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

Public Member Functions

 QgsComposerTextTable (QgsComposition *c)
 ~QgsComposerTextTable ()
virtual int type () const
 return correct graphics item type.
void setHeaderLabels (const QStringList &labels)
 Sets the text to use for the header row for the table.
void addRow (const QStringList &row)
 Adds a row to the table.
bool writeXML (QDomElement &elem, QDomDocument &doc) const
 Writes properties specific to text tables.
bool readXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads the properties specific to a text table from xml.
bool getFeatureAttributes (QList< QgsAttributeMap > &attributeMaps)
 Queries the text table for text to show in the cells.
- 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)
 Sets the margin distance between cell borders and their contents.
double lineTextDistance () const
 Returns the margin distance between cell borders and their contents.
void setHeaderFont (const QFont &f)
 Sets the font used to draw header text in the table.
QFont headerFont () const
 Returns 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.
QColor headerFontColor () const
 Returns the color used to draw header text in the table.
void setHeaderHAlignment (const HeaderHAlignment alignment)
 Sets the horizontal alignment for table headers.
HeaderHAlignment headerHAlignment () const
 Returns the horizontal alignment for table headers.
void setContentFont (const QFont &f)
 Sets the font used to draw text in table body cells.
QFont contentFont () const
 Returns 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.
QColor contentFontColor () const
 Returns the color used to draw text in table body cells.
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.
void setGridStrokeWidth (double w)
 Sets the width for grid lines in the table.
double gridStrokeWidth () const
 Returns the width of grid lines in the table.
void setGridColor (const QColor &c)
 Sets color used for grid lines in the table.
QColor gridColor () const
 Returns the color used for grid lines in the table.
virtual QMap< int, QString > headerLabels () const
 Returns the text used in the column headers for the table.
QList< QgsComposerTableColumn * > * columns ()
 Returns a pointer to the list of QgsComposerTableColumns shown in the table.
void setColumns (QList< QgsComposerTableColumn * > columns)
 Replaces the columns in the table with a specified list of QgsComposerTableColumns.
- 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 bool isRemoved () const
 Returns whether this item has been removed from the composition.
void setIsRemoved (const bool removed)
 Sets whether this item has been removed from the composition.
virtual void setSelected (bool s)
 Set selected, selected item should be highlighted.
virtual bool selected () const
 Is selected.
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.
int page () const
 Gets the page the item is currently on.
QPointF pagePos () const
 Returns the item's position relative to its current page.
void updatePagePos (double newPageWidth, double newPageHeight)
 Moves the item so that it retains its relative position on the page when the paper size changes.
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.
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 (const bool drawFrame)
 Set whether this item has a frame drawn around it or not.
virtual void setFrameOutlineWidth (const double outlineWidth)
 Sets frame outline width.
double frameOutlineWidth () const
 Returns the frame's outline width.
Qt::PenJoinStyle frameJoinStyle () const
 Returns the join style used for drawing the item's frame.
void setFrameJoinStyle (const Qt::PenJoinStyle style)
 Sets join style used when drawing the item's frame.
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 (const 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 (const QPainter::CompositionMode blendMode)
 Sets the item's composition blending mode.
int transparency () const
 Returns the item's transparency.
void setTransparency (const int transparency)
 Sets the item's transparency.
bool effectsEnabled () const
 Returns whether effects (eg blend modes) are enabled for the item.
void setEffectsEnabled (const 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 ()
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 ()
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.
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.
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 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 fontHeightMillimeters (const QFont &font) const
 Returns the font height in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE.
Q_DECL_DEPRECATED double pixelFontSize (double pointSize) const
 Calculates font size in mm from a font point size.
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.
void setPositionLock (const bool lock)
 Locks / unlocks the item position for mouse drags.
bool positionLock () const
 Returns whether position lock for mouse drags is enabled returns true if item is locked for mouse movement and resizing.
double itemRotation (const QgsComposerObject::PropertyValueType valueType=QgsComposerObject::EvaluatedValue) const
 Returns the current rotation for the composer item.
Q_DECL_DEPRECATED 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.
virtual QString displayName () const
 Get item display name.
virtual void setVisibility (const bool visible)
 Sets visibility for item.
bool isGroupMember () const
 Returns whether this item is part of a group.
void setIsGroupMember (const bool isGroupMember)
 Sets whether this item is part of a group.
virtual int numberExportLayers () const
 Get the number of layers that this item requires for exporting as layers.
virtual void setCurrentExportLayer (const int layerIdx=-1)
 Sets the current layer to draw for exporting.
- Public Member Functions inherited from QgsComposerObject
 QgsComposerObject (QgsComposition *composition)
 Constructor.
virtual ~QgsComposerObject ()
const QgsCompositioncomposition () const
 Returns the composition the item is attached to.
QgsCompositioncomposition ()
QgsDataDefineddataDefinedProperty (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.

Private Attributes

QList< QStringList > mRowText
 One stringlist per row.

Additional Inherited Members

- Public Types inherited from QgsComposerTable
enum  HeaderHAlignment { FollowColumn, HeaderLeft, HeaderCenter, HeaderRight }
- Public Slots inherited from QgsComposerTable
virtual void refreshAttributes ()
 Refreshes the attributes shown in the table by querying the vector layer for new data.
virtual void adjustFrameToSize ()
 Adapts the size of the frame to match the content.
- Signals inherited from QgsComposerItem
void itemRotationChanged (double newRotation)
 Is emitted on item rotation change.
void sizeChanged ()
 Emitted if the rectangle changes.
void frameChanged ()
 Emitted if the item's frame style changes.
void lockChanged ()
 Emitted if the item's lock status changes.
- 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.
void adaptItemFrame (const QMap< int, double > &maxWidthMap, const QList< QgsAttributeMap > &attributeMaps)
 Adapts the size of the item frame to match the table's content.
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 tableWriteXML (QDomElement &itemElem, QDomDocument &doc) const
 Writes common table properties to xml for storage.
bool tableReadXML (const QDomElement &itemElem, const QDomDocument &doc)
 Reads the table's common properties from xml.
- Protected Attributes inherited from QgsComposerTable
double mLineTextDistance
 Distance between table lines and text.
QFont mHeaderFont
QColor mHeaderFontColor
QFont mContentFont
QColor mContentFontColor
HeaderHAlignment mHeaderHAlignment
bool mShowGrid
double mGridStrokeWidth
QColor mGridColor
QList< QgsAttributeMapmAttributeMaps
QMap< int, double > mMaxColumnWidthMap
QList< QgsComposerTableColumn * > mColumns

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 21 of file qgscomposertexttable.cpp.

QgsComposerTextTable::~QgsComposerTextTable ( )

Definition at line 26 of file qgscomposertexttable.cpp.

Member Function Documentation

void QgsComposerTextTable::addRow ( const QStringList &  row)
inline

Adds a row to the table.

Parameters
rowlist of strings to use for each cell's value in the newly added row
Note
If row is shorter than the number of columns in the table than blank cells will be inserted at the end of the row. If row contains more strings then the number of columns in the table then these extra strings will be ignored.

Definition at line 45 of file qgscomposertexttable.h.

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

Queries the text table for text to show in the cells.

Parameters
attributeMapslist of QgsAttributeMaps where the cell text will be stored
Returns
true if attribute values were successfully set from table's text
Note
not available in python bindings

Reimplemented from QgsComposerTable.

Definition at line 68 of file qgscomposertexttable.cpp.

References mRowText.

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

Reads the properties specific to a text table from xml.

Parameters
itemElema QDomElement holding the text table's desired properties.
docQDomDocument for the source xml.
See Also
writeXML

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.

Parameters
labelslist of strings to use for each column's header row
See Also
headerLabels

Definition at line 31 of file qgscomposertexttable.cpp.

References QgsComposerTable::mColumns, and QgsComposerTableColumn::setHeading().

virtual int QgsComposerTextTable::type ( ) const
inlinevirtual

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
virtual

Writes properties specific to text tables.

Parameters
eleman existing QDomElement in which to store the text table's properties.
docQDomDocument for the destination xml.
See Also
readXML

Implements QgsComposerTable.

Definition at line 53 of file qgscomposertexttable.cpp.

References QgsComposerItem::_writeXML().

Member Data Documentation

QList< QStringList > QgsComposerTextTable::mRowText
private

One stringlist per row.

Definition at line 70 of file qgscomposertexttable.h.

Referenced by getFeatureAttributes().


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