Salome HOME
Merge branch 'Dev_GroupsRevision'
[modules/shaper.git] / src / XGUI / XGUI_SalomeConnector.h
index 7596878a1de0e6eab8fdc382b59c1a6cb0432538..2c19972df35c8f35748590a260dcbd041cad4db7 100644 (file)
@@ -1,4 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef XGUI_SALOMECONNECTOR_H
 #define XGUI_SALOMECONNECTOR_H
@@ -16,7 +34,7 @@ class ModuleBase_IViewer;
 
 /**
  * \ingroup GUI
- * An interface which provides a connection of XGUI functionality 
+ * An interface which provides a connection of XGUI functionality
  * with functionality of SALOME module interface.
  */
 class XGUI_EXPORT XGUI_SalomeConnector
@@ -35,24 +53,29 @@ class XGUI_EXPORT XGUI_SalomeConnector
   //! \param theIcon - icon
   //! \param isCheckable - is checkable or not
   //! \param theKeys - hot keys
+  //! \param isAddSeparator boolean flag about adding separator after the action
   //! returns created action
   virtual QAction* addFeature(const QString& theWBName, const QString& theId,
-                              const QString& theTitle, const QString& theTip, const QIcon& theIcon,
-                              const QKeySequence& theKeys, bool isCheckable) = 0;
+                              const QString& theTitle, const QString& theTip,
+                              const QIcon& theIcon,
+                              const QKeySequence& theKeys, bool isCheckable,
+                              const bool isAddSeparator,
+                              const QString& theStatusTip) = 0;
 
   //! Creates a feature (command) in SALOME desktop
   //! \param theWBName - name of toolbar (workbench)
   //! \param theInfo - information about action (icon, text, etc)
+  //! \param isAddSeparator boolean flag about adding separator after the action
   virtual QAction* addFeature(const QString& theWBName,
-                              const ActionInfo& theInfo) = 0;
+                              const ActionInfo& theInfo, const bool isAddSeparator) = 0;
 
   //! Creates a feature (command) in SALOME desktop
   //! \param theWBName - name of toolbar (workbench)
   //! \param theInfo - information about action (icon, text, etc)
   //! \param theNestedActions a list of nested actions
   virtual QAction* addFeatureOfNested(const QString& theWBName,
-                                    const ActionInfo& theInfo,
-                                    const QList<QAction*>& theNestedActions) = 0;
+                                      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 addFeatureOfNested().
@@ -85,21 +108,15 @@ class XGUI_EXPORT XGUI_SalomeConnector
   /// \param theToolBarTitle the toolbar name
   virtual bool addActionInToolbar( QAction* theAction, const QString& theToolBarTitle ) = 0;
 
+  /// Creates menu/tool bar actions for loaded features stored in the menu manager
+  virtual void createFeatureActions() = 0;
+
   //! Returns desktop window of SALOME
   virtual QMainWindow* desktop() const = 0;
 
-  //! Returns command string Id by QAction instance
-  virtual QString commandId(const QAction* theCmd) const = 0;
-
-  //! Returns QAction instance by command string Id
-  virtual QAction* command(const QString& theId) const = 0;
-
   //! Returns list of defined actions (just by SHAPER module)
   virtual QList<QAction*> commandList() const = 0;
 
-  //! Returns list of Ids of defined actions (just by NewGeom module)
-  virtual QStringList commandIdList() const = 0;
-
   //! Stores XML information for the feature kind
   //! \param theFeatureId a feature kind
   //! \param theMessage a container of the feature XML properties
@@ -116,6 +133,12 @@ class XGUI_EXPORT XGUI_SalomeConnector
 
   //! Create preferences
   virtual void createPreferences() = 0;
+
+  //! Shows the given text in status bar as a permanent text
+  //! \theInfo a string value
+  //! \theMsecs interval of msec milliseconds when the message will be hidden, if -1, it stays.
+  //            If 0, default value is used, it is 3000
+  virtual void putInfo(const QString& theInfo, const int theMSecs = 0) = 0;
 };
 
 #endif