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

Public Member Functions
	QgsSymbolV2LegendNode (QgsLayerTreeLayer *nodeLayer, const QgsLegendSymbolItemV2 &item, QObject *parent=0)
	~QgsSymbolV2LegendNode ()
virtual Qt::ItemFlags	flags () const
	Return item flags associated with the item.
virtual QVariant	data (int role) const
	Return data associated with the item.
virtual bool	setData (const QVariant &value, int role)
	Set some data associated with the item.
QSizeF	drawSymbol (const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const
	Draws symbol on the left side of the item.
virtual void	setEmbeddedInParent (bool embedded)
void	setUserLabel (const QString &userLabel)
virtual bool	isScaleOK (double scale) const
virtual void	invalidateMapBasedData ()
	Notification from model that information from associated map view has changed.
Public Member Functions inherited from QgsLayerTreeModelLegendNode
	~QgsLayerTreeModelLegendNode ()
QgsLayerTreeLayer *	layerNode () const
	Return pointer to the parent layer node.
QgsLayerTreeModel *	model () const
	Return pointer to model owning this legend node.
virtual bool	isEmbeddedInParent () const
virtual QString	userLabel () const
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, const QSizeF &symbolSize) const
	Draws label on the right side of the item.

Additional Inherited Members
Public Types inherited from QgsLayerTreeModelLegendNode
enum	LegendNodeRoles { RuleKeyRole = Qt::UserRole, SymbolV2LegacyRuleKeyRole }
Signals inherited from QgsLayerTreeModelLegendNode
void	dataChanged ()
	Emitted on internal data change so the layer tree model can forward the signal to views.
Protected Member Functions inherited from QgsLayerTreeModelLegendNode
	QgsLayerTreeModelLegendNode (QgsLayerTreeLayer *nodeL, QObject *parent=0)
	Construct the node with pointer to its parent layer node.
Protected Attributes inherited from QgsLayerTreeModelLegendNode
QgsLayerTreeLayer *	mLayerNode
bool	mEmbeddedInParent
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.

Note

added in 2.6

Constructor & Destructor Documentation

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

QgsSymbolV2LegendNode::~QgsSymbolV2LegendNode

(

)

Member Function Documentation

QVariant QgsSymbolV2LegendNode::data ( int  role ) const

virtual

Return data associated with the item.

Must be implemented in derived class.

Implements QgsLayerTreeModelLegendNode.

QSizeF QgsSymbolV2LegendNode::drawSymbol ( const QgsLegendSettings &  settings, ItemContext *  ctx, double  itemHeight  ) const

virtual

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.

Qt::ItemFlags QgsSymbolV2LegendNode::flags ( ) const

virtual

Return item flags associated with the item.

Default implementation returns Qt::ItemIsEnabled.

Reimplemented from QgsLayerTreeModelLegendNode.

void QgsSymbolV2LegendNode::invalidateMapBasedData ( )

virtual

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

Default implementation does nothing.

Reimplemented from QgsLayerTreeModelLegendNode.

virtual bool QgsSymbolV2LegendNode::isScaleOK ( double  scale ) const

inlinevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

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

virtual

Set some data associated with the item.

Default implementation does nothing and returns false.

Reimplemented from QgsLayerTreeModelLegendNode.

void QgsSymbolV2LegendNode::setEmbeddedInParent ( bool  embedded )

virtual

Reimplemented from QgsLayerTreeModelLegendNode.

void QgsSymbolV2LegendNode::setUserLabel ( const QString &  userLabel )

inlinevirtual

Reimplemented from QgsLayerTreeModelLegendNode.

---

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

• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/layertree/qgslayertreemodellegendnode.h
• /tmp/buildd/qgis-2.6.0+wheezy1/src/core/layertree/qgslayertreemodellegendnode.cpp