Module: cwc.layer_shell

Layer shell object info and events.

Info:

  • Copyright: 2025
  • License: GPLv3
  • Originally authored by: Dwi Asmoro Bangun
    (Full contributors list available on our github project)

Static module functions

cwc.layer_shell.get () -> cwc_layer_shell[] Get all input device in the server.

Object properties

screen cwc_screen The screen where the layer shell visible. Read only
namespace string The namespace of the layer shell. Read only
pid number The pid of the layer shell. Read only

Object methods

:kill () Kill a layer shell client without any question asked.

Signals

layer_shell::new Emitted when a layer shell surface is created.
layer_shell::destroy Emitted when layer shell surface is about to be destroyed.


Static module functions

🔗 cwc.layer_shell.get () -> cwc_layer_shell[]
Get all input device in the server.

Returns:

    cwc_layer_shell[]

Object properties

🔗 screen cwc_screen · read only
The screen where the layer shell visible.

Constraints:

Default value : Up to the client.
🔗 namespace string · read only
The namespace of the layer shell.

Constraints:

Default value : Extracted from wlrlayersurface.
🔗 pid number · read only
The pid of the layer shell.

Constraints:

Default value : Provided by the OS.
Negative allowed : false

Object methods

🔗 :kill ()
Kill a layer shell client without any question asked.

Signals

🔗 layer_shell::new
Emitted when a layer shell surface is created.

Arguments:

Name Type(s) Description
layer_shell cwc_layer_shell The layer shell object.
🔗 layer_shell::destroy
Emitted when layer shell surface is about to be destroyed.

Arguments:

Name Type(s) Description
layer_shell cwc_layer_shell The layer shell object.
generated by LDoc 1.5.0 based on AwesomeWM template