wxComboBox — wx v2.4.3.1

Search documentation of wx

# wxComboBox (wx v2.4.3.1)

View Source

A combobox is like a combination of an edit control and a listbox.

It can be displayed as static list with editable or read-only text field; or a drop-down list with text field; or a drop-down list without a text field depending on the platform and presence of wxCB_READONLY style.

A combobox permits a single selection only. Combobox items are numbered from zero.

If you need a customized combobox, have a look at `wxComboCtrl` (not implemented in wx), `wxOwnerDrawnComboBox` (not implemented in wx), `wxComboPopup` (not implemented in wx) and the ready-to-use `wxBitmapComboBox` (not implemented in wx).

Please refer to `wxTextEntry` (not implemented in wx) documentation for the description of methods operating with the text entry part of the combobox and to `wxItemContainer` (not implemented in wx) for the methods operating with the list of strings. Notice that at least under MSW `wxComboBox` doesn't behave correctly if it contains strings differing in case only so portable programs should avoid adding such strings to this control.

## Styles

This class supports the following styles:

- wxCB_SIMPLE: Creates a combobox with a permanently displayed list. Windows only.

- wxCB_DROPDOWN: Creates a combobox with a drop-down list. MSW and Motif only.

- wxCB_READONLY: A combobox with this style behaves like a `wxChoice` (and may look in the same way as well, although this is platform-dependent), i.e. it allows the user to choose from the list of options but doesn't allow to enter a value not present in the list.

- wxCB_SORT: Sorts the entries in the list alphabetically.

- wxTE_PROCESS_ENTER: The control will generate the event `wxEVT_TEXT_ENTER` that can be handled by the program. Otherwise, i.e. either if this style not specified at all, or it is used, but there is no event handler for this event or the event handler called `wxEvent:skip/2` to avoid overriding the default handling, pressing Enter key is either processed internally by the control or used to activate the default button of the dialog, if any.

See:

- `wxListBox`

- `wxTextCtrl`

- `wxChoice`

- `wxCommandEvent`

This class is derived, and can use functions, from:

- `wxControlWithItems`

- `wxControl`

- `wxWindow`

- `wxEvtHandler`

wxWidgets docs: wxComboBox

## Events

Event types emitted from this class:

- `command_combobox_selected`

- `command_text_updated`

- `command_text_enter`

- `combobox_dropdown`

- `combobox_closeup`

# Summary

## Types

wxComboBox()

## Functions

canCopy(This)

Returns true if the selection can be copied to the clipboard.

canCut(This)

Returns true if the selection can be cut to the clipboard.

canPaste(This)

Returns true if the contents of the clipboard can be pasted into the text control.

canRedo(This)

Returns true if there is a redo facility available and the last operation can be redone.

canUndo(This)

Returns true if there is an undo facility available and the last operation can be undone.

copy(This)

Copies the selected text to the clipboard.

create(This, Parent, Id, Value, Pos, Size, Choices)

Equivalent to `create(This, Parent, Id, Value, Pos, Size, Choices, [])`.

create/8
cut(This)

Copies the selected text to the clipboard and removes it from the control.

destroy(This)

Destroys the object

getInsertionPoint(This)

Same as `wxTextCtrl:getInsertionPoint/1`.

getLastPosition(This)

Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control.

getValue(This)

Gets the contents of the control.

new()

Default constructor.

new(Parent, Id)

Equivalent to `new(Parent, Id, [])`.

new/3

Constructor, creating and showing a combobox.

paste(This)

Pastes text from the clipboard to the text item.

redo(This)

If there is a redo facility and the last operation can be redone, redoes the last operation.

remove(This, From, To)

Removes the text starting at the first given position up to (but not including) the character at the last position.

replace(This, From, To, Value)

Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.

setInsertionPoint(This, Pos)

Sets the insertion point at the given position.

setInsertionPointEnd(This)

Sets the insertion point at the end of the text control.

setSelection(This, N)

Sets the selection to the given item `n` or removes the selection entirely if `n` == `wxNOT\_FOUND`.

setSelection(This, From, To)

Same as `wxTextCtrl:setSelection/3`.

setValue(This, Text)

Sets the text for the combobox text field.

undo(This)

If there is an undo facility and the last operation can be undone, undoes the last operation.

# Types

# wxComboBox()

    -type wxComboBox() :: wx:wx_object().

# Functions

# canCopy(This)

    -spec canCopy(This) -> boolean() when This :: wxComboBox().

Returns true if the selection can be copied to the clipboard.

# canCut(This)

    -spec canCut(This) -> boolean() when This :: wxComboBox().

Returns true if the selection can be cut to the clipboard.

# canPaste(This)

    -spec canPaste(This) -> boolean() when This :: wxComboBox().

Returns true if the contents of the clipboard can be pasted into the text control.

On some platforms (Motif, GTK) this is an approximation and returns true if the control is editable, false otherwise.

# canRedo(This)

    -spec canRedo(This) -> boolean() when This :: wxComboBox().

Returns true if there is a redo facility available and the last operation can be redone.

# canUndo(This)

    -spec canUndo(This) -> boolean() when This :: wxComboBox().

Returns true if there is an undo facility available and the last operation can be undone.

# copy(This)

    -spec copy(This) -> ok when This :: wxComboBox().

Copies the selected text to the clipboard.

# create(This, Parent, Id, Value, Pos, Size, Choices)

    -spec create(This, Parent, Id, Value, Pos, Size, Choices) -> boolean()
                    when
                        This :: wxComboBox(),
                        Parent :: wxWindow:wxWindow(),
                        Id :: integer(),
                        Value :: unicode:chardata(),
                        Pos :: {X :: integer(), Y :: integer()},
                        Size :: {W :: integer(), H :: integer()},
                        Choices :: [unicode:chardata()].

Equivalent to `create(This, Parent, Id, Value, Pos, Size, Choices, [])`.

# create/8

    -spec create(This, Parent, Id, Value, Pos, Size, Choices, [Option]) -> boolean()
                    when
                        This :: wxComboBox(),
                        Parent :: wxWindow:wxWindow(),
                        Id :: integer(),
                        Value :: unicode:chardata(),
                        Pos :: {X :: integer(), Y :: integer()},
                        Size :: {W :: integer(), H :: integer()},
                        Choices :: [unicode:chardata()],
                        Option :: {style, integer()} | {validator, wx:wx_object()}.

# cut(This)

    -spec cut(This) -> ok when This :: wxComboBox().

Copies the selected text to the clipboard and removes it from the control.

# destroy(This)

    -spec destroy(This :: wxComboBox()) -> ok.

Destroys the object

# getInsertionPoint(This)

    -spec getInsertionPoint(This) -> integer() when This :: wxComboBox().

Same as `wxTextCtrl:getInsertionPoint/1`.

Note: Under wxMSW, this function always returns 0 if the combobox doesn't have the focus.

# getLastPosition(This)

    -spec getLastPosition(This) -> integer() when This :: wxComboBox().

Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control.

# getValue(This)

    -spec getValue(This) -> unicode:charlist() when This :: wxComboBox().

Gets the contents of the control.

Notice that for a multiline text control, the lines will be separated by (Unix-style) `\n` characters, even under Windows where they are separated by a `\r\n` sequence in the native control.

# new()

    -spec new() -> wxComboBox().

Default constructor.

# new(Parent, Id)

    -spec new(Parent, Id) -> wxComboBox() when Parent :: wxWindow:wxWindow(), Id :: integer().

Equivalent to `new(Parent, Id, [])`.

# new/3

    -spec new(Parent, Id, [Option]) -> wxComboBox()
                 when
                     Parent :: wxWindow:wxWindow(),
                     Id :: integer(),
                     Option ::
                         {value, unicode:chardata()} |
                         {pos, {X :: integer(), Y :: integer()}} |
                         {size, {W :: integer(), H :: integer()}} |
                         {choices, [unicode:chardata()]} |
                         {style, integer()} |
                         {validator, wx:wx_object()}.

Constructor, creating and showing a combobox.

See: `create/8`

# paste(This)

    -spec paste(This) -> ok when This :: wxComboBox().

Pastes text from the clipboard to the text item.

# redo(This)

    -spec redo(This) -> ok when This :: wxComboBox().

If there is a redo facility and the last operation can be redone, redoes the last operation.

Does nothing if there is no redo facility.

# remove(This, From, To)

    -spec remove(This, From, To) -> ok when This :: wxComboBox(), From :: integer(), To :: integer().

Removes the text starting at the first given position up to (but not including) the character at the last position.

This function puts the current insertion point position at `to` as a side effect.

# replace(This, From, To, Value)

    -spec replace(This, From, To, Value) -> ok
                     when
                         This :: wxComboBox(),
                         From :: integer(),
                         To :: integer(),
                         Value :: unicode:chardata().

Replaces the text starting at the first position up to (but not including) the character at the last position with the given text.

This function puts the current insertion point position at `to` as a side effect.

# setInsertionPoint(This, Pos)

    -spec setInsertionPoint(This, Pos) -> ok when This :: wxComboBox(), Pos :: integer().

Sets the insertion point at the given position.

# setInsertionPointEnd(This)

    -spec setInsertionPointEnd(This) -> ok when This :: wxComboBox().

Sets the insertion point at the end of the text control.

This is equivalent to calling `setInsertionPoint/2` with `getLastPosition/1` argument.

# setSelection(This, N)

    -spec setSelection(This, N) -> ok when This :: wxComboBox(), N :: integer().

Sets the selection to the given item `n` or removes the selection entirely if `n` == `wxNOT\_FOUND`.

Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.

See:

- `wxControlWithItems:setString/3`

- `wxControlWithItems:setStringSelection/2`

# setSelection(This, From, To)

    -spec setSelection(This, From, To) -> ok when This :: wxComboBox(), From :: integer(), To :: integer().

Same as `wxTextCtrl:setSelection/3`.

# setValue(This, Text)

    -spec setValue(This, Text) -> ok when This :: wxComboBox(), Text :: unicode:chardata().

Sets the text for the combobox text field.

For normal, editable comboboxes with a text entry field calling this method will generate a `wxEVT_TEXT` event, consistently with `wxTextCtrl:setValue/2` behaviour, use `wxTextCtrl:changeValue/2` if this is undesirable.

For controls with `wxCB_READONLY` style the method behaves somewhat differently: the string must be in the combobox choices list (the check for this is case-insensitive) and `wxEVT_TEXT` is `not` generated in this case.

# undo(This)

    -spec undo(This) -> ok when This :: wxComboBox().

If there is an undo facility and the last operation can be undone, undoes the last operation.

Does nothing if there is no undo facility.