Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
AppearanceLibrary.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3#pragma once
4#include <QObject>
5#include <QVariantMap>
6#include <QUrl>
7#include <QtQmlIntegration/qqmlintegration.h>
8class QQmlEngine;
9class QJSEngine;
10namespace PhosphorTheme {
11class AppearanceStore;
12}
14// The wallpaper catalog and portable look recipes. Selection/decoding happens
15// off the GUI thread; AppearanceStore owns the single Apply/Revert transaction.
16class AppearanceLibrary : public QObject
17{
18 Q_OBJECT
19 QML_ELEMENT
20 QML_SINGLETON
21 Q_PROPERTY(QVariantList wallpapers READ wallpapers NOTIFY wallpapersChanged)
22 Q_PROPERTY(QVariantList presets READ presets NOTIFY presetsChanged)
23 Q_PROPERTY(QVariantMap imported READ imported NOTIFY importedChanged)
24 Q_PROPERTY(QString error READ error NOTIFY errorChanged)
25 Q_PROPERTY(bool busy READ busy NOTIFY busyChanged)
26 Q_PROPERTY(QStringList fonts READ fonts CONSTANT)
27public:
28 // `directory` holds the library's own files: the bundled artwork, imported
29 // images and saved looks. Empty keeps none, so nothing can be saved.
30 AppearanceLibrary(PhosphorTheme::AppearanceStore* store, const QString& directory, QObject* parent = nullptr);
31 // The directory of the process-wide instance create() returns, such as
32 // `<data>/<app>/appearance`. Set it once at startup, before QML loads.
33 static void setSingletonDirectory(const QString& directory);
34 static QString singletonDirectory();
35 static AppearanceLibrary* create(QQmlEngine*, QJSEngine*);
36 QVariantList wallpapers() const
37 {
38 return m_wallpapers;
39 }
40 QVariantList presets() const;
41 QVariantMap imported() const
42 {
43 return m_imported;
44 }
45 QString error() const
46 {
47 return m_error;
48 }
49 bool busy() const
50 {
51 return m_busy;
52 }
53 QStringList fonts() const;
54 Q_INVOKABLE void rescan();
55 Q_INVOKABLE QVariantMap wallpaper(const QString& path) const;
56 Q_INVOKABLE void chooseWallpaper(const QString& path, const QString& screen, const QString& fit);
57 Q_INVOKABLE void importImages(const QList<QUrl>& urls);
58 Q_INVOKABLE void cancel();
59 Q_INVOKABLE bool savePreset(const QString& name, bool wallpaper, bool bar);
60 Q_INVOKABLE bool removePreset(const QString& id);
61 Q_INVOKABLE bool inspectImport(const QUrl& file);
62 Q_INVOKABLE bool previewPreset(const QString& id, bool wallpaper, bool bar);
63 Q_INVOKABLE bool saveImported(const QString& name);
64 Q_INVOKABLE bool exportPreset(const QString& id, const QUrl& file);
65 static QVariantMap inspectImage(const QString& path);
66Q_SIGNALS:
72
73private:
74 explicit AppearanceLibrary(QObject* parent = nullptr);
75 bool fail(const QString& error);
76 void setBusy(bool busy);
77 bool writePresets(const QVariantList& presets);
78 QVariantMap recipe(const QString& id) const;
79 static QVariantMap normalizeRecipe(const QVariantMap& value);
80 static QVariantMap scopedSettings(const QVariantMap& values, bool wallpaper, bool bar);
81 QString uniqueName(const QString& name) const;
82 void loadPresets();
84 QString m_directory;
85 QVariantList m_wallpapers;
86 QVariantList m_saved;
87 QVariantMap m_imported;
88 QString m_error;
89 bool m_busy = false;
90 quint64 m_generation = 0;
91};
92}
QVariantMap wallpaper(const QString &path) const
QVariantList wallpapers() const
Definition AppearanceLibrary.h:36
void importImages(const QList< QUrl > &urls)
AppearanceLibrary(PhosphorTheme::AppearanceStore *store, const QString &directory, QObject *parent=nullptr)
bool inspectImport(const QUrl &file)
bool busy() const
Definition AppearanceLibrary.h:49
bool exportPreset(const QString &id, const QUrl &file)
QVariantMap imported() const
Definition AppearanceLibrary.h:41
void chooseWallpaper(const QString &path, const QString &screen, const QString &fit)
bool removePreset(const QString &id)
bool saveImported(const QString &name)
static QVariantMap inspectImage(const QString &path)
bool savePreset(const QString &name, bool wallpaper, bool bar)
QString error() const
Definition AppearanceLibrary.h:45
bool previewPreset(const QString &id, bool wallpaper, bool bar)
static void setSingletonDirectory(const QString &directory)
static AppearanceLibrary * create(QQmlEngine *, QJSEngine *)
Definition AppearanceStore.h:18
Definition AppearanceLibrary.h:13
Definition AppearanceLibrary.h:10