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

#include <qgscptcitycolorrampdialog.h>

Inheritance diagram for QgsCptCityColorRampDialog:

Signals
void	changed ()
	Emitted when the dialog settings change. More...

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

QDialogButtonBox *	buttonBox () const
	Returns a reference to the dialog's button box. More...

bool	eventFilter (QObject obj, QEvent event) override

QgsCptCityColorRamp	ramp () const
	Returns a color ramp representing the current settings from the dialog. More...

bool	saveAsGradientRamp () const
	Returns `true` if the ramp should be converted to a QgsGradientColorRamp. More...

QString	selectedName () const
	Returns the name of the ramp currently selected in the dialog. More...

void	setRamp (const QgsCptCityColorRamp &ramp)
	Sets the color ramp to show in the dialog. More...

Properties
QgsCptCityColorRamp	ramp

Detailed Description

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

Since: QGIS 3.0

Definition at line 42 of file qgscptcitycolorrampdialog.h.

Constructor & Destructor Documentation

◆ QgsCptCityColorRampDialog()

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

Constructor for QgsCptCityColorRampDialog.

Parameters

ramp	initial ramp to show in dialog
parent	parent widget

Definition at line 40 of file qgscptcitycolorrampdialog.cpp.

Member Function Documentation

◆ buttonBox()

QDialogButtonBox * QgsCptCityColorRampDialog::buttonBox ( ) const

Returns a reference to the dialog's button box.

Since: QGIS 3.10

Definition at line 508 of file qgscptcitycolorrampdialog.cpp.

◆ changed

void QgsCptCityColorRampDialog::changed ( )

signal

Emitted when the dialog settings change.

◆ eventFilter()

bool QgsCptCityColorRampDialog::eventFilter	(	QObject *	obj,
		QEvent *	event
	)

override

Definition at line 551 of file qgscptcitycolorrampdialog.cpp.

◆ ramp()

QgsCptCityColorRamp QgsCptCityColorRampDialog::ramp ( ) const

inline

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

See also: setRamp()

Definition at line 60 of file qgscptcitycolorrampdialog.h.

◆ saveAsGradientRamp()

bool QgsCptCityColorRampDialog::saveAsGradientRamp ( ) const

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

Definition at line 501 of file qgscptcitycolorrampdialog.cpp.

◆ selectedName()

QString QgsCptCityColorRampDialog::selectedName ( ) const

inline

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

Definition at line 72 of file qgscptcitycolorrampdialog.h.

◆ setRamp()

void QgsCptCityColorRampDialog::setRamp ( const QgsCptCityColorRamp & ramp )

Sets the color ramp to show in the dialog.

Parameters

ramp	color ramp

See also: ramp()

Definition at line 132 of file qgscptcitycolorrampdialog.cpp.

Property Documentation

◆ ramp

QgsCptCityColorRamp QgsCptCityColorRampDialog::ramp

readwrite

Definition at line 1 of file qgscptcitycolorrampdialog.h.

The documentation for this class was generated from the following files:

/build/qgis-3.16.0+99unstable/src/gui/symbology/qgscptcitycolorrampdialog.h
/build/qgis-3.16.0+99unstable/src/gui/symbology/qgscptcitycolorrampdialog.cpp

Signals

Public Member Functions

Properties