cwc

• Index

Contents

• Static module functions
• Object properties
• Object methods

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_kbd
• cwc.pointer + 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

• config
• cuteful.client
• cuteful.enum
• cuteful.pointer
• cuteful.screen
• cuteful.tag
• gears.matcher
• gears.surface
• impl

Classes

• gears.cache
• gears.matrix

Documentation

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

Module: cwc.timer

Low-level API to create a timer.

Static module functions

cwc.timer.new (timeout, callback, options, data)	Create a new timer.
cwc.timer.delayed_call (callback, data)	Call the given function at the end of wayland event loop.

Object properties

data	table	user data table	Read only
started	boolean	Whether the timer is currently running or not.
timeout	boolean	The timer timeout value in seconds.

Object methods

:start ()	Start the timer.
:stop ()	Stop the timer.
:again ()	Restart the timer.
:destroy ()	Destroy the timer, invalidate the object and freeing it from memory.

Static module functions

🔗 cwc.timer.new (timeout, callback, options, data)

Create a new timer.

Parameters:

Name		Type(s)	Description	Default value
timeout		number	Timeout in seconds	Not applicable
callback		function	Callback when the timer ends	Not applicable
options	Optional	table	Additional settings	Undefined
autostart	Optional	boolean	Immediately start the timer countdown	true
call_now	Optional	boolean	Immediately call the callback function	false
single_shot	Optional	boolean	Run only once then stop	false
one_shot	Optional	boolean	Run only once then destroy	false
data	Optional	any	Userdata callback argument.	nil

🔗 cwc.timer.delayed_call (callback, data)

Call the given function at the end of wayland event loop.

Parameters:

Name		Type(s)	Description	Default value
callback		function		Not applicable
data	Optional	any	Userdata callback argument	nil

Object properties

🔗 started boolean

Whether the timer is currently running or not.

Constraints:

Default value	: false
Valid values	: true or false.

🔗 timeout boolean

The timer timeout value in seconds.

Constraints:

Default value	: false
Valid values	: true or false.

Object methods

🔗 :start ()

Start the timer.

🔗 :stop ()

Stop the timer.

🔗 :again ()

Restart the timer.

Equivalent to stopping the timer and then starting it again.

🔗 :destroy ()

Destroy the timer, invalidate the object and freeing it from memory.