summaryrefslogtreecommitdiffstats
path: root/src/pdfquick/qquickpdfdocument_p.h
blob: af9cab4101170bb9658599921bf3cef673cd2190 (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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/****************************************************************************
**
** 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 QQUICKPDFDOCUMENT_P_H
#define QQUICKPDFDOCUMENT_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtPdfQuick/private/qtpdfquickglobal_p.h>
#include <QtPdf/QPdfDocument>

#include <QtQml/QQmlEngine>
#include <QtQml/QQmlParserStatus>
#include <QtCore/QDateTime>
#include <QtCore/QUrl>

QT_BEGIN_NAMESPACE

class QPdfFile;

class Q_PDFQUICK_EXPORT QQuickPdfDocument : public QObject, public QQmlParserStatus
{
    Q_OBJECT
    Q_INTERFACES(QQmlParserStatus)

    Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged FINAL)
    Q_PROPERTY(qreal maxPageWidth READ maxPageWidth NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(qreal maxPageHeight READ maxPageHeight NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(QString error READ error NOTIFY errorChanged FINAL)

    Q_PROPERTY(QString title READ title NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(QString subject READ subject NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(QString author READ author NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(QString keywords READ keywords NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(QString producer READ producer NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(QString creator READ creator NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(QDateTime creationDate READ creationDate NOTIFY metaDataChanged FINAL)
    Q_PROPERTY(QDateTime modificationDate READ modificationDate NOTIFY metaDataChanged FINAL)
    QML_NAMED_ELEMENT(PdfDocument)
    QML_EXTENDED(QPdfDocument)
    QML_ADDED_IN_VERSION(5, 15)

public:
    explicit QQuickPdfDocument(QObject *parent = nullptr);
    ~QQuickPdfDocument() override;

    void classBegin() override;
    void componentComplete() override {}

    QUrl source() const { return m_source; }
    void setSource(QUrl source);
    QUrl resolvedSource() const { return m_resolvedSource; }

    QString error() const;

    QString title() { return m_doc->metaData(QPdfDocument::MetaDataField::Title).toString(); }
    QString author() { return m_doc->metaData(QPdfDocument::MetaDataField::Author).toString(); }
    QString subject() { return m_doc->metaData(QPdfDocument::MetaDataField::Subject).toString(); }
    QString keywords() { return m_doc->metaData(QPdfDocument::MetaDataField::Keywords).toString(); }
    QString producer() { return m_doc->metaData(QPdfDocument::MetaDataField::Producer).toString(); }
    QString creator() { return m_doc->metaData(QPdfDocument::MetaDataField::Creator).toString(); }
    QDateTime creationDate() { return m_doc->metaData(QPdfDocument::MetaDataField::CreationDate).toDateTime(); }
    QDateTime modificationDate() { return m_doc->metaData(QPdfDocument::MetaDataField::ModificationDate).toDateTime(); }

    Q_INVOKABLE QSizeF pagePointSize(int page) const;
    qreal maxPageWidth() const;
    qreal maxPageHeight() const;

Q_SIGNALS:
    void sourceChanged();
    void errorChanged();
    void metaDataChanged();

private:
    QPdfDocument *document() const;
    QPdfFile *carrierFile();
    void updateMaxPageSize() const;

private:
    QUrl m_source;
    QUrl m_resolvedSource;
    QPdfDocument *m_doc = nullptr;
    QPdfFile *m_carrierFile = nullptr;
    mutable QSizeF m_maxPageWidthHeight;

    friend class QQuickPdfBookmarkModel;
    friend class QQuickPdfLinkModel;
    friend class QQuickPdfPageImage;
    friend class QQuickPdfSearchModel;
    friend class QQuickPdfSelection;

    Q_DISABLE_COPY(QQuickPdfDocument)
};

QT_END_NAMESPACE

#endif // QQUICKPDFDOCUMENT_P_H