]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/button.h
take const wxConfig object in wxDocManager::FileHistoryLoad() and wxFileHistory:...
[wxWidgets.git] / interface / button.h
index 4a63ff78a3beb106a37e2f1d203faacab8a7d285..67e13cc77f0f8241ddf01c18b8a54ff8aea12318 100644 (file)
     or indeed on almost any other window.
 
     @beginStyleTable
-    @style{wxBU_LEFT}:
+    @style{wxBU_LEFT}
            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.
-    @style{wxBU_RIGHT}:
+    @style{wxBU_RIGHT}
            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.
-    @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 ).
-    @style{wxBORDER_NONE}:
+    @style{wxBORDER_NONE}
            Creates a flat button. Windows and GTK+ only.
     @endStyleTable
 
-    @beginEventTable
-    @event{EVT_BUTTON(id, func)}:
+    @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}
+    <!-- @appearance{button.png} -->
 
     @see wxBitmapButton
 */
@@ -86,12 +86,12 @@ public:
              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.
@@ -102,15 +102,15 @@ public:
                 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.
@@ -120,7 +120,8 @@ public:
     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.
@@ -129,8 +130,10 @@ public:
         and text panel items, and wxTopLevelWindow::SetDefaultItem().
 
         @remarks Under Windows, only dialog box buttons respond to this function.
+
+        @return the old default item (possibly NULL)
     */
-    void SetDefault();
+    virtual wxWindow* SetDefault();
 
     /**
         Sets the string label for the button.