X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/66c033b4a6ee95a2392b7f3c5a629256b661c456..30e24d9dd5a5abf1c9a375ea259eb239b122b7f7:/wxPython/src/gtk/_gdi.py?ds=sidebyside diff --git a/wxPython/src/gtk/_gdi.py b/wxPython/src/gtk/_gdi.py index 633fe02561..50e075fb63 100644 --- a/wxPython/src/gtk/_gdi.py +++ b/wxPython/src/gtk/_gdi.py @@ -1,88 +1,122 @@ -# This file was created automatically by SWIG. +# This file was created automatically by SWIG 1.3.29. # Don't modify this file, modify the SWIG interface instead. import _gdi_ +import new +new_instancemethod = new.instancemethod +def _swig_setattr_nondynamic(self,class_type,name,value,static=1): + if (name == "thisown"): return self.this.own(value) + if (name == "this"): + if type(value).__name__ == 'PySwigObject': + self.__dict__[name] = value + return + method = class_type.__swig_setmethods__.get(name,None) + if method: return method(self,value) + if (not static) or hasattr(self,name): + self.__dict__[name] = value + else: + raise AttributeError("You cannot add attributes to %s" % self) + +def _swig_setattr(self,class_type,name,value): + return _swig_setattr_nondynamic(self,class_type,name,value,0) + +def _swig_getattr(self,class_type,name): + if (name == "thisown"): return self.this.own() + method = class_type.__swig_getmethods__.get(name,None) + if method: return method(self) + raise AttributeError,name + +def _swig_repr(self): + try: strthis = "proxy of " + self.this.__repr__() + except: strthis = "" + return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,) + +import types +try: + _object = types.ObjectType + _newclass = 1 +except AttributeError: + class _object : pass + _newclass = 0 +del types + + +def _swig_setattr_nondynamic_method(set): + def set_attr(self,name,value): + if (name == "thisown"): return self.this.own(value) + if hasattr(self,name) or (name == "this"): + set(self,name,value) + else: + raise AttributeError("You cannot add attributes to %s" % self) + return set_attr + import _core wx = _core #--------------------------------------------------------------------------- class GDIObject(_core.Object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxGDIObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ GDIObject 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) -> GDIObject""" - newobj = _gdi_.new_GDIObject(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_GDIObject): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - - def GetVisible(*args, **kwargs): - """GetVisible(self) -> bool""" - return _gdi_.GDIObject_GetVisible(*args, **kwargs) - - def SetVisible(*args, **kwargs): - """SetVisible(self, bool visible)""" - return _gdi_.GDIObject_SetVisible(*args, **kwargs) - + _gdi_.GDIObject_swiginit(self,_gdi_.new_GDIObject(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_GDIObject + __del__ = lambda self : None; def IsNull(*args, **kwargs): """IsNull(self) -> bool""" return _gdi_.GDIObject_IsNull(*args, **kwargs) - -class GDIObjectPtr(GDIObject): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = GDIObject -_gdi_.GDIObject_swigregister(GDIObjectPtr) +_gdi_.GDIObject_swigregister(GDIObject) #--------------------------------------------------------------------------- +C2S_NAME = _gdi_.C2S_NAME +C2S_CSS_SYNTAX = _gdi_.C2S_CSS_SYNTAX +C2S_HTML_SYNTAX = _gdi_.C2S_HTML_SYNTAX +ALPHA_TRANSPARENT = _gdi_.ALPHA_TRANSPARENT +ALPHA_OPAQUE = _gdi_.ALPHA_OPAQUE class Colour(_core.Object): """ - A colour is an object representing a combination of Red, Green, and Blue (RGB) - intensity values, and is used to determine drawing colours, window colours, - etc. Valid RGB values are in the range 0 to 255. + A colour is an object representing a combination of Red, Green, and + Blue (RGB) intensity values, and is used to determine drawing colours, + window colours, etc. Valid RGB values are in the range 0 to 255. - In wxPython there are typemaps that will automatically convert from a colour - name, or from a '#RRGGBB' colour hex value string to a wx.Colour object when - calling C++ methods that expect a wxColour. This means that the following are - all equivallent: + In wxPython there are typemaps that will automatically convert from a + colour name, from a '#RRGGBB' colour hex value string, or from a 3 + integer tuple to a wx.Colour object when calling C++ methods that + expect a wxColour. This means that the following are all + equivallent:: win.SetBackgroundColour(wxColour(0,0,255)) win.SetBackgroundColour('BLUE') win.SetBackgroundColour('#0000FF') + win.SetBackgroundColour((0,0,255)) + + Additional colour names and their coresponding values can be added + using `wx.ColourDatabase`. Various system colours (as set in the + user's system preferences) can be retrieved with + `wx.SystemSettings.GetColour`. - You can retrieve the various current system colour settings with - wx.SystemSettings.GetColour. """ - def __repr__(self): - return "<%s.%s; proxy of C++ wxColour instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + 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, unsigned char red=0, unsigned char green=0, unsigned char blue=0) -> Colour + __init__(self, byte red=0, byte green=0, byte blue=0, byte alpha=ALPHA_OPAQUE) -> Colour Constructs a colour from red, green and blue values. - """ - newobj = _gdi_.new_Colour(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Colour): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass + :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`. + + """ + _gdi_.Colour_swiginit(self,_gdi_.new_Colour(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Colour + __del__ = lambda self : None; def Red(*args, **kwargs): """ - Red(self) -> unsigned char + Red(self) -> byte Returns the red intensity. """ @@ -90,7 +124,7 @@ class Colour(_core.Object): def Green(*args, **kwargs): """ - Green(self) -> unsigned char + Green(self) -> byte Returns the green intensity. """ @@ -98,24 +132,33 @@ class Colour(_core.Object): def Blue(*args, **kwargs): """ - Blue(self) -> unsigned char + Blue(self) -> byte Returns the blue intensity. """ return _gdi_.Colour_Blue(*args, **kwargs) - def Ok(*args, **kwargs): + def Alpha(*args, **kwargs): """ - Ok(self) -> bool + Alpha(self) -> byte + + Returns the Alpha value. + """ + return _gdi_.Colour_Alpha(*args, **kwargs) + + def IsOk(*args, **kwargs): + """ + IsOk(self) -> bool Returns True if the colour object is valid (the colour has been initialised with RGB values). """ - return _gdi_.Colour_Ok(*args, **kwargs) + return _gdi_.Colour_IsOk(*args, **kwargs) + Ok = IsOk def Set(*args, **kwargs): """ - Set(self, unsigned char red, unsigned char green, unsigned char blue) + Set(self, byte red, byte green, byte blue, byte alpha=ALPHA_OPAQUE) Sets the RGB intensity values. """ @@ -133,33 +176,48 @@ class Colour(_core.Object): """ SetFromName(self, String colourName) - Sets the RGB intensity values using a colour name listed in wx.TheColourDatabase. + Sets the RGB intensity values using a colour name listed in + ``wx.TheColourDatabase``. """ return _gdi_.Colour_SetFromName(*args, **kwargs) + def GetAsString(*args, **kwargs): + """ + GetAsString(self, long flags=wxC2S_NAME|wxC2S_CSS_SYNTAX) -> String + + Return the colour as a string. Acceptable flags are: + + =================== ================================== + wx.C2S_NAME return colour name, when possible + wx.C2S_CSS_SYNTAX return colour in rgb(r,g,b) syntax + wx.C2S_HTML_SYNTAX return colour in #rrggbb syntax + =================== ================================== + """ + return _gdi_.Colour_GetAsString(*args, **kwargs) + def GetPixel(*args, **kwargs): """ GetPixel(self) -> long Returns a pixel value which is platform-dependent. On Windows, a - COLORREF is returned. On X, an allocated pixel value is returned. - -1 is returned if the pixel is invalid (on X, unallocated). + COLORREF is returned. On X, an allocated pixel value is returned. -1 + is returned if the pixel is invalid (on X, unallocated). """ return _gdi_.Colour_GetPixel(*args, **kwargs) def __eq__(*args, **kwargs): """ - __eq__(self, Colour colour) -> bool + __eq__(self, PyObject other) -> bool - Compare colours for equality + Compare colours for equality. """ return _gdi_.Colour___eq__(*args, **kwargs) def __ne__(*args, **kwargs): """ - __ne__(self, Colour colour) -> bool + __ne__(self, PyObject other) -> bool - Compare colours for inequality + Compare colours for inequality. """ return _gdi_.Colour___ne__(*args, **kwargs) @@ -179,29 +237,27 @@ class Colour(_core.Object): """ return _gdi_.Colour_GetRGB(*args, **kwargs) - asTuple = Get - def __str__(self): return str(self.asTuple()) - def __repr__(self): return 'wx.Colour' + str(self.asTuple()) - def __nonzero__(self): return self.Ok() + asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") + def __str__(self): return str(self.Get(True)) + def __repr__(self): return 'wx.Colour' + str(self.Get(True)) + def __len__(self): return len(self.Get()) + def __getitem__(self, index): return self.Get()[index] + def __nonzero__(self): return self.IsOk() __safe_for_unpickling__ = True - def __reduce__(self): return (Colour, self.Get()) + def __reduce__(self): return (Colour, self.Get(True)) - -class ColourPtr(Colour): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Colour -_gdi_.Colour_swigregister(ColourPtr) + Pixel = property(GetPixel,doc="See `GetPixel`") + RGB = property(GetRGB,SetRGB,doc="See `GetRGB` and `SetRGB`") +_gdi_.Colour_swigregister(Colour) def NamedColour(*args, **kwargs): """ NamedColour(String colorName) -> Colour - Constructs a colour object using a colour name listed in wx.TheColourDatabase. + Constructs a colour object using a colour name listed in + ``wx.TheColourDatabase``. """ val = _gdi_.new_NamedColour(*args, **kwargs) - val.thisown = 1 return val def ColourRGB(*args, **kwargs): @@ -211,7 +267,6 @@ def ColourRGB(*args, **kwargs): Constructs a colour from a packed RGB value. """ val = _gdi_.new_ColourRGB(*args, **kwargs) - val.thisown = 1 return val Color = Colour @@ -219,58 +274,46 @@ NamedColor = NamedColour ColorRGB = ColourRGB class Palette(GDIObject): - def __repr__(self): - return "<%s.%s; proxy of C++ wxPalette instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ Palette 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, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette""" - newobj = _gdi_.new_Palette(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Palette): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.Palette_swiginit(self,_gdi_.new_Palette(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Palette + __del__ = lambda self : None; def GetPixel(*args, **kwargs): """GetPixel(self, byte red, byte green, byte blue) -> int""" return _gdi_.Palette_GetPixel(*args, **kwargs) def GetRGB(*args, **kwargs): - """GetRGB(int pixel) -> (R,G,B)""" + """GetRGB(self, int pixel) -> (R,G,B)""" return _gdi_.Palette_GetRGB(*args, **kwargs) - def Ok(*args, **kwargs): - """Ok(self) -> bool""" - return _gdi_.Palette_Ok(*args, **kwargs) + def GetColoursCount(*args, **kwargs): + """GetColoursCount(self) -> int""" + return _gdi_.Palette_GetColoursCount(*args, **kwargs) - def __nonzero__(self): return self.Ok() + def IsOk(*args, **kwargs): + """IsOk(self) -> bool""" + return _gdi_.Palette_IsOk(*args, **kwargs) -class PalettePtr(Palette): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Palette -_gdi_.Palette_swigregister(PalettePtr) + Ok = IsOk + def __nonzero__(self): return self.IsOk() + ColoursCount = property(GetColoursCount,doc="See `GetColoursCount`") +_gdi_.Palette_swigregister(Palette) #--------------------------------------------------------------------------- class Pen(GDIObject): - def __repr__(self): - return "<%s.%s; proxy of C++ wxPen instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ Pen 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, Colour colour, int width=1, int style=SOLID) -> Pen""" - newobj = _gdi_.new_Pen(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Pen): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.Pen_swiginit(self,_gdi_.new_Pen(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Pen + __del__ = lambda self : None; def GetCap(*args, **kwargs): """GetCap(self) -> int""" return _gdi_.Pen_GetCap(*args, **kwargs) @@ -291,10 +334,11 @@ class Pen(GDIObject): """GetWidth(self) -> int""" return _gdi_.Pen_GetWidth(*args, **kwargs) - def Ok(*args, **kwargs): - """Ok(self) -> bool""" - return _gdi_.Pen_Ok(*args, **kwargs) + def IsOk(*args, **kwargs): + """IsOk(self) -> bool""" + return _gdi_.Pen_IsOk(*args, **kwargs) + Ok = IsOk def SetCap(*args, **kwargs): """SetCap(self, int cap_style)""" return _gdi_.Pen_SetCap(*args, **kwargs) @@ -316,7 +360,7 @@ class Pen(GDIObject): return _gdi_.Pen_SetWidth(*args, **kwargs) def SetDashes(*args, **kwargs): - """SetDashes(self, int dashes, wxDash dashes_array)""" + """SetDashes(self, int dashes)""" return _gdi_.Pen_SetDashes(*args, **kwargs) def GetDashes(*args, **kwargs): @@ -337,6 +381,7 @@ class Pen(GDIObject): """GetDashCount(self) -> int""" return _gdi_.Pen_GetDashCount(*args, **kwargs) + DashCount = property(GetDashCount,doc="See `GetDashCount`") def __eq__(*args, **kwargs): """__eq__(self, Pen other) -> bool""" return _gdi_.Pen___eq__(*args, **kwargs) @@ -345,14 +390,14 @@ class Pen(GDIObject): """__ne__(self, Pen other) -> bool""" return _gdi_.Pen___ne__(*args, **kwargs) - def __nonzero__(self): return self.Ok() - -class PenPtr(Pen): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Pen -_gdi_.Pen_swigregister(PenPtr) + def __nonzero__(self): return self.IsOk() + Cap = property(GetCap,SetCap,doc="See `GetCap` and `SetCap`") + Colour = property(GetColour,SetColour,doc="See `GetColour` and `SetColour`") + Dashes = property(GetDashes,SetDashes,doc="See `GetDashes` and `SetDashes`") + Join = property(GetJoin,SetJoin,doc="See `GetJoin` and `SetJoin`") + Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`") + Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`") +_gdi_.Pen_swigregister(Pen) #--------------------------------------------------------------------------- @@ -361,54 +406,18 @@ class Brush(GDIObject): A brush is a drawing tool for filling in areas. It is used for painting the background of rectangles, ellipses, etc. when drawing on a `wx.DC`. It has a colour and a style. - - :warning: Do not create instances of wx.Brush before the `wx.App` - object has been created because, depending on the platform, - required internal data structures may not have been initialized - yet. Instead create your brushes in the app's OnInit or as they - are needed for drawing. - - :note: On monochrome displays all brushes are white, unless the colour - really is black. - - :see: `wx.BrushList`, `wx.DC`, `wx.DC.SetBrush` - """ - def __repr__(self): - return "<%s.%s; proxy of C++ wxBrush instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + 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, Colour colour, int style=SOLID) -> Brush - Constructs a brush from a `wx.Colour` object and a style. The style - parameter may be one of the following: - - =================== ============================= - Style Meaning - =================== ============================= - wx.TRANSPARENT Transparent (no fill). - wx.SOLID Solid. - wx.STIPPLE Uses a bitmap as a stipple. - wx.BDIAGONAL_HATCH Backward diagonal hatch. - wx.CROSSDIAG_HATCH Cross-diagonal hatch. - wx.FDIAGONAL_HATCH Forward diagonal hatch. - wx.CROSS_HATCH Cross hatch. - wx.HORIZONTAL_HATCH Horizontal hatch. - wx.VERTICAL_HATCH Vertical hatch. - =================== ============================= - - - """ - newobj = _gdi_.new_Brush(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Brush): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + Constructs a brush from a `wx.Colour` object and a style. + """ + _gdi_.Brush_swiginit(self,_gdi_.new_Brush(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Brush + __del__ = lambda self : None; def SetColour(*args, **kwargs): """ SetColour(self, Colour col) @@ -460,22 +469,37 @@ class Brush(GDIObject): """ return _gdi_.Brush_GetStipple(*args, **kwargs) - def Ok(*args, **kwargs): + def IsHatch(*args, **kwargs): + """ + IsHatch(self) -> bool + + Is the current style a hatch type? """ - Ok(self) -> bool + return _gdi_.Brush_IsHatch(*args, **kwargs) + + def IsOk(*args, **kwargs): + """ + IsOk(self) -> bool Returns True if the brush is initialised and valid. """ - return _gdi_.Brush_Ok(*args, **kwargs) + return _gdi_.Brush_IsOk(*args, **kwargs) + + Ok = IsOk + def __nonzero__(self): return self.IsOk() + Colour = property(GetColour,SetColour,doc="See `GetColour` and `SetColour`") + Stipple = property(GetStipple,SetStipple,doc="See `GetStipple` and `SetStipple`") + Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`") +_gdi_.Brush_swigregister(Brush) - def __nonzero__(self): return self.Ok() +def BrushFromBitmap(*args, **kwargs): + """ + BrushFromBitmap(Bitmap stippleBitmap) -> Brush -class BrushPtr(Brush): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Brush -_gdi_.Brush_swigregister(BrushPtr) + Constructs a stippled brush using a bitmap. + """ + val = _gdi_.new_BrushFromBitmap(*args, **kwargs) + return val class Bitmap(GDIObject): """ @@ -485,69 +509,23 @@ class Bitmap(GDIObject): device context (instance of `wx.MemoryDC`). This enables the bitmap to be copied to a window or memory device context using `wx.DC.Blit`, or to be used as a drawing surface. - - The BMP and XMP image file formats are supported on all platforms by - wx.Bitmap. Other formats are automatically loaded by `wx.Image` and - converted to a wx.Bitmap, so any image file format supported by - `wx.Image` can be used. - - :todo: Add wrappers and support for raw bitmap data access. Can this - be be put into Python without losing the speed benefits of the - teplates and iterators in rawbmp.h? - - :todo: Find a way to do very efficient PIL Image <--> wx.Bitmap - converstions. - """ - def __repr__(self): - return "<%s.%s; proxy of C++ wxBitmap instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + 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, String name, int type=BITMAP_TYPE_ANY) -> Bitmap Loads a bitmap from a file. + """ + _gdi_.Bitmap_swiginit(self,_gdi_.new_Bitmap(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Bitmap + __del__ = lambda self : None; + def IsOk(*args, **kwargs): + """IsOk(self) -> bool""" + return _gdi_.Bitmap_IsOk(*args, **kwargs) - :param name: Name of the file to load the bitmap from. - :param type: The type of image to expect. Can be one of the following - constants (assuming that the neccessary `wx.Image` handlers are - loaded): - - * wx.BITMAP_TYPE_ANY - * wx.BITMAP_TYPE_BMP - * wx.BITMAP_TYPE_ICO - * wx.BITMAP_TYPE_CUR - * wx.BITMAP_TYPE_XBM - * wx.BITMAP_TYPE_XPM - * wx.BITMAP_TYPE_TIF - * wx.BITMAP_TYPE_GIF - * wx.BITMAP_TYPE_PNG - * wx.BITMAP_TYPE_JPEG - * wx.BITMAP_TYPE_PNM - * wx.BITMAP_TYPE_PCX - * wx.BITMAP_TYPE_PICT - * wx.BITMAP_TYPE_ICON - * wx.BITMAP_TYPE_ANI - * wx.BITMAP_TYPE_IFF - - :see: Alternate constructors `wx.EmptyBitmap`, `wx.BitmapFromIcon`, - `wx.BitmapFromImage`, `wx.BitmapFromXPMData`, - `wx.BitmapFromBits` - - """ - newobj = _gdi_.new_Bitmap(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Bitmap): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - - def Ok(*args, **kwargs): - """Ok(self) -> bool""" - return _gdi_.Bitmap_Ok(*args, **kwargs) - + Ok = IsOk def GetWidth(*args, **kwargs): """ GetWidth(self) -> int @@ -650,6 +628,10 @@ class Bitmap(GDIObject): """ return _gdi_.Bitmap_LoadFile(*args, **kwargs) + def GetPalette(*args, **kwargs): + """GetPalette(self) -> Palette""" + return _gdi_.Bitmap_GetPalette(*args, **kwargs) + def CopyFromIcon(*args, **kwargs): """CopyFromIcon(self, Icon icon) -> bool""" return _gdi_.Bitmap_CopyFromIcon(*args, **kwargs) @@ -686,7 +668,25 @@ class Bitmap(GDIObject): """ return _gdi_.Bitmap_SetSize(*args, **kwargs) - def __nonzero__(self): return self.Ok() + def CopyFromBuffer(*args, **kwargs): + """ + CopyFromBuffer(self, buffer data) + + Copy data from a RGB buffer object to replace the bitmap pixel data. + See `wxBitmapFromBuffer` for more . + """ + return _gdi_.Bitmap_CopyFromBuffer(*args, **kwargs) + + def CopyFromBufferRGBA(*args, **kwargs): + """ + CopyFromBufferRGBA(self, buffer data) + + Copy data from a RGBA buffer object to replace the bitmap pixel data. + See `wxBitmapFromBufferRGBA` for more . + """ + return _gdi_.Bitmap_CopyFromBufferRGBA(*args, **kwargs) + + def __nonzero__(self): return self.IsOk() def __eq__(*args, **kwargs): """__eq__(self, Bitmap other) -> bool""" return _gdi_.Bitmap___eq__(*args, **kwargs) @@ -695,13 +695,14 @@ class Bitmap(GDIObject): """__ne__(self, Bitmap other) -> bool""" return _gdi_.Bitmap___ne__(*args, **kwargs) - -class BitmapPtr(Bitmap): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Bitmap -_gdi_.Bitmap_swigregister(BitmapPtr) + Depth = property(GetDepth,SetDepth,doc="See `GetDepth` and `SetDepth`") + Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`") + Mask = property(GetMask,SetMask,doc="See `GetMask` and `SetMask`") + Palette = property(GetPalette,doc="See `GetPalette`") + Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`") + SubBitmap = property(GetSubBitmap,doc="See `GetSubBitmap`") + Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`") +_gdi_.Bitmap_swigregister(Bitmap) def EmptyBitmap(*args, **kwargs): """ @@ -709,10 +710,9 @@ def EmptyBitmap(*args, **kwargs): Creates a new bitmap of the given size. A depth of -1 indicates the depth of the current screen or visual. Some platforms only support 1 - for monochrome and -1 for the current colour setting. + for monochrome and -1 for the current display depth. """ val = _gdi_.new_EmptyBitmap(*args, **kwargs) - val.thisown = 1 return val def BitmapFromIcon(*args, **kwargs): @@ -722,7 +722,6 @@ def BitmapFromIcon(*args, **kwargs): Create a new bitmap from a `wx.Icon` object. """ val = _gdi_.new_BitmapFromIcon(*args, **kwargs) - val.thisown = 1 return val def BitmapFromImage(*args, **kwargs): @@ -736,7 +735,6 @@ def BitmapFromImage(*args, **kwargs): that a colour reduction may have to take place. """ val = _gdi_.new_BitmapFromImage(*args, **kwargs) - val.thisown = 1 return val def BitmapFromXPMData(*args, **kwargs): @@ -746,7 +744,6 @@ def BitmapFromXPMData(*args, **kwargs): Construct a Bitmap from a list of strings formatted as XPM data. """ val = _gdi_.new_BitmapFromXPMData(*args, **kwargs) - val.thisown = 1 return val def BitmapFromBits(*args, **kwargs): @@ -759,9 +756,333 @@ def BitmapFromBits(*args, **kwargs): bit depths, the behaviour is platform dependent. """ val = _gdi_.new_BitmapFromBits(*args, **kwargs) - val.thisown = 1 return val + +def _BitmapFromBufferAlpha(*args, **kwargs): + """_BitmapFromBufferAlpha(int width, int height, buffer data, buffer alpha) -> Bitmap""" + return _gdi_._BitmapFromBufferAlpha(*args, **kwargs) + +def _BitmapFromBuffer(*args, **kwargs): + """_BitmapFromBuffer(int width, int height, buffer data) -> Bitmap""" + return _gdi_._BitmapFromBuffer(*args, **kwargs) +def BitmapFromBuffer(width, height, dataBuffer, alphaBuffer=None): + """ + Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer + parameter must be a Python object that implements the buffer + interface, such as a string, array, etc. The dataBuffer object is + expected to contain a series of RGB bytes and be width*height*3 + bytes long. A buffer object can optionally be supplied for the + image's alpha channel data, and it is expected to be width*height + bytes long. On Windows the RGB values are 'premultiplied' by the + alpha values. (The other platforms do the multiplication + themselves.) + + Unlike `wx.ImageFromBuffer` the bitmap created with this function + does not share the memory buffer with the buffer object. This is + because the native pixel buffer format varies on different + platforms, and so instead an efficient as possible copy of the + data is made from the buffer objects to the bitmap's native pixel + buffer. For direct access to a bitmap's pixel buffer see + `wx.NativePixelData` and `wx.AlphaPixelData`. + + :see: `wx.Bitmap`, `wx.BitmapFromBufferRGBA`, `wx.NativePixelData`, + `wx.AlphaPixelData`, `wx.ImageFromBuffer` + """ + if alphaBuffer is not None: + return _gdi_._BitmapFromBufferAlpha(width, height, dataBuffer, alphaBuffer) + else: + return _gdi_._BitmapFromBuffer(width, height, dataBuffer) + + +def _BitmapFromBufferRGBA(*args, **kwargs): + """_BitmapFromBufferRGBA(int width, int height, buffer data) -> Bitmap""" + return _gdi_._BitmapFromBufferRGBA(*args, **kwargs) +def BitmapFromBufferRGBA(width, height, dataBuffer): + """ + Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer + parameter must be a Python object that implements the buffer + interface, such as a string, array, etc. The dataBuffer object is + expected to contain a series of RGBA bytes (red, green, blue and + alpha) and be width*height*4 bytes long. On Windows the RGB + values are 'premultiplied' by the alpha values. (The other + platforms do the multiplication themselves.) + + Unlike `wx.ImageFromBuffer` the bitmap created with this function + does not share the memory buffer with the buffer object. This is + because the native pixel buffer format varies on different + platforms, and so instead an efficient as possible copy of the + data is made from the buffer object to the bitmap's native pixel + buffer. For direct access to a bitmap's pixel buffer see + `wx.NativePixelData` and `wx.AlphaPixelData`. + + :see: `wx.Bitmap`, `wx.BitmapFromBuffer`, `wx.NativePixelData`, + `wx.AlphaPixelData`, `wx.ImageFromBuffer` + """ + return _gdi_._BitmapFromBufferRGBA(width, height, dataBuffer) + +class PixelDataBase(object): + """Proxy of C++ PixelDataBase 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 GetOrigin(*args, **kwargs): + """GetOrigin(self) -> Point""" + return _gdi_.PixelDataBase_GetOrigin(*args, **kwargs) + + def GetWidth(*args, **kwargs): + """GetWidth(self) -> int""" + return _gdi_.PixelDataBase_GetWidth(*args, **kwargs) + + def GetHeight(*args, **kwargs): + """GetHeight(self) -> int""" + return _gdi_.PixelDataBase_GetHeight(*args, **kwargs) + + def GetSize(*args, **kwargs): + """GetSize(self) -> Size""" + return _gdi_.PixelDataBase_GetSize(*args, **kwargs) + + def GetRowStride(*args, **kwargs): + """GetRowStride(self) -> int""" + return _gdi_.PixelDataBase_GetRowStride(*args, **kwargs) + + Height = property(GetHeight,doc="See `GetHeight`") + Origin = property(GetOrigin,doc="See `GetOrigin`") + RowStride = property(GetRowStride,doc="See `GetRowStride`") + Size = property(GetSize,doc="See `GetSize`") + Width = property(GetWidth,doc="See `GetWidth`") +_gdi_.PixelDataBase_swigregister(PixelDataBase) + +class NativePixelData(PixelDataBase): + """Proxy of C++ NativePixelData 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): + """ + __init__(self, Bitmap bmp) -> NativePixelData + __init__(self, Bitmap bmp, Rect rect) -> NativePixelData + __init__(self, Bitmap bmp, Point pt, Size sz) -> NativePixelData + """ + _gdi_.NativePixelData_swiginit(self,_gdi_.new_NativePixelData(*args)) + __swig_destroy__ = _gdi_.delete_NativePixelData + __del__ = lambda self : None; + def GetPixels(*args, **kwargs): + """GetPixels(self) -> NativePixelData_Accessor""" + return _gdi_.NativePixelData_GetPixels(*args, **kwargs) + + def UseAlpha(*args, **kwargs): + """UseAlpha(self)""" + return _gdi_.NativePixelData_UseAlpha(*args, **kwargs) + + def __nonzero__(*args, **kwargs): + """__nonzero__(self) -> bool""" + return _gdi_.NativePixelData___nonzero__(*args, **kwargs) + + def __iter__(self): + """ + Create and return an iterator object for this pixel data + object. (It's really a generator but I won't tell if you + don't tell.) + """ + width = self.GetWidth() + height = self.GetHeight() + pixels = self.GetPixels() + + + + + class PixelFacade(object): + def Get(self): + return pixels.Get() + def Set(self, *args, **kw): + return pixels.Set(*args, **kw) + def __str__(self): + return str(self.Get()) + def __repr__(self): + return 'pixel(%d,%d): %s' % (x,y,self.Get()) + X = property(lambda self: x) + Y = property(lambda self: y) + + pf = PixelFacade() + for y in xrange(height): + for x in xrange(width): + + + + yield pf + pixels.nextPixel() + pixels.MoveTo(self, 0, y) + + Pixels = property(GetPixels,doc="See `GetPixels`") +_gdi_.NativePixelData_swigregister(NativePixelData) + +class NativePixelData_Accessor(object): + """Proxy of C++ NativePixelData_Accessor 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): + """ + __init__(self, NativePixelData data) -> NativePixelData_Accessor + __init__(self, Bitmap bmp, NativePixelData data) -> NativePixelData_Accessor + __init__(self) -> NativePixelData_Accessor + """ + _gdi_.NativePixelData_Accessor_swiginit(self,_gdi_.new_NativePixelData_Accessor(*args)) + __swig_destroy__ = _gdi_.delete_NativePixelData_Accessor + __del__ = lambda self : None; + def Reset(*args, **kwargs): + """Reset(self, NativePixelData data)""" + return _gdi_.NativePixelData_Accessor_Reset(*args, **kwargs) + + def IsOk(*args, **kwargs): + """IsOk(self) -> bool""" + return _gdi_.NativePixelData_Accessor_IsOk(*args, **kwargs) + + def nextPixel(*args, **kwargs): + """nextPixel(self)""" + return _gdi_.NativePixelData_Accessor_nextPixel(*args, **kwargs) + + def Offset(*args, **kwargs): + """Offset(self, NativePixelData data, int x, int y)""" + return _gdi_.NativePixelData_Accessor_Offset(*args, **kwargs) + + def OffsetX(*args, **kwargs): + """OffsetX(self, NativePixelData data, int x)""" + return _gdi_.NativePixelData_Accessor_OffsetX(*args, **kwargs) + + def OffsetY(*args, **kwargs): + """OffsetY(self, NativePixelData data, int y)""" + return _gdi_.NativePixelData_Accessor_OffsetY(*args, **kwargs) + + def MoveTo(*args, **kwargs): + """MoveTo(self, NativePixelData data, int x, int y)""" + return _gdi_.NativePixelData_Accessor_MoveTo(*args, **kwargs) + + def Set(*args, **kwargs): + """Set(self, byte red, byte green, byte blue)""" + return _gdi_.NativePixelData_Accessor_Set(*args, **kwargs) + + def Get(*args, **kwargs): + """Get(self) -> PyObject""" + return _gdi_.NativePixelData_Accessor_Get(*args, **kwargs) + +_gdi_.NativePixelData_Accessor_swigregister(NativePixelData_Accessor) + +class AlphaPixelData(PixelDataBase): + """Proxy of C++ AlphaPixelData 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): + """ + __init__(self, Bitmap bmp) -> AlphaPixelData + __init__(self, Bitmap bmp, Rect rect) -> AlphaPixelData + __init__(self, Bitmap bmp, Point pt, Size sz) -> AlphaPixelData + """ + _gdi_.AlphaPixelData_swiginit(self,_gdi_.new_AlphaPixelData(*args)) + self.UseAlpha() + + __swig_destroy__ = _gdi_.delete_AlphaPixelData + __del__ = lambda self : None; + def GetPixels(*args, **kwargs): + """GetPixels(self) -> AlphaPixelData_Accessor""" + return _gdi_.AlphaPixelData_GetPixels(*args, **kwargs) + + def UseAlpha(*args, **kwargs): + """UseAlpha(self)""" + return _gdi_.AlphaPixelData_UseAlpha(*args, **kwargs) + + def __nonzero__(*args, **kwargs): + """__nonzero__(self) -> bool""" + return _gdi_.AlphaPixelData___nonzero__(*args, **kwargs) + + def __iter__(self): + """ + Create and return an iterator object for this pixel data + object. (It's really a generator but I won't tell if you + don't tell.) + """ + width = self.GetWidth() + height = self.GetHeight() + pixels = self.GetPixels() + + + + + class PixelFacade(object): + def Get(self): + return pixels.Get() + def Set(self, *args, **kw): + return pixels.Set(*args, **kw) + def __str__(self): + return str(self.Get()) + def __repr__(self): + return 'pixel(%d,%d): %s' % (x,y,self.Get()) + X = property(lambda self: x) + Y = property(lambda self: y) + + pf = PixelFacade() + for y in xrange(height): + for x in xrange(width): + + + + yield pf + pixels.nextPixel() + pixels.MoveTo(self, 0, y) + + Pixels = property(GetPixels,doc="See `GetPixels`") +_gdi_.AlphaPixelData_swigregister(AlphaPixelData) + +class AlphaPixelData_Accessor(object): + """Proxy of C++ AlphaPixelData_Accessor 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): + """ + __init__(self, AlphaPixelData data) -> AlphaPixelData_Accessor + __init__(self, Bitmap bmp, AlphaPixelData data) -> AlphaPixelData_Accessor + __init__(self) -> AlphaPixelData_Accessor + """ + _gdi_.AlphaPixelData_Accessor_swiginit(self,_gdi_.new_AlphaPixelData_Accessor(*args)) + __swig_destroy__ = _gdi_.delete_AlphaPixelData_Accessor + __del__ = lambda self : None; + def Reset(*args, **kwargs): + """Reset(self, AlphaPixelData data)""" + return _gdi_.AlphaPixelData_Accessor_Reset(*args, **kwargs) + + def IsOk(*args, **kwargs): + """IsOk(self) -> bool""" + return _gdi_.AlphaPixelData_Accessor_IsOk(*args, **kwargs) + + def nextPixel(*args, **kwargs): + """nextPixel(self)""" + return _gdi_.AlphaPixelData_Accessor_nextPixel(*args, **kwargs) + + def Offset(*args, **kwargs): + """Offset(self, AlphaPixelData data, int x, int y)""" + return _gdi_.AlphaPixelData_Accessor_Offset(*args, **kwargs) + + def OffsetX(*args, **kwargs): + """OffsetX(self, AlphaPixelData data, int x)""" + return _gdi_.AlphaPixelData_Accessor_OffsetX(*args, **kwargs) + + def OffsetY(*args, **kwargs): + """OffsetY(self, AlphaPixelData data, int y)""" + return _gdi_.AlphaPixelData_Accessor_OffsetY(*args, **kwargs) + + def MoveTo(*args, **kwargs): + """MoveTo(self, AlphaPixelData data, int x, int y)""" + return _gdi_.AlphaPixelData_Accessor_MoveTo(*args, **kwargs) + + def Set(*args, **kwargs): + """Set(self, byte red, byte green, byte blue, byte alpha)""" + return _gdi_.AlphaPixelData_Accessor_Set(*args, **kwargs) + + def Get(*args, **kwargs): + """Get(self) -> PyObject""" + return _gdi_.AlphaPixelData_Accessor_Get(*args, **kwargs) + +_gdi_.AlphaPixelData_Accessor_swigregister(AlphaPixelData_Accessor) + class Mask(_core.Object): """ This class encapsulates a monochrome mask bitmap, where the masked @@ -773,11 +1094,10 @@ class Mask(_core.Object): `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a mask. - """ - def __repr__(self): - return "<%s.%s; proxy of C++ wxMask instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + 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, Colour colour=NullColour) -> Mask @@ -789,42 +1109,30 @@ class Mask(_core.Object): :see: `wx.Bitmap`, `wx.Colour` """ - newobj = _gdi_.new_Mask(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - -class MaskPtr(Mask): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Mask -_gdi_.Mask_swigregister(MaskPtr) + _gdi_.Mask_swiginit(self,_gdi_.new_Mask(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Mask + __del__ = lambda self : None; +_gdi_.Mask_swigregister(Mask) MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.") class Icon(GDIObject): - def __repr__(self): - return "<%s.%s; proxy of C++ wxIcon instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ Icon 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, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon""" - newobj = _gdi_.new_Icon(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Icon): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.Icon_swiginit(self,_gdi_.new_Icon(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Icon + __del__ = lambda self : None; def LoadFile(*args, **kwargs): """LoadFile(self, String name, int type) -> bool""" return _gdi_.Icon_LoadFile(*args, **kwargs) - def Ok(*args, **kwargs): - """Ok(self) -> bool""" - return _gdi_.Icon_Ok(*args, **kwargs) + def IsOk(*args, **kwargs): + """IsOk(self) -> bool""" + return _gdi_.Icon_IsOk(*args, **kwargs) + Ok = IsOk def GetWidth(*args, **kwargs): """GetWidth(self) -> int""" return _gdi_.Icon_GetWidth(*args, **kwargs) @@ -853,59 +1161,46 @@ class Icon(GDIObject): """CopyFromBitmap(self, Bitmap bmp)""" return _gdi_.Icon_CopyFromBitmap(*args, **kwargs) - def __nonzero__(self): return self.Ok() - -class IconPtr(Icon): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Icon -_gdi_.Icon_swigregister(IconPtr) + def __nonzero__(self): return self.IsOk() + Depth = property(GetDepth,SetDepth,doc="See `GetDepth` and `SetDepth`") + Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`") + Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`") +_gdi_.Icon_swigregister(Icon) def EmptyIcon(*args, **kwargs): """EmptyIcon() -> Icon""" val = _gdi_.new_EmptyIcon(*args, **kwargs) - val.thisown = 1 return val def IconFromLocation(*args, **kwargs): """IconFromLocation(IconLocation loc) -> Icon""" val = _gdi_.new_IconFromLocation(*args, **kwargs) - val.thisown = 1 return val def IconFromBitmap(*args, **kwargs): """IconFromBitmap(Bitmap bmp) -> Icon""" val = _gdi_.new_IconFromBitmap(*args, **kwargs) - val.thisown = 1 return val def IconFromXPMData(*args, **kwargs): """IconFromXPMData(PyObject listOfStrings) -> Icon""" val = _gdi_.new_IconFromXPMData(*args, **kwargs) - val.thisown = 1 return val class IconLocation(object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxIconLocation instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ IconLocation 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, String filename=&wxPyEmptyString, int num=0) -> IconLocation""" - newobj = _gdi_.new_IconLocation(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_IconLocation): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.IconLocation_swiginit(self,_gdi_.new_IconLocation(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_IconLocation + __del__ = lambda self : None; def IsOk(*args, **kwargs): """IsOk(self) -> bool""" return _gdi_.IconLocation_IsOk(*args, **kwargs) - def __nonzero__(self): return self.Ok() + def __nonzero__(self): return self.IsOk() def SetFileName(*args, **kwargs): """SetFileName(self, String filename)""" return _gdi_.IconLocation_SetFileName(*args, **kwargs) @@ -922,29 +1217,19 @@ class IconLocation(object): """GetIndex(self) -> int""" return _gdi_.IconLocation_GetIndex(*args, **kwargs) - -class IconLocationPtr(IconLocation): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = IconLocation -_gdi_.IconLocation_swigregister(IconLocationPtr) + FileName = property(GetFileName,SetFileName,doc="See `GetFileName` and `SetFileName`") + Index = property(GetIndex,SetIndex,doc="See `GetIndex` and `SetIndex`") +_gdi_.IconLocation_swigregister(IconLocation) class IconBundle(object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxIconBundle instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ IconBundle 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) -> IconBundle""" - newobj = _gdi_.new_IconBundle(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_IconBundle): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.IconBundle_swiginit(self,_gdi_.new_IconBundle(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_IconBundle + __del__ = lambda self : None; def AddIcon(*args, **kwargs): """AddIcon(self, Icon icon)""" return _gdi_.IconBundle_AddIcon(*args, **kwargs) @@ -957,103 +1242,70 @@ class IconBundle(object): """GetIcon(self, Size size) -> Icon""" return _gdi_.IconBundle_GetIcon(*args, **kwargs) - -class IconBundlePtr(IconBundle): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = IconBundle -_gdi_.IconBundle_swigregister(IconBundlePtr) + Icon = property(GetIcon,doc="See `GetIcon`") +_gdi_.IconBundle_swigregister(IconBundle) def IconBundleFromFile(*args, **kwargs): """IconBundleFromFile(String file, long type) -> IconBundle""" val = _gdi_.new_IconBundleFromFile(*args, **kwargs) - val.thisown = 1 return val def IconBundleFromIcon(*args, **kwargs): """IconBundleFromIcon(Icon icon) -> IconBundle""" val = _gdi_.new_IconBundleFromIcon(*args, **kwargs) - val.thisown = 1 return val class Cursor(GDIObject): """ - A cursor is a small bitmap usually used for denoting where the - mouse pointer is, with a picture that might indicate the - interpretation of a mouse click. + A cursor is a small bitmap usually used for denoting where the mouse + pointer is, with a picture that might indicate the interpretation of a + mouse click. A single cursor object may be used in many windows (any subwindow - type). The wxWindows convention is to set the cursor for a - window, as in X, rather than to set it globally as in MS Windows, - although a global wx.SetCursor function is also available for use - on MS Windows. + type). The wxWindows convention is to set the cursor for a window, as + in X, rather than to set it globally as in MS Windows, although a + global `wx.SetCursor` function is also available for use on MS Windows. + """ - def __repr__(self): - return "<%s.%s; proxy of C++ wxCursor instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + 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, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor Construct a Cursor from a file. Specify the type of file using - wx.BITAMP_TYPE* constants, and specify the hotspot if not using a - .cur file. - - This cursor is not available on wxGTK, use wx.StockCursor, - wx.CursorFromImage, or wx.CursorFromBits instead. - """ - newobj = _gdi_.new_Cursor(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Cursor): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - - def Ok(*args, **kwargs): - """Ok(self) -> bool""" - return _gdi_.Cursor_Ok(*args, **kwargs) - - def __nonzero__(self): return self.Ok() - -class CursorPtr(Cursor): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Cursor -_gdi_.Cursor_swigregister(CursorPtr) + wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur + file. + """ + _gdi_.Cursor_swiginit(self,_gdi_.new_Cursor(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Cursor + __del__ = lambda self : None; + def IsOk(*args, **kwargs): + """IsOk(self) -> bool""" + return _gdi_.Cursor_IsOk(*args, **kwargs) + + Ok = IsOk + def __nonzero__(self): return self.IsOk() +_gdi_.Cursor_swigregister(Cursor) def StockCursor(*args, **kwargs): """ StockCursor(int id) -> Cursor - Create a cursor using one of the stock cursors. Note that not - all cursors are available on all platforms. + Create a cursor using one of the stock cursors. Note that not all + stock cursors are available on all platforms. """ val = _gdi_.new_StockCursor(*args, **kwargs) - val.thisown = 1 return val def CursorFromImage(*args, **kwargs): """ CursorFromImage(Image image) -> Cursor - Constructs a cursor from a wxImage. The cursor is monochrome, - colors with the RGB elements all greater than 127 will be - foreground, colors less than this background. The mask (if any) - will be used as transparent. - - In MSW the foreground will be white and the background black. The - cursor is resized to 32x32 In GTK, the two most frequent colors - will be used for foreground and background. The cursor will be - displayed at the size of the image. On MacOS the cursor is - resized to 16x16 and currently only shown as black/white (mask - respected). + Constructs a cursor from a `wx.Image`. The mask (if any) will be used + for setting the transparent portions of the cursor. """ val = _gdi_.new_CursorFromImage(*args, **kwargs) - val.thisown = 1 return val #--------------------------------------------------------------------------- @@ -1062,20 +1314,14 @@ OutRegion = _gdi_.OutRegion PartRegion = _gdi_.PartRegion InRegion = _gdi_.InRegion class Region(GDIObject): - def __repr__(self): - return "<%s.%s; proxy of C++ wxRegion instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ Region 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, int x=0, int y=0, int width=0, int height=0) -> Region""" - newobj = _gdi_.new_Region(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Region): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.Region_swiginit(self,_gdi_.new_Region(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Region + __del__ = lambda self : None; def Clear(*args, **kwargs): """Clear(self)""" return _gdi_.Region_Clear(*args, **kwargs) @@ -1120,6 +1366,10 @@ class Region(GDIObject): """IsEmpty(self) -> bool""" return _gdi_.Region_IsEmpty(*args, **kwargs) + def IsEqual(*args, **kwargs): + """IsEqual(self, Region region) -> bool""" + return _gdi_.Region_IsEqual(*args, **kwargs) + def Union(*args, **kwargs): """Union(self, int x, int y, int width, int height) -> bool""" return _gdi_.Region_Union(*args, **kwargs) @@ -1161,44 +1411,40 @@ class Region(GDIObject): return _gdi_.Region_ConvertToBitmap(*args, **kwargs) def UnionBitmap(*args, **kwargs): - """UnionBitmap(self, Bitmap bmp, Colour transColour=NullColour, int tolerance=0) -> bool""" + """UnionBitmap(self, Bitmap bmp) -> bool""" return _gdi_.Region_UnionBitmap(*args, **kwargs) + def UnionBitmapColour(*args, **kwargs): + """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool""" + return _gdi_.Region_UnionBitmapColour(*args, **kwargs) -class RegionPtr(Region): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Region -_gdi_.Region_swigregister(RegionPtr) + Box = property(GetBox,doc="See `GetBox`") +_gdi_.Region_swigregister(Region) def RegionFromBitmap(*args, **kwargs): - """RegionFromBitmap(Bitmap bmp, Colour transColour=NullColour, int tolerance=0) -> Region""" + """RegionFromBitmap(Bitmap bmp) -> Region""" val = _gdi_.new_RegionFromBitmap(*args, **kwargs) - val.thisown = 1 + return val + +def RegionFromBitmapColour(*args, **kwargs): + """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region""" + val = _gdi_.new_RegionFromBitmapColour(*args, **kwargs) return val def RegionFromPoints(*args, **kwargs): - """RegionFromPoints(int points, Point points_array, int fillStyle=WINDING_RULE) -> Region""" + """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region""" val = _gdi_.new_RegionFromPoints(*args, **kwargs) - val.thisown = 1 return val class RegionIterator(_core.Object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxRegionIterator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ RegionIterator 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, Region region) -> RegionIterator""" - newobj = _gdi_.new_RegionIterator(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_RegionIterator): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.RegionIterator_swiginit(self,_gdi_.new_RegionIterator(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_RegionIterator + __del__ = lambda self : None; def GetX(*args, **kwargs): """GetX(self) -> int""" return _gdi_.RegionIterator_GetX(*args, **kwargs) @@ -1243,13 +1489,14 @@ class RegionIterator(_core.Object): """__nonzero__(self) -> bool""" return _gdi_.RegionIterator___nonzero__(*args, **kwargs) - -class RegionIteratorPtr(RegionIterator): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = RegionIterator -_gdi_.RegionIterator_swigregister(RegionIteratorPtr) + H = property(GetH,doc="See `GetH`") + Height = property(GetHeight,doc="See `GetHeight`") + Rect = property(GetRect,doc="See `GetRect`") + W = property(GetW,doc="See `GetW`") + Width = property(GetWidth,doc="See `GetWidth`") + X = property(GetX,doc="See `GetX`") + Y = property(GetY,doc="See `GetY`") +_gdi_.RegionIterator_swigregister(RegionIterator) #--------------------------------------------------------------------------- @@ -1380,20 +1627,14 @@ FONTENCODING_SHIFT_JIS = _gdi_.FONTENCODING_SHIFT_JIS #--------------------------------------------------------------------------- class NativeFontInfo(object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxNativeFontInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ NativeFontInfo 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) -> NativeFontInfo""" - newobj = _gdi_.new_NativeFontInfo(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_NativeFontInfo): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.NativeFontInfo_swiginit(self,_gdi_.new_NativeFontInfo(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_NativeFontInfo + __del__ = lambda self : None; def Init(*args, **kwargs): """Init(self)""" return _gdi_.NativeFontInfo_Init(*args, **kwargs) @@ -1447,7 +1688,7 @@ class NativeFontInfo(object): return _gdi_.NativeFontInfo_SetUnderlined(*args, **kwargs) def SetFaceName(*args, **kwargs): - """SetFaceName(self, String facename)""" + """SetFaceName(self, String facename) -> bool""" return _gdi_.NativeFontInfo_SetFaceName(*args, **kwargs) def SetFamily(*args, **kwargs): @@ -1478,31 +1719,26 @@ class NativeFontInfo(object): """ToUserString(self) -> String""" return _gdi_.NativeFontInfo_ToUserString(*args, **kwargs) - -class NativeFontInfoPtr(NativeFontInfo): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = NativeFontInfo -_gdi_.NativeFontInfo_swigregister(NativeFontInfoPtr) + Encoding = property(GetEncoding,SetEncoding,doc="See `GetEncoding` and `SetEncoding`") + FaceName = property(GetFaceName,SetFaceName,doc="See `GetFaceName` and `SetFaceName`") + Family = property(GetFamily,SetFamily,doc="See `GetFamily` and `SetFamily`") + PointSize = property(GetPointSize,SetPointSize,doc="See `GetPointSize` and `SetPointSize`") + Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`") + Underlined = property(GetUnderlined,SetUnderlined,doc="See `GetUnderlined` and `SetUnderlined`") + Weight = property(GetWeight,SetWeight,doc="See `GetWeight` and `SetWeight`") +_gdi_.NativeFontInfo_swigregister(NativeFontInfo) class NativeEncodingInfo(object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxNativeEncodingInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) + """Proxy of C++ NativeEncodingInfo class""" + thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') + __repr__ = _swig_repr facename = property(_gdi_.NativeEncodingInfo_facename_get, _gdi_.NativeEncodingInfo_facename_set) encoding = property(_gdi_.NativeEncodingInfo_encoding_get, _gdi_.NativeEncodingInfo_encoding_set) - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs): """__init__(self) -> NativeEncodingInfo""" - newobj = _gdi_.new_NativeEncodingInfo(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_NativeEncodingInfo): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.NativeEncodingInfo_swiginit(self,_gdi_.new_NativeEncodingInfo(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_NativeEncodingInfo + __del__ = lambda self : None; def FromString(*args, **kwargs): """FromString(self, String s) -> bool""" return _gdi_.NativeEncodingInfo_FromString(*args, **kwargs) @@ -1511,39 +1747,27 @@ class NativeEncodingInfo(object): """ToString(self) -> String""" return _gdi_.NativeEncodingInfo_ToString(*args, **kwargs) - -class NativeEncodingInfoPtr(NativeEncodingInfo): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = NativeEncodingInfo -_gdi_.NativeEncodingInfo_swigregister(NativeEncodingInfoPtr) +_gdi_.NativeEncodingInfo_swigregister(NativeEncodingInfo) def GetNativeFontEncoding(*args, **kwargs): - """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo""" - return _gdi_.GetNativeFontEncoding(*args, **kwargs) + """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo""" + return _gdi_.GetNativeFontEncoding(*args, **kwargs) def TestFontEncoding(*args, **kwargs): - """TestFontEncoding(NativeEncodingInfo info) -> bool""" - return _gdi_.TestFontEncoding(*args, **kwargs) + """TestFontEncoding(NativeEncodingInfo info) -> bool""" + return _gdi_.TestFontEncoding(*args, **kwargs) #--------------------------------------------------------------------------- class FontMapper(object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxFontMapper instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ FontMapper 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) -> FontMapper""" - newobj = _gdi_.new_FontMapper(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_FontMapper): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.FontMapper_swiginit(self,_gdi_.new_FontMapper(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_FontMapper + __del__ = lambda self : None; def Get(*args, **kwargs): """Get() -> FontMapper""" return _gdi_.FontMapper_Get(*args, **kwargs) @@ -1583,10 +1807,6 @@ class FontMapper(object): return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs) GetEncodingFromName = staticmethod(GetEncodingFromName) - def SetConfig(*args, **kwargs): - """SetConfig(self, ConfigBase config)""" - return _gdi_.FontMapper_SetConfig(*args, **kwargs) - def SetConfigPath(*args, **kwargs): """SetConfigPath(self, String prefix)""" return _gdi_.FontMapper_SetConfigPath(*args, **kwargs) @@ -1612,72 +1832,102 @@ class FontMapper(object): """SetDialogTitle(self, String title)""" return _gdi_.FontMapper_SetDialogTitle(*args, **kwargs) + AltForEncoding = property(GetAltForEncoding,doc="See `GetAltForEncoding`") +_gdi_.FontMapper_swigregister(FontMapper) -class FontMapperPtr(FontMapper): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = FontMapper -_gdi_.FontMapper_swigregister(FontMapperPtr) - -def FontMapper_Get(*args, **kwargs): - """FontMapper_Get() -> FontMapper""" - return _gdi_.FontMapper_Get(*args, **kwargs) +def FontMapper_Get(*args): + """FontMapper_Get() -> FontMapper""" + return _gdi_.FontMapper_Get(*args) def FontMapper_Set(*args, **kwargs): - """FontMapper_Set(FontMapper mapper) -> FontMapper""" - return _gdi_.FontMapper_Set(*args, **kwargs) + """FontMapper_Set(FontMapper mapper) -> FontMapper""" + return _gdi_.FontMapper_Set(*args, **kwargs) -def FontMapper_GetSupportedEncodingsCount(*args, **kwargs): - """FontMapper_GetSupportedEncodingsCount() -> size_t""" - return _gdi_.FontMapper_GetSupportedEncodingsCount(*args, **kwargs) +def FontMapper_GetSupportedEncodingsCount(*args): + """FontMapper_GetSupportedEncodingsCount() -> size_t""" + return _gdi_.FontMapper_GetSupportedEncodingsCount(*args) def FontMapper_GetEncoding(*args, **kwargs): - """FontMapper_GetEncoding(size_t n) -> int""" - return _gdi_.FontMapper_GetEncoding(*args, **kwargs) + """FontMapper_GetEncoding(size_t n) -> int""" + return _gdi_.FontMapper_GetEncoding(*args, **kwargs) def FontMapper_GetEncodingName(*args, **kwargs): - """FontMapper_GetEncodingName(int encoding) -> String""" - return _gdi_.FontMapper_GetEncodingName(*args, **kwargs) + """FontMapper_GetEncodingName(int encoding) -> String""" + return _gdi_.FontMapper_GetEncodingName(*args, **kwargs) def FontMapper_GetEncodingDescription(*args, **kwargs): - """FontMapper_GetEncodingDescription(int encoding) -> String""" - return _gdi_.FontMapper_GetEncodingDescription(*args, **kwargs) + """FontMapper_GetEncodingDescription(int encoding) -> String""" + return _gdi_.FontMapper_GetEncodingDescription(*args, **kwargs) def FontMapper_GetEncodingFromName(*args, **kwargs): - """FontMapper_GetEncodingFromName(String name) -> int""" - return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs) + """FontMapper_GetEncodingFromName(String name) -> int""" + return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs) -def FontMapper_GetDefaultConfigPath(*args, **kwargs): - """FontMapper_GetDefaultConfigPath() -> String""" - return _gdi_.FontMapper_GetDefaultConfigPath(*args, **kwargs) +def FontMapper_GetDefaultConfigPath(*args): + """FontMapper_GetDefaultConfigPath() -> String""" + return _gdi_.FontMapper_GetDefaultConfigPath(*args) #--------------------------------------------------------------------------- class Font(GDIObject): - def __repr__(self): - return "<%s.%s; proxy of C++ wxFont instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """ + A font is an object which determines the appearance of text. Fonts are + used for drawing text to a device context, and setting the appearance + of a window's text. + + You can retrieve the current system font settings with `wx.SystemSettings`. + """ + 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, int pointSize, int family, int style, int weight, bool underline=False, String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font + + Creates a font object with the specified attributes. + + :param pointSize: The size of the font in points. + + :param family: Font family. A generic way of referring to fonts + without specifying actual facename. It can be One of + the ``wx.FONTFAMILY_xxx`` constants. + + :param style: One of the ``wx.FONTSTYLE_xxx`` constants. + + :param weight: Font weight, sometimes also referred to as font + boldness. One of the ``wx.FONTWEIGHT_xxx`` constants. + + :param underline: The value can be ``True`` or ``False`` and + indicates whether the font will include an underline. This + may not be supported on all platforms. + + :param face: An optional string specifying the actual typeface to + be used. If it is an empty string, a default typeface will be + chosen based on the family. + + :param encoding: An encoding which may be one of the + ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't + available, no font is created. + + :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`, + `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo` + + """ + if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName'] + _gdi_.Font_swiginit(self,_gdi_.new_Font(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Font + __del__ = lambda self : None; + def IsOk(*args, **kwargs): + """ + IsOk(self) -> bool + + Returns ``True`` if this font was successfully created. """ - newobj = _gdi_.new_Font(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Font): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - - def Ok(*args, **kwargs): - """Ok(self) -> bool""" - return _gdi_.Font_Ok(*args, **kwargs) - - def __nonzero__(self): return self.Ok() + return _gdi_.Font_IsOk(*args, **kwargs) + + Ok = IsOk + def __nonzero__(self): return self.IsOk() def __eq__(*args, **kwargs): """__eq__(self, Font other) -> bool""" return _gdi_.Font___eq__(*args, **kwargs) @@ -1687,99 +1937,234 @@ class Font(GDIObject): return _gdi_.Font___ne__(*args, **kwargs) def GetPointSize(*args, **kwargs): - """GetPointSize(self) -> int""" + """ + GetPointSize(self) -> int + + Gets the point size. + """ return _gdi_.Font_GetPointSize(*args, **kwargs) + def GetPixelSize(*args, **kwargs): + """ + GetPixelSize(self) -> Size + + Returns the size in pixels if the font was constructed with a pixel + size. + """ + return _gdi_.Font_GetPixelSize(*args, **kwargs) + + def IsUsingSizeInPixels(*args, **kwargs): + """ + IsUsingSizeInPixels(self) -> bool + + Returns ``True`` if the font is using a pixelSize. + """ + return _gdi_.Font_IsUsingSizeInPixels(*args, **kwargs) + def GetFamily(*args, **kwargs): - """GetFamily(self) -> int""" + """ + GetFamily(self) -> int + + Gets the font family. + """ return _gdi_.Font_GetFamily(*args, **kwargs) def GetStyle(*args, **kwargs): - """GetStyle(self) -> int""" + """ + GetStyle(self) -> int + + Gets the font style. + """ return _gdi_.Font_GetStyle(*args, **kwargs) def GetWeight(*args, **kwargs): - """GetWeight(self) -> int""" + """ + GetWeight(self) -> int + + Gets the font weight. + """ return _gdi_.Font_GetWeight(*args, **kwargs) def GetUnderlined(*args, **kwargs): - """GetUnderlined(self) -> bool""" + """ + GetUnderlined(self) -> bool + + Returns ``True`` if the font is underlined, ``False`` otherwise. + """ return _gdi_.Font_GetUnderlined(*args, **kwargs) def GetFaceName(*args, **kwargs): - """GetFaceName(self) -> String""" + """ + GetFaceName(self) -> String + + Returns the typeface name associated with the font, or the empty + string if there is no typeface information. + """ return _gdi_.Font_GetFaceName(*args, **kwargs) def GetEncoding(*args, **kwargs): - """GetEncoding(self) -> int""" + """ + GetEncoding(self) -> int + + Get the font's encoding. + """ return _gdi_.Font_GetEncoding(*args, **kwargs) def GetNativeFontInfo(*args, **kwargs): - """GetNativeFontInfo(self) -> NativeFontInfo""" + """ + GetNativeFontInfo(self) -> NativeFontInfo + + Constructs a `wx.NativeFontInfo` object from this font. + """ return _gdi_.Font_GetNativeFontInfo(*args, **kwargs) def IsFixedWidth(*args, **kwargs): - """IsFixedWidth(self) -> bool""" + """ + IsFixedWidth(self) -> bool + + Returns true if the font is a fixed width (or monospaced) font, false + if it is a proportional one or font is invalid. + """ return _gdi_.Font_IsFixedWidth(*args, **kwargs) def GetNativeFontInfoDesc(*args, **kwargs): - """GetNativeFontInfoDesc(self) -> String""" + """ + GetNativeFontInfoDesc(self) -> String + + Returns the platform-dependent string completely describing this font + or an empty string if the font isn't valid. + """ return _gdi_.Font_GetNativeFontInfoDesc(*args, **kwargs) def GetNativeFontInfoUserDesc(*args, **kwargs): - """GetNativeFontInfoUserDesc(self) -> String""" + """ + GetNativeFontInfoUserDesc(self) -> String + + Returns a human readable version of `GetNativeFontInfoDesc`. + """ return _gdi_.Font_GetNativeFontInfoUserDesc(*args, **kwargs) def SetPointSize(*args, **kwargs): - """SetPointSize(self, int pointSize)""" + """ + SetPointSize(self, int pointSize) + + Sets the point size. + """ return _gdi_.Font_SetPointSize(*args, **kwargs) + def SetPixelSize(*args, **kwargs): + """ + SetPixelSize(self, Size pixelSize) + + Sets the size in pixels rather than points. If there is platform API + support for this then it is used, otherwise a font with the closest + size is found using a binary search. + """ + return _gdi_.Font_SetPixelSize(*args, **kwargs) + def SetFamily(*args, **kwargs): - """SetFamily(self, int family)""" + """ + SetFamily(self, int family) + + Sets the font family. + """ return _gdi_.Font_SetFamily(*args, **kwargs) def SetStyle(*args, **kwargs): - """SetStyle(self, int style)""" + """ + SetStyle(self, int style) + + Sets the font style. + """ return _gdi_.Font_SetStyle(*args, **kwargs) def SetWeight(*args, **kwargs): - """SetWeight(self, int weight)""" + """ + SetWeight(self, int weight) + + Sets the font weight. + """ return _gdi_.Font_SetWeight(*args, **kwargs) def SetFaceName(*args, **kwargs): - """SetFaceName(self, String faceName)""" - return _gdi_.Font_SetFaceName(*args, **kwargs) + """ + SetFaceName(self, String faceName) -> bool + + Sets the facename for the font. The facename, which should be a valid + font installed on the end-user's system. + + To avoid portability problems, don't rely on a specific face, but + specify the font family instead or as well. A suitable font will be + found on the end-user's system. If both the family and the facename + are specified, wxWidgets will first search for the specific face, and + then for a font belonging to the same family. + """ + return _gdi_.Font_SetFaceName(*args, **kwargs) def SetUnderlined(*args, **kwargs): - """SetUnderlined(self, bool underlined)""" + """ + SetUnderlined(self, bool underlined) + + Sets underlining. + """ return _gdi_.Font_SetUnderlined(*args, **kwargs) def SetEncoding(*args, **kwargs): - """SetEncoding(self, int encoding)""" + """ + SetEncoding(self, int encoding) + + Set the font encoding. + """ return _gdi_.Font_SetEncoding(*args, **kwargs) def SetNativeFontInfo(*args, **kwargs): - """SetNativeFontInfo(self, NativeFontInfo info)""" + """ + SetNativeFontInfo(self, NativeFontInfo info) + + Set the font's attributes from a `wx.NativeFontInfo` object. + """ return _gdi_.Font_SetNativeFontInfo(*args, **kwargs) def SetNativeFontInfoFromString(*args, **kwargs): - """SetNativeFontInfoFromString(self, String info)""" + """ + SetNativeFontInfoFromString(self, String info) -> bool + + Set the font's attributes from string representation of a + `wx.NativeFontInfo` object. + """ return _gdi_.Font_SetNativeFontInfoFromString(*args, **kwargs) def SetNativeFontInfoUserDesc(*args, **kwargs): - """SetNativeFontInfoUserDesc(self, String info)""" + """ + SetNativeFontInfoUserDesc(self, String info) -> bool + + Set the font's attributes from a string formerly returned from + `GetNativeFontInfoDesc`. + """ return _gdi_.Font_SetNativeFontInfoUserDesc(*args, **kwargs) def GetFamilyString(*args, **kwargs): - """GetFamilyString(self) -> String""" + """ + GetFamilyString(self) -> String + + Returns a string representation of the font family. + """ return _gdi_.Font_GetFamilyString(*args, **kwargs) def GetStyleString(*args, **kwargs): - """GetStyleString(self) -> String""" + """ + GetStyleString(self) -> String + + Returns a string representation of the font style. + """ return _gdi_.Font_GetStyleString(*args, **kwargs) def GetWeightString(*args, **kwargs): - """GetWeightString(self) -> String""" + """ + GetWeightString(self) -> String + + Return a string representation of the font weight. + """ return _gdi_.Font_GetWeightString(*args, **kwargs) def SetNoAntiAliasing(*args, **kwargs): @@ -1791,73 +2176,153 @@ class Font(GDIObject): return _gdi_.Font_GetNoAntiAliasing(*args, **kwargs) def GetDefaultEncoding(*args, **kwargs): - """GetDefaultEncoding() -> int""" + """ + GetDefaultEncoding() -> int + + Returns the encoding used for all fonts created with an encoding of + ``wx.FONTENCODING_DEFAULT``. + """ return _gdi_.Font_GetDefaultEncoding(*args, **kwargs) GetDefaultEncoding = staticmethod(GetDefaultEncoding) def SetDefaultEncoding(*args, **kwargs): - """SetDefaultEncoding(int encoding)""" + """ + SetDefaultEncoding(int encoding) + + Sets the default font encoding. + """ return _gdi_.Font_SetDefaultEncoding(*args, **kwargs) SetDefaultEncoding = staticmethod(SetDefaultEncoding) - -class FontPtr(Font): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Font -_gdi_.Font_swigregister(FontPtr) + Encoding = property(GetEncoding,SetEncoding,doc="See `GetEncoding` and `SetEncoding`") + FaceName = property(GetFaceName,SetFaceName,doc="See `GetFaceName` and `SetFaceName`") + Family = property(GetFamily,SetFamily,doc="See `GetFamily` and `SetFamily`") + FamilyString = property(GetFamilyString,doc="See `GetFamilyString`") + NativeFontInfo = property(GetNativeFontInfo,SetNativeFontInfo,doc="See `GetNativeFontInfo` and `SetNativeFontInfo`") + NativeFontInfoDesc = property(GetNativeFontInfoDesc,doc="See `GetNativeFontInfoDesc`") + NativeFontInfoUserDesc = property(GetNativeFontInfoUserDesc,SetNativeFontInfoUserDesc,doc="See `GetNativeFontInfoUserDesc` and `SetNativeFontInfoUserDesc`") + NoAntiAliasing = property(GetNoAntiAliasing,SetNoAntiAliasing,doc="See `GetNoAntiAliasing` and `SetNoAntiAliasing`") + PixelSize = property(GetPixelSize,SetPixelSize,doc="See `GetPixelSize` and `SetPixelSize`") + PointSize = property(GetPointSize,SetPointSize,doc="See `GetPointSize` and `SetPointSize`") + Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`") + StyleString = property(GetStyleString,doc="See `GetStyleString`") + Underlined = property(GetUnderlined,SetUnderlined,doc="See `GetUnderlined` and `SetUnderlined`") + Weight = property(GetWeight,SetWeight,doc="See `GetWeight` and `SetWeight`") + WeightString = property(GetWeightString,doc="See `GetWeightString`") +_gdi_.Font_swigregister(Font) def FontFromNativeInfo(*args, **kwargs): - """FontFromNativeInfo(NativeFontInfo info) -> Font""" + """ + FontFromNativeInfo(NativeFontInfo info) -> Font + + Construct a `wx.Font` from a `wx.NativeFontInfo` object. + """ + if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName'] val = _gdi_.new_FontFromNativeInfo(*args, **kwargs) - val.thisown = 1 return val def FontFromNativeInfoString(*args, **kwargs): - """FontFromNativeInfoString(String info) -> Font""" + """ + FontFromNativeInfoString(String info) -> Font + + Construct a `wx.Font` from the string representation of a + `wx.NativeFontInfo` object. + """ + if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName'] val = _gdi_.new_FontFromNativeInfoString(*args, **kwargs) - val.thisown = 1 return val -def Font2(*args, **kwargs): +def FFont(*args, **kwargs): """ - Font2(int pointSize, int family, int flags=FONTFLAG_DEFAULT, + FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT, String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font + + A bit of a simpler way to create a `wx.Font` using flags instead of + individual attribute settings. The value of flags can be a + combination of the following: + + ============================ == + wx.FONTFLAG_DEFAULT + wx.FONTFLAG_ITALIC + wx.FONTFLAG_SLANT + wx.FONTFLAG_LIGHT + wx.FONTFLAG_BOLD + wx.FONTFLAG_ANTIALIASED + wx.FONTFLAG_NOT_ANTIALIASED + wx.FONTFLAG_UNDERLINED + wx.FONTFLAG_STRIKETHROUGH + ============================ == + + :see: `wx.Font.__init__` + """ + if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName'] + val = _gdi_.new_FFont(*args, **kwargs) + return val + +def FontFromPixelSize(*args, **kwargs): """ - val = _gdi_.new_Font2(*args, **kwargs) - val.thisown = 1 + FontFromPixelSize(Size pixelSize, int family, int style, int weight, + bool underlined=False, String face=wxEmptyString, + int encoding=FONTENCODING_DEFAULT) -> Font + + Creates a font using a size in pixels rather than points. If there is + platform API support for this then it is used, otherwise a font with + the closest size is found using a binary search. + + :see: `wx.Font.__init__` + """ + if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName'] + val = _gdi_.new_FontFromPixelSize(*args, **kwargs) + return val + +def FFontFromPixelSize(*args, **kwargs): + """ + FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT, + String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font + + Creates a font using a size in pixels rather than points. If there is + platform API support for this then it is used, otherwise a font with + the closest size is found using a binary search. + + :see: `wx.Font.__init__`, `wx.FFont` + """ + if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName'] + val = _gdi_.new_FFontFromPixelSize(*args, **kwargs) return val -def Font_GetDefaultEncoding(*args, **kwargs): - """Font_GetDefaultEncoding() -> int""" - return _gdi_.Font_GetDefaultEncoding(*args, **kwargs) +def Font_GetDefaultEncoding(*args): + """ + Font_GetDefaultEncoding() -> int + + Returns the encoding used for all fonts created with an encoding of + ``wx.FONTENCODING_DEFAULT``. + """ + return _gdi_.Font_GetDefaultEncoding(*args) def Font_SetDefaultEncoding(*args, **kwargs): - """Font_SetDefaultEncoding(int encoding)""" - return _gdi_.Font_SetDefaultEncoding(*args, **kwargs) + """ + Font_SetDefaultEncoding(int encoding) + + Sets the default font encoding. + """ + return _gdi_.Font_SetDefaultEncoding(*args, **kwargs) +Font2 = wx._deprecated(FFont, "Use `wx.FFont` instead.") #--------------------------------------------------------------------------- class FontEnumerator(object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxPyFontEnumerator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ FontEnumerator 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) -> FontEnumerator""" - newobj = _gdi_.new_FontEnumerator(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - self._setCallbackInfo(self, FontEnumerator, 0) - - def __del__(self, destroy=_gdi_.delete_FontEnumerator): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass + _gdi_.FontEnumerator_swiginit(self,_gdi_.new_FontEnumerator(*args, **kwargs)) + 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): @@ -1869,20 +2334,43 @@ class FontEnumerator(object): return _gdi_.FontEnumerator_EnumerateEncodings(*args, **kwargs) def GetEncodings(*args, **kwargs): - """GetEncodings(self) -> PyObject""" + """GetEncodings() -> PyObject""" return _gdi_.FontEnumerator_GetEncodings(*args, **kwargs) + GetEncodings = staticmethod(GetEncodings) def GetFacenames(*args, **kwargs): - """GetFacenames(self) -> PyObject""" + """GetFacenames() -> PyObject""" return _gdi_.FontEnumerator_GetFacenames(*args, **kwargs) + GetFacenames = staticmethod(GetFacenames) + def IsValidFacename(*args, **kwargs): + """ + IsValidFacename(String str) -> bool + + Convenience function that returns true if the given face name exist in + the user's system + """ + return _gdi_.FontEnumerator_IsValidFacename(*args, **kwargs) + + IsValidFacename = staticmethod(IsValidFacename) +_gdi_.FontEnumerator_swigregister(FontEnumerator) + +def FontEnumerator_GetEncodings(*args): + """FontEnumerator_GetEncodings() -> PyObject""" + return _gdi_.FontEnumerator_GetEncodings(*args) + +def FontEnumerator_GetFacenames(*args): + """FontEnumerator_GetFacenames() -> PyObject""" + return _gdi_.FontEnumerator_GetFacenames(*args) + +def FontEnumerator_IsValidFacename(*args, **kwargs): + """ + FontEnumerator_IsValidFacename(String str) -> bool -class FontEnumeratorPtr(FontEnumerator): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = FontEnumerator -_gdi_.FontEnumerator_swigregister(FontEnumeratorPtr) + Convenience function that returns true if the given face name exist in + the user's system + """ + return _gdi_.FontEnumerator_IsValidFacename(*args, **kwargs) #--------------------------------------------------------------------------- @@ -2118,19 +2606,14 @@ LANGUAGE_ZHUANG = _gdi_.LANGUAGE_ZHUANG LANGUAGE_ZULU = _gdi_.LANGUAGE_ZULU LANGUAGE_USER_DEFINED = _gdi_.LANGUAGE_USER_DEFINED class LanguageInfo(object): - def __init__(self): raise RuntimeError, "No constructor defined" - def __repr__(self): - return "<%s.%s; proxy of C++ wxLanguageInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) + """Proxy of C++ LanguageInfo 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 Language = property(_gdi_.LanguageInfo_Language_get, _gdi_.LanguageInfo_Language_set) CanonicalName = property(_gdi_.LanguageInfo_CanonicalName_get, _gdi_.LanguageInfo_CanonicalName_set) Description = property(_gdi_.LanguageInfo_Description_get, _gdi_.LanguageInfo_Description_set) - -class LanguageInfoPtr(LanguageInfo): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = LanguageInfo -_gdi_.LanguageInfo_swigregister(LanguageInfoPtr) +_gdi_.LanguageInfo_swigregister(LanguageInfo) LOCALE_CAT_NUMBER = _gdi_.LOCALE_CAT_NUMBER LOCALE_CAT_DATE = _gdi_.LOCALE_CAT_DATE @@ -2141,20 +2624,14 @@ LOCALE_DECIMAL_POINT = _gdi_.LOCALE_DECIMAL_POINT LOCALE_LOAD_DEFAULT = _gdi_.LOCALE_LOAD_DEFAULT LOCALE_CONV_ENCODING = _gdi_.LOCALE_CONV_ENCODING class Locale(object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxLocale instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale""" - newobj = _gdi_.new_Locale(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_Locale): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + """Proxy of C++ Locale 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, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale""" + _gdi_.Locale_swiginit(self,_gdi_.new_Locale(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Locale + __del__ = lambda self : None; def Init1(*args, **kwargs): """ Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString, @@ -2219,6 +2696,11 @@ class Locale(object): """AddCatalog(self, String szDomain) -> bool""" return _gdi_.Locale_AddCatalog(*args, **kwargs) + def IsAvailable(*args, **kwargs): + """IsAvailable(int lang) -> bool""" + return _gdi_.Locale_IsAvailable(*args, **kwargs) + + IsAvailable = staticmethod(IsAvailable) def IsLoaded(*args, **kwargs): """IsLoaded(self, String szDomain) -> bool""" return _gdi_.Locale_IsLoaded(*args, **kwargs) @@ -2251,50 +2733,82 @@ class Locale(object): """GetName(self) -> String""" return _gdi_.Locale_GetName(*args, **kwargs) + CanonicalName = property(GetCanonicalName,doc="See `GetCanonicalName`") + Language = property(GetLanguage,doc="See `GetLanguage`") + Locale = property(GetLocale,doc="See `GetLocale`") + Name = property(GetName,doc="See `GetName`") + String = property(GetString,doc="See `GetString`") + SysName = property(GetSysName,doc="See `GetSysName`") +_gdi_.Locale_swigregister(Locale) -class LocalePtr(Locale): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Locale -_gdi_.Locale_swigregister(LocalePtr) +def Locale_GetSystemLanguage(*args): + """Locale_GetSystemLanguage() -> int""" + return _gdi_.Locale_GetSystemLanguage(*args) -def Locale_GetSystemLanguage(*args, **kwargs): - """Locale_GetSystemLanguage() -> int""" - return _gdi_.Locale_GetSystemLanguage(*args, **kwargs) +def Locale_GetSystemEncoding(*args): + """Locale_GetSystemEncoding() -> int""" + return _gdi_.Locale_GetSystemEncoding(*args) -def Locale_GetSystemEncoding(*args, **kwargs): - """Locale_GetSystemEncoding() -> int""" - return _gdi_.Locale_GetSystemEncoding(*args, **kwargs) - -def Locale_GetSystemEncodingName(*args, **kwargs): - """Locale_GetSystemEncodingName() -> String""" - return _gdi_.Locale_GetSystemEncodingName(*args, **kwargs) +def Locale_GetSystemEncodingName(*args): + """Locale_GetSystemEncodingName() -> String""" + return _gdi_.Locale_GetSystemEncodingName(*args) def Locale_AddCatalogLookupPathPrefix(*args, **kwargs): - """Locale_AddCatalogLookupPathPrefix(String prefix)""" - return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs) + """Locale_AddCatalogLookupPathPrefix(String prefix)""" + return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs) + +def Locale_IsAvailable(*args, **kwargs): + """Locale_IsAvailable(int lang) -> bool""" + return _gdi_.Locale_IsAvailable(*args, **kwargs) def Locale_GetLanguageInfo(*args, **kwargs): - """Locale_GetLanguageInfo(int lang) -> LanguageInfo""" - return _gdi_.Locale_GetLanguageInfo(*args, **kwargs) + """Locale_GetLanguageInfo(int lang) -> LanguageInfo""" + return _gdi_.Locale_GetLanguageInfo(*args, **kwargs) def Locale_GetLanguageName(*args, **kwargs): - """Locale_GetLanguageName(int lang) -> String""" - return _gdi_.Locale_GetLanguageName(*args, **kwargs) + """Locale_GetLanguageName(int lang) -> String""" + return _gdi_.Locale_GetLanguageName(*args, **kwargs) def Locale_FindLanguageInfo(*args, **kwargs): - """Locale_FindLanguageInfo(String locale) -> LanguageInfo""" - return _gdi_.Locale_FindLanguageInfo(*args, **kwargs) + """Locale_FindLanguageInfo(String locale) -> LanguageInfo""" + return _gdi_.Locale_FindLanguageInfo(*args, **kwargs) def Locale_AddLanguage(*args, **kwargs): - """Locale_AddLanguage(LanguageInfo info)""" - return _gdi_.Locale_AddLanguage(*args, **kwargs) + """Locale_AddLanguage(LanguageInfo info)""" + return _gdi_.Locale_AddLanguage(*args, **kwargs) + +class PyLocale(Locale): + """Proxy of C++ PyLocale 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, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale""" + _gdi_.PyLocale_swiginit(self,_gdi_.new_PyLocale(*args, **kwargs)) + PyLocale._setCallbackInfo(self, self, PyLocale) + + __swig_destroy__ = _gdi_.delete_PyLocale + __del__ = lambda self : None; + def _setCallbackInfo(*args, **kwargs): + """_setCallbackInfo(self, PyObject self, PyObject _class)""" + return _gdi_.PyLocale__setCallbackInfo(*args, **kwargs) + + def GetSingularString(*args, **kwargs): + """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar""" + return _gdi_.PyLocale_GetSingularString(*args, **kwargs) + + def GetPluralString(*args, **kwargs): + """ + GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n, + wxChar szDomain=None) -> wxChar + """ + return _gdi_.PyLocale_GetPluralString(*args, **kwargs) + +_gdi_.PyLocale_swigregister(PyLocale) -def GetLocale(*args, **kwargs): - """GetLocale() -> Locale""" - return _gdi_.GetLocale(*args, **kwargs) +def GetLocale(*args): + """GetLocale() -> Locale""" + return _gdi_.GetLocale(*args) #--------------------------------------------------------------------------- CONVERT_STRICT = _gdi_.CONVERT_STRICT @@ -2305,20 +2819,14 @@ PLATFORM_WINDOWS = _gdi_.PLATFORM_WINDOWS PLATFORM_OS2 = _gdi_.PLATFORM_OS2 PLATFORM_MAC = _gdi_.PLATFORM_MAC class EncodingConverter(_core.Object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxEncodingConverter instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + """Proxy of C++ EncodingConverter 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) -> EncodingConverter""" - newobj = _gdi_.new_EncodingConverter(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_EncodingConverter): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass - + _gdi_.EncodingConverter_swiginit(self,_gdi_.new_EncodingConverter(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_EncodingConverter + __del__ = lambda self : None; def Init(*args, **kwargs): """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool""" return _gdi_.EncodingConverter_Init(*args, **kwargs) @@ -2343,49 +2851,36 @@ class EncodingConverter(_core.Object): CanConvert = staticmethod(CanConvert) def __nonzero__(self): return self.IsOk() - -class EncodingConverterPtr(EncodingConverter): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = EncodingConverter -_gdi_.EncodingConverter_swigregister(EncodingConverterPtr) +_gdi_.EncodingConverter_swigregister(EncodingConverter) def GetTranslation(*args): - """ + """ GetTranslation(String str) -> String + GetTranslation(String str, String domain) -> String GetTranslation(String str, String strPlural, size_t n) -> String + GetTranslation(String str, String strPlural, size_t n, String domain) -> String """ - return _gdi_.GetTranslation(*args) + return _gdi_.GetTranslation(*args) def EncodingConverter_GetPlatformEquivalents(*args, **kwargs): - """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray""" - return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs) + """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray""" + return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs) def EncodingConverter_GetAllEquivalents(*args, **kwargs): - """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray""" - return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs) + """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray""" + return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs) def EncodingConverter_CanConvert(*args, **kwargs): - """EncodingConverter_CanConvert(int encIn, int encOut) -> bool""" - return _gdi_.EncodingConverter_CanConvert(*args, **kwargs) + """EncodingConverter_CanConvert(int encIn, int encOut) -> bool""" + return _gdi_.EncodingConverter_CanConvert(*args, **kwargs) #---------------------------------------------------------------------------- -# wxGTK sets the locale when initialized. Doing this at the Python -# level should set it up to match what GTK is doing at the C level. -if wx.Platform == "__WXGTK__": - try: - import locale - locale.setlocale(locale.LC_ALL, "") - except: - pass - -# On MSW add the directory where the wxWindows catalogs were installed +# On MSW add the directory where the wxWidgets catalogs were installed # to the default catalog path. if wx.Platform == "__WXMSW__": import os - localedir = os.path.join(os.path.split(__file__)[0], "locale") - Locale_AddCatalogLookupPathPrefix(localedir) + _localedir = os.path.join(os.path.split(__file__)[0], "locale") + Locale.AddCatalogLookupPathPrefix(_localedir) del os #---------------------------------------------------------------------------- @@ -2393,186 +2888,598 @@ if wx.Platform == "__WXMSW__": #--------------------------------------------------------------------------- class DC(_core.Object): - def __init__(self): raise RuntimeError, "No constructor defined" - def __repr__(self): - return "<%s.%s; proxy of C++ wxDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __del__(self, destroy=_gdi_.delete_DC): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass + """ + A wx.DC is a device context onto which graphics and text can be + drawn. It is intended to represent a number of output devices in a + generic way, so a window can have a device context associated with it, + and a printer also has a device context. In this way, the same piece + of code may write to a number of different devices, if the device + context is used as a parameter. + + Derived types of wxDC have documentation for specific features only, + so refer to this section for most device context information. + + The wx.DC class is abstract and can not be instantiated, you must use + one of the derived classes instead. Which one will depend on the + situation in which it is used. + """ + 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 + __swig_destroy__ = _gdi_.delete_DC + __del__ = lambda self : None; + # These have been deprecated in wxWidgets. Since they never + # really did anything to begin with, just make them be NOPs. + def BeginDrawing(self): pass + def EndDrawing(self): pass - def BeginDrawing(*args, **kwargs): - """BeginDrawing(self)""" - return _gdi_.DC_BeginDrawing(*args, **kwargs) + def FloodFill(*args, **kwargs): + """ + FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool - def EndDrawing(*args, **kwargs): - """EndDrawing(self)""" - return _gdi_.DC_EndDrawing(*args, **kwargs) + Flood fills the device context starting from the given point, using + the current brush colour, and using a style: - def FloodFillXY(*args, **kwargs): - """FloodFillXY(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool""" - return _gdi_.DC_FloodFillXY(*args, **kwargs) + - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than + the given colour is encountered. - def FloodFill(*args, **kwargs): - """FloodFill(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool""" + - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given + colour. + + Returns False if the operation failed. + + Note: The present implementation for non-Windows platforms may fail to + find colour borders if the pixels do not match the colour + exactly. However the function will still return true. + """ return _gdi_.DC_FloodFill(*args, **kwargs) - def GetPixelXY(*args, **kwargs): - """GetPixelXY(self, int x, int y) -> Colour""" - return _gdi_.DC_GetPixelXY(*args, **kwargs) + def FloodFillPoint(*args, **kwargs): + """ + FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool + + Flood fills the device context starting from the given point, using + the current brush colour, and using a style: + + - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than + the given colour is encountered. + + - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given + colour. + + Returns False if the operation failed. + + Note: The present implementation for non-Windows platforms may fail to + find colour borders if the pixels do not match the colour + exactly. However the function will still return true. + """ + return _gdi_.DC_FloodFillPoint(*args, **kwargs) + + def GradientFillConcentric(*args, **kwargs): + """ + GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour, + Point circleCenter) + + Fill the area specified by rect with a radial gradient, starting from + initialColour in the center of the circle and fading to destColour on + the outside of the circle. The circleCenter argument is the relative + coordinants of the center of the circle in the specified rect. + + Note: Currently this function is very slow, don't use it for real-time + drawing. + """ + return _gdi_.DC_GradientFillConcentric(*args, **kwargs) + + def GradientFillLinear(*args, **kwargs): + """ + GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour, + int nDirection=EAST) + + Fill the area specified by rect with a linear gradient, starting from + initialColour and eventually fading to destColour. The nDirection + parameter specifies the direction of the colour change, default is to + use initialColour on the left part of the rectangle and destColour on + the right side. + """ + return _gdi_.DC_GradientFillLinear(*args, **kwargs) def GetPixel(*args, **kwargs): - """GetPixel(self, Point pt) -> Colour""" + """ + GetPixel(self, int x, int y) -> Colour + + Gets the colour at the specified location on the DC. + """ return _gdi_.DC_GetPixel(*args, **kwargs) - def DrawLineXY(*args, **kwargs): - """DrawLineXY(self, int x1, int y1, int x2, int y2)""" - return _gdi_.DC_DrawLineXY(*args, **kwargs) + def GetPixelPoint(*args, **kwargs): + """GetPixelPoint(self, Point pt) -> Colour""" + return _gdi_.DC_GetPixelPoint(*args, **kwargs) def DrawLine(*args, **kwargs): - """DrawLine(self, Point pt1, Point pt2)""" + """ + DrawLine(self, int x1, int y1, int x2, int y2) + + Draws a line from the first point to the second. The current pen is + used for drawing the line. Note that the second point is *not* part of + the line and is not drawn by this function (this is consistent with + the behaviour of many other toolkits). + """ return _gdi_.DC_DrawLine(*args, **kwargs) - def CrossHairXY(*args, **kwargs): - """CrossHairXY(self, int x, int y)""" - return _gdi_.DC_CrossHairXY(*args, **kwargs) + def DrawLinePoint(*args, **kwargs): + """ + DrawLinePoint(self, Point pt1, Point pt2) + + Draws a line from the first point to the second. The current pen is + used for drawing the line. Note that the second point is *not* part of + the line and is not drawn by this function (this is consistent with + the behaviour of many other toolkits). + """ + return _gdi_.DC_DrawLinePoint(*args, **kwargs) def CrossHair(*args, **kwargs): - """CrossHair(self, Point pt)""" + """ + CrossHair(self, int x, int y) + + Displays a cross hair using the current pen. This is a vertical and + horizontal line the height and width of the window, centred on the + given point. + """ return _gdi_.DC_CrossHair(*args, **kwargs) - def DrawArcXY(*args, **kwargs): - """DrawArcXY(self, int x1, int y1, int x2, int y2, int xc, int yc)""" - return _gdi_.DC_DrawArcXY(*args, **kwargs) + def CrossHairPoint(*args, **kwargs): + """ + CrossHairPoint(self, Point pt) + + Displays a cross hair using the current pen. This is a vertical and + horizontal line the height and width of the window, centred on the + given point. + """ + return _gdi_.DC_CrossHairPoint(*args, **kwargs) def DrawArc(*args, **kwargs): - """DrawArc(self, Point pt1, Point pt2, Point centre)""" + """ + DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc) + + Draws an arc of a circle, centred on the *center* point (xc, yc), from + the first point to the second. The current pen is used for the outline + and the current brush for filling the shape. + + The arc is drawn in an anticlockwise direction from the start point to + the end point. + """ return _gdi_.DC_DrawArc(*args, **kwargs) - def DrawCheckMarkXY(*args, **kwargs): - """DrawCheckMarkXY(self, int x, int y, int width, int height)""" - return _gdi_.DC_DrawCheckMarkXY(*args, **kwargs) + def DrawArcPoint(*args, **kwargs): + """ + DrawArcPoint(self, Point pt1, Point pt2, Point center) + + Draws an arc of a circle, centred on the *center* point (xc, yc), from + the first point to the second. The current pen is used for the outline + and the current brush for filling the shape. + + The arc is drawn in an anticlockwise direction from the start point to + the end point. + """ + return _gdi_.DC_DrawArcPoint(*args, **kwargs) def DrawCheckMark(*args, **kwargs): - """DrawCheckMark(self, Rect rect)""" + """ + DrawCheckMark(self, int x, int y, int width, int height) + + Draws a check mark inside the given rectangle. + """ return _gdi_.DC_DrawCheckMark(*args, **kwargs) - def DrawEllipticArcXY(*args, **kwargs): - """DrawEllipticArcXY(self, int x, int y, int w, int h, double sa, double ea)""" - return _gdi_.DC_DrawEllipticArcXY(*args, **kwargs) + def DrawCheckMarkRect(*args, **kwargs): + """ + DrawCheckMarkRect(self, Rect rect) + + Draws a check mark inside the given rectangle. + """ + return _gdi_.DC_DrawCheckMarkRect(*args, **kwargs) def DrawEllipticArc(*args, **kwargs): - """DrawEllipticArc(self, Point pt, Size sz, double sa, double ea)""" + """ + DrawEllipticArc(self, int x, int y, int w, int h, double start, double end) + + Draws an arc of an ellipse, with the given rectangle defining the + bounds of the ellipse. The current pen is used for drawing the arc and + the current brush is used for drawing the pie. + + The *start* and *end* parameters specify the start and end of the arc + relative to the three-o'clock position from the center of the + rectangle. Angles are specified in degrees (360 is a complete + circle). Positive values mean counter-clockwise motion. If start is + equal to end, a complete ellipse will be drawn. + """ return _gdi_.DC_DrawEllipticArc(*args, **kwargs) - def DrawPointXY(*args, **kwargs): - """DrawPointXY(self, int x, int y)""" - return _gdi_.DC_DrawPointXY(*args, **kwargs) + def DrawEllipticArcPointSize(*args, **kwargs): + """ + DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end) + + Draws an arc of an ellipse, with the given rectangle defining the + bounds of the ellipse. The current pen is used for drawing the arc and + the current brush is used for drawing the pie. + + The *start* and *end* parameters specify the start and end of the arc + relative to the three-o'clock position from the center of the + rectangle. Angles are specified in degrees (360 is a complete + circle). Positive values mean counter-clockwise motion. If start is + equal to end, a complete ellipse will be drawn. + """ + return _gdi_.DC_DrawEllipticArcPointSize(*args, **kwargs) def DrawPoint(*args, **kwargs): - """DrawPoint(self, Point pt)""" + """ + DrawPoint(self, int x, int y) + + Draws a point using the current pen. + """ return _gdi_.DC_DrawPoint(*args, **kwargs) - def DrawRectangleXY(*args, **kwargs): - """DrawRectangleXY(self, int x, int y, int width, int height)""" - return _gdi_.DC_DrawRectangleXY(*args, **kwargs) + def DrawPointPoint(*args, **kwargs): + """ + DrawPointPoint(self, Point pt) + + Draws a point using the current pen. + """ + return _gdi_.DC_DrawPointPoint(*args, **kwargs) def DrawRectangle(*args, **kwargs): - """DrawRectangle(self, Point pt, Size sz)""" + """ + DrawRectangle(self, int x, int y, int width, int height) + + Draws a rectangle with the given top left corner, and with the given + size. The current pen is used for the outline and the current brush + for filling the shape. + """ return _gdi_.DC_DrawRectangle(*args, **kwargs) def DrawRectangleRect(*args, **kwargs): - """DrawRectangleRect(self, Rect rect)""" + """ + DrawRectangleRect(self, Rect rect) + + Draws a rectangle with the given top left corner, and with the given + size. The current pen is used for the outline and the current brush + for filling the shape. + """ return _gdi_.DC_DrawRectangleRect(*args, **kwargs) - def DrawRoundedRectangleXY(*args, **kwargs): - """DrawRoundedRectangleXY(self, int x, int y, int width, int height, double radius)""" - return _gdi_.DC_DrawRoundedRectangleXY(*args, **kwargs) + def DrawRectanglePointSize(*args, **kwargs): + """ + DrawRectanglePointSize(self, Point pt, Size sz) + + Draws a rectangle with the given top left corner, and with the given + size. The current pen is used for the outline and the current brush + for filling the shape. + """ + return _gdi_.DC_DrawRectanglePointSize(*args, **kwargs) def DrawRoundedRectangle(*args, **kwargs): - """DrawRoundedRectangle(self, Point pt, Size sz, double radius)""" + """ + DrawRoundedRectangle(self, int x, int y, int width, int height, double radius) + + Draws a rectangle with the given top left corner, and with the given + size. The corners are quarter-circles using the given radius. The + current pen is used for the outline and the current brush for filling + the shape. + + If radius is positive, the value is assumed to be the radius of the + rounded corner. If radius is negative, the absolute value is assumed + to be the proportion of the smallest dimension of the rectangle. This + means that the corner can be a sensible size relative to the size of + the rectangle, and also avoids the strange effects X produces when the + corners are too big for the rectangle. + """ return _gdi_.DC_DrawRoundedRectangle(*args, **kwargs) def DrawRoundedRectangleRect(*args, **kwargs): - """DrawRoundedRectangleRect(self, Rect r, double radius)""" + """ + DrawRoundedRectangleRect(self, Rect r, double radius) + + Draws a rectangle with the given top left corner, and with the given + size. The corners are quarter-circles using the given radius. The + current pen is used for the outline and the current brush for filling + the shape. + + If radius is positive, the value is assumed to be the radius of the + rounded corner. If radius is negative, the absolute value is assumed + to be the proportion of the smallest dimension of the rectangle. This + means that the corner can be a sensible size relative to the size of + the rectangle, and also avoids the strange effects X produces when the + corners are too big for the rectangle. + """ return _gdi_.DC_DrawRoundedRectangleRect(*args, **kwargs) - def DrawCircleXY(*args, **kwargs): - """DrawCircleXY(self, int x, int y, int radius)""" - return _gdi_.DC_DrawCircleXY(*args, **kwargs) + def DrawRoundedRectanglePointSize(*args, **kwargs): + """ + DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius) + + Draws a rectangle with the given top left corner, and with the given + size. The corners are quarter-circles using the given radius. The + current pen is used for the outline and the current brush for filling + the shape. + + If radius is positive, the value is assumed to be the radius of the + rounded corner. If radius is negative, the absolute value is assumed + to be the proportion of the smallest dimension of the rectangle. This + means that the corner can be a sensible size relative to the size of + the rectangle, and also avoids the strange effects X produces when the + corners are too big for the rectangle. + """ + return _gdi_.DC_DrawRoundedRectanglePointSize(*args, **kwargs) def DrawCircle(*args, **kwargs): - """DrawCircle(self, Point pt, int radius)""" + """ + DrawCircle(self, int x, int y, int radius) + + Draws a circle with the given center point and radius. The current + pen is used for the outline and the current brush for filling the + shape. + """ return _gdi_.DC_DrawCircle(*args, **kwargs) - def DrawEllipseXY(*args, **kwargs): - """DrawEllipseXY(self, int x, int y, int width, int height)""" - return _gdi_.DC_DrawEllipseXY(*args, **kwargs) + def DrawCirclePoint(*args, **kwargs): + """ + DrawCirclePoint(self, Point pt, int radius) + + Draws a circle with the given center point and radius. The current + pen is used for the outline and the current brush for filling the + shape. + """ + return _gdi_.DC_DrawCirclePoint(*args, **kwargs) def DrawEllipse(*args, **kwargs): - """DrawEllipse(self, Point pt, Size sz)""" + """ + DrawEllipse(self, int x, int y, int width, int height) + + Draws an ellipse contained in the specified rectangle. The current pen + is used for the outline and the current brush for filling the shape. + """ return _gdi_.DC_DrawEllipse(*args, **kwargs) def DrawEllipseRect(*args, **kwargs): - """DrawEllipseRect(self, Rect rect)""" + """ + DrawEllipseRect(self, Rect rect) + + Draws an ellipse contained in the specified rectangle. The current pen + is used for the outline and the current brush for filling the shape. + """ return _gdi_.DC_DrawEllipseRect(*args, **kwargs) - def DrawIconXY(*args, **kwargs): - """DrawIconXY(self, Icon icon, int x, int y)""" - return _gdi_.DC_DrawIconXY(*args, **kwargs) + def DrawEllipsePointSize(*args, **kwargs): + """ + DrawEllipsePointSize(self, Point pt, Size sz) + + Draws an ellipse contained in the specified rectangle. The current pen + is used for the outline and the current brush for filling the shape. + """ + return _gdi_.DC_DrawEllipsePointSize(*args, **kwargs) def DrawIcon(*args, **kwargs): - """DrawIcon(self, Icon icon, Point pt)""" + """ + DrawIcon(self, Icon icon, int x, int y) + + Draw an icon on the display (does nothing if the device context is + PostScript). This can be the simplest way of drawing bitmaps on a + window. + """ return _gdi_.DC_DrawIcon(*args, **kwargs) - def DrawBitmapXY(*args, **kwargs): - """DrawBitmapXY(self, Bitmap bmp, int x, int y, bool useMask=False)""" - return _gdi_.DC_DrawBitmapXY(*args, **kwargs) + def DrawIconPoint(*args, **kwargs): + """ + DrawIconPoint(self, Icon icon, Point pt) + + Draw an icon on the display (does nothing if the device context is + PostScript). This can be the simplest way of drawing bitmaps on a + window. + """ + return _gdi_.DC_DrawIconPoint(*args, **kwargs) def DrawBitmap(*args, **kwargs): - """DrawBitmap(self, Bitmap bmp, Point pt, bool useMask=False)""" + """ + DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False) + + Draw a bitmap on the device context at the specified point. If + *transparent* is true and the bitmap has a transparency mask, (or + alpha channel on the platforms that support it) then the bitmap will + be drawn transparently. + """ return _gdi_.DC_DrawBitmap(*args, **kwargs) - def DrawTextXY(*args, **kwargs): - """DrawTextXY(self, String text, int x, int y)""" - return _gdi_.DC_DrawTextXY(*args, **kwargs) + def DrawBitmapPoint(*args, **kwargs): + """ + DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False) + + Draw a bitmap on the device context at the specified point. If + *transparent* is true and the bitmap has a transparency mask, (or + alpha channel on the platforms that support it) then the bitmap will + be drawn transparently. + """ + return _gdi_.DC_DrawBitmapPoint(*args, **kwargs) def DrawText(*args, **kwargs): - """DrawText(self, String text, Point pt)""" + """ + DrawText(self, String text, int x, int y) + + Draws a text string at the specified point, using the current text + font, and the current text foreground and background colours. + + The coordinates refer to the top-left corner of the rectangle bounding + the string. See `GetTextExtent` for how to get the dimensions of a + text string, which can be used to position the text more precisely. + + **NOTE**: under wxGTK the current logical function is used by this + function but it is ignored by wxMSW. Thus, you should avoid using + logical functions with this function in portable programs. + """ return _gdi_.DC_DrawText(*args, **kwargs) - def DrawRotatedTextXY(*args, **kwargs): - """DrawRotatedTextXY(self, String text, int x, int y, double angle)""" - return _gdi_.DC_DrawRotatedTextXY(*args, **kwargs) + def DrawTextPoint(*args, **kwargs): + """ + DrawTextPoint(self, String text, Point pt) + + Draws a text string at the specified point, using the current text + font, and the current text foreground and background colours. + + The coordinates refer to the top-left corner of the rectangle bounding + the string. See `GetTextExtent` for how to get the dimensions of a + text string, which can be used to position the text more precisely. + + **NOTE**: under wxGTK the current logical function is used by this + function but it is ignored by wxMSW. Thus, you should avoid using + logical functions with this function in portable programs. + """ + return _gdi_.DC_DrawTextPoint(*args, **kwargs) def DrawRotatedText(*args, **kwargs): - """DrawRotatedText(self, String text, Point pt, double angle)""" + """ + DrawRotatedText(self, String text, int x, int y, double angle) + + Draws the text rotated by *angle* degrees, if supported by the platform. + + **NOTE**: Under Win9x only TrueType fonts can be drawn by this + function. In particular, a font different from ``wx.NORMAL_FONT`` + should be used as the it is not normally a TrueType + font. ``wx.SWISS_FONT`` is an example of a font which is. + """ return _gdi_.DC_DrawRotatedText(*args, **kwargs) - def BlitXY(*args, **kwargs): + def DrawRotatedTextPoint(*args, **kwargs): + """ + DrawRotatedTextPoint(self, String text, Point pt, double angle) + + Draws the text rotated by *angle* degrees, if supported by the platform. + + **NOTE**: Under Win9x only TrueType fonts can be drawn by this + function. In particular, a font different from ``wx.NORMAL_FONT`` + should be used as the it is not normally a TrueType + font. ``wx.SWISS_FONT`` is an example of a font which is. """ - BlitXY(self, int xdest, int ydest, int width, int height, DC source, + return _gdi_.DC_DrawRotatedTextPoint(*args, **kwargs) + + def Blit(*args, **kwargs): + """ + Blit(self, int xdest, int ydest, int width, int height, DC source, int xsrc, int ysrc, int rop=COPY, bool useMask=False, int xsrcMask=-1, int ysrcMask=-1) -> bool + + Copy from a source DC to this DC. Parameters specify the destination + coordinates, size of area to copy, source DC, source coordinates, + logical function, whether to use a bitmap mask, and mask source + position. """ - return _gdi_.DC_BlitXY(*args, **kwargs) + return _gdi_.DC_Blit(*args, **kwargs) - def Blit(*args, **kwargs): + def BlitPointSize(*args, **kwargs): """ - Blit(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY, + BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY, bool useMask=False, Point srcPtMask=DefaultPosition) -> bool + + Copy from a source DC to this DC. Parameters specify the destination + coordinates, size of area to copy, source DC, source coordinates, + logical function, whether to use a bitmap mask, and mask source + position. """ - return _gdi_.DC_Blit(*args, **kwargs) + return _gdi_.DC_BlitPointSize(*args, **kwargs) + + def GetAsBitmap(*args, **kwargs): + """GetAsBitmap(self, Rect subrect=None) -> Bitmap""" + return _gdi_.DC_GetAsBitmap(*args, **kwargs) + + def SetClippingRegion(*args, **kwargs): + """ + SetClippingRegion(self, int x, int y, int width, int height) + + Sets the clipping region for this device context to the intersection + of the given region described by the parameters of this method and the + previously set clipping region. You should call `DestroyClippingRegion` + if you want to set the clipping region exactly to the region + specified. + + The clipping region is an area to which drawing is + restricted. Possible uses for the clipping region are for clipping + text or for speeding up window redraws when only a known area of the + screen is damaged. + """ + return _gdi_.DC_SetClippingRegion(*args, **kwargs) + + def SetClippingRegionPointSize(*args, **kwargs): + """ + SetClippingRegionPointSize(self, Point pt, Size sz) + + Sets the clipping region for this device context to the intersection + of the given region described by the parameters of this method and the + previously set clipping region. You should call `DestroyClippingRegion` + if you want to set the clipping region exactly to the region + specified. + + The clipping region is an area to which drawing is + restricted. Possible uses for the clipping region are for clipping + text or for speeding up window redraws when only a known area of the + screen is damaged. + """ + return _gdi_.DC_SetClippingRegionPointSize(*args, **kwargs) + + def SetClippingRegionAsRegion(*args, **kwargs): + """ + SetClippingRegionAsRegion(self, Region region) + + Sets the clipping region for this device context to the intersection + of the given region described by the parameters of this method and the + previously set clipping region. You should call `DestroyClippingRegion` + if you want to set the clipping region exactly to the region + specified. + + The clipping region is an area to which drawing is + restricted. Possible uses for the clipping region are for clipping + text or for speeding up window redraws when only a known area of the + screen is damaged. + """ + return _gdi_.DC_SetClippingRegionAsRegion(*args, **kwargs) + + def SetClippingRect(*args, **kwargs): + """ + SetClippingRect(self, Rect rect) + + Sets the clipping region for this device context to the intersection + of the given region described by the parameters of this method and the + previously set clipping region. You should call `DestroyClippingRegion` + if you want to set the clipping region exactly to the region + specified. + + The clipping region is an area to which drawing is + restricted. Possible uses for the clipping region are for clipping + text or for speeding up window redraws when only a known area of the + screen is damaged. + """ + return _gdi_.DC_SetClippingRect(*args, **kwargs) def DrawLines(*args, **kwargs): - """DrawLines(self, int points, Point points_array, int xoffset=0, int yoffset=0)""" + """ + DrawLines(self, List points, int xoffset=0, int yoffset=0) + + Draws lines using a sequence of `wx.Point` objects, adding the + optional offset coordinate. The current pen is used for drawing the + lines. + """ return _gdi_.DC_DrawLines(*args, **kwargs) def DrawPolygon(*args, **kwargs): """ - DrawPolygon(self, int points, Point points_array, int xoffset=0, int yoffset=0, + DrawPolygon(self, List points, int xoffset=0, int yoffset=0, int fillStyle=ODDEVEN_RULE) + + Draws a filled polygon using a sequence of `wx.Point` objects, adding + the optional offset coordinate. The last argument specifies the fill + rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``. + + The current pen is used for drawing the outline, and the current brush + for filling the shape. Using a transparent brush suppresses + filling. Note that wxWidgets automatically closes the first and last + points. """ return _gdi_.DC_DrawPolygon(*args, **kwargs) @@ -2580,6 +3487,10 @@ class DC(_core.Object): """ DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, int indexAccel=-1) + + Draw *text* within the specified rectangle, abiding by the alignment + flags. Will additionally emphasize the character at *indexAccel* if + it is not -1. """ return _gdi_.DC_DrawLabel(*args, **kwargs) @@ -2587,99 +3498,173 @@ class DC(_core.Object): """ DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, int indexAccel=-1) -> Rect + + Draw *text* and an image (which may be ``wx.NullBitmap`` to skip + drawing it) within the specified rectangle, abiding by the alignment + flags. Will additionally emphasize the character at *indexAccel* if + it is not -1. Returns the bounding rectangle. """ return _gdi_.DC_DrawImageLabel(*args, **kwargs) def DrawSpline(*args, **kwargs): - """DrawSpline(self, int points, Point points_array)""" + """ + DrawSpline(self, List points) + + Draws a spline between all given control points, (a list of `wx.Point` + objects) using the current pen. The spline is drawn using a series of + lines, using an algorithm taken from the X drawing program 'XFIG'. + """ return _gdi_.DC_DrawSpline(*args, **kwargs) def Clear(*args, **kwargs): - """Clear(self)""" + """ + Clear(self) + + Clears the device context using the current background brush. + """ return _gdi_.DC_Clear(*args, **kwargs) def StartDoc(*args, **kwargs): - """StartDoc(self, String message) -> bool""" + """ + StartDoc(self, String message) -> bool + + Starts a document (only relevant when outputting to a + printer). *Message* is a message to show whilst printing. + """ return _gdi_.DC_StartDoc(*args, **kwargs) def EndDoc(*args, **kwargs): - """EndDoc(self)""" + """ + EndDoc(self) + + Ends a document (only relevant when outputting to a printer). + """ return _gdi_.DC_EndDoc(*args, **kwargs) def StartPage(*args, **kwargs): - """StartPage(self)""" + """ + StartPage(self) + + Starts a document page (only relevant when outputting to a printer). + """ return _gdi_.DC_StartPage(*args, **kwargs) def EndPage(*args, **kwargs): - """EndPage(self)""" + """ + EndPage(self) + + Ends a document page (only relevant when outputting to a printer). + """ return _gdi_.DC_EndPage(*args, **kwargs) def SetFont(*args, **kwargs): - """SetFont(self, Font font)""" + """ + SetFont(self, Font font) + + Sets the current font for the DC. It must be a valid font, in + particular you should not pass ``wx.NullFont`` to this method. + """ return _gdi_.DC_SetFont(*args, **kwargs) def SetPen(*args, **kwargs): - """SetPen(self, Pen pen)""" + """ + SetPen(self, Pen pen) + + Sets the current pen for the DC. + + If the argument is ``wx.NullPen``, the current pen is selected out of the + device context, and the original pen restored. + """ return _gdi_.DC_SetPen(*args, **kwargs) def SetBrush(*args, **kwargs): - """SetBrush(self, Brush brush)""" + """ + SetBrush(self, Brush brush) + + Sets the current brush for the DC. + + If the argument is ``wx.NullBrush``, the current brush is selected out + of the device context, and the original brush restored, allowing the + current brush to be destroyed safely. + """ return _gdi_.DC_SetBrush(*args, **kwargs) def SetBackground(*args, **kwargs): - """SetBackground(self, Brush brush)""" + """ + SetBackground(self, Brush brush) + + Sets the current background brush for the DC. + """ return _gdi_.DC_SetBackground(*args, **kwargs) def SetBackgroundMode(*args, **kwargs): - """SetBackgroundMode(self, int mode)""" + """ + SetBackgroundMode(self, int mode) + + *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting + determines whether text will be drawn with a background colour or + not. + """ return _gdi_.DC_SetBackgroundMode(*args, **kwargs) def SetPalette(*args, **kwargs): - """SetPalette(self, Palette palette)""" - return _gdi_.DC_SetPalette(*args, **kwargs) - - def SetClippingRegionXY(*args, **kwargs): - """SetClippingRegionXY(self, int x, int y, int width, int height)""" - return _gdi_.DC_SetClippingRegionXY(*args, **kwargs) - - def SetClippingRegion(*args, **kwargs): - """SetClippingRegion(self, Point pt, Size sz)""" - return _gdi_.DC_SetClippingRegion(*args, **kwargs) - - def SetClippingRect(*args, **kwargs): - """SetClippingRect(self, Rect rect)""" - return _gdi_.DC_SetClippingRect(*args, **kwargs) + """ + SetPalette(self, Palette palette) - def SetClippingRegionAsRegion(*args, **kwargs): - """SetClippingRegionAsRegion(self, Region region)""" - return _gdi_.DC_SetClippingRegionAsRegion(*args, **kwargs) + If this is a window DC or memory DC, assigns the given palette to the + window or bitmap associated with the DC. If the argument is + ``wx.NullPalette``, the current palette is selected out of the device + context, and the original palette restored. + """ + return _gdi_.DC_SetPalette(*args, **kwargs) def DestroyClippingRegion(*args, **kwargs): - """DestroyClippingRegion(self)""" + """ + DestroyClippingRegion(self) + + Destroys the current clipping region so that none of the DC is + clipped. + """ return _gdi_.DC_DestroyClippingRegion(*args, **kwargs) def GetClippingBox(*args, **kwargs): - """GetClippingBox() -> (x, y, width, height)""" + """ + GetClippingBox() -> (x, y, width, height) + + Gets the rectangle surrounding the current clipping region. + """ return _gdi_.DC_GetClippingBox(*args, **kwargs) def GetClippingRect(*args, **kwargs): - """GetClippingRect(self) -> Rect""" + """ + GetClippingRect(self) -> Rect + + Gets the rectangle surrounding the current clipping region. + """ return _gdi_.DC_GetClippingRect(*args, **kwargs) def GetCharHeight(*args, **kwargs): - """GetCharHeight(self) -> int""" + """ + GetCharHeight(self) -> int + + Gets the character height of the currently set font. + """ return _gdi_.DC_GetCharHeight(*args, **kwargs) def GetCharWidth(*args, **kwargs): - """GetCharWidth(self) -> int""" + """ + GetCharWidth(self) -> int + + Gets the average character width of the currently set font. + """ return _gdi_.DC_GetCharWidth(*args, **kwargs) def GetTextExtent(*args, **kwargs): """ GetTextExtent(wxString string) -> (width, height) - Get the width and height of the text using the current font. - Only works for single line strings. + Get the width and height of the text using the current font. Only + works for single line strings. """ return _gdi_.DC_GetTextExtent(*args, **kwargs) @@ -2688,30 +3673,50 @@ class DC(_core.Object): GetFullTextExtent(wxString string, Font font=None) -> (width, height, descent, externalLeading) - Get the width, height, decent and leading of the text using the current or specified font. - Only works for single line strings. + Get the width, height, decent and leading of the text using the + current or specified font. Only works for single line strings. """ return _gdi_.DC_GetFullTextExtent(*args, **kwargs) def GetMultiLineTextExtent(*args, **kwargs): """ GetMultiLineTextExtent(wxString string, Font font=None) -> - (width, height, descent, externalLeading) + (width, height, lineHeight) - Get the width, height, decent and leading of the text using the current or specified font. - Works for single as well as multi-line strings. + Get the width, height, and line height of the text using the + current or specified font. Works for single as well as multi-line + strings. """ return _gdi_.DC_GetMultiLineTextExtent(*args, **kwargs) def GetPartialTextExtents(*args, **kwargs): - """GetPartialTextExtents(self, String text) -> wxArrayInt""" + """ + GetPartialTextExtents(self, text) -> [widths] + + Returns a list of integers such that each value is the distance in + pixels from the begining of text to the coresponding character of + *text*. The generic version simply builds a running total of the widths + of each character using GetTextExtent, however if the various + platforms have a native API function that is faster or more accurate + than the generic implementation then it will be used instead. + """ return _gdi_.DC_GetPartialTextExtents(*args, **kwargs) def GetSize(*args, **kwargs): """ GetSize(self) -> Size - Get the DC size in device units. + This gets the horizontal and vertical resolution in device units. It + can be used to scale graphics to fit the page. For example, if *maxX* + and *maxY* represent the maximum horizontal and vertical 'pixel' values + used in your application, the following code will scale the graphic to + fit on the printer page:: + + w, h = dc.GetSize() + scaleX = maxX*1.0 / w + scaleY = maxY*1.0 / h + dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY)) + """ return _gdi_.DC_GetSize(*args, **kwargs) @@ -2719,7 +3724,17 @@ class DC(_core.Object): """ GetSizeTuple() -> (width, height) - Get the DC size in device units. + This gets the horizontal and vertical resolution in device units. It + can be used to scale graphics to fit the page. For example, if *maxX* + and *maxY* represent the maximum horizontal and vertical 'pixel' values + used in your application, the following code will scale the graphic to + fit on the printer page:: + + w, h = dc.GetSize() + scaleX = maxX*1.0 / w + scaleY = maxY*1.0 / h + dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY)) + """ return _gdi_.DC_GetSizeTuple(*args, **kwargs) @@ -2740,35 +3755,79 @@ class DC(_core.Object): return _gdi_.DC_GetSizeMMTuple(*args, **kwargs) def DeviceToLogicalX(*args, **kwargs): - """DeviceToLogicalX(self, int x) -> int""" + """ + DeviceToLogicalX(self, int x) -> int + + Convert device X coordinate to logical coordinate, using the current + mapping mode. + """ return _gdi_.DC_DeviceToLogicalX(*args, **kwargs) def DeviceToLogicalY(*args, **kwargs): - """DeviceToLogicalY(self, int y) -> int""" + """ + DeviceToLogicalY(self, int y) -> int + + Converts device Y coordinate to logical coordinate, using the current + mapping mode. + """ return _gdi_.DC_DeviceToLogicalY(*args, **kwargs) def DeviceToLogicalXRel(*args, **kwargs): - """DeviceToLogicalXRel(self, int x) -> int""" + """ + DeviceToLogicalXRel(self, int x) -> int + + Convert device X coordinate to relative logical coordinate, using the + current mapping mode but ignoring the x axis orientation. Use this + function for converting a width, for example. + """ return _gdi_.DC_DeviceToLogicalXRel(*args, **kwargs) def DeviceToLogicalYRel(*args, **kwargs): - """DeviceToLogicalYRel(self, int y) -> int""" + """ + DeviceToLogicalYRel(self, int y) -> int + + Convert device Y coordinate to relative logical coordinate, using the + current mapping mode but ignoring the y axis orientation. Use this + function for converting a height, for example. + """ return _gdi_.DC_DeviceToLogicalYRel(*args, **kwargs) def LogicalToDeviceX(*args, **kwargs): - """LogicalToDeviceX(self, int x) -> int""" + """ + LogicalToDeviceX(self, int x) -> int + + Converts logical X coordinate to device coordinate, using the current + mapping mode. + """ return _gdi_.DC_LogicalToDeviceX(*args, **kwargs) def LogicalToDeviceY(*args, **kwargs): - """LogicalToDeviceY(self, int y) -> int""" + """ + LogicalToDeviceY(self, int y) -> int + + Converts logical Y coordinate to device coordinate, using the current + mapping mode. + """ return _gdi_.DC_LogicalToDeviceY(*args, **kwargs) def LogicalToDeviceXRel(*args, **kwargs): - """LogicalToDeviceXRel(self, int x) -> int""" + """ + LogicalToDeviceXRel(self, int x) -> int + + Converts logical X coordinate to relative device coordinate, using the + current mapping mode but ignoring the x axis orientation. Use this for + converting a width, for example. + """ return _gdi_.DC_LogicalToDeviceXRel(*args, **kwargs) def LogicalToDeviceYRel(*args, **kwargs): - """LogicalToDeviceYRel(self, int y) -> int""" + """ + LogicalToDeviceYRel(self, int y) -> int + + Converts logical Y coordinate to relative device coordinate, using the + current mapping mode but ignoring the y axis orientation. Use this for + converting a height, for example. + """ return _gdi_.DC_LogicalToDeviceYRel(*args, **kwargs) def CanDrawBitmap(*args, **kwargs): @@ -2780,67 +3839,146 @@ class DC(_core.Object): return _gdi_.DC_CanGetTextExtent(*args, **kwargs) def GetDepth(*args, **kwargs): - """GetDepth(self) -> int""" + """ + GetDepth(self) -> int + + Returns the colour depth of the DC. + """ return _gdi_.DC_GetDepth(*args, **kwargs) def GetPPI(*args, **kwargs): - """GetPPI(self) -> Size""" + """ + GetPPI(self) -> Size + + Resolution in pixels per inch + """ return _gdi_.DC_GetPPI(*args, **kwargs) - def Ok(*args, **kwargs): - """Ok(self) -> bool""" - return _gdi_.DC_Ok(*args, **kwargs) + def IsOk(*args, **kwargs): + """ + IsOk(self) -> bool + + Returns true if the DC is ok to use. + """ + return _gdi_.DC_IsOk(*args, **kwargs) + Ok = IsOk def GetBackgroundMode(*args, **kwargs): - """GetBackgroundMode(self) -> int""" + """ + GetBackgroundMode(self) -> int + + Returns the current background mode, either ``wx.SOLID`` or + ``wx.TRANSPARENT``. + """ return _gdi_.DC_GetBackgroundMode(*args, **kwargs) def GetBackground(*args, **kwargs): - """GetBackground(self) -> Brush""" + """ + GetBackground(self) -> Brush + + Gets the brush used for painting the background. + """ return _gdi_.DC_GetBackground(*args, **kwargs) def GetBrush(*args, **kwargs): - """GetBrush(self) -> Brush""" + """ + GetBrush(self) -> Brush + + Gets the current brush + """ return _gdi_.DC_GetBrush(*args, **kwargs) def GetFont(*args, **kwargs): - """GetFont(self) -> Font""" + """ + GetFont(self) -> Font + + Gets the current font + """ return _gdi_.DC_GetFont(*args, **kwargs) def GetPen(*args, **kwargs): - """GetPen(self) -> Pen""" + """ + GetPen(self) -> Pen + + Gets the current pen + """ return _gdi_.DC_GetPen(*args, **kwargs) def GetTextBackground(*args, **kwargs): - """GetTextBackground(self) -> Colour""" + """ + GetTextBackground(self) -> Colour + + Gets the current text background colour + """ return _gdi_.DC_GetTextBackground(*args, **kwargs) def GetTextForeground(*args, **kwargs): - """GetTextForeground(self) -> Colour""" + """ + GetTextForeground(self) -> Colour + + Gets the current text foreground colour + """ return _gdi_.DC_GetTextForeground(*args, **kwargs) def SetTextForeground(*args, **kwargs): - """SetTextForeground(self, Colour colour)""" + """ + SetTextForeground(self, Colour colour) + + Sets the current text foreground colour for the DC. + """ return _gdi_.DC_SetTextForeground(*args, **kwargs) def SetTextBackground(*args, **kwargs): - """SetTextBackground(self, Colour colour)""" + """ + SetTextBackground(self, Colour colour) + + Sets the current text background colour for the DC. + """ return _gdi_.DC_SetTextBackground(*args, **kwargs) def GetMapMode(*args, **kwargs): - """GetMapMode(self) -> int""" + """ + GetMapMode(self) -> int + + Gets the current *mapping mode* for the device context + """ return _gdi_.DC_GetMapMode(*args, **kwargs) def SetMapMode(*args, **kwargs): - """SetMapMode(self, int mode)""" + """ + SetMapMode(self, int mode) + + The *mapping mode* of the device context defines the unit of + measurement used to convert logical units to device units. The + mapping mode can be one of the following: + + ================ ============================================= + wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440 + of an inch. + wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch. + wx.MM_METRIC Each logical unit is 1 mm. + wx.MM_LOMETRIC Each logical unit is 1/10 of a mm. + wx.MM_TEXT Each logical unit is 1 pixel. + ================ ============================================= + + """ return _gdi_.DC_SetMapMode(*args, **kwargs) def GetUserScale(*args, **kwargs): - """GetUserScale() -> (xScale, yScale)""" + """ + GetUserScale(self) -> (xScale, yScale) + + Gets the current user scale factor (set by `SetUserScale`). + """ return _gdi_.DC_GetUserScale(*args, **kwargs) def SetUserScale(*args, **kwargs): - """SetUserScale(self, double x, double y)""" + """ + SetUserScale(self, double x, double y) + + Sets the user scaling factor, useful for applications which require + 'zooming'. + """ return _gdi_.DC_SetUserScale(*args, **kwargs) def GetLogicalScale(*args, **kwargs): @@ -2863,6 +4001,10 @@ class DC(_core.Object): """SetLogicalOrigin(self, int x, int y)""" return _gdi_.DC_SetLogicalOrigin(*args, **kwargs) + def SetLogicalOriginPoint(*args, **kwargs): + """SetLogicalOriginPoint(self, Point point)""" + return _gdi_.DC_SetLogicalOriginPoint(*args, **kwargs) + def GetDeviceOrigin(*args, **kwargs): """GetDeviceOrigin(self) -> Point""" return _gdi_.DC_GetDeviceOrigin(*args, **kwargs) @@ -2875,55 +4017,175 @@ class DC(_core.Object): """SetDeviceOrigin(self, int x, int y)""" return _gdi_.DC_SetDeviceOrigin(*args, **kwargs) + def SetDeviceOriginPoint(*args, **kwargs): + """SetDeviceOriginPoint(self, Point point)""" + return _gdi_.DC_SetDeviceOriginPoint(*args, **kwargs) + def SetAxisOrientation(*args, **kwargs): - """SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)""" + """ + SetAxisOrientation(self, bool xLeftRight, bool yBottomUp) + + Sets the x and y axis orientation (i.e., the direction from lowest to + highest values on the axis). The default orientation is the natural + orientation, e.g. x axis from left to right and y axis from bottom up. + """ return _gdi_.DC_SetAxisOrientation(*args, **kwargs) def GetLogicalFunction(*args, **kwargs): - """GetLogicalFunction(self) -> int""" + """ + GetLogicalFunction(self) -> int + + Gets the current logical function (set by `SetLogicalFunction`). + """ return _gdi_.DC_GetLogicalFunction(*args, **kwargs) def SetLogicalFunction(*args, **kwargs): - """SetLogicalFunction(self, int function)""" + """ + SetLogicalFunction(self, int function) + + Sets the current logical function for the device context. This + determines how a source pixel (from a pen or brush colour, or source + device context if using `Blit`) combines with a destination pixel in + the current device context. + + The possible values and their meaning in terms of source and + destination pixel values are as follows: + + ================ ========================== + wx.AND src AND dst + wx.AND_INVERT (NOT src) AND dst + wx.AND_REVERSE src AND (NOT dst) + wx.CLEAR 0 + wx.COPY src + wx.EQUIV (NOT src) XOR dst + wx.INVERT NOT dst + wx.NAND (NOT src) OR (NOT dst) + wx.NOR (NOT src) AND (NOT dst) + wx.NO_OP dst + wx.OR src OR dst + wx.OR_INVERT (NOT src) OR dst + wx.OR_REVERSE src OR (NOT dst) + wx.SET 1 + wx.SRC_INVERT NOT src + wx.XOR src XOR dst + ================ ========================== + + The default is wx.COPY, which simply draws with the current + colour. The others combine the current colour and the background using + a logical operation. wx.INVERT is commonly used for drawing rubber + bands or moving outlines, since drawing twice reverts to the original + colour. + + """ return _gdi_.DC_SetLogicalFunction(*args, **kwargs) - def SetOptimization(*args, **kwargs): - """SetOptimization(self, bool opt)""" - return _gdi_.DC_SetOptimization(*args, **kwargs) + def ComputeScaleAndOrigin(*args, **kwargs): + """ + ComputeScaleAndOrigin(self) + + Performs all necessary computations for given platform and context + type after each change of scale and origin parameters. Usually called + automatically internally after such changes. + + """ + return _gdi_.DC_ComputeScaleAndOrigin(*args, **kwargs) + + def SetOptimization(self, optimize): + pass + def GetOptimization(self): + return False - def GetOptimization(*args, **kwargs): - """GetOptimization(self) -> bool""" - return _gdi_.DC_GetOptimization(*args, **kwargs) + SetOptimization = wx._deprecated(SetOptimization) + GetOptimization = wx._deprecated(GetOptimization) def CalcBoundingBox(*args, **kwargs): - """CalcBoundingBox(self, int x, int y)""" + """ + CalcBoundingBox(self, int x, int y) + + Adds the specified point to the bounding box which can be retrieved + with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions. + """ return _gdi_.DC_CalcBoundingBox(*args, **kwargs) + def CalcBoundingBoxPoint(*args, **kwargs): + """ + CalcBoundingBoxPoint(self, Point point) + + Adds the specified point to the bounding box which can be retrieved + with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions. + """ + return _gdi_.DC_CalcBoundingBoxPoint(*args, **kwargs) + def ResetBoundingBox(*args, **kwargs): - """ResetBoundingBox(self)""" + """ + ResetBoundingBox(self) + + Resets the bounding box: after a call to this function, the bounding + box doesn't contain anything. + """ return _gdi_.DC_ResetBoundingBox(*args, **kwargs) def MinX(*args, **kwargs): - """MinX(self) -> int""" + """ + MinX(self) -> int + + Gets the minimum horizontal extent used in drawing commands so far. + """ return _gdi_.DC_MinX(*args, **kwargs) def MaxX(*args, **kwargs): - """MaxX(self) -> int""" + """ + MaxX(self) -> int + + Gets the maximum horizontal extent used in drawing commands so far. + """ return _gdi_.DC_MaxX(*args, **kwargs) def MinY(*args, **kwargs): - """MinY(self) -> int""" + """ + MinY(self) -> int + + Gets the minimum vertical extent used in drawing commands so far. + """ return _gdi_.DC_MinY(*args, **kwargs) def MaxY(*args, **kwargs): - """MaxY(self) -> int""" + """ + MaxY(self) -> int + + Gets the maximum vertical extent used in drawing commands so far. + """ return _gdi_.DC_MaxY(*args, **kwargs) def GetBoundingBox(*args, **kwargs): - """GetBoundingBox() -> (x1,y1, x2,y2)""" + """ + GetBoundingBox() -> (x1,y1, x2,y2) + + Returns the min and max points used in drawing commands so far. + """ return _gdi_.DC_GetBoundingBox(*args, **kwargs) - def __nonzero__(self): return self.Ok() + def __nonzero__(self): return self.IsOk() + def GetLayoutDirection(*args, **kwargs): + """ + GetLayoutDirection(self) -> int + + Get the layout direction (LTR or RTL)_ for this dc. On platforms + where RTL layout is supported, the return value will either be + ``wx.Layout_LeftToRight`` or ``wx.Layout_RightToLeft``. + ``wx.Layout_Default`` is returned if layout direction is not + supported. + """ + return _gdi_.DC_GetLayoutDirection(*args, **kwargs) + + def SetLayoutDirection(*args, **kwargs): + """ + SetLayoutDirection(self, int dir) + + Change the layout direction for this dc. + """ + return _gdi_.DC_SetLayoutDirection(*args, **kwargs) + def _DrawPointList(*args, **kwargs): """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject""" return _gdi_.DC__DrawPointList(*args, **kwargs) @@ -2952,6 +4214,16 @@ class DC(_core.Object): return _gdi_.DC__DrawTextList(*args, **kwargs) def DrawPointList(self, points, pens=None): + """ + Draw a list of points as quickly as possible. + + :param points: A sequence of 2-element sequences representing + each point to draw, (x,y). + :param pens: If None, then the current pen is used. If a + single pen then it will be used for all points. If + a list of pens then there should be one for each point + in points. + """ if pens is None: pens = [] elif isinstance(pens, wx.Pen): @@ -2962,6 +4234,16 @@ class DC(_core.Object): def DrawLineList(self, lines, pens=None): + """ + Draw a list of lines as quickly as possible. + + :param lines: A sequence of 4-element sequences representing + each line to draw, (x1,y1, x2,y2). + :param pens: If None, then the current pen is used. If a + single pen then it will be used for all lines. If + a list of pens then there should be one for each line + in lines. + """ if pens is None: pens = [] elif isinstance(pens, wx.Pen): @@ -2972,6 +4254,18 @@ class DC(_core.Object): def DrawRectangleList(self, rectangles, pens=None, brushes=None): + """ + Draw a list of rectangles as quickly as possible. + + :param rectangles: A sequence of 4-element sequences representing + each rectangle to draw, (x,y, w,h). + :param pens: If None, then the current pen is used. If a + single pen then it will be used for all rectangles. + If a list of pens then there should be one for each + rectangle in rectangles. + :param brushes: A brush or brushes to be used to fill the rectagles, + with similar semantics as the pens parameter. + """ if pens is None: pens = [] elif isinstance(pens, wx.Pen): @@ -2988,6 +4282,18 @@ class DC(_core.Object): def DrawEllipseList(self, ellipses, pens=None, brushes=None): + """ + Draw a list of ellipses as quickly as possible. + + :param ellipses: A sequence of 4-element sequences representing + each ellipse to draw, (x,y, w,h). + :param pens: If None, then the current pen is used. If a + single pen then it will be used for all ellipses. + If a list of pens then there should be one for each + ellipse in ellipses. + :param brushes: A brush or brushes to be used to fill the ellipses, + with similar semantics as the pens parameter. + """ if pens is None: pens = [] elif isinstance(pens, wx.Pen): @@ -3004,8 +4310,20 @@ class DC(_core.Object): def DrawPolygonList(self, polygons, pens=None, brushes=None): - ## Note: This does not currently support fill style or offset - ## you can always use the non-List version if need be. + """ + Draw a list of polygons, each of which is a list of points. + + :param polygons: A sequence of sequences of sequences. + [[(x1,y1),(x2,y2),(x3,y3)...], + [(x1,y1),(x2,y2),(x3,y3)...]] + + :param pens: If None, then the current pen is used. If a + single pen then it will be used for all polygons. + If a list of pens then there should be one for each + polygon. + :param brushes: A brush or brushes to be used to fill the polygons, + with similar semantics as the pens parameter. + """ if pens is None: pens = [] elif isinstance(pens, wx.Pen): @@ -3021,10 +4339,20 @@ class DC(_core.Object): return self._DrawPolygonList(polygons, pens, brushes) - def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None, fonts = None): - ## NOTE: this does not currently support changing the font - ## Make sure you set Background mode to wxSolid (DC.SetBackgroundMode) - ## If you want backgounds to do anything. + def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None): + """ + Draw a list of strings using a list of coordinants for positioning each string. + + :param textList: A list of strings + :param coords: A list of (x,y) positions + :param foregrounds: A list of `wx.Colour` objects to use for the + foregrounds of the strings. + :param backgrounds: A list of `wx.Colour` objects to use for the + backgrounds of the strings. + + NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode) + If you want backgrounds to do anything. + """ if type(textList) == type(''): textList = [textList] elif len(textList) != len(coords): @@ -3043,872 +4371,3196 @@ class DC(_core.Object): raise ValueError('backgrounds and coords must have same length') return self._DrawTextList(textList, coords, foregrounds, backgrounds) - -class DCPtr(DC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = DC -_gdi_.DC_swigregister(DCPtr) + Background = property(GetBackground,SetBackground,doc="See `GetBackground` and `SetBackground`") + BackgroundMode = property(GetBackgroundMode,SetBackgroundMode,doc="See `GetBackgroundMode` and `SetBackgroundMode`") + BoundingBox = property(GetBoundingBox,doc="See `GetBoundingBox`") + Brush = property(GetBrush,SetBrush,doc="See `GetBrush` and `SetBrush`") + CharHeight = property(GetCharHeight,doc="See `GetCharHeight`") + CharWidth = property(GetCharWidth,doc="See `GetCharWidth`") + ClippingBox = property(GetClippingBox,doc="See `GetClippingBox`") + ClippingRect = property(GetClippingRect,SetClippingRect,doc="See `GetClippingRect` and `SetClippingRect`") + Depth = property(GetDepth,doc="See `GetDepth`") + DeviceOrigin = property(GetDeviceOrigin,SetDeviceOrigin,doc="See `GetDeviceOrigin` and `SetDeviceOrigin`") + Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`") + FullTextExtent = property(GetFullTextExtent,doc="See `GetFullTextExtent`") + LogicalFunction = property(GetLogicalFunction,SetLogicalFunction,doc="See `GetLogicalFunction` and `SetLogicalFunction`") + LogicalOrigin = property(GetLogicalOrigin,SetLogicalOrigin,doc="See `GetLogicalOrigin` and `SetLogicalOrigin`") + LogicalScale = property(GetLogicalScale,SetLogicalScale,doc="See `GetLogicalScale` and `SetLogicalScale`") + MapMode = property(GetMapMode,SetMapMode,doc="See `GetMapMode` and `SetMapMode`") + MultiLineTextExtent = property(GetMultiLineTextExtent,doc="See `GetMultiLineTextExtent`") + Optimization = property(GetOptimization,SetOptimization,doc="See `GetOptimization` and `SetOptimization`") + PPI = property(GetPPI,doc="See `GetPPI`") + PartialTextExtents = property(GetPartialTextExtents,doc="See `GetPartialTextExtents`") + Pen = property(GetPen,SetPen,doc="See `GetPen` and `SetPen`") + Pixel = property(GetPixel,doc="See `GetPixel`") + PixelPoint = property(GetPixelPoint,doc="See `GetPixelPoint`") + Size = property(GetSize,doc="See `GetSize`") + SizeMM = property(GetSizeMM,doc="See `GetSizeMM`") + TextBackground = property(GetTextBackground,SetTextBackground,doc="See `GetTextBackground` and `SetTextBackground`") + TextExtent = property(GetTextExtent,doc="See `GetTextExtent`") + TextForeground = property(GetTextForeground,SetTextForeground,doc="See `GetTextForeground` and `SetTextForeground`") + UserScale = property(GetUserScale,SetUserScale,doc="See `GetUserScale` and `SetUserScale`") + LayoutDirection = property(GetLayoutDirection,SetLayoutDirection) +_gdi_.DC_swigregister(DC) #--------------------------------------------------------------------------- -class MemoryDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxMemoryDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self) -> MemoryDC""" - newobj = _gdi_.new_MemoryDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def SelectObject(*args, **kwargs): - """SelectObject(self, Bitmap bitmap)""" - return _gdi_.MemoryDC_SelectObject(*args, **kwargs) +class DCTextColourChanger(object): + """ + wx.DCTextColourChanger can be used to temporarily change the DC text + colour and restore it automatically when the object goes out of scope + """ + 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, DC dc, Colour col) -> DCTextColourChanger + wx.DCTextColourChanger can be used to temporarily change the DC text + colour and restore it automatically when the object goes out of scope + """ + _gdi_.DCTextColourChanger_swiginit(self,_gdi_.new_DCTextColourChanger(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_DCTextColourChanger + __del__ = lambda self : None; +_gdi_.DCTextColourChanger_swigregister(DCTextColourChanger) -class MemoryDCPtr(MemoryDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = MemoryDC -_gdi_.MemoryDC_swigregister(MemoryDCPtr) +class DCPenChanger(object): + """ + wx.DCPenChanger can be used to temporarily change the DC pen and + restore it automatically when the object goes out of scope + """ + 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, DC dc, Pen pen) -> DCPenChanger -def MemoryDCFromDC(*args, **kwargs): - """MemoryDCFromDC(DC oldDC) -> MemoryDC""" - val = _gdi_.new_MemoryDCFromDC(*args, **kwargs) - val.thisown = 1 - return val + wx.DCPenChanger can be used to temporarily change the DC pen and + restore it automatically when the object goes out of scope + """ + _gdi_.DCPenChanger_swiginit(self,_gdi_.new_DCPenChanger(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_DCPenChanger + __del__ = lambda self : None; +_gdi_.DCPenChanger_swigregister(DCPenChanger) -#--------------------------------------------------------------------------- +class DCBrushChanger(object): + """ + wx.DCBrushChanger can be used to temporarily change the DC brush and + restore it automatically when the object goes out of scope + """ + 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, DC dc, Brush brush) -> DCBrushChanger -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): + wx.DCBrushChanger can be used to temporarily change the DC brush and + restore it automatically when the object goes out of scope """ - __init__(self, DC dc, Bitmap buffer) -> BufferedDC - __init__(self, DC dc, Size area) -> BufferedDC + _gdi_.DCBrushChanger_swiginit(self,_gdi_.new_DCBrushChanger(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_DCBrushChanger + __del__ = lambda self : None; +_gdi_.DCBrushChanger_swigregister(DCBrushChanger) + +class DCClipper(object): + """ + wx.wxDCClipper sets the DC's clipping region when it is constructed, + and then automatically destroys the clipping region when the clipper + goes out of scope. + """ + 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): """ - 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 + __init__(self, DC dc, Region r) -> DCClipper + __init__(self, DC dc, Rect r) -> DCClipper + __init__(self, DC dc, int x, int y, int w, int h) -> DCClipper - def __del__(self, destroy=_gdi_.delete_BufferedDC): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass + wx.wxDCClipper sets the DC's clipping region when it is constructed, + and then automatically destroys the clipping region when the clipper + goes out of scope. + """ + _gdi_.DCClipper_swiginit(self,_gdi_.new_DCClipper(*args)) + __swig_destroy__ = _gdi_.delete_DCClipper + __del__ = lambda self : None; +_gdi_.DCClipper_swigregister(DCClipper) - def UnMask(*args, **kwargs): - """UnMask(self)""" - return _gdi_.BufferedDC_UnMask(*args, **kwargs) +#--------------------------------------------------------------------------- +class ScreenDC(DC): + """ + A wxScreenDC can be used to paint anywhere on the screen. This should + normally be constructed as a temporary stack object; don't store a + wxScreenDC object. -class BufferedDCPtr(BufferedDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = BufferedDC -_gdi_.BufferedDC_swigregister(BufferedDCPtr) + """ + 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) -> ScreenDC -def BufferedDCInternalBuffer(*args): - """BufferedDCInternalBuffer(DC dc, Size area) -> 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 + A wxScreenDC can be used to paint anywhere on the screen. This should + normally be constructed as a temporary stack object; don't store a + wxScreenDC object. -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__(self, Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC""" - newobj = _gdi_.new_BufferedPaintDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - -class BufferedPaintDCPtr(BufferedPaintDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = BufferedPaintDC -_gdi_.BufferedPaintDC_swigregister(BufferedPaintDCPtr) + """ + _gdi_.ScreenDC_swiginit(self,_gdi_.new_ScreenDC(*args, **kwargs)) + def StartDrawingOnTopWin(*args, **kwargs): + """ + StartDrawingOnTopWin(self, Window window) -> bool -#--------------------------------------------------------------------------- + Specify that the area of the screen to be drawn upon coincides with + the given window. -class ScreenDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxScreenDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self) -> ScreenDC""" - newobj = _gdi_.new_ScreenDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def StartDrawingOnTopWin(*args, **kwargs): - """StartDrawingOnTopWin(self, Window window) -> bool""" + :see: `EndDrawingOnTop` + """ return _gdi_.ScreenDC_StartDrawingOnTopWin(*args, **kwargs) def StartDrawingOnTop(*args, **kwargs): - """StartDrawingOnTop(self, Rect rect=None) -> bool""" - return _gdi_.ScreenDC_StartDrawingOnTop(*args, **kwargs) + """ + StartDrawingOnTop(self, Rect rect=None) -> bool - def EndDrawingOnTop(*args, **kwargs): - """EndDrawingOnTop(self) -> bool""" - return _gdi_.ScreenDC_EndDrawingOnTop(*args, **kwargs) + Specify that the area is the given rectangle, or the whole screen if + ``None`` is passed. + :see: `EndDrawingOnTop` + """ + return _gdi_.ScreenDC_StartDrawingOnTop(*args, **kwargs) -class ScreenDCPtr(ScreenDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = ScreenDC -_gdi_.ScreenDC_swigregister(ScreenDCPtr) + def EndDrawingOnTop(*args, **kwargs): + """ + EndDrawingOnTop(self) -> bool -#--------------------------------------------------------------------------- + Use this in conjunction with `StartDrawingOnTop` or + `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on + top of existing windows. Without this, some window systems (such as X) + only allow drawing to take place underneath other windows. -class ClientDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxClientDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, Window win) -> ClientDC""" - newobj = _gdi_.new_ClientDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - -class ClientDCPtr(ClientDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = ClientDC -_gdi_.ClientDC_swigregister(ClientDCPtr) + You might use this pair of functions when implementing a drag feature, + for example as in the `wx.SplitterWindow` implementation. -#--------------------------------------------------------------------------- + These functions are probably obsolete since the X implementations + allow drawing directly on the screen now. However, the fact that this + function allows the screen to be refreshed afterwards may be useful + to some applications. + """ + return _gdi_.ScreenDC_EndDrawingOnTop(*args, **kwargs) -class PaintDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxPaintDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, Window win) -> PaintDC""" - newobj = _gdi_.new_PaintDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - -class PaintDCPtr(PaintDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = PaintDC -_gdi_.PaintDC_swigregister(PaintDCPtr) +_gdi_.ScreenDC_swigregister(ScreenDC) #--------------------------------------------------------------------------- class WindowDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxWindowDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, Window win) -> WindowDC""" - newobj = _gdi_.new_WindowDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - -class WindowDCPtr(WindowDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = WindowDC -_gdi_.WindowDC_swigregister(WindowDCPtr) - -#--------------------------------------------------------------------------- + """ + A wx.WindowDC must be constructed if an application wishes to paint on + the whole area of a window (client and decorations). This should + normally be constructed as a temporary stack object; don't store a + wx.WindowDC object. + """ + 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, Window win) -> WindowDC -class MirrorDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxMirrorDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, DC dc, bool mirror) -> MirrorDC""" - newobj = _gdi_.new_MirrorDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - -class MirrorDCPtr(MirrorDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = MirrorDC -_gdi_.MirrorDC_swigregister(MirrorDCPtr) + Constructor. Pass the window on which you wish to paint. + """ + _gdi_.WindowDC_swiginit(self,_gdi_.new_WindowDC(*args, **kwargs)) +_gdi_.WindowDC_swigregister(WindowDC) #--------------------------------------------------------------------------- -class PostScriptDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxPostScriptDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, wxPrintData printData) -> PostScriptDC""" - newobj = _gdi_.new_PostScriptDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def GetPrintData(*args, **kwargs): - """GetPrintData(self) -> wxPrintData""" - return _gdi_.PostScriptDC_GetPrintData(*args, **kwargs) +class ClientDC(WindowDC): + """ + A wx.ClientDC must be constructed if an application wishes to paint on + the client area of a window from outside an EVT_PAINT event. This should + normally be constructed as a temporary stack object; don't store a + wx.ClientDC object long term. - def SetPrintData(*args, **kwargs): - """SetPrintData(self, wxPrintData data)""" - return _gdi_.PostScriptDC_SetPrintData(*args, **kwargs) + To draw on a window from within an EVT_PAINT handler, construct a + `wx.PaintDC` object. - def SetResolution(*args, **kwargs): - """SetResolution(int ppi)""" - return _gdi_.PostScriptDC_SetResolution(*args, **kwargs) + To draw on the whole window including decorations, construct a + `wx.WindowDC` object (Windows only). - SetResolution = staticmethod(SetResolution) - def GetResolution(*args, **kwargs): - """GetResolution() -> int""" - return _gdi_.PostScriptDC_GetResolution(*args, **kwargs) + """ + 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, Window win) -> ClientDC - GetResolution = staticmethod(GetResolution) + Constructor. Pass the window on which you wish to paint. + """ + _gdi_.ClientDC_swiginit(self,_gdi_.new_ClientDC(*args, **kwargs)) +_gdi_.ClientDC_swigregister(ClientDC) -class PostScriptDCPtr(PostScriptDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = PostScriptDC -_gdi_.PostScriptDC_swigregister(PostScriptDCPtr) +#--------------------------------------------------------------------------- -def PostScriptDC_SetResolution(*args, **kwargs): - """PostScriptDC_SetResolution(int ppi)""" - return _gdi_.PostScriptDC_SetResolution(*args, **kwargs) +class PaintDC(ClientDC): + """ + A wx.PaintDC must be constructed if an application wishes to paint on + the client area of a window from within an EVT_PAINT event + handler. This should normally be constructed as a temporary stack + object; don't store a wx.PaintDC object. If you have an EVT_PAINT + handler, you **must** create a wx.PaintDC object within it even if you + don't actually use it. + + Using wx.PaintDC within EVT_PAINT handlers is important because it + automatically sets the clipping area to the damaged area of the + window. Attempts to draw outside this area do not appear. + + To draw on a window from outside EVT_PAINT handlers, construct a + `wx.ClientDC` object. + + """ + 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, Window win) -> PaintDC -def PostScriptDC_GetResolution(*args, **kwargs): - """PostScriptDC_GetResolution() -> int""" - return _gdi_.PostScriptDC_GetResolution(*args, **kwargs) + Constructor. Pass the window on which you wish to paint. + """ + _gdi_.PaintDC_swiginit(self,_gdi_.new_PaintDC(*args, **kwargs)) +_gdi_.PaintDC_swigregister(PaintDC) #--------------------------------------------------------------------------- -class MetaFile(_core.Object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxMetaFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, String filename=EmptyString) -> MetaFile""" - newobj = _gdi_.new_MetaFile(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - -class MetaFilePtr(MetaFile): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = MetaFile -_gdi_.MetaFile_swigregister(MetaFilePtr) +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:: -class MetaFileDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxMetaFileDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): + 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, String filename=EmptyString, int width=0, int height=0, - String description=EmptyString) -> MetaFileDC + __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): """ - newobj = _gdi_.new_MetaFileDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown + SelectObject(self, Bitmap bitmap) -class MetaFileDCPtr(MetaFileDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = MetaFileDC -_gdi_.MetaFileDC_swigregister(MetaFileDCPtr) + 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. -class PrinterDC(DC): - def __repr__(self): - return "<%s.%s; proxy of C++ wxPrinterDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, wxPrintData printData) -> PrinterDC""" - newobj = _gdi_.new_PrinterDC(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - -class PrinterDCPtr(PrinterDC): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = PrinterDC -_gdi_.PrinterDC_swigregister(PrinterDCPtr) - -class DC_old(DC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = DC.FloodFillXY - GetPixel = DC.GetPixelXY - DrawLine = DC.DrawLineXY - CrossHair = DC.CrossHairXY - DrawArc = DC.DrawArcXY - DrawCheckMark = DC.DrawCheckMarkXY - DrawEllipticArc = DC.DrawEllipticArcXY - DrawPoint = DC.DrawPointXY - DrawRectangle = DC.DrawRectangleXY - DrawRoundedRectangle = DC.DrawRoundedRectangleXY - DrawCircle = DC.DrawCircleXY - DrawEllipse = DC.DrawEllipseXY - DrawIcon = DC.DrawIconXY - DrawBitmap = DC.DrawBitmapXY - DrawText = DC.DrawTextXY - DrawRotatedText = DC.DrawRotatedTextXY - Blit = DC.BlitXY - -class MemoryDC_old(MemoryDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = MemoryDC.FloodFillXY - GetPixel = MemoryDC.GetPixelXY - DrawLine = MemoryDC.DrawLineXY - CrossHair = MemoryDC.CrossHairXY - DrawArc = MemoryDC.DrawArcXY - DrawCheckMark = MemoryDC.DrawCheckMarkXY - DrawEllipticArc = MemoryDC.DrawEllipticArcXY - DrawPoint = MemoryDC.DrawPointXY - DrawRectangle = MemoryDC.DrawRectangleXY - DrawRoundedRectangle = MemoryDC.DrawRoundedRectangleXY - DrawCircle = MemoryDC.DrawCircleXY - DrawEllipse = MemoryDC.DrawEllipseXY - DrawIcon = MemoryDC.DrawIconXY - DrawBitmap = MemoryDC.DrawBitmapXY - DrawText = MemoryDC.DrawTextXY - DrawRotatedText = MemoryDC.DrawRotatedTextXY - Blit = MemoryDC.BlitXY - -class BufferedDC_old(BufferedDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = BufferedDC.FloodFillXY - GetPixel = BufferedDC.GetPixelXY - DrawLine = BufferedDC.DrawLineXY - CrossHair = BufferedDC.CrossHairXY - DrawArc = BufferedDC.DrawArcXY - DrawCheckMark = BufferedDC.DrawCheckMarkXY - DrawEllipticArc = BufferedDC.DrawEllipticArcXY - DrawPoint = BufferedDC.DrawPointXY - DrawRectangle = BufferedDC.DrawRectangleXY - DrawRoundedRectangle = BufferedDC.DrawRoundedRectangleXY - DrawCircle = BufferedDC.DrawCircleXY - DrawEllipse = BufferedDC.DrawEllipseXY - DrawIcon = BufferedDC.DrawIconXY - DrawBitmap = BufferedDC.DrawBitmapXY - DrawText = BufferedDC.DrawTextXY - DrawRotatedText = BufferedDC.DrawRotatedTextXY - Blit = BufferedDC.BlitXY - -class BufferedPaintDC_old(BufferedPaintDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = BufferedPaintDC.FloodFillXY - GetPixel = BufferedPaintDC.GetPixelXY - DrawLine = BufferedPaintDC.DrawLineXY - CrossHair = BufferedPaintDC.CrossHairXY - DrawArc = BufferedPaintDC.DrawArcXY - DrawCheckMark = BufferedPaintDC.DrawCheckMarkXY - DrawEllipticArc = BufferedPaintDC.DrawEllipticArcXY - DrawPoint = BufferedPaintDC.DrawPointXY - DrawRectangle = BufferedPaintDC.DrawRectangleXY - DrawRoundedRectangle = BufferedPaintDC.DrawRoundedRectangleXY - DrawCircle = BufferedPaintDC.DrawCircleXY - DrawEllipse = BufferedPaintDC.DrawEllipseXY - DrawIcon = BufferedPaintDC.DrawIconXY - DrawBitmap = BufferedPaintDC.DrawBitmapXY - DrawText = BufferedPaintDC.DrawTextXY - DrawRotatedText = BufferedPaintDC.DrawRotatedTextXY - Blit = BufferedPaintDC.BlitXY - -class ScreenDC_old(ScreenDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = ScreenDC.FloodFillXY - GetPixel = ScreenDC.GetPixelXY - DrawLine = ScreenDC.DrawLineXY - CrossHair = ScreenDC.CrossHairXY - DrawArc = ScreenDC.DrawArcXY - DrawCheckMark = ScreenDC.DrawCheckMarkXY - DrawEllipticArc = ScreenDC.DrawEllipticArcXY - DrawPoint = ScreenDC.DrawPointXY - DrawRectangle = ScreenDC.DrawRectangleXY - DrawRoundedRectangle = ScreenDC.DrawRoundedRectangleXY - DrawCircle = ScreenDC.DrawCircleXY - DrawEllipse = ScreenDC.DrawEllipseXY - DrawIcon = ScreenDC.DrawIconXY - DrawBitmap = ScreenDC.DrawBitmapXY - DrawText = ScreenDC.DrawTextXY - DrawRotatedText = ScreenDC.DrawRotatedTextXY - Blit = ScreenDC.BlitXY - -class ClientDC_old(ClientDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = ClientDC.FloodFillXY - GetPixel = ClientDC.GetPixelXY - DrawLine = ClientDC.DrawLineXY - CrossHair = ClientDC.CrossHairXY - DrawArc = ClientDC.DrawArcXY - DrawCheckMark = ClientDC.DrawCheckMarkXY - DrawEllipticArc = ClientDC.DrawEllipticArcXY - DrawPoint = ClientDC.DrawPointXY - DrawRectangle = ClientDC.DrawRectangleXY - DrawRoundedRectangle = ClientDC.DrawRoundedRectangleXY - DrawCircle = ClientDC.DrawCircleXY - DrawEllipse = ClientDC.DrawEllipseXY - DrawIcon = ClientDC.DrawIconXY - DrawBitmap = ClientDC.DrawBitmapXY - DrawText = ClientDC.DrawTextXY - DrawRotatedText = ClientDC.DrawRotatedTextXY - Blit = ClientDC.BlitXY - -class PaintDC_old(PaintDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = PaintDC.FloodFillXY - GetPixel = PaintDC.GetPixelXY - DrawLine = PaintDC.DrawLineXY - CrossHair = PaintDC.CrossHairXY - DrawArc = PaintDC.DrawArcXY - DrawCheckMark = PaintDC.DrawCheckMarkXY - DrawEllipticArc = PaintDC.DrawEllipticArcXY - DrawPoint = PaintDC.DrawPointXY - DrawRectangle = PaintDC.DrawRectangleXY - DrawRoundedRectangle = PaintDC.DrawRoundedRectangleXY - DrawCircle = PaintDC.DrawCircleXY - DrawEllipse = PaintDC.DrawEllipseXY - DrawIcon = PaintDC.DrawIconXY - DrawBitmap = PaintDC.DrawBitmapXY - DrawText = PaintDC.DrawTextXY - DrawRotatedText = PaintDC.DrawRotatedTextXY - Blit = PaintDC.BlitXY - -class WindowDC_old(WindowDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = WindowDC.FloodFillXY - GetPixel = WindowDC.GetPixelXY - DrawLine = WindowDC.DrawLineXY - CrossHair = WindowDC.CrossHairXY - DrawArc = WindowDC.DrawArcXY - DrawCheckMark = WindowDC.DrawCheckMarkXY - DrawEllipticArc = WindowDC.DrawEllipticArcXY - DrawPoint = WindowDC.DrawPointXY - DrawRectangle = WindowDC.DrawRectangleXY - DrawRoundedRectangle = WindowDC.DrawRoundedRectangleXY - DrawCircle = WindowDC.DrawCircleXY - DrawEllipse = WindowDC.DrawEllipseXY - DrawIcon = WindowDC.DrawIconXY - DrawBitmap = WindowDC.DrawBitmapXY - DrawText = WindowDC.DrawTextXY - DrawRotatedText = WindowDC.DrawRotatedTextXY - Blit = WindowDC.BlitXY - -class MirrorDC_old(MirrorDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = MirrorDC.FloodFillXY - GetPixel = MirrorDC.GetPixelXY - DrawLine = MirrorDC.DrawLineXY - CrossHair = MirrorDC.CrossHairXY - DrawArc = MirrorDC.DrawArcXY - DrawCheckMark = MirrorDC.DrawCheckMarkXY - DrawEllipticArc = MirrorDC.DrawEllipticArcXY - DrawPoint = MirrorDC.DrawPointXY - DrawRectangle = MirrorDC.DrawRectangleXY - DrawRoundedRectangle = MirrorDC.DrawRoundedRectangleXY - DrawCircle = MirrorDC.DrawCircleXY - DrawEllipse = MirrorDC.DrawEllipseXY - DrawIcon = MirrorDC.DrawIconXY - DrawBitmap = MirrorDC.DrawBitmapXY - DrawText = MirrorDC.DrawTextXY - DrawRotatedText = MirrorDC.DrawRotatedTextXY - Blit = MirrorDC.BlitXY - -class PostScriptDC_old(PostScriptDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = PostScriptDC.FloodFillXY - GetPixel = PostScriptDC.GetPixelXY - DrawLine = PostScriptDC.DrawLineXY - CrossHair = PostScriptDC.CrossHairXY - DrawArc = PostScriptDC.DrawArcXY - DrawCheckMark = PostScriptDC.DrawCheckMarkXY - DrawEllipticArc = PostScriptDC.DrawEllipticArcXY - DrawPoint = PostScriptDC.DrawPointXY - DrawRectangle = PostScriptDC.DrawRectangleXY - DrawRoundedRectangle = PostScriptDC.DrawRoundedRectangleXY - DrawCircle = PostScriptDC.DrawCircleXY - DrawEllipse = PostScriptDC.DrawEllipseXY - DrawIcon = PostScriptDC.DrawIconXY - DrawBitmap = PostScriptDC.DrawBitmapXY - DrawText = PostScriptDC.DrawTextXY - DrawRotatedText = PostScriptDC.DrawRotatedTextXY - Blit = PostScriptDC.BlitXY - -class MetaFileDC_old(MetaFileDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = MetaFileDC.FloodFillXY - GetPixel = MetaFileDC.GetPixelXY - DrawLine = MetaFileDC.DrawLineXY - CrossHair = MetaFileDC.CrossHairXY - DrawArc = MetaFileDC.DrawArcXY - DrawCheckMark = MetaFileDC.DrawCheckMarkXY - DrawEllipticArc = MetaFileDC.DrawEllipticArcXY - DrawPoint = MetaFileDC.DrawPointXY - DrawRectangle = MetaFileDC.DrawRectangleXY - DrawRoundedRectangle = MetaFileDC.DrawRoundedRectangleXY - DrawCircle = MetaFileDC.DrawCircleXY - DrawEllipse = MetaFileDC.DrawEllipseXY - DrawIcon = MetaFileDC.DrawIconXY - DrawBitmap = MetaFileDC.DrawBitmapXY - DrawText = MetaFileDC.DrawTextXY - DrawRotatedText = MetaFileDC.DrawRotatedTextXY - Blit = MetaFileDC.BlitXY - -class PrinterDC_old(PrinterDC): - """DC class that has methods with 2.4 compatible parameters.""" - FloodFill = PrinterDC.FloodFillXY - GetPixel = PrinterDC.GetPixelXY - DrawLine = PrinterDC.DrawLineXY - CrossHair = PrinterDC.CrossHairXY - DrawArc = PrinterDC.DrawArcXY - DrawCheckMark = PrinterDC.DrawCheckMarkXY - DrawEllipticArc = PrinterDC.DrawEllipticArcXY - DrawPoint = PrinterDC.DrawPointXY - DrawRectangle = PrinterDC.DrawRectangleXY - DrawRoundedRectangle = PrinterDC.DrawRoundedRectangleXY - DrawCircle = PrinterDC.DrawCircleXY - DrawEllipse = PrinterDC.DrawEllipseXY - DrawIcon = PrinterDC.DrawIconXY - DrawBitmap = PrinterDC.DrawBitmapXY - DrawText = PrinterDC.DrawTextXY - DrawRotatedText = PrinterDC.DrawRotatedTextXY - Blit = PrinterDC.BlitXY + 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) -IMAGELIST_DRAW_NORMAL = _gdi_.IMAGELIST_DRAW_NORMAL -IMAGELIST_DRAW_TRANSPARENT = _gdi_.IMAGELIST_DRAW_TRANSPARENT -IMAGELIST_DRAW_SELECTED = _gdi_.IMAGELIST_DRAW_SELECTED -IMAGELIST_DRAW_FOCUSED = _gdi_.IMAGELIST_DRAW_FOCUSED -IMAGE_LIST_NORMAL = _gdi_.IMAGE_LIST_NORMAL -IMAGE_LIST_SMALL = _gdi_.IMAGE_LIST_SMALL -IMAGE_LIST_STATE = _gdi_.IMAGE_LIST_STATE -class ImageList(_core.Object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxImageList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList""" - newobj = _gdi_.new_ImageList(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_ImageList): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass +_gdi_.MemoryDC_swigregister(MemoryDC) - def Add(*args, **kwargs): - """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int""" - return _gdi_.ImageList_Add(*args, **kwargs) +def MemoryDCFromDC(*args, **kwargs): + """ + MemoryDCFromDC(DC oldDC) -> MemoryDC - def AddWithColourMask(*args, **kwargs): - """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int""" - return _gdi_.ImageList_AddWithColourMask(*args, **kwargs) + Creates a DC that is compatible with the oldDC. + """ + val = _gdi_.new_MemoryDCFromDC(*args, **kwargs) + return val - def AddIcon(*args, **kwargs): - """AddIcon(self, Icon icon) -> int""" - return _gdi_.ImageList_AddIcon(*args, **kwargs) +#--------------------------------------------------------------------------- - def Replace(*args, **kwargs): - """Replace(self, int index, Bitmap bitmap) -> bool""" - return _gdi_.ImageList_Replace(*args, **kwargs) +BUFFER_VIRTUAL_AREA = _gdi_.BUFFER_VIRTUAL_AREA +BUFFER_CLIENT_AREA = _gdi_.BUFFER_CLIENT_AREA +class BufferedDC(MemoryDC): + """ + This simple class provides a simple way to avoid flicker: when drawing + on it, everything is in fact first drawn on an in-memory buffer (a + `wx.Bitmap`) and then copied to the screen only once, when this object + is destroyed. You can either provide a buffer bitmap yourself, and + reuse it the next time something needs painted, or you can let the + buffered DC create and provide a buffer bitmap itself. + + Buffered DCs can be used in the same way as any other device context. + wx.BufferedDC itself typically replaces `wx.ClientDC`, if you want to + use it in your EVT_PAINT handler, you should look at + `wx.BufferedPaintDC`. You can also use a wx.BufferedDC without + providing a target DC. In this case the operations done on the dc + will only be written to the buffer bitmap and *not* to any window, so + you will want to have provided the buffer bitmap and then reuse it + when it needs painted to the window. + + Please note that GTK+ 2.0 and OS X provide double buffering themselves + natively. You may want to use `wx.Window.IsDoubleBuffered` to + determine whether you need to use buffering or not, or use + `wx.AutoBufferedPaintDC` to avoid needless double buffering on systems + that already do it automatically. - def Draw(*args, **kwargs): + + + """ + 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): """ - Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL, - bool solidBackground=False) -> bool + __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC + __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC + + Constructs a buffered DC. """ - return _gdi_.ImageList_Draw(*args, **kwargs) + _gdi_.BufferedDC_swiginit(self,_gdi_.new_BufferedDC(*args)) + # 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] - def GetImageCount(*args, **kwargs): - """GetImageCount(self) -> int""" - return _gdi_.ImageList_GetImageCount(*args, **kwargs) - def Remove(*args, **kwargs): - """Remove(self, int index) -> bool""" - return _gdi_.ImageList_Remove(*args, **kwargs) + __swig_destroy__ = _gdi_.delete_BufferedDC + __del__ = lambda self : None; + def UnMask(*args, **kwargs): + """ + UnMask(self) - def RemoveAll(*args, **kwargs): - """RemoveAll(self) -> bool""" - return _gdi_.ImageList_RemoveAll(*args, **kwargs) + Blits the buffer to the dc, and detaches the dc from the buffer (so it + can be effectively used once only). This is usually only called in + the destructor. + """ + return _gdi_.BufferedDC_UnMask(*args, **kwargs) - def GetSize(*args, **kwargs): - """GetSize() -> (width,height)""" - return _gdi_.ImageList_GetSize(*args, **kwargs) + def SetStyle(*args, **kwargs): + """SetStyle(self, int style)""" + return _gdi_.BufferedDC_SetStyle(*args, **kwargs) + def GetStyle(*args, **kwargs): + """GetStyle(self) -> int""" + return _gdi_.BufferedDC_GetStyle(*args, **kwargs) -class ImageListPtr(ImageList): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = ImageList -_gdi_.ImageList_swigregister(ImageListPtr) +_gdi_.BufferedDC_swigregister(BufferedDC) -#--------------------------------------------------------------------------- +class BufferedPaintDC(BufferedDC): + """ + This is a subclass of `wx.BufferedDC` which can be used inside of an + EVT_PAINT event handler. Just create an object of this class instead + of `wx.PaintDC` and that's all you have to do to (mostly) avoid + flicker. The only thing to watch out for is that if you are using this + class together with `wx.ScrolledWindow`, you probably do **not** want + to call `wx.Window.PrepareDC` on it as it already does this internally + for the real underlying `wx.PaintDC`. -class PenList(_core.Object): - def __init__(self): raise RuntimeError, "No constructor defined" - def __repr__(self): - return "<%s.%s; proxy of C++ wxPenList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def AddPen(*args, **kwargs): - """AddPen(self, Pen pen)""" - return _gdi_.PenList_AddPen(*args, **kwargs) + If your window is already fully buffered in a `wx.Bitmap` then your + EVT_PAINT handler can be as simple as just creating a + ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window + automatically when it is destroyed. For example:: - def FindOrCreatePen(*args, **kwargs): - """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen""" - return _gdi_.PenList_FindOrCreatePen(*args, **kwargs) + def OnPaint(self, event): + dc = wx.BufferedPaintDC(self, self.buffer) - def RemovePen(*args, **kwargs): - """RemovePen(self, Pen pen)""" - return _gdi_.PenList_RemovePen(*args, **kwargs) - def GetCount(*args, **kwargs): - """GetCount(self) -> int""" - return _gdi_.PenList_GetCount(*args, **kwargs) + """ + 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, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC -class PenListPtr(PenList): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = PenList -_gdi_.PenList_swigregister(PenListPtr) -cvar = _gdi_.cvar -NORMAL_FONT = cvar.NORMAL_FONT -SMALL_FONT = cvar.SMALL_FONT -ITALIC_FONT = cvar.ITALIC_FONT -SWISS_FONT = cvar.SWISS_FONT -RED_PEN = cvar.RED_PEN -CYAN_PEN = cvar.CYAN_PEN -GREEN_PEN = cvar.GREEN_PEN -BLACK_PEN = cvar.BLACK_PEN -WHITE_PEN = cvar.WHITE_PEN -TRANSPARENT_PEN = cvar.TRANSPARENT_PEN -BLACK_DASHED_PEN = cvar.BLACK_DASHED_PEN -GREY_PEN = cvar.GREY_PEN -MEDIUM_GREY_PEN = cvar.MEDIUM_GREY_PEN -LIGHT_GREY_PEN = cvar.LIGHT_GREY_PEN -BLUE_BRUSH = cvar.BLUE_BRUSH -GREEN_BRUSH = cvar.GREEN_BRUSH -WHITE_BRUSH = cvar.WHITE_BRUSH -BLACK_BRUSH = cvar.BLACK_BRUSH -TRANSPARENT_BRUSH = cvar.TRANSPARENT_BRUSH -CYAN_BRUSH = cvar.CYAN_BRUSH -RED_BRUSH = cvar.RED_BRUSH -GREY_BRUSH = cvar.GREY_BRUSH -MEDIUM_GREY_BRUSH = cvar.MEDIUM_GREY_BRUSH -LIGHT_GREY_BRUSH = cvar.LIGHT_GREY_BRUSH -BLACK = cvar.BLACK -WHITE = cvar.WHITE -RED = cvar.RED -BLUE = cvar.BLUE -GREEN = cvar.GREEN -CYAN = cvar.CYAN -LIGHT_GREY = cvar.LIGHT_GREY -STANDARD_CURSOR = cvar.STANDARD_CURSOR -HOURGLASS_CURSOR = cvar.HOURGLASS_CURSOR -CROSS_CURSOR = cvar.CROSS_CURSOR -NullBitmap = cvar.NullBitmap -NullIcon = cvar.NullIcon -NullCursor = cvar.NullCursor -NullPen = cvar.NullPen -NullBrush = cvar.NullBrush -NullPalette = cvar.NullPalette -NullFont = cvar.NullFont -NullColour = cvar.NullColour + Create a buffered paint DC. As with `wx.BufferedDC`, you may either + provide the bitmap to be used for buffering or let this object create + one internally (in the latter case, the size of the client part of the + window is automatically used). + """ + _gdi_.BufferedPaintDC_swiginit(self,_gdi_.new_BufferedPaintDC(*args, **kwargs)) + if len(args) > 1: self.__bmp = args[1] -class BrushList(_core.Object): - def __init__(self): raise RuntimeError, "No constructor defined" - def __repr__(self): - return "<%s.%s; proxy of C++ wxBrushList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def AddBrush(*args, **kwargs): - """AddBrush(self, Brush brush)""" - return _gdi_.BrushList_AddBrush(*args, **kwargs) +_gdi_.BufferedPaintDC_swigregister(BufferedPaintDC) - def FindOrCreateBrush(*args, **kwargs): - """FindOrCreateBrush(self, Colour colour, int style) -> Brush""" - return _gdi_.BrushList_FindOrCreateBrush(*args, **kwargs) +#--------------------------------------------------------------------------- - def RemoveBrush(*args, **kwargs): - """RemoveBrush(self, Brush brush)""" - return _gdi_.BrushList_RemoveBrush(*args, **kwargs) +class AutoBufferedPaintDC(DC): + """ + If the current platform double buffers by default then this DC is the + same as a plain `wx.PaintDC`, otherwise it is a `wx.BufferedPaintDC`. - def GetCount(*args, **kwargs): - """GetCount(self) -> int""" - return _gdi_.BrushList_GetCount(*args, **kwargs) + :see: `wx.AutoBufferedPaintDCFactory` + """ + 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, Window win) -> AutoBufferedPaintDC -class BrushListPtr(BrushList): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = BrushList -_gdi_.BrushList_swigregister(BrushListPtr) + If the current platform double buffers by default then this DC is the + same as a plain `wx.PaintDC`, otherwise it is a `wx.BufferedPaintDC`. -class ColourDatabase(_core.Object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxColourDatabase instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self) -> ColourDatabase""" - newobj = _gdi_.new_ColourDatabase(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def __del__(self, destroy=_gdi_.delete_ColourDatabase): - """__del__(self)""" - try: - if self.thisown: destroy(self) - except: pass + :see: `wx.AutoBufferedPaintDCFactory` - def Find(*args, **kwargs): - """Find(self, String name) -> Colour""" - return _gdi_.ColourDatabase_Find(*args, **kwargs) + """ + _gdi_.AutoBufferedPaintDC_swiginit(self,_gdi_.new_AutoBufferedPaintDC(*args, **kwargs)) +_gdi_.AutoBufferedPaintDC_swigregister(AutoBufferedPaintDC) - def FindName(*args, **kwargs): - """FindName(self, Colour colour) -> String""" - return _gdi_.ColourDatabase_FindName(*args, **kwargs) - FindColour = Find - def AddColour(*args, **kwargs): - """AddColour(self, String name, Colour colour)""" - return _gdi_.ColourDatabase_AddColour(*args, **kwargs) +def AutoBufferedPaintDCFactory(*args, **kwargs): + """ + AutoBufferedPaintDCFactory(Window window) -> DC - def Append(*args, **kwargs): - """Append(self, String name, int red, int green, int blue)""" - return _gdi_.ColourDatabase_Append(*args, **kwargs) + Checks if the window is natively double buffered and will return a + `wx.PaintDC` if it is, a `wx.BufferedPaintDC` otherwise. The advantage of + this function over `wx.AutoBufferedPaintDC` is that this function will check + if the the specified window has double-buffering enabled rather than just + going by platform defaults. + """ + return _gdi_.AutoBufferedPaintDCFactory(*args, **kwargs) +#--------------------------------------------------------------------------- +class MirrorDC(DC): + """ + wx.MirrorDC is a simple wrapper class which is always associated with a + real `wx.DC` object and either forwards all of its operations to it + without changes (no mirroring takes place) or exchanges x and y + coordinates which makes it possible to reuse the same code to draw a + figure and its mirror -- i.e. reflection related to the diagonal line + x == y. + """ + 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, DC dc, bool mirror) -> MirrorDC -class ColourDatabasePtr(ColourDatabase): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = ColourDatabase -_gdi_.ColourDatabase_swigregister(ColourDatabasePtr) + Creates a mirrored DC associated with the real *dc*. Everything drawn + on the wx.MirrorDC will appear on the *dc*, and will be mirrored if + *mirror* is True. + """ + _gdi_.MirrorDC_swiginit(self,_gdi_.new_MirrorDC(*args, **kwargs)) +_gdi_.MirrorDC_swigregister(MirrorDC) -class FontList(_core.Object): - def __init__(self): raise RuntimeError, "No constructor defined" - def __repr__(self): - return "<%s.%s; proxy of C++ wxFontList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def AddFont(*args, **kwargs): - """AddFont(self, Font font)""" - return _gdi_.FontList_AddFont(*args, **kwargs) +#--------------------------------------------------------------------------- - def FindOrCreateFont(*args, **kwargs): +class PostScriptDC(DC): + """This is a `wx.DC` that can write to PostScript files on any platform.""" + 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): """ - FindOrCreateFont(self, int point_size, int family, int style, int weight, - bool underline=False, String facename=EmptyString, - int encoding=FONTENCODING_DEFAULT) -> Font + __init__(self, wxPrintData printData) -> PostScriptDC + + Constructs a PostScript printer device context from a `wx.PrintData` + object. """ - return _gdi_.FontList_FindOrCreateFont(*args, **kwargs) + _gdi_.PostScriptDC_swiginit(self,_gdi_.new_PostScriptDC(*args, **kwargs)) + def GetPrintData(*args, **kwargs): + """GetPrintData(self) -> wxPrintData""" + return _gdi_.PostScriptDC_GetPrintData(*args, **kwargs) - def RemoveFont(*args, **kwargs): - """RemoveFont(self, Font font)""" - return _gdi_.FontList_RemoveFont(*args, **kwargs) + def SetPrintData(*args, **kwargs): + """SetPrintData(self, wxPrintData data)""" + return _gdi_.PostScriptDC_SetPrintData(*args, **kwargs) - def GetCount(*args, **kwargs): - """GetCount(self) -> int""" - return _gdi_.FontList_GetCount(*args, **kwargs) + def SetResolution(*args, **kwargs): + """ + SetResolution(int ppi) + Set resolution (in pixels per inch) that will be used in PostScript + output. Default is 720ppi. + """ + return _gdi_.PostScriptDC_SetResolution(*args, **kwargs) -class FontListPtr(FontList): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = FontList -_gdi_.FontList_swigregister(FontListPtr) + SetResolution = staticmethod(SetResolution) + def GetResolution(*args, **kwargs): + """ + GetResolution() -> int -#--------------------------------------------------------------------------- + Return resolution used in PostScript output. + """ + return _gdi_.PostScriptDC_GetResolution(*args, **kwargs) -NullColor = NullColour -#--------------------------------------------------------------------------- + GetResolution = staticmethod(GetResolution) + PrintData = property(GetPrintData,SetPrintData,doc="See `GetPrintData` and `SetPrintData`") +_gdi_.PostScriptDC_swigregister(PostScriptDC) -class Effects(_core.Object): - def __repr__(self): - return "<%s.%s; proxy of C++ wxEffects instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,) - def __init__(self, *args, **kwargs): - """__init__(self) -> Effects""" - newobj = _gdi_.new_Effects(*args, **kwargs) - self.this = newobj.this - self.thisown = 1 - del newobj.thisown - def GetHighlightColour(*args, **kwargs): - """GetHighlightColour(self) -> Colour""" - return _gdi_.Effects_GetHighlightColour(*args, **kwargs) +def PostScriptDC_SetResolution(*args, **kwargs): + """ + PostScriptDC_SetResolution(int ppi) - def GetLightShadow(*args, **kwargs): - """GetLightShadow(self) -> Colour""" - return _gdi_.Effects_GetLightShadow(*args, **kwargs) + Set resolution (in pixels per inch) that will be used in PostScript + output. Default is 720ppi. + """ + return _gdi_.PostScriptDC_SetResolution(*args, **kwargs) - def GetFaceColour(*args, **kwargs): - """GetFaceColour(self) -> Colour""" - return _gdi_.Effects_GetFaceColour(*args, **kwargs) +def PostScriptDC_GetResolution(*args): + """ + PostScriptDC_GetResolution() -> int - def GetMediumShadow(*args, **kwargs): - """GetMediumShadow(self) -> Colour""" - return _gdi_.Effects_GetMediumShadow(*args, **kwargs) + Return resolution used in PostScript output. + """ + return _gdi_.PostScriptDC_GetResolution(*args) - def GetDarkShadow(*args, **kwargs): - """GetDarkShadow(self) -> Colour""" - return _gdi_.Effects_GetDarkShadow(*args, **kwargs) +#--------------------------------------------------------------------------- - def SetHighlightColour(*args, **kwargs): - """SetHighlightColour(self, Colour c)""" - return _gdi_.Effects_SetHighlightColour(*args, **kwargs) +class MetaFile(_core.Object): + """Proxy of C++ MetaFile 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, String filename=EmptyString) -> MetaFile""" + _gdi_.MetaFile_swiginit(self,_gdi_.new_MetaFile(*args, **kwargs)) +_gdi_.MetaFile_swigregister(MetaFile) - def SetLightShadow(*args, **kwargs): - """SetLightShadow(self, Colour c)""" - return _gdi_.Effects_SetLightShadow(*args, **kwargs) +class MetaFileDC(DC): + """Proxy of C++ MetaFileDC 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, String filename=EmptyString, int width=0, int height=0, + String description=EmptyString) -> MetaFileDC + """ + _gdi_.MetaFileDC_swiginit(self,_gdi_.new_MetaFileDC(*args, **kwargs)) +_gdi_.MetaFileDC_swigregister(MetaFileDC) - def SetFaceColour(*args, **kwargs): - """SetFaceColour(self, Colour c)""" - return _gdi_.Effects_SetFaceColour(*args, **kwargs) +class PrinterDC(DC): + """Proxy of C++ PrinterDC 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, wxPrintData printData) -> PrinterDC""" + _gdi_.PrinterDC_swiginit(self,_gdi_.new_PrinterDC(*args, **kwargs)) +_gdi_.PrinterDC_swigregister(PrinterDC) - def SetMediumShadow(*args, **kwargs): - """SetMediumShadow(self, Colour c)""" - return _gdi_.Effects_SetMediumShadow(*args, **kwargs) +#--------------------------------------------------------------------------- - def SetDarkShadow(*args, **kwargs): - """SetDarkShadow(self, Colour c)""" - return _gdi_.Effects_SetDarkShadow(*args, **kwargs) +class GraphicsObject(_core.Object): + """ + 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 - def Set(*args, **kwargs): + 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. """ - Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour, - Colour mediumShadow, Colour darkShadow) + _gdi_.GraphicsObject_swiginit(self,_gdi_.new_GraphicsObject(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_GraphicsObject + __del__ = lambda self : None; + def IsNull(*args, **kwargs): """ - return _gdi_.Effects_Set(*args, **kwargs) + IsNull(self) -> bool - def DrawSunkenEdge(*args, **kwargs): - """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)""" - return _gdi_.Effects_DrawSunkenEdge(*args, **kwargs) + Is this object valid (false) or still empty (true)? + """ + return _gdi_.GraphicsObject_IsNull(*args, **kwargs) - def TileBitmap(*args, **kwargs): - """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool""" - return _gdi_.Effects_TileBitmap(*args, **kwargs) + def GetRenderer(*args, **kwargs): + """ + 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): + """ + 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 + + 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): + """ + 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 + + 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): + """ + 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 + + 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): + """ + 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 + + 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): + """ + Concat(self, GraphicsMatrix t) + + Concatenates the passed in matrix to the current matrix. + """ + return _gdi_.GraphicsMatrix_Concat(*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 specified values (default values are the + identity matrix.) + """ + return _gdi_.GraphicsMatrix_Set(*args, **kwargs) + + def Invert(*args, **kwargs): + """ + Invert(self) + + Inverts the matrix. + """ + return _gdi_.GraphicsMatrix_Invert(*args, **kwargs) + + def IsEqual(*args, **kwargs): + """ + IsEqual(self, GraphicsMatrix t) -> bool + + Returns ``True`` if the elements of the transformation matrix are equal + """ + return _gdi_.GraphicsMatrix_IsEqual(*args, **kwargs) + + def IsIdentity(*args, **kwargs): + """ + IsIdentity(self) -> bool + + Returns ``True`` if this is the identity matrix + """ + return _gdi_.GraphicsMatrix_IsIdentity(*args, **kwargs) + + def Translate(*args, **kwargs): + """ + Translate(self, Double dx, Double dy) + + Add a translation to this matrix. + """ + return _gdi_.GraphicsMatrix_Translate(*args, **kwargs) + + def Scale(*args, **kwargs): + """ + Scale(self, Double xScale, Double yScale) + + Scales this matrix. + """ + return _gdi_.GraphicsMatrix_Scale(*args, **kwargs) + + def Rotate(*args, **kwargs): + """ + Rotate(self, Double angle) + + Rotates this matrix. The angle should be specified in radians. + """ + return _gdi_.GraphicsMatrix_Rotate(*args, **kwargs) + + def TransformPoint(*args, **kwargs): + """ + TransformPoint(self, x, y) --> (x, y) + + Applies this matrix to a point, returns the resulting point values + """ + return _gdi_.GraphicsMatrix_TransformPoint(*args, **kwargs) + + def TransformDistance(*args, **kwargs): + """ + TransformDistance(self, dx, dy) --> (dx, dy) + + Applies this matrix to a distance (ie. performs all transforms except + translations) + """ + return _gdi_.GraphicsMatrix_TransformDistance(*args, **kwargs) + + def GetNativeMatrix(*args, **kwargs): + """ + GetNativeMatrix(self) -> void + + 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) + +_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') + __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): + """ + MoveToPoint(self, Double x, Double y) + MoveToPoint(self, Point2D p) + + Begins a new subpath at the specified point. + """ + return _gdi_.GraphicsPath_MoveToPoint(*args) + + def AddLineToPoint(*args): + """ + AddLineToPoint(self, Double x, Double y) + AddLineToPoint(self, Point2D p) + + Adds a straight line from the current point to the specified point. + """ + return _gdi_.GraphicsPath_AddLineToPoint(*args) + + def AddCurveToPoint(*args): + """ + AddCurveToPoint(self, Double cx1, Double cy1, Double cx2, Double cy2, Double x, + Double y) + AddCurveToPoint(self, Point2D c1, Point2D c2, Point2D e) + + Adds a cubic Bezier curve from the current point, using two control + points and an end point + """ + return _gdi_.GraphicsPath_AddCurveToPoint(*args) + + def AddPath(*args, **kwargs): + """ + AddPath(self, GraphicsPath path) + + Adds another path + """ + return _gdi_.GraphicsPath_AddPath(*args, **kwargs) + + def CloseSubpath(*args, **kwargs): + """ + CloseSubpath(self) + + Closes the current sub-path. + """ + return _gdi_.GraphicsPath_CloseSubpath(*args, **kwargs) + + def GetCurrentPoint(*args, **kwargs): + """ + GetCurrentPoint(self) -> Point2D + + Gets the last point of the current path, (0,0) if not yet set + """ + return _gdi_.GraphicsPath_GetCurrentPoint(*args, **kwargs) + + def AddArc(*args): + """ + AddArc(self, Double x, Double y, Double r, Double startAngle, Double endAngle, + bool clockwise) + AddArc(self, Point2D c, Double r, Double startAngle, Double endAngle, + bool clockwise) + + Adds an arc of a circle centering at (x,y) with radius (r) from + startAngle to endAngle + """ + return _gdi_.GraphicsPath_AddArc(*args) + + def AddQuadCurveToPoint(*args, **kwargs): + """ + AddQuadCurveToPoint(self, Double cx, Double cy, Double x, Double y) + + Adds a quadratic Bezier curve from the current point, using a control + point and an end point + """ + return _gdi_.GraphicsPath_AddQuadCurveToPoint(*args, **kwargs) + + def AddRectangle(*args, **kwargs): + """ + AddRectangle(self, Double x, Double y, Double w, Double h) + + Appends a rectangle as a new closed subpath. + """ + return _gdi_.GraphicsPath_AddRectangle(*args, **kwargs) + + def AddCircle(*args, **kwargs): + """ + AddCircle(self, Double x, Double y, Double r) + + Appends a circle around (x,y) with radius r as a new closed subpath. + """ + return _gdi_.GraphicsPath_AddCircle(*args, **kwargs) + + def AddArcToPoint(*args, **kwargs): + """ + 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) + """ + return _gdi_.GraphicsPath_AddArcToPoint(*args, **kwargs) + + def AddEllipse(*args, **kwargs): + """ + AddEllipse(self, Double x, Double y, Double w, Double h) + + Appends an ellipse fitting into the passed in rectangle. + """ + return _gdi_.GraphicsPath_AddEllipse(*args, **kwargs) + + def AddRoundedRectangle(*args, **kwargs): + """ + AddRoundedRectangle(self, Double x, Double y, Double w, Double h, Double radius) + + Appends a rounded rectangle. + """ + return _gdi_.GraphicsPath_AddRoundedRectangle(*args, **kwargs) + + def GetNativePath(*args, **kwargs): + """ + GetNativePath(self) -> void + + 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) + + def UnGetNativePath(*args, **kwargs): + """ + UnGetNativePath(self, void p) + + 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) + + def Transform(*args, **kwargs): + """ + Transform(self, GraphicsMatrix matrix) + + Transforms each point of this path by the matrix + """ + return _gdi_.GraphicsPath_Transform(*args, **kwargs) + + def GetBox(*args, **kwargs): + """ + GetBox(self) -> wxRect2DDouble + + 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 + + Returns ``True`` if the point is within the path. + """ + return _gdi_.GraphicsPath_Contains(*args) + +_gdi_.GraphicsPath_swigregister(GraphicsPath) + +class GraphicsContext(GraphicsObject): + """ + 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 + __swig_destroy__ = _gdi_.delete_GraphicsContext + __del__ = lambda self : None; + def Create(*args): + """ + 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 + + 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 + + Creates a wx.GraphicsContext from a native window. + """ + return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) + + CreateFromNativeWindow = staticmethod(CreateFromNativeWindow) + def CreatePath(*args, **kwargs): + """ + CreatePath(self) -> GraphicsPath + + Creates a native graphics path which is initially empty. + """ + return _gdi_.GraphicsContext_CreatePath(*args, **kwargs) + + def CreatePen(*args, **kwargs): + """ + 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 + + Creates a native brush from a `wx.Brush`. + """ + return _gdi_.GraphicsContext_CreateBrush(*args, **kwargs) + + def CreateLinearGradientBrush(*args, **kwargs): + """ + CreateLinearGradientBrush(self, Double x1, Double y1, Double x2, Double y2, Colour c1, + Colour c2) -> GraphicsBrush + + 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) + + def CreateRadialGradientBrush(*args, **kwargs): + """ + 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 + radius r and color cColour. + """ + return _gdi_.GraphicsContext_CreateRadialGradientBrush(*args, **kwargs) + + def CreateFont(*args, **kwargs): + """ + CreateFont(self, Font font, Colour col=*wxBLACK) -> GraphicsFont + + Creates a native graphics font from a `wx.Font` and a text colour. + """ + return _gdi_.GraphicsContext_CreateFont(*args, **kwargs) + + def CreateMatrix(*args, **kwargs): + """ + 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 + + Creates a native affine transformation matrix from the passed in + values. The defaults result in an identity matrix. + """ + return _gdi_.GraphicsContext_CreateMatrix(*args, **kwargs) + + def PushState(*args, **kwargs): + """ + PushState(self) + + push the current state of the context, ie the transformation matrix on a stack + """ + return _gdi_.GraphicsContext_PushState(*args, **kwargs) + + def PopState(*args, **kwargs): + """ + PopState(self) + + pops a stored state from the stack + """ + return _gdi_.GraphicsContext_PopState(*args, **kwargs) + + def ClipRegion(*args, **kwargs): + """ + ClipRegion(self, Region region) + + Clips drawings to the region, combined to current clipping region. + """ + return _gdi_.GraphicsContext_ClipRegion(*args, **kwargs) + + def Clip(*args, **kwargs): + """ + Clip(self, Double x, Double y, Double w, Double h) + + Clips drawings to the rectangle. + """ + return _gdi_.GraphicsContext_Clip(*args, **kwargs) + + def ResetClip(*args, **kwargs): + """ + ResetClip(self) + + Resets the clipping to original shape. + """ + return _gdi_.GraphicsContext_ResetClip(*args, **kwargs) + + def GetNativeContext(*args, **kwargs): + """ + GetNativeContext(self) -> void + + 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) + + Translates the current transformation matrix. + """ + return _gdi_.GraphicsContext_Translate(*args, **kwargs) + + def Scale(*args, **kwargs): + """ + Scale(self, Double xScale, Double yScale) + + Scale the current transformation matrix of the context. + """ + return _gdi_.GraphicsContext_Scale(*args, **kwargs) + + def Rotate(*args, **kwargs): + """ + Rotate(self, Double angle) + + Rotate the current transformation matrix of the context. ``angle`` is + specified in radians. + """ + return _gdi_.GraphicsContext_Rotate(*args, **kwargs) + + def ConcatTransform(*args, **kwargs): + """ + ConcatTransform(self, GraphicsMatrix matrix) + + Concatenates the passed in transform with the current transform of + this context. + """ + return _gdi_.GraphicsContext_ConcatTransform(*args, **kwargs) + + def SetTransform(*args, **kwargs): + """ + SetTransform(self, GraphicsMatrix matrix) + + Sets the current transform of this context. + """ + return _gdi_.GraphicsContext_SetTransform(*args, **kwargs) + + def GetTransform(*args, **kwargs): + """ + GetTransform(self) -> GraphicsMatrix + + Gets the current transformation matrix of this context. + """ + return _gdi_.GraphicsContext_GetTransform(*args, **kwargs) + + def SetPen(*args): + """ + SetPen(self, GraphicsPen pen) + SetPen(self, Pen pen) + + Sets the stroke pen + """ + return _gdi_.GraphicsContext_SetPen(*args) + + def SetBrush(*args): + """ + SetBrush(self, GraphicsBrush brush) + SetBrush(self, Brush brush) + + Sets the brush for filling + """ + return _gdi_.GraphicsContext_SetBrush(*args) + + def SetFont(*args): + """ + SetFont(self, GraphicsFont font) + SetFont(self, Font font, Colour colour=*wxBLACK) + + Sets the font + """ + return _gdi_.GraphicsContext_SetFont(*args) + + def StrokePath(*args, **kwargs): + """ + StrokePath(self, GraphicsPath path) + + Strokes along a path with the current pen. + """ + return _gdi_.GraphicsContext_StrokePath(*args, **kwargs) + + def FillPath(*args, **kwargs): + """ + FillPath(self, GraphicsPath path, int fillStyle=ODDEVEN_RULE) + + Fills a path with the current brush. + """ + return _gdi_.GraphicsContext_FillPath(*args, **kwargs) + + def DrawPath(*args, **kwargs): + """ + DrawPath(self, GraphicsPath path, int fillStyle=ODDEVEN_RULE) + + 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, 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, 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) + + 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) + + 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] + + 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) + + 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) + + 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. + """ + return _gdi_.GraphicsContext_StrokeLine(*args, **kwargs) + + def StrokeLines(*args, **kwargs): + """ + StrokeLines(self, List points) + + Stroke lines connecting each of the points + """ + return _gdi_.GraphicsContext_StrokeLines(*args, **kwargs) + + def StrokeLineSegements(*args, **kwargs): + """ + StrokeLineSegements(self, PyObject beginPoints, PyObject endPoints) + + Stroke disconnected lines from begin to end points + """ + return _gdi_.GraphicsContext_StrokeLineSegements(*args, **kwargs) + + def DrawLines(*args, **kwargs): + """ + DrawLines(self, size_t points, int fillStyle=ODDEVEN_RULE) + + Draws a polygon. + """ + return _gdi_.GraphicsContext_DrawLines(*args, **kwargs) + + def DrawRectangle(*args, **kwargs): + """ + DrawRectangle(self, Double x, Double y, Double w, Double h) + + Draws a rectangle. + """ + return _gdi_.GraphicsContext_DrawRectangle(*args, **kwargs) + + def DrawEllipse(*args, **kwargs): + """ + DrawEllipse(self, Double x, Double y, Double w, Double h) + + Draws an ellipse. + """ + return _gdi_.GraphicsContext_DrawEllipse(*args, **kwargs) + + def DrawRoundedRectangle(*args, **kwargs): + """ + DrawRoundedRectangle(self, Double x, Double y, Double w, Double h, Double radius) + + Draws a rounded rectangle + """ + return _gdi_.GraphicsContext_DrawRoundedRectangle(*args, **kwargs) + + def ShouldOffset(*args, **kwargs): + """ + ShouldOffset(self) -> bool + + helper to determine if a 0.5 offset should be applied for the drawing operation + """ + return _gdi_.GraphicsContext_ShouldOffset(*args, **kwargs) + +_gdi_.GraphicsContext_swigregister(GraphicsContext) +cvar = _gdi_.cvar +NullGraphicsPen = cvar.NullGraphicsPen +NullGraphicsBrush = cvar.NullGraphicsBrush +NullGraphicsFont = cvar.NullGraphicsFont +NullGraphicsMatrix = cvar.NullGraphicsMatrix +NullGraphicsPath = cvar.NullGraphicsPath + +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 + + 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 + + Creates a wx.GraphicsContext from a native window. + """ + return _gdi_.GraphicsContext_CreateFromNativeWindow(*args, **kwargs) + +class GraphicsRenderer(_core.Object): + """Proxy of C++ GraphicsRenderer 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 + __swig_destroy__ = _gdi_.delete_GraphicsRenderer + __del__ = lambda self : None; + def GetDefaultRenderer(*args, **kwargs): + """GetDefaultRenderer() -> GraphicsRenderer""" + return _gdi_.GraphicsRenderer_GetDefaultRenderer(*args, **kwargs) + + GetDefaultRenderer = staticmethod(GetDefaultRenderer) + def CreateContext(*args): + """ + CreateContext(self, WindowDC dc) -> GraphicsContext + CreateContext(self, Window window) -> GraphicsContext + """ + 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) + + def CreateContextFromNativeWindow(*args, **kwargs): + """CreateContextFromNativeWindow(self, void window) -> GraphicsContext""" + return _gdi_.GraphicsRenderer_CreateContextFromNativeWindow(*args, **kwargs) + + def CreatePath(*args, **kwargs): + """CreatePath(self) -> GraphicsPath""" + return _gdi_.GraphicsRenderer_CreatePath(*args, **kwargs) + + def CreateMatrix(*args, **kwargs): + """ + 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 + """ + return _gdi_.GraphicsRenderer_CreateMatrix(*args, **kwargs) + + def CreatePen(*args, **kwargs): + """CreatePen(self, Pen pen) -> GraphicsPen""" + return _gdi_.GraphicsRenderer_CreatePen(*args, **kwargs) + + def CreateBrush(*args, **kwargs): + """CreateBrush(self, Brush brush) -> GraphicsBrush""" + return _gdi_.GraphicsRenderer_CreateBrush(*args, **kwargs) + + def CreateLinearGradientBrush(*args, **kwargs): + """ + CreateLinearGradientBrush(self, Double x1, Double y1, Double x2, Double y2, Colour c1, + Colour c2) -> GraphicsBrush + """ + return _gdi_.GraphicsRenderer_CreateLinearGradientBrush(*args, **kwargs) + + def CreateRadialGradientBrush(*args, **kwargs): + """ + CreateRadialGradientBrush(self, Double xo, Double yo, Double xc, Double yc, Double radius, + Colour oColor, Colour cColor) -> GraphicsBrush + """ + return _gdi_.GraphicsRenderer_CreateRadialGradientBrush(*args, **kwargs) + + def CreateFont(*args, **kwargs): + """CreateFont(self, Font font, Colour col=*wxBLACK) -> GraphicsFont""" + return _gdi_.GraphicsRenderer_CreateFont(*args, **kwargs) + +_gdi_.GraphicsRenderer_swigregister(GraphicsRenderer) + +def GraphicsRenderer_GetDefaultRenderer(*args): + """GraphicsRenderer_GetDefaultRenderer() -> GraphicsRenderer""" + return _gdi_.GraphicsRenderer_GetDefaultRenderer(*args) + +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): + """ + __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 + __del__ = lambda self : None; + def GetGraphicsContext(*args, **kwargs): + """GetGraphicsContext(self) -> GraphicsContext""" + return _gdi_.GCDC_GetGraphicsContext(*args, **kwargs) + + def SetGraphicsContext(*args, **kwargs): + """SetGraphicsContext(self, GraphicsContext ctx)""" + return _gdi_.GCDC_SetGraphicsContext(*args, **kwargs) + + GraphicsContext = property(GetGraphicsContext,SetGraphicsContext) +_gdi_.GCDC_swigregister(GCDC) + +class Overlay(object): + """Proxy of C++ Overlay 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) -> Overlay""" + _gdi_.Overlay_swiginit(self,_gdi_.new_Overlay(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_Overlay + __del__ = lambda self : None; + def Reset(*args, **kwargs): + """Reset(self)""" + return _gdi_.Overlay_Reset(*args, **kwargs) + +_gdi_.Overlay_swigregister(Overlay) + +class DCOverlay(object): + """Proxy of C++ DCOverlay 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): + """ + __init__(self, Overlay overlay, WindowDC dc, int x, int y, int width, + int height) -> DCOverlay + __init__(self, Overlay overlay, WindowDC dc) -> DCOverlay + """ + _gdi_.DCOverlay_swiginit(self,_gdi_.new_DCOverlay(*args)) + __swig_destroy__ = _gdi_.delete_DCOverlay + __del__ = lambda self : None; + def Clear(*args, **kwargs): + """Clear(self)""" + return _gdi_.DCOverlay_Clear(*args, **kwargs) + +_gdi_.DCOverlay_swigregister(DCOverlay) + +#--------------------------------------------------------------------------- + +IMAGELIST_DRAW_NORMAL = _gdi_.IMAGELIST_DRAW_NORMAL +IMAGELIST_DRAW_TRANSPARENT = _gdi_.IMAGELIST_DRAW_TRANSPARENT +IMAGELIST_DRAW_SELECTED = _gdi_.IMAGELIST_DRAW_SELECTED +IMAGELIST_DRAW_FOCUSED = _gdi_.IMAGELIST_DRAW_FOCUSED +IMAGE_LIST_NORMAL = _gdi_.IMAGE_LIST_NORMAL +IMAGE_LIST_SMALL = _gdi_.IMAGE_LIST_SMALL +IMAGE_LIST_STATE = _gdi_.IMAGE_LIST_STATE +class ImageList(_core.Object): + """Proxy of C++ ImageList 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, int width, int height, int mask=True, int initialCount=1) -> ImageList""" + _gdi_.ImageList_swiginit(self,_gdi_.new_ImageList(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_ImageList + __del__ = lambda self : None; + def Add(*args, **kwargs): + """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int""" + return _gdi_.ImageList_Add(*args, **kwargs) + + def AddWithColourMask(*args, **kwargs): + """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int""" + return _gdi_.ImageList_AddWithColourMask(*args, **kwargs) + + def AddIcon(*args, **kwargs): + """AddIcon(self, Icon icon) -> int""" + return _gdi_.ImageList_AddIcon(*args, **kwargs) + + def GetBitmap(*args, **kwargs): + """GetBitmap(self, int index) -> Bitmap""" + return _gdi_.ImageList_GetBitmap(*args, **kwargs) + + def GetIcon(*args, **kwargs): + """GetIcon(self, int index) -> Icon""" + return _gdi_.ImageList_GetIcon(*args, **kwargs) + + def Replace(*args, **kwargs): + """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool""" + return _gdi_.ImageList_Replace(*args, **kwargs) + + def Draw(*args, **kwargs): + """ + Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL, + bool solidBackground=False) -> bool + """ + return _gdi_.ImageList_Draw(*args, **kwargs) + + def GetImageCount(*args, **kwargs): + """GetImageCount(self) -> int""" + return _gdi_.ImageList_GetImageCount(*args, **kwargs) + + def Remove(*args, **kwargs): + """Remove(self, int index) -> bool""" + return _gdi_.ImageList_Remove(*args, **kwargs) + + def RemoveAll(*args, **kwargs): + """RemoveAll(self) -> bool""" + return _gdi_.ImageList_RemoveAll(*args, **kwargs) + + def GetSize(*args, **kwargs): + """GetSize(index) -> (width,height)""" + return _gdi_.ImageList_GetSize(*args, **kwargs) + + ImageCount = property(GetImageCount,doc="See `GetImageCount`") + Size = property(GetSize,doc="See `GetSize`") +_gdi_.ImageList_swigregister(ImageList) + +#--------------------------------------------------------------------------- + +class StockGDI(object): + """Proxy of C++ StockGDI class""" + thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') + __repr__ = _swig_repr + BRUSH_BLACK = _gdi_.StockGDI_BRUSH_BLACK + BRUSH_BLUE = _gdi_.StockGDI_BRUSH_BLUE + BRUSH_CYAN = _gdi_.StockGDI_BRUSH_CYAN + BRUSH_GREEN = _gdi_.StockGDI_BRUSH_GREEN + BRUSH_GREY = _gdi_.StockGDI_BRUSH_GREY + BRUSH_LIGHTGREY = _gdi_.StockGDI_BRUSH_LIGHTGREY + BRUSH_MEDIUMGREY = _gdi_.StockGDI_BRUSH_MEDIUMGREY + BRUSH_RED = _gdi_.StockGDI_BRUSH_RED + BRUSH_TRANSPARENT = _gdi_.StockGDI_BRUSH_TRANSPARENT + BRUSH_WHITE = _gdi_.StockGDI_BRUSH_WHITE + COLOUR_BLACK = _gdi_.StockGDI_COLOUR_BLACK + COLOUR_BLUE = _gdi_.StockGDI_COLOUR_BLUE + COLOUR_CYAN = _gdi_.StockGDI_COLOUR_CYAN + COLOUR_GREEN = _gdi_.StockGDI_COLOUR_GREEN + COLOUR_LIGHTGREY = _gdi_.StockGDI_COLOUR_LIGHTGREY + COLOUR_RED = _gdi_.StockGDI_COLOUR_RED + COLOUR_WHITE = _gdi_.StockGDI_COLOUR_WHITE + CURSOR_CROSS = _gdi_.StockGDI_CURSOR_CROSS + CURSOR_HOURGLASS = _gdi_.StockGDI_CURSOR_HOURGLASS + CURSOR_STANDARD = _gdi_.StockGDI_CURSOR_STANDARD + FONT_ITALIC = _gdi_.StockGDI_FONT_ITALIC + FONT_NORMAL = _gdi_.StockGDI_FONT_NORMAL + FONT_SMALL = _gdi_.StockGDI_FONT_SMALL + FONT_SWISS = _gdi_.StockGDI_FONT_SWISS + PEN_BLACK = _gdi_.StockGDI_PEN_BLACK + PEN_BLACKDASHED = _gdi_.StockGDI_PEN_BLACKDASHED + PEN_CYAN = _gdi_.StockGDI_PEN_CYAN + PEN_GREEN = _gdi_.StockGDI_PEN_GREEN + PEN_GREY = _gdi_.StockGDI_PEN_GREY + PEN_LIGHTGREY = _gdi_.StockGDI_PEN_LIGHTGREY + PEN_MEDIUMGREY = _gdi_.StockGDI_PEN_MEDIUMGREY + PEN_RED = _gdi_.StockGDI_PEN_RED + PEN_TRANSPARENT = _gdi_.StockGDI_PEN_TRANSPARENT + PEN_WHITE = _gdi_.StockGDI_PEN_WHITE + ITEMCOUNT = _gdi_.StockGDI_ITEMCOUNT + def __init__(self, *args, **kwargs): + """__init__(self) -> StockGDI""" + _gdi_.StockGDI_swiginit(self,_gdi_.new_StockGDI(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_StockGDI + __del__ = lambda self : None; + def DeleteAll(*args, **kwargs): + """DeleteAll()""" + return _gdi_.StockGDI_DeleteAll(*args, **kwargs) + + DeleteAll = staticmethod(DeleteAll) + def instance(*args, **kwargs): + """instance() -> StockGDI""" + return _gdi_.StockGDI_instance(*args, **kwargs) + + instance = staticmethod(instance) + def GetBrush(*args, **kwargs): + """GetBrush(int item) -> Brush""" + return _gdi_.StockGDI_GetBrush(*args, **kwargs) + + GetBrush = staticmethod(GetBrush) + def GetColour(*args, **kwargs): + """GetColour(int item) -> Colour""" + return _gdi_.StockGDI_GetColour(*args, **kwargs) + + GetColour = staticmethod(GetColour) + def GetCursor(*args, **kwargs): + """GetCursor(int item) -> Cursor""" + return _gdi_.StockGDI_GetCursor(*args, **kwargs) + + GetCursor = staticmethod(GetCursor) + def GetPen(*args, **kwargs): + """GetPen(int item) -> Pen""" + return _gdi_.StockGDI_GetPen(*args, **kwargs) + + GetPen = staticmethod(GetPen) + def GetFont(*args, **kwargs): + """GetFont(self, int item) -> Font""" + return _gdi_.StockGDI_GetFont(*args, **kwargs) + + def _initStockObjects(): + import wx + wx.ITALIC_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_ITALIC).this + wx.NORMAL_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_NORMAL).this + wx.SMALL_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_SMALL).this + wx.SWISS_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_SWISS).this + + wx.BLACK_DASHED_PEN.this = StockGDI.GetPen(StockGDI.PEN_BLACKDASHED).this + wx.BLACK_PEN.this = StockGDI.GetPen(StockGDI.PEN_BLACK).this + wx.CYAN_PEN.this = StockGDI.GetPen(StockGDI.PEN_CYAN).this + wx.GREEN_PEN.this = StockGDI.GetPen(StockGDI.PEN_GREEN).this + wx.GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_GREY).this + wx.LIGHT_GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_LIGHTGREY).this + wx.MEDIUM_GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_MEDIUMGREY).this + wx.RED_PEN.this = StockGDI.GetPen(StockGDI.PEN_RED).this + wx.TRANSPARENT_PEN.this = StockGDI.GetPen(StockGDI.PEN_TRANSPARENT).this + wx.WHITE_PEN.this = StockGDI.GetPen(StockGDI.PEN_WHITE).this + + wx.BLACK_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_BLACK).this + wx.BLUE_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_BLUE).this + wx.CYAN_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_CYAN).this + wx.GREEN_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_GREEN).this + wx.GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_GREY).this + wx.LIGHT_GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_LIGHTGREY).this + wx.MEDIUM_GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_MEDIUMGREY).this + wx.RED_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_RED).this + wx.TRANSPARENT_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_TRANSPARENT).this + wx.WHITE_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_WHITE).this + + wx.BLACK.this = StockGDI.GetColour(StockGDI.COLOUR_BLACK).this + wx.BLUE.this = StockGDI.GetColour(StockGDI.COLOUR_BLUE).this + wx.CYAN.this = StockGDI.GetColour(StockGDI.COLOUR_CYAN).this + wx.GREEN.this = StockGDI.GetColour(StockGDI.COLOUR_GREEN).this + wx.LIGHT_GREY.this = StockGDI.GetColour(StockGDI.COLOUR_LIGHTGREY).this + wx.RED.this = StockGDI.GetColour(StockGDI.COLOUR_RED).this + wx.WHITE.this = StockGDI.GetColour(StockGDI.COLOUR_WHITE).this + + wx.CROSS_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_CROSS).this + wx.HOURGLASS_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_HOURGLASS).this + wx.STANDARD_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_STANDARD).this + + wx.TheFontList.this = _wxPyInitTheFontList().this + wx.ThePenList.this = _wxPyInitThePenList().this + wx.TheBrushList.this = _wxPyInitTheBrushList().this + wx.TheColourDatabase.this = _wxPyInitTheColourDatabase().this + + + _initStockObjects = staticmethod(_initStockObjects) + +_gdi_.StockGDI_swigregister(StockGDI) + +def StockGDI_DeleteAll(*args): + """StockGDI_DeleteAll()""" + return _gdi_.StockGDI_DeleteAll(*args) + +def StockGDI_instance(*args): + """StockGDI_instance() -> StockGDI""" + return _gdi_.StockGDI_instance(*args) + +def StockGDI_GetBrush(*args, **kwargs): + """StockGDI_GetBrush(int item) -> Brush""" + return _gdi_.StockGDI_GetBrush(*args, **kwargs) + +def StockGDI_GetColour(*args, **kwargs): + """StockGDI_GetColour(int item) -> Colour""" + return _gdi_.StockGDI_GetColour(*args, **kwargs) + +def StockGDI_GetCursor(*args, **kwargs): + """StockGDI_GetCursor(int item) -> Cursor""" + return _gdi_.StockGDI_GetCursor(*args, **kwargs) + +def StockGDI_GetPen(*args, **kwargs): + """StockGDI_GetPen(int item) -> Pen""" + return _gdi_.StockGDI_GetPen(*args, **kwargs) + +# Create an uninitialized instance for the stock objects, they will +# be initialized later when the wx.App object is created. +ITALIC_FONT = Font.__new__(Font) +NORMAL_FONT = Font.__new__(Font) +SMALL_FONT = Font.__new__(Font) +SWISS_FONT = Font.__new__(Font) + +BLACK_DASHED_PEN = Pen.__new__(Pen) +BLACK_PEN = Pen.__new__(Pen) +CYAN_PEN = Pen.__new__(Pen) +GREEN_PEN = Pen.__new__(Pen) +GREY_PEN = Pen.__new__(Pen) +LIGHT_GREY_PEN = Pen.__new__(Pen) +MEDIUM_GREY_PEN = Pen.__new__(Pen) +RED_PEN = Pen.__new__(Pen) +TRANSPARENT_PEN = Pen.__new__(Pen) +WHITE_PEN = Pen.__new__(Pen) + +BLACK_BRUSH = Brush.__new__(Brush) +BLUE_BRUSH = Brush.__new__(Brush) +CYAN_BRUSH = Brush.__new__(Brush) +GREEN_BRUSH = Brush.__new__(Brush) +GREY_BRUSH = Brush.__new__(Brush) +LIGHT_GREY_BRUSH = Brush.__new__(Brush) +MEDIUM_GREY_BRUSH = Brush.__new__(Brush) +RED_BRUSH = Brush.__new__(Brush) +TRANSPARENT_BRUSH = Brush.__new__(Brush) +WHITE_BRUSH = Brush.__new__(Brush) + +BLACK = Colour.__new__(Colour) +BLUE = Colour.__new__(Colour) +CYAN = Colour.__new__(Colour) +GREEN = Colour.__new__(Colour) +LIGHT_GREY = Colour.__new__(Colour) +RED = Colour.__new__(Colour) +WHITE = Colour.__new__(Colour) + +CROSS_CURSOR = Cursor.__new__(Cursor) +HOURGLASS_CURSOR = Cursor.__new__(Cursor) +STANDARD_CURSOR = Cursor.__new__(Cursor) + +class GDIObjListBase(object): + """Proxy of C++ GDIObjListBase 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) -> GDIObjListBase""" + _gdi_.GDIObjListBase_swiginit(self,_gdi_.new_GDIObjListBase(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_GDIObjListBase + __del__ = lambda self : None; +_gdi_.GDIObjListBase_swigregister(GDIObjListBase) +NullBitmap = cvar.NullBitmap +NullIcon = cvar.NullIcon +NullCursor = cvar.NullCursor +NullPen = cvar.NullPen +NullBrush = cvar.NullBrush +NullPalette = cvar.NullPalette +NullFont = cvar.NullFont +NullColour = cvar.NullColour + +class PenList(GDIObjListBase): + """Proxy of C++ PenList 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 FindOrCreatePen(*args, **kwargs): + """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): + """Proxy of C++ BrushList 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 FindOrCreateBrush(*args, **kwargs): + """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): + """Proxy of C++ FontList 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 FindOrCreateFont(*args, **kwargs): + """ + FindOrCreateFont(self, int point_size, int family, int style, int weight, + bool underline=False, String facename=EmptyString, + int encoding=FONTENCODING_DEFAULT) -> Font + """ + 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): + """Proxy of C++ ColourDatabase 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) -> ColourDatabase""" + _gdi_.ColourDatabase_swiginit(self,_gdi_.new_ColourDatabase(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_ColourDatabase + __del__ = lambda self : None; + def Find(*args, **kwargs): + """Find(self, String name) -> Colour""" + return _gdi_.ColourDatabase_Find(*args, **kwargs) + + def FindName(*args, **kwargs): + """FindName(self, Colour colour) -> String""" + return _gdi_.ColourDatabase_FindName(*args, **kwargs) + + FindColour = Find + def AddColour(*args, **kwargs): + """AddColour(self, String name, Colour colour)""" + return _gdi_.ColourDatabase_AddColour(*args, **kwargs) + + def Append(*args, **kwargs): + """Append(self, String name, int red, int green, int blue)""" + return _gdi_.ColourDatabase_Append(*args, **kwargs) + +_gdi_.ColourDatabase_swigregister(ColourDatabase) + +#--------------------------------------------------------------------------- + + +def _wxPyInitTheFontList(*args): + """_wxPyInitTheFontList() -> FontList""" + return _gdi_._wxPyInitTheFontList(*args) + +def _wxPyInitThePenList(*args): + """_wxPyInitThePenList() -> PenList""" + return _gdi_._wxPyInitThePenList(*args) + +def _wxPyInitTheBrushList(*args): + """_wxPyInitTheBrushList() -> BrushList""" + return _gdi_._wxPyInitTheBrushList(*args) + +def _wxPyInitTheColourDatabase(*args): + """_wxPyInitTheColourDatabase() -> ColourDatabase""" + return _gdi_._wxPyInitTheColourDatabase(*args) +# Create an uninitialized instance for the stock objects, they will +# be initialized later when the wx.App object is created. +TheFontList = FontList.__new__(FontList) +ThePenList = PenList.__new__(PenList) +TheBrushList = BrushList.__new__(BrushList) +TheColourDatabase = ColourDatabase.__new__(ColourDatabase) + +NullColor = NullColour +#--------------------------------------------------------------------------- + +class Effects(_core.Object): + """Proxy of C++ Effects 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) -> Effects""" + _gdi_.Effects_swiginit(self,_gdi_.new_Effects(*args, **kwargs)) + def GetHighlightColour(*args, **kwargs): + """GetHighlightColour(self) -> Colour""" + return _gdi_.Effects_GetHighlightColour(*args, **kwargs) + + def GetLightShadow(*args, **kwargs): + """GetLightShadow(self) -> Colour""" + return _gdi_.Effects_GetLightShadow(*args, **kwargs) + + def GetFaceColour(*args, **kwargs): + """GetFaceColour(self) -> Colour""" + return _gdi_.Effects_GetFaceColour(*args, **kwargs) + + def GetMediumShadow(*args, **kwargs): + """GetMediumShadow(self) -> Colour""" + return _gdi_.Effects_GetMediumShadow(*args, **kwargs) + + def GetDarkShadow(*args, **kwargs): + """GetDarkShadow(self) -> Colour""" + return _gdi_.Effects_GetDarkShadow(*args, **kwargs) + + def SetHighlightColour(*args, **kwargs): + """SetHighlightColour(self, Colour c)""" + return _gdi_.Effects_SetHighlightColour(*args, **kwargs) + + def SetLightShadow(*args, **kwargs): + """SetLightShadow(self, Colour c)""" + return _gdi_.Effects_SetLightShadow(*args, **kwargs) + + def SetFaceColour(*args, **kwargs): + """SetFaceColour(self, Colour c)""" + return _gdi_.Effects_SetFaceColour(*args, **kwargs) + + def SetMediumShadow(*args, **kwargs): + """SetMediumShadow(self, Colour c)""" + return _gdi_.Effects_SetMediumShadow(*args, **kwargs) + + def SetDarkShadow(*args, **kwargs): + """SetDarkShadow(self, Colour c)""" + return _gdi_.Effects_SetDarkShadow(*args, **kwargs) + + def Set(*args, **kwargs): + """ + Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour, + Colour mediumShadow, Colour darkShadow) + """ + return _gdi_.Effects_Set(*args, **kwargs) + + def DrawSunkenEdge(*args, **kwargs): + """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)""" + return _gdi_.Effects_DrawSunkenEdge(*args, **kwargs) + + def TileBitmap(*args, **kwargs): + """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool""" + return _gdi_.Effects_TileBitmap(*args, **kwargs) + + DarkShadow = property(GetDarkShadow,SetDarkShadow,doc="See `GetDarkShadow` and `SetDarkShadow`") + FaceColour = property(GetFaceColour,SetFaceColour,doc="See `GetFaceColour` and `SetFaceColour`") + HighlightColour = property(GetHighlightColour,SetHighlightColour,doc="See `GetHighlightColour` and `SetHighlightColour`") + LightShadow = property(GetLightShadow,SetLightShadow,doc="See `GetLightShadow` and `SetLightShadow`") + MediumShadow = property(GetMediumShadow,SetMediumShadow,doc="See `GetMediumShadow` and `SetMediumShadow`") +_gdi_.Effects_swigregister(Effects) + +#--------------------------------------------------------------------------- + +CONTROL_DISABLED = _gdi_.CONTROL_DISABLED +CONTROL_FOCUSED = _gdi_.CONTROL_FOCUSED +CONTROL_PRESSED = _gdi_.CONTROL_PRESSED +CONTROL_SPECIAL = _gdi_.CONTROL_SPECIAL +CONTROL_ISDEFAULT = _gdi_.CONTROL_ISDEFAULT +CONTROL_ISSUBMENU = _gdi_.CONTROL_ISSUBMENU +CONTROL_EXPANDED = _gdi_.CONTROL_EXPANDED +CONTROL_SIZEGRIP = _gdi_.CONTROL_SIZEGRIP +CONTROL_CURRENT = _gdi_.CONTROL_CURRENT +CONTROL_SELECTED = _gdi_.CONTROL_SELECTED +CONTROL_CHECKED = _gdi_.CONTROL_CHECKED +CONTROL_CHECKABLE = _gdi_.CONTROL_CHECKABLE +CONTROL_UNDETERMINED = _gdi_.CONTROL_UNDETERMINED +CONTROL_FLAGS_MASK = _gdi_.CONTROL_FLAGS_MASK +CONTROL_DIRTY = _gdi_.CONTROL_DIRTY +class SplitterRenderParams(object): + """ + This is just a simple struct used as a return value of + `wx.RendererNative.GetSplitterParams` and contains some platform + specific metrics about splitters. + + * widthSash: the width of the splitter sash. + * border: the width of the border of the splitter window. + * isHotSensitive: ``True`` if the splitter changes its + appearance when the mouse is over it. + + + """ + 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, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams + + This is just a simple struct used as a return value of + `wx.RendererNative.GetSplitterParams` and contains some platform + specific metrics about splitters. + + * widthSash: the width of the splitter sash. + * border: the width of the border of the splitter window. + * isHotSensitive: ``True`` if the splitter changes its + appearance when the mouse is over it. + + + """ + _gdi_.SplitterRenderParams_swiginit(self,_gdi_.new_SplitterRenderParams(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_SplitterRenderParams + __del__ = lambda self : None; + widthSash = property(_gdi_.SplitterRenderParams_widthSash_get) + border = property(_gdi_.SplitterRenderParams_border_get) + isHotSensitive = property(_gdi_.SplitterRenderParams_isHotSensitive_get) +_gdi_.SplitterRenderParams_swigregister(SplitterRenderParams) + +class HeaderButtonParams(object): + """Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`""" + 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) -> HeaderButtonParams + + Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton` + """ + _gdi_.HeaderButtonParams_swiginit(self,_gdi_.new_HeaderButtonParams(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_HeaderButtonParams + __del__ = lambda self : None; + m_arrowColour = property(_gdi_.HeaderButtonParams_m_arrowColour_get, _gdi_.HeaderButtonParams_m_arrowColour_set) + m_selectionColour = property(_gdi_.HeaderButtonParams_m_selectionColour_get, _gdi_.HeaderButtonParams_m_selectionColour_set) + m_labelText = property(_gdi_.HeaderButtonParams_m_labelText_get, _gdi_.HeaderButtonParams_m_labelText_set) + m_labelFont = property(_gdi_.HeaderButtonParams_m_labelFont_get, _gdi_.HeaderButtonParams_m_labelFont_set) + m_labelColour = property(_gdi_.HeaderButtonParams_m_labelColour_get, _gdi_.HeaderButtonParams_m_labelColour_set) + m_labelBitmap = property(_gdi_.HeaderButtonParams_m_labelBitmap_get, _gdi_.HeaderButtonParams_m_labelBitmap_set) + m_labelAlignment = property(_gdi_.HeaderButtonParams_m_labelAlignment_get, _gdi_.HeaderButtonParams_m_labelAlignment_set) +_gdi_.HeaderButtonParams_swigregister(HeaderButtonParams) + +HDR_SORT_ICON_NONE = _gdi_.HDR_SORT_ICON_NONE +HDR_SORT_ICON_UP = _gdi_.HDR_SORT_ICON_UP +HDR_SORT_ICON_DOWN = _gdi_.HDR_SORT_ICON_DOWN +class RendererVersion(object): + """ + This simple struct represents the `wx.RendererNative` interface + version and is only used as the return value of + `wx.RendererNative.GetVersion`. + """ + 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, int version_, int age_) -> RendererVersion + + This simple struct represents the `wx.RendererNative` interface + version and is only used as the return value of + `wx.RendererNative.GetVersion`. + """ + _gdi_.RendererVersion_swiginit(self,_gdi_.new_RendererVersion(*args, **kwargs)) + __swig_destroy__ = _gdi_.delete_RendererVersion + __del__ = lambda self : None; + Current_Version = _gdi_.RendererVersion_Current_Version + Current_Age = _gdi_.RendererVersion_Current_Age + def IsCompatible(*args, **kwargs): + """IsCompatible(RendererVersion ver) -> bool""" + return _gdi_.RendererVersion_IsCompatible(*args, **kwargs) + + IsCompatible = staticmethod(IsCompatible) + version = property(_gdi_.RendererVersion_version_get) + age = property(_gdi_.RendererVersion_age_get) +_gdi_.RendererVersion_swigregister(RendererVersion) + +def RendererVersion_IsCompatible(*args, **kwargs): + """RendererVersion_IsCompatible(RendererVersion ver) -> bool""" + return _gdi_.RendererVersion_IsCompatible(*args, **kwargs) + +class RendererNative(object): + """ + One of the design principles of wxWidgets is to use the native + widgets on every platform in order to be as close as possible to + the native look and feel on every platform. However there are + still cases when some generic widgets are needed for various + reasons, but it can sometimes take a lot of messy work to make + them conform to the native LnF. + + The wx.RendererNative class is a collection of functions that have + platform-specific implementations for drawing certain parts of + genereic controls in ways that are as close to the native look as + possible. + + Note that each drawing function restores the `wx.DC` attributes if it + changes them, so it is safe to assume that the same pen, brush and + colours that were active before the call to this function are still in + effect after it. + + """ + 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 DrawHeaderButton(*args, **kwargs): + """ + DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE, + HeaderButtonParams params=None) -> int + + 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) -> int + + Draw the contents of a header control button, (label, sort + arrows, etc.) Normally this is only called by `DrawHeaderButton`. + """ + return _gdi_.RendererNative_DrawHeaderButtonContents(*args, **kwargs) + + def GetHeaderButtonHeight(*args, **kwargs): + """ + GetHeaderButtonHeight(self, Window win) -> int + + Returns the default height of a header button, either a fixed platform + height if available, or a generic height based on the window's font. + """ + return _gdi_.RendererNative_GetHeaderButtonHeight(*args, **kwargs) + + def DrawTreeItemButton(*args, **kwargs): + """ + DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0) + + Draw the expanded/collapsed icon for a tree control item. + """ + return _gdi_.RendererNative_DrawTreeItemButton(*args, **kwargs) + + def DrawSplitterBorder(*args, **kwargs): + """ + DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0) + + Draw the border for a sash window: this border must be such that the + sash drawn by `DrawSplitterSash` blends into it well. + """ + return _gdi_.RendererNative_DrawSplitterBorder(*args, **kwargs) + + def DrawSplitterSash(*args, **kwargs): + """ + DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient, + int flags=0) + + Draw a sash. The orient parameter defines whether the sash should be + vertical or horizontal and how the position should be interpreted. + """ + return _gdi_.RendererNative_DrawSplitterSash(*args, **kwargs) + + def DrawComboBoxDropButton(*args, **kwargs): + """ + DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0) + + Draw a button like the one used by `wx.ComboBox` to show a drop down + window. The usual appearance is a downwards pointing arrow. + + The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or + ``wx.CONTROL_CURRENT`` bits set. + """ + return _gdi_.RendererNative_DrawComboBoxDropButton(*args, **kwargs) + + def DrawDropArrow(*args, **kwargs): + """ + DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0) + + Draw a drop down arrow that is suitable for use outside a combo + box. Arrow will have a transparent background. + + ``rect`` is not entirely filled by the arrow. Instead, you should use + bounding rectangle of a drop down button which arrow matches the size + you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or + ``wx.CONTROL_CURRENT`` bit set. + """ + return _gdi_.RendererNative_DrawDropArrow(*args, **kwargs) + + def DrawCheckBox(*args, **kwargs): + """ + DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0) + + Draw a check button. Flags may use wx.CONTROL_CHECKED, + wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT. + """ + return _gdi_.RendererNative_DrawCheckBox(*args, **kwargs) + + def DrawPushButton(*args, **kwargs): + """ + DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0) + + Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and + wx.CONTROL_ISDEFAULT + """ + return _gdi_.RendererNative_DrawPushButton(*args, **kwargs) + + def DrawItemSelectionRect(*args, **kwargs): + """ + DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0) + + Draw rectangle indicating that an item in e.g. a list control has been + selected or focused + + The flags parameter may be: + + ==================== ============================================ + wx.CONTROL_SELECTED item is selected, e.g. draw background + wx.CONTROL_CURRENT item is the current item, e.g. dotted border + wx.CONTROL_FOCUSED the whole control has focus, e.g. blue + background vs. grey otherwise + ==================== ============================================ + + """ + return _gdi_.RendererNative_DrawItemSelectionRect(*args, **kwargs) + + def GetSplitterParams(*args, **kwargs): + """ + GetSplitterParams(self, Window win) -> SplitterRenderParams + + Get the splitter parameters, see `wx.SplitterRenderParams`. + """ + return _gdi_.RendererNative_GetSplitterParams(*args, **kwargs) + + def Get(*args, **kwargs): + """ + Get() -> RendererNative + + Return the currently used renderer + """ + return _gdi_.RendererNative_Get(*args, **kwargs) + + Get = staticmethod(Get) + def GetGeneric(*args, **kwargs): + """ + GetGeneric() -> RendererNative + + Return the generic implementation of the renderer. Under some + platforms, this is the default renderer implementation, others have + platform-specific default renderer which can be retrieved by calling + `wx.RendererNative.GetDefault`. + """ + return _gdi_.RendererNative_GetGeneric(*args, **kwargs) + + GetGeneric = staticmethod(GetGeneric) + def GetDefault(*args, **kwargs): + """ + GetDefault() -> RendererNative + + Return the default (native) implementation for this platform -- this + is also the one used by default but this may be changed by calling + `wx.RendererNative.Set` in which case the return value of this method + may be different from the return value of `wx.RendererNative.Get`. + """ + return _gdi_.RendererNative_GetDefault(*args, **kwargs) + + GetDefault = staticmethod(GetDefault) + def Set(*args, **kwargs): + """ + Set(RendererNative renderer) -> RendererNative + + Set the renderer to use, passing None reverts to using the default + renderer. Returns the previous renderer used with Set or None. + """ + return _gdi_.RendererNative_Set(*args, **kwargs) + + Set = staticmethod(Set) + def GetVersion(*args, **kwargs): + """ + GetVersion(self) -> RendererVersion + + Returns the version of the renderer. Will be used for ensuring + compatibility of dynamically loaded renderers. + """ + return _gdi_.RendererNative_GetVersion(*args, **kwargs) + + SplitterParams = property(GetSplitterParams,doc="See `GetSplitterParams`") + Version = property(GetVersion,doc="See `GetVersion`") +_gdi_.RendererNative_swigregister(RendererNative) + +def RendererNative_Get(*args): + """ + RendererNative_Get() -> RendererNative + + Return the currently used renderer + """ + return _gdi_.RendererNative_Get(*args) + +def RendererNative_GetGeneric(*args): + """ + RendererNative_GetGeneric() -> RendererNative + + Return the generic implementation of the renderer. Under some + platforms, this is the default renderer implementation, others have + platform-specific default renderer which can be retrieved by calling + `wx.RendererNative.GetDefault`. + """ + return _gdi_.RendererNative_GetGeneric(*args) + +def RendererNative_GetDefault(*args): + """ + RendererNative_GetDefault() -> RendererNative + + Return the default (native) implementation for this platform -- this + is also the one used by default but this may be changed by calling + `wx.RendererNative.Set` in which case the return value of this method + may be different from the return value of `wx.RendererNative.Get`. + """ + return _gdi_.RendererNative_GetDefault(*args) + +def RendererNative_Set(*args, **kwargs): + """ + RendererNative_Set(RendererNative renderer) -> RendererNative + + Set the renderer to use, passing None reverts to using the default + renderer. Returns the previous renderer used with Set or None. + """ + return _gdi_.RendererNative_Set(*args, **kwargs) + +#--------------------------------------------------------------------------- + +class PseudoDC(_core.Object): + """ + A PseudoDC is an object that can be used as if it were a `wx.DC`. All + commands issued to the PseudoDC are stored in a list. You can then + play these commands back to a real DC object using the DrawToDC + method. Commands in the command list are indexed by ID. You can use + this to clear the operations associated with a single ID and then + re-draw the object associated with that ID. + """ + 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) -> PseudoDC + + Constructs a new Pseudo device context for recording dc operations + """ + _gdi_.PseudoDC_swiginit(self,_gdi_.new_PseudoDC(*args, **kwargs)) + def BeginDrawing(*args, **kwargs): + """ + BeginDrawing(self) + + Allows for optimization of drawing code on platforms that need it. On + other platforms this is just an empty function and is harmless. To + take advantage of this postential optimization simply enclose each + group of calls to the drawing primitives within calls to + `BeginDrawing` and `EndDrawing`. + """ + return _gdi_.PseudoDC_BeginDrawing(*args, **kwargs) + + def EndDrawing(*args, **kwargs): + """ + EndDrawing(self) + + Ends the group of drawing primitives started with `BeginDrawing`, and + invokes whatever optimization is available for this DC type on the + current platform. + """ + return _gdi_.PseudoDC_EndDrawing(*args, **kwargs) + + __swig_destroy__ = _gdi_.delete_PseudoDC + __del__ = lambda self : None; + def RemoveAll(*args, **kwargs): + """ + RemoveAll(self) + + Removes all objects and operations from the recorded list. + """ + return _gdi_.PseudoDC_RemoveAll(*args, **kwargs) + + def GetLen(*args, **kwargs): + """ + GetLen(self) -> int + + Returns the number of operations in the recorded list. + """ + return _gdi_.PseudoDC_GetLen(*args, **kwargs) + + def SetId(*args, **kwargs): + """ + SetId(self, int id) + + Sets the id to be associated with subsequent operations. + """ + return _gdi_.PseudoDC_SetId(*args, **kwargs) + + def ClearId(*args, **kwargs): + """ + ClearId(self, int id) + + Removes all operations associated with id so the object can be redrawn. + """ + return _gdi_.PseudoDC_ClearId(*args, **kwargs) + + def RemoveId(*args, **kwargs): + """ + RemoveId(self, int id) + + Remove the object node (and all operations) associated with an id. + """ + return _gdi_.PseudoDC_RemoveId(*args, **kwargs) + + def TranslateId(*args, **kwargs): + """ + TranslateId(self, int id, int dx, int dy) + + Translate the operations of id by dx,dy. + """ + return _gdi_.PseudoDC_TranslateId(*args, **kwargs) + + def SetIdGreyedOut(*args, **kwargs): + """ + SetIdGreyedOut(self, int id, bool greyout=True) + + Set whether an object is drawn greyed out or not. + """ + return _gdi_.PseudoDC_SetIdGreyedOut(*args, **kwargs) + + def GetIdGreyedOut(*args, **kwargs): + """ + GetIdGreyedOut(self, int id) -> bool + + Get whether an object is drawn greyed out or not. + """ + return _gdi_.PseudoDC_GetIdGreyedOut(*args, **kwargs) + + def FindObjects(*args, **kwargs): + """ + FindObjects(self, int x, int y, int radius=1, wxColor 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). + Returns an empty list if nothing is found. The list is in + reverse drawing order so list[0] is the top id. + """ + return _gdi_.PseudoDC_FindObjects(*args, **kwargs) + + def FindObjectsByBBox(*args, **kwargs): + """ + FindObjectsByBBox(self, int x, int y) -> PyObject + + Returns a list of all the id's whose bounding boxes include (x,y). + Returns an empty list if nothing is found. The list is in + reverse drawing order so list[0] is the top id. + """ + return _gdi_.PseudoDC_FindObjectsByBBox(*args, **kwargs) + + def DrawIdToDC(*args, **kwargs): + """ + DrawIdToDC(self, int id, DC dc) + + Draw recorded operations of id to dc. + """ + return _gdi_.PseudoDC_DrawIdToDC(*args, **kwargs) + + def SetIdBounds(*args, **kwargs): + """ + SetIdBounds(self, int id, Rect rect) + + Set the bounding rect of a given object. This will create + an object node if one doesn't exist. + """ + return _gdi_.PseudoDC_SetIdBounds(*args, **kwargs) + + def GetIdBounds(*args, **kwargs): + """ + GetIdBounds(self, int id) -> Rect + + Returns the bounding rectangle previouly set with SetIdBounds. If + no bounds have been set, it returns wx.Rect(0,0,0,0). + """ + return _gdi_.PseudoDC_GetIdBounds(*args, **kwargs) + + def DrawToDCClipped(*args, **kwargs): + """ + DrawToDCClipped(self, DC dc, Rect rect) + + Draws the recorded operations to dc unless the operation is known to + be outside rect. + """ + return _gdi_.PseudoDC_DrawToDCClipped(*args, **kwargs) + + def DrawToDCClippedRgn(*args, **kwargs): + """ + DrawToDCClippedRgn(self, DC dc, Region region) + + Draws the recorded operations to dc unless the operation is known to + be outside rect. + """ + return _gdi_.PseudoDC_DrawToDCClippedRgn(*args, **kwargs) + + def DrawToDC(*args, **kwargs): + """ + DrawToDC(self, DC dc) + + Draws the recorded operations to dc. + """ + return _gdi_.PseudoDC_DrawToDC(*args, **kwargs) + + def FloodFill(*args, **kwargs): + """ + FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) + + Flood fills the device context starting from the given point, using + the current brush colour, and using a style: + + - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than + the given colour is encountered. + + - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given + colour. + + Returns False if the operation failed. + + Note: The present implementation for non-Windows platforms may fail to + find colour borders if the pixels do not match the colour + exactly. However the function will still return true. + """ + return _gdi_.PseudoDC_FloodFill(*args, **kwargs) + + def FloodFillPoint(*args, **kwargs): + """ + FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) + + Flood fills the device context starting from the given point, using + the current brush colour, and using a style: + + - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than + the given colour is encountered. + + - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given + colour. + + Returns False if the operation failed. + + Note: The present implementation for non-Windows platforms may fail to + find colour borders if the pixels do not match the colour + exactly. However the function will still return true. + """ + return _gdi_.PseudoDC_FloodFillPoint(*args, **kwargs) + + def DrawLine(*args, **kwargs): + """ + DrawLine(self, int x1, int y1, int x2, int y2) + + Draws a line from the first point to the second. The current pen is + used for drawing the line. Note that the second point is *not* part of + the line and is not drawn by this function (this is consistent with + the behaviour of many other toolkits). + """ + return _gdi_.PseudoDC_DrawLine(*args, **kwargs) + + def DrawLinePoint(*args, **kwargs): + """ + DrawLinePoint(self, Point pt1, Point pt2) + + Draws a line from the first point to the second. The current pen is + used for drawing the line. Note that the second point is *not* part of + the line and is not drawn by this function (this is consistent with + the behaviour of many other toolkits). + """ + return _gdi_.PseudoDC_DrawLinePoint(*args, **kwargs) + + def CrossHair(*args, **kwargs): + """ + CrossHair(self, int x, int y) + + Displays a cross hair using the current pen. This is a vertical and + horizontal line the height and width of the window, centred on the + given point. + """ + return _gdi_.PseudoDC_CrossHair(*args, **kwargs) + + def CrossHairPoint(*args, **kwargs): + """ + CrossHairPoint(self, Point pt) + + Displays a cross hair using the current pen. This is a vertical and + horizontal line the height and width of the window, centred on the + given point. + """ + return _gdi_.PseudoDC_CrossHairPoint(*args, **kwargs) + + def DrawArc(*args, **kwargs): + """ + DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc) + + Draws an arc of a circle, centred on the *center* point (xc, yc), from + the first point to the second. The current pen is used for the outline + and the current brush for filling the shape. + + The arc is drawn in an anticlockwise direction from the start point to + the end point. + """ + return _gdi_.PseudoDC_DrawArc(*args, **kwargs) + + def DrawArcPoint(*args, **kwargs): + """ + DrawArcPoint(self, Point pt1, Point pt2, Point center) + + Draws an arc of a circle, centred on the *center* point (xc, yc), from + the first point to the second. The current pen is used for the outline + and the current brush for filling the shape. + + The arc is drawn in an anticlockwise direction from the start point to + the end point. + """ + return _gdi_.PseudoDC_DrawArcPoint(*args, **kwargs) + + def DrawCheckMark(*args, **kwargs): + """ + DrawCheckMark(self, int x, int y, int width, int height) + + Draws a check mark inside the given rectangle. + """ + return _gdi_.PseudoDC_DrawCheckMark(*args, **kwargs) + + def DrawCheckMarkRect(*args, **kwargs): + """ + DrawCheckMarkRect(self, Rect rect) + + Draws a check mark inside the given rectangle. + """ + return _gdi_.PseudoDC_DrawCheckMarkRect(*args, **kwargs) + + def DrawEllipticArc(*args, **kwargs): + """ + DrawEllipticArc(self, int x, int y, int w, int h, double start, double end) + + Draws an arc of an ellipse, with the given rectangle defining the + bounds of the ellipse. The current pen is used for drawing the arc and + the current brush is used for drawing the pie. + + The *start* and *end* parameters specify the start and end of the arc + relative to the three-o'clock position from the center of the + rectangle. Angles are specified in degrees (360 is a complete + circle). Positive values mean counter-clockwise motion. If start is + equal to end, a complete ellipse will be drawn. + """ + return _gdi_.PseudoDC_DrawEllipticArc(*args, **kwargs) + + def DrawEllipticArcPointSize(*args, **kwargs): + """ + DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end) + + Draws an arc of an ellipse, with the given rectangle defining the + bounds of the ellipse. The current pen is used for drawing the arc and + the current brush is used for drawing the pie. + + The *start* and *end* parameters specify the start and end of the arc + relative to the three-o'clock position from the center of the + rectangle. Angles are specified in degrees (360 is a complete + circle). Positive values mean counter-clockwise motion. If start is + equal to end, a complete ellipse will be drawn. + """ + return _gdi_.PseudoDC_DrawEllipticArcPointSize(*args, **kwargs) + + def DrawPoint(*args, **kwargs): + """ + DrawPoint(self, int x, int y) + + Draws a point using the current pen. + """ + return _gdi_.PseudoDC_DrawPoint(*args, **kwargs) + + def DrawPointPoint(*args, **kwargs): + """ + DrawPointPoint(self, Point pt) + + Draws a point using the current pen. + """ + return _gdi_.PseudoDC_DrawPointPoint(*args, **kwargs) + + def DrawRectangle(*args, **kwargs): + """ + DrawRectangle(self, int x, int y, int width, int height) + + Draws a rectangle with the given top left corner, and with the given + size. The current pen is used for the outline and the current brush + for filling the shape. + """ + return _gdi_.PseudoDC_DrawRectangle(*args, **kwargs) + + def DrawRectangleRect(*args, **kwargs): + """ + DrawRectangleRect(self, Rect rect) + + Draws a rectangle with the given top left corner, and with the given + size. The current pen is used for the outline and the current brush + for filling the shape. + """ + return _gdi_.PseudoDC_DrawRectangleRect(*args, **kwargs) + + def DrawRectanglePointSize(*args, **kwargs): + """ + DrawRectanglePointSize(self, Point pt, Size sz) + + Draws a rectangle with the given top left corner, and with the given + size. The current pen is used for the outline and the current brush + for filling the shape. + """ + return _gdi_.PseudoDC_DrawRectanglePointSize(*args, **kwargs) + + def DrawRoundedRectangle(*args, **kwargs): + """ + DrawRoundedRectangle(self, int x, int y, int width, int height, double radius) + + Draws a rectangle with the given top left corner, and with the given + size. The corners are quarter-circles using the given radius. The + current pen is used for the outline and the current brush for filling + the shape. + + If radius is positive, the value is assumed to be the radius of the + rounded corner. If radius is negative, the absolute value is assumed + to be the proportion of the smallest dimension of the rectangle. This + means that the corner can be a sensible size relative to the size of + the rectangle, and also avoids the strange effects X produces when the + corners are too big for the rectangle. + """ + return _gdi_.PseudoDC_DrawRoundedRectangle(*args, **kwargs) + + def DrawRoundedRectangleRect(*args, **kwargs): + """ + DrawRoundedRectangleRect(self, Rect r, double radius) + + Draws a rectangle with the given top left corner, and with the given + size. The corners are quarter-circles using the given radius. The + current pen is used for the outline and the current brush for filling + the shape. + + If radius is positive, the value is assumed to be the radius of the + rounded corner. If radius is negative, the absolute value is assumed + to be the proportion of the smallest dimension of the rectangle. This + means that the corner can be a sensible size relative to the size of + the rectangle, and also avoids the strange effects X produces when the + corners are too big for the rectangle. + """ + return _gdi_.PseudoDC_DrawRoundedRectangleRect(*args, **kwargs) + + def DrawRoundedRectanglePointSize(*args, **kwargs): + """ + DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius) + + Draws a rectangle with the given top left corner, and with the given + size. The corners are quarter-circles using the given radius. The + current pen is used for the outline and the current brush for filling + the shape. + + If radius is positive, the value is assumed to be the radius of the + rounded corner. If radius is negative, the absolute value is assumed + to be the proportion of the smallest dimension of the rectangle. This + means that the corner can be a sensible size relative to the size of + the rectangle, and also avoids the strange effects X produces when the + corners are too big for the rectangle. + """ + return _gdi_.PseudoDC_DrawRoundedRectanglePointSize(*args, **kwargs) + + def DrawCircle(*args, **kwargs): + """ + DrawCircle(self, int x, int y, int radius) + + Draws a circle with the given center point and radius. The current + pen is used for the outline and the current brush for filling the + shape. + """ + return _gdi_.PseudoDC_DrawCircle(*args, **kwargs) + + def DrawCirclePoint(*args, **kwargs): + """ + DrawCirclePoint(self, Point pt, int radius) + + Draws a circle with the given center point and radius. The current + pen is used for the outline and the current brush for filling the + shape. + """ + return _gdi_.PseudoDC_DrawCirclePoint(*args, **kwargs) + + def DrawEllipse(*args, **kwargs): + """ + DrawEllipse(self, int x, int y, int width, int height) + + Draws an ellipse contained in the specified rectangle. The current pen + is used for the outline and the current brush for filling the shape. + """ + return _gdi_.PseudoDC_DrawEllipse(*args, **kwargs) + + def DrawEllipseRect(*args, **kwargs): + """ + DrawEllipseRect(self, Rect rect) + + Draws an ellipse contained in the specified rectangle. The current pen + is used for the outline and the current brush for filling the shape. + """ + return _gdi_.PseudoDC_DrawEllipseRect(*args, **kwargs) + + def DrawEllipsePointSize(*args, **kwargs): + """ + DrawEllipsePointSize(self, Point pt, Size sz) + + Draws an ellipse contained in the specified rectangle. The current pen + is used for the outline and the current brush for filling the shape. + """ + return _gdi_.PseudoDC_DrawEllipsePointSize(*args, **kwargs) + + def DrawIcon(*args, **kwargs): + """ + DrawIcon(self, Icon icon, int x, int y) + + Draw an icon on the display (does nothing if the device context is + PostScript). This can be the simplest way of drawing bitmaps on a + window. + """ + return _gdi_.PseudoDC_DrawIcon(*args, **kwargs) + + def DrawIconPoint(*args, **kwargs): + """ + DrawIconPoint(self, Icon icon, Point pt) + + Draw an icon on the display (does nothing if the device context is + PostScript). This can be the simplest way of drawing bitmaps on a + window. + """ + return _gdi_.PseudoDC_DrawIconPoint(*args, **kwargs) + + def DrawBitmap(*args, **kwargs): + """ + DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False) + + Draw a bitmap on the device context at the specified point. If + *transparent* is true and the bitmap has a transparency mask, (or + alpha channel on the platforms that support it) then the bitmap will + be drawn transparently. + """ + return _gdi_.PseudoDC_DrawBitmap(*args, **kwargs) + + def DrawBitmapPoint(*args, **kwargs): + """ + DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False) + + Draw a bitmap on the device context at the specified point. If + *transparent* is true and the bitmap has a transparency mask, (or + alpha channel on the platforms that support it) then the bitmap will + be drawn transparently. + """ + return _gdi_.PseudoDC_DrawBitmapPoint(*args, **kwargs) + + def DrawText(*args, **kwargs): + """ + DrawText(self, String text, int x, int y) + + Draws a text string at the specified point, using the current text + font, and the current text foreground and background colours. + + The coordinates refer to the top-left corner of the rectangle bounding + the string. See `wx.DC.GetTextExtent` for how to get the dimensions of + a text string, which can be used to position the text more precisely, + (you will need to use a real DC with GetTextExtent as wx.PseudoDC does + not implement it.) + + **NOTE**: under wxGTK the current logical function is used by this + function but it is ignored by wxMSW. Thus, you should avoid using + logical functions with this function in portable programs. + """ + return _gdi_.PseudoDC_DrawText(*args, **kwargs) + + def DrawTextPoint(*args, **kwargs): + """ + DrawTextPoint(self, String text, Point pt) + + Draws a text string at the specified point, using the current text + font, and the current text foreground and background colours. + + The coordinates refer to the top-left corner of the rectangle bounding + the string. See `wx.DC.GetTextExtent` for how to get the dimensions of + a text string, which can be used to position the text more precisely, + (you will need to use a real DC with GetTextExtent as wx.PseudoDC does + not implement it.) + + **NOTE**: under wxGTK the current logical function is used by this + function but it is ignored by wxMSW. Thus, you should avoid using + logical functions with this function in portable programs. + """ + return _gdi_.PseudoDC_DrawTextPoint(*args, **kwargs) + + def DrawRotatedText(*args, **kwargs): + """ + DrawRotatedText(self, String text, int x, int y, double angle) + + Draws the text rotated by *angle* degrees, if supported by the platform. + + **NOTE**: Under Win9x only TrueType fonts can be drawn by this + function. In particular, a font different from ``wx.NORMAL_FONT`` + should be used as the it is not normally a TrueType + font. ``wx.SWISS_FONT`` is an example of a font which is. + """ + return _gdi_.PseudoDC_DrawRotatedText(*args, **kwargs) + + def DrawRotatedTextPoint(*args, **kwargs): + """ + DrawRotatedTextPoint(self, String text, Point pt, double angle) + + Draws the text rotated by *angle* degrees, if supported by the platform. + + **NOTE**: Under Win9x only TrueType fonts can be drawn by this + function. In particular, a font different from ``wx.NORMAL_FONT`` + should be used as the it is not normally a TrueType + font. ``wx.SWISS_FONT`` is an example of a font which is. + """ + return _gdi_.PseudoDC_DrawRotatedTextPoint(*args, **kwargs) + + def DrawLines(*args, **kwargs): + """ + DrawLines(self, List points, int xoffset=0, int yoffset=0) + + Draws lines using a sequence of `wx.Point` objects, adding the + optional offset coordinate. The current pen is used for drawing the + lines. + """ + return _gdi_.PseudoDC_DrawLines(*args, **kwargs) + + def DrawPolygon(*args, **kwargs): + """ + DrawPolygon(self, List points, int xoffset=0, int yoffset=0, + int fillStyle=ODDEVEN_RULE) + + Draws a filled polygon using a sequence of `wx.Point` objects, adding + the optional offset coordinate. The last argument specifies the fill + rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``. + + The current pen is used for drawing the outline, and the current brush + for filling the shape. Using a transparent brush suppresses + filling. Note that wxWidgets automatically closes the first and last + points. + """ + return _gdi_.PseudoDC_DrawPolygon(*args, **kwargs) + + def DrawLabel(*args, **kwargs): + """ + DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, + int indexAccel=-1) + + Draw *text* within the specified rectangle, abiding by the alignment + flags. Will additionally emphasize the character at *indexAccel* if + it is not -1. + """ + return _gdi_.PseudoDC_DrawLabel(*args, **kwargs) + + def DrawImageLabel(*args, **kwargs): + """ + DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, + int indexAccel=-1) + + Draw *text* and an image (which may be ``wx.NullBitmap`` to skip + drawing it) within the specified rectangle, abiding by the alignment + flags. Will additionally emphasize the character at *indexAccel* if + it is not -1. + """ + return _gdi_.PseudoDC_DrawImageLabel(*args, **kwargs) + + def DrawSpline(*args, **kwargs): + """ + DrawSpline(self, List points) + + Draws a spline between all given control points, (a list of `wx.Point` + objects) using the current pen. The spline is drawn using a series of + lines, using an algorithm taken from the X drawing program 'XFIG'. + """ + return _gdi_.PseudoDC_DrawSpline(*args, **kwargs) + + def Clear(*args, **kwargs): + """ + Clear(self) + + Clears the device context using the current background brush. + """ + return _gdi_.PseudoDC_Clear(*args, **kwargs) + + def SetFont(*args, **kwargs): + """ + SetFont(self, Font font) + + Sets the current font for the DC. It must be a valid font, in + particular you should not pass ``wx.NullFont`` to this method. + """ + return _gdi_.PseudoDC_SetFont(*args, **kwargs) + + def SetPen(*args, **kwargs): + """ + SetPen(self, Pen pen) + + Sets the current pen for the DC. + + If the argument is ``wx.NullPen``, the current pen is selected out of the + device context, and the original pen restored. + """ + return _gdi_.PseudoDC_SetPen(*args, **kwargs) + + def SetBrush(*args, **kwargs): + """ + SetBrush(self, Brush brush) + + Sets the current brush for the DC. + + If the argument is ``wx.NullBrush``, the current brush is selected out + of the device context, and the original brush restored, allowing the + current brush to be destroyed safely. + """ + return _gdi_.PseudoDC_SetBrush(*args, **kwargs) + + def SetBackground(*args, **kwargs): + """ + SetBackground(self, Brush brush) + + Sets the current background brush for the DC. + """ + return _gdi_.PseudoDC_SetBackground(*args, **kwargs) + + def SetBackgroundMode(*args, **kwargs): + """ + SetBackgroundMode(self, int mode) + + *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting + determines whether text will be drawn with a background colour or + not. + """ + return _gdi_.PseudoDC_SetBackgroundMode(*args, **kwargs) + + def SetPalette(*args, **kwargs): + """ + SetPalette(self, Palette palette) + + If this is a window DC or memory DC, assigns the given palette to the + window or bitmap associated with the DC. If the argument is + ``wx.NullPalette``, the current palette is selected out of the device + context, and the original palette restored. + """ + return _gdi_.PseudoDC_SetPalette(*args, **kwargs) + + def SetTextForeground(*args, **kwargs): + """ + SetTextForeground(self, Colour colour) + + Sets the current text foreground colour for the DC. + """ + return _gdi_.PseudoDC_SetTextForeground(*args, **kwargs) + + def SetTextBackground(*args, **kwargs): + """ + SetTextBackground(self, Colour colour) + + Sets the current text background colour for the DC. + """ + return _gdi_.PseudoDC_SetTextBackground(*args, **kwargs) + + def SetLogicalFunction(*args, **kwargs): + """ + SetLogicalFunction(self, int function) + + Sets the current logical function for the device context. This + determines how a source pixel (from a pen or brush colour, combines + with a destination pixel in the current device context. + + The possible values and their meaning in terms of source and + destination pixel values are as follows: + + ================ ========================== + wx.AND src AND dst + wx.AND_INVERT (NOT src) AND dst + wx.AND_REVERSE src AND (NOT dst) + wx.CLEAR 0 + wx.COPY src + wx.EQUIV (NOT src) XOR dst + wx.INVERT NOT dst + wx.NAND (NOT src) OR (NOT dst) + wx.NOR (NOT src) AND (NOT dst) + wx.NO_OP dst + wx.OR src OR dst + wx.OR_INVERT (NOT src) OR dst + wx.OR_REVERSE src OR (NOT dst) + wx.SET 1 + wx.SRC_INVERT NOT src + wx.XOR src XOR dst + ================ ========================== + + The default is wx.COPY, which simply draws with the current + colour. The others combine the current colour and the background using + a logical operation. wx.INVERT is commonly used for drawing rubber + bands or moving outlines, since drawing twice reverts to the original + colour. + + """ + return _gdi_.PseudoDC_SetLogicalFunction(*args, **kwargs) + IdBounds = property(GetIdBounds,SetIdBounds,doc="See `GetIdBounds` and `SetIdBounds`") + Len = property(GetLen,doc="See `GetLen`") +_gdi_.PseudoDC_swigregister(PseudoDC) -class EffectsPtr(Effects): - def __init__(self, this): - self.this = this - if not hasattr(self,"thisown"): self.thisown = 0 - self.__class__ = Effects -_gdi_.Effects_swigregister(EffectsPtr) -TheFontList = cvar.TheFontList -ThePenList = cvar.ThePenList -TheBrushList = cvar.TheBrushList -TheColourDatabase = cvar.TheColourDatabase