CPageZone_interface.h File Reference

Interface for CPageZone wrapper. More...

Go to the source code of this file.

Functions
CPageZone	CPageZone_Create (enum ZoneType const evZoneType, idrs_exception *pargException)
	Creates an instance of CPageZone object with the data object pointing to the correct type of zone.
CPageZone	CPageZone_Create2 (enum ZoneType const evZoneType, CPolygon objBoundingPolygon, idrs_exception *pargException)
	Creates an instance of CPageZone object with the data object pointing to the correct type of zone.
enum ZoneType	CPageZone_GetZoneType (const CPageZone argCPageZone, idrs_exception *pargException)
	Get the zone type.
CPolygon	CPageZone_GetBoundingPolygon (const CPageZone argCPageZone, idrs_exception *pargException)
	Get the bounding polygon.
void	CPageZone_SetBoundingPolygon (CPageZone argCPageZone, const CPolygon argBoundingPolygon, idrs_exception *pargException)
	Set the polygon containing all zone content.
PaddingInfo	CPageZone_GetPadding (const CPageZone argCPageZone, idrs_exception *pargException)
	Get the zone's padding information.
void	CPageZone_SetPadding (CPageZone argCPageZone, const PaddingInfo *stPaddingInfo, idrs_exception *pargException)
	Set the zone's padding information.
enum TextDirection	CPageZone_GetTextDirection (const CPageZone argCPageZone, idrs_exception *pargException)
	Get the text direction for the current zone.
void	CPageZone_SetTextDirection (CPageZone argCPageZone, enum TextDirection const evTextDirection, idrs_exception *pargException)
	Set the text direction for the current zone.
IDRS_INT	CPageZone_GetZoneOrder (const CPageZone argCPageZone, idrs_exception *pargException)
	Get the reading order of the zone.
void	CPageZone_SetZoneOrder (CPageZone argCPageZone, IDRS_INT const iZoneOrder, idrs_exception *pargException)
	Set the reading order to a zone.
void	CPageZone_SetIdentifier (CPageZone argCPageZone, const idrs_string strZoneIdentifier, idrs_exception *pargException)
	Assigns a unique identifier to the zone.
idrs_string	CPageZone_GetIdentifier (const CPageZone argCPageZone, idrs_exception *pargException)
	Retrieves the identifier of the zone.
void	CPageZone_Destroy (CPageZone argCPageZone, idrs_exception *pargException)
	Destroys a CPageZone handle.
CPageZoneArray	ArrayInterface_Create_CPageZoneArray (idrs_exception *pargException)
	Creates a new CPageZoneArray object.

Detailed Description

Interface for CPageZone wrapper.

Function Documentation

ArrayInterface_Create_CPageZoneArray()

CPageZoneArray ArrayInterface_Create_CPageZoneArray

(

idrs_exception *

pargException

)

Creates a new CPageZoneArray object.

Parameters

pargException

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

Returns

The newly created CPageZoneArray

CPageZone_Create()

CPageZone CPageZone_Create	(	enum ZoneType const	evZoneType,
		idrs_exception *	pargException
	)

Creates an instance of CPageZone object with the data object pointing to the correct type of zone.

This method instantiates the following objects, based on the zone type:

• ZoneType::Text, ZoneType::Text:

  See also

  CPageZoneText CPageZoneText

• ZoneType::Table:

  See also

  CPageZoneTable CPageZoneTable

• ZoneType::Graphic:

  See also

  CPageZoneGraphic CPageZoneGraphic

  Parameters

  evZoneType	Zone type
  pargException	Pointer to exception structure that will be filled if an exception occurs

  Returns

  CPageZone object with the data object pointing to the correct type of data class

  Remarks

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

CPageZone_Create2()

CPageZone CPageZone_Create2	(	enum ZoneType const	evZoneType,
		CPolygon	objBoundingPolygon,
		idrs_exception *	pargException
	)

Creates an instance of CPageZone object with the data object pointing to the correct type of zone.

This method instantiates the following objects, based on the zone type:

• ZoneType::Text, ZoneType::Text:

  See also

  CPageZoneText CPageZoneText

• ZoneType::Table:

  See also

  CPageZoneTable CPageZoneTable

• ZoneType::Graphic:

  See also

  CPageZoneGraphic CPageZoneGraphic

  Parameters

  evZoneType	Zone type
  objBoundingPolygon	Polygon where all elements withing the zone are located
  pargException	Pointer to exception structure that will be filled if an exception occurs

  Returns

  CPageZone object with the data object pointing to the correct type of data class

  Remarks

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

CPageZone_Destroy()

void CPageZone_Destroy	(	CPageZone	argCPageZone,
		idrs_exception *	pargException
	)

Destroys a CPageZone handle.

Parameters

argCPageZone	CPageZone handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_GetBoundingPolygon()

CPolygon CPageZone_GetBoundingPolygon	(	const CPageZone	argCPageZone,
		idrs_exception *	pargException
	)

Get the bounding polygon.

Parameters

argCPageZone	CPageZone handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_GetIdentifier()

idrs_string CPageZone_GetIdentifier	(	const CPageZone	argCPageZone,
		idrs_exception *	pargException
	)

Retrieves the identifier of the zone.

If zonal OCR recognition has been performed, the zone identifier is automatically copied from the COcrZoneDescription object used to define the current zone's OCR parameters.

If full-page OCR recognition has been executed, the zone identifier will be an empty string.

If SetIdentifier has been called, this method returns the assigned zone identifier.

Returns

The identifier associated with the zone.

Parameters

argCPageZone	CPageZone handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_GetPadding()

PaddingInfo CPageZone_GetPadding	(	const CPageZone	argCPageZone,
		idrs_exception *	pargException
	)

Get the zone's padding information.

Paragraph style's margins are expected to be computed relative to this rectangle.

Returns

The padding box

Parameters

argCPageZone	CPageZone handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_GetTextDirection()

enum TextDirection CPageZone_GetTextDirection	(	const CPageZone	argCPageZone,
		idrs_exception *	pargException
	)

Get the text direction for the current zone.

Note

Text direction is not useful for graphical zones

The default value is IDRS::TextDirection::LeftToRight

Returns

Text direction

Parameters

argCPageZone	CPageZone handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_GetZoneOrder()

IDRS_INT CPageZone_GetZoneOrder	(	const CPageZone	argCPageZone,
		idrs_exception *	pargException
	)

Get the reading order of the zone.

The ocr engine returns the zones in reading order. The reading order is considering the human reading order, based on the language used for OCR

Parameters

argCPageZone	CPageZone handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_GetZoneType()

enum ZoneType CPageZone_GetZoneType	(	const CPageZone	argCPageZone,
		idrs_exception *	pargException
	)

Get the zone type.

Parameters

argCPageZone	CPageZone handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_SetBoundingPolygon()

void CPageZone_SetBoundingPolygon	(	CPageZone	argCPageZone,
		const CPolygon	argBoundingPolygon,
		idrs_exception *	pargException
	)

Set the polygon containing all zone content.

Parameters

argCPageZone	CPageZone handle
argBoundingPolygon	Polygon object
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_SetIdentifier()

void CPageZone_SetIdentifier	(	CPageZone	argCPageZone,
		const idrs_string	strZoneIdentifier,
		idrs_exception *	pargException
	)

Assigns a unique identifier to the zone.

Note

If zonal OCR recognition has already been performed, this call will override the identifier previously set in COcrZoneDescription.

Parameters

argCPageZone	CPageZone handle
strZoneIdentifier	The user-defined identifier for the zone.
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_SetPadding()

void CPageZone_SetPadding	(	CPageZone	argCPageZone,
		const PaddingInfo *	stPaddingInfo,
		idrs_exception *	pargException
	)

Set the zone's padding information.

Paragraph style's margins are expected to be computed relative to this rectangle.

Parameters

argCPageZone	CPageZone handle
stPaddingInfo	The padding to set
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_SetTextDirection()

void CPageZone_SetTextDirection	(	CPageZone	argCPageZone,
		enum TextDirection const	evTextDirection,
		idrs_exception *	pargException
	)

Set the text direction for the current zone.

Note

Text direction is not useful for graphical zones

The default value is IDRS::TextDirection::LeftToRight

Parameters

argCPageZone	CPageZone handle
evTextDirection	Text direction
pargException	Pointer to exception structure that will be filled if an exception occurs

CPageZone_SetZoneOrder()

void CPageZone_SetZoneOrder	(	CPageZone	argCPageZone,
		IDRS_INT const	iZoneOrder,
		idrs_exception *	pargException
	)

Set the reading order to a zone.

Parameters

argCPageZone	CPageZone handle
iZoneOrder	Zone reading order
pargException	Pointer to exception structure that will be filled if an exception occurs