spinetoolbox.spine_db_editor.widgets.spine_db_editor

Contains the SpineDBEditor class.

author

13. Marin (KTH)

date

26.11.2018

Module Contents

Classes

SpineDBEditorBase	Base class for SpineDBEditor (i.e. Spine database editor).
SpineDBEditor	A widget to visualize Spine dbs.

class spinetoolbox.spine_db_editor.widgets.spine_db_editor.SpineDBEditorBase(db_mngr)

Bases: PySide2.QtWidgets.QMainWindow

Base class for SpineDBEditor (i.e. Spine database editor).

Initializes form.

Parameters

db_mngr (SpineDBManager) – The manager to use

msg

link_msg

msg_error

file_exported

sqlite_file_exported

property toolbox(self)

property settings_subgroup(self)

property db_names(self)

property first_db_map(self)

property db_url_codenames(self)

load_db_urls(self, db_url_codenames, create=False, update_history=True)

init_add_undo_redo_actions(self)

fetch_db_maps(self, *db_maps)

_make_busy(self)

_make_iddle(self)

load_previous_urls(self, _=False)

load_next_urls(self, _=False)

open_db_file(self, _=False)

create_db_file(self, _=False)

_make_docks_menu(self)

Returns a menu with all dock toggle/view actions. Called by self.add_main_menu().

Returns

QMenu

add_main_menu(self)

Adds a menu with main actions to toolbar.

connect_signals(self)

Connects signals to slots.

update_undo_redo_actions(self, index)

_replace_undo_redo_actions(self, new_undo_action, new_redo_action)

_refresh_undo_redo_actions(self)

update_commit_enabled(self, _clean=False)

show_history_dialog(self, checked=False)

init_models(self)

Initializes models.

add_message(self, msg)

Pushes message to notification stack.

Parameters

msg (str) – String to show in the notification

add_link_msg(self, msg, open_link=None)

Pushes link message to notification stack.

Parameters

msg (str) – String to show in notification

refresh_copy_paste_actions(self)

Runs when menus are about to show. Enables or disables actions according to selection status.

copy(self, checked=False)

Copies data to clipboard.

paste(self, checked=False)

Pastes data from clipboard.

import_data(self, data)

import_file(self, checked=False)

Import file. It supports SQLite, JSON, and Excel.

import_from_json(self, file_path)

import_from_sqlite(self, file_path)

import_from_excel(self, file_path)

show_mass_export_items_dialog(self, checked=False)

Shows dialog for user to select dbs and items for export.

export_session(self, checked=False)

Exports changes made in the current session as reported by DiffDatabaseMapping.

mass_export_items(self, db_map_item_types)

export_data(self, db_map_ids_for_export)

Exports data from given dictionary into a file.

Parameters

db_map_ids_for_export – Dictionary mapping db maps to keyword arguments for spinedb_api.export_data

static _parse_db_map_metadata(db_map_metadata)

static _metadata_per_entity(db_map, entity_ids)

show_db_map_entity_metadata(self, db_map_ids)

static _metadata_per_parameter_value(db_map, param_val_ids)

show_db_map_parameter_value_metadata(self, db_map_ids)

reload_session(self, db_maps)

Reloads data from given db_maps.

refresh_session(self, checked=False)

commit_session(self, checked=False)

Commits session.

rollback_session(self, checked=False)

receive_session_committed(self, db_maps, cookie)

receive_session_rolled_back(self, db_maps)

receive_session_refreshed(self, db_maps)

show_mass_remove_items_form(self, checked=False)

show_parameter_value_editor(self, index)

Shows the parameter_value editor for the given index of given table view.

receive_error_msg(self, db_map_error_log)

log_changes(self, action, item_type, db_map_data)

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

receive_scenarios_added(self, db_map_data)

receive_alternatives_added(self, db_map_data)

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_entity_groups_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_features_added(self, db_map_data)

receive_tools_added(self, db_map_data)

receive_tool_features_added(self, db_map_data)

receive_tool_feature_methods_added(self, db_map_data)

receive_scenarios_updated(self, db_map_data)

receive_alternatives_updated(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_features_updated(self, db_map_data)

receive_tools_updated(self, db_map_data)

receive_tool_features_updated(self, db_map_data)

receive_tool_feature_methods_updated(self, db_map_data)

receive_parameter_definition_tags_set(self, db_map_data)

receive_scenarios_removed(self, db_map_data)

receive_alternatives_removed(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_entity_groups_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)

receive_features_removed(self, db_map_data)

receive_tools_removed(self, db_map_data)

receive_tool_features_removed(self, db_map_data)

receive_tool_feature_methods_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.

tear_down(self)

closeEvent(self, event)

Handle close window.

Parameters

event (QCloseEvent) – Closing event

class spinetoolbox.spine_db_editor.widgets.spine_db_editor.SpineDBEditor(db_mngr, db_url_codenames=None)

Bases: spinetoolbox.spine_db_editor.widgets.tabular_view_mixin.TabularViewMixin, spinetoolbox.spine_db_editor.widgets.graph_view_mixin.GraphViewMixin, spinetoolbox.spine_db_editor.widgets.parameter_view_mixin.ParameterViewMixin, spinetoolbox.spine_db_editor.widgets.tree_view_mixin.TreeViewMixin, SpineDBEditorBase

A widget to visualize Spine dbs.

Initializes everything.

Parameters

db_mngr (SpineDBManager) – The manager to use

connect_signals(self)

Connects signals to slots.

_restart_timer_refresh_tab_order(self, _visible=False)

_refresh_tab_order(self)

tabify_and_raise(self, docks)

Tabifies docks in given list, then raises the first.

Parameters

docks (list) –

restore_dock_widgets(self)

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

begin_style_change(self)

Begins a style change operation.

end_style_change(self)

Ends a style change operation.

apply_stacked_style(self, checked=False)

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

apply_pivot_style(self, _action)

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

apply_graph_style(self, checked=False)

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

static _get_base_dir()