IImportImageCmdData Class Reference

#include <IImportImageCmdData.h>

Inheritance diagram for IImportImageCmdData:

Public Types
enum	{ kDefaultIID = IID_IIMPORTIMAGECMDDATA }

Public Member Functions
virtual void	Set (IDataBase *db, UID uid, IPMStream *stream, bool8 showProgressBar=kTrue, bool8 forceCreateProxy=kFalse, int16 transparencyAlphaIndex=-1, bool8 allowAutoEmbedding=kTrue)=0
virtual IPMStream *	GetStream () const =0
virtual IDataBase *	GetImageDB () const =0
virtual UID	GetImageUID () const =0
virtual bool8	GetShowProgress () const =0
virtual bool8	GetForceCreateProxy () const =0
virtual int16	GetTransparencyIndex () const =0
virtual bool8	GetAllowAutoEmbedding () const =0
virtual ClassID	GetFormatClassId () const =0
virtual void	Set (IDataBase *db, UID uid, IPMStream *stream, bool8 showProgressBar=kTrue, bool8 forceCreateProxy=kFalse, int16 transparencyAlphaIndex=-1, bool8 allowAutoEmbedding=kTrue, ClassID formatClassId=kInvalidClass)=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

Command data interface for the kPlaceImageCmdBoss

Member Enumeration Documentation

anonymous enum

default interface IID for this interface

Member Function Documentation

virtual bool8 IImportImageCmdData::GetAllowAutoEmbedding ( ) const

pure virtual

Returns

kFalse if placed file must not be auto embedded. Auto embedding happens when file size < 48k

virtual bool8 IImportImageCmdData::GetForceCreateProxy ( ) const

pure virtual

Returns

kTrue if we are forcing a new image proxy to be created.

virtual ClassID IImportImageCmdData::GetFormatClassId ( ) const

pure virtual

Returns

classId of IImageReadFormat using which the image should be placed.

virtual IDataBase* IImportImageCmdData::GetImageDB ( ) const

pure virtual

IDataBase accessor for the Set method above.

Returns

pointer to the destination IDataBase.

virtual UID IImportImageCmdData::GetImageUID ( ) const

pure virtual

UID accessor for the Set method above.

Returns

UID of the kImageItem boss.

virtual bool8 IImportImageCmdData::GetShowProgress ( ) const

pure virtual

ShowProgressBar accessor for the Set method above.

Returns

kTrue if we are showing the progress bar.

virtual IPMStream* IImportImageCmdData::GetStream ( ) const

pure virtual

Stream accessor for the Set method above.

Returns

pointer to the source stream.

virtual int16 IImportImageCmdData::GetTransparencyIndex ( ) const

pure virtual

Returns

Zero-based index of the index of the alpha channel to use as a transparency mask.

virtual void IImportImageCmdData::Set ( IDataBase *  db, UID  uid, IPMStream *  stream, bool8  showProgressBar = kTrue, bool8  forceCreateProxy = kFalse, int16  transparencyAlphaIndex = -1, bool8  allowAutoEmbedding = kTrue  )

pure virtual

The ImportImageCmd requires the client to pass in a valid IDataBase, UID, and stream.

Parameters

db	- IN: The IDataBase that the image is being placed into.
uid	- IN: The UID should be created using NewPageItemCmd and is the UID of the actual image boss.
stream	- IN: The stream can be a file stream or a DB stream depending on the source. For example, if the data is coming from the scrap/clipboard it will be a DB stream and if the data is coming from a file selected in the Place dialog then a file stream will be used.
showProgressBar	- IN: Pass kFalse for the showProgressBar argument to suppress any progress bars from displaying (in case you want to display your own).
forceCreateProxy	- IN: kFalse allows the command to share the proxy with another image if that image has the same link. kFalse helps prevent pub bloat.
transparencyAlphaIndex	- IN: If >= 0, it is the index of the alpha to use as a transparency mask.
allowAutoEmbedding	- IN: Pass kFalse to disable auto embedding during place.

virtual void IImportImageCmdData::Set ( IDataBase *  db, UID  uid, IPMStream *  stream, bool8  showProgressBar = kTrue, bool8  forceCreateProxy = kFalse, int16  transparencyAlphaIndex = -1, bool8  allowAutoEmbedding = kTrue, ClassID  formatClassId = kInvalidClass  )

pure virtual

The ImportImageCmd requires the client to pass in a valid IDataBase, UID, and stream.

Parameters

db	- IN: The IDataBase that the image is being placed into.
uid	- IN: The UID should be created using NewPageItemCmd and is the UID of the actual image boss.
stream	- IN: The stream can be a file stream or a DB stream depending on the source. For example, if the data is coming from the scrap/clipboard it will be a DB stream and if the data is coming from a file selected in the Place dialog then a file stream will be used.
showProgressBar	- IN: Pass kFalse for the showProgressBar argument to suppress any progress bars from displaying (in case you want to display your own).
forceCreateProxy	- IN: kFalse allows the command to share the proxy with another image if that image has the same link. kFalse helps prevent pub bloat.
transparencyAlphaIndex	- IN: If >= 0, it is the index of the alpha to use as a transparency mask.
allowAutoEmbedding	- IN: Pass kFalse to disable auto embedding during place.
formatClassId	- IN: Pass the classId of IImageReadFormat using which the imaged should be placed.