Inheritance diagram for IFindChangeOptions:

Public Types
enum	{ kDefaultIID = IID_IFINDCHANGEOPTIONS }

enum	SearchMode { kTextSearch, kGrepSearch, kGlyphSearch, kObjectSearch, kTransliterateSearch, kColorSearch }

enum	ChangeMode { kChange, kTransliterate }

enum	CharacterType { kKanji, kHalfWidthKatakana, kHalfWidthRoman, kFullWidthHiragana, kFullWidthKatakana, kFullWidthRoman, kNone, kWesternArabicDigits, kArabicIndicDigits, kFarsiDigits }

enum	ObjectType { kAllFrames, kTextFrames, kGraphicFrames, kUnassignedFrames }

enum	ChangeConditionsMode { kChangeReplacesConditions, kChangeAddsConditions }

enum	SearchDirection { kForward, kBackward }

Public Member Functions
virtual bool16	GetCaseSensitive (SearchMode mode) const =0

virtual void	SetCaseSensitive (bool16 caseSensitive, SearchMode mode)=0

virtual bool16	GetKanaSensitive (SearchMode mode) const =0

virtual void	SetKanaSensitive (bool16 kanaSensitive, SearchMode mode)=0

virtual bool16	GetWidthSensitive (SearchMode mode) const =0

virtual void	SetWidthSensitive (bool16 widthSensitive, SearchMode mode)=0

virtual IFindChangeOptions::SearchMode	GetSearchMode () const =0

virtual void	SetSearchMode (IFindChangeOptions::SearchMode mode)=0

virtual IFindChangeOptions::ChangeMode	GetChangeMode () const =0

virtual void	SetChangeMode (IFindChangeOptions::ChangeMode changeMode)=0

virtual void	SetFindCharacterType (IFindChangeOptions::CharacterType charType)=0

virtual IFindChangeOptions::CharacterType	GetFindCharacterType () const =0

virtual bool16	GetIncludeLockedStoriesForFind (SearchMode mode) const =0

virtual void	SetIncludeLockedStoriesForFind (bool16 includeLockedStories, SearchMode mode)=0

virtual bool16	GetIncludeLockedLayersForFind (SearchMode mode) const =0

virtual void	SetIncludeLockedLayersForFind (bool16 includeLockedLayers, SearchMode mode)=0

virtual bool16	GetIncludeHiddenLayers (SearchMode mode) const =0

virtual void	SetIncludeHiddenLayers (bool16 includeHiddenLayers, SearchMode mode)=0

virtual bool16	GetIncludeMasterPages (SearchMode mode) const =0

virtual void	SetIncludeMasterPages (bool16 includeMasterPages, SearchMode mode)=0

virtual bool16	GetIncludeFootnotes (SearchMode mode) const =0

virtual void	SetIncludeFootnotes (bool16 includeFootnotes, SearchMode mode)=0

virtual bool16	GetSearchBackwards (SearchMode mode) const =0

virtual void	SetSearchBackwards (bool16 searchBackwards, SearchMode mode)=0

virtual void	SetReplaceCharacterType (IFindChangeOptions::CharacterType charType)=0

virtual IFindChangeOptions::CharacterType	GetReplaceCharacterType () const =0

virtual bool16	GetEntireWord (SearchMode mode) const =0

virtual void	SetEntireWord (bool16 entireWord, SearchMode mode)=0

virtual IWalkerScopeFactoryUtils::WalkScopeType	GetFindChangeScope (SearchMode mode) const =0

virtual void	SetFindChangeScope (IWalkerScopeFactoryUtils::WalkScopeType findChangeScope, SearchMode mode)=0

virtual const WideString &	GetFindString (SearchMode mode) const =0

virtual void	SetFindString (const WideString &findString, SearchMode mode)=0

virtual const WideString &	GetReplaceString (SearchMode mode) const =0

virtual void	SetReplaceString (const WideString &replaceString, SearchMode mode)=0

virtual const AttributeBossList *	GetFindAttributeBossList (IDataBase *targetDB, SearchMode mode) const =0

virtual void	ApplyToFindAttributeBossList (const AttributeBossList findList, IDataBase targetDB, SearchMode mode)=0

virtual void	RemoveFindAttribute (ClassID removeAttribute, SearchMode mode)=0

virtual void	ClearFindAttributeBossList (SearchMode mode)=0

virtual const AttributeBossList *	GetChangeAttributeBossList (IDataBase *targetDB, SearchMode mode, bool16 allowCreation=kTrue) const =0

virtual void	ApplyToChangeAttributeBossList (const AttributeBossList findList, IDataBase targetDB, SearchMode mode)=0

virtual void	RemoveChangeAttribute (ClassID removeAttribute, SearchMode mode)=0

virtual void	ClearChangeAttributeBossList (SearchMode mode)=0

virtual void	ClearFindCharStyle (SearchMode mode)=0

virtual void	ClearFindParaStyle (SearchMode mode)=0

virtual void	ClearObjectFindStyle ()=0

virtual void	ClearChangeCharStyle (SearchMode mode)=0

virtual void	ClearChangeParaStyle (SearchMode mode)=0

virtual void	ClearObjectChangeStyle ()=0

virtual void	SetFindCharStyle (const UID &s, IDataBase *targetDB, SearchMode mode)=0

virtual void	SetFindParaStyle (const UID &s, IDataBase *targetDB, SearchMode mode)=0

virtual void	SetObjectFindStyle (const UID &s, IDataBase *targetDB)=0

virtual void	SetChangeCharStyle (const UID &s, IDataBase *targetDB, SearchMode mode)=0

virtual void	SetChangeParaStyle (const UID &s, IDataBase *targetDB, SearchMode mode)=0

virtual void	SetObjectChangeStyle (const UID &s, IDataBase *targetDB)=0

virtual const UID &	GetFindCharStyle (IDataBase *targetDB, SearchMode mode) const =0

virtual const UID &	GetFindParaStyle (IDataBase *targetDB, SearchMode mode) const =0

virtual const UID &	GetObjectFindStyle (IDataBase *targetDB) const =0

virtual const UID &	GetChangeCharStyle (IDataBase *targetDB, SearchMode mode, bool16 allowCreation=kTrue) const =0

virtual const UID &	GetChangeParaStyle (IDataBase *targetDB, SearchMode mode, bool16 allowCreation=kTrue) const =0

virtual const UID &	GetObjectChangeStyle (IDataBase *targetDB, bool16 allowCreation=kFalse) const =0

virtual bool16	IsThereSomethingToFind (IDataBase *targetDB, SearchMode mode) const =0

virtual IDataBase *	GetUIDAttrDB () const =0

virtual void	Init (bool16 caseSensitive, bool16 entireWord, bool16 kanaSensitive, bool16 widthSensitive, SearchMode searchMode, ChangeMode changeMode, CharacterType findCharacterType, CharacterType replaceCharacterType, IWalkerScopeFactoryUtils::WalkScopeType findChangeScope, const WideString &findString, const WideString &replaceString, const AttributeBossList findAttributeBossList, const AttributeBossList changeAttributeBossList, IDataBase *targetDB, const UID &findCharStyle, const UID &findParaStyle, const UID &changeCharStyle, const UID &changeParaStyle, bool16 grepFlag, bool16 includeMasterPages, bool16 includeLockedLayersForFind, bool16 includeLockedStoriesForFind, bool16 includeHiddenLayers, bool16 includeFootnotes, bool16 searchBackwards, Text::GlyphID findGlyphID, Text::GlyphID replaceGlyphID)=0

virtual void	Clear ()=0

virtual bool16	GetGrepFlag () const =0

virtual void	SetGrepFlag (bool16 grepFlag)=0

virtual void	SetChangeXMLTag (const PMString &tagName, SearchMode mode)=0

virtual const PMString &	GetChangeXMLTag (SearchMode mode) const =0

virtual void	ClearChangeXMLTag (SearchMode mode)=0

virtual void	SetChangeCaseOption (const PMString &caseOption, SearchMode mode)=0

virtual const PMString &	GetChangeCaseOption (SearchMode mode) const =0

virtual void	ClearChangeCaseOption (SearchMode mode)=0

virtual const Text::GlyphID	GetFindGlyphID () const =0

virtual void	SetFindGlyphID (const Text::GlyphID findGlyphID)=0

virtual void	SetFindROSFontGroup (const PMString &registry, const PMString &ordering)=0

virtual void	GetFindROSFontGroup (PMString &registry, PMString &ordering) const =0

virtual void	SetUseFindROSFontGroup (const bool16 bUseROSFontGroup)=0

virtual const bool16	GetUseFindROSFontGroup () const =0

virtual const Text::GlyphID	GetReplaceGlyphID () const =0

virtual void	SetReplaceGlyphID (const Text::GlyphID replaceGlyphID)=0

virtual void	SetReplaceROSFontGroup (const PMString &registry, const PMString &ordering)=0

virtual void	GetReplaceROSFontGroup (PMString &registry, PMString &ordering) const =0

virtual void	SetUseReplaceROSFontGroup (const bool16 bUseROSFontGroup)=0

virtual const bool16	GetUseReplaceROSFontGroup () const =0

virtual void	SetObjectSearchType (const ObjectType objType)=0

virtual const ObjectType	GetObjectSearchType () const =0

virtual void	SetChangeConditionsMode (ChangeConditionsMode chgConditionsMode, SearchMode mode)=0

virtual IFindChangeOptions::ChangeConditionsMode	GetChangeConditionsMode (SearchMode mode) const =0

virtual void	ClearChangeConditionsMode (SearchMode mode)=0

virtual void	InitializeDB ()=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Enumeration Documentation

anonymous enum

Standard enum to for use with GetDefaultIID() method.

enum IFindChangeOptions::ChangeConditionsMode

Enum for distinguishing between change conditions replacing applied conditions or adding to applied conditions.
Enumerator
kChangeReplacesConditions
For replacing applied conditions.
kChangeAddsConditions
For adding to applied conditions.

enum IFindChangeOptions::ChangeMode

Enum for distinguishing between substituting text and changing
Enumerator
kChange
For Changing text
kTransliterate
For Substituing text

enum IFindChangeOptions::CharacterType

Enum for distinguishing character type in CJK
Enumerator
kKanji
Kanji
kHalfWidthKatakana
Half width Katakana
kHalfWidthRoman
Half width Roman
kFullWidthHiragana
Full width Hiragana
kFullWidthKatakana
Full width Katakana
kFullWidthRoman
Full width Roman
kNone
None

enum IFindChangeOptions::ObjectType

Enum for specifying the types of objects to search
Enumerator
kAllFrames
All Frames
kTextFrames
Text Frames
kGraphicFrames
Graphic Frames
kUnassignedFrames
Unassigned Frames

enum IFindChangeOptions::SearchDirection

Enum for distinguishing between forward and backward search.

enum IFindChangeOptions::SearchMode

Enum for specifying Find/Change mode.
Enumerator
kTextSearch
Text Find/Change Mode
kGrepSearch
Grep Find/Change Mode
kGlyphSearch
Glyph Find/Change Mode
kObjectSearch
Object Find/Change Mode
kTransliterateSearch
Transliterate Find/Change Mode
kColorSearch
Color Find/Change Mode

Member Function Documentation

virtual void IFindChangeOptions::ApplyToChangeAttributeBossList	(	const AttributeBossList *	findList,
		IDataBase *	targetDB,
		SearchMode	mode
	)

pure virtual

Sets the attributes that will be applied to found text/object

Parameters

findList	is a poiner to AttributeBossList
targetDB	is a pointer to IDataBase
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetChangeAttributeBossList

virtual void IFindChangeOptions::ApplyToFindAttributeBossList	(	const AttributeBossList *	findList,
		IDataBase *	targetDB,
		SearchMode	mode
	)

pure virtual

Sets the attributes to search for

Parameters

findList	is a pointer to AttributeBossList
targetDB	is a pointer to IDataBase
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetFindAttributeBossList

virtual void IFindChangeOptions::Clear ( )

pure virtual

Resets the find/change options

virtual void IFindChangeOptions::ClearChangeAttributeBossList ( SearchMode mode )

pure virtual

Clears the attributes that will be applied to found text/object

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearChangeCaseOption ( SearchMode mode )

pure virtual

Resets the ChangeCaseOption tag that will be applied to found text to ""

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearChangeCharStyle ( SearchMode mode )

pure virtual

Clears the character style that will be applied to found text/object

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearChangeConditionsMode ( SearchMode mode )

pure virtual

Resets the change conditions mode that will be applied to found text to IFindChangeOptions::kChangeReplacesConditions.

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearChangeParaStyle ( SearchMode mode )

pure virtual

Clears the paragraph style that will be applied to found text/object

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearChangeXMLTag ( SearchMode mode )

pure virtual

Resets the XML tag that will be applied to found text to ""

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearFindAttributeBossList ( SearchMode mode )

pure virtual

For resetting the find attributes

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearFindCharStyle ( SearchMode mode )

pure virtual

Clears the character style that will be found

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearFindParaStyle ( SearchMode mode )

pure virtual

Clears the paragraph style that will be found

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::ClearObjectChangeStyle ( )

pure virtual

Clears the object style that will be applied to found object

virtual void IFindChangeOptions::ClearObjectFindStyle ( )

pure virtual

Clears the object style that will be found

virtual bool16 IFindChangeOptions::GetCaseSensitive ( SearchMode mode ) const

pure virtual

Gets "Case Sensitive" find option

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if case sensitive option is on and "kFalse" if it is off.

See Also: IFindChangeOptions::SetCaseSensitive

virtual const AttributeBossList* IFindChangeOptions::GetChangeAttributeBossList	(	IDataBase *	targetDB,
		SearchMode	mode,
		bool16	allowCreation = `kTrue`
	)		const

pure virtual

Gets the attributes that will be applied to found text/object

Parameters

targetDB	is a pointer to attributes database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Parameters

allowCreation is a boolean value indicating whether the attributes need to be created or not if the attributes do not exist

Returns: value is a pointer to AttributeBossList

See Also: IFindChangeOptions::ApplyToChangeAttributeBossList

virtual const PMString& IFindChangeOptions::GetChangeCaseOption ( SearchMode mode ) const

pure virtual

Gets the ChangeCase Option that will be applied to found text

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: value is a PMString

See Also: IFindChangeOptions::SetChangeCaseOption

virtual const UID& IFindChangeOptions::GetChangeCharStyle	(	IDataBase *	targetDB,
		SearchMode	mode,
		bool16	allowCreation = `kTrue`
	)		const

pure virtual

Get the character style that will be applied to found text

Parameters

targetDB	is a pointer to character style's database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: value is character style's UID

See Also: IFindChangeOptions::SetChangeCharStyle

virtual IFindChangeOptions::ChangeConditionsMode IFindChangeOptions::GetChangeConditionsMode ( SearchMode mode ) const

pure virtual

Gets the change conditions mode that will be applied to found text

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: IFindChangeOptions::ChangeConditionsMode

See Also: IFindChangeOptions::ChangeConditionsMode; IFindChangeOptions::SetChangeConditionsMode

virtual IFindChangeOptions::ChangeMode IFindChangeOptions::GetChangeMode ( ) const

pure virtual

Gets the option that distinguishes Find/Change from Transliterate

Returns: IFindChangeOptions::ChangeMode

See Also: IFindChangeOptions::ChangeMode; IFindChangeOptions::SetChangeMode

virtual const UID& IFindChangeOptions::GetChangeParaStyle	(	IDataBase *	targetDB,
		SearchMode	mode,
		bool16	allowCreation = `kTrue`
	)		const

pure virtual

Get the paragraph style that will be applied to found text

Parameters

targetDB	is a pointer to paragraph style's database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: value is paragraph style's UID

See Also: IFindChangeOptions::SetChangeParaStyle

virtual const PMString& IFindChangeOptions::GetChangeXMLTag ( SearchMode mode ) const

pure virtual

Gets the XML Tag that will be applied to found text

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: value is a PMString

See Also: IFindChangeOptions::SetChangeXMLTag

virtual bool16 IFindChangeOptions::GetEntireWord ( SearchMode mode ) const

pure virtual

Gets "Entire Word" option

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if entire word option is on and "kFalse" if it is off

See Also: IFindChangeOptions::SetEntireWord

virtual const AttributeBossList* IFindChangeOptions::GetFindAttributeBossList	(	IDataBase *	targetDB,
		SearchMode	mode
	)		const

pure virtual

Gets the attributes being searched for

Parameters

targetDB	is a pointer to IDataBase specifying the database of the attributes
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: value is a pointer to AttributeBossList

See Also: IFindChangeOptions::ApplyToFindAttributeBossList

virtual IWalkerScopeFactoryUtils::WalkScopeType IFindChangeOptions::GetFindChangeScope ( SearchMode mode ) const

pure virtual

Gets the scope in which find/change option will be operating

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: IWalkerScopeFactoryUtils::WalkScopeType

See Also: IWalkerScopeFactoryUtils::WalkScopeType; IFindChangeOptions::SetFindChangeScope

virtual IFindChangeOptions::CharacterType IFindChangeOptions::GetFindCharacterType ( ) const

pure virtual

When transliterating, gets the options for the type being searched for and the character type to replace with

Returns: IFindChangeOptions::CharacterType

See Also: IFindChangeOptions::CharacterType; IFindChangeOptions::SetFindCharacterType

virtual const UID& IFindChangeOptions::GetFindCharStyle	(	IDataBase *	targetDB,
		SearchMode	mode
	)		const

pure virtual

Gets the character style that will be found

Parameters

targetDB	is a pointer to character style's database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: value is character style's UID

See Also: IFindChangeOptions::SetFindCharStyle

virtual const Text::GlyphID IFindChangeOptions::GetFindGlyphID ( ) const

pure virtual

Glyph ID, type, font, style (find and replace) Find Gets the glyph id to be found

Returns: value is of type Text::GlyphID

See Also: IFindChangeOptions::SetFindGlyphID

virtual const UID& IFindChangeOptions::GetFindParaStyle	(	IDataBase *	targetDB,
		SearchMode	mode
	)		const

pure virtual

Get the paragraph style that will be found

Parameters

targetDB	is a pointer to paragraph style's database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: value is paragraph style's UID

See Also: IFindChangeOptions::SetFindParaStyle

virtual void IFindChangeOptions::GetFindROSFontGroup	(	PMString &	registry,
		PMString &	ordering
	)		const

pure virtual

Gets the ROS(Registry Ordered Supplement) font group of the glyph to be searched.

Returns: registry is of type PMString; ordering is of type PMString

virtual const WideString& IFindChangeOptions::GetFindString ( SearchMode mode ) const

pure virtual

Gets the string being searched for

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: the string being searched for

See Also: IFindChangeOptions::SetFindString

virtual bool16 IFindChangeOptions::GetGrepFlag ( ) const

pure virtual

Grep flag Gets whether grep search is being carried out or not.

Returns: value is kTrue if Grep is active otherwise it is kFalse

See Also: IFindChangeOptions::GetGrepFlag

virtual bool16 IFindChangeOptions::GetIncludeFootnotes ( SearchMode mode ) const

pure virtual

Gets "Include Footnotes" option

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if include footnotes option is on and "kFalse" if it is off

See Also: IFindChangeOptions::SetIncludeFootnotes

virtual bool16 IFindChangeOptions::GetIncludeHiddenLayers ( SearchMode mode ) const

pure virtual

Gets "Include Hidden Layers" option

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if include hidden layers option is on and "kFalse" if it is off

See Also: IFindChangeOptions::SetIncludeHiddenLayers

virtual bool16 IFindChangeOptions::GetIncludeLockedLayersForFind ( SearchMode mode ) const

pure virtual

Gets "Include Locked Layers" find option

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if include locked layers option is on and "kFalse" if it is off. This option is only for find i.e. we do not have option to change on locked layers.

See Also: IFindChangeOptions::SetIncludeLockedLayersForFind

virtual bool16 IFindChangeOptions::GetIncludeLockedStoriesForFind ( SearchMode mode ) const

pure virtual

Gets "Include Locked Stories" find option

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if include locked stories option is on and "kFalse" if it is off. This option is only for find i.e. we do not have option to change in locked stories

See Also: IFindChangeOptions::SetIncludeLockedStoriesForFind

virtual bool16 IFindChangeOptions::GetIncludeMasterPages ( SearchMode mode ) const

pure virtual

Gets "Include Master Pages" option

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if include master pages option is on and "kFalse" if it is off

See Also: IFindChangeOptions::SetIncludeMasterPages

virtual bool16 IFindChangeOptions::GetKanaSensitive ( SearchMode mode ) const

pure virtual

Gets the option that specifies whether the search is sensitive to katakana vs. hiragana character sets (Japanese)

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if kana sensitive option is on and "kFalse" if it is off.

See Also: IFindChangeOptions::SetKanaSensitive

virtual const UID& IFindChangeOptions::GetObjectChangeStyle	(	IDataBase *	targetDB,
		bool16	allowCreation = `kFalse`
	)		const

pure virtual

Get the object style that will be applied to found object

Parameters

targetDB	is a pointer to object style's database
allowCreation	pass kTrue if you want to create the style if it doesn't exist in targetDB

Returns: value is object style's UID

See Also: IFindChangeOptions::SetObjectChangeStyle

virtual const UID& IFindChangeOptions::GetObjectFindStyle ( IDataBase * targetDB ) const

pure virtual

Get the object style that will be found

Parameters

targetDB is a pointer to object style's database

Returns: value is find style's UID

See Also: IFindChangeOptions::SetObjectFindStyle

virtual const ObjectType IFindChangeOptions::GetObjectSearchType ( ) const

pure virtual

Gets whether object search should find all frames/text frames/graphic frames/unassigned frames.

Returns: is of type IFindChangeOptions::ObjectType

See Also: IFindChangeOptions::ObjectType; IFindChangeOptions::SetObjectSearchType

virtual IFindChangeOptions::CharacterType IFindChangeOptions::GetReplaceCharacterType ( ) const

pure virtual

When transliterating, gets the options for the character type to replace with

Returns: IFindChangeOptions::CharacterType

See Also: IFindChangeOptions::CharacterType; IFindChangeOptions::SetReplaceCharacterType

virtual const Text::GlyphID IFindChangeOptions::GetReplaceGlyphID ( ) const

pure virtual

Replace Gets the glyph id that will be placed in place of found glyph

Returns: is of type Text::GlyphID

See Also: IFindChangeOptions::SetReplaceGlyphID

virtual void IFindChangeOptions::GetReplaceROSFontGroup	(	PMString &	registry,
		PMString &	ordering
	)		const

pure virtual

Gets the ROS(Registry Ordered Supplement) font group of the glyph to be searched.

Returns: registry is of type PMString; ordering is of type PMString

virtual const WideString& IFindChangeOptions::GetReplaceString ( SearchMode mode ) const

pure virtual

Gets the string that will replace the found string

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: the string that will replace the found string

See Also: IFindChangeOptions::SetReplaceString

virtual bool16 IFindChangeOptions::GetSearchBackwards ( SearchMode mode ) const

pure virtual

Gets "Search backwards" option

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if search backwards option is on and "kFalse" if it is off

See Also: IFindChangeOptions::SetSearchBackwards

virtual IFindChangeOptions::SearchMode IFindChangeOptions::GetSearchMode ( ) const

pure virtual

Gets the Find/Change mode

Returns: IFindChangeOptions::SearchMode

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::SetSearchMode

virtual IDataBase* IFindChangeOptions::GetUIDAttrDB ( ) const

pure virtual

Gets the database of attributes

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: value is a pointer to database interface

virtual const bool16 IFindChangeOptions::GetUseFindROSFontGroup ( ) const

pure virtual

Get whether the glyph search is for a specific font or a ROS group.

Returns: value if of type bool16

virtual const bool16 IFindChangeOptions::GetUseReplaceROSFontGroup ( ) const

pure virtual

Get whether the glyph search is for a specific font or a ROS group.

Returns: value if of type bool16

virtual bool16 IFindChangeOptions::GetWidthSensitive ( SearchMode mode ) const

pure virtual

Japanese character sets have full and half-width options for hiragana, katakana, and Roman character sets This method lets us know whether find/change is width sensitive or not in the given mode

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

Returns: "kTrue" if width sensitive option is on and "kFalse" if it is off.

See Also: IFindChangeOptions::SetWidthSensitive

virtual void IFindChangeOptions::Init	(	bool16	caseSensitive,
		bool16	entireWord,
		bool16	kanaSensitive,
		bool16	widthSensitive,
		SearchMode	searchMode,
		ChangeMode	changeMode,
		CharacterType	findCharacterType,
		CharacterType	replaceCharacterType,
		IWalkerScopeFactoryUtils::WalkScopeType	findChangeScope,
		const WideString &	findString,
		const WideString &	replaceString,
		const AttributeBossList *	findAttributeBossList,
		const AttributeBossList *	changeAttributeBossList,
		IDataBase *	targetDB,
		const UID &	findCharStyle,
		const UID &	findParaStyle,
		const UID &	changeCharStyle,
		const UID &	changeParaStyle,
		bool16	grepFlag,
		bool16	includeMasterPages,
		bool16	includeLockedLayersForFind,
		bool16	includeLockedStoriesForFind,
		bool16	includeHiddenLayers,
		bool16	includeFootnotes,
		bool16	searchBackwards,
		Text::GlyphID	findGlyphID,
		Text::GlyphID	replaceGlyphID
	)

pure virtual

Initializes various options for a search mode

virtual bool16 IFindChangeOptions::IsThereSomethingToFind	(	IDataBase *	targetDB,
		SearchMode	mode
	)		const

pure virtual

The FindChangeOptions interface is in a unique position to know whether there is

adequate information defined on it to allow searching for "something". Without this method, calls throughout the code were asking the interface whether the length of the search string was greater than zero OR there was a special character or paragraph format to search for in various ways such as if (::SearchFormatExist() || !FindEditBoxEmpty()) This is worse with the addition of transliterate, where if in transliterate mode, the search string is irrelevant. Although this interface isn't responsible for performing a find, it's now a smart secretary, able to pack the boss's briefcase with all the necessary papers before the big meeting.

Parameters

targetDB	is a pointer to find/change options database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::RemoveChangeAttribute	(	ClassID	removeAttribute,
		SearchMode	mode
	)

pure virtual

Removes the specified attribute from the list of attributes that will be applied to found text/object

Parameters

removeAttribute	is of type ClassID specifying the class id of the attribute to be removed
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::RemoveFindAttribute	(	ClassID	removeAttribute,
		SearchMode	mode
	)

pure virtual

For Removing a specific attribute from the find attribute list

Parameters

removeAttribute	is of type ClassID specifying the classid of the attribute that needs to be removed from the attribute list
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode

virtual void IFindChangeOptions::SetCaseSensitive	(	bool16	caseSensitive,
		SearchMode	mode
	)

pure virtual

Sets "Case Sensitive" find option

Parameters

caseSensitive	is Boolean Value specifying the value to be set
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetCaseSensitive

virtual void IFindChangeOptions::SetChangeCaseOption	(	const PMString &	caseOption,
		SearchMode	mode
	)

pure virtual

Sets the ChangeCaseOption that will be applied to found text

Parameters

caseOption	is of type PMString specifying the case selected
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetChangeCaseOption

virtual void IFindChangeOptions::SetChangeCharStyle	(	const UID &	s,
		IDataBase *	targetDB,
		SearchMode	mode
	)

pure virtual

Sets the character style that will be applied to found text

Parameters

s	is the UID of the character style
targetDB	is the pointer to style's database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetChangeCharStyle

virtual void IFindChangeOptions::SetChangeConditionsMode	(	ChangeConditionsMode	chgConditionsMode,
		SearchMode	mode
	)

pure virtual

Sets the change conditions mode that will be applied to found text

Parameters

chgConditionsMode	is of type IFindChangeOptions::ChangeConditionsMode specifying the mode for change conditions
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::ChangeConditionsMode; IFindChangeOptions::SearchMode; IFindChangeOptions::GetChangeConditionsMode

virtual void IFindChangeOptions::SetChangeMode ( IFindChangeOptions::ChangeMode changeMode )

pure virtual

Sets the option that distinguishes Find/Change from Transliterate

Parameters

changeMode is of type IFindChangeOptions::ChangeMode

See Also: IFindChangeOptions::ChangeMode; IFindChangeOptions::GetChangeMode

virtual void IFindChangeOptions::SetChangeParaStyle	(	const UID &	s,
		IDataBase *	targetDB,
		SearchMode	mode
	)

pure virtual

Sets the paragraph style that will be applied to found text

Parameters

s	is the UID of the paragraph style
targetDB	is the pointer to style's database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetChangeParaStyle

virtual void IFindChangeOptions::SetChangeXMLTag	(	const PMString &	tagName,
		SearchMode	mode
	)

pure virtual

Sets the XML tag that will be applied to found text

Parameters

tagName	is of type PMString specifying the tag
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetChangeXMLTag

virtual void IFindChangeOptions::SetEntireWord	(	bool16	entireWord,
		SearchMode	mode
	)

pure virtual

Sets "Entire Word" option

Parameters

entireWord	is a Boolean value specifying whether entire word option should be turned on or off
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetEntireWord

virtual void IFindChangeOptions::SetFindChangeScope	(	IWalkerScopeFactoryUtils::WalkScopeType	findChangeScope,
		SearchMode	mode
	)

pure virtual

Sets the scope in which find/change option will be operating

Parameters

findChangeScope is of type IWalkerScopeFactoryUtils::WalkScopeType

See Also: IWalkerScopeFactoryUtils::WalkScopeType

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetFindChangeScope

virtual void IFindChangeOptions::SetFindCharacterType ( IFindChangeOptions::CharacterType charType )

pure virtual

When transliterating, sets the options for the type being searched for and the character type to replace with

Parameters

charType is of type IFindChangeOptions::CharacterType

See Also: IFindChangeOptions::CharacterType; IFindChangeOptions::GetFindCharacterType

virtual void IFindChangeOptions::SetFindCharStyle	(	const UID &	s,
		IDataBase *	targetDB,
		SearchMode	mode
	)

pure virtual

Sets the character style to be found

Parameters

s	is the UID of the character style
targetDB	is the pointer to style's database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetFindCharStyle

virtual void IFindChangeOptions::SetFindGlyphID ( const Text::GlyphID findGlyphID )

pure virtual

Sets the glyph id to be found

Parameters

findGlyphID is of type Text::GlyphID

See Also: IFindChangeOptions::GetFindGlyphID

virtual void IFindChangeOptions::SetFindParaStyle	(	const UID &	s,
		IDataBase *	targetDB,
		SearchMode	mode
	)

pure virtual

Sets the paragraph style to be found

Parameters

s	is the UID of the paragraph style
targetDB	is the pointer to style's database
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetFindParaStyle

virtual void IFindChangeOptions::SetFindROSFontGroup	(	const PMString &	registry,
		const PMString &	ordering
	)

pure virtual

Sets the ROS(Registry Ordered Supplement) font group of the glyph to be searched.

Parameters

registry	is of type PMString
ordering	is of type PMString

virtual void IFindChangeOptions::SetFindString	(	const WideString &	findString,
		SearchMode	mode
	)

pure virtual

Sets the string to search for

Parameters

findString	is of type WideString
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetFindString

virtual void IFindChangeOptions::SetGrepFlag ( bool16 grepFlag )

pure virtual

Sets the search mode to grep

Parameters

grepFlag is a boolean specifying the value

See Also: IFindChangeOptions::SetGrepFlag

virtual void IFindChangeOptions::SetIncludeFootnotes	(	bool16	includeFootnotes,
		SearchMode	mode
	)

pure virtual

Sets "Include Footnotes" option

Parameters

includeFootnotes	Boolean value for setting "Include Footnotes" option.
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetIncludeFootnotes

virtual void IFindChangeOptions::SetIncludeHiddenLayers	(	bool16	includeHiddenLayers,
		SearchMode	mode
	)

pure virtual

Sets "Include Hidden Layers" option

Parameters

includeHiddenLayers	Boolean value for setting "Include Hidden Layers" option.
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetIncludeHiddenLayers

virtual void IFindChangeOptions::SetIncludeLockedLayersForFind	(	bool16	includeLockedLayers,
		SearchMode	mode
	)

pure virtual

Sets "Include Locked Layers" find option

Parameters

includeLockedLayers	Boolean value for setting "Include Locked Layers" option. This option is only for find i.e. we do not have option to change on locked layers.
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetIncludeLockedLayersForFind

virtual void IFindChangeOptions::SetIncludeLockedStoriesForFind	(	bool16	includeLockedStories,
		SearchMode	mode
	)

pure virtual

Sets "Include Locked Stories" find option

Parameters

includeLockedStories	Boolean value for setting "Include Locked Stories" option. This option is only for find i.e. we do not have option to change in locked stories
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetIncludeLockedStoriesForFind

virtual void IFindChangeOptions::SetIncludeMasterPages	(	bool16	includeMasterPages,
		SearchMode	mode
	)

pure virtual

Sets "Include Master Pages" option

Parameters

includeMasterPages	Boolean value for setting "Include Master Pages" option.
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetIncludeMasterPages

virtual void IFindChangeOptions::SetKanaSensitive	(	bool16	kanaSensitive,
		SearchMode	mode
	)

pure virtual

Sets the option that specifies whether the search is sensitive to katakana vs. hiragana character sets (Japanese)

Parameters

kanaSensitive	is Boolean value specifying the option to be set
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetKanaSensitive

virtual void IFindChangeOptions::SetObjectChangeStyle	(	const UID &	s,
		IDataBase *	targetDB
	)

pure virtual

Sets the obect style that will be applied to found obect

Parameters

s	is the UID of the object style
targetDB	is the pointer to style's database

See Also: IFindChangeOptions::GetObjectChangeStyle

virtual void IFindChangeOptions::SetObjectFindStyle	(	const UID &	s,
		IDataBase *	targetDB
	)

pure virtual

Sets the object style to be found

Parameters

s	is the UID of the object style
targetDB	is the pointer to style's database

See Also: IFindChangeOptions::GetObjectFindStyle

virtual void IFindChangeOptions::SetObjectSearchType ( const ObjectType objType )

pure virtual

Sets whether object search should find all frames/text frames/graphic frames/unassigned frames.

Parameters

objType is of type IFindChangeOptions::ObjectType

See Also: IFindChangeOptions::ObjectType; IFindChangeOptions::GetObjectSearchType

virtual void IFindChangeOptions::SetReplaceCharacterType ( IFindChangeOptions::CharacterType charType )

pure virtual

When transliterating, sets the options for the character type to replace with

Parameters

charType is of type IFindChangeOptions::CharacterType

See Also: IFindChangeOptions::CharacterType; IFindChangeOptions::GetReplaceCharacterType

virtual void IFindChangeOptions::SetReplaceGlyphID ( const Text::GlyphID replaceGlyphID )

pure virtual

Sets the glyph id that will be placed in place of found glyph

Parameters

replaceGlyphID is of type Text::GlyphID

See Also: IFindChangeOptions::GetReplaceGlyphID

virtual void IFindChangeOptions::SetReplaceROSFontGroup	(	const PMString &	registry,
		const PMString &	ordering
	)

pure virtual

Sets the ROS(Registry Ordered Supplement) font group of the glyph to be searched.

Parameters

registry	is of type PMString
ordering	is of type PMString

virtual void IFindChangeOptions::SetReplaceString	(	const WideString &	replaceString,
		SearchMode	mode
	)

pure virtual

Sets the string that will replace the found string

Parameters

replaeString	is of type WideString
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetReplaceString

virtual void IFindChangeOptions::SetSearchBackwards	(	bool16	searchBackwards,
		SearchMode	mode
	)

pure virtual

Sets "Search backwards" option

Parameters

searchBackwards	Boolean value for setting "Search backwards" option.
mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetSearchBackwards

virtual void IFindChangeOptions::SetSearchMode ( IFindChangeOptions::SearchMode mode )

pure virtual

Sets the Find/Change mode

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetSearchMode

virtual void IFindChangeOptions::SetUseFindROSFontGroup ( const bool16 bUseROSFontGroup )

pure virtual

Set whether the glyph search is for a specific font or a ROS group.

Parameters

bUseROSFontGroup is of type bool16

virtual void IFindChangeOptions::SetUseReplaceROSFontGroup ( const bool16 bUseROSFontGroup )

pure virtual

Set whether the glyph search is for a specific font or a ROS group.

Parameters

bUseROSFontGroup is of type bool16

virtual void IFindChangeOptions::SetWidthSensitive	(	bool16	widthSensitive,
		SearchMode	mode
	)

pure virtual

Japanese character sets have full and half-width options for hiragana, katakana, and Roman character sets This method sets whether find/change should be width sensitive or not in the given mode

Parameters

mode	is of type IFindChangeOptions::SearchMode specifying the mode of Find/Change

See Also: IFindChangeOptions::SearchMode; IFindChangeOptions::GetWidthSensitive

Enumerator
kChangeReplacesConditions	For replacing applied conditions.
kChangeAddsConditions	For adding to applied conditions.

Enumerator
kChange	For Changing text
kTransliterate	For Substituing text

Enumerator
kKanji	Kanji
kHalfWidthKatakana	Half width Katakana
kHalfWidthRoman	Half width Roman
kFullWidthHiragana	Full width Hiragana
kFullWidthKatakana	Full width Katakana
kFullWidthRoman	Full width Roman
kNone	None

Enumerator
kAllFrames	All Frames
kTextFrames	Text Frames
kGraphicFrames	Graphic Frames
kUnassignedFrames	Unassigned Frames

Enumerator
kTextSearch	Text Find/Change Mode
kGrepSearch	Grep Find/Change Mode
kGlyphSearch	Glyph Find/Change Mode
kObjectSearch	Object Find/Change Mode
kTransliterateSearch	Transliterate Find/Change Mode
kColorSearch	Color Find/Change Mode

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation