Quantum GIS API Documentation
1.7.4
|
A table class that displays a vector attribute table. More...
#include <qgscomposerattributetable.h>
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 QgsVectorLayer * | vectorLayer () const |
void | setComposerMap (const QgsComposerMap *map) |
const QgsComposerMap * | composerMap () 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 | |
QgsVectorLayer * | mVectorLayer |
Associated vector layer. | |
const QgsComposerMap * | mComposerMap |
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). |
A table class that displays a vector attribute table.
Definition at line 40 of file qgscomposerattributetable.h.
QgsComposerAttributeTable::QgsComposerAttributeTable | ( | QgsComposition * | composition | ) |
Definition at line 46 of file qgscomposerattributetable.cpp.
References QgsMapLayerRegistry::instance(), QgsMapLayerRegistry::mapLayers(), mVectorLayer, and removeLayer().
Definition at line 64 of file qgscomposerattributetable.cpp.
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().
const QgsComposerMap* QgsComposerAttributeTable::composerMap | ( | ) | const [inline] |
Definition at line 60 of file qgscomposerattributetable.h.
QSet<int> QgsComposerAttributeTable::displayAttributes | ( | ) | const [inline] |
Definition at line 68 of file qgscomposerattributetable.h.
bool QgsComposerAttributeTable::displayOnlyVisibleFeatures | ( | ) | const [inline] |
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] |
Retrieves feature attributes.
Reimplemented from QgsComposerTable.
Definition at line 119 of file qgscomposerattributetable.cpp.
References QgsFeature::attributeMap(), QgsComposerMap::extent(), mComposerMap, mDisplayAttributes, mMaximumNumberOfFeatures, mShowOnlyVisibleFeatures, mSortInformation, mVectorLayer, QgsVectorLayer::nextFeature(), QgsVectorLayer::pendingAllAttributesList(), QgsVectorLayer::select(), QgsComposerAttributeTableCompare::setAscending(), and QgsComposerAttributeTableCompare::setSortColumn().
QMap< int, QString > QgsComposerAttributeTable::getHeaderLabels | ( | ) | const [protected, virtual] |
Reimplemented from QgsComposerTable.
Definition at line 160 of file qgscomposerattributetable.cpp.
References attributeDisplayName(), mDisplayAttributes, mVectorLayer, and QgsVectorLayer::pendingFields().
void QgsComposerAttributeTable::initializeAliasMap | ( | ) | [private] |
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().
int QgsComposerAttributeTable::maximumNumberOfFeatures | ( | ) | const [inline] |
Definition at line 63 of file qgscomposerattributetable.h.
void QgsComposerAttributeTable::maximumNumerOfFeaturesChanged | ( | 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 69 of file qgscomposerattributetable.cpp.
References QgsComposerMap::isDrawing(), and mComposerMap.
bool QgsComposerAttributeTable::readXML | ( | const QDomElement & | itemElem, |
const QDomDocument & | doc | ||
) | [virtual] |
sets state from Dom document
itemElem | is Dom node corresponding to item tag |
doc | is Dom document |
Implements QgsComposerTable.
Definition at line 276 of file qgscomposerattributetable.cpp.
References QgsComposerItem::composition(), QgsComposition::getComposerMapById(), QgsMapLayerRegistry::instance(), QgsComposerItem::itemChanged(), QgsMapLayerRegistry::mapLayer(), mComposerMap, mDisplayAttributes, mFieldAliasMap, mMaximumNumberOfFeatures, mShowOnlyVisibleFeatures, mSortInformation, mVectorLayer, and QgsComposerTable::tableReadXML().
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().
void QgsComposerAttributeTable::setComposerMap | ( | const QgsComposerMap * | map | ) |
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.
void QgsComposerAttributeTable::setDisplayOnlyVisibleFeatures | ( | bool | b | ) | [inline] |
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.
void QgsComposerAttributeTable::setMaximumNumberOfFeatures | ( | int | nr | ) | [inline] |
Definition at line 62 of file qgscomposerattributetable.h.
void QgsComposerAttributeTable::setSceneRect | ( | const QRectF & | rectangle | ) | [virtual] |
Adapts mMaximumNumberOfFeatures depending on the rectangle height.
Reimplemented from QgsComposerItem.
Definition at line 203 of file qgscomposerattributetable.cpp.
References QgsComposerItem::fontAscentMillimeters(), maximumNumerOfFeaturesChanged(), QgsComposerTable::mContentFont, QgsComposerTable::mGridStrokeWidth, QgsComposerTable::mHeaderFont, QgsComposerTable::mLineTextDistance, and mMaximumNumberOfFeatures.
Referenced by QgsComposerView::mousePressEvent().
void QgsComposerAttributeTable::setSortAttributes | ( | const QList< QPair< int, bool > > | att | ) | [inline] |
Definition at line 77 of file qgscomposerattributetable.h.
void QgsComposerAttributeTable::setVectorLayer | ( | QgsVectorLayer * | vl | ) |
Definition at line 96 of file qgscomposerattributetable.cpp.
References initializeAliasMap(), mDisplayAttributes, and mVectorLayer.
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.
const QgsVectorLayer* QgsComposerAttributeTable::vectorLayer | ( | ) | const [inline] |
Definition at line 57 of file qgscomposerattributetable.h.
bool QgsComposerAttributeTable::writeXML | ( | QDomElement & | elem, |
QDomDocument & | doc | ||
) | const [virtual] |
stores state in Dom element
elem | is Dom element corresponding to 'Composer' tag |
doc | is 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().
const QgsComposerMap* QgsComposerAttributeTable::mComposerMap [private] |
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().
QSet<int> QgsComposerAttributeTable::mDisplayAttributes [private] |
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().
int QgsComposerAttributeTable::mMaximumNumberOfFeatures [private] |
Maximum number of features that is displayed.
Definition at line 91 of file qgscomposerattributetable.h.
Referenced by getFeatureAttributes(), readXML(), and setSceneRect().
bool QgsComposerAttributeTable::mShowOnlyVisibleFeatures [private] |
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().
Associated vector layer.
Definition at line 87 of file qgscomposerattributetable.h.
Referenced by getFeatureAttributes(), getHeaderLabels(), initializeAliasMap(), QgsComposerAttributeTable(), readXML(), removeLayer(), setVectorLayer(), and writeXML().