CImageWriteFormat Class Reference

Inheritance diagram for CImageWriteFormat:

Public Member Functions
virtual bool16	SetImageAttributes (IImageAttributes *iImageAttributes)
virtual bool16	Open (IPMStream *iPMStream)
virtual bool16	Close ()
virtual bool16	SetFormatOption (uint32 formatOption, uint32 formatData)
virtual bool16	WriteData (IImageStream *iImageStream)

Additional Inherited Members
Public Types inherited from IImageWriteFormat
enum	{ kOptionSetImage = 1 }

Member Function Documentation

virtual bool16 CImageWriteFormat::Close ( )

inlinevirtual

Terminates a write session started by a prior call to Open.

Returns

kTrue if the method succeeds, else kFalse

Implements IImageWriteFormat.

virtual bool16 CImageWriteFormat::Open ( IPMStream *  iPMStream )

inlinevirtual

Initializes a writer for a write session to the specified stream.

Parameters

iPMStream

IN The stream to write to

Returns

kTrue if the method succeeds, else kFalse

Implements IImageWriteFormat.

virtual bool16 CImageWriteFormat::SetFormatOption ( uint32  formatOption, uint32  formatData  )

inlinevirtual

Sets an additional option for the image write. Only option supported at this point is whether to write high res (kPMHighResImage) or low res (kPMLowResImage) image.

Parameters

formatOption	IN The selector for the option to set
formatData	IN The data for the option

Returns

kTrue if the method succeeds, else kFalse

Implements IImageWriteFormat.

virtual bool16 CImageWriteFormat::SetImageAttributes ( IImageAttributes *  iImageAttributes )

inlinevirtual

Sets the image attributes to use when writing the image. Unlike reading, image attributes are required before writing the image data.

IMPORTANT: If the format supports more than one image per file, then the attributes set are those for the current image (via the SetFormatOption call).

Parameters

iImageAttributes

IN The image attributes to use for the write

Returns

kTrue if the method succeeds, else kFalse

Implements IImageWriteFormat.

virtual bool16 CImageWriteFormat::WriteData ( IImageStream *  iImageStream )

inlinevirtual

Reads source data from the given IImageStream and writes to the output stream.

Note: The format may read the data in any row, plane, or layer order. Also, Because the format is driving the interaction, it is responsible for posting the progress bar.

Parameters

iImageStream

IN The source input stream

Returns

kTrue if the method succeeds, else kFalse

Implements IImageWriteFormat.