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
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}
- @appearance{bitmapbutton.png}
+ <!-- @appearance{bitmapbutton.png} -->
@see wxButton
*/
const wxSize& size = wxDefaultSize,
long style = wxBU_AUTODRAW,
const wxValidator& validator = wxDefaultValidator,
- const wxString& name = "button");
+ const wxString& name = wxButtonNameStr);
/**
Destructor, destroying the button.
*/
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);
//@{
/**
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()
*/
/**
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()
*/
/**
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()
*/
/**
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()
*/
- wxBitmap& GetBitmapSelected() const;
+ const wxBitmap& GetBitmapSelected() const;
/**
Sets the bitmap for the disabled button appearance.
/**
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.