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 will be included
13 in the stacking list."""
14 INCLUDE_OMNIPRESENT = 1
15 """If this is non-zero then windows which are on all-desktops at once will
18 """This specifies a rough limit of characters for the cycling list titles.
19 Titles which are larger will be chopped with an elipsis in their
21 ACTIVATE_WHILE_CYCLING = 1
22 """If this is non-zero then windows will be activated as they are
23 highlighted in the cycling list (except iconified windows)."""
24 # See focus.AVOID_SKIP_TASKBAR
25 # See focuscycle.RAISE_WINDOW
26 ###########################################################################
29 """Focus the next window."""
31 raise RuntimeError("stackedcycle.next must be bound to a key" +
32 "combination with at least one modifier")
36 """Focus the previous window."""
38 raise RuntimeError("stackedcycle.previous must be bound to a key" +
39 "combination with at least one modifier")
42 ###########################################################################
43 ###########################################################################
45 ###########################################################################
46 ### Internal stuff, should not be accessed outside the module. ###
47 ###########################################################################
58 def createpopup(self):
59 self.widget = otk.Widget(self.screen.number(), ob.openbox,
60 otk.Widget.Vertical, 0, 1)
62 def destroypopup(self):
66 def shouldadd(self, client):
67 """Determines if a client should be added to the list."""
68 curdesk = self.screen.desktop()
69 desk = client.desktop()
71 if not client.normal(): return 0
72 if not (client.canFocus() or client.focusNotify()): return 0
73 if focus.AVOID_SKIP_TASKBAR and client.skipTaskbar(): return 0
75 if INCLUDE_ICONS and client.iconic(): return 1
76 if INCLUDE_OMNIPRESENT and desk == 0xffffffff: return 1
77 if INCLUDE_ALL_DESKTOPS: return 1
78 if desk == curdesk: return 1
82 def populatelist(self):
83 """Populates self.clients and self.menuwidgets, and then shows and
84 positions the cycling popup."""
89 current = self.clients[self.menupos]
90 except IndexError: current = 0
94 # get the list of clients, keeping iconic windows at the bottom
97 for c in focus._clients:
98 if c.iconic(): iconic_clients.append(c)
99 else: self.clients.append(c)
100 self.clients.extend(iconic_clients)
104 self.menuwidgets = []
105 while i < len(self.clients):
107 if not self.shouldadd(c):
108 # make the clients and menuwidgets lists match
112 w = otk.Label(self.widget)
113 if current and c.window() == current.window():
120 self.menuwidgets.append(w)
122 if c.iconic(): t = c.iconTitle()
124 if len(t) > TITLE_SIZE_LIMIT: # limit the length of titles
125 t = t[:TITLE_SIZE_LIMIT / 2 - 2] + "..." + \
126 t[0 - TITLE_SIZE_LIMIT / 2 - 2:]
131 # the window we were on may be gone
133 # try stay at the same spot in the menu
134 if oldpos >= len(self.clients):
135 self.menupos = len(self.clients) - 1
137 self.menupos = oldpos
139 # find the size for the popup
142 for w in self.menuwidgets:
144 if size.width() > width: width = size.width()
145 height += size.height()
147 # show or hide the list and its child widgets
148 if len(self.clients) > 1:
149 size = self.screeninfo.size()
150 self.widget.resize(otk.Size(width, height))
151 self.widget.move(otk.Point((size.width() - width) / 2,
152 (size.height() - height) / 2))
155 def activatetarget(self, final):
157 client = self.clients[self.menupos]
158 except IndexError: return # empty list makes for this
160 # move the to client's desktop if required
161 if not (client.iconic() or client.desktop() == 0xffffffff or \
162 client.desktop() == self.screen.desktop()):
163 root = self.screeninfo.rootWindow()
164 ob.send_client_msg(root, otk.atoms.net_current_desktop,
165 root, client.desktop())
167 # send a net_active_window message for the target
168 if final or not client.iconic():
169 if final: r = focuscycle.RAISE_WINDOW
171 ob.send_client_msg(self.screeninfo.rootWindow(),
172 otk.atoms.openbox_active_window,
173 client.window(), final, r)
175 def cycle(self, data, forward):
177 ob.kgrab(data.screen, _grabfunc)
178 # the pointer grab causes pointer events during the keyboard grab
179 # to go away, which means we don't get enter notifies when the
180 # popup disappears, screwing up the focus
181 ob.mgrab(data.screen)
185 self.state = data.state
186 self.screen = ob.openbox.screen(data.screen)
187 self.screeninfo = otk.display.screenInfo(data.screen)
190 self.clients = [] # so it doesnt try start partway through the list
193 if not len(self.clients): return # don't both doing anything
195 self.menuwidgets[self.menupos].setHighlighted(0)
201 if self.menupos < 0: self.menupos = len(self.clients) - 1
202 elif self.menupos >= len(self.clients): self.menupos = 0
203 self.menuwidgets[self.menupos].setHighlighted(1)
204 if ACTIVATE_WHILE_CYCLING:
205 self.activatetarget(0) # activate, but dont deiconify/unshade/raise
207 def grabfunc(self, data):
210 # have all the modifiers this started with been released?
211 if (data.action == ob.KeyAction.Release and
212 not self.state & data.state):
214 # has Escape been pressed?
215 elif data.action == ob.KeyAction.Press and data.key == "Escape":
224 # activate, and deiconify/unshade/raise
225 self.activatetarget(notreverting)
230 def _newwindow(data):
231 if _o.cycling: _o.populatelist()
233 def _closewindow(data):
234 if _o.cycling: _o.populatelist()
239 ob.ebind(ob.EventAction.NewWindow, _newwindow)
240 ob.ebind(ob.EventAction.CloseWindow, _closewindow)
244 print "Loaded stackedcycle.py"