Implementation of legend node interface for displaying arbitrary label with icon. More...
#include <qgslayertreemodellegendnode.h>
Inheritance diagram for QgsSimpleLegendNode:
Public Member Functions | |
| QgsSimpleLegendNode (QgsLayerTreeLayer *nodeLayer, const QString &label, const QIcon &icon=QIcon(), QObject *parent=nullptr, const QString &key=QString()) | |
| Constructor for QgsSimpleLegendNode. | |
| QVariant | data (int role) const override |
| Returns data associated with the item. Must be implemented in derived class. | |
 Public Member Functions inherited from QgsLayerTreeModelLegendNode | |
| virtual bool | columnBreak () const |
| Returns whether a forced column break should occur before the node. | |
| virtual ItemMetrics | draw (const QgsLegendSettings &settings, ItemContext *ctx) |
| Entry point called from QgsLegendRenderer to do the rendering. | |
| virtual QSizeF | drawSymbol (const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const |
| Draws symbol on the left side of the item. | |
| virtual QSizeF | drawSymbolText (const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize) const |
| Draws label on the right side of the item. | |
| virtual QJsonObject | exportSymbolToJson (const QgsLegendSettings &settings, const QgsRenderContext &context) const |
| Adds a symbol in base64 string within a JSON object with the key "icon". | |
| QJsonObject | exportToJson (const QgsLegendSettings &settings, const QgsRenderContext &context) |
| Entry point called from QgsLegendRenderer to do the rendering in a JSON object. | |
| virtual Qt::ItemFlags | flags () const |
| Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled. | |
| virtual void | invalidateMapBasedData () |
| Notification from model that information from associated map view has changed. | |
| virtual bool | isEmbeddedInParent () const |
| virtual bool | isScaleOK (double scale) const |
| QgsLayerTreeLayer * | layerNode () const |
| Returns pointer to the parent layer node. | |
| QgsLayerTreeModel * | model () const |
| Returns pointer to model owning this legend node. | |
| virtual void | setColumnBreak (bool breakBeforeNode) |
| Sets whether a forced column break should occur before the node. | |
| virtual bool | setData (const QVariant &value, int role) |
Sets some data associated with the item. Default implementation does nothing and returns false. | |
| 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. | |
| virtual QString | userLabel () const |
| virtual QSizeF | userPatchSize () const |
| Returns the user (overridden) size for the legend node. | |
Additional Inherited Members | |
| Public Types inherited from QgsLayerTreeModelLegendNode | |
| enum class | CustomRole : int { RuleKey = Qt::UserRole , ParentRuleKey , NodeType , IsDataDefinedSize } |
| Legend node data roles. More... | |
| enum | NodeTypes { SimpleLegend , SymbolLegend , RasterSymbolLegend , ImageLegend , WmsLegend , DataDefinedSizeLegend , EmbeddedWidget , ColorRampLegend } |
| Types of legend nodes. More... | |
| Public Slots inherited from QgsLayerTreeModelLegendNode | |
| void | checkAllItems () |
| Checks all checkable items belonging to the same layer as this node. | |
| void | toggleAllItems () |
| Toggle all checkable items belonging to the same layer as this node. | |
| void | uncheckAllItems () |
| Unchecks all checkable items belonging to the same layer as this node. | |
| Signals inherited from QgsLayerTreeModelLegendNode | |
| void | dataChanged () |
| Emitted on internal data change so the layer tree model can forward the signal to views. | |
| void | sizeChanged () |
| Emitted when the size of this node changes. | |
| Protected Member Functions inherited from QgsLayerTreeModelLegendNode | |
| QgsLayerTreeModelLegendNode (QgsLayerTreeLayer *nodeL, QObject *parent=nullptr) | |
| Construct the node with pointer to its parent layer node. | |
| QgsRenderContext * | createTemporaryRenderContext () const |
Returns a temporary context or nullptr if legendMapViewData are not valid. | |
| 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 arbitrary label with icon.
Definition at line 592 of file qgslayertreemodellegendnode.h.
Constructor & Destructor Documentation
◆ QgsSimpleLegendNode()
| QgsSimpleLegendNode::QgsSimpleLegendNode | ( | QgsLayerTreeLayer * | nodeLayer, |
| const QString & | label, | ||
| const QIcon & | icon = QIcon(), |
||
| QObject * | parent = nullptr, |
||
| const QString & | key = QString() |
||
| ) |
Constructor for QgsSimpleLegendNode.
- Parameters
-
nodeLayer layer node label label icon icon parent attach a parent QObject to the legend node. key the rule key
Definition at line 994 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 1002 of file qgslayertreemodellegendnode.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/layertree/qgslayertreemodellegendnode.h
- /build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/layertree/qgslayertreemodellegendnode.cpp
