Changes between Version 3 and Version 4 of WK2-EFLTextCheckerApiTutorial

Timestamp:

May 10, 2013, 2:29:25 AM (12 years ago)

Author:

a.badowski@samsung.com

Comment:

--

WK2-EFLTextCheckerApiTutorial

@@ -17 +17 @@
 == Enabling text checker feature ==
 
-If an application wants to use this feature, the following API from ewk_settings.h should be used:
+If an application wants to use this feature, the following API from ewk_text_checker.h should be used:
 {{{
-void ewk_settings_continuous_spell_checking_enabled_set(Eina_Bool enable);
+void ewk_text_checker_continuous_spell_checking_enabled_set(Eina_Bool enable);
 }}}
 Here is an example how an application can enable this feature:
 {{{
-ewk_settings_continuous_spell_checking_enabled_set(EINA_TRUE);
+ewk_text_checker_continuous_spell_checking_enabled_set(EINA_TRUE);
 }}}
 As a result, the text checker feature is enabled and the spell checking related functionalities are available for the user.
@@ -29 +29 @@
 
 
-The user is able to query whether spellchecker continuous spell checking is enabled, the following API from ewk_settings.h should be used:
+The user is able to query whether spellchecker continuous spell checking is enabled, the following API from ewk_text_checker.h should be used:
 {{{
-Eina_Bool ewk_settings_continuous_spell_checking_enabled_get(void);
+Eina_Bool ewk_text_checker_continuous_spell_checking_enabled_get(void);
 }}}
 Here is an example of its usage:
 {{{
-Eina_Bool enabled = ewk_settings_continuous_spell_checking_enabled_get();
+Eina_Bool enabled = ewk_text_checker_continuous_spell_checking_enabled_get();
 }}}
     
 == Languages support ==
-By default, WebKit2-EFL performs spell checking based on the default OS language. An arbitrary language can be set by using the following API from the ewk_settings.h:
+By default, WebKit2-EFL performs spell checking based on the default OS language. An arbitrary language can be set by using the following API from the ewk_text_checker.h:
 {{{
-void ewk_settings_spell_checking_languages_set(const char *languages);
+void ewk_text_checker_spell_checking_languages_set(const char *languages);
 }}}
 
@@ -47 +47 @@
 {{{
 const char lang[] = "en_US";
-ewk_settings_spell_checking_languages_set(lang);
+ewk_text_checker_spell_checking_languages_set(lang);
 }}}
 
@@ -53 +53 @@
 {{{
 const char langs[] = "en_US,ko,pl";
-ewk_settings_spell_checking_languages_set(langs);
+ewk_text_checker_spell_checking_languages_set(langs);
 }}}
 The presented example sets three languages (English, Korean and Polish) to be used in spell checking. The number of the languages is not limited. However, be aware that loading multiple dictionaries may slow down your application.[[BR]]
 
-There is a possibility to retrieve a list of dictionaries that are supported/installed by OS. The following API from ewk_settings.h should be used:
+There is a possibility to retrieve a list of dictionaries that are supported/installed by OS. The following API from ewk_text_checker.h should be used:
 {{{
 Eina_List *ewk_settings_spell_checking_available_languages_get(void);
@@ -64 +64 @@
 Here is an example of its usage. It gets the available languages and displays them on the standard output:
 {{{
-Eina_List *available_langs = ewk_settings_spell_checking_available_languages_get();
+Eina_List *available_langs = ewk_text_checker_spell_checking_available_languages_get();
 if (!available_langs)
     return;
@@ -82 +82 @@
 The client can get a list of dictionaries that have been already loaded and are in use to perform spellchecking. Here is an example:
 {{{
-Eina_List *loaded_langs = ewk_settings_spell_checking_languages_get();
+Eina_List *loaded_langs = ewk_text_checker_spell_checking_languages_get();
 if (!loaded_langs)
    return;
@@ -101 +101 @@
 There is a callback function used to notify the user 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. The following API from ewk_settings.h can be used:
 {{{
-void ewk_settings_continuous_spell_checking_change_cb_set(Ewk_Settings_Continuous_Spell_Checking_Change_Cb cb);
-typedef void (*Ewk_Settings_Continuous_Spell_Checking_Change_Cb)(Eina_Bool enable);
+void ewk_text_checker_continuous_spell_checking_change_cb_set(Ewk_Settings_Continuous_Spell_Checking_Change_Cb cb);
+typedef void (*Ewk_Text_Checker_Continuous_Spell_Checking_Change_Cb)(Eina_Bool enable);
 }}}
 
@@ -115 +115 @@
     ...
     // Callback registration.
-    ewk_settings_continuous_spell_checking_change_cb_set(setting_change);
+    ewk_text_checker_continuous_spell_checking_change_cb_set(setting_change);
 }
 }}}