[kupfer: 17/31] Add a triggers plugin.

[Ulrik Sverdrup <usverdrup src gnome org>]

commit e9302e227953ef893289d36b20177d3db865fa6f
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date:   Wed Dec 30 06:31:43 2009 +0100

    Add a triggers plugin.
    
    With the remove trigger action, the trigger handling is almost
    complete. This plugin is highly experimental but already works
    surprisingly well;  you notice here that this plugin has no preference
    pane but only uses Kupfer's "normal" interface -- this is since it is
    so convenient and easy to add to Kupfer using this method if you are
    used to it.

 kupfer/plugin/triggers.py |  117 +++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 117 insertions(+), 0 deletions(-)
---
diff --git a/kupfer/plugin/triggers.py b/kupfer/plugin/triggers.py
new file mode 100644
index 0000000..5f569db
--- /dev/null
+++ b/kupfer/plugin/triggers.py
@@ -0,0 +1,117 @@
+import gtk
+
+
+from kupfer import keybindings
+
+from kupfer.objects import Leaf, Action, Source
+from kupfer.objects import ComposedLeaf, TextLeaf, RunnableLeaf
+from kupfer import puid
+
+__kupfer_name__ = _("Triggers")
+__kupfer_sources__ = ("Triggers", )
+__kupfer_actions__ = (
+	"AddTrigger",
+)
+__description__ = _("Trigger actions")
+__version__ = ""
+__author__ = "Ulrik Sverdrup <ulrik sverdrup gmail com>"
+
+_PRIVATE_KEYBINDING_MASK = 0xFF00
+
+class Trigger (RunnableLeaf):
+	def get_actions(self):
+		for act in RunnableLeaf.get_actions(self):
+			yield act
+		yield RemoveTrigger()
+	def run(self):
+		Triggers.perform_trigger(self.object)
+
+class Triggers (Source):
+	instance = None
+
+	def __init__(self):
+		Source.__init__(self, _("Triggers"))
+		self.trigger_table = {}
+	
+	def initialize(self):
+		Triggers.instance = self
+		keybindings.GetKeyboundObject().connect("keybinding", self._callback)
+		for target, (keystr, name, id_) in self.trigger_table.iteritems():
+			keybindings.bind_key(keystr, target)
+		self.output_debug(self.trigger_table)
+
+	def _callback(self, keyobj, target, event_time):
+		self.perform_trigger(target)
+
+	def get_items(self):
+		for target, (keystr, name, id_) in self.trigger_table.iteritems():
+			label = gtk.accelerator_get_label(*gtk.accelerator_parse(keystr))
+			yield Trigger(target, u"%s (%s)" % (label or keystr, name))
+
+	@classmethod
+	def perform_trigger(cls, target):
+		try:
+			keystr, name, id_ = cls.instance.trigger_table[target]
+		except KeyError:
+			return
+		obj = puid.resolve_unique_id(id_)
+		if obj is None:
+			return
+		obj.run()
+
+	@classmethod
+	def add_trigger(cls, leaf, keystr):
+		Triggers.instance._add_trigger(leaf, keystr)
+
+	@classmethod
+	def remove_trigger(cls, target):
+		Triggers.instance._remove_trigger(target)
+	
+	def _add_trigger(self, leaf, keystr):
+		X = _PRIVATE_KEYBINDING_MASK
+		for target in xrange(X, X + 1000):
+			if target not in self.trigger_table:
+				break
+		keybindings.bind_key(keystr, target)
+		name = unicode(leaf)
+		self.trigger_table[target] = (keystr, name, puid.get_unique_id(leaf))
+		self.mark_for_update()
+
+	def _remove_trigger(self, target):
+		self.trigger_table.pop(target, None)
+		keybindings.bind_key(None, target)
+		self.mark_for_update()
+
+	def get_icon_name(self):
+		return "key_bindings"
+
+class AddTrigger (Action):
+	def __init__(self):
+		Action.__init__(self, _("Add Trigger..."))
+	
+	def activate(self, leaf, iobj):
+		Triggers.add_trigger(leaf, iobj.object)
+
+	def item_types(self):
+		yield ComposedLeaf
+
+	def requires_object(self):
+		return True
+	def object_types(self):
+		yield TextLeaf
+	def valid_object(self, iobj, for_item=None):
+		val, mod = gtk.accelerator_parse(iobj.object)
+		return val or mod
+
+	def get_icon_name(self):
+		return "list-add"
+
+class RemoveTrigger (Action):
+	def __init__(self):
+		Action.__init__(self, _("Remove Trigger"))
+
+	def activate(self, leaf):
+		Triggers.remove_trigger(leaf.object)
+
+	def get_icon_name(self):
+		return "list-remove"