QgsColorSchemeRegistry Class Reference

Registry of color schemes. More...

#include <qgscolorschemeregistry.h>

Public Member Functions
	QgsColorSchemeRegistry ()
	Constructor for an empty color scheme registry. More...
virtual	~QgsColorSchemeRegistry ()
void	addColorScheme (QgsColorScheme *scheme)
	Adds a color scheme to the registry. More...
void	addDefaultSchemes ()
	Adds all default color schemes to this color scheme. More...
void	addUserSchemes ()
	Creates schemes for all gpl palettes in the user's palettes folder. More...
void	populateFromInstance ()
	Adds all color schemes from the global instance to this color scheme. More...
bool	removeColorScheme (QgsColorScheme *scheme)
	Removes all matching color schemes from the registry. More...
QList< QgsColorScheme * >	schemes () const
	Returns all color schemes in the registry. More...
QList< QgsColorScheme * >	schemes (const QgsColorScheme::SchemeFlag flag) const
	Returns all color schemes in the registry which have a specified flag set. More...
template<class T >
void	schemes (QList< T *> &schemeList)
	Return color schemes of a specific type. More...

Static Public Member Functions
static QgsColorSchemeRegistry *	instance ()
	Returns the global instance pointer, creating the object on the first call. More...

Detailed Description

Registry of color schemes.

A registry of QgsColorScheme color schemes. This class can be created directly, or accessed via a global instance.

Note

Added in version 2.5

Definition at line 32 of file qgscolorschemeregistry.h.

Constructor & Destructor Documentation

QgsColorSchemeRegistry()

QgsColorSchemeRegistry::QgsColorSchemeRegistry

(

)

Constructor for an empty color scheme registry.

Definition at line 47 of file qgscolorschemeregistry.cpp.

~QgsColorSchemeRegistry()

QgsColorSchemeRegistry::~QgsColorSchemeRegistry ( )

virtual

Definition at line 51 of file qgscolorschemeregistry.cpp.

Member Function Documentation

addColorScheme()

void QgsColorSchemeRegistry::addColorScheme

(

QgsColorScheme *

scheme

)

Adds a color scheme to the registry.

Ownership of the scheme is transferred to the registry.

Parameters

scheme

color scheme to add

See also

populateFromInstance

removeColorScheme

Definition at line 97 of file qgscolorschemeregistry.cpp.

addDefaultSchemes()

void QgsColorSchemeRegistry::addDefaultSchemes

(

)

Adds all default color schemes to this color scheme.

See also

populateFromInstance

addColorScheme

addUserSchemes

Definition at line 70 of file qgscolorschemeregistry.cpp.

addUserSchemes()

void QgsColorSchemeRegistry::addUserSchemes

(

)

Creates schemes for all gpl palettes in the user's palettes folder.

See also

populateFromInstance

addDefaultSchemes

addColorScheme

Definition at line 79 of file qgscolorschemeregistry.cpp.

instance()

QgsColorSchemeRegistry * QgsColorSchemeRegistry::instance ( )

static

Returns the global instance pointer, creating the object on the first call.

Definition at line 28 of file qgscolorschemeregistry.cpp.

populateFromInstance()

void QgsColorSchemeRegistry::populateFromInstance

(

)

Adds all color schemes from the global instance to this color scheme.

See also

addDefaultSchemes

addColorScheme

Definition at line 57 of file qgscolorschemeregistry.cpp.

removeColorScheme()

bool QgsColorSchemeRegistry::removeColorScheme

(

QgsColorScheme *

scheme

)

Removes all matching color schemes from the registry.

Parameters

scheme

color scheme to remove

Returns

true if scheme was found and removed

See also

addColorScheme

Definition at line 127 of file qgscolorschemeregistry.cpp.

schemes() [1/3]

QList< QgsColorScheme * > QgsColorSchemeRegistry::schemes

(

)

const

Returns all color schemes in the registry.

Returns

list of color schemes

Definition at line 102 of file qgscolorschemeregistry.cpp.

schemes() [2/3]

QList< QgsColorScheme * > QgsColorSchemeRegistry::schemes

(

const QgsColorScheme::SchemeFlag

flag

)

const

Returns all color schemes in the registry which have a specified flag set.

Parameters

flag	flag to match

Returns

list of color schemes with flag set

Definition at line 113 of file qgscolorschemeregistry.cpp.

schemes() [3/3]

template<class T >

void QgsColorSchemeRegistry::schemes

(

QList< T *> &

schemeList

)

Return color schemes of a specific type.

Parameters

schemeList

destination list for matching schemes

Note

not available in python bindings

Definition at line 107 of file qgscolorschemeregistry.h.

---

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

• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgscolorschemeregistry.h
• /tmp/buildd/qgis-2.18.21+99unstable/src/core/qgscolorschemeregistry.cpp