X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/526954c5968baa29218c994ec48e476ae2bd4b9f..038c99477c8cd14013cef892517012717c47df35:/interface/wx/radiobut.h diff --git a/interface/wx/radiobut.h b/interface/wx/radiobut.h index 76a63a9b1a..36be096fa6 100644 --- a/interface/wx/radiobut.h +++ b/interface/wx/radiobut.h @@ -25,20 +25,17 @@ 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} - Use a checkbox button instead of radio button (currently supported - only on PalmOS). @endStyleTable @beginEventEmissionTable{wxCommandEvent} @event{EVT_RADIOBUTTON(id, func)} - Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the + Process a @c wxEVT_RADIOBUTTON event, when the radiobutton is clicked. @endEventTable @library{wxcore} @category{ctrl} - @appearance{radiobutton.png} + @appearance{radiobutton} @see @ref overview_events, wxRadioBox, wxCheckBox */ @@ -100,16 +97,21 @@ public: const wxString& name = wxRadioButtonNameStr); /** - Returns @true if the radio button is depressed, @false otherwise. + Returns @true if the radio button is checked, @false otherwise. */ virtual bool GetValue() const; /** - Sets the radio button to selected or deselected status. This does not cause a - @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted. + Sets the radio button to checked or unchecked status. This does not cause a + @c wxEVT_RADIOBUTTON event to get emitted. + + If the radio button belongs to a radio group exactly one button in the + group may be checked and so this method can be only called with @a + value set to @true. To uncheck a radio button in a group you must check + another button in the same group. @param value - @true to select, @false to deselect. + @true to check, @false to uncheck. */ virtual void SetValue(bool value); };