Update ReST docs

[wxWidgets.git] / wxPython / src / msw / _core.py

diff --git a/wxPython/src/msw/_core.py b/wxPython/src/msw/_core.py
index 9135aa2849d55c4feb7d8dc937cc751b7d503191..81c9364b07717436a13186219305079d9f11cf05 100644 (file)
--- a/wxPython/src/msw/_core.py
+++ b/wxPython/src/msw/_core.py
@@ -705,9 +705,8 @@ class Object(object):
 
         Deletes the C++ object this Python object is a proxy for.
         """
 
         Deletes the C++ object this Python object is a proxy for.
         """

-        val = _core_.Object_Destroy(*args, **kwargs)
-        args[0].thisown = 0
-        return val
+        args[0].this.own(False)
+        return _core_.Object_Destroy(*args, **kwargs)

 
     ClassName = property(GetClassName,doc="See `GetClassName`") 
 _core_.Object_swigregister(Object)
 
     ClassName = property(GetClassName,doc="See `GetClassName`") 
 _core_.Object_swigregister(Object)


@@ -841,6 +840,14 @@ class Size(object):
         """
         return _core_.Size_DecTo(*args, **kwargs)
 
         """
         return _core_.Size_DecTo(*args, **kwargs)
 

+    def IncBy(*args, **kwargs):
+        """IncBy(self, int dx, int dy)"""
+        return _core_.Size_IncBy(*args, **kwargs)
+
+    def DecBy(*args, **kwargs):
+        """DecBy(self, int dx, int dy)"""
+        return _core_.Size_DecBy(*args, **kwargs)
+

     def Scale(*args, **kwargs):
         """
         Scale(self, float xscale, float yscale)
     def Scale(*args, **kwargs):
         """
         Scale(self, float xscale, float yscale)


@@ -1184,6 +1191,22 @@ class Rect(object):
         """SetBottomRight(self, Point p)"""
         return _core_.Rect_SetBottomRight(*args, **kwargs)
 
         """SetBottomRight(self, Point p)"""
         return _core_.Rect_SetBottomRight(*args, **kwargs)
 

+    def GetTopRight(*args, **kwargs):
+        """GetTopRight(self) -> Point"""
+        return _core_.Rect_GetTopRight(*args, **kwargs)
+
+    def SetTopRight(*args, **kwargs):
+        """SetTopRight(self, Point p)"""
+        return _core_.Rect_SetTopRight(*args, **kwargs)
+
+    def GetBottomLeft(*args, **kwargs):
+        """GetBottomLeft(self) -> Point"""
+        return _core_.Rect_GetBottomLeft(*args, **kwargs)
+
+    def SetBottomLeft(*args, **kwargs):
+        """SetBottomLeft(self, Point p)"""
+        return _core_.Rect_SetBottomLeft(*args, **kwargs)
+

     def GetLeft(*args, **kwargs):
         """GetLeft(self) -> int"""
         return _core_.Rect_GetLeft(*args, **kwargs)
     def GetLeft(*args, **kwargs):
         """GetLeft(self) -> int"""
         return _core_.Rect_GetLeft(*args, **kwargs)


@@ -1349,9 +1372,12 @@ class Rect(object):
         """
         return _core_.Rect_ContainsRect(*args, **kwargs)
 
         """
         return _core_.Rect_ContainsRect(*args, **kwargs)
 

-    Inside = wx._deprecated(Contains, "Use `Contains` instead.")
-    InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
-    InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
+    #Inside = wx._deprecated(Contains, "Use `Contains` instead.")
+    #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.")
+    #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.")
+    Inside = Contains
+    InsideXY = ContainsXY
+    InsideRect = ContainsRect

 
     def Intersects(*args, **kwargs):
         """
 
     def Intersects(*args, **kwargs):
         """


@@ -1408,6 +1434,7 @@ class Rect(object):
 
     Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`") 
     BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`") 
 
     Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`") 
     BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`") 

+    BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`") 

     Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`") 
     Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`") 
     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") 
     Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`") 
     Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`") 
     Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") 


@@ -1415,6 +1442,7 @@ class Rect(object):
     Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`") 
     Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`") 
     TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`") 
     Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`") 
     Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`") 
     TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`") 

+    TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`") 

     Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`") 
     X = property(GetX,SetX,doc="See `GetX` and `SetX`") 
     Y = property(GetY,SetY,doc="See `GetY` and `SetY`") 
     Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`") 
     X = property(GetX,SetX,doc="See `GetX` and `SetX`") 
     Y = property(GetY,SetY,doc="See `GetY` and `SetY`") 


@@ -1472,6 +1500,8 @@ class Point2D(object):
         Create a w.Point2D object.
         """
         _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
         Create a w.Point2D object.
         """
         _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))

+    __swig_destroy__ = _core_.delete_Point2D
+    __del__ = lambda self : None;

     def GetFloor(*args, **kwargs):
         """
         GetFloor() -> (x,y)
     def GetFloor(*args, **kwargs):
         """
         GetFloor() -> (x,y)


@@ -2010,6 +2040,8 @@ def MemoryFSHandler_RemoveFile(*args, **kwargs):
 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE
 IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT
 IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD
 IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE

+IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL
+IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH

 #---------------------------------------------------------------------------
 
 class ImageHandler(Object):
 #---------------------------------------------------------------------------
 
 class ImageHandler(Object):


@@ -2288,20 +2320,61 @@ class Image(Object):
 
         Destroys the image data.
         """
 
         Destroys the image data.
         """

-        val = _core_.Image_Destroy(*args, **kwargs)
-        args[0].thisown = 0
-        return val
+        args[0].this.own(False)
+        return _core_.Image_Destroy(*args, **kwargs)

 
     def Scale(*args, **kwargs):
         """
 
     def Scale(*args, **kwargs):
         """

-        Scale(self, int width, int height) -> Image
+        Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image

 
         Returns a scaled version of the image. This is also useful for scaling
         bitmaps in general as the only other way to scale bitmaps is to blit a
 
         Returns a scaled version of the image. This is also useful for scaling
         bitmaps in general as the only other way to scale bitmaps is to blit a

-        `wx.MemoryDC` into another `wx.MemoryDC`.
+        `wx.MemoryDC` into another `wx.MemoryDC`.  The ``quality`` parameter
+        specifies what method to use for resampling the image.  It can be
+        either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling
+        method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses
+        bicubic and box averaging resampling methods for upsampling and
+        downsampling respectively.

         """
         return _core_.Image_Scale(*args, **kwargs)
 
         """
         return _core_.Image_Scale(*args, **kwargs)
 

+    def ResampleBox(*args, **kwargs):
+        """ResampleBox(self, int width, int height) -> Image"""
+        return _core_.Image_ResampleBox(*args, **kwargs)
+
+    def ResampleBicubic(*args, **kwargs):
+        """ResampleBicubic(self, int width, int height) -> Image"""
+        return _core_.Image_ResampleBicubic(*args, **kwargs)
+
+    def Blur(*args, **kwargs):
+        """
+        Blur(self, int radius) -> Image
+
+        Blurs the image in both horizontal and vertical directions by the
+        specified pixel ``radius``. This should not be used when using a
+        single mask colour for transparency.
+        """
+        return _core_.Image_Blur(*args, **kwargs)
+
+    def BlurHorizontal(*args, **kwargs):
+        """
+        BlurHorizontal(self, int radius) -> Image
+
+        Blurs the image in the horizontal direction only. This should not be
+        used when using a single mask colour for transparency.
+
+        """
+        return _core_.Image_BlurHorizontal(*args, **kwargs)
+
+    def BlurVertical(*args, **kwargs):
+        """
+        BlurVertical(self, int radius) -> Image
+
+        Blurs the image in the vertical direction only. This should not be
+        used when using a single mask colour for transparency.
+        """
+        return _core_.Image_BlurVertical(*args, **kwargs)
+

     def ShrinkBy(*args, **kwargs):
         """
         ShrinkBy(self, int xFactor, int yFactor) -> Image
     def ShrinkBy(*args, **kwargs):
         """
         ShrinkBy(self, int xFactor, int yFactor) -> Image


@@ -2312,7 +2385,7 @@ class Image(Object):
 
     def Rescale(*args, **kwargs):
         """
 
     def Rescale(*args, **kwargs):
         """

-        Rescale(self, int width, int height) -> Image
+        Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image

 
         Changes the size of the image in-place by scaling it: after a call to
         this function, the image will have the given width and height.
 
         Changes the size of the image in-place by scaling it: after a call to
         this function, the image will have the given width and height.


@@ -2576,14 +2649,15 @@ class Image(Object):
         """
         return _core_.Image_LoadMimeStream(*args, **kwargs)
 
         """
         return _core_.Image_LoadMimeStream(*args, **kwargs)
 

-    def Ok(*args, **kwargs):
+    def IsOk(*args, **kwargs):

         """
         """

-        Ok(self) -> bool
+        IsOk(self) -> bool

 
         Returns true if image data is present.
         """
 
         Returns true if image data is present.
         """

-        return _core_.Image_Ok(*args, **kwargs)
+        return _core_.Image_IsOk(*args, **kwargs)

 
 

+    Ok = IsOk 

     def GetWidth(*args, **kwargs):
         """
         GetWidth(self) -> int
     def GetWidth(*args, **kwargs):
         """
         GetWidth(self) -> int


@@ -2961,7 +3035,7 @@ class Image(Object):
         return _core_.Image_HSVtoRGB(*args, **kwargs)
 
     HSVtoRGB = staticmethod(HSVtoRGB)
         return _core_.Image_HSVtoRGB(*args, **kwargs)
 
     HSVtoRGB = staticmethod(HSVtoRGB)

-    def __nonzero__(self): return self.Ok() 
+    def __nonzero__(self): return self.IsOk() 

     AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`") 
     AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`") 
     Data = property(GetData,SetData,doc="See `GetData` and `SetData`") 
     AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`") 
     AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`") 
     Data = property(GetData,SetData,doc="See `GetData` and `SetData`") 


@@ -2970,7 +3044,6 @@ class Image(Object):
     MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`") 
     MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`") 
     MaskRed = property(GetMaskRed,doc="See `GetMaskRed`") 
     MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`") 
     MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`") 
     MaskRed = property(GetMaskRed,doc="See `GetMaskRed`") 

-    Size = property(GetSize,doc="See `GetSize`") 

     Width = property(GetWidth,doc="See `GetWidth`") 
 _core_.Image_swigregister(Image)
 
     Width = property(GetWidth,doc="See `GetWidth`") 
 _core_.Image_swigregister(Image)
 


@@ -3407,6 +3480,18 @@ class EvtHandler(Object):
         """ProcessPendingEvents(self)"""
         return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
 
         """ProcessPendingEvents(self)"""
         return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs)
 

+    def AllowReentrance(*args, **kwargs):
+        """AllowReentrance(self, bool allow=True)"""
+        return _core_.EvtHandler_AllowReentrance(*args, **kwargs)
+
+    def IsReentranceAllowed(*args, **kwargs):
+        """IsReentranceAllowed(self) -> bool"""
+        return _core_.EvtHandler_IsReentranceAllowed(*args, **kwargs)
+
+    def IsEventHandlingInProgress(*args, **kwargs):
+        """IsEventHandlingInProgress(self) -> bool"""
+        return _core_.EvtHandler_IsEventHandlingInProgress(*args, **kwargs)
+

     def Connect(*args, **kwargs):
         """Connect(self, int id, int lastId, int eventType, PyObject func)"""
         return _core_.EvtHandler_Connect(*args, **kwargs)
     def Connect(*args, **kwargs):
         """Connect(self, int id, int lastId, int eventType, PyObject func)"""
         return _core_.EvtHandler_Connect(*args, **kwargs)


@@ -7410,8 +7495,8 @@ in on the main display of your Mac."""
         destroy(self)
 
     def Destroy(self):
         destroy(self)
 
     def Destroy(self):

+        self.this.own(False)

         wx.PyApp.Destroy(self)
         wx.PyApp.Destroy(self)

-        self.thisown = 0

 
     def SetTopWindow(self, frame):
         """Set the \"main\" top level window"""
 
     def SetTopWindow(self, frame):
         """Set the \"main\" top level window"""


@@ -7726,10 +7811,11 @@ class AcceleratorTable(Object):
         _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
     __swig_destroy__ = _core_.delete_AcceleratorTable
     __del__ = lambda self : None;
         _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs))
     __swig_destroy__ = _core_.delete_AcceleratorTable
     __del__ = lambda self : None;

-    def Ok(*args, **kwargs):
-        """Ok(self) -> bool"""
-        return _core_.AcceleratorTable_Ok(*args, **kwargs)
+    def IsOk(*args, **kwargs):
+        """IsOk(self) -> bool"""
+        return _core_.AcceleratorTable_IsOk(*args, **kwargs)

 
 

+    Ok = IsOk 

 _core_.AcceleratorTable_swigregister(AcceleratorTable)
 
 
 _core_.AcceleratorTable_swigregister(AcceleratorTable)
 
 


@@ -7816,9 +7902,8 @@ class Window(EvtHandler):
         Returns True if the window has either been successfully deleted, or it
         has been added to the list of windows pending real deletion.
         """
         Returns True if the window has either been successfully deleted, or it
         has been added to the list of windows pending real deletion.
         """

-        val = _core_.Window_Destroy(*args, **kwargs)
-        args[0].thisown = 0
-        return val
+        args[0].this.own(False)
+        return _core_.Window_Destroy(*args, **kwargs)

 
     def DestroyChildren(*args, **kwargs):
         """
 
     def DestroyChildren(*args, **kwargs):
         """


@@ -9103,7 +9188,7 @@ class Window(EvtHandler):
         window instead of waiting for the EVT_PAINT event to happen, (normally
         this would usually only happen when the flow of control returns to the
         event loop.)  Notice that this function doesn't refresh the window and
         window instead of waiting for the EVT_PAINT event to happen, (normally
         this would usually only happen when the flow of control returns to the
         event loop.)  Notice that this function doesn't refresh the window and

-        does nothing if the window has been already repainted.  Use Refresh
+        does nothing if the window has been already repainted.  Use `Refresh`

         first if you want to immediately redraw the window (or some portion of
         it) unconditionally.
         """
         first if you want to immediately redraw the window (or some portion of
         it) unconditionally.
         """


@@ -9166,6 +9251,17 @@ class Window(EvtHandler):
         """
         return _core_.Window_PrepareDC(*args, **kwargs)
 
         """
         return _core_.Window_PrepareDC(*args, **kwargs)
 

+    def IsDoubleBuffered(*args, **kwargs):
+        """
+        IsDoubleBuffered(self) -> bool
+
+        Returns ``True`` if the window contents is double-buffered by the
+        system, i.e. if any drawing done on the window is really done on a
+        temporary backing surface and transferred to the screen all at once
+        later.
+        """
+        return _core_.Window_IsDoubleBuffered(*args, **kwargs)
+

     def GetUpdateRegion(*args, **kwargs):
         """
         GetUpdateRegion(self) -> Region
     def GetUpdateRegion(*args, **kwargs):
         """
         GetUpdateRegion(self) -> Region


@@ -10378,29 +10474,16 @@ class Menu(EvtHandler):
 
         Deletes the C++ object this Python object is a proxy for.
         """
 
         Deletes the C++ object this Python object is a proxy for.
         """

-        val = _core_.Menu_Destroy(*args, **kwargs)
-        args[0].thisown = 0
-        return val
+        args[0].this.own(False)
+        return _core_.Menu_Destroy(*args, **kwargs)

 
     def DestroyId(*args, **kwargs):
 
     def DestroyId(*args, **kwargs):

-        """
-        DestroyId(self, int id) -> bool
-
-        Deletes the C++ object this Python object is a proxy for.
-        """
-        val = _core_.Menu_DestroyId(*args, **kwargs)
-        args[0].thisown = 0
-        return val
+        """DestroyId(self, int id) -> bool"""
+        return _core_.Menu_DestroyId(*args, **kwargs)

 
     def DestroyItem(*args, **kwargs):
 
     def DestroyItem(*args, **kwargs):

-        """
-        DestroyItem(self, MenuItem item) -> bool
-
-        Deletes the C++ object this Python object is a proxy for.
-        """
-        val = _core_.Menu_DestroyItem(*args, **kwargs)
-        args[0].thisown = 0
-        return val
+        """DestroyItem(self, MenuItem item) -> bool"""
+        return _core_.Menu_DestroyItem(*args, **kwargs)

 
     def GetMenuItemCount(*args, **kwargs):
         """GetMenuItemCount(self) -> size_t"""
 
     def GetMenuItemCount(*args, **kwargs):
         """GetMenuItemCount(self) -> size_t"""


@@ -10942,14 +11025,6 @@ class Control(Window):
         """
         return _core_.Control_Command(*args, **kwargs)
 
         """
         return _core_.Control_Command(*args, **kwargs)
 

-    def GetLabel(*args, **kwargs):
-        """
-        GetLabel(self) -> String
-
-        Return a control's text.
-        """
-        return _core_.Control_GetLabel(*args, **kwargs)
-

     def GetClassDefaultAttributes(*args, **kwargs):
         """
         GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
     def GetClassDefaultAttributes(*args, **kwargs):
         """
         GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes


@@ -10969,7 +11044,6 @@ class Control(Window):
 
     GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
     Alignment = property(GetAlignment,doc="See `GetAlignment`") 
 
     GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
     Alignment = property(GetAlignment,doc="See `GetAlignment`") 

-    Label = property(GetLabel,doc="See `GetLabel`") 

     LabelText = property(GetLabelText,doc="See `GetLabelText`") 
 _core_.Control_swigregister(Control)
 ControlNameStr = cvar.ControlNameStr
     LabelText = property(GetLabelText,doc="See `GetLabelText`") 
 _core_.Control_swigregister(Control)
 ControlNameStr = cvar.ControlNameStr


@@ -13422,7 +13496,7 @@ 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()
     assert app is not None, 'No wx.App created yet'
     """
     app = wx.GetApp()
     assert app is not None, 'No wx.App created yet'


@@ -13441,7 +13515,7 @@ def CallAfter(callable, *args, **kw):
 #----------------------------------------------------------------------------
 
 
 #----------------------------------------------------------------------------
 
 

-class FutureCall:
+class CallLater:

     """
     A convenience class for `wx.Timer`, that calls the given callable
     object once after the given amount of milliseconds, passing any
     """
     A convenience class for `wx.Timer`, that calls the given callable
     object once after the given amount of milliseconds, passing any


@@ -13452,7 +13526,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`


@@ -13542,6 +13616,9 @@ class FutureCall:
     Result = property(GetResult)
 
 
     Result = property(GetResult)
 
 

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

 #----------------------------------------------------------------------------
 # Control which items in this module should be documented by epydoc.
 # We allow only classes and functions, which will help reduce the size
 #----------------------------------------------------------------------------
 # Control which items in this module should be documented by epydoc.
 # We allow only classes and functions, which will help reduce the size