diff options
| author | m-holger <m-holger@kubitscheck.org> | 2022-01-30 15:39:01 +0100 |
|---|---|---|
| committer | Jay Berkenbilt <jberkenbilt@users.noreply.github.com> | 2022-01-30 19:09:54 +0100 |
| commit | 8a5ba5686c8cd6f3a9bd65e58ef001e1ae4f15b8 (patch) | |
| tree | 6e16b0aca7db062a97261d6cec30c6761bd87ce2 /include | |
| parent | 0f9086e5094029854eff81cf6480a2284887e5fe (diff) | |
| download | qpdf-8a5ba5686c8cd6f3a9bd65e58ef001e1ae4f15b8.tar.zst | |
Add some doc comments for QPDFObjectHandle dictionary methods
Diffstat (limited to 'include')
| -rw-r--r-- | include/qpdf/QPDFObjectHandle.hh | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/include/qpdf/QPDFObjectHandle.hh b/include/qpdf/QPDFObjectHandle.hh index ac6b4b55..7f3154c6 100644 --- a/include/qpdf/QPDFObjectHandle.hh +++ b/include/qpdf/QPDFObjectHandle.hh @@ -777,12 +777,19 @@ class QPDFObjectHandle QPDF_DLL 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 bool hasKey(std::string const&); + // Return the value for the key. If the key is not present, null is + // returned. QPDF_DLL 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 std::set<std::string> getKeys(); + // Return dictionary as a map. Entries with null values are included. QPDF_DLL std::map<std::string, QPDFObjectHandle> getDictAsMap(); |