API-ref-idrs16/html_c/_c_document__interface_8h_source.html

#ifndef CDOCUMENT_INTERFACE_H


#define CDOCUMENT_INTERFACE_H


#include "CObjPtr_interface.h"

#include "CDocumentMetadata_interface.h"

#include "IPageCollection_interface.h"


#include "idrs_common.h"


#ifdef __cplusplus

extern "C" {

#endif


CDocument CDocument_Create(CIDRS argIDRS, IDRS_BOOL const bBlocking, idrs_exception *pargException);


CDocument CDocument_Create2(CIDRS argIDRS, idrs_exception *pargException);


CDocument CDocument_Create3(IPageCollection argPageCollection, idrs_exception *pargException);


IPageCollection CDocument_GetPages(const CDocument argCDocument, idrs_exception *pargException);


CDocumentMetadata CDocument_GetMetadata(const CDocument argCDocument, idrs_exception *pargException);


void CDocument_SetMetadata(CDocument argCDocument, const CDocumentMetadata argMetadata, idrs_exception *pargException);


void CDocument_Destroy(CDocument argCDocument, idrs_exception *pargException);


#ifdef __cplusplus

}

#endif /* __cplusplus */


#endif /* CDOCUMENT_INTERFACE_H */

CDocument_GetMetadata
CDocumentMetadata CDocument_GetMetadata(const CDocument argCDocument, idrs_exception *pargException)
GetMetadata returns the document's metadata container.

CDocument_Create2
CDocument CDocument_Create2(CIDRS argIDRS, idrs_exception *pargException)
Creates a new CDocument that uses a CDefaultPageCollection to handle the pages.

CDocument_Destroy
void CDocument_Destroy(CDocument argCDocument, idrs_exception *pargException)
Destroys a CDocument handle.

CDocument_GetPages
IPageCollection CDocument_GetPages(const CDocument argCDocument, idrs_exception *pargException)
GetPages returns the collection of CPage elements.

CDocument_Create3
CDocument CDocument_Create3(IPageCollection argPageCollection, idrs_exception *pargException)
Creates a new CDocument that uses a custom IPageCollection.

CDocument_SetMetadata
void CDocument_SetMetadata(CDocument argCDocument, const CDocumentMetadata argMetadata, idrs_exception *pargException)
SetMetadata sets the document's metadata.

CDocument_Create
CDocument CDocument_Create(CIDRS argIDRS, IDRS_BOOL const bBlocking, idrs_exception *pargException)
Creates a new CDocument that uses a CDefaultPageCollection to handle the pages.

CDocumentMetadata_interface.h
Interface for CDocumentMetadata wrapper.

CObjPtr_interface.h
Interface for CObjPtr wrapper.

IPageCollection_interface.h
Interface for IPageCollection wrapper.

CDocument
CDocument class represents a document composed of a set of CPage elements.

CDocumentMetadata
CDocumentMetadata class represents the set of metadata defined at the document level.

IPageCollection
IPageCollection defines the interface for a page collection.

idrs_common.h

IDRS_BOOL
IDRS_INT IDRS_BOOL
A Boolean value.
Definition idrsstd_interface.h:37