]>
Commit | Line | Data |
---|---|---|
a660d684 KB |
1 | \section{\class{wxChoice}}\label{wxchoice} |
2 | ||
3 | A choice item is used to select one of a list of strings. Unlike a | |
4 | listbox, only the selection is visible until the user pulls down the | |
5 | menu of choices. | |
6 | ||
7 | \wxheading{Derived from} | |
8 | ||
9 | \helpref{wxControl}{wxcontrol}\\ | |
10 | \helpref{wxWindow}{wxwindow}\\ | |
11 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
12 | \helpref{wxObject}{wxobject} | |
13 | ||
954b8ae6 JS |
14 | \wxheading{Include files} |
15 | ||
16 | <wx/choice.h> | |
17 | ||
a660d684 KB |
18 | \wxheading{Window styles} |
19 | ||
20 | There are no special styles for wxChoice. | |
21 | ||
22 | See also \helpref{window styles overview}{windowstyles}. | |
23 | ||
5de76427 JS |
24 | \wxheading{Event handling} |
25 | ||
26 | \twocolwidtha{7cm} | |
27 | \begin{twocollist}\itemsep=0pt | |
28 | \twocolitem{{\bf EVT\_CHOICE(id, func)}}{Process a wxEVT\_COMMAND\_CHOICE\_SELECTED event, | |
29 | when an item on the list is selected.} | |
30 | \end{twocollist} | |
31 | ||
a660d684 KB |
32 | \wxheading{See also} |
33 | ||
5de76427 JS |
34 | \helpref{wxListBox}{wxlistbox}, \helpref{wxComboBox}{wxcombobox}, |
35 | \rtfsp\helpref{wxCommandEvent}{wxcommandevent} | |
a660d684 KB |
36 | |
37 | \latexignore{\rtfignore{\wxheading{Members}}} | |
38 | ||
39 | \membersection{wxChoice::wxChoice}\label{wxchoiceconstr} | |
40 | ||
41 | \func{}{wxChoice}{\void} | |
42 | ||
43 | Default constructor. | |
44 | ||
eaaa6a06 | 45 | \func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp |
a660d684 | 46 | \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp |
eaaa6a06 JS |
47 | \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp |
48 | \param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}} | |
a660d684 KB |
49 | |
50 | Constructor, creating and showing a choice. | |
51 | ||
52 | \wxheading{Parameters} | |
53 | ||
54 | \docparam{parent}{Parent window. Must not be NULL.} | |
55 | ||
56 | \docparam{id}{Window identifier. A value of -1 indicates a default value.} | |
57 | ||
58 | \docparam{pos}{Window position.} | |
59 | ||
60 | \docparam{size}{Window size. If the default size (-1, -1) is specified then the choice is sized | |
61 | appropriately.} | |
62 | ||
63 | \docparam{n}{Number of strings with which to initialise the choice control.} | |
64 | ||
65 | \docparam{choices}{An array of strings with which to initialise the choice control.} | |
66 | ||
67 | \docparam{style}{Window style. See \helpref{wxChoice}{wxchoice}.} | |
68 | ||
69 | \docparam{validator}{Window validator.} | |
70 | ||
71 | \docparam{name}{Window name.} | |
72 | ||
73 | \wxheading{See also} | |
74 | ||
75 | \helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator} | |
76 | ||
77 | \membersection{wxChoice::\destruct{wxChoice}} | |
78 | ||
79 | \func{}{\destruct{wxChoice}}{\void} | |
80 | ||
81 | Destructor, destroying the choice item. | |
82 | ||
83 | \membersection{wxChoice::Append}\label{wxchoiceappend} | |
84 | ||
85 | \func{void}{Append}{\param{const wxString\& }{ item}} | |
86 | ||
87 | Adds the item to the end of the choice control. | |
88 | ||
89 | \wxheading{Parameters} | |
90 | ||
91 | \docparam{item}{String to add.} | |
92 | ||
93 | \membersection{wxChoice::Clear}\label{wxchoiceclear} | |
94 | ||
95 | \func{void}{Clear}{\void} | |
96 | ||
97 | Clears the strings from the choice item. | |
98 | ||
99 | \membersection{wxChoice::Create}\label{wxchoicecreate} | |
100 | ||
eaaa6a06 | 101 | \func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp |
a660d684 | 102 | \param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp |
eaaa6a06 JS |
103 | \param{int}{ n}, \param{const wxString }{choices[]},\rtfsp |
104 | \param{long}{ style = 0}, \param{const wxString\& }{name = ``choice"}} | |
a660d684 KB |
105 | |
106 | Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoiceconstr}. | |
107 | ||
108 | \membersection{wxChoice::FindString}\label{wxchoicefindstring} | |
109 | ||
110 | \constfunc{int}{FindString}{\param{const wxString\& }{string}} | |
111 | ||
112 | Finds a choice matching the given string. | |
113 | ||
114 | \wxheading{Parameters} | |
115 | ||
116 | \docparam{string}{String to find.} | |
117 | ||
118 | \wxheading{Return value} | |
119 | ||
120 | Returns the position if found, or -1 if not found. | |
121 | ||
122 | \membersection{wxChoice::GetColumns}\label{wxchoicegetcolumns} | |
123 | ||
124 | \constfunc{int}{GetColumns}{\void} | |
125 | ||
126 | Gets the number of columns in this choice item. | |
127 | ||
128 | \wxheading{Remarks} | |
129 | ||
130 | This is implemented for Motif only. | |
131 | ||
132 | \membersection{wxChoice::GetSelection}\label{wxchoicegetselection} | |
133 | ||
134 | \constfunc{int}{GetSelection}{\void} | |
135 | ||
136 | Gets the id (position) of the selected string, or -1 if there is no selection. | |
137 | ||
138 | \membersection{wxChoice::GetString}\label{wxchoicegetstring} | |
139 | ||
eaaa6a06 | 140 | \constfunc{wxString}{GetString}{\param{int}{ n}} |
a660d684 KB |
141 | |
142 | Returns the string at the given position. | |
143 | ||
144 | \wxheading{Parameters} | |
145 | ||
146 | \docparam{n}{The zero-based position.} | |
147 | ||
148 | \wxheading{Return value} | |
149 | ||
150 | The string at the given position, or the empty string if {\it n} is invalid. | |
151 | ||
152 | \membersection{wxChoice::GetStringSelection}\label{wxchoicegetstringselection} | |
153 | ||
154 | \constfunc{wxString}{GetStringSelection}{\void} | |
155 | ||
156 | Gets the selected string, or the empty string if no string is selected. | |
157 | ||
158 | \membersection{wxChoice::Number}\label{wxchoicenumber} | |
159 | ||
160 | \constfunc{int}{Number}{\void} | |
161 | ||
162 | Returns the number of strings in the choice control. | |
163 | ||
164 | \membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns} | |
165 | ||
eaaa6a06 | 166 | \func{void}{SetColumns}{\param{int}{ n = 1}} |
a660d684 KB |
167 | |
168 | Sets the number of columns in this choice item. | |
169 | ||
170 | \wxheading{Parameters} | |
171 | ||
172 | \docparam{n}{Number of columns.} | |
173 | ||
174 | \wxheading{Remarks} | |
175 | ||
176 | This is implemented for Motif only. | |
177 | ||
178 | \membersection{wxChoice::SetSelection}\label{wxchoicesetselection} | |
179 | ||
eaaa6a06 | 180 | \func{void}{SetSelection}{\param{int}{ n}} |
a660d684 KB |
181 | |
182 | Sets the choice by passing the desired string position. | |
183 | ||
184 | \wxheading{Parameters} | |
185 | ||
186 | \docparam{n}{The string position to select, starting from zero.} | |
187 | ||
188 | \wxheading{See also} | |
189 | ||
190 | \helpref{wxChoice::SetStringSelection}{wxchoicesetstringselection} | |
191 | ||
192 | \membersection{wxChoice::SetStringSelection}\label{wxchoicesetstringselection} | |
193 | ||
194 | \func{void}{SetStringSelection}{\param{const wxString\& }{ string}} | |
195 | ||
196 | Sets the choice by passing the desired string. | |
197 | ||
198 | \wxheading{Parameters} | |
199 | ||
200 | \docparam{string}{The string to select.} | |
201 | ||
202 | \wxheading{See also} | |
203 | ||
204 | \helpref{wxChoice::SetSelection}{wxchoicesetselection} | |
205 | ||
206 |