QGIS/python/core/qgsmaplayerlegend.sip

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsmaplayerlegend.h                                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/






class QgsMapLayerLegend : QObject
{
%Docstring
 The QgsMapLayerLegend class is abstract interface for implementations
 of legends for one map layer.

.. versionadded:: 2.6
%End

%TypeHeaderCode
#include "qgsmaplayerlegend.h"
%End
  public:
    explicit QgsMapLayerLegend( QObject *parent /TransferThis/ = 0 );


    virtual QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) = 0 /Factory/;
%Docstring
 Return list of legend nodes to be used for a particular layer tree layer node.
 Ownership is transferred to the caller.
 :rtype: list of QgsLayerTreeModelLegendNode
%End


    static QgsMapLayerLegend *defaultVectorLegend( QgsVectorLayer *vl ) /Factory/;
%Docstring
Create new legend implementation for vector layer
 :rtype: QgsMapLayerLegend
%End

    static QgsMapLayerLegend *defaultRasterLegend( QgsRasterLayer *rl ) /Factory/;
%Docstring
Create new legend implementation for raster layer
 :rtype: QgsMapLayerLegend
%End

    static QgsMapLayerLegend *defaultPluginLegend( QgsPluginLayer *pl ) /Factory/;
%Docstring
Create new legend implementation for raster layer
 :rtype: QgsMapLayerLegend
%End

  signals:
    void itemsChanged();
%Docstring
Emitted when existing items/nodes got invalid and should be replaced by new ones
%End
};


class QgsMapLayerLegendUtils
{
%Docstring
 Miscellaneous utility functions for handling of map layer legend

.. versionadded:: 2.6
%End

%TypeHeaderCode
#include "qgsmaplayerlegend.h"
%End
  public:
    static void setLegendNodeOrder( QgsLayerTreeLayer *nodeLayer, const QList<int> &order );
    static QList<int> legendNodeOrder( QgsLayerTreeLayer *nodeLayer );
%Docstring
 :rtype: list of int
%End
    static bool hasLegendNodeOrder( QgsLayerTreeLayer *nodeLayer );
%Docstring
 :rtype: bool
%End

    static void setLegendNodeUserLabel( QgsLayerTreeLayer *nodeLayer, int originalIndex, const QString &newLabel );
    static QString legendNodeUserLabel( QgsLayerTreeLayer *nodeLayer, int originalIndex );
%Docstring
 :rtype: str
%End
    static bool hasLegendNodeUserLabel( QgsLayerTreeLayer *nodeLayer, int originalIndex );
%Docstring
 :rtype: bool
%End

    static void applyLayerNodeProperties( QgsLayerTreeLayer *nodeLayer, QList<QgsLayerTreeModelLegendNode *> &nodes );
%Docstring
update according to layer node's custom properties (order of items, user labels for items)
%End
};



class QgsDefaultVectorLayerLegend : QgsMapLayerLegend
{
%Docstring
 Default legend implementation for vector layers
.. versionadded:: 2.6
%End

%TypeHeaderCode
#include "qgsmaplayerlegend.h"
%End
  public:
    explicit QgsDefaultVectorLayerLegend( QgsVectorLayer *vl );

    virtual QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) /Factory/;

};


class QgsDefaultRasterLayerLegend : QgsMapLayerLegend
{
%Docstring
 Default legend implementation for raster layers
.. versionadded:: 2.6
%End

%TypeHeaderCode
#include "qgsmaplayerlegend.h"
%End
  public:
    explicit QgsDefaultRasterLayerLegend( QgsRasterLayer *rl );

    virtual QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) /Factory/;

};


class QgsDefaultPluginLayerLegend : QgsMapLayerLegend
{
%Docstring
 Default legend implementation for plugin layers
.. versionadded:: 2.6
%End

%TypeHeaderCode
#include "qgsmaplayerlegend.h"
%End
  public:
    explicit QgsDefaultPluginLayerLegend( QgsPluginLayer *pl );

    virtual QList<QgsLayerTreeModelLegendNode *> createLayerTreeModelLegendNodes( QgsLayerTreeLayer *nodeLayer ) /Factory/;

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgsmaplayerlegend.h                                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/