File tabulous.lua
Authors:
Lucas de Vries <lucasdevries@gmail.com> |
Julien Danjou <julien@danjou.info> |
Copyright ©2008 Julien Danjou, Lucas de Vries
Release: v3.3.4
Functions
autotab_start () | Start autotabbing, this automatically tabs new clients when the current client is tabbed. |
clients_get (tabindex) | Get all clients on a tabbed display. |
display (tabindex, cl) | Swaand select which client in tab is displayed. |
displayed_get (tabindex) | Get the displayed client on a tabbed display. |
findkey (table, value) | Find a key in a table. |
hook_focus (cl) | Keep tabulous in sync when a client is focused but was hidden in a tab (show the client and hide the previous one) |
next (tabindex, cl) | Get the next client in a tab display. |
position_get (tabindex, pos) | Get a client by tab number. |
prev (tabindex, cl) | Get the previous client in a tabdisplay |
tab (tabindex, cl) | Add a client to a tabbed display. |
tab_create (cl) | Create a new tabbed display with client as the master. |
tabindex_check (tabindex, cl) | Check if the client is in the given tabindex. |
tabindex_get (cl) | Find the tab index or return nil if not tabbed. |
untab (cl) | Remove a client from a tabbed display. |
untab_all (tabindex) | Untab all clients in a tabbed display. |
update_tabbing () | Update the tabbing when current tags changes, by unactivating all tabs that are not in the current tag (and activating the good one) |
Functions
- autotab_start ()
- Start autotabbing, this automatically tabs new clients when the current client is tabbed.
- clients_get (tabindex)
-
Get all clients on a tabbed display.
Parameters
- tabindex: The tab index.
Return value:
All tabbed clients. - display (tabindex, cl)
-
Swaand select which client in tab is displayed.
Parameters
- tabindex: The tab index.
- cl: The client to show.
- displayed_get (tabindex)
-
Get the displayed client on a tabbed display.
Parameters
- tabindex: The tab index.
Return value:
The displayed client. - findkey (table, value)
-
Find a key in a table.
Parameters
- table: The table to look into
- value: The value to find.
Return value:
The key or nil if not found. - hook_focus (cl)
-
Keep tabulous in sync when a client is focused but was hidden in a tab (show the client and hide the previous one)
Parameters
- cl:
- next (tabindex, cl)
-
Get the next client in a tab display.
Parameters
- tabindex: The tab index.
- cl: The current client.
Return value:
The next client. - position_get (tabindex, pos)
-
Get a client by tab number.
Parameters
- tabindex: The tab index.
- pos: The position in the tab.
Return value:
The client at the given position. - prev (tabindex, cl)
-
Get the previous client in a tabdisplay
Parameters
- tabindex: The tab index.
- cl: The current client.
Return value:
The previous client. - tab (tabindex, cl)
-
Add a client to a tabbed display.
Parameters
- tabindex: The tab index.
- cl: The client to add, or the focused one otherwise.
- tab_create (cl)
-
Create a new tabbed display with client as the master.
Parameters
- cl: The client to set into the tab, focused one otherwise.
Return value:
The created tab index. - tabindex_check (tabindex, cl)
-
Check if the client is in the given tabindex.
Parameters
- tabindex: The tab index.
- cl: The client
Return value:
The key. - tabindex_get (cl)
-
Find the tab index or return nil if not tabbed.
Parameters
- cl: The client to search.
Return value:
The tab index. - untab (cl)
-
Remove a client from a tabbed display.
Parameters
- cl: The client to remove.
Return value:
True if the client has been untabbed. - untab_all (tabindex)
-
Untab all clients in a tabbed display.
Parameters
- tabindex: The tab index.
- update_tabbing ()
- Update the tabbing when current tags changes, by unactivating all tabs that are not in the current tag (and activating the good one)