spinetoolbox.mvcmodels.minimal_tree_model

Models to represent items in a tree.

authors

16. Vennström (VTT), M. Marin (KTH)

date

11.3.2019

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=None)

A tree item that can fetch its children.

Initializes item.

Parameters

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

property model(self)

property child_item_type(self)

Returns the type of child items. Reimplement in subclasses to return something more meaningful.

property children(self)

property parent_item(self)

child(self, row)

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

last_child(self)

Returns the last child.

child_count(self)

Returns the number of children.

child_number(self)

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

find_children(self, cond=lambda child: ...)

Returns children that meet condition expressed as a lambda function.

find_child(self, cond=lambda child: ...)

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

next_sibling(self)

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

previous_sibling(self)

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

index(self)

insert_children(self, position, *children)

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

Parameters

• position (int) – insert new items here

• children (iter) – insert items from this iterable

append_children(self, *children)

Append children at the end.

remove_children(self, position, count)

Removes count children starting from the given position.

clear_children(self)

Clear children list.

flags(self, column)

Enables the item and makes it selectable.

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

Returns data for given column and role.

has_children(self)

Returns whether or not this item has or could have children.

can_fetch_more(self)

Returns whether or not this item can fetch more.

fetch_more(self)

Fetches more children.

property display_data(self)

property edit_data(self)

abstract set_data(self, 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: PySide2.QtCore.QAbstractItemModel

Base class for all tree models.

Init class.

Parameters

parent (SpineDBEditor) –

visit_all(self, index=QModelIndex())

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.

item_from_index(self, index)

Return the item corresponding to the given index.

index_from_item(self, item)

Return a model index corresponding to the given item.

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

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

parent(self, index)

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

columnCount(self, parent=QModelIndex())

rowCount(self, parent=QModelIndex())

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

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

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

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

flags(self, index)

Returns the item flags for the given index.

hasChildren(self, parent)

canFetchMore(self, parent)

fetchMore(self, parent)