#include <WalkerScopeOptions.h>
Public Member Functions
WalkerScopeOptions (bool16 includeMasterPages, bool16 includeLockedLayers, bool16 includeHiddenLayers, bool16 includeLockedStories, bool16 includeFootnotes, bool16 searchBackwards)

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)

bool16 GetSearchBackwards () const

void SetSearchBackwards (bool16 inSearchBackwards)

Detailed Description

WalkerScopeOptions provides a way to convey the options for consideration to IWalkerScopeFactoryUtils while creating the ITextWalkerScope

Constructor & Destructor Documentation

WalkerScopeOptions::WalkerScopeOptions	(	bool16	includeMasterPages,
		bool16	includeLockedLayers,
		bool16	includeHiddenLayers,
		bool16	includeLockedStories,
		bool16	includeFootnotes,
		bool16	searchBackwards
	)

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.
searchBackwards	specifies whether to search backwards or not. kTrue for backwards and kFalse for forward search.

Member Function Documentation

bool16 WalkerScopeOptions::GetIncludeFootnotes ( ) const

inline

Returns the value of include footnotes option

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

bool16 WalkerScopeOptions::GetIncludeHiddenLayers ( ) const

inline

Returns the value of include hidden layers option

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

bool16 WalkerScopeOptions::GetIncludeLockedLayers ( ) const

inline

Returns the value of include locked layers option

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

bool16 WalkerScopeOptions::GetIncludeLockedStories ( ) const

inline

Returns the value of include locked stories option

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

bool16 WalkerScopeOptions::GetIncludeMasterPages ( ) const

inline

Returns the value of include master pages option

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

bool16 WalkerScopeOptions::GetSearchBackwards ( ) const

inline

Returns the value of search backwards option

Returns: kTrue if "search backwards" is on else kFalse

void WalkerScopeOptions::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 WalkerScopeOptions::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 WalkerScopeOptions::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 WalkerScopeOptions::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 WalkerScopeOptions::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 WalkerScopeOptions::SetSearchBackwards ( bool16 inSearchBackwards )

inline

Sets the value of search backwards option

Parameters

inSearchBackwards specifies the value for "search backwards" option. It can be kTrue/kFalse.

Public Member Functions
	WalkerScopeOptions (bool16 includeMasterPages, bool16 includeLockedLayers, bool16 includeHiddenLayers, bool16 includeLockedStories, bool16 includeFootnotes, bool16 searchBackwards)

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)

bool16	GetSearchBackwards () const

void	SetSearchBackwards (bool16 inSearchBackwards)