summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorfvogel <fvogelnew1@free.fr>2020-07-18 10:24:09 (GMT)
committerfvogel <fvogelnew1@free.fr>2020-07-18 10:24:09 (GMT)
commit5c61bcbe7c9f0de02a56e88fcd6253a2b2cfb482 (patch)
treead41e2b1c5644a661d2b2ae4bce7b7f5592ab465 /doc
parent150c5622292b1daa23aaf8d7a43053f9345f9642 (diff)
downloadtk-5c61bcbe7c9f0de02a56e88fcd6253a2b2cfb482.zip
tk-5c61bcbe7c9f0de02a56e88fcd6253a2b2cfb482.tar.gz
tk-5c61bcbe7c9f0de02a56e88fcd6253a2b2cfb482.tar.bz2
More detailed documentation of the simplified packing algorithm and options used by ttk for layouts.
Diffstat (limited to 'doc')
-rw-r--r--doc/ttk_style.n19
1 files changed, 13 insertions, 6 deletions
diff --git a/doc/ttk_style.n b/doc/ttk_style.n
index a67cae6..931e290 100644
--- a/doc/ttk_style.n
+++ b/doc/ttk_style.n
@@ -98,24 +98,31 @@ by one or more options specifying how to arrange the element.
The layout mechanism uses a simplified version of the \fBpack\fR
geometry manager: given an initial cavity,
each element is allocated a parcel.
+Then the parcel actually used by the element is adjusted within
+the allocated parcel.
Valid options are:
.TP
-\fB\-children { \fIsublayout... \fB}\fR
+\fB\-children { \fIsublayout...\fB }\fR
Specifies a list of elements to place inside the element.
.TP
\fB\-expand\fR \fIboolean\fR
-Specifies whether the allocated parcel is the entire cavity.
+Specifies whether the allocated parcel is the entire cavity. If so,
+simultaneous specification of \fB\-side\fR is ignored.
Defaults to 0.
.TP
\fB\-side \fIside\fR
Specifies which side of the cavity to place the element;
one of \fBleft\fR, \fBright\fR, \fBtop\fR, or \fBbottom\fR.
-If omitted, the allocated parcel is the entire cavity (therefore the
-same as \fB\-expand\fR 1).
+For instance, \fB\-side top\fR allocates the parcel along the top of
+the cavity having width and height respectively the width of the cavity
+and the height of the element.
+If omitted, the allocated parcel is the entire cavity (same result
+as \fB\-expand\fR 1).
.TP
\fB\-sticky\fR \fB[\fInswe\fB]\fR
-Specifies where the element is placed inside its allocated parcel.
-Default is \fBnswe\fR.
+Specifies the actual parcel position and size inside the allocated parcel.
+If specified as an empty string then the actual parcel is centered in
+the allocated parcel. Default is \fBnswe\fR.
.\" Also: -border, -unit: may go away.
.PP
For example: