A color scheme which contains custom colors set through QGIS app options dialog. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsCustomColorScheme:

Public Member Functions
	QgsCustomColorScheme ()
virtual	~QgsCustomColorScheme ()
virtual QString	schemeName () const
	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())
	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.
QgsColorScheme *	clone () const
	Clones a color scheme.
Public Member Functions inherited from QgsColorScheme
	QgsColorScheme ()
virtual	~QgsColorScheme ()

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 custom colors set through QGIS app options dialog.

Note: Added in version 2.5

Constructor & Destructor Documentation

QgsCustomColorScheme::QgsCustomColorScheme ( )

QgsCustomColorScheme::~QgsCustomColorScheme ( )

virtual

Member Function Documentation

QgsColorScheme * QgsCustomColorScheme::clone ( ) const

virtual

Clones a color scheme.

Returns: copy of color scheme

Implements QgsColorScheme.

QgsNamedColorList QgsCustomColorScheme::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.

Returns: a list of QPairs of color and color name

Implements QgsColorScheme.

virtual SchemeFlags QgsCustomColorScheme::flags ( ) const

inlinevirtual

Returns the current flags for the color scheme.

Returns: current flags

Reimplemented from QgsColorScheme.

virtual bool QgsCustomColorScheme::isEditable ( ) const

inlinevirtual

Returns whether the color scheme is editable.

Returns: true if scheme is editable

See Also: setColors

Reimplemented from QgsColorScheme.

virtual QString QgsCustomColorScheme::schemeName ( ) const

inlinevirtual

Gets the name for the color scheme.

Returns: color scheme name

Implements QgsColorScheme.

bool QgsCustomColorScheme::setColors	(	const QgsNamedColorList	colors,
		const QString	context = `QString()`,
		const QColor	baseColor = `QColor()`
	)

virtual

Sets the colors for the scheme.

This method is only valid for editable color schemes.

Parameters

colors	list of colors for the scheme
context	to set colors for
baseColor	base color to set colors for

Returns: true if colors were set successfully

See Also: isEditable

Reimplemented from QgsColorScheme.

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

/tmp/buildd/qgis-2.6.0+wheezy1/src/core/qgscolorscheme.h
/tmp/buildd/qgis-2.6.0+wheezy1/src/core/qgscolorscheme.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation