Version: 8.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
CAM_Module.h
Go to the documentation of this file.
1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 
23 #ifndef CAM_MODULE_H
24 #define CAM_MODULE_H
25 
26 #include "CAM.h"
27 
28 #include <QObject>
29 #include <QPixmap>
30 #include <QString>
31 #include <QMap>
32 #include <QPair>
33 #include <QKeySequence>
34 
35 class QAction;
36 class QMenu;
37 class QIcon;
38 
39 class QtxActionGroup;
40 class QtxActionMenuMgr;
41 class QtxActionToolMgr;
42 class SUIT_Study;
43 class SUIT_Application;
44 class CAM_Study;
45 class CAM_DataModel;
46 class CAM_Application;
47 
48 #ifdef WIN32
49 #pragma warning( disable: 4251 )
50 #endif
51 
52 class CAM_EXPORT CAM_Module : public QObject
53 {
54  Q_OBJECT
55 
56 public:
57  CAM_Module();
58  CAM_Module( const QString& );
59  virtual ~CAM_Module();
60 
61  virtual void initialize( CAM_Application* );
62 
63  QString name() const;
64  QString moduleName() const;
65  virtual QPixmap moduleIcon() const;
66  virtual QString iconName() const;
67 
68  CAM_DataModel* dataModel() const;
69  CAM_Application* application() const;
70 
71  virtual void contextMenuPopup( const QString&, QMenu*, QString& ) {};
72  virtual void updateCommandsStatus() {};
73 
74  virtual void putInfo( const QString&, const int = -1 );
75 
76  bool isActiveModule() const;
77 
78  virtual void setMenuShown( const bool );
79  void setMenuShown( QAction*, const bool );
80  void setMenuShown( const int, const bool );
81 
82  virtual void setToolShown( const bool );
83  void setToolShown( QAction*, const bool );
84  void setToolShown( const int, const bool );
85 
86  virtual void updateModuleVisibilityState();
87 
88  virtual bool activateOperation( int actionId );
89  virtual bool activateOperation( const QString& actionId );
90  virtual bool activateOperation( const QString& actionId, const QString& pluginName );
91 
92  // actions/menu/toolbars management
93 
94  QtxActionMenuMgr* menuMgr() const;
95  QtxActionToolMgr* toolMgr() const;
96 
97  virtual QAction* action( const int ) const;
98  virtual int actionId( const QAction* ) const;
99  virtual QAction* createAction( const int, const QString&, const QIcon&, const QString&,
100  const QString&, const int, QObject* = 0,
101  const bool = false, QObject* = 0, const char* = 0, const QString& = QString() );
102  virtual QAction* createAction( const int, const QString&, const QIcon&, const QString&,
103  const QString&, const QKeySequence&, QObject* = 0,
104  const bool = false, QObject* = 0, const char* = 0, const QString& = QString() );
105  QtxActionGroup* createActionGroup( const int, const bool = true );
106 
107  int createTool( const QString&, const QString& = QString() );
108  int createTool( const int, const int, const int = -1 );
109  int createTool( const int, const QString&, const int = -1 );
110  int createTool( QAction*, const int, const int = -1, const int = -1 );
111  int createTool( QAction*, const QString&, const int = -1, const int = -1 );
112 
113  int createMenu( const QString&, const int, const int = -1, const int = -1, const int = -1,QMenu * = 0);
114  int createMenu( const QString&, const QString&, const int = -1, const int = -1, const int = -1 );
115  int createMenu( const int, const int, const int = -1, const int = -1 );
116  int createMenu( const int, const QString&, const int = -1, const int = -1 );
117  int createMenu( QAction*, const int, const int = -1, const int = -1, const int = -1 );
118  int createMenu( QAction*, const QString&, const int = -1, const int = -1, const int = -1 );
119 
120  static QAction* separator();
121 
122 public slots:
123  virtual bool activateModule( SUIT_Study* );
124  virtual bool deactivateModule( SUIT_Study* );
125 
126  virtual void connectToStudy( CAM_Study* );
127 
128  virtual void studyClosed( SUIT_Study* );
129  virtual void studyChanged( SUIT_Study*, SUIT_Study* );
130 
131  virtual void onApplicationClosed( SUIT_Application* );
132 
133 private slots:
134  void onInfoChanged( QString );
135 
136 protected:
137  virtual bool isSelectionCompatible();
138 
139  virtual CAM_DataModel* createDataModel();
140 
141  void setName( const QString& );
142  virtual void setModuleName( const QString& );
143 
144  int registerAction( const int, QAction* );
145  bool unregisterAction( const int );
146  bool unregisterAction( QAction* );
147  // IMN 05/03/2015: we copied myActionMap for reset/unset actions accelerator keys
148  // after activate/deactivate modules
149  QMap<QAction*, QKeySequence> myActionShortcutMap;
150 
151  virtual bool abortAllOperations();
152 
153 private:
154  CAM_Application* myApp;
155  QString myName;
156  QPixmap myIcon;
157  QString myInfo;
158  CAM_DataModel* myDataModel;
159  QMap<int, QAction*> myActionMap;
160  bool myMenuShown;
161  bool myToolShown;
162 
163  friend class CAM_Application;
164 };
165 
166 #ifdef WIN32
167 #pragma warning( default: 4251 )
168 #endif
169 
170 extern "C"
171 {
172  typedef CAM_Module* (*GET_MODULE_FUNC)();
173  typedef char* (*GET_VERSION_FUNC)();
174 }
175 
176 #define GET_MODULE_NAME "createModule"
177 #define GET_VERSION_NAME "getModuleVersion"
178 #endif