Class: QgsColorRampButton¶
-
class
qgis.gui.
QgsColorRampButton
(parent: QWidget = None, dialogTitle: str = '')¶ Bases:
PyQt5.QtWidgets.QToolButton
Construct a new color ramp button. Use
parent
to attach a parent QWidget to the dialog. UsedialogTitle
string to define the title to show in the color ramp dialogA cross platform button subclass for selecting color ramps. Will open color ramp dialogs when clicked. Offers live updates to button from color ramp dialog. An attached drop-down menu allows for access to saved color ramps, as well as option to invert the current color ramp and create new ramps.
New in version 3.0: Enums
Methods
Returns whether the button accepts live updates from
QgsColorRampDialog
.Returns a copy of the current color ramp.
Returns the title for the color ramp dialog window.
Returns the name of the current color ramp when it’s available in the style manager
Returns the context string for the color ramp button.
Returns a copy of the default color ramp for the button, which is shown in the button’s drop-down menu for the “default color ramp” option.
Returns true if the current color is null.
Returns true if the current color is null.
Reimplemented to detect right mouse button clicks on the color ramp button
Sets whether the button accepts live updates from
QgsColorRampDialog
.Sets the background pixmap for the button based upon current color ramp.
Sets the current color ramp for the button.
Set the title for the color ramp dialog window.
Sets the current color ramp for the button using a saved color ramp name.
Sets the name of the current color ramp when it’s available in the style manager
Sets the context string for the color ramp button.
Sets the default color ramp for the button, which is shown in the button’s drop-down menu for the “default color ramp” option.
Sets the current color ramp for the button to random colors.
Sets whether the color ramp button only shows gradient type ramps
Sets whether the drop-down menu should be shown for the button.
Sets whether a set to null (clear) option is shown in the button’s drop-down menu.
Sets whether a random colors option is shown in the button’s drop-down menu.
Sets color ramp to the button’s default color ramp, if set.
Sets color ramp to null.
Returns true if the color ramp button only shows gradient type ramps
Returns whether the drop-down menu is shown for the button.
Returns whether the set to null (clear) option is shown in the button’s drop-down menu.
Returns whether random colors option is shown in the button’s drop-down menu.
Signals
Emitted whenever a new color ramp is set for the button.
Attributes
-
acceptLiveUpdates
(self) → bool¶ Returns whether the button accepts live updates from
QgsColorRampDialog
.- Returns
true if the button will be accepted immediately when the dialog’s color ramp changes
See also
-
actionEvent
()¶
-
changeEvent
(self, e: QEvent)¶
-
checkStateSet
()¶
-
childEvent
()¶
-
closeEvent
()¶
-
colorRamp
(self) → QgsColorRamp¶ Returns a copy of the current color ramp.
See also
-
colorRampChanged
¶ Emitted whenever a new color ramp is set for the button. The color ramp is always valid. In case the new color ramp is the same, no signal is emitted to avoid infinite loops. [signal]
-
colorRampDialogTitle
(self) → str¶ Returns the title for the color ramp dialog window.
- Returns
title for the color ramp dialog
See also
-
colorRampName
(self) → str¶ Returns the name of the current color ramp when it’s available in the style manager
See also
-
connectNotify
()¶
-
context
(self) → str¶ Returns the context string for the color ramp button. The context string is passed to all color ramp preview icons shown in the button’s drop-down menu, to (eventually) allow them to customize their display colors based on the context.
- Returns
context context string for the color dialog button’s color ramp preview icons
See also
-
contextMenuEvent
()¶
-
create
()¶
-
customEvent
()¶
-
defaultColorRamp
(self) → QgsColorRamp¶ Returns a copy of the default color ramp for the button, which is shown in the button’s drop-down menu for the “default color ramp” option.
- Returns
default color ramp for the button. Returns a null pointer if the default color ramp option is disabled.
See also
-
destroy
()¶
-
disconnectNotify
()¶
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
dropEvent
()¶
-
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.
See also
See also
-
isRandomColorRamp
(self) → bool¶ Returns true if the current color is null.
See also
See also
-
isSignalConnected
()¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
leaveEvent
()¶
-
metric
()¶
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
(self, e: QMouseEvent)¶ Reimplemented to detect right mouse button clicks on the color ramp button
-
mouseReleaseEvent
()¶
-
moveEvent
()¶
-
nativeEvent
()¶
-
nextCheckState
()¶
-
paintEvent
()¶
-
receivers
()¶
-
resizeEvent
(self, event: QResizeEvent)¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setAcceptLiveUpdates
(self, accept: bool)¶ Sets whether the button accepts live updates from
QgsColorRampDialog
. Live updates may cause changes that are not undoable on QColorRampDialog cancel.- Parameters
accept – set to true to enable live updates
See also
-
setButtonBackground
(self, colorramp: QgsColorRamp = None)¶ Sets the background pixmap for the button based upon current color ramp.
- Parameters
colorramp – Color ramp for button background. If no color ramp is specified, the button’s current color ramp will be used
-
setColorRamp
(self, colorramp: QgsColorRamp)¶ Sets the current color ramp for the button. Will emit a colorRampChanged() signal if the color ramp is different to the previous color ramp.
- Parameters
colorramp – New color ramp for the button. The ramp will be cloned and ownership is not transferred.
See also
-
setColorRampDialogTitle
(self, title: str)¶ Set the title for the color ramp dialog window.
- Parameters
title – Title for the color ramp dialog
See also
-
setColorRampFromName
(self, name: str = '')¶ Sets the current color ramp for the button using a saved color ramp name. Will emit a colorRampChanged() signal if the color ramp is different to the previous color ramp.
- Parameters
name – Name of saved color ramp
See also
-
setColorRampName
(self, name: str)¶ Sets the name of the current color ramp when it’s available in the style manager
- Parameters
name – Name of the saved color ramp
See also
-
setContext
(self, context: str)¶ Sets the context string for the color ramp button. The context string is passed to all color ramp preview icons shown in the button’s drop-down menu, to (eventually) allow them to customize their display colors based on the context.
- Parameters
context – context string for the color dialog button’s color ramp preview icons
See also
-
setDefaultColorRamp
(self, colorramp: QgsColorRamp)¶ Sets the default color ramp for the button, which is shown in the button’s drop-down menu for the “default color ramp” option.
- Parameters
colorramp – default color ramp for the button. Set to a null pointer to disable the default color ramp option. The ramp will be cloned and ownership is not transferred.
See also
-
setRandomColorRamp
(self)¶ Sets the current color ramp for the button to random colors. Will emit a colorRampChanged() signal if the color ramp is different to the previous color ramp.
See also
-
setShowGradientOnly
(self, gradientonly: bool)¶ Sets whether the color ramp button only shows gradient type ramps
- Parameters
gradientonly – set to true to show only gradient type ramps
See also
-
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
-
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
See also
See also
-
setShowRandomColorRamp
(self, showRandom: bool)¶ Sets whether a random colors option is shown in the button’s drop-down menu.
- Parameters
showRandom – set to true to show a random colors option
See also
-
setToDefaultColorRamp
(self)¶ Sets color ramp to the button’s default color ramp, if set.
See also
See also
See also
-
setToNull
(self)¶ Sets color ramp to null.
See also
-
showEvent
(self, e: QShowEvent)¶
-
showGradientOnly
(self) → bool¶ Returns true if the color ramp button only shows gradient type ramps
See also
-
showMenu
(self) → bool¶ Returns whether the drop-down menu is shown for the button.
- Returns
true if drop-down menu is shown
See also
-
showNull
(self) → bool¶ Returns whether the set to null (clear) option is shown in the button’s drop-down menu.
See also
See also
-
showRandomColorRamp
(self) → bool¶ Returns whether random colors option is shown in the button’s drop-down menu.
See also
-
sizeHint
(self) → QSize¶
-
tabletEvent
()¶
-
timerEvent
()¶
-
updateMicroFocus
()¶
-
wheelEvent
()¶
-