QgsUserColorScheme Class Reference

A color scheme which stores its colors in a gpl palette file within the "palettes" subfolder off the user's QGIS settings folder. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsUserColorScheme:

Public Member Functions
	QgsUserColorScheme (const QString &filename)
	Constructs a new user color scheme, using a specified gpl palette file.
virtual	~QgsUserColorScheme ()
virtual QgsColorScheme *	clone () const override
	Clones a color scheme.
bool	erase ()
	Erases the associated gpl palette file from the users "palettes" folder.
virtual bool	isEditable () const override
	Returns whether the color scheme is editable.
virtual QString	schemeName () const override
	Gets the name for the color scheme.
void	setName (const QString &name)
	Sets the name for the scheme.
Public Member Functions inherited from QgsGplColorScheme
	QgsGplColorScheme ()
virtual	~QgsGplColorScheme ()
virtual QgsNamedColorList	fetchColors (const QString &context=QString(), const QColor &baseColor=QColor()) override
	Gets a list of colors from the scheme.
virtual bool	setColors (const QgsNamedColorList &colors, const QString &context=QString(), const QColor &baseColor=QColor()) override
	Sets the colors for the scheme.
Public Member Functions inherited from QgsColorScheme
	QgsColorScheme ()
virtual	~QgsColorScheme ()
virtual SchemeFlags	flags () const
	Returns the current flags for the color scheme.

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

Protected Attributes
QString	mFilename
QString	mName

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 within the "palettes" subfolder off the user's QGIS settings folder.

Note

Added in version 2.5

Definition at line 136 of file qgscolorscheme.h.

Constructor & Destructor Documentation

QgsUserColorScheme::QgsUserColorScheme

(

const QString &

filename

)

Constructs a new user color scheme, using a specified gpl palette file.

Parameters

filename

filename of gpl palette file stored in the users "palettes" folder

Definition at line 293 of file qgscolorscheme.cpp.

QgsUserColorScheme::~QgsUserColorScheme ( )

virtual

Definition at line 325 of file qgscolorscheme.cpp.

Member Function Documentation

QgsColorScheme * QgsUserColorScheme::clone ( ) const

overridevirtual

Clones a color scheme.

Returns

copy of color scheme

Implements QgsColorScheme.

Definition at line 335 of file qgscolorscheme.cpp.

bool QgsUserColorScheme::erase

(

)

Erases the associated gpl palette file from the users "palettes" folder.

Returns

true if erase was successful

Definition at line 340 of file qgscolorscheme.cpp.

QString QgsUserColorScheme::gplFilePath ( )

overrideprotectedvirtual

Returns the file path for the associated gpl palette file.

Returns

gpl file path

Implements QgsGplColorScheme.

Definition at line 352 of file qgscolorscheme.cpp.

virtual bool QgsUserColorScheme::isEditable ( ) const

inlineoverridevirtual

Returns whether the color scheme is editable.

Returns

true if scheme is editable

See Also

setColors

Reimplemented from QgsColorScheme.

Definition at line 151 of file qgscolorscheme.h.

QString QgsUserColorScheme::schemeName ( ) const

overridevirtual

Gets the name for the color scheme.

Returns

color scheme name

Implements QgsColorScheme.

Definition at line 330 of file qgscolorscheme.cpp.

void QgsUserColorScheme::setName ( const QString &  name )

inline

Sets the name for the scheme.

Parameters

name

new name

Definition at line 156 of file qgscolorscheme.h.

Member Data Documentation

QString QgsUserColorScheme::mFilename

protected

Definition at line 167 of file qgscolorscheme.h.

QString QgsUserColorScheme::mName

protected

Definition at line 165 of file qgscolorscheme.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgscolorscheme.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/qgscolorscheme.cpp