Merge lp:~sdemchenko/glipper/feature-accelerators into lp:glipper

[Stanislav Demchenko]

I have added accelerators to history items and to snippet menu and its items.
Also, a new plugin "Auto paste" can accelerate Glipper usage even further (it sends Control+V key stroke to the active window right after an item selection). Just like item accelerators, auto-pasting works both for history and snippets.

[Laszlo Pandy (laszlok)]

> reserved_accelerators = "0acpu" # _0. Snippets, _About, _Clear, _Preferences, Pl_ugins

This won't work. For example, in the French translation, the accelorator for Pl_ugins is "_Greffons".

The only way I see to make it work across languages is to only use numbers for the accelorators.

[Stanislav Demchenko (sdemchenko)]

Hi Laszlo, thank you for the tip, I'll try to amend this ASAP.
And I have one more question, about plugin Auto Paste: in that plugin
I rely on a command "xte", which is in Ubuntu package "xautomation",
and I'm undecided if I shall
1) add a dependency on that package (to spare users from manual
installation), or
2) ask users to install xautomation themselves (as I do now in a
message box), because the plugin is optional and people may not want
to have extra dependencies.
I implemented the second option to be conservative, but honestly I
feel it just unnecessarily adds some headache to users, and I should
add a dependency on xautomation.
What is your preference?

On Wed, Aug 15, 2012 at 9:37 AM, Laszlo Pandy <email address hidden> wrote:
>> reserved_accelerators = "0acpu" # _0. Snippets, _About, _Clear, _Preferences, Pl_ugins
>
> This won't work. For example, in the French translation, the accelorator for Pl_ugins is "_Greffons".
>
> The only way I see to make it work across languages is to only use numbers for the accelorators.
> --
> https://code.launchpad.net/~sdemchenko/glipper/feature-accelerators/+merge/118856
> You are the owner of lp:~sdemchenko/glipper/feature-accelerators.

[lp:~sdemchenko/glipper/feature-accelerators]

121. By Stanislav Demchenko on 2012-08-15

Replaced hard-coded accelerator characters with their respective internationalized counterparts provided by GTK.

[Joseph Boiteau (josephboiteau)]

so will that be merged?

I'm quite interested by the auto-paste feature myself, it should be an option to set via the Preferences

Unmerged revisions

121. By Stanislav Demchenko on 2012-08-15

Replaced hard-coded accelerator characters with their respective internationalized counterparts provided by GTK.

120. By Stanislav Demchenko on 2012-08-09

Added 'Auto paste' plugin to emulate Control+V on a history or snippet item selection.

119. By Stanislav Demchenko on 2012-08-03

Added a space between the accelerator and the label in menu item "Snippets" (for readability).

118. By Stanislav Demchenko on 2012-08-03

Restored spaces as in trunk to simplify review.
Added 1 extra space between the accelerator character and menu item label to improve readability.

117. By Stanislav Demchenko on 2012-08-01

Added accelerators for menu items in history and in snippets.

=== modified file 'glipper/AppIndicator.py'
--- glipper/AppIndicator.py	2012-08-11 22:07:48 +0000
+++ glipper/AppIndicator.py	2012-08-15 20:12:23 +0000
@@ -7,6 +7,7 @@
 from glipper.Keybinder import *
 from glipper.History import *
 from glipper.PluginsManager import *
+import string
 
 class StatusIcon:
 	def __init__(self):
@@ -76,7 +77,7 @@
 			menu_item.set_sensitive(False)
 			self.menu.append(menu_item)
 		else:
-			for item in history:
+			for i, item in enumerate(history):
 				menu_item = gtk.CheckMenuItem(format_item(item), False)
 				menu_item.set_property('draw-as-radio', True)
 
@@ -91,6 +92,7 @@
 					
 				menu_item.connect('activate', self.on_menu_item_activate, item)
 				self.menu.append(menu_item)
+				add_accelerator(i, menu_item)
 		
 		self.menu.append(gtk.SeparatorMenuItem())
 		
@@ -186,5 +188,27 @@
 	i = item.replace("\n", " ")
 	i = i.replace("\t", " ")
 	if len(item) > max_item_length:
-	  return i[0:max_item_length/2] + u'\u2026' + i[-(max_item_length/2-3):]
+		return i[0:max_item_length/2] + u'\u2026' + i[-(max_item_length/2-3):]
 	return i
+
+def _get_reserved_accelerators():
+	labels = [_("Pl_ugins"), "_0.  " + _("Snippets")]
+	for menu_item in [gtk.ImageMenuItem(gtk.STOCK_ABOUT),
+					  gtk.ImageMenuItem(gtk.STOCK_HELP),
+					  gtk.ImageMenuItem(gtk.STOCK_PREFERENCES),
+					  gtk.ImageMenuItem(gtk.STOCK_CLEAR)]:
+		labels.append(menu_item.get_children()[0].get_label())
+		menu_item.destroy()
+	accelerators_in_use = set()
+	for label in labels:
+		for i, char in enumerate(label):
+			if char == '_' and i + 1 < len(label):
+				accelerators_in_use.add(label[i + 1].lower())
+	return ''.join(accelerators_in_use)
+
+def add_accelerator(pos, menu_item):
+	available_accelerators = (string.digits + string.lowercase).translate(None, _get_reserved_accelerators())
+	if pos < len(available_accelerators):
+		label_with_escaped_underscore = menu_item.get_label().replace('_', '__')
+		menu_item.set_label('_' + available_accelerators[pos] + '.  ' + label_with_escaped_underscore)
+		menu_item.set_use_underline(True)

=== modified file 'glipper/__init__.py'
--- glipper/__init__.py	2011-04-08 23:06:47 +0000
+++ glipper/__init__.py	2012-08-15 20:12:23 +0000
@@ -125,3 +125,6 @@
 
 def format_item(item):
 	return glipper.AppIndicator.format_item(item)
+
+def add_accelerator(order_in_menu, menu_item):
+	return glipper.AppIndicator.add_accelerator(order_in_menu, menu_item)

=== added file 'glipper/plugins/autopaste.py'
--- glipper/plugins/autopaste.py	1970-01-01 00:00:00 +0000
+++ glipper/plugins/autopaste.py	2012-08-15 20:12:23 +0000
@@ -0,0 +1,62 @@
+from gettext import gettext as _
+import os
+import subprocess
+import gtk
+from glipper.AppIndicator import AppIndicator
+
+snippets = __import__("snippets")
+history_original_on_menu_item_activate = AppIndicator.on_menu_item_activate
+snippet_original_on_menu_item_activate = snippets.on_activate
+
+def info():
+	info = {"Name": _("Auto paste"),
+			"Description": _("Pastes the selected item into the active window (emulates a '^+V' key press)."),
+			"Preferences": False}
+	return info
+
+def init():
+	if not is_xte_installed():
+		return
+	enhance_history_on_activate_behavior()
+	enhance_snippet_on_activate_behavior()
+
+def stop():
+	AppIndicator.on_menu_item_activate = history_original_on_menu_item_activate
+	snippets.on_activate = snippet_original_on_menu_item_activate
+
+def enhance_history_on_activate_behavior():
+	def on_menu_item_activate_enhanced(self, menu_item, item):
+		history_original_on_menu_item_activate(self, menu_item, item)
+		paste()
+	AppIndicator.on_menu_item_activate = on_menu_item_activate_enhanced
+
+
+def enhance_snippet_on_activate_behavior():
+	def on_menu_item_activate_enhanced(menu_item, snippet):
+		snippet_original_on_menu_item_activate(menu_item, snippet)
+		paste()
+	snippets.on_activate = on_menu_item_activate_enhanced
+
+def paste():
+	subprocess.call(["xte", "keydown Control_L", "key V", "keyup Control_L"])
+
+def is_xte_installed():
+	devnull = open(os.devnull, 'w')
+	try:
+		subprocess.call(["xte", "-h"], stdout=devnull)
+	except OSError:
+		devnull.close()
+		md = gtk.MessageDialog(
+			None,
+			gtk.DIALOG_DESTROY_WITH_PARENT,
+			gtk.MESSAGE_ERROR,
+			gtk.BUTTONS_CLOSE,
+			_("Plugin 'Auto paste' for Glipper uses command 'xte' from package 'xautomation'.\n"
+			  "To use the plugin, please install the package, e.g. run:\n"
+			  "'sudo apt-get install xautomation'.\n"
+			  "Then disable and re-enable the plugin to activate it."))
+		md.run()
+		md.destroy()
+		return False
+	else:
+		return True
\ No newline at end of file

=== modified file 'glipper/plugins/snippets.py'
--- glipper/plugins/snippets.py	2011-04-09 08:17:59 +0000
+++ glipper/plugins/snippets.py	2012-08-15 20:12:23 +0000
@@ -107,7 +107,8 @@
 	load_snippets()
 	Manager(parent)
 
-menu_item = gtk.MenuItem(_("Snippets"))
+menu_item = gtk.MenuItem("_0.  " + _("Snippets"))
+menu_item.set_use_underline(True)
 menu = gtk.Menu()
 
 def init():
@@ -128,12 +129,13 @@
 	if len(snippets) == 0:
 		menu.append(gtk.MenuItem(_("No snippets available")))
 	else:
-		for snippet in snippets:
+		for i, snippet in enumerate(snippets):
 			item = gtk.MenuItem(glipper.format_item(snippet))
 			if len(snippet) > max_length:
 				item.set_tooltip_text(snippet)
 			item.connect('activate', on_activate, snippet)
 			menu.append(item)
+			glipper.add_accelerator(i, item)
 	
 	menu.show_all()
 	menu_item.set_submenu(menu)