]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/msw/_misc.py
Use the wx.ART_NORMAL_FILE icon
[wxWidgets.git] / wxPython / src / msw / _misc.py
index 541455e79eadbb348ce96d483d9cd356ac20e2b8..c93257631089c44d32089e828e5bd467e865ece3 100644 (file)
@@ -155,7 +155,7 @@ class SystemSettings(object):
 
     GetFont = staticmethod(GetFont)
     def GetMetric(*args, **kwargs):
-        """GetMetric(int index) -> int"""
+        """GetMetric(int index, Window win=None) -> int"""
         return _misc_.SystemSettings_GetMetric(*args, **kwargs)
 
     GetMetric = staticmethod(GetMetric)
@@ -191,7 +191,7 @@ def SystemSettings_GetFont(*args, **kwargs):
     return _misc_.SystemSettings_GetFont(*args, **kwargs)
 
 def SystemSettings_GetMetric(*args, **kwargs):
-    """SystemSettings_GetMetric(int index) -> int"""
+    """SystemSettings_GetMetric(int index, Window win=None) -> int"""
     return _misc_.SystemSettings_GetMetric(*args, **kwargs)
 
 def SystemSettings_HasFeature(*args, **kwargs):
@@ -241,6 +241,11 @@ class SystemOptions(_core.Object):
         return _misc_.SystemOptions_HasOption(*args, **kwargs)
 
     HasOption = staticmethod(HasOption)
+    def IsFalse(*args, **kwargs):
+        """IsFalse(String name) -> bool"""
+        return _misc_.SystemOptions_IsFalse(*args, **kwargs)
+
+    IsFalse = staticmethod(IsFalse)
 
 class SystemOptionsPtr(SystemOptions):
     def __init__(self, this):
@@ -271,6 +276,10 @@ def SystemOptions_HasOption(*args, **kwargs):
     """SystemOptions_HasOption(String name) -> bool"""
     return _misc_.SystemOptions_HasOption(*args, **kwargs)
 
+def SystemOptions_IsFalse(*args, **kwargs):
+    """SystemOptions_IsFalse(String name) -> bool"""
+    return _misc_.SystemOptions_IsFalse(*args, **kwargs)
+
 #---------------------------------------------------------------------------
 
 
@@ -295,7 +304,7 @@ def IsStockLabel(*args, **kwargs):
     return _misc_.IsStockLabel(*args, **kwargs)
 
 def GetStockLabel(*args, **kwargs):
-    """GetStockLabel(int id) -> String"""
+    """GetStockLabel(int id, bool withCodes=True, String accelerator=EmptyString) -> String"""
     return _misc_.GetStockLabel(*args, **kwargs)
 
 def Bell(*args, **kwargs):
@@ -525,6 +534,15 @@ def SetCursor(*args, **kwargs):
     """SetCursor(Cursor cursor)"""
     return _misc_.SetCursor(*args, **kwargs)
 
+def GetXDisplay(*args, **kwargs):
+    """
+    GetXDisplay() -> void
+
+    Returns a swigified pointer to the X11 display.  Returns None on
+    other platforms.
+    """
+    return _misc_.GetXDisplay(*args, **kwargs)
+
 def BeginBusyCursor(*args, **kwargs):
     """BeginBusyCursor(Cursor cursor=wxHOURGLASS_CURSOR)"""
     return _misc_.BeginBusyCursor(*args, **kwargs)
@@ -545,6 +563,16 @@ def GetTopLevelParent(*args, **kwargs):
     """GetTopLevelParent(Window win) -> Window"""
     return _misc_.GetTopLevelParent(*args, **kwargs)
 
+def LaunchDefaultBrowser(*args, **kwargs):
+    """
+    LaunchDefaultBrowser(String url) -> bool
+
+    Launches the user's default browser and tells it to open the location
+    at ``url``.  Returns ``True`` if the application was successfully
+    launched.
+    """
+    return _misc_.LaunchDefaultBrowser(*args, **kwargs)
+
 def GetKeyState(*args, **kwargs):
     """
     GetKeyState(int key) -> bool
@@ -658,11 +686,13 @@ class Caret(object):
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
-    def __del__(self, destroy=_misc_.delete_Caret):
-        """__del__(self)"""
-        try:
-            if self.thisown: destroy(self)
-        except: pass
+    def Destroy(*args, **kwargs):
+        """
+        Destroy(self)
+
+        Deletes the C++ object this Python object is a proxy for.
+        """
+        return _misc_.Caret_Destroy(*args, **kwargs)
 
     def IsOk(*args, **kwargs):
         """IsOk(self) -> bool"""
@@ -717,6 +747,16 @@ class Caret(object):
         return _misc_.Caret_Hide(*args, **kwargs)
 
     def __nonzero__(self): return self.IsOk() 
+    def GetBlinkTime(*args, **kwargs):
+        """GetBlinkTime() -> int"""
+        return _misc_.Caret_GetBlinkTime(*args, **kwargs)
+
+    GetBlinkTime = staticmethod(GetBlinkTime)
+    def SetBlinkTime(*args, **kwargs):
+        """SetBlinkTime(int milliseconds)"""
+        return _misc_.Caret_SetBlinkTime(*args, **kwargs)
+
+    SetBlinkTime = staticmethod(SetBlinkTime)
 
 class CaretPtr(Caret):
     def __init__(self, this):
@@ -725,7 +765,6 @@ class CaretPtr(Caret):
         self.__class__ = Caret
 _misc_.Caret_swigregister(CaretPtr)
 
-
 def Caret_GetBlinkTime(*args, **kwargs):
     """Caret_GetBlinkTime() -> int"""
     return _misc_.Caret_GetBlinkTime(*args, **kwargs)
@@ -733,6 +772,7 @@ def Caret_GetBlinkTime(*args, **kwargs):
 def Caret_SetBlinkTime(*args, **kwargs):
     """Caret_SetBlinkTime(int milliseconds)"""
     return _misc_.Caret_SetBlinkTime(*args, **kwargs)
+
 class BusyCursor(object):
     """Proxy of C++ BusyCursor class"""
     def __repr__(self):
@@ -946,6 +986,10 @@ def PreSingleInstanceChecker(*args, **kwargs):
     val.thisown = 1
     return val
 
+
+def DrawWindowOnDC(*args, **kwargs):
+    """DrawWindowOnDC(Window window, DC dc) -> bool"""
+    return _misc_.DrawWindowOnDC(*args, **kwargs)
 #---------------------------------------------------------------------------
 
 class TipProvider(object):
@@ -1070,7 +1114,7 @@ class Timer(_core.EvtHandler):
         """GetId(self) -> int"""
         return _misc_.Timer_GetId(*args, **kwargs)
 
-    def Destroy():
+    def Destroy(self):
         """NO-OP: Timers must be destroyed by normal refrence counting"""
         pass
 
@@ -2019,11 +2063,6 @@ class JoystickEvent(_core.Event):
     """Proxy of C++ JoystickEvent class"""
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxJoystickEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
-    m_pos = property(_misc_.JoystickEvent_m_pos_get, _misc_.JoystickEvent_m_pos_set)
-    m_zPosition = property(_misc_.JoystickEvent_m_zPosition_get, _misc_.JoystickEvent_m_zPosition_set)
-    m_buttonChange = property(_misc_.JoystickEvent_m_buttonChange_get, _misc_.JoystickEvent_m_buttonChange_set)
-    m_buttonState = property(_misc_.JoystickEvent_m_buttonState_get, _misc_.JoystickEvent_m_buttonState_set)
-    m_joyStick = property(_misc_.JoystickEvent_m_joyStick_get, _misc_.JoystickEvent_m_joyStick_set)
     def __init__(self, *args, **kwargs):
         """
         __init__(self, wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1, 
@@ -2097,6 +2136,12 @@ class JoystickEvent(_core.Event):
         """ButtonIsDown(self, int but=JOY_BUTTON_ANY) -> bool"""
         return _misc_.JoystickEvent_ButtonIsDown(*args, **kwargs)
 
+    m_pos = property(GetPosition, SetPosition)
+    m_zPosition = property(GetZPosition, SetZPosition)
+    m_buttonChange = property(GetButtonChange, SetButtonChange)
+    m_buttonState = property(GetButtonState, SetButtonState)
+    m_joyStick = property(GetJoystick, SetJoystick)
+
 
 class JoystickEventPtr(JoystickEvent):
     def __init__(self, this):
@@ -2531,6 +2576,16 @@ class ArtProvider(object):
         return _misc_.ArtProvider_GetIcon(*args, **kwargs)
 
     GetIcon = staticmethod(GetIcon)
+    def GetSizeHint(*args, **kwargs):
+        """
+        GetSizeHint(String client, bool platform_dependent=False) -> Size
+
+        Get the size hint of an icon from a specific Art Client, queries the
+        topmost provider if platform_dependent = false
+        """
+        return _misc_.ArtProvider_GetSizeHint(*args, **kwargs)
+
+    GetSizeHint = staticmethod(GetSizeHint)
     def Destroy(*args, **kwargs):
         """Destroy(self)"""
         return _misc_.ArtProvider_Destroy(*args, **kwargs)
@@ -2564,6 +2619,8 @@ ART_GO_DOWN = cvar.ART_GO_DOWN
 ART_GO_TO_PARENT = cvar.ART_GO_TO_PARENT
 ART_GO_HOME = cvar.ART_GO_HOME
 ART_FILE_OPEN = cvar.ART_FILE_OPEN
+ART_FILE_SAVE = cvar.ART_FILE_SAVE
+ART_FILE_SAVE_AS = cvar.ART_FILE_SAVE_AS
 ART_PRINT = cvar.ART_PRINT
 ART_HELP = cvar.ART_HELP
 ART_TIP = cvar.ART_TIP
@@ -2586,6 +2643,16 @@ ART_QUESTION = cvar.ART_QUESTION
 ART_WARNING = cvar.ART_WARNING
 ART_INFORMATION = cvar.ART_INFORMATION
 ART_MISSING_IMAGE = cvar.ART_MISSING_IMAGE
+ART_COPY = cvar.ART_COPY
+ART_CUT = cvar.ART_CUT
+ART_PASTE = cvar.ART_PASTE
+ART_DELETE = cvar.ART_DELETE
+ART_NEW = cvar.ART_NEW
+ART_UNDO = cvar.ART_UNDO
+ART_REDO = cvar.ART_REDO
+ART_QUIT = cvar.ART_QUIT
+ART_FIND = cvar.ART_FIND
+ART_FIND_AND_REPLACE = cvar.ART_FIND_AND_REPLACE
 
 def ArtProvider_PushProvider(*args, **kwargs):
     """
@@ -2630,6 +2697,15 @@ def ArtProvider_GetIcon(*args, **kwargs):
     """
     return _misc_.ArtProvider_GetIcon(*args, **kwargs)
 
+def ArtProvider_GetSizeHint(*args, **kwargs):
+    """
+    ArtProvider_GetSizeHint(String client, bool platform_dependent=False) -> Size
+
+    Get the size hint of an icon from a specific Art Client, queries the
+    topmost provider if platform_dependent = false
+    """
+    return _misc_.ArtProvider_GetSizeHint(*args, **kwargs)
+
 #---------------------------------------------------------------------------
 
 CONFIG_USE_LOCAL_FILE = _misc_.CONFIG_USE_LOCAL_FILE
@@ -3730,36 +3806,36 @@ class DateTime(object):
         """
         return _misc_.DateTime___sub__(*args)
 
-    def __lt__(*args):
+    def __lt__(*args, **kwargs):
         """__lt__(self, DateTime other) -> bool"""
-        return _misc_.DateTime___lt__(*args)
+        return _misc_.DateTime___lt__(*args, **kwargs)
 
-    def __le__(*args):
+    def __le__(*args, **kwargs):
         """__le__(self, DateTime other) -> bool"""
-        return _misc_.DateTime___le__(*args)
+        return _misc_.DateTime___le__(*args, **kwargs)
 
-    def __gt__(*args):
+    def __gt__(*args, **kwargs):
         """__gt__(self, DateTime other) -> bool"""
-        return _misc_.DateTime___gt__(*args)
+        return _misc_.DateTime___gt__(*args, **kwargs)
 
-    def __ge__(*args):
+    def __ge__(*args, **kwargs):
         """__ge__(self, DateTime other) -> bool"""
-        return _misc_.DateTime___ge__(*args)
+        return _misc_.DateTime___ge__(*args, **kwargs)
 
-    def __eq__(*args):
+    def __eq__(*args, **kwargs):
         """__eq__(self, DateTime other) -> bool"""
-        return _misc_.DateTime___eq__(*args)
+        return _misc_.DateTime___eq__(*args, **kwargs)
 
-    def __ne__(*args):
+    def __ne__(*args, **kwargs):
         """__ne__(self, DateTime other) -> bool"""
-        return _misc_.DateTime___ne__(*args)
+        return _misc_.DateTime___ne__(*args, **kwargs)
 
     def ParseRfc822Date(*args, **kwargs):
         """ParseRfc822Date(self, String date) -> int"""
         return _misc_.DateTime_ParseRfc822Date(*args, **kwargs)
 
     def ParseFormat(*args, **kwargs):
-        """ParseFormat(self, String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int"""
+        """ParseFormat(self, String date, String format=DefaultDateTimeFormat, DateTime dateDef=DefaultDateTime) -> int"""
         return _misc_.DateTime_ParseFormat(*args, **kwargs)
 
     def ParseDateTime(*args, **kwargs):
@@ -3775,7 +3851,7 @@ class DateTime(object):
         return _misc_.DateTime_ParseTime(*args, **kwargs)
 
     def Format(*args, **kwargs):
-        """Format(self, String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String"""
+        """Format(self, String format=DefaultDateTimeFormat, wxDateTime::TimeZone tz=LOCAL_TZ) -> String"""
         return _misc_.DateTime_Format(*args, **kwargs)
 
     def FormatDate(*args, **kwargs):
@@ -3796,12 +3872,13 @@ class DateTime(object):
 
     def __repr__(self):
         if self.IsValid():
-            return '<wx.DateTime: \"%s\" at %s>' % ( self.Format(), self.this)
+            f = self.Format().encode(wx.GetDefaultPyEncoding())
+            return '<wx.DateTime: \"%s\" at %s>' % ( f, self.this)
         else:
             return '<wx.DateTime: \"INVALID\" at %s>' % self.this
     def __str__(self):
         if self.IsValid():
-            return self.Format()
+            return self.Format().encode(wx.GetDefaultPyEncoding())
         else:
             return "INVALID DateTime"
 
@@ -3812,8 +3889,8 @@ class DateTimePtr(DateTime):
         if not hasattr(self,"thisown"): self.thisown = 0
         self.__class__ = DateTime
 _misc_.DateTime_swigregister(DateTimePtr)
-DateFormatStr = cvar.DateFormatStr
-TimeSpanFormatStr = cvar.TimeSpanFormatStr
+DefaultDateTimeFormat = cvar.DefaultDateTimeFormat
+DefaultTimeSpanFormat = cvar.DefaultTimeSpanFormat
 
 def DateTime_SetCountry(*args, **kwargs):
     """DateTime_SetCountry(int country)"""
@@ -4117,13 +4194,14 @@ class TimeSpan(object):
         return _misc_.TimeSpan_GetMilliseconds(*args, **kwargs)
 
     def Format(*args, **kwargs):
-        """Format(self, String format=TimeSpanFormatStr) -> String"""
+        """Format(self, String format=DefaultTimeSpanFormat) -> String"""
         return _misc_.TimeSpan_Format(*args, **kwargs)
 
     def __repr__(self):
-        return '<wx.TimeSpan: \"%s\" at %s>' % ( self.Format(), self.this)
+        f = self.Format().encode(wx.GetDefaultPyEncoding())
+        return '<wx.TimeSpan: \"%s\" at %s>' % ( f, self.this)
     def __str__(self):
-        return self.Format()
+        return self.Format().encode(wx.GetDefaultPyEncoding())
 
 
 class TimeSpanPtr(TimeSpan):
@@ -4965,12 +5043,6 @@ class FileDataObject(DataObjectSimple):
     Explorer and other compatible programs under Windows or GNOME/KDE
     filemanager under Unix which makes it possible to receive files from
     them using this class.
-
-    :Warning: Under all non-Windows platforms this class is currently
-        "input-only", i.e. you can receive the files from another
-        application, but copying (or dragging) file(s) from a wxWidgets
-        application is not currently supported.
-
     """
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxFileDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -5014,9 +5086,11 @@ class CustomDataObject(DataObjectSimple):
     """
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxCustomDataObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args):
         """
-        __init__(self, DataFormat format=FormatInvalid) -> CustomDataObject
+        __init__(self, DataFormat format) -> CustomDataObject
+        __init__(self, String formatName) -> CustomDataObject
+        __init__(self) -> CustomDataObject
 
         wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
         some application-specific data in arbitrary format.  Python strings
@@ -5024,7 +5098,7 @@ class CustomDataObject(DataObjectSimple):
         easily be transfered via strings.  A copy of the data is stored in the
         data object.
         """
-        newobj = _misc_.new_CustomDataObject(*args, **kwargs)
+        newobj = _misc_.new_CustomDataObject(*args)
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
@@ -5197,6 +5271,18 @@ class DropSourcePtr(DropSource):
         self.__class__ = DropSource
 _misc_.DropSource_swigregister(DropSourcePtr)
 
+def DROP_ICON(filename):
+    """
+    Returns either a `wx.Cursor` or `wx.Icon` created from the image file
+    ``filename``.  This function is useful with the `wx.DropSource` class
+    which, depending on platform accepts either a icon or a cursor.
+    """
+    img = wx.Image(filename)
+    if wx.Platform == '__WXGTK__':
+        return wx.IconFromBitmap(wx.BitmapFromImage(img))
+    else:
+        return wx.CursorFromImage(img)
+
 class DropTarget(object):
     """Proxy of C++ DropTarget class"""
     def __repr__(self):
@@ -5247,6 +5333,14 @@ class DropTarget(object):
         """GetData(self) -> bool"""
         return _misc_.DropTarget_GetData(*args, **kwargs)
 
+    def SetDefaultAction(*args, **kwargs):
+        """SetDefaultAction(self, int action)"""
+        return _misc_.DropTarget_SetDefaultAction(*args, **kwargs)
+
+    def GetDefaultAction(*args, **kwargs):
+        """GetDefaultAction(self) -> int"""
+        return _misc_.DropTarget_GetDefaultAction(*args, **kwargs)
+
 
 class DropTargetPtr(DropTarget):
     def __init__(self, this):