Salome HOME
Update from BR_V5_DEV 13Feb2009
[modules/gui.git] / src / LightApp / LightApp_Study.h
1 //  Copyright (C) 2007-2008  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.
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 #ifndef LIGHTAPP_STUDY_H
23 #define LIGHTAPP_STUDY_H
24
25 #include "LightApp.h"
26 #include "LightApp_Driver.h"
27
28 #include <CAM_Study.h>
29
30 #include "string"
31 #include "vector"
32
33 class SUIT_Study;
34 class SUIT_Application;
35 class CAM_DataModel;
36
37 /*!
38   Custom study, using for open/close of documents HDF format.
39   Data of each module can be saved to different files, those 
40   after that are combined into one HDF file
41 */
42 class LIGHTAPP_EXPORT LightApp_Study : public CAM_Study
43 {
44   Q_OBJECT
45
46 public:
47   LightApp_Study( SUIT_Application* );
48   virtual ~LightApp_Study();
49
50   virtual bool        createDocument( const QString& );
51   virtual bool        openDocument( const QString& );
52   virtual bool        loadDocument( const QString& ); 
53
54   virtual bool        saveDocument();
55   virtual bool        saveDocumentAs( const QString& );
56
57   virtual void        closeDocument(bool permanently = true);
58
59   virtual bool        isSaved()  const;
60   virtual bool        isModified() const;
61
62   virtual void        addComponent   ( const CAM_DataModel* dm);
63
64   virtual std::string GetTmpDir      ( const char* theURL, const bool  isMultiFile );
65
66   virtual QString     componentDataType( const QString& ) const;
67   virtual QString     referencedToEntry( const QString& ) const;
68   virtual bool        isComponent( const QString& ) const;
69   virtual void        children( const QString&, QStringList& ) const;
70   virtual void        components( QStringList& ) const;
71
72 protected:
73   virtual void        saveModuleData ( QString theModuleName, QStringList theListOfFiles );
74   virtual void        openModuleData ( QString theModuleName, QStringList& theListOfFiles );
75   virtual bool        saveStudyData  ( const QString& theFileName );
76   virtual bool        openStudyData  ( const QString& theFileName );
77
78   virtual std::vector<std::string> GetListOfFiles ( const char* theModuleName ) const;
79   virtual void        SetListOfFiles ( const char* theModuleName,
80                                        const std::vector<std::string> theListOfFiles );
81
82   virtual void        RemoveTemporaryFiles ( const char* theModuleName, const bool isMultiFile ) const;
83
84 protected:
85   virtual bool        openDataModel  ( const QString&, CAM_DataModel* );
86
87 signals:
88   void                saved  ( SUIT_Study* );
89   void                opened ( SUIT_Study* );
90   void                closed ( SUIT_Study* );
91   void                created( SUIT_Study* );
92
93
94 private:
95   LightApp_Driver*    myDriver;
96
97   friend class LightApp_Application;
98 };
99
100 #endif