No animate contrib anymore

[wxWidgets.git] / wxPython / src / _core_ex.py

diff --git a/wxPython/src/_core_ex.py b/wxPython/src/_core_ex.py
index d9d121fa52d4c184f4bb069e4f5979c57e19d310..bd9ecf759eb388b2db78e59514b4e478d716bf42 100644 (file)
--- a/wxPython/src/_core_ex.py
+++ b/wxPython/src/_core_ex.py
@@ -19,16 +19,66 @@ __wxPyPtrTypeMap['wxStatusBar95']   = 'wxStatusBar'
 
 #----------------------------------------------------------------------------
 # Load version numbers from __version__...  Ensure that major and minor
 
 #----------------------------------------------------------------------------
 # Load version numbers from __version__...  Ensure that major and minor

-# versions are the same for both wxPython and wxWindows.
+# versions are the same for both wxPython and wxWidgets.

 
 from __version__ import *
 __version__ = VERSION_STRING
 
 
 from __version__ import *
 __version__ = VERSION_STRING
 

-assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
-assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
+assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
+assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"

 if RELEASE_VERSION != _core_.RELEASE_VERSION:
     import warnings
 if RELEASE_VERSION != _core_.RELEASE_VERSION:
     import warnings

-    warnings.warn("wxPython/wxWindows release number mismatch")
+    warnings.warn("wxPython/wxWidgets release number mismatch")
+
+
+def version():
+    """Returns a string containing version and port info"""
+    ctype = wx.USE_UNICODE and 'unicode' or 'ansi'
+    if wx.Platform == '__WXMSW__':
+        port = 'msw'
+    elif wx.Platform == '__WXMAC__':
+        port = 'mac'
+    elif wx.Platform == '__WXGTK__':
+        port = 'gtk'
+        if 'gtk2' in wx.PlatformInfo:
+            port = 'gtk2'
+    else:
+        port = '?'
+
+    return "%s (%s-%s)" % (wx.VERSION_STRING, port, ctype)
+                       
+    
+#----------------------------------------------------------------------------
+
+# Set wxPython's default string<-->unicode conversion encoding from
+# the locale, but only if Python's default hasn't been changed.  (We
+# assume that if the user has customized it already then that is the
+# encoding we need to use as well.)
+#
+# The encoding selected here is used when string or unicode objects
+# need to be converted in order to pass them to wxWidgets.  Please be
+# aware that the default encoding within the same locale may be
+# slightly different on different platforms.  For example, please see
+# http://www.alanwood.net/demos/charsetdiffs.html for differences
+# between the common latin/roman encodings.
+
+default = _sys.getdefaultencoding()
+if default == 'ascii':
+    import locale
+    import codecs
+    try:
+        if hasattr(locale, 'getpreferredencoding'):
+            default = locale.getpreferredencoding()
+        else:
+            default = locale.getdefaultlocale()[1]
+        codecs.lookup(default)
+    except (ValueError, LookupError, TypeError):
+        default = _sys.getdefaultencoding()
+    del locale
+    del codecs
+if default:
+    wx.SetDefaultPyEncoding(default)
+del default

 
 #----------------------------------------------------------------------------
 
 
 #----------------------------------------------------------------------------
 


@@ -90,7 +140,6 @@ class _wxPyUnbornObject(object):
 
 
 #----------------------------------------------------------------------------
 
 
 #----------------------------------------------------------------------------

-_wxPyCallAfterId = None

 
 def CallAfter(callable, *args, **kw):
     """
 
 def CallAfter(callable, *args, **kw):
     """


@@ -99,30 +148,28 @@ def CallAfter(callable, *args, **kw):
     method calls from non-GUI threads.  Any extra positional or
     keyword args are passed on to the callable when it is called.
 
     method calls from non-GUI threads.  Any extra positional or
     keyword args are passed on to the callable when it is called.
 

-    :see: `wx.FutureCall`
+    :see: `wx.CallLater`

     """
     app = wx.GetApp()
     """
     app = wx.GetApp()

-    assert app, 'No wxApp created yet'
+    assert app is not None, 'No wx.App created yet'

 
 

-    global _wxPyCallAfterId
-    if _wxPyCallAfterId is None:
-        _wxPyCallAfterId = wx.NewEventType()
-        app.Connect(-1, -1, _wxPyCallAfterId,
-              lambda event: event.callable(*event.args, **event.kw) )
+    if not hasattr(app, "_CallAfterId"):
+        app._CallAfterId = wx.NewEventType()
+        app.Connect(-1, -1, app._CallAfterId,
+                    lambda event: event.callable(*event.args, **event.kw) )

     evt = wx.PyEvent()
     evt = wx.PyEvent()

-    evt.SetEventType(_wxPyCallAfterId)
+    evt.SetEventType(app._CallAfterId)

     evt.callable = callable
     evt.args = args
     evt.kw = kw
     wx.PostEvent(app, evt)
 
     evt.callable = callable
     evt.args = args
     evt.kw = kw
     wx.PostEvent(app, evt)
 

-

 #----------------------------------------------------------------------------
 
 
 #----------------------------------------------------------------------------
 
 

-class FutureCall:
+class CallLater:

     """
     """

-    A convenience class for wx.Timer, that calls the given callable
+    A convenience class for `wx.Timer`, that calls the given callable

     object once after the given amount of milliseconds, passing any
     positional or keyword args.  The return value of the callable is
     availbale after it has been run with the `GetResult` method.
     object once after the given amount of milliseconds, passing any
     positional or keyword args.  The return value of the callable is
     availbale after it has been run with the `GetResult` method.


@@ -131,7 +178,7 @@ class FutureCall:
     then there is no need to hold a reference to this object.  It will
     hold a reference to itself while the timer is running (the timer
     has a reference to self.Notify) but the cycle will be broken when
     then there is no need to hold a reference to this object.  It will
     hold a reference to itself while the timer is running (the timer
     has a reference to self.Notify) but the cycle will be broken when

-    the timer completes, automatically cleaning up the wx.FutureCall
+    the timer completes, automatically cleaning up the wx.CallLater

     object.
 
     :see: `wx.CallAfter`
     object.
 
     :see: `wx.CallAfter`


@@ -217,7 +264,12 @@ class FutureCall:
             # if it wasn't restarted, then cleanup
             wx.CallAfter(self.Stop)
 
             # if it wasn't restarted, then cleanup
             wx.CallAfter(self.Stop)
 

+    Interval = property(GetInterval)
+    Result = property(GetResult)
+

 
 

+class FutureCall(CallLater):
+    """A compatibility alias for `CallLater`."""

 
 #----------------------------------------------------------------------------
 # Control which items in this module should be documented by epydoc.
 
 #----------------------------------------------------------------------------
 # Control which items in this module should be documented by epydoc.


@@ -230,7 +282,7 @@ class FutureCall:
 class __DocFilter:
     """
     A filter for epydoc that only allows non-Ptr classes and
 class __DocFilter:
     """
     A filter for epydoc that only allows non-Ptr classes and

-    fucntions, in order to reduce the clutter in the API docs.
+    functions, in order to reduce the clutter in the API docs.

     """
     def __init__(self, globals):
         self._globals = globals
     """
     def __init__(self, globals):
         self._globals = globals


@@ -238,10 +290,22 @@ class __DocFilter:
     def __call__(self, name):
         import types
         obj = self._globals.get(name, None)
     def __call__(self, name):
         import types
         obj = self._globals.get(name, None)

+
+        # only document classes and function

         if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
             return False
         if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
             return False

-        if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
+
+        # skip other things that are private or will be documented as part of somethign else
+        if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister')  or name.endswith('Ptr') :

             return False
             return False

+
+        # skip functions that are duplicates of static functions in a class
+        if name.find('_') != -1:
+            cls = self._globals.get(name.split('_')[0], None)
+            methname = name.split('_')[1]
+            if hasattr(cls, methname) and type(getattr(cls, methname)) is types.FunctionType:
+                return False
+            

         return True
 
 #----------------------------------------------------------------------------
         return True
 
 #----------------------------------------------------------------------------


@@ -254,10 +318,5 @@ from _windows import *
 from _controls import *
 from _misc import *
 
 from _controls import *
 from _misc import *
 

-
-# Fixup the stock objects since they can't be used yet.  (They will be
-# restored in wx.PyApp.OnInit.)
-_core_._wxPyFixStockObjects()
-

 #----------------------------------------------------------------------------
 #----------------------------------------------------------------------------
 #----------------------------------------------------------------------------
 #----------------------------------------------------------------------------