Added some more docstrings, and also a few little tweaks along the way.

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

diff --git a/wxPython/src/msw/gdi.py b/wxPython/src/msw/gdi.py
index f7fce7ed2dba05685bcd7f27b6c1f7b9bf4a2015..e64a6900a9ae87111ee3ca09ad099a7198d08773 100644 (file)
--- a/wxPython/src/msw/gdi.py
+++ b/wxPython/src/msw/gdi.py
@@ -235,6 +235,10 @@ class Pen(GDIObject):
         """GetDashes() -> PyObject"""
         return _gdi.Pen_GetDashes(*args, **kwargs)
 
+    def __eq__(*args, **kwargs):
+        """__eq__(Pen pen) -> bool"""
+        return _gdi.Pen___eq__(*args, **kwargs)
+
     def GetDashCount(*args, **kwargs):
         """GetDashCount() -> int"""
         return _gdi.Pen_GetDashCount(*args, **kwargs)
@@ -584,9 +588,10 @@ class Mask(core.Object):
         return "<%s.%s; proxy of C++ wxMask instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
     def __init__(self, *args, **kwargs):
         """
-        __init__(Bitmap bitmap) -> Mask
+        __init__(Bitmap bitmap, Colour colour=NullColour) -> Mask
 
-        Constructs a mask from a monochrome bitmap.
+        Constructs a mask from a bitmap and a colour in that bitmap that indicates
+        the transparent portions of the mask, by default BLACK is used.
         """
         newobj = _gdi.new_Mask(*args, **kwargs)
         self.this = newobj.this
@@ -600,17 +605,7 @@ class MaskPtr(Mask):
         self.__class__ = Mask
 _gdi.Mask_swigregister(MaskPtr)
 
-def MaskColour(*args, **kwargs):
-    """
-    MaskColour(Bitmap bitmap, Colour colour) -> Mask
-
-    Constructs a mask from a bitmap and a colour in that bitmap that indicates the
-    background.
-    """
-    val = _gdi.new_MaskColour(*args, **kwargs)
-    val.thisown = 1
-    return val
-
+MaskColour = Mask 
 class Icon(GDIObject):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxIcon instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
@@ -2170,8 +2165,8 @@ _gdi.EncodingConverter_swigregister(EncodingConverterPtr)
 
 def GetTranslation(*args):
     """
-    GetTranslation(String sz) -> String
-    GetTranslation(String sz1, String sz2, size_t n) -> String
+    GetTranslation(String str) -> String
+    GetTranslation(String str, String strPlural, size_t n) -> String
     """
     return _gdi.GetTranslation(*args)
 
@@ -2520,6 +2515,10 @@ class DC(core.Object):
         """
         return _gdi.DC_GetMultiLineTextExtent(*args, **kwargs)
 
+    def GetPartialTextExtents(*args, **kwargs):
+        """GetPartialTextExtents(String text) -> wxArrayInt"""
+        return _gdi.DC_GetPartialTextExtents(*args, **kwargs)
+
     def GetSize(*args, **kwargs):
         """
         GetSize() -> Size
@@ -2895,16 +2894,22 @@ def MemoryDCFromDC(*args, **kwargs):
 
 #---------------------------------------------------------------------------
 
+BUFFER_DC_OVERWRITE_BG = _gdi.BUFFER_DC_OVERWRITE_BG
+BUFFER_DC_PRESERVE_BG = _gdi.BUFFER_DC_PRESERVE_BG
+BUFFER_DC_DEFAULT = _gdi.BUFFER_DC_DEFAULT
 class BufferedDC(MemoryDC):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxBufferedDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
-    def __init__(self, *args, **kwargs):
-        """__init__(DC dc, Bitmap buffer) -> BufferedDC"""
-        newobj = _gdi.new_BufferedDC(*args, **kwargs)
+    def __init__(self, *args):
+        """
+        __init__(DC dc, Bitmap buffer) -> BufferedDC
+        __init__(DC dc, Size area, int flags=BUFFER_DC_DEFAULT) -> BufferedDC
+        """
+        newobj = _gdi.new_BufferedDC(*args)
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown
-        self._dc = args[0] # save a ref so the other dc will not be deleted before self
+        val._dc = args[0] # save a ref so the other dc will not be deleted before self
 
     def UnMask(*args, **kwargs):
         """UnMask()"""
@@ -2918,9 +2923,9 @@ class BufferedDCPtr(BufferedDC):
         self.__class__ = BufferedDC
 _gdi.BufferedDC_swigregister(BufferedDCPtr)
 
-def BufferedDCInternalBuffer(*args, **kwargs):
-    """BufferedDCInternalBuffer(DC dc, Size area) -> BufferedDC"""
-    val = _gdi.new_BufferedDCInternalBuffer(*args, **kwargs)
+def BufferedDCInternalBuffer(*args):
+    """BufferedDCInternalBuffer(DC dc, Size area, int flags=BUFFER_DC_DEFAULT) -> BufferedDC"""
+    val = _gdi.new_BufferedDCInternalBuffer(*args)
     val.thisown = 1
     val._dc = args[0] # save a ref so the other dc will not be deleted before self
     return val
@@ -2928,9 +2933,12 @@ def BufferedDCInternalBuffer(*args, **kwargs):
 class BufferedPaintDC(BufferedDC):
     def __repr__(self):
         return "<%s.%s; proxy of C++ wxBufferedPaintDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
-    def __init__(self, *args, **kwargs):
-        """__init__(Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC"""
-        newobj = _gdi.new_BufferedPaintDC(*args, **kwargs)
+    def __init__(self, *args):
+        """
+        __init__(Window window, Bitmap buffer) -> BufferedPaintDC
+        __init__(Window window, int flags=BUFFER_DC_DEFAULT) -> BufferedPaintDC
+        """
+        newobj = _gdi.new_BufferedPaintDC(*args)
         self.this = newobj.this
         self.thisown = 1
         del newobj.thisown