QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
qgscolorutils.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgscolorutils.h
3
---------------------------
4
begin : July 2022
5
copyright : (C) 2022 by Nyall Dawson
6
email : nyall dot dawson at gmail dot com
7
***************************************************************************/
8
9
/***************************************************************************
10
* *
11
* This program is free software; you can redistribute it and/or modify *
12
* it under the terms of the GNU General Public License as published by *
13
* the Free Software Foundation; either version 2 of the License, or *
14
* (at your option) any later version. *
15
* *
16
***************************************************************************/
17
18
#ifndef QGSCOLORUTILS_H
19
#define QGSCOLORUTILS_H
20
21
#include "
qgis.h
"
22
#include "qgis_core.h"
23
#include "
qgis_sip.h
"
24
25
#include <QColorSpace>
26
#include <QDomDocument>
27
#include <QDomElement>
28
29
class
QgsReadWriteContext
;
30
37
class
CORE_EXPORT
QgsColorUtils
38
{
39
public
:
54
static
void
writeXml
(
const
QColor &color,
const
QString &identifier, QDomDocument &document, QDomElement &element,
const
QgsReadWriteContext
&context );
55
68
static
QColor
readXml
(
const
QDomElement &element,
const
QString &identifier,
const
QgsReadWriteContext
&context );
69
80
static
QString
colorToString
(
const
QColor &color );
81
94
static
QColor
colorFromString
(
const
QString &
string
);
95
107
static
QColorSpace
iccProfile
(
const
QString &iccProfileFilePath, QString &errorMsg
SIP_OUT
);
108
115
static
QString
saveIccProfile
(
const
QColorSpace &colorSpace,
const
QString &iccProfileFilePath );
116
117
118
#if QT_VERSION >= QT_VERSION_CHECK( 6, 8, 0 )
119
127
static
Qgis::ColorModel
toColorModel
( QColorSpace::ColorModel colorModel,
bool
*ok =
nullptr
)
SIP_SKIP
;
128
129
#endif
130
};
131
132
#endif
// QGSCOLORUTILS_H
Qgis::ColorModel
ColorModel
Color model types.
Definition
qgis.h:6883
QgsColorUtils
Contains utility functions for working with colors.
Definition
qgscolorutils.h:38
QgsColorUtils::readXml
static QColor readXml(const QDomElement &element, const QString &identifier, const QgsReadWriteContext &context)
Reads a color from an XML element, matching the specified identifier string.
Definition
qgscolorutils.cpp:123
QgsColorUtils::writeXml
static void writeXml(const QColor &color, const QString &identifier, QDomDocument &document, QDomElement &element, const QgsReadWriteContext &context)
Writes a color to an XML element, storing it under the specified identifier.
Definition
qgscolorutils.cpp:30
QgsColorUtils::toColorModel
static Qgis::ColorModel toColorModel(QColorSpace::ColorModel colorModel, bool *ok=nullptr)
Convert and returns Qt colorModel to Qgis::ColorModel.
Definition
qgscolorutils.cpp:341
QgsColorUtils::colorFromString
static QColor colorFromString(const QString &string)
Decodes a string into a color value.
Definition
qgscolorutils.cpp:239
QgsColorUtils::colorToString
static QString colorToString(const QColor &color)
Encodes a color into a string value.
Definition
qgscolorutils.cpp:174
QgsColorUtils::iccProfile
static QColorSpace iccProfile(const QString &iccProfileFilePath, QString &errorMsg)
Loads an ICC profile from iccProfileFilePath and returns associated color space.
Definition
qgscolorutils.cpp:301
QgsColorUtils::saveIccProfile
static QString saveIccProfile(const QColorSpace &colorSpace, const QString &iccProfileFilePath)
Save color space colorSpace to an ICC profile file iccProfileFilePath.
Definition
qgscolorutils.cpp:324
QgsReadWriteContext
A container for the context for various read/write operations on objects.
Definition
qgsreadwritecontext.h:38
qgis.h
qgis_sip.h
SIP_SKIP
#define SIP_SKIP
Definition
qgis_sip.h:138
SIP_OUT
#define SIP_OUT
Definition
qgis_sip.h:57
Generated on
for QGIS API Documentation by
1.17.0