QgsColorScheme Class Reference

Abstract base class for color schemes. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsColorScheme:

Public Types
enum	SchemeFlag { ShowInColorDialog = 0x01 , ShowInColorButtonMenu = 0x02 , ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu }
	Flags for controlling behavior of color scheme. More...

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

Detailed Description

Abstract base class for color schemes.

A color scheme for display in QgsColorButton. Color schemes return lists of colors with an optional associated color name. The colors returned can be generated using an optional base color.

Since

QGIS 2.5

Definition at line 46 of file qgscolorscheme.h.

Member Enumeration Documentation

SchemeFlag

enum QgsColorScheme::SchemeFlag

Flags for controlling behavior of color scheme.

Enumerator
ShowInColorDialog	Show scheme in color picker dialog.
ShowInColorButtonMenu	Show scheme in color button drop-down menu.
ShowInAllContexts	Show scheme in all contexts.

Definition at line 71 of file qgscolorscheme.h.

Constructor & Destructor Documentation

QgsColorScheme()

QgsColorScheme::QgsColorScheme ( )

default

Constructor for QgsColorScheme.

~QgsColorScheme()

virtual QgsColorScheme::~QgsColorScheme ( )

virtualdefault

Member Function Documentation

clone()

virtual QgsColorScheme* QgsColorScheme::clone ( ) const

pure virtual

Clones a color scheme.

Returns

copy of color scheme

Implemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsRecentColorScheme, QgsUserColorScheme, and QgsPresetSchemeColorRamp.

fetchColors()

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

pure virtual

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

Implemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsRecentColorScheme, QgsGplColorScheme, and QgsPresetSchemeColorRamp.

flags()

virtual SchemeFlags QgsColorScheme::flags ( ) const

inlinevirtual

Returns the current flags for the color scheme.

Returns

current flags

Reimplemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsRecentColorScheme, and QgsUserColorScheme.

Definition at line 96 of file qgscolorscheme.h.

isEditable()

virtual bool QgsColorScheme::isEditable ( ) const

inlinevirtual

Returns whether the color scheme is editable.

Returns

true if scheme is editable

See also

setColors

Reimplemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsUserColorScheme, and QgsPresetSchemeColorRamp.

Definition at line 117 of file qgscolorscheme.h.

schemeName()

virtual QString QgsColorScheme::schemeName ( ) const

pure virtual

Gets the name for the color scheme.

Returns

color scheme name

Implemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsRecentColorScheme, QgsUserColorScheme, and QgsPresetSchemeColorRamp.

setColors()

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

virtual

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 in QgsProjectColorScheme, QgsCustomColorScheme, QgsGplColorScheme, and QgsPresetSchemeColorRamp.

Definition at line 30 of file qgscolorscheme.cpp.

---

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

• /build/qgis-3.22.4+99unstable/src/core/qgscolorscheme.h
• /build/qgis-3.22.4+99unstable/src/core/qgscolorscheme.cpp