QGIS API Documentation
2.4.0-Chugiak
|
A text table item that reads text from string lists. More...
#include <qgscomposertexttable.h>
Public Member Functions | |
QgsComposerTextTable (QgsComposition *c) | |
~QgsComposerTextTable () | |
virtual int | type () const |
return correct graphics item type. More... | |
void | setHeaderLabels (const QStringList &labels) |
Sets the text to use for the header row for the table. More... | |
void | addRow (const QStringList &row) |
Adds a row to the table. More... | |
bool | writeXML (QDomElement &elem, QDomDocument &doc) const |
Writes properties specific to text tables. More... | |
bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) |
Reads the properties specific to a text table from xml. More... | |
bool | getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps) |
Queries the text table for text to show in the cells. More... | |
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. More... | |
void | setLineTextDistance (double d) |
Sets the margin distance between cell borders and their contents. More... | |
double | lineTextDistance () const |
Returns the margin distance between cell borders and their contents. More... | |
void | setHeaderFont (const QFont &f) |
Sets the font used to draw header text in the table. More... | |
QFont | headerFont () const |
Returns the font used to draw header text in the table. More... | |
void | setHeaderHAlignment (const HeaderHAlignment alignment) |
Sets the horizontal alignment for table headers. More... | |
HeaderHAlignment | headerHAlignment () const |
Returns the horizontal alignment for table headers. More... | |
void | setContentFont (const QFont &f) |
Sets the font used to draw text in table body cells. More... | |
QFont | contentFont () const |
Returns the font used to draw text in table body cells. More... | |
void | setShowGrid (bool show) |
Sets whether grid lines should be drawn in the table. More... | |
bool | showGrid () const |
Returns whether grid lines are drawn in the table. More... | |
void | setGridStrokeWidth (double w) |
Sets the width for grid lines in the table. More... | |
double | gridStrokeWidth () const |
Returns the width of grid lines in the table. More... | |
void | setGridColor (const QColor &c) |
Sets color used for grid lines in the table. More... | |
QColor | gridColor () const |
Returns the color used for grid lines in the table. More... | |
virtual QMap< int, QString > | headerLabels () const |
Returns the text used in the column headers for the table. More... | |
QList< QgsComposerTableColumn * > * | columns () |
Returns a pointer to the list of QgsComposerTableColumns shown in the table. More... | |
void | setColumns (QList< QgsComposerTableColumn * > columns) |
Replaces the columns in the table with a specified list of QgsComposerTableColumns. More... | |
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... | |
int | page () const |
Gets the page the item is currently on. More... | |
QPointF | pagePos () const |
Returns the item's position relative to its current page. More... | |
void | updatePagePos (double newPageWidth, double newPageHeight) |
Moves the item so that it retains its relative position on the page when the paper size changes. More... | |
void | setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1) |
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, int page=-1) |
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... | |
double | frameOutlineWidth () const |
Returns the frame's 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 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. 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, int flags=Qt::TextWordWrap) 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 descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. More... | |
double | fontHeightMillimeters (const QFont &font) const |
Returns the font height 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... | |
Q_DECL_DEPRECATED 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... | |
Private Attributes | |
QList< QStringList > | mRowText |
One stringlist per row. More... | |
Additional Inherited Members | |
Public Types inherited from QgsComposerTable | |
enum | HeaderHAlignment { FollowColumn, HeaderLeft, HeaderCenter, HeaderRight } |
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 QgsComposerTable | |
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 () |
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... | |
Protected Member Functions inherited from QgsComposerTable | |
virtual bool | calculateMaxColumnWidths (QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps) const |
Calculates the maximum width of text shown in columns. More... | |
void | adaptItemFrame (const QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps) |
Adapts the size of the item frame to match the table's content. More... | |
void | drawHorizontalGridLines (QPainter *p, int nAttributes) |
Draws the horizontal grid lines for the table. More... | |
void | drawVerticalGridLines (QPainter *p, const QMap< int, double > &maxWidthMap) |
Draws the vertical grid lines for the table. More... | |
bool | tableWriteXML (QDomElement &itemElem, QDomDocument &doc) const |
Writes common table properties to xml for storage. More... | |
bool | tableReadXML (const QDomElement &itemElem, const QDomDocument &doc) |
Reads the table's common properties from xml. More... | |
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... | |
Q_DECL_DEPRECATED 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... | |
Q_DECL_DEPRECATED 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... | |
Q_DECL_DEPRECATED 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 inherited from QgsComposerTable | |
double | mLineTextDistance |
Distance between table lines and text. More... | |
QFont | mHeaderFont |
QFont | mContentFont |
HeaderHAlignment | mHeaderHAlignment |
bool | mShowGrid |
double | mGridStrokeWidth |
QColor | mGridColor |
QList< QgsAttributeMap > | mAttributeMaps |
QMap< int, double > | mMaxColumnWidthMap |
QList< QgsComposerTableColumn * > | mColumns |
Protected Attributes inherited from QgsComposerItem | |
QgsComposition * | mComposition |
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 |
QgsComposerEffect * | mEffect |
int | mTransparency |
Item transparency. More... | |
ItemPositionMode | mLastUsedPositionMode |
The item's position mode. More... | |
int | mCurrentExportLayer |
The layer that needs to be exported. More... | |
A text table item that reads text from string lists.
Definition at line 24 of file qgscomposertexttable.h.
QgsComposerTextTable::QgsComposerTextTable | ( | QgsComposition * | c | ) |
Definition at line 21 of file qgscomposertexttable.cpp.
QgsComposerTextTable::~QgsComposerTextTable | ( | ) |
Definition at line 26 of file qgscomposertexttable.cpp.
|
inline |
Adds a row to the table.
row | list of strings to use for each cell's value in the newly added row |
Definition at line 45 of file qgscomposertexttable.h.
|
virtual |
Queries the text table for text to show in the cells.
attributeMaps | list of QgsAttributeMaps where the cell text will be stored |
Reimplemented from QgsComposerTable.
Definition at line 68 of file qgscomposertexttable.cpp.
References mRowText.
|
virtual |
Reads the properties specific to a text table from xml.
itemElem | a QDomElement holding the text table's desired properties. |
doc | QDomDocument for the source xml. |
Implements QgsComposerTable.
Definition at line 62 of file qgscomposertexttable.cpp.
References QgsComposerTable::tableReadXML().
void QgsComposerTextTable::setHeaderLabels | ( | const QStringList & | labels | ) |
Sets the text to use for the header row for the table.
labels | list of strings to use for each column's header row |
Definition at line 31 of file qgscomposertexttable.cpp.
References QgsComposerTable::mColumns, and QgsComposerTableColumn::setHeading().
|
inlinevirtual |
return correct graphics item type.
Added in v1.7
Reimplemented from QgsComposerTable.
Definition at line 31 of file qgscomposertexttable.h.
References QgsComposerItem::ComposerTextTable.
|
virtual |
Writes properties specific to text tables.
elem | an existing QDomElement in which to store the text table's properties. |
doc | QDomDocument for the destination xml. |
Implements QgsComposerTable.
Definition at line 53 of file qgscomposertexttable.cpp.
References QgsComposerItem::_writeXML().
|
private |
One stringlist per row.
Definition at line 70 of file qgscomposertexttable.h.
Referenced by getFeatureAttributes().