InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IImageIOPreferences Class Referenceabstract

#include <IImageIOPreferences.h>

Inheritance diagram for IImageIOPreferences:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IIMAGEIOPREFERENCES }
 

Public Member Functions

virtual void SetPreviewResolution (int32 resolution)=0
 
virtual int32 GetPreviewResolution () const =0
 
virtual void SetCreateClippingFrame (bool16 doClip)=0
 
virtual bool16 GetCreateClippingFrame () const =0
 
virtual void SetAllowAutoEmbedding (bool16 allow)=0
 
virtual bool16 GetAllowAutoEmbedding (void) const =0
 
virtual void SetAlphaChannelName (const PMString &channelName)=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

IImageIOPreferences This class defines the import/place time preferences for an image. This interface lives off of the workspace (session) and also off of each raster image page item (kImageItem boss). The workspace version defines the default settings for newly placed images. The version on the image's boss defines the settings that were used to import that image.

See Also
IImageIOPrefsCmdData.h

Member Enumeration Documentation

anonymous enum

default IID for this interface

Member Function Documentation

virtual bool16 IImageIOPreferences::GetAllowAutoEmbedding (void ) const
pure virtual

Returns whether it is okay to automatically embed an image if it is determined to be small enough

virtual PMString IImageIOPreferences::GetAlphaChannelName () const
pure virtual

Returns the name of the alpha channel to apply.

virtual bool16 IImageIOPreferences::GetCreateClippingFrame () const
pure virtual

Returns whether or not clipping paths will automatically be applied to images at Place time.

virtual int32 IImageIOPreferences::GetPreviewResolution () const
pure virtual

Return the desired proxy resolution.

virtual void IImageIOPreferences::SetAllowAutoEmbedding (bool16 allow)
pure virtual

During import, if an image is small enough (smaller than ILinkData::GetEmbedSize()) then it may be automatically embedded in the pub.

Parameters
allow- IN: Pass kFalse to SetAllowAutoEmbedding() to prevent the image from being embedded in the pub.
virtual void IImageIOPreferences::SetAlphaChannelName (const PMString & channelName)
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 channelName is empty, it means no alpha is selected. Initial/default value is an empty string.

Parameters
channelName- IN: The name of the alpha channel.
virtual void IImageIOPreferences::SetCreateClippingFrame (bool16 doClip)
pure virtual

During import, if an image format contains a clipping path, the place provider has the option of creating a frame for the image based on the clipping path. Setting this flag does not imply that there is a path, rather it indicates the preference to use if it exists.

Parameters
doClip- IN: kTrue to automatically apply clipping paths.
virtual void IImageIOPreferences::SetPreviewResolution (int32 resolution)
pure virtual

During import we always create a proxy image which is stored inside the pub. The following resolution dictates the size of the low res image.

Parameters
resolution- IN: The desired proxy resolution.