Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-06-27 16:22:58 +00:00
parent 92b6654b66
commit ae3c17b401
277 changed files with 0 additions and 0 deletions
--- a/interface/wx/tglbtn.h
+++ b/interface/wx/tglbtn.h
@@ -0,0 +1,170 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        tglbtn.h
+// Purpose:     interface of wxBitmapToggleButton
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+
+/**
+    @class wxToggleButton
+    @wxheader{tglbtn.h}
+
+    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.
+
+    You can see wxToggleButton in action in the sixth page of the
+    controls() sample.
+
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_TOGGLEBUTTON(id, func)}
+           Handles a toggle button click event.
+    @endEventTable
+
+    @library{wxcore}
+    @category{ctrl}
+    <!-- @appearance{togglebutton.png} -->
+
+    @see wxCheckBox, wxButton, wxBitmapToggleButton
+*/
+class wxToggleButton : public wxControl
+{
+public:
+    //@{
+    /**
+        Constructor, creating and showing a toggle button.
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param id
+            Toggle button identifier. The value wxID_ANY indicates a default value.
+        @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.
+        @param size
+            Toggle button size. If wxDefaultSize is specified then a
+        default size is chosen.
+        @param style
+            Window style. See wxToggleButton.
+        @param validator
+            Window validator.
+        @param name
+            Window name.
+
+        @see Create(), wxValidator
+    */
+    wxToggleButton();
+    wxToggleButton(wxWindow* parent, wxWindowID id,
+                   const wxString& label,
+                   const wxPoint& pos = wxDefaultPosition,
+                   const wxSize& size = wxDefaultSize,
+                   long style = 0,
+                   const wxValidator& val = wxDefaultValidator,
+                   const wxString& name = "checkBox");
+    //@}
+
+    /**
+        Destructor, destroying the toggle button.
+    */
+    virtual ~wxToggleButton();
+
+    /**
+        Creates the toggle button for two-step construction. See wxToggleButton()
+        for details.
+    */
+    bool Create(wxWindow* parent, wxWindowID id,
+                const wxString& label,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxValidator& val = wxDefaultValidator,
+                const wxString& name = "checkBox");
+
+    /**
+        Gets the state of the toggle button.
+
+        @return Returns @true if it is pressed, @false otherwise.
+    */
+    bool GetValue() const;
+
+    /**
+        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.
+    */
+    void SetValue(bool state);
+};
+
+
+/**
+    @class wxBitmapToggleButton
+    @wxheader{tglbtn.h}
+
+    wxBitmapToggleButton is a wxToggleButton
+    that contains a bitmap instead of text.
+
+    This control emits an update UI event.
+
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_TOGGLEBUTTON(id, func)}
+           Handles a toggle button click event.
+    @endEventTable
+
+    @library{wxcore}
+    @category{ctrl}
+    <!-- @appearance{bitmaptogglebutton.png} -->
+*/
+class wxBitmapToggleButton : public wxControl
+{
+public:
+    //@{
+    /**
+        Constructor, creating and showing a toggle button with the bitmap @e label.
+        Internally calls Create().
+    */
+    wxBitmapToggleButton();
+    wxBitmapToggleButton(wxWindow* parent, wxWindowID id,
+                         const wxBitmap& label,
+                         const wxPoint& pos = wxDefaultPosition,
+                         const wxSize& size = wxDefaultSize,
+                         long style = 0,
+                         const wxValidator& val = wxDefaultValidator,
+                         const wxString& name = "checkBox");
+    //@}
+
+    /**
+        Create method for two-step construction.
+    */
+    bool Create(wxWindow* parent, wxWindowID id,
+                const wxBitmap& label,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxValidator& val = wxDefaultValidator,
+                const wxString& name = "checkBox");
+
+    /**
+        Gets the state of the toggle button.
+
+        @return Returns @true if it is pressed, @false otherwise.
+    */
+    virtual bool GetValue() const;
+
+    /**
+        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.
+    */
+    virtual void SetValue(bool state);
+};
+