| 1 | # Copyright (c) 1996, Expert Interface Technologies |
| 2 | # See the file "license.terms" for information on usage and redistribution |
| 3 | # of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| 4 | # |
| 5 | # The file man.macros and some of the macros used by this file are |
| 6 | # copyrighted: (c) 1990 The Regents of the University of California. |
| 7 | # (c) 1994-1995 Sun Microsystems, Inc. |
| 8 | # The license terms of the Tcl/Tk distribution are in the file |
| 9 | # license.tcl. |
| 10 | |
| 11 | =head1 NAME |
| 12 | |
| 13 | Tk::Pixmap - Create color images from XPM files. |
| 14 | |
| 15 | =for category Tk Image Classes |
| 16 | |
| 17 | =head1 SYNOPSIS |
| 18 | |
| 19 | S< >I<$widget>-E<gt>B<Pixmap>?(I<name>?,I<options>?)? |
| 20 | |
| 21 | =head1 DESCRIPTION |
| 22 | |
| 23 | XPM is a popular X Window image file format for storing color icons. |
| 24 | The B<Pixmap> image type can be used to create color images using XPM files. |
| 25 | |
| 26 | Pixmaps support the following I<options>: |
| 27 | |
| 28 | =over 4 |
| 29 | |
| 30 | =item B<-data> =E<gt> I<string> |
| 31 | |
| 32 | Specifies the contents of the source pixmap as a string. The string |
| 33 | must adhere to the XPM file format (e.g., as generated by the |
| 34 | B<pixmap(1)> program). If both the B<-data> and B<-file> |
| 35 | options are specified, the B<-data> option takes precedence. |
| 36 | Please note that the XPM file parsing code in the xpm library is |
| 37 | somewhat fragile. The first line of the string must be "B</* XPM> |
| 38 | */" or otherwise a segmatation fault will be caused. |
| 39 | |
| 40 | =item B<-file> =E<gt> I<name> |
| 41 | |
| 42 | I<name> gives the name of a file whose contents define the source |
| 43 | pixmap. The file must adhere to the XPM file format (e.g., as |
| 44 | generated by the B<pixmap(1)> program). |
| 45 | |
| 46 | =back |
| 47 | |
| 48 | =head1 IMAGE METHODS |
| 49 | |
| 50 | When a pixmap image is created, Tk also creates a new object. |
| 51 | This object supports the B<configure> and B<cget> methods |
| 52 | described in L<Tk::options> which can be used to enquire and |
| 53 | modify the options described above. |
| 54 | |
| 55 | =head1 SEE ALSO |
| 56 | |
| 57 | L<Tk::Image|Tk::Image> |
| 58 | |
| 59 | =head1 KEYWORDS |
| 60 | |
| 61 | pixmap, image, tix |
| 62 | |
| 63 | =cut |
| 64 | |