Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PhosphorRegistry::PluginSeam Struct Reference

One kind of plugin the suite loads, such as bar widgets. More...

#include <PhosphorRegistry/PluginCatalog.h>

Public Attributes

QString name
 Directory name under each plugin root, for example bar-widget.
QString iid
 The IID every plugin of this seam declares, for example org.phosphor_works.Lambent.BarWidget/1.
int apiVersion = 0
 The ApiVersion this build loads.

Detailed Description

One kind of plugin the suite loads, such as bar widgets.

A plugin of a seam is a Qt plugin (qt_add_plugin + Q_PLUGIN_METADATA) whose IID equals iid and whose embedded metadata JSON carries at least "Id" (a non-empty [A-Za-z0-9][A-Za-z0-9._-]* string) and an integer "ApiVersion" equal to apiVersion. Everything else in that JSON belongs to the seam and is handed through untouched.

name follows the same pattern as an id, iid is non-empty and apiVersion is at least 1. A catalog over a seam that breaks any of these logs a warning and offers nothing.

Member Data Documentation

◆ apiVersion

int PhosphorRegistry::PluginSeam::apiVersion = 0

The ApiVersion this build loads.

A plugin built for another one is refused before its library is loaded.

◆ iid

QString PhosphorRegistry::PluginSeam::iid

The IID every plugin of this seam declares, for example org.phosphor_works.Lambent.BarWidget/1.

◆ name

QString PhosphorRegistry::PluginSeam::name

Directory name under each plugin root, for example bar-widget.


The documentation for this struct was generated from the following file: