Workspace 6.21.5
Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
WorkflowToolsPluginMenu Class Reference

Provides a custom menu for the plugin CSIRO::Tools::WorkflowToolsPlugin within the Workspace editor.

#include <Tools/workflowtoolspluginmenu.h>

Inheritance diagram for WorkflowToolsPluginMenu:
[legend]

Public Slots

void onCurrentWorkflowChanged (const QString &workflowFileName) override
 
void runAnalyseWorkflowStructure ()
 
void startWorkspaceAnalyseApp ()
 
- Public Slots inherited from PluginMenu
virtual void onCurrentWorkflowChanged (const QString &workflowFileName)
 

Public Member Functions

 WorkflowToolsPluginMenu ()
 
 ~WorkflowToolsPluginMenu () override
 
void createMenu () override
 Menu to provide links to workflow tools like workflow-analyse.
 
void destroy () override
 
QString getMenuName () const override
 
bool isTopLevelMenu () const override
 Returns true if the menu is to be directly inserted into the application's main menu bar.
 
- Public Member Functions inherited from PluginMenu
virtual void createMenu ()=0
 Here is where the menu items are created and connections made.
 
virtual void destroy ()=0
 
virtual QMenu * getMenu ()
 This returns a pointer to the main plugin menu.
 
virtual QString getMenuName () const =0
 
virtual bool isTopLevelMenu () const
 Returns true if the menu is to be directly inserted into the application's main menu bar.
 

Protected Member Functions

void addExternalWorkflowDock ()
 
- Protected Member Functions inherited from PluginMenu
 PluginMenu ()
 
 ~PluginMenu () override=default
 
QMainWindow * applicationWindow ()
 Returns a pointer to the main application window.
 

Protected Attributes

std::unique_ptr< DockManagerdockManager_
 
- Protected Attributes inherited from PluginMenu
QString currentWorkflow_
 
std::unique_ptr< QMenu > mainMenu_
 

Additional Inherited Members

- Signals inherited from PluginMenu
void openWorkflow (const QString &filePath)
 Sends a request to the Workspace editor to open a new workflow.
 

Constructor & Destructor Documentation

◆ WorkflowToolsPluginMenu()

Creates a menu which is inserted into the menu bar of the Workspace editor.

◆ ~WorkflowToolsPluginMenu()

~WorkflowToolsPluginMenu ( )
overridedefault

Member Function Documentation

◆ addExternalWorkflowDock()

void addExternalWorkflowDock ( )
protected

◆ createMenu()

void createMenu ( )
overridevirtual

Implements PluginMenu.

◆ destroy()

void destroy ( )
overridevirtual

Subclasses will almost always implement this function simply as a call to the delete operator, or to some kind of factory singleton which does this. Since PluginMenu subclass objects are usually instantiated by a singleton within the plugin, the destroy() function is necessary to ensure that the plugin also deletes instances.

Implements PluginMenu.

◆ getMenuName()

QString getMenuName ( ) const
overridevirtual
Returns
You must implement this and supply a title for your menu.

Implements PluginMenu.

◆ isTopLevelMenu()

bool isTopLevelMenu ( ) const
overridevirtual

The menu can be either directly inserted into the main menu bar or inserted as a submenu into a "Plugins" menu. The base class implementation returns true: override this to return false

Reimplemented from PluginMenu.

◆ onCurrentWorkflowChanged

void onCurrentWorkflowChanged ( const QString &  workflowFileName)
overrideslot

◆ runAnalyseWorkflowStructure

void runAnalyseWorkflowStructure ( )
slot

◆ startWorkspaceAnalyseApp

void startWorkspaceAnalyseApp ( )
slot

Member Data Documentation

◆ dockManager_

std::unique_ptr<DockManager> dockManager_
protected