Merge lp:~michael-sheldon/ubuntu-keyboard/hide-setting into lp:ubuntu-keyboard

[Michael Sheldon]

Adds a setting to allow the keyboard to remain hidden at all times (e.g. when a hardware keyboard is connected)

Adds a setting to allow the keyboard to remain hidden at all times (e.g. when a hardware keyboard is connected)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:285
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/532/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/33
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/33
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/33/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/33

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-keyboard-ci/532/rebuild

review: Approve (continuous-integration)

[Michael Zanetti (mzanetti)]

Tested this and works fine.

review: Approve

[Michael Sheldon (michael-sheldon)]

Are there any related MPs required for this MP to build/function as expected? Please list.

 * No

Is your branch in sync with latest trunk (e.g. bzr pull lp:trunk -> no changes)

 * Yes

Did you perform an exploratory manual test run of your code change and any related functionality on device or emulator?

 * Yes

Did you successfully run all tests found in your component's Test Plan (https://wiki.ubuntu.com/Process/Merges/TestPlan/ubuntu-keyboard) on device or emulator?

 * Yes

If you changed the UI, was the change specified/approved by design?

 * No change

If you changed UI labels, did you update the pot file?

 * No change

If you changed the packaging (debian), did you add a core-dev as a reviewer to this MP?

 * No change

=== modified file 'data/schemas/com.canonical.keyboard.maliit.gschema.xml'
--- data/schemas/com.canonical.keyboard.maliit.gschema.xml	2014-09-02 19:29:43 +0000
+++ data/schemas/com.canonical.keyboard.maliit.gschema.xml	2015-01-14 12:09:44 +0000
@@ -56,5 +56,10 @@
       <description>Insert a full-stop when space is pressed twice.</description>
       <default>true</default>
     </key>
+    <key name="stay-hidden" type="b">
+      <summary>Stay hidden</summary>
+      <description>Never show the keyboard (e.g. because a hardware keyboard has been connected.)</description>
+      <default>false</default>
+    </key>
   </schema>
 </schemalist>

=== modified file 'src/plugin/inputmethod.cpp'
--- src/plugin/inputmethod.cpp	2014-12-05 00:49:11 +0000
+++ src/plugin/inputmethod.cpp	2015-01-14 12:09:44 +0000
@@ -116,6 +116,7 @@
     d->registerActiveLanguage();
     d->registerEnabledLanguages();
     d->registerDoubleSpaceFullStop();
+    d->registerStayHidden();
 
     //fire signal so all listeners know what active language is
     Q_EMIT activeLanguageChanged(d->activeLanguage);
@@ -135,9 +136,11 @@
 {
     Q_D(InputMethod);
 
-    d->m_geometry->setShown(true);
-    update();
-    d->view->setVisible(true);
+    if(!d->m_settings.stayHidden()) {
+        d->m_geometry->setShown(true);
+        update();
+        d->view->setVisible(true);
+    }
 }
 
 //! \brief InputMethod::hide

=== modified file 'src/plugin/inputmethod_p.h'
--- src/plugin/inputmethod_p.h	2014-12-05 00:49:11 +0000
+++ src/plugin/inputmethod_p.h	2015-01-14 12:09:44 +0000
@@ -255,6 +255,12 @@
         editor.setDoubleSpaceFullStopEnabled(m_settings.doubleSpaceFullStop());
     }
 
+    void registerStayHidden()
+    {
+        QObject::connect(&m_settings, SIGNAL(stayHiddenChanged(bool)),
+                         q, SLOT(hide()));
+    } 
+
     void closeOskWindow()
     {
         if (!view->isVisible())

=== modified file 'src/plugin/keyboardsettings.cpp'
--- src/plugin/keyboardsettings.cpp	2014-07-22 14:02:39 +0000
+++ src/plugin/keyboardsettings.cpp	2015-01-14 12:09:44 +0000
@@ -44,6 +44,7 @@
 const QLatin1String KEY_PRESS_AUDIO_FEEDBACK_SOUND_KEY = QLatin1String("keyPressFeedbackSound");
 const QLatin1String KEY_PRESS_HAPTIC_FEEDBACK_KEY = QLatin1String("keyPressHapticFeedback");
 const QLatin1String DOUBLE_SPACE_FULL_STOP = QLatin1String("doubleSpaceFullStop");
+const QLatin1String STAY_HIDDEN = QLatin1String("stayHidden");
 
 /*!
  * \brief KeyboardSettings::KeyboardSettings class to load the settings, and
@@ -163,6 +164,15 @@
 }
 
 /*!
+ * \brief KeyboardSettings:stayHidden returns true if the keyboard should
+ * always remain hidden (e.g. if a hardware keyboard has been connected).
+ */
+bool KeyboardSettings::stayHidden() const
+{
+    return m_settings->get(STAY_HIDDEN).toBool();
+}
+
+/*!
  * \brief KeyboardSettings::settingUpdated slot to handle changes in the settings backend
  * A specialized signal is emitted for the affected setting
  * \param key
@@ -199,6 +209,8 @@
     } else if (key == DOUBLE_SPACE_FULL_STOP) {
         Q_EMIT doubleSpaceFullStopChanged(doubleSpaceFullStop());
         return;
+    } else if (key == STAY_HIDDEN) {
+        Q_EMIT stayHiddenChanged(stayHidden());
     }
 
     qWarning() << Q_FUNC_INFO << "unknown settings key:" << key;

=== modified file 'src/plugin/keyboardsettings.h'
--- src/plugin/keyboardsettings.h	2014-07-22 14:02:39 +0000
+++ src/plugin/keyboardsettings.h	2015-01-14 12:09:44 +0000
@@ -54,6 +54,7 @@
     QString keyPressAudioFeedbackSound() const;
     bool keyPressHapticFeedback() const;
     bool doubleSpaceFullStop() const;
+    bool stayHidden() const;
 
 Q_SIGNALS:
     void activeLanguageChanged(QString);
@@ -66,6 +67,7 @@
     void keyPressAudioFeedbackSoundChanged(QString);
     void keyPressHapticFeedbackChanged(bool);
     void doubleSpaceFullStopChanged(bool);
+    void stayHiddenChanged(bool);
 
 private:
     Q_SLOT void settingUpdated(const QString &key);

=== modified file 'tests/unittests/ut_keyboardsettings/ut_keyboardsettings.cpp'
--- tests/unittests/ut_keyboardsettings/ut_keyboardsettings.cpp	2014-07-22 14:02:39 +0000
+++ tests/unittests/ut_keyboardsettings/ut_keyboardsettings.cpp	2015-01-14 12:09:44 +0000
@@ -67,25 +67,28 @@
         QTest::addColumn<int>("feedbackSpyCount");
         QTest::addColumn<int>("feedbackSoundSpyCount");
         QTest::addColumn<int>("doubleSpaceFullStopSpyCount");
+        QTest::addColumn<int>("stayHiddenSpyCount");
 
         QTest::newRow("languages changed") << QString("enabledLanguages")
-                                           << 1 << 0 << 0 << 0 << 0 << 0 << 0 << 0;
+                                           << 1 << 0 << 0 << 0 << 0 << 0 << 0 << 0 << 0;
         QTest::newRow("capitalization changed") << QString("autoCapitalization")
-                                                << 0 << 1 << 0 << 0 << 0 << 0 << 0 << 0;
+                                                << 0 << 1 << 0 << 0 << 0 << 0 << 0 << 0 << 0;
         QTest::newRow("completion changed") << QString("autoCompletion")
-                                            << 0 << 0 << 1 << 0 << 0 << 0 << 0 << 0;
+                                            << 0 << 0 << 1 << 0 << 0 << 0 << 0 << 0 << 0;
         QTest::newRow("predict changed") << QString("predictiveText")
-                                         << 0 << 0 << 0 << 1 << 0 << 0 << 0 << 0;
+                                         << 0 << 0 << 0 << 1 << 0 << 0 << 0 << 0 << 0;
         QTest::newRow("spellcheck changed") << QString("spellChecking")
-                                         << 0 << 0 << 0 << 0 << 1 << 0 << 0 << 0;
+                                         << 0 << 0 << 0 << 0 << 1 << 0 << 0 << 0 << 0;
         QTest::newRow("feedback changed") << QString("keyPressFeedback")
-                                          << 0 << 0 << 0 << 0 << 0 << 1 << 0 << 0;
+                                          << 0 << 0 << 0 << 0 << 0 << 1 << 0 << 0 << 0;
         QTest::newRow("feedback sound changed") << QString("keyPressFeedbackSound")
-                                          << 0 << 0 << 0 << 0 << 0 << 0 << 1 << 0;
+                                          << 0 << 0 << 0 << 0 << 0 << 0 << 1 << 0 << 0;
         QTest::newRow("doule space full-stop changed") << QString("doubleSpaceFullStop")
-                                          << 0 << 0 << 0 << 0 << 0 << 0 << 0 << 1;
+                                          << 0 << 0 << 0 << 0 << 0 << 0 << 0 << 1 << 0;
+        QTest::newRow("stay hidden changed") << QString("stayHidden")
+                                          << 0 << 0 << 0 << 0 << 0 << 0 << 0 << 0 << 1;
         QTest::newRow("unknown changed") << QString("unknownKey")
-                                         << 0 << 0 << 0 << 0 << 0 << 0 << 0 << 0;
+                                         << 0 << 0 << 0 << 0 << 0 << 0 << 0 << 0 << 0;
     }
 
     Q_SLOT void testSettingUpdated()
@@ -99,6 +102,7 @@
         QFETCH(int, feedbackSpyCount);
         QFETCH(int, feedbackSoundSpyCount);
         QFETCH(int, doubleSpaceFullStopSpyCount);
+        QFETCH(int, stayHiddenSpyCount);
 
         QSignalSpy languagesSpy(m_settings, SIGNAL(enabledLanguagesChanged(QStringList)));
         QSignalSpy capitalSpy(m_settings, SIGNAL(autoCapitalizationChanged(bool)));
@@ -108,6 +112,7 @@
         QSignalSpy feedbackSpy(m_settings, SIGNAL(keyPressAudioFeedbackChanged(bool)));
         QSignalSpy feedbackSoundSpy(m_settings, SIGNAL(keyPressAudioFeedbackSoundChanged(QString)));
         QSignalSpy doubleSpaceFullStopSpy(m_settings, SIGNAL(doubleSpaceFullStopChanged(bool)));
+        QSignalSpy stayHiddenSpy(m_settings, SIGNAL(stayHiddenChanged(bool)));
 
         m_settings->settingUpdated(key);
 
@@ -119,6 +124,7 @@
         QCOMPARE(feedbackSpy.count(), feedbackSpyCount);
         QCOMPARE(feedbackSoundSpy.count(), feedbackSoundSpyCount);
         QCOMPARE(doubleSpaceFullStopSpy.count(), doubleSpaceFullStopSpyCount);
+        QCOMPARE(stayHiddenSpy.count(), stayHiddenSpyCount);
     }
 };