document GetValue() behaviour when called from an event handler processing change...

[wxWidgets.git] / interface / bmpbuttn.h

diff --git a/interface/bmpbuttn.h b/interface/bmpbuttn.h
index 58b5e32e1cae3aab52efb5542ee8ff0dfd8a78b9..89dcca967714f314a772040cbc7c6f8aa5fbdb37 100644 (file)
--- a/interface/bmpbuttn.h
+++ b/interface/bmpbuttn.h
@@ -35,19 +35,19 @@
         to get reasonably good behaviour on all platforms.
 
     @beginStyleTable
         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.
            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.
            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.
            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.
            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
            Aligns the bitmap label to the bottom of the button.
            Has effect only under MS Windows.
     @endStyleTable


@@ -55,14 +55,14 @@
     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.
 
     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
 
     @library{wxcore}
     @category{ctrl}
            Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
     @endEventTable
 
     @library{wxcore}
     @category{ctrl}

-    @appearance{bitmapbutton.png}
+    <!-- @appearance{bitmapbutton.png} -->

 
     @see wxButton
 */
 
     @see wxButton
 */


@@ -108,12 +108,12 @@ public:
                    const wxSize& size = wxDefaultSize,
                    long style = wxBU_AUTODRAW,
                    const wxValidator& validator = wxDefaultValidator,
                    const wxSize& size = wxDefaultSize,
                    long style = wxBU_AUTODRAW,
                    const wxValidator& validator = wxDefaultValidator,

-                   const wxString& name = "button");
+                   const wxString& name = wxButtonNameStr);

 
     /**
         Destructor, destroying the button.
     */
 
     /**
         Destructor, destroying the button.
     */

-    ~wxBitmapButton();
+    virtual ~wxBitmapButton();

 
     /**
         Button creation function for two-step creation.
 
     /**
         Button creation function for two-step creation.


@@ -121,17 +121,17 @@ public:
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxBitmap& bitmap,
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxBitmap& bitmap,

-                const wxPoint& pos,
+                const wxPoint& pos = wxDefaultPosition,

                 const wxSize& size = wxDefaultSize,
                 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);

 
     //@{
     /**
         Returns the bitmap for the disabled state, which may be invalid.
 
 
     //@{
     /**
         Returns the bitmap for the disabled state, which may be invalid.
 

-        @returns A reference to the disabled state bitmap.
+        @return A reference to the disabled state bitmap.

 
         @see SetBitmapDisabled()
     */
 
         @see SetBitmapDisabled()
     */


@@ -143,7 +143,7 @@ public:
     /**
         Returns the bitmap for the focused state, which may be invalid.
 
     /**
         Returns the bitmap for the focused state, which may be invalid.
 

-        @returns A reference to the focused state bitmap.
+        @return A reference to the focused state bitmap.

 
         @see SetBitmapFocus()
     */
 
         @see SetBitmapFocus()
     */


@@ -165,7 +165,7 @@ public:
     /**
         Returns the label bitmap (the one passed to the constructor), always valid.
 
     /**
         Returns the label bitmap (the one passed to the constructor), always valid.
 

-        @returns A reference to the button's label bitmap.
+        @return A reference to the button's label bitmap.

 
         @see SetBitmapLabel()
     */
 
         @see SetBitmapLabel()
     */


@@ -176,11 +176,11 @@ public:
     /**
         Returns the bitmap for the selected state.
 
     /**
         Returns the bitmap for the selected state.
 

-        @returns A reference to the selected state bitmap.
+        @return A reference to the selected state bitmap.

 
         @see SetBitmapSelected()
     */
 
         @see SetBitmapSelected()
     */

-    wxBitmap& GetBitmapSelected() const;
+    const wxBitmap& GetBitmapSelected() const;

 
     /**
         Sets the bitmap for the disabled button appearance.
 
     /**
         Sets the bitmap for the disabled button appearance.


@@ -191,7 +191,7 @@ public:
         @see GetBitmapDisabled(), SetBitmapLabel(),
              SetBitmapSelected(), SetBitmapFocus()
     */
         @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.
 
     /**
         Sets the bitmap for the button appearance when it has the keyboard focus.


@@ -202,18 +202,18 @@ public:
         @see GetBitmapFocus(), SetBitmapLabel(),
              SetBitmapSelected(), SetBitmapDisabled()
     */
         @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.
 
 
     /**
         Sets the bitmap to be shown when the mouse is over the button.
 

-        @wxsince{2.7.0}
+        @since 2.7.0

 
         The hover bitmap is currently only supported in wxMSW.
 
         @see GetBitmapHover()
     */
 
         The hover bitmap is currently only supported in wxMSW.
 
         @see GetBitmapHover()
     */

-    void SetBitmapHover(const wxBitmap& bitmap);
+    virtual void SetBitmapHover(const wxBitmap& bitmap);

 
     /**
         Sets the bitmap label for the button.
 
     /**
         Sets the bitmap label for the button.


@@ -226,7 +226,7 @@ public:
 
         @see GetBitmapLabel()
     */
 
         @see GetBitmapLabel()
     */

-    void SetBitmapLabel(const wxBitmap& bitmap);
+    virtual void SetBitmapLabel(const wxBitmap& bitmap);

 
     /**
         Sets the bitmap for the selected (depressed) button appearance.
 
     /**
         Sets the bitmap for the selected (depressed) button appearance.


@@ -234,6 +234,6 @@ public:
         @param bitmap
             The bitmap to set.
     */
         @param bitmap
             The bitmap to set.
     */

-    void SetBitmapSelected(const wxBitmap& bitmap);
+    virtual void SetBitmapSelected(const wxBitmap& bitmap);

 };
 
 };