JawsMako::IPageRaster Class Reference

A rasterized equivalent of a page from an IDocument. More...

#include <jawsmako/jawsmako.h>

Inheritance diagram for JawsMako::IPageRaster:

Public Member Functions
virtual uint32	getWidth () const =0
	Get the width of the raster image.
virtual uint32	getHeight () const =0
	Get the height of the raster image.
virtual uint32	getResX () const =0
	Get the resolution of the raster image along the X-axis.
virtual uint32	getResY () const =0
	Get the resolution of the raster image along the Y-axis.
virtual uint32	getBPC () const =0
	Get the number of bits per component.
virtual uint32	getNumComponents () const =0
	Get the number of component per pixel.
virtual uint32	getRawBytesPerRow () const =0
	Get the number of bytes per row.
virtual bool	isBlank () const =0
	Return true if the page is unmarked.
virtual uint8 *	getFrameBuffer () const =0
	Get the address the raw frame buffer.
virtual IDOMImagePtr	getAsDOMImage () const =0
	Return an IDOMImage equivalent of the raster image.
virtual void	releaseFrameBuffer ()=0
	Release the frame buffer for this raster.
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.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from JawsMako::IHashable
virtual	~IHashable ()
virtual uint64	hash () const
	Obtain a 64-bit hash of the receiving object.
virtual void	updateHash (uint64 &hash) const =0
	Update the given hash to include the receiver.

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

Detailed Description

A rasterized equivalent of a page from an IDocument.

Member Function Documentation

getAsDOMImage()

virtual IDOMImagePtr JawsMako::IPageRaster::getAsDOMImage ( ) const

pure virtual

Return an IDOMImage equivalent of the raster image.

Returns

IDOMImagePtr A DOM image.

getBPC()

virtual uint32 JawsMako::IPageRaster::getBPC ( ) const

pure virtual

Get the number of bits per component.

Returns

uint32 The number of bits per component.

getFrameBuffer()

virtual uint8 * JawsMako::IPageRaster::getFrameBuffer ( ) const

pure virtual

Get the address the raw frame buffer.

Returns

uint8* Pointer to the frame buffer

getHeight()

virtual uint32 JawsMako::IPageRaster::getHeight ( ) const

pure virtual

Get the height of the raster image.

Returns

uint32 The height.

getNumComponents()

virtual uint32 JawsMako::IPageRaster::getNumComponents ( ) const

pure virtual

Get the number of component per pixel.

Returns

uint32 The number of components.

getRawBytesPerRow()

virtual uint32 JawsMako::IPageRaster::getRawBytesPerRow ( ) const

pure virtual

Get the number of bytes per row.

Returns

uint32 The number of bytes per row.

getResX()

virtual uint32 JawsMako::IPageRaster::getResX ( ) const

pure virtual

Get the resolution of the raster image along the X-axis.

Returns

uint32 The X-axis resolution in dpi.

getResY()

virtual uint32 JawsMako::IPageRaster::getResY ( ) const

pure virtual

Get the resolution of the raster image along the Y-axis.

Returns

uint32 The Y-axis resolution in dpi.

getWidth()

virtual uint32 JawsMako::IPageRaster::getWidth ( ) const

pure virtual

Get the width of the raster image.

Returns

uint32 The width.

isBlank()

virtual bool JawsMako::IPageRaster::isBlank ( ) const

pure virtual

Return true if the page is unmarked.

Returns

bool True if the page is unmarked, otherwise false.

releaseFrameBuffer()

virtual void JawsMako::IPageRaster::releaseFrameBuffer ( )

pure virtual

Release the frame buffer for this raster.

---

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

• jawsmako/jawsmako.h