NumberTree Class Documentation
class NumberTreeNamespace:datalogics_interface
Detailed Description
The number tree is a common data structure in PDF files.
The number tree is a type of dictionary that can store many more pairs of matched records than a standard object dictionary.
A number tree uses keys that are integers to map to data objects, sorted in ascending numerical order.
Constructor & Destructor Documentation
NumberTree
NumberTree(Document & doc)Parameters
doc: Document &The Document in which to create the NumberTree.
Creates a new, empty NumberTree in the specified Document.
NumberTree
NumberTree(NumberTree && )Parameters
~NumberTree
~NumberTree()Member Function Documentation
get
std::unique_ptr< PDFObject > get(int32_t key)Parameters
key: int32_tThe integer key of the PDFObject to get from the tree.
Returns:
std::unique_ptr< PDFObject >The PDFObject value corresponding to the supplied key.
Retrieves an entry from this NumberTree.
get_pdf_dict
PDFDict get_pdf_dict()Returns:
PDFDictThe PDFDict representing the NumberTree's data structure.
Gets the underlying PDFDict of this NumberTree.
operator=
NumberTree & operator=(NumberTree && )Parameters
Returns:
NumberTree &put
void put(int32_t key, PDFObject & value)Parameters
key: int32_t- The integer of the PDFObject to put in the tree.
value: PDFObject &- The PDFObject to be associated with key.
Returns:
voidPuts a new entry in this NumberTree. If an entry with this name is already in the tree, it is replaced.
remove
void remove(int32_t key)Parameters
key: int32_t- The integer of the PDFObject to remove from the tree.
Returns:
voidRemoves the specified PDFObject from this NumberTree. It does nothing if no PDFObject of that number exists in this NumberTree.