Remove wrappers for some functions meant to be interal use only.

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

diff --git a/wxPython/src/_event.i b/wxPython/src/_event.i
index 6e8de85b91ad493aa687be57bbddece1d47cb4a8..004cc784eec4aff7f0bfd5147ae94327d74d50df 100644 (file)
--- a/wxPython/src/_event.i
+++ b/wxPython/src/_event.i
@@ -314,10 +314,6 @@ EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
 EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
 
-EVT_SPIN_UP   = wx.PyEventBinder( wxEVT_SCROLL_LINEUP, 1)
-EVT_SPIN_DOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN, 1)
-EVT_SPIN      = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
-
 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED, 1)
@@ -450,7 +446,8 @@ public:
 
     // Get checkbox value
     bool IsChecked() const;
-
+    %pythoncode { Checked = IsChecked }
+    
     // True if the listbox event was a selection.
     bool IsSelection() const;
 
@@ -567,6 +564,16 @@ public:
     bool AltDown() const;
     bool ShiftDown() const;
 
+    DocDeclStr(
+        bool , CmdDown() const,
+        "\"Cmd\" is a pseudo key which is the same as Control for PC and Unix
+platforms but the special \"Apple\" (a.k.a as \"Command\") key on
+Macs: it makes often sense to use it instead of, say, `ControlDown`
+because Cmd key is used for the same thing under Mac as Ctrl
+elsewhere. The Ctrl still exists, it's just not used for this
+purpose. So for non-Mac platforms this is the same as `ControlDown`
+and Macs this is the same as `MetaDown`.", "");
+    
     // Find which event was just generated
     bool LeftDown() const;
     bool MiddleDown() const;
@@ -600,7 +607,8 @@ public:
 
 
     DocStr(GetPosition,   // sets the docstring for both
-           "Returns the position of the mouse in window coordinates when the event happened.");
+           "Returns the position of the mouse in window coordinates when the event
+happened.", "");
     wxPoint GetPosition();
 
     DocDeclAName(
@@ -687,6 +695,18 @@ public:
     bool MetaDown() const;
     bool AltDown() const;
     bool ShiftDown() const;
+    
+    DocDeclStr(
+        bool , CmdDown() const,
+        "\"Cmd\" is a pseudo key which is the same as Control for PC and Unix
+platforms but the special \"Apple\" (a.k.a as \"Command\") key on
+Macs: it makes often sense to use it instead of, say, `ControlDown`
+because Cmd key is used for the same thing under Mac as Ctrl
+elsewhere. The Ctrl still exists, it's just not used for this
+purpose. So for non-Mac platforms this is the same as `ControlDown`
+and Macs this is the same as `MetaDown`.", "");
+   
+    
 
     // exclude MetaDown() from HasModifiers() because NumLock under X is often
     // configured as mod2 modifier, yet the key events even when it is pressed
@@ -698,14 +718,16 @@ public:
     %pythoncode { KeyCode = GetKeyCode }
 
     %extend {
-        int GetUniChar() {
-        #if wxUSE_UNICODE
-            return self->m_uniChar;
-        #else
+        int GetUnicodeKey() {
+        %#if wxUSE_UNICODE
+            return self->GetUnicodeKey();
+        %#else
             return 0;
-        #endif
+        %#endif
         }
     }
+    %pythoncode { GetUniChar = GetUnicodeKey }
+    
     
     // get the raw key code (platform-dependent)
     wxUint32 GetRawKeyCode() const;
@@ -715,7 +737,7 @@ public:
 
     
     DocStr(GetPosition,   // sets the docstring for both
-           "Find the position of the event.");
+           "Find the position of the event.", "");
     wxPoint GetPosition();
 
     DocDeclAName(
@@ -990,6 +1012,8 @@ enum wxUpdateUIMode
     wxUPDATE_UI_PROCESS_SPECIFIED
 };
 
+
+
 class wxUpdateUIEvent : public wxCommandEvent
 {
 public:
@@ -1029,7 +1053,6 @@ public:
     static wxUpdateUIMode GetMode();
 };
 
-
 //---------------------------------------------------------------------------
 %newgroup;
 
@@ -1105,17 +1128,25 @@ public:
     
     // direction: forward (True) or backward (False)
     bool GetDirection() const;
-    void SetDirection(bool bForward);
+    void SetDirection(bool forward);
 
     // it may be a window change event (MDI, notebook pages...) or a control
     // change event
     bool IsWindowChange() const;
-    void SetWindowChange(bool bIs);
+    void SetWindowChange(bool ischange);
 
+    void SetFlags(long flags);
+    
     // the child which has the focus currently (may be NULL - use
     // wxWindow::FindFocus then)
     wxWindow* GetCurrentFocus() const;
     void SetCurrentFocus(wxWindow *win);
+
+    enum {
+        IsBackward,
+        IsForward,
+        WinChange
+    };
 };
 
 
@@ -1183,6 +1214,7 @@ enum wxIdleMode
     wxIDLE_PROCESS_SPECIFIED
 };
 
+
 class wxIdleEvent : public wxEvent
 {
 public:
@@ -1212,7 +1244,7 @@ public:
 
 class wxPyEvent : public wxEvent {
 public:
-    %addtofunc wxPyEvent     "self.SetSelf(self)"
+    %pythonAppend wxPyEvent     "self.SetSelf(self)"
     wxPyEvent(int winid=0, wxEventType commandType = wxEVT_NULL );
     ~wxPyEvent();
 
@@ -1224,7 +1256,7 @@ public:
 
 class wxPyCommandEvent : public wxCommandEvent {
 public:
-    %addtofunc wxPyCommandEvent     "self.SetSelf(self)"
+    %pythonAppend wxPyCommandEvent     "self.SetSelf(self)"
     wxPyCommandEvent(wxEventType commandType = wxEVT_NULL, int id=0);
     ~wxPyCommandEvent();