spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item

Classes to represent alternative and scenario items in a tree.

authors:
  1. Vennström (VTT)
date:

17.6.2020

Module Contents

Classes

RootItem A root item.
LeafItem A tree item that fetches their children as they are inserted.
AlternativeRootItem An alternative root item.
ScenarioRootItem A scenario root item.
AlternativeLeafItem An alternative leaf item.
ScenarioLeafItem A scenario leaf item.
ScenarioAlternativeLeafItem A scenario alternative leaf item.
spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item._ALTERNATIVE_ICON = [source]
spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item._SCENARIO_ICON = [source]
class spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.RootItem(model=None)[source]

Bases: spinetoolbox.spine_db_editor.mvcmodels.tree_item_utility.EmptyChildMixin, spinetoolbox.spine_db_editor.mvcmodels.tree_item_utility.AllBoldMixin, spinetoolbox.spine_db_editor.mvcmodels.tree_item_utility.NonLazyTreeItem

A root item.

Initializes item.

Parameters:model (MinimalTreeModel, NoneType) – The model where the item belongs.
item_type[source]
display_data[source]
icon_code[source]
db_map[source]
display_icon[source]
data(self, column, role=Qt.DisplayRole)[source]

Returns data for given column and role.

set_data(self, column, value, role)[source]

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
empty_child(self)[source]
class spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.LeafItem(identifier=None)[source]

Bases: spinetoolbox.spine_db_editor.mvcmodels.tree_item_utility.NonLazyTreeItem

A tree item that fetches their children as they are inserted.

Initializes item.

Parameters:model (MinimalTreeModel, NoneType) – The model where the item belongs.
item_type[source]
tool_tip[source]
db_map[source]
id[source]
item_data[source]
name[source]
add_item_to_db(self, db_item)[source]
update_item_in_db(self, db_item)[source]
header_data(self, column)[source]
data(self, column, role=Qt.DisplayRole)[source]

Returns data for given column and role.

set_data(self, column, value, role)[source]

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
handle_updated_in_db(self)[source]
class spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.AlternativeRootItem(model=None)[source]

Bases: spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.RootItem

An alternative root item.

Initializes item.

Parameters:model (MinimalTreeModel, NoneType) – The model where the item belongs.
item_type[source]
display_data[source]
icon_code[source]
empty_child(self)[source]
class spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.ScenarioRootItem(model=None)[source]

Bases: spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.RootItem

A scenario root item.

Initializes item.

Parameters:model (MinimalTreeModel, NoneType) – The model where the item belongs.
item_type[source]
display_data[source]
icon_code[source]
empty_child(self)[source]
class spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.AlternativeLeafItem(identifier=None)[source]

Bases: spinetoolbox.spine_db_editor.mvcmodels.tree_item_utility.LastGrayMixin, spinetoolbox.spine_db_editor.mvcmodels.tree_item_utility.EditableMixin, spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.LeafItem

An alternative leaf item.

Initializes item.

Parameters:model (MinimalTreeModel, NoneType) – The model where the item belongs.
item_type[source]
tool_tip[source]
add_item_to_db(self, db_item)[source]
update_item_in_db(self, db_item)[source]
flags(self, column)[source]

Makes items editable.

class spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.ScenarioLeafItem(identifier=None)[source]

Bases: spinetoolbox.spine_db_editor.mvcmodels.tree_item_utility.LastGrayMixin, spinetoolbox.spine_db_editor.mvcmodels.tree_item_utility.EditableMixin, spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.LeafItem

A scenario leaf item.

Initializes item.

Parameters:model (MinimalTreeModel, NoneType) – The model where the item belongs.
item_type[source]
tool_tip[source]
alternative_id_list[source]
add_item_to_db(self, db_item)[source]
update_item_in_db(self, db_item)[source]
flags(self, column)[source]

Makes items editable.

data(self, column, role=Qt.DisplayRole)[source]

Returns data for given column and role.

set_data(self, column, value, role)[source]

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
fetch_more(self)[source]

Fetches more children.

handle_updated_in_db(self)[source]
_update_alternative_id_list(self)[source]
class spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.ScenarioAlternativeLeafItem(identifier=None)[source]

Bases: spinetoolbox.spine_db_editor.mvcmodels.alternative_scenario_item.LeafItem

A scenario alternative leaf item.

Initializes item.

Parameters:model (MinimalTreeModel, NoneType) – The model where the item belongs.
item_type[source]
tool_tip[source]
id[source]
add_item_to_db(self, db_item)[source]
update_item_in_db(self, db_item)[source]
flags(self, column)[source]

Enables the item and makes it selectable.