ObjectWalkerScopeOptions.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 __OBJECTWALKERSCOPEOPTIONS_H
#define __OBJECTWALKERSCOPEOPTIONS_H

#include "UIDList.h"
class ObjectWalkerScopeOptions
{
public:
 enum WalkType
 {
 kAllFrames,
 kTextFrames,
 kGraphicFrames,
 kUnassignedFrames,
 };
 
 enum SearchScopeType
 {
 kAllDocuments,
 kDocument,
 kSelection,
 };

 // default ctor
 ObjectWalkerScopeOptions() 
 { 
 fIncludeMasterPages = kTrue; 
 fIncludeLockedLayers = kTrue; 
 fIncludeHiddenLayers = kTrue; 
 fIncludeLockedStories = kTrue; 
 fIncludeFootnotes = kTrue; 
 fWalkType = kAllFrames;
 fSearchScopeType = kDocument;
 }
 // default dtor
 ~ObjectWalkerScopeOptions() 
 {
 }
 ObjectWalkerScopeOptions(bool16 includeMasterPages,bool16 includeLockedLayers,bool16 includeHiddenLayers,bool16 includeLockedStories,bool16 includeFootnotes,WalkType walkType,SearchScopeType scopeType)
 { 
 fIncludeMasterPages = includeMasterPages; 
 fIncludeLockedLayers = includeLockedLayers; 
 fIncludeHiddenLayers = includeHiddenLayers; 
 fIncludeLockedStories = includeLockedStories; 
 fIncludeFootnotes = includeFootnotes; 
 fWalkType = walkType;
 fSearchScopeType = scopeType;
 }
 bool16 GetIncludeMasterPages() const
 { 
 return fIncludeMasterPages; 
 }
 void SetIncludeMasterPages(bool16 inIncludeMasterPages) 
 { 
 fIncludeMasterPages = inIncludeMasterPages; 
 }
 bool16 GetIncludeLockedLayers() const
 { 
 return fIncludeLockedLayers; 
 }
 void SetIncludeLockedLayers(bool16 inIncludeLockedLayers) 
 { 
 fIncludeLockedLayers = inIncludeLockedLayers; 
 }
 bool16 GetIncludeHiddenLayers() const
 { 
 return fIncludeHiddenLayers; 
 }
 void SetIncludeHiddenLayers(bool16 inIncludeHiddenLayers) 
 { 
 fIncludeHiddenLayers = inIncludeHiddenLayers; 
 }
 bool16 GetIncludeLockedStories() const
 { 
 return fIncludeLockedStories; 
 }
 void SetIncludeLockedStories(bool16 inIncludeLockedStories) 
 { 
 fIncludeLockedStories = inIncludeLockedStories; 
 }
 bool16 GetIncludeFootnotes() const 
 { 
 return fIncludeFootnotes; 
 }
 void SetIncludeFootnotes(bool16 inIncludeFootnotes) 
 { 
 fIncludeFootnotes = inIncludeFootnotes; 
 }
 WalkType GetObjectWalkType() const 
 { 
 return fWalkType; 
 }
 void SetObjectWalkType(WalkType inWalkType) 
 { 
 fWalkType = inWalkType; 
 }
 SearchScopeType GetSearchScopeType() const
 {
 return fSearchScopeType;
 }
 void SetSearchScopeType(SearchScopeType scopeType)
 {
 fSearchScopeType = scopeType;
 }
 UIDRef GetDocumentToBeSearched() const
 {
 return fDocRef;
 }
 void SetDocumentToBeSearched(UIDRef inDocRef)
 {
 fDocRef = inDocRef;
 }
 UIDList GetPageItemsToBeSearched() const
 {
 return fSelectedItemList;
 }
 void SetPageItemsToBeSearched(UIDList inItemList)
 {
 fSelectedItemList = inItemList;
 }
private:
 bool16 fIncludeMasterPages; // data member for storing include master pages option
 bool16 fIncludeLockedLayers; // data member for storing include locked layers option
 bool16 fIncludeHiddenLayers; // data member for storing include hidden layers option
 bool16 fIncludeLockedStories; // data member for storing include locked stories option
 bool16 fIncludeFootnotes; // data member for storing include footnotes option
 WalkType fWalkType; // data member for storing walk type
 SearchScopeType fSearchScopeType; // data member for storing search scope type
 UIDRef fDocRef; // data member for storing the document that needs to be searched when search scope type is kDocument
 UIDList fSelectedItemList; // data member for storing the items that needs to be searched when search scope type is kSelection
};

#endif