X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/27e45892536c571947a72cef7f4bf77fe613c9ec..205d49f79e084d964b7f91388ec92d53ab4700a7:/wxPython/src/msw/_gdi.py diff --git a/wxPython/src/msw/_gdi.py b/wxPython/src/msw/_gdi.py index 7869a827b7..1ca38b70b7 100644 --- a/wxPython/src/msw/_gdi.py +++ b/wxPython/src/msw/_gdi.py @@ -75,6 +75,8 @@ _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 @@ -102,7 +104,7 @@ class Colour(_core.Object): __repr__ = _swig_repr def __init__(self, *args, **kwargs): """ - __init__(self, byte red=0, byte green=0, byte 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. @@ -136,6 +138,14 @@ class Colour(_core.Object): """ return _gdi_.Colour_Blue(*args, **kwargs) + def Alpha(*args, **kwargs): + """ + Alpha(self) -> byte + + Returns the Alpha value. + """ + return _gdi_.Colour_Alpha(*args, **kwargs) + def Ok(*args, **kwargs): """ Ok(self) -> bool @@ -147,7 +157,7 @@ class Colour(_core.Object): def Set(*args, **kwargs): """ - Set(self, byte red, byte green, byte blue) + Set(self, byte red, byte green, byte blue, byte alpha=ALPHA_OPAQUE) Sets the RGB intensity values. """ @@ -227,12 +237,14 @@ class Colour(_core.Object): return _gdi_.Colour_GetRGB(*args, **kwargs) asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") - def __str__(self): return str(self.Get()) - def __repr__(self): return 'wx.Colour' + str(self.Get()) + def __str__(self): return str(self.Get(True)) + def __repr__(self): return 'wx.Colour' + str(self.Get(True)) def __nonzero__(self): return self.Ok() __safe_for_unpickling__ = True - def __reduce__(self): return (Colour, self.Get()) + def __reduce__(self): return (Colour, self.Get(True)) + Pixel = property(GetPixel,doc="See `GetPixel`") + RGB = property(GetRGB,SetRGB,doc="See `GetRGB` and `SetRGB`") _gdi_.Colour_swigregister(Colour) def NamedColour(*args, **kwargs): @@ -284,6 +296,7 @@ class Palette(GDIObject): return _gdi_.Palette_Ok(*args, **kwargs) def __nonzero__(self): return self.Ok() + ColoursCount = property(GetColoursCount,doc="See `GetColoursCount`") _gdi_.Palette_swigregister(Palette) #--------------------------------------------------------------------------- @@ -363,6 +376,7 @@ class Pen(GDIObject): """GetDashCount(self) -> int""" return _gdi_.Pen_GetDashCount(*args, **kwargs) + DashCount = property(GetDashCount,doc="See `GetDashCount`") def GetStipple(*args, **kwargs): """GetStipple(self) -> Bitmap""" return _gdi_.Pen_GetStipple(*args, **kwargs) @@ -371,6 +385,7 @@ class Pen(GDIObject): """SetStipple(self, Bitmap stipple)""" return _gdi_.Pen_SetStipple(*args, **kwargs) + Stipple = property(GetStipple,SetStipple,doc="See `GetStipple` and `SetStipple`") def __eq__(*args, **kwargs): """__eq__(self, Pen other) -> bool""" return _gdi_.Pen___eq__(*args, **kwargs) @@ -380,6 +395,12 @@ class Pen(GDIObject): return _gdi_.Pen___ne__(*args, **kwargs) def __nonzero__(self): return self.Ok() + 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) #--------------------------------------------------------------------------- @@ -469,6 +490,9 @@ class Brush(GDIObject): return _gdi_.Brush_Ok(*args, **kwargs) def __nonzero__(self): return self.Ok() + 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 BrushFromBitmap(*args, **kwargs): @@ -671,6 +695,13 @@ class Bitmap(GDIObject): """__ne__(self, Bitmap other) -> bool""" return _gdi_.Bitmap___ne__(*args, **kwargs) + 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): @@ -727,6 +758,331 @@ def BitmapFromBits(*args, **kwargs): val = _gdi_.new_BitmapFromBits(*args, **kwargs) 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 @@ -817,6 +1173,9 @@ class Icon(GDIObject): return _gdi_.Icon_CopyFromBitmap(*args, **kwargs) def __nonzero__(self): return self.Ok() + 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): @@ -869,6 +1228,8 @@ class IconLocation(object): """GetIndex(self) -> int""" return _gdi_.IconLocation_GetIndex(*args, **kwargs) + 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): @@ -892,6 +1253,7 @@ class IconBundle(object): """GetIcon(self, Size size) -> Icon""" return _gdi_.IconBundle_GetIcon(*args, **kwargs) + Icon = property(GetIcon,doc="See `GetIcon`") _gdi_.IconBundle_swigregister(IconBundle) def IconBundleFromFile(*args, **kwargs): @@ -1058,6 +1420,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) @@ -1106,6 +1472,7 @@ class Region(GDIObject): """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool""" return _gdi_.Region_UnionBitmapColour(*args, **kwargs) + Box = property(GetBox,doc="See `GetBox`") _gdi_.Region_swigregister(Region) def RegionFromBitmap(*args, **kwargs): @@ -1176,6 +1543,13 @@ class RegionIterator(_core.Object): """__nonzero__(self) -> bool""" return _gdi_.RegionIterator___nonzero__(*args, **kwargs) + 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) #--------------------------------------------------------------------------- @@ -1407,6 +1781,13 @@ class NativeFontInfo(object): """ToUserString(self) -> String""" return _gdi_.NativeFontInfo_ToUserString(*args, **kwargs) + 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): @@ -1513,6 +1894,7 @@ class FontMapper(object): """SetDialogTitle(self, String title)""" return _gdi_.FontMapper_SetDialogTitle(*args, **kwargs) + AltForEncoding = property(GetAltForEncoding,doc="See `GetAltForEncoding`") _gdi_.FontMapper_swigregister(FontMapper) def FontMapper_Get(*args): @@ -1873,6 +2255,21 @@ class Font(GDIObject): return _gdi_.Font_SetDefaultEncoding(*args, **kwargs) SetDefaultEncoding = staticmethod(SetDefaultEncoding) + 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): @@ -2360,6 +2757,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) @@ -2392,6 +2794,12 @@ 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) def Locale_GetSystemLanguage(*args): @@ -2410,6 +2818,10 @@ def 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) @@ -2426,6 +2838,34 @@ def 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)) + self._setCallbackInfo(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): """GetLocale() -> Locale""" @@ -2477,7 +2917,9 @@ _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) @@ -3296,9 +3738,9 @@ class DC(_core.Object): 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 + 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. """ @@ -3969,6 +4411,35 @@ class DC(_core.Object): raise ValueError('backgrounds and coords must have same length') return self._DrawTextList(textList, coords, foregrounds, backgrounds) + 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`") _gdi_.DC_swigregister(DC) #--------------------------------------------------------------------------- @@ -4040,11 +4511,15 @@ class BufferedDC(MemoryDC): `wx.Bitmap`) and then copied to the screen only once, when this object is destroyed. - It 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 + It 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`. + Please note that GTK+ 2.0 and OS X provide double buffering themselves + natively so using this class on those platforms will normally result + in an unneeded level of buffering. + """ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') __repr__ = _swig_repr @@ -4317,6 +4792,7 @@ class PostScriptDC(DC): return _gdi_.PostScriptDC_GetResolution(*args, **kwargs) GetResolution = staticmethod(GetResolution) + PrintData = property(GetPrintData,SetPrintData,doc="See `GetPrintData` and `SetPrintData`") _gdi_.PostScriptDC_swigregister(PostScriptDC) def PostScriptDC_SetResolution(*args, **kwargs): @@ -4464,6 +4940,8 @@ class ImageList(_core.Object): """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) #--------------------------------------------------------------------------- @@ -4870,6 +5348,11 @@ class Effects(_core.Object): """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) #--------------------------------------------------------------------------- @@ -4877,9 +5360,11 @@ _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 @@ -4925,6 +5410,31 @@ class SplitterRenderParams(object): 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 @@ -4961,11 +5471,12 @@ def 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 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. + 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 @@ -4983,13 +5494,33 @@ class RendererNative(object): __repr__ = _swig_repr def DrawHeaderButton(*args, **kwargs): """ - DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0) + DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE, + HeaderButtonParams params=None) Draw the header control button (such as what is used by `wx.ListCtrl` in report mode.) """ 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) + + 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) @@ -5104,7 +5635,7 @@ class RendererNative(object): 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 - `GetDefault`. + `wx.RendererNative.GetDefault`. """ return _gdi_.RendererNative_GetGeneric(*args, **kwargs) @@ -5114,9 +5645,9 @@ class RendererNative(object): 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 `Set` - in which case the return value of this method may be different from - the return value of `Get`. + 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) @@ -5140,6 +5671,8 @@ class RendererNative(object): """ 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): @@ -5157,7 +5690,7 @@ def RendererNative_GetGeneric(*args): 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 - `GetDefault`. + `wx.RendererNative.GetDefault`. """ return _gdi_.RendererNative_GetGeneric(*args) @@ -5166,9 +5699,9 @@ 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 `Set` - in which case the return value of this method may be different from - the return value of `Get`. + 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) @@ -5680,8 +6213,10 @@ class PseudoDC(_core.Object): 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. + 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 @@ -5697,8 +6232,10 @@ class PseudoDC(_core.Object): 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. + 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 @@ -5881,9 +6418,8 @@ class PseudoDC(_core.Object): 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. + 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: @@ -5916,6 +6452,8 @@ class PseudoDC(_core.Object): """ 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)