QGIS API Documentation 3.37.0-Master (df6056bf1be)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsColorRampLegendNodeDialog Class Reference

A dialog for configuring a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings). More...

#include <qgscolorramplegendnodewidget.h>

Inheritance diagram for QgsColorRampLegendNodeDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsColorRampLegendNodeDialog (const QgsColorRampLegendNodeSettings &settings, QWidget *parent SIP_TRANSFERTHIS=nullptr, QgsColorRampLegendNodeWidget::Capabilities capabilities=QgsColorRampLegendNodeWidget::Capability::AllCapabilities)
 Constructor for QgsColorRampLegendNodeDialog, initially showing the specified settings.
 
QDialogButtonBox * buttonBox () const
 Returns a reference to the dialog's button box.
 
QgsColorRampLegendNodeSettings settings () const
 Returns the legend node settings as defined by the dialog.
 
void setUseContinuousRampCheckBoxVisibility (bool visible)
 Sets visibility for the "Use Continuous Legend" checkbox in the legend settings dialog to visible.
 

Detailed Description

A dialog for configuring a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings).

Since
QGIS 3.18

Definition at line 119 of file qgscolorramplegendnodewidget.h.

Constructor & Destructor Documentation

◆ QgsColorRampLegendNodeDialog()

QgsColorRampLegendNodeDialog::QgsColorRampLegendNodeDialog ( const QgsColorRampLegendNodeSettings settings,
QWidget *parent  SIP_TRANSFERTHIS = nullptr,
QgsColorRampLegendNodeWidget::Capabilities  capabilities = QgsColorRampLegendNodeWidget::Capability::AllCapabilities 
)

Constructor for QgsColorRampLegendNodeDialog, initially showing the specified settings.

Since QGIS 3.38, the capabilities argument can be used to fine-tune settings exposed in the dialog.

Definition at line 169 of file qgscolorramplegendnodewidget.cpp.

Member Function Documentation

◆ buttonBox()

QDialogButtonBox * QgsColorRampLegendNodeDialog::buttonBox ( ) const

Returns a reference to the dialog's button box.

Definition at line 195 of file qgscolorramplegendnodewidget.cpp.

◆ settings()

QgsColorRampLegendNodeSettings QgsColorRampLegendNodeDialog::settings ( ) const

Returns the legend node settings as defined by the dialog.

Definition at line 190 of file qgscolorramplegendnodewidget.cpp.

◆ setUseContinuousRampCheckBoxVisibility()

void QgsColorRampLegendNodeDialog::setUseContinuousRampCheckBoxVisibility ( bool  visible)

Sets visibility for the "Use Continuous Legend" checkbox in the legend settings dialog to visible.

This widget is visible and checked by default but in a few cases it does not need to be visible because disabling it would not make sense (for instance when using single band gray renderer).

Definition at line 200 of file qgscolorramplegendnodewidget.cpp.


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