CAM_Application.h

Go to the documentation of this file.

// Copyright (C) 2007-2026  CEA, EDF, 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_APPLICATION_H
#define CAM_APPLICATION_H
 
#include "CAM.h"
 
#include <STD_Application.h>
#include <QList>
 
class QMenu;
class CAM_Module;
 
#ifdef WIN32
#pragma warning( disable:4251 )
#endif
 
class CAM_EXPORT CAM_Application : public STD_Application
{
  Q_OBJECT
 
public:
  typedef QList<CAM_Module*> ModuleList;
  typedef struct { QString name;  QString version; } ModuleShortInfo;
  typedef QList<ModuleShortInfo> ModuleShortInfoList;
 
public:
  CAM_Application( const bool = true );
  virtual ~CAM_Application();
 
  virtual void        start();
 
  CAM_Module*         activeModule() const;
  CAM_Module*         module( const QString& ) const;
 
  ModuleList          modules() const;
  void                modules( ModuleList& ) const;
  void                modules( QStringList&,
                               const bool loaded = true ) const;
 
  virtual void        addModule( CAM_Module* );
 
  virtual void        loadModules();
  virtual CAM_Module* loadModule( const QString&, const bool = true );
 
  virtual bool        activateModule( const QString& );
 
  bool                activateOperation( const QString& modName,
                                         const int actionId );
  bool                activateOperation( const QString& modName,
                                         const QString& actionId );
  bool                activateOperation( const QString& modName,
                                         const QString& actionId,
                                         const QString& pluginName );
 
  virtual void        contextMenuPopup( const QString&, QMenu*, QString& );
 
  static QString      moduleName( const QString& );
  static QString      moduleTitle( const QString& );
  static QString      moduleIcon( const QString& );
  static QString      moduleDescription( const QString& );
  static QString      moduleLibrary( const QString&,
                                     const bool = true );
  static QString      moduleDisplayer( const QString& );
 
  virtual void        createEmptyStudy();
 
  static ModuleShortInfoList getVersionInfo();
 
  static void         logUserEvent( const QString& );
  static void         logAction( QAction*, const QString& = QString() );
  static void         logStructuredUserEvent( const QString& module,
                                              const QString& section,
                                              const QString& action,
                                              const QString& event,
                                              const QString& message = "" );
 
protected:
  virtual SUIT_Study* createNewStudy();
  virtual void        updateCommandsStatus();
 
  virtual bool        checkModule( const QString& );
  virtual void        moduleAdded( CAM_Module* );
  virtual void        moduleDeactivated( CAM_Module* );
  virtual void        beforeCloseDoc( SUIT_Study* );
  virtual void        afterCloseDoc();
  virtual bool        activateModule( CAM_Module* = 0 );
 
  virtual void        setActiveStudy( SUIT_Study* );
 
  virtual bool        abortAllOperations();
 
protected:
  bool                appendModuleInfo( const QString& );
  void                removeModuleInfo( const QString& );
  void                showAllModuleInfo();
 
private:
  enum { stInvalid = -1, stUnknown = 0, stNoGui, stInaccessible, stReady };
  struct ModuleInfo
  {
    QString name, title, icon, library, version, description, displayer;
    int status;
    ModuleInfo() : status( stInvalid ) {}
  };
  void                readModuleList();
 
private:
  typedef QList<ModuleInfo> ModuleInfoList;
  static ModuleInfoList myInfoList;      
  CAM_Module*           myModule;        
  ModuleList            myModules;       
  bool                  myAutoLoad;      
  bool                  myBlocked;       
};
 
#ifdef WIN32
#pragma warning( default:4251 )
#endif
 
#endif