mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
83 lines
2.3 KiB
Plaintext
83 lines
2.3 KiB
Plaintext
/**
|
|
* \class QgsLegendInterface
|
|
* \brief Abstract base class to make QgsLegend available to plugins.
|
|
*/
|
|
class QgsLegendInterface : QObject
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgslegendinterface.h>
|
|
%End
|
|
|
|
public:
|
|
|
|
/** Constructor */
|
|
QgsLegendInterface();
|
|
|
|
/** Virtual destructor */
|
|
~QgsLegendInterface();
|
|
|
|
//! Return a string list of groups
|
|
virtual QStringList groups() =0;
|
|
|
|
//! Return the relationship between groups and layers in the legend
|
|
virtual QList< QPair< QString, QList<QString> > > groupLayerRelationship();
|
|
|
|
//! Return all layers in the project in legend order
|
|
//! @note added in 1.5
|
|
virtual QList< QgsMapLayer * > layers() const =0;
|
|
|
|
//! Check if a group exists
|
|
//! @note added in 1.5
|
|
virtual bool groupExists( int groupIndex ) =0;
|
|
|
|
//! Check if a group is expanded
|
|
//! @note added in 1.5
|
|
virtual bool isGroupExpanded( int groupIndex ) =0;
|
|
|
|
//! Check if a group is visible
|
|
//! @note added in 1.5
|
|
virtual bool isGroupVisible( int groupIndex ) =0;
|
|
|
|
//! Check if a layer is visible
|
|
//! @note added in 1.5
|
|
virtual bool isLayerVisible( QgsMapLayer * ml ) =0;
|
|
|
|
signals:
|
|
|
|
//! emitted when a group index has changed
|
|
void groupIndexChanged( int oldIndex, int newIndex );
|
|
|
|
public slots:
|
|
|
|
//! Add a new group
|
|
//! @note added parent parameter in 1.7
|
|
virtual int addGroup( QString name, bool expand = true, QTreeWidgetItem* parent =0 ) = 0;
|
|
|
|
//! Add a new group
|
|
//! @note added parentIndex parameter in 1.7
|
|
virtual int addGroup( QString name, bool expand, int parentIndex ) = 0;
|
|
|
|
//! Remove group on index
|
|
virtual void removeGroup( int groupIndex ) =0;
|
|
|
|
//! Move a layer to a group
|
|
virtual void moveLayer( QgsMapLayer * layer, int groupIndex ) =0;
|
|
|
|
//! Collapse or expand a group
|
|
//! @note added in 1.5
|
|
virtual void setGroupExpanded( int groupIndex, bool expand ) =0;
|
|
|
|
//! Set the visibility of a group
|
|
//! @note added in 1.5
|
|
virtual void setGroupVisible( int groupIndex, bool visible ) =0;
|
|
|
|
//! Set the visibility of a layer
|
|
//! @note added in 1.5
|
|
virtual void setLayerVisible( QgsMapLayer * ml, bool visible ) =0;
|
|
|
|
//! refresh layer symbology
|
|
//! @note added in 1.5
|
|
virtual void refreshLayerSymbology( QgsMapLayer *layer ) =0;
|
|
};
|
|
|