QgsCptCityColorRampDialog class

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

Contents

Constructors, destructors, conversion operators

QgsCptCityColorRampDialog(const QgsCptCityColorRamp& ramp, QWidget* parent = nullptr)
Constructor for QgsCptCityColorRampDialog.

Public functions

auto ramp() const -> QgsCptCityColorRamp
Returns a color ramp representing the current settings from the dialog.
auto saveAsGradientRamp() const -> bool
Returns true if the ramp should be converted to a QgsGradientColorRamp.
auto selectedName() const -> QString
Returns the name of the ramp currently selected in the dialog.
void setRamp(const QgsCptCityColorRamp& ramp)
Sets the color ramp to show in the dialog.

Signals

void changed()
Emitted when the dialog settings change.

Function documentation

QgsCptCityColorRampDialog::QgsCptCityColorRampDialog(const QgsCptCityColorRamp& ramp, QWidget* parent = nullptr)

Constructor for QgsCptCityColorRampDialog.

Parameters
ramp initial ramp to show in dialog
parent parent widget

QgsCptCityColorRamp QgsCptCityColorRampDialog::ramp() const

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

void QgsCptCityColorRampDialog::setRamp(const QgsCptCityColorRamp& ramp)

Sets the color ramp to show in the dialog.

Parameters
ramp color ramp