PhosphorProtocol::Service Namespace Reference

Namespaces
namespace	Apps
	Single-instance app identities.
namespace	Error
	D-Bus error names returned via QDBusMessage::createErrorReply.
namespace	Interface
namespace	ScrollBehaviourKey
	Keys of the scrolling BEHAVIOUR map that crosses the daemon → KWin effect boundary on org.plasmazones.Scrolling (scrollEffectBehaviour / scrollEffectBehaviourChanged): three already-resolved screen-id lists, the per-context focus-follows-mouse and crop-straddlers rule slots and the vertical-axis MEMBERSHIP (a screen in the list runs its strip vertically; absence means horizontal).
namespace	ScrollTabKey
	Keys of the two scrolling tab-indicator maps that cross the daemon → KWin effect boundary on org.plasmazones.Tiling: the per-screen context-rule PAINT override map (scrollTabPaintOverridesChanged / scrollTabPaintOverrides, all eleven paint keys) and the per-window rule COLOUR map (scrollTabColors / scrollTabColorsChanged, the three colour keys).
namespace	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	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	WindowMetadataKey
	Keys for the extended-window-property QVariantMap (the trailing a{sv} argument of setWindowMetadata).

Functions
constexpr QLatin1String	Name ("org.plasmazones")
	D-Bus service constants shared by all compositor plugins.
constexpr QLatin1String	ObjectPath ("/PlasmaZones")
int	snapAssistThumbnailBoxPx (int zoneMinAxisLogicalPx, int candidateCount, double outputScale)
bool	envSwitchEnabled (const char *name)
bool	envSwitchEnabledByDefault (const char *name)
bool	snapAssistDmabufThumbnailsEnabled ()
bool	snapAssistThumbnailTraceEnabled ()

Variables
constexpr int	QuickLayoutSlotCount = 9
	Quick-layout slots are numbered 1..QuickLayoutSlotCount.
constexpr int	ApiVersion = 5
constexpr int	MinPeerApiVersion = 5
constexpr int	SyncCallTimeoutMs = 500
constexpr int	DaemonReadyProbeTimeoutMs = 3000
constexpr int	SnapAssistThumbnailPostTimeoutMs = 2000
constexpr int	SnapAssistThumbnailCacheCapacity = 24
constexpr int	SnapAssistThumbnailMaxDimension = 1024
constexpr double	SnapAssistCardScaleBase = 0.35
constexpr double	SnapAssistIconSizeRatio = 0.6
constexpr int	SnapAssistMinIconLogicalPx = 16
constexpr double	SnapAssistThumbnailHeadroom = 1.25

Function Documentation

envSwitchEnabled()

bool PhosphorProtocol::Service::envSwitchEnabled ( const char *  name )

inline

envSwitchEnabledByDefault()

bool PhosphorProtocol::Service::envSwitchEnabledByDefault ( const char *  name )

inline

Name()

constexpr QLatin1String PhosphorProtocol::Service::Name ( "org.plasmazones"  )

inlineconstexpr

D-Bus service constants shared by all compositor plugins.

Centralized D-Bus interface names to avoid magic strings. Used by KWin effect, Wayfire plugin, and any future compositor integration.

ObjectPath()

constexpr QLatin1String PhosphorProtocol::Service::ObjectPath ( "/PlasmaZones"  )

inlineconstexpr

snapAssistDmabufThumbnailsEnabled()

bool PhosphorProtocol::Service::snapAssistDmabufThumbnailsEnabled ( )

inline

snapAssistThumbnailBoxPx()

int PhosphorProtocol::Service::snapAssistThumbnailBoxPx ( int  zoneMinAxisLogicalPx, int  candidateCount, double  outputScale  )

inline

snapAssistThumbnailTraceEnabled()

bool PhosphorProtocol::Service::snapAssistThumbnailTraceEnabled ( )

inline

Variable Documentation

ApiVersion

constexpr int PhosphorProtocol::Service::ApiVersion = 5

inlineconstexpr

DaemonReadyProbeTimeoutMs

constexpr int PhosphorProtocol::Service::DaemonReadyProbeTimeoutMs = 3000

inlineconstexpr

MinPeerApiVersion

constexpr int PhosphorProtocol::Service::MinPeerApiVersion = 5

inlineconstexpr

QuickLayoutSlotCount

constexpr int PhosphorProtocol::Service::QuickLayoutSlotCount = 9

inlineconstexpr

Quick-layout slots are numbered 1..QuickLayoutSlotCount.

Protocol-level because the daemon validates the bound on the D-Bus boundary while the settings app walks it in its Quick Shortcuts reset loop, and the two live in different trees. Kept here so those two cannot drift. Note the phosphor-zones mirror, LayoutRegistry::QuickSlotCount (LayoutRegistry.h), enforces the same 1..9 bound as its own named constant: that library deliberately does not depend on phosphor-protocol, so the two are not covered by one definition and must be updated in step by hand if the count ever changes.

SnapAssistCardScaleBase

constexpr double PhosphorProtocol::Service::SnapAssistCardScaleBase = 0.35

inlineconstexpr

SnapAssistIconSizeRatio

constexpr double PhosphorProtocol::Service::SnapAssistIconSizeRatio = 0.6

inlineconstexpr

SnapAssistMinIconLogicalPx

constexpr int PhosphorProtocol::Service::SnapAssistMinIconLogicalPx = 16

inlineconstexpr

SnapAssistThumbnailCacheCapacity

constexpr int PhosphorProtocol::Service::SnapAssistThumbnailCacheCapacity = 24

inlineconstexpr

SnapAssistThumbnailHeadroom

constexpr double PhosphorProtocol::Service::SnapAssistThumbnailHeadroom = 1.25

inlineconstexpr

SnapAssistThumbnailMaxDimension

constexpr int PhosphorProtocol::Service::SnapAssistThumbnailMaxDimension = 1024

inlineconstexpr

SnapAssistThumbnailPostTimeoutMs

constexpr int PhosphorProtocol::Service::SnapAssistThumbnailPostTimeoutMs = 2000

inlineconstexpr

SyncCallTimeoutMs

constexpr int PhosphorProtocol::Service::SyncCallTimeoutMs = 500

inlineconstexpr