QGIS/python/core/auto_generated/layout/qgslayouttable.sip.in

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgslayouttable.h                                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/





typedef QVector< QVariant > QgsLayoutTableRow;

typedef QVector< QVector< QVariant > > QgsLayoutTableContents;


typedef QVector< QgsLayoutTableColumn * > QgsLayoutTableColumns;



class QgsLayoutTableStyle
{
%Docstring
Styling option for a composer table cell

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgslayouttable.h"
%End
  public:

    QgsLayoutTableStyle();
%Docstring
Constructor for QgsLayoutTableStyle
%End

    bool enabled;

    QColor cellBackgroundColor;

    bool writeXml( QDomElement &styleElem, QDomDocument &doc ) const;
%Docstring
Writes the style's properties to XML for storage.

:param styleElem: an existing QDomElement in which to store the style's properties.
:param doc: QDomDocument for the destination XML.

.. seealso:: :py:func:`readXml`
%End

    bool readXml( const QDomElement &styleElem );
%Docstring
Reads the style's properties from XML.

:param styleElem: a QDomElement holding the style's desired properties.

.. seealso:: :py:func:`writeXml`
%End

};

class QgsLayoutTable: QgsLayoutMultiFrame
{
%Docstring
A class to display a table in the print layout, and allow
the table to span over multiple frames

.. versionadded:: 3.0
%End

%TypeHeaderCode
#include "qgslayouttable.h"
%End
  public:

    enum HeaderHAlignment
    {
      FollowColumn,
      HeaderLeft,
      HeaderCenter,
      HeaderRight
    };

    enum HeaderMode
    {
      FirstFrame,
      AllFrames,
      NoHeaders
    };

    enum EmptyTableMode
    {
      HeadersOnly,
      HideTable,
      ShowMessage
    };

    enum WrapBehavior
    {
      TruncateText,
      WrapText
    };

    enum CellStyleGroup
    {
      OddColumns,
      EvenColumns,
      OddRows,
      EvenRows,
      FirstColumn,
      LastColumn,
      HeaderRow,
      FirstRow,
      LastRow
    };

    QgsLayoutTable( QgsLayout *layout );
%Docstring
Constructor for QgsLayoutTable, belonging to the specified ``layout``.
%End

    ~QgsLayoutTable();

    void setCellMargin( double margin );
%Docstring
Sets the ``margin`` distance in mm between cell borders and their contents.

.. seealso:: :py:func:`cellMargin`
%End

    double cellMargin() const;
%Docstring
Returns the margin distance between cell borders and their contents in mm.

.. seealso:: :py:func:`setCellMargin`
%End

    void setEmptyTableBehavior( EmptyTableMode mode );
%Docstring
Sets the behavior ``mode`` for empty tables with no content rows.

.. seealso:: :py:func:`emptyTableBehavior`
%End

    EmptyTableMode emptyTableBehavior() const;
%Docstring
Returns the behavior mode for empty tables. This property controls
how the table is drawn if it contains no content rows.

.. seealso:: :py:func:`setEmptyTableBehavior`
%End

    void setEmptyTableMessage( const QString &message );
%Docstring
Sets the ``message`` for empty tables with no content rows. This message
is displayed in the table body if the empty table behavior is
set to ShowMessage.

.. seealso:: :py:func:`emptyTableMessage`

.. seealso:: :py:func:`setEmptyTableBehavior`
%End

    QString emptyTableMessage() const;
%Docstring
Returns the message for empty tables with no content rows. This message
is displayed in the table body if the empty table behavior is
set to ShowMessage.

.. seealso:: :py:func:`setEmptyTableMessage`

.. seealso:: :py:func:`emptyTableBehavior`
%End

    void setShowEmptyRows( bool showEmpty );
%Docstring
Sets whether empty rows should be drawn. Tables default to hiding empty rows.

:param showEmpty: set to ``True`` to show empty rows in the table

.. seealso:: :py:func:`showEmptyRows`
%End

    bool showEmptyRows() const;
%Docstring
Returns whether empty rows are drawn in the table.

.. seealso:: :py:func:`setShowEmptyRows`
%End

    void setHeaderFont( const QFont &font );
%Docstring
Sets the ``font`` used to draw header text in the table.

.. seealso:: :py:func:`headerFont`

.. seealso:: :py:func:`setContentFont`
%End

    QFont headerFont() const;
%Docstring
Returns the font used to draw header text in the table.

.. seealso:: :py:func:`setHeaderFont`

.. seealso:: :py:func:`contentFont`
%End

    void setHeaderFontColor( const QColor &color );
%Docstring
Sets the ``color`` used to draw header text in the table.

.. seealso:: :py:func:`headerFontColor`

.. seealso:: :py:func:`setHeaderFont`

.. seealso:: :py:func:`setContentFontColor`
%End

    QColor headerFontColor() const;
%Docstring
Returns the color used to draw header text in the table.

.. seealso:: :py:func:`setHeaderFontColor`

.. seealso:: :py:func:`headerFont`

.. seealso:: :py:func:`contentFontColor`
%End

    void setHeaderHAlignment( HeaderHAlignment alignment );
%Docstring
Sets the horizontal ``alignment`` for table headers.

.. seealso:: :py:func:`headerHAlignment`
%End

    HeaderHAlignment headerHAlignment() const;
%Docstring
Returns the horizontal alignment for table headers.

.. seealso:: :py:func:`setHeaderHAlignment`
%End

    void setHeaderMode( HeaderMode mode );
%Docstring
Sets the display ``mode`` for headers in the table. This property controls
if and where headers are shown in the table.

.. seealso:: :py:func:`headerMode`
%End

    HeaderMode headerMode() const;
%Docstring
Returns the display mode for headers in the table. This property controls
if and where headers are shown in the table.

.. seealso:: :py:func:`setHeaderMode`
%End

    void setContentFont( const QFont &font );
%Docstring
Sets the ``font`` used to draw text in table body cells.

.. seealso:: :py:func:`contentFont`

.. seealso:: :py:func:`setHeaderFont`
%End

    QFont contentFont() const;
%Docstring
Returns the font used to draw text in table body cells.

.. seealso:: :py:func:`setContentFont`

.. seealso:: :py:func:`headerFont`
%End

    void setContentFontColor( const QColor &color );
%Docstring
Sets the ``color`` used to draw text in table body cells.

.. seealso:: :py:func:`contentFontColor`

.. seealso:: :py:func:`setContentFont`

.. seealso:: :py:func:`setHeaderFontColor`
%End

    QColor contentFontColor() const;
%Docstring
Returns the color used to draw text in table body cells.

.. seealso:: :py:func:`setContentFontColor`

.. seealso:: :py:func:`contentFont`

.. seealso:: :py:func:`headerFontColor`
%End

    void setShowGrid( bool showGrid );
%Docstring
Sets whether grid lines should be drawn in the table

:param showGrid: set to ``True`` to show grid lines

.. seealso:: :py:func:`showGrid`

.. seealso:: :py:func:`setGridStrokeWidth`

.. seealso:: :py:func:`setGridColor`
%End

    bool showGrid() const;
%Docstring
Returns whether grid lines are drawn in the table

.. seealso:: :py:func:`setShowGrid`

.. seealso:: :py:func:`gridStrokeWidth`

.. seealso:: :py:func:`gridColor`
%End

    void setGridStrokeWidth( double width );
%Docstring
Sets the ``width`` in mm for grid lines in the table.

.. seealso:: :py:func:`gridStrokeWidth`

.. seealso:: :py:func:`setShowGrid`

.. seealso:: :py:func:`setGridColor`
%End

    double gridStrokeWidth() const;
%Docstring
Returns the width of grid lines in the table in mm.

.. seealso:: :py:func:`setGridStrokeWidth`

.. seealso:: :py:func:`showGrid`

.. seealso:: :py:func:`gridColor`
%End

    void setGridColor( const QColor &color );
%Docstring
Sets the ``color`` used for grid lines in the table.

.. seealso:: :py:func:`gridColor`

.. seealso:: :py:func:`setShowGrid`

.. seealso:: :py:func:`setGridStrokeWidth`
%End

    QColor gridColor() const;
%Docstring
Returns the color used for grid lines in the table.

.. seealso:: :py:func:`setGridColor`

.. seealso:: :py:func:`showGrid`

.. seealso:: :py:func:`gridStrokeWidth`
%End

    void setHorizontalGrid( bool horizontalGrid );
%Docstring
Sets whether the grid's horizontal lines should be drawn in the table

:param horizontalGrid: set to ``True`` to draw grid's horizontal lines

.. seealso:: :py:func:`setShowGrid`

.. seealso:: :py:func:`setGridStrokeWidth`

.. seealso:: :py:func:`setGridColor`

.. seealso:: :py:func:`setVerticalGrid`
%End

    bool horizontalGrid() const;
%Docstring
Returns whether the grid's horizontal lines are drawn in the table.

.. seealso:: :py:func:`setShowGrid`

.. seealso:: :py:func:`setGridStrokeWidth`

.. seealso:: :py:func:`setGridColor`

.. seealso:: :py:func:`setVerticalGrid`
%End

    void setVerticalGrid( bool verticalGrid );
%Docstring
Sets whether the grid's vertical lines should be drawn in the table

:param verticalGrid: set to ``True`` to draw grid's vertical lines

.. seealso:: :py:func:`setShowGrid`

.. seealso:: :py:func:`setGridStrokeWidth`

.. seealso:: :py:func:`setGridColor`

.. seealso:: :py:func:`setHorizontalGrid`
%End

    bool verticalGrid() const;
%Docstring
Returns whether the grid's vertical lines are drawn in the table.

.. seealso:: :py:func:`setShowGrid`

.. seealso:: :py:func:`setGridStrokeWidth`

.. seealso:: :py:func:`setGridColor`

.. seealso:: :py:func:`setHorizontalGrid`
%End

    void setBackgroundColor( const QColor &color );
%Docstring
Sets the ``color`` used for background of table.

.. seealso:: :py:func:`backgroundColor`

.. seealso:: :py:func:`setGridColor`
%End

    QColor backgroundColor() const;
%Docstring
Returns the color used for the background of the table.

.. seealso:: :py:func:`setBackgroundColor`

.. seealso:: :py:func:`gridColor`
%End

    void setWrapBehavior( WrapBehavior behavior );
%Docstring
Sets the wrap ``behavior`` for the table, which controls how text within cells is
automatically wrapped.

.. seealso:: :py:func:`wrapBehavior`
%End

    WrapBehavior wrapBehavior() const;
%Docstring
Returns the wrap behavior for the table, which controls how text within cells is
automatically wrapped.

.. seealso:: :py:func:`setWrapBehavior`
%End

    QgsLayoutTableColumns &columns();
%Docstring
Returns a reference to the list of QgsLayoutTableColumns shown in the table

.. seealso:: :py:func:`setColumns`
%End

    void setColumns( const QgsLayoutTableColumns &columns );
%Docstring
Replaces the columns in the table with a specified list of QgsLayoutTableColumns.

:param columns: list of QgsLayoutTableColumns to show in table.

.. seealso:: :py:func:`columns`
%End

    void setCellStyle( CellStyleGroup group, const QgsLayoutTableStyle &style );
%Docstring
Sets the cell ``style`` for a cell ``group``.

.. seealso:: :py:func:`cellStyle`
%End

    const QgsLayoutTableStyle *cellStyle( CellStyleGroup group ) const;
%Docstring
Returns the cell style for a cell ``group``.

.. seealso:: :py:func:`setCellStyle`
%End


    virtual bool getTableContents( QgsLayoutTableContents &contents ) = 0;
%Docstring
Fetches the contents used for the cells in the table.

:return: ``True`` if table contents were successfully retrieved.

:param contents: QgsLayoutTableContents to store retrieved row data in
%End

    QgsLayoutTableContents &contents();
%Docstring
Returns the current contents of the table. Excludes header cells.
%End

    virtual QSizeF fixedFrameSize( int frameIndex = -1 ) const;

    virtual QSizeF minFrameSize( int frameIndex = -1 ) const;


    virtual bool writePropertiesToElement( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const;

    virtual bool readPropertiesFromElement( const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context );

    virtual QSizeF totalSize() const;

    virtual void render( QgsLayoutItemRenderContext &context, const QRectF &renderExtent, int frameIndex );


  public slots:

    virtual void refresh();


    virtual void refreshAttributes();
%Docstring
Refreshes the contents shown in the table by querying for new data.
This also causes the column widths and size of the table to change to accommodate the
new data.
%End

    virtual void recalculateFrameSizes();


  protected:























    virtual bool calculateMaxColumnWidths();
%Docstring
Calculates the maximum width of text shown in columns.
%End

    virtual bool calculateMaxRowHeights();
%Docstring
Calculates the maximum height of text shown in rows.
%End

    double totalWidth();

    double totalHeight();

    int rowsVisible( double frameHeight, int firstRow, bool includeHeader, bool includeEmptyRows ) const;
%Docstring
Calculates how many content rows would be visible within a frame of the specified
height.

:param frameHeight: height of frame
:param firstRow: index of first row visible in frame (where 0 = first row in table)
:param includeHeader: set to ``True`` if frame would include a header row
:param includeEmptyRows: set to ``True`` to also include rows which would be empty in the returned count. For instance,
                         if the frame would include all table content rows and have space left for extra rows then setting this parameter
                         to ``True`` would also include a count of these extra blank rows.

:return: number of visible content rows (excluding header row)
%End

    int rowsVisible( int frameIndex, int firstRow, bool includeEmptyRows ) const;
%Docstring
Calculates how many content rows are visible within a given frame.

:param frameIndex: index number for frame
:param firstRow: index of first row visible in frame (where 0 = first row in table)
:param includeEmptyRows: set to ``True`` to also include rows which would be empty in the returned count. For instance,
                         if the frame would include all table content rows and have space left for extra rows then setting this parameter
                         to ``True`` would also include a count of these extra blank rows.

:return: number of visible content rows (excludes header rows)
%End

    QPair<int, int> rowRange( int frameIndex ) const;
%Docstring
Calculates a range of rows which should be visible in a given frame.

:param frameIndex: index number for frame

:return: row range
%End

    void drawHorizontalGridLines( QPainter *painter, int firstRow, int lastRow, bool drawHeaderLines ) const;
%Docstring
Draws the horizontal grid lines for the table.

:param painter: destination painter for grid lines
:param firstRow: index corresponding to first row shown in frame
:param lastRow: index corresponding to last row shown in frame. If greater than the number of content rows in the
                table, then the default row height will be used for the remaining rows.
:param drawHeaderLines: set to ``True`` to include for the table header

.. seealso:: :py:func:`drawVerticalGridLines`
%End


    void recalculateTableSize();
%Docstring
Recalculates and updates the size of the table and all table frames.
%End

    bool contentsContainsRow( const QgsLayoutTableContents &contents, const QgsLayoutTableRow &row ) const;
%Docstring
Checks whether a table contents contains a given row

:param contents: table contents to check
:param row: row to check for

:return: ``True`` if contents contains rows
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/layout/qgslayouttable.h                                     *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 ************************************************************************/