diff options
| -rw-r--r-- | src/virtualkeyboard/qvirtualkeyboarddictionary.cpp | 36 | ||||
| -rw-r--r-- | src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp | 78 |
2 files changed, 114 insertions, 0 deletions
diff --git a/src/virtualkeyboard/qvirtualkeyboarddictionary.cpp b/src/virtualkeyboard/qvirtualkeyboarddictionary.cpp index d8983b05..e0df0a63 100644 --- a/src/virtualkeyboard/qvirtualkeyboarddictionary.cpp +++ b/src/virtualkeyboard/qvirtualkeyboarddictionary.cpp @@ -29,6 +29,18 @@ #include <QtVirtualKeyboard/qvirtualkeyboarddictionary.h> +/*! + \class QVirtualKeyboardDictionary + + \inmodule QtVirtualKeyboard + + \brief An application-defined dictionary for virtual keyboard input methods. + + This class defines a named dictionary that consists of words or phrases. The + dictionary can be enabled in the desired context and its usage depends on + the current input method of the virtual keyboard. +*/ + QVirtualKeyboardDictionary::QVirtualKeyboardDictionary(const QString &name, QObject *parent) : QObject(parent), _name(name) @@ -54,6 +66,30 @@ void QVirtualKeyboardDictionary::setContents(const QStringList &wordList) } } +/*! + \property QVirtualKeyboardDictionary::name + \brief name of the dictionary. + + This property holds the name of the dictionary that was specified when + the dictionary was created. The name is necessary when referring to a + specific dictionary (for example when you activate it in the input context). + + \note The dictionary name cannot be changed later. +*/ + +/*! + \property QVirtualKeyboardDictionary::contents + \brief contents of the dictionary. + + This property holds the contents of the dictionary. Typically, the content + consists of words or phrases. Note that the dictionary is language neutral, + meaning it is the application's responsibility to localize the dictionary if + it contains language-dependent data. + + The content can be set at any time, although it makes sense to set it when + the input method is not active. +*/ + QT_BEGIN_NAMESPACE QT_END_NAMESPACE diff --git a/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp b/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp index 730b4772..59904d57 100644 --- a/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp +++ b/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp @@ -68,6 +68,34 @@ struct QVirtualKeyboardDictionaryManagerSingleton { Q_GLOBAL_STATIC(QVirtualKeyboardDictionaryManagerSingleton, singleton) +/*! + \class QVirtualKeyboardDictionaryManager + + \inmodule QtVirtualKeyboard + + \brief Dictionary management for application-defined dictionaries. + + This class allows you to manage dictionaries for virtual keyboard input + methods. Dictionaries are application-defined and can be activated in the + desired context. + + \note Dictionaries do not refer to the built-in dictionaries of the input + method, but to the application's own dictionaries (for example, a phonebook + application). + + The following operations are supported by the dictionary manager: + \list + \li Create dictionaries using the \c createDictionary() function. + \li Add or modify content of the dictionary instance. + \li Activate dictionaries by adding them to the list of + \l {baseDictionaries}{base dictionaries} or + \l {extraDictionaries}{extra dictionaries}. + \endlist + + To activate dictionaries from QML, use the \l VirtualKeyboard attached + type. +*/ + QVirtualKeyboardDictionaryManager::QVirtualKeyboardDictionaryManager(QObject *parent) : QObject(*new QVirtualKeyboardDictionaryManagerPrivate(this), parent) { @@ -78,6 +106,12 @@ QVirtualKeyboardDictionaryManager::QVirtualKeyboardDictionaryManager(QObject *pa [=](){ d->updateActiveDictionaries(); }); } +/*! + Returns the singleton instance of the QVirtualKeyboardDictionaryManager. + + All the functionalities must be called from the main thread. + */ + QVirtualKeyboardDictionaryManager *QVirtualKeyboardDictionaryManager::instance() { return &singleton->instance; @@ -131,6 +165,15 @@ QStringList QVirtualKeyboardDictionaryManager::activeDictionaries() const return d->activeDictionaries.values(); } +/*! + Create a dictionary with the given \a name or return the dictionary if it + already exists. + + The dictionary instance is owned by the dictionary manager and must not be + destroyed manually. To free memory allocated for the dictionary, the + application may reset the contents of the dictionary. + */ + QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::createDictionary(const QString &name) { Q_D(QVirtualKeyboardDictionaryManager); @@ -145,6 +188,10 @@ QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::createDictionary( return dictionary; } +/*! + Returns an existing dictionary if it exists. + */ + QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::dictionary(const QString &name) const { Q_D(const QVirtualKeyboardDictionaryManager); @@ -152,4 +199,35 @@ QVirtualKeyboardDictionary *QVirtualKeyboardDictionaryManager::dictionary(const return d->dictionaries.value(name); } +/*! + \property QVirtualKeyboardDictionary::availableDictionaries + \brief the list of all dictionaries. + + This property holds the names of all existing dictionaries. +*/ + +/*! + \property QVirtualKeyboardDictionary::baseDictionaries + \brief the list of currently active base dictionaries. + + This property holds the names of base dictionaries. The application manages + this property. +*/ + +/*! + \property QVirtualKeyboardDictionary::extraDictionaries + \brief the list of currently active extra dictionaries. + + This property holds the names of extra dictionaries. The application manages + this property. +*/ + +/*! + \property QVirtualKeyboardDictionary::activeDictionaries + \brief the list of currently active dictionaries. + + This property holds the list of active dictionaries, which is a combination + of unique names included in baseDictionaries and extraDictionaries. +*/ + QT_END_NAMESPACE |