ZoneJsonKeys.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorLayoutApi/GapKeys.h>
#include <QLatin1String>
 
namespace PhosphorZones {
 
namespace ZoneJsonKeys {
 
// Zone-identity keys.
inline constexpr QLatin1String Id{"id"};
inline constexpr QLatin1String ZoneId{"zoneId"};
inline constexpr QLatin1String Name{"name"};
inline constexpr QLatin1String ZoneNumber{"zoneNumber"};
inline constexpr QLatin1String RelativeGeometry{"relativeGeometry"};
inline constexpr QLatin1String Appearance{"appearance"};
 
// Per-zone geometry keys.
inline constexpr QLatin1String X{"x"};
inline constexpr QLatin1String Y{"y"};
inline constexpr QLatin1String Width{"width"};
inline constexpr QLatin1String Height{"height"};
inline constexpr QLatin1String ZOrder{"zOrder"};
 
// Per-zone appearance keys.
inline constexpr QLatin1String HighlightColor{"highlightColor"};
inline constexpr QLatin1String InactiveColor{"inactiveColor"};
inline constexpr QLatin1String BorderColor{"borderColor"};
inline constexpr QLatin1String ActiveOpacity{"activeOpacity"};
inline constexpr QLatin1String InactiveOpacity{"inactiveOpacity"};
inline constexpr QLatin1String BorderWidth{"borderWidth"};
inline constexpr QLatin1String BorderRadius{"borderRadius"};
inline constexpr QLatin1String UseCustomColors{"useCustomColors"};
inline constexpr QLatin1String IsHighlighted{"isHighlighted"};
 
// Layout-level keys.
inline constexpr QLatin1String DefaultOrder{"defaultOrder"};
inline constexpr QLatin1String Description{"description"};
inline constexpr QLatin1String Zones{"zones"};
inline constexpr QLatin1String ZonePadding{"zonePadding"};
inline constexpr QLatin1String OuterGap{"outerGap"};
inline constexpr QLatin1String ShowZoneNumbers{"showZoneNumbers"};
inline constexpr QLatin1String OverlayDisplayMode{"overlayDisplayMode"};
inline constexpr QLatin1String IsBuiltIn{"isBuiltIn"}; 
inline constexpr QLatin1String IsSystem{"isSystem"}; 
inline constexpr QLatin1String HasSystemOrigin{"hasSystemOrigin"}; 
inline constexpr QLatin1String SystemSourcePath{"systemSourcePath"}; 
inline constexpr QLatin1String ZoneCount{"zoneCount"};
inline constexpr QLatin1String Category{"category"}; 
 
// Shader-binding keys (per-zone shader pipeline overrides).
inline constexpr QLatin1String ShaderId{"shaderId"};
inline constexpr QLatin1String ShaderParams{"shaderParams"};
 
// Visibility-filtering keys (which screens / desktops / activities
// the layout is offered on).
inline constexpr QLatin1String HiddenFromSelector{"hiddenFromSelector"};
inline constexpr QLatin1String AllowedScreens{"allowedScreens"};
inline constexpr QLatin1String AllowedDesktops{"allowedDesktops"};
inline constexpr QLatin1String AllowedActivities{"allowedActivities"};
 
// Aspect-ratio classification keys.
inline constexpr QLatin1String AspectRatioClassKey{"aspectRatioClass"};
inline constexpr QLatin1String MinAspectRatio{"minAspectRatio"};
inline constexpr QLatin1String MaxAspectRatio{"maxAspectRatio"};
 
// App-rule (auto-assign) keys.
inline constexpr QLatin1String AppRules{"appRules"};
inline constexpr QLatin1String Pattern{"pattern"};
// `ZoneNumber` (above) is reused for the rule target.
inline constexpr QLatin1String TargetScreen{"targetScreen"};
inline constexpr QLatin1String AutoAssign{"autoAssign"};
 
// Geometry-mode keys.
inline constexpr QLatin1String UseFullScreenGeometry{"useFullScreenGeometry"};
inline constexpr QLatin1String GeometryMode{"geometryMode"};
inline constexpr QLatin1String FixedGeometry{"fixedGeometry"};
inline constexpr QLatin1String FixedX{"fixedX"};
inline constexpr QLatin1String FixedY{"fixedY"};
inline constexpr QLatin1String FixedWidth{"fixedWidth"};
inline constexpr QLatin1String FixedHeight{"fixedHeight"};
 
// Per-side outer-gap keys — canonical definition in phosphor-layout-api's
// GapKeys.h (shared with phosphor-tiles AutotileConstants). Re-exported so
// in-tree ZoneJsonKeys callers can keep their references unchanged.
using PhosphorLayout::GapKeys::OuterGapBottom;
using PhosphorLayout::GapKeys::OuterGapLeft;
using PhosphorLayout::GapKeys::OuterGapRight;
using PhosphorLayout::GapKeys::OuterGapTop;
using PhosphorLayout::GapKeys::UsePerSideOuterGap;
 
} // namespace ZoneJsonKeys
 
} // namespace PhosphorZones