Inheritance diagram for makVrf::DtCommandLevelsManager:

Classes
struct	CommandLevel

Public Member Functions
	DtCommandLevelsManager (makVrv::DtDe &)

virtual	~DtCommandLevelsManager () override

virtual void	getSplitRecord (std::vector< DtCommandLevelsRecord > &rec, std::vector< std::string > &fileNames)

virtual void	addRecords (DtCommandLevelsRecord &recs, DtCommandLevelsRecord &combinedRec)

virtual void	setFromRecord (const DtCommandLevelsRecord &rec)

virtual void	loadDefaultCommandLevelsSettings (bool loadOnlyFactorySettings=false)

virtual void	getRecord (DtCommandLevelsRecord &rec) const

virtual void	setAutoSave (bool)

virtual bool	autoSave () const

virtual void	saveSettingsAsDefault ()


virtual void	addTaskSetCommandLevel (int level, const DtString &title, const DtString &toolTip, const DtString &icon)

virtual void	addToTaskSetCommandLevel (int level, const DtString &, bool thisSessionOnly=false)

virtual void	setIsMagicCommand (const DtString &, bool flag)

virtual bool	isMagicCommand (const DtString &) const

virtual void	removeFromTaskSetCommandLevel (int level, const DtString &, bool thisSessionOnly=false)

virtual DtString	taskSetCommandLevelToolTip (int level) const

virtual DtString	taskSetCommandLevelTitle (int level) const

virtual DtString	taskSetCommandLevelIcon (int level) const

virtual std::vector< int >	taskSetCommandLevels (const DtString &) const

virtual int	numberOfTaskSetCommandLevels () const

virtual std::vector< int >	taskSetCommandLevels () const

virtual bool	isInTaskSetCommandLevel (int level, const DtString &taskSetType) const

virtual void	clearSessionCommandLevels ()


virtual void	setExpandCollapsedState (const DtString &section, bool exp)

virtual bool	expandCollapsedState (const DtString &section) const


virtual void	setAlwaysPopOut (bool)

virtual bool	alwaysPopOut () const

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtCommandLevelsManager &	instance (makVrv::DtDe &de)

static void	registerInstance (makVrv::DtDe &de, DtCommandLevelsManager *)

Public Attributes
boost::signals2::signal< void(const DtCommandLevelsRecord &)>	signal_commandLevelsChanged

boost::signals2::signal< void()>	signal_sessionCommandLevelsChanged

boost::signals2::signal< void()>	signal_commandLevelCategoriesChanged

boost::signals2::signal< void(const DtString &, int level, bool)>	signal_commandLevelChanged

boost::signals2::signal< void(const DtString &, bool)>	signal_expandCollapsedStateChanged

boost::signals2::signal< void(bool)>	signal_alwaysPopOutChanged

Protected Types
typedef std::map< int, CommandLevel >	CommandLevels

Protected Attributes
makVrv::DtDe &	myDe

DtCommandLevelsRecord	myCommandLevelsRecord

std::map< int, std::set < DtString > >	myTaskSetCommandLevels

std::map< DtString, bool >	myIsMagicCommand

CommandLevels	myCommandLevels

Member Typedef Documentation

typedef std::map<int, CommandLevel> makVrf::DtCommandLevelsManager::CommandLevels

protected

Constructor & Destructor Documentation

makVrf::DtCommandLevelsManager::DtCommandLevelsManager ( makVrv::DtDe & )

virtual makVrf::DtCommandLevelsManager::~DtCommandLevelsManager ( )

overridevirtual

Member Function Documentation

static DtCommandLevelsManager& makVrf::DtCommandLevelsManager::instance ( makVrv::DtDe & de )

static

Returns instance of the messager.

static void makVrf::DtCommandLevelsManager::registerInstance	(	makVrv::DtDe &	de,
		DtCommandLevelsManager *
	)

static

virtual void makVrf::DtCommandLevelsManager::getSplitRecord	(	std::vector< DtCommandLevelsRecord > &	rec,
		std::vector< std::string > &	fileNames
	)

inlinevirtual

To support writing element definitions in folders as multiple files not implemented.

virtual void makVrf::DtCommandLevelsManager::addRecords	(	DtCommandLevelsRecord &	recs,
		DtCommandLevelsRecord &	combinedRec
	)

inlinevirtual

To support writing element definitions in folders as multiple files not implemented.

virtual void makVrf::DtCommandLevelsManager::setFromRecord ( const DtCommandLevelsRecord & rec )

virtual

virtual void makVrf::DtCommandLevelsManager::loadDefaultCommandLevelsSettings ( bool loadOnlyFactorySettings = false )

virtual

virtual void makVrf::DtCommandLevelsManager::getRecord ( DtCommandLevelsRecord & rec ) const

virtual

virtual void makVrf::DtCommandLevelsManager::setAutoSave ( bool )

virtual

Set to false to not save on settings change. Default is true.

virtual bool makVrf::DtCommandLevelsManager::autoSave ( ) const

virtual

virtual void makVrf::DtCommandLevelsManager::saveSettingsAsDefault ( )

virtual

virtual void makVrf::DtCommandLevelsManager::addTaskSetCommandLevel	(	int	level,
		const DtString &	title,
		const DtString &	toolTip,
		const DtString &	icon
	)

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual void makVrf::DtCommandLevelsManager::addToTaskSetCommandLevel	(	int	level,
		const DtString &	,
		bool	thisSessionOnly = `false`
	)

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual void makVrf::DtCommandLevelsManager::setIsMagicCommand	(	const DtString &	,
		bool	flag
	)

virtual

See DtVrfMenuConfigurationPathLoader for flags.

virtual bool makVrf::DtCommandLevelsManager::isMagicCommand ( const DtString & ) const

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual void makVrf::DtCommandLevelsManager::removeFromTaskSetCommandLevel	(	int	level,
		const DtString &	,
		bool	thisSessionOnly = `false`
	)

virtual

If level is -1 removed from any grouping level except all.

virtual DtString makVrf::DtCommandLevelsManager::taskSetCommandLevelToolTip ( int level ) const

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual DtString makVrf::DtCommandLevelsManager::taskSetCommandLevelTitle ( int level ) const

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual DtString makVrf::DtCommandLevelsManager::taskSetCommandLevelIcon ( int level ) const

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual std::vector<int> makVrf::DtCommandLevelsManager::taskSetCommandLevels ( const DtString & ) const

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual int makVrf::DtCommandLevelsManager::numberOfTaskSetCommandLevels ( ) const

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual std::vector<int> makVrf::DtCommandLevelsManager::taskSetCommandLevels ( ) const

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual bool makVrf::DtCommandLevelsManager::isInTaskSetCommandLevel	(	int	level,
		const DtString &	taskSetType
	)		const

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual void makVrf::DtCommandLevelsManager::clearSessionCommandLevels ( )

virtual

This section deals with task/set favorites and the various task/set favorite groupings. Currently the following levels exists: Level 1 = All – Items do not have to be added to this group – they are in this group already Level 0 = Favorites.

Groupings will work in that if the task/set is in a grouping <= the level requested, the task/set will be shown.

If thisSessionOnly is true, will not be set into the gui settings record, but will be set locally and looked at first before looking at gui level settings

virtual void makVrf::DtCommandLevelsManager::setExpandCollapsedState	(	const DtString &	section,
		bool	exp
	)

virtual

Accessor/mutator for expansion/collapsed state of section. True if expanded.

virtual bool makVrf::DtCommandLevelsManager::expandCollapsedState ( const DtString & section ) const

virtual

Accessor/mutator for expansion/collapsed state of section. True if expanded.

virtual void makVrf::DtCommandLevelsManager::setAlwaysPopOut ( bool )

virtual

Whether or not to always pop out task/set dialogs. Default is false.

virtual bool makVrf::DtCommandLevelsManager::alwaysPopOut ( ) const

virtual

Whether or not to always pop out task/set dialogs. Default is false.

Member Data Documentation

boost::signals2::signal<void (const DtCommandLevelsRecord&)> makVrf::DtCommandLevelsManager::signal_commandLevelsChanged

Sent when gui settings have changed.

boost::signals2::signal<void ()> makVrf::DtCommandLevelsManager::signal_sessionCommandLevelsChanged

boost::signals2::signal<void ()> makVrf::DtCommandLevelsManager::signal_commandLevelCategoriesChanged

boost::signals2::signal<void (const DtString&, int level, bool)> makVrf::DtCommandLevelsManager::signal_commandLevelChanged

Signal sent when an item is added or removed from the particular command level.

boost::signals2::signal<void (const DtString&, bool)> makVrf::DtCommandLevelsManager::signal_expandCollapsedStateChanged

Signal sent when expand/collapsed state changes.

boost::signals2::signal<void (bool)> makVrf::DtCommandLevelsManager::signal_alwaysPopOutChanged

Signal sent when always pop out state changes.

makVrv::DtDe& makVrf::DtCommandLevelsManager::myDe

protected

DtCommandLevelsRecord makVrf::DtCommandLevelsManager::myCommandLevelsRecord

protected

std::map<int, std::set<DtString> > makVrf::DtCommandLevelsManager::myTaskSetCommandLevels

protected

std::map<DtString, bool> makVrf::DtCommandLevelsManager::myIsMagicCommand

protected

CommandLevels makVrf::DtCommandLevelsManager::myCommandLevels

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfGuiCore/commandLevelsManager.h

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation