Information class about an action. More...

#include <ActionInfo.h>

Inheritance diagram for Core::ActionInfo:

Public Types
typedef boost::shared_ptr< ActionInfo >	handle_type

typedef boost::mutex	mutex_type

typedef boost::unique_lock< mutex_type >	lock_type

Public Member Functions
	ActionInfo (const std::string &definition)

std::string	get_definition () const
	Get the definition of the action (in xml format)

std::string	get_type () const
	The type/name of the action.

std::string	get_usage () const
	The usage string of the action.

std::string	get_description () const
	Get the description of the action.

std::vector< std::string >	get_properties () const
	Get the properties of the action.

size_t	get_num_key_value_pairs () const
	The number of key value pairs associated with this action.

std::string	get_key (size_t index) const
	The name of key <index>

int	get_key_index (const std::string &key) const
	The index of a key.

std::string	get_default_key_value (size_t index) const
	The default value of the key <index>

std::string	get_key_description (size_t index) const
	The description of key <index>

std::vector< std::string >	get_key_properties (size_t index) const
	Get the properties of key <index>

bool	is_valid () const
	Check the validity of the action description.

bool	is_undoable () const
	Check whether an action is undoable.

bool	changes_project_data () const
	Check whether the action changes the data of the program.

Static Public Member Functions
static mutex_type &	GetMutex ()
	Get the mutex that protects the generation of ActionInfo instances.

Detailed Description

Information class about an action.

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

Public Types