summaryrefslogtreecommitdiffstats
path: root/doc/ttk_image.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2007-10-22 14:33:13 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2007-10-22 14:33:13 (GMT)
commit5787fe560c93a6350d21481301843f811fe912b0 (patch)
tree140cdc3cc35622196837dfa37d3abf5c27df2da1 /doc/ttk_image.n
parentdfdf99ed53285ece3a7ca2ca269a205b4c3b69e2 (diff)
downloadtk-5787fe560c93a6350d21481301843f811fe912b0.zip
tk-5787fe560c93a6350d21481301843f811fe912b0.tar.gz
tk-5787fe560c93a6350d21481301843f811fe912b0.tar.bz2
Documentation improvements, all minor.
Diffstat (limited to 'doc/ttk_image.n')
-rw-r--r--doc/ttk_image.n78
1 files changed, 39 insertions, 39 deletions
diff --git a/doc/ttk_image.n b/doc/ttk_image.n
index 26034cf..c308533 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.6 2007/04/23 21:19:51 das Exp $
-'\"
+'\"
+'\" RCS: @(#) $Id: ttk_image.n,v 1.7 2007/10/22 14:33:13 dkf Exp $
+'\"
.so man.macros
.TH ttk_image n 8.5 Tk "Tk Themed Widget"
.BS
@@ -16,50 +16,50 @@ 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
@@ -67,8 +67,8 @@ 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"