|
QGIS API Documentation
2.12.0-Lyon
|
A text table item that reads text from string lists. More...
#include <qgscomposertexttable.h>
Public Member Functions | |
| QgsComposerTextTableV2 (QgsComposition *c, bool createUndoCommands) | |
| ~QgsComposerTextTableV2 () | |
| virtual void | addFrame (QgsComposerFrame *frame, bool recalcFrameSizes=true) override |
| Adds a frame to the multiframe. More... | |
| void | addRow (const QStringList &row) |
| Adds a row to the table. More... | |
| bool | getTableContents (QgsComposerTableContents &contents) override |
| Fetches the contents used for the cells in the table. More... | |
| void | setContents (const QList< QStringList > &contents) |
| Sets the contents of the text table. More... | |
 Public Member Functions inherited from QgsComposerTableV2 | |
| QgsComposerTableV2 (QgsComposition *composition, bool createUndoCommands) | |
| QgsComposerTableV2 () | |
| virtual | ~QgsComposerTableV2 () |
| QColor | backgroundColor () const |
| Returns the color used for the background of the table. More... | |
| double | cellMargin () const |
| Returns the margin distance between cell borders and their contents. More... | |
| const QgsComposerTableStyle * | cellStyle (CellStyleGroup group) const |
| Returns the cell style for a cell group. More... | |
| QgsComposerTableColumns * | columns () |
| Returns a pointer to the list of QgsComposerTableColumns shown in the table. More... | |
| QFont | contentFont () const |
| Returns the font used to draw text in table body cells. More... | |
| QColor | contentFontColor () const |
| Returns the color used to draw text in table body cells. More... | |
| QgsComposerTableContents * | contents () |
| Returns the current contents of the table. More... | |
| EmptyTableMode | emptyTableBehaviour () const |
| Returns the behaviour mode for empty tables. More... | |
| QString | emptyTableMessage () const |
| Returns the message for empty tables with no content rows. More... | |
| virtual QSizeF | fixedFrameSize (const int frameIndex=-1) const override |
| Returns the fixed size for a frame, if desired. More... | |
| QColor | gridColor () const |
| Returns the color used for grid lines in the table. More... | |
| double | gridStrokeWidth () const |
| Returns the width of grid lines in the table. More... | |
| QFont | headerFont () const |
| Returns the font used to draw header text in the table. More... | |
| QColor | headerFontColor () const |
| Returns the color used to draw header text in the table. More... | |
| HeaderHAlignment | headerHAlignment () const |
| Returns the horizontal alignment for table headers. More... | |
| virtual QMap< int, QString > | headerLabels () const |
| Returns the text used in the column headers for the table. More... | |
| HeaderMode | headerMode () const |
| Returns the display mode for headers in the table. More... | |
| virtual QSizeF | minFrameSize (const int frameIndex=-1) const override |
| Returns the minimum size for a frames, if desired. More... | |
| virtual bool | readXML (const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames=false) override |
| Reads multiframe state information from a DOM element. More... | |
| virtual void | render (QPainter *p, const QRectF &renderExtent, const int frameIndex) override |
| Renders a portion of the multiframe's content into a painter. More... | |
| void | setBackgroundColor (const QColor &color) |
| Sets color used for background of table. More... | |
| void | setCellMargin (const double margin) |
| Sets the margin distance between cell borders and their contents. More... | |
| void | setCellStyle (CellStyleGroup group, const QgsComposerTableStyle &style) |
| Sets the cell style for a cell group. More... | |
| void | setColumns (const QgsComposerTableColumns &columns) |
| Replaces the columns in the table with a specified list of QgsComposerTableColumns. More... | |
| void | setContentFont (const QFont &font) |
| Sets the font used to draw text in table body cells. More... | |
| void | setContentFontColor (const QColor &color) |
| Sets the color used to draw text in table body cells. More... | |
| void | setEmptyTableBehaviour (const EmptyTableMode mode) |
| Sets the behaviour for empty tables with no content rows. More... | |
| void | setEmptyTableMessage (const QString &message) |
| Sets the message for empty tables with no content rows. More... | |
| void | setGridColor (const QColor &color) |
| Sets color used for grid lines in the table. More... | |
| void | setGridStrokeWidth (const double width) |
| Sets the width for grid lines in the table. More... | |
| void | setHeaderFont (const QFont &font) |
| Sets the font used to draw header text in the table. More... | |
| void | setHeaderFontColor (const QColor &color) |
| Sets the color used to draw header text in the table. More... | |
| void | setHeaderHAlignment (const HeaderHAlignment alignment) |
| Sets the horizontal alignment for table headers. More... | |
| void | setHeaderMode (const HeaderMode mode) |
| Sets the display mode for headers in the table. More... | |
| void | setShowEmptyRows (const bool showEmpty) |
| Sets whether empty rows should be drawn. More... | |
| void | setShowGrid (const bool showGrid) |
| Sets whether grid lines should be drawn in the table. More... | |
| void | setWrapBehaviour (WrapBehaviour behaviour) |
| Sets the wrap behaviour for the table, which controls how text within cells is automatically wrapped. More... | |
| bool | showEmptyRows () const |
| Returns whether empty rows are drawn in the table. More... | |
| bool | showGrid () const |
| Returns whether grid lines are drawn in the table. More... | |
| virtual QSizeF | totalSize () const override |
| Returns the total size of the multiframe's content. More... | |
| WrapBehaviour | wrapBehaviour () const |
| Returns the wrap behaviour for the table, which controls how text within cells is automatically wrapped. More... | |
| virtual bool | writeXML (QDomElement &elem, QDomDocument &doc, bool ignoreFrames=false) const override |
| Stores state information about multiframe in DOM element. More... | |
| Public Member Functions inherited from QgsComposerMultiFrame | |
| QgsComposerMultiFrame (QgsComposition *c, bool createUndoCommands) | |
| Construct a new multiframe item. More... | |
| virtual | ~QgsComposerMultiFrame () |
| bool | _readXML (const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames=false) |
| Restores state information about base multiframe object from a DOM element. More... | |
| bool | _writeXML (QDomElement &elem, QDomDocument &doc, bool ignoreFrames=false) const |
| Stores state information about base multiframe object in DOM element. More... | |
| QgsComposition * | composition () |
| Returns the parent composition for the multiframe. More... | |
| QgsComposerFrame * | createNewFrame (QgsComposerFrame *currentFrame, QPointF pos, QSizeF size) |
| Creates a new frame and adds it to the multi frame and composition. More... | |
| bool | createUndoCommands () const |
| Returns whether undo commands should be created for interactions with the multiframe. More... | |
| void | deleteFrames () |
| Removes and deletes all child frames. More... | |
| virtual QString | displayName () const |
| Get multiframe display name. More... | |
| virtual double | findNearbyPageBreak (double yPos) |
| Finds the optimal position to break a frame at. More... | |
| QgsComposerFrame * | frame (int i) const |
| Returns a child frame from the multiframe. More... | |
| int | frameCount () const |
| Returns the number of frames associated with this multiframe. More... | |
| int | frameIndex (QgsComposerFrame *frame) const |
| Returns the index of a frame within the multiframe. More... | |
| void | removeFrame (int i, const bool removeEmptyPages=false) |
| Removes a frame from the multiframe. More... | |
| virtual Q_DECL_DEPRECATED void | render (QPainter *p, const QRectF &renderExtent) |
| Renders a portion of the multiframe's content into a painter. More... | |
| ResizeMode | resizeMode () const |
| Returns the resize mode for the multiframe. More... | |
| void | setCreateUndoCommands (bool enabled) |
| Sets whether undo commands should be created for interactions with the multiframe. More... | |
| void | setResizeMode (ResizeMode mode) |
| Sets the resize mode for the multiframe, and recalculates frame sizes to match. More... | |
| Public Member Functions inherited from QgsComposerObject | |
| QgsComposerObject (QgsComposition *composition) | |
| Constructor. More... | |
| virtual | ~QgsComposerObject () |
| const QgsComposition * | composition () const |
| Returns the composition the item is attached to. More... | |
| QgsComposition * | composition () |
| virtual QgsExpressionContext * | createExpressionContext () const |
| Creates an expression context relating to the objects's current state. More... | |
| QStringList | customProperties () const |
| Return list of keys stored in custom properties for the object. More... | |
| QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
| Read a custom property from the object. More... | |
| QgsDataDefined * | dataDefinedProperty (const DataDefinedProperty property) const |
| Returns a reference to the data defined settings for one of the item's data defined properties. More... | |
| virtual bool | readXML (const QDomElement &itemElem, const QDomDocument &doc) |
| Sets item state from DOM element. More... | |
| void | removeCustomProperty (const QString &key) |
| Remove a custom property from the object. More... | |
| void | setCustomProperty (const QString &key, const QVariant &value) |
| Set a custom property for the object. More... | |
| 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. More... | |
| virtual bool | writeXML (QDomElement &elem, QDomDocument &doc) const |
| Stores item state in DOM element. More... | |
| Public Member Functions inherited from QObject | |
| QObject (QObject *parent) | |
| QObject (QObject *parent, const char *name) | |
| virtual | ~QObject () |
| bool | blockSignals (bool block) |
| QObject * | child (const char *objName, const char *inheritsClass, bool recursiveSearch) const |
| const QObjectList & | children () const |
| const char * | className () const |
| bool | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const |
| void | deleteLater () |
| void | destroyed (QObject *obj) |
| bool | disconnect (const QObject *receiver, const char *method) |
| bool | disconnect (const char *signal, const QObject *receiver, const char *method) |
| void | dumpObjectInfo () |
| void | dumpObjectTree () |
| QList< QByteArray > | dynamicPropertyNames () const |
| virtual bool | event (QEvent *e) |
| virtual bool | eventFilter (QObject *watched, QEvent *event) |
| T | findChild (const QString &name) const |
| QList< T > | findChildren (const QRegExp ®Exp) const |
| QList< T > | findChildren (const QString &name) const |
| bool | inherits (const char *className) const |
| void | insertChild (QObject *object) |
| void | installEventFilter (QObject *filterObj) |
| bool | isA (const char *className) const |
| bool | isWidgetType () const |
| void | killTimer (int id) |
| virtual const QMetaObject * | metaObject () const |
| void | moveToThread (QThread *targetThread) |
| const char * | name () const |
| const char * | name (const char *defaultName) const |
| QString | objectName () const |
| QObject * | parent () const |
| QVariant | property (const char *name) const |
| void | removeChild (QObject *object) |
| void | removeEventFilter (QObject *obj) |
| void | setName (const char *name) |
| void | setObjectName (const QString &name) |
| void | setParent (QObject *parent) |
| bool | setProperty (const char *name, const QVariant &value) |
| bool | signalsBlocked () const |
| int | startTimer (int interval) |
| QThread * | thread () const |
Additional Inherited Members | |
| Public Types inherited from QgsComposerTableV2 | |
| enum | CellStyleGroup { OddColumns, EvenColumns, OddRows, EvenRows, FirstColumn, LastColumn, HeaderRow, FirstRow, LastRow } |
| Row or column groups for cell styling. More... | |
| enum | EmptyTableMode { HeadersOnly = 0, HideTable, ShowMessage } |
| Controls how empty tables are displayed. More... | |
| enum | HeaderHAlignment { FollowColumn, HeaderLeft, HeaderCenter, HeaderRight } |
| Controls how headers are horizontally aligned in a table. More... | |
| enum | HeaderMode { FirstFrame = 0, AllFrames, NoHeaders } |
| Controls where headers are shown in the table. More... | |
| enum | WrapBehaviour { TruncateText = 0, WrapText } |
| Controls how long strings in the table are handled. More... | |
| Public Types inherited from QgsComposerMultiFrame | |
| enum | ResizeMode { UseExistingFrames = 0, ExtendToNextPage, RepeatOnEveryPage, RepeatUntilFinished } |
| Specifies the behaviour for creating new frames to fit the multiframe's content. More... | |
| Public Types inherited from QgsComposerObject | |
| enum | DataDefinedProperty { NoProperty = 0, AllProperties, TestProperty, PresetPaperSize, PaperWidth, PaperHeight, NumPages, PaperOrientation, PageNumber, PositionX, PositionY, ItemWidth, ItemHeight, ItemRotation, Transparency, BlendMode, ExcludeFromExports, MapRotation, MapScale, MapXMin, MapYMin, MapXMax, MapYMax, MapAtlasMargin, MapLayers, MapStylePreset, PictureSource, SourceUrl } |
| Data defined properties for different item types. More... | |
| enum | PropertyValueType { EvaluatedValue = 0, OriginalValue } |
| Specifies whether the value returned by a function should be the original, user set value, or the current evaluated value for the property. More... | |
| Public Slots inherited from QgsComposerTableV2 | |
| void | recalculateFrameSizes () override |
| virtual void | refreshAttributes () |
| Refreshes the contents shown in the table by querying for new data. More... | |
| Public Slots inherited from QgsComposerMultiFrame | |
| void | recalculateFrameRects () |
| Forces a recalculation of all the associated frame's scene rectangles. More... | |
| virtual void | recalculateFrameSizes () |
| Recalculates the portion of the multiframe item which is shown in each of it's component frames. More... | |
| void | update () |
| Forces a redraw of all child frames. More... | |
| Public Slots inherited from QgsComposerObject | |
| virtual void | refreshDataDefinedProperty (const DataDefinedProperty property=AllProperties, const QgsExpressionContext *context=0) |
| Refreshes a data defined property for the item by reevaluating the property's value and redrawing the item with this new value. More... | |
| virtual void | repaint () |
| Triggers a redraw for the item. More... | |
| Signals inherited from QgsComposerMultiFrame | |
| void | changed () |
| Emitted when the properties of a multi frame have changed, and the GUI item widget must be updated. More... | |
| void | contentsChanged () |
| Emitted when the contents of the multi frame have changed and the frames must be redrawn. More... | |
| Signals inherited from QgsComposerObject | |
| void | itemChanged () |
| Emitted when the item changes. More... | |
| Static Public Member Functions inherited from QObject | |
| bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
| bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
| bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
| bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
| QString | tr (const char *sourceText, const char *disambiguation, int n) |
| QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
| Protected Slots inherited from QgsComposerMultiFrame | |
| void | handleFrameRemoval (QgsComposerItem *item) |
| Called before a frame is going to be removed. More... | |
| void | handlePageChange () |
| Adapts to changed number of composition pages if resize type is RepeatOnEveryPage. More... | |
| Protected Member Functions inherited from QgsComposerTableV2 | |
| virtual bool | calculateMaxColumnWidths () |
| Calculates the maximum width of text shown in columns. More... | |
| virtual bool | calculateMaxRowHeights () |
| Calculates the maximum height of text shown in rows. More... | |
| bool | contentsContainsRow (const QgsComposerTableContents &contents, const QgsComposerTableRow &row) const |
| Checks whether a table contents contains a given row. More... | |
| void | drawHorizontalGridLines (QPainter *painter, int firstRow, int lastRow, bool drawHeaderLines) const |
| Draws the horizontal grid lines for the table. More... | |
| Q_DECL_DEPRECATED void | drawHorizontalGridLines (QPainter *painter, const int rows, const bool drawHeaderLines) const |
| Draws the horizontal grid lines for the table. More... | |
| void | drawVerticalGridLines (QPainter *painter, const QMap< int, double > &maxWidthMap, int firstRow, int lastRow, bool hasHeader, bool mergeCells=false) const |
| Draws the vertical grid lines for the table. More... | |
| Q_DECL_DEPRECATED void | drawVerticalGridLines (QPainter *painter, const QMap< int, double > &maxWidthMap, const int numberRows, const bool hasHeader, const bool mergeCells=false) const |
| Draws the vertical grid lines for the table. More... | |
| void | recalculateTableSize () |
| Recalculates and updates the size of the table and all table frames. More... | |
| QPair< int, int > | rowRange (const int frameIndex) const |
| Calculates a range of rows which should be visible in a given frame. More... | |
| Q_DECL_DEPRECATED QPair< int, int > | rowRange (const QRectF &extent, const int frameIndex) const |
| Calculates a range of rows which should be visible in a given frame extent. More... | |
| int | rowsVisible (double frameHeight, int firstRow, bool includeHeader, bool includeEmptyRows) const |
| Calculates how many content rows would be visible within a frame of the specified height. More... | |
| int | rowsVisible (int frameIndex, int firstRow, bool includeEmptyRows) const |
| Calculates how many content rows are visible within a given frame. More... | |
| Q_DECL_DEPRECATED int | rowsVisible (const int frameIndex) const |
| Calculates how many content rows are visible within a given frame. More... | |
| Q_DECL_DEPRECATED int | rowsVisible (const double frameHeight, const bool includeHeader) const |
| Calculates how many content rows would be visible within a specified height. More... | |
| double | totalHeight () |
| Returns total height of table contents. More... | |
| double | totalWidth () |
| Returns total width of table contents. More... | |
| Protected Member Functions inherited from QgsComposerObject | |
| bool | dataDefinedEvaluate (const QgsComposerObject::DataDefinedProperty property, QVariant &expressionValue, const QgsExpressionContext &context=QgsExpressionContext()) const |
| Evaluate a data defined property and return the calculated value. More... | |
| Protected Member Functions inherited from QObject | |
| bool | checkConnectArgs (const char *signal, const QObject *object, const char *method) |
| virtual void | childEvent (QChildEvent *event) |
| virtual void | connectNotify (const char *signal) |
| virtual void | customEvent (QEvent *event) |
| virtual void | disconnectNotify (const char *signal) |
| int | receivers (const char *signal) const |
| QObject * | sender () const |
| int | senderSignalIndex () const |
| virtual void | timerEvent (QTimerEvent *event) |
| Static Protected Member Functions inherited from QObject | |
| QByteArray | normalizeSignalSlot (const char *signalSlot) |
| Protected Attributes inherited from QgsComposerTableV2 | |
| QColor | mBackgroundColor |
| Color for table background. More... | |
| double | mCellMargin |
| Margin between cell borders and cell text. More... | |
| QMap< CellStyleGroup, QgsComposerTableStyle * > | mCellStyles |
| QgsComposerTableColumns | mColumns |
| Columns to show in table. More... | |
| QFont | mContentFont |
| Table contents font. More... | |
| QColor | mContentFontColor |
| Table contents font color. More... | |
| QString | mEmptyTableMessage |
| String to show in empty tables. More... | |
| EmptyTableMode | mEmptyTableMode |
| Behaviour for empty tables. More... | |
| QColor | mGridColor |
| Color for grid lines. More... | |
| double | mGridStrokeWidth |
| Width of grid lines. More... | |
| QFont | mHeaderFont |
| Header font. More... | |
| QColor | mHeaderFontColor |
| Header font color. More... | |
| HeaderHAlignment | mHeaderHAlignment |
| Alignment for table headers. More... | |
| HeaderMode | mHeaderMode |
| Header display mode. More... | |
| QMap< int, double > | mMaxColumnWidthMap |
| Map of maximum width for each column. More... | |
| QMap< int, double > | mMaxRowHeightMap |
| Map of maximum height for each row. More... | |
| bool | mShowEmptyRows |
| True if empty rows should be shown in the table. More... | |
| bool | mShowGrid |
| True if grid should be shown. More... | |
| QgsComposerTableContents | mTableContents |
| Contents to show in table. More... | |
| QSizeF | mTableSize |
| WrapBehaviour | mWrapBehaviour |
| Protected Attributes inherited from QgsComposerMultiFrame | |
| bool | mCreateUndoCommands |
| True: creates QgsMultiFrameCommands on internal changes (e.g. More... | |
| QList< QgsComposerFrame * > | mFrameItems |
| ResizeMode | mResizeMode |
| Protected Attributes inherited from QgsComposerObject | |
| QgsComposition * | mComposition |
| QgsObjectCustomProperties | mCustomProperties |
| Custom properties for object. More... | |
| QMap< QgsComposerObject::DataDefinedProperty, QString > | mDataDefinedNames |
| Map of data defined properties for the item to string name to use when exporting item to xml. More... | |
| Properties inherited from QObject | |
| objectName | |
A text table item that reads text from string lists.
Definition at line 77 of file qgscomposertexttable.h.
| QgsComposerTextTableV2::QgsComposerTextTableV2 | ( | QgsComposition * | c, |
| bool | createUndoCommands | ||
| ) |
Definition at line 90 of file qgscomposertexttable.cpp.
| QgsComposerTextTableV2::~QgsComposerTextTableV2 | ( | ) |
Definition at line 96 of file qgscomposertexttable.cpp.
|
overridevirtual |
Adds a frame to the multiframe.
| frame | frame to add |
| recalcFrameSizes | set to true to force recalculation of all existing frame sizes |
Implements QgsComposerMultiFrame.
Definition at line 140 of file qgscomposertexttable.cpp.
| void QgsComposerTextTableV2::addRow | ( | const QStringList & | row | ) |
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 101 of file qgscomposertexttable.cpp.
|
overridevirtual |
Fetches the contents used for the cells in the table.
| contents | QgsComposerTableContents to store retrieved row data in |
Implements QgsComposerTableV2.
Definition at line 113 of file qgscomposertexttable.cpp.
| void QgsComposerTextTableV2::setContents | ( | const QList< QStringList > & | contents | ) |
Sets the contents of the text table.
| contents | list of table rows |
Definition at line 107 of file qgscomposertexttable.cpp.
1.8.9.1
