summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorfvogel <fvogelnew1@free.fr>2023-07-14 18:58:10 (GMT)
committerfvogel <fvogelnew1@free.fr>2023-07-14 18:58:10 (GMT)
commitae5f616528f6c6bdaf8292ad9e196c0b4c4350bd (patch)
treebb7ef76db1943538377cf7d263877855ca4719ee /doc
parentdce9a69e660b5794ed00094a7129d3ee1d96c822 (diff)
parent8e07837faa291f02d4b8aef8662f4a9dd55b2ef6 (diff)
downloadtk-ae5f616528f6c6bdaf8292ad9e196c0b4c4350bd.zip
tk-ae5f616528f6c6bdaf8292ad9e196c0b4c4350bd.tar.gz
tk-ae5f616528f6c6bdaf8292ad9e196c0b4c4350bd.tar.bz2
merge trunk
Diffstat (limited to 'doc')
-rw-r--r--doc/3DBorder.32
-rw-r--r--doc/AddOption.318
-rw-r--r--doc/menu.n37
-rw-r--r--doc/ttk_style.n27
4 files changed, 65 insertions, 19 deletions
diff --git a/doc/3DBorder.3 b/doc/3DBorder.3
index 0bc41d0..a6deb30 100644
--- a/doc/3DBorder.3
+++ b/doc/3DBorder.3
@@ -9,7 +9,7 @@
.so man.macros
.BS
.SH NAME
-Tk_Alloc3DBorderFromObj, Tk_ClipDrawableToRect, Tk_DrawHighlightBorder, Tk_Get3DBorder, fBTk_Get3DBorderColors, Tk_Get3DBorderFromObj, Tk_Draw3DRectangle, Tk_Fill3DRectangle, Tk_Draw3DPolygon, Tk_Fill3DPolygon, Tk_3DVerticalBevel, Tk_3DHorizontalBevel, Tk_SetBackgroundFromBorder, Tk_NameOf3DBorder, Tk_3DBorderColor, Tk_3DBorderGC, Tk_Free3DBorderFromObj, Tk_Free3DBorder \- draw borders with three-dimensional appearance
+Tk_Alloc3DBorderFromObj, Tk_ClipDrawableToRect, Tk_DrawHighlightBorder, Tk_Get3DBorder, Tk_Get3DBorderColors, Tk_Get3DBorderFromObj, Tk_Draw3DRectangle, Tk_Fill3DRectangle, Tk_Draw3DPolygon, Tk_Fill3DPolygon, Tk_3DVerticalBevel, Tk_3DHorizontalBevel, Tk_SetBackgroundFromBorder, Tk_NameOf3DBorder, Tk_3DBorderColor, Tk_3DBorderGC, Tk_Free3DBorderFromObj, Tk_Free3DBorder \- draw borders with three-dimensional appearance
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
diff --git a/doc/AddOption.3 b/doc/AddOption.3
index a331455..fc46492 100644
--- a/doc/AddOption.3
+++ b/doc/AddOption.3
@@ -14,7 +14,7 @@ Tk_AddOption \- Add an option to the option database
void
\fBTk_AddOption\fR(\fItkwin, name, value, priority\fR)
.sp
-void
+Tcl_Obj *
\fBTk_GetSystemDefault\fR(\fItkwin, dbName, className\fR)
.SH ARGUMENTS
.AP Tk_Window tkwin in
@@ -40,20 +40,22 @@ classes separated by asterisks or dots, in the usual X format.
this value will be returned in calls to \fBTk_GetOption\fR.
\fIPriority\fR specifies the priority of the value; when options are
queried using \fBTk_GetOption\fR, the value with the highest priority
-is returned. \fIPriority\fR must be between 0 and \fBTK_MAX_PRIO\fR. Some
-common priority values are:
-.IP 20
+is returned. \fIPriority\fR must be between 0 and \fBTK_MAX_PRIO\fR (100).
+Some common priority values are:
+.IP \fBTK_WIDGET_DEFAULT_PRIO\fR (20)
Used for default values hard-coded into widgets.
-.IP 40
+.IP \fBTK_STARTUP_FILE_PRIO\fR (40)
Used for options specified in application-specific startup files.
-.IP 60
+.IP \fBTK_USER_DEFAULT_PRIO\fR (60)
Used for options specified in user-specific defaults files, such as
\fB.Xdefaults\fR, resource databases loaded into the X server, or
user-specific startup files.
-.IP 80
+.IP \fBTK_INTERACTIVE_PRIO\fR (80)
Used for options specified interactively after the application starts
running.
-\fBTk_GetSystemDefault\fR return a Tk_Uid string representation of the given \fIdbname\fR and \fIclassName\fR of a configuration option.
+.PP
+\fBTk_GetSystemDefault\fR returns a Tcl_Obj* with the string identifying
+a configuration option matching the given \fIdbname\fR and \fIclassName\fR.
Returns NULL if there are no system defaults that match this pair.
.SH KEYWORDS
class, name, option, add
diff --git a/doc/menu.n b/doc/menu.n
index 109a94b..26004a2 100644
--- a/doc/menu.n
+++ b/doc/menu.n
@@ -356,9 +356,14 @@ Specifies the entry numerically, where 0 corresponds
to the top-most entry of the menu, 1 to the entry below it, and
so on.
.TP 12
+\fIid\fR
+.
+If the index does not satisfy one of the above forms then the menu is
+searched for an entry with the specified id.
+.TP 12
\fIpattern\fR
.
-If the index does not satisfy one of the above forms then this
+If all of the above methods for finding an entry fail, this
form is used. \fIPattern\fR is pattern-matched against the label of
each entry in the menu, in order from the top down, until a
matching entry is found. The rules of \fBstring match\fR
@@ -381,15 +386,18 @@ is specified as \fB{}\fR or \fBnone\fR, or if the specified entry is
disabled, then the menu ends up with no active entry.
Returns an empty string.
.TP
-\fIpathName \fBadd \fItype \fR?\fIoption value option value ...\fR?
+\fIpathName \fBadd \fItype \fR?\fIid\fR? ?\fIoption value option value ...\fR?
.
Add a new entry to the bottom of the menu. The new entry's type
is given by \fItype\fR and must be one of \fBcascade\fR,
\fBcheckbutton\fR, \fBcommand\fR, \fBradiobutton\fR, or \fBseparator\fR,
-or a unique abbreviation of one of the above. If additional arguments
-are present, they specify the options listed in the \fBMENU ENTRY OPTIONS\fR
-section below.
-The \fBadd\fR widget command returns an empty string.
+or a unique abbreviation of one of the above.
+If the \fIid\fR argument is specified, it is used as the entry identifier;
+\fIid\fR must not already exist in the menu. Otherwise, a new unique
+identifier is generated.
+If additional arguments are present, they specify the options listed in the
+\fBMENU ENTRY OPTIONS\fR section below.
+The \fBadd\fR widget command returns the id of the new entry.
.TP
\fIpathName \fBcget \fIoption\fR
.
@@ -450,19 +458,28 @@ If no \fIoptions\fR are specified, returns a list describing
the current options for entry \fIindex\fR (see \fBTk_ConfigureInfo\fR for
information on the format of this list).
.TP
+\fIpathName \fBid \fIindex\fR
+.
+Returns the id of the menu entry given by \fIindex\fR.
+This is the identifier that was assigned to the entry when it was created
+using the \fBadd\fR or \fBinsert\fR widget command.
+Returns an empty string for the tear-off entry, or if \fIindex\fR is
+equivalent to \fB{}\fR.
+.TP
\fIpathName \fBindex \fIindex\fR
.
Returns the numerical index corresponding to \fIindex\fR, or
\fB{}\fR if \fIindex\fR was specified as \fB{}\fR or \fBnone\fR.
.TP
-\fIpathName \fBinsert \fIindex type \fR?\fIoption value option value ...\fR?
+\fIpathName \fBinsert \fIindex type \fR?\fIid\fR? ?\fIoption value option value ...\fR?
.
Same as the \fBadd\fR widget command except that it inserts the new
entry just before the entry given by \fIindex\fR, instead of appending
-to the end of the menu. The \fItype\fR, \fIoption\fR, and \fIvalue\fR
-arguments have the same interpretation as for the \fBadd\fR widget
-command. It is not possible to insert new menu entries before the
+to the end of the menu. The \fItype\fR, \fIid\fR, \fIoption\fR, and
+\fIvalue\fR arguments have the same interpretation as for the \fBadd\fR
+widget command. It is not possible to insert new menu entries before the
tear-off entry, if the menu has one.
+The \fBinsert\fR widget command returns the id of the new entry.
.TP
\fIpathName \fBinvoke \fIindex\fR
.
diff --git a/doc/ttk_style.n b/doc/ttk_style.n
index 057a1db..09c8f6c 100644
--- a/doc/ttk_style.n
+++ b/doc/ttk_style.n
@@ -169,6 +169,33 @@ ttk::style layout Horizontal.TScrollbar {
}
}
.CE
+.SH ROOT STYLE
+.PP
+The
+.QW .
+theme root style can be configured like any other style, providing defaults
+for its derived styles. In addition to the usual options,
+.QW .
+styling options configurable with \fBttk::style\fP are:
+.PP
+\fB\-insertofftime\fP \fIamount\fP
+.RS
+Specifies a non-negative integer value indicating the number of milliseconds
+the insertion cursor should remain
+.QW off
+in each blink cycle. If this option is zero then the cursor does not blink:
+it is on all the time. Defaults to 300 ms, unless overriden with a
+\fBRESOURCE_MANAGER\fR property or \fB.Xdefaults\fR file.
+.RE
+.PP
+\fB\-insertontime\fP \fIamount\fP
+.RS
+Specifies a non-negative integer value indicating the number of milliseconds
+the insertion cursor should remain
+.QW on
+in each blink cycle. Defaults to 600 ms, unless overriden with a
+\fBRESOURCE_MANAGER\fR property or \fB.Xdefaults\fR file.
+.RE
.SH "SEE ALSO"
ttk::intro(n), ttk::widget(n), photo(n), ttk_image(n)
.SH KEYWORDS