QGIS API Documentation
2.2.0-Valmiera
|
A class to display feature attributes in the print composer. More...
#include <qgscomposertable.h>
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. | |
Public Member Functions inherited from QgsComposerItem | |
QgsComposerItem (QgsComposition *composition, bool manageZValue=true) | |
Constructor. | |
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 () const |
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, bool posIncludesFrame=false) |
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. | |
virtual void | setFrameOutlineWidth (double outlineWidth) |
Sets frame outline width. | |
virtual double | estimatedFrameBleed () const |
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. | |
virtual QRectF | rectWithFrame () const |
Returns the item's rectangular bounds, including any bleed caused by the item's frame. | |
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 QgsComposition * | composition () const |
QgsComposition * | composition () |
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) | |
double | itemRotation () const |
Returns the rotation for the composer item. | |
double | rotation () const |
Returns the rotation for the composer item. | |
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 | |
virtual bool | getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps) |
Retrieves feature attributes. | |
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. | |
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 | 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, double rotation) const |
Calculates width and hight of the picture (in mm) such that it fits into the item frame with the given rotation. | |
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. | |
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. | |
bool | cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height, double rotation) const |
Calculates corner point after rotation and scaling. | |
bool | cornerPointOnRotatedAndScaledRect (double &x, double &y, double width, double height) const |
Calculates corner point after rotation and scaling. | |
void | sizeChangedByRotation (double &width, double &height, double rotation) |
Calculates width / height of the bounding box of a rotated rectangle. | |
void | sizeChangedByRotation (double &width, double &height) |
Calculates width / height of the bounding box of a rotated rectangle. | |
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 () |
Protected Attributes | |
double | mLineTextDistance |
Distance between table lines and text. | |
QFont | mHeaderFont |
QFont | mContentFont |
bool | mShowGrid |
double | mGridStrokeWidth |
QColor | mGridColor |
Protected Attributes inherited from QgsComposerItem | |
QgsComposition * | mComposition |
QgsComposerItem::MouseMoveAction | mCurrentMouseMoveAction |
QPointF | mMouseMoveStartPos |
Start point of the last mouse move action (in scene coordinates) | |
QPointF | mLastMouseEventPos |
Position of the last mouse move event (in scene coordinates) | |
QGraphicsRectItem * | mBoundingResizeRectangle |
Rectangle used during move and resize actions. | |
QGraphicsLineItem * | mHAlignSnapItem |
QGraphicsLineItem * | mVAlignSnapItem |
bool | mFrame |
True if item fram needs to be painted. | |
bool | mBackground |
True if item background needs to be painted. | |
QColor | mBackgroundColor |
Background color. | |
bool | mItemPositionLocked |
True if item position and size cannot be changed with mouse move. | |
double | mLastValidViewScaleFactor |
Backup to restore item appearance if no view scale factor is available. | |
double | mItemRotation |
Item rotation in degrees, clockwise. | |
QPainter::CompositionMode | mBlendMode |
Composition blend mode for item. | |
bool | mEffectsEnabled |
QgsComposerEffect * | mEffect |
int | mTransparency |
Item transparency. | |
ItemPositionMode | mLastUsedPositionMode |
The item's position mode. |
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 } |
Public Slots inherited from QgsComposerItem | |
virtual void | setRotation (double r) |
Sets the item rotation. | |
virtual void | setItemRotation (double r, bool adjustPosition=false) |
Sets the item rotation. | |
void | repaint () |
Signals inherited from QgsComposerItem | |
void | itemRotationChanged (double newRotation) |
Is emitted on item rotation change. | |
void | itemChanged () |
Used e.g. | |
void | sizeChanged () |
Emitted if the rectangle changes. | |
void | frameChanged () |
Emitted if the item's frame style changes. |
A class to display feature attributes in the print composer.
Definition at line 29 of file qgscomposertable.h.
QgsComposerTable::QgsComposerTable | ( | QgsComposition * | composition | ) |
Definition at line 22 of file qgscomposertable.cpp.
References mContentFont, and mHeaderFont.
|
virtual |
Definition at line 39 of file qgscomposertable.cpp.
|
protected |
Adapts the size of the item frame to match the content.
Definition at line 211 of file qgscomposertable.cpp.
References QgsComposerItem::fontAscentMillimeters(), mContentFont, mGridStrokeWidth, mHeaderFont, mLineTextDistance, and QgsComposerItem::setSceneRect().
Referenced by adjustFrameToSize(), and paint().
void QgsComposerTable::adjustFrameToSize | ( | ) |
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 126 of file qgscomposertable.cpp.
References adaptItemFrame(), calculateMaxColumnWidths(), and getFeatureAttributes().
|
protectedvirtual |
Calculate the maximum width values of the vector attributes.
Definition at line 181 of file qgscomposertable.cpp.
References getHeaderLabels(), mContentFont, mHeaderFont, and QgsComposerItem::textWidthMillimeters().
Referenced by adjustFrameToSize(), and paint().
|
inline |
Definition at line 51 of file qgscomposertable.h.
|
protected |
Definition at line 233 of file qgscomposertable.cpp.
References QgsComposerItem::fontAscentMillimeters(), mContentFont, mGridStrokeWidth, mHeaderFont, and mLineTextDistance.
Referenced by paint().
|
protected |
Definition at line 250 of file qgscomposertable.cpp.
References mGridStrokeWidth, and mLineTextDistance.
Referenced by paint().
|
inlineprotectedvirtual |
Retrieves feature attributes.
Reimplemented in QgsComposerAttributeTable.
Definition at line 79 of file qgscomposertable.h.
Referenced by adjustFrameToSize(), and paint().
|
inlineprotectedvirtual |
Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.
Definition at line 80 of file qgscomposertable.h.
Referenced by calculateMaxColumnWidths(), and paint().
|
inline |
Definition at line 60 of file qgscomposertable.h.
|
inline |
Definition at line 57 of file qgscomposertable.h.
|
inline |
Definition at line 48 of file qgscomposertable.h.
|
inline |
Definition at line 45 of file qgscomposertable.h.
|
virtual |
Reimplementation of QCanvasItem::paint.
Reimplemented in QgsComposerAttributeTable.
Definition at line 44 of file qgscomposertable.cpp.
References adaptItemFrame(), calculateMaxColumnWidths(), QgsComposerItem::drawBackground(), QgsComposerItem::drawFrame(), drawHorizontalGridLines(), QgsComposerItem::drawSelectionBoxes(), QgsComposerItem::drawText(), drawVerticalGridLines(), QgsComposerItem::fontAscentMillimeters(), getFeatureAttributes(), getHeaderLabels(), mContentFont, mGridColor, mGridStrokeWidth, mHeaderFont, mLineTextDistance, and mShowGrid.
|
pure virtual |
sets state from Dom document
itemElem | is Dom node corresponding to item tag |
doc | is Dom document |
Implements QgsComposerItem.
Implemented in QgsComposerAttributeTable, and QgsComposerTextTable.
|
inline |
Definition at line 50 of file qgscomposertable.h.
|
inline |
Definition at line 59 of file qgscomposertable.h.
|
inline |
Definition at line 56 of file qgscomposertable.h.
|
inline |
Definition at line 47 of file qgscomposertable.h.
|
inline |
Definition at line 44 of file qgscomposertable.h.
|
inline |
Definition at line 53 of file qgscomposertable.h.
|
inline |
Definition at line 54 of file qgscomposertable.h.
|
protected |
Definition at line 152 of file qgscomposertable.cpp.
References QgsComposerItem::_readXML(), mContentFont, mGridColor, mGridStrokeWidth, mHeaderFont, mLineTextDistance, and mShowGrid.
Referenced by QgsComposerTextTable::readXML(), and QgsComposerAttributeTable::readXML().
|
protected |
Definition at line 139 of file qgscomposertable.cpp.
References QgsComposerItem::_writeXML(), mContentFont, mGridColor, mGridStrokeWidth, mHeaderFont, mLineTextDistance, and mShowGrid.
Referenced by QgsComposerAttributeTable::writeXML().
|
inlinevirtual |
return correct graphics item type.
Added in v1.7
Reimplemented from QgsComposerItem.
Reimplemented in QgsComposerAttributeTable, and QgsComposerTextTable.
Definition at line 36 of file qgscomposertable.h.
References QgsComposerItem::ComposerTable.
|
pure virtual |
stores state in Dom element
elem | is Dom element corresponding to 'Composer' tag |
doc | is the Dom document |
Implements QgsComposerItem.
Implemented in QgsComposerAttributeTable, and QgsComposerTextTable.
|
protected |
Definition at line 71 of file qgscomposertable.h.
Referenced by adaptItemFrame(), calculateMaxColumnWidths(), drawHorizontalGridLines(), paint(), QgsComposerTable(), QgsComposerAttributeTable::setSceneRect(), tableReadXML(), and tableWriteXML().
|
protected |
Definition at line 75 of file qgscomposertable.h.
Referenced by paint(), tableReadXML(), and tableWriteXML().
|
protected |
Definition at line 74 of file qgscomposertable.h.
Referenced by adaptItemFrame(), drawHorizontalGridLines(), drawVerticalGridLines(), paint(), QgsComposerAttributeTable::setSceneRect(), tableReadXML(), and tableWriteXML().
|
protected |
Definition at line 70 of file qgscomposertable.h.
Referenced by adaptItemFrame(), calculateMaxColumnWidths(), drawHorizontalGridLines(), paint(), QgsComposerTable(), QgsComposerAttributeTable::setSceneRect(), tableReadXML(), and tableWriteXML().
|
protected |
Distance between table lines and text.
Definition at line 68 of file qgscomposertable.h.
Referenced by adaptItemFrame(), drawHorizontalGridLines(), drawVerticalGridLines(), paint(), QgsComposerAttributeTable::setSceneRect(), tableReadXML(), and tableWriteXML().
|
protected |
Definition at line 73 of file qgscomposertable.h.
Referenced by paint(), tableReadXML(), and tableWriteXML().