Button Reference Documentation

Button

Parent class: Widget

A simple command button widget. The Button is generally considered to be the most commonly used user-interface component. It allows the user to initiate some action when it is pressed.

Object Events:

Clicked

The event generated when the button is pressed.

Method Summary:
	Button::Button	();
void	Button::activate	();
void	Button::setLabel	(const String& pLabel);
String	Button::getLabel	();

Button::Button

Button::Button();

Constructs a new command button.

void Button::activate

void Button::activate();

Causes the button to generate a Click event just as if the user had clicked on the button.

void Button::setLabel

void Button::setLabel(const String& pLabel);

Sets the text displayed on the button.

Parameters:
const String&	pLabel	The new button label.

String Button::getLabel

String Button::getLabel();

Returns the button's label.