qgslayertreelayer.h

Go to the documentation of this file.

/***************************************************************************
  qgslayertreelayer.h
  --------------------------------------
  Date                 : May 2014
  Copyright            : (C) 2014 by Martin Dobias
  Email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSLAYERTREELAYER_H
#define QGSLAYERTREELAYER_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayertreenode.h"
#include "qgslegendpatchshape.h"
#include "qgsmaplayerref.h"
#include "qgsreadwritecontext.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsMapLayer;

class CORE_EXPORT QgsLayerTreeLayer : public QgsLayerTreeNode
{
    Q_OBJECT
  public:
    explicit QgsLayerTreeLayer( QgsMapLayer *layer );
 
#ifndef SIP_RUN
    QgsLayerTreeLayer( const QgsLayerTreeLayer &other );
#endif

    explicit QgsLayerTreeLayer( const QString &layerId, const QString &name = QString(), const QString &source = QString(), const QString &provider = QString() );
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    QString str = u"<QgsLayerTreeLayer: %1>"_s.arg( sipCpp->name() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif

        QString layerId() const
    {
      return mRef.layerId;
    }

    QgsMapLayer *layer() const { return mRef.get(); }

    QString name() const override;

    void setName( const QString &n ) override;

    void setUseLayerName( bool use = true );

    bool useLayerName() const;

    static QgsLayerTreeLayer *readXml( QDomElement &element, const QgsReadWriteContext &context ) SIP_FACTORY; // cppcheck-suppress duplInheritedMember

    static QgsLayerTreeLayer *readXml( QDomElement &element, const QgsProject *project, const QgsReadWriteContext &context ) SIP_FACTORY;
 
    void writeXml( QDomElement &parentElement, const QgsReadWriteContext &context ) override;
 
    QString dump() const override;
 
    QgsLayerTreeLayer *clone() const override SIP_FACTORY;

    void resolveReferences( const QgsProject *project, bool looseMatching = false ) override;

    void setLabelExpression( const QString &expression );

    QString labelExpression() const { return mLabelExpression; }

    QgsLegendPatchShape patchShape() const;

    void setPatchShape( const QgsLegendPatchShape &shape );

    QSizeF patchSize() const { return mPatchSize; }

    void setPatchSize( QSizeF size ) { mPatchSize = size; }

    enum LegendNodesSplitBehavior
    {
      UseDefaultLegendSetting,                        
      AllowSplittingLegendNodesOverMultipleColumns,   
      PreventSplittingLegendNodesOverMultipleColumns, 
    };

    LegendNodesSplitBehavior legendSplitBehavior() const { return mSplitBehavior; }

    void setLegendSplitBehavior( LegendNodesSplitBehavior behavior ) { mSplitBehavior = behavior; }
 
  signals:

    void layerLoaded();

    void layerWillBeUnloaded();
 
  protected:
    void attachToLayer();

    QgsMapLayerRef mRef;
    QString mLayerName;
    QString mLabelExpression;

    bool mUseLayerName = true;
 
  private slots:

    void layerNameChanged();

    void layerWillBeDeleted();
 
  private:
#ifdef SIP_RUN

    QgsLayerTreeLayer( const QgsLayerTreeLayer &other );
#endif
 
    QgsLegendPatchShape mPatchShape;
    QSizeF mPatchSize;
    LegendNodesSplitBehavior mSplitBehavior = UseDefaultLegendSetting;
 
    QgsLayerTreeLayer &operator=( const QgsLayerTreeLayer & ) = delete;
};
 
 
#endif // QGSLAYERTREELAYER_H