Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
ActionParams.h File Reference
#include <QLatin1StringView>

Go to the source code of this file.

Namespaces

namespace  PhosphorRules
namespace  PhosphorRules::ActionParam
namespace  PhosphorRules::ParamKind
namespace  PhosphorRules::OverlayStyleToken
 Wire tokens for OverrideOverlayStyle's value param — the closed vocabulary the descriptor's validator + enumWireValues, the daemon consumer (LayoutRegistry::resolveContextOverlay), and the settings label layers (enumOptionLabel + the rule-list summary) all read from this single source, so a future rename can never desync the consumers.
namespace  PhosphorRules::InsertPositionToken
 Wire tokens for SetInsertPosition's value param — the closed vocabulary the descriptor validator, the daemon consumer (LayoutRegistry::resolveContextTilingParams maps token → the AutotileInsertPosition int), and the settings label layers all read from this single source.
namespace  PhosphorRules::OverflowBehaviorToken
 Wire tokens for SetOverflowBehavior's value param.
namespace  PhosphorRules::DragBehaviorToken
 Wire tokens for SetDragBehavior's value param.
namespace  PhosphorRules::CenterFocusedColumnToken
 Wire tokens for SetCenterFocusedColumn's value param — the closed vocabulary the descriptor validator, the daemon consumer (LayoutRegistry::resolveContextScrollingParams maps token → int), and the settings label layers all read from this single source.
namespace  PhosphorRules::ColumnDisplayToken
 Wire tokens for SetScrollDefaultColumnDisplay's value param — how a column lays its windows out.
namespace  PhosphorRules::TabIndicatorStyleToken
 Wire tokens for SetTabIndicatorStyle's value param.
namespace  PhosphorRules::TabIndicatorPositionToken
 Wire tokens for SetTabIndicatorPosition's value param — which column edge the indicator runs along.
namespace  PhosphorRules::ColumnPlacementToken
 Wire tokens for OpenColumnPlacement's value param — whether an opening window starts its own column or joins the focused one.
namespace  PhosphorRules::ScrollInsertPositionToken
 Wire tokens for SetScrollInsertPosition's value param — where a fresh column enters the strip.
namespace  PhosphorRules::StickyWindowHandlingToken
 Wire tokens for SetScrollStickyWindowHandling's value param — how the strip treats a window shown on all desktops.
namespace  PhosphorRules::StripAxisToken
 Wire tokens for SetScrollStripAxis's value param — which way the matched context's strip runs.
namespace  PhosphorRules::WindowLayerToken
 Wire tokens for SetWindowLayer's value param — the closed vocabulary the descriptor validator, the KWin-effect consumer (resolveWindowLayer), and the settings label layers all read from this single source.
namespace  PhosphorRules::BorderColorToken
 Sentinel value a SetBorderColorActive / SetBorderColorInactive value param may carry instead of a hex string, meaning "track the live system accent colour".

Variables

constexpr QLatin1StringView PhosphorRules::ActionParam::Event {"event"}
constexpr QLatin1StringView PhosphorRules::ActionParam::EffectId {"effectId"}
constexpr QLatin1StringView PhosphorRules::ActionParam::Params {"params"}
constexpr QLatin1StringView PhosphorRules::ActionParam::PresetId {"presetId"}
constexpr QLatin1StringView PhosphorRules::ActionParam::PresetIds {"presetIds"}
 Per-pack preset references for OverrideDecorationChain: {packId: presetId}, mirroring how that action's Params is already nested per pack.
constexpr QLatin1StringView PhosphorRules::ActionParam::Curve {"curve"}
constexpr QLatin1StringView PhosphorRules::ActionParam::DurationMs {"durationMs"}
constexpr QLatin1StringView PhosphorRules::ActionParam::Value {"value"}
constexpr QLatin1StringView PhosphorRules::ActionParam::Mode {"mode"}
constexpr QLatin1StringView PhosphorRules::ActionParam::LayoutId {"layoutId"}
constexpr QLatin1StringView PhosphorRules::ActionParam::Algorithm {"algorithm"}
constexpr QLatin1StringView PhosphorRules::ActionParam::Zones {"zones"}
constexpr QLatin1StringView PhosphorRules::ActionParam::ZoneNames {"zoneNames"}
constexpr QLatin1StringView PhosphorRules::ActionParam::TargetScreenId {"targetScreenId"}
constexpr QLatin1StringView PhosphorRules::ActionParam::TargetDesktop {"targetDesktop"}
constexpr QLatin1StringView PhosphorRules::ActionParam::TargetWorkspaceId {"targetWorkspaceId"}
constexpr QLatin1StringView PhosphorRules::ActionParam::TargetWorkspaceName {"targetWorkspaceName"}
constexpr QLatin1StringView PhosphorRules::ActionParam::Chain {"chain"}
constexpr QLatin1StringView PhosphorRules::ParamKind::AnimationEvent {"animationEvent"}
 A param whose value is an animation event path (window.appearance.open).
constexpr int PhosphorRules::MaxZoneOrdinal = 64
 Upper bound for a SnapToZone zone ordinal (each ActionParam::Zones entry).
constexpr int PhosphorRules::MaxZoneNameLength = 128
 Upper bound on a SnapToZone zone-name entry (each ActionParam::ZoneNames string), in characters, measured on the TRIMMED name.
constexpr int PhosphorRules::MaxWorkspaceNameLength = 128
 Upper bound on a RouteToWorkspace target name (ActionParam::TargetWorkspaceName), in characters, measured on the TRIMMED name.
constexpr int PhosphorRules::MaxWorkspaceIdLength = 128
 Upper bound on a RouteToWorkspace target id (ActionParam::TargetWorkspaceId), in characters, measured on the TRIMMED value, the same grossly-malformed-payload posture as the name bound above.
constexpr int PhosphorRules::MaxScreenIdLength = 128
 Upper bound on a RouteToScreen target id (ActionParam::TargetScreenId), in characters, measured on the TRIMMED value.
constexpr int PhosphorRules::MaxFontFamilyLength = 128
 Upper bound on a tab label font FAMILY (SetTabIndicatorFontFamily), in characters, measured on the TRIMMED value.
constexpr int PhosphorRules::MaxTabGroupNameLength = 64
 Length cap on an OpenTabGroup group name, on the same terms as the font family above (checked on the trimmed value; the descriptor validator and the rule editor's text field both read it).
constexpr int PhosphorRules::MaxDecorationChainEntries = 64
 Caps on an OverrideDecorationChain payload, mirroring the config path's kMaxChainPacks / kMaxShaderStringChars.
constexpr int PhosphorRules::MaxChainPackIdLength = 1024
constexpr int PhosphorRules::MaxShaderPresetIdLength = 1024
 Length cap on a shader preset id carried by a rule action.
constexpr double PhosphorRules::MaxBorderWidth = 20.0
 Upper bounds for the per-window border appearance overrides (SetBorderWidth / SetBorderRadius), in logical px, mirroring the PhosphorCompositor::DecorationDefaults BorderWidthMax / BorderRadiusMax slider ceilings.
constexpr double PhosphorRules::MaxBorderRadius = 50.0
constexpr double PhosphorRules::MinAnimationDurationMs = 50.0
 Bounds for the per-event animation duration override (OverrideAnimationTiming's optional durationMs), in ms.
constexpr double PhosphorRules::MaxAnimationDurationMs = 2000.0
constexpr double PhosphorRules::MaxGap = 200.0
 Upper bound for the context-domain gap actions (SetInnerGap, SetOuterGap, and the four per-side variants), in logical px.
constexpr double PhosphorRules::MinColumnWidthRatio = 0.05
 Bounds for a scrolling-engine work-area FRACTION, width or height.
constexpr double PhosphorRules::MaxColumnWidthRatio = 1.0
constexpr double PhosphorRules::MinFocusFollowsMouseMaxScrollRatio = 0.0
 Bounds for the focus-follows-mouse scroll cap, niri's max-scroll-amount, as a FRACTION of the viewport's extent along the strip.
constexpr double PhosphorRules::MaxFocusFollowsMouseMaxScrollRatio = 1.0
constexpr double PhosphorRules::MinTabIndicatorGap = -64.0
 Bounds for the tab-indicator numeric slots.
constexpr double PhosphorRules::MaxTabIndicatorGap = 64.0
constexpr double PhosphorRules::MinTabIndicatorWidth = 1.0
constexpr double PhosphorRules::MaxTabIndicatorWidth = 64.0
constexpr double PhosphorRules::TabIndicatorCornerRadiusPill = -1.0
constexpr double PhosphorRules::MaxTabIndicatorCornerRadius = 64.0
constexpr double PhosphorRules::MinTabIndicatorLengthRatio = 0.05
constexpr double PhosphorRules::MaxTabIndicatorLengthRatio = 1.0
constexpr double PhosphorRules::MinTabIndicatorFontWeight = 100.0
 Bounds for the tab label's font WEIGHT, the CSS/QFont::Weight scale where 400 is regular and 700 is bold.
constexpr double PhosphorRules::MaxTabIndicatorFontWeight = 900.0
constexpr double PhosphorRules::MinDropIndicatorOpacity = 0.0
 Drop-indicator numeric bounds, mirroring the config layer's (ConfigDefaults::scrollingDropIndicator*Min/Max) so a rule cannot author a value the settings page would refuse.
constexpr double PhosphorRules::MaxDropIndicatorOpacity = 1.0
constexpr double PhosphorRules::MinDropIndicatorBorderWidth = 0.0
constexpr double PhosphorRules::MaxDropIndicatorBorderWidth = 10.0
constexpr double PhosphorRules::MinDropIndicatorBorderRadius = 0.0
constexpr double PhosphorRules::MaxDropIndicatorBorderRadius = 50.0
constexpr double PhosphorRules::MinScrollFactor = 0.05
 Bounds for the ScrollFactor multiplier.
constexpr double PhosphorRules::MaxScrollFactor = 10.0
constexpr int PhosphorRules::MaxVirtualDesktopOrdinal = 1024
 Upper bound for a RouteToDesktop 1-based virtual-desktop number.
constexpr QLatin1StringView PhosphorRules::OverlayStyleToken::Rectangles {"rectangles"}
 OverlayDisplayMode::ZoneRectangles (0).
constexpr QLatin1StringView PhosphorRules::OverlayStyleToken::Preview {"preview"}
 OverlayDisplayMode::LayoutPreview (1).
constexpr QLatin1StringView PhosphorRules::InsertPositionToken::End {"end"}
 AutotileInsertPosition::End (0).
constexpr QLatin1StringView PhosphorRules::InsertPositionToken::AfterFocused {"afterFocused"}
 AfterFocused (1).
constexpr QLatin1StringView PhosphorRules::InsertPositionToken::AsMaster {"asMaster"}
 AsMaster (2).
constexpr QLatin1StringView PhosphorRules::OverflowBehaviorToken::Float {"float"}
 AutotileOverflowBehavior::Float (0).
constexpr QLatin1StringView PhosphorRules::OverflowBehaviorToken::Unlimited {"unlimited"}
 Unlimited (1).
constexpr QLatin1StringView PhosphorRules::DragBehaviorToken::Float {"float"}
 AutotileDragBehavior::Float (0).
constexpr QLatin1StringView PhosphorRules::DragBehaviorToken::Reorder {"reorder"}
 Reorder (1).
constexpr QLatin1StringView PhosphorRules::CenterFocusedColumnToken::Never {"never"}
 never re-centre (0)
constexpr QLatin1StringView PhosphorRules::CenterFocusedColumnToken::Always {"always"}
 always re-centre (1)
constexpr QLatin1StringView PhosphorRules::CenterFocusedColumnToken::OnOverflow {"onOverflow"}
 re-centre only when the row overflows (2)
constexpr QLatin1StringView PhosphorRules::ColumnDisplayToken::Normal {"normal"}
 windows share the column vertically (0)
constexpr QLatin1StringView PhosphorRules::ColumnDisplayToken::Tabbed {"tabbed"}
 windows stack as tabs (1)
constexpr QLatin1StringView PhosphorRules::TabIndicatorStyleToken::Chips {"chips"}
 a pill of titled chips (0)
constexpr QLatin1StringView PhosphorRules::TabIndicatorStyleToken::Bar {"bar"}
 a run of coloured segments (1)
constexpr QLatin1StringView PhosphorRules::TabIndicatorPositionToken::Left {"left"}
 (0)
constexpr QLatin1StringView PhosphorRules::TabIndicatorPositionToken::Right {"right"}
 (1)
constexpr QLatin1StringView PhosphorRules::TabIndicatorPositionToken::Top {"top"}
 (2)
constexpr QLatin1StringView PhosphorRules::TabIndicatorPositionToken::Bottom {"bottom"}
 (3)
constexpr QLatin1StringView PhosphorRules::ColumnPlacementToken::NewColumn {"newColumn"}
 open in a column of its own
constexpr QLatin1StringView PhosphorRules::ColumnPlacementToken::Consume {"consume"}
 consume into the focused column
constexpr QLatin1StringView PhosphorRules::ScrollInsertPositionToken::RightOfActive {"rightOfActive"}
constexpr QLatin1StringView PhosphorRules::ScrollInsertPositionToken::LeftOfActive {"leftOfActive"}
constexpr QLatin1StringView PhosphorRules::ScrollInsertPositionToken::First {"first"}
constexpr QLatin1StringView PhosphorRules::ScrollInsertPositionToken::Last {"last"}
constexpr QLatin1StringView PhosphorRules::ScrollInsertPositionToken::IntoActiveColumn {"intoActiveColumn"}
constexpr QLatin1StringView PhosphorRules::StickyWindowHandlingToken::TreatAsNormal {"treatAsNormal"}
constexpr QLatin1StringView PhosphorRules::StickyWindowHandlingToken::RestoreOnly {"restoreOnly"}
constexpr QLatin1StringView PhosphorRules::StickyWindowHandlingToken::IgnoreAll {"ignoreAll"}
constexpr QLatin1StringView PhosphorRules::StripAxisToken::Auto {"auto"}
constexpr QLatin1StringView PhosphorRules::StripAxisToken::Horizontal {"horizontal"}
constexpr QLatin1StringView PhosphorRules::StripAxisToken::Vertical {"vertical"}
constexpr QLatin1StringView PhosphorRules::WindowLayerToken::Above {"above"}
constexpr QLatin1StringView PhosphorRules::WindowLayerToken::Normal {"normal"}
constexpr QLatin1StringView PhosphorRules::WindowLayerToken::Below {"below"}
constexpr QLatin1StringView PhosphorRules::BorderColorToken::Accent {"accent"}