QColorDialog

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

Inheritance diagram of PySide2.QtWidgets.QColorDialog

Synopsis

Functions

Signals

Static functions

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.

../../_images/fusion-colordialog.png

See also

QColor QFileDialog QFontDialog Standard Dialogs Example

class QColorDialog([parent=None])

QColorDialog(initial[, parent=None])

param parent

QWidget

param initial

QColor

Constructs a color dialog with the given parent .

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

PySide2.QtWidgets.QColorDialog.ColorDialogOption

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.DontUseNativeDialog

Use Qt’s standard color dialog instead of the operating system native color dialog.

See also

options setOption() testOption() windowModality()

PySide2.QtWidgets.QColorDialog.colorSelected(color)
Parameters

color – QColor

PySide2.QtWidgets.QColorDialog.currentColor()
Return type

QColor

See also

setCurrentColor()

PySide2.QtWidgets.QColorDialog.currentColorChanged(color)
Parameters

color – QColor

static PySide2.QtWidgets.QColorDialog.customColor(index)
Parameters

index – int

Return type

QColor

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

See also

setCustomColor()

static PySide2.QtWidgets.QColorDialog.customCount()
Return type

int

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

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

  • initial – QColor

  • parent – QWidget

  • title – unicode

  • options – ColorDialogOptions

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 isValid() ) color if the user cancels the dialog.

The options argument allows you to customize the dialog.

PySide2.QtWidgets.QColorDialog.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.

PySide2.QtWidgets.QColorDialog.options()
Return type

ColorDialogOptions

See also

setOptions()

PySide2.QtWidgets.QColorDialog.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.

PySide2.QtWidgets.QColorDialog.setCurrentColor(color)
Parameters

color – QColor

See also

currentColor()

static PySide2.QtWidgets.QColorDialog.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()

PySide2.QtWidgets.QColorDialog.setOption(option[, on=true])
Parameters

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

See also

options testOption()

PySide2.QtWidgets.QColorDialog.setOptions(options)
Parameters

options – ColorDialogOptions

See also

options()

static PySide2.QtWidgets.QColorDialog.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 PySide2.QtWidgets.QColorDialog.standardColor(index)
Parameters

index – int

Return type

QColor

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

See also

setStandardColor()

PySide2.QtWidgets.QColorDialog.testOption(option)
Parameters

option – ColorDialogOption

Return type

bool

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

See also

options setOption()