]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/tglbtn.h
Added wxPGProperty::Enable() for conveniency. Refactored related code and improved...
[wxWidgets.git] / interface / wx / tglbtn.h
index c6b09ad7a5c3f5b5481a3c89c91f4d30ed7f1ae4..53f51a78f22858b00518afa2f71d5035bfca2645 100644 (file)
@@ -1,32 +1,30 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        tglbtn.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        tglbtn.h
-// Purpose:     interface of wxBitmapToggleButton
+// Purpose:     interface of wxBitmapToggleButton, wxToggleButton
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 /**
     @class wxToggleButton
 
 /////////////////////////////////////////////////////////////////////////////
 
 
 /**
     @class wxToggleButton
 
-    wxToggleButton is a button that stays pressed when clicked by the user. In
-    other words, it is similar to wxCheckBox in
-    functionality but looks like a wxButton.
+    wxToggleButton is a button that stays pressed when clicked by the user.
+    In other words, it is similar to wxCheckBox in functionality but looks like a wxButton.
 
     Since wxWidgets version 2.9.0 this control emits an update UI event.
 
 
     Since wxWidgets version 2.9.0 this control emits an update UI event.
 
-    You can see wxToggleButton in action in the sixth page of the
-    controls() sample.
+    You can see wxToggleButton in action in @ref page_samples_controls.
 
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TOGGLEBUTTON(id, func)}
     @event{EVT_TOGGLEBUTTON(id, func)}
-           Handles a toggle button click event.
+        Handles a toggle button click event.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
-    <!-- @appearance{togglebutton.png} -->
+    @appearance{togglebutton.png}
 
     @see wxCheckBox, wxButton, wxBitmapToggleButton
 */
 
     @see wxCheckBox, wxButton, wxBitmapToggleButton
 */
@@ -48,14 +46,14 @@ public:
         @param label
             Text to be displayed next to the toggle button.
         @param pos
         @param label
             Text to be displayed next to the toggle button.
         @param pos
-            Toggle button position. If wxDefaultPosition is specified then a
-        default position is chosen.
+            Toggle button position.
+            If ::wxDefaultPosition is specified then a default position is chosen.
         @param size
         @param size
-            Toggle button size. If wxDefaultSize is specified then a
-        default size is chosen.
+            Toggle button size.
+            If ::wxDefaultSize is specified then a default size is chosen.
         @param style
             Window style. See wxToggleButton.
         @param style
             Window style. See wxToggleButton.
-        @param validator
+        @param val
             Window validator.
         @param name
             Window name.
             Window validator.
         @param name
             Window name.
@@ -76,8 +74,8 @@ public:
     virtual ~wxToggleButton();
 
     /**
     virtual ~wxToggleButton();
 
     /**
-        Creates the toggle button for two-step construction. See wxToggleButton()
-        for details.
+        Creates the toggle button for two-step construction.
+        See wxToggleButton() for details.
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& label,
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& label,
@@ -92,16 +90,16 @@ public:
 
         @return Returns @true if it is pressed, @false otherwise.
     */
 
         @return Returns @true if it is pressed, @false otherwise.
     */
-    bool GetValue() const;
+    virtual bool GetValue() const;
 
     /**
 
     /**
-        Sets the toggle button to the given state. This does not cause a
-        @c EVT_TOGGLEBUTTON event to be emitted.
+        Sets the toggle button to the given state.
+        This does not cause a @c EVT_TOGGLEBUTTON event to be emitted.
 
         @param state
             If @true, the button is pressed.
     */
 
         @param state
             If @true, the button is pressed.
     */
-    void SetValue(bool state);
+    virtual void SetValue(bool state);
 };
 
 
 };
 
 
@@ -113,14 +111,14 @@ public:
 
     This control emits an update UI event.
 
 
     This control emits an update UI event.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TOGGLEBUTTON(id, func)}
     @event{EVT_TOGGLEBUTTON(id, func)}
-           Handles a toggle button click event.
+        Handles a toggle button click event.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
-    <!-- @appearance{bitmaptogglebutton.png} -->
+    @appearance{bitmaptogglebutton.png}
 */
 class wxBitmapToggleButton : public wxControl
 {
 */
 class wxBitmapToggleButton : public wxControl
 {
@@ -161,8 +159,8 @@ public:
     virtual bool GetValue() const;
 
     /**
     virtual bool GetValue() const;
 
     /**
-        Sets the toggle button to the given state. This does not cause a
-        @c EVT_TOGGLEBUTTON event to be emitted.
+        Sets the toggle button to the given state.
+        This does not cause a @c EVT_TOGGLEBUTTON event to be emitted.
 
         @param state
             If @true, the button is pressed.
 
         @param state
             If @true, the button is pressed.