qgscomposerattributetablev2.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposerattributetablev2.h
                         ---------------------------
    begin                : September 2014
    copyright            : (C) 2014 by Marco Hugentobler
    email                : marco at hugis dot net
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSCOMPOSERATTRIBUTETABLEV2_H
#define QGSCOMPOSERATTRIBUTETABLEV2_H

#include "qgscomposertablev2.h"
#include "qgscomposerattributetable.h"
#include "qgsvectorlayerref.h"

class QgsComposerMap;
class QgsVectorLayer;

class CORE_EXPORT QgsComposerAttributeTableCompareV2
{
  public:
    QgsComposerAttributeTableCompareV2();
    bool operator()( const QgsComposerTableRow& m1, const QgsComposerTableRow& m2 );

    void setSortColumn( int col ) { mCurrentSortColumn = col; }

    void setAscending( bool asc ) { mAscending = asc; }

  private:
    int mCurrentSortColumn;
    bool mAscending;
};


class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
{
    Q_OBJECT

  public:

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

    QgsComposerAttributeTableV2( QgsComposition* composition, bool createUndoCommands );
    ~QgsComposerAttributeTableV2();

    virtual QString displayName() const override;

    virtual bool writeXML( QDomElement& elem, QDomDocument & doc, bool ignoreFrames = false ) const override;

    virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc, bool ignoreFrames = false ) override;

    virtual void addFrame( QgsComposerFrame* frame, bool recalcFrameSizes = true ) override;

    void setSource( const ContentSource source );

    ContentSource source() const { return mSource; }

    QgsVectorLayer* sourceLayer();

    void setVectorLayer( QgsVectorLayer* layer );

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

    void setRelationId( const QString& relationId );

    QString relationId() const { return mRelationId; }

    void resetColumns();

    void setComposerMap( const QgsComposerMap* map );

    const QgsComposerMap* composerMap() const { return mComposerMap; }

    void setMaximumNumberOfFeatures( const int features );

    int maximumNumberOfFeatures() const { return mMaximumNumberOfFeatures; }

    void setUniqueRowsOnly( const bool uniqueOnly );

    bool uniqueRowsOnly() const { return mShowUniqueRowsOnly; }

    void setDisplayOnlyVisibleFeatures( const bool visibleOnly );

    bool displayOnlyVisibleFeatures() const { return mShowOnlyVisibleFeatures; }

    void setFilterToAtlasFeature( const bool filterToAtlas );

    bool filterToAtlasFeature() const { return mFilterToAtlasIntersection; }

    bool filterFeatures() const { return mFilterFeatures; }

    void setFilterFeatures( const bool filter );

    QString featureFilter() const { return mFeatureFilter; }

    void setFeatureFilter( const QString& expression );

    Q_DECL_DEPRECATED void setDisplayAttributes( const QSet<int>& attr, bool refresh = true );

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

    QList<QPair<int, bool> > sortAttributes() const;

    void setWrapString( const QString& wrapString );

    QString wrapString() const { return mWrapString; }

    bool getTableContents( QgsComposerTableContents &contents ) override;

    virtual QgsExpressionContext* createExpressionContext() const override;

  private:

    ContentSource mSource;
    QgsVectorLayerRef mVectorLayer;
    QString mRelationId;

    QgsVectorLayer* mCurrentAtlasLayer;

    const QgsComposerMap* mComposerMap;
    int mMaximumNumberOfFeatures;

    bool mShowUniqueRowsOnly;

    bool mShowOnlyVisibleFeatures;

    bool mFilterToAtlasIntersection;

    bool mFilterFeatures;
    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 // QGSCOMPOSERATTRIBUTETABLEV2_H