IImageIOPrefsCmdData Class Reference

#include <IImageIOPrefsCmdData.h>

Inheritance diagram for IImageIOPrefsCmdData:

Public Types
enum	{ kDefaultIID = IID_IIMAGEIOPREFSCMDDATA }

Public Member Functions
virtual void	Set (int32 preResolution, bool16 bClip, bool16 allowAutoEmbedding=kTrue, const PMString &alphaChannelName=PMString())=0
virtual const int32	GetPreviewResolution () const =0
virtual const bool16	GetCreateClippingFrame () const =0
virtual bool16	GetAllowAutoEmbedding (void) const =0
virtual PMString	GetAlphaChannelName () 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

IImageIOPrefsCmdData Data interface for the kSetImageIOPrefsCmdBoss. If the command has an item list, then the prefs will be set for the items in the list. Otherwise, the command will set the prefs for the session.

See Also

IImageIOPreferences.h

Member Enumeration Documentation

anonymous enum

default IID for this interface

Member Function Documentation

virtual bool16 IImageIOPrefsCmdData::GetAllowAutoEmbedding ( void  ) const

pure virtual

During import, if an image is small enough (smaller than ILinkData::GetEmbedSize()) then it may be automatically embedded in the pub. Pass kFalse to SetAllowAutoEmbedding() to prevent the image from being embedded in the pub.

Returns

Is it okay to automatically embed an image if it is determined to be small enough?

virtual PMString IImageIOPrefsCmdData::GetAlphaChannelName ( ) const

pure virtual

During import, if an image has multiple alpha channels, the user can select which alpha they wish to apply. The name is the alpha channel name. If string is empty, it means no alpha is selected. Initial/default value is an empty string.

Returns

The name of the alpha channel to apply.

virtual const bool16 IImageIOPrefsCmdData::GetCreateClippingFrame ( ) const

pure virtual

Return whether we should create a Frame based on any Photoshop embedded clipping path encountered

virtual const int32 IImageIOPrefsCmdData::GetPreviewResolution ( ) const

pure virtual

Return the preferred resolution of the low resolution proxy

virtual void IImageIOPrefsCmdData::Set ( int32  preResolution, bool16  bClip, bool16  allowAutoEmbedding = kTrue, const PMString &  alphaChannelName = PMString()  )

pure virtual

Set the desired resolution, clipping, auto-embedding and alpha channel name settings.

Parameters

preResolution	- IN: Desired preview/proxy resolution.
bClip	- IN: kTrue to automatically apply embedded Photoshop clipping paths.
allowAutoEmbedding	- IN: kTrue to allow InDesign to automatically embed any image which is below the ILinkData::GetEmbedSize() threshold in size.
alphaChannelName	- IN: Name of the alpha channel to apply.