Initial upload of HyprArch releng configuration

airootfs/usr/include/libcalamares/viewpages/QmlViewStep.h

@@ -0,0 +1,127 @@
+/* === This file is part of Calamares - <https://calamares.io> ===
+ *
+ *   SPDX-FileCopyrightText: 2020 Adriaan de Groot <groot@kde.org>
+ *   SPDX-License-Identifier: GPL-3.0-or-later
+ *
+ *   Calamares is Free Software: see the License-Identifier above.
+ *
+ */
+
+#ifndef QMLVIEWSTEP_H
+#define QMLVIEWSTEP_H
+
+#include "DllMacro.h"
+#include "utils/Qml.h"
+#include "viewpages/ViewStep.h"
+
+class QQmlComponent;
+class QQmlEngine;
+class QQuickItem;
+class QQuickWidget;
+class WaitingWidget;
+
+namespace Calamares
+{
+
+/** @brief A viewstep that uses QML for the UI
+ *
+ * This is generally a **base** class for other view steps, but
+ * it can be used stand-alone for viewsteps that don't really have
+ * any functionality.
+ *
+ * Most subclasses will override the following methods:
+ * - prettyName() to provide a meaningful human-readable name
+ * - jobs() if there is real work to be done during installation
+ * - getConfig() to return a meaningful configuration object
+ *
+ * For details on the interaction between the config object and
+ * the QML in the module, see the module documentation:
+ *      src/modules/README.md
+ */
+class UIDLLEXPORT QmlViewStep : public Calamares::ViewStep
+{
+    Q_OBJECT
+public:
+    /** @brief Creates a QML view step
+     *
+     * The search behavior for the actial QML depends on a QmlSearch value.
+     * This is set through common configuration key *qmlSearch*.
+     * The filename used comes from the module identifier, or can be
+     * set in the configuration file through *qmlFilename*.
+     *
+     * @see Qml.h for available Calamares internals.
+     */
+    QmlViewStep( QObject* parent = nullptr );
+    ~QmlViewStep() override;
+
+    virtual QString prettyName() const override;
+
+    virtual QWidget* widget() override;
+    virtual QSize widgetMargins( Qt::Orientations panelSides ) override;
+
+    virtual bool isNextEnabled() const override;
+    virtual bool isBackEnabled() const override;
+
+    virtual bool isAtBeginning() const override;
+    virtual bool isAtEnd() const override;
+
+    virtual void onActivate() override;
+    virtual void onLeave() override;
+
+    /// @brief QML widgets don't produce jobs by default
+    virtual JobList jobs() const override;
+
+    /// @brief Configure search paths; subclasses should call this at the **end** of their own implementation
+    virtual void setConfigurationMap( const QVariantMap& configurationMap ) override;
+
+protected:
+    /** @brief Gets a pointer to the Config of this view step
+     *
+     * Parts of the configuration of the viewstep can be passed to QML
+     * by placing them in a QObject (as properties). The default
+     * implementation returns nullptr, for no-config.
+     *
+     * Ownership of the config object remains with the ViewStep; it is possible
+     * to return a pointer to a member variable.
+     *
+     * This object is made available as a context-property *config* in QML.
+     */
+    virtual QObject* getConfig();
+
+    /** @brief Adds a context property for this QML file
+     *
+     * Does not take ownership.
+     */
+    void setContextProperty( const char* name, QObject* property );
+
+private Q_SLOTS:
+    void loadComplete();
+
+private:
+    /// @brief Swap out the spinner for the QQuickWidget
+    void showQml();
+    /// @brief Show error message in spinner.
+    void showFailedQml();
+
+    /// @brief Controls where m_name is searched
+    Calamares::QmlSearch m_searchMethod;
+
+    QString m_name;
+    QString m_qmlFileName;
+
+    QWidget* m_widget = nullptr;
+    WaitingWidget* m_spinner = nullptr;
+
+#if QT_VERSION < QT_VERSION_CHECK( 6, 0, 0 )
+    QQuickWidget* m_qmlWidget = nullptr;
+#else
+    QWidget* m_qmlWidget = nullptr;  // Qt6: container for QQuickWindow
+#endif
+
+    QQmlEngine* m_qmlEngine = nullptr;  // Qt5: points to QuickWidget engine, Qt6: separate engine
+    QQmlComponent* m_qmlComponent = nullptr;
+    QQuickItem* m_qmlObject = nullptr;
+};
+
+}  // namespace Calamares
+#endif