A boolean that can be directly displayed and edited in the UI. More...

Inheritance diagram for UIBool:

Collaboration diagram for UIBool:

[legend]

Public Member Functions
void	Display () override
	Displays the variable as an editable field in the UI.

	UIBool (const std::string &name="", bool value=false, ActionStack *actionStack=nullptr, std::function< void()> callback=std::function< void()>(nullptr))
	Creates a new variable that can be displayed and updated directly in the UI.

Public Member Functions inherited from IUIVariable< bool >
bool	Equals (const bool &value) const
	Returns whether the value is equal to the given value.

bool	Get () const
	Returns the current value of this variable.

bool *	GetRef () const
	Returns a reference to the value stored in this variable. This is unsafe, but is necessary for Commands outside of the class to update the value.

	operator bool ()
	Explicitly converts this variable to its internal value.

bool &	operator* ()
	Returns a reference to the value stored in this variable.

bool *	operator-> ()
	Returns a reference to the value stored in this variable.

std::string	Name () const
	Returns the name of the variable.

void	Set (const bool &newValue)
	Sets the value of the variable to the new value only if it is different. Sends a Command to the action stack indicating the changed value.

void	SetNoUpdate (const bool &newValue)
	Sets the value of the variable to the new value without creating a command.

Additional Inherited Members
Protected Attributes inherited from IUIVariable< bool >
std::string	mName
	Name of the variable.

bool	mValue
	Value of the variable.

ActionStack *	mActionStack
	Reference to the global action stack.

std::function< void()>	mSetCallback
	Callback function that runs whenever set is modified.

Detailed Description

A boolean that can be directly displayed and edited in the UI.

Constructor & Destructor Documentation

UIBool::UIBool	(	const std::string &	name = `""`,
		bool	value = `false`,
		ActionStack *	actionStack = `nullptr`,
		std::function< void()>	callback = `std::function<void()>(nullptr)`
	)

inlineexplicit

Creates a new variable that can be displayed and updated directly in the UI.

Parameters

name	Name of the variable
value	Value to initialize the variable to
actionStack	Global action stack
callback	Callback function to run when set

void UIBool::Display ( )

inlineoverridevirtual

Displays the variable as an editable field in the UI.