Initial release
This commit is contained in:
unknown
276
hlp/en/bwidget/ArrowButton.html
Normal file
276
hlp/en/bwidget/ArrowButton.html
Normal file
@@ -0,0 +1,276 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ArrowButton</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ArrowButton</B>
|
||||
- Button widget with an arrow shape.
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ArrowButton</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-activebackground">-activebackground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-activeforeground">-activeforeground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-background">-background or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-disabledforeground">-disabledforeground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightbackground">-highlightbackground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-highlightcolor">-highlightcolor</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightthickness">-highlightthickness</A></TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-repeatdelay">-repeatdelay</A></TR>
|
||||
<TD> <A HREF="options.htm#M-repeatinterval">-repeatinterval</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-takefocus">-takefocus</A></TR>
|
||||
<TD> <A HREF="options.htm#M-troughcolor">-troughcolor</A></TR>
|
||||
</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="#-armcommand">-armcommand</A></TR>
|
||||
<TD> <A HREF="#-arrowbd">-arrowbd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-arrowrelief">-arrowrelief</A></TR>
|
||||
<TD> <A HREF="#-clean">-clean</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-command">-command</A></TR>
|
||||
<TD> <A HREF="#-dir">-dir</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-disarmcommand">-disarmcommand</A></TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-helptext">-helptext</A></TR>
|
||||
<TD> <A HREF="#-helptype">-helptype</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-helpvar">-helpvar</A></TR>
|
||||
<TD> <A HREF="#-ipadx">-ipadx</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-ipady">-ipady</A></TR>
|
||||
<TD> <A HREF="#-state">-state</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-type">-type</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="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#invoke"><B>invoke</B></A>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
ArrowButton can be of two types following <B>type</B> option:
|
||||
for <B>button</B> type, it is standard button with an arrow drawn on it;
|
||||
for <B>arrow</B> type, it is an arrow like scrollbar's arrow.
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-armcommand"><B>-armcommand</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command to associate with the ArrowButton when mouse button 1 is pressed
|
||||
over the ArrowButton. When <B>repeatdelay</B> or <B>repeatinterval</B> option is positive
|
||||
integer, this command is repeatedly called if mouse pointer is over the button and until
|
||||
mouse button 1 is released.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-arrowbd"><B>-arrowbd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
When ArrowButton <B>type</B> is <I>arrow</I>, specifies the border width of the
|
||||
arrow. Must be 1 or 2.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-arrowrelief"><B>-arrowrelief</B></A></DT>
|
||||
<DD>
|
||||
|
||||
When ArrowButton <B>type</B> is <I>arrow</I>, specifies the relief of the arrow.
|
||||
Must be <B>raised</B> or <B>sunken</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-clean"><B>-clean</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a level of quality, between 0 and 2, for the arrow.
|
||||
If 0, the arrow is drawn with its maximum width and height.
|
||||
If 1, the base of arrow is arranged to be odd to have same edges.
|
||||
If 2, the base of arrow is arranged to be odd and the orthogonal to be (base+1)/2 to
|
||||
have 'straight' diagonal for edges.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-command"><B>-command</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command to associate with the ArrowButton. This command
|
||||
is typically invoked when mouse button 1 is released over the ArrowButton
|
||||
window.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dir"><B>-dir</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the direction of the arrow: <B>top</B>, <B>bottom</B>, <B>left</B>
|
||||
or <B>right</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-disarmcommand"><B>-disarmcommand</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command to associate with the ArrowButton when mouse button 1 is released.
|
||||
This command is called even if pointer is not over the ArrowButton, and always before
|
||||
the command specified by <B>command</B> option.
|
||||
It is typically used in conjuntion with <B>armcommand</B>, <B>repeatdelay</B> and
|
||||
<B>repeatinterval</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a desired height for the ArrowButton. The value is in screen units.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-helptext"><B>-helptext</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Text for dynamic help. If empty, no help is available for this widget.
|
||||
See also <A HREF="DynamicHelp.html">DynamicHelp</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-helptype"><B>-helptype</B></A></DT>
|
||||
<DD>
|
||||
Type of dynamic help. Use <I>balloon</I> or <I>variable</I>.
|
||||
See also <A HREF="DynamicHelp.html">DynamicHelp</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-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="-ipadx"><B>-ipadx</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a minimun pad between the ArrowButton border and the right and left side
|
||||
of the arrow. The value is in screen units.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-ipady"><B>-ipady</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a minimun pad between the ArrowButton border and the top and bottom side
|
||||
of the arrow. The value is in screen units.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-state"><B>-state</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies one of three states for the ArrowButton: <B>normal</B>, <B>active</B>,
|
||||
or <B>disabled</B>.
|
||||
<DL><DT>If ArrowButton <B>type</B> is <I>button</I>:</DT>
|
||||
<DD>In normal state the ArrowButton is displayed using the
|
||||
<B>foreground</B> and <B>background</B> options. The active state is
|
||||
typically used when the pointer is over the ArrowButton. In active state
|
||||
the ArrowButton is displayed using the <B>activeforeground</B> and
|
||||
<B>activebackground</B> options. In disabled state the <B>disabledforeground</B> and
|
||||
<B>background</B> options determine how the ArrowButton is displayed.
|
||||
</DD>
|
||||
<DT>If ArrowButton <B>type</B> is <I>arrow</I>:</DT>
|
||||
<DD>Only colors of arrow change. The background of ArrowButton is always
|
||||
displayed using <B>troughcolor</B> option.
|
||||
In normal state the ArrowButton is displayed using the <B>background</B> option. The active
|
||||
state is typically used when the pointer is over the ArrowButton. In active state
|
||||
the ArrowButton is displayed using the <B>activebackground</B> option. In disabled state
|
||||
the ArrowButton is displayed with a dark stipple.
|
||||
</DD>
|
||||
</DL>
|
||||
Disabled state means that the ArrowButton
|
||||
should be insensitive: the default bindings will refuse to activate
|
||||
the widget and will ignore mouse button presses.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-type"><B>-type</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Determines the type of the ArrowButton: <B>button</B> for standard button look, or
|
||||
<B>arrow</B> scrollbar's arrow look.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a desired width for the ArrowButton. The value is in screen units.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="invoke"><I>pathName</I> <B>invoke</B></A>
|
||||
</DT><DD>
|
||||
|
||||
If ArrowButton <B>state</B> is not disabled, this invoke the commands of the button.
|
||||
ArrowButton is redisplayed with active color and sunken relief, and
|
||||
<B>armcommand</B> is called. Then ArrowButton is redisplayed with
|
||||
normal color and its defined relief, and <B>disarmcommand</B> then <B>command</B>
|
||||
are called.
|
||||
<P><B>invoke</B> is called when ArrowButton has input focus and user press the space bar.
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
116
hlp/en/bwidget/BWidget.html
Normal file
116
hlp/en/bwidget/BWidget.html
Normal file
@@ -0,0 +1,116 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>BWidget</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>BWidget</B>
|
||||
- Description text
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">COMMAND</A></I></DT>
|
||||
<DD>BWidget::<A HREF="#XLFDfont"><B>XLFDfont</B></A>
|
||||
<I>cmd</I>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#assert"><B>assert</B></A>
|
||||
<I>exp</I>
|
||||
?<I>msg</I>?
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#clonename"><B>clonename</B></A>
|
||||
<I>menu</I>
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#focus"><B>focus</B></A>
|
||||
<I>option</I>
|
||||
<I>path</I>
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#get3dcolor"><B>get3dcolor</B></A>
|
||||
<I>path</I>
|
||||
<I>bgcolor</I>
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#getname"><B>getname</B></A>
|
||||
<I>name</I>
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#grab"><B>grab</B></A>
|
||||
<I>option</I>
|
||||
<I>path</I>
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#lreorder"><B>lreorder</B></A>
|
||||
<I>list</I>
|
||||
<I>neworder</I>
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#parsetext"><B>parsetext</B></A>
|
||||
<I>text</I>
|
||||
</DD>
|
||||
<DD>BWidget::<A HREF="#place"><B>place</B></A>
|
||||
<I>path</I>
|
||||
<I>w</I>
|
||||
<I>h</I>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
Description text
|
||||
</P>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="XLFDfont">BWidget::<B>XLFDfont</B></A>
|
||||
<I>cmd</I>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="assert">BWidget::<B>assert</B></A>
|
||||
<I>exp</I>
|
||||
?<I>msg</I>?
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="clonename">BWidget::<B>clonename</B></A>
|
||||
<I>menu</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="focus">BWidget::<B>focus</B></A>
|
||||
<I>option</I>
|
||||
<I>path</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="get3dcolor">BWidget::<B>get3dcolor</B></A>
|
||||
<I>path</I>
|
||||
<I>bgcolor</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="getname">BWidget::<B>getname</B></A>
|
||||
<I>name</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="grab">BWidget::<B>grab</B></A>
|
||||
<I>option</I>
|
||||
<I>path</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="lreorder">BWidget::<B>lreorder</B></A>
|
||||
<I>list</I>
|
||||
<I>neworder</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="parsetext">BWidget::<B>parsetext</B></A>
|
||||
<I>text</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="place">BWidget::<B>place</B></A>
|
||||
<I>path</I>
|
||||
<I>w</I>
|
||||
<I>h</I>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
273
hlp/en/bwidget/Button.html
Normal file
273
hlp/en/bwidget/Button.html
Normal file
@@ -0,0 +1,273 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>Button</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>Button</B>
|
||||
- Button widget with enhanced options
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>Button</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-activebackground">-activebackground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-activeforeground">-activeforeground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-anchor">-anchor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-background">-background or -bg</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-bitmap">-bitmap</A></TR>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-cursor">-cursor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-disabledforeground">-disabledforeground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-font">-font</A></TR>
|
||||
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightbackground">-highlightbackground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-highlightcolor">-highlightcolor</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightthickness">-highlightthickness</A></TR>
|
||||
<TD> <A HREF="options.htm#M-image">-image</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-justify">-justify</A></TR>
|
||||
<TD> <A HREF="options.htm#M-padx">-padx</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-pady">-pady</A></TR>
|
||||
<TD> <A HREF="options.htm#M-repeatdelay">-repeatdelay</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-repeatinterval">-repeatinterval</A></TR>
|
||||
<TD> <A HREF="options.htm#M-takefocus">-takefocus</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-text">-text</A></TR>
|
||||
<TD> <A HREF="options.htm#M-textvariable">-textvariable</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-wraplength">-wraplength</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="#-armcommand">-armcommand</A></TR>
|
||||
<TD> <A HREF="#-command">-command</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-default">-default</A></TR>
|
||||
<TD> <A HREF="#-disarmcommand">-disarmcommand</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
<TD> <A HREF="#-helptext">-helptext</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-helptype">-helptype</A></TR>
|
||||
<TD> <A HREF="#-helpvar">-helpvar</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-name">-name</A></TR>
|
||||
<TD> <A HREF="#-relief">-relief</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-state">-state</A></TR>
|
||||
<TD> <A HREF="#-underline">-underline</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#invoke"><B>invoke</B></A>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
Button widget extends the Tk button with new options.
|
||||
<A HREF="DynamicHelp.html">DynamicHelp</A> options,
|
||||
a new relief style, callback for <B>arm</B>/<B>disarm</B>, and
|
||||
<B>repeatdelay</B>/<B>repeatinterval</B> options has been added.
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-armcommand"><B>-armcommand</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command to associate with the Button when mouse button 1 is pressed over the
|
||||
Button. When <B>repeatdelay</B> or <B>repeatinterval</B> option is positive integer,
|
||||
this command is repeatedly called if mouse pointer is over the Button and until mouse
|
||||
button 1 is released.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-command"><B>-command</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command to associate with the Button. This command
|
||||
is typically invoked when mouse button 1 is released over the Button
|
||||
window.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-default"><B>-default</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies one of three states for the default ring: <B>normal</B>, <B>active</B>,
|
||||
or <B>disabled</B>. In active state, the button is drawn with the platform specific
|
||||
appearance for a default button. In normal state, the button is drawn with the platform
|
||||
specific appearance for a non-default button, leaving enough space to draw the default
|
||||
button appearance. The normal and active states will result in buttons of the same size.
|
||||
In disabled state, the button is drawn with the non-default button appearance without
|
||||
leaving space for the default appearance. The disabled state may result
|
||||
in a smaller button than the active state.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-disarmcommand"><B>-disarmcommand</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command to associate with the Button when mouse button 1 is released.
|
||||
This command is called even if pointer is not over the Button, and always before
|
||||
the command specified by <B>command</B> option.
|
||||
It is typically used in conjuntion with <B>armcommand</B>, <B>repeatdelay</B> and
|
||||
<B>repeatinterval</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a desired height for the Button.
|
||||
If an image or bitmap is being displayed in the Button then the value is in
|
||||
screen units;
|
||||
for text it is in lines of text.
|
||||
If this option isn't specified, the Button's desired height is computed
|
||||
from the size of the image or bitmap or text being displayed in it.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-helptext"><B>-helptext</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Text for dynamic help. If empty, no help is available for this widget.
|
||||
See also <A HREF="DynamicHelp.html">DynamicHelp</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-helptype"><B>-helptype</B></A></DT>
|
||||
<DD>
|
||||
Type of dynamic help. Use <I>balloon</I> or <I>variable</I>.
|
||||
See also <A HREF="DynamicHelp.html">DynamicHelp</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-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="-name"><B>-name</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a standard name for the button. If the option <B>*<I>name</I>Name</B> is
|
||||
found in the resources database, then <B>text</B> and <B>underline</B> options
|
||||
are extracted from its value.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-relief"><B>-relief</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the 3-D effect desired for the widget. Acceptable values are standard values for
|
||||
button relief (<B>raised</B>, <B>sunken</B>, <B>flat</B>, <B>ridge</B>, <B>solid</B>, and <B>groove</B>) and <B>link</B>, which specifies that button relief is <B>flat</B> when pointer
|
||||
is outside the button and <B>raised</B> when pointer is inside.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-state"><B>-state</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies one of three states for the Button: <B>normal</B>, <B>active</B>,
|
||||
or <B>disabled</B>. In normal state the Button is displayed using the
|
||||
<B>foreground</B> and <B>background</B> options. The active state is
|
||||
typically used when the pointer is over the Button. In active state
|
||||
the Button is displayed using the <B>activeforeground</B> and
|
||||
<B>activebackground</B> options. Disabled state means that the Button
|
||||
should be insensitive: the default bindings will refuse to activate
|
||||
the widget and will ignore mouse button presses.
|
||||
In this state the <B>disabledforeground</B> and
|
||||
<B>background</B> options determine how the Button is displayed.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-underline"><B>-underline</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the integer index of a character to underline in the label of the button.
|
||||
0 corresponds to the first character of the text displayed, 1 to the next character,
|
||||
and so on.
|
||||
<BR>The binding <B><Alt-<I>char</I>></B> is automatically set on the toplevel
|
||||
of the Button to call Button::<B>setfocus</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
If an image or bitmap is being displayed in the Button then the value is in
|
||||
screen units;
|
||||
for text it is in characters.
|
||||
If this option isn't specified, the Button's desired width is computed
|
||||
from the size of the image or bitmap or text being displayed in it.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="invoke"><I>pathName</I> <B>invoke</B></A>
|
||||
</DT><DD>
|
||||
|
||||
If Button <B>state</B> is not disabled, this invoke the commands of the Button.
|
||||
Button is redisplayed with active color and sunken relief, and
|
||||
<B>armcommand</B> is called. Then Button is redisplayed with
|
||||
normal color and its defined relief, and <B>disarmcommand</B> then <B>command</B>
|
||||
are called.
|
||||
<P><B>invoke</B> is called when Button has input focus and user press the space bar.
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
220
hlp/en/bwidget/ButtonBox.html
Normal file
220
hlp/en/bwidget/ButtonBox.html
Normal file
@@ -0,0 +1,220 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ButtonBox</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ButtonBox</B>
|
||||
- Set of buttons with horizontal or vertical layout
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ButtonBox</B></A> <I>pathName</I> ?<I>option value...</I>?</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="#-background">-background or -bg</A></TD>
|
||||
<TD> <A HREF="#-default">-default</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-homogeneous">-homogeneous</A></TR>
|
||||
<TD> <A HREF="#-orient">-orient</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-padx">-padx</A></TR>
|
||||
<TD> <A HREF="#-pady">-pady</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-spacing">-spacing</A></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>option value...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#index"><B>index</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#invoke"><B>invoke</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#itemcget"><B>itemcget</B></A>
|
||||
<I>index</I>
|
||||
<I>option</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#itemconfigure"><B>itemconfigure</B></A>
|
||||
<I>index</I>
|
||||
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#setfocus"><B>setfocus</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
ButtonBox layouts Button horizontally or vertically.
|
||||
Some commands take an <I>index</I> as argument indicating on which
|
||||
Button it work. This index may be specified in any of the following forms:
|
||||
<P>
|
||||
<DL COMPACT>
|
||||
<DT>
|
||||
<I>number</I>
|
||||
<DD>
|
||||
Specifies the Button numerically, where 0 corresponds
|
||||
to the first added Button, 1 to the next, and so on.
|
||||
<DT>
|
||||
<B>end</B> or <B>last</B>
|
||||
<DD>
|
||||
Indicates the last item added.
|
||||
<DT><B>default</B>
|
||||
<DD>
|
||||
Indicates the default Button.
|
||||
</DL>
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-background"><B>-background</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a default background color for all added buttons and for the frame.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-default"><B>-default</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the default button of the button box. The value is an integer
|
||||
referencing the n-th added button, starting from 0.
|
||||
If this value is -1 (the default), all button wil be drawn with their -default
|
||||
option set to disabled, and this value can not be changed. <BR>If this value is
|
||||
not -1, the associated button is drawn with -default option set to active and
|
||||
the others are drawn with -default option set to normal. The value can be changed
|
||||
by configure.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-homogeneous"><B>-homogeneous (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies wether or not buttons must have the same width for horizontal layout.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-orient"><B>-orient (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the orientation of the button box. If this option is <B>horizontal</B>
|
||||
(the default), buttons are added from top to bottom.
|
||||
If this option is <B>vertical</B>, buttons are added from left to right.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-padx"><B>-padx</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a default value for the -padx option of all added buttons.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-pady"><B>-pady</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a default value for the -pady option of all added buttons.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-spacing"><B>-spacing</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the default spacing between buttons. This value can be changed before each
|
||||
call to <B>add</B>.
|
||||
|
||||
</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>option value...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Add a button to the button box.
|
||||
<P>
|
||||
See <A HREF="Button.html"><B>Button</B></A> for description of options.
|
||||
</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="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="index"><I>pathName</I> <B>index</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Return the numerical index corresponding to the item.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="invoke"><I>pathName</I> <B>invoke</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Invoke the Button given by <I>index</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="itemcget"><I>pathName</I> <B>itemcget</B></A>
|
||||
<I>index</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>index</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="setfocus"><I>pathName</I> <B>setfocus</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Set the focus to the Button given by <I>index</I>.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
306
hlp/en/bwidget/ComboBox.html
Normal file
306
hlp/en/bwidget/ComboBox.html
Normal file
@@ -0,0 +1,306 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ComboBox</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ComboBox</B>
|
||||
- ComboBox widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ComboBox</B></A> <I>pathName</I> ?<I>option value...</I>?</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> -background or -bg</TD>
|
||||
<TD> -disabledforeground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -foreground or -fg</TD>
|
||||
<TD> -state</TD>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="Entry.html">OPTIONS from <B>Entry</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -command</TD>
|
||||
<TD> -disabledforeground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dragenabled</TD>
|
||||
<TD> -dragendcmd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dragevent</TD>
|
||||
<TD> -draginitcmd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dragtype</TD>
|
||||
<TD> -dropcmd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dropenabled</TD>
|
||||
<TD> -dropovercmd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -droptypes</TD>
|
||||
<TD> -editable</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -entrybg (see <B>-background</B>)</TD>
|
||||
<TD> -entryfg (see <B>-foreground</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -exportselection</TD>
|
||||
<TD> -font</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helptext</TD>
|
||||
<TD> -helptype</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helpvar</TD>
|
||||
<TD> -highlightbackground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -highlightcolor</TD>
|
||||
<TD> -highlightthickness</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertbackground</TD>
|
||||
<TD> -insertborderwidth</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertofftime</TD>
|
||||
<TD> -insertontime</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertwidth</TD>
|
||||
<TD> -justify</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -selectbackground</TD>
|
||||
<TD> -selectborderwidth</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -selectforeground</TD>
|
||||
<TD> -show</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -state</TD>
|
||||
<TD> -takefocus</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -text</TD>
|
||||
<TD> -textvariable</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -width</TD>
|
||||
<TD> -xscrollcommand</TD>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="LabelFrame.html">OPTIONS from <B>LabelFrame</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -background or -bg</TD>
|
||||
<TD> -borderwidth or -bd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -disabledforeground</TD>
|
||||
<TD> -foreground or -fg</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helptext</TD>
|
||||
<TD> -helptype</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helpvar</TD>
|
||||
<TD> -label (see <B>-text</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -labelanchor (see <B>-anchor</B>)</TD>
|
||||
<TD> -labelfont (see <B>-font</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -labelheight (see <B>-height</B>)</TD>
|
||||
<TD> -labeljustify (see <B>-justify</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -labelwidth (see <B>-width</B>)</TD>
|
||||
<TD> -name</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -padx</TD>
|
||||
<TD> -pady</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -relief</TD>
|
||||
<TD> -side</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -state</TD>
|
||||
<TD> -underline</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -wraplength</TD>
|
||||
</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="#-modifycmd">-modifycmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-postcommand">-postcommand</A></TR>
|
||||
<TD> <A HREF="#-values">-values</A></TR>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#bind"><B>bind</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#getvalue"><B>getvalue</B></A>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#setvalue"><B>setvalue</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
ComboBox widget enables the user to select a value among a list given by the <B>values</B> option.
|
||||
The list of possible values can be popped by pressing the ArrowButton or by clicking in the entry
|
||||
when <B>editable</B> value of the ComboBox is <B>false</B>.<BR>
|
||||
If <B>editable</B> value of the ComboBox is <B>true</B> and the entry has the focus, the user can
|
||||
press the top and bottom arrow keys to modify its value. If the current value exactly match a value in the list,
|
||||
then the previous (for top arrow key) or then next (for bottom arrow key) value in the list is displayed.
|
||||
If the current value match the beginning of a value in the list, then this value is displayed.
|
||||
If the current value doesnt match anything, then the first value is displayed.
|
||||
|
||||
</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 window, in lines. If zero or less, then the desired
|
||||
height for the window is made just large enough to hold all the elements in the listbox.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-modifycmd"><B>-modifycmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command called when the user modify the value of the ComboBox by selecting it in the listbox or pressing arrow key.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-postcommand"><B>-postcommand</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command called before the listbox of the ComboBox is mapped.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-values"><B>-values</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the values to display in the listbox of the ComboBox.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="bind"><I>pathName</I> <B>bind</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Set bindings on the entry widget.
|
||||
|
||||
</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="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="getvalue"><I>pathName</I> <B>getvalue</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Returns the index of the current text of the ComboBox in the list of values,
|
||||
or -1 if it doesn't match any value.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setvalue"><I>pathName</I> <B>setvalue</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Set the text of the ComboBox to the value indicated by <I>index</I> in the list of values.
|
||||
<I>index</I> may be specified in any of the following forms:
|
||||
<P>
|
||||
<DL COMPACT>
|
||||
<DT>
|
||||
<B>last</B>
|
||||
<DD>
|
||||
Specifies the last element of the list of values.
|
||||
<DT><B>first</B>
|
||||
<DD>
|
||||
Specifies the first element of the list of values.
|
||||
<DT>
|
||||
<B>next</B>
|
||||
<DD>
|
||||
Specifies the element following the current (ie returned by <B>getvalue</B>) in the list
|
||||
of values.
|
||||
<DT><B>previous</B>
|
||||
<DD>
|
||||
Specifies the element preceding the current (ie returned by <B>getvalue</B>) in the list
|
||||
of values.
|
||||
<DT>
|
||||
@<I>number</I>
|
||||
<DD>
|
||||
Specifies the integer index in the list of values.
|
||||
</DL>
|
||||
|
||||
</DD></DL>
|
||||
<HR><BR><B>BINDINGS</B><BR><BR>
|
||||
|
||||
When Entry of the ComboBox has the input focus, it has the following bindings, in addition
|
||||
to the default Entry bindings:
|
||||
<UL>
|
||||
<LI>Page up set the value of the ComboBox to the first value.
|
||||
<LI>Page down set the value of the ComboBox to the last value.
|
||||
<LI>Arrow up set the value of the ComboBox to the previous value.
|
||||
<LI>Arrow down set the value of the ComboBox to the next value.
|
||||
</UL>
|
||||
If the listbox is not mapped and ComboBox is not editable or disabled,
|
||||
mouse button 1 on the Entry cause the listbox to popup, as if the user press the ArrowButton.
|
||||
|
||||
</BODY></HTML>
|
||||
293
hlp/en/bwidget/Dialog.html
Normal file
293
hlp/en/bwidget/Dialog.html
Normal file
@@ -0,0 +1,293 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>Dialog</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>Dialog</B>
|
||||
- Dialog abstraction with custom buttons
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>Dialog</B></A> <I>pathName</I> ?<I>option value...</I>?</DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="ButtonBox.html">OPTIONS from <B>ButtonBox</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -background or -bg</TD>
|
||||
<TD> -homogeneous</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -padx</TD>
|
||||
<TD> -pady</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -spacing</TD>
|
||||
</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="#-anchor">-anchor</A></TR>
|
||||
<TD> <A HREF="#-bitmap">-bitmap</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-cancel">-cancel</A></TR>
|
||||
<TD> <A HREF="#-default">-default</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-image">-image</A></TR>
|
||||
<TD> <A HREF="#-modal">-modal</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-parent">-parent</A></TR>
|
||||
<TD> <A HREF="#-separator">-separator</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-side">-side</A></TR>
|
||||
<TD> <A HREF="#-title">-title</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>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#draw"><B>draw</B></A>
|
||||
?<I>focus</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#enddialog"><B>enddialog</B></A>
|
||||
<I>result</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#getframe"><B>getframe</B></A>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#invoke"><B>invoke</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#itemcget"><B>itemcget</B></A>
|
||||
<I>index</I>
|
||||
<I>option</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#itemconfigure"><B>itemconfigure</B></A>
|
||||
<I>index</I>
|
||||
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#setfocus"><B>setfocus</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#withdraw"><B>withdraw</B></A>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
Dialog widget enables the user to create a dialog box.
|
||||
Some commands take an <I>index</I> as argument indicating on which
|
||||
Button it work. This index is the same specified for equivalent ButtonBox command:
|
||||
<P>
|
||||
<DL COMPACT>
|
||||
<DT>
|
||||
<I>number</I>
|
||||
<DD>
|
||||
Specifies the Button numerically, where 0 corresponds
|
||||
to the first added Button, 1 to the next, and so on.
|
||||
<DT>
|
||||
<B>end</B> or <B>last</B>
|
||||
<DD>
|
||||
Indicates the last item added.
|
||||
<DT><B>default</B>
|
||||
<DD>
|
||||
Indicates the default Button.
|
||||
</DL>
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-anchor"><B>-anchor (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the anchor point of the ButtonBox.
|
||||
Must be one of <B>w</B>, <B>e</B>, <B>n</B>, <B>s</B> or <B>c</B>.
|
||||
If <B>side</B> option is set to <I>top</I> or <I>bottom</I>,
|
||||
<B>anchor</B> values <I>n</I>, <I>s</I> and <I>c</I> have the same effect.
|
||||
If <B>side</B> option is set to <I>left</I> or <I>right</I>,
|
||||
<B>anchor</B> values <I>w</I>, <I>e</I> and <I>c</I> have the same effect.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-bitmap"><B>-bitmap (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a bitmap to display at the left of the user frame.
|
||||
<B>image</B> option override <B>bitmap</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-cancel"><B>-cancel</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the number of the cancel button of the Dialog. When user press Esc in the Dialog,
|
||||
this button is invoked.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-default"><B>-default</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the number of the default button of the Dialog.
|
||||
When user press Return in the Dialog, this button is invoked.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-image"><B>-image (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an image to display at the left of the user frame.
|
||||
<B>image</B> option override <B>bitmap</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-modal"><B>-modal</B></A></DT>
|
||||
<DD>
|
||||
|
||||
This option must be <B>none</B>, <B>local</B> or <B>global</B>. The value of this option
|
||||
specifies the grab mode of the dialog and how works Dialog::<B>draw</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-parent"><B>-parent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Parent of the Dialog. Dialog is centered in its parent. If empty, it is centered in
|
||||
root window.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-separator"><B>-separator (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies wether or not to draw a separator between the user frame and the ButtonBox.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-side"><B>-side (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies where to draw the ButtonBox relative to the user frame. Must be one of
|
||||
<B>top</B>, <B>left</B>, <B>bottom</B> or <B>right</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-title"><B>-title</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Title of the Dialog toplevel.
|
||||
|
||||
</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>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Add a button to the button box of the dialog box. Default -command option is
|
||||
<I>Dialog::enddialog $path index</I> where <I>index</I> is number of button added.
|
||||
</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="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="draw"><I>pathName</I> <B>draw</B></A>
|
||||
?<I>focus</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command draw the Dialog, and set grab to it following <B>modal</B> option.
|
||||
If <B>modal</B> option is set to <I>none</I>, the command returns immediatly
|
||||
an empty string. In all other case, the command returns when Dialog::<B>enddialog</B>
|
||||
is called or when Dialog is destroyed.
|
||||
The return value is the result argument of Dialog::<B>enddialog</B> or -1 if it is destroyed.
|
||||
<P>
|
||||
By default, the focus is set to the default button referenced by <B>default</B> option,
|
||||
or to the toplevel of Dialog if no default button has been set.
|
||||
If <I>focus</I> is present, it must be a pathname, or an index to a button.
|
||||
Initial focus is set on this pathname or corresponding button.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="enddialog"><I>pathName</I> <B>enddialog</B></A>
|
||||
<I>result</I>
|
||||
</DT><DD>
|
||||
|
||||
This command is typically called within a command of a button to make Dialog::<B>draw</B>
|
||||
return.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="getframe"><I>pathName</I> <B>getframe</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Returns the pathname of the user window.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="invoke"><I>pathName</I> <B>invoke</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Invoke the Button given by <I>index</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="itemcget"><I>pathName</I> <B>itemcget</B></A>
|
||||
<I>index</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>index</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="setfocus"><I>pathName</I> <B>setfocus</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Set the focus to the Button given by <I>index</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="withdraw"><I>pathName</I> <B>withdraw</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Call this command to hide the dialog box.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
139
hlp/en/bwidget/DragSite.html
Normal file
139
hlp/en/bwidget/DragSite.html
Normal file
@@ -0,0 +1,139 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>DragSite</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>DragSite</B>
|
||||
- Commands set for Drag facilities
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">COMMAND</A></I></DT>
|
||||
<DD>DragSite::<A HREF="#include"><B>include</B></A>
|
||||
<I>class</I>
|
||||
<I>type</I>
|
||||
<I>event</I>
|
||||
</DD>
|
||||
<DD>DragSite::<A HREF="#register"><B>register</B></A>
|
||||
<I>path</I>
|
||||
?<I>option value...</I>?
|
||||
</DD>
|
||||
<DD>DragSite::<A HREF="#setdrag"><B>setdrag</B></A>
|
||||
<I>path</I>
|
||||
<I>subpath</I>
|
||||
<I>initcmd</I>
|
||||
<I>endcmd</I>
|
||||
?<I>force</I>?
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
Commands of this namespace enable user to define a BWidget or a Tk widget as a drag site.
|
||||
|
||||
|
||||
|
||||
</P>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="include">DragSite::<B>include</B></A>
|
||||
<I>class</I>
|
||||
<I>type</I>
|
||||
<I>event</I>
|
||||
</DT><DD>
|
||||
|
||||
This command provides a simple way to include options relatives to a drag site into
|
||||
BWidget resources definition.
|
||||
It includes the options needed for <B>register</B>: <I>-dragevent</I>, initialized to
|
||||
<I>event</I>, <I>-draginitcmd</I> and <I>-dragendcmd</I>, initialized to empty string,
|
||||
and two new options:
|
||||
<TABLE BORDER=0 CELLSPACING=1>
|
||||
<TR><TD><I>-dragenabled</I><TD>Specifies wether or not drag is active (initialized to 0)
|
||||
<TR><TD><I>-dragtype</I><TD>Default or alternate dragged data type (initialized to <I>type</I>)
|
||||
</TABLE>
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="register">DragSite::<B>register</B></A>
|
||||
<I>path</I>
|
||||
?<I>option value...</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command is used to declare <I>path</I> as a drag site. Options are:
|
||||
|
||||
<P>
|
||||
<DL><DT><A NAME="DragSite-dragendcmd"><B>-dragendcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Command called when drag terminates (ie when user release drag icon).
|
||||
This command is called with the following arguments:
|
||||
<UL>
|
||||
<LI>the pathname of the drag source (the widget itself),
|
||||
<LI>the pathname of the drop target,
|
||||
<LI>the operation,
|
||||
<LI>the type of the dragged data,
|
||||
<LI>the dragged data,
|
||||
<LI>result of the drop (result of the call to <B>-dropcmd</B> of the target),
|
||||
</UL>
|
||||
If the drop does not occurs, the target and the operation are empty string and the result
|
||||
is 0.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="DragSite-dragevent"><B>-dragevent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the number of the mouse button associated to the drag.
|
||||
Must be <B>1</B>, <B>2</B> or <B>3</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="DragSite-draginitcmd"><B>-draginitcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Command called when drag initiates. When the event of option <B>dragevent</B> occurs on
|
||||
<I>path</I>, this command is called with the following arguments:
|
||||
<UL>
|
||||
<LI>pathname of the drag source (<I>path</I>),
|
||||
<LI>root x-coordinate of pointer,
|
||||
<LI>root y-coordinate of pointer,
|
||||
<LI>a toplevel created to represent dragged data. When returning, if it
|
||||
has no children, a bitmap is automatically displayed.
|
||||
</UL>
|
||||
The command must return a list containing three elements:
|
||||
<UL>
|
||||
<LI>the type of the data,
|
||||
<LI>the list of acceptable basic operations (<B>copy</B>, <B>move</B> and <B>link</B>)
|
||||
<LI>and the data.
|
||||
</UL>
|
||||
Note that even if <B>copy</b> does not appear in the list of basic operation,
|
||||
it is considered as an acceptable operation, since <B>copy</B> semantic does not modify
|
||||
the drag source.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setdrag">DragSite::<B>setdrag</B></A>
|
||||
<I>path</I>
|
||||
<I>subpath</I>
|
||||
<I>initcmd</I>
|
||||
<I>endcmd</I>
|
||||
?<I>force</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command provides a simple way to call <B>register</B> during a BWidget creation or
|
||||
configuration.
|
||||
<UL>
|
||||
<LI><I>path</I> is the pathname of the BWidget,
|
||||
<LI><I>subpath</I> is the pathname of the tk widget where drag event occurs,
|
||||
<LI><I>initcmd</I> BWidget command for <I>drag-init</I> event,
|
||||
<LI><I>endcmd</I> BWidget command for <I>drag-end</I> event,
|
||||
<LI><I>force</I> specifies wether or not to call <B>register</B> whenever no option value has
|
||||
changed (0 by default - for BWidget configuration, use 1 for BWidget creation).
|
||||
</UL>
|
||||
<B>setdrag</B> verifies the modification flag of options <B>dragenabled</B> and
|
||||
<B>dragevent</B> and calls <B>register</B> if needed according to the options values and
|
||||
<I>initcmd</I> and <I>endcmd</I> arguments. <B>draginitcmd</B> and <B>dragendcmd</B> are not
|
||||
taken from options of widget because they are considered as user command, called by
|
||||
BWidget implementation of <I>drag-init</I> and <I>drag-end</I> events.
|
||||
</DD></DL>
|
||||
</BODY>
|
||||
</HTML>
|
||||
258
hlp/en/bwidget/DropSite.html
Normal file
258
hlp/en/bwidget/DropSite.html
Normal file
@@ -0,0 +1,258 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>DropSite</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>DropSite</B>
|
||||
- Commands set for Drop facilities
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">COMMAND</A></I></DT>
|
||||
<DD>DropSite::<A HREF="#include"><B>include</B></A>
|
||||
<I>class</I>
|
||||
<I>types</I>
|
||||
</DD>
|
||||
<DD>DropSite::<A HREF="#register"><B>register</B></A>
|
||||
<I>path</I>
|
||||
?<I>option value...</I>?
|
||||
</DD>
|
||||
<DD>DropSite::<A HREF="#setcursor"><B>setcursor</B></A>
|
||||
<I>cursor</I>
|
||||
</DD>
|
||||
<DD>DropSite::<A HREF="#setdrop"><B>setdrop</B></A>
|
||||
<I>path</I>
|
||||
<I>subpath</I>
|
||||
<I>dropover</I>
|
||||
<I>drop</I>
|
||||
?<I>force</I>?
|
||||
</DD>
|
||||
<DD>DropSite::<A HREF="#setoperation"><B>setoperation</B></A>
|
||||
<I>op</I>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
Commands of this namespace enable user to define a BWidget or a Tk widget as a drop site.
|
||||
A drop site is composed of the type of object that can be dropped and associated operation,
|
||||
a command called when drop occurs, and a command when an object is dragged over the widget.
|
||||
A drop site must have at least one type of acceptable object and a drop command.
|
||||
|
||||
</P>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="include">DropSite::<B>include</B></A>
|
||||
<I>class</I>
|
||||
<I>types</I>
|
||||
</DT><DD>
|
||||
|
||||
This command provides a simple way to include options relatives to a drop site into
|
||||
BWidget resources definition.
|
||||
It includes the options needed for <B>register</B>, <I>-dropovercmd</I> and <I>-dropcmd</I>,
|
||||
initialized to empty string, and <I>-droptypes</I>, initialized to <I>types</I>,
|
||||
and one new option:
|
||||
<TABLE BORDER=0 CELLSPACING=1>
|
||||
<TR><TD><I>-dropenabled</I><TD>Specifies wether or not drop is active (initialized to 0)
|
||||
</TABLE>
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="register">DropSite::<B>register</B></A>
|
||||
<I>path</I>
|
||||
?<I>option value...</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command is used to declare <I>path</I> as a drop site. Options are:
|
||||
|
||||
<P>
|
||||
<DL><DT><A NAME="DropSite-dropcmd"><B>-dropcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
This command is called when user release the drag icon over a valid drop target widget.
|
||||
It takes the same arguments as <B>-dragovercmd</B> command. Its return values is passed
|
||||
as a result to the <B>-dragendcmd</B> command of the drag source widget.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="DropSite-dropovercmd"><B>-dropovercmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
This command can be used to provide a dynamic drag while <I>drag-over</I> events.
|
||||
While a drag occurs, events <Enter>, <Motion> and <Leave> are catched.
|
||||
Arguments passed to the command are:
|
||||
<UL>
|
||||
<LI>pathname of the drop target (the widget itself),
|
||||
<LI>pathname of the drag source,
|
||||
<LI>event over the drop target: <I>enter</I>, <I>motion</I> or <I>leave</I>,
|
||||
<LI>root x-coordinate of the pointer,
|
||||
<LI>root y-coordinate of the pointer,
|
||||
<LI>operation,
|
||||
<LI>type of the dragged data,
|
||||
<LI>dragged data.
|
||||
</UL>
|
||||
Command must the new status of the drag:
|
||||
<UL>
|
||||
<LI>0 if widget refuse this drag. Command will not be recalled on motion/leave event.
|
||||
<LI>1 if widget accept this drag. Command will not be recalled on motion/leave event.
|
||||
<LI>2 if widget refuse this drag. Command will be recalled on each motion event to reevaluate.
|
||||
<LI>3 if widget accept this drag. Command will be recalled on each motion event to reevaluate.
|
||||
|
||||
</UL>
|
||||
Here is a list of events and associated actions on a DropSite widget. This example
|
||||
assumes that dragged data type is valid for the drop target.
|
||||
<B>status</B> is the status of the drag on a DropSite. Its value is:
|
||||
<BR><BR>
|
||||
|
||||
<TABLE BORDER CELLSPACING=1 CELLPADDING=4>
|
||||
<TR><TD WIDTH="18%" VALIGN="TOP">
|
||||
<P ALIGN="CENTER"><FONT SIZE=2>Event</FONT></TD>
|
||||
<TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P ALIGN="CENTER">Old status</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P ALIGN="CENTER">Action</FONT></TD>
|
||||
<TD WIDTH="24%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P ALIGN="CENTER">New status</FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="18%" VALIGN="TOP" ROWSPAN=2>
|
||||
<FONT SIZE=2><P><Enter></FONT></TD>
|
||||
<TD WIDTH="10%" VALIGN="TOP" ROWSPAN=2>
|
||||
<FONT SIZE=2><P>-</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>if DropSite has <B>dropovercmd</B>, call it with <I>enter</I></FONT></TD>
|
||||
<TD WIDTH="24%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>result of <B>dropovercmd</B></FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>else</FONT></TD>
|
||||
<TD WIDTH="24%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>1</FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="18%" VALIGN="TOP" ROWSPAN=2>
|
||||
<FONT SIZE=2><P><Motion></FONT></TD>
|
||||
<TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>0 or 1</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP"> </TD>
|
||||
<TD WIDTH="24%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>unchanged</FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>2 or 3</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>call <B>dropovercmd</B> with <I>motion</I></FONT></TD>
|
||||
<TD WIDTH="24%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>result of <B>dropovercmd</B></FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="18%" VALIGN="TOP" ROWSPAN=2>
|
||||
<FONT SIZE=2><P><Leave></P>
|
||||
</FONT><P> </TD>
|
||||
<TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>0 or 1</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP"> </TD>
|
||||
<TD WIDTH="24%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>-</FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>2 or 3</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>call <B>dropovercmd</B> with <I>leave</I></FONT></TD>
|
||||
<TD WIDTH="24%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>-</FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="18%" VALIGN="TOP" ROWSPAN=4>
|
||||
<FONT SIZE=2><P><Drop></FONT></TD>
|
||||
<TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>0</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>call <B>dragendcmd</B> of drag source</FONT></TD>
|
||||
<TD WIDTH="24%" VALIGN="TOP" ROWSPAN=4>
|
||||
<FONT SIZE=2><P>-</FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>1</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>call <B>dropcmd</B> and call <B>dragendcmd</B> of drag source</FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>2</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>call <B>dropovercmd</B> with <I>leave</I> and call <B>dragendcmd</B> of drag source</FONT></TD>
|
||||
</TR>
|
||||
<TR><TD WIDTH="10%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>3</FONT></TD>
|
||||
<TD WIDTH="48%" VALIGN="TOP">
|
||||
<FONT SIZE=2><P>call <B>dropcmd</B> and call <B>dragendcmd</B> of drag source</FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<BR>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="DropSite-droptypes"><B>-droptypes</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a list {<I>type</I> <I>oplist</I> ?<I>type</I> <I>oplist</I>? ...} of acceptable
|
||||
types and associated operations for the drop target.
|
||||
For each type, <I>oplist</I> is a list
|
||||
{<I>descops</I> <I>mod</I> ?<I>descops</I> <I>mod</I>? ...} describing operations and
|
||||
modifier keys for these operations.
|
||||
<I>descops</I> describe an operation. It can be a predefined operations (<B>copy</B>,
|
||||
<B>move</B> or <B>link</B>) or a new user defined operation, of the form {<I>subop</I>
|
||||
<B>baseop</I> ?<I>bitmap</I>?}.
|
||||
<I>subop</I> is the name given to the sub operation, <I>baseop</I> is the name of the
|
||||
base operation (<B>copy</B>, <B>move</B> or <B>link</B>) and <I>bitmap</I> is a bitmap
|
||||
to display for the operation.
|
||||
<BR>If <I>bitmap</I> is empty, the default bitmap of the base operation is used for the
|
||||
sub operation.
|
||||
<BR><I>subop</I> can be a base operation, in order to change the bitmap of a base operation.
|
||||
In this case, <I>baseop</I> must be empty or equal to <I>subop</I>.
|
||||
<BR><I>mod</I> is the modifer key for the operation. It can be:
|
||||
<UL>
|
||||
<LI><B>none</B> to specify that no modifier key is pressed. This modifier can only be used
|
||||
with a sub operation named <B>default</B> (and vice versa), which has the behaviour of not
|
||||
display any bitmap operation. For all type, if the modifier <B>none</B> is not given, it is
|
||||
automatically associated to the <B>default</B> sub operation of a <B>copy</B> base operation.
|
||||
<LI><B>program</B> to specifies a sub operation accessible only by <B>DropSite::setoperation</B>.
|
||||
<LI>A list combining <B>shift</B>, <B>control</B> and <B>alt</B>, which means their
|
||||
corresponding key.
|
||||
</UL>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setcursor">DropSite::<B>setcursor</B></A>
|
||||
<I>cursor</I>
|
||||
</DT><DD>
|
||||
|
||||
This command can be used within the script <B>dragovercmd</B>. It is usefull to provide
|
||||
visual effect about the state of the drag.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setdrop">DropSite::<B>setdrop</B></A>
|
||||
<I>path</I>
|
||||
<I>subpath</I>
|
||||
<I>dropover</I>
|
||||
<I>drop</I>
|
||||
?<I>force</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command provides a simple way to call <B>register</B> during a BWidget creation or
|
||||
configuration.
|
||||
<UL>
|
||||
<LI><I>path</I> is the pathname of the BWidget,
|
||||
<LI><I>subpath</I> is the pathname of the tk widget where drag event occurs,
|
||||
<LI><I>dropover</I> is a command for <I>drag-over</I> event,
|
||||
<LI><I>drop</I> is a command for <I>drop</I> event,
|
||||
<LI><I>force</I> specifies wether or not to call <B>register</B> whenever no option value
|
||||
has changed (0 by default - for BWidget configuration, use 1 for BWidget creation).
|
||||
</UL>
|
||||
<B>setdrop</B> verifies the modification flag of options <B>dropenabled</B> and
|
||||
<B>droptypes</B> and calls <B>register</B> if needed according to the options values and
|
||||
<I>dropover</I> and <I>drop</I> arguments. <B>dropovercmd</B> and <B>dropcmd</B> are not
|
||||
taken from options of widget because they are considered as user command, called by
|
||||
BWidget implementation of <I>drag-over</I> and <I>drop</I> events.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setoperation">DropSite::<B>setoperation</B></A>
|
||||
<I>op</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
126
hlp/en/bwidget/DynamicHelp.html
Normal file
126
hlp/en/bwidget/DynamicHelp.html
Normal file
@@ -0,0 +1,126 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>DynamicHelp</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>DynamicHelp</B>
|
||||
- Provide help to Tk widget or BWidget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">COMMAND</A></I></DT>
|
||||
<DD>DynamicHelp::<A HREF="#configure"><B>configure</B></A>
|
||||
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
|
||||
</DD>
|
||||
<DD>DynamicHelp::<A HREF="#include"><B>include</B></A>
|
||||
<I>class</I>
|
||||
<I>type</I>
|
||||
</DD>
|
||||
<DD>DynamicHelp::<A HREF="#register"><B>register</B></A>
|
||||
<I>path</I>
|
||||
<I>type</I>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD>DynamicHelp::<A HREF="#sethelp"><B>sethelp</B></A>
|
||||
<I>path</I>
|
||||
<I>subpath</I>
|
||||
?<I>force</I>?
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
Description text
|
||||
</P>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="configure">DynamicHelp::<B>configure</B></A>
|
||||
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
|
||||
</DT><DD>
|
||||
This command configure the ballon help.
|
||||
<P>
|
||||
<DL><DT><A NAME="DynamicHelp-borderwidth"><B>-borderwidth</B></A></DT>
|
||||
<DD>
|
||||
Width of the black border around the balloon.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="DynamicHelp-delay"><B>-delay</B></A></DT>
|
||||
<DD>
|
||||
Define the delay in millisecond of mouse inactivity before displaying
|
||||
the balloon.
|
||||
</DD>
|
||||
</DL>
|
||||
<BR>Other standard options are:
|
||||
<DD><TABLE CELLSPACING=0 CELLSPACING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-background">-background or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-font">-font</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-justify">-justify</A></TR>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="include">DynamicHelp::<B>include</B></A>
|
||||
<I>class</I>
|
||||
<I>type</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="register">DynamicHelp::<B>register</B></A>
|
||||
<I>path</I>
|
||||
<I>type</I>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
Register a help text to the widget <I>path</I>.
|
||||
<I>type</I> determines the type of the help or the type of the widget.
|
||||
Depending on <I>type</I>, other options must be provided.
|
||||
<BR>
|
||||
<TABLE CELLSPACING=5 CELLPADDING=0 BORDER=0>
|
||||
<TR><TD><B> type </B></TD><TD><B> options </B></TD></TR>
|
||||
<TR><TD><B><I> balloon </I></B></TD><TD><I> text </I></TD></TR>
|
||||
<TR><TD><B><I> variable </I></B></TD><TD><I> varName text </I></TD></TR>
|
||||
<TR><TD><B><I> menu </I></B></TD><TD><I> varName </I></TD></TR>
|
||||
<TR><TD><B><I> menuentry </I></B></TD><TD><I> index text </I></TD></TR>
|
||||
</TABLE>
|
||||
<BR>If one of the option is missing or is empty, help is removed for this widget.
|
||||
<BR>For type other than <I>balloon</I>, <I>varName</I> is typically a variable
|
||||
linked to a label.
|
||||
<BR>For menu, balloon type help is not available. To declare a help for menu,
|
||||
you first declare the menu, and then entries of this menu.
|
||||
<BR>For example:
|
||||
<BR><BR>
|
||||
<CENTER>
|
||||
<TABLE BORDER=2 CELLSPACING=2 WIDTH="80%">
|
||||
<TR><TD><PRE>
|
||||
<FONT COLOR=red><I># create menu</I></FONT>
|
||||
menu .m -type menubar
|
||||
<FONT COLOR=red><I># associate menubar to toplevel BEFORE DynamicHelp::register</I></FONT>
|
||||
<FONT COLOR=red><I># to make it works with menu clone name</I></FONT>
|
||||
. configure -menu .m
|
||||
.m add cascade -label "File" -menu .m.file
|
||||
menu .m.file
|
||||
.m.file add command -label "Open..."
|
||||
.m.file add command -label "Quit"
|
||||
<FONT COLOR=red><I># create label for help, using variable varinfo</I></FONT>
|
||||
label .l -textvariable varinfo
|
||||
<FONT COLOR=red><I># associate all entries of menu .m.file to variable varinfo</I></FONT>
|
||||
DynamicHelp::register .m.file menu varinfo
|
||||
<FONT COLOR=red><I># then declare entries of .m.file</I></FONT>
|
||||
DynamicHelp::register .m.file menuentry 0 "Detach menu"
|
||||
DynamicHelp::register .m.file menuentry 1 "Open a file"
|
||||
DynamicHelp::register .m.file menuentry 2 "Exit demo"
|
||||
</PRE></TD></TR></TABLE></CENTER>
|
||||
<BR>
|
||||
<BR>Notice that if popup menu is owned by a menubar, you must associate first the menubar
|
||||
to its toplevel. In this case, when you create a menu popup, its clone window is also
|
||||
created, and DynamicHelp::register detects the exitence of the clone window and maps
|
||||
events to it.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="sethelp">DynamicHelp::<B>sethelp</B></A>
|
||||
<I>path</I>
|
||||
<I>subpath</I>
|
||||
?<I>force</I>?
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
340
hlp/en/bwidget/Entry.html
Normal file
340
hlp/en/bwidget/Entry.html
Normal file
@@ -0,0 +1,340 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>Entry</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>Entry</B>
|
||||
- Entry widget with <B>state</B> option, dynamic help and drag and drop facilities
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>Entry</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-disabledforeground">-disabledforeground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-exportselection">-exportselection</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-font">-font</A></TR>
|
||||
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightbackground">-highlightbackground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-highlightcolor">-highlightcolor</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightthickness">-highlightthickness</A></TR>
|
||||
<TD> <A HREF="options.htm#M-insertbackground">-insertbackground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-insertborderwidth">-insertborderwidth</A></TR>
|
||||
<TD> <A HREF="options.htm#M-insertofftime">-insertofftime</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-insertontime">-insertontime</A></TR>
|
||||
<TD> <A HREF="options.htm#M-insertwidth">-insertwidth</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-justify">-justify</A></TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-selectbackground">-selectbackground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-selectborderwidth">-selectborderwidth</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-selectforeground">-selectforeground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-takefocus">-takefocus</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-text">-text</A></TR>
|
||||
<TD> <A HREF="options.htm#M-textvariable">-textvariable</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-xscrollcommand">-xscrollcommand</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="#-command">-command</A></TR>
|
||||
<TD> <A HREF="#-dragenabled">-dragenabled</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dragendcmd">-dragendcmd</A></TR>
|
||||
<TD> <A HREF="#-dragevent">-dragevent</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-draginitcmd">-draginitcmd</A></TR>
|
||||
<TD> <A HREF="#-dragtype">-dragtype</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dropcmd">-dropcmd</A></TR>
|
||||
<TD> <A HREF="#-dropenabled">-dropenabled</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dropovercmd">-dropovercmd</A></TR>
|
||||
<TD> <A HREF="#-droptypes">-droptypes</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-editable">-editable</A></TR>
|
||||
<TD> <A HREF="#-helptext">-helptext</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-helptype">-helptype</A></TR>
|
||||
<TD> <A HREF="#-helpvar">-helpvar</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-show">-show</A></TR>
|
||||
<TD> <A HREF="#-state">-state</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#invoke"><B>invoke</B></A>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
The <B>Entry</B> widget extends the default Tk entry. Options have been added to provide
|
||||
visual effect depending on the state of the Entry,
|
||||
<A HREF="DynamicHelp.html">DynamicHelp</A> options,
|
||||
and <A HREF="DragSite.html">Drag</A> and
|
||||
<A HREF="DropSite.html">Drop</A>.
|
||||
Entry behaves much like a Label, with <B>text</B> option to set its contents.
|
||||
<BR>Tk entry command can also be used on Entry widget.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-command"><B>-command</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command when user press <Return> in the Entry.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragenabled"><B>-dragenabled</B></A></DT>
|
||||
<DD>
|
||||
A boolean specifying if drag is enabled.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragendcmd"><B>-dragendcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when drag ended.
|
||||
<B>dragendcmd</B> must be a command conforming to the description of the
|
||||
option <B>dragendcmd</B> of <B>DragSite::<A HREF="DragSite.html#register">register</A></B>.
|
||||
|
||||
<BR>If <B>dragendcmd</B> is empty, the internal <I>dragend</I> command updates the entry
|
||||
following the operation (<B>move</B> or <B>copy</B>) and the dragged data
|
||||
(whole or selected part of the entry).
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragevent"><B>-dragevent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the number of the mouse button associated to the drag.
|
||||
Must be <B>1</B>, <B>2</B> or <B>3</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-draginitcmd"><B>-draginitcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when <B>dragevent</B> occurs on widget.
|
||||
<B>draginitcmd</B> must be a command conforming to the description of the
|
||||
option <B>draginitcmd</B> of <B>DragSite::<A HREF="DragSite.html#register">register</A></B>.
|
||||
|
||||
<BR>if <B>draginitcmd</B> is empty, the command refuse the drag if entry is empty or if
|
||||
portion of text is selected and event doesn't occur above the selection. In all other cases,
|
||||
the command returns:
|
||||
<UL>
|
||||
<LI>as the data type, the value of option <B>dragtype</B> or <I>TEXT</I> if empty,
|
||||
<LI>as the operations, <I>{copy move}</I> if <B>state</B> is normal and <B>editable</B>
|
||||
is true, or <I>{copy}</I> only in other cases,
|
||||
<LI>as the data, the whole content or the selected portion of the entry.
|
||||
</UL>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragtype"><B>-dragtype</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an alternate type of dragged object.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropcmd"><B>-dropcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Entry has a command wrapper for <I>drop</I> events. This command stops auto scrolling
|
||||
and extract current position.
|
||||
<BR>If <B>dropcmd</B> is not empty, it is called with the following arguments:
|
||||
<UL>
|
||||
<LI>the pathname of the Entry,
|
||||
<LI>the pathname of the drag source,
|
||||
<LI>the numeric index in the entry designated by the cursor,
|
||||
<LI>the current operation,
|
||||
<LI>the data type,
|
||||
<LI>the data.
|
||||
</UL>
|
||||
and must return a value conforming to <B>dropcmd</B> option described in
|
||||
<B>DropSite::<A HREF="DropSite.html#register">register</A></B>.
|
||||
If <B>dropcmd</B> is empty, the wrapper updates the entry following the type of data:
|
||||
<DL><DD><TABLE BORDER=0 CELLSPACING=1>
|
||||
<TR><TD><I>COLOR</I> or <I>FGCOLOR</I></TD>
|
||||
<TD>reconfigure the <B>foreground</B> of the Entry</TD>
|
||||
<TR><TD><I>BGCOLOR</I></TD>
|
||||
<TD>reconfigure the <B>background</B> of the Entry</TD>
|
||||
<TR><TD><I>TEXT</I>,<BR>or any other tag</TD>
|
||||
<TD>reconfigure the Entry to display the associated string.</TD>
|
||||
</TABLE></DL>
|
||||
and returns 1.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropenabled"><B>-dropenabled</B></A></DT>
|
||||
<DD>
|
||||
A boolean specifying if drop is enabled.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropovercmd"><B>-dropovercmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Entry has a command wrapper for <I>drag-over</I> events. This command enables auto scrolling
|
||||
and position extraction during the <I>drag-over</I>.
|
||||
<BR>If <B>dropovercmd</B> is empty, the wrapper accepts the drop if <B>editable</b> option is
|
||||
true and <B>state</B> option is normal.
|
||||
<BR>If <B>dropovercmd</B> is not empty, it is called with the following arguments:
|
||||
<UL>
|
||||
<LI>the pathname of the Entry,
|
||||
<LI>the pathname of the drag source,
|
||||
<LI>the event,
|
||||
<LI>the numeric index in the entry designated by the cursor,
|
||||
<LI>the current operation,
|
||||
<LI>the data type,
|
||||
<LI>the data.
|
||||
</UL>
|
||||
and must return a value conforming to <B>dropovercmd</B> option described in
|
||||
<B>DropSite::<A HREF="DropSite.html#register">register</A></B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-droptypes"><B>-droptypes</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a list of accepted dropped object/operation.
|
||||
See option <B>droptypes</B> of
|
||||
<B>DropSite::<A HREF="DropSite.html#register">register</A></B>.
|
||||
for more infromation.
|
||||
|
||||
Default accepts <I>FGCOLOR</I>, <I>COLOR</I>, <I>BGCOLOR</I> and <I>TEXT</I>,
|
||||
all with <B>copy</B> and <B>move</B> operations.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-editable"><B>-editable</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies whether the Entry is editable by the user. Equivalent to the <B>state</B> option
|
||||
of the Tk entry widget.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-helptext"><B>-helptext</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Text for dynamic help. If empty, no help is available for this widget.
|
||||
See also <A HREF="DynamicHelp.html">DynamicHelp</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-helptype"><B>-helptype</B></A></DT>
|
||||
<DD>
|
||||
Type of dynamic help. Use <I>balloon</I> or <I>variable</I>.
|
||||
See also <A HREF="DynamicHelp.html">DynamicHelp</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-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="-show"><B>-show</B></A></DT>
|
||||
<DD>
|
||||
|
||||
If this option is specified, then the true contents of the entry are not displayed in the
|
||||
window. Instead, each character in the entry's value will be displayed as the first character
|
||||
in the value of this option, such as ``*''. This is useful, for example, if the entry is to
|
||||
be used to enter a password. If characters in the entry are selected and copied elsewhere, the
|
||||
information copied will be what is displayed, not the true contents of the entry.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-state"><B>-state</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies one of two states for the Entry: <B>normal</B> or <B>disabled</B>.
|
||||
In normal state the text of the Entry is displayed using the <B>foreground</B> option.
|
||||
In disabled state the text of the Entry is displayed using the <B>disabledforeground</B>
|
||||
option. If the entry is disabled then the value may not be changed by user input
|
||||
and no insertion cursor will be displayed, even if the input focus is in the widget.
|
||||
Disabled state is the same as not editable with visual effect.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an integer value indicating the desired width of the entry window, in average-size
|
||||
characters of the widget's font. If the value is less than or equal to zero, the widget picks
|
||||
a size just large enough to hold its current text.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="invoke"><I>pathName</I> <B>invoke</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Calls the command specified by the option <B>-command</B>.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
331
hlp/en/bwidget/Label.html
Normal file
331
hlp/en/bwidget/Label.html
Normal file
@@ -0,0 +1,331 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>Label</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>Label</B>
|
||||
- Label widget with <B>state</B> option, dynamic help and drag and drop facilities
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>Label</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-anchor">-anchor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-background">-background or -bg</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-bitmap">-bitmap</A></TR>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-cursor">-cursor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-disabledforeground">-disabledforeground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-font">-font</A></TR>
|
||||
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightbackground">-highlightbackground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-highlightcolor">-highlightcolor</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightthickness">-highlightthickness</A></TR>
|
||||
<TD> <A HREF="options.htm#M-image">-image</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-justify">-justify</A></TR>
|
||||
<TD> <A HREF="options.htm#M-padx">-padx</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-pady">-pady</A></TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-takefocus">-takefocus</A></TR>
|
||||
<TD> <A HREF="options.htm#M-text">-text</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-textvariable">-textvariable</A></TR>
|
||||
<TD> <A HREF="options.htm#M-wraplength">-wraplength</A></TR>
|
||||
</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="#-dragenabled">-dragenabled</A></TR>
|
||||
<TD> <A HREF="#-dragendcmd">-dragendcmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dragevent">-dragevent</A></TR>
|
||||
<TD> <A HREF="#-draginitcmd">-draginitcmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dragtype">-dragtype</A></TR>
|
||||
<TD> <A HREF="#-dropcmd">-dropcmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dropenabled">-dropenabled</A></TR>
|
||||
<TD> <A HREF="#-dropovercmd">-dropovercmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-droptypes">-droptypes</A></TR>
|
||||
<TD> <A HREF="#-focus">-focus</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
<TD> <A HREF="#-helptext">-helptext</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-helptype">-helptype</A></TR>
|
||||
<TD> <A HREF="#-helpvar">-helpvar</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-name">-name</A></TR>
|
||||
<TD> <A HREF="#-state">-state</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-underline">-underline</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="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#setfocus"><B>setfocus</B></A>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
The <B>Label</B> widget extends the default Tk label. Options have been added to provide
|
||||
visual effect depending on the state of the Label, <A HREF="DynamicHelp.html">DynamicHelp</A> options, and <A HREF="DragSite.html">Drag
|
||||
</A> and <A HREF="DropSite.html">Drop</A>.
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-dragenabled"><B>-dragenabled</B></A></DT>
|
||||
<DD>
|
||||
A boolean specifying if drag is enabled.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragendcmd"><B>-dragendcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when drag ended.
|
||||
<B>dragendcmd</B> must be a command conforming to the description of the
|
||||
option <B>dragendcmd</B> of <B>DragSite::<A HREF="DragSite.html#register">register</A></B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragevent"><B>-dragevent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the number of the mouse button associated to the drag.
|
||||
Must be <B>1</B>, <B>2</B> or <B>3</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-draginitcmd"><B>-draginitcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when <B>dragevent</B> occurs on widget.
|
||||
<B>draginitcmd</B> must be a command conforming to the description of the
|
||||
option <B>draginitcmd</B> of <B>DragSite::<A HREF="DragSite.html#register">register</A></B>.
|
||||
|
||||
<BR>If <B>draginitcmd</B> is empty, the internal <B>draginitcmd</B> command is used instead
|
||||
and returns:
|
||||
<DL><DD><TABLE BORDER=0 CELLSPACING=1>
|
||||
<TR><TD valign=top><I>IMAGE {copy} <image name></I>
|
||||
<TD>if an image is displayed.
|
||||
<TR><TD valign=top><I>BITMAP {copy} <bitmap name></I>
|
||||
<TD>if a bitmap is displayed.
|
||||
<TR><TD valign=top><I>TEXT {copy} <text></I>
|
||||
<TD>if a text is displayed.
|
||||
</TABLE></DL>
|
||||
Note that if <B>dragtype</B> option is not empty, its value is used instead of those above.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragtype"><B>-dragtype</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an alternate type of dragged object.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropcmd"><B>-dropcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when drop occurs on the widget.
|
||||
<B>dropcmd</B> must be a command conforming to the description of the
|
||||
option <B>dropcmd</B> of <B>DropSite::<A HREF="DropSite.html#register">register</A></B>.
|
||||
|
||||
<BR>If <B>dropcmd</B> is empty, the command updates the label following the type of the data:
|
||||
<DL><DD><TABLE BORDER=0 CELLSPACING=1>
|
||||
<TR><TD><I>COLOR</I> or <I>FGCOLOR</I></TD>
|
||||
<TD>reconfigure the <B>foreground</B> of the Label.</TD>
|
||||
<TR><TD><I>BGCOLOR</I></TD>
|
||||
<TD>reconfigure the <B>background</B> of the Label.</TD>
|
||||
<TR><TD><I>IMAGE</I></TD>
|
||||
<TD>reconfigure the Label to display the associated image.</TD>
|
||||
<TR><TD><I>BITMAP</I></TD>
|
||||
<TD>reconfigure the Label to display the associated bitmap.
|
||||
<B>image</B> option is set to empty.</TD>
|
||||
<TR><TD><I>TEXT</I>,<BR>or any other tag</TD>
|
||||
<TD>reconfigure the Label to display the associated string.
|
||||
<B>image</B> and <B>bitmap</B> options are set to empty.</TD>
|
||||
</TABLE></DL>
|
||||
and returns 1.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropenabled"><B>-dropenabled</B></A></DT>
|
||||
<DD>
|
||||
A boolean specifying if drop is enabled.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropovercmd"><B>-dropovercmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when drag icon is over the widget.
|
||||
<B>dropovercmd</B> must be a command conforming to the description of the
|
||||
option <B>dropovercmd</B> of <B>DropSite::<A HREF="DropSite.html#register">register</A></B>.
|
||||
|
||||
<BR>If <B>dropovercmd</B> is empty, Label always accepts the drop if data type is
|
||||
<I>FGCOLOR</I>, <I>COLOR</I>, <I>BGCOLOR</I>, and accepts all other data type only if
|
||||
<B>state</B> is normal.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-droptypes"><B>-droptypes</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a list of accepted dropped object/operation.
|
||||
See option <B>droptypes</B> of
|
||||
<B>DropSite::<A HREF="DropSite.html#register">register</A></B>.
|
||||
for more infromation.
|
||||
|
||||
Default accepts <I>FGCOLOR</I>, <I>COLOR</I>, <I>BGCOLOR</I>, <I>TEXT</I>, <I>BITMAP</I>
|
||||
and <I>IMAGE</I>, all with <B>copy</B> and <B>move</B> operations.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-focus"><B>-focus</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a pathname to set the focus on for Label::<B>setfocus</B> command.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a desired height for the label.
|
||||
If an image or bitmap is being displayed in the label then the value is in
|
||||
screen units, for text it is in lines of text.
|
||||
If this option isn't specified, the label's desired height is computed
|
||||
from the size of the image or bitmap or text being displayed in it.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-helptext"><B>-helptext</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Text for dynamic help. If empty, no help is available for this widget.
|
||||
See also <A HREF="DynamicHelp.html">DynamicHelp</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-helptype"><B>-helptype</B></A></DT>
|
||||
<DD>
|
||||
Type of dynamic help. Use <I>balloon</I> or <I>variable</I>.
|
||||
See also <A HREF="DynamicHelp.html">DynamicHelp</A>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-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="-name"><B>-name</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a standard name for the label. If the option <B>*<I>name</I>Name</B> is
|
||||
found in the resource database, then <B>text</B> and <B>underline</B> options
|
||||
are extracted from its value.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-state"><B>-state</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies one of two states for the Label: <B>normal</B> or <B>disabled</B>.
|
||||
In normal state the text of the Label is displayed using the <B>foreground</B> option.
|
||||
In disabled state the text of the Label is displayed using the <B>disabledforeground</B> option.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-underline"><B>-underline</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the integer index of a character to underline in the label.
|
||||
0 corresponds to the first character of the text displayed, 1 to the next character,
|
||||
and so on.
|
||||
<BR>The binding <B><Alt-<I>char</I>></B> is automatically set on the toplevel
|
||||
of the Label to call Label::<B>setfocus</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a desired width for the label.
|
||||
If an image or bitmap is being displayed in the label then the value is in
|
||||
screen units, for text it is in characters.
|
||||
If this option isn't specified, the label's desired width is computed
|
||||
from the size of the image or bitmap or text being displayed in it.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="setfocus"><I>pathName</I> <B>setfocus</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Set the focus on the pathname given by <B>-focus</B> option if <B>-state</B> is <I>normal</I>.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
194
hlp/en/bwidget/LabelEntry.html
Normal file
194
hlp/en/bwidget/LabelEntry.html
Normal file
@@ -0,0 +1,194 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>LabelEntry</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>LabelEntry</B>
|
||||
-
|
||||
LabelFrame containing an Entry widget.
|
||||
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>LabelEntry</B></A> <I>pathName</I> ?<I>option value...</I>?</DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="Entry.html">OPTIONS from <B>Entry</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -borderwidth or -bd</TD>
|
||||
<TD> -command</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -disabledforeground</TD>
|
||||
<TD> -dragenabled</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dragendcmd</TD>
|
||||
<TD> -dragevent</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -draginitcmd</TD>
|
||||
<TD> -dragtype</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dropcmd</TD>
|
||||
<TD> -dropenabled</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dropovercmd</TD>
|
||||
<TD> -droptypes</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -editable</TD>
|
||||
<TD> -entrybg (see <B>-background</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -entryfg (see <B>-foreground</B>)</TD>
|
||||
<TD> -exportselection</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -font</TD>
|
||||
<TD> -helptext</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helptype</TD>
|
||||
<TD> -helpvar</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -highlightbackground</TD>
|
||||
<TD> -highlightcolor</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -highlightthickness</TD>
|
||||
<TD> -insertbackground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertborderwidth</TD>
|
||||
<TD> -insertofftime</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertontime</TD>
|
||||
<TD> -insertwidth</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -justify</TD>
|
||||
<TD> -relief</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -selectbackground</TD>
|
||||
<TD> -selectborderwidth</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -selectforeground</TD>
|
||||
<TD> -show</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -state</TD>
|
||||
<TD> -takefocus</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -text</TD>
|
||||
<TD> -textvariable</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -width</TD>
|
||||
<TD> -xscrollcommand</TD>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="LabelFrame.html">OPTIONS from <B>LabelFrame</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -background or -bg</TD>
|
||||
<TD> -disabledforeground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -foreground or -fg</TD>
|
||||
<TD> -helptext</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helptype</TD>
|
||||
<TD> -helpvar</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -label (see <B>-text</B>)</TD>
|
||||
<TD> -labelanchor (see <B>-anchor</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -labelfont (see <B>-font</B>)</TD>
|
||||
<TD> -labelheight (see <B>-height</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -labeljustify (see <B>-justify</B>)</TD>
|
||||
<TD> -labelwidth (see <B>-width</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -name</TD>
|
||||
<TD> -padx</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -pady</TD>
|
||||
<TD> -side</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -state</TD>
|
||||
<TD> -underline</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -wraplength</TD>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#bind"><B>bind</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
LabelEntry is a widget composed of <A HREF="LabelFrame.html">LabelFrame</A> widget
|
||||
containing an <A HREF="Entry.html">Entry</A> widget.
|
||||
Tk entry command can also be used on LabelEntry widget.
|
||||
|
||||
</P>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="bind"><I>pathName</I> <B>bind</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Set bindings on the entry widget.
|
||||
|
||||
</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="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>
|
||||
</BODY></HTML>
|
||||
139
hlp/en/bwidget/LabelFrame.html
Normal file
139
hlp/en/bwidget/LabelFrame.html
Normal file
@@ -0,0 +1,139 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>LabelFrame</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>LabelFrame</B>
|
||||
- Frame with a Label
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>LabelFrame</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-borderwidth">-borderwidth or -bd</A></TD>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="Label.html">OPTIONS from <B>Label</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -anchor</TD>
|
||||
<TD> -background or -bg</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -disabledforeground</TD>
|
||||
<TD> -focus</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -font</TD>
|
||||
<TD> -foreground or -fg</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -height</TD>
|
||||
<TD> -helptext</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helptype</TD>
|
||||
<TD> -helpvar</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -justify</TD>
|
||||
<TD> -name</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -padx</TD>
|
||||
<TD> -pady</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -state</TD>
|
||||
<TD> -text</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -underline</TD>
|
||||
<TD> -width</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -wraplength</TD>
|
||||
</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="#-side">-side</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD>LabelFrame::<A HREF="#align"><B>align</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#getframe"><B>getframe</B></A>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
LabelFrame enables user to create a frame with a
|
||||
<A HREF="Label.html">Label</A> positionned at any side.
|
||||
LabelFrame is used by <A HREF="ComboBox.html">ComboBox</A>
|
||||
and <A HREF="SpinBox.html">SpinBox</A>.
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-side"><B>-side (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies where to position the Label relative to the user frame: <B>top</B>, <B>bottom</B>, <B>left</B> or <B>right</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="align">LabelFrame::<B>align</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command align label of all widget given by <I>args</I> of class LabelFrame
|
||||
(or "derived") by setting their width to the max one +1
|
||||
|
||||
</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="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="getframe"><I>pathName</I> <B>getframe</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Return the frame where the user can create any other widget.
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
608
hlp/en/bwidget/ListBox.html
Normal file
608
hlp/en/bwidget/ListBox.html
Normal file
@@ -0,0 +1,608 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ListBox</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ListBox</B>
|
||||
- ListBox widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ListBox</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-cursor">-cursor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-highlightbackground">-highlightbackground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightcolor">-highlightcolor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-highlightthickness">-highlightthickness</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
<TD> <A HREF="options.htm#M-selectbackground">-selectbackground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-selectforeground">-selectforeground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-takefocus">-takefocus</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-xscrollcommand">-xscrollcommand</A></TR>
|
||||
<TD> <A HREF="options.htm#M-yscrollcommand">-yscrollcommand</A></TR>
|
||||
</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="#-deltax">-deltax</A></TR>
|
||||
<TD> <A HREF="#-deltay">-deltay</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dragenabled">-dragenabled</A></TR>
|
||||
<TD> <A HREF="#-dragendcmd">-dragendcmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dragevent">-dragevent</A></TR>
|
||||
<TD> <A HREF="#-draginitcmd">-draginitcmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dragtype">-dragtype</A></TR>
|
||||
<TD> <A HREF="#-dropcmd">-dropcmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dropenabled">-dropenabled</A></TR>
|
||||
<TD> <A HREF="#-dropovercmd">-dropovercmd</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dropovermode">-dropovermode</A></TR>
|
||||
<TD> <A HREF="#-droptypes">-droptypes</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
<TD> <A HREF="#-multicolumn">-multicolumn</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-padx">-padx</A></TR>
|
||||
<TD> <A HREF="#-redraw">-redraw</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#bindImage"><B>bindImage</B></A>
|
||||
<I>event</I>
|
||||
<I>script</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#bindText"><B>bindText</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="#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>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#edit"><B>edit</B></A>
|
||||
<I>item</I>
|
||||
<I>text</I>
|
||||
?<I>verifycmd</I>?
|
||||
?<I>clickres</I>?
|
||||
?<I>select</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#exists"><B>exists</B></A>
|
||||
<I>item</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#index"><B>index</B></A>
|
||||
<I>item</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#insert"><B>insert</B></A>
|
||||
<I>index</I>
|
||||
<I>item</I>
|
||||
?<I>option value...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#item"><B>item</B></A>
|
||||
<I>first</I>
|
||||
?<I>last</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#itemcget"><B>itemcget</B></A>
|
||||
<I>item</I>
|
||||
<I>option</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#itemconfigure"><B>itemconfigure</B></A>
|
||||
<I>item</I>
|
||||
?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#items"><B>items</B></A>
|
||||
?<I>first</I>?
|
||||
?<I>last</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#move"><B>move</B></A>
|
||||
<I>item</I>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#reorder"><B>reorder</B></A>
|
||||
<I>neworder</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#see"><B>see</B></A>
|
||||
<I>item</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#selection"><B>selection</B></A>
|
||||
<I>cmd</I>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#xview"><B>xview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#yview"><B>yview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
<B>ListBox</B> widget uses canvas to display a list of items.
|
||||
Each item is composed of a label with its own font and foreground attributes, and an optional
|
||||
image or window. Each item is drawn in a single line, whose height is defined by the
|
||||
<B>deltay</B> option, so they must have at most this height.
|
||||
A item is uniquely identified by a string given at creation (by the
|
||||
<B>insert</B> command). The ListBox can have one or more columns, depending on
|
||||
<B>multicolumn</B> option. The user do not handle columns; the number of columns
|
||||
is determined following the height of the ListBox in order to see each item vertically.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-deltax"><B>-deltax</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies horizontal pad between each columns.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-deltay"><B>-deltay</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies vertical size of the items.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragenabled"><B>-dragenabled</B></A></DT>
|
||||
<DD>
|
||||
A boolean specifying if drag is enabled.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragendcmd"><B>-dragendcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when drag ended.
|
||||
<B>dragendcmd</B> must be a command conforming to the description of the
|
||||
option <B>dragendcmd</B> of <B>DragSite::<A HREF="DragSite.html#register">register</A></B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragevent"><B>-dragevent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the number of the mouse button associated to the drag.
|
||||
Must be <B>1</B>, <B>2</B> or <B>3</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-draginitcmd"><B>-draginitcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
ListBox has a command wrapper for <I>drag-init</I> events. This command refused the drag
|
||||
if no item is designated. In other cases:
|
||||
<BR>If <B>draginitcmd</B> is empty, it returns:
|
||||
<UL>
|
||||
<LI>the value of option <B>dragtype</B> or <I>LISTBOX_ITEM</I> if empty as the data type,
|
||||
<LI><I>{move copy link}</I> as the operations,
|
||||
<LI>the item identifier as the data.
|
||||
</UL>
|
||||
If <B>draginitcmd</B> is not empty, it is called with the following arguments:
|
||||
<UL>
|
||||
<LI>the pathname of the listbox,
|
||||
<LI>the identifier of the dragged item,
|
||||
<LI>the toplevel created to represent dragged data.
|
||||
</UL>
|
||||
and must return a value conforming to <B>draginitcmd</B> option described in
|
||||
<B>DragSite::<A HREF="DragSite.html#register">register</A></B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragtype"><B>-dragtype</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an alternate type of dragged object.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropcmd"><B>-dropcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
ListBox has a command wrapper for <I>drop</I> events. This command stops auto scrolling
|
||||
and extract item and position.
|
||||
<BR>If <B>dropcmd</B> is not empty, it is called with the following arguments:
|
||||
<UL>
|
||||
<LI>the pathname of the listbox,
|
||||
<LI>the pathname of the drag source,
|
||||
<LI>a list describing where the drop occurs. It can be:
|
||||
<UL>
|
||||
<LI><I>{</I><B>widget</B><I>}</I>,
|
||||
<LI><I>{</I><B>item</B> <I>item}</I> or
|
||||
<LI><I>{</I><B>position</B> <I>index}</I>.
|
||||
</UL>
|
||||
<LI>the current operation,
|
||||
<LI>the data type,
|
||||
<LI>the data.
|
||||
</UL>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropenabled"><B>-dropenabled</B></A></DT>
|
||||
<DD>
|
||||
A boolean specifying if drop is enabled.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropovercmd"><B>-dropovercmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
LsitBox has a command wrapper for <I>drag-over</I> events. This command enables auto scrolling
|
||||
and position extraction during the <I>drag-over</I>.
|
||||
If <B>dropovercmd</B> is not empty, the command is called with the following aguments:
|
||||
<UL>
|
||||
<LI>the pathname of the listbox,
|
||||
<LI>the pathname of the drag source,
|
||||
<LI>a list describing where the drop can occur, whose elements are:
|
||||
<UL>
|
||||
<LI>the string <I>widget</I> if <B>dropovertype</B> option contains <I>w</I>, else empty string.
|
||||
<LI>the targeted item if drag icon points an item and <B>dropovertype</B> option contains
|
||||
<I>i</I>, else empty string.
|
||||
<LI>an index within two items where drag icon points to if <B>dropovertype</B> option
|
||||
contains <I>p</I>, else empty string.
|
||||
<LI>optionally, the preferred method if drop can occur both inside an item and between two
|
||||
items. The value is <I>position</I> or <I>item</I>.
|
||||
</UL>
|
||||
<LI>the current operation,
|
||||
<LI>the data type,
|
||||
<LI>the data.
|
||||
</UL>
|
||||
The command must return a list with two elements:
|
||||
<UL>
|
||||
<LI>the drop status, conforming to those described in <B>dropovercmd</B> option of
|
||||
<B>DropSite::<A HREF="DropSite.html#register">register</A></B>,
|
||||
<LI>the choosen method: <I>widget</I>, <I>item</I> or <I>position</I>.
|
||||
</UL>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropovermode"><B>-dropovermode</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the type of <I>drop-over</I> interaction. Must be a combination of
|
||||
<B>w</B>, which specifies that drop can occurs everywhere on widget,
|
||||
<B>p</B>, which specifies that drop can occurs between two items,
|
||||
and <B>i</B>, which specifies that drop occurs inside items.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-droptypes"><B>-droptypes</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a list of accepted dropped object/operation.
|
||||
See option <B>droptypes</B> of
|
||||
<B>DropSite::<A HREF="DropSite.html#register">register</A></B>.
|
||||
for more infromation.
|
||||
|
||||
<BR>Default is <I>LISTBOX_ITEM</I> with operations <B>copy</B> and <B>move</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired height for the listbox in units of <B>deltay</B> pixels.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-multicolumn"><B>-multicolumn</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies wether or not ListBox layouts items in order to see each one vertically.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-padx"><B>-padx</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies distance between image or window and text of the items.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-redraw"><B>-redraw</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies wether or not the listbox should be redrawn when entering idle.
|
||||
Set it to false if you call <B>update</B> while modifying the listbox.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired width for the listbox in units of 8 pixels.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="bindImage"><I>pathName</I> <B>bindImage</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 the image of a item.
|
||||
The item idenfier on which the event occurs is appended to the command.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="bindText"><I>pathName</I> <B>bindText</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 the label of a item.
|
||||
The item idenfier 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="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>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Deletes all items in <I>arg</I>. <I>arg</I> can be a list
|
||||
of items or a list of list of items.
|
||||
To delete all items, do <I>$pathName delete [$pathName items]</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="edit"><I>pathName</I> <B>edit</B></A>
|
||||
<I>item</I>
|
||||
<I>text</I>
|
||||
?<I>verifycmd</I>?
|
||||
?<I>clickres</I>?
|
||||
?<I>select</I>?
|
||||
</DT><DD>
|
||||
|
||||
Provides a way for the user to edit in place the label of an item.
|
||||
<BR>The command takes the initial text as argument and does not modify the label of the
|
||||
edited node, but returns an empty string if edition is canceled, or the typed text
|
||||
if edition is accepted.
|
||||
<BR>When editing, the user can cancel by pressing Escape, or accept by pressing Return.
|
||||
<BR><I>clickres</I> specifies what to do if the user click outside the editable area.
|
||||
If <I>clickres</I> is 0 (the default), the edition is canceled.
|
||||
If <I>clickres</I> is 1, the edition is accepted.
|
||||
In all other case, the edition continues.
|
||||
<BR>If edition is accepted and <I>modifycmd</I> is not empty, then it is called with
|
||||
the new text as argument and must return 1 to accept the new text, 0 to refuse it
|
||||
and continue edition.
|
||||
<BR><I>select</I> specifies wether or not the initial text should be selected. Default is 1.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="exists"><I>pathName</I> <B>exists</B></A>
|
||||
<I>item</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns 1 if <I>item</I> exists in the listbox, else 0.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="index"><I>pathName</I> <B>index</B></A>
|
||||
<I>item</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the position of <I>item</I> in the list.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="insert"><I>pathName</I> <B>insert</B></A>
|
||||
<I>index</I>
|
||||
<I>item</I>
|
||||
?<I>option value...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Inserts a new item identified by <I>item</I> in the list at position <I>index</I>.
|
||||
|
||||
<P>
|
||||
<DL><DT><A NAME="Item-data"><B>-data</B></A></DT>
|
||||
<DD>
|
||||
|
||||
User data associated to the item.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Item-fill"><B>-fill</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the foreground color of the label of the item.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Item-font"><B>-font</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a font for the label of the item.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Item-image"><B>-image</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an image to display at the left of the label of the item.
|
||||
<B>window</B> option override <B>image</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Item-indent"><B>-indent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the amount of extra space in pixels at the left of the item.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Item-text"><B>-text</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the label of the item.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Item-window"><B>-window</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a pathname to display at the left of the label of the item.
|
||||
<B>window</B> option override <B>image</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="item"><I>pathName</I> <B>item</B></A>
|
||||
<I>first</I>
|
||||
?<I>last</I>?
|
||||
</DT><DD>
|
||||
|
||||
<B>Its use is deprecated. Use <I>items</I> instead.</B><BR>
|
||||
If <I>last</I> is omitted, returns the item at index <I>first</I> in the list,
|
||||
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 items 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="itemcget"><I>pathName</I> <B>itemcget</B></A>
|
||||
<I>item</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>item</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="items"><I>pathName</I> <B>items</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 items.
|
||||
If <I>first</I> is specified and <I>last</I> omitted, returns the item 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 items 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="move"><I>pathName</I> <B>move</B></A>
|
||||
<I>item</I>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Moves <I>item</I> at position <I>index</I> in the list.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="reorder"><I>pathName</I> <B>reorder</B></A>
|
||||
<I>neworder</I>
|
||||
</DT><DD>
|
||||
|
||||
Modifies the order of items in the listbox given by <I>neworder</I>. Items that do not
|
||||
appear in <I>neworder</I> are no moved.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="see"><I>pathName</I> <B>see</B></A>
|
||||
<I>item</I>
|
||||
</DT><DD>
|
||||
|
||||
Arrange the scrolling area to make <I>item</I> visible.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="selection"><I>pathName</I> <B>selection</B></A>
|
||||
<I>cmd</I>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Modifies the list of selected items following <I>cmd</I>:
|
||||
<DL>
|
||||
<DT><B>clear</B>
|
||||
<DD>remove all items of the selection.
|
||||
<DT><B>set</B>
|
||||
<DD>set the selection to all items in <I>arg</I>
|
||||
<DT><B>add</B>
|
||||
<DD>add all items of <I>arg</I> in the selection
|
||||
<DT><B>remove</B>
|
||||
<DD>remove all items of <I>arg</I> of the selection
|
||||
<DT><B>get</B>
|
||||
<DD>return the current selected items
|
||||
</DL>
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="xview"><I>pathName</I> <B>xview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Standard command to enable horizontal scrolling of <I>pathName</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="yview"><I>pathName</I> <B>yview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Standard command to enable vertical scrolling of <I>pathName</I>.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
283
hlp/en/bwidget/MainFrame.html
Normal file
283
hlp/en/bwidget/MainFrame.html
Normal file
@@ -0,0 +1,283 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>MainFrame</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>MainFrame</B>
|
||||
- Manage toplevel with menu, toolbar and statusbar
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>MainFrame</B></A> <I>pathName</I> ?<I>option value...</I>?</DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="ProgressBar.html">OPTIONS from <B>ProgressBar</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -background or -bg</TD>
|
||||
<TD> -progressfg (see <B>-foreground</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -progressmax (see <B>-maximum</B>)</TD>
|
||||
<TD> -progresstype (see <B>-type</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -progressvar (see <B>-variable</B>)</TD>
|
||||
</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="#-menu">-menu</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-separator">-separator</A></TR>
|
||||
<TD> <A HREF="#-textvariable">-textvariable</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#addindicator"><B>addindicator</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#addtoolbar"><B>addtoolbar</B></A>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#getframe"><B>getframe</B></A>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#getindicator"><B>getindicator</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#getmenu"><B>getmenu</B></A>
|
||||
<I>menuid</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#gettoolbar"><B>gettoolbar</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#setmenustate"><B>setmenustate</B></A>
|
||||
<I>tag</I>
|
||||
<I>state</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#showstatusbar"><B>showstatusbar</B></A>
|
||||
<I>name</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#showtoolbar"><B>showtoolbar</B></A>
|
||||
<I>index</I>
|
||||
<I>bool</I>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
MainFrame manage toplevel to have:<BR>
|
||||
<UL>
|
||||
<LI>simple menu creation, with automatic accelerator bindings and
|
||||
<A HREF="DynamicHelp.html">DynamicHelp</A> association,
|
||||
<LI>one or more toolbar that user can hide,
|
||||
<LI>a status bar, displaying a user message or a menu description, and optionnaly a
|
||||
<A HREF="ProgressBar.html">ProgressBar</A>.
|
||||
</UL>
|
||||
</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 user frame in any of the forms acceptable to
|
||||
Tk_GetPixels. If this option is less than or equal to zero (the default) then the window
|
||||
will not request any size at all.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-menu"><B>-menu (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
This option describes the menu. This is a list whose each five elements describe
|
||||
one cascad menu. It has the following form:
|
||||
{<I>menuname</I> <I>tags</I> <I>menuId</I> <I>tearoff</I> <I>menuentries</I>...}
|
||||
where <I>menuentries</I> is a list where each element describe one menu entry, which can be:
|
||||
<UL>
|
||||
<LI>for a separator:<BR>
|
||||
{<B>separator</B>}
|
||||
<LI>for a command:<BR>
|
||||
{<B>command</B> <I>menuname</I> ?<I>tags</I>? ?<I>description</I>? ?<I>accelerator</I>? ?<I>option</I> <I>value</I>? ...}
|
||||
<LI>for a check button:<BR>
|
||||
{<B>checkbutton</B> <I>menuname</I> ?<I>tags</I>? ?<I>description</I>? ?<I>accelerator</I>? ?<I>option</I> <I>value</I>? ...}
|
||||
<LI>for a radio button:<BR>
|
||||
{<B>radiobutton</B> <I>menuname</I> ?<I>tags</I>? ?<I>description</I>? ?<I>accelerator</I> ?<I>option</I> <I>value</I>? ...}
|
||||
<LI>for a cascad menu:<BR>
|
||||
{<B>cascad</B> <I>menuname</I> <I>tags</I> <I>menuId</I> <I>tearoff</I> <I>menuentries</I>}
|
||||
</UL>
|
||||
where:
|
||||
<UL>
|
||||
<LI><I>menuname</I> is the name of the menu. If it contains a &, the following character
|
||||
is automatically converted to the corresponding <B>-underline</B> option of <B>menu add</B>
|
||||
command.
|
||||
<LI><I>tags</I> is the tags list for the entry, used for enabling or disabling menu
|
||||
entries with <B>MainFrame::setmenustate</B>.
|
||||
<LI><I>menuId</I> is an id for the menu, from which you can get menu pathname with
|
||||
<B>MainFrame::getmenu</B>.
|
||||
<LI><I>tearoff</I> specifies if menu has tearoff entry.
|
||||
<LI><I>description</I> specifies a string for <A HREF=\"DynamicHelp.html\">DynamicHelp</A>.
|
||||
<LI><I>accelerator</I> specifies a key sequence. It is a list of two elements, where the first
|
||||
is one of <B>Ctrl</B>, <B>Alt</B> or <B>CtrlAlt</B>, and the second as letter or a digit.
|
||||
An accelerator string is build and corresponding binding set on the toplevel to invoke the
|
||||
menu entry.
|
||||
<LI><I>option value</I> specifies additionnal options for the entry (see <B>menu add</B>
|
||||
command).
|
||||
</UL>
|
||||
Each value enclosed by ? are optional and defaulted to empty string, but must be
|
||||
provided if one or more following options is not empty.
|
||||
<BR>Example:
|
||||
<PRE>
|
||||
set descmenu {
|
||||
"&File" {} {} 0 {
|
||||
{command "&New" {} "Create a new document" {Ctrl n} -command Menu::new}
|
||||
{command "&Open..." {} "Open an existing document" {Ctrl o} -command Menu::open}
|
||||
{command "&Save" open "Save the document" {Ctrl s} -command Menu::save}
|
||||
{cascad "&Export" {} export 0 {
|
||||
{command "Format &1" open "Export document to format 1" {} -command {Menu::export 1}}
|
||||
{command "Format &2" open "Export document to format 2" {} -command {Menu::export 2}}
|
||||
}}
|
||||
{separator}
|
||||
{cascad "&Recent files" {} recent 0 {}}
|
||||
{separator}
|
||||
{command "E&xit" {} "Exit the application" {} -command Menu::exit}
|
||||
}
|
||||
"&Options" {} {} 0 {
|
||||
{checkbutton "Toolbar" {} "Show/hide toolbar" {}
|
||||
-variable Menu::_drawtoolbar
|
||||
-command {$Menu::_mainframe showtoolbar toolbar $Menu::_drawtoolbar}
|
||||
}
|
||||
}
|
||||
}
|
||||
</PRE>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-separator"><B>-separator (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies if separator should be drawn at the top and/or at the bottom of the user window.
|
||||
Must be one of the values <B>none</B>, <B>top</B>, <B>bottom</B> or <B>both</B>.
|
||||
It depends on the relief of subwidgets of user window.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-textvariable"><B>-textvariable</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the textvariable option for the label of the status bar.
|
||||
<A HREF="DynamicHelp.html">DynamicHelp</A> description
|
||||
of menu entries are mapped to this variable at the creation of the MainFrame.
|
||||
If this variable is changed by MainFrame::configure, menu description will
|
||||
not be available.
|
||||
<BR>You change the text of the label by modifying the value of the variable.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired width for the user frame in any of the forms acceptable to
|
||||
Tk_GetPixels. If this option is less than or equal to zero (the default) then the window
|
||||
will not request any size at all.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="addindicator"><I>pathName</I> <B>addindicator</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Add an indicator box at the right of the status bar. Each indicator are added from left
|
||||
to right. An indicator is a Tk label widget configured with option-value pair
|
||||
given by ?<I>arg...</I>?. <B>-relief</B> and <B>-borderwidth</B> options are respetively
|
||||
defaulted to <I>sunken</I> and 1. Returns the pathname of the created label.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="addtoolbar"><I>pathName</I> <B>addtoolbar</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Add a toolbar to the MainFrame. Returns the pathname of the new window where to place
|
||||
toolbar items.
|
||||
</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="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="getframe"><I>pathName</I> <B>getframe</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Returns the pathname of the user window.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="getindicator"><I>pathName</I> <B>getindicator</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the pathname of the <I>index</I>th added indicator.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="getmenu"><I>pathName</I> <B>getmenu</B></A>
|
||||
<I>menuid</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the pathname of the menu whose id is <I>menuid</I>.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="gettoolbar"><I>pathName</I> <B>gettoolbar</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the pathname of the <I>index</I>th added toolbar.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setmenustate"><I>pathName</I> <B>setmenustate</B></A>
|
||||
<I>tag</I>
|
||||
<I>state</I>
|
||||
</DT><DD>
|
||||
|
||||
Set the <B>-state</B> option value of all the menu entries that have the tag <I>tag</I>
|
||||
to <I>state</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="showstatusbar"><I>pathName</I> <B>showstatusbar</B></A>
|
||||
<I>name</I>
|
||||
</DT><DD>
|
||||
|
||||
<I>name</I> is one of <B>none</B>, <B>status</B> or <B>progression</B>.
|
||||
Use <B>none</B> to hide the status bar, <B>status</B> to display the label only, or
|
||||
<B>progression</B> to display the label and the
|
||||
<A HREF="ProgressBar.html">ProgressBar</A>.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="showtoolbar"><I>pathName</I> <B>showtoolbar</B></A>
|
||||
<I>index</I>
|
||||
<I>bool</I>
|
||||
</DT><DD>
|
||||
|
||||
Hide if <I>bool</I> is 0, or show if <I>bool</I> is 1 the <I>index</I>th added toolbar.
|
||||
To prevent your toplevel from resizing while hiding/showing toolbar,
|
||||
do [wm geometry $top [wm geometry $top]] when it is managed.
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
208
hlp/en/bwidget/MessageDlg.html
Normal file
208
hlp/en/bwidget/MessageDlg.html
Normal file
@@ -0,0 +1,208 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>MessageDlg</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>MessageDlg</B>
|
||||
- Message dialog box
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>MessageDlg</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-anchor">-anchor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-font">-font</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-padx">-padx</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-pady">-pady</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="Dialog.html">OPTIONS from <B>Dialog</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -background or -bg</TD>
|
||||
<TD> -cancel</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -default</TD>
|
||||
<TD> -parent</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="#-aspect">-aspect</A></TR>
|
||||
<TD> <A HREF="#-buttons">-buttons</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-icon">-icon</A></TR>
|
||||
<TD> <A HREF="#-justify">-justify</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-message">-message</A></TR>
|
||||
<TD> <A HREF="#-title">-title</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-type">-type</A></TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
MessageDlg provides a simple way to display a message dialog.
|
||||
MessageDlg::<B>create</B> creates the message dialog, displays
|
||||
it and return the index of the pressed button, or -1 if it is destroyed.
|
||||
When returning, the dialog no longer exists.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-aspect"><B>-aspect</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a non-negative integer value indicating desired
|
||||
aspect ratio for the text. The aspect ratio is specified as
|
||||
100*width/height. 100 means the text should
|
||||
be as wide as it is tall, 200 means the text should
|
||||
be twice as wide as it is tall, 50 means the text should
|
||||
be twice as tall as it is wide, and so on.
|
||||
Used to choose line length for text if <B>width</B> option
|
||||
isn't specified.
|
||||
Defaults to 150.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-buttons"><B>-buttons</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a list of buttons to display when <B>type</B> option is <I>user</I>.
|
||||
If a button has a symbolic name, its associated text will be displayed.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-icon"><B>-icon</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an icon to display. Must be one of the following: <B>error</B>, <B>info</B>,
|
||||
<B>question</B> or <B>warning</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-justify"><B>-justify</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies how to justify lines of text.
|
||||
Must be one of <B>left</B>, <B>center</B>, or <B>right</B>. Defaults
|
||||
to <B>left</B>.
|
||||
This option works together with the <B>anchor</B>, <B>aspect</B>,
|
||||
<B>padx</B>, <B>pady</B>, and <B>width</B> options to provide a variety
|
||||
of arrangements of the text within the window.
|
||||
The <B>aspect</B> and <B>width</B> options determine the amount of
|
||||
screen space needed to display the text.
|
||||
The <B>anchor</B>, <B>padx</B>, and <B>pady</B> options determine where this
|
||||
rectangular area is displayed within the widget's window, and the
|
||||
<B>justify</B> option determines how each line is displayed within that
|
||||
rectangular region.
|
||||
For example, suppose <B>anchor</B> is <B>e</B> and <B>justify</B> is
|
||||
<B>left</B>, and that the message window is much larger than needed
|
||||
for the text.
|
||||
The the text will displayed so that the left edges of all the lines
|
||||
line up and the right edge of the longest line is <B>padx</B> from
|
||||
the right side of the window; the entire text block will be centered
|
||||
in the vertical span of the window.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-message"><B>-message</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the message to display in this message box.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-title"><B>-title</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a string to display as the title of the message box.
|
||||
If the value is empty (the default), a default title will be set corresponding
|
||||
to the <B>icon</B> option.
|
||||
The default associated title is in english, and can be modified to set it in
|
||||
another language by specifying the resource:
|
||||
<PRE> *MessageDlg.<I>name</I>Title: <I>value</I></PRE>
|
||||
or the equivalent tcl command:
|
||||
<PRE> option add *MessageDlg.<I>name</I>Title <I>value</I></PRE>
|
||||
where <I>name</I> is the name of an icon as defined in the <B>icon</B> option.
|
||||
<BR>For example, for french language, you can specify for a warning dialog:
|
||||
<PRE> option add *MessageDlg.warningTitle "Attention"</PRE>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-type"><B>-type</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a set of buttons to be displayed. The following values are possible:
|
||||
<DD>
|
||||
<P>
|
||||
<DL COMPACT>
|
||||
<DT>
|
||||
<B>abortretryignore</B>
|
||||
<DD>
|
||||
Displays three buttons whose symbolic names are <B>abort</B>,
|
||||
<B>retry</B> and <B>ignore</B>.<P>
|
||||
<DT>
|
||||
<B>ok</B>
|
||||
<DD>
|
||||
Displays one button whose symbolic name is <B>ok</B>.<P>
|
||||
<DT>
|
||||
<B>okcancel</B>
|
||||
<DD>
|
||||
Displays two buttons whose symbolic names are <B>ok</B> and <B>cancel</B>.<P>
|
||||
<DT>
|
||||
<B>retrycancel</B>
|
||||
<DD>
|
||||
Displays two buttons whose symbolic names are <B>retry</B> and <B>cancel</B>.<P>
|
||||
<DT>
|
||||
<B>yesno</B>
|
||||
<DD>
|
||||
Displays two buttons whose symbolic names are <B>yes</B> and <B>no</B>.<P>
|
||||
<DT>
|
||||
<B>yesnocancel</B>
|
||||
<DD>
|
||||
Displays three buttons whose symbolic names are <B>yes</B>, <B>no</B>
|
||||
and <B>cancel</B>.
|
||||
<P>
|
||||
<DT>
|
||||
<B>user</B>
|
||||
<DD>
|
||||
Displays buttons of <B>-buttons</B> option.<P>
|
||||
<DT>
|
||||
</DL COMPACT>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the length of lines in the window.
|
||||
If this option has a value greater than zero then the <B>aspect</B>
|
||||
option is ignored and the <B>width</B> option determines the line
|
||||
length.
|
||||
If this option has a value less than or equal to zero, then
|
||||
the <B>aspect</B> option determines the line length.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
</BODY></HTML>
|
||||
343
hlp/en/bwidget/NoteBook.html
Normal file
343
hlp/en/bwidget/NoteBook.html
Normal file
@@ -0,0 +1,343 @@
|
||||
<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="#-height">-height</A></TR>
|
||||
<TD> <A HREF="#-homogeneous">-homogeneous</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-side">-side</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="#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>
|
||||
|
||||
NoteBook widget manage a set of pages and displays one of them.
|
||||
|
||||
</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 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 wether or not the label of the pages must have the same width.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-side"><B>-side (read-only)</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>.
|
||||
Only <B>top</B> is implemented for the moment.
|
||||
|
||||
</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 tabs. The page idenfier 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 idendified 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.
|
||||
|
||||
<P>
|
||||
<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-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-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-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>
|
||||
174
hlp/en/bwidget/PagesManager.html
Normal file
174
hlp/en/bwidget/PagesManager.html
Normal file
@@ -0,0 +1,174 @@
|
||||
<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>
|
||||
130
hlp/en/bwidget/PanedWindow.html
Normal file
130
hlp/en/bwidget/PanedWindow.html
Normal file
@@ -0,0 +1,130 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>PanedWindow</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>PanedWindow</B>
|
||||
- Tiled layout manager widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>PanedWindow</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 or -bg</A></TD>
|
||||
</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="#-pad">-pad</A></TR>
|
||||
<TD> <A HREF="#-side">-side</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-width">-width</A></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>option value...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#getframe"><B>getframe</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
PanedWindow is a widget that lays out children in
|
||||
a vertically or horizontally tiled format.
|
||||
The user can adjust the size of the panes, with a pane control sash created
|
||||
between children.
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-pad"><B>-pad (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies additional space between the button of the sash and children.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-side"><B>-side (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the side of the sash, which implies the layout: <B>top</B> or <B>bottom</B>
|
||||
(horizontal layout), <B>left</B> or <B>right</B> (vertical layout).
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the width of the button of the sash.
|
||||
|
||||
</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>option value...</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command add a new pane. The new pane is placed below the previous pane for vertical
|
||||
layout or at right for horizontal layout. This command returns a frame where user can place
|
||||
its widget. Valid options are:
|
||||
<P>
|
||||
<DL><DT><A NAME="Pane-minsize"><B>-minsize</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the minimum size requested for the pane.
|
||||
See the <B>grid</B> command for more information.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Pane-weight"><B>-weight</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the relative weight for apportioning any extra spaces among panes.
|
||||
See the <B>grid</B> command for more information.
|
||||
</DD>
|
||||
</DL>
|
||||
</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="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="getframe"><I>pathName</I> <B>getframe</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the pathname of the <I>index</I>th added pane.
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
214
hlp/en/bwidget/PasswdDlg.html
Normal file
214
hlp/en/bwidget/PasswdDlg.html
Normal file
@@ -0,0 +1,214 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>PasswdDlg</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>PasswdDlg</B>
|
||||
- Login/Password dialog box
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>PasswdDlg</B></A> <I>pathName</I> ?<I>option value...</I>?</DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="Dialog.html">OPTIONS from <B>Dialog</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -anchor</TD>
|
||||
<TD> -background or -bg</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -homogeneous</TD>
|
||||
<TD> -modal</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -padx</TD>
|
||||
<TD> -pady</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -parent</TD>
|
||||
<TD> -spacing</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -title</TD>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="LabelEntry.html">OPTIONS from <B>LabelEntry</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -background or -bg</TD>
|
||||
<TD> -borderwidth or -bd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -disabledforeground</TD>
|
||||
<TD> -entrybg</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -entryfg</TD>
|
||||
<TD> -exportselection</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -font</TD>
|
||||
<TD> -foreground or -fg</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helptype</TD>
|
||||
<TD> -highlightbackground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -highlightcolor</TD>
|
||||
<TD> -highlightthickness</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertbackground</TD>
|
||||
<TD> -insertborderwidth</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertofftime</TD>
|
||||
<TD> -insertontime</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertwidth</TD>
|
||||
<TD> -labelanchor</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -labelfont</TD>
|
||||
<TD> -labelheight</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -labeljustify</TD>
|
||||
<TD> -labelwidth</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -loginhelptext (see <B>-helptext</B>)</TD>
|
||||
<TD> -loginhelpvar (see <B>-helpvar</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -loginlabel (see <B>-label</B>)</TD>
|
||||
<TD> -logintext (see <B>-text</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -logintextvariable (see <B>-textvariable</B>)</TD>
|
||||
<TD> -loginunderline (see <B>-underline</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -passwdeditable (see <B>-editable</B>)</TD>
|
||||
<TD> -passwdhelptext (see <B>-helptext</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -passwdhelpvar (see <B>-helpvar</B>)</TD>
|
||||
<TD> -passwdlabel (see <B>-label</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -passwdstate (see <B>-state</B>)</TD>
|
||||
<TD> -passwdtext (see <B>-text</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -passwdtextvariable (see <B>-textvariable</B>)</TD>
|
||||
<TD> -passwdunderline (see <B>-underline</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -relief</TD>
|
||||
<TD> -selectbackground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -selectborderwidth</TD>
|
||||
<TD> -selectforeground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -wraplength</TD>
|
||||
</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="#-command">-command</A></TR>
|
||||
<TD> <A HREF="#-type">-type</A></TR>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
PasswdDlg provides a simple way to display a login/password dialog.
|
||||
PasswdDlg::<B>create</B> creates the dialog, displays it, and return the value of login
|
||||
and password in a list, or an empty list if it is destroyed or user press cancel.
|
||||
When returning, the dialog no longer exists.
|
||||
<BR>Additionnal resources can be set to modify other text:
|
||||
<PRE>
|
||||
*loginName Label for login LabelEntry
|
||||
*passwordName Label for password LabelEntry
|
||||
</PRE>
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-command"><B>-command</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to call when user press ok button.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-type"><B>-type</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a set of buttons to be displayed. The following values are possible:
|
||||
<DD>
|
||||
<P>
|
||||
<DL COMPACT>
|
||||
<DT>
|
||||
<B>ok</B>
|
||||
<DD>
|
||||
Displays one button whose symbolic name is <B>ok</B>.<P>
|
||||
<DT>
|
||||
<B>okcancel</B>
|
||||
<DD>
|
||||
Displays two buttons whose symbolic names are <B>ok</B> and <B>cancel</B>.<P>
|
||||
</DL COMPACT>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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>
|
||||
<HR>
|
||||
|
||||
<ADRESS>Stephane Lavirotte <A HREF="mailto:Stephane.Lavirotte@sophia.inria.fr">(Stephane.Lavirotte@sophia.inria.fr)</A></ADRESS>
|
||||
|
||||
</BODY></HTML>
|
||||
136
hlp/en/bwidget/ProgressBar.html
Normal file
136
hlp/en/bwidget/ProgressBar.html
Normal file
@@ -0,0 +1,136 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ProgressBar</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ProgressBar</B>
|
||||
- Progress indicator widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ProgressBar</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-orient">-orient</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
<TD> <A HREF="options.htm#M-troughcolor">-troughcolor</A></TR>
|
||||
</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="#-maximum">-maximum</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-type">-type</A></TR>
|
||||
<TD> <A HREF="#-variable">-variable</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
ProgressBar widget indicates the user the progress of a lengthly operation.
|
||||
It is used by <A HREF="MainFrame.html">MainFrame</A>
|
||||
and <A HREF="ProgressDlg.html">ProgressDlg</A>.
|
||||
</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 progress indicator.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-maximum"><B>-maximum</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the maximum value of the variable.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-type"><B>-type</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the type of the ProgressBar. Must be one of <B>normal</B>, <B>incremental</B> or
|
||||
<B>infinite</B>.
|
||||
<BR>If <B>type</B> is <I>normal</I>, the progress indicator is drawn proportional
|
||||
to the variable value and <B>maximum</B> option each time the variable is set.
|
||||
<BR>If <B>type</B> is <I>incremental</I>, the value of the progress indicator is maintained internally,
|
||||
and incremented each time the variable is set by its value. The progress indicator is drawn proportional
|
||||
to the internal value and <B>maximum</B> option.
|
||||
<BR>If <B>type</B> is <I>infinite</I>, the value of the progress indicator is maintained internally,
|
||||
and incremented each time the variable is set by its value. The progress indicator grow from left to
|
||||
right if internal value (modulo <B>maximum</B>) is less than <B>maximum</B>/2, and from right to left if
|
||||
internal value is greater than <B>maximum</B>/2.
|
||||
<BR>See <B>-variable</B> option for special case of its value,
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-variable"><B>-variable</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the variable attached to the progress indicator.
|
||||
Progress indicator is updated when the value of the variable changes.
|
||||
If the value of the variable is negative, the progress indicator is not
|
||||
displayed (it is drawn flat with <B>background</B> color
|
||||
- usefull for ProgressDlg to make it invisible). If its value 0, progress indicator
|
||||
is reinitialized.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired width for the progress indicator.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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>
|
||||
</BODY></HTML>
|
||||
143
hlp/en/bwidget/ProgressDlg.html
Normal file
143
hlp/en/bwidget/ProgressDlg.html
Normal file
@@ -0,0 +1,143 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ProgressDlg</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ProgressDlg</B>
|
||||
- Progress indicator dialog box
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ProgressDlg</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>
|
||||
<TD> <A HREF="options.htm#M-textvariable">-textvariable</A></TR>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="Dialog.html">OPTIONS from <B>Dialog</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -background or -bg</TD>
|
||||
<TD> -parent</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -separator</TD>
|
||||
<TD> -title</TD>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="ProgressBar.html">OPTIONS from <B>ProgressBar</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -background or -bg</TD>
|
||||
<TD> -borderwidth or -bd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -foreground or -fg</TD>
|
||||
<TD> -maximum</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -relief</TD>
|
||||
<TD> -troughcolor</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -type</TD>
|
||||
<TD> -variable</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="#-command">-command</A></TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-stop">-stop</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="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
ProgressDlg provides a simple way to display a progress indicator dialog.
|
||||
ProgressDlg::<B>create</B> creates the dialog, displays it, set a local
|
||||
grab to it and immediatly return. The dialog is updated by modifying the
|
||||
value of the variable of options <B>-textvariable</B> and <B>-variable</B>.
|
||||
You have to destroy the dialog after use.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-command"><B>-command</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to call when user press stop button.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a desired height for the label in lines of text.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-stop"><B>-stop</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the text of the button typically used to stop process. If empty, no button will
|
||||
be drawn. This can be a symbolic name.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a desired width for the label in characters.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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>
|
||||
</BODY></HTML>
|
||||
130
hlp/en/bwidget/ScrollView.html
Normal file
130
hlp/en/bwidget/ScrollView.html
Normal file
@@ -0,0 +1,130 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ScrollView</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ScrollView</B>
|
||||
- Display the visible area of a scrolled window
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ScrollView</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-cursor">-cursor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
</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="#-fill">-fill</A></TR>
|
||||
<TD> <A HREF="#-foreground">-foreground or -fg</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-window">-window</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
ScrollView displays the visible area of a scrolled window within
|
||||
its scroll region.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-fill"><B>-fill</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the fill color of the rectangle.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-foreground"><B>-foreground</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the color of the border of the rectangle.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired height for the ScrollView.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired width for the ScrollView.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-window"><B>-window</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the window to view. This widget must have <B>-xscrollcommand</B> and
|
||||
<B>-yscrollcommand</B> options, and respond to <B>xview</B> and <B>yview</B> command.
|
||||
In order to make ScrollView working with other scrollbar, <B>-xscrollcommand</B> and
|
||||
<B>-yscrollcommand</B> options of the widget must be set before the widget is passed to
|
||||
the <B>-window</B> option of the ScrollView (for example, if the widget is handled by
|
||||
a ScrolledWindow, call <B>setwidget</B> before setting <B>-window</B> option).
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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>
|
||||
<HR><BR><B>BINDINGS</B><BR><BR>
|
||||
|
||||
<DL><DT>If mouse button 1 is pressed and dragged over the ScrollView, the top left corner of
|
||||
the visible area of the scrolled window is moved proportionally to the mouse displacement.
|
||||
</DT></DL>
|
||||
<DL><DT>If mouse button 3 is pressed over the ScrollView, the top left corner of the visible
|
||||
area is proportionally set to this point.
|
||||
</DT></DL>
|
||||
|
||||
</BODY></HTML>
|
||||
191
hlp/en/bwidget/ScrollableFrame.html
Normal file
191
hlp/en/bwidget/ScrollableFrame.html
Normal file
@@ -0,0 +1,191 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ScrollableFrame</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ScrollableFrame</B>
|
||||
- Scrollable frame containing widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ScrollableFrame</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-xscrollcommand">-xscrollcommand</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-yscrollcommand">-yscrollcommand</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="#-areaheight">-areaheight</A></TR>
|
||||
<TD> <A HREF="#-areawidth">-areawidth</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-constrainedheight">-constrainedheight</A></TR>
|
||||
<TD> <A HREF="#-constrainedwidth">-constrainedwidth</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-xscrollincrement">-xscrollincrement</A></TR>
|
||||
<TD> <A HREF="#-yscrollincrement">-yscrollincrement</A></TR>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#getframe"><B>getframe</B></A>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#see"><B>see</B></A>
|
||||
<I>widget</I>
|
||||
?<I>vert</I>?
|
||||
?<I>horz</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#xview"><B>xview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#yview"><B>yview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
ScrollableFrame widget containing widget.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-areaheight"><B>-areaheight</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the height for the scrollable area. If zero, then the height
|
||||
of the scrollable area is made just large enough to hold all its children.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-areawidth"><B>-areawidth</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the width for the scrollable area. If zero, then the width
|
||||
of the scrollable area window is made just large enough to hold all its children.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-constrainedheight"><B>-constrainedheight</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies whether or not the scrollable area should have the same height of the
|
||||
scrolled window. If true, vertical scrollbar is not needed.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-constrainedwidth"><B>-constrainedwidth</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies whether or not the scrollable area should have the same width of the
|
||||
scrolled window. If true, horizontal scrollbar is not needed.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired height for the window in pixels.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired width for the window in pixels.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-xscrollincrement"><B>-xscrollincrement</B></A></DT>
|
||||
<DD>
|
||||
|
||||
See <B>xscrollincrement</B> option of <B>canvas</B> widget.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-yscrollincrement"><B>-yscrollincrement</B></A></DT>
|
||||
<DD>
|
||||
|
||||
See <B>yscrollincrement</B> option of <B>canvas</B> widget.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="getframe"><I>pathName</I> <B>getframe</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Return the pathname of the scrolled frame where widget should be created.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="see"><I>pathName</I> <B>see</B></A>
|
||||
<I>widget</I>
|
||||
?<I>vert</I>?
|
||||
?<I>horz</I>?
|
||||
</DT><DD>
|
||||
|
||||
Arrange scrollable area to make <I>widget</I> visible in the window.
|
||||
<I>vert</I> and <I>horz</I> specify which part of <I>widget</I> must be preferably
|
||||
visible, in case where <I>widget</I> is too tall or too large to be entirely visible.
|
||||
<I>vert</I> must be <B>top</B> (the default) or <B>bottom</B>,
|
||||
and <I>horz</I> must be <B>left</B> (the default) or <B>right</B>.
|
||||
If <I>vert</I> or <I>horz</I> is not a valid value, area is not scrolled in this direction.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="xview"><I>pathName</I> <B>xview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Standard command to enable horizontal scrolling of <I>pathName</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="yview"><I>pathName</I> <B>yview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Standard command to enable vertical scrolling of <I>pathName</I>.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
115
hlp/en/bwidget/ScrolledWindow.html
Normal file
115
hlp/en/bwidget/ScrolledWindow.html
Normal file
@@ -0,0 +1,115 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>ScrolledWindow</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>ScrolledWindow</B>
|
||||
- Generic scrolled widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>ScrolledWindow</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</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="#-auto">-auto</A></TR>
|
||||
<TD> <A HREF="#-scrollbar">-scrollbar</A></TR>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#getframe"><B>getframe</B></A>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#setwidget"><B>setwidget</B></A>
|
||||
<I>widget</I>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
ScrolledWindow enables user to create easily a widget with its scrollbar.
|
||||
Scrollbars are created by ScrolledWindow and scroll commands are automatically associated to
|
||||
a scrollable widget with <B>ScrolledWindow::setwidget</B>.
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-auto"><B>-auto</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired auto managed scrollbar:
|
||||
<LI><B>none</B> means scrollbar are always drawn
|
||||
<LI><B>horizontal</B> means horizontal scrollbar is drawn as needed
|
||||
<LI><B>vertical</B> means vertical scrollbar is drawn as needed
|
||||
<LI><B>both</B> means horizontal and vertical scrollbars are drawn as needed
|
||||
<LI><B>horizontal</B> means horizontal scrollbar is drawn as needed
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-scrollbar"><B>-scrollbar (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired scrollbar: <B>none</B>, <B>horizontal</B>, <B>vertical</B>
|
||||
or <B>both</B>. This option is not modifiable with <B>ScrolledWindow::configure</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="getframe"><I>pathName</I> <B>getframe</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Return the pathname of the frame where the scrolled widget should be created. This command
|
||||
is no longer needed. You can directly create the scrolled widget as the child
|
||||
of <I>pathName</I>.
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setwidget"><I>pathName</I> <B>setwidget</B></A>
|
||||
<I>widget</I>
|
||||
</DT><DD>
|
||||
|
||||
Associate <I>widget</I> to the the scrollbars. <I>widget</I> is packed
|
||||
in with option <B>expand</B> to <I>yes</I> and <B>fill</B> to <I>both</I>.
|
||||
<I>widget</I> must be a scrollable widget, i.e. have the options
|
||||
<B>xscrollcommand</B>/<B>yscrollcommand</B> and the command <B>xview</B>/<B>yview</B>,
|
||||
such as canvas or text.
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
152
hlp/en/bwidget/SelectColor.html
Normal file
152
hlp/en/bwidget/SelectColor.html
Normal file
@@ -0,0 +1,152 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>SelectColor</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>SelectColor</B>
|
||||
- Color selection widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>SelectColor</B></A> <I>pathName</I> ?<I>option value...</I>?</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="#-color">-color</A></TR>
|
||||
<TD> <A HREF="#-command">-command</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
<TD> <A HREF="#-parent">-parent</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-title">-title</A></TR>
|
||||
<TD> <A HREF="#-type">-type</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-variable">-variable</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="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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>SelectColor::<A HREF="#setcolor"><B>setcolor</B></A>
|
||||
<I>index</I>
|
||||
<I>color</I>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
SelectColor provides a simple way to select color. It can be displayed
|
||||
as a dialog box or as a menubutton.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-color"><B>-color</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the color value of the widget.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-command"><B>-command</B></A></DT>
|
||||
<DD>
|
||||
|
||||
When <B>type</B> is <I>menubutton</I>,
|
||||
specifies a command to call when user select a color.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
When <B>type</B> is <I>menubutton</I>, specifies the desired height for the button.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-parent"><B>-parent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Parent of the Dialog. Dialog is centered in its parent. If empty, it is centered in
|
||||
root window.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-title"><B>-title</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Title of the Dialog toplevel.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-type"><B>-type (read-only)</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the type of the SelectColor widget. Must be <B>dialog</B> or <B>menubutton</B>.
|
||||
<BR>If <B>type</B> option is <I>dialog</I>, SelectColor::<B>create</B> directly creates the
|
||||
dialog, displays it and return an empty string if cancel button is pressed or if dialog is
|
||||
destroyed, and the selected color if ok button is pressed. In all cases, dialog is destroyed.
|
||||
<BR>If <B>type</B> option is <I>menubutton</I>, SelectColor::<B>create</B> returns the
|
||||
pathname of the widget created. It is composed of a button from which user can access a menu
|
||||
displaying predefined colors.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-variable"><B>-variable</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a variable to link to the color value of the widget.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
When <B>type</B> is <I>menubutton</I>, specifies the desired width for the button.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="setcolor">SelectColor::<B>setcolor</B></A>
|
||||
<I>index</I>
|
||||
<I>color</I>
|
||||
</DT><DD>
|
||||
|
||||
Set the value of user predefined color at index <I>index</I> to <I>color</I>.
|
||||
<I>index</I> must be between 1 and 5.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
132
hlp/en/bwidget/SelectFont.html
Normal file
132
hlp/en/bwidget/SelectFont.html
Normal file
@@ -0,0 +1,132 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>SelectFont</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>SelectFont</B>
|
||||
- Font selection widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>SelectFont</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-font">-font</A></TR>
|
||||
</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="#-command">-command</A></TR>
|
||||
<TD> <A HREF="#-parent">-parent</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-sampletext">-sampletext</A></TR>
|
||||
<TD> <A HREF="#-title">-title</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-type">-type</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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>SelectFont::<A HREF="#loadfont"><B>loadfont</B></A>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
SelectFont provides a simple way to choose font. It can be displayed
|
||||
as a dialog box or as a toolbar.
|
||||
<BR>Textual items in Dialog box uses <B>-name</B> options so they
|
||||
can be translated to any language. Symbolic name used are
|
||||
<B>ok</B>, <B>cancel</B>, <B>font</B>, <B>size</B>, <B>style</B>,
|
||||
<B>bold</B>, <B>italic</B>, <B>underline</B> and <B>overstrike</B>.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-command"><B>-command</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to call when user select a new font when SelectFont <B>type</B>
|
||||
option is <I>toolbar</I>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-parent"><B>-parent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Parent of the Dialog. Dialog is centered in its parent. If empty, it is centered in
|
||||
root window.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-sampletext"><B>-sampletext</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the text displayed in the preview area.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-title"><B>-title</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Title of the Dialog toplevel.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-type"><B>-type</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the type of the SelectFont widget. Must be <B>dialog</B> or <B>toolbar</B>.
|
||||
<BR>If <B>type</B> option is <I>dialog</I>, SelectFont::<B>create</B> directly creates the
|
||||
dialog, displays it and return an empty string if cancel button is pressed or if dialog is
|
||||
destroyed, and the selected font if ok button is pressed. In all cases, dialog is destroyed.
|
||||
<BR>If <B>type</B> option is <I>toolbar</I>, SelectFont::<B>create</B> returns the pathname
|
||||
of the widget created.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="loadfont">SelectFont::<B>loadfont</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Load the font available in the system.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
77
hlp/en/bwidget/Separator.html
Normal file
77
hlp/en/bwidget/Separator.html
Normal file
@@ -0,0 +1,77 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>Separator</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>Separator</B>
|
||||
- 3D separator widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>Separator</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-orient">-orient</A></TR>
|
||||
</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="#-relief">-relief</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
Separator is a widget that display an horizontal or vertical 3-D line.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-relief"><B>-relief</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the relief of the Separator. Must be <B>groove</B> (the default) or <B>ridge</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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>
|
||||
</BODY></HTML>
|
||||
250
hlp/en/bwidget/SpinBox.html
Normal file
250
hlp/en/bwidget/SpinBox.html
Normal file
@@ -0,0 +1,250 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>SpinBox</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>SpinBox</B>
|
||||
- SpinBox widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>SpinBox</B></A> <I>pathName</I> ?<I>option value...</I>?</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> -background or -bg</TD>
|
||||
<TD> -disabledforeground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -foreground or -fg</TD>
|
||||
<TD> -repeatdelay</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -repeatinterval</TD>
|
||||
<TD> -state</TD>
|
||||
</TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="Entry.html">OPTIONS from <B>Entry</B></A></I></DT>
|
||||
<DD><TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
|
||||
<TR>
|
||||
<TD> -command</TD>
|
||||
<TD> -disabledforeground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dragenabled</TD>
|
||||
<TD> -dragendcmd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dragevent</TD>
|
||||
<TD> -draginitcmd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dragtype</TD>
|
||||
<TD> -dropcmd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -dropenabled</TD>
|
||||
<TD> -dropovercmd</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -droptypes</TD>
|
||||
<TD> -editable</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -entrybg (see <B>-background</B>)</TD>
|
||||
<TD> -entryfg (see <B>-foreground</B>)</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -exportselection</TD>
|
||||
<TD> -font</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helptext</TD>
|
||||
<TD> -helptype</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -helpvar</TD>
|
||||
<TD> -highlightbackground</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -highlightcolor</TD>
|
||||
<TD> -highlightthickness</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertbackground</TD>
|
||||
<TD> -insertborderwidth</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertofftime</TD>
|
||||
<TD> -insertontime</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -insertwidth</TD>
|
||||
<TD> -justify</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -selectbackground</TD>
|
||||
<TD> -selectborderwidth</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -selectforeground</TD>
|
||||
<TD> -show</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -state</TD>
|
||||
<TD> -takefocus</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -text</TD>
|
||||
<TD> -textvariable</TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> -width</TD>
|
||||
<TD> -xscrollcommand</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="#-modifycmd">-modifycmd</A></TR>
|
||||
<TD> <A HREF="#-range">-range</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-values">-values</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#bind"><B>bind</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#getvalue"><B>getvalue</B></A>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#setvalue"><B>setvalue</B></A>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
SpinBox widget enables the user to select a value among a list given by the <B>values</B>
|
||||
option or a set of values defined by a mininum, a maximum and an increment.
|
||||
Notice that <B>range</B> option defines a list of values, so <B>getvalue</B> and
|
||||
<B>setvalue</B> work with both values and range.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-modifycmd"><B>-modifycmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a Tcl command called when the user modify the value of the SpinBox.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-range"><B>-range</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a list of three intergers (or real) describing the minimum, maximum and increment
|
||||
of the SpinBox.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-values"><B>-values</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the values accepted by the SpinBox. This option takes precedence over
|
||||
<B>range</B> option.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="bind"><I>pathName</I> <B>bind</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Set bindings on the entry widget.
|
||||
|
||||
</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="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="getvalue"><I>pathName</I> <B>getvalue</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Returns the index of the current text of the SpinBox in the list of values,
|
||||
or -1 if it doesn't match any value.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setvalue"><I>pathName</I> <B>setvalue</B></A>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Set the text of the SpinBox to the value indicated by <I>index</I> in the list of values.
|
||||
<I>index</I> may be specified in any of the following forms:
|
||||
<P>
|
||||
<DL COMPACT>
|
||||
<DT>
|
||||
<B>last</B>
|
||||
<DD>
|
||||
Specifies the last element of the list of values.
|
||||
<DT><B>first</B>
|
||||
<DD>
|
||||
Specifies the first element of the list of values.
|
||||
<DT>
|
||||
<B>next</B>
|
||||
<DD>
|
||||
Specifies the element following the current (ie returned by <B>getvalue</B>) in the list
|
||||
of values.
|
||||
<DT><B>previous</B>
|
||||
<DD>
|
||||
Specifies the element preceding the current (ie returned by <B>getvalue</B>) in the list
|
||||
of values.
|
||||
<DT>
|
||||
@<I>number</I>
|
||||
<DD>
|
||||
Specifies the integer index in the list of values.
|
||||
</DL>
|
||||
|
||||
</DD></DL>
|
||||
<HR><BR><B>BINDINGS</B><BR><BR>
|
||||
|
||||
When Entry of the SpinBox has the input focus, it has the following bindings, in addition
|
||||
to the default Entry bindings:
|
||||
<UL>
|
||||
<LI>Page up set the value of the SpinBox to the last value.
|
||||
<LI>Page down set the value of the SpinBox to the first value.
|
||||
<LI>Arrow up set the value of the SpinBox to the next value.
|
||||
<LI>Arrow down set the value of the SpinBox to the previous value.
|
||||
</UL>
|
||||
|
||||
</BODY></HTML>
|
||||
107
hlp/en/bwidget/TitleFrame.html
Normal file
107
hlp/en/bwidget/TitleFrame.html
Normal file
@@ -0,0 +1,107 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>TitleFrame</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>TitleFrame</B>
|
||||
- Frame with a title
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>TitleFrame</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-font">-font</A></TR>
|
||||
<TD> <A HREF="options.htm#M-foreground">-foreground or -fg</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
<TD> <A HREF="options.htm#M-text">-text</A></TR>
|
||||
</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="#-baseline">-baseline</A></TR>
|
||||
<TD> <A HREF="#-ipad">-ipad</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-side">-side</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#cget"><B>cget</B></A>
|
||||
<I>option</I>
|
||||
</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="#getframe"><B>getframe</B></A>
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
TitleFrame enables user to create a frame with a title like XmFrame Motif widget.
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-baseline"><B>-baseline</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the vertical alignment of the title: <B>top</B>, <B>center</B> or <B>bottom</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-ipad"><B>-ipad</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a pad between the border of the frame and the user frame.
|
||||
The value is in screen units.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-side"><B>-side</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the horizontal alignment of the title: <B>left</B>, <B>center</B> or <B>right</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<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="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="getframe"><I>pathName</I> <B>getframe</B></A>
|
||||
</DT><DD>
|
||||
|
||||
Return the frame where the user can create any other widget.
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
696
hlp/en/bwidget/Tree.html
Normal file
696
hlp/en/bwidget/Tree.html
Normal file
@@ -0,0 +1,696 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>Tree</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>Tree</B>
|
||||
- Tree widget
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I>CREATION</I></DT>
|
||||
<DD><A HREF="#descr"><B>Tree</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 or -bg</A></TD>
|
||||
<TD> <A HREF="options.htm#M-borderwidth">-borderwidth or -bd</A></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-cursor">-cursor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-highlightbackground">-highlightbackground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-highlightcolor">-highlightcolor</A></TR>
|
||||
<TD> <A HREF="options.htm#M-highlightthickness">-highlightthickness</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-relief">-relief</A></TR>
|
||||
<TD> <A HREF="options.htm#M-selectbackground">-selectbackground</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-selectforeground">-selectforeground</A></TR>
|
||||
<TD> <A HREF="options.htm#M-takefocus">-takefocus</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="options.htm#M-xscrollcommand">-xscrollcommand</A></TR>
|
||||
<TD> <A HREF="options.htm#M-yscrollcommand">-yscrollcommand</A></TR>
|
||||
</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="#-closecmd">-closecmd</A></TR>
|
||||
<TD> <A HREF="#-deltax">-deltax</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-deltay">-deltay</A></TR>
|
||||
<TD> <A HREF="#-dragenabled">-dragenabled</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dragendcmd">-dragendcmd</A></TR>
|
||||
<TD> <A HREF="#-dragevent">-dragevent</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-draginitcmd">-draginitcmd</A></TR>
|
||||
<TD> <A HREF="#-dragtype">-dragtype</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dropcmd">-dropcmd</A></TR>
|
||||
<TD> <A HREF="#-dropenabled">-dropenabled</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-dropovercmd">-dropovercmd</A></TR>
|
||||
<TD> <A HREF="#-dropovermode">-dropovermode</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-droptypes">-droptypes</A></TR>
|
||||
<TD> <A HREF="#-height">-height</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-linesfill">-linesfill</A></TR>
|
||||
<TD> <A HREF="#-linestipple">-linestipple</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-opencmd">-opencmd</A></TR>
|
||||
<TD> <A HREF="#-padx">-padx</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-redraw">-redraw</A></TR>
|
||||
<TD> <A HREF="#-showlines">-showlines</A></TR>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> <A HREF="#-width">-width</A></TR>
|
||||
</TABLE></DD>
|
||||
</DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">WIDGET COMMAND</A></I></DT>
|
||||
<DD><I>pathName</I> <A HREF="#bindImage"><B>bindImage</B></A>
|
||||
<I>event</I>
|
||||
<I>script</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#bindText"><B>bindText</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="#closetree"><B>closetree</B></A>
|
||||
<I>node</I>
|
||||
</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>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#edit"><B>edit</B></A>
|
||||
<I>node</I>
|
||||
<I>text</I>
|
||||
?<I>verifycmd</I>?
|
||||
?<I>clickres</I>?
|
||||
?<I>select</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#exists"><B>exists</B></A>
|
||||
<I>node</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#index"><B>index</B></A>
|
||||
<I>node</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#insert"><B>insert</B></A>
|
||||
<I>index</I>
|
||||
<I>parent</I>
|
||||
<I>node</I>
|
||||
?<I>option value...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#itemcget"><B>itemcget</B></A>
|
||||
<I>node</I>
|
||||
<I>option</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#itemconfigure"><B>itemconfigure</B></A>
|
||||
<I>node</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>parent</I>
|
||||
<I>node</I>
|
||||
<I>index</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#nodes"><B>nodes</B></A>
|
||||
<I>node</I>
|
||||
?<I>first</I>?
|
||||
?<I>last</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#opentree"><B>opentree</B></A>
|
||||
<I>node</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#parent"><B>parent</B></A>
|
||||
<I>node</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#reorder"><B>reorder</B></A>
|
||||
<I>node</I>
|
||||
<I>neworder</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#see"><B>see</B></A>
|
||||
<I>node</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#selection"><B>selection</B></A>
|
||||
<I>cmd</I>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#visible"><B>visible</B></A>
|
||||
<I>node</I>
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#xview"><B>xview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD><I>pathName</I> <A HREF="#yview"><B>yview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
<B>Tree</B> widget uses canvas to display a hierarchical list of items (called nodes).
|
||||
Each node is composed of a label with its own font and foreground attributes, and an optional
|
||||
image or window. Each node can have a list of subnodes, which can be collapsed or expanded.
|
||||
Each node is drawn in a single line, whose height is defined by the
|
||||
<B>deltay</B> option, so they must have at most this height.
|
||||
A node is uniquely identified by a string given at creation (by the
|
||||
<B>insert</B> command). The node named <I>root</I> is the root of
|
||||
the tree and is not drawn.
|
||||
The tree structure is directly maintained by the widget.
|
||||
|
||||
</P>
|
||||
<BR><HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wso">WIDGET-SPECIFIC OPTIONS</A></B><BR>
|
||||
<DL><DT><A NAME="-closecmd"><B>-closecmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when user close a node. The
|
||||
closed node is appended to the command.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-deltax"><B>-deltax</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies horizontal indentation between a node and its children.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-deltay"><B>-deltay</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies vertical size of the nodes.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragenabled"><B>-dragenabled</B></A></DT>
|
||||
<DD>
|
||||
A boolean specifying if drag is enabled.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragendcmd"><B>-dragendcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when drag ended.
|
||||
<B>dragendcmd</B> must be a command conforming to the description of the
|
||||
option <B>dragendcmd</B> of <B>DragSite::<A HREF="DragSite.html#register">register</A></B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragevent"><B>-dragevent</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the number of the mouse button associated to the drag.
|
||||
Must be <B>1</B>, <B>2</B> or <B>3</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-draginitcmd"><B>-draginitcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Tree has a command wrapper for <I>drag-init</I> events. This command refused the drag
|
||||
if no node is designated. In other cases:
|
||||
<BR>If <B>draginitcmd</B> is empty, it returns:
|
||||
<UL>
|
||||
<LI>the value of option <B>dragtype</B> or <I>TREE_NODE</I> if empty as the data type,
|
||||
<LI><I>{copy move link}</I> as the operations,
|
||||
<LI>the node identifier as the data.
|
||||
</UL>
|
||||
If <B>draginitcmd</B> is not empty, it is called with the following arguments:
|
||||
<UL>
|
||||
<LI>the pathname of the tree,
|
||||
<LI>the identifier of the dragged node,
|
||||
<LI>the toplevel created to represent dragged data.
|
||||
</UL>
|
||||
and must return a value conforming to <B>draginitcmd</B> option described in
|
||||
<B>DragSite::<A HREF="DragSite.html#register">register</A></B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dragtype"><B>-dragtype</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an alternate type of dragged object.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropcmd"><B>-dropcmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Tree has a command wrapper for <I>drop</I> events. This command stops auto scrolling
|
||||
and extract node and position.
|
||||
<BR>If <B>dropcmd</B> is not empty, it is called with the following arguments:
|
||||
<UL>
|
||||
<LI>the pathname of the tree,
|
||||
<LI>the pathname of the drag source,
|
||||
<LI>a list describing where the drop occurs. It can be:
|
||||
<UL>
|
||||
<LI><I>{</I><B>widget</B><I>}</I>,
|
||||
<LI><I>{</I><B>node</B> <I>node}</I> or
|
||||
<LI><I>{</I><B>position</B> <I>node index}</I>.
|
||||
</UL>
|
||||
<LI>the current operation,
|
||||
<LI>the data type,
|
||||
<LI>the data.
|
||||
</UL>
|
||||
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropenabled"><B>-dropenabled</B></A></DT>
|
||||
<DD>
|
||||
A boolean specifying if drop is enabled.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropovercmd"><B>-dropovercmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Tree has a command wrapper for <I>drag-over</I> events. This command enables auto scrolling
|
||||
and position extraction during the <I>drag-over</I>.
|
||||
If <B>dropovercmd</B> is not empty, the command is called with the following aguments:
|
||||
<UL>
|
||||
<LI>the pathname of the tree,
|
||||
<LI>the pathname of the drag source,
|
||||
<LI>a list describing where the drop can occur, whose elements are:
|
||||
<UL>
|
||||
<LI>the string <I>widget</I> if <B>dropovertype</B> option contains <I>w</I>, else empty string.
|
||||
<LI>the targeted node if drag icon points a node and <B>dropovertype</B> option contains <I>n</I>, else empty string.
|
||||
<LI>a list containing a node and the position within the children of the node where drag
|
||||
icon points to if <B>dropovertype</B> option contains <I>p</I>, else empty string.
|
||||
<LI>optionally, the preferred method if drop can occur both inside a node and between two
|
||||
nodes. The value is <I>position</I> or <I>node</I>.
|
||||
</UL>
|
||||
<LI>the current operation,
|
||||
<LI>the data type,
|
||||
<LI>the data.
|
||||
</UL>
|
||||
The command must return a list with two elements:
|
||||
<UL>
|
||||
<LI>the drop status, conforming to those described in <B>dropovercmd</B> option of
|
||||
<B>DropSite::<A HREF="DropSite.html#register">register</A></B>,
|
||||
<LI>the choosen method: <I>widget</I>, <I>node</I> or <I>position</I>.
|
||||
</UL>
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-dropovermode"><B>-dropovermode</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the type of <I>drop-over</I> interaction. Must be a combination of
|
||||
<B>w</B>, which specifies that drop can occurs everywhere on widget,
|
||||
<B>p</B>, which specifies that drop can occurs between two nodes,
|
||||
and <B>n</B>, which specifies that drop occurs inside nodes.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-droptypes"><B>-droptypes</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a list of accepted dropped object/operation.
|
||||
See option <B>droptypes</B> of
|
||||
<B>DropSite::<A HREF="DropSite.html#register">register</A></B>.
|
||||
for more infromation.
|
||||
|
||||
<BR>Default is <I>TREE_NODE</I> with operations <B>copy</B> and <B>move</B>.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-height"><B>-height</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired height for the tree in units of <B>deltay</B> pixels.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-linesfill"><B>-linesfill</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a foreground color for the lines between nodes.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-linestipple"><B>-linestipple</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a stipple bitmap for the lines between nodes.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-opencmd"><B>-opencmd</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a command to be called when user open a node. The
|
||||
opened node is appended to the command.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-padx"><B>-padx</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies distance between image or window and text of the nodes.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-redraw"><B>-redraw</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies wether or not the tree should be redrawn when entering idle.
|
||||
Set it to false if you call <B>update</B> while modifying the tree.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-showlines"><B>-showlines</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies whether or not lines should be drawn between nodes.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="-width"><B>-width</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the desired width for the tree in units of 8 pixels.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">WIDGET COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="bindImage"><I>pathName</I> <B>bindImage</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 the image of a node.
|
||||
The node idenfier on which the event occurs is appended to the command.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="bindText"><I>pathName</I> <B>bindText</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 the label of a node.
|
||||
The node idenfier 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="closetree"><I>pathName</I> <B>closetree</B></A>
|
||||
<I>node</I>
|
||||
</DT><DD>
|
||||
|
||||
This command close all the subtree given by <I>node</I> (recurse
|
||||
through the tree starting at <I>node</I> and set <B>open</B> option to 0)
|
||||
|
||||
</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>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Deletes all nodes (and children of them) in <I>arg</I>. <I>arg</I> can be a list
|
||||
of nodes or a list of list of nodes.
|
||||
To delete all the tree, do <I>$pathName delete [$pathName nodes root]</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="edit"><I>pathName</I> <B>edit</B></A>
|
||||
<I>node</I>
|
||||
<I>text</I>
|
||||
?<I>verifycmd</I>?
|
||||
?<I>clickres</I>?
|
||||
?<I>select</I>?
|
||||
</DT><DD>
|
||||
|
||||
Provides a way for the user to edit in place the label of a node. This is
|
||||
possible only if <I>node</I> is visible (all its parents are open).
|
||||
<BR>The command takes the initial text as argument and does not modify the label of the
|
||||
edited node, but returns an empty string if edition is canceled, or the typed text
|
||||
if edition is accepted.
|
||||
<BR>When editing, the user can cancel by pressing Escape, or accept by pressing Return.
|
||||
<BR><I>clickres</I> specifies what to do if the user click outside the editable area.
|
||||
If <I>clickres</I> is 0 (the default), the edition is canceled.
|
||||
If <I>clickres</I> is 1, the edition is accepted.
|
||||
In all other case, the edition continues.
|
||||
<BR>If edition is accepted and <I>modifycmd</I> is not empty, then it is called with
|
||||
the new text as argument and must return 1 to accept the new text, 0 to refuse it
|
||||
and continue edition.
|
||||
<BR><I>select</I> specifies wether or not the initial text should be selected. Default is 1.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="exists"><I>pathName</I> <B>exists</B></A>
|
||||
<I>node</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns whether or not <I>node</I> exists in the tree.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="index"><I>pathName</I> <B>index</B></A>
|
||||
<I>node</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the position of <I>node</I> in its parent.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="insert"><I>pathName</I> <B>insert</B></A>
|
||||
<I>index</I>
|
||||
<I>parent</I>
|
||||
<I>node</I>
|
||||
?<I>option value...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Inserts a new node identified by <I>node</I> in the children list of <I>parent</I>
|
||||
at position <I>index</I>.
|
||||
|
||||
<P>
|
||||
<DL><DT><A NAME="Node-data"><B>-data</B></A></DT>
|
||||
<DD>
|
||||
|
||||
User data associated to the node.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Node-drawcross"><B>-drawcross</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies how the cross used to expand or collapse the children of a node
|
||||
should be drawn.
|
||||
Must be one of <B>auto</B>, <B>allways</B> or <B>never</B>.
|
||||
<BR>If <B>auto</B>, the cross is drawn only if the node has children.
|
||||
If <B>allways</B>, the cross is always drawn.
|
||||
If <B>never</B>, the cross is never drawn.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Node-fill"><B>-fill</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the foreground color of the label of the node.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Node-font"><B>-font</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a font for the label of the node.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Node-image"><B>-image</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies an image to display at the left of the label of the node.
|
||||
<B>window</B> option override <B>image</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Node-open"><B>-open</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies wether or not the children of the node should be drawn.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Node-text"><B>-text</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies the label of the node.
|
||||
|
||||
</DD>
|
||||
</DL>
|
||||
<DL><DT><A NAME="Node-window"><B>-window</B></A></DT>
|
||||
<DD>
|
||||
|
||||
Specifies a pathname to display at the left of the label of the node.
|
||||
<B>window</B> option override <B>image</B>.
|
||||
</DD>
|
||||
</DL>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="itemcget"><I>pathName</I> <B>itemcget</B></A>
|
||||
<I>node</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>node</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>parent</I>
|
||||
<I>node</I>
|
||||
<I>index</I>
|
||||
</DT><DD>
|
||||
|
||||
Moves <I>node</I> to the children list of <I>parent</I> at position <I>index</I>.
|
||||
<I>parent</I> can not be a descendant of <I>node</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="nodes"><I>pathName</I> <B>nodes</B></A>
|
||||
<I>node</I>
|
||||
?<I>first</I>?
|
||||
?<I>last</I>?
|
||||
</DT><DD>
|
||||
|
||||
Returns parts of the children of <I>node</I>, following <I>first</I> and <I>last</I>.<BR>
|
||||
If <I>first</I> and <I>last</I> are omitted, returns the list of all children.
|
||||
If <I>first</I> is specified and <I>last</I> omitted, returns the child 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 children 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="opentree"><I>pathName</I> <B>opentree</B></A>
|
||||
<I>node</I>
|
||||
</DT><DD>
|
||||
|
||||
This command open all the subtree given by <I>node</I> (recurse
|
||||
through the tree starting at <I>node</I> and set <B>open</B> option to 1)
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="parent"><I>pathName</I> <B>parent</B></A>
|
||||
<I>node</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the parent of <I>node</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="reorder"><I>pathName</I> <B>reorder</B></A>
|
||||
<I>node</I>
|
||||
<I>neworder</I>
|
||||
</DT><DD>
|
||||
|
||||
Modifies the order of children of <I>node</I> given by <I>neworder</I>. Children of
|
||||
<I>node</I> that do not appear in <I>neworder</I> are no moved.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="see"><I>pathName</I> <B>see</B></A>
|
||||
<I>node</I>
|
||||
</DT><DD>
|
||||
|
||||
Arrange the scrolling area to make <I>node</I> visible.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="selection"><I>pathName</I> <B>selection</B></A>
|
||||
<I>cmd</I>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Modifies the list of selected nodes following <I>cmd</I>:
|
||||
<DL>
|
||||
<DT><B>clear</B>
|
||||
<DD>remove all nodes of the selection.
|
||||
<DT><B>set</B>
|
||||
<DD>set the selection to all nodes in <I>arg</I>
|
||||
<DT><B>add</B>
|
||||
<DD>add all nodes of <I>arg</I> in the selection
|
||||
<DT><B>remove</B>
|
||||
<DD>remove all nodes of <I>arg</I> of the selection
|
||||
<DT><B>get</B>
|
||||
<DD>return the current selected nodes
|
||||
</DL>
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="visible"><I>pathName</I> <B>visible</B></A>
|
||||
<I>node</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns whether or not <I>node</I> is visible (all its parents are open).
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="xview"><I>pathName</I> <B>xview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Standard command to enable horizontal scrolling of <I>pathName</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="yview"><I>pathName</I> <B>yview</B></A>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
Standard command to enable vertical scrolling of <I>pathName</I>.
|
||||
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
409
hlp/en/bwidget/Widget.html
Normal file
409
hlp/en/bwidget/Widget.html
Normal file
@@ -0,0 +1,409 @@
|
||||
<HTML>
|
||||
<HEAD><TITLE>Widget</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<IMG SRC="constr.gif" WIDTH="40" HEIGHT="40"> Under construction ...<BR>
|
||||
<DL><DT><I><A HREF="#descr">NAME</A></I></DT>
|
||||
<DD><B>Widget</B>
|
||||
- The Widget base class
|
||||
</DD></DL>
|
||||
<DL>
|
||||
<DT><I><A HREF="#wc">COMMAND</A></I></DT>
|
||||
<DD>Widget::<A HREF="#addmap"><B>addmap</B></A>
|
||||
<I>class</I>
|
||||
<I>subclass</I>
|
||||
<I>subpath</I>
|
||||
<I>options</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#bwinclude"><B>bwinclude</B></A>
|
||||
<I>class</I>
|
||||
<I>subclass</I>
|
||||
<I>subpath</I>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#cget"><B>cget</B></A>
|
||||
<I>path</I>
|
||||
<I>option</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#configure"><B>configure</B></A>
|
||||
<I>path</I>
|
||||
<I>options</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#declare"><B>declare</B></A>
|
||||
<I>class</I>
|
||||
<I>optlist</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#destroy"><B>destroy</B></A>
|
||||
<I>path</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#focusNext"><B>focusNext</B></A>
|
||||
<I>w</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#focusOK"><B>focusOK</B></A>
|
||||
<I>w</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#focusPrev"><B>focusPrev</B></A>
|
||||
<I>w</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#generate-doc"><B>generate-doc</B></A>
|
||||
<I>dir</I>
|
||||
<I>widgetlist</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#generate-widget-doc"><B>generate-widget-doc</B></A>
|
||||
<I>class</I>
|
||||
<I>iscmd</I>
|
||||
<I>file</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#getoption"><B>getoption</B></A>
|
||||
<I>path</I>
|
||||
<I>option</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#hasChanged"><B>hasChanged</B></A>
|
||||
<I>path</I>
|
||||
<I>option</I>
|
||||
<I>pvalue</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#init"><B>init</B></A>
|
||||
<I>class</I>
|
||||
<I>path</I>
|
||||
<I>options</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#setoption"><B>setoption</B></A>
|
||||
<I>path</I>
|
||||
<I>option</I>
|
||||
<I>value</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#subcget"><B>subcget</B></A>
|
||||
<I>path</I>
|
||||
<I>subwidget</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#syncoptions"><B>syncoptions</B></A>
|
||||
<I>class</I>
|
||||
<I>subclass</I>
|
||||
<I>subpath</I>
|
||||
<I>options</I>
|
||||
</DD>
|
||||
<DD>Widget::<A HREF="#tkinclude"><B>tkinclude</B></A>
|
||||
<I>class</I>
|
||||
<I>tkwidget</I>
|
||||
<I>subpath</I>
|
||||
?<I>arg...</I>?
|
||||
</DD>
|
||||
</DL>
|
||||
<BR><HR WIDTH="100%"><BR>
|
||||
<B><A NAME="descr"></A>DESCRIPTION</B><BR>
|
||||
<P>
|
||||
|
||||
The <B>Widget</B> namespace handle data associated to all BWidget and provide commands
|
||||
to easily define BWidget.
|
||||
<BR>For commands can be used to define a BWidget:
|
||||
<B>tkinclude</B>, <B>bwinclude</B>, <B>declare</B>, <B>addmap</B> and <B>syncoptions</B>.
|
||||
Here is the definition of <A HREF="ComboBox.html">ComboBox</A> widget:
|
||||
<BR><BR>
|
||||
<CENTER>
|
||||
<TABLE BORDER=2 CELSPACING=2 WIDTH=80%>
|
||||
<TR><TD><PRE>
|
||||
namespace eval ComboBox {
|
||||
<FONT COLOR=red><I># We're using ArrowButton, Entry and LabelFrame</I></FONT>
|
||||
ArrowButton::use
|
||||
Entry::use
|
||||
LabelFrame::use
|
||||
|
||||
<FONT COLOR=red><I># Include resources of LabelFrame</I></FONT>
|
||||
Widget::bwinclude ComboBox LabelFrame .labf \
|
||||
rename {-text -label} \
|
||||
remove {-focus} \
|
||||
prefix {label -justify -width -anchor -height -font} \
|
||||
initialize {-relief sunken -borderwidth 2}
|
||||
|
||||
<FONT COLOR=red><I># Include resources of Entry</I></FONT>
|
||||
Widget::bwinclude ComboBox Entry .e \
|
||||
remove {-relief -bd -borderwidth -bg -fg} \
|
||||
rename {-foreground -entryfg -background -entrybg}
|
||||
|
||||
<FONT COLOR=red><I># Declare new resources</I></FONT>
|
||||
Widget::declare ComboBox {
|
||||
{-height TkResource 0 0 listbox}
|
||||
{-values String "" 0}
|
||||
{-modifycmd String "" 0}
|
||||
{-postcommand String "" 0}
|
||||
}
|
||||
|
||||
<FONT COLOR=red><I># Map resources to subwidget</I></FONT>
|
||||
Widget::addmap ComboBox "" :cmd {-background {}}
|
||||
Widget::addmap ComboBox ArrowButton .a \
|
||||
{-foreground {} -background {} -disabledforeground {} -state {}}
|
||||
|
||||
<FONT COLOR=red><I># Synchronize subwidget options</I></FONT>
|
||||
Widget::syncoptions ComboBox Entry .e {-text {}}
|
||||
Widget::syncoptions ComboBox LabelFrame .labf {-label -text -underline {}}
|
||||
|
||||
proc use {} {}
|
||||
}</PRE>
|
||||
</TD></TR>
|
||||
</TABLE></CENTER>
|
||||
|
||||
</P>
|
||||
<HR WIDTH="50%"><BR>
|
||||
<B><A NAME="wc">COMMAND</A></B><BR>
|
||||
<DL><DT><A NAME="addmap">Widget::<B>addmap</B></A>
|
||||
<I>class</I>
|
||||
<I>subclass</I>
|
||||
<I>subpath</I>
|
||||
<I>options</I>
|
||||
</DT><DD>
|
||||
|
||||
This command map some resources to subwidget.
|
||||
Mapped resources automatically configure subwidget when widget is configured.
|
||||
<UL>
|
||||
<LI><I>class</I> is the class of the new BWidget
|
||||
<LI><I>subclass</I> is the class the subwidget (BWidget class, e.g Entry, or empty for Tk widget)
|
||||
<LI><I>subpath</I> is the path of the subwidget
|
||||
<LI><I>options</I> is the list <I>{option realres ...}</I> of options to map to subwidget
|
||||
</UL>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="bwinclude">Widget::<B>bwinclude</B></A>
|
||||
<I>class</I>
|
||||
<I>subclass</I>
|
||||
<I>subpath</I>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command includes into a new BWidget the resources of another BWidget.
|
||||
Arguments are:
|
||||
<UL>
|
||||
<LI><I>class</I> class of the new widget
|
||||
<LI><I>subclass</I> class name of the BWidget to be included
|
||||
<LI><I>subpath</I> path of the widget to configure when BWidget is configured
|
||||
<LI><I>options</I> is:
|
||||
<UL>
|
||||
<LI><I><B>include</B> {option option ...}</I>
|
||||
<BR>list of options to include (all if not defined)
|
||||
<LI><I><B>remove</B> {option option ...}</I>
|
||||
<BR> list of options to remove
|
||||
<LI><I><B>rename</B> {option name option name ...}</I>
|
||||
<BR>list of options to rename
|
||||
<LI><I><B>prefix</B> {prefix option option ...}</I>
|
||||
<BR>pefix all <I>option</I> by <I>prefix</I>
|
||||
<LI><I><B>initialize</B> {option value option value ...}</I>
|
||||
<BR>default value of options
|
||||
<LI><I><B>readonly</B> {option value option value ...}</I>
|
||||
<BR>new readonly flag
|
||||
</UL></UL>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="cget">Widget::<B>cget</B></A>
|
||||
<I>path</I>
|
||||
<I>option</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the value of <I>option</I> of BWidget <I>path</I>. <B>cget</B> tests the option
|
||||
existence and takes care of synchronization with subwidget.
|
||||
Typically called by the BWidget <B>cget</B> command.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="configure">Widget::<B>configure</B></A>
|
||||
<I>path</I>
|
||||
<I>options</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="declare">Widget::<B>declare</B></A>
|
||||
<I>class</I>
|
||||
<I>optlist</I>
|
||||
</DT><DD>
|
||||
|
||||
This command declare new resources for a BWidget.
|
||||
<UL>
|
||||
<LI><I>class</I> is class of the new widget
|
||||
<LI><I>options</I> is the list describing new options. Each new option is a list
|
||||
<B>{option type value ro ?args?}</B> where:
|
||||
<UL>
|
||||
<LI><I>option</I> is the name of the option
|
||||
<LI><I>type</I> is the type of the option
|
||||
<LI><I>value</I> is the default value of the option
|
||||
<LI><I>ro</I> is the readonly flag of the option
|
||||
<LI><I>args</I> depends on type
|
||||
</UL></UL>
|
||||
<BR>
|
||||
<I>type</I> can be:
|
||||
<BR>
|
||||
<DL>
|
||||
<DT><B>TkResource</B></DT>
|
||||
<DD>
|
||||
<I>value</I> of <I>option</I> denotes a resource of a Tk widget. <I>args</I> must be <I>class</I> or
|
||||
<I>{class realoption}</I>. <I>class</I> is the creation command of the Tk widget, e.g.
|
||||
<B>entry</B>.
|
||||
The second form must be used if <I>option</I> has not the same name in Tk widget,
|
||||
but <I>realoption</I>.
|
||||
<BR>If <I>value</I> is empty, it is initialized to the default value of the Tk widget.
|
||||
</DD>
|
||||
|
||||
<DT><B>BwResource</B></DT>
|
||||
<DD>
|
||||
<I>value</I> of <I>option</I> denotes a resource of a BWidget. <I>args</I> must be <I>class</I> or
|
||||
<I>{class realoption}</I>. <I>class</I> is the name of the namespace of the BWidget, e.g.
|
||||
<B>LabelFrame</B>.
|
||||
The second form must be used if <I>option</I> has not the same name in BWidget,
|
||||
but <I>realoption</I>.
|
||||
<BR>If <I>value</I> is empty, it is initialized to the default value of the BWidget.
|
||||
</DD>
|
||||
|
||||
<DT><B>Int</B></DT>
|
||||
<DD><I>value</I> of <I>option</I> is an integer.
|
||||
<I>args</I> can be <I>{?min? ?max?}</I> to force it to be in a range. The test is
|
||||
<I>[expr $option>$min] && [expr $option<$max]</I> so
|
||||
if args is <I>{0 10}</I>, value must be beetween 0 and 10 exclude,
|
||||
if <I>args</I> is <I>{=0 =10}</I> , value must be beetween 0 and 10 include.
|
||||
</DD>
|
||||
|
||||
<DT><B>Boolean</B></DT>
|
||||
<DD><I>value</I> of <I>option</I> is a boolean. True values can be <B>1</B>, <B>true</B> or <B>yes</B>.
|
||||
False values can be <B>0</B>, <B>false</B> or <B>no</B>. <B>Widget::cget</B> always return
|
||||
0 or 1.
|
||||
</DD>
|
||||
|
||||
<DT><B>Enum</B></DT>
|
||||
<DD>
|
||||
<I>value</I> of <I>option</I> is a element of a enumeration. <I>args</I> must be the list
|
||||
of enumeration, e.g. <I>{top left bottom right}</I>.
|
||||
</DD>
|
||||
|
||||
<DT><B>Flag</B></DT>
|
||||
<DD>
|
||||
<I>value</I> of <I>option</I> is a combination of a set of chars. <I>args</I> must be a
|
||||
string defining the set.
|
||||
</DD>
|
||||
|
||||
<DT><B>String</B></DT>
|
||||
<DD>
|
||||
<DD><I>value</I> of <I>option</I> is any uncontrolled string.
|
||||
</DD>
|
||||
|
||||
<DT><B>Synonym</B></DT>
|
||||
<DD>
|
||||
<DD><I>option</I> is a synonym of option <I>args</I>. <I>value</I> has no effect here.
|
||||
</DD>
|
||||
|
||||
</DL>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="destroy">Widget::<B>destroy</B></A>
|
||||
<I>path</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="focusNext">Widget::<B>focusNext</B></A>
|
||||
<I>w</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="focusOK">Widget::<B>focusOK</B></A>
|
||||
<I>w</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="focusPrev">Widget::<B>focusPrev</B></A>
|
||||
<I>w</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="generate-doc">Widget::<B>generate-doc</B></A>
|
||||
<I>dir</I>
|
||||
<I>widgetlist</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="generate-widget-doc">Widget::<B>generate-widget-doc</B></A>
|
||||
<I>class</I>
|
||||
<I>iscmd</I>
|
||||
<I>file</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="getoption">Widget::<B>getoption</B></A>
|
||||
<I>path</I>
|
||||
<I>option</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the value of <I>option</I> of BWidget <I>path</I>. This command does not test
|
||||
option existence, does not handle synonym and does not take care of synchronization with
|
||||
subwidget.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="hasChanged">Widget::<B>hasChanged</B></A>
|
||||
<I>path</I>
|
||||
<I>option</I>
|
||||
<I>pvalue</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="init">Widget::<B>init</B></A>
|
||||
<I>class</I>
|
||||
<I>path</I>
|
||||
<I>options</I>
|
||||
</DT><DD>
|
||||
Description text
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="setoption">Widget::<B>setoption</B></A>
|
||||
<I>path</I>
|
||||
<I>option</I>
|
||||
<I>value</I>
|
||||
</DT><DD>
|
||||
|
||||
Set the value of <I>option</I> of BWidget <I>path</I> without option test, subwidget mapping,
|
||||
synonym handling and does not set the modification flag.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="subcget">Widget::<B>subcget</B></A>
|
||||
<I>path</I>
|
||||
<I>subwidget</I>
|
||||
</DT><DD>
|
||||
|
||||
Returns the list of all option/value of BWidget <I>path</I> that are mapped to <I>subwidget</I>.
|
||||
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="syncoptions">Widget::<B>syncoptions</B></A>
|
||||
<I>class</I>
|
||||
<I>subclass</I>
|
||||
<I>subpath</I>
|
||||
<I>options</I>
|
||||
</DT><DD>
|
||||
|
||||
This command synchronize options value of a subwidget.
|
||||
Used when an option of a subwidget is modified out of the BWidget <B>configure</B> command.
|
||||
<UL>
|
||||
<LI><I>class</I> is the class of the new BWidget
|
||||
<LI><I>subclass</I> is the class the subwidget (BWidget class, e.g Entry, or empty for Tk widget)
|
||||
<LI><I>subpath</I> is the path of the subwidget
|
||||
<LI><I>options</I> is the list <I>{option realres ...}</I> of options to synchronize
|
||||
with subwidget
|
||||
</UL>
|
||||
</DD></DL>
|
||||
<DL><DT><A NAME="tkinclude">Widget::<B>tkinclude</B></A>
|
||||
<I>class</I>
|
||||
<I>tkwidget</I>
|
||||
<I>subpath</I>
|
||||
?<I>arg...</I>?
|
||||
</DT><DD>
|
||||
|
||||
This command includes into a new BWidget the resources of a Tk widget.
|
||||
Arguments are:
|
||||
<UL>
|
||||
<LI><I>class</I> class of the new widget
|
||||
<LI><I>tkwidger</I> command name of the Tk widget to be included
|
||||
<LI><I>subpath</I> path of the widget to configure when BWidget is configured
|
||||
<LI><I>options</I> is:
|
||||
<UL>
|
||||
<LI><I><B>include</B> {option option ...}</I>
|
||||
<BR>list of options to include (all if not defined)
|
||||
<LI><I><B>remove</B> {option option ...}</I>
|
||||
<BR>list of options to remove
|
||||
<LI><I><B>rename</B> {option name option name ...}</I>
|
||||
<BR>list of options to rename
|
||||
<LI><I><B>prefix</B> {prefix option option ...}</I>
|
||||
<BR>pefix all <I>option</I> by <I>prefix</I>
|
||||
<LI><I><B>initialize</B> {option value option value ...}</I>
|
||||
<BR>default value of options
|
||||
<LI><I><B>readonly</B> {option value option value ...}</I>
|
||||
<BR>new readonly flag
|
||||
</UL></UL>
|
||||
</DD></DL>
|
||||
</BODY></HTML>
|
||||
34
hlp/en/bwidget/bw.toc.html
Normal file
34
hlp/en/bwidget/bw.toc.html
Normal file
@@ -0,0 +1,34 @@
|
||||
<title>BWidget</title>
|
||||
<a href="Label.html">Label</a><br>
|
||||
<a href="Entry.html">Entry</a><br>
|
||||
<a href="Button.html">Button</a><br>
|
||||
<a href="ArrowButton.html">ArrowButton</a><br>
|
||||
<a href="ProgressBar.html">ProgressBar</a><br>
|
||||
<a href="ScrollView.html">ScrollView</a><br>
|
||||
<a href="Separator.html">Separator</a><br>
|
||||
<a href="MainFrame.html">MainFrame</a><br>
|
||||
<a href="LabelFrame.html">LabelFrame</a><br>
|
||||
<a href="TitleFrame.html">TitleFrame</a><br>
|
||||
<a href="ScrolledWindow.html">ScrolledWindow</a><br>
|
||||
<a href="ScrollableFrame.html">ScrollableFrame</a><br>
|
||||
<a href="PanedWindow.html">PanedWindow</a><br>
|
||||
<a href="ButtonBox.html">ButtonBox</a><br>
|
||||
<a href="PagesManager.html">PagesManager</a><br>
|
||||
<a href="NoteBook.html">NoteBook</a><br>
|
||||
<a href="Dialog.html">Dialog</a><br>
|
||||
<a href="LabelEntry.html">LabelEntry</a><br>
|
||||
<a href="ComboBox.html">ComboBox</a><br>
|
||||
<a href="SpinBox.html">SpinBox</a><br>
|
||||
<a href="Tree.html">Tree</a><br>
|
||||
<a href="ListBox.html">ListBox</a><br>
|
||||
<a href="MessageDlg.html">MessageDlg</a><br>
|
||||
<a href="ProgressDlg.html">ProgressDlg</a><br>
|
||||
<a href="PasswdDlg.html">PasswdDlg</a><br>
|
||||
<a href="SelectFont.html">SelectFont</a><br>
|
||||
<a href="SelectColor.html">SelectColor</a><br>
|
||||
<a href="Widget.html">Widget</a><br>
|
||||
<a href="DynamicHelp.html">DynamicHelp</a><br>
|
||||
<a href="DragSite.html">DragSite</a><br>
|
||||
<a href="DropSite.html">DropSite</a><br>
|
||||
<a href="BWidget.html">BWidget</a><br>
|
||||
|
||||
39
hlp/en/bwidget/navtree.html
Normal file
39
hlp/en/bwidget/navtree.html
Normal file
@@ -0,0 +1,39 @@
|
||||
<HTML><BODY BGCOLOR=white>
|
||||
<FONT SIZE=1><STRONG><A HREF="contents.html" TARGET=Manual>Brief description</A></STRONG></FONT><BR>
|
||||
<FONT SIZE=1><STRONG>Simple Widgets</STRONG></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="Label.html" TARGET=Manual>Label</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="Entry.html" TARGET=Manual>Entry</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="Button.html" TARGET=Manual>Button</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ArrowButton.html" TARGET=Manual>ArrowButton</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ProgressBar.html" TARGET=Manual>ProgressBar</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ScrollView.html" TARGET=Manual>ScrollView</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="Separator.html" TARGET=Manual>Separator</A></FONT><BR>
|
||||
<FONT SIZE=1><STRONG>Manager Widgets</STRONG></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="MainFrame.html" TARGET=Manual>MainFrame</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="LabelFrame.html" TARGET=Manual>LabelFrame</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="TitleFrame.html" TARGET=Manual>TitleFrame</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ScrolledWindow.html" TARGET=Manual>ScrolledWindow</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ScrollableFrame.html" TARGET=Manual>ScrollableFrame</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="PanedWindow.html" TARGET=Manual>PanedWindow</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ButtonBox.html" TARGET=Manual>ButtonBox</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="PagesManager.html" TARGET=Manual>PagesManager</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="NoteBook.html" TARGET=Manual>NoteBook</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="Dialog.html" TARGET=Manual>Dialog</A></FONT><BR>
|
||||
<FONT SIZE=1><STRONG>Composite Widgets</STRONG></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="LabelEntry.html" TARGET=Manual>LabelEntry</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ComboBox.html" TARGET=Manual>ComboBox</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="SpinBox.html" TARGET=Manual>SpinBox</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="Tree.html" TARGET=Manual>Tree</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ListBox.html" TARGET=Manual>ListBox</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="MessageDlg.html" TARGET=Manual>MessageDlg</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="ProgressDlg.html" TARGET=Manual>ProgressDlg</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="PasswdDlg.html" TARGET=Manual>PasswdDlg</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="SelectFont.html" TARGET=Manual>SelectFont</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="SelectColor.html" TARGET=Manual>SelectColor</A></FONT><BR>
|
||||
<FONT SIZE=1><STRONG>Commands Classes</STRONG></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="Widget.html" TARGET=Manual>Widget</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="DynamicHelp.html" TARGET=Manual>DynamicHelp</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="DragSite.html" TARGET=Manual>DragSite</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="DropSite.html" TARGET=Manual>DropSite</A></FONT><BR>
|
||||
<FONT SIZE=1><A HREF="BWidget.html" TARGET=Manual>BWidget</A></FONT><BR>
|
||||
</BODY></HTML>
|
||||
449
hlp/en/bwidget/options.htm
Normal file
449
hlp/en/bwidget/options.htm
Normal file
@@ -0,0 +1,449 @@
|
||||
<HTML><HEAD><TITLE>Tk Built-In Commands - options manual page</TITLE></HEAD>
|
||||
<BODY BGCOLOR=white>
|
||||
<DL>
|
||||
<DD><A HREF="options.htm#M2" NAME="L2">NAME</A>
|
||||
<DL><DD>options - Standard options supported by widgets</DL>
|
||||
<DD><A HREF="options.htm#M3" NAME="L3">DESCRIPTION</A>
|
||||
<DL>
|
||||
<DD><A HREF="options.htm#M-activebackground" NAME="L4">-activebackground, activeBackground, Foreground</A>
|
||||
<DD><A HREF="options.htm#M-activeborderwidth" NAME="L5">-activeborderwidth, activeBorderWidth, BorderWidth</A>
|
||||
<DD><A HREF="options.htm#M-activeforeground" NAME="L6">-activeforeground, activeForeground, Background</A>
|
||||
<DD><A HREF="options.htm#M-anchor" NAME="L7">-anchor, anchor, Anchor</A>
|
||||
<DD><A HREF="options.htm#M-background" NAME="L8">-background or -bg, background, Background</A>
|
||||
<DD><A HREF="options.htm#M-bitmap" NAME="L9">-bitmap, bitmap, Bitmap</A>
|
||||
<DD><A HREF="options.htm#M-borderwidth" NAME="L10">-borderwidth or -bd, borderWidth, BorderWidth</A>
|
||||
<DD><A HREF="options.htm#M-cursor" NAME="L11">-cursor, cursor, Cursor</A>
|
||||
<DD><A HREF="options.htm#M-disabledforeground" NAME="L12">-disabledforeground, disabledForeground, DisabledForeground</A>
|
||||
<DD><A HREF="options.htm#M-exportselection" NAME="L13">-exportselection, exportSelection, ExportSelection</A>
|
||||
<DD><A HREF="options.htm#M-font" NAME="L14">-font, font, Font</A>
|
||||
<DD><A HREF="options.htm#M-foreground" NAME="L15">-foreground or -fg, foreground, Foreground</A>
|
||||
<DD><A HREF="options.htm#M-highlightbackground" NAME="L16">-highlightbackground, highlightBackground, HighlightBackground</A>
|
||||
<DD><A HREF="options.htm#M-highlightcolor" NAME="L17">-highlightcolor, highlightColor, HighlightColor</A>
|
||||
<DD><A HREF="options.htm#M-highlightthickness" NAME="L18">-highlightthickness, highlightThickness, HighlightThickness</A>
|
||||
<DD><A HREF="options.htm#M-image" NAME="L19">-image, image, Image</A>
|
||||
<DD><A HREF="options.htm#M-insertbackground" NAME="L20">-insertbackground, insertBackground, Foreground</A>
|
||||
<DD><A HREF="options.htm#M-insertborderwidth" NAME="L21">-insertborderwidth, insertBorderWidth, BorderWidth</A>
|
||||
<DD><A HREF="options.htm#M-insertofftime" NAME="L22">-insertofftime, insertOffTime, OffTime</A>
|
||||
<DD><A HREF="options.htm#M-insertontime" NAME="L23">-insertontime, insertOnTime, OnTime</A>
|
||||
<DD><A HREF="options.htm#M-insertwidth" NAME="L24">-insertwidth, insertWidth, InsertWidth</A>
|
||||
<DD><A HREF="options.htm#M-jump" NAME="L25">-jump, jump, Jump</A>
|
||||
<DD><A HREF="options.htm#M-justify" NAME="L26">-justify, justify, Justify</A>
|
||||
<DD><A HREF="options.htm#M-orient" NAME="L27">-orient, orient, Orient</A>
|
||||
<DD><A HREF="options.htm#M-padx" NAME="L28">-padx, padX, Pad</A>
|
||||
<DD><A HREF="options.htm#M-pady" NAME="L29">-pady, padY, Pad</A>
|
||||
<DD><A HREF="options.htm#M-relief" NAME="L30">-relief, relief, Relief</A>
|
||||
<DD><A HREF="options.htm#M-repeatdelay" NAME="L31">-repeatdelay, repeatDelay, RepeatDelay</A>
|
||||
<DD><A HREF="options.htm#M-repeatinterval" NAME="L32">-repeatinterval, repeatInterval, RepeatInterval</A>
|
||||
<DD><A HREF="options.htm#M-selectbackground" NAME="L33">-selectbackground, selectBackground, Foreground</A>
|
||||
<DD><A HREF="options.htm#M-selectborderwidth" NAME="L34">-selectborderwidth, selectBorderWidth, BorderWidth</A>
|
||||
<DD><A HREF="options.htm#M-selectforeground" NAME="L35">-selectforeground, selectForeground, Background</A>
|
||||
<DD><A HREF="options.htm#M-setgrid" NAME="L36">-setgrid, setGrid, SetGrid</A>
|
||||
<DD><A HREF="options.htm#M-takefocus" NAME="L37">-takefocus, takeFocus, TakeFocus</A>
|
||||
<DD><A HREF="options.htm#M-text" NAME="L38">-text, text, Text</A>
|
||||
<DD><A HREF="options.htm#M-textvariable" NAME="L39">-textvariable, textVariable, Variable</A>
|
||||
<DD><A HREF="options.htm#M-troughcolor" NAME="L40">-troughcolor, troughColor, Background</A>
|
||||
<DD><A HREF="options.htm#M-underline" NAME="L41">-underline, underline, Underline</A>
|
||||
<DD><A HREF="options.htm#M-wraplength" NAME="L42">-wraplength, wrapLength, WrapLength</A>
|
||||
<DD><A HREF="options.htm#M-xscrollcommand" NAME="L43">-xscrollcommand, xScrollCommand, ScrollCommand</A>
|
||||
<DD><A HREF="options.htm#M-yscrollcommand" NAME="L44">-yscrollcommand, yScrollCommand, ScrollCommand</A>
|
||||
</DL>
|
||||
<DD><A HREF="options.htm#M4" NAME="L45">KEYWORDS</A>
|
||||
</DL><HR>
|
||||
<H3><A NAME="M2">NAME</A></H3>
|
||||
options - Standard options supported by widgets
|
||||
<H3><A NAME="M3">DESCRIPTION</A></H3>
|
||||
This manual entry describes the common configuration options supported
|
||||
by widgets in the Tk toolkit. Every widget does not necessarily support
|
||||
every option (see the manual entries for individual widgets for a list
|
||||
of the standard options supported by that widget), but if a widget does
|
||||
support an option with one of the names listed below, then the option
|
||||
has exactly the effect described below.
|
||||
<P>
|
||||
In the descriptions below, ``Command-Line Name'' refers to the
|
||||
switch used in class commands and <B>configure</B> widget commands to
|
||||
set this value. For example, if an option's command-line switch is
|
||||
<B>-foreground</B> and there exists a widget <B>.a.b.c</B>, then the
|
||||
command
|
||||
<PRE><B>.a.b.c configure -foreground black</B></PRE>
|
||||
may be used to specify the value <B>black</B> for the option in the
|
||||
the widget <B>.a.b.c</B>. Command-line switches may be abbreviated,
|
||||
as long as the abbreviation is unambiguous.
|
||||
``Database Name'' refers to the option's name in the option database (e.g.
|
||||
in .Xdefaults files). ``Database Class'' refers to the option's class value
|
||||
in the option database.
|
||||
<DL>
|
||||
<DT>Command-Line Name: <B><A NAME="M-activebackground">-activebackground</A></B>
|
||||
<DT>Database Name: <B>activeBackground</B>
|
||||
<DT>Database Class: <B>Foreground</B>
|
||||
<DD>Specifies background color to use when drawing active elements.
|
||||
An element (a widget or portion of a widget) is active if the
|
||||
mouse cursor is positioned over the element and pressing a mouse button
|
||||
will cause some action to occur.
|
||||
If strict Motif compliance has been requested by setting the
|
||||
<B>tk_strictMotif</B> variable, this option will normally be
|
||||
ignored; the normal background color will be used instead.
|
||||
For some elements on Windows and Macintosh systems, the active color
|
||||
will only be used while mouse button 1 is pressed over the element.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-activeborderwidth">-activeborderwidth</A></B>
|
||||
<DT>Database Name: <B>activeBorderWidth</B>
|
||||
<DT>Database Class: <B>BorderWidth</B>
|
||||
<DD>Specifies a non-negative value indicating
|
||||
the width of the 3-D border drawn around active elements. See above for
|
||||
definition of active elements.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
||||
This option is typically only available in widgets displaying more
|
||||
than one element at a time (e.g. menus but not buttons).
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-activeforeground">-activeforeground</A></B>
|
||||
<DT>Database Name: <B>activeForeground</B>
|
||||
<DT>Database Class: <B>Background</B>
|
||||
<DD>Specifies foreground color to use when drawing active elements.
|
||||
See above for definition of active elements.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-anchor">-anchor</A></B>
|
||||
<DT>Database Name: <B>anchor</B>
|
||||
<DT>Database Class: <B>Anchor</B>
|
||||
<DD>Specifies how the information in a widget (e.g. text or a bitmap)
|
||||
is to be displayed in the widget.
|
||||
Must be one of the values <B>n</B>, <B>ne</B>, <B>e</B>, <B>se</B>,
|
||||
<B>s</B>, <B>sw</B>, <B>w</B>, <B>nw</B>, or <B>center</B>.
|
||||
For example, <B>nw</B> means display the information such that its
|
||||
top-left corner is at the top-left corner of the widget.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-background">-background or -bg</A></B>
|
||||
<DT>Database Name: <B>background</B>
|
||||
<DT>Database Class: <B>Background</B>
|
||||
<DD>Specifies the normal background color to use when displaying the
|
||||
widget.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-bitmap">-bitmap</A></B>
|
||||
<DT>Database Name: <B>bitmap</B>
|
||||
<DT>Database Class: <B>Bitmap</B>
|
||||
<DD>Specifies a bitmap to display in the widget, in any of the forms
|
||||
acceptable to <B><A HREF="../TkLib/GetBitmap.htm">Tk_GetBitmap</A></B>.
|
||||
The exact way in which the bitmap is displayed may be affected by
|
||||
other options such as <B>anchor</B> or <B>justify</B>.
|
||||
Typically, if this option is specified then it overrides other
|
||||
options that specify a textual value to display in the widget;
|
||||
the <B>bitmap</B> option may be reset to an empty string to re-enable
|
||||
a text display.
|
||||
In widgets that support both <B>bitmap</B> and <B>image</B> options,
|
||||
<B>image</B> will usually override <B>bitmap</B>.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-borderwidth">-borderwidth or -bd</A></B>
|
||||
<DT>Database Name: <B>borderWidth</B>
|
||||
<DT>Database Class: <B>BorderWidth</B>
|
||||
<DD>Specifies a non-negative value indicating the width
|
||||
of the 3-D border to draw around the outside of the widget (if such a
|
||||
border is being drawn; the <B>relief</B> option typically determines
|
||||
this). The value may also be used when drawing 3-D effects in the
|
||||
interior of the widget.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-cursor">-cursor</A></B>
|
||||
<DT>Database Name: <B>cursor</B>
|
||||
<DT>Database Class: <B>Cursor</B>
|
||||
<DD>Specifies the mouse cursor to be used for the widget.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetCursor.htm">Tk_GetCursor</A></B>.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-disabledforeground">-disabledforeground</A></B>
|
||||
<DT>Database Name: <B>disabledForeground</B>
|
||||
<DT>Database Class: <B>DisabledForeground</B>
|
||||
<DD>Specifies foreground color to use when drawing a disabled element.
|
||||
If the option is specified as an empty string (which is typically the
|
||||
case on monochrome displays), disabled elements are drawn with the
|
||||
normal foreground color but they are dimmed by drawing them
|
||||
with a stippled fill pattern.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-exportselection">-exportselection</A></B>
|
||||
<DT>Database Name: <B>exportSelection</B>
|
||||
<DT>Database Class: <B>ExportSelection</B>
|
||||
<DD>Specifies whether or not a selection in the widget should also be
|
||||
the X selection.
|
||||
The value may have any of the forms accepted by <B><A HREF="../TclLib/GetInt.htm">Tcl_GetBoolean</A></B>,
|
||||
such as <B>true</B>, <B>false</B>, <B>0</B>, <B>1</B>, <B>yes</B>, or <B>no</B>.
|
||||
If the selection is exported, then selecting in the widget deselects
|
||||
the current X selection, selecting outside the widget deselects any
|
||||
widget selection, and the widget will respond to selection retrieval
|
||||
requests when it has a selection. The default is usually for widgets
|
||||
to export selections.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-font">-font</A></B>
|
||||
<DT>Database Name: <B><A HREF="../TkCmd/font.htm">font</A></B>
|
||||
<DT>Database Class: <B><A HREF="../TkCmd/font.htm">Font</A></B>
|
||||
<DD>Specifies the font to use when drawing text inside the widget.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-foreground">-foreground or -fg</A></B>
|
||||
<DT>Database Name: <B>foreground</B>
|
||||
<DT>Database Class: <B>Foreground</B>
|
||||
<DD>Specifies the normal foreground color to use when displaying the widget.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-highlightbackground">-highlightbackground</A></B>
|
||||
<DT>Database Name: <B>highlightBackground</B>
|
||||
<DT>Database Class: <B>HighlightBackground</B>
|
||||
<DD>Specifies the color to display in the traversal highlight region when
|
||||
the widget does not have the input focus.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-highlightcolor">-highlightcolor</A></B>
|
||||
<DT>Database Name: <B>highlightColor</B>
|
||||
<DT>Database Class: <B>HighlightColor</B>
|
||||
<DD>Specifies the color to use for the traversal highlight rectangle that is
|
||||
drawn around the widget when it has the input focus.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-highlightthickness">-highlightthickness</A></B>
|
||||
<DT>Database Name: <B>highlightThickness</B>
|
||||
<DT>Database Class: <B>HighlightThickness</B>
|
||||
<DD>Specifies a non-negative value indicating the width of the highlight
|
||||
rectangle to draw around the outside of the widget when it has the
|
||||
input focus.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
||||
If the value is zero, no focus highlight is drawn around the widget.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-image">-image</A></B>
|
||||
<DT>Database Name: <B>image</B>
|
||||
<DT>Database Class: <B>Image</B>
|
||||
<DD>Specifies an image to display in the widget, which must have been
|
||||
created with the <B><A HREF="../TkCmd/image.htm">image create</A></B> command.
|
||||
Typically, if the <B>image</B> option is specified then it overrides other
|
||||
options that specify a bitmap or textual value to display in the widget;
|
||||
the <B>image</B> option may be reset to an empty string to re-enable
|
||||
a bitmap or text display.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-insertbackground">-insertbackground</A></B>
|
||||
<DT>Database Name: <B>insertBackground</B>
|
||||
<DT>Database Class: <B>Foreground</B>
|
||||
<DD>Specifies the color to use as background in the area covered by the
|
||||
insertion cursor. This color will normally override either the normal
|
||||
background for the widget (or the selection background if the insertion
|
||||
cursor happens to fall in the selection).
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-insertborderwidth">-insertborderwidth</A></B>
|
||||
<DT>Database Name: <B>insertBorderWidth</B>
|
||||
<DT>Database Class: <B>BorderWidth</B>
|
||||
<DD>Specifies a non-negative value indicating the width
|
||||
of the 3-D border to draw around the insertion cursor.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-insertofftime">-insertofftime</A></B>
|
||||
<DT>Database Name: <B>insertOffTime</B>
|
||||
<DT>Database Class: <B>OffTime</B>
|
||||
<DD>Specifies a non-negative integer value indicating the number of
|
||||
milliseconds the insertion cursor should remain ``off'' in each blink cycle.
|
||||
If this option is zero then the cursor doesn't blink: it is on
|
||||
all the time.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-insertontime">-insertontime</A></B>
|
||||
<DT>Database Name: <B>insertOnTime</B>
|
||||
<DT>Database Class: <B>OnTime</B>
|
||||
<DD>Specifies a non-negative integer value indicating the number of
|
||||
milliseconds the insertion cursor should remain ``on'' in each blink cycle.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-insertwidth">-insertwidth</A></B>
|
||||
<DT>Database Name: <B>insertWidth</B>
|
||||
<DT>Database Class: <B>InsertWidth</B>
|
||||
<DD>Specifies a value indicating the total width of the insertion cursor.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
||||
If a border has been specified for the insertion
|
||||
cursor (using the <B>insertBorderWidth</B> option), the border
|
||||
will be drawn inside the width specified by the <B>insertWidth</B>
|
||||
option.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-jump">-jump</A></B>
|
||||
<DT>Database Name: <B>jump</B>
|
||||
<DT>Database Class: <B>Jump</B>
|
||||
<DD>For widgets with a slider that can be dragged to adjust a value,
|
||||
such as scrollbars, this option determines when
|
||||
notifications are made about changes in the value.
|
||||
The option's value must be a boolean of the form accepted by
|
||||
<B><A HREF="../TclLib/GetInt.htm">Tcl_GetBoolean</A></B>.
|
||||
If the value is false, updates are made continuously as the
|
||||
slider is dragged.
|
||||
If the value is true, updates are delayed until the mouse button
|
||||
is released to end the drag; at that point a single notification
|
||||
is made (the value ``jumps'' rather than changing smoothly).
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-justify">-justify</A></B>
|
||||
<DT>Database Name: <B>justify</B>
|
||||
<DT>Database Class: <B>Justify</B>
|
||||
<DD>When there are multiple lines of text displayed in a widget, this
|
||||
option determines how the lines line up with each other.
|
||||
Must be one of <B>left</B>, <B>center</B>, or <B>right</B>.
|
||||
<B>Left</B> means that the lines' left edges all line up, <B>center</B>
|
||||
means that the lines' centers are aligned, and <B>right</B> means
|
||||
that the lines' right edges line up.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-orient">-orient</A></B>
|
||||
<DT>Database Name: <B>orient</B>
|
||||
<DT>Database Class: <B>Orient</B>
|
||||
<DD>For widgets that can lay themselves out with either a horizontal
|
||||
or vertical orientation, such as scrollbars, this option specifies
|
||||
which orientation should be used. Must be either <B>horizontal</B>
|
||||
or <B>vertical</B> or an abbreviation of one of these.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-padx">-padx</A></B>
|
||||
<DT>Database Name: <B>padX</B>
|
||||
<DT>Database Class: <B>Pad</B>
|
||||
<DD>Specifies a non-negative value indicating how much extra space
|
||||
to request for the widget in the X-direction.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
||||
When computing how large a window it needs, the widget will
|
||||
add this amount to the width it would normally need (as determined
|
||||
by the width of the things displayed in the widget); if the geometry
|
||||
manager can satisfy this request, the widget will end up with extra
|
||||
internal space to the left and/or right of what it displays inside.
|
||||
Most widgets only use this option for padding text: if they are
|
||||
displaying a bitmap or image, then they usually ignore padding
|
||||
options.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-pady">-pady</A></B>
|
||||
<DT>Database Name: <B>padY</B>
|
||||
<DT>Database Class: <B>Pad</B>
|
||||
<DD>Specifies a non-negative value indicating how much extra space
|
||||
to request for the widget in the Y-direction.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
||||
When computing how large a window it needs, the widget will add
|
||||
this amount to the height it would normally need (as determined by
|
||||
the height of the things displayed in the widget); if the geometry
|
||||
manager can satisfy this request, the widget will end up with extra
|
||||
internal space above and/or below what it displays inside.
|
||||
Most widgets only use this option for padding text: if they are
|
||||
displaying a bitmap or image, then they usually ignore padding
|
||||
options.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-relief">-relief</A></B>
|
||||
<DT>Database Name: <B>relief</B>
|
||||
<DT>Database Class: <B>Relief</B>
|
||||
<DD>Specifies the 3-D effect desired for the widget. Acceptable
|
||||
values are <B>raised</B>, <B>sunken</B>, <B>flat</B>, <B>ridge</B>,
|
||||
<B>solid</B>, and <B>groove</B>.
|
||||
The value
|
||||
indicates how the interior of the widget should appear relative
|
||||
to its exterior; for example, <B>raised</B> means the interior of
|
||||
the widget should appear to protrude from the screen, relative to
|
||||
the exterior of the widget.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-repeatdelay">-repeatdelay</A></B>
|
||||
<DT>Database Name: <B>repeatDelay</B>
|
||||
<DT>Database Class: <B>RepeatDelay</B>
|
||||
<DD>Specifies the number of milliseconds a button or key must be held
|
||||
down before it begins to auto-repeat. Used, for example, on the
|
||||
up- and down-arrows in scrollbars.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-repeatinterval">-repeatinterval</A></B>
|
||||
<DT>Database Name: <B>repeatInterval</B>
|
||||
<DT>Database Class: <B>RepeatInterval</B>
|
||||
<DD>Used in conjunction with <B>repeatDelay</B>: once auto-repeat
|
||||
begins, this option determines the number of milliseconds between
|
||||
auto-repeats.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-selectbackground">-selectbackground</A></B>
|
||||
<DT>Database Name: <B>selectBackground</B>
|
||||
<DT>Database Class: <B>Foreground</B>
|
||||
<DD>Specifies the background color to use when displaying selected
|
||||
items.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-selectborderwidth">-selectborderwidth</A></B>
|
||||
<DT>Database Name: <B>selectBorderWidth</B>
|
||||
<DT>Database Class: <B>BorderWidth</B>
|
||||
<DD>Specifies a non-negative value indicating the width
|
||||
of the 3-D border to draw around selected items.
|
||||
The value may have any of the forms acceptable to <B><A HREF="../TkLib/GetPixels.htm">Tk_GetPixels</A></B>.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-selectforeground">-selectforeground</A></B>
|
||||
<DT>Database Name: <B>selectForeground</B>
|
||||
<DT>Database Class: <B>Background</B>
|
||||
<DD>Specifies the foreground color to use when displaying selected
|
||||
items.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-setgrid">-setgrid</A></B>
|
||||
<DT>Database Name: <B>setGrid</B>
|
||||
<DT>Database Class: <B>SetGrid</B>
|
||||
<DD>Specifies a boolean value that determines whether this widget controls the
|
||||
resizing grid for its top-level window.
|
||||
This option is typically used in text widgets, where the information
|
||||
in the widget has a natural size (the size of a character) and it makes
|
||||
sense for the window's dimensions to be integral numbers of these units.
|
||||
These natural window sizes form a grid.
|
||||
If the <B>setGrid</B> option is set to true then the widget will
|
||||
communicate with the window manager so that when the user interactively
|
||||
resizes the top-level window that contains the widget, the dimensions of
|
||||
the window will be displayed to the user in grid units and the window
|
||||
size will be constrained to integral numbers of grid units.
|
||||
See the section GRIDDED GEOMETRY MANAGEMENT in the <B><A HREF="../TkCmd/wm.htm">wm</A></B> manual
|
||||
entry for more details.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-takefocus">-takefocus</A></B>
|
||||
<DT>Database Name: <B>takeFocus</B>
|
||||
<DT>Database Class: <B>TakeFocus</B>
|
||||
<DD>Determines whether the window accepts the focus during keyboard
|
||||
traversal (e.g., Tab and Shift-Tab).
|
||||
Before setting the focus to a window, the traversal scripts
|
||||
consult the value of the <B>takeFocus</B> option.
|
||||
A value of <B>0</B> means that the window should be skipped entirely
|
||||
during keyboard traversal.
|
||||
<B>1</B> means that the window should receive the input
|
||||
focus as long as it is viewable (it and all of its ancestors are mapped).
|
||||
An empty value for the option means that the traversal scripts make
|
||||
the decision about whether or not to focus on the window: the current
|
||||
algorithm is to skip the window if it is
|
||||
disabled, if it has no key bindings, or if it is not viewable.
|
||||
If the value has any other form, then the traversal scripts take
|
||||
the value, append the name of the window to it (with a separator space),
|
||||
and evaluate the resulting string as a Tcl script.
|
||||
The script must return <B>0</B>, <B>1</B>, or an empty string: a
|
||||
<B>0</B> or <B>1</B> value specifies whether the window will receive
|
||||
the input focus, and an empty string results in the default decision
|
||||
described above.
|
||||
Note: this interpretation of the option is defined entirely by
|
||||
the Tcl scripts that implement traversal: the widget implementations
|
||||
ignore the option entirely, so you can change its meaning if you
|
||||
redefine the keyboard traversal scripts.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-text">-text</A></B>
|
||||
<DT>Database Name: <B><A HREF="../TkCmd/text.htm">text</A></B>
|
||||
<DT>Database Class: <B><A HREF="../TkCmd/text.htm">Text</A></B>
|
||||
<DD>Specifies a string to be displayed inside the widget. The way in which
|
||||
the string is displayed depends on the particular widget and may be
|
||||
determined by other options, such as <B>anchor</B> or <B>justify</B>.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-textvariable">-textvariable</A></B>
|
||||
<DT>Database Name: <B>textVariable</B>
|
||||
<DT>Database Class: <B><A HREF="../TclCmd/variable.htm">Variable</A></B>
|
||||
<DD>Specifies the name of a variable. The value of the variable is a text
|
||||
string to be displayed inside the widget; if the variable value changes
|
||||
then the widget will automatically update itself to reflect the new value.
|
||||
The way in which the string is displayed in the widget depends on the
|
||||
particular widget and may be determined by other options, such as
|
||||
<B>anchor</B> or <B>justify</B>.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-troughcolor">-troughcolor</A></B>
|
||||
<DT>Database Name: <B>troughColor</B>
|
||||
<DT>Database Class: <B>Background</B>
|
||||
<DD>Specifies the color to use for the rectangular trough areas
|
||||
in widgets such as scrollbars and scales.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-underline">-underline</A></B>
|
||||
<DT>Database Name: <B>underline</B>
|
||||
<DT>Database Class: <B>Underline</B>
|
||||
<DD>Specifies the integer index of a character to underline in the widget.
|
||||
This option is used by the default bindings to implement keyboard
|
||||
traversal for menu buttons and menu entries.
|
||||
0 corresponds to the first character of the text displayed in the
|
||||
widget, 1 to the next character, and so on.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-wraplength">-wraplength</A></B>
|
||||
<DT>Database Name: <B>wrapLength</B>
|
||||
<DT>Database Class: <B>WrapLength</B>
|
||||
<DD>For widgets that can perform word-wrapping, this option specifies
|
||||
the maximum line length.
|
||||
Lines that would exceed this length are wrapped onto the next line,
|
||||
so that no line is longer than the specified length.
|
||||
The value may be specified in any of the standard forms for
|
||||
screen distances.
|
||||
If this value is less than or equal to 0 then no wrapping is done: lines
|
||||
will break only at newline characters in the text.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-xscrollcommand">-xscrollcommand</A></B>
|
||||
<DT>Database Name: <B>xScrollCommand</B>
|
||||
<DT>Database Class: <B>ScrollCommand</B>
|
||||
<DD>Specifies the prefix for a command used to communicate with horizontal
|
||||
scrollbars.
|
||||
When the view in the widget's window changes (or
|
||||
whenever anything else occurs that could change the display in a
|
||||
scrollbar, such as a change in the total size of the widget's
|
||||
contents), the widget will
|
||||
generate a Tcl command by concatenating the scroll command and
|
||||
two numbers.
|
||||
Each of the numbers is a fraction between 0 and 1, which indicates
|
||||
a position in the document. 0 indicates the beginning of the document,
|
||||
1 indicates the end, .333 indicates a position one third the way through
|
||||
the document, and so on.
|
||||
The first fraction indicates the first information in the document
|
||||
that is visible in the window, and the second fraction indicates
|
||||
the information just after the last portion that is visible.
|
||||
The command is
|
||||
then passed to the Tcl interpreter for execution. Typically the
|
||||
<B>xScrollCommand</B> option consists of the path name of a scrollbar
|
||||
widget followed by ``set'', e.g. ``.x.scrollbar set'': this will cause
|
||||
the scrollbar to be updated whenever the view in the window changes.
|
||||
If this option is not specified, then no command will be executed.
|
||||
<P><DT>Command-Line Name: <B><A NAME="M-yscrollcommand">-yscrollcommand</A></B>
|
||||
<DT>Database Name: <B>yScrollCommand</B>
|
||||
<DT>Database Class: <B>ScrollCommand</B>
|
||||
<DD>Specifies the prefix for a command used to communicate with vertical
|
||||
scrollbars. This option is treated in the same way as the
|
||||
<B>xScrollCommand</B> option, except that it is used for vertical
|
||||
scrollbars and is provided by widgets that support vertical scrolling.
|
||||
See the description of <B>xScrollCommand</B> for details
|
||||
on how this option is used.
|
||||
|
||||
</DL>
|
||||
<H3><A NAME="M4">KEYWORDS</A></H3>
|
||||
<A href="../Keywords/C.htm#class">class</A>, <A href="../Keywords/N.htm#name">name</A>, <A href="../Keywords/S.htm#standard option">standard option</A>, <A href="../Keywords/S.htm#switch">switch</A>
|
||||
<HR><PRE>
|
||||
<A HREF="../copyright.htm">Copyright</A> © 1990-1994 The Regents of the University of California.
|
||||
<A HREF="../copyright.htm">Copyright</A> © 1994-1996 Sun Microsystems, Inc.
|
||||
<A HREF="../copyright.htm">Copyright</A> © 1995-1997 Roger E. Critchlow Jr.</PRE>
|
||||
</BODY></HTML>
|
||||
Reference in New Issue
Block a user