VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrf::DtVrfMainMenuAssembler Class Reference

DtVrfMainMenuAssembler used in DtVrfMainMenu register and unregister menus for menu bar. More...

Inheritance diagram for makVrf::DtVrfMainMenuAssembler:
Inheritance graph
[legend]

Public Member Functions

 DtVrfMainMenuAssembler (makVrv::DtDe &de)
 Constructor for this class should not be used unless overriding class.
virtual ~DtVrfMainMenuAssembler ()
 Destructor for this class which also should not be directly accessed.
virtual void registerMenu (makVrv::DtMenu *menu)
 Register a new menu class for use in DtVrfMainMenu.
virtual void unregisterMenu (makVrv::DtMenu *menu, bool deleteBuilder=true)
 Unregister an existing menu class in DtVrfMainMenu.
virtual void registerItem (makVrv::DtMenuItem *item)
 Register a new menu item class for use in DtVrfMainMenu.
virtual void unregisterItem (makVrv::DtMenuItem *item, bool deleteBuilder=true)
 Unregister an existing menu class in DtVrfMainMenu.
- Public Member Functions inherited from makVrf::DtConfigurableMenuAssembler
 DtConfigurableMenuAssembler (makVrv::DtDe &de)
virtual ~DtConfigurableMenuAssembler ()
void setDeleteReferences (bool b)
bool deleteReferences () const
void setLocalOnly (bool b)
bool localOnly () const
void cleanup ()
makVrv::DtMenuManagermenuManager ()
 Returns menu manager.
const makVrv::DtMenuManagermenuManager () const
QMenufindMenu (const makVrv::DtMenuPath &path)
 Returns the QMenu object for the given path.
QActionfindMenuItem (const makVrv::DtMenuPath &path)
virtual void merge (const DtQtMenuAssembler::MenuBuilderMap &)
 Merges the contents of the supplied menu builder map, adding new entries and replacing existing.
virtual void merge (const DtQtMenuAssembler::MenuItemBuilderMap &)
 Merges the contents of the supplied menu item builder map, adding new entries and replacing existing.
void makeChangesTo (makVrv::DtQtMenuAssembler *c)
void clearMakeChangesTo ()
virtual QMenuBar * menuBar ()
virtual QWidgetmenuWindow ()
void setCreateSubMenusForMissingMenus (bool b)
 If true, for any missing sub-menu item, create a menu builder and add it. Default is false.
virtual void assembleMenu (const makVrv::DtMenuPath &menuPath)
 Assemble a menu from the path.
- Public Member Functions inherited from makVrv::DtQtMenuAssembler
virtual ~DtQtMenuAssembler ()
 DTOR.
DtMenumenuBuilder (const std::string &) const
 Returns a menu builder given the menu id name.
DtMenuItemmenuItemBuilder (const std::string &) const
 Returns a menu item builder given the menu id name.
const MenuBuilderMapmenuBuilderMap () const
const MenuItemBuilderMapmenuItemBuilderMap () const
MenuBuilderMapmenuBuilderMap ()
MenuItemBuilderMapmenuItemBuilderMap ()
virtual void merge (const DtQtMenuAssembler::MenuBuilderMap &)
 Merges the contents of the supplied menu builder map, adding new entries and replacing existing.
virtual void merge (const DtQtMenuAssembler::MenuItemBuilderMap &)
 Merges the contents of the supplied menu item builder map, adding new entries and replacing existing.
- Public Member Functions inherited from makVrv::DtMenuAssembler
virtual ~DtMenuAssembler ()
 DTOR.
virtual void assemble (const DtMenuConfiguration &configuration)
 Assemble a configuration.
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Protected Member Functions

virtual void registerMenu (makVrv::DtMenuItem *)
 Call registerItem() instead.
virtual void unregisterMenu (makVrv::DtMenuItem *, bool)
 Call unregisterItem() instead.

Protected Attributes

makVrv::DtDemyDe
- Protected Attributes inherited from makVrf::DtConfigurableMenuAssembler
DtConfigurationMenuManager myMenuManager
std::vector
< makVrv::DtQtMenuAssembler * > 
myMakeChangesTo
bool myDeleteReferences
bool myLocalOnly
bool myCreateSubMenusForMissingMenus
- Protected Attributes inherited from makVrv::DtQtMenuAssembler
MenuBuilderMap myMenuBuilders
MenuItemBuilderMap myMenuItemBuilders
- Protected Attributes inherited from makVrv::DtMenuAssembler
std::stack< DtMenuPathmyMenuStack
DtDemyDe

Additional Inherited Members

- Public Types inherited from makVrv::DtQtMenuAssembler
typedef boost::unordered_map
< std::string, DtMenu * > 
MenuBuilderMap
typedef boost::unordered_map
< std::string, DtMenuItem * > 
MenuItemBuilderMap
- Static Public Member Functions inherited from makVrv::DtQtMenuAssembler
static DtQtMenuAssemblerinstance (DtDe &de)
 Get an instance of the assembler.

Detailed Description

DtVrfMainMenuAssembler used in DtVrfMainMenu register and unregister menus for menu bar.

Menus must be registered before they are added to the menu configuration. Menus and items already registered to this specific menu do not need to be re-registered. The assembler also assumes ownership of the object once you pass it in. If you want to add this menu to the path in this menu group, you need to use the DtVrfMainMenuConfig class to do so.

Constructor & Destructor Documentation

makVrf::DtVrfMainMenuAssembler::DtVrfMainMenuAssembler ( makVrv::DtDe de)

Constructor for this class should not be used unless overriding class.

Use the the DtVrfMainMenu class instead to access this object

virtual makVrf::DtVrfMainMenuAssembler::~DtVrfMainMenuAssembler ( )
virtual

Destructor for this class which also should not be directly accessed.

Destroy the main DtVrfMainMenu instead to destroy this object.

Member Function Documentation

virtual void makVrf::DtVrfMainMenuAssembler::registerMenu ( makVrv::DtMenu menu)
virtual

Register a new menu class for use in DtVrfMainMenu.

You still need to add the menu's path by using the addMenuPath() function in the config class.

Reimplemented from makVrf::DtConfigurableMenuAssembler.

virtual void makVrf::DtVrfMainMenuAssembler::unregisterMenu ( makVrv::DtMenu menu,
bool  deleteBuilder = true 
)
virtual

Unregister an existing menu class in DtVrfMainMenu.

You should remove the menu's path by using the removeMenuPath() function in the config class.

Reimplemented from makVrf::DtConfigurableMenuAssembler.

virtual void makVrf::DtVrfMainMenuAssembler::registerItem ( makVrv::DtMenuItem item)
virtual

Register a new menu item class for use in DtVrfMainMenu.

You still need to add the menu item's path by using the addMenuPath() function in the config class.

virtual void makVrf::DtVrfMainMenuAssembler::unregisterItem ( makVrv::DtMenuItem item,
bool  deleteBuilder = true 
)
virtual

Unregister an existing menu class in DtVrfMainMenu.

You should remove the menu's path by using the removeMenuPath() function in the config class.

virtual void makVrf::DtVrfMainMenuAssembler::registerMenu ( makVrv::DtMenuItem )
protectedvirtual

Call registerItem() instead.

Reimplemented from makVrf::DtConfigurableMenuAssembler.

virtual void makVrf::DtVrfMainMenuAssembler::unregisterMenu ( makVrv::DtMenuItem ,
bool   
)
protectedvirtual

Call unregisterItem() instead.

Reimplemented from makVrf::DtConfigurableMenuAssembler.

Member Data Documentation

makVrv::DtDe& makVrf::DtVrfMainMenuAssembler::myDe
protected

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

Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)