First attempt to document raw bitmap access

[wxWidgets.git] / interface / bmpbuttn.h

diff --git a/interface/bmpbuttn.h b/interface/bmpbuttn.h
index 58b5e32e1cae3aab52efb5542ee8ff0dfd8a78b9..6d80e607b7ca72578cd141d0120adb2dbb854fd3 100644 (file)
--- a/interface/bmpbuttn.h
+++ b/interface/bmpbuttn.h
@@ -35,19 +35,19 @@
         to get reasonably good behaviour on all platforms.
 
     @beginStyleTable
-    @style{wxBU_AUTODRAW}:
+    @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}:
+    @style{wxBU_LEFT}
            Left-justifies the bitmap label. Has effect only under MS Windows.
-    @style{wxBU_TOP}:
+    @style{wxBU_TOP}
            Aligns the bitmap label to the top of the button.
            Has effect only under MS Windows.
-    @style{wxBU_RIGHT}:
+    @style{wxBU_RIGHT}
            Right-justifies the bitmap label. Has effect only under MS Windows.
-    @style{wxBU_BOTTOM}:
+    @style{wxBU_BOTTOM}
            Aligns the bitmap label to the bottom of the button.
            Has effect only under MS Windows.
     @endStyleTable
@@ -55,8 +55,8 @@
     Note that the wxBU_EXACTFIT style supported by wxButton is not used by this
     class as bitmap buttons don't have any minimal standard size by default.
 
-    @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
 
@@ -108,12 +108,12 @@ public:
                    const wxSize& size = wxDefaultSize,
                    long style = wxBU_AUTODRAW,
                    const wxValidator& validator = wxDefaultValidator,
-                   const wxString& name = "button");
+                   const wxString& name = wxButtonNameStr);
 
     /**
         Destructor, destroying the button.
     */
-    ~wxBitmapButton();
+    virtual ~wxBitmapButton();
 
     /**
         Button creation function for two-step creation.
@@ -121,11 +121,11 @@ public:
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxBitmap& bitmap,
-                const wxPoint& pos,
+                const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
-                long style = 0,
-                const wxValidator& validator,
-                const wxString& name = "button");
+                long style = wxBU_AUTODRAW,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxButtonNameStr);
 
     //@{
     /**
@@ -180,7 +180,7 @@ public:
 
         @see SetBitmapSelected()
     */
-    wxBitmap& GetBitmapSelected() const;
+    const wxBitmap& GetBitmapSelected() const;
 
     /**
         Sets the bitmap for the disabled button appearance.
@@ -191,7 +191,7 @@ public:
         @see GetBitmapDisabled(), SetBitmapLabel(),
              SetBitmapSelected(), SetBitmapFocus()
     */
-    void SetBitmapDisabled(const wxBitmap& bitmap);
+    virtual void SetBitmapDisabled(const wxBitmap& bitmap);
 
     /**
         Sets the bitmap for the button appearance when it has the keyboard focus.
@@ -202,7 +202,7 @@ public:
         @see GetBitmapFocus(), SetBitmapLabel(),
              SetBitmapSelected(), SetBitmapDisabled()
     */
-    void SetBitmapFocus(const wxBitmap& bitmap);
+    virtual void SetBitmapFocus(const wxBitmap& bitmap);
 
     /**
         Sets the bitmap to be shown when the mouse is over the button.
@@ -213,7 +213,7 @@ public:
 
         @see GetBitmapHover()
     */
-    void SetBitmapHover(const wxBitmap& bitmap);
+    virtual void SetBitmapHover(const wxBitmap& bitmap);
 
     /**
         Sets the bitmap label for the button.
@@ -226,7 +226,7 @@ public:
 
         @see GetBitmapLabel()
     */
-    void SetBitmapLabel(const wxBitmap& bitmap);
+    virtual void SetBitmapLabel(const wxBitmap& bitmap);
 
     /**
         Sets the bitmap for the selected (depressed) button appearance.
@@ -234,6 +234,6 @@ public:
         @param bitmap
             The bitmap to set.
     */
-    void SetBitmapSelected(const wxBitmap& bitmap);
+    virtual void SetBitmapSelected(const wxBitmap& bitmap);
 };