spinetoolbox.mvcmodels.compound_table_model

Models that vertically concatenate two or more table models.

Module Contents

Classes

CompoundTableModel	A model that concatenates several sub table models vertically.
CompoundWithEmptyTableModel	A compound parameter table model where the last model is an empty row model.

class spinetoolbox.mvcmodels.compound_table_model.CompoundTableModel(parent=None, header=None)

Bases: spinetoolbox.mvcmodels.minimal_table_model.MinimalTableModel

A model that concatenates several sub table models vertically.

Initializes model.

Parameters

• parent (QObject, optional) – the parent object

• header (list of str, optional) – header labels

refreshed

map_to_sub(index)

Returns an equivalent submodel index.

Parameters

index (QModelIndex) – the compound model index.

Returns

the equivalent index in one of the submodels

Return type

QModelIndex

map_from_sub(sub_model, sub_index)

Returns an equivalent compound model index.

Parameters

• sub_model (MinimalTableModel) – the submodel

• sub_index (QModelIndex) – the submodel index.

Returns

the equivalent index in the compound model

Return type

QModelIndex

item_at_row(row)

Returns the item at given row.

Parameters

row (int) –

Returns

object

sub_model_at_row(row)

Returns the submodel corresponding to the given row in the compound model.

Parameters

row (int) –

Returns

MinimalTableModel

sub_model_row(row)

Calculates sub model row.

Parameters

row (int) – row in compound model

Returns

row in sub model

Return type

int

refresh()

Refreshes the layout by computing a new row map.

_do_refresh()

Recomputes the row and inverse row maps.

_append_row_map(row_map)

Appends given row map to the tail of the model.

Parameters

row_map (list) – tuples (model, row number)

_row_map_iterator_for_model(model)

Yields row map for given model. The base class implementation just yields all model rows.

Parameters

model (MinimalTableModel) –

Yields

tuple – (model, row number)

_row_map_for_model(model)

Returns row map for given model. The base class implementation just returns all model rows.

Parameters

model (MinimalTableModel) –

Returns

tuples (model, row number)

Return type

list

canFetchMore(parent)

Returns True if any of the submodels that haven’t been fetched yet can fetch more.

fetchMore(parent)

Fetches the next sub model and increments the fetched counter.

flags(index)

Return index flags.

data(index, role=Qt.ItemDataRole.DisplayRole)

Returns the data stored under the given role for the item referred to by the index.

Parameters

• index (QModelIndex) – Index of item

• role (int) – Data role

Returns

Item data for given role.

rowCount(parent=QModelIndex())

Returns the sum of rows in all models.

batch_set_data(indexes, data)

Sets data for indexes in batch. Distributes indexes and values among the different submodels and calls batch_set_data on each of them.

insertRows(row, count, parent=QModelIndex())

Inserts count rows after the given row under the given parent. Localizes the appropriate submodel and calls insertRows on it.

removeRows(row, count, parent=QModelIndex())

Removes count rows starting with the given row under parent. Localizes the appropriate submodels and calls removeRows on it.

class spinetoolbox.mvcmodels.compound_table_model.CompoundWithEmptyTableModel(parent=None, header=None)

Bases: CompoundTableModel

A compound parameter table model where the last model is an empty row model.

Initializes model.

Parameters

• parent (QObject, optional) – the parent object

• header (list of str, optional) – header labels

property single_models

property empty_model

abstract _create_empty_model()

Creates and returns an empty model.

Returns

model

Return type

EmptyRowModel

init_model()

Initializes the compound model.

Basically populates the sub_models list attribute with the result of _create_empty_model.

_connect_single_model(model)

Connects signals so changes in the submodels are acknowledged by the compound.

_recompute_empty_row_map()

Recomputes the part of the row map corresponding to the empty model.

_handle_empty_rows_removed(parent, empty_first, empty_last)

Updates row_map when rows are removed from the empty model.

_handle_empty_rows_inserted(parent, empty_first, empty_last)

Runs when rows are inserted to the empty model. Updates row_map, then emits rowsInserted so the new rows become visible.

_handle_single_model_about_to_be_reset(model)

Runs when given model is about to reset.

_handle_single_model_reset(model)

Runs when given model is reset.

_refresh_single_model(model)

_get_insert_position(model)

_insert_single_model(model)

_get_row_for_insertion(pos)

_insert_row_map(pos, single_row_map)

clear_model()

Clears the model.