remove prints
[mikachu/openbox.git] / scripts / focus.py
1 ###########################################################################
2 ###          Functions for helping out with your window focus.          ###
3 ###########################################################################
4
5 ###########################################################################
6 ###         Options that affect the behavior of the focus module.       ###
7 ###                                                                     ###
8 # cycle_raise - raise the window also when it is focused                ###
9 cycle_raise = 1                                                         ###
10 # avoid_skip_taskbar - Don't focus windows which have requested to not  ###
11 ###                    be displayed in taskbars. You will still be able ###
12 ###                    to focus the windows, but not through cycling,   ###
13 ###                    and they won't be focused as a fallback if       ###
14 ###                    'fallback' is enabled.                           ###
15 avoid_skip_taskbar = 1                                                  ###
16 # stacked_cycle_raise - raise as you cycle in stacked mode              ###
17 stacked_cycle_raise = 0                                                 ###
18 # stacked_cycle_popup_list - show a pop-up list of windows while        ###
19 ###                          cycling                                    ###
20 stacked_cycle_popup_list = 1                                            ###
21 # send focus somewhere when nothing is left with the focus, if possible ###
22 fallback = 0                                                            ###
23 ###                                                                     ###
24 ###                                                                     ###
25 # Provides:                                                             ###
26 # def focus_next_stacked(data, forward=1):                              ###
27 #   """Focus the next (or previous, with forward=0) window in a stacked ###
28 #      order."""                                                        ###
29 # def focus_prev_stacked(data):                                         ###
30 #   """Focus the previous window in a stacked order."""                 ###
31 # def focus_next(data, num=1, forward=1):                               ###
32 #   """Focus the next (or previous, with forward=0) window in a linear  ###
33 #      order."""                                                        ###
34 # def focus_prev(data, num=1):                                          ###
35 #   """Focus the previous window in a linear order."""                  ###
36 ###                                                                     ###
37 # All of these functions call be used as callbacks for bindings         ###
38 # directly.                                                             ###
39 ###                                                                     ###
40 ###########################################################################
41
42 import otk
43 import ob
44
45 # maintain a list of clients, stacked in focus order
46 _clients = []
47 # maintaint he current focused window
48 _doing_stacked = 0
49
50 def _focusable(client, desktop):
51     if not (avoid_skip_taskbar and client.skipTaskbar()) and \
52        (client.desktop() == desktop or client.desktop() == 0xffffffff) and \
53        client.normal() and (client.canFocus() or client.focusNotify()):
54         return 1
55     return 0
56
57 def _new_win(data):
58     global _clients
59     global _doing_stacked
60     global _cyc_w;
61
62     if _doing_stacked:
63         _clients.insert(_clients.index(_cyc_w), data.client.window())
64         _create_popup_list(data)
65         _hilite_popup_list(data)
66     else:
67         if not len(_clients):
68             _clients.append(data.client.window())
69         else:
70             _clients.insert(1, data.client.window()) # insert in 2nd slot
71
72 def _close_win(data):
73     global _clients
74     global _cyc_w;
75     global _doing_stacked
76
77     if not _doing_stacked:
78         # not in the middle of stacked cycling, so who cares
79         _clients.remove(data.client.window())
80     else:
81         # have to fix the cycling if we remove anything
82         win = data.client.window()
83         if _cyc_w == win:
84             _do_stacked_cycle(data, 1) # cycle off the window first, forward
85         _clients.remove(win)
86         _create_popup_list(data)
87
88 def _focused(data):
89     global _clients
90     global _doing_stacked
91     global _cyc_w
92
93     if data.client:
94         if not _doing_stacked: # only move the window when we're not cycling
95             win = data.client.window()
96             # move it to the top
97             _clients.remove(win)
98             _clients.insert(0, win)
99         else: # if we are cycling, then update our pointer
100             _cyc_w = data.client.window()
101             _hilite_popup_list(data)
102     elif fallback:
103         # pass around focus
104         desktop = ob.openbox.screen(_cyc_screen).desktop()
105         for w in _clients:
106             client = ob.openbox.findClient(w)
107             if client and _focusable(client, desktop) and client.focus():
108                 break
109         if _doing_stacked:
110             _cyc_w = 0
111             _hilite_popup_list(data)
112
113 _cyc_mask = 0
114 _cyc_key = 0
115 _cyc_w = 0 # last window cycled to
116 _cyc_screen = 0
117
118 def _do_stacked_cycle(data, forward):
119     global _cyc_w
120     global stacked_cycle_raise
121     global _clients
122
123     clients = _clients[:] # make a copy
124
125     if not forward:
126         clients.reverse()
127
128     try:
129         i = clients.index(_cyc_w) + 1
130     except ValueError:
131         i = 1
132     clients = clients[i:] + clients[:i]
133         
134     desktop = ob.openbox.screen(data.screen).desktop()
135     for w in clients:
136         client = ob.openbox.findClient(w)
137                    
138         if client and _focusable(client, desktop) and client.focus():
139             if stacked_cycle_raise:
140                 ob.openbox.screen(data.screen).raiseWindow(client)
141             return
142
143 def _focus_stacked_ungrab(data):
144     global _cyc_mask;
145     global _cyc_key;
146     global _doing_stacked;
147
148     if data.action == ob.KeyAction.Release:
149         # have all the modifiers this started with been released?
150         if not _cyc_mask & data.state:
151             _destroy_popup_list()
152             ob.kungrab()
153             ob.mungrab()
154             _doing_stacked = 0;
155             client = ob.openbox.findClient(_cyc_w)
156             if client:
157                 data.client = client
158                 #_focused(data) # resort the list as appropriate
159                 if cycle_raise:
160                     ob.openbox.screen(data.screen).raiseWindow(client)
161
162 _list_widget = 0
163 _list_labels = []
164 _list_windows = []
165
166 def _hilite_popup_list(data):
167     global _cyc_w, _doing_stacked
168     global _list_widget, _list_labels, _list_windows
169     found = 0
170
171     if not _list_widget and _doing_stacked:
172         _create_popup_list(data)
173     
174     if _list_widget:
175         i = 0
176         for w in _list_windows:
177             if w == _cyc_w:
178                 _list_labels[i].focus()
179                 found = 1
180             else:
181                 _list_labels[i].unfocus()
182             i += 1
183     if not found:
184         _create_popup_list(data)
185
186 def _destroy_popup_list():
187     global _list_widget, _list_labels, _list_windows
188     if _list_widget:
189         _list_windows = []
190         _list_labels = []
191         _list_widget = 0
192     
193 def _create_popup_list(data):
194     global avoid_skip_taskbar
195     global _list_widget, _list_labels, _list_windows, _clients
196
197     if _list_widget:
198         _destroy_popup_list()
199     
200     style = ob.openbox.screen(data.screen).style()
201     _list_widget = otk.Widget(ob.openbox, style,
202                               otk.Widget.Vertical, 0,
203                               style.bevelWidth(), 1)
204     t = style.titlebarFocusBackground()
205     _list_widget.setTexture(t)
206
207     titles = []
208     font = style.labelFont()
209     height = font.height()
210     longest = 0
211     desktop = ob.openbox.screen(data.screen).desktop()
212     for c in _clients:
213         client = ob.openbox.findClient(c)
214         if client and _focusable(client, desktop):
215             t = client.title()
216             if len(t) > 50: # limit the length of titles
217                 t = t[:24] + "..." + t[-24:]
218             titles.append(t)
219             _list_windows.append(c)
220             l = font.measureString(t)
221             if l > longest: longest = l
222     if len(titles) > 1:
223         for t in titles:
224             w = otk.FocusLabel(_list_widget)
225             w.fitSize(longest, height)
226             w.setText(t)
227             w.unfocus()
228             _list_labels.append(w)
229         _list_widget.update()
230         area = otk.display.screenInfo(data.screen).rect()
231         _list_widget.move(area.x() + (area.width() -
232                                       _list_widget.width()) / 2,
233                           area.y() + (area.height() -
234                                       _list_widget.height()) / 2)
235         _list_widget.show(1)
236     else:
237         _destroy_popup_list() # nothing (or only 1) to list
238
239 def focus_next_stacked(data, forward=1):
240     """Focus the next (or previous, with forward=0) window in a stacked
241        order."""
242     global _cyc_mask
243     global _cyc_key
244     global _cyc_w
245     global _cyc_screen
246     global _doing_stacked
247
248     if _doing_stacked:
249         if _cyc_key == data.key:
250             _do_stacked_cycle(data,forward)
251     else:
252         _cyc_mask = data.state
253         _cyc_key = data.key
254         _cyc_w = 0
255         _cyc_screen = data.screen
256         _doing_stacked = 1
257
258         global stacked_cycle_popup_list
259         if stacked_cycle_popup_list:
260             _create_popup_list(data)
261
262         ob.kgrab(data.screen, _focus_stacked_ungrab)
263         # the pointer grab causes pointer events during the keyboard grab to
264         # go away, which means we don't get enter notifies when the popup
265         # disappears, screwing up the focus
266         ob.mgrab(data.screen)
267         focus_next_stacked(data, forward) # start with the first press
268
269 def focus_prev_stacked(data):
270     """Focus the previous window in a stacked order."""
271     focus_next_stacked(data, forward=0)
272
273 def focus_next(data, num=1, forward=1):
274     """Focus the next (or previous, with forward=0) window in a linear
275        order."""
276     global avoid_skip_taskbar
277
278     screen = ob.openbox.screen(data.screen)
279     count = screen.clientCount()
280
281     if not count: return # no clients
282     
283     target = 0
284     if data.client:
285         client_win = data.client.window()
286         found = 0
287         r = range(count)
288         if not forward:
289             r.reverse()
290         for i in r:
291             if found:
292                 target = i
293                 found = 2
294                 break
295             elif screen.client(i).window() == client_win:
296                 found = 1
297         if found == 1: # wraparound
298             if forward: target = 0
299             else: target = count - 1
300
301     t = target
302     desktop = screen.desktop()
303     while 1:
304         client = screen.client(t)
305         if client and _focusable(client, desktop) and client.focus():
306             if cycle_raise:
307                 screen.raiseWindow(client)
308             return
309         if forward:
310             t += num
311             if t >= count: t -= count
312         else:
313             t -= num
314             if t < 0: t += count
315         if t == target: return # nothing to focus
316
317 def focus_prev(data, num=1):
318     """Focus the previous window in a linear order."""
319     focus_next(data, num, forward=0)
320
321
322 ob.ebind(ob.EventAction.NewWindow, _new_win)
323 ob.ebind(ob.EventAction.CloseWindow, _close_win)
324 ob.ebind(ob.EventAction.Focus, _focused)
325
326 print "Loaded focus.py"