d7/d22/qpdflink_8h_source.html

// Copyright (C) 2022 The Qt Company Ltd.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only


#ifndef QPDFLINK_H

#define QPDFLINK_H


#include <QtPdf/qtpdfglobal.h>

#include <QtCore/qlist.h>

#include <QtCore/qobject.h>

#include <QtCore/qpoint.h>

#include <QtCore/qrect.h>

#include <QtCore/qshareddata.h>

#include <QtGui/qclipboard.h>


QT_BEGIN_NAMESPACE


class QDebug;

class QPdfLinkPrivate;


class QPdfLink

{

    Q_GADGET_EXPORT(Q_PDF_EXPORT)

    Q_PROPERTY(bool valid READ isValid)

    Q_PROPERTY(int page READ page)

    Q_PROPERTY(QPointF location READ location)

    Q_PROPERTY(qreal zoom READ zoom)

    Q_PROPERTY(QUrl url READ url)

    Q_PROPERTY(QString contextBefore READ contextBefore)

    Q_PROPERTY(QString contextAfter READ contextAfter)

    Q_PROPERTY(QList<QRectF> rectangles READ rectangles)


public:

    Q_PDF_EXPORT QPdfLink();

    Q_PDF_EXPORT ~QPdfLink();

    Q_PDF_EXPORT QPdfLink &operator=(const QPdfLink &other);


    Q_PDF_EXPORT QPdfLink(const QPdfLink &other) noexcept;

    Q_PDF_EXPORT QPdfLink(QPdfLink &&other) noexcept;

    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_MOVE_AND_SWAP(QPdfLink)


    void swap(QPdfLink &other) noexcept { d.swap(other.d); }


    Q_PDF_EXPORT bool isValid() const;

    Q_PDF_EXPORT int page() const;

    Q_PDF_EXPORT QPointF location() const;

    Q_PDF_EXPORT qreal zoom() const;

    Q_PDF_EXPORT QUrl url() const;

    Q_PDF_EXPORT QString contextBefore() const;

    Q_PDF_EXPORT QString contextAfter() const;

    Q_PDF_EXPORT QList<QRectF> rectangles() const;

    Q_PDF_EXPORT Q_INVOKABLE QString toString() const;

    Q_PDF_EXPORT Q_INVOKABLE void copyToClipboard(QClipboard::Mode mode = QClipboard::Clipboard) const;


private: // methods

    QPdfLink(int page, QPointF location, qreal zoom);

    QPdfLink(int page, QList<QRectF> rects, QString contextBefore, QString contextAfter);

    QPdfLink(QPdfLinkPrivate *d);

    friend class QPdfDocument;

    friend class QPdfLinkModelPrivate;

    friend class QPdfSearchModelPrivate;

    friend class QPdfPageNavigator;

    friend class QQuickPdfPageNavigator;


private: // storage

    QExplicitlySharedDataPointer<QPdfLinkPrivate> d;


};

Q_DECLARE_SHARED(QPdfLink)


#ifndef QT_NO_DEBUG_STREAM

Q_PDF_EXPORT QDebug operator<<(QDebug, const QPdfLink &);

#endif


QT_END_NAMESPACE


Q_DECLARE_METATYPE(QPdfLink)


#endif // QPDFLINK_H

QClipboard::Mode
Mode
\keyword clipboard mode
Definition qclipboard.h:27

QClipboard::Clipboard
@ Clipboard
Definition qclipboard.h:27

QDebug
\inmodule QtCore

QExplicitlySharedDataPointer
\inmodule QtCore
Definition qshareddata.h:130

QExplicitlySharedDataPointer::swap
void swap(QExplicitlySharedDataPointer &other) noexcept
Swap this instance's explicitly shared data pointer with the explicitly shared data pointer in other.
Definition qshareddata.h:199

QList
Definition qlist.h:74

QPdfDocument
The QPdfDocument class loads a PDF document and renders pages from it.
Definition qpdfdocument.h:21

QPdfLinkModelPrivate
Definition qpdflinkmodel_p.h:24

QPdfLinkPrivate
Definition qpdflink_p.h:27

QPdfLink
The QPdfLink class defines a link between a region on a page (such as a hyperlink or a search result)...
Definition qpdflink.h:21

QPdfLink::~QPdfLink
Q_PDF_EXPORT ~QPdfLink()

QPdfLink::QPdfLink
Q_PDF_EXPORT QPdfLink()
Constructs an invalid Destination.
Definition qpdflink.cpp:27

QPdfLink::url
QUrl url
This property holds the destination URL if the link is an external hyperlink; otherwise,...
Definition qpdflink.h:27

QPdfLink::copyToClipboard
Q_PDF_EXPORT Q_INVOKABLE void copyToClipboard(QClipboard::Mode mode=QClipboard::Clipboard) const
Copies the toString() representation of the link to the \l {QGuiApplication::clipboard()}{system clip...
Definition qpdflink.cpp:166

QPdfLink::contextAfter
QString contextAfter
This property holds adjacent text found on the page after the search string.
Definition qpdflink.h:29

QPdfLink::zoom
qreal zoom
This property holds the suggested magnification level, where 1.0 means default scale (1 pixel = 1 poi...
Definition qpdflink.h:26

QPdfLink::QPdfLink
Q_PDF_EXPORT QPdfLink(const QPdfLink &other) noexcept

QPdfLink::QPdfLink
Q_PDF_EXPORT QPdfLink(QPdfLink &&other) noexcept

QPdfLink::location
QPointF location
This property holds the location on the \l page, in units of points.
Definition qpdflink.h:25

QPdfLink::operator=
Q_PDF_EXPORT QPdfLink & operator=(const QPdfLink &other)

QPdfLink::toString
Q_PDF_EXPORT Q_INVOKABLE QString toString() const
Returns a translated representation for display.
Definition qpdflink.cpp:153

QPdfLink::page
int page
This property holds the page number.
Definition qpdflink.h:24

QPdfLink::contextBefore
QString contextBefore
This property holds adjacent text found on the page before the search string.
Definition qpdflink.h:28

QPdfLink::rectangles
QList< QRectF > rectangles
This property holds the region (set of rectangles) occupied by the link or search result on the page ...
Definition qpdflink.h:30

QPdfLink::valid
bool valid
This property holds whether the link is valid.
Definition qpdflink.h:23

QPdfLink::isValid
Q_PDF_EXPORT bool isValid() const
Definition qpdflink.cpp:55

QPdfPageNavigator
Navigation history within a PDF document.
Definition qpdfpagenavigator.h:16

QPdfSearchModelPrivate
Definition qpdfsearchmodel_p.h:26

QPointF
\inmodule QtCore\reentrant
Definition qpoint.h:214

QQuickPdfPageNavigator
Definition qquickpdfpagenavigator_p.h:35

QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:127

QUrl
\inmodule QtCore
Definition qurl.h:94

QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21

QT_END_NAMESPACE
Definition qsharedpointer.cpp:1545

void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition qdbus_symbols_p.h:401

Q_DECLARE_METATYPE
#define Q_DECLARE_METATYPE(TYPE)
Definition qmetatype.h:1504

location
GLint location
Definition qopengles2ext.h:207

mode
GLenum mode
Definition qopengles2ext.h:333

operator<<
Q_PDF_EXPORT QDebug operator<<(QDebug, const QPdfLink &)
Definition qpdflink.cpp:172

Q_PROPERTY
#define Q_PROPERTY(...)
Definition qtmetamacros.h:56

Q_GADGET_EXPORT
#define Q_GADGET_EXPORT(...)
Definition qtmetamacros.h:138

Q_INVOKABLE
#define Q_INVOKABLE
Definition qtmetamacros.h:76

Q_PDF_EXPORT
#define Q_PDF_EXPORT
Definition qtpdfglobal.h:16

qreal
double qreal
Definition qtypes.h:92

d
double d
Definition src_corelib_text_qlocale.cpp:9

other
QSharedPointer< T > other(t)
[5]