spinetoolbox.widgets.data_store_widget

Contains the DataStoreForm class.

author:

13. Marin (KTH)

date:

26.11.2018

Module Contents

class spinetoolbox.widgets.data_store_widget.DataStoreFormBase(db_mngr, *db_urls)

Bases: PySide2.QtWidgets.QMainWindow

Base class for DataStoreForm

Initializes form.

Parameters:

• db_mngr (SpineDBManager) – The manager to use
• *db_urls (tuple) – Database url, codename.

msg

msg_error

error_box

add_menu_actions(self)

Adds actions to View and Edit menu.

connect_signals(self)

Connects signals to slots.

update_undo_redo_actions(self, index)

update_commit_enabled(self, _clean=False)

show_history_dialog(self, checked=False)

init_models(self)

Initializes models.

add_message(self, msg)

Appends regular message to status bar.

Parameters:msg (str) – String to show in QStatusBar

restore_dock_widgets(self)

Docks all floating and or hidden QDockWidgets back to the window.

_handle_menu_edit_about_to_show(self)

Runs when the edit menu from the main menubar is about to show. Enables or disables actions according to selection status.

_find_focus_child(self)

selected_entity_class_ids(self, entity_class_type)

Returns object class ids selected in object tree and parameter tag toolbar.

_accept_selection(self, widget)

Clears selection from all widgets except the given one, so there’s only one selection in the form at a time. In addition, registers the given widget as the official source for all operations involving selections (copy, remove, edit), but only in case it has a selection.

remove_selection(self, checked=False)

Removes selection of items.

copy(self, checked=False)

Copies data to clipboard.

paste(self, checked=False)

Pastes data from clipboard.

show_import_file_dialog(self, checked=False)

Shows dialog to allow user to select a file to import.

export_database(self, checked=False)

Exports data from database into a file.

_select_database(self)

Lets user select a database from available databases.

Shows a dialog from which user can select a single database. If there is only a single database it is selected automatically and no dialog is shown.

Returns:the database map of the database or None if no database was selected

export_to_excel(self, db_map, file_path)

Exports data from database into Excel file.

export_to_sqlite(self, db_map, file_path)

Exports data from database into SQlite file.

refresh_session(self, checked=False)

commit_session(self, checked=False)

Commits session.

rollback_session(self, checked=False)

receive_session_committed(self, db_maps)

receive_session_rolled_back(self, db_maps)

receive_session_refreshed(self, db_maps)

_handle_tag_button_toggled(self, db_map_ids, checked)

Updates filter according to selected tags.

show_manage_parameter_tags_form(self, checked=False)

_handle_parameter_value_list_selection_changed(self, selected, deselected)

Accepts selection.

show_parameter_value_list_context_menu(self, pos)

Shows the context menu for parameter value list tree view.

Parameters:pos (QPoint) – Mouse position

remove_parameter_value_lists(self)

Removes selection of parameter value-lists.

notify_items_changed(self, action, item_type, db_map_data)

Enables or disables actions and informs the user about what just happened.

receive_object_classes_added(self, db_map_data)

receive_objects_added(self, db_map_data)

receive_relationship_classes_added(self, db_map_data)

receive_relationships_added(self, db_map_data)

receive_parameter_definitions_added(self, db_map_data)

receive_parameter_values_added(self, db_map_data)

receive_parameter_value_lists_added(self, db_map_data)

receive_parameter_tags_added(self, db_map_data)

receive_object_classes_updated(self, db_map_data)

receive_objects_updated(self, db_map_data)

receive_relationship_classes_updated(self, db_map_data)

receive_relationships_updated(self, db_map_data)

receive_parameter_definitions_updated(self, db_map_data)

receive_parameter_values_updated(self, db_map_data)

receive_parameter_value_lists_updated(self, db_map_data)

receive_parameter_tags_updated(self, db_map_data)

receive_parameter_definition_tags_set(self, db_map_data)

receive_object_classes_removed(self, db_map_data)

receive_objects_removed(self, db_map_data)

receive_relationship_classes_removed(self, db_map_data)

receive_relationships_removed(self, db_map_data)

receive_parameter_definitions_removed(self, db_map_data)

receive_parameter_values_removed(self, db_map_data)

receive_parameter_value_lists_removed(self, db_map_data)

receive_parameter_tags_removed(self, db_map_data)

restore_ui(self)

Restore UI state from previous session.

save_window_state(self)

Save window state parameters (size, position, state) via QSettings.

closeEvent(self, event)

Handle close window.

Parameters:event (QCloseEvent) – Closing event

class spinetoolbox.widgets.data_store_widget.DataStoreForm(db_mngr, *db_urls)

Bases: spinetoolbox.widgets.tabular_view_mixin.TabularViewMixin, spinetoolbox.widgets.graph_view_mixin.GraphViewMixin, spinetoolbox.widgets.parameter_view_mixin.ParameterViewMixin, spinetoolbox.widgets.tree_view_mixin.TreeViewMixin, spinetoolbox.widgets.data_store_widget.DataStoreFormBase

A widget to visualize Spine dbs.

Initializes everything.

Parameters:

• db_mngr (SpineDBManager) – The manager to use
• *db_urls (tuple) – Database url, codename.

connect_signals(self)

tabify_and_raise(self, docks)

Tabifies docks in given list, then raises the first.

Parameters:docks (list) –

begin_style_change(self)

Begins a style change operation.

end_style_change(self)

Ends a style change operation.

apply_tree_style(self, checked=False)

Applies the tree style, inspired in the former tree view.

apply_tabular_style(self, checked=False)

Applies the tree style, inspired in the former tabular view.

apply_graph_style(self, checked=False)

Applies the tree style, inspired in the former graph view.