X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FXGUI%2FXGUI_SalomeConnector.h;h=50c622f018e2aee23e24dd3d9df5f219e2904c9d;hb=327f5bbd915fb32d21f2e524a8d97536e0e5dd4b;hp=6418cdf463f7038189628161aad31cc9c271eca6;hpb=de072782c67b5ed9db59be608e17a549912438aa;p=modules%2Fshaper.git diff --git a/src/XGUI/XGUI_SalomeConnector.h b/src/XGUI/XGUI_SalomeConnector.h index 6418cdf46..50c622f01 100644 --- a/src/XGUI/XGUI_SalomeConnector.h +++ b/src/XGUI/XGUI_SalomeConnector.h @@ -1,20 +1,31 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D --> + #ifndef XGUI_SALOMECONNECTOR_H #define XGUI_SALOMECONNECTOR_H #include "XGUI.h" -#include #include +#include + +#include class QMainWindow; +class ModuleBase_IViewer; /** -* An interface which provides a connection of XGUI functionality -* with functionality of SALOME module interface. -*/ + * \ingroup GUI + * An interface which provides a connection of XGUI functionality + * with functionality of SALOME module interface. + */ class XGUI_EXPORT XGUI_SalomeConnector { -public: + 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 @@ -22,18 +33,31 @@ public: //! \param theTip - a tooltip string (help) //! \param theIcon - icon //! \param isCheckable - is checkable or not - //! \param reciever - QObject which will react on the command call - //! \param member - a method of receiver which will be called on the command //! \param theKeys - hot keys - virtual void addFeature(const QString& theWBName, - const QString& theId, - const QString& theTitle, - const QString& theTip, - const QIcon& theIcon, - bool isCheckable, - QObject* reciever, - const char* member, - const QKeySequence& theKeys) = 0; + //! 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; + + //! 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) + //! \param theNestedActions a list of nested actions + virtual QAction* addFeatureOfNested(const QString& theWBName, + const ActionInfo& theInfo, + const QList& theNestedActions) = 0; + + //! Returns true if the feature action is a nested action, in other words, + //! it is created by addFeatureOfNested(). + //! \param theAction - an action of a feature + //! returns boolean result + virtual bool isFeatureOfNested(const QAction* theAction) = 0; //! Creates a command in Edit menu of SALOME desktop //! \param theId - an id of the feature @@ -41,20 +65,24 @@ public: //! \param theTip - a tooltip string (help) //! \param theIcon - icon //! \param isCheckable - is checkable or not - //! \param reciever - QObject which will react on the command call - //! \param member - a method of receiver which will be called on the command //! \param theKeys - hot keys - virtual void addEditCommand(const QString& theId, - const QString& theTitle, - const QString& theTip, - const QIcon& theIcon, - bool isCheckable, - QObject* reciever, - const char* member, - const QKeySequence& theKeys) = 0; + //! \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* 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; + + /// Add an action into tool bar + /// \param theAction the Action object + /// \param theToolBarTitle the toolbar name + virtual bool addActionInToolbar( QAction* theAction, const QString& theToolBarTitle ) = 0; //! Returns desktop window of SALOME virtual QMainWindow* desktop() const = 0; @@ -65,8 +93,33 @@ public: //! Returns QAction instance by command string Id virtual QAction* command(const QString& theId) const = 0; - //! Returns AIS_InteractiveContext from current OCCViewer - virtual Handle(AIS_InteractiveContext) AISContext() const = 0; + //! Returns list of defined actions (just by NewGeom module) + virtual QList commandList() const = 0; + + //! Returns list of Ids of defined actions (just by NewGeom module) + virtual QStringList commandIdList() const = 0; + + //! Set nested actions dependent on command Id + //! \param theId - the command ID + //! \param theActions - the list of nested actions + virtual void setNestedActions(const QString& theId, const QStringList& theActions) = 0; + + //! 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 ModuleBase_IViewer* viewer() const = 0; + + //! Create preferences + virtual void createPreferences() = 0; }; -#endif \ No newline at end of file +#endif