PoDoFo 0.9.20
|
#include <PdfDictionary.h>
Public Member Functions | |
PdfDictionary () | |
PdfDictionary (const PdfDictionary &rhs) | |
PdfDictionary & | operator= (const PdfDictionary &rhs) |
bool | operator== (const PdfDictionary &rhs) const |
bool | operator!= (const PdfDictionary &rhs) const |
void | Clear () |
PdfObject & | AddKey (const PdfName &key, const PdfObject &obj) |
void | AddKeyIndirect (const PdfName &key, const PdfObject &obj) |
PdfObject & | AddKeyIndirectSafe (const PdfName &key, const PdfObject &obj) |
const PdfObject * | GetKey (const std::string_view &key) const |
PdfObject * | GetKey (const std::string_view &key) |
const PdfObject * | FindKey (const std::string_view &key) const |
const PdfObject * | FindKeyParent (const std::string_view &key) const |
const PdfObject & | MustGetKey (const std::string_view &key) const |
bool | HasKey (const std::string_view &key) const |
bool | RemoveKey (const std::string_view &key) |
void | Write (OutputStream &stream, PdfWriteFlags writeMode, const PdfStatefulEncrypt &encrypt, charbuff &buffer) const override |
unsigned | GetSize () const |
![]() | |
const PdfObject * | GetOwner () const |
![]() | |
std::string | ToString () const |
Additional Inherited Members | |
![]() | |
PdfDataContainer () | |
![]() | |
PdfDataProvider () | |
The PDF dictionary data type of PoDoFo (inherits from PdfDataContainer, the base class for such representations) Note: manipulation function accepts PdfName for the key, while getters accept std::string_view. This is an optimization since we do lookup with both types. We also assume doing lookups with strings will only use characters compatible with PdfDocEncoding
PdfDictionary::PdfDictionary | ( | ) |
Create a new, empty dictionary
PdfDictionary::PdfDictionary | ( | const PdfDictionary & | rhs | ) |
Deep copy a dictionary
rhs | the PdfDictionary to copy |
Add a key to the dictionary. If an existing key of this name exists, its value is replaced and the old value object will be deleted. The given object is copied.
This will set the dirty flag of this object.
key | the key is identified by this name in the dictionary |
obj | object containing the data. The object is copied. |
Add a key to the dictionary. If an existing key of this name exists, its value is replaced and the old value object will be deleted. The object must be indirect and the object reference will be added instead to the dictionary
This will set the dirty flag of this object.
key | the key is identified by this name in the dictionary |
obj | object containing the data |
PdfError::InvalidHandle | on nullptr obj or if the object can't be added as an indirect reference |
Add a key to the dictionary. If an existing key of this name exists, its value is replaced and the old value object will be deleted. If the object is indirect the object reference will be added instead to the dictionary, otherwise the object is copied
This will set the dirty flag of this object.
key | the key is identified by this name in the dictionary |
obj | a variant object containing the data |
PdfError::InvalidHandle | on nullptr obj |
void PdfDictionary::Clear | ( | ) |
Removes all keys from the dictionary
const PdfObject * PoDoFo::PdfDictionary::FindKey | ( | const std::string_view & | key | ) | const |
Get the keys value out of the dictionary
Lookup in the indirect objects as well, if the shallow object was a reference. The returned value is a pointer to the internal object in the dictionary so it MUST not be deleted.
key | look for the key names key in the dictionary |
const PdfObject * PoDoFo::PdfDictionary::FindKeyParent | ( | const std::string_view & | key | ) | const |
Get the keys value out of the dictionary
Lookup in the indirect objects as well, if the shallow object was a reference. Also lookup the parent objects, if /Parent key is found in the dictionary. The returned value is a pointer to the internal object in the dictionary so it MUST not be deleted.
key | look for the key names key in the dictionary |
PdfObject * PoDoFo::PdfDictionary::GetKey | ( | const std::string_view & | key | ) |
Get the key's value out of the dictionary. This is an overloaded member function.
The returned value is a pointer to the internal object in the dictionary. It may be modified but is still owned by the dictionary so it MUST not be deleted.
key | look for the key named key in the dictionary |
const PdfObject * PoDoFo::PdfDictionary::GetKey | ( | const std::string_view & | key | ) | const |
Get the key's value out of the dictionary.
The returned value is a pointer to the internal object in the dictionary so it MUST not be deleted.
key | look for the key named key in the dictionary |
unsigned PdfDictionary::GetSize | ( | ) | const |
bool PdfDictionary::HasKey | ( | const std::string_view & | key | ) | const |
Allows to check if a dictionary contains a certain key.
key | look for the key named key.Name() in the dictionary |
const PdfObject & PoDoFo::PdfDictionary::MustGetKey | ( | const std::string_view & | key | ) | const |
Get the key's value out of the dictionary.
The returned value is a reference to the internal object in the dictionary so it MUST not be deleted. If the key is not found, this throws a PdfError exception with error code PdfErrorCode::NoObject, instead of returning. This is intended to make code more readable by sparing (especially multiple) nullptr checks.
key | look for the key named key in the dictionary |
PdfError(PdfErrorCode::NoObject). |
bool PdfDictionary::operator!= | ( | const PdfDictionary & | rhs | ) | const |
PdfDictionary & PdfDictionary::operator= | ( | const PdfDictionary & | rhs | ) |
Assignment operator. Assign another PdfDictionary to this dictionary. This is a deep copy; all elements of the source dictionary are duplicated.
rhs | the PdfDictionary to copy. |
This will set the dirty flag of this object.
bool PdfDictionary::operator== | ( | const PdfDictionary & | rhs | ) | const |
Comparison operator. If this dictionary contains all the same keys as the other dictionary, and for each key the values compare equal, the dictionaries are considered equal.
bool PdfDictionary::RemoveKey | ( | const std::string_view & | key | ) |
Remove a key from this dictionary. If the key does not exist, this function does nothing.
key | the name of the key to delete |
This will set the dirty flag of this object.
|
overridevirtual |
Write the complete datatype to a file.
device | write the object to this device |
writeMode | additional options for writing this object |
encrypt | an encryption object which is used to encrypt this object or nullptr to not encrypt this object |
Implements PoDoFo::PdfDataProvider.