iDRS™ SDK 16
Loading...
Searching...
No Matches
IPageCollection_interface.h
Go to the documentation of this file.
1
7#ifndef IPAGECOLLECTION_INTERFACE_H
8
9#define IPAGECOLLECTION_INTERFACE_H
10
12#include "idrskrn_interface.h"
13
14#include "idrs_common.h"
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
20typedef enum PageCollectionType (*PtrGetTypeFn)();
21
22typedef CPage (*PtrGetAtFn)(IDRS_UINT const);
23
24typedef void (*PtrSetAtFn)(IDRS_UINT const, const CPage);
25
26typedef void (*PtrAddTailFn)(const CPage);
27
28typedef void (*PtrSetPageProcessedFn)(IDRS_UINT const, IDRS_BOOL const);
29
30typedef IDRS_BOOL (*PtrGetPageProcessedFn)(IDRS_UINT const);
31
46IPageCollection IPageCollection_Create(PtrGetTypeFn ptrGetTypeFn, PtrGetAtFn ptrGetAtFn, PtrSetAtFn ptrSetAtFn, PtrAddTailFn ptrAddTailFn, PtrSetPageProcessedFn ptrSetPageProcessedFn, PtrGetPageProcessedFn ptrGetPageProcessedFn, idrs_exception *pargException);
47
55void IPageCollection_Destroy(IPageCollection argIPageCollection, idrs_exception *pargException);
56
66enum PageCollectionType IPageCollection_GetType(const IPageCollection argIPageCollection, idrs_exception *pargException);
67
77CPage IPageCollection_GetAt(const IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException);
78
90void IPageCollection_SetAt(IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, const CPage argPage, idrs_exception *pargException);
91
99void IPageCollection_AddTail(IPageCollection argIPageCollection, const CPage argPage, idrs_exception *pargException);
100
109void IPageCollection_SetPageProcessed(IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, IDRS_BOOL const argValue, idrs_exception *pargException);
110
120IDRS_BOOL IPageCollection_GetPageProcessed(const IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException);
121
122#ifdef __cplusplus
123}
124#endif /* __cplusplus */
125
126#endif /* IPAGECOLLECTION_INTERFACE_H */
Interface for EnumDefinitions wrapper.
PageCollectionType
Definition of the available types of IPageCollection implementations.
Definition EnumDefinitions_interface.h:2713
void IPageCollection_AddTail(IPageCollection argIPageCollection, const CPage argPage, idrs_exception *pargException)
Adds the specified page after the one stored with the highest index in the collection.
IDRS_BOOL IPageCollection_GetPageProcessed(const IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
Reads the flag that indicates whether the page at specified index has been processed by CDocumentWrit...
enum PageCollectionType IPageCollection_GetType(const IPageCollection argIPageCollection, idrs_exception *pargException)
GetType returns the type of this collection, either default or custom.
void IPageCollection_Destroy(IPageCollection argIPageCollection, idrs_exception *pargException)
Destroys a IPageCollection handle.
void IPageCollection_SetAt(IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, const CPage argPage, idrs_exception *pargException)
Sets the page at the specified index in the collection.
void IPageCollection_SetPageProcessed(IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, IDRS_BOOL const argValue, idrs_exception *pargException)
Sets the flag that indicates whether the page at specified index has been processed by CDocumentWrite...
IPageCollection IPageCollection_Create(PtrGetTypeFn ptrGetTypeFn, PtrGetAtFn ptrGetAtFn, PtrSetAtFn ptrSetAtFn, PtrAddTailFn ptrAddTailFn, PtrSetPageProcessedFn ptrSetPageProcessedFn, PtrGetPageProcessedFn ptrGetPageProcessedFn, idrs_exception *pargException)
Creates a new IPageCollection object.
CPage IPageCollection_GetAt(const IPageCollection argIPageCollection, IDRS_UINT const uiPageIndex, idrs_exception *pargException)
GetAt returns the page at the specified index.
The CPage class manages a page in the IDRS.
IPageCollection defines the interface for a page collection.
Interface for idrskrn wrapper.
IDRS_INT IDRS_BOOL
A Boolean value.
Definition idrsstd_interface.h:37
unsigned int IDRS_UINT
An unsigned integer.
Definition idrsstd_interface.h:27