From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 15 Jun 2009 23:18:06 +0000 (+0000)
Subject: minor tweaks to alignment styles documentation
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/0f5fe332828c082195b265dbcccb9eb2b4d98817

minor tweaks to alignment styles documentation

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@61072 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/interface/wx/bmpbuttn.h b/interface/wx/bmpbuttn.h
index 1d352d856a..91223e9ef7 100644
--- a/interface/wx/bmpbuttn.h
+++ b/interface/wx/bmpbuttn.h
@@ -18,21 +18,14 @@
     support in wxButton.
 
     @beginStyleTable
-    @style{wxBU_AUTODRAW}
-           If this is specified, the button will be drawn automatically using
-           the label bitmap only, providing a 3D-look border. If this style is
-           not specified, the button will be drawn without borders and using
-           all provided bitmaps. Has effect only under MS Windows.
     @style{wxBU_LEFT}
-           Left-justifies the bitmap label. Has effect only under MS Windows.
+           Left-justifies the bitmap label.
     @style{wxBU_TOP}
            Aligns the bitmap label to the top of the button.
-           Has effect only under MS Windows.
     @style{wxBU_RIGHT}
-           Right-justifies the bitmap label. Has effect only under MS Windows.
+           Right-justifies the bitmap label.
     @style{wxBU_BOTTOM}
            Aligns the bitmap label to the bottom of the button.
-           Has effect only under MS Windows.
     @endStyleTable
 
     Note that the wxBU_EXACTFIT style supported by wxButton is not used by this
diff --git a/interface/wx/button.h b/interface/wx/button.h
index fa2882bc24..0ad5d3482f 100644
--- a/interface/wx/button.h
+++ b/interface/wx/button.h
@@ -31,6 +31,14 @@
            Creates a flat button. Windows and GTK+ only.
     @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
+    rectangle combining both the label and the bitmap and the bitmap position
+    set with wxButton::SetBitmapPosition() defines the relative position of the
+    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 wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.