InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IImageWriteFormatInfo Class Referenceabstract

#include <IImageWriteFormatInfo.h>

Inheritance diagram for IImageWriteFormatInfo:
IPMUnknown

Public Member Functions

virtual OSType GetFileType ()=0
 
virtual OSType GetCreator ()=0
 
virtual void GetExtension (PMString *extension)=0
 
virtual void GetFormatName (PMString *formatName)=0
 
virtual bool16 GetImageColorSpaceSupportInfo (uint32 colorSpace, ImageColorSpaceSupportInfo *supportInfo)=0
 
virtual uint32 GetMaxWidth ()=0
 
virtual uint32 GetMaxHeight ()=0
 
virtual bool16 CanWriteAll (IImageAttributes *iImageAttributes)=0
 
virtual WidgetID GetPreferencesPanel ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface that provides additional data about the capabilities of an IImageWriteFormat implementation.

See Also
IImageWriteFormat

Member Function Documentation

virtual bool16 IImageWriteFormatInfo::CanWriteAll (IImageAttributesiImageAttributes)
pure virtual

Returns kTrue if the filter can write every attribute in the image, else kFalse.

Note: If a filter returns kFalse but the caller still uses it to create an image, then those tags that are not supported will be dropped by the filter.

Parameters
iImageAttributesIN The attributes to use for the write
Returns
kTrue if every attribute in the image can be written, else kFalse
virtual OSType IImageWriteFormatInfo::GetCreator ()
pure virtual

Returns the creator that should be used when creating a new file to contain the image data.

Returns
The file creator type for the new file
virtual void IImageWriteFormatInfo::GetExtension (PMStringextension)
pure virtual

Returns the extension that should be used when creating a new file to contain the image data.

Parameters
extensionOUT Pointer to the PMString to fill with the file extension for the new file
virtual OSType IImageWriteFormatInfo::GetFileType ()
pure virtual

Returns the file type that should be used when creating a new file to contain the image data.

Returns
The file type for the new file
virtual void IImageWriteFormatInfo::GetFormatName (PMStringformatName)
pure virtual

Returns the format name for this filter.

Parameters
formatNameOUT Pointer to the PMString to fill with the format name
virtual bool16 IImageWriteFormatInfo::GetImageColorSpaceSupportInfo (uint32 colorSpace,
ImageColorSpaceSupportInfosupportInfo 
)
pure virtual

Returns kTrue if the requested colorspace is supported, else kFalse. If kTrue is returned, then the supportInfo structure contains valid information regarding the requested colorspace.

Parameters
colorSpaceIN The colorspace for which support information is requested
supportInfoOUT On successful calls, filled with information about the nature of support
Returns
kTrue if the colorspace is supported by the filter, else kFalse
virtual uint32 IImageWriteFormatInfo::GetMaxHeight ()
pure virtual

Returns the maximum image height supported by the filter

Returns
The maximum supported height
virtual uint32 IImageWriteFormatInfo::GetMaxWidth ()
pure virtual

Returns the maximum image width supported by the filter

Returns
The maximum supported width
virtual WidgetID IImageWriteFormatInfo::GetPreferencesPanel ()
pure virtual

Returns the WidgetID of the panel to add to the Export Preferences dialog, if any.

The filter is responsible for setting the panel's parent to 'ImageExportUI' via the IDListPair resource definition of the panel and the 'Visible' field of the panel's resource definition to kFalse.

At export time, the export provider will ask the filter for its WidgetID. If the WidgetID is valid, the provider will use the WidgetID to query for the panel's IID_IUIDDATA and use it to set the source UID to be used to initialize the panel. Afterwards, the provider will show the panel, allowing the IntializeFields() method of the IDialogController for the panel to be called.

Returns
The WidgetID of the filter's preferences panel, or kInvalidWidgetID if it doesn't have one