docs/latex/wx/combobox.tex

   1 \section{\class{wxComboBox}}\label{wxcombobox}
   2
   3 A combobox is like a combination of an edit control and a listbox. It can be
   4 displayed as static list with editable or read-only text field; or a drop-down list with
   5 text field; or a drop-down list without a text field.
   6
   7 A combobox permits a single selection only. Combobox items are numbered from zero.
   8
   9 \wxheading{Derived from}
  10
  11 \helpref{wxChoice}{wxchoice}\\
  12 \helpref{wxControl}{wxcontrol}\\
  13 \helpref{wxWindow}{wxwindow}\\
  14 \helpref{wxEvtHandler}{wxevthandler}\\
  15 \helpref{wxObject}{wxobject}
  16
  17 \wxheading{Include files}
  18
  19 <wx/combobox.h>
  20
  21 \wxheading{Window styles}
  22
  23 \begin{twocollist}\itemsep=0pt
  24 \twocolitem{\windowstyle{wxCB\_SIMPLE}}{Creates a combobox with a permanently displayed list. Windows only. }
  25 \twocolitem{\windowstyle{wxCB\_DROPDOWN}}{Creates a combobox with a drop-down list.}
  26 \twocolitem{\windowstyle{wxCB\_READONLY}}{Same as wxCB\_DROPDOWN but only the
  27 strings specified as the combobox choices can be selected, it is impossible to
  28 select (even from a program) a string which is not in the choices list.}
  29 \twocolitem{\windowstyle{wxCB\_SORT}}{Sorts the entries in the list alphabetically.}
  30 \end{twocollist}
  31
  32 See also \helpref{window styles overview}{windowstyles}.
  33
  34 \wxheading{Event handling}
  35
  36 \twocolwidtha{7cm}
  37 \begin{twocollist}\itemsep=0pt
  38 \twocolitem{{\bf EVT\_COMBOBOX(id, func)}}{Process a wxEVT\_COMMAND\_COMBOBOX\_SELECTED event,
  39 when an item on the list is selected.}
  40 \twocolitem{{\bf EVT\_TEXT(id, func)}}{Process a wxEVT\_COMMAND\_TEXT\_UPDATED event,
  41 when the combobox text changes.}
  42 \end{twocollist}
  43
  44 \wxheading{See also}
  45
  46 \helpref{wxListBox}{wxlistbox}, \helpref{wxTextCtrl}{wxtextctrl}, \helpref{wxChoice}{wxchoice},
  47 \rtfsp\helpref{wxCommandEvent}{wxcommandevent}
  48
  49 \latexignore{\rtfignore{\wxheading{Members}}}
  50
  51 \membersection{wxComboBox::wxComboBox}\label{wxcomboboxconstr}
  52
  53 \func{}{wxComboBox}{\void}
  54
  55 Default constructor.
  56
  57 \func{}{wxComboBox}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
  58 \param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  59 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
  60 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}}
  61
  62 Constructor, creating and showing a combobox.
  63
  64 \wxheading{Parameters}
  65
  66 \docparam{parent}{Parent window. Must not be NULL.}
  67
  68 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
  69
  70 \docparam{pos}{Window position.}
  71
  72 \docparam{size}{Window size. If the default size (-1, -1) is specified then the window is sized
  73 appropriately.}
  74
  75 \docparam{n}{Number of strings with which to initialise the control.}
  76
  77 \docparam{choices}{An array of strings with which to initialise the control.}
  78
  79 \docparam{style}{Window style. See \helpref{wxComboBox}{wxcombobox}.}
  80
  81 \docparam{validator}{Window validator.}
  82
  83 \docparam{name}{Window name.}
  84
  85 \wxheading{See also}
  86
  87 \helpref{wxComboBox::Create}{wxcomboboxcreate}, \helpref{wxValidator}{wxvalidator}
  88
  89 \pythonnote{The wxComboBox constructor in wxPython reduces the {\tt n}
  90 and {\tt choices} arguments are to a single argument, which is
  91 a list of strings.}
  92
  93 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
  94 and {\tt choices}.}
  95
  96 \membersection{wxComboBox::\destruct{wxComboBox}}
  97
  98 \func{}{\destruct{wxComboBox}}{\void}
  99
 100 Destructor, destroying the combobox.
 101
 102 \membersection{wxComboBox::Append}\label{wxcomboboxappend}
 103
 104 \func{void}{Append}{\param{const wxString\& }{item}}
 105
 106 Adds the item to the end of the combobox.
 107
 108 \func{void}{Append}{\param{const wxString\& }{ item}, \param{void* }{clientData}}
 109
 110 Adds the item to the end of the combobox, associating the given data
 111 with the item.
 112
 113 \wxheading{Parameters}
 114
 115 \docparam{item}{The string to add.}
 116
 117 \docparam{clientData}{Client data to associate with the item.}
 118
 119 \membersection{wxComboBox::Clear}\label{wxcomboboxclear}
 120
 121 \func{void}{Clear}{\void}
 122
 123 Clears all strings from the combobox.
 124
 125 \membersection{wxComboBox::Create}\label{wxcomboboxcreate}
 126
 127 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id},\rtfsp
 128 \param{const wxString\& }{value = ``"}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
 129 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
 130 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``comboBox"}}
 131
 132 Creates the combobox for two-step construction. Derived classes
 133 should call or replace this function. See \helpref{wxComboBox::wxComboBox}{wxcomboboxconstr}\rtfsp
 134 for further details.
 135
 136 \membersection{wxComboBox::Copy}\label{wxcomboboxcopy}
 137
 138 \func{void}{Copy}{\void}
 139
 140 Copies the selected text to the clipboard.
 141
 142 \membersection{wxComboBox::Cut}\label{wxcomboboxcut}
 143
 144 \func{void}{Cut}{\void}
 145
 146 Copies the selected text to the clipboard and removes the selection.
 147
 148 \membersection{wxComboBox::Delete}\label{wxcomboboxdelete}
 149
 150 \func{void}{Delete}{\param{int}{ n}}
 151
 152 Deletes an item from the combobox.
 153
 154 \wxheading{Parameters}
 155
 156 \docparam{n}{The item to delete, starting from zero.}
 157
 158 \membersection{wxComboBox::FindString}\label{wxcomboboxfindstring}
 159
 160 \func{int}{FindString}{\param{const wxString\& }{string}}
 161
 162 Finds a choice matching the given string.
 163
 164 \wxheading{Parameters}
 165
 166 \docparam{string}{The item to find.}
 167
 168 \wxheading{Return value}
 169
 170 The position if found, or -1 if not found.
 171
 172 \membersection{wxComboBox::GetClientData}\label{wxcomboboxgetclientdata}
 173
 174 \constfunc{void*}{GetClientData}{\param{int}{ n}}
 175
 176 Returns a pointer to the client data associated with the given item (if any).
 177
 178 \wxheading{Parameters}
 179
 180 \docparam{n}{An item, starting from zero.}
 181
 182 \wxheading{Return value}
 183
 184 A pointer to the client data, or NULL if the item was not found.
 185
 186 \membersection{wxComboBox::GetInsertionPoint}\label{wxcomboboxgetinsertionpoint}
 187
 188 \constfunc{long}{GetInsertionPoint}{\void}
 189
 190 Returns the insertion point for the combobox's text field.
 191
 192 \membersection{wxComboBox::GetLastPosition}\label{wxcomboboxgetlastposition}
 193
 194 \constfunc{long}{GetLastPosition}{\void}
 195
 196 Returns the last position in the combobox text field.
 197
 198 \membersection{wxComboBox::GetSelection}\label{wxcomboboxgetselection}
 199
 200 \constfunc{int}{GetSelection}{\void}
 201
 202 Gets the position of the selected string, or -1 if there is no selection.
 203
 204 \membersection{wxComboBox::GetString}\label{wxcomboboxgetstring}
 205
 206 \constfunc{wxString}{GetString}{\param{int}{ n}}
 207
 208 Returns the string at position {\it n}.
 209
 210 \wxheading{Parameters}
 211
 212 \docparam{n}{The item position, starting from zero.}
 213
 214 \wxheading{Return value}
 215
 216 The string if the item is found, otherwise the empty string.
 217
 218 \membersection{wxComboBox::GetStringSelection}\label{wxcomboboxgetstringselection}
 219
 220 \constfunc{wxString}{GetStringSelection}{\void}
 221
 222 Gets the selected string.
 223
 224 \membersection{wxComboBox::GetValue}\label{wxcomboboxgetvalue}
 225
 226 \constfunc{wxString}{GetValue}{\void}
 227
 228 Returns the current value in the combobox text field.
 229
 230 \membersection{wxComboBox::Number}\label{wxcomboboxnumber}
 231
 232 \constfunc{int}{Number}{\void}
 233
 234 Returns the number of items in the combobox list.
 235 %TODO: make this GetNumber or GetCount?
 236
 237 \membersection{wxComboBox::Paste}\label{wxcomboboxpaste}
 238
 239 \func{void}{Paste}{\void}
 240
 241 Pastes text from the clipboard to the text field.
 242
 243 \membersection{wxComboBox::Replace}\label{wxcomboboxreplace}
 244
 245 \func{void}{Replace}{\param{long}{ from}, \param{long}{ to}, \param{const wxString\& }{text}}
 246
 247 Replaces the text between two positions with the given text, in the combobox text field.
 248
 249 \wxheading{Parameters}
 250
 251 \docparam{from}{The first position.}
 252
 253 \docparam{to}{The second position.}
 254
 255 \docparam{text}{The text to insert.}
 256
 257 \membersection{wxComboBox::Remove}\label{wxcomboboxremove}
 258
 259 \func{void}{Remove}{\param{long}{ from}, \param{long}{ to}}
 260
 261 Removes the text between the two positions in the combobox text field.
 262
 263 \wxheading{Parameters}
 264
 265 \docparam{from}{The first position.}
 266
 267 \docparam{to}{The last position.}
 268
 269 \membersection{wxComboBox::SetClientData}\label{wxcomboboxsetclientdata}
 270
 271 \func{void}{SetClientData}{\param{int}{ n}, \param{void* }{data}}
 272
 273 Associates the given client data pointer with the given item.
 274
 275 \wxheading{Parameters}
 276
 277 \docparam{n}{The zero-based item.}
 278
 279 \docparam{data}{The client data.}
 280
 281 \membersection{wxComboBox::SetInsertionPoint}\label{wxcomboboxsetinsertionpoint}
 282
 283 \func{void}{SetInsertionPoint}{\param{long}{ pos}}
 284
 285 Sets the insertion point in the combobox text field.
 286
 287 \wxheading{Parameters}
 288
 289 \docparam{pos}{The new insertion point.}
 290
 291 \membersection{wxComboBox::SetInsertionPointEnd}\label{wxcomboboxsetinsertionpointend}
 292
 293 \func{void}{SetInsertionPointEnd}{\void}
 294
 295 Sets the insertion point at the end of the combobox text field.
 296
 297 \membersection{wxComboBox::SetSelection}\label{wxcomboboxsetselection}
 298
 299 \func{void}{SetSelection}{\param{int}{ n}}
 300
 301 Selects the given item in the combobox list. This does not cause a
 302 wxEVT\_COMMAND\_COMBOBOX\_SELECTED event to get emitted.
 303
 304 \func{void}{SetSelection}{\param{long}{ from}, \param{long}{ to}}
 305
 306 Selects the text between the two positions, in the combobox text field.
 307
 308 \wxheading{Parameters}
 309
 310 \docparam{n}{The zero-based item to select.}
 311
 312 \docparam{from}{The first position.}
 313
 314 \docparam{to}{The second position.}
 315
 316 \pythonnote{The second form of this method is called {\tt SetMark} in
 317 wxPython.}
 318
 319 \membersection{wxComboBox::SetValue}\label{wxcomboboxsetvalue}
 320
 321 \func{void}{SetValue}{\param{const wxString\& }{text}}
 322
 323 Sets the text for the combobox text field.
 324
 325 {\bf NB:} For a combobox with {\tt wxCB\_READONLY} style the string must be in
 326 the combobox choices list, otherwise the call to SetValue() is ignored.
 327
 328 \wxheading{Parameters}
 329
 330 \docparam{text}{The text to set.}
 331
 332