iDRS™ SDK 16
Loading...
Searching...
No Matches
CPageContent_interface.h
Go to the documentation of this file.
1
7#ifndef CPAGECONTENT_INTERFACE_H
8
9#define CPAGECONTENT_INTERFACE_H
10
16#include "ArrayInterface.h"
17
18#include "idrs_common.h"
19
20#ifdef __cplusplus
21extern "C" {
22#endif
23
29CPageContent CPageContent_Create(idrs_exception *pargException);
30
40CPageContent CPageContent_Create2(IDRS_INT const iPageWidth, IDRS_INT const iPageHeight, IDRS_INT const iPageResolution, idrs_exception *pargException);
41
47IDRS_INT CPageContent_GetPageWidth(const CPageContent argCPageContent, idrs_exception *pargException);
48
54IDRS_INT CPageContent_GetPageHeight(const CPageContent argCPageContent, idrs_exception *pargException);
55
61IDRS_INT CPageContent_GetPageResolution(const CPageContent argCPageContent, idrs_exception *pargException);
62
68MarginInfo CPageContent_GetPageMargins(const CPageContent argCPageContent, idrs_exception *pargException);
69
77enum Language CPageContent_GetPageMainLanguage(const CPageContent argCPageContent, idrs_exception *pargException);
78
84CPageSectionArray CPageContent_GetSections(const CPageContent argCPageContent, idrs_exception *pargException);
85
91CPageGraphicShapeArray CPageContent_GetGraphicShapes(const CPageContent argCPageContent, idrs_exception *pargException);
92
104const CPageZoneArray CPageContent_QueryPageZones(const CPageContent argCPageContent, idrs_exception *pargException);
105
113void CPageContent_SetPageWidth(CPageContent argCPageContent, IDRS_INT const iPageWidth, idrs_exception *pargException);
114
122void CPageContent_SetPageHeight(CPageContent argCPageContent, IDRS_INT const iPageHeight, idrs_exception *pargException);
123
131void CPageContent_SetPageResolution(CPageContent argCPageContent, IDRS_INT const iPageResolution, idrs_exception *pargException);
132
140void CPageContent_SetPageMargins(CPageContent argCPageContent, const MarginInfo* stPageMargins, idrs_exception *pargException);
141
149void CPageContent_SetPageMainLanguage(CPageContent argCPageContent, enum Language const evPageLanguage, idrs_exception *pargException);
150
158void CPageContent_SetSections(CPageContent argCPageContent, const CPageSectionArray argSections, idrs_exception *pargException);
159
167void CPageContent_SetGraphicShapes(CPageContent argCPageContent, const CPageGraphicShapeArray argShapes, idrs_exception *pargException);
168
174CPageStyle CPageContent_GetPageStyle(const CPageContent argCPageContent, idrs_exception *pargException);
175
183void CPageContent_SetPageStyle(CPageContent argCPageContent, const CPageStyle argPageStyle, idrs_exception *pargException);
184
192CPageMetadata CPageContent_GetMetadata(const CPageContent argCPageContent, idrs_exception *pargException);
193
201void CPageContent_SetMetadata(CPageContent argCPageContent, const CPageMetadata argPageMetadata, idrs_exception *pargException);
202
208void CPageContent_Clear(CPageContent argCPageContent, idrs_exception *pargException);
209
217void CPageContent_Destroy(CPageContent argCPageContent, idrs_exception *pargException);
218
219#ifdef __cplusplus
220}
221#endif /* __cplusplus */
222
223#endif /* CPAGECONTENT_INTERFACE_H */
Interface for TObjPtrArray wrapper.
CPageMetadata CPageContent_GetMetadata(const CPageContent argCPageContent, idrs_exception *pargException)
Gets the page metadata.
void CPageContent_SetPageHeight(CPageContent argCPageContent, IDRS_INT const iPageHeight, idrs_exception *pargException)
Sets the page height.
void CPageContent_SetPageMargins(CPageContent argCPageContent, const MarginInfo *stPageMargins, idrs_exception *pargException)
Sets the page margins.
IDRS_INT CPageContent_GetPageResolution(const CPageContent argCPageContent, idrs_exception *pargException)
Gets the page resolution.
CPageContent CPageContent_Create2(IDRS_INT const iPageWidth, IDRS_INT const iPageHeight, IDRS_INT const iPageResolution, idrs_exception *pargException)
Create instantiates a new page content object and initializes the basic values.
void CPageContent_SetMetadata(CPageContent argCPageContent, const CPageMetadata argPageMetadata, idrs_exception *pargException)
Sets the page metadata.
enum Language CPageContent_GetPageMainLanguage(const CPageContent argCPageContent, idrs_exception *pargException)
Gets the main language used in the page.
void CPageContent_SetPageStyle(CPageContent argCPageContent, const CPageStyle argPageStyle, idrs_exception *pargException)
Sets the page style associated to the page content.
void CPageContent_SetPageWidth(CPageContent argCPageContent, IDRS_INT const iPageWidth, idrs_exception *pargException)
Sets the page width.
MarginInfo CPageContent_GetPageMargins(const CPageContent argCPageContent, idrs_exception *pargException)
Gets the page margins.
void CPageContent_Destroy(CPageContent argCPageContent, idrs_exception *pargException)
Destroys a CPageContent handle.
void CPageContent_Clear(CPageContent argCPageContent, idrs_exception *pargException)
Clears all elements in the page.
void CPageContent_SetSections(CPageContent argCPageContent, const CPageSectionArray argSections, idrs_exception *pargException)
Sets the array containing the page sections.
CPageContent CPageContent_Create(idrs_exception *pargException)
Instantiates a new page content object with default values.
CPageGraphicShapeArray CPageContent_GetGraphicShapes(const CPageContent argCPageContent, idrs_exception *pargException)
Gets an array containing all graphic shapes in the page.
CPageSectionArray CPageContent_GetSections(const CPageContent argCPageContent, idrs_exception *pargException)
Gets an array with all sections in the page.
IDRS_INT CPageContent_GetPageHeight(const CPageContent argCPageContent, idrs_exception *pargException)
Gets the page height.
void CPageContent_SetPageResolution(CPageContent argCPageContent, IDRS_INT const iPageResolution, idrs_exception *pargException)
Sets the page resolution.
CPageStyle CPageContent_GetPageStyle(const CPageContent argCPageContent, idrs_exception *pargException)
Gets the style object associated to the page content.
IDRS_INT CPageContent_GetPageWidth(const CPageContent argCPageContent, idrs_exception *pargException)
Gets the page width.
void CPageContent_SetGraphicShapes(CPageContent argCPageContent, const CPageGraphicShapeArray argShapes, idrs_exception *pargException)
Sets the array containing the graphic shapes.
const CPageZoneArray CPageContent_QueryPageZones(const CPageContent argCPageContent, idrs_exception *pargException)
Retrieves a list containing all the the zones of the page content.
void CPageContent_SetPageMainLanguage(CPageContent argCPageContent, enum Language const evPageLanguage, idrs_exception *pargException)
Sets the main language used in the page.
Interface for CPageCustomData wrapper.
Interface for CPageGraphicShape wrapper.
Interface for CPageMetadata wrapper.
Interface for CPageSection wrapper.
Interface for CPageStyle wrapper.
CPageContent represents the results content of CPage.
CPageMetadata represents the metadata content of a page.
Sets the page style associated to a page.
Language
The Language data type defines a language identifier.
Definition Language_interface.h:25
int IDRS_INT
A signed integer.
Definition idrsstd_interface.h:25
Structure containing the margins for a page element.
Definition StructDefinitions_interface.h:35