InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IFindChangeFormatData Class Referenceabstract
Inheritance diagram for IFindChangeFormatData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IFINDCHANGEFORMATDATA }
 
enum  FindChangeFormatDataType { kFindDialogType = 0, kChangeDialogType }
 

Public Member Functions

virtual FindChangeFormatDataType GetDialogType ()=0
 
virtual void SetDialogType (FindChangeFormatDataType type)=0
 
virtual IDataBaseGetTargetDB ()=0
 
virtual const AttributeBossListGetFindAttrsToApply (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const UIDGetFindCharStyle (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const UIDGetFindParaStyle (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const UIDGetObjectFindStyle ()=0
 
virtual void SetTargetDB (IDataBase *db)=0
 
virtual void SetFindAttrsToApply (const AttributeBossList *findList, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetFindCharStyle (const UID &styleName, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetFindParaStyle (const UID &styleName, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetObjectFindStyle (const UID &styleName)=0
 
virtual void ClearFindAttrsToApply (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const AttributeBossListGetChangeAttrsToApply (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const UIDGetChangeCharStyle (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const UIDGetChangeParaStyle (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const UIDGetObjectChangeStyle ()=0
 
virtual void SetChangeAttrsToApply (const AttributeBossList *changeList, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetChangeCharStyle (const UID &styleName, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetChangeParaStyle (const UID &styleName, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetObjectChangeStyle (const UID &styleName)=0
 
virtual void ClearChangeAttrsToApply (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const PMStringGetChangeXMLTag (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetChangeXMLTag (const PMString &tagName, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual const PMStringGetChangeCaseOption (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetChangeCaseOption (const PMString &tagName, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual
IFindChangeOptions::ChangeConditionsMode 
GetChangeConditionsMode (IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
virtual void SetChangeConditionsMode (IFindChangeOptions::ChangeConditionsMode chgConditionsMode, IFindChangeOptions::SearchMode mode=IFindChangeOptions::kTextSearch)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (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 specifying whether the format data is for find dialog or for change dialog
Enumerator
kFindDialogType 

Find Dialog

kChangeDialogType 

Change Dialog

Member Function Documentation

virtual void IFindChangeFormatData::ClearChangeAttrsToApply (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Clears the attributes which will be applied on found text/object

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
virtual void IFindChangeFormatData::ClearFindAttrsToApply (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Clears the attributes for which we will search for

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
virtual const AttributeBossList* IFindChangeFormatData::GetChangeAttrsToApply (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Gets the attributes which will be applied on found text/object

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
is a pointer to AttributeBossList
See Also
IFindChangeFormatData::SetChangeAttrsToApply
virtual const PMString& IFindChangeFormatData::GetChangeCaseOption (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Gets the ChangeCase Option that will be applied on found text/object

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
is of type PMString
See Also
IFindChangeFormatData::SetChangeCaseOption
virtual const UID& IFindChangeFormatData::GetChangeCharStyle (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Gets the character style to be applied on found text

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
is of type UID specifying character style's UID
See Also
IFindChangeFormatData::SetChangeCharStyle
virtual IFindChangeOptions::ChangeConditionsMode IFindChangeFormatData::GetChangeConditionsMode (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

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

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
IFindChangeOptions::ChangeConditionsMode
See Also
IFindChangeOptions::ChangeConditionsMode
IFindChangeFormatData::SetChangeConditionsMode
virtual const UID& IFindChangeFormatData::GetChangeParaStyle (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Gets the paragraph style to be applied on found text

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
is of type UID specifying paragraph style's UID
See Also
IFindChangeFormatData::SetChangeParaStyle
virtual const PMString& IFindChangeFormatData::GetChangeXMLTag (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Gets the XML tag that will be applied on found text/object

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
is of type PMString
See Also
IFindChangeFormatData::SetChangeXMLTag
virtual FindChangeFormatDataType IFindChangeFormatData::GetDialogType ()
pure virtual

Gets the dialog type for which this format data is being supplied

Returns
is of type IFindChangeFormatData::FindChangeFormatDataType
See Also
IFindChangeFormatData::FindChangeFormatDataType
IFindChangeFormatData::SetDialogType
virtual const AttributeBossList* IFindChangeFormatData::GetFindAttrsToApply (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Gets the attributes that will be searched for

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
is a pointer to AttributeBossList
See Also
IFindChangeFormatData::SetFindAttrsToApply
virtual const UID& IFindChangeFormatData::GetFindCharStyle (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Gets the character style that will be searched for

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
is character style's UID
See Also
IFindChangeFormatData::SetFindCharStyle
virtual const UID& IFindChangeFormatData::GetFindParaStyle (IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch)
pure virtual

Gets the paragraph style that will be searched for

Parameters
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
Returns
is paragraph style's UID
See Also
IFindChangeFormatData::SetFindParaStyle
virtual const UID& IFindChangeFormatData::GetObjectChangeStyle ()
pure virtual

Gets the object style to be applied on found object

Returns
is of type UID specifying object style's UID
See Also
IFindChangeFormatData::SetObjectStyle
virtual const UID& IFindChangeFormatData::GetObjectFindStyle ()
pure virtual

Gets the object style that will be searched for

Returns
is object style's UID
See Also
IFindChangeFormatData::SetFindParaStyle
virtual IDataBase* IFindChangeFormatData::GetTargetDB ()
pure virtual

Gets the data base of find/change attributes that are being specified

Returns
is a pointer to IDataBase interface
See Also
IFindChangeFormatData::SetTargetDB
virtual void IFindChangeFormatData::SetChangeAttrsToApply (const AttributeBossListchangeList,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

Sets attributes that will be applied on found text/object

Parameters
changeListis a pointer to AttributeBossList
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetChangeAttrsToApply
virtual void IFindChangeFormatData::SetChangeCaseOption (const PMStringtagName,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

Sets the ChangeCase Option that will be applied on found text/object

Parameters
tagNameis of type PMString specifying ChangeCase Option
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetChangeCaseOption
virtual void IFindChangeFormatData::SetChangeCharStyle (const UIDstyleName,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

Sets the character style that will be applied on found text

Parameters
styleNameis UID of the character style
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetChangeCharStyle
virtual void IFindChangeFormatData::SetChangeConditionsMode (IFindChangeOptions::ChangeConditionsMode chgConditionsMode,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

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

Parameters
chgConditionsModeis of type IFindChangeOptions::ChangeConditionsMode specifying the mode for change conditions
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::ChangeConditionsMode
IFindChangeOptions::SearchMode
IFindChangeFormatData::SetChangeConditionsMode
virtual void IFindChangeFormatData::SetChangeParaStyle (const UIDstyleName,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

Sets the paragraph style that will be applied on found text

Parameters
styleNameis UID of the paragraph style
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetChangeParaStyle
virtual void IFindChangeFormatData::SetChangeXMLTag (const PMStringtagName,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

Sets the XML tag that will be applied on found text/object

Parameters
tagNameis of type PMString specifying XML Tag
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetChangeXMLTag
virtual void IFindChangeFormatData::SetDialogType (FindChangeFormatDataType type)
pure virtual

Sets the dialog type for which this format data is being supplied

Parameters
typeis of type IFindChangeFormatData::FindChangeFormatDataType
See Also
IFindChangeFormatData::FindChangeFormatDataType
IFindChangeFormatData::GetDialogType
virtual void IFindChangeFormatData::SetFindAttrsToApply (const AttributeBossListfindList,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

Sets the attributes for which we will search for

Parameters
findListis a pointer to AttributeBossList
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetFindAttrsToApply
virtual void IFindChangeFormatData::SetFindCharStyle (const UIDstyleName,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

Sets the UID of character style to be searched for

Parameters
styleNameis of type UID
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetFindCharStyle
virtual void IFindChangeFormatData::SetFindParaStyle (const UIDstyleName,
IFindChangeOptions::SearchMode mode = IFindChangeOptions::kTextSearch 
)
pure virtual

Sets the UID of paragraph style to be searched for

Parameters
styleNameis of type UID
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetFindParaStyle
virtual void IFindChangeFormatData::SetObjectChangeStyle (const UIDstyleName)
pure virtual

Sets the object style that will be applied on found object

Parameters
styleNameis UID of the object style
modeis of type IFindChangeOptions::SearchMode specifying the mode of Find/Change
See Also
IFindChangeOptions::SearchMode
IFindChangeFormatData::GetObjectChangeStyle
virtual void IFindChangeFormatData::SetObjectFindStyle (const UIDstyleName)
pure virtual

Sets the UID of object style to be searched for

Parameters
styleNameis of type UID
See Also
IFindChangeFormatData::GetObjectFindStyle
virtual void IFindChangeFormatData::SetTargetDB (IDataBasedb)
pure virtual

Sets the database of find/change attributes

Parameters
dbis a pointer to IDataBase interface