// Purpose: interface of wxBitmapToggleButton, wxToggleButton
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
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_COMMAND_TOGGLEBUTTON_CLICKED event.
@endEventTable
@library{wxcore}
@category{ctrl}
- <!-- @appearance{togglebutton.png} -->
+ @appearance{togglebutton.png}
@see wxCheckBox, wxButton, wxBitmapToggleButton
*/
-class wxToggleButton : public wxControl
+class wxToggleButton : public wxAnyButton
{
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.
/**
@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_COMMAND_TOGGLEBUTTON_CLICKED event.
@endEventTable
@library{wxcore}
@category{ctrl}
- <!-- @appearance{bitmaptogglebutton.png} -->
+ @appearance{bitmaptogglebutton.png}
*/
-class wxBitmapToggleButton : public wxControl
+class wxBitmapToggleButton : public wxToggleButton
{
public:
/**