277 lines
9.5 KiB
HTML
277 lines
9.5 KiB
HTML
<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>
|