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

... / ...

Commit	Line	Data
	1	\section{\class{wxRadioButton}}\label{wxradiobutton}
	2
	3	A radio button item is a button which usually denotes one of several mutually
	4	exclusive options. It has a text label next to a (usually) round button.
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxControl}{wxcontrol}\\
	9	\helpref{wxWindow}{wxwindow}\\
	10	\helpref{wxEvtHandler}{wxevthandler}\\
	11	\helpref{wxObject}{wxobject}
	12
	13	\wxheading{Include files}
	14
	15	<wx/radiobut.h>
	16
	17	\wxheading{Window styles}
	18
	19	\twocolwidtha{5cm}
	20	\begin{twocollist}\itemsep=0pt
	21	\twocolitem{\windowstyle{wxRB\_GROUP}}{Marks the beginning of a new group of radio buttons.}
	22	\end{twocollist}
	23
	24	See also \helpref{window styles overview}{windowstyles}.
	25
	26	\wxheading{Event handling}
	27
	28	\twocolwidtha{7cm}
	29	\begin{twocollist}\itemsep=0pt
	30	\twocolitem{{\bf EVT\_RADIOBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED event,
	31	when the radiobutton is clicked.}
	32	\end{twocollist}
	33
	34	\wxheading{See also}
	35
	36	\helpref{Event handling overview}{eventhandlingoverview}, \helpref{wxRadioBox}{wxradiobox},\rtfsp
	37	\helpref{wxCheckBox}{wxcheckbox}
	38
	39	\latexignore{\rtfignore{\wxheading{Members}}}
	40
	41	\membersection{wxRadioButton::wxRadioButton}\label{wxradiobuttonconstr}
	42
	43	\func{}{wxRadioButton}{\void}
	44
	45	Default constructor.
	46
	47	\func{}{wxRadioButton}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
	48	\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
	49	\param{long}{ style = 0},\rtfsp
	50	\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
	51	\param{const wxString\& }{name = ``radioButton"}}
	52
	53	Constructor, creating and showing a radio button.
	54
	55	\wxheading{Parameters}
	56
	57	\docparam{parent}{Parent window. Must not be NULL.}
	58
	59	\docparam{id}{Window identifier. A value of -1 indicates a default value.}
	60
	61	\docparam{label}{Label for the radio button.}
	62
	63	\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
	64
	65	\docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
	66
	67	\docparam{style}{Window style. See \helpref{wxRadioButton}{wxradiobutton}.}
	68
	69	\docparam{validator}{Window validator.}
	70
	71	\docparam{name}{Window name.}
	72
	73	\wxheading{See also}
	74
	75	\helpref{wxRadioButton::Create}{wxradiobuttoncreate}, \helpref{wxValidator}{wxvalidator}
	76
	77	\membersection{wxRadioButton::\destruct{wxRadioButton}}
	78
	79	\func{void}{\destruct{wxRadioButton}}{\void}
	80
	81	Destructor, destroying the radio button item.
	82
	83	\membersection{wxRadioButton::Create}\label{wxradiobuttoncreate}
	84
	85	\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
	86	\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
	87	\param{long}{ style = 0},\rtfsp
	88	\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
	89	\param{const wxString\& }{name = ``radioButton"}}
	90
	91	Creates the choice for two-step construction. See \helpref{wxRadioButton::wxRadioButton}{wxradiobuttonconstr} for
	92	further details.
	93
	94	\membersection{wxRadioButton::GetValue}\label{wxradiobuttongetvalue}
	95
	96	\constfunc{bool}{GetValue}{\void}
	97
	98	Returns TRUE if the radio button is depressed, FALSE otherwise.
	99
	100	\membersection{wxRadioButton::SetValue}\label{wxradiobuttonsetvalue}
	101
	102	\func{void}{SetValue}{\param{const bool}{ value}}
	103
	104	Sets the radio button to selected or deselected status. This does not cause a
	105	wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED event to get emitted.
	106
	107	\wxheading{Parameters}
	108
	109	\docparam{value}{TRUE to select, FALSE to deselect.}
	110
	111