qgslayoutitemmanualtable.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitemmanualtable.h
                         ---------------------------
    begin                : January 2020
    copyright            : (C) 2020 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 QGSLAYOUTITEMMANUALTABLE_H
#define QGSLAYOUTITEMMANUALTABLE_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayouttable.h"
#include "qgstablecell.h"

class CORE_EXPORT QgsLayoutItemManualTable: public QgsLayoutTable
{
    Q_OBJECT

  public:

    QgsLayoutItemManualTable( QgsLayout *layout SIP_TRANSFERTHIS );

    ~QgsLayoutItemManualTable() override;

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

    static QgsLayoutItemManualTable *create( QgsLayout *layout ) SIP_FACTORY;
    bool getTableContents( QgsLayoutTableContents &contents ) override SIP_SKIP;
    QgsConditionalStyle conditionalCellStyle( int row, int column ) const override;

    void setTableContents( const QgsTableContents &contents );

    QgsTableContents tableContents() const;

    QList< double > rowHeights() const { return mRowHeights; }

    void setRowHeights( const QList< double > &heights );

    QList< double > columnWidths() const { return mColumnWidths; }

    void setColumnWidths( const QList< double > &widths );

    bool includeTableHeader() const;

    void setIncludeTableHeader( bool included );

    QgsLayoutTableColumns &headers();

    void setHeaders( const QgsLayoutTableColumns &headers );

  protected:

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

  private:

    QgsTableContents mContents;
    QgsLayoutTableColumns mHeaders;

    QList< double > mRowHeights;
    QList< double > mColumnWidths;
    bool mIncludeHeader = false;

    void refreshColumns();

};

#endif // QGSLAYOUTITEMMANUALTABLE_H