API-ref-idrs16/html_c/_c_page__interface_8h_source.html

#ifndef CPAGE_INTERFACE_H


#define CPAGE_INTERFACE_H


#include "CImage_interface.h"

#include "ILineReader_interface.h"

#include "CPageContent_interface.h"

#include "ArrayInterface.h"


#include "idrs_common.h"


#ifdef __cplusplus

extern "C" {

#endif


CPage CPage_Create(CIDRS argIDRS, idrs_exception *pargException);


CPage CPage_Create2(const CImage argImage, idrs_exception *pargException);


void CPage_SetSourceImage(CPage argCPage, const CImage argImage, idrs_exception *pargException);


CImage CPage_GetSourceImage(const CPage argCPage, idrs_exception *pargException);


IDRS_UINT CPage_GetWidth(const CPage argCPage, idrs_exception *pargException);


IDRS_UINT CPage_GetHeight(const CPage argCPage, idrs_exception *pargException);


IDRS_UINT CPage_GetResolution(const CPage argCPage, idrs_exception *pargException);


CPageContent CPage_GetPageContent(const CPage argCPage, idrs_exception *pargException);


void CPage_SetPageContent(const CPage argCPage, const CPageContent argPageContent, idrs_exception *pargException);


void CPage_SetWorkImage(CPage argCPage, const CImage argImage, idrs_exception *pargException);


CImage CPage_GetWorkImage(const CPage argCPage, idrs_exception *pargException);


void CPage_SetBackgroundImage(CPage argCPage, const CImage argBackgroundImage, idrs_exception *pargException);


CImage CPage_GetBackgroundImage(const CPage argCPage, idrs_exception *pargException);


void CPage_Destroy(CPage argCPage, idrs_exception *pargException);


CPageArray ArrayInterface_Create_CPageArray(idrs_exception *pargException);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* CPAGE_INTERFACE_H */

ArrayInterface.h
Interface for TObjPtrArray wrapper.

CImage_interface.h
Interface for CImage wrapper.

CPage_SetBackgroundImage
void CPage_SetBackgroundImage(CPage argCPage, const CImage argBackgroundImage, idrs_exception *pargException)
Sets the background image to use during document output if required.

CPage_GetBackgroundImage
CImage CPage_GetBackgroundImage(const CPage argCPage, idrs_exception *pargException)
Gets the background image to use during document output if required.

CPage_GetSourceImage
CImage CPage_GetSourceImage(const CPage argCPage, idrs_exception *pargException)
Gets the source image associated to the current CPage object.

CPage_Destroy
void CPage_Destroy(CPage argCPage, idrs_exception *pargException)
Destroys a CPage handle.

ArrayInterface_Create_CPageArray
CPageArray ArrayInterface_Create_CPageArray(idrs_exception *pargException)
Creates a new CPageArray object.

CPage_GetResolution
IDRS_UINT CPage_GetResolution(const CPage argCPage, idrs_exception *pargException)

CPage_GetHeight
IDRS_UINT CPage_GetHeight(const CPage argCPage, idrs_exception *pargException)

CPage_SetSourceImage
void CPage_SetSourceImage(CPage argCPage, const CImage argImage, idrs_exception *pargException)
SetSourceImage sets the source image for the page.

CPage_SetWorkImage
void CPage_SetWorkImage(CPage argCPage, const CImage argImage, idrs_exception *pargException)
Sets the work image that can be used by the processing engines (page analysis, barcode processing and...

CPage_Create2
CPage CPage_Create2(const CImage argImage, idrs_exception *pargException)
Create creates a new page from an existing image.

CPage_Create
CPage CPage_Create(CIDRS argIDRS, idrs_exception *pargException)
Create creates a new page.

CPage_GetWidth
IDRS_UINT CPage_GetWidth(const CPage argCPage, idrs_exception *pargException)

CPage_SetPageContent
void CPage_SetPageContent(const CPage argCPage, const CPageContent argPageContent, idrs_exception *pargException)
Sets the CPageContent object associated with the CPage object.

CPage_GetWorkImage
CImage CPage_GetWorkImage(const CPage argCPage, idrs_exception *pargException)
Gets the work image set into the CPage object.

CPage_GetPageContent
CPageContent CPage_GetPageContent(const CPage argCPage, idrs_exception *pargException)
Gets page access content of the page via CPageContent class.

CPageContent_interface.h
Interface for CPageContent wrapper.

ILineReader_interface.h
Interface for ILineReader wrapper.

CImage
The CImage class manages images for iDRS.

CPageContent
CPageContent represents the results content of CPage.

CPage
The CPage class manages a page in the IDRS.

idrs_common.h

IDRS_UINT
unsigned int IDRS_UINT
An unsigned integer.
Definition idrsstd_interface.h:27