diff options
author | dgp <dgp@noemail.net> | 2007-10-26 20:13:21 (GMT) |
---|---|---|
committer | dgp <dgp@noemail.net> | 2007-10-26 20:13:21 (GMT) |
commit | 4064529ba9703e507a2b41d4cccbec2b661d1d48 (patch) | |
tree | 8355bd802491be2c1de242e0598914b0bb36fca5 /doc/ttk_image.n | |
parent | 67ef9220fa871ce137f6e2cbb4fe3784396e1ff3 (diff) | |
download | tk-4064529ba9703e507a2b41d4cccbec2b661d1d48.zip tk-4064529ba9703e507a2b41d4cccbec2b661d1d48.tar.gz tk-4064529ba9703e507a2b41d4cccbec2b661d1d48.tar.bz2 |
* doc/*.1: Revert doc changes that broke
* doc/*.3: `make html` so we can get the release
* doc/*.n: out the door.
FossilOrigin-Name: 4fe4274467a1800529131c86ff155c4c0b03db8a
Diffstat (limited to 'doc/ttk_image.n')
-rw-r--r-- | doc/ttk_image.n | 83 |
1 files changed, 44 insertions, 39 deletions
diff --git a/doc/ttk_image.n b/doc/ttk_image.n index 6eebf64..61effb9 100644 --- a/doc/ttk_image.n +++ b/doc/ttk_image.n @@ -3,9 +3,9 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: ttk_image.n,v 1.8 2007/10/23 15:44:36 dkf Exp $ -'\" +'\" +'\" RCS: @(#) $Id: ttk_image.n,v 1.9 2007/10/26 20:13:23 dgp Exp $ +'\" .so man.macros .TH ttk_image n 8.5 Tk "Tk Themed Widget" .BS @@ -16,58 +16,63 @@ ttk_image \- Define an element based on an image .BE .SH DESCRIPTION -The \fIimage\fR element factory creates a new element in the current theme -whose visual appearance is determined by Tk images. \fIimageSpec\fP is a list -of one or more elements. The first element is the default image name. The rest -of the list is a sequence of \fIstatespec / value\fR pairs specifying other -images to use when the element is in a particular state or combination of -states. +The \fIimage\fR element factory creates a new element +in the current theme whose visual appearance is determined +by Tk images. +\fIimageSpec\fP is a list of one or more elements. +The first element is the default image name. +The rest of the list is a sequence of \fIstatespec / value\fR +pairs specifying other images to use when the element is +in a particular state or combination of states. + .SH OPTIONS Valid \fIoptions\fR are: .TP -\fB\-border\fR \fIpadding\fR -. -\fIpadding\fR is a list of up to four integers, specifying the left, top, -right, and bottom borders, respectively. See \fBIMAGE STRETCHING\fR, below. +\fB-border\fR \fIpadding\fR +\fIpadding\fR is a list of up to four integers, specifying +the left, top, right, and bottom borders, respectively. +See \fBIMAGE STRETCHING\fR, below. .TP -\fB\-height \fIheight\fR -. -Specifies a minimum height for the element. If less than zero, the base -image's height is used as a default. +\fB-height \fIheight\fR +Specifies a minimum height for the element. +If less than zero, the base image's height is used as a default. .TP -\fB\-padding\fR \fIpadding\fR -. -Specifies the element's interior padding. Defaults to \fI\-border\fR if not -specified. +\fB-padding\fR \fIpadding\fR +Specifies the element's interior padding. Defaults to +\fI-border\fR if not specified. .TP -\fB\-sticky\fR \fIspec\fR -. -Specifies how the image is placed within the final parcel. \fIspec\fR contains -zero or more characters "n", "s", "w", or "e". +\fB-sticky\fR \fIspec\fR +Specifies how the image is placed within the final parcel. +\fIspec\fR contains zero or more characters "n", "s", "w", or "e". .TP -\fB\-width \fIwidth\fR -. -Specifies a minimum width for the element. If less than zero, the base image's -width is used as a default. +\fB-width \fIwidth\fR +Specifies a minimum width for the element. +If less than zero, the base image's width is used as a default. + .SH "IMAGE STRETCHING" -If the element's allocated parcel is larger than the image, the image will be -placed in the parcel based on the \fB\-sticky\fR option. If the image needs to -stretch horizontally (i.e., \fB\-sticky ew\fR) or vertically (\fB\-sticky -ns\fR), subregions of the image are replicated to fill the parcel based on the -\fB\-border\fR option. The \fB\-border\fR divides the image into 9 regions: -four fixed corners, top and left edges (which may be tiled horizontally), left -and right edges (which may be tiled vertically), and the central area (which -may be tiled in both directions). +If the element's allocated parcel is larger than the image, +the image will be placed in the parcel based on the \fB-sticky\fR option. +If the image needs to stretch horizontally (i.e., \fB-sticky ew\fR) +or vertically (\fB-sticky ns\fR), +subregions of the image are replicated to fill the parcel +based on the \fB-border\fR option. +The \fB-border\fR divides the image into 9 regions: +four fixed corners, top and left edges (which may be tiled horizontally), +left and right edges (which may be tiled vertically), +and the central area (which may be tiled in both directions). + .SH "EXAMPLE" .CS set img1 [image create photo -file button.png] set img2 [image create photo -file button-pressed.png] set img3 [image create photo -file button-active.png] style element create Button.button image \e - [list $img1 pressed $img2 active $img3] \e - -border {2 4} -sticky we + [list $img1 pressed $img2 active $img3] \e + -border {2 4} -sticky we .CE + .SH "SEE ALSO" image(n), photo(n) + .SH KEYWORDS pixmap theme, image |