QgsGradientColorRampDialog Class Reference

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

#include <qgsgradientcolorrampdialog.h>

Inheritance diagram for QgsGradientColorRampDialog:

Public Slots
void	setColor1 (const QColor &color)
	Sets the start color for the gradient ramp.
void	setColor2 (const QColor &color)
	Sets the end color for the gradient ramp.

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

Public Member Functions
	QgsGradientColorRampDialog (const QgsGradientColorRamp &ramp, QWidget *parent=nullptr)
	Constructor for QgsGradientColorRampDialog.
	~QgsGradientColorRampDialog () override
QDialogButtonBox *	buttonBox () const
	Returns a reference to the dialog's button box.
QgsGradientColorRamp	ramp () const
	Returns a color ramp representing the current settings from the dialog.
void	setRamp (const QgsGradientColorRamp &ramp)
	Sets the color ramp to show in the dialog.

Properties
QgsGradientColorRamp	ramp

Detailed Description

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

Since

QGIS 3.0

Definition at line 38 of file qgsgradientcolorrampdialog.h.

Constructor & Destructor Documentation

QgsGradientColorRampDialog()

QgsGradientColorRampDialog::QgsGradientColorRampDialog	(	const QgsGradientColorRamp &	ramp,
		QWidget *	parent = nullptr
	)

Constructor for QgsGradientColorRampDialog.

Parameters

ramp	initial ramp to show in dialog
parent	parent widget

Definition at line 47 of file qgsgradientcolorrampdialog.cpp.

~QgsGradientColorRampDialog()

QgsGradientColorRampDialog::~QgsGradientColorRampDialog ( )

override

Definition at line 192 of file qgsgradientcolorrampdialog.cpp.

Member Function Documentation

buttonBox()

QDialogButtonBox * QgsGradientColorRampDialog::buttonBox

(

)

const

Returns a reference to the dialog's button box.

Since

QGIS 3.10

Definition at line 213 of file qgsgradientcolorrampdialog.cpp.

changed

void QgsGradientColorRampDialog::changed ( )

signal

Emitted when the dialog settings change.

ramp()

QgsGradientColorRamp QgsGradientColorRampDialog::ramp ( ) const

inline

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

See also

setRamp()

Definition at line 57 of file qgsgradientcolorrampdialog.h.

setColor1

void QgsGradientColorRampDialog::setColor1 ( const QColor &  color )

slot

Sets the start color for the gradient ramp.

See also

setColor2()

Definition at line 620 of file qgsgradientcolorrampdialog.cpp.

setColor2

void QgsGradientColorRampDialog::setColor2 ( const QColor &  color )

slot

Sets the end color for the gradient ramp.

See also

setColor1()

Definition at line 626 of file qgsgradientcolorrampdialog.cpp.

setRamp()

void QgsGradientColorRampDialog::setRamp

(

const QgsGradientColorRamp &

ramp

)

Sets the color ramp to show in the dialog.

Parameters

ramp	color ramp

See also

ramp()

Definition at line 202 of file qgsgradientcolorrampdialog.cpp.

Property Documentation

ramp

QgsGradientColorRamp QgsGradientColorRampDialog::ramp

readwrite

Definition at line 41 of file qgsgradientcolorrampdialog.h.

---

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

• /build/qgis-3.34.0+99sid/src/gui/qgsgradientcolorrampdialog.h
• /build/qgis-3.34.0+99sid/src/gui/qgsgradientcolorrampdialog.cpp