spinetoolbox.spine_db_editor.widgets.custom_qtableview

Custom QTableView classes that support copy-paste and the like.

Module Contents

Classes

StackedTableView	Base stacked view.
ParameterTableView	Base stacked view.
ParameterDefinitionTableView	Base stacked view.
ParameterValueTableView	Base stacked view.
EntityAlternativeTableView	Visualize entities and their alternatives.
PivotTableView	Custom QTableView class with pivot capabilities.
FrozenTableView	param parent parent widget
MetadataTableViewBase	Base for metadata and item metadata table views.
MetadataTableView	Table view for metadata.
ItemMetadataTableView	Table view for entity and parameter value metadata.

Functions

_set_data(index, new_value)

Updates (object or relationship) parameter_definition or value with newly edited data.

spinetoolbox.spine_db_editor.widgets.custom_qtableview._set_data(index, new_value)

Updates (object or relationship) parameter_definition or value with newly edited data.

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.StackedTableView(parent)

Bases: spinetoolbox.widgets.custom_qtableview.AutoFilterCopyPasteTableView

Base stacked view.

Parameters

parent (QWidget) – parent widget

_COLUMN_SIZE_HINTS

_EXPECTED_COLUMN_COUNT: int

connect_spine_db_editor(spine_db_editor)

Connects a Spine db editor to work with this view.

Parameters

spine_db_editor (SpineDBEditor) –

_make_delegate(column_name, delegate_class)

Creates a delegate for the given column and returns it.

Parameters

• column_name (str) –

• delegate_class (TableDelegate) –

Returns

TableDelegate

create_delegates()

Creates delegates for this view

populate_context_menu()

Creates a context menu for this view.

contextMenuEvent(event)

Shows context menu.

Parameters

event (QContextMenuEvent) –

_selected_rows_per_column()

Computes selected rows per column.

Returns

Mapping columns to selected rows in that column.

Return type

dict

filter_by_selection(checked=False)

filter_excluding_selection(checked=False)

remove_selected()

Removes selected indexes.

_refresh_copy_paste_actions(_, __)

Enables or disables copy and paste actions.

_initial_column_size(column)

_set_column_resize_modes(old_column_count, new_column_count)

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.ParameterTableView(parent)

Bases: StackedTableView

Base stacked view.

Parameters

parent (QWidget) – parent widget

value_column_header: str

Either “default_value” or “value”. Used to identify the value column for advanced editing and plotting.

populate_context_menu()

Creates a context menu for this view.

contextMenuEvent(event)

Shows context menu.

Parameters

event (QContextMenuEvent) –

open_in_editor()

Opens the current index in a parameter_value editor using the connected Spine db editor.

plot(checked=False)

Plots current index.

abstract _plot_selection(selection, plot_widget=None)

Adds selected indexes to existing plot or creates a new plot window.

Parameters

• selection (Iterable of QModelIndex) – a list of QModelIndex objects for plotting

• plot_widget (PlotWidget, optional) – an existing plot widget to draw into or None to create a new widget

Returns

a PlotWidget object

Return type

PlotWidget

plot_in_window(action)

Plots current index in the window given by action’s name.

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.ParameterDefinitionTableView(parent)

Bases: ParameterTableView

Base stacked view.

Parameters

parent (QWidget) – parent widget

value_column_header = 'default_value'

_EXPECTED_COLUMN_COUNT = 6

_COLUMN_SIZE_HINTS

create_delegates()

Creates delegates for this view

_plot_selection(selection, plot_widget=None)

See base class

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.ParameterValueTableView(parent)

Bases: ParameterTableView

Base stacked view.

Parameters

parent (QWidget) – parent widget

property _pk_fields

value_column_header = 'value'

_COLUMN_SIZE_HINTS

_EXPECTED_COLUMN_COUNT = 6

connect_spine_db_editor(spine_db_editor)

Connects a Spine db editor to work with this view.

Parameters

spine_db_editor (SpineDBEditor) –

create_delegates()

Creates delegates for this view

_update_pinned_values(_selected, _deselected)

_make_pinned_value(index)

_plot_selection(selection, plot_widget=None)

See base class.

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.EntityAlternativeTableView(parent)

Bases: StackedTableView

Visualize entities and their alternatives.

Parameters

parent (QWidget) – parent widget

_EXPECTED_COLUMN_COUNT = 5

_COLUMN_SIZE_HINTS

create_delegates()

Creates delegates for this view

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.PivotTableView(parent=None)

Bases: spinetoolbox.widgets.custom_qtableview.CopyPasteTableView

Custom QTableView class with pivot capabilities.

Uses ‘contexts’ to provide different UI elements (table headers, context menus,…) depending on what data the pivot table currently contains.

Parameters

parent (QWidget, optional) – parent widget

class _ContextBase(view, db_editor, horizontal_header, vertical_header)

Base class for pivot table view’s contexts.

Parameters

• view (PivotTableView) – parent view

• db_editor (SpineDBEditor) – database editor

• horizontal_header (QHeaderView) – horizontal header

• vertical_header (QHeaderView) – vertical header

_REMOVE_ENTITY = 'Remove entities'

_REMOVE_PARAMETER = 'Remove parameter definitions'

_REMOVE_ALTERNATIVE = 'Remove alternatives'

_REMOVE_SCENARIO = 'Remove scenarios'

_DUPLICATE_SCENARIO = 'Duplicate scenario'

_clear_selection_lists()

Clears cached selected index lists.

abstract populate_context_menu()

Generates context menu.

_refresh_selected_indexes()

Caches selected index lists.

remove_alternatives()

Removes selected alternatives from the database.

show_context_menu(position)

Shows the context menu.

_to_selection_lists(index)

Caches given index to corresponding selected index list.

Parameters

index (QModelIndex) – index to cache

abstract _update_actions_availability()

Enables/disables context menu entries before the menu is shown.

class _EntityContextBase(view, db_editor, horizontal_header, vertical_header)

Bases: PivotTableView._ContextBase

Base class for contexts that contain entities and entity classes.

Parameters

• view (PivotTableView) – parent view

• db_editor (SpineDBEditor) – database editor

• horizontal_header (QHeaderView) – horizontal header

• vertical_header (QHeaderView) – vertical header

_clear_selection_lists()

See base class.

abstract populate_context_menu()

See base class.

remove_entities()

Removes selected entities from the database.

abstract _update_actions_availability()

See base class.

class _ParameterValueContext(view, db_editor)

Bases: PivotTableView._EntityContextBase

Context for showing parameter values in the pivot table.

Parameters

• view (PivotTableView) – parent view

• db_editor (SpineDBEditor) – database editor

_clear_selection_lists()

See base class.

populate_context_menu()

See base class.

open_in_editor()

Opens the parameter value editor for the first selected cell.

plot()

Plots the selected cells.

_plot_in_window(action)

Plots the selected cells in an existing window.

remove_parameters()

Removes selected parameter definitions from the database.

remove_values()

Removes selected parameter values from the database.

show_context_menu(position)

Shows the context menu.

_to_selection_lists(index)

See base class.

_update_actions_availability()

See base class.

class _IndexExpansionContext(view, db_editor)

Bases: PivotTableView._ParameterValueContext

Context for expanded parameter values

Parameters

• view (PivotTableView) – parent view

• db_editor (SpineDBEditor) – database editor

class _ElementContext(view, db_editor)

Bases: PivotTableView._EntityContextBase

Context for presenting relationships in the pivot table.

Parameters

• view (PivotTableView) – parent view

• db_editor (SpineDBEditor) – database editor

populate_context_menu()

See base class.

_update_actions_availability()

See base class.

class _ScenarioAlternativeContext(view, db_editor)

Bases: PivotTableView._ContextBase

Context for presenting scenarios and alternatives

Parameters

• view (PivotTableView) – parent view

• db_editor (SpineDBEditor) – database editor

_clear_selection_lists()

See base class.

populate_context_menu()

See base class.

remove_scenarios()

Removes selected scenarios from the database.

duplicate_scenario()

Duplicates current scenario in the database.

_to_selection_lists(index)

See base class.

_update_actions_availability()

See base class.

_open_scenario_generator()

Opens the scenario generator dialog.

_toggle_checked_state()

Toggles the checked state of selected alternatives.

property source_model

property db_mngr

header_changed

connect_spine_db_editor(spine_db_editor)

_change_context()

Changes the UI engine according to pivot model type.

contextMenuEvent(event)

Shows context menu.

Parameters

event (QContextMenuEvent) –

setModel(model)

_synch_selection_with_header_tables(selected, deselected)

indexWidget(proxy_index)

setIndexWidget(proxy_index, widget)

setHorizontalHeader(horizontal_header)

setVerticalHeader(vertical_header)

resizeEvent(ev)

sizeHintForColumn(column)

_fetch_more_visible()

_update_header_tables()

_update_section_width(logical_index, _old_size, new_size)

_update_section_height(logical_index, _old_size, new_size)

_update_header_tables_geometry()

_refresh_copy_paste_actions(_, __)

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.FrozenTableView(parent=None)

Bases: PySide6.QtWidgets.QTableView

Parameters

parent (QWidget) – parent widget

property area

header_dropped

dragEnterEvent(event)

dragMoveEvent(event)

dropEvent(event)

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.MetadataTableViewBase(parent)

Bases: spinetoolbox.widgets.custom_qtableview.CopyPasteTableView

Base for metadata and item metadata table views.

Parameters

parent (QWidget, optional) – parent widget

connect_spine_db_editor(db_editor)

Finishes view’s initialization.

Parameters

db_editor (SpineDBEditor) – database editor instance

contextMenuEvent(event)

_remove_selected()

Removes selected rows from view’s model.

_enable_delegates(db_editor)

Creates delegates for this view

Parameters

db_editor (SpineDBEditor) – database editor

_populate_context_menu()

Fills context menu with actions.

_set_model_data(index, value)

Sets model data.

Parameters

• index (QModelIndex) – model index to set

• value (str) – value

_refresh_copy_paste_actions()

_set_horizontal_header_resize_modes(old_column_count, new_column_count)

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.MetadataTableView(parent)

Bases: MetadataTableViewBase

Table view for metadata.

Parameters

parent (QWidget, optional) – parent widget

_enable_delegates(db_editor)

See base class.

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.ItemMetadataTableView(parent)

Bases: MetadataTableViewBase

Table view for entity and parameter value metadata.

Parameters

parent (QWidget) – parent widget

set_models(item_metadata_model, metadata_model)

Sets models.

Parameters

• item_metadata_model (ItemMetadataModel) – item metadata model

• metadata_model (MetadataTableModel) – metadata model

_enable_delegates(db_editor)

See base class