wxButton Class Reference
[Controls]

#include <wx/button.h>

Inheritance diagram for wxButton:

Inheritance graph
[legend]

Detailed Description

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 on a wxPanel panel, or indeed on almost any other window.

Styles

This class supports the following styles:

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxCommandEvent& event)
Event macros for events emitted by this class:

Library:  wxCore

Category:  Controls

Appearance:
wxMSW appearancewxGTK appearancewxMac appearance
wxMSW appearancewxGTK appearancewxMac appearance

See also:
wxBitmapButton

Public Member Functions

 wxButton ()
 Default ctor.
 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=wxButtonNameStr)
 Constructor, creating and showing a button.
virtual ~wxButton ()
 Destructor, destroying the button.
bool Create (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=wxButtonNameStr)
 Button creation function for two-step creation.
wxString GetLabel () const
 Returns the string label for the button.
virtual wxWindowSetDefault ()
 This sets the button to be the default item in its top-level window (e.g.
void SetLabel (const wxString &label)
 Sets the string label for the button.

Static Public Member Functions

static wxSize GetDefaultSize ()
 Returns the default size for the buttons.

List of all members.


Constructor & Destructor Documentation

wxButton::wxButton (  ) 

Default ctor.

wxButton::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 = wxButtonNameStr 
)

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, a 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 class description.
validator Window validator.
name Window name.
See also:
Create(), wxValidator

virtual wxButton::~wxButton (  )  [virtual]

Destructor, destroying the button.


Member Function Documentation

bool wxButton::Create ( 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 = wxButtonNameStr 
)

Button creation function for two-step creation.

For more details, see wxButton().

static wxSize wxButton::GetDefaultSize (  )  [static]

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.

wxString wxButton::GetLabel (  )  const [virtual]

Returns the string label for the button.

See also:
SetLabel()

Reimplemented from wxControl.

virtual wxWindow* wxButton::SetDefault (  )  [virtual]

This sets the button to be the default item in its top-level window (e.g.

the panel or the dialog box containing it).

As normal, 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 wxTopLevelWindow::SetDefaultItem().

Remarks:
Under Windows, only dialog box buttons respond to this function.
Returns:
the old default item (possibly NULL)

void wxButton::SetLabel ( const wxString label  )  [virtual]

Sets the string label for the button.

Parameters:
label The label to set.

Reimplemented from wxControl.



wxWidgets logo

[ top ]