A widget for properties relating to a QgsColorRampLegendNode (QgsColorRampLegendNodeSettings). More...
#include <qgscolorramplegendnodewidget.h>
Public Member Functions | |
| QgsColorRampLegendNodeWidget (QWidget *parent=nullptr) | |
| Constructor for QgsColorRampLegendNodeWidget, with the specified parent widget. More... | |
| void | setSettings (const QgsColorRampLegendNodeSettings &settings) |
| Sets the settings to show in the widget. More... | |
| QgsColorRampLegendNodeSettings | settings () const |
| Returns the legend node settings as defined by the widget. More... | |
| void | setUseContinuousRampCheckBoxVisibility (bool visible) |
| Sets visibility for the "Use Continuous Legend" checkbox to visible. 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... | |
| 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. 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... | |
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... | |
| 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... | |
| 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. 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 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 41 of file qgscolorramplegendnodewidget.h.
Constructor & Destructor Documentation
◆ QgsColorRampLegendNodeWidget()
| QgsColorRampLegendNodeWidget::QgsColorRampLegendNodeWidget | ( | QWidget * | parent = nullptr | ) |
Constructor for QgsColorRampLegendNodeWidget, with the specified parent widget.
Definition at line 24 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 73 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 58 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 90 of file qgscolorramplegendnodewidget.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.20.0+99unstable/src/gui/qgscolorramplegendnodewidget.h
- /build/qgis-3.20.0+99unstable/src/gui/qgscolorramplegendnodewidget.cpp
