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

#include <qgslegendinterface.h>

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	moveLayer (QgsMapLayer *ml, int groupIndex)=0
	Move a layer to a group.
virtual void	refreshLayerSymbology (QgsMapLayer *ml)=0
	Refresh layer symbology.
virtual void	removeGroup (int groupIndex)=0
	Remove group on index.
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	setLayerExpanded (QgsMapLayer *ml, bool expand)=0
	Collapse or expand a layer.
virtual void	setLayerVisible (QgsMapLayer *ml, bool visible)=0
	Set the visibility of a layer.
Signals
void	currentLayerChanged (QgsMapLayer *layer)
	Emitted whenever current (selected) layer changes.
void	groupIndexChanged (int oldIndex, int newIndex)
	emitted when a group index has changed
void	groupRelationsChanged ()
void	itemAdded (QModelIndex index)
void	itemRemoved ()
Public Member Functions
	QgsLegendInterface ()
	Constructor.
virtual	~QgsLegendInterface ()
	Virtual destructor.
virtual void	addLegendLayerAction (QAction *action, QString menu, QString id, QgsMapLayer::LayerType type, bool allLayers)=0
	Add action for layers in the legend.
virtual void	addLegendLayerActionForLayer (QAction action, QgsMapLayer layer)=0
	Add action for a specific layers in the legend.
virtual QgsMapLayer *	currentLayer ()=0
	Returns the current layer if the current item is a QgsLegendLayer.
virtual bool	groupExists (int groupIndex)=0
	Check if a group exists.
virtual QList< GroupLayerInfo >	groupLayerRelationship ()
	Return the relationship between groups and layers in the legend.
virtual QStringList	groups ()=0
	Return a string list of groups.
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	isLayerExpanded (QgsMapLayer *ml)=0
	Check if a layer is expanded.
virtual bool	isLayerVisible (QgsMapLayer *ml)=0
	Check if a layer is visible.
virtual QList< QgsMapLayer * >	layers () const =0
	Return all layers in the project in drawing order.
virtual bool	removeLegendLayerAction (QAction *action)=0
	Remove action for layers in the legend.
virtual QList< QgsMapLayer * >	selectedLayers (bool inDrawOrder=false) const =0
	Returns the currently selected layers of QgsLegendLayers.
virtual bool	setCurrentLayer (QgsMapLayer *layer)=0
	set the current layer returns true if the layer exists, false otherwise

Detailed Description

QgsLegendInterface Abstract base class to make QgsLegend available to plugins.

Note:: added in 1.4

Definition at line 42 of file qgslegendinterface.h.

Constructor & Destructor Documentation

QgsLegendInterface::QgsLegendInterface ( )

Constructor.

Definition at line 19 of file qgslegendinterface.cpp.

QgsLegendInterface::~QgsLegendInterface ( ) [virtual]

Virtual destructor.

Definition at line 23 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 void QgsLegendInterface::addLegendLayerAction	(	QAction *	action,
		QString	menu,
		QString	id,
		QgsMapLayer::LayerType	type,
		bool	allLayers
	)		`[pure virtual]`

Add action for layers in the legend.

Note:: added in 2.0

virtual void QgsLegendInterface::addLegendLayerActionForLayer	(	QAction *	action,
		QgsMapLayer *	layer
	)		`[pure virtual]`

Add action for a specific layers in the legend.

Use this in combination with addLegendLayerAction( allLayers = False )

Note:: added in 2.0

virtual QgsMapLayer* QgsLegendInterface::currentLayer ( ) [pure virtual]

Returns the current layer if the current item is a QgsLegendLayer.

If the current item is a QgsLegendLayer, its first maplayer is returned. Else, 0 is returned.

Note:: Added in 2.0

void QgsLegendInterface::currentLayerChanged ( QgsMapLayer * layer ) [signal]

Emitted whenever current (selected) layer changes.

Note:: Added in 2.0

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 58 of file qgslegendinterface.h.

void QgsLegendInterface::groupRelationsChanged ( ) [signal]

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::isLayerExpanded ( QgsMapLayer * ml ) [pure virtual]

Check if a layer is expanded.

Note:: added in 2.0

virtual bool QgsLegendInterface::isLayerVisible ( QgsMapLayer * ml ) [pure virtual]

Check if a layer is visible.

Note:: added in 1.5

void QgsLegendInterface::itemAdded ( QModelIndex index ) [signal]

void QgsLegendInterface::itemRemoved ( ) [signal]

virtual QList< QgsMapLayer * > QgsLegendInterface::layers ( ) const [pure virtual]

Return all layers in the project in drawing 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 bool QgsLegendInterface::removeLegendLayerAction ( QAction * action ) [pure virtual]

Remove action for layers in the legend.

Note:: added in 2.0

virtual QList<QgsMapLayer *> QgsLegendInterface::selectedLayers ( bool inDrawOrder = false ) const [pure virtual]

Returns the currently selected layers of QgsLegendLayers.

Parameters:

inDrawOrder return layers in drawing order (added in 1.9)

Returns:: list of layers, else an empty list

virtual bool QgsLegendInterface::setCurrentLayer ( QgsMapLayer * layer ) [pure virtual]

set the current layer returns true if the layer exists, false otherwise

Note:: Added in 2.0

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::setLayerExpanded	(	QgsMapLayer *	ml,
		bool	expand
	)		`[pure virtual, slot]`

Collapse or expand a layer.

Note:: added in 2.0

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:

src/gui/qgslegendinterface.h
src/gui/qgslegendinterface.cpp

Public Slots

Signals

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation