X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/884a3e9d375ed780dbd4677f3c56acc4b71f70a8..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/button.h?ds=sidebyside

diff --git a/interface/wx/button.h b/interface/wx/button.h
index 30c8e5f337..afbb6d3637 100644
--- a/interface/wx/button.h
+++ b/interface/wx/button.h
@@ -2,7 +2,6 @@
 // Name:        button.h
 // Purpose:     interface of wxButton
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -16,31 +15,6 @@
     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}
-        Left-justifies the label. Windows and GTK+ only.
-    @style{wxBU_TOP}
-        Aligns the label to the top of the button. Windows and GTK+ only.
-    @style{wxBU_RIGHT}
-        Right-justifies the bitmap label. Windows and GTK+ only.
-    @style{wxBU_BOTTOM}
-        Aligns the label to the bottom of the button. Windows and GTK+ only.
-    @style{wxBU_EXACTFIT}
-        Creates the button as small as possible instead of making it of the
-        standard size (which is the default behaviour ).
-    @style{wxBU_NOTEXT}
-        Disables the display of the text label in the button even if it has one
-        or its id is one of the standard stock ids with an associated label:
-        without using this style a button which is only supposed to show a
-        bitmap but uses a standard id would display a label too.
-    @style{wxBORDER_NONE}
-        Creates a button without border. This is currently implemented in MSW,
-        GTK2 and OSX/Carbon ports but in the latter only applies to buttons
-        with bitmaps and using bitmap of one of the standard sizes only, namely
-        128*128, 48*48, 24*24 or 16*16. In all the other cases wxBORDER_NONE is
-        ignored under OSX.
-    @endStyleTable
-
     By default, i.e. if none of the alignment styles are specified, the label
     is centered both horizontally and vertically. If the button has both a
     label and a bitmap, the alignment styles above specify the location of the
@@ -49,12 +23,6 @@
     bitmap with respect to the label (however currently non-default alignment
     combinations are not implemented on all platforms).
 
-    @beginEventEmissionTable{wxCommandEvent}
-    @event{EVT_BUTTON(id, func)}
-           Process a @c wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
-    @endEventTable
-
-
     Since version 2.9.1 wxButton supports showing both text and an image
     (currently only when using wxMSW, wxGTK or wxOSX/Cocoa ports), see
     SetBitmap() and SetBitmapLabel(), SetBitmapDisabled() &c methods. In the
@@ -88,14 +56,50 @@
     The position of the image inside the button be configured using
     SetBitmapPosition(). By default the image is on the left of the text.
 
-    Please also notice that GTK+ uses a global setting called @c
-    gtk-button-images to determine if the images should be shown in the buttons
+    Please also notice that GTK+ uses a global setting called @c gtk-button-images 
+    to determine if the images should be shown in the buttons
     at all. If it is off (which is the case in e.g. Gnome 2.28 by default), no
     images will be shown, consistently with the native behaviour.
 
+    @beginStyleTable
+    @style{wxBU_LEFT}
+        Left-justifies the label. Windows and GTK+ only.
+    @style{wxBU_TOP}
+        Aligns the label to the top of the button. Windows and GTK+ only.
+    @style{wxBU_RIGHT}
+        Right-justifies the bitmap label. Windows and GTK+ only.
+    @style{wxBU_BOTTOM}
+        Aligns the label to the bottom of the button. Windows and GTK+ only.
+    @style{wxBU_EXACTFIT}
+        By default, all buttons are made of at least the standard button size,
+        even if their contents is small enough to fit into a smaller size. This
+        is done for consistency as most platforms use buttons of the same size
+        in the native dialogs, but can be overridden by specifying this flag.
+        If it is given, the button will be made just big enough for its
+        contents. Notice that under MSW the button will still have at least the
+        standard height, even with this style, if it has a non-empty label.
+    @style{wxBU_NOTEXT}
+        Disables the display of the text label in the button even if it has one
+        or its id is one of the standard stock ids with an associated label:
+        without using this style a button which is only supposed to show a
+        bitmap but uses a standard id would display a label too.
+    @style{wxBORDER_NONE}
+        Creates a button without border. This is currently implemented in MSW,
+        GTK2 and OSX/Cocoa and OSX/Carbon ports but in the latter only applies
+        to buttons with bitmaps and using bitmap of one of the standard sizes
+        only, namely 128*128, 48*48, 24*24 or 16*16. In all the other cases
+        wxBORDER_NONE is ignored under OSX/Carbon (these restrictions don't
+        exist in OSX/Cocoa however).
+    @endStyleTable
+
+    @beginEventEmissionTable{wxCommandEvent}
+    @event{EVT_BUTTON(id, func)}
+           Process a @c wxEVT_BUTTON event, when the button is clicked.
+    @endEventTable
+
     @library{wxcore}
     @category{ctrl}
-    @appearance{button.png}
+    @appearance{button}
 
     @see wxBitmapButton
 */
@@ -127,7 +131,7 @@ public:
         @param parent
             Parent window. Must not be @NULL.
         @param id
-            Button identifier. A value of wxID_ANY indicates a default value.
+            Button identifier. A value of @c wxID_ANY indicates a default value.
         @param label
             Text to be displayed on the button.
         @param pos
@@ -218,7 +222,7 @@ public:
 
         @remarks Under Windows, only dialog box buttons respond to this function.
 
-        @return the old default item (possibly NULL)
+        @return the old default item (possibly @NULL)
     */
     virtual wxWindow* SetDefault();