A class to display feature attributes in the print composer. More...

#include <qgscomposertable.h>

Inheritance diagram for QgsComposerTable:

Public Types
enum	HeaderHAlignment { FollowColumn, HeaderLeft, HeaderCenter, HeaderRight }
Public Types inherited from QgsComposerItem
enum	ItemPositionMode { UpperLeft, UpperMiddle, UpperRight, MiddleLeft, Middle, MiddleRight, LowerLeft, LowerMiddle, LowerRight }
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	ZoomMode { Zoom = 0, ZoomRecenter, ZoomToPoint, NoZoom }
	Modes for zooming item content. More...
Public Types inherited from QgsComposerObject
enum	DataDefinedProperty { NoProperty = 0, AllProperties, TestProperty, PresetPaperSize, PaperWidth, PaperHeight, NumPages, PaperOrientation, PageNumber, PositionX, PositionY, ItemWidth, ItemHeight, ItemRotation, Transparency, BlendMode, ExcludeFromExports, MapRotation, MapScale, MapXMin, MapYMin, MapXMax, MapYMax, MapAtlasMargin, PictureSource, SourceUrl }
	Data defined properties for different item types. More...
enum	PropertyValueType { EvaluatedValue = 0, OriginalValue }
	Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More...

Public Slots
virtual void	adjustFrameToSize ()
	Adapts the size of the frame to match the content.
virtual void	refreshAttributes ()
	Refreshes the attributes shown in the table by querying the vector layer for new data.
Public Slots inherited from QgsComposerItem
virtual void	refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties) override
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.
void	repaint () override
virtual void	setItemRotation (const double r, const bool adjustPosition=false)
	Sets the item rotation.
virtual void	setRotation (double r)
	Sets the item rotation.
Public Slots inherited from QgsComposerObject
virtual void	refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties)
	Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value.
virtual void	repaint ()
	Triggers a redraw for the item.

Public Member Functions
	QgsComposerTable (QgsComposition *composition)
virtual	~QgsComposerTable ()
QList< QgsComposerTableColumn * > *	columns ()
	Returns a pointer to the list of QgsComposerTableColumns shown in the table.
QFont	contentFont () const
	Returns the font used to draw text in table body cells.
QColor	contentFontColor () const
	Returns the color used to draw text in table body cells.
virtual bool	getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps)
	Fetches the text used for the rows of the table.
QColor	gridColor () const
	Returns the color used for grid lines in the table.
double	gridStrokeWidth () const
	Returns the width of grid lines in the table.
QFont	headerFont () const
	Returns the font used to draw header text in the table.
QColor	headerFontColor () const
	Returns the color used to draw header text in the table.
HeaderHAlignment	headerHAlignment () const
	Returns the horizontal alignment for table headers.
virtual QMap< int, QString >	headerLabels () const
	Returns the text used in the column headers for the table.
double	lineTextDistance () const
	Returns the margin distance between cell borders and their contents.
virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem itemStyle, QWidget *pWidget) override
	Reimplementation of QCanvasItem::paint.
virtual bool	readXML (const QDomElement &itemElem, const QDomDocument &doc) override=0
	Sets item state from DOM element.
void	setColumns (QList< QgsComposerTableColumn * > columns)
	Replaces the columns in the table with a specified list of QgsComposerTableColumns.
void	setContentFont (const QFont &f)
	Sets the font used to draw text in table body cells.
void	setContentFontColor (const QColor &color)
	Sets the color used to draw text in table body cells.
void	setGridColor (const QColor &c)
	Sets color used for grid lines in the table.
void	setGridStrokeWidth (double w)
	Sets the width for grid lines in the table.
void	setHeaderFont (const QFont &f)
	Sets the font used to draw header text in the table.
void	setHeaderFontColor (const QColor &color)
	Sets the color used to draw header text in the table.
void	setHeaderHAlignment (const HeaderHAlignment alignment)
	Sets the horizontal alignment for table headers.
void	setLineTextDistance (double d)
	Sets the margin distance between cell borders and their contents.
void	setShowGrid (bool show)
	Sets whether grid lines should be drawn in the table.
bool	showGrid () const
	Returns whether grid lines are drawn in the table.
virtual int	type () const override
	return correct graphics item type.
virtual bool	writeXML (QDomElement &elem, QDomDocument &doc) const override=0
	Stores item state in DOM element.
Public Member Functions inherited from QgsComposerItem
	QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
	Constructor.
	QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
	Constructor with box position and composer object.
virtual	~QgsComposerItem ()
bool	_readXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads parameter that are not subclass specific in document.
bool	_writeXML (QDomElement &itemElem, QDomDocument &doc) const
	Writes parameter that are not subclass specific in document.
virtual void	addItem (QgsComposerItem *item)
	Composite operations for item groups do nothing per default.
QColor	backgroundColor () const
	Gets the background color for this item.
void	beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown)
	Starts new composer undo command.
virtual void	beginItemCommand (const QString &text)
QPainter::CompositionMode	blendMode () const
	Returns the item's composition blending mode.
void	cancelCommand ()
virtual QString	displayName () const
	Get item display name.
Q_DECL_DEPRECATED void	drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const
	Draws Text.
Q_DECL_DEPRECATED 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.
bool	effectsEnabled () const
	Returns whether effects (eg blend modes) are enabled for the item.
void	endCommand ()
	Finish current command and push it onto the undo stack.
virtual void	endItemCommand ()
virtual double	estimatedFrameBleed () const
	Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.
bool	excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue)
	Returns whether the item should be excluded from composer exports and prints.
Q_DECL_DEPRECATED double	fontAscentMillimeters (const QFont &font) const
	Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Q_DECL_DEPRECATED double	fontDescentMillimeters (const QFont &font) const
	Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Q_DECL_DEPRECATED double	fontHeightCharacterMM (const QFont &font, const QChar &c) const
	Returns the font height of a character in millimeters.
Q_DECL_DEPRECATED double	fontHeightMillimeters (const QFont &font) const
	Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Qt::PenJoinStyle	frameJoinStyle () const
	Returns the join style used for drawing the item's frame.
QColor	frameOutlineColor () const
	Returns the frame's outline color.
double	frameOutlineWidth () const
	Returns the frame's outline width.
bool	hasBackground () const
	Whether this item has a Background or not.
bool	hasFrame () const
	Whether this item has a frame or not.
QString	id () const
	Get item's id (which is not necessarly unique)
bool	isGroupMember () const
	Returns whether this item is part of a group.
virtual bool	isRemoved () const
	Returns whether this item has been removed from the composition.
double	itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
	Returns the current rotation for the composer item.
ItemPositionMode	lastUsedPositionMode ()
	Returns item's last used position mode.
void	move (double dx, double dy)
	Moves item in canvas coordinates.
virtual void	moveContent (double dx, double dy)
	Move Content of item.
virtual int	numberExportLayers () const
	Get the number of layers that this item requires for exporting as layers.
int	page () const
	Gets the page the item is currently on.
QPointF	pagePos () const
	Returns the item's position relative to its current page.
Q_DECL_DEPRECATED double	pixelFontSize (double pointSize) const
	Calculates font size in mm from a font point size.
bool	positionLock () const
	Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing.
virtual QRectF	rectWithFrame () const
	Returns the item's rectangular bounds, including any bleed caused by the item's frame.
virtual void	removeItems ()
Q_DECL_DEPRECATED double	rotation () const
	Returns the rotation for the composer item.
Q_DECL_DEPRECATED QFont	scaledFontPixelSize (const QFont &font) const
	Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.
virtual bool	selected () const
	Is selected.
void	setBackgroundColor (const QColor &backgroundColor)
	Sets the background color for this item.
void	setBackgroundEnabled (const bool drawBackground)
	Set whether this item has a Background drawn around it or not.
void	setBlendMode (const QPainter::CompositionMode blendMode)
	Sets the item's composition blending mode.
virtual void	setCurrentExportLayer (const int layerIdx=-1)
	Sets the current layer to draw for exporting.
void	setEffectsEnabled (const bool effectsEnabled)
	Sets whether effects (eg blend modes) are enabled for the item.
virtual void	setExcludeFromExports (const bool exclude)
	Sets whether the item should be excluded from composer exports and prints.
virtual void	setFrameEnabled (const bool drawFrame)
	Set whether this item has a frame drawn around it or not.
void	setFrameJoinStyle (const Qt::PenJoinStyle style)
	Sets join style used when drawing the item's frame.
virtual void	setFrameOutlineColor (const QColor &color)
	Sets frame outline color.
virtual void	setFrameOutlineWidth (const double outlineWidth)
	Sets frame outline width.
virtual void	setId (const QString &id)
	Set item's id (which is not necessarly unique)
void	setIsGroupMember (const bool isGroupMember)
	Sets whether this item is part of a group.
void	setIsRemoved (const bool removed)
	Sets whether this item has been removed from the composition.
void	setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1)
	Moves the item to a new position (in canvas coordinates)
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.
void	setPositionLock (const bool lock)
	Locks / unlocks the item position for mouse drags.
virtual void	setSceneRect (const QRectF &rectangle)
	Sets this items bound in scene coordinates such that 1 item size units corresponds to 1 scene size unit.
virtual void	setSelected (bool s)
	Set selected, selected item should be highlighted.
void	setTransparency (const int transparency)
	Sets the item's transparency.
virtual void	setVisibility (const bool visible)
	Sets visibility for item.
Q_DECL_DEPRECATED double	textWidthMillimeters (const QFont &font, const QString &text) const
	Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
int	transparency () const
	Returns the item's transparency.
virtual void	updateItem ()
	Updates item, with the possibility to do custom update for subclasses.
void	updatePagePos (double newPageWidth, double newPageHeight)
	Moves the item so that it retains its relative position on the page when the paper size changes.
QString	uuid () const
	Get item identification name.
virtual Q_DECL_DEPRECATED void	zoomContent (int delta, double x, double y)
	Zoom content of item.
virtual void	zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom)
	Zoom content of item.
Public Member Functions inherited from QgsComposerObject
	QgsComposerObject (QgsComposition *composition)
	Constructor.
virtual	~QgsComposerObject ()
const QgsComposition *	composition () const
	Returns the composition the item is attached to.
QgsComposition *	composition ()
QgsDataDefined *	dataDefinedProperty (const DataDefinedProperty property) const
	Returns a reference to the data defined settings for one of the item's data defined properties.
void	setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field)
	Sets parameters for a data defined property for the item.

Protected Member Functions
void	adaptItemFrame (const QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps)
	Adapts the size of the item frame to match the table's content.
virtual bool	calculateMaxColumnWidths (QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps) const
	Calculates the maximum width of text shown in columns.
void	drawHorizontalGridLines (QPainter *p, int nAttributes)
	Draws the horizontal grid lines for the table.
void	drawVerticalGridLines (QPainter *p, const QMap< int, double > &maxWidthMap)
	Draws the vertical grid lines for the table.
bool	tableReadXML (const QDomElement &itemElem, const QDomDocument &doc)
	Reads the table's common properties from xml.
bool	tableWriteXML (QDomElement &itemElem, QDomDocument &doc) const
	Writes common table properties to xml for storage.
Protected Member Functions inherited from QgsComposerItem
Q_DECL_DEPRECATED double	angle (const QPointF &p1, const QPointF &p2) const
	Returns angle of the line from p1 to p2 (clockwise, starting at N)
Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const
	Calculates corner point after rotation and scaling.
Q_DECL_DEPRECATED bool	cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
	Calculates corner point after rotation and scaling.
void	deleteAlignItems ()
void	deleteHAlignSnapItem ()
void	deleteVAlignSnapItem ()
Q_DECL_DEPRECATED void	drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
	Draws arrowhead.
virtual void	drawBackground (QPainter *p)
	Draw background.
virtual void	drawFrame (QPainter *p)
	Draw black frame around item.
virtual void	drawSelectionBoxes (QPainter *p)
	Draws additional graphics on selected items.
QRectF	evalItemRect (const QRectF &newRect, const bool resizeOnly=false)
	Evaluates an item's bounding rect to consider data defined position and size of item and reference point.
QGraphicsLineItem *	hAlignSnapItem ()
	Return horizontal align snap item.
double	horizontalViewScaleFactor () const
	Returns the zoom factor of the graphics view.
Q_DECL_DEPRECATED 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.
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.
Q_DECL_DEPRECATED 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.
Q_DECL_DEPRECATED double	lockSymbolSize () const
	Returns the size of the lock symbol depending on the composer zoom level and the item size.
double	rectHandlerBorderTolerance () const
	Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing.
Q_DECL_DEPRECATED void	rotate (double angle, double &x, double &y) const
	Rotates a point / vector.
bool	shouldDrawItem () const
	Returns whether the item should be drawn in the current context.
Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height, double rotation)
	Calculates width / height of the bounding box of a rotated rectangle.
Q_DECL_DEPRECATED void	sizeChangedByRotation (double &width, double &height)
	Calculates width / height of the bounding box of a rotated rectangle.
QGraphicsLineItem *	vAlignSnapItem ()
	Return vertical align snap item.
Protected Member Functions inherited from QgsComposerObject
bool	dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
	Evaluate a data defined property and return the calculated value.

Protected Attributes
QList< QgsAttributeMap >	mAttributeMaps
QList< QgsComposerTableColumn * >	mColumns
QFont	mContentFont
QColor	mContentFontColor
QColor	mGridColor
double	mGridStrokeWidth
QFont	mHeaderFont
QColor	mHeaderFontColor
HeaderHAlignment	mHeaderHAlignment
double	mLineTextDistance
	Distance between table lines and text.
QMap< int, double >	mMaxColumnWidthMap
bool	mShowGrid
Protected Attributes inherited from QgsComposerItem
bool	mBackground
	True if item background needs to be painted.
QColor	mBackgroundColor
	Background color.
QPainter::CompositionMode	mBlendMode
	Composition blend mode for item.
QGraphicsRectItem *	mBoundingResizeRectangle
	Rectangle used during move and resize actions.
int	mCurrentExportLayer
	The layer that needs to be exported.
QgsComposerItem::MouseMoveAction	mCurrentMouseMoveAction
QgsComposerEffect *	mEffect
bool	mEffectsEnabled
bool	mEvaluatedExcludeFromExports
	Temporary evaluated item exclusion.
double	mEvaluatedItemRotation
	Temporary evaluated item rotation in degrees, clockwise.
bool	mExcludeFromExports
	Whether item should be excluded in exports.
bool	mFrame
	True if item fram needs to be painted.
Qt::PenJoinStyle	mFrameJoinStyle
	Frame join style.
QGraphicsLineItem *	mHAlignSnapItem
bool	mIsGroupMember
	Whether or not this item is part of a group.
bool	mItemPositionLocked
	True if item position and size cannot be changed with mouse move.
double	mItemRotation
	Item rotation in degrees, clockwise.
QPointF	mLastMouseEventPos
	Position of the last mouse move event (in scene coordinates)
ItemPositionMode	mLastUsedPositionMode
	The item's position mode.
double	mLastValidViewScaleFactor
	Backup to restore item appearance if no view scale factor is available.
QPointF	mMouseMoveStartPos
	Start point of the last mouse move action (in scene coordinates)
bool	mRemovedFromComposition
	True if item has been removed from the composition.
int	mTransparency
	Item transparency.
QGraphicsLineItem *	mVAlignSnapItem
Protected Attributes inherited from QgsComposerObject
QgsComposition *	mComposition
QMap < QgsComposerObject::DataDefinedProperty, QString >	mDataDefinedNames
	Map of data defined properties for the item to string name to use when exporting item to xml.

Additional Inherited Members
Signals inherited from QgsComposerItem
void	frameChanged ()
	Emitted if the item's frame style changes.
void	itemRotationChanged (double newRotation)
	Is emitted on item rotation change.
void	lockChanged ()
	Emitted if the item's lock status changes.
void	sizeChanged ()
	Emitted if the rectangle changes.

Detailed Description

A class to display feature attributes in the print composer.

Definition at line 30 of file qgscomposertable.h.

Member Enumeration Documentation

enum QgsComposerTable::HeaderHAlignment

Controls how headers are horizontally aligned in a table

Enumerator:

FollowColumn	header uses the same alignment as the column
HeaderLeft	align headers left
HeaderCenter	align headers to center
HeaderRight	align headers right

Definition at line 38 of file qgscomposertable.h.

Constructor & Destructor Documentation

QgsComposerTable::QgsComposerTable ( QgsComposition * composition )

Definition at line 26 of file qgscomposertable.cpp.

QgsComposerTable::~QgsComposerTable ( )

virtual

Definition at line 46 of file qgscomposertable.cpp.

Member Function Documentation

void QgsComposerTable::adaptItemFrame	(	const QMap< int, double > &	maxWidthMap,
		const QList< QgsAttributeMap > &	attributeMaps
	)

protected

Adapts the size of the item frame to match the table's content.

Parameters

maxWidthMap	QMap of int to double, where the int contains the column number and the double is the maximum width of text present in the column.
attributeMaps	list of attribute values for each row shown in the table

Note: not available in python bindings

See Also: calculateMaxColumnWidths

Definition at line 383 of file qgscomposertable.cpp.

void QgsComposerTable::adjustFrameToSize ( )

virtualslot

Adapts the size of the frame to match the content.

First, the optimal width of the columns is recalculated by checking the maximum width of attributes shown in the table. Then, the table is resized to fit its contents. This slot utilises the table's attribute cache so that a re-query of the vector layer is not required.

Note: added in 2.3

See Also: refreshAttributes

Definition at line 231 of file qgscomposertable.cpp.

bool QgsComposerTable::calculateMaxColumnWidths	(	QMap< int, double > &	maxWidthMap,
		const QList< QgsAttributeMap > &	attributeMaps
	)		const

protectedvirtual

Calculates the maximum width of text shown in columns.

Parameters

maxWidthMap	QMap of int to double in which to store the maximum widths. The int will be filled with the column number and the double with the maximum width of text present in the column.
attributeMaps	list of attribute values for each row shown in the table

Note: not available in python bindings

See Also: adaptItemFrame

Definition at line 351 of file qgscomposertable.cpp.

QList<QgsComposerTableColumn*>* QgsComposerTable::columns ( )

inline

Returns a pointer to the list of QgsComposerTableColumns shown in the table.

Returns: pointer to list of columns in table

Note: added in 2.3

See Also: setColumns

Definition at line 219 of file qgscomposertable.h.

QFont QgsComposerTable::contentFont ( ) const

inline

Returns the font used to draw text in table body cells.

Returns: font for table cells

See Also: setContentFont; headerFont

Definition at line 128 of file qgscomposertable.h.

QColor QgsComposerTable::contentFontColor ( ) const

inline

Returns the color used to draw text in table body cells.

Returns: text color for table cells

See Also: setContentFontColor; contentFont; headerFontColor

Note: added in 2.5

Definition at line 146 of file qgscomposertable.h.

void QgsComposerTable::drawHorizontalGridLines	(	QPainter *	p,
		int	nAttributes
	)

protected

Draws the horizontal grid lines for the table.

Parameters

p	destination painter for grid lines
nAttributes	number of attribute rows shown in table

See Also: drawVerticalGridLines

Definition at line 408 of file qgscomposertable.cpp.

void QgsComposerTable::drawVerticalGridLines	(	QPainter *	p,
		const QMap< int, double > &	maxWidthMap
	)

protected

Draws the vertical grid lines for the table.

Parameters

p	destination painter for grid lines
maxWidthMap	QMap of int to double, where the int contains the column number and the double is the maximum width of text present in the column.

Note: not available in python bindings

See Also: drawVerticalGridLines; calculateMaxColumnWidths

Definition at line 425 of file qgscomposertable.cpp.

virtual bool QgsComposerTable::getFeatureAttributes ( QList< QgsAttributeMap > & attributeMaps )

inlinevirtual

Fetches the text used for the rows of the table.

Returns: true if attribute text was successfully retrieved.

Parameters

attributeMaps QList of QgsAttributeMap to store retrieved row data in

Note: not available in python bindings

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 212 of file qgscomposertable.h.

QColor QgsComposerTable::gridColor ( ) const

inline

Returns the color used for grid lines in the table.

Returns: grid line color

See Also: setGridColor; showGrid; gridStrokeWidth

Definition at line 194 of file qgscomposertable.h.

double QgsComposerTable::gridStrokeWidth ( ) const

inline

Returns the width of grid lines in the table.

Returns: grid line width

See Also: setGridStrokeWidth; showGrid; gridColor

Definition at line 178 of file qgscomposertable.h.

QFont QgsComposerTable::headerFont ( ) const

inline

Returns the font used to draw header text in the table.

Returns: font for header cells

See Also: setHeaderFont; contentFont

Definition at line 82 of file qgscomposertable.h.

QColor QgsComposerTable::headerFontColor ( ) const

inline

Returns the color used to draw header text in the table.

Returns: color for header text

See Also: setHeaderFontColor; headerFont; contentFontColor

Note: added in 2.5

Definition at line 100 of file qgscomposertable.h.

HeaderHAlignment QgsComposerTable::headerHAlignment ( ) const

inline

Returns the horizontal alignment for table headers.

Returns: Horizontal alignment for table header cells

Note: added in 2.3

See Also: setHeaderHAlignment

Definition at line 114 of file qgscomposertable.h.

QMap< int, QString > QgsComposerTable::headerLabels ( ) const

virtual

Returns the text used in the column headers for the table.

Returns: QMap of int to QString, where the int is the column index (starting at 0), and the string is the text to use for the column's header

Note: added in 2.3; not available in python bindings

Definition at line 244 of file qgscomposertable.cpp.

double QgsComposerTable::lineTextDistance ( ) const

inline

Returns the margin distance between cell borders and their contents.

Returns: margin for cell contents

See Also: setLineTextDistance

Definition at line 68 of file qgscomposertable.h.

void QgsComposerTable::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	itemStyle,
		QWidget *	pWidget
	)

overridevirtual

Reimplementation of QCanvasItem::paint.

Reimplemented in QgsComposerAttributeTable.

Definition at line 68 of file qgscomposertable.cpp.

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

overridepure virtual

Sets item state from DOM element.

Parameters

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

Reimplemented from QgsComposerObject.

Implemented in QgsComposerAttributeTable, and QgsComposerTextTable.

void QgsComposerTable::refreshAttributes ( )

virtualslot

Refreshes the attributes shown in the table by querying the vector layer for new data.

This also causes the column widths and size of the table to change to accommodate the new data.

Note: added in 2.3

See Also: adjustFrameToSize

Definition at line 52 of file qgscomposertable.cpp.

void QgsComposerTable::setColumns ( QList< QgsComposerTableColumn * > columns )

Replaces the columns in the table with a specified list of QgsComposerTableColumns.

Parameters

columns list of QgsComposerTableColumns to show in table

Note: added in 2.3

See Also: columns

Definition at line 258 of file qgscomposertable.cpp.

void QgsComposerTable::setContentFont ( const QFont & f )

Sets the font used to draw text in table body cells.

Parameters

f	font for table cells

See Also: contentFont; setHeaderFont

Definition at line 204 of file qgscomposertable.cpp.

void QgsComposerTable::setContentFontColor ( const QColor & color )

Sets the color used to draw text in table body cells.

Parameters

color table cell text color

See Also: contentFontColor; setContentFont; setHeaderFontColor

Note: added in 2.5

Definition at line 211 of file qgscomposertable.cpp.

void QgsComposerTable::setGridColor ( const QColor & c )

inline

Sets color used for grid lines in the table.

Parameters

c	grid line color

See Also: gridColor; setShowGrid; setGridStrokeWidth

Definition at line 186 of file qgscomposertable.h.

void QgsComposerTable::setGridStrokeWidth ( double w )

Sets the width for grid lines in the table.

Parameters

w	grid line width

See Also: gridStrokeWidth; setShowGrid; setGridColor

Definition at line 224 of file qgscomposertable.cpp.

void QgsComposerTable::setHeaderFont ( const QFont & f )

Sets the font used to draw header text in the table.

Parameters

f	font for header cells

See Also: headerFont; setContentFont

Definition at line 185 of file qgscomposertable.cpp.

void QgsComposerTable::setHeaderFontColor ( const QColor & color )

Sets the color used to draw header text in the table.

Parameters

color header text color

See Also: headerFontColor; setHeaderFont; setContentFontColor

Note: added in 2.5

Definition at line 192 of file qgscomposertable.cpp.

void QgsComposerTable::setHeaderHAlignment ( const HeaderHAlignment alignment )

Sets the horizontal alignment for table headers.

Parameters

alignment Horizontal alignment for table header cells

Note: added in 2.3

See Also: headerHAlignment

Definition at line 198 of file qgscomposertable.cpp.

void QgsComposerTable::setLineTextDistance ( double d )

Sets the margin distance between cell borders and their contents.

Parameters

d	margin for cell contents

See Also: lineTextDistance

Definition at line 178 of file qgscomposertable.cpp.

void QgsComposerTable::setShowGrid ( bool show )

Sets whether grid lines should be drawn in the table.

Parameters

show	set to true to show grid lines

See Also: showGrid; setGridStrokeWidth; setGridColor

Definition at line 217 of file qgscomposertable.cpp.

bool QgsComposerTable::showGrid ( ) const

inline

Returns whether grid lines are drawn in the table.

Returns: true if grid lines are shown

See Also: setShowGrid; gridStrokeWidth; gridColor

Definition at line 162 of file qgscomposertable.h.

bool QgsComposerTable::tableReadXML	(	const QDomElement &	itemElem,
		const QDomDocument &	doc
	)

protected

Reads the table's common properties from xml.

Parameters

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

See Also: tableWriteXML; readXML

Definition at line 293 of file qgscomposertable.cpp.

bool QgsComposerTable::tableWriteXML	(	QDomElement &	itemElem,
		QDomDocument &	doc
	)		const

protected

Writes common table properties to xml for storage.

Parameters

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

See Also: tableReadXML; writeXML

Definition at line 267 of file qgscomposertable.cpp.

virtual int QgsComposerTable::type ( ) const

inlineoverridevirtual

return correct graphics item type.

Reimplemented from QgsComposerItem.

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 50 of file qgscomposertable.h.

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

overridepure virtual

Stores item state in DOM element.

Parameters

elem	is DOM element corresponding to item tag
doc	is the DOM document

Reimplemented from QgsComposerObject.

Implemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Member Data Documentation

QList<QgsAttributeMap> QgsComposerTable::mAttributeMaps

protected

Definition at line 262 of file qgscomposertable.h.

QList<QgsComposerTableColumn*> QgsComposerTable::mColumns

protected

Definition at line 265 of file qgscomposertable.h.

QFont QgsComposerTable::mContentFont

protected

Definition at line 253 of file qgscomposertable.h.

QColor QgsComposerTable::mContentFontColor

protected

Definition at line 254 of file qgscomposertable.h.

QColor QgsComposerTable::mGridColor

protected

Definition at line 260 of file qgscomposertable.h.

double QgsComposerTable::mGridStrokeWidth

protected

Definition at line 259 of file qgscomposertable.h.

QFont QgsComposerTable::mHeaderFont

protected

Definition at line 251 of file qgscomposertable.h.

QColor QgsComposerTable::mHeaderFontColor

protected

Definition at line 252 of file qgscomposertable.h.

HeaderHAlignment QgsComposerTable::mHeaderHAlignment

protected

Definition at line 256 of file qgscomposertable.h.

double QgsComposerTable::mLineTextDistance

protected

Distance between table lines and text.

Definition at line 249 of file qgscomposertable.h.

QMap<int, double> QgsComposerTable::mMaxColumnWidthMap

protected

Definition at line 263 of file qgscomposertable.h.

bool QgsComposerTable::mShowGrid

protected

Definition at line 258 of file qgscomposertable.h.

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

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

Public Types

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation