[libcalamaresui] Factor out "simple" QML method calls

src/libcalamaresui/CMakeLists.txt

@@ -16,6 +16,7 @@ set( calamaresui_SOURCES
     utils/CalamaresUtilsGui.cpp
     utils/ImageRegistry.cpp
     utils/Paste.cpp
+    utils/Qml.cpp
 
     viewpages/BlankViewStep.cpp
     viewpages/ExecutionViewStep.cpp

src/libcalamaresui/utils/Qml.cpp

@@ -0,0 +1,52 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2020, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "Qml.h"
+
+#include "utils/Logger.h"
+
+#include <QByteArray>
+#include <QObject>
+#include <QQuickItem>
+#include <QVariant>
+
+namespace CalamaresUtils
+{
+
+void
+callQMLFunction( QQuickItem* qmlObject, const char* method )
+{
+    QByteArray methodSignature( method );
+    methodSignature.append( "()" );
+
+    if ( qmlObject && qmlObject->metaObject()->indexOfMethod( methodSignature ) >= 0 )
+    {
+        QVariant returnValue;
+        QMetaObject::invokeMethod( qmlObject, method, Q_RETURN_ARG( QVariant, returnValue ) );
+        if ( !returnValue.isNull() )
+        {
+            cDebug() << "QML" << methodSignature << "returned" << returnValue;
+        }
+    }
+    else if ( qmlObject )
+    {
+        cDebug() << "QML" << methodSignature << "is missing.";
+    }
+}
+
+}  // namespace CalamaresUtils

src/libcalamaresui/utils/Qml.h

@@ -0,0 +1,42 @@
+/* === This file is part of Calamares - <https://github.com/calamares> ===
+ *
+ *   Copyright 2020, Adriaan de Groot <groot@kde.org>
+ *
+ *   Calamares is free software: you can redistribute it and/or modify
+ *   it under the terms of the GNU General Public License as published by
+ *   the Free Software Foundation, either version 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   Calamares is distributed in the hope that it will be useful,
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ *   GNU General Public License for more details.
+ *
+ *   You should have received a copy of the GNU General Public License
+ *   along with Calamares. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef UTILS_QML_H
+#define UTILS_QML_H
+
+#include "DllMacro.h"
+
+class QQuickItem;
+
+namespace CalamaresUtils
+{
+
+/** @brief Calls the QML method @p method on @p qmlObject
+ *
+ * Pass in only the name of the method (e.g. onActivate). This function
+ * checks if the method exists (with no arguments) before trying to
+ * call it, so that no warnings are printed due to missing methods.
+ *
+ * If there is a return value from the QML method, it is logged (but not otherwise used).
+ */
+DLLEXPORT void
+callQMLFunction( QQuickItem* qmlObject, const char* method );
+
+}  // namespace CalamaresUtils
+
+#endif

src/libcalamaresui/viewpages/ExecutionViewStep.cpp

@@ -31,6 +31,7 @@
 #include "utils/CalamaresUtilsGui.h"
 #include "utils/Dirs.h"
 #include "utils/Logger.h"
+#include "utils/Qml.h"
 #include "utils/Retranslator.h"
 
 #include <QDir>
@@ -42,35 +43,6 @@
 #include <QQuickWidget>
 #include <QVBoxLayout>
 
-/** @brief Calls the QML method @p method()
- *
- * Pass in only the name of the method (e.g. onActivate). This function
- * checks if the method exists (with no arguments) before trying to
- * call it, so that no warnings are printed due to missing methods.
- *
- * If there is a return value from the QML method, it is logged (but not otherwise used).
- */
-static void
-callQMLFunction( QQuickItem* qmlObject, const char* method )
-{
-    QByteArray methodSignature( method );
-    methodSignature.append( "()" );
-
-    if ( qmlObject && qmlObject->metaObject()->indexOfMethod( methodSignature ) >= 0 )
-    {
-        QVariant returnValue;
-        QMetaObject::invokeMethod( qmlObject, method, Q_RETURN_ARG( QVariant, returnValue ) );
-        if ( !returnValue.isNull() )
-        {
-            cDebug() << "QML" << methodSignature << "returned" << returnValue;
-        }
-    }
-    else if ( qmlObject )
-    {
-        cDebug() << "QML" << methodSignature << "is missing.";
-    }
-}
-
 namespace Calamares
 {
 
@@ -205,7 +177,7 @@ changeSlideShowState( Slideshow state, QQuickItem* slideshow, QQuickWidget* widg
     if ( Branding::instance()->slideshowAPI() == 2 )
     {
         // The QML was already loaded in the constructor, need to start it
-        callQMLFunction( slideshow, activate ? "onActivate" : "onLeave" );
+        CalamaresUtils::callQMLFunction( slideshow, activate ? "onActivate" : "onLeave" );
     }
     else if ( !Calamares::Branding::instance()->slideshowPath().isEmpty() )
     {