CPage_interface.h File Reference

Interface for CPage wrapper. More...

Go to the source code of this file.

Functions
CPage	CPage_Create (CIDRS argIDRS, idrs_exception *pargException)
	Create creates a new page.
CPage	CPage_Create2 (const CImage argImage, idrs_exception *pargException)
	Create creates a new page from an existing image.
void	CPage_SetSourceImage (CPage argCPage, const CImage argImage, idrs_exception *pargException)
	SetSourceImage sets the source image for the page.
CImage	CPage_GetSourceImage (const CPage argCPage, idrs_exception *pargException)
	Gets the source image associated to the current CPage object.
IDRS_UINT	CPage_GetWidth (const CPage argCPage, idrs_exception *pargException)
IDRS_UINT	CPage_GetHeight (const CPage argCPage, idrs_exception *pargException)
IDRS_UINT	CPage_GetResolution (const CPage argCPage, idrs_exception *pargException)
CPageContent	CPage_GetPageContent (const CPage argCPage, idrs_exception *pargException)
	Gets page access content of the page via CPageContent class.
void	CPage_SetPageContent (const CPage argCPage, const CPageContent argPageContent, idrs_exception *pargException)
	Sets the CPageContent object associated with the CPage object.
void	CPage_SetWorkImage (CPage argCPage, const CImage argImage, idrs_exception *pargException)
	Sets the work image that can be used by the processing engines (page analysis, barcode processing and text recognition)
CImage	CPage_GetWorkImage (const CPage argCPage, idrs_exception *pargException)
	Gets the work image set into the CPage object.
void	CPage_SetBackgroundImage (CPage argCPage, const CImage argBackgroundImage, idrs_exception *pargException)
	Sets the background image to use during document output if required.
CImage	CPage_GetBackgroundImage (const CPage argCPage, idrs_exception *pargException)
	Gets the background image to use during document output if required.
void	CPage_Destroy (CPage argCPage, idrs_exception *pargException)
	Destroys a CPage handle.
CPageArray	ArrayInterface_Create_CPageArray (idrs_exception *pargException)
	Creates a new CPageArray object.

Detailed Description

Interface for CPage wrapper.

Function Documentation

ArrayInterface_Create_CPageArray()

CPageArray ArrayInterface_Create_CPageArray

(

idrs_exception *

pargException

)

Creates a new CPageArray object.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created CPageArray

CPage_Create()

CPage CPage_Create	(	CIDRS	argIDRS,
		idrs_exception *	pargException
	)

Create creates a new page.

All contained images (Source, Work, and Background) will remain NULL.

Parameters

argIDRS	- CIDRS handle object
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created page.

CPage_Create2()

CPage CPage_Create2	(	const CImage	argImage,
		idrs_exception *	pargException
	)

Create creates a new page from an existing image.

The provided image will be set as the page's Source, and both Work and Background images will be NULL.

Note that the provided image instance will be associated with the newly created page using a shallow copy. This means that any further change to the provided CImage will affect the CPage object.

Parameters

argImage	The image to set as source image.
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created page.

CPage_Destroy()

void CPage_Destroy	(	CPage	argCPage,
		idrs_exception *	pargException
	)

Destroys a CPage handle.

Parameters

argCPage	CPage handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_GetBackgroundImage()

CImage CPage_GetBackgroundImage	(	const CPage	argCPage,
		idrs_exception *	pargException
	)

Gets the background image to use during document output if required.

Returns

The background image

Parameters

argCPage	CPage handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_GetHeight()

IDRS_UINT CPage_GetHeight	(	const CPage	argCPage,
		idrs_exception *	pargException
	)

Return values

The	height of the page.

Returns

0 if there's no image for the page.

Parameters

argCPage	CPage handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_GetPageContent()

CPageContent CPage_GetPageContent	(	const CPage	argCPage,
		idrs_exception *	pargException
	)

Gets page access content of the page via CPageContent class.

Using CPageContent class provides an integrator with read/write access to page content

Returns

Read/write access to the page content.

Parameters

argCPage	CPage handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_GetResolution()

IDRS_UINT CPage_GetResolution	(	const CPage	argCPage,
		idrs_exception *	pargException
	)

Returns

The resolution of the source image.

Parameters

argCPage	CPage handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_GetSourceImage()

CImage CPage_GetSourceImage	(	const CPage	argCPage,
		idrs_exception *	pargException
	)

Gets the source image associated to the current CPage object.

Returns

The source image associated to this CPage object

Parameters

argCPage	CPage handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_GetWidth()

IDRS_UINT CPage_GetWidth	(	const CPage	argCPage,
		idrs_exception *	pargException
	)

Return values

The	width of the page.

Returns

0 if there's no image for the page.

Parameters

argCPage	CPage handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_GetWorkImage()

CImage CPage_GetWorkImage	(	const CPage	argCPage,
		idrs_exception *	pargException
	)

Gets the work image set into the CPage object.

Returns

Work image associated to the CPage object

Parameters

argCPage	CPage handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_SetBackgroundImage()

void CPage_SetBackgroundImage	(	CPage	argCPage,
		const CImage	argBackgroundImage,
		idrs_exception *	pargException
	)

Sets the background image to use during document output if required.

The Background image is an optional image which can be computed during text recognition. It will correspond to the source image with all detected text erased from it. It can therefore be used later when creating output formats needing such background image (Docx with Exact layout for instance).

The background image can be changed during the deskew process, if there's a skew angle detected.

Parameters

argCPage	CPage handle
argBackgroundImage	The background image
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_SetPageContent()

void CPage_SetPageContent	(	const CPage	argCPage,
		const CPageContent	argPageContent,
		idrs_exception *	pargException
	)

Sets the CPageContent object associated with the CPage object.

Using CPageContent class provides an integrator with read/write access to page content

Parameters

argCPage	CPage handle
argPageContent	CPageContent object that will be associated to the CPage
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_SetSourceImage()

void CPage_SetSourceImage	(	CPage	argCPage,
		const CImage	argImage,
		idrs_exception *	pargException
	)

SetSourceImage sets the source image for the page.

Note that the provided image instance will be associated with this page using a shallow copy. This means that any further change to the provided CImage object will affect the CPage object.

Parameters

argCPage	CPage handle
argImage	The image to set as a source image.
pargException	Pointer to exception structure that will be filled if an exception occurs

CPage_SetWorkImage()

void CPage_SetWorkImage	(	CPage	argCPage,
		const CImage	argImage,
		idrs_exception *	pargException
	)

Sets the work image that can be used by the processing engines (page analysis, barcode processing and text recognition)

The work image is an optional black & white image which can be used by page analysis, text recognition and barcode detection algorithms. If this image is set, it will be provided to the concerned engines in addition to the source image, in order to help recognition. The work image needs to be black & white, and have the same characteristics than the source image (dimensions and resolution).

The work image can be changed during the deskew process, if there's a skew angle detected.

Parameters

argCPage	CPage handle
argImage	Black&white image that will be used by processing engines
pargException	Pointer to exception structure that will be filled if an exception occurs