Abstract base class for color schemes. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsColorScheme:

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

Public Member Functions
	QgsColorScheme ()
virtual	~QgsColorScheme ()
virtual QString	schemeName () const =0
	Gets the name for the color scheme.
virtual SchemeFlags	flags () const
	Returns the current flags for the color scheme.
virtual QgsNamedColorList	fetchColors (const QString context=QString(), const QColor baseColor=QColor())=0
	Gets a list of colors from the scheme.
virtual bool	isEditable () const
	Returns whether the color scheme is editable.
virtual bool	setColors (const QgsNamedColorList colors, const QString context=QString(), const QColor baseColor=QColor())
	Sets the colors for the scheme.
virtual QgsColorScheme *	clone () const =0
	Clones a color scheme.

Detailed Description

Abstract base class for color schemes.

A color scheme for display in QgsColorButtonV2. Color schemes return lists of colors with an optional associated color name. The colors returned can be generated using an optional base color.

Note: Added in version 2.5

Member Enumeration Documentation

enum QgsColorScheme::SchemeFlag

Flags for controlling behaviour of color scheme.

Enumerator:

ShowInColorDialog
ShowInColorButtonMenu
ShowInAllContexts

Constructor & Destructor Documentation

QgsColorScheme::QgsColorScheme ( )

QgsColorScheme::~QgsColorScheme ( )

virtual

Member Function Documentation

virtual QgsColorScheme* QgsColorScheme::clone ( ) const

pure virtual

Clones a color scheme.

Returns: copy of color scheme

Implemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsRecentColorScheme, and QgsUserColorScheme.

virtual QgsNamedColorList QgsColorScheme::fetchColors	(	const QString	context = `QString()`,
		const QColor	baseColor = `QColor()`
	)

pure virtual

Gets a list of colors from the scheme.

The colors can optionally be generated using the supplied context and base color.

Parameters

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