The GuiButton class provides a widget for buttons. More...

#include <jmGuiWidgetsA.h>

Public Member Functions
	GuiButton (Sprite *_sprite)
	Construct a new gui button from the given _sprite. More...

void	SetDisabled (bool _disabled) override
	Set the disabled state of this widget. More...

void	SetVisible (bool _visible) override
	Set the visibility of this widget. More...

Sprite *	GetSprite ()
	Returns the sprite of this button. More...

void	SetTextLabel (const std::string &_label)
	Set the text label of this button if applicable. More...

bool	IsCheckable ()
	Returns true if this button is checkable; otherwise returns false;. More...

void	SetCheckable (bool _checkable)
	Set checkable status of this button. More...

bool	IsChecked ()
	Returns true if this button is checked; otherwise returns false. More...

void	SetChecked (bool _checked)
	Set the checked state of this button. More...

Public Member Functions inherited from GuiWidget
bool	IsCursorDown ()
	Returns true if the cursor is hold down over this widget; otherwise returns false. More...

bool	IsCursorOver ()
	Returns true if the cursor is over this widget; otherwise returns false. More...

bool	IsPressed ()
	Returns true if the cursor is pressed while over this widget; otherwise returns false. More...

bool	IsValueChanged ()
	Returns true if this widget's value is changed; otherwise returns false. More...

bool	IsDisabled ()
	Returns true if this widget is disabled; otherwise returns false. More...

bool	IsVisible ()
	Returns true if this widget is visible; otherwise returns false. More...

void	SetName (const std::string &_name)
	Set the name of this widget. More...

std::string	GetName ()
	Returns the name of this widget. More...

void	SetTag (int _tag)
	Set the tag of this widget. More...

int	GetTag ()
	Returns the tag of this widget. More...

GuiWidgetKind	GetKind ()
	Returns the kind of this widget. More...

std::string	GetDesignKind ()
	Returns the design kind of this widget. More...

void	AssignCustomObject (CustomObject *_customObject)
	Assign the given _customObject to this widget. More...

CustomObject *	GetCustomObject ()
	Returns the custom object of this widget or nullptr if none. More...

void	AssignCallback (GuiWidgetCallback *_callback)
	Assign the given _callback to this widget. More...

GuiWidgetCallback *	GetCallback ()
	Returns the callback of this widget or nullptr if none. More...

Additional Inherited Members
Static Public Member Functions inherited from GuiWidget
static GuiWidget *	GetInteracted ()
	Returns the interacted widget. More...

static GuiWidget *	GetInteracted (const std::string &_name)
	Returns the interacted widget with the given _name. More...

static GuiWidget *	GetInteracted (int _tag)
	Returns the interacted widget with the given _tag. More...

static GuiWidget *	GetInteracted (CustomObject *_customObject)
	Returns the interacted widget which has assigned the given _customObject. More...

static GuiWidget *	GetInteracted_Pressed ()
	Returns the interacted widget which is pressed. More...

static GuiWidget *	GetInteracted_Pressed (const std::string &_name)
	Returns the interacted widget with the given _name which is pressed. More...

static GuiWidget *	GetInteracted_Pressed (int _tag)
	Returns the interacted widget with the given _tag which is pressed. More...

static GuiWidget *	GetInteracted_Pressed (CustomObject *_customObject)
	Returns the interacted widget with assigned _customObject which is pressed. More...

static GuiWidget *	GetInteracted_ValueChanged ()
	Returns the interacted widget which has changed value. More...

static GuiWidget *	GetInteracted_ValueChanged (const std::string &_name)
	Returns the interacted widget with the given _name which has changed value. More...

static GuiWidget *	GetInteracted_ValueChanged (int _tag)
	Returns the interacted widget with the given _tag which has changed value. More...

static GuiWidget *	GetInteracted_ValueChanged (CustomObject *_customObject)
	Returns the interacted widget with assigned _customObject which has changed value. More...

static GuiWidget *	GetInteracted_CursorOver ()
	Returns the interacted widget which has the cursor over. More...

static GuiWidget *	GetInteracted_CursorOver (const std::string &_name)
	Returns the interacted widget with the given _name which has the cursor over. More...

static GuiWidget *	GetInteracted_CursorOver (int _tag)
	Returns the interacted widget with the given _tag which has the cursor over. More...

static GuiWidget *	GetInteracted_CursorOver (CustomObject *_customObject)
	Returns the interacted widget with assigned _customObject which has the cursor over. More...

static GuiWidget *	GetInteracted_cursorDown ()
	Returns the interacted widget which has the cursor hold down. More...

static GuiWidget *	GetInteracted_CursorDown (const std::string &_name)
	Returns the interacted widget with the given _name which has the cursor hold down. More...

static GuiWidget *	GetInteracted_CursorDown (int _tag)
	Returns the interacted widget with the given _tag which has the cursor hold down. More...

static GuiWidget *	GetInteracted_CursorDown (CustomObject *_customObject)
	Returns the interacted widget with assigned _customObject which has the cursor hold down. More...

Detailed Description

The GuiButton class provides a widget for buttons.

Constructor & Destructor Documentation

◆ GuiButton()

GuiButton ( Sprite * _sprite )

Construct a new gui button from the given *_sprite*.

The button properties are obtained from the sprite custom parameters.

Member Function Documentation

◆ SetDisabled()

void SetDisabled ( bool _disabled )

overridevirtual

Set the disabled state of this widget.

See also: IsDisabled

Reimplemented from GuiWidget.

◆ SetVisible()

void SetVisible ( bool _visible )

overridevirtual

Set the visibility of this widget.

This function is not available for GuiTextField.

See also: IsVisible

Reimplemented from GuiWidget.

◆ GetSprite()

Sprite* GetSprite ( )

inline

Returns the sprite of this button.

◆ SetTextLabel()

void SetTextLabel ( const std::string & _label )

Set the text label of this button if applicable.

Text label can be applied if the button sprite is a TextSprite or a ComposedSprite which contains a child TextSprite marked as the label.

◆ IsCheckable()

bool IsCheckable ( )

inline

Returns true if this button is checkable; otherwise returns false;.

A checkable button provides toggle behavior.

See also: SetCheckable, IsChecked, SetChecked

◆ SetCheckable()

void SetCheckable ( bool _checkable )

inline

Set checkable status of this button.

A checkable button provides toggle behavior.

See also: IsCheckable, IsChecked, SetChecked

◆ IsChecked()

bool IsChecked ( )

inline

Returns true if this button is checked; otherwise returns false.

The checked state is applicable if the button is checkable.

See also: SetChecked, SetCheckable, IsCheckable

◆ SetChecked()

void SetChecked ( bool _checked )

Set the checked state of this button.

The checked state is applicable if the button is checkable.

See also: IsChecked, SetCheckable, IsCheckable

The documentation for this class was generated from the following files:

C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmGuiWidgetsA.h
C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmGuiWidgetsA.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GuiButton()

Member Function Documentation

◆ SetDisabled()

◆ SetVisible()

◆ GetSprite()

◆ SetTextLabel()

◆ IsCheckable()

◆ SetCheckable()

◆ IsChecked()

◆ SetChecked()