An editable list of color swatches, taken from an associated QgsColorScheme. More...

#include <qgscolorschemelist.h>

Public Slots
void	addColor (const QColor &color, const QString &label=QString())
	Adds a color to the list.
void	copyColors ()
	Copies colors from the list to the clipboard.
void	pasteColors ()
	Pastes colors from clipboard to the list.
void	removeSelection ()
	Removes any selected colors from the list.
void	setScheme (QgsColorScheme *scheme, const QString &context=QString(), const QColor &baseColor=QColor())
	Sets the color scheme to show in the list.

Signals
void	colorSelected (const QColor &color)
	Emitted when a color is selected from the list.

Public Member Functions
	QgsColorSchemeList (QWidget parent=0, QgsColorScheme scheme=0, const QString &context=QString(), const QColor &baseColor=QColor())
	Construct a new color swatch grid.
virtual	~QgsColorSchemeList ()
bool	exportColorsToGpl (QFile &file)
	Export colors to a GPL palette file from the list.
bool	importColorsFromGpl (QFile &file)
	Import colors from a GPL palette file to the list.
bool	isDirty () const
	Returns whether the color scheme list has been modified.
bool	saveColorsToScheme ()
	Saves the current colors shown in the list back to a color scheme, if supported by the color scheme.

Protected Member Functions
void	keyPressEvent (QKeyEvent *event) override
void	mousePressEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override

Detailed Description

An editable list of color swatches, taken from an associated QgsColorScheme.

See Also: QgsColorSchemeList

Note: introduced in QGIS 2.5

Definition at line 146 of file qgscolorschemelist.h.

Constructor & Destructor Documentation

QgsColorSchemeList::QgsColorSchemeList	(	QWidget *	parent = `0`,
		QgsColorScheme *	scheme = `0`,
		const QString &	context = `QString()`,
		const QColor &	baseColor = `QColor()`
	)

Construct a new color swatch grid.

Parameters

parent	parent widget
scheme	QgsColorScheme for colors to show in the list
context	context string provided to color scheme
baseColor	base color for color scheme

Definition at line 31 of file qgscolorschemelist.cpp.

QgsColorSchemeList::~QgsColorSchemeList ( )

virtual

Definition at line 54 of file qgscolorschemelist.cpp.

Member Function Documentation

void QgsColorSchemeList::addColor	(	const QColor &	color,
		const QString &	label = `QString()`
	)

slot

Adds a color to the list.

Parameters

color	color to add
label	optional label for color

Definition at line 94 of file qgscolorschemelist.cpp.

void QgsColorSchemeList::colorSelected ( const QColor & color )

signal

Emitted when a color is selected from the list.

Parameters

color color selected

void QgsColorSchemeList::copyColors ( )

slot

Copies colors from the list to the clipboard.

See Also: pasteColors

Definition at line 117 of file qgscolorschemelist.cpp.

bool QgsColorSchemeList::exportColorsToGpl ( QFile & file )

Export colors to a GPL palette file from the list.

Parameters

file	destination file

See Also: importColorsFromGpl

Definition at line 219 of file qgscolorschemelist.cpp.

bool QgsColorSchemeList::importColorsFromGpl ( QFile & file )

Import colors from a GPL palette file to the list.

Parameters

file	file to import

See Also: exportColorsToGpl

Definition at line 192 of file qgscolorschemelist.cpp.

bool QgsColorSchemeList::isDirty ( ) const

Returns whether the color scheme list has been modified.

Returns: true if colors have been modified

Definition at line 224 of file qgscolorschemelist.cpp.

void QgsColorSchemeList::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 138 of file qgscolorschemelist.cpp.

void QgsColorSchemeList::mousePressEvent ( QMouseEvent * event )

overrideprotected

Definition at line 163 of file qgscolorschemelist.cpp.

void QgsColorSchemeList::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

Definition at line 173 of file qgscolorschemelist.cpp.

void QgsColorSchemeList::pasteColors ( )

slot

Pastes colors from clipboard to the list.

See Also: copyColors

Definition at line 99 of file qgscolorschemelist.cpp.

void QgsColorSchemeList::removeSelection ( )

slot

Removes any selected colors from the list.

Definition at line 76 of file qgscolorschemelist.cpp.

bool QgsColorSchemeList::saveColorsToScheme ( )

Saves the current colors shown in the list back to a color scheme, if supported by the color scheme.

Note: this method is only effective if the color scheme is editable

Definition at line 65 of file qgscolorschemelist.cpp.

void QgsColorSchemeList::setScheme	(	QgsColorScheme *	scheme,
		const QString &	context = `QString()`,
		const QColor &	baseColor = `QColor()`
	)

slot

Sets the color scheme to show in the list.

Parameters

scheme	QgsColorScheme for colors to show in the list
context	context string provided to color scheme
baseColor	base color for color scheme

Definition at line 59 of file qgscolorschemelist.cpp.

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

/tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgscolorschemelist.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/gui/qgscolorschemelist.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation