#include <IModifyTOCFormatInfoCmdData.h>

Inheritance diagram for IModifyTOCFormatInfoCmdData:

Public Types
enum	{ kDefaultIID = IID_IMODIFYTOCFORMATINFOCMDDATA }

Public Member Functions
virtual void	Set (const UIDRef &target, const UIDRef &styleRef, const PMString &styleName, bool16 isParaStyle, bool16 isRename, const UIDRef &replaceUIDRef)=0

virtual const UIDRef &	GetTarget () const =0

virtual void	SetTarget (const UIDRef &target)=0

virtual const UIDRef &	GetStyleRef () const =0

virtual void	SetStyleRef (const UIDRef &styleRef)=0

virtual const PMString &	GetStyleName () const =0

virtual void	SetStyleName (const PMString &styleName)=0

virtual const bool16 &	IsParaStyle () const =0

virtual void	SetParaStyleFlag (const bool16 &paraStyleFlag)=0

virtual const bool16 &	IsRename () const =0

virtual void	SetRenameFlag (const bool16 &renameFlag)=0

virtual const UIDRef &	GetReplaceUIDRef () const =0

virtual void	SetReplaceUIDRef (const UIDRef &replaceUIDRef)=0

virtual const ICommand::CommandState	GetCmdState () const =0

virtual void	SetCmdState (const ICommand::CommandState state)=0

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

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This interface is for accessing command data related to ModifyTOCFormatInfoCmd. ModifyTOCFormatInfoCmd is used for repairing the format information for table of content styles when those format table of content entry styles(paragraph or chracter styles) are being deleted or modified. In future release, we will use reference index to do the repair work and this interface may be obsolete.

See Also: kModifyTOCFormatInfoCmdBoss.

Member Function Documentation

virtual const ICommand::CommandState IModifyTOCFormatInfoCmdData::GetCmdState ( ) const

pure virtual

This function is deprecated since InDesign 2.0. It is NOT used in InDesign's core code base.

Parameters

none

Returns: ICommand::CommandState the command state.

virtual const UIDRef& IModifyTOCFormatInfoCmdData::GetReplaceUIDRef ( ) const

pure virtual

Get the UIDRef of the updated format style.

Parameters

none

Returns: const UIDRef& the updated format style.

virtual const PMString& IModifyTOCFormatInfoCmdData::GetStyleName ( ) const

pure virtual

Get the original name of deleted or edited paragraph or character style.

Parameters

none

Returns: const PMString& the original name of deleted or edited paragraph or character style.

virtual const UIDRef& IModifyTOCFormatInfoCmdData::GetStyleRef ( ) const

pure virtual

Get the UIDRef of deleted or edited paragraph or character style.

Parameters

none

Returns: const UIDRef& the delete or edited paragraph or character style.

virtual const UIDRef& IModifyTOCFormatInfoCmdData::GetTarget ( ) const

pure virtual

Get the UIDRef for the session or document workspace which we use to instantiate corresponding the table of content style name table and other style name table.

Parameters

none

Returns: const UIDRef& the UIDRef of session or document workspace.

virtual const bool16& IModifyTOCFormatInfoCmdData::IsParaStyle ( ) const

pure virtual

Get the boolean data about if the deleted or edited style is a paragraph style or not.

Parameters

none

Returns: const bool16& kTrue means it is a paragraph style, otherwise kFalse.

virtual const bool16& IModifyTOCFormatInfoCmdData::IsRename ( ) const

pure virtual

Get the boolean data indicating if the edited style is just a rename action or not. This flag is to optimize certain action. For example, if the format style is a character style and we just rename the style, then we should not do anything since we cache the UID for character style and rename does not change UID.

Parameters

none

Returns: const bool16& kTrue means the style is renamed, otherwise kFalse.

virtual void IModifyTOCFormatInfoCmdData::Set	(	const UIDRef &	target,
		const UIDRef &	styleRef,
		const PMString &	styleName,
		bool16	isParaStyle,
		bool16	isRename,
		const UIDRef &	replaceUIDRef
	)

pure virtual

Set all the data for processing ModifyTOCFormatInfoCmd.

Parameters

target	IN the session or document workspace where the format style resides on.
styleRef	IN the UIDRef of the format style(paragraph style or character style)
styleName	IN the original name of the format style.
isParaStyle	IN flag indicates if it is paragraph style or not.
isRename	IN flag indicates if the edited style is renamed or not. This is to optimize certain action. For example, if the format style is a character style and we just rename the style, then we should not do anything since we cache the UID for character style and rename does not change UID.
replaceUIDRef	IN the UIDRef for the updated format style.

virtual void IModifyTOCFormatInfoCmdData::SetCmdState ( const ICommand::CommandState state )

pure virtual

This function is deprecated since InDesign 2.0. It is NOT used in InDesign's core code base.

Parameters

state the command state to be set.

virtual void IModifyTOCFormatInfoCmdData::SetParaStyleFlag ( const bool16 & paraStyleFlag )

pure virtual

Set the boolean flag regarding the deleted or edited style is a paragraph style or not.

Parameters

paraStyleFlag IN the boolean data to be set.

virtual void IModifyTOCFormatInfoCmdData::SetRenameFlag ( const bool16 & renameFlag )

pure virtual

Set the flag indicates if the edited style is renamed or not.

Parameters

renameFlag IN the boolean flag to be set.

virtual void IModifyTOCFormatInfoCmdData::SetReplaceUIDRef ( const UIDRef & replaceUIDRef )

pure virtual

Set the updated format style.

Parameters

replaceUIDRef IN the style to be set.

virtual void IModifyTOCFormatInfoCmdData::SetStyleName ( const PMString & styleName )

pure virtual

Set the original name of deleted or edited paragraph or character style.

Parameters

styleName IN the original name.

virtual void IModifyTOCFormatInfoCmdData::SetStyleRef ( const UIDRef & styleRef )

pure virtual

Set the UIDRef of deleted or edited paragraph or character style.

Parameters

styleRef IN UIDRef of the deleted or edited paragraph or character style.

virtual void IModifyTOCFormatInfoCmdData::SetTarget ( const UIDRef & target )

pure virtual

Set the target of the session or document workspace.

Parameters

target IN the UIDRef of session or document workspace to be set.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation