QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | Static Public Member Functions | List of all members
QgsRecentColorScheme Class Reference

A color scheme which contains the most recently used colors. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsRecentColorScheme:
Inheritance graph
[legend]

Public Member Functions

 QgsRecentColorScheme ()=default
 Constructor for QgsRecentColorScheme. More...
 
QgsRecentColorSchemeclone () 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...
 
QString schemeName () const override
 Gets the name for the color scheme. More...
 
- Public Member Functions inherited from QgsColorScheme
 QgsColorScheme ()=default
 Constructor for QgsColorScheme. More...
 
virtual ~QgsColorScheme ()=default
 
virtual QgsColorSchemeclone () 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...
 

Static Public Member Functions

static void addRecentColor (const QColor &color)
 Adds a color to the list of recent colors. More...
 
static QColor lastUsedColor ()
 Returns the most recently used color. More...
 

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 the most recently used colors.

Since
QGIS 2.5

Definition at line 230 of file qgscolorscheme.h.

Constructor & Destructor Documentation

◆ QgsRecentColorScheme()

QgsRecentColorScheme::QgsRecentColorScheme ( )
default

Constructor for QgsRecentColorScheme.

Member Function Documentation

◆ addRecentColor()

void QgsRecentColorScheme::addRecentColor ( const QColor &  color)
static

Adds a color to the list of recent colors.

Parameters
colorcolor to add
See also
lastUsedColor()
Since
QGIS 2.14

Definition at line 68 of file qgscolorscheme.cpp.

◆ clone()

QgsRecentColorScheme * QgsRecentColorScheme::clone ( ) const
overridevirtual

Clones a color scheme.

Returns
copy of color scheme

Implements QgsColorScheme.

Definition at line 63 of file qgscolorscheme.cpp.

◆ fetchColors()

QgsNamedColorList QgsRecentColorScheme::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 44 of file qgscolorscheme.cpp.

◆ flags()

SchemeFlags QgsRecentColorScheme::flags ( ) const
inlineoverridevirtual

Returns the current flags for the color scheme.

Returns
current flags

Reimplemented from QgsColorScheme.

Definition at line 241 of file qgscolorscheme.h.

◆ lastUsedColor()

QColor QgsRecentColorScheme::lastUsedColor ( )
static

Returns the most recently used color.

See also
addRecentColor()
Since
QGIS 3.0

Definition at line 104 of file qgscolorscheme.cpp.

◆ schemeName()

QString QgsRecentColorScheme::schemeName ( ) const
inlineoverridevirtual

Gets the name for the color scheme.

Returns
color scheme name

Implements QgsColorScheme.

Definition at line 239 of file qgscolorscheme.h.


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