spinetoolbox.spine_db_editor.widgets.custom_qtreeview

Classes for custom QTreeViews and QTreeWidgets.

Module Contents

Classes

EntityTreeView	Tree view for entity classes and entities.
ItemTreeView	Base class for all non-entity tree views.
AlternativeTreeView	Custom QTreeView for the alternative tree in SpineDBEditor.
ScenarioTreeView	Custom QTreeView for the scenario tree in SpineDBEditor.
ParameterValueListTreeView	Custom QTreeView class for parameter_value_list in SpineDBEditor.

class spinetoolbox.spine_db_editor.widgets.custom_qtreeview.EntityTreeView(parent)

Bases: spinetoolbox.widgets.custom_qtreeview.CopyPasteTreeView

Tree view for entity classes and entities.

Parameters

parent (QWidget) – parent widget

tree_selection_changed

reset()

connect_spine_db_editor(spine_db_editor)

Connects a Spine db editor to work with this view.

Parameters

spine_db_editor (SpineDBEditor) –

_add_middle_actions()

_create_context_menu()

Creates a context menu for this view.

toggle_hide_empty_classes()

edit(index, trigger, event)

Edit all selected items.

connect_signals()

Connects signals.

rowsInserted(parent, start, end)

rowsRemoved(parent, start, end)

setModel(model)

_fetch_more_visible()

verticalScrollbarValueChanged(value)

_handle_selection_changed(selected, deselected)

Classifies selection by item type and emits signal.

_refresh_selected_indexes()

clear_any_selections()

Clears the selection if any.

fully_expand()

Expands selected indexes and all their children.

fully_collapse()

Collapses selected indexes and all their children.

export_selected()

Exports data from selected indexes using the connected Spine db editor.

remove_selected()

Removes selected indexes using the connected Spine db editor.

contextMenuEvent(event)

Shows context menu.

Parameters

event (QContextMenuEvent) –

mousePressEvent(event)

Overrides selection behaviour if the user has selected sticky selection in Settings. If sticky selection is enabled, multiple-selection is enabled when selecting items in the Object tree. Pressing the Ctrl-button down, enables single selection.

Parameters

event (QMouseEvent) –

update_actions_availability()

Updates the visible property of actions according to whether or not they apply to given item.

edit_selected()

Edits all selected indexes using the connected Spine db editor.

add_entity_classes()

add_entities()

find_next_entity()

Finds the next occurrence of the relationship at the current index and expands it.

_do_find_next_entity()

duplicate_entity()

Duplicates the object at the current index using the connected Spine db editor.

add_entity_group()

manage_elements()

manage_members()

select_superclass()

class spinetoolbox.spine_db_editor.widgets.custom_qtreeview.ItemTreeView(parent)

Bases: spinetoolbox.widgets.custom_qtreeview.CopyPasteTreeView

Base class for all non-entity tree views.

Parameters

parent (QWidget) – parent widget

rowsInserted(parent, start, end)

connect_signals()

Connects signals.

abstract remove_selected()

Removes items selected in the view.

abstract update_actions_availability(item)

Updates the visible property of actions according to whether or not they apply to given item.

connect_spine_db_editor(spine_db_editor)

Prepares the view to work with the DB editor.

Parameters

spine_db_editor (SpineDBEditor) – editor instance

populate_context_menu()

Creates a context menu for this view.

contextMenuEvent(event)

Shows context menu.

Parameters

event (QContextMenuEvent) –

_refresh_copy_paste_actions(_, __)

Refreshes copy and paste actions enabled state.

class spinetoolbox.spine_db_editor.widgets.custom_qtreeview.AlternativeTreeView(parent)

Bases: ItemTreeView

Custom QTreeView for the alternative tree in SpineDBEditor.

Parameters

parent (QWidget) – parent widget

property selected_alternative_ids

alternative_selection_changed

reset()

connect_signals()

Connects signals.

connect_spine_db_editor(spine_db_editor)

see base class

populate_context_menu()

See base class.

_db_map_alt_ids_from_selection(selection)

Gather alternative ids per database map from selection.

Parameters

selection (QItemSelection) – selection

Returns

mapping from database map to set of alternative ids

Return type

dict

_handle_selection_changed(selected, deselected)

Emits alternative_selection_changed with the current selection.

remove_selected()

See base class.

update_actions_availability(item)

See base class.

_open_scenario_generator()

Opens the scenario generator dialog.

can_copy()

See base class.

can_paste()

See base class.

copy()

See base class.

paste()

Pastes alternatives from clipboard to the tree.

This makes sense only when pasting alternatives from one database to another.

class spinetoolbox.spine_db_editor.widgets.custom_qtreeview.ScenarioTreeView(parent)

Bases: ItemTreeView

Custom QTreeView for the scenario tree in SpineDBEditor.

Parameters

parent (QWidget) – parent widget

property selected_alternative_ids

scenario_selection_changed

reset()

connect_signals()

Connects signals.

connect_spine_db_editor(spine_db_editor)

see base class

populate_context_menu()

See base class.

_db_map_alternative_ids_from_selection(selection)

Collects database maps and alternative ids within given selection.

Parameters

selection (Sequence of QModelIndex) – selection indices

Returns

mapping from database map to set of alternative ids

Return type

dict

_handle_selection_changed(selected, deselected)

Emits scenario_selection_changed with the current selection.

remove_selected()

See base class.

dragMoveEvent(event)

dragEnterEvent(event)

update_actions_availability(item)

See base class

copy()

See base class.

can_paste()

See base class.

paste()

Pastes alternatives and scenarios from clipboard to the tree.

_duplicate_scenario()

Duplicates selected scenarios.

class spinetoolbox.spine_db_editor.widgets.custom_qtreeview.ParameterValueListTreeView(parent)

Bases: ItemTreeView

Custom QTreeView class for parameter_value_list in SpineDBEditor.

Parameters

parent (QWidget) – parent widget

connect_spine_db_editor(spine_db_editor)

see base class

populate_context_menu()

Creates a context menu for this view.

update_actions_availability(item)

See base class.

open_in_editor()

Opens the parameter_value editor for the first selected cell.

remove_selected()

See base class.