1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/** Stores properties of a column in a QgsComposerTable. Some properties of a QgsComposerTableColumn
are applicable only in certain contexts. For instance, the attribute and setAttribute methods only
have an effect for QgsComposerAttributeTables, and have no effect for QgsComposerTextTables.*/
class QgsComposerTableColumn: QObject
{
%TypeHeaderCode
#include <qgscomposertablecolumn.h>
%End
public:
/** Constructor for QgsComposerTableColumn.
* @param heading column heading
*/
QgsComposerTableColumn( const QString& heading = QString() );
virtual ~QgsComposerTableColumn();
/** 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.
* @note added in 2.3
* @see readXML
*/
virtual bool writeXML( QDomElement& columnElem, QDomDocument & doc ) const;
/** Reads the column's properties from xml.
* @param columnElem a QDomElement holding the column's desired properties.
* @note added in 2.3
* @see writeXML
*/
virtual bool readXML( const QDomElement& columnElem );
/** Returns the width for a column.
* @returns column width in mm, or 0 if column width is automatically calculated.
* @note added in 2.5
* @see setWidth
*/
double width() const;
/** Sets the width for a column.
* @param width column width in mm, or 0 if column width is to be automatically calculated.
* @note added in 2.5
* @see width
*/
void setWidth( const double width );
/** Returns the heading for a column, which is the value displayed in the columns
* header cell.
* @returns Heading for column.
* @note added in 2.3
* @see setHeading
*/
QString heading() const;
/** Sets the heading for a column, which is the value displayed in the columns
* header cell.
* @param heading Heading for column.
* @note added in 2.3
* @see heading
*/
void setHeading( const QString& heading );
/** Returns the horizontal alignment for a column, which controls the alignment
* used for drawing column values within cells.
* @returns horizontal alignment.
* @note added in 2.3
* @see setHAlignment
* @see vAlignment
*/
Qt::AlignmentFlag hAlignment() const;
/** Sets the horizontal alignment for a column, which controls the alignment
* used for drawing column values within cells.
* @param alignment horizontal alignment for cell.
* @note added in 2.3
* @see hAlignment
* @see setVAlignment
*/
void setHAlignment( Qt::AlignmentFlag alignment );
/** Returns the vertical alignment for a column, which controls the alignment
* used for drawing column values within cells.
* @returns vertical alignment.
* @note added in 2.12
* @see setVAlignment
* @see hAlignment
*/
Qt::AlignmentFlag vAlignment() const;
/** Sets the vertical alignment for a column, which controls the alignment
* used for drawing column values within cells.
* @param alignment vertical alignment for cell.
* @note added in 2.12
* @see vAlignment
* @see setHAlignment
*/
void setVAlignment( Qt::AlignmentFlag alignment );
/** Returns the attribute name or expression used for the column's values. This property
* is only used when the column is part of a QgsComposerAttributeTable.
* @returns attribute name or expression text for column
* @note added in 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see setAttribute
*/
QString attribute() const;
/** Sets the attribute name or expression used for the column's values. This property
* is only used when the column is part of a QgsComposerAttributeTable.
* @param attribute attribute name or expression text for column
* @note added in 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see attribute
*/
void setAttribute( const QString& attribute );
/** Returns the sort order for the column. This property is only used when the column
* is part of a QgsComposerAttributeTable and when sortByRank is > 0.
* @returns sort order for column
* @note added in 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see setSortOrder
* @see sortByRank
*/
Qt::SortOrder sortOrder() const;
/** Sets the sort order for the column. This property is only used when the column
* is part of a QgsComposerAttributeTable and when sortByRank is > 0.
* @param sortOrder sort order for column
* @note added in 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see sortOrder
* @see setSortByRank
*/
void setSortOrder( Qt::SortOrder sortOrder );
/** 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 QgsComposerAttributeTable.
* @returns sort rank for column. If sort rank is <= 0 then the column is not being
* sorted.
* @note added in 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see setSortByRank
* @see sortOrder
*/
int sortByRank() const;
/** 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 QgsComposerAttributeTable.
* @param sortByRank sort rank for column. If sort rank is <= 0 then the column is not being
* sorted.
* @note added in 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see sortByRank
* @see setSortOrder
*/
void setSortByRank( int sortByRank );
/** Creates a duplicate column which is a deep copy of this column.
* @returns a new QgsComposerTableColumn with same properties as this column.
* @note added in 2.3
*/
QgsComposerTableColumn* clone();
};
|
