API-ref-idrs16/html_c/_c_page_zone__interface_8h_source.html

#ifndef CPAGEZONE_INTERFACE_H


#define CPAGEZONE_INTERFACE_H


#include "CPageCustomData_interface.h"

#include "EnumDefinitions_interface.h"

#include "StructDefinitions_interface.h"

#include "idrs_string_interface.h"

#include "ArrayInterface.h"


#include "idrs_common.h"


#ifdef __cplusplus

extern "C" {

#endif


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


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


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


CPolygon CPageZone_GetBoundingPolygon(const CPageZone argCPageZone, idrs_exception *pargException);


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


PaddingInfo CPageZone_GetPadding(const CPageZone argCPageZone, idrs_exception *pargException);


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


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


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


IDRS_INT CPageZone_GetZoneOrder(const CPageZone argCPageZone, idrs_exception *pargException);


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


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


idrs_string CPageZone_GetIdentifier(const CPageZone argCPageZone, idrs_exception *pargException);


void CPageZone_Destroy(CPageZone argCPageZone, idrs_exception *pargException);


CPageZoneArray ArrayInterface_Create_CPageZoneArray(idrs_exception *pargException);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* CPAGEZONE_INTERFACE_H */

ArrayInterface.h
Interface for TObjPtrArray wrapper.

CPageCustomData_interface.h
Interface for CPageCustomData wrapper.

ArrayInterface_Create_CPageZoneArray
CPageZoneArray ArrayInterface_Create_CPageZoneArray(idrs_exception *pargException)
Creates a new CPageZoneArray object.

CPageZone_SetZoneOrder
void CPageZone_SetZoneOrder(CPageZone argCPageZone, IDRS_INT const iZoneOrder, idrs_exception *pargException)
Set the reading order to a zone.

CPageZone_GetIdentifier
idrs_string CPageZone_GetIdentifier(const CPageZone argCPageZone, idrs_exception *pargException)
Retrieves the identifier of the zone.

CPageZone_SetPadding
void CPageZone_SetPadding(CPageZone argCPageZone, const PaddingInfo *stPaddingInfo, idrs_exception *pargException)
Set the zone's padding information.

CPageZone_GetBoundingPolygon
CPolygon CPageZone_GetBoundingPolygon(const CPageZone argCPageZone, idrs_exception *pargException)
Get the bounding polygon.

CPageZone_SetBoundingPolygon
void CPageZone_SetBoundingPolygon(CPageZone argCPageZone, const CPolygon argBoundingPolygon, idrs_exception *pargException)
Set the polygon containing all zone content.

CPageZone_GetTextDirection
enum TextDirection CPageZone_GetTextDirection(const CPageZone argCPageZone, idrs_exception *pargException)
Get the text direction for the current zone.

CPageZone_GetZoneOrder
IDRS_INT CPageZone_GetZoneOrder(const CPageZone argCPageZone, idrs_exception *pargException)
Get the reading order of the zone.

CPageZone_SetIdentifier
void CPageZone_SetIdentifier(CPageZone argCPageZone, const idrs_string strZoneIdentifier, idrs_exception *pargException)
Assigns a unique identifier to the zone.

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.

CPageZone_GetZoneType
enum ZoneType CPageZone_GetZoneType(const CPageZone argCPageZone, idrs_exception *pargException)
Get the zone type.

CPageZone_SetTextDirection
void CPageZone_SetTextDirection(CPageZone argCPageZone, enum TextDirection const evTextDirection, idrs_exception *pargException)
Set the text direction for the current zone.

CPageZone_Destroy
void CPageZone_Destroy(CPageZone argCPageZone, idrs_exception *pargException)
Destroys a CPageZone handle.

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.

CPageZone_GetPadding
PaddingInfo CPageZone_GetPadding(const CPageZone argCPageZone, idrs_exception *pargException)
Get the zone's padding information.

EnumDefinitions_interface.h
Interface for EnumDefinitions wrapper.

TextDirection
TextDirection
The TextDirection data type defines the text direction of the concerned element it is applied to.
Definition EnumDefinitions_interface.h:461

ZoneType
ZoneType
The ZoneType data type defines the type of a zone.
Definition EnumDefinitions_interface.h:363

StructDefinitions_interface.h
Interface for StructDefinitions wrapper.

CPageZone
Class CPageZone represents the base class for all zones available in iDRS SDK.

CPolygon
The CPolygon class handles polygons for iDRS.

idrs_string
Class that handles a string of characters.

idrs_common.h

idrs_string_interface.h
Interface for idrs_string wrapper.

IDRS_INT
int IDRS_INT
A signed integer.
Definition idrsstd_interface.h:25

PaddingInfo
Structure containing the padding information for a page.
Definition StructDefinitions_interface.h:21