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

Container class that will create instances of scripted task configurable menu. More...

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

Classes

struct  ScriptedTaskData

Public Types

enum  RecreateFlags {
  RecreateNone = 0, RecreateOnScenarioLoad = 0x00000001, RecreateOnScriptedTaskChange = 0x00000002, RecreateToolbars = 0x00000004,
  UseGlobalMenuManager = 0x00000008, RecreateMenuOnSelectionChange = 0x00000010, SkipInitialMenuSetup = 0x00000020
}
typedef std::map< std::string,
ScriptedTaskData > 		ScriptedTasks

Public Member Functions

 DtScriptedTaskConfigurableMenu (makVrv::DtDe &, const std::string &menuIdName)
 CTOR.
virtual ~DtScriptedTaskConfigurableMenu ()
 DTOR.
virtual void setEditMode (bool)
 If in edit mode shows all scripted task items regardless of show in menu status. Default is false.
virtual bool editMode () const
virtual void setRecreateFlags (RecreateFlags)
 If true will respond to recreate message. Default is false.
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.
virtual void setScriptedTasks (const ScriptedTasks &, bool signal=true)
 Sets/gets the scripted tasks to use with this task menu.
virtual const ScriptedTasks & scriptedTasks () const
virtual void setMenuConfiguration (const DtSubMenuConfiguration &)
 If set use this instead of the default task menu configuration.
virtual int supportedScriptType (int type) const =0
virtual const char * supportsToolbarType () const =0
DtVrfTaskSetMenu * menu ()
- Public Member Functions inherited from makVrf::DtConfigurableMenu
 DtConfigurableMenu (makVrv::DtDe &, const std::string &className)
 CTOR.
virtual ~DtConfigurableMenu ()
 DTOR.
virtual DtSubMenuConfiguration & menuConfiguration ()
 Returns the configuration for the menu to be used. May be effected directly.
virtual
DtConfigurableMenuAssembler & 		menuAssembler ()
 Returns the assembler for the menu to be used. May be effected directly.
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.
virtual QMenu * createMenu (DtDe &, QWidget *parent)=0
 Build a menu.
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Public Attributes

boost::signal< void(DtSubMenuConfiguration &)> signal_preCreateConfiguration
 Signal sent right before menu is configured.
boost::signal< void()> signal_recreateMenu
 Sent when the task menus need to be recreated because menu configuration has changed.
- 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

Protected Member Functions

virtual void scriptIdChanged (const std::string &oldId, const std::string &newId, int action)
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.
virtual std::string addScriptedTaskToolbarLocation (const std::string &scriptedTaskId, makVrv::DtToolbarConfiguration &configuration)
- Protected Member Functions inherited from makVrf::DtConfigurableMenu
virtual void initMenuItems (makVrv::DtDe &de)
DtConfigurableMenuAssembler & assembler ()
DtSubMenuConfiguration & configuration ()
virtual void createMenuConfiguration (makVrv::DtDe &)
 Creates the menu configuration by creating the assembler and adding menu items.

Protected Attributes

RecreateFlags myRecreateFlags
ScriptedTasks myScriptedTasks
bool myEditMode
makVrv::DtSignalConnectionManager myConnectionManager
DtSubMenuConfiguration myConfiguration
DtVrfTaskSetMenu * myMenu
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
DtDe & myDe
std::string myMenuIdName

Additional Inherited Members

- 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)

Detailed Description

Container class that will create instances of scripted task configurable menu.

Examples

Member Typedef Documentation

typedef std::map<std::string, ScriptedTaskData> makVrf::DtScriptedTaskConfigurableMenu::ScriptedTasks

Member Enumeration Documentation

enum makVrf::DtScriptedTaskConfigurableMenu::RecreateFlags
Enumerator:
RecreateNone 
RecreateOnScenarioLoad 
RecreateOnScriptedTaskChange 
RecreateToolbars 
UseGlobalMenuManager 
RecreateMenuOnSelectionChange 
SkipInitialMenuSetup 

Constructor & Destructor Documentation

makVrf::DtScriptedTaskConfigurableMenu::DtScriptedTaskConfigurableMenu ( makVrv::DtDe &  ,
const std::string &  menuIdName 
)

CTOR.

virtual makVrf::DtScriptedTaskConfigurableMenu::~DtScriptedTaskConfigurableMenu ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtScriptedTaskConfigurableMenu::setEditMode ( bool  )
virtual

If in edit mode shows all scripted task items regardless of show in menu status. Default is false.

virtual bool makVrf::DtScriptedTaskConfigurableMenu::editMode ( ) const
virtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::setRecreateFlags ( RecreateFlags  )
virtual

If true will respond to recreate message. Default is false.

virtual void makVrf::DtScriptedTaskConfigurableMenu::addScriptedTask ( const DtScriptedTaskMetaData &  ,
bool  signal = true 
)
virtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::addScriptedTasks ( DtSubMenuConfiguration &  ,
makVrv::DtToolbarConfiguration &  ,
DtConfigurableMenuAssembler &  ,
bool  addToolbarMenuItems = true,
bool  useGlobalMenuManager = false 
)
virtual

Adds the scripted tasks into the supplied configuration.

virtual void makVrf::DtScriptedTaskConfigurableMenu::setScriptedTasks ( const ScriptedTasks &  ,
bool  signal = true 
)
virtual

Sets/gets the scripted tasks to use with this task menu.

If signal is true signal to recreate menu

virtual const ScriptedTasks& makVrf::DtScriptedTaskConfigurableMenu::scriptedTasks ( ) const
virtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::setMenuConfiguration ( const DtSubMenuConfiguration &  )
virtual

If set use this instead of the default task menu configuration.

virtual int makVrf::DtScriptedTaskConfigurableMenu::supportedScriptType ( int  type) const
pure virtual

Implemented in makVrf::DtSetMenu, and makVrf::DtTaskMenu.

virtual const char* makVrf::DtScriptedTaskConfigurableMenu::supportsToolbarType ( ) const
pure virtual

Implemented in makVrf::DtSetMenu, and makVrf::DtTaskMenu.

DtVrfTaskSetMenu* makVrf::DtScriptedTaskConfigurableMenu::menu ( )
inline
virtual void makVrf::DtScriptedTaskConfigurableMenu::scriptIdChanged ( const std::string &  oldId,
const std::string &  newId,
int  action 
)
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::menuRecreated ( )
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::clearScriptedTasks ( )
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::scriptedTaskAboutToBeRemoved ( std::string  id)
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::scriptedTaskAdded ( std::string  id)
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::receivedScriptedTasks ( )
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::clearRegisteredMenuAssemblers ( )
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::clearRegisteredMenuAssembler ( const std::string &  )
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::removeAllScriptedTasks ( bool  signal = true)
protectedvirtual
virtual void makVrf::DtScriptedTaskConfigurableMenu::removeScriptedTask ( const std::string &  id,
bool  signal = true 
)
protectedvirtual
virtual std::string makVrf::DtScriptedTaskConfigurableMenu::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 
)
protectedvirtual

This could get added if it is not shown in the menu if it is show in the toolbar.

If the last variable is false do not register toolbar items to be created. This should only be set to true for the main task menu

virtual std::string makVrf::DtScriptedTaskConfigurableMenu::addScriptedTaskToolbarLocation ( const std::string &  scriptedTaskId,
makVrv::DtToolbarConfiguration &  configuration 
)
protectedvirtual

Member Data Documentation

boost::signal<void (DtSubMenuConfiguration&)> makVrf::DtScriptedTaskConfigurableMenu::signal_preCreateConfiguration

Signal sent right before menu is configured.

boost::signal<void ()> makVrf::DtScriptedTaskConfigurableMenu::signal_recreateMenu

Sent when the task menus need to be recreated because menu configuration has changed.

RecreateFlags makVrf::DtScriptedTaskConfigurableMenu::myRecreateFlags
protected
ScriptedTasks makVrf::DtScriptedTaskConfigurableMenu::myScriptedTasks
protected
bool makVrf::DtScriptedTaskConfigurableMenu::myEditMode
protected
makVrv::DtSignalConnectionManager makVrf::DtScriptedTaskConfigurableMenu::myConnectionManager
protected
DtSubMenuConfiguration makVrf::DtScriptedTaskConfigurableMenu::myConfiguration
protected
DtVrfTaskSetMenu* makVrf::DtScriptedTaskConfigurableMenu::myMenu
protected
std::set<std::string> makVrf::DtScriptedTaskConfigurableMenu::myScriptedTasksAddedToMenuAssember
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)