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) More...

Signals inherited from QgsComposerItem
void	itemRotationChanged (double newRotation)
	Is emitted on item rotation change. More...

void	itemChanged ()
	Used e.g. More...

void	sizeChanged ()
	Emitted if the rectangle changes. More...

void	frameChanged ()
	Emitted if the item's frame style changes. More...

Public Member Functions
	QgsComposerAttributeTable (QgsComposition *composition)

	~QgsComposerAttributeTable ()

virtual int	type () const
	return correct graphics item type. More...

virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget)
	Reimplementation of QCanvasItem::paint. More...

bool	writeXML (QDomElement &elem, QDomDocument &doc) const
	Writes properties specific to attribute tables. More...

bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads the properties specific to an attribute table from xml. More...

void	setVectorLayer (QgsVectorLayer *layer)
	Sets the vector layer from which to display feature attributes. More...

QgsVectorLayer *	vectorLayer () const
	Returns the vector layer the attribute table is currently using. More...

void	resetColumns ()
	Resets the attribute table's columns to match the vector layer's fields. More...

void	setComposerMap (const QgsComposerMap *map)
	Sets the composer map to use to limit the extent of features shown in the attribute table. More...

const QgsComposerMap *	composerMap () const
	Returns the composer map whose extents are controlling the features shown in the table. More...

void	setMaximumNumberOfFeatures (int features)
	Sets the maximum number of features shown by the table. More...

int	maximumNumberOfFeatures () const
	Returns the maximum number of features to be shown by the table. More...

void	setDisplayOnlyVisibleFeatures (bool visibleOnly)
	Sets attribute table to only show features which are visible in a composer map item. More...

bool	displayOnlyVisibleFeatures () const
	Returns true if the table is set to show only features visible on a corresponding composer map item. More...

bool	filterFeatures () const
	Returns true if a feature filter is active on the attribute table. More...

void	setFilterFeatures (bool filter)
	Sets whether the feature filter is active for the attribute table. More...

QString	featureFilter () const
	Returns the current expression used to filter features for the table. More...

void	setFeatureFilter (const QString &expression)
	Sets the expression used for filtering features in the table. More...

Q_DECL_DEPRECATED QSet< int >	displayAttributes () const
	Returns the attributes fields which are shown by the table. More...

void	setDisplayAttributes (const QSet< int > &attr, bool refresh=true)
	Sets the attributes to display in the table. More...

Q_DECL_DEPRECATED QMap< int, QString >	fieldAliasMap () const
	Returns the attribute field aliases, which control how fields are named in the table's header row. More...

Q_DECL_DEPRECATED void	setFieldAliasMap (const QMap< int, QString > &map)
	Sets the attribute field aliases, which control how fields are named in the table's header row. More...

void	setSceneRect (const QRectF &rectangle)
	Adapts mMaximumNumberOfFeatures depending on the rectangle height. More...

Q_DECL_DEPRECATED void	setSortAttributes (const QList< QPair< int, bool > > att)
	Sets the attributes to use to sort the table's features. More...

QList< QPair< int, bool > >	sortAttributes () const
	Returns the attributes used to sort the table's features. More...

bool	getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps)
	Queries the attribute table's vector layer for attributes to show in the table. More...

Public Member Functions inherited from QgsComposerTable
	QgsComposerTable (QgsComposition *composition)

virtual	~QgsComposerTable ()

void	setLineTextDistance (double d)
	Sets the margin distance between cell borders and their contents. More...

double	lineTextDistance () const
	Returns the margin distance between cell borders and their contents. More...

void	setHeaderFont (const QFont &f)
	Sets the font used to draw header text in the table. More...

QFont	headerFont () const
	Returns the font used to draw header text in the table. More...

void	setHeaderHAlignment (const HeaderHAlignment alignment)
	Sets the horizontal alignment for table headers. More...

HeaderHAlignment	headerHAlignment () const
	Returns the horizontal alignment for table headers. More...

void	setContentFont (const QFont &f)
	Sets the font used to draw text in table body cells. More...

QFont	contentFont () const
	Returns the font used to draw text in table body cells. More...

void	setShowGrid (bool show)
	Sets whether grid lines should be drawn in the table. More...

bool	showGrid () const
	Returns whether grid lines are drawn in the table. More...

void	setGridStrokeWidth (double w)
	Sets the width for grid lines in the table. More...

double	gridStrokeWidth () const
	Returns the width of grid lines in the table. More...

void	setGridColor (const QColor &c)
	Sets color used for grid lines in the table. More...

QColor	gridColor () const
	Returns the color used for grid lines in the table. More...

virtual QMap< int, QString >	headerLabels () const
	Returns the text used in the column headers for the table. More...

QList< QgsComposerTableColumn * > *	columns ()
	Returns a pointer to the list of QgsComposerTableColumns shown in the table. More...

void	setColumns (QList< QgsComposerTableColumn * > columns)
	Replaces the columns in the table with a specified list of QgsComposerTableColumns. More...

Public Member Functions inherited from QgsComposerItem
	QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
	Constructor. More...

	QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
	Constructor with box position and composer object. More...

virtual	~QgsComposerItem ()

virtual void	setSelected (bool s)
	Set selected, selected item should be highlighted. More...

virtual bool	selected () const
	Is selected. More...

virtual bool	writeSettings ()
	stores state in project More...

virtual bool	readSettings ()
	read state from project More...

virtual bool	removeSettings ()
	delete settings from project file More...

void	move (double dx, double dy)
	Moves item in canvas coordinates. More...

virtual void	moveContent (double dx, double dy)
	Move Content of item. More...

virtual void	zoomContent (int delta, double x, double y)
	Zoom content of item. More...

int	page () const
	Gets the page the item is currently on. More...

QPointF	pagePos () const
	Returns the item's position relative to its current page. More...

void	updatePagePos (double newPageWidth, double newPageHeight)
	Moves the item so that it retains its relative position on the page when the paper size changes. More...

void	setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
	Moves the item to a new position (in canvas coordinates) More...

void	setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft, bool posIncludesFrame=false, int page=-1)
	Sets item position and width / height in one go. More...

ItemPositionMode	lastUsedPositionMode ()
	Returns item's last used position mode. More...

bool	_writeXML (QDomElement &itemElem, QDomDocument &doc) const
	Writes parameter that are not subclass specific in document. More...

bool	_readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads parameter that are not subclass specific in document. More...

bool	hasFrame () const
	Whether this item has a frame or not. More...

void	setFrameEnabled (bool drawFrame)
	Set whether this item has a frame drawn around it or not. More...

virtual void	setFrameOutlineWidth (double outlineWidth)
	Sets frame outline width. More...

double	frameOutlineWidth () const
	Returns the frame's outline width. More...

Qt::PenJoinStyle	frameJoinStyle () const
	Returns the join style used for drawing the item's frame. More...

void	setFrameJoinStyle (Qt::PenJoinStyle style)
	Sets join style used when drawing the item's frame. More...

virtual double	estimatedFrameBleed () const
	Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. More...

virtual QRectF	rectWithFrame () const
	Returns the item's rectangular bounds, including any bleed caused by the item's frame. More...

bool	hasBackground () const
	Whether this item has a Background or not. More...

void	setBackgroundEnabled (bool drawBackground)
	Set whether this item has a Background drawn around it or not. More...

QColor	backgroundColor () const
	Gets the background color for this item. More...

void	setBackgroundColor (const QColor &backgroundColor)
	Sets the background color for this item. More...

QPainter::CompositionMode	blendMode () const
	Returns the item's composition blending mode. More...

void	setBlendMode (QPainter::CompositionMode blendMode)
	Sets the item's composition blending mode. More...

int	transparency () const
	Returns the item's transparency. More...

void	setTransparency (int transparency)
	Sets the item's transparency. More...

bool	effectsEnabled () const
	Returns true if effects (eg blend modes) are enabled for the item. More...

void	setEffectsEnabled (bool effectsEnabled)
	Sets whether effects (eg blend modes) are enabled for the item. More...

virtual void	addItem (QgsComposerItem *item)
	Composite operations for item groups do nothing per default. More...

virtual void	removeItems ()

const QgsComposition *	composition () const

QgsComposition *	composition ()

virtual void	beginItemCommand (const QString &text)

void	beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
	Starts new composer undo command. More...

virtual void	endItemCommand ()

void	endCommand ()
	Finish current command and push it onto the undo stack. More...

void	cancelCommand ()

void	drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
	Draws Text. More...

void	drawText (QPainter *p, const QRectF &rect, const QString &text, const QFont &font, Qt::AlignmentFlag halignment=Qt::AlignLeft, Qt::AlignmentFlag valignment=Qt::AlignTop, int flags=Qt::TextWordWrap) const
	Like the above, but with a rectangle for multiline text. More...

double	textWidthMillimeters (const QFont &font, const QString &text) const
	Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...

double	fontHeightCharacterMM (const QFont &font, const QChar &c) const
	Returns the font height of a character in millimeters. More...

double	fontAscentMillimeters (const QFont &font) const
	Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...

double	fontDescentMillimeters (const QFont &font) const
	Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...

double	fontHeightMillimeters (const QFont &font) const
	Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...

double	pixelFontSize (double pointSize) const
	Calculates font to from point size to pixel size. More...

QFont	scaledFontPixelSize (const QFont &font) const
	Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. More...

void	setPositionLock (bool lock)
	Locks / unlocks the item position for mouse drags. More...

bool	positionLock () const
	Returns position lock for mouse drags (true means locked) More...

double	itemRotation () const
	Returns the rotation for the composer item. More...

Q_DECL_DEPRECATED double	rotation () const
	Returns the rotation for the composer item. More...

virtual void	updateItem ()
	Updates item, with the possibility to do custom update for subclasses. More...

QString	id () const
	Get item's id (which is not necessarly unique) More...

virtual void	setId (const QString &id)
	Set item's id (which is not necessarly unique) More...

QString	uuid () const
	Get item identification name. More...

virtual int	numberExportLayers () const
	Get the number of layers that this item requires for exporting as layers. More...

virtual void	setCurrentExportLayer (int layerIdx=-1)
	Sets the current layer to draw for exporting. More...

Private Slots
void	removeLayer (QString layerId)
	Checks if this vector layer will be removed (and sets mVectorLayer to 0 if yes) More...

Private Member Functions
QList< int >	fieldsToDisplay () const
	Returns a list of attribute indices corresponding to displayed fields in the table. More...

void	restoreFieldAliasMap (const QMap< int, QString > &map)
	Restores a field alias map from a pre 2.4 format project file format. More...

Private Attributes
QgsVectorLayer *	mVectorLayer
	Associated vector layer. More...

const QgsComposerMap *	mComposerMap
	Associated composer map (used to display the visible features) More...

int	mMaximumNumberOfFeatures
	Maximum number of features that is displayed. More...

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

bool	mFilterFeatures
	True if feature filtering enabled. More...

QString	mFeatureFilter
	Feature filter expression. More...

Additional Inherited Members
Public Types inherited from QgsComposerTable
enum	HeaderHAlignment { FollowColumn, HeaderLeft, HeaderCenter, HeaderRight }

Public Types inherited from QgsComposerItem
enum	ItemType { ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel, ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture, ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable, ComposerTextTable, ComposerFrame }

enum	MouseMoveAction { MoveItem, ResizeUp, ResizeDown, ResizeLeft, ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown, ResizeRightDown, NoAction }
	Describes the action (move or resize in different directon) to be done during mouse move. More...

enum	ItemPositionMode { UpperLeft, UpperMiddle, UpperRight, MiddleLeft, Middle, MiddleRight, LowerLeft, LowerMiddle, LowerRight }

Public Slots inherited from QgsComposerTable
virtual void	refreshAttributes ()
	Refreshes the attributes shown in the table by querying the vector layer for new data. More...

virtual void	adjustFrameToSize ()
	Adapts the size of the frame to match the content. More...

Public Slots inherited from QgsComposerItem
virtual void	setRotation (double r)
	Sets the item rotation. More...

virtual void	setItemRotation (double r, bool adjustPosition=false)
	Sets the item rotation. More...

void	repaint ()

Protected Member Functions inherited from QgsComposerTable
virtual bool	calculateMaxColumnWidths (QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps) const
	Calculates the maximum width of text shown in columns. More...

void	adaptItemFrame (const QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps)
	Adapts the size of the item frame to match the table's content. More...

void	drawHorizontalGridLines (QPainter *p, int nAttributes)
	Draws the horizontal grid lines for the table. More...

void	drawVerticalGridLines (QPainter *p, const QMap< int, double > &maxWidthMap)
	Draws the vertical grid lines for the table. More...

bool	tableWriteXML (QDomElement &itemElem, QDomDocument &doc) const
	Writes common table properties to xml for storage. More...

bool	tableReadXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads the table's common properties from xml. More...

Protected Member Functions inherited from QgsComposerItem
virtual void	drawSelectionBoxes (QPainter *p)
	Draw selection boxes around item. More...

virtual void	drawFrame (QPainter *p)
	Draw black frame around item. More...

virtual void	drawBackground (QPainter *p)
	Draw background. More...

void	drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
	Draws arrowhead. More...

double	angle (const QPointF &p1, const QPointF &p2) const
	Returns angle of the line from p1 to p2 (clockwise, starting at N) More...

double	rectHandlerBorderTolerance () const
	Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing. More...

double	lockSymbolSize () const
	Returns the size of the lock symbol depending on the composer zoom level and the item size. More...

double	horizontalViewScaleFactor () const
	Returns the zoom factor of the graphics view. More...

bool	imageSizeConsideringRotation (double &width, double &height, double rotation) const
	Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...

Q_DECL_DEPRECATED bool	imageSizeConsideringRotation (double &width, double &height) const
	Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. More...

QRectF	largestRotatedRectWithinBounds (QRectF originalRect, QRectF boundsRect, double rotation) const
	Calculates the largest scaled version of originalRect which fits within boundsRect, when it is rotated by a specified amount. More...

bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
	Calculates corner point after rotation and scaling. More...

Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
	Calculates corner point after rotation and scaling. More...

void	sizeChangedByRotation (double &width, double &height, double rotation)
	Calculates width / height of the bounding box of a rotated rectangle. More...

Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height)
	Calculates width / height of the bounding box of a rotated rectangle. More...

void	rotate (double angle, double &x, double &y) const
	Rotates a point / vector. More...

QGraphicsLineItem *	hAlignSnapItem ()
	Return horizontal align snap item. More...

void	deleteHAlignSnapItem ()

QGraphicsLineItem *	vAlignSnapItem ()
	Return vertical align snap item. More...

void	deleteVAlignSnapItem ()

void	deleteAlignItems ()

Protected Attributes inherited from QgsComposerTable
double	mLineTextDistance
	Distance between table lines and text. More...

QFont	mHeaderFont

QFont	mContentFont

HeaderHAlignment	mHeaderHAlignment

bool	mShowGrid

double	mGridStrokeWidth

QColor	mGridColor

QList< QgsAttributeMap >	mAttributeMaps

QMap< int, double >	mMaxColumnWidthMap

QList< QgsComposerTableColumn * >	mColumns

Protected Attributes inherited from QgsComposerItem
QgsComposition *	mComposition

QgsComposerItem::MouseMoveAction	mCurrentMouseMoveAction

QPointF	mMouseMoveStartPos
	Start point of the last mouse move action (in scene coordinates) More...

QPointF	mLastMouseEventPos
	Position of the last mouse move event (in scene coordinates) More...

QGraphicsRectItem *	mBoundingResizeRectangle
	Rectangle used during move and resize actions. More...

QGraphicsLineItem *	mHAlignSnapItem

QGraphicsLineItem *	mVAlignSnapItem

bool	mFrame
	True if item fram needs to be painted. More...

bool	mBackground
	True if item background needs to be painted. More...

QColor	mBackgroundColor
	Background color. More...

Qt::PenJoinStyle	mFrameJoinStyle
	Frame join style. More...

bool	mItemPositionLocked
	True if item position and size cannot be changed with mouse move. More...

double	mLastValidViewScaleFactor
	Backup to restore item appearance if no view scale factor is available. More...

double	mItemRotation
	Item rotation in degrees, clockwise. More...

QPainter::CompositionMode	mBlendMode
	Composition blend mode for item. More...

bool	mEffectsEnabled

QgsComposerEffect *	mEffect

int	mTransparency
	Item transparency. More...

ItemPositionMode	mLastUsedPositionMode
	The item's position mode. More...

int	mCurrentExportLayer
	The layer that needs to be exported. More...

Detailed Description

A table class that displays a vector attribute table.

Definition at line 49 of file qgscomposerattributetable.h.

Constructor & Destructor Documentation

QgsComposerAttributeTable::QgsComposerAttributeTable ( QgsComposition * composition )

Definition at line 93 of file qgscomposerattributetable.cpp.

References QgsComposition::atlasComposition(), QgsMapLayerRegistry::instance(), QgsMapLayerRegistry::mapLayers(), QgsComposerItem::mComposition, mVectorLayer, QgsComposerTable::refreshAttributes(), removeLayer(), and resetColumns().

QgsComposerAttributeTable::~QgsComposerAttributeTable ( )

Definition at line 130 of file qgscomposerattributetable.cpp.

Member Function Documentation

const QgsComposerMap* QgsComposerAttributeTable::composerMap ( ) const

inline

Returns the composer map whose extents are controlling the features shown in the table.

The extents of the map are only used if displayOnlyVisibleFeatures() is true.

Returns: composer map controlling the attribute table

See also: setComposerMap; displayOnlyVisibleFeatures

Definition at line 111 of file qgscomposerattributetable.h.

QSet< int > QgsComposerAttributeTable::displayAttributes ( ) const

Returns the attributes fields which are shown by the table.

Returns: a QSet of integers refering to the attributes in the vector layer. If result is an empty QSet than all feature attributes will be shown.

See also: setDisplayAttributes

Deprecated:: use QgsComposerTable::columns() instead

Definition at line 256 of file qgscomposerattributetable.cpp.

References fieldsToDisplay().

Referenced by readXML().

bool QgsComposerAttributeTable::displayOnlyVisibleFeatures ( ) const

inline

Returns true if the table is set to show only features visible on a corresponding composer map item.

Returns: true if table only shows visible features

See also: composerMap; setDisplayOnlyVisibleFeatures

Definition at line 142 of file qgscomposerattributetable.h.

QString QgsComposerAttributeTable::featureFilter ( ) const

inline

Returns the current expression used to filter features for the table.

The filter is only active if filterFeatures() is true.

Returns: feature filter expression

Note: added in 2.3

See also: setFeatureFilter; filterFeatures

Definition at line 169 of file qgscomposerattributetable.h.

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

Returns the attribute field aliases, which control how fields are named in the table's header row.

Returns: a QMap of integers to strings, where the string is the field's alias and the integer is the field index from the associated vector layer.

See also: setFieldAliasMap

Deprecated:: use QgsComposerTable::columns() instead

Definition at line 310 of file qgscomposerattributetable.cpp.

References QgsVectorLayer::fieldNameIndex(), QgsComposerTable::mColumns, and mVectorLayer.

Referenced by readXML().

QList< int > QgsComposerAttributeTable::fieldsToDisplay ( ) const

private

Returns a list of attribute indices corresponding to displayed fields in the table.

Note: kept for compatibility with 2.0 api only

Definition at line 352 of file qgscomposerattributetable.cpp.

References QgsVectorLayer::fieldNameIndex(), QgsComposerTable::mColumns, and mVectorLayer.

Referenced by displayAttributes().

bool QgsComposerAttributeTable::filterFeatures ( ) const

inline

Returns true if a feature filter is active on the attribute table.

Returns: bool state of the feature filter

Note: added in 2.3

See also: setFilterFeatures; featureFilter

Definition at line 150 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::getFeatureAttributes ( QList< QgsAttributeMap > & attributeMaps )

virtual

Queries the attribute table's vector layer for attributes to show in the table.

Parameters

attributeMaps list of QgsAttributeMaps where the fetched feature attributes will be stored

Returns: true if attributes were successfully fetched

Note: not available in python bindings

Reimplemented from QgsComposerTable.

Definition at line 366 of file qgscomposerattributetable.cpp.

References QgsFeature::attributes(), QgsMapLayer::crs(), QgsComposerMap::currentMapExtent(), QgsMapSettings::destinationCrs(), QgsExpression::evaluate(), QgsFeatureRequest::ExactIntersect, QgsVectorLayer::fieldNameIndex(), QgsVectorLayer::getFeatures(), QgsMapSettings::hasCrsTransformEnabled(), QgsRectangle::isEmpty(), QgsComposition::mapSettings(), QgsComposerTable::mColumns, mComposerMap, QgsComposerItem::mComposition, mFeatureFilter, mFilterFeatures, mMaximumNumberOfFeatures, mShowOnlyVisibleFeatures, mVectorLayer, QgsFeatureIterator::nextFeature(), QgsFeatureRequest::NoFlags, QgsVectorLayer::pendingFields(), QgsExpression::prepare(), QgsCoordinateTransform::ReverseTransform, QgsComposerAttributeTableCompare::setAscending(), QgsExpression::setCurrentRowNumber(), QgsFeatureRequest::setFilterRect(), QgsFeatureRequest::setFlags(), QgsComposerAttributeTableCompare::setSortColumn(), and sortAttributes().

int QgsComposerAttributeTable::maximumNumberOfFeatures ( ) const

inline

Returns the maximum number of features to be shown by the table.

Returns: maximum number of features

See also: setMaximumNumberOfFeatures

Definition at line 125 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 134 of file qgscomposerattributetable.cpp.

References QgsComposerMap::isDrawing(), mComposerMap, and QgsComposerTable::paint().

bool QgsComposerAttributeTable::readXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)

virtual

Reads the properties specific to an attribute table from xml.

Parameters

itemElem	a QDomElement holding the attribute table's desired properties.
doc	QDomDocument for the source xml.

See also: writeXML

Implements QgsComposerTable.

Definition at line 589 of file qgscomposerattributetable.cpp.

References QgsFields::at(), QgsComposerTable::columns(), QgsComposerItem::composition(), displayAttributes(), fieldAliasMap(), QgsComposition::getComposerMapById(), index, QgsMapLayerRegistry::instance(), QgsComposerItem::itemChanged(), QgsMapLayerRegistry::mapLayer(), QgsComposerTable::mColumns, mComposerMap, mFeatureFilter, mFilterFeatures, mMaximumNumberOfFeatures, mShowOnlyVisibleFeatures, mVectorLayer, QgsVectorLayer::pendingFields(), QgsComposerTable::refreshAttributes(), restoreFieldAliasMap(), setDisplayAttributes(), and QgsComposerTable::tableReadXML().

Referenced by QgsComposition::addItemsFromXML().

void QgsComposerAttributeTable::removeLayer ( QString layerId )

privateslot

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

Definition at line 468 of file qgscomposerattributetable.cpp.

References QgsMapLayer::id(), QgsComposerTable::mColumns, and mVectorLayer.

Referenced by QgsComposerAttributeTable().

void QgsComposerAttributeTable::resetColumns ( )

Resets the attribute table's columns to match the vector layer's fields.

Note: added in 2.3

See also: setVectorLayer

Definition at line 167 of file qgscomposerattributetable.cpp.

References QgsVectorLayer::attributeDisplayName(), QgsFields::count(), QgsComposerTable::mColumns, mVectorLayer, QgsVectorLayer::pendingFields(), QgsComposerTableColumn::setAttribute(), and QgsComposerTableColumn::setHeading().

Referenced by QgsComposerAttributeTable(), QgsComposerAttributeTableColumnModel::resetToLayer(), and setVectorLayer().

void QgsComposerAttributeTable::restoreFieldAliasMap ( const QMap< int, QString > & map )

private

Restores a field alias map from a pre 2.4 format project file format.

Parameters

map	QMap of integers to strings, where the string is the alias to use for the corresponding field, and the integer is the field index from the vector layer

Definition at line 323 of file qgscomposerattributetable.cpp.

References QgsVectorLayer::attributeDisplayName(), QgsVectorLayer::fieldNameIndex(), QgsComposerTable::mColumns, and mVectorLayer.

Referenced by readXML(), and setFieldAliasMap().

void QgsComposerAttributeTable::setComposerMap ( const QgsComposerMap * map )

Sets the composer map to use to limit the extent of features shown in the attribute table.

This setting only has an effect if setDisplayOnlyVisibleFeatures is set to true. Changing the composer map forces the table to refetch features from its vector layer, and may result in the table changing size to accommodate the new displayed feature attributes.

Parameters

map	QgsComposerMap which drives the extents of the table's features

See also: composerMap; setDisplayOnlyVisibleFeatures

Definition at line 190 of file qgscomposerattributetable.cpp.

References mComposerMap, and QgsComposerTable::refreshAttributes().

Referenced by QgsComposerView::mouseReleaseEvent().

void QgsComposerAttributeTable::setDisplayAttributes	(	const QSet< int > &	attr,
		bool	refresh = `true`
	)

Sets the attributes to display in the table.

Parameters

attr	QSet of integer values refering to the attributes from the vector layer to show. Set to an empty QSet to show all feature attributes.
refresh	set to true to force the table to refetch features from its vector layer and immediately update the display of the table. This may result in the table changing size to accommodate the new displayed feature attributes.

See also: displayAttributes

Definition at line 261 of file qgscomposerattributetable.cpp.

References QgsVectorLayer::attributeDisplayName(), QgsFields::count(), QgsFields::exists(), QgsComposerTable::mColumns, mVectorLayer, QgsVectorLayer::pendingFields(), QgsComposerTable::refreshAttributes(), QgsComposerTableColumn::setAttribute(), and QgsComposerTableColumn::setHeading().

Referenced by readXML().

void QgsComposerAttributeTable::setDisplayOnlyVisibleFeatures ( bool visibleOnly )

Sets attribute table to only show features which are visible in a composer map item.

Changing this setting forces the table to refetch features from its vector layer, and may result in the table changing size to accommodate the new displayed feature attributes.

Parameters

visibleOnly set to true to show only visible features

See also: displayOnlyVisibleFeatures; setComposerMap

Definition at line 223 of file qgscomposerattributetable.cpp.

References mShowOnlyVisibleFeatures, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setFeatureFilter ( const QString & expression )

Sets the expression used for filtering features in the table.

The filter is only active if filterFeatures() is set to true. Changing this setting forces the table to refetch features from its vector layer, and may result in the table changing size to accommodate the new displayed feature attributes.

Parameters

expression filter to use for selecting which features to display in the table

Note: added in 2.3

See also: featureFilter; setFilterFeatures

Definition at line 245 of file qgscomposerattributetable.cpp.

References mFeatureFilter, and QgsComposerTable::refreshAttributes().

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

Sets the attribute field aliases, which control how fields are named in the table's header row.

Parameters

map	QMap of integers to strings, where the string is the alias to use for the corresponding field, and the integer is the field index from the vector layer

See also: fieldAliasMap

Deprecated:: use QgsComposerTable::columns() instead

Definition at line 346 of file qgscomposerattributetable.cpp.

References QgsComposerTable::refreshAttributes(), and restoreFieldAliasMap().

void QgsComposerAttributeTable::setFilterFeatures ( bool filter )

Sets whether the feature filter is active for the attribute table.

Changing this setting forces the table to refetch features from its vector layer, and may result in the table changing size to accommodate the new displayed feature attributes.

Parameters

filter Set to true to enable the feature filter

Note: added in 2.3

See also: filterFeatures; setFeatureFilter

Definition at line 234 of file qgscomposerattributetable.cpp.

References mFilterFeatures, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setMaximumNumberOfFeatures ( int features )

Sets the maximum number of features shown by the table.

Changing this setting may result in the attribute table changing its size to accommodate the new number of rows, and requires the table to refetch features from its vector layer.

Parameters

features maximum number of features to show in the table

See also: maximumNumberOfFeatures

Definition at line 212 of file qgscomposerattributetable.cpp.

References mMaximumNumberOfFeatures, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setSceneRect ( const QRectF & rectangle )

virtual

Adapts mMaximumNumberOfFeatures depending on the rectangle height.

Calling this forces the table to refetch features from its vector layer and immediately updates the display of the table.

See also: maximumNumberOfFeatures; setMaximumNumberOfFeatures

Reimplemented from QgsComposerItem.

Definition at line 482 of file qgscomposerattributetable.cpp.

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

Referenced by QgsComposerView::mouseReleaseEvent().

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

Sets the attributes to use to sort the table's features.

Parameters

att QList integers/bool pairs, where the integer refers to the attribute index and the bool sets the sort order for the attribute. If true the attribute is sorted ascending, if false, the attribute is sorted in descending order. Note that features are sorted after the maximum number of displayed features have been fetched from the vector layer's provider.

See also: sortAttributes

Deprecated:

use QgsComposerTable::columns() instead

Note: not available in python bindings

Definition at line 502 of file qgscomposerattributetable.cpp.

References QgsComposerTable::mColumns, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setVectorLayer ( QgsVectorLayer * layer )

Sets the vector layer from which to display feature attributes.

Parameters

layer Vector layer for attribute table

See also: vectorLayer

Definition at line 143 of file qgscomposerattributetable.cpp.

References mVectorLayer, QgsComposerTable::refreshAttributes(), and resetColumns().

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

Returns the attributes used to sort the table's features.

Returns: a QList of integer/bool pairs, where the integer refers to the attribute index and the bool to the sort order for the attribute. If true the attribute is sorted ascending, if false, the attribute is sorted in descending order.

Note: not available in python bindings

Definition at line 533 of file qgscomposerattributetable.cpp.

References columnsBySortRank(), and QgsComposerTable::mColumns.

Referenced by getFeatureAttributes().

virtual int QgsComposerAttributeTable::type ( ) const

inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerTable.

Definition at line 57 of file qgscomposerattributetable.h.

References QgsComposerItem::ComposerAttributeTable.

QgsVectorLayer* QgsComposerAttributeTable::vectorLayer ( ) const

inline

Returns the vector layer the attribute table is currently using.

Returns: attribute table's current vector layer

See also: setVectorLayer

Definition at line 86 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::writeXML	(	QDomElement &	elem,
		QDomDocument &	doc
	)		const

virtual

Writes properties specific to attribute tables.

Parameters

elem	an existing QDomElement in which to store the attribute table's properties.
doc	QDomDocument for the destination xml.

See also: readXML

Implements QgsComposerTable.

Definition at line 563 of file qgscomposerattributetable.cpp.

References QgsMapLayer::id(), QgsComposerMap::id(), mComposerMap, mFeatureFilter, mFilterFeatures, mMaximumNumberOfFeatures, mShowOnlyVisibleFeatures, mVectorLayer, and QgsComposerTable::tableWriteXML().

Member Data Documentation

const QgsComposerMap* QgsComposerAttributeTable::mComposerMap

private

Associated composer map (used to display the visible features)

Definition at line 257 of file qgscomposerattributetable.h.

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

QString QgsComposerAttributeTable::mFeatureFilter

private

Feature filter expression.

Definition at line 267 of file qgscomposerattributetable.h.

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

bool QgsComposerAttributeTable::mFilterFeatures

private

True if feature filtering enabled.

Definition at line 265 of file qgscomposerattributetable.h.

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

int QgsComposerAttributeTable::mMaximumNumberOfFeatures

private

Maximum number of features that is displayed.

Definition at line 259 of file qgscomposerattributetable.h.

Referenced by getFeatureAttributes(), readXML(), setMaximumNumberOfFeatures(), 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 262 of file qgscomposerattributetable.h.

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

QgsVectorLayer* QgsComposerAttributeTable::mVectorLayer

private

Associated vector layer.

Definition at line 255 of file qgscomposerattributetable.h.

Referenced by fieldAliasMap(), fieldsToDisplay(), getFeatureAttributes(), QgsComposerAttributeTable(), readXML(), removeLayer(), resetColumns(), restoreFieldAliasMap(), setDisplayAttributes(), setVectorLayer(), and writeXML().

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

/tmp/buildd/qgis-2.4.0+unstable1/src/core/composer/qgscomposerattributetable.h
/tmp/buildd/qgis-2.4.0+unstable1/src/core/composer/qgscomposerattributetable.cpp

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation