X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a51dff7380c17258a209dd3c9c7fa01444553ee5..eab6e45eef7030527f540c62047fb726b6afc8b8:/wxPython/src/_evthandler.i diff --git a/wxPython/src/_evthandler.i b/wxPython/src/_evthandler.i index f4baaacfdb..915d659f4d 100644 --- a/wxPython/src/_evthandler.i +++ b/wxPython/src/_evthandler.i @@ -85,27 +85,40 @@ public: """ Bind an event to an event handler. - event One of the EVT_* objects that specifies the - type of event to bind, - - handler A callable object to be invoked when the event - is delivered to self. Pass None to disconnect an - event handler. - - source Sometimes the event originates from a different window - than self, but you still want to catch it in self. (For - example, a button event delivered to a frame.) By - passing the source of the event, the event handling - system is able to differentiate between the same event - type from different controls. - - id,id2 Used for menu IDs or for event types that require a - range of IDs + :param event: One of the EVT_* objects that specifies the + type of event to bind, + + :param handler: A callable object to be invoked when the + event is delivered to self. Pass None to + disconnect an event handler. + + :param source: Sometimes the event originates from a + different window than self, but you still + want to catch it in self. (For example, a + button event delivered to a frame.) By + passing the source of the event, the event + handling system is able to differentiate + between the same event type from different + controls. + + :param id: Used to spcify the event source by ID instead + of instance. + + :param id2: Used when it is desirable to bind a handler + to a range of IDs, such as with EVT_MENU_RANGE. """ if source is not None: id = source.GetId() event.Bind(self, id, id2, handler) + def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY): + """ + Disconencts the event handler binding for event from self. + Returns True if successful. + """ + if source is not None: + id = source.GetId() + return event.Unbind(self, id, id2) }