Continue working on the checkmark menu

Author: MyNameIsTrez

Python/gui/checkbox_button_menu.py

@@ -0,0 +1,63 @@
+import PySimpleGUI as sg
+
+
+from Python import shared_globals as cfg
+
+
+def handle_button_press(window, buttonmenu_name, selected_button_name, user_settings_button_mappings):
+	buttonmenu = get_button_menu(window, buttonmenu_name)
+	menu_definition = get_menu_definition(buttonmenu)
+
+	selected_button_index = get_user_settings_button_index(user_settings_button_mappings, selected_button_name)
+
+	buttons = get_button_menu_buttons(menu_definition)
+	toggle_button(user_settings_button_mappings, selected_button_name, buttons, selected_button_index)
+
+	buttonmenu.update(menu_definition)
+
+
+def get_button_menu(window, buttonmenu_name):
+	return window[buttonmenu_name]
+
+
+def get_menu_definition(buttonmenu):
+	return buttonmenu.MenuDefinition
+
+
+def get_button_menu_buttons(menu_definition):
+	return menu_definition[1]
+
+
+def toggle_button(user_settings_button_mappings, selected_button_name, buttons, selected_button_index):
+	toggle_button_user_entry_setting(user_settings_button_mappings, selected_button_name)
+	toggle_button_visually(buttons, selected_button_index)
+
+
+def toggle_button_visually(buttons, selected_button_index):
+	current_button_string = buttons[selected_button_index]
+
+	if current_button_string[0] == cfg.CHECKMARK:
+		buttons[selected_button_index] = cfg.NO_CHECKMARK + current_button_string[1:]
+	else:
+		buttons[selected_button_index] = cfg.CHECKMARK + current_button_string[1:]
+
+
+def toggle_button_user_entry_setting(user_settings_button_mappings, selected_button_name):
+	user_settings_button_key = get_user_settings_button_value(user_settings_button_mappings, selected_button_name)
+
+	current_user_settings_button_state = sg.user_settings_get_entry(user_settings_button_key)
+	sg.user_settings_set_entry(user_settings_button_key, not current_user_settings_button_state)
+
+
+def get_user_settings_button_index(user_settings_button_mappings, selected_button_name):
+	""" We can't do a simple lookup due to the checkmark that may be in selected_button_name, so we need to use the in operator """
+	for i, button_name in enumerate(user_settings_button_mappings.keys()):
+		if button_name in selected_button_name:
+			return i
+
+
+def get_user_settings_button_value(user_settings_button_mappings, selected_button_name):
+	""" We can't do a simple lookup due to the checkmark that may be in selected_button_name, so we need to use the in operator """
+	for k, v in user_settings_button_mappings.items():
+		if k in selected_button_name:
+			return v

Python/gui/checkbox_button_menu_refactor_idea.py

@@ -0,0 +1,52 @@
+import PySimpleGUI as sg
+
+def find_sub_menu(widget, position):
+    length = widget.index("end")+1
+    for i in range(length):
+        label = widget.entrycget(i, 'label')
+        sub_menu = widget.nametowidget(widget.entrycget(i, 'menu'))
+        if label == position[0]:
+            if len(position) == 1:
+                return sub_menu
+            else:
+                return find_sub_menu(sub_menu, position[1:])
+
+def insert_menu_checkbutton(menu, position, indexes, labels):
+    widget = menu.Widget
+    sub_menu = find_sub_menu(widget, position)
+    if sub_menu:
+        for index, label in zip(indexes, labels):
+            var = sg.tk.BooleanVar()
+            sub_menu.insert_checkbutton(index, label=label, variable=var,
+                command=lambda label=label, var=var: menu._MenuItemChosenCallback(f'{label} {var.get()}'))
+    else:
+        print("Postion not found !")
+
+sg.theme("DarkBlue3")
+sg.set_options(font=("Courier New", 20))
+
+menu_def = [['&File', ['&Open', '&Save', '&Properties', 'E&xit']]]
+
+layout = [
+    [sg.Menu(menu_def, key='-MENU-')],
+    [sg.Button("Add Checkbox in Menu")],
+]
+window = sg.Window('Title', layout, finalize=True)
+variables = []
+while True:
+
+    event, values = window.read()
+    if event == sg.WINDOW_CLOSED:
+        break
+    elif event == "Add Checkbox in Menu":
+
+        menu = window['-MENU-']
+
+        position = ("File",)
+        indexes = (0, 2, 4)
+        labels = ("Confirmation", "Alarm", "Status")
+        insert_menu_checkbutton(menu, position, indexes, labels)
+
+    print(event, values)
+
+window.close()

Python/gui/gui.py

@@ -6,7 +6,9 @@
 from Python import shared_globals as cfg
 from Python import convert
 from Python import warnings
+
 from Python.gui import gui_layout
+from Python.gui import checkbox_button_menu
 
 
 def init_window_theme():
@@ -25,27 +27,34 @@ def init_window():
 	if not os.path.isfile(sg.user_settings_filename()):
 		sg.Popup("This is a tool that allows you to convert legacy (old) mods to the latest version of CCCP. You can get more information from the GitHub repo or the Discord server by clicking the corresponding icons.", title="Welcome screen", custom_text=" OK ")
 
-	# if not sg.user_settings_get_entry("cccp_folder"):
-	# 	sg.user_settings_set_entry("cccp_folder", "Input")
-
-	play_finish_sound_setting = sg.user_settings_get_entry("play_finish_sound")
-	sg.user_settings_set_entry("play_finish_sound", True if play_finish_sound_setting == None else play_finish_sound_setting)
+	# set_default_settings(window)
 
 	cfg.sg = sg
+
 	warnings.load_conversion_and_warning_rules() # TODO: Why is this called in this GUI function?
 
 	window = sg.Window(
 		f"Legacy Mod Converter {cfg.CONVERTER_VERSION} for CCCP {cfg.GAME_VERSION}",
 		gui_layout.get_layout(),
 		icon=utils.path("Media/legacy-mod-converter.ico"),
-		font=("Helvetica", 16)
+		font=("Helvetica", 16),
+		finalize=True
 	)
+
+	set_default_settings(window)
+
 	cfg.progress_bar = window["PROGRESS_BAR"]
-	window.finalize()
+
+	# window.finalize()
 
 	return window
 
 
+def set_default_settings(window):
+	if sg.user_settings_get_entry("play_finish_sound") == None:
+		checkbox_button_menu.handle_button_press(window, "SETTINGS", "Play finish sound", cfg.USER_SETTINGS_BUTTON_MAPPINGS)
+
+
 def run_window(window):
 	valid_cccp_path = True if sg.user_settings_get_entry("cccp_folder") else False
 
@@ -72,12 +81,9 @@ def run_window(window):
 				valid_cccp_path = False
 				window[event](background_color = cfg.NO_PATH_SET_COLOR)
 
-		elif event == "OUTPUT_ZIPS":
-			sg.user_settings_set_entry("output_zips", values[event])
-		elif event == "PLAY_FINISH_SOUND":
-			sg.user_settings_set_entry("play_finish_sound", values[event])
-		elif event == "SKIP_CONVERSION":
-			sg.user_settings_set_entry("skip_conversion", values[event])
+		elif event == "SETTINGS":
+			selected_button_name = values[event]
+			checkbox_button_menu.handle_button_press(window, event, selected_button_name, cfg.USER_SETTINGS_BUTTON_MAPPINGS)
 
 		elif event == "CONVERT":
 			if valid_cccp_path:

Python/gui/gui_layout.py

@@ -30,7 +30,18 @@ def get_layout():
 				)
 			],
 			[
-				sg.ButtonMenu('Options',  ['_', ['Edit Me', 'Exit']]),
+				sg.ButtonMenu(
+					"Settings",  [
+						"",
+						[
+							f"{cfg.NO_CHECKMARK}Skip conversion",
+							f"{cfg.NO_CHECKMARK}Output zips",
+							f"{cfg.NO_CHECKMARK}Play finish sound",
+						]
+					],
+					key="SETTINGS",
+					background_color="#2a3948"
+				),
 				sg.Button(
 					"Convert",
 					key="CONVERT",

Python/shared_globals.py

@@ -6,6 +6,15 @@
 CONVERTER_FOLDER_NAME = "LegacyModConverter" + VERSION_STRING
 WARNINGS_MOD_NAME_SEPARATOR = "-" * 50
 
+NO_CHECKMARK = " "
+CHECKMARK = "✓"
+
+USER_SETTINGS_BUTTON_MAPPINGS = {
+	"Skip conversion": "skip_conversion",
+	"Output zips": "output_zips",
+	"Play finish sound": "play_finish_sound"
+}
+
 NOT_RELEASE = True # This enables tests when set to True, as the release version shouldn't run tests.
 
 sg = None