QPDFObjectHelper.hh
2.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Copyright (c) 2005-2021 Jay Berkenbilt
// Copyright (c) 2022-2025 Jay Berkenbilt and Manfred Holger
//
// This file is part of qpdf.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
// in compliance with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under the License
// is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
// or implied. See the License for the specific language governing permissions and limitations under
// the License.
//
// Versions of qpdf prior to version 7 were released under the terms of version 2.0 of the Artistic
// License. At your option, you may continue to consider qpdf to be licensed under those terms.
// Please see the manual for additional information.
#ifndef QPDFOBJECTHELPER_HH
#define QPDFOBJECTHELPER_HH
#include <qpdf/DLL.h>
#include <qpdf/QPDFObjectHandle.hh>
// This is a base class for QPDF Object Helper classes. Object helpers are classes that provide a
// convenient, higher-level API for working with specific types of QPDF objects. Object helpers are
// always initialized with a QPDFObjectHandle, and the underlying object handle can always be
// retrieved. The intention is that you may freely intermix use of object helpers with the
// underlying QPDF objects unless there is a specific comment in a specific helper method that says
// otherwise. The pattern of using helper objects was introduced to allow creation of higher level
// helper functions without polluting the public interface of QPDFObjectHandle.
class QPDF_DLL_CLASS QPDFObjectHelper: public qpdf::BaseHandle
{
public:
QPDF_DLL
QPDFObjectHelper(QPDFObjectHandle oh) :
qpdf::BaseHandle(oh.getObj())
{
}
QPDF_DLL
virtual ~QPDFObjectHelper();
QPDF_DLL
QPDFObjectHandle
getObjectHandle()
{
return {obj};
}
QPDF_DLL
QPDFObjectHandle const
getObjectHandle() const
{
return {obj};
}
protected:
QPDF_DLL_PRIVATE
QPDFObjectHandle
oh()
{
return {obj};
}
QPDF_DLL_PRIVATE
QPDFObjectHandle const
oh() const
{
return {obj};
}
QPDFObjectHandle oh_;
};
#endif // QPDFOBJECTHELPER_HH