Interface to a class representing an image extracted from a PDF file. Intended to be only used with the JawsMako APIs. More...

#include <idomimageresource.h>

Inheritance diagram for IDOMPDFImage:

[legend]

Classes
class	CCITTFaxParams
	Class to hold filter parameters for CCITTFax-compressed image data. Please see the PDF specification for the meaning of these parameters. More...

class	Data
	Initialization data. More...

class	DCTParams
	Class to hold filter parameters for DCT-compressed image data. Please see the PDF specification for the meaning of these parameters. More...

class	FlateLZWParams
	Class to hold filter parameters for Flate or LZW-compressed image data. Please see the PDF specification for the meaning of these parameters. More...

class	IDecodeParams
	Abstract interface for per-image decoding filter parameters. More...

class	JBIG2Params
	Class to hold filter parameters for JBIG2-compressed image data. Please see the PDF specification for the meaning of these parameters. More...

Public Member Functions
virtual CEDLVector< IDecodeParamsPtr >	getDecodeParameters () const =0
	Retrieves the decode parameters. May be NULL. More...

virtual IDecodeParamsPtr	getDecodeParametersAtIndex (uint32 index) const
	Retrieves the decode parameters from the list with the given index. May be NULL. More...

virtual CEDLVector< eDOMImageType >	getImageTypes () const =0
	Retrieves the array of the image type. More...

virtual CEDLVector< float >	getDecode () const =0
	Retrieves the decode array used to interpret the color samples. An empty vector will be returned if there is no decode. More...

virtual uint8	getBitsPerComponent () const =0
	Retrieves the bits per component of the source data. For JPEG2000, this information is available only in the image stream and this function will return 0. In this case please use the `IImageStream` interface. More...

virtual CEDLVector< uint16 >	getColorKey () const =0
	Retrieves the color key for mask generation. An empty vector will be returned if there is no color key. More...

virtual IDOMColorSpacePtr	getColorSpace () const =0
	Retrieves the color space to be used with this image. For JPEG2000, this may be NULL if the colorspace needs to be determined from the image data. In this case please use the IImageStream interface. More...

virtual eImageAlpha	getAlphaDetails () const =0
	Returns if the image has alpha, and if the colour samples are premultiplied. More...

Public Member Functions inherited from IDOMImage
virtual IImageDecoderPtr	createImageDecoder (IEDLClassFactory *factory, const IDOMImagePropertiesPtr &imageProperties)=0
	Creates a properly initialized image decoder object that reads from an inputstream that is specific to that image format. More...

virtual IImageFramePtr	getImageFrame (IEDLClassFactory *factory)
	Fetch the image frame; convenience. More...

virtual IImageEncoderPtr	createImageEncoder (const ISessionPtr &session, const IOutputStreamPtr &imageDest, const IDOMImagePropertiesPtr &imageProperties)=0
	Creates a properly initialized image encoder object that writes to an outputstream that is specific to that image format. More...

virtual IDOMImagePropertiesPtr	getImageProperties ()=0
	Returns an object that stores the properties for this image object. The properties can then be inspected (or more added) by clients that need to manipulate the image resource. More...

virtual eDOMImageType	getImageType ()=0
	Retrieves the image type. More...

virtual bool	getIsRendered ()=0
	Determine if the image is as a result of rendering. This is indicated if the image type is eDITRendered or if the image explicitly notes this is the case (such as for IDOMPDFImage). More...

virtual IDOMImagePtr	getImageWithSubstitutedColorSpace (IEDLClassFactory *factory, const IDOMColorSpacePtr &colorSpace)
	Obtain an image that is the same as this image, but with the colorspace substituted for another. More...

Public Member Functions inherited from IDOMResource
virtual IInputStreamPtr	getStream () const =0
	Retrieves the resource stream. More...

virtual void	setStream (const IInputStreamPtr &stream)=0
	Sets the resource stream for the node. More...

virtual uint64	getStreamLength () const =0
	Retrieves the stream length, if it is available. More...

virtual const EDLSysString &	getUri () const =0
	Retrieves the resource URI. More...

virtual void	setUri (const EDLSysString &uri)=0
	Sets the resource URI. More...

Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject. More...

virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory. More...

virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject. More...

Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.

virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...

virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to. More...

Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.

virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object. More...

virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails. More...

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves class id of IDOMPDFImage. More...

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Interface to a class representing an image extracted from a PDF file. Intended to be only used with the JawsMako APIs.

Member Function Documentation

◆ classID()

static const CClassID& IDOMPDFImage::classID ( )

inlinestatic

Retrieves class id of IDOMPDFImage.

Returns: CClassID Class id of the element

◆ getAlphaDetails()

virtual eImageAlpha IDOMPDFImage::getAlphaDetails ( ) const

pure virtual

Returns if the image has alpha, and if the colour samples are premultiplied.

Returns: eImageAlpha The image alpha details

◆ getBitsPerComponent()

virtual uint8 IDOMPDFImage::getBitsPerComponent ( ) const

pure virtual

Retrieves the bits per component of the source data. For JPEG2000, this information is available only in the image stream and this function will return 0. In this case please use the IImageStream interface.

Returns: uint32 The number of bits per component

◆ getColorKey()

virtual CEDLVector<uint16> IDOMPDFImage::getColorKey ( ) const

pure virtual

Retrieves the color key for mask generation. An empty vector will be returned if there is no color key.

Returns: CEDLVector<uint16> The color key

◆ getColorSpace()

virtual IDOMColorSpacePtr IDOMPDFImage::getColorSpace ( ) const

pure virtual

Retrieves the color space to be used with this image. For JPEG2000, this may be NULL if the colorspace needs to be determined from the image data. In this case please use the IImageStream interface.

Returns: IDOMColorSpacePtr The color space

◆ getDecode()

virtual CEDLVector<float> IDOMPDFImage::getDecode ( ) const

pure virtual

Retrieves the decode array used to interpret the color samples. An empty vector will be returned if there is no decode.

Returns: CEDLVector<float> The decode array

◆ getDecodeParameters()

virtual CEDLVector<IDecodeParamsPtr> IDOMPDFImage::getDecodeParameters ( ) const

pure virtual

Retrieves the decode parameters. May be NULL.

Returns: CEDLVector<IDecodeParamsPtr> The array of the decode parameters

◆ getDecodeParametersAtIndex()

virtual IDecodeParamsPtr IDOMPDFImage::getDecodeParametersAtIndex ( uint32 index ) const

inlinevirtual

Retrieves the decode parameters from the list with the given index. May be NULL.

Parameters

index Index of the desired decode parameters in the array to return (beginning at 0).

Returns: IDecodeParamsPtr The decode parameters

◆ getImageTypes()

virtual CEDLVector<eDOMImageType> IDOMPDFImage::getImageTypes ( ) const

pure virtual

Retrieves the array of the image type.

Returns: CEDLVector<eDOMImageType> The array of the image type.

The documentation for this class was generated from the following file:

idomimageresource.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ getAlphaDetails()

◆ getBitsPerComponent()

◆ getColorKey()

◆ getColorSpace()

◆ getDecode()

◆ getDecodeParameters()

◆ getDecodeParametersAtIndex()

◆ getImageTypes()