no real changes, clarified the usage of WX_GL_DOUBLEBUFFER; documented it and other...

[wxWidgets.git] / interface / button.h

diff --git a/interface/button.h b/interface/button.h
index 78619a6c4519c5b0e4a4d54e84f76ef1d3e41fb2..afb7dee205f66eaa9174a5771107d71eee384583 100644 (file)
--- a/interface/button.h
+++ b/interface/button.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        button.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        button.h

-// Purpose:     documentation for wxButton class
+// Purpose:     interface of wxButton

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -10,141 +10,137 @@
     @class wxButton
     @wxheader{button.h}
 
     @class wxButton
     @wxheader{button.h}
 

-    A button is a control that contains a text string,
-    and is one of the most common elements of a GUI. It may be placed on a
-    @ref overview_wxdialog "dialog box" or panel, or indeed
-    almost any other window.
+    A button is a control that contains a text string, and is one of the most
+    common elements of a GUI.
+
+    It may be placed on a @ref wxDialog "dialog box" or on a @ref wxPanel panel,
+    or indeed on almost any other window.

 
     @beginStyleTable
 
     @beginStyleTable

-    @style{wxBU_LEFT}:
+    @style{wxBU_LEFT}

            Left-justifies the label. Windows and GTK+ only.
            Left-justifies the label. Windows and GTK+ only.

-    @style{wxBU_TOP}:
+    @style{wxBU_TOP}

            Aligns the label to the top of the button. Windows and GTK+ only.
            Aligns the label to the top of the button. Windows and GTK+ only.

-    @style{wxBU_RIGHT}:
+    @style{wxBU_RIGHT}

            Right-justifies the bitmap label. Windows and GTK+ only.
            Right-justifies the bitmap label. Windows and GTK+ only.

-    @style{wxBU_BOTTOM}:
+    @style{wxBU_BOTTOM}

            Aligns the label to the bottom of the button. Windows and GTK+ only.
            Aligns the label to the bottom of the button. Windows and GTK+ only.

-    @style{wxBU_EXACTFIT}:
+    @style{wxBU_EXACTFIT}

            Creates the button as small as possible instead of making it of the
            standard size (which is the default behaviour ).
            Creates the button as small as possible instead of making it of the
            standard size (which is the default behaviour ).

-    @style{wxBORDER_NONE}:
+    @style{wxBORDER_NONE}

            Creates a flat button. Windows and GTK+ only.
     @endStyleTable
 
            Creates a flat button. Windows and GTK+ only.
     @endStyleTable
 

-    @beginEventTable
-    @event{EVT_BUTTON(id\, func)}:
-           Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is
-           clicked.
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_BUTTON(id, func)}
+           Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.

     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
     @appearance{button.png}
 
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
     @appearance{button.png}
 

-    @seealso
-    wxBitmapButton
+    @see wxBitmapButton

 */
 class wxButton : public wxControl
 {
 public:
 */
 class wxButton : public wxControl
 {
 public:

-    //@{
+    /**
+        Default ctor.
+    */
+    wxButton();
+

     /**
         Constructor, creating and showing a button.
     /**
         Constructor, creating and showing a button.

-        
+

         The preferred way to create standard buttons is to use default value of
         The preferred way to create standard buttons is to use default value of

-        @e label. If no label is supplied and @e id is one of standard IDs from
-        @ref overview_stockitems "this list", standard label will be used. In addition
-        to
-        that, the button will be decorated with stock icons under GTK+ 2.
-        
+        @a label. If no label is supplied and @a id is one of standard IDs from
+        @ref page_stockitems "this list", a standard label will be used.
+
+        In addition to that, the button will be decorated with stock icons under GTK+ 2.
+

         @param parent
         @param parent

-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.

         @param id
         @param id

-        Button identifier. A value of wxID_ANY indicates a default value.
-        
+            Button identifier. A value of wxID_ANY indicates a default value.

         @param label
         @param label

-        Text to be displayed on the button.
-        
+            Text to be displayed on the button.

         @param pos
         @param pos

-        Button position.
-        
+            Button position.

         @param size
         @param size

-        Button size. If the default size is specified then the button is sized
-        appropriately for the text.
-        
+            Button size. If the default size is specified then the button is sized
+            appropriately for the text.

         @param style
         @param style

-        Window style. See wxButton.
-        
+            Window style. See wxButton class description.

         @param validator
         @param validator

-        Window validator.
-        
+            Window validator.

         @param name
         @param name

-        Window name.
-        
-        @sa Create(), wxValidator
+            Window name.
+
+        @see Create(), wxValidator

     */
     */

-    wxButton();

     wxButton(wxWindow* parent, wxWindowID id,
              const wxString& label = wxEmptyString,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              const wxValidator& validator = wxDefaultValidator,
     wxButton(wxWindow* parent, wxWindowID id,
              const wxString& label = wxEmptyString,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              const wxValidator& validator = wxDefaultValidator,

-             const wxString& name = "button");
-    //@}
+             const wxString& name = wxButtonNameStr);

 
     /**
         Destructor, destroying the button.
     */
 
     /**
         Destructor, destroying the button.
     */

-    ~wxButton();
+    virtual ~wxButton();

 
     /**
 
     /**

-        Button creation function for two-step creation. For more details, see
-        wxButton().
+        Button creation function for two-step creation.
+        For more details, see wxButton().

     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& label = wxEmptyString,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& label = wxEmptyString,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,

-                const wxValidator& validator,
-                const wxString& name = "button");
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxButtonNameStr);

 
     /**
         Returns the default size for the buttons. It is advised to make all the dialog
         buttons of the same size and this function allows to retrieve the (platform and
         current font dependent size) which should be the best suited for this.
     */
 
     /**
         Returns the default size for the buttons. It is advised to make all the dialog
         buttons of the same size and this function allows to retrieve the (platform and
         current font dependent size) which should be the best suited for this.
     */

-    wxSize GetDefaultSize();
+    static wxSize GetDefaultSize();

 
     /**
         Returns the string label for the button.
 
     /**
         Returns the string label for the button.

-        
-        @returns The button's label.
-        
-        @sa SetLabel()
+
+        @see SetLabel()

     */
     */

-    wxString GetLabel();
+    wxString GetLabel() const;

 
     /**
 
     /**

-        This sets the button to be the default item for the panel or dialog
-        box.
-        
+        This sets the button to be the default item in its top-level window
+        (e.g. the panel or the dialog box containing it).
+
+        As normal, pressing return causes the default button to be depressed when
+        the return key is pressed.
+
+        See also wxWindow::SetFocus() which sets the keyboard focus for windows
+        and text panel items, and wxTopLevelWindow::SetDefaultItem().
+

         @remarks Under Windows, only dialog box buttons respond to this function.
         @remarks Under Windows, only dialog box buttons respond to this function.

-                    As normal under Windows and Motif, pressing return
-                   causes the default button to be depressed when the
-                   return key is pressed. See also wxWindow::SetFocus
-                   which sets the keyboard focus for windows and text
-                   panel items, and wxTopLevelWindow::SetDefaultItem.
+
+        @returns the old default item (possibly NULL)

     */
     */

-    void SetDefault();
+    virtual wxWindow* SetDefault();

 
     /**
         Sets the string label for the button.
 
     /**
         Sets the string label for the button.

-        
+

         @param label
         @param label

-        The label to set.
+            The label to set.

     */
     void SetLabel(const wxString& label);
 };
     */
     void SetLabel(const wxString& label);
 };

+