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. Usecdt
string to define the title to show in the color ramp dialog Use a color schemeregistry
for color swatch grids to show in the drop-down menu. If not specified, the button will use the global color scheme registry insteadA 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.
- Parameters
parent (QWidget = None) –
cdt (str = '') –
registry –
-
class
Behavior
¶ Bases:
int
-
baseClass
¶ alias of
QgsColorButton
-
-
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.
- Return type
bool
- Returns
true if opacity modification is allowed
See also
New in version 3.0.
-
behavior
(self) → QgsColorButton.Behavior¶ Returns the behavior for when the button is clicked.
- Return type
- Returns
behavior when button is clicked
See also
-
changeEvent
(self, e: QEvent)¶ - Parameters
e (QEvent) –
-
checkStateSet
()¶
-
childEvent
()¶
-
closeEvent
()¶
-
color
(self) → QColor¶ Returns the currently selected color.
- Return type
QColor
- Returns
currently selected color
See also
-
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
See also
behavior()
[signal]
-
colorDialogTitle
(self) → str¶ Returns the title for the color chooser dialog window.
- Return type
str
- Returns
title for the color chooser dialog
See also
-
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.
- Return type
- 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.
See also
-
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 customize their display colors based on the context.
- Return type
str
- Returns
context string for the color button’s color swatch grids
See also
-
contextMenuEvent
()¶
-
copyColor
(self)¶ Copies the current color to the clipboard
See also
-
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.
- Return type
QColor
- Returns
default color for the button. Returns an invalid QColor if the default color option is disabled.
See also
-
destroy
()¶
-
disconnectNotify
()¶
-
dragEnterEvent
(self, e: QDragEnterEvent)¶ Reimplemented to accept dragged colors
- Parameters
e (QDragEnterEvent) –
-
dragLeaveEvent
(self, e: QDragLeaveEvent)¶ Reimplemented to reset button appearance after drag leave
- Parameters
e (QDragLeaveEvent) –
-
dragMoveEvent
()¶
-
dropEvent
(self, e: QDropEvent)¶ Reimplemented to accept dropped colors
- Parameters
e (QDropEvent) –
-
enterEvent
()¶
-
event
(self, e: QEvent) → bool¶ - Parameters
e (QEvent) –
- Return type
bool
-
focusInEvent
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPreviousChild
()¶
-
hideEvent
()¶
-
hitButton
()¶
-
initPainter
()¶
-
initStyleOption
()¶
-
inputMethodEvent
()¶
-
isNull
(self) → bool¶ Returns true if the current color is null.
See also
See also
New in version 2.16.
- Return type
bool
-
isSignalConnected
()¶
-
keyPressEvent
(self, e: QKeyEvent)¶ Reimplemented to allow canceling color pick via keypress, and sample via space bar press
- Parameters
e (QKeyEvent) –
-
keyReleaseEvent
()¶
-
leaveEvent
()¶
-
metric
()¶
-
minimumSizeHint
(self) → QSize¶ - Return type
QSize
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
(self, e: QMouseEvent)¶ Reimplemented to allow dragging colors from button
- Parameters
e (QMouseEvent) –
-
mousePressEvent
(self, e: QMouseEvent)¶ Reimplemented to detect right mouse button clicks on the color button and allow dragging colors
- Parameters
e (QMouseEvent) –
-
mouseReleaseEvent
(self, e: QMouseEvent)¶ Reimplemented to allow color picking
- Parameters
e (QMouseEvent) –
-
moveEvent
()¶
-
nativeEvent
()¶
-
nextCheckState
()¶
-
noColorString
(self) → str¶ Returns the string used for the “no color” option in the button’s drop-down menu.
- Return type
str
- Returns
string used for the “no color” menu option
See also
See also
Note
The “no color” option is only shown if the color button is set to show an alpha channel in the color dialog
-
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
-
receivers
()¶
-
resizeEvent
(self, event: QResizeEvent)¶ - Parameters
event (QResizeEvent) –
-
sender
()¶
-
senderSignalIndex
()¶
-
setAllowOpacity
(self, allowOpacity: bool)¶ Sets whether opacity modification (transparency) is permitted for the color. Defaults to false.
- Parameters
allowOpacity (bool) – set to true to allow opacity modification
See also
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 (QgsColorButton.Behavior) – behavior when button is clicked
See also
-
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 (Union[QColor) – 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 (Union[QColor) – new color for the button
See also
-
setColorDialogTitle
(self, title: str)¶ Set the title for the color chooser dialog window.
- Parameters
title (str) – Title for the color chooser dialog
See also
-
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 (QgsColorSchemeRegistry) – color scheme registry for the button. Set to 0 to hide all color swatch grids from the button’s drop-down menu.
See also
-
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 customize their display colors based on the context.
- Parameters
context (str) – context string for the color button’s color swatch grids
See also
-
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 (Union[QColor) – default color for the button. Set to an invalid QColor to disable the default color option.
See also
-
setNoColorString
(self, noColorString: str)¶ Sets the string to use for the “no color” option in the button’s drop-down menu.
- Parameters
noColorString (str) – string to use for the “no color” menu option
See also
See also
Note
The “no color” option is only shown if the color button is set to show an alpha channel in the color dialog
-
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 (bool) – set to false to hide the drop-down menu
See also
-
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 (bool) – set to true to show the no color option. This is disabled by default.
See also
See also
Note
The “no color” option is only shown if the color button is set to show an alpha channel in the color dialog
-
setShowNull
(self, showNull: bool)¶ Sets whether a set to null (clear) option is shown in the button’s drop-down menu.
- Parameters
showNull (bool) – set to true to show a null option
See also
See also
New in version 2.16.
-
setToDefaultColor
(self)¶ Sets color to the button’s default color, if set.
See also
See also
See also
-
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 then the color will not be changed.
See also
-
setToNull
(self)¶ Sets color to null.
See also
See also
New in version 2.16.
-
showEvent
(self, e: QShowEvent)¶ - Parameters
e (QShowEvent) –
-
showMenu
(self) → bool¶ Returns whether the drop-down menu is shown for the button.
- Return type
bool
- Returns
true if drop-down menu is shown
See also
-
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.
- Return type
bool
- Returns
true if the no color option is shown.
See also
See also
Note
The “no color” option is only shown if the color button is set to show an alpha channel in the color dialog
-
showNull
(self) → bool¶ Returns whether the set to null (clear) option is shown in the button’s drop-down menu.
See also
See also
New in version 2.16.
- Return type
bool
-
sizeHint
(self) → QSize¶ - Return type
QSize
-
tabletEvent
()¶
-
timerEvent
()¶
-
transparentBackground
() → QPixmap¶ Returns a checkboard pattern pixmap for use as a background to transparent colors
- Return type
QPixmap
-
updateMicroFocus
()¶
-
wheelEvent
()¶