VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Types
makVrf::DtVrfTaskSetDialogManager Class Reference

The Master Scenario Settings Dialog. More...

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

Public Member Functions

 DtVrfTaskSetDialogManager (makVrv::DtDe &)
 CTOR. Registers all known dialogs with manager.
virtual ~DtVrfTaskSetDialogManager ()
 DTOR.
virtual bool processDialogFor (int menuItemType, QWidget *parent, DtVrfTaskSetAction *forAction, const std::vector< makVrv::DtSimEntry * > &data, bool partOfPlan=false)
 Creates dialog and then sends out various signals at creation process to allow user to add functionality.
virtual
DtCommandAssignmentWidgetInterface
processCommandActionDialog (int menuItemType, QWidget *parent, DtVrfTaskSetAction *forAction, const std::vector< makVrv::DtSimEntry * > &data, bool partOfPlan=false)
 Creates a command assignment widget but does not connect it to anything (other than the destruction of the dialog).
bool dialogInProgress () const
virtual int nextAvailableId () const
 Starting at the user menu start item, return the next available id.
virtual void addTaskDialogCreator (int menuItemType, DtVrfTaskDialogCreator *)
 Adds items into the factory.
virtual void addSetDialogCreator (int menuItemType, DtVrfSetDialogCreator *)
virtual bool removeTaskDialogCreator (int menuItemType)
 Removes the dialog creator, effectively disabling the task/set menu item. Returns true if removed.
virtual bool removeSetDialogCreator (int menuItemType)
virtual bool hasTaskDialogCreator (int menuItemType)
 Returns true if the dialog has a creator.
virtual bool hasSetDialogCreator (int menuItemType)
virtual void removeAllDialogCreators ()
 Removes all dialog creators.
virtual bool statementIsEditable (const DtSimStatement *) const
 Returns true if statement is editable.
virtual DtTaskSetDialogInterfacecreateDialogFor (const DtSimTaskMessageType &type, const DtSimStatement *stmt, QWidget *parent, bool registerDialog=true)
 Creates a dialog, connects signals, and returns the pointer.
virtual DtTaskSetDialogInterfacecreateDialogFor (const DtSetMessageType &type, const DtSimStatement *stmt, QWidget *parent, bool registerDialog=true)
virtual DtTaskSetDialogInterfacecreateDialogFor (const DtSimStatement *stmt, QWidget *parent, bool registerDialog=true)
virtual
DtCommandAssignmentWidgetInterface
createCommandDialogFor (const DtSimStatement *stmt, QWidget *parent)
 Creates a command dialog, connects signals and returns the pointer.
virtual
DtCommandAssignmentWidgetInterface
createCommandDialogFor (int menuItemType, QWidget *parent)
virtual DtSimTaskMessageType taskTypeFromStatement (const DtSimStatement *stmt) const
 Returns the type based on the sim statement.
virtual DtSetMessageType setTypeFromStatement (const DtSimStatement *stmt) const
virtual
DtCommandAssignmentWidgetInterface
createCommandActionDialog (QWidget *, DtCommandDialogExtensionInterface *)
 Creates command action dialog. Override to create your own instance.
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 Do nothing constructor.
virtual ~DtVirtualBaseClass ()
 Virtual do nothing destructor.

Static Public Member Functions

static DtVrfTaskSetDialogManagerinstance (makVrv::DtDe &de)
 Returns instance of the messager.

Public Attributes

boost::signal< void(DtTaskSetDialogInterface *)> signal_dialogCreated
 Signal sent when the dialog is created but before it is run.
boost::signal< void(DtCommandAssignmentWidgetInterface *)> signal_commandDialogCreated
 Signal sent when the dialog is created but before it is run.
boost::signal< void(DtCommandAssignmentWidget *)> signal_commandDialogDestroyed
 Signal sent when the dialog is destroyed.
boost::signal< void(DtTaskSetDialogInterface *)> signal_dialogDestroyed
 Signal sent when the dialog is destroyed.

Protected Member Functions

virtual void slot_onDialogDestroyed (DtTaskSetDialogInterface *)
virtual void slot_onCommandDialogDestroyed (DtCommandAssignmentWidget *)
virtual void prepDialog (DtTaskSetDialogInterface *, DtVrfTaskSetAction *forAction, bool partOfPlan)
 Emits signals about dialog state and makes connections on dialog to allow for task/set activation.
virtual void prepDialog (DtCommandAssignmentWidgetInterface *, DtVrfTaskSetAction *forAction, bool partOfPlan)
virtual void slot_scriptAddedToTaskMenu (int, std::string)
 Called when a new scripted task is added. Set up dialog creator.
virtual void slot_scriptRemovedFromTaskMenu (int, std::string)
 Called when a new scripted task is removed. Remove dialog creator.

Protected Attributes

makVrv::DtDemyDe
DtVrfTaskDialogCreatorMap myTaskDialogCreatorMap
DtVrfSetDialogCreatorMap mySetDialogCreatorMap
DtVrfTaskSetDialogSignalHandler myTaskSetDialogSignalHandler
bool myDialogInProgress

Private Types

typedef std::map< int,
DtVrfTaskDialogCreator * > 
DtVrfTaskDialogCreatorMap
typedef std::map< int,
DtVrfSetDialogCreator * > 
DtVrfSetDialogCreatorMap

Detailed Description

The Master Scenario Settings Dialog.

Member Typedef Documentation

Constructor & Destructor Documentation

makVrf::DtVrfTaskSetDialogManager::DtVrfTaskSetDialogManager ( makVrv::DtDe )

CTOR. Registers all known dialogs with manager.

virtual makVrf::DtVrfTaskSetDialogManager::~DtVrfTaskSetDialogManager ( )
virtual

DTOR.

Member Function Documentation

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

Returns instance of the messager.

virtual bool makVrf::DtVrfTaskSetDialogManager::processDialogFor ( int  menuItemType,
QWidget parent,
DtVrfTaskSetAction forAction,
const std::vector< makVrv::DtSimEntry * > &  data,
bool  partOfPlan = false 
)
virtual

Creates dialog and then sends out various signals at creation process to allow user to add functionality.

Connects to slot in the action to process the resulting task/set request for the dialog

virtual DtCommandAssignmentWidgetInterface* makVrf::DtVrfTaskSetDialogManager::processCommandActionDialog ( int  menuItemType,
QWidget parent,
DtVrfTaskSetAction forAction,
const std::vector< makVrv::DtSimEntry * > &  data,
bool  partOfPlan = false 
)
virtual

Creates a command assignment widget but does not connect it to anything (other than the destruction of the dialog).

It is up to the caller of this function to assign functionality to the signals emitted by the dialog

bool makVrf::DtVrfTaskSetDialogManager::dialogInProgress ( ) const
inline
virtual int makVrf::DtVrfTaskSetDialogManager::nextAvailableId ( ) const
virtual

Starting at the user menu start item, return the next available id.

Call this to add items from a plugin to figure out a unique id

virtual void makVrf::DtVrfTaskSetDialogManager::addTaskDialogCreator ( int  menuItemType,
DtVrfTaskDialogCreator  
)
virtual

Adds items into the factory.

The memory will be taked as owned by the factory. The pattern should be passing in a subclass of DtVrfTaskSetDialogCreator and implementing the create(QWidget*) method

virtual void makVrf::DtVrfTaskSetDialogManager::addSetDialogCreator ( int  menuItemType,
DtVrfSetDialogCreator  
)
virtual
virtual bool makVrf::DtVrfTaskSetDialogManager::removeTaskDialogCreator ( int  menuItemType)
virtual

Removes the dialog creator, effectively disabling the task/set menu item. Returns true if removed.

virtual bool makVrf::DtVrfTaskSetDialogManager::removeSetDialogCreator ( int  menuItemType)
virtual
virtual bool makVrf::DtVrfTaskSetDialogManager::hasTaskDialogCreator ( int  menuItemType)
virtual

Returns true if the dialog has a creator.

virtual bool makVrf::DtVrfTaskSetDialogManager::hasSetDialogCreator ( int  menuItemType)
virtual
virtual void makVrf::DtVrfTaskSetDialogManager::removeAllDialogCreators ( )
virtual

Removes all dialog creators.

virtual bool makVrf::DtVrfTaskSetDialogManager::statementIsEditable ( const DtSimStatement ) const
virtual

Returns true if statement is editable.

virtual DtTaskSetDialogInterface* makVrf::DtVrfTaskSetDialogManager::createDialogFor ( const DtSimTaskMessageType type,
const DtSimStatement stmt,
QWidget parent,
bool  registerDialog = true 
)
virtual

Creates a dialog, connects signals, and returns the pointer.

Call run() to start execution of dialog. The type is the task or set statement type

virtual DtTaskSetDialogInterface* makVrf::DtVrfTaskSetDialogManager::createDialogFor ( const DtSetMessageType type,
const DtSimStatement stmt,
QWidget parent,
bool  registerDialog = true 
)
virtual
virtual DtTaskSetDialogInterface* makVrf::DtVrfTaskSetDialogManager::createDialogFor ( const DtSimStatement stmt,
QWidget parent,
bool  registerDialog = true 
)
virtual
virtual DtCommandAssignmentWidgetInterface* makVrf::DtVrfTaskSetDialogManager::createCommandDialogFor ( const DtSimStatement stmt,
QWidget parent 
)
virtual

Creates a command dialog, connects signals and returns the pointer.

virtual DtCommandAssignmentWidgetInterface* makVrf::DtVrfTaskSetDialogManager::createCommandDialogFor ( int  menuItemType,
QWidget parent 
)
virtual
virtual DtSimTaskMessageType makVrf::DtVrfTaskSetDialogManager::taskTypeFromStatement ( const DtSimStatement stmt) const
virtual

Returns the type based on the sim statement.

virtual DtSetMessageType makVrf::DtVrfTaskSetDialogManager::setTypeFromStatement ( const DtSimStatement stmt) const
virtual
virtual DtCommandAssignmentWidgetInterface* makVrf::DtVrfTaskSetDialogManager::createCommandActionDialog ( QWidget ,
DtCommandDialogExtensionInterface  
)
virtual

Creates command action dialog. Override to create your own instance.

virtual void makVrf::DtVrfTaskSetDialogManager::slot_onDialogDestroyed ( DtTaskSetDialogInterface )
protectedvirtual
virtual void makVrf::DtVrfTaskSetDialogManager::slot_onCommandDialogDestroyed ( DtCommandAssignmentWidget )
protectedvirtual
virtual void makVrf::DtVrfTaskSetDialogManager::prepDialog ( DtTaskSetDialogInterface ,
DtVrfTaskSetAction forAction,
bool  partOfPlan 
)
protectedvirtual

Emits signals about dialog state and makes connections on dialog to allow for task/set activation.

virtual void makVrf::DtVrfTaskSetDialogManager::prepDialog ( DtCommandAssignmentWidgetInterface ,
DtVrfTaskSetAction forAction,
bool  partOfPlan 
)
protectedvirtual
virtual void makVrf::DtVrfTaskSetDialogManager::slot_scriptAddedToTaskMenu ( int  ,
std::string   
)
protectedvirtual

Called when a new scripted task is added. Set up dialog creator.

virtual void makVrf::DtVrfTaskSetDialogManager::slot_scriptRemovedFromTaskMenu ( int  ,
std::string   
)
protectedvirtual

Called when a new scripted task is removed. Remove dialog creator.

Member Data Documentation

boost::signal<void (DtTaskSetDialogInterface*)> makVrf::DtVrfTaskSetDialogManager::signal_dialogCreated

Signal sent when the dialog is created but before it is run.

boost::signal<void (DtCommandAssignmentWidgetInterface*)> makVrf::DtVrfTaskSetDialogManager::signal_commandDialogCreated

Signal sent when the dialog is created but before it is run.

boost::signal<void (DtCommandAssignmentWidget*)> makVrf::DtVrfTaskSetDialogManager::signal_commandDialogDestroyed

Signal sent when the dialog is destroyed.

boost::signal<void (DtTaskSetDialogInterface*)> makVrf::DtVrfTaskSetDialogManager::signal_dialogDestroyed

Signal sent when the dialog is destroyed.

makVrv::DtDe& makVrf::DtVrfTaskSetDialogManager::myDe
protected
DtVrfTaskDialogCreatorMap makVrf::DtVrfTaskSetDialogManager::myTaskDialogCreatorMap
protected
DtVrfSetDialogCreatorMap makVrf::DtVrfTaskSetDialogManager::mySetDialogCreatorMap
protected
DtVrfTaskSetDialogSignalHandler makVrf::DtVrfTaskSetDialogManager::myTaskSetDialogSignalHandler
protected
bool makVrf::DtVrfTaskSetDialogManager::myDialogInProgress
protected

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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)