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

A static search target on one of the module's pages: a setting or section at one of the page's anchors. More...

#include <PhosphorControl/ModuleMetadata.h>

Public Attributes

QString page
 The module's local page id.
QString anchor
 One of that page's anchors.
bool section = false
 "Kind": "Section".
QString title
QStringList keywords
bool advancedOnly = false
 The row shows only in advanced mode (SearchEntry::advancedOnly).

Detailed Description

A static search target on one of the module's pages: a setting or section at one of the page's anchors.

the host indexes these from the metadata, so search finds them before the module loads.

Member Data Documentation

◆ advancedOnly

bool PhosphorControl::ModuleSearchEntryMetadata::advancedOnly = false

The row shows only in advanced mode (SearchEntry::advancedOnly).

An error on a page that, or any of whose local ancestors, shows only in simple mode, where search could never offer it.

◆ anchor

QString PhosphorControl::ModuleSearchEntryMetadata::anchor

One of that page's anchors.

◆ keywords

QStringList PhosphorControl::ModuleSearchEntryMetadata::keywords

◆ page

QString PhosphorControl::ModuleSearchEntryMetadata::page

The module's local page id.

◆ section

bool PhosphorControl::ModuleSearchEntryMetadata::section = false

"Kind": "Section".

"Setting", the default, leaves it false. A kind this PhosphorControl does not know is a warning, and parse() leaves that entry out, so an entry written for a newer PhosphorControl costs only itself.

◆ title

QString PhosphorControl::ModuleSearchEntryMetadata::title

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