A widget for properties relating to a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings). More...

#include <qgscolorramplegendnodewidget.h>

Inheritance diagram for QgsColorRampLegendNodeWidget:

[legend]

Public Types
typedef QFlags< Capability >	Capabilities
	Capabilities to expose in the widget.

enum class	Capability : int SIP_ENUM_BASETYPE(IntFlag) { Prefix = 1 << 0 , Suffix = 1 << 1 , NumberFormat = 1 << 2 , DefaultMinimum = 1 << 3 , DefaultMaximum = 1 << 4 , AllCapabilities = Prefix \| Suffix \| NumberFormat \| DefaultMinimum \| DefaultMaximum }
	Capabilities to expose in the widget. More...

Public Member Functions
	QgsColorRampLegendNodeWidget (QWidget *parent=nullptr, QgsColorRampLegendNodeWidget::Capabilities capabilities=QgsColorRampLegendNodeWidget::Capability::AllCapabilities)
	Constructor for QgsColorRampLegendNodeWidget, with the specified parent widget.

void	setSettings (const QgsColorRampLegendNodeSettings &settings)
	Sets the settings to show in the widget.

QgsColorRampLegendNodeSettings	settings () const
	Returns the legend node settings as defined by the widget.

void	setUseContinuousRampCheckBoxVisibility (bool visible)
	Sets visibility for the "Use Continuous Legend" checkbox to visible.

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel.

virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in.

bool	autoDelete ()
	The the auto delete property on the widget.

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.

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.

bool	dockMode ()
	Returns the dock mode state.

virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required.

virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel.

QString	panelTitle ()
	The title of the panel.

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget.

virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface.

Additional Inherited Members
Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel.

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.

Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user.

void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface.

void	widgetChanged ()
	Emitted when the widget state changes.

Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget.

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget.

Detailed Description

A widget for properties relating to a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings).

The current settings are set by a call to setSettings(), and the settings defined by the widget are retrieved by calling settings().

When changes are made the to settings by a user the widgetChanged() signal is emitted.

Since: QGIS 3.18

Definition at line 40 of file qgscolorramplegendnodewidget.h.

Member Typedef Documentation

◆ Capabilities

typedef QFlags< Capability > QgsColorRampLegendNodeWidget::Capabilities

Capabilities to expose in the widget.

Since: QGIS 3.38

Definition at line 67 of file qgscolorramplegendnodewidget.h.

Member Enumeration Documentation

◆ Capability

enum class QgsColorRampLegendNodeWidget::Capability : int SIP_ENUM_BASETYPE(IntFlag)

strong

Capabilities to expose in the widget.

Since: QGIS 3.38

Enumerator
Prefix	Allow editing legend prefix.
Suffix	Allow editing legend suffix.
NumberFormat	Allow editing number format.
DefaultMinimum	Allow resetting minimum label to default.
DefaultMaximum	Allow resetting maximum label to default.
AllCapabilities	All capabilities.

Definition at line 51 of file qgscolorramplegendnodewidget.h.

Constructor & Destructor Documentation

◆ QgsColorRampLegendNodeWidget()

QgsColorRampLegendNodeWidget::QgsColorRampLegendNodeWidget	(	QWidget *	parent = `nullptr`,
		QgsColorRampLegendNodeWidget::Capabilities	capabilities = `QgsColorRampLegendNodeWidget::Capability::AllCapabilities`
	)

Constructor for QgsColorRampLegendNodeWidget, with the specified parent widget.

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

Definition at line 25 of file qgscolorramplegendnodewidget.cpp.

Member Function Documentation

◆ setSettings()

void QgsColorRampLegendNodeWidget::setSettings ( const QgsColorRampLegendNodeSettings & settings )

Sets the settings to show in the widget.

See also: settings()

Definition at line 104 of file qgscolorramplegendnodewidget.cpp.

◆ settings()

QgsColorRampLegendNodeSettings QgsColorRampLegendNodeWidget::settings ( ) const

Returns the legend node settings as defined by the widget.

See also: setSettings()

Definition at line 89 of file qgscolorramplegendnodewidget.cpp.

◆ setUseContinuousRampCheckBoxVisibility()

void QgsColorRampLegendNodeWidget::setUseContinuousRampCheckBoxVisibility ( bool visible )

Sets visibility for the "Use Continuous Legend" checkbox 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 121 of file qgscolorramplegendnodewidget.cpp.

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

/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/qgscolorramplegendnodewidget.h
/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/gui/qgscolorramplegendnodewidget.cpp

Public Types

Public Member Functions

Additional Inherited Members