Quantum GIS API Documentation  1.7.4
Public Slots | Signals | Public Member Functions
QgsLegendInterface Class Reference

QgsLegendInterface Abstract base class to make QgsLegend available to plugins. More...

#include <qgslegendinterface.h>

List of all members.

Public Slots

virtual int addGroup (QString name, bool expand=true, QTreeWidgetItem *parent=0)=0
 Add a new group a parent group can be given to nest the new group in it.
virtual int addGroup (QString name, bool expand, int parentIndex)=0
 Add a new group a parent group index has to be given to nest the new group in it.
virtual void removeGroup (int groupIndex)=0
 Remove group on index.
virtual void moveLayer (QgsMapLayer *ml, int groupIndex)=0
 Move a layer to a group.
virtual void setGroupExpanded (int groupIndex, bool expand)=0
 Collapse or expand a group.
virtual void setGroupVisible (int groupIndex, bool visible)=0
 Set the visibility of a group.
virtual void setLayerVisible (QgsMapLayer *ml, bool visible)=0
 Set the visibility of a layer.
virtual void refreshLayerSymbology (QgsMapLayer *ml)=0
 Refresh layer symbology.

Signals

void groupIndexChanged (int oldIndex, int newIndex)
 emitted when a group index has changed

Public Member Functions

 QgsLegendInterface ()
 Constructor.
virtual ~QgsLegendInterface ()
 Virtual destructor.
virtual QStringList groups ()=0
 Return a string list of groups.
virtual QList< GroupLayerInfogroupLayerRelationship ()
 Return the relationship between groups and layers in the legend.
virtual QList< QgsMapLayer * > layers () const =0
 Return all layers in the project in legend order.
virtual bool groupExists (int groupIndex)=0
 Check if a group exists.
virtual bool isGroupExpanded (int groupIndex)=0
 Check if a group is expanded.
virtual bool isGroupVisible (int groupIndex)=0
 Check if a group is visible.
virtual bool isLayerVisible (QgsMapLayer *ml)=0
 Check if a layer is visible.

Detailed Description

QgsLegendInterface Abstract base class to make QgsLegend available to plugins.

Note:
added in 1.4

Definition at line 39 of file qgslegendinterface.h.


Constructor & Destructor Documentation

Constructor.

Definition at line 20 of file qgslegendinterface.cpp.

Virtual destructor.

Definition at line 24 of file qgslegendinterface.cpp.


Member Function Documentation

virtual int QgsLegendInterface::addGroup ( QString  name,
bool  expand = true,
QTreeWidgetItem *  parent = 0 
) [pure virtual, slot]

Add a new group a parent group can be given to nest the new group in it.

virtual int QgsLegendInterface::addGroup ( QString  name,
bool  expand,
int  parentIndex 
) [pure virtual, slot]

Add a new group a parent group index has to be given to nest the new group in it.

virtual bool QgsLegendInterface::groupExists ( int  groupIndex) [pure virtual]

Check if a group exists.

Note:
added in 1.5
void QgsLegendInterface::groupIndexChanged ( int  oldIndex,
int  newIndex 
) [signal]

emitted when a group index has changed

virtual QList< GroupLayerInfo > QgsLegendInterface::groupLayerRelationship ( ) [inline, virtual]

Return the relationship between groups and layers in the legend.

Definition at line 55 of file qgslegendinterface.h.

virtual QStringList QgsLegendInterface::groups ( ) [pure virtual]

Return a string list of groups.

virtual bool QgsLegendInterface::isGroupExpanded ( int  groupIndex) [pure virtual]

Check if a group is expanded.

Note:
added in 1.5
virtual bool QgsLegendInterface::isGroupVisible ( int  groupIndex) [pure virtual]

Check if a group is visible.

Note:
added in 1.5
virtual bool QgsLegendInterface::isLayerVisible ( QgsMapLayer ml) [pure virtual]

Check if a layer is visible.

Note:
added in 1.5
virtual QList< QgsMapLayer * > QgsLegendInterface::layers ( ) const [pure virtual]

Return all layers in the project in legend order.

Note:
added in 1.5
virtual void QgsLegendInterface::moveLayer ( QgsMapLayer ml,
int  groupIndex 
) [pure virtual, slot]

Move a layer to a group.

virtual void QgsLegendInterface::refreshLayerSymbology ( QgsMapLayer ml) [pure virtual, slot]

Refresh layer symbology.

Note:
added in 1.5
virtual void QgsLegendInterface::removeGroup ( int  groupIndex) [pure virtual, slot]

Remove group on index.

virtual void QgsLegendInterface::setGroupExpanded ( int  groupIndex,
bool  expand 
) [pure virtual, slot]

Collapse or expand a group.

Note:
added in 1.5
virtual void QgsLegendInterface::setGroupVisible ( int  groupIndex,
bool  visible 
) [pure virtual, slot]

Set the visibility of a group.

Note:
added in 1.5
virtual void QgsLegendInterface::setLayerVisible ( QgsMapLayer ml,
bool  visible 
) [pure virtual, slot]

Set the visibility of a layer.

Note:
added in 1.5

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines