fpdf_objects_w.h
Go to the documentation of this file.
1 
26 #ifndef _FSPDF_OBJECTS_W_H_
27 #define _FSPDF_OBJECTS_W_H_
28 
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56 
57 /*******************************************************************************/
58 /* Object creation */
59 /*******************************************************************************/
87 FS_RESULT FSPDF_Object_CreateBoolean(FSCRT_DOCUMENT document, FS_BOOL boolean, FSPDF_OBJECT* object);
88 
116 FS_RESULT FSPDF_Object_CreateInteger(FSCRT_DOCUMENT document, FS_INT32 number, FSPDF_OBJECT* object);
117 
145 FS_RESULT FSPDF_Object_CreateFloat(FSCRT_DOCUMENT document, FS_FLOAT number, FSPDF_OBJECT* object);
146 
175 FS_RESULT FSPDF_Object_CreateRawByteString(FSCRT_DOCUMENT document, const FSCRT_BSTR* string, FS_BOOL hexStr, FSPDF_OBJECT* object);
176 
207 FS_RESULT FSPDF_Object_CreateUnicodeString(FSCRT_DOCUMENT document, const FSCRT_BSTR* string, FSPDF_OBJECT* object);
208 
239 FS_RESULT FSPDF_Object_CreateDateTime(FSCRT_DOCUMENT document, const FSCRT_DATETIMEZONE* dt, FSPDF_OBJECT* object);
240 
271 FS_RESULT FSPDF_Object_CreateUnicodeName(FSCRT_DOCUMENT document, const FSCRT_BSTR* nameStr, FSPDF_OBJECT* object);
272 
299 FS_RESULT FSPDF_Object_CreateArray(FSCRT_DOCUMENT document, FSPDF_OBJECT* object);
300 
330 FS_RESULT FSPDF_Object_CreateRect(FSCRT_DOCUMENT document, const FSCRT_RECTF* rect, FSPDF_OBJECT* object);
331 
361 FS_RESULT FSPDF_Object_CreateMatrix(FSCRT_DOCUMENT document, const FSCRT_MATRIX* matrix, FSPDF_OBJECT* object);
362 
389 FS_RESULT FSPDF_Object_CreateDict(FSCRT_DOCUMENT document, FSPDF_OBJECT* object);
390 
420 FS_RESULT FSPDF_Object_CreateStream(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, FSPDF_OBJECT* object);
421 
450 FS_RESULT FSPDF_Object_CreateReference(FSCRT_DOCUMENT document, FSPDF_OBJECT refObj, FSPDF_OBJECT* object);
451 
479 FS_RESULT FSPDF_Object_CreateReferenceWithObjNum(FSCRT_DOCUMENT document, FS_DWORD objNum, FSPDF_OBJECT* object);
480 
505 FS_RESULT FSPDF_Object_Release(FSCRT_DOCUMENT document, FSPDF_OBJECT object);
506 
507 /*******************************************************************************/
508 /* PDF array access */
509 /*******************************************************************************/
544 FS_RESULT FSPDF_Array_InsertAt(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT element);
545 
577 FS_RESULT FSPDF_Array_SetAt(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT element);
578 
608 FS_RESULT FSPDF_Array_Add(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FSPDF_OBJECT element);
609 
635 FS_RESULT FSPDF_Array_AddBoolean(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_BOOL boolean);
636 
662 FS_RESULT FSPDF_Array_AddInteger(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 number);
663 
689 FS_RESULT FSPDF_Array_AddFloat(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_FLOAT number);
690 
719 FS_RESULT FSPDF_Array_AddRawByteString(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_BOOL hexStr, const FSCRT_BSTR* string);
720 
750 FS_RESULT FSPDF_Array_AddUnicodeString(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_BSTR* string);
751 
781 FS_RESULT FSPDF_Array_AddDateTime(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_DATETIMEZONE* dt);
782 
812 FS_RESULT FSPDF_Array_AddUnicodeName(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_BSTR* nameStr);
813 
842 FS_RESULT FSPDF_Array_AddRect(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_RECTF* rect);
843 
872 FS_RESULT FSPDF_Array_AddMatrix(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_MATRIX* matrix);
873 
900 FS_RESULT FSPDF_Array_RemoveAt(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index);
901 
902 /*******************************************************************************/
903 /* PDF dictionary access */
904 /*******************************************************************************/
935 FS_RESULT FSPDF_Dictionary_SetAt(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, FSPDF_OBJECT object);
936 
965 FS_RESULT FSPDF_Dictionary_SetAtBoolean(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, FS_BOOL boolean);
966 
995 FS_RESULT FSPDF_Dictionary_SetAtInteger(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, FS_INT32 number);
996 
1025 FS_RESULT FSPDF_Dictionary_SetAtFloat(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, FS_FLOAT number);
1026 
1059 FS_RESULT FSPDF_Dictionary_SetAtRawByteString(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key,
1060  FS_BOOL hexStr, const FSCRT_BSTR* string);
1061 
1094 FS_RESULT FSPDF_Dictionary_SetAtUnicodeString(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, const FSCRT_BSTR* string);
1095 
1128 FS_RESULT FSPDF_Dictionary_SetAtDateTime(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, const FSCRT_DATETIMEZONE* dt);
1129 
1161 FS_RESULT FSPDF_Dictionary_SetAtUnicodeName(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, const FSCRT_BSTR* nameStr);
1162 
1194 FS_RESULT FSPDF_Dictionary_SetAtRect(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, const FSCRT_RECTF* rect);
1195 
1227 FS_RESULT FSPDF_Dictionary_SetAtMatrix(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key, const FSCRT_MATRIX* matrix);
1228 
1256 FS_RESULT FSPDF_Dictionary_RemoveAt(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR* key);
1257 
1258 /*******************************************************************************/
1259 /* PDF stream access */
1260 /*******************************************************************************/
1289 FS_RESULT FSPDF_Stream_SetData(FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FS_LPCVOID buffer, FS_DWORD length);
1290 
1320 FS_RESULT FSPDF_Stream_ImportData(FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FSCRT_FILE file);
1321 
1322 #ifdef __cplusplus
1323 };
1324 #endif
1325  /* group FPDFOBJECTS */
1327 
1328 #endif // _FSPDF_OBJECTS_W_H_
FSPDF_Array_AddRawByteString
FS_RESULT FSPDF_Array_AddRawByteString(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_BOOL hexStr, const FSCRT_BSTR *string)
Add a raw string element into array, to the last position.
FSPDF_Array_AddFloat
FS_RESULT FSPDF_Array_AddFloat(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_FLOAT number)
Add a float element into array, to the last position.
FSPDF_Stream_ImportData
FS_RESULT FSPDF_Stream_ImportData(FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FSCRT_FILE file)
Import stream data from a file.
FSCRT_RECTF
Structure for rectangle, in float.
Definition: fs_base_r.h:2078
FS_FLOAT
float FS_FLOAT
32-bit floating-point number, single precision.
Definition: fs_base_r.h:148
FS_LPCVOID
void const * FS_LPCVOID
A constant pointer to any types.
Definition: fs_base_r.h:130
FSPDF_Array_RemoveAt
FS_RESULT FSPDF_Array_RemoveAt(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index)
Remove an element from array.
FSPDF_Dictionary_SetAt
FS_RESULT FSPDF_Dictionary_SetAt(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FSPDF_OBJECT object)
Set an object as value to specific key in dictionary.
FSPDF_Object_CreateReference
FS_RESULT FSPDF_Object_CreateReference(FSCRT_DOCUMENT document, FSPDF_OBJECT refObj, FSPDF_OBJECT *object)
Create a reference PDF object.
FSPDF_Object_CreateFloat
FS_RESULT FSPDF_Object_CreateFloat(FSCRT_DOCUMENT document, FS_FLOAT number, FSPDF_OBJECT *object)
Create a float number PDF object.
FSPDF_Dictionary_RemoveAt
FS_RESULT FSPDF_Dictionary_RemoveAt(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key)
Remove a specific key from dictionary.
FSPDF_Object_CreateMatrix
FS_RESULT FSPDF_Object_CreateMatrix(FSCRT_DOCUMENT document, const FSCRT_MATRIX *matrix, FSPDF_OBJECT *object)
Create a matrix PDF object.
FSPDF_Dictionary_SetAtDateTime
FS_RESULT FSPDF_Dictionary_SetAtDateTime(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_DATETIMEZONE *dt)
Set a date and time value to specific key in dictionary.
FSPDF_Dictionary_SetAtBoolean
FS_RESULT FSPDF_Dictionary_SetAtBoolean(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_BOOL boolean)
Set a boolean value with specific key in dictionary.
FSPDF_Dictionary_SetAtRawByteString
FS_RESULT FSPDF_Dictionary_SetAtRawByteString(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_BOOL hexStr, const FSCRT_BSTR *string)
Set a raw byte string value to specific key in dictionary.
FSPDF_Array_AddRect
FS_RESULT FSPDF_Array_AddRect(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_RECTF *rect)
Add a rectangle element into array, to the last position.
FSPDF_Object_CreateInteger
FS_RESULT FSPDF_Object_CreateInteger(FSCRT_DOCUMENT document, FS_INT32 number, FSPDF_OBJECT *object)
Create an integer number PDF object.
FS_DWORD
unsigned int FS_DWORD
32-bit unsigned integer.
Definition: fs_base_r.h:142
FSPDF_Array_AddUnicodeString
FS_RESULT FSPDF_Array_AddUnicodeString(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_BSTR *string)
Add an UTF-8 string element into array, to the last position.
FSPDF_Object_CreateUnicodeName
FS_RESULT FSPDF_Object_CreateUnicodeName(FSCRT_DOCUMENT document, const FSCRT_BSTR *nameStr, FSPDF_OBJECT *object)
Create an UTF-8 name PDF object.
FSPDF_Object_CreateRect
FS_RESULT FSPDF_Object_CreateRect(FSCRT_DOCUMENT document, const FSCRT_RECTF *rect, FSPDF_OBJECT *object)
Create a rectangle PDF object.
FSPDF_Dictionary_SetAtFloat
FS_RESULT FSPDF_Dictionary_SetAtFloat(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_FLOAT number)
Set a float value to specific key in dictionary.
FS_INT32
int FS_INT32
32-bit signed integer.
Definition: fs_base_r.h:175
FSPDF_Array_Add
FS_RESULT FSPDF_Array_Add(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FSPDF_OBJECT element)
Add an element into array, to the last position.
FSCRT_DATETIMEZONE
Structure for date and time.
Definition: fs_base_r.h:2018
FSPDF_Dictionary_SetAtInteger
FS_RESULT FSPDF_Dictionary_SetAtInteger(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, FS_INT32 number)
Set an integer value to specific key in dictionary.
FSPDF_Dictionary_SetAtRect
FS_RESULT FSPDF_Dictionary_SetAtRect(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_RECTF *rect)
Set a rectangle value to specific key in dictionary.
FSPDF_Array_AddBoolean
FS_RESULT FSPDF_Array_AddBoolean(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_BOOL boolean)
Add a boolean element into array, to the last position.
FSPDF_Stream_SetData
FS_RESULT FSPDF_Stream_SetData(FSCRT_DOCUMENT document, FSPDF_OBJECT stream, FS_LPCVOID buffer, FS_DWORD length)
Set stream data.
FSPDF_Dictionary_SetAtUnicodeString
FS_RESULT FSPDF_Dictionary_SetAtUnicodeString(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_BSTR *string)
Set a UTF-8 byte string value to specific key in dictionary.
FSPDF_Object_CreateReferenceWithObjNum
FS_RESULT FSPDF_Object_CreateReferenceWithObjNum(FSCRT_DOCUMENT document, FS_DWORD objNum, FSPDF_OBJECT *object)
Create a reference PDF object with an object number.
FSPDF_Object_CreateDateTime
FS_RESULT FSPDF_Object_CreateDateTime(FSCRT_DOCUMENT document, const FSCRT_DATETIMEZONE *dt, FSPDF_OBJECT *object)
Create a date PDF object.
FSPDF_Array_AddDateTime
FS_RESULT FSPDF_Array_AddDateTime(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_DATETIMEZONE *dt)
Add a date and time element into array, to the last position.
FSPDF_Array_SetAt
FS_RESULT FSPDF_Array_SetAt(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT element)
Set a new element at parameter index position in array.
FSPDF_Object_CreateUnicodeString
FS_RESULT FSPDF_Object_CreateUnicodeString(FSCRT_DOCUMENT document, const FSCRT_BSTR *string, FSPDF_OBJECT *object)
Create an UTF-8 string PDF object.
FSPDF_Dictionary_SetAtMatrix
FS_RESULT FSPDF_Dictionary_SetAtMatrix(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_MATRIX *matrix)
Set a matrix value to specific key in dictionary.
FS_BOOL
int FS_BOOL
Boolean type (This should be TRUE or FALSE).
Definition: fs_base_r.h:133
FSPDF_Object_CreateDict
FS_RESULT FSPDF_Object_CreateDict(FSCRT_DOCUMENT document, FSPDF_OBJECT *object)
Create a dictionary PDF object.
FSPDF_Dictionary_SetAtUnicodeName
FS_RESULT FSPDF_Dictionary_SetAtUnicodeName(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, const FSCRT_BSTR *key, const FSCRT_BSTR *nameStr)
Set a UTF-8 name value to specific key in dictionary.
FSPDF_Object_CreateArray
FS_RESULT FSPDF_Object_CreateArray(FSCRT_DOCUMENT document, FSPDF_OBJECT *object)
Create an array PDF object.
FSPDF_Object_CreateStream
FS_RESULT FSPDF_Object_CreateStream(FSCRT_DOCUMENT document, FSPDF_OBJECT dictionary, FSPDF_OBJECT *object)
Create a stream PDF object.
FSPDF_Array_AddInteger
FS_RESULT FSPDF_Array_AddInteger(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 number)
Add an integer element into array, to the last position.
FSCRT_MATRIX
Structure for 2D matrix.
Definition: fs_base_r.h:2130
FSCRT_BSTR
Structure for byte string.
Definition: fs_base_r.h:611
FSPDF_Array_AddUnicodeName
FS_RESULT FSPDF_Array_AddUnicodeName(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_BSTR *nameStr)
Add an UTF-8 name element into array, to the last position.
FSPDF_Object_CreateBoolean
FS_RESULT FSPDF_Object_CreateBoolean(FSCRT_DOCUMENT document, FS_BOOL boolean, FSPDF_OBJECT *object)
Create a boolean PDF object.
FSPDF_Array_InsertAt
FS_RESULT FSPDF_Array_InsertAt(FSCRT_DOCUMENT document, FSPDF_OBJECT array, FS_INT32 index, FSPDF_OBJECT element)
Insert an element into array.
FS_RESULT
int FS_RESULT
Result code for functions in Foxit PDF SDK.
Definition: fs_base_r.h:160
FSPDF_Array_AddMatrix
FS_RESULT FSPDF_Array_AddMatrix(FSCRT_DOCUMENT document, FSPDF_OBJECT array, const FSCRT_MATRIX *matrix)
Add a matrix element into array, to the last position.
FSPDF_Object_Release
FS_RESULT FSPDF_Object_Release(FSCRT_DOCUMENT document, FSPDF_OBJECT object)
Release a PDF object created but not inserted into any PDF document or other PDF objects.
FSPDF_Object_CreateRawByteString
FS_RESULT FSPDF_Object_CreateRawByteString(FSCRT_DOCUMENT document, const FSCRT_BSTR *string, FS_BOOL hexStr, FSPDF_OBJECT *object)
Create a raw string PDF object.

Foxit Corporation