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

Classes

class  ApplicationController
 Top-level orchestrator for a phosphor-control application. More...
class  IControlModule
 The root object of a control module. More...
struct  DBusEndpoint
 Configured endpoint for a single D-Bus service the settings app talks to. More...
class  DBusBridge
 Thin wrapper around QDBusConnection::sessionBus() that bakes in a pre-configured endpoint. More...
class  ExtensionSlotModel
 The sections in one slot of one page, as ApplicationController:: extensionsFor() lists them, for ExtensionSlot's Repeater. More...
class  ISearchProvider
 Source of dynamic (content) search entries — rules, shaders, layouts, virtual screens, etc. More...
class  LocalizedContext
 Minimal QML i18n context that routes through Qt's translation system. More...
class  ModuleContext
 What the host hands a module while it loads (IControlModule::registerInto). More...
class  ModuleHost
 Hosts control modules in an ApplicationController. More...
 A top-level sidebar category a module defines. More...
 One page of a module, as its metadata describes it. More...
 A named place on one of the module's pages that other modules may add a section to, beyond the implicit top, bottom, before:<anchor> and after:<anchor> slots every page has. More...
 A section this module adds to another module's page. More...
 A static search target on one of the module's pages: a setting or section at one of the page's anchors. More...
 The metadata a control module embeds with Q_PLUGIN_METADATA: More...
class  ModulePlaceholderPage
 The controller of a page that stands in for a control module's page while the module is not loaded. More...
class  ModuleTestHost
 Checks one control module without a window, for the module's own CI. More...
class  PageController
 Base class for a settings page: a staging domain backed by a QML page that appears in the sidebar. More...
class  PageRegistry
 Holds the catalogue of pages an application has registered. More...
class  SearchController
 Global settings search: builds a ranked result list for a query. More...
struct  SearchEntry
 One searchable item in the global settings search index. More...
class  SearchRanker
 Pure, stateless scoring + ranking for the global settings search. More...
class  SidebarRows
 Derives the sidebar's visible row list from the page registry. More...
class  StagingDomain
 Abstract base for anything that holds staged user changes pending an Apply. More...

Functions

PHOSPHORCONTROL_EXPORT QString version ()

Variables

constexpr int ControlModuleApiVersion = 1
 The ApiVersion a control module's metadata declares, and the version the PhosphorControlModule_iid below ends in.
constexpr int DefaultSyncTimeoutMs = 500
 Default bound for synchronous DBusBridge::call(): "definitely something is wrong" rather than expected latency for in-memory daemon hash lookups.

Function Documentation

◆ version()

PHOSPHORCONTROL_EXPORT QString PhosphorControl::version ( )

Variable Documentation

◆ ControlModuleApiVersion

int PhosphorControl::ControlModuleApiVersion = 1
inlineconstexpr

The ApiVersion a control module's metadata declares, and the version the PhosphorControlModule_iid below ends in.

Both change together.

◆ DefaultSyncTimeoutMs

int PhosphorControl::DefaultSyncTimeoutMs = 500
inlineconstexpr

Default bound for synchronous DBusBridge::call(): "definitely something is wrong" rather than expected latency for in-memory daemon hash lookups.

Centralised so the struct default and the clamp warning agree.