QgsCustomColorScheme Class Reference

A color scheme which contains custom colors set through QGIS app options dialog. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsCustomColorScheme:

Public Member Functions
	QgsCustomColorScheme ()=default
QgsCustomColorScheme *	clone () const override
	Clones a color scheme.
QgsNamedColorList	fetchColors (const QString &context=QString(), const QColor &baseColor=QColor()) override
	Gets a list of colors from the scheme.
SchemeFlags	flags () const override
	Returns the current flags for the color scheme.
bool	isEditable () const override
	Returns whether the color scheme is editable.
QString	schemeName () const override
	Gets the name for the color scheme.
bool	setColors (const QgsNamedColorList &colors, const QString &context=QString(), const QColor &baseColor=QColor()) override
	Sets the colors for the scheme.
Public Member Functions inherited from QgsColorScheme
	QgsColorScheme ()=default
virtual	~QgsColorScheme ()=default

Static Public Attributes
static const QgsSettingsEntryVariant *	settingsPaletteColors = new QgsSettingsEntryVariant( u"palette-colors"_s, QgsSettingsTree::sTreeColors, QVariant(), u"User-defined custom color palette (stored as a QVariantList of colors), kept in sync with the associated labels."_s )
static const QgsSettingsEntryVariant *	settingsPaletteLabels = new QgsSettingsEntryVariant( u"palette-labels"_s, QgsSettingsTree::sTreeColors, QVariant(), u"Labels of the user-defined custom color palette entries, kept in sync with the associated colors."_s )

Additional Inherited Members
Public Types inherited from QgsColorScheme
enum	SchemeFlag { ShowInColorDialog = 0x01 , ShowInColorButtonMenu = 0x02 , ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu }
	Flags for controlling behavior of color scheme. More...
typedef QFlags< SchemeFlag >	SchemeFlags

Detailed Description

A color scheme which contains custom colors set through QGIS app options dialog.

Definition at line 252 of file qgscolorscheme.h.

Constructor & Destructor Documentation

QgsCustomColorScheme()

QgsCustomColorScheme::QgsCustomColorScheme ( )

default

Member Function Documentation

clone()

QgsCustomColorScheme * QgsCustomColorScheme::clone ( ) const

overridevirtual

Clones a color scheme.

Returns

copy of color scheme

Implements QgsColorScheme.

Definition at line 196 of file qgscolorscheme.cpp.

fetchColors()

QgsNamedColorList QgsCustomColorScheme::fetchColors ( const QString & context = QString(), const QColor & baseColor = QColor() )

overridevirtual

Gets a list of colors from the scheme.

The colors can optionally be generated using the supplied context and base color.

Parameters

context	string specifying an optional context for the returned colors. For instance, a "recent colors" scheme may filter returned colors by context so that colors used only in a "composer" context are returned.
baseColor	base color for the scheme's colors. Some color schemes may take advantage of this to filter or modify their returned colors to colors related to the base color.

Returns

a list of QPairs of color and color name

Implements QgsColorScheme.

Definition at line 127 of file qgscolorscheme.cpp.

flags()

SchemeFlags QgsCustomColorScheme::flags ( ) const

inlineoverridevirtual

Returns the current flags for the color scheme.

Returns

current flags

Reimplemented from QgsColorScheme.

Definition at line 259 of file qgscolorscheme.h.

isEditable()

bool QgsCustomColorScheme::isEditable ( ) const

inlineoverridevirtual

Returns whether the color scheme is editable.

Returns

true if scheme is editable

See also

setColors

Reimplemented from QgsColorScheme.

Definition at line 263 of file qgscolorscheme.h.

schemeName()

QString QgsCustomColorScheme::schemeName ( ) const

inlineoverridevirtual

Gets the name for the color scheme.

Returns

color scheme name

Implements QgsColorScheme.

Definition at line 257 of file qgscolorscheme.h.

setColors()

bool QgsCustomColorScheme::setColors ( const QgsNamedColorList & colors, const QString & context = QString(), const QColor & baseColor = QColor() )

overridevirtual

Sets the colors for the scheme.

This method is only valid for editable color schemes.

Parameters

colors	list of colors for the scheme
context	to set colors for
baseColor	base color to set colors for

Returns

true if colors were set successfully

See also

isEditable

Reimplemented from QgsColorScheme.

Definition at line 174 of file qgscolorscheme.cpp.

Member Data Documentation

settingsPaletteColors

const QgsSettingsEntryVariant * QgsCustomColorScheme::settingsPaletteColors = new QgsSettingsEntryVariant( u"palette-colors"_s, QgsSettingsTree::sTreeColors, QVariant(), u"User-defined custom color palette (stored as a QVariantList of colors), kept in sync with the associated labels."_s )

static

Definition at line 270 of file qgscolorscheme.h.

settingsPaletteLabels

const QgsSettingsEntryVariant * QgsCustomColorScheme::settingsPaletteLabels = new QgsSettingsEntryVariant( u"palette-labels"_s, QgsSettingsTree::sTreeColors, QVariant(), u"Labels of the user-defined custom color palette entries, kept in sync with the associated colors."_s )

static

Definition at line 271 of file qgscolorscheme.h.

---

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

• /build/qgis-4.1.0+git20260503+376402f9aeb+99sid/src/core/qgscolorscheme.h
• /build/qgis-4.1.0+git20260503+376402f9aeb+99sid/src/core/qgscolorscheme.cpp