qgscomposertable.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposertable.h
                         ------------------
    begin                : January 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 QGSCOMPOSERTABLE_H
#define QGSCOMPOSERTABLE_H

#include "qgscomposeritem.h"
#include "qgscomposition.h"
#include "qgsfeature.h"
#include <QSet>
#include <QObject>

class QgsComposerTableColumn;

//TODO QGIS 3.0 -remove
class CORE_EXPORT QgsComposerTable: public QgsComposerItem
{
    Q_OBJECT

  public:

    enum HeaderHAlignment
    {
      FollowColumn, 
      HeaderLeft, 
      HeaderCenter, 
      HeaderRight 
    };

    QgsComposerTable( QgsComposition* composition );
    virtual ~QgsComposerTable();

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

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

    virtual bool writeXML( QDomElement& elem, QDomDocument & doc ) const override = 0;
    virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) override = 0;

    void setLineTextDistance( double d );

    double lineTextDistance() const { return mLineTextDistance; }

    void setHeaderFont( const QFont& f );

    QFont headerFont() const { return mHeaderFont; }

    void setHeaderFontColor( const QColor& color );

    QColor headerFontColor() const { return mHeaderFontColor; }

    void setHeaderHAlignment( const HeaderHAlignment alignment );

    HeaderHAlignment headerHAlignment() const { return mHeaderHAlignment; }

    void setContentFont( const QFont& f );

    QFont contentFont() const { return mContentFont; }

    void setContentFontColor( const QColor& color );

    QColor contentFontColor() const { return mContentFontColor; }

    void setShowGrid( bool show );

    bool showGrid() const { return mShowGrid; }

    void setGridStrokeWidth( double w );

    double gridStrokeWidth() const { return mGridStrokeWidth; }

    void setGridColor( const QColor& c ) { mGridColor = c; }

    QColor gridColor() const { return mGridColor; }

    virtual QMap<int, QString> headerLabels() const;

    //TODO - make this more generic for next API break, eg rename as getRowValues, use QStringList rather than
    //QgsAttributeMap

    virtual bool getFeatureAttributes( QList<QgsAttributeMap>& attributeMaps ) { Q_UNUSED( attributeMaps ); return false; }

    QList<QgsComposerTableColumn*>* columns() { return &mColumns; }

    void setColumns( const QList<QgsComposerTableColumn*>& columns );

  public slots:

    virtual void refreshAttributes();

    virtual void adjustFrameToSize();

  protected:
    double mLineTextDistance;

    QFont mHeaderFont;
    QColor mHeaderFontColor;
    QFont mContentFont;
    QColor mContentFontColor;

    HeaderHAlignment mHeaderHAlignment;

    bool mShowGrid;
    double mGridStrokeWidth;
    QColor mGridColor;

    QList<QgsAttributeMap> mAttributeMaps;
    QMap<int, double> mMaxColumnWidthMap;

    QList<QgsComposerTableColumn*> mColumns;

    virtual bool calculateMaxColumnWidths( QMap<int, double>& maxWidthMap, const QList<QgsAttributeMap>& attributeMaps ) const;

    void adaptItemFrame( const QMap<int, double>& maxWidthMap, const QList<QgsAttributeMap>& attributeMaps );

    void drawHorizontalGridLines( QPainter* p, int nAttributes );

    void drawVerticalGridLines( QPainter* p, const QMap<int, double>& maxWidthMap );

    bool tableWriteXML( QDomElement& itemElem, QDomDocument& doc ) const;

    bool tableReadXML( const QDomElement& itemElem, const QDomDocument& doc );
};

#endif // QGSCOMPOSERTABLE_H