421 lines
11 KiB
C++
421 lines
11 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2015 The Qt Company Ltd.
|
|
** Contact: http://www.qt.io/licensing/
|
|
**
|
|
** This file is part of the QtGui module of the Qt Toolkit.
|
|
**
|
|
** $QT_BEGIN_LICENSE:LGPL21$
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
|
** and conditions see http://www.qt.io/terms-conditions. For further
|
|
** information use the contact form at http://www.qt.io/contact-us.
|
|
**
|
|
** GNU Lesser General Public License Usage
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
|
** General Public License version 2.1 or version 3 as published by the Free
|
|
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
|
|
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
|
|
** following information to ensure the GNU Lesser General Public License
|
|
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
|
|
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|
**
|
|
** As a special exception, The Qt Company gives you certain additional
|
|
** rights. These rights are described in The Qt Company LGPL Exception
|
|
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|
**
|
|
** $QT_END_LICENSE$
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include <qpdfwriter.h>
|
|
|
|
#ifndef QT_NO_PDF
|
|
|
|
#include "qpagedpaintdevice_p.h"
|
|
#include <QtCore/private/qobject_p.h>
|
|
#include "private/qpdf_p.h"
|
|
#include <QtCore/qfile.h>
|
|
|
|
QT_BEGIN_NAMESPACE
|
|
|
|
class QPdfWriterPrivate : public QObjectPrivate
|
|
{
|
|
public:
|
|
QPdfWriterPrivate()
|
|
: QObjectPrivate()
|
|
{
|
|
engine = new QPdfEngine();
|
|
output = 0;
|
|
}
|
|
~QPdfWriterPrivate()
|
|
{
|
|
delete engine;
|
|
delete output;
|
|
}
|
|
|
|
QPdfEngine *engine;
|
|
QFile *output;
|
|
};
|
|
|
|
class QPdfPagedPaintDevicePrivate : public QPagedPaintDevicePrivate
|
|
{
|
|
public:
|
|
QPdfPagedPaintDevicePrivate(QPdfWriterPrivate *d)
|
|
: QPagedPaintDevicePrivate(), pd(d)
|
|
{}
|
|
|
|
virtual ~QPdfPagedPaintDevicePrivate()
|
|
{}
|
|
|
|
bool setPageLayout(const QPageLayout &newPageLayout) Q_DECL_OVERRIDE
|
|
{
|
|
// Try to set the paint engine page layout
|
|
pd->engine->setPageLayout(newPageLayout);
|
|
// Set QPagedPaintDevice layout to match the current paint engine layout
|
|
m_pageLayout = pd->engine->pageLayout();
|
|
return m_pageLayout.isEquivalentTo(newPageLayout);
|
|
}
|
|
|
|
bool setPageSize(const QPageSize &pageSize) Q_DECL_OVERRIDE
|
|
{
|
|
// Try to set the paint engine page size
|
|
pd->engine->setPageSize(pageSize);
|
|
// Set QPagedPaintDevice layout to match the current paint engine layout
|
|
m_pageLayout = pd->engine->pageLayout();
|
|
return m_pageLayout.pageSize().isEquivalentTo(pageSize);
|
|
}
|
|
|
|
bool setPageOrientation(QPageLayout::Orientation orientation) Q_DECL_OVERRIDE
|
|
{
|
|
// Set the print engine value
|
|
pd->engine->setPageOrientation(orientation);
|
|
// Set QPagedPaintDevice layout to match the current paint engine layout
|
|
m_pageLayout = pd->engine->pageLayout();
|
|
return m_pageLayout.orientation() == orientation;
|
|
}
|
|
|
|
bool setPageMargins(const QMarginsF &margins) Q_DECL_OVERRIDE
|
|
{
|
|
return setPageMargins(margins, pageLayout().units());
|
|
}
|
|
|
|
bool setPageMargins(const QMarginsF &margins, QPageLayout::Unit units) Q_DECL_OVERRIDE
|
|
{
|
|
// Try to set engine margins
|
|
pd->engine->setPageMargins(margins, units);
|
|
// Set QPagedPaintDevice layout to match the current paint engine layout
|
|
m_pageLayout = pd->engine->pageLayout();
|
|
return m_pageLayout.margins() == margins && m_pageLayout.units() == units;
|
|
}
|
|
|
|
QPageLayout pageLayout() const Q_DECL_OVERRIDE
|
|
{
|
|
return pd->engine->pageLayout();
|
|
}
|
|
|
|
QPdfWriterPrivate *pd;
|
|
};
|
|
|
|
/*! \class QPdfWriter
|
|
\inmodule QtGui
|
|
|
|
\brief The QPdfWriter class is a class to generate PDFs
|
|
that can be used as a paint device.
|
|
|
|
\ingroup painting
|
|
|
|
QPdfWriter generates PDF out of a series of drawing commands using QPainter.
|
|
The newPage() method can be used to create several pages.
|
|
*/
|
|
|
|
/*!
|
|
Constructs a PDF writer that will write the pdf to \a filename.
|
|
*/
|
|
QPdfWriter::QPdfWriter(const QString &filename)
|
|
: QObject(*new QPdfWriterPrivate),
|
|
QPagedPaintDevice(new QPdfPagedPaintDevicePrivate(d_func()))
|
|
{
|
|
Q_D(QPdfWriter);
|
|
|
|
d->engine->setOutputFilename(filename);
|
|
|
|
// Set QPagedPaintDevice layout to match the current paint engine layout
|
|
devicePageLayout() = d->engine->pageLayout();
|
|
}
|
|
|
|
/*!
|
|
Constructs a PDF writer that will write the pdf to \a device.
|
|
*/
|
|
QPdfWriter::QPdfWriter(QIODevice *device)
|
|
: QObject(*new QPdfWriterPrivate),
|
|
QPagedPaintDevice(new QPdfPagedPaintDevicePrivate(d_func()))
|
|
{
|
|
Q_D(QPdfWriter);
|
|
|
|
d->engine->d_func()->outDevice = device;
|
|
|
|
// Set QPagedPaintDevice layout to match the current paint engine layout
|
|
devicePageLayout() = d->engine->pageLayout();
|
|
}
|
|
|
|
/*!
|
|
Destroys the pdf writer.
|
|
*/
|
|
QPdfWriter::~QPdfWriter()
|
|
{
|
|
|
|
}
|
|
|
|
/*!
|
|
Returns the title of the document.
|
|
*/
|
|
QString QPdfWriter::title() const
|
|
{
|
|
Q_D(const QPdfWriter);
|
|
return d->engine->d_func()->title;
|
|
}
|
|
|
|
/*!
|
|
Sets the title of the document being created to \a title.
|
|
*/
|
|
void QPdfWriter::setTitle(const QString &title)
|
|
{
|
|
Q_D(QPdfWriter);
|
|
d->engine->d_func()->title = title;
|
|
}
|
|
|
|
/*!
|
|
Returns the creator of the document.
|
|
*/
|
|
QString QPdfWriter::creator() const
|
|
{
|
|
Q_D(const QPdfWriter);
|
|
return d->engine->d_func()->creator;
|
|
}
|
|
|
|
/*!
|
|
Sets the creator of the document to \a creator.
|
|
*/
|
|
void QPdfWriter::setCreator(const QString &creator)
|
|
{
|
|
Q_D(QPdfWriter);
|
|
d->engine->d_func()->creator = creator;
|
|
}
|
|
|
|
/*!
|
|
\reimp
|
|
*/
|
|
QPaintEngine *QPdfWriter::paintEngine() const
|
|
{
|
|
Q_D(const QPdfWriter);
|
|
|
|
return d->engine;
|
|
}
|
|
|
|
/*!
|
|
\since 5.3
|
|
|
|
Sets the PDF \a resolution in DPI.
|
|
|
|
This setting affects the coordinate system as returned by, for
|
|
example QPainter::viewport().
|
|
|
|
\sa resolution()
|
|
*/
|
|
|
|
void QPdfWriter::setResolution(int resolution)
|
|
{
|
|
Q_D(const QPdfWriter);
|
|
if (resolution > 0)
|
|
d->engine->setResolution(resolution);
|
|
}
|
|
|
|
/*!
|
|
\since 5.3
|
|
|
|
Returns the resolution of the PDF in DPI.
|
|
|
|
\sa setResolution()
|
|
*/
|
|
|
|
int QPdfWriter::resolution() const
|
|
{
|
|
Q_D(const QPdfWriter);
|
|
return d->engine->resolution();
|
|
}
|
|
|
|
// Defined in QPagedPaintDevice but non-virtual, add QPdfWriter specific doc here
|
|
#ifdef Q_QDOC
|
|
/*!
|
|
\fn bool QPdfWriter::setPageLayout(const QPageLayout &newPageLayout)
|
|
\since 5.3
|
|
|
|
Sets the PDF page layout to \a newPageLayout.
|
|
|
|
You should call this before calling QPainter::begin(), or immediately
|
|
before calling newPage() to apply the new page layout to a new page.
|
|
You should not call any painting methods between a call to setPageLayout()
|
|
and newPage() as the wrong paint metrics may be used.
|
|
|
|
Returns true if the page layout was successfully set to \a newPageLayout.
|
|
|
|
\sa pageLayout()
|
|
*/
|
|
|
|
/*!
|
|
\fn bool QPdfWriter::setPageSize(const QPageSize &pageSize)
|
|
\since 5.3
|
|
|
|
Sets the PDF page size to \a pageSize.
|
|
|
|
To get the current QPageSize use pageLayout().pageSize().
|
|
|
|
You should call this before calling QPainter::begin(), or immediately
|
|
before calling newPage() to apply the new page size to a new page.
|
|
You should not call any painting methods between a call to setPageSize()
|
|
and newPage() as the wrong paint metrics may be used.
|
|
|
|
Returns true if the page size was successfully set to \a pageSize.
|
|
|
|
\sa pageLayout()
|
|
*/
|
|
|
|
/*!
|
|
\fn bool QPdfWriter::setPageOrientation(QPageLayout::Orientation orientation)
|
|
\since 5.3
|
|
|
|
Sets the PDF page \a orientation.
|
|
|
|
The page orientation is used to define the orientation of the
|
|
page size when obtaining the page rect.
|
|
|
|
You should call this before calling QPainter::begin(), or immediately
|
|
before calling newPage() to apply the new orientation to a new page.
|
|
You should not call any painting methods between a call to setPageOrientation()
|
|
and newPage() as the wrong paint metrics may be used.
|
|
|
|
To get the current QPageLayout::Orientation use pageLayout().pageOrientation().
|
|
|
|
Returns true if the page orientation was successfully set to \a orientation.
|
|
|
|
\sa pageLayout()
|
|
*/
|
|
|
|
/*!
|
|
\fn bool QPdfWriter::setPageMargins(const QMarginsF &margins)
|
|
\since 5.3
|
|
|
|
Set the PDF page \a margins in the current page layout units.
|
|
|
|
You should call this before calling QPainter::begin(), or immediately
|
|
before calling newPage() to apply the new margins to a new page.
|
|
You should not call any painting methods between a call to setPageMargins()
|
|
and newPage() as the wrong paint metrics may be used.
|
|
|
|
To get the current page margins use pageLayout().pageMargins().
|
|
|
|
Returns true if the page margins were successfully set to \a margins.
|
|
|
|
\sa pageLayout()
|
|
*/
|
|
|
|
/*!
|
|
\fn bool QPdfWriter::setPageMargins(const QMarginsF &margins, QPageLayout::Unit units)
|
|
\since 5.3
|
|
|
|
Set the PDF page \a margins defined in the given \a units.
|
|
|
|
You should call this before calling QPainter::begin(), or immediately
|
|
before calling newPage() to apply the new margins to a new page.
|
|
You should not call any painting methods between a call to setPageMargins()
|
|
and newPage() as the wrong paint metrics may be used.
|
|
|
|
To get the current page margins use pageLayout().pageMargins().
|
|
|
|
Returns true if the page margins were successfully set to \a margins.
|
|
|
|
\sa pageLayout()
|
|
*/
|
|
|
|
/*!
|
|
\fn QPageLayout QPdfWriter::pageLayout() const
|
|
\since 5.3
|
|
|
|
Returns the current page layout. Use this method to access the current
|
|
QPageSize, QPageLayout::Orientation, QMarginsF, fullRect() and paintRect().
|
|
|
|
Note that you cannot use the setters on the returned object, you must either
|
|
call the individual QPdfWriter methods or use setPageLayout().
|
|
|
|
\sa setPageLayout(), setPageSize(), setPageOrientation(), setPageMargins()
|
|
*/
|
|
#endif
|
|
|
|
/*!
|
|
\reimp
|
|
|
|
\obsolete Use setPageSize(QPageSize(id)) instead
|
|
|
|
\sa setPageSize()
|
|
*/
|
|
|
|
void QPdfWriter::setPageSize(PageSize size)
|
|
{
|
|
setPageSize(QPageSize(QPageSize::PageSizeId(size)));
|
|
}
|
|
|
|
/*!
|
|
\reimp
|
|
|
|
\obsolete Use setPageSize(QPageSize(size, QPageSize::Millimeter)) instead
|
|
|
|
\sa setPageSize()
|
|
*/
|
|
|
|
void QPdfWriter::setPageSizeMM(const QSizeF &size)
|
|
{
|
|
setPageSize(QPageSize(size, QPageSize::Millimeter));
|
|
}
|
|
|
|
/*!
|
|
\internal
|
|
|
|
Returns the metric for the given \a id.
|
|
*/
|
|
int QPdfWriter::metric(PaintDeviceMetric id) const
|
|
{
|
|
Q_D(const QPdfWriter);
|
|
return d->engine->metric(id);
|
|
}
|
|
|
|
/*!
|
|
\reimp
|
|
*/
|
|
bool QPdfWriter::newPage()
|
|
{
|
|
Q_D(QPdfWriter);
|
|
|
|
return d->engine->newPage();
|
|
}
|
|
|
|
|
|
/*!
|
|
\reimp
|
|
|
|
\obsolete Use setPageMargins(QMarginsF(l, t, r, b), QPageLayout::Millimeter) instead
|
|
|
|
\sa setPageMargins()
|
|
*/
|
|
void QPdfWriter::setMargins(const Margins &m)
|
|
{
|
|
setPageMargins(QMarginsF(m.left, m.top, m.right, m.bottom), QPageLayout::Millimeter);
|
|
}
|
|
|
|
QT_END_NAMESPACE
|
|
|
|
#endif // QT_NO_PDF
|