cwc

• Index

Contents

• Static module functions

Libraries

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

Core components

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

Input handling

• 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

Classes

• gears.cache
• gears.matrix

Documentation

• Getting Started
• Custom Layout
• C Plugin

Module: cuteful.screen

Useful functions for screen object.

Static module functions

cuteful.screen.idx (offset, s) -> cwc_screen	Get a screen by its relative index.
cuteful.screen.focus_relative (offset)	Move the focus to a screen relative to the current one.
cuteful.screen.focus_bydirection (dir, s)	Move the focus to a screen in a specific direction.

Static module functions

🔗 cuteful.screen.idx (offset, s) -> cwc_screen

Get a screen by its relative index.

Parameters:

Name		Type(s)	Description	Default value
offset		number	Offset index starting from the pivot.	Not applicable
s	Optional	cwc_screen	Screen as pivot offset.	nil

Returns:

cwc_screen The screen object

🔗 cuteful.screen.focus_relative (offset)

Move the focus to a screen relative to the current one.

Parameters:

Name		Type(s)	Description
offset		number	Value to add to the current focused screen index. 1 to focus the next one, -1 to focus the previous one.

🔗 cuteful.screen.focus_bydirection (dir, s)

Move the focus to a screen in a specific direction.

Parameters:

Name		Type(s)	Description	Default value
dir		number	The direction enum.	Not applicable
s	Optional	cwc_screen	Screen.	nil

See also:

cuteful.enum.direction	Extracted from wlr_direction wlr_output_layout.h (cuteful.enum)	tables