X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/76e2b5703a0b8ae2f7210526defd2a07e3b81e0d..6a5c9ff8e8864c2a1540af521d9a93bae9617d93:/interface/wx/radiobut.h diff --git a/interface/wx/radiobut.h b/interface/wx/radiobut.h index 362bed386e..1c8b839b18 100644 --- a/interface/wx/radiobut.h +++ b/interface/wx/radiobut.h @@ -3,7 +3,7 @@ // Purpose: interface of wxRadioButton // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -25,9 +25,6 @@ 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} @@ -38,7 +35,7 @@ @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 + Sets the radio button to checked or unchecked status. This does not cause a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED 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); };