1 ###########################################################################
2 ### Functions for cycling focus (in a 'stacked' order) between windows. ###
3 ###########################################################################
5 ###########################################################################
6 ### Options that affect the behavior of the stackedcycle module. ###
7 ###########################################################################
8 INCLUDE_ALL_DESKTOPS = 0
9 """If this is non-zero then windows from all desktops will be included in
12 """If this is non-zero then windows which are iconified on the current desktop
13 will be included in the stacking list."""
14 INCLUDE_ICONS_ALL_DESKTOPS = 1
15 """If this is non-zero then windows which are iconified from all desktops
16 will be included in the stacking list."""
17 INCLUDE_OMNIPRESENT = 1
18 """If this is non-zero then windows which are on all-desktops at once will
21 """This specifies a rough limit of characters for the cycling list titles.
22 Titles which are larger will be chopped with an elipsis in their
24 ACTIVATE_WHILE_CYCLING = 1
25 """If this is non-zero then windows will be activated as they are
26 highlighted in the cycling list (except iconified windows)."""
27 # See focus.AVOID_SKIP_TASKBAR
28 # See focuscycle.RAISE_WINDOW
29 ###########################################################################
32 """Focus the next window."""
34 raise RuntimeError("stackedcycle.next must be bound to a key" +
35 "combination with at least one modifier")
39 """Focus the previous window."""
41 raise RuntimeError("stackedcycle.previous must be bound to a key" +
42 "combination with at least one modifier")
45 ###########################################################################
46 ###########################################################################
48 ###########################################################################
49 ### Internal stuff, should not be accessed outside the module. ###
50 ###########################################################################
61 def createpopup(self):
62 self.widget = otk.Widget(self.screen.number(), ob.openbox,
63 otk.Widget.Vertical, 0, 1)
65 def destroypopup(self):
69 def shouldadd(self, client):
70 """Determines if a client should be added to the list."""
71 curdesk = self.screen.desktop()
72 desk = client.desktop()
74 if not client.normal(): return 0
75 if not (client.canFocus() or client.focusNotify()): return 0
76 if focus.AVOID_SKIP_TASKBAR and client.skipTaskbar(): return 0
80 if INCLUDE_ICONS_ALL_DESKTOPS: return 1
81 if desk == curdesk: return 1
83 if INCLUDE_OMNIPRESENT and desk == 0xffffffff: return 1
84 if INCLUDE_ALL_DESKTOPS: return 1
85 if desk == curdesk: return 1
89 def populatelist(self):
90 """Populates self.clients and self.menuwidgets, and then shows and
91 positions the cycling popup."""
96 current = self.clients[self.menupos]
97 except IndexError: current = 0
101 # get the list of clients, keeping iconic windows at the bottom
104 for c in focus._clients:
105 if c.iconic(): iconic_clients.append(c)
106 else: self.clients.append(c)
107 self.clients.extend(iconic_clients)
111 self.menuwidgets = []
112 while i < len(self.clients):
114 if not self.shouldadd(c):
115 # make the clients and menuwidgets lists match
119 w = otk.Label(self.widget)
120 if current and c.window() == current.window():
123 self.menuwidgets.append(w)
125 if c.iconic(): t = c.iconTitle()
128 if INCLUDE_ALL_DESKTOPS:
130 if d == 0xffffffff: d = self.screen.desktop()
131 t = self.screen.desktopName(d) + " - " + t
133 if len(t) > TITLE_SIZE_LIMIT: # limit the length of titles
134 t = t[:TITLE_SIZE_LIMIT / 2 - 2] + "..." + \
135 t[0 - TITLE_SIZE_LIMIT / 2 - 2:]
140 # the window we were on may be gone
142 # try stay at the same spot in the menu
143 if oldpos >= len(self.clients):
144 self.menupos = len(self.clients) - 1
146 self.menupos = oldpos
148 # find the size for the popup
151 for w in self.menuwidgets:
153 if size.width() > width: width = size.width()
154 height += size.height()
156 # show or hide the list and its child widgets
157 if len(self.clients) > 1:
158 size = self.screeninfo.size()
159 self.widget.moveresize(otk.Rect((size.width() - width) / 2,
160 (size.height() - height) / 2,
164 def activatetarget(self, final):
166 client = self.clients[self.menupos]
167 except IndexError: return # empty list makes for this
169 # move the to client's desktop if required
170 if not (client.iconic() or client.desktop() == 0xffffffff or \
171 client.desktop() == self.screen.desktop()):
172 root = self.screeninfo.rootWindow()
173 ob.send_client_msg(root, otk.atoms.net_current_desktop,
174 root, client.desktop())
176 # send a net_active_window message for the target
177 if final or not client.iconic():
178 if final: r = focuscycle.RAISE_WINDOW
180 ob.send_client_msg(self.screeninfo.rootWindow(),
181 otk.atoms.openbox_active_window,
182 client.window(), final, r)
186 def cycle(self, data, forward):
188 ob.kgrab(data.screen, _grabfunc)
189 # the pointer grab causes pointer events during the keyboard grab
190 # to go away, which means we don't get enter notifies when the
191 # popup disappears, screwing up the focus
192 ob.mgrab(data.screen)
195 self.state = data.state
196 self.screen = ob.openbox.screen(data.screen)
197 self.screeninfo = otk.display.screenInfo(data.screen)
200 self.clients = [] # so it doesnt try start partway through the list
203 if not len(self.clients): return # don't both doing anything
205 self.menuwidgets[self.menupos].setHighlighted(0)
211 if self.menupos < 0: self.menupos = len(self.clients) - 1
212 elif self.menupos >= len(self.clients): self.menupos = 0
213 self.menuwidgets[self.menupos].setHighlighted(1)
214 if ACTIVATE_WHILE_CYCLING:
215 self.activatetarget(0) # activate, but dont deiconify/unshade/raise
217 def grabfunc(self, data):
220 # have all the modifiers this started with been released?
221 if not self.state & data.state:
223 elif data.action == ob.KeyAction.Press:
224 # has Escape been pressed?
225 if data.key == "Escape":
230 # has Enter been pressed?
231 elif data.key == "Return":
235 # activate, and deiconify/unshade/raise
236 self.activatetarget(notreverting)
242 def _newwindow(data):
243 if _o.cycling: _o.populatelist()
245 def _closewindow(data):
246 if _o.cycling: _o.populatelist()
251 ob.ebind(ob.EventAction.NewWindow, _newwindow)
252 ob.ebind(ob.EventAction.CloseWindow, _closewindow)
256 print "Loaded stackedcycle.py"