Adds setting to reset view to letters on input change (#754)

Author: urikdev

app/src/main/java/com/urik/keyboard/UrikInputMethodService.kt

@@ -2530,6 +2530,10 @@ class UrikInputMethodService :
             coordinateStateClear()
         }
 
+        if (currentSettings.resetToLettersOnDismiss) {
+            viewModel.resetToLetters()
+        }
+
         autofillStateTracker.scheduleClear(serviceScope) {
             swipeKeyboardView?.forceClearAllSuggestions()
         }

app/src/main/java/com/urik/keyboard/settings/KeyboardSettings.kt

@@ -119,7 +119,8 @@ data class KeyboardSettings(
     val mergedDictionaries: Boolean = true,
     val pauseOnMisspelledWord: Boolean = true,
     val autocorrectionEnabled: Boolean = false,
-    val showNumberHints: Boolean = false
+    val showNumberHints: Boolean = false,
+    val resetToLettersOnDismiss: Boolean = true
 ) {
     /**
      * Whether word learning is enabled via [learnNewWords] flag.

app/src/main/java/com/urik/keyboard/settings/SettingsEvent.kt

@@ -66,6 +66,8 @@ sealed interface SettingsEvent {
 
         data object NumberHintsToggleFailed : Error
 
+        data object ResetToLettersOnDismissToggleFailed : Error
+
         data object DeleteWordFailed : Error
 
         data object DeleteAllWordsFailed : Error

app/src/main/java/com/urik/keyboard/settings/SettingsEventHandler.kt

@@ -131,6 +131,10 @@ class SettingsEventHandler(private val context: Context) {
                     context.getString(R.string.error_update_number_hints)
                 }
 
+                is SettingsEvent.Error.ResetToLettersOnDismissToggleFailed -> {
+                    context.getString(R.string.error_update_reset_to_letters)
+                }
+
                 is SettingsEvent.Error.DeleteWordFailed -> {
                     context.getString(R.string.error_delete_word)
                 }

app/src/main/java/com/urik/keyboard/settings/SettingsRepository.kt

@@ -79,6 +79,7 @@ constructor(
         val PAUSE_ON_MISSPELLED_WORD = booleanPreferencesKey("pause_on_misspelled_word")
         val AUTOCORRECTION_ENABLED = booleanPreferencesKey("autocorrection_enabled")
         val SHOW_NUMBER_HINTS = booleanPreferencesKey("show_number_hints")
+        val RESET_TO_LETTERS_ON_DISMISS = booleanPreferencesKey("reset_to_letters_on_dismiss")
     }
 
     /**
@@ -236,7 +237,8 @@ constructor(
                     mergedDictionaries = preferences[PreferenceKeys.MERGED_DICTIONARIES] ?: true,
                     pauseOnMisspelledWord = preferences[PreferenceKeys.PAUSE_ON_MISSPELLED_WORD] ?: true,
                     autocorrectionEnabled = preferences[PreferenceKeys.AUTOCORRECTION_ENABLED] ?: false,
-                    showNumberHints = preferences[PreferenceKeys.SHOW_NUMBER_HINTS] ?: false
+                    showNumberHints = preferences[PreferenceKeys.SHOW_NUMBER_HINTS] ?: false,
+                    resetToLettersOnDismiss = preferences[PreferenceKeys.RESET_TO_LETTERS_ON_DISMISS] ?: true
                 ).validated()
             }.catch { e ->
                 ErrorLogger.logException(
@@ -624,6 +626,16 @@ constructor(
         Result.failure(e)
     }
 
+    /**
+     * Updates reset-to-letters-on-dismiss toggle.
+     */
+    suspend fun updateResetToLettersOnDismiss(enabled: Boolean): Result<Unit> = try {
+        dataStore.edit { it[PreferenceKeys.RESET_TO_LETTERS_ON_DISMISS] = enabled }
+        Result.success(Unit)
+    } catch (e: Exception) {
+        Result.failure(e)
+    }
+
     /**
      * Clears all learned words from database and invalidates caches.
      *

app/src/main/java/com/urik/keyboard/settings/typingbehavior/TypingBehaviorFragment.kt

@@ -38,6 +38,7 @@ class TypingBehaviorFragment : PreferenceFragmentCompat() {
 
     private lateinit var doubleSpacePref: SwitchPreferenceCompat
     private lateinit var autoCapitalizationPref: SwitchPreferenceCompat
+    private lateinit var resetToLettersPref: SwitchPreferenceCompat
     private lateinit var swipePref: SwitchPreferenceCompat
     private lateinit var spacebarCursorPref: SwitchPreferenceCompat
     private lateinit var cursorSpeedPref: ListPreference
@@ -97,6 +98,16 @@ class TypingBehaviorFragment : PreferenceFragmentCompat() {
             }
         screen.addPreference(autoCapitalizationPref)
 
+        resetToLettersPref =
+            SwitchPreferenceCompat(context).apply {
+                key = "reset_to_letters_on_dismiss"
+                isPersistent = false
+                title = resources.getString(R.string.typing_settings_reset_to_letters)
+                summaryOn = resources.getString(R.string.typing_settings_reset_to_letters_on)
+                summaryOff = resources.getString(R.string.typing_settings_reset_to_letters_off)
+            }
+        screen.addPreference(resetToLettersPref)
+
         swipePref =
             SwitchPreferenceCompat(context).apply {
                 key = "swipe_enabled"
@@ -199,6 +210,11 @@ class TypingBehaviorFragment : PreferenceFragmentCompat() {
             true
         }
 
+        resetToLettersPref.setOnPreferenceChangeListener { _, newValue ->
+            viewModel.updateResetToLettersOnDismiss(newValue as Boolean)
+            true
+        }
+
         swipePref.setOnPreferenceChangeListener { _, newValue ->
             viewModel.updateSwipeEnabled(newValue as Boolean)
             true
@@ -249,6 +265,7 @@ class TypingBehaviorFragment : PreferenceFragmentCompat() {
                     viewModel.uiState.collect { state ->
                         doubleSpacePref.isChecked = state.doubleSpacePeriod
                         autoCapitalizationPref.isChecked = state.autoCapitalizationEnabled
+                        resetToLettersPref.isChecked = state.resetToLettersOnDismiss
                         swipePref.isChecked = state.swipeEnabled
                         spacebarCursorPref.isChecked = state.spacebarCursorControl
                         cursorSpeedPref.value = state.cursorSpeed.name

app/src/main/java/com/urik/keyboard/settings/typingbehavior/TypingBehaviorViewModel.kt

@@ -42,7 +42,8 @@ constructor(private val settingsRepository: SettingsRepository) :
                     longPressPunctuationMode = settings.longPressPunctuationMode,
                     longPressDuration = settings.longPressDuration,
                     hapticFeedback = settings.hapticFeedback,
-                    vibrationStrength = settings.vibrationStrength
+                    vibrationStrength = settings.vibrationStrength,
+                    resetToLettersOnDismiss = settings.resetToLettersOnDismiss
                 )
             }.stateIn(
                 scope = viewModelScope,
@@ -130,6 +131,14 @@ constructor(private val settingsRepository: SettingsRepository) :
         }
     }
 
+    fun updateResetToLettersOnDismiss(enabled: Boolean) {
+        viewModelScope.launch {
+            settingsRepository
+                .updateResetToLettersOnDismiss(enabled)
+                .onFailure { _events.emit(SettingsEvent.Error.ResetToLettersOnDismissToggleFailed) }
+        }
+    }
+
     private companion object {
         const val STOP_TIMEOUT_MILLIS = 5000L
     }
@@ -148,5 +157,6 @@ data class TypingBehaviorUiState(
     val longPressPunctuationMode: LongPressPunctuationMode = LongPressPunctuationMode.PERIOD,
     val longPressDuration: LongPressDuration = LongPressDuration.MEDIUM,
     val hapticFeedback: Boolean = true,
-    val vibrationStrength: Int = 128
+    val vibrationStrength: Int = 128,
+    val resetToLettersOnDismiss: Boolean = true
 )

app/src/main/java/com/urik/keyboard/ui/keyboard/KeyboardViewModel.kt

@@ -88,6 +88,18 @@ constructor(
         startLoadLayout(_state.value.currentMode)
     }
 
+    /**
+     * Resets keyboard mode to LETTERS.
+     *
+     * No-op if already in LETTERS mode.
+     */
+    fun resetToLetters() {
+        if (_state.value.currentMode != KeyboardMode.LETTERS) {
+            startLoadLayout(KeyboardMode.LETTERS)
+            updateState { it.copy(currentMode = KeyboardMode.LETTERS) }
+        }
+    }
+
     fun onEvent(event: KeyboardEvent) {
         viewModelScope.launch {
             _events.emit(event)

app/src/main/res/values-ar/strings.xml

@@ -122,6 +122,9 @@
     <string name="long_press_punctuation_spacebar">المسافة</string>
     <string name="long_press_punctuation_period">مفتاح النقطة</string>
     <string name="typing_settings_long_press_duration">فترة الضغط المطول</string>
+    <string name="typing_settings_reset_to_letters">إعادة الضبط إلى عرض الحروف عند تغيير الإدخال</string>
+    <string name="typing_settings_reset_to_letters_on">تشغيل</string>
+    <string name="typing_settings_reset_to_letters_off">إيقاف</string>
 
     <!-- Layout & Input Settings -->
     <string name="layout_settings_alternative_layout">تخطيط لوحة المفاتيح</string>
@@ -316,6 +319,7 @@
     <string name="merged_dictionaries_on">جميع قواميس اللغات المستخدمة في الاقتراحات</string>
 
     <string name="error_update_number_hints">فشل تحديث تلميحات الأرقام</string>
+    <string name="error_update_reset_to_letters">فشل تحديث إعداد إعادة الضبط إلى الحروف</string>
     <string name="layout_settings_show_number_hints">إظهار تلميحات الأرقام</string>
     <string name="layout_settings_number_hints_on">تشغيل</string>
     <string name="layout_settings_number_hints_off">إيقاف</string>

app/src/main/res/values-ca/strings.xml

@@ -115,6 +115,9 @@
     <string name="long_press_punctuation_spacebar">Barra espaiadora</string>
     <string name="long_press_punctuation_period">Tecla del període</string>
     <string name="typing_settings_long_press_duration">Duració de pulsació llarga</string>
+    <string name="typing_settings_reset_to_letters">Restableix a la vista de lletres en canviar l\'entrada</string>
+    <string name="typing_settings_reset_to_letters_on">Activat</string>
+    <string name="typing_settings_reset_to_letters_off">Desactivat</string>
     <!-- Layout & Input Settings -->
     <string name="layout_settings_alternative_layout">Disseny del teclat</string>
     <string name="layout_settings_adaptive_modes_enabled">Modes adaptatius del teclat</string>
@@ -284,6 +287,7 @@
     <string name="clipboard_item_unpin">Deixar de fixar l\'element al porta-retalls</string>
     <string name="clipboard_item_delete">Eliminar l\'element del porta-retalls</string>
     <string name="error_update_number_hints">Ha fallat l\'actualització dels suggeriments numèrics</string>
+    <string name="error_update_reset_to_letters">Ha fallat l\'actualització del paràmetre de restabliment a les lletres</string>
     <string name="layout_settings_show_number_hints">Mostrar suggeriments numèrics</string>
     <string name="layout_settings_number_hints_on">Activat</string>
     <string name="layout_settings_number_hints_off">Desactivat</string>