QGIS API Documentation  2.0.1-Dufour
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
QgsComposerTextTable Class Reference

A text table item that reads text from string lists. More...

#include <qgscomposertexttable.h>

Inheritance diagram for QgsComposerTextTable:
Inheritance graph
Collaboration diagram for QgsComposerTextTable:
Collaboration graph

Public Member Functions

 QgsComposerTextTable (QgsComposition *c)
 ~QgsComposerTextTable ()
virtual int type () const
 return correct graphics item type.
void setHeaderLabels (const QStringList &l)
void addRow (const QStringList &row)
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
- Public Member Functions inherited from QgsComposerTable
 QgsComposerTable (QgsComposition *composition)
virtual ~QgsComposerTable ()
virtual void paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget)
 Reimplementation of QCanvasItem::paint.
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.
- Public Member Functions inherited from QgsComposerItem
 QgsComposerItem (QgsComposition *composition, bool manageZValue=true)
 QgsComposerItem (qreal x, qreal y, qreal width, qreal height, QgsComposition *composition, bool manageZValue=true)
 Constructor with box position and composer object.
virtual ~QgsComposerItem ()
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted.
virtual bool selected ()
 Is selected.
virtual bool writeSettings ()
 stores state in project
virtual bool readSettings ()
 read state from project
virtual bool removeSettings ()
 delete settings from project file
void move (double dx, double dy)
 Moves item in canvas coordinates.
virtual void moveContent (double dx, double dy)
 Move Content of item.
virtual void zoomContent (int delta, double x, double y)
 Zoom content of item.
void setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft)
 Moves the item to a new position (in canvas coordinates)
void setItemPosition (double x, double y, double width, double height, ItemPositionMode itemPoint=UpperLeft)
 Sets item position and width / height in one go.
ItemPositionMode lastUsedPositionMode ()
 Returns item's last used position mode.
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.
bool _writeXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes parameter that are not subclass specific in document.
bool _readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads parameter that are not subclass specific in document.
bool hasFrame () const
 Whether this item has a frame or not.
void setFrameEnabled (bool drawFrame)
 Set whether this item has a frame drawn around it or not.
bool hasBackground () const
 Whether this item has a Background or not.
void setBackgroundEnabled (bool drawBackground)
 Set whether this item has a Background drawn around it or not.
QColor backgroundColor () const
 Gets the background color for this item.
void setBackgroundColor (const QColor &backgroundColor)
 Sets the background color for this item.
QPainter::CompositionMode blendMode () const
 Returns the item's composition blending mode.
void setBlendMode (QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode.
int transparency () const
 Returns the item's transparency.
void setTransparency (int transparency)
 Sets the item's transparency.
bool effectsEnabled () const
 Returns true if effects (eg blend modes) are enabled for the item.
void setEffectsEnabled (bool effectsEnabled)
 Sets whether effects (eg blend modes) are enabled for the item.
virtual void addItem (QgsComposerItem *item)
 Composite operations for item groups do nothing per default.
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.
virtual void endItemCommand ()
void endCommand ()
 Finish current command and push it onto the undo stack.
void cancelCommand ()
void drawText (QPainter *p, double x, double y, const QString &text, const QFont &font) const
 Draws Text.
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.
double textWidthMillimeters (const QFont &font, const QString &text) const
 Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double fontHeightCharacterMM (const QFont &font, const QChar &c) const
 Returns the font height of a character in millimeters.
double fontAscentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double fontDescentMillimeters (const QFont &font) const
 Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
double pixelFontSize (double pointSize) const
 Calculates font to from point size to pixel size.
QFont scaledFontPixelSize (const QFont &font) const
 Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE.
void setPositionLock (bool lock)
 Locks / unlocks the item position for mouse drags.
bool positionLock () const
 Returns position lock for mouse drags (true means locked)
void updateCursor (const QPointF &itemPos)
 Update mouse cursor at (item) position.
double rotation () const
virtual void updateItem ()
 Updates item, with the possibility to do custom update for subclasses.
QString id () const
 Get item's id (which is not necessarly unique)
virtual void setId (const QString &id)
 Set item's id (which is not necessarly unique)
QString uuid () const
 Get item identification name.

Protected Member Functions

bool getFeatureAttributes (QList< QgsAttributes > &attributes)
QMap< int, QString > getHeaderLabels () const
- Protected Member Functions inherited from QgsComposerTable
virtual bool getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps)
 Retrieves feature attributes.
virtual bool calculateMaxColumnWidths (QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps) const
 Calculate the maximum width values of the vector attributes.
void adaptItemFrame (const QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps)
 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 Member Functions inherited from QgsComposerItem
virtual void mouseMoveEvent (QGraphicsSceneMouseEvent *event)
virtual void mousePressEvent (QGraphicsSceneMouseEvent *event)
virtual void mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
virtual void hoverMoveEvent (QGraphicsSceneHoverEvent *event)
Qt::CursorShape cursorForPosition (const QPointF &itemCoordPos)
 Finds out the appropriate cursor for the current mouse position in the widget (e.g.
QgsComposerItem::MouseMoveAction mouseMoveActionForPosition (const QPointF &itemCoordPos)
 Finds out which mouse move action to choose depending on the cursor position inside the widget.
void changeItemRectangle (const QPointF &currentPosition, const QPointF &mouseMoveStartPos, const QGraphicsRectItem *originalItem, double dx, double dy, QGraphicsRectItem *changeItem)
 Changes the rectangle of an item depending on current mouse action (resize or move)
virtual void drawSelectionBoxes (QPainter *p)
 Draw selection boxes around item.
virtual void drawFrame (QPainter *p)
 Draw black frame around item.
virtual void drawBackground (QPainter *p)
 Draw background.
void drawArrowHead (QPainter *p, double x, double y, double angle, double arrowHeadWidth) const
 Draws arrowhead.
double angle (const QPointF &p1, const QPointF &p2) const
 Returns angle of the line from p1 to p2 (clockwise, starting at N)
double rectHandlerBorderTolerance () const
 Returns the current (zoom level dependent) tolerance to decide if mouse position is close enough to the item border for resizing.
double lockSymbolSize () const
 Returns the size of the lock symbol depending on the composer zoom level and the item size.
double horizontalViewScaleFactor () const
 Returns the zoom factor of the graphics view.
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.
bool cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const
 Calculates corner point after rotation and scaling.
void sizeChangedByRotation (double &width, double &height)
 Calculates width / height of the bounding box of a rotated rectangle (mRotation)
void rotate (double angle, double &x, double &y) const
 Rotates a point / vector.
QGraphicsLineItem * hAlignSnapItem ()
 Return horizontal align snap item.
void deleteHAlignSnapItem ()
QGraphicsLineItem * vAlignSnapItem ()
 Return vertical align snap item.
void deleteVAlignSnapItem ()
void deleteAlignItems ()

Private Attributes

QStringList mHeaderLabels
 Column titles.
QList< QStringList > mRowText
 One stringlist per row.

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,
- Public Slots inherited from QgsComposerItem
virtual void setRotation (double r)
void repaint ()
- Signals inherited from QgsComposerItem
void rotationChanged (double newRotation)
 Is emitted on rotation change to notify north arrow pictures.
void itemChanged ()
 Used e.g.
void sizeChanged ()
 Emitted if the rectangle changes.
- Protected Attributes inherited from QgsComposerTable
double mLineTextDistance
 Distance between table lines and text.
QFont mHeaderFont
QFont mContentFont
bool mShowGrid
double mGridStrokeWidth
QColor mGridColor

Detailed Description

A text table item that reads text from string lists.

Definition at line 24 of file qgscomposertexttable.h.

Constructor & Destructor Documentation

QgsComposerTextTable::QgsComposerTextTable ( QgsComposition c)

Definition at line 20 of file qgscomposertexttable.cpp.

QgsComposerTextTable::~QgsComposerTextTable ( )

Definition at line 25 of file qgscomposertexttable.cpp.

Member Function Documentation

void QgsComposerTextTable::addRow ( const QStringList &  row)

Definition at line 34 of file qgscomposertexttable.h.

bool QgsComposerTextTable::getFeatureAttributes ( QList< QgsAttributes > &  attributes)
not available in python bindings

Definition at line 45 of file qgscomposertexttable.cpp.

References mRowText.

QMap< int, QString > QgsComposerTextTable::getHeaderLabels ( ) const

Reimplemented from QgsComposerTable.

Definition at line 64 of file qgscomposertexttable.cpp.

References mHeaderLabels.

bool QgsComposerTextTable::readXML ( const QDomElement &  itemElem,
const QDomDocument &  doc 

sets state from Dom document

itemElemis Dom node corresponding to item tag
docis Dom document

Implements QgsComposerTable.

Definition at line 39 of file qgscomposertexttable.cpp.

References QgsComposerTable::tableReadXML().

void QgsComposerTextTable::setHeaderLabels ( const QStringList &  l)

Definition at line 33 of file qgscomposertexttable.h.

virtual int QgsComposerTextTable::type ( ) const

return correct graphics item type.

Added in v1.7

Reimplemented from QgsComposerTable.

Definition at line 31 of file qgscomposertexttable.h.

References QgsComposerItem::ComposerTextTable.

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

stores state in Dom element

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

Implements QgsComposerTable.

Definition at line 30 of file qgscomposertexttable.cpp.

References QgsComposerItem::_writeXML().

Member Data Documentation

QStringList QgsComposerTextTable::mHeaderLabels

Column titles.

Definition at line 46 of file qgscomposertexttable.h.

Referenced by getHeaderLabels().

QList< QStringList > QgsComposerTextTable::mRowText

One stringlist per row.

Definition at line 48 of file qgscomposertexttable.h.

Referenced by getFeatureAttributes().

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