Unigine::WidgetButton Class

#include <UnigineWidgets.h>
using namespace Unigine;

/* .. */

// event handler function
int onButtonClicked()
{
	/* .. */
	
	return 1;
}

/* .. */

// getting a pointer to the system GUI
GuiPtr gui = Gui::get();

// creating a button widget and setting its caption
WidgetButtonPtr widget_button = WidgetButton::create(gui, "Delete");

// setting a tooltip
widget_button->setToolTip("Delete object(s)");

// rearranging button size
widget_button->arrange();

// setting button position
widget_button->setPosition(10, 10);

// setting onButtonClicked function to handle CLICKED event
widget_button->setCallback0(Gui::CLICKED, MakeCallback(onButtonClicked));

// adding created button widget to the system GUI
gui->addChild(widget_button->getWidget(), Gui::ALIGN_OVERLAP | Gui::ALIGN_FIXED);

WidgetButton Class

Members

---

static WidgetButtonPtr create ( const Ptr<Gui> & gui, const char * str = 0 )

Constructor. Creates a button with a given label.

Arguments

• const Ptr<Gui> & gui - GUI, to which the new button will belong.
• const char * str - Button label. This is an optional parameter.

Ptr<WidgetButton> cast( const Ptr<Widget> & widget )

Casts a WidgetButton out of the Widget instance.

Arguments

• const Ptr<Widget> & widget - Pointer to Widget.

Return value

Pointer to WidgetButton.

void setBackground( int background )

Sets a value indicating if a background texture should be rendered for the button. By default, the background texture is always rendered. The default is 1.

Arguments

• int background - 1 to render the background texture, 0 not to render. The default is 1.

int getBackground( )

Returns a value indicating if a background texture is rendered for the button. The default is 1.

Return value

1 if a background texture is rendered; otherwise, 0.

void setImage( const Ptr<Image> & image )

Updates a button image.

Arguments

• const Ptr<Image> & image - Image to set.

void getImage( const Ptr<Image> & image )

Returns the button image.

Arguments

• const Ptr<Image> & image

void setText( const char * text )

Sets a button text label.

Arguments

• const char * text - Button label.

const char * getText( )

Returns the button text label.

Return value

Button label.

void setTextAlign( int align )

Sets alignment of the button label.

Arguments

• int align - One of the Gui:: Enumeration with ALIGN_* prefixes.

int getTextAlign( )

Returns alignment of the button label.

Return value

Alignment of the button label: one of the Gui:: Enumeration with ALIGN_* prefixes.

void setTexture( const char * texture )

Sets a button image texture.

Arguments

• const char * texture - Path to a texture file.

const char * getTexture( )

Returns the path to the button image texture.

Return value

Path to the button image texture.

void setToggleable( int toggleable )

Sets a value indicating if the button is a toggle button or a simple one.

Arguments

• int toggleable - 1 to make the button a toggle button, 0 to make it a simple one. The default is 0.

int isToggleable( )

Returns a value indicating if the button is a toggle button or a simple one. The default is 0.

Return value

1 if the button is a toggle button; otherwise, 0.

void setToggled( int toggled )

Sets a state of the toggle button.

Arguments

• int toggled - 1 to press the button, 0 to release it.

int isToggled( )

Returns a value indicating if the toggle button is pressed.

Return value

1 if the button is pressed; otherwise, 0.

int type( )

WidgetButton type.

Return value

WidgetButton type identifier.