spinetoolbox.widgets.settings_widget

Widget for controlling user settings.

author

16. Savolainen (VTT)

date

17.1.2018

Module Contents

Classes

SettingsWidgetBase	param qsettings Toolbox settings
SpineDBEditorSettingsMixin
SpineDBEditorSettingsWidget	A widget to change user’s preferred settings, but only for the Spine db editor.
SettingsWidget	A widget to change user’s preferred settings.

Functions

_get_python_exe_by_kernel_name(kernel_name)
_get_python_kernel_name_by_exe(python_exe)
_get_julia_env_by_kernel_name(kernel_name)
_get_julia_kernel_name_by_env(julia_exe, julia_project)
_samefile(a, b)

class spinetoolbox.widgets.settings_widget.SettingsWidgetBase(qsettings)

Bases: PySide2.QtWidgets.QWidget

Parameters

qsettings (QSettings) – Toolbox settings

connect_signals(self)

Connect signals.

keyPressEvent(self, e)

Close settings form when escape key is pressed.

Parameters

e (QKeyEvent) – Received key press event.

mousePressEvent(self, e)

Save mouse position at the start of dragging.

Parameters

e (QMouseEvent) – Mouse event

mouseReleaseEvent(self, e)

Save mouse position at the end of dragging.

Parameters

e (QMouseEvent) – Mouse event

mouseMoveEvent(self, e)

Moves the window when mouse button is pressed and mouse cursor is moved.

Parameters

e (QMouseEvent) – Mouse event

update_ui(self)

Updates UI to reflect current settings. Called when the user choses to cancel their changes. Undoes all temporary UI changes that resulted from the user playing with certain settings.

save_settings(self)

Gets selections and saves them to persistent memory.

update_ui_and_close(self, checked=False)

Updates UI to reflect current settings and close.

save_and_close(self, checked=False)

Saves settings and close.

class spinetoolbox.widgets.settings_widget.SpineDBEditorSettingsMixin

connect_signals(self)

Connect signals.

read_settings(self)

Read saved settings from app QSettings instance and update UI to display them.

save_settings(self)

Get selections and save them to persistent memory.

update_ui(self)

class spinetoolbox.widgets.settings_widget.SpineDBEditorSettingsWidget(multi_db_editor)

Bases: SpineDBEditorSettingsMixin, SettingsWidgetBase

A widget to change user’s preferred settings, but only for the Spine db editor.

Initialize class.

show(self)

set_auto_expand_objects(self, checked=False)

class spinetoolbox.widgets.settings_widget.SettingsWidget(toolbox)

Bases: SpineDBEditorSettingsMixin, SettingsWidgetBase

A widget to change user’s preferred settings.

Parameters

toolbox (ToolboxUI) – Parent widget.

connect_signals(self)

Connect signals.

_handle_python_kernel_changed(self, kernel_name)

_handle_python_exe_changed(self)

_handle_julia_kernel_changed(self, kernel_name)

_handle_julia_env_changed(self)

_show_install_julia_wizard(self)

_show_add_up_spine_opt_wizard(self)

set_auto_expand_objects(self, checked=False)

browse_gams_path(self, checked=False)

Open file browser where user can select a GAMS program.

browse_julia_button_clicked(self, checked=False)

Calls static method that shows a file browser for selecting the Julia path.

browse_julia_project_button_clicked(self, checked=False)

Calls static method that shows a file browser for selecting a Julia project.

browse_python_button_clicked(self, checked=False)

Calls static method that shows a file browser for selecting Python interpreter.

show_python_kernel_editor(self, checked=False)

Opens kernel editor, where user can make a kernel for the Python Console.

python_kernel_editor_closed(self, ret_code)

Catches the selected Python kernel name when the editor is closed.

show_julia_kernel_editor(self, checked=False)

Opens kernel editor, where user can make a kernel the Julia Console.

julia_kernel_editor_closed(self, ret_code)

Catches the selected Julia kernel name when the editor is closed.

browse_work_path(self, checked=False)

Open file browser where user can select the path to wanted work directory.

show_color_dialog(self, checked=False)

Let user pick the bg color.

Parameters

checked (boolean) – Value emitted with clicked signal

update_bg_color(self)

Set tool button icon as the selected color and update Design View scene background color.

update_scene_bg(self, checked=False)

Draw background on scene depending on radiobutton states.

Parameters

checked (boolean) – Toggle state

update_links_geometry(self, checked=False)

set_toolbar_colored_icons(self, checked=False)

read_settings(self)

Read saved settings from app QSettings instance and update UI to display them.

read_project_settings(self)

Get project name and description and update widgets accordingly.

save_settings(self)

Get selections and save them to persistent memory. Note: On Linux, True and False are saved as boolean values into QSettings. On Windows, booleans and integers are saved as strings. To make it consistent, we should use strings.

_get_julia_settings(self)

update_project_settings(self)

Update project name and description if these have been changed.

set_work_directory(self, new_work_dir)

Sets new work directory.

Parameters

new_work_dir (str) – Possibly a new work directory

update_ui(self)

Updates UI to reflect current settings. Called when the user choses to cancel their changes. Undoes all temporary UI changes that resulted from the user playing with certain settings.

spinetoolbox.widgets.settings_widget._get_python_exe_by_kernel_name(kernel_name)

spinetoolbox.widgets.settings_widget._get_python_kernel_name_by_exe(python_exe)

spinetoolbox.widgets.settings_widget._get_julia_env_by_kernel_name(kernel_name)

spinetoolbox.widgets.settings_widget._get_julia_kernel_name_by_env(julia_exe, julia_project)

spinetoolbox.widgets.settings_widget._samefile(a, b)