QGIS API Documentation  2.99.0-Master (37c43df)
qgscomposertablecolumn.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgscomposertablecolumn.h
3  ------------------
4  begin : May 2014
5  copyright : (C) 2014 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 QGSCOMPOSERTABLECOLUMN_H
19 #define QGSCOMPOSERTABLECOLUMN_H
20 
21 #include <QObject>
22 #include <QDomDocument>
23 #include <QDomElement>
24 #include <QColor>
25 
30 class CORE_EXPORT QgsComposerTableColumn: public QObject
31 {
32  Q_OBJECT
33 
34  public:
35 
39  QgsComposerTableColumn( const QString& heading = QString() );
40 
41  virtual ~QgsComposerTableColumn();
42 
49  virtual bool writeXml( QDomElement& columnElem, QDomDocument & doc ) const;
50 
56  virtual bool readXml( const QDomElement& columnElem );
57 
63  double width() const { return mWidth; }
64 
70  void setWidth( const double width ) { mWidth = width; }
71 
78  QString heading() const { return mHeading; }
79 
86  void setHeading( const QString& heading ) { mHeading = heading; }
87 
95  Qt::AlignmentFlag hAlignment() const { return mHAlignment; }
96 
104  void setHAlignment( Qt::AlignmentFlag alignment ) { mHAlignment = alignment; }
105 
113  Qt::AlignmentFlag vAlignment() const { return mVAlignment; }
114 
122  void setVAlignment( Qt::AlignmentFlag alignment ) { mVAlignment = alignment; }
123 
131  QString attribute() const { return mAttribute; }
132 
140  void setAttribute( const QString& attribute ) { mAttribute = attribute; }
141 
150  Qt::SortOrder sortOrder() const { return mSortOrder; }
151 
160  void setSortOrder( Qt::SortOrder sortOrder ) { mSortOrder = sortOrder; }
161 
174  int sortByRank() const { return mSortByRank; }
175 
188  void setSortByRank( int sortByRank ) { mSortByRank = sortByRank; }
189 
194  QgsComposerTableColumn* clone();
195 
196  private:
197 
198  QColor mBackgroundColor; //curently unused
199  Qt::AlignmentFlag mHAlignment;
200  Qt::AlignmentFlag mVAlignment;
201  QString mHeading;
202  QString mAttribute;
203  int mSortByRank;
204  Qt::SortOrder mSortOrder;
205  double mWidth;
206 
207 };
208 
209 #endif // QGSCOMPOSERTABLECOLUMN_H
void setAttribute(const QString &attribute)
Sets the attribute name or expression used for the column&#39;s values.
Qt::AlignmentFlag hAlignment() const
Returns the horizontal alignment for a column, which controls the alignment used for drawing column v...
Qt::AlignmentFlag vAlignment() const
Returns the vertical alignment for a column, which controls the alignment used for drawing column val...
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 columns header cell...
int sortByRank() const
Returns the sort rank for the column.
Stores properties of a column in a QgsComposerTable.
double width() const
Returns the width for a column.
QString heading() const
Returns the heading for a column, which is the value displayed in the columns header cell...
void setSortOrder(Qt::SortOrder sortOrder)
Sets the sort order for the column.
void setVAlignment(Qt::AlignmentFlag alignment)
Sets the vertical alignment for a column, which controls the alignment used for drawing column values...
QString attribute() const
Returns the attribute name or expression used for the column&#39;s values.
void setWidth(const double width)
Sets the width for a column.
Qt::SortOrder sortOrder() const
Returns the sort order for the column.
void setSortByRank(int sortByRank)
Sets the sort rank for the column.