X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/adaaa68635b4c8a4d8c5284add40366ea3eefb07..4d98817cfab2654773755cb5c540057c5f3d4fd6:/interface/wx/radiobut.h diff --git a/interface/wx/radiobut.h b/interface/wx/radiobut.h index 5fe292f85b..26366ecdc3 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 ///////////////////////////////////////////////////////////////////////////// /** @@ -30,7 +30,7 @@ only on PalmOS). @endStyleTable - @beginEventTable{wxCommandEvent} + @beginEventEmissionTable{wxCommandEvent} @event{EVT_RADIOBUTTON(id, func)} Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the radiobutton is clicked. @@ -38,14 +38,13 @@ @library{wxcore} @category{ctrl} - + @appearance{radiobutton.png} - @see @ref overview_eventhandling, wxRadioBox, wxCheckBox + @see @ref overview_events, wxRadioBox, wxCheckBox */ class wxRadioButton : public wxControl { public: - /** Default constructor. @@ -63,11 +62,11 @@ public: @param label Label for the radio button. @param pos - Window position. If @c 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 @c 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. @param validator @@ -83,7 +82,7 @@ public: const wxSize& size = wxDefaultSize, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "radioButton"); + const wxString& name = wxRadioButtonNameStr); /** Destructor, destroying the radio button item. @@ -94,13 +93,11 @@ public: Creates the choice for two-step construction. See wxRadioButton() for further details. */ - bool Create(wxWindow* parent, wxWindowID id, - const wxString& label, + bool Create(wxWindow* parent, wxWindowID id, const wxString& label, const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = 0, + const wxSize& size = wxDefaultSize, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "radioButton"); + const wxString& name = wxRadioButtonNameStr); /** Returns @true if the radio button is depressed, @false otherwise. @@ -110,10 +107,14 @@ public: /** Sets the radio button to selected or deselected status. This does not cause a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event to get emitted. + + If the radio button belongs to a group you can only select a radio button + (which will deselect the previously selected button) and you therefore + must not call this method with value set to @false in that case. @param value @true to select, @false to deselect. */ - void SetValue(const bool value); + virtual void SetValue(bool value); };