PhosphorOverlay::ShellState Class Reference

#include <phosphor-overlay/include/PhosphorOverlay/ShellState.h>

Public Member Functions
	ShellState ()=default
	ShellState (const ShellState &)=delete
	ShellState (ShellState &&)=delete
ShellState &	operator= (const ShellState &)=delete
ShellState &	operator= (ShellState &&)=delete
PhosphorLayer::Surface *	shellSurface () const
	The layer-shell wl_surface backing this screen's overlay shell.
QQuickWindow *	shellWindow () const
	The QQuickWindow hosting the shell's QML scene tree.
QScreen *	physScreen () const
	The physical QScreen the shell was constructed against.

Public Attributes
QHash< QString, SlotEntry >	slots
	Per-content slot entries keyed by slot name (e.g.

Constructor & Destructor Documentation

ShellState() [1/3]

PhosphorOverlay::ShellState::ShellState ( )

default

ShellState() [2/3]

PhosphorOverlay::ShellState::ShellState ( const ShellState &  )

delete

ShellState() [3/3]

PhosphorOverlay::ShellState::ShellState ( ShellState &&  )

delete

Member Function Documentation

operator=() [1/2]

ShellState & PhosphorOverlay::ShellState::operator= ( const ShellState &  )

delete

operator=() [2/2]

ShellState & PhosphorOverlay::ShellState::operator= ( ShellState &&  )

delete

physScreen()

QScreen * PhosphorOverlay::ShellState::physScreen ( ) const

inline

The physical QScreen the shell was constructed against.

Used by hot-plug rekey logic to confirm the same monitor underlies the new key.

shellSurface()

PhosphorLayer::Surface * PhosphorOverlay::ShellState::shellSurface ( ) const

inline

The layer-shell wl_surface backing this screen's overlay shell.

Lifetime is managed by the Qt parent chain (the Surface is a QObject parented inside the SurfaceManager / consumer-owned engine), but ShellHost::destroyShell schedules deleteLater() explicitly so the wl_surface unmaps deterministically rather than at random parent-dtor time. nullptr means the shell has not been created yet (or was torn down and not yet re-created).

shellWindow()

QQuickWindow * PhosphorOverlay::ShellState::shellWindow ( ) const

inline

The QQuickWindow hosting the shell's QML scene tree.

Cached at create-time to avoid repeated shellSurface->window() calls in the hot per-show path.

Member Data Documentation

slots

QHash<QString, SlotEntry> PhosphorOverlay::ShellState::slots

Per-content slot entries keyed by slot name (e.g.

"osd", "snapAssist", "layoutPicker", "zoneSelector", "mainOverlay"). Each entry holds the slot's QQuickItem (borrowed; owned by the shell QQuickWindow's scene graph) plus the PhosphorLayer::Role the slot's SurfaceAnimator show/hide leg targets. Populated by the consumer's post-create callback and consumed by ShellHost::hideSlot to drive the animator without the consumer re-specifying the role at each call.

---

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

• phosphor-overlay/include/PhosphorOverlay/ShellState.h