QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | Static Public Attributes | List of all members
QgsSymbolLegendNode Class Reference

Implementation of legend node interface for displaying preview of vector symbols and their labels and allowing interaction with the symbol / renderer. More...

#include <qgslayertreemodellegendnode.h>

Inheritance diagram for QgsSymbolLegendNode:
Inheritance graph
[legend]

Public Member Functions

 QgsSymbolLegendNode (QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItem &item, QObject *parent=nullptr)
 Constructor for QgsSymbolLegendNode. More...
 
 ~QgsSymbolLegendNode ()
 
QgsSymbolcustomSymbol () const
 Returns the node's custom symbol. 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...
 
QString evaluateLabel (const QgsExpressionContext &context=QgsExpressionContext(), const QString &label=QString())
 Evaluates and returns the text label of the current node. 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...
 
Qt::ItemFlags flags () const override
 Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled. More...
 
QSize iconSize () const
 
void invalidateMapBasedData () override
 Notification from model that information from associated map view has changed. More...
 
bool isScaleOK (double scale) const override
 
QSize minimumIconSize () const
 Calculates the minimum icon size to prevent cropping. More...
 
QSize minimumIconSize (QgsRenderContext *context) const
 Calculates the minimum icon size to prevent cropping. More...
 
QgsLegendPatchShape patchShape () const
 Returns the symbol patch shape to use when rendering the legend node symbol. More...
 
void setCustomSymbol (QgsSymbol *symbol)
 Sets the node's custom symbol. More...
 
bool setData (const QVariant &value, int role) override
 Sets some data associated with the item. Default implementation does nothing and returns false. More...
 
void setEmbeddedInParent (bool embedded) override
 
void setIconSize (QSize sz)
 Set the icon size. More...
 
void setPatchShape (const QgsLegendPatchShape &shape)
 Sets the symbol patch shape to use when rendering the legend node symbol. More...
 
void setSymbol (QgsSymbol *symbol)
 Sets the symbol to be used by the legend node. More...
 
void setTextOnSymbolLabel (const QString &label)
 Sets label of text to be shown on top of the symbol. More...
 
void setTextOnSymbolTextFormat (const QgsTextFormat &format)
 Sets format of text to be shown on top of the symbol. More...
 
void setUserLabel (const QString &userLabel) override
 
const QgsSymbolsymbol () const
 Returns the symbol used by the legend node. More...
 
QString symbolLabel () const
 Label of the symbol, user defined label will be used, otherwise will default to the label made by QGIS. More...
 
QString textOnSymbolLabel () const
 Returns label of text to be shown on top of the symbol. More...
 
QgsTextFormat textOnSymbolTextFormat () const
 Returns text format of the label to be shown on top of the symbol. More...
 
- Public Member Functions inherited from QgsLayerTreeModelLegendNode
virtual bool columnBreak () const
 Returns whether a forced column break should occur before the node. More...
 
virtual QVariant data (int role) const =0
 Returns data associated with the item. Must be implemented in derived class. More...
 
virtual ItemMetrics draw (const QgsLegendSettings &settings, ItemContext *ctx)
 Entry point called from QgsLegendRenderer to do the rendering. More...
 
virtual QSizeF drawSymbol (const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const
 Draws symbol on the left side of the item. More...
 
virtual QSizeF drawSymbolText (const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize) const
 Draws label on the right side of the item. More...
 
virtual QJsonObject exportSymbolToJson (const QgsLegendSettings &settings, const QgsRenderContext &context) const
 Adds a symbol in base64 string within a JSON object with the key "icon". 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
 
QgsLayerTreeLayerlayerNode () const
 Returns pointer to the parent layer node. More...
 
QgsLayerTreeModelmodel () 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...
 

Static Public Attributes

static double MAXIMUM_SIZE = -1.0
 
static double MINIMUM_SIZE = -1.0
 

Additional Inherited Members

- Public Types inherited from QgsLayerTreeModelLegendNode
enum  LegendNodeRoles { RuleKeyRole = Qt::UserRole , ParentRuleKeyRole , NodeTypeRole }
 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. More...
 
void toggleAllItems ()
 Toggle all checkable items belonging to the same layer as this node. More...
 
void uncheckAllItems ()
 Unchecks all checkable items belonging to the same layer as this node. More...
 
- 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...
 
QgsRenderContextcreateTemporaryRenderContext () const
 Returns a temporary context or nullptr if legendMapViewData are not valid. More...
 
- Protected Attributes inherited from QgsLayerTreeModelLegendNode
bool mColumnBreakBeforeNode = false
 
bool mEmbeddedInParent
 
QgsLayerTreeLayermLayerNode = nullptr
 
QgsLegendPatchShape mPatchShape
 
QString mUserLabel
 
QSizeF mUserSize
 

Detailed Description

Implementation of legend node interface for displaying preview of vector symbols and their labels and allowing interaction with the symbol / renderer.

Since
QGIS 2.6

Definition at line 358 of file qgslayertreemodellegendnode.h.

Constructor & Destructor Documentation

◆ QgsSymbolLegendNode()

QgsSymbolLegendNode::QgsSymbolLegendNode ( QgsLayerTreeLayer nodeLayer,
const QgsLegendSymbolItem item,
QObject *  parent = nullptr 
)

Constructor for QgsSymbolLegendNode.

Parameters
nodeLayerlayer node
itemthe legend symbol item
parentattach a parent QObject to the legend node.

Definition at line 296 of file qgslayertreemodellegendnode.cpp.

◆ ~QgsSymbolLegendNode()

QgsSymbolLegendNode::~QgsSymbolLegendNode ( )
default

Member Function Documentation

◆ customSymbol()

QgsSymbol * QgsSymbolLegendNode::customSymbol ( ) const

Returns the node's custom symbol.

If a non-nullptr value is returned, then this symbol will be used for rendering the legend node instead of the default symbol().

See also
setCustomSymbol()
Since
QGIS 3.14

Definition at line 423 of file qgslayertreemodellegendnode.cpp.

◆ data()

QVariant QgsSymbolLegendNode::data ( int  role) const
overridevirtual

Returns data associated with the item. Must be implemented in derived class.

Implements QgsLayerTreeModelLegendNode.

Definition at line 512 of file qgslayertreemodellegendnode.cpp.

◆ drawSymbol()

QSizeF QgsSymbolLegendNode::drawSymbol ( const QgsLegendSettings settings,
ItemContext ctx,
double  itemHeight 
) const
overridevirtual

Draws symbol on the left side of the item.

Parameters
settingsLegend layout configuration
ctxContext for rendering - may be nullptr if only doing layout without actual rendering
itemHeightMinimal 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 615 of file qgslayertreemodellegendnode.cpp.

◆ evaluateLabel()

QString QgsSymbolLegendNode::evaluateLabel ( const QgsExpressionContext context = QgsExpressionContext(),
const QString &  label = QString() 
)

Evaluates and returns the text label of the current node.

Parameters
contextextra QgsExpressionContext to use for evaluating the expression
labeltext to evaluate instead of the layer layertree string
Since
QGIS 3.10

Definition at line 865 of file qgslayertreemodellegendnode.cpp.

◆ exportSymbolToJson()

QJsonObject QgsSymbolLegendNode::exportSymbolToJson ( const QgsLegendSettings settings,
const QgsRenderContext context 
) const
overridevirtual

Adds a symbol in base64 string within a JSON object with the key "icon".

Parameters
settingsLegend layout configuration
contextRendering context
Since
QGIS 3.8

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 764 of file qgslayertreemodellegendnode.cpp.

◆ flags()

Qt::ItemFlags QgsSymbolLegendNode::flags ( ) const
overridevirtual

Returns item flags associated with the item. Default implementation returns Qt::ItemIsEnabled.

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 327 of file qgslayertreemodellegendnode.cpp.

◆ iconSize()

QSize QgsSymbolLegendNode::iconSize ( ) const
inline
Since
QGIS 2.10

Definition at line 398 of file qgslayertreemodellegendnode.h.

◆ invalidateMapBasedData()

void QgsSymbolLegendNode::invalidateMapBasedData ( )
overridevirtual

Notification from model that information from associated map view has changed.

Default implementation does nothing.

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 832 of file qgslayertreemodellegendnode.cpp.

◆ isScaleOK()

bool QgsSymbolLegendNode::isScaleOK ( double  scale) const
inlineoverridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 388 of file qgslayertreemodellegendnode.h.

◆ minimumIconSize() [1/2]

QSize QgsSymbolLegendNode::minimumIconSize ( ) const

Calculates the minimum icon size to prevent cropping.

When evaluating the size for multiple icons it is more efficient to create a single render context in advance and use the variant which accepts a QgsRenderContext argument.

Since
QGIS 2.10

Definition at line 336 of file qgslayertreemodellegendnode.cpp.

◆ minimumIconSize() [2/2]

QSize QgsSymbolLegendNode::minimumIconSize ( QgsRenderContext context) const

Calculates the minimum icon size to prevent cropping.

When evaluating the size for multiple icons it is more efficient to create a single render context in advance and call this method instead of minimumIconSize().

Since
QGIS 2.18

Definition at line 342 of file qgslayertreemodellegendnode.cpp.

◆ patchShape()

QgsLegendPatchShape QgsSymbolLegendNode::patchShape ( ) const

Returns the symbol patch shape to use when rendering the legend node symbol.

See also
setPatchShape()
Since
QGIS 3.14

Definition at line 406 of file qgslayertreemodellegendnode.cpp.

◆ setCustomSymbol()

void QgsSymbolLegendNode::setCustomSymbol ( QgsSymbol symbol)

Sets the node's custom symbol.

If a non-nullptr value is set, then this symbol will be used for rendering the legend node instead of the default symbol().

Ownership of symbol is transferred.

See also
customSymbol()
Since
QGIS 3.14

Definition at line 428 of file qgslayertreemodellegendnode.cpp.

◆ setData()

bool QgsSymbolLegendNode::setData ( const QVariant &  value,
int  role 
)
overridevirtual

Sets some data associated with the item. Default implementation does nothing and returns false.

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 591 of file qgslayertreemodellegendnode.cpp.

◆ setEmbeddedInParent()

void QgsSymbolLegendNode::setEmbeddedInParent ( bool  embedded)
overridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 825 of file qgslayertreemodellegendnode.cpp.

◆ setIconSize()

void QgsSymbolLegendNode::setIconSize ( QSize  sz)
inline

Set the icon size.

Since
QGIS 2.10

Definition at line 396 of file qgslayertreemodellegendnode.h.

◆ setPatchShape()

void QgsSymbolLegendNode::setPatchShape ( const QgsLegendPatchShape shape)

Sets the symbol patch shape to use when rendering the legend node symbol.

See also
patchShape()
Since
QGIS 3.14

Definition at line 418 of file qgslayertreemodellegendnode.cpp.

◆ setSymbol()

void QgsSymbolLegendNode::setSymbol ( QgsSymbol symbol)

Sets the symbol to be used by the legend node.

The symbol change is also propagated to the associated vector layer's renderer.

Parameters
symbolnew symbol for node. Ownership is transferred.
See also
symbol()
Since
QGIS 2.14

Definition at line 433 of file qgslayertreemodellegendnode.cpp.

◆ setTextOnSymbolLabel()

void QgsSymbolLegendNode::setTextOnSymbolLabel ( const QString &  label)
inline

Sets label of text to be shown on top of the symbol.

Since
QGIS 3.2

Definition at line 443 of file qgslayertreemodellegendnode.h.

◆ setTextOnSymbolTextFormat()

void QgsSymbolLegendNode::setTextOnSymbolTextFormat ( const QgsTextFormat format)
inline

Sets format of text to be shown on top of the symbol.

Since
QGIS 3.2

Definition at line 455 of file qgslayertreemodellegendnode.h.

◆ setUserLabel()

void QgsSymbolLegendNode::setUserLabel ( const QString &  userLabel)
inlineoverridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 386 of file qgslayertreemodellegendnode.h.

◆ symbol()

const QgsSymbol * QgsSymbolLegendNode::symbol ( ) const

Returns the symbol used by the legend node.

See also
setSymbol()
Since
QGIS 2.14

Definition at line 387 of file qgslayertreemodellegendnode.cpp.

◆ symbolLabel()

QString QgsSymbolLegendNode::symbolLabel ( ) const

Label of the symbol, user defined label will be used, otherwise will default to the label made by QGIS.

Since
QGIS 3.10

Definition at line 392 of file qgslayertreemodellegendnode.cpp.

◆ textOnSymbolLabel()

QString QgsSymbolLegendNode::textOnSymbolLabel ( ) const
inline

Returns label of text to be shown on top of the symbol.

Since
QGIS 3.2

Definition at line 437 of file qgslayertreemodellegendnode.h.

◆ textOnSymbolTextFormat()

QgsTextFormat QgsSymbolLegendNode::textOnSymbolTextFormat ( ) const
inline

Returns text format of the label to be shown on top of the symbol.

Since
QGIS 3.2

Definition at line 449 of file qgslayertreemodellegendnode.h.

Member Data Documentation

◆ MAXIMUM_SIZE

double QgsSymbolLegendNode::MAXIMUM_SIZE = -1.0
static

Definition at line 365 of file qgslayertreemodellegendnode.h.

◆ MINIMUM_SIZE

double QgsSymbolLegendNode::MINIMUM_SIZE = -1.0
static

Definition at line 364 of file qgslayertreemodellegendnode.h.


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