X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b6df5cf983b27cc810341ac475533ef739b33b37..f7a50432401c62a3300b0b9faa7e99d7ffe3d4e8:/wxPython/src/msw/_gdi.py diff --git a/wxPython/src/msw/_gdi.py b/wxPython/src/msw/_gdi.py index ec4122bace..ce3d8648f9 100644 --- a/wxPython/src/msw/_gdi.py +++ b/wxPython/src/msw/_gdi.py @@ -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): @@ -2873,7 +2873,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; @@ -4580,69 +4580,6 @@ _gdi_.DCClipper_swigregister(DCClipper) #--------------------------------------------------------------------------- -class MemoryDC(DC): - """ - A memory device context provides a means to draw graphics onto a - bitmap. A bitmap must be selected into the new memory DC before it may - be used for anything. Typical usage is as follows:: - - dc = wx.MemoryDC() - dc.SelectObject(bitmap) - # draw on the dc using any of the Draw methods - dc.SelectObject(wx.NullBitmap) - # the bitmap now contains wahtever was drawn upon it - - Note that the memory DC *must* be deleted (or the bitmap selected out - of it) before a bitmap can be reselected into another memory DC. - - """ - 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, Bitmap bitmap=NullBitmap) -> MemoryDC - - Constructs a new memory device context. - - Use the Ok member to test whether the constructor was successful in - creating a usable device context. If a bitmap is not given to this - constructor then don't forget to select a bitmap into the DC before - drawing on it. - """ - _gdi_.MemoryDC_swiginit(self,_gdi_.new_MemoryDC(*args, **kwargs)) - def SelectObject(*args, **kwargs): - """ - SelectObject(self, Bitmap bitmap) - - Selects the bitmap into the device context, to use as the memory - bitmap. Selecting the bitmap into a memory DC allows you to draw into - the DC, and therefore the bitmap, and also to use Blit to copy the - bitmap to a window. - - If the argument is wx.NullBitmap (or some other uninitialised - `wx.Bitmap`) the current bitmap is selected out of the device context, - and the original bitmap restored, allowing the current bitmap to be - destroyed safely. - """ - return _gdi_.MemoryDC_SelectObject(*args, **kwargs) - - def SelectObjectAsSource(*args, **kwargs): - """SelectObjectAsSource(self, Bitmap bmp)""" - return _gdi_.MemoryDC_SelectObjectAsSource(*args, **kwargs) - -_gdi_.MemoryDC_swigregister(MemoryDC) - -def MemoryDCFromDC(*args, **kwargs): - """ - MemoryDCFromDC(DC oldDC) -> MemoryDC - - Creates a DC that is compatible with the oldDC. - """ - val = _gdi_.new_MemoryDCFromDC(*args, **kwargs) - return val - -#--------------------------------------------------------------------------- - class ScreenDC(DC): """ A wxScreenDC can be used to paint anywhere on the screen. This should @@ -4784,6 +4721,69 @@ _gdi_.PaintDC_swigregister(PaintDC) #--------------------------------------------------------------------------- +class MemoryDC(WindowDC): + """ + A memory device context provides a means to draw graphics onto a + bitmap. A bitmap must be selected into the new memory DC before it may + be used for anything. Typical usage is as follows:: + + dc = wx.MemoryDC() + dc.SelectObject(bitmap) + # draw on the dc using any of the Draw methods + dc.SelectObject(wx.NullBitmap) + # the bitmap now contains wahtever was drawn upon it + + Note that the memory DC *must* be deleted (or the bitmap selected out + of it) before a bitmap can be reselected into another memory DC. + + """ + 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, Bitmap bitmap=NullBitmap) -> MemoryDC + + Constructs a new memory device context. + + Use the Ok member to test whether the constructor was successful in + creating a usable device context. If a bitmap is not given to this + constructor then don't forget to select a bitmap into the DC before + drawing on it. + """ + _gdi_.MemoryDC_swiginit(self,_gdi_.new_MemoryDC(*args, **kwargs)) + def SelectObject(*args, **kwargs): + """ + SelectObject(self, Bitmap bitmap) + + Selects the bitmap into the device context, to use as the memory + bitmap. Selecting the bitmap into a memory DC allows you to draw into + the DC, and therefore the bitmap, and also to use Blit to copy the + bitmap to a window. + + If the argument is wx.NullBitmap (or some other uninitialised + `wx.Bitmap`) the current bitmap is selected out of the device context, + and the original bitmap restored, allowing the current bitmap to be + destroyed safely. + """ + return _gdi_.MemoryDC_SelectObject(*args, **kwargs) + + def SelectObjectAsSource(*args, **kwargs): + """SelectObjectAsSource(self, Bitmap bmp)""" + return _gdi_.MemoryDC_SelectObjectAsSource(*args, **kwargs) + +_gdi_.MemoryDC_swigregister(MemoryDC) + +def MemoryDCFromDC(*args, **kwargs): + """ + MemoryDCFromDC(DC oldDC) -> MemoryDC + + Creates a DC that is compatible with the oldDC. + """ + val = _gdi_.new_MemoryDCFromDC(*args, **kwargs) + return val + +#--------------------------------------------------------------------------- + BUFFER_VIRTUAL_AREA = _gdi_.BUFFER_VIRTUAL_AREA BUFFER_CLIENT_AREA = _gdi_.BUFFER_CLIENT_AREA class BufferedDC(MemoryDC): @@ -4823,7 +4823,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 +4884,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) #--------------------------------------------------------------------------- @@ -5071,63 +5077,134 @@ _gdi_.PrinterDC_swigregister(PrinterDC) #--------------------------------------------------------------------------- class GraphicsObject(_core.Object): - """Proxy of C++ GraphicsObject class""" + """ + This class is the superclass of native graphics objects like pens + etc. It provides the internal reference counting. It is not to be + instantiated by user code. + """ 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, GraphicsRenderer renderer=None) -> GraphicsObject""" + """ + __init__(self, GraphicsRenderer renderer=None) -> GraphicsObject + + This class is the superclass of native graphics objects like pens + etc. It provides the internal reference counting. It is not to be + instantiated by user code. + """ _gdi_.GraphicsObject_swiginit(self,_gdi_.new_GraphicsObject(*args, **kwargs)) __swig_destroy__ = _gdi_.delete_GraphicsObject __del__ = lambda self : None; def IsNull(*args, **kwargs): - """IsNull(self) -> bool""" + """ + IsNull(self) -> bool + + Is this object valid (false) or still empty (true)? + """ return _gdi_.GraphicsObject_IsNull(*args, **kwargs) def GetRenderer(*args, **kwargs): - """GetRenderer(self) -> GraphicsRenderer""" + """ + GetRenderer(self) -> GraphicsRenderer + + Returns the renderer that was used to create this instance, or + ``None`` if it has not been initialized yet. + """ return _gdi_.GraphicsObject_GetRenderer(*args, **kwargs) _gdi_.GraphicsObject_swigregister(GraphicsObject) class GraphicsPen(GraphicsObject): - """Proxy of C++ GraphicsPen class""" + """ + A wx.GraphicsPen is a native representation of a pen. It is used for + stroking a path on a `wx.GraphicsContext`. The contents are specific and + private to the respective renderer. The only way to get a valid instance + is via a CreatePen 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') __repr__ = _swig_repr def __init__(self, *args, **kwargs): - """__init__(self) -> GraphicsPen""" + """ + __init__(self) -> GraphicsPen + + A wx.GraphicsPen is a native representation of a pen. It is used for + stroking a path on a `wx.GraphicsContext`. The contents are specific and + private to the respective renderer. The only way to get a valid instance + is via a CreatePen call on the graphics context or the renderer + instance. + """ _gdi_.GraphicsPen_swiginit(self,_gdi_.new_GraphicsPen(*args, **kwargs)) __swig_destroy__ = _gdi_.delete_GraphicsPen __del__ = lambda self : None; _gdi_.GraphicsPen_swigregister(GraphicsPen) class GraphicsBrush(GraphicsObject): - """Proxy of C++ GraphicsBrush class""" + """ + A wx.GraphicsBrush is a native representation of a brush. It is used + for filling a path on a `wx.GraphicsContext`. The contents are + specific and private to the respective renderer. The only way to get a + valid instance is via a Create...Brush 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') __repr__ = _swig_repr def __init__(self, *args, **kwargs): - """__init__(self) -> GraphicsBrush""" + """ + __init__(self) -> GraphicsBrush + + A wx.GraphicsBrush is a native representation of a brush. It is used + for filling a path on a `wx.GraphicsContext`. The contents are + specific and private to the respective renderer. The only way to get a + valid instance is via a Create...Brush call on the graphics context or + the renderer instance. + """ _gdi_.GraphicsBrush_swiginit(self,_gdi_.new_GraphicsBrush(*args, **kwargs)) __swig_destroy__ = _gdi_.delete_GraphicsBrush __del__ = lambda self : None; _gdi_.GraphicsBrush_swigregister(GraphicsBrush) class GraphicsFont(GraphicsObject): - """Proxy of C++ GraphicsFont class""" + """ + A `wx.GraphicsFont` is a native representation of a font (including + text colour). The contents are specific an private to the respective + renderer. The only way to get a valid instance is via a CreateFont + 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') __repr__ = _swig_repr def __init__(self, *args, **kwargs): - """__init__(self) -> GraphicsFont""" + """ + __init__(self) -> GraphicsFont + + A `wx.GraphicsFont` is a native representation of a font (including + text colour). The contents are specific an private to the respective + renderer. The only way to get a valid instance is via a CreateFont + call on the graphics context or the renderer instance. + """ _gdi_.GraphicsFont_swiginit(self,_gdi_.new_GraphicsFont(*args, **kwargs)) __swig_destroy__ = _gdi_.delete_GraphicsFont __del__ = lambda self : None; _gdi_.GraphicsFont_swigregister(GraphicsFont) class GraphicsMatrix(GraphicsObject): - """Proxy of C++ GraphicsMatrix class""" + """ + 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. + """ 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) -> GraphicsMatrix""" + """ + __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; @@ -5135,32 +5212,33 @@ class GraphicsMatrix(GraphicsObject): """ Concat(self, GraphicsMatrix t) - concatenates the matrix + Concatenates the passed in matrix to the current matrix. """ return _gdi_.GraphicsMatrix_Concat(*args, **kwargs) - def Copy(*args, **kwargs): - """ - Copy(self, GraphicsMatrix t) - - Copy the passed in matrix to this one. - """ - return _gdi_.GraphicsMatrix_Copy(*args, **kwargs) - def Set(*args, **kwargs): """ Set(self, Double a=1.0, Double b=0.0, Double c=0.0, Double d=1.0, Double tx=0.0, Double ty=0.0) - sets the matrix to the respective values + Sets the matrix to the specified values (default values are the + identity matrix.) """ 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) - makes this the inverse matrix + Inverts the matrix. """ return _gdi_.GraphicsMatrix_Invert(*args, **kwargs) @@ -5168,7 +5246,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) @@ -5176,7 +5255,7 @@ class GraphicsMatrix(GraphicsObject): """ IsIdentity(self) -> bool - return true if this is the identity matrix + Returns ``True`` if this is the identity matrix """ return _gdi_.GraphicsMatrix_IsIdentity(*args, **kwargs) @@ -5184,7 +5263,7 @@ class GraphicsMatrix(GraphicsObject): """ Translate(self, Double dx, Double dy) - add the translation to this matrix + Add a translation to this matrix. """ return _gdi_.GraphicsMatrix_Translate(*args, **kwargs) @@ -5192,7 +5271,7 @@ class GraphicsMatrix(GraphicsObject): """ Scale(self, Double xScale, Double yScale) - add the scale to this matrix + Scales this matrix. """ return _gdi_.GraphicsMatrix_Scale(*args, **kwargs) @@ -5200,7 +5279,7 @@ class GraphicsMatrix(GraphicsObject): """ Rotate(self, Double angle) - add the rotation to this matrix (radians) + Rotates this matrix. The angle should be specified in radians. """ return _gdi_.GraphicsMatrix_Rotate(*args, **kwargs) @@ -5208,7 +5287,7 @@ class GraphicsMatrix(GraphicsObject): """ TransformPoint(self, x, y) --> (x, y) - applies that matrix to the point + Applies this matrix to a point, returns the resulting point values """ return _gdi_.GraphicsMatrix_TransformPoint(*args, **kwargs) @@ -5216,7 +5295,8 @@ class GraphicsMatrix(GraphicsObject): """ TransformDistance(self, dx, dy) --> (dx, dy) - applies the matrix except for translations + Applies this matrix to a distance (ie. performs all transforms except + translations) """ return _gdi_.GraphicsMatrix_TransformDistance(*args, **kwargs) @@ -5224,7 +5304,10 @@ class GraphicsMatrix(GraphicsObject): """ GetNativeMatrix(self) -> void - returns the native representation + Returns the native representation of the matrix. For CoreGraphics this + is a CFAffineMatrix pointer. For GDIPlus a Matrix Pointer and for + Cairo a cairo_matrix_t pointer. NOTE: For wxPython we still need a + way to make this value usable. """ return _gdi_.GraphicsMatrix_GetNativeMatrix(*args, **kwargs) @@ -5244,7 +5327,7 @@ class GraphicsPath(GraphicsObject): MoveToPoint(self, Double x, Double y) MoveToPoint(self, Point2D p) - Begins a new subpath at (x,y) + Begins a new subpath at the specified point. """ return _gdi_.GraphicsPath_MoveToPoint(*args) @@ -5253,7 +5336,7 @@ class GraphicsPath(GraphicsObject): AddLineToPoint(self, Double x, Double y) AddLineToPoint(self, Point2D p) - Adds a straight line from the current point to (x,y) + Adds a straight line from the current point to the specified point. """ return _gdi_.GraphicsPath_AddLineToPoint(*args) @@ -5272,7 +5355,7 @@ class GraphicsPath(GraphicsObject): """ AddPath(self, GraphicsPath path) - adds another path + Adds another path """ return _gdi_.GraphicsPath_AddPath(*args, **kwargs) @@ -5280,7 +5363,7 @@ class GraphicsPath(GraphicsObject): """ CloseSubpath(self) - closes the current sub-path + Closes the current sub-path. """ return _gdi_.GraphicsPath_CloseSubpath(*args, **kwargs) @@ -5295,9 +5378,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 @@ -5317,7 +5400,7 @@ class GraphicsPath(GraphicsObject): """ AddRectangle(self, Double x, Double y, Double w, Double h) - Appends a rectangle as a new closed subpath + Appends a rectangle as a new closed subpath. """ return _gdi_.GraphicsPath_AddRectangle(*args, **kwargs) @@ -5325,7 +5408,7 @@ class GraphicsPath(GraphicsObject): """ AddCircle(self, Double x, Double y, Double r) - Appends a circle as a new closed subpath with the given radius. + Appends a circle around (x,y) with radius r as a new closed subpath. """ return _gdi_.GraphicsPath_AddCircle(*args, **kwargs) @@ -5333,8 +5416,8 @@ class GraphicsPath(GraphicsObject): """ AddArcToPoint(self, Double x1, Double y1, Double x2, Double y2, Double r) - Draws a 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) @@ -5342,7 +5425,7 @@ class GraphicsPath(GraphicsObject): """ AddEllipse(self, Double x, Double y, Double w, Double h) - appends an ellipse + Appends an ellipse fitting into the passed in rectangle. """ return _gdi_.GraphicsPath_AddEllipse(*args, **kwargs) @@ -5350,7 +5433,7 @@ class GraphicsPath(GraphicsObject): """ AddRoundedRectangle(self, Double x, Double y, Double w, Double h, Double radius) - appends a rounded rectangle + Appends a rounded rectangle. """ return _gdi_.GraphicsPath_AddRoundedRectangle(*args, **kwargs) @@ -5358,7 +5441,9 @@ class GraphicsPath(GraphicsObject): """ GetNativePath(self) -> void - returns the native path + Returns the native path (CGPathRef for Core Graphics, Path pointer for + GDIPlus and a cairo_path_t pointer for cairo). NOTE: For wxPython we + still need a way to make this value usable. """ return _gdi_.GraphicsPath_GetNativePath(*args, **kwargs) @@ -5366,8 +5451,9 @@ class GraphicsPath(GraphicsObject): """ UnGetNativePath(self, void p) - give the native path returned by GetNativePath() back (there might be some - deallocations necessary) + Gives back the native path returned by GetNativePath() because there + might be some deallocations necessary (eg on cairo the native path + returned by GetNativePath is newly allocated each time). """ return _gdi_.GraphicsPath_UnGetNativePath(*args, **kwargs) @@ -5375,29 +5461,38 @@ class GraphicsPath(GraphicsObject): """ Transform(self, GraphicsMatrix matrix) - transforms each point of this path by the matrix + Transforms each point of this path by the matrix """ return _gdi_.GraphicsPath_Transform(*args, **kwargs) 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. """ return _gdi_.GraphicsPath_Contains(*args) _gdi_.GraphicsPath_swigregister(GraphicsPath) class GraphicsContext(GraphicsObject): - """Proxy of C++ GraphicsContext class""" + """ + A `wx.GraphicsContext` instance is the object that is drawn upon. It is + created by a renderer using the CreateContext calls, this can be done + either directly using a renderer instance, or indirectly using the + static convenience CreateXXX functions of wx.GraphicsContext that + always delegate the task to the default renderer. + """ 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 @@ -5407,19 +5502,42 @@ class GraphicsContext(GraphicsObject): """ Create(WindowDC dc) -> GraphicsContext Create(Window window) -> GraphicsContext + + Creates a wx.GraphicsContext either from a window or a DC. """ val = _gdi_.GraphicsContext_Create(*args) val.__dc = args[0] # save a ref so the dc will not be deleted before self return val Create = staticmethod(Create) + def CreateMeasuringContext(*args): + """ + CreateMeasuringContext() -> GraphicsContext + + Create a lightwieght context that can be used for measuring text only. + """ + val = _gdi_.GraphicsContext_CreateMeasuringContext(*args) + val.__dc = args[0] # save a ref so the dc will not be deleted before self + return val + + CreateMeasuringContext = staticmethod(CreateMeasuringContext) def CreateFromNative(*args, **kwargs): - """CreateFromNative(void context) -> 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. + """ return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs) CreateFromNative = staticmethod(CreateFromNative) def CreateFromNativeWindow(*args, **kwargs): - """CreateFromNativeWindow(void window) -> GraphicsContext""" + """ + CreateFromNativeWindow(void window) -> GraphicsContext + + Creates a wx.GraphicsContext from a native window. + """ return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) CreateFromNativeWindow = staticmethod(CreateFromNativeWindow) @@ -5427,16 +5545,24 @@ class GraphicsContext(GraphicsObject): """ CreatePath(self) -> GraphicsPath - creates a path instance that corresponds to the type of graphics context, ie GDIPlus, Cairo, CoreGraphics ... + Creates a native graphics path which is initially empty. """ return _gdi_.GraphicsContext_CreatePath(*args, **kwargs) def CreatePen(*args, **kwargs): - """CreatePen(self, Pen pen) -> GraphicsPen""" + """ + CreatePen(self, Pen pen) -> GraphicsPen + + Creates a native pen from a `wx.Pen`. + """ return _gdi_.GraphicsContext_CreatePen(*args, **kwargs) def CreateBrush(*args, **kwargs): - """CreateBrush(self, Brush brush) -> GraphicsBrush""" + """ + CreateBrush(self, Brush brush) -> GraphicsBrush + + Creates a native brush from a `wx.Brush`. + """ return _gdi_.GraphicsContext_CreateBrush(*args, **kwargs) def CreateLinearGradientBrush(*args, **kwargs): @@ -5444,8 +5570,8 @@ class GraphicsContext(GraphicsObject): CreateLinearGradientBrush(self, Double x1, Double y1, Double x2, Double y2, Colour c1, Colour c2) -> GraphicsBrush - sets the brush to a linear gradient, starting at (x1,y1) with color c1 - to (x2,y2) with color c2 + Creates a native brush, having a linear gradient, starting at (x1,y1) + with color c1 to (x2,y2) with color c2. """ return _gdi_.GraphicsContext_CreateLinearGradientBrush(*args, **kwargs) @@ -5454,10 +5580,9 @@ class GraphicsContext(GraphicsObject): CreateRadialGradientBrush(self, Double xo, Double yo, Double xc, Double yc, Double radius, Colour oColor, Colour cColor) -> GraphicsBrush - sets the brush to a radial gradient originating at (xo,yc) with color - oColor and ends on a circle around (xc,yc) with radius r and color - cColor - + 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) @@ -5465,7 +5590,7 @@ class GraphicsContext(GraphicsObject): """ CreateFont(self, Font font, Colour col=*wxBLACK) -> GraphicsFont - sets the font + Creates a native graphics font from a `wx.Font` and a text colour. """ return _gdi_.GraphicsContext_CreateFont(*args, **kwargs) @@ -5474,7 +5599,8 @@ class GraphicsContext(GraphicsObject): CreateMatrix(self, Double a=1.0, Double b=0.0, Double c=0.0, Double d=1.0, Double tx=0.0, Double ty=0.0) -> GraphicsMatrix - create a 'native' matrix corresponding to these values + Creates a native affine transformation matrix from the passed in + values. The defaults result in an identity matrix. """ return _gdi_.GraphicsContext_CreateMatrix(*args, **kwargs) @@ -5482,7 +5608,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) @@ -5490,7 +5617,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) @@ -5498,7 +5625,7 @@ class GraphicsContext(GraphicsObject): """ ClipRegion(self, Region region) - clips drawings to the region + Clips drawings to the region, combined to current clipping region. """ return _gdi_.GraphicsContext_ClipRegion(*args, **kwargs) @@ -5506,7 +5633,7 @@ class GraphicsContext(GraphicsObject): """ Clip(self, Double x, Double y, Double w, Double h) - clips drawings to the rect + Clips drawings to the rectangle. """ return _gdi_.GraphicsContext_Clip(*args, **kwargs) @@ -5514,7 +5641,7 @@ class GraphicsContext(GraphicsObject): """ ResetClip(self) - resets the clipping to original extent + Resets the clipping to original shape. """ return _gdi_.GraphicsContext_ResetClip(*args, **kwargs) @@ -5522,15 +5649,32 @@ class GraphicsContext(GraphicsObject): """ GetNativeContext(self) -> void - returns the native context + Returns the native context (CGContextRef for Core Graphics, Graphics + pointer for GDIPlus and cairo_t pointer for cairo). """ 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) - translate the current transformation matrix CTM of the context + Translates the current transformation matrix. """ return _gdi_.GraphicsContext_Translate(*args, **kwargs) @@ -5538,7 +5682,7 @@ class GraphicsContext(GraphicsObject): """ Scale(self, Double xScale, Double yScale) - scale the current transformation matrix CTM of the context + Scale the current transformation matrix of the context. """ return _gdi_.GraphicsContext_Scale(*args, **kwargs) @@ -5546,7 +5690,8 @@ class GraphicsContext(GraphicsObject): """ Rotate(self, Double angle) - rotate (radians) the current transformation matrix CTM of the context + Rotate the current transformation matrix of the context. ``angle`` is + specified in radians. """ return _gdi_.GraphicsContext_Rotate(*args, **kwargs) @@ -5554,7 +5699,8 @@ class GraphicsContext(GraphicsObject): """ ConcatTransform(self, GraphicsMatrix matrix) - concatenates this transform with the current transform of this context + Concatenates the passed in transform with the current transform of + this context. """ return _gdi_.GraphicsContext_ConcatTransform(*args, **kwargs) @@ -5562,7 +5708,7 @@ class GraphicsContext(GraphicsObject): """ SetTransform(self, GraphicsMatrix matrix) - sets the transform of this context + Sets the current transform of this context. """ return _gdi_.GraphicsContext_SetTransform(*args, **kwargs) @@ -5570,7 +5716,7 @@ class GraphicsContext(GraphicsObject): """ GetTransform(self) -> GraphicsMatrix - gets the matrix of this context + Gets the current transformation matrix of this context. """ return _gdi_.GraphicsContext_GetTransform(*args, **kwargs) @@ -5579,7 +5725,7 @@ class GraphicsContext(GraphicsObject): SetPen(self, GraphicsPen pen) SetPen(self, Pen pen) - sets the stroke pen + Sets the stroke pen """ return _gdi_.GraphicsContext_SetPen(*args) @@ -5588,7 +5734,7 @@ class GraphicsContext(GraphicsObject): SetBrush(self, GraphicsBrush brush) SetBrush(self, Brush brush) - sets the brush for filling + Sets the brush for filling """ return _gdi_.GraphicsContext_SetBrush(*args) @@ -5597,7 +5743,7 @@ class GraphicsContext(GraphicsObject): SetFont(self, GraphicsFont font) SetFont(self, Font font, Colour colour=*wxBLACK) - sets the font + Sets the font """ return _gdi_.GraphicsContext_SetFont(*args) @@ -5605,7 +5751,7 @@ class GraphicsContext(GraphicsObject): """ StrokePath(self, GraphicsPath path) - strokes along a path with the current pen + Strokes along a path with the current pen. """ return _gdi_.GraphicsContext_StrokePath(*args, **kwargs) @@ -5613,7 +5759,7 @@ class GraphicsContext(GraphicsObject): """ FillPath(self, GraphicsPath path, int fillStyle=ODDEVEN_RULE) - fills a path with the current brush + Fills a path with the current brush. """ return _gdi_.GraphicsContext_FillPath(*args, **kwargs) @@ -5621,43 +5767,81 @@ class GraphicsContext(GraphicsObject): """ DrawPath(self, GraphicsPath path, int fillStyle=ODDEVEN_RULE) - draws a path by first filling and then stroking + Draws the path by first filling and then stroking. """ return _gdi_.GraphicsContext_DrawPath(*args, **kwargs) def DrawText(*args, **kwargs): - """DrawText(self, String str, Double x, Double y)""" + """ + DrawText(self, String str, Double x, Double y, GraphicsBrush backgroundBrush=NullGraphicsBrush) + + Draws a text string at the defined position. + """ return _gdi_.GraphicsContext_DrawText(*args, **kwargs) def DrawRotatedText(*args, **kwargs): - """DrawRotatedText(self, String str, Double x, Double y, Double angle)""" + """ + DrawRotatedText(self, String str, Double x, Double y, Double angle, GraphicsBrush backgroundBrush=NullGraphicsBrush) + + Draws a text string at the defined position, at the specified angle, + which is given in radians. + """ return _gdi_.GraphicsContext_DrawRotatedText(*args, **kwargs) def GetFullTextExtent(*args, **kwargs): - """GetFullTextExtent(self, text) --> (width, height, descent, externalLeading)""" + """ + GetFullTextExtent(self, text) --> (width, height, descent, externalLeading) + + Gets the dimensions of the string using the currently selected + font. ``text`` is the string to measure, ``w`` and ``h`` are the total + width and height respectively, ``descent`` is the dimension from the + baseline of the font to the bottom of the descender, and + ``externalLeading`` is any extra vertical space added to the font by + the font designer (usually is zero). + """ return _gdi_.GraphicsContext_GetFullTextExtent(*args, **kwargs) def GetTextExtent(*args, **kwargs): - """GetTextExtent(self, text) --> (width, height)""" + """ + GetTextExtent(self, text) --> (width, height) + + Gets the dimensions of the string using the currently selected + font. ``text`` is the string to measure, ``w`` and ``h`` are the total + width and height respectively. + """ return _gdi_.GraphicsContext_GetTextExtent(*args, **kwargs) def GetPartialTextExtents(*args, **kwargs): - """GetPartialTextExtents(self, text) -> [widths]""" + """ + GetPartialTextExtents(self, text) -> [widths] + + Returns a list of widths from the beginning of ``text`` to the + coresponding character in ``text``. + """ return _gdi_.GraphicsContext_GetPartialTextExtents(*args, **kwargs) def DrawBitmap(*args, **kwargs): - """DrawBitmap(self, Bitmap bmp, Double x, Double y, Double w, Double h)""" + """ + DrawBitmap(self, Bitmap bmp, Double x, Double y, Double w, Double h) + + Draws the bitmap. In case of a mono bitmap, this is treated as a mask + and the current brush is used for filling. + """ return _gdi_.GraphicsContext_DrawBitmap(*args, **kwargs) def DrawIcon(*args, **kwargs): - """DrawIcon(self, Icon icon, Double x, Double y, Double w, Double h)""" + """ + DrawIcon(self, Icon icon, Double x, Double y, Double w, Double h) + + Draws the icon. + """ return _gdi_.GraphicsContext_DrawIcon(*args, **kwargs) def StrokeLine(*args, **kwargs): """ StrokeLine(self, Double x1, Double y1, Double x2, Double y2) - strokes a single line + Strokes a single line. """ return _gdi_.GraphicsContext_StrokeLine(*args, **kwargs) @@ -5665,7 +5849,7 @@ class GraphicsContext(GraphicsObject): """ StrokeLines(self, List points) - stroke lines connecting each of the points + Stroke lines connecting each of the points """ return _gdi_.GraphicsContext_StrokeLines(*args, **kwargs) @@ -5673,7 +5857,7 @@ class GraphicsContext(GraphicsObject): """ StrokeLineSegements(self, PyObject beginPoints, PyObject endPoints) - stroke disconnected lines from begin to end points + Stroke disconnected lines from begin to end points """ return _gdi_.GraphicsContext_StrokeLineSegements(*args, **kwargs) @@ -5681,7 +5865,7 @@ class GraphicsContext(GraphicsObject): """ DrawLines(self, size_t points, int fillStyle=ODDEVEN_RULE) - draws a polygon + Draws a polygon. """ return _gdi_.GraphicsContext_DrawLines(*args, **kwargs) @@ -5689,7 +5873,7 @@ class GraphicsContext(GraphicsObject): """ DrawRectangle(self, Double x, Double y, Double w, Double h) - draws a rectangle + Draws a rectangle. """ return _gdi_.GraphicsContext_DrawRectangle(*args, **kwargs) @@ -5697,7 +5881,7 @@ class GraphicsContext(GraphicsObject): """ DrawEllipse(self, Double x, Double y, Double w, Double h) - draws an ellipse + Draws an ellipse. """ return _gdi_.GraphicsContext_DrawEllipse(*args, **kwargs) @@ -5705,7 +5889,7 @@ class GraphicsContext(GraphicsObject): """ DrawRoundedRectangle(self, Double x, Double y, Double w, Double h, Double radius) - draws a rounded rectangle + Draws a rounded rectangle """ return _gdi_.GraphicsContext_DrawRoundedRectangle(*args, **kwargs) @@ -5729,17 +5913,39 @@ def GraphicsContext_Create(*args): """ Create(WindowDC dc) -> GraphicsContext GraphicsContext_Create(Window window) -> GraphicsContext + + Creates a wx.GraphicsContext either from a window or a DC. """ val = _gdi_.GraphicsContext_Create(*args) val.__dc = args[0] # save a ref so the dc will not be deleted before self return val +def GraphicsContext_CreateMeasuringContext(*args): + """ + GraphicsContext_CreateMeasuringContext() -> GraphicsContext + + Create a lightwieght context that can be used for measuring text only. + """ + val = _gdi_.GraphicsContext_CreateMeasuringContext(*args) + val.__dc = args[0] # save a ref so the dc will not be deleted before self + return val + def GraphicsContext_CreateFromNative(*args, **kwargs): - """GraphicsContext_CreateFromNative(void context) -> GraphicsContext""" + """ + 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. + """ return _gdi_.GraphicsContext_CreateFromNative(*args, **kwargs) def GraphicsContext_CreateFromNativeWindow(*args, **kwargs): - """GraphicsContext_CreateFromNativeWindow(void window) -> GraphicsContext""" + """ + GraphicsContext_CreateFromNativeWindow(void window) -> GraphicsContext + + Creates a wx.GraphicsContext from a native window. + """ return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) class GraphicsRenderer(_core.Object): @@ -5761,6 +5967,10 @@ class GraphicsRenderer(_core.Object): """ return _gdi_.GraphicsRenderer_CreateContext(*args) + def CreateMeasuringContext(*args, **kwargs): + """CreateMeasuringContext(self) -> GraphicsContext""" + return _gdi_.GraphicsRenderer_CreateMeasuringContext(*args, **kwargs) + def CreateContextFromNativeContext(*args, **kwargs): """CreateContextFromNativeContext(self, void context) -> GraphicsContext""" return _gdi_.GraphicsRenderer_CreateContextFromNativeContext(*args, **kwargs) @@ -5816,9 +6026,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 @@ -6487,17 +6700,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`. @@ -6816,7 +7029,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).