diff options
author | Michal Klocek <michal.klocek@theqtcompany.com> | 2016-04-28 20:58:16 +0200 |
---|---|---|
committer | Michal Klocek <michal.klocek@theqtcompany.com> | 2016-05-04 17:57:11 +0000 |
commit | 64c4db034de560aa0e1e4658140700fb5e56d85d (patch) | |
tree | c159a81f504cc38a66052138910244a93ca6863f /src | |
parent | 903a07a5c5cf4d22609b4b01295e8563680d9d97 (diff) |
Doc: Document how dictionaries are loaded
Change-Id: I366e35b6de0a46be648de3130eb7d8585fc1a694
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Diffstat (limited to 'src')
-rw-r--r-- | src/webengine/api/qquickwebengineprofile.cpp | 15 | ||||
-rw-r--r-- | src/webenginewidgets/api/qwebengineprofile.cpp | 16 |
2 files changed, 31 insertions, 0 deletions
diff --git a/src/webengine/api/qquickwebengineprofile.cpp b/src/webengine/api/qquickwebengineprofile.cpp index cf9d7ab2f..6901b3e0e 100644 --- a/src/webengine/api/qquickwebengineprofile.cpp +++ b/src/webengine/api/qquickwebengineprofile.cpp @@ -623,6 +623,21 @@ QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile() \qmlproperty QString WebEngineProfile::spellCheckLanguage This property holds the language used by the spell checker. + The language should match the name of the \c .bdic dictionary. + For example, the \a language \c en-US will load the \c en-US.bdic + dictionary file. + + The web engine checks for the \c qtwebengine_dictionaries subdirectory + first in the local directory and if it is not found in the Qt + installation directory: + + \list + \li QCoreApplication::applicationDirPath()/qtwebengine_dictionaries + \li [QLibraryInfo::DataPath]/qtwebengine_dictionaries + \endlist + + For more information about how to compile \c .bdic dictionaries, see the + \l{WebEngine Widgets Spellchecker Example}{Spellchecker Example}. \since QtWebEngine 1.3 */ diff --git a/src/webenginewidgets/api/qwebengineprofile.cpp b/src/webenginewidgets/api/qwebengineprofile.cpp index 1f5912667..361a60944 100644 --- a/src/webenginewidgets/api/qwebengineprofile.cpp +++ b/src/webenginewidgets/api/qwebengineprofile.cpp @@ -559,6 +559,22 @@ QWebEngineProfile *QWebEngineProfile::defaultProfile() \since 5.7 Sets the current \a language for the spell checker. + The language should match the name of the \c .bdic dictionary. + For example, the \a language \c en-US will load the \c en-US.bdic + dictionary file. + + The web engine checks for the \c qtwebengine_dictionaries subdirectory + first in the local directory and if it is not found in the Qt + installation directory: + + \list + \li QCoreApplication::applicationDirPath()/qtwebengine_dictionaries + \li [QLibraryInfo::DataPath]/qtwebengine_dictionaries + \endlist + + For more information about how to compile \c .bdic dictionaries, see the + \l{WebEngine Widgets Spellchecker Example}{Spellchecker Example}. + */ void QWebEngineProfile::setSpellCheckLanguage(const QString &language) { |