QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
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 ()
 
virtual ~QgsRecentColorScheme ()
 
QgsRecentColorSchemeclone () const override
 Clones a color scheme. More...
 
virtual QgsNamedColorList fetchColors (const QString &context=QString(), const QColor &baseColor=QColor()) override
 Gets a list of colors from the scheme. More...
 
virtual SchemeFlags flags () const override
 Returns the current flags for the color scheme. More...
 
virtual QString schemeName () const override
 Gets the name for the color scheme. More...
 
- Public Member Functions inherited from QgsColorScheme
 QgsColorScheme ()
 
virtual ~QgsColorScheme ()
 
virtual bool isEditable () const
 Returns whether the color scheme is editable. 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...
 

Additional Inherited Members

- Public Types inherited from QgsColorScheme
enum  SchemeFlag { ShowInColorDialog = 0x01, ShowInColorButtonMenu = 0x02, ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu }
 Flags for controlling behaviour of color scheme. More...
 

Detailed Description

A color scheme which contains the most recently used colors.

Note
Added in version 2.5

Definition at line 188 of file qgscolorscheme.h.

Constructor & Destructor Documentation

QgsRecentColorScheme::QgsRecentColorScheme ( )

Definition at line 51 of file qgscolorscheme.cpp.

QgsRecentColorScheme::~QgsRecentColorScheme ( )
virtual

Definition at line 56 of file qgscolorscheme.cpp.

Member Function Documentation

void QgsRecentColorScheme::addRecentColor ( const QColor color)
static

Adds a color to the list of recent colors.

Parameters
colorcolor to add
Note
added in QGIS 2.14

Definition at line 84 of file qgscolorscheme.cpp.

QgsRecentColorScheme * QgsRecentColorScheme::clone ( ) const
overridevirtual

Clones a color scheme.

Returns
copy of color scheme

Implements QgsColorScheme.

Definition at line 79 of file qgscolorscheme.cpp.

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 specifiying 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 61 of file qgscolorscheme.cpp.

virtual SchemeFlags QgsRecentColorScheme::flags ( ) const
inlineoverridevirtual

Returns the current flags for the color scheme.

Returns
current flags

Reimplemented from QgsColorScheme.

Definition at line 198 of file qgscolorscheme.h.

virtual QString QgsRecentColorScheme::schemeName ( ) const
inlineoverridevirtual

Gets the name for the color scheme.

Returns
color scheme name

Implements QgsColorScheme.

Definition at line 196 of file qgscolorscheme.h.


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