#include <ObjectWalkerScopeOptions.h>
Public Types
enum WalkType { kAllFrames, kTextFrames, kGraphicFrames, kUnassignedFrames }

enum SearchScopeType { kAllDocuments, kDocument, kSelection }

Public Member Functions
ObjectWalkerScopeOptions (bool16 includeMasterPages, bool16 includeLockedLayers, bool16 includeHiddenLayers, bool16 includeLockedStories, bool16 includeFootnotes, WalkType walkType, SearchScopeType scopeType)

bool16 GetIncludeMasterPages () const

void SetIncludeMasterPages (bool16 inIncludeMasterPages)

bool16 GetIncludeLockedLayers () const

void SetIncludeLockedLayers (bool16 inIncludeLockedLayers)

bool16 GetIncludeHiddenLayers () const

void SetIncludeHiddenLayers (bool16 inIncludeHiddenLayers)

bool16 GetIncludeLockedStories () const

void SetIncludeLockedStories (bool16 inIncludeLockedStories)

bool16 GetIncludeFootnotes () const

void SetIncludeFootnotes (bool16 inIncludeFootnotes)

WalkType GetObjectWalkType () const

void SetObjectWalkType (WalkType inWalkType)

SearchScopeType GetSearchScopeType () const

void SetSearchScopeType (SearchScopeType scopeType)

UIDRef GetDocumentToBeSearched () const

void SetDocumentToBeSearched (UIDRef inDocRef)

UIDList GetPageItemsToBeSearched () const

void SetPageItemsToBeSearched (UIDList inItemList)

Detailed Description

ObjectWalkerScopeOptions provides a way to convey the options for consideration to IObjectWalkerFactoryUtils while creating the IObjectWalker

Member Enumeration Documentation

enum ObjectWalkerScopeOptions::SearchScopeType

Enumerator
kAllDocuments	This enumeration specifies All Documents to be searched
kDocument	This enumeration specifies Document to be searched
kSelection	This enumeration specifies Selected page items to be searched

enum ObjectWalkerScopeOptions::WalkType

Enumerator
kAllFrames	This enumeration specifies All Splines for Walking
kTextFrames	This enumeration specifies Text Frames for Walking
kGraphicFrames	This enumeration specifies Graphic Frames for Walking
kUnassignedFrames	This enumeration specifies Unassigned Frames for Walking

Constructor & Destructor Documentation

ObjectWalkerScopeOptions::ObjectWalkerScopeOptions	(	bool16	includeMasterPages,
		bool16	includeLockedLayers,
		bool16	includeHiddenLayers,
		bool16	includeLockedStories,
		bool16	includeFootnotes,
		WalkType	walkType,
		SearchScopeType	scopeType
	)

inline

constructor

Parameters

includeMasterPages	specifies whether to include master pages or not. kTrue to include and kFalse to exclude.
includeLockedLayers	specifies whether to include locked layers or not. kTrue to include and kFalse to exclude.
includeHiddenLayers	specifies whether to include hidden layers or not. kTrue to include and kFalse to exclude.
includeLockedStories	specifies whether to include locked stories or not. kTrue to include and kFalse to exclude.
includeFootnotes	specifies whether to include footnotes or not. kTrue to include and kFalse to exclude.
walkType	specifies which type of objects need to be searched. see documentation.
scopeType	specifies the search scope. see documentation.

Member Function Documentation

UIDRef ObjectWalkerScopeOptions::GetDocumentToBeSearched ( ) const

inline

Returns the UIDRef of the document that needs to be searched when scope type is document

bool16 ObjectWalkerScopeOptions::GetIncludeFootnotes ( ) const

inline

Returns the value of include footnotes option

Returns: kTrue if "include footnotes" is on else kFalse

bool16 ObjectWalkerScopeOptions::GetIncludeHiddenLayers ( ) const

inline

Returns the value of include hidden layers option

Returns: kTrue if "include hidden layers" is on else kFalse

bool16 ObjectWalkerScopeOptions::GetIncludeLockedLayers ( ) const

inline

Returns the value of include locked layers option

Returns: kTrue if "include locked layers" is on else kFalse

bool16 ObjectWalkerScopeOptions::GetIncludeLockedStories ( ) const

inline

Returns the value of include locked stories option

Returns: kTrue if "include locked stories" is on else kFalse

bool16 ObjectWalkerScopeOptions::GetIncludeMasterPages ( ) const

inline

Returns the value of include master pages option

Returns: kTrue if "include master pages" is on else kFalse

WalkType ObjectWalkerScopeOptions::GetObjectWalkType ( ) const

inline

Returns the value of walk type

Returns: kAllFrames if all splines need to be searched kTextFrames if all text frames need to be searched kGraphicFrames if all graphic frames need to be searched kUnassignedFrames if all unassigned frames need to be searched

UIDList ObjectWalkerScopeOptions::GetPageItemsToBeSearched ( ) const

inline

Returns the list of UID's that needs to be searched when scope type is selection

SearchScopeType ObjectWalkerScopeOptions::GetSearchScopeType ( ) const

inline

Returns the search scope type

Returns: kAllDocuments if all documents need to be searched kDocument if single document need to be searched kSelection if only selected items need to be searched

void ObjectWalkerScopeOptions::SetDocumentToBeSearched ( UIDRef inDocRef )

inline

Sets the document that needs to be searched when scope type is document

void ObjectWalkerScopeOptions::SetIncludeFootnotes ( bool16 inIncludeFootnotes )

inline

Sets the value of include footnotes option

Parameters

inIncludeFootnotes specifies the value for "include footnotes" option. It can be kTrue/kFalse.

void ObjectWalkerScopeOptions::SetIncludeHiddenLayers ( bool16 inIncludeHiddenLayers )

inline

Sets the value of include hidden layers option

Parameters

inIncludeHiddenLayers specifies the value for "include hidden layers" option. It can be kTrue/kFalse.

void ObjectWalkerScopeOptions::SetIncludeLockedLayers ( bool16 inIncludeLockedLayers )

inline

Sets the value of include locked layers option

Parameters

inIncludeLockedLayers specifies the value for "include locked layers" option. It can be kTrue/kFalse.

void ObjectWalkerScopeOptions::SetIncludeLockedStories ( bool16 inIncludeLockedStories )

inline

Sets the value of include locked stories option

Parameters

inIncludeLockedStories specifies the value for "include locked stories" option. It can be kTrue/kFalse.

void ObjectWalkerScopeOptions::SetIncludeMasterPages ( bool16 inIncludeMasterPages )

inline

Sets the value of include master pages option

Parameters

inIncludeMasterPages specifies the value for "include master pages" option. It can be kTrue/kFalse.

void ObjectWalkerScopeOptions::SetObjectWalkType ( WalkType inWalkType )

inline

Sets the value of walk type for the walker

Parameters

inWalkType specifies the value for type of objects to be searched. It can be kAllFrames, kTextFrames, kGraphicFrames or kUnassignedFrames.

void ObjectWalkerScopeOptions::SetPageItemsToBeSearched ( UIDList inItemList )

inline

Sets the list of UID's that needs to be searched when scope type is selection

void ObjectWalkerScopeOptions::SetSearchScopeType ( SearchScopeType scopeType )

inline

Sets the search scope type for the walker

Parameters

scopeType specifies the value for search scope. It can be kAllDocuments, kDocument or kSelection

Public Types
enum	WalkType { kAllFrames, kTextFrames, kGraphicFrames, kUnassignedFrames }

enum	SearchScopeType { kAllDocuments, kDocument, kSelection }

Public Member Functions
	ObjectWalkerScopeOptions (bool16 includeMasterPages, bool16 includeLockedLayers, bool16 includeHiddenLayers, bool16 includeLockedStories, bool16 includeFootnotes, WalkType walkType, SearchScopeType scopeType)

bool16	GetIncludeMasterPages () const

void	SetIncludeMasterPages (bool16 inIncludeMasterPages)

bool16	GetIncludeLockedLayers () const

void	SetIncludeLockedLayers (bool16 inIncludeLockedLayers)

bool16	GetIncludeHiddenLayers () const

void	SetIncludeHiddenLayers (bool16 inIncludeHiddenLayers)

bool16	GetIncludeLockedStories () const

void	SetIncludeLockedStories (bool16 inIncludeLockedStories)

bool16	GetIncludeFootnotes () const

void	SetIncludeFootnotes (bool16 inIncludeFootnotes)

WalkType	GetObjectWalkType () const

void	SetObjectWalkType (WalkType inWalkType)

SearchScopeType	GetSearchScopeType () const

void	SetSearchScopeType (SearchScopeType scopeType)

UIDRef	GetDocumentToBeSearched () const

void	SetDocumentToBeSearched (UIDRef inDocRef)

UIDList	GetPageItemsToBeSearched () const

void	SetPageItemsToBeSearched (UIDList inItemList)