some minor fixes to the docs (bugs 13271[56])

[wxWidgets.git] / wxPython / src / gtk / wx.py

diff --git a/wxPython/src/gtk/wx.py b/wxPython/src/gtk/wx.py
index 1c1f08c9c81f2abc32a8d6ee7b48bde5809fd7e6..be608e29cffe84fceeca3e1e9fd489142d5e5d01 100644 (file)
--- a/wxPython/src/gtk/wx.py
+++ b/wxPython/src/gtk/wx.py
@@ -13,6 +13,8 @@ from clip_dnd import *
 
 from events import *
 
+from streams import *
+
 from mdi import *
 
 from frames import *
@@ -34,6 +36,10 @@ from image import *
 from printfw import *
 
 from sizers import *
+
+from filesys import *
+
+from utils import *
 class wxPyAppPtr(wxEvtHandlerPtr):
     def __init__(self,this):
         self.this = this
@@ -138,6 +144,11 @@ _wxStart = wxc._wxStart
 
 _wxSetDictionary = wxc._wxSetDictionary
 
+def wxGetApp(*_args, **_kwargs):
+    val = apply(wxc.wxGetApp,_args,_kwargs)
+    if val: val = wxPyAppPtr(val)
+    return val
+
 wxApp_CleanUp = wxc.wxApp_CleanUp
 
 
@@ -188,6 +199,8 @@ wxDEFAULT_DIALOG_STYLE = wxc.wxDEFAULT_DIALOG_STYLE
 wxFRAME_TOOL_WINDOW = wxc.wxFRAME_TOOL_WINDOW
 wxFRAME_FLOAT_ON_PARENT = wxc.wxFRAME_FLOAT_ON_PARENT
 wxFRAME_NO_WINDOW_MENU = wxc.wxFRAME_NO_WINDOW_MENU
+wxFRAME_NO_TASKBAR = wxc.wxFRAME_NO_TASKBAR
+wxFRAME_EX_CONTEXTHELP = wxc.wxFRAME_EX_CONTEXTHELP
 wxED_CLIENT_MARGIN = wxc.wxED_CLIENT_MARGIN
 wxED_BUTTONS_BOTTOM = wxc.wxED_BUTTONS_BOTTOM
 wxED_BUTTONS_RIGHT = wxc.wxED_BUTTONS_RIGHT
@@ -214,6 +227,7 @@ wxALIGN_TOP = wxc.wxALIGN_TOP
 wxALIGN_CENTER = wxc.wxALIGN_CENTER
 wxALIGN_CENTRE = wxc.wxALIGN_CENTRE
 wxSHAPED = wxc.wxSHAPED
+wxADJUST_MINSIZE = wxc.wxADJUST_MINSIZE
 wxLB_NEEDED_SB = wxc.wxLB_NEEDED_SB
 wxLB_ALWAYS_SB = wxc.wxLB_ALWAYS_SB
 wxLB_SORT = wxc.wxLB_SORT
@@ -284,12 +298,17 @@ wxLC_SORT_DESCENDING = wxc.wxLC_SORT_DESCENDING
 wxLC_MASK_TYPE = wxc.wxLC_MASK_TYPE
 wxLC_MASK_ALIGN = wxc.wxLC_MASK_ALIGN
 wxLC_MASK_SORT = wxc.wxLC_MASK_SORT
+wxLC_HRULES = wxc.wxLC_HRULES
+wxLC_VRULES = wxc.wxLC_VRULES
 wxSP_VERTICAL = wxc.wxSP_VERTICAL
 wxSP_HORIZONTAL = wxc.wxSP_HORIZONTAL
 wxSP_ARROW_KEYS = wxc.wxSP_ARROW_KEYS
 wxSP_WRAP = wxc.wxSP_WRAP
 wxSP_NOBORDER = wxc.wxSP_NOBORDER
 wxSP_3D = wxc.wxSP_3D
+wxSP_3DSASH = wxc.wxSP_3DSASH
+wxSP_3DBORDER = wxc.wxSP_3DBORDER
+wxSP_FULLSASH = wxc.wxSP_FULLSASH
 wxSP_BORDER = wxc.wxSP_BORDER
 wxSP_LIVE_UPDATE = wxc.wxSP_LIVE_UPDATE
 wxSP_PERMIT_UNSPLIT = wxc.wxSP_PERMIT_UNSPLIT
@@ -401,6 +420,7 @@ wxHIDE_READONLY = wxc.wxHIDE_READONLY
 wxOVERWRITE_PROMPT = wxc.wxOVERWRITE_PROMPT
 wxFILE_MUST_EXIST = wxc.wxFILE_MUST_EXIST
 wxMULTIPLE = wxc.wxMULTIPLE
+wxCHANGE_DIR = wxc.wxCHANGE_DIR
 wxACCEL_ALT = wxc.wxACCEL_ALT
 wxACCEL_CTRL = wxc.wxACCEL_CTRL
 wxACCEL_SHIFT = wxc.wxACCEL_SHIFT
@@ -437,6 +457,13 @@ wxLI_HORIZONTAL = wxc.wxLI_HORIZONTAL
 wxLI_VERTICAL = wxc.wxLI_VERTICAL
 wxHW_SCROLLBAR_NEVER = wxc.wxHW_SCROLLBAR_NEVER
 wxHW_SCROLLBAR_AUTO = wxc.wxHW_SCROLLBAR_AUTO
+wxJOYSTICK1 = wxc.wxJOYSTICK1
+wxJOYSTICK2 = wxc.wxJOYSTICK2
+wxJOY_BUTTON1 = wxc.wxJOY_BUTTON1
+wxJOY_BUTTON2 = wxc.wxJOY_BUTTON2
+wxJOY_BUTTON3 = wxc.wxJOY_BUTTON3
+wxJOY_BUTTON4 = wxc.wxJOY_BUTTON4
+wxJOY_BUTTON_ANY = wxc.wxJOY_BUTTON_ANY
 wxDEFAULT = wxc.wxDEFAULT
 wxDECORATIVE = wxc.wxDECORATIVE
 wxROMAN = wxc.wxROMAN
@@ -775,53 +802,12 @@ wxEVT_COMMAND_RIGHT_DCLICK = wxc.wxEVT_COMMAND_RIGHT_DCLICK
 wxEVT_COMMAND_SET_FOCUS = wxc.wxEVT_COMMAND_SET_FOCUS
 wxEVT_COMMAND_KILL_FOCUS = wxc.wxEVT_COMMAND_KILL_FOCUS
 wxEVT_COMMAND_ENTER = wxc.wxEVT_COMMAND_ENTER
-wxEVT_COMMAND_TREE_BEGIN_DRAG = wxc.wxEVT_COMMAND_TREE_BEGIN_DRAG
-wxEVT_COMMAND_TREE_BEGIN_RDRAG = wxc.wxEVT_COMMAND_TREE_BEGIN_RDRAG
-wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT = wxc.wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT
-wxEVT_COMMAND_TREE_END_LABEL_EDIT = wxc.wxEVT_COMMAND_TREE_END_LABEL_EDIT
-wxEVT_COMMAND_TREE_DELETE_ITEM = wxc.wxEVT_COMMAND_TREE_DELETE_ITEM
-wxEVT_COMMAND_TREE_GET_INFO = wxc.wxEVT_COMMAND_TREE_GET_INFO
-wxEVT_COMMAND_TREE_SET_INFO = wxc.wxEVT_COMMAND_TREE_SET_INFO
-wxEVT_COMMAND_TREE_ITEM_EXPANDED = wxc.wxEVT_COMMAND_TREE_ITEM_EXPANDED
-wxEVT_COMMAND_TREE_ITEM_EXPANDING = wxc.wxEVT_COMMAND_TREE_ITEM_EXPANDING
-wxEVT_COMMAND_TREE_ITEM_COLLAPSED = wxc.wxEVT_COMMAND_TREE_ITEM_COLLAPSED
-wxEVT_COMMAND_TREE_ITEM_COLLAPSING = wxc.wxEVT_COMMAND_TREE_ITEM_COLLAPSING
-wxEVT_COMMAND_TREE_SEL_CHANGED = wxc.wxEVT_COMMAND_TREE_SEL_CHANGED
-wxEVT_COMMAND_TREE_SEL_CHANGING = wxc.wxEVT_COMMAND_TREE_SEL_CHANGING
-wxEVT_COMMAND_TREE_KEY_DOWN = wxc.wxEVT_COMMAND_TREE_KEY_DOWN
-wxEVT_COMMAND_TREE_ITEM_ACTIVATED = wxc.wxEVT_COMMAND_TREE_ITEM_ACTIVATED
-wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK = wxc.wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK
-wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK = wxc.wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK
-wxEVT_COMMAND_LIST_BEGIN_DRAG = wxc.wxEVT_COMMAND_LIST_BEGIN_DRAG
-wxEVT_COMMAND_LIST_BEGIN_RDRAG = wxc.wxEVT_COMMAND_LIST_BEGIN_RDRAG
-wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT = wxc.wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
-wxEVT_COMMAND_LIST_END_LABEL_EDIT = wxc.wxEVT_COMMAND_LIST_END_LABEL_EDIT
-wxEVT_COMMAND_LIST_DELETE_ITEM = wxc.wxEVT_COMMAND_LIST_DELETE_ITEM
-wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS = wxc.wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
-wxEVT_COMMAND_LIST_GET_INFO = wxc.wxEVT_COMMAND_LIST_GET_INFO
-wxEVT_COMMAND_LIST_SET_INFO = wxc.wxEVT_COMMAND_LIST_SET_INFO
-wxEVT_COMMAND_LIST_ITEM_SELECTED = wxc.wxEVT_COMMAND_LIST_ITEM_SELECTED
-wxEVT_COMMAND_LIST_ITEM_DESELECTED = wxc.wxEVT_COMMAND_LIST_ITEM_DESELECTED
-wxEVT_COMMAND_LIST_KEY_DOWN = wxc.wxEVT_COMMAND_LIST_KEY_DOWN
-wxEVT_COMMAND_LIST_INSERT_ITEM = wxc.wxEVT_COMMAND_LIST_INSERT_ITEM
-wxEVT_COMMAND_LIST_COL_CLICK = wxc.wxEVT_COMMAND_LIST_COL_CLICK
-wxEVT_COMMAND_LIST_ITEM_ACTIVATED = wxc.wxEVT_COMMAND_LIST_ITEM_ACTIVATED
-wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK = wxc.wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
-wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK = wxc.wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK
-wxEVT_COMMAND_TAB_SEL_CHANGED = wxc.wxEVT_COMMAND_TAB_SEL_CHANGED
-wxEVT_COMMAND_TAB_SEL_CHANGING = wxc.wxEVT_COMMAND_TAB_SEL_CHANGING
-wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED = wxc.wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
-wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING = wxc.wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
-wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING = wxc.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING
-wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED = wxc.wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
-wxEVT_COMMAND_SPLITTER_UNSPLIT = wxc.wxEVT_COMMAND_SPLITTER_UNSPLIT
-wxEVT_COMMAND_SPLITTER_DOUBLECLICKED = wxc.wxEVT_COMMAND_SPLITTER_DOUBLECLICKED
 wxEVT_NAVIGATION_KEY = wxc.wxEVT_NAVIGATION_KEY
 wxEVT_TIMER = wxc.wxEVT_TIMER
 __version__ = wxc.__version__
 cvar = wxc.cvar
-wxPyDefaultPosition = wxPointPtr(wxc.cvar.wxPyDefaultPosition)
-wxPyDefaultSize = wxSizePtr(wxc.cvar.wxPyDefaultSize)
+wxDefaultPosition = wxPointPtr(wxc.cvar.wxDefaultPosition)
+wxDefaultSize = wxSizePtr(wxc.cvar.wxDefaultSize)
 
 
 #-------------- USER INCLUDE -----------------------
@@ -1456,9 +1442,6 @@ def EVT_LIST_SET_INFO(win, id, func):
 def EVT_LIST_ITEM_SELECTED(win, id, func):
     win.Connect(id, -1,  wxEVT_COMMAND_LIST_ITEM_SELECTED, func)
 
-def EVT_LIST_ITEM_ACTIVATED(win, id, func):
-    win.Connect(id, -1,  wxEVT_COMMAND_LIST_ITEM_ACTIVATED, func)
-
 def EVT_LIST_ITEM_DESELECTED(win, id, func):
     win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_DESELECTED, func)
 
@@ -1477,6 +1460,10 @@ def EVT_LIST_ITEM_RIGHT_CLICK(win, id, func):
 def EVT_LIST_ITEM_MIDDLE_CLICK(win, id, func):
     win.Connect(id, -1, wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK, func)
 
+def EVT_LIST_ITEM_ACTIVATED(win, id, func):
+    win.Connect(id, -1,  wxEVT_COMMAND_LIST_ITEM_ACTIVATED, func)
+
+
 
 
 #wxSplitterWindow
@@ -1497,24 +1484,53 @@ def EVT_SPLITTER_DOUBLECLICKED(win, id, func):
 def EVT_TIMER(win, id, func):
     win.Connect(id, -1, wxEVT_TIMER, func)
 
+# wxProcess
+def EVT_END_PROCESS(eh, id, func):
+    eh.Connect(id, -1, wxEVT_END_PROCESS, func)
 
 
+# wxJoyStick
+def EVT_JOY_DOWN(win, func):
+    win.Connect(-1, -1, wxEVT_JOY_DOWN, func)
+
+def EVT_JOY_UP(win, func):
+    win.Connect(-1, -1, wxEVT_JOY_UP, func)
+
+def EVT_JOY_MOVE(win, func):
+    win.Connect(-1, -1, wxEVT_JOY_MOVE, func)
+
+def EVT_JOY_ZMOVE(win, func):
+    win.Connect(-1, -1, wxEVT_JOY_ZMOVE, func)
+
+def EVT_JOYSTICK_EVENTS(win, func):
+    win.Connect(-1, -1, wxEVT_JOY_DOWN, func)
+    win.Connect(-1, -1, wxEVT_JOY_UP, func)
+    win.Connect(-1, -1, wxEVT_JOY_MOVE, func)
+    win.Connect(-1, -1, wxEVT_JOY_ZMOVE, func)
+
 #----------------------------------------------------------------------
 
 class wxTimer(wxPyTimer):
-    def __init__(self):
-        wxPyTimer.__init__(self, self.Notify)   # derived class must provide
-                                                # Notify(self) method.
+    def __init__(self, evtHandler = None, id = -1):
+        if evtHandler is None:
+            wxPyTimer.__init__(self, self.Notify)   # derived class must provide
+                                                    # Notify(self) method.
+        else:
+            wxPyTimer.__init__(self, None)
+            self.SetOwner(evtHandler, id)
 
 #----------------------------------------------------------------------
 # Some wxWin methods can take "NULL" as parameters, but the shadow classes
 # expect an object with the SWIG pointer as a 'this' member.  This class
 # and instance fools the shadow into passing the NULL pointer.
 
-class NullObj:
+## NOTE:  This is not needed anymore as None can be passed instead and
+#         will be interpreted as NULL.
+
+class _NullObj:
     this = 'NULL'       # SWIG converts this to (void*)0
 
-NULL = NullObj()
+NULL = _NullObj()
 
 
 #----------------------------------------------------------------------
@@ -1523,15 +1539,15 @@ NULL = NullObj()
 wxColor      = wxColour
 wxNamedColor = wxNamedColour
 
-wxPyDefaultPosition.Set(-1,-1)
-wxPyDefaultSize.Set(-1,-1)
-
 # aliases so that C++ documentation applies:
-wxDefaultPosition  = wxPyDefaultPosition
-wxDefaultSize      = wxPyDefaultSize
+#wxDefaultPosition  = wxPyDefaultPosition
+#wxDefaultSize      = wxPyDefaultSize
+
 
 # backwards compatibility
-wxNoRefBitmap      = wxBitmap
+wxNoRefBitmap       = wxBitmap
+wxPyDefaultPosition = wxDefaultPosition
+wxPyDefaultSize     = wxDefaultSize
 
 #----------------------------------------------------------------------
 # This helper function will take a wxPython object and convert it to