Make API a little more flexible

qgis · Apr 22, 2023 · f3f0946 · f3f0946
1 parent 9ee0453
commit f3f0946
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 15 deletions.
diff --git a/python/gui/auto_generated/history/qgshistoryprovider.sip.in b/python/gui/auto_generated/history/qgshistoryprovider.sip.in
@@ -8,7 +8,6 @@
 
 
 
-
 class QgsAbstractHistoryProvider
 {
 %Docstring(signature="appended")
@@ -38,14 +37,14 @@ Abstract base class for objects which track user history (i.e. operations perfor
 Returns the provider's unique id, which is used to associate existing history entries with the provider.
 %End
 
-    virtual QgsHistoryEntryNode *createNodeForEntry( const QVariantMap &entry ) /Factory/;
+    virtual QgsHistoryEntryNode *createNodeForEntry( const QgsHistoryEntry &entry ) /Factory/;
 %Docstring
 Creates a new history node for the given ``entry``.
 
 .. versionadded:: 3.32
 %End
 
-    virtual void updateNodeForEntry( QgsHistoryEntryNode *node, const QVariantMap &entry );
+    virtual void updateNodeForEntry( QgsHistoryEntryNode *node, const QgsHistoryEntry &entry );
 %Docstring
 Updates an existing history ``node`` for the given ``entry``.
 

diff --git a/src/gui/history/qgshistoryentrymodel.cpp b/src/gui/history/qgshistoryentrymodel.cpp
@@ -219,14 +219,16 @@ void QgsHistoryEntryModel::entryUpdated( long long id, const QVariantMap &entry,
   if ( QgsHistoryEntryNode *node = mIdToNodeHash.value( id ) )
   {
     bool ok = false;
-    const QString providerId = mRegistry->entry( id, ok, backend ).providerId;
+    QgsHistoryEntry historyEntry = mRegistry->entry( id, ok, backend );
+    historyEntry.entry = entry;
+    const QString providerId = historyEntry.providerId;
     QgsAbstractHistoryProvider *provider = mRegistry->providerById( providerId );
     if ( !provider )
       return;
 
     const QModelIndex nodeIndex = node2index( node );
     const int existingChildRows = node->childCount();
-    provider->updateNodeForEntry( node, entry );
+    provider->updateNodeForEntry( node, historyEntry );
     const int newChildRows = node->childCount();
 
     if ( newChildRows < existingChildRows )

diff --git a/src/gui/history/qgshistoryprovider.cpp b/src/gui/history/qgshistoryprovider.cpp
@@ -18,12 +18,12 @@
 
 QgsAbstractHistoryProvider::~QgsAbstractHistoryProvider() = default;
 
-QgsHistoryEntryNode *QgsAbstractHistoryProvider::createNodeForEntry( const QVariantMap & )
+QgsHistoryEntryNode *QgsAbstractHistoryProvider::createNodeForEntry( const QgsHistoryEntry & )
 {
   return nullptr;
 }
 
-void QgsAbstractHistoryProvider::updateNodeForEntry( QgsHistoryEntryNode *, const QVariantMap & )
+void QgsAbstractHistoryProvider::updateNodeForEntry( QgsHistoryEntryNode *, const QgsHistoryEntry & )
 {
 
 }
diff --git a/src/gui/history/qgshistoryprovider.h b/src/gui/history/qgshistoryprovider.h
@@ -22,7 +22,7 @@
 #include <QVariantMap>
 
 class QgsHistoryEntryNode;
-
+class QgsHistoryEntry;
 
 /**
  * Abstract base class for objects which track user history (i.e. operations performed through the GUI).
@@ -57,14 +57,14 @@ class GUI_EXPORT QgsAbstractHistoryProvider
      *
      * \since QGIS 3.32
      */
-    virtual QgsHistoryEntryNode *createNodeForEntry( const QVariantMap &entry ) SIP_FACTORY;
+    virtual QgsHistoryEntryNode *createNodeForEntry( const QgsHistoryEntry &entry ) SIP_FACTORY;
 
     /**
      * Updates an existing history \a node for the given \a entry.
      *
      * \since QGIS 3.32
      */
-    virtual void updateNodeForEntry( QgsHistoryEntryNode *node, const QVariantMap &entry );
+    virtual void updateNodeForEntry( QgsHistoryEntryNode *node, const QgsHistoryEntry &entry );
 
 };
 

diff --git a/tests/src/python/test_qgshistoryproviderregistry.py b/tests/src/python/test_qgshistoryproviderregistry.py
@@ -36,12 +36,12 @@
 
 class TestEntryNode(QgsHistoryEntryGroup):
 
-    def __init__(self, entry):
+    def __init__(self, val):
         super().__init__()
-        self.entry = entry
+        self.val = val
 
     def data(self, role):
-        return self.entry
+        return self.val
 
 
 class TestHistoryProvider(QgsAbstractHistoryProvider):
@@ -50,10 +50,10 @@ def id(self) -> str:
         return 'test_provider'
 
     def createNodeForEntry(self, entry):
-        return TestEntryNode(entry)
+        return TestEntryNode(entry.entry)
 
     def updateNodeForEntry(self, node, entry):
-        node.entry = entry
+        node.val = entry.entry
 
         new_child_node = TestEntryNode('my child')
         node.addChild(new_child_node)