Metatype QgsHistoryEntry

nyalldawson · nyalldawson · commit d5cd4c99fc76 · 2023-04-22T20:55:59.000+10:00
diff --git a/python/gui/auto_generated/history/qgshistoryproviderregistry.sip.in b/python/gui/auto_generated/history/qgshistoryproviderregistry.sip.in
@@ -23,6 +23,11 @@ Encapsulates a history entry.
 %End
   public:
 
+    QgsHistoryEntry();
+%Docstring
+Constructor for an invalid entry.
+%End
+
     QgsHistoryEntry( const QString &providerId, const QDateTime &timestamp, const QVariantMap &entry );
 %Docstring
 Constructor for QgsHistoryEntry ``entry``, with the specified ``providerId`` and ``timestamp``.
@@ -33,6 +38,13 @@ Constructor for QgsHistoryEntry ``entry``, with the specified ``providerId`` and
 Constructor for QgsHistoryEntry ``entry``.
 
 The entry timestamp will be automatically set to the current date/time.
+%End
+
+    bool isValid() const;
+%Docstring
+Returns ``True`` if the entry is valid.
+
+.. versionadded:: 3.32
 %End
 
     QDateTime timestamp;
@@ -49,6 +61,7 @@ The entry timestamp will be automatically set to the current date/time.
 
 };
 
+
 class QgsHistoryProviderRegistry : QObject
 {
 %Docstring(signature="appended")
diff --git a/src/gui/history/qgshistoryproviderregistry.cpp b/src/gui/history/qgshistoryproviderregistry.cpp
@@ -44,6 +44,11 @@ QgsHistoryEntry::QgsHistoryEntry( const QVariantMap &entry )
 
 }
 
+bool QgsHistoryEntry::isValid() const
+{
+  return !providerId.isEmpty();
+}
+
 //
 // QgsHistoryProviderRegistry
 //
diff --git a/src/gui/history/qgshistoryproviderregistry.h b/src/gui/history/qgshistoryproviderregistry.h
@@ -41,6 +41,11 @@ class GUI_EXPORT QgsHistoryEntry
 {
   public:
 
+    /**
+     * Constructor for an invalid entry.
+     */
+    QgsHistoryEntry() = default;
+
     /**
      * Constructor for QgsHistoryEntry \a entry, with the specified \a providerId and \a timestamp.
      */
@@ -53,6 +58,13 @@ class GUI_EXPORT QgsHistoryEntry
      */
     QgsHistoryEntry( const QVariantMap &entry );
 
+    /**
+     * Returns TRUE if the entry is valid.
+     *
+     * \since QGIS 3.32
+     */
+    bool isValid() const;
+
     //! Entry timestamp
     QDateTime timestamp;
 
@@ -77,6 +89,8 @@ class GUI_EXPORT QgsHistoryEntry
 
 };
 
+Q_DECLARE_METATYPE( QgsHistoryEntry );
+
 /**
  * The QgsHistoryProviderRegistry is a registry for objects which track user history (i.e. operations performed through the GUI).
  *
diff --git a/src/gui/qgsgui.cpp b/src/gui/qgsgui.cpp
@@ -325,6 +325,8 @@ QgsGui::QgsGui()
   mWidgetStateHelper = new QgsWidgetStateHelper();
   mProcessingRecentAlgorithmLog = new QgsProcessingRecentAlgorithmLog();
   mProcessingGuiRegistry = new QgsProcessingGuiRegistry();
+
+  qRegisterMetaType< QgsHistoryEntry >( "QgsHistoryEntry" );
 }
 
 bool QgsGui::pythonMacroAllowed( void ( *lambda )(), QgsMessageBar *messageBar )

Original file line number	Diff line number	Diff line change
`@@ -325,6 +325,8 @@ QgsGui::QgsGui()`
`325`	`325`	`mWidgetStateHelper = new QgsWidgetStateHelper();`
`326`	`326`	`mProcessingRecentAlgorithmLog = new QgsProcessingRecentAlgorithmLog();`
`327`	`327`	`mProcessingGuiRegistry = new QgsProcessingGuiRegistry();`
	`328`	`+`
	`329`	`+ qRegisterMetaType< QgsHistoryEntry >( "QgsHistoryEntry" );`
`328`	`330`	`}`
`329`	`331`
`330`	`332`	`bool QgsGui::pythonMacroAllowed( void ( lambda )(), QgsMessageBar messageBar )`