ProjectExplorer: Add LayoutBuilder ability to operate on QGridLayout

Also, make it possible to extend an existing layout.

Change-Id: Idcbc7ace967e575dd743c7d748f4d3b751668f7a
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>

src/plugins/projectexplorer/projectconfiguration.cpp

@@ -60,22 +60,44 @@ void ProjectConfigurationAspect::addToLayout(LayoutBuilder &)
 
 // LayoutBuilder
 
-LayoutBuilder::LayoutBuilder(QWidget *parent)
-    : m_layout(new QFormLayout(parent))
+LayoutBuilder::LayoutBuilder(QWidget *parent, LayoutType layoutType)
 {
-    m_layout->setContentsMargins(0, 0, 0, 0);
-    if (auto fl = qobject_cast<QFormLayout *>(m_layout))
-        fl->setFieldGrowthPolicy(QFormLayout::ExpandingFieldsGrow);
+    if (layoutType == FormLayout) {
+        m_formLayout = new QFormLayout(parent);
+        m_formLayout->setContentsMargins(0, 0, 0, 0);
+        m_formLayout->setFieldGrowthPolicy(QFormLayout::ExpandingFieldsGrow);
+    } else {
+        m_gridLayout = new QGridLayout(parent);
+        m_gridLayout->setContentsMargins(0, 0, 0, 0);
+    }
+}
+
+LayoutBuilder::LayoutBuilder(QLayout *layout)
+{
+    if (auto fl = qobject_cast<QFormLayout *>(layout)) {
+        m_formLayout = fl;
+    } else if (auto grid = qobject_cast<QGridLayout *>(layout)) {
+        m_gridLayout = grid;
+        m_currentGridRow = grid->rowCount();
+        m_currentGridColumn = 0;
+    }
 }
 
 LayoutBuilder::~LayoutBuilder()
 {
-    flushPendingItems();
+    flushPendingFormItems();
 }
 
 LayoutBuilder &LayoutBuilder::startNewRow()
 {
-    flushPendingItems();
+    if (m_formLayout)
+        flushPendingFormItems();
+    if (m_gridLayout) {
+        if (m_currentGridColumn != 0) {
+            ++m_currentGridRow;
+            m_currentGridColumn = 0;
+        }
+    }
     return *this;
 }
 
@@ -86,69 +108,76 @@ LayoutBuilder &LayoutBuilder::addRow(const LayoutItem &item)
     return *this;
 }
 
-void LayoutBuilder::flushPendingItems()
+void LayoutBuilder::flushPendingFormItems()
 {
-    if (m_pendingItems.isEmpty())
+    QTC_ASSERT(m_formLayout, return);
+
+    if (m_pendingFormItems.isEmpty())
         return;
 
-    if (auto fl = qobject_cast<QFormLayout *>(m_layout)) {
-        // If there are more than two items, we cram the last ones in one hbox.
-        if (m_pendingItems.size() > 2) {
-            auto hbox = new QHBoxLayout;
-            hbox->setContentsMargins(0, 0, 0, 0);
-            for (int i = 1; i < m_pendingItems.size(); ++i) {
-                if (QWidget *w = m_pendingItems.at(i).widget)
-                    hbox->addWidget(w);
-                else if (QLayout *l = m_pendingItems.at(i).layout)
-                    hbox->addItem(l);
-                else
-                    QTC_CHECK(false);
-            }
-            while (m_pendingItems.size() >= 2)
-                m_pendingItems.takeLast();
-            m_pendingItems.append(LayoutItem(hbox));
+    // If there are more than two items, we cram the last ones in one hbox.
+    if (m_pendingFormItems.size() > 2) {
+        auto hbox = new QHBoxLayout;
+        hbox->setContentsMargins(0, 0, 0, 0);
+        for (int i = 1; i < m_pendingFormItems.size(); ++i) {
+            if (QWidget *w = m_pendingFormItems.at(i).widget)
+                hbox->addWidget(w);
+            else if (QLayout *l = m_pendingFormItems.at(i).layout)
+                hbox->addItem(l);
+            else
+                QTC_CHECK(false);
         }
+        while (m_pendingFormItems.size() >= 2)
+            m_pendingFormItems.takeLast();
+        m_pendingFormItems.append(LayoutItem(hbox));
+    }
 
-        if (m_pendingItems.size() == 1) { // One one item given, so this spans both columns.
-            if (auto layout = m_pendingItems.at(0).layout)
-                fl->addRow(layout);
-            else if (auto widget = m_pendingItems.at(0).widget)
-                fl->addRow(widget);
-        } else if (m_pendingItems.size() == 2) { // Normal case, both columns used.
-            if (auto label = m_pendingItems.at(0).widget) {
-                if (auto layout = m_pendingItems.at(1).layout)
-                    fl->addRow(label, layout);
-                else if (auto widget = m_pendingItems.at(1).widget)
-                    fl->addRow(label, widget);
-            } else  {
-                if (auto layout = m_pendingItems.at(1).layout)
-                    fl->addRow(m_pendingItems.at(0).text, layout);
-                else if (auto widget = m_pendingItems.at(1).widget)
-                    fl->addRow(m_pendingItems.at(0).text, widget);
-            }
-        } else {
-            QTC_CHECK(false);
+    if (m_pendingFormItems.size() == 1) { // One one item given, so this spans both columns.
+        if (auto layout = m_pendingFormItems.at(0).layout)
+            m_formLayout->addRow(layout);
+        else if (auto widget = m_pendingFormItems.at(0).widget)
+            m_formLayout->addRow(widget);
+    } else if (m_pendingFormItems.size() == 2) { // Normal case, both columns used.
+        if (auto label = m_pendingFormItems.at(0).widget) {
+            if (auto layout = m_pendingFormItems.at(1).layout)
+                m_formLayout->addRow(label, layout);
+            else if (auto widget = m_pendingFormItems.at(1).widget)
+                m_formLayout->addRow(label, widget);
+        } else  {
+            if (auto layout = m_pendingFormItems.at(1).layout)
+                m_formLayout->addRow(m_pendingFormItems.at(0).text, layout);
+            else if (auto widget = m_pendingFormItems.at(1).widget)
+                m_formLayout->addRow(m_pendingFormItems.at(0).text, widget);
         }
     } else {
         QTC_CHECK(false);
     }
 
-    m_pendingItems.clear();
+    m_pendingFormItems.clear();
 }
 
 QLayout *LayoutBuilder::layout() const
 {
-    return m_layout;
+    if (m_formLayout)
+        return m_formLayout;
+    return m_gridLayout;
 }
 
 LayoutBuilder &LayoutBuilder::addItem(LayoutItem item)
 {
+    if (item.widget && !item.widget->parent())
+        item.widget->setParent(layout()->parentWidget());
+
     if (item.aspect) {
         item.aspect->addToLayout(*this);
     } else {
-        if (item.widget && !item.widget->parent())
-            item.widget->setParent(m_layout->parentWidget());
-        m_pendingItems.append(item);
+        if (m_gridLayout) {
+            if (auto widget = item.widget)
+                m_gridLayout->addWidget(widget, m_currentGridRow, m_currentGridColumn, 1, item.span, item.align);
+            m_currentGridColumn += item.span;
+        } else {
+            m_pendingFormItems.append(item);
+        }
     }
     return *this;
 }

src/plugins/projectexplorer/projectconfiguration.h

@@ -36,6 +36,11 @@
 #include <QVariantMap>
 #include <QWidget>
 
+QT_BEGIN_NAMESPACE
+class QFormLayout;
+class QGridLayout;
+QT_END_NAMESPACE
+
 namespace ProjectExplorer {
 
 class Kit;
@@ -47,14 +52,18 @@ class Target;
 class PROJECTEXPLORER_EXPORT LayoutBuilder
 {
 public:
-    explicit LayoutBuilder(QWidget *parent);
+    enum LayoutType { GridLayout, FormLayout };
+    explicit LayoutBuilder(QWidget *parent, LayoutType layoutType = FormLayout);
+    explicit LayoutBuilder(QLayout *layout); // Adds to existing layout.
+
     ~LayoutBuilder();
 
     class LayoutItem
     {
     public:
-        LayoutItem(QLayout *layout) : layout(layout) {}
-        LayoutItem(QWidget *widget) : widget(widget) {}
+        LayoutItem(QLayout *layout, int span = 1) : layout(layout), span(span) {}
+        LayoutItem(QWidget *widget, int span = 1, Qt::Alignment align = {})
+            : widget(widget), span(span), align(align) {}
         LayoutItem(ProjectConfigurationAspect *aspect) : aspect(aspect) {}
         LayoutItem(const QString &text) : text(text) {}
 
@@ -62,6 +71,8 @@ public:
         QWidget *widget = nullptr;
         ProjectConfigurationAspect *aspect = nullptr;
         QString text;
+        int span = 1;
+        Qt::Alignment align;
     };
 
     template<typename ...Items>
@@ -77,10 +88,13 @@ public:
     QLayout *layout() const;
 
 private:
-    void flushPendingItems();
+    void flushPendingFormItems();
 
-    QLayout *m_layout = nullptr;
-    QList<LayoutItem> m_pendingItems;
+    QFormLayout *m_formLayout = nullptr;
+    QGridLayout *m_gridLayout = nullptr;
+    QList<LayoutItem> m_pendingFormItems;
+    int m_currentGridRow = 0;
+    int m_currentGridColumn = 0;
 };
 
 class PROJECTEXPLORER_EXPORT ProjectConfigurationAspect : public QObject