\inmodule QtGui More...

#include <qpdfwriter.h>

Inheritance diagram for QPdfWriter:

Collaboration diagram for QPdfWriter:

Public Types
enum class	ColorModel { RGB , Grayscale , CMYK , Auto }
Public Types inherited from QPagedPaintDevice
enum	PdfVersion { PdfVersion_1_4 , PdfVersion_A1b , PdfVersion_1_6 , PdfVersion_X4 }
	The PdfVersion enum describes the version of the PDF file that is produced by QPrinter or QPdfWriter. More...
Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled , PdmDevicePixelRatioF_EncodedA , PdmDevicePixelRatioF_EncodedB }

Public Member Functions
	QPdfWriter (const QString &filename)
	Constructs a PDF writer that will write the pdf to filename.
	QPdfWriter (QIODevice *device)
	Constructs a PDF writer that will write the pdf to device.
	~QPdfWriter ()
	Destroys the pdf writer.
void	setPdfVersion (PdfVersion version)
PdfVersion	pdfVersion () const
QString	title () const
	Returns the title of the document.
void	setTitle (const QString &title)
	Sets the title of the document being created to title.
QString	creator () const
	Returns the creator of the document.
void	setCreator (const QString &creator)
	Sets the creator of the document to creator.
QUuid	documentId () const
void	setDocumentId (QUuid documentId)
QString	author () const
void	setAuthor (const QString &author)
bool	newPage () override
	\reimp
void	setResolution (int resolution)
int	resolution () const
void	setDocumentXmpMetadata (const QByteArray &xmpMetadata)
QByteArray	documentXmpMetadata () const
void	addFileAttachment (const QString &fileName, const QByteArray &data, const QString &mimeType=QString())
ColorModel	colorModel () const
void	setColorModel (ColorModel model)
QPdfOutputIntent	outputIntent () const
void	setOutputIntent (const QPdfOutputIntent &intent)
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	isQmlExposed () const noexcept
	Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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`.
Public Member Functions inherited from QPagedPaintDevice
	~QPagedPaintDevice ()
	Destroys the object.
virtual bool	setPageLayout (const QPageLayout &pageLayout)
virtual bool	setPageSize (const QPageSize &pageSize)
virtual bool	setPageOrientation (QPageLayout::Orientation orientation)
virtual bool	setPageMargins (const QMarginsF &margins, QPageLayout::Unit units=QPageLayout::Millimeter)
QPageLayout	pageLayout () const
virtual void	setPageRanges (const QPageRanges &ranges)
QPageRanges	pageRanges () const
Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()
virtual int	devType () const
bool	paintingActive () const
int	width () const
int	height () const
int	widthMM () const
int	heightMM () const
int	logicalDpiX () const
int	logicalDpiY () const
int	physicalDpiX () const
int	physicalDpiY () const
qreal	devicePixelRatio () const
qreal	devicePixelRatioF () const
int	colorCount () const
int	depth () const

Protected Member Functions
QPaintEngine *	paintEngine () const override
	\reimp
int	metric (PaintDeviceMetric id) const override
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 Member Functions inherited from QPagedPaintDevice
	QPagedPaintDevice (QPagedPaintDevicePrivate *dd)
QPagedPaintDevicePrivate *	dd ()
Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept
virtual void	initPainter (QPainter *painter) const
virtual QPaintDevice *	redirected (QPoint *offset) const
virtual QPainter *	sharedPainter () const
double	getDecodedMetricF (PaintDeviceMetric metricA, PaintDeviceMetric metricB) const

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe
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.
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)
Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()
static int	encodeMetricF (PaintDeviceMetric metric, double value)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr
Protected Attributes inherited from QPagedPaintDevice
QPagedPaintDevicePrivate *	d
Protected Attributes inherited from QPaintDevice
ushort	painters
Properties inherited from QObject
QString	objectName
	the name of this object
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

\inmodule QtGui

The QPdfWriter class is a class to generate PDFs that can be used as a paint device.

QPdfWriter generates PDF out of a series of drawing commands using QPainter. The newPage() method can be used to create several pages.

Definition at line 23 of file qpdfwriter.h.

Member Enumeration Documentation

◆ ColorModel

enum class QPdfWriter::ColorModel

strong

Since: 6.8

This enumeration describes the way in which the PDF engine interprets stroking and filling colors, set as a QPainter's pen or brush (via QPen and QBrush).

\value RGB All colors are converted to RGB and saved as such in the PDF.

\value Grayscale All colors are converted to grayscale. For backwards compatibility, they are emitted in the PDF output as RGB colors, with identical quantities of red, green and blue.

\value CMYK All colors are converted to CMYK and saved as such.

\value Auto RGB colors are emitted as RGB; CMYK colors are emitted as CMYK. Colors of any other color spec are converted to RGB. This is the default since Qt 6.8.

See also: QColor, QGradient

Enumerator
RGB
Grayscale
CMYK
Auto

Definition at line 56 of file qpdfwriter.h.

Constructor & Destructor Documentation

◆ QPdfWriter() [1/2]

QPdfWriter::QPdfWriter ( const QString & filename )

explicit

Constructs a PDF writer that will write the pdf to filename.

Definition at line 100 of file qpdfwriter.cpp.

◆ QPdfWriter() [2/2]

QPdfWriter::QPdfWriter ( QIODevice * device )

explicit

Constructs a PDF writer that will write the pdf to device.

Definition at line 112 of file qpdfwriter.cpp.

◆ ~QPdfWriter()

QPdfWriter::~QPdfWriter ( )

Destroys the pdf writer.

Definition at line 124 of file qpdfwriter.cpp.

Member Function Documentation

◆ addFileAttachment()

void QPdfWriter::addFileAttachment	(	const QString &	fileName,
		const QByteArray &	data,
		const QString &	mimeType = QString() )

Since: 5.15

Adds fileName attachment to the PDF with (optional) mimeType. data contains the raw file data to embed into the PDF file.

Definition at line 315 of file qpdfwriter.cpp.

◆ author()

QString QPdfWriter::author ( ) const

Since: 6.9 Returns the author of the document.

Definition at line 219 of file qpdfwriter.cpp.

◆ colorModel()

QPdfWriter::ColorModel QPdfWriter::colorModel ( ) const

Since: 6.8

Returns the color model used by this PDF writer. The default is QPdfWriter::ColorModel::Auto.

Definition at line 372 of file qpdfwriter.cpp.

◆ creator()

QString QPdfWriter::creator ( ) const

Returns the creator of the document.

Definition at line 179 of file qpdfwriter.cpp.

◆ documentId()

QUuid QPdfWriter::documentId ( ) const

Since: 6.8 Returns the ID of the document. By default, the ID is a randomly generated UUID.

Definition at line 199 of file qpdfwriter.cpp.

◆ documentXmpMetadata()

QByteArray QPdfWriter::documentXmpMetadata ( ) const

Since: 5.15

Gets the document metadata, as it was provided with a call to setDocumentXmpMetadata. It will not return the default metadata.

See also: setDocumentXmpMetadata()

Definition at line 302 of file qpdfwriter.cpp.

◆ metric()

int QPdfWriter::metric ( PaintDeviceMetric id ) const

overrideprotectedvirtual

Returns the metric for the given id.

Reimplemented from QPaintDevice.

Definition at line 326 of file qpdfwriter.cpp.

◆ newPage()

bool QPdfWriter::newPage ( )

overridevirtual

\reimp

Implements QPagedPaintDevice.

Definition at line 335 of file qpdfwriter.cpp.

◆ outputIntent()

QPdfOutputIntent QPdfWriter::outputIntent ( ) const

Since: 6.8

Returns the output intent used by this PDF writer.

Definition at line 394 of file qpdfwriter.cpp.

◆ paintEngine()

QPaintEngine * QPdfWriter::paintEngine ( ) const

overrideprotectedvirtual

\reimp

Implements QPaintDevice.

Definition at line 238 of file qpdfwriter.cpp.

◆ pdfVersion()

QPdfWriter::PdfVersion QPdfWriter::pdfVersion ( ) const

Since: 5.10

Returns the PDF version for this writer. The default is PdfVersion_1_4.

Definition at line 152 of file qpdfwriter.cpp.

◆ resolution()

int QPdfWriter::resolution ( ) const

Since: 5.3

Returns the resolution of the PDF in DPI.

See also: setResolution()

Definition at line 271 of file qpdfwriter.cpp.

◆ setAuthor()

void QPdfWriter::setAuthor ( const QString & author )

Since: 6.9 Sets the author of the document to author.

Definition at line 229 of file qpdfwriter.cpp.

◆ setColorModel()

void QPdfWriter::setColorModel ( ColorModel model )

Since: 6.8

Sets the color model used by this PDF writer to model.

Definition at line 383 of file qpdfwriter.cpp.

◆ setCreator()

void QPdfWriter::setCreator ( const QString & creator )

Sets the creator of the document to creator.

Definition at line 188 of file qpdfwriter.cpp.

◆ setDocumentId()

void QPdfWriter::setDocumentId ( QUuid documentId )

Since: 6.8 Sets the ID of the document to documentId.

Definition at line 209 of file qpdfwriter.cpp.

◆ setDocumentXmpMetadata()

void QPdfWriter::setDocumentXmpMetadata ( const QByteArray & xmpMetadata )

Since: 5.15

Sets the document metadata. This metadata is not influenced by the setTitle / setCreator methods, so is up to the user to keep it consistent. xmpMetadata contains XML formatted metadata to embed into the PDF file.

See also: documentXmpMetadata()

Definition at line 287 of file qpdfwriter.cpp.

◆ setOutputIntent()

void QPdfWriter::setOutputIntent ( const QPdfOutputIntent & intent )

Since: 6.8

Sets the output intent used by this PDF writer to intent.

Definition at line 405 of file qpdfwriter.cpp.

◆ setPdfVersion()

void QPdfWriter::setPdfVersion ( PdfVersion version )

Since: 5.10

Sets the PDF version for this writer to version.

If version is the same value as currently set then no change will be made.

Definition at line 136 of file qpdfwriter.cpp.

◆ setResolution()

void QPdfWriter::setResolution ( int resolution )

Since: 5.3

Sets the PDF resolution in DPI.

This setting affects the coordinate system as returned by, for example QPainter::viewport().

See also: resolution()

Definition at line 256 of file qpdfwriter.cpp.

◆ setTitle()

void QPdfWriter::setTitle ( const QString & title )

Sets the title of the document being created to title.

Definition at line 170 of file qpdfwriter.cpp.

◆ title()

QString QPdfWriter::title ( ) const

Returns the title of the document.

Definition at line 161 of file qpdfwriter.cpp.

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

qtbase/src/gui/painting/qpdfwriter.h (512d35198b726413c151533c8291c6b4b52f0a1d)
qtbase/src/gui/painting/qpdfwriter.cpp (512d35198b726413c151533c8291c6b4b52f0a1d)

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members