Implementation of legend node interface for displaying arbitrary raster image. More...

#include <qgslayertreemodellegendnode.h>

Inheritance diagram for QgsImageLegendNode:

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

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 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 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 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 arbitrary raster image.

Since: QGIS 2.6

Definition at line 368 of file qgslayertreemodellegendnode.h.

Constructor & Destructor Documentation

◆ QgsImageLegendNode()

QgsImageLegendNode::QgsImageLegendNode	(	QgsLayerTreeLayer *	nodeLayer,
		const QImage &	img,
		QObject *	parent = `nullptr`
	)

Constructor for QgsImageLegendNode.

Parameters

nodeLayer	layer node
img	the image
parent	attach a parent QObject to the legend node.

Definition at line 637 of file qgslayertreemodellegendnode.cpp.

Member Function Documentation

◆ data()

QVariant QgsImageLegendNode::data ( int role ) const

overridevirtual

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

Implements QgsLayerTreeModelLegendNode.

Definition at line 643 of file qgslayertreemodellegendnode.cpp.

◆ drawSymbol()

QSizeF QgsImageLegendNode::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 656 of file qgslayertreemodellegendnode.cpp.

◆ exportSymbolToJson()

void QgsImageLegendNode::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 668 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 Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsImageLegendNode()

Member Function Documentation

◆ data()

◆ drawSymbol()

◆ exportSymbolToJson()