Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
AppearanceStore.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
5#include <PhosphorTheme/phosphortheme_export.h>
6#include <QObject>
7#include <QVariantMap>
8#include <QUrl>
9#include <QtQmlIntegration/qqmlintegration.h>
10#include <memory>
11
12class QQmlEngine;
13class QJSEngine;
14class QLockFile;
15
16namespace PhosphorTheme {
17class PHOSPHORTHEME_EXPORT AppearanceStore : public QObject
18{
19 Q_OBJECT
20 QML_ELEMENT
21 QML_SINGLETON
22 Q_PROPERTY(QVariantMap values READ values NOTIFY changed)
23 Q_PROPERTY(QString error READ error NOTIFY errorChanged)
24 Q_PROPERTY(QString currentPreset READ currentPreset NOTIFY changed)
25 Q_PROPERTY(QVariantMap palette READ palette NOTIFY changed)
26 Q_PROPERTY(bool editing READ editing NOTIFY changed)
27 Q_PROPERTY(bool dirty READ dirty NOTIFY changed)
28public:
29 // An empty path keeps the settings in memory: nothing is read or written.
30 explicit AppearanceStore(const QString& path, QObject* parent = nullptr);
31 ~AppearanceStore() override;
32 QVariantMap values() const
33 {
34 return m_values;
35 }
36 QString error() const
37 {
38 return m_error;
39 }
40 // The file the process-wide instance create() returns reads and writes,
41 // such as `<config>/<app>/appearance.json`. Set it once at startup,
42 // before the first create() (and so before QML loads). Empty, the
43 // default, keeps that instance's settings in memory only.
44 static void setSingletonPath(const QString& path);
45 static QString singletonPath();
46 // Process-owned: a geometry reload must not destroy a live preview.
47 static AppearanceStore* create(QQmlEngine* engine, QJSEngine* scriptEngine);
48 static QVariantMap defaults();
49 static bool validate(const QVariantMap& values, QVariantMap& result);
50 // Cross-process decoration readers use a draft only while its producer
51 // holds the preview lock. A crashed editor cannot leave a saved-looking draft.
52 static QVariantMap effectiveValues(const QString& path, bool* previewActive = nullptr);
53 bool editing() const
54 {
55 return m_editing;
56 }
57 bool dirty() const
58 {
59 return m_editing && m_values != m_saved;
60 }
61 Q_INVOKABLE bool beginPreview();
62 Q_INVOKABLE bool applyPreview();
63 Q_INVOKABLE void revertPreview();
64 Q_INVOKABLE void endPreview();
65 Q_INVOKABLE bool setValues(const QVariantMap& values);
66 Q_INVOKABLE bool setWallpaper(const QString& path, const QString& screen, const QString& fit);
67
68 QString currentPreset() const;
69 QVariantMap palette() const;
70 Q_INVOKABLE QVariantMap paletteFor(const QVariantMap& settings) const;
71 Q_INVOKABLE bool setValue(const QString& key, const QVariant& value);
72 Q_INVOKABLE bool setLibraryPalette(const QString& name, const QVariantMap& tokens);
73 bool setColorMode(const QString& mode, bool systemDark);
74 bool updateSystemColorScheme(bool dark);
75 Q_INVOKABLE bool moveWidget(const QString& id, const QString& region, int index = -1);
76 Q_INVOKABLE bool resetBarLayout();
77 Q_INVOKABLE bool applyPreset(const QString& preset);
78 Q_INVOKABLE bool importPreset(const QUrl& file);
79 Q_INVOKABLE bool exportPreset(const QUrl& file);
80Q_SIGNALS:
81 void changed();
84
85private:
86 explicit AppearanceStore(QObject* parent = nullptr);
87 static QVariantMap presetValues(const QString& preset);
88 bool write(const QVariantMap& values);
89 bool writeDocument(const QString& path, const QVariantMap& values);
90 void publish(const QVariantMap& values);
91 bool commit(const QVariantMap& values);
92 bool fail(const QString& error);
93 QString m_path;
94 QString m_error;
95 QVariantMap m_values;
96 QVariantMap m_saved;
97 bool m_editing = false;
98 std::unique_ptr<QLockFile> m_previewLock;
99};
100}
QVariantMap paletteFor(const QVariantMap &settings) const
bool moveWidget(const QString &id, const QString &region, int index=-1)
bool setValues(const QVariantMap &values)
bool exportPreset(const QUrl &file)
bool applyPreset(const QString &preset)
static AppearanceStore * create(QQmlEngine *engine, QJSEngine *scriptEngine)
QString error() const
Definition AppearanceStore.h:36
static void setSingletonPath(const QString &path)
bool setColorMode(const QString &mode, bool systemDark)
static bool validate(const QVariantMap &values, QVariantMap &result)
static QVariantMap effectiveValues(const QString &path, bool *previewActive=nullptr)
static QString singletonPath()
bool setWallpaper(const QString &path, const QString &screen, const QString &fit)
bool importPreset(const QUrl &file)
static QVariantMap defaults()
bool dirty() const
Definition AppearanceStore.h:57
QVariantMap palette() const
bool setValue(const QString &key, const QVariant &value)
QVariantMap values() const
Definition AppearanceStore.h:32
bool updateSystemColorScheme(bool dark)
bool setLibraryPalette(const QString &name, const QVariantMap &tokens)
AppearanceStore(const QString &path, QObject *parent=nullptr)
bool editing() const
Definition AppearanceStore.h:53
Definition AppearanceLibrary.h:10