Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
snapnavigationtargets.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
6#include "phosphorsnapengine_export.h"
9
10#include <QRect>
11#include <QString>
12#include <QStringList>
13
14#include <functional>
15
16namespace PhosphorZones {
17class LayoutRegistry;
18}
19
20namespace PhosphorScreens {
21class ScreenManager;
22}
23
24namespace PhosphorEngine {
26}
27
28namespace PhosphorSnapEngine {
29
30class ISettings;
32
37{
38 bool success = false;
39 QString reason;
45 QStringList zoneIds;
47 QRect geometry;
49 QString sourceZoneId;
50 QString screenName;
52 bool grew = false;
53};
54
62PHOSPHORSNAPENGINE_EXPORT bool isStoredScreenValid(PhosphorScreens::ScreenManager* mgr, const QString& storedScreen);
63
68inline QString oppositeCrossingDirection(const QString& direction)
69{
70 if (direction == QLatin1String("left")) {
71 return QStringLiteral("right");
72 }
73 if (direction == QLatin1String("right")) {
74 return QStringLiteral("left");
75 }
76 if (direction == QLatin1String("up")) {
77 return QStringLiteral("down");
78 }
79 if (direction == QLatin1String("down")) {
80 return QStringLiteral("up");
81 }
82 return {};
83}
84
117class PHOSPHORSNAPENGINE_EXPORT SnapNavigationTargetResolver
118{
119public:
126 std::function<void(bool success, const QString& action, const QString& reason, const QString& sourceZoneId,
127 const QString& targetZoneId, const QString& screenId)>;
128
138 PhosphorZones::LayoutRegistry* layoutManager, IZoneAdjacencyResolver* zoneAdjacency,
139 FeedbackFn feedback);
140
145
151
158 using NeighbourTilingFn = std::function<bool(const QString& screenId)>;
160
165 using LandingRefusalFn = std::function<QString(const QString& windowId, const QString& screenId)>;
167
172 std::function<QStringList(const QString& zoneId, const QString& screenId, const QString& excludeWindowId)>;
174
175 PhosphorProtocol::MoveTargetResult getMoveTargetForWindow(const QString& windowId, const QString& direction,
176 const QString& screenId);
177
194 SpanTargetResult getSpanTargetForWindow(const QString& windowId, const QString& direction, const QString& screenId);
195
196 PhosphorProtocol::FocusTargetResult getFocusTargetForWindow(const QString& windowId, const QString& direction,
197 const QString& screenId);
198
199 PhosphorProtocol::RestoreTargetResult getRestoreForWindow(const QString& windowId, const QString& screenId);
200
202 const QString& screenId);
203
204 PhosphorProtocol::SwapTargetResult getSwapTargetForWindow(const QString& windowId, const QString& direction,
205 const QString& screenId);
206
207 PhosphorProtocol::MoveTargetResult getPushTargetForWindow(const QString& windowId, const QString& screenId);
208
210 const QString& screenId);
211
212private:
221 bool hasDependencies() const
222 {
223 return m_service != nullptr && m_layoutManager != nullptr;
224 }
225
230 void emitFeedback(bool success, const QString& action, const QString& reason, const QString& sourceZoneId,
231 const QString& targetZoneId, const QString& screenId) const
232 {
233 if (m_feedback) {
234 m_feedback(success, action, reason, sourceZoneId, targetZoneId, screenId);
235 }
236 }
237
247 PhosphorProtocol::MoveTargetResult crossOutputEntryTarget(const QString& windowId, const QString& currentZoneId,
248 const QString& direction, const QString& sourceScreenId,
249 bool landsWindow) const;
250
259 PhosphorProtocol::SwapTargetResult crossOutputSwapTarget(const QString& windowId, const QString& currentZoneId,
260 const QString& direction,
261 const QString& sourceScreenId) const;
262
266 QString storedScreenOr(const QString& windowId, const QString& screenId) const;
267
270 QString adjacentZoneFor(const QString& windowId, const QString& currentZoneId, const QString& direction,
271 const QString& screenId) const;
272
280 QStringList windowsInZoneOnScreen(const QString& zoneId, const QString& screenName) const;
281
285 QString firstWindowInZoneOnScreen(const QString& zoneId, const QString& screenName,
286 const QString& excludeWindowId) const;
288 QStringList zoneOccupants(const QString& zoneId, const QString& screenName, const QString& excludeWindowId) const;
289
290 PhosphorEngine::IWindowTrackingService* m_service = nullptr;
291 PhosphorZones::LayoutRegistry* m_layoutManager = nullptr;
292 IZoneAdjacencyResolver* m_zoneAdjacency = nullptr;
293 PhosphorEngine::ICrossSurfaceResolver* m_crossSurface = nullptr;
294 FeedbackFn m_feedback;
295 NeighbourTilingFn m_neighbourIsTiling;
296 LandingRefusalFn m_landingRefusal;
297 ZoneOccupantsFn m_zoneOccupants;
298};
299
300} // namespace PhosphorSnapEngine
Resolves the neighbouring surface — output or virtual desktop — in a direction, for cross-surface win...
Definition ICrossSurfaceResolver.h:21
Definition IWindowTrackingService.h:35
Centralized screen-topology service.
Definition Manager.h:86
Narrow interface for zone-adjacency queries used by snap navigation.
Definition IZoneAdjacencyResolver.h:32
SpanTargetResult getSpanTargetForWindow(const QString &windowId, const QString &direction, const QString &screenId)
Compute the new zone span when the user grows/shrinks toward direction.
std::function< bool(const QString &screenId)> NeighbourTilingFn
Reports whether a neighbour OUTPUT is owned by a TILING engine — autotile or scrolling,...
Definition snapnavigationtargets.h:158
PhosphorProtocol::RestoreTargetResult getRestoreForWindow(const QString &windowId, const QString &screenId)
PhosphorProtocol::SwapTargetResult getSwapTargetForWindow(const QString &windowId, const QString &direction, const QString &screenId)
void setZoneAdjacencyResolver(IZoneAdjacencyResolver *resolver)
Late setter for the zone adjacency resolver — it may not be available at construction time,...
std::function< QStringList(const QString &zoneId, const QString &screenId, const QString &excludeWindowId)> ZoneOccupantsFn
The windows snapped in a zone on a screen in the context it shows, once each, without excludeWindowId...
Definition snapnavigationtargets.h:171
std::function< QString(const QString &windowId, const QString &screenId)> LandingRefusalFn
Why the landing context refuses windowId: "excluded" (an exclusion rule applies there),...
Definition snapnavigationtargets.h:165
std::function< void(bool success, const QString &action, const QString &reason, const QString &sourceZoneId, const QString &targetZoneId, const QString &screenId)> FeedbackFn
Callback shape matching SnapEngine::navigationFeedback (and the WindowTrackingAdaptor signal it is ul...
Definition snapnavigationtargets.h:125
PhosphorProtocol::MoveTargetResult getMoveTargetForWindow(const QString &windowId, const QString &direction, const QString &screenId)
void setCrossSurfaceResolver(PhosphorEngine::ICrossSurfaceResolver *resolver)
Late setter for the cross-surface resolver (neighbour output / desktop lookup).
SnapNavigationTargetResolver(PhosphorEngine::IWindowTrackingService *service, PhosphorZones::LayoutRegistry *layoutManager, IZoneAdjacencyResolver *zoneAdjacency, FeedbackFn feedback)
Construct the resolver with its pure dependencies.
PhosphorProtocol::FocusTargetResult getFocusTargetForWindow(const QString &windowId, const QString &direction, const QString &screenId)
PhosphorProtocol::MoveTargetResult getSnapToZoneByNumberTarget(const QString &windowId, int zoneNumber, const QString &screenId)
PhosphorProtocol::CycleTargetResult getCycleTargetForWindow(const QString &windowId, bool forward, const QString &screenId)
void setNeighbourTilingProvider(NeighbourTilingFn fn)
PhosphorProtocol::MoveTargetResult getPushTargetForWindow(const QString &windowId, const QString &screenId)
void setLandingRefusalProvider(LandingRefusalFn fn)
Manual zone-layout registry + per-context assignment store.
Definition LayoutRegistry.h:87
Definition DesktopRemap.h:12
Definition IWindowTrackingService.h:28
Definition SnapStateResolver.h:16
QString oppositeCrossingDirection(const QString &direction)
The edge a neighbour surface is entered from when crossing in direction: crossing "right" lands on th...
Definition snapnavigationtargets.h:68
PHOSPHORSNAPENGINE_EXPORT bool isStoredScreenValid(PhosphorScreens::ScreenManager *mgr, const QString &storedScreen)
True when storedScreen still resolves on the live screen set, judged by mgr: a physical id must be a ...
Definition IWindowTrackingService.h:24
D-Bus struct for cycle navigation result: (bssss).
Definition NavigationTypes.h:72
D-Bus struct for focus navigation result: (bsssss).
Definition NavigationTypes.h:61
D-Bus struct for move/push/zone-number navigation result: (bssiiiiss).
Definition NavigationTypes.h:42
D-Bus struct for restore navigation result: (bbiiii).
Definition NavigationTypes.h:110
D-Bus struct for swap navigation result: (bssiiiissiiiisssss).
Definition NavigationTypes.h:82
Result of a span (grow/shrink) target computation.
Definition snapnavigationtargets.h:37
QRect geometry
Union rect of the new span's zone geometries.
Definition snapnavigationtargets.h:47
bool success
Definition snapnavigationtargets.h:38
QString sourceZoneId
Primary zone before the change (empty when the window was unsnapped).
Definition snapnavigationtargets.h:49
QString reason
Definition snapnavigationtargets.h:39
QString screenName
Definition snapnavigationtargets.h:50
bool grew
true when the span grew into new zone(s), false when it retracted.
Definition snapnavigationtargets.h:52
QStringList zoneIds
The window's full NEW span set, primary zone first.
Definition snapnavigationtargets.h:45