docs/latex/wx/radiobut.tex

   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 There are no specific styles for this class.
  20
  21 See also \helpref{window styles overview}{windowstyles}.
  22
  23 \wxheading{Event handling}
  24
  25 \twocolwidtha{7cm}
  26 \begin{twocollist}\itemsep=0pt
  27 \twocolitem{{\bf EVT\_RADIOBUTTON(id, func)}}{Process a wxEVT\_COMMAND\_RADIOBUTTON\_SELECTED event,
  28 when the radiobutton is clicked.}
  29 \end{twocollist}
  30
  31 \wxheading{See also}
  32
  33 \helpref{Event handling overview}{eventhandlingoverview}, \helpref{wxRadioBox}{wxradiobox},\rtfsp
  34 \helpref{wxCheckBox}{wxcheckbox}
  35
  36 \latexignore{\rtfignore{\wxheading{Members}}}
  37
  38 \membersection{wxRadioButton::wxRadioButton}\label{wxradiobuttonconstr}
  39
  40 \func{}{wxRadioButton}{\void}
  41
  42 Default constructor.
  43
  44 \func{}{wxRadioButton}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
  45 \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  46 \param{long}{ style = 0},\rtfsp
  47 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
  48 \param{const wxString\& }{name = ``radioButton"}}
  49
  50 Constructor, creating and showing a radio button.
  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{label}{Label for the radio button.}
  59
  60 \docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
  61
  62 \docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
  63
  64 \docparam{style}{Window style. See \helpref{wxRadioButton}{wxradiobutton}.}
  65
  66 \docparam{validator}{Window validator.}
  67
  68 \docparam{name}{Window name.}
  69
  70 \wxheading{See also}
  71
  72 \helpref{wxRadioButton::Create}{wxradiobuttoncreate}, \helpref{wxValidator}{wxvalidator}
  73
  74 \membersection{wxRadioButton::\destruct{wxRadioButton}}
  75
  76 \func{void}{\destruct{wxRadioButton}}{\void}
  77
  78 Destructor, destroying the radio button item.
  79
  80 \membersection{wxRadioButton::Create}\label{wxradiobuttoncreate}
  81
  82 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID}{ id}, \param{const wxString\& }{label},\rtfsp
  83 \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\&}{ size = wxDefaultSize},\rtfsp
  84 \param{long}{ style = 0},\rtfsp
  85 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
  86 \param{const wxString\& }{name = ``radioButton"}}
  87
  88 Creates the choice for two-step construction. See \helpref{wxRadioButton::wxRadioButton}{wxradiobuttonconstr} for
  89 further details.
  90
  91 \membersection{wxRadioButton::GetValue}\label{wxradiobuttongetvalue}
  92
  93 \constfunc{bool}{GetValue}{\void}
  94
  95 Returns TRUE if the radio button is depressed, FALSE otherwise.
  96
  97 \membersection{wxRadioButton::SetValue}\label{wxradiobuttonsetvalue}
  98
  99 \func{void}{SetValue}{\param{const bool}{ value}}
 100
 101 Sets the radio button to selected or deselected status.
 102
 103 \wxheading{Parameters}
 104
 105 \docparam{value}{TRUE to select, FALSE to deselect.}
 106
 107