]> git.saurik.com Git - wxWidgets.git/blobdiff - wxPython/src/msw/_gdi.py
Elippsis and markup support for wxStaticText
[wxWidgets.git] / wxPython / src / msw / _gdi.py
index 23cc061890a76b66ae6e71edbf4827960ca32baf..eeed44bce8e76a3ded906b6f7c9e073931de16fe 100644 (file)
@@ -698,7 +698,7 @@ class Bitmap(GDIObject):
         CopyFromBuffer(self, buffer data)
 
         Copy data from a RGB buffer object to replace the bitmap pixel data.
-        See `wxBitmapFromBuffer` for more .
+        See `wx.BitmapFromBuffer` for more .
         """
         return _gdi_.Bitmap_CopyFromBuffer(*args, **kwargs)
 
@@ -707,7 +707,7 @@ class Bitmap(GDIObject):
         CopyFromBufferRGBA(self, buffer data)
 
         Copy data from a RGBA buffer object to replace the bitmap pixel data.
-        See `wxBitmapFromBufferRGBA` for more .
+        See `wx.BitmapFromBufferRGBA` for more .
         """
         return _gdi_.Bitmap_CopyFromBufferRGBA(*args, **kwargs)
 
@@ -2406,12 +2406,12 @@ class FontEnumerator(object):
     def __init__(self, *args, **kwargs): 
         """__init__(self) -> FontEnumerator"""
         _gdi_.FontEnumerator_swiginit(self,_gdi_.new_FontEnumerator(*args, **kwargs))
-        self._setCallbackInfo(self, FontEnumerator, 0)
+        FontEnumerator._setCallbackInfo(self, self, FontEnumerator)
 
     __swig_destroy__ = _gdi_.delete_FontEnumerator
     __del__ = lambda self : None;
     def _setCallbackInfo(*args, **kwargs):
-        """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
+        """_setCallbackInfo(self, PyObject self, PyObject _class, int incref=0)"""
         return _gdi_.FontEnumerator__setCallbackInfo(*args, **kwargs)
 
     def EnumerateFacenames(*args, **kwargs):
@@ -2723,9 +2723,8 @@ class Locale(object):
     __del__ = lambda self : None;
     def Init1(*args, **kwargs):
         """
-        Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString, 
-            bool bLoadDefault=True, 
-            bool bConvertEncoding=False) -> bool
+        Init1(self, String name, String shortName=EmptyString, String locale=EmptyString, 
+            bool bLoadDefault=True, bool bConvertEncoding=False) -> bool
         """
         return _gdi_.Locale_Init1(*args, **kwargs)
 
@@ -2782,7 +2781,7 @@ class Locale(object):
 
     AddCatalogLookupPathPrefix = staticmethod(AddCatalogLookupPathPrefix)
     def AddCatalog(*args, **kwargs):
-        """AddCatalog(self, String szDomain) -> bool"""
+        """AddCatalog(self, String domain) -> bool"""
         return _gdi_.Locale_AddCatalog(*args, **kwargs)
 
     def IsAvailable(*args, **kwargs):
@@ -2791,7 +2790,7 @@ class Locale(object):
 
     IsAvailable = staticmethod(IsAvailable)
     def IsLoaded(*args, **kwargs):
-        """IsLoaded(self, String szDomain) -> bool"""
+        """IsLoaded(self, String domain) -> bool"""
         return _gdi_.Locale_IsLoaded(*args, **kwargs)
 
     def GetLanguageInfo(*args, **kwargs):
@@ -2815,7 +2814,7 @@ class Locale(object):
 
     AddLanguage = staticmethod(AddLanguage)
     def GetString(*args, **kwargs):
-        """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
+        """GetString(self, String origString, String domain=EmptyString) -> String"""
         return _gdi_.Locale_GetString(*args, **kwargs)
 
     def GetName(*args, **kwargs):
@@ -2873,7 +2872,7 @@ class PyLocale(Locale):
     def __init__(self, *args, **kwargs): 
         """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale"""
         _gdi_.PyLocale_swiginit(self,_gdi_.new_PyLocale(*args, **kwargs))
-        self._setCallbackInfo(self, PyLocale)
+        PyLocale._setCallbackInfo(self, self, PyLocale)
 
     __swig_destroy__ = _gdi_.delete_PyLocale
     __del__ = lambda self : None;
@@ -2882,14 +2881,11 @@ class PyLocale(Locale):
         return _gdi_.PyLocale__setCallbackInfo(*args, **kwargs)
 
     def GetSingularString(*args, **kwargs):
-        """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar"""
+        """GetSingularString(self, String origString, String domain=EmptyString) -> String"""
         return _gdi_.PyLocale_GetSingularString(*args, **kwargs)
 
     def GetPluralString(*args, **kwargs):
-        """
-        GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n, 
-            wxChar szDomain=None) -> wxChar
-        """
+        """GetPluralString(self, String origString, String origString2, size_t n, String domain=EmptyString) -> String"""
         return _gdi_.PyLocale_GetPluralString(*args, **kwargs)
 
 _gdi_.PyLocale_swigregister(PyLocale)
@@ -3474,6 +3470,35 @@ class DC(_core.Object):
         """
         return _gdi_.DC_BlitPointSize(*args, **kwargs)
 
+    def StretchBlit(*args, **kwargs):
+        """
+        StretchBlit(self, int dstX, int dstY, int dstWidth, int dstHeight, DC source, 
+            int srcX, int srcY, int srcWidth, int srcHeight, 
+            int rop=COPY, bool useMask=False, 
+            int srcMaskX=wxDefaultCoord, int srcMaskY=wxDefaultCoord) -> bool
+
+        Copy from a source DC to this DC, specifying the destination
+        coordinates, destination size, source DC, source coordinates, size of
+        source area to copy, logical function, whether to use a bitmap mask,
+        and mask source position.
+        """
+        return _gdi_.DC_StretchBlit(*args, **kwargs)
+
+    def StretchBlitPointSize(*args, **kwargs):
+        """
+        StretchBlitPointSize(self, Point dstPt, Size dstSize, DC source, Point srcPt, 
+            Size srcSize, int rop=COPY, bool useMask=False, 
+            Point srcMaskPt=DefaultPosition) -> bool
+
+        Copy from a source DC to this DC, specifying the destination
+        coordinates, destination size, source DC, source coordinates, size of
+        source area to copy, logical function, whether to use a bitmap mask,
+        and mask source position.  This version is the same as `StretchBlit`
+        except `wx.Point` and `wx.Size` objects are used instead of individual
+        position and size components.
+        """
+        return _gdi_.DC_StretchBlitPointSize(*args, **kwargs)
+
     def GetAsBitmap(*args, **kwargs):
         """GetAsBitmap(self, Rect subrect=None) -> Bitmap"""
         return _gdi_.DC_GetAsBitmap(*args, **kwargs)
@@ -4786,6 +4811,7 @@ def MemoryDCFromDC(*args, **kwargs):
 
 BUFFER_VIRTUAL_AREA = _gdi_.BUFFER_VIRTUAL_AREA
 BUFFER_CLIENT_AREA = _gdi_.BUFFER_CLIENT_AREA
+BUFFER_USES_SHARED_BUFFER = _gdi_.BUFFER_USES_SHARED_BUFFER
 class BufferedDC(MemoryDC):
     """
     This simple class provides a simple way to avoid flicker: when drawing
@@ -4823,7 +4849,11 @@ class BufferedDC(MemoryDC):
         Constructs a buffered DC.
         """
         _gdi_.BufferedDC_swiginit(self,_gdi_.new_BufferedDC(*args))
-        self.__dc = args[0] # save a ref so the other dc will not be deleted before self
+        # save a ref so the other dc will not be deleted before self
+        self.__dc = args[0] 
+        # also save a ref to the bitmap
+        if len(args) > 1: self.__bmp = args[1]
+
 
     __swig_destroy__ = _gdi_.delete_BufferedDC
     __del__ = lambda self : None;
@@ -4880,6 +4910,8 @@ class BufferedPaintDC(BufferedDC):
         window is automatically used).
         """
         _gdi_.BufferedPaintDC_swiginit(self,_gdi_.new_BufferedPaintDC(*args, **kwargs))
+        if len(args) > 1: self.__bmp = args[1]
+
 _gdi_.BufferedPaintDC_swigregister(BufferedPaintDC)
 
 #---------------------------------------------------------------------------
@@ -5184,22 +5216,13 @@ _gdi_.GraphicsFont_swigregister(GraphicsFont)
 class GraphicsMatrix(GraphicsObject):
     """
     A wx.GraphicsMatrix is a native representation of an affine
-    matrix. The contents are specific an private to the respective
+    matrix. The contents are specific and private to the respective
     renderer. The only way to get a valid instance is via a CreateMatrix
     call on the graphics context or the renderer instance.
     """
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+    def __init__(self): raise AttributeError, "No constructor defined"
     __repr__ = _swig_repr
-    def __init__(self, *args, **kwargs): 
-        """
-        __init__(self) -> GraphicsMatrix
-
-        A wx.GraphicsMatrix is a native representation of an affine
-        matrix. The contents are specific an private to the respective
-        renderer. The only way to get a valid instance is via a CreateMatrix
-        call on the graphics context or the renderer instance.
-        """
-        _gdi_.GraphicsMatrix_swiginit(self,_gdi_.new_GraphicsMatrix(*args, **kwargs))
     __swig_destroy__ = _gdi_.delete_GraphicsMatrix
     __del__ = lambda self : None;
     def Concat(*args, **kwargs):
@@ -5220,6 +5243,14 @@ class GraphicsMatrix(GraphicsObject):
         """
         return _gdi_.GraphicsMatrix_Set(*args, **kwargs)
 
+    def Get(*args, **kwargs):
+        """
+        Get(self) --> (a, b, c, d, tx, ty)
+
+        Gets the component values of the matrix and returns them as a tuple.
+        """
+        return _gdi_.GraphicsMatrix_Get(*args, **kwargs)
+
     def Invert(*args, **kwargs):
         """
         Invert(self)
@@ -5232,7 +5263,8 @@ class GraphicsMatrix(GraphicsObject):
         """
         IsEqual(self, GraphicsMatrix t) -> bool
 
-        Returns ``True`` if the elements of the transformation matrix are equal
+        Returns ``True`` if the elements of the transformation matrix are
+        equal
         """
         return _gdi_.GraphicsMatrix_IsEqual(*args, **kwargs)
 
@@ -5301,10 +5333,8 @@ _gdi_.GraphicsMatrix_swigregister(GraphicsMatrix)
 class GraphicsPath(GraphicsObject):
     """Proxy of C++ GraphicsPath class"""
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+    def __init__(self): raise AttributeError, "No constructor defined"
     __repr__ = _swig_repr
-    def __init__(self, *args, **kwargs): 
-        """__init__(self) -> GraphicsPath"""
-        _gdi_.GraphicsPath_swiginit(self,_gdi_.new_GraphicsPath(*args, **kwargs))
     __swig_destroy__ = _gdi_.delete_GraphicsPath
     __del__ = lambda self : None;
     def MoveToPoint(*args):
@@ -5363,9 +5393,9 @@ class GraphicsPath(GraphicsObject):
     def AddArc(*args):
         """
         AddArc(self, Double x, Double y, Double r, Double startAngle, Double endAngle, 
-            bool clockwise)
+            bool clockwise=True)
         AddArc(self, Point2D c, Double r, Double startAngle, Double endAngle, 
-            bool clockwise)
+            bool clockwise=True)
 
         Adds an arc of a circle centering at (x,y) with radius (r) from
         startAngle to endAngle
@@ -5401,8 +5431,8 @@ class GraphicsPath(GraphicsObject):
         """
         AddArcToPoint(self, Double x1, Double y1, Double x2, Double y2, Double r)
 
-        Appends an arc to two tangents connecting (current) to (x1,y1) and (x1,y1)
-        to (x2,y2), also a straight line from (current) to (x1,y1)
+        Appends an arc to two tangents connecting (current) to (x1,y1) and
+        (x1,y1) to (x2,y2), also a straight line from (current) to (x1,y1)
         """
         return _gdi_.GraphicsPath_AddArcToPoint(*args, **kwargs)
 
@@ -5452,16 +5482,17 @@ class GraphicsPath(GraphicsObject):
 
     def GetBox(*args, **kwargs):
         """
-        GetBox(self) -> wxRect2DDouble
+        GetBox(self) -> Rect2D
 
-        Gets the bounding box enclosing all points (possibly including control points)
+        Gets the bounding box enclosing all points (possibly including control
+        points)
         """
         return _gdi_.GraphicsPath_GetBox(*args, **kwargs)
 
     def Contains(*args):
         """
         Contains(self, Double x, Double y, int fillStyle=ODDEVEN_RULE) -> bool
-        Contains(self, wxPoint2DDouble c, int fillStyle=ODDEVEN_RULE) -> bool
+        Contains(self, Point2D c, int fillStyle=ODDEVEN_RULE) -> bool
 
         Returns ``True`` if the point is within the path.
         """
@@ -5509,9 +5540,10 @@ class GraphicsContext(GraphicsObject):
         """
         CreateFromNative(void context) -> GraphicsContext
 
-        Creates a wx.GraphicsContext from a native context. This native context
-        must be eg a CGContextRef for Core Graphics, a Graphics pointer for
-        GDIPlus or a cairo_t pointer for Cairo.
+        Creates a wx.GraphicsContext from a native context. This native
+        context must be eg a CGContextRef for Core Graphics, a Graphics
+        pointer for GDIPlus or a cairo_t pointer for Cairo.  NOTE: For
+        wxPython we still need a way to make this value usable.
         """
         return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs)
 
@@ -5520,7 +5552,8 @@ class GraphicsContext(GraphicsObject):
         """
         CreateFromNativeWindow(void window) -> GraphicsContext
 
-        Creates a wx.GraphicsContext from a native window.
+        Creates a wx.GraphicsContext from a native window.  NOTE: For wxPython
+        we still need a way to make this value usable.
         """
         return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs)
 
@@ -5564,8 +5597,8 @@ class GraphicsContext(GraphicsObject):
         CreateRadialGradientBrush(self, Double xo, Double yo, Double xc, Double yc, Double radius, 
             Colour oColor, Colour cColor) -> GraphicsBrush
 
-        Creates a native brush, having a radial gradient originating at 
-        point (xo,yc) with color oColour and ends on a circle around (xc,yc) with
+        Creates a native brush, having a radial gradient originating at point
+        (xo,yc) with color oColour and ends on a circle around (xc,yc) with
         radius r and color cColour.
         """
         return _gdi_.GraphicsContext_CreateRadialGradientBrush(*args, **kwargs)
@@ -5592,7 +5625,8 @@ class GraphicsContext(GraphicsObject):
         """
         PushState(self)
 
-        push the current state of the context, ie the transformation matrix on a stack
+        Push the current state of the context, (ie the transformation matrix)
+        on a stack
         """
         return _gdi_.GraphicsContext_PushState(*args, **kwargs)
 
@@ -5600,7 +5634,7 @@ class GraphicsContext(GraphicsObject):
         """
         PopState(self)
 
-        pops a stored state from the stack
+        Pops a stored state from the stack
         """
         return _gdi_.GraphicsContext_PopState(*args, **kwargs)
 
@@ -5637,6 +5671,22 @@ class GraphicsContext(GraphicsObject):
         """
         return _gdi_.GraphicsContext_GetNativeContext(*args, **kwargs)
 
+    def GetLogicalFunction(*args, **kwargs):
+        """
+        GetLogicalFunction(self) -> int
+
+        Returns the current logical function.
+        """
+        return _gdi_.GraphicsContext_GetLogicalFunction(*args, **kwargs)
+
+    def SetLogicalFunction(*args, **kwargs):
+        """
+        SetLogicalFunction(self, int function) -> bool
+
+        Sets the current logical function, returns ``True`` if it supported
+        """
+        return _gdi_.GraphicsContext_SetLogicalFunction(*args, **kwargs)
+
     def Translate(*args, **kwargs):
         """
         Translate(self, Double dx, Double dy)
@@ -5822,7 +5872,7 @@ class GraphicsContext(GraphicsObject):
 
     def StrokeLineSegements(*args, **kwargs):
         """
-        StrokeLineSegements(self, PyObject beginPoints, PyObject endPoints)
+        StrokeLineSegments(self, List beginPoints, List endPoints)
 
         Stroke disconnected lines from begin to end points
         """
@@ -5901,9 +5951,10 @@ def GraphicsContext_CreateFromNative(*args, **kwargs):
   """
     GraphicsContext_CreateFromNative(void context) -> GraphicsContext
 
-    Creates a wx.GraphicsContext from a native context. This native context
-    must be eg a CGContextRef for Core Graphics, a Graphics pointer for
-    GDIPlus or a cairo_t pointer for Cairo.
+    Creates a wx.GraphicsContext from a native context. This native
+    context must be eg a CGContextRef for Core Graphics, a Graphics
+    pointer for GDIPlus or a cairo_t pointer for Cairo.  NOTE: For
+    wxPython we still need a way to make this value usable.
     """
   return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs)
 
@@ -5911,7 +5962,8 @@ def GraphicsContext_CreateFromNativeWindow(*args, **kwargs):
   """
     GraphicsContext_CreateFromNativeWindow(void window) -> GraphicsContext
 
-    Creates a wx.GraphicsContext from a native window.
+    Creates a wx.GraphicsContext from a native window.  NOTE: For wxPython
+    we still need a way to make this value usable.
     """
   return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs)
 
@@ -5993,9 +6045,12 @@ class GCDC(DC):
     """Proxy of C++ GCDC class"""
     thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
     __repr__ = _swig_repr
-    def __init__(self, *args, **kwargs): 
-        """__init__(self, WindowDC dc) -> GCDC"""
-        _gdi_.GCDC_swiginit(self,_gdi_.new_GCDC(*args, **kwargs))
+    def __init__(self, *args): 
+        """
+        __init__(self, WindowDC dc) -> GCDC
+        __init__(self, Window window) -> GCDC
+        """
+        _gdi_.GCDC_swiginit(self,_gdi_.new_GCDC(*args))
         self.__dc = args[0] # save a ref so the other dc will not be deleted before self
 
     __swig_destroy__ = _gdi_.delete_GCDC
@@ -6338,17 +6393,6 @@ class PenList(GDIObjListBase):
         """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
         return _gdi_.PenList_FindOrCreatePen(*args, **kwargs)
 
-    def AddPen(*args, **kwargs):
-        """AddPen(self, Pen pen)"""
-        return _gdi_.PenList_AddPen(*args, **kwargs)
-
-    def RemovePen(*args, **kwargs):
-        """RemovePen(self, Pen pen)"""
-        return _gdi_.PenList_RemovePen(*args, **kwargs)
-
-    AddPen = wx._deprecated(AddPen)
-    RemovePen = wx._deprecated(RemovePen)
-
 _gdi_.PenList_swigregister(PenList)
 
 class BrushList(GDIObjListBase):
@@ -6360,17 +6404,6 @@ class BrushList(GDIObjListBase):
         """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
         return _gdi_.BrushList_FindOrCreateBrush(*args, **kwargs)
 
-    def AddBrush(*args, **kwargs):
-        """AddBrush(self, Brush brush)"""
-        return _gdi_.BrushList_AddBrush(*args, **kwargs)
-
-    def RemoveBrush(*args, **kwargs):
-        """RemoveBrush(self, Brush brush)"""
-        return _gdi_.BrushList_RemoveBrush(*args, **kwargs)
-
-    AddBrush = wx._deprecated(AddBrush)
-    RemoveBrush = wx._deprecated(RemoveBrush)
-
 _gdi_.BrushList_swigregister(BrushList)
 
 class FontList(GDIObjListBase):
@@ -6386,17 +6419,6 @@ class FontList(GDIObjListBase):
         """
         return _gdi_.FontList_FindOrCreateFont(*args, **kwargs)
 
-    def AddFont(*args, **kwargs):
-        """AddFont(self, Font font)"""
-        return _gdi_.FontList_AddFont(*args, **kwargs)
-
-    def RemoveFont(*args, **kwargs):
-        """RemoveFont(self, Font font)"""
-        return _gdi_.FontList_RemoveFont(*args, **kwargs)
-
-    AddFont = wx._deprecated(AddFont)
-    RemoveFont = wx._deprecated(RemoveFont)
-
 _gdi_.FontList_swigregister(FontList)
 
 class ColourDatabase(object):
@@ -6664,17 +6686,17 @@ class RendererNative(object):
     def DrawHeaderButton(*args, **kwargs):
         """
         DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE, 
-            HeaderButtonParams params=None)
+            HeaderButtonParams params=None) -> int
 
-        Draw the header control button (such as what is used by `wx.ListCtrl`
-        in report mode.)
+        Draw a header control button (such as what is used by `wx.ListCtrl` in report
+        mode.)  The optimal size of the label (text and icons) is returned.
         """
         return _gdi_.RendererNative_DrawHeaderButton(*args, **kwargs)
 
     def DrawHeaderButtonContents(*args, **kwargs):
         """
         DrawHeaderButtonContents(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE, 
-            HeaderButtonParams params=None)
+            HeaderButtonParams params=None) -> int
 
         Draw the contents of a header control button, (label, sort
         arrows, etc.)  Normally this is only called by `DrawHeaderButton`.
@@ -6993,7 +7015,7 @@ class PseudoDC(_core.Object):
 
     def FindObjects(*args, **kwargs):
         """
-        FindObjects(self, int x, int y, int radius=1, wxColor bg=*wxWHITE) -> PyObject
+        FindObjects(self, int x, int y, int radius=1, Colour bg=*wxWHITE) -> PyObject
 
         Returns a list of all the id's that draw a pixel with color
         not equal to bg within radius of (x,y).