QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Member Functions | Protected Member Functions | List of all members
QgsGplColorScheme Class Referenceabstract

A color scheme which stores its colors in a gpl palette file. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsGplColorScheme:
Inheritance graph
[legend]

Public Member Functions

 QgsGplColorScheme ()=default
 Constructor for QgsGplColorScheme. More...
 
QgsNamedColorList fetchColors (const QString &context=QString(), const QColor &baseColor=QColor()) override
 Gets a list of colors from the 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
 
virtual QgsColorSchemeclone () const =0
 Clones a color 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...
 

Protected Member Functions

virtual QString gplFilePath ()=0
 Returns the file path for the associated gpl palette file. 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...
 
typedef QFlags< SchemeFlagSchemeFlags
 

Detailed Description

A color scheme which stores its colors in a gpl palette file.

Definition at line 141 of file qgscolorscheme.h.

Constructor & Destructor Documentation

◆ QgsGplColorScheme()

QgsGplColorScheme::QgsGplColorScheme ( )
default

Constructor for QgsGplColorScheme.

Member Function Documentation

◆ fetchColors()

QgsNamedColorList QgsGplColorScheme::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 241 of file qgscolorscheme.cpp.

◆ gplFilePath()

virtual QString QgsGplColorScheme::gplFilePath ( )
protectedpure virtual

Returns the file path for the associated gpl palette file.

Returns
gpl file path

Implemented in QgsUserColorScheme.

◆ setColors()

bool QgsGplColorScheme::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 259 of file qgscolorscheme.cpp.


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