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 enum VisibilityState {
50 /// Default constructor
51 ModuleBase_ITreeNode(ModuleBase_ITreeNode* theParent = 0) : myParent(theParent) {}
53 virtual ~ModuleBase_ITreeNode() { deleteChildren(); }
55 virtual std::string type() const = 0;
57 /// Returns the node representation according to theRole.
58 virtual QVariant data(int theColumn, int theRole) const { return QVariant(); }
60 /// Returns properties flag of the item
61 virtual Qt::ItemFlags flags(int theColumn) const { return Qt::ItemIsSelectable | Qt::ItemIsEnabled; }
63 /// Returns parent node of the current node
64 ModuleBase_ITreeNode* parent() const { return myParent; }
66 /// Returns list of the node children
67 QTreeNodesList children() const { return myChildren; }
69 /// Returns a children node according to given row (index)
70 ModuleBase_ITreeNode* subNode(int theRow) const
72 if ((theRow > -1) && (theRow < myChildren.length()))
73 return myChildren.at(theRow);
77 /// Finds a node which contains the referenced object
78 /// \param theObj an object to find
79 /// \param allLevels if true then all sub-trees will be processed
80 ModuleBase_ITreeNode* subNode(const ObjectPtr& theObj, bool allLevels = true) const
82 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
83 if (aNode->object() == theObj)
86 ModuleBase_ITreeNode* aSubNode = aNode->subNode(theObj, allLevels);
94 /// Returns true if the given node is found within children
95 /// \param theNode a node to find
96 /// \param allLevels if true then all sub-trees will be processed
97 bool hasSubNode(ModuleBase_ITreeNode* theNode, bool allLevels = true) const
99 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
100 if (aNode == theNode)
103 if (aNode->hasSubNode(theNode))
110 /// Returns number of children
111 int childrenCount() const { return myChildren.length(); }
113 int nodeRow(ModuleBase_ITreeNode* theNode) const { return myChildren.indexOf(theNode); }
115 /// Returns object referenced by the node (can be null)
116 virtual ObjectPtr object() const { return ObjectPtr(); }
118 /// Updates all sub-nodes of the node (checks whole sub-tree)
119 virtual void update() {}
121 /// Process creation of objects.
122 /// \param theObjects a list of created objects
123 /// \return a list of nodes which corresponds to the created objects
124 virtual QTreeNodesList objectCreated(const QObjectPtrList& theObjects) { return QTreeNodesList(); }
126 /// Process deletion of objects.
127 /// \param theDoc a document where objects were deleted
128 /// \param theGroup a name of group where objects were deleted
129 /// \return a list of parents where nodes were deleted
130 virtual QTreeNodesList objectsDeleted(const DocumentPtr& theDoc, const QString& theGroup)
131 { return QTreeNodesList(); }
133 /// Returns workshop object. Has to be reimplemented in a root node
134 virtual ModuleBase_IWorkshop* workshop() const { return parent()->workshop(); }
136 /// Returns document object of the sub-tree. Has to be reimplemented in sub-tree root object
137 virtual DocumentPtr document() const { return parent()->document(); }
139 /// Returns a node which belongs to the given document and contains objects of the given group
140 /// \param theDoc a document
141 /// \param theGroup a name of objects group
142 /// \return a parent node if it is found
143 virtual ModuleBase_ITreeNode* findParent(const DocumentPtr& theDoc, QString theGroup)
146 /// Returns root node of a data tree of the given document
147 /// \param theDoc a document
148 /// \return a tree node which is a root of the document structure
149 virtual ModuleBase_ITreeNode* findRoot(const DocumentPtr& theDoc)
151 if (document() == theDoc)
153 ModuleBase_ITreeNode* aRoot;
154 foreach(ModuleBase_ITreeNode* aNode, myChildren) {
155 aRoot = aNode->findRoot(theDoc);
162 /// Returns visibilitystate of the node in viewer 3d
163 virtual VisibilityState visibilityState() const { return NoneState; }
167 /// deletes all children nodes (called in destructor.)
168 virtual void deleteChildren()
170 while (myChildren.size()) {
171 ModuleBase_ITreeNode* aNode = myChildren.takeLast();
176 ModuleBase_ITreeNode* myParent; //!< Parent of the node
177 QTreeNodesList myChildren; //!< Children of the node