CPageTextLine_interface.h File Reference

Interface for CPageTextLine wrapper. More...

Go to the source code of this file.

Functions
CPageTextLine	CPageTextLine_Create (idrs_exception *pargException)
	Creates a new instance of CPageTextLine.
CPolygon	CPageTextLine_GetBoundingPolygon (const CPageTextLine argCPageTextLine, idrs_exception *pargException)
	Get the polygon where the text line is located.
void	CPageTextLine_SetBoundingPolygon (CPageTextLine argCPageTextLine, const CPolygon argBoundingPolygon, idrs_exception *pargException)
	Set the polygon where the text line is located.
IDRS_INT	CPageTextLine_GetBaseline (const CPageTextLine argCPageTextLine, idrs_exception *pargException)
	Get the baseline for the text line.
void	CPageTextLine_SetBaseline (CPageTextLine argCPageTextLine, IDRS_INT const iBaseline, idrs_exception *pargException)
	Set the baseline for the text line.
CPageWordArray	CPageTextLine_GetWords (const CPageTextLine argCPageTextLine, idrs_exception *pargException)
	GetWords retrieves the array of words in the line.
void	CPageTextLine_SetWords (CPageTextLine argCPageTextLine, const CPageWordArray argxWords, idrs_exception *pargException)
	Set the array containing the words in the line.
void	CPageTextLine_Destroy (CPageTextLine argCPageTextLine, idrs_exception *pargException)
	Destroys a CPageTextLine handle.
CPageTextLineArray	ArrayInterface_Create_CPageTextLineArray (idrs_exception *pargException)
	Creates a new CPageTextLineArray object.

Detailed Description

Interface for CPageTextLine wrapper.

Function Documentation

ArrayInterface_Create_CPageTextLineArray()

CPageTextLineArray ArrayInterface_Create_CPageTextLineArray

(

idrs_exception *

pargException

)

Creates a new CPageTextLineArray object.

Parameters

pargException

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

Returns

The newly created CPageTextLineArray

CPageTextLine_Create()

CPageTextLine CPageTextLine_Create

(

idrs_exception *

pargException

)

Creates a new instance of CPageTextLine.

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

CPageTextLine_Destroy()

void CPageTextLine_Destroy	(	CPageTextLine	argCPageTextLine,
		idrs_exception *	pargException
	)

Destroys a CPageTextLine handle.

Parameters

argCPageTextLine	CPageTextLine handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTextLine_GetBaseline()

IDRS_INT CPageTextLine_GetBaseline	(	const CPageTextLine	argCPageTextLine,
		idrs_exception *	pargException
	)

Get the baseline for the text line.

Parameters

argCPageTextLine	CPageTextLine handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTextLine_GetBoundingPolygon()

CPolygon CPageTextLine_GetBoundingPolygon	(	const CPageTextLine	argCPageTextLine,
		idrs_exception *	pargException
	)

Get the polygon where the text line is located.

Parameters

argCPageTextLine	CPageTextLine handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTextLine_GetWords()

CPageWordArray CPageTextLine_GetWords	(	const CPageTextLine	argCPageTextLine,
		idrs_exception *	pargException
	)

GetWords retrieves the array of words in the line.

Parameters

argCPageTextLine	CPageTextLine handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTextLine_SetBaseline()

void CPageTextLine_SetBaseline	(	CPageTextLine	argCPageTextLine,
		IDRS_INT const	iBaseline,
		idrs_exception *	pargException
	)

Set the baseline for the text line.

Parameters

argCPageTextLine	CPageTextLine handle
iBaseline	Baseline value
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTextLine_SetBoundingPolygon()

void CPageTextLine_SetBoundingPolygon	(	CPageTextLine	argCPageTextLine,
		const CPolygon	argBoundingPolygon,
		idrs_exception *	pargException
	)

Set the polygon where the text line is located.

Parameters

argCPageTextLine	CPageTextLine handle
argBoundingPolygon	Polygon containing the text line
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageTextLine_SetWords()

void CPageTextLine_SetWords	(	CPageTextLine	argCPageTextLine,
		const CPageWordArray	argxWords,
		idrs_exception *	pargException
	)

Set the array containing the words in the line.

Parameters

argCPageTextLine	CPageTextLine handle
argxWords	Array containing the words in the line
pargException	Pointer to exception structure that will be filled if an exception occurs