1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef ModuleBase_ITreeNode_H
22 #define ModuleBase_ITreeNode_H
24 #include "ModuleBase.h"
25 #include "ModuleBase_Definitions.h"
27 #include <ModelAPI_Object.h>
28 #include <ModelAPI_Document.h>
35 class ModuleBase_ITreeNode;
36 class ModuleBase_IWorkshop;
38 typedef QList<ModuleBase_ITreeNode*> QTreeNodesList;
40 class ModuleBase_ITreeNode
43 /// Default constructor
44 ModuleBase_ITreeNode(ModuleBase_ITreeNode* theParent = 0) : myParent(theParent) {}
46 virtual ~ModuleBase_ITreeNode() { deleteChildren(); }
48 virtual std::string type() const = 0;
50 /// Returns the node representation according to theRole.
51 virtual QVariant data(int theColumn, int theRole) const { return QVariant(); }
53 /// Returns properties flag of the item
54 virtual Qt::ItemFlags flags(int theColumn) const { return Qt::ItemIsSelectable | Qt::ItemIsEnabled; }
56 /// Returns parent node of the current node
57 ModuleBase_ITreeNode* parent() const { return myParent; }
59 /// Returns list of the node children
60 QTreeNodesList children() const { return myChildren; }
62 /// Returns a children node according to given row (index)
63 ModuleBase_ITreeNode* subNode(int theRow) const
65 if ((theRow > -1) && (theRow < myChildren.length()))
66 return myChildren.at(theRow);
70 /// Finds a node which contains the referenced object
71 /// \param theObj an object to find
72 /// \param allLevels if true then all sub-trees will be processed
73 ModuleBase_ITreeNode* subNode(const ObjectPtr& theObj, bool allLevels = true) const
75 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
76 if (aNode->object() == theObj)
79 ModuleBase_ITreeNode* aSubNode = aNode->subNode(theObj, allLevels);
87 /// Returns true if the given node is found within children
88 /// \param theNode a node to find
89 /// \param allLevels if true then all sub-trees will be processed
90 bool hasSubNode(ModuleBase_ITreeNode* theNode, bool allLevels = true) const
92 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
96 if (aNode->hasSubNode(theNode))
103 /// Returns number of children
104 int childrenCount() const { return myChildren.length(); }
106 int nodeRow(ModuleBase_ITreeNode* theNode) const { return myChildren.indexOf(theNode); }
108 /// Returns object referenced by the node (can be null)
109 virtual ObjectPtr object() const { return ObjectPtr(); }
111 /// Updates all sub-nodes of the node (checks whole sub-tree)
112 virtual void update() {}
114 /// Process creation of objects.
115 /// \param theObjects a list of created objects
116 /// \return a list of nodes which corresponds to the created objects
117 virtual QTreeNodesList objectCreated(const QObjectPtrList& theObjects) { return QTreeNodesList(); }
119 /// Process deletion of objects.
120 /// \param theDoc a document where objects were deleted
121 /// \param theGroup a name of group where objects were deleted
122 /// \return a list of parents where nodes were deleted
123 virtual QTreeNodesList objectsDeleted(const DocumentPtr& theDoc, const QString& theGroup)
124 { return QTreeNodesList(); }
126 /// Returns workshop object. Has to be reimplemented in a root node
127 virtual ModuleBase_IWorkshop* workshop() const { return parent()->workshop(); }
129 /// Returns document object of the sub-tree. Has to be reimplemented in sub-tree root object
130 virtual DocumentPtr document() const { return parent()->document(); }
132 /// Returns a node which belongs to the given document and contains objects of the given group
133 /// \param theDoc a document
134 /// \param theGroup a name of objects group
135 /// \return a parent node if it is found
136 virtual ModuleBase_ITreeNode* findParent(const DocumentPtr& theDoc, QString theGroup)
139 /// Returns root node of a data tree of the given document
140 /// \param theDoc a document
141 /// \return a tree node which is a root of the document structure
142 virtual ModuleBase_ITreeNode* findRoot(const DocumentPtr& theDoc)
144 if (document() == theDoc)
146 ModuleBase_ITreeNode* aRoot;
147 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
148 aRoot = aNode->findRoot(theDoc);
157 /// deletes all children nodes (called in destructor.)
158 virtual void deleteChildren()
160 while (myChildren.size()) {
161 ModuleBase_ITreeNode* aNode = myChildren.takeLast();
166 ModuleBase_ITreeNode* myParent; //!< Parent of the node
167 QTreeNodesList myChildren; //!< Children of the node