qpdfoutputintent.cpp

Go to the documentation of this file.

// Copyright (C) 2024 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#include "qpdfoutputintent.h"
 
#ifndef QT_NO_PDF
 
#include <QtCore/qfile.h>
#include <QtCore/qshareddata.h>
#include <QtCore/qstring.h>
#include <QtCore/qurl.h>
 
#include <QtGui/qcolorspace.h>
 
QT_BEGIN_NAMESPACE
 
using namespace Qt::StringLiterals;
 
class QPdfOutputIntentPrivate : public QSharedData
{
public:
    QPdfOutputIntentPrivate()
    {
        QFile colorProfileFile(QStringLiteral(":/qpdf/sRGB2014.icc"));
        bool ok = colorProfileFile.open(QIODevice::ReadOnly);
        Q_ASSERT(ok);
        outputProfile = QColorSpace::fromIccProfile(colorProfileFile.readAll());
    }
 
    QString outputConditionIdentifier = QStringLiteral("sRGB_IEC61966-2-1_black_scaled");
    QString outputCondition = QStringLiteral("sRGB IEC61966 v2.1 with black scaling");
    QUrl registryName = QUrl{u"http://www.color.org"_s};
    QColorSpace outputProfile;
};
 
/*!
    \class QPdfOutputIntent
    \inmodule QtGui
    \ingroup painting
    \since 6.8
 
    The QPdfOutputIntent class contains metadata that characterize
    the printing condition for which painting data has been prepared
    when generating a PDF file.
 
    \sa QPdfWriter
*/
 
/*!
    Constructs a new PDF output intent.
*/
QPdfOutputIntent::QPdfOutputIntent()
    : d(new QPdfOutputIntentPrivate)
{}
 
/*!
    Constructs a copy of the output intent \a other.
*/
QPdfOutputIntent::QPdfOutputIntent(const QPdfOutputIntent &other) = default;
 
/*!
    \fn QPdfOutputIntent::QPdfOutputIntent(QPdfOutputIntent &&other) noexcept
 
    Constructs a QPdfOutputIntent object by moving from \a other.
*/
 
/*!
    Assigns the output intent \a other over this intent.
*/
QPdfOutputIntent &QPdfOutputIntent::operator=(const QPdfOutputIntent &other) = default;
 
/*!
    \fn QPdfOutputIntent &QPdfOutputIntent::operator=(QPdfOutputIntent &&other) noexcept
 
    Move-assigns the output intent \a other over this intent.
*/
 
/*!
    Destroys this output intent.
*/
QPdfOutputIntent::~QPdfOutputIntent() = default;
 
/*!
    \fn void QPdfOutputIntent::swap(QPdfOutputIntent &other) noexcept
    \memberswap{output intent}
*/
 
/*!
    Returns the identifier of the output condition.
 
    If a registry name is provided, then this identifier should should
    match the reference name of an entry in that registry.
 
    The default identifier is \c{sRGB_IEC61966-2-1_black_scaled}.
 
    \sa setOutputConditionIdentifier()
*/
QString QPdfOutputIntent::outputConditionIdentifier() const
{
    return d->outputConditionIdentifier;
}
 
/*!
    Sets the identifier of the output condition to \a identifier.
 
    If a registry name is provided, then this identifier should should
    match the reference name of an entry in that registry.
 
    \sa setOutputCondition(), setRegistryName()
*/
void QPdfOutputIntent::setOutputConditionIdentifier(const QString &identifier)
{
    d.detach();
    d->outputConditionIdentifier = identifier;
}
 
/*!
    Returns the human-readable output condition.
 
    This is a string that concisely identifies the characterized
    printing condition in a form that will be meaningful to a
    human operator.
 
    The default output condition is
    \c{sRGB IEC61966 v2.1 with black scaling}.
 
    \sa setOutputCondition()
*/
QString QPdfOutputIntent::outputCondition() const
{
    return d->outputCondition;
}
 
/*!
    Sets the human-readable output condition to \a condition.
 
    \sa setOutputConditionIdentifier(), setRegistryName()
*/
void QPdfOutputIntent::setOutputCondition(const QString &condition)
{
    d.detach();
    d->outputCondition = condition;
}
 
/*!
    Returns the URL of a characterization registry for the intended
    printing condition.
 
    The default registry is \c{http://www.color.org}.
 
    \sa setOutputConditionIdentifier()
*/
QUrl QPdfOutputIntent::registryName() const
{
    return d->registryName;
}
 
/*!
    Sets the URL of the characterization registry to \a name.
 
    \sa setOutputConditionIdentifier()
*/
void QPdfOutputIntent::setRegistryName(const QUrl &name)
{
    d.detach();
    d->registryName = name;
}
 
/*!
    Returns the output device profile.
 
    The default profile is the sRGB v2 profile available
    from the
    \l{https://www.color.org/srgbprofiles.xalter#v2}{International
    Color Consortium}.
*/
QColorSpace QPdfOutputIntent::outputProfile() const
{
    return d->outputProfile;
}
 
/*!
    Sets the output device profile to \a profile.
 
    \note PDF/X-4 requires all the color specifications in the
    document to match the same colorspace of \a profile. It is
    the application's responsibility to ensure this is the case.
 
    \sa QColorSpace::fromIccProfile, QPdfWriter::setColorModel
*/
void QPdfOutputIntent::setOutputProfile(const QColorSpace &profile)
{
    d.detach();
    d->outputProfile = profile;
}
 
QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QPdfOutputIntentPrivate)
 
QT_END_NAMESPACE
 
#endif // QT_NO_PDF