makVrf::DtVrfMainMenu Class Reference

DtVrfMainMenu Main accessor for modifying items in the menu bar. More...

Inheritance diagram for makVrf::DtVrfMainMenu:

Public Member Functions
virtual	~DtVrfMainMenu ()
	Destructor for this class.
virtual DtSubMenuConfiguration &	menuConfiguration ()
	Gets the menu configuration for this class used to add/remove menu paths from the menu bar.
virtual DtConfigurableMenuAssembler &	menuAssembler ()
	Gets the menu assembler for this class used to register/unregister menu/items to/from the menu bar.
Public Member Functions inherited from makVrf::DtConfigurableMenu
	DtConfigurableMenu (makVrv::DtDe &, const std::string &className)
	CTOR.
virtual	~DtConfigurableMenu ()
	DTOR.
virtual void	registerMenu (makVrv::DtMenu *customMenu)
	Use to register your own complex menu object.
virtual void	registerMenuItem (makVrv::DtMenuItem *customMenuItem)
	Use to register your own complex menu item object.
virtual void	createSimpleMenu (std::string menuText, makVrv::DtMenuPath menuIdPath, int weight=-1)
virtual void	createSimpleMenuAfter (std::string menuText, makVrv::DtMenuPath menuIdPath, makVrv::DtMenuPath afterIdPath)
virtual void	createSimpleMenuBefore (std::string menuText, makVrv::DtMenuPath menuIdPath, makVrv::DtMenuPath beforeIdPath)
virtual void	createSimpleMenuItem (std::string itemText, makVrv::DtMenuPath itemIdPath, DtSimpleMenuItemAction *action, void *usr=NULL, int weight=-1)
virtual void	createSimpleMenuItemAfter (std::string itemText, makVrv::DtMenuPath itemIdPath, makVrv::DtMenuPath afterIdPath, DtSimpleMenuItemAction *action, void *usr=NULL)
virtual void	createSimpleMenuItemBefore (std::string itemText, makVrv::DtMenuPath itemIdPath, makVrv::DtMenuPath beforeIdPath, DtSimpleMenuItemAction *action, void *usr=NULL)
virtual void	mergeMenu (makVrv::DtQtMenuAssembler &assembler, makVrv::DtMenuConfiguration &configuration)
	Merges in the assembler and configuration into the supplied assembler and configuration.
virtual void	mergeMenu (makVrv::DtQtMenuAssembler &assembler)
	Merges in the assembler into the supplied assembler.
virtual void	mergeMenu (makVrv::DtMenuConfiguration &configuration)
	Merges in the configuration into the supplied configuration. This merges all the menu paths together.
Public Member Functions inherited from makVrv::DtMenu
	DtMenu (DtDe &de, const std::string &menuIdName)
	CTOR.
virtual	~DtMenu ()
	DTOR.
virtual const std::string &	menuIdName () const
	Get the menu id name, the menu id name is not the same thing as the visible menu text.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtVrfMainMenu &	instance (makVrv::DtDe &de)
	Get the instance of this object.

Protected Member Functions
	DtVrfMainMenu (makVrv::DtDe &)
	The constructor is protected in this class as this class should be accessed with the instance() function.
virtual void	createMenuConfiguration (makVrv::DtDe &)
	Overridden function from base class.
virtual QMenu *	createMenu (makVrv::DtDe &, QWidget *)
	Overridden function from base class.
Protected Member Functions inherited from makVrf::DtConfigurableMenu
virtual void	initMenuItems (makVrv::DtDe &de)
DtConfigurableMenuAssembler &	assembler ()
DtSubMenuConfiguration &	configuration ()

Protected Attributes
makVrv::DtDe &	myDe
DtVrfMainMenuConfiguration	myConfig
DtVrfMainMenuAssembler	myAssembler
Protected Attributes inherited from makVrf::DtConfigurableMenu
DtConfigurableMenuAssembler	myAssembler
DtSubMenuConfiguration	myConfiguration
bool	myInitialized
makVrv::DtSignalConnectionManager	myConnections
Protected Attributes inherited from makVrv::DtMenu
DtDe &	myDe
std::string	myMenuIdName

Static Protected Attributes
static DtVrfMainMenu *	theInstance

Additional Inherited Members
Public Attributes inherited from makVrf::DtConfigurableMenu
boost::signal< void(DtConfigurableMenu *)>	signal_menuRecreated
	Signal sent when this menu is recreated from it's original creation.
boost::signal< void(QAction *)>	signal_validateMenuItem

Detailed Description

DtVrfMainMenu Main accessor for modifying items in the menu bar.

Used primarily to modify items in the menu bar particularly from plugins. Similar to other such classes which are divided up among multiple DtConfigurableMenu overrides.

Examples

• guiLocalCreateObject
• guiObjectDataInterface
• interfaceContentGui
• menuManipulation
• unitStatus

Constructor & Destructor Documentation

virtual makVrf::DtVrfMainMenu::~DtVrfMainMenu ( )

virtual

Destructor for this class.

Likely this should only be destroyed if you have a good reason to do so since it is a singleton.

makVrf::DtVrfMainMenu::DtVrfMainMenu ( makVrv::DtDe &  )

protected

The constructor is protected in this class as this class should be accessed with the instance() function.

Member Function Documentation

static DtVrfMainMenu& makVrf::DtVrfMainMenu::instance ( makVrv::DtDe &  de )

static

Get the instance of this object.

It is static so don't delete it unless you have a good reason to do so.

virtual DtSubMenuConfiguration& makVrf::DtVrfMainMenu::menuConfiguration ( )

virtual

Gets the menu configuration for this class used to add/remove menu paths from the menu bar.

Reimplemented from makVrf::DtConfigurableMenu.

virtual DtConfigurableMenuAssembler& makVrf::DtVrfMainMenu::menuAssembler ( )

virtual

Gets the menu assembler for this class used to register/unregister menu/items to/from the menu bar.

This accessor is not entirely needed as there are the functions that do this for you in this class (inherited) and only really used if you specifically want to register menus/items from other menus.

Reimplemented from makVrf::DtConfigurableMenu.

virtual void makVrf::DtVrfMainMenu::createMenuConfiguration ( makVrv::DtDe &  )

protectedvirtual

Overridden function from base class.

If you override this class for any reason, you should not override this function.

Reimplemented from makVrf::DtConfigurableMenu.

virtual QMenu* makVrf::DtVrfMainMenu::createMenu ( makVrv::DtDe &  , QWidget *    )

protectedvirtual

Overridden function from base class.

If you override this class for any reason, you should not override this function.

Implements makVrv::DtMenu.

Member Data Documentation

makVrv::DtDe& makVrf::DtVrfMainMenu::myDe

protected

DtVrfMainMenu* makVrf::DtVrfMainMenu::theInstance

staticprotected

DtVrfMainMenuConfiguration makVrf::DtVrfMainMenu::myConfig

protected

DtVrfMainMenuAssembler makVrf::DtVrfMainMenu::myAssembler

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCoreQt/vrfMainMenu.h