Module: cuteful.client
Useful functions for client manipulation.
Info:
- Copyright: 2024
- License: GPLv3
-
Originally authored by: Dwi Asmoro Bangun
(Full contributors list available on our github project)
Static module functions
| cuteful.client.getidx (idx, client) -> cwc_client | Get a client by its relative index. | |
| cuteful.client.focusidx (idx, client) | Focus a client by its relative index. | |
| cuteful.client.swapidx (idx, client) | Swap a client by its relative index. | |
| cuteful.client.maximize_horizontal (client) | Maximize client horizontally. | |
| cuteful.client.maximize_vertical (client) | Maximize client vertically. | |
| cuteful.client.restore (active_tag, s) -> cwc_client | Restore (=unminimize) a client in the screen. | |
| cuteful.client.get_master (s) -> cwc_client | Get the master client. | |
| cuteful.client.set_master (c, swap_container) | Set the master client or container. |
Static module functions
- 🔗 cuteful.client.getidx (idx, client) -> cwc_client
-
Get a client by its relative index.
Parameters:
Name Type(s) Description idx number Index relative to the this client client Optional cwc_client Base client (index 0). Returns:
-
cwc_client
- 🔗 cuteful.client.focusidx (idx, client)
-
Focus a client by its relative index.
Parameters:
Name Type(s) Description idx number Index relative to the this client client Optional cwc_client Base client (index 0). - 🔗 cuteful.client.swapidx (idx, client)
-
Swap a client by its relative index.
Parameters:
Name Type(s) Description idx number Index relative to the this client client Optional cwc_client Base client (index 0). - 🔗 cuteful.client.maximize_horizontal (client)
-
Maximize client horizontally.
Parameters:
Name Type(s) Description client Optional cwc_client The client - 🔗 cuteful.client.maximize_vertical (client)
-
Maximize client vertically.
Parameters:
Name Type(s) Description client Optional cwc_client The client - 🔗 cuteful.client.restore (active_tag, s) -> cwc_client
-
Restore (=unminimize) a client in the screen.
Parameters:
Name Type(s) Description active_tag boolean Unminimize client in the active tag only. s Optional cwc_screen The screen to use. Returns:
-
cwc_client
The restored client.
- 🔗 cuteful.client.get_master (s) -> cwc_client
-
Get the master client.
Parameters:
Name Type(s) Description s Optional cwc_screen Screen to use Returns:
-
cwc_client
The master client
- 🔗 cuteful.client.set_master (c, swap_container)
-
Set the master client or container.
Parameters:
Name Type(s) Description Default value c cwc_client New master client. Not applicable swap_container Optional boolean Whether to swap the container. false