Changeset 79016 in vbox

Timestamp:

Jun 6, 2019 8:13:23 AM (5 years ago)

Author:

vboxsync

Message:

FE/Qt: bugref:6143. Loading keycaps from a file.

Location:

trunk/src/VBox/Frontends/VirtualBox

Files:

• src/softkeyboard/UISoftKeyboard.cpp (modified) (15 diffs)
• xml/101_ansi.xml (modified) (3 diffs)
• xml/102_iso.xml (modified) (3 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/softkeyboard/UISoftKeyboard.cpp

@@ -107 +107 @@
     void setKeyGeometry(const QRect &rect);
 
+    const QString &staticKeyCap() const;
+    void setStaticKeyCap(const QString &strKeyCap);
+
     const QString &keyCap() const;
     void setKeyCap(const QString &strKeyCap);
@@ -154 +157 @@
 
     QRect      m_keyGeometry;
+    /** Static keycaps are what is obtained from the layout file, as opposed to the keycaps file.
+      * normally they are the captions of modifier keys (Shift, etc) whose meaning stays the same across the layouts. */
+    QString    m_strStaticKeyCap;
+    /** Key caps are loaded from a keycap file and preferred over the static keycaps if they are not empty. */
     QString    m_strKeyCap;
+
     /** Stores the key polygon in local coordinates. */
     QPolygon   m_polygon;
@@ -168 +176 @@
     int        m_iCutoutWidth;
     int        m_iCutoutHeight;
-    /** -1 is no cutout. 0 is the topleft corner. we go clockwise. */
+    /** -1 is for no cutout. 0 is the topleft, 2 is the top right and so on. */
     int        m_iCutoutCorner;
     /** Key's position in the layout. */
@@ -212 +220 @@
     void sltHandleKeyCapEdit();
     void sltHandleSaveKeyCapFile();
+    void sltHandleLoadKeyCapFile();
+    void sltHandleUnloadKeyCaps();
 
 private:
@@ -282 +292 @@
 
     QXmlStreamReader m_xmlReader;
+};
+
+/*********************************************************************************************************************************
+*   UIKeyboardKeyCapReader definition.                                                                                  *
+*********************************************************************************************************************************/
+
+class UIKeyboardKeyCapReader
+{
+
+public:
+
+    UIKeyboardKeyCapReader(const QString &strFileName);
+    const QMap<int, QString> &keyCapMap() const;
+
+private:
+
+    bool  parseKeyCapFile(const QString &strFileName);
+    void  parseKey();
+    QXmlStreamReader m_xmlReader;
+    /** Keys are positions and values are keycaps. */
+    QMap<int, QString> m_keyCapMap;
 };
 
@@ -363 +394 @@
 {
     m_keyGeometry = rect;
+}
+
+const QString &UISoftKeyboardKey::staticKeyCap() const
+{
+    return m_strStaticKeyCap;
+}
+
+void UISoftKeyboardKey::setStaticKeyCap(const QString &strStaticKeyCap)
+{
+    m_strStaticKeyCap = strStaticKeyCap;
 }
 
@@ -622 +663 @@
             if (&key == m_pKeyBeingEdited)
             {
-                //m_pKeyCapEditor->setText(key.keyCap());
                 m_pKeyCapEditor->setFont(painterFont);
                 m_pKeyCapEditor->setGeometry(m_fScaleFactorX * key.keyGeometry().x(), m_fScaleFactorY * key.keyGeometry().y(),
@@ -643 +683 @@
                 painter.drawText(textRect, Qt::TextWordWrap, QString::number(key.position()));
             else
-                painter.drawText(textRect, Qt::TextWordWrap, key.keyCap());
+                painter.drawText(textRect, Qt::TextWordWrap,
+                                 !key.keyCap().isEmpty() ? key.keyCap() : key.staticKeyCap());
 
             if (key.type() != UIKeyType_Ordinary)
@@ -713 +754 @@
             {
                 if (m_pKeyBeingEdited)
-                    m_pKeyBeingEdited->setKeyCap(m_pKeyCapEditor->text());
+                    m_pKeyBeingEdited->setStaticKeyCap(m_pKeyCapEditor->text());
                 m_pKeyBeingEdited = 0;
                 update();
@@ -788 +829 @@
     QFileInfo fileInfo(strFileName);
     if (fileInfo.suffix().compare("xml", Qt::CaseInsensitive) != 0)
-    {
         strFileName += ".xml";
-    }
 
     QFile xmlFile(strFileName);
@@ -811 +850 @@
            UISoftKeyboardKey &key = keys[j];
            xmlWriter.writeTextElement("position", QString::number(key.position()));
-           xmlWriter.writeTextElement("keycap", key.keyCap());
+           if (!key.keyCap().isEmpty())
+               xmlWriter.writeTextElement("keycap", key.keyCap());
+           else
+               xmlWriter.writeTextElement("keycap", key.staticKeyCap());
            xmlWriter.writeEndElement();
-
        }
    }
@@ -820 +861 @@
 
    xmlFile.close();
+}
+
+void UISoftKeyboardWidget::sltHandleLoadKeyCapFile()
+{
+    const QString strFileName = QIFileDialog::getOpenFileName(QString(), UISoftKeyboard::tr("XML files (*.xml)"), this,
+                                                              UISoftKeyboard::tr("Choose file to load key captions.."));
+    if (strFileName.isEmpty())
+        return;
+    UIKeyboardKeyCapReader keyCapReader(strFileName);
+    const QMap<int, QString> &keyCapMap = keyCapReader.keyCapMap();
+
+    for (int i = 0; i < m_rows.size(); ++i)
+    {
+        QVector<UISoftKeyboardKey> &keys = m_rows[i].keys();
+        for (int j = 0; j < keys.size(); ++j)
+        {
+            UISoftKeyboardKey &key = keys[j];
+            if (keyCapMap.contains(key.position()))
+                key.setKeyCap(keyCapMap[key.position()]);
+        }
+    }
+}
+
+void UISoftKeyboardWidget::sltHandleUnloadKeyCaps()
+{
+    for (int i = 0; i < m_rows.size(); ++i)
+    {
+        QVector<UISoftKeyboardKey> &keys = m_rows[i].keys();
+        for (int j = 0; j < keys.size(); ++j)
+            keys[j].setKeyCap(QString());
+    }
 }
 
@@ -1031 +1103 @@
     QAction *pSaveKeyCapFile = pKeycapsMenu->addAction(UISoftKeyboard::tr("Save key caps to file..."));
     connect(pSaveKeyCapFile, &QAction::triggered, this, &UISoftKeyboardWidget::sltHandleSaveKeyCapFile);
-
-    /* Choose the first layput action's data as the defaults one: */
+    QAction *pLoadKeyCapFile = pKeycapsMenu->addAction(UISoftKeyboard::tr("Load key caps from file..."));
+    connect(pLoadKeyCapFile, &QAction::triggered, this, &UISoftKeyboardWidget::sltHandleLoadKeyCapFile);
+    QAction *pUnloadKeyCaps = pKeycapsMenu->addAction(UISoftKeyboard::tr("Unload key caps"));
+    connect(pUnloadKeyCaps, &QAction::triggered, this, &UISoftKeyboardWidget::sltHandleUnloadKeyCaps);
+
+    /* Choose the first layout action's data as the default layout: */
     if (!m_pLayoutActionGroup->actions().empty())
     {
@@ -1174 +1250 @@
             m_xmlReader.skipCurrentElement();
     }
-    key.setKeyCap(strKeyCap);
+    key.setStaticKeyCap(strKeyCap);
 }
 
@@ -1273 +1349 @@
 
 /*********************************************************************************************************************************
+*   UIKeyboardKeyCapReader implementation.                                                                                  *
+*********************************************************************************************************************************/
+
+UIKeyboardKeyCapReader::UIKeyboardKeyCapReader(const QString &strFileName)
+{
+    parseKeyCapFile(strFileName);
+}
+
+const QMap<int, QString> &UIKeyboardKeyCapReader::keyCapMap() const
+{
+    return m_keyCapMap;
+}
+
+bool UIKeyboardKeyCapReader::parseKeyCapFile(const QString &strFileName)
+{
+    QFile xmlFile(strFileName);
+    if (!xmlFile.exists())
+        return false;
+
+    if (!xmlFile.open(QIODevice::ReadOnly))
+        return false;
+
+    m_xmlReader.setDevice(&xmlFile);
+
+    if (!m_xmlReader.readNextStartElement() || m_xmlReader.name() != "keycaps")
+        return false;
+
+    while (m_xmlReader.readNextStartElement())
+    {
+        if (m_xmlReader.name() == "key")
+            parseKey();
+        else
+            m_xmlReader.skipCurrentElement();
+    }
+
+    return true;
+}
+
+void  UIKeyboardKeyCapReader::parseKey()
+{
+    QString strKeyCap;
+    int iKeyPosition = 0;
+    while (m_xmlReader.readNextStartElement())
+    {
+        if (m_xmlReader.name() == "keycap")
+            strKeyCap = m_xmlReader.readElementText();
+        else if (m_xmlReader.name() == "position")
+            iKeyPosition = m_xmlReader.readElementText().toInt();
+        else
+            m_xmlReader.skipCurrentElement();
+    }
+    m_keyCapMap.insert(iKeyPosition, strKeyCap);
+}
+
+/*********************************************************************************************************************************
 *   UISoftKeyboard implementation.                                                                                  *
 *********************************************************************************************************************************/

trunk/src/VBox/Frontends/VirtualBox/xml/101_ansi.xml

@@ -1 +1 @@
 <?xml version="1.0"?>
-
+<!-- https://www.ibm.com/support/knowledgecenter/en/ssw_aix_71/com.ibm.aix.keyboardtechref/doc/kybdtech/Key.htm -->
 <layout defaultHeight="50" defaultWidth="50">
     <row>
@@ -399 +399 @@
         </key>
         <key>
-            <keycap>Win</keycap>
-            <width>75</width>
-            <type>modifier</type>
+            <keycap>OS</keycap>
+            <width>75</width>
+            <type>modifier</type>
+            <position>227</position>
             <scancodeprefix>0xe0</scancodeprefix>
             <scancode>0x5b</scancode>
@@ -426 +427 @@
         </key>
         <key>
-            <keycap>Win</keycap>
-            <width>75</width>
-            <type>modifier</type>
+            <keycap>OS</keycap>
+            <width>75</width>
+            <type>modifier</type>
+            <position>231</position>
             <scancodeprefix>0xe0</scancodeprefix>
             <scancode>0x5c</scancode>

trunk/src/VBox/Frontends/VirtualBox/xml/102_iso.xml

@@ -1 +1 @@
 <?xml version="1.0"?>
-
+<!-- https://www.ibm.com/support/knowledgecenter/en/ssw_aix_71/com.ibm.aix.keyboardtechref/doc/kybdtech/Key.htm -->
 <layout defaultHeight="50" defaultWidth="50">
     <row>
@@ -408 +408 @@
         </key>
         <key>
-            <keycap>Win</keycap>
-            <width>75</width>
-            <type>modifier</type>
+            <keycap>OS</keycap>
+            <width>75</width>
+            <type>modifier</type>
+            <position>227</position>
             <scancodeprefix>0xe0</scancodeprefix>
             <scancode>0x5b</scancode>
@@ -435 +436 @@
         </key>
         <key>
-            <keycap>Win</keycap>
-            <width>75</width>
-            <type>modifier</type>
+            <keycap>OS</keycap>
+            <width>75</width>
+            <type>modifier</type>
+            <position>231</position>
             <scancodeprefix>0xe0</scancodeprefix>
             <scancode>0x5c</scancode>