Inheritance diagram for Core::StateName:

Public Types
typedef std::string	value_type

typedef StateNameHandle	handle_type

typedef boost::signals2::signal< void(std::string, std::string, ActionSource) >	value_changed_signal_type

Public Types inherited from Core::StateBase
enum	{ DO_NOT_LOAD_E = -1, LOAD_LAST_E = 0, DEFAULT_LOAD_E = 100 }

typedef boost::signals2::signal< void() >	state_changed_signal_type
	This signal is triggered when the state is changed.

Public Member Functions
	StateName (const std::string &stateid, const std::string &value)

virtual std::string	export_to_string () const
	Convert the contents of the State into a string.

virtual bool	import_from_string (const std::string &str, ActionSource source=ActionSource::NONE_E)
	Set the State from a string.

const std::string &	get () const
	Get the value of the state variable.

bool	set (const std::string &value, ActionSource source=ActionSource::NONE_E)

Public Member Functions inherited from Core::StateBase
	StateBase (const std::string &stateid)

virtual bool	import_from_string (const std::string &str, Core::ActionSource source=Core::ActionSource::NONE_E)=0
	Set the State from a string.

void	set_is_project_data (bool is_project_data)
	Set whether the data is part of the project data.

void	set_locked (bool locked)

bool	get_locked () const
	Query whether the variable has been designated as locked.

int	get_session_priority () const
	Get the priority in which loading sets the states.

void	set_session_priority (int priority)
	By default the priority is set to DEAFULT_LOAD_E.

std::string	get_stateid () const
	Get the unique id assigned to the state variable.

bool	is_project_data () const
	Whether the data is tagged as project data that is saved in a session.

Public Attributes
value_changed_signal_type	value_changed_signal_

Public Attributes inherited from Core::StateBase
state_changed_signal_type	state_changed_signal_

Static Public Attributes
static const std::string	REGEX_VALIDATOR_C
	The regular expression for validating a name string.

Protected Member Functions
virtual void	export_to_variant (Variant &variant) const
	Export the state data to a variant parameter.

virtual bool	import_from_variant (Variant &variant, ActionSource source=ActionSource::NONE_E)
	Import the state data from a variant parameter.

virtual bool	validate_variant (Variant &variant, std::string &error)

virtual void	invalidate ()

Protected Member Functions inherited from Core::StateBase
virtual bool	import_from_variant (Variant &variant, Core::ActionSource source=Core::ActionSource::NONE_E)=0
	Import the state data from a variant parameter.

void	enable_signals (bool signals_enabled)

bool	signals_enabled ()
	Check whether signals are enabled.

void	set_initializing (bool initializing)

bool	get_initializing () const
	Query whether the state variable and its parent are still being initialized.

Member Typedef Documentation

typedef boost::signals2::signal< void( std::string, std::string, ActionSource ) > Core::StateName::value_changed_signal_type

Signal when the data in the state is changed. The first two parameters contain the old and new values respectively. The third parameter indicates the source of the change

Member Function Documentation

void Core::StateName::invalidate ( )

protectedvirtual

Invalidate the state variable. This function is called by the "invalidate" function of StateHandler to release any resource occupied by the state. It will put the name string back to the pool.

Reimplemented from Core::StateBase.

bool Core::StateName::set	(	const std::string &	value,
		ActionSource	source = `ActionSource::NONE_E`
	)

Set the value of the state variable NOTE: this function by passes the action mechanism and should only be used to enforce a constraint from another action.

bool Core::StateName::validate_variant	(	Variant &	variant,
		std::string &	error
	)

protectedvirtual

Validate a variant parameter This function returns false if the parameter is invalid or cannot be converted and in that case error will describe the error.

Implements Core::StateBase.

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

Core/State/StateName.h
Core/State/StateName.cc

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Member Typedef Documentation

Member Function Documentation