Make setRoleNames() protected and improve docs.

(cherry picked from commit 15be8a6b259a5cb4f528b1c765bfcddfc9edd044)

Authored-by: Martin Jones
Reviewed-by: mbm

3 files changed, 50 insertions, 1 deletions

diff --git a/src/corelib/kernel/qabstractitemmodel.cpp b/src/corelib/kernel/qabstractitemmodel.cpp
index 3d9263e..cd17076 100644
--- a/src/corelib/kernel/qabstractitemmodel.cpp
+++ b/src/corelib/kernel/qabstractitemmodel.cpp
@@ -467,6 +467,21 @@ QAbstractItemModel *QAbstractItemModelPrivate::staticEmptyModel()
     return qEmptyModel();
 }
 
+const QHash<int,QByteArray> &QAbstractItemModelPrivate::defaultRoleNames()
+{
+    static QHash<int,QByteArray> roleNames;
+    if (roleNames.isEmpty()) {
+        roleNames[Qt::DisplayRole] = "display";
+        roleNames[Qt::DecorationRole] = "decoration";
+        roleNames[Qt::EditRole] = "edit";
+        roleNames[Qt::ToolTipRole] = "toolTip";
+        roleNames[Qt::StatusTipRole] = "statusTip";
+        roleNames[Qt::WhatsThisRole] = "whatsThis";
+    }
+
+    return roleNames;
+}
+
 /*!
     \internal
     return true if \a value contains a numerical type
@@ -1863,6 +1878,33 @@ QSize QAbstractItemModel::span(const QModelIndex &) const
 }
 
 /*!
+  Sets the model's role names to \a roleNames.
+
+  This function is provided to allow mapping of role identifiers to
+  role property names in Declarative UI.  This function must be called
+  before the model is used.  Modifying the role names after the model
+  has been set may result in undefined behaviour.
+
+  \sa roleNames()
+*/
+void QAbstractItemModel::setRoleNames(const QHash<int,QByteArray> &roleNames)
+{
+    Q_D(QAbstractItemModel);
+    d->roleNames = roleNames;
+}
+
+/*!
+  Returns the model's role names.
+
+  \sa setRoleNames
+*/
+const QHash<int,QByteArray> &QAbstractItemModel::roleNames() const
+{
+    Q_D(const QAbstractItemModel);
+    return d->roleNames;
+}
+
+/*!
   Called to let the model know that it should submit whatever it has cached
   to the permanent storage. Typically used for row editing.
 
diff --git a/src/corelib/kernel/qabstractitemmodel.h b/src/corelib/kernel/qabstractitemmodel.h
index dc7d7bd..a6bbff4 100644
--- a/src/corelib/kernel/qabstractitemmodel.h
+++ b/src/corelib/kernel/qabstractitemmodel.h
@@ -220,6 +220,8 @@ public:
                                   Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const;
     virtual QSize span(const QModelIndex &index) const;
 
+    const QHash<int,QByteArray> &roleNames() const;
+
 #ifdef Q_NO_USING_KEYWORD
     inline QObject *parent() const { return QObject::parent(); }
 #else
@@ -282,6 +284,8 @@ protected:
     void changePersistentIndexList(const QModelIndexList &from, const QModelIndexList &to);
     QModelIndexList persistentIndexList() const;
 
+    void setRoleNames(const QHash<int,QByteArray> &roleNames);
+
 private:
     Q_DECLARE_PRIVATE(QAbstractItemModel)
     Q_DISABLE_COPY(QAbstractItemModel)
diff --git a/src/corelib/kernel/qabstractitemmodel_p.h b/src/corelib/kernel/qabstractitemmodel_p.h
index c047f95..6a29723 100644
--- a/src/corelib/kernel/qabstractitemmodel_p.h
+++ b/src/corelib/kernel/qabstractitemmodel_p.h
@@ -78,7 +78,7 @@ class Q_CORE_EXPORT QAbstractItemModelPrivate : public QObjectPrivate
     Q_DECLARE_PUBLIC(QAbstractItemModel)
 
 public:
-    QAbstractItemModelPrivate() : QObjectPrivate(), supportedDragActions(-1) {}
+    QAbstractItemModelPrivate() : QObjectPrivate(), supportedDragActions(-1), roleNames(defaultRoleNames()) {}
     void removePersistentIndexData(QPersistentModelIndexData *data);
     void rowsAboutToBeInserted(const QModelIndex &parent, int first, int last);
     void rowsInserted(const QModelIndex &parent, int first, int last);
@@ -144,6 +144,9 @@ public:
     } persistent;
 
     Qt::DropActions supportedDragActions;
+
+    QHash<int,QByteArray> roleNames;
+    static const QHash<int,QByteArray> &defaultRoleNames();
 };
 
 QT_END_NAMESPACE