Pmw.ComboBox

Name

Pmw.ComboBox() - dropdown or simple combination box widget

Inherits

Pmw.MegaWidget

Description

This class creates an entry field and an associated scrolled listbox. When an item in the listbox is selected, it is displayed in the entry field. Optionally, the user may also edit the entry field directly.

For a simple combobox, the scrolled listbox is displayed beneath the entry field. For a dropdown combobox, the scrolled listbox is displayed in a window which pops up beneath the entry field when the user clicks on an arrow button on the right of the entry field. Either style allows an optional label.

Options

Options for this megawidget and its base classes are described below.

arrowrelief

Initialisation option. Specifies the relief style to use for the arrow button of a dropdown combobox when it is in a normal state. Acceptable values are 'raised', 'sunken', 'flat', 'ridge', and 'groove'. However, do not use 'sunken' as this is the relief used to indicate a depressed state. This option has no effect on simple comboboxes. The default is 'raised'.

autoclear

Initialisation option. If both autoclear and history are true, clear the entry field whenever <Return> is pressed, after adding the value to the history list. The default is 0.

buttonaspect

Initialisation option. The default is 1.0.

dropdown

Initialisation option. The default is 1.

fliparrow

Initialisation option. The default is 0.

history

Initialisation option. The default is 1.

labelmargin

Initialisation option. If the labelpos option is not None, this specifies the distance between the label component and the rest of the megawidget. The default is 0.

labelpos

Initialisation option. Specifies where to place the label component. If not None, it should be a concatenation of one or two of the letters 'n', 's', 'e' and 'w'. The first letter specifies on which side of the megawidget to place the label. If a second letter is specified, it indicates where on that side to place the label. For example, if labelpos is 'w', the label is placed in the centre of the left hand side; if it is 'wn', the label is placed at the top of the left hand side; if it is 'ws', the label is placed at the bottom of the left hand side.

If None, a label component is not created. The default is None.

listheight

Initialisation option. The default is 150.

selectioncommand

The default is ''.

unique

Initialisation option. The default is 1.

Components

Components created by this megawidget and its base classes are described below.

arrowbutton

By default, this component is a Tkinter.Canvas.

entryfield

By default, this component is a Pmw.EntryField.

hull

This acts as the body for the entire megawidget. Other components are created as children of the hull to further specialise the widget. By default, this component is a Tkinter.Frame.

label

If the labelpos option is not None, this component is created as a text label for the megawidget. See the labelpos option for details. Note that to set, for example, the text option of the label, you need use the label_text component option. By default, this component is a Tkinter.Label.

popup

By default, this component is a Tkinter.Toplevel.

scrolledlist

By default, this component is a Pmw.ScrolledListBox.

Component aliases

Sub-components of components of this megawidget may be accessed via the following aliases.

entry

Alias for entryfield_entry.

listbox

Alias for scrolledlist_listbox.

Methods

Only methods specific to this megawidget are described below. For a description of its inherited methods, see the manuals for its base classes. In addition, methods from the following megawidgets are forwarded to the indicated component. Methods from Pmw.ScrolledListBox are forwarded to the scrolledlist component. Methods from Pmw.EntryField are forwarded to the entryfield component. Forwarded methods are searched in the order given.

get(first = None, last = None)

invoke()

selectitem(index, setentry = 1)

size()