QGIS API Documentation  3.17.0-Master (57c5a6fc26)
Signals | Public Member Functions | Properties | List of all members
QgsPresetColorRampDialog Class Reference

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

#include <qgspresetcolorrampdialog.h>

Inheritance diagram for QgsPresetColorRampDialog:
Inheritance graph
[legend]

Signals

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

Public Member Functions

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

Properties

QgsPresetSchemeColorRamp ramp
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 86 of file qgspresetcolorrampdialog.h.

Constructor & Destructor Documentation

◆ QgsPresetColorRampDialog()

QgsPresetColorRampDialog::QgsPresetColorRampDialog ( const QgsPresetSchemeColorRamp ramp,
QWidget *  parent = nullptr 
)

Constructor for QgsPresetColorRampDialog.

Parameters
rampinitial ramp to show in dialog
parentparent widget

Definition at line 109 of file qgspresetcolorrampdialog.cpp.

Member Function Documentation

◆ buttonBox()

QDialogButtonBox * QgsPresetColorRampDialog::buttonBox ( ) const

Returns a reference to the dialog's button box.

Since
QGIS 3.10

Definition at line 127 of file qgspresetcolorrampdialog.cpp.

◆ changed

void QgsPresetColorRampDialog::changed ( )
signal

Emitted when the dialog settings change.

◆ ramp()

QgsPresetSchemeColorRamp QgsPresetColorRampDialog::ramp ( ) const
inline

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

See also
setRamp()

Definition at line 104 of file qgspresetcolorrampdialog.h.

◆ setRamp()

void QgsPresetColorRampDialog::setRamp ( const QgsPresetSchemeColorRamp ramp)
inline

Sets the color ramp to show in the dialog.

Parameters
rampcolor ramp
See also
ramp()

Definition at line 111 of file qgspresetcolorrampdialog.h.

Property Documentation

◆ ramp

QgsPresetSchemeColorRamp QgsPresetColorRampDialog::ramp
readwrite

Definition at line 89 of file qgspresetcolorrampdialog.h.


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