QPdfLink#
The QPdfLink
class defines a link between a region on a page (such as a hyperlink or a search result) and a destination (page, location on the page, and zoom level at which to view it). More…
Synopsis#
Properties#
Functions#
def
contextAfter
()def
contextBefore
()def
copyToClipboard
([mode=QClipboard.Clipboard])def
isValid
()def
location
()def
page
()def
rectangles
()def
swap
(other)def
toString
()def
url
()def
zoom
()
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#
- class PySide6.QtPdf.QPdfLink#
PySide6.QtPdf.QPdfLink(other)
- Parameters:
other –
PySide6.QtPdf.QPdfLink
Constructs an invalid Destination.
See also
valid
Note
Properties can be used directly when from __feature__ import true_property
is used or via accessor functions otherwise.
- property PᅟySide6.QtPdf.QPdfLink.contextAfter: str#
This property holds adjacent text found on the page after the search string. If the link is a hyperlink, this string is empty.
See also
- Access functions:
contextAfter
()
- property PᅟySide6.QtPdf.QPdfLink.contextBefore: str#
This property holds adjacent text found on the page before the search string. If the link is a hyperlink, this string is empty.
See also
- Access functions:
- property PᅟySide6.QtPdf.QPdfLink.location: PySide6.QtCore.QPointF#
This property holds the location on the page
, in units of points. If the link is a search result, it is the location where the result is found; if the link is a hyperlink, it is the destination location.
- Access functions:
location
()
- property PᅟySide6.QtPdf.QPdfLink.page: int#
This property holds the page number. If the link is a search result, it is the page number on which the result is found; if the link is a hyperlink, it is the destination page number.
- Access functions:
page
()
- property PᅟySide6.QtPdf.QPdfLink.rectangles#
This property holds the region (set of rectangles) occupied by the link or search result on the page where it was found. If the text wraps around to multiple lines on the page, there may be multiple rectangles:
See also
- Access functions:
rectangles
()
- property PᅟySide6.QtPdf.QPdfLink.url: PySide6.QtCore.QUrl#
This property holds the destination URL if the link is an external hyperlink; otherwise, it’s empty.
- Access functions:
url
()
- property PᅟySide6.QtPdf.QPdfLink.valid: bool#
This property holds whether the link is valid.
- Access functions:
isValid
()
- property PᅟySide6.QtPdf.QPdfLink.zoom: float#
This property holds the suggested magnification level, where 1.0 means default scale (1 pixel = 1 point). If the link is a search result, this value is not used.
- Access functions:
zoom
()
- PySide6.QtPdf.QPdfLink.contextAfter()#
- Return type:
str
Getter of property contextAfter
.
- PySide6.QtPdf.QPdfLink.contextBefore()#
- Return type:
str
Getter of property contextBefore
.
Copies the toString()
representation of the link to the system clipboard depending on the mode
given.
- PySide6.QtPdf.QPdfLink.isValid()#
- Return type:
bool
Getter of property valid
.
- PySide6.QtPdf.QPdfLink.location()#
- Return type:
Getter of property location
.
- PySide6.QtPdf.QPdfLink.page()#
- Return type:
int
Getter of property page
.
- PySide6.QtPdf.QPdfLink.rectangles()#
Getter of property rectangles
.
- PySide6.QtPdf.QPdfLink.swap(other)#
- Parameters:
other –
PySide6.QtPdf.QPdfLink
- PySide6.QtPdf.QPdfLink.toString()#
- Return type:
str
Returns a translated representation for display.
See also
- PySide6.QtPdf.QPdfLink.url()#
- Return type:
Getter of property url
.
- PySide6.QtPdf.QPdfLink.zoom()#
- Return type:
float
Getter of property zoom
.