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.style = self.screen.style()
60 self.widget = otk.Widget(ob.openbox, self.style, otk.Widget.Vertical,
61 0, self.style.bevelWidth(), 1)
62 self.widget.setTexture(self.style.titlebarFocusBackground())
64 def destroypopup(self):
68 def shouldadd(self, client):
69 """Determines if a client should be added to the list."""
70 curdesk = self.screen.desktop()
71 desk = client.desktop()
73 if not client.normal(): return 0
74 if not (client.canFocus() or client.focusNotify()): return 0
75 if focus.avoid_skip_taskbar and client.skipTaskbar(): return 0
77 if include_icons and client.iconic(): return 1
78 if include_omnipresent and desk == 0xffffffff: return 1
79 if include_all_desktops: return 1
80 if desk == curdesk: return 1
84 def populatelist(self):
85 """Populates self.clients and self.menuwidgets, and then shows and
86 positions the cycling popup."""
91 current = self.clients[self.menupos]
92 except IndexError: current = 0
96 # get the list of clients
98 for i in focus._clients:
99 c = ob.openbox.findClient(i)
100 if c: self.clients.append(c)
102 font = self.style.labelFont()
104 height = font.height()
108 self.menuwidgets = []
109 while i < len(self.clients):
111 if not self.shouldadd(c):
112 # make the clients and menuwidgets lists match
116 w = otk.FocusLabel(self.widget)
117 if current and c.window() == current.window():
122 self.menuwidgets.append(w)
124 if c.iconic(): t = c.iconTitle()
126 if len(t) > title_size_limit: # limit the length of titles
127 t = t[:title_size_limit / 2 - 2] + "..." + \
128 t[0 - title_size_limit / 2 - 2:]
129 length = font.measureString(t)
130 if length > longest: longest = length
135 # the window we were on may be gone
137 # try stay at the same spot in the menu
138 if oldpos >= len(self.clients):
139 self.menupos = len(self.clients) - 1
141 self.menupos = oldpos
143 # fit to the largest item in the menu
144 for w in self.menuwidgets:
145 w.fitSize(longest, height)
147 # show or hide the list and its child widgets
148 if len(self.clients) > 1:
149 area = self.screeninfo.rect()
151 self.widget.move(area.x() + (area.width() -
152 self.widget.width()) / 2,
153 area.y() + (area.height() -
154 self.widget.height()) / 2)
157 def activatetarget(self, final):
159 client = self.clients[self.menupos]
160 except IndexError: return # empty list makes for this
162 # move the to client's desktop if required
163 if not (client.iconic() or client.desktop() == 0xffffffff or \
164 client.desktop() == self.screen.desktop()):
165 root = self.screeninfo.rootWindow()
166 ob.send_client_msg(root, otk.Property_atoms().net_current_desktop,
167 root, client.desktop())
169 # send a net_active_window message for the target
170 if final or not client.iconic():
171 if final: r = focuscycle.raise_window
173 ob.send_client_msg(self.screeninfo.rootWindow(),
174 otk.Property_atoms().openbox_active_window,
175 client.window(), final, r)
177 def cycle(self, data, forward):
181 self.state = data.state
182 self.screen = ob.openbox.screen(data.screen)
183 self.screeninfo = otk.display.screenInfo(data.screen)
186 self.clients = [] # so it doesnt try start partway through the list
189 ob.kgrab(self.screen.number(), _grabfunc)
190 # the pointer grab causes pointer events during the keyboard grab
191 # to go away, which means we don't get enter notifies when the
192 # popup disappears, screwing up the focus
193 ob.mgrab(self.screen.number())
195 self.menuwidgets[self.menupos].unfocus()
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].focus()
204 if activate_while_cycling:
205 self.activatetarget(0) # activate, but dont deiconify/unshade/raise
207 def grabfunc(self, data):
209 # have all the modifiers this started with been released?
210 if (data.action == ob.KeyAction.Release and
211 not self.state & data.state):
213 # has Escape been pressed?
214 if data.action == ob.KeyAction.Press and data.key == "Escape":
222 self.activatetarget(1) # activate, and deiconify/unshade/raise
227 def _newwindow(data):
228 if _o.cycling: _o.populatelist()
230 def _closewindow(data):
231 if _o.cycling: _o.populatelist()
236 ob.ebind(ob.EventAction.NewWindow, _newwindow)
237 ob.ebind(ob.EventAction.CloseWindow, _closewindow)
241 print "Loaded stackedcycle.py"