/////////////////////////////////////////////////////////////////////////////
// Name: radiobut.h
-// Purpose: documentation for wxRadioButton class
+// Purpose: interface of wxRadioButton
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
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)}:
+ @beginEventTable{wxCommandEvent}
+ @event{EVT_RADIOBUTTON(id, func)}
Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
radiobutton is clicked.
@endEventTable
@category{ctrl}
@appearance{radiobutton.png}
- @seealso
- @ref overview_eventhandlingoverview, wxRadioBox, wxCheckBox
+ @see @ref overview_eventhandling, wxRadioBox, wxCheckBox
*/
class wxRadioButton : public wxControl
{
//@{
/**
Constructor, creating and showing a radio button.
-
+
@param parent
Parent window. Must not be @NULL.
@param id
Window validator.
@param name
Window name.
-
+
@see Create(), wxValidator
*/
wxRadioButton();
/**
Sets the radio button to selected or deselected status. This does not cause a
wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted.
-
+
@param value
@true to select, @false to deselect.
*/
void SetValue(const bool value);
};
+