CPageSection_interface.h File Reference

Interface for CPageSection wrapper. More...

Go to the source code of this file.

Functions
CPageSection	CPageSection_Create (idrs_exception *pargException)
	Creates a new instance of a section object.
IDRS_RECT	CPageSection_GetBoundingBox (const CPageSection argCPageSection, idrs_exception *pargException)
	Get the rectangle where the section is located.
void	CPageSection_SetBoundingBox (CPageSection argCPageSection, const IDRS_RECT *rcBoundingBox, idrs_exception *pargException)
	Set the rectangle where the page section is located.
CPageColumnArray	CPageSection_GetColumns (const CPageSection argCPageSection, idrs_exception *pargException)
	Get the columns that are inside the section.
CPageZoneArray	CPageSection_GetZones (const CPageSection argCPageSection, idrs_exception *pargException)
	Get the zones that are inside the section, but not in any column.
void	CPageSection_SetColumns (CPageSection argCPageSection, const CPageColumnArray xColumns, idrs_exception *pargException)
	Set the array of columns available in the current section.
void	CPageSection_SetZones (CPageSection argCPageSection, const CPageZoneArray xZones, idrs_exception *pargException)
	Set the array of zones in the current section that are not present in any column.
IDRS_BOOL	CPageSection_HasLineBetweenColumns (const CPageSection argCPageSection, idrs_exception *pargException)
	HasLineBetweenColumns returns a flag indicating whether there's a line between the columns in the section.
void	CPageSection_SetHasLineBetweenColumns (CPageSection argCPageSection, IDRS_BOOL const bValue, idrs_exception *pargException)
	SetHasLineBetweenColumns sets the flag indicating that there's a line betweent the columns in the section.
void	CPageSection_Destroy (CPageSection argCPageSection, idrs_exception *pargException)
	Destroys a CPageSection handle.
CPageSectionArray	ArrayInterface_Create_CPageSectionArray (idrs_exception *pargException)
	Creates a new CPageSectionArray object.

Detailed Description

Interface for CPageSection wrapper.

Function Documentation

ArrayInterface_Create_CPageSectionArray()

CPageSectionArray ArrayInterface_Create_CPageSectionArray

(

idrs_exception *

pargException

)

Creates a new CPageSectionArray object.

Parameters

pargException

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

Returns

The newly created CPageSectionArray

CPageSection_Create()

CPageSection CPageSection_Create

(

idrs_exception *

pargException

)

Creates a new instance of a section 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 CPageCustomData methods

CPageSection_Destroy()

void CPageSection_Destroy	(	CPageSection	argCPageSection,
		idrs_exception *	pargException
	)

Destroys a CPageSection handle.

Parameters

argCPageSection	CPageSection handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageSection_GetBoundingBox()

IDRS_RECT CPageSection_GetBoundingBox	(	const CPageSection	argCPageSection,
		idrs_exception *	pargException
	)

Get the rectangle where the section is located.

Parameters

argCPageSection	CPageSection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageSection_GetColumns()

CPageColumnArray CPageSection_GetColumns	(	const CPageSection	argCPageSection,
		idrs_exception *	pargException
	)

Get the columns that are inside the section.

Parameters

argCPageSection	CPageSection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageSection_GetZones()

CPageZoneArray CPageSection_GetZones	(	const CPageSection	argCPageSection,
		idrs_exception *	pargException
	)

Get the zones that are inside the section, but not in any column.

Parameters

argCPageSection	CPageSection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageSection_HasLineBetweenColumns()

IDRS_BOOL CPageSection_HasLineBetweenColumns	(	const CPageSection	argCPageSection,
		idrs_exception *	pargException
	)

HasLineBetweenColumns returns a flag indicating whether there's a line between the columns in the section.

Parameters

argCPageSection	CPageSection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageSection_SetBoundingBox()

void CPageSection_SetBoundingBox	(	CPageSection	argCPageSection,
		const IDRS_RECT *	rcBoundingBox,
		idrs_exception *	pargException
	)

Set the rectangle where the page section is located.

Parameters

argCPageSection	CPageSection handle
rcBoundingBox	Rectangle containing the coordinates for section location
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageSection_SetColumns()

void CPageSection_SetColumns	(	CPageSection	argCPageSection,
		const CPageColumnArray	xColumns,
		idrs_exception *	pargException
	)

Set the array of columns available in the current section.

Parameters

argCPageSection	CPageSection handle
xColumns	Array of columns
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageSection_SetHasLineBetweenColumns()

void CPageSection_SetHasLineBetweenColumns	(	CPageSection	argCPageSection,
		IDRS_BOOL const	bValue,
		idrs_exception *	pargException
	)

SetHasLineBetweenColumns sets the flag indicating that there's a line betweent the columns in the section.

Parameters

argCPageSection	CPageSection handle
bValue	Line between columns flag value
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageSection_SetZones()

void CPageSection_SetZones	(	CPageSection	argCPageSection,
		const CPageZoneArray	xZones,
		idrs_exception *	pargException
	)

Set the array of zones in the current section that are not present in any column.

Parameters

argCPageSection	CPageSection handle
xZones	Array of zones
pargException	Pointer to exception structure that will be filled if an exception occurs