Stores properties of a column in a QgsComposerTable. More...

#include <qgscomposertablecolumn.h>

Public Member Functions
	QgsComposerTableColumn ()
virtual	~QgsComposerTableColumn ()
QString	attribute () const
	Returns the attribute name or expression used for the column's values.
QgsComposerTableColumn *	clone ()
	Creates a duplicate column which is a deep copy of this column.
Qt::AlignmentFlag	hAlignment () const
	Returns the horizontal alignment for a column, which controls the alignment used for drawing column values within cells.
QString	heading () const
	Returns the heading for a column, which is the value displayed in the columns header cell.
virtual bool	readXML (const QDomElement &columnElem)
	Reads the column's properties from xml.
void	setAttribute (QString attribute)
	Sets the attribute name or expression used for the column's values.
void	setHAlignment (Qt::AlignmentFlag alignment)
	Sets the horizontal alignment for a column, which controls the alignment used for drawing column values within cells.
void	setHeading (QString heading)
	Sets the heading for a column, which is the value displayed in the columns header cell.
void	setSortByRank (int sortByRank)
	Sets the sort rank for the column.
void	setSortOrder (Qt::SortOrder sortOrder)
	Sets the sort order for the column.
void	setWidth (const double width)
	Sets the width for a column.
int	sortByRank () const
	Returns the sort rank for the column.
Qt::SortOrder	sortOrder () const
	Returns the sort order for the column.
double	width () const
	Returns the width for a column.
virtual bool	writeXML (QDomElement &columnElem, QDomDocument &doc) const
	Writes the column's properties to xml for storage.

Detailed Description

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.

Definition at line 27 of file qgscomposertablecolumn.h.

Constructor & Destructor Documentation

QgsComposerTableColumn::QgsComposerTableColumn ( )

Definition at line 20 of file qgscomposertablecolumn.cpp.

QgsComposerTableColumn::~QgsComposerTableColumn ( )

virtual

Definition at line 30 of file qgscomposertablecolumn.cpp.

Member Function Documentation

QString QgsComposerTableColumn::attribute ( ) const

inline

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; only applicable when used in a QgsComposerAttributeTable

See Also: setAttribute

Definition at line 104 of file qgscomposertablecolumn.h.

QgsComposerTableColumn * QgsComposerTableColumn::clone ( )

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

Definition at line 86 of file qgscomposertablecolumn.cpp.

Qt::AlignmentFlag QgsComposerTableColumn::hAlignment ( ) const

inline

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 Also: setHAlignment

Definition at line 87 of file qgscomposertablecolumn.h.

QString QgsComposerTableColumn::heading ( ) const

inline

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 Also: setHeading

Definition at line 71 of file qgscomposertablecolumn.h.

bool QgsComposerTableColumn::readXML ( const QDomElement & columnElem )

virtual

Reads the column's properties from xml.

Parameters

columnElem a QDomElement holding the column's desired properties.

Note: added in 2.3

See Also: writeXML

Definition at line 58 of file qgscomposertablecolumn.cpp.

void QgsComposerTableColumn::setAttribute ( QString attribute )

inline

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.

Parameters

attribute attribute name or expression text for column

Note: added in 2.3; only applicable when used in a QgsComposerAttributeTable

See Also: attribute

Definition at line 113 of file qgscomposertablecolumn.h.

void QgsComposerTableColumn::setHAlignment ( Qt::AlignmentFlag alignment )

inline

Sets the horizontal alignment for a column, which controls the alignment used for drawing column values within cells.

Parameters

alignment horizontal alignment for cell.

Note: added in 2.3

See Also: hAlignment

Definition at line 95 of file qgscomposertablecolumn.h.

void QgsComposerTableColumn::setHeading ( QString heading )

inline

Sets the heading for a column, which is the value displayed in the columns header cell.

Parameters

heading Heading for column.

Note: added in 2.3

See Also: heading

Definition at line 79 of file qgscomposertablecolumn.h.

void QgsComposerTableColumn::setSortByRank ( int sortByRank )

inline

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.

Parameters

sortByRank sort rank for column. If sort rank is <= 0 then the column is not being sorted.

Note: added in 2.3; only applicable when used in a QgsComposerAttributeTable

See Also: sortByRank; setSortOrder

Definition at line 161 of file qgscomposertablecolumn.h.

void QgsComposerTableColumn::setSortOrder ( Qt::SortOrder sortOrder )

inline

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.

Parameters

sortOrder sort order for column

Note: added in 2.3; only applicable when used in a QgsComposerAttributeTable

See Also: sortOrder; setSortByRank

Definition at line 133 of file qgscomposertablecolumn.h.

void QgsComposerTableColumn::setWidth ( const double width )

inline

Sets the width for a column.

Parameters

width column width in mm, or 0 if column width is to be automatically calculated.

Note: added in 2.5

See Also: width

Definition at line 63 of file qgscomposertablecolumn.h.

int QgsComposerTableColumn::sortByRank ( ) const

inline

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; only applicable when used in a QgsComposerAttributeTable

See Also: setSortByRank; sortOrder

Definition at line 147 of file qgscomposertablecolumn.h.

Qt::SortOrder QgsComposerTableColumn::sortOrder ( ) const

inline

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; only applicable when used in a QgsComposerAttributeTable

See Also: setSortOrder; sortByRank

Definition at line 123 of file qgscomposertablecolumn.h.

double QgsComposerTableColumn::width ( ) const

inline

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 Also: setWidth

Definition at line 56 of file qgscomposertablecolumn.h.

bool QgsComposerTableColumn::writeXML	(	QDomElement &	columnElem,
		QDomDocument &	doc
	)		const

virtual

Writes the column's properties to xml for storage.

Parameters

columnElem	an existing QDomElement in which to store the column's properties.
doc	QDomDocument for the destination xml.

Note: added in 2.3

See Also: readXML

Definition at line 35 of file qgscomposertablecolumn.cpp.

The documentation for this class was generated from the following files:

/tmp/buildd/qgis-2.8.2+12wheezy/src/core/composer/qgscomposertablecolumn.h
/tmp/buildd/qgis-2.8.2+12wheezy/src/core/composer/qgscomposertablecolumn.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation