PlatformSpellChecker/com.darkrockstudios.libs.platformspellchecker

Package-level declarations

The public API: PlatformSpellCheckerFactory, PlatformSpellChecker, the WordCheckResult hierarchy (CorrectWord / MisspelledWord), SpellingCorrection, SpLocale, and DictionaryScope.

Types

CorrectWord

data class CorrectWord(val word: String) : WordCheckResult

Result for a correctly spelled word.

DictionaryScope

enum DictionaryScope : Enum<DictionaryScope>

Scope of a custom-dictionary mutation.

MisspelledWord

data class MisspelledWord(val word: String, val suggestions: List<String>) : WordCheckResult

Result for a misspelled word, with up to maxSuggestions suggestions (closest first). suggestions may be empty when the platform offers no alternatives.

PlatformSpellChecker

actual class PlatformSpellChecker : AutoCloseable

Platform-specific spell checker that provides spell checking functionality.

expect class PlatformSpellChecker

Platform-specific spell checker that provides spell checking functionality.

actual class PlatformSpellChecker : AutoCloseable

Desktop JVM implementation of PlatformSpellChecker.

actual class PlatformSpellChecker : AutoCloseable

iOS implementation of PlatformSpellChecker using UITextChecker.

PlatformSpellCheckerFactory

actual class PlatformSpellCheckerFactory

PlatformSpellCheckerFactory creates platform spell checkers and provides a capability check.

expect class PlatformSpellCheckerFactory

PlatformSpellCheckerFactory creates platform spell checkers and provides a capability check.

actual class PlatformSpellCheckerFactory

PlatformSpellCheckerFactory creates platform spell checkers and provides a capability check.

actual class PlatformSpellCheckerFactory

PlatformSpellCheckerFactory creates platform spell checkers and provides a capability check.

SpellingCorrection

data class SpellingCorrection(val misspelledWord: String, val startIndex: Int, val length: Int, val suggestions: List<String>)

Represents a spelling correction for a misspelled word in a text.

SpLocale

data class SpLocale(val language: String, val country: String? = null)

Locale identifier for spell checking dictionaries.

WordCheckResult

sealed interface WordCheckResult

The outcome of checking a single word with PlatformSpellChecker.checkWord.

Functions

isMisspelled

fun isMisspelled(result: WordCheckResult): Boolean

Returns true if result is a MisspelledWord. On the true branch result smart-casts to MisspelledWord, so its suggestions are accessible without a further is check.

toJavaLocale

fun SpLocale.toJavaLocale(): Locale

JVM-only convenience conversions between SpLocale and java.util.Locale (Android/JVM).

fun SpLocale.toJavaLocale(): Locale

JVM-only convenience conversions between SpLocale and java.util.Locale (Desktop/JVM).

toNSLocale

fun SpLocale.toNSLocale(): NSLocale

iOS-only convenience conversions between SpLocale and NSLocale (Apple platforms).

toSpLocale

fun Locale.toSpLocale(): SpLocale

fun NSLocale.toSpLocale(): SpLocale