UIString Class Reference

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

Inheritance diagram for UIString:

Collaboration diagram for UIString:

Public Member Functions
void	Display () override
	Displays the variable as an editable field in the UI.
std::string	operator+ (const std::string &other) const
	Adds the given value to this value.
std::string	operator+ (const UIString &other) const
	Adds the given value to this value.
	UIString (const std::string &name="", const std::string &value="", 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< std::string >
bool	Equals (const std::string &value) const
	Returns whether the value is equal to the given value.
std::string	Get () const
	Returns the current value of this variable.
std::string *	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 std::string ()
	Explicitly converts this variable to its internal value.
std::string &	operator* ()
	Returns a reference to the value stored in this variable.
std::string *	operator-> ()
	Returns a reference to the value stored in this variable.
std::string	Name () const
	Returns the name of the variable.
void	Set (const std::string &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 std::string &newValue)
	Sets the value of the variable to the new value without creating a command.

Additional Inherited Members
Protected Attributes inherited from IUIVariable< std::string >
std::string	mName
	Name of the variable.
std::string	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 string that can be directly displayed and edited in the UI.

Constructor & Destructor Documentation

UIString()

UIString::UIString ( const std::string &  name = "", const std::string &  value = "", 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

Member Function Documentation

Display()

void UIString::Display ( )

inlineoverridevirtual

Displays the variable as an editable field in the UI.

Implements IUIVariable< std::string >.

operator+() [1/2]

std::string UIString::operator+ ( const std::string &  other ) const

inline

Adds the given value to this value.

Parameters

other

Value to add

Returns

This + Other

operator+() [2/2]

std::string UIString::operator+ ( const UIString &  other ) const

inline

Adds the given value to this value.

Parameters

other

Value to add

Returns

This + Other