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

One page of a module, as its metadata describes it. More...

#include <PhosphorControl/ModuleMetadata.h>

Public Attributes

QString id
 Local to the module: snapping or snapping/behavior.
QString name
QString icon
QString parent
 Empty for a page directly under the module (or under category), a local page id for a page under one of the module's own pages, or <module>:<page> for a page under another module's page.
QString category
 A category to put the page in directly, instead of under its module.
QStringList keywords
 Search terms for the page.
PageRegistry::PageVisibility visibility = PageRegistry::PageVisibility::Always
 The page's simple/advanced tier.
bool dividerAfter = false
 Draw a divider after the page's sidebar row.
QString counterpart
 The page's other-mode counterpart: a local page id or <module>:<page>.
QStringList anchors
 The page's section anchors: the names its QML reveals for a deep link (<page>#<anchor>, ApplicationController::setPendingAnchor).

Detailed Description

One page of a module, as its metadata describes it.

Member Data Documentation

◆ anchors

QStringList PhosphorControl::ModulePageMetadata::anchors

The page's section anchors: the names its QML reveals for a deep link (<page>#<anchor>, ApplicationController::setPendingAnchor).

A search entry lands on one, and every anchor is also a place other modules can add a section, before:<anchor> and after:<anchor>, which the page's QML places with a ExtensionSlot next to the anchored section.

◆ category

QString PhosphorControl::ModulePageMetadata::category

A category to put the page in directly, instead of under its module.

Exclusive with parent.

◆ counterpart

QString PhosphorControl::ModulePageMetadata::counterpart

The page's other-mode counterpart: a local page id or <module>:<page>.

Empty for none. See PageRegistry::Entry.

◆ dividerAfter

bool PhosphorControl::ModulePageMetadata::dividerAfter = false

Draw a divider after the page's sidebar row.

◆ icon

QString PhosphorControl::ModulePageMetadata::icon

◆ id

QString PhosphorControl::ModulePageMetadata::id

Local to the module: snapping or snapping/behavior.

◆ keywords

QStringList PhosphorControl::ModulePageMetadata::keywords

Search terms for the page.

ModuleHost passes them, with the module's own keywords, to its SearchController (ModuleHost::setSearchController), so the page is found before its module loads.

◆ name

QString PhosphorControl::ModulePageMetadata::name

◆ parent

QString PhosphorControl::ModulePageMetadata::parent

Empty for a page directly under the module (or under category), a local page id for a page under one of the module's own pages, or <module>:<page> for a page under another module's page.

◆ visibility

PageRegistry::PageVisibility PhosphorControl::ModulePageMetadata::visibility = PageRegistry::PageVisibility::Always

The page's simple/advanced tier.


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