qgscomposerattributetable.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposerattributetable.h
                         ---------------------------
    begin                : April 2010
    copyright            : (C) 2010 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 QGSCOMPOSERATTRIBUTETABLE_H
#define QGSCOMPOSERATTRIBUTETABLE_H

#include "qgscomposertable.h"

class QgsComposerMap;
class QgsVectorLayer;

class CORE_EXPORT QgsComposerAttributeTableCompare
{
  public:
    QgsComposerAttributeTableCompare();
    bool operator()( const QgsAttributeMap& m1, const QgsAttributeMap& m2 );

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

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

  private:
    int mCurrentSortColumn;
    bool mAscending;
};

// TODO QGIS 3.0 - remove
class CORE_EXPORT QgsComposerAttributeTable: public QgsComposerTable
{
    Q_OBJECT
  public:
    QgsComposerAttributeTable( QgsComposition* composition );
    ~QgsComposerAttributeTable();

    virtual int type() const override { return ComposerAttributeTable; }

    virtual void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override;

    bool writeXML( QDomElement& elem, QDomDocument & doc ) const override;

    bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) override;

    void setVectorLayer( QgsVectorLayer* layer );

    QgsVectorLayer* vectorLayer() const { return mVectorLayer; }

    void resetColumns();

    void setComposerMap( const QgsComposerMap* map );

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

    void setMaximumNumberOfFeatures( int features );

    int maximumNumberOfFeatures() const { return mMaximumNumberOfFeatures; }

    void setDisplayOnlyVisibleFeatures( bool visibleOnly );

    bool displayOnlyVisibleFeatures() const { return mShowOnlyVisibleFeatures; }

    bool filterFeatures() const { return mFilterFeatures; }

    void setFilterFeatures( bool filter );

    QString featureFilter() const { return mFeatureFilter; }

    void setFeatureFilter( const QString& expression );

    Q_DECL_DEPRECATED QSet<int> displayAttributes() const;

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

    Q_DECL_DEPRECATED QMap<int, QString> fieldAliasMap() const;

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

    void setSceneRect( const QRectF& rectangle ) override;

    Q_DECL_DEPRECATED void setSortAttributes( const QList<QPair<int, bool> >& att );

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

    bool getFeatureAttributes( QList<QgsAttributeMap>& attributeMaps ) override;

  private:
    QgsVectorLayer* mVectorLayer;
    const QgsComposerMap* mComposerMap;
    int mMaximumNumberOfFeatures;

    bool mShowOnlyVisibleFeatures;

    bool mFilterFeatures;
    QString mFeatureFilter;

    QList<int> fieldsToDisplay() const;

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

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

};

#endif // QGSCOMPOSERATTRIBUTETABLE_H