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	\twocolitem{\windowstyle{wxRB\_SINGLE}}{If your radio buttons are not
	23	consecutive siblings, they cannot form a group under Windows and you should use
	24	this style to indicate that each of them is handled individually.}
	25	\twocolitem{\windowstyle{wxRB\_USE\_CHECKBOX}}{Use of the checkbox control instead of radio
	26	button (currently supported only on PalmOS)}
	27	\end{twocollist}
	28
	29	See also \helpref{window styles overview}{windowstyles}.
	30
	31	\wxheading{Event handling}
	32
	33	\twocolwidtha{7cm}
	34	\begin{twocollist}\itemsep=0pt
	35	\twocolitem{{\bf EVT\_RADIOBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED event,
	36	when the radiobutton is clicked.}
	37	\end{twocollist}
	38
	39	\wxheading{See also}
	40
	41	\helpref{Event handling overview}{eventhandlingoverview}, \helpref{wxRadioBox}{wxradiobox},\rtfsp
	42	\helpref{wxCheckBox}{wxcheckbox}
	43
	44	\latexignore{\rtfignore{\wxheading{Members}}}
	45
	46	\membersection{wxRadioButton::wxRadioButton}\label{wxradiobuttonctor}
	47
	48	\func{}{wxRadioButton}{\void}
	49
	50	Default constructor.
	51
	52	\func{}{wxRadioButton}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
	53	\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
	54	\param{long}{ style = 0},\rtfsp
	55	\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
	56	\param{const wxString\& }{name = ``radioButton"}}
	57
	58	Constructor, creating and showing a radio button.
	59
	60	\wxheading{Parameters}
	61
	62	\docparam{parent}{Parent window. Must not be NULL.}
	63
	64	\docparam{id}{Window identifier. A value of -1 indicates a default value.}
	65
	66	\docparam{label}{Label for the radio button.}
	67
	68	\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
	69
	70	\docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
	71
	72	\docparam{style}{Window style. See \helpref{wxRadioButton}{wxradiobutton}.}
	73
	74	\docparam{validator}{Window validator.}
	75
	76	\docparam{name}{Window name.}
	77
	78	\wxheading{See also}
	79
	80	\helpref{wxRadioButton::Create}{wxradiobuttoncreate}, \helpref{wxValidator}{wxvalidator}
	81
	82	\membersection{wxRadioButton::\destruct{wxRadioButton}}\label{wxradiobuttondtor}
	83
	84	\func{void}{\destruct{wxRadioButton}}{\void}
	85
	86	Destructor, destroying the radio button item.
	87
	88	\membersection{wxRadioButton::Create}\label{wxradiobuttoncreate}
	89
	90	\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
	91	\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
	92	\param{long}{ style = 0},\rtfsp
	93	\param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
	94	\param{const wxString\& }{name = ``radioButton"}}
	95
	96	Creates the choice for two-step construction. See \helpref{wxRadioButton::wxRadioButton}{wxradiobuttonctor} for
	97	further details.
	98
	99	\membersection{wxRadioButton::GetValue}\label{wxradiobuttongetvalue}
	100
	101	\constfunc{bool}{GetValue}{\void}
	102
	103	Returns true if the radio button is depressed, false otherwise.
	104
	105	\membersection{wxRadioButton::SetValue}\label{wxradiobuttonsetvalue}
	106
	107	\func{void}{SetValue}{\param{const bool}{ value}}
	108
	109	Sets the radio button to selected or deselected status. This does not cause a
	110	wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED event to get emitted.
	111
	112	\wxheading{Parameters}
	113
	114	\docparam{value}{true to select, false to deselect.}
	115
	116