PySide6.QtPdf.QPdfSelection

class QPdfSelection

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

Synopsis

Properties

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

See also

getSelection()

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property boundingRectangleᅟ: QRectF

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

Access functions:
property boundsᅟ: list of 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 getSelection() are always rectangles; but in the future it may be possible to represent more complex regions.

Access functions:
property endIndexᅟ: int

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

Access functions:
property startIndexᅟ: int

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

Access functions:
property textᅟ: str

This property holds the selected text.

Access functions:
property validᅟ: bool

This property holds whether the selection is valid.

Access functions:
__init__(other)
Parameters:

otherQPdfSelection

boundingRectangle()
Return type:

QRectF

Getter of property boundingRectangleᅟ .

bounds()
Return type:

.list of QPolygonF

Getter of property boundsᅟ .

copyToClipboard([mode=QClipboard.Clipboard])
Parameters:

modeMode

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

endIndex()
Return type:

int

Getter of property endIndexᅟ .

isValid()
Return type:

bool

Getter of property validᅟ .

startIndex()
Return type:

int

Getter of property startIndexᅟ .

swap(other)
Parameters:

otherQPdfSelection

text()
Return type:

str

Getter of property textᅟ .