Developer Documentation

TreeItemObjectSelection.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 #ifndef TREEITEM_HH
45 #define TREEITEM_HH
46
47 #include <QString>
48 #include <QList>
49 #include <vector>
50
51 #include <OpenFlipper/common/Types.hh>
52
53 class TreeItemObjectSelection {
54
55 public :
56
57 TreeItemObjectSelection(int _id, QString _name, DataType _type, TreeItemObjectSelection* _parent);
58
59 // static members
60 public:
62 int id();
63
65 DataType dataType();
66 bool dataType(DataType _type);
67
69 int group();
70 bool isGroup();
71
72 private:
73 int id_;
74 DataType dataType_;
75
76 // dynamic members
77 public:
78
80 bool visible();
81 void visible(bool _visible);
82
84 QString name( );
85 void name( QString _name );
86
87 private:
88 bool visible_;
89 QString name_;
90
91 // tree traversal
92 public:
93
96 TreeItemObjectSelection* next();
97
100 int level();
101
102 private:
104 TreeItemObjectSelection *parentItem_;
105
107 QList<TreeItemObjectSelection*> childItems_;
108
109 public:
110 //===========================================================================
113 //===========================================================================
114
116 int row() const;
117
119 TreeItemObjectSelection *parent();
120
122 void setParent(TreeItemObjectSelection* _parent);
123
126 //===========================================================================
129 //===========================================================================
130
132 TreeItemObjectSelection* childExists(int _objectId);
133
135 TreeItemObjectSelection* childExists(QString _name);
136
138 void appendChild(TreeItemObjectSelection *child);
139
141 TreeItemObjectSelection *child(int row);
142
144 int childCount() const;
145
147 void removeChild( TreeItemObjectSelection* _item );
148
150 QList< TreeItemObjectSelection* > getLeafs();
151
153 void deleteSubtree();
154
155 };
156
157
158 //=============================================================================
159 #endif // TREEITEM_HH defined
160 //=============================================================================
TreeItemObjectSelection::parentItem_
TreeItemObjectSelection * parentItem_
Parent item or 0 if rootnode.
Definition: TreeItemObjectSelection.hh:104
TreeItemObjectSelection::next
TreeItemObjectSelection * next()
Definition: TreeItemObjectSelection.cc:139
TreeItemObjectSelection::dataType
DataType dataType()
dataType
Definition: TreeItemObjectSelection.cc:80
TreeItemObjectSelection::id
int id()
id
Definition: TreeItemObjectSelection.cc:64
TreeItemObjectSelection::childCount
int childCount() const
get the number of children
Definition: TreeItemObjectSelection.cc:226
TreeItemObjectSelection::parent
TreeItemObjectSelection * parent()
Get the parent item ( 0 if rootitem )
Definition: TreeItemObjectSelection.cc:199
TreeItemObjectSelection
Definition: TreeItemObjectSelection.hh:53
TreeItemObjectSelection::removeChild
void removeChild(TreeItemObjectSelection *_item)
Remove a child from this object.
Definition: TreeItemObjectSelection.cc:269
TreeItemObjectSelection::level
int level()
Definition: TreeItemObjectSelection.cc:174
TreeItemObjectSelection::setParent
void setParent(TreeItemObjectSelection *_parent)
Set the parent pointer.
Definition: TreeItemObjectSelection.cc:206
TreeItemObjectSelection::appendChild
void appendChild(TreeItemObjectSelection *child)
add a child to this node
Definition: TreeItemObjectSelection.cc:212
TreeItemObjectSelection::group
int group()
group
Definition: TreeItemObjectSelection.cc:86
TreeItemObjectSelection::deleteSubtree
void deleteSubtree()
delete the whole subtree below this item ( The item itself is not touched )
Definition: TreeItemObjectSelection.cc:307
TreeItemObjectSelection::childItems_
QList< TreeItemObjectSelection * > childItems_
Children of this node.
Definition: TreeItemObjectSelection.hh:107
TreeItemObjectSelection::childExists
TreeItemObjectSelection * childExists(int _objectId)
Check if the element exists in the subtree of this element.
Definition: TreeItemObjectSelection.cc:233
TreeItemObjectSelection::visible
bool visible()
visible
Definition: TreeItemObjectSelection.cc:113
TreeItemObjectSelection::name
QString name()
name
Definition: TreeItemObjectSelection.cc:125
TreeItemObjectSelection::child
TreeItemObjectSelection * child(int row)
return a child
Definition: TreeItemObjectSelection.cc:219
TreeItemObjectSelection::getLeafs
QList< TreeItemObjectSelection *> getLeafs()
get all leafes of the tree below this object ( These will be all visible objects ) ...
Definition: TreeItemObjectSelection.cc:290
Types.hh
DataType
Predefined datatypes.
Definition: DataTypes.hh:83
TreeItemObjectSelection::row
int row() const
get the row of this item from the parent
Definition: TreeItemObjectSelection.cc:189