Class: QgsColorSwatchGridAction¶
-
class
qgis.gui.
QgsColorSwatchGridAction
(scheme: QgsColorScheme, menu: QMenu = None, context: str = '', parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QWidgetAction
Construct a new color swatch grid action.
- Parameters
scheme (QgsColorScheme) –
QgsColorScheme
for colors to show in gridmenu (QMenu = None) – parent menu
context (str = '') – context string provided to color scheme
parent (QWidget = None) – parent widget
A color swatch grid which can be embedded into a menu.
See also
Methods
Gets the base color for the color grid
Gets the current context for the color grid
Returns whether the parent menu will be dismissed after a color is selected from the action’s color widget.
Reload colors from scheme and redraws the widget
Sets the base color for the color grid
Sets the current context for the color grid
Sets whether the parent menu should be dismissed and closed when a color is selected from the action’s color widget.
Signals
Emitted when a color has been selected from the widget
-
baseColor
(self) → QColor¶ Gets the base color for the color grid
- Return type
QColor
- Returns
base color which is passed to scheme for color generation
See also
-
childEvent
()¶
-
colorChanged
¶ Emitted when a color has been selected from the widget
- Parameters
color – selected color [signal]
-
connectNotify
()¶
-
context
(self) → str¶ Gets the current context for the color grid
- Return type
str
- Returns
context string which is passed to scheme for color generation
See also
-
createWidget
()¶
-
createdWidgets
()¶
-
customEvent
()¶
-
deleteWidget
()¶
-
disconnectNotify
()¶
-
dismissOnColorSelection
(self) → bool¶ Returns whether the parent menu will be dismissed after a color is selected from the action’s color widget.
See also
New in version 2.14.
- Return type
bool
-
event
()¶
-
eventFilter
()¶
-
isSignalConnected
()¶
-
receivers
()¶
-
refreshColors
(self)¶ Reload colors from scheme and redraws the widget
-
sender
()¶
-
senderSignalIndex
()¶
-
setBaseColor
(self, baseColor: Union[QColor, Qt.GlobalColor, QGradient])¶ Sets the base color for the color grid
- Parameters
baseColor (Union[QColor) – base color to pass to scheme for color generation
See also
-
setContext
(self, context: str)¶ Sets the current context for the color grid
- Parameters
context (str) – string which is passed to scheme for color generation
See also
-
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 to false, the colorChanged signal will be emitted but the menu will stay open.
See also
New in version 2.14.
-
timerEvent
()¶