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 ULTIMA_SHARED_CORE_TREE_ITEM_H
#define ULTIMA_SHARED_CORE_TREE_ITEM_H

#include "ultima/shared/core/message_target.h"

namespace Ultima {
namespace Shared {

namespace Gfx {
class VisualItem;
} // End of namespace Gfx

namespace Maps {
class Map;
} // End of namespace Maps

class Game;
class GameManager;
class GameState;
class Events;
class Map;
class NamedItem;
class CMessage;

class TreeItem: public MessageTarget {
    friend class CMessage;
    DECLARE_MESSAGE_MAP;
private:
    TreeItem *_parent;
    TreeItem *_nextSibling;
    TreeItem *_priorSibling;
    TreeItem *_firstChild;
    DisposeAfterUse::Flag _disposeAfterUse;
public:
    CLASSDEF;
    TreeItem();

    virtual const Common::String getName() const {
        return Common::String();
    }

    virtual bool isEquals(const Common::String &name, int maxLen = 0) const {
        return false;
    }

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

    virtual void viewChange() {
    }

    TreeItem *getParent() const {
        return _parent;
    }

    Game *getGame();

    const Game *getGame() const;

    Gfx::VisualItem *getView();

    TreeItem *getNextSibling() const {
        return _nextSibling;
    }

    TreeItem *getPriorSibling() const {
        return _priorSibling;
    }

    TreeItem *getLastSibling();

    TreeItem *getFirstChild() const {
        return _firstChild;
    }

    TreeItem *getLastChild() const;

    TreeItem *scan(TreeItem *item) const;

    TreeItem *findChildInstanceOf(const ClassDef &classDef) const;

    TreeItem *findNextInstanceOf(const ClassDef &classDef, TreeItem *startItem) const;

    void addUnder(TreeItem *newParent);

    void addChild(TreeItem *child);

    void setParent(TreeItem *newParent);

    void addSibling(TreeItem *item);

    void moveUnder(TreeItem *newParent);

    void destroyAll();

    int destroyChildren();

    void detach();

    void attach(TreeItem *item);

    NamedItem *findByName(const Common::String &name);
};

} // End of namespace Shared
} // End of namespace Ultima

#endif