Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
ScrollingTemplateStore.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
6#include "phosphorzones_export.h"
7
9
10#include <QHash>
11#include <QList>
12#include <QObject>
13#include <QString>
14#include <QUuid>
15
16namespace PhosphorZones {
17
37class PHOSPHORZONES_EXPORT ScrollingTemplateStore : public QObject
38{
39 Q_OBJECT
40
41public:
46 explicit ScrollingTemplateStore(QString templateSubdirectory, QObject* parent = nullptr);
47
51 QString templateSubdirectory() const
52 {
53 return m_templateSubdirectory;
54 }
55
60 QString userTemplateDirectory() const;
61
65
67 QList<ScrollingTemplate> templates() const;
69 ScrollingTemplate templateById(const QUuid& id) const;
70 bool contains(const QUuid& id) const
71 {
72 return m_templates.contains(id);
73 }
74 int count() const
75 {
76 return m_templates.size();
77 }
78
88
101 bool removeTemplate(const QUuid& id);
102
106 QUuid duplicateTemplate(const QUuid& id, const QString& newName = QString());
107
108Q_SIGNALS:
111
112private:
113 QString userTemplateFilePath(const QUuid& id) const;
114 bool writeTemplateFile(const ScrollingTemplate& templ);
115
116 QString m_templateSubdirectory;
117 QHash<QUuid, ScrollingTemplate> m_templates;
118};
119
120} // namespace PhosphorZones
QUuid duplicateTemplate(const QUuid &id, const QString &newName=QString())
Store a copy of id under a fresh UUID with newName (or a "name (Copy)" derivative when empty).
bool removeTemplate(const QUuid &id)
Delete the USER files for id.
QList< ScrollingTemplate > templates() const
All templates, name-sorted (case-insensitive) for stable UI order.
ScrollingTemplate templateById(const QUuid &id) const
The template with id, or an invalid template.
QUuid saveTemplate(ScrollingTemplate templ)
Persist templ (create or update).
bool contains(const QUuid &id) const
Definition ScrollingTemplateStore.h:70
QString templateSubdirectory() const
The data-location subdirectory templates live in, relative to GenericDataLocation,...
Definition ScrollingTemplateStore.h:51
int count() const
Definition ScrollingTemplateStore.h:74
void loadTemplates()
Rescan every data location (system first, user last).
ScrollingTemplateStore(QString templateSubdirectory, QObject *parent=nullptr)
templateSubdirectory is where the app keeps its templates, relative to every QStandardPaths::GenericD...
QString userTemplateDirectory() const
Absolute path of the USER template directory (GenericDataLocation + templateSubdirectory()).
void templatesChanged()
The loaded template set changed (load, save, remove, duplicate).
A scrolling screen's first-class sizing template.
Definition ScrollingTemplate.h:128
Definition IWindowTrackingService.h:24