X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/78e87bf7b8fb25529f77881834c75ae1614e6552..a8bda512079352ba81933e278d9ccdb8ef7a9866:/interface/wx/tglbtn.h diff --git a/interface/wx/tglbtn.h b/interface/wx/tglbtn.h index 3f6d601528..866be9765e 100644 --- a/interface/wx/tglbtn.h +++ b/interface/wx/tglbtn.h @@ -3,7 +3,7 @@ // Purpose: interface of wxBitmapToggleButton, wxToggleButton // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -17,14 +17,14 @@ 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 toggle button click event. @endEventTable @library{wxcore} @category{ctrl} - + @appearance{togglebutton.png} @see wxCheckBox, wxButton, wxBitmapToggleButton */ @@ -47,13 +47,13 @@ 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 validator + @param val Window validator. @param name Window name. @@ -106,19 +106,25 @@ 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 toggle button click event. @endEventTable @library{wxcore} @category{ctrl} - + @appearance{bitmaptogglebutton.png} */ class wxBitmapToggleButton : public wxControl {