Simplify and correct MSW selection of background brush for children painting.

[wxWidgets.git] / interface / wx / button.h

diff --git a/interface/wx/button.h b/interface/wx/button.h
index 764d87fca57b8b5187d840e0d7985e12573ad5ae..9aad73ed38519311acf36a7557de786beb5ef6d4 100644 (file)
--- a/interface/wx/button.h
+++ b/interface/wx/button.h
@@ -34,8 +34,8 @@
         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 ports but in the latter only applies to buttons with
-        bitmaps and using bitmap of one of the standard sizes only, namely
+        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
@@ -54,14 +54,16 @@
     @endEventTable
 
 
-    Since version 2.9.1 wxButton supports showing both text and an image, see
+    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
     previous wxWidgets versions this functionality was only available in (the
     now trivial) wxBitmapButton class which was only capable of showing an
     image without text.
 
     A button may have either a single image for all states or different images
-    for the following states:
+    for the following states (different images are not currently supported
+    under OS X where the normal image is used for all states):
     @li @b normal: the default state
     @li @b disabled: bitmap shown when the button is disabled.
     @li @b pressed: bitmap shown when the button is pushed (e.g. while the user
@@ -81,6 +83,11 @@
     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
+    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.
+
     @library{wxcore}
     @category{ctrl}
     @appearance{button.png}
@@ -144,6 +151,19 @@ public:
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxButtonNameStr);
 
+    /**
+        Returns @true if an authentication needed symbol is displayed on the
+        button.
+
+        @remarks This method always returns @false if the platform is not
+                 Windows Vista or newer.
+
+        @see SetAuthNeeded()
+
+        @since 2.9.1
+     */
+    bool GetAuthNeeded() const;
+
     /**
         Return the bitmap shown by the button.
 
@@ -207,6 +227,15 @@ public:
     */
     wxBitmap GetBitmapPressed() const;
 
+    /**
+        Get the margins between the bitmap and the text of the button.
+
+        @see SetBitmapMargins()
+
+        @since 2.9.1
+     */
+    wxSize GetBitmapMargins();
+
     /**
         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
@@ -221,6 +250,19 @@ public:
     */
     wxString GetLabel() const;
 
+    /**
+        Sets whether an authentication needed symbol should be displayed on the
+        button.
+
+        @remarks This method doesn't do anything if the platform is not Windows
+                 Vista or newer.
+
+        @see GetAuthNeeded()
+
+        @since 2.9.1
+     */
+    void SetAuthNeeded(bool needed = true);
+
     /**
         Sets the bitmap to display in the button.