+// Copyright (C) 2007-2023 CEA/DEN, EDF R&D, OPEN CASCADE
+//
+// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// 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
+//
+
#ifndef CAM_MODULE_H
#define CAM_MODULE_H
#include "CAM.h"
-#include <qpixmap.h>
-#include <qobject.h>
-#include <qpopupmenu.h>
-#include <qstring.h>
+#include <QObject>
+#include <QPixmap>
+#include <QString>
+#include <QMap>
+#include <QPair>
+#include <QKeySequence>
class QAction;
+class QMenu;
+class QIcon;
+
+class QtxActionGroup;
+class QtxActionMenuMgr;
+class QtxActionToolMgr;
class SUIT_Study;
+class SUIT_Application;
class CAM_Study;
class CAM_DataModel;
class CAM_Application;
-class QtxActionMenuMgr;
-class QtxActionToolMgr;
#ifdef WIN32
#pragma warning( disable: 4251 )
#endif
-/*!
- * Class provide support of tool and menu managers.
- */
class CAM_EXPORT CAM_Module : public QObject
{
Q_OBJECT
virtual void initialize( CAM_Application* );
+ QString name() const;
QString moduleName() const;
- QPixmap moduleIcon() const;
+ virtual QPixmap moduleIcon() const;
+ virtual QString iconName() const;
CAM_DataModel* dataModel() const;
CAM_Application* application() const;
- virtual QString iconName() const;
-
- virtual void contextMenuPopup( const QString&, QPopupMenu*, QString& title ) {};
+ virtual void contextMenuPopup( const QString&, QMenu*, QString& ) {};
virtual void updateCommandsStatus() {};
- /** @name Set Menu Shown*/
- //@{
- void setMenuShown( const bool );
+ virtual void putInfo( const QString&, const int = -1 );
+
+ int showNotification(const QString& message, const QString& title, int timeout = -1);
+ void hideNotification(const QString& message);
+ void hideNotification(int id);
+
+ bool isActiveModule() const;
+
+ virtual void setMenuShown( const bool );
void setMenuShown( QAction*, const bool );
void setMenuShown( const int, const bool );
- //@}
- /** @name Set Tool Shown*/
- //@{
- void setToolShown( const bool );
+ virtual void setToolShown( const bool );
void setToolShown( QAction*, const bool );
void setToolShown( const int, const bool );
- //@}
-public slots:
- virtual bool activateModule( SUIT_Study* );
- virtual bool deactivateModule( SUIT_Study* );
+ virtual void updateModuleVisibilityState();
- virtual void connectToStudy( CAM_Study* );
+ virtual bool activateOperation( int actionId );
+ virtual bool activateOperation( const QString& actionId );
+ virtual bool activateOperation( const QString& actionId, const QString& pluginName );
- virtual void studyClosed( SUIT_Study* );
- virtual void studyChanged( SUIT_Study*, SUIT_Study* );
-
-protected:
- virtual CAM_DataModel* createDataModel();
-
- virtual void setModuleName( const QString& );
- virtual void setModuleIcon( const QPixmap& );
+ // actions/menu/toolbars management
QtxActionMenuMgr* menuMgr() const;
QtxActionToolMgr* toolMgr() const;
- /** @name Create tool methods.*/
- //@{
- int createTool( const QString& );
+ virtual QAction* action( const int ) const;
+ virtual int actionId( const QAction* ) const;
+ virtual QAction* createAction( const int, const QString&, const QIcon&, const QString&,
+ const QString&, const int, QObject* = 0,
+ const bool = false, QObject* = 0, const char* = 0, const QString& = QString() );
+ virtual QAction* createAction( const int, const QString&, const QIcon&, const QString&,
+ const QString&, const QKeySequence&, QObject* = 0,
+ const bool = false, QObject* = 0, const char* = 0, const QString& = QString() );
+ QtxActionGroup* createActionGroup( const int, const bool = true );
+
+ int createTool( const QString&, const QString& = QString() );
int createTool( const int, const int, const int = -1 );
int createTool( const int, const QString&, const int = -1 );
int createTool( QAction*, const int, const int = -1, const int = -1 );
int createTool( QAction*, const QString&, const int = -1, const int = -1 );
- //@}
+ void clearTool( const QString& title );
- /** @name Create menu methods.*/
- //@{
- int createMenu( const QString&, const int, const int = -1, const int = -1, const int = -1 );
+ int createMenu( const QString&, const int, const int = -1, const int = -1, const int = -1,QMenu * = 0);
int createMenu( const QString&, const QString&, const int = -1, const int = -1, const int = -1 );
int createMenu( const int, const int, const int = -1, const int = -1 );
int createMenu( const int, const QString&, const int = -1, const int = -1 );
int createMenu( QAction*, const int, const int = -1, const int = -1, const int = -1 );
int createMenu( QAction*, const QString&, const int = -1, const int = -1, const int = -1 );
- //@}
static QAction* separator();
- /**Action ids methods.*/
- //@{
- QAction* action( const int ) const;
- int actionId( const QAction* ) const;
- //@}
+public slots:
+ virtual bool activateModule( SUIT_Study* );
+ virtual bool deactivateModule( SUIT_Study* );
+
+ virtual void connectToStudy( CAM_Study* );
+
+ virtual void studyClosed( SUIT_Study* );
+ virtual void studyChanged( SUIT_Study*, SUIT_Study* );
+
+ virtual void onApplicationClosed( SUIT_Application* );
+
+private slots:
+ void onInfoChanged( QString );
+
+protected:
+ virtual bool isSelectionCompatible();
+
+ virtual CAM_DataModel* createDataModel();
+
+ void setName( const QString& );
+ virtual void setModuleName( const QString& );
int registerAction( const int, QAction* );
- QAction* createAction( const int, const QString&, const QIconSet&, const QString&,
- const QString&, const int, QObject* = 0,
- const bool = false, QObject* = 0, const char* = 0 );
+ bool unregisterAction( const int );
+ bool unregisterAction( QAction* );
+ // IMN 05/03/2015: we copied myActionMap for reset/unset actions accelerator keys
+ // after activate/deactivate modules
+ QMap<QAction*, QKeySequence> myActionShortcutMap; //!< copy actions shortcut map
+
+ virtual bool abortAllOperations();
private:
- CAM_Application* myApp;
- QString myName;
- QPixmap myIcon;
- CAM_DataModel* myDataModel;
- QMap<int, QAction*> myActionMap;
+ CAM_Application* myApp; //!< parent application object
+ QString myName; //!< module title (user name)
+ QPixmap myIcon; //!< module icon
+ QString myInfo; //!< latest info message
+ CAM_DataModel* myDataModel; //!< data model
+ QMap<int, QAction*> myActionMap; //!< menu actions
+ bool myMenuShown; //!< menu shown flag
+ bool myToolShown; //!< tool shown flag
friend class CAM_Application;
};
#pragma warning( default: 4251 )
#endif
-extern "C" {
+extern "C"
+{
typedef CAM_Module* (*GET_MODULE_FUNC)();
+ typedef char* (*GET_VERSION_FUNC)();
}
#define GET_MODULE_NAME "createModule"
-
+#define GET_VERSION_NAME "getModuleVersion"
#endif
