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

A section this module adds to another module's page. More...

#include <PhosphorControl/ModuleMetadata.h>

Public Attributes

QString id
 Local to the module.
QString target
 The target page, <module>:<page>.
QString slot
 top, bottom, before:<anchor>, after:<anchor>, or the id of one of the target page's extension points.
int targetVersion = 1
 The version of the slot the extension was built for.
QString name
QStringList keywords
 Search terms for the section, which ModuleHost indexes while the extension is active.
int order = 0

Detailed Description

A section this module adds to another module's page.

Member Data Documentation

◆ id

QString PhosphorControl::ModuleExtensionMetadata::id

Local to the module.

the host knows it as <module>:<id>, the same form as a scoped page id, so an extension and a page of one module may share an id. The two never meet: extension ids name sections only (ModuleHost::refusedExtensions, extensionsOn), never sidebar pages.

◆ keywords

QStringList PhosphorControl::ModuleExtensionMetadata::keywords

Search terms for the section, which ModuleHost indexes while the extension is active.

◆ name

QString PhosphorControl::ModuleExtensionMetadata::name

◆ order

int PhosphorControl::ModuleExtensionMetadata::order = 0

◆ slot

QString PhosphorControl::ModuleExtensionMetadata::slot

top, bottom, before:<anchor>, after:<anchor>, or the id of one of the target page's extension points.

parse() only requires one; ModuleHost refuses the extension, with the reason, when the target page does not offer it.

◆ target

QString PhosphorControl::ModuleExtensionMetadata::target

The target page, <module>:<page>.

◆ targetVersion

int PhosphorControl::ModuleExtensionMetadata::targetVersion = 1

The version of the slot the extension was built for.


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