Developer Documentation
TreeItem.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 #ifndef TREEITEM_HH
51 #define TREEITEM_HH
52 
53 #include <QString>
54 #include <QList>
55 #include <vector>
56 
58 
59 class TreeItem {
60 
61  public :
62 
63  TreeItem(int _id, QString _name, DataType _type, TreeItem* _parent);
64 
65  // static members
66  public:
68  int id();
69 
72  bool dataType(DataType _type);
73 
75  int group();
76  bool isGroup();
77 
78  private:
79  int id_;
80  DataType dataType_;
81 
82  // dynamic members
83  public:
84 
86  bool visible();
87  void visible(bool _visible);
88 
90  QString name( );
91  void name( QString _name );
92 
93  private:
94  bool visible_;
95  QString name_;
96 
97  // tree traversal
98  public:
99 
102  TreeItem* next();
103 
106  int level();
107 
108  private:
111 
113  QList<TreeItem*> childItems_;
114 
115  public:
116  //===========================================================================
119  //===========================================================================
120 
122  int row() const;
123 
125  TreeItem *parent();
126 
128  void setParent(TreeItem* _parent);
129 
132  //===========================================================================
135  //===========================================================================
136 
138  TreeItem* childExists(int _objectId);
139 
141  TreeItem* childExists(QString _name);
142 
144  void appendChild(TreeItem *child);
145 
147  TreeItem *child(int row);
148 
150  int childCount() const;
151 
153  void removeChild( TreeItem* _item );
154 
156  QList< TreeItem* > getLeafs();
157 
159  void deleteSubtree();
160 
161 };
162 
163 
164 //=============================================================================
165 #endif // TREEITEM_HH defined
166 //=============================================================================
void deleteSubtree()
delete the whole subtree below this item ( The item itself is not touched )
Definition: TreeItem.cc:351
bool visible()
visible
Definition: TreeItem.cc:159
Predefined datatypes.
Definition: DataTypes.hh:96
TreeItem * parent()
Get the parent item ( 0 if root item )
Definition: TreeItem.cc:243
int group()
group
Definition: TreeItem.cc:108
TreeItem * childExists(int _objectId)
Check if the element exists in the subtree of this element.
Definition: TreeItem.cc:279
QString name()
name
Definition: TreeItem.cc:171
QList< TreeItem * > childItems_
Children of this node.
Definition: TreeItem.hh:127
void setParent(TreeItem *_parent)
Set the parent pointer.
Definition: TreeItem.cc:250
int id()
id
Definition: TreeItem.cc:86
TreeItem * next()
Definition: TreeItem.cc:185
void appendChild(TreeItem *child)
add a child to this node
Definition: TreeItem.cc:256
int row() const
get the row of this item from the parent
Definition: TreeItem.cc:236
TreeItem * child(int row)
return a child
Definition: TreeItem.cc:265
TreeItem * parentItem_
Parent item or 0 if root node.
Definition: TreeItem.hh:121
void removeChild(TreeItem *_item)
Remove a child from this object.
Definition: TreeItem.cc:316
int childCount() const
get the number of children
Definition: TreeItem.cc:272
int level()
Definition: TreeItem.cc:221
QList< TreeItem * > getLeafs()
get all leafes of the tree below this object ( These will be all visible objects ) ...
Definition: TreeItem.cc:334
DataType dataType()
dataType
Definition: TreeItem.cc:102