Enum FocusTarget 

pub enum FocusTarget {
    Window(Window),
    Popup(PopupKind),
    LayerSurface(LayerSurface),
    Subsurface(WlSurface, Box<FocusTarget>),
}

Input-event target for Smithay’s seat handlers. Smithay requires a concrete type as the “target” of a keyboard / pointer / touch event; FocusTarget bridges that to the concrete Wayland surface behind a window, popup, or layer surface.

Variants

Window(Window)

Popup(PopupKind)

LayerSurface(LayerSurface)

Subsurface(WlSurface, Box<FocusTarget>)

A subsurface under the pointer, which takes the pointer’s events on its own surface (a browser draws its permission and menu bubbles so), with the window, popup, or layer surface it belongs to, which everything but those events goes by: the keyboard, the window policy, a grab’s window.

Implementations

impl FocusTarget

pub(crate) fn owner(&self) -> &FocusTarget

The window, popup, or layer surface this target is, or a subsurface belongs to.

fn under_point( self, origin: Point<f64, Logical>, p: Point<f64, Logical>, ) -> (FocusTarget, Point<f64, Logical>)

This target, or the subsurface of its surface tree that takes input at the logical point p where one does, with the origin pointer events there are local to; origin is where this target’s own surface lies. A point the tree takes no input at leaves the target as it is.

Trait Implementations

impl Clone for FocusTarget

fn clone(&self) -> FocusTarget

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FocusTarget

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DndFocus<AppState> for FocusTarget

Forward drag-and-drop focus events (enter / motion / leave / drop) to the wrapped target’s underlying wl_surface, reusing the WlSurface offer-data type.

type OfferData<S: Source> = <WlSurface as DndFocus<AppState>>::OfferData<S>

OfferData implementation returned by this target

fn enter<S: Source>( &self, data: &mut AppState, dh: &DisplayHandle, source: Arc<S>, seat: &Seat<AppState>, location: Point<f64, Logical>, serial: &Serial, ) -> Option<Self::OfferData<S>>

An active Drag’n’Drop operation has entered the client

fn motion<S: Source>( &self, data: &mut AppState, offer: Option<&mut Self::OfferData<S>>, seat: &Seat<AppState>, location: Point<f64, Logical>, time: InputTime, )

An active Drag’n’Drop operation, which has previously entered the client, has been moved

fn leave<S: Source>( &self, data: &mut AppState, offer: Option<&mut Self::OfferData<S>>, seat: &Seat<AppState>, )

An active Drag’n’Drop operation, which has previously entered the client, left again.

fn drop<S: Source>( &self, data: &mut AppState, offer: Option<&mut Self::OfferData<S>>, seat: &Seat<AppState>, )

An active Drag’n’Drop operation, which has previously entered the client, has been dropped.

impl From<LayerSurface> for FocusTarget

Wrap a layer surface as a focus target.

fn from(l: DesktopLayerSurface) -> Self

Converts to this type from the input type.

impl From<PopupKind> for FocusTarget

Wrap a popup as a focus target.

fn from(p: PopupKind) -> Self

Converts to this type from the input type.

impl From<Window> for FocusTarget

Wrap a Window as a focus target.

fn from(w: Window) -> Self

Converts to this type from the input type.

impl IsAlive for FocusTarget

Liveness of a focus target: true while its underlying window / popup / layer surface is still alive, so dead targets are dropped from focus.

fn alive(&self) -> bool

Check if object is alive

impl KeyboardTarget<AppState> for FocusTarget

Forward every keyboard event (enter / leave / key / modifiers) to the wrapped target’s underlying wl_surface, which carries Smithay’s real keyboard-target implementation; a subsurface’s events go to the surface it belongs to, since keyboard focus is a whole window’s.

fn enter( &self, seat: &Seat<AppState>, data: &mut AppState, keys: Vec<KeysymHandle<'_>>, serial: Serial, )

Keyboard focus of a given seat was assigned to this handler

fn leave(&self, seat: &Seat<AppState>, data: &mut AppState, serial: Serial)

The keyboard focus of a given seat left this handler

fn key( &self, seat: &Seat<AppState>, data: &mut AppState, key: KeysymHandle<'_>, state: KeyState, serial: Serial, time: InputTime, )

A key was pressed on a keyboard from a given seat

fn modifiers( &self, seat: &Seat<AppState>, data: &mut AppState, modifiers: ModifiersState, serial: Serial, )

Hold modifiers were changed on a keyboard from a given seat

fn replace( &self, replaced: <D as SeatHandler>::KeyboardFocus, seat: &Seat<D>, data: &mut D, keys: Vec<KeysymHandle<'_>>, modifiers: ModifiersState, serial: Serial, )

Keyboard focus of a given seat moved from another handler to this handler

impl PartialEq for FocusTarget

fn eq(&self, other: &FocusTarget) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PointerTarget<AppState> for FocusTarget

Forward every pointer event (motion, buttons, axis, and all swipe / pinch / hold gesture phases) to the wrapped target’s underlying wl_surface.

fn enter(&self, seat: &Seat<AppState>, data: &mut AppState, event: &MotionEvent)

A pointer of a given seat entered this handler

fn motion( &self, seat: &Seat<AppState>, data: &mut AppState, event: &MotionEvent, )

A pointer of a given seat moved over this handler

fn relative_motion( &self, seat: &Seat<AppState>, data: &mut AppState, event: &RelativeMotionEvent, )

A pointer of a given seat that provides relative motion moved over this handler

fn button( &self, seat: &Seat<AppState>, data: &mut AppState, event: &ButtonEvent, )

A pointer of a given seat clicked a button

fn axis(&self, seat: &Seat<AppState>, data: &mut AppState, frame: AxisFrame)

A pointer of a given seat scrolled on an axis

fn frame(&self, seat: &Seat<AppState>, data: &mut AppState)

End of a pointer frame

fn leave( &self, seat: &Seat<AppState>, data: &mut AppState, serial: Serial, time: InputTime, )

A pointer of a given seat left this handler

fn gesture_swipe_begin( &self, seat: &Seat<AppState>, data: &mut AppState, event: &GestureSwipeBeginEvent, )

A pointer of a given seat started a swipe gesture

fn gesture_swipe_update( &self, seat: &Seat<AppState>, data: &mut AppState, event: &GestureSwipeUpdateEvent, )

A pointer of a given seat updated a swipe gesture

fn gesture_swipe_end( &self, seat: &Seat<AppState>, data: &mut AppState, event: &GestureSwipeEndEvent, )

A pointer of a given seat ended a swipe gesture

fn gesture_pinch_begin( &self, seat: &Seat<AppState>, data: &mut AppState, event: &GesturePinchBeginEvent, )

A pointer of a given seat started a pinch gesture

fn gesture_pinch_update( &self, seat: &Seat<AppState>, data: &mut AppState, event: &GesturePinchUpdateEvent, )

A pointer of a given seat updated a pinch gesture

fn gesture_pinch_end( &self, seat: &Seat<AppState>, data: &mut AppState, event: &GesturePinchEndEvent, )

A pointer of a given seat ended a pinch gesture

fn gesture_hold_begin( &self, seat: &Seat<AppState>, data: &mut AppState, event: &GestureHoldBeginEvent, )

A pointer of a given seat started a hold gesture

fn gesture_hold_end( &self, seat: &Seat<AppState>, data: &mut AppState, event: &GestureHoldEndEvent, )

A pointer of a given seat ended a hold gesture

fn replace( &self, replaced: <D as SeatHandler>::PointerFocus, seat: &Seat<D>, data: &mut D, event: &MotionEvent, )

A pointer of a given seat moved from another handler to this handler

impl StructuralPartialEq for FocusTarget

impl TouchTarget<AppState> for FocusTarget

Forward every touch event (down / up / motion / frame / cancel / shape / orientation) to the wrapped target’s underlying wl_surface.

fn down(&self, seat: &Seat<AppState>, data: &mut AppState, event: &DownEvent)

A new touch point has appeared on the target.

fn up(&self, seat: &Seat<AppState>, data: &mut AppState, event: &UpEvent)

The touch point has disappeared.

fn motion( &self, seat: &Seat<AppState>, data: &mut AppState, event: &MotionEvent, )

A touch point has changed coordinates.

fn frame(&self, seat: &Seat<AppState>, data: &mut AppState, marker: FrameMarker)

Indicates the end of a set of events that logically belong together.

fn cancel( &self, seat: &Seat<AppState>, data: &mut AppState, marker: FrameMarker, )

Touch session cancelled.

fn shape(&self, seat: &Seat<AppState>, data: &mut AppState, event: &ShapeEvent)

Sent when a touch point has changed its shape.

fn orientation( &self, seat: &Seat<AppState>, data: &mut AppState, event: &OrientationEvent, )

Sent when a touch point has changed its orientation.

fn last_frame( &self, seat: &Seat<AppState>, data: &mut AppState, ) -> Option<FrameMarker>

Returns last know [FrameMarker].

impl WaylandFocus for FocusTarget

Expose the wrapped target’s underlying wl_surface and same-client checks so Smithay can route focus and selection ownership by client.

fn wl_surface(&self) -> Option<Cow<'_, WlSurface>>

Returns the underlying wl_surface, if any.

fn same_client_as(&self, object_id: &ObjectId) -> bool

Returns true, if the underlying wayland object originates from the same client connection as the provided ObjectId.