1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef TITANIC_TREE_ITEM_H
#define TITANIC_TREE_ITEM_H
#include "titanic/core/message_target.h"
#include "titanic/support/simple_file.h"
namespace Titanic {
class CGameManager;
class CMovieClipList;
class CNamedItem;
class CProjectItem;
class CScreenManager;
class CViewItem;
class CTreeItem: public CMessageTarget {
friend class CMessage;
DECLARE_MESSAGE_MAP;
private:
CTreeItem *_parent;
CTreeItem *_nextSibling;
CTreeItem *_priorSibling;
CTreeItem *_firstChild;
int _field14;
public:
CLASSDEF;
CTreeItem();
/**
* Dump the item and any of it's children
*/
void dump(int indent);
/**
* Dump the item
*/
virtual CString dumpItem(int indent) const;
/**
* Save the data for the class to file
*/
virtual void save(SimpleFile *file, int indent);
/**
* Load the data for the class from file
*/
virtual void load(SimpleFile *file);
/**
* Get the game manager for the project
*/
virtual CGameManager *getGameManager() const;
/**
* Returns true if the item is a file item
*/
virtual bool isFileItem() const;
/**
* Returns true if the item is a room item
*/
virtual bool isRoomItem() const;
/**
* Returns true if the item is a node item
*/
virtual bool isNodeItem() const;
/**
* Returns true if the item is a view item
*/
virtual bool isViewItem() const;
/**
* Returns true if the item is a link item
*/
virtual bool isLinkItem() const;
/**
* Returns true if the item is a placeholder item
*/
virtual bool isPlaceHolderItem() const;
/**
* Returns true if the item is a named item
*/
virtual bool isNamedItem() const;
/**
* Returns true if the item is a game object
*/
virtual bool isGameObject() const;
/**
* Returns true if the item is a game object desc item
*/
virtual bool isGameObjectDescItem() const;
/**
* Gets the name of the item, if any
*/
virtual const CString getName() const { return CString(); }
/**
* Returns true if the item's name matches a passed name
*/
virtual bool isEquals(const CString &name, int maxLen = 0) const { return false; }
/**
* Compares the name of the item to a passed name
*/
virtual int compareTo(const CString &name, int maxLen = 0) const { return false; }
/**
* Returns the clip list, if any, associated with the item
*/
virtual const CMovieClipList *getMovieClips() const { return nullptr; }
/**
* Returns true if the given item connects to another specified view
*/
virtual bool connectsTo(CViewItem *destView) const { return false; }
/**
* Allows the item to draw itself
*/
virtual void draw(CScreenManager *screenManager) {}
/**
* Gets the bounds occupied by the item
*/
virtual Rect getBounds() const { return Rect(); }
/**
* Called when the view changes
*/
virtual void viewChange() {}
/**
* Get the parent for the given item
*/
CTreeItem *getParent() const { return _parent; }
/**
* Jumps up through the parents to find the root item
*/
CProjectItem *getRoot() const;
/**
* Get the next sibling
*/
CTreeItem *getNextSibling() const { return _nextSibling; }
/**
* Get the prior sibling
*/
CTreeItem *getPriorSibling() const { return _priorSibling; }
/**
* Get the last sibling of this sibling
*/
CTreeItem *getLastSibling();
/**
* Get the first child of the item, if any
*/
CTreeItem *getFirstChild() const { return _firstChild; }
/**
* Get the last child of the item, if any
*/
CTreeItem *getLastChild() const;
/**
* Given all the recursive children of the tree item, gives the next
* item in sequence to the passed starting item
*/
CTreeItem *scan(CTreeItem *item) const;
/**
* Find the first child item that is of a given type
*/
CTreeItem *findChildInstanceOf(ClassDef *classDef) const;
/**
* Find the next sibling item that is of the given type
*/
CTreeItem *findNextInstanceOf(ClassDef *classDef, CTreeItem *startItem) const;
/**
* Adds the item under another tree item
*/
void addUnder(CTreeItem *newParent);
/**
* Sets the parent for the item
*/
void setParent(CTreeItem *newParent);
/**
* Adds the item as a sibling of another item
*/
void addSibling(CTreeItem *item);
/**
* Moves the tree item to be under another parent
*/
void moveUnder(CTreeItem *newParent);
/**
* Destroys both the item as well as any of it's children
*/
void destroyAll();
/**
* Destroys all child tree items under this one.
* @returns Total number of tree items recursively removed
*/
int destroyChildren();
/**
* Detach the tree item from any other associated tree items
*/
void detach();
/**
* Attaches a tree item to a new node
*/
void attach(CTreeItem *item);
/**
* Finds a tree item by name
* @param name Name to find
* @param subMatch If false, does an exact name match.
* If false, matches any item that starts with the given name
*/
CNamedItem *findByName(const CString &name, bool subMatch = false);
};
} // End of namespace Titanic
#endif /* TITANIC_TREE_ITEM_H */
|
