ILowResImageList Class Reference

#include <ILowResImageList.h>

Inheritance diagram for ILowResImageList:

Public Member Functions
virtual int32	PersistAddRef (int32 at)=0
virtual int32	PersistRelease (int32 at)=0
virtual int32	FindImage (UID lowResUID) const =0
virtual void	Add (UID lowResUID)=0
virtual void	Remove (int32 at)=0
virtual UID	GetUID (int32 at) const =0
virtual int32	GetRefCount (int32 at) const =0
virtual void	ReadWrite (IPMStream *iPMStream, ImplementationID prop)=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

The ILowResImageList is a pure virtual interface for a singleton list of all the proxy images in a given document. Therefore, this interface lives on the kDocWorkspaceBoss with the IID_ILOWRESIMAGELIST interface id. Every image, raster (e.g. tiff, jpeg, etc) and vector (pdf, pict, eps, wmf, etc.), has its own low resolution proxy created at place time such that it can efficiently be drawn without having to re-read the image data from the original image file every time the document is opened. These proxies are stored in the ILowResImageList, allowing them to be shared if the same image is duplicated or placed multiple times.

Member Function Documentation

virtual void ILowResImageList::Add ( UID  lowResUID )

pure virtual

Add a proxy image UID to the list

Parameters

lowResUID

- IN: The UID of the new image.

virtual int32 ILowResImageList::FindImage ( UID  lowResUID ) const

pure virtual

Look for a proxy image with the given UID.

Parameters

lowResUID

- IN: The UID of the image

Returns

Zero based index of the image or -1 if it cannot be found.

virtual int32 ILowResImageList::GetRefCount ( int32  at ) const

pure virtual

Get the refcount of the proxy image at the given index.

Parameters

at	- IN: zero-based index.

Returns

the refcount (i.e. number of instances of imported page items sharing this proxy).

virtual UID ILowResImageList::GetUID ( int32  at ) const

pure virtual

Get the UID of the Proxy image at the entry referenced by the given index.

Parameters

at	- IN: zero-based index.

Returns

The UID at position 'at' or kInvalidUID if the position is not valid.

virtual int32 ILowResImageList::PersistAddRef ( int32  at )

pure virtual

Increment the refcount for the image at position 'at'

Parameters

at	- IN: zero-based index into the list of an image to addref.

Returns

Returns the refcount value after the addref.

virtual int32 ILowResImageList::PersistRelease ( int32  at )

pure virtual

Decrement the refcount for the image at position 'at'

Parameters

at	- IN: zero-based index into the list of an image to release.

Returns

Returns the refcount value after the release.

virtual void ILowResImageList::ReadWrite ( IPMStream *  iPMStream, ImplementationID  prop  )

pure virtual

Routine to persist or read the list.

Parameters

iPMStream	- IN/OUT: Source stream if reading, destination stream if writing.
prop	- IN: The implementation ID.

virtual void ILowResImageList::Remove ( int32  at )

pure virtual

Removes the given image from the list

Parameters

at	- IN: zero-based index into the list of an image to remove.