wxBitmapButton — wx v2.4.3.1

Search documentation of wx

# wxBitmapButton (wx v2.4.3.1)

View Source

A bitmap button is a control that contains a bitmap.

Notice that since wxWidgets 2.9.1 bitmap display is supported by the base `wxButton` class itself and the only tiny advantage of using this class is that it allows specifying the bitmap in its constructor, unlike `wxButton`. Please see the base class documentation for more information about images support in `wxButton`.

## Styles

This class supports the following styles:

- wxBU_LEFT: Left-justifies the bitmap label.

- wxBU_TOP: Aligns the bitmap label to the top of the button.

- wxBU_RIGHT: Right-justifies the bitmap label.

- wxBU_BOTTOM: Aligns the bitmap label to the bottom of the button. 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.

See: `wxButton`

This class is derived, and can use functions, from:

- `wxButton`

- `wxControl`

- `wxWindow`

- `wxEvtHandler`

wxWidgets docs: wxBitmapButton

## Events

Event types emitted from this class:

- `command_button_clicked`

# Summary

## Types

wxBitmapButton()

## Functions

create(This, Parent, Id, Bitmap)

Equivalent to `create(This, Parent, Id, Bitmap, [])`.

create/5

Button creation function for two-step creation.

destroy(This)

Destroys the object

new()

Default ctor.

new(Parent, Id, Bitmap)

Equivalent to `new(Parent, Id, Bitmap, [])`.

new/4

Constructor, creating and showing a button.

newCloseButton(Parent, Winid)

Helper function creating a standard-looking "Close" button.

# Types

# wxBitmapButton()

    -type wxBitmapButton() :: wx:wx_object().

# Functions

# create(This, Parent, Id, Bitmap)

    -spec create(This, Parent, Id, Bitmap) -> boolean()
                    when
                        This :: wxBitmapButton(),
                        Parent :: wxWindow:wxWindow(),
                        Id :: integer(),
                        Bitmap :: wxBitmap:wxBitmap().

Equivalent to `create(This, Parent, Id, Bitmap, [])`.

# create/5

    -spec create(This, Parent, Id, Bitmap, [Option]) -> boolean()
                    when
                        This :: wxBitmapButton(),
                        Parent :: wxWindow:wxWindow(),
                        Id :: integer(),
                        Bitmap :: wxBitmap:wxBitmap(),
                        Option ::
                            {pos, {X :: integer(), Y :: integer()}} |
                            {size, {W :: integer(), H :: integer()}} |
                            {style, integer()} |
                            {validator, wx:wx_object()}.

Button creation function for two-step creation.

For more details, see `new/4`.

# destroy(This)

    -spec destroy(This :: wxBitmapButton()) -> ok.

Destroys the object

# new()

    -spec new() -> wxBitmapButton().

Default ctor.

# new(Parent, Id, Bitmap)

    -spec new(Parent, Id, Bitmap) -> wxBitmapButton()
                 when Parent :: wxWindow:wxWindow(), Id :: integer(), Bitmap :: wxBitmap:wxBitmap().

Equivalent to `new(Parent, Id, Bitmap, [])`.

# new/4

    -spec new(Parent, Id, Bitmap, [Option]) -> wxBitmapButton()
                 when
                     Parent :: wxWindow:wxWindow(),
                     Id :: integer(),
                     Bitmap :: wxBitmap:wxBitmap(),
                     Option ::
                         {pos, {X :: integer(), Y :: integer()}} |
                         {size, {W :: integer(), H :: integer()}} |
                         {style, integer()} |
                         {validator, wx:wx_object()}.

Constructor, creating and showing a button.

Remark: The bitmap parameter is normally the only bitmap you need to provide, and wxWidgets will draw the button correctly in its different states. If you want more control, call any of the functions `SetBitmapPressed()` (not implemented in wx), `wxButton:setBitmapFocus/2`, `wxButton:setBitmapDisabled/2`.

See: `create/5`

# newCloseButton(Parent, Winid)

    -spec newCloseButton(Parent, Winid) -> wxBitmapButton()
                            when Parent :: wxWindow:wxWindow(), Winid :: integer().

Helper function creating a standard-looking "Close" button.

To get the best results, platform-specific code may need to be used to create a small, title bar-like "Close" button. This function is provided to avoid the need to test for the current platform and creates the button with as native look as possible.

Return: The new button.

Since: 2.9.5