Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
ServiceConstants.h File Reference
#include <QByteArray>
#include <QLatin1String>
#include <QtGlobal>
#include <algorithm>
#include <cmath>

Go to the source code of this file.

Namespaces

namespace  PhosphorProtocol
 D-Bus marshalling for the shared tiling-family value types (see AutotileTypes.h; the file names predate the autotile-to-tiling generalization and are load-bearing across the build, so only the docs moved with the split).
namespace  PhosphorProtocol::Service
namespace  PhosphorProtocol::Service::Interface
namespace  PhosphorProtocol::Service::Error
 D-Bus error names returned via QDBusMessage::createErrorReply.
namespace  PhosphorProtocol::Service::SettingProperty
 Property names exposed by the Settings interface's runtime D-Bus surface (distinct from the persisted-config keys served by ConfigDefaults — these names live on the wire only).
namespace  PhosphorProtocol::Service::WindowMetadataKey
 Keys for the extended-window-property QVariantMap (the trailing a{sv} argument of setWindowMetadata).
namespace  PhosphorProtocol::Service::ScrollTabKey
 Keys of the scrolling tab-indicator maps that cross the daemon → KWin effect boundary on org.phosphor_works.Placement.Tiling: the per-screen context-rule PAINT override map (scrollTabPaintOverridesChanged / scrollTabPaintOverrides, every key below) and the per-window rule COLOUR map (scrollTabColors / scrollTabColorsChanged, the colour keys only).
namespace  PhosphorProtocol::Service::ScrollBehaviourKey
 Keys of the scrolling BEHAVIOUR map that crosses the daemon → KWin effect boundary on org.phosphor_works.Placement.Scrolling (scrollEffectBehaviour / scrollEffectBehaviourChanged): already-resolved screen-id lists, one per key below.
namespace  PhosphorProtocol::Service::StripPreviewKey
 Tab keys on the STRIP PREVIEW payload — the per-tile description of the tab indicator its column draws, so a preview of the strip shows a tabbed column as tabbed instead of as a plain window.
namespace  PhosphorProtocol::Service::StripModelKey
 Keys of the STRIP MODEL payload, org.phosphor_works.Placement.Scrolling.stripModelJson: the whole strip of one screen as the Phosphor shell's placement map draws it, columns on and off screen alike, in pixels along the strip's own axis.
namespace  PhosphorProtocol::Service::DropProxyKey
 Keys of the drop-proxy JSON a shell registers on org.phosphor_works.Placement.WindowDrag (registerDropProxy).
namespace  PhosphorProtocol::Service::Apps
 Single-instance app identities.
namespace  PhosphorProtocol::Service::Apps::Settings
namespace  PhosphorProtocol::Service::Apps::Editor

Functions

constexpr QLatin1String PhosphorProtocol::Service::Name ("org.phosphor_works.Placement")
 The placement service's D-Bus identity.
constexpr QLatin1String PhosphorProtocol::Service::ObjectPath ("/org/phosphor_works/Placement")
constexpr QLatin1String PhosphorProtocol::Service::HostApi ("placement")
 Not a D-Bus name.
constexpr QLatin1String PhosphorProtocol::Service::Interface::Settings ("org.phosphor_works.Placement.Settings")
constexpr QLatin1String PhosphorProtocol::Service::Interface::WindowDrag ("org.phosphor_works.Placement.WindowDrag")
constexpr QLatin1String PhosphorProtocol::Service::Interface::WindowTracking ("org.phosphor_works.Placement.WindowTracking")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Overlay ("org.phosphor_works.Placement.Overlay")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Tiling ("org.phosphor_works.Placement.Tiling")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Autotile ("org.phosphor_works.Placement.Autotile")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Scrolling ("org.phosphor_works.Placement.Scrolling")
constexpr QLatin1String PhosphorProtocol::Service::Interface::LayoutRegistry ("org.phosphor_works.Placement.LayoutRegistry")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Screen ("org.phosphor_works.Placement.Screen")
constexpr QLatin1String PhosphorProtocol::Service::Interface::ZoneDetection ("org.phosphor_works.Placement.ZoneDetection")
constexpr QLatin1String PhosphorProtocol::Service::Interface::CompositorBridge ("org.phosphor_works.Placement.CompositorBridge")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Snap ("org.phosphor_works.Placement.Snap")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Rules ("org.phosphor_works.Placement.Rules")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Control ("org.phosphor_works.Placement.Control")
constexpr QLatin1String PhosphorProtocol::Service::Interface::Shader ("org.phosphor_works.Placement.Shader")
constexpr QLatin1String PhosphorProtocol::Service::Error::Busy ("org.phosphor_works.Placement.Error.Busy")
constexpr QLatin1String PhosphorProtocol::Service::Error::Shutdown ("org.phosphor_works.Placement.Error.Shutdown")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::ShaderProfileTree ("shaderProfileTree")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::MotionProfileTree ("motionProfileTree")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::AnimationShaderSearchPaths ("animationShaderSearchPaths")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::DecorationProfileTree ("decorationProfileTree")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::OverlayShaderTree ("overlayShaderTree")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::DecorationBlurScaleMultiplier ("decorationBlurScaleMultiplier")
 The user's decoration blur-quality tier.
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsMinimized ("isMinimized")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsDemandingAttention ("isDemandingAttention")
 Urgency (KWin's demandsAttention).
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsFullscreen ("isFullscreen")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsSticky ("isSticky")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsMaximized ("isMaximized")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsAxisMaximized ("isAxisMaximized")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsFocused ("isFocused")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsTransient ("isTransient")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsNotification ("isNotification")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::KeepAbove ("keepAbove")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::KeepBelow ("keepBelow")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::SkipTaskbar ("skipTaskbar")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::SkipPager ("skipPager")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::SkipSwitcher ("skipSwitcher")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsModal ("isModal")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::HasDecoration ("hasDecoration")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsResizable ("isResizable")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsMovable ("isMovable")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::IsMaximizable ("isMaximizable")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::Width ("width")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::Height ("height")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::PositionX ("positionX")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::PositionY ("positionY")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::CaptionNormal ("captionNormal")
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::VirtualDesktops ("virtualDesktops")
 Full 1-based desktop-number list for a window on SEVERAL (but not all) virtual desktops.
constexpr QLatin1String PhosphorProtocol::Service::WindowMetadataKey::Activities ("activities")
 Full activity UUID list for a window on SEVERAL (but not all) activities.
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::TabStyle ("tabStyle")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::GapsBetweenTabs ("gapsBetweenTabs")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::CornerRadius ("cornerRadius")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::ActiveColor ("activeColor")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::InactiveColor ("inactiveColor")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::UrgentColor ("urgentColor")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::FontFamily ("fontFamily")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::FontWeight ("fontWeight")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::FontItalic ("fontItalic")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::FontUnderline ("fontUnderline")
constexpr QLatin1String PhosphorProtocol::Service::ScrollTabKey::FontStrikeout ("fontStrikeout")
constexpr QLatin1String PhosphorProtocol::Service::ScrollBehaviourKey::FocusFollowsMouse ("focusFollowsMouse")
constexpr QLatin1String PhosphorProtocol::Service::ScrollBehaviourKey::CropStraddlers ("cropStraddlers")
constexpr QLatin1String PhosphorProtocol::Service::ScrollBehaviourKey::VerticalAxis ("verticalAxis")
constexpr QLatin1String PhosphorProtocol::Service::StripPreviewKey::TabCount ("tabCount")
 How many tabs the tile's column shows, and absent or 0 when it draws no indicator — the single "no indicator here" gate on this payload, as the null rect is on the compositor's.
constexpr QLatin1String PhosphorProtocol::Service::StripPreviewKey::ActiveTab ("activeTab")
 The tile's own 0-based tab within that count.
constexpr QLatin1String PhosphorProtocol::Service::StripPreviewKey::TabPosition ("tabPosition")
 Which edge the indicator runs along, as a PhosphorScrollEngine:: TabIndicatorPosition underlying value (0 Left, 1 Right, 2 Top, 3 Bottom).
constexpr QLatin1String PhosphorProtocol::Service::StripPreviewKey::TabLength ("tabLength")
 How much of that edge the indicator covers, 0.0 to 1.0, centered on it.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::Axis ("axis")
 0 for a horizontal strip, 1 for a vertical one.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::ViewOffsetPx ("viewOffsetPx")
 The viewport's leading edge in strip coordinates.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::ViewportPx ("viewportPx")
 The viewport's extent along the strip (the work area's main extent).
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::StripExtentPx ("stripExtentPx")
 The strip's total extent: every non-minimized column plus the gaps.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::ActiveColumn ("activeColumn")
 Strip index of the active column, -1 on an empty strip.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::Columns ("columns")
 The column array, in strip order.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::Index ("index")
 A column's strip index, which is also what focusColumnAt takes.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::StripPosPx ("stripPosPx")
 A column's leading edge in strip coordinates.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::ExtentPx ("extentPx")
 A column's extent along the strip; 0 for a fully minimized column.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::Display ("display")
 A column's display as a PhosphorScrollEngine::ColumnDisplay underlying value (0 Normal, 1 Tabbed).
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::ActiveTile ("activeTile")
 Index into the column's tiles of its active tile.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::Maximized ("maximized")
 The column's declared maximize-to-edges state.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::Tiles ("tiles")
 The column's tile array, in stack order, minimized tiles included.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::WindowId ("windowId")
 A tile's window id.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::CrossPx ("crossPx")
 A tile's resolved extent across the strip; 0 for a minimized tile.
constexpr QLatin1String PhosphorProtocol::Service::StripModelKey::Minimized ("minimized")
 Whether the tile is minimized (kept in the stack order, laid out nowhere).
constexpr QLatin1String PhosphorProtocol::Service::DropProxyKey::Rect ("rect")
 The miniature's bounding rect on its screen.
constexpr QLatin1String PhosphorProtocol::Service::DropProxyKey::Cells ("cells")
 Array of cells, one per drawn zone, each {id, rect}.
constexpr QLatin1String PhosphorProtocol::Service::DropProxyKey::Id ("id")
 A cell's target: the snapping zone id, braces included, as the layout interfaces spell it.
constexpr QLatin1String PhosphorProtocol::Service::Apps::Settings::ServiceName ("org.phosphor_works.Facet")
constexpr QLatin1String PhosphorProtocol::Service::Apps::Settings::ObjectPath ("/org/phosphor_works/Facet")
constexpr QLatin1String PhosphorProtocol::Service::Apps::Settings::Interface ("org.phosphor_works.Facet")
constexpr QLatin1String PhosphorProtocol::Service::Apps::Editor::ServiceName ("org.phosphor_works.PlasmaZones.Editor")
constexpr QLatin1String PhosphorProtocol::Service::Apps::Editor::ObjectPath ("/org/phosphor_works/PlasmaZones/Editor")
constexpr QLatin1String PhosphorProtocol::Service::Apps::Editor::Interface ("org.phosphor_works.PlasmaZones.Editor")
int PhosphorProtocol::Service::snapAssistThumbnailBoxPx (int zoneMinAxisLogicalPx, int candidateCount, double outputScale)
bool PhosphorProtocol::Service::envSwitchEnabled (const char *name)
bool PhosphorProtocol::Service::envSwitchEnabledByDefault (const char *name)
bool PhosphorProtocol::Service::snapAssistDmabufThumbnailsEnabled ()
bool PhosphorProtocol::Service::snapAssistThumbnailTraceEnabled ()
Global window gaps

The resolved global gaps as the Settings interface serves them (the Gaps group).

The daemon registers them read-write: the Phosphor shell's desktop style writes them here, so the geometry cascade sees the change through the setters' signals, and the editor reads them to draw its gap overlay. The per-side spellings coincide with PhosphorLayout::GapKeys, the layout-file field names, but the two are independent contracts and neither follows the other.

constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::InnerGap ("innerGap")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::OuterGap ("outerGap")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::UsePerSideOuterGap ("usePerSideOuterGap")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::OuterGapTop ("outerGapTop")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::OuterGapBottom ("outerGapBottom")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::OuterGapLeft ("outerGapLeft")
constexpr QLatin1String PhosphorProtocol::Service::SettingProperty::OuterGapRight ("outerGapRight")

Variables

constexpr int PhosphorProtocol::Service::QuickLayoutSlotCount = 9
 Quick-layout slots are numbered 1..QuickLayoutSlotCount.
constexpr int PhosphorProtocol::Service::MaxRunningWindowsPayloadBytes = 1 << 20
 The largest running-windows payload (Settings.provideRunningWindows) the daemon relays, in UTF-8 bytes.
constexpr int PhosphorProtocol::Service::ApiVersion = 11
constexpr int PhosphorProtocol::Service::MinPeerApiVersion = 11
constexpr int PhosphorProtocol::Service::CommittedSizeTolerancePx = 1
constexpr int PhosphorProtocol::Service::SyncCallTimeoutMs = 500
constexpr int PhosphorProtocol::Service::DaemonReadyProbeTimeoutMs = 3000
constexpr int PhosphorProtocol::Service::SnapAssistThumbnailPostTimeoutMs = 2000
constexpr int PhosphorProtocol::Service::SnapAssistThumbnailCacheCapacity = 24
constexpr int PhosphorProtocol::Service::SnapAssistThumbnailMaxDimension = 1024
constexpr double PhosphorProtocol::Service::SnapAssistCardScaleBase = 0.35
constexpr double PhosphorProtocol::Service::SnapAssistIconSizeRatio = 0.6
constexpr int PhosphorProtocol::Service::SnapAssistMinIconLogicalPx = 16
constexpr double PhosphorProtocol::Service::SnapAssistThumbnailHeadroom = 1.25