iccprofile.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2009-08-07
 * Description : a wrapper class for an ICC color profile
 *
 * Copyright (C) 2005-2006 by F.J. Cruz <fj dot cruz at supercable dot es>
 * Copyright (C) 2005-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2009-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_ICC_PROFILE_H
#define DIGIKAM_ICC_PROFILE_H
 
// Qt includes
 
#include <QByteArray>
#include <QMetaType>
#include <QSharedData>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT IccProfile
{
public:
 
    enum ProfileType
    {
        InvalidType,
        Input,
        Output,
        Display,
        Abstract,
        ColorSpace,
        DeviceLink,
        NamedColor
    };
 
public:
 
    IccProfile();
 
    explicit IccProfile(const QByteArray& data);
 
    explicit IccProfile(const QString& filePath);
 
    static IccProfile sRGB();
    static IccProfile adobeRGB();
    static IccProfile wideGamutRGB();
    static IccProfile proPhotoRGB();
 
    static QList<IccProfile> defaultProfiles();
 
    IccProfile(const IccProfile& other);
    ~IccProfile();
 
    IccProfile& operator=(const IccProfile& other);
 
    bool isNull() const;
 
    bool operator==(const IccProfile& other) const;
 
    bool operator!=(const IccProfile& other) const
    {
        return !operator==(other);
    }
 
    bool isSameProfileAs(IccProfile& other);
 
    bool open();
 
    void close();
 
    bool isOpen()       const;
 
    QString filePath()  const;
 
    QString description();
 
    ProfileType type();
 
    QByteArray data();
 
    bool writeToFile(const QString& filePath);
 
    void* handle()      const;
 
    operator void*()    const
    {
        return handle();
    }
 
    static QStringList defaultSearchPaths();
 
    static QList<IccProfile> scanDirectories(const QStringList& dirs);
 
    static void considerOriginalAdobeRGB(const QString& filePath);
 
private:
 
    IccProfile(const char* const location, const QString& relativePath);
 
private:
 
    class Private;
    QSharedDataPointer<Private> d;
};
 
// --------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT LcmsLock
{
public:
 
    explicit LcmsLock();
    ~LcmsLock();
};
 
} // namespace Digikam
 
Q_DECLARE_METATYPE(Digikam::IccProfile)
 
#endif // DIGIKAM_ICC_PROFILE_H