TreeNodeTraverser.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Joss
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __TreeNodeTraverser__
#define __TreeNodeTraverser__

#include "ITreeViewMgr.h"
#include "K2Stack.h"
#include "K2Vector.h"
#include "NodeID.h"

class ITreeViewMgr;

// This is a help class used by the TreeNodeTraverser class. It really has no use on its own.
class TreeNodeHelper
{
 public:
 typedef base_type data_type;
 TreeNodeHelper(const ITreeViewMgr* treeMgr, const NodeID& node, bool16 expandedNodesOnly, bool16 reverse = kFalse, int32 index = -1);
 ~TreeNodeHelper();
 
 NodeID GetNextNode(const ITreeViewMgr* treeMgr);
 const NodeID& GetNode() const;
 
 private:
 NodeID fNode;
 int32 fIndex;
 bool16 fReverse;
 bool16 fExpandedOnly;
};


//========================================================================================
// CLASS TreeNodeTraverser
//========================================================================================

class DV_ TreeNodeTraverser
{
// ----- Constructors/desctructors
public:
 enum Direction { eForward, eReverse };

 TreeNodeTraverser(const NodeID& from, const ITreeViewMgr* treeMgr, bool16 expandedNodesOnly, Direction direction = eForward); 
 virtual ~TreeNodeTraverser();

 virtual NodeID Next();

 virtual bool16 Completed() const;

 private:
 void ClearStack();
 
 NodeID fCurrentNode;
 bool16 fExpandedNodesOnly;
 Direction fDirection;
 K2Vector<TreeNodeHelper*> fStack;
 const ITreeViewMgr* fTreeMgr;
};


#endif