|
QGIS API Documentation
2.8.2-Wien
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
QGIS API Documentation
2.8.2-Wien
|
A text table item that reads text from string lists. More...
#include <qgscomposertexttable.h>
Public Member Functions | |
| QgsComposerTextTable (QgsComposition *c) | |
| ~QgsComposerTextTable () | |
| void | addRow (const QStringList &row) |
| Adds a row to the table. | |
| bool | getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps) override |
| Queries the text table for text to show in the cells. | |
| bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) override |
| Reads the properties specific to a text table from xml. | |
| void | setHeaderLabels (const QStringList &labels) |
| Sets the text to use for the header row for the table. | |
| virtual int | type () const override |
| return correct graphics item type. | |
| bool | writeXML (QDomElement &elem, QDomDocument &doc) const override |
| Writes properties specific to text tables. | |
 Public Member Functions inherited from QgsComposerTable | |
| QgsComposerTable (QgsComposition *composition) | |
| virtual | ~QgsComposerTable () |
| QList< QgsComposerTableColumn * > * | columns () |
| Returns a pointer to the list of QgsComposerTableColumns shown in the table. | |
| QFont | contentFont () const |
| Returns the font used to draw text in table body cells. | |
| QColor | contentFontColor () const |
| Returns the color used to draw text in table body cells. | |
| QColor | gridColor () const |
| Returns the color used for grid lines in the table. | |
| double | gridStrokeWidth () const |
| Returns the width of grid lines in the table. | |
| QFont | headerFont () const |
| Returns the font used to draw header text in the table. | |
| QColor | headerFontColor () const |
| Returns the color used to draw header text in the table. | |
| HeaderHAlignment | headerHAlignment () const |
| Returns the horizontal alignment for table headers. | |
| virtual QMap< int, QString > | headerLabels () const |
| Returns the text used in the column headers for the table. | |
| double | lineTextDistance () const |
| Returns the margin distance between cell borders and their contents. | |
| virtual void | paint (QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override |
| Reimplementation of QCanvasItem::paint. | |
| void | setColumns (QList< QgsComposerTableColumn * > columns) |
| Replaces the columns in the table with a specified list of QgsComposerTableColumns. | |
| void | setContentFont (const QFont &f) |
| Sets the font used to draw text in table body cells. | |
| void | setContentFontColor (const QColor &color) |
| Sets the color used to draw text in table body cells. | |
| void | setGridColor (const QColor &c) |
| Sets color used for grid lines in the table. | |
| void | setGridStrokeWidth (double w) |
| Sets the width for grid lines in the table. | |
| void | setHeaderFont (const QFont &f) |
| Sets the font used to draw header text in the table. | |
| void | setHeaderFontColor (const QColor &color) |
| Sets the color used to draw header text in the table. | |
| void | setHeaderHAlignment (const HeaderHAlignment alignment) |
| Sets the horizontal alignment for table headers. | |
| void | setLineTextDistance (double d) |
| Sets the margin distance between cell borders and their contents. | |
| void | setShowGrid (bool show) |
| Sets whether grid lines should be drawn in the table. | |
| bool | showGrid () const |
| Returns whether grid lines are drawn in the table. | |
| 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 () |
| bool | _readXML (const QDomElement &itemElem, const QDomDocument &doc) |
| Reads parameter that are not subclass specific in document. | |
| bool | _writeXML (QDomElement &itemElem, QDomDocument &doc) const |
| Writes parameter that are not subclass specific in document. | |
| virtual void | addItem (QgsComposerItem *item) |
| Composite operations for item groups do nothing per default. | |
| QColor | backgroundColor () const |
| Gets the background color for this item. | |
| void | beginCommand (const QString &commandText, QgsComposerMergeCommand::Context c=QgsComposerMergeCommand::Unknown) |
| Starts new composer undo command. | |
| virtual void | beginItemCommand (const QString &text) |
| QPainter::CompositionMode | blendMode () const |
| Returns the item's composition blending mode. | |
| void | cancelCommand () |
| virtual QString | displayName () const |
| Get item display name. | |
| Q_DECL_DEPRECATED void | drawText (QPainter *p, double x, double y, const QString &text, const QFont &font, const QColor &c=QColor()) const |
| Draws Text. | |
| Q_DECL_DEPRECATED 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. | |
| bool | effectsEnabled () const |
| Returns whether effects (eg blend modes) are enabled for the item. | |
| void | endCommand () |
| Finish current command and push it onto the undo stack. | |
| virtual void | endItemCommand () |
| virtual double | estimatedFrameBleed () const |
| Returns the estimated amount the item's frame bleeds outside the item's actual rectangle. | |
| bool | excludeFromExports (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) |
| Returns whether the item should be excluded from composer exports and prints. | |
| Q_DECL_DEPRECATED double | fontAscentMillimeters (const QFont &font) const |
| Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. | |
| Q_DECL_DEPRECATED double | fontDescentMillimeters (const QFont &font) const |
| Returns the font descent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. | |
| Q_DECL_DEPRECATED double | fontHeightCharacterMM (const QFont &font, const QChar &c) const |
| Returns the font height of a character in millimeters. | |
| Q_DECL_DEPRECATED double | fontHeightMillimeters (const QFont &font) const |
| Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. | |
| Qt::PenJoinStyle | frameJoinStyle () const |
| Returns the join style used for drawing the item's frame. | |
| QColor | frameOutlineColor () const |
| Returns the frame's outline color. | |
| double | frameOutlineWidth () const |
| Returns the frame's outline width. | |
| bool | hasBackground () const |
| Whether this item has a Background or not. | |
| bool | hasFrame () const |
| Whether this item has a frame or not. | |
| QString | id () const |
| Get item's id (which is not necessarly unique) | |
| bool | isGroupMember () const |
| Returns whether this item is part of a group. | |
| virtual bool | isRemoved () const |
| Returns whether this item has been removed from the composition. | |
| double | itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const |
| Returns the current rotation for the composer item. | |
| ItemPositionMode | lastUsedPositionMode () |
| Returns item's last used position mode. | |
| void | move (double dx, double dy) |
| Moves item in canvas coordinates. | |
| virtual void | moveContent (double dx, double dy) |
| Move Content of item. | |
| virtual int | numberExportLayers () const |
| Get the number of layers that this item requires for exporting as layers. | |
| int | page () const |
| Gets the page the item is currently on. | |
| QPointF | pagePos () const |
| Returns the item's position relative to its current page. | |
| Q_DECL_DEPRECATED double | pixelFontSize (double pointSize) const |
| Calculates font size in mm from a font point size. | |
| bool | positionLock () const |
| Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing. | |
| virtual QRectF | rectWithFrame () const |
| Returns the item's rectangular bounds, including any bleed caused by the item's frame. | |
| virtual void | removeItems () |
| Q_DECL_DEPRECATED double | rotation () const |
| Returns the rotation for the composer item. | |
| Q_DECL_DEPRECATED QFont | scaledFontPixelSize (const QFont &font) const |
| Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE. | |
| virtual bool | selected () const |
| Is selected. | |
| void | setBackgroundColor (const QColor &backgroundColor) |
| Sets the background color for this item. | |
| void | setBackgroundEnabled (const bool drawBackground) |
| Set whether this item has a Background drawn around it or not. | |
| void | setBlendMode (const QPainter::CompositionMode blendMode) |
| Sets the item's composition blending mode. | |
| virtual void | setCurrentExportLayer (const int layerIdx=-1) |
| Sets the current layer to draw for exporting. | |
| void | setEffectsEnabled (const bool effectsEnabled) |
| Sets whether effects (eg blend modes) are enabled for the item. | |
| virtual void | setExcludeFromExports (const bool exclude) |
| Sets whether the item should be excluded from composer exports and prints. | |
| virtual void | setFrameEnabled (const bool drawFrame) |
| Set whether this item has a frame drawn around it or not. | |
| void | setFrameJoinStyle (const Qt::PenJoinStyle style) |
| Sets join style used when drawing the item's frame. | |
| virtual void | setFrameOutlineColor (const QColor &color) |
| Sets frame outline color. | |
| virtual void | setFrameOutlineWidth (const double outlineWidth) |
| Sets frame outline width. | |
| virtual void | setId (const QString &id) |
| Set item's id (which is not necessarly unique) | |
| void | setIsGroupMember (const bool isGroupMember) |
| Sets whether this item is part of a group. | |
| void | setIsRemoved (const bool removed) |
| Sets whether this item has been removed from the composition. | |
| void | setItemPosition (double x, double y, ItemPositionMode itemPoint=UpperLeft, int page=-1) |
| 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, int page=-1) |
| Sets item position and width / height in one go. | |
| void | setPositionLock (const bool lock) |
| Locks / unlocks the item position for mouse drags. | |
| 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. | |
| virtual void | setSelected (bool s) |
| Set selected, selected item should be highlighted. | |
| void | setTransparency (const int transparency) |
| Sets the item's transparency. | |
| virtual void | setVisibility (const bool visible) |
| Sets visibility for item. | |
| Q_DECL_DEPRECATED double | textWidthMillimeters (const QFont &font, const QString &text) const |
| Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE. | |
| int | transparency () const |
| Returns the item's transparency. | |
| virtual void | updateItem () |
| Updates item, with the possibility to do custom update for subclasses. | |
| void | updatePagePos (double newPageWidth, double newPageHeight) |
| Moves the item so that it retains its relative position on the page when the paper size changes. | |
| QString | uuid () const |
| Get item identification name. | |
| virtual Q_DECL_DEPRECATED void | zoomContent (int delta, double x, double y) |
| Zoom content of item. | |
| virtual void | zoomContent (const double factor, const QPointF point, const ZoomMode mode=QgsComposerItem::Zoom) |
| Zoom content of item. | |
| Public Member Functions inherited from QgsComposerObject | |
| QgsComposerObject (QgsComposition *composition) | |
| Constructor. | |
| virtual | ~QgsComposerObject () |
| const QgsComposition * | composition () const |
| Returns the composition the item is attached to. | |
| QgsComposition * | composition () |
| QgsDataDefined * | dataDefinedProperty (const DataDefinedProperty property) const |
| Returns a reference to the data defined settings for one of the item's data defined properties. | |
| void | setDataDefinedProperty (const DataDefinedProperty property, const bool active, const bool useExpression, const QString &expression, const QString &field) |
| Sets parameters for a data defined property for the item. | |
Additional Inherited Members | |
| Public Types inherited from QgsComposerTable | |
| enum | HeaderHAlignment { FollowColumn, HeaderLeft, HeaderCenter, HeaderRight } |
| Public Slots inherited from QgsComposerTable | |
| virtual void | adjustFrameToSize () |
| Adapts the size of the frame to match the content. | |
| virtual void | refreshAttributes () |
| Refreshes the attributes shown in the table by querying the vector layer for new data. | |
| Signals inherited from QgsComposerItem | |
| void | frameChanged () |
| Emitted if the item's frame style changes. | |
| void | itemRotationChanged (double newRotation) |
| Is emitted on item rotation change. | |
| void | lockChanged () |
| Emitted if the item's lock status changes. | |
| void | sizeChanged () |
| Emitted if the rectangle changes. | |
| Protected Member Functions inherited from QgsComposerTable | |
| void | adaptItemFrame (const QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps) |
| Adapts the size of the item frame to match the table's content. | |
| virtual bool | calculateMaxColumnWidths (QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps) const |
| Calculates the maximum width of text shown in columns. | |
| void | drawHorizontalGridLines (QPainter *p, int nAttributes) |
| Draws the horizontal grid lines for the table. | |
| void | drawVerticalGridLines (QPainter *p, const QMap< int, double > &maxWidthMap) |
| Draws the vertical grid lines for the table. | |
| bool | tableReadXML (const QDomElement &itemElem, const QDomDocument &doc) |
| Reads the table's common properties from xml. | |
| bool | tableWriteXML (QDomElement &itemElem, QDomDocument &doc) const |
| Writes common table properties to xml for storage. | |
| Protected Attributes inherited from QgsComposerTable | |
| QList< QgsAttributeMap > | mAttributeMaps |
| QList< QgsComposerTableColumn * > | mColumns |
| QFont | mContentFont |
| QColor | mContentFontColor |
| QColor | mGridColor |
| double | mGridStrokeWidth |
| QFont | mHeaderFont |
| QColor | mHeaderFontColor |
| HeaderHAlignment | mHeaderHAlignment |
| double | mLineTextDistance |
| Distance between table lines and text. | |
| QMap< int, double > | mMaxColumnWidthMap |
| bool | mShowGrid |
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.
|
overridevirtual |
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.
|
overridevirtual |
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.
| 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.
|
inlineoverridevirtual |
return correct graphics item type.
Reimplemented from QgsComposerTable.
Definition at line 31 of file qgscomposertexttable.h.
|
overridevirtual |
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.
1.8.1.2