feat: enable search functionality for ControlSettings (Reviews & Previews)

Author: sanjaysargam

AnkiDroid/src/main/java/com/ichi2/anki/preferences/ControlsSettingsFragment.kt

@@ -61,6 +61,24 @@ class ControlsSettingsFragment :
         setupNewStudyScreenSettings()
     }
 
+    /**
+     * Selects the appropriate tab based on a preference key from search results.
+     * This allows search navigation to automatically switch to the correct tab.
+     */
+    fun selectTabForPreference(key: String) {
+        val targetTabIndex = actionToScreenMap[key]?.ordinal
+        if (targetTabIndex == null) {
+            Timber.w("Could not find the preference with %s key", key)
+            return
+        }
+
+        view?.post {
+            requirePreference<ControlsTabPreference>(
+                R.string.pref_controls_tab_layout_key,
+            ).selectTab(targetTabIndex)
+        }
+    }
+
     private fun setControlPreferencesDefaultValues(screen: ControlPreferenceScreen) {
         val commands = screen.getActions().associateBy { it.preferenceKey }
         val prefs = sharedPrefs()
@@ -157,6 +175,13 @@ class ControlsSettingsFragment :
     }
 
     companion object {
+        val actionToScreenMap: Map<String, ControlPreferenceScreen> by lazy {
+            ControlPreferenceScreen.entries
+                .flatMap { screen ->
+                    screen.getActions().map { action -> action.preferenceKey to screen }
+                }.toMap()
+        }
+
         val legacyStudyScreenSettings =
             listOf(
                 R.string.save_voice_command_key,

AnkiDroid/src/main/java/com/ichi2/anki/preferences/ControlsTabPreference.kt

@@ -45,6 +45,14 @@ class ControlsTabPreference
             tabLayout?.addOnTabSelectedListener(listener)
         }
 
+        /**
+         * Selects a tab programmatically by position.
+         * @param tabPosition The position of the tab to select.
+         */
+        fun selectTab(tabPosition: Int) {
+            tabLayout?.selectTab(tabLayout?.getTabAt(tabPosition))
+        }
+
         override fun onBindViewHolder(holder: PreferenceViewHolder) {
             super.onBindViewHolder(holder)
             tabLayout = holder.itemView as? TabLayout

AnkiDroid/src/main/java/com/ichi2/anki/preferences/HeaderFragment.kt

@@ -130,6 +130,12 @@ class HeaderFragment : SettingsFragment() {
                         .addBreadcrumb(R.string.pref_cat_appearance)
                 }
                 index(R.xml.preferences_controls)
+                index(R.xml.preferences_reviewer_controls)
+                    .addBreadcrumb(activity.getString(R.string.pref_cat_controls))
+                    .addBreadcrumb(activity.getString(R.string.pref_controls_reviews_tab))
+                index(R.xml.preferences_previewer_controls)
+                    .addBreadcrumb(activity.getString(R.string.pref_cat_controls))
+                    .addBreadcrumb(activity.getString(R.string.pref_controls_previews_tab))
                 index(R.xml.preferences_accessibility)
                 index(R.xml.preferences_backup_limits)
                 ignorePreference(activity.getString(R.string.pref_backups_help_key))

AnkiDroid/src/main/java/com/ichi2/anki/preferences/Preferences.kt

@@ -32,6 +32,7 @@ import androidx.fragment.app.FragmentFactory
 import androidx.fragment.app.FragmentManager
 import androidx.fragment.app.FragmentTransaction
 import androidx.fragment.app.commit
+import androidx.lifecycle.lifecycleScope
 import androidx.preference.Preference
 import androidx.preference.PreferenceFragmentCompat
 import com.bytehamster.lib.preferencesearch.SearchConfiguration
@@ -46,10 +47,13 @@ import com.ichi2.anki.common.annotations.LegacyNotifications
 import com.ichi2.anki.preferences.HeaderFragment.Companion.getHeaderKeyForFragment
 import com.ichi2.anki.reviewreminders.ReviewReminderScope
 import com.ichi2.anki.reviewreminders.ScheduleReminders
+import com.ichi2.anki.utils.AnimationUtils.areSystemAnimationsEnabled
 import com.ichi2.anki.utils.ext.sharedPrefs
 import com.ichi2.anki.utils.isWindowCompact
 import com.ichi2.themes.Themes
 import com.ichi2.utils.FragmentFactoryUtils
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.launch
 import timber.log.Timber
 import kotlin.reflect.KClass
 import kotlin.reflect.jvm.jvmName
@@ -137,8 +141,22 @@ class PreferencesFragment :
             addToBackStack(fragment.javaClass.name)
         }
 
-        Timber.i("Highlighting key '%s' on %s", result.key, fragment)
-        result.highlight(fragment as PreferenceFragmentCompat)
+        if (fragment is ControlsSettingsFragment) {
+            fragment.lifecycleScope.launch {
+                if (areSystemAnimationsEnabled(requireContext())) {
+                    delay(100)
+                    fragment.selectTabForPreference(result.key)
+                    delay(150)
+                    result.highlight(fragment as PreferenceFragmentCompat)
+                } else {
+                    // Animations disabled - do everything immediately
+                    fragment.selectTabForPreference(result.key)
+                    result.highlight(fragment as PreferenceFragmentCompat)
+                }
+            }
+        } else {
+            result.highlight(fragment as PreferenceFragmentCompat)
+        }
     }
 
     private fun setupBackCallbacks() {
@@ -282,6 +300,8 @@ fun getFragmentFromXmlRes(
         R.xml.preferences_notifications -> NotificationsSettingsFragment()
         R.xml.preferences_appearance -> AppearanceSettingsFragment()
         R.xml.preferences_controls -> ControlsSettingsFragment()
+        R.xml.preferences_reviewer_controls -> ControlsSettingsFragment()
+        R.xml.preferences_previewer_controls -> ControlsSettingsFragment()
         R.xml.preferences_advanced -> AdvancedSettingsFragment()
         R.xml.preferences_accessibility -> AccessibilitySettingsFragment()
         R.xml.preferences_dev_options -> DevOptionsFragment()

AnkiDroid/src/test/java/com/ichi2/anki/preferences/PrefsSearchBarTest.kt

@@ -68,10 +68,18 @@ class PrefsSearchBarTest : RobolectricTest() {
             val fragment = getFragmentFromXmlRes(resId)
 
             assertNotNull(fragment)
+
+            // Special handling for ControlsSettingsFragment which handles multiple XML resources
+            val expectedResourceId =
+                when (fragment) {
+                    is ControlsSettingsFragment -> fragment.preferenceResource
+                    else -> resId
+                }
+
             assertThat(
-                "${targetContext.resources.getResourceName(resId)} should match the preferenceResource of ${fragment::class.simpleName}",
+                "${targetContext.resources.getResourceName(resId)} should be handled by ${fragment::class.simpleName}",
                 fragment.preferenceResource,
-                equalTo(resId),
+                equalTo(expectedResourceId),
             )
         }
     }