// Purpose: interface of wxListBox
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Always show a vertical scrollbar.
@style{wxLB_NEEDED_SB}
Only create a vertical scrollbar if needed.
+ @style{wxLB_NO_SB}
+ Don't create vertical scrollbar (wxMSW only).
@style{wxLB_SORT}
The listbox contents are sorted in alphabetical order.
@endStyleTable
@beginEventEmissionTable{wxCommandEvent}
@event{EVT_LISTBOX(id, func)}
- Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
+ Process a @c wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
list is selected or the selection changes.
@event{EVT_LISTBOX_DCLICK(id, func)}
- Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the listbox
+ Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox
is double-clicked.
@endEventTable
The ID of this control. A value of @c wxID_ANY indicates a default value.
@param pos
The initial position.
+ If ::wxDefaultPosition is specified then a default position is chosen.
@param size
The initial size.
- If wxDefaultSize is specified then the window is sized appropriately.
+ If ::wxDefaultSize is specified then the window is sized appropriately.
@param n
Number of strings with which to initialise the control.
@param choices
The validator for this control.
@param name
The name of this class.
+
+ @beginWxPerlOnly
+ Not supported by wxPerl.
+ @endWxPerlOnly
*/
wxListBox(wxWindow* parent, wxWindowID id,
See the other wxListBox() constructor; the only difference is that
this overload takes a wxArrayString instead of a pointer to an array
of wxString.
+
+ @beginWxPerlOnly
+ Use an array reference for the @a choices parameter.
+ @endWxPerlOnly
*/
wxListBox(wxWindow* parent, wxWindowID id,
@remarks Use this with a multiple selection listbox.
+ @beginWxPerlOnly
+ In wxPerl this method takes no parameters and return the
+ selected items as a list.
+ @endWxPerlOnly
+
@see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection,
wxControlWithItems::SetSelection
*/
@param pos
Position before which to insert the items: if pos is 0 the
items will be inserted in the beginning of the listbox
+
+ @beginWxPerlOnly
+ Not supported by wxPerl.
+ @endWxPerlOnly
*/
void InsertItems(unsigned int nItems, const wxString *items,
unsigned int pos);
@param pos
Position before which to insert the items: if pos is @c 0 the
items will be inserted in the beginning of the listbox
+
+ @beginWxPerlOnly
+ Use an array reference for the @a items parameter.
+ @endWxPerlOnly
*/
void InsertItems(const wxArrayString& items,
unsigned int pos);