A generic configuration for configuring the GUI. More...

Inheritance diagram for makVrv::DtGuiConfiguration:

Public Types
enum	Location { Left, Right, Top, Bottom, DockWidgetLeft = Left, DockWidgetRight = Right, DockWidgetTop = Top, DockWidgetBottom = Bottom, ToolBarLeft = 4, ToolBarRight, ToolBarTop, ToolBarBottom }
typedef std::pair< std::string, bool >	DtGuiConfigurationCreationOrder
typedef std::map< std::string, DtGuiConfigurationCreationOrder >	DtCreationOrderMap
Public Member Functions
	DtGuiConfiguration ()
	CTOR.
	DtGuiConfiguration (const DtGuiConfiguration &copy)
	CopyCTOR.
virtual	~DtGuiConfiguration ()
void	setLanguage (const std::string &language)
	Set the language used for translation.
const std::string &	language () const
	Get the set language.
void	setControlVisible (const std::string &controlName, bool visible)
	Set if a control is visible or not.
bool	controlVisible (const std::string &controlName) const
	Check to see if a control is visible.
virtual void	createControlBefore (const std::string &control, const std::string &before)
	Creates this control before the specified control.
virtual void	createControlAfter (const std::string &control, const std::string &after)
	Creates this control after the specified control.
virtual void	removeControlCreationOrder (const std::string &control)
	Removes any creation order for the specified control.
const DtCreationOrderMap &	creationOrder () const
	Returns creation order map which is a map of widgets and whether or not they are created before (true) or after (false) the specified widget.
void	setAllowTabbedDockWidgets (bool b)
	Set whether tabbed dock widgets are allowed on the main window.
bool	allowTabbedDockWidgets () const
	Get whether tabbed dock widgets are allowed on the main window.

void	setControlLocation (const std::string &controlName, Location location)
	Set/Get the location for a control.
Location	controlLocation (const std::string &controlName) const
	Set/Get the location for a control.
Protected Types
typedef std::map< std::string, bool >	ControlVisibilityMap
typedef std::map< std::string, Location >	ControlLocationMap
Protected Attributes
std::string	myLanguage
ControlVisibilityMap	myControlVisibilityMap
ControlLocationMap	myControlLocationMap
DtCreationOrderMap	myCreationOrder
bool	myAllowTabbedDockWidgets

Detailed Description

A generic configuration for configuring the GUI.

Each GUI element is responsible for checking this configuration to determine if it should be shown.

Member Typedef Documentation

typedef std::pair<std::string, bool> makVrv::DtGuiConfiguration::DtGuiConfigurationCreationOrder

typedef std::map<std::string, DtGuiConfigurationCreationOrder> makVrv::DtGuiConfiguration::DtCreationOrderMap

typedef std::map<std::string,bool> makVrv::DtGuiConfiguration::ControlVisibilityMap [protected]

typedef std::map<std::string,Location> makVrv::DtGuiConfiguration::ControlLocationMap [protected]

Member Enumeration Documentation

enum makVrv::DtGuiConfiguration::Location

Enumerator:

Left
Right
Top
Bottom
DockWidgetLeft
DockWidgetRight
DockWidgetTop
DockWidgetBottom
ToolBarLeft
ToolBarRight
ToolBarTop
ToolBarBottom

Constructor & Destructor Documentation

makVrv::DtGuiConfiguration::DtGuiConfiguration ( )

CTOR.

makVrv::DtGuiConfiguration::DtGuiConfiguration ( const DtGuiConfiguration & copy )

CopyCTOR.

virtual makVrv::DtGuiConfiguration::~DtGuiConfiguration ( ) [virtual]

Member Function Documentation

void makVrv::DtGuiConfiguration::setLanguage ( const std::string & language )

Set the language used for translation.

Default is '' which means use hard coded English.

const std::string& makVrv::DtGuiConfiguration::language ( ) const

Get the set language.

void makVrv::DtGuiConfiguration::setControlLocation	(	const std::string &	controlName,
		Location	location
	)

Set/Get the location for a control.

Location makVrv::DtGuiConfiguration::controlLocation ( const std::string & controlName ) const

Set/Get the location for a control.

void makVrv::DtGuiConfiguration::setControlVisible	(	const std::string &	controlName,
		bool	visible
	)

Set if a control is visible or not.

bool makVrv::DtGuiConfiguration::controlVisible ( const std::string & controlName ) const

Check to see if a control is visible.

By default all controls are visible.

virtual void makVrv::DtGuiConfiguration::createControlBefore	(	const std::string &	control,
		const std::string &	before
	)		`[virtual]`

Creates this control before the specified control.

If a control order currently exists, replaces with this one

virtual void makVrv::DtGuiConfiguration::createControlAfter	(	const std::string &	control,
		const std::string &	after
	)		`[virtual]`

Creates this control after the specified control.

If a control order currently exists, replaces with this one

virtual void makVrv::DtGuiConfiguration::removeControlCreationOrder ( const std::string & control ) [virtual]

Removes any creation order for the specified control.

const DtCreationOrderMap& makVrv::DtGuiConfiguration::creationOrder ( ) const [inline]

Returns creation order map which is a map of widgets and whether or not they are created before (true) or after (false) the specified widget.

void makVrv::DtGuiConfiguration::setAllowTabbedDockWidgets ( bool b )

Set whether tabbed dock widgets are allowed on the main window.

bool makVrv::DtGuiConfiguration::allowTabbedDockWidgets ( ) const

Get whether tabbed dock widgets are allowed on the main window.

Member Data Documentation

std::string makVrv::DtGuiConfiguration::myLanguage [protected]

ControlVisibilityMap makVrv::DtGuiConfiguration::myControlVisibilityMap [protected]

ControlLocationMap makVrv::DtGuiConfiguration::myControlLocationMap [protected]

DtCreationOrderMap makVrv::DtGuiConfiguration::myCreationOrder [protected]

bool makVrv::DtGuiConfiguration::myAllowTabbedDockWidgets [protected]

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

include/vrvUtil/DtGuiConfiguration.h

Public Types

Public Member Functions