QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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:
Inheritance graph
[legend]

Public Member Functions

 QgsUserColorScheme (const QString &filename)
 Constructs a new user color scheme, using a specified gpl palette file. More...
 
virtual ~QgsUserColorScheme ()
 
virtual QgsUserColorSchemeclone () const override
 Clones a color scheme. More...
 
bool erase ()
 Erases the associated gpl palette file from the users "palettes" folder. More...
 
virtual QgsColorScheme::SchemeFlags flags () const override
 Returns the current flags for the color scheme. More...
 
virtual bool isEditable () const override
 Returns whether the color scheme is editable. More...
 
virtual QString schemeName () const override
 Gets the name for the color scheme. More...
 
void setName (const QString &name)
 Sets the name for the scheme. More...
 
void setShowSchemeInMenu (bool show)
 Sets whether a this scheme should be shown in color button menus. More...
 
- 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. More...
 
virtual bool setColors (const QgsNamedColorList &colors, const QString &context=QString(), const QColor &baseColor=QColor()) override
 Sets the colors for the scheme. More...
 
- Public Member Functions inherited from QgsColorScheme
 QgsColorScheme ()
 
virtual ~QgsColorScheme ()
 

Protected Member Functions

virtual QString gplFilePath () override
 Returns the file path for the associated gpl palette file. More...
 

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 138 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
filenamefilename of gpl palette file stored in the users "palettes" folder

Definition at line 329 of file qgscolorscheme.cpp.

QgsUserColorScheme::~QgsUserColorScheme ( )
virtual

Definition at line 361 of file qgscolorscheme.cpp.

Member Function Documentation

QgsUserColorScheme * QgsUserColorScheme::clone ( ) const
overridevirtual

Clones a color scheme.

Returns
copy of color scheme

Implements QgsColorScheme.

Definition at line 371 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 391 of file qgscolorscheme.cpp.

QgsColorScheme::SchemeFlags QgsUserColorScheme::flags ( ) const
overridevirtual

Returns the current flags for the color scheme.

Returns
current flags

Reimplemented from QgsColorScheme.

Definition at line 376 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 420 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 153 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 366 of file qgscolorscheme.cpp.

void QgsUserColorScheme::setName ( const QString name)
inline

Sets the name for the scheme.

Parameters
namenew name

Definition at line 160 of file qgscolorscheme.h.

void QgsUserColorScheme::setShowSchemeInMenu ( bool  show)

Sets whether a this scheme should be shown in color button menus.

Parameters
showset to true to show in color button menus, or false to hide from menus
Note
added in QGIS 2.18

Definition at line 403 of file qgscolorscheme.cpp.

Member Data Documentation

QString QgsUserColorScheme::mFilename
protected

Definition at line 177 of file qgscolorscheme.h.

QString QgsUserColorScheme::mName
protected

Definition at line 175 of file qgscolorscheme.h.


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