The DtDefaultGuiConfigurationCreator class will create the default_guiConfiguration.gui file in the factory directory if that file does not exist. More...

Inheritance diagram for makVrf::DtDefaultGuiConfigurationCreator:

[legend]

Classes
struct	Configurations
struct	OptionFunctions

Public Types
enum	Flags { InformationConfiguration = 1, PageConfiguration = 2, ToolbarConfiguration = 4, MenuConfiguration = 8, RightClickMenuConfiguration = 16, AllConfigurations = 32 }
typedef boost::function< void(const DtString &)>	ReadOptionFunction
typedef boost::function< void(DtEnvironment *, DtEnvValueSP)>	WriteOptionFunction
typedef std::map< std::string, makVrv::DtMenuConfiguration >	RightClickConfigurations

Public Member Functions
	DtDefaultGuiConfigurationCreator (makVrv::DtDe &)
	CTOR.
virtual	~DtDefaultGuiConfigurationCreator ()
	DTOR.
virtual void	createDefaultGuiConfigurationFile (bool force=false)
	Will create default configuration file only if the file does not exist, or, if the force flag is specified to true.
virtual void	save (const std::string &)
	Saves all known information to specified file.
virtual bool	load (const std::string &)
	Loads into internal members, removing information for the current members.
const DtFilename &	filename () const
	Returns the filename loaded from a successful load.
virtual bool	isValid () const
	Returns true if there is valid information in the configuration.
virtual void	setInformationPageConfiguration (const DtInformationPageConfiguration &)
	Sets the initial page configuration for the information pages.
const DtInformationPageConfiguration &	informationPageConfiguration () const
DtInformationPageConfiguration &	informationPageConfiguration ()
const DtInformationPageConfiguration &	originalInformationPageConfiguration () const
virtual void	setMainPageConfiguration (const makVrv::DtPageConfiguration &)
	Sets the initial page configuration for the main application.
const makVrv::DtPageConfiguration &	mainPageConfiguration () const
makVrv::DtPageConfiguration &	mainPageConfiguration ()
const makVrv::DtPageConfiguration &	originalPageConfiguration () const
virtual void	setMainToolbarConfiguration (const makVrv::DtToolbarConfiguration &)
	Sets the initial page configuration for the main application.
const makVrv::DtToolbarConfiguration &	mainToolbarConfiguration () const
makVrv::DtToolbarConfiguration &	mainToolbarConfiguration ()
const makVrv::DtToolbarConfiguration &	originalToolbarConfiguration () const
virtual void	setRightClickMenuConfiguration (const RightClickConfigurations &)
	Sets the initial right click menu configuration for the main application.
const RightClickConfigurations &	rightClickMenuConfiguration () const
RightClickConfigurations &	rightClickMenuConfiguration ()
const RightClickConfigurations &	originalRightClickMenuConfiguration () const
virtual void	setMainMenuConfiguration (const makVrv::DtMenuConfiguration &)
	Sets the initial menu configuration.
const makVrv::DtMenuConfiguration &	mainMenuConfiguration () const
makVrv::DtMenuConfiguration &	mainMenuConfiguration ()
const makVrv::DtMenuConfiguration &	originalMenuConfiguration () const
virtual void	addRightClickContextMenu (const std::string &context, const makVrv::DtMenuConfiguration &configuration)
	Adds a new right click context menu configuration, replacing existing.
const makVrv::DtMenuConfiguration &	rightClickContextMenu (const std::string &context) const
makVrv::DtMenuConfiguration &	rightClickContextMenu (const std::string &context)
const makVrv::DtMenuConfiguration &	originalRightClickContextMenu (const std::string &context) const
virtual void	clearAllContextMenus ()
	Clears all right click context menus.
virtual void	install ()
	Installs the page, toolbar and menu settings into the application.
virtual void	installLockedOnly ()
	Installs only the locked items. Will still signal pre and post lock install.
virtual void	setLock (int, bool)
	Turn on/off whether or not the configuration can be changed.
bool	isLocked (int) const
virtual void	readOptions (DtEnvironment *, DtEnvValueSP root)
	Reads options from the options line. Use the addOption call to add options and the boost funciton to call to process it.
virtual void	saveOptions (DtEnvironment *env, DtEnvValueSP root)
	Saves out options to gui options line.
virtual void	addOption (const DtString &option, ReadOptionFunction readFunc, WriteOptionFunction writeFunc)
	Add a function to process an option. If function exists will overwrite.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtDefaultGuiConfigurationCreator &	instance (makVrv::DtDe &de)
static void	registerInstance (makVrv::DtDe &de, DtDefaultGuiConfigurationCreator *)

Public Attributes
boost::signal< void()>	signal_preInstall
boost::signal< void()>	signal_postInstall
boost::signal< void()>	signal_preLockInstall
boost::signal< void()>	signal_postLockInstall

Protected Types
typedef std::map< DtString, OptionFunctions >	OptionFunctionsMap

Protected Member Functions
virtual void	setOverrideLayout (const DtString &)
	Default option functions.
virtual void	writeOverrideLayout (DtEnvironment *env, DtEnvValueSP root)
virtual void	setAllowEditing (const DtString &)
virtual void	postTickSetAllowEditing (bool b)
virtual void	writeAllowEditing (DtEnvironment *env, DtEnvValueSP root)
virtual void	setLayoutSettingsFile (const DtString &)
virtual void	writeLayoutSettingsFile (DtEnvironment *env, DtEnvValueSP root)
virtual void	saveMenuConfiguration (DtEnvironment *env, DtEnvValueSP root, const makVrv::DtMenuConfiguration &) const
	Saves the menu configuration to the given xml root.
virtual void	savePageConfiguration (DtEnvironment *env, DtEnvValueSP root, const makVrv::DtPageConfiguration &) const
	Saves the page configuration to the given xml root.
virtual void	saveToolbarConfiguration (DtEnvironment *env, DtEnvValueSP root, const makVrv::DtToolbarConfiguration &) const
	Saves the toolbar configuration to the given xml root.

Protected Attributes
Configurations	myLoadedConfigurations
Configurations	myBackupConfigurations
makVrv::DtDe &	myDe
int	mySetFlags
int	myLockedFlags
DtFilename	myFilename
OptionFunctionsMap	myOptionFunctions

Detailed Description

The DtDefaultGuiConfigurationCreator class will create the default_guiConfiguration.gui file in the factory directory if that file does not exist.

Will create from current state of: 1) Menu layout except for Create, Task and Set menus. The file will contain the root nodes of these menus, so, if they are not there, they will not be created. The create, task and set menus are configured on a simulation model set basis, and, their menu files are contained in the simulation model set's gui directory 2) Tabs that appear on settings pages, but, not the contents of those pages 3) Right click menu items. If the developer wants to do specific configuration beyond the base, however, that will need to be in code as the menus apply generally to all items (entities, for example, not fixed wing or tank entities) 4) The dockable widgets that can appear, but not the contents of those widgets 5) Toolbars and items that appear on toolbars 6) Information dialogs and items that appear on those dialogs

Member Typedef Documentation

typedef boost::function<void (const DtString&)> makVrf::DtDefaultGuiConfigurationCreator::ReadOptionFunction

typedef boost::function<void (DtEnvironment*, DtEnvValueSP)> makVrf::DtDefaultGuiConfigurationCreator::WriteOptionFunction

typedef std::map<std::string, makVrv::DtMenuConfiguration> makVrf::DtDefaultGuiConfigurationCreator::RightClickConfigurations

typedef std::map<DtString, OptionFunctions> makVrf::DtDefaultGuiConfigurationCreator::OptionFunctionsMap

protected

Member Enumeration Documentation

enum makVrf::DtDefaultGuiConfigurationCreator::Flags

Enumerator:

InformationConfiguration
PageConfiguration
ToolbarConfiguration
MenuConfiguration
RightClickMenuConfiguration
AllConfigurations

Constructor & Destructor Documentation

makVrf::DtDefaultGuiConfigurationCreator::DtDefaultGuiConfigurationCreator ( makVrv::DtDe & )

CTOR.

virtual makVrf::DtDefaultGuiConfigurationCreator::~DtDefaultGuiConfigurationCreator ( )

virtual

DTOR.

Member Function Documentation

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

static

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

static

virtual void makVrf::DtDefaultGuiConfigurationCreator::createDefaultGuiConfigurationFile ( bool force = false )

virtual

Will create default configuration file only if the file does not exist, or, if the force flag is specified to true.

Will create factory\setting\vrfGui\default_guiConfiguration.gui file

virtual void makVrf::DtDefaultGuiConfigurationCreator::save ( const std::string & )

virtual

Saves all known information to specified file.

virtual bool makVrf::DtDefaultGuiConfigurationCreator::load ( const std::string & )

virtual

Loads into internal members, removing information for the current members.

const DtFilename& makVrf::DtDefaultGuiConfigurationCreator::filename ( ) const

inline

Returns the filename loaded from a successful load.

virtual bool makVrf::DtDefaultGuiConfigurationCreator::isValid ( ) const

virtual

Returns true if there is valid information in the configuration.

virtual void makVrf::DtDefaultGuiConfigurationCreator::setInformationPageConfiguration ( const DtInformationPageConfiguration & )

virtual

Sets the initial page configuration for the information pages.

const DtInformationPageConfiguration& makVrf::DtDefaultGuiConfigurationCreator::informationPageConfiguration ( ) const

inline

DtInformationPageConfiguration& makVrf::DtDefaultGuiConfigurationCreator::informationPageConfiguration ( )

inline

const DtInformationPageConfiguration& makVrf::DtDefaultGuiConfigurationCreator::originalInformationPageConfiguration ( ) const

inline

virtual void makVrf::DtDefaultGuiConfigurationCreator::setMainPageConfiguration ( const makVrv::DtPageConfiguration & )

virtual

Sets the initial page configuration for the main application.

const makVrv::DtPageConfiguration& makVrf::DtDefaultGuiConfigurationCreator::mainPageConfiguration ( ) const

inline

makVrv::DtPageConfiguration& makVrf::DtDefaultGuiConfigurationCreator::mainPageConfiguration ( )

inline

const makVrv::DtPageConfiguration& makVrf::DtDefaultGuiConfigurationCreator::originalPageConfiguration ( ) const

inline

virtual void makVrf::DtDefaultGuiConfigurationCreator::setMainToolbarConfiguration ( const makVrv::DtToolbarConfiguration & )

virtual

Sets the initial page configuration for the main application.

const makVrv::DtToolbarConfiguration& makVrf::DtDefaultGuiConfigurationCreator::mainToolbarConfiguration ( ) const

inline

makVrv::DtToolbarConfiguration& makVrf::DtDefaultGuiConfigurationCreator::mainToolbarConfiguration ( )

inline

const makVrv::DtToolbarConfiguration& makVrf::DtDefaultGuiConfigurationCreator::originalToolbarConfiguration ( ) const

inline

virtual void makVrf::DtDefaultGuiConfigurationCreator::setRightClickMenuConfiguration ( const RightClickConfigurations & )

virtual

Sets the initial right click menu configuration for the main application.

const RightClickConfigurations& makVrf::DtDefaultGuiConfigurationCreator::rightClickMenuConfiguration ( ) const

inline

RightClickConfigurations& makVrf::DtDefaultGuiConfigurationCreator::rightClickMenuConfiguration ( )

inline

const RightClickConfigurations& makVrf::DtDefaultGuiConfigurationCreator::originalRightClickMenuConfiguration ( ) const

inline

virtual void makVrf::DtDefaultGuiConfigurationCreator::setMainMenuConfiguration ( const makVrv::DtMenuConfiguration & )

virtual

Sets the initial menu configuration.

const makVrv::DtMenuConfiguration& makVrf::DtDefaultGuiConfigurationCreator::mainMenuConfiguration ( ) const

inline

makVrv::DtMenuConfiguration& makVrf::DtDefaultGuiConfigurationCreator::mainMenuConfiguration ( )

inline

const makVrv::DtMenuConfiguration& makVrf::DtDefaultGuiConfigurationCreator::originalMenuConfiguration ( ) const

inline

virtual void makVrf::DtDefaultGuiConfigurationCreator::addRightClickContextMenu	(	const std::string &	context,
		const makVrv::DtMenuConfiguration &	configuration
	)

virtual

Adds a new right click context menu configuration, replacing existing.

const makVrv::DtMenuConfiguration& makVrf::DtDefaultGuiConfigurationCreator::rightClickContextMenu ( const std::string & context ) const

makVrv::DtMenuConfiguration& makVrf::DtDefaultGuiConfigurationCreator::rightClickContextMenu ( const std::string & context )

const makVrv::DtMenuConfiguration& makVrf::DtDefaultGuiConfigurationCreator::originalRightClickContextMenu ( const std::string & context ) const

virtual void makVrf::DtDefaultGuiConfigurationCreator::clearAllContextMenus ( )

virtual

Clears all right click context menus.

virtual void makVrf::DtDefaultGuiConfigurationCreator::install ( )

virtual

Installs the page, toolbar and menu settings into the application.

Note that this is only valid during application initialization. Once the application is running this will have no effect other than to signal the pre and post install signals

virtual void makVrf::DtDefaultGuiConfigurationCreator::installLockedOnly ( )

virtual

Installs only the locked items. Will still signal pre and post lock install.

virtual void makVrf::DtDefaultGuiConfigurationCreator::setLock	(	int	,
		bool
	)

virtual

Turn on/off whether or not the configuration can be changed.

This will not prevent a developer from getting access to one of the members and then changing it, however, during install time if something should not have been changed the backup value will replace the current loaded value

bool makVrf::DtDefaultGuiConfigurationCreator::isLocked ( int ) const

virtual void makVrf::DtDefaultGuiConfigurationCreator::readOptions	(	DtEnvironment *	,
		DtEnvValueSP	root
	)

virtual

Reads options from the options line. Use the addOption call to add options and the boost funciton to call to process it.

virtual void makVrf::DtDefaultGuiConfigurationCreator::saveOptions	(	DtEnvironment *	env,
		DtEnvValueSP	root
	)

virtual

Saves out options to gui options line.

virtual void makVrf::DtDefaultGuiConfigurationCreator::addOption	(	const DtString &	option,
		ReadOptionFunction	readFunc,
		WriteOptionFunction	writeFunc
	)

virtual

Add a function to process an option. If function exists will overwrite.

virtual void makVrf::DtDefaultGuiConfigurationCreator::setOverrideLayout ( const DtString & )

protectedvirtual

Default option functions.

virtual void makVrf::DtDefaultGuiConfigurationCreator::writeOverrideLayout	(	DtEnvironment *	env,
		DtEnvValueSP	root
	)

protectedvirtual

virtual void makVrf::DtDefaultGuiConfigurationCreator::setAllowEditing ( const DtString & )

protectedvirtual

virtual void makVrf::DtDefaultGuiConfigurationCreator::postTickSetAllowEditing ( bool b )

protectedvirtual

virtual void makVrf::DtDefaultGuiConfigurationCreator::writeAllowEditing	(	DtEnvironment *	env,
		DtEnvValueSP	root
	)

protectedvirtual

virtual void makVrf::DtDefaultGuiConfigurationCreator::setLayoutSettingsFile ( const DtString & )

protectedvirtual

virtual void makVrf::DtDefaultGuiConfigurationCreator::writeLayoutSettingsFile	(	DtEnvironment *	env,
		DtEnvValueSP	root
	)

protectedvirtual

virtual void makVrf::DtDefaultGuiConfigurationCreator::saveMenuConfiguration	(	DtEnvironment *	env,
		DtEnvValueSP	root,
		const makVrv::DtMenuConfiguration &
	)		const

protectedvirtual

Saves the menu configuration to the given xml root.

virtual void makVrf::DtDefaultGuiConfigurationCreator::savePageConfiguration	(	DtEnvironment *	env,
		DtEnvValueSP	root,
		const makVrv::DtPageConfiguration &
	)		const

protectedvirtual

Saves the page configuration to the given xml root.

virtual void makVrf::DtDefaultGuiConfigurationCreator::saveToolbarConfiguration	(	DtEnvironment *	env,
		DtEnvValueSP	root,
		const makVrv::DtToolbarConfiguration &
	)		const

protectedvirtual

Saves the toolbar configuration to the given xml root.

Member Data Documentation

boost::signal<void ()> makVrf::DtDefaultGuiConfigurationCreator::signal_preInstall

boost::signal<void ()> makVrf::DtDefaultGuiConfigurationCreator::signal_postInstall

boost::signal<void ()> makVrf::DtDefaultGuiConfigurationCreator::signal_preLockInstall

boost::signal<void ()> makVrf::DtDefaultGuiConfigurationCreator::signal_postLockInstall

Configurations makVrf::DtDefaultGuiConfigurationCreator::myLoadedConfigurations

protected

Configurations makVrf::DtDefaultGuiConfigurationCreator::myBackupConfigurations

protected

makVrv::DtDe& makVrf::DtDefaultGuiConfigurationCreator::myDe

protected

int makVrf::DtDefaultGuiConfigurationCreator::mySetFlags

protected

int makVrf::DtDefaultGuiConfigurationCreator::myLockedFlags

protected

DtFilename makVrf::DtDefaultGuiConfigurationCreator::myFilename

protected

OptionFunctionsMap makVrf::DtDefaultGuiConfigurationCreator::myOptionFunctions

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/defaultGuiConfigurationCreator.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation