QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Signals | Public Member Functions | Protected Member Functions | Private Slots | Private Member Functions | Private Attributes | List of all members
QgsComposerAttributeTable Class Reference

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

#include <qgscomposerattributetable.h>

Inheritance diagram for QgsComposerAttributeTable:
Inheritance graph
[legend]
Collaboration diagram for QgsComposerAttributeTable:
Collaboration graph
[legend]

Signals

void maximumNumberOfFeaturesChanged (int n)
 This signal is emitted if the maximum number of feature changes (interactively) More...
 
- Signals inherited from QgsComposerItem
void itemRotationChanged (double newRotation)
 Is emitted on item rotation change. More...
 
void itemChanged ()
 Used e.g. More...
 
void sizeChanged ()
 Emitted if the rectangle changes. More...
 
void frameChanged ()
 Emitted if the item's frame style changes. More...
 

Public Member Functions

 QgsComposerAttributeTable (QgsComposition *composition)
 
 ~QgsComposerAttributeTable ()
 
virtual int type () const
 return correct graphics item type. More...
 
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint. More...
 
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom element More...
 
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document More...
 
void setVectorLayer (QgsVectorLayer *layer)
 Sets the vector layer from which to display feature attributes. More...
 
QgsVectorLayervectorLayer () const
 
void setComposerMap (const QgsComposerMap *map)
 Sets the composer map to use to limit the extent of features shown in the attribute table. More...
 
const QgsComposerMapcomposerMap () const
 
void setMaximumNumberOfFeatures (int features)
 Sets the maximum number of features shown by the table. More...
 
int maximumNumberOfFeatures () const
 
void setDisplayOnlyVisibleFeatures (bool visibleOnly)
 Sets attribute table to only show features which are visible in a composer map item. More...
 
bool displayOnlyVisibleFeatures () const
 
bool filterFeatures () const
 
void setFilterFeatures (bool filter)
 Sets whether the feature filter is active for the attribute table. More...
 
QString featureFilter () const
 
void setFeatureFilter (const QString &expression)
 Sets the expression used for filtering features in the table. More...
 
QSet< int > displayAttributes () const
 
void setDisplayAttributes (const QSet< int > &attr, bool refresh=true)
 Sets the attributes to display in the table. More...
 
QMap< int, QString > fieldAliasMap () const
 
void setFieldAliasMap (const QMap< int, QString > &map, bool refresh=true)
 Sets the attribute field aliases, which control how fields are named in the table's header row. More...
 
void setSceneRect (const QRectF &rectangle)
 Adapts mMaximumNumberOfFeatures depending on the rectangle height. More...
 
void setSortAttributes (const QList< QPair< int, bool > > att, bool refresh=true)
 Sets the attributes to use to sort the table's features. More...
 
QList< QPair< int, bool > > sortAttributes () const
 
- Public Member Functions inherited from QgsComposerTable
 QgsComposerTable (QgsComposition *composition)
 
virtual ~QgsComposerTable ()
 
void setLineTextDistance (double d)
 
double lineTextDistance () const
 
void setHeaderFont (const QFont &f)
 
QFont headerFont () const
 
void setContentFont (const QFont &f)
 
QFont contentFont () const
 
void setShowGrid (bool show)
 
bool showGrid () const
 
void setGridStrokeWidth (double w)
 
double gridStrokeWidth () const
 
void setGridColor (const QColor &c)
 
QColor gridColor () const
 
- 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...
 
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft)
 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)
 Sets item position and width / height in one go. More...
 
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode. More...
 
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document. More...
 
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document. More...
 
bool hasFrame () const
 Whether this item has a frame or not. More...
 
void setFrameEnabled (bool drawFrame)
 Set whether this item has a frame drawn around it or not. More...
 
virtual void setFrameOutlineWidth (double outlineWidth)
 Sets frame outline width. More...
 
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 QgsCompositioncomposition () const
 
QgsCompositioncomposition ()
 
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) 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 ascent 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...
 
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

bool getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps)
 Retrieves feature attributes. More...
 
QMap< int, QString > getHeaderLabels () const
 
- Protected Member Functions inherited from QgsComposerTable
virtual bool calculateMaxColumnWidths (QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps) const
 Calculate the maximum width values of the vector attributes. More...
 
void adaptItemFrame (const QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps)
 Adapts the size of the item frame to match the content. More...
 
void drawHorizontalGridLines (QPainter *p, int nAttributes)
 
void drawVerticalGridLines (QPainter *p, const QMap< int, double > &maxWidthMap)
 
bool tableWriteXML (QDomElement &itemElem, QDomDocument &doc) const
 
bool tableReadXML (const QDomElement &itemElem, const QDomDocument &doc)
 
- 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...
 
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...
 
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...
 
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 ()
 

Private Slots

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

Private Member Functions

void initializeAliasMap ()
 Inserts aliases from vector layer as starting configuration to the alias map. More...
 
QString attributeDisplayName (int attributeIndex, const QString &name) const
 Returns the attribute name to display in the table's header row for a specified attribute. More...
 

Private Attributes

QgsVectorLayermVectorLayer
 Associated vector layer. More...
 
const QgsComposerMapmComposerMap
 Associated composer map (used to display the visible features) More...
 
int mMaximumNumberOfFeatures
 Maximum number of features that is displayed. More...
 
bool mShowOnlyVisibleFeatures
 Shows only the features that are visible in the associated composer map (true by default) More...
 
bool mFilterFeatures
 
QString mFeatureFilter
 
QSet< int > mDisplayAttributes
 List of attribute indices to display (or all attributes if list is empty) More...
 
QMap< int, QString > mFieldAliasMap
 Map of attribute name aliases. More...
 
QList< QPair< int, bool > > mSortInformation
 Contains information about sort attribute index / ascending (true/false). More...
 

Additional Inherited Members

- Public Types inherited from QgsComposerItem
enum  ItemType {
  ComposerItem = UserType + 100, ComposerArrow, ComposerItemGroup, ComposerLabel,
  ComposerLegend, ComposerMap, ComposerPaper, ComposerPicture,
  ComposerScaleBar, ComposerShape, ComposerTable, ComposerAttributeTable,
  ComposerTextTable, ComposerFrame
}
 
enum  MouseMoveAction {
  MoveItem, ResizeUp, ResizeDown, ResizeLeft,
  ResizeRight, ResizeLeftUp, ResizeRightUp, ResizeLeftDown,
  ResizeRightDown, NoAction
}
 Describes the action (move or resize in different directon) to be done during mouse move. More...
 
enum  ItemPositionMode {
  UpperLeft, UpperMiddle, UpperRight, MiddleLeft,
  Middle, MiddleRight, LowerLeft, LowerMiddle,
  LowerRight
}
 
- Public Slots inherited from QgsComposerTable
virtual void refreshAttributes ()
 Refreshes the attributes shown in the table by querying the vector layer for new data. More...
 
virtual void adjustFrameToSize ()
 Adapts the size of the frame to match the content. More...
 
- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
 Sets the item rotation. More...
 
virtual void setItemRotation (double r, bool adjustPosition=false)
 Sets the item rotation. More...
 
void repaint ()
 
- Protected Attributes inherited from QgsComposerTable
double mLineTextDistance
 Distance between table lines and text. More...
 
QFont mHeaderFont
 
QFont mContentFont
 
bool mShowGrid
 
double mGridStrokeWidth
 
QColor mGridColor
 
QList< QgsAttributeMapmAttributeMaps
 
QMap< int, double > mMaxColumnWidthMap
 
- Protected Attributes inherited from QgsComposerItem
QgsCompositionmComposition
 
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
 
QgsComposerEffectmEffect
 
int mTransparency
 Item transparency. More...
 
ItemPositionMode mLastUsedPositionMode
 The item's position mode. More...
 
int mCurrentExportLayer
 The layer that needs to be exported. More...
 

Detailed Description

A table class that displays a vector attribute table.

Definition at line 40 of file qgscomposerattributetable.h.

Constructor & Destructor Documentation

QgsComposerAttributeTable::QgsComposerAttributeTable ( QgsComposition composition)
QgsComposerAttributeTable::~QgsComposerAttributeTable ( )

Definition at line 71 of file qgscomposerattributetable.cpp.

Member Function Documentation

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

Returns the attribute name to display in the table's header row for a specified attribute.

Parameters
attributeIndexattribute index
namedefault name to use for the attribute
Returns
the aliases for the attribute if set. If an alias is not set then the default name will be returned.
See Also
setFieldAliasMap

Definition at line 318 of file qgscomposerattributetable.cpp.

References mFieldAliasMap.

Referenced by getHeaderLabels().

const QgsComposerMap* QgsComposerAttributeTable::composerMap ( ) const
inline

Definition at line 87 of file qgscomposerattributetable.h.

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

Definition at line 162 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::displayOnlyVisibleFeatures ( ) const
inline

Definition at line 120 of file qgscomposerattributetable.h.

QString QgsComposerAttributeTable::featureFilter ( ) const
inline

Definition at line 146 of file qgscomposerattributetable.h.

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

Definition at line 177 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::filterFeatures ( ) const
inline

Definition at line 128 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::getFeatureAttributes ( QList< QgsAttributeMap > &  attributeMaps)
protectedvirtual
QMap< int, QString > QgsComposerAttributeTable::getHeaderLabels ( ) const
protectedvirtual
Note
not available in python bindings

Reimplemented from QgsComposerTable.

Definition at line 300 of file qgscomposerattributetable.cpp.

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

void QgsComposerAttributeTable::initializeAliasMap ( )
private

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

Definition at line 84 of file qgscomposerattributetable.cpp.

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

Referenced by setVectorLayer().

int QgsComposerAttributeTable::maximumNumberOfFeatures ( ) const
inline

Definition at line 102 of file qgscomposerattributetable.h.

void QgsComposerAttributeTable::maximumNumberOfFeaturesChanged ( int  n)
signal

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

Referenced by setSceneRect().

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

Reimplementation of QCanvasItem::paint.

Reimplemented from QgsComposerTable.

Definition at line 75 of file qgscomposerattributetable.cpp.

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

bool QgsComposerAttributeTable::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
)
virtual
void QgsComposerAttributeTable::removeLayer ( QString  layerId)
privateslot

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

Definition at line 323 of file qgscomposerattributetable.cpp.

References QgsMapLayer::id(), and mVectorLayer.

Referenced by QgsComposerAttributeTable().

void QgsComposerAttributeTable::setComposerMap ( const QgsComposerMap map)

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

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

Parameters
mapQgsComposerMap which drives the extents of the table's features
Note
added in 2.3
See Also
composerMap
setDisplayOnlyVisibleFeatures

Definition at line 124 of file qgscomposerattributetable.cpp.

References mComposerMap, and QgsComposerTable::refreshAttributes().

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

Sets the attributes to display in the table.

Parameters
attrQSet of integer values refering to the attributes from the vector layer to show
refreshset to true to force the table to refetch features from its vector layer and immediately update the display of the table. This may result in the table changing size to accomodate the new displayed feature attributes.
See Also
displayAttributes

Definition at line 189 of file qgscomposerattributetable.cpp.

References mDisplayAttributes, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setDisplayOnlyVisibleFeatures ( bool  visibleOnly)

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

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

Parameters
visibleOnlyset to true to show only visible features
Note
added in 2.3
See Also
displayOnlyVisibleFeatures
setComposerMap

Definition at line 156 of file qgscomposerattributetable.cpp.

References mShowOnlyVisibleFeatures, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setFeatureFilter ( const QString &  expression)

Sets the expression used for filtering features in the table.

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

Parameters
expressionfilter to use for selecting which features to display in the table
Note
added in 2.3
See Also
featureFilter
setFilterFeatures

Definition at line 178 of file qgscomposerattributetable.cpp.

References mFeatureFilter, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setFieldAliasMap ( const QMap< int, QString > &  map,
bool  refresh = true 
)

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

Parameters
mapQMap of integers to strings, where the string is the alias to use for the corresponding field.
refreshset to true to force the table to refetch features from its vector layer and immediately update the display of the table. This may result in the table changing size to accomodate the new displayed feature attributes and field aliases.
See Also
fieldAliasMap

Definition at line 199 of file qgscomposerattributetable.cpp.

References mFieldAliasMap, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setFilterFeatures ( bool  filter)

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

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

Parameters
filterSet to true to enable the feature filter
Note
added in 2.3
See Also
filterFeatures
setFeatureFilter

Definition at line 167 of file qgscomposerattributetable.cpp.

References mFilterFeatures, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setMaximumNumberOfFeatures ( int  features)

Sets the maximum number of features shown by the table.

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

Parameters
featuresmaximum number of features to show in the table
Note
added in 2.3
See Also
maximumNumberOfFeatures

Definition at line 145 of file qgscomposerattributetable.cpp.

References mMaximumNumberOfFeatures, and QgsComposerTable::refreshAttributes().

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

Adapts mMaximumNumberOfFeatures depending on the rectangle height.

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

See Also
maximumNumberOfFeatures
setMaximumNumberOfFeatures

Reimplemented from QgsComposerItem.

Definition at line 334 of file qgscomposerattributetable.cpp.

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

Referenced by QgsComposerView::mousePressEvent().

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

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

Parameters
attQList integers/bool pairs, where the integer refers to the attribute index and the bool sets the sort order for the attribute. If true the attribute is sorted ascending, if false, the attribute is sorted in descending order. Note that features are sorted after the maximum number of displayed features have been fetched from the vector layer's provider.
refreshset to true to force the table to refetch features from its vector layer and immediately update the display of the table. This may result in the table changing size to accomodate the new displayed feature attributes and field aliases.l
See Also
sortAttributes
Note
not available in python bindings

Definition at line 354 of file qgscomposerattributetable.cpp.

References mSortInformation, and QgsComposerTable::refreshAttributes().

void QgsComposerAttributeTable::setVectorLayer ( QgsVectorLayer layer)

Sets the vector layer from which to display feature attributes.

Parameters
layerVector layer for attribute table
Note
added in 2.3
See Also
vectorLayer

Definition at line 101 of file qgscomposerattributetable.cpp.

References initializeAliasMap(), mDisplayAttributes, mVectorLayer, and QgsComposerTable::refreshAttributes().

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

Definition at line 219 of file qgscomposerattributetable.h.

virtual int QgsComposerAttributeTable::type ( ) const
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerTable.

Definition at line 48 of file qgscomposerattributetable.h.

References QgsComposerItem::ComposerAttributeTable.

QgsVectorLayer* QgsComposerAttributeTable::vectorLayer ( ) const
inline

Definition at line 67 of file qgscomposerattributetable.h.

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

stores state in Dom element

Parameters
elemis Dom element corresponding to 'Composer' tag
docis the Dom document

Implements QgsComposerTable.

Definition at line 364 of file qgscomposerattributetable.cpp.

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

Member Data Documentation

const QgsComposerMap* QgsComposerAttributeTable::mComposerMap
private

Associated composer map (used to display the visible features)

Definition at line 234 of file qgscomposerattributetable.h.

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

QSet<int> QgsComposerAttributeTable::mDisplayAttributes
private

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

Definition at line 247 of file qgscomposerattributetable.h.

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

QString QgsComposerAttributeTable::mFeatureFilter
private
QMap<int, QString> QgsComposerAttributeTable::mFieldAliasMap
private

Map of attribute name aliases.

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

Definition at line 249 of file qgscomposerattributetable.h.

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

bool QgsComposerAttributeTable::mFilterFeatures
private
int QgsComposerAttributeTable::mMaximumNumberOfFeatures
private

Maximum number of features that is displayed.

Definition at line 236 of file qgscomposerattributetable.h.

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

bool QgsComposerAttributeTable::mShowOnlyVisibleFeatures
private

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

Definition at line 239 of file qgscomposerattributetable.h.

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

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

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

First entry has the highest priority

Definition at line 252 of file qgscomposerattributetable.h.

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

QgsVectorLayer* QgsComposerAttributeTable::mVectorLayer
private

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