Corrected a return type

[wxWidgets.git] / wxPython / src / events.i

diff --git a/wxPython/src/events.i b/wxPython/src/events.i
index 1b348b9dd9cc505afa17db953b3981881839c22a..3c825cbaf5031dce09b3d6bb1bea63938ce9824e 100644 (file)
--- a/wxPython/src/events.i
+++ b/wxPython/src/events.i
@@ -30,9 +30,20 @@
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+enum Propagation_state
+{
+    // don't propagate it at all
+    wxEVENT_PROPAGATE_NONE = 0,
+
+    // propagate it until it is processed
+    wxEVENT_PROPAGATE_MAX = INT_MAX
+};
+

 
 int wxNewEventType();
 
 
 int wxNewEventType();
 

+
+

 class wxEvent : public wxObject {
 public:
     // wxEvent(int id = 0);     // *** This class is now an ABC
 class wxEvent : public wxObject {
 public:
     // wxEvent(int id = 0);     // *** This class is now an ABC


@@ -41,15 +52,52 @@ public:
     wxObject* GetEventObject();
     wxEventType GetEventType();
     int GetId();
     wxObject* GetEventObject();
     wxEventType GetEventType();
     int GetId();

-    bool GetSkipped();

     long GetTimestamp();
     void SetEventObject(wxObject* object);
     void SetEventType(wxEventType typ);
     void SetId(int id);
     void SetTimestamp(long timeStamp);
     long GetTimestamp();
     void SetEventObject(wxObject* object);
     void SetEventType(wxEventType typ);
     void SetId(int id);
     void SetTimestamp(long timeStamp);

+
+    bool IsCommandEvent() const;
+
+    // Can instruct event processor that we wish to ignore this event
+    // (treat as if the event table entry had not been found): this must be done
+    // to allow the event processing by the base classes (calling event.Skip()
+    // is the analog of calling the base class verstion of a virtual function)

     void Skip(bool skip = TRUE);
     void Skip(bool skip = TRUE);

+    bool GetSkipped() const;
+
+    // Determine if this event should be propagating to the parent window.
+    bool ShouldPropagate() const;
+
+    // Stop an event from propagating to its parent window, returns the old
+    // propagation level value
+    int StopPropagation();

 
 

-    wxEvent *Clone();
+    // Resume the event propagation by restoring the propagation level
+    // (returned by StopPropagation())
+    void ResumePropagation(int propagationLevel);
+
+   wxEvent *Clone();
+};
+
+//---------------------------------------------------------------------------
+
+// Helper class to temporarily change an event not to propagate.
+class  wxPropagationDisabler
+{
+public:
+    wxPropagationDisabler(wxEvent& event);
+    ~wxPropagationDisabler();
+};
+
+
+// Another one to temporarily lower propagation level.
+class  wxPropagateOnce
+{
+public:
+    wxPropagateOnce(wxEvent& event);
+    ~wxPropagateOnce();

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -58,6 +106,8 @@ class wxSizeEvent : public wxEvent {
 public:
     wxSizeEvent(const wxSize& sz, int id = 0);
     wxSize GetSize();
 public:
     wxSizeEvent(const wxSize& sz, int id = 0);
     wxSize GetSize();

+    wxRect GetRect() const;
+    void SetRect(wxRect rect);

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -193,6 +243,30 @@ public:
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+class wxMouseCaptureChangedEvent : public wxEvent
+{
+public:
+    wxMouseCaptureChangedEvent(wxWindowID id = 0, wxWindow* gainedCapture = NULL);
+    wxWindow* GetCapturedWindow() const;
+};
+
+//---------------------------------------------------------------------------
+
+class wxSetCursorEvent : public wxEvent
+{
+public:
+    wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0);
+
+    wxCoord GetX() const;
+    wxCoord GetY() const;
+
+    void SetCursor(const wxCursor& cursor);
+    const wxCursor& GetCursor() const;
+    bool HasCursor() const;
+};
+
+//---------------------------------------------------------------------------
+

 class wxKeyEvent: public wxEvent {
 public:
     wxKeyEvent(int keyEventType);
 class wxKeyEvent: public wxEvent {
 public:
     wxKeyEvent(int keyEventType);


@@ -201,23 +275,31 @@ public:
     bool MetaDown();
     bool AltDown();
     bool ShiftDown();
     bool MetaDown();
     bool AltDown();
     bool ShiftDown();

-    long KeyCode();

 
     long GetKeyCode();
 
     long GetKeyCode();

+    %pragma(python) addtoclass = "KeyCode = GetKeyCode"

     bool HasModifiers();
 
     bool HasModifiers();
 

+    // get the raw key code (platform-dependent)
+    long GetRawKeyCode() const;
+
+    // get the raw key flags (platform-dependent)
+    long GetRawKeyFlags() const;
+

     long GetX();
     long GetY();
     wxPoint GetPosition();
     %name(GetPositionTuple) void GetPosition(long* OUTPUT, long* OUTPUT);
 
     long GetX();
     long GetY();
     wxPoint GetPosition();
     %name(GetPositionTuple) void GetPosition(long* OUTPUT, long* OUTPUT);
 

-    long          m_x, m_y;
-    long          m_keyCode;
-    bool          m_controlDown;
-    bool          m_shiftDown;
-    bool          m_altDown;
-    bool          m_metaDown;
-    bool          m_scanCode;
+    long        m_x, m_y;
+    long        m_keyCode;
+    bool        m_controlDown;
+    bool        m_shiftDown;
+    bool        m_altDown;
+    bool        m_metaDown;
+    bool        m_scanCode;
+    long        m_rawCode;
+    long        m_rawFlags;

 
 };
 
 
 };
 


@@ -241,8 +323,9 @@ public:
 class wxMoveEvent: public wxEvent {
 public:
     wxMoveEvent(const wxPoint& pt, int id = 0);
 class wxMoveEvent: public wxEvent {
 public:
     wxMoveEvent(const wxPoint& pt, int id = 0);

-

     wxPoint GetPosition();
     wxPoint GetPosition();

+    wxRect GetRect() const;
+    void SetRect(wxRect rect);

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -266,7 +349,7 @@ public:
 
 class wxFocusEvent: public wxEvent {
 public:
 
 class wxFocusEvent: public wxEvent {
 public:

-    wxFocusEvent(WXTYPE eventType = 0, int id = 0);
+    wxFocusEvent(int eventType = 0, int id = 0);

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -285,7 +368,7 @@ public:
 
 class wxActivateEvent: public wxEvent{
 public:
 
 class wxActivateEvent: public wxEvent{
 public:

-    wxActivateEvent(WXTYPE eventType = 0, int active = TRUE, int id = 0);
+    wxActivateEvent(int eventType = 0, int active = TRUE, int id = 0);

     bool GetActive();
 };
 
     bool GetActive();
 };
 


@@ -300,8 +383,10 @@ public:
 
 class wxMenuEvent: public wxEvent {
 public:
 
 class wxMenuEvent: public wxEvent {
 public:

-    wxMenuEvent(WXTYPE id = 0, int id = 0);
+    wxMenuEvent(int id = 0, int winid = 0, wxMenu* menu = NULL);

     int GetMenuId();
     int GetMenuId();

+    bool IsPopup();
+    wxMenu* GetMenu() const;

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -373,7 +458,11 @@ public:
             }
 
             for (int i=0; i<count; i++) {
             }
 
             for (int i=0; i<count; i++) {

+#if wxUSE_UNICODE
+                PyList_SetItem(list, i, PyUnicode_FromWideChar(files[i], files[i].Len()));
+#else

                 PyList_SetItem(list, i, PyString_FromString((const char*)files[i]));
                 PyList_SetItem(list, i, PyString_FromString((const char*)files[i]));

+#endif

             }
             return list;
         }
             }
             return list;
         }


@@ -382,15 +471,57 @@ public:
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+// Whether to always send idle events to windows, or
+// to only send update events to those with the
+// wxWS_EX_PROCESS_IDLE style.
+
+enum wxIdleMode
+{
+        // Send idle events to all windows
+    wxIDLE_PROCESS_ALL,
+
+        // Send idle events to windows that have
+        // the wxWS_EX_PROCESS_IDLE flag specified
+    wxIDLE_PROCESS_SPECIFIED
+};
+
+

 class wxIdleEvent: public wxEvent {
 public:
     wxIdleEvent();
     void RequestMore(bool needMore = TRUE);
     bool MoreRequested();
 class wxIdleEvent: public wxEvent {
 public:
     wxIdleEvent();
     void RequestMore(bool needMore = TRUE);
     bool MoreRequested();

+
+    // Specify how wxWindows will send idle events: to
+    // all windows, or only to those which specify that they
+    // will process the events.
+    static void SetMode(wxIdleMode mode) { sm_idleMode = mode; }
+
+    // Returns the idle event mode
+    static wxIdleMode GetMode() { return sm_idleMode ; }
+
+    // Can we send an idle event?
+    static bool CanSend(wxWindow* win) ;
+

 };
 
 //---------------------------------------------------------------------------
 
 };
 
 //---------------------------------------------------------------------------
 

+// Whether to always send update events to windows, or
+// to only send update events to those with the
+// wxWS_EX_PROCESS_UI_UPDATES style.
+
+enum wxUpdateUIMode
+{
+        // Send UI update events to all windows
+    wxUPDATE_UI_PROCESS_ALL,
+
+        // Send UI update events to windows that have
+        // the wxWS_EX_PROCESS_UI_UPDATES flag specified
+    wxUPDATE_UI_PROCESS_SPECIFIED
+};
+
+

 class wxUpdateUIEvent: public wxEvent {
 public:
     wxUpdateUIEvent(wxWindowID commandId = 0);
 class wxUpdateUIEvent: public wxEvent {
 public:
     wxUpdateUIEvent(wxWindowID commandId = 0);


@@ -404,6 +535,29 @@ public:
     void Check(bool check);
     void Enable(bool enable);
     void SetText(const wxString& text);
     void Check(bool check);
     void Enable(bool enable);
     void SetText(const wxString& text);

+
+
+    // Sets the interval between updates in milliseconds.
+    // Set to -1 to disable updates, or to 0 to update as frequently as possible.
+    static void SetUpdateInterval(long updateInterval);
+
+    // Returns the current interval between updates in milliseconds
+    static long GetUpdateInterval();
+
+    // Can we update this window?
+    static bool CanUpdate(wxWindow* win);
+
+    // Reset the update time to provide a delay until the next
+    // time we should update
+    static void ResetUpdateTime();
+
+    // Specify how wxWindows will send update events: to
+    // all windows, or only to those which specify that they
+    // will process the events.
+    static void SetMode(wxUpdateUIMode mode);
+
+    // Returns the UI update mode
+    static wxUpdateUIMode GetMode();

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -474,6 +628,18 @@ public:
 
 //---------------------------------------------------------------------------
 
 
 //---------------------------------------------------------------------------
 

+class wxContextMenuEvent : public wxCommandEvent
+{
+public:
+    wxContextMenuEvent(wxEventType type = wxEVT_NULL,
+                       wxWindowID id = 0,
+                       const wxPoint& pt = wxDefaultPosition);
+    const wxPoint& GetPosition();
+    void SetPosition(const wxPoint& pos);
+};
+
+//----------------------------------------------------------------------
+

 class  wxTimerEvent : public wxEvent
 {
 public:
 class  wxTimerEvent : public wxEvent
 {
 public:


@@ -501,7 +667,7 @@ public:
 
 class wxPyEvent : public wxEvent {
 public:
 
 class wxPyEvent : public wxEvent {
 public:

-    wxPyEvent(int id=0);
+    wxPyEvent(int winid=0, wxEventType commandType = wxEVT_NULL );

     ~wxPyEvent();
 
     %pragma(python) addtomethod = "__init__:self.SetSelf(self)"
     ~wxPyEvent();
 
     %pragma(python) addtomethod = "__init__:self.SetSelf(self)"