CPageZoneText_interface.h File Reference

Interface for CPageZoneText wrapper. More...

Go to the source code of this file.

Functions
CPageZoneText	CPageZoneText_Create (idrs_exception *pargException)
	Creates a new instance of a CPageZoneText object.
CPageZoneText	CPageZoneText_Create2 (const CPageZone argPageZone, idrs_exception *pargException)
	Constructor using the base class.
CPageParagraphsGroupArray	CPageZoneText_GetParagraphsGroups (const CPageZoneText argCPageZoneText, idrs_exception *pargException)
	Get the list of paragraphs groups present in the current text zone.
void	CPageZoneText_SetParagraphsGroups (CPageZoneText argCPageZoneText, const CPageParagraphsGroupArray argParagraphsGroups, idrs_exception *pargException)
	Set the list of paragraphs groups.
void	CPageZoneText_Destroy (CPageZoneText argCPageZoneText, idrs_exception *pargException)
	Destroys a CPageZoneText handle.

Detailed Description

Interface for CPageZoneText wrapper.

Function Documentation

CPageZoneText_Create()

CPageZoneText CPageZoneText_Create

(

idrs_exception *

pargException

)

Creates a new instance of a CPageZoneText object.

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 CPageZone methods

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

CPageZoneText_Create2()

CPageZoneText CPageZoneText_Create2	(	const CPageZone	argPageZone,
		idrs_exception *	pargException
	)

Constructor using the base class.

Parameters

argPageZone	Base page zone
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

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

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

CPageZoneText_Destroy()

void CPageZoneText_Destroy	(	CPageZoneText	argCPageZoneText,
		idrs_exception *	pargException
	)

Destroys a CPageZoneText handle.

Parameters

argCPageZoneText	CPageZoneText handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZoneText_GetParagraphsGroups()

CPageParagraphsGroupArray CPageZoneText_GetParagraphsGroups	(	const CPageZoneText	argCPageZoneText,
		idrs_exception *	pargException
	)

Get the list of paragraphs groups present in the current text zone.

Parameters

argCPageZoneText	CPageZoneText handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZoneText_SetParagraphsGroups()

void CPageZoneText_SetParagraphsGroups	(	CPageZoneText	argCPageZoneText,
		const CPageParagraphsGroupArray	argParagraphsGroups,
		idrs_exception *	pargException
	)

Set the list of paragraphs groups.

Parameters

argCPageZoneText	CPageZoneText handle
argParagraphsGroups	Array of paragraph groups
pargException	Pointer to exception structure that will be filled if an exception occurs