Class: QgsColorWidgetAction¶

class qgis.gui.QgsColorWidgetAction(colorWidget: QgsColorWidget, menu: QMenu = None, parent: QWidget = None)¶

Bases: PyQt5.QtWidgets.QWidgetAction

Construct a new color widget action.

Parameters

An action containing a color widget, which can be embedded into a menu.

See also

New in version 2.14: Enums

Methods

`childEvent`
`colorWidget`	Returns the color widget contained in the widget action.
`connectNotify`
`createWidget`
`createdWidgets`
`customEvent`
`deleteWidget`
`disconnectNotify`
`dismissOnColorSelection`	Returns whether the parent menu will be dismissed after a color is selected from the action’s color widget.
`event`
`eventFilter`
`isSignalConnected`
`receivers`
`sender`
`senderSignalIndex`
`setDismissOnColorSelection`	Sets whether the parent menu should be dismissed and closed when a color is selected from the action’s color widget.
`timerEvent`

Signals

Emitted when a color has been selected from the widget

Attributes

colorChanged¶

Emitted when a color has been selected from the widget

colorWidget(self) → QgsColorWidget¶: Returns the color widget contained in the widget action.

dismissOnColorSelection(self) → bool¶: Returns whether the parent menu will be dismissed after a color is selected from the action’s color widget.

See also

setDismissOnColorSelection()

setDismissOnColorSelection(self, dismiss: bool)¶

Sets whether the parent menu should be dismissed and closed when a color is selected from the action’s color widget.

Parameters: dismiss – set to true (default) to immediately close the menu when a color is selected from the widget. If set to false, the colorChanged signal will be emitted but the menu will stay open.