Add files via upload

Author: ways2read

NVDA-addon/addon/globalPlugins/MathCAT/MathCATPreferences.py

@@ -0,0 +1,189 @@
+import wx
+import MathCATgui
+import yaml
+import os
+import sys
+import webbrowser  
+from tendo import singleton
+import gettext
+_ = gettext.gettext
+
+#initialize the languages dictionary
+Speech_Language = { "en": "English : en"}
+
+# initialize the user preferences tuples
+user_preferences = dict([("", "")])
+Speech_Impairment = ("LearningDisability", "Blindness", "LowVision")
+Speech_Verbosity = ("Terse", "Medium", "Verbose")
+Speech_SpeechStyle = ("ClearSpeak", "SimpleSpeak")
+Speech_SubjectArea = ("General")
+Speech_Chemistry = ("SpellOut", "AsCompound", "Off")
+
+Navigation_NavMode = ("Enhanced", "Simple", "Character")
+#Navigation_ResetNavMode is boolean
+#Navigation_OverView is boolean
+Navigation_NavVerbosity = ("Terse", "Medium", "Verbose")
+#Navigation_AutoZoomOut is boolean
+
+Braille_BrailleNavHighlight = ("Off", "FirstChar", "EndPoints", "All")
+Braille_BrailleCode = ("Nemeth", "UEB")
+
+def path_to_default_preferences():
+    #the default preferences file is: C:\Users\<user-name>AppData\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\prefs.yaml
+    return os.path.expanduser('~')+"\\AppData\\Roaming\\nvda\\addons\\mathCAT\\globalPlugins\\MathCAT\\Rules\\prefs.yaml";
+
+def path_to_user_preferences_folder():
+    #the user preferences file is stored at: C:\Users\<user-name>AppData\Roaming\MathCAT\prefs.yaml
+    return os.path.expanduser('~')+"\\AppData\\Roaming\\MathCAT";
+
+def path_to_user_preferences():
+    #the user preferences file is stored at: C:\Users\<user-name>AppData\Roaming\MathCAT\prefs.yaml
+    return path_to_user_preferences_folder() + "\\prefs.yaml";
+
+def load_default_preferences():
+    global user_preferences
+    #load default preferences into the user preferences data structure (overwites existing)
+    if os.path.exists(path_to_default_preferences()):
+        with open(path_to_default_preferences()) as f:
+            user_preferences = yaml.load(f, Loader=yaml.FullLoader)
+    else:
+        #default preferences file is NOT found
+        wx.MessageBox(_(u"MathCat preferences file not found. The program will now exit."), "Error", wx.OK | wx.ICON_ERROR)
+        os.sys.exit(-1)
+
+def load_user_preferences():
+    global user_preferences
+    #merge user file values into the user preferences data structure
+    if os.path.exists(path_to_user_preferences()):
+        with open(path_to_user_preferences()) as f:
+            # merge with the default preferences, overwriting with the user's values
+            user_preferences |= yaml.load(f, Loader=yaml.FullLoader)
+
+def write_user_preferences():
+    if not os.path.exists(path_to_user_preferences_folder()):
+        #create a folder for the user preferences
+        os.mkdir(path_to_user_preferences_folder())
+    with open(path_to_user_preferences(), 'w') as f:
+        #write values to the user preferences file, NOT the default
+        yaml.dump(user_preferences, f)
+
+def GetKey(val):
+   for key, value in Speech_Language.items():
+      if val == value:
+         return key 
+   return "en"
+
+class UserInterface(MathCATgui.MathCATPreferencesDialog):
+
+    def set_ui_values(self):
+        #set the UI elements to the ones read from the preference file(s)
+        try:
+            self.m_choiceImpairment.SetSelection(Speech_Impairment.index(user_preferences["Speech"]["Impairment"]))
+            self.m_choiceLanguage.SetStringSelection(Speech_Language[user_preferences["Speech"]["Language"]])
+            self.m_choiceSpeechStyle.SetSelection(Speech_SpeechStyle.index(user_preferences["Speech"]["SpeechStyle"]))
+            self.m_choiceSpeechAmount.SetSelection(Speech_Verbosity.index(user_preferences["Speech"]["Verbosity"]))
+            self.m_choiceSpeechForChemical.SetSelection(Speech_Chemistry.index(user_preferences["Speech"]["Chemistry"]))
+            self.m_choiceNavigationMode.SetSelection(Navigation_NavMode.index(user_preferences["Navigation"]["NavMode"]))
+            self.m_checkBoxResetNavigationMode.SetValue(user_preferences["Navigation"]["ResetNavMode"])
+            self.m_choiceSpeechAmountNavigation.SetSelection(Navigation_NavVerbosity.index(user_preferences["Navigation"]["NavVerbosity"]))
+            if user_preferences["Navigation"]["Overview"]:
+                self.m_choiceNavigationSpeech.SetSelection(0)
+            else:
+                self.m_choiceNavigationSpeech.SetSelection(1)
+            self.m_checkBoxResetNavigationSpeech.SetValue(user_preferences["Navigation"]["ResetOverview"])
+            self.m_checkBoxAutomaticZoom.SetValue(user_preferences["Navigation"]["AutoZoomOut"])
+            self.m_choiceBrailleHighlights.SetSelection(Braille_BrailleNavHighlight.index(user_preferences["Braille"]["BrailleNavHighlight"]))
+            self.m_choiceBrailleMathCode.SetSelection(Braille_BrailleCode.index(user_preferences["Braille"]["BrailleCode"]))
+        except KeyError as err:
+            print('Key not found')
+        		
+    def get_ui_values(self):
+        global user_preferences
+        # read the values from the UI and update the user preferences dictionary
+        user_preferences["Speech"]["Impairment"] = Speech_Impairment[self.m_choiceImpairment.GetSelection()]
+        user_preferences["Speech"]["Language"] = GetKey( self.m_choiceLanguage.GetStringSelection())
+        user_preferences["Speech"]["SpeechStyle"] = Speech_SpeechStyle[self.m_choiceSpeechStyle.GetSelection()]
+        user_preferences["Speech"]["Verbosity"] = Speech_Verbosity[self.m_choiceSpeechAmount.GetSelection()]
+        user_preferences["Speech"]["Chemistry"] = Speech_Chemistry[self.m_choiceSpeechForChemical.GetSelection()]
+        user_preferences["Navigation"]["NavMode"] = Navigation_NavMode[self.m_choiceNavigationMode.GetSelection()]
+        user_preferences["Navigation"]["ResetNavMode"] = self.m_checkBoxResetNavigationMode.GetValue()
+        user_preferences["Navigation"]["NavVerbosity"] = Navigation_NavVerbosity[self.m_choiceSpeechAmountNavigation.GetSelection()]
+        if self.m_choiceNavigationSpeech.GetSelection() == 0:
+            user_preferences["Navigation"]["Overview"] = True
+        else:
+            user_preferences["Navigation"]["Overview"] = False
+        user_preferences["Navigation"]["ResetOverview"] = self.m_checkBoxResetNavigationSpeech.GetValue()
+        user_preferences["Navigation"]["AutoZoomOut"] = self.m_checkBoxAutomaticZoom.GetValue()
+        user_preferences["Braille"]["BrailleNavHighlight"] = Braille_BrailleNavHighlight[self.m_choiceBrailleHighlights.GetSelection()]
+        user_preferences["Braille"]["BrailleCode"] = Braille_BrailleCode[self.m_choiceBrailleMathCode.GetSelection()]
+        user_preferences["MathCATPreferencesLastCategory"] = self.m_listBoxPreferencesTopic.GetSelection()
+
+    def __init__(self,parent):
+        #initialize parent class
+        MathCATgui.MathCATPreferencesDialog.__init__(self,parent)
+        if "MathCATPreferencesLastCategory" in user_preferences:
+            #set the categories selection to what we used on last run
+            self.m_listBoxPreferencesTopic.SetSelection(user_preferences["MathCATPreferencesLastCategory"])
+            #show the appropriate dialogue page
+            self.m_simplebookPanelsCategories.SetSelection(self.m_listBoxPreferencesTopic.GetSelection())
+        else:
+            #set the categories selection to the first item
+            self.m_listBoxPreferencesTopic.SetSelection(0)
+            user_preferences["MathCATPreferencesLastCategory"]="0"
+        #populate the language choices
+        self.m_choiceLanguage.Clear()
+        for lang in Speech_Language.values():
+            self.m_choiceLanguage.Append(lang)
+        #populate the SpeechStyle choices
+        #this will need to be done on change of language
+        self.m_choiceSpeechStyle.Clear()
+        self.m_choiceSpeechStyle.Append("ClearSpeak")
+
+        UserInterface.set_ui_values(self)
+
+    def OnClickOK(self,event):
+        UserInterface.get_ui_values(self)
+        write_user_preferences()
+        app.ExitMainLoop()
+ 
+    def OnClickCancel(self,event):
+        app.ExitMainLoop()
+ 
+    def OnClickApply(self,event):
+        UserInterface.get_ui_values(self)
+        write_user_preferences()
+ 
+    def OnClickReset(self,event):
+        load_default_preferences()
+        UserInterface.set_ui_values(self)
+ 
+    def OnClickHelp(self,event):
+        webbrowser.open('https://nsoiffer.github.io/MathCAT/users.html')
+
+    def OnListBoxCategories(self,event):
+        #show the appropriate dialogue page
+        self.m_simplebookPanelsCategories.SetSelection(self.m_listBoxPreferencesTopic.GetSelection())
+
+    def MathCATPreferencesDialogOnCharHook(self,event):
+        #designed choice is that Enter is the same as clicking OK, and Escape is the same as clicking Cancel
+        keyCode = event.GetKeyCode()
+        if keyCode == wx.WXK_ESCAPE:
+            UserInterface.OnClickCancel(self,event)
+        if keyCode == wx.WXK_RETURN:
+            UserInterface.OnClickOK(self,event)
+        event.Skip()
+
+#if there is already an instance of MathCATPreferences running then terminate
+try:
+    me = singleton.SingleInstance() # will sys.exit(-1) if other instance is running
+except:
+    os.sys.exit(-2)
+
+app = wx.App(False)
+#get the default preferences (we don't write to this file)
+load_default_preferences()
+#having grabbed the default values, let's see if there is a preferences file for this user
+load_user_preferences()
+frame = UserInterface(None)
+frame.Show(True)
+app.MainLoop()