QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
A color scheme which contains custom colors set through QGIS app options dialog. More...
#include <qgscolorscheme.h>
Public Member Functions | |
QgsCustomColorScheme ()=default | |
Constructor for QgsCustomColorScheme. More... | |
QgsCustomColorScheme * | clone () 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... | |
![]() | |
QgsColorScheme ()=default | |
Constructor for QgsColorScheme. More... | |
virtual | ~QgsColorScheme ()=default |
Additional Inherited Members | |
![]() | |
enum | SchemeFlag { ShowInColorDialog = 0x01, ShowInColorButtonMenu = 0x02, ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu } |
Flags for controlling behavior of color scheme. More... | |
A color scheme which contains custom colors set through QGIS app options dialog.
Definition at line 270 of file qgscolorscheme.h.
|
default |
Constructor for QgsCustomColorScheme.
|
overridevirtual |
Clones a color scheme.
Implements QgsColorScheme.
Definition at line 186 of file qgscolorscheme.cpp.
|
overridevirtual |
Gets a list of colors from the scheme.
The colors can optionally be generated using the supplied context and base color.
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. |
Implements QgsColorScheme.
Definition at line 114 of file qgscolorscheme.cpp.
|
inlineoverridevirtual |
Returns the current flags for the color scheme.
Reimplemented from QgsColorScheme.
Definition at line 281 of file qgscolorscheme.h.
|
inlineoverridevirtual |
Returns whether the color scheme is editable.
true
if scheme is editable Reimplemented from QgsColorScheme.
Definition at line 286 of file qgscolorscheme.h.
|
inlineoverridevirtual |
Gets the name for the color scheme.
Implements QgsColorScheme.
Definition at line 279 of file qgscolorscheme.h.
|
overridevirtual |
Sets the colors for the scheme.
This method is only valid for editable color schemes.
colors | list of colors for the scheme |
context | to set colors for |
baseColor | base color to set colors for |
true
if colors were set successfully Reimplemented from QgsColorScheme.
Definition at line 163 of file qgscolorscheme.cpp.