refactor: use .ui file instead of manual layout in settings dialog.

- enable Qt UIC in cmake file.
- use .ui file to replace manually written layout in settings dialog.

CMakeLists.txt

@@ -16,6 +16,7 @@ set (CMAKE_CXX_STANDARD 17)
 set (CMAKE_CXX_STANDARD_REQUIRED ON)
 set (CMAKE_AUTOMOC ON)
 set (CMAKE_AUTORCC ON)
+set (CMAKE_AUTOUIC ON)
 
 find_package(QT NAMES Qt6 REQUIRED COMPONENTS Core)
 
@@ -73,6 +74,10 @@ set (PPIC_HEADER_FILES
     app/fileopeneventhandler.h
 )
 
+set (PPIC_UI_FILES
+    app/settingsdialog.ui
+)
+
 set (PPIC_QRC_FILES
     assets/resources.qrc
 )
@@ -95,6 +100,7 @@ endif ()
 add_executable (${EXE_NAME}
     ${PPIC_HEADER_FILES}
     ${PPIC_CPP_FILES}
+    ${PPIC_UI_FILES}
     ${PPIC_QRC_FILES}
     ${PPIC_RC_FILES}
 )

app/settingsdialog.cpp

@@ -3,112 +3,107 @@
 // SPDX-License-Identifier: MIT
 
 #include "settingsdialog.h"
+#include "ui_settingsdialog.h"
 
 #include "settings.h"
 
-#include <QAction>
+#include <QApplication>
-#include <QCheckBox>
+#include <QTimer>
-#include <QComboBox>
-#include <QFormLayout>
-#include <QKeySequenceEdit>
-#include <QScrollArea>
-#include <QSplitter>
 #include <QStringListModel>
-#include <QMessageBox>
+#include <type_traits>
+
+template <typename E, typename = std::enable_if_t<std::is_enum_v<E>>>
+class EnumComboBoxTransformer {
+public:
+    using Pair = QPair<E, QString>;
+    using Pairs = QList<QPair<E, QString>>;
+
+    EnumComboBoxTransformer(Pairs &&pairs) : pairs(std::move(pairs)) {}
+    ~EnumComboBoxTransformer() = default;
+    Q_DISABLE_COPY_MOVE(EnumComboBoxTransformer)
+
+    /// Build Qt model used for QComboBox
+    QStringListModel* buildComboBoxModel(QObject *parent = nullptr) const {
+        QStringList dropDownEntries;
+        for (const auto& pair : std::as_const(this->pairs)) {
+            dropDownEntries.append(pair.second);
+        }
+        return new QStringListModel(dropDownEntries, parent);
+    }
+    /// Convert QComboBox index to enum value.
+    E to_value(int index) const {
+        return this->pairs.at(static_cast<qsizetype>(index)).first;
+    }
+    /// Convert enum value to QComboBox index.
+    int to_index(E value) const {
+        for (qsizetype i = 0; i < pairs.size(); ++i) {
+            if (pairs.at(i).first == value) {
+                return static_cast<int>(i);
+            }
+        }
+        // Value not found
+        throw std::invalid_argument("invalid enum value for finding index");
+    }
+
+private:
+    Pairs pairs;
+};
+
+static EnumComboBoxTransformer<Settings::DoubleClickBehavior> DC_OPTIONS {
+    {
+        {Settings::DoubleClickBehavior::Ignore, QCoreApplication::translate("SettingsDialog", "Do nothing")},
+        {Settings::DoubleClickBehavior::Close, QCoreApplication::translate("SettingsDialog", "Close the window")},
+        {Settings::DoubleClickBehavior::Maximize, QCoreApplication::translate("SettingsDialog", "Toggle maximize")},
+        {Settings::DoubleClickBehavior::FullScreen, QCoreApplication::translate("SettingsDialog", "Toggle fullscreen")}
+    }
+};
+
+static EnumComboBoxTransformer<Settings::MouseWheelBehavior, QString> MW_OPTIONS {
+    {
+        { Settings::MouseWheelBehavior::Zoom, QCoreApplication::translate("SettingsDialog", "Zoom in and out") },
+        { Settings::MouseWheelBehavior::Switch, QCoreApplication::translate("SettingsDialog", "View next or previous item") }
+    }
+};
+
+static EnumComboBoxTransformer<Settings::WindowSizeBehavior, QString> IWS_OPTIONS {
+    {
+        { Settings::WindowSizeBehavior::Auto, QCoreApplication::translate("SettingsDialog", "Auto size") },
+        { Settings::WindowSizeBehavior::Maximized, QCoreApplication::translate("SettingsDialog", "Maximized") },
+        { Settings::WindowSizeBehavior::Windowed, QCoreApplication::translate("SettingsDialog", "Windowed") }
+    }
+};
+
+static EnumComboBoxTransformer<Qt::HighDpiScaleFactorRoundingPolicy, QString> HIDPI_OPTIONS {
+    {
+        { Qt::HighDpiScaleFactorRoundingPolicy::Round, QCoreApplication::translate("SettingsDialog", "Round (Integer scaling)", "This option means round up for .5 and above") },
+        { Qt::HighDpiScaleFactorRoundingPolicy::Ceil, QCoreApplication::translate("SettingsDialog", "Ceil (Integer scaling)", "This option means always round up") },
+        { Qt::HighDpiScaleFactorRoundingPolicy::Floor, QCoreApplication::translate("SettingsDialog", "Floor (Integer scaling)", "This option means always round down") },
+        { Qt::HighDpiScaleFactorRoundingPolicy::PassThrough, QCoreApplication::translate("SettingsDialog", "Follow system (Fractional scaling)", "This option means don't round") }
+    }
+};
 
 SettingsDialog::SettingsDialog(QWidget *parent)
-    : QDialog(parent)
+    : QDialog(parent), ui(new Ui::SettingsDialog)
-    , m_useLightCheckerboard(new QCheckBox)
-    , m_loopGallery(new QCheckBox)
-    , m_svgTiny12Only(new QCheckBox)
-    , m_doubleClickBehavior(new QComboBox)
-    , m_mouseWheelBehavior(new QComboBox)
-    , m_initWindowSizeBehavior(new QComboBox)
-    , m_hiDpiRoundingPolicyBehavior(new QComboBox)
 {
-    this->setWindowTitle(tr("Settings"));
+    ui->setupUi(this);
+    setWindowFlag(Qt::WindowContextHelpButtonHint, false);
 
-    QHBoxLayout * mainLayout = new QHBoxLayout(this);
+    auto* settings = Settings::instance();
-    QTabWidget * settingsTabs = new QTabWidget(this);
+    ui->m_useLightCheckerboard->setChecked(settings->useLightCheckerboard());
-    mainLayout->addWidget(settingsTabs);
+    ui->m_loopGallery->setChecked(settings->loopGallery());
-
+    ui->m_svgTiny12Only->setChecked(settings->svgTiny12Only());
-    QWidget * settingsFormHolder = new QWidget;
+    ui->m_doubleClickBehavior->setModel(DC_OPTIONS.buildComboBoxModel(this));
-    QFormLayout * settingsForm = new QFormLayout(settingsFormHolder);
+    Settings::DoubleClickBehavior dcb = settings->doubleClickBehavior();
-    settingsTabs->addTab(settingsFormHolder, tr("Options"));
+    ui->m_doubleClickBehavior->setCurrentIndex(DC_OPTIONS.to_index(dcb));
-
+    ui->m_mouseWheelBehavior->setModel(MW_OPTIONS.buildComboBoxModel(this));
-    static QList< QPair<Settings::DoubleClickBehavior, QString> > _dc_options {
+    Settings::MouseWheelBehavior mwb = settings->mouseWheelBehavior();
-        { Settings::DoubleClickBehavior::Ignore, tr("Do nothing") },
+    ui->m_mouseWheelBehavior->setCurrentIndex(MW_OPTIONS.to_index(mwb));
-        { Settings::DoubleClickBehavior::Close, tr("Close the window") },
+    ui->m_initWindowSizeBehavior->setModel(IWS_OPTIONS.buildComboBoxModel(this));
-        { Settings::DoubleClickBehavior::Maximize, tr("Toggle maximize") },
+    Settings::WindowSizeBehavior iwsb = settings->initWindowSizeBehavior();
-        { Settings::DoubleClickBehavior::FullScreen, tr("Toggle fullscreen") }
+    ui->m_initWindowSizeBehavior->setCurrentIndex(IWS_OPTIONS.to_index(iwsb));
-    };
+    ui->m_hiDpiRoundingPolicyBehavior->setModel(HIDPI_OPTIONS.buildComboBoxModel(this));
-
+    Qt::HighDpiScaleFactorRoundingPolicy hidpi = settings->hiDpiScaleFactorBehavior();
-    static QList< QPair<Settings::MouseWheelBehavior, QString> > _mw_options {
+    ui->m_hiDpiRoundingPolicyBehavior->setCurrentIndex(HIDPI_OPTIONS.to_index(hidpi));
-        { Settings::MouseWheelBehavior::Zoom, tr("Zoom in and out") },
-        { Settings::MouseWheelBehavior::Switch, tr("View next or previous item") }
-    };
-
-    static QList< QPair<Settings::WindowSizeBehavior, QString> > _iws_options {
-        { Settings::WindowSizeBehavior::Auto, tr("Auto size") },
-        { Settings::WindowSizeBehavior::Maximized, tr("Maximized") },
-        { Settings::WindowSizeBehavior::Windowed, tr("Windowed") }
-    };
-
-    static QList< QPair<Qt::HighDpiScaleFactorRoundingPolicy, QString> > _hidpi_options {
-        { Qt::HighDpiScaleFactorRoundingPolicy::Round, tr("Round (Integer scaling)", "This option means round up for .5 and above") },
-        { Qt::HighDpiScaleFactorRoundingPolicy::Ceil, tr("Ceil (Integer scaling)", "This option means always round up") },
-        { Qt::HighDpiScaleFactorRoundingPolicy::Floor, tr("Floor (Integer scaling)", "This option means always round down") },
-        { Qt::HighDpiScaleFactorRoundingPolicy::PassThrough, tr("Follow system (Fractional scaling)", "This option means don't round") }
-    };
-
-    QStringList dcbDropDown;
-    for (const QPair<Settings::DoubleClickBehavior, QString> & dcOption : _dc_options) {
-        dcbDropDown.append(dcOption.second);
-    }
-
-    QStringList mwbDropDown;
-    for (const QPair<Settings::MouseWheelBehavior, QString> & mwOption : _mw_options) {
-        mwbDropDown.append(mwOption.second);
-    }
-
-    QStringList iwsbDropDown;
-    for (const QPair<Settings::WindowSizeBehavior, QString> & iwsOption : _iws_options) {
-        iwsbDropDown.append(iwsOption.second);
-    }
-
-    QStringList hidpiDropDown;
-    for (const QPair<Qt::HighDpiScaleFactorRoundingPolicy, QString> & hidpiOption : _hidpi_options) {
-        hidpiDropDown.append(hidpiOption.second);
-    }
-
-    settingsForm->addRow(tr("Use light-color checkerboard"), m_useLightCheckerboard);
-    settingsForm->addRow(tr("Loop the loaded gallery"), m_loopGallery);
-    settingsForm->addRow(tr("Limit SVG support to SVG Tiny 1.2"), m_svgTiny12Only);
-    settingsForm->addRow(tr("Double-click behavior"), m_doubleClickBehavior);
-    settingsForm->addRow(tr("Mouse wheel behavior"), m_mouseWheelBehavior);
-    settingsForm->addRow(tr("Default window size"), m_initWindowSizeBehavior);
-    settingsForm->addRow(tr("HiDPI scale factor rounding policy"), m_hiDpiRoundingPolicyBehavior);
-
-    m_useLightCheckerboard->setChecked(Settings::instance()->useLightCheckerboard());
-    m_loopGallery->setChecked(Settings::instance()->loopGallery());
-    m_svgTiny12Only->setChecked(Settings::instance()->svgTiny12Only());
-    m_doubleClickBehavior->setModel(new QStringListModel(dcbDropDown));
-    Settings::DoubleClickBehavior dcb = Settings::instance()->doubleClickBehavior();
-    m_doubleClickBehavior->setCurrentIndex(static_cast<int>(dcb));
-    m_mouseWheelBehavior->setModel(new QStringListModel(mwbDropDown));
-    Settings::MouseWheelBehavior mwb = Settings::instance()->mouseWheelBehavior();
-    m_mouseWheelBehavior->setCurrentIndex(static_cast<int>(mwb));
-    m_initWindowSizeBehavior->setModel(new QStringListModel(iwsbDropDown));
-    Settings::WindowSizeBehavior iwsb = Settings::instance()->initWindowSizeBehavior();
-    m_initWindowSizeBehavior->setCurrentIndex(static_cast<int>(iwsb));
-    m_hiDpiRoundingPolicyBehavior->setModel(new QStringListModel(hidpiDropDown));
-    Qt::HighDpiScaleFactorRoundingPolicy hidpi = Settings::instance()->hiDpiScaleFactorBehavior();
-    for (int i = 0; i < _hidpi_options.count(); i++) {
-        if (_hidpi_options.at(i).first == hidpi) {
-            m_hiDpiRoundingPolicyBehavior->setCurrentIndex(i);
-            break;
-        }
-    }
 
 #if QT_VERSION >= QT_VERSION_CHECK(6, 7, 0)
 # define QCHECKBOX_CHECKSTATECHANGED QCheckBox::checkStateChanged
@@ -118,39 +113,45 @@ SettingsDialog::SettingsDialog(QWidget *parent)
 # define QT_CHECKSTATE int
 #endif // QT_VERSION >= QT_VERSION_CHECK(6, 7, 0)
 
-    connect(m_useLightCheckerboard, &QCHECKBOX_CHECKSTATECHANGED, this, [ = ](QT_CHECKSTATE state){
+    connect(ui->m_useLightCheckerboard, &QCHECKBOX_CHECKSTATECHANGED, this, [ = ](QT_CHECKSTATE state){
         Settings::instance()->setUseLightCheckerboard(state == Qt::Checked);
     });
 
-    connect(m_loopGallery, &QCHECKBOX_CHECKSTATECHANGED, this, [ = ](QT_CHECKSTATE state){
+    connect(ui->m_loopGallery, &QCHECKBOX_CHECKSTATECHANGED, this, [ = ](QT_CHECKSTATE state){
         Settings::instance()->setLoopGallery(state == Qt::Checked);
     });
 
-    connect(m_svgTiny12Only, &QCHECKBOX_CHECKSTATECHANGED, this, [ = ](QT_CHECKSTATE state){
+    connect(ui->m_svgTiny12Only, &QCHECKBOX_CHECKSTATECHANGED, this, [ = ](QT_CHECKSTATE state){
         Settings::instance()->setSvgTiny12Only(state == Qt::Checked);
     });
 
-    connect(m_doubleClickBehavior, QOverload<int>::of(&QComboBox::currentIndexChanged), this, [ = ](int index){
+    connect(ui->m_doubleClickBehavior, QOverload<int>::of(&QComboBox::currentIndexChanged), this, [ = ](int index){
-        Settings::instance()->setDoubleClickBehavior(_dc_options.at(index).first);
+        Settings::instance()->setDoubleClickBehavior(DC_OPTIONS.to_value(index));
     });
 
-    connect(m_mouseWheelBehavior, QOverload<int>::of(&QComboBox::currentIndexChanged), this, [ = ](int index){
+    connect(ui->m_mouseWheelBehavior, QOverload<int>::of(&QComboBox::currentIndexChanged), this, [ = ](int index){
-        Settings::instance()->setMouseWheelBehavior(_mw_options.at(index).first);
+        Settings::instance()->setMouseWheelBehavior(MW_OPTIONS.to_value(index));
     });
 
-    connect(m_initWindowSizeBehavior, QOverload<int>::of(&QComboBox::currentIndexChanged), this, [ = ](int index){
+    connect(ui->m_initWindowSizeBehavior, QOverload<int>::of(&QComboBox::currentIndexChanged), this, [ = ](int index){
-        Settings::instance()->setInitWindowSizeBehavior(_iws_options.at(index).first);
+        Settings::instance()->setInitWindowSizeBehavior(IWS_OPTIONS.to_value(index));
     });
 
-    connect(m_hiDpiRoundingPolicyBehavior, QOverload<int>::of(&QComboBox::currentIndexChanged), this, [ = ](int index){
+    connect(ui->m_hiDpiRoundingPolicyBehavior, QOverload<int>::of(&QComboBox::currentIndexChanged), this, [ = ](int index){
-        Settings::instance()->setHiDpiScaleFactorBehavior(_hidpi_options.at(index).first);
+        Settings::instance()->setHiDpiScaleFactorBehavior(HIDPI_OPTIONS.to_value(index));
     });
 
-    adjustSize();
+    // YYC MARK:
-    setWindowFlag(Qt::WindowContextHelpButtonHint, false);
+    // Use adjustSize() to make sure all ComboBox are expanded by its items.
+    // Because items are added after inserting them into layout.
+    // It is inviable to call this function in ctor because this relys on Qt event system.
+    // It only can be done by QTimer::singleShot().
+    QTimer::singleShot(0, this, [this](){
+        this->adjustSize();
+    });
 }
 
 SettingsDialog::~SettingsDialog()
 {
-
+    delete ui;
 }

app/settingsdialog.h

@@ -8,8 +8,12 @@
 #include <QObject>
 #include <QDialog>
 
-class QCheckBox;
+QT_BEGIN_NAMESPACE
-class QComboBox;
+namespace Ui {
+class SettingsDialog;
+}
+QT_END_NAMESPACE
+
 class SettingsDialog : public QDialog
 {
     Q_OBJECT
@@ -17,18 +21,8 @@ public:
     explicit SettingsDialog(QWidget *parent = nullptr);
     ~SettingsDialog();
 
-signals:
-
-public slots:
-
 private:
-    QCheckBox * m_useLightCheckerboard = nullptr;
+    QT_PREPEND_NAMESPACE(Ui::SettingsDialog) *ui;
-    QCheckBox * m_loopGallery = nullptr;
-    QCheckBox * m_svgTiny12Only = nullptr;
-    QComboBox * m_doubleClickBehavior = nullptr;
-    QComboBox * m_mouseWheelBehavior = nullptr;
-    QComboBox * m_initWindowSizeBehavior = nullptr;
-    QComboBox * m_hiDpiRoundingPolicyBehavior = nullptr;
 };
 
 #endif // SETTINGSDIALOG_H

app/settingsdialog.ui

@@ -0,0 +1,91 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>SettingsDialog</class>
+ <widget class="QDialog" name="SettingsDialog">
+  <property name="windowModality">
+   <enum>Qt::NonModal</enum>
+  </property>
+  <property name="windowTitle">
+   <string>Settings</string>
+  </property>
+  <layout class="QHBoxLayout" name="mainLayout">
+   <item>
+    <widget class="QTabWidget" name="settingsTabs">
+     <property name="currentIndex">
+      <number>0</number>
+     </property>
+     <widget class="QWidget" name="optionsTab">
+      <attribute name="title">
+       <string>Options</string>
+      </attribute>
+      <layout class="QFormLayout" name="settingsForm">
+        <item row="0" column="0" colspan="2">
+         <widget class="QCheckBox" name="m_useLightCheckerboard">
+          <property name="text">
+           <string>Use light-color checkerboard</string>
+          </property>
+         </widget>
+        </item>
+        <item row="1" column="0" colspan="2">
+         <widget class="QCheckBox" name="m_loopGallery">
+          <property name="text">
+           <string>Loop the loaded gallery</string>
+          </property>
+         </widget>
+        </item>
+        <item row="2" column="0" colspan="2">
+         <widget class="QCheckBox" name="m_svgTiny12Only">
+          <property name="text">
+           <string>Limit SVG support to SVG Tiny 1.2</string>
+          </property>
+         </widget>
+        </item>
+       <item row="3" column="0">
+         <widget class="QLabel" name="m_doubleClickBehaviorLabel">
+         <property name="text">
+          <string>Double-click behavior</string>
+         </property>
+        </widget>
+       </item>
+       <item row="3" column="1">
+        <widget class="QComboBox" name="m_doubleClickBehavior"/>
+       </item>
+       <item row="4" column="0">
+         <widget class="QLabel" name="m_mouseWheelBehaviorLabel">
+         <property name="text">
+          <string>Mouse wheel behavior</string>
+         </property>
+        </widget>
+       </item>
+       <item row="4" column="1">
+        <widget class="QComboBox" name="m_mouseWheelBehavior"/>
+       </item>
+       <item row="5" column="0">
+         <widget class="QLabel" name="m_initWindowSizeBehaviorLabel">
+         <property name="text">
+          <string>Default window size</string>
+         </property>
+        </widget>
+       </item>
+       <item row="5" column="1">
+        <widget class="QComboBox" name="m_initWindowSizeBehavior"/>
+       </item>
+       <item row="6" column="0">
+         <widget class="QLabel" name="m_hiDpiRoundingPolicyBehaviorLabel">
+         <property name="text">
+          <string>HiDPI scale factor rounding policy</string>
+         </property>
+        </widget>
+       </item>
+       <item row="6" column="1">
+        <widget class="QComboBox" name="m_hiDpiRoundingPolicyBehavior"/>
+       </item>
+      </layout>
+     </widget>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>