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. Use dialogTitle string to define the title to show in the color ramp dialog

A 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.

Parameters
  • parent (QWidget = None) –

  • dialogTitle

acceptLiveUpdates(self) → bool

Returns whether the button accepts live updates from QgsColorRampDialog.

Return type

bool

Returns

True if the button will be accepted immediately when the dialog’s color ramp changes

actionEvent()
changeEvent(self, e: QEvent)
Parameters

e (QEvent) –

checkStateSet()
childEvent()
closeEvent()
colorRamp(self) → QgsColorRamp

Returns a copy of the current color ramp.

See also

setColorRamp()

Return type

QgsColorRamp

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.

Return type

str

Returns

title for the color ramp dialog

colorRampName(self) → str

Returns the name of the current color ramp when it’s available in the style manager

Return type

str

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.

Return type

str

Returns

context context string for the color dialog button’s color ramp preview icons

See also

setContext()

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.

Return type

QgsColorRamp

Returns

default color ramp for the button. Returns None if the default color ramp option is disabled.

destroy()
disconnectNotify()
dragEnterEvent()
dragLeaveEvent()
dragMoveEvent()
dropEvent()
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

setShowNull()

See also

showNull()

Return type

bool

isRandomColorRamp(self) → bool

Returns True if the current color is null.

See also

setShowNull()

See also

showNull()

Return type

bool

isSignalConnected()
keyPressEvent()
keyReleaseEvent()
leaveEvent()
metric()
mouseDoubleClickEvent()
mouseMoveEvent()
mousePressEvent(self, e: QMouseEvent)

Reimplemented to detect right mouse button clicks on the color ramp button

Parameters

e (QMouseEvent) –

mouseReleaseEvent()
moveEvent()
nativeEvent()
nextCheckState()
paintEvent()
receivers()
resizeEvent(self, event: QResizeEvent)
Parameters

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 (bool) – set to True to enable live updates

setButtonBackground(self, colorramp: QgsColorRamp = None)

Sets the background pixmap for the button based upon current color ramp.

Parameters

colorramp (QgsColorRamp = None) – 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 (QgsColorRamp) – New color ramp for the button. The ramp will be cloned and ownership is not transferred.

setColorRampDialogTitle(self, title: str)

Set the title for the color ramp dialog window.

Parameters

title (str) – Title for the color ramp dialog

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 (str = '') – Name of saved color ramp

See also

setColorRamp()

setColorRampName(self, name: str)

Sets the name of the current color ramp when it’s available in the style manager

Parameters

name (str) – Name of the saved color ramp

See also

colorRampName()

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 (str) – context string for the color dialog button’s color ramp preview icons

See also

context()

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 (QgsColorRamp) – default color ramp for the button. Set to None to disable the default color ramp option. The ramp will be cloned and ownership is not transferred.

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

setColorRamp()

setShowGradientOnly(self, gradientonly: bool)

Sets whether the color ramp button only shows gradient type ramps

Parameters

gradientonly (bool) – set to True to show only gradient type ramps

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

showMenu()

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

showNull()

See also

isNull()

setShowRandomColorRamp(self, showRandom: bool)

Sets whether a random colors option is shown in the button’s drop-down menu.

Parameters

showRandom (bool) – set to True to show a random colors option

setToDefaultColorRamp(self)

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

See also

setToNull()

setToNull(self)

Sets color ramp to null.

sharedPainter()
showEvent(self, e: QShowEvent)
Parameters

e (QShowEvent) –

showGradientOnly(self) → bool

Returns True if the color ramp button only shows gradient type ramps

Return type

bool

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

setShowMenu()

showNull(self) → bool

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

See also

setShowNull()

See also

isNull()

Return type

bool

showRandomColorRamp(self) → bool

Returns whether random colors option is shown in the button’s drop-down menu.

Return type

bool

sizeHint(self) → QSize
Return type

QSize

tabletEvent()
timerEvent()
updateMicroFocus()
wheelEvent()