Class: QgsColorRampLegendNodeDialog¶

A dialog for configuring a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings).

Added in version 3.18.

Class Hierarchy¶

Base classes¶

QDialog
QWidget
QObject
QPaintDevice

Methods

`buttonBox`	Returns a reference to the dialog's button box.
`setUseContinuousRampCheckBoxVisibility`	Sets visibility for the "Use Continuous Legend" checkbox in the legend settings dialog to visible.
`settings`	Returns the legend node settings as defined by the dialog.

class qgis.gui.QgsColorRampLegendNodeDialog[source]¶

Bases: QDialog

__init__(settings: QgsColorRampLegendNodeSettings, parent: QWidget | None = None, capabilities: QgsColorRampLegendNodeWidget.Capabilities | QgsColorRampLegendNodeWidget.Capability = 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.

Parameters:

settings (QgsColorRampLegendNodeSettings)
parent (Optional[QWidget] = None)
capabilities (Union[QgsColorRampLegendNodeWidget.Capabilities, QgsColorRampLegendNodeWidget.Capability] = QgsColorRampLegendNodeWidget.Capability.AllCapabilities)

buttonBox(self) → QDialogButtonBox | None[source]¶

Returns a reference to the dialog’s button box.

Return type:: Optional[QDialogButtonBox]

setUseContinuousRampCheckBoxVisibility(self, visible: bool)[source]¶

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).

Parameters:: visible (bool)

settings(self) → QgsColorRampLegendNodeSettings[source]¶

Returns the legend node settings as defined by the dialog.

Return type:: QgsColorRampLegendNodeSettings