QGIS API Documentation  3.3.0-Master (4010e79)
Public Slots | Signals | Public Member Functions | Properties | List of all members
QgsGradientColorRampDialog Class Reference

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

#include <qgsgradientcolorrampdialog.h>

Inheritance diagram for QgsGradientColorRampDialog:
Inheritance graph
[legend]

Public Slots

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

Signals

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

Public Member Functions

 QgsGradientColorRampDialog (const QgsGradientColorRamp &ramp, QWidget *parent=nullptr)
 Constructor for QgsGradientColorRampDialog. More...
 
 ~QgsGradientColorRampDialog () override
 
QgsGradientColorRamp ramp () const
 Returns a color ramp representing the current settings from the dialog. More...
 
void setRamp (const QgsGradientColorRamp &ramp)
 Sets the color ramp to show in the dialog. More...
 

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
rampinitial ramp to show in dialog
parentparent widget

Definition at line 44 of file qgsgradientcolorrampdialog.cpp.

◆ ~QgsGradientColorRampDialog()

QgsGradientColorRampDialog::~QgsGradientColorRampDialog ( )
override

Definition at line 161 of file qgsgradientcolorrampdialog.cpp.

Member Function Documentation

◆ 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 564 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 570 of file qgsgradientcolorrampdialog.cpp.

◆ setRamp()

void QgsGradientColorRampDialog::setRamp ( const QgsGradientColorRamp ramp)

Sets the color ramp to show in the dialog.

Parameters
rampcolor ramp
See also
ramp()

Definition at line 172 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: