digiKam
Digikam::IccProfile Class Reference

Public Types

enum  ProfileType {
  InvalidType , Input , Output , Display ,
  Abstract , ColorSpace , DeviceLink , NamedColor
}
 

Public Member Functions

void close ()
 
QByteArray data ()
 
QString description ()
 
QString filePath () const
 
void * handle () const
 
 IccProfile ()
 
 IccProfile (const IccProfile &other)
 
 IccProfile (const QByteArray &data)
 
 IccProfile (const QString &filePath)
 
bool isNull () const
 
bool isOpen () const
 
bool isSameProfileAs (IccProfile &other)
 
bool open ()
 
 operator void * () const
 
bool operator!= (const IccProfile &other) const
 
IccProfileoperator= (const IccProfile &other)
 
bool operator== (const IccProfile &other) const
 
ProfileType type ()
 
bool writeToFile (const QString &filePath)
 
 ~IccProfile ()
 

Static Public Member Functions

static IccProfile adobeRGB ()
 
static void considerOriginalAdobeRGB (const QString &filePath)
 
static QList< IccProfiledefaultProfiles ()
 
static QStringList defaultSearchPaths ()
 
static IccProfile proPhotoRGB ()
 
static QList< IccProfilescanDirectories (const QStringList &dirs)
 
static IccProfile sRGB ()
 
static IccProfile wideGamutRGB ()
 

Member Enumeration Documentation

◆ ProfileType

Enumerator
InvalidType 

Returned for a null profile or an unknown (non-standard) profile type.

Input 

For an input device like a scanner or digital camera.

Output 

For an output device like a printer.

Display 

For a display device like a monitor.

Abstract 
ColorSpace 
DeviceLink 
NamedColor 

Constructor & Destructor Documentation

◆ IccProfile() [1/4]

Digikam::IccProfile::IccProfile ( )

Creates a null profile

Referenced by adobeRGB(), proPhotoRGB(), sRGB(), and wideGamutRGB().

◆ IccProfile() [2/4]

Digikam::IccProfile::IccProfile ( const QByteArray &  data)
explicit

Creates a profile from the given data in memory

References data().

◆ IccProfile() [3/4]

Digikam::IccProfile::IccProfile ( const QString &  filePath)
explicit

Creates a profile from the given file

References filePath().

◆ IccProfile() [4/4]

Digikam::IccProfile::IccProfile ( const IccProfile other)

◆ ~IccProfile()

Digikam::IccProfile::~IccProfile ( )

Member Function Documentation

◆ adobeRGB()

IccProfile Digikam::IccProfile::adobeRGB ( )
static

◆ close()

void Digikam::IccProfile::close ( )

Close the profile, freeing resources. You can re-open. Called automatically at destruction.

Referenced by Digikam::IccSettings::loadAllProfilesProperties().

◆ considerOriginalAdobeRGB()

void Digikam::IccProfile::considerOriginalAdobeRGB ( const QString &  filePath)
static

◆ data()

◆ defaultProfiles()

QList< IccProfile > Digikam::IccProfile::defaultProfiles ( )
static

Returns a list with the profiles above

References adobeRGB(), proPhotoRGB(), sRGB(), and wideGamutRGB().

Referenced by Digikam::IccSettings::allProfiles().

◆ defaultSearchPaths()

QStringList Digikam::IccProfile::defaultSearchPaths ( )
static

Returns the default search paths for ICC profiles. This does not include any user-specified settings.

References Digikam::macOSBundlePrefix(), and QT_SKIP_EMPTY_PARTS.

Referenced by Digikam::IccSettings::allProfiles(), and Digikam::SetupICC::iccRepositoryIsValid().

◆ description()

◆ filePath()

QString Digikam::IccProfile::filePath ( ) const

Returns the filename that this profile was read from. returns a null QString() if this profile was loaded from memory.

Referenced by considerOriginalAdobeRGB(), DigikamBqmIccConvertPlugin::IccConvert::defaultSettings(), IccProfile(), and writeToFile().

◆ handle()

void * Digikam::IccProfile::handle ( ) const

Access to the LCMS cmsHPROFILE handle.

◆ isNull()

◆ isOpen()

bool Digikam::IccProfile::isOpen ( ) const

Returns if the profile is opened.

Referenced by Digikam::IccSettings::loadAllProfilesProperties().

◆ isSameProfileAs()

bool Digikam::IccProfile::isSameProfileAs ( IccProfile other)

◆ open()

bool Digikam::IccProfile::open ( )

Open this profile. Returns true if the operation succeeded or the profile is already open. Returns false if the profile is null or the operation failed. You need to open each profile after construction.

References data(), and dkCmsOpenProfileFromMem().

Referenced by description(), Digikam::IccManager::displayProfile(), Digikam::IccSettings::Private::scanDirectory(), and type().

◆ operator void *()

Digikam::IccProfile::operator void * ( ) const
inline

◆ operator!=()

bool Digikam::IccProfile::operator!= ( const IccProfile other) const
inline

References Digikam::operator==().

◆ operator=()

IccProfile & Digikam::IccProfile::operator= ( const IccProfile other)

◆ operator==()

bool Digikam::IccProfile::operator== ( const IccProfile other) const

Returns true if both profiles are null, if both profiles are created from the same file profile, or if the loaded profile data is identical. Note: This will not ensure that the data is loaded. Use isSameProfile().

◆ proPhotoRGB()

IccProfile Digikam::IccProfile::proPhotoRGB ( )
static

References IccProfile().

Referenced by defaultProfiles().

◆ scanDirectories()

static QList<IccProfile> Digikam::IccProfile::scanDirectories ( const QStringList &  dirs)
static

◆ sRGB()

◆ type()

◆ wideGamutRGB()

IccProfile Digikam::IccProfile::wideGamutRGB ( )
static

References IccProfile().

Referenced by defaultProfiles().

◆ writeToFile()

bool Digikam::IccProfile::writeToFile ( const QString &  filePath)

Writes the profile to the given file.

References data(), and filePath().


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