Module awful.menu
Menu module for awful
Authors:
Damien Leone <damien.leone@gmail.com> |
Julien Danjou <julien@danjou.info> |
Copyright© 2008 Damien Leone, Julien Danjou
Release: v3.1.2
Functions
clients (menu) | Build a popup menu with running clients and shows it. |
get_parents (data) | Get the elder parent so for example when you kill it, it will destroy the whole family. |
hide (menu) | Hide a menu popup. |
new (menu, parent, num) | Open a menu popup. |
show (menu) | Show a menu. |
toggle (menu) | Toggle menu visibility. |
Functions
- clients (menu)
-
Build a popup menu with running clients and shows it.
Parameters
- menu: Menu table, see new() function for more informations
Return value:
The menu. - get_parents (data)
-
Get the elder parent so for example when you kill it, it will destroy the whole family.
Parameters
- data:
- hide (menu)
-
Hide a menu popup.
Parameters
- menu: The menu to hide.
- new (menu, parent, num)
-
Open a menu popup.
Parameters
- menu: Table containing the menu informations. Key items: Table containing the displayed items, each element is a tab containing: item name, tiggered action, submenu table or function, item icon (optional). Keys [fg|bg]_[focus|normal], border, border_width, submenu_icon, height and width override the default display for your menu, each of them are optional.
- parent: Specify the parent menu if we want to open a submenu, this value should never be set by the user.
- num: Specify the parent's clicked item number if we want to open a submenu, this value should never be set by the user.
- show (menu)
-
Show a menu.
Parameters
- menu: The menu to show.
- toggle (menu)
-
Toggle menu visibility.
Parameters
- menu: The menu to show if it's hidden, or to hide if it's shown.