iDRS™ SDK 16
Loading...
Searching...
No Matches
CPageBookmark_interface.h
Go to the documentation of this file.
1
7#ifndef CPAGEBOOKMARK_INTERFACE_H
8
9#define CPAGEBOOKMARK_INTERFACE_H
10
13#include "ArrayInterface.h"
14
15#include "idrs_common.h"
16
17#ifdef __cplusplus
18extern "C" {
19#endif
20
28CPageBookmark CPageBookmark_Create(const idrs_string strTitle, idrs_exception *pargException);
29
35CPageBookmarkArray CPageBookmark_GetChildren(const CPageBookmark argCPageBookmark, idrs_exception *pargException);
36
44void CPageBookmark_SetChildren(CPageBookmark argCPageBookmark, const CPageBookmarkArray xChildren, idrs_exception *pargException);
45
53const idrs_string CPageBookmark_GetTitle(const CPageBookmark argCPageBookmark, idrs_exception *pargException);
54
62void CPageBookmark_SetTitle(CPageBookmark argCPageBookmark, const idrs_string strTitle, idrs_exception *pargException);
63
71enum BookmarkDisplayMode CPageBookmark_GetDisplayMode(const CPageBookmark argCPageBookmark, idrs_exception *pargException);
72
84void CPageBookmark_SetDisplayMode(CPageBookmark argCPageBookmark, const enum BookmarkDisplayMode* const evDisplayMode, idrs_exception *pargException);
85
93IDRS_UINT CPageBookmark_GetDestinationPage(const CPageBookmark argCPageBookmark, idrs_exception *pargException);
94
102void CPageBookmark_SetDestinationPage(CPageBookmark argCPageBookmark, IDRS_UINT const uiDestinationPageIndex, idrs_exception *pargException);
103
111IDRS_RECT CPageBookmark_GetDestination(const CPageBookmark argCPageBookmark, idrs_exception *pargException);
112
125void CPageBookmark_SetDestination(CPageBookmark argCPageBookmark, const IDRS_RECT* stDestination, idrs_exception *pargException);
126
134IDRS_UINT CPageBookmark_GetZoomFactor(const CPageBookmark argCPageBookmark, idrs_exception *pargException);
135
148void CPageBookmark_SetZoomFactor(CPageBookmark argCPageBookmark, const IDRS_UINT* const uiZoomFactor, idrs_exception *pargException);
149
157void CPageBookmark_Destroy(CPageBookmark argCPageBookmark, idrs_exception *pargException);
158
167CPageBookmarkArray ArrayInterface_Create_CPageBookmarkArray(idrs_exception *pargException);
168
169#ifdef __cplusplus
170}
171#endif /* __cplusplus */
172
173#endif /* CPAGEBOOKMARK_INTERFACE_H */
Interface for TObjPtrArray wrapper.
CPageBookmark CPageBookmark_Create(const idrs_string strTitle, idrs_exception *pargException)
Creates a new instance.
void CPageBookmark_SetZoomFactor(CPageBookmark argCPageBookmark, const IDRS_UINT *const uiZoomFactor, idrs_exception *pargException)
Set the bookmark zoom factor.
CPageBookmarkArray CPageBookmark_GetChildren(const CPageBookmark argCPageBookmark, idrs_exception *pargException)
Returns the bookmark's children.
void CPageBookmark_SetDestinationPage(CPageBookmark argCPageBookmark, IDRS_UINT const uiDestinationPageIndex, idrs_exception *pargException)
Sets the bookmark destination page index.
void CPageBookmark_SetChildren(CPageBookmark argCPageBookmark, const CPageBookmarkArray xChildren, idrs_exception *pargException)
Set the bookmark's children.
void CPageBookmark_Destroy(CPageBookmark argCPageBookmark, idrs_exception *pargException)
Destroys a CPageBookmark handle.
IDRS_UINT CPageBookmark_GetZoomFactor(const CPageBookmark argCPageBookmark, idrs_exception *pargException)
Get the bookmark zoom factor.
CPageBookmarkArray ArrayInterface_Create_CPageBookmarkArray(idrs_exception *pargException)
Creates a new CPageBookmarkArray object.
const idrs_string CPageBookmark_GetTitle(const CPageBookmark argCPageBookmark, idrs_exception *pargException)
Get the title of the bookmark.
void CPageBookmark_SetDisplayMode(CPageBookmark argCPageBookmark, const enum BookmarkDisplayMode *const evDisplayMode, idrs_exception *pargException)
Set the display mode of the bookmark.
void CPageBookmark_SetDestination(CPageBookmark argCPageBookmark, const IDRS_RECT *stDestination, idrs_exception *pargException)
Set the bookmark destination (positioning on the page).
void CPageBookmark_SetTitle(CPageBookmark argCPageBookmark, const idrs_string strTitle, idrs_exception *pargException)
Set the title of the bookmark.
enum BookmarkDisplayMode CPageBookmark_GetDisplayMode(const CPageBookmark argCPageBookmark, idrs_exception *pargException)
Get the display mode of the bookmark.
IDRS_UINT CPageBookmark_GetDestinationPage(const CPageBookmark argCPageBookmark, idrs_exception *pargException)
Gets the bookmark destination page index.
IDRS_RECT CPageBookmark_GetDestination(const CPageBookmark argCPageBookmark, idrs_exception *pargException)
Get the bookmark destination (positioning on the page).
Interface for CPageCustomData wrapper.
Interface for EnumDefinitions wrapper.
BookmarkDisplayMode
Enumeration allowing to specify a bookmark's display mode.
Definition EnumDefinitions_interface.h:261
CPageBookmark represents a bookmark on a page.
Class that handles a string of characters.
unsigned int IDRS_UINT
An unsigned integer.
Definition idrsstd_interface.h:27
Structure that defines the upper-left and lower-right corners of a rectangle.
Definition idrsstd_interface.h:60