QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgslayoutitemmanualtable.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutitemmanualtable.h
3  ---------------------------
4  begin : January 2020
5  copyright : (C) 2020 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 QGSLAYOUTITEMMANUALTABLE_H
19 #define QGSLAYOUTITEMMANUALTABLE_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include "qgslayouttable.h"
24 #include "qgstablecell.h"
25 
31 class CORE_EXPORT QgsLayoutItemManualTable: public QgsLayoutTable
32 {
33  Q_OBJECT
34 
35  public:
36 
43 
44  ~QgsLayoutItemManualTable() override;
45 
46  int type() const override;
47  QIcon icon() const override;
48  QString displayName() const override;
49 
53  static QgsLayoutItemManualTable *create( QgsLayout *layout ) SIP_FACTORY;
54  bool getTableContents( QgsLayoutTableContents &contents ) override SIP_SKIP;
55  QgsConditionalStyle conditionalCellStyle( int row, int column ) const override;
56 
62  void setTableContents( const QgsTableContents &contents );
63 
69  QgsTableContents tableContents() const;
70 
79  QList< double > rowHeights() const { return mRowHeights; }
80 
89  void setRowHeights( const QList< double > &heights );
90 
99  QList< double > columnWidths() const { return mColumnWidths; }
100 
109  void setColumnWidths( const QList< double > &widths );
110 
116  bool includeTableHeader() const;
117 
123  void setIncludeTableHeader( bool included );
124 
129  QgsLayoutTableColumns &headers();
130 
135  void setHeaders( const QgsLayoutTableColumns &headers );
136 
137  protected:
138 
139  bool writePropertiesToElement( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
140  bool readPropertiesFromElement( const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context ) override;
141  bool calculateMaxRowHeights() override;
142 
143  private:
144 
145  QgsTableContents mContents;
146  QgsLayoutTableColumns mHeaders;
147 
148  QList< double > mRowHeights;
149  QList< double > mColumnWidths;
150  bool mIncludeHeader = false;
151 
152  void refreshColumns();
153 
154 };
155 
156 #endif // QGSLAYOUTITEMMANUALTABLE_H
QgsLayoutTableColumns
QVector< QgsLayoutTableColumn > QgsLayoutTableColumns
Definition: qgslayouttable.h:57
QgsLayoutTableContents
QVector< QgsLayoutTableRow > QgsLayoutTableContents
Definition: qgslayouttable.h:46
QgsReadWriteContext
Definition: qgsreadwritecontext.h:34
QgsLayoutTable::writePropertiesToElement
bool writePropertiesToElement(QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override
Stores multiframe state within an XML DOM element.
Definition: qgslayouttable.cpp:76
QgsLayoutMultiFrame::icon
virtual QIcon icon() const
Returns the item's icon.
Definition: qgslayoutmultiframe.h:154
QgsConditionalStyle
Definition: qgsconditionalstyle.h:112
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsTableContents
QVector< QgsTableRow > QgsTableContents
A set of table rows.
Definition: qgstablecell.h:158
QgsLayoutTable::readPropertiesFromElement
bool readPropertiesFromElement(const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context) override
Sets multiframe state from a DOM element.
Definition: qgslayouttable.cpp:134
QgsLayoutMultiFrame::type
virtual int type() const =0
Returns unique multiframe type id.
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
qgslayouttable.h
qgstablecell.h
qgis_sip.h
QgsLayoutTable::getTableContents
virtual bool getTableContents(QgsLayoutTableContents &contents)=0
Fetches the contents used for the cells in the table.
QgsLayoutTable
A class to display a table in the print layout, and allow the table to span over multiple frames.
Definition: qgslayouttable.h:111
QgsLayoutTable::calculateMaxRowHeights
virtual bool calculateMaxRowHeights()
Calculates the maximum height of text shown in rows.
Definition: qgslayouttable.cpp:992
QgsLayout
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
QgsLayoutTable::conditionalCellStyle
virtual QgsConditionalStyle conditionalCellStyle(int row, int column) const
Returns the conditional style to use for the cell at row, column.
Definition: qgslayouttable.cpp:843
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
QgsLayoutMultiFrame::displayName
virtual QString displayName() const
Returns the multiframe display name.
Definition: qgslayoutmultiframe.cpp:273
QgsLayoutItemManualTable
Definition: qgslayoutitemmanualtable.h:31