Class: QgsGradientColorRampDialog

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

Class Hierarchy

Base classes

QDialog
QWidget
QObject
QPaintDevice

Methods

buttonBox	Returns a reference to the dialog's button box.
ramp	Returns a color ramp representing the current settings from the dialog.
setColor1	Sets the start color for the gradient ramp.
setColor2	Sets the end color for the gradient ramp.
setRamp	Sets the color ramp to show in the dialog.

Signals

changed

Emitted when the dialog settings change

class qgis.gui.QgsGradientColorRampDialog

Bases: QDialog

__init__(ramp: QgsGradientColorRamp, parent: QWidget | None = None)

Constructor for QgsGradientColorRampDialog.

Parameters:

• ramp (QgsGradientColorRamp) – initial ramp to show in dialog

• parent (Optional[QWidget] = None) – parent widget

buttonBox(self) → QDialogButtonBox | None

Returns a reference to the dialog’s button box.

Added in version 3.10.

Return type:

Optional[QDialogButtonBox]

signal changed

Emitted when the dialog settings change

ramp(self) → QgsGradientColorRamp

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

See also

setRamp()

Return type:

QgsGradientColorRamp

setColor1(self, color: QColor | Qt.GlobalColor)

Sets the start color for the gradient ramp.

See also

setColor2()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setColor2(self, color: QColor | Qt.GlobalColor)

Sets the end color for the gradient ramp.

See also

setColor1()

Parameters:

color (Union[QColor, Qt.GlobalColor])

setRamp(self, ramp: QgsGradientColorRamp)

Sets the color ramp to show in the dialog.

Parameters:

ramp (QgsGradientColorRamp) – color ramp

See also

ramp()