fpdf_markedcontent_r.h
Go to the documentation of this file.
1 
24 #ifndef _FSPDF_MARKEDCONTENT_R_H_
25 #define _FSPDF_MARKEDCONTENT_R_H_
26 
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
83 /*******************************************************************************/
84 /* PDF Marked Content */
85 /*******************************************************************************/
86 #ifndef _FSPDF_DEF_HANDLE_MARKEDCONTENT_
87 #define _FSPDF_DEF_HANDLE_MARKEDCONTENT_
88 
90 FSCRT_DEFINEHANDLE(FSPDF_MARKEDCONTENT);
91 #endif /* _FSPDF_DEF_HANDLE_MARKEDCONTENT_ */
92 
93 #ifndef _FSPDF_DEF_MACRO_MARKEDCONTENT_PARAMTYPE_
94 #define _FSPDF_DEF_MACRO_MARKEDCONTENT_PARAMTYPE_
95 
101 #define FSPDF_MARKEDCONTENT_PARAMTYPE_NONE 0
102 
103 #define FSPDF_MARKEDCONTENT_PARAMTYPE_PROPERTIESDICT 1
104 
105 #define FSPDF_MARKEDCONTENT_PARAMTYPE_DIRECTDICT 2
106 
113 #define FSPDF_MARKEDCONTENT_PARAMTYPE_MCID 3
114 
116 #endif /* _FSPDF_DEF_MACRO_MARKEDCONTENT_PARAMTYPE_ */
117 
147 FS_RESULT FSPDF_PageObject_GetMarkedContent(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_MARKEDCONTENT* mc);
148 
177 FS_RESULT FSPDF_MarkedContent_CountItems(FSCRT_PAGE page, FSPDF_MARKEDCONTENT mc, FS_INT32* count);
178 
211 FS_RESULT FSPDF_MarkedContent_GetTagName (FSCRT_PAGE page, FSPDF_MARKEDCONTENT mc, FS_INT32 index, FSCRT_BSTR* tagName);
212 
243 FS_RESULT FSPDF_MarkedContent_HasTag(FSCRT_PAGE page, FSPDF_MARKEDCONTENT mc, const FSCRT_BSTR* tagName, FS_BOOL* bHas);
244 
287 FS_RESULT FSPDF_MarkedContent_GetItemParam(FSCRT_PAGE page, FSPDF_MARKEDCONTENT mc, const FSCRT_BSTR* tagName, FS_INT32* paramType, FS_LPVOID* param);
288 
289 #ifdef __cplusplus
290 };
291 #endif
292  /* group FPDFPAGEOBJECTS */
294 
295 #endif /* _FSPDF_MARKEDCONTENT_R_H_ */
FS_RESULT FSPDF_MarkedContent_HasTag(FSCRT_PAGE page, FSPDF_MARKEDCONTENT mc, const FSCRT_BSTR *tagName, FS_BOOL *bHas)
Check whether a marked content object has a specified marked content item.
FS_RESULT FSPDF_MarkedContent_CountItems(FSCRT_PAGE page, FSPDF_MARKEDCONTENT mc, FS_INT32 *count)
Get the count of marked content items in the marked content sequence.
FS_RESULT FSPDF_MarkedContent_GetItemParam(FSCRT_PAGE page, FSPDF_MARKEDCONTENT mc, const FSCRT_BSTR *tagName, FS_INT32 *paramType, FS_LPVOID *param)
Get a parameter type of a parameter value of a specific marked content item.
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FS_RESULT FSPDF_MarkedContent_GetTagName(FSCRT_PAGE page, FSPDF_MARKEDCONTENT mc, FS_INT32 index, FSCRT_BSTR *tagName)
Get the tag name of a specific marked content item.
int FS_BOOL
Boolean type (This should be TRUE or FALSE).
Definition: fs_base_r.h:133
FS_RESULT FSPDF_PageObject_GetMarkedContent(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_MARKEDCONTENT *mc)
Get a marked content object from a page object.
void * FS_LPVOID
A pointer to any types.
Definition: fs_base_r.h:127
Structure for byte string.
Definition: fs_base_r.h:611
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160

Foxit Corporation