ui: introduce keyboard scroll flag in Virtual Console

Introduce in Virtual Console Settings a flag to enable/disable
standard keyboard management on scroll area.
The flag, when enabled (default), guarantees current behaviour:
arrow keys and PgUp/PgDown keys are used to scroll the console
and cannot be used as key combinations for controls.
When disabled, the scroll area does not consume key events
anymore, leaving all the keys available as key combinations
on the controls.

Author: Pac72

ui/src/CMakeLists.txt

@@ -127,6 +127,7 @@ add_library(${module_name}
     virtualconsole/vcmatrixproperties.cpp virtualconsole/vcmatrixproperties.h virtualconsole/vcmatrixproperties.ui
     virtualconsole/vcproperties.cpp virtualconsole/vcproperties.h virtualconsole/vcproperties.ui
     virtualconsole/vcpropertieseditor.cpp virtualconsole/vcpropertieseditor.h
+    virtualconsole/vcscrollarea.cpp virtualconsole/vcscrollarea.h
     virtualconsole/vcslider.cpp virtualconsole/vcslider.h
     virtualconsole/vcsliderproperties.cpp virtualconsole/vcsliderproperties.h virtualconsole/vcsliderproperties.ui
     virtualconsole/vcsoloframe.cpp virtualconsole/vcsoloframe.h

ui/src/src.pro

@@ -155,6 +155,7 @@ HEADERS += virtualconsole/addvcbuttonmatrix.h \
            virtualconsole/vcmatrixproperties.h \
            virtualconsole/vcproperties.h \
            virtualconsole/vcpropertieseditor.h \
+           virtualconsole/vcscrollarea.h \
            virtualconsole/vcslider.h \
            virtualconsole/vcsliderproperties.h \
            virtualconsole/vcsoloframe.h \
@@ -337,6 +338,7 @@ SOURCES += virtualconsole/addvcbuttonmatrix.cpp \
            virtualconsole/vcmatrixproperties.cpp \
            virtualconsole/vcproperties.cpp \
            virtualconsole/vcpropertieseditor.cpp \
+           virtualconsole/vcscrollarea.cpp \
            virtualconsole/vcslider.cpp \
            virtualconsole/vcsliderproperties.cpp \
            virtualconsole/vcsoloframe.cpp \

ui/src/virtualconsole/vcproperties.cpp

@@ -34,6 +34,7 @@
 VCProperties::VCProperties()
     : m_size(QSize(1920, 1080))
     , m_gmVisible(true)
+    , m_keyboardScroll(true)
     , m_gmChannelMode(GrandMaster::Intensity)
     , m_gmValueMode(GrandMaster::Reduce)
     , m_gmSliderMode(GrandMaster::Normal)
@@ -45,6 +46,7 @@ VCProperties::VCProperties()
 VCProperties::VCProperties(const VCProperties& properties)
     : m_size(properties.m_size)
     , m_gmVisible(properties.m_gmVisible)
+    , m_keyboardScroll(properties.m_keyboardScroll)
     , m_gmChannelMode(properties.m_gmChannelMode)
     , m_gmValueMode(properties.m_gmValueMode)
     , m_gmSliderMode(properties.m_gmSliderMode)
@@ -63,6 +65,7 @@ VCProperties &VCProperties::operator=(const VCProperties &props)
     {
         m_size = props.m_size;
         m_gmVisible = props.m_gmVisible;
+        m_keyboardScroll = props.m_keyboardScroll;
         m_gmChannelMode = props.m_gmChannelMode;
         m_gmValueMode = props.m_gmValueMode;
         m_gmSliderMode = props.m_gmSliderMode;
@@ -87,6 +90,20 @@ QSize VCProperties::size() const
     return m_size;
 }
 
+/*****************************************************************************
+ * Keyboard scrolling
+ *****************************************************************************/
+
+void VCProperties::setKeyboardScroll(const bool enable)
+{
+    m_keyboardScroll = enable;
+}
+
+bool VCProperties::keyboardScroll() const
+{
+    return m_keyboardScroll;
+}
+
 /*****************************************************************************
  * Grand Master
  *****************************************************************************/
@@ -179,6 +196,15 @@ bool VCProperties::loadXML(QXmlStreamReader &root)
             /* Set size if both are valid */
             if (sz.isValid() == true)
                 setSize(sz);
+\
+            bool keyboardScroll = true;
+
+            /* Keyboard scrolling */
+            str = root.attributes().value(KXMLQLCVCPropertiesKeyboardScroll).toString();
+            if (str.isEmpty() == false)
+                keyboardScroll = QVariant(str).toBool();
+            setKeyboardScroll(keyboardScroll);
+
             root.skipCurrentElement();
         }
         else if (root.name() == KXMLQLCVCPropertiesGrandMaster)
@@ -242,6 +268,7 @@ bool VCProperties::saveXML(QXmlStreamWriter *doc) const
     doc->writeStartElement(KXMLQLCVCPropertiesSize);
     doc->writeAttribute(KXMLQLCVCPropertiesSizeWidth, QString::number(size().width()));
     doc->writeAttribute(KXMLQLCVCPropertiesSizeHeight, QString::number(size().height()));
+    doc->writeAttribute(KXMLQLCVCPropertiesKeyboardScroll, QVariant(keyboardScroll()).toString());
     doc->writeEndElement();
 
     /***********************

ui/src/virtualconsole/vcproperties.h

@@ -35,12 +35,13 @@ class Doc;
  * @{
  */
 
-#define KXMLQLCVirtualConsole           QStringLiteral("VirtualConsole")
+#define KXMLQLCVirtualConsole             QStringLiteral("VirtualConsole")
 
-#define KXMLQLCVCProperties             QStringLiteral("Properties")
-#define KXMLQLCVCPropertiesSize         QStringLiteral("Size")
-#define KXMLQLCVCPropertiesSizeWidth    QStringLiteral("Width")
-#define KXMLQLCVCPropertiesSizeHeight   QStringLiteral("Height")
+#define KXMLQLCVCProperties               QStringLiteral("Properties")
+#define KXMLQLCVCPropertiesSize           QStringLiteral("Size")
+#define KXMLQLCVCPropertiesSizeWidth      QStringLiteral("Width")
+#define KXMLQLCVCPropertiesSizeHeight     QStringLiteral("Height")
+#define KXMLQLCVCPropertiesKeyboardScroll QStringLiteral("KeyboardScroll")
 
 #define KXMLQLCVCPropertiesGrandMaster              QStringLiteral("GrandMaster")
 #define KXMLQLCVCPropertiesGrandMasterVisible       QStringLiteral("Visible")
@@ -98,8 +99,19 @@ class VCProperties
     quint32 grandMasterInputUniverse() const;
     quint32 grandMasterInputChannel() const;
 
+    /*********************************************************************
+     * Keyboard scrolling
+     *********************************************************************/
+
+    /** Set Virtual Console keyboard scrolling */
+    void setKeyboardScroll(const bool enable);
+
+    /** Get Virtual Console keyboard scrolling */
+    bool keyboardScroll() const;
+
 private:
     bool m_gmVisible;
+    bool m_keyboardScroll;
     GrandMaster::ChannelMode m_gmChannelMode;
     GrandMaster::ValueMode m_gmValueMode;
     GrandMaster::SliderMode m_gmSliderMode;

ui/src/virtualconsole/vcproperties.ui

@@ -105,6 +105,35 @@
         </widget>
        </item>
        <item row="1" column="0">
+        <widget class="QGroupBox" name="m_scrollGroup">
+         <property name="title">
+          <string>Scrolling</string>
+         </property>
+         <layout class="QGridLayout" name="gridLayout_1">
+          <item row="0" column="0">
+           <widget class="QCheckBox" name="m_enableKeyboardScroll">
+            <property name="text">
+             <string>Use arrow and PgUp/PgDown keys to scroll</string>
+            </property>
+            <property name="checked">
+             <bool>true</bool>
+            </property>
+           </widget>
+          </item>
+          <item row="1" column="0">
+           <widget class="QLabel" name="m_keyboardScrollWarning">
+            <property name="text">
+             <string>Note: enabling keyboard scroll prevents using arrow and PgUp/PgDown keys in Key combinations for console controls.</string>
+            </property>
+            <property name="wordWrap">
+             <bool>true</bool>
+            </property>
+           </widget>
+          </item>
+         </layout>
+        </widget>
+       </item>
+       <item row="2" column="0">
         <spacer name="verticalSpacer_2">
          <property name="orientation">
           <enum>Qt::Orientation::Vertical</enum>
@@ -830,6 +859,7 @@
  <tabstops>
   <tabstop>m_sizeXSpin</tabstop>
   <tabstop>m_sizeYSpin</tabstop>
+  <tabstop>m_enableKeyboardScroll</tabstop>
   <tabstop>m_buttonWspin</tabstop>
   <tabstop>m_buttonHspin</tabstop>
   <tabstop>m_sliderWspin</tabstop>
@@ -1004,6 +1034,22 @@
     </hint>
    </hints>
   </connection>
+  <connection>
+   <sender>m_enableKeyboardScroll</sender>
+   <signal>toggled(bool)</signal>
+   <receiver>VCPropertiesEditor</receiver>
+   <slot>slotKeyboardScrollToggled(bool)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>190</x>
+     <y>198</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>190</x>
+     <y>245</y>
+    </hint>
+   </hints>
+  </connection>
   <connection>
    <sender>m_gmVisible</sender>
    <signal>toggled(bool)</signal>

ui/src/virtualconsole/vcpropertieseditor.cpp

@@ -56,6 +56,7 @@ VCPropertiesEditor::VCPropertiesEditor(QWidget* parent, const VCProperties& prop
     /* General page */
     m_sizeXSpin->setValue(properties.size().width());
     m_sizeYSpin->setValue(properties.size().height());
+    m_enableKeyboardScroll->setChecked(properties.keyboardScroll());
 
     /* Widgets page */
     QSettings settings;
@@ -321,6 +322,11 @@ void VCPropertiesEditor::slotSizeYChanged(int value)
     m_properties.setSize(sz);
 }
 
+void VCPropertiesEditor::slotKeyboardScrollToggled(bool checked)
+{
+    m_properties.setKeyboardScroll(checked);
+}
+
 void VCPropertiesEditor::slotSpeedDialConfirmed()
 {
     if (m_speedValueEdit->text().contains(".") == false)

ui/src/virtualconsole/vcpropertieseditor.h

@@ -84,6 +84,7 @@ class VCPropertiesEditor : public QDialog, public Ui_VCPropertiesEditor
 private slots:
     void slotSizeXChanged(int value);
     void slotSizeYChanged(int value);
+    void slotKeyboardScrollToggled(bool checked);
 
     /*************************************************************************
      * Widgets page

ui/src/virtualconsole/vcscrollarea.cpp

@@ -0,0 +1,18 @@
+#include "vcscrollarea.h"
+#include "qevent.h"
+
+VCScrollArea::VCScrollArea(QWidget *parent) : QScrollArea(parent) {
+    // nothing more right now
+}
+
+void VCScrollArea::keyPressEvent(QKeyEvent *ev) {
+    if (m_keyPassthru) {
+        ev->ignore();
+    } else {
+        QScrollArea::keyPressEvent(ev);
+    }
+}
+
+void VCScrollArea::setKeyPassthruEnabled(bool enable) {
+    m_keyPassthru = enable;
+}

ui/src/virtualconsole/vcscrollarea.h

@@ -0,0 +1,23 @@
+#ifndef VCSCROLLAREA_H
+#define VCSCROLLAREA_H
+
+#include <QObject>
+#include <QScrollArea>
+#include <QWidget>
+
+class VCScrollArea : public QScrollArea
+{
+    Q_OBJECT
+public:
+    explicit VCScrollArea(QWidget *parent = nullptr);
+
+    void setKeyPassthruEnabled(bool enabled);
+
+protected:
+    void keyPressEvent(QKeyEvent *) override;
+
+private:
+    bool m_keyPassthru;
+};
+
+#endif // VCSCROLLAREA_H

ui/src/virtualconsole/virtualconsole.cpp

@@ -135,6 +135,7 @@ VirtualConsole::VirtualConsole(QWidget* parent, Doc* doc)
     , m_contents(NULL)
 
     , m_liveEdit(false)
+    , m_keyboardScroll(true)
 {
     Q_ASSERT(s_instance == NULL);
     s_instance = this;
@@ -1014,6 +1015,7 @@ void VirtualConsole::slotToolsSettings()
             m_dockArea->setGrandMasterVisible(m_properties.grandMasterVisible());
             m_dockArea->setGrandMasterInvertedAppearance(m_properties.grandMasterSliderMode());
         }
+        m_keyboardScroll = m_properties.keyboardScroll();
 
         QSettings settings;
         settings.setValue(SETTINGS_BUTTON_SIZE, vcpe.buttonSize());
@@ -1605,7 +1607,7 @@ void VirtualConsole::initContents()
 {
     Q_ASSERT(layout() != NULL);
 
-    m_scrollArea = new QScrollArea(this);
+    m_scrollArea = new VCScrollArea(this);
     m_contentsLayout->addWidget(m_scrollArea);
     m_scrollArea->setAlignment(Qt::AlignCenter);
     m_scrollArea->setWidgetResizable(false);
@@ -1730,6 +1732,9 @@ void VirtualConsole::enableEdit()
     m_stackingRaiseAction->setShortcut(QKeySequence("SHIFT+UP"));
     m_stackingLowerAction->setShortcut(QKeySequence("SHIFT+DOWN"));
 
+    // disable key passthru
+    m_scrollArea->setKeyPassthruEnabled(false);
+
     // Show toolbar
     m_toolbar->show();
 }
@@ -1783,6 +1788,10 @@ void VirtualConsole::disableEdit()
     m_stackingRaiseAction->setShortcut(QKeySequence());
     m_stackingLowerAction->setShortcut(QKeySequence());
 
+
+    // manage key passthru
+    m_scrollArea->setKeyPassthruEnabled(!m_keyboardScroll);
+
     // Hide toolbar; there's nothing usable there in operate mode
     m_toolbar->hide();
 
@@ -1845,6 +1854,7 @@ bool VirtualConsole::loadXML(QXmlStreamReader &root)
             QSize size(m_properties.size());
             contents()->resize(size);
             contents()->setSizePolicy(QSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed));
+            m_keyboardScroll = m_properties.keyboardScroll();
         }
         else if (root.name() == KXMLQLCVCFrame)
         {