QGIS API Documentation
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 "qgscomposertable.h"
22 #include <QObject>
23 
27 class CORE_EXPORT QgsComposerTableColumn: public QObject
28 {
29  Q_OBJECT
30 
31  public:
32 
36  QgsComposerTableColumn( const QString& heading = QString() );
37 
38  virtual ~QgsComposerTableColumn();
39 
46  virtual bool writeXML( QDomElement& columnElem, QDomDocument & doc ) const;
47 
53  virtual bool readXML( const QDomElement& columnElem );
54 
60  double width() const { return mWidth; }
61 
67  void setWidth( const double width ) { mWidth = width; }
68 
75  QString heading() const { return mHeading; }
76 
83  void setHeading( const QString& heading ) { mHeading = heading; }
84 
92  Qt::AlignmentFlag hAlignment() const { return mHAlignment; }
93 
101  void setHAlignment( Qt::AlignmentFlag alignment ) { mHAlignment = alignment; }
102 
110  Qt::AlignmentFlag vAlignment() const { return mVAlignment; }
111 
119  void setVAlignment( Qt::AlignmentFlag alignment ) { mVAlignment = alignment; }
120 
128  QString attribute() const { return mAttribute; }
129 
137  void setAttribute( const QString& attribute ) { mAttribute = attribute; }
138 
147  Qt::SortOrder sortOrder() const { return mSortOrder; }
148 
157  void setSortOrder( Qt::SortOrder sortOrder ) { mSortOrder = sortOrder; }
158 
171  int sortByRank() const { return mSortByRank; }
172 
185  void setSortByRank( int sortByRank ) { mSortByRank = sortByRank; }
186 
191  QgsComposerTableColumn* clone();
192 
193  private:
194 
195  QColor mBackgroundColor; //curently unused
196  Qt::AlignmentFlag mHAlignment;
197  Qt::AlignmentFlag mVAlignment;
198  QString mHeading;
199  QString mAttribute;
200  int mSortByRank;
201  Qt::SortOrder mSortOrder;
202  double mWidth;
203 
204 };
205 
206 #endif // QGSCOMPOSERTABLECOLUMN_H
void setAttribute(const QString &attribute)
Sets the attribute name or expression used for the column&#39;s values.
Qt::AlignmentFlag vAlignment() const
Returns the vertical alignment for a column, which controls the alignment used for drawing column val...
int sortByRank() const
Returns the sort rank for the column.
double width() const
Returns the width for a 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 columns header cell...
Stores properties of a column in a QgsComposerTable.
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...
Qt::AlignmentFlag hAlignment() const
Returns the horizontal alignment for a column, which controls the alignment used for drawing column v...
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.
void setSortByRank(int sortByRank)
Sets the sort rank for the column.