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

#include <IMotionPresetCmdData.h>

Inheritance diagram for IMotionPresetCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMOTIONPRESETCMDDATA }
 

Public Member Functions

virtual void SetCreateEmpty (bool createEmpty)=0
 
virtual void SetPresetName (const PMString &name)=0
 
virtual void SetPresetDescription (const PMString &description)=0
 
virtual void SetMotionPresetFile (const IDFile &presetFile)=0
 
virtual void SetMotionPresetData (const WideString &presetData)=0
 
virtual void SetUsePresetFile (const bool &useFile)=0
 
virtual void SetTargetDB (IDataBase *iDB)=0
 
virtual void SetIsCustomPreset (bool isCustom)=0
 
virtual bool GetCreateEmpty () const =0
 
virtual PMString GetPresetName () const =0
 
virtual PMString GetPresetDescription () const =0
 
virtual bool GetSetDescriptionFlag () const =0
 
virtual bool GetSetNameFlag () const =0
 
virtual void SetEditLocked (bool editLocked)=0
 
virtual void SetDeleteLocked (bool deleteLocked)=0
 
virtual void SetNameLocked (bool nameLocked)=0
 
virtual bool GetEditLockInfo () const =0
 
virtual bool GetDeleteLockInfo () const =0
 
virtual bool GetNameLockInfo () const =0
 
virtual bool GetSetEditLockInfo () const =0
 
virtual bool GetSetDeleteLockInfo () const =0
 
virtual bool GetSetNameLockInfo () const =0
 
virtual void GetMotionPresetFile (IDFile &presetFile) const =0
 
virtual void GetMotionPresetData (WideString &presetData) const =0
 
virtual bool GetUsePresetFile () const =0
 
virtual IDataBaseGetTargetDB () const =0
 
virtual bool GetIsCustomPreset () 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

Data interface apply motion preset file command.

Member Function Documentation

virtual bool IMotionPresetCmdData::GetCreateEmpty () const
pure virtual

Get the flag whether to create a default empty preset.

Returns
true if create a default empty preset
virtual bool IMotionPresetCmdData::GetDeleteLockInfo () const
pure virtual
Returns
the name lock info setting.
virtual bool IMotionPresetCmdData::GetEditLockInfo () const
pure virtual
Returns
the name lock info setting.
virtual bool IMotionPresetCmdData::GetIsCustomPreset () const
pure virtual

Get flag indicate whether or not the new preset is custom

Returns
true if custom preset
virtual void IMotionPresetCmdData::GetMotionPresetData (WideStringpresetData) const
pure virtual

Get the motion preset input.

Parameters
presetDatareturns the current motion preset data to use.
virtual void IMotionPresetCmdData::GetMotionPresetFile (IDFilepresetFile) const
pure virtual

Get the motion preset input.

Parameters
presetFilereturns the current motion preset file.
virtual bool IMotionPresetCmdData::GetNameLockInfo () const
pure virtual
Returns
the name lock info setting.
virtual PMString IMotionPresetCmdData::GetPresetDescription () const
pure virtual
Returns
the preset description.
virtual PMString IMotionPresetCmdData::GetPresetName () const
pure virtual
Returns
the preset name.
virtual bool IMotionPresetCmdData::GetSetDeleteLockInfo () const
pure virtual
Returns
set delete lock info flag.
virtual bool IMotionPresetCmdData::GetSetDescriptionFlag () const
pure virtual
Returns
true if description should be set.
virtual bool IMotionPresetCmdData::GetSetEditLockInfo () const
pure virtual
Returns
set edit lock info flag.
virtual bool IMotionPresetCmdData::GetSetNameFlag () const
pure virtual
Returns
true if name should be set.
virtual bool IMotionPresetCmdData::GetSetNameLockInfo () const
pure virtual
Returns
set name lock info flag.
virtual IDataBase* IMotionPresetCmdData::GetTargetDB () const
pure virtual

Get the target DataBase for this command

Returns
targetDB
virtual bool IMotionPresetCmdData::GetUsePresetFile () const
pure virtual

Get flag indicating whether to use IDFile or WideString for motion data

Returns
true if using a IDFile.
virtual void IMotionPresetCmdData::SetCreateEmpty (bool createEmpty)
pure virtual

Set the flag to indicate whether to create a default empty preset.

Parameters
createEmptyis true if create a default empty preset.
virtual void IMotionPresetCmdData::SetDeleteLocked (bool deleteLocked)
pure virtual

Sets the dellete lock info.

Parameters
deleteLockedis the lock info to set.
virtual void IMotionPresetCmdData::SetEditLocked (bool editLocked)
pure virtual

Sets the edit lock info.

Parameters
editLockedis the lock info to set.
virtual void IMotionPresetCmdData::SetIsCustomPreset (bool isCustom)
pure virtual

Get flag indicate whether or not the new preset is custom

Parameters
isCustombool.
virtual void IMotionPresetCmdData::SetMotionPresetData (const WideStringpresetData)
pure virtual

Sets motion preset data to apply

Parameters
presetDatais the WideString representing the motion preset data to add.
virtual void IMotionPresetCmdData::SetMotionPresetFile (const IDFilepresetFile)
pure virtual

Sets motion preset file to apply

Parameters
presetFileis the motion preset file to add.
virtual void IMotionPresetCmdData::SetNameLocked (bool nameLocked)
pure virtual

Sets the name lock info.

Parameters
nameLockedis the lock info to set.
virtual void IMotionPresetCmdData::SetPresetDescription (const PMStringdescription)
pure virtual

Set the preset description.

Parameters
descriptionthe preset description.
virtual void IMotionPresetCmdData::SetPresetName (const PMStringname)
pure virtual

Set the preset name.

Parameters
namethe preset name.
virtual void IMotionPresetCmdData::SetTargetDB (IDataBaseiDB)
pure virtual

Set target DB

Parameters
iDBis the target DB for the new preset
virtual void IMotionPresetCmdData::SetUsePresetFile (const bool & useFile)
pure virtual

Sets flag to indicate generate motion xml for SWF

Parameters
useFileis set to true if using a IDFile