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:

[legend]

Public Slots
void	checkAllItems ()
	Checks all items belonging to the same layer as this node. More...

void	toggleAllItems ()
	Toggle all items belonging to the same layer as this node. More...

void	uncheckAllItems ()
	Unchecks all items belonging to the same layer as this node. More...

Public Member Functions
	QgsSymbolLegendNode (QgsLayerTreeLayer nodeLayer, const QgsLegendSymbolItem &item, QObject parent=nullptr)
	Constructor for QgsSymbolLegendNode. 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...

void	exportSymbolToJson (const QgsLegendSettings &settings, const QgsRenderContext &context, QJsonObject &json) 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...

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	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 QgsSymbol *	symbol () const
	Returns the symbol used by the legend node. 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 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...

void	exportSymbolTextToJson (const QgsLegendSettings &settings, QJsonObject &json) const
	Adds a label in a JSON object with the key "title". More...

void	exportToJson (const QgsLegendSettings &settings, const QgsRenderContext &context, QJsonObject &json)
	Entry point called from QgsLegendRenderer to do the rendering in a JSON object. More...

virtual bool	isEmbeddedInParent () 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 QString	userLabel () const

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...

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	mEmbeddedInParent

QgsLayerTreeLayer *	mLayerNode = nullptr

QString	mUserLabel

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 185 of file qgslayertreemodellegendnode.h.

Constructor & Destructor Documentation

◆ QgsSymbolLegendNode()

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

Constructor for QgsSymbolLegendNode.

Parameters

nodeLayer	layer node
item	the legend symbol item
parent	attach a parent QObject to the legend node.

Definition at line 158 of file qgslayertreemodellegendnode.cpp.

Member Function Documentation

◆ checkAllItems

void QgsSymbolLegendNode::checkAllItems ( )

slot

Checks all items belonging to the same layer as this node.

See also: uncheckAllItems(); toggleAllItems()

Since: QGIS 2.14

Definition at line 250 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 311 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

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

Returns: Real size of the symbol (may be bigger than "normal" symbol size from settings)

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 410 of file qgslayertreemodellegendnode.cpp.

◆ exportSymbolToJson()

void QgsSymbolLegendNode::exportSymbolToJson	(	const QgsLegendSettings &	settings,
		const QgsRenderContext &	context,
		QJsonObject &	json
	)		const

overridevirtual

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

Parameters

settings	Legend layout configuration
context	Rendering context
json	The json object to update

Since: QGIS 3.8

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 519 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 174 of file qgslayertreemodellegendnode.cpp.

◆ iconSize()

QSize QgsSymbolLegendNode::iconSize ( ) const

inline

Since: QGIS 2.10

Definition at line 221 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 568 of file qgslayertreemodellegendnode.cpp.

◆ isScaleOK()

bool QgsSymbolLegendNode::isScaleOK ( double scale ) const

inlineoverridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 211 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 183 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 189 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 386 of file qgslayertreemodellegendnode.cpp.

◆ setEmbeddedInParent()

void QgsSymbolLegendNode::setEmbeddedInParent ( bool embedded )

overridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 561 of file qgslayertreemodellegendnode.cpp.

◆ setIconSize()

void QgsSymbolLegendNode::setIconSize ( QSize sz )

inline

Set the icon size.

Since: QGIS 2.10

Definition at line 219 of file qgslayertreemodellegendnode.h.

◆ 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

symbol new symbol for node. Ownership is transferred.

See also: symbol()

Since: QGIS 2.14

Definition at line 231 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 266 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 278 of file qgslayertreemodellegendnode.h.

◆ setUserLabel()

void QgsSymbolLegendNode::setUserLabel ( const QString & userLabel )

inlineoverridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 209 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 226 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 260 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 272 of file qgslayertreemodellegendnode.h.

◆ toggleAllItems

void QgsSymbolLegendNode::toggleAllItems ( )

slot

Toggle all items belonging to the same layer as this node.

See also: checkAllItems(); uncheckAllItems()

Since: QGIS 3.6

Definition at line 260 of file qgslayertreemodellegendnode.cpp.

◆ uncheckAllItems

void QgsSymbolLegendNode::uncheckAllItems ( )

slot

Unchecks all items belonging to the same layer as this node.

See also: checkAllItems(); toggleAllItems()

Since: QGIS 2.14

Definition at line 255 of file qgslayertreemodellegendnode.cpp.

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

/tmp/buildd/qgis-3.8.0+99unstable/src/core/layertree/qgslayertreemodellegendnode.h
/tmp/buildd/qgis-3.8.0+99unstable/src/core/layertree/qgslayertreemodellegendnode.cpp

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSymbolLegendNode()

Member Function Documentation

◆ checkAllItems

◆ data()

◆ drawSymbol()

◆ exportSymbolToJson()

◆ flags()

◆ iconSize()

◆ invalidateMapBasedData()

◆ isScaleOK()

◆ minimumIconSize() [1/2]

◆ minimumIconSize() [2/2]

◆ setData()

◆ setEmbeddedInParent()

◆ setIconSize()

◆ setSymbol()

◆ setTextOnSymbolLabel()

◆ setTextOnSymbolTextFormat()

◆ setUserLabel()

◆ symbol()

◆ textOnSymbolLabel()

◆ textOnSymbolTextFormat()

◆ toggleAllItems

◆ uncheckAllItems