Subgroup: Color

Class: QgsColorButton

class qgis.gui.QgsColorButton(parent: QWidget = None, cdt: str = '', registry: QgsColorSchemeRegistry = None)

Bases: PyQt5.QtWidgets.QToolButton

Construct a new color ramp button. Use parent to attach a parent QWidget to the dialog. Use cdt string to define the title to show in the color ramp dialog Use a color scheme registry for color swatch grids to show in the drop-down menu. If not specified, the button will use the global color scheme registry instead

A cross platform button subclass for selecting colors. Will open a color chooser dialog when clicked. Offers live updates to button from color chooser dialog. An attached drop-down menu allows for copying and pasting colors, picking colors from the screen, and selecting colors from color swatch grids.

New in version 2.5: Methods

actionEvent
activatePicker Activates the color picker tool, which allows for sampling a color from anywhere on the screen
allowOpacity Returns whether opacity modification (transparency) is permitted for the color.
behavior Returns the behavior for when the button is clicked.
changeEvent
checkStateSet
childEvent
closeEvent
color Return the currently selected color.
colorDialogTitle Returns the title for the color chooser dialog window.
colorSchemeRegistry Returns the color scheme registry for the button, which controls the color swatch grids that are shown in the button’s drop-down menu.
connectNotify
context Returns the context string for the color button.
contextMenuEvent
copyColor Copies the current color to the clipboard
create
customEvent
defaultColor Returns the default color for the button, which is shown in the button’s drop-down menu for the “default color” option.
destroy
disconnectNotify
dragEnterEvent Reimplemented to accept dragged colors
dragLeaveEvent Reimplemented to reset button appearance after drag leave
dragMoveEvent
dropEvent Reimplemented to accept dropped colors
enterEvent
event
focusInEvent
focusNextChild
focusNextPrevChild
focusOutEvent
focusPreviousChild
hideEvent
hitButton
initPainter
initStyleOption
inputMethodEvent
isNull Returns true if the current color is null.
isSignalConnected
keyPressEvent Reimplemented to allow canceling color pick via keypress, and sample via space bar press
keyReleaseEvent
leaveEvent
metric
minimumSizeHint
mouseDoubleClickEvent
mouseMoveEvent Reimplemented to allow dragging colors from button
mousePressEvent Reimplemented to detect right mouse button clicks on the color button and allow dragging colors
mouseReleaseEvent Reimplemented to allow color picking
moveEvent
nativeEvent
nextCheckState
noColorString Returns the string used for the “no color” option in the button’s drop-down menu.
paintEvent
pasteColor Pastes a color from the clipboard to the color button.
receivers
resizeEvent
sender
senderSignalIndex
setAllowOpacity Sets whether opacity modification (transparency) is permitted for the color.
setBehavior Sets the behavior for when the button is clicked.
setButtonBackground Sets the background pixmap for the button based upon color and transparency.
setColor Sets the current color for the button.
setColorDialogTitle Set the title for the color chooser dialog window.
setColorSchemeRegistry Sets the color scheme registry for the button, which controls the color swatch grids that are shown in the button’s drop-down menu.
setContext Sets the context string for the color button.
setDefaultColor Sets the default color for the button, which is shown in the button’s drop-down menu for the “default color” option.
setNoColorString Sets the string to use for the “no color” option in the button’s drop-down menu.
setShowMenu Sets whether the drop-down menu should be shown for the button.
setShowNoColor Sets whether the “no color” option should be shown in the button’s drop-down menu.
setShowNull Sets whether a set to null (clear) option is shown in the button’s drop-down menu.
setToDefaultColor Sets color to the button’s default color, if set.
setToNoColor Sets color to a totally transparent color.
setToNull Sets color to null.
sharedPainter
showEvent
showMenu Returns whether the drop-down menu is shown for the button.
showNoColor Returns whether the “no color” option is shown in the button’s drop-down menu.
showNull Returns whether the set to null (clear) option is shown in the button’s drop-down menu.
sizeHint
tabletEvent
timerEvent
transparentBackground Returns a checkboard pattern pixmap for use as a background to transparent colors
updateMicroFocus
wheelEvent

Signals

colorChanged Is emitted whenever a new color is set for the button.
colorClicked Emitted when the button is clicked, if the button’s behavior is set to SignalOnly

Attributes

ShowDialog
SignalOnly
class Behavior

Bases: int

ShowDialog = 0
SignalOnly = 1
actionEvent()
activatePicker(self)

Activates the color picker tool, which allows for sampling a color from anywhere on the screen

allowOpacity(self) → bool

Returns whether opacity modification (transparency) is permitted for the color.

Returns:true if opacity modification is allowed

New in version 3.0.

behavior(self) → QgsColorButton.Behavior

Returns the behavior for when the button is clicked.

Returns:behavior when button is clicked

See also

setBehavior()

changeEvent(self, e: QEvent)
checkStateSet()
childEvent()
closeEvent()
color(self) → QColor

Return the currently selected color.

Returns:currently selected color

See also

setColor()

colorChanged

Is emitted whenever a new color is set for the button. The color is always valid. In case the new color is the same no signal is emitted, to avoid infinite loops.

Parameters:color – New color [signal]
colorClicked

Emitted when the button is clicked, if the button’s behavior is set to SignalOnly

Parameters:color – button color

See also

setBehavior()

See also

behavior() [signal]

colorDialogTitle(self) → str

Returns the title for the color chooser dialog window.

Returns:title for the color chooser dialog
colorSchemeRegistry(self) → QgsColorSchemeRegistry

Returns the color scheme registry for the button, which controls the color swatch grids that are shown in the button’s drop-down menu.

Returns:color scheme registry for the button. If returned value is 0 then all color

swatch grids are hidden from the button’s drop-down menu.

connectNotify()
context(self) → str

Returns the context string for the color button. The context string is passed to all color swatch grids shown in the button’s drop-down menu, to allow them to customise their display colors based on the context.

Returns:context string for the color button’s color swatch grids

See also

setContext()

contextMenuEvent()
copyColor(self)

Copies the current color to the clipboard

See also

pasteColor()

create()
customEvent()
defaultColor(self) → QColor

Returns the default color for the button, which is shown in the button’s drop-down menu for the “default color” option.

Returns:default color for the button. Returns an invalid QColor if the default color

option is disabled.

destroy()
disconnectNotify()
dragEnterEvent(self, e: QDragEnterEvent)

Reimplemented to accept dragged colors

dragLeaveEvent(self, e: QDragLeaveEvent)

Reimplemented to reset button appearance after drag leave

dragMoveEvent()
dropEvent(self, e: QDropEvent)

Reimplemented to accept dropped colors

enterEvent()
event(self, e: QEvent) → bool
focusInEvent()
focusNextChild()
focusNextPrevChild()
focusOutEvent()
focusPreviousChild()
hideEvent()
hitButton()
initPainter()
initStyleOption()
inputMethodEvent()
isNull(self) → bool

Returns true if the current color is null.

New in version 2.16.

See also

setShowNull()

See also

showNull()

isSignalConnected()
keyPressEvent(self, e: QKeyEvent)

Reimplemented to allow canceling color pick via keypress, and sample via space bar press

keyReleaseEvent()
leaveEvent()
metric()
minimumSizeHint(self) → QSize
mouseDoubleClickEvent()
mouseMoveEvent(self, e: QMouseEvent)

Reimplemented to allow dragging colors from button

mousePressEvent(self, e: QMouseEvent)

Reimplemented to detect right mouse button clicks on the color button and allow dragging colors

mouseReleaseEvent(self, e: QMouseEvent)

Reimplemented to allow color picking

moveEvent()
nativeEvent()
nextCheckState()
noColorString(self) → str

Returns the string used for the “no color” option in the button’s drop-down menu.

Returns:string used for the “no color” menu option

See also

showNoColor()

Note

The “no color” option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

paintEvent()
pasteColor(self)

Pastes a color from the clipboard to the color button. If clipboard does not contain a valid color or string representation of a color, then no change is applied.

See also

copyColor()

receivers()
resizeEvent(self, event: QResizeEvent)
sender()
senderSignalIndex()
setAllowOpacity(self, allowOpacity: bool)

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

Parameters:allowOpacity – set to true to allow opacity modification

See also

allowOpacity()

New in version 3.0.

setBehavior(self, behavior: QgsColorButton.Behavior)

Sets the behavior for when the button is clicked. The default behavior is to show a color picker dialog.

Parameters:behavior – behavior when button is clicked

See also

behavior()

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

Sets the background pixmap for the button based upon color and transparency. Call directly to update background after adding/removing QColorDialog.ShowAlphaChannel option but the color has not changed, i.e. setColor() wouldn’t update button and you want the button to retain the set color’s alpha component regardless

Parameters:color – Color for button background. If no color is specified, the button’s current

color will be used

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

Sets the current color for the button. Will emit a colorChanged signal if the color is different to the previous color.

Parameters:color – new color for the button

See also

color()

setColorDialogTitle(self, title: str)

Set the title for the color chooser dialog window.

Parameters:title – Title for the color chooser dialog
setColorSchemeRegistry(self, registry: QgsColorSchemeRegistry)

Sets the color scheme registry for the button, which controls the color swatch grids that are shown in the button’s drop-down menu.

Parameters:registry – color scheme registry for the button. Set to 0 to hide all color

swatch grids from the button’s drop-down menu.

setContext(self, context: str)

Sets the context string for the color button. The context string is passed to all color swatch grids shown in the button’s drop-down menu, to allow them to customise their display colors based on the context.

Parameters:context – context string for the color button’s color swatch grids

See also

context()

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

Sets the default color for the button, which is shown in the button’s drop-down menu for the “default color” option.

Parameters:color – default color for the button. Set to an invalid QColor to disable the default color

option.

See also

defaultColor()

setNoColorString(self, noColorString: str)

Sets the string to use for the “no color” option in the button’s drop-down menu.

Parameters:noColorString – string to use for the “no color” menu option

See also

noColorString()

See also

setShowNoColor()

Note

The “no color” option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

setShowMenu(self, showMenu: bool)

Sets whether the drop-down menu should be shown for the button. The default behavior is to show the menu.

Parameters:showMenu – set to false to hide the drop-down menu

See also

showMenu()

setShowNoColor(self, showNoColorOption: bool)

Sets whether the “no color” option should be shown in the button’s drop-down menu. If selected, the “no color” option sets the color button’s color to a totally transparent color.

Parameters:showNoColorOption – set to true to show the no color option. This is disabled by default.

See also

showNoColor()

Note

The “no color” option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

setShowNull(self, showNull: bool)

Sets whether a set to null (clear) option is shown in the button’s drop-down menu.

Parameters:showNull – set to true to show a null option

New in version 2.16.

See also

showNull()

See also

isNull()

setToDefaultColor(self)

Sets color to the button’s default color, if set.

See also

defaultColor()

See also

setToNull()

setToNoColor(self)

Sets color to a totally transparent color.

Note

If the color button is not set to show an opacity channel in the color dialog (see setColorDialogOptions) then the color will not be changed.

See also

setToNull()

setToNull(self)

Sets color to null.

See also

setToNoColor()

New in version 2.16.

sharedPainter()
showEvent(self, e: QShowEvent)
showMenu(self) → bool

Returns whether the drop-down menu is shown for the button.

Returns:true if drop-down menu is shown

See also

setShowMenu()

showNoColor(self) → bool

Returns whether the “no color” option is shown in the button’s drop-down menu. If selected, the “no color” option sets the color button’s color to a totally transparent color.

Returns:true if the no color option is shown.

See also

setShowNoColor()

See also

noColorString()

Note

The “no color” option is only shown if the color button is set to show an alpha channel in the color dialog (see setColorDialogOptions)

showNull(self) → bool

Returns whether the set to null (clear) option is shown in the button’s drop-down menu.

New in version 2.16.

See also

setShowNull()

See also

isNull()

sizeHint(self) → QSize
tabletEvent()
timerEvent()
transparentBackground() → QPixmap

Returns a checkboard pattern pixmap for use as a background to transparent colors

updateMicroFocus()
wheelEvent()