QgsColorDialog Class Reference

A custom QGIS dialog for selecting a color. More...

#include <qgscolordialog.h>

Inheritance diagram for QgsColorDialog:

Public Slots
void	setColor (const QColor &color)
	Sets the current color for the dialog.

Signals
void	currentColorChanged (const QColor &color)
	Emitted when the dialog's color changes.

Public Member Functions
	QgsColorDialog (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags, const QColor &color=QColor())
	Create a new color picker dialog.
QColor	color () const
	Returns the current color for the dialog.
void	setAllowOpacity (bool allowOpacity)
	Sets whether opacity modification (transparency) is permitted for the color dialog.
void	setTitle (const QString &title)
	Sets the title for the color dialog.

Static Public Member Functions
static QColor	getColor (const QColor &initialColor, QWidget *parent, const QString &title=QString(), bool allowOpacity=false)
	Returns a color selection from a color dialog.

Protected Member Functions
void	closeEvent (QCloseEvent *e) override

Detailed Description

A custom QGIS dialog for selecting a color.

Has many improvements over the standard Qt color picker dialog, including hue wheel supports, color swatches, and a color sampler.

Definition at line 35 of file qgscolordialog.h.

Constructor & Destructor Documentation

QgsColorDialog()

QgsColorDialog::QgsColorDialog	(	QWidget *	parent = nullptr,
		Qt::WindowFlags	fl = QgsGuiUtils::ModalDialogFlags,
		const QColor &	color = QColor()
	)

Create a new color picker dialog.

Parameters

parent	parent widget
fl	window flags
color	initial color for dialog

Definition at line 30 of file qgscolordialog.cpp.

Member Function Documentation

closeEvent()

void QgsColorDialog::closeEvent ( QCloseEvent *  e )

overrideprotected

Definition at line 150 of file qgscolordialog.cpp.

color()

QColor QgsColorDialog::color

(

)

const

Returns the current color for the dialog.

Returns

dialog color

Definition at line 62 of file qgscolordialog.cpp.

currentColorChanged

void QgsColorDialog::currentColorChanged ( const QColor &  color )

signal

Emitted when the dialog's color changes.

Parameters

color

current color

getColor()

QColor QgsColorDialog::getColor ( const QColor &  initialColor, QWidget *  parent, const QString &  title = QString(), bool  allowOpacity = false  )

static

Returns a color selection from a color dialog.

Parameters

initialColor	the initial color of the selection dialog.
parent	parent widget
title	the title of the dialog.
allowOpacity	set to true to allow modification of color opacity value (transparency)

Returns

Selected color on accepted() or initialColor on rejected().

Definition at line 78 of file qgscolordialog.cpp.

setAllowOpacity()

void QgsColorDialog::setAllowOpacity

(

bool

allowOpacity

)

Sets whether opacity modification (transparency) is permitted for the color dialog.

Defaults to true.

Parameters

allowOpacity

set to false to disable opacity modification

Definition at line 72 of file qgscolordialog.cpp.

setColor

void QgsColorDialog::setColor ( const QColor &  color )

slot

Sets the current color for the dialog.

Parameters

color

desired color

Definition at line 132 of file qgscolordialog.cpp.

setTitle()

void QgsColorDialog::setTitle

(

const QString &

title

)

Sets the title for the color dialog.

Parameters

title

title for dialog box

Definition at line 67 of file qgscolordialog.cpp.

---

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

• /build/qgis-3.36.0+99sid/src/gui/qgscolordialog.h
• /build/qgis-3.36.0+99sid/src/gui/qgscolordialog.cpp