e_spell_dictionary_new ()

ESpellDictionary *
e_spell_dictionary_new (struct _ESpellChecker *spell_checker,
                        EnchantDict *enchant_dict);

e_spell_dictionary_new_bare ()

ESpellDictionary *
e_spell_dictionary_new_bare (struct _ESpellChecker *spell_checker,
                             const gchar *language_tag);

e_spell_dictionary_hash ()

guint
e_spell_dictionary_hash (ESpellDictionary *dictionary);

Generates a hash value for dictionary based on its ISO code. This function is intended for easily hashing an ESpellDictionary to add to a GHashTable or similar data structure.

e_spell_dictionary_equal ()

gboolean
e_spell_dictionary_equal (ESpellDictionary *dictionary1,
                          ESpellDictionary *dictionary2);

Checks two ESpellDictionary instances for equality based on their ISO codes.

e_spell_dictionary_compare ()

gint
e_spell_dictionary_compare (ESpellDictionary *dictionary1,
                            ESpellDictionary *dictionary2);

Compares dictionary1 and dictionary2 by their display names for the purpose of lexicographical sorting. Use this function where a GCompareFunc callback is required, such as g_list_sort().

e_spell_dictionary_get_name ()

const gchar *
e_spell_dictionary_get_name (ESpellDictionary *dictionary);

Returns the display name of the dictionary (for example "English (British)")

e_spell_dictionary_get_code ()

const gchar *
e_spell_dictionary_get_code (ESpellDictionary *dictionary);

Returns the ISO code of the spell-checking language for dictionary (for example "en_US").

e_spell_dictionary_ref_spell_checker ()

struct _ESpellChecker *
e_spell_dictionary_ref_spell_checker (ESpellDictionary *dictionary);

Returns a new reference to the ESpellChecker which owns the dictionary. Unreference the ESpellChecker with g_object_unref() when finished with it.

e_spell_dictionary_check_word ()

gboolean
e_spell_dictionary_check_word (ESpellDictionary *dictionary,
                               const gchar *word,
                               gsize length);

Tries to lookup the word in the dictionary to check whether it's spelled correctly or not.

e_spell_dictionary_learn_word ()

void
e_spell_dictionary_learn_word (ESpellDictionary *dictionary,
                               const gchar *word,
                               gsize length);

Permanently adds word to dictionary so that next time calling e_spell_dictionary_check() on the word will return TRUE.

e_spell_dictionary_ignore_word ()

void
e_spell_dictionary_ignore_word (ESpellDictionary *dictionary,
                                const gchar *word,
                                gsize length);

Adds word to temporary ignore list of the dictionary , so that e_spell_dictionary_check() on the word will return TRUE. The list is cleared when the dictionary is freed.

e_spell_dictionary_get_suggestions ()

GList *
e_spell_dictionary_get_suggestions (ESpellDictionary *dictionary,
                                    const gchar *word,
                                    gsize length);

Provides list of alternative spellings of word .

Free the returned spelling suggestions with g_free(), and the list itself with g_list_free(). An easy way to free the list properly in one step is as follows:

1

g_list_free_full (list, (GDestroyNotify) g_free);

e_spell_dictionary_store_correction ()

void
e_spell_dictionary_store_correction (ESpellDictionary *dictionary,
                                     const gchar *misspelled,
                                     gsize misspelled_length,
                                     const gchar *correction,
                                     gsize correction_length);

The “spell-checker” property

  “spell-checker”            ESpellChecker *

Parent spell checker.

Flags: Read / Write / Construct Only