175 lines
5.6 KiB
HTML
175 lines
5.6 KiB
HTML
|
<HTML>
|
||
|
|
<HEAD><TITLE>PagesManager</TITLE></HEAD>
|
||
|
|
<BODY BGCOLOR=white>
|
||
|
|
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||
|
|
<DD><B>PagesManager</B>
|
||
|
|
- Pages manager widget
|
||
|
|
</DD></DL>
|
||
|
|
<DL>
|
||
|
|
<DT><I>CREATION</I></DT>
|
||
|
|
<DD><A HREF="#descr"><B>PagesManager</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-background">-background</A></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="#-height">-height</A></TR>
|
||
|
|
<TD> <A HREF="#-width">-width</A></TR>
|
||
|
|
</TR>
|
||
|
|
</TABLE></DD>
|
||
|
|
</DL>
|
||
|
|
<DL>
|
||
|
|
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||
|
|
<DD><I>pathName</I> <A HREF="#add"><B>add</B></A>
|
||
|
|
<I>page</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>
|
||
|
|
</DD>
|
||
|
|
<DD><I>pathName</I> <A HREF="#getframe"><B>getframe</B></A>
|
||
|
|
<I>page</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>
|
||
|
|
</DL>
|
||
|
|
<BR><HR WIDTH="100%"><BR>
|
||
|
|
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
PagesManager widget manage a set of pages and displays one of them.
|
||
|
|
PagesManager does not provide any user access method, as NoteBook does,
|
||
|
|
so it can be done through a listbox, a menu, radiobutton, or whatever.
|
||
|
|
|
||
|
|
</P>
|
||
|
|
<BR><HR WIDTH="50%"><BR>
|
||
|
|
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||
|
|
<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 PagesManager::<B>compute_size</B> to make PagesManager
|
||
|
|
larger enough to contains the largest page.
|
||
|
|
</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 PagesManager::<B>compute_size</B> to make PagesManager
|
||
|
|
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="add"><I>pathName</I> <B>add</B></A>
|
||
|
|
<I>page</I>
|
||
|
|
</DT><DD>
|
||
|
|
|
||
|
|
Add a new page idendified by <I>page</I>. The pathname of the new page
|
||
|
|
is returned.
|
||
|
|
|
||
|
|
</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 PagesManager large enough to contain the largest page.
|
||
|
|
|
||
|
|
</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>
|
||
|
|
</DT><DD>
|
||
|
|
|
||
|
|
Deletes the page <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="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>
|
||
|
|
</BODY></HTML>
|