openbox/scripts/stackedcycle.py

256 lines
9 KiB
Python

###########################################################################
### Functions for cycling focus (in a 'stacked' order) between windows. ###
###########################################################################
###########################################################################
### Options that affect the behavior of the stackedcycle module. ###
###########################################################################
INCLUDE_ALL_DESKTOPS = 0
"""If this is non-zero then windows from all desktops will be included in
the stacking list."""
INCLUDE_ICONS = 1
"""If this is non-zero then windows which are iconified on the current desktop
will be included in the stacking list."""
INCLUDE_ICONS_ALL_DESKTOPS = 1
"""If this is non-zero then windows which are iconified from all desktops
will be included in the stacking list."""
INCLUDE_OMNIPRESENT = 1
"""If this is non-zero then windows which are on all-desktops at once will
be included."""
TITLE_SIZE_LIMIT = 80
"""This specifies a rough limit of characters for the cycling list titles.
Titles which are larger will be chopped with an elipsis in their
center."""
ACTIVATE_WHILE_CYCLING = 1
"""If this is non-zero then windows will be activated as they are
highlighted in the cycling list (except iconified windows)."""
# See focus.AVOID_SKIP_TASKBAR
# See focuscycle.RAISE_WINDOW
###########################################################################
def next(data):
"""Focus the next window."""
if not data.state:
raise RuntimeError("stackedcycle.next must be bound to a key" +
"combination with at least one modifier")
_o.cycle(data, 1)
def previous(data):
"""Focus the previous window."""
if not data.state:
raise RuntimeError("stackedcycle.previous must be bound to a key" +
"combination with at least one modifier")
_o.cycle(data, 0)
###########################################################################
###########################################################################
###########################################################################
### Internal stuff, should not be accessed outside the module. ###
###########################################################################
import otk
import ob
import focus
import focuscycle
class _cycledata:
def __init__(self):
self.cycling = 0
def createpopup(self):
self.widget = otk.Widget(self.screen.number(), ob.openbox,
otk.Widget.Vertical, 0, 1)
def destroypopup(self):
self.menuwidgets = []
self.widget = 0
def shouldadd(self, client):
"""Determines if a client should be added to the list."""
curdesk = self.screen.desktop()
desk = client.desktop()
if not client.normal(): return 0
if not (client.canFocus() or client.focusNotify()): return 0
if focus.AVOID_SKIP_TASKBAR and client.skipTaskbar(): return 0
if client.iconic():
if INCLUDE_ICONS:
if INCLUDE_ICONS_ALL_DESKTOPS: return 1
if desk == curdesk: return 1
return 0
if INCLUDE_OMNIPRESENT and desk == 0xffffffff: return 1
if INCLUDE_ALL_DESKTOPS: return 1
if desk == curdesk: return 1
return 0
def populatelist(self):
"""Populates self.clients and self.menuwidgets, and then shows and
positions the cycling popup."""
self.widget.hide()
try:
current = self.clients[self.menupos]
except IndexError: current = 0
oldpos = self.menupos
self.menupos = -1
# get the list of clients, keeping iconic windows at the bottom
self.clients = []
iconic_clients = []
for c in focus._clients:
if c.iconic(): iconic_clients.append(c)
else: self.clients.append(c)
self.clients.extend(iconic_clients)
# make the widgets
i = 0
self.menuwidgets = []
while i < len(self.clients):
c = self.clients[i]
if not self.shouldadd(c):
# make the clients and menuwidgets lists match
self.clients.pop(i)
continue
w = otk.Label(self.widget)
if current and c.window() == current.window():
self.menupos = i
w.setHighlighted(1)
self.menuwidgets.append(w)
if c.iconic(): t = c.iconTitle()
else: t = c.title()
if INCLUDE_ALL_DESKTOPS:
d = c.desktop()
if d == 0xffffffff: d = self.screen.desktop()
t = self.screen.desktopName(d) + " - " + t
if len(t) > TITLE_SIZE_LIMIT: # limit the length of titles
t = t[:TITLE_SIZE_LIMIT / 2 - 2] + "..." + \
t[0 - TITLE_SIZE_LIMIT / 2 - 2:]
w.setText(t)
i += 1
# the window we were on may be gone
if self.menupos < 0:
# try stay at the same spot in the menu
if oldpos >= len(self.clients):
self.menupos = len(self.clients) - 1
else:
self.menupos = oldpos
# find the size for the popup
width = 0
height = 0
for w in self.menuwidgets:
size = w.minSize()
if size.width() > width: width = size.width()
height += size.height()
# show or hide the list and its child widgets
if len(self.clients) > 1:
size = self.screeninfo.size()
self.widget.moveresize(otk.Rect((size.width() - width) / 2,
(size.height() - height) / 2,
width, height))
self.widget.show(1)
def activatetarget(self, final):
try:
client = self.clients[self.menupos]
except IndexError: return # empty list makes for this
# move the to client's desktop if required
if not (client.iconic() or client.desktop() == 0xffffffff or \
client.desktop() == self.screen.desktop()):
root = self.screeninfo.rootWindow()
ob.send_client_msg(root, otk.atoms.net_current_desktop,
root, client.desktop())
# send a net_active_window message for the target
if final or not client.iconic():
if final: r = focuscycle.RAISE_WINDOW
else: r = 0
ob.send_client_msg(self.screeninfo.rootWindow(),
otk.atoms.openbox_active_window,
client.window(), final, r)
if not final:
focus._skip += 1
def cycle(self, data, forward):
if not self.cycling:
ob.kgrab(data.screen, _grabfunc)
# the pointer grab causes pointer events during the keyboard grab
# to go away, which means we don't get enter notifies when the
# popup disappears, screwing up the focus
ob.mgrab(data.screen)
self.cycling = 1
self.state = data.state
self.screen = ob.openbox.screen(data.screen)
self.screeninfo = otk.display.screenInfo(data.screen)
self.menupos = 0
self.createpopup()
self.clients = [] # so it doesnt try start partway through the list
self.populatelist()
if not len(self.clients): return # don't both doing anything
self.menuwidgets[self.menupos].setHighlighted(0)
if forward:
self.menupos += 1
else:
self.menupos -= 1
# wrap around
if self.menupos < 0: self.menupos = len(self.clients) - 1
elif self.menupos >= len(self.clients): self.menupos = 0
self.menuwidgets[self.menupos].setHighlighted(1)
if ACTIVATE_WHILE_CYCLING:
self.activatetarget(0) # activate, but dont deiconify/unshade/raise
def grabfunc(self, data):
done = 0
notreverting = 1
# have all the modifiers this started with been released?
if not self.state == data.state:
done = 1
elif data.action == ob.KeyAction.Press:
# has Escape been pressed?
if data.key == "Escape":
done = 1
notreverting = 0
# revert
self.menupos = 0
# has Enter been pressed?
elif data.key == "Return":
done = 1
if done:
# activate, and deiconify/unshade/raise
self.activatetarget(notreverting)
self.destroypopup()
self.cycling = 0
ob.kungrab()
ob.mungrab()
def _newwindow(data):
if _o.cycling: _o.populatelist()
def _closewindow(data):
if _o.cycling: _o.populatelist()
def _grabfunc(data):
_o.grabfunc(data)
ob.ebind(ob.EventAction.NewWindow, _newwindow)
ob.ebind(ob.EventAction.CloseWindow, _closewindow)
_o = _cycledata()
print "Loaded stackedcycle.py"