8.6.4.1.1. pymodaq_gui.managers.settings.settings_manager module

class pymodaq_gui.managers.settings.settings_manager.SettingsManager(dashboard=None, handler_id='settings')[source]

Bases: ManagerBase

Main class managing settings values to be restored.

Could be extended with special subentries dealing with other features, see StateManager

Methods

`add_subentry`(special_entry_name)	Create an entry in the table from one of the special SubEntryHandlers
`connect_things`()
`do_things_for_new_creation`()
`format_subentries`(entries)
`get_entry_folder`(**kwargs_to_entry_folder)	Get the folder path where the managed entries are stored.
`get_module_from_param`(param)	should return the module name from data bundled in the ParameterWithPath
`populate_from_file`(file_path)	for quick testing purpose, not meant to be used at the end
`populate_from_settings`(settings)	Initialize the state from a Parameter settings.
`save_entries`([entry_path])
`set_readonly_setting`([param])	Set all settings as readonly but configure the VALID_FOR_CONFIGURATION option:
`setup_actions`()
`setup_docks_and_widgets`()
`setup_menus_and_toolbars`([menubar])

add_setting
display_settings
move_down_setting
move_up_setting
remove_setting
set_drag_mode_recursive
update_settings

static format_subentries(entries)[source]

static get_module_from_param(param)[source]

should return the module name from data bundled in the ParameterWithPath

To be reimplemented

Parameters:: param (ParameterWithPath)
Return type:: str

add_setting()[source]

add_subentry(special_entry_name)[source]: Create an entry in the table from one of the special SubEntryHandlers

connect_things()[source]

display_settings(display_all=True, param=None)[source]

do_things_for_new_creation()[source]

get_entry_folder(**kwargs_to_entry_folder)[source]

Get the folder path where the managed entries are stored.

Return type:: Path

move_down_setting()[source]

move_up_setting()[source]

populate_from_file(file_path)[source]: for quick testing purpose, not meant to be used at the end

populate_from_settings(settings)[source]

Initialize the state from a Parameter settings.

Parameters:: settings (Parameter) – Settings containing all modules configuration

remove_setting()[source]

save_entries(entry_path=None)[source]

set_drag_mode_recursive(param, movable=True, drop_enabled=True)[source]

set_readonly_setting(param=None)[source]

Set all settings as readonly but configure the VALID_FOR_CONFIGURATION option:

if initially readonly: VALID_FOR_CONFIGURATION is set to its value (if existing otherwise True if not specified) else: VALID_FOR_CONFIGURATION is set to False