ICMSAttributeSuite Class Reference

Inheritance diagram for ICMSAttributeSuite:

Public Types
enum	{ kDefaultIID = IID_ICMSATTRIBUTESUITE }

Public Member Functions
virtual int32	GetProfileColorspace ()=0
virtual bool16	GetRenderingIntent (ICMSSettings::renderingIntent &)=0
virtual bool16	GetCMSState (bool16 &onOffstate)=0
virtual bool16	GetProfileName (PMString &, ICMSItemProfileSource::ProfileSourceType &)=0
virtual bool16	GetEmbeddedProfileName (PMString &)=0
virtual bool16	CanApplyCMS ()=0
virtual bool16	CanApplyEmbeddedProfile ()=0
virtual bool16	CanCreateProfileFilter ()=0
virtual bool16	CreateProfileFilter (CMSMgrProfileFilter &)=0
virtual ErrorCode	ApplyRenderingIntent (const ICMSSettings::renderingIntent &)=0
virtual ErrorCode	ApplyCMSState (const bool16 &cmsOnOff)=0
virtual ErrorCode	ApplyEmbeddedProfile (void)=0
virtual ErrorCode	ApplyDocDefaultProfile (void)=0
virtual ErrorCode	ApplyExternalProfile (const PMString &)=0
virtual bool16	GetEmbeddedReadOnlyProfileName (PMString &name)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode ICMSAttributeSuite::ApplyCMSState ( const bool16 &  cmsOnOff )

pure virtual

Apply the specified CMS on/off state to the selection.

Parameters

cmsOfOff

on (kTrue) or off (kFalse).

Precondition

CanApplyCMS() == kTrue.

virtual ErrorCode ICMSAttributeSuite::ApplyDocDefaultProfile ( void  )

pure virtual

Apply the document's default profiles to the selection.

Precondition

CanApplyCMS() == kTrue.

virtual ErrorCode ICMSAttributeSuite::ApplyEmbeddedProfile ( void  )

pure virtual

Apply the embedded profile to the selection.

Precondition

CanApplyEmbeddedProfile() == kTrue.

virtual ErrorCode ICMSAttributeSuite::ApplyExternalProfile ( const PMString &  )

pure virtual

Apply the specified profile to the selection.

Parameters

profileName

the name of the profile to apply.

Precondition

CanApplyCMS() == kTrue.

virtual ErrorCode ICMSAttributeSuite::ApplyRenderingIntent ( const ICMSSettings::renderingIntent &  )

pure virtual

Apply the specified rendering intent to the selection.

Parameters

renderingIntent

the rendering intent to apply.

Precondition

CanApplyCMS() == kTrue.

virtual bool16 ICMSAttributeSuite::CanApplyCMS ( )

pure virtual

Returns kTrue if CMS attributes can be applied.

Precondition

CanApplyCMS() == kTrue.

virtual bool16 ICMSAttributeSuite::CanApplyEmbeddedProfile ( )

pure virtual

Returns kTrue if an embedded profile can be applied.

virtual bool16 ICMSAttributeSuite::CanCreateProfileFilter ( )

pure virtual

Returns kTrue if a profile filter can be created. A profile filter can only be created if the profile color space is one of (kPMCsCalRGB, kPMCsCalCMYK, or kPMCsLab).

virtual bool16 ICMSAttributeSuite::CreateProfileFilter ( CMSMgrProfileFilter &  )

pure virtual

Create a profile filter based on the current selection. Returns the profile filter in the parameter.

Precondition

CanCreateProfileFilter() == kTrue.

virtual bool16 ICMSAttributeSuite::GetCMSState ( bool16 &  onOffstate )

pure virtual

Returns the current CMS enabling state in the parameter. Returns kTrue if there's an unique CMS enable state in the selection. Otherwise returns kFalse.

Parameters

onOffstate

Precondition

CanApplyCMS() == kTrue.

virtual bool16 ICMSAttributeSuite::GetEmbeddedProfileName ( PMString &  )

pure virtual

Returns the embedded profile name in the parameter. There can be an embedded profile only if there's only one item in the selection. All other cases, the name is set to null. Returns kTrue if there's an embedded profile. Otherwise kFalse.

Parameters

embeddedrofileName.

Precondition

CanApplyCMS() == kTrue.

virtual bool16 ICMSAttributeSuite::GetEmbeddedReadOnlyProfileName ( PMString &  name )

pure virtual

Returns the current profile name for embedded, read-only profiles. Returns kTrue if selected items have embedded, read-only profiles; returns kFalse if selected items do not have such profiles or if selection is mixed.

Parameters

name	The profile's name if present, read-only, and embedded

virtual int32 ICMSAttributeSuite::GetProfileColorspace ( )

pure virtual

Returns the profile color space. Valid color spaces are kPMCsCalRGB, kPMCsCalCMYK, and kPMCsLab. Returns kPMCsUnused if mixed selection.

Returns

profile color space.

Precondition

CanApplyCMS() == kTrue.

virtual bool16 ICMSAttributeSuite::GetProfileName ( PMString &  , ICMSItemProfileSource::ProfileSourceType &    )

pure virtual

Returns the current profile name and type in the parameters. The name is set to null if profile type is set to use the document default. It is also null if there's mixed selection. Returns kTrue if the profile is unique Otherwise returns kFalse.

Parameters

profileName.
profileType.

Precondition

CanApplyCMS() == kTrue.

virtual bool16 ICMSAttributeSuite::GetRenderingIntent ( ICMSSettings::renderingIntent &  )

pure virtual

Returns the current rendering intent in the parameter. Returns kTrue if there's an unique rendering intent in the selection. Otherwise returns kFalse.

Parameters

renderingIntent

Precondition

CanApplyCMS() == kTrue.