1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef XGUI_DataModel_H
21 #define XGUI_DataModel_H
24 #include <ModuleBase_Definitions.h>
25 #include <ModelAPI_Object.h>
26 #include <ModelAPI_Document.h>
27 #include <Events_Listener.h>
29 #include <QAbstractItemModel>
31 class Config_DataModelReader;
33 class ModuleBase_ITreeNode;
35 /**\class XGUI_DataModel
37 * \brief This is a data model for Object Browser (QTreeView).
38 * It uses XML file for definition of data tree.
39 * Some tips about organization of the model:
40 * - Non Valid Index - root index
41 * - An index with internal Id == -1 is a folder of root document
42 * - An index which contains internal pointer as ModelAPI_Object its the object
43 * - An index which contains internal pointer as ModelAPI_Document is
44 * a folder which belongs to this document
46 class XGUI_EXPORT XGUI_DataModel : public QAbstractItemModel, public Events_Listener
51 /// \param theParent a parent object
52 XGUI_DataModel(QObject* theParent);
55 virtual ~XGUI_DataModel();
58 void setRoot(ModuleBase_ITreeNode* theRoot) { myRoot = theRoot; }
60 ModuleBase_ITreeNode* root() const { return myRoot; }
62 /// Event Listener method
63 /// \param theMessage an event message
64 virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
66 //! Returns an object by the given Model index.
67 //! Returns 0 if the given index is not index of an object
68 virtual ObjectPtr object(const QModelIndex& theIndex) const;
70 //! Returns index of the object
71 //! \param theObject object to find
72 virtual QModelIndex objectIndex(const ObjectPtr theObject, int theColumn = 1) const;
74 //! Clear internal data
78 virtual void rebuildDataTree();
80 /// Returns the data stored under the given role for the item referred to by the index.
81 /// \param theIndex a model index
82 /// \param theRole a data role (see Qt::ItemDataRole)
83 virtual QVariant data(const QModelIndex& theIndex, int theRole) const;
85 /// Returns the data for the given role and section in the header with the specified orientation.
86 /// \param theSection a section
87 /// \param theOrient an orientation
88 /// \param theRole a data role (see Qt::ItemDataRole)
89 virtual QVariant headerData(int theSection, Qt::Orientation theOrient, int theRole =
90 Qt::DisplayRole) const;
92 /// Returns the number of rows under the given parent. When the parent is valid it means that
93 /// rowCount is returning the number of children of parent.
94 /// \param theParent a parent model index
95 virtual int rowCount(const QModelIndex& theParent = QModelIndex()) const;
97 /// Returns the number of columns for the children of the given parent.
98 /// It has a one column
99 /// \param theParent a parent model index
100 virtual int columnCount(const QModelIndex& theParent = QModelIndex()) const;
102 /// Returns the index of the item in the model specified by the given row,
103 /// column and parent index.
104 /// \param theRow a row
105 /// \param theColumn a column
106 /// \param theParent a parent model index
107 virtual QModelIndex index(int theRow, int theColumn, const QModelIndex &theParent =
108 QModelIndex()) const;
110 /// Returns the parent of the model item with the given index.
111 /// If the item has no parent, an invalid QModelIndex is returned.
112 /// \param theIndex a model index
113 virtual QModelIndex parent(const QModelIndex& theIndex) const;
115 /// Returns true if parent has any children; otherwise returns false.
116 /// \param theParent a parent model index
117 virtual bool hasChildren(const QModelIndex& theParent = QModelIndex()) const;
119 /// Inserts count rows into the model before the given row.
120 /// Items in the new row will be children of the item represented by the parent model index.
121 /// \param theRow a start row
122 /// \param theCount a nember of rows to insert
123 /// \param theParent a parent model index
124 virtual bool insertRows(int theRow, int theCount, const QModelIndex& theParent = QModelIndex());
126 /// Removes count rows starting with the given row under parent parent from the model.
127 /// \param theRow a start row
128 /// \param theCount a nember of rows to remove
129 /// \param theParent a parent model index
130 virtual bool removeRows(int theRow, int theCount, const QModelIndex& theParent = QModelIndex());
132 /// Returns the item flags for the given index.
133 /// \param theIndex a model index
134 virtual Qt::ItemFlags flags(const QModelIndex& theIndex) const;
136 /// Returns an index which is root of the given document
137 /// \param theDoc a document
138 QModelIndex documentRootIndex(DocumentPtr theDoc, int theColumn = 1) const;
140 /// Returns last history object index
141 //virtual QModelIndex lastHistoryIndex() const;
143 /// Initialises XML data model reader. It must be initialised before DataModel using.
144 //void setXMLReader(Config_DataModelReader* theReader) { myXMLReader = theReader; }
146 /// Do not processing anymore events of model loop
147 //bool blockEventsProcessing(const bool theState);
149 /// Returns true if the data model item has Hidden visual state
150 /// \param theIndex a tree model item
151 /// \return boolean value
152 bool hasHiddenState(const QModelIndex& theIndex);
154 /// Returns true if the given index exists in data tree
155 /// \param theIndex an index to check
156 bool hasIndex(const QModelIndex& theIndex) const;
158 DocumentPtr document(const QModelIndex& theIndex) const;
161 /// Signal about tree had been rebuilt
165 enum VisibilityState {
172 QModelIndex getParentIndex(ModuleBase_ITreeNode* theNode, int thCol) const;
174 QModelIndex getIndex(ModuleBase_ITreeNode* theNode, int thCol) const;
176 void updateSubTree(ModuleBase_ITreeNode* theParent);
178 /// Find a root index which contains objects of the given document
179 /// \param theDoc the document object
180 //QModelIndex findDocumentRootIndex(const ModelAPI_Document* theDoc, int aColumn = 1) const;
182 /// Returns number of folders in document.
183 /// Considered folders which has to be shown only if they are not empty.
184 /// \param theDoc document which has to be checked. If 0 then Root document will be considered
185 //int foldersCount(ModelAPI_Document* theDoc = 0) const;
187 /// Retrurns indexes of folders which can not be shown because they are empty
188 /// \param theDoc document which has to be checked. If 0 then Root document will be considered
189 //QIntList missedFolderIndexes(ModelAPI_Document* theDoc = 0) const;
191 /// Returns Id (row) of a folder taking into consideration
192 /// folders which can not be shown non empty
193 /// \param theType Type of the folder
194 /// \param theDoc a document which contains this folder
195 //int folderId(std::string theType, ModelAPI_Document* theDoc = 0) const;
197 /// Removes a row from branch of tree
198 /// \param theStart - start row to update indexes
199 /// \param theSize - number of indexes in the folder
200 /// \param theParent - index of parent folder
201 //void rebuildBranch(int theRow, int theCount, const QModelIndex& theParent = QModelIndex());
203 /// Returns list of folders types which can not be shown empty
204 /// \param fromRoot - root document flag
205 //QStringList listOfShowNotEmptyFolders(bool fromRoot = true) const;
207 //int getNumberOfFolderItems(const ModelAPI_Folder* theFolder) const;
208 //ObjectPtr getObjectInFolder(const ModelAPI_Folder* theFolder, int theId) const;
210 //VisibilityState getVisibilityState(const QModelIndex& theIndex) const;
212 //void addShownFolder(DocumentPtr theDoc, QString theFolder)
214 // if (!myShownFolders.contains(theDoc)) {
215 // myShownFolders[theDoc] = QStringList();
217 // myShownFolders[theDoc].append(theFolder);
220 //void removeShownFolder(DocumentPtr theDoc, QString theFolder)
222 // if (myShownFolders.contains(theDoc)) {
223 // myShownFolders[theDoc].removeAll(theFolder);
224 // if (myShownFolders[theDoc].isEmpty())
225 // myShownFolders.remove(theDoc);
229 //bool hasShownFolder(DocumentPtr theDoc, QString theFolder) const
231 // if (myShownFolders.contains(theDoc))
232 // return myShownFolders[theDoc].contains(theFolder);
236 //Config_DataModelReader* myXMLReader;
238 XGUI_Workshop* myWorkshop;
239 QMap<DocumentPtr, QStringList> myShownFolders;
240 //bool myIsEventsProcessingBlocked;
242 ModuleBase_ITreeNode* myRoot;