git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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{wxControlWithItems}{wxcontrolwithitems}\\
	10	\helpref{wxControl}{wxcontrol}\\
	11	\helpref{wxWindow}{wxwindow}\\
	12	\helpref{wxEvtHandler}{wxevthandler}\\
	13	\helpref{wxObject}{wxobject}
	14
	15	\wxheading{Include files}
	16
	17	<wx/choice.h>
	18
	19	\wxheading{Window styles}
	20
	21	There are no special styles for wxChoice.
	22
	23	See also \helpref{window styles overview}{windowstyles}.
	24
	25	\wxheading{Event handling}
	26
	27	\twocolwidtha{7cm}
	28	\begin{twocollist}\itemsep=0pt
	29	\twocolitem{{\bf EVT\_CHOICE(id, func)}}{Process a wxEVT\_COMMAND\_CHOICE\_SELECTED event,
	30	when an item on the list is selected.}
	31	\end{twocollist}
	32
	33	\wxheading{See also}
	34
	35	\helpref{wxListBox}{wxlistbox}, \helpref{wxComboBox}{wxcombobox},
	36	\rtfsp\helpref{wxCommandEvent}{wxcommandevent}
	37
	38	\latexignore{\rtfignore{\wxheading{Members}}}
	39
	40	\membersection{wxChoice::wxChoice}\label{wxchoicector}
	41
	42	\func{}{wxChoice}{\void}
	43
	44	Default constructor.
	45
	46	\func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
	47	\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
	48	\param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
	49	\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
	50
	51	\func{}{wxChoice}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
	52	\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
	53	\param{const wxArrayString\& }{choices},\rtfsp
	54	\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``choice"}}
	55
	56	Constructor, creating and showing a choice.
	57
	58	\wxheading{Parameters}
	59
	60	\docparam{parent}{Parent window. Must not be NULL.}
	61
	62	\docparam{id}{Window identifier. A value of -1 indicates a default value.}
	63
	64	\docparam{pos}{Window position.}
	65
	66	\docparam{size}{Window size. If the default size (-1, -1) is specified then the choice is sized
	67	appropriately.}
	68
	69	\docparam{n}{Number of strings with which to initialise the choice control.}
	70
	71	\docparam{choices}{An array of strings with which to initialise the choice control.}
	72
	73	\docparam{style}{Window style. See \helpref{wxChoice}{wxchoice}.}
	74
	75	\docparam{validator}{Window validator.}
	76
	77	\docparam{name}{Window name.}
	78
	79	\wxheading{See also}
	80
	81	\helpref{wxChoice::Create}{wxchoicecreate}, \helpref{wxValidator}{wxvalidator}
	82
	83	\pythonnote{The wxChoice constructor in wxPython reduces the {\tt n}
	84	and {\tt choices} arguments are to a single argument, which is
	85	a list of strings.}
	86
	87	\perlnote{In wxPerl there is just an array reference in place of {\tt n}
	88	and {\tt choices}.}
	89
	90	\membersection{wxChoice::\destruct{wxChoice}}\label{wxchoicedtor}
	91
	92	\func{}{\destruct{wxChoice}}{\void}
	93
	94	Destructor, destroying the choice item.
	95
	96	\membersection{wxChoice::Create}\label{wxchoicecreate}
	97
	98	\func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
	99	\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
	100	\param{int}{ n}, \param{const wxString }{choices[]},\rtfsp
	101	\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
	102	\param{const wxString\& }{name = ``choice"}}
	103
	104	\func{bool}{Create}{\param{wxWindow *}{parent}, \param{wxWindowID}{ id},\rtfsp
	105	\param{const wxPoint\& }{pos}, \param{const wxSize\&}{ size},\rtfsp
	106	\param{const wxArrayString\& }{choices},\rtfsp
	107	\param{long}{ style = 0}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
	108	\param{const wxString\& }{name = ``choice"}}
	109
	110	Creates the choice for two-step construction. See \helpref{wxChoice::wxChoice}{wxchoicector}.
	111
	112	\membersection{wxChoice::Delete}\label{wxchoicedelete}
	113
	114	\func{void}{Delete}{\param{int }{n}}
	115
	116	Deletes the item with the given index from the control.
	117
	118	\wxheading{Parameters}
	119
	120	\docparam{n}{The item to delete.}
	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 and always returns $1$ for the other
	131	platforms.
	132
	133	\membersection{wxChoice::SetColumns}\label{wxchoicesetcolumns}
	134
	135	\func{void}{SetColumns}{\param{int}{ n = 1}}
	136
	137	Sets the number of columns in this choice item.
	138
	139	\wxheading{Parameters}
	140
	141	\docparam{n}{Number of columns.}
	142
	143	\wxheading{Remarks}
	144
	145	This is implemented for Motif only and doesn't do anything under other
	146	platforms.
	147