/**
@class wxListBox
@wxheader{listbox.h}
-
+
A listbox is used to select one or more of a list of strings. The
strings are displayed in a scrolling box, with the selected string(s)
marked in reverse video. A listbox can be single selection (if an item
is selected, the previous selection is removed) or multiple selection
(clicking an item toggles the item on or off independently of other
selections).
-
+
List box elements are numbered from zero. Their number may be limited
under some platforms.
-
+
A listbox callback gets an event wxEVT_COMMAND_LISTBOX_SELECTED for single
clicks, and
wxEVT_COMMAND_LISTBOX_DOUBLE_CLICKED for double clicks.
-
+
@beginStyleTable
@style{wxLB_SINGLE}:
Single-selection list.
@style{wxLB_SORT}:
The listbox contents are sorted in alphabetical order.
@endStyleTable
-
+
@beginEventTable
@event{EVT_LISTBOX(id\, func)}:
Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the
listbox is double-clicked.
@endEventTable
-
+
@library{wxcore}
@category{ctrl}
@appearance{listbox.png}
-
+
@seealso
wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
*/
/**
Constructor, creating and showing a list box.
- @param parent
+ @param parent
Parent window. Must not be @NULL.
- @param id
+ @param id
Window identifier. The value wxID_ANY indicates a default value.
- @param pos
+ @param pos
Window position.
- @param size
+ @param size
Window size. If wxDefaultSize is specified then the window is sized
appropriately.
- @param n
+ @param n
Number of strings with which to initialise the control.
- @param choices
+ @param choices
An array of strings with which to initialise the control.
- @param style
+ @param style
Window style. See wxListBox.
- @param validator
+ @param validator
Window validator.
- @param name
+ @param name
Window name.
@sa Create(), wxValidator
*/
wxListBox();
- wxListBox(wxWindow* parent, wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- int n = 0,
- const wxString choices[] = @NULL,
- long style = 0,
- const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "listBox");
- wxListBox(wxWindow* parent, wxWindowID id,
- const wxPoint& pos,
- const wxSize& size,
- const wxArrayString& choices,
- long style = 0,
- const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "listBox");
+ wxListBox(wxWindow* parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ int n = 0,
+ const wxString choices[] = @NULL,
+ long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = "listBox");
+ wxListBox(wxWindow* parent, wxWindowID id,
+ const wxPoint& pos,
+ const wxSize& size,
+ const wxArrayString& choices,
+ long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = "listBox");
//@}
/**
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "listBox");
- bool Create(wxWindow* parent, wxWindowID id,
- const wxPoint& pos,
- const wxSize& size,
- const wxArrayString& choices,
- long style = 0,
- const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "listBox");
+ bool Create(wxWindow* parent, wxWindowID id,
+ const wxPoint& pos,
+ const wxSize& size,
+ const wxArrayString& choices,
+ long style = 0,
+ const wxValidator& validator = wxDefaultValidator,
+ const wxString& name = "listBox");
//@}
/**
Deselects an item in the list box.
- @param n
+ @param n
The zero-based item to deselect.
@remarks This applies to multiple selection listboxes only.
/**
Fill an array of ints with the positions of the currently selected items.
- @param selections
+ @param selections
A reference to an wxArrayInt instance that is used to store the result of the
query.
for wxMSW, wxMac and wxGTK2
ports.
- @param point
+ @param point
Point of item (in client coordinates) to obtain
@returns Item located at point, or wxNOT_FOUND if unimplemented or the
/**
Insert the given number of strings before the specified position.
- @param nItems
+ @param nItems
Number of items in the array items
- @param items
+ @param items
Labels of items to be inserted
- @param pos
+ @param pos
Position before which to insert the items: for example, if pos is 0 the items
will be inserted in the beginning of the listbox
*/
void InsertItems(int nItems, const wxString items,
unsigned int pos);
- void InsertItems(const wxArrayString& nItems,
- unsigned int pos);
+ void InsertItems(const wxArrayString& nItems,
+ unsigned int pos);
//@}
/**
Determines whether an item is selected.
- @param n
+ @param n
The zero-based item index.
@returns @true if the given item is selected, @false otherwise.
/**
Clears the list box and adds the given strings to it.
- @param n
+ @param n
The number of strings to set.
- @param choices
+ @param choices
An array of strings to set.
- @param clientData
+ @param clientData
Options array of client data pointers
@remarks You may free the array from the calling program after this
function has been called.
*/
void Set(int n, const wxString* choices, void clientData = @NULL);
- void Set(const wxArrayString& choices,
- void clientData = @NULL);
+ void Set(const wxArrayString& choices,
+ void clientData = @NULL);
//@}
//@{
/**
Set the specified item to be the first visible item.
- @param n
+ @param n
The zero-based item index.
- @param string
+ @param string
The string that should be visible.
*/
void SetFirstItem(int n);
- void SetFirstItem(const wxString& string);
+ void SetFirstItem(const wxString& string);
//@}
};
projects / wxWidgets.git / blobdiff