QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | List of all members
QgsColorScheme Class Referenceabstract

Abstract base class for color schemes. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsColorScheme:
Inheritance graph
[legend]

Public Types

enum  SchemeFlag { ShowInColorDialog = 0x01, ShowInColorButtonMenu = 0x02, ShowInAllContexts = ShowInColorDialog | ShowInColorButtonMenu }
 Flags for controlling behaviour of color scheme. More...
 

Public Member Functions

 QgsColorScheme ()
 
virtual ~QgsColorScheme ()
 
virtual QString schemeName () const =0
 Gets the name for the color scheme. More...
 
virtual SchemeFlags flags () const
 Returns the current flags for the color scheme. More...
 
virtual QgsNamedColorList fetchColors (const QString context=QString(), const QColor baseColor=QColor())=0
 Gets a list of colors from the scheme. More...
 
virtual bool isEditable () const
 Returns whether the color scheme is editable. More...
 
virtual bool setColors (const QgsNamedColorList colors, const QString context=QString(), const QColor baseColor=QColor())
 Sets the colors for the scheme. More...
 
virtual QgsColorSchemeclone () const =0
 Clones a color scheme. More...
 

Detailed Description

Abstract base class for color schemes.

A color scheme for display in QgsColorButtonV2. Color schemes return lists of colors with an optional associated color name. The colors returned can be generated using an optional base color.

Note
Added in version 2.5

Member Enumeration Documentation

Flags for controlling behaviour of color scheme.

Enumerator
ShowInColorDialog 
ShowInColorButtonMenu 
ShowInAllContexts 

Constructor & Destructor Documentation

QgsColorScheme::QgsColorScheme ( )
QgsColorScheme::~QgsColorScheme ( )
virtual

Member Function Documentation

virtual QgsColorScheme* QgsColorScheme::clone ( ) const
pure virtual

Clones a color scheme.

Returns
copy of color scheme

Implemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsRecentColorScheme, and QgsUserColorScheme.

virtual QgsNamedColorList QgsColorScheme::fetchColors ( const QString  context = QString(),
const QColor  baseColor = QColor() 
)
pure virtual

Gets a list of colors from the scheme.

The colors can optionally be generated using the supplied context and base color.

Parameters
contextstring 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.
baseColorbase 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

Implemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsRecentColorScheme, and QgsGplColorScheme.

virtual SchemeFlags QgsColorScheme::flags ( ) const
inlinevirtual

Returns the current flags for the color scheme.

Returns
current flags

Reimplemented in QgsProjectColorScheme, QgsCustomColorScheme, and QgsRecentColorScheme.

virtual bool QgsColorScheme::isEditable ( ) const
inlinevirtual

Returns whether the color scheme is editable.

Returns
true if scheme is editable
See also
setColors

Reimplemented in QgsProjectColorScheme, QgsCustomColorScheme, and QgsUserColorScheme.

virtual QString QgsColorScheme::schemeName ( ) const
pure virtual

Gets the name for the color scheme.

Returns
color scheme name

Implemented in QgsProjectColorScheme, QgsCustomColorScheme, QgsRecentColorScheme, and QgsUserColorScheme.

bool QgsColorScheme::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
colorslist of colors for the scheme
contextto set colors for
baseColorbase color to set colors for
Returns
true if colors were set successfully
See also
isEditable

Reimplemented in QgsProjectColorScheme, QgsCustomColorScheme, and QgsGplColorScheme.


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