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

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




class QgsLayoutItemTextTable : QgsLayoutTable
{
%Docstring
A text table item that reads text from string lists

.. versionadded:: 3.0
%End

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

    QgsLayoutItemTextTable( QgsLayout *layout /TransferThis/ );
%Docstring
Constructor for QgsLayoutItemTextTable, for the specified ``layout``.

Ownership is transferred to the layout.
%End

    virtual int type() const;

    virtual QString displayName() const;


    static QgsLayoutItemTextTable *create( QgsLayout *layout ) /Factory/;
%Docstring
Returns a new QgsLayoutItemTextTable for the specified parent ``layout``.
%End

    void addRow( const QStringList &row );
%Docstring
Adds a row to the table

:param row: list of strings to use for each cell's value in the newly added row

.. note::

   If row is shorter than the number of columns in the table than blank cells
   will be inserted at the end of the row. If row contains more strings then the number
   of columns in the table then these extra strings will be ignored.

.. note::

   if adding many rows, setContents() is much faster
%End

    void setContents( const QVector< QStringList > &contents );
%Docstring
Sets the contents of the text table.

:param contents: list of table rows

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

    virtual bool getTableContents( QgsLayoutTableContents &contents );


};

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