Quantum GIS API Documentation  1.7.4
Signals | Public Member Functions | Protected Member Functions | Private Slots | Private Member Functions | Private Attributes
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]

List of all members.

Signals

void maximumNumerOfFeaturesChanged (int n)
 This signal is emitted if the maximum number of feature changes (interactively)

Public Member Functions

 QgsComposerAttributeTable (QgsComposition *composition)
 ~QgsComposerAttributeTable ()
virtual int type () const
 return correct graphics item type.
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint.
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 stores state in Dom element
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 sets state from Dom document
void setVectorLayer (QgsVectorLayer *vl)
const QgsVectorLayervectorLayer () const
void setComposerMap (const QgsComposerMap *map)
const QgsComposerMapcomposerMap () const
void setMaximumNumberOfFeatures (int nr)
int maximumNumberOfFeatures () const
void setDisplayOnlyVisibleFeatures (bool b)
bool displayOnlyVisibleFeatures () const
QSet< int > displayAttributes () const
void setDisplayAttributes (const QSet< int > &attr)
QMap< int, QString > fieldAliasMap () const
void setFieldAliasMap (const QMap< int, QString > &map)
void setSceneRect (const QRectF &rectangle)
 Adapts mMaximumNumberOfFeatures depending on the rectangle height.
void setSortAttributes (const QList< QPair< int, bool > > att)
QList< QPair< int, bool > > sortAttributes () const

Protected Member Functions

bool getFeatureAttributes (QList< QgsAttributeMap > &attributes)
 Retrieves feature attributes.
QMap< int, QString > getHeaderLabels () const

Private Slots

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

Private Member Functions

void initializeAliasMap ()
 Inserts aliases from vector layer as starting configuration to the alias map.
QString attributeDisplayName (int attributeIndex, const QString &name) const
 Returns the attribute name to display in the item (attribute name or an alias if present)

Private Attributes

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

Detailed Description

A table class that displays a vector attribute table.

Definition at line 40 of file qgscomposerattributetable.h.


Constructor & Destructor Documentation

Definition at line 64 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 item (attribute name or an alias if present)

Definition at line 179 of file qgscomposerattributetable.cpp.

References mFieldAliasMap.

Referenced by getHeaderLabels().

Definition at line 60 of file qgscomposerattributetable.h.

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

Definition at line 68 of file qgscomposerattributetable.h.

Definition at line 66 of file qgscomposerattributetable.h.

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

Definition at line 71 of file qgscomposerattributetable.h.

bool QgsComposerAttributeTable::getFeatureAttributes ( QList< QgsAttributeMap > &  attributes) [protected, virtual]
QMap< int, QString > QgsComposerAttributeTable::getHeaderLabels ( ) const [protected, virtual]

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

Definition at line 78 of file qgscomposerattributetable.cpp.

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

Referenced by setVectorLayer().

Definition at line 63 of file qgscomposerattributetable.h.

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 69 of file qgscomposerattributetable.cpp.

References QgsComposerMap::isDrawing(), and mComposerMap.

bool QgsComposerAttributeTable::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
) [virtual]
void QgsComposerAttributeTable::removeLayer ( QString  layerId) [private, slot]

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

Definition at line 192 of file qgscomposerattributetable.cpp.

References QgsMapLayer::id(), and mVectorLayer.

Referenced by QgsComposerAttributeTable().

Definition at line 106 of file qgscomposerattributetable.cpp.

References mComposerMap, and QgsComposerItem::repaint().

void QgsComposerAttributeTable::setDisplayAttributes ( const QSet< int > &  attr) [inline]

Definition at line 69 of file qgscomposerattributetable.h.

Definition at line 65 of file qgscomposerattributetable.h.

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

Definition at line 72 of file qgscomposerattributetable.h.

Definition at line 62 of file qgscomposerattributetable.h.

void QgsComposerAttributeTable::setSceneRect ( const QRectF &  rectangle) [virtual]
void QgsComposerAttributeTable::setSortAttributes ( const QList< QPair< int, bool > >  att) [inline]

Definition at line 77 of file qgscomposerattributetable.h.

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

Definition at line 78 of file qgscomposerattributetable.h.

virtual int QgsComposerAttributeTable::type ( ) const [inline, virtual]

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerTable.

Definition at line 48 of file qgscomposerattributetable.h.

References QgsComposerItem::ComposerAttributeTable.

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

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


Member Data Documentation

Associated composer map (used to display the visible features)

Definition at line 89 of file qgscomposerattributetable.h.

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

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

Definition at line 97 of file qgscomposerattributetable.h.

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

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 99 of file qgscomposerattributetable.h.

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

Maximum number of features that is displayed.

Definition at line 91 of file qgscomposerattributetable.h.

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

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

Definition at line 94 of file qgscomposerattributetable.h.

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

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


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines