j3soon / whisper-to-input

An Android keyboard that performs speech-to-text (STT/ASR) with OpenAI Whisper and input the recognized text; Supports English, Chinese, Japanese, etc. and even mixed languages.

35 stars 4 forks source link

Settings Refactor & Overhual #21

Closed tigerpaws01 closed 8 months ago

tigerpaws01 commented 9 months ago

What This Branch Achieved

Different settings page visuals, and a unified "Apply" button.

Details

settings.xml contains several <setting> tags, each representing a setting widget.

label: Text label displayed for that setting.
desc: Text description displayed for that setting.
type: Type of that setting. Currently, there are type="text" and type="dropdown".
dataStoreType: The data type this setting stores (Forced to be string for texts currently).
dataStoreKey: The data store key of this setting.
hint: The text hint to be displayed when text input field is empty (only for texts).

<item> tags are used inside type="dropdown" settings.

label: Text label to be displayed inside the dropdown menu.
value: The value to be stored when selecting this option.

Code Structures

SettingsPageBuilder builds a SettingsPage according to settings.xml
A SettingsPage is a container of several SettingItems.
SettingItem is an abstract class. It is responsible for notifying SettingsPage of modification, and for acutally performing data store read/writes.

Minor Fixes

As mentioned by @j3soon in previous PRs,

Renamed whisperJobManager.
Renamed keyboard state Waiting into Transcribing.

Testing This Branch

Functionality overall stays the same.
The setting page should work correctly.