Fixed docs footer to bottom, and fixed up TOC on all main pages, and some overviews.

[wxWidgets.git] / interface / wx / tglbtn.h

diff --git a/interface/wx/tglbtn.h b/interface/wx/tglbtn.h
index a64e52e402ca6679cd00e51f6a0691b5da7ee090..a2ee8e710ea81edb749eb776da17e6a6926f576c 100644 (file)
--- 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,9 +17,9 @@
 
     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}
@@ -28,7 +28,7 @@
 
     @see wxCheckBox, wxButton, wxBitmapToggleButton
 */
-class wxToggleButton : public wxControl
+class wxToggleButton : public wxAnyButton
 {
 public:
     /**
@@ -47,10 +47,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 +106,27 @@ 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_COMMAND_TOGGLEBUTTON_CLICKED event.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
     @appearance{bitmaptogglebutton.png}
 */
-class wxBitmapToggleButton : public wxControl
+class wxBitmapToggleButton : public wxToggleButton
 {
 public:
     /**