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

Item model implementation based on layer tree model for composer legend. More...

#include <qgscomposerlegend.h>

Inheritance diagram for QgsLegendModelV2:
Inheritance graph
[legend]

Public Member Functions

 QgsLegendModelV2 (QgsLayerTreeGroup *rootNode, QObject *parent=0)
QVariant data (const QModelIndex &index, int role) const
Qt::ItemFlags flags (const QModelIndex &index) const
- Public Member Functions inherited from QgsLayerTreeModel
 QgsLayerTreeModel (QgsLayerTreeGroup *rootNode, QObject *parent=0)
 Construct a new tree model with given layer tree (root node must not be null pointer).
 ~QgsLayerTreeModel ()
int rowCount (const QModelIndex &parent=QModelIndex()) const
int columnCount (const QModelIndex &parent=QModelIndex()) const
QModelIndex index (int row, int column, const QModelIndex &parent=QModelIndex()) const
QModelIndex parent (const QModelIndex &child) const
bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)
Qt::DropActions supportedDropActions () const
QStringList mimeTypes () const
QMimeData * mimeData (const QModelIndexList &indexes) const
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex())
void setFlags (Flags f)
 Set OR-ed combination of model flags.
void setFlag (Flag f, bool on=true)
 Enable or disable a model flag.
Flags flags () const
 Return OR-ed combination of model flags.
bool testFlag (Flag f) const
 Check whether a flag is enabled.
QgsLayerTreeNodeindex2node (const QModelIndex &index) const
 Return layer tree node for given index.
QModelIndex node2index (QgsLayerTreeNode *node) const
 Return index for a given node. If the node does not belong to the layer tree, the result is undefined.
QList< QgsLayerTreeNode * > indexes2nodes (const QModelIndexList &list, bool skipInternal=false) const
 Convert a list of indexes to a list of layer tree nodes.
QModelIndex legendNode2index (QgsLayerTreeModelLegendNode *legendNode)
 Return index for a given legend node.
QList
< QgsLayerTreeModelLegendNode * > 
layerLegendNodes (QgsLayerTreeLayer *nodeLayer)
 Return list of legend nodes attached to a particular layer node.
QgsLayerTreeGrouprootGroup ()
 Return pointer to the root node of the layer tree. Always a non-null pointer.
void setRootGroup (QgsLayerTreeGroup *newRootGroup)
 Reset the model and use a new root group node.
void refreshLayerLegend (QgsLayerTreeLayer *nodeLayer)
 Force a refresh of legend nodes of a layer node.
QModelIndex currentIndex () const
 Get index of the item marked as current. Item marked as current is underlined.
void setCurrentIndex (const QModelIndex &currentIndex)
 Set index of the current item. May be used by view. Item marked as current is underlined.
void setLayerTreeNodeFont (int nodeType, const QFont &font)
 Set font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeType enumeration.
QFont layerTreeNodeFont (int nodeType) const
 Get font for a particular type of layer tree node. nodeType should come from QgsLayerTreeNode::NodeType enumeration.
void setAutoCollapseLegendNodes (int nodeCount)
 Set at what number of legend nodes the layer node should be collapsed. Setting -1 disables the auto-collapse (default).
int autoCollapseLegendNodes () const
 Return at what number of legend nodes the layer node should be collapsed. -1 means no auto-collapse (default).
void setLegendFilterByScale (double scaleDenominator)
 Force only display of legend nodes which are valid for given scale denominator.
double legendFilterByScale () const
Q_DECL_DEPRECATED bool isIndexSymbologyNode (const QModelIndex &index) const
 Return true if index represents a legend node (instead of layer node)
Q_DECL_DEPRECATED
QgsLayerTreeLayer
layerNodeForSymbologyNode (const QModelIndex &index) const
 Return layer node to which a legend node belongs to.
Q_DECL_DEPRECATED void refreshLayerSymbology (QgsLayerTreeLayer *nodeLayer)
Q_DECL_DEPRECATED void setAutoCollapseSymbologyNodes (int nodeCount)
Q_DECL_DEPRECATED int autoCollapseSymbologyNodes () const

Additional Inherited Members

- Public Types inherited from QgsLayerTreeModel
enum  Flag {
  ShowLegend = 0x0001, ShowSymbology = 0x0001, ShowRasterPreviewIcon = 0x0002, AllowNodeReorder = 0x1000,
  AllowNodeRename = 0x2000, AllowNodeChangeVisibility = 0x4000, AllowLegendChangeState = 0x8000, AllowSymbologyChangeState = 0x8000
}
- Static Public Member Functions inherited from QgsLayerTreeModel
static
QgsLayerTreeModelLegendNode
index2legendNode (const QModelIndex &index)
 Return legend node for given index.
- Protected Slots inherited from QgsLayerTreeModel
void nodeWillAddChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo)
void nodeAddedChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo)
void nodeWillRemoveChildren (QgsLayerTreeNode *node, int indexFrom, int indexTo)
void nodeRemovedChildren ()
void nodeVisibilityChanged (QgsLayerTreeNode *node)
void nodeCustomPropertyChanged (QgsLayerTreeNode *node, const QString &key)
void nodeLayerLoaded ()
void nodeLayerWillBeUnloaded ()
void layerLegendChanged ()
void layerNeedsUpdate ()
void legendNodeDataChanged ()
- Protected Member Functions inherited from QgsLayerTreeModel
void removeLegendFromLayer (QgsLayerTreeLayer *nodeLayer)
void addLegendToLayer (QgsLayerTreeLayer *nodeL)
void connectToLayer (QgsLayerTreeLayer *nodeLayer)
void disconnectFromLayer (QgsLayerTreeLayer *nodeLayer)
void connectToLayers (QgsLayerTreeGroup *parentGroup)
void disconnectFromLayers (QgsLayerTreeGroup *parentGroup)
void connectToRootNode ()
void disconnectFromRootNode ()
void recursivelyEmitDataChanged (const QModelIndex &index=QModelIndex())
 emit dataChanged() for layer tree node items
QList
< QgsLayerTreeModelLegendNode * > 
filterLegendNodes (const QList< QgsLayerTreeModelLegendNode * > &nodes)
 Filter nodes from QgsMapLayerLegend according to the current filtering rules.
- Static Protected Member Functions inherited from QgsLayerTreeModel
static const QIcon & iconGroup ()
- Protected Attributes inherited from QgsLayerTreeModel
QgsLayerTreeGroupmRootNode
 Pointer to the root node of the layer tree. Not owned by the model.
Flags mFlags
 Set of flags for the model.
QMap< QgsLayerTreeLayer
*, QList
< QgsLayerTreeModelLegendNode * > > 
mLegendNodes
 Active legend nodes for each layer node.
QMap< QgsLayerTreeLayer
*, QList
< QgsLayerTreeModelLegendNode * > > 
mOriginalLegendNodes
 Data structure for storage of legend nodes for each layer.
QPersistentModelIndex mCurrentIndex
 Current index - will be underlined.
int mAutoCollapseLegendNodesCount
 Minimal number of nodes when legend should be automatically collapsed. -1 = disabled.
QFont mFontLayer
QFont mFontGroup
double mLegendFilterByScale
 scale denominator for filtering of legend nodes (<= 0 means no filtering)

Detailed Description

Item model implementation based on layer tree model for composer legend.

Overrides some functionality of QgsLayerTreeModel to better fit the needs of composer legend.

Note
added in 2.6

Constructor & Destructor Documentation

QgsLegendModelV2::QgsLegendModelV2 ( QgsLayerTreeGroup rootNode,
QObject *  parent = 0 
)

Member Function Documentation

QVariant QgsLegendModelV2::data ( const QModelIndex &  index,
int  role 
) const

Reimplemented from QgsLayerTreeModel.

Qt::ItemFlags QgsLegendModelV2::flags ( const QModelIndex &  index) const

Reimplemented from QgsLayerTreeModel.


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