/***************************************************************************
 *                          Zanoza Modeler v2.x                            *
 *      This is unpublished propietary source code of Zanoza Software.     *
 *      The copyright notice does not evidence any actual or intended      *
 *                    publication of such source code.                     *
 *                                                                         *
 *                Copyright (c) 2002-2008 Zanoza Software.                 *
 *                                                                         *
 *                        All rights reserved.                             *
 ***************************************************************************
 *--------------------------------------------------------------------------
 * @author:   Oleg Melashenko
 *--------------------------------------------------------------------------
 * @purpose:  Declaration of the class ITreeNavigator
 *   Interface to navigate in tree-structure
 *--------------------------------------------------------------------------
 * @created: Thursday, October 03, 2002 16:59:22
 */

#if !defined(ITreeNavigator_h_included)
#define ITreeNavigator_h_included
//forward declaration of this class might require
namespace core
{ namespace layout
  { class ITreeNavigator; }; };
#include <zmodeler.h>
#include <core/layout/layoutTypes.h>

namespace core
{
  namespace layout
  {
    
    class ITreeNavigator : public ZUnknown
    {
    public:
      virtual ZRESULT getRoot(core::layout::ITreeNavigator** ppRoot)=0;
      virtual ZRESULT getParent(core::layout::ITreeNavigator** ppParent)=0;
      /* Releases sub-nodes. if bForce is true (only zmodeler is allowed to
       * pass true there), the nodes are hard-code released */
      virtual ZRESULT killSubs(bool bForceDelete=false)=0;
      virtual ZRESULT getSub(core::layout::ITreeNavigator** ppSub)=0;
      virtual ZRESULT getNext(core::layout::ITreeNavigator** ppNext)=0;
    
    };//class ITreeNavigator
  };//layout
};//core

#endif
