Class: QgsColorBox¶

class qgis.gui.QgsColorBox¶

Bases: QgsColorWidget

A color box widget. This widget consists of a two dimensional rectangle filled with color variations, where a different color component varies along both the horizontal and vertical axis.

Added in version 2.5.

QgsColorBox(parent: Optional[QWidget] = None, component: QgsColorWidget.ColorComponent = QgsColorWidget.Value) Construct a new color box widget.

Parameters:

parent – parent QWidget for the widget

component –

constant color component for the widget. The color components: which vary along the horizontal and vertical axis are automatically assigned based on this constant color component.

Methods

`actionEvent`
`alterColor`	Alters a color by modifying the value of a specific color component
`changeEvent`
`childEvent`
`closeEvent`
`componentRange`	Returns the range of valid values for the color widget's component
`componentValue`	Returns the current value of the widget's color component
`connectNotify`
`contextMenuEvent`
`create`
`customEvent`
`destroy`
`disconnectNotify`
`dragEnterEvent`
`dragLeaveEvent`
`dragMoveEvent`
`dropEvent`
`enterEvent`
`event`
`focusInEvent`
`focusNextChild`
`focusNextPrevChild`
`focusOutEvent`
`focusPreviousChild`
`hideEvent`
`hue`	Returns the hue for the widget.
`initPainter`
`inputMethodEvent`
`isSignalConnected`
`keyPressEvent`
`keyReleaseEvent`
`leaveEvent`
`metric`
`mouseDoubleClickEvent`
`mouseMoveEvent`	param event:
`mousePressEvent`	param event:
`mouseReleaseEvent`	param event:
`moveEvent`
`nativeEvent`
`paintEvent`	param event:
`receivers`
`resizeEvent`	param event:
`sender`
`senderSignalIndex`
`setColor`	param color:
`setComponent`	param component:
`sharedPainter`
`showEvent`
`sizeHint`	rtype: QSize
`tabletEvent`
`timerEvent`
`transparentBackground`	Generates a checkboard pattern pixmap for use as a background to transparent colors
`updateMicroFocus`
`wheelEvent`

actionEvent(self, a0: QActionEvent | None)¶

alterColor(self, color: QColor | Qt.GlobalColor, component: QgsColorWidget.ColorComponent, newValue: int)¶

Alters a color by modifying the value of a specific color component

Parameters:

color – color to alter
component – color component to alter
newValue – new value of color component. Values are automatically clipped to a valid range for the color component.

changeEvent(self, a0: QEvent | None)¶

childEvent(self, a0: QChildEvent | None)¶

closeEvent(self, a0: QCloseEvent | None)¶

componentRange(self) → int¶

Returns the range of valid values for the color widget’s component

Returns:: maximum value allowed for color component, or -1 if widget has multiple components

componentRange(self, component: QgsColorWidget.ColorComponent) -> int Returns the range of valid values a color component

Returns:: maximum value allowed for color component

componentValue(self) → int¶

Returns the current value of the widget’s color component

Returns:: value of color component, or -1 if widget has multiple components or an invalid color set