fpdf_pageobjects_w.h
Go to the documentation of this file.
1 
31 #ifndef _FSPDF_PAGEOBJECTS_W_H_
32 #define _FSPDF_PAGEOBJECTS_W_H_
33 
86 #ifdef __cplusplus
87 extern "C" {
88 #endif
89 
90 /*******************************************************************************/
91 /* Page objects */
92 /*******************************************************************************/
131 FS_RESULT FSPDF_PageObjects_InsertObject(FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FS_INT32 typeFilter, FS_INT32 index, FSPDF_PAGEOBJECT pageObj);
132 
160 FS_RESULT FSPDF_PageObjects_RemoveObject(FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FSPDF_PAGEOBJECT pageObj);
161 
190 FS_RESULT FSPDF_PageObjects_GenerateContents(FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs);
191 
192 /*******************************************************************************/
193 /* Page object */
194 /*******************************************************************************/
225 FS_RESULT FSPDF_PageObject_Clone(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_PAGEOBJECT* clonedPageObj);
226 
254 FS_RESULT FSPDF_PageObject_SetMatrix(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_MATRIX* matrix);
255 
285 FS_RESULT FSPDF_PageObject_Transform(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_MATRIX* matrix, FS_BOOL needTransformClipPath);
286 
313 FS_RESULT FSPDF_PageObject_SetGraphState(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSPDF_GRAPHSTATE* graphState);
314 
344 FS_RESULT FSPDF_PageObject_SetColor(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_BOOL isStroke, FS_ARGB color);
345 
371 FS_RESULT FSPDF_PageObject_SetClipRect(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_RECTF* clipRect);
372 
373 /********************************************************************************/
374 /* Text object */
375 /********************************************************************************/
401 FS_RESULT FSPDF_TextObject_Create(FSCRT_PAGE page, FSPDF_PAGEOBJECT* textObj);
402 
433 FS_RESULT FSPDF_TextObject_SetTextState(FSCRT_PAGE page, FSPDF_PAGEOBJECT textObj,
434  const FSPDF_TEXTSTATE* textState, FS_BOOL italic, FS_INT32 weight);
435 
467 FS_RESULT FSPDF_TextObject_SetUnicodeString(FSCRT_PAGE page, FSPDF_PAGEOBJECT textObj, const FSCRT_BSTR* unicodeStr);
468 
469 /*******************************************************************************/
470 /* Path object */
471 /*******************************************************************************/
497 FS_RESULT FSPDF_PathObject_Create(FSCRT_PAGE page, FSPDF_PAGEOBJECT* pathObj);
498 
525 FS_RESULT FSPDF_PathObject_SetPathData(FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FSCRT_PATHDATA pathData);
526 
552 FS_RESULT FSPDF_PathObject_SetFillMode(FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FS_INT32 fillMode);
553 
583 FS_RESULT FSPDF_PathObject_SetStrokeState(FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FS_BOOL isStroke);
584 
616 FS_RESULT FSPDF_PathObject_ConvertFromTextObject(FSCRT_PAGE page, FSPDF_PAGEOBJECT* convertedObj);
617 
618 /*******************************************************************************/
619 /* Image object */
620 /*******************************************************************************/
646 FS_RESULT FSPDF_ImageObject_Create(FSCRT_PAGE page, FSPDF_PAGEOBJECT* imageObj);
647 
680 FS_RESULT FSPDF_ImageObject_SetBitmap(FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FSCRT_BITMAP bitmap, FSCRT_BITMAP mask);
681 
714 FS_RESULT FSPDF_ImageObject_SetImage(FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FSCRT_IMAGE image);
715 
752 FS_RESULT FSPDF_ImageObject_SetImageFromFileName(FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, const FSCRT_BSTR* imageFileName, FS_INT32 frameIndexOfImage);
753 
754 /*******************************************************************************/
755 /* Form XObject object */
756 /*******************************************************************************/
782 FS_RESULT FSPDF_FormXObject_Create(FSCRT_PAGE page, FSPDF_PAGEOBJECT* formXObj);
783 
812 FS_RESULT FSPDF_FormXObject_ExtractAPFromPage(FSCRT_PAGE page, FSPDF_PAGEOBJECT formXObj, FSCRT_PAGE srcPage, FS_BOOL isAnnotsIncluded);
813 
814 /*******************************************************************************/
815 /* Clipping data */
816 /*******************************************************************************/
844 FS_RESULT FSPDF_PageObject_AddClipPath(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSCRT_PATHDATA pathData, FS_INT32 fillMode);
845 
872 FS_RESULT FSPDF_PageObject_DeleteClipPath(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 index);
873 
900 FS_RESULT FSPDF_PageObject_AddClipText(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_PAGEOBJECT textObj);
901 
929 FS_RESULT FSPDF_PageObject_DeleteClipText(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 index);
930 
955 FS_RESULT FSPDF_PageObject_ClearClips(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj);
956 
957 /*******************************************************************************/
958 /* Page object release */
959 /*******************************************************************************/
986 FS_RESULT FSPDF_PageObject_Release(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj);
987 
988 #ifdef __cplusplus
989 };
990 #endif
991  /* group FPDFPAGEOBJECTS */
992 
993 
994 #endif // _FSPDF_PAGEOBJECTS_W_H_
FS_RESULT FSPDF_ImageObject_SetBitmap(FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FSCRT_BITMAP bitmap, FSCRT_BITMAP mask)
Set a bitmap to an image object.
FS_RESULT FSPDF_PageObject_ClearClips(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj)
Clear all clips from a page object.
FS_RESULT FSPDF_PageObject_Transform(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_MATRIX *matrix, FS_BOOL needTransformClipPath)
Transform a page object.
FS_RESULT FSPDF_PageObject_AddClipText(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_PAGEOBJECT textObj)
Add text for clipping to a page object.
Structure for rectangle, in float.
Definition: fs_base_r.h:2078
FS_RESULT FSPDF_FormXObject_Create(FSCRT_PAGE page, FSPDF_PAGEOBJECT *formXObj)
Create a Form XObject object.
FS_RESULT FSPDF_PageObject_SetClipRect(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_RECTF *clipRect)
Set clip rectangle of a page object.
FS_RESULT FSPDF_PageObject_SetMatrix(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSCRT_MATRIX *matrix)
Set matrix of a page object.
FS_RESULT FSPDF_PageObject_Clone(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSPDF_PAGEOBJECT *clonedPageObj)
Clone a new page object.
FS_RESULT FSPDF_PageObjects_InsertObject(FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FS_INT32 typeFilter, FS_INT32 index, FSPDF_PAGEOBJECT pageObj)
Insert a page object and it will be automatically freed.
FS_RESULT FSPDF_PathObject_SetFillMode(FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FS_INT32 fillMode)
Set fill mode of a path object.
FS_RESULT FSPDF_PathObject_ConvertFromTextObject(FSCRT_PAGE page, FSPDF_PAGEOBJECT *convertedObj)
Convert text object to path object for avoiding print deviation.
FS_RESULT FSPDF_PathObject_Create(FSCRT_PAGE page, FSPDF_PAGEOBJECT *pathObj)
Create a new path object.
FS_RESULT FSPDF_ImageObject_Create(FSCRT_PAGE page, FSPDF_PAGEOBJECT *imageObj)
Create an image object.
FS_RESULT FSPDF_PathObject_SetStrokeState(FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FS_BOOL isStroke)
Set stroke state of a path object.
FS_RESULT FSPDF_PageObject_DeleteClipPath(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 index)
Delete a path for clipping from a page object.
FS_RESULT FSPDF_PageObjects_GenerateContents(FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs)
Generate PDF Page contents.
Structure for PDF text states.
Definition: fpdf_pageobjects_r.h:239
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FS_RESULT FSPDF_PageObject_AddClipPath(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FSCRT_PATHDATA pathData, FS_INT32 fillMode)
Add path for clipping to a page object.
FS_RESULT FSPDF_PathObject_SetPathData(FSCRT_PAGE page, FSPDF_PAGEOBJECT pathObj, FSCRT_PATHDATA pathData)
Set path data of a path object.
FS_RESULT FSPDF_ImageObject_SetImage(FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, FSCRT_IMAGE image)
Set an image to an image object.
FS_RESULT FSPDF_FormXObject_ExtractAPFromPage(FSCRT_PAGE page, FSPDF_PAGEOBJECT formXObj, FSCRT_PAGE srcPage, FS_BOOL isAnnotsIncluded)
Extract appearance of contents and annotations from a source page to a Form XObject object...
FS_RESULT FSPDF_PageObject_SetColor(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_BOOL isStroke, FS_ARGB color)
Set color of a page object .
int FS_BOOL
Boolean type (This should be TRUE or FALSE).
Definition: fs_base_r.h:133
FS_RESULT FSPDF_PageObject_SetGraphState(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, const FSPDF_GRAPHSTATE *graphState)
Set graph states of a page object.
FS_RESULT FSPDF_ImageObject_SetImageFromFileName(FSCRT_PAGE page, FSPDF_PAGEOBJECT imageObj, const FSCRT_BSTR *imageFileName, FS_INT32 frameIndexOfImage)
Set an image to an image object from a specific file path.
FS_RESULT FSPDF_PageObjects_RemoveObject(FSCRT_PAGE page, FSPDF_PAGEOBJECTS pageObjs, FSPDF_PAGEOBJECT pageObj)
Remove a page object.
Structure for PDF graph states.
Definition: fpdf_pageobjects_r.h:199
unsigned int FS_ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_base_r.h:145
FS_RESULT FSPDF_PageObject_Release(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj)
Release a page object which is created or which is cloned but not inserted into any PDF page...
FS_RESULT FSPDF_TextObject_SetUnicodeString(FSCRT_PAGE page, FSPDF_PAGEOBJECT textObj, const FSCRT_BSTR *unicodeStr)
Set unicode string for a text object.
Structure for 2D matrix.
Definition: fs_base_r.h:2130
Structure for byte string.
Definition: fs_base_r.h:611
FS_RESULT FSPDF_TextObject_SetTextState(FSCRT_PAGE page, FSPDF_PAGEOBJECT textObj, const FSPDF_TEXTSTATE *textState, FS_BOOL italic, FS_INT32 weight)
Set text states of a text object.
FS_RESULT FSPDF_PageObject_DeleteClipText(FSCRT_PAGE page, FSPDF_PAGEOBJECT pageObj, FS_INT32 index)
Delete a text for clipping from a page object.
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160
FS_RESULT FSPDF_TextObject_Create(FSCRT_PAGE page, FSPDF_PAGEOBJECT *textObj)
Create a new text Object.

Foxit Corporation