Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
ModuleContext.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
6#include "phosphorcontrol_export.h"
7
8#include <QList>
9#include <QPointer>
10#include <QSet>
11#include <QString>
12#include <QStringList>
13#include <QUrl>
14#include <QtCore/qtclasshelpermacros.h>
15
16#include <functional>
17#include <memory>
18
19namespace PhosphorConfig {
20class IBackend;
21}
22
23namespace PhosphorControl {
24
25class ModuleHost;
26class ISearchProvider;
27class PageController;
28class StagingDomain;
29
52class PHOSPHORCONTROL_EXPORT ModuleContext
53{
54public:
55 Q_DISABLE_COPY_MOVE(ModuleContext)
56
57 [[nodiscard]] QString moduleId() const;
58 [[nodiscard]] const ModuleMetadata& metadata() const;
59
61 [[nodiscard]] QString pageId(const QString& localPageId) const;
62
71 bool registerPage(const QString& localPageId, PageController* controller, const QUrl& qmlSource);
72
79
104
120 bool registerExtension(const QString& localExtensionId, StagingDomain* domain, const QUrl& qmlSource);
121
128 using ConfigBackendFactory = std::function<std::unique_ptr<PhosphorConfig::IBackend>(const QString& path)>;
170 PhosphorConfig::IBackend* configBackend(const QString& path, const ConfigBackendFactory& create);
171
172private:
173 friend class ModuleHost;
174 ModuleContext(ModuleHost* host, const ModuleMetadata& metadata);
175
176 struct PageRegistration
177 {
178 QString localId;
179 QPointer<PageController> controller;
180 QUrl qmlSource;
181 };
182
183 struct ExtensionRegistration
184 {
185 QString localId;
186 QPointer<StagingDomain> domain;
187 QUrl qmlSource;
188 };
189
190 struct SearchProviderRegistration
191 {
192 ISearchProvider* provider = nullptr;
194 QPointer<QObject> object;
195 bool isObject = false;
196 };
197
200 [[nodiscard]] QString registeredAs(const StagingDomain* domain) const;
201
202 ModuleHost* m_host;
203 const ModuleMetadata& m_metadata;
204 QList<PageRegistration> m_pages;
205 QList<ExtensionRegistration> m_extensions;
206 QSet<QString> m_registeredPages;
207 QSet<QString> m_registeredExtensions;
208 QList<SearchProviderRegistration> m_searchProviders;
209 QList<QPointer<StagingDomain>> m_domains;
210 QStringList m_errors;
211};
212
213} // namespace PhosphorControl
Pluggable configuration backend.
Definition IBackend.h:151
Source of dynamic (content) search entries — rules, shaders, layouts, virtual screens,...
Definition ISearchProvider.h:23
QString pageId(const QString &localPageId) const
The scoped id of the module's page localPageId.
bool registerPage(const QString &localPageId, PageController *controller, const QUrl &qmlSource)
Register the controller and QML page for the metadata page localPageId.
PhosphorConfig::IBackend * configBackend(const QString &path, const ConfigBackendFactory &create)
The config backend for the file at path, an absolute path, shared by every module that opens the same...
bool registerDomain(StagingDomain *domain)
Register a staging domain that has no page of its own, so it joins Apply, Discard and the dirty flag.
const ModuleMetadata & metadata() const
bool registerExtension(const QString &localExtensionId, StagingDomain *domain, const QUrl &qmlSource)
Register the section for the extension localExtensionId the metadata declares: its staging domain and...
friend class ModuleHost
Definition ModuleContext.h:173
std::function< std::unique_ptr< PhosphorConfig::IBackend >(const QString &path)> ConfigBackendFactory
Makes the backend of a config file.
Definition ModuleContext.h:128
bool registerSearchProvider(ISearchProvider *provider)
Register a dynamic search source, for content the metadata cannot list (rules, layouts,...
Hosts control modules in an ApplicationController.
Definition ModuleHost.h:131
Base class for a settings page: a staging domain backed by a QML page that appears in the sidebar.
Definition PageController.h:24
Abstract base for anything that holds staged user changes pending an Apply.
Definition StagingDomain.h:30
Definition HostDirectory.h:19
Definition ApplicationController.h:21
The metadata a control module embeds with Q_PLUGIN_METADATA:
Definition ModuleMetadata.h:186