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

Public Types

enum  { kDefaultIID = IID_ISTYLEMAPPINGFACADE }
 

Public Member Functions

virtual ErrorCode AddStyleMappingRule (const UIDRef &itemRef, const IStyleMappings::MappingRule &mappingRule, const IStyleMappings::MappingStyleType &styleType, int32 &pos) const =0
 
virtual ErrorCode AddStyleMappingRule (const UIDList &itemList, const IStyleMappings::MappingRule &mappingRule, const IStyleMappings::MappingStyleType &styleType) const =0
 
virtual ErrorCode SetStyleMappingRule (const UIDList &itemList, const int32 index, const IStyleMappings::MappingRule &mappingRule, const IStyleMappings::MappingStyleType &styleType) const =0
 
virtual ErrorCode RemoveStyleMappingRule (const UIDList &itemList, const int32 index, const IStyleMappings::MappingStyleType &styleType) const =0
 
virtual ErrorCode ClearStyleMappings (const UIDList &itemList) const =0
 
virtual ErrorCode SetStyleMappings (const UIDList &itemList, const IStyleMappings *inMappingsData) const =0
 
virtual bool16 ValidateMappingStyleName (const PMString &styleName) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual ErrorCode Facade::IStyleMappingFacade::AddStyleMappingRule (const UIDRefitemRef,
const IStyleMappings::MappingRulemappingRule,
const IStyleMappings::MappingStyleTypestyleType,
int32 & pos 
) const
pure virtual

Adds a single mapping rule to the mapping data of the object.

Parameters
itemRefobject on which style mapping data needs to be changed. The object must have IStyleMappings interface.
mappingRule[IN] the mapping rule which needs to be added to the mapping data of the objects.
styleType[IN] the type of style to which the above mapping rule corresponds.
pos[OUT] the position at which the mapping rule was added, if addition was successful, else -1.
Returns
kSuccess if mapping is successfully added.
virtual ErrorCode Facade::IStyleMappingFacade::AddStyleMappingRule (const UIDListitemList,
const IStyleMappings::MappingRulemappingRule,
const IStyleMappings::MappingStyleTypestyleType 
) const
pure virtual

Adds a single mapping rule to the mapping data of the objects passed as a list.

Parameters
itemList[IN] the list of objects on which style mapping data needs to be changed. The objects must have IStyleMappings interface.
mappingRule[IN] the mapping rule which needs to be added to the mapping data of the objects.
styleType[IN] the type of style to which the above mapping rule corresponds.
Returns
kSuccess if mapping is successfully added.
virtual ErrorCode Facade::IStyleMappingFacade::ClearStyleMappings (const UIDListitemList) const
pure virtual

Changes a single mapping rule present at a specific location in the mapping data of the objects passed as a list.

Parameters
itemList[IN] the list of objects on which style mapping data needs to be changed. The objects must have IStyleMappings interface.
Returns
kSuccess if mapping data is successfully cleared.
virtual ErrorCode Facade::IStyleMappingFacade::RemoveStyleMappingRule (const UIDListitemList,
const int32 index,
const IStyleMappings::MappingStyleTypestyleType 
) const
pure virtual

Changes a single mapping rule present at a specific location in the mapping data of the objects passed as a list.

Parameters
itemList[IN] the list of objects on which style mapping data needs to be changed. The objects must have IStyleMappings interface.
index[IN] the index of the mapping rule to modify.
styleType[IN] the type of style to which the above mapping rule corresponds.
Returns
kSuccess if mapping rule is successfully removed.
virtual ErrorCode Facade::IStyleMappingFacade::SetStyleMappingRule (const UIDListitemList,
const int32 index,
const IStyleMappings::MappingRulemappingRule,
const IStyleMappings::MappingStyleTypestyleType 
) const
pure virtual

Changes a single mapping rule present at a specific location in the mapping data of the objects passed as a list.

Parameters
itemList[IN] the list of objects on which style mapping data needs to be changed. The objects must have IStyleMappings interface.
index[IN] the index of the mapping rule to modify.
mappingRule[IN] the mapping rule which needs to be added to the mapping data of the objects.
styleType[IN] the type of style to which the above mapping rule corresponds.
Returns
kSuccess if mapping rule is successfully changed.
virtual ErrorCode Facade::IStyleMappingFacade::SetStyleMappings (const UIDListitemList,
const IStyleMappingsinMappingsData 
) const
pure virtual

Changes a single mapping rule present at a specific location in the mapping data of the objects passed as a list.

Parameters
itemList[IN] the list of objects on which style mapping data needs to be changed. The objects must have IStyleMappings interface.
Returns
kSuccess if mapping data is successfully cleared.
virtual bool16 Facade::IStyleMappingFacade::ValidateMappingStyleName (const PMStringstyleName) const
pure virtual

checks if the mapping style name (or style group name) is a valid for style mapping.

Parameters
styleName[IN]the style name or the style group name to validate.
Returns
kTrue if the name is valid otherwise kFalse.