/////////////////////////////////////////////////////////////////////////////
// Name: radiobut.h
-// Purpose: documentation for wxRadioButton class
+// Purpose: interface of wxRadioButton
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@class wxRadioButton
@wxheader{radiobut.h}
- A radio button item is a button which usually denotes one of several mutually
- exclusive options. It has a text label next to a (usually) round button.
+ A radio button item is a button which usually denotes one of several
+ mutually exclusive options. It has a text label next to a (usually) round
+ button.
- You can create a group of mutually-exclusive radio buttons by specifying @c
- wxRB_GROUP for
- the first in the group. The group ends when another radio button group is
- created, or there are no more radio buttons.
+ You can create a group of mutually-exclusive radio buttons by specifying
+ @c wxRB_GROUP for the first in the group. The group ends when another
+ radio button group is created, or there are no more radio buttons.
@beginStyleTable
- @style{wxRB_GROUP}:
+ @style{wxRB_GROUP}
Marks the beginning of a new group of radio buttons.
- @style{wxRB_SINGLE}:
+ @style{wxRB_SINGLE}
In some circumstances, radio buttons that are not consecutive
siblings trigger a hang bug in Windows (only). If this happens, add
this style to mark the button as not belonging to a group, and
implement the mutually-exclusive group behaviour yourself.
- @style{wxRB_USE_CHECKBOX}:
+ @style{wxRB_USE_CHECKBOX}
Use a checkbox button instead of radio button (currently supported
only on PalmOS).
@endStyleTable
- @beginEventTable
- @event{EVT_RADIOBUTTON(id, func)}:
- Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
+ @beginEventTable{wxCommandEvent}
+ @event{EVT_RADIOBUTTON(id, func)}
+ Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
radiobutton is clicked.
@endEventTable
@library{wxcore}
@category{ctrl}
- @appearance{radiobutton.png}
+ <!-- @appearance{radiobutton.png} -->
- @seealso
- @ref overview_eventhandlingoverview, wxRadioBox, wxCheckBox
+ @see @ref overview_eventhandling, wxRadioBox, wxCheckBox
*/
class wxRadioButton : public wxControl
{
public:
- //@{
+
+ /**
+ Default constructor.
+
+ @see Create(), wxValidator
+ */
+ wxRadioButton();
+
/**
Constructor, creating and showing a radio button.
-
+
@param parent
Parent window. Must not be @NULL.
@param id
- Window identifier. The value wxID_ANY indicates a default value.
+ Window identifier. The value @c wxID_ANY indicates a default value.
@param label
Label for the radio button.
@param pos
- Window position. If wxDefaultPosition is specified then a default
+ Window position. If @c wxDefaultPosition is specified then a default
position is chosen.
@param size
- Window size. If wxDefaultSize is specified then a default size
+ Window size. If @c wxDefaultSize is specified then a default size
is chosen.
@param style
Window style. See wxRadioButton.
Window validator.
@param name
Window name.
-
+
@see Create(), wxValidator
*/
- wxRadioButton();
wxRadioButton(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxPoint& pos = wxDefaultPosition,
long style = 0,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "radioButton");
- //@}
/**
Destructor, destroying the radio button item.
/**
Returns @true if the radio button is depressed, @false otherwise.
*/
- bool GetValue();
+ bool GetValue() const;
/**
Sets the radio button to selected or deselected status. This does not cause a
- wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted.
-
+ @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted.
+
@param value
@true to select, @false to deselect.
*/
void SetValue(const bool value);
};
+