summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorfvogel <fvogelnew1@free.fr>2017-04-07 21:24:24 (GMT)
committerfvogel <fvogelnew1@free.fr>2017-04-07 21:24:24 (GMT)
commit94e87e7990f560f992b180c01979879f775c06ad (patch)
treeee046fd0e4a65c19a4635910a1f36827bd3a452a /doc
parent1bc7b09b1504f4fc06f0be369a22538f7ab6ec84 (diff)
downloadtk-94e87e7990f560f992b180c01979879f775c06ad.zip
tk-94e87e7990f560f992b180c01979879f775c06ad.tar.gz
tk-94e87e7990f560f992b180c01979879f775c06ad.tar.bz2
Factorized documentation of -padding as much as possible, and clarified documentation of -border in the same way as for -paddingbug_3602901fff
Diffstat (limited to 'doc')
-rw-r--r--doc/ttk_frame.n6
-rw-r--r--doc/ttk_image.n20
-rw-r--r--doc/ttk_label.n13
-rw-r--r--doc/ttk_labelframe.n6
-rw-r--r--doc/ttk_notebook.n3
-rw-r--r--doc/ttk_treeview.n5
-rw-r--r--doc/ttk_vsapi.n7
-rw-r--r--doc/ttk_widget.n47
8 files changed, 63 insertions, 44 deletions
diff --git a/doc/ttk_frame.n b/doc/ttk_frame.n
index b54ce96..d2bd745 100644
--- a/doc/ttk_frame.n
+++ b/doc/ttk_frame.n
@@ -17,8 +17,8 @@ ttk::frame \- Simple container widget
A \fBttk::frame\fR widget is a container, used to group other widgets
together.
.SO ttk_widget
-\-class \-cursor \-takefocus
-\-style
+\-class \-cursor \-padding \-style
+\-takefocus
.SE
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-borderwidth borderWidth BorderWidth
@@ -28,8 +28,6 @@ One of the standard Tk border styles:
\fBflat\fR, \fBgroove\fR, \fBraised\fR, \fBridge\fR,
\fBsolid\fR, or \fBsunken\fR.
Defaults to \fBflat\fR.
-.OP \-padding padding Padding
-Additional padding to include inside the border.
.OP \-width width Width
If specified, the widget's requested width in pixels.
.OP \-height height Height
diff --git a/doc/ttk_image.n b/doc/ttk_image.n
index 4985c20..bc1dd3f 100644
--- a/doc/ttk_image.n
+++ b/doc/ttk_image.n
@@ -29,6 +29,13 @@ Valid \fIoptions\fR are:
\fB\-border\fR \fIpadding\fR
\fIpadding\fR is a list of up to four integers, specifying
the left, top, right, and bottom borders, respectively.
+If fewer than four elements are specified,
+\fIbottom\fR defaults to \fItop\fR,
+\fIright\fR defaults to \fIleft\fR, and
+\fItop\fR defaults to \fIleft\fR.
+In other words, a list of three numbers specify the left, vertical, and right border;
+a list of two numbers specify the horizontal and the vertical border;
+a single number specifies the same border all the way around the element.
See \fBIMAGE STRETCHING\fR, below.
.TP
\fB\-height \fIheight\fR
@@ -36,8 +43,17 @@ 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
-\fB\-border\fR if not specified.
+Specifies the element's interior padding.
+The padding is a list of up to four length specifications
+\fIleft top right bottom\fR.
+If fewer than four elements are specified,
+\fIbottom\fR defaults to \fItop\fR,
+\fIright\fR defaults to \fIleft\fR, and
+\fItop\fR defaults to \fIleft\fR.
+In other words, a list of three numbers specify the left, vertical, and right padding;
+a list of two numbers specify the horizontal and the vertical padding;
+a single number specifies the same padding all the way around the widget.
+Defaults to \fB\-border\fR if not specified.
.TP
\fB\-sticky\fR \fIspec\fR
Specifies how the image is placed within the final parcel.
diff --git a/doc/ttk_label.n b/doc/ttk_label.n
index 3933ec0..9c28d7c 100644
--- a/doc/ttk_label.n
+++ b/doc/ttk_label.n
@@ -19,7 +19,7 @@ The label may be linked to a Tcl variable
to automatically change the displayed text.
.SO ttk_widget
\-class \-compound \-cursor
-\-image \-style \-takefocus
+\-image \-padding \-style \-takefocus
\-text \-textvariable \-underline
\-width
.SE
@@ -43,17 +43,6 @@ If there are multiple lines of text, specifies how
the lines are laid out relative to one another.
One of \fBleft\fR, \fBcenter\fR, or \fBright\fR.
See also \fB\-anchor\fR.
-.OP \-padding padding Padding
-Specifies the amount of extra space to allocate for the widget.
-The padding is a list of up to four length specifications
-\fIleft top right bottom\fR.
-If fewer than four elements are specified,
-\fIbottom\fR defaults to \fItop\fR,
-\fIright\fR defaults to \fIleft\fR, and
-\fItop\fR defaults to \fIleft\fR.
-In other words, a list of three numbers specify the left, vertical, and right padding;
-a list of two numbers specify the horizontal and the vertical padding;
-a single number specifies the same padding all the way around the widget.
.OP \-relief relief Relief
.\" Rewrite this:
Specifies the 3-D effect desired for the widget border.
diff --git a/doc/ttk_labelframe.n b/doc/ttk_labelframe.n
index 64edf6a..4c2c8d5 100644
--- a/doc/ttk_labelframe.n
+++ b/doc/ttk_labelframe.n
@@ -18,8 +18,8 @@ A \fBttk::labelframe\fR widget is a container used to group other widgets
together. It has an optional label, which may be a plain text string or
another widget.
.SO ttk_widget
-\-class \-cursor \-takefocus
-\-style
+\-class \-cursor \-padding \-style
+\-takefocus
.SE
.SH "WIDGET-SPECIFIC OPTIONS"
.\" XXX: Currently included, but may go away:
@@ -48,8 +48,6 @@ underline in the text string.
The underlined character is used for mnemonic activation.
Mnemonic activation for a \fBttk::labelframe\fR
sets the keyboard focus to the first child of the \fBttk::labelframe\fR widget.
-.OP \-padding padding Padding
-Additional padding to include inside the border.
.OP \-labelwidget labelWidget LabelWidget
The name of a widget to use for the label.
If set, overrides the \fB\-text\fR option.
diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n
index 290a0c7..e2ae137 100644
--- a/doc/ttk_notebook.n
+++ b/doc/ttk_notebook.n
@@ -41,6 +41,9 @@ If fewer than four elements are specified,
\fIbottom\fR defaults to \fItop\fR,
\fIright\fR defaults to \fIleft\fR, and
\fItop\fR defaults to \fIleft\fR.
+In other words, a list of three numbers specify the left, vertical, and right padding;
+a list of two numbers specify the horizontal and the vertical padding;
+a single number specifies the same padding all the way around the widget.
.OP \-width width Width
If present and greater than zero,
specifies the desired width of the pane area
diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n
index 660b076..8399a09 100644
--- a/doc/ttk_treeview.n
+++ b/doc/ttk_treeview.n
@@ -45,6 +45,7 @@ and [\fBxy\fR]\fBview\fR widget commands.
.SO ttk_widget
\-class \-cursor \-takefocus
\-style \-xscrollcommand \-yscrollcommand
+\-padding
.SE
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-columns columns Columns
@@ -63,10 +64,6 @@ all columns are shown in the order given.
Specifies the number of rows which should be visible.
Note:
the requested width is determined from the sum of the column widths.
-.OP \-padding padding Padding
-Specifies the internal padding for the widget.
-The padding is a list of up to four length specifications;
-see \fBTtk_GetPaddingFromObj()\fR for details.
.OP \-selectmode selectMode SelectMode
Controls how the built-in class bindings manage the selection.
One of \fBextended\fR, \fBbrowse\fR, or \fBnone\fR.
diff --git a/doc/ttk_vsapi.n b/doc/ttk_vsapi.n
index 4d5c3eb..af63c39 100644
--- a/doc/ttk_vsapi.n
+++ b/doc/ttk_vsapi.n
@@ -34,6 +34,13 @@ Valid \fIoptions\fR are:
Specify the element's interior padding.
\fIpadding\fR is a list of up to four integers specifying
the left, top, right and bottom padding quantities respectively.
+If fewer than four elements are specified,
+\fIbottom\fR defaults to \fItop\fR,
+\fIright\fR defaults to \fIleft\fR, and
+\fItop\fR defaults to \fIleft\fR.
+In other words, a list of three numbers specify the left, vertical, and right padding;
+a list of two numbers specify the horizontal and the vertical padding;
+a single number specifies the same padding all the way around the widget.
This option may not be mixed with any other options.
.TP
\fB\-margins \fIpadding\fR
diff --git a/doc/ttk_widget.n b/doc/ttk_widget.n
index 2ecc29f..d362bba 100644
--- a/doc/ttk_widget.n
+++ b/doc/ttk_widget.n
@@ -71,24 +71,6 @@ See the description of \fB\-xscrollcommand\fR above for details.
.SH "LABEL OPTIONS"
The following options are supported by labels, buttons,
and other button-like widgets:
-.OP \-text text Text
-Specifies a text string to be displayed inside the widget
-(unless overridden by \fB\-textvariable\fR).
-.OP \-textvariable textVariable Variable
-Specifies the name of a global variable whose value will be used
-in place of the \fB\-text\fR resource.
-.OP \-underline underline Underline
-If set, specifies the integer index (0-based) of a character to underline
-in the text string.
-The underlined character is used for mnemonic activation.
-.OP \-image image Image
-Specifies an image to display.
-This is a list of 1 or more elements.
-The first element is the default image name.
-The rest of the list is a sequence of \fIstatespec / value\fR pairs
-as per \fBstyle map\fR, specifying different images to use when
-the widget is in a particular state or combination of states.
-All images in the list should have the same size.
.OP \-compound compound Compound
Specifies how to display the image relative to the text,
in the case both \fB\-text\fR and \fB\-image\fR are present.
@@ -108,6 +90,35 @@ Display image above, below, left of, or right of the text, respectively.
.IP none
The default; display the image if present, otherwise the text.
.RE
+.OP \-image image Image
+Specifies an image to display.
+This is a list of 1 or more elements.
+The first element is the default image name.
+The rest of the list is a sequence of \fIstatespec / value\fR pairs
+as per \fBstyle map\fR, specifying different images to use when
+the widget is in a particular state or combination of states.
+All images in the list should have the same size.
+.OP \-padding padding Padding
+Specifies the internal padding for the widget.
+The padding is a list of up to four length specifications
+\fIleft top right bottom\fR.
+If fewer than four elements are specified,
+\fIbottom\fR defaults to \fItop\fR,
+\fIright\fR defaults to \fIleft\fR, and
+\fItop\fR defaults to \fIleft\fR.
+In other words, a list of three numbers specify the left, vertical, and right padding;
+a list of two numbers specify the horizontal and the vertical padding;
+a single number specifies the same padding all the way around the widget.
+.OP \-text text Text
+Specifies a text string to be displayed inside the widget
+(unless overridden by \fB\-textvariable\fR).
+.OP \-textvariable textVariable Variable
+Specifies the name of a global variable whose value will be used
+in place of the \fB\-text\fR resource.
+.OP \-underline underline Underline
+If set, specifies the integer index (0-based) of a character to underline
+in the text string.
+The underlined character is used for mnemonic activation.
.OP \-width width Width
If greater than zero, specifies how much space, in character widths,
to allocate for the text label.