wxComboBox(3erl)

💅 wxComboBox(3erl) — Erlang Module Definition 💅

🌸 NAME 🌸

wxComboBox - Functions for wxComboBox class. Highkey iconic, no cap.

🦋 DESCRIPTION 🦋

okay so, no cap, a combobox is like a combination of an edit control and a listbox — literally a little combo meal of UI widgets 🍓.

It can be displayed as a 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 the wxCB_READONLY style. The way it switches up depending on platform and style is giving main character energy 💅.

A combobox permits a single selection only. No "choose five, bestie" chaos. 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). I'm obsessed with the options, but yes: all of those are not implemented in wx, noted 🫶.

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. That's a real warning, bestie — lowkey important 💀.

✨ Styles ✨

This class supports the following styles:

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

🌈 DATA TYPES 🌈

wxComboBox() = wx:wx_object()

🔥 EXPORTS 🔥

new/0 — default constructor 🌸

new() -> wxComboBox()

Default constructor.

new/2 — constructor with Parent and Id 🎀

new(Parent, Id) -> wxComboBox()

Types:

Parent = wxWindow:wxWindow()
Id = integer()

new/3 — constructor with options, slay ✨

new(Parent, Id, Options :: [Option]) -> wxComboBox()

Types:

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, wxValidator (not implemented in wx)

destroy/1 — destructor, bye-bye combobox 💀

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

Destructor, destroying the combobox.

create/7 — create it, no options edition 🦋

create(This, Parent, Id, Value, Pos, Size, Choices) -> boolean()

Types:

This = wxComboBox()
Parent = wxWindow:wxWindow()
Id = integer()
Value = unicode:chardata()
Pos = {X :: integer(), Y :: integer()}
Size = {W :: integer(), H :: integer()}
Choices = [unicode:chardata()]

create/8 — create it with options, periodt 💅

create(This, Parent, Id, Value, Pos, Size, Choices,
       Options :: [Option]) ->
          boolean()

Types:

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()}

canCopy/1 — clipboard vibe check for copy 📋

canCopy(This) -> boolean()

Types:

This = wxComboBox()

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

canCut/1 — clipboard vibe check for cut ✂️

canCut(This) -> boolean()

Types:

This = wxComboBox()

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

canPaste/1 — can we paste, bestie? 📋✨

canPaste(This) -> boolean()

Types:

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. So it's giving "maybe" energy on those platforms, iykyk.

canRedo/1 — redo facility check 🔁

canRedo(This) -> boolean()

Types:

This = wxComboBox()

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

canUndo/1 — undo facility check ↩️

canUndo(This) -> boolean()

Types:

This = wxComboBox()

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

copy/1 — copy selected text 🎀

copy(This) -> ok

Types:

This = wxComboBox()

Copies the selected text to the clipboard.

cut/1 — cut selected text ✂️

cut(This) -> ok

Types:

This = wxComboBox()

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

getInsertionPoint/1 — where's the cursor? 📍

getInsertionPoint(This) -> integer()

Types:

This = wxComboBox()

Same as wxTextCtrl:getInsertionPoint/1.

Note: Under wxMSW, this function always returns 0 if the combobox doesn't have the focus. That's the caveat, bestie — don't forget it 💀.

getLastPosition/1 — last text position, zero-based 🧮

getLastPosition(This) -> integer()

Types:

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/1 — get the contents 💖

getValue(This) -> unicode:charlist()

Types:

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. So cute, so cross-platform, so important to remember 🌈.

paste/1 — paste from clipboard 📋

paste(This) -> ok

Types:

This = wxComboBox()

Pastes text from the clipboard to the text item.

redo/1 — redo the last operation 🔁

redo(This) -> ok

Types:

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. Literally nothing. No drama, no error, just vibes.

replace/4 — replace text from From to To 🌸

replace(This, From, To, Value) -> ok

Types:

This = wxComboBox()
From = 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. Side-effect queen, honestly.

remove/3 — remove text from From to To 🧹

remove(This, From, To) -> ok

Types:

This = wxComboBox()
From = 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. Same side-effect energy, no cap.

setInsertionPoint/2 — put the cursor somewhere specific 📍

setInsertionPoint(This, Pos) -> ok

Types:

This = wxComboBox()
Pos = integer()

Sets the insertion point at the given position.

setInsertionPointEnd/1 — cursor to the end 🏁

setInsertionPointEnd(This) -> ok

Types:

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/2 — select item by number 🎯

setSelection(This, N) -> ok

Types:

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. It's giving quiet selection, no event spam 💅.

See: wxControlWithItems:setString/3, wxControlWithItems:setStringSelection/2

setSelection/3 — select text range ✨

setSelection(This, From, To) -> ok

Types:

This = wxComboBox()
From = To = integer()

Same as wxTextCtrl:setSelection/3.

setValue/2 — set the text field 🖊️

setValue(This, Text) -> ok

Types:

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. Read-only means read-only, bestie — respect the boundary 🫶.

undo/1 — undo the last operation ↩️

undo(This) -> ok

Types:

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. Again: no facility, no drama, no error.

---

🎀 cute sign-off 🎀 — from wxWidgets team. with version wx 2.2.2.1, page wxComboBox(3erl); no separate date shows up in this footer, so consider this your timestamp, bestie 💖✨