QgsColorSchemeList Class Reference

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

#include <qgscolorschemelist.h>

Inheritance diagram for QgsColorSchemeList:

Public Slots
void	addColor (const QColor &color, const QString &label=QString(), bool allowDuplicate=false)
	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.
void	showExportColorsDialog ()
	Displays a file picker dialog allowing users to export colors from the list into a file.
void	showImportColorsDialog ()
	Displays a file picker dialog allowing users to import colors into the list from a file.

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

Public Member Functions
	QgsColorSchemeList (QWidget *parent=nullptr, QgsColorScheme *scheme=nullptr, const QString &context=QString(), const QColor &baseColor=QColor())
	Construct a new color swatch grid.
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.
QgsColorScheme *	scheme ()
	Returns the scheme currently selected in the list.

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

Definition at line 158 of file qgscolorschemelist.h.

Constructor & Destructor Documentation

QgsColorSchemeList()

QgsColorSchemeList::QgsColorSchemeList	(	QWidget *	parent = nullptr,
		QgsColorScheme *	scheme = nullptr,
		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 36 of file qgscolorschemelist.cpp.

Member Function Documentation

addColor

void QgsColorSchemeList::addColor ( const QColor &  color, const QString &  label = QString(), bool  allowDuplicate = false  )

slot

Adds a color to the list.

Parameters

color	color to add
label	optional label for color
allowDuplicate	set to true to allow duplicate colors to be added, ie colors which already exist in the list

Definition at line 96 of file qgscolorschemelist.cpp.

colorSelected

void QgsColorSchemeList::colorSelected ( const QColor &  color )

signal

Emitted when a color is selected from the list.

Parameters

color

color selected

copyColors

void QgsColorSchemeList::copyColors ( )

slot

Copies colors from the list to the clipboard.

See also

pasteColors

Definition at line 119 of file qgscolorschemelist.cpp.

exportColorsToGpl()

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 282 of file qgscolorschemelist.cpp.

importColorsFromGpl()

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 255 of file qgscolorschemelist.cpp.

isDirty()

bool QgsColorSchemeList::isDirty

(

)

const

Returns whether the color scheme list has been modified.

Returns

true if colors have been modified

Definition at line 287 of file qgscolorschemelist.cpp.

keyPressEvent()

void QgsColorSchemeList::keyPressEvent ( QKeyEvent *  event )

overrideprotected

Definition at line 200 of file qgscolorschemelist.cpp.

mousePressEvent()

void QgsColorSchemeList::mousePressEvent ( QMouseEvent *  event )

overrideprotected

Definition at line 227 of file qgscolorschemelist.cpp.

mouseReleaseEvent()

void QgsColorSchemeList::mouseReleaseEvent ( QMouseEvent *  event )

overrideprotected

Definition at line 237 of file qgscolorschemelist.cpp.

pasteColors

void QgsColorSchemeList::pasteColors ( )

slot

Pastes colors from clipboard to the list.

See also

copyColors

Definition at line 101 of file qgscolorschemelist.cpp.

removeSelection

void QgsColorSchemeList::removeSelection ( )

slot

Removes any selected colors from the list.

Definition at line 76 of file qgscolorschemelist.cpp.

saveColorsToScheme()

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.

scheme()

QgsColorScheme * QgsColorSchemeList::scheme

(

)

Returns the scheme currently selected in the list.

See also

setScheme()

Definition at line 297 of file qgscolorschemelist.cpp.

setScheme

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

See also

scheme()

Definition at line 59 of file qgscolorschemelist.cpp.

showExportColorsDialog

void QgsColorSchemeList::showExportColorsDialog ( )

slot

Displays a file picker dialog allowing users to export colors from the list into a file.

See also

showImportColorsDialog()

Definition at line 171 of file qgscolorschemelist.cpp.

showImportColorsDialog

void QgsColorSchemeList::showImportColorsDialog ( )

slot

Displays a file picker dialog allowing users to import colors into the list from a file.

See also

showExportColorsDialog()

Definition at line 142 of file qgscolorschemelist.cpp.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgscolorschemelist.h
• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/gui/qgscolorschemelist.cpp