docs/latex/wx/choice.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        treectrl.tex
   3 %% Purpose:     wxChoice documentation
   4 %% Author:      wxWidgets Team
   5 %% Modified by:
   6 %% Created:
   7 %% RCS-ID:      $Id$
   8 %% Copyright:   (c) wxWidgets Team
   9 %% License:     wxWindows license
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11
  12 \section{\class{wxChoice}}\label{wxchoice}
  13
  14 A choice item is used to select one of a list of strings. Unlike a
  15 listbox, only the selection is visible until the user pulls down the
  16 menu of choices.
  17
  18 \wxheading{Derived from}
  19
  20 \helpref{wxControlWithItems}{wxcontrolwithitems}\\
  21 \helpref{wxControl}{wxcontrol}\\
  22 \helpref{wxWindow}{wxwindow}\\
  23 \helpref{wxEvtHandler}{wxevthandler}\\
  24 \helpref{wxObject}{wxobject}
  25
  26 \wxheading{Include files}
  27
  28 <wx/choice.h>
  29
  30 \wxheading{Window styles}
  31
  32 There are no special styles for wxChoice.
  33
  34 See also \helpref{window styles overview}{windowstyles}.
  35
  36 \wxheading{Event handling}
  37
  38 \twocolwidtha{7cm}
  39 \begin{twocollist}\itemsep=0pt
  40 \twocolitem{{\bf EVT\_CHOICE(id, func)}}{Process a wxEVT\_COMMAND\_CHOICE\_SELECTED event,
  41 when an item on the list is selected.}
  42 \end{twocollist}
  43
  44 \wxheading{See also}
  45
  46 \helpref{wxListBox}{wxlistbox}, \helpref{wxComboBox}{wxcombobox},
  47 \rtfsp\helpref{wxCommandEvent}{wxcommandevent}
  48
  49 \latexignore{\rtfignore{\wxheading{Members}}}
  50
  51
  52 \membersection{wxChoice::wxChoice}\label{wxchoicector}
  53
  54 \func{}{wxChoice}{\void}
  55
  56 Default constructor.
  57
  58 \func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
  59 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
  60 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
  61 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
  62
  63 \func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
  64 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
  65 \param{const wxArrayString\& }{choices},\rtfsp
  66 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
  67
  68 Constructor, creating and showing a choice.
  69
  70 \wxheading{Parameters}
  71
  72 \docparam{parent}{Parent window. Must not be NULL.}
  73
  74 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
  75
  76 \docparam{pos}{Window position.}
  77
  78 \docparam{size}{Window size. If the default size (-1, -1) is specified then the choice is sized
  79 appropriately.}
  80
  81 \docparam{n}{Number of strings with which to initialise the choice control.}
  82
  83 \docparam{choices}{An array of strings with which to initialise the choice control.}
  84
  85 \docparam{style}{Window style. See \helpref{wxChoice}{wxchoice}.}
  86
  87 \docparam{validator}{Window validator.}
  88
  89 \docparam{name}{Window name.}
  90
  91 \wxheading{See also}
  92
  93 \helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator}
  94
  95 \pythonnote{The wxChoice constructor in wxPython reduces the {\tt n}
  96 and {\tt choices} arguments are to a single argument, which is
  97 a list of strings.}
  98
  99 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 100 and {\tt choices}.}
 101
 102
 103 \membersection{wxChoice::\destruct{wxChoice}}\label{wxchoicedtor}
 104
 105 \func{}{\destruct{wxChoice}}{\void}
 106
 107 Destructor, destroying the choice item.
 108
 109
 110 \membersection{wxChoice::Create}\label{wxchoicecreate}
 111
 112 \func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
 113 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
 114 \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
 115 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 116 \param{const wxString\& }{name = ``choice"}}
 117
 118 \func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
 119 \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
 120 \param{const wxArrayString\& }{choices},\rtfsp
 121 \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 122 \param{const wxString\& }{name = ``choice"}}
 123
 124 Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}.
 125
 126
 127 \membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns}
 128
 129 \constfunc{int}{GetColumns}{\void}
 130
 131 Gets the number of columns in this choice item.
 132
 133 \wxheading{Remarks}
 134
 135 This is implemented for Motif only and always returns $1$ for the other
 136 platforms.
 137
 138
 139 \membersection{wxChoice::GetCurrentSelection}\label{wxchoicegetcurrentselection}
 140
 141 \constfunc{int}{GetCurrentSelection}{\void}
 142
 143 Unlike \helpref{GetSelection}{wxcontrolwithitemsgetselection} which only
 144 returns the accepted selection value, i.e. the selection in the control once
 145 the user closes the dropdown list, this function returns the current selection.
 146 That is, while the dropdown list is shown, it returns the currently selected
 147 item in it. When it is not shown, its result is the same as for the other
 148 function.
 149
 150 \newsince{2.6.2} (before this version
 151 \helpref{GetSelection}{wxcontrolwithitemsgetselection} itself behaved like
 152 this).
 153
 154
 155 \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns}
 156
 157 \func{void}{SetColumns}{\param{int}{ n = 1}}
 158
 159 Sets the number of columns in this choice item.
 160
 161 \wxheading{Parameters}
 162
 163 \docparam{n}{Number of columns.}
 164
 165 \wxheading{Remarks}
 166
 167 This is implemented for Motif only and doesn't do anything under other
 168 platforms.