spinetoolbox.mvcmodels.minimal_tree_model

Models to represent items in a tree.

Module Contents

Classes

TreeItem	A tree item that can fetch its children.
MinimalTreeModel	Base class for all tree models.

class spinetoolbox.mvcmodels.minimal_tree_model.TreeItem(model)

A tree item that can fetch its children.

Parameters

model (MinimalTreeModel) – The model where the item belongs.

property model

property children

property parent_item

property display_data

property edit_data

set_has_children_initially(has_children_initially)

has_children()

Returns whether this item has or could have children.

is_valid()

Tests if item is valid.

Returns

True if item is valid, False otherwise

Return type

bool

child(row)

Returns the child at given row or None if out of bounds.

last_child()

Returns the last child.

child_count()

Returns the number of children.

row_count()

Returns the number of rows, which may be different from the number of children. This allows subclasses to hide children.

child_number()

Returns the rank of this item within its parent or -1 if it’s an orphan.

find_children(cond=lambda child: ...)

Returns children that meet condition expressed as a lambda function.

find_child(cond=lambda child: ...)

Returns first child that meet condition expressed as a lambda function or None.

next_sibling()

Returns the next sibling or None if it’s the last.

previous_sibling()

Returns the previous sibling or None if it’s the first.

index()

set_up()

_do_set_up()

Do stuff after the item has been inserted.

_polish_children(children)

Polishes children just before inserting them.

insert_children(position, children)

Insert new children at given position. Returns a boolean depending on how it went.

Parameters

• position (int) – insert new items here

• children (list of TreeItem) – insert items from this iterable

Returns

True if the children were inserted successfully, False otherwise

Return type

bool

append_children(children)

Append children at the end.

tear_down()

Do stuff after the item has been removed.

tear_down_recursively()

remove_children(position, count)

Removes count children starting from the given position.

Parameters

• position (int) – position of the first child to remove

• count (int) – number of children to remove

Returns

True if operation was successful, False otherwise

Return type

bool

flags(column)

Enables the item and makes it selectable.

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

Returns data for given column and role.

can_fetch_more()

Returns whether this item can fetch more.

fetch_more()

Fetches more children.

abstract set_data(column, value, role)

Sets data for this item.

Parameters

• column (int) – column index

• value (object) – a new value

• role (int) – role of the new value

Returns

True if data was set successfully, False otherwise

Return type

bool

class spinetoolbox.mvcmodels.minimal_tree_model.MinimalTreeModel(parent)

Bases: PySide6.QtCore.QAbstractItemModel

Base class for all tree models.

Init class.

Parameters

parent (SpineDBEditor) –

visit_all(index=QModelIndex(), view=None)

Iterates all items in the model including and below the given index. Iterative implementation so we don’t need to worry about Python recursion limits.

Parameters

• index (QModelIndex) – an index to start. If not given, we start at the root

• view (QTreeView) – a tree view. If given, we only yield items that are visible to that view. So for example, if a tree item is not expanded then we don’t yield its children.

Yields

TreeItem

item_from_index(index)

Return the item corresponding to the given index.

Parameters

index (QModelIndex) – model index

Returns

item at index

Return type

TreeItem

index_from_item(item)

Return a model index corresponding to the given item.

Parameters

item (StandardTreeItem) – item

Returns

item’s index

Return type

QModelIndex

index(row, column, parent=QModelIndex())

Returns the index of the item in the model specified by the given row, column and parent index.

parent(index)

Returns the parent of the model item with the given index.

columnCount(parent=QModelIndex())

rowCount(parent=QModelIndex())

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

Returns the data stored under the given role for the index.

setData(index, value, role=Qt.ItemDataRole.EditRole)

Sets data for given index and role. Returns True if successful; otherwise returns False.

flags(index)

Returns the item flags for the given index.

hasChildren(parent)

canFetchMore(parent)

fetchMore(parent)