### Functions for helping out with your window focus. ###
###########################################################################
-ob_focus_raise = 1
-ob_focus_fallback = 0
+###########################################################################
+### Options that affect the behavior of the focus module. ###
+###########################################################################
+AVOID_SKIP_TASKBAR = 1
+"""Don't focus windows which have requested to not be displayed in taskbars.
+ You will still be able to focus the windows, but not through cycling, and
+ they won't be focused as a fallback if 'fallback' is enabled."""
+FALLBACK = 0
+"""Send focus somewhere when nothing is left with the focus, if possible."""
+###########################################################################
+
+###########################################################################
+###########################################################################
+
+###########################################################################
+### Internal stuff, should not be accessed outside the module. ###
+###########################################################################
+
+import ob
# maintain a list of clients, stacked in focus order
-ob_clients = []
-# maintaint he current focused window
-ob_focused = 0;
+_clients = []
+_disable = 0
-def ob_new_win(data):
- global ob_clients
- if not len(ob_clients): ob_clients.append(data.client.window())
- else: ob_clients.insert(1, data.client.window()) # insert in 2nd slot
+def _focusable(client, desktop):
+ if not client.normal(): return 0
+ if not (client.canFocus() or client.focusNotify()): return 0
+ if AVOID_SKIP_TASKBAR and client.skipTaskbar(): return 0
-def ob_close_win(data):
- global ob_clients
- ob_clients.remove(data.client.window())
+ desk = client.desktop()
+ if not (desk == 0xffffffff or desk == desktop): return 0
-def ob_focused(data):
- global ob_clients
- if data.client:
- win = data.client.window()
- ob_focused = win
- # move it to the top
- ob_clients.remove(win)
- ob_clients.insert(0, win)
- elif ob_focus_fallback:
- # pass around focus
- ob_focused = 0
- desktop = openbox.screen(data.screen).desktop()
- for w in ob_clients:
- client = openbox.findClient(w)
- if client and (client.desktop() == desktop and \
- client.normal() and client.focus()):
- break
+ return 1
-ebind(EventNewWindow, ob_new_win)
-ebind(EventCloseWindow, ob_close_win)
-ebind(EventFocus, ob_focused)
+def _remove(client):
+ """This function exists because Swig pointers don't define a __eq__
+ function, so list.remove(ptr) does not work."""
+ win = client.window()
+ for i in range(len(_clients)):
+ if _clients[i].window() == win:
+ _clients.pop(i)
+ return
+ raise ValueError("_remove(x): x not in _clients list.")
-def focus_next(data, num=1, forward=1):
- """Focus the next (or previous, with forward=0) window in a linear
- order."""
- screen = openbox.screen(data.screen)
- count = screen.clientCount()
+def _focused(data):
+ global _clients
+
+ if _disable: return
- if not count: return # no clients
-
- target = 0
if data.client:
- client_win = data.client.window()
- found = 0
- r = range(count)
- if not forward:
- r.reverse()
- for i in r:
- if found:
- target = i
- found = 2
+ # move it to the top
+ try:
+ _remove(data.client)
+ except ValueError: pass # happens if _focused comes before _newwindow
+ _clients.insert(0, data.client)
+ elif FALLBACK:
+ # pass around focus
+ desktop = ob.openbox.screen(data.screen).desktop()
+ for c in _clients:
+ if _focusable(c, desktop) and c.focus():
break
- elif screen.client(i).window() == client_win:
- found = 1
- if found == 1: # wraparound
- if forward: target = 0
- else: target = count - 1
- t = target
- curdesk = screen.desktop()
- while 1:
- client = screen.client(t)
- if client.normal() and \
- (client.desktop() == curdesk or client.desktop() == 0xffffffff)\
- and client.focus():
- if ob_focus_raise:
- screen.raiseWindow(client)
+def _newwindow(data):
+ # make sure its not already in the list
+ win = data.client.window()
+ for i in range(len(_clients)):
+ if _clients[i].window() == win:
return
- if forward:
- t += num
- if t >= count: t -= count
- else:
- t -= num
- if t < 0: t += count
- if t == target: return # nothing to focus
-
-def focus_prev(data, num=1):
- """Focus the previous window in a linear order."""
- focus_next(data, num, forward=0)
+ _clients.append(data.client)
+
+def _closewindow(data):
+ _remove(data.client)
+ob.ebind(ob.EventAction.NewWindow, _newwindow)
+ob.ebind(ob.EventAction.CloseWindow, _closewindow)
+ob.ebind(ob.EventAction.Focus, _focused)
print "Loaded focus.py"