QGIS API Documentation  2.6.0-Brighton
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsImageLegendNode Class Reference

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

#include <qgslayertreemodellegendnode.h>

Inheritance diagram for QgsImageLegendNode:
Inheritance graph
[legend]

Public Member Functions

 QgsImageLegendNode (QgsLayerTreeLayer *nodeLayer, const QImage &img, QObject *parent=0)
virtual QVariant data (int role) const
 Return data associated with the item.
QSizeF drawSymbol (const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight) const
 Draws symbol on the left side of the item.
- Public Member Functions inherited from QgsLayerTreeModelLegendNode
 ~QgsLayerTreeModelLegendNode ()
QgsLayerTreeLayerlayerNode () const
 Return pointer to the parent layer node.
QgsLayerTreeModelmodel () const
 Return pointer to model owning this legend node.
virtual Qt::ItemFlags flags () const
 Return item flags associated with the item.
virtual bool setData (const QVariant &value, int role)
 Set some data associated with the item.
virtual bool isEmbeddedInParent () const
virtual void setEmbeddedInParent (bool embedded)
virtual QString userLabel () const
virtual 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.
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
QgsLayerTreeLayermLayerNode
bool mEmbeddedInParent
QString mUserLabel

Detailed Description

Implementation of legend node interface for displaying arbitrary raster image.

Note
added in 2.6

Constructor & Destructor Documentation

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

Member Function Documentation

QVariant QgsImageLegendNode::data ( int  role) const
virtual

Return data associated with the item.

Must be implemented in derived class.

Implements QgsLayerTreeModelLegendNode.

QSizeF QgsImageLegendNode::drawSymbol ( const QgsLegendSettings settings,
ItemContext ctx,
double  itemHeight 
) const
virtual

Draws symbol on the left side of the item.

Parameters
settingsLegend layout configuration
ctxContext for rendering - may be null if only doing layout without actual rendering
itemHeightMinimal 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.


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