7#include <PhosphorLayer/phosphorlayer_export.h>
104class PHOSPHORLAYER_EXPORT
Surface :
public QObject
259 CtorToken() =
default;
274 std::unique_ptr<Impl> m_impl;
Abstracts the layer-shell protocol binding.
Definition ILayerShellTransport.h:111
Hook point for consumer-controlled QQmlEngine ownership policy.
Definition IQmlEngineProvider.h:40
Source-of-truth interface for the available QScreen set.
Definition IScreenProvider.h:62
Hook point for show/hide transitions on Surfaces.
Definition ISurfaceAnimator.h:51
Handle returned by attach(); lets the caller mutate post-show properties that the wlr-layer-shell pro...
Definition ILayerShellTransport.h:53
Stateless constructor for Surfaces.
Definition SurfaceFactory.h:35
Opaque construction token — only SurfaceFactory can create instances of it.
Definition Surface.h:257
friend class SurfaceFactory
Definition Surface.h:258
bool isLogicallyShown() const noexcept
Convenience: is the Surface in the logical "shown" state?
~Surface() override
Q_ENUM so QMetaEnum can stringify State values in log messages (State::Failed → "Failed") and so Q_PR...
friend class SurfaceFactory
Definition Surface.h:271
State state() const noexcept
void warmUp()
Create window + content (and, for contentUrl content, the engine that loads it), leave hidden.
State
Definition Surface.h:110
const SurfaceConfig & config() const noexcept
QQuickWindow * window() const noexcept
void stateChanged(State newState)
NOTIFY signal for the state Q_PROPERTY.
ITransportHandle * transport() const noexcept
Surface(CtorToken, SurfaceConfig cfg, SurfaceDeps deps, QObject *parent)
Protected so subclasses can forward a CtorToken through their own constructor.
void screenLost()
Emitted when the QScreen the Surface is bound to is removed from the IScreenProvider's list or destro...
void failed(const QString &reason)
Emitted once when transitioning to State::Failed.
void setKeyboardInteractivity(KeyboardInteractivity keyboard)
Change the surface's keyboard interactivity.
Definition SurfaceAnimator.h:26
KeyboardInteractivity
Keyboard focus policy (wlr-layer-shell v4 adds OnDemand).
Definition Role.h:51
Immutable per-surface configuration passed to SurfaceFactory::create().
Definition SurfaceConfig.h:47
Bundle of dependencies the Surface inherits from the factory.
Definition Surface.h:42
ILayerShellTransport * transport
Definition Surface.h:43
ISurfaceAnimator * animator
Phase-5 hook for show/hide visual transitions.
Definition Surface.h:60
IQmlEngineProvider * engineProvider
Definition Surface.h:44
IScreenProvider * screenProvider
Screen provider the Surface subscribes to for hot-unplug detection and its primary-screen fallback.
Definition Surface.h:49