compound(n) Tix (4.0) compound(n)
_________________________________________________________________
NAME
Compound - Create multi-line compound images.
SYNOPSIS
image create compound ?name? ?options?
_________________________________________________________________
DESCRIPTION
Compound image types can be used to create images that
consists of multiple horizontal lines; each line is composed
of a series of items (texts, bitmaps, images or spaces)
arranged from left to right. Compound images are mainly used
to embed complex drawings into widgets that support the
-image option. As shown in the EXAMPLE section below, a
compound image can be used to display a bitmap and a text
string simutaneously in a TK button(n) widget.
CREATING COMPOUND IMAGES
Like all images, compound images are created using the image
create command. Compound images support the following
options:
-background color
Specifies the background color of the compound image.
This color is also used as the default background color
for the bitmap items in the compound image.
-borderwidth pixels
Specifies a non-negative value indicating the width of
the 3-D border drawn around the compound image.
-font font
Specifies the default font for the text items in the
compound image.
-foreground color
Specifies the default foreground color for the bitmap
and text items in the compound image.
-padx value
Specifies a non-negative value indicating how much
extra space to request for the compound image in the
X-direction. The value may have any of the forms
acceptable to Tk_GetPixels(3).
-pady value
Specifies a non-negative value indicating how much
extra space to request for the compound image in the
Y-direction.
Page 1 (printed 12/22/98)
compound(n) Tix (4.0) compound(n)-relief value
Specifies the 3-D effect desired for the background of
the compound image. Acceptable values are raised,
sunken, flat, ridge, and groove.
-showbackground value
Specifies whether the background and the 3D borders
should be drawn. Must be a valid boolean value. By
default the background is not drawn and the compound
image appears to have a transparent background.
-window pathName
Specifies the window in which the compound image is
displayed. One compound image can be displayed in only
one window. When that window is destroyed, the compound
image is automatically destroyed as well. This option
must be specified when calling the image create
compound command and cannot be changed by the configure
image command.
IMAGE COMMAND
When a compound image is created, Tk also creates a new
command whose name is the same as the image. This command
may be used to invoke various operations on the image. It
has the following general form:
imageName option ?arg arg ...?
Option and the args determine the exact behavior of the
command. The following commands are possible for compound
images:
imageName add line ?option value ...?
Creates a new line at the bottom of the compound image.
Lines support the following options:
-anchor value
Specifies how the line should be aligned along the
horizontal axis. When the values are w, sw or nw,
the line is aligned to the left. When the values
are c, s or n, the line is aligned to the middle.
When the values are e, se or ne, the line is
aligned to the right.
-padx value
Specifies a non-negative value indicating how much
extra space to request for this line in the X-
direction.
imageName add item-type ?option value ...?
Creates a new item of the type item-type at the end of
the last line of the compound image. All types of items
Page 2 (printed 12/22/98)
compound(n) Tix (4.0) compound(n)
support these following common options:
-anchor value
Specifies how the item should be aligned along the
vertical axis. When the values are n, nw or ne,
the item is aligned to the top of the line. When
the values are c, w or e, the item is aligned to
the middle of the line. When the values are s, se
or sw, the item is aligned to the bottom of the
line.
-padx value
Specifies a non-negative value indicating how much
extra space to request for this item in the X-
direction.
-pady value
Specifies a non-negative value indicating how much
extra space to request for this item in the Y-
direction.
item-type can be any of the following:
imageName add bitmap ?option value ...?
Creates a new bitmap item of at the end of the last
line of the compound image. Additional options accepted
by the bitmap type are:
-background color
Specifies the background color of the bitmap item.
-bitmap name
Specifies a bitmap to display in this item, in any
of the forms acceptable to Tk_GetBitmap(3).
-foreground color
Specifies the foreground color of the bitmap item.
imageName add image ?option value ...?
Creates a new image item of at the end of the last line
of the compound image. Additional options accepted by
the image type are:
image(n), Tix(n)
Page 3 (printed 12/22/98)
