1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxEditableListBox
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 @class wxEditableListBox
12 An editable listbox is composite control that lets the user easily enter,
13 delete and reorder a list of strings.
16 @style{wxEL_ALLOW_NEW}
17 Allows the user to enter new strings.
18 @style{wxEL_ALLOW_EDIT}
19 Allows the user to edit existing strings.
20 @style{wxEL_ALLOW_DELETE}
21 Allows the user to delete existing strings.
22 @style{wxEL_NO_REORDER}
23 Does not allow the user to reorder the strings.
24 @style{wxEL_DEFAULT_STYLE}
25 Default style: wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE.
28 The control uses a wxListCtrl internally and emit its events.
33 @see wxListBox, wxListCtrl
35 class wxEditableListBox
: public wxPanel
44 Constructor, creating and showing a list box.
47 Parent window. Must not be @NULL.
49 Window identifier. The value wxID_ANY indicates a default value.
51 The text shown just before the list control.
54 If ::wxDefaultPosition is specified then a default position is chosen.
57 If ::wxDefaultSize is specified then the window is sized appropriately.
59 Window style. See wxEditableListBox.
65 wxEditableListBox(wxWindow
* parent
, wxWindowID id
,
66 const wxString
& label
,
67 const wxPoint
& pos
= wxDefaultPosition
,
68 const wxSize
& size
= wxDefaultSize
,
69 long style
= wxEL_DEFAULT_STYLE
,
70 const wxString
& name
= wxEditableListBoxNameStr
);
73 Destructor, destroying the list box.
75 virtual ~wxEditableListBox();
78 Creates the editable listbox for two-step construction.
79 See wxEditableListBox() for further details.
81 bool Create(wxWindow
* parent
, wxWindowID id
, const wxString
& label
,
82 const wxPoint
& pos
= wxDefaultPosition
,
83 const wxSize
& size
= wxDefaultSize
,
84 long style
= wxEL_DEFAULT_STYLE
,
85 const wxString
& name
= wxEditableListBoxNameStr
);
88 Replaces current contents with given strings.
90 void SetStrings(const wxArrayString
& strings
);
94 Returns in the given array the current contents of the control
95 (the array will be erased before control's contents are appended).
97 void GetStrings(wxArrayString
& strings
) const;