Polish the Qt Designer custom widget wizard

Start editing the class name when wizard page
is initialized. Show a disabled widget page
for the dummy widget item (least surprise).
Add +/- buttons. Refuse invalid class names
(by introducing an item model with setData()
validation. Code polishing, explicitness, etc.
Task-number: QTCREATORBUG-1123

src/plugins/qt4projectmanager/customwidgetwizard/classlist.cpp

@@ -29,59 +29,146 @@
 
 #include "classlist.h"
 
+#include <utils/qtcassert.h>
+
 #include <QtGui/QKeyEvent>
 #include <QtGui/QMessageBox>
+#include <QtGui/QStandardItemModel>
+#include <QtGui/QStandardItem>
+#include <QtGui/QLabel>
+#include <QtGui/QToolButton>
+
+#include <QtCore/QDebug>
+#include <QtCore/QRegExp>
 
 namespace Qt4ProjectManager {
 namespace Internal {
 
-ClassList::ClassList(QWidget *parent) :
-    QListWidget(parent)
+// ClassModel: Validates the class name in setData() and
+// refuses placeholders and invalid characters.
+class ClassModel : public QStandardItemModel {
+public:
+    explicit ClassModel(QObject *parent = 0);
+    virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole);
+
+    void appendPlaceHolder() { appendClass(m_newClassPlaceHolder); }
+
+    QModelIndex placeHolderIndex() const;
+    QString newClassPlaceHolder() const { return m_newClassPlaceHolder; }
+
+private:
+    void appendClass(const QString &);
+
+    const QRegExp m_validator;
+    const QString m_newClassPlaceHolder;
+};
+
+ClassModel::ClassModel(QObject *parent) :
+    QStandardItemModel(0, 1, parent),
+    m_validator(QLatin1String("^[a-zA-Z][a-zA-Z0-9_]*$")),
+    m_newClassPlaceHolder(ClassList::tr("<New class>"))
 {
+    QTC_ASSERT(m_validator.isValid(), return)
+    appendPlaceHolder();
+}
+
+void ClassModel::appendClass(const QString &c)
+{
+    QStandardItem *item = new QStandardItem(c);
+    item->setFlags(Qt::ItemIsEnabled|Qt::ItemIsEditable);
+    appendRow(item);
+}
+
+bool ClassModel::setData(const QModelIndex &index, const QVariant &value, int role)
+{
+    if (role == Qt::EditRole && !m_validator.exactMatch(value.toString()))
+        return false;
+    return QStandardItemModel::setData(index, value, role);
+}
+
+QModelIndex ClassModel::placeHolderIndex() const
+{
+    return index(rowCount() - 1, 0);
+}
+
+// --------------- ClassList
+ClassList::ClassList(QWidget *parent) :
+    QListView(parent),
+    m_model(new ClassModel)
+{
+    setModel(m_model);
     connect(itemDelegate(), SIGNAL(closeEditor(QWidget *, QAbstractItemDelegate::EndEditHint)), SLOT(classEdited()));
-    insertNewItem();
+    connect(selectionModel(), SIGNAL(currentRowChanged(QModelIndex,QModelIndex)),
+            this, SLOT(slotCurrentRowChanged(QModelIndex,QModelIndex)));
+}
+
+void ClassList::startEditingNewClassItem()
+{
+    // Start editing the 'new class' item.
+    setFocus();
+
+    const QModelIndex index = m_model->placeHolderIndex();
+    setCurrentIndex(index);
+    edit(index);
+}
+
+QString ClassList::className(int row) const
+{
+    return m_model->item(row, 0)->text();
 }
 
 void ClassList::classEdited()
 {
-    if (currentRow() == count() - 1) {
-        if (currentItem()->text() != tr("<New class>")) {
-            emit classAdded(currentItem()->text());
-            insertNewItem();
+    const QModelIndex index = currentIndex();
+    QTC_ASSERT(index.isValid(), return)
+
+    const QString name = className(index.row());
+    if (index == m_model->placeHolderIndex()) {
+        // Real name class entered.
+        if (name != m_model->newClassPlaceHolder()) {
+            emit classAdded(name);
+            m_model->appendPlaceHolder();
         }
     } else {
-        emit classRenamed(currentRow(), currentItem()->text());
+        emit classRenamed(index.row(), name);
     }
 }
 
-void ClassList::insertNewItem()
+void ClassList::removeCurrentClass()
 {
-    QListWidgetItem *itm = new QListWidgetItem(tr("<New class>"), this);
-    itm->setFlags(Qt::ItemIsEnabled|Qt::ItemIsEditable);
+    const QModelIndex index = currentIndex();
+    if (!index.isValid() || index == m_model->placeHolderIndex())
+        return;
+    if (QMessageBox::question(this,
+                              tr("Confirm Delete"),
+                              tr("Delete class %1 from list?").arg(className(index.row())),
+                              QMessageBox::Ok|QMessageBox::Cancel) != QMessageBox::Ok)
+        return;
+    // Delete row and set current on same item.
+    m_model->removeRows(index.row(), 1);
+    emit classDeleted(index.row());
+    setCurrentIndex(m_model->indexFromItem(m_model->item(index.row(), 0)));
 }
 
 void ClassList::keyPressEvent(QKeyEvent *event)
 {
-    if (event->key() == Qt::Key_Delete) {
-        const int row = currentRow();
-        if (row != count() - 1) {
-            if (QMessageBox::question(this,
-                tr("Confirm Delete"),
-                tr("Delete class %1 from list?").arg(currentItem()->text()),
-                QMessageBox::Ok|QMessageBox::Cancel) == QMessageBox::Ok)
-            {
-                delete currentItem();
-                emit classDeleted(row);
-                setCurrentRow(row);
-            }
-        }
-    } else if (event->key() == Qt::Key_Insert) {
-        setCurrentRow(count() - 1);
-        editItem(currentItem());
-    } else {
-        QListWidget::keyPressEvent(event);
+    switch (event->key()) {
+    case Qt::Key_Delete:
+        removeCurrentClass();
+        break;
+    case Qt::Key_Insert:
+        startEditingNewClassItem();
+        break;
+    default:
+        QListView::keyPressEvent(event);
+        break;
     }
 }
 
+void ClassList::slotCurrentRowChanged(const QModelIndex &current, const QModelIndex &)
+{
+    emit currentRowChanged(current.row());
 }
-}
+
+} // namespace Internal
+} // namespace Qt4ProjectManager