QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsRecentColorScheme Class Reference

A color scheme which contains the most recently used colors. More...

#include <qgscolorscheme.h>

Inheritance diagram for QgsRecentColorScheme:
Inheritance graph
[legend]

Public Member Functions

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

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 the most recently used colors.

Note
Added in version 2.5

Constructor & Destructor Documentation

QgsRecentColorScheme::QgsRecentColorScheme ( )
QgsRecentColorScheme::~QgsRecentColorScheme ( )
virtual

Member Function Documentation

QgsColorScheme * QgsRecentColorScheme::clone ( ) const
virtual

Clones a color scheme.

Returns
copy of color scheme

Implements QgsColorScheme.

QgsNamedColorList QgsRecentColorScheme::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 QgsRecentColorScheme::flags ( ) const
inlinevirtual

Returns the current flags for the color scheme.

Returns
current flags

Reimplemented from QgsColorScheme.

virtual QString QgsRecentColorScheme::schemeName ( ) const
inlinevirtual

Gets the name for the color scheme.

Returns
color scheme name

Implements QgsColorScheme.


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