src/XGUI/XGUI_ModuleConnector.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        XGUI_ModuleConnector.h
   4 // Created:     3 June 2014
   5 // Author:      Vitaly Smetannikov
   6
   7 #ifndef XGUI_ModuleConnector_H
   8 #define XGUI_ModuleConnector_H
   9
  10 #include "XGUI.h"
  11 #include <ModuleBase_Definitions.h>
  12 #include <ModuleBase_IWorkshop.h>
  13
  14 class Handle_AIS_InteractiveContext;
  15 class XGUI_Workshop;
  16 class XGUI_Displayer;
  17
  18 /**
  19  * \ingroup GUI
  20  * Implementation of IWorkshop interface which provides access to Workshop services at module level
  21  */
  22 class XGUI_EXPORT XGUI_ModuleConnector : public ModuleBase_IWorkshop
  23 {
  24 Q_OBJECT
  25  public:
  26    /// Constructor
  27    /// \param theWorkshop a workshop
  28   XGUI_ModuleConnector(XGUI_Workshop* theWorkshop);
  29
  30   virtual ~XGUI_ModuleConnector();
  31
  32   //! Returns list of currently selected data objects
  33   virtual ModuleBase_ISelection* selection() const;
  34
  35   /// Activate sub-shapes selection (opens local context if it was not opened)
  36   /// Types has to be dined according to TopAbs_ShapeEnum
  37   virtual void activateSubShapesSelection(const QIntList& theTypes);
  38
  39   /// Activate objects in the module selection modes(opens local context)
  40   virtual void activateModuleSelectionModes();
  41
  42   /// Deactivate sub-shapes selection (closes local context)
  43   virtual void deactivateSubShapesSelection();
  44
  45   //! Returns instance of loaded module
  46   virtual ModuleBase_IModule* module() const;
  47
  48   //! Returns current viewer
  49   virtual ModuleBase_IViewer* viewer() const;
  50
  51   //! Returns property panel
  52   virtual ModuleBase_IPropertyPanel* propertyPanel() const;
  53
  54   //! Returns currently active operation
  55   virtual ModuleBase_Operation* currentOperation() const;
  56
  57   //! Returns true if the operation with id theId can be started
  58   virtual bool canStartOperation(QString theId);
  59
  60   //! Performs the operation launch
  61   //! \param theOperation an operation to be launched
  62   virtual void processLaunchOperation(ModuleBase_Operation* theOperation,
  63                                       const bool isUpdatePropertyPanel);
  64
  65   //! Returns started operation by the operation identifier. The operation manager is called.
  66   //! \param theId an operation id
  67   //! \return an operation instance or NULL
  68   virtual ModuleBase_Operation* findStartedOperation(const QString& theId);
  69
  70   //! Returns true if the operation with id theId can be stopped. The operation manager is called.
  71   //! \param theOperation a stopped operation
  72   //! \return boolean result
  73   virtual bool canStopOperation(ModuleBase_Operation* theOperation);
  74
  75   //! Commits if possible or aborts the given operation.
  76   //! \param theOperation an aborted operation
  77   virtual void stopOperation(ModuleBase_Operation* theOperation);
  78
  79   //! Returns AIS object by data object
  80   virtual AISObjectPtr findPresentation(const ObjectPtr& theObject) const;
  81
  82   //! Returns data object by AIS
  83   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const;
  84
  85   //! Select features clearing previous selection.
  86   //! If the list is empty then selection will be cleared
  87   virtual void setSelected(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues);
  88
  89   //! Shows the message in the status bar
  90   //! \param theMessage a message
  91   virtual void setStatusBarMessage(const QString& theMessage);
  92
  93    /// Update of commands status
  94   virtual void updateCommandStatus();
  95
  96   /// Returns Information about feature defined in corresponded XML
  97   /// \param theId - id of the feature
  98   virtual std::shared_ptr<Config_FeatureMessage> featureInfo(const QString& theId) const;
  99
 100   /// Return application main window
 101   virtual QMainWindow* desktop() const;
 102
 103
 104   //! Returns workshop
 105   XGUI_Workshop* workshop() const { return myWorkshop; }
 106
 107 private:
 108   QObjectPtrList activeObjects(const QObjectPtrList& theObjList) const;
 109
 110   /// Reference to workshop
 111   XGUI_Workshop* myWorkshop;
 112 };
 113
 114 #endif