X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7e59b88579c7a1e8b4da0827be75dc5d2a84ec73..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/tglbtn.h?ds=sidebyside diff --git a/interface/wx/tglbtn.h b/interface/wx/tglbtn.h index a64e52e402..d22a6744f9 100644 --- a/interface/wx/tglbtn.h +++ b/interface/wx/tglbtn.h @@ -2,11 +2,12 @@ // Name: tglbtn.h // Purpose: interface of wxBitmapToggleButton, wxToggleButton // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +wxEventType wxEVT_TOGGLEBUTTON; + /** @class wxToggleButton @@ -17,18 +18,18 @@ You can see wxToggleButton in action in @ref page_samples_controls. - @beginEventTable{wxCommandEvent} + @beginEventEmissionTable{wxCommandEvent} @event{EVT_TOGGLEBUTTON(id, func)} - Handles a toggle button click event. + Handles a wxEVT_TOGGLEBUTTON event. @endEventTable @library{wxcore} @category{ctrl} - @appearance{togglebutton.png} + @appearance{togglebutton} @see wxCheckBox, wxButton, wxBitmapToggleButton */ -class wxToggleButton : public wxControl +class wxToggleButton : public wxAnyButton { public: /** @@ -47,10 +48,10 @@ public: Text to be displayed next to the toggle button. @param pos Toggle button position. - If wxDefaultPosition is specified then a default position is chosen. + If ::wxDefaultPosition is specified then a default position is chosen. @param size Toggle button size. - If wxDefaultSize is specified then a default size is chosen. + If ::wxDefaultSize is specified then a default size is chosen. @param style Window style. See wxToggleButton. @param val @@ -106,21 +107,26 @@ public: /** @class wxBitmapToggleButton - wxBitmapToggleButton is a wxToggleButton - that contains a bitmap instead of text. + wxBitmapToggleButton is a wxToggleButton that contains a bitmap instead of + text. + + This class is not available in all ports currently (although it is + available in the major ones), test for @c wxHAS_BITMAPTOGGLEBUTTON to + determine whether it can be used (in addition for possibly testing for + @c wxUSE_TOGGLEBTN which can be set to 0 to explicitly disable support for + this class and wxToggleButton). This control emits an update UI event. - @beginEventTable{wxCommandEvent} + @beginEventEmissionTable{wxCommandEvent} @event{EVT_TOGGLEBUTTON(id, func)} - Handles a toggle button click event. + Handles a wxEVT_TOGGLEBUTTON event. @endEventTable @library{wxcore} @category{ctrl} - @appearance{bitmaptogglebutton.png} */ -class wxBitmapToggleButton : public wxControl +class wxBitmapToggleButton : public wxToggleButton { public: /**