Go to the documentation of this file.
15 #ifndef FS_PDFOBJECT_H_
16 #define FS_PDFOBJECT_H_
436 PDFObject(
const PDFObject&);
437 PDFObject &operator = (
const PDFObject&
object);
457 typedef enum _Filter {
579 bool GetData(
bool is_raw_data,
size_t size,
void* out_buffer);
589 void SetData(
const void* buffer,
size_t size);
768 void AddName(
const char* name);
778 void AddString(
const wchar_t* new_string);
870 bool HasKey(
const char* key)
const;
970 void SetAtFloat(
const char* key,
float value);
1010 void SetAtName(
const char* key,
const char* value);
1022 void SetAtString(
const char* key,
const char* value);
1034 void SetAtString(
const char* key,
const wchar_t* value);
1056 #endif // FS_PDFOBJECT_H_
POSITION MoveNext(POSITION position)
Move to the position of first or the next entry.
PDF boolean object.
Definition: fs_pdfobject.h:66
PDF array object.
Definition: fs_pdfobject.h:74
bool IsIdentical(PDFObject *pdf_obj) const
Check if input PDF object is identical with current PDF object.
PDF null object.
Definition: fs_pdfobject.h:80
PDF string object.
Definition: fs_pdfobject.h:70
Definition: fs_pdfobject.h:640
Filter GetStreamFilter()
Get the type of stream filter which indicate how the stream data must be decoded before the data is u...
void AddInteger(int integer_value)
Add an integer value to the end of current PDF array object.
void SetAtMatrix(const char *key, const Matrix &value)
Set a matrix object as value element to an entry specified by key.
Filter type: ASCIIHexDecode, which means to decode data encoded in an ASCII hexadecimal representatio...
Definition: fs_pdfobject.h:466
static PDFDictionary * Create()
Create a new dictionary object.
Definition: fs_basictypes.h:482
void AddElement(PDFObject *element)
Add a PDF object to the end of current PDF array object.
Filter type: ASCII85Decode, which means to decode data encoded in an ASCII base-85 representation,...
Definition: fs_pdfobject.h:471
void AddReference(PDFObject *pdf_object, PDFDoc document)
Set the reference object of an indirect PDF object (whose object number is always above 0) as value e...
static PDFObject * CreateFromFloat(float float_value)
Create a PDF object from a float number.
CFX_Object Object
Object type.
Definition: fs_basictypes.h:221
Invalid PDF object type.
Definition: fs_pdfobject.h:64
FX_POSITION POSITION
A value used to denote the position of an element in a collection.
Definition: fs_basictypes.h:206
static PDFArray * CreateFromRect(const RectF &rect)
Create a new array object for a rectangle.
PDFObject * GetDirectObject() const
Get the direct object of current PDF object.
void SetAtName(const char *key, const char *value)
Set a string (as PDF name object) as value element to an entry specified by key.
Header file for common definitions and classes.
RectF GetRect() const
Get the rectangle value of current PDF object.
Filter
Enumeration for stream filter type.
Definition: fs_pdfobject.h:457
Type
Enumeration for PDF object type.
Definition: fs_pdfobject.h:62
PDF number object.
Definition: fs_pdfobject.h:68
void AddFloat(float float_value)
Add a float value to the end of current PDF array object.
void SetAtReference(const char *key, PDFObject *pdf_object, PDFDoc document)
Set the reference object of an indirect PDF object (whose object number is always above 0) as value e...
Definition: fx_basic.h:1297
String GetKey(POSITION position) const
Get the key of an entry specified by position.
File reading interface.
Definition: fx_stream.h:587
bool HasKey(const char *key) const
Check whether there is an entry with specified key in current dictionary or not.
Header file for file operation related definitions and functions.
PDFObject * GetElement(const char *key) const
Get the value element of an entry with specified key.
void AddName(const char *name)
Add a string as PDF name object to the end of current PDF array object.
void AddDateTime(const DateTime &date_time)
Add a date time to the end of current PDF array object.
CFX_ArrayTemplate< PDFDictionary * > PDFDictionaryArray
Definition: fs_pdfobject.h:1051
Filter type: DCTDecode, which means to decompress data encoded using a DCT (discrete cosine transform...
Definition: fs_pdfobject.h:503
Definition: fs_pdfobject.h:55
static PDFObject * CreateFromNameW(const wchar_t *name)
Create a PDF object from a string which represents a name.
static PDFObject * CreateFromDateTime(const DateTime &date_time)
Create a PDF object from date time.
void SetAtRect(const char *key, const RectF &value)
Set a rectangle object as value element to an entry specified by key.
Filter type: LZWDecode, which means to decompress data encoded using the LZW (Lempel-Ziv-Welch) adapt...
Definition: fs_pdfobject.h:476
PDFObject * GetValue(POSITION position) const
Get the value element of an entry specified by position.
uint64 GetDataSize(bool is_raw_data)
Get the size of stream data, in bytes.
PDFDictionary * GetDict()
Get the PDF dictionary object of current PDF object.
void SetData(const void *buffer, size_t size)
Set stream data.
void AddBoolean(bool boolean_value)
Add a boolean value to the end of current PDF array object.
static PDFStream * Create(PDFDictionary *dictionary)
Create a new stream object based on a dictionary.
static PDFArray * Create()
Create a new array object.
bool GetBoolean() const
Get the boolean value of current PDF object.
static PDFObject * CreateReference(PDFDoc document, uint32 object_number)
Create a reference for an indirect object.
BYTE STRING CLASS.
Definition: fx_string.h:317
void SetAtString(const char *key, const char *value)
Set a string as value element to an entry specified by key.
PDF dictionary object.
Definition: fs_pdfobject.h:76
void SetAtBoolean(const char *key, bool value)
Set boolean element an entry specified by key.
void RemoveAt(int index)
Remove an element in a specified position (by index) from current PDF array object.
DateTime GetDateTime() const
Get the date time value of current PDF object.
PDF reference object.
Definition: fs_pdfobject.h:82
Filter type: FlateDecode, which means to decompress data encoded using the zlib/deflate compression m...
Definition: fs_pdfobject.h:481
PDFObject * CloneObject() const
Clone current PDF object and get the cloned PDF object.
common::file::ReaderCallback * ExportData(bool is_raw_data)
Export stream data.
void Release()
Release a newly created PDF object or a clone PDF object, which is not related to PDF document or oth...
String GetName() const
Get the name value of current PDF object.
void AddRect(const RectF &rect)
Add a rectangle to the end of current PDF array object.
Foxit namespace.
Definition: fs_taggedpdf.h:27
static PDFObject * CreateFromInteger(int integer_value)
Create a PDF object from a integer number.
WString GetWideString() const
Get the wide string value of current PDF object.
String GetString() const
Get the string value of current PDF object.
Filter type: JPXDecode, which means to decompress data encoded using the wavelet-based JPEG2000 stand...
Definition: fs_pdfobject.h:508
Definition: fs_pdfobject.h:850
PDFDictionary * GetDictionary()
Get the PDF dictionary object associated to current PDF stream object.
static PDFObject * CreateFromBoolean(bool boolean_value)
Create a PDF object from a boolean value.
void SetAtFloat(const char *key, float value)
Set a float element to an entry specified by key.
PDFArray * GetArray()
Get the PDF array object of current PDF object.
int GetInteger() const
Get the integer value of current PDF object.
int GetElementCount() const
Get the count of elements.
static PDFObject * CreateFromName(const char *name)
Create a PDF object from a string which represents a name.
Filter type: JBIG2Decode, which means to decompress data encoded using the JBIG2 standard,...
Definition: fs_pdfobject.h:498
Unknown filter type.
Definition: fs_pdfobject.h:459
void AddString(const wchar_t *new_string)
Add a string as PDF string object to the end of current PDF array object.
PDF name object.
Definition: fs_pdfobject.h:72
PDFObject * GetElement(int index) const
Get a specified element by index.
Matrix GetMatrix() const
Get the matrix value of current PDF object.
Definition: fx_coordinates.h:771
PDFStream * GetStream()
Get the PDF stream object of current PDF object.
No need to decode the stream data.
Definition: fs_pdfobject.h:461
Filter type: CCITTFaxDecode, which means to decompress data encoded using the CCITT facsimile standar...
Definition: fs_pdfobject.h:493
bool GetData(bool is_raw_data, size_t size, void *out_buffer)
Get stream data.
Definition: fs_pdfdoc.h:772
static PDFObject * CreateFromString(const wchar_t *string_value)
Create a PDF object from string.
void ImportData(common::file::ReaderCallback *file_read, Filter stream_filter)
Import stream data.
void SetAt(int index, PDFObject *element)
Set a new PDF object at a specified position in current PDF array object.
PDFObject * DeepCloneObject() const
Clone current PDF object and get the cloned PDF object.
void InsertAt(int index, PDFObject *element)
Insert a PDF object to a specified position in current PDF array object.
PDF stream object.
Definition: fs_pdfobject.h:78
Definition: fx_coordinates.h:1076
Filter type: RunLengthDecode, which means to decompress data encoded using a byte-oriented run-length...
Definition: fs_pdfobject.h:488
static PDFArray * CreateFromMatrix(const Matrix &matrix)
Create a new array object for a matrix.
Definition: fs_pdfobject.h:448
void SetAtDateTime(const char *key, const DateTime &value)
Set a Datetime object as value element to an entry specified by key.
void RemoveAt(const char *key)
Remove an entry specified by key.
void AddMatrix(const Matrix &matrix)
Add a matrix to the end of current PDF array object.
WIDE STRING CLASS.
Definition: fx_string.h:1461
void SetAt(const char *key, PDFObject *pdf_object)
Set a direct PDF object (whose object number is always equal to 0) as value element to an entry speci...
uint32 GetObjNum() const
Get the indirect object number of current PDF object.
void SetAtInteger(const char *key, int value)
Set a integer element to an entry specified by key.
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
FX_UINT64 uint64
Unsigned 64-bit integer.
Definition: fs_basictypes.h:192
Filter type: Crypt, which means to decrypt data encrypted by a security handler, reproducing the orig...
Definition: fs_pdfobject.h:513
Type GetType() const
Get the type of current PDF object.
float GetFloat() const
Get the float value of current PDF object.
@2025 Foxit Software Incorporated. All rights reserved.