summaryrefslogtreecommitdiffstats
path: root/src/pdf/qpdflink.h
blob: 81053b42a2976c782399725e1e38435bbe6cfa12 (plain)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtPDF module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QPDFLINK_H
#define QPDFLINK_H

#include <QtPdf/qtpdfglobal.h>
#include <QtCore/qdebug.h>
#include <QtCore/qlist.h>
#include <QtCore/qobject.h>
#include <QtCore/qpoint.h>
#include <QtCore/qrect.h>
#include <QtCore/qshareddata.h>

QT_BEGIN_NAMESPACE

class QPdfLinkPrivate;

class QPdfLink
{
    Q_GADGET_EXPORT(Q_PDF_EXPORT)
    Q_PROPERTY(bool valid READ isValid)
    Q_PROPERTY(int page READ page)
    Q_PROPERTY(QPointF location READ location)
    Q_PROPERTY(qreal zoom READ zoom)
    Q_PROPERTY(QString contextBefore READ contextBefore)
    Q_PROPERTY(QString contextAfter READ contextAfter)
    Q_PROPERTY(QList<QRectF> rectangles READ rectangles)

public:
    Q_PDF_EXPORT QPdfLink();
    Q_PDF_EXPORT ~QPdfLink();
    Q_PDF_EXPORT QPdfLink &operator=(const QPdfLink &other);

    Q_PDF_EXPORT QPdfLink(const QPdfLink &other) noexcept;
    Q_PDF_EXPORT QPdfLink(QPdfLink &&other) noexcept;
    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_MOVE_AND_SWAP(QPdfLink)

    void swap(QPdfLink &other) noexcept { d.swap(other.d); }

    Q_PDF_EXPORT bool isValid() const;
    Q_PDF_EXPORT int page() const;
    Q_PDF_EXPORT QPointF location() const;
    Q_PDF_EXPORT qreal zoom() const;
    Q_PDF_EXPORT QString contextBefore() const;
    Q_PDF_EXPORT QString contextAfter() const;
    Q_PDF_EXPORT QList<QRectF> rectangles() const;

private: // methods
    QPdfLink(int page, QPointF location, qreal zoom);
    QPdfLink(int page, QList<QRectF> rects, QString contextBefore, QString contextAfter);
    QPdfLink(QPdfLinkPrivate *d);
    friend class QPdfDocument;
    friend class QPdfSearchModelPrivate;
    friend class QQuickPdfNavigationStack;

private: // storage
    QExplicitlySharedDataPointer<QPdfLinkPrivate> d;

};
Q_DECLARE_SHARED(QPdfLink)

Q_PDF_EXPORT QDebug operator<<(QDebug, const QPdfLink &);

QT_END_NAMESPACE

#endif // QPDFLINK_H