QGIS API Documentation  3.21.0-Master (5b68dc587e)
qgslayoutitemtexttable.h
Go to the documentation of this file.
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 
30 class CORE_EXPORT QgsLayoutItemTextTable : public QgsLayoutTable
31 {
32 
33  Q_OBJECT
34 
35  public:
36 
43 
44  int type() const override;
45  QString displayName() const override;
46 
50  static QgsLayoutItemTextTable *create( QgsLayout *layout ) SIP_FACTORY;
51 
60  void addRow( const QStringList &row );
61 
67  void setContents( const QVector< QStringList > &contents );
68 
69  bool getTableContents( QgsLayoutTableContents &contents ) override;
70 
71  private:
73  QVector< QStringList > mRowText;
74 };
75 
76 #endif // QGSLAYOUTTEXTTABLE_H
A text table item that reads text from string lists.
virtual int type() const =0
Returns unique multiframe type id.
virtual QString displayName() const
Returns the multiframe display name.
A class to display a table in the print layout, and allow the table to span over multiple frames.
virtual bool getTableContents(QgsLayoutTableContents &contents)=0
Fetches the contents used for the cells in the table.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:51
QVector< QgsLayoutTableRow > QgsLayoutTableContents
List of QgsLayoutTableRows, representing rows and column cell contents for a QgsLayoutTable.
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
#define SIP_FACTORY
Definition: qgis_sip.h:76