1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 #ifndef XGUI_SALOMECONNECTOR_H
4 #define XGUI_SALOMECONNECTOR_H
11 #include <ModuleBase_ActionInfo.h>
14 class ModuleBase_IViewer;
18 * An interface which provides a connection of XGUI functionality
19 * with functionality of SALOME module interface.
21 class XGUI_EXPORT XGUI_SalomeConnector
24 //! Creates a feature (command) in SALOME desktop
25 //! \param theWBName - a workbench name
26 //! \param theId - an id of the feature
27 //! \param theTitle - a menu item string
28 //! \param theTip - a tooltip string (help)
29 //! \param theIcon - icon
30 //! \param isCheckable - is checkable or not
31 //! \param theKeys - hot keys
32 //! returns created action
33 virtual QAction* addFeature(const QString& theWBName, const QString& theId,
34 const QString& theTitle, const QString& theTip, const QIcon& theIcon,
35 const QKeySequence& theKeys, bool isCheckable) = 0;
37 virtual QAction* addFeature(const QString& theWBName,
38 const ActionInfo& theInfo) = 0;
40 //! Creates a command in Edit menu of SALOME desktop
41 //! \param theId - an id of the feature
42 //! \param theTitle - a menu item string
43 //! \param theTip - a tooltip string (help)
44 //! \param theIcon - icon
45 //! \param isCheckable - is checkable or not
46 //! \param theKeys - hot keys
47 //! \param theMenuSourceText - a source text of the desktop menu
48 //! \param theMenuPosition - a position of the command in the desktop menu
49 //! returns created action
50 virtual QAction* addDesktopCommand(const QString& theId, const QString& theTitle,
51 const QString& theTip, const QIcon& theIcon,
52 const QKeySequence& theKeys, bool isCheckable,
53 const char* theMenuSourceText,
54 const int theMenuPosition = 10) = 0;
56 //! Insert separator into Edit menu of SALOME desktop
57 virtual void addDesktopMenuSeparator(const char* theMenuSourceText,
58 const int theMenuPosition = 10) = 0;
60 //! Returns desktop window of SALOME
61 virtual QMainWindow* desktop() const = 0;
63 //! Returns command string Id by QAction instance
64 virtual QString commandId(const QAction* theCmd) const = 0;
66 //! Returns QAction instance by command string Id
67 virtual QAction* command(const QString& theId) const = 0;
69 //! Returns list of defined actions (just by NewGeom module)
70 virtual QList<QAction*> commandList() const = 0;
72 //! Returns list of Ids of defined actions (just by NewGeom module)
73 virtual QStringList commandIdList() const = 0;
75 //! Set nested actions dependent on command Id
76 //! \param theId - the command ID
77 //! \param theActions - the list of nested actions
78 virtual void setNestedActions(const QString& theId, const QStringList& theActions) = 0;
80 //! Returns list of nested actions according to the given command ID
81 virtual QStringList nestedActions(const QString& theId) const = 0;
83 //! Set the document kind of the action by the given command Id
84 //! \param theId - the command ID
85 //! \param theKind - the document kind
86 virtual void setDocumentKind(const QString& theId, const QString& theKind) = 0;
88 //! Returns the document kind of the action by the given command ID
89 virtual QString documentKind(const QString& theId) const = 0;
91 //! Returns interface to Salome viewer
92 virtual ModuleBase_IViewer* viewer() const = 0;
94 //! Create preferences
95 virtual void createPreferences() = 0;