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 QgsSymbolV2LegendNode:

[legend]

Public Slots
void	checkAllItems ()
	Checks 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
	QgsSymbolV2LegendNode (QgsLayerTreeLayer nodeLayer, const QgsLegendSymbolItemV2 &item, QObject parent=nullptr)

	~QgsSymbolV2LegendNode ()

virtual QVariant	data (int role) const override
	Return data associated with the item. More...

QSizeF	drawSymbol (const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const override
	Draws symbol on the left side of the item. More...

virtual Qt::ItemFlags	flags () const override
	Return item flags associated with the item. More...

QSize	iconSize () const

virtual void	invalidateMapBasedData () override
	Notification from model that information from associated map view has changed. More...

virtual bool	isScaleOK (double scale) const override

QSize	minimumIconSize () const
	Get the minimum icon size to prevent cropping. More...

virtual bool	setData (const QVariant &value, int role) override
	Set some data associated with the item. More...

virtual void	setEmbeddedInParent (bool embedded) override

void	setIconSize (QSize sz)
	Set the icon size. More...

void	setSymbol (QgsSymbolV2 *symbol)
	Sets the symbol to be used by the legend node. More...

void	setUserLabel (const QString &userLabel) override

const QgsSymbolV2 *	symbol () const
	Returns the symbol used by the legend node. More...

Public Member Functions inherited from QgsLayerTreeModelLegendNode
	~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...

virtual bool	isEmbeddedInParent () const

QgsLayerTreeLayer *	layerNode () const
	Return pointer to the parent layer node. More...

QgsLayerTreeModel *	model () const
	Return pointer to model owning this legend node. More...

virtual QString	userLabel () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Additional Inherited Members
Public Types inherited from QgsLayerTreeModelLegendNode
enum	LegendNodeRoles { RuleKeyRole = Qt::UserRole, SymbolV2LegacyRuleKeyRole, ParentRuleKeyRole }

Signals inherited from QgsLayerTreeModelLegendNode
void	dataChanged ()
	Emitted on internal data change so the layer tree model can forward the signal to views. More...

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QgsLayerTreeModelLegendNode
	QgsLayerTreeModelLegendNode (QgsLayerTreeLayer nodeL, QObject parent=nullptr)
	Construct the node with pointer to its parent layer node. More...

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Protected Attributes inherited from QgsLayerTreeModelLegendNode
bool	mEmbeddedInParent

QgsLayerTreeLayer *	mLayerNode

QString	mUserLabel

Properties inherited from QObject
	objectName

Detailed Description

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

Note: added in 2.6

Definition at line 146 of file qgslayertreemodellegendnode.h.

Constructor & Destructor Documentation

◆ QgsSymbolV2LegendNode()

QgsSymbolV2LegendNode::QgsSymbolV2LegendNode	(	QgsLayerTreeLayer *	nodeLayer,
		const QgsLegendSymbolItemV2 &	item,
		QObject *	parent = `nullptr`
	)

Definition at line 135 of file qgslayertreemodellegendnode.cpp.

◆ ~QgsSymbolV2LegendNode()

QgsSymbolV2LegendNode::~QgsSymbolV2LegendNode ( )

Definition at line 147 of file qgslayertreemodellegendnode.cpp.

Member Function Documentation

◆ checkAllItems

void QgsSymbolV2LegendNode::checkAllItems ( )

slot

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

Note: added in QGIS 2.14

See also: uncheckAllItems()

Definition at line 211 of file qgslayertreemodellegendnode.cpp.

◆ data()

QVariant QgsSymbolV2LegendNode::data ( int role ) const

overridevirtual

Return data associated with the item.

Must be implemented in derived class.

Implements QgsLayerTreeModelLegendNode.

Definition at line 255 of file qgslayertreemodellegendnode.cpp.

◆ drawSymbol()

QSizeF QgsSymbolV2LegendNode::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 null 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 346 of file qgslayertreemodellegendnode.cpp.

◆ flags()

Qt::ItemFlags QgsSymbolV2LegendNode::flags ( ) const

overridevirtual

Return item flags associated with the item.

Default implementation returns Qt::ItemIsEnabled.

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 151 of file qgslayertreemodellegendnode.cpp.

◆ iconSize()

QSize QgsSymbolV2LegendNode::iconSize ( ) const

inline

Note: added in 2.10

Definition at line 172 of file qgslayertreemodellegendnode.h.

◆ invalidateMapBasedData()

void QgsSymbolV2LegendNode::invalidateMapBasedData ( )

overridevirtual

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

Default implementation does nothing.

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 440 of file qgslayertreemodellegendnode.cpp.

◆ isScaleOK()

virtual bool QgsSymbolV2LegendNode::isScaleOK ( double scale ) const

inlineoverridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 164 of file qgslayertreemodellegendnode.h.

◆ minimumIconSize()

QSize QgsSymbolV2LegendNode::minimumIconSize ( ) const

Get the minimum icon size to prevent cropping.

Note: added in 2.10

Definition at line 160 of file qgslayertreemodellegendnode.cpp.

◆ setData()

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

overridevirtual

Set some data associated with the item.

Default implementation does nothing and returns false.

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 323 of file qgslayertreemodellegendnode.cpp.

◆ setEmbeddedInParent()

void QgsSymbolV2LegendNode::setEmbeddedInParent ( bool embedded )

overridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 433 of file qgslayertreemodellegendnode.cpp.

◆ setIconSize()

void QgsSymbolV2LegendNode::setIconSize ( QSize sz )

inline

Set the icon size.

Note: added in 2.10

Definition at line 170 of file qgslayertreemodellegendnode.h.

◆ setSymbol()

void QgsSymbolV2LegendNode::setSymbol ( QgsSymbolV2 * 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()

Note: added in QGIS 2.14

Definition at line 193 of file qgslayertreemodellegendnode.cpp.

◆ setUserLabel()

void QgsSymbolV2LegendNode::setUserLabel ( const QString & userLabel )

inlineoverridevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

Definition at line 162 of file qgslayertreemodellegendnode.h.

◆ symbol()

const QgsSymbolV2 * QgsSymbolV2LegendNode::symbol ( ) const

Returns the symbol used by the legend node.

See also: setSymbol()

Note: added in QGIS 2.14

Definition at line 188 of file qgslayertreemodellegendnode.cpp.

◆ uncheckAllItems

void QgsSymbolV2LegendNode::uncheckAllItems ( )

slot

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

Note: added in QGIS 2.14

See also: checkAllItems()

Definition at line 216 of file qgslayertreemodellegendnode.cpp.

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

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

Public Slots

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSymbolV2LegendNode()

◆ ~QgsSymbolV2LegendNode()

Member Function Documentation

◆ checkAllItems

◆ data()

◆ drawSymbol()

◆ flags()

◆ iconSize()

◆ invalidateMapBasedData()

◆ isScaleOK()

◆ minimumIconSize()

◆ setData()

◆ setEmbeddedInParent()

◆ setIconSize()

◆ setSymbol()

◆ setUserLabel()

◆ symbol()

◆ uncheckAllItems