Struct SpellWin 

pub struct SpellWin { /* private fields */ }

SpellWin is the main type for implementing widgets, it covers various properties and trait implementation, thus providing various features.

Panics

The constructor method conjure_spells will panic if the number of WindowConfs provided is not equal to the amount of widgets that are initialised in the scope. The solution to avoid panic is to add more let _ = WidgetName::new().unwrap(); for all the widgets/window components you are declaring in your slint files and adding WindowConfs for in SpellMultiWinHandler.

Implementations

impl SpellWin

pub fn get_handler(&mut self) -> Sender<Handle>

retrive the sender handle to pass Handle events to the windows.

pub fn invoke_spell(name: &str, window_conf: WindowConf) -> Self

This function is called to create a instance of window. This window is then finally called by cast_spell event loop.

Panics

This function needs to be called “before” initialising the slint window to avoid panicing of this function.

pub fn hide(&self)

Hides the layer (aka the widget) if it is visible in screen.

pub fn show_again(&mut self)

Brings back the layer (aka the widget) back on screen if it is hidden.

pub fn toggle(&mut self)

Hides the widget if visible or shows the widget back if hidden.

pub fn add_input_region(&self, x: i32, y: i32, width: i32, height: i32)

This function adds specific rectangular regions of your complete layer to receive input events from pointer and/or touch. The coordinates are in surface local format from top left corener. By default, The whole layer is considered for input events. Adding existing areas again as input region has no effect. This function combined with transparent base widgets can be used to mimic resizable widgets.

pub fn subtract_input_region(&self, x: i32, y: i32, width: i32, height: i32)

This function subtracts specific rectangular regions of your complete layer from receiving input events from pointer and/or touch. The coordinates are in surface local format from top left corener. By default, The whole layer is considered for input events. Substracting input areas which are already not input regions has no effect.

pub fn add_opaque_region(&self, x: i32, y: i32, width: i32, height: i32)

This function marks specific rectangular regions of your complete layer as opaque. This can result in specific optimisations from your wayland compositor, setting this property is optional. The coordinates are in surface local format from top left corener. Not adding opaque regions in it has no isuues but adding transparent regions of layer as opaque can cause weird behaviour and glitches.

pub fn subtract_opaque_region(&self, x: i32, y: i32, width: i32, height: i32)

This function removes specific rectangular regions of your complete layer from being opaque. This can result in specific optimisations from your wayland compositor, setting this property is optional. The coordinates are in surface local format from top left corener.

pub fn grab_focus(&self)

Grabs the focus of keyboard. Can be used in combination with other functions to make the widgets keyboard navigable.

pub fn remove_focus(&self)

Removes the focus of keyboard from window if it currently has it.

Trait Implementations

impl CompositorHandler for SpellWin

fn scale_factor_changed( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _surface: &WlSurface, _new_factor: i32, )

The surface has either been moved into or out of an output and the output has a different scale factor.

fn transform_changed( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _surface: &WlSurface, _new_transform: Transform, )

The surface has either been moved into or out of an output and the output has different transform.

fn frame( &mut self, _conn: &Connection, qh: &QueueHandle<Self>, _surface: &WlSurface, _time: u32, )

A frame callback has been completed.

fn surface_enter( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _surface: &WlSurface, _output: &WlOutput, )

The surface has entered an output.

fn surface_leave( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _surface: &WlSurface, _output: &WlOutput, )

The surface has left an output.

impl Debug for SpellWin

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

Formats the value using the given formatter.

impl Dispatch<WlCallback, WlSurface> for SpellWin

fn event( state: &mut Self, proxy: &WlCallback, event: <WlCallback as Proxy>::Event, data: &WlSurface, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WlCompositor, GlobalData> for SpellWin

fn event( state: &mut Self, proxy: &WlCompositor, event: <WlCompositor as Proxy>::Event, data: &GlobalData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WlKeyboard, KeyboardData<SpellWin>> for SpellWin

fn event( state: &mut Self, proxy: &WlKeyboard, event: <WlKeyboard as Proxy>::Event, data: &KeyboardData<SpellWin>, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WlOutput, OutputData> for SpellWin

fn event( state: &mut Self, proxy: &WlOutput, event: <WlOutput as Proxy>::Event, data: &OutputData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WlPointer, PointerData> for SpellWin

fn event( state: &mut Self, proxy: &WlPointer, event: <WlPointer as Proxy>::Event, data: &PointerData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WlRegistry, GlobalListContents> for SpellWin

fn event( state: &mut Self, proxy: &WlRegistry, event: <WlRegistry as Proxy>::Event, data: &GlobalListContents, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WlSeat, SeatData> for SpellWin

fn event( state: &mut Self, proxy: &WlSeat, event: <WlSeat as Proxy>::Event, data: &SeatData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WlShm, GlobalData> for SpellWin

fn event( state: &mut Self, proxy: &WlShm, event: <WlShm as Proxy>::Event, data: &GlobalData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WlSurface, SurfaceData> for SpellWin

fn event( state: &mut Self, proxy: &WlSurface, event: <WlSurface as Proxy>::Event, data: &SurfaceData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WpCursorShapeDeviceV1, GlobalData> for SpellWin

fn event( state: &mut Self, proxy: &WpCursorShapeDeviceV1, event: <WpCursorShapeDeviceV1 as Proxy>::Event, data: &GlobalData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<WpCursorShapeManagerV1, GlobalData> for SpellWin

fn event( state: &mut Self, proxy: &WpCursorShapeManagerV1, event: <WpCursorShapeManagerV1 as Proxy>::Event, data: &GlobalData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<ZwlrLayerShellV1, GlobalData> for SpellWin

fn event( state: &mut Self, proxy: &ZwlrLayerShellV1, event: <ZwlrLayerShellV1 as Proxy>::Event, data: &GlobalData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<ZwlrLayerSurfaceV1, LayerSurfaceData> for SpellWin

fn event( state: &mut Self, proxy: &ZwlrLayerSurfaceV1, event: <ZwlrLayerSurfaceV1 as Proxy>::Event, data: &LayerSurfaceData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<ZxdgOutputManagerV1, GlobalData> for SpellWin

fn event( state: &mut Self, proxy: &ZxdgOutputManagerV1, event: <ZxdgOutputManagerV1 as Proxy>::Event, data: &GlobalData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl Dispatch<ZxdgOutputV1, OutputData> for SpellWin

fn event( state: &mut Self, proxy: &ZxdgOutputV1, event: <ZxdgOutputV1 as Proxy>::Event, data: &OutputData, conn: &Connection, qhandle: &QueueHandle<Self>, )

Called when an event from the server is processed

fn event_created_child( opcode: u16, qhandle: &QueueHandle<Self>, ) -> Arc<dyn ObjectData>

Method used to initialize the user-data of objects created by events

impl KeyboardHandler for SpellWin

fn enter( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _keyboard: &WlKeyboard, _surface: &WlSurface, _serial: u32, _raw: &[u32], _keysyms: &[Keysym], )

The keyboard has entered a surface.

fn leave( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _keyboard: &WlKeyboard, _surface: &WlSurface, _serial: u32, )

The keyboard has left a surface.

fn press_key( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _keyboard: &WlKeyboard, _serial: u32, event: KeyEvent, )

A key has been pressed on the keyboard.

fn release_key( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _keyboard: &WlKeyboard, _serial: u32, event: KeyEvent, )

A key has been released.

fn update_modifiers( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _keyboard: &WlKeyboard, _serial: u32, _modifiers: Modifiers, _raw_modifiers: RawModifiers, _layout: u32, )

Keyboard modifiers have been updated.

fn update_repeat_info( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _keyboard: &WlKeyboard, _info: RepeatInfo, )

The keyboard has updated the rate and delay between repeating key inputs.

fn repeat_key( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _keyboard: &WlKeyboard, _serial: u32, _event: KeyEvent, )

A key has been previously pressed and is now repeating.

fn update_keymap( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _keyboard: &WlKeyboard, _keymap: Keymap<'_>, )

Keyboard keymap has been updated.

impl LayerShellHandler for SpellWin

fn closed( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _layer: &LayerSurface, )

The layer surface has been closed.

fn configure( &mut self, _conn: &Connection, qh: &QueueHandle<Self>, _layer: &LayerSurface, _configure: LayerSurfaceConfigure, _serial: u32, )

Apply a suggested surface change.

impl OutputHandler for SpellWin

fn output_state(&mut self) -> &mut OutputState

fn new_output( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _output: WlOutput, )

A new output has been advertised.

fn update_output( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _output: WlOutput, )

An existing output has changed.

fn output_destroyed( &mut self, _conn: &Connection, _qh: &QueueHandle<Self>, _output: WlOutput, )

An output is no longer advertised.

impl PointerHandler for SpellWin

fn pointer_frame( &mut self, _conn: &Connection, qh: &QueueHandle<Self>, _pointer: &WlPointer, events: &[PointerEvent], )

One or more pointer events are available.

impl ProvidesRegistryState for SpellWin

fn registry(&mut self) -> &mut RegistryState

Returns a mutable reference to the registry state.

fn runtime_add_global( &mut self, conn: &Connection, qh: &QueueHandle<Self>, name: u32, interface: &str, version: u32, )

Called when a new global has been advertised by the compositor.

fn runtime_remove_global( &mut self, conn: &Connection, qh: &QueueHandle<Self>, name: u32, interface: &str, )

Called when a global has been destroyed by the compositor.

impl SeatHandler for SpellWin

fn seat_state(&mut self) -> &mut SeatState

fn new_seat(&mut self, _: &Connection, _: &QueueHandle<Self>, _: WlSeat)

A new seat has been created.

fn new_capability( &mut self, _conn: &Connection, qh: &QueueHandle<Self>, seat: WlSeat, capability: Capability, )

A new capability is available on the seat.

fn remove_capability( &mut self, _conn: &Connection, _: &QueueHandle<Self>, _: WlSeat, capability: Capability, )

A capability has been removed from the seat.

fn remove_seat(&mut self, _: &Connection, _: &QueueHandle<Self>, _: WlSeat)

A seat has been removed.

impl ShmHandler for SpellWin

fn shm_state(&mut self) -> &mut Shm