qgscomposertablev2.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposertablev2.h
                         ------------------
    begin                : July 2014
    copyright            : (C) 2014 by Nyall Dawson, Marco Hugentobler
    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 QGSCOMPOSERTABLEV2_H
#define QGSCOMPOSERTABLEV2_H

#include "qgscomposermultiframe.h"
#include <QFont>
#include <QColor>
#include <QPair>

class QgsComposerTableColumn;

typedef QList< QVariant > QgsComposerTableRow;

typedef QList< QgsComposerTableRow > QgsComposerTableContents;

typedef QList<QgsComposerTableColumn*> QgsComposerTableColumns;


class CORE_EXPORT QgsComposerTableStyle
{
  public:

    QgsComposerTableStyle()
        : enabled( false )
        , cellBackgroundColor( QColor( 255, 255, 255, 255 ) )
    {}

    bool enabled;

    QColor cellBackgroundColor;

    bool writeXML( QDomElement& styleElem, QDomDocument & doc ) const;

    bool readXML( const QDomElement& styleElem );

};

class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
{
    Q_OBJECT

  public:

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

    enum HeaderMode
    {
      FirstFrame = 0, 
      AllFrames, 
      NoHeaders 
    };

    enum EmptyTableMode
    {
      HeadersOnly = 0, 
      HideTable, 
      ShowMessage 
    };

    enum WrapBehaviour
    {
      TruncateText = 0, 
      WrapText 
    };

    enum CellStyleGroup
    {
      OddColumns, 
      EvenColumns, 
      OddRows, 
      EvenRows, 
      FirstColumn, 
      LastColumn, 
      HeaderRow, 
      FirstRow, 
      LastRow 
    };

    QgsComposerTableV2( QgsComposition* composition, bool createUndoCommands );
    QgsComposerTableV2();

    virtual ~QgsComposerTableV2();

    void setCellMargin( const double margin );

    double cellMargin() const { return mCellMargin; }

    void setEmptyTableBehaviour( const EmptyTableMode mode );

    EmptyTableMode emptyTableBehaviour() const { return mEmptyTableMode; }

    void setEmptyTableMessage( const QString& message );

    QString emptyTableMessage() const { return mEmptyTableMessage; }

    void setShowEmptyRows( const bool showEmpty );

    bool showEmptyRows() const { return mShowEmptyRows; }

    void setHeaderFont( const QFont& font );

    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 setHeaderMode( const HeaderMode mode );

    HeaderMode headerMode() const { return mHeaderMode; }

    void setContentFont( const QFont& font );

    QFont contentFont() const { return mContentFont; }

    void setContentFontColor( const QColor& color );

    QColor contentFontColor() const { return mContentFontColor; }

    void setShowGrid( const bool showGrid );

    bool showGrid() const { return mShowGrid; }

    void setGridStrokeWidth( const double width );

    double gridStrokeWidth() const { return mGridStrokeWidth; }

    void setGridColor( const QColor& color );

    QColor gridColor() const { return mGridColor; }

    void setBackgroundColor( const QColor& color );

    QColor backgroundColor() const { return mBackgroundColor; }

    void setWrapBehaviour( WrapBehaviour behaviour );

    WrapBehaviour wrapBehaviour() const { return mWrapBehaviour; }

    QgsComposerTableColumns* columns() { return &mColumns; }

    void setColumns( const QgsComposerTableColumns& columns );

    void setCellStyle( CellStyleGroup group, const QgsComposerTableStyle& style );

    const QgsComposerTableStyle* cellStyle( CellStyleGroup group ) const;

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

    virtual bool getTableContents( QgsComposerTableContents &contents ) = 0;

    QgsComposerTableContents* contents() { return &mTableContents; }

    //reimplemented to return fixed table width
    virtual QSizeF fixedFrameSize( const int frameIndex = -1 ) const override;

    //reimplemented to return min frame height
    virtual QSizeF minFrameSize( const int frameIndex = -1 ) 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 QSizeF totalSize() const override;
    virtual void render( QPainter* p, const QRectF& renderExtent, const int frameIndex ) override;

  public slots:

    virtual void refreshAttributes();

    void recalculateFrameSizes() override;

  protected:
    double mCellMargin;

    EmptyTableMode mEmptyTableMode;

    QString mEmptyTableMessage;

    bool mShowEmptyRows;

    QFont mHeaderFont;

    QColor mHeaderFontColor;

    HeaderHAlignment mHeaderHAlignment;

    HeaderMode mHeaderMode;

    QFont mContentFont;

    QColor mContentFontColor;

    bool mShowGrid;

    double mGridStrokeWidth;

    QColor mGridColor;

    QColor mBackgroundColor;

    QgsComposerTableColumns mColumns;

    QgsComposerTableContents mTableContents;

    QMap<int, double> mMaxColumnWidthMap;

    QMap<int, double> mMaxRowHeightMap;

    QSizeF mTableSize;

    WrapBehaviour mWrapBehaviour;

    QMap< CellStyleGroup, QgsComposerTableStyle* > mCellStyles;

    virtual bool calculateMaxColumnWidths();

    virtual bool calculateMaxRowHeights();

    //not const, as needs to call calculateMaxColumnWidths()
    double totalWidth();

    //not const, as needs to call calculateMaxRowHeights()
    double totalHeight();

    int rowsVisible( double frameHeight, int firstRow, bool includeHeader, bool includeEmptyRows ) const;

    int rowsVisible( int frameIndex, int firstRow, bool includeEmptyRows ) const;

    QPair<int, int> rowRange( const int frameIndex ) const;

    void drawHorizontalGridLines( QPainter* painter, int firstRow, int lastRow, bool drawHeaderLines ) const;

    void drawVerticalGridLines( QPainter* painter, const QMap<int, double>& maxWidthMap, int firstRow, int lastRow, bool hasHeader, bool mergeCells = false ) const;

    void recalculateTableSize();

    bool contentsContainsRow( const QgsComposerTableContents &contents, const QgsComposerTableRow &row ) const;

    //deprecated methods

    Q_DECL_DEPRECATED int rowsVisible( const int frameIndex ) const;

    Q_DECL_DEPRECATED int rowsVisible( const double frameHeight, const bool includeHeader ) const;

    Q_DECL_DEPRECATED QPair<int, int> rowRange( const QRectF &extent, const int frameIndex ) const;

    Q_DECL_DEPRECATED void drawHorizontalGridLines( QPainter* painter, const int rows, const bool drawHeaderLines ) const;

    Q_DECL_DEPRECATED void drawVerticalGridLines( QPainter* painter, const QMap<int, double>& maxWidthMap, const int numberRows, const bool hasHeader, const bool mergeCells = false ) const;

  private:

    QMap< CellStyleGroup, QString > mCellStyleNames;

    void initStyles();

    bool textRequiresWrapping( const QString& text, double columnWidth , const QFont &font ) const;

    QString wrappedText( const QString &value, double columnWidth, const QFont &font ) const;

    QColor backgroundColor( int row, int column ) const;

    friend class TestQgsComposerTableV2;
};

#endif // QGSCOMPOSERTABLEV2_H