octoleo/qpdf
2
1
Fork 0
mirror of https://github.com/qpdf/qpdf.git synced 2024-12-23 03:18:59 +00:00
Code Issues Releases Wiki Activity

Add some doc comments for QPDFObjectHandle dictionary methods

Browse Source
This commit is contained in:
m-holger 2022-01-30 14:39:01 +00:00 committed by Jay Berkenbilt
parent 0f9086e509
commit 8a5ba5686c
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/qpdf/QPDFObjectHandle.hh
View File

@ -777,12 +777,19 @@ class QPDFObjectHandle
QPDF_DLL QPDF_DLL
QPDFDictItems ditems(); QPDFDictItems ditems();
// Return true if key is present. Keys with null values are treated as if
// they are not present. This is as per the PDF spec.
QPDF_DLL QPDF_DLL
bool hasKey(std::string const&); bool hasKey(std::string const&);
// Return the value for the key. If the key is not present, null is
// returned.
QPDF_DLL QPDF_DLL
QPDFObjectHandle getKey(std::string const&); QPDFObjectHandle getKey(std::string const&);
// Return all keys. Keys with null values are treated as if
// they are not present. This is as per the PDF spec.
QPDF_DLL QPDF_DLL
std::set<std::string> getKeys(); std::set<std::string> getKeys();
// Return dictionary as a map. Entries with null values are included.
QPDF_DLL QPDF_DLL
std::map<std::string, QPDFObjectHandle> getDictAsMap(); std::map<std::string, QPDFObjectHandle> getDictAsMap();