fpdf_base_r.h
Go to the documentation of this file.
1 
28 #ifndef _FSPDF_BASE_R_H_
29 #define _FSPDF_BASE_R_H_
30 
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71 
72 /*******************************************************************************/
73 /* PDF module */
74 /*******************************************************************************/
98 
119 
120 /*******************************************************************************/
121 /* Common definitions */
122 /* */
123 /* PDF permissions, page areas, alignment, default appearance */
124 /*******************************************************************************/
125 #ifndef _FSPDF_DEF_MACRO_PERMISSION_
126 #define _FSPDF_DEF_MACRO_PERMISSION_
127 
140 #define FSPDF_PERMISSION_PRINT 0x0004
141 
147 #define FSPDF_PERMISSION_MODIFY 0x0008
148 
154 #define FSPDF_PERMISSION_EXTRACT 0x0010
155 
160 #define FSPDF_PERMISSION_ANNOTFORM 0x0020
161 
167 #define FSPDF_PERMISSION_FILLFORM 0x0100
168 
174 #define FSPDF_PERMISSION_EXTRACTACCESS 0x0200
175 
181 #define FSPDF_PERMISSION_ASSEMBLE 0x0400
182 
188 #define FSPDF_PERMISSION_PRINT_HIGH 0x0800
189 
191 #endif /* _FSPDF_DEF_MACRO_PERMISSION_ */
192 
193 #ifndef _FSPDF_DEF_MACRO_PAGEBOX_
194 #define _FSPDF_DEF_MACRO_PAGEBOX_
195 
207 #define FSPDF_PAGEBOX_MEDIABOX 0
208 
213 #define FSPDF_PAGEBOX_CROPBOX 1
214 
219 #define FSPDF_PAGEBOX_TRIMBOX 2
220 
225 #define FSPDF_PAGEBOX_ARTBOX 3
226 
231 #define FSPDF_PAGEBOX_BLEEDBOX 4
232 
234 #endif /* _FSPDF_DEF_MACRO_PAGEBOX_ */
235 
236 #ifndef _FSPDF_DEF_MACRO_ALIGNMENT_
237 #define _FSPDF_DEF_MACRO_ALIGNMENT_
238 
244 #define FSPDF_ALIGNMENT_LEFT 0
245 
246 #define FSPDF_ALIGNMENT_CENTER 1
247 
248 #define FSPDF_ALIGNMENT_RIGHT 2
249 
251 #endif /* _FSPDF_DEF_MACRO_ALIGNMENT_ */
252 
253 #ifndef _FSPDF_DEF_MACRO_DEFAULTAPPEARANCE_
254 #define _FSPDF_DEF_MACRO_DEFAULTAPPEARANCE_
255 
261 #define FSPDF_DEFAULTAPPEARANCE_FONT 0x0001
262 
263 #define FSPDF_DEFAULTAPPEARANCE_TEXTCOLOR 0x0002
264 
265 #define FSPDF_DEFAULTAPPEARANCE_TEXTMATRIX 0x0004
266 
268 #endif /* _FSPDF_DEF_MACRO_DEFAULTAPPEARANCE_ */
269 
270 #ifndef _FSPDF_DEF_STRUCTURE_DEFAULTAPPEARANCE_
271 #define _FSPDF_DEF_STRUCTURE_DEFAULTAPPEARANCE_
272 
278 typedef struct _FSPDF_DEFAULTAPPEARANCE
279 {
298  FSCRT_FONT font;
311 
319 
320 #endif /* _FSPDF_DEF_STRUCTURE_DEFAULTAPPEARANCE_ */
321 
322 /*******************************************************************************/
323 /* Handles Definition */
324 /*******************************************************************************/
325 #ifndef _FSPDF_DEF_HANDLE_OBJECT_
326 #define _FSPDF_DEF_HANDLE_OBJECT_
327 
329 FSCRT_DEFINEHANDLE(FSPDF_OBJECT);
330 
331 #endif /* _FSPDF_DEF_HANDLE_OBJECT_ */
332 
333 #ifndef _FSPDF_DEF_HANDLE_ATTACHMENT_
334 #define _FSPDF_DEF_HANDLE_ATTACHMENT_
335 
337 FSCRT_DEFINEHANDLE(FSPDF_ATTACHMENT);
338 
339 #endif /* _FSPDF_DEF_HANDLE_ATTACHMENT_ */
340 
341 /*******************************************************************************/
342 /* PDF rendering context */
343 /*******************************************************************************/
344 #ifndef _FSPDF_DEF_HANDLE_RENDERCONTEXT_
345 #define _FSPDF_DEF_HANDLE_RENDERCONTEXT_
346 
348 FSCRT_DEFINEHANDLE(FSPDF_RENDERCONTEXT);
349 
350 #endif /* _FSPDF_DEF_HANDLE_RENDERCONTEXT_ */
351 
352 #ifndef _FSPDF_DEF_MACRO_RENDEROPTION_
353 #define _FSPDF_DEF_MACRO_RENDEROPTION_
354 
361 #define FSPDF_RENDEROPTION_COLORMODE 0
362 
364 #endif /* _FSPDF_DEF_MACRO_RENDEROPTION_ */
365 
366 #ifndef _FSPDF_DEF_MACRO_COLORMODE_
367 #define _FSPDF_DEF_MACRO_COLORMODE_
368 
374 #define FSPDF_COLORMODE_NORMAL 0
375 
376 #define FSPDF_COLORMODE_GRAY 1
377 
378 #define FSPDF_COLORMODE_TWOCOLOR 2
379 
381 #endif /* _FSPDF_DEF_MACRO_COLORMODE_ */
382 
383 #ifndef _FSCRT_DEF_STRUCTURE_RENDEROPTIONPARAM_COLORMODE_
384 #define _FSCRT_DEF_STRUCTURE_RENDEROPTIONPARAM_COLORMODE_
385 
392 typedef struct _FSPDF_RENDEROPTIONPARAM_COLORMODE
393 {
405 
406 #endif /* _FSCRT_DEF_STRUCTURE_RENDEROPTIONPARAM_COLORMODE_ */
407 
408 #ifndef _FSPDF_DEF_MACRO_RENDERCONTEXTFLAG_
409 #define _FSPDF_DEF_MACRO_RENDERCONTEXTFLAG_
410 
417 #define FSPDF_RENDERCONTEXTFLAG_ANNOT 0x0001
418 
425 #define FSPDF_RENDERCONTEXTFLAG_DROPOBJECTS 0x0002
426 
427 #define FSPDF_RENDERCONTEXTFLAG_NOWIDGET 0x0004
428 
433 #define FSPDF_RENDERCONTEXTFLAG_NOTTRANSFORMICON 0x0008
434 
435 #define FSPDF_RENDERCONTEXTFLAG_NOSIGNATURE 0x0020
436 
437 #define FSPDF_RENDERCONTEXTFLAG_OCGPRINT 0x0100
438 
439 #define FSPDF_RENDERCONTEXTFLAG_OCGDESIGN 0x0200
440 
441 #define FSPDF_RENDERCONTEXTFLAG_OCGEXPORT 0x0400
442 
444 #endif /* _FSPDF_DEF_MACRO_RENDERCONTEXTFLAG_ */
445 
471 FS_RESULT FSPDF_RenderContext_Create(FSPDF_RENDERCONTEXT* pdfRenderContext);
472 
492 FS_RESULT FSPDF_RenderContext_Release(FSPDF_RENDERCONTEXT pdfRenderContext);
493 
514 FS_RESULT FSPDF_RenderContext_SetFlags(FSPDF_RENDERCONTEXT pdfRenderContext, FS_DWORD flags);
515 
535 FS_RESULT FSPDF_RenderContext_SetMatrix(FSPDF_RENDERCONTEXT pdfRenderContext, const FSCRT_MATRIX *matrix);
536 
568 FS_RESULT FSPDF_RenderContext_SetHalftoneLimit(FSPDF_RENDERCONTEXT pdfRenderContext, FS_INT32 halftoneLimit);
569 
593 FS_RESULT FSPDF_RenderContext_SetOption(FSPDF_RENDERCONTEXT pdfRenderContext, FS_DWORD option, FS_LPVOID params);
594 
595 #ifndef _FSPDF_DEF_HANDLE_LAYERCONTEXT_
596 #define _FSPDF_DEF_HANDLE_LAYERCONTEXT_
597 
599 FSCRT_DEFINEHANDLE(FSPDF_LAYERCONTEXT);
600 #endif /* _FSPDF_DEF_HANDLE_LAYERCONTEXT_ */
601 
627 FS_RESULT FSPDF_RenderContext_SetLayerContext(FSPDF_RENDERCONTEXT pdfRenderContext, FSPDF_LAYERCONTEXT layerContext);
628 
629 /*******************************************************************************/
630 /* Destination */
631 /*******************************************************************************/
632 #ifndef _FSPDF_DEF_MACRO_ZOOM_
633 #define _FSPDF_DEF_MACRO_ZOOM_
634 
640 #define FSPDF_ZOOM_FACTOR 1
641 
642 #define FSPDF_ZOOM_FITPAGE 2
643 
644 #define FSPDF_ZOOM_FITWIDTH 3
645 
646 #define FSPDF_ZOOM_FITHEIGHT 4
647 
648 #define FSPDF_ZOOM_FITRECT 5
649 
650 #define FSPDF_ZOOM_FITCONTENT 6
651 
652 #define FSPDF_ZOOM_FITCONTENTWIDTH 7
653 
654 #define FSPDF_ZOOM_FITCONTENTHEIGHT 8
655 
657 #endif /* _FSPDF_DEF_MACRO_ZOOM_ */
658 
659 #ifndef _FSPDF_DEF_STRUCTURE_DESTDATA_
660 #define _FSPDF_DEF_STRUCTURE_DESTDATA_
661 
663 typedef struct _FSPDF_DESTDATA
664 {
692  FS_FLOAT params[4];
694 
695 #endif /* _FSPDF_DEF_STRUCTURE_DESTDATA_ */
696 
697 /*******************************************************************************/
698 /* Actions */
699 /*******************************************************************************/
700 #ifndef _FSPDF_DEF_MACRO_ACTION_
701 #define _FSPDF_DEF_MACRO_ACTION_
702 
708 #define FSPDF_ACTION_UNSUPPORTED 0
709 
710 #define FSPDF_ACTION_GOTO 1
711 
712 #define FSPDF_ACTION_REMOTEGOTO 2
713 
714 #define FSPDF_ACTION_EMBEDDEDGOTO 3
715 
716 #define FSPDF_ACTION_URI 4
717 
718 #define FSPDF_ACTION_LAUNCH 5
719 
720 #define FSPDF_ACTION_JAVASCRIPT 6
721 
722 #define FSPDF_ACTION_HIDE 7
723 
724 #define FSPDF_ACTION_NAMED 8
725 
726 #define FSPDF_ACTION_SUBMITFORM 9
727 
728 #define FSPDF_ACTION_RESETFORM 10
729 
730 #define FSPDF_ACTION_IMPORTDATA 11
731 
732 #define FSPDF_ACTION_RENDITION 12
733 
735 #endif /* _FSPDF_DEF_MACRO_ACTION_ */
736 
737 #ifndef _FSPDF_DEF_MACRO_TRIGGER_DOC_
738 #define _FSPDF_DEF_MACRO_TRIGGER_DOC_
739 
745 #define FSPDF_TRIGGER_DOC_DO 0
746 
747 #define FSPDF_TRIGGER_DOC_WC 1
748 
749 #define FSPDF_TRIGGER_DOC_WS 2
750 
751 #define FSPDF_TRIGGER_DOC_DS 3
752 
753 #define FSPDF_TRIGGER_DOC_WP 4
754 
755 #define FSPDF_TRIGGER_DOC_DP 5
756 
758 #endif /* _FSPDF_DEF_MACRO_TRIGGER_DOC_ */
759 
760 #ifndef _FSPDF_DEF_MACRO_TRIGGER_FORMFIELD_
761 #define _FSPDF_DEF_MACRO_TRIGGER_FORMFIELD_
762 
772 #define FSPDF_TRIGGER_FORMFIELD_KS 0
773 
778 #define FSPDF_TRIGGER_FORMFIELD_WF 1
779 
784 #define FSPDF_TRIGGER_FORMFIELD_WV 2
785 
786 #define FSPDF_TRIGGER_FORMFIELD_FC 3
787 
789 #endif /* _FSPDF_DEF_MACRO_TRIGGER_FORMFIELD_ */
790 
791 #ifndef _FSPDF_DEF_MACRO_TRIGGER_PAGE_
792 #define _FSPDF_DEF_MACRO_TRIGGER_PAGE_
793 
799 #define FSPDF_TRIGGER_PAGE_PO 0
800 
801 #define FSPDF_TRIGGER_PAGE_PC 1
802 
804 #endif /* _FSPDF_DEF_MACRO_TRIGGER_PAGE_ */
805 
806 #ifndef _FSPDF_DEF_MACRO_TRIGGER_ANNOT_
807 #define _FSPDF_DEF_MACRO_TRIGGER_ANNOT_
808 
814 #define FSPDF_TRIGGER_ANNOT_CE 0
815 
816 #define FSPDF_TRIGGER_ANNOT_CX 1
817 
818 #define FSPDF_TRIGGER_ANNOT_MD 2
819 
820 #define FSPDF_TRIGGER_ANNOT_MU 3
821 
822 #define FSPDF_TRIGGER_ANNOT_FO 4
823 
824 #define FSPDF_TRIGGER_ANNOT_FL 5
825 
826 #define FSPDF_TRIGGER_ANNOT_PO 6
827 
828 #define FSPDF_TRIGGER_ANNOT_PC 7
829 
830 #define FSPDF_TRIGGER_ANNOT_PV 8
831 
832 #define FSPDF_TRIGGER_ANNOT_PI 9
833 
835 #endif /* _FSPDF_DEF_MACRO_TRIGGER_ANNOT_ */
836 
837 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_
838 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_
839 
841 typedef struct _FSPDF_ACTIONDATA
842 {
875 
876 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_ */
877 
878 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_GOTO_
879 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_GOTO_
880 
882 typedef struct _FSPDF_ACTIONDATA_GOTO
883 {
887 
888 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_GOTO_ */
889 
890 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_REMOTEGOTO_
891 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_REMOTEGOTO_
892 
903 typedef struct _FSPDF_ACTIONDATA_REMOTEGOTO
904 {
932 
933 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_REMOTEGOTO_ */
934 
935 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_EMBEDDEDGOTO_TARGET_
936 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_EMBEDDEDGOTO_TARGET_
937 
945 typedef struct _FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET
946 {
952  struct _FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET* next;
1002 
1003 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_EMBEDDEDGOTO_TARGET_ */
1004 
1005 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_EMBEDDEDGOTO_
1006 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_EMBEDDEDGOTO_
1007 
1018 typedef struct _FSPDF_ACTIONDATA_EMBEDDEDGOTO
1019 {
1023  FSPDF_ATTACHMENT attachment;
1045 
1046 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_EMBEDDEDGOTO_ */
1047 
1048 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_URI_
1049 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_URI_
1050 
1052 typedef struct _FSPDF_ACTIONDATA_URI
1053 {
1069 
1070 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_URI_ */
1071 
1072 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_LAUNCH_
1073 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_LAUNCH_
1074 
1076 typedef struct _FSPDF_ACTIONDATA_LAUNCH
1077 {
1079  FSPDF_ATTACHMENT attachment;
1121 
1122 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_LAUNCH_ */
1123 
1124 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_JAVASCRIPT_
1125 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_JAVASCRIPT_
1126 
1128 typedef struct _FSPDF_ACTIONDATA_JAVASCRIPT
1129 {
1139 
1140 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_JAVASCRIPT_ */
1141 
1142 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_HIDE_
1143 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_HIDE_
1144 
1146 typedef struct _FSPDF_ACTIONDATA_HIDE
1147 {
1162 
1163 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_HIDE_ */
1164 
1165 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_NAMED_
1166 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_NAMED_
1167 
1169 typedef struct _FSPDF_ACTIONDATA_NAMED
1170 {
1180 
1181 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_NAMED_ */
1182 
1183 #ifndef _FSPDF_DEF_MACRO_SUBMITFORM_FLAGS_
1184 #define _FSPDF_DEF_MACRO_SUBMITFORM_FLAGS_
1185 
1195 #define FSPDF_SUBMITFORMFLAGS_INCLUDE 0x0001
1196 
1201 #define FSPDF_SUBMITFORMFLAGS_INCLUDENOVALUEFIELDS 0x0002
1202 
1208 #define FSPDF_SUBMITFORMFLAGS_EXPORTFORMAT 0x0004
1209 
1215 #define FSPDF_SUBMITFORMFLAGS_GETMETHOD 0x0008
1216 
1219 #define FSPDF_SUBMITFORMFLAGS_SUBMITCOORDINATES 0x0010
1220 
1223 #define FSPDF_SUBMITFORMFLAGS_XFDF 0x0020
1224 
1229 #define FSPDF_SUBMITFORMFLAGS_INCLUDEAPPENDSAVES 0x0040
1230 
1235 #define FSPDF_SUBMITFORMFLAGS_INCLUDEANNOTATIONS 0x0080
1236 
1239 #define FSPDF_SUBMITFORMFLAGS_SUBMITPDF 0x0100
1240 
1243 #define FSPDF_SUBMITFORMFLAGS_CANONICALFORMAT 0x0200
1244 
1247 #define FSPDF_SUBMITFORMFLAGS_EXCLNONUSERANNOTS 0x0400
1248 
1251 #define FSPDF_SUBMITFORMFLAGS_EXCLFKEY 0x0800
1252 
1255 #define FSPDF_SUBMITFORMFLAGS_EMBEDFORM 0x2000
1256 
1258 #endif /* _FSPDF_DEF_MACRO_SUBMITFORM_FLAGS_ */
1259 
1260 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_SUBMITFORM_
1261 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_SUBMITFORM_
1262 
1264 typedef struct _FSPDF_ACTIONDATA_SUBMITFORM
1265 {
1271  FSPDF_ATTACHMENT attachment;
1290 
1291 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_SUBMITFORM_ */
1292 
1293 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_RESETFORM_
1294 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_RESETFORM_
1295 
1297 typedef struct _FSPDF_ACTIONDATA_RESETFORM
1298 {
1321 
1322 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_RESETFORM_ */
1323 
1324 #ifndef _FSPDF_DEF_STRUCTURE_ACTIONDATA_IMPORTDATA_
1325 #define _FSPDF_DEF_STRUCTURE_ACTIONDATA_IMPORTDATA_
1326 
1328 typedef struct _FSPDF_ACTIONDATA_IMPORTDATA
1329 {
1331  FSPDF_ATTACHMENT attachment;
1333 
1334 #endif /* _FSPDF_DEF_STRUCTURE_ACTIONDATA_IMPORTDATA_ */
1335 
1355 
1375 
1376 /*******************************************************************************/
1377 /* PDF Attachment */
1378 /*******************************************************************************/
1405 FS_RESULT FSPDF_Attachment_Create(FSCRT_DOCUMENT document, FSPDF_ATTACHMENT* attachment);
1406 
1430 FS_RESULT FSPDF_Attachment_Release(FSCRT_DOCUMENT document, FSPDF_ATTACHMENT attachment);
1431 
1466 FS_RESULT FSPDF_Attachment_IsEmbedded(FSPDF_ATTACHMENT attachment, FS_BOOL* embedded);
1467 
1492 FS_RESULT FSPDF_Attachment_GetFileName(FSPDF_ATTACHMENT attachment, FSCRT_BSTR* fileName);
1493 
1522 FS_RESULT FSPDF_Attachment_SetFileName(FSPDF_ATTACHMENT attachment, const FSCRT_BSTR* fileName, FS_BOOL isURL);
1523 
1549 FS_RESULT FSPDF_Attachment_GetDescription(FSPDF_ATTACHMENT attachment, FSCRT_BSTR* description);
1550 
1579 FS_RESULT FSPDF_Attachment_SetDescription(FSPDF_ATTACHMENT attachment, const FSCRT_BSTR* description);
1580 
1606 FS_RESULT FSPDF_Attachment_GetSize(FSPDF_ATTACHMENT attachment, FSCRT_FILESIZE* size);
1607 
1630 FS_RESULT FSPDF_Attachment_GetCreationDateTime(FSPDF_ATTACHMENT attachment, FSCRT_DATETIMEZONE* dt);
1631 
1656 FS_RESULT FSPDF_Attachment_SetCreationDateTime(FSPDF_ATTACHMENT attachment, const FSCRT_DATETIMEZONE* dt);
1657 
1680 FS_RESULT FSPDF_Attachment_GetModifiedDateTime(FSPDF_ATTACHMENT attachment, FSCRT_DATETIMEZONE* dt);
1681 
1706 FS_RESULT FSPDF_Attachment_SetModifiedDateTime(FSPDF_ATTACHMENT attachment, const FSCRT_DATETIMEZONE* dt);
1707 
1736 FS_RESULT FSPDF_Attachment_GetCheckSum(FSPDF_ATTACHMENT attachment, FSCRT_BSTR* checksum);
1737 
1765 FS_RESULT FSPDF_Attachment_SetCheckSum(FSPDF_ATTACHMENT attachment, const FSCRT_BSTR* checksum);
1766 
1792 FS_RESULT FSPDF_Attachment_WriteToFile(FSPDF_ATTACHMENT attachment, FSCRT_FILE file);
1793 
1822 FS_RESULT FSPDF_Attachment_GetData(FSPDF_ATTACHMENT attachment, FS_BOOL isRawData, FSCRT_FILE* file);
1823 
1854 FS_RESULT FSPDF_Attachment_SetFile(FSPDF_ATTACHMENT attachment, FSCRT_FILE file);
1855 
1876 FS_RESULT FSPDF_Attachment_GetDocument(FSPDF_ATTACHMENT attachment, FSCRT_DOCUMENT* document);
1877 
1902 FS_RESULT FSPDF_Font_IsEmbedded(FSCRT_DOCUMENT document, FSCRT_FONT font, FS_BOOL* isEmbedded);
1903 
1929 FS_RESULT FSPDF_Font_GetDict(FSCRT_DOCUMENT document, FSCRT_FONT font, FSPDF_OBJECT* fontDictionary);
1930 
1968 FS_RESULT FSPDF_Font_IsSupportEmbedded(FSCRT_DOCUMENT document, FSCRT_FONT font, FS_BOOL* isSupported);
1969 
1970 #ifdef __cplusplus
1971 };
1972 #endif
1973  /* group FPDFBASE */
1975 
1976 #endif /* _FSPDF_BASE_R_H_ */
1977 
FS_ARGB textColor
Text color of default appearance. Format: 0xAARRGGBB.
Definition: fpdf_base_r.h:310
FSPDF_ATTACHMENT attachment
Handle to a FSPDF_ATTACHMENT object from which form data is imported.
Definition: fpdf_base_r.h:1331
FS_BOOL hide
Indicate to hide annotations or show them.
Definition: fpdf_base_r.h:1160
FS_INT32 colorMode
Color mode.
Definition: fpdf_base_r.h:399
FS_RESULT FSPDF_Attachment_SetCreationDateTime(FSPDF_ATTACHMENT attachment, const FSCRT_DATETIMEZONE *dt)
Set the creation date and time of an attachment.
FS_ARGB backColor
Background color. Format: 0xAARRGGBB.
Definition: fpdf_base_r.h:403
FS_RESULT FSPDF_ActionData_Clear(FSPDF_ACTIONDATA *actionData)
Clear PDF action data.
FSCRT_BSTR * fields
Pointer to an array which are names of fields to be included or excluded.
Definition: fpdf_base_r.h:1307
FSCRT_BSTR destname
A named destination in target document that provides the page index of the file attachment annotation...
Definition: fpdf_base_r.h:980
FS_RESULT FSPDF_Attachment_GetDocument(FSPDF_ATTACHMENT attachment, FSCRT_DOCUMENT *document)
Get a document handle related to an attachment.
FS_RESULT FSPDF_Attachment_SetCheckSum(FSPDF_ATTACHMENT attachment, const FSCRT_BSTR *checksum)
Set the checksum of an attachment.
FS_RESULT FSCRT_PDFModule_Initialize()
Initialize PDF module.
FS_INT32 count
Count of elements in fields array.
Definition: fpdf_base_r.h:1309
Structure for action type FSPDF_ACTION_IMPORTDATA.
Definition: fpdf_base_r.h:1328
Structure for render option parameters of color mode.
Definition: fpdf_base_r.h:392
float FS_FLOAT
32-bit floating-point number, single precision.
Definition: fs_base_r.h:148
FSPDF_ATTACHMENT attachment
(Reserved, not support currently) Handle to a FSPDF_ATTACHMENT object which is the application or doc...
Definition: fpdf_base_r.h:1079
FSCRT_BSTR filename
Name of the file in the EmbeddedFiles name tree, in UTF-8.
Definition: fpdf_base_r.h:972
FS_RESULT FSPDF_Attachment_IsEmbedded(FSPDF_ATTACHMENT attachment, FS_BOOL *embedded)
Check whether an attachment is an embedded file or not.
FS_RESULT FSPDF_Attachment_Create(FSCRT_DOCUMENT document, FSPDF_ATTACHMENT *attachment)
Create an attachment object.
FS_INT32 count
Count of elements in fields array.
Definition: fpdf_base_r.h:1282
Structure for large file size.
Definition: fs_base_r.h:898
FS_RESULT FSPDF_Font_IsSupportEmbedded(FSCRT_DOCUMENT document, FSCRT_FONT font, FS_BOOL *isSupported)
Check whether all features of the font can be embedded to a specific PDF document or not...
struct _FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET * next
Pointer to a FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET structure which specifies additional path informati...
Definition: fpdf_base_r.h:952
FSCRT_BSTR operation
Operation to perform, in UTF-8.
Definition: fpdf_base_r.h:1109
FSCRT_BSTR destName
Destination name, in UTF-8.
Definition: fpdf_base_r.h:1041
Structure for action type FSPDF_ACTION_SUBMITFORM.
Definition: fpdf_base_r.h:1264
FS_INT32 count
Count of elements in fields array.
Definition: fpdf_base_r.h:1158
FS_RESULT FSPDF_Attachment_GetData(FSPDF_ATTACHMENT attachment, FS_BOOL isRawData, FSCRT_FILE *file)
Get the attachment data with an asynchronous way.
FS_RESULT FSPDF_Attachment_SetFileName(FSPDF_ATTACHMENT attachment, const FSCRT_BSTR *fileName, FS_BOOL isURL)
Set the file name of an attachment.
FS_RESULT FSPDF_Attachment_Release(FSCRT_DOCUMENT document, FSPDF_ATTACHMENT attachment)
Release a attachment object.
FS_INT32 actionType
Action type.
Definition: fpdf_base_r.h:848
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142
FSCRT_BSTR fileName
File name, in UTF-8.
Definition: fpdf_base_r.h:1087
FS_RESULT FSPDF_Attachment_SetFile(FSPDF_ATTACHMENT attachment, FSCRT_FILE file)
Set the file of an attachment.
FS_RESULT FSPDF_ActionData_Init(FSPDF_ACTIONDATA *actionData)
Initialize PDF action data.
Structure for action type FSPDF_ACTION_URI.
Definition: fpdf_base_r.h:1052
Structure for action type FSPDF_ACTION_REMOTEGOTO.
Definition: fpdf_base_r.h:903
Structure for action type FSPDF_ACTION_JAVASCRIPT.
Definition: fpdf_base_r.h:1128
FS_RESULT FSPDF_Attachment_GetDescription(FSPDF_ATTACHMENT attachment, FSCRT_BSTR *description)
Get description of an attachment.
FS_RESULT FSPDF_RenderContext_SetFlags(FSPDF_RENDERCONTEXT pdfRenderContext, FS_DWORD flags)
Set flags to a rendering context.
FS_RESULT FSPDF_RenderContext_SetHalftoneLimit(FSPDF_RENDERCONTEXT pdfRenderContext, FS_INT32 halftoneLimit)
Set a halftone limit to a rendering context.
FS_DWORD flags
A set of flags specifying various characteristics of the action.
Definition: fpdf_base_r.h:1288
FS_RESULT FSPDF_RenderContext_SetOption(FSPDF_RENDERCONTEXT pdfRenderContext, FS_DWORD option, FS_LPVOID params)
Set option parameters to a rendering context.
FSCRT_BSTR javascript
Javascript contents, in UTF-8.
Definition: fpdf_base_r.h:1137
FS_FLOAT fontSize
Font size of default appearance. This should not be negative.
Definition: fpdf_base_r.h:304
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
Structure for action type FSPDF_ACTION_EMBEDDEDGOTO.
Definition: fpdf_base_r.h:1018
FSCRT_MATRIX textMatrix
Text matrix of default appearance.
Definition: fpdf_base_r.h:317
FSPDF_DESTDATA destData
Destination data.
Definition: fpdf_base_r.h:930
Structure for date and time.
Definition: fs_base_r.h:2018
FS_RESULT FSPDF_RenderContext_Release(FSPDF_RENDERCONTEXT pdfRenderContext)
Release a PDF rendering context.
FS_RESULT FSPDF_Attachment_GetFileName(FSPDF_ATTACHMENT attachment, FSCRT_BSTR *fileName)
Get file name of an attachment.
Structure for action type FSPDF_ACTION_LAUNCH.
Definition: fpdf_base_r.h:1076
FS_INT32 pageIndex
A zero-based index for page.
Definition: fpdf_base_r.h:666
Structure for action type FSPDF_ACTION_RESETFORM.
Definition: fpdf_base_r.h:1297
FS_DWORD flags
Flags of default appearance.
Definition: fpdf_base_r.h:290
FSPDF_ATTACHMENT attachment
Handle to a FSPDF_ATTACHMENT object which is the root document of the target.
Definition: fpdf_base_r.h:1023
Structure for action type FSPDF_ACTION_GOTO.
Definition: fpdf_base_r.h:882
FS_DWORD flags
Flags specify including or excluding fields.
Definition: fpdf_base_r.h:1319
FS_BOOL mapPosition
Whether to track the mouse position when the URI is resolved.
Definition: fpdf_base_r.h:1067
Structure for default appearance.
Definition: fpdf_base_r.h:278
FSCRT_BSTR fileName
File name that remote to, encoded in UTF-8.
Definition: fpdf_base_r.h:912
Structure for an action data.
Definition: fpdf_base_r.h:841
FS_RESULT FSPDF_Attachment_SetModifiedDateTime(FSPDF_ATTACHMENT attachment, const FSCRT_DATETIMEZONE *dt)
Set the modification date of an attachment.
FS_RESULT FSPDF_Attachment_GetCreationDateTime(FSPDF_ATTACHMENT attachment, FSCRT_DATETIMEZONE *dt)
Get creation date and time of an attachment.
FS_RESULT FSPDF_Attachment_GetSize(FSPDF_ATTACHMENT attachment, FSCRT_FILESIZE *size)
Get the size of an attachment.
FS_BOOL newWindow
Whether a new window should be opened or not.
Definition: fpdf_base_r.h:1043
int FS_BOOL
Boolean type (This should be TRUE or FALSE).
Definition: fs_base_r.h:133
FSCRT_BSTR relationship
Relationship between current document and the target document, in UTF-8. Valid values are "P"(the tar...
Definition: fpdf_base_r.h:962
FSPDF_DESTDATA destData
Destination data.
Definition: fpdf_base_r.h:885
FS_INT32 zoomMode
Zoom mode.
Definition: fpdf_base_r.h:672
FSCRT_BSTR annotname
Value of NM in the annotation dictionary, in UTF-8.
Definition: fpdf_base_r.h:988
FSCRT_BSTR * fields
Pointer to an array which are names of fields.
Definition: fpdf_base_r.h:1280
void * FS_LPVOID
A pointer to any types.
Definition: fs_base_r.h:127
FSCRT_BSTR * fields
Pointer to an array which are names of fields to be included or excluded.
Definition: fpdf_base_r.h:1156
FSCRT_BSTR url
URL address, in UTF-8.
Definition: fpdf_base_r.h:1061
FS_ARGB foreColor
Foreground color. Format: 0xAARRGGBB.
Definition: fpdf_base_r.h:401
unsigned int FS_ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_base_r.h:145
Structure for target of FSPDF_ACTIONDATA_EMBEDDEDGOTO.
Definition: fpdf_base_r.h:945
FSCRT_BSTR namedAction
A text string which is an action name, in UTF-8.
Definition: fpdf_base_r.h:1178
Structure for 2D matrix.
Definition: fs_base_r.h:2130
FS_INT32 pageindex
Page index(zero-based) in target document containing the file attachment annotation.
Definition: fpdf_base_r.h:994
Structure for byte string.
Definition: fs_base_r.h:611
FS_RESULT FSPDF_RenderContext_SetMatrix(FSPDF_RENDERCONTEXT pdfRenderContext, const FSCRT_MATRIX *matrix)
Set a transformation matrix to a rendering context.
FS_DWORD reserved
Reserved.
Definition: fpdf_base_r.h:292
FSPDF_ATTACHMENT attachment
Handle to a FSPDF_ATTACHMENT object to which the form data is submitted.
Definition: fpdf_base_r.h:1271
FS_RESULT FSPDF_Attachment_GetCheckSum(FSPDF_ATTACHMENT attachment, FSCRT_BSTR *checksum)
Get an attachment&#39;s checksum.
FSCRT_BSTR destName
Destination name, in UTF-8.
Definition: fpdf_base_r.h:922
FS_RESULT FSPDF_Font_IsEmbedded(FSCRT_DOCUMENT document, FSCRT_FONT font, FS_BOOL *isEmbedded)
Check whether a font is embedded in a PDF document.
FS_INT32 annotindex
Annotation index(zero-based) of the page specified by parameter pageindex.
Definition: fpdf_base_r.h:1000
FSCRT_BSTR defaultPath
Default path, in UTF-8.
Definition: fpdf_base_r.h:1095
Structure for action type FSPDF_ACTION_NAMED.
Definition: fpdf_base_r.h:1169
FS_RESULT FSPDF_RenderContext_Create(FSPDF_RENDERCONTEXT *pdfRenderContext)
Create a PDF rendering context.
FS_RESULT FSPDF_RenderContext_SetLayerContext(FSPDF_RENDERCONTEXT pdfRenderContext, FSPDF_LAYERCONTEXT layerContext)
Set layer context to render context handle.
FS_RESULT FSPDF_Font_GetDict(FSCRT_DOCUMENT document, FSCRT_FONT font, FSPDF_OBJECT *fontDictionary)
Get the dictionary of a font in a PDF document.
FS_BOOL newWindow
Whether a new window should be opened.
Definition: fpdf_base_r.h:1119
FS_RESULT FSPDF_Attachment_WriteToFile(FSPDF_ATTACHMENT attachment, FSCRT_FILE file)
Write the attachment data directly into a file.
Structure for a destination data.
Definition: fpdf_base_r.h:663
FS_RESULT FSPDF_Attachment_SetDescription(FSPDF_ATTACHMENT attachment, const FSCRT_BSTR *description)
Set the description of an attachment.
Structure for action type FSPDF_ACTION_HIDE.
Definition: fpdf_base_r.h:1146
FS_RESULT FSPDF_Attachment_GetModifiedDateTime(FSPDF_ATTACHMENT attachment, FSCRT_DATETIMEZONE *dt)
Get the last modification date and time of an attachment.
FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET * target
Pointer to a FSPDF_ACTIONDATA_EMBEDDEDGOTO_TARGET structure which specifies path information to the t...
Definition: fpdf_base_r.h:1021
FSPDF_DESTDATA destData
Destination data.
Definition: fpdf_base_r.h:1031
FSCRT_FONT font
Font object of default appearance.
Definition: fpdf_base_r.h:298
FS_LPVOID actionData
An action data.
Definition: fpdf_base_r.h:873
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160
FS_RESULT FSCRT_PDFModule_Finalize()
Finalize PDF module.
FSCRT_BSTR parameters
A parameter string to be passed to the application, in UTF-8.
Definition: fpdf_base_r.h:1117

Foxit Corporation