<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="#-background">-background</A></td>
<TD> <A HREF="#-color">-color</A></td>
</TR>
<TR>
<TD> <A HREF="#-command">-command</A></td>
<TD> <A HREF="#-help">-help</A></td>
</TR>
<TR>
<TD> <A HREF="#-parent">-parent</A></td>
<TD> <A HREF="#-placement">-placement</A></td>
</TR>
<TR>
<TD> <A HREF="#-title">-title</A></td>
<TD> <A HREF="#-type">-type</A></td>
</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="#dialog"><B>dialog</B></A>
<I>pathName</I>
<I>?option value ...?</I>
</DD>
<DD>SelectColor::<A HREF="#menu"><B>menu</B></A>
<I>pathName</I>
<I>placement</I>
<I>?option value ...?</I>
</DD>
<DD>SelectColor::<A HREF="#setbasecolor"><B>setbasecolor</B></A>
<I>index</I>
<I>color</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="-background"><B>-background</B></A></DT>
<DD>
Specifies the background color of the widget.
</DD>
</DL>
<DL><DT><A NAME="-color"><B>-color</B></A></DT>
<DD>
Specifies the initial color used in the widget's color selectors. When modifying a
color that is used in the GUI, the value supplied is typically the existing value of
that color.
</DD>
</DL>
<DL><DT><A NAME="-command"><B>-command</B></A></DT>
<DD>
Specifies a command to be evaluated, with a color value appended, whenever
the color selected in the dialog changes. This facility can be used to modify
a color in the calling GUI and preview the change before deciding whether or not
to accept it. If the user selects "Cancel" in the dialog, the command is called
a final time to restore the initial color (supplied by option <B>-color</B>) that was
used before the dialog was opened.
</DD>
</DL>
<DL><DT><A NAME="-help"><B>-help</B></A></DT>
<DD>
This option takes a Boolean value. If the value is Boolean true, the SelectColor
dialog will include a balloon help for text entry and mouse operation.
</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="-placement"><B>-placement</B></A></DT>
<DD>
Where to place the <i>popup</i> color dialog when displaying it.
Must be any of: <b>at</b>, <b>center</b>, <b>left</b>,
<b>right</b>, <b>above</b>, or <b>below</b>. If <i>-parent</i> is specified,
placement will be in relation to the parent widget.
</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>popup</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>popup</I>,
SelectColor::<B>create</B> creates a small, popup dialog with a small set of
predefined colors and a button to activate a full color dialog.
</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="dialog">SelectColor::<B>dialog</B></A>
<I>pathName</I>
<I>?option value ...?</I>
</DT><DD>
Creates a dialog for the user to select a custom color.
</DD></DL>
<DL><DT><A NAME="dialog">SelectColor::<B>menu</B></A>
<I>pathName</I>
<I>placement</I>
<I>?option value ...?</I>
</DT><DD>
Creates a small, popup dialog for the user to select from a predefined list
of colors with an additional button to display a full color dialog.
<p>
<i>placement</i> can be any of <b>at</b>, <b>center</b>, <b>left</b>,
<b>right</b>, <b>above</b>, or <b>below</b>. If <i>-parent</i> is specified,
placement will be in relation to the parent widget.
</p>
</DD></DL>
</DD></DL>
<DL><DT><A NAME="setbasecolor">SelectColor::<B>setbasecolor</B></A>
<I>index</I>
<I>color</I>
</DT><DD>
Set the value of user predefined base color at index <I>index</I> to <I>color</I>.
<I>index</I> must be between 0 and 10.
</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 0 and 10.
</DD></DL>
</BODY></HTML>
