Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuickPdfDocument Class Reference

#include <qquickpdfdocument_p.h>

+ Inheritance diagram for QQuickPdfDocument:
+ Collaboration diagram for QQuickPdfDocument:

Signals

void sourceChanged ()
 
void errorChanged ()
 
void metaDataChanged ()
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QQuickPdfDocument (QObject *parent=nullptr)
 A representation of a PDF document.
 
 ~QQuickPdfDocument () override
 
void classBegin () override
 Invoked after class creation, but before any properties have been set.
 
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
 
QUrl source () const
 
void setSource (QUrl source)
 \qmlproperty url PdfDocument::source
 
QUrl resolvedSource () const
 
QString error () const
 \qmlproperty string PdfDocument::error
 
QString title ()
 
QString author ()
 
QString subject ()
 
QString keywords ()
 
QString producer ()
 
QString creator ()
 
QDateTime creationDate ()
 
QDateTime modificationDate ()
 
qreal maxPageWidth () const
 \qmlproperty string PdfDocument::password
 
qreal maxPageHeight () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Properties

QUrl source
 
qreal maxPageWidth
 
qreal maxPageHeight
 
QString error
 
QString title
 
QString subject
 
QString author
 
QString keywords
 
QString producer
 
QString creator
 
QDateTime creationDate
 
QDateTime modificationDate
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Friends

class QQuickPdfBookmarkModel
 
class QQuickPdfLinkModel
 
class QQuickPdfPageImage
 
class QQuickPdfSearchModel
 
class QQuickPdfSelection
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 30 of file qquickpdfdocument_p.h.

Constructor & Destructor Documentation

◆ QQuickPdfDocument()

QT_BEGIN_NAMESPACE QQuickPdfDocument::QQuickPdfDocument ( QObject * parent = nullptr)
explicit

A representation of a PDF document.

\qmltype PdfDocument

! \instantiates QQuickPdfDocument \inqmlmodule QtQuick.Pdf

Since
5.15

PdfDocument provides access to PDF document meta-information. It is not necessary for rendering, as it is enough to use an \l Image with source set to the URL of the PDF.

Definition at line 31 of file qquickpdfdocument.cpp.

◆ ~QQuickPdfDocument()

QQuickPdfDocument::~QQuickPdfDocument ( )
override

Definition at line 39 of file qquickpdfdocument.cpp.

Member Function Documentation

◆ author()

QString QQuickPdfDocument::author ( )
inline

Definition at line 66 of file qquickpdfdocument_p.h.

References QPdfDocument::Author.

◆ classBegin()

void QQuickPdfDocument::classBegin ( )
overridevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 44 of file qquickpdfdocument.cpp.

References QObject::connect(), emit, QPdfDocument::error(), errorChanged(), QPdfDocument::IncorrectPassword, QPdfDocument::load(), metaDataChanged(), QPdfDocument::passwordChanged(), QPdfDocument::passwordRequired(), Q_ASSERT, qmlExtendedObject(), QPdfDocument::Ready, resolvedSource(), QPdfDocument::statusChanged(), and QQmlFile::urlToLocalFileOrQrc().

+ Here is the call graph for this function:

◆ componentComplete()

void QQuickPdfDocument::componentComplete ( )
inlineoverridevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 57 of file qquickpdfdocument_p.h.

◆ creationDate()

QDateTime QQuickPdfDocument::creationDate ( )
inline

Definition at line 71 of file qquickpdfdocument_p.h.

References QPdfDocument::CreationDate.

◆ creator()

QString QQuickPdfDocument::creator ( )
inline

Definition at line 70 of file qquickpdfdocument_p.h.

References QPdfDocument::Creator.

◆ error()

QString QQuickPdfDocument::error ( ) const

\qmlproperty string PdfDocument::error

This property holds a translated string representation of the current error, if any.

See also
status

Definition at line 93 of file qquickpdfdocument.cpp.

References QPdfDocument::DataNotYetAvailable, QPdfDocument::error(), QPdfDocument::FileNotFound, QPdfDocument::IncorrectPassword, QPdfDocument::InvalidFileFormat, QPdfDocument::None, tr, QPdfDocument::Unknown, and QPdfDocument::UnsupportedSecurityScheme.

+ Here is the call graph for this function:

◆ errorChanged

void QQuickPdfDocument::errorChanged ( )
signal

Referenced by classBegin().

+ Here is the caller graph for this function:

◆ keywords()

QString QQuickPdfDocument::keywords ( )
inline

Definition at line 68 of file qquickpdfdocument_p.h.

References QPdfDocument::Keywords.

◆ maxPageHeight()

qreal QQuickPdfDocument::maxPageHeight ( ) const

Definition at line 154 of file qquickpdfdocument.cpp.

References QSizeF::height().

+ Here is the call graph for this function:

◆ maxPageWidth()

qreal QQuickPdfDocument::maxPageWidth ( ) const

\qmlproperty string PdfDocument::password

This property holds the document password. If the passwordRequired() signal is emitted, the UI should prompt the user and then set this property so that document opening can continue.

\qmlproperty int PdfDocument::pageCount

This property holds the number of pages the PDF contains.

\qmlsignal PdfDocument::passwordRequired()

This signal is emitted when the PDF requires a password in order to open. The UI in a typical PDF viewer should prompt the user for the password and then set the password property when the user has provided it.

\qmlmethod size PdfDocument::pagePointSize(int page)

Returns the size of the given page in points.

Definition at line 148 of file qquickpdfdocument.cpp.

References QSizeF::width().

+ Here is the call graph for this function:

◆ metaDataChanged

void QQuickPdfDocument::metaDataChanged ( )
signal

Referenced by classBegin().

+ Here is the caller graph for this function:

◆ modificationDate()

QDateTime QQuickPdfDocument::modificationDate ( )
inline

Definition at line 72 of file qquickpdfdocument_p.h.

References QPdfDocument::ModificationDate.

◆ producer()

QString QQuickPdfDocument::producer ( )
inline

Definition at line 69 of file qquickpdfdocument_p.h.

References QPdfDocument::Producer.

◆ resolvedSource()

QUrl QQuickPdfDocument::resolvedSource ( ) const
inline

Definition at line 61 of file qquickpdfdocument_p.h.

Referenced by classBegin(), and QQuickPdfPageImage::setDocument().

+ Here is the caller graph for this function:

◆ setSource()

void QQuickPdfDocument::setSource ( QUrl source)

\qmlproperty url PdfDocument::source

This property holds a URL pointing to the PDF file to be loaded.

Note
At this time, only local filesystem URLs are supported.

Definition at line 68 of file qquickpdfdocument.cpp.

References context, QObject::deleteLater(), emit, QUrl::isValid(), QPdfDocument::load(), qmlContext(), source, sourceChanged(), and QQmlFile::urlToLocalFileOrQrc().

+ Here is the call graph for this function:

◆ source()

QUrl QQuickPdfDocument::source ( ) const
inline

Definition at line 59 of file qquickpdfdocument_p.h.

◆ sourceChanged

void QQuickPdfDocument::sourceChanged ( )
signal

Referenced by QQuickPdfSelection::setDocument(), and setSource().

+ Here is the caller graph for this function:

◆ subject()

QString QQuickPdfDocument::subject ( )
inline

Definition at line 67 of file qquickpdfdocument_p.h.

References QPdfDocument::Subject.

◆ title()

QString QQuickPdfDocument::title ( )
inline

Definition at line 65 of file qquickpdfdocument_p.h.

References QPdfDocument::Title.

Friends And Related Symbol Documentation

◆ QQuickPdfBookmarkModel

friend class QQuickPdfBookmarkModel
friend

Definition at line 94 of file qquickpdfdocument_p.h.

◆ QQuickPdfLinkModel

friend class QQuickPdfLinkModel
friend

Definition at line 95 of file qquickpdfdocument_p.h.

◆ QQuickPdfPageImage

friend class QQuickPdfPageImage
friend

Definition at line 96 of file qquickpdfdocument_p.h.

◆ QQuickPdfSearchModel

friend class QQuickPdfSearchModel
friend

Definition at line 97 of file qquickpdfdocument_p.h.

◆ QQuickPdfSelection

friend class QQuickPdfSelection
friend

Definition at line 98 of file qquickpdfdocument_p.h.

Property Documentation

◆ author

QString QQuickPdfDocument::author
read

Definition at line 42 of file qquickpdfdocument_p.h.

◆ creationDate

QDateTime QQuickPdfDocument::creationDate
read

Definition at line 46 of file qquickpdfdocument_p.h.

◆ creator

QString QQuickPdfDocument::creator
read

Definition at line 45 of file qquickpdfdocument_p.h.

◆ error

QString QQuickPdfDocument::error
read

Definition at line 38 of file qquickpdfdocument_p.h.

◆ keywords

QString QQuickPdfDocument::keywords
read

Definition at line 43 of file qquickpdfdocument_p.h.

◆ maxPageHeight

qreal QQuickPdfDocument::maxPageHeight
read

Definition at line 37 of file qquickpdfdocument_p.h.

◆ maxPageWidth

qreal QQuickPdfDocument::maxPageWidth
read

Definition at line 36 of file qquickpdfdocument_p.h.

◆ modificationDate

QDateTime QQuickPdfDocument::modificationDate
read

Definition at line 47 of file qquickpdfdocument_p.h.

◆ producer

QString QQuickPdfDocument::producer
read

Definition at line 44 of file qquickpdfdocument_p.h.

◆ source

QUrl QQuickPdfDocument::source
readwrite

Definition at line 35 of file qquickpdfdocument_p.h.

Referenced by setSource().

◆ subject

QString QQuickPdfDocument::subject
read

Definition at line 41 of file qquickpdfdocument_p.h.

◆ title

QString QQuickPdfDocument::title
read

Definition at line 40 of file qquickpdfdocument_p.h.


The documentation for this class was generated from the following files: