You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
483 lines
14 KiB
483 lines
14 KiB
<HTML> |
|
<HEAD><TITLE>NoteBook</TITLE></HEAD> |
|
<BODY BGCOLOR=white> |
|
<DL><DT><I><A HREF="#descr">NAME</A></I></DT> |
|
<DD><B>NoteBook</B> |
|
- Notebook manager widget |
|
</DD></DL> |
|
<DL> |
|
<DT><I>CREATION</I></DT> |
|
<DD><A HREF="#descr"><B>NoteBook</B></A> <I>pathName</I> ?<I>option value...</I>?</DD> |
|
</DL> |
|
<DL> |
|
<DT><I>STANDARD OPTIONS</I></DT> |
|
<DD><TABLE CELLSPACING=0 CELLSPACING=0 BORDER=0> |
|
<TR> |
|
<TD> <A HREF="options.htm#M-font">-font</A></TR> |
|
</TABLE></DD> |
|
</DL> |
|
<DL> |
|
<DT><I><A HREF="ArrowButton.html">OPTIONS from <B>ArrowButton</B></A></I></DT> |
|
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> |
|
<TR> |
|
<TD> -activebackground</TD> |
|
<TD> -activeforeground</TD> |
|
</TR> |
|
<TR> |
|
<TD> -background or -bg</TD> |
|
<TD> -borderwidth or -bd</TD> |
|
</TR> |
|
<TR> |
|
<TD> -disabledforeground</TD> |
|
<TD> -foreground or -fg</TD> |
|
</TR> |
|
<TR> |
|
<TD> -repeatdelay</TD> |
|
<TD> -repeatinterval</TD> |
|
</TR> |
|
</TABLE></DD> |
|
</DL> |
|
<DL> |
|
<DT><I><A HREF="#wso">WIDGET-SPECIFIC OPTIONS</A></I></DT> |
|
<DD><TABLE CELLSPACING=0 CELLSPACING=0 BORDER=0> |
|
<TR> |
|
<TD> <A HREF="#-arcradius">-arcradius</A></TD> |
|
<TD> <A HREF="#-height">-height</A></TD> |
|
</TR> |
|
<TR> |
|
<TD> <A HREF="#-homogeneous">-homogeneous</A></TD> |
|
<TD> <A HREF="#-internalborderwidth">-internalborderwidth or -ibd</A></TD> |
|
</TR> |
|
<TR> |
|
<TD> <A HREF="#-side">-side</A></TD> |
|
<TD> <A HREF="#-tabbevelsize">-tabbevelsize</A></TD> |
|
</TR> |
|
<TR> |
|
<TD> <A HREF="#-tabpady">-tabpady</A></TD> |
|
<TD> <A HREF="#-width">-width</A></TD> |
|
</TR> |
|
</TABLE></DD> |
|
</DL> |
|
<DL> |
|
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT> |
|
<DD><I>pathName</I> <A HREF="#bindtabs"><B>bindtabs</B></A> |
|
<I>event</I> |
|
<I>script</I> |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A> |
|
<I>option</I> |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#compute_size"><B>compute_size</B></A> |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#configure"><B>configure</B></A> |
|
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...? |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#delete"><B>delete</B></A> |
|
<I>page</I> |
|
?<I>destroyframe</I>? |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#getframe"><B>getframe</B></A> |
|
<I>page</I> |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#index"><B>index</B></A> |
|
<I>page</I> |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#insert"><B>insert</B></A> |
|
<I>index</I> |
|
<I>page</I> |
|
?<I>option value...</I>? |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#itemcget"><B>itemcget</B></A> |
|
<I>page</I> |
|
<I>option</I> |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#itemconfigure"><B>itemconfigure</B></A> |
|
<I>page</I> |
|
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...? |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#move"><B>move</B></A> |
|
<I>page</I> |
|
<I>index</I> |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#page"><B>page</B></A> |
|
<I>first</I> |
|
?<I>last</I>? |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#pages"><B>pages</B></A> |
|
?<I>first</I>? |
|
?<I>last</I>? |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#raise"><B>raise</B></A> |
|
?<I>page</I>? |
|
</DD> |
|
<DD><I>pathName</I> <A HREF="#see"><B>see</B></A> |
|
<I>page</I> |
|
</DD> |
|
</DL> |
|
<BR><HR WIDTH="100%"><BR> |
|
<B><A NAME="descr"></A>DESCRIPTION</B><BR> |
|
<P> |
|
|
|
The NoteBook widget manages a set of pages and displays one of them. A page |
|
is a <B>frame</B> or <B>ttk::frame</B> that is included in the NoteBook by its |
|
<A HREF="#insert"><B>insert</B></A> command. Each page is associated with a tab; |
|
the tabs are displayed in a band either above or below the pages, depending on |
|
the value of the option <A HREF="#-side">-side</A>. |
|
|
|
</P> |
|
<BR><HR WIDTH="50%"><BR> |
|
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR> |
|
<DL><DT><A NAME="-arcradius"><B>-arcradius</B></A></DT> |
|
<DD> |
|
|
|
Specifies the amount of rounding effect at the corners of a tab. This value |
|
can be adjusted from 0 to 8 pixels with the default being 2 pixels. Usually, |
|
small values are preferable. |
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="-height"><B>-height</B></A></DT> |
|
<DD> |
|
|
|
Specifies the desired height for the pages. If this option is equal to zero (the default) |
|
then the window will not request any size at all. |
|
In this case, user may want to call NoteBook::<B>compute_size</B> to make NoteBook larger |
|
enough to contains the largest page. |
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="-homogeneous"><B>-homogeneous</B></A></DT> |
|
<DD> |
|
|
|
Specifies whether or not the label of the pages must have the same width. |
|
|
|
</DD> |
|
</DL> |
|
|
|
<DL><DT><A NAME="-internalborderwidth"><B>-internalborderwidth</B> or <B>-ibd</B></A></DT> |
|
<DD> |
|
|
|
Value that is applied to each page in the NoteBook as its <B>-borderwidth</B> or <B>-bd</B>. |
|
|
|
</DD> |
|
</DL> |
|
|
|
|
|
<DL><DT><A NAME="-side"><B>-side</B></A></DT> |
|
<DD> |
|
|
|
Specifies the side where to place the label of the pages. Must be one |
|
of <B>top</B> or <B>bottom</B>. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="-tabbevelsize"><B>-tabbevelsize</B></A></DT> |
|
<DD> |
|
|
|
Specifies the amount of bevel the tabs should have. This value can be adjusted from |
|
0 to 8 pixels with the default being 0 pixels. A zero pixel bevel is essentially rectangular |
|
while non-zero bevel size will look trapezoidal. |
|
</DD> |
|
</DL> |
|
|
|
<DL><DT><A NAME="-tabpady"><B>-tabpady</B></A></DT> |
|
<DD> |
|
Specifies the padding between the text in the tab and the top and bottom |
|
of the tab. Padding may be a list of two values to specify padding for |
|
top and bottom separately. Padding defaults to {0 6}. |
|
</DD> |
|
</DL> |
|
|
|
<DL><DT><A NAME="-width"><B>-width</B></A></DT> |
|
<DD> |
|
|
|
Specifies the desired width for the pages. If this option is equal to zero (the default) |
|
then the window will not request any size at all. |
|
In this case, user may want to call NoteBook::<B>compute_size</B> to make NoteBook larger |
|
enough to contains the largest page. |
|
</DD> |
|
</DL> |
|
<HR WIDTH="50%"><BR> |
|
<B><A NAME="wc">WIDGET COMMAND</A></B><BR> |
|
<DL><DT><A NAME="bindtabs"><I>pathName</I> <B>bindtabs</B></A> |
|
<I>event</I> |
|
<I>script</I> |
|
</DT><DD> |
|
|
|
This command associates a command to execute whenever the event |
|
sequence given by <I>event</I> occurs on a tab. The page identifier on which |
|
the event occurs is appended to the command. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="cget"><I>pathName</I> <B>cget</B></A> |
|
<I>option</I> |
|
</DT><DD> |
|
|
|
Returns the current value of the configuration option given by <I>option</I>. |
|
<I>Option</I> may have any of the values accepted by the creation command. |
|
</DD></DL> |
|
<DL><DT><A NAME="compute_size"><I>pathName</I> <B>compute_size</B></A> |
|
</DT><DD> |
|
|
|
This command can be called to make the NoteBook large enough to contain the largest page. |
|
Note that if all pages use -createcmd, they will have no requested size. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="configure"><I>pathName</I> <B>configure</B></A> |
|
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...? |
|
</DT><DD> |
|
|
|
Query or modify the configuration options of the widget. If no <I>option</I> is specified, |
|
returns a list describing all of the available options for <I>pathName</I>. |
|
If <I>option</I> is specified with no <I>value</I>, then the command returns a list |
|
describing the one named <I>option</I> (this list will be identical to the corresponding |
|
sublist of the value returned if no <I>option</I> is specified). If one or |
|
more <I>option-value</I> pairs are specified, then the command modifies the given widget |
|
option(s) to have the given value(s); in this case the command returns an empty string. |
|
<I>Option</I> may have any of the values accepted by the creation command. |
|
Read-only options are not be modified. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="delete"><I>pathName</I> <B>delete</B></A> |
|
<I>page</I> |
|
?<I>destroyframe</I>? |
|
</DT><DD> |
|
|
|
Deletes the page <I>page</I>. If <I>destroyframe</I> is 1 (the default), the frame |
|
associated to <I>page</I> is destroyed. If <I>destroyframe</I> is 0, the frame is not |
|
destroyed and is reused by further call to <B>insert</B> with the same <I>page</I>. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="getframe"><I>pathName</I> <B>getframe</B></A> |
|
<I>page</I> |
|
</DT><DD> |
|
|
|
Returns the pathname of the page <I>page</I>. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="index"><I>pathName</I> <B>index</B></A> |
|
<I>page</I> |
|
</DT><DD> |
|
|
|
Return the numerical index corresponding to the item. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="insert"><I>pathName</I> <B>insert</B></A> |
|
<I>index</I> |
|
<I>page</I> |
|
?<I>option value...</I>? |
|
</DT><DD> |
|
|
|
Insert a new page identified by <I>page</I> at position <I>index</I> in the pages list. |
|
<I>index</I> must be numeric or <B>end</B>. The pathname of the new page is returned. |
|
Dynamic help, if it is specified by the options, is |
|
displayed when the pointer hovers over the tab that belongs to the page. |
|
|
|
<P> |
|
<DL><DT><A NAME="Page-activebackground"><B>-activebackground</B></A></DT> |
|
<DD> |
|
|
|
Background color for the tab when it is active. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-activeforeground"><B>-activeforeground</B></A></DT> |
|
<DD> |
|
|
|
Color used for the tab's text when the tab is active. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-background"><B>-background</B></A></DT> |
|
<DD> |
|
|
|
Background color for the tab when it is not active. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-createcmd"><B>-createcmd</B></A></DT> |
|
<DD> |
|
|
|
Specifies a command to be called the first time the page is raised. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-disabledforeground"><B>-disabledforeground</B></A></DT> |
|
<DD> |
|
|
|
Color used for the tab's text when the tab is disabled. |
|
|
|
</DD> |
|
</DL> |
|
|
|
<DL><DT><A NAME="Page-foreground"><B>-foreground</B></A></DT> |
|
<DD> |
|
|
|
Color used for the tab's text when the tab is neither active nor disabled. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-helpcmd"><B>-helpcmd</B></A></DT> |
|
<DD> |
|
|
|
Has no effect. |
|
See also <A HREF="DynamicHelp.html">DynamicHelp</A>. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-helptext"><B>-helptext</B></A></DT> |
|
<DD> |
|
|
|
Text for dynamic help. If empty, no help is available for this page. |
|
See also <A HREF="DynamicHelp.html">DynamicHelp</A>. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-helptype"><B>-helptype</B></A></DT> |
|
<DD> |
|
|
|
Type of dynamic help. Use <I>balloon</I> (the default for a NoteBook |
|
page) or <I>variable</I>. |
|
See also <A HREF="DynamicHelp.html">DynamicHelp</A>. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-helpvar"><B>-helpvar</B></A></DT> |
|
<DD> |
|
|
|
Variable to use when <B>-helptype</B> option is <I>variable</I>. |
|
See also <A HREF="DynamicHelp.html">DynamicHelp</A>. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-image"><B>-image</B></A></DT> |
|
<DD> |
|
|
|
Specifies an image to display for the page at the left of the label |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-leavecmd"><B>-leavecmd</B></A></DT> |
|
<DD> |
|
|
|
Specifies a command to be called when a page is about to be leaved. |
|
The command must return 0 if the page can not be leaved, or 1 if it can. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-ractiveimage"><B>-ractiveimage</B></A></DT> |
|
<DD> |
|
|
|
Image to show on the right of the tab when the tab is active. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-raisecmd"><B>-raisecmd</B></A></DT> |
|
<DD> |
|
|
|
Specifies a command to be called each time the page is raised. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-rimage"><B>-rimage</B></A></DT> |
|
<DD> |
|
|
|
Image to show on the right of the tab when the tab is not active. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-rimagecmd"><B>-rimagecmd</B></A></DT> |
|
<DD> |
|
|
|
Specifies a command to be evaluated, with two arguments appended, when the |
|
image shown on the right of the tab is clicked. The first appended argument |
|
is the Tk window path of the NoteBook, the second is the name of the page. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-state"><B>-state</B></A></DT> |
|
<DD> |
|
|
|
Specifies the state of the page. Must be <B>normal</B> or <B>disabled</B>. |
|
|
|
</DD> |
|
</DL> |
|
<DL><DT><A NAME="Page-text"><B>-text</B></A></DT> |
|
<DD> |
|
|
|
Specifies a label to display for the page. |
|
|
|
</DD> |
|
</DL> |
|
</DD></DL> |
|
<DL><DT><A NAME="itemcget"><I>pathName</I> <B>itemcget</B></A> |
|
<I>page</I> |
|
<I>option</I> |
|
</DT><DD> |
|
|
|
Returns the current value of a configuration option for the item. |
|
<I>Option</I> may have any of the values accepted by the item creation command. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="itemconfigure"><I>pathName</I> <B>itemconfigure</B></A> |
|
<I>page</I> |
|
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...? |
|
</DT><DD> |
|
|
|
This command is similar to the <B>configure</B> command, except that it applies to the |
|
options for an individual item, whereas <B>configure</B> applies to the options for |
|
the widget as a whole. <B>Options</B> may have any of the values accepted by the |
|
item creation widget command. If options are specified, options are modified as indicated |
|
in the command and the command returns an empty string. If no options are specified, |
|
returns a list describing the current options for the item. |
|
Read-only options are not be modified. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="move"><I>pathName</I> <B>move</B></A> |
|
<I>page</I> |
|
<I>index</I> |
|
</DT><DD> |
|
|
|
Moves <I>page</I> tab to index <I>index</I>. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="page"><I>pathName</I> <B>page</B></A> |
|
<I>first</I> |
|
?<I>last</I>? |
|
</DT><DD> |
|
|
|
<B>Its use is deprecated. Use <I>pages</I> instead.</B><BR> |
|
If <I>last</I> is omitted, returns the page at index <I>first</I>, or an empty string if |
|
<I>first</I> refers to a non-existent element. If <I>last</I> is specified, the command |
|
returns a list whose elements are all of the pages between <I>first</I> and <I>last</I>, |
|
inclusive. Both <I>first</I> and <I>last</I> may have any of the standard |
|
forms for indices. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="pages"><I>pathName</I> <B>pages</B></A> |
|
?<I>first</I>? |
|
?<I>last</I>? |
|
</DT><DD> |
|
|
|
If <I>first</I> and <I>last</I> are omitted, returns the list of all pages. |
|
If <I>first</I> is specified and <I>last</I> omitted, returns the page at index |
|
<I>first</I>, or an empty string if <I>first</I> refers to a non-existent element. |
|
If <I>first</I> and <I>last</I> are specified, the command returns a list whose elements |
|
are all of the pages between <I>first</I> and <I>last</I>, |
|
inclusive. Both <I>first</I> and <I>last</I> may have any of the standard |
|
forms for indices. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="raise"><I>pathName</I> <B>raise</B></A> |
|
?<I>page</I>? |
|
</DT><DD> |
|
|
|
Raise the page <I>page</I>, or return the raised page if <I>page</I> is omitted. |
|
|
|
</DD></DL> |
|
<DL><DT><A NAME="see"><I>pathName</I> <B>see</B></A> |
|
<I>page</I> |
|
</DT><DD> |
|
|
|
Scrolls labels to make the label of the page <I>page</I> visible. |
|
|
|
</DD></DL> |
|
</BODY></HTML>
|
|
|