InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXRefFormatCmdData Class Referenceabstract

#include <IXRefFormatCmdData.h>

Inheritance diagram for IXRefFormatCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXREFFORMATCMDDATA }
 

Public Member Functions

virtual void SetName (const PMString &formatName)=0
 
virtual PMString GetName () const =0
 
virtual bool16 ChangingName () const =0
 
virtual void SetCharStyle (UID charStyle)=0
 
virtual UID GetCharStyle () const =0
 
virtual bool16 ChangingCharStyle () const =0
 
virtual void SetBuildingBlocks (const K2Vector< XRefBuildingBlock > &buildingBlocks)=0
 
virtual void GetBuildingBlocks (K2Vector< XRefBuildingBlock > &buildingBlocks) const =0
 
virtual bool16 ChangingBuildingBlocks () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Abstract interface to cross reference format command data.

See Also
kXRefBuildingBlockBoss

Member Function Documentation

virtual bool16 IXRefFormatCmdData::ChangingBuildingBlocks () const
pure virtual

Return kTrue if we are changing building blocks

Returns
bool16 - kTrue if building blocks are changed
virtual bool16 IXRefFormatCmdData::ChangingCharStyle () const
pure virtual

Return kTrue if we are changing the character style

Returns
bool16 - kTrue if character style is changed
virtual bool16 IXRefFormatCmdData::ChangingName () const
pure virtual

Return kTrue if we are changing the name

Returns
bool16 - kTrue if name is changed
virtual void IXRefFormatCmdData::GetBuildingBlocks (K2Vector< XRefBuildingBlock > & buildingBlocks) const
pure virtual

Get the building blocks list of the format

Parameters
K2Vector<XRefBuildingblock>&- [OUT]list of building blocks
virtual UID IXRefFormatCmdData::GetCharStyle () const
pure virtual

Get the character style of the format

Returns
UID - The character style UID of the format
virtual PMString IXRefFormatCmdData::GetName () const
pure virtual

Get the name of the format

Returns
PMString - The name of the format
virtual void IXRefFormatCmdData::SetBuildingBlocks (const K2Vector< XRefBuildingBlock > & buildingBlocks)
pure virtual

Set the building blocks list to the format

Parameters
buildingBlocks- building blocks list
virtual void IXRefFormatCmdData::SetCharStyle (UID charStyle)
pure virtual

Set the character style of the format

Parameters
charStyle- The new character style to use
virtual void IXRefFormatCmdData::SetName (const PMStringformatName)
pure virtual

Set the name of the format

Parameters
formatName- The new name to use