QgsLayerTreeModelLegendNode Class Reference

The QgsLegendRendererItem class is abstract interface for legend items returned from QgsMapLayerLegend implementation. More...

#include <qgslayertreemodellegendnode.h>

Inheritance diagram for QgsLayerTreeModelLegendNode:

Classes
struct	ItemContext
struct	ItemMetrics

Public Types
enum	LegendNodeRoles { RuleKeyRole = Qt::UserRole, SymbolV2LegacyRuleKeyRole, ParentRuleKeyRole }

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

Public Member Functions
	~QgsLayerTreeModelLegendNode ()
virtual QVariant	data (int role) const =0
	Return data associated with the item.
virtual ItemMetrics	draw (const QgsLegendSettings &settings, ItemContext *ctx)
	Entry point called from QgsLegendRenderer to do the rendering.
virtual QSizeF	drawSymbol (const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const
	Draws symbol on the left side of the item.
virtual QSizeF	drawSymbolText (const QgsLegendSettings &settings, ItemContext *ctx, const QSizeF &symbolSize) const
	Draws label on the right side of the item.
virtual Qt::ItemFlags	flags () const
	Return item flags associated with the item.
virtual void	invalidateMapBasedData ()
	Notification from model that information from associated map view has changed.
virtual bool	isEmbeddedInParent () const
virtual bool	isScaleOK (double scale) const
QgsLayerTreeLayer *	layerNode () const
	Return pointer to the parent layer node.
QgsLayerTreeModel *	model () const
	Return pointer to model owning this legend node.
virtual bool	setData (const QVariant &value, int role)
	Set some data associated with the item.
virtual void	setEmbeddedInParent (bool embedded)
virtual void	setUserLabel (const QString &userLabel)
virtual QString	userLabel () const

Protected Member Functions
	QgsLayerTreeModelLegendNode (QgsLayerTreeLayer *nodeL, QObject *parent=0)
	Construct the node with pointer to its parent layer node.

Protected Attributes
bool	mEmbeddedInParent
QgsLayerTreeLayer *	mLayerNode
QString	mUserLabel

Detailed Description

The QgsLegendRendererItem class is abstract interface for legend items returned from QgsMapLayerLegend implementation.

The objects are used in QgsLayerTreeModel. Custom implementations may offer additional interactivity and customized look.

Note

added in 2.6

Definition at line 42 of file qgslayertreemodellegendnode.h.

Member Enumeration Documentation

enum QgsLayerTreeModelLegendNode::LegendNodeRoles

Enumerator:

RuleKeyRole	rule key of the node (QString)
SymbolV2LegacyRuleKeyRole	for QgsSymbolV2LegendNode only - legacy rule key (void ptr, to be cast to QgsSymbolV2 ptr)
ParentRuleKeyRole	rule key of the parent legend node - for legends with tree hierarchy (QString). Added in 2.8

Definition at line 48 of file qgslayertreemodellegendnode.h.

Constructor & Destructor Documentation

QgsLayerTreeModelLegendNode::~QgsLayerTreeModelLegendNode

(

)

Definition at line 38 of file qgslayertreemodellegendnode.cpp.

QgsLayerTreeModelLegendNode::QgsLayerTreeModelLegendNode ( QgsLayerTreeLayer *  nodeL, QObject *  parent = 0  )

explicitprotected

Construct the node with pointer to its parent layer node.

Definition at line 31 of file qgslayertreemodellegendnode.cpp.

Member Function Documentation

virtual QVariant QgsLayerTreeModelLegendNode::data ( int  role ) const

pure virtual

Return data associated with the item.

Must be implemented in derived class.

Implemented in QgsWMSLegendNode, QgsRasterSymbolLegendNode, QgsImageLegendNode, QgsSimpleLegendNode, and QgsSymbolV2LegendNode.

void QgsLayerTreeModelLegendNode::dataChanged ( )

signal

Emitted on internal data change so the layer tree model can forward the signal to views.

QgsLayerTreeModelLegendNode::ItemMetrics QgsLayerTreeModelLegendNode::draw ( const QgsLegendSettings &  settings, ItemContext *  ctx  )

virtual

Entry point called from QgsLegendRenderer to do the rendering.

Default implementation calls drawSymbol() and drawSymbolText() methods.

If ctx is null, this is just first stage when preparing layout - without actual rendering.

Definition at line 60 of file qgslayertreemodellegendnode.cpp.

QSizeF QgsLayerTreeModelLegendNode::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 in QgsWMSLegendNode, QgsRasterSymbolLegendNode, QgsImageLegendNode, and QgsSymbolV2LegendNode.

Definition at line 77 of file qgslayertreemodellegendnode.cpp.

QSizeF QgsLayerTreeModelLegendNode::drawSymbolText ( const QgsLegendSettings &  settings, ItemContext *  ctx, const QSizeF &  symbolSize  ) const

virtual

Draws label on the right side of the item.

Parameters

settings	Legend layout configuration
ctx	Context for rendering - may be null if only doing layout without actual rendering
symbolSize	Real size of the associated symbol - used for correct positioning when rendering

Returns

Size of the label (may span multiple lines)

Definition at line 90 of file qgslayertreemodellegendnode.cpp.

Qt::ItemFlags QgsLayerTreeModelLegendNode::flags ( ) const

virtual

Return item flags associated with the item.

Default implementation returns Qt::ItemIsEnabled.

Reimplemented in QgsSymbolV2LegendNode.

Definition at line 47 of file qgslayertreemodellegendnode.cpp.

virtual void QgsLayerTreeModelLegendNode::invalidateMapBasedData ( )

inlinevirtual

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

Default implementation does nothing.

Reimplemented in QgsWMSLegendNode, and QgsSymbolV2LegendNode.

Definition at line 80 of file qgslayertreemodellegendnode.h.

virtual bool QgsLayerTreeModelLegendNode::isEmbeddedInParent ( ) const

inlinevirtual

Definition at line 70 of file qgslayertreemodellegendnode.h.

virtual bool QgsLayerTreeModelLegendNode::isScaleOK ( double  scale ) const

inlinevirtual

Reimplemented in QgsSymbolV2LegendNode.

Definition at line 76 of file qgslayertreemodellegendnode.h.

QgsLayerTreeLayer* QgsLayerTreeModelLegendNode::layerNode ( ) const

inline

Return pointer to the parent layer node.

Definition at line 56 of file qgslayertreemodellegendnode.h.

QgsLayerTreeModel * QgsLayerTreeModelLegendNode::model

(

)

const

Return pointer to model owning this legend node.

Definition at line 42 of file qgslayertreemodellegendnode.cpp.

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

virtual

Set some data associated with the item.

Default implementation does nothing and returns false.

Reimplemented in QgsSymbolV2LegendNode.

Definition at line 52 of file qgslayertreemodellegendnode.cpp.

virtual void QgsLayerTreeModelLegendNode::setEmbeddedInParent ( bool  embedded )

inlinevirtual

Reimplemented in QgsSymbolV2LegendNode.

Definition at line 71 of file qgslayertreemodellegendnode.h.

virtual void QgsLayerTreeModelLegendNode::setUserLabel ( const QString &  userLabel )

inlinevirtual

Reimplemented in QgsSymbolV2LegendNode.

Definition at line 74 of file qgslayertreemodellegendnode.h.

virtual QString QgsLayerTreeModelLegendNode::userLabel ( ) const

inlinevirtual

Definition at line 73 of file qgslayertreemodellegendnode.h.

Member Data Documentation

bool QgsLayerTreeModelLegendNode::mEmbeddedInParent

protected

Definition at line 133 of file qgslayertreemodellegendnode.h.

QgsLayerTreeLayer* QgsLayerTreeModelLegendNode::mLayerNode

protected

Definition at line 132 of file qgslayertreemodellegendnode.h.

QString QgsLayerTreeModelLegendNode::mUserLabel

protected

Definition at line 134 of file qgslayertreemodellegendnode.h.

---

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

• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/layertree/qgslayertreemodellegendnode.h
• /tmp/buildd/qgis-2.8.2+12wheezy/src/core/layertree/qgslayertreemodellegendnode.cpp