NAME

SelectColor - color selection dialog

SYNOPSIS

SelectColor pathName ?option value...?

DESCRIPTION

STANDARD OPTIONS

-background

-color

-command

-help

-parent

-placement

-title

-type

WIDGET COMMAND

pathName cget option

pathName configure ?option? ?value option value ...?

SelectColor::dialog pathName ?option value ...?

SelectColor::menu pathName placement ?option value ...?

SelectColor::setbasecolor index color

SelectColor::setcolor index color

NAME

SYNOPSIS

DESCRIPTION

WIDGET-SPECIFIC OPTIONS

-background

Specifies the background color of the widget.

-color

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.

-command

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 -color) that was used before the dialog was opened.

-help

This option takes a Boolean value. If the value is Boolean true, the SelectColor dialog will include a panel that offers dynamic help to the user.

-parent

Parent of the Dialog. Dialog is centered in its parent. If empty, it is centered in root window.

-placement

Where to place the popup color dialog when displaying it. Must be any of: at, center, left, right, above, or below. If -parent is specified, placement will be in relation to the parent widget.

-title

Title of the Dialog toplevel.

-type (only on widget creation)

Specifies the type of the SelectColor widget. Must be dialog or popup.
If type option is dialog, SelectColor::create 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.
If type option is popup, SelectColor::create creates a small, popup dialog with a small set of predefined colors and a button to activate a full color dialog.
The widget commands dialog and menu below are synonyms for those operation modes.

WIDGET COMMAND

pathName cget option

Returns the current value of the configuration option given by option. Argument option may have any of the values accepted by the creation command SelectColor.

pathName configure ?option? ?value option value ...?

Query or modify the configuration options of the widget. If no option is specified, returns a list describing all of the available options for pathName. If option is specified with no value, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified). If one or more option-value 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. Argument option may have any of the values accepted by the creation command SelectColor. Read-only options cannot be modified.

SelectColor::dialog pathName ?option value ...?

Creates a dialog for the user to select a custom color.

SelectColor::menu pathName placement ?option value ...?

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.

placement can be any of at, center, left, right, above, or below. If -parent is specified, placement will be in relation to the parent widget.

SelectColor::setbasecolor index color

Set the value of user predefined base color at index index to color. index must be between 0 and 10.

SelectColor::setcolor index color

Set the value of user predefined color at index index to color. index must be between 0 and 10.