Class: QgsColorDialog

class qgis.gui.QgsColorDialog(parent: QWidget = None, fl: Union[Qt.WindowFlags, Qt.WindowType] = QgsGuiUtils.ModalDialogFlags, color: Union[QColor, Qt.GlobalColor, QGradient] = QColor())

Bases: PyQt5.QtWidgets.QDialog

Create a new color picker dialog

Parameters
  • parent (QWidget = None) – parent widget

  • fl (Union[Qt.WindowFlags) – window flags

  • color (Union[QColor) – initial color for dialog

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.

actionEvent()
changeEvent()
childEvent()
closeEvent(self, e: QCloseEvent)
Parameters

e (QCloseEvent) –

color(self) → QColor

Returns the current color for the dialog

Return type

QColor

Returns

dialog color

connectNotify()
contextMenuEvent()
create()
currentColorChanged

Emitted when the dialog’s color changes

Parameters

color (Union[QColor) – current color [signal]

customEvent()
destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
enterEvent()
event()
eventFilter()
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
getColor(initialColor: Union[QColor, Qt.GlobalColor, QGradient], parent: QWidget, title: str = '', allowOpacity: bool = False) → QColor

Returns a color selection from a color dialog.

Parameters
  • initialColor (Union[QColor) – the initial color of the selection dialog.

  • parent (QWidget) – parent widget

  • title (str = '') – the title of the dialog.

  • allowOpacity (bool = False) – set to True to allow modification of color opacity value (transparency)

Return type

QColor

Returns

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

hideEvent()
initPainter()
inputMethodEvent()
isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent()
mouseReleaseEvent()
moveEvent()
nativeEvent()
paintEvent()
receivers()
resizeEvent()
sender()
senderSignalIndex()
setAllowOpacity(self, allowOpacity: bool)

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

Parameters

allowOpacity (bool) – set to False to disable opacity modification

New in version 3.0.

setColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the current color for the dialog

Parameters

color (Union[QColor) – desired color

setTitle(self, title: str)

Sets the title for the color dialog

Parameters

title (str) – title for dialog box

sharedPainter()
showEvent()
tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()