PySide6.QtWidgets.QColorDialog

class QColorDialog

The QColorDialog class provides a dialog widget for specifying colors. More…

Synopsis

Properties

• currentColorᅟ - The currently selected color in the dialog

• optionsᅟ - The various options that affect the look and feel of the dialog

Methods

• def __init__()

• def currentColor()

• def open()

• def options()

• def selectedColor()

• def setCurrentColor()

• def setOption()

• def setOptions()

• def testOption()

Signals

• def colorSelected()

• def currentColorChanged()

Static functions

• def customColor()

• def customCount()

• def getColor()

• def setCustomColor()

• def setStandardColor()

• def standardColor()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

The color dialog’s function is to allow users to choose colors. For example, you might use this in a drawing program to allow the user to set the brush color.

The static functions provide modal color dialogs.

The static getColor() function shows the dialog, and allows the user to specify a color. This function can also be used to let users choose a color with a level of transparency: pass the ShowAlphaChannel option as an additional argument.

The user can store customCount() different custom colors. The custom colors are shared by all color dialogs, and remembered during the execution of the program. Use setCustomColor() to set the custom colors, and use customColor() to get them.

When pressing the “Pick Screen Color” button, the cursor changes to a haircross and the colors on the screen are scanned. The user can pick up one by clicking the mouse or the Enter button. Pressing Escape restores the last color selected before entering this mode.

The Standard Dialogs example shows how to use QColorDialog as well as other built-in Qt dialogs.

See also

QFileDialog QFontDialog Standard Dialogs Example

class ColorDialogOption

(inherits enum.Flag) This enum specifies various options that affect the look and feel of a color dialog.

Constant	Description
QColorDialog.ShowAlphaChannel	Allow the user to select the alpha component of a color.
QColorDialog.NoButtons	Don’t display OK and Cancel buttons. (Useful for “live dialogs”.)
QColorDialog.NoEyeDropperButton	Hide the Eye Dropper button. This value was added in Qt 6.6.
QColorDialog.DontUseNativeDialog	Use Qt’s standard color dialog instead of the operating system native color dialog.

See also

options setOption() testOption() windowModality()

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property currentColorᅟ: QColor

This property holds the currently selected color in the dialog.

Access functions:

• currentColor()

• setCurrentColor()

• Signal currentColorChanged()

property optionsᅟ: Combination of QColorDialog.ColorDialogOption

This property holds the various options that affect the look and feel of the dialog.

By default, all options are disabled.

Options should be set before showing the dialog. Setting them while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

See also

setOption() testOption()

Access functions:

• options()

• setOptions()

__init__([parent=None])

Parameters:

parent – QWidget

Constructs a color dialog with the given parent.

__init__(initial[, parent=None])

Parameters:

• initial – QColor

• parent – QWidget

Constructs a color dialog with the given parent and specified initial color.

colorSelected(color)

Parameters:

color – QColor

This signal is emitted just after the user has clicked OK to select a color to use. The chosen color is specified by color.

See also

color currentColorChanged()

currentColor()

Return type:

QColor

See also

setCurrentColor()

Getter of property currentColorᅟ .

currentColorChanged(color)

Parameters:

color – QColor

This signal is emitted whenever the current color changes in the dialog. The current color is specified by color.

See also

color colorSelected()

Notification signal of property currentColorᅟ .

static customColor(index)

Parameters:

index – int

Return type:

QColor

Returns the custom color at the given index as a QColor value.

See also

setCustomColor()

static customCount()

Return type:

int

Returns the number of custom colors supported by QColorDialog . All color dialogs share the same custom colors.

static getColor([initial=Qt.white[, parent=None[, title=""[, options=QColorDialog.ColorDialogOptions()]]]])

Parameters:

• initial – QColor

• parent – QWidget

• title – str

• options – Combination of ColorDialogOption

Return type:

QColor

Pops up a modal color dialog with the given window title (or “Select Color” if none is specified), lets the user choose a color, and returns that color. The color is initially set to initial. The dialog is a child of parent. It returns an invalid (see QColor::isValid()) color if the user cancels the dialog.

The options argument allows you to customize the dialog.

open(receiver, member)

Parameters:

• receiver – QObject

• member – str

Opens the dialog and connects its colorSelected() signal to the slot specified by receiver and member.

The signal will be disconnected from the slot when the dialog is closed.

options()

Return type:

Combination of ColorDialogOption

See also

setOptions()

Getter of property optionsᅟ .

selectedColor()

Return type:

QColor

Returns the color that the user selected by clicking the OK or equivalent button.

Note

This color is not always the same as the color held by the currentColor property since the user can choose different colors before finally selecting the one to use.

setCurrentColor(color)

Parameters:

color – QColor

See also

currentColor()

Setter of property currentColorᅟ .

static setCustomColor(index, color)

Parameters:

• index – int

• color – QColor

Sets the custom color at index to the QColor color value.

Note

This function does not apply to the Native Color Dialog on the macOS platform. If you still require this function, use the DontUseNativeDialog option.

See also

customColor()

setOption(option[, on=true])

Parameters:

• option – ColorDialogOption

• on – bool

Sets the given option to be enabled if on is true; otherwise, clears the given option.

See also

options testOption()

setOptions(options)

Parameters:

options – Combination of ColorDialogOption

See also

options()

Setter of property optionsᅟ .

static setStandardColor(index, color)

Parameters:

• index – int

• color – QColor

Sets the standard color at index to the QColor color value.

Note

This function does not apply to the Native Color Dialog on the macOS platform. If you still require this function, use the DontUseNativeDialog option.

See also

standardColor()

static standardColor(index)

Parameters:

index – int

Return type:

QColor

Returns the standard color at the given index as a QColor value.

See also

setStandardColor()

testOption(option)

Parameters:

option – ColorDialogOption

Return type:

bool

Returns true if the given option is enabled; otherwise, returns false.

See also

options setOption()