QGIS API Documentation 3.41.0-Master (fda2aa46e9a)
|
A class to display a table in the print layout, and allow the table to span over multiple frames. More...
#include <qgslayouttable.h>
Public Slots | |
void | recalculateFrameSizes () override |
void | refresh () override |
virtual void | refreshAttributes () |
Refreshes the contents shown in the table by querying for new data. | |
Public Slots inherited from QgsLayoutMultiFrame | |
void | recalculateFrameRects () |
Forces a recalculation of all the associated frame's scene rectangles. | |
virtual void | recalculateFrameSizes () |
Recalculates the portion of the multiframe item which is shown in each of its component frames. | |
void | refresh () override |
Refreshes the multiframe, causing a recalculation of any property overrides. | |
virtual void | refreshDataDefinedProperty (QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::DataDefinedProperty::AllProperties) |
Refreshes a data defined property for the multi frame by reevaluating the property's value and redrawing the item with this new value. | |
void | update () |
Forces a redraw of all child frames. | |
Public Slots inherited from QgsLayoutObject | |
virtual void | refresh () |
Refreshes the object, causing a recalculation of any property overrides. | |
Public Member Functions | |
QgsLayoutTable (QgsLayout *layout) | |
Constructor for QgsLayoutTable, belonging to the specified layout. | |
~QgsLayoutTable () override | |
QColor | backgroundColor () const |
Returns the color used for the background of the table. | |
double | cellMargin () const |
Returns the margin distance between cell borders and their contents in mm. | |
const QgsLayoutTableStyle * | cellStyle (CellStyleGroup group) const |
Returns the cell style for a cell group. | |
QgsLayoutTableColumns & | columns () |
Returns a reference to the list of QgsLayoutTableColumns shown in the table. | |
virtual int | columnSpan (int row, int column) const |
Returns the column span for the cell a row, column. | |
virtual QgsConditionalStyle | conditionalCellStyle (int row, int column) const |
Returns the conditional style to use for the cell at row, column. | |
Q_DECL_DEPRECATED QFont | contentFont () const |
Returns the font used to draw text in table body cells. | |
Q_DECL_DEPRECATED QColor | contentFontColor () const |
Returns the color used to draw text in table body cells. | |
QgsLayoutTableContents & | contents () |
Returns the current contents of the table. | |
QgsTextFormat | contentTextFormat () const |
Returns the format used to draw content text in the table. | |
EmptyTableMode | emptyTableBehavior () const |
Returns the behavior mode for empty tables. | |
QString | emptyTableMessage () const |
Returns the message for empty tables with no content rows. | |
QSizeF | fixedFrameSize (int frameIndex=-1) const override |
Returns the fixed size for a frame, if desired. | |
virtual bool | getTableContents (QgsLayoutTableContents &contents)=0 |
Fetches the contents used for the cells in the table. | |
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 in mm. | |
Q_DECL_DEPRECATED QFont | headerFont () const |
Returns the font used to draw header text in the table. | |
Q_DECL_DEPRECATED 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. | |
HeaderMode | headerMode () const |
Returns the display mode for headers in the table. | |
QgsTextFormat | headerTextFormat () const |
Returns the format used to draw header text in the table. | |
bool | horizontalGrid () const |
Returns whether the grid's horizontal lines are drawn in the table. | |
QSizeF | minFrameSize (int frameIndex=-1) const override |
Returns the minimum size for a frames, if desired. | |
bool | readPropertiesFromElement (const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context) override |
Sets multiframe state from a DOM element. | |
void | render (QgsLayoutItemRenderContext &context, const QRectF &renderExtent, int frameIndex) override |
Renders a portion of the multiframe's content into a render context. | |
virtual int | rowSpan (int row, int column) const |
Returns the row span for the cell a row, column. | |
virtual QgsExpressionContextScope * | scopeForCell (int row, int column) const |
Creates a new QgsExpressionContextScope for the cell at row, column. | |
void | setBackgroundColor (const QColor &color) |
Sets the color used for background of table. | |
void | setCellMargin (double margin) |
Sets the margin distance in mm between cell borders and their contents. | |
void | setCellStyle (CellStyleGroup group, const QgsLayoutTableStyle &style) |
Sets the cell style for a cell group. | |
void | setColumns (const QgsLayoutTableColumns &columns) |
Replaces the columns in the table with a specified list of QgsLayoutTableColumns. | |
Q_DECL_DEPRECATED void | setContentFont (const QFont &font) |
Sets the font used to draw text in table body cells. | |
Q_DECL_DEPRECATED void | setContentFontColor (const QColor &color) |
Sets the color used to draw text in table body cells. | |
void | setContentTextFormat (const QgsTextFormat &format) |
Sets the format used to draw content text in the table. | |
void | setEmptyTableBehavior (EmptyTableMode mode) |
Sets the behavior mode for empty tables with no content rows. | |
void | setEmptyTableMessage (const QString &message) |
Sets the message for empty tables with no content rows. | |
void | setGridColor (const QColor &color) |
Sets the color used for grid lines in the table. | |
void | setGridStrokeWidth (double width) |
Sets the width in mm for grid lines in the table. | |
Q_DECL_DEPRECATED void | setHeaderFont (const QFont &font) |
Sets the font used to draw header text in the table. | |
Q_DECL_DEPRECATED void | setHeaderFontColor (const QColor &color) |
Sets the color used to draw header text in the table. | |
void | setHeaderHAlignment (HeaderHAlignment alignment) |
Sets the horizontal alignment for table headers. | |
void | setHeaderMode (HeaderMode mode) |
Sets the display mode for headers in the table. | |
void | setHeaderTextFormat (const QgsTextFormat &format) |
Sets the format used to draw header text in the table. | |
void | setHorizontalGrid (bool horizontalGrid) |
Sets whether the grid's horizontal lines should be drawn in the table. | |
void | setShowEmptyRows (bool showEmpty) |
Sets whether empty rows should be drawn. | |
void | setShowGrid (bool showGrid) |
Sets whether grid lines should be drawn in the table. | |
void | setSortColumns (const QgsLayoutTableSortColumns &sortColumns) |
Replaces the sorting columns in the table with a specified list of QgsLayoutTableSortColumns. | |
void | setVerticalGrid (bool verticalGrid) |
Sets whether the grid's vertical lines should be drawn in the table. | |
void | setWrapBehavior (WrapBehavior behavior) |
Sets the wrap behavior for the table, which controls how text within cells is automatically wrapped. | |
bool | showEmptyRows () const |
Returns whether empty rows are drawn in the table. | |
bool | showGrid () const |
Returns whether grid lines are drawn in the table. | |
QgsLayoutTableSortColumns & | sortColumns () |
Returns a reference to the list of QgsLayoutTableSortColumns shown in the table. | |
QSizeF | totalSize () const override |
Returns the total size of the multiframe's content, in layout units. | |
bool | verticalGrid () const |
Returns whether the grid's vertical lines are drawn in the table. | |
WrapBehavior | wrapBehavior () const |
Returns the wrap behavior for the table, which controls how text within cells is automatically wrapped. | |
bool | writePropertiesToElement (QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override |
Stores multiframe state within an XML DOM element. | |
Public Member Functions inherited from QgsLayoutMultiFrame | |
QgsLayoutMultiFrame (QgsLayout *layout) | |
Construct a new multiframe item, attached to the specified layout. | |
~QgsLayoutMultiFrame () override | |
virtual void | addFrame (QgsLayoutFrame *frame, bool recalcFrameSizes=true) |
Adds a frame to the multiframe. | |
void | beginCommand (const QString &commandText, UndoCommand command=UndoNone) |
Starts new undo command for this item. | |
void | cancelCommand () |
Cancels the current item command and discards it. | |
QgsAbstractLayoutUndoCommand * | createCommand (const QString &text, int id, QUndoCommand *parent=nullptr) override |
Creates a new layout undo command with the specified text and parent. | |
QgsExpressionContext | createExpressionContext () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context. | |
QgsLayoutFrame * | createNewFrame (QgsLayoutFrame *currentFrame, QPointF pos, QSizeF size) |
Creates a new frame and adds it to the multi frame and layout. | |
void | deleteFrames () |
Removes and deletes all child frames. | |
virtual QString | displayName () const |
Returns the multiframe display name. | |
void | endCommand () |
Completes the current item command and push it onto the layout's undo stack. | |
virtual void | finalizeRestoreFromXml () |
Called after all pending items have been restored from XML. | |
virtual double | findNearbyPageBreak (double yPos) |
Finds the optimal position to break a frame at. | |
QgsLayoutFrame * | frame (int index) const |
Returns the child frame at a specified index from the multiframe. | |
int | frameCount () const |
Returns the number of frames associated with this multiframe. | |
int | frameIndex (QgsLayoutFrame *frame) const |
Returns the index of a frame within the multiframe. | |
QList< QgsLayoutFrame * > | frames () const |
Returns a list of all child frames for this multiframe. | |
virtual QIcon | icon () const |
Returns the item's icon. | |
bool | readXml (const QDomElement &itemElement, const QDomDocument &document, const QgsReadWriteContext &context, bool includeFrames=false) |
Sets the item state from a DOM element. | |
void | removeFrame (int index, bool removeEmptyPages=false) |
Removes a frame by index from the multiframe. | |
ResizeMode | resizeMode () const |
Returns the resize mode for the multiframe. | |
void | setResizeMode (ResizeMode mode) |
Sets the resize mode for the multiframe, and recalculates frame sizes to match. | |
virtual int | type () const =0 |
Returns unique multiframe type id. | |
QString | uuid () const |
Returns the multiframe identification string. | |
bool | writeXml (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context, bool includeFrames=false) const |
Stores the multiframe state in a DOM element. | |
Public Member Functions inherited from QgsLayoutObject | |
QgsLayoutObject (QgsLayout *layout) | |
Constructor for QgsLayoutObject, with the specified parent layout. | |
QgsExpressionContext | createExpressionContext () const override |
Creates an expression context relating to the objects' current state. | |
QStringList | customProperties () const |
Returns list of keys stored in custom properties for the object. | |
QVariant | customProperty (const QString &key, const QVariant &defaultValue=QVariant()) const |
Read a custom property from the object. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the object's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the object's property collection, used for data defined overrides. | |
QgsLayout * | layout () |
Returns the layout the object is attached to. | |
const QgsLayout * | layout () const |
Returns the layout the object is attached to. | |
void | removeCustomProperty (const QString &key) |
Remove a custom property from the object. | |
void | setCustomProperty (const QString &key, const QVariant &value) |
Set a custom property for the object. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the objects's property collection, used for data defined overrides. | |
Public Member Functions inherited from QgsExpressionContextGenerator | |
virtual | ~QgsExpressionContextGenerator ()=default |
Public Member Functions inherited from QgsLayoutUndoObjectInterface | |
virtual | ~QgsLayoutUndoObjectInterface ()=default |
Protected Member Functions | |
virtual bool | calculateMaxColumnWidths () |
Calculates the maximum width of text shown in columns. | |
virtual bool | calculateMaxRowHeights () |
Calculates the maximum height of text shown in rows. | |
bool | contentsContainsRow (const QgsLayoutTableContents &contents, const QgsLayoutTableRow &row) const |
Checks whether a table contents contains a given row. | |
void | drawHorizontalGridLines (QgsLayoutItemRenderContext &context, int firstRow, int lastRow, bool drawHeaderLines) const |
Draws the horizontal grid lines for the table. | |
void | drawVerticalGridLines (QgsLayoutItemRenderContext &context, const QMap< int, double > &maxWidthMap, int firstRow, int lastRow, bool hasHeader, bool mergeCells=false) const |
Draws the vertical grid lines for the table. | |
virtual Qt::Alignment | horizontalAlignmentForCell (int row, int column) const |
Returns the horizontal alignment to use for the cell at the specified row and column. | |
void | recalculateTableSize () |
Recalculates and updates the size of the table and all table frames. | |
QPair< int, int > | rowRange (QgsRenderContext &context, int frameIndex) const |
Calculates a range of rows which should be visible in a given frame. | |
int | rowsVisible (QgsRenderContext &context, double frameHeight, int firstRow, bool includeHeader, bool includeEmptyRows) const |
Calculates how many content rows would be visible within a frame of the specified height. | |
int | rowsVisible (QgsRenderContext &context, int frameIndex, int firstRow, bool includeEmptyRows) const |
Calculates how many content rows are visible within a given frame. | |
virtual QgsTextFormat | textFormatForCell (int row, int column) const |
Returns the text format to use for the cell at the specified row and column. | |
virtual QgsTextFormat | textFormatForHeader (int column) const |
Returns the text format to use for the header cell at the specified column. | |
double | totalHeight () |
Returns total height of table contents. | |
double | totalWidth () |
Returns total width of table contents. | |
virtual Qt::Alignment | verticalAlignmentForCell (int row, int column) const |
Returns the vertical alignment to use for the cell at the specified row and column. | |
Protected Member Functions inherited from QgsLayoutObject | |
bool | readObjectPropertiesFromElement (const QDomElement &parentElement, const QDomDocument &document, const QgsReadWriteContext &context) |
Sets object properties from a DOM element. | |
bool | writeObjectPropertiesToElement (QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context) const |
Stores object properties within an XML DOM element. | |
Protected Attributes | |
QColor | mBackgroundColor = Qt::white |
Color for table background. | |
double | mCellMargin = 1.0 |
Margin between cell borders and cell text. | |
QMap< CellStyleGroup, QgsLayoutTableStyle * > | mCellStyles |
QgsLayoutTableColumns | mColumns |
Columns to show in table. | |
QgsTextFormat | mContentTextFormat |
QString | mEmptyTableMessage |
String to show in empty tables. | |
EmptyTableMode | mEmptyTableMode = HeadersOnly |
Behavior for empty tables. | |
QColor | mGridColor = Qt::black |
Color for grid lines. | |
double | mGridStrokeWidth = 0.5 |
Width of grid lines. | |
HeaderHAlignment | mHeaderHAlignment = FollowColumn |
Alignment for table headers. | |
HeaderMode | mHeaderMode = FirstFrame |
Header display mode. | |
QgsTextFormat | mHeaderTextFormat |
bool | mHorizontalGrid = true |
True if grid should be shown. | |
QMap< int, double > | mMaxColumnWidthMap |
Map of maximum width for each column. | |
QMap< int, double > | mMaxRowHeightMap |
Map of maximum height for each row. | |
bool | mShowEmptyRows = false |
True if empty rows should be shown in the table. | |
bool | mShowGrid = true |
True if grid should be shown. | |
QgsLayoutTableSortColumns | mSortColumns |
Columns to sort the table. | |
QgsLayoutTableContents | mTableContents |
Contents to show in table. | |
QSizeF | mTableSize |
bool | mVerticalGrid = true |
True if grid should be shown. | |
WrapBehavior | mWrapBehavior = TruncateText |
Protected Attributes inherited from QgsLayoutMultiFrame | |
QList< QgsLayoutFrame * > | mFrameItems |
ResizeMode | mResizeMode = UseExistingFrames |
Protected Attributes inherited from QgsLayoutObject | |
QgsObjectCustomProperties | mCustomProperties |
Custom properties for object. | |
QgsPropertyCollection | mDataDefinedProperties |
QPointer< QgsLayout > | mLayout |
Friends | |
class | QgsCompositionConverter |
class | TestQgsLayoutManualTable |
class | TestQgsLayoutTable |
Additional Inherited Members | |
Signals inherited from QgsLayoutMultiFrame | |
void | contentsChanged () |
Emitted when the contents of the multi frame have changed and the frames must be redrawn. | |
Signals inherited from QgsLayoutObject | |
void | changed () |
Emitted when the object's properties change. | |
Static Public Member Functions inherited from QgsLayoutObject | |
static bool | propertyAssociatesWithParentMultiframe (DataDefinedProperty property) |
Returns true if the specified property key is normally associated with the parent QgsLayoutMultiFrame object instead of a child QgsLayoutFrame object. | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the layout object property definitions. | |
A class to display a table in the print layout, and allow the table to span over multiple frames.
Definition at line 106 of file qgslayouttable.h.
Row or column groups for cell styling.
Definition at line 155 of file qgslayouttable.h.
Controls how empty tables are displayed.
Enumerator | |
---|---|
HeadersOnly | Show header rows only. |
HideTable | Hides entire table if empty. |
ShowMessage | Shows preset message instead of table contents. |
Definition at line 136 of file qgslayouttable.h.
Controls how headers are horizontally aligned in a table.
Enumerator | |
---|---|
FollowColumn | Header uses the same alignment as the column. |
HeaderLeft | Align headers left. |
HeaderCenter | Align headers to center. |
HeaderRight | Align headers right. |
Definition at line 115 of file qgslayouttable.h.
Controls where headers are shown in the table.
Enumerator | |
---|---|
FirstFrame | Header shown on first frame only. |
AllFrames | Headers shown on all frames. |
NoHeaders | No headers shown for table. |
Definition at line 126 of file qgslayouttable.h.
Controls how long strings in the table are handled.
Definition at line 146 of file qgslayouttable.h.
QgsLayoutTable::QgsLayoutTable | ( | QgsLayout * | layout | ) |
Constructor for QgsLayoutTable, belonging to the specified layout.
Definition at line 56 of file qgslayouttable.cpp.
|
override |
Definition at line 62 of file qgslayouttable.cpp.
|
inline |
Returns the color used for the background of the table.
Definition at line 456 of file qgslayouttable.h.
|
protectedvirtual |
Calculates the maximum width of text shown in columns.
Definition at line 1112 of file qgslayouttable.cpp.
|
protectedvirtual |
Calculates the maximum height of text shown in rows.
Reimplemented in QgsLayoutItemManualTable.
Definition at line 1198 of file qgslayouttable.cpp.
|
inline |
Returns the margin distance between cell borders and their contents in mm.
Definition at line 185 of file qgslayouttable.h.
const QgsLayoutTableStyle * QgsLayoutTable::cellStyle | ( | QgsLayoutTable::CellStyleGroup | group | ) | const |
Returns the cell style for a cell group.
Definition at line 1002 of file qgslayouttable.cpp.
|
inline |
Returns a reference to the list of QgsLayoutTableColumns shown in the table.
Definition at line 476 of file qgslayouttable.h.
|
virtual |
Returns the column span for the cell a row, column.
Reimplemented in QgsLayoutItemManualTable.
Definition at line 1036 of file qgslayouttable.cpp.
|
virtual |
Returns the conditional style to use for the cell at row, column.
Reimplemented in QgsLayoutItemAttributeTable, and QgsLayoutItemManualTable.
Definition at line 1041 of file qgslayouttable.cpp.
QFont QgsLayoutTable::contentFont | ( | ) | const |
Returns the font used to draw text in table body cells.
Definition at line 838 of file qgslayouttable.cpp.
QColor QgsLayoutTable::contentFontColor | ( | ) | const |
Returns the color used to draw text in table body cells.
Definition at line 856 of file qgslayouttable.cpp.
|
inline |
Returns the current contents of the table.
Excludes header cells.
Definition at line 569 of file qgslayouttable.h.
|
protected |
Checks whether a table contents contains a given row.
contents | table contents to check |
row | row to check for |
true
if contents contains rows Definition at line 1626 of file qgslayouttable.cpp.
QgsTextFormat QgsLayoutTable::contentTextFormat | ( | ) | const |
Returns the format used to draw content text in the table.
Definition at line 871 of file qgslayouttable.cpp.
|
protected |
Draws the horizontal grid lines for the table.
context | destination render context |
firstRow | index corresponding to first row shown in frame |
lastRow | index corresponding to last row shown in frame. If greater than the number of content rows in the table, then the default row height will be used for the remaining rows. |
drawHeaderLines | set to true to include for the table header |
Definition at line 1380 of file qgslayouttable.cpp.
|
protected |
Draws the vertical grid lines for the table.
context | destination render context |
maxWidthMap | QMap of int to double, where the int contains the column number and the double is the maximum width of text present in the column. |
firstRow | index corresponding to first row shown in frame |
lastRow | index corresponding to last row shown in frame. If greater than the number of content rows in the table, then the default row height will be used for the remaining rows. |
hasHeader | set to true if table frame includes header cells |
mergeCells | set to true to merge table content cells |
Definition at line 1503 of file qgslayouttable.cpp.
|
inline |
Returns the behavior mode for empty tables.
This property controls how the table is drawn if it contains no content rows.
Definition at line 198 of file qgslayouttable.h.
|
inline |
Returns the message for empty tables with no content rows.
This message is displayed in the table body if the empty table behavior is set to ShowMessage.
Definition at line 216 of file qgslayouttable.h.
|
overridevirtual |
Returns the fixed size for a frame, if desired.
If the fixed frame size changes, the sizes of all frames can be recalculated by calling recalculateFrameRects().
frameIndex | frame number |
Reimplemented from QgsLayoutMultiFrame.
Definition at line 1046 of file qgslayouttable.cpp.
|
pure virtual |
Fetches the contents used for the cells in the table.
true
if table contents were successfully retrieved. contents | QgsLayoutTableContents to store retrieved row data in |
Implemented in QgsLayoutItemAttributeTable, QgsLayoutItemManualTable, and QgsLayoutItemTextTable.
|
inline |
Returns the color used for grid lines in the table.
Definition at line 404 of file qgslayouttable.h.
|
inline |
Returns the width of grid lines in the table in mm.
Definition at line 388 of file qgslayouttable.h.
QFont QgsLayoutTable::headerFont | ( | ) | const |
Returns the font used to draw header text in the table.
Definition at line 754 of file qgslayouttable.cpp.
QColor QgsLayoutTable::headerFontColor | ( | ) | const |
Returns the color used to draw header text in the table.
Definition at line 772 of file qgslayouttable.cpp.
|
inline |
Returns the horizontal alignment for table headers.
Definition at line 291 of file qgslayouttable.h.
|
virtual |
Returns the text used in the column headers for the table.
Definition at line 1010 of file qgslayouttable.cpp.
|
inline |
Returns the display mode for headers in the table.
This property controls if and where headers are shown in the table.
Definition at line 305 of file qgslayouttable.h.
QgsTextFormat QgsLayoutTable::headerTextFormat | ( | ) | const |
Returns the format used to draw header text in the table.
Definition at line 787 of file qgslayouttable.cpp.
|
protectedvirtual |
Returns the horizontal alignment to use for the cell at the specified row and column.
Reimplemented in QgsLayoutItemManualTable.
Definition at line 1641 of file qgslayouttable.cpp.
|
inline |
Returns whether the grid's horizontal lines are drawn in the table.
Definition at line 423 of file qgslayouttable.h.
|
overridevirtual |
Returns the minimum size for a frames, if desired.
If the minimum size changes, the sizes of all frames can be recalculated by calling recalculateFrameRects().
frameIndex | frame number |
Reimplemented from QgsLayoutMultiFrame.
Definition at line 1052 of file qgslayouttable.cpp.
|
overridevirtual |
Sets multiframe state from a DOM element.
element | is the DOM element for the multiframe |
document | DOM document |
context | read write context |
Note that item subclasses should not rely on all other items being present in the layout at the time this method is called. Instead, any connections and links to other items must be made in the finalizeRestoreFromXml() method. E.g. when restoring a scalebar, the connection to the linked map's signals should be implemented in finalizeRestoreFromXml(), not readPropertiesFromElement().
Reimplemented from QgsLayoutMultiFrame.
Definition at line 135 of file qgslayouttable.cpp.
|
overrideslot |
Definition at line 1083 of file qgslayouttable.cpp.
|
protected |
Recalculates and updates the size of the table and all table frames.
Definition at line 1617 of file qgslayouttable.cpp.
|
overrideslot |
Definition at line 281 of file qgslayouttable.cpp.
|
virtualslot |
Refreshes the contents shown in the table by querying for new data.
This also causes the column widths and size of the table to change to accommodate the new data.
Definition at line 1070 of file qgslayouttable.cpp.
|
overridevirtual |
Renders a portion of the multiframe's content into a render context.
context | destination render painter |
renderExtent | visible extent of content to render into the painter. |
frameIndex | frame number for content |
Implements QgsLayoutMultiFrame.
Definition at line 367 of file qgslayouttable.cpp.
|
protected |
Calculates a range of rows which should be visible in a given frame.
context | render context |
frameIndex | index number for frame |
Definition at line 342 of file qgslayouttable.cpp.
|
virtual |
Returns the row span for the cell a row, column.
Reimplemented in QgsLayoutItemManualTable.
Definition at line 1031 of file qgslayouttable.cpp.
|
protected |
Calculates how many content rows would be visible within a frame of the specified height.
context | render context |
frameHeight | height of frame |
firstRow | index of first row visible in frame (where 0 = first row in table) |
includeHeader | set to true if frame would include a header row |
includeEmptyRows | set to true to also include rows which would be empty in the returned count. For instance, if the frame would include all table content rows and have space left for extra rows then setting this parameter to true would also include a count of these extra blank rows. |
Definition at line 287 of file qgslayouttable.cpp.
|
protected |
Calculates how many content rows are visible within a given frame.
context | render context |
frameIndex | index number for frame |
firstRow | index of first row visible in frame (where 0 = first row in table) |
includeEmptyRows | set to true to also include rows which would be empty in the returned count. For instance, if the frame would include all table content rows and have space left for extra rows then setting this parameter to true would also include a count of these extra blank rows. |
Definition at line 324 of file qgslayouttable.cpp.
|
virtual |
Creates a new QgsExpressionContextScope for the cell at row, column.
Reimplemented in QgsLayoutItemAttributeTable.
Definition at line 1023 of file qgslayouttable.cpp.
void QgsLayoutTable::setBackgroundColor | ( | const QColor & | color | ) |
Sets the color used for background of table.
Definition at line 945 of file qgslayouttable.cpp.
void QgsLayoutTable::setCellMargin | ( | double | margin | ) |
Sets the margin distance in mm between cell borders and their contents.
Definition at line 677 of file qgslayouttable.cpp.
void QgsLayoutTable::setCellStyle | ( | QgsLayoutTable::CellStyleGroup | group, |
const QgsLayoutTableStyle & | style | ||
) |
Sets the cell style for a cell group.
Definition at line 994 of file qgslayouttable.cpp.
void QgsLayoutTable::setColumns | ( | const QgsLayoutTableColumns & | columns | ) |
Replaces the columns in the table with a specified list of QgsLayoutTableColumns.
columns | list of QgsLayoutTableColumns to show in table. |
Definition at line 971 of file qgslayouttable.cpp.
void QgsLayoutTable::setContentFont | ( | const QFont & | font | ) |
Sets the font used to draw text in table body cells.
Definition at line 818 of file qgslayouttable.cpp.
void QgsLayoutTable::setContentFontColor | ( | const QColor & | color | ) |
Sets the color used to draw text in table body cells.
Definition at line 843 of file qgslayouttable.cpp.
void QgsLayoutTable::setContentTextFormat | ( | const QgsTextFormat & | format | ) |
Sets the format used to draw content text in the table.
Definition at line 861 of file qgslayouttable.cpp.
void QgsLayoutTable::setEmptyTableBehavior | ( | const QgsLayoutTable::EmptyTableMode | mode | ) |
Sets the behavior mode for empty tables with no content rows.
Definition at line 692 of file qgslayouttable.cpp.
void QgsLayoutTable::setEmptyTableMessage | ( | const QString & | message | ) |
Sets the message for empty tables with no content rows.
This message is displayed in the table body if the empty table behavior is set to ShowMessage.
Definition at line 707 of file qgslayouttable.cpp.
void QgsLayoutTable::setGridColor | ( | const QColor & | color | ) |
Sets the color used for grid lines in the table.
Definition at line 904 of file qgslayouttable.cpp.
void QgsLayoutTable::setGridStrokeWidth | ( | double | width | ) |
Sets the width in mm for grid lines in the table.
Definition at line 890 of file qgslayouttable.cpp.
void QgsLayoutTable::setHeaderFont | ( | const QFont & | font | ) |
Sets the font used to draw header text in the table.
Definition at line 734 of file qgslayouttable.cpp.
void QgsLayoutTable::setHeaderFontColor | ( | const QColor & | color | ) |
Sets the color used to draw header text in the table.
Definition at line 759 of file qgslayouttable.cpp.
void QgsLayoutTable::setHeaderHAlignment | ( | const QgsLayoutTable::HeaderHAlignment | alignment | ) |
Sets the horizontal alignment for table headers.
Definition at line 792 of file qgslayouttable.cpp.
void QgsLayoutTable::setHeaderMode | ( | const QgsLayoutTable::HeaderMode | mode | ) |
Sets the display mode for headers in the table.
This property controls if and where headers are shown in the table.
Definition at line 805 of file qgslayouttable.cpp.
void QgsLayoutTable::setHeaderTextFormat | ( | const QgsTextFormat & | format | ) |
Sets the format used to draw header text in the table.
Definition at line 777 of file qgslayouttable.cpp.
void QgsLayoutTable::setHorizontalGrid | ( | bool | horizontalGrid | ) |
Sets whether the grid's horizontal lines should be drawn in the table.
horizontalGrid | set to true to draw grid's horizontal lines |
Definition at line 917 of file qgslayouttable.cpp.
void QgsLayoutTable::setShowEmptyRows | ( | bool | showEmpty | ) |
Sets whether empty rows should be drawn.
Tables default to hiding empty rows.
showEmpty | set to true to show empty rows in the table |
Definition at line 722 of file qgslayouttable.cpp.
void QgsLayoutTable::setShowGrid | ( | bool | showGrid | ) |
Sets whether grid lines should be drawn in the table.
showGrid | set to true to show grid lines |
Definition at line 876 of file qgslayouttable.cpp.
void QgsLayoutTable::setSortColumns | ( | const QgsLayoutTableSortColumns & | sortColumns | ) |
Replaces the sorting columns in the table with a specified list of QgsLayoutTableSortColumns.
sortColumns | list of QgsLayoutTableColumns used to sort the table. |
Definition at line 989 of file qgslayouttable.cpp.
void QgsLayoutTable::setVerticalGrid | ( | bool | verticalGrid | ) |
Sets whether the grid's vertical lines should be drawn in the table.
verticalGrid | set to true to draw grid's vertical lines |
Definition at line 931 of file qgslayouttable.cpp.
void QgsLayoutTable::setWrapBehavior | ( | QgsLayoutTable::WrapBehavior | behavior | ) |
Sets the wrap behavior for the table, which controls how text within cells is automatically wrapped.
Definition at line 958 of file qgslayouttable.cpp.
|
inline |
Returns whether empty rows are drawn in the table.
Definition at line 229 of file qgslayouttable.h.
|
inline |
Returns whether grid lines are drawn in the table.
Definition at line 372 of file qgslayouttable.h.
|
inline |
Returns a reference to the list of QgsLayoutTableSortColumns shown in the table.
Definition at line 495 of file qgslayouttable.h.
|
protectedvirtual |
Returns the text format to use for the cell at the specified row and column.
Reimplemented in QgsLayoutItemAttributeTable, and QgsLayoutItemManualTable.
Definition at line 1631 of file qgslayouttable.cpp.
|
protectedvirtual |
Returns the text format to use for the header cell at the specified column.
Reimplemented in QgsLayoutItemManualTable.
Definition at line 1636 of file qgslayouttable.cpp.
|
protected |
Returns total height of table contents.
Definition at line 1304 of file qgslayouttable.cpp.
|
overridevirtual |
Returns the total size of the multiframe's content, in layout units.
Implements QgsLayoutMultiFrame.
Definition at line 276 of file qgslayouttable.cpp.
|
protected |
Returns total width of table contents.
Definition at line 1283 of file qgslayouttable.cpp.
|
protectedvirtual |
Returns the vertical alignment to use for the cell at the specified row and column.
Reimplemented in QgsLayoutItemManualTable.
Definition at line 1646 of file qgslayouttable.cpp.
|
inline |
Returns whether the grid's vertical lines are drawn in the table.
Definition at line 442 of file qgslayouttable.h.
|
inline |
Returns the wrap behavior for the table, which controls how text within cells is automatically wrapped.
Definition at line 470 of file qgslayouttable.h.
|
overridevirtual |
Stores multiframe state within an XML DOM element.
element | is the DOM element to store the multiframe's properties in |
document | DOM document |
context | read write context |
Reimplemented from QgsLayoutMultiFrame.
Definition at line 71 of file qgslayouttable.cpp.
|
friend |
Definition at line 805 of file qgslayouttable.h.
|
friend |
Definition at line 804 of file qgslayouttable.h.
|
friend |
Definition at line 803 of file qgslayouttable.h.
|
protected |
Color for table background.
Definition at line 631 of file qgslayouttable.h.
|
protected |
Margin between cell borders and cell text.
Definition at line 594 of file qgslayouttable.h.
|
protected |
Definition at line 652 of file qgslayouttable.h.
|
protected |
Columns to show in table.
Definition at line 634 of file qgslayouttable.h.
|
protected |
Definition at line 613 of file qgslayouttable.h.
|
protected |
String to show in empty tables.
Definition at line 600 of file qgslayouttable.h.
|
protected |
Behavior for empty tables.
Definition at line 597 of file qgslayouttable.h.
|
protected |
Color for grid lines.
Definition at line 622 of file qgslayouttable.h.
|
protected |
Width of grid lines.
Definition at line 619 of file qgslayouttable.h.
|
protected |
Alignment for table headers.
Definition at line 607 of file qgslayouttable.h.
|
protected |
Header display mode.
Definition at line 610 of file qgslayouttable.h.
|
protected |
Definition at line 612 of file qgslayouttable.h.
|
protected |
True if grid should be shown.
Definition at line 625 of file qgslayouttable.h.
|
protected |
Map of maximum width for each column.
Definition at line 643 of file qgslayouttable.h.
|
protected |
Map of maximum height for each row.
Definition at line 646 of file qgslayouttable.h.
|
protected |
True if empty rows should be shown in the table.
Definition at line 603 of file qgslayouttable.h.
|
protected |
True if grid should be shown.
Definition at line 616 of file qgslayouttable.h.
|
protected |
Columns to sort the table.
Definition at line 637 of file qgslayouttable.h.
|
protected |
Contents to show in table.
Definition at line 640 of file qgslayouttable.h.
|
protected |
Definition at line 648 of file qgslayouttable.h.
|
protected |
True if grid should be shown.
Definition at line 628 of file qgslayouttable.h.
|
protected |
Definition at line 650 of file qgslayouttable.h.