PlatformSpellChecker/com.darkrockstudios.libs.platformspellchecker.native/NativeSpellChecker

NativeSpellChecker

interface NativeSpellChecker : AutoCloseable(source)

Common interface for native spell checkers across different operating systems.

Implementations:

Windows: Uses the Windows Spell Checking API (Windows 8+)
macOS: Will use NSSpellChecker (to be implemented)
Linux: Will use Hunspell or similar (to be implemented)

Inheritors

LinuxSpellChecker

MacOSSpellChecker

WindowsSpellChecker

Properties

abstract val languageTag: String

The language tag this spell checker was created for (e.g., "en-US").

Functions

addToDictionary

abstract fun addToDictionary(word: String)

Adds a word to the user dictionary.

abstract fun checkText(text: String): List<SpellingError>

Checks the spelling of the provided text.

abstract fun close()

abstract fun getSuggestions(word: String): List<String>

Gets spelling suggestions for a misspelled word.

abstract fun ignoreWord(word: String)

Ignores a word for this session.

abstract fun isWordCorrect(word: String): Boolean

Checks if a single word is spelled correctly.

removeFromDictionary

abstract fun removeFromDictionary(word: String)

Removes a word previously added via addToDictionary. Best-effort: platforms whose native API does not expose a remove operation should log a warning and no-op.