Implementation of legend node interface for displaying raster legend entries. More...
#include <qgslayertreemodellegendnode.h>
Inheritance diagram for QgsRasterSymbolLegendNode:
Public Member Functions | |
| QgsRasterSymbolLegendNode (QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent=nullptr) | |
| Constructor for QgsRasterSymbolLegendNode. More... | |
| QVariant | data (int role) const override |
| Returns data associated with the item. Must be implemented in derived class. More... | |
| QSizeF | drawSymbol (const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const override |
| Draws symbol on the left side of the item. More... | |
| QJsonObject | exportSymbolToJson (const QgsLegendSettings &settings, const QgsRenderContext &context) const override |
| Adds a symbol in base64 string within a JSON object with the key "icon". More... | |
 Public Member Functions inherited from QgsLayerTreeModelLegendNode | |
| virtual bool | columnBreak () const |
| Returns whether a forced column break should occur before the node. More... | |
| virtual ItemMetrics | draw (const QgsLegendSettings &settings, ItemContext *ctx) |
| Entry point called from QgsLegendRenderer to do the rendering. More... | |
| virtual QSizeF | drawSymbolText (const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize) const |
| Draws label on the right side of the item. More... | |
| QJsonObject | exportToJson (const QgsLegendSettings &settings, const QgsRenderContext &context) |
| Entry point called from QgsLegendRenderer to do the rendering in a JSON object. More... | |
| virtual Qt::ItemFlags | flags () const |
| Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled. More... | |
| virtual void | invalidateMapBasedData () |
| Notification from model that information from associated map view has changed. More... | |
| virtual bool | isEmbeddedInParent () const |
| virtual bool | isScaleOK (double scale) const |
| QgsLayerTreeLayer * | layerNode () const |
| Returns pointer to the parent layer node. More... | |
| QgsLayerTreeModel * | model () const |
| Returns pointer to model owning this legend node. More... | |
| virtual void | setColumnBreak (bool breakBeforeNode) |
| Sets whether a forced column break should occur before the node. More... | |
| virtual bool | setData (const QVariant &value, int role) |
Sets some data associated with the item. Default implementation does nothing and returns false. More... | |
| virtual void | setEmbeddedInParent (bool embedded) |
| virtual void | setUserLabel (const QString &userLabel) |
| virtual void | setUserPatchSize (QSizeF size) |
| Sets the user (overridden) size for the legend node. More... | |
| virtual QString | userLabel () const |
| virtual QSizeF | userPatchSize () const |
| Returns the user (overridden) size for the legend node. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsLayerTreeModelLegendNode | |
| enum | LegendNodeRoles { RuleKeyRole = Qt::UserRole, ParentRuleKeyRole } |
| Signals inherited from QgsLayerTreeModelLegendNode | |
| void | dataChanged () |
| Emitted on internal data change so the layer tree model can forward the signal to views. More... | |
| void | sizeChanged () |
| Emitted when the size of this node changes. More... | |
| Protected Member Functions inherited from QgsLayerTreeModelLegendNode | |
| QgsLayerTreeModelLegendNode (QgsLayerTreeLayer *nodeL, QObject *parent=nullptr) | |
| Construct the node with pointer to its parent layer node. More... | |
| QgsRenderContext * | createTemporaryRenderContext () const |
Returns a temporary context or nullptr if legendMapViewData are not valid. More... | |
| Protected Attributes inherited from QgsLayerTreeModelLegendNode | |
| bool | mColumnBreakBeforeNode = false |
| bool | mEmbeddedInParent |
| QgsLayerTreeLayer * | mLayerNode = nullptr |
| QgsLegendPatchShape | mPatchShape |
| QString | mUserLabel |
| QSizeF | mUserSize |
Detailed Description
Implementation of legend node interface for displaying raster legend entries.
- Since
- QGIS 2.6
Definition at line 567 of file qgslayertreemodellegendnode.h.
Constructor & Destructor Documentation
◆ QgsRasterSymbolLegendNode()
| QgsRasterSymbolLegendNode::QgsRasterSymbolLegendNode | ( | QgsLayerTreeLayer * | nodeLayer, |
| const QColor & | color, | ||
| const QString & | label, | ||
| QObject * | parent = nullptr |
||
| ) |
Constructor for QgsRasterSymbolLegendNode.
- Parameters
-
nodeLayer layer node color color label label parent attach a parent QObject to the legend node.
Definition at line 891 of file qgslayertreemodellegendnode.cpp.
Member Function Documentation
◆ data()
|
overridevirtual |
Returns data associated with the item. Must be implemented in derived class.
Implements QgsLayerTreeModelLegendNode.
Definition at line 898 of file qgslayertreemodellegendnode.cpp.
◆ drawSymbol()
|
overridevirtual |
Draws symbol on the left side of the item.
- Parameters
-
settings Legend layout configuration ctx Context for rendering - may be nullptrif only doing layout without actual renderingitemHeight Minimal height of the legend item - used for correct positioning when rendering
- Returns
- Real size of the symbol (may be bigger than "normal" symbol size from settings)
Reimplemented from QgsLayerTreeModelLegendNode.
Definition at line 914 of file qgslayertreemodellegendnode.cpp.
◆ exportSymbolToJson()
|
overridevirtual |
Adds a symbol in base64 string within a JSON object with the key "icon".
- Parameters
-
settings Legend layout configuration context Rendering context
- Since
- QGIS 3.8
Reimplemented from QgsLayerTreeModelLegendNode.
Definition at line 972 of file qgslayertreemodellegendnode.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.16.0+99unstable/src/core/layertree/qgslayertreemodellegendnode.h
- /build/qgis-3.16.0+99unstable/src/core/layertree/qgslayertreemodellegendnode.cpp
