class QColorDialog#

QColorDialog 提供了一个用于指定颜色的对话框小部件。 更多

Inheritance diagram of PySide6.QtWidgets.QColorDialog

概要#

属性#

方法#

信号#

静态函数#

注意

本文档可能包含自动从C++转换为Python的代码片段。我们始终欢迎对代码片段翻译的贡献。如果您发现翻译存在问题,您也可以通过在https:/bugreports.qt.io/projects/PYSIDE上创建票据来告诉我们。

详细说明#

颜色对话框的功能是允许用户选择颜色。例如,您可以在绘图程序中使用它来允许用户设置画笔颜色。

静态函数提供模态颜色对话框。

静态的 getColor() 函数显示对话框,并允许用户指定一个颜色。此函数也可以用于让用户选择具有透明度的颜色:通过将 ShowAlphaChannel 选项作为附加参数传入。

用户可以存储 customCount() 个不同的自定义颜色。自定义颜色为所有颜色对话框共享,并在程序执行期间保留。使用 setCustomColor() 设置自定义颜色,并使用 customColor() 获取它们。

当按下“拾取屏幕颜色”按钮时,光标变为十字准星,并对屏幕上的颜色进行扫描。用户可以通过单击鼠标或Enter键来选择一个颜色。按Esc键将恢复进入此模式前的最后一个颜色选择。

《标准对话框》示例展示了如何使用 QColorDialog 以及其他内置的 Qt 对话框。

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

另见

QFileDialog QFontDialog 《标准对话框示例》

class ColorDialogOption#

(继承自 enum.Flag) 此枚举指定了影响颜色对话框外观和感受的各种选项。

常量

描述

QColorDialog.ShowAlphaChannel

允许用户选择颜色的alpha组件。

QColorDialog.NoButtons

不显示确定和取消按钮。(对于“实时对话框”很有用。)

QColorDialog.NoEyeDropperButton

隐藏取色器按钮。此值是在 Qt 6.6 中添加的。

QColorDialog.DontUseNativeDialog

使用 Qt 的标准颜色对话框而不是操作系统原生颜色对话框。

另见

options setOption() testOption() windowModality()

注意

当使用 from __feature__ import true_property 时,可以直接使用属性,否则通过访问函数。

property currentColorᅟ: QColor#

此属性持有对话框中当前所选颜色。

访问函数
property optionsᅟ: Combination of QColorDialog.ColorDialogOption#

此属性持有影响对话框外观和感受的各种选项。

默认情况下,所有选项均被禁用。

应在显示对话框之前设置选项。在对话框可见时设置它们不一定立即影响对话框(取决于选项和平台)。

访问函数
__init__(initial[, parent=None])#
参数:

使用指定的 parentinitial 颜色构建颜色对话框。

__init__([parent=None])
参数:

parentQWidget

使用指定的 parent 构建颜色对话框。

colorSelected(color)#
参数:

colorQColor

当用户单击 OK 选择颜色后,将发出此信号。所选颜色由 color 指定。

currentColor()#
返回类型:

QColor

获取属性 currentColor 的 getter。

currentColorChanged(color)#
参数:

colorQColor

每当对话框中的当前颜色更改时,都会发出此信号。当前颜色由 color 指定。

属性 currentColor 的通知信号。

静态customColor(index)#
参数:

index – int

返回类型:

QColor

返回给定 index 的自定义颜色作为 QColor 值。

static customCount()#
返回类型:

int

返回由 QColorDialog 支持的自定义颜色数量。所有颜色对话框都共享相同的自定义颜色。

static getColor([initial=Qt.white[, parent=None[, title=""[, options=QColorDialog.ColorDialogOptions()]]]]])#
参数:
返回类型:

QColor

弹出带有指定窗口标题 title(如果未指定,则为“选择颜色”)的颜色对话框,允许用户选择颜色,并返回该颜色。颜色最初设置为 initial。对话框是 parent 的子窗口。如果用户取消对话框,则返回一个无效的颜色(参见 QColor::isValid())。

参数 options 允许您自定义对话框。

open(receiver, member)#
参数:
  • receiverQObject

  • member – str

打开对话框并连接其 colorSelected() 信号到由 receivermember 指定的槽。

当对话框关闭时,信号将从槽断开。

options()#
返回类型:

ColorDialogOption 的组合

另见

setOptions()

optionsᅟ 属性的获取器。

selectedColor()#
返回类型:

QColor

返回用户通过单击 OK 或等效按钮选择的颜色。

注意

由于用户在选择最终要使用的颜色之前可以选择不同的颜色,因此此颜色不一定与 currentColor 属性持有的颜色相同。

setCurrentColor(color)#
参数:

colorQColor

属性 currentColor 的设置器。

static setCustomColor(index, color)#
参数:
  • index – int

  • colorQColor

将索引为 index 的自定义颜色设置为 QColor 的 color 值。

注意

此功能不适用于 macOS 平台的原生颜色对话框。如果您仍然需要此功能,请使用 DontUseNativeDialog 选项。

另见

customColor()

setOption(option[, on=true])#
参数:

如果 on 为真,则将给定的 option 设置为启用;否则,清除给定的 option

setOptions(options)#
参数:

optionsColorDialogOption 的组合

另见

options()

属性 options 的设置器。

static setStandardColor(index, color)#
参数:
  • index – int

  • colorQColor

将索引为 index 的标准颜色设置为 QColor 的 color 值。

注意

此功能不适用于 macOS 平台的原生颜色对话框。如果您仍然需要此功能,请使用 DontUseNativeDialog 选项。

static standardColor(index)#
参数:

index – int

返回类型:

QColor

以 QColor 值返回给定 index 的标准颜色。

testOption(option)#
参数:

optionColorDialogOption

返回类型:

bool

如果给定的 option 启用,则返回 true;否则,返回 false。