Skip to content

PythonQt.QtGui.QColorDialog · declarations 001

Back to PythonQt.QtGui.QColorDialog

ColorDialogOption instance-attribute

ColorDialogOption: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

ColorDialogOptions instance-attribute

ColorDialogOptions: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

DontUseNativeDialog instance-attribute

DontUseNativeDialog: Any

ShowAlphaChannel instance-attribute

ShowAlphaChannel: Any

accepted

accepted(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.accepted; argument details are not documented.

changeEvent

changeEvent(event: Any) -> None

X.changeEvent(event)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QColorDialog::changeEvent(QEvent *e)

Reimplements: QWidget::changeEvent(QEvent *event).

Upstream PySide2 reference signatures (binding differences may apply):

changeEvent(self, event: PySide2.QtCore.QEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#changeEvent

colorSelected

colorSelected(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.colorSelected; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QColorDialog::colorSelected(const QColor \&color)

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 and currentColorChanged().

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#colorSelected

currentColor instance-attribute

currentColor: QColor

Qt 5 reference:

currentColor : QColor

This property holds the currently selected color in the dialog

Access functions:

QColor currentColor() const
void setCurrentColor(const QColor \&color)

Notifier signal:

void currentColorChanged(const QColor \&color)

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#currentColor

currentColorChanged

currentColorChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.currentColorChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QColorDialog::currentColorChanged(const QColor \&color)

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

Note: Notifier signal for property currentColor.

See also color and colorSelected().

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#currentColorChanged

customColor

customColor(index: int) -> Any

X.customColor(index) -> PythonQt.QtGui.QColor

Supplemental documentation: Qt 5 reference:

[static] QColor QColorDialog::customColor(int index)

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

This function was introduced in Qt 4.5.

See also setCustomColor().

Upstream PySide2 reference signatures (binding differences may apply):

customColor(index: int) -> PySide2.QtGui.QColor

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#customColor

customContextMenuRequested

customContextMenuRequested(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.customContextMenuRequested; argument details are not documented.

customCount

customCount() -> int

X.customCount() -> int

Supplemental documentation: Qt 5 reference:

[static] int QColorDialog::customCount()

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

Upstream PySide2 reference signatures (binding differences may apply):

customCount() -> int

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#customCount

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.destroyed; argument details are not documented.

done

done(result: int) -> None

X.done(result)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QColorDialog::done(int result)

Reimplements: QDialog::done(int r).

Closes the dialog and sets its result code to result. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return result.

See also QDialog::done().

Upstream PySide2 reference signatures (binding differences may apply):

done(self, result: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#done

finished

finished(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.finished; argument details are not documented.

getColor

getColor(initial: Any, parent: Any, title: str, options: Any) -> Any

X.getColor(initial, parent, title, options) -> PythonQt.QtGui.QColor

Supplemental documentation: Qt 5 reference:

[static] QColor QColorDialog::getColor(const QColor \&initial \= Qt::white, QWidget *parent \= nullptr, const QString \&title \= QString(), QColorDialog::ColorDialogOptions options \= ColorDialogOptions())

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.

This function was introduced in Qt 4.5.

Upstream PySide2 reference signatures (binding differences may apply):

getColor(initial: PySide2.QtGui.QColor=..., parent: typing.Optional[PySide2.QtWidgets.QWidget]=..., title: str=..., options: PySide2.QtWidgets.QColorDialog.ColorDialogOptions=...) -> PySide2.QtGui.QColor

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#getColor

getRgba

getRgba(rgba: Any, ok: Any, parent: Any) -> int

X.getRgba(rgba, ok, parent) -> int

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.objectNameChanged; argument details are not documented.

open

open() -> None

X.open()

Supplemental documentation: Qt 5 reference:

void QColorDialog::open(QObject *receiver, const char *member)

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.

This function was introduced in Qt 4.5.

Upstream PySide2 reference signatures (binding differences may apply):

open(self) -> None
open(self, receiver: PySide2.QtCore.QObject, member: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#open

options instance-attribute

options: Any

Qt 5 reference:

options : ColorDialogOptions

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

Access functions:

QColorDialog::ColorDialogOptions options() const
void setOptions(QColorDialog::ColorDialogOptions options)

See also setOption() and testOption().

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#options

rejected

rejected(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.rejected; argument details are not documented.

selectedColor

selectedColor() -> Any

X.selectedColor() -> PythonQt.QtGui.QColor

Supplemental documentation: Qt 5 reference:

QColor QColorDialog::selectedColor() const

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.

Upstream PySide2 reference signatures (binding differences may apply):

selectedColor(self) -> PySide2.QtGui.QColor

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#selectedColor

setCurrentColor

setCurrentColor(color: Any) -> None

X.setCurrentColor(color)

Upstream PySide2 reference signatures (binding differences may apply):

setCurrentColor(self, color: PySide2.QtGui.QColor) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#setCurrentColor

setCustomColor

setCustomColor(index: int, color: Any) -> None

X.setCustomColor(index, color)

Supplemental documentation: Qt 5 reference:

[static] void QColorDialog::setCustomColor(int index, QColor color)

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 QColorDialog::DontUseNativeDialog option.

See also customColor().

Upstream PySide2 reference signatures (binding differences may apply):

setCustomColor(index: int, color: PySide2.QtGui.QColor) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#setCustomColor

setOption

setOption(option: Any, on: bool) -> None

X.setOption(option, on)

Supplemental documentation: Qt 5 reference:

void QColorDialog::setOption(QColorDialog::ColorDialogOption option, bool on \= true)

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

See also options and testOption().

Upstream PySide2 reference signatures (binding differences may apply):

setOption(self, option: PySide2.QtWidgets.QColorDialog.ColorDialogOption, on: bool=...) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#setOption

setOptions

setOptions(options: Any) -> None

X.setOptions(options)

Upstream PySide2 reference signatures (binding differences may apply):

setOptions(self, options: PySide2.QtWidgets.QColorDialog.ColorDialogOptions) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#setOptions

setStandardColor

setStandardColor(index: int, color: Any) -> None

X.setStandardColor(index, color)

Supplemental documentation: Qt 5 reference:

[static] void QColorDialog::setStandardColor(int index, QColor color)

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 QColorDialog::DontUseNativeDialog option.

See also standardColor().

Upstream PySide2 reference signatures (binding differences may apply):

setStandardColor(index: int, color: PySide2.QtGui.QColor) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#setStandardColor

setVisible

setVisible(visible: bool) -> None

X.setVisible(visible)

Supplemental documentation: Qt 5 reference:

[override virtual] void QColorDialog::setVisible(bool visible)

Reimplements: QDialog::setVisible(bool visible).

Changes the visibility of the dialog. If visible is true, the dialog is shown; otherwise, it is hidden.

Upstream PySide2 reference signatures (binding differences may apply):

setVisible(self, visible: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#setVisible

standardColor

standardColor(index: int) -> Any

X.standardColor(index) -> PythonQt.QtGui.QColor

Supplemental documentation: Qt 5 reference:

[static] QColor QColorDialog::standardColor(int index)

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

This function was introduced in Qt 5.0.

See also setStandardColor().

Upstream PySide2 reference signatures (binding differences may apply):

standardColor(index: int) -> PySide2.QtGui.QColor

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#standardColor

testOption

testOption(option: Any) -> bool

X.testOption(option) -> bool

Supplemental documentation: Qt 5 reference:

bool QColorDialog::testOption(QColorDialog::ColorDialogOption option) const

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

This function was introduced in Qt 4.5.

See also options and setOption().

Upstream PySide2 reference signatures (binding differences may apply):

testOption(self, option: PySide2.QtWidgets.QColorDialog.ColorDialogOption) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qcolordialog.html#testOption

windowIconChanged

windowIconChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.windowIconChanged; argument details are not documented.

windowIconTextChanged

windowIconTextChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.windowIconTextChanged; argument details are not documented.

windowTitleChanged

windowTitleChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QColorDialog.windowTitleChanged; argument details are not documented.