KDReports::AutoTableElement Class Reference

#include <KDReportsAutoTableElement.h>

Inheritance diagram for KDReports::AutoTableElement:

Collaboration diagram for KDReports::AutoTableElement:

Public Types
enum	Role { DecorationAlignmentRole = 0x2D535FB1, NonBreakableLinesRole = 0x2D535FB2 }

Public Member Functions
	AutoTableElement (const AutoTableElement &other)
	AutoTableElement (const QString &modelKey)
	AutoTableElement (QAbstractItemModel *tableModel)
	~AutoTableElement () override
void	build (ReportBuilder &) const override
Element *	clone () const override
QBrush	headerBackground () const
QSize	iconSize () const
bool	isHorizontalHeaderVisible () const
bool	isVerticalHeaderVisible () const
AutoTableElement &	operator= (const AutoTableElement &other)
void	setHeaderBackground (const QBrush &brush)
void	setHorizontalHeaderVisible (bool visible)
void	setIconSize (QSize iconSize)
void	setModelKey (const QString &modelKey)
void	setTableModel (QAbstractItemModel *tableModel)
void	setVerticalHeaderVisible (bool visible)
QAbstractItemModel *	tableModel () const
Public Member Functions inherited from KDReports::AbstractTableElement
qreal	border () const
QBrush	borderBrush () const
QFont	defaultFont (bool *isSet) const
qreal	padding () const
void	setBorder (qreal border)
void	setBorderBrush (const QBrush &brush)
void	setColumnConstraints (const QVector< ColumnConstraint > &constraints)
void	setDefaultFont (const QFont &font)
void	setPadding (qreal padding)
void	setWidth (qreal width, Unit unit=Millimeters)
Unit	unit () const
qreal	width () const
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::AbstractTableElement
	AbstractTableElement ()
	AbstractTableElement (const AbstractTableElement &other)
	~AbstractTableElement () override
void	fillTableFormat (QTextTableFormat &tableFormat, QTextCursor &textDocCursor) const
AbstractTableElement &	operator= (const AbstractTableElement &other)
Protected Member Functions inherited from KDReports::Element
	Element ()
	Element (const Element &other)
Element &	operator= (const Element &other)

Detailed Description

The KDReports::AutoTableElement class represents a table in the report, whose data is provided by a QAbstractItemModel. A header row is added if the QAbstractItemModel has horizontal header data, and a header column is added if the QAbstractItemModel has vertical header data. The header row is repeated on every page if the table is broken across page boundaries.

Definition at line 40 of file KDReportsAutoTableElement.h.

Member Enumeration Documentation

Role

enum KDReports::AutoTableElement::Role

Enumerator
DecorationAlignmentRole	This model role allows to specify whether the icon should go before the text (Qt::AlignLeft) or after the text (Qt::AlignRight).
NonBreakableLinesRole	This model role allows to specify that line-breaking is not allowed in this table cell. Since 1.7.

Definition at line 154 of file KDReportsAutoTableElement.h.

Constructor & Destructor Documentation

AutoTableElement() [1/3]

KDReports::AutoTableElement::AutoTableElement ( QAbstractItemModel *  tableModel )

explicit

Creates a table element from the given table model. Note that the argument isn't const because KDReports will call fetchMore() on it, if canFetchMore() returns true.

Definition at line 228 of file KDReportsAutoTableElement.cpp.

References tableModel().

AutoTableElement() [2/3]

KDReports::AutoTableElement::AutoTableElement ( const QString &  modelKey )

explicit

Creates a table element that does not have an associated model yet. The association will be done later using the model key.

Definition at line 234 of file KDReportsAutoTableElement.cpp.

References KDReports::modelForKey().

~AutoTableElement()

KDReports::AutoTableElement::~AutoTableElement ( )

override

Destructor. Deletes internal data.

Definition at line 255 of file KDReportsAutoTableElement.cpp.

AutoTableElement() [3/3]

KDReports::AutoTableElement::AutoTableElement

(

const AutoTableElement &

other

)

Copies a table element. The model and settings are copied over.

Definition at line 240 of file KDReportsAutoTableElement.cpp.

Member Function Documentation

build()

void KDReports::AutoTableElement::build ( ReportBuilder &  builder ) const

overridevirtual

Implements KDReports::Element.

Definition at line 276 of file KDReportsAutoTableElement.cpp.

References KDReports::ReportBuilder::currentDocument(), KDReports::ReportBuilder::currentDocumentData(), KDReports::ReportBuilder::cursor(), KDReports::HeaderColumnsProperty, and KDReports::TextDocumentData::registerAutoTable().

clone()

KDReports::Element * KDReports::AutoTableElement::clone ( ) const

overridevirtual

Implements KDReports::Element.

Definition at line 353 of file KDReportsAutoTableElement.cpp.

headerBackground()

QBrush KDReports::AutoTableElement::headerBackground

(

)

const

Returns

the background color of the headers

Since

1.4

Definition at line 409 of file KDReportsAutoTableElement.cpp.

Referenced by KDReports::MainTable::setAutoTableElement().

iconSize()

QSize KDReports::AutoTableElement::iconSize

(

)

const

Returns

the size passed to setIconSize

Since

1.3

Definition at line 389 of file KDReportsAutoTableElement.cpp.

Referenced by KDReports::MainTable::setAutoTableElement().

isHorizontalHeaderVisible()

bool KDReports::AutoTableElement::isHorizontalHeaderVisible

(

)

const

Returns

true if the horizontal header will be visible

Since

1.1

Definition at line 379 of file KDReportsAutoTableElement.cpp.

Referenced by KDReports::MainTable::setAutoTableElement(), and KDReports::TableBreakingSettingsDialog::TableBreakingSettingsDialog().

isVerticalHeaderVisible()

bool KDReports::AutoTableElement::isVerticalHeaderVisible

(

)

const

Returns

true if the vertical header will be visible

Since

1.1

Definition at line 374 of file KDReportsAutoTableElement.cpp.

Referenced by KDReports::MainTable::setAutoTableElement(), and KDReports::TableBreakingSettingsDialog::TableBreakingSettingsDialog().

operator=()

KDReports::AutoTableElement & KDReports::AutoTableElement::operator=

(

const AutoTableElement &

other

)

Copies the model and settings from another table element.

Definition at line 246 of file KDReportsAutoTableElement.cpp.

References KDReports::AbstractTableElement::operator=().

setHeaderBackground()

void KDReports::AutoTableElement::setHeaderBackground

(

const QBrush &

brush

)

Sets the background color of the headers The default color is gray. Call setHeaderBackground(QBrush()) to disable the background color and have transparent headers instead.

Definition at line 369 of file KDReportsAutoTableElement.cpp.

setHorizontalHeaderVisible()

void KDReports::AutoTableElement::setHorizontalHeaderVisible

(

bool

visible

)

Sets whether to show a horizontal header, showing header data from the model. This is true by default, call setHorizontalHeaderVisible(false) to hide the horizontal header.

Definition at line 364 of file KDReportsAutoTableElement.cpp.

setIconSize()

void KDReports::AutoTableElement::setIconSize

(

QSize

iconSize

)

Sets the size of the decoration icons, in pixels. This is used when setting the DecorationRole to a QIcon in the model. Note that the model can also set it to a QPixmap or QImage, in which case the size in the report will simply be the size of the pixmap or image.

Since

1.1

Definition at line 384 of file KDReportsAutoTableElement.cpp.

setModelKey()

void KDReports::AutoTableElement::setModelKey

(

const QString &

modelKey

)

set the model key associated with this element

Since

1.4

Definition at line 404 of file KDReportsAutoTableElement.cpp.

References KDReports::modelForKey().

setTableModel()

void KDReports::AutoTableElement::setTableModel

(

QAbstractItemModel *

tableModel

)

set the model associated with this element

Since

1.4

Definition at line 399 of file KDReportsAutoTableElement.cpp.

setVerticalHeaderVisible()

void KDReports::AutoTableElement::setVerticalHeaderVisible

(

bool

visible

)

Sets whether to show a vertical header (showing header data from the model, or row numbers by default). This is true by default, call setVerticalHeaderVisible(false) to hide the vertical header.

Definition at line 359 of file KDReportsAutoTableElement.cpp.

tableModel()

QAbstractItemModel * KDReports::AutoTableElement::tableModel

(

)

const

Returns

the model associated with this element

Since

1.2

Definition at line 394 of file KDReportsAutoTableElement.cpp.

Referenced by AutoTableElement(), and KDReports::MainTable::setAutoTableElement().

---

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

• KDReportsAutoTableElement.h
• KDReportsAutoTableElement.cpp