qgslayoutitemattributetable.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitemattributetable.h
                         ---------------------------
    begin                : November 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson 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 QGSLAYOUTITEMATTRIBUTETABLE_H
#define QGSLAYOUTITEMATTRIBUTETABLE_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgis.h"
#include "qgslayouttable.h"
#include "qgsvectorlayerref.h"

class QgsLayoutItemMap;
class QgsVectorLayer;

class CORE_EXPORT QgsLayoutItemAttributeTable: public QgsLayoutTable
{
    Q_OBJECT

  public:

    enum ContentSource
    {
      LayerAttributes = 0, 
      AtlasFeature, 
      RelationChildren 
    };

    QgsLayoutItemAttributeTable( QgsLayout *layout SIP_TRANSFERTHIS );

    int type() const override;
    QIcon icon() const override;
    QString displayName() const override;

    static QgsLayoutItemAttributeTable *create( QgsLayout *layout ) SIP_FACTORY;

    void setSource( ContentSource source );

    ContentSource source() const { return mSource; }

    QgsVectorLayer *sourceLayer() const;

    void setVectorLayer( QgsVectorLayer *layer );

    QgsVectorLayer *vectorLayer() const { return mVectorLayer.get(); }

    void setRelationId( const QString &id );

    QString relationId() const { return mRelationId; }

    void resetColumns();

    void setMap( QgsLayoutItemMap *map );

    QgsLayoutItemMap *map() const { return mMap; }

    void setMaximumNumberOfFeatures( int features );

    int maximumNumberOfFeatures() const { return mMaximumNumberOfFeatures; }

    void setUniqueRowsOnly( bool uniqueOnly );

    bool uniqueRowsOnly() const { return mShowUniqueRowsOnly; }

    void setDisplayOnlyVisibleFeatures( bool visibleOnly );

    bool displayOnlyVisibleFeatures() const { return mShowOnlyVisibleFeatures; }

    void setFilterToAtlasFeature( bool filterToAtlas );

    bool filterToAtlasFeature() const { return mFilterToAtlasIntersection; }

    bool filterFeatures() const { return mFilterFeatures; }

    void setFilterFeatures( bool filter );

    QString featureFilter() const { return mFeatureFilter; }

    void setFeatureFilter( const QString &expression );

    void setDisplayedFields( const QStringList &fields, bool refresh = true );

    QVector< QPair<int, bool> > sortAttributes() const SIP_SKIP;

    void setWrapString( const QString &wrapString );

    QString wrapString() const { return mWrapString; }

    bool getTableContents( QgsLayoutTableContents &contents ) override SIP_SKIP;

    QgsExpressionContext createExpressionContext() const override;
    void finalizeRestoreFromXml() override;

    void refreshDataDefinedProperty( QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::AllProperties ) override;

  protected:

    bool writePropertiesToElement( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    bool readPropertiesFromElement( const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context ) override;

  private:

    ContentSource mSource = LayerAttributes;
    QgsVectorLayerRef mVectorLayer;

    QPointer< QgsVectorLayer > mDataDefinedVectorLayer;

    QString mRelationId;

    QgsVectorLayer *mCurrentAtlasLayer = nullptr;

    QgsLayoutItemMap *mMap = nullptr;
    QString mMapUuid;

    int mMaximumNumberOfFeatures = 30;

    bool mShowUniqueRowsOnly = false;

    bool mShowOnlyVisibleFeatures = false;

    bool mFilterToAtlasIntersection = false;

    bool mFilterFeatures = false;

    QString mFeatureFilter;

    QString mWrapString;

    QList<int> fieldsToDisplay() const;

    void restoreFieldAliasMap( const QMap<int, QString> &map );

    QVariant replaceWrapChar( const QVariant &variant ) const;

  private slots:
    void removeLayer( const QString &layerId );

    void atlasLayerChanged( QgsVectorLayer *layer );

};

#endif // QGSLAYOUTITEMATTRIBUTETABLE_H