QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgslayouttablecolumn.h
Go to the documentation of this file.
1/***************************************************************************
2 QgsLayoutTableColumn.h
3 ------------------
4 begin : November 2017
5 copyright : (C) 2017 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 QGSLAYOUTTABLECOLUMN_H
19#define QGSLAYOUTTABLECOLUMN_H
20
21#include <QDomDocument>
22#include <QDomElement>
23#include <QColor>
24
25#include "qgis_core.h"
26#include "qgis_sip.h"
27
36class CORE_EXPORT QgsLayoutTableColumn
37{
38 public:
39
44 QgsLayoutTableColumn( const QString &heading = QString() );
45
52 bool writeXml( QDomElement &columnElem, QDomDocument &doc ) const;
53
59 bool readXml( const QDomElement &columnElem );
60
66 double width() const { return mWidth; }
67
72 void setWidth( const double width ) { mWidth = width; }
73
79 QString heading() const { return mHeading; }
80
86 void setHeading( const QString &heading ) { mHeading = heading; }
87
94 Qt::AlignmentFlag hAlignment() const { return mHAlignment; }
95
102 void setHAlignment( Qt::AlignmentFlag alignment ) { mHAlignment = alignment; }
103
110 Qt::AlignmentFlag vAlignment() const { return mVAlignment; }
111
118 void setVAlignment( Qt::AlignmentFlag alignment ) { mVAlignment = alignment; }
119
126 QString attribute() const { return mAttribute; }
127
134 void setAttribute( const QString &attribute ) { mAttribute = attribute; }
135
143 Qt::SortOrder sortOrder() const { return mSortOrder; }
144
152 void setSortOrder( Qt::SortOrder order ) { mSortOrder = order; }
153
168 Q_DECL_DEPRECATED int sortByRank() const SIP_DEPRECATED { return mSortByRank; }
169
183 Q_DECL_DEPRECATED void setSortByRank( int rank ) SIP_DEPRECATED { mSortByRank = rank; }
184
191
192 bool operator==( const QgsLayoutTableColumn &other ) const
193 {
194 return mHeading == other.mHeading
195 && mAttribute == other.mAttribute
196 && mSortByRank == other.mSortByRank
197 && mSortOrder == other.mSortOrder
198 && mWidth == other.mWidth
199 && mHAlignment == other.mHAlignment
200 && mVAlignment == other.mVAlignment;
201 }
202
203
204#ifdef SIP_RUN
205 SIP_PYOBJECT __repr__();
206 % MethodCode
207 QString str;
208 if ( sipCpp->heading() != sipCpp->attribute() && !sipCpp->heading().isEmpty() )
209 str = QStringLiteral( "<QgsLayoutTableColumn: %1 (\"%2\")>" ).arg( sipCpp->attribute(), sipCpp->heading() );
210 else
211 str = QStringLiteral( "<QgsLayoutTableColumn: %1>" ).arg( sipCpp->attribute() );
212 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
213 % End
214#endif
215
216 private:
217
218 QString mHeading;
219 QString mAttribute;
220 int mSortByRank = 0;
221 Qt::SortOrder mSortOrder = Qt::AscendingOrder;
222 double mWidth = 0.0;
223 QColor mBackgroundColor = Qt::transparent; //currently unused
224 Qt::AlignmentFlag mHAlignment = Qt::AlignLeft;
225 Qt::AlignmentFlag mVAlignment = Qt::AlignVCenter;
226
228
229};
230#endif //QGSLAYOUTTABLECOLUMN_H
QgsCompositionConverter class converts a QGIS 2.x composition to a QGIS 3.x layout.
Stores properties of a column for a QgsLayoutTable.
Q_DECL_DEPRECATED QgsLayoutTableColumn * clone()
Creates a duplicate column which is a deep copy of this column.
QString attribute() const
Returns the attribute name or expression used for the column's values.
void setVAlignment(Qt::AlignmentFlag alignment)
Sets the vertical alignment for a column, which controls the alignment used for drawing column values...
double width() const
Returns the width for the column in mm, or 0 if column width is automatically calculated.
Qt::AlignmentFlag vAlignment() const
Returns the vertical alignment for a column, which controls the alignment used for drawing column val...
QString heading() const
Returns the heading for a column, which is the value displayed in the column's header cell.
bool operator==(const QgsLayoutTableColumn &other) const
Q_DECL_DEPRECATED void setSortByRank(int rank)
Sets the sort rank for the column.
void setSortOrder(Qt::SortOrder order)
Sets the sort order for the column.
void setAttribute(const QString &attribute)
Sets the attribute name or expression used for the column's values.
Q_DECL_DEPRECATED int sortByRank() const
Returns the sort rank for the column.
Qt::SortOrder sortOrder() const
Returns the sort order for the column.
void setHAlignment(Qt::AlignmentFlag alignment)
Sets the horizontal alignment for a column, which controls the alignment used for drawing column valu...
void setHeading(const QString &heading)
Sets the heading for a column, which is the value displayed in the column's header cell.
Qt::AlignmentFlag hAlignment() const
Returns the horizontal alignment for a column, which controls the alignment used for drawing column v...
void setWidth(const double width)
Sets the width for a column in mm.
#define str(x)
Definition: qgis.cpp:38
#define SIP_DEPRECATED
Definition: qgis_sip.h:106
#define SIP_FACTORY
Definition: qgis_sip.h:76