VR-Forces 4.8 Class Documentation
 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
makVrf::DtTaskMenu Class Reference

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

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

Public Member Functions

 DtTaskMenu (makVrv::DtDe &, const std::string &menuIdName=DtTaskMenuId)
 CTOR. More...
 
virtual ~DtTaskMenu ()
 DTOR. More...
 
virtual QMenucreateMenu (makVrv::DtDe &, QWidget *parent)
 Build a menu. More...
 
virtual DtTaskMenunewInstance ()
 
virtual int supportedScriptType (int d) const
 
virtual const charsupportsToolbarType () const
 
virtual DtVrfTaskSetMenucreateTaskMenu (QWidget *widgetOwner, QMenuBar *menuOwner=0, int flags=DtScriptedTaskConfigurableMenu::RecreateOnScriptedTaskChange|DtScriptedTaskConfigurableMenu::RecreateMenuOnSelectionChange|DtScriptedTaskConfigurableMenu::SkipInitialMenuSetup)
 
- Public Member Functions inherited from makVrf::DtScriptedTaskConfigurableMenu
 DtScriptedTaskConfigurableMenu (makVrv::DtDe &, const std::string &menuIdName)
 CTOR. More...
 
virtual ~DtScriptedTaskConfigurableMenu ()
 DTOR. More...
 
virtual void setEditMode (bool)
 If in edit mode shows all scripted task items regardless of show in menu status. Default is false. More...
 
virtual bool editMode () const
 
virtual void setRecreateFlags (RecreateFlags)
 If true will respond to recreate message. Default is false. More...
 
virtual void addScriptedTask (const DtScriptedTaskMetaData &, bool signal=true)
 
virtual void addScriptedTasks (DtSubMenuConfiguration &, makVrv::DtToolbarConfiguration &, DtConfigurableMenuAssembler &, bool addToolbarMenuItems=true, bool useGlobalMenuManager=false)
 Adds the scripted tasks into the supplied configuration. More...
 
virtual void setScriptedTasks (const ScriptedTasks &, bool signal=true)
 Sets/gets the scripted tasks to use with this task menu. More...
 
virtual const ScriptedTasksscriptedTasks () const
 
virtual void setMenuConfiguration (const DtSubMenuConfiguration &)
 If set use this instead of the default task menu configuration. More...
 
DtVrfTaskSetMenumenu ()
 
- Public Member Functions inherited from makVrf::DtConfigurableMenu
 DtConfigurableMenu (makVrv::DtDe &, const std::string &className)
 CTOR. More...
 
virtual ~DtConfigurableMenu ()
 DTOR. More...
 
virtual DtSubMenuConfigurationmenuConfiguration ()
 Returns the configuration for the menu to be used. May be effected directly. More...
 
virtual
DtConfigurableMenuAssembler
menuAssembler ()
 Returns the assembler for the menu to be used. May be effected directly. More...
 
virtual void registerMenu (makVrv::DtMenu *customMenu)
 Use to register your own complex menu object. More...
 
virtual void registerMenuItem (makVrv::DtMenuItem *customMenuItem)
 Use to register your own complex menu item object. More...
 
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. More...
 
virtual void mergeMenu (makVrv::DtQtMenuAssembler &assembler)
 Merges in the assembler into the supplied assembler. More...
 
virtual void mergeMenu (makVrv::DtMenuConfiguration &configuration)
 Merges in the configuration into the supplied configuration. This merges all the menu paths together. More...
 
- Public Member Functions inherited from makVrv::DtMenu
 DtMenu (DtDe &de, const std::string &menuIdName)
 CTOR. More...
 
virtual ~DtMenu ()
 DTOR. More...
 
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. More...
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor. More...
 
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor. More...
 

Static Public Member Functions

static DtTaskMenuinstance (makVrv::DtDe &)
 
static DtTaskMenumenuInstance (makVrv::DtDe &)
 Return a new copy, not the registered copy. More...
 
- 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)
 

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
}
 
typedef std::map< std::string,
ScriptedTaskData
ScriptedTasks
 
- Public Attributes inherited from makVrf::DtScriptedTaskConfigurableMenu
boost::signals2::signal< void(DtSubMenuConfiguration &)> signal_preCreateConfiguration
 Signal sent right before menu is configured. More...
 
boost::signals2::signal< void()> signal_recreateMenu
 Sent when the task menus need to be recreated because menu configuration has changed. More...
 
- Public Attributes inherited from makVrf::DtConfigurableMenu
boost::signals2::signal< void(DtConfigurableMenu *)> signal_menuRecreated
 Signal sent when this menu is recreated from it's original creation. More...
 
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)
 This could get added if it is not shown in the menu if it is show in the toolbar. More...
 
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 &)
 Creates the menu configuration by creating the assembler and adding menu items. More...
 
- 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
 

Detailed Description

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

Examples

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

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)