A grid of color swatches, which allows for user selection. More...

#include <qgscolorswatchgrid.h>

Public Slots
void	refreshColors ()
	Reload colors from scheme and redraws the widget.

Signals
void	colorChanged (const QColor &color)
	Emitted when a color has been selected from the widget.
void	hovered ()
	Emitted when mouse hovers over widget.

Public Member Functions
	QgsColorSwatchGrid (QgsColorScheme scheme, QString context=QString(), QWidget parent=0)
	Construct a new color swatch grid.
virtual	~QgsColorSwatchGrid ()
QColor	baseColor () const
	Get the base color for the widget.
QgsNamedColorList *	colors ()
	Gets the list of colors shown in the grid.
QString	context () const
	Get the current context for the grid.
virtual QSize	minimumSizeHint () const override
void	setBaseColor (const QColor &baseColor)
	Sets the base color for the widget.
void	setContext (const QString &context)
	Sets the current context for the grid.
virtual QSize	sizeHint () const override

Protected Member Functions
void	focusInEvent (QFocusEvent *event) override
void	focusOutEvent (QFocusEvent *event) override
void	keyPressEvent (QKeyEvent *event) override
void	mouseMoveEvent (QMouseEvent *event) override
void	mousePressEvent (QMouseEvent *event) override
void	mouseReleaseEvent (QMouseEvent *event) override
void	paintEvent (QPaintEvent *event) override

Detailed Description

A grid of color swatches, which allows for user selection.

Colors are taken from an associated QgsColorScheme.

See Also: QgsColorGridAction

Note: introduced in QGIS 2.5

Definition at line 29 of file qgscolorswatchgrid.h.

Constructor & Destructor Documentation

QgsColorSwatchGrid::QgsColorSwatchGrid	(	QgsColorScheme *	scheme,
		QString	context = `QString()`,
		QWidget *	parent = `0`
	)

Construct a new color swatch grid.

Parameters

scheme	QgsColorScheme for colors to show in grid
context	context string provided to color scheme
parent	parent widget

Definition at line 33 of file qgscolorswatchgrid.cpp.

QgsColorSwatchGrid::~QgsColorSwatchGrid ( )

virtual

Definition at line 55 of file qgscolorswatchgrid.cpp.

Member Function Documentation

QColor QgsColorSwatchGrid::baseColor ( ) const

inline

Get the base color for the widget.

Returns: base color which is passed to scheme for color generation

See Also: setBaseColor

Definition at line 66 of file qgscolorswatchgrid.h.

void QgsColorSwatchGrid::colorChanged ( const QColor & color )

signal

Emitted when a color has been selected from the widget.

Parameters

color selected color

QgsNamedColorList* QgsColorSwatchGrid::colors ( )

inline

Gets the list of colors shown in the grid.

Returns: list of colors currently shown in the grid

Definition at line 77 of file qgscolorswatchgrid.h.

QString QgsColorSwatchGrid::context ( ) const

inline

Get the current context for the grid.

Returns: context string which is passed to scheme for color generation

See Also: setContext

Definition at line 54 of file qgscolorswatchgrid.h.

void QgsColorSwatchGrid::focusInEvent ( QFocusEvent * event )

overrideprotected

Definition at line 231 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::focusOutEvent ( QFocusEvent * event )

overrideprotected

Definition at line 238 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::hovered ( )

signal

Emitted when mouse hovers over widget.

void QgsColorSwatchGrid::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 172 of file qgscolorswatchgrid.cpp.

QSize QgsColorSwatchGrid::minimumSizeHint ( ) const

overridevirtual

Definition at line 60 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::mouseMoveEvent ( QMouseEvent * event )

overrideprotected

Definition at line 100 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::mousePressEvent ( QMouseEvent * event )

overrideprotected

Definition at line 139 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

Definition at line 150 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::paintEvent ( QPaintEvent * event )

overrideprotected

Definition at line 92 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::refreshColors ( )

slot

Reload colors from scheme and redraws the widget.

Definition at line 82 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::setBaseColor ( const QColor & baseColor )

Sets the base color for the widget.

Parameters

baseColor base color to pass to scheme for color generation

See Also: baseColor

Definition at line 76 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::setContext ( const QString & context )

Sets the current context for the grid.

Parameters

context string which is passed to scheme for color generation

See Also: context

Definition at line 70 of file qgscolorswatchgrid.cpp.

QSize QgsColorSwatchGrid::sizeHint ( ) const

overridevirtual

Definition at line 65 of file qgscolorswatchgrid.cpp.

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

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation