fife-parpg: engine/extensions/pychan/events.py annotate

annotate engine/extensions/pychan/events.py @ 205:54bfd1015b35

* PyChan event handling rework (part I) ** Unified listeners ** ...hopefully more robust attach/detach code. * Added compat, layout and also the new autopsition feature. * Documentation * Minor style fixes in core.

author	phoku@33b003aa-7bff-0310-803a-e67f0ece8222
date	Sat, 14 Mar 2009 12:13:29 +0000
parents	06dddc96ce54
children	e281223a03a6

rev	line source
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	1 # -- coding: utf-8 --
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	2 #coding: utf-8
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	3
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	4 """
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	5 PyChan event handling
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	6 =====================
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	7
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	8 Users shouldn't need to use this module directly.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	9 L{widgets.Widget.capture} and L{widgets.Widget.mapEvents} provide
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	10 a convenient API to capture events.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	11
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	12 Nevertheless to understand how its supposed to work
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	13 take a look at L{EventMapper} and L{EventListener}
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	14
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	15 Event callbacks
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	16 ---------------
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	17
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	18 You can either write callbacks yourself or
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	19 use L{tools.callBackWithArguments} or L{tools.attrSetCallback}
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	20 to generate suitable callbacks.
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	21
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	22 Here's an example callback::
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	23 def dumpEventInfo(event=0,widget=0):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	24 print widget, " received the event ", event
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	25
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	26 Note the signature - C{event} and C{widget} are keyword
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	27 arguments passed to the callback. If doesn't accept either
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	28 C{event} or C{widget} as argument, these are not passed.
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	29
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	30 This way a simple function which ignores C{event} or C{widget}
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	31 can be used, while they are available if needed.
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	32
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	33 Currently only one callback can be set per event. In case
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	34 you don't want to write your own callback that dispatches
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	35 to different callbacks you can use L{tools.chainCallbacks}.
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	36
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	37 Available Events
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	38 ----------------
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	39
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	40 """
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	41
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	42 from compat import guichan
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	43
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	44 import exceptions
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	45 from internal import get_manager
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	46 import tools
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	47 import traceback
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	48
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	49 EVENTS = [
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	50 "mouseEntered",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	51 "mouseExited",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	52 "mousePressed",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	53 "mouseReleased",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	54 "mouseClicked",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	55 "mouseMoved",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	56 "mouseDragged",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	57 "action",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	58 "keyPressed",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	59 "keyReleased",
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	60 ]
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	61
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	62 # Add the EVENTS to the docs.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	63 __doc__ += "".join([" - %s\n" % event for event in EVENTS])
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	64
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	65 # The line before seems to leak the variable event into the global namespace ... remove that!
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	66 # This is a python problem, addressed in python3
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	67 try: del event
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	68 except:pass
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	69
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	70 MOUSE_EVENT, KEY_EVENT, ACTION_EVENT = range(3)
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	71 def getEventType(name):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	72 if "mouse" in name:
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	73 return MOUSE_EVENT
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	74 if "key" in name:
164 5b04a7d3ded6 typo fix spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 157 diff changeset	75 return KEY_EVENT
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	76 return ACTION_EVENT
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	77
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	78
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	79 CALLBACK_NONE_MESSAGE = """\
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	80 You passed None as parameter to %s.capture, which would normally remove a mapped event.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	81 But there was no event mapped. Did you accidently call a function instead of passing it?
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	82 """
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	83 class EventListenerBase(object):
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	84 """
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	85 Redirector for event callbacks.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	86 Use only from L{EventMapper}.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	87
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	88 This class uses the SWIG director feature - overriden
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	89 virtual methods are called from C++ to - listen to
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	90 Guichan events.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	91
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	92 """
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	93 def __init__(self):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	94 super(EventListenerBase,self).__init__()
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	95 self.events = {}
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	96 self.indent = 0
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	97 self.debug = 1
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	98 self.is_attached = False
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	99
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	100 def attach(self,widget):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	101 """
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	102 Start receiving events.
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	103 No need to call this manually.
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	104 """
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	105
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	106 if self.is_attached:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	107 return
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	108 if not self.events:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	109 return
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	110 if self.debug: print "Attach:",self
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	111 self.doAttach(widget.real_widget)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	112 self.widget = widget
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	113 self.is_attached = True
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	114
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	115 def detach(self):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	116 """
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	117 Stop receiving events.
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	118 No need to call this manually.
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	119 """
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	120 if not self.is_attached:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	121 return
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	122 if self.debug: print "Detach:",self
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	123 self.doDetach(self.widget.real_widget)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	124 self.widget = None
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	125 self.is_attached = False
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	126
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	127 def _redirectEvent(self,name,event):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	128 self.indent += 4
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	129 try:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	130 event = self.translateEvent(getEventType(name), event)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	131 if name in self.events:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	132 if self.debug: print "-"*self.indent, name
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	133 for f in self.events[name].itervalues():
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	134 f( event )
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	135
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	136 except:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	137 print name, event
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	138 traceback.print_exc()
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	139 raise
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	140
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	141 finally:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	142 self.indent -= 4
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	143
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	144 def translateEvent(self,event_type,event):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	145 if event_type == MOUSE_EVENT:
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	146 return get_manager().hook.translate_mouse_event(event)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	147 if event_type == KEY_EVENT:
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	148 return get_manager().hook.translate_key_event(event)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	149 return event
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	150
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	151 class _ActionEventListener(EventListenerBase,guichan.ActionListener):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	152 def __init__(self):super(_ActionEventListener,self).__init__()
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	153 def doAttach(self,real_widget): real_widget.addActionListener(self)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	154 def doDetach(self,real_widget): real_widget.removeActionListener(self)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	155
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	156 def action(self,e): self._redirectEvent("action",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	157
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	158 class _MouseEventListener(EventListenerBase,guichan.MouseListener):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	159 def __init__(self):super(_MouseEventListener,self).__init__()
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	160 def doAttach(self,real_widget): real_widget.addMouseListener(self)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	161 def doDetach(self,real_widget): real_widget.removeMouseListener(self)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	162
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	163 def mouseEntered(self,e): self._redirectEvent("mouseEntered",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	164 def mouseExited(self,e): self._redirectEvent("mouseExited",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	165 def mousePressed(self,e): self._redirectEvent("mousePressed",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	166 def mouseReleased(self,e): self._redirectEvent("mouseReleased",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	167 def mouseClicked(self,e): self._redirectEvent("mouseClicked",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	168 def mouseMoved(self,e): self._redirectEvent("mouseMoved",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	169 def mouseDragged(self,e): self._redirectEvent("mouseDragged",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	170
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	171 class _KeyEventListener(EventListenerBase,guichan.KeyListener):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	172 def __init__(self):super(_KeyEventListener,self).__init__()
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	173 def doAttach(self,real_widget): real_widget.addKeyListener(self)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	174 def doDetach(self,real_widget): real_widget.removeKeyListener(self)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	175
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	176 def keyPressed(self,e): self._redirectEvent("keyPressed",e)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	177 def keyReleased(self,e): self._redirectEvent("keyReleased",e)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	178
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	179 class EventMapper(object):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	180 """
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	181 Handles events and callbacks for L{widgets.Widget}
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	182 and derived classes.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	183
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	184 Every PyChan widget has an L{EventMapper} instance
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	185 as attribute B{event_mapper}.
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	186
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	187 This instance handles all necessary house-keeping.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	188 Such an event mapper can be either attached or
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	189 detached. In its attached state an L{EventListener}
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	190 is added to the Guichan widget and will redirect
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	191 the events to the callbacks.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	192
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	193 In its detached state no events are received from the
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	194 real Guichan widget.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	195
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	196 The event mapper starts in the detached state.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	197 When a new event is captured the mapper attaches itself
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	198 automatically. The widget doesn't need to handle that.
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	199 """
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	200 def __init__(self,widget):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	201 super(EventMapper,self).__init__()
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	202 self.widget = widget
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	203 self.listener = {
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	204 KEY_EVENT : _KeyEventListener(),
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	205 ACTION_EVENT : _ActionEventListener(),
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	206 MOUSE_EVENT : _MouseEventListener(),
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	207 }
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	208 self.is_attached = False
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	209 self.debug = get_manager().debug
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	210
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	211 def __repr__(self):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	212 return "EventMapper(%s)" % repr(self.widget)
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	213
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	214
164 5b04a7d3ded6 typo fix spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 157 diff changeset	215 def capture(self,event_name,callback,group_name):
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	216 if event_name not in EVENTS:
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	217 raise exceptions.RuntimeError("Unknown eventname: " + event_name)
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	218
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	219 if callback is None:
166 81a222e7bd25 Fixes for event handling. phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 164 diff changeset	220 if self.isCaptured(event_name,group_name):
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	221 self.removeEvent(event_name,group_name)
164 5b04a7d3ded6 typo fix spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 157 diff changeset	222 elif self.debug:
188 06dddc96ce54 * Fixed some space and tab mixing nihathrael@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 166 diff changeset	223 print CALLBACK_NONE_MESSAGE % str(self.widget)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	224 return
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	225 self.addEvent(event_name,callback,group_name)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	226
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	227 def isCaptured(self,event_name,group_name="default"):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	228 return ("%s/%s" % (event_name,group_name)) in self.getCapturedEvents()
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	229
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	230 def getCapturedEvents(self):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	231 events = []
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	232 for event_type, listener in self.listener.items():
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	233 for event_name, group in listener.events.items():
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	234 for group_name in group.keys():
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	235 events.append( "%s/%s" % (event_name, group_name) )
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	236 return events
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	237
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	238 def getListener(self,event_name):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	239 return self.listener[getEventType(event_name)]
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	240
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	241 def removeEvent(self,event_name,group_name):
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	242 listener = self.getListener(event_name)
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	243 del listener.events[event_name][group_name]
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	244 if not listener.events[event_name]:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	245 del listener.events[event_name]
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	246 if not listener.events:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	247 listener.detach()
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	248
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	249 def addEvent(self,event_name,callback,group_name):
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	250 if not callable(callback):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	251 raise RuntimeError("An event callback must be either a callable or None - not %s" % repr(callback))
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	252
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	253 def captured_f(event):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	254 tools.applyOnlySuitable(callback,event=event,widget=self.widget)
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	255
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	256 listener = self.getListener(event_name)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	257
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	258 if event_name not in listener.events:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	259 listener.events[event_name] = {group_name : captured_f}
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	260 else:
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	261 listener.events[event_name][group_name] = captured_f
54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	262 listener.attach(self.widget)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	263
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	264
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	265 def splitEventDescriptor(name):
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	266 """ Utility function to split "widgetName/eventName" descriptions into tuples. """
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	267 L = name.split("/")
164 5b04a7d3ded6 typo fix spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 157 diff changeset	268 if len(L) not in (1,2,3):
5b04a7d3ded6 typo fix spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 157 diff changeset	269 raise exceptions.RuntimeError("Invalid widgetname / eventname combination: " + name)
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	270 if len(L) == 1:
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	271 L = L[0],"action"
164 5b04a7d3ded6 typo fix spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 157 diff changeset	272 elif L[1] not in EVENTS:
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	273 raise exceptions.RuntimeError("Unknown event name: " + name)
164 5b04a7d3ded6 typo fix spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 157 diff changeset	274 if len(L) == 2:
5b04a7d3ded6 typo fix spq@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 157 diff changeset	275 L = L[0],L[1],"default"
157 bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	276 return L
bb9902910067 input_rework merged! phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: diff changeset	277
205 54bfd1015b35 * PyChan event handling rework (part I) phoku@33b003aa-7bff-0310-803a-e67f0ece8222 parents: 188 diff changeset	278

Mercurial > fife-parpg

annotate engine/extensions/pychan/events.py @ 205:54bfd1015b35