New User Settings Demo

DemoPrograms/Demo_User_Settings.py

@@ -0,0 +1,79 @@
+import PySimpleGUI as sg
+
+"""
+    Demo - User Settings
+
+    Use the "user_settings" API calls to make a "settings window"
+
+    This demo is very basic. The user_settings functions are used directly without a lookup table
+    or some other mechanism to map between PySimpleGUI keys and user settings keys. 
+    
+    Copyright 2020 PySimpleGUI.org
+"""
+
+SETTINGS_PATH = '.'
+
+
+def make_window():
+    """
+    Creates a new window.  The default values for some elements are pulled directly from the
+    "User Settings" without the use of temp variables.
+
+    Some get_entry calls don't have a default value, such as theme, because there was an initial call
+    that would have set the default value if the setting wasn't present.  Could still put the default
+    value if you wanted but it would be 2 places to change if you wanted a different default value.
+
+    Use of a lookup table to map between element keys and user settings could be aded. This demo
+    is intentionally done without one to show how to use the settings APIs in the most basic,
+    straightforward way.
+
+    If your application allows changing the theme, then a make_window function is good to have
+    so that you can close and re-create a window easily.
+
+    :return: (sg.Window)  The window that was created
+    """
+
+    sg.user_settings_filename(path=SETTINGS_PATH)
+
+    sg.theme(sg.user_settings_get_entry('theme', 'DarkBlue2'))  # set the theme
+
+    layout = [[sg.Text('Settings Window')],
+              [sg.Input(sg.user_settings_get_entry('input', ''), k='-IN-')],
+              [sg.Listbox(sg.theme_list(), default_values=[sg.user_settings_get_entry('theme')], size=(15, 10), k='-LISTBOX-')],
+              [sg.CB('Option 1', sg.user_settings_get_entry('option1', True), k='-CB1-')],
+              [sg.CB('Option 2', sg.user_settings_get_entry('option2', False), k='-CB2-')],
+              [sg.T('Settings file = ' + sg.user_settings_filename())],
+              [sg.Button('Save'), sg.Button('Exit without saving', k='Exit')]]
+
+    return sg.Window('A Settings Window', layout)
+
+
+def settings_window():
+    """
+    Create and interact with a "settings window". You can a similar pair of functions to your
+    code to add a "settings" feature.
+    """
+
+    window = make_window()
+    current_theme = sg.theme()
+
+    while True:
+        event, values = window.read()
+        if event in (sg.WINDOW_CLOSED, 'Exit'):
+            break
+        if event == 'Save':
+            # Save some of the values as user settings
+            sg.user_settings_set_entry('input', values['-IN-'])
+            sg.user_settings_set_entry('theme', values['-LISTBOX-'][0])
+            sg.user_settings_set_entry('option1', values['-CB1-'])
+            sg.user_settings_set_entry('option2', values['-CB2-'])
+
+        # if the theme was changed, restart the window
+        if values['-LISTBOX-'][0] != current_theme:
+            current_theme = values['-LISTBOX-'][0]
+            window.close()
+            window = make_window()
+
+
+if __name__ == '__main__':
+    settings_window()