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

#include <IImportPreview.h>

Inheritance diagram for IImportPreview:
IPMUnknown

Public Member Functions

virtual ErrorCode Create24bitRGBPreview (uint8 *prevBaseaddr, int32 prevWidth, int32 prevHeight, IPMStream *iPMStream, bool16 useProgressBar) const =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

IImportPreview This class is used to create a 24 bit RGB preview for the Place dialog. This interface lives off of the PlaceProviderBoss (the boss containing an IID_IIMPORTPROVIDER interface) for each specific page item. If the interface does not exist, then the OS is responsible for drawing the preview on the Mac and no preview is drawn on Windows. If you are implementing this routine, it is desirable to periodically check events to allow the user to abort the preview creation process.

Member Function Documentation

virtual ErrorCode IImportPreview::Create24bitRGBPreview (uint8 * prevBaseaddr,
int32 prevWidth,
int32 prevHeight,
IPMStreamiPMStream,
bool16 useProgressBar 
) const
pure virtual

Create a 24 bit RGB preview of the stream contents.

Parameters
prevBaseAddr- OUT: Pointer to the bitmap data. The base addr points to an already allocated block of memory that is (((width * 3) + 3) / 4) * 4 * height bytes large. That is, each row is long aligned.
prevWidth- IN: The width of the preview area.
prevHeight- IN: The height of the preview area.
iPMStream- IN: the input stream containing the data we want previewed.
useProgressBar- IN: kTrue if it is okay to draw a progress bar.
Returns
kSuccess if successful. Otherwise, something like kFailure.