added convenient wxON_BLOCK_EXIT_THISn() macros wrapping wxON_BLOCK_EXIT_OBJn(*this)

[wxWidgets.git] / interface / button.h

diff --git a/interface/button.h b/interface/button.h
index 3db1b2dcc3b99c0a4cfc50ad77a983227cf710f7..5cc9bad0f732c65b8d7891491eadacde9ff1fe9f 100644 (file)
--- a/interface/button.h
+++ b/interface/button.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        button.h
-// Purpose:     documentation for wxButton class
+// Purpose:     interface of wxButton
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -10,10 +10,11 @@
     @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
     @style{wxBU_LEFT}:
@@ -33,29 +34,32 @@
 
     @beginEventTable
     @event{EVT_BUTTON(id, func)}:
-           Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is
-           clicked.
+           Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}
     @appearance{button.png}
 
-    @seealso
-    wxBitmapButton
+    @see wxBitmapButton
 */
 class wxButton : public wxControl
 {
 public:
-    //@{
+    /**
+        Default ctor.
+    */
+    wxButton();
+
     /**
         Constructor, creating and showing a button.
+
         The preferred way to create standard buttons is to use default value of
-        @e label. If no label is supplied and @a 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
             Parent window. Must not be @NULL.
         @param id
@@ -68,75 +72,72 @@ public:
             Button size. If the default size is specified then the button is sized
             appropriately for the text.
         @param style
-            Window style. See wxButton.
+            Window style. See wxButton class description.
         @param validator
             Window validator.
         @param name
             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,
-             const wxString& name = "button");
-    //@}
+             const wxString& name = wxButtonNameStr);
 
     /**
         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,
-                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.
     */
-    wxSize GetDefaultSize();
+    static wxSize GetDefaultSize();
 
     /**
         Returns the string label for the button.
-        
-        @returns The button's label.
-        
+
         @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 for the panel or dialog box.
+
+        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.
-                  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.
     */
     void SetDefault();
 
     /**
         Sets the string label for the button.
-        
+
         @param label
             The label to set.
     */
     void SetLabel(const wxString& label);
 };
+