39 styleElem.setAttribute( QStringLiteral(
"enabled" ),
enabled );
46 enabled = ( styleElem.attribute( QStringLiteral(
"enabled" ), QStringLiteral(
"0" ) ) != QLatin1String(
"0" ) );
72 elem.setAttribute( QStringLiteral(
"cellMargin" ), QString::number(
mCellMargin ) );
73 elem.setAttribute( QStringLiteral(
"emptyTableMode" ), QString::number(
static_cast< int >(
mEmptyTableMode ) ) );
75 elem.setAttribute( QStringLiteral(
"showEmptyRows" ),
mShowEmptyRows );
77 QDomElement headerElem = doc.createElement( QStringLiteral(
"headerTextFormat" ) );
79 headerElem.appendChild( headerTextElem );
80 elem.appendChild( headerElem );
81 elem.setAttribute( QStringLiteral(
"headerHAlignment" ), QString::number(
static_cast< int >(
mHeaderHAlignment ) ) );
82 elem.setAttribute( QStringLiteral(
"headerMode" ), QString::number(
static_cast< int >(
mHeaderMode ) ) );
84 QDomElement contentElem = doc.createElement( QStringLiteral(
"contentTextFormat" ) );
86 contentElem.appendChild( contentTextElem );
87 elem.appendChild( contentElem );
88 elem.setAttribute( QStringLiteral(
"gridStrokeWidth" ), QString::number(
mGridStrokeWidth ) );
90 elem.setAttribute( QStringLiteral(
"horizontalGrid" ),
mHorizontalGrid );
91 elem.setAttribute( QStringLiteral(
"verticalGrid" ),
mVerticalGrid );
92 elem.setAttribute( QStringLiteral(
"showGrid" ),
mShowGrid );
94 elem.setAttribute( QStringLiteral(
"wrapBehavior" ), QString::number(
static_cast< int >(
mWrapBehavior ) ) );
97 QDomElement displayColumnsElem = doc.createElement( QStringLiteral(
"displayColumns" ) );
100 QDomElement columnElem = doc.createElement( QStringLiteral(
"column" ) );
101 column.writeXml( columnElem, doc );
102 displayColumnsElem.appendChild( columnElem );
104 elem.appendChild( displayColumnsElem );
106 QDomElement sortColumnsElem = doc.createElement( QStringLiteral(
"sortColumns" ) );
109 QDomElement columnElem = doc.createElement( QStringLiteral(
"column" ) );
110 column.writeXml( columnElem, doc );
111 sortColumnsElem.appendChild( columnElem );
113 elem.appendChild( sortColumnsElem );
117 QDomElement stylesElem = doc.createElement( QStringLiteral(
"cellStyles" ) );
118 QMap< CellStyleGroup, QString >::const_iterator it = mCellStyleNames.constBegin();
119 for ( ; it != mCellStyleNames.constEnd(); ++it )
121 QString styleName = it.value();
122 QDomElement styleElem = doc.createElement( styleName );
127 stylesElem.appendChild( styleElem );
130 elem.appendChild( stylesElem );
137 mEmptyTableMessage = itemElem.attribute( QStringLiteral(
"emptyTableMessage" ), tr(
"No matching records" ) );
138 mShowEmptyRows = itemElem.attribute( QStringLiteral(
"showEmptyRows" ), QStringLiteral(
"0" ) ).toInt();
140 const QDomElement
headerTextFormat = itemElem.firstChildElement( QStringLiteral(
"headerTextFormat" ) );
143 QDomNodeList textFormatNodeList =
headerTextFormat.elementsByTagName( QStringLiteral(
"text-style" ) );
144 QDomElement textFormatElem = textFormatNodeList.at( 0 ).toElement();
152 headerFont.fromString( itemElem.attribute( QStringLiteral(
"headerFont" ), QString() ) );
172 const QDomElement
contentTextFormat = itemElem.firstChildElement( QStringLiteral(
"contentTextFormat" ) );
175 QDomNodeList textFormatNodeList =
contentTextFormat.elementsByTagName( QStringLiteral(
"text-style" ) );
176 QDomElement textFormatElem = textFormatNodeList.at( 0 ).toElement();
184 contentFont.fromString( itemElem.attribute( QStringLiteral(
"contentFont" ), QString() ) );
201 mCellMargin = itemElem.attribute( QStringLiteral(
"cellMargin" ), QStringLiteral(
"1.0" ) ).toDouble();
202 mGridStrokeWidth = itemElem.attribute( QStringLiteral(
"gridStrokeWidth" ), QStringLiteral(
"0.5" ) ).toDouble();
203 mHorizontalGrid = itemElem.attribute( QStringLiteral(
"horizontalGrid" ), QStringLiteral(
"1" ) ).toInt();
204 mVerticalGrid = itemElem.attribute( QStringLiteral(
"verticalGrid" ), QStringLiteral(
"1" ) ).toInt();
205 mShowGrid = itemElem.attribute( QStringLiteral(
"showGrid" ), QStringLiteral(
"1" ) ).toInt();
212 QDomNodeList columnsList = itemElem.elementsByTagName( QStringLiteral(
"displayColumns" ) );
213 if ( !columnsList.isEmpty() )
215 QDomElement columnsElem = columnsList.at( 0 ).toElement();
216 QDomNodeList columnEntryList = columnsElem.elementsByTagName( QStringLiteral(
"column" ) );
217 for (
int i = 0; i < columnEntryList.size(); ++i )
219 QDomElement columnElem = columnEntryList.at( i ).toElement();
227 QDomNodeList sortColumnsList = itemElem.elementsByTagName( QStringLiteral(
"sortColumns" ) );
228 if ( !sortColumnsList.isEmpty() )
230 QDomElement columnsElem = sortColumnsList.at( 0 ).toElement();
231 QDomNodeList columnEntryList = columnsElem.elementsByTagName( QStringLiteral(
"column" ) );
232 for (
int i = 0; i < columnEntryList.size(); ++i )
234 QDomElement columnElem = columnEntryList.at( i ).toElement();
251 QDomNodeList stylesList = itemElem.elementsByTagName( QStringLiteral(
"cellStyles" ) );
252 if ( !stylesList.isEmpty() )
254 QDomElement stylesElem = stylesList.at( 0 ).toElement();
256 QMap< CellStyleGroup, QString >::const_iterator it = mCellStyleNames.constBegin();
257 for ( ; it != mCellStyleNames.constEnd(); ++it )
259 QString styleName = it.value();
260 QDomNodeList styleList = stylesElem.elementsByTagName( styleName );
261 if ( !styleList.isEmpty() )
263 QDomElement styleElem = styleList.at( 0 ).toElement();
289 double headerHeight = 0;
301 double contentHeight = frameHeight - headerHeight;
305 int currentRow = firstRow;
306 while ( contentHeight > 0 && currentRow <=
mTableContents.count() )
309 contentHeight -= currentRowHeight;
313 if ( includeEmptyRows && contentHeight > 0 )
317 currentRow += std::max( std::floor( contentHeight / rowHeight ), 0.0 );
320 return currentRow - firstRow - 1;
332 bool includeHeader =
false;
336 includeHeader =
true;
338 return rowsVisible( context, frameExtent.height(), firstRow, includeHeader, includeEmptyRows );
347 return qMakePair( 0, 0 );
352 int rowsAlreadyShown = 0;
355 rowsAlreadyShown +=
rowsVisible( context, idx, rowsAlreadyShown,
false );
359 int firstVisible = std::min( rowsAlreadyShown,
static_cast<int>(
mTableContents.length() ) );
361 int lastVisible = std::min( firstVisible + possibleRowsVisible,
static_cast<int>(
mTableContents.length() ) );
363 return qMakePair( firstVisible, lastVisible );
375 if ( !
mLayout->renderContext().isPreviewRender() )
400 int numberRowsToDraw = rowsToShow.second - rowsToShow.first;
401 int numberEmptyRows = 0;
405 numberEmptyRows = numberRowsToDraw - rowsToShow.second + rowsToShow.first;
407 bool mergeCells =
false;
422 p->setPen( Qt::SolidLine );
424 double currentX = gridSizeX;
425 double currentY = gridSizeY;
432 std::unique_ptr< QgsExpressionContextScope > headerCellScope = std::make_unique< QgsExpressionContextScope >();
433 headerCellScope->setVariable( QStringLiteral(
"column_number" ), col + 1,
true );
439 p->setPen( Qt::NoPen );
468 const QStringList
str = column.heading().split(
'\n' );
484 currentX += gridSizeX;
488 currentY += cellHeaderHeight;
489 currentY += gridSizeY;
494 std::set< std::pair< int, int > > spannedCells;
498 for (
int row = rowsToShow.first; row < rowsToShow.second; ++row )
501 currentX = gridSizeX;
508 bool isSpanned =
false;
511 double cellHeight = 0;
512 double cellWidth = 0;
513 const int rowsSpan =
rowSpan( row, col );
515 if ( spannedCells.find( std::make_pair( row, col ) ) != spannedCells.end() )
521 for (
int spannedRow = row; spannedRow < row + rowsSpan; ++spannedRow )
524 + ( spannedRow > row ? gridSizeY : 0 );
525 for (
int spannedCol = col; spannedCol < col + colsSpan; ++spannedCol )
527 spannedCells.insert( std::make_pair( spannedRow, spannedCol ) );
530 for (
int spannedCol = col; spannedCol < col + colsSpan; ++spannedCol )
533 + ( spannedCol > col ? gridSizeX : 0 );
537 fullCell = QRectF( currentX, currentY, cellWidth, cellHeight );
543 p->setPen( Qt::NoPen );
545 p->drawRect( fullCell );
555 const QString localizedString { QgsExpressionUtils::toLocalizedString( cellContents ) };
556 const QStringList
str = localizedString.split(
'\n' );
563 p->setClipRect( fullCell );
567 QColor foreColor = cellFormat.
color();
589 currentX += gridSizeX;
593 currentY += gridSizeY;
597 if ( numberRowsToDraw > rowsDrawn )
600 p->setPen( Qt::NoPen );
603 for (
int row = rowsDrawn; row < numberRowsToDraw; ++row )
605 currentX = gridSizeX;
611 p->drawRect( QRectF( gridSizeX, currentY,
mTableSize.width() - 2 * gridSizeX, cellBodyHeightForEmptyRows ) );
627 currentX += gridSizeX;
631 currentY += cellBodyHeightForEmptyRows + gridSizeY;
642 gridPen.setJoinStyle( Qt::MiterJoin );
643 gridPen.setCapStyle( Qt::FlatCap );
644 p->setPen( gridPen );
659 double messageY = gridSizeY + ( drawHeader ? cellHeaderHeight + gridSizeY : 0 );
660 cell = QRectF( messageX, messageY,
mTableSize.width() - messageX, cellBodyHeightForEmptyRows );
736 if ( font.pointSizeF() > 0 )
741 else if ( font.pixelSize() > 0 )
820 if ( font.pointSizeF() > 0 )
825 else if ( font.pixelSize() > 0 )
980 if ( !newSortColumns.isEmpty() )
1011 QMap<int, QString> headers;
1016 headers.insert( i, col.heading() );
1024 std::unique_ptr< QgsExpressionContextScope > cellScope = std::make_unique< QgsExpressionContextScope >();
1025 cellScope->setVariable( QStringLiteral(
"row_number" ), row + 1,
true );
1026 cellScope->setVariable( QStringLiteral(
"column_number" ), column + 1,
true );
1027 return cellScope.release();
1061 for (
int col = 0; col <
mColumns.size(); ++ col )
1066 return QSizeF( 0, height );
1088void QgsLayoutTable::initStyles()
1100 mCellStyleNames.insert(
OddColumns, QStringLiteral(
"oddColumns" ) );
1101 mCellStyleNames.insert(
EvenColumns, QStringLiteral(
"evenColumns" ) );
1102 mCellStyleNames.insert(
OddRows, QStringLiteral(
"oddRows" ) );
1103 mCellStyleNames.insert(
EvenRows, QStringLiteral(
"evenRows" ) );
1104 mCellStyleNames.insert(
FirstColumn, QStringLiteral(
"firstColumn" ) );
1105 mCellStyleNames.insert(
LastColumn, QStringLiteral(
"lastColumn" ) );
1106 mCellStyleNames.insert(
HeaderRow, QStringLiteral(
"headerRow" ) );
1107 mCellStyleNames.insert(
FirstRow, QStringLiteral(
"firstRow" ) );
1108 mCellStyleNames.insert(
LastRow, QStringLiteral(
"lastRow" ) );
1118 QVector< double > widths( cells );
1120 double currentCellTextWidth;
1129 if ( col.width() > 0 )
1132 widths[i] = col.width();
1136 std::unique_ptr< QgsExpressionContextScope > headerCellScope = std::make_unique< QgsExpressionContextScope >();
1137 headerCellScope->setVariable( QStringLiteral(
"column_number" ), i + 1,
true );
1141 const QStringList multiLineSplit = col.heading().split(
'\n' );
1143 widths[i] = currentCellTextWidth;
1153 QgsLayoutTableContents::const_iterator rowIt =
mTableContents.constBegin();
1157 QgsLayoutTableRow::const_iterator colIt = rowIt->constBegin();
1159 for ( ; colIt != rowIt->constEnd(); ++colIt )
1161 if (
mColumns.at( col ).width() <= 0 )
1164 const QStringList multiLineSplit = QgsExpressionUtils::toLocalizedString( *colIt ).split(
'\n' );
1171 widths[ row * cols + col ] = currentCellTextWidth;
1175 widths[ row * cols + col ] = 0;
1184 for (
int col = 0; col < cols; ++col )
1186 double maxColWidth = 0;
1189 maxColWidth = std::max( widths[ row * cols + col ], maxColWidth );
1204 QVector< double > heights( cells );
1213 std::unique_ptr< QgsExpressionContextScope > headerCellScope = std::make_unique< QgsExpressionContextScope >();
1214 headerCellScope->setVariable( QStringLiteral(
"column_number" ), i + 1,
true );
1240 QgsLayoutTableContents::const_iterator rowIt =
mTableContents.constBegin();
1244 QgsLayoutTableRow::const_iterator colIt = rowIt->constBegin();
1246 for ( ; colIt != rowIt->constEnd(); ++colIt )
1252 const QString localizedString { QgsExpressionUtils::toLocalizedString( *colIt ) };
1256 QStringList() << localizedString.split(
'\n' ),
1271 double maxRowHeight = 0;
1272 for (
int col = 0; col < cols; ++col )
1274 maxRowHeight = std::max( heights[ row * cols + col ], maxRowHeight );
1318 int rowsAlreadyShown = 0;
1320 int rowsVisibleInLastFrame = 0;
1321 double heightOfLastFrame = 0;
1322 for (
int idx = 0; idx < numberExistingFrames; ++idx )
1326 heightOfLastFrame =
frame( idx )->rect().height();
1327 rowsVisibleInLastFrame =
rowsVisible( context, heightOfLastFrame, rowsAlreadyShown, hasHeader,
false );
1328 rowsAlreadyShown += rowsVisibleInLastFrame;
1329 height += heightOfLastFrame;
1340 if ( remainingRows <= 0 )
1356 int numberFramesMissing = 0;
1357 while ( remainingRows > 0 )
1359 numberFramesMissing++;
1361 rowsVisibleInLastFrame =
rowsVisible( context, heightOfLastFrame, rowsAlreadyShown, hasHeader,
false );
1362 if ( rowsVisibleInLastFrame < 1 )
1369 rowsAlreadyShown += rowsVisibleInLastFrame;
1375 height += heightOfLastFrame * numberFramesMissing;
1382 if ( lastRow - firstRow < 1 && !drawHeaderLines )
1391 double currentY = halfGridStrokeWidth;
1392 if ( drawHeaderLines )
1394 painter->drawLine( QPointF( 0, currentY ), QPointF(
mTableSize.width(), currentY ) );
1399 QHash< QPair< int, int >,
bool > skippedCellBottomBorders;
1400 for (
int row = 0; row < lastRow; ++row )
1402 for (
int col = 0; col <
mColumns.size(); ++col )
1404 if ( skippedCellBottomBorders.constFind( qMakePair( row, col ) ) != skippedCellBottomBorders.constEnd() )
1407 const int rowsSpan =
rowSpan( row, col );
1409 skippedCellBottomBorders.insert( qMakePair( row, col ), rowsSpan > 1 );
1410 for (
int rowDelta = 0; rowDelta < rowsSpan - 1; ++rowDelta )
1412 for (
int colDelta = 0; colDelta < colsSpan; ++colDelta )
1414 if ( rowDelta != 0 || colDelta != 0 )
1415 skippedCellBottomBorders.insert( qMakePair( row + rowDelta, col + colDelta ),
true );
1421 for (
int row = firstRow; row < lastRow; ++row )
1424 double endX = startX;
1426 for (
int col = 0; col <
mColumns.size(); ++col )
1430 if ( skippedCellBottomBorders.value( qMakePair( row - 1, col ) ) )
1435 painter->drawLine( QPointF( startX, currentY ), QPointF( endX, currentY ) );
1451 painter->drawLine( QPointF( startX, currentY ), QPointF( endX, currentY ) );
1458 painter->drawLine( QPointF( 0, currentY ), QPointF(
mTableSize.width(), currentY ) );
1465 if ( style->enabled && column % 2 == 0 )
1466 color = style->cellBackgroundColor;
1468 if ( style->enabled && column % 2 == 1 )
1469 color = style->cellBackgroundColor;
1471 if ( style->enabled && row % 2 == 0 )
1472 color = style->cellBackgroundColor;
1474 if ( style->enabled && row % 2 == 1 )
1475 color = style->cellBackgroundColor;
1477 if ( style->enabled && column == 0 )
1478 color = style->cellBackgroundColor;
1481 color = style->cellBackgroundColor;
1483 if ( style->enabled && row == -1 )
1484 color = style->cellBackgroundColor;
1486 if ( style->enabled && row == 0 )
1487 color = style->cellBackgroundColor;
1490 color = style->cellBackgroundColor;
1505 if ( lastRow - firstRow < 1 && !hasHeader )
1510 QHash< QPair< int, int >,
bool > skippedCellRightBorders;
1511 for (
int row = 0; row < lastRow; ++row )
1513 for (
int col = 0; col <
mColumns.size(); ++col )
1515 if ( skippedCellRightBorders.constFind( qMakePair( row, col ) ) != skippedCellRightBorders.constEnd() )
1518 const int rowsSpan =
rowSpan( row, col );
1520 skippedCellRightBorders.insert( qMakePair( row, col ), colsSpan > 1 );
1522 for (
int colDelta = 0; colDelta < colsSpan - 1; ++colDelta )
1524 for (
int rowDelta = 0; rowDelta < rowsSpan; ++rowDelta )
1526 if ( rowDelta != 0 || colDelta != 0 )
1527 skippedCellRightBorders.insert( qMakePair( row + rowDelta, col + colDelta ),
true );
1536 double tableHeight = 0;
1537 QList< double > rowHeights;
1548 double headerHeight = tableHeight;
1551 for (
int row = firstRow; row < lastRow; ++row )
1560 painter->drawLine( QPointF( currentX, 0 ), QPointF( currentX, tableHeight ) );
1562 QMap<int, double>::const_iterator maxColWidthIt = maxWidthMap.constBegin();
1564 for ( ; maxColWidthIt != maxWidthMap.constEnd(); ++maxColWidthIt )
1566 currentX += ( maxColWidthIt.value() + 2 *
mCellMargin );
1567 if ( col == maxWidthMap.size() )
1570 painter->drawLine( QPointF( currentX, 0 ), QPointF( currentX, tableHeight ) );
1578 for (
int row = firstRow; row < lastRow; ++row )
1580 const double rowHeight = rowHeights.value( row - firstRow + 1 );
1581 if ( skippedCellRightBorders.value( qMakePair( row, col - 1 ) ) )
1586 painter->drawLine( QPointF( currentX, startY ), QPointF( currentX, endY ) );
1602 painter->drawLine( QPointF( currentX, startY ), QPointF( currentX, endY ) );
1605 else if ( hasHeader )
1607 painter->drawLine( QPointF( currentX, 0 ), QPointF( currentX, headerHeight ) );
1627 return (
contents.indexOf( row ) >= 0 );
1642 return mColumns.value( column ).hAlignment();
1647 return mColumns.value( column ).vAlignment();
@ Rectangle
Text within rectangle layout mode.
QFlags< TextRendererFlag > TextRendererFlags
@ Millimeters
Millimeters.
@ Points
Points (e.g., for font sizes)
@ ApplyScalingWorkaroundForTextRendering
Whether a scaling workaround designed to stablise the rendering of small font sizes (or for painters ...
@ VerticalCenter
Center align.
TextHorizontalAlignment
Text horizontal alignment.
@ WrapLines
Automatically wrap long lines of text.
static QColor colorFromString(const QString &string)
Decodes a string into a color value.
static QString colorToString(const QColor &color)
Encodes a color into a string value.
Conditional styling for a rule.
QColor backgroundColor() const
The background color for style.
QColor textColor() const
The text color set for style.
RAII class to pop scope from an expression context on destruction.
Single scope for storing variables and functions for use within a QgsExpressionContext.
static bool setFromXmlChildNode(QFont &font, const QDomElement &element, const QString &childNode)
Sets the properties of a font to match the properties stored in an XML child node.
QRectF extent() const
Returns the visible portion of the multi frame's content which is shown in this frame,...
Item representing the paper in a layout.
Contains settings and helpers relating to a render of a QgsLayoutItem.
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
QgsLayoutSize sizeWithUnits() const
Returns the item's current size, including units.
int page() const
Returns the page the item is currently on, with the first page returning 0.
Abstract base class for layout items with the ability to distribute the content to several frames (Qg...
int frameCount() const
Returns the number of frames associated with this multiframe.
QgsLayoutFrame * frame(int index) const
Returns the child frame at a specified index from the multiframe.
@ ExtendToNextPage
Creates new full page frames on the following page(s) until the entire multiframe content is visible.
void refresh() override
Refreshes the multiframe, causing a recalculation of any property overrides.
virtual void recalculateFrameSizes()
Recalculates the portion of the multiframe item which is shown in each of its component frames.
void update()
Forces a redraw of all child frames.
int frameIndex(QgsLayoutFrame *frame) const
Returns the index of a frame within the multiframe.
void recalculateFrameRects()
Forces a recalculation of all the associated frame's scene rectangles.
void changed()
Emitted when the object's properties change.
QPointer< QgsLayout > mLayout
double height() const
Returns the height of the size.
Stores properties of a column for a QgsLayoutTable.
bool readXml(const QDomElement &columnElem)
Reads the column's properties from xml.
Styling option for a layout table cell.
bool readXml(const QDomElement &styleElem)
Reads the style's properties from XML.
QColor cellBackgroundColor
Cell background color.
bool enabled
Whether the styling option is enabled.
bool writeXml(QDomElement &styleElem, QDomDocument &doc) const
Writes the style's properties to XML for storage.
bool mHorizontalGrid
True if grid should be shown.
QSizeF fixedFrameSize(int frameIndex=-1) const override
Returns the fixed size for a frame, if desired.
QgsLayoutTableColumns & columns()
Returns a reference to the list of QgsLayoutTableColumns shown in the table.
void setColumns(const QgsLayoutTableColumns &columns)
Replaces the columns in the table with a specified list of QgsLayoutTableColumns.
Q_DECL_DEPRECATED void setHeaderFontColor(const QColor &color)
Sets the color used to draw header text in the table.
QgsLayoutTable(QgsLayout *layout)
Constructor for QgsLayoutTable, belonging to the specified layout.
virtual Qt::Alignment horizontalAlignmentForCell(int row, int column) const
Returns the horizontal alignment to use for the cell at the specified row and column.
QColor backgroundColor() const
Returns the color used for the background of the table.
virtual QgsConditionalStyle conditionalCellStyle(int row, int column) const
Returns the conditional style to use for the cell at row, column.
void setHeaderHAlignment(HeaderHAlignment alignment)
Sets the horizontal alignment for table headers.
void setShowEmptyRows(bool showEmpty)
Sets whether empty rows should be drawn.
Q_DECL_DEPRECATED QFont headerFont() const
Returns the font used to draw header text in the table.
QMap< int, double > mMaxColumnWidthMap
Map of maximum width for each column.
void setVerticalGrid(bool verticalGrid)
Sets whether the grid's vertical lines should be drawn in the table.
virtual void refreshAttributes()
Refreshes the contents shown in the table by querying for new data.
void setGridColor(const QColor &color)
Sets the color used for grid lines in the table.
double totalWidth()
Returns total width of table contents.
bool horizontalGrid() const
Returns whether the grid's horizontal lines are drawn in the table.
Q_DECL_DEPRECATED void setContentFontColor(const QColor &color)
Sets the color used to draw text in table body cells.
void setCellMargin(double margin)
Sets the margin distance in mm between cell borders and their contents.
void render(QgsLayoutItemRenderContext &context, const QRectF &renderExtent, int frameIndex) override
Renders a portion of the multiframe's content into a render context.
Q_DECL_DEPRECATED void setHeaderFont(const QFont &font)
Sets the font used to draw header text in 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.
QgsLayoutTableSortColumns & sortColumns()
Returns a reference to the list of QgsLayoutTableSortColumns shown in the table.
void setBackgroundColor(const QColor &color)
Sets the color used for background of table.
void setContentTextFormat(const QgsTextFormat &format)
Sets the format used to draw content text in the table.
QgsTextFormat contentTextFormat() const
Returns the format used to draw content text in the table.
QString mEmptyTableMessage
String to show in empty tables.
virtual int rowSpan(int row, int column) const
Returns the row span for the cell a row, column.
void setWrapBehavior(WrapBehavior behavior)
Sets the wrap behavior for the table, which controls how text within cells is automatically wrapped.
Q_DECL_DEPRECATED QColor headerFontColor() const
Returns the color used to draw header text in the table.
QPair< int, int > rowRange(QgsRenderContext &context, int frameIndex) const
Calculates a range of rows which should be visible in a given frame.
double mGridStrokeWidth
Width of grid lines.
EmptyTableMode mEmptyTableMode
Behavior for empty tables.
void setEmptyTableBehavior(EmptyTableMode mode)
Sets the behavior mode for empty tables with no content rows.
virtual QgsTextFormat textFormatForHeader(int column) const
Returns the text format to use for the header cell at the specified column.
void setHeaderMode(HeaderMode mode)
Sets the display mode for headers in the table.
Q_DECL_DEPRECATED void setContentFont(const QFont &font)
Sets the font used to draw text in table body cells.
WrapBehavior mWrapBehavior
bool verticalGrid() const
Returns whether the grid's vertical lines are drawn in the table.
QColor mBackgroundColor
Color for table background.
void recalculateTableSize()
Recalculates and updates the size of the table and all table frames.
void drawHorizontalGridLines(QgsLayoutItemRenderContext &context, int firstRow, int lastRow, bool drawHeaderLines) const
Draws the horizontal grid lines for the table.
virtual QgsExpressionContextScope * scopeForCell(int row, int column) const
Creates a new QgsExpressionContextScope for the cell at row, column.
Q_DECL_DEPRECATED QFont contentFont() const
Returns the font used to draw text in table body cells.
bool contentsContainsRow(const QgsLayoutTableContents &contents, const QgsLayoutTableRow &row) const
Checks whether a table contents contains a given row.
bool mShowGrid
True if grid should be shown.
CellStyleGroup
Row or column groups for cell styling.
@ FirstRow
Style first row only.
@ EvenColumns
Style even numbered columns.
@ EvenRows
Style even numbered rows.
@ HeaderRow
Style header row.
@ OddColumns
Style odd numbered columns.
@ FirstColumn
Style first column only.
@ LastColumn
Style last column only.
@ LastRow
Style last row only.
@ OddRows
Style odd numbered rows.
QgsTextFormat mHeaderTextFormat
void setHorizontalGrid(bool horizontalGrid)
Sets whether the grid's horizontal lines should be drawn in the table.
HeaderMode
Controls where headers are shown in the table.
@ FirstFrame
Header shown on first frame only.
@ AllFrames
Headers shown on all frames.
@ NoHeaders
No headers shown for table.
void setCellStyle(CellStyleGroup group, const QgsLayoutTableStyle &style)
Sets the cell style for a cell group.
QgsLayoutTableColumns mColumns
Columns to show in table.
const QgsLayoutTableStyle * cellStyle(CellStyleGroup group) const
Returns the cell style for a cell group.
void setShowGrid(bool showGrid)
Sets whether grid lines should be drawn in the table.
QgsTextFormat mContentTextFormat
virtual bool getTableContents(QgsLayoutTableContents &contents)=0
Fetches the contents used for the cells in the table.
virtual bool calculateMaxColumnWidths()
Calculates the maximum width of text shown in columns.
~QgsLayoutTable() override
QgsTextFormat headerTextFormat() const
Returns the format used to draw header text in the table.
HeaderMode mHeaderMode
Header display mode.
HeaderHAlignment mHeaderHAlignment
Alignment for table headers.
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.
void recalculateFrameSizes() override
bool mShowEmptyRows
True if empty rows should be shown in the table.
QColor mGridColor
Color for grid lines.
QSizeF minFrameSize(int frameIndex=-1) const override
Returns the minimum size for a frames, if desired.
double mCellMargin
Margin between cell borders and cell text.
virtual Qt::Alignment verticalAlignmentForCell(int row, int column) const
Returns the vertical alignment to use for the cell at the specified row and column.
Q_DECL_DEPRECATED QColor contentFontColor() const
Returns the color used to draw text in table body cells.
double totalHeight()
Returns total height of table contents.
QgsLayoutTableContents mTableContents
Contents to show in table.
bool writePropertiesToElement(QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override
Stores multiframe state within an XML DOM element.
void setEmptyTableMessage(const QString &message)
Sets the message for empty tables with no content rows.
virtual int columnSpan(int row, int column) const
Returns the column span for the cell a row, column.
void setSortColumns(const QgsLayoutTableSortColumns &sortColumns)
Replaces the sorting columns in the table with a specified list of QgsLayoutTableSortColumns.
void setHeaderTextFormat(const QgsTextFormat &format)
Sets the format used to draw header text in the table.
QgsLayoutTableSortColumns mSortColumns
Columns to sort the table.
bool showGrid() const
Returns whether grid lines are drawn in the table.
virtual QMap< int, QString > headerLabels() const
Returns the text used in the column headers for the table.
void setGridStrokeWidth(double width)
Sets the width in mm for grid lines in the table.
virtual QgsTextFormat textFormatForCell(int row, int column) const
Returns the text format to use for the cell at the specified row and column.
bool readPropertiesFromElement(const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context) override
Sets multiframe state from a DOM element.
QgsLayoutTableContents & contents()
Returns the current contents of the table.
QSizeF totalSize() const override
Returns the total size of the multiframe's content, in layout units.
bool mVerticalGrid
True if grid should be shown.
virtual bool calculateMaxRowHeights()
Calculates the maximum height of text shown in rows.
WrapBehavior
Controls how long strings in the table are handled.
@ WrapText
Text which doesn't fit inside the cell is wrapped. Note that this only applies to text in columns wit...
HeaderHAlignment
Controls how headers are horizontally aligned in a table.
@ HeaderRight
Align headers right.
@ HeaderLeft
Align headers left.
@ HeaderCenter
Align headers to center.
@ FollowColumn
Header uses the same alignment as the column.
EmptyTableMode
Controls how empty tables are displayed.
@ HideTable
Hides entire table if empty.
@ ShowMessage
Shows preset message instead of table contents.
QMap< int, double > mMaxRowHeightMap
Map of maximum height for each row.
QMap< CellStyleGroup, QgsLayoutTableStyle * > mCellStyles
static QgsRenderContext createRenderContextForLayout(QgsLayout *layout, QPainter *painter, double dpi=-1)
Creates a render context suitable for the specified layout and painter destination.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
double scaleFactor() const
Returns the scaling factor for the render to convert painter units to physical sizes.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
QPainter * painter()
Returns the destination QPainter for the render operation.
QgsExpressionContext & expressionContext()
Gets the expression context.
bool testFlag(Qgis::RenderContextFlag flag) const
Check whether a particular flag is enabled.
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
Scoped object for saving and restoring a QPainter object's state.
Scoped object for temporary scaling of a QgsRenderContext for pixel based rendering.
Container for all settings relating to text rendering.
void setColor(const QColor &color)
Sets the color that text will be rendered in.
void setSize(double size)
Sets the size for rendered text.
void setFont(const QFont &font)
Sets the font used for rendering text.
void setSizeUnit(Qgis::RenderUnit unit)
Sets the units for the size of rendered text.
void updateDataDefinedProperties(QgsRenderContext &context)
Updates the format by evaluating current values of data defined properties.
void readXml(const QDomElement &elem, const QgsReadWriteContext &context)
Read settings from a DOM element.
QFont toQFont() const
Returns a QFont matching the relevant settings from this text format.
QDomElement writeXml(QDomDocument &doc, const QgsReadWriteContext &context) const
Write settings into a DOM element.
QColor color() const
Returns the color that text will be rendered in.
static Qgis::TextVerticalAlignment convertQtVAlignment(Qt::Alignment alignment)
Converts a Qt vertical alignment flag to a Qgis::TextVerticalAlignment value.
static double textWidth(const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, QFontMetricsF *fontMetrics=nullptr)
Returns the width of a text based on a given format.
static void drawText(const QRectF &rect, double rotation, Qgis::TextHorizontalAlignment alignment, const QStringList &textLines, QgsRenderContext &context, const QgsTextFormat &format, bool drawAsOutlines=true, Qgis::TextVerticalAlignment vAlignment=Qgis::TextVerticalAlignment::Top, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags(), Qgis::TextLayoutMode mode=Qgis::TextLayoutMode::Rectangle)
Draws text within a rectangle using the specified settings.
static QFontMetricsF fontMetrics(QgsRenderContext &context, const QgsTextFormat &format, double scaleFactor=1.0)
Returns the font metrics for the given text format, when rendered in the specified render context.
static double textHeight(const QgsRenderContext &context, const QgsTextFormat &format, const QStringList &textLines, Qgis::TextLayoutMode mode=Qgis::TextLayoutMode::Point, QFontMetricsF *fontMetrics=nullptr, Qgis::TextRendererFlags flags=Qgis::TextRendererFlags(), double maxLineWidth=0)
Returns the height of a text based on a given format.
static constexpr double FONT_WORKAROUND_SCALE
Scale factor for upscaling font sizes and downscaling destination painter devices.
static Qgis::TextHorizontalAlignment convertQtHAlignment(Qt::Alignment alignment)
Converts a Qt horizontal alignment flag to a Qgis::TextHorizontalAlignment value.
QVector< QgsLayoutTableColumn > QgsLayoutTableColumns
List of column definitions for a QgsLayoutTable.
QVector< QgsLayoutTableColumn > QgsLayoutTableSortColumns
List of column definitions for sorting a QgsLayoutTable.
QVector< QgsLayoutTableRow > QgsLayoutTableContents
List of QgsLayoutTableRows, representing rows and column cell contents for a QgsLayoutTable.
QVector< QVariant > QgsLayoutTableRow
List of QVariants, representing a the contents of a single row in a QgsLayoutTable.
#define Q_NOWARN_DEPRECATED_POP
#define Q_NOWARN_DEPRECATED_PUSH
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)