QPdfSelection Class

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

Header: #include <QPdfSelection>
Since: Qt 5.15

Properties

Public Functions

QPdfSelection(QPdfSelection &&other)
QPdfSelection(const QPdfSelection &other)
QPdfSelection &operator=(QPdfSelection &&other)
QPdfSelection &operator=(const QPdfSelection &other)
~QPdfSelection()
QRectF boundingRectangle() const
QList<QPolygonF> bounds() const
void copyToClipboard(QClipboard::Mode mode = QClipboard::Clipboard) const
int endIndex() const
bool isValid() const
int startIndex() const
void swap(QPdfSelection &other)
QString text() const

Detailed Description

See also QPdfDocument::getSelection().

Property Documentation

[read-only] boundingRectangle : const QRectF

This property holds the overall bounding rectangle (convex hull) around bounds.

Access functions:

QRectF boundingRectangle() const

[read-only] bounds : const QList<QPolygonF>

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 points.

Note: For now, the polygons returned from QPdfDocument::getSelection() are always rectangles; but in the future it may be possible to represent more complex regions.

Access functions:

QList<QPolygonF> bounds() const

[read-only] endIndex : const int

This property holds the index at the end of text within the full text on the page.

Access functions:

int endIndex() const

[read-only] startIndex : const int

This property holds the index at the beginning of text within the full text on the page.

Access functions:

int startIndex() const

[read-only] text : const QString

This property holds the selected text.

Access functions:

QString text() const

[read-only] valid : const bool

This property holds whether the selection is valid.

Access functions:

bool isValid() const

Member Function Documentation

QPdfSelection::QPdfSelection(QPdfSelection &&other)

Move-copy constructor.

QPdfSelection::QPdfSelection(const QPdfSelection &other)

Default constructs an instance of QPdfSelection.

QPdfSelection &QPdfSelection::operator=(QPdfSelection &&other)

Move-assignment operator.

QPdfSelection &QPdfSelection::operator=(const QPdfSelection &other)

Copy-assignment operator.

QPdfSelection::~QPdfSelection()

Destroys the instance of QPdfSelection.

void QPdfSelection::copyToClipboard(QClipboard::Mode mode = QClipboard::Clipboard) const

Copies text to the system clipboard depending on the mode selected.

void QPdfSelection::swap(QPdfSelection &other)

© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.