QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Public Member Functions | List of all members
QgsCustomColorScheme Class Reference

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

#include <qgscolorscheme.h>

Inheritance diagram for QgsCustomColorScheme:
Inheritance graph
[legend]

Public Member Functions

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

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...
 

Detailed Description

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

Since
QGIS 2.5

Definition at line 270 of file qgscolorscheme.h.

Constructor & Destructor Documentation

◆ QgsCustomColorScheme()

QgsCustomColorScheme::QgsCustomColorScheme ( )
default

Constructor for QgsCustomColorScheme.

Member Function Documentation

◆ clone()

QgsCustomColorScheme * QgsCustomColorScheme::clone ( ) const
overridevirtual

Clones a color scheme.

Returns
copy of color scheme

Implements QgsColorScheme.

Definition at line 186 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
contextstring 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.
baseColorbase 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 114 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 281 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 286 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 279 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
colorslist of colors for the scheme
contextto set colors for
baseColorbase color to set colors for
Returns
true if colors were set successfully
See also
isEditable

Reimplemented from QgsColorScheme.

Definition at line 163 of file qgscolorscheme.cpp.


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