src/LightApp/LightApp_Application.h

   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 // File:      LightApp_Application.h
  24 // Created:   6/20/2005 18:39:25 PM
  25 // Author:    OCC team
  26
  27 #ifndef LIGHTAPP_APPLICATION_H
  28 #define LIGHTAPP_APPLICATION_H
  29
  30 #if _MSC_VER > 1000
  31 #pragma once
  32 #endif // _MSC_VER > 1000
  33
  34 #include "LightApp.h"
  35 #include <SUIT_TreeModel.h>
  36 #include <SUIT_DataObject.h>
  37 #include <CAM_Application.h>
  38
  39 #include <QPointer>
  40 #include <QStringList>
  41
  42 class LogWindow;
  43 #ifndef DISABLE_PYCONSOLE
  44 class PyConsole_Console;
  45 class PyConsole_Interp;
  46 #endif
  47 class LightApp_WidgetContainer;
  48 class LightApp_Preferences;
  49 class LightApp_SelectionMgr;
  50 class LightApp_FullScreenHelper;
  51 class LightApp_DataObject;
  52 class SUIT_DataBrowser;
  53 class SUIT_Study;
  54 class SUIT_Accel;
  55 class SUIT_ViewModel;
  56 class CAM_Module;
  57
  58 class QString;
  59 class QWidget;
  60 class QStringList;
  61 class QDockWidget;
  62 class QTimer;
  63
  64 #ifdef WIN32
  65 #pragma warning( disable:4251 )
  66 #endif
  67
  68 /*!
  69   Description : Application containing only LightApp module
  70 */
  71
  72 class LIGHTAPP_EXPORT LightApp_Application : public CAM_Application, public SUIT_DataSearcher
  73 {
  74   Q_OBJECT
  75
  76 public:
  77   typedef enum { WT_ObjectBrowser,
  78 #ifndef DISABLE_PYCONSOLE
  79                  WT_PyConsole,
  80 #endif
  81                  WT_LogWindow,
  82                  WT_User }
  83   WindowTypes;
  84
  85   enum { MenuWindowId = 6 };
  86
  87   enum { RenameId = CAM_Application::UserID,
  88          CloseId, CloseAllId, GroupAllId,
  89          PreferencesId, MRUId, ModulesListId,
  90          NewGLViewId, NewPlot2dId, NewOCCViewId, NewVTKViewId,
  91          NewQxSceneViewId, NewGraphicsViewId, NewPVViewId, NewPyViewerId, StyleId, FullScreenId,
  92          UserID };
  93
  94 protected:
  95   enum { NewStudyId = 1, OpenStudyId };
  96
  97   enum BrowsePolicy { BP_Never = 0, BP_ApplyAndClose, BP_Always };
  98
  99 public:
 100   LightApp_Application();
 101   virtual ~LightApp_Application();
 102
 103   virtual QString                     applicationName() const;
 104   virtual QString                     applicationVersion() const;
 105
 106   virtual CAM_Module*                 loadModule( const QString&, const bool = true );
 107   virtual bool                        activateModule( const QString& );
 108
 109   LightApp_SelectionMgr*              selectionMgr() const;
 110
 111   LogWindow*                          logWindow();
 112   SUIT_DataBrowser*                   objectBrowser();
 113 #ifndef DISABLE_PYCONSOLE
 114   PyConsole_Console*                  pythonConsole(const bool force = false);
 115 #endif
 116
 117   virtual void                        updateObjectBrowser( const bool = true );
 118
 119   LightApp_Preferences*               preferences() const;
 120
 121   virtual QString                     getFileFilter( bool ) const;
 122
 123   virtual QString                     getFileName( bool open, const QString& initial, const QString& filters,
 124                                                    const QString& caption, QWidget* parent );
 125   virtual QString                     getDirectory( const QString& initial, const QString& caption, QWidget* parent );
 126   virtual QStringList                 getOpenFileNames( const QString& initial, const QString& filters,
 127                                                         const QString& caption, QWidget* parent );
 128
 129   void                                updateActions();
 130
 131   SUIT_ViewManager*                   getViewManager( const QString&, const bool );
 132   virtual void                        addViewManager( SUIT_ViewManager* );
 133   virtual void                        removeViewManager( SUIT_ViewManager* );
 134   virtual SUIT_ViewManager*           createViewManager( const QString& vmType, bool detached = false );
 135   virtual SUIT_ViewManager*           createViewManager( const QString& vmType, QWidget* w );
 136   virtual SUIT_ViewManager*           createViewManager( SUIT_ViewModel* );
 137
 138   QWidget*                            getWindow( const int );
 139   QWidget*                            dockWindow( const int ) const;
 140   void                                removeDockWindow( const int );
 141   void                                insertDockWindow( const int, QWidget* );
 142   void                                placeDockWindow( const int, Qt::DockWidgetArea );
 143
 144   virtual void                        start();
 145   virtual void                        closeApplication();
 146
 147   virtual void                        contextMenuPopup( const QString&, QMenu*, QString& );
 148
 149   virtual void                        createEmptyStudy();
 150
 151   virtual void                        setDesktop( SUIT_Desktop* );
 152
 153   SUIT_Accel*                         accel() const;
 154
 155   void                                setDefaultStudyName( const QString& theName );
 156
 157   virtual bool                        event( QEvent* );
 158
 159   virtual bool                        checkDataObject( LightApp_DataObject* theObj );
 160
 161   virtual void                        updateDesktopTitle();
 162
 163   //! Returns list of view manager types which are supported by this application
 164   QStringList                          viewManagersTypes() const;
 165
 166   //! Removes ViewManagers only of known type
 167   virtual void                        clearKnownViewManagers();
 168
 169   virtual QString                     browseObjects( const QStringList& theEntryList,
 170                                                      const bool theIsApplyAndClose = true,
 171                                                      const bool theIsOptimizedBrowsing = false );
 172
 173   virtual SUIT_DataObject*            findObject( const QString& ) const;
 174
 175   virtual bool                        renameAllowed( const QString& ) const;
 176   virtual bool                        renameObject( const QString&, const QString& );
 177
 178   void                                emitOperationFinished( const QString&, const QString&, const QStringList& );
 179
 180   void                                updateVisibilityState( DataObjectList& theList,
 181                                                              SUIT_ViewModel* theViewModel );
 182
 183   virtual bool                        checkExistingDoc( bool checkExistingDoc = true );
 184
 185 #ifndef DISABLE_PYCONSOLE
 186   PyConsole_Interp*                   getPyInterp();
 187 #endif
 188
 189 signals:
 190   void                                studyOpened();
 191   void                                studySaved();
 192   void                                studyClosed();
 193   void                                preferenceChanged( const QString&, const QString&, const QString& );
 194   void                                preferenceResetToDefaults();
 195   void                                operationFinished( const QString&, const QString&, const QStringList& );
 196
 197 public slots:
 198   virtual void                        onHelpContentsModule();
 199   virtual void                        onHelpContextModule( const QString&, const QString&, const QString& = QString() );
 200   virtual void                        onNewDoc();
 201   virtual void                        onOpenDoc();
 202
 203   virtual void                        onHelpAbout();
 204   virtual bool                        onOpenDoc( const QString& );
 205   virtual void                        onCopy();
 206   virtual void                        onPaste();
 207   virtual void                        onSelectionChanged();
 208   virtual void                        onDockWindowVisibilityChanged( bool );
 209
 210 protected:
 211   void                                showHelp( const QString& );
 212   virtual void                        createActions();
 213   virtual void                        createActionForViewer( const int id,
 214                                                              const int parentId,
 215                                                              const QString& suffix,
 216                                                              const int accel );
 217   virtual SUIT_Study*                 createNewStudy();
 218   virtual QWidget*                    createWindow( const int );
 219   virtual void                        defaultWindows( QMap<int, int>& ) const;
 220   void                                defaultViewManagers( QStringList& ) const;
 221
 222   virtual void                        setActiveStudy( SUIT_Study* );
 223   virtual void                        updateCommandsStatus();
 224
 225   virtual void                        beforeCloseDoc( SUIT_Study* );
 226   virtual void                        afterCloseDoc();
 227   virtual void                        moduleAdded( CAM_Module* );
 228   virtual bool                        activateModule( CAM_Module* = 0 );
 229
 230   LightApp_Preferences*               preferences( const bool ) const;
 231   virtual void                        createPreferences( LightApp_Preferences* );
 232   virtual void                        preferencesChanged( const QString&, const QString& );
 233
 234   virtual void                        loadPreferences();
 235   virtual void                        savePreferences();
 236
 237   virtual QMap<int, QString>          activateModuleActions() const;
 238   virtual void                        moduleActionSelected( const int );
 239
 240 #ifndef DISABLE_PYCONSOLE
 241   virtual PyConsole_Interp*           createPyInterp();
 242 #endif
 243
 244 protected slots:
 245   virtual void                        onDesktopActivated();
 246   virtual void                        onViewManagerRemoved( SUIT_ViewManager* );
 247   virtual void                        onWindowActivated( SUIT_ViewWindow* theViewWindow );
 248
 249   void                                onNewWindow();
 250   virtual void                        onModuleActivation( const QString& );
 251   void                                onCloseView( SUIT_ViewManager* );
 252
 253   virtual void                        onStudyCreated( SUIT_Study* );
 254   virtual void                        onStudyOpened( SUIT_Study* );
 255   virtual void                        onStudySaved( SUIT_Study* );
 256   virtual void                        onStudyClosed( SUIT_Study* );
 257
 258   void                                onWCDestroyed( QObject* );
 259
 260   void                                onMRUActivated( const QString& );
 261
 262   void                                onStylePreferences();
 263   void                                onFullScreen();
 264
 265   virtual void                        onDesktopMessage( const QString& );
 266
 267 private slots:
 268   void                                onSelection();
 269   void                                onRefresh();
 270   void                                onDropped( const QList<SUIT_DataObject*>&, SUIT_DataObject*, int, Qt::DropAction );
 271   void                                onPreferences();
 272   void                                onPreferenceChanged( QString&, QString&, QString& );
 273   void                                onRenameWindow();
 274   void                                onCloseWindow();
 275   void                                onCloseAllWindow();
 276   void                                onGroupAllWindow();
 277   void                                onRenamed();
 278   //void                                onMoved();
 279
 280 protected:
 281   void                                updateWindows();
 282   void                                updateViewManagers();
 283   void                                updateModuleActions();
 284   void                                removeModuleAction( const QString& );
 285
 286   bool                                checkModule( const QString& );
 287
 288   void                                loadDockWindowsState();
 289   void                                saveDockWindowsState();
 290
 291   virtual void                        studyOpened( SUIT_Study* );
 292   virtual void                        studyCreated( SUIT_Study* );
 293   virtual void                        studySaved( SUIT_Study* );
 294
 295   void                                updatePreference( const QString&, const QString&, const QString& );
 296
 297   QString                             defaultModule() const;
 298   virtual void                        currentWindows( QMap<int, int>& ) const;
 299   void                                currentViewManagers( QStringList& ) const;
 300   void                                moduleIconNames( QMap<QString, QString>& ) const;
 301
 302   QDockWidget*                        windowDock( QWidget* ) const;
 303   QByteArray                          dockWindowsState( const QMap<QString, bool>&, const QMap<QString, bool>& ) const;
 304   void                                dockWindowsState( const QByteArray&, QMap<QString, bool>&, QMap<QString, bool>& ) const;
 305
 306   virtual int                         openChoice( const QString& );
 307   virtual bool                        openAction( const int, const QString& );
 308
 309   void                                showPreferences( const QString& = QString() );
 310
 311 private:
 312   void                                emptyPreferences( const QString& );
 313   QList<QToolBar*>                    findToolBars( const QStringList& names = QStringList() );
 314
 315   QByteArray                          processState(QByteArray& input,
 316                                                    const bool processWin,
 317                                                    const bool processTb,
 318                                                    const bool isRestoring,
 319                                                    QByteArray defaultState = QByteArray());
 320
 321 protected:
 322   typedef QPointer<QWidget>         WinPtr;
 323   typedef QMap<int, WinPtr>         WinMap;
 324   typedef QMap<QString, QByteArray> WinVis;
 325   typedef QMap<QString, QByteArray> WinGeom;
 326
 327   enum { OpenReload = CAM_Application::OpenExist + 1 };
 328
 329 protected:
 330   LightApp_Preferences*               myPrefs;
 331   LightApp_SelectionMgr*              mySelMgr;
 332
 333   LightApp_FullScreenHelper*          myScreenHelper;
 334
 335   WinMap                              myWin;
 336   WinVis                              myWinVis;
 337
 338   SUIT_Accel*                         myAccel;
 339   QTimer*                             myAutoSaveTimer;
 340
 341   static LightApp_Preferences*        _prefs_;
 342
 343   QStringList                         myUserWmTypes;
 344
 345   friend void LightAppCleanUpAppResources();
 346 };
 347
 348 #ifdef WIN32
 349 #pragma warning( default:4251 )
 350 #endif
 351
 352 #endif