Unigine::WidgetCheckBox Class

Example#

The following code illustrates how to create a checkbox widget and set its parameters.

Source code (C++)

#include <UnigineWidgets.h>
using namespace Unigine;

/* .. */

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

/* .. */

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

// creating a checkbox widget and setting its caption
WidgetCheckBoxPtr widget_checkbox = WidgetCheckBox::create(gui, "Automatic mode");

// setting a tooltip
widget_checkbox->setToolTip("Toggle automatic mode");

// rearranging checkbox size
widget_checkbox->arrange();

// setting checkbox position
widget_checkbox->setPosition(10, 10);

// setting checkbox state to checked
widget_checkbox->setChecked(1);

// setting onCheckBoxChanged function to handle CHANGED event
widget_checkbox->addCallback(Gui::CHANGED, MakeCallback(onCheckBoxChanged));

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

Methods:

Name	Description View: Sort by:
*create*	Constructor.
setChecked	Sets a value indicating if the checkbox is selected.
isChecked	Returns a value indicating if the checkbox is selected.
setText	Sets a checkbox text label.
getText	Returns the checkbox text label.
setCheckedColor	Sets the color to be used for the checked widget's state.
getCheckedColor	Returns the current color used for the checked widget's state.
setUncheckedColor	Sets the color to be used for the unchecked widget's state.
getUncheckedColor	Returns the current color used for the unchecked widget's state.

WidgetCheckBox Class

Members

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

Constructor. Creates a checkbox with a given text label and adds it to the specified GUI.

Arguments

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

static WidgetCheckBoxPtr create ( const char * str = 0 ) #

Constructor. Creates a checkbox with a given text label and adds it to the Engine GUI.

Arguments

const char * str - Checkbox label. This is an optional parameter.

void setChecked ( bool checked ) #

Sets a value indicating if the checkbox is selected.

Arguments

bool checked - 1 to check (select) the checkbox, 0 to uncheck it.

bool isChecked ( ) const#

Returns a value indicating if the checkbox is selected.

Return value

1 if the checkbox is checked (selected); otherwise, 0.

void setText ( const char * text ) #

Sets a checkbox text label.

Arguments

const char * text - Checkbox label.

const char * getText ( ) const#

Returns the checkbox text label.

Return value

Checkbox label.

void setCheckedColor ( const Math::vec4 & color ) #

Sets the color to be used for the checked widget's state.

Arguments

const Math::vec4 & color - The four-component vector specifying the color in the RGBA format.

Math::vec4 getCheckedColor ( ) const#

Returns the current color used for the checked widget's state.

Return value

The four-component vector specifying the color in the RGBA format.

void setUncheckedColor ( const Math::vec4 & color ) #

Sets the color to be used for the unchecked widget's state.

Arguments

const Math::vec4 & color - The four-component vector specifying the color in the RGBA format.

Math::vec4 getUncheckedColor ( ) const#

Returns the current color used for the unchecked widget's state.

Return value

The four-component vector specifying the color in the RGBA format.

Last update: 2023-06-23

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

Unigine::WidgetCheckBox Class

In This Article:

See Also#

Example#

Methods:

WidgetCheckBox Class

Members

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

Arguments

static WidgetCheckBoxPtr create ( const char * str = 0 ) #

Arguments

void setChecked ( bool checked ) #

Arguments

bool isChecked ( ) const#

Return value

void setText ( const char * text ) #

Arguments

const char * getText ( ) const#

Return value

void setCheckedColor ( const Math::vec4 & color ) #

Arguments

Math::vec4 getCheckedColor ( ) const#

Return value

void setUncheckedColor ( const Math::vec4 & color ) #

Arguments

Math::vec4 getUncheckedColor ( ) const#

Return value

Header:	#include <UnigineWidgets.h>
Inherits from:	Widget