QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
Implementation of legend node interface for displaying raster legend entries. More...
#include <qgslayertreemodellegendnode.h>
Public Member Functions | |
QgsRasterSymbolLegendNode (QgsLayerTreeLayer *nodeLayer, const QColor &color, const QString &label, QObject *parent=nullptr, bool isCheckable=false, const QString &ruleKey=QString()) | |
Constructor for QgsRasterSymbolLegendNode. | |
QVariant | data (int role) const override |
Returns data associated with the item. Must be implemented in derived class. | |
QSizeF | drawSymbol (const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const override |
Draws symbol on the left side of the item. | |
QJsonObject | exportSymbolToJson (const QgsLegendSettings &settings, const QgsRenderContext &context) const override |
Adds a symbol in base64 string within a JSON object with the key "icon". | |
Qt::ItemFlags | flags () const override |
Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled. | |
bool | isCheckable () const |
Returns whether the item is user-checkable - whether renderer supports enabling/disabling it. | |
QString | ruleKey () const |
Returns the unique identifier of node for identification of the item within renderer. | |
bool | setData (const QVariant &value, int role) override |
Sets some data associated with the item. Default implementation does nothing and returns false . | |
![]() | |
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 | drawSymbolText (const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize) const |
Draws label on the right side of the item. | |
QJsonObject | exportToJson (const QgsLegendSettings &settings, const QgsRenderContext &context) |
Entry point called from QgsLegendRenderer to do the rendering in a JSON object. | |
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 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 | |
![]() | |
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... | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
bool | mColumnBreakBeforeNode = false |
bool | mEmbeddedInParent |
QgsLayerTreeLayer * | mLayerNode = nullptr |
QgsLegendPatchShape | mPatchShape |
QString | mUserLabel |
QSizeF | mUserSize |
Implementation of legend node interface for displaying raster legend entries.
Definition at line 668 of file qgslayertreemodellegendnode.h.
QgsRasterSymbolLegendNode::QgsRasterSymbolLegendNode | ( | QgsLayerTreeLayer * | nodeLayer, |
const QColor & | color, | ||
const QString & | label, | ||
QObject * | parent = nullptr , |
||
bool | isCheckable = false , |
||
const QString & | ruleKey = QString() |
||
) |
Constructor for QgsRasterSymbolLegendNode.
nodeLayer | layer node |
color | color |
label | label |
parent | attach a parent QObject to the legend node. |
isCheckable | set to true to enable the checkbox for the node (since QGIS 3.18) |
ruleKey | optional identifier to allow a unique ID to be assigned to the node by a renderer (since QGIS 3.18) |
Definition at line 1073 of file qgslayertreemodellegendnode.cpp.
|
overridevirtual |
Returns data associated with the item. Must be implemented in derived class.
Implements QgsLayerTreeModelLegendNode.
Definition at line 1090 of file qgslayertreemodellegendnode.cpp.
|
overridevirtual |
Draws symbol on the left side of the item.
settings | Legend layout configuration |
ctx | Context for rendering - may be nullptr if only doing layout without actual rendering |
itemHeight | Minimal height of the legend item - used for correct positioning when rendering |
Reimplemented from QgsLayerTreeModelLegendNode.
Definition at line 1164 of file qgslayertreemodellegendnode.cpp.
|
overridevirtual |
Adds a symbol in base64 string within a JSON object with the key "icon".
settings | Legend layout configuration |
context | Rendering context |
Reimplemented from QgsLayerTreeModelLegendNode.
Definition at line 1222 of file qgslayertreemodellegendnode.cpp.
|
overridevirtual |
Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled.
Reimplemented from QgsLayerTreeModelLegendNode.
Definition at line 1082 of file qgslayertreemodellegendnode.cpp.
|
inline |
Returns whether the item is user-checkable - whether renderer supports enabling/disabling it.
Definition at line 703 of file qgslayertreemodellegendnode.h.
|
inline |
Returns the unique identifier of node for identification of the item within renderer.
Definition at line 696 of file qgslayertreemodellegendnode.h.
|
overridevirtual |
Sets some data associated with the item. Default implementation does nothing and returns false
.
Reimplemented from QgsLayerTreeModelLegendNode.
Definition at line 1133 of file qgslayertreemodellegendnode.cpp.