Add DialogButtonBox::buttonLayout

[ChangeLog][Controls][DialogButtonBox] Added buttonLayout property that
can be used to arrange the buttons.

Change-Id: I9160e5df86a0c9444b45ed9f585c50166c145671
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>

10 files changed, 104 insertions, 12 deletions

diff --git a/src/imports/controls/DialogButtonBox.qml b/src/imports/controls/DialogButtonBox.qml
index 51a5cc49..15619288 100644
--- a/src/imports/controls/DialogButtonBox.qml
+++ b/src/imports/controls/DialogButtonBox.qml
@@ -35,7 +35,7 @@
 ****************************************************************************/
 
 import QtQuick 2.11
-import QtQuick.Templates 2.4 as T
+import QtQuick.Templates 2.5 as T
 
 T.DialogButtonBox {
     id: control
diff --git a/src/imports/controls/fusion/DialogButtonBox.qml b/src/imports/controls/fusion/DialogButtonBox.qml
index 5d30c329..4dd5392a 100644
--- a/src/imports/controls/fusion/DialogButtonBox.qml
+++ b/src/imports/controls/fusion/DialogButtonBox.qml
@@ -35,7 +35,7 @@
 ****************************************************************************/
 
 import QtQuick 2.11
-import QtQuick.Templates 2.4 as T
+import QtQuick.Templates 2.5 as T
 import QtQuick.Controls 2.4
 import QtQuick.Controls.impl 2.4
 import QtQuick.Controls.Fusion 2.4
diff --git a/src/imports/controls/imagine/DialogButtonBox.qml b/src/imports/controls/imagine/DialogButtonBox.qml
index d24ad4ee..e550c16b 100644
--- a/src/imports/controls/imagine/DialogButtonBox.qml
+++ b/src/imports/controls/imagine/DialogButtonBox.qml
@@ -35,7 +35,7 @@
 ****************************************************************************/
 
 import QtQuick 2.11
-import QtQuick.Templates 2.4 as T
+import QtQuick.Templates 2.5 as T
 import QtQuick.Controls 2.4
 import QtQuick.Controls.Imagine 2.4
 import QtQuick.Controls.Imagine.impl 2.4
diff --git a/src/imports/controls/material/DialogButtonBox.qml b/src/imports/controls/material/DialogButtonBox.qml
index 35df6362..40ab42dd 100644
--- a/src/imports/controls/material/DialogButtonBox.qml
+++ b/src/imports/controls/material/DialogButtonBox.qml
@@ -35,7 +35,7 @@
 ****************************************************************************/
 
 import QtQuick 2.11
-import QtQuick.Templates 2.4 as T
+import QtQuick.Templates 2.5 as T
 import QtQuick.Controls 2.4
 import QtQuick.Controls.impl 2.4
 import QtQuick.Controls.Material 2.4
diff --git a/src/imports/controls/universal/DialogButtonBox.qml b/src/imports/controls/universal/DialogButtonBox.qml
index 7f28a144..fc63f8f1 100644
--- a/src/imports/controls/universal/DialogButtonBox.qml
+++ b/src/imports/controls/universal/DialogButtonBox.qml
@@ -35,7 +35,7 @@
 ****************************************************************************/
 
 import QtQuick 2.11
-import QtQuick.Templates 2.4 as T
+import QtQuick.Templates 2.5 as T
 import QtQuick.Controls 2.4
 import QtQuick.Controls.Universal 2.4
 
diff --git a/src/imports/templates/qtquicktemplates2plugin.cpp b/src/imports/templates/qtquicktemplates2plugin.cpp
index f9bcfc98..024eb6cf 100644
--- a/src/imports/templates/qtquicktemplates2plugin.cpp
+++ b/src/imports/templates/qtquicktemplates2plugin.cpp
@@ -330,6 +330,7 @@ void QtQuickTemplates2Plugin::registerTypes(const char *uri)
     qmlRegisterType<QQuickSpinBox, 4>(uri, 2, 4, "SpinBox");
 
     // QtQuick.Templates 2.5 (new types and revisions in Qt 5.12)
+    qmlRegisterType<QQuickDialogButtonBox, 5>(uri, 2, 5, "DialogButtonBox");
     qmlRegisterType<QQuickControl, 5>(uri, 2, 5, "Control");
     qmlRegisterType<QQuickPopup, 5>(uri, 2, 5, "Popup");
     qmlRegisterType<QQuickTextField, 5>(uri, 2, 5, "TextField");
diff --git a/src/quicktemplates2/qquickdialogbuttonbox.cpp b/src/quicktemplates2/qquickdialogbuttonbox.cpp
index cd971139..70425c40 100644
--- a/src/quicktemplates2/qquickdialogbuttonbox.cpp
+++ b/src/quicktemplates2/qquickdialogbuttonbox.cpp
@@ -168,10 +168,16 @@ QT_BEGIN_NAMESPACE
     \sa accepted(), rejected(), helpRequested()
 */
 
+static QQuickDialogButtonBox::ButtonLayout platformButtonLayout()
+{
+    return QGuiApplicationPrivate::platformTheme()->themeHint(QPlatformTheme::DialogButtonBoxLayout).value<QQuickDialogButtonBox::ButtonLayout>();
+}
+
 QQuickDialogButtonBoxPrivate::QQuickDialogButtonBoxPrivate()
     : alignment(0),
       position(QQuickDialogButtonBox::Footer),
       standardButtons(QPlatformDialogHelper::NoButton),
+      buttonLayout(platformButtonLayout()),
       delegate(nullptr)
 {
 }
@@ -258,6 +264,11 @@ void QQuickDialogButtonBoxPrivate::updateLayout()
     }
 
     struct ButtonLayout {
+        ButtonLayout(QPlatformDialogHelper::ButtonLayout layout)
+            : m_layout(QPlatformDialogHelper::buttonLayout(Qt::Horizontal, layout))
+        {
+        }
+
         bool operator()(QQuickAbstractButton *first, QQuickAbstractButton *second)
         {
             const QPlatformDialogHelper::ButtonRole firstRole = QQuickDialogPrivate::buttonRole(first);
@@ -280,15 +291,10 @@ void QQuickDialogButtonBoxPrivate::updateLayout()
 
             return firstRole != QPlatformDialogHelper::InvalidRole;
         }
-        static const int *themeButtonLayout()
-        {
-            const int hint = QGuiApplicationPrivate::platformTheme()->themeHint(QPlatformTheme::DialogButtonBoxLayout).toInt();
-            return QPlatformDialogHelper::buttonLayout(Qt::Horizontal, static_cast<QPlatformDialogHelper::ButtonLayout>(hint));
-        }
-        const int *m_layout = themeButtonLayout();
+        const int *m_layout;
     };
 
-    std::sort(buttons.begin(), buttons.end(), ButtonLayout());
+    std::sort(buttons.begin(), buttons.end(), ButtonLayout(static_cast<QPlatformDialogHelper::ButtonLayout>(buttonLayout)));
 
     for (int i = 0; i < buttons.count() - 1; ++i)
         q->insertItem(i, buttons.at(i));
@@ -580,6 +586,43 @@ QQuickDialogButtonBoxAttached *QQuickDialogButtonBox::qmlAttachedProperties(QObj
     return new QQuickDialogButtonBoxAttached(object);
 }
 
+/*!
+    \since QtQuick.Controls 2.5 (Qt 5.12)
+    \qmlproperty enumeration QtQuick.Controls::DialogButtonBox::buttonLayout
+
+    This property holds the button layout policy to be used when arranging the buttons contained in the button box.
+    The default value is platform-specific.
+
+    Available values:
+    \value DialogButtonBox.WinLayout Use a policy appropriate for applications on Windows.
+    \value DialogButtonBox.MacLayout Use a policy appropriate for applications on macOS.
+    \value DialogButtonBox.KdeLayout Use a policy appropriate for applications on KDE.
+    \value DialogButtonBox.GnomeLayout Use a policy appropriate for applications on GNOME.
+    \value DialogButtonBox.AndroidLayout Use a policy appropriate for applications on Android.
+*/
+QQuickDialogButtonBox::ButtonLayout QQuickDialogButtonBox::buttonLayout() const
+{
+    Q_D(const QQuickDialogButtonBox);
+    return d->buttonLayout;
+}
+
+void QQuickDialogButtonBox::setButtonLayout(ButtonLayout layout)
+{
+    Q_D(QQuickDialogButtonBox);
+    if (d->buttonLayout == layout)
+        return;
+
+    d->buttonLayout = layout;
+    if (isComponentComplete())
+        d->updateLayout();
+    emit buttonLayoutChanged();
+}
+
+void QQuickDialogButtonBox::resetButtonLayout()
+{
+    setButtonLayout(platformButtonLayout());
+}
+
 void QQuickDialogButtonBox::updatePolish()
 {
     Q_D(QQuickDialogButtonBox);
diff --git a/src/quicktemplates2/qquickdialogbuttonbox_p.h b/src/quicktemplates2/qquickdialogbuttonbox_p.h
index 1e3cdeef..df302e54 100644
--- a/src/quicktemplates2/qquickdialogbuttonbox_p.h
+++ b/src/quicktemplates2/qquickdialogbuttonbox_p.h
@@ -66,6 +66,8 @@ class Q_QUICKTEMPLATES2_PRIVATE_EXPORT QQuickDialogButtonBox : public QQuickCont
     Q_PROPERTY(Qt::Alignment alignment READ alignment WRITE setAlignment RESET resetAlignment NOTIFY alignmentChanged FINAL)
     Q_PROPERTY(QPlatformDialogHelper::StandardButtons standardButtons READ standardButtons WRITE setStandardButtons NOTIFY standardButtonsChanged FINAL)
     Q_PROPERTY(QQmlComponent *delegate READ delegate WRITE setDelegate NOTIFY delegateChanged FINAL)
+    // 2.5 (Qt 5.12)
+    Q_PROPERTY(ButtonLayout buttonLayout READ buttonLayout WRITE setButtonLayout RESET resetButtonLayout NOTIFY buttonLayoutChanged FINAL REVISION 5)
     Q_FLAGS(QPlatformDialogHelper::StandardButtons)
 
 public:
@@ -94,6 +96,24 @@ public:
 
     static QQuickDialogButtonBoxAttached *qmlAttachedProperties(QObject *object);
 
+    // 2.5 (Qt 5.12)
+
+    // ### TODO: use Q_ENUMS(QPlatformDialogHelper::ButtonLayout)
+    enum ButtonLayout {
+        UnknownLayout = -1,
+        WinLayout,
+        MacLayout,
+        KdeLayout,
+        GnomeLayout,
+        MacModelessLayout,
+        AndroidLayout
+    };
+    Q_ENUM(ButtonLayout)
+
+    ButtonLayout buttonLayout() const;
+    void setButtonLayout(ButtonLayout layout);
+    void resetButtonLayout();
+
 Q_SIGNALS:
     void accepted();
     void rejected();
@@ -107,6 +127,8 @@ Q_SIGNALS:
     Q_REVISION(3) void applied();
     Q_REVISION(3) void reset();
     Q_REVISION(3) void discarded();
+    // 2.5 (Qt 5.12)
+    Q_REVISION(5) void buttonLayoutChanged();
 
 protected:
     void updatePolish() override;
diff --git a/src/quicktemplates2/qquickdialogbuttonbox_p_p.h b/src/quicktemplates2/qquickdialogbuttonbox_p_p.h
index 7247d591..3c761d6b 100644
--- a/src/quicktemplates2/qquickdialogbuttonbox_p_p.h
+++ b/src/quicktemplates2/qquickdialogbuttonbox_p_p.h
@@ -78,6 +78,7 @@ public:
     Qt::Alignment alignment;
     QQuickDialogButtonBox::Position position;
     QPlatformDialogHelper::StandardButtons standardButtons;
+    QQuickDialogButtonBox::ButtonLayout buttonLayout;
     QQmlComponent *delegate;
 };
 
diff --git a/tests/auto/controls/data/tst_dialogbuttonbox.qml b/tests/auto/controls/data/tst_dialogbuttonbox.qml
index 044c9593..7d343cc6 100644
--- a/tests/auto/controls/data/tst_dialogbuttonbox.qml
+++ b/tests/auto/controls/data/tst_dialogbuttonbox.qml
@@ -195,4 +195,29 @@ TestCase {
         compare(clickedSpy.signalArguments[0][0], button)
         compare(roleSpy.count, 1)
     }
+
+    function test_buttonLayout_data() {
+        return [
+            { tag: "WinLayout", buttonLayout: DialogButtonBox.WinLayout, button1Role: DialogButtonBox.AcceptRole, button2Role: DialogButtonBox.RejectRole },
+            { tag: "MacLayout", buttonLayout: DialogButtonBox.MacLayout, button1Role: DialogButtonBox.RejectRole, button2Role: DialogButtonBox.AcceptRole },
+            { tag: "KdeLayout", buttonLayout: DialogButtonBox.KdeLayout, button1Role: DialogButtonBox.AcceptRole, button2Role: DialogButtonBox.RejectRole },
+            { tag: "GnomeLayout", buttonLayout: DialogButtonBox.GnomeLayout, button1Role: DialogButtonBox.RejectRole, button2Role: DialogButtonBox.AcceptRole },
+            { tag: "AndroidLayout", buttonLayout: DialogButtonBox.AndroidLayout, button1Role: DialogButtonBox.RejectRole, button2Role: DialogButtonBox.AcceptRole }
+        ]
+    }
+
+    function test_buttonLayout(data) {
+        var control = createTemporaryObject(buttonBox, testCase, {buttonLayout: data.buttonLayout, standardButtons: DialogButtonBox.Ok|DialogButtonBox.Cancel})
+        verify(control)
+
+        compare(control.count, 2)
+
+        var button1 = control.itemAt(0)
+        verify(button1)
+        compare(button1.DialogButtonBox.buttonRole, data.button1Role)
+
+        var button2 = control.itemAt(1)
+        verify(button2)
+        compare(button2.DialogButtonBox.buttonRole, data.button2Role)
+    }
 }