Quantum GIS API Documentation  1.8
Public Member Functions | Protected Member Functions | Protected Attributes
QgsComposerTable Class Reference

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

#include <qgscomposertable.h>

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

List of all members.

Public Member Functions

 QgsComposerTable (QgsComposition *composition)
virtual ~QgsComposerTable ()
virtual int type () const
 return correct graphics item type.
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint.
virtual bool writeXML (QDomElement &elem, QDomDocument &doc) const =0
 stores state in Dom element
virtual bool readXML (const QDomElement &itemElem, const QDomDocument &doc)=0
 sets state from Dom document
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
void adjustFrameToSize ()
 Adapts the size of the frame to match the content.

Protected Member Functions

virtual bool getFeatureAttributes (QList< QgsAttributeMap > &attributes)
 Retrieves feature attributes.
virtual QMap< int, QString > getHeaderLabels () const
virtual bool calculateMaxColumnWidths (QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeList) const
 Calculate the maximum width values of the vector attributes.
void adaptItemFrame (const QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeList)
 Adapts the size of the item frame to match the content.
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 Attributes

double mLineTextDistance
 Distance between table lines and text.
QFont mHeaderFont
QFont mContentFont
bool mShowGrid
double mGridStrokeWidth
QColor mGridColor

Detailed Description

A class to display feature attributes in the print composer.

Definition at line 28 of file qgscomposertable.h.


Constructor & Destructor Documentation

Definition at line 22 of file qgscomposertable.cpp.

Definition at line 31 of file qgscomposertable.cpp.


Member Function Documentation

void QgsComposerTable::adaptItemFrame ( const QMap< int, double > &  maxWidthMap,
const QList< QgsAttributeMap > &  attributeList 
) [protected]

Adapts the size of the item frame to match the content.

Definition at line 213 of file qgscomposertable.cpp.

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

Referenced by adjustFrameToSize(), and paint().

Adapts the size of the frame to match the content.

This is normally done in the paint method, but sometimes it needs to be done before the first render

Definition at line 119 of file qgscomposertable.cpp.

References adaptItemFrame(), calculateMaxColumnWidths(), and getFeatureAttributes().

bool QgsComposerTable::calculateMaxColumnWidths ( QMap< int, double > &  maxWidthMap,
const QList< QgsAttributeMap > &  attributeList 
) const [protected, virtual]

Calculate the maximum width values of the vector attributes.

Definition at line 177 of file qgscomposertable.cpp.

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

Referenced by adjustFrameToSize(), and paint().

QFont QgsComposerTable::contentFont ( ) const [inline]

Definition at line 50 of file qgscomposertable.h.

void QgsComposerTable::drawHorizontalGridLines ( QPainter *  p,
int  nAttributes 
) [protected]
void QgsComposerTable::drawVerticalGridLines ( QPainter *  p,
const QMap< int, double > &  maxWidthMap 
) [protected]

Definition at line 249 of file qgscomposertable.cpp.

References mGridStrokeWidth, and mLineTextDistance.

Referenced by paint().

virtual bool QgsComposerTable::getFeatureAttributes ( QList< QgsAttributeMap > &  attributes) [inline, protected, virtual]

Retrieves feature attributes.

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 77 of file qgscomposertable.h.

Referenced by adjustFrameToSize(), and paint().

virtual QMap<int, QString> QgsComposerTable::getHeaderLabels ( ) const [inline, protected, virtual]

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 79 of file qgscomposertable.h.

Referenced by calculateMaxColumnWidths(), and paint().

QColor QgsComposerTable::gridColor ( ) const [inline]

Definition at line 59 of file qgscomposertable.h.

double QgsComposerTable::gridStrokeWidth ( ) const [inline]

Definition at line 56 of file qgscomposertable.h.

QFont QgsComposerTable::headerFont ( ) const [inline]

Definition at line 47 of file qgscomposertable.h.

double QgsComposerTable::lineTextDistance ( ) const [inline]

Definition at line 44 of file qgscomposertable.h.

void QgsComposerTable::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  itemStyle,
QWidget *  pWidget 
) [virtual]
virtual bool QgsComposerTable::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
) [pure virtual]

sets state from Dom document

Parameters:
itemElemis Dom node corresponding to item tag
docis Dom document

Implements QgsComposerItem.

Implemented in QgsComposerAttributeTable, and QgsComposerTextTable.

void QgsComposerTable::setContentFont ( const QFont &  f) [inline]

Definition at line 49 of file qgscomposertable.h.

void QgsComposerTable::setGridColor ( const QColor &  c) [inline]

Definition at line 58 of file qgscomposertable.h.

void QgsComposerTable::setGridStrokeWidth ( double  w) [inline]

Definition at line 55 of file qgscomposertable.h.

void QgsComposerTable::setHeaderFont ( const QFont &  f) [inline]

Definition at line 46 of file qgscomposertable.h.

void QgsComposerTable::setLineTextDistance ( double  d) [inline]

Definition at line 43 of file qgscomposertable.h.

void QgsComposerTable::setShowGrid ( bool  show) [inline]

Definition at line 52 of file qgscomposertable.h.

bool QgsComposerTable::showGrid ( ) const [inline]

Definition at line 53 of file qgscomposertable.h.

bool QgsComposerTable::tableReadXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 
) [protected]
bool QgsComposerTable::tableWriteXML ( QDomElement &  itemElem,
QDomDocument &  doc 
) const [protected]
virtual int QgsComposerTable::type ( ) const [inline, virtual]

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 35 of file qgscomposertable.h.

References QgsComposerItem::ComposerTable.

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

stores state in Dom element

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

Implements QgsComposerItem.

Implemented in QgsComposerAttributeTable, and QgsComposerTextTable.


Member Data Documentation

QFont QgsComposerTable::mContentFont [protected]
QColor QgsComposerTable::mGridColor [protected]

Definition at line 74 of file qgscomposertable.h.

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

QFont QgsComposerTable::mHeaderFont [protected]
bool QgsComposerTable::mShowGrid [protected]

Definition at line 72 of file qgscomposertable.h.

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


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