QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Slots | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsComposerTable Class Referenceabstract

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

#include <qgscomposertable.h>

Inheritance diagram for QgsComposerTable:
Inheritance graph
[legend]

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
}
 
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 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 (const double r, const bool adjustPosition=false)
 Sets the item rotation. More...
 
void repaint ()
 
virtual void refreshDataDefinedProperty (const QgsComposerObject::DataDefinedProperty property=QgsComposerObject::AllProperties)
 Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More...
 
- Public Slots inherited from QgsComposerObject
virtual void repaint ()
 Triggers a redraw for the item. More...
 
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. More...
 

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 item state in DOM element. More...
 
virtual bool readXML (const QDomElement &itemElem, const QDomDocument &doc)=0
 Sets item state from DOM element. 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 setHeaderFontColor (const QColor &color)
 Sets the color used to draw header text in the table. More...
 
QColor headerFontColor () const
 Returns the color 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 setContentFontColor (const QColor &color)
 Sets the color used to draw text in table body cells. More...
 
QColor contentFontColor () const
 Returns the color 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 bool isRemoved () const
 Returns whether this item has been removed from the composition. More...
 
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition. More...
 
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted. More...
 
virtual bool selected () const
 Is selected. 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 Q_DECL_DEPRECATED void zoomContent (int delta, double x, double y)
 Zoom content of item. More...
 
virtual void zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom)
 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 (const bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
virtual void setFrameOutlineColor (const QColor &color)
 Sets frame outline color. More...
 
QColor frameOutlineColor () const
 Returns the frame's outline color. More...
 
virtual void setFrameOutlineWidth (const 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 (const 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 (const 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 (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode. More...
 
int transparency () const
 Returns the item's transparency. More...
 
void setTransparency (const int transparency)
 Sets the item's transparency. More...
 
bool effectsEnabled () const
 Returns whether effects (eg blend modes) are enabled for the item. More...
 
void setEffectsEnabled (const 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 ()
 
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 ()
 
Q_DECL_DEPRECATED void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const
 Draws Text. More...
 
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. More...
 
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. More...
 
Q_DECL_DEPRECATED double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters. More...
 
Q_DECL_DEPRECATED double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontDescentMillimeters (const QFont &font) const
 Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double fontHeightMillimeters (const QFont &font) const
 Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More...
 
Q_DECL_DEPRECATED double pixelFontSize (double pointSize) const
 Calculates font size in mm from a font point size. More...
 
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. More...
 
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags. More...
 
bool positionLock () const
 Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. More...
 
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current 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 QString displayName () const
 Get item display name. More...
 
virtual void setVisibility (const bool visible)
 Sets visibility for item. More...
 
bool excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue)
 Returns whether the item should be excluded from composer exports and prints. More...
 
virtual void setExcludeFromExports (const bool exclude)
 Sets whether the item should be excluded from composer exports and prints. More...
 
bool isGroupMember () const
 Returns whether this item is part of a group. More...
 
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group. More...
 
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers. More...
 
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting. More...
 
- Public Member Functions inherited from QgsComposerObject
 QgsComposerObject (QgsComposition *composition)
 Constructor. More...
 
virtual ~QgsComposerObject ()
 
const QgsCompositioncomposition () const
 Returns the composition the item is attached to. More...
 
QgsCompositioncomposition ()
 
QgsDataDefineddataDefinedProperty (const DataDefinedProperty property) const
 Returns a reference to the data defined settings for one of the item's data defined properties. More...
 
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. 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)
 Draws additional graphics on selected items. More...
 
virtual void drawFrame (QPainter *p)
 Draw black frame around item. More...
 
virtual void drawBackground (QPainter *p)
 Draw background. More...
 
Q_DECL_DEPRECATED void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead. More...
 
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) 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...
 
Q_DECL_DEPRECATED 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...
 
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. 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...
 
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. More...
 
Q_DECL_DEPRECATED 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...
 
Q_DECL_DEPRECATED 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...
 
Q_DECL_DEPRECATED 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 ()
 
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. More...
 
bool shouldDrawItem () const
 Returns whether the item should be drawn in the current context. More...
 
- Protected Member Functions inherited from QgsComposerObject
bool dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue)
 Evaluate a data defined property and return the calculated value. More...
 

Protected Attributes

double mLineTextDistance
 Distance between table lines and text. More...
 
QFont mHeaderFont
 
QColor mHeaderFontColor
 
QFont mContentFont
 
QColor mContentFontColor
 
HeaderHAlignment mHeaderHAlignment
 
bool mShowGrid
 
double mGridStrokeWidth
 
QColor mGridColor
 
QList< QgsAttributeMapmAttributeMaps
 
QMap< int, double > mMaxColumnWidthMap
 
QList< QgsComposerTableColumn * > mColumns
 
- Protected Attributes inherited from QgsComposerItem
bool mRemovedFromComposition
 True if item has been removed from the composition. More...
 
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...
 
double mEvaluatedItemRotation
 Temporary evaluated item rotation in degrees, clockwise. More...
 
QPainter::CompositionMode mBlendMode
 Composition blend mode for item. More...
 
bool mEffectsEnabled
 
QgsComposerEffectmEffect
 
int mTransparency
 Item transparency. More...
 
bool mExcludeFromExports
 Whether item should be excluded in exports. More...
 
bool mEvaluatedExcludeFromExports
 Temporary evaluated item exclusion. More...
 
ItemPositionMode mLastUsedPositionMode
 The item's position mode. More...
 
bool mIsGroupMember
 Whether or not this item is part of a group. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 
- Protected Attributes inherited from QgsComposerObject
QgsCompositionmComposition
 
QMap
< QgsComposerObject::DataDefinedProperty,
QString > 
mDataDefinedNames
 Map of data defined properties for the item to string name to use when exporting item to xml. More...
 

Additional Inherited Members

- Signals inherited from QgsComposerItem
void itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 
void lockChanged ()
 Emitted if the item's lock status changes. More...
 
- Signals inherited from QgsComposerObject
void itemChanged ()
 Emitted when the item changes. More...
 

Detailed Description

A class to display feature attributes in the print composer.

Member Enumeration Documentation

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

Constructor & Destructor Documentation

QgsComposerTable::QgsComposerTable ( QgsComposition composition)
QgsComposerTable::~QgsComposerTable ( )
virtual

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
maxWidthMapQMap of int to double, where the int contains the column number and the double is the maximum width of text present in the column.
attributeMapslist of attribute values for each row shown in the table
Note
not available in python bindings
See also
calculateMaxColumnWidths
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
bool QgsComposerTable::calculateMaxColumnWidths ( QMap< int, double > &  maxWidthMap,
const QList< QgsAttributeMap > &  attributeMaps 
) const
protectedvirtual

Calculates the maximum width of text shown in columns.

Parameters
maxWidthMapQMap 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.
attributeMapslist of attribute values for each row shown in the table
Note
not available in python bindings
See also
adaptItemFrame
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
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
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
void QgsComposerTable::drawHorizontalGridLines ( QPainter *  p,
int  nAttributes 
)
protected

Draws the horizontal grid lines for the table.

Parameters
pdestination painter for grid lines
nAttributesnumber of attribute rows shown in table
See also
drawVerticalGridLines
void QgsComposerTable::drawVerticalGridLines ( QPainter *  p,
const QMap< int, double > &  maxWidthMap 
)
protected

Draws the vertical grid lines for the table.

Parameters
pdestination painter for grid lines
maxWidthMapQMap 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
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
attributeMapsQList of QgsAttributeMap to store retrieved row data in
Note
not available in python bindings

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

QColor QgsComposerTable::gridColor ( ) const
inline

Returns the color used for grid lines in the table.

Returns
grid line color
See also
setGridColor
showGrid
gridStrokeWidth
double QgsComposerTable::gridStrokeWidth ( ) const
inline

Returns the width of grid lines in the table.

Returns
grid line width
See also
setGridStrokeWidth
showGrid
gridColor
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
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
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
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
double QgsComposerTable::lineTextDistance ( ) const
inline

Returns the margin distance between cell borders and their contents.

Returns
margin for cell contents
See also
setLineTextDistance
void QgsComposerTable::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
)
virtual

Reimplementation of QCanvasItem::paint.

Reimplemented in QgsComposerAttributeTable.

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

Sets item state from DOM element.

Parameters
itemElemis DOM node corresponding to item tag
docis 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
void QgsComposerTable::setColumns ( QList< QgsComposerTableColumn * >  columns)

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

Parameters
columnslist of QgsComposerTableColumns to show in table
Note
added in 2.3
See also
columns
void QgsComposerTable::setContentFont ( const QFont &  f)

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

Parameters
ffont for table cells
See also
contentFont
setHeaderFont
void QgsComposerTable::setContentFontColor ( const QColor &  color)

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

Parameters
colortable cell text color
See also
contentFontColor
setContentFont
setHeaderFontColor
Note
added in 2.5
void QgsComposerTable::setGridColor ( const QColor &  c)
inline

Sets color used for grid lines in the table.

Parameters
cgrid line color
See also
gridColor
setShowGrid
setGridStrokeWidth
void QgsComposerTable::setGridStrokeWidth ( double  w)

Sets the width for grid lines in the table.

Parameters
wgrid line width
See also
gridStrokeWidth
setShowGrid
setGridColor
void QgsComposerTable::setHeaderFont ( const QFont &  f)

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

Parameters
ffont for header cells
See also
headerFont
setContentFont
void QgsComposerTable::setHeaderFontColor ( const QColor &  color)

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

Parameters
colorheader text color
See also
headerFontColor
setHeaderFont
setContentFontColor
Note
added in 2.5
void QgsComposerTable::setHeaderHAlignment ( const HeaderHAlignment  alignment)

Sets the horizontal alignment for table headers.

Parameters
alignmentHorizontal alignment for table header cells
Note
added in 2.3
See also
headerHAlignment
void QgsComposerTable::setLineTextDistance ( double  d)

Sets the margin distance between cell borders and their contents.

Parameters
dmargin for cell contents
See also
lineTextDistance
void QgsComposerTable::setShowGrid ( bool  show)

Sets whether grid lines should be drawn in the table.

Parameters
showset to true to show grid lines
See also
showGrid
setGridStrokeWidth
setGridColor
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
bool QgsComposerTable::tableReadXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
protected

Reads the table's common properties from xml.

Parameters
itemElema QDomElement holding the table's desired properties.
docQDomDocument for the source xml.
See also
tableWriteXML
readXML
bool QgsComposerTable::tableWriteXML ( QDomElement &  itemElem,
QDomDocument &  doc 
) const
protected

Writes common table properties to xml for storage.

Parameters
itemEleman existing QDomElement in which to store the table's properties.
docQDomDocument for the destination xml.
See also
tableReadXML
writeXML
virtual int QgsComposerTable::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

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

Stores item state in DOM element.

Parameters
elemis DOM element corresponding to item tag
docis the DOM document

Reimplemented from QgsComposerObject.

Implemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Member Data Documentation

QList<QgsAttributeMap> QgsComposerTable::mAttributeMaps
protected
QList<QgsComposerTableColumn*> QgsComposerTable::mColumns
protected
QFont QgsComposerTable::mContentFont
protected
QColor QgsComposerTable::mContentFontColor
protected
QColor QgsComposerTable::mGridColor
protected
double QgsComposerTable::mGridStrokeWidth
protected
QFont QgsComposerTable::mHeaderFont
protected
QColor QgsComposerTable::mHeaderFontColor
protected
HeaderHAlignment QgsComposerTable::mHeaderHAlignment
protected
double QgsComposerTable::mLineTextDistance
protected

Distance between table lines and text.

QMap<int, double> QgsComposerTable::mMaxColumnWidthMap
protected
bool QgsComposerTable::mShowGrid
protected

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