summaryrefslogtreecommitdiffstats
path: root/src/pdf/qpdfselection.cpp
blob: 5f0ee3b2091bf2db41f1bb70959f4a2b49bc0ac1 (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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtPDF module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3$
** 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free
** Software Foundation and appearing in the file LICENSE.GPL included in
** the packaging of this file. Please review the following information to
** ensure the GNU General Public License version 2.0 requirements will be
** met: http://www.gnu.org/licenses/gpl-2.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qpdfselection.h"
#include "qpdfselection_p.h"
#include <QGuiApplication>

QT_BEGIN_NAMESPACE

/*!
    \class QPdfSelection
    \since 5.15
    \inmodule QtPdf

    \brief The QPdfSelection class defines a range of text that has been selected
    on one page in a PDF document, and its geometric boundaries.

    \sa QPdfDocument::getSelection()
*/

/*!
    Constructs an invalid selection.

    \sa valid
*/
QPdfSelection::QPdfSelection()
  : d(new QPdfSelectionPrivate())
{
}

/*!
    \internal
    Constructs a selection including the range of characters that make up the
    \a text string, and which take up space on the page within the polygon
    regions given in \a bounds.
*/
QPdfSelection::QPdfSelection(const QString &text, QVector<QPolygonF> bounds, QRectF boundingRect, int startIndex, int endIndex)
  : d(new QPdfSelectionPrivate(text, bounds, boundingRect, startIndex, endIndex))
{
}

QPdfSelection::QPdfSelection(QPdfSelectionPrivate *d)
  : d(d)
{
}

QPdfSelection::QPdfSelection(const QPdfSelection &other)
  : d(other.d)
{
}

QPdfSelection::QPdfSelection(QPdfSelection &&other) noexcept
  : d(std::move(other.d))
{
}

QPdfSelection::~QPdfSelection()
{
}

QPdfSelection &QPdfSelection::operator=(const QPdfSelection &other)
{
    d = other.d;
    return *this;
}

/*!
    \property QPdfSelection::valid

    This property holds whether the selection is valid.
*/
bool QPdfSelection::isValid() const
{
    return !d->bounds.isEmpty();
}

/*!
    \property QPdfSelection::bounds

    This property holds a set of regions that the selected text occupies on the
    page, represented as polygons. The coordinate system for the polygons has
    the origin at the upper-left corner of the page, and the units are
    \l {https://en.wikipedia.org/wiki/Point_(typography)}{points}.

    \note For now, the polygons returned from \l QPdfDocument::getSelection()
    are always rectangles; but in the future it may be possible to represent
    more complex regions.
*/
QVector<QPolygonF> QPdfSelection::bounds() const
{
    return d->bounds;
}

/*!
    \property QPdfSelection::text

    This property holds the selected text.
*/
QString QPdfSelection::text() const
{
    return d->text;
}

/*!
    \property rect QPdfSelection::boundingRectangle

    This property holds the overall bounding rectangle (convex hull) around \l bounds.
*/
QRectF QPdfSelection::boundingRectangle() const
{
    return d->boundingRect;
}

/*!
    \property int QPdfSelection::startIndex

    This property holds the index at the beginning of \l text within the full text on the page.
*/
int QPdfSelection::startIndex() const
{
    return d->startIndex;
}

/*!
    \property int QPdfSelection::endIndex

    This property holds the index at the end of \l text within the full text on the page.
*/
int QPdfSelection::endIndex() const
{
    return d->endIndex;
}

#if QT_CONFIG(clipboard)
/*!
    Copies \l text to the \l {QGuiApplication::clipboard()}{system clipboard}.
*/
void QPdfSelection::copyToClipboard(QClipboard::Mode mode) const
{
    QGuiApplication::clipboard()->setText(d->text, mode);
}
#endif

QT_END_NAMESPACE

#include "moc_qpdfselection.cpp"