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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
|
#!/usr/bin/env python
#
#"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
# Copyright (C) 2007 Hubert Berezowski
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 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 General Public License for more details.
#
# You should have received a copy of the GNU 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.
#
#
#
#"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
# .~SSS' '' ' s' `~:. `.SSSSS'''''aS
# >Ss''''.'SSSs '; >SSS'''.'SS
# ,'''S', ~`'SSSSSs `~ ,''''S'' .
# '''','' A. `'SSSSSs ,''''',' `A;.
#'' s' K. ..N. `'SSSSS'''''''sSs. ~a;.,;
#''SSSs E.~ Y >SSS'''';'.SSSSs. ~a.``
#`'SSSSSs Y ,''''S',' ,. `'SSSSs. ~;>
# `'SSSSSs. ,'''''',' 'I;. `'SSSSs. ,
#;k `'SSSS''''''''s' <E;... ~L. `'SSSS''
#df ,SSS'''''.'SSSs `X. ``~'E> >SS''
# `''''S''''` `'SSSSs ~A. ,`'''S''
#
# ADD KEYBOARD SHORTCUTS TO EXAILE
from gettext import gettext as _
import xl.plugins as plugins
import gtk
from gobject import source_remove,io_add_watch
from xl import common
try:
from Xlib.display import Display
from Xlib import X
except ImportError:
X = None
PLUGIN_NAME = _("Keyboard Shortcuts")
PLUGIN_AUTHORS = ['Hubert Berezowski <hubertb2@wp.pl>']
PLUGIN_VERSION = '0.1.6'
PLUGIN_DESCRIPTION = _(r""" Keyboard Shortcuts via the X Server.
\n\n
Requires Python-Xlib
\n
http://python-xlib.sourceforge.net/""")
PLUGIN_ENABLED = False
b = gtk.Button()
PLUGIN_ICON = b.render_icon(gtk.STOCK_BOLD, gtk.ICON_SIZE_MENU)
b.destroy()
CONNS = plugins.SignalContainer()
class XlibKeys:
def __init__(self):
'''
test for settings and connect them with xlib
'''
# actionlist, the keys of the keyb dictionary, sorting order in the configure panel
self.actionlist = ['play','pause','stop','next Track','previous Track','seek forward','seek backward','volume up','volume down','show osd']
# load settings or use default
try:
self.getsettings()
except:
# [key] [button] [ 1=pressed 0=unpressed ] [ a function the key will call ]
# [ ] [text ] [ leave this 0 ] [ or a direct exaile command ]
# v v v v v v v v v v
# keyb = 'name':[keyname,keycode,shift,ctrl,alt,mod1,mod2,callback,callback-arguments]
# ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
# keyb = '* ':[str ,int ,int ,int ,int,int,int ,str ,str ]
self.keyb = {'play': ['not defined', 0, 0, 0, 0, 0, 0, 'APP.player.play',''],
'stop': ['not defined', 0, 0, 0, 0, 0, 0, 'APP.player.stop',''],
'pause': ['not defined', 0, 0, 0, 0, 0, 0, 'APP.player.toggle_pause',''],
'next Track': ['not defined', 0, 0, 0, 0, 0, 0, 'APP.player.next',''],
'previous Track':['not defined', 0, 0, 0, 0, 0, 0, 'APP.player.previous',''],
'seek forward': ['not defined', 0, 0, 0, 0, 0, 0, 'seekForward','5'],
'seek backward': ['not defined', 0, 0, 0, 0, 0, 0, 'seekBack','5'],
'volume up': ['not defined', 0, 0, 0, 0, 0, 0, 'volUp5','2'],
'volume down': ['not defined', 0, 0, 0, 0, 0, 0, 'volDown5','2'],
'show osd': ['not defined', 0, 0, 0, 0, 0, 0, 'APP.show_osd',''],
}
# connect loaded settings with X
# start listening
self.listen()
def ButtonHit(self,event):
'''##########################################################################
a mapped button was hit! do specified exaile action
'''
# specify actions:
def seekBack(step):
APP.player.seek(APP.player.get_position()/1000000000-step)
APP.show_osd()
def seekForward(step):
APP.player.seek(APP.player.get_position()/1000000000+step)
APP.show_osd()
def volUp5(step):
APP.volume.set_value(APP.volume.value+step)
def volDown5(step):
APP.volume.set_value(APP.volume.value-step)
# run the function keyb[callback]([arguments]) if keyb[kecode] == x.event
for i in self.keyb.values():
if i[1] == event:
eval (i[7]+'('+i[8]+')')
def extras(self,key):
'''#########################################################################
called by updatebuttons() in the configure method. will return a gtk widget
which will be between the label and key-button.
'''
def setextra(value):
self.keyb[key][8]=str(value.value)
if key == 'seek forward':
container = gtk.HBox(False, 0)
adjustments = gtk.Adjustment(float(self.keyb[key][8]), 1, 50, 1, 0, 0)
adjustments.connect("value_changed", setextra)
zeichen = gtk.Label(" ")
label = gtk.Label(_("sec."))
steps = gtk.HScale(adjustments)
steps.set_value_pos(gtk.POS_LEFT)
steps.set_usize( 100, 0)
container.pack_start(zeichen, True, True, 3)
container.pack_start(steps, True, True, 3)
container.pack_start(label, False, False, 3)
zeichen.show()
steps.show()
label.show()
return container
if key == 'seek backward':
container = gtk.HBox(False, 0)
adjustments = gtk.Adjustment(float(self.keyb[key][8]), 1, 50, 1, 0, 0)
adjustments.connect("value_changed", setextra)
zeichen = gtk.Label("-")
label = gtk.Label(_("sec."))
steps = gtk.HScale(adjustments)
steps.set_value_pos(gtk.POS_LEFT)
steps.set_usize( 100, 0)
container.pack_start(zeichen, True, True, 3)
container.pack_start(steps, True, True, 3)
container.pack_start(label, False, False, 3)
#steps.set_inverted(True)
zeichen.show()
steps.show()
label.show()
return container
if key == 'volume up':
zeichen = gtk.Label(" ")
container = gtk.HBox(False, 0)
adjustments = gtk.Adjustment(float(self.keyb[key][8]), 0, 25, 1, 0, 0)
adjustments.connect("value_changed", setextra)
steps = gtk.HScale(adjustments)
steps.set_value_pos(gtk.POS_LEFT)
steps.set_usize( 100, 0)
label = gtk.Label("%")
container.pack_start(zeichen, True, True, 3)
container.pack_start(steps, True, True, 3)
container.pack_start(label, False, False, 3)
steps.show()
zeichen.show()
label.show()
return container
if key == 'volume down':
zeichen = gtk.Label("-")
container = gtk.HBox(False, 0)
adjustments = gtk.Adjustment(float(self.keyb[key][8]), 0, 25, 1, 0, 0)
adjustments.connect("value_changed", setextra)
steps = gtk.HScale(adjustments)
#steps.set_inverted(True)
steps.set_value_pos(gtk.POS_LEFT)
steps.set_usize( 100, 0)
label = gtk.Label("%")
container.pack_start(zeichen, True, True, 3)
container.pack_start(steps, True, True, 3)
container.pack_start(label, False, False, 3)
steps.show()
zeichen.show()
label.show()
return container
##################################################################################
#
# If you want to add your custom shortcut, this is as far as you have to edit this
# file. The Rest is generic stuff that should work with any action. As long as it
# follows following pattern:
#
# in the __init__ method:
# a valid entry(see comments) in the keyb dictionary and actionlist
#
# optional:
# in the Buttonhit method:
# a function called by the 7the entry in the dict
#
# in the extras method:
# additional config menu items
#
##################################################################################
def freeKey(self):
'''#######################################################################
stop grabbing without a trace (i hope)
'''
source_remove(self.listener)
self.grabKey('free')
#self.disp.close()
def grabKey(self,action):
'''#######################################################################
Connect / disconnect Keys to grab
'''
# Make a xlib Mask for every key in the settings-dict
for key in self.keyb.keys():
if self.keyb[key][0] != 'not defined':
maske = ''
if self.keyb[key][2] == 1:
maske += '|X.ShiftMask'
if self.keyb[key][3] == 1:
maske += '|X.ControlMask'
if self.keyb[key][4] == 1:
maske += '|X.Mod1Mask'
if self.keyb[key][5] == 1:
maske += '|X.Mod2Mask'
if self.keyb[key][6] == 1:
maske += '|X.Mod3Mask'
def checkmask(maske):
# make sure the mask is valid
if maske != '':
amaske = maske.lstrip('|')
return eval(amaske)
else:
return X.AnyModifier
if action == 'grab':
# ...and grab it...
#print 'grab hit'
self.root.grab_key(self.keyb[key][1], checkmask(maske), 1,X.GrabModeAsync, X.GrabModeAsync)
#print 'grabbed '+str(self.keyb[key][1])
elif action == 'free':
# ...or ungrab it.
self.root.ungrab_key(self.keyb[key][1], checkmask(maske))
self.disp.flush()
#print 'ungrabbed '+str(self.keyb[key][1])
def listen(self):
'''##########################################################################
connect xlib to the dictionary with the keys
'''
# select display to listen on
self.disp = Display()
self.root = self.disp.screen().root
# specify event
self.root.change_attributes(event_mask = X.KeyPressMask)
self.grabKey('grab')
#print 'listening'
def checkKey(arg1,arg2):
#print arg1,arg2
event = self.disp.next_event()
if event.type == X.KeyPress:
self.ButtonHit(event.detail)
return True
self.listener = io_add_watch(self.disp, 1 ,checkKey)
print self.disp.pending_events()
def savesettings(self):
'''##########################################################################
Save the working dictionary a a string
'''
#print 'savesettings'
for k in self.keyb.keys():
#print self.keyb[k]
APP.settings.set_str(k, str(self.keyb[k]), plugin=plugins.name(__file__))
def getsettings(self):
'''##########################################################################
Get the string and convert it back to the state it was before saving
'''
#value = get_str('setting_name_1', default='some string', plugin=plugins.name(__file__))
# this dictionary will hold the setting
self.keyb = {}
for action in self.actionlist:
# get values, remove garbage and split values into a list
values = APP.settings.get_str(action, default='some string', plugin=plugins.name(__file__)).strip('[]').rsplit(',')
# convert values into desired types
clean = [values[0].lstrip(' ').strip('\''),int(values[1]),int(values[2]),int(values[3]),int(values[4]),int(values[5]),int(values[6]),values[7].lstrip(' ').strip('\''),values[8].lstrip(' ').strip('\'')]
# finally put all into the dict
self.keyb[action] = clean
def configdialog(self):
'''##########################################################################
'''
def defineNewKey(widget,data):
def keypressed(widget, event):
mod = 0
# put pressed modifiers into the list and count them
####
if 'GDK_SHIFT_MASK' in event.state.value_names:
self.keyb[data][2] = 1
mod += 1
else:
self.keyb[data][2] = 0
if 'GDK_CONTROL_MASK' in event.state.value_names:
self.keyb[data][3] = 1
mod += 1
else:
self.keyb[data][3] = 0
if 'GDK_MOD1_MASK' in event.state.value_names:
self.keyb[data][4] = 1
mod += 1
else:
self.keyb[data][4] = 0
if 'GDK_MOD2_MASK' in event.state.value_names:
self.keyb[data][5] = 1
mod += 1
else:
self.keyb[data][5] = 0
if 'GDK_MOD3_MASK' in event.state.value_names:
self.keyb[data][6] = 1
mod += 1
else:
self.keyb[data][6] = 0
#### now sort out the exceptions
# omitt doing an action for modifier key events
if event.string == '':
print 'mod hit'
elif mod == 0:
print 'no mod used'
else:
# If the user entered a valid keycombination, save the key in the dict
# and reload the main-plugin-configuration dialog
# so that the label on the button shows the correct key
# but first check if the key is already mapped
used = ''
for kcode in self.keyb:
if self.keyb[kcode][1] == event.hardware_keycode:
if self.keyb[kcode][0] != self.keyb[data][0]:
used = kcode
if used == '':
self.keyb[data][0] = gtk.gdk.keyval_name(event.keyval)
self.keyb[data][1] = event.hardware_keycode
pkeyinfo.destroy()
updatebuttons()
else:
useddialog = gtk.MessageDialog(APP.window, gtk.DIALOG_DESTROY_WITH_PARENT,
gtk.MESSAGE_INFO,
gtk.BUTTONS_OK,
_("Key already mapped by %s") % used)
useddialog.run()
useddialog.destroy()
#######################################################################
# dialog = gtk.Dialog("Configure Exaile Shortcuts",
# APP.window,
# gtk.DIALOG_DESTROY_WITH_PARENT,
# (gtk.STOCK_CANCEL, gtk.RESPONSE_REJECT,
# gtk.STOCK_OK, gtk.RESPONSE_ACCEPT))
pkeyinfo = gtk.MessageDialog(APP.window, gtk.DIALOG_DESTROY_WITH_PARENT,
gtk.MESSAGE_INFO, gtk.BUTTONS_CANCEL,
_("Please Press a Key for '%s' while holding one or more modifier Keys (ctrl, shift, alt)") % data)
pkeyinfo.add_events(gtk.gdk.KEY_PRESS_MASK)
pkeyinfo.connect('key-press-event', keypressed)
pkeyinfo.run()
pkeyinfo.destroy()
def clearKey(widget, data):
# user clicked the 'clear' button
self.keyb[data][0]='not defined'
self.keyb[data][1]=0
self.keyb[data][2]=0
self.keyb[data][3]=0
self.keyb[data][4]=0
self.keyb[data][5]=0
self.keyb[data][6]=0
updatebuttons()
# packung -------------------------------------------------+
# label key-button clear-button |
# L defineNewKey() L self.clearKey() |
# L Keypressed() |
#----------------------------------------------------------+
dialog = gtk.Dialog(_("Configure Exaile Shortcuts"),
APP.window,
gtk.DIALOG_DESTROY_WITH_PARENT,
(gtk.STOCK_CANCEL, gtk.RESPONSE_REJECT,
gtk.STOCK_OK, gtk.RESPONSE_ACCEPT))
beschreibung = gtk.Label(_('The shortcuts will be globally accessible in X'))
dialog.vbox.pack_start(beschreibung, False, False, 0)
def updatebuttons():
# remove the refreshbox container holding the old buttons
#try:
dialog.vbox.remove(self.refreshbox)
# create the context for the buttons
self.refreshbox = gtk.VBox(True, 0)
dialog.vbox.pack_start(self.refreshbox, False, False, 5)
beschreibung.set_padding(5, 3)
beschreibung.show()
dialog.set_border_width(5)
for key in self.actionlist:
# create something like this for every key:
#
# +- packung -----------------------------------+
# | [ name ] ( [ extra ] )? [ kname ] [ clk ] |
# +---------------------------------------------+
#
# and put it in the refresh-vbox:
#
# +- dialog.vbox -------+
# | beschreibung(label) |
# --> | +- refreshbox ----+ |
# | | [ packung 1 ] | |
# | | [ packung 2 ] | |
# | | etc ... | |
# --> | +-----------------+ |
# | [cancel][ok] |
# +---------------------+
packung = gtk.HBox(False, 0)
knopf = str(self.keyb[key][0])
if self.keyb[key][2] == 1:
knopf += ' + shift'
if self.keyb[key][3] == 1:
knopf += ' + ctrl'
if self.keyb[key][4] == 1:
knopf += ' + mod1'
if self.keyb[key][5] == 1:
knopf += ' + mod2'
if self.keyb[key][6] == 1:
knopf += ' + mod3'
name = gtk.Label(key)
name.set_width_chars(15)
kname = gtk.Button(knopf)
clk = gtk.Button('clear')
kname.connect("clicked",defineNewKey, key)
clk.connect("clicked",clearKey, key)
self.refreshbox.pack_start(packung, False, False, 5)
packung.pack_start(name, False, False, 5)
# check for extra options
if self.keyb[key][8] != '':
extra = self.extras(key)
packung.pack_start(extra, False, False,5)
extra.show()
packung.pack_start(kname, True, True, 5)
packung.pack_start(clk, False, False, 2)
name.show()
kname.show()
clk.show()
packung.show()
self.refreshbox.show()
# ungrab keys, so that no key is blocked while defining a new shortcut
self.grabKey('free')
source_remove(self.listener)
# create the context for the buttons
self.refreshbox = gtk.VBox(True, 0)
dialog.vbox.pack_start(self.refreshbox, False, False, 5)
beschreibung.set_padding(5, 3)
beschreibung.show()
dialog.set_border_width(5)
updatebuttons()
# If user clicked 'ok' save settings else reload settings
dial = dialog.run()
if dial == gtk.RESPONSE_ACCEPT:
self.savesettings()
self.listen()
elif dial == gtk.RESPONSE_REJECT:
self.getsettings()
self.listen()
dialog.destroy()
def initialize():
"""
Called when the plugin is enabled
"""
if not X:
common.error(APP.window, _('Python-xlib library is not available. '
'Cannot initialize xkeys plugin.'))
return False
APP.window.cuts = XlibKeys()
return True
def destroy():
"""
Called when the plugin is disabled
"""
APP.window.cuts.freeKey()
CONNS.disconnect_all()
def configure():
"""
Called when the user clicks Configure in the Plugin Manager
"""
APP.window.cuts.configdialog()
|