QGIS API Documentation  2.3.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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]
Collaboration diagram for QgsComposerTable:
Collaboration graph
[legend]

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 (double r, bool adjustPosition=false)
 Sets the item rotation. More...
 
void repaint ()
 

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 state in Dom element More...
 
virtual bool readXML (const QDomElement &itemElem, const QDomDocument &doc)=0
 sets state from Dom document More...
 
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...
 
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 (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

virtual bool getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps)
 Retrieves feature attributes. More...
 
virtual QMap< int, QString > getHeaderLabels () const
 
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 ()
 

Protected Attributes

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...
 

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
}
 
- 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...
 

Detailed Description

A class to display feature attributes in the print composer.

Definition at line 29 of file qgscomposertable.h.

Constructor & Destructor Documentation

QgsComposerTable::QgsComposerTable ( QgsComposition composition)

Definition at line 23 of file qgscomposertable.cpp.

References mContentFont, and mHeaderFont.

QgsComposerTable::~QgsComposerTable ( )
virtual

Definition at line 40 of file qgscomposertable.cpp.

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 content.

Note
not available in python bindings

Definition at line 238 of file qgscomposertable.cpp.

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

Referenced by adjustFrameToSize().

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

Definition at line 153 of file qgscomposertable.cpp.

References adaptItemFrame(), calculateMaxColumnWidths(), mAttributeMaps, mMaxColumnWidthMap, and QgsComposerItem::repaint().

Referenced by refreshAttributes(), setContentFont(), and setHeaderFont().

bool QgsComposerTable::calculateMaxColumnWidths ( QMap< int, double > &  maxWidthMap,
const QList< QgsAttributeMap > &  attributeMaps 
) const
protectedvirtual

Calculate the maximum width values of the vector attributes.

Definition at line 208 of file qgscomposertable.cpp.

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

Referenced by adjustFrameToSize().

QFont QgsComposerTable::contentFont ( ) const
inline

Definition at line 53 of file qgscomposertable.h.

void QgsComposerTable::drawHorizontalGridLines ( QPainter *  p,
int  nAttributes 
)
protected
void QgsComposerTable::drawVerticalGridLines ( QPainter *  p,
const QMap< int, double > &  maxWidthMap 
)
protected
Note
not available in python bindings

Definition at line 277 of file qgscomposertable.cpp.

References mGridStrokeWidth, and mLineTextDistance.

Referenced by paint().

virtual bool QgsComposerTable::getFeatureAttributes ( QList< QgsAttributeMap > &  attributeMaps)
inlineprotectedvirtual

Retrieves feature attributes.

Note
not available in python bindings

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 99 of file qgscomposertable.h.

Referenced by refreshAttributes().

virtual QMap<int, QString> QgsComposerTable::getHeaderLabels ( ) const
inlineprotectedvirtual

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 100 of file qgscomposertable.h.

Referenced by calculateMaxColumnWidths(), and paint().

QColor QgsComposerTable::gridColor ( ) const
inline

Definition at line 62 of file qgscomposertable.h.

double QgsComposerTable::gridStrokeWidth ( ) const
inline

Definition at line 59 of file qgscomposertable.h.

QFont QgsComposerTable::headerFont ( ) const
inline

Definition at line 50 of file qgscomposertable.h.

double QgsComposerTable::lineTextDistance ( ) const
inline

Definition at line 47 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::refreshAttributes ( )
virtualslot
void QgsComposerTable::setContentFont ( const QFont &  f)

Definition at line 146 of file qgscomposertable.cpp.

References adjustFrameToSize(), and mContentFont.

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

Definition at line 61 of file qgscomposertable.h.

void QgsComposerTable::setGridStrokeWidth ( double  w)
inline

Definition at line 58 of file qgscomposertable.h.

void QgsComposerTable::setHeaderFont ( const QFont &  f)

Definition at line 139 of file qgscomposertable.cpp.

References adjustFrameToSize(), and mHeaderFont.

void QgsComposerTable::setLineTextDistance ( double  d)
inline

Definition at line 46 of file qgscomposertable.h.

void QgsComposerTable::setShowGrid ( bool  show)
inline

Definition at line 55 of file qgscomposertable.h.

bool QgsComposerTable::showGrid ( ) const
inline

Definition at line 56 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
inlinevirtual

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerItem.

Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.

Definition at line 38 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

QList<QgsAttributeMap> QgsComposerTable::mAttributeMaps
protected

Definition at line 94 of file qgscomposertable.h.

Referenced by adjustFrameToSize(), paint(), and refreshAttributes().

QFont QgsComposerTable::mContentFont
protected
QColor QgsComposerTable::mGridColor
protected

Definition at line 92 of file qgscomposertable.h.

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

double QgsComposerTable::mGridStrokeWidth
protected
QFont QgsComposerTable::mHeaderFont
protected
double QgsComposerTable::mLineTextDistance
protected
QMap<int, double> QgsComposerTable::mMaxColumnWidthMap
protected

Definition at line 95 of file qgscomposertable.h.

Referenced by adjustFrameToSize(), paint(), and refreshAttributes().

bool QgsComposerTable::mShowGrid
protected

Definition at line 90 of file qgscomposertable.h.

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


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