KD Reports API Documentation
2.2
|
#include <KDReportsCell.h>
Public Types | |
using | CellFormatFunc = std::function< void(int, int, QTextTableCellFormat &)> |
Public Member Functions | |
Cell (const Cell &other) | |
~Cell () override | |
void | addElement (const Element &element, Qt::AlignmentFlag horizontalAlignment=Qt::AlignLeft) |
void | addInlineElement (const Element &element) |
void | addVariable (VariableType variable) |
void | addVerticalSpacing (qreal space) |
void | build (ReportBuilder &builder) const override |
CellFormatFunc | cellFormatFunction () const |
Returns the function passed to setCellFormatFunction() More... | |
Element * | clone () const override |
int | columnSpan () const |
Cell & | operator= (const Cell &other) |
int | rowSpan () const |
void | setCellFormatFunction (const CellFormatFunc &func) |
Sets the function to call in order to customize the format of the cell. More... | |
void | setColumnSpan (int columnSpan) |
void | setRowSpan (int rowSpan) |
void | setVerticalAlignment (Qt::AlignmentFlag verticalAlignment) |
Set the vertical alignment of the cell contents. More... | |
Qt::AlignmentFlag | verticalAlignment () const |
Returns the vertical alignment of the cell contents. More... | |
Public Member Functions inherited from KDReports::Element | |
virtual | ~Element () |
QBrush | background () const |
void | setBackground (const QBrush &brush) |
Additional Inherited Members | |
Protected Member Functions inherited from KDReports::Element | |
Element () | |
Element (const Element &other) | |
Element & | operator= (const Element &other) |
This class presents a cell in a table. To add an element to a cell, first get hold of the right cell using Table::cell(), then add elements to it.
Definition at line 36 of file KDReportsCell.h.
using KDReports::Cell::CellFormatFunc = std::function<void(int , int , QTextTableCellFormat &)> |
Definition at line 95 of file KDReportsCell.h.
|
override |
Definition at line 46 of file KDReportsCell.cpp.
KDReports::Cell::Cell | ( | const Cell & | other | ) |
void KDReports::Cell::addElement | ( | const Element & | element, |
Qt::AlignmentFlag | horizontalAlignment = Qt::AlignLeft |
||
) |
Adds an element to the cell, creating a new paragraph for it. You can specify the alignment of that paragraph.
Definition at line 75 of file KDReportsCell.cpp.
References KDReports::Element::clone().
void KDReports::Cell::addInlineElement | ( | const Element & | element | ) |
Adds an element to the cell, next to the previous element, in the same paragraph.
Definition at line 70 of file KDReportsCell.cpp.
References KDReports::Element::clone().
void KDReports::Cell::addVariable | ( | VariableType | variable | ) |
Adds an variable in the text of the current paragraph.
Definition at line 80 of file KDReportsCell.cpp.
void KDReports::Cell::addVerticalSpacing | ( | qreal | space | ) |
Adds vertical spacing between paragraphs. Make sure to call addElement after that, not addInlineElement.
space | the space in millimeters |
Definition at line 85 of file KDReportsCell.cpp.
References KDReports::ElementData::VerticalSpacing.
|
overridevirtual |
Implements KDReports::Element.
Definition at line 110 of file KDReportsCell.cpp.
References KDReports::ReportBuilder::addBlockElement(), KDReports::ReportBuilder::addInlineElement(), KDReports::ReportBuilder::addVariable(), KDReports::ReportBuilder::addVerticalSpacing(), KDReports::ElementData::Block, KDReports::ElementData::Inline, KDReports::ElementData::m_align, KDReports::ElementData::m_element, KDReports::ElementData::m_type, KDReports::ElementData::m_value, KDReports::ElementData::m_variableType, KDReports::ElementData::Variable, and KDReports::ElementData::VerticalSpacing.
KDReports::Cell::CellFormatFunc KDReports::Cell::cellFormatFunction | ( | ) | const |
Returns the function passed to setCellFormatFunction()
Definition at line 105 of file KDReportsCell.cpp.
|
inlineoverridevirtual |
Implements KDReports::Element.
Definition at line 120 of file KDReportsCell.h.
int KDReports::Cell::columnSpan | ( | ) | const |
Returns the number of columns that this cell will span.
Definition at line 55 of file KDReportsCell.cpp.
KDReports::Cell & KDReports::Cell::operator= | ( | const Cell & | other | ) |
Definition at line 37 of file KDReportsCell.cpp.
References KDReports::Element::operator=().
int KDReports::Cell::rowSpan | ( | ) | const |
Returns the number of rows that this cell will span.
Definition at line 65 of file KDReportsCell.cpp.
void KDReports::Cell::setCellFormatFunction | ( | const CellFormatFunc & | func | ) |
Sets the function to call in order to customize the format of the cell.
This allows to set the width, style, and color of the 4 borders independently, customize the padding, etc.
Definition at line 100 of file KDReportsCell.cpp.
void KDReports::Cell::setColumnSpan | ( | int | columnSpan | ) |
Set the number of columns that this cell will span. The default is 1.
Definition at line 50 of file KDReportsCell.cpp.
void KDReports::Cell::setRowSpan | ( | int | rowSpan | ) |
Set the number of rows that this cell will span. The default is 1.
Definition at line 60 of file KDReportsCell.cpp.
void KDReports::Cell::setVerticalAlignment | ( | Qt::AlignmentFlag | verticalAlignment | ) |
Set the vertical alignment of the cell contents.
Definition at line 90 of file KDReportsCell.cpp.
Qt::AlignmentFlag KDReports::Cell::verticalAlignment | ( | ) | const |
Returns the vertical alignment of the cell contents.
Definition at line 95 of file KDReportsCell.cpp.