Class: QgsGradientColorRampDialog

class qgis.gui.QgsGradientColorRampDialog

Bases: PyQt5.QtWidgets.QDialog

A dialog which allows users to modify the properties of a QgsGradientColorRamp.

New in version 3.0.

QgsGradientColorRampDialog(ramp: QgsGradientColorRamp, parent: QWidget = None) Constructor for QgsGradientColorRampDialog.

actionEvent(self, QActionEvent)
buttonBox(self) QDialogButtonBox

Returns a reference to the dialog’s button box.

New in version 3.10.

Return type


changeEvent(self, QEvent)

Emitted when the dialog settings change [signal]

childEvent(self, QChildEvent)
closeEvent(self, QCloseEvent)
connectNotify(self, QMetaMethod)
contextMenuEvent(self, QContextMenuEvent)
create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)
customEvent(self, QEvent)
destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)
disconnectNotify(self, QMetaMethod)
dragEnterEvent(self, QDragEnterEvent)
dragLeaveEvent(self, QDragLeaveEvent)
dragMoveEvent(self, QDragMoveEvent)
dropEvent(self, QDropEvent)
enterEvent(self, QEvent)
event(self, QEvent) bool
eventFilter(self, QObject, QEvent) bool
focusInEvent(self, QFocusEvent)
focusNextChild(self) bool
focusNextPrevChild(self, bool) bool
focusOutEvent(self, QFocusEvent)
focusPreviousChild(self) bool
hideEvent(self, QHideEvent)
initPainter(self, QPainter)
inputMethodEvent(self, QInputMethodEvent)
isSignalConnected(self, QMetaMethod) bool
keyPressEvent(self, QKeyEvent)
keyReleaseEvent(self, QKeyEvent)
leaveEvent(self, QEvent)
metric(self, QPaintDevice.PaintDeviceMetric) int
mouseDoubleClickEvent(self, QMouseEvent)
mouseMoveEvent(self, QMouseEvent)
mousePressEvent(self, QMouseEvent)
mouseReleaseEvent(self, QMouseEvent)
moveEvent(self, QMoveEvent)
nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) Tuple[bool, int]
paintEvent(self, QPaintEvent)
ramp(self) QgsGradientColorRamp

Returns a color ramp representing the current settings from the dialog.

See also


Return type


receivers(self, PYQT_SIGNAL) int
resizeEvent(self, QResizeEvent)
sender(self) QObject
senderSignalIndex(self) int
setColor1(self, color: Union[QColor, Qt.GlobalColor, QGradient])

Sets the start color for the gradient ramp.

See also



color (Union[QColor) –

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

Sets the end color for the gradient ramp.

See also



color (Union[QColor) –

setRamp(self, ramp: QgsGradientColorRamp)

Sets the color ramp to show in the dialog.


ramp (QgsGradientColorRamp) – color ramp

See also


sharedPainter(self) QPainter
showEvent(self, QShowEvent)
tabletEvent(self, QTabletEvent)
timerEvent(self, QTimerEvent)
wheelEvent(self, QWheelEvent)