.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Pixmap 3"
.TH Pixmap 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Tk::Pixmap \- Create color images from XPM files.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\ \ \ \ \fR\f(CI$widget\fR\fI\fR\->\fBPixmap\fR?(\fIname\fR?,\fIoptions\fR?)?
.SH DESCRIPTION
.IX Header "DESCRIPTION"
XPM is a popular X Window image file format for storing color icons.
The \fBPixmap\fR image type can be used to create color images using XPM files.
.PP
Pixmaps support the following \fIoptions\fR:
.IP "\fB\-data\fR => \fIstring\fR" 4
.IX Item "-data => string"
Specifies the contents of the source pixmap as a string.  The string
must adhere to the XPM file format (e.g., as generated by the
\&\fBpixmap\|(1)\fR program). If both the \fB\-data\fR and \fB\-file\fR
options are specified, the \fB\-data\fR option takes precedence.
Please note that the XPM file parsing code in the xpm library is
somewhat fragile. The first line of the string must be "\fB/* XPM\fR
*/" or otherwise a segmatation fault will be caused.
.IP "\fB\-file\fR => \fIname\fR" 4
.IX Item "-file => name"
\&\fIname\fR gives the name of a file whose contents define the source
pixmap.  The file must adhere to the XPM file format (e.g., as
generated by the \fBpixmap\|(1)\fR program).
.SH "IMAGE METHODS"
.IX Header "IMAGE METHODS"
When a pixmap image is created, Tk also creates a new object.
This object supports the \fBconfigure\fR and \fBcget\fR methods
described in Tk::options which can be used to enquire and
modify the options described above.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Tk::Image
.SH KEYWORDS
.IX Header "KEYWORDS"
pixmap, image, tix