Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                          qgslayoutitemtexttable.h
       3                 :            :                          ----------------------
       4                 :            :     begin                : November 2017
       5                 :            :     copyright            : (C) 2017 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSLAYOUTTEXTTABLE_H
      19                 :            : #define QGSLAYOUTTEXTTABLE_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis_sip.h"
      23                 :            : #include "qgslayouttable.h"
      24                 :            : 
      25                 :            : /**
      26                 :            :  * \ingroup core
      27                 :            :  * \brief A text table item that reads text from string lists
      28                 :            :  * \since QGIS 3.0
      29                 :            : */
      30                 :            : class CORE_EXPORT QgsLayoutItemTextTable : public QgsLayoutTable
      31                 :            : {
      32                 :            : 
      33                 :          0 :     Q_OBJECT
      34                 :            : 
      35                 :            :   public:
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * Constructor for QgsLayoutItemTextTable, for the specified \a layout.
      39                 :            :      *
      40                 :            :      * Ownership is transferred to the layout.
      41                 :            :      */
      42                 :            :     QgsLayoutItemTextTable( QgsLayout *layout SIP_TRANSFERTHIS );
      43                 :            : 
      44                 :            :     int type() const override;
      45                 :            :     QString displayName() const override;
      46                 :            : 
      47                 :            :     /**
      48                 :            :      * Returns a new QgsLayoutItemTextTable for the specified parent \a layout.
      49                 :            :      */
      50                 :            :     static QgsLayoutItemTextTable *create( QgsLayout *layout ) SIP_FACTORY;
      51                 :            : 
      52                 :            :     /**
      53                 :            :      * Adds a row to the table
      54                 :            :      * \param row list of strings to use for each cell's value in the newly added row
      55                 :            :      * \note If row is shorter than the number of columns in the table than blank cells
      56                 :            :      * will be inserted at the end of the row. If row contains more strings then the number
      57                 :            :      * of columns in the table then these extra strings will be ignored.
      58                 :            :      * \note if adding many rows, setContents() is much faster
      59                 :            :      */
      60                 :            :     void addRow( const QStringList &row );
      61                 :            : 
      62                 :            :     /**
      63                 :            :      * Sets the contents of the text table.
      64                 :            :      * \param contents list of table rows
      65                 :            :      * \see addRow
      66                 :            :      */
      67                 :            :     void setContents( const QVector< QStringList > &contents );
      68                 :            : 
      69                 :            :     bool getTableContents( QgsLayoutTableContents &contents ) override;
      70                 :            : 
      71                 :            :   private:
      72                 :            :     //! One stringlist per row
      73                 :            :     QVector< QStringList > mRowText;
      74                 :            : };
      75                 :            : 
      76                 :            : #endif // QGSLAYOUTTEXTTABLE_H