/************************************************************************ * This file has been generated automatically from * * * * src/core/layout/qgslayouttablecolumn.h * * * * Do not edit manually ! Edit header and run scripts/sipify.py again * ************************************************************************/ class QgsLayoutTableColumn { %Docstring(signature="appended") Stores properties of a column for a :py:class:`QgsLayoutTable`. Some properties of a :py:class:`QgsLayoutTableColumn` are applicable only in certain contexts. For instance, the attribute and setAttribute methods only have an effect for :py:class:`QgsLayoutItemAttributeTables`, and have no effect for :py:class:`QgsLayoutItemTextTables`. %End %TypeHeaderCode #include "qgslayouttablecolumn.h" %End public: QgsLayoutTableColumn( const QString &heading = QString() ); %Docstring Constructor for QgsLayoutTableColumn. :param heading: column heading %End bool writeXml( QDomElement &columnElem, QDomDocument &doc ) const; %Docstring Writes the column's properties to xml for storage. :param columnElem: an existing QDomElement in which to store the column's properties. :param doc: QDomDocument for the destination xml. .. seealso:: :py:func:`readXml` %End bool readXml( const QDomElement &columnElem ); %Docstring Reads the column's properties from xml. :param columnElem: a QDomElement holding the column's desired properties. .. seealso:: :py:func:`writeXml` %End double width() const; %Docstring Returns the width for the column in mm, or 0 if column width is automatically calculated. .. seealso:: :py:func:`setWidth` %End void setWidth( const double width ); %Docstring Sets the width for a column in mm. Set the ``width`` to 0 if the column width is to be automatically calculated. .. seealso:: :py:func:`width` %End QString heading() const; %Docstring Returns the heading for a column, which is the value displayed in the column's header cell. .. seealso:: :py:func:`setHeading` %End void setHeading( const QString &heading ); %Docstring Sets the ``heading`` for a column, which is the value displayed in the column's header cell. .. seealso:: :py:func:`heading` %End Qt::AlignmentFlag hAlignment() const; %Docstring Returns the horizontal alignment for a column, which controls the alignment used for drawing column values within cells. .. seealso:: :py:func:`setHAlignment` .. seealso:: :py:func:`vAlignment` %End void setHAlignment( Qt::AlignmentFlag alignment ); %Docstring Sets the horizontal ``alignment`` for a column, which controls the alignment used for drawing column values within cells. .. seealso:: :py:func:`hAlignment` .. seealso:: :py:func:`setVAlignment` %End Qt::AlignmentFlag vAlignment() const; %Docstring Returns the vertical alignment for a column, which controls the alignment used for drawing column values within cells. .. seealso:: :py:func:`setVAlignment` .. seealso:: :py:func:`hAlignment` %End void setVAlignment( Qt::AlignmentFlag alignment ); %Docstring Sets the vertical ``alignment`` for a column, which controls the alignment used for drawing column values within cells. .. seealso:: :py:func:`vAlignment` .. seealso:: :py:func:`setHAlignment` %End QString attribute() const; %Docstring Returns the attribute name or expression used for the column's values. This property is only used when the column is part of a :py:class:`QgsLayoutItemAttributeTable`. .. note:: only applicable when used in a :py:class:`QgsLayoutItemAttributeTable` .. seealso:: :py:func:`setAttribute` %End void setAttribute( const QString &attribute ); %Docstring Sets the ``attribute`` name or expression used for the column's values. This property is only used when the column is part of a :py:class:`QgsLayoutItemAttributeTable`. .. note:: only applicable when used in a :py:class:`QgsLayoutItemAttributeTable` .. seealso:: :py:func:`attribute` %End Qt::SortOrder sortOrder() const; %Docstring Returns the sort order for the column. This property is only used when the column is part of a :py:class:`QgsLayoutItemAttributeTable` and when sortByRank is > 0. .. note:: only applicable when used in a :py:class:`QgsLayoutItemAttributeTable` .. seealso:: :py:func:`setSortOrder` .. seealso:: :py:func:`sortByRank` %End void setSortOrder( Qt::SortOrder order ); %Docstring Sets the sort ``order`` for the column. This property is only used when the column is part of a :py:class:`QgsLayoutItemAttributeTable` and when :py:func:`~QgsLayoutTableColumn.sortByRank` is > 0. .. note:: only applicable when used in a :py:class:`QgsLayoutItemAttributeTable` .. seealso:: :py:func:`sortOrder` .. seealso:: :py:func:`setSortByRank` %End int sortByRank() const /Deprecated="Since 3.14. The order is now hold in a dedicated model."/; %Docstring Returns the sort rank for the column. If the sort rank is > 0 then the column will be sorted in the table. The sort rank specifies the priority given to the column when the table is sorted by multiple columns, with lower sort ranks having higher priority. This property is only used when the column is part of a :py:class:`QgsLayoutItemAttributeTable`. If sort rank is <= 0 then the column is not being sorted. .. note:: only applicable when used in a :py:class:`QgsLayoutItemAttributeTable` .. seealso:: :py:func:`setSortByRank` .. seealso:: :py:func:`sortOrder` .. deprecated:: 3.14 The order is now hold in a dedicated model. %End void setSortByRank( int rank ) /Deprecated="Since 3.14. The order is now hold in a dedicated model."/; %Docstring Sets the sort ``rank`` for the column. If the sort rank is > 0 then the column will be sorted in the table. The sort rank specifies the priority given to the column when the table is sorted by multiple columns, with lower sort ranks having higher priority. This property is only used when the column is part of a :py:class:`QgsLayoutItemAttributeTable`. If the sort ``rank`` is <= 0 then the column is not being sorted. .. note:: only applicable when used in a :py:class:`QgsLayoutItemAttributeTable` .. seealso:: :py:func:`sortByRank` .. seealso:: :py:func:`setSortOrder` .. deprecated:: 3.14 The order is now hold in a dedicated model. %End QgsLayoutTableColumn *clone() /Deprecated="Since 3.14. Use a copy instead.",Factory/; %Docstring Creates a duplicate column which is a deep copy of this column. :return: a new QgsLayoutTableColumn with same properties as this column. .. deprecated:: 3.14 Use a copy instead. %End bool operator==( const QgsLayoutTableColumn &other ) const; SIP_PYOBJECT __repr__(); %MethodCode QString str; if ( sipCpp->heading() != sipCpp->attribute() && !sipCpp->heading().isEmpty() ) str = QStringLiteral( "" ).arg( sipCpp->attribute(), sipCpp->heading() ); else str = QStringLiteral( "" ).arg( sipCpp->attribute() ); sipRes = PyUnicode_FromString( str.toUtf8().constData() ); %End }; /************************************************************************ * This file has been generated automatically from * * * * src/core/layout/qgslayouttablecolumn.h * * * * Do not edit manually ! Edit header and run scripts/sipify.py again * ************************************************************************/