VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Attributes
makVrf::DtTaskMenu Class Reference

Container class that will create instances of the task menu which will configure itself for tasks.

Examples
Inheritance diagram for makVrf::DtTaskMenu:
Inheritance graph
[legend]

Public Member Functions

 DtTaskMenu (makVrv::DtDe &, const std::string &menuIdName=DtTaskMenuId)
 
virtual ~DtTaskMenu ()
 
virtual QMenucreateMenu (makVrv::DtDe &, QWidget *parent)
 
virtual DtTaskMenunewInstance ()
 
virtual int supportedScriptType (int d) const
 
virtual const charsupportsToolbarType () const
 
virtual void giveBackTaskMenu (DtVrfTaskSetMenu *)
 
virtual DtVrfTaskSetMenucreateTaskMenu (QWidget *widgetOwner, QMenuBar *menuOwner=nullptr, int flags=DtScriptedTaskConfigurableMenu::RecreateOnScriptedTaskChange|DtScriptedTaskConfigurableMenu::RecreateMenuOnSelectionChange|DtScriptedTaskConfigurableMenu::SkipInitialMenuSetup)
 
bool hasPrecreatedMenus () const
 
- Public Member Functions inherited from makVrf::DtScriptedTaskConfigurableMenu
 DtScriptedTaskConfigurableMenu (makVrv::DtDe &, const std::string &menuIdName)
 
virtual ~DtScriptedTaskConfigurableMenu ()
 
virtual void setEditMode (bool)
 
virtual bool editMode () const
 
virtual void setRecreateFlags (RecreateFlags)
 
virtual void addScriptedTask (const DtScriptedTaskMetaData &, bool signal=true)
 
virtual void addScriptedTasks (DtSubMenuConfiguration &, makVrv::DtToolbarConfiguration &, DtConfigurableMenuAssembler &, bool addToolbarMenuItems=true, bool useGlobalMenuManager=false)
 
virtual void setScriptedTasks (const ScriptedTasks &, bool signal=true)
 
virtual const ScriptedTasksscriptedTasks () const
 
virtual void setMenuConfiguration (const DtSubMenuConfiguration &)
 
DtVrfTaskSetMenumenu ()
 
- Public Member Functions inherited from makVrf::DtConfigurableMenu
 DtConfigurableMenu (makVrv::DtDe &, const std::string &className)
 
virtual ~DtConfigurableMenu ()
 
virtual DtSubMenuConfigurationmenuConfiguration ()
 
virtual
DtConfigurableMenuAssembler
menuAssembler ()
 
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 DtTaskMenuinstance (makVrv::DtDe &)
 
static DtTaskMenumenuInstance (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)
 

Protected Slots

virtual void precreatedMenuDeleted ()
 

Protected Attributes

std::vector< DtVrfTaskSetMenu * > myPrecreatedMenus
 
- Protected Attributes inherited from makVrf::DtScriptedTaskConfigurableMenu
RecreateFlags myRecreateFlags
 
ScriptedTasks myScriptedTasks
 
bool myEditMode
 
makVrv::DtSignalConnectionManager myConnectionManager
 
DtSubMenuConfiguration myConfiguration
 
DtVrfTaskSetMenumyMenu
 
std::set< std::string > myScriptedTasksAddedToMenuAssember
 
- Protected Attributes inherited from makVrf::DtConfigurableMenu
DtConfigurableMenuAssembler myAssembler
 
DtSubMenuConfiguration myConfiguration
 
bool myInitialized
 
makVrv::DtSignalConnectionManager myConnections
 
- Protected Attributes inherited from makVrv::DtMenu
DtDemyDe
 
std::string myMenuIdName
 

Additional Inherited Members

- Public Types inherited from makVrf::DtScriptedTaskConfigurableMenu
enum  RecreateFlags {
  RecreateNone = 0, RecreateOnScenarioLoad = 0x00000001, RecreateOnScriptedTaskChange = 0x00000002, RecreateToolbars = 0x00000004,
  UseGlobalMenuManager = 0x00000008, RecreateMenuOnSelectionChange = 0x00000010, SkipInitialMenuSetup = 0x00000020, AllowPassThru = 0x00000040
}
 
typedef std::map< std::string,
ScriptedTaskData
ScriptedTasks
 
- Public Attributes inherited from makVrf::DtScriptedTaskConfigurableMenu
boost::signals2::signal< void(DtSubMenuConfiguration &)> signal_preCreateConfiguration
 
boost::signals2::signal< void()> signal_recreateMenu
 
- Public Attributes inherited from makVrf::DtConfigurableMenu
boost::signals2::signal< void(DtConfigurableMenu *)> signal_menuRecreated
 
boost::signals2::signal< void(QAction *)> signal_validateMenuItem
 
- Protected Member Functions inherited from makVrf::DtScriptedTaskConfigurableMenu
virtual void scriptIdChanged (const std::string &oldId, const std::string &newId, int action)
 
virtual bool eventFilter (QObject *o, QEvent *e)
 
virtual void slot_sendTaskRequest (std::vector< DtUUID > names, const DtSimTask &s)
 
virtual void slot_sendSetRequest (std::vector< DtUUID > names, const DtSetDataRequest &s)
 
virtual void menuRecreated ()
 
virtual void clearScriptedTasks ()
 
virtual void scriptedTaskAboutToBeRemoved (std::string id)
 
virtual void scriptedTaskAdded (std::string id)
 
virtual void receivedScriptedTasks ()
 
virtual void clearRegisteredMenuAssemblers ()
 
virtual void clearRegisteredMenuAssembler (const std::string &)
 
virtual void removeAllScriptedTasks (bool signal=true)
 
virtual void removeScriptedTask (const std::string &id, bool signal=true)
 
virtual std::string addScriptedTaskMenuLocation (const std::string &scriptedTaskId, const std::string &potentialPath, const QString &menuName, const QString &extMenuName, const QString &toolTip, DtSubMenuConfiguration &configuration, DtConfigurableMenuAssembler &, bool showInMenu=true, bool addToolbarMenuItems=true, bool useGlobalMenuManager=false)
 
virtual std::string addScriptedTaskToolbarLocation (const std::string &scriptedTaskId, makVrv::DtToolbarConfiguration &configuration)
 
- Protected Member Functions inherited from makVrf::DtConfigurableMenu
virtual void initMenuItems (makVrv::DtDe &de)
 
DtConfigurableMenuAssemblerassembler ()
 
DtSubMenuConfigurationconfiguration ()
 
virtual void createMenuConfiguration (makVrv::DtDe &)
 

Constructor & Destructor Documentation

makVrf::DtTaskMenu::DtTaskMenu ( makVrv::DtDe ,
const std::string &  menuIdName = DtTaskMenuId 
)

CTOR.

virtual makVrf::DtTaskMenu::~DtTaskMenu ( )
virtual

DTOR.

Member Function Documentation

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

Build a menu.

Implements makVrv::DtMenu.

Reimplemented in makVrf::DtRightClickTaskMenu, and makVrf::DtEmbeddedEntityTaskMenu.

static DtTaskMenu& makVrf::DtTaskMenu::instance ( makVrv::DtDe )
static
static DtTaskMenu* makVrf::DtTaskMenu::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 DtTaskMenu* makVrf::DtTaskMenu::newInstance ( )
virtual
virtual int makVrf::DtTaskMenu::supportedScriptType ( int  d) const
virtual
virtual const char* makVrf::DtTaskMenu::supportsToolbarType ( ) const
virtual
virtual void makVrf::DtTaskMenu::giveBackTaskMenu ( DtVrfTaskSetMenu )
virtual

Creating menus is an expensive process, so, if one has been created and then given back with the giveBackTaskMenu will return that one (but set ther new owner and create flags first). Create will only work with precreated menu is menuOwner is nullptr.

virtual DtVrfTaskSetMenu* makVrf::DtTaskMenu::createTaskMenu ( QWidget *  widgetOwner,
QMenuBar *  menuOwner = nullptr,
int  flags = DtScriptedTaskConfigurableMenu::RecreateOnScriptedTaskChange|DtScriptedTaskConfigurableMenu::RecreateMenuOnSelectionChange|DtScriptedTaskConfigurableMenu::SkipInitialMenuSetup 
)
virtual
bool makVrf::DtTaskMenu::hasPrecreatedMenus ( ) const
inline
virtual void makVrf::DtTaskMenu::precreatedMenuDeleted ( )
protectedvirtualslot

Member Data Documentation

std::vector<DtVrfTaskSetMenu*> makVrf::DtTaskMenu::myPrecreatedMenus
protected

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

Document ID: Generated on Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)