/* Menes GUI - C++ Sensible Abstract GUI Toolkit
 * Copyright (C) 2002-2004  Jay Freeman (saurik)
*/

/*
 *        Redistribution and use in source and binary
 * forms, with or without modification, are permitted
 * provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the
 *    above copyright notice, this list of conditions
 *    and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the
 *    above copyright notice, this list of conditions
 *    and the following disclaimer in the documentation
 *    and/or other materials provided with the
 *    distribution.
 * 3. The name of the author may not be used to endorse
 *    or promote products derived from this software
 *    without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef MENES_GUI1_TREEMODEL_HPP
#define MENES_GUI1_TREEMODEL_HPP

#include "ext/map.hpp"
#include "ext/redblackset.hpp"
#include "cse/string.hpp"
#include "ext/vector.hpp"

#include "gui1/linkage.hpp"

namespace gui1 {

class TreeModel;

class TreeView {
  public:
    virtual void InsertChild(void *baton, TreeModel *child, TreeModel *before = NULL) = 0;
    virtual void EraseChild(void *baton, TreeModel *child) = 0;
    virtual void UpdateInfo(void *baton) = 0;
};

class GUI1_DECLARE TreeModel {
  public:
    typedef ext::Vector<TreeModel *> List;

  private:
    typedef ext::RedBlackMap<TreeView *, void *> ViewMap_;
    mutable ViewMap_ views_;

  protected:
    //void SetTreeChild_(unsigned index, TreeModel *child);

    void InsertTreeChild_(TreeModel *child, TreeModel *before = NULL);
    void EraseTreeChild_(TreeModel *child);
    void UpdateTreeInfo_();

  public:
    virtual TreeModel *GetTreeChild(unsigned index) = 0;
    virtual unsigned GetTreeSize() = 0;

    List GetTreeChildren();

    virtual TreeModel *GetTreeParent() = 0;

    virtual cse::String GetTreeText() const = 0;

    void SubscribeView(TreeView *view, void *baton) const;
    void UnsubscribeView(TreeView *view) const;

    void *GetViewBaton(TreeView *view) const;
};

}

#endif//MENES_GUI1_TREEMODEL_HPP