VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends
makVrv::DtToolbarAssembler Class Reference

The base class implementation of a Toolbar Assembler. More...

Inheritance diagram for makVrv::DtToolbarAssembler:
Inheritance graph
[legend]

Public Member Functions

virtual ~DtToolbarAssembler ()
 DTOR.
virtual void assemble (const DtToolbarConfiguration &configuration)
 Assemble a configuration.
virtual void updateToolbars (const DtToolbarConfiguration &configuration)
 Updates the toolbar UI layout with the information passed in the configuration.
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Static Public Member Functions

static DtToolbarAssemblerinstance (DtDe &)
 Get an instance of the assembler.

Protected Types

typedef std::multimap
< DtToolbarConfiguration::ToolbarLocation,
DtToolbarPath
LocationPathMap
typedef std::map< int,
DtToolbarPath
ToolbarPathsMap
typedef std::map< int,
ToolbarPathsMap
ToolbarPathsMapMap

Protected Member Functions

 DtToolbarAssembler (DtDe &de)
void assembleToolbarPath (const DtToolbarPath &toolbarPath, const DtToolbarConfiguration &configuration, DtToolbarConfiguration::ToolbarLocation location)
 Assemble a toolbar path.
virtual void assembleRow (const DtToolbarPath &toolbarPath, DtToolbarConfiguration::ToolbarLocation location)
 Assemble a row from the path.
virtual void addToolbarBreak (DtToolbarConfiguration::ToolbarLocation loc)
 Add a toolbar break at the specified location.
virtual void assembleToolbar (const DtToolbarPath &toolbarPath, const DtToolbarConfiguration &configuration)
 Assemble a toolbar from the path.
virtual void assembleToolbarItem (const DtToolbarPath &toolbarPath)
 Assemble a toolbar from the path.
virtual void assembleToolbarMenuItem (const DtToolbarPath &toolbarPath)
 Assemble a toolbar from the path.
virtual void assembleToolbarWidget (const DtToolbarPath &toolbarPath)
 Assemble a toolbar from the path.
virtual void assembleToolbarMenu (const DtToolbarPath &toolbarPath)
 Assemble a toolbar from the path.
virtual void assembleTopLeftToolbars (const LocationPathMap &locMap, DtToolbarConfiguration::ToolbarLocation loc, const DtToolbarConfiguration &configuration)
 Assemble toolbars located at the top or left areas of the UI.
virtual void assembleBottomRightToolbars (const LocationPathMap &, DtToolbarConfiguration::ToolbarLocation, const DtToolbarConfiguration &)
 Assemble toolbars located at the bottom or right areas of the UI.
virtual void populateToobarPathsMap (const LocationPathMap &locMap, DtToolbarConfiguration::ToolbarLocation loc, const DtToolbarConfiguration &configuration, ToolbarPathsMapMap &tpMap)
 Populates the tpMap map with the proper order in which toolbars need to be placed on the UI.
virtual void updateToolbarPath (const DtToolbarPath &toolbarPath, const DtToolbarConfiguration &configuration)
 Update the tool bar path with the state information contained inside the provided configuration.
virtual void updateToolbar (const DtToolbarPath &toolbarPath, const DtToolbarConfiguration &configuration)
 Update the tool bar with the state information contained inside the provided configuration.

Protected Attributes

std::stack< DtToolbarPathmyToolbarStack
DtDemyDe

Friends

class DtToolbarAssemblerCreator

Detailed Description

The base class implementation of a Toolbar Assembler.

Member Typedef Documentation

Constructor & Destructor Documentation

virtual makVrv::DtToolbarAssembler::~DtToolbarAssembler ( )
virtual

DTOR.

makVrv::DtToolbarAssembler::DtToolbarAssembler ( DtDe de)
protected

Member Function Documentation

static DtToolbarAssembler& makVrv::DtToolbarAssembler::instance ( DtDe )
static

Get an instance of the assembler.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::assemble ( const DtToolbarConfiguration configuration)
virtual

Assemble a configuration.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::updateToolbars ( const DtToolbarConfiguration configuration)
virtual

Updates the toolbar UI layout with the information passed in the configuration.

void makVrv::DtToolbarAssembler::assembleToolbarPath ( const DtToolbarPath toolbarPath,
const DtToolbarConfiguration configuration,
DtToolbarConfiguration::ToolbarLocation  location 
)
protected

Assemble a toolbar path.

virtual void makVrv::DtToolbarAssembler::assembleRow ( const DtToolbarPath toolbarPath,
DtToolbarConfiguration::ToolbarLocation  location 
)
protectedvirtual

Assemble a row from the path.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::addToolbarBreak ( DtToolbarConfiguration::ToolbarLocation  loc)
protectedvirtual

Add a toolbar break at the specified location.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::assembleToolbar ( const DtToolbarPath toolbarPath,
const DtToolbarConfiguration configuration 
)
protectedvirtual

Assemble a toolbar from the path.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::assembleToolbarItem ( const DtToolbarPath toolbarPath)
protectedvirtual

Assemble a toolbar from the path.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::assembleToolbarMenuItem ( const DtToolbarPath toolbarPath)
protectedvirtual

Assemble a toolbar from the path.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::assembleToolbarWidget ( const DtToolbarPath toolbarPath)
protectedvirtual

Assemble a toolbar from the path.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::assembleToolbarMenu ( const DtToolbarPath toolbarPath)
protectedvirtual

Assemble a toolbar from the path.

Reimplemented in makVrv::DtQtToolbarAssembler.

virtual void makVrv::DtToolbarAssembler::assembleTopLeftToolbars ( const LocationPathMap locMap,
DtToolbarConfiguration::ToolbarLocation  loc,
const DtToolbarConfiguration configuration 
)
protectedvirtual

Assemble toolbars located at the top or left areas of the UI.

virtual void makVrv::DtToolbarAssembler::assembleBottomRightToolbars ( const LocationPathMap ,
DtToolbarConfiguration::ToolbarLocation  ,
const DtToolbarConfiguration  
)
protectedvirtual

Assemble toolbars located at the bottom or right areas of the UI.

virtual void makVrv::DtToolbarAssembler::populateToobarPathsMap ( const LocationPathMap locMap,
DtToolbarConfiguration::ToolbarLocation  loc,
const DtToolbarConfiguration configuration,
ToolbarPathsMapMap tpMap 
)
protectedvirtual

Populates the tpMap map with the proper order in which toolbars need to be placed on the UI.

virtual void makVrv::DtToolbarAssembler::updateToolbarPath ( const DtToolbarPath toolbarPath,
const DtToolbarConfiguration configuration 
)
protectedvirtual

Update the tool bar path with the state information contained inside the provided configuration.

virtual void makVrv::DtToolbarAssembler::updateToolbar ( const DtToolbarPath toolbarPath,
const DtToolbarConfiguration configuration 
)
protectedvirtual

Update the tool bar with the state information contained inside the provided configuration.

The toolbarPath is expected to represent a toolbar, not a toolbar item.

Friends And Related Function Documentation

friend class DtToolbarAssemblerCreator
friend

Member Data Documentation

std::stack<DtToolbarPath> makVrv::DtToolbarAssembler::myToolbarStack
protected
DtDe& makVrv::DtToolbarAssembler::myDe
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)