The QPdfPageRenderer class encapsulates the rendering of pages of a PDF document. More...

#include <qpdfpagerenderer.h>

Inheritance diagram for QPdfPageRenderer:

Collaboration diagram for QPdfPageRenderer:

Public Types
enum class	RenderMode { MultiThreaded , SingleThreaded }
	This enum describes how the pages are rendered. More...

Signals
void	documentChanged (QPdfDocument *document)

void	renderModeChanged (QPdfPageRenderer::RenderMode renderMode)

void	pageRendered (int pageNumber, QSize imageSize, const QImage &image, QPdfDocumentRenderOptions options, quint64 requestId)

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
	QPdfPageRenderer ()

	QPdfPageRenderer (QObject *parent)
	Constructs a page renderer object with parent object parent.

	~QPdfPageRenderer () override
	Destroys the page renderer object.

RenderMode	renderMode () const
	Returns the mode of how the pages are rendered.

void	setRenderMode (RenderMode mode)
	Sets the mode of how the pages are rendered to mode.

QPdfDocument *	document () const
	Returns the document this objects renders the pages from, or a `nullptr` if none has been set before.

void	setDocument (QPdfDocument *document)
	Sets the document this object renders the pages from.

quint64	requestPage (int pageNumber, QSize imageSize, QPdfDocumentRenderOptions options=QPdfDocumentRenderOptions())
	Requests the renderer to render the page pageNumber into a QImage of size imageSize according to the provided options.

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< QString >	bindableObjectName ()

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

QThread *	thread () 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 >
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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () 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`.

Properties
QPdfDocument *	document
	The document instance this object renders the pages from.

RenderMode	renderMode
	The mode the renderer uses to render the pages.

Properties inherited from QObject
QString	objectName
	the name of this object

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
QObject *	sender () 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< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QPdfPageRenderer class encapsulates the rendering of pages of a PDF document.

Since: 5.11 \inmodule QtPdf

The QPdfPageRenderer contains a queue that collects all render requests that are invoked through requestPage(). Depending on the configured RenderMode the QPdfPageRenderer processes this queue in the main UI thread on next event loop invocation (RenderMode::SingleThreaded) or in a separate worker thread (RenderMode::MultiThreaded) and emits the result through the pageRendered() signal for each request once the rendering is done.

See also: QPdfDocument

Definition at line 19 of file qpdfpagerenderer.h.

Member Enumeration Documentation

◆ RenderMode

enum class QPdfPageRenderer::RenderMode

strong

This enum describes how the pages are rendered.

\value MultiThreaded All pages are rendered in a separate worker thread. \value SingleThreaded All pages are rendered in the main UI thread (default).

See also: renderMode(), setRenderMode()

Enumerator
MultiThreaded
SingleThreaded

Definition at line 27 of file qpdfpagerenderer.h.

Constructor & Destructor Documentation

◆ QPdfPageRenderer() [1/2]

QPdfPageRenderer::QPdfPageRenderer ( )

inline

Definition at line 34 of file qpdfpagerenderer.h.

◆ QPdfPageRenderer() [2/2]

QPdfPageRenderer::QPdfPageRenderer ( QObject * parent )

explicit

Constructs a page renderer object with parent object parent.

Definition at line 155 of file qpdfpagerenderer.cpp.

References QObject::connect(), QScopedPointer< T, Cleanup >::data(), QPdfPageRendererPrivate::m_renderWorker, page, RenderWorker::pageRendered(), and requestId.

Here is the call graph for this function:

◆ ~QPdfPageRenderer()

QPdfPageRenderer::~QPdfPageRenderer ( )

override

Destroys the page renderer object.

Definition at line 172 of file qpdfpagerenderer.cpp.

Member Function Documentation

◆ document()

QPdfDocument * QPdfPageRenderer::document ( ) const

Returns the document this objects renders the pages from, or a nullptr if none has been set before.

See also: QPdfDocument

Definition at line 249 of file qpdfpagerenderer.cpp.

References QPdfPageRendererPrivate::m_document.

◆ documentChanged

void QPdfPageRenderer::documentChanged ( QPdfDocument * document )

signal

Referenced by setDocument().

Here is the caller graph for this function:

◆ pageRendered

void QPdfPageRenderer::pageRendered	(	int	pageNumber,
		QSize	imageSize,
		const QImage &	image,
		QPdfDocumentRenderOptions	options,
		quint64	requestId )

signal

◆ renderMode()

QPdfPageRenderer::RenderMode QPdfPageRenderer::renderMode ( ) const

Returns the mode of how the pages are rendered.

See also: RenderMode

Definition at line 201 of file qpdfpagerenderer.cpp.

References QPdfPageRendererPrivate::m_renderMode.

◆ renderModeChanged

void QPdfPageRenderer::renderModeChanged ( QPdfPageRenderer::RenderMode renderMode )

signal

Referenced by setRenderMode().

Here is the caller graph for this function:

◆ requestPage()

quint64 QPdfPageRenderer::requestPage	(	int	pageNumber,
		QSize	imageSize,
		QPdfDocumentRenderOptions	options = QPdfDocumentRenderOptions() )

Requests the renderer to render the page pageNumber into a QImage of size imageSize according to the provided options.

Once the rendering is done the pageRendered() signal is emitted with the result as parameters.

The return value is an ID that uniquely identifies the render request. If a request with the same parameters is still in the queue, the ID of that queued request is returned.

Definition at line 279 of file qpdfpagerenderer.cpp.

References QPdfPageRendererPrivate::handleNextRequest(), QPdfPageRendererPrivate::m_document, QPdfPageRendererPrivate::m_pendingRequests, QPdfPageRendererPrivate::m_requestIdCounter, QPdfPageRendererPrivate::m_requests, QPdfDocument::Ready, request, and QPdfDocument::status.

Here is the call graph for this function:

◆ setDocument()

void QPdfPageRenderer::setDocument ( QPdfDocument * document )

Sets the document this object renders the pages from.

See also: QPdfDocument

Definition at line 259 of file qpdfpagerenderer.cpp.

References document, documentChanged(), emit, QPdfPageRendererPrivate::m_document, QPdfPageRendererPrivate::m_renderWorker, and RenderWorker::setDocument().

Here is the call graph for this function:

◆ setRenderMode()

void QPdfPageRenderer::setRenderMode ( RenderMode mode )

Sets the mode of how the pages are rendered to mode.

See also: RenderMode

Definition at line 211 of file qpdfpagerenderer.cpp.

References emit, QPdfPageRendererPrivate::m_renderMode, QPdfPageRendererPrivate::m_renderThread, QPdfPageRendererPrivate::m_renderWorker, QObject::moveToThread(), MultiThreaded, QThread::quit(), renderModeChanged(), QThread::start(), QObject::thread(), and QThread::wait().

Here is the call graph for this function:

Property Documentation

◆ document

QPdfPageRenderer::document

readwrite

The document instance this object renders the pages from.

By default, this property is nullptr.

See also: document(), setDocument(), QPdfDocument

Definition at line 23 of file qpdfpagerenderer.h.

Referenced by setDocument().

◆ renderMode

QPdfPageRenderer::renderMode

readwrite

The mode the renderer uses to render the pages.

By default, this property is RenderMode::SingleThreaded.

See also: setRenderMode(), RenderMode

Definition at line 24 of file qpdfpagerenderer.h.

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

qtwebengine/src/pdf/qpdfpagerenderer.h (9b9d789fcb8f63a8998f1eefe44f2a1c8156c362)
qtwebengine/src/pdf/qpdfpagerenderer.cpp (1052aaed63bab5f7c10346c097f95793343df5d5)

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ RenderMode

Constructor & Destructor Documentation

◆ QPdfPageRenderer() [1/2]

◆ QPdfPageRenderer() [2/2]

◆ ~QPdfPageRenderer()

Member Function Documentation

◆ document()

◆ documentChanged

◆ pageRendered

◆ renderMode()

◆ renderModeChanged

◆ requestPage()

◆ setDocument()

◆ setRenderMode()

Property Documentation

◆ document

◆ renderMode