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
|
# -*- coding: utf-8 -*-
#
# Caribou - text entry and UI navigation application
#
# Copyright (C) 2009 Eitan Isaacson <eitan@monotonous.org>
# Copyright (C) 2010 Warp Networks S.L.
# * Contributor: Daniel Baeyens <dbaeyens@warp.es>
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU Lesser General Public License as published by the
# Free Software Foundation; either version 2.1 of the License, or (at your
# option) any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
# for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
import animation
from caribou import data_path
import gconf
import gtk
import gtk.gdk as gdk
import opacity
import os
import sys
CARIBOU_GCONF_LAYOUT_KEY = '/apps/caribou/osk/layout'
CARIBOU_LAYOUT_DIR = 'keyboards'
class CaribouWindow(gtk.Window):
__gtype_name__ = "CaribouWindow"
def __init__(self, text_entry_mech, default_placement=None,
min_alpha=1.0, max_alpha=1.0, max_distance=100):
super(CaribouWindow, self).__init__(gtk.WINDOW_POPUP)
self.set_name("CaribouWindow")
self._vbox = gtk.VBox()
self.add(self._vbox)
self.keyboard = text_entry_mech
self._vbox.pack_start(text_entry_mech)
self.connect("size-allocate", lambda w, a: self._update_position())
self._gconf_client = gconf.client_get_default()
self._cursor_location = gdk.Rectangle()
self._entry_location = gdk.Rectangle()
self._default_placement = default_placement or \
CaribouWindowPlacement()
conf_file_path = self._get_keyboard_conf()
if conf_file_path:
text_entry_mech.load_kb(conf_file_path)
self.connect('show', self._on_window_show)
def destroy(self):
self.keyboard.destroy()
super(gtk.Window, self).destroy()
def set_cursor_location(self, cursor_location):
self._cursor_location = cursor_location
self._update_position()
def set_entry_location(self, entry_location):
self._entry_location = entry_location
self._update_position()
def set_default_placement(self, default_placement):
self._default_placement = default_placement
self._update_position()
def _get_root_bbox(self):
root_window = gdk.get_default_root_window()
args = root_window.get_position() + root_window.get_size()
root_bbox = gdk.Rectangle(*args)
current_screen = gtk.gdk.screen_get_default().get_number()
for panel in self._gconf_client.all_dirs('/apps/panel/toplevels'):
orientation = self._gconf_client.get_string(panel+'/orientation')
size = self._gconf_client.get_int(panel+'/size')
screen = self._gconf_client.get_int(panel+'/screen')
if screen != current_screen:
continue
if orientation == 'top':
root_bbox.y += size
root_bbox.height -= size
elif orientation == 'bottom':
root_bbox.height -= size
elif orientation == 'right':
root_bbox.x += size
root_bbox.width -= size
elif orientation == 'left':
root_bbox.x -= size
return root_bbox
def _calculate_position(self, placement=None):
root_bbox = self._get_root_bbox()
placement = placement or self._default_placement
x = self._calculate_axis(placement.x, root_bbox)
y = self._calculate_axis(placement.y, root_bbox)
return x, y
def _update_position(self):
x, y = self._calculate_position()
root_bbox = self._get_root_bbox()
proposed_position = \
gdk.Rectangle(x, y, self.allocation.width, self.allocation.height)
x += self._default_placement.x.adjust_to_bounds(root_bbox, proposed_position)
y += self._default_placement.y.adjust_to_bounds(root_bbox, proposed_position)
self.move(x, y)
def _calculate_axis(self, axis_placement, root_bbox):
bbox = root_bbox
if axis_placement.stickto == CaribouWindowPlacement.CURSOR:
bbox = self._cursor_location
elif axis_placement.stickto == CaribouWindowPlacement.ENTRY:
bbox = self._entry_location
offset = axis_placement.get_offset(bbox)
if axis_placement.align == CaribouWindowPlacement.END:
offset += axis_placement.get_length(bbox)
if axis_placement.gravitate == CaribouWindowPlacement.INSIDE:
offset -= axis_placement.get_length(self.allocation)
elif axis_placement.align == CaribouWindowPlacement.START:
if axis_placement.gravitate == CaribouWindowPlacement.OUTSIDE:
offset -= axis_placement.get_length(self.allocation)
elif axis_placement.align == CaribouWindowPlacement.CENTER:
offset += axis_placement.get_length(bbox)/2
return offset
def _get_keyboard_conf(self):
layout = self._gconf_client.get_string(CARIBOU_GCONF_LAYOUT_KEY) \
or "qwerty"
conf_file_path = os.path.join(data_path, CARIBOU_LAYOUT_DIR, layout)
if os.path.exists(conf_file_path):
return conf_file_path
else:
json_path = '%s.json' % conf_file_path
if os.path.exists(json_path):
return json_path
xml_path = '%s.xml' % conf_file_path
if os.path.exists(xml_path):
return xml_path
def show_all(self):
gtk.Window.show_all(self)
self.keyboard.show_all()
def hide_all(self):
self.keyboard.hide_all()
gtk.Window.hide_all(self)
def _on_window_show(self, window):
child = self.get_child()
border = self.get_border_width()
w, h = child.size_request()
self.resize(w + border, h + border)
class CaribouWindowDocked(CaribouWindow,
animation.AnimatedWindowBase,
opacity.ProximityWindowBase):
__gtype_name__ = "CaribouWindowDocked"
def __init__(self, text_entry_mech):
placement = CaribouWindowPlacement(
xalign=CaribouWindowPlacement.END,
yalign=CaribouWindowPlacement.START,
xstickto=CaribouWindowPlacement.SCREEN,
ystickto=CaribouWindowPlacement.SCREEN,
xgravitate=CaribouWindowPlacement.INSIDE)
CaribouWindow.__init__(self, text_entry_mech, placement)
animation.AnimatedWindowBase.__init__(self)
opacity.ProximityWindowBase.__init__(
self, min_alpha=0.5, max_alpha=0.8)
self.connect('map-event', self.__onmapped)
def __onmapped(self, obj, event):
self._roll_in()
def _roll_in(self):
x, y = self.get_position()
self.move(x + self.allocation.width, y)
return self.animated_move(x, y)
def _roll_out(self):
x, y = self.get_position()
return self.animated_move(x + self.allocation.width, y)
def hide_all(self):
animation = self._roll_out()
animation.connect('completed', lambda x: CaribouWindow.hide_all(self))
def hide(self):
animation = self._roll_out()
animation.connect('completed', lambda x: CaribouWindow.hide(self))
class CaribouWindowEntry(CaribouWindow):
__gtype_name__ = "CaribouWindowEntry"
def __init__(self, text_entry_mech):
placement = CaribouWindowPlacement(
xalign=CaribouWindowPlacement.START,
xstickto=CaribouWindowPlacement.ENTRY,
ystickto=CaribouWindowPlacement.ENTRY,
xgravitate=CaribouWindowPlacement.INSIDE,
ygravitate=CaribouWindowPlacement.OUTSIDE)
CaribouWindow.__init__(self, text_entry_mech, placement, min_alpha=0.075,
max_alpha=0.8)
def _calculate_axis(self, axis_placement, root_bbox):
offset = CaribouWindow._calculate_axis(self, axis_placement, root_bbox)
if axis_placement.axis == 'y':
if offset + self.allocation.height > root_bbox.height + root_bbox.y:
new_axis_placement = axis_placement.copy(align=CaribouWindowPlacement.START)
offset = CaribouWindow._calculate_axis(self, new_axis_placement, root_bbox)
return offset
class CaribouWindowPlacement(object):
START = 'start'
END = 'end'
CENTER = 'center'
SCREEN = 'screen'
ENTRY = 'entry'
CURSOR = 'cursor'
INSIDE = 'inside'
OUTSIDE = 'outside'
class _AxisPlacement(object):
def __init__(self, axis, align, stickto, gravitate):
self.axis = axis
self.align = align
self.stickto = stickto
self.gravitate = gravitate
def copy(self, align=None, stickto=None, gravitate=None):
return self.__class__(self.axis,
align or self.align,
stickto or self.stickto,
gravitate or self.gravitate)
def get_offset(self, bbox):
return bbox.x if self.axis == 'x' else bbox.y
def get_length(self, bbox):
return bbox.width if self.axis == 'x' else bbox.height
def adjust_to_bounds(self, root_bbox, child_bbox):
child_vector_start = self.get_offset(child_bbox)
child_vector_end = self.get_length(child_bbox) + child_vector_start
root_vector_start = self.get_offset(root_bbox)
root_vector_end = self.get_length(root_bbox) + root_vector_start
if root_vector_end < child_vector_end:
return root_vector_end - child_vector_end
if root_vector_start > child_vector_start:
return root_vector_start - child_vector_start
return 0
def __init__(self,
xalign=None, xstickto=None, xgravitate=None,
yalign=None, ystickto=None, ygravitate=None):
self.x = self._AxisPlacement('x',
xalign or self.END,
xstickto or self.CURSOR,
xgravitate or self.OUTSIDE)
self.y = self._AxisPlacement('y',
yalign or self.END,
ystickto or self.CURSOR,
ygravitate or self.OUTSIDE)
|
