Provides API to overwrite the default WebKit spellchecker implementation and contains API to manipulate spellchecker settings. More...

#include <Evas.h>

Typedefs
typedef void(*	Ewk_Text_Checker_Continuous_Spell_Checking_Change_Cb) (Eina_Bool enable)

typedef uint64_t(*	Ewk_Text_Checker_Unique_Spell_Document_Tag_Get_Cb) (const Evas_Object *o)

typedef void(*	Ewk_Text_Checker_Unique_Spell_Document_Tag_Close_Cb) (uint64_t tag)

typedef void(*	Ewk_Text_Checker_String_Spelling_Check_Cb) (uint64_t tag, const char text, int32_t misspelling_location, int32_t *misspelling_length)

typedef Eina_List (	Ewk_Text_Checker_Word_Guesses_Get_Cb) (uint64_t tag, const char *word)

typedef void(*	Ewk_Text_Checker_Word_Learn_Cb) (uint64_t tag, const char *word)

typedef void(*	Ewk_Text_Checker_Word_Ignore_Cb) (uint64_t tag, const char *word)

Functions
EAPI Eina_Bool	ewk_text_checker_continuous_spell_checking_enabled_get (void)

EAPI void	ewk_text_checker_continuous_spell_checking_enabled_set (Eina_Bool enable)

EAPI Eina_List *	ewk_text_checker_spell_checking_available_languages_get (void)

EAPI void	ewk_text_checker_spell_checking_languages_set (const char *languages)

EAPI Eina_List *	ewk_text_checker_spell_checking_languages_get (void)

EAPI void	ewk_text_checker_continuous_spell_checking_change_cb_set (Ewk_Text_Checker_Continuous_Spell_Checking_Change_Cb cb)

EAPI void	ewk_text_checker_unique_spell_document_tag_get_cb_set (Ewk_Text_Checker_Unique_Spell_Document_Tag_Get_Cb cb)

EAPI void	ewk_text_checker_unique_spell_document_tag_close_cb_set (Ewk_Text_Checker_Unique_Spell_Document_Tag_Close_Cb cb)

EAPI void	ewk_text_checker_string_spelling_check_cb_set (Ewk_Text_Checker_String_Spelling_Check_Cb cb)

EAPI void	ewk_text_checker_word_guesses_get_cb_set (Ewk_Text_Checker_Word_Guesses_Get_Cb cb)

EAPI void	ewk_text_checker_word_learn_cb_set (Ewk_Text_Checker_Word_Learn_Cb cb)

EAPI void	ewk_text_checker_word_ignore_cb_set (Ewk_Text_Checker_Word_Ignore_Cb cb)

Detailed Description

Provides API to overwrite the default WebKit spellchecker implementation and contains API to manipulate spellchecker settings.

There is one spellchecker object per application. It allows to check spelling in the editable areas, get suggestions for the misspelled word, learn and ignore spelling.

If application wants to check spelling while typing, ewk_text_checker_continuous_spell_checking_enabled_set API should be used.

The default WebKit spellchecker implementation is based on the Enchant library. It doesn't ensure grammar checking. Application is able to overwrite the default WebKit spellchecker implementation by defining its own implementation and setting appropriate callback functions.

Typedef Documentation

typedef void(* Ewk_Text_Checker_Continuous_Spell_Checking_Change_Cb) (Eina_Bool enable)

Creates a type name for the callback function used to notify the client when the continuous spell checking setting was changed by WebKit.

Parameters

enable EINA_TRUE if continuous spell checking is enabled or EINA_FALSE if it's disabled

typedef void(* Ewk_Text_Checker_String_Spelling_Check_Cb) (uint64_t tag, const char *text, int32_t *misspelling_location, int32_t *misspelling_length)

Defines a type name for the callback function to search for a misspelled words in the given string.

Parameters

tag	unique tag to notify the spell checker which document that text is associated, in most cases not necessarily, just for ignored word, `0` can be passed in for text not associated with a particular document
text	the text containing the words to spellcheck
misspelling_location	a pointer to store the beginning of the misspelled text, `-1` if the text is correct
misspelling_length	a pointer to store the length of misspelled text, `0` if the text is correct

typedef void(* Ewk_Text_Checker_Unique_Spell_Document_Tag_Close_Cb) (uint64_t tag)

Defines a type name for the callback function to close the prviously set tag.

This callback will notify the receiver that the user has finished with the tagged document.

Parameters

tag	the tag to be closed

typedef uint64_t(* Ewk_Text_Checker_Unique_Spell_Document_Tag_Get_Cb) (const Evas_Object *o)

Defines a type name for the callback function to return a tag (identifier) which is guaranteed to be unique.

Unique tags help to avoid collisions with other objects that are checked for spelling mistakes.

Parameters

o	the view object to get unique tag

Returns: unique tag for the given o view object

typedef Eina_List*(* Ewk_Text_Checker_Word_Guesses_Get_Cb) (uint64_t tag, const char *word)

Defines a type name for the callback function to get a list of suggested spellings for a misspelled word.

Parameters

tag	unique tag to notify the spell checker which document that text is associated, `0` can be passed for text not associated with a particular document
word	the word to get guesses

Returns: a list of dynamically allocated strings (as char*), the list and its items will be freed by WebKit.

typedef void(* Ewk_Text_Checker_Word_Ignore_Cb) (uint64_t tag, const char *word)

Sets a callback function to tell the spell checker to ignore a given word.

Parameters

tag	unique tag to notify the spell checker which document that text is associated, `0` can be passed for text not associated with a particular document
word	the word to ignore

typedef void(* Ewk_Text_Checker_Word_Learn_Cb) (uint64_t tag, const char *word)

Sets a callback function to add the word to the spell checker dictionary.

Parameters

tag	unique tag to notify the spell checker which document that text is associated, `0` can be passed for text not associated with a particular document
word	the word to add

Function Documentation

EAPI void ewk_text_checker_continuous_spell_checking_change_cb_set ( Ewk_Text_Checker_Continuous_Spell_Checking_Change_Cb cb )

Sets a callback function used to notify the client when the continuous spell checking setting was changed by WebKit.

Specifying of this callback is needed if the application wants to receive notifications once WebKit changes this setting. If the application is not interested, this callback is not set. Changing of this setting at the WebKit level can be made as a result of modifying options in a Context Menu by a user.

Parameters

cb	a new callback function to set or `NULL` to invalidate the previous one

EAPI Eina_Bool ewk_text_checker_continuous_spell_checking_enabled_get ( void )

Queries if continuous spell checking is enabled.

Returns: EINA_TRUE if continuous spell checking is enabled or EINA_FALSE if it's disabled

EAPI void ewk_text_checker_continuous_spell_checking_enabled_set ( Eina_Bool enable )

Enables/disables continuous spell checking.

This feature is disabled by default.

See also: ewk_text_checker_continuous_spell_checking_change_cb_set

Parameters

enable EINA_TRUE to enable continuous spell checking or EINA_FALSE to disable

EAPI Eina_List* ewk_text_checker_spell_checking_available_languages_get ( void )

Gets the the list of all available the spell checking languages to use.

See also: ewk_settings_spell_checking_languages_set

Returns: the list with available spell checking languages, or NULL on failure the Eina_List and its items should be freed after, use eina_stringshare_del()

EAPI Eina_List* ewk_text_checker_spell_checking_languages_get ( void )

Gets the the list of the spell checking languages in use.

See also: ewk_settings_spell_checking_available_languages_get; ewk_settings_spell_checking_languages_set

Returns: the list with the spell checking languages in use, the Eina_List and its items should be freed after, use eina_stringshare_del()

EAPI void ewk_text_checker_spell_checking_languages_set ( const char * languages )

Sets languages as the list of languages to use by default WebKit implementation of spellchecker feature with Enchant library support.

If languages is NULL, the default language is used. If the default language can not be determined then any available dictionary will be used.

Note: This function invalidates the previously set languages. The dictionaries are requested asynchronously.

Parameters

languages a list of comma (',') separated language codes of the form 'en_US', ie, language_VARIANT, may be NULL.

EAPI void ewk_text_checker_string_spelling_check_cb_set ( Ewk_Text_Checker_String_Spelling_Check_Cb cb )

Sets a callback function to search for a misspelled words in the given string.

Parameters

cb	a new callback to set or `NULL` to restore the default WebKit callback implementation

EAPI void ewk_text_checker_unique_spell_document_tag_close_cb_set ( Ewk_Text_Checker_Unique_Spell_Document_Tag_Close_Cb cb )

Sets a callback function to close a unique spell document tag.

Parameters

cb	a new callback to set or `NULL` to restore the default WebKit callback implementation

EAPI void ewk_text_checker_unique_spell_document_tag_get_cb_set ( Ewk_Text_Checker_Unique_Spell_Document_Tag_Get_Cb cb )

Sets a callback function to get a unique spell document tag.

Parameters

cb	a new callback to set or `NULL` to restore the default WebKit callback implementation

EAPI void ewk_text_checker_word_guesses_get_cb_set ( Ewk_Text_Checker_Word_Guesses_Get_Cb cb )

Sets a callback function to get an array of suggested spellings for a misspelled word.

Parameters

cb	a new callback to set or `NULL` to restore the default WebKit callback implementation

EAPI void ewk_text_checker_word_ignore_cb_set ( Ewk_Text_Checker_Word_Ignore_Cb cb )

Sets a callback function to tell the spell checker to ignore a given word.

Parameters

cb	a new callback to set or `NULL` to restore the default WebKit callback implementation

EAPI void ewk_text_checker_word_learn_cb_set ( Ewk_Text_Checker_Word_Learn_Cb cb )

Sets a callback function to add the word to the spell checker dictionary.

Parameters

cb	a new callback to set or `NULL` to restore the default WebKit callback implementation

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation