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

#include <qgscomposertablecolumn.h>

Inheritance diagram for QgsComposerTableColumn:

Public Member Functions
	QgsComposerTableColumn (const QString &heading=QString())
	Constructor for QgsComposerTableColumn. More...

virtual	~QgsComposerTableColumn ()

QString	attribute () const
	Returns the attribute name or expression used for the column's values. More...

QgsComposerTableColumn *	clone ()
	Creates a duplicate column which is a deep copy of this column. More...

Qt::AlignmentFlag	hAlignment () const
	Returns the horizontal alignment for a column, which controls the alignment used for drawing column values within cells. More...

QString	heading () const
	Returns the heading for a column, which is the value displayed in the columns header cell. More...

virtual bool	readXML (const QDomElement &columnElem)
	Reads the column's properties from xml. More...

void	setAttribute (const QString &attribute)
	Sets the attribute name or expression used for the column's values. More...

void	setHAlignment (Qt::AlignmentFlag alignment)
	Sets the horizontal alignment for a column, which controls the alignment used for drawing column values within cells. More...

void	setHeading (const QString &heading)
	Sets the heading for a column, which is the value displayed in the columns header cell. More...

void	setSortByRank (int sortByRank)
	Sets the sort rank for the column. More...

void	setSortOrder (Qt::SortOrder sortOrder)
	Sets the sort order for the column. More...

void	setVAlignment (Qt::AlignmentFlag alignment)
	Sets the vertical alignment for a column, which controls the alignment used for drawing column values within cells. More...

void	setWidth (const double width)
	Sets the width for a column. More...

int	sortByRank () const
	Returns the sort rank for the column. More...

Qt::SortOrder	sortOrder () const
	Returns the sort order for the column. More...

Qt::AlignmentFlag	vAlignment () const
	Returns the vertical alignment for a column, which controls the alignment used for drawing column values within cells. More...

double	width () const
	Returns the width for a column. More...

virtual bool	writeXML (QDomElement &columnElem, QDomDocument &doc) const
	Writes the column's properties to xml for storage. More...

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

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 28 of file qgscomposertablecolumn.h.

Constructor & Destructor Documentation

◆ QgsComposerTableColumn()

QgsComposerTableColumn::QgsComposerTableColumn ( const QString & heading = QString() )

Constructor for QgsComposerTableColumn.

Parameters

heading column heading

Definition at line 20 of file qgscomposertablecolumn.cpp.

◆ ~QgsComposerTableColumn()

QgsComposerTableColumn::~QgsComposerTableColumn ( )

virtual

Definition at line 33 of file qgscomposertablecolumn.cpp.

Member Function Documentation

◆ attribute()

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 129 of file qgscomposertablecolumn.h.

◆ clone()

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 91 of file qgscomposertablecolumn.cpp.

◆ hAlignment()

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; vAlignment

Definition at line 93 of file qgscomposertablecolumn.h.

◆ heading()

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 76 of file qgscomposertablecolumn.h.

◆ readXML()

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 62 of file qgscomposertablecolumn.cpp.

◆ setAttribute()

void QgsComposerTableColumn::setAttribute ( const 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 138 of file qgscomposertablecolumn.h.

◆ setHAlignment()

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; setVAlignment

Definition at line 102 of file qgscomposertablecolumn.h.

◆ setHeading()

void QgsComposerTableColumn::setHeading ( const 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 84 of file qgscomposertablecolumn.h.

◆ setSortByRank()

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 186 of file qgscomposertablecolumn.h.

◆ setSortOrder()

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 158 of file qgscomposertablecolumn.h.

◆ setVAlignment()

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

inline

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

Parameters

alignment vertical alignment for cell.

Note: added in 2.12

See also: vAlignment; setHAlignment

Definition at line 120 of file qgscomposertablecolumn.h.

◆ setWidth()

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 68 of file qgscomposertablecolumn.h.

◆ sortByRank()

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 172 of file qgscomposertablecolumn.h.

◆ sortOrder()

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 148 of file qgscomposertablecolumn.h.

◆ vAlignment()

Qt::AlignmentFlag QgsComposerTableColumn::vAlignment ( ) const

inline

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 also: setVAlignment; hAlignment

Definition at line 111 of file qgscomposertablecolumn.h.

◆ width()

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 61 of file qgscomposertablecolumn.h.

◆ writeXML()

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 38 of file qgscomposertablecolumn.cpp.

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

/tmp/buildd/qgis-2.18.21+99unstable/src/core/composer/qgscomposertablecolumn.h
/tmp/buildd/qgis-2.18.21+99unstable/src/core/composer/qgscomposertablecolumn.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsComposerTableColumn()

◆ ~QgsComposerTableColumn()

Member Function Documentation

◆ attribute()

◆ clone()

◆ hAlignment()

◆ heading()

◆ readXML()

◆ setAttribute()

◆ setHAlignment()

◆ setHeading()

◆ setSortByRank()

◆ setSortOrder()

◆ setVAlignment()

◆ setWidth()

◆ sortByRank()

◆ sortOrder()

◆ vAlignment()

◆ width()

◆ writeXML()