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

#include <qgscolorswatchgrid.h>

Inheritance diagram for QgsColorSwatchGrid:

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

Signals
void	colorChanged (const QColor &color)
	Emitted when a color has been selected from the widget. More...

void	hovered ()
	Emitted when mouse hovers over widget. More...

Public Member Functions
	QgsColorSwatchGrid (QgsColorScheme scheme, const QString &context=QString(), QWidget parent=nullptr)
	Construct a new color swatch grid. More...

QColor	baseColor () const
	Gets the base color for the widget. More...

QgsNamedColorList *	colors ()
	Gets the list of colors shown in the grid. More...

QString	context () const
	Gets the current context for the grid. More...

QSize	minimumSizeHint () const override

void	setBaseColor (const QColor &baseColor)
	Sets the base color for the widget. More...

void	setContext (const QString &context)
	Sets the current context for the grid. More...

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

Since: QGIS 2.5

Definition at line 32 of file qgscolorswatchgrid.h.

Constructor & Destructor Documentation

QgsColorSwatchGrid::QgsColorSwatchGrid	(	QgsColorScheme *	scheme,
		const QString &	context = `QString()`,
		QWidget *	parent = `nullptr`
	)

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 27 of file qgscolorswatchgrid.cpp.

Member Function Documentation

QColor QgsColorSwatchGrid::baseColor ( ) const

inline

Gets the base color for the widget.

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

See also: setBaseColor

Definition at line 71 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 84 of file qgscolorswatchgrid.h.

QString QgsColorSwatchGrid::context ( ) const

inline

Gets the current context for the grid.

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

See also: setContext

Definition at line 57 of file qgscolorswatchgrid.h.

void QgsColorSwatchGrid::focusInEvent ( QFocusEvent * event )

overrideprotected

Definition at line 266 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::focusOutEvent ( QFocusEvent * event )

overrideprotected

Definition at line 273 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::hovered ( )

signal

Emitted when mouse hovers over widget.

void QgsColorSwatchGrid::keyPressEvent ( QKeyEvent * event )

overrideprotected

Definition at line 207 of file qgscolorswatchgrid.cpp.

QSize QgsColorSwatchGrid::minimumSizeHint ( ) const

override

Definition at line 58 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::mouseMoveEvent ( QMouseEvent * event )

overrideprotected

Definition at line 98 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::mousePressEvent ( QMouseEvent * event )

overrideprotected

Definition at line 174 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

Definition at line 185 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::paintEvent ( QPaintEvent * event )

overrideprotected

Definition at line 90 of file qgscolorswatchgrid.cpp.

void QgsColorSwatchGrid::refreshColors ( )

slot

Reload colors from scheme and redraws the widget.

Definition at line 80 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 74 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 68 of file qgscolorswatchgrid.cpp.

QSize QgsColorSwatchGrid::sizeHint ( ) const

override

Definition at line 63 of file qgscolorswatchgrid.cpp.

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

/build/qgis-3.4.15+24xenial/src/gui/qgscolorswatchgrid.h
/build/qgis-3.4.15+24xenial/src/gui/qgscolorswatchgrid.cpp

Public Slots

Signals

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation