spinetoolbox.ui_main

Contains ToolboxUI class.

author:

16. Savolainen (VTT)

date:

14.12.2017

Module Contents

Classes

ToolboxUI

Class for application main GUI functions.

class spinetoolbox.ui_main.ToolboxUI

Bases: PySide2.QtWidgets.QMainWindow

Class for application main GUI functions.

Initializes application and main window.

msg

msg_success

msg_error

msg_warning

msg_proc

information_box

error_box

msg_proc_error

specification_model_changed

connect_signals(self)

Connect signals.

update_window_modified(self, clean)

Updates window modified status and save actions depending on the state of the undo stack.

parse_project_item_modules(self)

Collects attributes from project item modules into a dict. This dict is then used to perform all project item related tasks.

init_project_item_factory_model(self)

parse_assistant_modules(self)

Makes actions to run assistants from assistant modules.

show_assistant(self, module, action)

Creates and shows the assistant for the given module. Disables the given action while the assistant is shown, enables the action back when the assistant is destroyed. This is to make sure we don’t open the same assistant twice.

set_work_directory(self, new_work_dir=None)

Creates a work directory if it does not exist or changes the current work directory to given.

Parameters:new_work_dir (str, optional) – If given, changes the work directory to given and creates the directory if it does not exist.

project(self)

Returns current project or None if no project open.

qsettings(self)

Returns application preferences object.

update_window_title(self)

init_project(self, project_dir)

Initializes project at application start-up. Opens the last project that was open when app was closed (if enabled in Settings) or starts the app without a project.

new_project(self)

Opens a file dialog where user can select a directory where a project is created. Pops up a question box if selected directory is not empty or if it already contains a Spine Toolbox project. Initial project name is the directory name.

create_project(self, name, description, location)

Creates new project and sets it active.

Parameters:

• name (str) – Project name
• description (str) – Project description
• location (str) – Path to project directory

open_project(self, load_dir=None, clear_logs=True)

Opens project from a selected or given directory.

Parameters:

• load_dir (str) – Path to project base directory. If default value is used,
• file explorer dialog is opened where the user can select the (a) –
• to open. (project) –
• clear_logs (bool) – True clears Event and Process Log, False does not

Returns:

True when opening the project succeeded, False otherwise

Return type:

bool

restore_project(self, project_info, project_dir, clear_logs)

Initializes UI, Creates project, models, connections, etc., when opening a project.

Parameters:

• project_info (dict) – Project information dictionary
• project_dir (str) – Project directory
• clear_logs (bool) – True clears Event and Process Log, False does not

Returns:

True when restoring project succeeded, False otherwise

Return type:

bool

show_recent_projects_menu(self)

Updates and sets up the recent projects menu to File-Open recent menu item.

save_project(self)

Save project.

save_project_as(self)

Ask user for a new project name and save. Creates a duplicate of the open project.

upgrade_project(self, checked=False)

Upgrades an old style project (.proj file) to a new directory based Spine Toolbox project. Note that this method can be removed when we no longer want to support upgrading .proj projects. Project upgrading should happen later automatically when opening a project.

init_project_item_model(self)

Initializes project item model. Create root and category items and add them to the model.

init_specification_model(self, specification_paths)

Initializes Tool specification model.

Parameters:specification_paths (list) – List of tool definition file paths used in this project

load_specification_from_file(self, def_path)

Returns an Item specification from a definition file.

Parameters:def_path (str) – Path of the specification definition file Returns:item specification or None if reading the file failed Return type:ProjectItemSpecification

load_specification(self, definition, def_path)

Returns a Tool specification from a definition dictionary.

Parameters:

• definition (dict) – Dictionary with the tool definition
• def_path (str) – Path of the specification definition file

Returns:

ToolSpecification, NoneType

restore_ui(self)

Restore UI state from previous session.

clear_ui(self)

Clean UI to make room for a new or opened project.

undo_critical_commands(self)

Undoes critical commands in the undo stack.

overwrite_check(self, project_dir)

Checks if given directory is a project directory and/or empty And asks the user what to do in that case.

Parameters:project_dir (str) – Abs. path to a directory Returns:True if user wants to overwrite an existing project or if the directory is not empty and the user wants to make it into a Spine Toolbox project directory anyway. False if user cancels the action. Return type:bool

item_selection_changed(self, selected, deselected)

Synchronize selection with scene. Check if only one item is selected and make it the active item: disconnect signals of previous active item, connect signals of current active item and show correct properties tab for the latter.

activate_no_selection_tab(self)

Shows ‘No Selection’ tab.

activate_item_tab(self, item)

Shows project item properties tab according to item type. Note: Does not work if a category item is given as argument.

Parameters:item (ProjectItem) – Instance of a project item

import_specification(self)

Opens a file dialog where the user can select an existing specification definition file (.json). If file is valid, calls add_specification().

add_specification(self, specification)

Pushes a new AddSpecificationCommand to the undo stack.

do_add_specification(self, specification, row=None)

Adds a ProjectItemSpecification instance to project.

Parameters:specification (ProjectItemSpecification) – specification that is added to project

update_specification(self, row, specification)

Pushes a new UpdateSpecificationCommand to the undo stack.

do_update_specification(self, row, specification)

Updates a specification and refreshes all items that use it.

Parameters:

• row (int) – Row of tool specification in ProjectItemSpecFactoryModel
• specification (ProjectItemSpecification) – An updated specification

undo_update_specification(self, row)

Reverts a specification update and refreshes all items that use it.

Parameters:row (int) – Row of tool specification in ProjectItemSpecFactoryModel

_get_specific_items(self, specification)

Yields project items with given specification.

Parameters:specification (ProjectItemSpecification) –

remove_selected_specification(self, checked=False)

Removes specification selected in QListView.

remove_specification(self, row, ask_verification=True)

do_remove_specification(self, row, ask_verification=True)

Removes specification from ProjectItemSpecFactoryModel. Removes also specifications from all items that use this specification.

Parameters:

• row (int) – Row in ProjectItemSpecFactoryModel
• ask_verification (bool) – If True, displays a dialog box asking user to verify the removal

remove_all_items(self)

Removes all items from project. Slot for Remove All button.

open_anchor(self, qurl)

Open file explorer in the directory given in qurl.

Parameters:qurl (QUrl) – Directory path or a file to open

show_specification_context_menu(self, pos)

Context menu for item specifications.

Parameters:pos (QPoint) – Mouse position

edit_specification(self, index)

Open the tool specification widget for editing an existing tool specification.

Parameters:index (QModelIndex) – Index of the item (from double-click or contex menu signal)

open_specification_file(self, index)

Open the specification definition file in the default (.json) text-editor.

Parameters:index (QModelIndex) – Index of the item

export_as_graphml(self)

Exports all DAGs in project to separate GraphML files.

_handle_zoom_minus_pressed(self)

Slot for handling case when ‘-‘ button in menu is pressed.

_handle_zoom_plus_pressed(self)

Slot for handling case when ‘+’ button in menu is pressed.

_handle_zoom_reset_pressed(self)

Slot for handling case when ‘reset zoom’ button in menu is pressed.

setup_zoom_widget_action(self)

Setups zoom widget action in view menu.

restore_dock_widgets(self)

Dock all floating and or hidden QDockWidgets back to the main window.

set_debug_qactions(self)

Set shortcuts for QActions that may be needed in debugging.

add_menu_actions(self)

Add extra actions to View menu.

toggle_properties_tabbar_visibility(self)

Shows or hides the tab bar in properties dock widget. For debugging purposes.

update_datetime(self)

Returns a boolean, which determines whether date and time is prepended to every Event Log message.

add_message(self, msg)

Append regular message to Event Log.

Parameters:msg (str) – String written to QTextBrowser

add_success_message(self, msg)

Append message with green text color to Event Log.

Parameters:msg (str) – String written to QTextBrowser

add_error_message(self, msg)

Append message with red color to Event Log.

Parameters:msg (str) – String written to QTextBrowser

add_warning_message(self, msg)

Append message with yellow (golden) color to Event Log.

Parameters:msg (str) – String written to QTextBrowser

add_process_message(self, msg)

Writes message from stdout to process output QTextBrowser.

Parameters:msg (str) – String written to QTextBrowser

add_process_error_message(self, msg)

Writes message from stderr to process output QTextBrowser.

Parameters:msg (str) – String written to QTextBrowser

show_add_project_item_form(self, item_type, x=0, y=0, spec='')

Show add project item widget.

show_specification_form(self, item_type, specification=None)

Show specification widget.

show_settings(self)

Show Settings widget.

show_about(self)

Show About Spine Toolbox form.

show_user_guide(self)

Open Spine Toolbox User Guide index page. First tries to open the local docs but if they are missing, opens the docs from readthedocs.org.

show_getting_started_guide(self)

Open Spine Toolbox Getting Started HTML page in browser.

show_item_context_menu(self, pos)

Context menu for project items listed in the project QTreeView.

Parameters:pos (QPoint) – Mouse position

show_item_image_context_menu(self, pos, name)

Context menu for project item images on the QGraphicsView.

Parameters:

• pos (QPoint) – Mouse position
• name (str) – The name of the concerned item

show_project_item_context_menu(self, pos, ind)

Create and show project item context menu.

Parameters:

• pos (QPoint) – Mouse position
• ind (QModelIndex) – Index of concerned item

show_link_context_menu(self, pos, link)

Context menu for connection links.

Parameters:

• pos (QPoint) – Mouse position
• link (Link(QGraphicsPathItem)) – The concerned link

tear_down_items(self)

Calls the tear_down method on all project items, so they can clean up their mess if needed.

_tasks_before_exit(self)

Returns a list of tasks to perform before exiting the application.

Possible tasks are:

• “prompt exit”: prompt user if quitting is really desired
• “prompt save”: prompt user if project should be saved before quitting
• “save”: save project before quitting

Returns:a list containing zero or more tasks

_perform_pre_exit_tasks(self)

Prompts user to confirm quitting and saves the project if necessary.

Returns:True if exit should proceed, False if the process was cancelled

_confirm_exit(self)

Confirms exiting from user.

Returns:True if exit should proceed, False if user cancelled

_confirm_save_and_exit(self)

Confirms exit from user and saves the project if requested.

Returns:True if exiting should proceed, False if user cancelled

remove_path_from_recent_projects(self, p)

Removes entry that contains given path from the recent project files list in QSettings.

Parameters:p (str) – Full path to a project directory

update_recent_projects(self)

Adds a new entry to QSettings variable that remembers the five most recent project paths.

closeEvent(self, event)

Method for handling application exit.

Parameters:event (QCloseEvent) – PySide2 event

_serialize_selected_items(self)

Serializes selected project items into a dictionary.

The serialization protocol tries to imitate the format in which projects are saved. The format of the dictionary is following: {“item_category_1”: [{“name”: “item_1_name”, …}, …], …}

Returns:a dict containing serialized version of selected project items

_deserialized_item_position_shifts(self, serialized_items)

Calculates horizontal and vertical shifts for project items being deserialized.

If the mouse cursor is on the Design view we try to place the items unders the cursor. Otherwise the items will get a small shift so they don’t overlap a possible item below. In case the items don’t fit the scene rect we clamp their coordinates within it.

Parameters:serialized_items (dict) – a dictionary of serialized items being deserialized Returns:a tuple of (horizontal shift, vertical shift) in scene’s coordinates

static _set_deserialized_item_position(item_dict, shift_x, shift_y, scene_rect)

Moves item’s position by shift_x and shift_y while keeping it within the limits of scene_rect.

_deserialize_items(self, serialized_items)

Deserializes project items from a dictionary and adds them to the current project.

Parameters:serialized_items (dict) – serialized project items

project_item_to_clipboard(self)

Copies the selected project items to system’s clipboard.

project_item_from_clipboard(self)

Adds project items in system’s clipboard to the current project.

duplicate_project_item(self)

Duplicates the selected project items.

propose_item_name(self, prefix)

Proposes a name for a project item.

The format is prefix_xx where xx is a counter value [01..99].

Parameters:prefix (str) – a prefix for the name Returns:a name string

_item_edit_actions(self)

Creates project item edit actions (copy, paste, duplicate) and adds them to proper places.

_scroll_event_log_to_end(self)

_show_message_box(self, title, message)

Shows an information message box.

_show_error_box(self, title, message)

_connect_project_signals(self)

Connects signals emitted by project.