quickshell/src/cpp/qmlglobal.hpp

#pragma once

#include <qcontainerfwd.h>
#include <qobject.h>
#include <qqmlintegration.h>
#include <qqmllist.h>
#include <qtmetamacros.h>
#include <qtypes.h>

#include "qmlscreen.hpp"

class QuickShellGlobal: public QObject {
	Q_OBJECT;
	/// All currently connected screens.
	///
	/// This property updates as connected screens change.
	///
	/// #### Reusing a window on every screen
	/// ```qml
	/// ShellRoot {
	///   Variants {
	///     ProxyShellWindow {
	///       // ...
	///     }
	///
	///     // see Variants for details
	///     variants: QuickShell.screens.map(screen => ({ screen }))
	///   }
	/// }
	/// ```
	///
	/// This creates an instance of your window once on every screen.
	/// As screens are added or removed your window will be created or destroyed on those screens.
	Q_PROPERTY(QQmlListProperty<QuickShellScreenInfo> screens READ screens NOTIFY screensChanged);
	QML_SINGLETON;
	QML_NAMED_ELEMENT(QuickShell);

public:
	QuickShellGlobal(QObject* parent = nullptr);

	QQmlListProperty<QuickShellScreenInfo> screens();

	/// Reload the shell from the [ShellRoot].
	///
	/// `hard` - perform a hard reload. If this is false, QuickShell will attempt to reuse windows
	/// that already exist. If true windows will be recreated.
	///
	/// > [!INFO] QuickShell can only reuse windows that are in a hierarchy of elements known
	/// > internally as `Scavengeable`. These types are [ShellRoot] and [Variants].
	/// >
	/// > ```qml
	/// > // this will reuse the window on reload
	/// > ShellRoot {
	/// >   Varaints {
	/// >     ProxyShellWindow {
	/// >       // ...
	/// >     }
	/// >
	/// >     // ...
	/// >   }
	/// > }
	/// >
	/// > // this will NOT reuse the window on reload,
	/// > // and will destroy the old one / create a new one every time
	/// > ShellRoot {
	/// >   AnyNonScavengeableType {
	/// >     ProxyShellWindow {
	/// >       // ...
	/// >     }
	/// >
	/// >     // ...
	/// >   }
	/// > }
	/// > ```
	/// >
	/// > [ShellRoot]: ../shellroot
	/// > [Variants]: ../variants
	Q_INVOKABLE void reload(bool hard);

signals:
	void screensChanged();

public slots:
	void updateScreens();

private:
	static qsizetype screensCount(QQmlListProperty<QuickShellScreenInfo>* prop);
	static QuickShellScreenInfo* screenAt(QQmlListProperty<QuickShellScreenInfo>* prop, qsizetype i);

	QVector<QuickShellScreenInfo*> mScreens;
};