CPageColumn_interface.h File Reference

Interface for CPageColumn wrapper. More...

Go to the source code of this file.

Functions
CPageColumn	CPageColumn_Create (idrs_exception *pargException)
	Instantiates a new CPageColumn object.
IDRS_RECT	CPageColumn_GetBoundingBox (const CPageColumn argCPageColumn, idrs_exception *pargException)
	Gets the rectangle containing the column.
void	CPageColumn_SetBoundingBox (CPageColumn argCPageColumn, const IDRS_RECT *rcBoundingBox, idrs_exception *pargException)
	Sets the coordinates for the bounding rectangle.
CPageZoneArray	CPageColumn_GetZones (const CPageColumn argCPageColumn, idrs_exception *pargException)
	Gets an array containing the zones in the column.
void	CPageColumn_SetZones (CPageColumn argCPageColumn, const CPageZoneArray xZones, idrs_exception *pargException)
	Sets the zones in the column.
void	CPageColumn_Destroy (CPageColumn argCPageColumn, idrs_exception *pargException)
	Destroys a CPageColumn handle.
CPageColumnArray	ArrayInterface_Create_CPageColumnArray (idrs_exception *pargException)
	Creates a new CPageColumnArray object.

Detailed Description

Interface for CPageColumn wrapper.

Function Documentation

ArrayInterface_Create_CPageColumnArray()

CPageColumnArray ArrayInterface_Create_CPageColumnArray

(

idrs_exception *

pargException

)

Creates a new CPageColumnArray object.

Parameters

pargException

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

Returns

The newly created CPageColumnArray

CPageColumn_Create()

CPageColumn CPageColumn_Create

(

idrs_exception *

pargException

)

Instantiates a new CPageColumn 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

CPageColumn_Destroy()

void CPageColumn_Destroy	(	CPageColumn	argCPageColumn,
		idrs_exception *	pargException
	)

Destroys a CPageColumn handle.

Parameters

argCPageColumn	CPageColumn handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageColumn_GetBoundingBox()

IDRS_RECT CPageColumn_GetBoundingBox	(	const CPageColumn	argCPageColumn,
		idrs_exception *	pargException
	)

Gets the rectangle containing the column.

Returns

the rectangle containing the column.

Parameters

argCPageColumn	CPageColumn handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageColumn_GetZones()

CPageZoneArray CPageColumn_GetZones	(	const CPageColumn	argCPageColumn,
		idrs_exception *	pargException
	)

Gets an array containing the zones in the column.

Returns

an array containing the zones in the column.

Parameters

argCPageColumn	CPageColumn handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageColumn_SetBoundingBox()

void CPageColumn_SetBoundingBox	(	CPageColumn	argCPageColumn,
		const IDRS_RECT *	rcBoundingBox,
		idrs_exception *	pargException
	)

Sets the coordinates for the bounding rectangle.

Parameters

argCPageColumn	CPageColumn handle
rcBoundingBox	Bounding rectangle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageColumn_SetZones()

void CPageColumn_SetZones	(	CPageColumn	argCPageColumn,
		const CPageZoneArray	xZones,
		idrs_exception *	pargException
	)

Sets the zones in the column.

Important:

The zone coordinates need to be included in the column bounding box

Parameters

argCPageColumn	CPageColumn handle
xZones	List of zones
pargException	Pointer to exception structure that will be filled if an exception occurs