1996-09-27 06:29:02 -04:00
|
|
|
'\"
|
|
|
|
|
'\" 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"
|
|
|
|
|
.BS
|
|
|
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
|
|
|
|
.SH NAME
|
|
|
|
|
image \- Create and manipulate images
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
(\fBimage\fR \fIoption \fR?\fIarg arg ...\fR?)
|
|
|
|
|
.BE
|
|
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.PP
|
|
|
|
|
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:
|
|
|
|
|
.TP
|
|
|
|
|
(\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.
|
|
|
|
|
.TP
|
|
|
|
|
(\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.
|
|
|
|
|
.TP
|
|
|
|
|
(\fBimage 'height \fIname\fR)
|
|
|
|
|
Returns a decimal string giving the height of image \fIname\fR
|
|
|
|
|
in pixels.
|
|
|
|
|
.TP
|
|
|
|
|
(\fBimage 'names\fR)
|
|
|
|
|
Returns a list containing the names of all existing images.
|
|
|
|
|
.TP
|
|
|
|
|
(\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).
|
|
|
|
|
.TP
|
|
|
|
|
(\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).
|
|
|
|
|
.TP
|
|
|
|
|
(\fBimage 'width \fIname\fR)
|
|
|
|
|
Returns a decimal string giving the width of image \fIname\fR
|
|
|
|
|
in pixels.
|
|
|
|
|
|
|
|
|
|
.SH "BUILT-IN IMAGE TYPES"
|
|
|
|
|
.PP
|
|
|
|
|
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.
|
|
|
|
|
.TP
|
|
|
|
|
\fBbitmap\fR
|
|
|
|
|
Each pixel in the image displays a foreground color, a background
|
|
|
|
|
color, or nothing.
|
|
|
|
|
See the \fBbitmap\fR manual entry for more information.
|
|
|
|
|
.TP
|
|
|
|
|
\fBphoto\fR
|
|
|
|
|
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.
|
|
|
|
|
.TP
|
|
|
|
|
\fBpixmap\fR
|
|
|
|
|
Displays a color images in X11 pixmap format. See the \fBpixmap\fR manual entry
|
|
|
|
|
for more information.
|
|
|
|
|
|
|
|
|
|
.SH SEE ALSO
|
1998-04-10 06:59:06 -04:00
|
|
|
bitmap, make-image, jpeg, photo, pixmap
|
