/////////////////////////////////////////////////////////////////////////////
// Name: radiobut.h
-// Purpose: documentation for wxRadioButton class
+// Purpose: interface of wxRadioButton
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@endStyleTable
@beginEventTable
- @event{EVT_RADIOBUTTON(id\, func)}:
+ @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 "Event handling overview", wxRadioBox,
- wxCheckBox
+ @see @ref overview_eventhandlingoverview, wxRadioBox, wxCheckBox
*/
class wxRadioButton : public wxControl
{
//@{
/**
Constructor, creating and showing a radio button.
-
+
@param parent
- Parent window. Must not be @NULL.
-
+ Parent window. Must not be @NULL.
@param id
- Window identifier. The value wxID_ANY indicates a default value.
-
+ Window identifier. The value wxID_ANY indicates a default value.
@param label
- Label for the radio button.
-
+ Label for the radio button.
@param pos
- Window position. If wxDefaultPosition is specified then a default position
- is chosen.
-
+ Window position. If wxDefaultPosition is specified then a default
+ position is chosen.
@param size
- Window size. If wxDefaultSize is specified then a default size is
- chosen.
-
+ Window size. If wxDefaultSize is specified then a default size
+ is chosen.
@param style
- Window style. See wxRadioButton.
-
+ Window style. See wxRadioButton.
@param validator
- Window validator.
-
+ Window validator.
@param name
- Window name.
-
- @sa Create(), wxValidator
+ Window name.
+
+ @see Create(), wxValidator
*/
wxRadioButton();
wxRadioButton(wxWindow* parent, wxWindowID id,
/**
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.
-
+
@param value
- @true to select, @false to deselect.
+ @true to select, @false to deselect.
*/
void SetValue(const bool value);
};
+