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

Inheritance diagram for QgsGplColorScheme:

Public Member Functions
	QgsGplColorScheme ()
virtual	~QgsGplColorScheme ()
virtual QgsNamedColorList	fetchColors (const QString context=QString(), const QColor baseColor=QColor())
	Gets a list of colors from the scheme.
virtual bool	setColors (const QgsNamedColorList colors, const QString context=QString(), const QColor baseColor=QColor())
	Sets the colors for the scheme.
Public Member Functions inherited from QgsColorScheme
	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 bool	isEditable () const
	Returns whether the color scheme is editable.
virtual QgsColorScheme *	clone () const =0
	Clones a color scheme.

Protected Member Functions
virtual QString	gplFilePath ()=0
	Returns the file path for the associated gpl palette file.

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 stores its colors in a gpl palette file.

Constructor & Destructor Documentation

QgsGplColorScheme::QgsGplColorScheme ( )

QgsGplColorScheme::~QgsGplColorScheme ( )

virtual

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

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.