95 lines
3.3 KiB

'\" Copyright (c) 1994 The Regents of the University of California.
'\" Copyright (c) 1994 Sun Microsystems, Inc.
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" @(#) image.n 1.6 95/06/07 21:15:16
.so STk-man.macros
.TH image n 3.1 STk "Tk Built-In Commands"
'\" Note: do not modify the .SH NAME line immediately below!
image \- Create and manipulate images
(\fBimage\fR \fIoption \fR?\fIarg arg ...\fR?)
The \fBimage\fR command is used to create, delete, and query images.
It can take several different forms, depending on the
\fIoption\fR argument. The legal forms are:
(\fBimage 'create \fItype \fR?\fIname\fR? ?\fIoption value ...\fR?)
Creates a new image and returns its name.
\fItype\fR specifies the type of the image, which must be one of
the types currently defined (e.g., \fBbitmap\fR).
\fIname\fR specifies the name for the image; if it is omitted then
Tk picks a name of the form \fBimage\fIx\fR, where \fIx\fR is
an integer.
There may be any number of \fIoption\fR\-\fIvalue\fR pairs,
which provide configuration options for the new image.
The legal set of options is defined separately for each image
type; see below for details on the options for built-in image types.
If an image already exists by the given name then it is replaced
with the new image and any instances of that image will redisplay
with the new contents.
(\fBimage 'delete \fIname\fR ?\fIname name\fR ...?)
Deletes each of the named images and returns an empty list.
If there are instances of the images displayed in widgets,
the images won't actually be deleted until all of the instances
are released.
However, the association between the instances and the image
manager will be dropped.
Existing instances will retain their sizes but redisplay as
empty areas.
If a deleted image is recreated with another call to \fBimage create\fR,
the existing instances will use the new image.
(\fBimage 'height \fIname\fR)
Returns a decimal string giving the height of image \fIname\fR
in pixels.
(\fBimage 'names\fR)
Returns a list containing the names of all existing images.
(\fBimage 'type \fIname\fR)
Returns the type of image \fIname\fR (the value of the \fItype\fR
argument to \fBimage create\fR when the image was created).
(\fBimage 'types\fR)
Returns a list whose elements are all of the valid image types
(i.e., all of the values that may be supplied for the \fItype\fR
argument to \fBimage create\fR).
(\fBimage 'width \fIname\fR)
Returns a decimal string giving the width of image \fIname\fR
in pixels.
The following image types are defined by Tk so they will be available
in any Tk application.
Individual applications or extensions may define additional types.
Each pixel in the image displays a foreground color, a background
color, or nothing.
See the \fBbitmap\fR manual entry for more information.
Displays a variety of full-color images, using dithering to
approximate colors on displays with limited color capabilities.
See the \fBphoto\fR manual entry for more information.
Displays a color images in X11 pixmap format. See the \fBpixmap\fR manual entry
for more information.
bitmap, make-image, jpeg, photo, pixmap