QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
QgsPresetColorRampDialog Class Reference

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

#include <qgspresetcolorrampdialog.h>

Inheritance diagram for QgsPresetColorRampDialog:

Signals

void changed ()
 Emitted when the dialog settings change.

Public Member Functions

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

Properties

QgsPresetSchemeColorRamp ramp

Detailed Description

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

Definition at line 84 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 113 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 131 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 101 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 108 of file qgspresetcolorrampdialog.h.

Property Documentation

◆ ramp

QgsPresetSchemeColorRamp QgsPresetColorRampDialog::ramp
readwrite

Definition at line 87 of file qgspresetcolorrampdialog.h.


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