#include <IMotionPresetMgr.h>

Inheritance diagram for IMotionPresetMgr:

Public Types
enum	{ kDefaultIID = IID_IMOTIONPRESETMANAGER }

Public Member Functions
virtual int32	GetNumPresets () const =0

virtual ErrorCode	GetNthPresetName (int32 index, PMString &pName) const =0

virtual ErrorCode	GetNthPresetDescription (int32 index, PMString *pDesc) const =0

virtual UID	GetNthPresetUID (int32 index) const =0

virtual bool	IsDefaultPreset (int32 index) const =0

virtual bool	CanEditNthPreset (int32 index) const =0

virtual bool	CanDeleteNthPreset (int32 index) const =0

virtual IMotionPresetData *	QueryNthPreset (int32 index) const =0

virtual int32	FindPreset (const PMString &pName, bool casesensitive=true) const =0

virtual int32	FindPreset (UID presetUID) const =0

virtual ErrorCode	InsertPreset (IPMUnknown *iMotionPreset, int32 atPosition=-1)=0

virtual ErrorCode	RemoveNthPreset (int32 index, bool deleteUID=true)=0

virtual PMString	GetUniquePresetName (PMString &baseName, const PMString &appendString=PMString(), bool casesensitive=true) const =0

virtual ErrorCode	SyncMotionPresetFileList ()=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 is the main interface for InDesign animation presets. This interface sits on the application or document workspace boss.

Member Function Documentation

virtual bool IMotionPresetMgr::CanDeleteNthPreset ( int32 index ) const

pure virtual

Returns true if the nth preset can be deleted.

Parameters

index the nth preset

Returns: true if preset edibable.

virtual bool IMotionPresetMgr::CanEditNthPreset ( int32 index ) const

pure virtual

Returns true if the nth preset can be edited.

Parameters

index the nth preset

Returns: true if preset edibable.

virtual int32 IMotionPresetMgr::FindPreset	(	const PMString &	pName,
		bool	casesensitive = `true`
	)		const

pure virtual

Searches the list for a preset with the specified name.

Parameters

name	IN The name of the style to look for.
casesensitive	is true if doing case sensitive preset name comparison. The default is to do case sensitive comparison.

Returns: The index of the style, or -1 if it wasn't found.

virtual int32 IMotionPresetMgr::FindPreset ( UID presetUID ) const

pure virtual

Searches the list for a preset with the specified UID.

Parameters

presetUID IN The UID of the preset to look for.

Returns: The index of the preset, or -1 if it wasn't found.

virtual ErrorCode IMotionPresetMgr::GetNthPresetDescription	(	int32	index,
		PMString *	pDesc
	)		const

pure virtual

Get the description of the Nth preset.

Parameters

index	IN The index of the preset you're interested in.
pDesc	OUT Receives the description of the preset.

Returns: An error code or kSuccess if successful.

virtual ErrorCode IMotionPresetMgr::GetNthPresetName	(	int32	index,
		PMString &	pName
	)		const

pure virtual

Obtains the name of the Nth preset.

Parameters

index	IN The index of the preset you're interested in.
pName	OUT Receives the name of the preset.

Returns: An error code or kSuccess if successful.

virtual UID IMotionPresetMgr::GetNthPresetUID ( int32 index ) const

pure virtual

Get the UID of the Nth preset object. From this you can get/set the client items. Note that this only is used by preset lists that use UIDList-based storage.

Parameters

index IN The style to obtain the UIDRef for.

Returns: The UIDRef of the style.

virtual int32 IMotionPresetMgr::GetNumPresets ( ) const

pure virtual

Returns the number of motion presets in the list.

Returns: The number of motion presets.

virtual PMString IMotionPresetMgr::GetUniquePresetName	(	PMString &	baseName,
		const PMString &	appendString = `PMString()`,
		bool	casesensitive = `true`
	)		const

pure virtual

Generate a unique preset name. If the base string is empty, the the new will look something like: Motion Preset 1, Motion Preset 2. If the base string contains an exisiting style name, then the new name will look something like: <original name>=""> copy 1, <original name>=""> copy 2.

Parameters

baseName	IN The base name for which you want a unique name.
appendString	IN the string to append before the name. If not specified, the default is " ". Translate the appendstring first.
casesensitive	is true if doing case sensitive preset name comparison. The default is to do case sensitive comparison.

Returns: A unique name (ie, a version of baseName that is not currently in the list).

virtual ErrorCode IMotionPresetMgr::InsertPreset	(	IPMUnknown *	iMotionPreset,
		int32	atPosition = `-1`
	)

pure virtual

Adds a new preset with specified initial name. If the name is already in the list, the function fails.

Parameters

iMotionPreset	IN The new preset to insert
atPosition	IN The position to insert at. If atPosition is -1, the new preset is added at the end.

virtual bool IMotionPresetMgr::IsDefaultPreset ( int32 index ) const

pure virtual

Returns true if the nth preset is an InDesign default preset.

Parameters

index the nth preset

Returns: true if it's a default preset.

virtual IMotionPresetData* IMotionPresetMgr::QueryNthPreset ( int32 index ) const

pure virtual

Returns IMotionPresetData for the nth preset.

Parameters

index the nth preset

Returns: IMotionPresetData* to nth preset

virtual ErrorCode IMotionPresetMgr::RemoveNthPreset	(	int32	index,
		bool	deleteUID = `true`
	)

pure virtual

Deletes a preset.

Parameters

index	IN The index of the preset to delete.
deleteUID	IN true if the UID representing the motion preset is to be deleted from the DB.

Returns: Error code, or kSuccess if successful.

virtual ErrorCode IMotionPresetMgr::SyncMotionPresetFileList ( )

pure virtual

Internal use only.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation