phoenix_title wx.adv.EditableListBox

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

styles Window Styles

This class supports the following styles:

  • wx.adv.EL_ALLOW_NEW: Allows the user to enter new strings.

  • 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 emit its events.


class_hierarchy Class Hierarchy

Inheritance diagram for class EditableListBox:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


method_summary Methods Summary

__init__

Default constructor.

Create

Creates the editable listbox for two-step construction.

GetClassDefaultAttributes

GetDelButton

Returns a reference to the delete button used in the EditableListBox.

GetDownButton

Returns a reference to the down button used in the EditableListBox.

GetEditButton

Returns a reference to the edit button used in the EditableListBox.

GetListCtrl

Returns a reference to the listctrl used in the EditableListBox.

GetNewButton

Returns a reference to the new button used in the EditableListBox.

GetStrings

Returns a list of the current contents of the control.

GetUpButton

Returns a reference to the up button used in the EditableListBox.

SetStrings

Replaces current contents with given strings.


api Class API

class wx.adv.EditableListBox(Panel)

Possible constructors:

EditableListBox()

EditableListBox(parent, id=ID_ANY, label="", pos=DefaultPosition,
                size=DefaultSize, style=EL_DEFAULT_STYLE, name=EditableListBoxNameStr)

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


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.



__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 None.

  • 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.

See also

Create





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

Creates the editable listbox for two-step construction.

See wx.adv.EditableListBox for further details.

Parameters
  • parent (wx.Window) –

  • id (wx.WindowID) –

  • label (string) –

  • pos (wx.Point) –

  • size (wx.Size) –

  • style (long) –

  • name (string) –

Return type

bool



static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)
Parameters

variant (WindowVariant) –

Return type

VisualAttributes



GetDelButton(self)

Returns a reference to the delete button used in the EditableListBox.

Return type

BitmapButton



GetDownButton(self)

Returns a reference to the down button used in the EditableListBox.

Return type

BitmapButton



GetEditButton(self)

Returns a reference to the edit button used in the EditableListBox.

Return type

BitmapButton



GetListCtrl(self)

Returns a reference to the listctrl used in the EditableListBox.

Return type

ListCtrl



GetNewButton(self)

Returns a reference to the new button used in the EditableListBox.

Return type

BitmapButton



GetStrings(self)

Returns a list of the current contents of the control.

Return type

list of strings



GetUpButton(self)

Returns a reference to the up button used in the EditableListBox.

Return type

BitmapButton



SetStrings(self, strings)

Replaces current contents with given strings.

Parameters

strings (list of strings) –


Properties

DelButton

See GetDelButton



DownButton

See GetDownButton



EditButton

See GetEditButton



ListCtrl

See GetListCtrl



NewButton

See GetNewButton



Strings

See GetStrings and SetStrings



UpButton

See GetUpButton