1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef HYDROGUI_DATAMODEL_H
24 #define HYDROGUI_DATAMODEL_H
26 #include <HYDROData_Document.h>
27 #include <HYDROData_Object.h>
30 #include <LightApp_DataModel.h>
32 #include <SUIT_TreeModel.h>
35 class SUIT_DataObject;
36 class HYDROGUI_DataObject;
39 * \class HYDROGUI_DataModel
40 * \brief The class representing the HYDROGUI data model
42 class HYDROGUI_DataModel : public LightApp_DataModel, public SUIT_DataSearcher
47 * \param theModule module object
49 HYDROGUI_DataModel( CAM_Module* theModule );
50 virtual ~HYDROGUI_DataModel();
53 * Open the document into the data model. Reimplemented.
54 * \param theURL opened study path
55 * \param theStudy object study
56 * \param theFileList list of opened files for this model.
58 virtual bool open( const QString& theURL,
60 QStringList theFileList );
63 * Saves the document. Reimplemented.
64 * \param returned theFileList list of saved files of this model.
66 virtual bool save( QStringList& theFileList );
69 * Saves as the document. Reimplemented.
70 * \param theURL saved study path
71 * \param theStudy object study
72 * \param returned theFileList list of saved files of this model.
74 virtual bool saveAs( const QString& theURL,
76 QStringList& theFileList );
79 * Close the model and remove data. Reimplemented.
84 * Dump study data to Python script. Reimplemented.
86 virtual bool dumpPython( const QString& theURL,
89 QStringList& theListOfFiles );
92 * Returns modification status. Reimplemented.
93 * \return boolean value of modification status
95 virtual bool isModified() const;
98 * Returns saving status. Reimplemented.
99 * \return true if document has saved files on disc.
101 virtual bool isSaved() const;
104 * Updates the internal structure of data object tree.
105 * \param theStudyId study identifier
107 virtual void update( const int theStudyId );
110 * Returns data object corresponding to the model object.
111 * \param the data model object
112 * \return the only one object referenced to the given data model object, or null if not found
114 virtual HYDROGUI_DataObject* getDataObject( const Handle(HYDROData_Object)& theModelObject );
117 * Returns a data object referenced to the given data object.
118 * \param the data object
119 * \return the object referenced to the given object, or null if not found
121 virtual HYDROGUI_DataObject* getReferencedDataObject( HYDROGUI_DataObject* theObject );
124 * Finds the object by entry
125 * \param theEntry an object entry
127 virtual SUIT_DataObject* findObject( const QString& theEntry ) const;
130 * Updates the internal structure of data object tree starting from specified data object \a obj.
131 * \param theObject start data object
132 * \param theStudy study object
134 virtual void update( LightApp_DataObject* theObject = 0,
135 LightApp_Study* theStudy = 0 );
138 * Creates a module object and set is a root for the model
140 CAM_DataObject* createRootModuleObject( SUIT_DataObject* theParent );
143 * Correct an internal model object according to the current document mode
148 * Find a data object by the specified entry and kind
150 Handle(HYDROData_Object) objectByEntry( const QString& theEntry,
151 const ObjectKind theObjectKind = KIND_UNKNOWN );
154 * Check if it is possible to perform 'undo' operation
156 bool canUndo() const;
159 * Check if it is possible to perform 'redo' operation
161 bool canRedo() const;
164 * Returns the list of names of available 'undo' actions
166 QStringList undoNames() const;
169 * Returns the list of names of available 'redo' actions
171 QStringList redoNames() const;
174 * Clear the list of stored 'undo' actions
179 * Clear the list of stored 'redo' actions
184 * Perform the 'undo' operation
189 * Perform the 'redo' operation
194 * Check if it is possible to perform 'copy' operation
199 * Check if it is possible to perform 'paste' operation
204 * Perform the 'copy' operation
209 * Perform the 'paste' operation
214 * Update the sequence of the objects to be copied
216 static void changeCopyingObjects( const HYDROData_SequenceOfObjects& );
219 * Returns name of the partition containing the objects of the specified kind
220 * \param theObjectKind kind of objects
221 * \return partition name
223 static QString partitionName( const ObjectKind theObjectKind );
227 * Returns the document for the current study
229 Handle(HYDROData_Document) getDocument() const;
232 * Creates the GUI data object according to the model object.
233 * \param theParent a created object will be appended as a child of this object
234 * \param theModelObject model object
235 * \param theParentEntry entry of parent object
237 LightApp_DataObject* createObject( SUIT_DataObject* theParent,
238 Handle(HYDROData_Object) theModelObject,
239 const QString& theParentEntry = QString(),
240 const bool theIsBuildTree = true );
243 * Creates the GUI data object without corresponding model object: just by name
244 * \param theParent a created object will be appended as a child of this object
245 * \param theName name of this object
246 * \param theParentEntry entry of parent object
248 LightApp_DataObject* createObject( SUIT_DataObject* theParent,
249 const QString& theName,
250 const QString& theParentEntry = QString() );
253 * Build tree of model object.
254 * \param theParent a created object will be appended as a child of this object
255 * \param theObject gui object for which the tree will be build
256 * \param theParentEntry entry of parent object
258 void buildObjectTree( SUIT_DataObject* theParent,
259 SUIT_DataObject* theObject,
260 const QString& theParentEntry = QString() );
263 * Removes data object from the tree.
264 * \param theParent an object will be removed from this parent.
265 * \param theChild the removed object.
267 void removeChild( SUIT_DataObject* theParent,
268 SUIT_DataObject* theChild );
271 * Returns the first child of the object with the specified name
272 * \param theFather object that contain the searched object in children
273 * \param theName name f the searched data object
274 * \returns NULL if not found
276 static SUIT_DataObject* findChildByName( const SUIT_DataObject* theFather,
277 const QString& theName );
280 QString myStudyURL; ///< the saved/opened document URL