refs #821: correct orientation of the viewer after the plane selection

[modules/shaper.git] / src / XGUI / XGUI_SalomeConnector.h

diff --git a/src/XGUI/XGUI_SalomeConnector.h b/src/XGUI/XGUI_SalomeConnector.h
index 0055714b73e4078e6898804484a0bd727e4d6ad9..910aaa2495e1d921dc386afbfeb39e6e66673854 100644 (file)
--- a/src/XGUI/XGUI_SalomeConnector.h
+++ b/src/XGUI/XGUI_SalomeConnector.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 #ifndef XGUI_SALOMECONNECTOR_H
 #define XGUI_SALOMECONNECTOR_H
 
@@ -6,16 +8,24 @@
 #include <QString>
 #include <QStringList>
 
+#include <ModuleBase_ActionInfo.h>
+
 class QMainWindow;
-class XGUI_SalomeViewer;
+class ModuleBase_IViewer;
 
 /**
+ * \ingroup GUI
  * An interface which provides a connection of XGUI functionality 
  * with functionality of SALOME module interface.
  */
 class XGUI_EXPORT XGUI_SalomeConnector
 {
  public:
+  /// Default constructor
+  XGUI_SalomeConnector();
+  /// Virtual destructor
+  virtual ~XGUI_SalomeConnector();
+
   //! Creates a feature (command) in SALOME desktop
   //! \param theWBName - a workbench name
   //! \param theId - an id of the feature
@@ -29,6 +39,25 @@ class XGUI_EXPORT XGUI_SalomeConnector
                               const QString& theTitle, const QString& theTip, const QIcon& theIcon,
                               const QKeySequence& theKeys, bool isCheckable) = 0;
 
+  //! Creates a feature (command) in SALOME desktop
+  //! \param theWBName - name of toolbar (workbench)
+  //! \param theInfo - information about action (icon, text, etc)
+  virtual QAction* addFeature(const QString& theWBName,
+                              const ActionInfo& theInfo) = 0;
+
+  //! Creates a feature (command) in SALOME desktop
+  //! \param theWBName - name of toolbar (workbench)
+  //! \param theInfo - information about action (icon, text, etc)
+  virtual QAction* addNestedFeature(const QString& theWBName,
+                                    const ActionInfo& theInfo,
+                                    const QList<QAction*>& theNestedActions) = 0;
+
+  //! Returns true if the feature action is a nested action, in other words,
+  //! it is created by addNestedFeature().
+  //! \param theId - an action of a feature
+  //! returns boolean result
+  virtual bool isNestedFeature(const QAction* theAction) = 0;
+
   //! Creates a command in Edit menu of SALOME desktop
   //! \param theId - an id of the feature
   //! \param theTitle - a menu item string
@@ -36,13 +65,20 @@ class XGUI_EXPORT XGUI_SalomeConnector
   //! \param theIcon - icon
   //! \param isCheckable - is checkable or not
   //! \param theKeys - hot keys
+  //! \param theMenuSourceText - a source text of the desktop menu
+  //! \param theMenuPosition - a position of the command in the desktop menu
   //! returns created action
-  virtual QAction* addEditCommand(const QString& theId, const QString& theTitle,
-                                  const QString& theTip, const QIcon& theIcon,
-                                  const QKeySequence& theKeys, bool isCheckable) = 0;
+  virtual QAction* addDesktopCommand(const QString& theId, const QString& theTitle,
+                                     const QString& theTip, const QIcon& theIcon,
+                                     const QKeySequence& theKeys, bool isCheckable,
+                                     const char* theMenuSourceText,
+                                     const int theMenuPosition = 10) = 0;
 
   //! Insert separator into Edit menu of SALOME desktop
-  virtual void addEditMenuSeparator() = 0;
+  virtual void addDesktopMenuSeparator(const char* theMenuSourceText,
+                                       const int theMenuPosition = 10) = 0;
+
+  virtual bool addActionInToolbar( QAction* theAction, const QString& theToolBarTitle ) = 0;
 
   //! Returns desktop window of SALOME
   virtual QMainWindow* desktop() const = 0;
@@ -67,9 +103,18 @@ class XGUI_EXPORT XGUI_SalomeConnector
   //! Returns list of nested actions according to the given command ID
   virtual QStringList nestedActions(const QString& theId) const = 0;
 
+  //! Set the document kind of the action by the given command Id
+  //! \param theId - the command ID
+  //! \param theKind - the document kind
+  virtual void setDocumentKind(const QString& theId, const QString& theKind) = 0;
+
+  //! Returns the document kind of the action by the given command ID
+  virtual QString documentKind(const QString& theId) const = 0;
+
   //! Returns interface to Salome viewer
-  virtual XGUI_SalomeViewer* viewer() const = 0;
+  virtual ModuleBase_IViewer* viewer() const = 0;
 
+  //! Create preferences
   virtual void createPreferences() = 0;
 };