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

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

#include <qgspresetcolorrampdialog.h>

Inheritance diagram for QgsPresetColorRampWidget:
Inheritance graph
[legend]

Signals

void changed ()
 Emitted when the dialog settings change. More...
 
- Signals inherited from QgsPanelWidget
void panelAccepted (QgsPanelWidget *panel)
 Emitted when the panel is accepted by the user. More...
 
void showPanel (QgsPanelWidget *panel)
 Emit when you require a panel to be show in the interface. More...
 
void widgetChanged ()
 Emitted when the widget state changes. More...
 

Public Member Functions

 QgsPresetColorRampWidget (const QgsPresetSchemeColorRamp &ramp, QWidget *parent=nullptr)
 Constructor for QgsPresetColorRampWidget. 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...
 
- Public Member Functions inherited from QgsPanelWidget
 QgsPanelWidget (QWidget *parent=nullptr)
 Base class for any widget that can be shown as a inline panel. More...
 
bool autoDelete ()
 The the auto delete property on the widget. More...
 
void connectChildPanel (QgsPanelWidget *panel)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
 
void connectChildPanels (const QList< QgsPanelWidget *> &panels)
 Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...
 
bool dockMode ()
 Returns the dock mode state. More...
 
virtual QMenu * menuButtonMenu ()
 Returns the menu to use for the menu button for this panel, or nullptr if no menu button is required. More...
 
virtual QString menuButtonTooltip () const
 Returns the (translated) tooltip text to use for the menu button for this panel. More...
 
QString panelTitle ()
 The title of the panel. More...
 
void setAutoDelete (bool autoDelete)
 The the auto delete property on the widget. More...
 
virtual void setDockMode (bool dockMode)
 Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...
 
void setPanelTitle (const QString &panelTitle)
 Set the title of the panel when shown in the interface. More...
 

Properties

QgsPresetSchemeColorRamp ramp
 

Additional Inherited Members

- Public Slots inherited from QgsPanelWidget
void acceptPanel ()
 Accept the panel. More...
 
void openPanel (QgsPanelWidget *panel)
 Open a panel or dialog depending on dock mode setting If dock mode is true this method will emit the showPanel signal for connected slots to handle the open event. More...
 
- Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidgetfindParentPanel (QWidget *widget)
 Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...
 
- Protected Member Functions inherited from QgsPanelWidget
void keyPressEvent (QKeyEvent *event) override
 Overridden key press event to handle the esc event on the widget. More...
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 34 of file qgspresetcolorrampdialog.h.

Constructor & Destructor Documentation

◆ QgsPresetColorRampWidget()

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

Constructor for QgsPresetColorRampWidget.

Parameters
rampinitial ramp to show in dialog
parentparent widget

Definition at line 25 of file qgspresetcolorrampdialog.cpp.

Member Function Documentation

◆ changed

void QgsPresetColorRampWidget::changed ( )
signal

Emitted when the dialog settings change.

◆ ramp()

QgsPresetSchemeColorRamp QgsPresetColorRampWidget::ramp ( ) const

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

See also
setRamp()

◆ setRamp()

void QgsPresetColorRampWidget::setRamp ( const QgsPresetSchemeColorRamp ramp)

Sets the color ramp to show in the dialog.

Parameters
rampcolor ramp
See also
ramp()

Definition at line 50 of file qgspresetcolorrampdialog.cpp.

Property Documentation

◆ ramp

QgsPresetSchemeColorRamp QgsPresetColorRampWidget::ramp
readwrite

Definition at line 37 of file qgspresetcolorrampdialog.h.


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