CPageContent_interface.h File Reference

Interface for CPageContent wrapper. More...

Go to the source code of this file.

Functions
CPageContent	CPageContent_Create (idrs_exception *pargException)
	Instantiates a new page content object with default values.
CPageContent	CPageContent_Create2 (IDRS_INT const iPageWidth, IDRS_INT const iPageHeight, IDRS_INT const iPageResolution, idrs_exception *pargException)
	Create instantiates a new page content object and initializes the basic values.
IDRS_INT	CPageContent_GetPageWidth (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets the page width.
IDRS_INT	CPageContent_GetPageHeight (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets the page height.
IDRS_INT	CPageContent_GetPageResolution (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets the page resolution.
MarginInfo	CPageContent_GetPageMargins (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets the page margins.
enum Language	CPageContent_GetPageMainLanguage (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets the main language used in the page.
CPageSectionArray	CPageContent_GetSections (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets an array with all sections in the page.
CPageGraphicShapeArray	CPageContent_GetGraphicShapes (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets an array containing all graphic shapes in the page.
const CPageZoneArray	CPageContent_QueryPageZones (const CPageContent argCPageContent, idrs_exception *pargException)
	Retrieves a list containing all the the zones of the page content.
void	CPageContent_SetPageWidth (CPageContent argCPageContent, IDRS_INT const iPageWidth, idrs_exception *pargException)
	Sets the page width.
void	CPageContent_SetPageHeight (CPageContent argCPageContent, IDRS_INT const iPageHeight, idrs_exception *pargException)
	Sets the page height.
void	CPageContent_SetPageResolution (CPageContent argCPageContent, IDRS_INT const iPageResolution, idrs_exception *pargException)
	Sets the page resolution.
void	CPageContent_SetPageMargins (CPageContent argCPageContent, const MarginInfo *stPageMargins, idrs_exception *pargException)
	Sets the page margins.
void	CPageContent_SetPageMainLanguage (CPageContent argCPageContent, enum Language const evPageLanguage, idrs_exception *pargException)
	Sets the main language used in the page.
void	CPageContent_SetSections (CPageContent argCPageContent, const CPageSectionArray argSections, idrs_exception *pargException)
	Sets the array containing the page sections.
void	CPageContent_SetGraphicShapes (CPageContent argCPageContent, const CPageGraphicShapeArray argShapes, idrs_exception *pargException)
	Sets the array containing the graphic shapes.
CPageStyle	CPageContent_GetPageStyle (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets the style object associated to the page content.
void	CPageContent_SetPageStyle (CPageContent argCPageContent, const CPageStyle argPageStyle, idrs_exception *pargException)
	Sets the page style associated to the page content.
CPageMetadata	CPageContent_GetMetadata (const CPageContent argCPageContent, idrs_exception *pargException)
	Gets the page metadata.
void	CPageContent_SetMetadata (CPageContent argCPageContent, const CPageMetadata argPageMetadata, idrs_exception *pargException)
	Sets the page metadata.
void	CPageContent_Clear (CPageContent argCPageContent, idrs_exception *pargException)
	Clears all elements in the page.
void	CPageContent_Destroy (CPageContent argCPageContent, idrs_exception *pargException)
	Destroys a CPageContent handle.

Detailed Description

Interface for CPageContent wrapper.

Function Documentation

CPageContent_Clear()

void CPageContent_Clear	(	CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Clears all elements in the page.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_Create()

CPageContent CPageContent_Create

(

idrs_exception *

pargException

)

Instantiates a new page content object with default values.

Parameters

pargException

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

Remarks

Instances created by this method can also be provided to CPageCustomData methods

CPageContent_Create2()

CPageContent CPageContent_Create2	(	IDRS_INT const	iPageWidth,
		IDRS_INT const	iPageHeight,
		IDRS_INT const	iPageResolution,
		idrs_exception *	pargException
	)

Create instantiates a new page content object and initializes the basic values.

Parameters

iPageWidth	Page width
iPageHeight	Page height
iPageResolution	Page resolution
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

Instances created by this method can also be provided to CPageCustomData methods

CPageContent_Destroy()

void CPageContent_Destroy	(	CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Destroys a CPageContent handle.

Parameters

argCPageContent	CPageContent handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetGraphicShapes()

CPageGraphicShapeArray CPageContent_GetGraphicShapes	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets an array containing all graphic shapes in the page.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetMetadata()

CPageMetadata CPageContent_GetMetadata	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets the page metadata.

Returns

The page metadata.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetPageHeight()

IDRS_INT CPageContent_GetPageHeight	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets the page height.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetPageMainLanguage()

enum Language CPageContent_GetPageMainLanguage	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets the main language used in the page.

Note

There might be several languages used in the page. The main language represents the language that is used more often.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetPageMargins()

MarginInfo CPageContent_GetPageMargins	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets the page margins.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetPageResolution()

IDRS_INT CPageContent_GetPageResolution	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets the page resolution.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetPageStyle()

CPageStyle CPageContent_GetPageStyle	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets the style object associated to the page content.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetPageWidth()

IDRS_INT CPageContent_GetPageWidth	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets the page width.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_GetSections()

CPageSectionArray CPageContent_GetSections	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Gets an array with all sections in the page.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_QueryPageZones()

const CPageZoneArray CPageContent_QueryPageZones	(	const CPageContent	argCPageContent,
		idrs_exception *	pargException
	)

Retrieves a list containing all the the zones of the page content.

Note

For content generated via full page OCR, the zones in the array will be sorted by the reading order detected by the OCR engine; while for content generated via zonal OCR, the zones in the array will be sorted in the same order than their corresponding COcrZoneDescription were registered in input params.

A new array is created for retrieving the results, therefore any modification such as adding or removing elements from that array has no effect on the page content.

Parameters

argCPageContent	CPageContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetGraphicShapes()

void CPageContent_SetGraphicShapes	(	CPageContent	argCPageContent,
		const CPageGraphicShapeArray	argShapes,
		idrs_exception *	pargException
	)

Sets the array containing the graphic shapes.

Parameters

argCPageContent	CPageContent handle
argShapes	Array containing graphic shapes
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetMetadata()

void CPageContent_SetMetadata	(	CPageContent	argCPageContent,
		const CPageMetadata	argPageMetadata,
		idrs_exception *	pargException
	)

Sets the page metadata.

Parameters

argCPageContent	CPageContent handle
argPageMetadata	The metadata to set
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetPageHeight()

void CPageContent_SetPageHeight	(	CPageContent	argCPageContent,
		IDRS_INT const	iPageHeight,
		idrs_exception *	pargException
	)

Sets the page height.

Parameters

argCPageContent	CPageContent handle
iPageHeight	Page height
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetPageMainLanguage()

void CPageContent_SetPageMainLanguage	(	CPageContent	argCPageContent,
		enum Language const	evPageLanguage,
		idrs_exception *	pargException
	)

Sets the main language used in the page.

Parameters

argCPageContent	CPageContent handle
evPageLanguage	Main language used in the page
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetPageMargins()

void CPageContent_SetPageMargins	(	CPageContent	argCPageContent,
		const MarginInfo *	stPageMargins,
		idrs_exception *	pargException
	)

Sets the page margins.

Parameters

argCPageContent	CPageContent handle
stPageMargins	Structure containing the page margins
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetPageResolution()

void CPageContent_SetPageResolution	(	CPageContent	argCPageContent,
		IDRS_INT const	iPageResolution,
		idrs_exception *	pargException
	)

Sets the page resolution.

Parameters

argCPageContent	CPageContent handle
iPageResolution	Page resolution
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetPageStyle()

void CPageContent_SetPageStyle	(	CPageContent	argCPageContent,
		const CPageStyle	argPageStyle,
		idrs_exception *	pargException
	)

Sets the page style associated to the page content.

Parameters

argCPageContent	CPageContent handle
argPageStyle	Page style object
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetPageWidth()

void CPageContent_SetPageWidth	(	CPageContent	argCPageContent,
		IDRS_INT const	iPageWidth,
		idrs_exception *	pargException
	)

Sets the page width.

Parameters

argCPageContent	CPageContent handle
iPageWidth	Page width
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageContent_SetSections()

void CPageContent_SetSections	(	CPageContent	argCPageContent,
		const CPageSectionArray	argSections,
		idrs_exception *	pargException
	)

Sets the array containing the page sections.

Parameters

argCPageContent	CPageContent handle
argSections	Page sections array
pargException	Pointer to exception structure that will be filled if an exception occurs