QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | List of all members
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 populateFromInstance ()
 Adds all color schemes from the global instance to this color scheme. 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 addColorScheme (QgsColorScheme *scheme)
 Adds a color scheme to the registry. 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 QgsColorSchemeRegistryinstance ()
 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

Constructor & Destructor Documentation

QgsColorSchemeRegistry::QgsColorSchemeRegistry ( )

Constructor for an empty color scheme registry.

QgsColorSchemeRegistry::~QgsColorSchemeRegistry ( )
virtual

Member Function Documentation

void QgsColorSchemeRegistry::addColorScheme ( QgsColorScheme scheme)

Adds a color scheme to the registry.

Ownership of the scheme is transferred to the registry.

Parameters
schemecolor scheme to add
See also
populateFromInstance
removeColorScheme
void QgsColorSchemeRegistry::addDefaultSchemes ( )

Adds all default color schemes to this color scheme.

See also
populateFromInstance
addColorScheme
addUserSchemes
void QgsColorSchemeRegistry::addUserSchemes ( )

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

See also
populateFromInstance
addDefaultSchemes
addColorScheme
QgsColorSchemeRegistry * QgsColorSchemeRegistry::instance ( )
static

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

void QgsColorSchemeRegistry::populateFromInstance ( )

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

See also
addDefaultSchemes
addColorScheme
bool QgsColorSchemeRegistry::removeColorScheme ( QgsColorScheme scheme)

Removes all matching color schemes from the registry.

Parameters
schemecolor scheme to remove
Returns
true if scheme was found and removed
See also
addColorScheme
QList< QgsColorScheme * > QgsColorSchemeRegistry::schemes ( ) const

Returns all color schemes in the registry.

Returns
list of color schemes
QList< QgsColorScheme * > QgsColorSchemeRegistry::schemes ( const QgsColorScheme::SchemeFlag  flag) const

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

Parameters
flagflag to match
Returns
list of color schemes with flag set
template<class T >
void QgsColorSchemeRegistry::schemes ( QList< T * > &  schemeList)

Return color schemes of a specific type.

Parameters
schemeListdestination list for matching schemes
Note
not available in python bindings

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