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

A Qt implementation of a DtToolbarAssembler. More...

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

Public Types

typedef std::map< std::string,
DtToolbar * > 
ToolbarBuilderMap

Public Member Functions

virtual ~DtQtToolbarAssembler ()
 DTOR.
void registerToolbar (DtToolbar *)
 Register a toolbar builder.
DtToolbartoolbarBuilder (const std::string &) const
 Returns a toolbar builder given the toolbar id name.
void unregisterToolbar (DtToolbar *, bool deleteBuilder=true)
 Register a toolbar builder.
const ToolbarBuilderMaptoolbarBuilderMap () const
ToolbarBuilderMaptoolbarBuilderMap ()
virtual void setIconSize (const QSize &)
 Sets the icon size used for button images on the toolbars. Default is 16x16.
const QSize & iconSize () const
virtual void merge (const DtQtToolbarAssembler::ToolbarBuilderMap &)
 Merges the contents of the supplied toolbar builder map, adding new entries and replacing existing.
virtual void registerWidgetBuilder (const std::string &, DtWidgetBuilder *, bool deleteExisting=true)
 Adds in a widget builder that can be used to create a widget for a toolbar.
virtual DtWidgetBuilderwidgetBuilder (const std::string &)
 Returns a widget builder with a given name.
virtual void unregisterWidgetBuilder (const std::string &, bool deleteExisting=true)
 Removes a widget builder and deletes if deleteExisting is true.
- Public Member Functions inherited from makVrv::DtToolbarAssembler
virtual ~DtToolbarAssembler ()
 DTOR.
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 DtQtToolbarAssemblerinstance (DtDe &de)
 Get an instance of the assembler.

Protected Types

typedef std::map< std::string,
DtWidgetBuilder * > 
WidgetBuilders
typedef std::map< int,
std::string > 
RowBreakMap
- Protected Types inherited from makVrv::DtToolbarAssembler
typedef std::multimap
< DtToolbarConfiguration::ToolbarLocation,
DtToolbarPath
LocationPathMap
typedef std::map< int,
DtToolbarPath
ToolbarPathsMap
typedef std::map< int,
ToolbarPathsMap
ToolbarPathsMapMap

Protected Member Functions

 DtQtToolbarAssembler (DtDe &)
 CTOR.
virtual QActionfindMenuItem (const std::string &item, const std::map< DtMenuPath, QAction * > &menuItems) const
virtual void assembleRow (const DtToolbarPath &toolbarPath, DtToolbarConfiguration::ToolbarLocation location)
 Assemble a row from the path.
virtual void assembleToolbar (const DtToolbarPath &toolbarPath, const DtToolbarConfiguration &configuration)
 Assemble a toolbar from the path.
virtual void assembleToolbarItem (const DtToolbarPath &toolbarPath)
 Assemble a menu item from the path.
virtual void assembleToolbarMenuItem (const DtToolbarPath &toolbarPath)
 Assemble a toolbar from the path.
virtual void assembleToolbarWidget (const DtToolbarPath &toolbarPath)
 Assemble a widget from the path.
virtual void assembleToolbarMenu (const DtToolbarPath &toolbarPath)
 Assemble a menu from the path.
virtual QWidgettoolbarWindow ()
virtual DtQtToolbarManagertoolbarManager ()
virtual void assemble (const DtToolbarConfiguration &configuration)
 Override to assemble menus into local assembler.
virtual void addToolbarBreak (DtToolbarConfiguration::ToolbarLocation loc)
 Add a toolbar break at the specified location.
- Protected Member Functions inherited from makVrv::DtToolbarAssembler
 DtToolbarAssembler (DtDe &de)
void assembleToolbarPath (const DtToolbarPath &toolbarPath, const DtToolbarConfiguration &configuration, DtToolbarConfiguration::ToolbarLocation location)
 Assemble a toolbar 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

ToolbarBuilderMap myToolbarBuilders
DtQtToolbarMenuAssembler myToolbarMenuAssembler
WidgetBuilders myWidgetBuilders
QSize myIconSize
RowBreakMap myOnRow
- Protected Attributes inherited from makVrv::DtToolbarAssembler
std::stack< DtToolbarPathmyToolbarStack
DtDemyDe

Friends

class DtQtToolbarAssemblerCreator

Detailed Description

A Qt implementation of a DtToolbarAssembler.

Member Typedef Documentation

typedef std::map<std::string, DtWidgetBuilder*> makVrv::DtQtToolbarAssembler::WidgetBuilders
protected
typedef std::map<int, std::string> makVrv::DtQtToolbarAssembler::RowBreakMap
protected

Constructor & Destructor Documentation

virtual makVrv::DtQtToolbarAssembler::~DtQtToolbarAssembler ( )
virtual

DTOR.

makVrv::DtQtToolbarAssembler::DtQtToolbarAssembler ( DtDe )
protected

CTOR.

Member Function Documentation

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

Get an instance of the assembler.

Reimplemented from makVrv::DtToolbarAssembler.

void makVrv::DtQtToolbarAssembler::registerToolbar ( DtToolbar )

Register a toolbar builder.

DtToolbar* makVrv::DtQtToolbarAssembler::toolbarBuilder ( const std::string &  ) const

Returns a toolbar builder given the toolbar id name.

void makVrv::DtQtToolbarAssembler::unregisterToolbar ( DtToolbar ,
bool  deleteBuilder = true 
)

Register a toolbar builder.

const ToolbarBuilderMap& makVrv::DtQtToolbarAssembler::toolbarBuilderMap ( ) const
inline
ToolbarBuilderMap& makVrv::DtQtToolbarAssembler::toolbarBuilderMap ( )
inline
virtual void makVrv::DtQtToolbarAssembler::setIconSize ( const QSize &  )
virtual

Sets the icon size used for button images on the toolbars. Default is 16x16.

const QSize& makVrv::DtQtToolbarAssembler::iconSize ( ) const
virtual void makVrv::DtQtToolbarAssembler::merge ( const DtQtToolbarAssembler::ToolbarBuilderMap )
virtual

Merges the contents of the supplied toolbar builder map, adding new entries and replacing existing.

virtual void makVrv::DtQtToolbarAssembler::registerWidgetBuilder ( const std::string &  ,
DtWidgetBuilder ,
bool  deleteExisting = true 
)
virtual

Adds in a widget builder that can be used to create a widget for a toolbar.

If one exists, will replace. Will delete if delete flag is true

virtual DtWidgetBuilder* makVrv::DtQtToolbarAssembler::widgetBuilder ( const std::string &  )
virtual

Returns a widget builder with a given name.

virtual void makVrv::DtQtToolbarAssembler::unregisterWidgetBuilder ( const std::string &  ,
bool  deleteExisting = true 
)
virtual

Removes a widget builder and deletes if deleteExisting is true.

virtual QAction* makVrv::DtQtToolbarAssembler::findMenuItem ( const std::string &  item,
const std::map< DtMenuPath, QAction * > &  menuItems 
) const
protectedvirtual
virtual void makVrv::DtQtToolbarAssembler::assembleRow ( const DtToolbarPath toolbarPath,
DtToolbarConfiguration::ToolbarLocation  location 
)
protectedvirtual

Assemble a row from the path.

If row has already been created, then, do not add a break. Since rows are really just toolbar breaks, if the current row is different than the last row, then, add a new break

Reimplemented from makVrv::DtToolbarAssembler.

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

Assemble a toolbar from the path.

Reimplemented from makVrv::DtToolbarAssembler.

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

Assemble a menu item from the path.

Reimplemented from makVrv::DtToolbarAssembler.

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

Assemble a toolbar from the path.

Reimplemented from makVrv::DtToolbarAssembler.

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

Assemble a widget from the path.

Reimplemented from makVrv::DtToolbarAssembler.

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

Assemble a menu from the path.

Will look in menu manager first for menu if the menu exists. If not will create the menu from the local assembler

Reimplemented from makVrv::DtToolbarAssembler.

virtual QWidget* makVrv::DtQtToolbarAssembler::toolbarWindow ( )
protectedvirtual
virtual DtQtToolbarManager& makVrv::DtQtToolbarAssembler::toolbarManager ( )
protectedvirtual
virtual void makVrv::DtQtToolbarAssembler::assemble ( const DtToolbarConfiguration configuration)
protectedvirtual

Override to assemble menus into local assembler.

Reimplemented from makVrv::DtToolbarAssembler.

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

Add a toolbar break at the specified location.

Reimplemented from makVrv::DtToolbarAssembler.

Friends And Related Function Documentation

friend class DtQtToolbarAssemblerCreator
friend

Member Data Documentation

ToolbarBuilderMap makVrv::DtQtToolbarAssembler::myToolbarBuilders
protected
DtQtToolbarMenuAssembler makVrv::DtQtToolbarAssembler::myToolbarMenuAssembler
protected
WidgetBuilders makVrv::DtQtToolbarAssembler::myWidgetBuilders
protected
QSize makVrv::DtQtToolbarAssembler::myIconSize
protected
RowBreakMap makVrv::DtQtToolbarAssembler::myOnRow
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)