2 '\" Copyright (c) 1994 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 '\" RCS: @(#) $Id: image.n,v 1.6 2001/04/03 04:33:58 hobbs Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or "in/out" to describe whether procedure reads or modifies arg,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments for setting tab stops. Type and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to .AP later. If args are omitted, default tab stops are used.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar, for use in marking newly-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version when the .VS was added, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present, then a line break is forced before starting the sidebar.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option. cmdName gives the
64 '\" option's name as specified in the class command, dbName gives
65 '\" the option's name in the option database, and dbClass gives
66 '\" the option's class in the option database.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH image n 4.0 Tk "Tk Built-In Commands"
248 '\" Note: do not modify the .SH NAME line immediately below!
250 image \- Create and manipulate images
252 \fBimage\fR \fIoption \fR?\fIarg arg ...\fR?
257 The \fBimage\fR command is used to create, delete, and query images.
258 It can take several different forms, depending on the
259 \fIoption\fR argument. The legal forms are:
261 \fBimage create \fItype \fR?\fIname\fR? ?\fIoption value ...\fR?
262 Creates a new image and returns its name.
263 \fItype\fR specifies the type of the image, which must be one of
264 the types currently defined (e.g., \fBbitmap\fR).
265 \fIname\fR specifies the name for the image; if it is omitted then
266 Tk picks a name of the form \fBimage\fIx\fR, where \fIx\fR is
268 There may be any number of \fIoption\fR\-\fIvalue\fR pairs,
269 which provide configuration options for the new image.
270 The legal set of options is defined separately for each image
271 type; see below for details on the options for built-in image types.
272 If an image already exists by the given name then it is replaced
273 with the new image and any instances of that image will redisplay
274 with the new contents.
275 It is important to note that the image command will silently overwrite any
276 procedure that may currently be defined by the given name, so choose the
277 name wisely. It is recommended to use a separate namespace for image names
278 (e.g., \fB::img::logo\fR, \fB::img::large\fR).
280 \fBimage delete \fR?\fIname name\fR ...?
281 Deletes each of the named images and returns an empty string.
282 If there are instances of the images displayed in widgets,
283 the images won't actually be deleted until all of the instances
285 However, the association between the instances and the image
286 manager will be dropped.
287 Existing instances will retain their sizes but redisplay as
289 If a deleted image is recreated with another call to \fBimage create\fR,
290 the existing instances will use the new image.
292 \fBimage height \fIname\fR
293 Returns a decimal string giving the height of image \fIname\fR
296 \fBimage inuse \fIname\fR
297 Returns a boolean value indicating whether or not the image given by
298 \fIname\fR is in use by any widgets.
301 Returns a list containing the names of all existing images.
303 \fBimage type \fIname\fR
304 Returns the type of image \fIname\fR (the value of the \fItype\fR
305 argument to \fBimage create\fR when the image was created).
308 Returns a list whose elements are all of the valid image types
309 (i.e., all of the values that may be supplied for the \fItype\fR
310 argument to \fBimage create\fR).
312 \fBimage width \fIname\fR
313 Returns a decimal string giving the width of image \fIname\fR
316 .SH "BUILT-IN IMAGE TYPES"
318 The following image types are defined by Tk so they will be available
319 in any Tk application.
320 Individual applications or extensions may define additional types.
323 Each pixel in the image displays a foreground color, a background
325 See the \fBbitmap\fR manual entry for more information.
328 Displays a variety of full-color images, using dithering to
329 approximate colors on displays with limited color capabilities.
330 See the \fBphoto\fR manual entry for more information.
333 height, image, types of images, width