wxPython/src/_evthandler.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _evthandler.i
   3 // Purpose:     SWIG interface for wxEventHandler
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     9-Aug-2003
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup
  18
  19 // wxEvtHandler: the base class for all objects handling wxWindows events
  20 class wxEvtHandler : public wxObject {
  21 public:
  22     // turn off this typemap
  23     %typemap(out) wxEvtHandler*;
  24
  25     wxEvtHandler();
  26
  27     // Turn it back on again
  28     %typemap(out) wxEvtHandler* { $result = wxPyMake_wxObject($1, $owner); }
  29
  30     wxEvtHandler* GetNextHandler();
  31     wxEvtHandler* GetPreviousHandler();
  32     void SetNextHandler(wxEvtHandler* handler);
  33     void SetPreviousHandler(wxEvtHandler* handler);
  34
  35     bool GetEvtHandlerEnabled();
  36     void SetEvtHandlerEnabled(bool enabled);
  37
  38
  39     // process an event right now
  40     bool ProcessEvent(wxEvent& event);
  41
  42     // add an event to be processed later
  43     void AddPendingEvent(wxEvent& event);
  44
  45     // process all pending events
  46     void ProcessPendingEvents();
  47
  48     %extend {
  49         // Dynamic association of a member function handler with the event handler
  50         void Connect( int id, int lastId, int eventType, PyObject* func) {
  51             if (PyCallable_Check(func)) {
  52                 self->Connect(id, lastId, eventType,
  53                           (wxObjectEventFunction) &wxPyCallback::EventThunker,
  54                           new wxPyCallback(func));
  55             }
  56             else if (func == Py_None) {
  57                 self->Disconnect(id, lastId, eventType,
  58                                  (wxObjectEventFunction)
  59                                  &wxPyCallback::EventThunker);
  60             }
  61             else {
  62                 wxPyBLOCK_THREADS(
  63                     PyErr_SetString(PyExc_TypeError, "Expected callable object or None."));
  64             }
  65         }
  66
  67         bool Disconnect(int id, int lastId = -1,
  68                         wxEventType eventType = wxEVT_NULL) {
  69             return self->Disconnect(id, lastId, eventType,
  70                                    (wxObjectEventFunction)
  71                                     &wxPyCallback::EventThunker);
  72         }
  73     }
  74
  75     %pythonAppend _setOORInfo   "args[0].thisown = 0";
  76     %extend {
  77         void _setOORInfo(PyObject* _self, bool incref=true) {
  78             if (_self && _self != Py_None) {
  79                 self->SetClientObject(new wxPyOORClientData(_self, incref));
  80             }
  81             else {
  82                 wxPyOORClientData* data = (wxPyOORClientData*)self->GetClientObject();
  83                 if (data) {
  84                     self->SetClientObject(NULL);  // This will delete it too
  85                 }
  86             }
  87         }
  88     }
  89
  90     %pythoncode {
  91         def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
  92             """
  93             Bind an event to an event handler.
  94
  95             :param event: One of the EVT_* objects that specifies the
  96                           type of event to bind,
  97
  98             :param handler: A callable object to be invoked when the
  99                           event is delivered to self.  Pass None to
 100                           disconnect an event handler.
 101
 102             :param source: Sometimes the event originates from a
 103                           different window than self, but you still
 104                           want to catch it in self.  (For example, a
 105                           button event delivered to a frame.)  By
 106                           passing the source of the event, the event
 107                           handling system is able to differentiate
 108                           between the same event type from different
 109                           controls.
 110
 111             :param id: Used to spcify the event source by ID instead
 112                        of instance.
 113
 114             :param id2: Used when it is desirable to bind a handler
 115                           to a range of IDs, such as with EVT_MENU_RANGE.
 116             """
 117             if source is not None:
 118                 id  = source.GetId()
 119             event.Bind(self, id, id2, handler)
 120
 121         def Unbind(self, event, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
 122             """
 123             Disconencts the event handler binding for event from self.
 124             Returns True if successful.
 125             """
 126             if source is not None:
 127                 id  = source.GetId()
 128             return event.Unbind(self, id, id2)
 129     }
 130
 131     %property(EvtHandlerEnabled, GetEvtHandlerEnabled, SetEvtHandlerEnabled, doc="See `GetEvtHandlerEnabled` and `SetEvtHandlerEnabled`");
 132     %property(NextHandler, GetNextHandler, SetNextHandler, doc="See `GetNextHandler` and `SetNextHandler`");
 133     %property(PreviousHandler, GetPreviousHandler, SetPreviousHandler, doc="See `GetPreviousHandler` and `SetPreviousHandler`");
 134
 135 };
 136
 137 //---------------------------------------------------------------------------