IPreflightProfileManager Class Reference

#include <IPreflightProfileManager.h>

Inheritance diagram for IPreflightProfileManager:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTPROFILEMANAGER }

Public Member Functions
virtual int32	GetProfileCount () const =0
virtual IPreflightProfile *	QueryNthProfile (int32 n) const =0
virtual UID	GetNthProfileUID (int32 n) const =0
virtual void	GetAllProfiles (UIDList *theList) const =0
virtual int32	FindProfile (UID profileUID) const =0
virtual int32	FindProfile (const IPreflightProfile *iProfile) const =0
virtual int32	FindProfile (const PMString &profileName) const =0
virtual void	InsertProfile (IPreflightProfile *iProfile, int32 beforeIndex=-1)=0
virtual void	InsertCopyOfProfile (IPreflightProfile *iProfile, int32 beforeIndex=-1)=0
virtual void	RemoveNthProfile (int32 n, bool deleteIt=kTrue)=0
virtual void	RemoveAllProfiles (bool deleteThem=kTrue)=0
virtual PMString	GetUniqueProfileName (const PMString &name) const =0
virtual void	Startup ()=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

Manages a list of profiles at the application or document level. To get one of these interfaces you'd normally use IPreflightUtils::QueryProfileManager().

See Also

IPreflightProfile

IPrefilghtUtils

Member Function Documentation

virtual int32 IPreflightProfileManager::FindProfile ( UID  profileUID ) const

pure virtual

Find a profile by its UID.

Parameters

profileUID

The UID of the profile you want.

Returns

The index of the profile or -1 if no match was found.

virtual int32 IPreflightProfileManager::FindProfile ( const IPreflightProfile *  iProfile ) const

pure virtual

Find a profile by its interface.

Parameters

iProfile

The profile you want to find.

Returns

The index of the profile or -1 if no match was found.

virtual int32 IPreflightProfileManager::FindProfile ( const PMString &  profileName ) const

pure virtual

Find a profile by its name.

Parameters

profileName

The name of the profile you want.

Returns

The index of the profile or -1 if no match was found.

virtual void IPreflightProfileManager::GetAllProfiles ( UIDList *  theList ) const

pure virtual

Get the whole profile list.

Parameters

theList

OUT The UIDList to accept the profile list.

virtual UID IPreflightProfileManager::GetNthProfileUID ( int32  n ) const

pure virtual

Get the Nth profile in the list.

Parameters

n	The index of the profile you want.

Returns

The UID of the nth profile.

virtual int32 IPreflightProfileManager::GetProfileCount ( ) const

pure virtual

Get the number of profiles in the list.

Returns

The number of profiles in the list.

virtual PMString IPreflightProfileManager::GetUniqueProfileName ( const PMString &  name ) const

pure virtual

Return a unique profile name within the specified profile manager based on "name".

Note

If 'name' is already unique, it's simply returned without any decoration.

Parameters

name	is the base name from which to create an unique profile name. If this is empty then the returned string is the default new-profile name plus any decoration needed to make it unique.

Returns

the unique profile name.

virtual void IPreflightProfileManager::InsertCopyOfProfile ( IPreflightProfile *  iProfile, int32  beforeIndex = -1  )

pure virtual

Insert a copy of a profile. The source can be in the same DB, another DB, or in memory. Note that the profile name is not checked for conflicts.

Parameters

iProfile	The profile you want to add to the list of profiles.
beforeIndex	The location of the profile. -1 = at end.

virtual void IPreflightProfileManager::InsertProfile ( IPreflightProfile *  iProfile, int32  beforeIndex = -1  )

pure virtual

Insert a particular profile; must be in the same DB as the manager.

Note

The profile name is NOT checked for conflicts.

Parameters

iProfile	The profile you want to add to the list of profiles.
beforeIndex	The location of the profile. -1 = at end.

virtual IPreflightProfile* IPreflightProfileManager::QueryNthProfile ( int32  n ) const

pure virtual

Get the Nth profile in the list.

Parameters

n	The index of the profile you want.

Returns

A refcounted profile interface or nil if n is out of range.

virtual void IPreflightProfileManager::RemoveAllProfiles ( bool  deleteThem = kTrue )

pure virtual

Remove all profiles from the list, optionally destroying them.

Parameters

deleteThem

kTrue if you want to delete the profiles (ie delete their UIDs) or kFalse to simply detach them. In the latter case be sure you establish a new owner for the profiles.

virtual void IPreflightProfileManager::RemoveNthProfile ( int32  n, bool  deleteIt = kTrue  )

pure virtual

Remove a profile from the list, optionally destroying it.

Parameters

n	The index of the profile you want to delete.
deleteIt	kTrue if you want to delete the profile (ie delete its UID) or kFalse to simply detach it. In the latter case be sure you establish a new owner for the profile.

virtual void IPreflightProfileManager::Startup ( )

pure virtual

Called by the preflight manager at application startup; do not call.