Graphics.UI.Gtk.ModelView.ComboBox

A ComboBox is a widget that allows the user to choose from a list of valid choices. The ComboBox displays the selected choice. When activated, the ComboBox displays a popup which allows the user to make a new choice. The style in which the selected value is displayed, and the style of the popup is determined by the current theme. It may be similar to a OptionMenu, or similar to a Windows-style combo box.

Unlike its predecessors Combo and OptionMenu, the ComboBox uses the model-view pattern; the list of valid choices is specified in the form of a tree model, and the display of the choices can be adapted to the data in the model by using cell renderers, as you would in a tree view. This is possible since ComboBox implements the CellLayout interface. The tree model holding the valid choices is not restricted to a flat list, it can be a real tree, and the popup will reflect the tree structure.

In addition to the model-view API, ComboBox offers a simple API which is suitable for text-only combo boxes, and hides the complexity of managing the data in a model. It consists of the functions comboBoxNewText, comboBoxAppendText, comboBoxInsertText, comboBoxPrependText, comboBoxRemoveText and comboBoxGetActiveText.

Class Hierarchy

 |  GObject
 |   +----Object
 |         +----Widget
 |               +----Container
 |                     +----Bin
 |                           +----ComboBox
 |                                 +----ComboBoxEntry

Types

data ComboBox

Instances

BinClass ComboBox

CellLayoutClass ComboBox

ComboBoxClass ComboBox

ContainerClass ComboBox

GObjectClass ComboBox

ObjectClass ComboBox

WidgetClass ComboBox

class BinClass o => ComboBoxClass o

Instances

ComboBoxClass ComboBox

ComboBoxClass ComboBoxEntry

castToComboBox :: GObjectClass obj => obj -> ComboBox

toComboBox :: ComboBoxClass o => o -> ComboBox

Constructors

comboBoxNew :: IO ComboBox

Creates a new empty ComboBox.

comboBoxNewText :: IO ComboBox

Convenience function which constructs a new text combo box, which is a ComboBox just displaying strings. If you use this function to create a text combo box, you should only manipulate its data source with the following convenience functions: comboBoxAppendText, comboBoxInsertText, comboBoxPrependText and comboBoxRemoveText.

comboBoxNewWithModel

:: TreeModelClass model
=> model	`model` - A `TreeModel`.
-> IO ComboBox
Creates a new `ComboBox` with the model initialized to `model`.

Methods

comboBoxSetWrapWidth :: ComboBoxClass self => self -> Int -> IO ()

Sets the wrap width of the combo box to be width. The wrap width is basically the preferred number of columns when you want the popup to be layed out in a table.

comboBoxSetRowSpanColumn :: ComboBoxClass self => self -> Int -> IO ()

Sets the column with row span information for the combo box to be rowSpan. The row span column contains integers which indicate how many rows an item should span.

comboBoxSetColumnSpanColumn :: ComboBoxClass self => self -> Int -> IO ()

Sets the column with column span information for the combo box to be columnSpan. The column span column contains integers which indicate how many columns an item should span.

comboBoxGetActive

:: ComboBoxClass self
=> self
-> IO (Maybe Int)	returns An integer which is the index of the currently active item, or `Nothing` if there's no active item.
Returns the index of the currently active item, or `Nothing` if there's no active item. If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this function returns `treePathGetIndices path !! 0`, where `path` is the TreePath of the active item.

comboBoxSetActive

:: ComboBoxClass self
=> self
-> Int	`index` - An index in the model passed during construction, or -1 to have no active item.
-> IO ()
Sets the active item of the combo box to be the item at `index`.

comboBoxGetActiveIter :: ComboBoxClass self => self -> IO (Maybe TreeIter)

Returns a TreeIter that points to the current active item, if it exists, or Nothing if there is no current active item.

comboBoxSetActiveIter

:: ComboBoxClass self
=> self
-> TreeIter	`iter` - The `TreeIter`.
-> IO ()
Sets the current active item to be the one referenced by `iter`. `iter` must correspond to a path of depth one.

comboBoxGetModel

:: (ComboBoxClass self, TreeModelClass model)
=> self
-> IO (Maybe model)	returns A `TreeModel` which was passed during construction.
Returns the `TreeModel` which is acting as data source for `comboBox`.

comboBoxSetModel :: (ComboBoxClass self, TreeModelClass model) => self -> Maybe model -> IO ()

Sets the model used by comboBox to be model. Will unset a previously set model (if applicable). If model is Nothing, then it will unset the model.

Note that this function does not clear the cell renderers, you have to call comboBoxCellLayoutClear yourself if you need to set up different cell renderers for the new model.

comboBoxAppendText :: ComboBoxClass self => self -> String -> IO ()

Appends the given string to the list of strings stored in the combo box. Note that you can only use this function with combo boxes constructed with comboBoxNewText.

comboBoxInsertText

:: ComboBoxClass self
=> self
-> Int	`position` - An index to insert `text`.
-> String	text
-> IO ()
Inserts `text` at `position` in the list of strings stored in the combo box. Note that you can only use this function with combo boxes constructed with `comboBoxNewText`.

comboBoxPrependText :: ComboBoxClass self => self -> String -> IO ()

Prepends the given string to the list of strings stored in the combo box. Note that you can only use this function with combo boxes constructed with comboBoxNewText.

comboBoxRemoveText

:: ComboBoxClass self
=> self
-> Int	`position` - Index of the item to remove.
-> IO ()
Removes the string at `position` from the combo box. Note that you can only use this function with combo boxes constructed with `comboBoxNewText`.

comboBoxPopup :: ComboBoxClass self => self -> IO ()

Pops up the menu or dropdown list of the combo box.

This function is mostly intended for use by accessibility technologies; applications should have little use for it.

comboBoxPopdown :: ComboBoxClass self => self -> IO ()

Hides the menu or dropdown list of the combo box.

This function is mostly intended for use by accessibility technologies; applications should have little use for it.

comboBoxGetWrapWidth :: ComboBoxClass self => self -> IO Int

Returns the wrap width which is used to determine the number of columns for the popup menu. If the wrap width is larger than 1, the combo box is in table mode.

Available since Gtk+ version 2.6

comboBoxGetRowSpanColumn :: ComboBoxClass self => self -> IO Int

Returns the column with row span information for comboBox.

Available since Gtk+ version 2.6

comboBoxGetColumnSpanColumn :: ComboBoxClass self => self -> IO Int

Returns the column with column span information for comboBox.

Available since Gtk+ version 2.6

comboBoxGetActiveText :: ComboBoxClass self => self -> IO (Maybe String)

Returns the currently active string in comboBox or Nothing if none is selected. Note that you can only use this function with combo boxes constructed with comboBoxNewText and with ComboBoxEntrys.

Available since Gtk+ version 2.6

comboBoxSetAddTearoffs

:: ComboBoxClass self
=> self
-> Bool	`addTearoffs` - `True` to add tearoff menu items
-> IO ()
Sets whether the popup menu should have a tearoff menu item. Available since Gtk+ version 2.6

comboBoxGetAddTearoffs :: ComboBoxClass self => self -> IO Bool

Gets the current value of the :add-tearoffs property.

comboBoxSetFocusOnClick

:: ComboBoxClass self
=> self
-> Bool	`focusOnClick` - whether the combo box grabs focus when clicked with the mouse
-> IO ()
Sets whether the combo box will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don't want the keyboard focus removed from the main area of the application. Available since Gtk+ version 2.6

comboBoxGetFocusOnClick

:: ComboBoxClass self
=> self
-> IO Bool	returns `True` if the combo box grabs focus when it is clicked with the mouse.
Returns whether the combo box grabs focus when it is clicked with the mouse. See `comboBoxSetFocusOnClick`. Available since Gtk+ version 2.6

Attributes

comboBoxModel :: (ComboBoxClass self, TreeModelClass model) => Attr self (Maybe model)

The model from which the combo box takes the values shown in the list.

comboBoxWrapWidth :: ComboBoxClass self => Attr self Int

If wrap-width is set to a positive value, the list will be displayed in multiple columns, the number of columns is determined by wrap-width.

Allowed values: >= 0

Default value: 0

comboBoxRowSpanColumn :: ComboBoxClass self => Attr self Int

If this is set to a non-negative value, it must be the index of a column of type G_TYPE_INT in the model.

The values of that column are used to determine how many rows a value in the list will span. Therefore, the values in the model column pointed to by this property must be greater than zero and not larger than wrap-width.

Allowed values: >= -1

Default value: -1

comboBoxColumnSpanColumn :: ComboBoxClass self => Attr self Int

If this is set to a non-negative value, it must be the index of a column of type G_TYPE_INT in the model.

The values of that column are used to determine how many columns a value in the list will span.

Allowed values: >= -1

Default value: -1

comboBoxAddTearoffs :: ComboBoxClass self => Attr self Bool

The add-tearoffs property controls whether generated menus have tearoff menu items.

Note that this only affects menu style combo boxes.

Default value: False

comboBoxHasFrame :: ComboBoxClass self => Attr self Bool

The has-frame property controls whether a frame is drawn around the entry.

Default value: True

comboBoxFocusOnClick :: ComboBoxClass self => Attr self Bool

Whether the combo box grabs focus when it is clicked with the mouse.

Default value: True

Signals

onChanged :: ComboBoxClass self => self -> IO () -> IO (ConnectId self)

The changed signal gets emitted when the active item is changed. This can be due to the user selecting a different item from the list, or due to a call to comboBoxSetActiveIter.

afterChanged :: ComboBoxClass self => self -> IO () -> IO (ConnectId self)

Produced by Haddock version 0.8