docs/latex/wx/listbox.tex

   1 \section{\class{wxListBox}}\label{wxlistbox}
   2
   3 A listbox is used to select one or more of a list of strings. The
   4 strings are displayed in a scrolling box, with the selected string(s)
   5 marked in reverse video. A listbox can be single selection (if an item
   6 is selected, the previous selection is removed) or multiple selection
   7 (clicking an item toggles the item on or off independently of other
   8 selections).
   9
  10 List box elements are numbered from zero. Their number is limited in
  11 some platforms (e.g. ca. 2000 on GTK).
  12
  13 A listbox callback gets an event wxEVT\_COMMAND\_LISTBOX\_SELECT for single clicks, and
  14 wxEVT\_COMMAND\_LISTBOX\_DOUBLE\_CLICKED for double clicks.
  15
  16 \wxheading{Derived from}
  17
  18 \helpref{wxControl}{wxcontrol}\\
  19 \helpref{wxWindow}{wxwindow}\\
  20 \helpref{wxEvtHandler}{wxevthandler}\\
  21 \helpref{wxObject}{wxobject}
  22
  23 \wxheading{Include files}
  24
  25 <wx/listbox.h>
  26
  27 \wxheading{Window styles}
  28
  29 \twocolwidtha{5cm}%
  30 \begin{twocollist}\itemsep=0pt
  31 \twocolitem{\windowstyle{wxLB\_SINGLE}}{Single-selection list.}
  32 \twocolitem{\windowstyle{wxLB\_MULTIPLE}}{Multiple-selection list: the user can toggle multiple
  33 items on and off.}
  34 \twocolitem{\windowstyle{wxLB\_EXTENDED}}{Extended-selection list: the user can
  35 select multiple items using the SHIFT key and the mouse or special key combinations.}
  36 \twocolitem{\windowstyle{wxLB\_HSCROLL}}{Create horizontal scrollbar if contents are too wide (Windows only).}
  37 \twocolitem{\windowstyle{wxLB\_ALWAYS\_SB}}{Always show a vertical scrollbar.}
  38 \twocolitem{\windowstyle{wxLB\_NEEDED\_SB}}{Only create a vertical scrollbar if needed.}
  39 \twocolitem{\windowstyle{wxLB\_SORT}}{The listbox contents are sorted in alphabetical order. No effect for GTK.}
  40 \end{twocollist}
  41
  42 See also \helpref{window styles overview}{windowstyles}.
  43
  44 \wxheading{Event handling}
  45
  46 \twocolwidtha{7cm}
  47 \begin{twocollist}\itemsep=0pt
  48 \twocolitem{{\bf EVT\_LISTBOX(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_SELECTED event,
  49 when an item on the list is selected.}
  50 \twocolitem{{\bf EVT\_LISTBOX\_DCLICK(id, func)}}{Process a wxEVT\_COMMAND\_LISTBOX\_DOUBLECLICKED event,
  51 when the listbox is doubleclicked.}
  52 \end{twocollist}
  53
  54 \wxheading{See also}
  55
  56 \helpref{wxChoice}{wxchoice}, \helpref{wxComboBox}{wxcombobox}, \helpref{wxListCtrl}{wxlistctrl},
  57 \rtfsp\helpref{wxCommandEvent}{wxcommandevent}
  58
  59 \latexignore{\rtfignore{\wxheading{Members}}}
  60
  61 \membersection{wxListBox::wxListBox}\label{wxlistboxconstr}
  62
  63 \func{}{wxListBox}{\void}
  64
  65 Default constructor.
  66
  67 \func{}{wxListBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
  68 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  69 \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
  70 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
  71
  72 Constructor, creating and showing a list box.
  73
  74 \wxheading{Parameters}
  75
  76 \docparam{parent}{Parent window. Must not be NULL.}
  77
  78 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
  79
  80 \docparam{pos}{Window position.}
  81
  82 \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
  83 appropriately.}
  84
  85 \docparam{n}{Number of strings with which to initialise the control.}
  86
  87 \docparam{choices}{An array of strings with which to initialise the control.}
  88
  89 \docparam{style}{Window style. See \helpref{wxListBox}{wxlistbox}.}
  90
  91 \docparam{validator}{Window validator.}
  92
  93 \docparam{name}{Window name.}
  94
  95 \wxheading{See also}
  96
  97 \helpref{wxListBox::Create}{wxlistboxcreate}, \helpref{wxValidator}{wxvalidator}
  98
  99 \pythonnote{The wxListBox constructor in wxPython reduces the \tt{n}
 100 and \tt{choices} arguments are to a single argument, which is
 101 a list of strings.}
 102
 103
 104
 105 \membersection{wxListBox::\destruct{wxListBox}}
 106
 107 \func{void}{\destruct{wxListBox}}{\void}
 108
 109 Destructor, destroying the list box.
 110
 111 \membersection{wxListBox::Append}\label{wxlistboxappend}
 112
 113 \func{void}{Append}{\param{const wxString\& }{ item}}
 114
 115 Adds the item to the end of the list box.
 116
 117 \func{void}{Append}{\param{const wxString\& }{ item}, \param{void* }{clientData}}
 118
 119 Adds the item to the end of the list box, associating the given data
 120 with the item.
 121
 122 \wxheading{Parameters}
 123
 124 \docparam{item}{String to add.}
 125
 126 \docparam{clientData}{Client data to associate with the item.}
 127
 128 \membersection{wxListBox::Clear}\label{wxlistboxclear}
 129
 130 \func{void}{Clear}{\void}
 131
 132 Clears all strings from the list box.
 133
 134 \membersection{wxListBox::Create}\label{wxlistboxcreate}
 135
 136 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 137 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
 138 \param{int}{ n}, \param{const wxString }{choices[] = NULL},\rtfsp
 139 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``listBox"}}
 140
 141 Creates the listbox for two-step construction. See \helpref{wxListBox::wxListBox}{wxlistboxconstr}\rtfsp
 142 for further details.
 143
 144 \membersection{wxListBox::Delete}\label{wxlistboxdelete}
 145
 146 \func{void}{Delete}{\param{int}{ n}}
 147
 148 Deletes an item from the listbox.
 149
 150 \wxheading{Parameters}
 151
 152 \docparam{n}{The zero-based item index.}
 153
 154 \membersection{wxListBox::Deselect}\label{wxlistboxdeselect}
 155
 156 \func{void}{Deselect}{\param{int}{ n}}
 157
 158 Deselects an item in the list box.
 159
 160 \wxheading{Parameters}
 161
 162 \docparam{n}{The zero-based item to deselect.}
 163
 164 \wxheading{Remarks}
 165
 166 This applies to multiple selection listboxes only.
 167
 168 \membersection{wxListBox::FindString}\label{wxlistboxfindstring}
 169
 170 \func{int}{FindString}{\param{const wxString\& }{string}}
 171
 172 Finds an item matching the given string.
 173
 174 \wxheading{Parameters}
 175
 176 \docparam{string}{String to find.}
 177
 178 \wxheading{Return value}
 179
 180 The zero-based position of the item, or -1 if the string was not found.
 181
 182 \membersection{wxListBox::GetClientData}\label{wxlistboxgetclientdata}
 183
 184 \constfunc{void*}{GetClientData}{\param{int}{ n}}
 185
 186 Returns a pointer to the client data associated with the given item (if any).
 187
 188 \wxheading{Parameters}
 189
 190 \docparam{n}{The zero-based position of the item.}
 191
 192 \wxheading{Return value}
 193
 194 A pointer to the client data, or NULL if not present.
 195
 196 \membersection{wxListBox::GetSelection}\label{wxlistboxgetselection}
 197
 198 \constfunc{int}{GetSelection}{\void}
 199
 200 Gets the position of the selected item.
 201
 202 \wxheading{Return value}
 203
 204 The position of the current selection.
 205
 206 \wxheading{Remarks}
 207
 208 Applicable to single selection list boxes only.
 209
 210 \wxheading{See also}
 211
 212 \helpref{wxListBox::SetSelection}{wxlistboxsetselection},\rtfsp
 213 \helpref{wxListBox::GetStringSelection}{wxlistboxgetstringselection},\rtfsp
 214 \helpref{wxListBox::GetSelections}{wxlistboxgetselections}
 215
 216 \membersection{wxListBox::GetSelections}\label{wxlistboxgetselections}
 217
 218 \constfunc{int}{GetSelections}{\param{wxArrayInt& }{selections}}
 219
 220 Fill an array of ints with the positions of the currently selected items.
 221
 222 \wxheading{Parameters}
 223
 224 \docparam{selections}{A reference to an wxArrayInt instance that is used to store the result of the query.}
 225
 226 \wxheading{Return value}
 227
 228 The number of selections.
 229
 230 \wxheading{Remarks}
 231
 232 Use this with a multiple selection listbox.
 233
 234 \wxheading{See also}
 235
 236 \helpref{wxListBox::GetSelection}{wxlistboxgetselection},\rtfsp
 237 \helpref{wxListBox::GetStringSelection}{wxlistboxgetstringselection},\rtfsp
 238 \helpref{wxListBox::SetSelection}{wxlistboxsetselection}
 239
 240 \pythonnote{The wxPython version of this method takes no parameters
 241 and returns a tuple of the selected items.}
 242
 243 \membersection{wxListBox::GetString}\label{wxlistboxgetstring}
 244
 245 \constfunc{wxString}{GetString}{\param{int}{ n}}
 246
 247 Returns the string at the given position.
 248
 249 \wxheading{Parameters}
 250
 251 \docparam{n}{The zero-based position.}
 252
 253 \wxheading{Return value}
 254
 255 The string, or an empty string if the position was invalid.
 256
 257 \membersection{wxListBox::GetStringSelection}\label{wxlistboxgetstringselection}
 258
 259 \constfunc{wxString}{GetStringSelection}{\void}
 260
 261 Gets the selected string - for single selection list boxes only. This
 262 must be copied by the calling program if long term use is to be made of
 263 it.
 264
 265 \wxheading{See also}
 266
 267 \helpref{wxListBox::GetSelection}{wxlistboxgetselection},\rtfsp
 268 \helpref{wxListBox::GetSelections}{wxlistboxgetselections},\rtfsp
 269 \helpref{wxListBox::SetSelection}{wxlistboxsetselection}
 270
 271 \membersection{wxListBox::InsertItems}\label{wxlistboxinsertitems}
 272
 273 \func{void}{InsertItems}{\param{int}{ nItems}, \param{const wxString}{ items}, \param{int}{ pos}}
 274
 275 Insert the given number of strings before the specified position.
 276
 277 \wxheading{Parameters}
 278
 279 \docparam{nItems}{Number of items in the array {\it items}}
 280
 281 \docparam{items}{Labels of items to be inserted}
 282
 283 \docparam{pos}{Position before which to insert the items: for example, if {\it pos} is 0 the items
 284 will be inserted in the beginning of the listbox}
 285
 286 \pythonnote{The first two parameters are collapsed into a single
 287 parameter for wxPython, which is a list of strings.}
 288
 289 \membersection{wxListBox::Number}\label{wxlistboxnumber}
 290
 291 \constfunc{int}{Number}{\void}
 292
 293 Returns the number of items in the listbox.
 294
 295 \membersection{wxListBox::Selected}\label{wxlistboxselected}
 296
 297 \constfunc{bool}{Selected}{\param{int}{ n}}
 298
 299 Determines whether an item is selected.
 300
 301 \wxheading{Parameters}
 302
 303 \docparam{n}{The zero-based item index.}
 304
 305 \wxheading{Return value}
 306
 307 TRUE if the given item is selected, FALSE otherwise.
 308
 309 \membersection{wxListBox::Set}\label{wxlistboxset}
 310
 311 \func{void}{Set}{\param{int}{ n}, \param{const wxString*}{ choices}}
 312
 313 Clears the list box and adds the given strings. Not implemented for GTK.
 314
 315 \wxheading{Parameters}
 316
 317 \docparam{n}{The number of strings to set.}
 318
 319 \docparam{choices}{An array of strings to set.}
 320
 321 \wxheading{Remarks}
 322
 323 Deallocate the array from the calling program
 324 after this function has been called.
 325
 326 \membersection{wxListBox::SetClientData}\label{wxlistboxsetclientdata}
 327
 328 \func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}}
 329
 330 Associates the given client data pointer with the given item.
 331
 332 \wxheading{Parameters}
 333
 334 \docparam{n}{The zero-based item index.}
 335
 336 \docparam{data}{The client data to associate with the item.}
 337
 338 \membersection{wxListBox::SetFirstItem}\label{wxlistboxsetfirstitem}
 339
 340 \func{void}{SetFirstItem}{\param{int}{ n}}
 341
 342 \func{void}{SetFirstItem}{\param{const wxString\& }{string}}
 343
 344 Set the specified item to be the first visible item. Windows only.
 345
 346 \wxheading{Parameters}
 347
 348 \docparam{n}{The zero-based item index.}
 349
 350 \docparam{string}{The string that should be visible.}
 351
 352 \membersection{wxListBox::SetSelection}\label{wxlistboxsetselection}
 353
 354 \func{void}{SetSelection}{\param{int}{ n}, \param{const bool }{select = TRUE}}
 355
 356 Selects or deselects the given item. This does not cause a
 357 wxEVT\_COMMAND\_LISTBOX\_SELECT event to get emitted.
 358
 359 \wxheading{Parameters}
 360
 361 \docparam{n}{The zero-based item index.}
 362
 363 \docparam{select}{If TRUE, will select the item. If FALSE, will deselect it.}
 364
 365 \membersection{wxListBox::SetString}\label{wxlistboxsetstring}
 366
 367 \func{void}{SetString}{\param{int}{ n}, \param{const wxString\& }{ string}}
 368
 369 Sets the string value of an item.
 370
 371 \wxheading{Parameters}
 372
 373 \docparam{n}{The zero-based item index.}
 374
 375 \docparam{string}{The string to set.}
 376
 377 \membersection{wxListBox::SetStringSelection}\label{wxlistboxsetstringselection}
 378
 379 \func{void}{SetStringSelection}{\param{const wxString\& }{ string}, \param{const bool}{ select = TRUE}}
 380
 381 Sets the current selection. This does not cause a
 382 wxEVT\_COMMAND\_LISTBOX\_SELECT event to get emitted.
 383
 384 \wxheading{Parameters}
 385
 386 \docparam{string}{The item to select.}
 387
 388 \docparam{select}{If TRUE, will select the item. If FALSE, will deselect it.}
 389