NAME

ArrowButton - a button widget with an arrow shape.

SYNOPSIS

ArrowButton pathName ?option value...?

DESCRIPTION

STANDARD OPTIONS

WIDGET COMMAND

pathName cget option

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

pathName invoke

NAME

SYNOPSIS

DESCRIPTION

An ArrowButton can be of two types following the -type option: for the button type, it is a standard button with an arrow drawn on it; for the arrow type, it is an arrow like a scrollbar's arrow.

The ArrowButton widget is used by Slab ComboBox, NoteBook, and SpinBox.

WIDGET-SPECIFIC OPTIONS

-armcommand

Specifies a Tcl command to associate with the ArrowButton when mouse button 1 is pressed over the ArrowButton. When option -repeatdelay or -repeatinterval is a positive integer, this command is repeatedly called if the mouse pointer is over the button and until mouse button 1 is released.

-arrowbd

When ArrowButton -type is arrow, specifies the border width of the arrow. Must be 1 or 2.

-arrowrelief

When ArrowButton -type is arrow, specifies the relief of the arrow. Must be raised or sunken.

-clean

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 the arrow is arranged to be odd to have the same edges. If 2, the base of the arrow is arranged to be odd and the orthogonal to be (base+1)/2 to have "straight" diagonals for edges.

-command

Specifies a Tcl command to associate with the ArrowButton. This command is typically invoked when mouse button 1 is released over the ArrowButton window.

-dir

Specifies the direction of the arrow: top, bottom, left or right.

-disarmcommand

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 option -command. It is typically used in conjunction with options -armcommand, -repeatdelay and -repeatinterval.

-height

Specifies a desired height for the ArrowButton. The value is in screen units.

-helptext

Text for dynamic help. If empty, no help is available for this widget. See also DynamicHelp.

-helptype

Type of dynamic help. Use balloon or variable. See also DynamicHelp.

-helpvar

Variable to use when option -helptype is variable. See also DynamicHelp.

-ipadx

Specifies a minimum pad between the ArrowButton border and the right and left side of the arrow. The value is in screen units.

-ipady

Specifies a minimum pad between the ArrowButton border and the top and bottom side of the arrow. The value is in screen units.

-state

Specifies one of three states for the ArrowButton: normal, active, or disabled.

If ArrowButton -type is button:

In the normal state the ArrowButton is displayed using the -foreground and -background options. The active state is typically used when the pointer is over the ArrowButton. In the active state the ArrowButton is displayed using the -activeforeground and -activebackground options. In the disabled state the -disabledforeground and -background options determine how the ArrowButton is displayed.

If ArrowButton -type is arrow:

Only colors of arrow change. The background of ArrowButton is always displayed using -troughcolor option. In the normal state the ArrowButton is displayed using the -background option. The active state is typically used when the pointer is over the ArrowButton. In the active state the ArrowButton is displayed using the -activebackground option. In the disabled state the ArrowButton is displayed with a dark stipple.

In the disabled state the ArrowButton is unresponsive: the default bindings will refuse to activate and the widget will ignore mouse button presses.

-type

Determines the type of the ArrowButton: button for standard button look, or arrow for a scrollbar's arrow look.

-width

Specifies a desired width for the ArrowButton. The value is in screen units.

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 ArrowButton.

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 ArrowButton. Read-only options cannot be modified.

pathName invoke

If ArrowButton option -state is not disabled, this command invokes the commands of the ArrowButton. The ArrowButton is redisplayed with active color and sunken relief, and -armcommand is called. Then the ArrowButton is redisplayed with normal color and its defined relief, and -disarmcommand and then -command are called.

invoke is called when the ArrowButton has keyboard focus and the user presses the space bar.