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

#include <qgscomposertable.h>

Inheritance diagram for QgsComposerTable:

Collaboration diagram for QgsComposerTable:

Public Types
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
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 ()

Public Member Functions
	QgsComposerTable (QgsComposition *composition)

virtual	~QgsComposerTable ()

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

virtual bool	writeXML (QDomElement &elem, QDomDocument &doc) const =0
	stores state in Dom element More...

virtual bool	readXML (const QDomElement &itemElem, const QDomDocument &doc)=0
	sets state from Dom document More...

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

virtual bool	getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps)
	Fetches the text used for the rows of 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...

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

Protected Member Functions
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
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...

Additional Inherited Members
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...

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 24 of file qgscomposertable.cpp.

References mContentFont, and mHeaderFont.

QgsComposerTable::~QgsComposerTable ( )

virtual

Definition at line 42 of file qgscomposertable.cpp.

References mColumns.

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 346 of file qgscomposertable.cpp.

References QgsComposerItem::fontAscentMillimeters(), mContentFont, mGridStrokeWidth, mHeaderFont, mLineTextDistance, and QgsComposerItem::setSceneRect().

Referenced by adjustFrameToSize().

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 205 of file qgscomposertable.cpp.

References adaptItemFrame(), calculateMaxColumnWidths(), mAttributeMaps, mMaxColumnWidthMap, and QgsComposerItem::repaint().

Referenced by refreshAttributes(), setContentFont(), setGridStrokeWidth(), setHeaderFont(), setLineTextDistance(), and setShowGrid().

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 314 of file qgscomposertable.cpp.

References mColumns, mContentFont, mHeaderFont, and QgsComposerItem::textWidthMillimeters().

Referenced by adjustFrameToSize().

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 183 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 110 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 368 of file qgscomposertable.cpp.

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

Referenced by paint().

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 385 of file qgscomposertable.cpp.

References mGridStrokeWidth, and mLineTextDistance.

Referenced by paint().

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 176 of file qgscomposertable.h.

Referenced by refreshAttributes().

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 158 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 142 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.

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 96 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 218 of file qgscomposertable.cpp.

References mColumns.

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
	)

virtual

Reimplementation of QCanvasItem::paint.

Reimplemented in QgsComposerAttributeTable.

Definition at line 64 of file qgscomposertable.cpp.

References QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), drawHorizontalGridLines(), QgsComposerItem::drawSelectionBoxes(), QgsComposerItem::drawText(), drawVerticalGridLines(), FollowColumn, QgsComposerItem::fontAscentMillimeters(), HeaderCenter, HeaderLeft, HeaderRight, mAttributeMaps, mColumns, QgsComposerItem::mComposition, mContentFont, mGridColor, mGridStrokeWidth, mHeaderFont, mHeaderHAlignment, mLineTextDistance, mMaxColumnWidthMap, mShowGrid, QgsComposition::plotStyle(), QgsComposition::Postscript, QgsComposition::Print, and refreshAttributes().

Referenced by QgsComposerAttributeTable::paint().

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

pure virtual

sets state from Dom document

Parameters

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

Implements QgsComposerItem.

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 48 of file qgscomposertable.cpp.

References adjustFrameToSize(), getFeatureAttributes(), mAttributeMaps, and mMaxColumnWidthMap.

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 232 of file qgscomposertable.cpp.

References mColumns.

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 184 of file qgscomposertable.cpp.

References adjustFrameToSize(), and mContentFont.

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 150 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 198 of file qgscomposertable.cpp.

References adjustFrameToSize(), and mGridStrokeWidth.

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 171 of file qgscomposertable.cpp.

References adjustFrameToSize(), and mHeaderFont.

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 178 of file qgscomposertable.cpp.

References mHeaderHAlignment, and QgsComposerItem::repaint().

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 164 of file qgscomposertable.cpp.

References adjustFrameToSize(), and mLineTextDistance.

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 191 of file qgscomposertable.cpp.

References adjustFrameToSize(), and mShowGrid.

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 126 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 267 of file qgscomposertable.cpp.

References QgsComposerItem::_readXML(), mColumns, mContentFont, mGridColor, mGridStrokeWidth, mHeaderFont, mHeaderHAlignment, mLineTextDistance, mShowGrid, and QgsComposerTableColumn::readXML().

Referenced by QgsComposerTextTable::readXML(), and QgsComposerAttributeTable::readXML().

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 241 of file qgscomposertable.cpp.

References QgsComposerItem::_writeXML(), mColumns, mContentFont, mGridColor, mGridStrokeWidth, mHeaderFont, mHeaderHAlignment, mLineTextDistance, and mShowGrid.

Referenced by QgsComposerAttributeTable::writeXML().

virtual int QgsComposerTable::type ( ) const

inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 50 of file qgscomposertable.h.

References QgsComposerItem::ComposerTable.

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

pure virtual

stores state in Dom element

Parameters

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

Implements QgsComposerItem.

Implemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Member Data Documentation

QList<QgsAttributeMap> QgsComposerTable::mAttributeMaps

protected

Definition at line 224 of file qgscomposertable.h.

Referenced by adjustFrameToSize(), paint(), and refreshAttributes().

QFont QgsComposerTable::mContentFont

protected

Definition at line 216 of file qgscomposertable.h.

Referenced by adaptItemFrame(), calculateMaxColumnWidths(), drawHorizontalGridLines(), paint(), QgsComposerTable(), setContentFont(), QgsComposerAttributeTable::setSceneRect(), tableReadXML(), and tableWriteXML().

QColor QgsComposerTable::mGridColor

protected

Definition at line 222 of file qgscomposertable.h.

Referenced by paint(), tableReadXML(), and tableWriteXML().

double QgsComposerTable::mGridStrokeWidth

protected

Definition at line 221 of file qgscomposertable.h.

Referenced by adaptItemFrame(), drawHorizontalGridLines(), drawVerticalGridLines(), paint(), setGridStrokeWidth(), QgsComposerAttributeTable::setSceneRect(), tableReadXML(), and tableWriteXML().

QFont QgsComposerTable::mHeaderFont

protected

Definition at line 215 of file qgscomposertable.h.

Referenced by adaptItemFrame(), calculateMaxColumnWidths(), drawHorizontalGridLines(), paint(), QgsComposerTable(), setHeaderFont(), QgsComposerAttributeTable::setSceneRect(), tableReadXML(), and tableWriteXML().

HeaderHAlignment QgsComposerTable::mHeaderHAlignment

protected

Definition at line 218 of file qgscomposertable.h.

Referenced by paint(), setHeaderHAlignment(), tableReadXML(), and tableWriteXML().

double QgsComposerTable::mLineTextDistance

protected

Distance between table lines and text.

Definition at line 213 of file qgscomposertable.h.

Referenced by adaptItemFrame(), drawHorizontalGridLines(), drawVerticalGridLines(), paint(), setLineTextDistance(), QgsComposerAttributeTable::setSceneRect(), tableReadXML(), and tableWriteXML().

QMap<int, double> QgsComposerTable::mMaxColumnWidthMap

protected

Definition at line 225 of file qgscomposertable.h.

Referenced by adjustFrameToSize(), paint(), and refreshAttributes().

bool QgsComposerTable::mShowGrid

protected

Definition at line 220 of file qgscomposertable.h.

Referenced by paint(), setShowGrid(), tableReadXML(), and tableWriteXML().

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

/tmp/buildd/qgis-2.4.0+unstable1/src/core/composer/qgscomposertable.h
/tmp/buildd/qgis-2.4.0+unstable1/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