## wxButton

A button is a control that contains a text string, and is one of the most common elements of a GUI. It may be placed on a dialog box or panel, or indeed almost any other window.

Derived from

wxControl
wxWindow
wxEvtHandler
wxObject

Include files

<wx/button.h>

Window styles

wxBU_LEFT | Left-justifies the label. Windows and GTK+ only.
wxBU_TOP | Aligns the label to the top of the button. Windows and GTK+ only.
wxBU_RIGHT | Right-justifies the bitmap label. Windows and GTK+ only.
wxBU_BOTTOM | Aligns the label to the bottom of the button. Windows and GTK+ only.
wxBU_EXACTFIT | Creates the button as small as possible instead of making it of the standard size (which is the default behaviour ).
wxNO_BORDER | Creates a flat button. Windows and GTK+ only.

See also window styles overview.

Event handling

EVT_BUTTON(id, func) | Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.

See also

wxBitmapButton

Members

wxButton::wxButton
wxButton::~wxButton
wxButton::Create
wxButton::GetLabel
wxButton::GetDefaultSize
wxButton::SetDefault
wxButton::SetLabel

### wxButton::wxButton

wxButton()

Default constructor.

wxButton(wxWindow* parent, wxWindowID id, const wxString& label = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "button")

Constructor, creating and showing a button.

The preferred way to create standard buttons is to use default value of label. If no label is supplied and id is one of standard IDs from this list, standard label will be used. In addition to that, the button will be decorated with stock icons under GTK+ 2.

Parameters

parent

Parent window. Must not be NULL.

id

Button identifier. A value of `wxID_ANY` indicates a default value.

label

Text to be displayed on the button.

pos

Button position.

size

Button size. If the default size is specified then the button is sized appropriately for the text.

style

Window style. See wxButton.

validator

Window validator.

name

Window name.

See also

wxButton::Create, wxValidator

### wxButton::~wxButton

~wxButton()

Destructor, destroying the button.

### wxButton::Create

bool Create(wxWindow* parent, wxWindowID id, const wxString& label = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, const wxValidator& validator, const wxString& name = "button")

Button creation function for two-step creation. For more details, see wxButton::wxButton.

### wxButton::GetLabel

wxString GetLabel() const

Returns the string label for the button.

Return value

The button's label.

See also

wxButton::SetLabel

### wxButton::GetDefaultSize

wxSize GetDefaultSize()

Returns the default size for the buttons. It is advised to make all the dialog buttons of the same size and this function allows to retrieve the (platform and current font dependent size) which should be the best suited for this.

### wxButton::SetDefault

void SetDefault()

This sets the button to be the default item for the panel or dialog box.

Remarks

Under Windows, only dialog box buttons respond to this function. As normal under Windows and Motif, pressing return causes the default button to be depressed when the return key is pressed. See also wxWindow::SetFocus which sets the keyboard focus for windows and text panel items, and wxPanel::SetDefaultItem.

Note that under Motif, calling this function immediately after creation of a button and before the creation of other buttons will cause misalignment of the row of buttons, since default buttons are larger. To get around this, call SetDefault after you have created a row of buttons: wxWidgets will then set the size of all buttons currently on the panel to the same size.

### wxButton::SetLabel

void SetLabel(const wxString& label)

Sets the string label for the button.

Parameters

label

The label to set.

See also

wxButton::GetLabel