awesome/lib/awful/menu.lua.in

274 lines
8.6 KiB
Lua

---------------------------------------------------------------------------
-- @author Damien Leone <damien.leone@gmail.com>
-- @author Julien Danjou <julien@danjou.info>
-- @copyright 2008 Damien Leone, Julien Danjou
-- @release @AWESOME_VERSION@
---------------------------------------------------------------------------
-- Grab environment we need
local pairs = pairs
local table = table
local type = type
local wibox = wibox
local image = image
local widget = widget
local button = button
local capi = { screen = screen, mouse = mouse, client = client }
local util = require("awful.util")
local tags = require("awful.tag")
local awbeautiful = require("awful.beautiful")
--- Menu module for awful
module("awful.menu")
local function load_theme(custom)
local theme = {}
local beautiful
beautiful = awbeautiful.get()
theme.fg_focus = custom.fg_focus or beautiful.menu_fg_focus or beautiful.fg_focus
theme.bg_focus = custom.bg_focus or beautiful.menu_bg_focus or beautiful.bg_focus
theme.fg_normal = custom.fg_normal or beautiful.menu_fg_normal or beautiful.fg_normal
theme.bg_normal = custom.bg_normal or beautiful.menu_bg_normal or beautiful.bg_normal
theme.submenu_icon = custom.submenu_icon or beautiful.menu_submenu_icon
theme.menu_height = custom.height or beautiful.menu_height or 15
theme.menu_width = custom.width or beautiful.menu_width or 100
theme.border = custom.border_color or beautiful.menu_border_color or beautiful.border_normal
theme.border_width = custom.border_width or beautiful.menu_border_width or beautiful.border_width
return theme
end
local function mouse_enter(w, theme)
w.fg = theme.fg_focus
w.bg = theme.bg_focus
end
local function mouse_leave(w, theme)
w.fg = theme.fg_normal
w.bg = theme.bg_normal
end
--- Hide a menu popup.
-- @param menu The menu to hide.
function hide(menu)
-- Remove items from screen
for i = 1, #menu.items do
-- Call mouse_leave to clear menu entry
for k, w in pairs(menu.items[i].widgets) do
w.mouse_leave()
end
menu.items[i].screen = nil
end
if menu.active_child then
menu.active_child:hide()
active_child = nil
end
end
--- Get the elder parent so for example when you kill
-- it, it will destroy the whole family.
local function get_parents(data)
if data.parent then
return get_parents(data.parent)
end
return data
end
local function exec(data, action, num)
if type(action[2]) == "table" then
if not data.child[num] then
data.child[num] = new({ items = action[2] }, data, num)
end
if data.active_child then
data.active_child:hide()
end
data.active_child = data.child[num]
data.active_child:show()
elseif type(action[2]) == "string" then
get_parents(data):hide()
util.spawn(action[2])
elseif type(action[2]) == "function" then
get_parents(data):hide()
action[2]()
end
end
local function add_item(data, num, item_info)
local item = wibox({
position = "floating",
fg = data.theme.fg_normal,
bg = data.theme.bg_normal,
border_color = data.theme.border,
border_width = data.theme.border_width
})
-- Create bindings
local bindings = {
button({}, 1, function () exec(data, item_info, num) end),
button({}, 3, function () hide(data) end)
}
-- Create the item icon widget
local icon
if item_info[3] then
icon = widget({ type = "imagebox", align = "left" })
if type(item_info[3]) == "string" then
icon.image = image(item_info[3])
else
icon.image = item_info[3]
end
else
icon = widget({type = "textbox", align = "left" })
icon.width = data.h
end
icon:buttons(bindings)
function icon.mouse_enter() mouse_enter(item, data.theme) end
function icon.mouse_leave() mouse_leave(item, data.theme) end
-- Create the item label widget
local label = widget({
type = "textbox",
align = "flex"
})
label.text = " " .. item_info[1]
label:buttons(bindings)
function label.mouse_enter() mouse_enter(item, data.theme) end
function label.mouse_leave() mouse_leave(item, data.theme) end
-- Create the submenu icon widget
local submenu
if type(item_info[2]) == "table" then
submenu = widget({ type = "imagebox", align = "right" })
submenu.image = data.theme.submenu_icon and image(data.theme.submenu_icon)
submenu:buttons(bindings)
function submenu.mouse_enter() mouse_enter(item, data.theme) end
function submenu.mouse_leave() mouse_leave(item, data.theme) end
end
-- Add widgets to the wibox
item.widgets = { icon, label, submenu }
item.ontop = true
return item
end
--- Build a popup menu with running clients and shows it.
-- @param menu Menu table, see new() function for more informations
-- @return The menu.
function clients(menu)
local cls = capi.client.get()
local cls_t = {}
for k, c in pairs(cls) do
cls_t[#cls_t + 1] = { util.escape(c.name) or "",
function ()
if not c:isvisible() then
tags.viewmore(c:tags(), c.screen)
end
capi.client.focus = c
end,
c.icon }
end
if not menu then
menu = {}
end
menu.items = cls_t
m = new(menu)
m:show()
return m
end
local function set_coords(menu, screen_idx)
local s_geometry = capi.screen[screen_idx].workarea
local screen_w = s_geometry.x + s_geometry.width
local screen_h = s_geometry.y + s_geometry.height
if menu.parent then
menu.w = menu.parent.w
menu.h = menu.parent.h
local p_w = (menu.h + menu.theme.border_width) * (menu.num - 1)
local m_h = menu.theme.border_width + (menu.h + menu.theme.border_width) * #menu.items
local m_w = menu.w + menu.theme.border_width
menu.y = menu.parent.y + p_w + m_h > screen_h and screen_h - m_h or menu.parent.y + p_w
menu.x = menu.parent.x + menu.w*2 + menu.theme.border_width > screen_w and menu.parent.x - m_w or menu.parent.x + m_w
else
local m_coords = capi.mouse.coords()
menu.y = m_coords.y < s_geometry.y and s_geometry.y or m_coords.y
menu.x = m_coords.x < s_geometry.x and s_geometry.x or m_coords.x
local m_h = menu.theme.border_width + (menu.h + menu.theme.border_width) * #menu.items
local m_w = menu.w + menu.theme.border_width*2
menu.y = menu.y + m_h > screen_h and screen_h - m_h or menu.y
menu.x = menu.x + m_w > screen_w and screen_w - m_w or menu.x
end
end
--- Show a menu.
-- @param menu The menu to show.
function show(menu)
local screen_index = capi.mouse.screen
set_coords(menu, screen_index)
for num, item in pairs(menu.items) do
item:geometry({
width = menu.w,
height = menu.h,
x = menu.x,
y = menu.y + (num - 1) * (menu.h + menu.theme.border_width)
})
item.screen = screen_index
end
end
--- Toggle menu visibility.
-- @param menu The menu to show if it's hidden, or to hide if it's shown.
function toggle(menu)
if menu.items[1].screen then
hide(menu)
else
show(menu)
end
end
--- Open a menu popup.
-- @param 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.
-- @param parent Specify the parent menu if we want to open a submenu, this value should never be set by the user.
-- @param num Specify the parent's clicked item number if we want to open a submenu, this value should never be set by the user.
function new(menu, parent, num)
-- Create a table to store our menu informations
local data = {}
data.items = {}
data.num = num or 1
data.theme = parent and parent.theme or load_theme(menu)
data.parent = parent
data.child = {}
data.h = parent and parent.h or data.theme.menu_height
data.w = parent and parent.w or data.theme.menu_width
-- Create items
for k, v in pairs(menu.items) do
table.insert(data.items, add_item(data, k, v))
end
-- Set methods
data.hide = hide
data.show = show
data.toggle = toggle
return data
end