Keyboard integration for Streamlink quality confirmation (#3169)

Co-authored-by: zneix <zneix@zneix.eu>

src/util/StreamLink.cpp

@@ -200,7 +200,7 @@ void openStreamlinkForChannel(const QString &channel)
     if (preferredQuality == "choose")
     {
         getStreamQualities(channelURL, [=](QStringList qualityOptions) {
-            QualityPopup::showDialog(channel, qualityOptions);
+            QualityPopup::showDialog(channelURL, qualityOptions);
         });
 
         return;

src/widgets/BasePopup.cpp

@@ -1,5 +1,7 @@
 #include "widgets/BasePopup.hpp"
 
+#include <QAbstractButton>
+#include <QDialogButtonBox>
 #include <QKeyEvent>
 
 namespace chatterino {
@@ -20,4 +22,66 @@ void BasePopup::keyPressEvent(QKeyEvent *e)
     BaseWindow::keyPressEvent(e);
 }
 
+bool BasePopup::handleEscape(QKeyEvent *e, QDialogButtonBox *buttonBox)
+{
+    assert(buttonBox != nullptr);
+
+    if (e->key() == Qt::Key_Escape)
+    {
+        auto buttons = buttonBox->buttons();
+        for (auto *button : buttons)
+        {
+            if (auto role = buttonBox->buttonRole(button);
+                role == QDialogButtonBox::ButtonRole::RejectRole)
+            {
+                button->click();
+                return true;
+            }
+        }
+    }
+
+    return false;
+}
+
+bool BasePopup::handleEnter(QKeyEvent *e, QDialogButtonBox *buttonBox)
+{
+    assert(buttonBox != nullptr);
+
+    if (!e->modifiers() ||
+        (e->modifiers() & Qt::KeypadModifier && e->key() == Qt::Key_Enter))
+    {
+        switch (e->key())
+        {
+            case Qt::Key_Enter:
+            case Qt::Key_Return: {
+                auto buttons = buttonBox->buttons();
+                QAbstractButton *acceptButton = nullptr;
+                for (auto *button : buttons)
+                {
+                    if (button->hasFocus())
+                    {
+                        button->click();
+                        return true;
+                    }
+
+                    if (auto role = buttonBox->buttonRole(button);
+                        role == QDialogButtonBox::ButtonRole::AcceptRole)
+                    {
+                        acceptButton = button;
+                    }
+                }
+
+                if (acceptButton != nullptr)
+                {
+                    acceptButton->click();
+                    return true;
+                }
+            }
+            break;
+        }
+    }
+
+    return false;
+}
+
 }  // namespace chatterino

src/widgets/BasePopup.hpp

@@ -3,6 +3,8 @@
 #include "common/FlagsEnum.hpp"
 #include "widgets/BaseWindow.hpp"
 
+class QDialogButtonBox;
+
 namespace chatterino {
 
 class BasePopup : public BaseWindow
@@ -13,6 +15,12 @@ public:
 
 protected:
     void keyPressEvent(QKeyEvent *e) override;
+
+    // handleEscape is a helper function for clicking the "Reject" role button of a button box when the Escape button is pressed
+    bool handleEscape(QKeyEvent *e, QDialogButtonBox *buttonBox);
+
+    // handleEnter is a helper function for clicking the "Accept" role button of a button box when Return or Enter is pressed
+    bool handleEnter(QKeyEvent *e, QDialogButtonBox *buttonBox);
 };
 
 }  // namespace chatterino

src/widgets/dialogs/QualityPopup.cpp

@@ -7,35 +7,32 @@
 
 namespace chatterino {
 
-QualityPopup::QualityPopup(const QString &_channelName, QStringList options)
+QualityPopup::QualityPopup(const QString &channelURL, QStringList options)
     : BasePopup({},
                 static_cast<QWidget *>(&(getApp()->windows->getMainWindow())))
-    , channelName_(_channelName)
+    , channelURL_(channelURL)
 {
-    this->ui_.okButton.setText("OK");
+    this->ui_.selector = new QComboBox(this);
-    this->ui_.cancelButton.setText("Cancel");
+    this->ui_.vbox = new QVBoxLayout(this);
+    this->ui_.buttonBox = new QDialogButtonBox(
+        QDialogButtonBox::Ok | QDialogButtonBox::Cancel, this);
 
-    QObject::connect(&this->ui_.okButton, &QPushButton::clicked, this,
+    QObject::connect(this->ui_.buttonBox, &QDialogButtonBox::accepted, this,
                      &QualityPopup::okButtonClicked);
-    QObject::connect(&this->ui_.cancelButton, &QPushButton::clicked, this,
+    QObject::connect(this->ui_.buttonBox, &QDialogButtonBox::rejected, this,
                      &QualityPopup::cancelButtonClicked);
 
-    this->ui_.buttonBox.addButton(&this->ui_.okButton,
+    this->ui_.selector->addItems(options);
-                                  QDialogButtonBox::ButtonRole::AcceptRole);
-    this->ui_.buttonBox.addButton(&this->ui_.cancelButton,
-                                  QDialogButtonBox::ButtonRole::RejectRole);
 
-    this->ui_.selector.addItems(options);
+    this->ui_.vbox->addWidget(this->ui_.selector);
+    this->ui_.vbox->addWidget(this->ui_.buttonBox);
 
-    this->ui_.vbox.addWidget(&this->ui_.selector);
+    this->setLayout(this->ui_.vbox);
-    this->ui_.vbox.addWidget(&this->ui_.buttonBox);
-
-    this->setLayout(&this->ui_.vbox);
 }
 
-void QualityPopup::showDialog(const QString &channelName, QStringList options)
+void QualityPopup::showDialog(const QString &channelURL, QStringList options)
 {
-    QualityPopup *instance = new QualityPopup(channelName, options);
+    QualityPopup *instance = new QualityPopup(channelURL, options);
 
     instance->window()->setWindowTitle("Chatterino - select stream quality");
     instance->setAttribute(Qt::WA_DeleteOnClose, true);
@@ -43,16 +40,27 @@ void QualityPopup::showDialog(const QString &channelName, QStringList options)
     instance->show();
     instance->activateWindow();
     instance->raise();
-    instance->setFocus();
+}
+
+void QualityPopup::keyPressEvent(QKeyEvent *e)
+{
+    if (this->handleEscape(e, this->ui_.buttonBox))
+    {
+        return;
+    }
+    if (this->handleEnter(e, this->ui_.buttonBox))
+    {
+        return;
+    }
+
+    BasePopup::keyPressEvent(e);
 }
 
 void QualityPopup::okButtonClicked()
 {
-    QString channelURL = "twitch.tv/" + this->channelName_;
-
     try
     {
-        openStreamlink(channelURL, this->ui_.selector.currentText());
+        openStreamlink(this->channelURL_, this->ui_.selector->currentText());
     }
     catch (const Exception &ex)
     {

src/widgets/dialogs/QualityPopup.hpp

@@ -4,7 +4,6 @@
 
 #include <QComboBox>
 #include <QDialogButtonBox>
-#include <QPushButton>
 #include <QVBoxLayout>
 
 namespace chatterino {
@@ -12,22 +11,23 @@ namespace chatterino {
 class QualityPopup : public BasePopup
 {
 public:
-    QualityPopup(const QString &_channelName, QStringList options);
+    QualityPopup(const QString &channelURL, QStringList options);
-    static void showDialog(const QString &_channelName, QStringList options);
+    static void showDialog(const QString &channelURL, QStringList options);
+
+protected:
+    void keyPressEvent(QKeyEvent *e) override;
 
 private:
     void okButtonClicked();
     void cancelButtonClicked();
 
     struct {
-        QVBoxLayout vbox;
+        QVBoxLayout *vbox;
-        QComboBox selector;
+        QComboBox *selector;
-        QDialogButtonBox buttonBox;
+        QDialogButtonBox *buttonBox;
-        QPushButton okButton;
-        QPushButton cancelButton;
     } ui_;
 
-    QString channelName_;
+    QString channelURL_;
 };
 
 }  // namespace chatterino