spinetoolbox.spine_db_editor.widgets.custom_qtableview

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

author

13. Marin (KTH)

date

18.5.2018

Module Contents

Classes

ParameterTableView	Custom QTableView class with autofilter functionality.
ObjectParameterTableMixin
RelationshipParameterTableMixin
ParameterDefinitionTableView	Custom QTableView class with autofilter functionality.
ParameterValueTableView	Custom QTableView class with autofilter functionality.
ObjectParameterDefinitionTableView	A custom QTableView for the object parameter_definition pane in Spine db editor.
RelationshipParameterDefinitionTableView	A custom QTableView for the relationship parameter_definition pane in Spine db editor.
ObjectParameterValueTableView	A custom QTableView for the object parameter_value pane in Spine db editor.
RelationshipParameterValueTableView	A custom QTableView for the relationship parameter_value pane in Spine db editor.
PivotTableView	Custom QTableView class with pivot capabilities.
FrozenTableView

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

Bases: spinetoolbox.widgets.custom_qtableview.AutoFilterCopyPasteTableView

Custom QTableView class with autofilter functionality.

Initialize the view.

property value_column_header(self)

Either “default value” or “value”. Used to identifiy the value column for advanced editting and plotting.

connect_spine_db_editor(self, spine_db_editor)

Connects a Spine db editor to work with this view.

Parameters

spine_db_editor (SpineDBEditor) –

_make_delegate(self, column_name, delegate_class)

Creates a delegate for the given column and returns it.

Parameters

• column_name (str) –

• delegate_class (ParameterDelegate) –

Returns

ParameterDelegate

create_delegates(self)

Creates delegates for this view

open_in_editor(self)

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

plot(self, checked=False)

Plots current index.

plot_in_window(self, action)

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

populate_context_menu(self)

Creates a context menu for this view.

contextMenuEvent(self, event)

Shows context menu.

Parameters

event (QContextMenuEvent) –

_selected_rows_per_column(self)

Computes selected rows per column.

Returns

Mapping columns to selected rows in that column.

Return type

dict

filter_by_selection(self, checked=False)

filter_excluding_selection(self, checked=False)

remove_selected(self)

Removes selected indexes.

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.ObjectParameterTableMixin

create_delegates(self)

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.RelationshipParameterTableMixin

create_delegates(self)

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

Bases: ParameterTableView

Custom QTableView class with autofilter functionality.

Initialize the view.

property value_column_header(self)

Either “default value” or “value”. Used to identifiy the value column for advanced editting and plotting.

create_delegates(self)

Creates delegates for this view

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

Bases: ParameterTableView

Custom QTableView class with autofilter functionality.

Initialize the view.

property value_column_header(self)

Either “default value” or “value”. Used to identifiy the value column for advanced editting and plotting.

create_delegates(self)

Creates delegates for this view

populate_context_menu(self)

Creates a context menu for this view.

show_value_metadata(self)

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

Bases: ObjectParameterTableMixin, ParameterDefinitionTableView

A custom QTableView for the object parameter_definition pane in Spine db editor.

Initialize the view.

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

Bases: RelationshipParameterTableMixin, ParameterDefinitionTableView

A custom QTableView for the relationship parameter_definition pane in Spine db editor.

Initialize the view.

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

Bases: ObjectParameterTableMixin, ParameterValueTableView

A custom QTableView for the object parameter_value pane in Spine db editor.

Initialize the view.

create_delegates(self)

Creates delegates for this view

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

Bases: RelationshipParameterTableMixin, ParameterValueTableView

A custom QTableView for the relationship parameter_value pane in Spine db editor.

Initialize the view.

create_delegates(self)

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.

Initialize the class.

_REMOVE_OBJECT = Remove objects

_REMOVE_RELATIONSHIP = Remove relationships

_REMOVE_PARAMETER = Remove parameter definitions

_REMOVE_ALTERNATIVE = Remove alternatives

_REMOVE_SCENARIO = Remove scenarios

property source_model(self)

property db_mngr(self)

connect_spine_db_editor(self, spine_db_editor)

populate_context_menu(self)

remove_selected(self)

remove_values(self)

remove_objects(self)

remove_relationships(self)

remove_parameters(self)

remove_alternatives(self)

remove_scenarios(self)

open_in_editor(self)

Opens the parameter_value editor for the first selected cell.

plot(self)

Plots the selected cells in the pivot table.

contextMenuEvent(self, event)

Shows context menu.

Parameters

event (QContextMenuEvent) –

_refresh_selected_indexes(self)

_update_actions_availability(self)

_can_remove_relationships(self)

_plot_in_window(self, action)

class spinetoolbox.spine_db_editor.widgets.custom_qtableview.FrozenTableView

Bases: PySide2.QtWidgets.QTableView

header_dropped

property area(self)

dragEnterEvent(self, event)

dragMoveEvent(self, event)

dropEvent(self, event)