Class: QgsCptCityColorRampDialog

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

QgsCptCityColorRampDialog showing the ‘grass/elevation’ color ramp

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.
saveAsGradientRamp	Returns True if the ramp should be converted to a QgsGradientColorRamp.
selectedName	Returns the name of the ramp currently selected in the dialog.
setRamp	Sets the color ramp to show in the dialog.

Signals

changed

Emitted when the dialog settings change

class qgis.gui.QgsCptCityColorRampDialog

Bases: QDialog

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

Constructor for QgsCptCityColorRampDialog.

Parameters:

• ramp (QgsCptCityColorRamp) – 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) → QgsCptCityColorRamp

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

See also

setRamp()

Return type:

QgsCptCityColorRamp

saveAsGradientRamp(self) → bool

Returns True if the ramp should be converted to a QgsGradientColorRamp.

Return type:

bool

selectedName(self) → str

Returns the name of the ramp currently selected in the dialog.

Return type:

str

setRamp(self, ramp: QgsCptCityColorRamp)

Sets the color ramp to show in the dialog.

Parameters:

ramp (QgsCptCityColorRamp) – color ramp

See also

ramp()