Add new setting for user data path

- The default userDataPath is set to QStandardPaths::GenericConfigLocation.
- Add a signal for application to indicate user data reset.

[ChangeLog] Added new property to settings
VirtualKeyboardSettings.userDataPath. This allows the application
or middleware to change the path to user files at runtime. Added
also a signal to indicate user data reset - when the application
triggers the signal, the virtual keyboard closes all files in the
user's directory.

Change-Id: I248a5b08c86b3fe7124a8d3f362c8f72e07b92c0
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>

1 files changed, 29 insertions, 0 deletions

diff --git a/src/virtualkeyboard/virtualkeyboardsettings.cpp b/src/virtualkeyboard/virtualkeyboardsettings.cpp
index ad940e90..47f6c1bd 100644
--- a/src/virtualkeyboard/virtualkeyboardsettings.cpp
+++ b/src/virtualkeyboard/virtualkeyboardsettings.cpp
@@ -167,6 +167,8 @@ VirtualKeyboardSettings::VirtualKeyboardSettings(QQmlEngine *engine) :
     connect(settings, SIGNAL(wclAlwaysVisibleChanged()), &d->wordCandidateListSettings, SIGNAL(alwaysVisibleChanged()));
     connect(settings, SIGNAL(wclAutoCommitWordChanged()), &d->wordCandidateListSettings, SIGNAL(autoCommitWordChanged()));
     connect(settings, SIGNAL(fullScreenModeChanged()), SIGNAL(fullScreenModeChanged()));
+    connect(settings, SIGNAL(userDataPathChanged()), SIGNAL(userDataPathChanged()));
+    settings->connect(this, SIGNAL(userDataReset()), SIGNAL(userDataReset()));
 }
 
 /*!
@@ -289,6 +291,16 @@ void VirtualKeyboardSettings::setFullScreenMode(bool fullScreenMode)
     return Settings::instance()->setFullScreenMode(fullScreenMode);
 }
 
+QString VirtualKeyboardSettings::userDataPath() const
+{
+    return Settings::instance()->userDataPath();
+}
+
+void VirtualKeyboardSettings::setUserDataPath(const QString &userDataPath)
+{
+    return Settings::instance()->setUserDataPath(userDataPath);
+}
+
 void VirtualKeyboardSettings::resetStyle()
 {
     Q_D(VirtualKeyboardSettings);
@@ -394,6 +406,23 @@ void VirtualKeyboardSettings::resetStyle()
 */
 
 /*!
+    \qmlproperty bool VirtualKeyboardSettings::userDataPath
+    \since QtQuick.VirtualKeyboard.Settings 6.1
+
+    This property sets the user data path for the virtual keyboard and its plugins.
+
+    By default, the user data path is set to \l {QStandardPaths::GenericConfigLocation}{GenericConfigLocation} + "/qtvirtualkeyboard".
+*/
+
+/*!
+    \qmlsignal VirtualKeyboardSettings::userDataReset()
+
+    The application triggers this signal prior to the user's data being reset to
+    indicate to the virtual keyboard that all files must be closed
+    in the user data directory.
+*/
+
+/*!
     \since QtQuick.VirtualKeyboard.Settings 2.2
     \qmlpropertygroup QtQuick.VirtualKeyboard::VirtualKeyboardSettings::wordCandidateList
     \qmlproperty int QtQuick.VirtualKeyboard::VirtualKeyboardSettings::wordCandidateList.autoHideDelay