PlatformSpellChecker/com.darkrockstudios.libs.platformspellchecker.windows/WindowsSpellChecker

WindowsSpellChecker

class WindowsSpellChecker : NativeSpellChecker, AutoCloseable(source)

High-level wrapper for the Windows Spell Checking API.

This class provides a Kotlin-friendly interface to the Windows native spell checker, which is available on Windows 8 and later.

Usage:

val spellChecker = WindowsSpellChecker.create("en-US")
if (spellChecker != null) {
    val errors = spellChecker.checkText("Helllo world")
    spellChecker.close()
}

Types

Companion

object Companion

Properties

languageTag

open override val languageTag: String

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

Functions

addToDictionary

open override fun addToDictionary(word: String)

Adds a word to the user dictionary.

checkText

open override fun checkText(text: String): List<SpellingError>

Checks the spelling of the provided text.

open override fun close()

getSuggestions

open override fun getSuggestions(word: String): List<String>

Gets spelling suggestions for a misspelled word.

ignoreWord

open override fun ignoreWord(word: String)

Ignores a word for this session.

isWordCorrect

open override fun isWordCorrect(word: String): Boolean

Checks if a single word is spelled correctly.

removeFromDictionary

open override fun removeFromDictionary(word: String)

No-op on Windows: the basic ISpellChecker VTable does not expose a remove operation. Removal would require ISpellChecker2 (Windows 8.1+), which is not currently bound. Logs a warning so callers know the request was dropped.