Class: QgsColorWidgetAction¶
- class qgis.gui.QgsColorWidgetAction¶
Bases:
PyQt5.QtWidgets.QWidgetAction
An action containing a color widget, which can be embedded into a menu.
See also
New in version 2.14.
QgsColorWidgetAction(colorWidget:
QgsColorWidget
, menu: QMenu = None, parent: QWidget = None) Construct a new color widget action.- Parameters:
colorWidget –
QgsColorWidget
to show in actionmenu – parent menu
parent –
parent widget
Methods
Returns the color widget contained in the widget action.
Returns whether the parent menu will be dismissed after a color is selected from the action's color widget.
Sets whether the parent menu should be dismissed and closed when a color is selected from the action's color widget.
Signals
pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
- childEvent(self, QChildEvent)¶
- colorChanged¶
pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL
types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.
- Parameters:
name (str = ...) –
revision (int = ...) –
arguments (Sequence = ...) –
- Return type:
PYQT_SIGNAL
- colorWidget(self) QgsColorWidget ¶
Returns the color widget contained in the widget action.
- Return type:
- connectNotify(self, QMetaMethod)¶
- createWidget(self, QWidget) QWidget ¶
- createdWidgets(self) List[QWidget] ¶
- customEvent(self, QEvent)¶
- deleteWidget(self, QWidget)¶
- disconnectNotify(self, QMetaMethod)¶
- dismissOnColorSelection(self) bool ¶
Returns whether the parent menu will be dismissed after a color is selected from the action’s color widget.
See also
- Return type:
bool
- event(self, QEvent) bool ¶
- eventFilter(self, QObject, QEvent) bool ¶
- isSignalConnected(self, QMetaMethod) bool ¶
- receivers(self, PYQT_SIGNAL) int ¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- 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 (bool) – set to
True
(default) to immediately close the menu when a color is selected from the widget. If set toFalse
, the colorChanged signal will be emitted but the menu will stay open.
See also
- timerEvent(self, QTimerEvent)¶