scrollutil::pagesman Commandscrollutil::pagesman – Create and manipulate
pagesman widgetsscrollutil::pagesman pathName ?options?
-background -highlightbackground -relief -borderwidth -highlightcolor -cursor -highlightthickness
-forgetcommand
command-height
screenDistance-leavecommand
command-takefocus
0|1|""|command-width
screenDistance-padding
padding-sticky
stickynesspathName add window
?option value option value ...?pathName adjustsizepathName attrib ?name
?value name value ...??pathName cget
optionpathName configure
?option ?value option value ...??pathName forget
pageIndexpathName hasattrib
namepathName haspageattrib
pageIndex namepathName index
windowpathName insert
pageIndex window ?option value option
value ...?pathName pageattrib
pageIndex ?name ?value name value
...??pathName pagecget
pageIndex optionpathName pageconfigure
pageIndex ?option ?value option
value ...??pathName pagespathName select
?pageIndex?pathName sizepathName unsetattrib
namepathName unsetpageattrib pageIndex
namepathName window
pageIndexscrollutil::pagesman – Create and manipulate
pagesman widgetsscrollutil::pagesman pathName ?options?
scrollutil::pagesman command creates a new
window named pathName and of the class
Pagesman, and makes it into a pagesman
widget. Additional options, described below, may be specified on the
command line or in the option database to configure aspects of the
pagesman widget such as its width, height, borderwidth, and relief.
The scrollutil::pagesman command returns its
pathName argument. At the time this command is
invoked, there must not exist a window named pathName,
but pathName's parent must exist.-background -highlightbackground -relief -borderwidth -highlightcolor -cursor -highlightthickness
-background,
-highlightbackground,
-highlightcolor, and
-highlightthickness options are only supported by the
Scrollutil package, but not by Scrollutil_tile. They have the same
default values as the options of the same names for Tk frame widgets.
The default values of the remaining standard options are:-borderwidth 0 -cursor "" -relief flat
| Command-Line Name: | -forgetcommand |
| Database Name: | forgetCommand |
| Database Class: | ForgetCommand |
Specifies a command to be invoked when attempting to unmanage a window with the aid of the
forgetsubcommand. If the option's value is a nonempty string then it is concatenated with the path name of the pagesman widget and that of the window to be unmanaged, and the resulting script, which must return a boolean, is evaluated in the global scope. If the return value of this script is false then theforgetsubcommand is aborted, i.e., the window is not unmanaged. The default is an empty string.
| Command-Line Name: | -height |
| Database Name: | height |
| Database Class: | Height |
If present and greater than zero, specifies the desired total height for the widget, including the border and highlight rectangle (if any) drawn around the outside of the widget, in any of the forms acceptable to
Tk_GetPixels. Otherwise, the maximum requested height of all pages is used. The default is0.
| Command-Line Name: | -leavecommand |
| Database Name: | leaveCommand |
| Database Class: | LeaveCommand |
Specifies a command to be invoked when attempting to leave the currently selected window by selecting a different one with the aid of the
selectsubcommand. If the option's value is a nonempty string then it is concatenated with the path name of the pagesman widget and that of the currently selected window, and the resulting script, which must return a boolean, is evaluated in the global scope. If the return value of this script is false then the operation of selecting a different window is aborted. The default is an empty string.
| Command-Line Name: | -takefocus |
| Database Name: | takeFocus |
| Database Class: | TakeFocus |
This option determines whether the pagesman widget accepts the focus during keyboard traversal. It is almost identical to the standard option of the same name (see the options manual entry for details). The only difference is that not the pagesman widget itself but the currently selected window (if any) will receive the focus during keyboard traversal with the standard keys (
TabandShift-Tab). The default is an empty string.
| Command-Line Name: | -width |
| Database Name: | width |
| Database Class: | Width |
If present and greater than zero, specifies the desired total width for the widget, including the border and highlight rectangle (if any) drawn around the outside of the widget, in any of the forms acceptable to
Tk_GetPixels. Otherwise, the maximum requested width of all pages is used. The default is0.
add, insert, pagecget, and pageconfigure commands:-padding
paddingpadding must be a list of up to
four nonnegative screen distances {left top
right bottom}. If fewer than four elements
are specified, bottom defaults to
top, right defaults to
left, and top defaults to
left. A padding value specified as an empty
list is equivalent to 0, which is the default.-sticky
stickynessstickyness must be a string
containing zero or more of the characters n,
s, e, or
w. Each letter refers to a side (north,
south, east, or west) that the page window will “stick” to, as per the
grid geometry manager. The default stickyness
is nsew.scrollutil::pagesman command creates a new Tcl
command whose name is pathName. This command
may be used to invoke various operations on the widget. It has the
following general form:
pathName option ?arg arg ...?
option and the args determine
the exact behavior of the command. In the subcommand descriptions
below, pageIndex always denotes a numerical page index,
which, with the exception of the insert subcommand, must be greater than or equal
to zero and less than the number of pages. The following subcommands
are possible for pagesman widgets:pathName add window
?option value option value ...?window is already managed by the pagesman widget,
then the subcommand uses its optional arguments to update the options
of the corresponding page.pathName
adjustsize-height option to the maximum requested height
of all pages and its -width
option to the maximum requested width of all pages.-height and
-width options have their default value
0 then in many cases there is no need to precede an
invocation of this subcommand for the pagesman widget by invocations of
the subcommand of the same name for its pages, because each
plainnotebook will automatically adapt its requested size to the
maximum requested size of its panes. For example, a font size
change in some panes of some of the pages might make it necessary to
invoke this subcommand for the pagesman widget, and at the invocation
time its pages will already have their requested sizes automatically
adapted to the new font size.pathName attrib
?name ?value name value ...??name is specified, the command returns a list of
pairs, each of which contains the name and the value of an attribute
for pathName. If name is
specified with no value, then the command returns
the value of the one named attribute, or an empty string if no
corresponding value exists (you can use the hasattrib subcommand to distinguish this
case from the one that the value of an existing attribute is an
empty string). If one or more
name-value pairs are specified,
then the command sets the given widget attribute(s) to the given
value(s); in this case the return value is an empty string. Each
name may be an arbitrary string.pathName cget
optionoption, which may have any of the values accepted
by the scrollutil::pagesman command.pathName configure
?option ?value option value
...??option is specified, the command returns a
list describing all of the available options for
pathName (see Tk_ConfigureInfo
for information on the format of this list). If
option is specified with no
value, then the command returns a list describing
the one named option (this list will be identical to the corresponding
sublist of the value returned if no option is
specified). If one or more
option-value pairs are
specified, then the command modifies the given widget option(s) to have
the given value(s); in this case the return value is an empty
string. option may have any of the values
accepted by the scrollutil::pagesman command.pathName forget
pageIndexpageIndex. The subcommand returns
0 if it was aborted by the command specified as the value
of the -forgetcommand
option, and 1 otherwise.pathName hasattrib
name1 if the attribute name
exists and 0 otherwise.pathName
haspageattrib pageIndex name1 if the attribute name
for the page given by pageIndex exists and
0 otherwise.pathName index
windowadd or insert subcommand.pathName insert
pageIndex window ?option value
option value ...?pageIndex. See the
PAGE CONFIGURATION OPTIONS section for the
list of available options. If window is
already managed by the pagesman widget, then the subcommand moves it to
the specified position and uses its optional arguments to update the
options of the corresponding page. If
pageIndex is less than or equal to zero then the
window is prepended to the list of pages; if it is greater than or
equal to the number of pages then the window is appended to the list of
pages.pathName pageattrib
pageIndex ?name ?value name value
...??pageIndex. If no name is
specified, the command returns a list of pairs, each of which contains
the name and the value of an attribute for the page. If
name is specified with no
value, then the command returns the value of the
one named page attribute, or an empty string if no corresponding value
exists (you can use the haspageattrib subcommand to distinguish
this case from the one that the value of an existing page
attribute is an empty string). If one or more
name-value pairs are specified,
then the command sets the given page attribute(s) to the given
value(s); in this case the return value is an empty string. Each
name may be an arbitrary string.pathName pagecget
pageIndex optionoption for the page specified by
pageIndex. option may
have any of the values accepted by the pageconfigure command.pathName
pageconfigure pageIndex ?option ?value
option value ...??pageIndex. If no option
is specified, the command returns a list describing all of the
available options for the page (see
Tk_ConfigureInfo for information on the format of
this list). If option is specified with no
value, then the command returns a list describing
the one named option (this list will be identical to the corresponding
sublist of the value returned if no option is
specified). If one or more
option-value pairs are
specified, then the command modifies the given page option(s) to have
the given value(s); in this case the return value is an empty
string. option may have any of the values
described in the PAGE CONFIGURATION OPTIONS
section.pathName
pagespathName select
?pageIndex?pageIndex is omitted, the subcommand returns
the path name of the currently selected window. Otherwise it
selects the specified page by mapping the corresponding window and
unmapping the previously-selected one (if different). In this
case, the return value is 0 if the operation of selecting
a different window was aborted by the command specified as the value of
the -leavecommand
option, and 1 otherwise.pathName sizepathName
unsetattrib namename. Returns an
empty string.pathName
unsetpageattrib pageIndex namename for the page given by
pageIndex. Returns an empty string.pathName window
pageIndexpageIndex.<<PagesmanPageChanged>> virtual event.