colbutton - Create and manipulate a column button widget

SYNOPSIS

mtiwidgets::colbutton pathName ?options?

INHERITANCE

itk::Widget <- button

STANDARD OPTIONS

activeBackground
borderWidth
font
highlightThickness
state
activeForeground
command
foreground
image
text
background
cursor
highlightBackground
padX
underline
bitmap
disabledForeground
highlightColor
padY
wrapLength

See the "options" manual entry for details on the standard options.

WIDGET-SPECIFIC OPTIONS

Name:                   sortState
Class: SortState
Command-Line Switch: -sortstate


DESCRIPTION

The colbutton command creates a column button.  This button is intended to be used as the header of a column where pressing the header button will cause the application to sort the column.  The column buttons adds two features to a basic button: 1) an indicator which will display blank (none state), an up arrow (up state), and a down arrow (down state), and 2) narrower height than is achievable with the default button.  

METHODS

The colbutton command creates a new Tcl command whose name is pathName. This command may be used to invoke various operations on the widget. It has the following general form:

pathName option ?arg arg ...?
Option and the args determine the exact behavior of the command. The following commands are possible for button widgets:

ASSOCIATED METHODS

invoke

See the "button" manual entry for details on the associated methods.

WIDGET-SPECIFIC METHODS

pathName cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the button command.
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 (see Tk_ConfigureInfo for information on the format of this list). 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. Option may have any of the values accepted by the button command.

COMPONENTS

Name:                   button
Class:                  Frame
Name:                   coltext
Class: label
Name:                   indicator
Class: label

EXAMPLE

package require Mtiwidgets

proc seqSortState {w} {
set ss [$w cget -sortstate]
switch $ss {
none {set ss up}
up {set ss down}
down {set ss none}
}
$w configure -sortstate $ss
puts "Sort by $ss"
}

mtiwidgets::colbutton .cb -text "Names" \
-command {seqSortState .cb}
pack .cb -padx 10 -pady 10

AUTHOR

Brian Griffin

KEYWORDS

button, repeat, widget