Branch data     Line data    Source code

       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                 :            : 
      26                 :            : /**
      27                 :            :  * \ingroup core
      28                 :            :  * \brief A layout table subclass that displays manually entered (and formatted) content.
      29                 :            :  * \since QGIS 3.12
      30                 :            : */
      31                 :            : class CORE_EXPORT QgsLayoutItemManualTable: public QgsLayoutTable
      32                 :            : {
      33                 :          0 :     Q_OBJECT
      34                 :            : 
      35                 :            :   public:
      36                 :            : 
      37                 :            :     /**
      38                 :            :      * Constructor for QgsLayoutItemManualTable, attached to the specified \a layout.
      39                 :            :      *
      40                 :            :      * Ownership is transferred to the layout.
      41                 :            :      */
      42                 :            :     QgsLayoutItemManualTable( QgsLayout *layout SIP_TRANSFERTHIS );
      43                 :            : 
      44                 :            :     ~QgsLayoutItemManualTable() override;
      45                 :            : 
      46                 :            :     int type() const override;
      47                 :            :     QIcon icon() const override;
      48                 :            :     QString displayName() const override;
      49                 :            : 
      50                 :            :     /**
      51                 :            :      * Returns a new QgsLayoutItemManualTable for the specified parent \a layout.
      52                 :            :      */
      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                 :            : 
      57                 :            :     /**
      58                 :            :      * Sets the \a contents of the table.
      59                 :            :      *
      60                 :            :      * \see tableContents()
      61                 :            :      */
      62                 :            :     void setTableContents( const QgsTableContents &contents );
      63                 :            : 
      64                 :            :     /**
      65                 :            :      * Returns the contents of the table.
      66                 :            :      *
      67                 :            :      * \see contents()
      68                 :            :      */
      69                 :            :     QgsTableContents tableContents() const;
      70                 :            : 
      71                 :            :     /**
      72                 :            :      * Returns the list of row heights (in millimeters) to use when rendering the table.
      73                 :            :      *
      74                 :            :      * A height of 0 indicates that the row height should be automatically calculated.
      75                 :            :      *
      76                 :            :      * \see setRowHeights()
      77                 :            :      * \see columnWidths()
      78                 :            :      */
      79                 :            :     QList< double > rowHeights() const { return mRowHeights; }
      80                 :            : 
      81                 :            :     /**
      82                 :            :      * Sets the list of row \a heights (in millimeters) to use when rendering the table.
      83                 :            :      *
      84                 :            :      * A height of 0 indicates that the row height should be automatically calculated.
      85                 :            :      *
      86                 :            :      * \see rowHeights()
      87                 :            :      * \see setColumnWidths()
      88                 :            :      */
      89                 :            :     void setRowHeights( const QList< double > &heights );
      90                 :            : 
      91                 :            :     /**
      92                 :            :      * Returns the list of column widths (in millimeters) to use when rendering the table.
      93                 :            :      *
      94                 :            :      * A width of 0 indicates that the column width should be automatically calculated.
      95                 :            :      *
      96                 :            :      * \see setColumnWidths()
      97                 :            :      * \see rowHeights()
      98                 :            :      */
      99                 :            :     QList< double > columnWidths() const { return mColumnWidths; }
     100                 :            : 
     101                 :            :     /**
     102                 :            :      * Sets the list of column \a widths (in millimeters) to use when rendering the table.
     103                 :            :      *
     104                 :            :      * A width of 0 indicates that the column width should be automatically calculated.
     105                 :            :      *
     106                 :            :      * \see columnWidths()
     107                 :            :      * \see setColumnWidths()
     108                 :            :      */
     109                 :            :     void setColumnWidths( const QList< double > &widths );
     110                 :            : 
     111                 :            :     /**
     112                 :            :      * Returns TRUE if the table includes a header row.
     113                 :            :      *
     114                 :            :      * \see setIncludeTableHeader()
     115                 :            :      */
     116                 :            :     bool includeTableHeader() const;
     117                 :            : 
     118                 :            :     /**
     119                 :            :      * Sets whether the table includes a header row.
     120                 :            :      *
     121                 :            :      * \see includeTableHeader()
     122                 :            :      */
     123                 :            :     void setIncludeTableHeader( bool included );
     124                 :            : 
     125                 :            :     /**
     126                 :            :      * Returns a reference to the list of headers shown in the table
     127                 :            :      * \see setHeaders()
     128                 :            :      */
     129                 :            :     QgsLayoutTableColumns &headers();
     130                 :            : 
     131                 :            :     /**
     132                 :            :      * Replaces the headers in the table with a specified list of QgsLayoutTableColumns.
     133                 :            :      * \see headers()
     134                 :            :      */
     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                 :            :     QgsTextFormat textFormatForHeader( int column ) const override;
     143                 :            :     QgsTextFormat textFormatForCell( int row, int column ) const override;
     144                 :            :     Qt::Alignment horizontalAlignmentForCell( int row, int column ) const override;
     145                 :            :     Qt::Alignment verticalAlignmentForCell( int row, int column ) const override;
     146                 :            : 
     147                 :            :   private:
     148                 :            : 
     149                 :            :     QgsTableContents mContents;
     150                 :            :     QgsLayoutTableColumns mHeaders;
     151                 :            : 
     152                 :            :     QList< double > mRowHeights;
     153                 :            :     QList< double > mColumnWidths;
     154                 :            :     bool mIncludeHeader = false;
     155                 :            : 
     156                 :            :     void refreshColumns();
     157                 :            : 
     158                 :            : };
     159                 :            : 
     160                 :            : #endif // QGSLAYOUTITEMMANUALTABLE_H