Table model that stores QVariant data. More...

#include <VariantTableModel.h>

Inherits QAbstractTableModel.

Public Member Functions
	VariantTableModel (VariantTableModelStorageRule storageRule=VariantTableModelStorageRule::GroupDisplayAndEditRoleData, QObject *parent=nullptr)
	Construct a model.

void	setPassRolesInDataChaged (bool pass)
	Tell if this model must pass roles in data changed signal. More...

int	rowCount (const QModelIndex &parent=QModelIndex()) const override
	Get row count.

int	columnCount (const QModelIndex &parent=QModelIndex()) const override
	Get column count.

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
	Get data at index. More...

QVariant	data (int row, int column, int role=Qt::DisplayRole) const
	Get data at row and column. More...

void	setItemEnabled (const QModelIndex &index, bool enable)
	Set item enabled at index. More...

void	setItemEnabled (int row, int column, bool enable)
	Set item enabled at row and column. More...

void	setItemEditable (const QModelIndex &index, bool editable)
	Set item editable at index. More...

void	setItemEditable (int row, int column, bool editable)
	Set item editable at row and column. More...

Qt::ItemFlags	flags (const QModelIndex &index) const override
	Get flags at index. More...

bool	setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) override
	Set data at index. More...

bool	setData (int row, int column, const QVariant &value, int role=Qt::EditRole)
	Set data at row and column. More...

void	appendRow ()
	Append a row.

void	prependRow ()
	Prepend a row.

bool	insertRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
	Implement QAbstractTableModel::insertRows() More...

void	removeFirstRow ()
	Remove first row.

void	removeLastRow ()
	Remove last row.

bool	removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
	Implement QAbstractTableModel::removeRows() More...

void	appendColumn ()
	Append a column.

void	prependColumn ()
	Prepend a column.

bool	insertColumns (int column, int count, const QModelIndex &parent=QModelIndex()) override
	Implement QAbstractTableModel::insertColumns() More...

void	removeFirstColumn ()
	Remove first column.

void	removeLastColumn ()
	Remove last column.

bool	removeColumns (int column, int count, const QModelIndex &parent=QModelIndex()) override
	Implement QAbstractTableModel::removeColumns() More...

void	resize (int rows, int columns)
	Resize model. More...

void	populateColumnWithInt (int column, int firstValue, int increment=1)
	Populate a column with int values. More...

void	populateColumnWithAscii (int column, char firstValue, int increment=1)
	Populate a column with ASCII values. More...

void	populateColumn (int column, const std::vector< QVariant > &data, Qt::ItemDataRole role=Qt::DisplayRole)
	Populate a column with data. More...

void	repopulateByColumns (const std::vector< std::vector< QVariant > > &data, Qt::ItemDataRole role=Qt::DisplayRole)
	Repopulate model with data. More...

void	populate (int rows, int columns)
	Populate model with data. More...

void	clear ()
	Clear all data. More...

Detailed Description

Table model that stores QVariant data.

Example:

#include "Mdt/ItemModel/VariantTableModel.h"
#include <QTableView>
Mdt::ItemModel::VariantTableModel model;
QTableView view;
view.setModel(&model);
view.show();
model.populate(3, 2);

This class is mostly used in unit tests in Mdt libraries.

Definition at line 49 of file VariantTableModel.h.

Member Function Documentation

void Mdt::ItemModel::VariantTableModel::clear ( )

Clear all data.

rowCount() and columnCount() will return 0 after this call

Definition at line 377 of file VariantTableModel.cpp.

QVariant Mdt::ItemModel::VariantTableModel::data	(	const QModelIndex &	index,
		int	role = `Qt::DisplayRole`
	)		const

override

Get data at index.

If storage rule (passed in constructor) is SeparateDisplayAndEditRoleData, data for Qt::EditRole will be distinct from data for Qt::DisplayRole.

If role is other than Qt::DisplayRole or Qt::EditRole, an null value is returned.

If index is not valid, or out of range, an null value is returned.

Definition at line 53 of file VariantTableModel.cpp.

QVariant Mdt::ItemModel::VariantTableModel::data	(	int	row,
		int	column,
		int	role = `Qt::DisplayRole`
	)		const

Get data at row and column.

Precondition: row must be in valid range ( 0 <= row < rowCount() ); column must be in valid range ( 0 <= column < columnCount() )

See also: data(const QModelIndex &, int)

Definition at line 69 of file VariantTableModel.cpp.

Qt::ItemFlags Mdt::ItemModel::VariantTableModel::flags ( const QModelIndex & index ) const

override

Get flags at index.

If index is not valid, or out of range, this method returns QAbstractTableModel's flags.

Definition at line 122 of file VariantTableModel.cpp.

bool Mdt::ItemModel::VariantTableModel::insertColumns	(	int	column,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

override

Implement QAbstractTableModel::insertColumns()

Precondition: column must be in correct range ( 0 <= column <= columnCount() ); count must be >= 1

Definition at line 242 of file VariantTableModel.cpp.

bool Mdt::ItemModel::VariantTableModel::insertRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

override

Implement QAbstractTableModel::insertRows()

Precondition: row must be in correct range ( 0 <= column <= rowCount() ); count must be >= 1

Definition at line 184 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::populate	(	int	rows,
		int	columns
	)

Populate model with data.

Form is: For row 0: 0A, 0B, ..., 0Z For row 1: 1A, 1B, ..., 1Z

If storage rule (passed in constructor) is SeparateDisplayAndEditRoleData, data for Qt::EditRole will not be set.

Definition at line 365 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::populateColumn	(	int	column,
		const std::vector< QVariant > &	data,
		Qt::ItemDataRole	role = `Qt::DisplayRole`
	)

Populate a column with data.

For example, if we have a model with 3 rows and 2 columns:

model.populateColumn(0, {1,2,3});

will update first column:

Col 0	Col 1
1
2
3

If we populate column 0 with less data than rowCount(), like this:

model.populateColumn(0, {'A','B'});

the last row will be keeped untouched:

Col 0	Col 1
A
B
3

Precondition: column must be in valid range ( 0 <= column < columnCount() ); data size must be <= rowCount(); role must be Qt::DisplayRole or Qt::EditRole; If role is Qt::EditRole, strage strategy must be VariantTableModelStorageRule::SeparateDisplayAndEditRoleData

Definition at line 333 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::populateColumnWithAscii	(	int	column,
		char	firstValue,
		int	increment = `1`
	)

Populate a column with ASCII values.

For each row, starting from 0, value at column will be updated.

For example, if we have a model with 3 rows and 2 columns:

Col 0	Col 1
A
B
C

populateColumnWithAscii(1, 'b', 3) will update second column:

Col 0	Col 1
A	'b'
B	'e'
C	'h'

Precondition: column must be in valid range ( 0 <= column < columnCount() )

Note: no checks are done for firstValue and increment.

Definition at line 320 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::populateColumnWithInt	(	int	column,
		int	firstValue,
		int	increment = `1`
	)

Populate a column with int values.

For each row, starting from 0, value at column will be updated.

For example, if we have a model with 3 rows and 2 columns:

Col 0	Col 1
A
B
C

populateColumnWithInt(1, 2, 4) will update second column:

Col 0	Col 1
A	2
B	6
C	10

Precondition: column must be in valid range ( 0 <= column < columnCount() )

Definition at line 307 of file VariantTableModel.cpp.

bool Mdt::ItemModel::VariantTableModel::removeColumns	(	int	column,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

override

Implement QAbstractTableModel::removeColumns()

Precondition: column must be >= 0; count must be >= 1; column + count must be in correct range ( 0 <= column <= columnCount() )

Definition at line 277 of file VariantTableModel.cpp.

bool Mdt::ItemModel::VariantTableModel::removeRows	(	int	row,
		int	count,
		const QModelIndex &	parent = `QModelIndex()`
	)

override

Implement QAbstractTableModel::removeRows()

Precondition: row must be >= 0; count must be >= 1; row + count must be in correct range ( 0 <= column <= rowCount() )

Definition at line 216 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::repopulateByColumns	(	const std::vector< std::vector< QVariant > > &	data,
		Qt::ItemDataRole	role = `Qt::DisplayRole`
	)

Repopulate model with data.

Calling:

model.populateByColumns({{1,2,3},{"A","B","C"}});

will populate the model:

Col 0	Col 1
1	A
2	B
3	C

This method will also reset the model.

Precondition: data must have at least 1 row; each row must have at least 1 column; each column must be the same size

Definition at line 349 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::resize	(	int	rows,
		int	columns
	)

Resize model.

For new count of rows, respectively columns, that is greater than current count, new null elements are added. For count that is less than current one, elements are removed.

This method will also reset the model.

Precondition: rows must be >= 0; columns must be >= 0

Definition at line 296 of file VariantTableModel.cpp.

bool Mdt::ItemModel::VariantTableModel::setData	(	const QModelIndex &	index,
		const QVariant &	value,
		int	role = `Qt::EditRole`
	)

override

Set data at index.

If storage rule (passed in constructor) is SeparateDisplayAndEditRoleData, data for Qt::EditRole will be distinct from data for Qt::DisplayRole.

If role is other than Qt::DisplayRole or Qt::EditRole, no data is set and this function returns false.

If index is not valid, or out of range, this method returns false.

Definition at line 135 of file VariantTableModel.cpp.

bool Mdt::ItemModel::VariantTableModel::setData	(	int	row,
		int	column,
		const QVariant &	value,
		int	role = `Qt::EditRole`
	)

Set data at row and column.

Precondition: row must be in valid range ( 0 <= row < rowCount() ); column must be in valid range ( 0 <= column < columnCount() )

See also: setData(const QModelIndex &, const QVariant &, int)

Definition at line 161 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::setItemEditable	(	const QModelIndex &	index,
		bool	editable
	)

Set item editable at index.

Precondition: index must be in valid range ( 0 <= index.row() < rowCount() and 0 <= index.column() < columnCount() )

Definition at line 102 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::setItemEditable	(	int	row,
		int	column,
		bool	editable
	)

Set item editable at row and column.

Precondition: row must be in valid range ( 0 <= row < rowCount() ); column must be in valid range ( 0 <= column < columnCount() )

See also: setItemEditable(const QModelIndex &, bool)

Definition at line 112 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::setItemEnabled	(	const QModelIndex &	index,
		bool	enable
	)

Set item enabled at index.

Precondition: index must be in valid range ( 0 <= index.row() < rowCount() and 0 <= index.column() < columnCount() )

Definition at line 82 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::setItemEnabled	(	int	row,
		int	column,
		bool	enable
	)

Set item enabled at row and column.

Precondition: row must be in valid range ( 0 <= row < rowCount() ); column must be in valid range ( 0 <= column < columnCount() )

See also: setItemEnabled(const QModelIndex &, bool)

Definition at line 92 of file VariantTableModel.cpp.

void Mdt::ItemModel::VariantTableModel::setPassRolesInDataChaged ( bool pass )

Tell if this model must pass roles in data changed signal.

By default, roles are passed in dataChanged() signal.

Definition at line 34 of file VariantTableModel.cpp.

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

libs/ItemModel/src/Mdt/ItemModel/VariantTableModel.h
libs/ItemModel/src/Mdt/ItemModel/VariantTableModel.cpp

Public Member Functions

Detailed Description

Member Function Documentation