IObjectWalker.h

//========================================================================================
// 
// $File$
// 
// Owner: Raveendra Madala 
// 
// $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 __IObjectWalker__
#define __IObjectWalker__

#include "IPMUnknown.h"
#include "TextWalkerServiceProviderID.h"
#include "ObjectWalkerScopeOptions.h"

class IObjectWalker : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IOBJECTWALKER };
 
 enum WalkerState
 {
 kEndOfDocumentReached,
 kWalkCompleted,
 kWalkingOnSameSpread,
 kSpreadEndReached,
 kMovedToNextSpread,
 kMovedToNextDocument,
 };
 
 virtual void Initialize(ObjectWalkerScopeOptions options) = 0;
 
 virtual WalkerState GetNextItem(UIDRef& ourRef) = 0;
 
 virtual UIDRef GetCurrentItem() const = 0;
 virtual UIDRef GetCurrentSpread() const = 0;
 
 virtual bool16 MoveToSpread(UIDRef inSpreadRef) = 0;
 
 virtual bool16 SkipSpread(UIDRef inSpreadRef) = 0;
 
 virtual bool16 StartWithItem(UIDRef inItemRef) = 0;
};

#endif