scripts/cycle.py (raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 |
import ob, otk
class _Cycle:
"""
This is a basic cycling class for anything, from xOr's stackedcycle.py,
that pops up a cycling menu when there's more than one thing to be cycled
to.
An example of inheriting from and modifying this class is _CycleWindows,
which allows users to cycle around windows.
This class could conceivably be used to cycle through anything -- desktops,
windows of a specific class, XMMS playlists, etc.
"""
"""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."""
TITLE_SIZE_LIMIT = 80
"""If this is non-zero then windows will be activated as they are
highlighted in the cycling list (except iconified windows)."""
ACTIVATE_WHILE_CYCLING = 0
"""If this is true, we start cycling with the next (or previous) thing
selected."""
START_WITH_NEXT = 1
"""If this is true, a popup window will be displayed with the options
while cycling."""
SHOW_POPUP = 1
def __init__(self):
"""Initialize an instance of this class. Subclasses should
do any necessary event binding in their constructor as well.
"""
self.cycling = 0 # internal var used for going through the menu
self.items = [] # items to cycle through
self.widget = None # the otk menu widget
self.menuwidgets = [] # labels in the otk menu widget TODO: RENAME
def createPopup(self):
"""Creates the cycling popup menu.
"""
self.widget = otk.Widget(self.screen.number(), ob.openbox,
otk.Widget.Vertical, 0, 1)
def destroyPopup(self):
"""Destroys (or rather, cleans up after) the cycling popup menu.
"""
self.menuwidgets = []
self.widget = 0
def populateItems(self):
"""Populate self.items with the appropriate items that can currently
be cycled through. self.items may be cleared out before this
method is called.
"""
pass
def menuLabel(self, item):
"""Return a string indicating the menu label for the given item.
Don't worry about title truncation.
"""
pass
def itemEqual(self, item1, item2):
"""Compare two items, return 1 if they're "equal" for purposes of
cycling, and 0 otherwise.
"""
# suggestion: define __eq__ on item classes so that this works
# in the general case. :)
return item1 == item2
def populateLists(self):
"""Populates self.items and self.menuwidgets, and then shows and
positions the cycling popup. You probably shouldn't mess with
this function; instead, see populateItems and menuLabel.
"""
self.widget.hide()
try:
current = self.items[self.menupos]
except IndexError:
current = None
oldpos = self.menupos
self.menupos = -1
self.items = []
self.populateItems()
# make the widgets
i = 0
self.menuwidgets = []
for i in range(len(self.items)):
c = self.items[i]
w = otk.Label(self.widget)
# current item might have shifted after a populateItems()
# call, so we need to do this test.
if current and self.itemEqual(c, current):
self.menupos = i
w.setHilighted(1)
self.menuwidgets.append(w)
t = self.menuLabel(c)
# TODO: maybe subclasses will want to truncate in different ways?
if len(t) > self.TITLE_SIZE_LIMIT: # limit the length of titles
t = t[:self.TITLE_SIZE_LIMIT / 2 - 2] + "..." + \
t[0 - self.TITLE_SIZE_LIMIT / 2 - 2:]
w.setText(t)
# The item we were on might be gone entirely
if self.menupos < 0:
# try stay at the same spot in the menu
if oldpos >= len(self.items):
self.menupos = len(self.items) - 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.items) > 1:
size = self.screen.size()
self.widget.moveresize(otk.Rect((size.width() - width) / 2,
(size.height() - height) / 2,
width, height))
if self.SHOW_POPUP: self.widget.show(1)
def activateTarget(self, final):
"""Activates (focuses and, if the user requested it, raises a window).
If final is true, then this is the very last window we're activating
and the user has finished cycling.
"""
pass
def setDataInfo(self, data):
"""Retrieve and/or calculate information when we start cycling,
preferably caching it. Data is what's given to callback functions.
"""
self.screen = ob.openbox.screen(data.screen)
def chooseStartPos(self):
"""Set self.menupos to a number between 0 and len(self.items) - 1.
By default the initial menupos is 0, but this can be used to change
it to some other position."""
pass
def cycle(self, data, forward):
"""Does the actual job of cycling through windows. data is a callback
parameter, while forward is a boolean indicating whether the
cycling goes forwards (true) or backwards (false).
"""
initial = 0
if not self.cycling:
ob.kgrab(data.screen, self.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.menupos = 0
self.setDataInfo(data)
self.createPopup()
self.items = [] # so it doesnt try start partway through the list
self.populateLists()
self.chooseStartPos()
self.initpos = self.menupos
initial = 1
if not self.items: return # don't bother doing anything
self.menuwidgets[self.menupos].setHighlighted(0)
if initial and not self.START_WITH_NEXT:
pass
else:
if forward:
self.menupos += 1
else:
self.menupos -= 1
# wrap around
if self.menupos < 0: self.menupos = len(self.items) - 1
elif self.menupos >= len(self.items): self.menupos = 0
self.menuwidgets[self.menupos].setHighlighted(1)
if self.ACTIVATE_WHILE_CYCLING:
self.activateTarget(0) # activate, but dont deiconify/unshade/raise
def grabfunc(self, data):
"""A callback method that grabs away all keystrokes so that navigating
the cycling menu is possible."""
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 = self.initpos
# 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 next(self, data):
"""Focus the next window."""
self.cycle(data, 1)
def previous(self, data):
"""Focus the previous window."""
self.cycle(data, 0)
#---------------------- Window Cycling --------------------
import focus
class _CycleWindows(_Cycle):
"""
This is a basic cycling class for Windows.
An example of inheriting from and modifying this class is
_ClassCycleWindows, which allows users to cycle around windows of a certain
application name/class only.
This class has an underscored name because I use the singleton pattern
(so CycleWindows is an actual instance of this class). This doesn't have
to be followed, but if it isn't followed then the user will have to create
their own instances of your class and use that (not always a bad thing).
An example of using the CycleWindows singleton:
from cycle import CycleWindows
CycleWindows.INCLUDE_ICONS = 0 # I don't like cycling to icons
ob.kbind(["A-Tab"], ob.KeyContext.All, CycleWindows.next)
ob.kbind(["A-S-Tab"], ob.KeyContext.All, CycleWindows.previous)
"""
"""If this is non-zero then windows from all desktops will be included in
the stacking list."""
INCLUDE_ALL_DESKTOPS = 0
"""If this is non-zero then windows which are iconified on the current
desktop will be included in the stacking list."""
INCLUDE_ICONS = 1
"""If this is non-zero then windows which are iconified from all desktops
will be included in the stacking list."""
INCLUDE_ICONS_ALL_DESKTOPS = 1
"""If this is non-zero then windows which are on all-desktops at once will
be included."""
INCLUDE_OMNIPRESENT = 1
"""A better default for window cycling than generic cycling."""
ACTIVATE_WHILE_CYCLING = 1
"""When cycling focus, raise the window chosen as well as focusing it."""
RAISE_WINDOW = 1
def __init__(self):
_Cycle.__init__(self)
def newwindow(data):
if self.cycling: self.populateLists()
def closewindow(data):
if self.cycling: self.populateLists()
ob.ebind(ob.EventAction.NewWindow, newwindow)
ob.ebind(ob.EventAction.CloseWindow, closewindow)
def shouldAdd(self, client):
"""Determines if a client should be added to the cycling 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 self.INCLUDE_ICONS:
if self.INCLUDE_ICONS_ALL_DESKTOPS: return 1
if desk == curdesk: return 1
return 0
if self.INCLUDE_OMNIPRESENT and desk == 0xffffffff: return 1
if self.INCLUDE_ALL_DESKTOPS: return 1
if desk == curdesk: return 1
return 0
def populateItems(self):
# get the list of clients, keeping iconic windows at the bottom
iconic_clients = []
for c in focus._clients:
if self.shouldAdd(c):
if c.iconic(): iconic_clients.append(c)
else: self.items.append(c)
self.items.extend(iconic_clients)
def menuLabel(self, client):
if client.iconic(): t = '[' + client.iconTitle() + ']'
else: t = client.title()
if self.INCLUDE_ALL_DESKTOPS:
d = client.desktop()
if d == 0xffffffff: d = self.screen.desktop()
t = self.screen.desktopName(d) + " - " + t
return t
def itemEqual(self, client1, client2):
return client1.window() == client2.window()
def activateTarget(self, final):
"""Activates (focuses and, if the user requested it, raises a window).
If final is true, then this is the very last window we're activating
and the user has finished cycling."""
try:
client = self.items[self.menupos]
except IndexError: return # empty list
# move the to client's desktop if required
if not (client.iconic() or client.desktop() == 0xffffffff or \
client.desktop() == self.screen.desktop()):
self.screen.changeDesktop(client.desktop())
# send a net_active_window message for the target
if final or not client.iconic():
if final: r = self.RAISE_WINDOW
else: r = 0
client.focus(final, r)
if not final:
focus._skip += 1
# The singleton.
CycleWindows = _CycleWindows()
#---------------------- Window Cycling --------------------
import focus
class _CycleWindowsLinear(_CycleWindows):
"""
This class is an example of how to inherit from and make use of the
_CycleWindows class. This class also uses the singleton pattern.
An example of using the CycleWindowsLinear singleton:
from cycle import CycleWindowsLinear
CycleWindows.ALL_DESKTOPS = 1 # I want all my windows in the list
ob.kbind(["A-Tab"], ob.KeyContext.All, CycleWindowsLinear.next)
ob.kbind(["A-S-Tab"], ob.KeyContext.All, CycleWindowsLinear.previous)
"""
"""When cycling focus, raise the window chosen as well as focusing it."""
RAISE_WINDOW = 0
"""If this is true, a popup window will be displayed with the options
while cycling."""
SHOW_POPUP = 0
def __init__(self):
_CycleWindows.__init__(self)
def shouldAdd(self, client):
"""Determines if a client should be added to the cycling 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(): return 0
if self.INCLUDE_OMNIPRESENT and desk == 0xffffffff: return 1
if self.INCLUDE_ALL_DESKTOPS: return 1
if desk == curdesk: return 1
return 0
def populateItems(self):
# get the list of clients, keeping iconic windows at the bottom
iconic_clients = []
for c in self.screen.clients:
if self.shouldAdd(c):
self.items.append(c)
def chooseStartPos(self):
if focus._clients:
t = focus._clients[0]
for i,c in zip(range(len(self.items)), self.items):
if self.itemEqual(c, t):
self.menupos = i
break
def menuLabel(self, client):
t = client.title()
if self.INCLUDE_ALL_DESKTOPS:
d = client.desktop()
if d == 0xffffffff: d = self.screen.desktop()
t = self.screen.desktopName(d) + " - " + t
return t
# The singleton.
CycleWindowsLinear = _CycleWindowsLinear()
#----------------------- Desktop Cycling ------------------
class _CycleDesktops(_Cycle):
"""
Example of usage:
from cycle import CycleDesktops
ob.kbind(["W-d"], ob.KeyContext.All, CycleDesktops.next)
ob.kbind(["W-S-d"], ob.KeyContext.All, CycleDesktops.previous)
"""
class Desktop:
def __init__(self, name, index):
self.name = name
self.index = index
def __eq__(self, other):
return other.index == self.index
def __init__(self):
_Cycle.__init__(self)
def populateItems(self):
for i in range(self.screen.numDesktops()):
self.items.append(
_CycleDesktops.Desktop(self.screen.desktopName(i), i))
def menuLabel(self, desktop):
return desktop.name
def chooseStartPos(self):
self.menupos = self.screen.desktop()
def activateTarget(self, final):
# TODO: refactor this bit
try:
desktop = self.items[self.menupos]
except IndexError: return
self.screen.changeDesktop(desktop.index)
CycleDesktops = _CycleDesktops()
print "Loaded cycle.py"
|