makVrv::DtUserInterfaceAssembler Class Reference

DEPRECATED The DtUserInterfaceAssembler builds parts of a window from it's list of builders. More...

Inheritance diagram for makVrv::DtUserInterfaceAssembler:

Public Types
typedef std::pair< std::string, bool >	WidgetCreationOrder
typedef boost::unordered_map < std::string, WidgetCreationOrder >	WidgetCreationOrderMap
typedef std::list< std::string >	BuilderList

Public Member Functions
virtual	~DtUserInterfaceAssembler ()
	Destructor.
virtual bool	destroyBuilder (const std::string &builderName, DtUserInterfaceBuilder *builder)
	Remove and destroy a menu build previously registered.
virtual DtUserInterfaceBuilder *	findMenuBuilder (const std::string &builderName) const
	Find a menu builder with the given name, if no builder is found than a null pointer is returned.
virtual void	registerMenuBuilder (const std::string &builderName, DtUserInterfaceBuilder *builder, int modeFlags)
	Set the menu builder instance with a given name.
virtual DtUserInterfaceBuilder *	findMenuItemBuilder (const std::string &builderName) const
	Find a menu item builder with the given name, if no builder is found than a null pointer is returned.
virtual void	registerMenuItemBuilder (const std::string &builderName, DtUserInterfaceBuilder *builder, int modeFlags)
	Set the menu item builder instance with a given name.
virtual DtUserInterfaceBuilder *	findWidgetBuilder (const std::string &builderName) const
	Find a widget builder with the given name, if no builder is found than a null pointer is returned.
virtual void	registerWidgetBuilder (const std::string &builderName, DtUserInterfaceBuilder *builder, int modeFlags)
	Set the widget builder instance with a given name.
virtual void	assemble (DtDe &de, DtDeMainWindow &mainWindow)
	Uses the builders to construct the assembly.
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.
virtual void	setMasterModeAssembleList (const BuilderList &builderList)
	Set the list of builders to actually assemble on the master.
virtual const BuilderList &	masterModeAssembleList () const
	Get the list of builders that are going to be assembled on the master.
virtual void	setSlaveModeAssembleList (const BuilderList &builderList)
	Set the list of builders to actually assemble on the slave.
virtual const BuilderList &	slaveModeAssembleList () const
	Get the list of builders that are going to be assembled on the slave.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtUserInterfaceAssembler &	instance (DtDe &de)
	Get the instance for this assembler.

Protected Types
typedef boost::unordered_map < std::string, DtUserInterfaceBuilder * >	BuilderMap

Protected Member Functions
	DtUserInterfaceAssembler ()
	brief Constructor.
virtual void	buildMenus (DtDe &de, DtDeMainWindow &mainWindow, BuilderList &builderList)
	Iterates through myMenuBuilderMap calling build() on each of the builders.
virtual void	buildMenuItems (DtDe &de, DtDeMainWindow &mainWindow, BuilderList &builderList)
	Iterates through myMenuItemBuilderMap calling build() on each of the builders.
virtual void	buildWidgets (DtDe &de, DtDeMainWindow &mainWindow, BuilderList &builderList)
	Iterates through myWidgetBuilderMap calling build() on each of the builders.
virtual void	build (DtDe &de, DtDeMainWindow &mainWindow, DtUserInterfaceBuilder *builder)
	Builds the widget, and connects the logic to the activate/ deactivate slots.
virtual void	mapNameToMode (const std::string &name, int modeFlags)
	Puts the builder name to into the correct mode maps so that during calls to assemble the correct widgets for the mode are built.
virtual BuilderList	widgetBuildOrder (const BuilderList &) const
	Returns the order in which widget elements should be created, based on the supplied list.

Static Protected Member Functions
static DtUserInterfaceAssembler *	create ()
	Static creator function.

Protected Attributes
BuilderMap	myMenuBuilderMap
BuilderMap	myMenuItemBuilderMap
BuilderMap	myWidgetBuilderMap
BuilderList	myMasterModeList
BuilderList	mySlaveModeList
WidgetCreationOrderMap	myCreationOrder

Detailed Description

DEPRECATED The DtUserInterfaceAssembler builds parts of a window from it's list of builders.

Member Typedef Documentation

typedef std::pair<std::string, bool> makVrv::DtUserInterfaceAssembler::WidgetCreationOrder

typedef boost::unordered_map<std::string, WidgetCreationOrder> makVrv::DtUserInterfaceAssembler::WidgetCreationOrderMap

typedef std::list<std::string> makVrv::DtUserInterfaceAssembler::BuilderList

typedef boost::unordered_map<std::string, DtUserInterfaceBuilder*> makVrv::DtUserInterfaceAssembler::BuilderMap

protected

Constructor & Destructor Documentation

virtual makVrv::DtUserInterfaceAssembler::~DtUserInterfaceAssembler ( )

virtual

Destructor.

makVrv::DtUserInterfaceAssembler::DtUserInterfaceAssembler ( )

protected

brief Constructor.

Member Function Documentation

static DtUserInterfaceAssembler& makVrv::DtUserInterfaceAssembler::instance ( DtDe &  de )

static

Get the instance for this assembler.

Creates this assembler if one doesn't exist (lazy creation).

virtual bool makVrv::DtUserInterfaceAssembler::destroyBuilder ( const std::string &  builderName, DtUserInterfaceBuilder *  builder  )

virtual

Remove and destroy a menu build previously registered.

If the pointer is null or has not been registered no action is taken.

Return values

true	if the builder was destroyed.
false	if no action was taken.

virtual DtUserInterfaceBuilder* makVrv::DtUserInterfaceAssembler::findMenuBuilder ( const std::string &  builderName ) const

virtual

Find a menu builder with the given name, if no builder is found than a null pointer is returned.

virtual void makVrv::DtUserInterfaceAssembler::registerMenuBuilder ( const std::string &  builderName, DtUserInterfaceBuilder *  builder, int  modeFlags  )

virtual

Set the menu builder instance with a given name.

If one exists, it is deleted and the newer one is added.

virtual DtUserInterfaceBuilder* makVrv::DtUserInterfaceAssembler::findMenuItemBuilder ( const std::string &  builderName ) const

virtual

Find a menu item builder with the given name, if no builder is found than a null pointer is returned.

virtual void makVrv::DtUserInterfaceAssembler::registerMenuItemBuilder ( const std::string &  builderName, DtUserInterfaceBuilder *  builder, int  modeFlags  )

virtual

Set the menu item builder instance with a given name.

If one exists, it is deleted and the newer one is added.

virtual DtUserInterfaceBuilder* makVrv::DtUserInterfaceAssembler::findWidgetBuilder ( const std::string &  builderName ) const

virtual

Find a widget builder with the given name, if no builder is found than a null pointer is returned.

virtual void makVrv::DtUserInterfaceAssembler::registerWidgetBuilder ( const std::string &  builderName, DtUserInterfaceBuilder *  builder, int  modeFlags  )

virtual

Set the widget builder instance with a given name.

If one exists, it is deleted and the newer one is added.

virtual void makVrv::DtUserInterfaceAssembler::assemble ( DtDe &  de, DtDeMainWindow &  mainWindow  )

virtual

Uses the builders to construct the assembly.

First builds menu's, then menu items, then widgets.

virtual void makVrv::DtUserInterfaceAssembler::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::DtUserInterfaceAssembler::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::DtUserInterfaceAssembler::removeControlCreationOrder ( const std::string &  control )

virtual

Removes any creation order for the specified control.

virtual void makVrv::DtUserInterfaceAssembler::setMasterModeAssembleList ( const BuilderList &  builderList )

virtual

Set the list of builders to actually assemble on the master.

virtual const BuilderList& makVrv::DtUserInterfaceAssembler::masterModeAssembleList ( ) const

virtual

Get the list of builders that are going to be assembled on the master.

virtual void makVrv::DtUserInterfaceAssembler::setSlaveModeAssembleList ( const BuilderList &  builderList )

virtual

Set the list of builders to actually assemble on the slave.

virtual const BuilderList& makVrv::DtUserInterfaceAssembler::slaveModeAssembleList ( ) const

virtual

Get the list of builders that are going to be assembled on the slave.

static DtUserInterfaceAssembler* makVrv::DtUserInterfaceAssembler::create ( )

staticprotected

Static creator function.

This class is 'lazily created' when needed. Creation happens during the first call to instance().

virtual void makVrv::DtUserInterfaceAssembler::buildMenus ( DtDe &  de, DtDeMainWindow &  mainWindow, BuilderList &  builderList  )

protectedvirtual

Iterates through myMenuBuilderMap calling build() on each of the builders.

virtual void makVrv::DtUserInterfaceAssembler::buildMenuItems ( DtDe &  de, DtDeMainWindow &  mainWindow, BuilderList &  builderList  )

protectedvirtual

Iterates through myMenuItemBuilderMap calling build() on each of the builders.

virtual void makVrv::DtUserInterfaceAssembler::buildWidgets ( DtDe &  de, DtDeMainWindow &  mainWindow, BuilderList &  builderList  )

protectedvirtual

Iterates through myWidgetBuilderMap calling build() on each of the builders.

virtual void makVrv::DtUserInterfaceAssembler::build ( DtDe &  de, DtDeMainWindow &  mainWindow, DtUserInterfaceBuilder *  builder  )

protectedvirtual

Builds the widget, and connects the logic to the activate/ deactivate slots.

virtual void makVrv::DtUserInterfaceAssembler::mapNameToMode ( const std::string &  name, int  modeFlags  )

protectedvirtual

Puts the builder name to into the correct mode maps so that during calls to assemble the correct widgets for the mode are built.

virtual BuilderList makVrv::DtUserInterfaceAssembler::widgetBuildOrder ( const BuilderList &  ) const

protectedvirtual

Returns the order in which widget elements should be created, based on the supplied list.

Member Data Documentation

BuilderMap makVrv::DtUserInterfaceAssembler::myMenuBuilderMap

protected

BuilderMap makVrv::DtUserInterfaceAssembler::myMenuItemBuilderMap

protected

BuilderMap makVrv::DtUserInterfaceAssembler::myWidgetBuilderMap

protected

BuilderList makVrv::DtUserInterfaceAssembler::myMasterModeList

protected

BuilderList makVrv::DtUserInterfaceAssembler::mySlaveModeList

protected

WidgetCreationOrderMap makVrv::DtUserInterfaceAssembler::myCreationOrder

protected

---

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

• include/vrvCore/DtUserInterfaceAssembler.h