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

#include <ILibraryAssetThumbnail.h>

Inheritance diagram for ILibraryAssetThumbnail:
IPMUnknown

Public Types

enum  { kLibAssetThumbnailMaxSize = 112 }
 

Public Member Functions

virtual void Set (int16 xSize, int16 ySize, const void *bitmapPtr, int32 bitmapSize)=0
 
virtual void GetDimensions (int16 &xSize, int16 &ySize) const =0
 
virtual void GetImageSize (int32 &bitmapSize) const =0
 
virtual void GetImage (void *bitmapPtr) const =0
 
virtual void Delete ()=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

This secondary interface to the LibraryAsset boss controls reading and writing of the "thumbnail" image for the asset. Library asset thumbnail images are defined to be uncompressed 24 bit/pixel RGB images with a line byte width which is a multiple of 4 bytes.

Member Function Documentation

virtual void ILibraryAssetThumbnail::Delete ()
pure virtual

Deletes the thumbnail.

virtual void ILibraryAssetThumbnail::GetDimensions (int16 & xSize,
int16 & ySize 
) const
pure virtual

Gets the thumbnail image X and Y pixel count.

Parameters
xSizeOUT the width in pixels
ySizeOUT the height in pixels
virtual void ILibraryAssetThumbnail::GetImage (void * bitmapPtr) const
pure virtual

Copy the thumbnail image bitmap to a buffer.

Parameters
bitmapPtrIN a pointer to the bitmap – caller must allocate the buffer
virtual void ILibraryAssetThumbnail::GetImageSize (int32 & bitmapSize) const
pure virtual

Gets the size in bytes of the thumbnail image bitmap.

Parameters
bitmapSizeOUT hte size of the bitmap in bytes
virtual void ILibraryAssetThumbnail::Set (int16 xSize,
int16 ySize,
const void * bitmapPtr,
int32 bitmapSize 
)
pure virtual

Sets the thumbnail to the given image.

Parameters
xSizeIN width in pixels
ySizeIN height in pixels
bitmapPtrIN pointer to the bitmap
bitmapSizeIN the size of the bitmap in bytes