QGIS API Documentation  3.22.4-Białowieża (ce8e65e95e)
Signals | Public Member Functions | Properties | List of all members
QgsColorBrewerColorRampDialog Class Reference

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

#include <qgscolorbrewercolorrampdialog.h>

Inheritance diagram for QgsColorBrewerColorRampDialog:
Inheritance graph
[legend]

Signals

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

Public Member Functions

 QgsColorBrewerColorRampDialog (const QgsColorBrewerColorRamp &ramp, QWidget *parent=nullptr)
 Constructor for QgsColorBrewerColorRampDialog. More...
 
QDialogButtonBox * buttonBox () const
 Returns a reference to the dialog's button box. More...
 
QgsColorBrewerColorRamp ramp () const
 Returns a color ramp representing the current settings from the dialog. More...
 
void setRamp (const QgsColorBrewerColorRamp &ramp)
 Sets the color ramp to show in the dialog. More...
 

Properties

QgsColorBrewerColorRamp ramp
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 86 of file qgscolorbrewercolorrampdialog.h.

Constructor & Destructor Documentation

◆ QgsColorBrewerColorRampDialog()

QgsColorBrewerColorRampDialog::QgsColorBrewerColorRampDialog ( const QgsColorBrewerColorRamp ramp,
QWidget *  parent = nullptr 
)

Constructor for QgsColorBrewerColorRampDialog.

Parameters
rampinitial ramp to show in dialog
parentparent widget

Definition at line 125 of file qgscolorbrewercolorrampdialog.cpp.

Member Function Documentation

◆ buttonBox()

QDialogButtonBox * QgsColorBrewerColorRampDialog::buttonBox ( ) const

Returns a reference to the dialog's button box.

Since
QGIS 3.10

Definition at line 142 of file qgscolorbrewercolorrampdialog.cpp.

◆ changed

void QgsColorBrewerColorRampDialog::changed ( )
signal

Emitted when the dialog settings change.

◆ ramp()

QgsColorBrewerColorRamp QgsColorBrewerColorRampDialog::ramp ( ) const
inline

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

See also
setRamp()

Definition at line 104 of file qgscolorbrewercolorrampdialog.h.

◆ setRamp()

void QgsColorBrewerColorRampDialog::setRamp ( const QgsColorBrewerColorRamp ramp)
inline

Sets the color ramp to show in the dialog.

Parameters
rampcolor ramp
See also
ramp()

Definition at line 111 of file qgscolorbrewercolorrampdialog.h.

Property Documentation

◆ ramp

QgsColorBrewerColorRamp QgsColorBrewerColorRampDialog::ramp
readwrite

Definition at line 77 of file qgscolorbrewercolorrampdialog.h.


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