| 1 |
578 |
markom |
'\"
|
| 2 |
|
|
'\" Copyright (c) 1996, Expert Interface Technologies
|
| 3 |
|
|
'\"
|
| 4 |
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
| 5 |
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
| 6 |
|
|
'\"
|
| 7 |
|
|
'\" The file man.macros and some of the macros used by this file are
|
| 8 |
|
|
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
| 9 |
|
|
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
| 10 |
|
|
'\" The license terms of the Tcl/Tk distrobution are in the file
|
| 11 |
|
|
'\" license.tcl.
|
| 12 |
|
|
.so man.macros
|
| 13 |
|
|
.HS pixmap tix 4.0
|
| 14 |
|
|
.BS
|
| 15 |
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
| 16 |
|
|
.SH NAME
|
| 17 |
|
|
pixmap \- Create color images from XPM files.
|
| 18 |
|
|
.SH SYNOPSIS
|
| 19 |
|
|
\fBimage create pixmap \fR?\fIname\fR? ?\fIoptions\fR?
|
| 20 |
|
|
.BE
|
| 21 |
|
|
|
| 22 |
|
|
.SH DESCRIPTION
|
| 23 |
|
|
.PP
|
| 24 |
|
|
XPM is a popular X Window image file format for storing color icons.
|
| 25 |
|
|
The \fBpixmap\fR image type defined by the \fBTix(n)\fR library can be
|
| 26 |
|
|
used to create color images using XPM files.
|
| 27 |
|
|
|
| 28 |
|
|
.SH "CREATING PIXMAPS"
|
| 29 |
|
|
.PP
|
| 30 |
|
|
Like all images, pixmaps are created using the \fBimage create\fR
|
| 31 |
|
|
command. Pixmaps support the following \fIoptions\fR:
|
| 32 |
|
|
.TP
|
| 33 |
|
|
\fB\-data \fIstring\fR
|
| 34 |
|
|
'
|
| 35 |
|
|
Specifies the contents of the source pixmap as a string. The string
|
| 36 |
|
|
must adhere to the XPM file format (e.g., as generated by the
|
| 37 |
|
|
\fBpixmap(1)\fR program). If both the \fB\-data\fR and \fB\-file\fR
|
| 38 |
|
|
options are specified, the \fB\-data\fR option takes precedence.
|
| 39 |
|
|
Please note that the XPM file parsing code in the xpm library is
|
| 40 |
|
|
extremely fragile. The first line of the string must be "\fB/* XPM
|
| 41 |
|
|
*/\fR" or otherwise a segmatation fault will be caused.
|
| 42 |
|
|
'
|
| 43 |
|
|
.TP
|
| 44 |
|
|
\fB\-file \fIname\fR
|
| 45 |
|
|
'
|
| 46 |
|
|
\fIname\fR gives the name of a file whose contents define the source
|
| 47 |
|
|
pixmap. The file must adhere to the XPM file format (e.g., as
|
| 48 |
|
|
generated by the \fBpixmap(1)\fR program).
|
| 49 |
|
|
'
|
| 50 |
|
|
.SH "IMAGE COMMAND"
|
| 51 |
|
|
.PP
|
| 52 |
|
|
When a pixmap image is created, Tk also creates a new command whose
|
| 53 |
|
|
name is the same as the image. This command may be used to invoke
|
| 54 |
|
|
various operations on the image. It has the following general form:
|
| 55 |
|
|
.DS C
|
| 56 |
|
|
\fIimageName option \fR?\fIarg arg ...\fR?
|
| 57 |
|
|
.DE
|
| 58 |
|
|
\fIOption\fR and the \fIarg\fRs
|
| 59 |
|
|
'
|
| 60 |
|
|
determine the exact behavior of the command. The following
|
| 61 |
|
|
commands are possible for pixmap images:
|
| 62 |
|
|
.TP
|
| 63 |
|
|
\fIimageName \fBcget\fR \fIoption\fR
|
| 64 |
|
|
'
|
| 65 |
|
|
Returns the current value of the configuration option given by
|
| 66 |
|
|
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
| 67 |
|
|
\fBimage create pixmap\fR command.
|
| 68 |
|
|
.TP
|
| 69 |
|
|
\fIimageName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
| 70 |
|
|
'
|
| 71 |
|
|
Query or modify the configuration options for the image. If no
|
| 72 |
|
|
\fIoption\fR is specified, returns a list describing all of the
|
| 73 |
|
|
available options for \fIimageName\fR (see \fBTk_ConfigureInfo\fR for
|
| 74 |
|
|
information on the format of this list). If \fIoption\fR is specified
|
| 75 |
|
|
with no \fIvalue\fR, then the command returns a list describing the
|
| 76 |
|
|
one named option (this list will be identical to the corresponding
|
| 77 |
|
|
sublist of the value returned if no \fIoption\fR is specified). If
|
| 78 |
|
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
| 79 |
|
|
modifies the given option(s) to have the given value(s); in this case
|
| 80 |
|
|
the command returns an empty string. \fIOption\fR may have any of the
|
| 81 |
|
|
values accepted by the \fBimage create pixmap\fR command.
|
| 82 |
|
|
|
| 83 |
|
|
.SH KEYWORDS
|
| 84 |
|
|
pixmap(1), image(n), Tix(n)
|
