combobox - Create and manipulate combination box widgets

INHERITANCE

STANDARD OPTIONS

cursor highlightColor insertWidth insertWidth selectBorderWidth

justify highlightThickness insertBackground insertBorderWidth textVariable

background exportSelection relief insertOffTime selectForeground

borderWidth foreground width insertOnTime selectBackground

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

ASSOCIATED OPTIONS

hscrollmode

textBackground

textFont

vscrollmode

See the "scrolledlistbox" manual entry for details on the above inherited options.

show

See the "entry" manual entry for details on the above inherited option.

INHERITED OPTIONS

childSitePos invalid

command textBackground

fixed textFont

focusCommand validate

See the "entryfield" class manual entry for details on the inherited options.

labelBitmap labelPos

labelFont labelText

labelImage labelVariable

labelMargin

See the "labeledwidget" class manual entry for details on the inherited options.

WIDGET-SPECIFIC OPTIONS

Name:                   arrowRelief
Class:                  Relief
Command-Line Switch:	-arrowrelief

Specifies the relief style to use for a dropdown Combobox's arrow button in a normal (not depressed) state. Acceptable values are raised, sunken, flat, ridge, and groove. Sunken is discouraged as this is the relief used to indicate a depressed state. This option has no effect on simple Comboboxes. The default is raised.

Name:                   completion
Class:                  Completion
Command-Line Switch:	-completion

Boolean given in any of the forms acceptable to Tcl_GetBoolean which determines whether insertions into the entry field, whether from the keyboard or programmatically via the insert method, are automatically completed with the first matching item from the listbox. The default is true.

Name:                   dropdown
Class:                  Dropdown
Command-Line Switch:	-dropdown

Boolean describing the Combobox layout style given in any of the forms acceptable to Tcl_GetBoolean. If true, the Combobox will be a dropdown style widget which displays an entry field and an arrow button which when activated will pop up a scrollable list of items. If false, a simple Combobox style will be used which has an entry field and a scrollable list beneath it which is always visible. Both styles allow an optional label for the entry field area. The default is true.

Name:                   editable
Class:                  Editable
Command-Line Switch:	-editable

Boolean describing whether or not the text entry area is editable by the user. If true the user can add items to the combobox by entering text into the entry area and then pressing Return. If false, the list of items is non-editable and can only be changed by calling the insert or delete methods. (The value in the entry field can still be modified by selecting from the list.) Given in any of the forms acceptable to Tcl_GetBoolean. The default is true.

Name:                   grab
Class:                  Grab
Command-Line Switch:	-grab

This option sets the grab scope for the appearance of the listbox in drop-down comboboxes. It can be either global or local. The default is local.

Name:                   listHeight
Class:                  Height
Command-Line Switch:	-listheight

Height of the listbox specified in any of the forms acceptable to Tk_GetPixels. The default is 150 pixels.

Name:                   margin
Class:                  Margin
Command-Line Switch:	-margin

Specifies the width in pixels between the entry component and the arrow button for a dropdown Combobox given in any of the forms acceptable to Tk_GetPixels. This option has no effect on a simple Combobox. The default is 1.

Name:                   popupCursor
Class:                  Cursor
Command-Line Switch:	-popupcursor

Specifies the cursor to be used for dropdown style listboxes. The value may have any of the forms acceptable to Tk_GetCursor. The default is arrow.

Name:                   selectionCommand
Class:                  SelectionCommand
Command-Line Switch:	-selectioncommand

Specifies a Tcl command procedure which is called when an item in the listbox area is selected. The item will be selected in the list, the listbox will be removed if it is a dropdown Combobox, and the selected item's text will be inserted into the entry field before the -selectioncommand proc is called. The default is {}.

Name:                   state
Class:                  State
Command-Line Switch:	-state

Specifies the overall state of the Combobox megawidget. Can be either normal or disabled. If the Combobox is disabled, no text can be entered into the entry field, no selection can be made in the listbox, and the arrowBtn component is disabled. The default is normal.

Name:                   unique
Class:                  Unique
Command-Line Switch:	-unique

Boolean describing whether or not duplicate items are allowed in the combobox list. If true, then duplicates are not allowed to be inserted. If false, a duplicate entry causes selection of the item. Given in any of the forms acceptable to Tcl_GetBoolean. The default is true.

DESCRIPTION

The combobox command creates an enhanced entry field widget with an optional associated label and a scrollable list. When an item is selected in the list area of a Combobox, its value is then displayed in the entry field text area. Functionally similar to an Optionmenu, the Combobox adds (optional) list scrolling and (optional) item editing and inserting capabilities.

There are two basic styles of Comboboxes (determined by the -dropdown option): dropdown and simple. The dropdown style adds an arrow button to the right of the entry field which when activated will pop up (and down) the scrolled listbox beneath the entry field. The simple (non-dropdown) Combobox permanently displays the listbox beneath the entry field and has no arrow button. Either style allows an optional entry field label.

METHODS

The combobox 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 ...?

ASSOCIATED METHODS

icursor

scan

See the "entry" manual entries for details on the above associated methods.

curselection xview

index yview

see

size

See the "listbox" manual entries for details on the above associated methods.

getcurselection

justify

sort

See the "scrolledlistbox" manual entries for details on the above associated methods.

WIDGET-SPECIFIC METHODS