Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
ModuleMetadata.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 <QJsonObject>
9#include <QList>
10#include <QLocale>
11#include <QString>
12#include <QStringList>
13
14namespace PhosphorControl {
15
17struct PHOSPHORCONTROL_EXPORT ModuleCategoryMetadata
18{
19 QString id;
20 QString name;
21 QString icon;
22 int order = 0;
23};
24
26struct PHOSPHORCONTROL_EXPORT ModulePageMetadata
27{
29 QString id;
30 QString name;
31 QString icon;
35 QString parent;
38 QString category;
42 QStringList keywords;
46 bool dividerAfter = false;
49 QString counterpart;
55 QStringList anchors;
56};
57
62struct PHOSPHORCONTROL_EXPORT ModuleExtensionPointMetadata
63{
65 QString page;
66 QString id;
69 int version = 1;
70};
71
73struct PHOSPHORCONTROL_EXPORT ModuleExtensionMetadata
74{
79 QString id;
81 QString target;
86 QString slot;
89 QString name;
92 QStringList keywords;
93 int order = 0;
94};
95
99struct PHOSPHORCONTROL_EXPORT ModuleSearchEntryMetadata
100{
102 QString page;
104 QString anchor;
108 bool section = false;
109 QString title;
110 QStringList keywords;
114 bool advancedOnly = false;
115};
116
185struct PHOSPHORCONTROL_EXPORT ModuleMetadata
186{
187 QString id;
188 int apiVersion = 0;
189 QString name;
190 QString description;
191 QString icon;
196 QString category;
199 QString parent;
200 int order = 0;
201 QStringList keywords;
207 QList<ModuleCategoryMetadata> categories;
211 QList<ModulePageMetadata> pages;
212 QList<ModuleExtensionPointMetadata> extensionPoints;
213 QList<ModuleExtensionMetadata> extensions;
214 QList<ModuleSearchEntryMetadata> search;
215 bool searchProviders = false;
216
224 static ModuleMetadata parse(const QJsonObject& json, const QLocale& locale, QStringList* errors,
225 QStringList* warnings = nullptr);
226
228 [[nodiscard]] const ModulePageMetadata* page(const QString& id) const;
230 [[nodiscard]] const ModuleExtensionMetadata* extension(const QString& id) const;
231
239 [[nodiscard]] int slotVersion(const QString& pageId, const QString& slot) const;
240};
241
242} // namespace PhosphorControl
PageVisibility
Master toggle for the two-tier "simple vs advanced" sidebar.
Definition PageRegistry.h:70
@ Always
Definition PageRegistry.h:71
Definition ApplicationController.h:21
A top-level sidebar category a module defines.
Definition ModuleMetadata.h:18
QString icon
Definition ModuleMetadata.h:21
QString id
Definition ModuleMetadata.h:19
int order
Definition ModuleMetadata.h:22
QString name
Definition ModuleMetadata.h:20
A section this module adds to another module's page.
Definition ModuleMetadata.h:74
QString target
The target page, <module>:<page>.
Definition ModuleMetadata.h:81
QString id
Local to the module.
Definition ModuleMetadata.h:79
QStringList keywords
Search terms for the section, which ModuleHost indexes while the extension is active.
Definition ModuleMetadata.h:92
int order
Definition ModuleMetadata.h:93
QString slot
top, bottom, before:<anchor>, after:<anchor>, or the id of one of the target page's extension points.
Definition ModuleMetadata.h:86
int targetVersion
The version of the slot the extension was built for.
Definition ModuleMetadata.h:88
QString name
Definition ModuleMetadata.h:89
A named place on one of the module's pages that other modules may add a section to,...
Definition ModuleMetadata.h:63
int version
Bumped whenever the slot moves or its meaning changes, so extensions built for the old one are skippe...
Definition ModuleMetadata.h:69
QString id
Definition ModuleMetadata.h:66
QString page
The module's local page id.
Definition ModuleMetadata.h:65
The metadata a control module embeds with Q_PLUGIN_METADATA:
Definition ModuleMetadata.h:186
QString parent
Another module's id to nest this module's node under, or empty.
Definition ModuleMetadata.h:199
static ModuleMetadata parse(const QJsonObject &json, const QLocale &locale, QStringList *errors, QStringList *warnings=nullptr)
Parse json for locale.
QList< ModuleCategoryMetadata > categories
Definition ModuleMetadata.h:207
QList< ModuleExtensionMetadata > extensions
Definition ModuleMetadata.h:213
int order
Definition ModuleMetadata.h:200
QString name
Definition ModuleMetadata.h:189
QList< ModulePageMetadata > pages
Pre-order: each page is followed by its local descendants, and siblings keep their declaration order,...
Definition ModuleMetadata.h:211
QString icon
Definition ModuleMetadata.h:191
const ModulePageMetadata * page(const QString &id) const
The page with local id id, or nullptr.
QList< ModuleSearchEntryMetadata > search
Definition ModuleMetadata.h:214
QStringList keywords
Definition ModuleMetadata.h:201
QString category
The category the module's node goes under when it is not nested under parent: when it names none,...
Definition ModuleMetadata.h:196
QList< ModuleExtensionPointMetadata > extensionPoints
Definition ModuleMetadata.h:212
int apiVersion
Definition ModuleMetadata.h:188
const ModuleExtensionMetadata * extension(const QString &id) const
The extension with local id id, or nullptr.
QString translationDomain
Read and kept for the module's own use.
Definition ModuleMetadata.h:206
QString id
Definition ModuleMetadata.h:187
QString description
Definition ModuleMetadata.h:190
bool searchProviders
Definition ModuleMetadata.h:215
int slotVersion(const QString &pageId, const QString &slot) const
The version slot slot of the local page pageId offers, or 0 when the page has no such slot.
One page of a module, as its metadata describes it.
Definition ModuleMetadata.h:27
QString icon
Definition ModuleMetadata.h:31
QStringList keywords
Search terms for the page.
Definition ModuleMetadata.h:42
QString category
A category to put the page in directly, instead of under its module.
Definition ModuleMetadata.h:38
bool dividerAfter
Draw a divider after the page's sidebar row.
Definition ModuleMetadata.h:46
QString name
Definition ModuleMetadata.h:30
QString counterpart
The page's other-mode counterpart: a local page id or <module>:<page>.
Definition ModuleMetadata.h:49
QStringList anchors
The page's section anchors: the names its QML reveals for a deep link (<page>#<anchor>,...
Definition ModuleMetadata.h:55
QString id
Local to the module: snapping or snapping/behavior.
Definition ModuleMetadata.h:29
PageRegistry::PageVisibility visibility
The page's simple/advanced tier.
Definition ModuleMetadata.h:44
QString parent
Empty for a page directly under the module (or under category), a local page id for a page under one ...
Definition ModuleMetadata.h:35
A static search target on one of the module's pages: a setting or section at one of the page's anchor...
Definition ModuleMetadata.h:100
QString anchor
One of that page's anchors.
Definition ModuleMetadata.h:104
bool section
"Kind": "Section".
Definition ModuleMetadata.h:108
QString title
Definition ModuleMetadata.h:109
bool advancedOnly
The row shows only in advanced mode (SearchEntry::advancedOnly).
Definition ModuleMetadata.h:114
QString page
The module's local page id.
Definition ModuleMetadata.h:102
QStringList keywords
Definition ModuleMetadata.h:110