Phosphor
Qt6 / Wayland library suite for window-management tools
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
PhosphorEngine::IWindowTrackingService Class Referenceabstract

#include <phosphor-engine/include/PhosphorEngine/IWindowTrackingService.h>

Inheritance diagram for PhosphorEngine::IWindowTrackingService:
[legend]

Public Member Functions

virtual ~IWindowTrackingService ()=default
 
virtual QObject * asQObject ()=0
 
virtual PhosphorScreens::ScreenManager * screenManager () const =0
 
virtual void assignWindowToZone (const QString &windowId, const QString &zoneId, const QString &screenId, int virtualDesktop)=0
 
virtual void assignWindowToZones (const QString &windowId, const QStringList &zoneIds, const QString &screenId, int virtualDesktop)=0
 
virtual void unassignWindow (const QString &windowId)=0
 
virtual const QHash< QString, QStringList > & zoneAssignments () const =0
 
virtual QStringList recordedSnapZones (const QString &windowId) const =0
 A window's recorded snap zone(s), preferring the LIVE assignment but falling back to the DURABLE placement-record snap slot when the live cache is cold.
 
virtual const QHash< QString, QString > & screenAssignments () const =0
 
virtual QString zoneForWindow (const QString &windowId) const =0
 
virtual QStringList zonesForWindow (const QString &windowId) const =0
 
virtual QString screenForWindow (const QString &windowId) const =0
 The screen a window is assigned to (empty when none), canonicalizing the id — the point accessor callers use instead of screenAssignments().value() so a window resolves across the effect-restart re-identification skew (#628).
 
virtual QString screenForWindow (const QString &windowId, const QString &defaultScreen) const =0
 Same, returning defaultScreen when the window has no assignment.
 
virtual QStringList windowsInZone (const QString &zoneId) const =0
 
virtual bool isWindowSnapped (const QString &windowId) const =0
 
virtual QString findEmptyZone (const QString &screenId=QString()) const =0
 
virtual void recordSnapIntent (const QString &windowId, bool wasUserInitiated)=0
 
virtual bool isWindowFloating (const QString &windowId) const =0
 
virtual void setWindowFloating (const QString &windowId, bool floating)=0
 
virtual void unsnapForFloat (const QString &windowId)=0
 
virtual bool clearFloatingForSnap (const QString &windowId)=0
 
virtual bool isWindowSticky (const QString &windowId) const =0
 
virtual QStringList preFloatZones (const QString &windowId) const =0
 
virtual QString preFloatScreen (const QString &windowId) const =0
 
virtual bool clearAutoSnapped (const QString &windowId)=0
 
virtual bool consumePendingAssignment (const QString &windowId)=0
 
virtual const QHash< QString, QList< PendingRestore > > & pendingRestoreQueues () const =0
 
virtual void updateLastUsedZone (const QString &zoneId, const QString &screenId, const QString &windowClass, int virtualDesktop)=0
 
virtual QString currentAppIdFor (const QString &anyWindowId) const =0
 
virtual std::optional< QRect > validatedUnmanagedGeometry (const QString &windowId, const QString &screenId, bool exactOnly=false) const =0
 
virtual void recordFreeGeometry (const QString &windowId, const QString &screenId, const QRect &geometry, bool overwrite)=0
 Record a window's SHARED free/float geometry (the single float-back store — the placement record's freeGeometryByScreen).
 
virtual void clearFreeGeometry (const QString &windowId)=0
 Clear a window's shared free/float geometry (all screens) from the record, leaving its engine slots intact.
 
virtual QRect zoneGeometry (const QString &zoneId, const QString &screenId=QString()) const =0
 
virtual QRect resolveZoneGeometry (const QStringList &zoneIds, const QString &screenId) const =0
 
virtual QString resolveEffectiveScreenId (const QString &screenId) const =0
 
virtual WindowPlacementStore & placementStore ()=0
 The unified, engine-agnostic placement store.
 
virtual QString findEmptyZoneInLayout (PhosphorZones::Layout *layout, const QString &screenId, int desktopFilter=0) const =0
 
virtual QSet< QUuid > buildOccupiedZoneSet (const QString &screenFilter=QString(), int desktopFilter=0) const =0
 
virtual QVector< ResnapEntry > takeResnapBuffer ()=0
 

Constructor & Destructor Documentation

◆ ~IWindowTrackingService()

virtual PhosphorEngine::IWindowTrackingService::~IWindowTrackingService ( )
virtualdefault

Member Function Documentation

◆ asQObject()

virtual QObject * PhosphorEngine::IWindowTrackingService::asQObject ( )
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ assignWindowToZone()

virtual void PhosphorEngine::IWindowTrackingService::assignWindowToZone ( const QString &  windowId,
const QString &  zoneId,
const QString &  screenId,
int  virtualDesktop 
)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ assignWindowToZones()

virtual void PhosphorEngine::IWindowTrackingService::assignWindowToZones ( const QString &  windowId,
const QStringList &  zoneIds,
const QString &  screenId,
int  virtualDesktop 
)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ buildOccupiedZoneSet()

virtual QSet< QUuid > PhosphorEngine::IWindowTrackingService::buildOccupiedZoneSet ( const QString &  screenFilter = QString(),
int  desktopFilter = 0 
) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ clearAutoSnapped()

virtual bool PhosphorEngine::IWindowTrackingService::clearAutoSnapped ( const QString &  windowId)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ clearFloatingForSnap()

virtual bool PhosphorEngine::IWindowTrackingService::clearFloatingForSnap ( const QString &  windowId)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ clearFreeGeometry()

virtual void PhosphorEngine::IWindowTrackingService::clearFreeGeometry ( const QString &  windowId)
pure virtual

Clear a window's shared free/float geometry (all screens) from the record, leaving its engine slots intact.

For the drag-out / layout-change consume paths that restore the float-back once and must not re-apply it.

Implemented in PhosphorPlacement::WindowTrackingService.

◆ consumePendingAssignment()

virtual bool PhosphorEngine::IWindowTrackingService::consumePendingAssignment ( const QString &  windowId)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ currentAppIdFor()

virtual QString PhosphorEngine::IWindowTrackingService::currentAppIdFor ( const QString &  anyWindowId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ findEmptyZone()

virtual QString PhosphorEngine::IWindowTrackingService::findEmptyZone ( const QString &  screenId = QString()) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ findEmptyZoneInLayout()

virtual QString PhosphorEngine::IWindowTrackingService::findEmptyZoneInLayout ( PhosphorZones::Layout *  layout,
const QString &  screenId,
int  desktopFilter = 0 
) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ isWindowFloating()

virtual bool PhosphorEngine::IWindowTrackingService::isWindowFloating ( const QString &  windowId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ isWindowSnapped()

virtual bool PhosphorEngine::IWindowTrackingService::isWindowSnapped ( const QString &  windowId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ isWindowSticky()

virtual bool PhosphorEngine::IWindowTrackingService::isWindowSticky ( const QString &  windowId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ pendingRestoreQueues()

virtual const QHash< QString, QList< PendingRestore > > & PhosphorEngine::IWindowTrackingService::pendingRestoreQueues ( ) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ placementStore()

virtual WindowPlacementStore & PhosphorEngine::IWindowTrackingService::placementStore ( )
pure virtual

The unified, engine-agnostic placement store.

Engines reach it through the tracking service to capture/restore the one WindowPlacement per window.

Implemented in PhosphorPlacement::WindowTrackingService.

◆ preFloatScreen()

virtual QString PhosphorEngine::IWindowTrackingService::preFloatScreen ( const QString &  windowId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ preFloatZones()

virtual QStringList PhosphorEngine::IWindowTrackingService::preFloatZones ( const QString &  windowId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ recordedSnapZones()

virtual QStringList PhosphorEngine::IWindowTrackingService::recordedSnapZones ( const QString &  windowId) const
pure virtual

A window's recorded snap zone(s), preferring the LIVE assignment but falling back to the DURABLE placement-record snap slot when the live cache is cold.

The live zoneAssignments() map is runtime-only — a daemon restart (and handoffRelease on autotile entry) clears it — so consumers that must survive a restart (the autotile→snap resnap) read this instead. Returns an empty list for a window that was never snapped in either source.

Implemented in PhosphorPlacement::WindowTrackingService.

◆ recordFreeGeometry()

virtual void PhosphorEngine::IWindowTrackingService::recordFreeGeometry ( const QString &  windowId,
const QString &  screenId,
const QRect &  geometry,
bool  overwrite 
)
pure virtual

Record a window's SHARED free/float geometry (the single float-back store — the placement record's freeGeometryByScreen).

This is the ONE writer all float-back captures route through (effect pre-tile/pre-snap capture, drag store, float-toggle capture), so snap and autotile read the same value and never drift. overwrite=false leaves an existing entry for screenId untouched (first-capture-wins). No-op on an invalid geometry.

Implemented in PhosphorPlacement::WindowTrackingService.

◆ recordSnapIntent()

virtual void PhosphorEngine::IWindowTrackingService::recordSnapIntent ( const QString &  windowId,
bool  wasUserInitiated 
)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ resolveEffectiveScreenId()

virtual QString PhosphorEngine::IWindowTrackingService::resolveEffectiveScreenId ( const QString &  screenId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ resolveZoneGeometry()

virtual QRect PhosphorEngine::IWindowTrackingService::resolveZoneGeometry ( const QStringList &  zoneIds,
const QString &  screenId 
) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ screenAssignments()

virtual const QHash< QString, QString > & PhosphorEngine::IWindowTrackingService::screenAssignments ( ) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ screenForWindow() [1/2]

virtual QString PhosphorEngine::IWindowTrackingService::screenForWindow ( const QString &  windowId) const
pure virtual

The screen a window is assigned to (empty when none), canonicalizing the id — the point accessor callers use instead of screenAssignments().value() so a window resolves across the effect-restart re-identification skew (#628).

Implemented in PhosphorPlacement::WindowTrackingService.

◆ screenForWindow() [2/2]

virtual QString PhosphorEngine::IWindowTrackingService::screenForWindow ( const QString &  windowId,
const QString &  defaultScreen 
) const
pure virtual

Same, returning defaultScreen when the window has no assignment.

Implemented in PhosphorPlacement::WindowTrackingService.

◆ screenManager()

virtual PhosphorScreens::ScreenManager * PhosphorEngine::IWindowTrackingService::screenManager ( ) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ setWindowFloating()

virtual void PhosphorEngine::IWindowTrackingService::setWindowFloating ( const QString &  windowId,
bool  floating 
)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ takeResnapBuffer()

virtual QVector< ResnapEntry > PhosphorEngine::IWindowTrackingService::takeResnapBuffer ( )
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ unassignWindow()

virtual void PhosphorEngine::IWindowTrackingService::unassignWindow ( const QString &  windowId)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ unsnapForFloat()

virtual void PhosphorEngine::IWindowTrackingService::unsnapForFloat ( const QString &  windowId)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ updateLastUsedZone()

virtual void PhosphorEngine::IWindowTrackingService::updateLastUsedZone ( const QString &  zoneId,
const QString &  screenId,
const QString &  windowClass,
int  virtualDesktop 
)
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ validatedUnmanagedGeometry()

virtual std::optional< QRect > PhosphorEngine::IWindowTrackingService::validatedUnmanagedGeometry ( const QString &  windowId,
const QString &  screenId,
bool  exactOnly = false 
) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ windowsInZone()

virtual QStringList PhosphorEngine::IWindowTrackingService::windowsInZone ( const QString &  zoneId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ zoneAssignments()

virtual const QHash< QString, QStringList > & PhosphorEngine::IWindowTrackingService::zoneAssignments ( ) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ zoneForWindow()

virtual QString PhosphorEngine::IWindowTrackingService::zoneForWindow ( const QString &  windowId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ zoneGeometry()

virtual QRect PhosphorEngine::IWindowTrackingService::zoneGeometry ( const QString &  zoneId,
const QString &  screenId = QString() 
) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

◆ zonesForWindow()

virtual QStringList PhosphorEngine::IWindowTrackingService::zonesForWindow ( const QString &  windowId) const
pure virtual

Implemented in PhosphorPlacement::WindowTrackingService.

The documentation for this class was generated from the following file: