wx.adv.EditableListBox¶

An editable listbox is composite control that lets the user easily enter, delete and reorder a list of strings.

Window Styles¶

This class supports the following styles:

wx.adv.EL_ALLOW_NEW: Allows the user to enter new strings (implies wx.adv.EL_ALLOW_EDIT as well).
wx.adv.EL_ALLOW_EDIT: Allows the user to edit existing strings.
wx.adv.EL_ALLOW_DELETE: Allows the user to delete existing strings.
wx.adv.EL_NO_REORDER: Does not allow the user to reorder the strings.
wx.adv.EL_DEFAULT_STYLE: Default style: EL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE.

The control uses a wx.ListCtrl internally and emits its events.

You may bind events directly to these internal buttons (e.g., wxEVT_BUTTON ) to intercept or augment default behavior. To add custom validation before an action occurs, bind to the button and call event.Skip() only if validation passes. To completely override the default behavior, omit the call to event.Skip() .

Note

This control provides access to its internal components (e.g., GetNewButton , GetListCtrl ) for advanced customization.

Class Hierarchy¶

Inheritance diagram for class EditableListBox:

Control Appearance¶

Methods Summary¶

`__init__`	Default constructor.
`Create`	Creates the editable listbox for two-step construction.
`GetClassDefaultAttributes`
`GetDelButton`	Returns the button used to delete the selected item from the list.
`GetDownButton`	Returns the button used to move the selected item down in the list.
`GetEditButton`	Returns the button used to edit the label of the selected item.
`GetListCtrl`	Returns the internal list control used by the editable list box.
`GetNewButton`	Returns the button used to add a new item to the list.
`GetStrings`	Returns a list of the current contents of the control.
`GetUpButton`	Returns the button used to move the selected item up in the list.
`SetStrings`	Replaces current contents with given strings.

Properties Summary¶

`DelButton`	See `GetDelButton`
`DownButton`	See `GetDownButton`
`EditButton`	See `GetEditButton`
`ListCtrl`	See `GetListCtrl`
`NewButton`	See `GetNewButton`
`Strings`	See `GetStrings` and `SetStrings`
`UpButton`	See `GetUpButton`

Class API¶

class wx.adv.EditableListBox(Panel)¶

Possible constructors:

EditableListBox() -> None

EditableListBox(parent, id=ID_ANY, label='', pos=DefaultPosition,
                size=DefaultSize, style=EL_DEFAULT_STYLE, name=EditableListBoxNameStr)
                -> None

An editable listbox is composite control that lets the user easily enter, delete and reorder a list of strings.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

Return type:: None

__init__ (self, parent, id=ID_ANY, label=’’, pos=DefaultPosition, size=DefaultSize, style=EL_DEFAULT_STYLE, name=EditableListBoxNameStr)

Constructor, creating and showing a list box.

Parameters:

parent (wx.Window) – Parent window. Must not be nullptr.
id (wx.WindowID) – Window identifier. The value wx.ID_ANY indicates a default value.
label (string) – The text shown just before the list control.
pos (wx.Point) – Window position. If wx.DefaultPosition is specified then a default position is chosen.
size (wx.Size) – Window size. If wx.DefaultSize is specified then the window is sized appropriately.
style (long) – Window style. See wx.adv.EditableListBox.
name (string) – Window name.

Return type: