cwc

• Index

Contents

• Static module functions
• Object properties
• Object methods
• Signals

Core components

• cwc
• cwc.client + cwc_client
• cwc.container + cwc_container
• cwc.layer_shell + cwc_layer_shell
• cwc.plugin + cwc_plugin
• cwc.screen + cwc_screen
• cwc.timer + cwc_timer
• cwc_tag

Input handling

• cwc.input + cwc_input
• cwc.kbd
• cwc.pointer
• cwc_kbind
• cwc_kbindmap

Plugins

• cwc.cwcle

Utility libraries

• gears.debug
• gears.filesystem
• gears.geometry
• gears.math
• gears.object
• gears.protected_call
• gears.sort
• gears.string
• gears.table

Theme related libraries

• gears.color

Libraries

• cuteful.client
• cuteful.enum
• cuteful.screen
• cuteful.tag
• gears.matcher
• gears.surface

Classes

• gears.cache
• gears.matrix

Documentation

• Getting Started
• Change log
• Custom Layout
• C Plugin

Module: cwc.plugin

C plugins lifecycle and management API.

Static module functions

cwc.plugin.get () -> cwc_plugin[]	Get all loaded plugin into a table.
cwc.plugin.load (path) -> boolean	load C plugin
cwc.plugin.unload_byname (name) -> boolean	unload C plugin filtered by name

Object properties

name	string	The name of the plugin.	Read only
description	string	The description of the plugin.	Read only
version	string	The version of the plugin.	Read only
author	string	The author of the plugin.	Read only
license	string	The license of the plugin.	Read only
filename	string	The filename of the plugin.	Read only

Object methods

:unload ()

Unload this plugin.

Signals

plugin::load	Emitted when a plugin is loaded.
plugin::unload	Emitted when the plugin is about to be unloaded.

Static module functions

🔗 cwc.plugin.get () -> cwc_plugin[]

Get all loaded plugin into a table.

Returns:

cwc_plugin[]

🔗 cwc.plugin.load (path) -> boolean

load C plugin

Parameters:

Name		Type(s)	Description
path		string	File location of the C shared object

Returns:

boolean true if loading success

🔗 cwc.plugin.unload_byname (name) -> boolean

unload C plugin filtered by name

Parameters:

Name		Type(s)	Description
name		string	Plugin name

Returns:

boolean true if unloading success

Object properties

🔗 name string · read only

The name of the plugin.

Constraints:

Default value	: ''

🔗 description string · read only

The description of the plugin.

Constraints:

Default value	: ''

🔗 version string · read only

The version of the plugin.

Constraints:

Default value	: ''

🔗 author string · read only

The author of the plugin.

Constraints:

Default value	: ''

🔗 license string · read only

The license of the plugin.

Constraints:

Default value	: ''

🔗 filename string · read only

The filename of the plugin.

Constraints:

Default value	: ''

Object methods

🔗 :unload ()

Unload this plugin.

Signals

🔗 plugin::load

Emitted when a plugin is loaded.

Arguments:

Name		Type(s)	Description
p		cwc_plugin	The plugin object.

🔗 plugin::unload

Emitted when the plugin is about to be unloaded.

Arguments:

Name		Type(s)	Description
p		cwc_plugin	The plugin object.