Phosphor
Qt6 / Wayland library suite for window-management tools
 
Loading...
Searching...
No Matches
PhosphorEngine::SnapResult Struct Reference

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

Public Member Functions

bool isValid () const
 

Static Public Member Functions

static SnapResult noSnap ()
 

Public Attributes

bool shouldSnap = false
 
QRect geometry
 
QString zoneId
 
QStringList zoneIds
 
QString screenId
 
bool deferredToTilingEngine = false
 Set (with shouldSnap false) when snap's resolve stood down because the record homes the window TILED on another engine's screen — the signal for the SnapAdaptor to offer the window to the tiling engines' claimCrossScreenReopen, and for nothing else.
 
int virtualDesktop = 0
 Target virtual desktop the snap should be committed in (1-based).
 

Member Function Documentation

◆ isValid()

bool PhosphorEngine::SnapResult::isValid ( ) const
inline

◆ noSnap()

static SnapResult PhosphorEngine::SnapResult::noSnap ( )
inlinestatic

Member Data Documentation

◆ deferredToTilingEngine

bool PhosphorEngine::SnapResult::deferredToTilingEngine = false

Set (with shouldSnap false) when snap's resolve stood down because the record homes the window TILED on another engine's screen — the signal for the SnapAdaptor to offer the window to the tiling engines' claimCrossScreenReopen, and for nothing else.

Distinguished from a plain no-snap so the reclaim runs ONLY on this verdict: an exclusion refusal, a disabled context, or an ordinary no-match must not hand the window to a reclaim the user's rules or gates already vetoed.

◆ geometry

QRect PhosphorEngine::SnapResult::geometry

◆ screenId

QString PhosphorEngine::SnapResult::screenId

◆ shouldSnap

bool PhosphorEngine::SnapResult::shouldSnap = false

◆ virtualDesktop

int PhosphorEngine::SnapResult::virtualDesktop = 0

Target virtual desktop the snap should be committed in (1-based).

0 means "the window's current desktop" — the historical behaviour. Set non-zero only by a placement rule that also routes the window to a desktop (RouteToDesktop), so the zone assignment is recorded on the desktop the window ends up on, not the one it momentarily opened on.

◆ zoneId

QString PhosphorEngine::SnapResult::zoneId

◆ zoneIds

QStringList PhosphorEngine::SnapResult::zoneIds

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