fpdf_page_w.h
Go to the documentation of this file.
1 
24 #ifndef _FSPDF_PAGE_W_H_
25 #define _FSPDF_PAGE_W_H_
26 
80 #ifdef __cplusplus
81 extern "C" {
82 #endif
83 
84 /*******************************************************************************/
85 /* Access PDF page attributes */
86 /*******************************************************************************/
113 FS_RESULT FSPDF_Page_SetIndex(FSCRT_PAGE page, FS_INT32 index);
114 
143 FS_RESULT FSPDF_Page_SetSize(FSCRT_PAGE page, FS_FLOAT width, FS_FLOAT height);
144 
169 FS_RESULT FSPDF_Page_SetRotation(FSCRT_PAGE page, FS_INT32 rotation);
170 
197 FS_RESULT FSPDF_Page_SetBox(FSCRT_PAGE page, FS_INT32 boxType, const FSCRT_RECTF* pageBox);
198 
199 /********************************************************************************/
200 /* Page trigger actions */
201 /********************************************************************************/
230 FS_RESULT FSPDF_Page_SetAction(FSCRT_PAGE page, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA* actionData);
231 
259 FS_RESULT FSPDF_Page_InsertAction(FSCRT_PAGE page, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA* actionData);
260 
287 FS_RESULT FSPDF_Page_RemoveAction(FSCRT_PAGE page, FS_INT32 trigger, FS_INT32 index);
288 
314 FS_RESULT FSPDF_Page_RemoveAllActions(FSCRT_PAGE page, FS_INT32 trigger);
315 
342 FS_RESULT FSPDF_Page_Transform(FSCRT_PAGE page, const FSCRT_MATRIX* matrix, FS_BOOL needTransformClipPath);
343 
370 FS_RESULT FSPDF_Page_SetClipRect(FSCRT_PAGE page, const FSCRT_RECTF* clipRect);
371 
372 /********************************************************************************/
373 /* Page editing */
374 /********************************************************************************/
375 #ifndef _FSPDF_DEF_MACRO_FLATTENFLAG_
376 #define _FSPDF_DEF_MACRO_FLATTENFLAG_
377 
384 #define FSPDF_FLATTENFLAG_DISPLAY 0
385 
389 #define FSPDF_FLATTENFLAG_PRINT 1
390 
391 #define FSPDF_FLATTENFLAG_NOANNOT 2
392 
393 #define FSPDF_FLATTENFLAG_NOFORMCONTROL 4
394 
396 #endif /* _FSPDF_DEF_MACRO_FLATTENFLAG_ */
397 
429 FS_RESULT FSPDF_Page_Create(FSCRT_DOCUMENT document, FS_INT32 index, FSCRT_PAGE* page);
430 
454 FS_RESULT FSPDF_Page_Delete(FSCRT_PAGE page);
455 
484 FS_RESULT FSPDF_Page_Flatten(FSCRT_PAGE page, FS_DWORD flags);
485 
510 FS_RESULT FSPDF_Page_SetThumbnail(FSCRT_PAGE page, FSCRT_BITMAP thumbnail);
511 
512 #ifdef __cplusplus
513 };
514 #endif
515  /* group FPDFPAGE */
517 
518 #endif /* _FSPDF_PAGE_W_H_ */
519 
FS_RESULT FSPDF_Page_Flatten(FSCRT_PAGE page, FS_DWORD flags)
Flatten a PDF page, and annotations or form fields will be made to be a part of the page contents...
Structure for rectangle, in float.
Definition: fs_base_r.h:2078
float FS_FLOAT
32-bit floating-point number, single precision.
Definition: fs_base_r.h:148
FS_RESULT FSPDF_Page_Transform(FSCRT_PAGE page, const FSCRT_MATRIX *matrix, FS_BOOL needTransformClipPath)
Transform a PDF page, including the annotations and form fields on the page.
FS_RESULT FSPDF_Page_SetClipRect(FSCRT_PAGE page, const FSCRT_RECTF *clipRect)
Set clip rectangle for all page objects on PDF page.
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142
FS_RESULT FSPDF_Page_RemoveAction(FSCRT_PAGE page, FS_INT32 trigger, FS_INT32 index)
Remove a page trigger action.
FS_RESULT FSPDF_Page_RemoveAllActions(FSCRT_PAGE page, FS_INT32 trigger)
Remove all trigger actions of a PDF page.
FS_RESULT FSPDF_Page_SetRotation(FSCRT_PAGE page, FS_INT32 rotation)
Set page rotation.
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FS_RESULT FSPDF_Page_Delete(FSCRT_PAGE page)
Delete a page from document.
Structure for an action data.
Definition: fpdf_base_r.h:841
int FS_BOOL
Boolean type (This should be TRUE or FALSE).
Definition: fs_base_r.h:133
FS_RESULT FSPDF_Page_SetBox(FSCRT_PAGE page, FS_INT32 boxType, const FSCRT_RECTF *pageBox)
Set page box which is a rectangle type of value.
FS_RESULT FSPDF_Page_Create(FSCRT_DOCUMENT document, FS_INT32 index, FSCRT_PAGE *page)
Create a new page to a position specified by the index.
FS_RESULT FSPDF_Page_SetIndex(FSCRT_PAGE page, FS_INT32 index)
Change page index of a PDF page.
Structure for 2D matrix.
Definition: fs_base_r.h:2130
FS_RESULT FSPDF_Page_SetAction(FSCRT_PAGE page, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA *actionData)
Set a page trigger action.
FS_RESULT FSPDF_Page_SetThumbnail(FSCRT_PAGE page, FSCRT_BITMAP thumbnail)
Set a thumbnail bitmap to a page.
FS_RESULT FSPDF_Page_SetSize(FSCRT_PAGE page, FS_FLOAT width, FS_FLOAT height)
Set page size.
FS_RESULT FSPDF_Page_InsertAction(FSCRT_PAGE page, FS_INT32 trigger, FS_INT32 index, const FSPDF_ACTIONDATA *actionData)
Insert a page trigger action.
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160

Foxit Corporation