tree_item.h

/* 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#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();


    void dump(int indent);

    virtual CString dumpItem(int indent) const;

    void save(SimpleFile *file, int indent) override;

    void load(SimpleFile *file) override;

    virtual CGameManager *getGameManager() const;

    virtual bool isFileItem() const;

    virtual bool isRoomItem() const;

    virtual bool isNodeItem() const;

    virtual bool isViewItem() const;

    virtual bool isLinkItem() const;

    virtual bool isPlaceHolderItem() const;

    virtual bool isNamedItem() const;

    virtual bool isGameObject() const;

    virtual bool isGameObjectDescItem() const;

    virtual const CString getName() const { return CString(); }

    virtual bool isEquals(const CString &name, bool startsWith = false) const{ return false; }

    virtual int compareTo(const CString &name, int maxLen = 0) const { return false; }

    virtual const CMovieClipList *getMovieClips() const { return nullptr; }

    virtual bool connectsTo(CViewItem *destView) const { return false; }

    virtual void draw(CScreenManager *screenManager) {}

    virtual Rect getBounds() const { return Rect(); }

    virtual void freeSurface() {}

    CTreeItem *getParent() const { return _parent; }

    CProjectItem *getRoot() const;

    CTreeItem *getNextSibling() const { return _nextSibling; }

    CTreeItem *getPriorSibling() const { return _priorSibling; }

    CTreeItem *getLastSibling();

    CTreeItem *getFirstChild() const { return _firstChild; }

    CTreeItem *getLastChild() const;

    CTreeItem *scan(CTreeItem *item) const;

    CTreeItem *findChildInstanceOf(ClassDef *classDef) const;

    CTreeItem *findNextInstanceOf(ClassDef *classDef, CTreeItem *startItem) const;

    void addUnder(CTreeItem *newParent);

    void setParent(CTreeItem *newParent);

    void addSibling(CTreeItem *item);

    void moveUnder(CTreeItem *newParent);

    void destroyAll();

    int destroyChildren();

    void detach();

    void attach(CTreeItem *item);

    CNamedItem *findByName(const CString &name, bool subMatch = false);
};

} // End of namespace Titanic

#endif /* TITANIC_TREE_ITEM_H */