lib/awful/screen.lua.in

   1 ---------------------------------------------------------------------------
   2 -- @author Julien Danjou &lt;julien@danjou.info&gt;
   3 -- @copyright 2008 Julien Danjou
   4 -- @release @AWESOME_VERSION@
   5 ---------------------------------------------------------------------------
   6
   7 -- Grab environment we need
   8 local capi =
   9 {
  10     mouse = mouse,
  11     screen = screen,
  12     client = client
  13 }
  14 local util = require("awful.util")
  15
  16 -- we use require("awful.client") inside functions to prevent circular dependencies.
  17 local client
  18
  19 --- Screen module for awful
  20 -- awful.screen
  21 local screen = {}
  22
  23 local data = {}
  24 data.padding = {}
  25
  26 ---
  27 -- Return Xinerama screen number corresponding to the given (pixel) coordinates.
  28 -- The number returned can be used as an index into the global
  29 -- `screen` table/object.
  30 -- @param x The x coordinate
  31 -- @param y The y coordinate
  32 -- @param default Optional default return value. If unspecified, 1 is returned.
  33 function screen.getbycoord(x, y, default)
  34     for i = 1, capi.screen:count() do
  35         local geometry = capi.screen[i].geometry
  36         if((x < 0 or (x >= geometry.x and x < geometry.x + geometry.width))
  37            and (y < 0 or (y >= geometry.y and y < geometry.y + geometry.height))) then
  38             return i
  39         end
  40     end
  41     -- No caller expects a nil result here, so just make something up
  42     if default == nil then return 1 end
  43     return default
  44 end
  45
  46 --- Give the focus to a screen, and move pointer. Keeps relative position of the pointer on the screen.
  47 -- @param _screen Screen number.
  48 function screen.focus(_screen)
  49     client = client or require("awful.client")
  50     if _screen > capi.screen.count() then _screen = capi.mouse.screen end
  51
  52     -- screen and pos for current screen
  53     local s = capi.mouse.screen
  54     local pos = capi.mouse.coords()
  55
  56     -- keep relative mouse position on the new screen
  57     local relx = (pos.x - capi.screen[s].geometry.x) / capi.screen[s].geometry.width
  58     local rely = (pos.y - capi.screen[s].geometry.y) / capi.screen[s].geometry.height
  59
  60     pos.x = capi.screen[_screen].geometry.x + relx * capi.screen[_screen].geometry.width
  61     pos.y = capi.screen[_screen].geometry.y + rely * capi.screen[_screen].geometry.height
  62
  63    -- move cursor without triggering signals mouse::enter and mouse::leave
  64     capi.mouse.coords(pos, true)
  65
  66     local c = client.focus.history.get(_screen, 0)
  67     if c then capi.client.focus = c end
  68 end
  69
  70 --- Give the focus to a screen, and move pointer, by physical position relative to current screen.
  71 -- @param dir The direction, can be either "up", "down", "left" or "right".
  72 -- @param _screen Screen number.
  73 function screen.focus_bydirection(dir, _screen)
  74     local sel = _screen or capi.mouse.screen
  75     if sel then
  76         local geomtbl = {}
  77         for s = 1, capi.screen.count() do
  78             geomtbl[s] = capi.screen[s].geometry
  79         end
  80         local target = util.get_rectangle_in_direction(dir, geomtbl, capi.screen[sel].geometry)
  81         if target then
  82             return screen.focus(target)
  83         end
  84     end
  85 end
  86
  87 --- Give the focus to a screen, and move pointer, but relative to the current
  88 -- focused screen.
  89 -- @param i Value to add to the current focused screen index. 1 will focus next
  90 -- screen, -1 would focus the previous one.
  91 function screen.focus_relative(i)
  92     return screen.focus(util.cycle(capi.screen.count(), capi.mouse.screen + i))
  93 end
  94
  95 --- Get or set the screen padding.
  96 -- @param _screen The screen object to change the padding on
  97 -- @param padding The padding, an table with 'top', 'left', 'right' and/or
  98 -- 'bottom'. Can be nil if you only want to retrieve padding
  99 function screen.padding(_screen, padding)
 100     if padding then
 101         data.padding[_screen] = padding
 102         _screen:emit_signal("padding")
 103     end
 104     return data.padding[_screen]
 105 end
 106
 107 capi.screen.add_signal("padding")
 108
 109 return screen
 110
 111 -- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80