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

A color scheme which contains project specific colors set through project properties dialog. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsProjectColorScheme:
Inheritance graph
[legend]

Public Member Functions

 QgsProjectColorScheme ()
 
virtual ~QgsProjectColorScheme ()
 
virtual QString schemeName () const
 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())
 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...
 
QgsColorSchemeclone () const
 Clones a color scheme. More...
 
- Public Member Functions inherited from QgsColorScheme
 QgsColorScheme ()
 
virtual ~QgsColorScheme ()
 

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 contains project specific colors set through project properties dialog.

Note
Added in version 2.5

Constructor & Destructor Documentation

QgsProjectColorScheme::QgsProjectColorScheme ( )
QgsProjectColorScheme::~QgsProjectColorScheme ( )
virtual

Member Function Documentation

QgsColorScheme * QgsProjectColorScheme::clone ( ) const
virtual

Clones a color scheme.

Returns
copy of color scheme

Implements QgsColorScheme.

QgsNamedColorList QgsProjectColorScheme::fetchColors ( const QString  context = QString(),
const QColor  baseColor = QColor() 
)
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

Implements QgsColorScheme.

virtual SchemeFlags QgsProjectColorScheme::flags ( ) const
inlinevirtual

Returns the current flags for the color scheme.

Returns
current flags

Reimplemented from QgsColorScheme.

virtual bool QgsProjectColorScheme::isEditable ( ) const
inlinevirtual

Returns whether the color scheme is editable.

Returns
true if scheme is editable
See also
setColors

Reimplemented from QgsColorScheme.

virtual QString QgsProjectColorScheme::schemeName ( ) const
inlinevirtual

Gets the name for the color scheme.

Returns
color scheme name

Implements QgsColorScheme.

bool QgsProjectColorScheme::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 from QgsColorScheme.


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