IEmbedPreflightProfileCmdData Class Reference

#include <IEmbedPreflightProfileCmdData.h>

Inheritance diagram for IEmbedPreflightProfileCmdData:

Public Types
enum	{ kDefaultIID = IID_IEMBEDPREFLIGHTPROFILECMDDATA }

Public Member Functions
virtual void	SetDataBase (IDataBase *db)=0
virtual IDataBase *	GetDataBase () const =0
virtual void	SetNewProfile (const IPreflightProfile *iSrcProfile)=0
virtual IPreflightProfile *	QueryNewProfile () const =0
virtual void	SetOldProfileUID (UID oldProfile)=0
virtual UID	GetOldProfileUID () const =0
virtual void	SetOldProfileName (const PMString &oldName)=0
virtual PMString	GetOldProfileName () const =0
virtual void	SetNewProfileUID (UID oldProfile)=0
virtual UID	GetNewProfileUID () const =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 provides the settings to accompany an EmbedPreflightProfile command. Note that this command can both embed and unembed profiles. Also, you may also find it easier to use IPreflightFacade::EmbedProfile and/or IPreflightFacade::UnembedProfile() than building and processing the command yourself.

See Also

IPreflightProfile

Member Function Documentation

virtual IDataBase* IEmbedPreflightProfileCmdData::GetDataBase ( ) const

pure virtual

Returns

the database to modify.

virtual UID IEmbedPreflightProfileCmdData::GetNewProfileUID ( ) const

pure virtual

Returns

the newly embedded profile's UID, if any. kInvalidUID if none was embedded.

virtual PMString IEmbedPreflightProfileCmdData::GetOldProfileName ( ) const

pure virtual

Returns

the previously embedded profile's name, if any. Empty if there was none.

virtual UID IEmbedPreflightProfileCmdData::GetOldProfileUID ( ) const

pure virtual

Returns

the previously embedded profile's UID, if any. kInvalidUID if there was none.

virtual IPreflightProfile* IEmbedPreflightProfileCmdData::QueryNewProfile ( ) const

pure virtual

Returns

the (refcounted) source profile that will be added; nil if not set.

Note

this is an in-memory COPY of the data passed into the SetNew method.

virtual void IEmbedPreflightProfileCmdData::SetDataBase ( IDataBase *  db )

pure virtual

Set the database to modify.

Parameters

db	IN The database to modify. Must be a valid document database.

virtual void IEmbedPreflightProfileCmdData::SetNewProfile ( const IPreflightProfile *  iSrcProfile )

pure virtual

For an embed operation, sets the profile data to copy into the document. For an unembed operation, you don't need to call this (but you can pass nil to force one if it's possible that it was set to non-nil at some point).

Parameters

iSrcProfile

IN The profile data you want to embed in the document. If nil, clears (disposes) the existing profile, so this becomes an Unembed request.

virtual void IEmbedPreflightProfileCmdData::SetNewProfileUID ( UID  oldProfile )

pure virtual

Sets the new (newly embedded) profile's UID, if any. This should only be set by the command itself during the processing of the command.

virtual void IEmbedPreflightProfileCmdData::SetOldProfileName ( const PMString &  oldName )

pure virtual

Sets the old (previously embedded) profile's name, if any. This should only be set by the command itself during the processing of the command.

virtual void IEmbedPreflightProfileCmdData::SetOldProfileUID ( UID  oldProfile )

pure virtual

Sets the old (previously embedded) profile's UID, if any. This should only be set by the command itself during the processing of the command.