Examples

Inheritance diagram for makVrf::DtCreateMenu:

Classes
struct	AdditionalItem

Public Types
typedef std::vector < AdditionalItem >	AdditionalItems

typedef DtOrderedEntityTypeList < DtCreateObjectActionCreator * >	ObjectActionCreators

Public Member Functions
	DtCreateMenu (makVrv::DtDe &, const QString &createName=DtCreateMenuId)

virtual	~DtCreateMenu () override

virtual QMenu *	createMenu (makVrv::DtDe &, QWidget *parent) override

virtual void	setUseGlobalMenuManager (bool)

virtual bool	useGlobalMenuManager () const

virtual DtCreateMenu *	newInstance ()

virtual DtCreateMenu *	clone () const

virtual DtCreateMenu *	duplicate (QMenu &, QWidget parent, DtVrfMenu *menu=0)

void	setTearOffsEnabled (bool b)

virtual void	setBaseCreateMenu (DtVrfMenu *)

virtual DtEntityType	nameToType (const QString &) const

virtual bool	triggerAction (const DtEntityMapperKey &key)

bool	tearOffsEnabled () const

virtual void	setSignalCreation (bool)

bool	signalCreation () const

const AdditionalItems &	additionalItems () const

AdditionalItems &	additionalItems ()

virtual void	setCreateObjectActionCreatorFor (const DtEntityType &, DtCreateObjectActionCreator *)

virtual DtCreateObjectActionCreator *	createObjectActionCreatorFor (const DtEntityType &) const

const DtVrfCreateMenu::MappedActions &	mappedActions () const

virtual DtCreateMenuFlags	menuFlags () const

bool	removePaletteItems () const

bool	removeExtraCreateItems () const

virtual void	setMenuFlags (DtCreateMenuFlags b)

virtual DtSubMenuConfiguration &	menuConfiguration () override

virtual DtConfigurableMenuAssembler &	menuAssembler () override

virtual void	addItemToCreate (const makVrv::DtMenuPath &path, const DtEntityMapperKey &key, const DtString &keywords="", const DtString &menuIcon="")

virtual void	removeItemToCreate (const makVrv::DtMenuPath &)

virtual void	addItemToCreateBefore (const makVrv::DtMenuPath &path, const makVrv::DtMenuPath &before, const DtEntityMapperKey &key, const DtString &keywords="", const DtString &menuIcon="")

virtual void	addItemToCreateAfter (const makVrv::DtMenuPath &path, const makVrv::DtMenuPath &after, const DtEntityMapperKey &key, const DtString &keywords="", const DtString &menuIcon="")

Public Member Functions inherited from makVrf::DtConfigurableMenu
	DtConfigurableMenu (makVrv::DtDe &, const std::string &className)

virtual	~DtConfigurableMenu () override

virtual void	registerMenu (makVrv::DtMenu *customMenu)

virtual void	registerMenuItem (makVrv::DtMenuItem *customMenuItem)

virtual void	createSimpleMenu (std::string menuText, makVrv::DtMenuPath menuIdPath, const makVrv::DtMenuConfiguration::MenuSortFlags &sortFlagsIfMenu=(makVrv::DtMenuConfiguration::MenuSortFlags)(makVrv::DtMenuConfiguration::SortAllAlphabetically\|makVrv::DtMenuConfiguration::SortWithinSubmenus\|makVrv::DtMenuConfiguration::SortBetweenSeparators))

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, const makVrv::DtMenuConfiguration::MenuSortFlags &sortFlagsIfMenu=(makVrv::DtMenuConfiguration::MenuSortFlags)(makVrv::DtMenuConfiguration::SortAllAlphabetically\|makVrv::DtMenuConfiguration::SortWithinSubmenus\|makVrv::DtMenuConfiguration::SortBetweenSeparators))

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)

virtual void	mergeMenu (makVrv::DtQtMenuAssembler &assembler)

virtual void	mergeMenu (makVrv::DtMenuConfiguration &configuration)

Public Member Functions inherited from makVrv::DtMenu
	DtMenu (DtDe &de, const std::string &menuIdName)

virtual	~DtMenu ()

virtual const std::string &	menuIdName () const

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtCreateMenu &	instance (makVrv::DtDe &)

static DtCreateMenu *	menuInstance (makVrv::DtDe &)

Static Public Member Functions inherited from makVrf::DtConfigurableMenu
static bool	hasMenuPath (const makVrv::DtMenuConfiguration &menus, const makVrv::DtMenuPath &sourcePath, const std::string &item, makVrv::DtMenuPath &foundPath)

Public Attributes
boost::signals2::signal< void(const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData &)>	signal_createObject

Public Attributes inherited from makVrf::DtConfigurableMenu
boost::signals2::signal< void(DtConfigurableMenu *)>	signal_menuRecreated

boost::signals2::signal< void(QAction *)>	signal_validateMenuItem

Protected Member Functions
virtual void	createMenuConfiguration (makVrv::DtDe &de) override

virtual void	slot_onCreateObject (const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData &)

virtual void	menuRecreated ()

Protected Member Functions inherited from makVrf::DtConfigurableMenu
virtual void	initMenuItems (makVrv::DtDe &de)

DtConfigurableMenuAssembler &	assembler ()

DtSubMenuConfiguration &	configuration ()

Protected Attributes
bool	myTearOffsEnabled

AdditionalItems	myAdditionalItems

bool	mySignalCreation

ObjectActionCreators	myObjectActionCreators

DtCreateMenuFlags	myMenuFlags

DtVrfMenu *	myBaseCreateMenu

bool	myUseGlobalMenuManager

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 DtConfigurableMenuAssembler *	theMenuAssembler

static DtSubMenuConfiguration *	theMenuConfiguration

Member Typedef Documentation

typedef std::vector<AdditionalItem> makVrf::DtCreateMenu::AdditionalItems

typedef DtOrderedEntityTypeList<DtCreateObjectActionCreator*> makVrf::DtCreateMenu::ObjectActionCreators

Constructor & Destructor Documentation

makVrf::DtCreateMenu::DtCreateMenu	(	makVrv::DtDe &	,
		const QString &	createName = `DtCreateMenuId`
	)

CTOR.

virtual makVrf::DtCreateMenu::~DtCreateMenu ( )

overridevirtual

DTOR.

Member Function Documentation

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

overridevirtual

Build a menu.

Implements makVrv::DtMenu.

Reimplemented in makVrf::DtRightClickCreateMenu.

static DtCreateMenu& makVrf::DtCreateMenu::instance ( makVrv::DtDe & )

static

virtual void makVrf::DtCreateMenu::setUseGlobalMenuManager ( bool )

virtual

The useGlobalMenuManager should only be used for the first instance of the create menu. Not for create menus on dialogs. If true, when actions are created they will be added to the global menu manager.

virtual bool makVrf::DtCreateMenu::useGlobalMenuManager ( ) const

virtual

static DtCreateMenu* makVrf::DtCreateMenu::menuInstance ( makVrv::DtDe & )

static

Return a new copy, not the registered copy. It will do this by calling the newInstance method on the currently registered version. newInstance needs to be overridden by subclasses to return their own new instance.

virtual DtCreateMenu* makVrf::DtCreateMenu::newInstance ( )

virtual

virtual DtCreateMenu* makVrf::DtCreateMenu::clone ( ) const

virtual

Returns a duplicate of this menu. If you are subclassing this menu, override the clone() method to return a new instance of your subclass.

virtual DtCreateMenu* makVrf::DtCreateMenu::duplicate	(	QMenu *&	,
		QWidget *	parent,
		DtVrfMenu *	menu = `0`
	)

virtual

If menu is specified, uses that rather than scenario default.

void makVrf::DtCreateMenu::setTearOffsEnabled ( bool b )

inline

virtual void makVrf::DtCreateMenu::setBaseCreateMenu ( DtVrfMenu * )

virtual

virtual DtEntityType makVrf::DtCreateMenu::nameToType ( const QString & ) const

virtual

Given a name of a menu item (e.g. M1A2) return the entity type that represents that.

virtual bool makVrf::DtCreateMenu::triggerAction ( const DtEntityMapperKey & key )

virtual

Given an entity key, trigger that action to create it. Return true if action is found.

bool makVrf::DtCreateMenu::tearOffsEnabled ( ) const

inline

virtual void makVrf::DtCreateMenu::setSignalCreation ( bool )

virtual

Set to true to signal creation rather than creating immediately. Will send boost signal_createObject signal if true.

bool makVrf::DtCreateMenu::signalCreation ( ) const

inline

const AdditionalItems& makVrf::DtCreateMenu::additionalItems ( ) const

inline

Returns items that are scheduled to be added to new create menus.

AdditionalItems& makVrf::DtCreateMenu::additionalItems ( )

inline

virtual void makVrf::DtCreateMenu::setCreateObjectActionCreatorFor	(	const DtEntityType &	,
		DtCreateObjectActionCreator *
	)

virtual

Add/replace the object action creator for the specified entity mapper key.

virtual DtCreateObjectActionCreator* makVrf::DtCreateMenu::createObjectActionCreatorFor ( const DtEntityType & ) const

virtual

Return the object action creator for the specified type.

const DtVrfCreateMenu::MappedActions& makVrf::DtCreateMenu::mappedActions ( ) const

virtual DtCreateMenuFlags makVrf::DtCreateMenu::menuFlags ( ) const

inlinevirtual

bool makVrf::DtCreateMenu::removePaletteItems ( ) const

inline

References makVrf::DtCreateMenuRemovePaletteItems.

bool makVrf::DtCreateMenu::removeExtraCreateItems ( ) const

inline

References makVrf::DtCreateMenuRemoveExtraCreateItems.

virtual void makVrf::DtCreateMenu::setMenuFlags ( DtCreateMenuFlags b )

inlinevirtual

When creating the menu, set to true to remove the "Entity Palette..." and other palette related items item.

virtual void makVrf::DtCreateMenu::createMenuConfiguration ( makVrv::DtDe & de )

overrideprotectedvirtual

Called to initially create the menu configuration.

Reimplemented from makVrf::DtConfigurableMenu.

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

overridevirtual

Returns the configuration for the menu to be used in the master mode. May be effected directly.

When using this configuration, it is used a bit differently than other configuration due to the nature of the create menu itself

When referencing the main menu, referece CreateMenu as the main menu (makVrv::DtMenuPath::mainMenu("CreateMenu")) Sub-menus and items are referenced by their name as they appear in the entity.mst file (Friendly, Opposing, M1A2, etc).

Reimplemented from makVrf::DtConfigurableMenu.

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

overridevirtual

Returns the configuration for the menu to be used in the master mode. May be effected directly.

Reimplemented from makVrf::DtConfigurableMenu.

virtual void makVrf::DtCreateMenu::addItemToCreate	(	const makVrv::DtMenuPath &	path,
		const DtEntityMapperKey &	key,
		const DtString &	keywords = `""`,
		const DtString &	menuIcon = `""`
	)

virtual

Routines to add items to the menu to create. Shortcut for adding a menu item creator of type DtCreateObjectAction and a menu item to the path.

Add at least the keyword on_overlay to allow the object to be placed on overlay layers. This means it can be created locally and placed on the overlay palette

TODO: Make sure this gets on the overlay palette

virtual void makVrf::DtCreateMenu::removeItemToCreate ( const makVrv::DtMenuPath & )

virtual

Call to remove an additional item to create.

virtual void makVrf::DtCreateMenu::addItemToCreateBefore	(	const makVrv::DtMenuPath &	path,
		const makVrv::DtMenuPath &	before,
		const DtEntityMapperKey &	key,
		const DtString &	keywords = `""`,
		const DtString &	menuIcon = `""`
	)

virtual

Same as above, except adds before specified path.

virtual void makVrf::DtCreateMenu::addItemToCreateAfter	(	const makVrv::DtMenuPath &	path,
		const makVrv::DtMenuPath &	after,
		const DtEntityMapperKey &	key,
		const DtString &	keywords = `""`,
		const DtString &	menuIcon = `""`
	)

virtual

Same as above, except adds after specified path.

virtual void makVrf::DtCreateMenu::slot_onCreateObject ( const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData & )

protectedvirtual

virtual void makVrf::DtCreateMenu::menuRecreated ( )

protectedvirtual

Member Data Documentation

boost::signals2::signal<void (const DtVrfObjectManipulationHandlerBaseClass::ObjectManipulationData&)> makVrf::DtCreateMenu::signal_createObject

bool makVrf::DtCreateMenu::myTearOffsEnabled

protected

AdditionalItems makVrf::DtCreateMenu::myAdditionalItems

protected

bool makVrf::DtCreateMenu::mySignalCreation

protected

ObjectActionCreators makVrf::DtCreateMenu::myObjectActionCreators

protected

DtCreateMenuFlags makVrf::DtCreateMenu::myMenuFlags

protected

DtConfigurableMenuAssembler* makVrf::DtCreateMenu::theMenuAssembler

staticprotected

Variables used to store initial menu configuration.

DtSubMenuConfiguration* makVrf::DtCreateMenu::theMenuConfiguration

staticprotected

DtVrfMenu* makVrf::DtCreateMenu::myBaseCreateMenu

protected

bool makVrf::DtCreateMenu::myUseGlobalMenuManager

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfGuiCoreQt/createMenu.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation