A table class that displays a vector attribute table. More...

#include <qgscomposerattributetable.h>

Inheritance diagram for QgsComposerAttributeTable:

Collaboration diagram for QgsComposerAttributeTable:

Signals
void	maximumNumberOfFeaturesChanged (int n)
	This signal is emitted if the maximum number of feature changes (interactively)
Public Member Functions
	QgsComposerAttributeTable (QgsComposition *composition)
	~QgsComposerAttributeTable ()
const QgsComposerMap *	composerMap () const
QSet< int >	displayAttributes () const
bool	displayOnlyVisibleFeatures () const
QMap< int, QString >	fieldAliasMap () const
int	maximumNumberOfFeatures () const
virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget)
	Reimplementation of QCanvasItem::paint.
bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	sets state from Dom document
void	setComposerMap (const QgsComposerMap *map)
void	setDisplayAttributes (const QSet< int > &attr)
void	setDisplayOnlyVisibleFeatures (bool b)
void	setFieldAliasMap (const QMap< int, QString > &map)
void	setMaximumNumberOfFeatures (int nr)
void	setSceneRect (const QRectF &rectangle)
	Adapts mMaximumNumberOfFeatures depending on the rectangle height.
void	setSortAttributes (const QList< QPair< int, bool > > att)
void	setVectorLayer (QgsVectorLayer *vl)
QList< QPair< int, bool > >	sortAttributes () const
virtual int	type () const
	return correct graphics item type.
const QgsVectorLayer *	vectorLayer () const
bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	stores state in Dom element
Protected Member Functions
bool	getFeatureAttributes (QList< QgsAttributes > &attributes)
	Retrieves feature attributes.
QMap< int, QString >	getHeaderLabels () const
Private Slots
void	removeLayer (QString layerId)
	Checks if this vector layer will be removed (and sets mVectorLayer to 0 if yes)
Private Member Functions
QString	attributeDisplayName (int attributeIndex, const QString &name) const
	Returns the attribute name to display in the item (attribute name or an alias if present)
void	initializeAliasMap ()
	Inserts aliases from vector layer as starting configuration to the alias map.
Private Attributes
const QgsComposerMap *	mComposerMap
	Associated composer map (used to display the visible features)
QSet< int >	mDisplayAttributes
	List of attribute indices to display (or all attributes if list is empty)
QMap< int, QString >	mFieldAliasMap
	Map of attribute name aliases.
int	mMaximumNumberOfFeatures
	Maximum number of features that is displayed.
bool	mShowOnlyVisibleFeatures
	Shows only the features that are visible in the associated composer map (true by default)
QList< QPair< int, bool > >	mSortInformation
	Contains information about sort attribute index / ascending (true/false).
QgsVectorLayer *	mVectorLayer
	Associated vector layer.

Detailed Description

A table class that displays a vector attribute table.

Definition at line 40 of file qgscomposerattributetable.h.

Constructor & Destructor Documentation

QgsComposerAttributeTable::QgsComposerAttributeTable ( QgsComposition * composition )

Definition at line 46 of file qgscomposerattributetable.cpp.

References QgsMapLayerRegistry::instance(), QgsMapLayerRegistry::mapLayers(), mVectorLayer, and removeLayer().

QgsComposerAttributeTable::~QgsComposerAttributeTable ( )

Definition at line 65 of file qgscomposerattributetable.cpp.

Member Function Documentation

QString QgsComposerAttributeTable::attributeDisplayName	(	int	attributeIndex,
		const QString &	name
	)		const `[private]`

Returns the attribute name to display in the item (attribute name or an alias if present)

Definition at line 195 of file qgscomposerattributetable.cpp.

References mFieldAliasMap.

Referenced by getHeaderLabels().

const QgsComposerMap* QgsComposerAttributeTable::composerMap ( ) const [inline]

Definition at line 60 of file qgscomposerattributetable.h.

QSet<int> QgsComposerAttributeTable::displayAttributes ( ) const [inline]

Definition at line 68 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::displayOnlyVisibleFeatures ( ) const [inline]

Definition at line 66 of file qgscomposerattributetable.h.

QMap<int, QString> QgsComposerAttributeTable::fieldAliasMap ( ) const [inline]

Definition at line 71 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::getFeatureAttributes ( QList< QgsAttributes > & attributes ) [protected, virtual]

Retrieves feature attributes.

Note:: not available in python bindings

Reimplemented from QgsComposerTable.

Definition at line 119 of file qgscomposerattributetable.cpp.

References QgsFeature::attributes(), QgsMapLayer::crs(), QgsMapRenderer::destinationCrs(), QgsFeatureRequest::ExactIntersect, QgsComposerMap::extent(), QgsVectorLayer::getFeatures(), QgsMapRenderer::hasCrsTransformEnabled(), QgsRectangle::isEmpty(), QgsComposerMap::mapRenderer(), mComposerMap, mDisplayAttributes, mMaximumNumberOfFeatures, mShowOnlyVisibleFeatures, mSortInformation, mVectorLayer, QgsFeatureIterator::nextFeature(), QgsFeatureRequest::NoGeometry, QgsCoordinateTransform::ReverseTransform, QgsComposerAttributeTableCompare::setAscending(), QgsFeatureRequest::setFilterRect(), QgsFeatureRequest::setFlags(), QgsComposerAttributeTableCompare::setSortColumn(), and QgsFeatureRequest::setSubsetOfAttributes().

QMap< int, QString > QgsComposerAttributeTable::getHeaderLabels ( ) const [protected, virtual]

Note:: not available in python bindings

Reimplemented from QgsComposerTable.

Definition at line 177 of file qgscomposerattributetable.cpp.

References attributeDisplayName(), QgsFields::count(), mDisplayAttributes, mVectorLayer, and QgsVectorLayer::pendingFields().

void QgsComposerAttributeTable::initializeAliasMap ( ) [private]

Inserts aliases from vector layer as starting configuration to the alias map.

Definition at line 79 of file qgscomposerattributetable.cpp.

References QgsVectorLayer::attributeAlias(), QgsFields::count(), mFieldAliasMap, mVectorLayer, and QgsVectorLayer::pendingFields().

Referenced by setVectorLayer().

int QgsComposerAttributeTable::maximumNumberOfFeatures ( ) const [inline]

Definition at line 63 of file qgscomposerattributetable.h.

void QgsComposerAttributeTable::maximumNumberOfFeaturesChanged ( int n ) [signal]

This signal is emitted if the maximum number of feature changes (interactively)

Referenced by setSceneRect().

void QgsComposerAttributeTable::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	itemStyle,
		QWidget *	pWidget
	)		`[virtual]`

Reimplementation of QCanvasItem::paint.

Reimplemented from QgsComposerTable.

Definition at line 70 of file qgscomposerattributetable.cpp.

References QgsComposerMap::isDrawing(), and mComposerMap.

bool QgsComposerAttributeTable::readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)		`[virtual]`

sets state from Dom document

Parameters:

itemElem	is Dom node corresponding to item tag
doc	is Dom document

Implements QgsComposerTable.

Definition at line 293 of file qgscomposerattributetable.cpp.

References QgsComposerItem::composition(), QgsComposition::getComposerMapById(), QgsMapLayerRegistry::instance(), QgsComposerItem::itemChanged(), QgsMapLayerRegistry::mapLayer(), mComposerMap, mDisplayAttributes, mFieldAliasMap, mMaximumNumberOfFeatures, mShowOnlyVisibleFeatures, mSortInformation, mVectorLayer, and QgsComposerTable::tableReadXML().

Referenced by QgsComposition::addItemsFromXML().

void QgsComposerAttributeTable::removeLayer ( QString layerId ) [private, slot]

Checks if this vector layer will be removed (and sets mVectorLayer to 0 if yes)

Definition at line 208 of file qgscomposerattributetable.cpp.

References QgsMapLayer::id(), and mVectorLayer.

Referenced by QgsComposerAttributeTable().

void QgsComposerAttributeTable::setComposerMap ( const QgsComposerMap * map )

Definition at line 106 of file qgscomposerattributetable.cpp.

References mComposerMap, and QgsComposerItem::repaint().

void QgsComposerAttributeTable::setDisplayAttributes ( const QSet< int > & attr ) [inline]

Definition at line 69 of file qgscomposerattributetable.h.

void QgsComposerAttributeTable::setDisplayOnlyVisibleFeatures ( bool b ) [inline]

Definition at line 65 of file qgscomposerattributetable.h.

void QgsComposerAttributeTable::setFieldAliasMap ( const QMap< int, QString > & map ) [inline]

Definition at line 72 of file qgscomposerattributetable.h.

void QgsComposerAttributeTable::setMaximumNumberOfFeatures ( int nr ) [inline]

Definition at line 62 of file qgscomposerattributetable.h.

void QgsComposerAttributeTable::setSceneRect ( const QRectF & rectangle ) [virtual]

Adapts mMaximumNumberOfFeatures depending on the rectangle height.

Reimplemented from QgsComposerItem.

Definition at line 219 of file qgscomposerattributetable.cpp.

References QgsComposerItem::fontAscentMillimeters(), maximumNumberOfFeaturesChanged(), QgsComposerTable::mContentFont, QgsComposerTable::mGridStrokeWidth, QgsComposerTable::mHeaderFont, QgsComposerTable::mLineTextDistance, and mMaximumNumberOfFeatures.

Referenced by QgsComposerView::mousePressEvent().

void QgsComposerAttributeTable::setSortAttributes ( const QList< QPair< int, bool > > att ) [inline]

Definition at line 78 of file qgscomposerattributetable.h.

void QgsComposerAttributeTable::setVectorLayer ( QgsVectorLayer * vl )

Definition at line 96 of file qgscomposerattributetable.cpp.

References initializeAliasMap(), mDisplayAttributes, and mVectorLayer.

QList<QPair<int, bool> > QgsComposerAttributeTable::sortAttributes ( ) const [inline]

Definition at line 81 of file qgscomposerattributetable.h.

virtual int QgsComposerAttributeTable::type ( ) const [inline, virtual]

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerTable.

Definition at line 48 of file qgscomposerattributetable.h.

References QgsComposerItem::ComposerAttributeTable.

const QgsVectorLayer* QgsComposerAttributeTable::vectorLayer ( ) const [inline]

Definition at line 57 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::writeXML	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const `[virtual]`

stores state in Dom element

Parameters:

elem	is Dom element corresponding to 'Composer' tag
doc	is the Dom document

Implements QgsComposerTable.

Definition at line 235 of file qgscomposerattributetable.cpp.

References QgsMapLayer::id(), QgsComposerMap::id(), mComposerMap, mDisplayAttributes, mFieldAliasMap, mMaximumNumberOfFeatures, mShowOnlyVisibleFeatures, mSortInformation, mVectorLayer, and QgsComposerTable::tableWriteXML().

Member Data Documentation

const QgsComposerMap* QgsComposerAttributeTable::mComposerMap [private]

Associated composer map (used to display the visible features)

Definition at line 96 of file qgscomposerattributetable.h.

Referenced by getFeatureAttributes(), paint(), readXML(), setComposerMap(), and writeXML().

QSet<int> QgsComposerAttributeTable::mDisplayAttributes [private]

List of attribute indices to display (or all attributes if list is empty)

Definition at line 104 of file qgscomposerattributetable.h.

Referenced by getFeatureAttributes(), getHeaderLabels(), readXML(), setVectorLayer(), and writeXML().

QMap<int, QString> QgsComposerAttributeTable::mFieldAliasMap [private]

Map of attribute name aliases.

The aliases might be different to those of QgsVectorLayer (but those from the vector layer are the default)

Definition at line 106 of file qgscomposerattributetable.h.

Referenced by attributeDisplayName(), initializeAliasMap(), readXML(), and writeXML().

int QgsComposerAttributeTable::mMaximumNumberOfFeatures [private]

Maximum number of features that is displayed.

Definition at line 98 of file qgscomposerattributetable.h.

Referenced by getFeatureAttributes(), readXML(), setSceneRect(), and writeXML().

bool QgsComposerAttributeTable::mShowOnlyVisibleFeatures [private]

Shows only the features that are visible in the associated composer map (true by default)

Definition at line 101 of file qgscomposerattributetable.h.

Referenced by getFeatureAttributes(), readXML(), and writeXML().

QList< QPair<int, bool> > QgsComposerAttributeTable::mSortInformation [private]

Contains information about sort attribute index / ascending (true/false).

First entry has the highest priority

Definition at line 109 of file qgscomposerattributetable.h.

Referenced by getFeatureAttributes(), readXML(), and writeXML().

QgsVectorLayer* QgsComposerAttributeTable::mVectorLayer [private]

Associated vector layer.

Definition at line 94 of file qgscomposerattributetable.h.

Referenced by getFeatureAttributes(), getHeaderLabels(), initializeAliasMap(), QgsComposerAttributeTable(), readXML(), removeLayer(), setVectorLayer(), and writeXML().

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

src/core/composer/qgscomposerattributetable.h
src/core/composer/qgscomposerattributetable.cpp

Signals

Public Member Functions

Protected Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation