interface/listbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listbox.h
   3 // Purpose:     documentation for wxListBox class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxListBox
  11     @wxheader{listbox.h}
  12
  13     A listbox is used to select one or more of a list of strings. The
  14     strings are displayed in a scrolling box, with the selected string(s)
  15     marked in reverse video. A listbox can be single selection (if an item
  16     is selected, the previous selection is removed) or multiple selection
  17     (clicking an item toggles the item on or off independently of other
  18     selections).
  19
  20     List box elements are numbered from zero. Their number may be limited
  21     under some platforms.
  22
  23     A listbox callback gets an event wxEVT_COMMAND_LISTBOX_SELECTED for single
  24     clicks, and
  25     wxEVT_COMMAND_LISTBOX_DOUBLE_CLICKED for double clicks.
  26
  27     @beginStyleTable
  28     @style{wxLB_SINGLE}:
  29            Single-selection list.
  30     @style{wxLB_MULTIPLE}:
  31            Multiple-selection list: the user can toggle multiple items on and
  32            off.
  33     @style{wxLB_EXTENDED}:
  34            Extended-selection list: the user can select multiple items using
  35            the SHIFT key and the mouse or special key combinations.
  36     @style{wxLB_HSCROLL}:
  37            Create horizontal scrollbar if contents are too wide (Windows only).
  38     @style{wxLB_ALWAYS_SB}:
  39            Always show a vertical scrollbar.
  40     @style{wxLB_NEEDED_SB}:
  41            Only create a vertical scrollbar if needed.
  42     @style{wxLB_SORT}:
  43            The listbox contents are sorted in alphabetical order.
  44     @endStyleTable
  45
  46     @beginEventTable
  47     @event{EVT_LISTBOX(id, func)}:
  48            Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
  49            list is selected or the selection changes.
  50     @event{EVT_LISTBOX_DCLICK(id, func)}:
  51            Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the
  52            listbox is double-clicked.
  53     @endEventTable
  54
  55     @library{wxcore}
  56     @category{ctrl}
  57     @appearance{listbox.png}
  58
  59     @seealso
  60     wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
  61 */
  62 class wxListBox : public wxControlWithItems
  63 {
  64 public:
  65     //@{
  66     /**
  67         Constructor, creating and showing a list box.
  68
  69         @param parent
  70             Parent window. Must not be @NULL.
  71         @param id
  72             Window identifier. The value wxID_ANY indicates a default value.
  73         @param pos
  74             Window position.
  75         @param size
  76             Window size. If wxDefaultSize is specified then the window is
  77         sized
  78             appropriately.
  79         @param n
  80             Number of strings with which to initialise the control.
  81         @param choices
  82             An array of strings with which to initialise the control.
  83         @param style
  84             Window style. See wxListBox.
  85         @param validator
  86             Window validator.
  87         @param name
  88             Window name.
  89
  90         @see Create(), wxValidator
  91     */
  92     wxListBox();
  93     wxListBox(wxWindow* parent, wxWindowID id,
  94               const wxPoint& pos = wxDefaultPosition,
  95               const wxSize& size = wxDefaultSize,
  96               int n = 0,
  97               const wxString choices[] = NULL,
  98               long style = 0,
  99               const wxValidator& validator = wxDefaultValidator,
 100               const wxString& name = "listBox");
 101     wxListBox(wxWindow* parent, wxWindowID id,
 102               const wxPoint& pos,
 103               const wxSize& size,
 104               const wxArrayString& choices,
 105               long style = 0,
 106               const wxValidator& validator = wxDefaultValidator,
 107               const wxString& name = "listBox");
 108     //@}
 109
 110     /**
 111         Destructor, destroying the list box.
 112     */
 113     ~wxListBox();
 114
 115     //@{
 116     /**
 117         Creates the listbox for two-step construction. See wxListBox()
 118         for further details.
 119     */
 120     bool Create(wxWindow* parent, wxWindowID id,
 121                 const wxPoint& pos = wxDefaultPosition,
 122                 const wxSize& size = wxDefaultSize,
 123                 int n,
 124                 const wxString choices[] = NULL,
 125                 long style = 0,
 126                 const wxValidator& validator = wxDefaultValidator,
 127                 const wxString& name = "listBox");
 128     bool Create(wxWindow* parent, wxWindowID id,
 129                 const wxPoint& pos,
 130                 const wxSize& size,
 131                 const wxArrayString& choices,
 132                 long style = 0,
 133                 const wxValidator& validator = wxDefaultValidator,
 134                 const wxString& name = "listBox");
 135     //@}
 136
 137     /**
 138         Deselects an item in the list box.
 139
 140         @param n
 141             The zero-based item to deselect.
 142
 143         @remarks This applies to multiple selection listboxes only.
 144     */
 145     void Deselect(int n);
 146
 147     /**
 148         Fill an array of ints with the positions of the currently selected items.
 149
 150         @param selections
 151             A reference to an wxArrayInt instance that is used to store the result of
 152         the query.
 153
 154         @returns The number of selections.
 155
 156         @remarks Use this with a multiple selection listbox.
 157
 158         @see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection,
 159              wxControlWithItems::SetSelection
 160     */
 161     int GetSelections(wxArrayInt& selections);
 162
 163     /**
 164         Returns the item located at @e point, or @c wxNOT_FOUND if there
 165         is no item located at @e point.
 166         This function is new since wxWidgets version 2.7.0. It is currently implemented
 167         for wxMSW, wxMac and wxGTK2
 168         ports.
 169
 170         @param point
 171             Point of item (in client coordinates) to obtain
 172
 173         @returns Item located at point, or wxNOT_FOUND if unimplemented or the
 174                  item does not exist.
 175     */
 176     int HitTest(const wxPoint point);
 177
 178     //@{
 179     /**
 180         Insert the given number of strings before the specified position.
 181
 182         @param nItems
 183             Number of items in the array items
 184         @param items
 185             Labels of items to be inserted
 186         @param pos
 187             Position before which to insert the items: for example, if pos is 0 the
 188         items
 189             will be inserted in the beginning of the listbox
 190     */
 191     void InsertItems(int nItems, const wxString items,
 192                      unsigned int pos);
 193     void InsertItems(const wxArrayString& nItems,
 194                      unsigned int pos);
 195     //@}
 196
 197     /**
 198         Determines whether an item is selected.
 199
 200         @param n
 201             The zero-based item index.
 202
 203         @returns @true if the given item is selected, @false otherwise.
 204     */
 205     bool IsSelected(int n);
 206
 207     //@{
 208     /**
 209         Clears the list box and adds the given strings to it.
 210
 211         @param n
 212             The number of strings to set.
 213         @param choices
 214             An array of strings to set.
 215         @param clientData
 216             Options array of client data pointers
 217
 218         @remarks You may free the array from the calling program after this
 219                  function has been called.
 220     */
 221     void Set(int n, const wxString* choices, void clientData = NULL);
 222     void Set(const wxArrayString& choices,
 223              void clientData = NULL);
 224     //@}
 225
 226     //@{
 227     /**
 228         Set the specified item to be the first visible item.
 229
 230         @param n
 231             The zero-based item index.
 232         @param string
 233             The string that should be visible.
 234     */
 235     void SetFirstItem(int n);
 236     void SetFirstItem(const wxString& string);
 237     //@}
 238 };