1 # This file was created automatically by SWIG 1.3.29.
2 # Don't modify this file, modify the SWIG interface instead.
6 new_instancemethod
= new
.instancemethod
7 def _swig_setattr_nondynamic(self
,class_type
,name
,value
,static
=1):
8 if (name
== "thisown"): return self
.this
.own(value
)
10 if type(value
).__name
__ == 'PySwigObject':
11 self
.__dict
__[name
] = value
13 method
= class_type
.__swig
_setmethods
__.get(name
,None)
14 if method
: return method(self
,value
)
15 if (not static
) or hasattr(self
,name
):
16 self
.__dict
__[name
] = value
18 raise AttributeError("You cannot add attributes to %s" % self
)
20 def _swig_setattr(self
,class_type
,name
,value
):
21 return _swig_setattr_nondynamic(self
,class_type
,name
,value
,0)
23 def _swig_getattr(self
,class_type
,name
):
24 if (name
== "thisown"): return self
.this
.own()
25 method
= class_type
.__swig
_getmethods
__.get(name
,None)
26 if method
: return method(self
)
27 raise AttributeError,name
30 try: strthis
= "proxy of " + self
.this
.__repr
__()
32 return "<%s.%s; %s >" % (self
.__class
__.__module
__, self
.__class
__.__name
__, strthis
,)
36 _object
= types
.ObjectType
38 except AttributeError:
44 def _swig_setattr_nondynamic_method(set):
45 def set_attr(self
,name
,value
):
46 if (name
== "thisown"): return self
.this
.own(value
)
47 if hasattr(self
,name
) or (name
== "this"):
50 raise AttributeError("You cannot add attributes to %s" % self
)
56 #---------------------------------------------------------------------------
58 class GDIObject(_core
.Object
):
59 """Proxy of C++ GDIObject class"""
60 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
62 def __init__(self
, *args
, **kwargs
):
63 """__init__(self) -> GDIObject"""
64 _gdi_
.GDIObject_swiginit(self
,_gdi_
.new_GDIObject(*args
, **kwargs
))
65 __swig_destroy__
= _gdi_
.delete_GDIObject
66 __del__
= lambda self
: None;
67 def GetVisible(*args
, **kwargs
):
68 """GetVisible(self) -> bool"""
69 return _gdi_
.GDIObject_GetVisible(*args
, **kwargs
)
71 def SetVisible(*args
, **kwargs
):
72 """SetVisible(self, bool visible)"""
73 return _gdi_
.GDIObject_SetVisible(*args
, **kwargs
)
75 def IsNull(*args
, **kwargs
):
76 """IsNull(self) -> bool"""
77 return _gdi_
.GDIObject_IsNull(*args
, **kwargs
)
79 GDIObject_swigregister
= _gdi_
.GDIObject_swigregister
80 GDIObject_swigregister(GDIObject
)
82 #---------------------------------------------------------------------------
84 class Colour(_core
.Object
):
86 A colour is an object representing a combination of Red, Green, and
87 Blue (RGB) intensity values, and is used to determine drawing colours,
88 window colours, etc. Valid RGB values are in the range 0 to 255.
90 In wxPython there are typemaps that will automatically convert from a
91 colour name, from a '#RRGGBB' colour hex value string, or from a 3
92 integer tuple to a wx.Colour object when calling C++ methods that
93 expect a wxColour. This means that the following are all
96 win.SetBackgroundColour(wxColour(0,0,255))
97 win.SetBackgroundColour('BLUE')
98 win.SetBackgroundColour('#0000FF')
99 win.SetBackgroundColour((0,0,255))
101 Additional colour names and their coresponding values can be added
102 using `wx.ColourDatabase`. Various system colours (as set in the
103 user's system preferences) can be retrieved with
104 `wx.SystemSettings.GetColour`.
107 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
108 __repr__
= _swig_repr
109 def __init__(self
, *args
, **kwargs
):
111 __init__(self, byte red=0, byte green=0, byte blue=0) -> Colour
113 Constructs a colour from red, green and blue values.
115 :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
118 _gdi_
.Colour_swiginit(self
,_gdi_
.new_Colour(*args
, **kwargs
))
119 __swig_destroy__
= _gdi_
.delete_Colour
120 __del__
= lambda self
: None;
121 def Red(*args
, **kwargs
):
125 Returns the red intensity.
127 return _gdi_
.Colour_Red(*args
, **kwargs
)
129 def Green(*args
, **kwargs
):
133 Returns the green intensity.
135 return _gdi_
.Colour_Green(*args
, **kwargs
)
137 def Blue(*args
, **kwargs
):
141 Returns the blue intensity.
143 return _gdi_
.Colour_Blue(*args
, **kwargs
)
145 def Ok(*args
, **kwargs
):
149 Returns True if the colour object is valid (the colour has been
150 initialised with RGB values).
152 return _gdi_
.Colour_Ok(*args
, **kwargs
)
154 def Set(*args
, **kwargs
):
156 Set(self, byte red, byte green, byte blue)
158 Sets the RGB intensity values.
160 return _gdi_
.Colour_Set(*args
, **kwargs
)
162 def SetRGB(*args
, **kwargs
):
164 SetRGB(self, unsigned long colRGB)
166 Sets the RGB intensity values from a packed RGB value.
168 return _gdi_
.Colour_SetRGB(*args
, **kwargs
)
170 def SetFromName(*args
, **kwargs
):
172 SetFromName(self, String colourName)
174 Sets the RGB intensity values using a colour name listed in
175 ``wx.TheColourDatabase``.
177 return _gdi_
.Colour_SetFromName(*args
, **kwargs
)
179 def GetPixel(*args
, **kwargs
):
181 GetPixel(self) -> long
183 Returns a pixel value which is platform-dependent. On Windows, a
184 COLORREF is returned. On X, an allocated pixel value is returned. -1
185 is returned if the pixel is invalid (on X, unallocated).
187 return _gdi_
.Colour_GetPixel(*args
, **kwargs
)
189 def __eq__(*args
, **kwargs
):
191 __eq__(self, PyObject other) -> bool
193 Compare colours for equality.
195 return _gdi_
.Colour___eq__(*args
, **kwargs
)
197 def __ne__(*args
, **kwargs
):
199 __ne__(self, PyObject other) -> bool
201 Compare colours for inequality.
203 return _gdi_
.Colour___ne__(*args
, **kwargs
)
205 def Get(*args
, **kwargs
):
209 Returns the RGB intensity values as a tuple.
211 return _gdi_
.Colour_Get(*args
, **kwargs
)
213 def GetRGB(*args
, **kwargs
):
215 GetRGB(self) -> unsigned long
217 Return the colour as a packed RGB value
219 return _gdi_
.Colour_GetRGB(*args
, **kwargs
)
221 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
222 def __str__(self
): return str(self
.Get())
223 def __repr__(self
): return 'wx.Colour' + str(self
.Get())
224 def __nonzero__(self
): return self
.Ok()
225 __safe_for_unpickling__
= True
226 def __reduce__(self
): return (Colour
, self
.Get())
228 Colour_swigregister
= _gdi_
.Colour_swigregister
229 Colour_swigregister(Colour
)
231 def NamedColour(*args
, **kwargs
):
233 NamedColour(String colorName) -> Colour
235 Constructs a colour object using a colour name listed in
236 ``wx.TheColourDatabase``.
238 val
= _gdi_
.new_NamedColour(*args
, **kwargs
)
241 def ColourRGB(*args
, **kwargs
):
243 ColourRGB(unsigned long colRGB) -> Colour
245 Constructs a colour from a packed RGB value.
247 val
= _gdi_
.new_ColourRGB(*args
, **kwargs
)
251 NamedColor
= NamedColour
254 class Palette(GDIObject
):
255 """Proxy of C++ Palette class"""
256 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
257 __repr__
= _swig_repr
258 def __init__(self
, *args
, **kwargs
):
259 """__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette"""
260 _gdi_
.Palette_swiginit(self
,_gdi_
.new_Palette(*args
, **kwargs
))
261 __swig_destroy__
= _gdi_
.delete_Palette
262 __del__
= lambda self
: None;
263 def GetPixel(*args
, **kwargs
):
264 """GetPixel(self, byte red, byte green, byte blue) -> int"""
265 return _gdi_
.Palette_GetPixel(*args
, **kwargs
)
267 def GetRGB(*args
, **kwargs
):
268 """GetRGB(self, int pixel) -> (R,G,B)"""
269 return _gdi_
.Palette_GetRGB(*args
, **kwargs
)
271 def GetColoursCount(*args
, **kwargs
):
272 """GetColoursCount(self) -> int"""
273 return _gdi_
.Palette_GetColoursCount(*args
, **kwargs
)
275 def Ok(*args
, **kwargs
):
276 """Ok(self) -> bool"""
277 return _gdi_
.Palette_Ok(*args
, **kwargs
)
279 def __nonzero__(self
): return self
.Ok()
280 Palette_swigregister
= _gdi_
.Palette_swigregister
281 Palette_swigregister(Palette
)
283 #---------------------------------------------------------------------------
285 class Pen(GDIObject
):
286 """Proxy of C++ Pen class"""
287 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
288 __repr__
= _swig_repr
289 def __init__(self
, *args
, **kwargs
):
290 """__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen"""
291 _gdi_
.Pen_swiginit(self
,_gdi_
.new_Pen(*args
, **kwargs
))
292 __swig_destroy__
= _gdi_
.delete_Pen
293 __del__
= lambda self
: None;
294 def GetCap(*args
, **kwargs
):
295 """GetCap(self) -> int"""
296 return _gdi_
.Pen_GetCap(*args
, **kwargs
)
298 def GetColour(*args
, **kwargs
):
299 """GetColour(self) -> Colour"""
300 return _gdi_
.Pen_GetColour(*args
, **kwargs
)
302 def GetJoin(*args
, **kwargs
):
303 """GetJoin(self) -> int"""
304 return _gdi_
.Pen_GetJoin(*args
, **kwargs
)
306 def GetStyle(*args
, **kwargs
):
307 """GetStyle(self) -> int"""
308 return _gdi_
.Pen_GetStyle(*args
, **kwargs
)
310 def GetWidth(*args
, **kwargs
):
311 """GetWidth(self) -> int"""
312 return _gdi_
.Pen_GetWidth(*args
, **kwargs
)
314 def Ok(*args
, **kwargs
):
315 """Ok(self) -> bool"""
316 return _gdi_
.Pen_Ok(*args
, **kwargs
)
318 def SetCap(*args
, **kwargs
):
319 """SetCap(self, int cap_style)"""
320 return _gdi_
.Pen_SetCap(*args
, **kwargs
)
322 def SetColour(*args
, **kwargs
):
323 """SetColour(self, Colour colour)"""
324 return _gdi_
.Pen_SetColour(*args
, **kwargs
)
326 def SetJoin(*args
, **kwargs
):
327 """SetJoin(self, int join_style)"""
328 return _gdi_
.Pen_SetJoin(*args
, **kwargs
)
330 def SetStyle(*args
, **kwargs
):
331 """SetStyle(self, int style)"""
332 return _gdi_
.Pen_SetStyle(*args
, **kwargs
)
334 def SetWidth(*args
, **kwargs
):
335 """SetWidth(self, int width)"""
336 return _gdi_
.Pen_SetWidth(*args
, **kwargs
)
338 def SetDashes(*args
, **kwargs
):
339 """SetDashes(self, int dashes)"""
340 return _gdi_
.Pen_SetDashes(*args
, **kwargs
)
342 def GetDashes(*args
, **kwargs
):
343 """GetDashes(self) -> PyObject"""
344 return _gdi_
.Pen_GetDashes(*args
, **kwargs
)
346 def _SetDashes(*args
, **kwargs
):
347 """_SetDashes(self, PyObject _self, PyObject pyDashes)"""
348 return _gdi_
.Pen__SetDashes(*args
, **kwargs
)
350 def SetDashes(self
, dashes
):
352 Associate a list of dash lengths with the Pen.
354 self
._SetDashes
(self
, dashes
)
356 def __eq__(*args
, **kwargs
):
357 """__eq__(self, Pen other) -> bool"""
358 return _gdi_
.Pen___eq__(*args
, **kwargs
)
360 def __ne__(*args
, **kwargs
):
361 """__ne__(self, Pen other) -> bool"""
362 return _gdi_
.Pen___ne__(*args
, **kwargs
)
364 def __nonzero__(self
): return self
.Ok()
365 Pen_swigregister
= _gdi_
.Pen_swigregister
366 Pen_swigregister(Pen
)
368 #---------------------------------------------------------------------------
370 class Brush(GDIObject
):
372 A brush is a drawing tool for filling in areas. It is used for
373 painting the background of rectangles, ellipses, etc. when drawing on
374 a `wx.DC`. It has a colour and a style.
376 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
377 __repr__
= _swig_repr
378 def __init__(self
, *args
, **kwargs
):
380 __init__(self, Colour colour, int style=SOLID) -> Brush
382 Constructs a brush from a `wx.Colour` object and a style.
384 _gdi_
.Brush_swiginit(self
,_gdi_
.new_Brush(*args
, **kwargs
))
385 __swig_destroy__
= _gdi_
.delete_Brush
386 __del__
= lambda self
: None;
387 def SetColour(*args
, **kwargs
):
389 SetColour(self, Colour col)
391 Set the brush's `wx.Colour`.
393 return _gdi_
.Brush_SetColour(*args
, **kwargs
)
395 def SetStyle(*args
, **kwargs
):
397 SetStyle(self, int style)
399 Sets the style of the brush. See `__init__` for a listing of styles.
401 return _gdi_
.Brush_SetStyle(*args
, **kwargs
)
403 def SetStipple(*args
, **kwargs
):
405 SetStipple(self, Bitmap stipple)
407 Sets the stipple `wx.Bitmap`.
409 return _gdi_
.Brush_SetStipple(*args
, **kwargs
)
411 def GetColour(*args
, **kwargs
):
413 GetColour(self) -> Colour
415 Returns the `wx.Colour` of the brush.
417 return _gdi_
.Brush_GetColour(*args
, **kwargs
)
419 def GetStyle(*args
, **kwargs
):
421 GetStyle(self) -> int
423 Returns the style of the brush. See `__init__` for a listing of
426 return _gdi_
.Brush_GetStyle(*args
, **kwargs
)
428 def GetStipple(*args
, **kwargs
):
430 GetStipple(self) -> Bitmap
432 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
433 have a wx.STIPPLE style, then the return value may be non-None but an
434 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
436 return _gdi_
.Brush_GetStipple(*args
, **kwargs
)
438 def IsHatch(*args
, **kwargs
):
440 IsHatch(self) -> bool
442 Is the current style a hatch type?
444 return _gdi_
.Brush_IsHatch(*args
, **kwargs
)
446 def Ok(*args
, **kwargs
):
450 Returns True if the brush is initialised and valid.
452 return _gdi_
.Brush_Ok(*args
, **kwargs
)
454 def MacGetTheme(*args
, **kwargs
):
455 """MacGetTheme(self) -> short"""
456 return _gdi_
.Brush_MacGetTheme(*args
, **kwargs
)
458 def MacSetTheme(*args
, **kwargs
):
459 """MacSetTheme(self, short macThemeBrush)"""
460 return _gdi_
.Brush_MacSetTheme(*args
, **kwargs
)
462 def __nonzero__(self
): return self
.Ok()
463 Brush_swigregister
= _gdi_
.Brush_swigregister
464 Brush_swigregister(Brush
)
466 def BrushFromBitmap(*args
, **kwargs
):
468 BrushFromBitmap(Bitmap stippleBitmap) -> Brush
470 Constructs a stippled brush using a bitmap.
472 val
= _gdi_
.new_BrushFromBitmap(*args
, **kwargs
)
475 class Bitmap(GDIObject
):
477 The wx.Bitmap class encapsulates the concept of a platform-dependent
478 bitmap. It can be either monochrome or colour, and either loaded from
479 a file or created dynamically. A bitmap can be selected into a memory
480 device context (instance of `wx.MemoryDC`). This enables the bitmap to
481 be copied to a window or memory device context using `wx.DC.Blit`, or
482 to be used as a drawing surface.
484 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
485 __repr__
= _swig_repr
486 def __init__(self
, *args
, **kwargs
):
488 __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap
490 Loads a bitmap from a file.
492 _gdi_
.Bitmap_swiginit(self
,_gdi_
.new_Bitmap(*args
, **kwargs
))
493 __swig_destroy__
= _gdi_
.delete_Bitmap
494 __del__
= lambda self
: None;
495 def Ok(*args
, **kwargs
):
496 """Ok(self) -> bool"""
497 return _gdi_
.Bitmap_Ok(*args
, **kwargs
)
499 def GetWidth(*args
, **kwargs
):
501 GetWidth(self) -> int
503 Gets the width of the bitmap in pixels.
505 return _gdi_
.Bitmap_GetWidth(*args
, **kwargs
)
507 def GetHeight(*args
, **kwargs
):
509 GetHeight(self) -> int
511 Gets the height of the bitmap in pixels.
513 return _gdi_
.Bitmap_GetHeight(*args
, **kwargs
)
515 def GetDepth(*args
, **kwargs
):
517 GetDepth(self) -> int
519 Gets the colour depth of the bitmap. A value of 1 indicates a
522 return _gdi_
.Bitmap_GetDepth(*args
, **kwargs
)
524 def GetSize(*args
, **kwargs
):
526 GetSize(self) -> Size
528 Get the size of the bitmap.
530 return _gdi_
.Bitmap_GetSize(*args
, **kwargs
)
532 def ConvertToImage(*args
, **kwargs
):
534 ConvertToImage(self) -> Image
536 Creates a platform-independent image from a platform-dependent
537 bitmap. This preserves mask information so that bitmaps and images can
538 be converted back and forth without loss in that respect.
540 return _gdi_
.Bitmap_ConvertToImage(*args
, **kwargs
)
542 def GetMask(*args
, **kwargs
):
544 GetMask(self) -> Mask
546 Gets the associated mask (if any) which may have been loaded from a
547 file or explpicitly set for the bitmap.
549 :see: `SetMask`, `wx.Mask`
552 return _gdi_
.Bitmap_GetMask(*args
, **kwargs
)
554 def SetMask(*args
, **kwargs
):
556 SetMask(self, Mask mask)
558 Sets the mask for this bitmap.
560 :see: `GetMask`, `wx.Mask`
563 return _gdi_
.Bitmap_SetMask(*args
, **kwargs
)
565 def SetMaskColour(*args
, **kwargs
):
567 SetMaskColour(self, Colour colour)
569 Create a Mask based on a specified colour in the Bitmap.
571 return _gdi_
.Bitmap_SetMaskColour(*args
, **kwargs
)
573 def GetSubBitmap(*args
, **kwargs
):
575 GetSubBitmap(self, Rect rect) -> Bitmap
577 Returns a sub-bitmap of the current one as long as the rect belongs
578 entirely to the bitmap. This function preserves bit depth and mask
581 return _gdi_
.Bitmap_GetSubBitmap(*args
, **kwargs
)
583 def SaveFile(*args
, **kwargs
):
585 SaveFile(self, String name, int type, Palette palette=None) -> bool
587 Saves a bitmap in the named file. See `__init__` for a description of
588 the ``type`` parameter.
590 return _gdi_
.Bitmap_SaveFile(*args
, **kwargs
)
592 def LoadFile(*args
, **kwargs
):
594 LoadFile(self, String name, int type) -> bool
596 Loads a bitmap from a file. See `__init__` for a description of the
599 return _gdi_
.Bitmap_LoadFile(*args
, **kwargs
)
601 def GetPalette(*args
, **kwargs
):
602 """GetPalette(self) -> Palette"""
603 return _gdi_
.Bitmap_GetPalette(*args
, **kwargs
)
605 def CopyFromIcon(*args
, **kwargs
):
606 """CopyFromIcon(self, Icon icon) -> bool"""
607 return _gdi_
.Bitmap_CopyFromIcon(*args
, **kwargs
)
609 def SetHeight(*args
, **kwargs
):
611 SetHeight(self, int height)
613 Set the height property (does not affect the existing bitmap data).
615 return _gdi_
.Bitmap_SetHeight(*args
, **kwargs
)
617 def SetWidth(*args
, **kwargs
):
619 SetWidth(self, int width)
621 Set the width property (does not affect the existing bitmap data).
623 return _gdi_
.Bitmap_SetWidth(*args
, **kwargs
)
625 def SetDepth(*args
, **kwargs
):
627 SetDepth(self, int depth)
629 Set the depth property (does not affect the existing bitmap data).
631 return _gdi_
.Bitmap_SetDepth(*args
, **kwargs
)
633 def SetSize(*args
, **kwargs
):
635 SetSize(self, Size size)
637 Set the bitmap size (does not affect the existing bitmap data).
639 return _gdi_
.Bitmap_SetSize(*args
, **kwargs
)
641 def __nonzero__(self
): return self
.Ok()
642 def __eq__(*args
, **kwargs
):
643 """__eq__(self, Bitmap other) -> bool"""
644 return _gdi_
.Bitmap___eq__(*args
, **kwargs
)
646 def __ne__(*args
, **kwargs
):
647 """__ne__(self, Bitmap other) -> bool"""
648 return _gdi_
.Bitmap___ne__(*args
, **kwargs
)
650 Bitmap_swigregister
= _gdi_
.Bitmap_swigregister
651 Bitmap_swigregister(Bitmap
)
653 def EmptyBitmap(*args
, **kwargs
):
655 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
657 Creates a new bitmap of the given size. A depth of -1 indicates the
658 depth of the current screen or visual. Some platforms only support 1
659 for monochrome and -1 for the current display depth.
661 val
= _gdi_
.new_EmptyBitmap(*args
, **kwargs
)
664 def BitmapFromIcon(*args
, **kwargs
):
666 BitmapFromIcon(Icon icon) -> Bitmap
668 Create a new bitmap from a `wx.Icon` object.
670 val
= _gdi_
.new_BitmapFromIcon(*args
, **kwargs
)
673 def BitmapFromImage(*args
, **kwargs
):
675 BitmapFromImage(Image image, int depth=-1) -> Bitmap
677 Creates bitmap object from a `wx.Image`. This has to be done to
678 actually display a `wx.Image` as you cannot draw an image directly on
679 a window. The resulting bitmap will use the provided colour depth (or
680 that of the current screen colour depth if depth is -1) which entails
681 that a colour reduction may have to take place.
683 val
= _gdi_
.new_BitmapFromImage(*args
, **kwargs
)
686 def BitmapFromXPMData(*args
, **kwargs
):
688 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
690 Construct a Bitmap from a list of strings formatted as XPM data.
692 val
= _gdi_
.new_BitmapFromXPMData(*args
, **kwargs
)
695 def BitmapFromBits(*args
, **kwargs
):
697 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
699 Creates a bitmap from an array of bits. You should only use this
700 function for monochrome bitmaps (depth 1) in portable programs: in
701 this case the bits parameter should contain an XBM image. For other
702 bit depths, the behaviour is platform dependent.
704 val
= _gdi_
.new_BitmapFromBits(*args
, **kwargs
)
707 class Mask(_core
.Object
):
709 This class encapsulates a monochrome mask bitmap, where the masked
710 area is black and the unmasked area is white. When associated with a
711 bitmap and drawn in a device context, the unmasked area of the bitmap
712 will be drawn, and the masked area will not be drawn.
714 A mask may be associated with a `wx.Bitmap`. It is used in
715 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
716 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
719 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
720 __repr__
= _swig_repr
721 def __init__(self
, *args
, **kwargs
):
723 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
725 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
726 that indicates the transparent portions of the mask. In other words,
727 the pixels in ``bitmap`` that match ``colour`` will be the transparent
728 portions of the mask. If no ``colour`` or an invalid ``colour`` is
729 passed then BLACK is used.
731 :see: `wx.Bitmap`, `wx.Colour`
733 _gdi_
.Mask_swiginit(self
,_gdi_
.new_Mask(*args
, **kwargs
))
734 __swig_destroy__
= _gdi_
.delete_Mask
735 __del__
= lambda self
: None;
736 Mask_swigregister
= _gdi_
.Mask_swigregister
737 Mask_swigregister(Mask
)
739 MaskColour
= wx
._deprecated
(Mask
, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
740 class Icon(GDIObject
):
741 """Proxy of C++ Icon class"""
742 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
743 __repr__
= _swig_repr
744 def __init__(self
, *args
, **kwargs
):
745 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
746 _gdi_
.Icon_swiginit(self
,_gdi_
.new_Icon(*args
, **kwargs
))
747 __swig_destroy__
= _gdi_
.delete_Icon
748 __del__
= lambda self
: None;
749 def Ok(*args
, **kwargs
):
750 """Ok(self) -> bool"""
751 return _gdi_
.Icon_Ok(*args
, **kwargs
)
753 def GetWidth(*args
, **kwargs
):
754 """GetWidth(self) -> int"""
755 return _gdi_
.Icon_GetWidth(*args
, **kwargs
)
757 def GetHeight(*args
, **kwargs
):
758 """GetHeight(self) -> int"""
759 return _gdi_
.Icon_GetHeight(*args
, **kwargs
)
761 def GetDepth(*args
, **kwargs
):
762 """GetDepth(self) -> int"""
763 return _gdi_
.Icon_GetDepth(*args
, **kwargs
)
765 def SetWidth(*args
, **kwargs
):
766 """SetWidth(self, int w)"""
767 return _gdi_
.Icon_SetWidth(*args
, **kwargs
)
769 def SetHeight(*args
, **kwargs
):
770 """SetHeight(self, int h)"""
771 return _gdi_
.Icon_SetHeight(*args
, **kwargs
)
773 def SetDepth(*args
, **kwargs
):
774 """SetDepth(self, int d)"""
775 return _gdi_
.Icon_SetDepth(*args
, **kwargs
)
777 def CopyFromBitmap(*args
, **kwargs
):
778 """CopyFromBitmap(self, Bitmap bmp)"""
779 return _gdi_
.Icon_CopyFromBitmap(*args
, **kwargs
)
781 def __nonzero__(self
): return self
.Ok()
782 Icon_swigregister
= _gdi_
.Icon_swigregister
783 Icon_swigregister(Icon
)
785 def EmptyIcon(*args
, **kwargs
):
786 """EmptyIcon() -> Icon"""
787 val
= _gdi_
.new_EmptyIcon(*args
, **kwargs
)
790 def IconFromLocation(*args
, **kwargs
):
791 """IconFromLocation(IconLocation loc) -> Icon"""
792 val
= _gdi_
.new_IconFromLocation(*args
, **kwargs
)
795 def IconFromBitmap(*args
, **kwargs
):
796 """IconFromBitmap(Bitmap bmp) -> Icon"""
797 val
= _gdi_
.new_IconFromBitmap(*args
, **kwargs
)
800 def IconFromXPMData(*args
, **kwargs
):
801 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
802 val
= _gdi_
.new_IconFromXPMData(*args
, **kwargs
)
805 class IconLocation(object):
806 """Proxy of C++ IconLocation class"""
807 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
808 __repr__
= _swig_repr
809 def __init__(self
, *args
, **kwargs
):
810 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
811 _gdi_
.IconLocation_swiginit(self
,_gdi_
.new_IconLocation(*args
, **kwargs
))
812 __swig_destroy__
= _gdi_
.delete_IconLocation
813 __del__
= lambda self
: None;
814 def IsOk(*args
, **kwargs
):
815 """IsOk(self) -> bool"""
816 return _gdi_
.IconLocation_IsOk(*args
, **kwargs
)
818 def __nonzero__(self
): return self
.Ok()
819 def SetFileName(*args
, **kwargs
):
820 """SetFileName(self, String filename)"""
821 return _gdi_
.IconLocation_SetFileName(*args
, **kwargs
)
823 def GetFileName(*args
, **kwargs
):
824 """GetFileName(self) -> String"""
825 return _gdi_
.IconLocation_GetFileName(*args
, **kwargs
)
827 def SetIndex(*args
, **kwargs
):
828 """SetIndex(self, int num)"""
829 return _gdi_
.IconLocation_SetIndex(*args
, **kwargs
)
831 def GetIndex(*args
, **kwargs
):
832 """GetIndex(self) -> int"""
833 return _gdi_
.IconLocation_GetIndex(*args
, **kwargs
)
835 IconLocation_swigregister
= _gdi_
.IconLocation_swigregister
836 IconLocation_swigregister(IconLocation
)
838 class IconBundle(object):
839 """Proxy of C++ IconBundle class"""
840 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
841 __repr__
= _swig_repr
842 def __init__(self
, *args
, **kwargs
):
843 """__init__(self) -> IconBundle"""
844 _gdi_
.IconBundle_swiginit(self
,_gdi_
.new_IconBundle(*args
, **kwargs
))
845 __swig_destroy__
= _gdi_
.delete_IconBundle
846 __del__
= lambda self
: None;
847 def AddIcon(*args
, **kwargs
):
848 """AddIcon(self, Icon icon)"""
849 return _gdi_
.IconBundle_AddIcon(*args
, **kwargs
)
851 def AddIconFromFile(*args
, **kwargs
):
852 """AddIconFromFile(self, String file, long type)"""
853 return _gdi_
.IconBundle_AddIconFromFile(*args
, **kwargs
)
855 def GetIcon(*args
, **kwargs
):
856 """GetIcon(self, Size size) -> Icon"""
857 return _gdi_
.IconBundle_GetIcon(*args
, **kwargs
)
859 IconBundle_swigregister
= _gdi_
.IconBundle_swigregister
860 IconBundle_swigregister(IconBundle
)
862 def IconBundleFromFile(*args
, **kwargs
):
863 """IconBundleFromFile(String file, long type) -> IconBundle"""
864 val
= _gdi_
.new_IconBundleFromFile(*args
, **kwargs
)
867 def IconBundleFromIcon(*args
, **kwargs
):
868 """IconBundleFromIcon(Icon icon) -> IconBundle"""
869 val
= _gdi_
.new_IconBundleFromIcon(*args
, **kwargs
)
872 class Cursor(GDIObject
):
874 A cursor is a small bitmap usually used for denoting where the mouse
875 pointer is, with a picture that might indicate the interpretation of a
878 A single cursor object may be used in many windows (any subwindow
879 type). The wxWindows convention is to set the cursor for a window, as
880 in X, rather than to set it globally as in MS Windows, although a
881 global `wx.SetCursor` function is also available for use on MS Windows.
884 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
885 __repr__
= _swig_repr
886 def __init__(self
, *args
, **kwargs
):
888 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
890 Construct a Cursor from a file. Specify the type of file using
891 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
894 _gdi_
.Cursor_swiginit(self
,_gdi_
.new_Cursor(*args
, **kwargs
))
895 __swig_destroy__
= _gdi_
.delete_Cursor
896 __del__
= lambda self
: None;
897 def Ok(*args
, **kwargs
):
898 """Ok(self) -> bool"""
899 return _gdi_
.Cursor_Ok(*args
, **kwargs
)
901 def __nonzero__(self
): return self
.Ok()
902 Cursor_swigregister
= _gdi_
.Cursor_swigregister
903 Cursor_swigregister(Cursor
)
905 def StockCursor(*args
, **kwargs
):
907 StockCursor(int id) -> Cursor
909 Create a cursor using one of the stock cursors. Note that not all
910 stock cursors are available on all platforms.
912 val
= _gdi_
.new_StockCursor(*args
, **kwargs
)
915 def CursorFromImage(*args
, **kwargs
):
917 CursorFromImage(Image image) -> Cursor
919 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
920 for setting the transparent portions of the cursor.
922 val
= _gdi_
.new_CursorFromImage(*args
, **kwargs
)
925 #---------------------------------------------------------------------------
927 OutRegion
= _gdi_
.OutRegion
928 PartRegion
= _gdi_
.PartRegion
929 InRegion
= _gdi_
.InRegion
930 class Region(GDIObject
):
931 """Proxy of C++ Region class"""
932 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
933 __repr__
= _swig_repr
934 def __init__(self
, *args
, **kwargs
):
935 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
936 _gdi_
.Region_swiginit(self
,_gdi_
.new_Region(*args
, **kwargs
))
937 __swig_destroy__
= _gdi_
.delete_Region
938 __del__
= lambda self
: None;
939 def Clear(*args
, **kwargs
):
941 return _gdi_
.Region_Clear(*args
, **kwargs
)
943 def Offset(*args
, **kwargs
):
944 """Offset(self, int x, int y) -> bool"""
945 return _gdi_
.Region_Offset(*args
, **kwargs
)
947 def Contains(*args
, **kwargs
):
948 """Contains(self, int x, int y) -> int"""
949 return _gdi_
.Region_Contains(*args
, **kwargs
)
951 def ContainsPoint(*args
, **kwargs
):
952 """ContainsPoint(self, Point pt) -> int"""
953 return _gdi_
.Region_ContainsPoint(*args
, **kwargs
)
955 def ContainsRect(*args
, **kwargs
):
956 """ContainsRect(self, Rect rect) -> int"""
957 return _gdi_
.Region_ContainsRect(*args
, **kwargs
)
959 def ContainsRectDim(*args
, **kwargs
):
960 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
961 return _gdi_
.Region_ContainsRectDim(*args
, **kwargs
)
963 def GetBox(*args
, **kwargs
):
964 """GetBox(self) -> Rect"""
965 return _gdi_
.Region_GetBox(*args
, **kwargs
)
967 def Intersect(*args
, **kwargs
):
968 """Intersect(self, int x, int y, int width, int height) -> bool"""
969 return _gdi_
.Region_Intersect(*args
, **kwargs
)
971 def IntersectRect(*args
, **kwargs
):
972 """IntersectRect(self, Rect rect) -> bool"""
973 return _gdi_
.Region_IntersectRect(*args
, **kwargs
)
975 def IntersectRegion(*args
, **kwargs
):
976 """IntersectRegion(self, Region region) -> bool"""
977 return _gdi_
.Region_IntersectRegion(*args
, **kwargs
)
979 def IsEmpty(*args
, **kwargs
):
980 """IsEmpty(self) -> bool"""
981 return _gdi_
.Region_IsEmpty(*args
, **kwargs
)
983 def Union(*args
, **kwargs
):
984 """Union(self, int x, int y, int width, int height) -> bool"""
985 return _gdi_
.Region_Union(*args
, **kwargs
)
987 def UnionRect(*args
, **kwargs
):
988 """UnionRect(self, Rect rect) -> bool"""
989 return _gdi_
.Region_UnionRect(*args
, **kwargs
)
991 def UnionRegion(*args
, **kwargs
):
992 """UnionRegion(self, Region region) -> bool"""
993 return _gdi_
.Region_UnionRegion(*args
, **kwargs
)
995 def Subtract(*args
, **kwargs
):
996 """Subtract(self, int x, int y, int width, int height) -> bool"""
997 return _gdi_
.Region_Subtract(*args
, **kwargs
)
999 def SubtractRect(*args
, **kwargs
):
1000 """SubtractRect(self, Rect rect) -> bool"""
1001 return _gdi_
.Region_SubtractRect(*args
, **kwargs
)
1003 def SubtractRegion(*args
, **kwargs
):
1004 """SubtractRegion(self, Region region) -> bool"""
1005 return _gdi_
.Region_SubtractRegion(*args
, **kwargs
)
1007 def Xor(*args
, **kwargs
):
1008 """Xor(self, int x, int y, int width, int height) -> bool"""
1009 return _gdi_
.Region_Xor(*args
, **kwargs
)
1011 def XorRect(*args
, **kwargs
):
1012 """XorRect(self, Rect rect) -> bool"""
1013 return _gdi_
.Region_XorRect(*args
, **kwargs
)
1015 def XorRegion(*args
, **kwargs
):
1016 """XorRegion(self, Region region) -> bool"""
1017 return _gdi_
.Region_XorRegion(*args
, **kwargs
)
1019 def ConvertToBitmap(*args
, **kwargs
):
1020 """ConvertToBitmap(self) -> Bitmap"""
1021 return _gdi_
.Region_ConvertToBitmap(*args
, **kwargs
)
1023 def UnionBitmap(*args
, **kwargs
):
1024 """UnionBitmap(self, Bitmap bmp) -> bool"""
1025 return _gdi_
.Region_UnionBitmap(*args
, **kwargs
)
1027 def UnionBitmapColour(*args
, **kwargs
):
1028 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1029 return _gdi_
.Region_UnionBitmapColour(*args
, **kwargs
)
1031 Region_swigregister
= _gdi_
.Region_swigregister
1032 Region_swigregister(Region
)
1034 def RegionFromBitmap(*args
, **kwargs
):
1035 """RegionFromBitmap(Bitmap bmp) -> Region"""
1036 val
= _gdi_
.new_RegionFromBitmap(*args
, **kwargs
)
1039 def RegionFromBitmapColour(*args
, **kwargs
):
1040 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1041 val
= _gdi_
.new_RegionFromBitmapColour(*args
, **kwargs
)
1044 def RegionFromPoints(*args
, **kwargs
):
1045 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
1046 val
= _gdi_
.new_RegionFromPoints(*args
, **kwargs
)
1049 class RegionIterator(_core
.Object
):
1050 """Proxy of C++ RegionIterator class"""
1051 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1052 __repr__
= _swig_repr
1053 def __init__(self
, *args
, **kwargs
):
1054 """__init__(self, Region region) -> RegionIterator"""
1055 _gdi_
.RegionIterator_swiginit(self
,_gdi_
.new_RegionIterator(*args
, **kwargs
))
1056 __swig_destroy__
= _gdi_
.delete_RegionIterator
1057 __del__
= lambda self
: None;
1058 def GetX(*args
, **kwargs
):
1059 """GetX(self) -> int"""
1060 return _gdi_
.RegionIterator_GetX(*args
, **kwargs
)
1062 def GetY(*args
, **kwargs
):
1063 """GetY(self) -> int"""
1064 return _gdi_
.RegionIterator_GetY(*args
, **kwargs
)
1066 def GetW(*args
, **kwargs
):
1067 """GetW(self) -> int"""
1068 return _gdi_
.RegionIterator_GetW(*args
, **kwargs
)
1070 def GetWidth(*args
, **kwargs
):
1071 """GetWidth(self) -> int"""
1072 return _gdi_
.RegionIterator_GetWidth(*args
, **kwargs
)
1074 def GetH(*args
, **kwargs
):
1075 """GetH(self) -> int"""
1076 return _gdi_
.RegionIterator_GetH(*args
, **kwargs
)
1078 def GetHeight(*args
, **kwargs
):
1079 """GetHeight(self) -> int"""
1080 return _gdi_
.RegionIterator_GetHeight(*args
, **kwargs
)
1082 def GetRect(*args
, **kwargs
):
1083 """GetRect(self) -> Rect"""
1084 return _gdi_
.RegionIterator_GetRect(*args
, **kwargs
)
1086 def HaveRects(*args
, **kwargs
):
1087 """HaveRects(self) -> bool"""
1088 return _gdi_
.RegionIterator_HaveRects(*args
, **kwargs
)
1090 def Reset(*args
, **kwargs
):
1092 return _gdi_
.RegionIterator_Reset(*args
, **kwargs
)
1094 def Next(*args
, **kwargs
):
1096 return _gdi_
.RegionIterator_Next(*args
, **kwargs
)
1098 def __nonzero__(*args
, **kwargs
):
1099 """__nonzero__(self) -> bool"""
1100 return _gdi_
.RegionIterator___nonzero__(*args
, **kwargs
)
1102 RegionIterator_swigregister
= _gdi_
.RegionIterator_swigregister
1103 RegionIterator_swigregister(RegionIterator
)
1105 #---------------------------------------------------------------------------
1107 FONTFAMILY_DEFAULT
= _gdi_
.FONTFAMILY_DEFAULT
1108 FONTFAMILY_DECORATIVE
= _gdi_
.FONTFAMILY_DECORATIVE
1109 FONTFAMILY_ROMAN
= _gdi_
.FONTFAMILY_ROMAN
1110 FONTFAMILY_SCRIPT
= _gdi_
.FONTFAMILY_SCRIPT
1111 FONTFAMILY_SWISS
= _gdi_
.FONTFAMILY_SWISS
1112 FONTFAMILY_MODERN
= _gdi_
.FONTFAMILY_MODERN
1113 FONTFAMILY_TELETYPE
= _gdi_
.FONTFAMILY_TELETYPE
1114 FONTFAMILY_MAX
= _gdi_
.FONTFAMILY_MAX
1115 FONTFAMILY_UNKNOWN
= _gdi_
.FONTFAMILY_UNKNOWN
1116 FONTSTYLE_NORMAL
= _gdi_
.FONTSTYLE_NORMAL
1117 FONTSTYLE_ITALIC
= _gdi_
.FONTSTYLE_ITALIC
1118 FONTSTYLE_SLANT
= _gdi_
.FONTSTYLE_SLANT
1119 FONTSTYLE_MAX
= _gdi_
.FONTSTYLE_MAX
1120 FONTWEIGHT_NORMAL
= _gdi_
.FONTWEIGHT_NORMAL
1121 FONTWEIGHT_LIGHT
= _gdi_
.FONTWEIGHT_LIGHT
1122 FONTWEIGHT_BOLD
= _gdi_
.FONTWEIGHT_BOLD
1123 FONTWEIGHT_MAX
= _gdi_
.FONTWEIGHT_MAX
1124 FONTFLAG_DEFAULT
= _gdi_
.FONTFLAG_DEFAULT
1125 FONTFLAG_ITALIC
= _gdi_
.FONTFLAG_ITALIC
1126 FONTFLAG_SLANT
= _gdi_
.FONTFLAG_SLANT
1127 FONTFLAG_LIGHT
= _gdi_
.FONTFLAG_LIGHT
1128 FONTFLAG_BOLD
= _gdi_
.FONTFLAG_BOLD
1129 FONTFLAG_ANTIALIASED
= _gdi_
.FONTFLAG_ANTIALIASED
1130 FONTFLAG_NOT_ANTIALIASED
= _gdi_
.FONTFLAG_NOT_ANTIALIASED
1131 FONTFLAG_UNDERLINED
= _gdi_
.FONTFLAG_UNDERLINED
1132 FONTFLAG_STRIKETHROUGH
= _gdi_
.FONTFLAG_STRIKETHROUGH
1133 FONTFLAG_MASK
= _gdi_
.FONTFLAG_MASK
1134 FONTENCODING_SYSTEM
= _gdi_
.FONTENCODING_SYSTEM
1135 FONTENCODING_DEFAULT
= _gdi_
.FONTENCODING_DEFAULT
1136 FONTENCODING_ISO8859_1
= _gdi_
.FONTENCODING_ISO8859_1
1137 FONTENCODING_ISO8859_2
= _gdi_
.FONTENCODING_ISO8859_2
1138 FONTENCODING_ISO8859_3
= _gdi_
.FONTENCODING_ISO8859_3
1139 FONTENCODING_ISO8859_4
= _gdi_
.FONTENCODING_ISO8859_4
1140 FONTENCODING_ISO8859_5
= _gdi_
.FONTENCODING_ISO8859_5
1141 FONTENCODING_ISO8859_6
= _gdi_
.FONTENCODING_ISO8859_6
1142 FONTENCODING_ISO8859_7
= _gdi_
.FONTENCODING_ISO8859_7
1143 FONTENCODING_ISO8859_8
= _gdi_
.FONTENCODING_ISO8859_8
1144 FONTENCODING_ISO8859_9
= _gdi_
.FONTENCODING_ISO8859_9
1145 FONTENCODING_ISO8859_10
= _gdi_
.FONTENCODING_ISO8859_10
1146 FONTENCODING_ISO8859_11
= _gdi_
.FONTENCODING_ISO8859_11
1147 FONTENCODING_ISO8859_12
= _gdi_
.FONTENCODING_ISO8859_12
1148 FONTENCODING_ISO8859_13
= _gdi_
.FONTENCODING_ISO8859_13
1149 FONTENCODING_ISO8859_14
= _gdi_
.FONTENCODING_ISO8859_14
1150 FONTENCODING_ISO8859_15
= _gdi_
.FONTENCODING_ISO8859_15
1151 FONTENCODING_ISO8859_MAX
= _gdi_
.FONTENCODING_ISO8859_MAX
1152 FONTENCODING_KOI8
= _gdi_
.FONTENCODING_KOI8
1153 FONTENCODING_KOI8_U
= _gdi_
.FONTENCODING_KOI8_U
1154 FONTENCODING_ALTERNATIVE
= _gdi_
.FONTENCODING_ALTERNATIVE
1155 FONTENCODING_BULGARIAN
= _gdi_
.FONTENCODING_BULGARIAN
1156 FONTENCODING_CP437
= _gdi_
.FONTENCODING_CP437
1157 FONTENCODING_CP850
= _gdi_
.FONTENCODING_CP850
1158 FONTENCODING_CP852
= _gdi_
.FONTENCODING_CP852
1159 FONTENCODING_CP855
= _gdi_
.FONTENCODING_CP855
1160 FONTENCODING_CP866
= _gdi_
.FONTENCODING_CP866
1161 FONTENCODING_CP874
= _gdi_
.FONTENCODING_CP874
1162 FONTENCODING_CP932
= _gdi_
.FONTENCODING_CP932
1163 FONTENCODING_CP936
= _gdi_
.FONTENCODING_CP936
1164 FONTENCODING_CP949
= _gdi_
.FONTENCODING_CP949
1165 FONTENCODING_CP950
= _gdi_
.FONTENCODING_CP950
1166 FONTENCODING_CP1250
= _gdi_
.FONTENCODING_CP1250
1167 FONTENCODING_CP1251
= _gdi_
.FONTENCODING_CP1251
1168 FONTENCODING_CP1252
= _gdi_
.FONTENCODING_CP1252
1169 FONTENCODING_CP1253
= _gdi_
.FONTENCODING_CP1253
1170 FONTENCODING_CP1254
= _gdi_
.FONTENCODING_CP1254
1171 FONTENCODING_CP1255
= _gdi_
.FONTENCODING_CP1255
1172 FONTENCODING_CP1256
= _gdi_
.FONTENCODING_CP1256
1173 FONTENCODING_CP1257
= _gdi_
.FONTENCODING_CP1257
1174 FONTENCODING_CP12_MAX
= _gdi_
.FONTENCODING_CP12_MAX
1175 FONTENCODING_UTF7
= _gdi_
.FONTENCODING_UTF7
1176 FONTENCODING_UTF8
= _gdi_
.FONTENCODING_UTF8
1177 FONTENCODING_EUC_JP
= _gdi_
.FONTENCODING_EUC_JP
1178 FONTENCODING_UTF16BE
= _gdi_
.FONTENCODING_UTF16BE
1179 FONTENCODING_UTF16LE
= _gdi_
.FONTENCODING_UTF16LE
1180 FONTENCODING_UTF32BE
= _gdi_
.FONTENCODING_UTF32BE
1181 FONTENCODING_UTF32LE
= _gdi_
.FONTENCODING_UTF32LE
1182 FONTENCODING_MACROMAN
= _gdi_
.FONTENCODING_MACROMAN
1183 FONTENCODING_MACJAPANESE
= _gdi_
.FONTENCODING_MACJAPANESE
1184 FONTENCODING_MACCHINESETRAD
= _gdi_
.FONTENCODING_MACCHINESETRAD
1185 FONTENCODING_MACKOREAN
= _gdi_
.FONTENCODING_MACKOREAN
1186 FONTENCODING_MACARABIC
= _gdi_
.FONTENCODING_MACARABIC
1187 FONTENCODING_MACHEBREW
= _gdi_
.FONTENCODING_MACHEBREW
1188 FONTENCODING_MACGREEK
= _gdi_
.FONTENCODING_MACGREEK
1189 FONTENCODING_MACCYRILLIC
= _gdi_
.FONTENCODING_MACCYRILLIC
1190 FONTENCODING_MACDEVANAGARI
= _gdi_
.FONTENCODING_MACDEVANAGARI
1191 FONTENCODING_MACGURMUKHI
= _gdi_
.FONTENCODING_MACGURMUKHI
1192 FONTENCODING_MACGUJARATI
= _gdi_
.FONTENCODING_MACGUJARATI
1193 FONTENCODING_MACORIYA
= _gdi_
.FONTENCODING_MACORIYA
1194 FONTENCODING_MACBENGALI
= _gdi_
.FONTENCODING_MACBENGALI
1195 FONTENCODING_MACTAMIL
= _gdi_
.FONTENCODING_MACTAMIL
1196 FONTENCODING_MACTELUGU
= _gdi_
.FONTENCODING_MACTELUGU
1197 FONTENCODING_MACKANNADA
= _gdi_
.FONTENCODING_MACKANNADA
1198 FONTENCODING_MACMALAJALAM
= _gdi_
.FONTENCODING_MACMALAJALAM
1199 FONTENCODING_MACSINHALESE
= _gdi_
.FONTENCODING_MACSINHALESE
1200 FONTENCODING_MACBURMESE
= _gdi_
.FONTENCODING_MACBURMESE
1201 FONTENCODING_MACKHMER
= _gdi_
.FONTENCODING_MACKHMER
1202 FONTENCODING_MACTHAI
= _gdi_
.FONTENCODING_MACTHAI
1203 FONTENCODING_MACLAOTIAN
= _gdi_
.FONTENCODING_MACLAOTIAN
1204 FONTENCODING_MACGEORGIAN
= _gdi_
.FONTENCODING_MACGEORGIAN
1205 FONTENCODING_MACARMENIAN
= _gdi_
.FONTENCODING_MACARMENIAN
1206 FONTENCODING_MACCHINESESIMP
= _gdi_
.FONTENCODING_MACCHINESESIMP
1207 FONTENCODING_MACTIBETAN
= _gdi_
.FONTENCODING_MACTIBETAN
1208 FONTENCODING_MACMONGOLIAN
= _gdi_
.FONTENCODING_MACMONGOLIAN
1209 FONTENCODING_MACETHIOPIC
= _gdi_
.FONTENCODING_MACETHIOPIC
1210 FONTENCODING_MACCENTRALEUR
= _gdi_
.FONTENCODING_MACCENTRALEUR
1211 FONTENCODING_MACVIATNAMESE
= _gdi_
.FONTENCODING_MACVIATNAMESE
1212 FONTENCODING_MACARABICEXT
= _gdi_
.FONTENCODING_MACARABICEXT
1213 FONTENCODING_MACSYMBOL
= _gdi_
.FONTENCODING_MACSYMBOL
1214 FONTENCODING_MACDINGBATS
= _gdi_
.FONTENCODING_MACDINGBATS
1215 FONTENCODING_MACTURKISH
= _gdi_
.FONTENCODING_MACTURKISH
1216 FONTENCODING_MACCROATIAN
= _gdi_
.FONTENCODING_MACCROATIAN
1217 FONTENCODING_MACICELANDIC
= _gdi_
.FONTENCODING_MACICELANDIC
1218 FONTENCODING_MACROMANIAN
= _gdi_
.FONTENCODING_MACROMANIAN
1219 FONTENCODING_MACCELTIC
= _gdi_
.FONTENCODING_MACCELTIC
1220 FONTENCODING_MACGAELIC
= _gdi_
.FONTENCODING_MACGAELIC
1221 FONTENCODING_MACKEYBOARD
= _gdi_
.FONTENCODING_MACKEYBOARD
1222 FONTENCODING_MACMIN
= _gdi_
.FONTENCODING_MACMIN
1223 FONTENCODING_MACMAX
= _gdi_
.FONTENCODING_MACMAX
1224 FONTENCODING_MAX
= _gdi_
.FONTENCODING_MAX
1225 FONTENCODING_UTF16
= _gdi_
.FONTENCODING_UTF16
1226 FONTENCODING_UTF32
= _gdi_
.FONTENCODING_UTF32
1227 FONTENCODING_UNICODE
= _gdi_
.FONTENCODING_UNICODE
1228 FONTENCODING_GB2312
= _gdi_
.FONTENCODING_GB2312
1229 FONTENCODING_BIG5
= _gdi_
.FONTENCODING_BIG5
1230 FONTENCODING_SHIFT_JIS
= _gdi_
.FONTENCODING_SHIFT_JIS
1231 #---------------------------------------------------------------------------
1233 class NativeFontInfo(object):
1234 """Proxy of C++ NativeFontInfo class"""
1235 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1236 __repr__
= _swig_repr
1237 def __init__(self
, *args
, **kwargs
):
1238 """__init__(self) -> NativeFontInfo"""
1239 _gdi_
.NativeFontInfo_swiginit(self
,_gdi_
.new_NativeFontInfo(*args
, **kwargs
))
1240 __swig_destroy__
= _gdi_
.delete_NativeFontInfo
1241 __del__
= lambda self
: None;
1242 def Init(*args
, **kwargs
):
1244 return _gdi_
.NativeFontInfo_Init(*args
, **kwargs
)
1246 def InitFromFont(*args
, **kwargs
):
1247 """InitFromFont(self, Font font)"""
1248 return _gdi_
.NativeFontInfo_InitFromFont(*args
, **kwargs
)
1250 def GetPointSize(*args
, **kwargs
):
1251 """GetPointSize(self) -> int"""
1252 return _gdi_
.NativeFontInfo_GetPointSize(*args
, **kwargs
)
1254 def GetStyle(*args
, **kwargs
):
1255 """GetStyle(self) -> int"""
1256 return _gdi_
.NativeFontInfo_GetStyle(*args
, **kwargs
)
1258 def GetWeight(*args
, **kwargs
):
1259 """GetWeight(self) -> int"""
1260 return _gdi_
.NativeFontInfo_GetWeight(*args
, **kwargs
)
1262 def GetUnderlined(*args
, **kwargs
):
1263 """GetUnderlined(self) -> bool"""
1264 return _gdi_
.NativeFontInfo_GetUnderlined(*args
, **kwargs
)
1266 def GetFaceName(*args
, **kwargs
):
1267 """GetFaceName(self) -> String"""
1268 return _gdi_
.NativeFontInfo_GetFaceName(*args
, **kwargs
)
1270 def GetFamily(*args
, **kwargs
):
1271 """GetFamily(self) -> int"""
1272 return _gdi_
.NativeFontInfo_GetFamily(*args
, **kwargs
)
1274 def GetEncoding(*args
, **kwargs
):
1275 """GetEncoding(self) -> int"""
1276 return _gdi_
.NativeFontInfo_GetEncoding(*args
, **kwargs
)
1278 def SetPointSize(*args
, **kwargs
):
1279 """SetPointSize(self, int pointsize)"""
1280 return _gdi_
.NativeFontInfo_SetPointSize(*args
, **kwargs
)
1282 def SetStyle(*args
, **kwargs
):
1283 """SetStyle(self, int style)"""
1284 return _gdi_
.NativeFontInfo_SetStyle(*args
, **kwargs
)
1286 def SetWeight(*args
, **kwargs
):
1287 """SetWeight(self, int weight)"""
1288 return _gdi_
.NativeFontInfo_SetWeight(*args
, **kwargs
)
1290 def SetUnderlined(*args
, **kwargs
):
1291 """SetUnderlined(self, bool underlined)"""
1292 return _gdi_
.NativeFontInfo_SetUnderlined(*args
, **kwargs
)
1294 def SetFaceName(*args
, **kwargs
):
1295 """SetFaceName(self, String facename)"""
1296 return _gdi_
.NativeFontInfo_SetFaceName(*args
, **kwargs
)
1298 def SetFamily(*args
, **kwargs
):
1299 """SetFamily(self, int family)"""
1300 return _gdi_
.NativeFontInfo_SetFamily(*args
, **kwargs
)
1302 def SetEncoding(*args
, **kwargs
):
1303 """SetEncoding(self, int encoding)"""
1304 return _gdi_
.NativeFontInfo_SetEncoding(*args
, **kwargs
)
1306 def FromString(*args
, **kwargs
):
1307 """FromString(self, String s) -> bool"""
1308 return _gdi_
.NativeFontInfo_FromString(*args
, **kwargs
)
1310 def ToString(*args
, **kwargs
):
1311 """ToString(self) -> String"""
1312 return _gdi_
.NativeFontInfo_ToString(*args
, **kwargs
)
1314 def __str__(*args
, **kwargs
):
1315 """__str__(self) -> String"""
1316 return _gdi_
.NativeFontInfo___str__(*args
, **kwargs
)
1318 def FromUserString(*args
, **kwargs
):
1319 """FromUserString(self, String s) -> bool"""
1320 return _gdi_
.NativeFontInfo_FromUserString(*args
, **kwargs
)
1322 def ToUserString(*args
, **kwargs
):
1323 """ToUserString(self) -> String"""
1324 return _gdi_
.NativeFontInfo_ToUserString(*args
, **kwargs
)
1326 NativeFontInfo_swigregister
= _gdi_
.NativeFontInfo_swigregister
1327 NativeFontInfo_swigregister(NativeFontInfo
)
1329 class NativeEncodingInfo(object):
1330 """Proxy of C++ NativeEncodingInfo class"""
1331 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1332 __repr__
= _swig_repr
1333 facename
= property(_gdi_
.NativeEncodingInfo_facename_get
, _gdi_
.NativeEncodingInfo_facename_set
)
1334 encoding
= property(_gdi_
.NativeEncodingInfo_encoding_get
, _gdi_
.NativeEncodingInfo_encoding_set
)
1335 def __init__(self
, *args
, **kwargs
):
1336 """__init__(self) -> NativeEncodingInfo"""
1337 _gdi_
.NativeEncodingInfo_swiginit(self
,_gdi_
.new_NativeEncodingInfo(*args
, **kwargs
))
1338 __swig_destroy__
= _gdi_
.delete_NativeEncodingInfo
1339 __del__
= lambda self
: None;
1340 def FromString(*args
, **kwargs
):
1341 """FromString(self, String s) -> bool"""
1342 return _gdi_
.NativeEncodingInfo_FromString(*args
, **kwargs
)
1344 def ToString(*args
, **kwargs
):
1345 """ToString(self) -> String"""
1346 return _gdi_
.NativeEncodingInfo_ToString(*args
, **kwargs
)
1348 NativeEncodingInfo_swigregister
= _gdi_
.NativeEncodingInfo_swigregister
1349 NativeEncodingInfo_swigregister(NativeEncodingInfo
)
1352 def GetNativeFontEncoding(*args
, **kwargs
):
1353 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
1354 return _gdi_
.GetNativeFontEncoding(*args
, **kwargs
)
1356 def TestFontEncoding(*args
, **kwargs
):
1357 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
1358 return _gdi_
.TestFontEncoding(*args
, **kwargs
)
1359 #---------------------------------------------------------------------------
1361 class FontMapper(object):
1362 """Proxy of C++ FontMapper class"""
1363 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1364 __repr__
= _swig_repr
1365 def __init__(self
, *args
, **kwargs
):
1366 """__init__(self) -> FontMapper"""
1367 _gdi_
.FontMapper_swiginit(self
,_gdi_
.new_FontMapper(*args
, **kwargs
))
1368 __swig_destroy__
= _gdi_
.delete_FontMapper
1369 __del__
= lambda self
: None;
1370 def Get(*args
, **kwargs
):
1371 """Get() -> FontMapper"""
1372 return _gdi_
.FontMapper_Get(*args
, **kwargs
)
1374 Get
= staticmethod(Get
)
1375 def Set(*args
, **kwargs
):
1376 """Set(FontMapper mapper) -> FontMapper"""
1377 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1379 Set
= staticmethod(Set
)
1380 def CharsetToEncoding(*args
, **kwargs
):
1381 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
1382 return _gdi_
.FontMapper_CharsetToEncoding(*args
, **kwargs
)
1384 def GetSupportedEncodingsCount(*args
, **kwargs
):
1385 """GetSupportedEncodingsCount() -> size_t"""
1386 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
, **kwargs
)
1388 GetSupportedEncodingsCount
= staticmethod(GetSupportedEncodingsCount
)
1389 def GetEncoding(*args
, **kwargs
):
1390 """GetEncoding(size_t n) -> int"""
1391 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1393 GetEncoding
= staticmethod(GetEncoding
)
1394 def GetEncodingName(*args
, **kwargs
):
1395 """GetEncodingName(int encoding) -> String"""
1396 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1398 GetEncodingName
= staticmethod(GetEncodingName
)
1399 def GetEncodingDescription(*args
, **kwargs
):
1400 """GetEncodingDescription(int encoding) -> String"""
1401 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1403 GetEncodingDescription
= staticmethod(GetEncodingDescription
)
1404 def GetEncodingFromName(*args
, **kwargs
):
1405 """GetEncodingFromName(String name) -> int"""
1406 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1408 GetEncodingFromName
= staticmethod(GetEncodingFromName
)
1409 def SetConfigPath(*args
, **kwargs
):
1410 """SetConfigPath(self, String prefix)"""
1411 return _gdi_
.FontMapper_SetConfigPath(*args
, **kwargs
)
1413 def GetDefaultConfigPath(*args
, **kwargs
):
1414 """GetDefaultConfigPath() -> String"""
1415 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
, **kwargs
)
1417 GetDefaultConfigPath
= staticmethod(GetDefaultConfigPath
)
1418 def GetAltForEncoding(*args
, **kwargs
):
1419 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
1420 return _gdi_
.FontMapper_GetAltForEncoding(*args
, **kwargs
)
1422 def IsEncodingAvailable(*args
, **kwargs
):
1423 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
1424 return _gdi_
.FontMapper_IsEncodingAvailable(*args
, **kwargs
)
1426 def SetDialogParent(*args
, **kwargs
):
1427 """SetDialogParent(self, Window parent)"""
1428 return _gdi_
.FontMapper_SetDialogParent(*args
, **kwargs
)
1430 def SetDialogTitle(*args
, **kwargs
):
1431 """SetDialogTitle(self, String title)"""
1432 return _gdi_
.FontMapper_SetDialogTitle(*args
, **kwargs
)
1434 FontMapper_swigregister
= _gdi_
.FontMapper_swigregister
1435 FontMapper_swigregister(FontMapper
)
1437 def FontMapper_Get(*args
):
1438 """FontMapper_Get() -> FontMapper"""
1439 return _gdi_
.FontMapper_Get(*args
)
1441 def FontMapper_Set(*args
, **kwargs
):
1442 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
1443 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1445 def FontMapper_GetSupportedEncodingsCount(*args
):
1446 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
1447 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
)
1449 def FontMapper_GetEncoding(*args
, **kwargs
):
1450 """FontMapper_GetEncoding(size_t n) -> int"""
1451 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1453 def FontMapper_GetEncodingName(*args
, **kwargs
):
1454 """FontMapper_GetEncodingName(int encoding) -> String"""
1455 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1457 def FontMapper_GetEncodingDescription(*args
, **kwargs
):
1458 """FontMapper_GetEncodingDescription(int encoding) -> String"""
1459 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1461 def FontMapper_GetEncodingFromName(*args
, **kwargs
):
1462 """FontMapper_GetEncodingFromName(String name) -> int"""
1463 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1465 def FontMapper_GetDefaultConfigPath(*args
):
1466 """FontMapper_GetDefaultConfigPath() -> String"""
1467 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
)
1469 #---------------------------------------------------------------------------
1471 class Font(GDIObject
):
1473 A font is an object which determines the appearance of text. Fonts are
1474 used for drawing text to a device context, and setting the appearance
1477 You can retrieve the current system font settings with `wx.SystemSettings`.
1479 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1480 __repr__
= _swig_repr
1481 def __init__(self
, *args
, **kwargs
):
1483 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
1484 String face=EmptyString,
1485 int encoding=FONTENCODING_DEFAULT) -> Font
1487 Creates a font object with the specified attributes.
1489 :param pointSize: The size of the font in points.
1491 :param family: Font family. A generic way of referring to fonts
1492 without specifying actual facename. It can be One of
1493 the ``wx.FONTFAMILY_xxx`` constants.
1495 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1497 :param weight: Font weight, sometimes also referred to as font
1498 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1500 :param underline: The value can be ``True`` or ``False`` and
1501 indicates whether the font will include an underline. This
1502 may not be supported on all platforms.
1504 :param face: An optional string specifying the actual typeface to
1505 be used. If it is an empty string, a default typeface will be
1506 chosen based on the family.
1508 :param encoding: An encoding which may be one of the
1509 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1510 available, no font is created.
1512 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1513 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1516 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1517 _gdi_
.Font_swiginit(self
,_gdi_
.new_Font(*args
, **kwargs
))
1518 __swig_destroy__
= _gdi_
.delete_Font
1519 __del__
= lambda self
: None;
1520 def Ok(*args
, **kwargs
):
1524 Returns ``True`` if this font was successfully created.
1526 return _gdi_
.Font_Ok(*args
, **kwargs
)
1528 def __nonzero__(self
): return self
.Ok()
1529 def __eq__(*args
, **kwargs
):
1530 """__eq__(self, Font other) -> bool"""
1531 return _gdi_
.Font___eq__(*args
, **kwargs
)
1533 def __ne__(*args
, **kwargs
):
1534 """__ne__(self, Font other) -> bool"""
1535 return _gdi_
.Font___ne__(*args
, **kwargs
)
1537 def GetPointSize(*args
, **kwargs
):
1539 GetPointSize(self) -> int
1541 Gets the point size.
1543 return _gdi_
.Font_GetPointSize(*args
, **kwargs
)
1545 def GetPixelSize(*args
, **kwargs
):
1547 GetPixelSize(self) -> Size
1549 Returns the size in pixels if the font was constructed with a pixel
1552 return _gdi_
.Font_GetPixelSize(*args
, **kwargs
)
1554 def IsUsingSizeInPixels(*args
, **kwargs
):
1556 IsUsingSizeInPixels(self) -> bool
1558 Returns ``True`` if the font is using a pixelSize.
1560 return _gdi_
.Font_IsUsingSizeInPixels(*args
, **kwargs
)
1562 def GetFamily(*args
, **kwargs
):
1564 GetFamily(self) -> int
1566 Gets the font family.
1568 return _gdi_
.Font_GetFamily(*args
, **kwargs
)
1570 def GetStyle(*args
, **kwargs
):
1572 GetStyle(self) -> int
1574 Gets the font style.
1576 return _gdi_
.Font_GetStyle(*args
, **kwargs
)
1578 def GetWeight(*args
, **kwargs
):
1580 GetWeight(self) -> int
1582 Gets the font weight.
1584 return _gdi_
.Font_GetWeight(*args
, **kwargs
)
1586 def GetUnderlined(*args
, **kwargs
):
1588 GetUnderlined(self) -> bool
1590 Returns ``True`` if the font is underlined, ``False`` otherwise.
1592 return _gdi_
.Font_GetUnderlined(*args
, **kwargs
)
1594 def GetFaceName(*args
, **kwargs
):
1596 GetFaceName(self) -> String
1598 Returns the typeface name associated with the font, or the empty
1599 string if there is no typeface information.
1601 return _gdi_
.Font_GetFaceName(*args
, **kwargs
)
1603 def GetEncoding(*args
, **kwargs
):
1605 GetEncoding(self) -> int
1607 Get the font's encoding.
1609 return _gdi_
.Font_GetEncoding(*args
, **kwargs
)
1611 def GetNativeFontInfo(*args
, **kwargs
):
1613 GetNativeFontInfo(self) -> NativeFontInfo
1615 Constructs a `wx.NativeFontInfo` object from this font.
1617 return _gdi_
.Font_GetNativeFontInfo(*args
, **kwargs
)
1619 def IsFixedWidth(*args
, **kwargs
):
1621 IsFixedWidth(self) -> bool
1623 Returns true if the font is a fixed width (or monospaced) font, false
1624 if it is a proportional one or font is invalid.
1626 return _gdi_
.Font_IsFixedWidth(*args
, **kwargs
)
1628 def GetNativeFontInfoDesc(*args
, **kwargs
):
1630 GetNativeFontInfoDesc(self) -> String
1632 Returns the platform-dependent string completely describing this font
1633 or an empty string if the font isn't valid.
1635 return _gdi_
.Font_GetNativeFontInfoDesc(*args
, **kwargs
)
1637 def GetNativeFontInfoUserDesc(*args
, **kwargs
):
1639 GetNativeFontInfoUserDesc(self) -> String
1641 Returns a human readable version of `GetNativeFontInfoDesc`.
1643 return _gdi_
.Font_GetNativeFontInfoUserDesc(*args
, **kwargs
)
1645 def SetPointSize(*args
, **kwargs
):
1647 SetPointSize(self, int pointSize)
1649 Sets the point size.
1651 return _gdi_
.Font_SetPointSize(*args
, **kwargs
)
1653 def SetPixelSize(*args
, **kwargs
):
1655 SetPixelSize(self, Size pixelSize)
1657 Sets the size in pixels rather than points. If there is platform API
1658 support for this then it is used, otherwise a font with the closest
1659 size is found using a binary search.
1661 return _gdi_
.Font_SetPixelSize(*args
, **kwargs
)
1663 def SetFamily(*args
, **kwargs
):
1665 SetFamily(self, int family)
1667 Sets the font family.
1669 return _gdi_
.Font_SetFamily(*args
, **kwargs
)
1671 def SetStyle(*args
, **kwargs
):
1673 SetStyle(self, int style)
1675 Sets the font style.
1677 return _gdi_
.Font_SetStyle(*args
, **kwargs
)
1679 def SetWeight(*args
, **kwargs
):
1681 SetWeight(self, int weight)
1683 Sets the font weight.
1685 return _gdi_
.Font_SetWeight(*args
, **kwargs
)
1687 def SetFaceName(*args
, **kwargs
):
1689 SetFaceName(self, String faceName)
1691 Sets the facename for the font. The facename, which should be a valid
1692 font installed on the end-user's system.
1694 To avoid portability problems, don't rely on a specific face, but
1695 specify the font family instead or as well. A suitable font will be
1696 found on the end-user's system. If both the family and the facename
1697 are specified, wxWidgets will first search for the specific face, and
1698 then for a font belonging to the same family.
1700 return _gdi_
.Font_SetFaceName(*args
, **kwargs
)
1702 def SetUnderlined(*args
, **kwargs
):
1704 SetUnderlined(self, bool underlined)
1708 return _gdi_
.Font_SetUnderlined(*args
, **kwargs
)
1710 def SetEncoding(*args
, **kwargs
):
1712 SetEncoding(self, int encoding)
1714 Set the font encoding.
1716 return _gdi_
.Font_SetEncoding(*args
, **kwargs
)
1718 def SetNativeFontInfo(*args
, **kwargs
):
1720 SetNativeFontInfo(self, NativeFontInfo info)
1722 Set the font's attributes from a `wx.NativeFontInfo` object.
1724 return _gdi_
.Font_SetNativeFontInfo(*args
, **kwargs
)
1726 def SetNativeFontInfoFromString(*args
, **kwargs
):
1728 SetNativeFontInfoFromString(self, String info)
1730 Set the font's attributes from string representation of a
1731 `wx.NativeFontInfo` object.
1733 return _gdi_
.Font_SetNativeFontInfoFromString(*args
, **kwargs
)
1735 def SetNativeFontInfoUserDesc(*args
, **kwargs
):
1737 SetNativeFontInfoUserDesc(self, String info)
1739 Set the font's attributes from a string formerly returned from
1740 `GetNativeFontInfoDesc`.
1742 return _gdi_
.Font_SetNativeFontInfoUserDesc(*args
, **kwargs
)
1744 def GetFamilyString(*args
, **kwargs
):
1746 GetFamilyString(self) -> String
1748 Returns a string representation of the font family.
1750 return _gdi_
.Font_GetFamilyString(*args
, **kwargs
)
1752 def GetStyleString(*args
, **kwargs
):
1754 GetStyleString(self) -> String
1756 Returns a string representation of the font style.
1758 return _gdi_
.Font_GetStyleString(*args
, **kwargs
)
1760 def GetWeightString(*args
, **kwargs
):
1762 GetWeightString(self) -> String
1764 Return a string representation of the font weight.
1766 return _gdi_
.Font_GetWeightString(*args
, **kwargs
)
1768 def SetNoAntiAliasing(*args
, **kwargs
):
1769 """SetNoAntiAliasing(self, bool no=True)"""
1770 return _gdi_
.Font_SetNoAntiAliasing(*args
, **kwargs
)
1772 def GetNoAntiAliasing(*args
, **kwargs
):
1773 """GetNoAntiAliasing(self) -> bool"""
1774 return _gdi_
.Font_GetNoAntiAliasing(*args
, **kwargs
)
1776 def GetDefaultEncoding(*args
, **kwargs
):
1778 GetDefaultEncoding() -> int
1780 Returns the encoding used for all fonts created with an encoding of
1781 ``wx.FONTENCODING_DEFAULT``.
1783 return _gdi_
.Font_GetDefaultEncoding(*args
, **kwargs
)
1785 GetDefaultEncoding
= staticmethod(GetDefaultEncoding
)
1786 def SetDefaultEncoding(*args
, **kwargs
):
1788 SetDefaultEncoding(int encoding)
1790 Sets the default font encoding.
1792 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
1794 SetDefaultEncoding
= staticmethod(SetDefaultEncoding
)
1795 Font_swigregister
= _gdi_
.Font_swigregister
1796 Font_swigregister(Font
)
1798 def FontFromNativeInfo(*args
, **kwargs
):
1800 FontFromNativeInfo(NativeFontInfo info) -> Font
1802 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
1804 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1805 val
= _gdi_
.new_FontFromNativeInfo(*args
, **kwargs
)
1808 def FontFromNativeInfoString(*args
, **kwargs
):
1810 FontFromNativeInfoString(String info) -> Font
1812 Construct a `wx.Font` from the string representation of a
1813 `wx.NativeFontInfo` object.
1815 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1816 val
= _gdi_
.new_FontFromNativeInfoString(*args
, **kwargs
)
1819 def FFont(*args
, **kwargs
):
1821 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
1822 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
1824 A bit of a simpler way to create a `wx.Font` using flags instead of
1825 individual attribute settings. The value of flags can be a
1826 combination of the following:
1828 ============================ ==
1834 wx.FONTFLAG_ANTIALIASED
1835 wx.FONTFLAG_NOT_ANTIALIASED
1836 wx.FONTFLAG_UNDERLINED
1837 wx.FONTFLAG_STRIKETHROUGH
1838 ============================ ==
1840 :see: `wx.Font.__init__`
1842 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1843 val
= _gdi_
.new_FFont(*args
, **kwargs
)
1846 def FontFromPixelSize(*args
, **kwargs
):
1848 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
1849 bool underlined=False, String face=wxEmptyString,
1850 int encoding=FONTENCODING_DEFAULT) -> Font
1852 Creates a font using a size in pixels rather than points. If there is
1853 platform API support for this then it is used, otherwise a font with
1854 the closest size is found using a binary search.
1856 :see: `wx.Font.__init__`
1858 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1859 val
= _gdi_
.new_FontFromPixelSize(*args
, **kwargs
)
1862 def FFontFromPixelSize(*args
, **kwargs
):
1864 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
1865 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
1867 Creates a font using a size in pixels rather than points. If there is
1868 platform API support for this then it is used, otherwise a font with
1869 the closest size is found using a binary search.
1871 :see: `wx.Font.__init__`, `wx.FFont`
1873 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1874 val
= _gdi_
.new_FFontFromPixelSize(*args
, **kwargs
)
1877 def Font_GetDefaultEncoding(*args
):
1879 Font_GetDefaultEncoding() -> int
1881 Returns the encoding used for all fonts created with an encoding of
1882 ``wx.FONTENCODING_DEFAULT``.
1884 return _gdi_
.Font_GetDefaultEncoding(*args
)
1886 def Font_SetDefaultEncoding(*args
, **kwargs
):
1888 Font_SetDefaultEncoding(int encoding)
1890 Sets the default font encoding.
1892 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
1894 Font2
= wx
._deprecated
(FFont
, "Use `wx.FFont` instead.")
1895 #---------------------------------------------------------------------------
1897 class FontEnumerator(object):
1898 """Proxy of C++ FontEnumerator class"""
1899 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1900 __repr__
= _swig_repr
1901 def __init__(self
, *args
, **kwargs
):
1902 """__init__(self) -> FontEnumerator"""
1903 _gdi_
.FontEnumerator_swiginit(self
,_gdi_
.new_FontEnumerator(*args
, **kwargs
))
1904 self
._setCallbackInfo
(self
, FontEnumerator
, 0)
1906 __swig_destroy__
= _gdi_
.delete_FontEnumerator
1907 __del__
= lambda self
: None;
1908 def _setCallbackInfo(*args
, **kwargs
):
1909 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
1910 return _gdi_
.FontEnumerator__setCallbackInfo(*args
, **kwargs
)
1912 def EnumerateFacenames(*args
, **kwargs
):
1913 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
1914 return _gdi_
.FontEnumerator_EnumerateFacenames(*args
, **kwargs
)
1916 def EnumerateEncodings(*args
, **kwargs
):
1917 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
1918 return _gdi_
.FontEnumerator_EnumerateEncodings(*args
, **kwargs
)
1920 def GetEncodings(*args
, **kwargs
):
1921 """GetEncodings(self) -> PyObject"""
1922 return _gdi_
.FontEnumerator_GetEncodings(*args
, **kwargs
)
1924 def GetFacenames(*args
, **kwargs
):
1925 """GetFacenames(self) -> PyObject"""
1926 return _gdi_
.FontEnumerator_GetFacenames(*args
, **kwargs
)
1928 FontEnumerator_swigregister
= _gdi_
.FontEnumerator_swigregister
1929 FontEnumerator_swigregister(FontEnumerator
)
1931 #---------------------------------------------------------------------------
1933 LANGUAGE_DEFAULT
= _gdi_
.LANGUAGE_DEFAULT
1934 LANGUAGE_UNKNOWN
= _gdi_
.LANGUAGE_UNKNOWN
1935 LANGUAGE_ABKHAZIAN
= _gdi_
.LANGUAGE_ABKHAZIAN
1936 LANGUAGE_AFAR
= _gdi_
.LANGUAGE_AFAR
1937 LANGUAGE_AFRIKAANS
= _gdi_
.LANGUAGE_AFRIKAANS
1938 LANGUAGE_ALBANIAN
= _gdi_
.LANGUAGE_ALBANIAN
1939 LANGUAGE_AMHARIC
= _gdi_
.LANGUAGE_AMHARIC
1940 LANGUAGE_ARABIC
= _gdi_
.LANGUAGE_ARABIC
1941 LANGUAGE_ARABIC_ALGERIA
= _gdi_
.LANGUAGE_ARABIC_ALGERIA
1942 LANGUAGE_ARABIC_BAHRAIN
= _gdi_
.LANGUAGE_ARABIC_BAHRAIN
1943 LANGUAGE_ARABIC_EGYPT
= _gdi_
.LANGUAGE_ARABIC_EGYPT
1944 LANGUAGE_ARABIC_IRAQ
= _gdi_
.LANGUAGE_ARABIC_IRAQ
1945 LANGUAGE_ARABIC_JORDAN
= _gdi_
.LANGUAGE_ARABIC_JORDAN
1946 LANGUAGE_ARABIC_KUWAIT
= _gdi_
.LANGUAGE_ARABIC_KUWAIT
1947 LANGUAGE_ARABIC_LEBANON
= _gdi_
.LANGUAGE_ARABIC_LEBANON
1948 LANGUAGE_ARABIC_LIBYA
= _gdi_
.LANGUAGE_ARABIC_LIBYA
1949 LANGUAGE_ARABIC_MOROCCO
= _gdi_
.LANGUAGE_ARABIC_MOROCCO
1950 LANGUAGE_ARABIC_OMAN
= _gdi_
.LANGUAGE_ARABIC_OMAN
1951 LANGUAGE_ARABIC_QATAR
= _gdi_
.LANGUAGE_ARABIC_QATAR
1952 LANGUAGE_ARABIC_SAUDI_ARABIA
= _gdi_
.LANGUAGE_ARABIC_SAUDI_ARABIA
1953 LANGUAGE_ARABIC_SUDAN
= _gdi_
.LANGUAGE_ARABIC_SUDAN
1954 LANGUAGE_ARABIC_SYRIA
= _gdi_
.LANGUAGE_ARABIC_SYRIA
1955 LANGUAGE_ARABIC_TUNISIA
= _gdi_
.LANGUAGE_ARABIC_TUNISIA
1956 LANGUAGE_ARABIC_UAE
= _gdi_
.LANGUAGE_ARABIC_UAE
1957 LANGUAGE_ARABIC_YEMEN
= _gdi_
.LANGUAGE_ARABIC_YEMEN
1958 LANGUAGE_ARMENIAN
= _gdi_
.LANGUAGE_ARMENIAN
1959 LANGUAGE_ASSAMESE
= _gdi_
.LANGUAGE_ASSAMESE
1960 LANGUAGE_AYMARA
= _gdi_
.LANGUAGE_AYMARA
1961 LANGUAGE_AZERI
= _gdi_
.LANGUAGE_AZERI
1962 LANGUAGE_AZERI_CYRILLIC
= _gdi_
.LANGUAGE_AZERI_CYRILLIC
1963 LANGUAGE_AZERI_LATIN
= _gdi_
.LANGUAGE_AZERI_LATIN
1964 LANGUAGE_BASHKIR
= _gdi_
.LANGUAGE_BASHKIR
1965 LANGUAGE_BASQUE
= _gdi_
.LANGUAGE_BASQUE
1966 LANGUAGE_BELARUSIAN
= _gdi_
.LANGUAGE_BELARUSIAN
1967 LANGUAGE_BENGALI
= _gdi_
.LANGUAGE_BENGALI
1968 LANGUAGE_BHUTANI
= _gdi_
.LANGUAGE_BHUTANI
1969 LANGUAGE_BIHARI
= _gdi_
.LANGUAGE_BIHARI
1970 LANGUAGE_BISLAMA
= _gdi_
.LANGUAGE_BISLAMA
1971 LANGUAGE_BRETON
= _gdi_
.LANGUAGE_BRETON
1972 LANGUAGE_BULGARIAN
= _gdi_
.LANGUAGE_BULGARIAN
1973 LANGUAGE_BURMESE
= _gdi_
.LANGUAGE_BURMESE
1974 LANGUAGE_CAMBODIAN
= _gdi_
.LANGUAGE_CAMBODIAN
1975 LANGUAGE_CATALAN
= _gdi_
.LANGUAGE_CATALAN
1976 LANGUAGE_CHINESE
= _gdi_
.LANGUAGE_CHINESE
1977 LANGUAGE_CHINESE_SIMPLIFIED
= _gdi_
.LANGUAGE_CHINESE_SIMPLIFIED
1978 LANGUAGE_CHINESE_TRADITIONAL
= _gdi_
.LANGUAGE_CHINESE_TRADITIONAL
1979 LANGUAGE_CHINESE_HONGKONG
= _gdi_
.LANGUAGE_CHINESE_HONGKONG
1980 LANGUAGE_CHINESE_MACAU
= _gdi_
.LANGUAGE_CHINESE_MACAU
1981 LANGUAGE_CHINESE_SINGAPORE
= _gdi_
.LANGUAGE_CHINESE_SINGAPORE
1982 LANGUAGE_CHINESE_TAIWAN
= _gdi_
.LANGUAGE_CHINESE_TAIWAN
1983 LANGUAGE_CORSICAN
= _gdi_
.LANGUAGE_CORSICAN
1984 LANGUAGE_CROATIAN
= _gdi_
.LANGUAGE_CROATIAN
1985 LANGUAGE_CZECH
= _gdi_
.LANGUAGE_CZECH
1986 LANGUAGE_DANISH
= _gdi_
.LANGUAGE_DANISH
1987 LANGUAGE_DUTCH
= _gdi_
.LANGUAGE_DUTCH
1988 LANGUAGE_DUTCH_BELGIAN
= _gdi_
.LANGUAGE_DUTCH_BELGIAN
1989 LANGUAGE_ENGLISH
= _gdi_
.LANGUAGE_ENGLISH
1990 LANGUAGE_ENGLISH_UK
= _gdi_
.LANGUAGE_ENGLISH_UK
1991 LANGUAGE_ENGLISH_US
= _gdi_
.LANGUAGE_ENGLISH_US
1992 LANGUAGE_ENGLISH_AUSTRALIA
= _gdi_
.LANGUAGE_ENGLISH_AUSTRALIA
1993 LANGUAGE_ENGLISH_BELIZE
= _gdi_
.LANGUAGE_ENGLISH_BELIZE
1994 LANGUAGE_ENGLISH_BOTSWANA
= _gdi_
.LANGUAGE_ENGLISH_BOTSWANA
1995 LANGUAGE_ENGLISH_CANADA
= _gdi_
.LANGUAGE_ENGLISH_CANADA
1996 LANGUAGE_ENGLISH_CARIBBEAN
= _gdi_
.LANGUAGE_ENGLISH_CARIBBEAN
1997 LANGUAGE_ENGLISH_DENMARK
= _gdi_
.LANGUAGE_ENGLISH_DENMARK
1998 LANGUAGE_ENGLISH_EIRE
= _gdi_
.LANGUAGE_ENGLISH_EIRE
1999 LANGUAGE_ENGLISH_JAMAICA
= _gdi_
.LANGUAGE_ENGLISH_JAMAICA
2000 LANGUAGE_ENGLISH_NEW_ZEALAND
= _gdi_
.LANGUAGE_ENGLISH_NEW_ZEALAND
2001 LANGUAGE_ENGLISH_PHILIPPINES
= _gdi_
.LANGUAGE_ENGLISH_PHILIPPINES
2002 LANGUAGE_ENGLISH_SOUTH_AFRICA
= _gdi_
.LANGUAGE_ENGLISH_SOUTH_AFRICA
2003 LANGUAGE_ENGLISH_TRINIDAD
= _gdi_
.LANGUAGE_ENGLISH_TRINIDAD
2004 LANGUAGE_ENGLISH_ZIMBABWE
= _gdi_
.LANGUAGE_ENGLISH_ZIMBABWE
2005 LANGUAGE_ESPERANTO
= _gdi_
.LANGUAGE_ESPERANTO
2006 LANGUAGE_ESTONIAN
= _gdi_
.LANGUAGE_ESTONIAN
2007 LANGUAGE_FAEROESE
= _gdi_
.LANGUAGE_FAEROESE
2008 LANGUAGE_FARSI
= _gdi_
.LANGUAGE_FARSI
2009 LANGUAGE_FIJI
= _gdi_
.LANGUAGE_FIJI
2010 LANGUAGE_FINNISH
= _gdi_
.LANGUAGE_FINNISH
2011 LANGUAGE_FRENCH
= _gdi_
.LANGUAGE_FRENCH
2012 LANGUAGE_FRENCH_BELGIAN
= _gdi_
.LANGUAGE_FRENCH_BELGIAN
2013 LANGUAGE_FRENCH_CANADIAN
= _gdi_
.LANGUAGE_FRENCH_CANADIAN
2014 LANGUAGE_FRENCH_LUXEMBOURG
= _gdi_
.LANGUAGE_FRENCH_LUXEMBOURG
2015 LANGUAGE_FRENCH_MONACO
= _gdi_
.LANGUAGE_FRENCH_MONACO
2016 LANGUAGE_FRENCH_SWISS
= _gdi_
.LANGUAGE_FRENCH_SWISS
2017 LANGUAGE_FRISIAN
= _gdi_
.LANGUAGE_FRISIAN
2018 LANGUAGE_GALICIAN
= _gdi_
.LANGUAGE_GALICIAN
2019 LANGUAGE_GEORGIAN
= _gdi_
.LANGUAGE_GEORGIAN
2020 LANGUAGE_GERMAN
= _gdi_
.LANGUAGE_GERMAN
2021 LANGUAGE_GERMAN_AUSTRIAN
= _gdi_
.LANGUAGE_GERMAN_AUSTRIAN
2022 LANGUAGE_GERMAN_BELGIUM
= _gdi_
.LANGUAGE_GERMAN_BELGIUM
2023 LANGUAGE_GERMAN_LIECHTENSTEIN
= _gdi_
.LANGUAGE_GERMAN_LIECHTENSTEIN
2024 LANGUAGE_GERMAN_LUXEMBOURG
= _gdi_
.LANGUAGE_GERMAN_LUXEMBOURG
2025 LANGUAGE_GERMAN_SWISS
= _gdi_
.LANGUAGE_GERMAN_SWISS
2026 LANGUAGE_GREEK
= _gdi_
.LANGUAGE_GREEK
2027 LANGUAGE_GREENLANDIC
= _gdi_
.LANGUAGE_GREENLANDIC
2028 LANGUAGE_GUARANI
= _gdi_
.LANGUAGE_GUARANI
2029 LANGUAGE_GUJARATI
= _gdi_
.LANGUAGE_GUJARATI
2030 LANGUAGE_HAUSA
= _gdi_
.LANGUAGE_HAUSA
2031 LANGUAGE_HEBREW
= _gdi_
.LANGUAGE_HEBREW
2032 LANGUAGE_HINDI
= _gdi_
.LANGUAGE_HINDI
2033 LANGUAGE_HUNGARIAN
= _gdi_
.LANGUAGE_HUNGARIAN
2034 LANGUAGE_ICELANDIC
= _gdi_
.LANGUAGE_ICELANDIC
2035 LANGUAGE_INDONESIAN
= _gdi_
.LANGUAGE_INDONESIAN
2036 LANGUAGE_INTERLINGUA
= _gdi_
.LANGUAGE_INTERLINGUA
2037 LANGUAGE_INTERLINGUE
= _gdi_
.LANGUAGE_INTERLINGUE
2038 LANGUAGE_INUKTITUT
= _gdi_
.LANGUAGE_INUKTITUT
2039 LANGUAGE_INUPIAK
= _gdi_
.LANGUAGE_INUPIAK
2040 LANGUAGE_IRISH
= _gdi_
.LANGUAGE_IRISH
2041 LANGUAGE_ITALIAN
= _gdi_
.LANGUAGE_ITALIAN
2042 LANGUAGE_ITALIAN_SWISS
= _gdi_
.LANGUAGE_ITALIAN_SWISS
2043 LANGUAGE_JAPANESE
= _gdi_
.LANGUAGE_JAPANESE
2044 LANGUAGE_JAVANESE
= _gdi_
.LANGUAGE_JAVANESE
2045 LANGUAGE_KANNADA
= _gdi_
.LANGUAGE_KANNADA
2046 LANGUAGE_KASHMIRI
= _gdi_
.LANGUAGE_KASHMIRI
2047 LANGUAGE_KASHMIRI_INDIA
= _gdi_
.LANGUAGE_KASHMIRI_INDIA
2048 LANGUAGE_KAZAKH
= _gdi_
.LANGUAGE_KAZAKH
2049 LANGUAGE_KERNEWEK
= _gdi_
.LANGUAGE_KERNEWEK
2050 LANGUAGE_KINYARWANDA
= _gdi_
.LANGUAGE_KINYARWANDA
2051 LANGUAGE_KIRGHIZ
= _gdi_
.LANGUAGE_KIRGHIZ
2052 LANGUAGE_KIRUNDI
= _gdi_
.LANGUAGE_KIRUNDI
2053 LANGUAGE_KONKANI
= _gdi_
.LANGUAGE_KONKANI
2054 LANGUAGE_KOREAN
= _gdi_
.LANGUAGE_KOREAN
2055 LANGUAGE_KURDISH
= _gdi_
.LANGUAGE_KURDISH
2056 LANGUAGE_LAOTHIAN
= _gdi_
.LANGUAGE_LAOTHIAN
2057 LANGUAGE_LATIN
= _gdi_
.LANGUAGE_LATIN
2058 LANGUAGE_LATVIAN
= _gdi_
.LANGUAGE_LATVIAN
2059 LANGUAGE_LINGALA
= _gdi_
.LANGUAGE_LINGALA
2060 LANGUAGE_LITHUANIAN
= _gdi_
.LANGUAGE_LITHUANIAN
2061 LANGUAGE_MACEDONIAN
= _gdi_
.LANGUAGE_MACEDONIAN
2062 LANGUAGE_MALAGASY
= _gdi_
.LANGUAGE_MALAGASY
2063 LANGUAGE_MALAY
= _gdi_
.LANGUAGE_MALAY
2064 LANGUAGE_MALAYALAM
= _gdi_
.LANGUAGE_MALAYALAM
2065 LANGUAGE_MALAY_BRUNEI_DARUSSALAM
= _gdi_
.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2066 LANGUAGE_MALAY_MALAYSIA
= _gdi_
.LANGUAGE_MALAY_MALAYSIA
2067 LANGUAGE_MALTESE
= _gdi_
.LANGUAGE_MALTESE
2068 LANGUAGE_MANIPURI
= _gdi_
.LANGUAGE_MANIPURI
2069 LANGUAGE_MAORI
= _gdi_
.LANGUAGE_MAORI
2070 LANGUAGE_MARATHI
= _gdi_
.LANGUAGE_MARATHI
2071 LANGUAGE_MOLDAVIAN
= _gdi_
.LANGUAGE_MOLDAVIAN
2072 LANGUAGE_MONGOLIAN
= _gdi_
.LANGUAGE_MONGOLIAN
2073 LANGUAGE_NAURU
= _gdi_
.LANGUAGE_NAURU
2074 LANGUAGE_NEPALI
= _gdi_
.LANGUAGE_NEPALI
2075 LANGUAGE_NEPALI_INDIA
= _gdi_
.LANGUAGE_NEPALI_INDIA
2076 LANGUAGE_NORWEGIAN_BOKMAL
= _gdi_
.LANGUAGE_NORWEGIAN_BOKMAL
2077 LANGUAGE_NORWEGIAN_NYNORSK
= _gdi_
.LANGUAGE_NORWEGIAN_NYNORSK
2078 LANGUAGE_OCCITAN
= _gdi_
.LANGUAGE_OCCITAN
2079 LANGUAGE_ORIYA
= _gdi_
.LANGUAGE_ORIYA
2080 LANGUAGE_OROMO
= _gdi_
.LANGUAGE_OROMO
2081 LANGUAGE_PASHTO
= _gdi_
.LANGUAGE_PASHTO
2082 LANGUAGE_POLISH
= _gdi_
.LANGUAGE_POLISH
2083 LANGUAGE_PORTUGUESE
= _gdi_
.LANGUAGE_PORTUGUESE
2084 LANGUAGE_PORTUGUESE_BRAZILIAN
= _gdi_
.LANGUAGE_PORTUGUESE_BRAZILIAN
2085 LANGUAGE_PUNJABI
= _gdi_
.LANGUAGE_PUNJABI
2086 LANGUAGE_QUECHUA
= _gdi_
.LANGUAGE_QUECHUA
2087 LANGUAGE_RHAETO_ROMANCE
= _gdi_
.LANGUAGE_RHAETO_ROMANCE
2088 LANGUAGE_ROMANIAN
= _gdi_
.LANGUAGE_ROMANIAN
2089 LANGUAGE_RUSSIAN
= _gdi_
.LANGUAGE_RUSSIAN
2090 LANGUAGE_RUSSIAN_UKRAINE
= _gdi_
.LANGUAGE_RUSSIAN_UKRAINE
2091 LANGUAGE_SAMOAN
= _gdi_
.LANGUAGE_SAMOAN
2092 LANGUAGE_SANGHO
= _gdi_
.LANGUAGE_SANGHO
2093 LANGUAGE_SANSKRIT
= _gdi_
.LANGUAGE_SANSKRIT
2094 LANGUAGE_SCOTS_GAELIC
= _gdi_
.LANGUAGE_SCOTS_GAELIC
2095 LANGUAGE_SERBIAN
= _gdi_
.LANGUAGE_SERBIAN
2096 LANGUAGE_SERBIAN_CYRILLIC
= _gdi_
.LANGUAGE_SERBIAN_CYRILLIC
2097 LANGUAGE_SERBIAN_LATIN
= _gdi_
.LANGUAGE_SERBIAN_LATIN
2098 LANGUAGE_SERBO_CROATIAN
= _gdi_
.LANGUAGE_SERBO_CROATIAN
2099 LANGUAGE_SESOTHO
= _gdi_
.LANGUAGE_SESOTHO
2100 LANGUAGE_SETSWANA
= _gdi_
.LANGUAGE_SETSWANA
2101 LANGUAGE_SHONA
= _gdi_
.LANGUAGE_SHONA
2102 LANGUAGE_SINDHI
= _gdi_
.LANGUAGE_SINDHI
2103 LANGUAGE_SINHALESE
= _gdi_
.LANGUAGE_SINHALESE
2104 LANGUAGE_SISWATI
= _gdi_
.LANGUAGE_SISWATI
2105 LANGUAGE_SLOVAK
= _gdi_
.LANGUAGE_SLOVAK
2106 LANGUAGE_SLOVENIAN
= _gdi_
.LANGUAGE_SLOVENIAN
2107 LANGUAGE_SOMALI
= _gdi_
.LANGUAGE_SOMALI
2108 LANGUAGE_SPANISH
= _gdi_
.LANGUAGE_SPANISH
2109 LANGUAGE_SPANISH_ARGENTINA
= _gdi_
.LANGUAGE_SPANISH_ARGENTINA
2110 LANGUAGE_SPANISH_BOLIVIA
= _gdi_
.LANGUAGE_SPANISH_BOLIVIA
2111 LANGUAGE_SPANISH_CHILE
= _gdi_
.LANGUAGE_SPANISH_CHILE
2112 LANGUAGE_SPANISH_COLOMBIA
= _gdi_
.LANGUAGE_SPANISH_COLOMBIA
2113 LANGUAGE_SPANISH_COSTA_RICA
= _gdi_
.LANGUAGE_SPANISH_COSTA_RICA
2114 LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
= _gdi_
.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2115 LANGUAGE_SPANISH_ECUADOR
= _gdi_
.LANGUAGE_SPANISH_ECUADOR
2116 LANGUAGE_SPANISH_EL_SALVADOR
= _gdi_
.LANGUAGE_SPANISH_EL_SALVADOR
2117 LANGUAGE_SPANISH_GUATEMALA
= _gdi_
.LANGUAGE_SPANISH_GUATEMALA
2118 LANGUAGE_SPANISH_HONDURAS
= _gdi_
.LANGUAGE_SPANISH_HONDURAS
2119 LANGUAGE_SPANISH_MEXICAN
= _gdi_
.LANGUAGE_SPANISH_MEXICAN
2120 LANGUAGE_SPANISH_MODERN
= _gdi_
.LANGUAGE_SPANISH_MODERN
2121 LANGUAGE_SPANISH_NICARAGUA
= _gdi_
.LANGUAGE_SPANISH_NICARAGUA
2122 LANGUAGE_SPANISH_PANAMA
= _gdi_
.LANGUAGE_SPANISH_PANAMA
2123 LANGUAGE_SPANISH_PARAGUAY
= _gdi_
.LANGUAGE_SPANISH_PARAGUAY
2124 LANGUAGE_SPANISH_PERU
= _gdi_
.LANGUAGE_SPANISH_PERU
2125 LANGUAGE_SPANISH_PUERTO_RICO
= _gdi_
.LANGUAGE_SPANISH_PUERTO_RICO
2126 LANGUAGE_SPANISH_URUGUAY
= _gdi_
.LANGUAGE_SPANISH_URUGUAY
2127 LANGUAGE_SPANISH_US
= _gdi_
.LANGUAGE_SPANISH_US
2128 LANGUAGE_SPANISH_VENEZUELA
= _gdi_
.LANGUAGE_SPANISH_VENEZUELA
2129 LANGUAGE_SUNDANESE
= _gdi_
.LANGUAGE_SUNDANESE
2130 LANGUAGE_SWAHILI
= _gdi_
.LANGUAGE_SWAHILI
2131 LANGUAGE_SWEDISH
= _gdi_
.LANGUAGE_SWEDISH
2132 LANGUAGE_SWEDISH_FINLAND
= _gdi_
.LANGUAGE_SWEDISH_FINLAND
2133 LANGUAGE_TAGALOG
= _gdi_
.LANGUAGE_TAGALOG
2134 LANGUAGE_TAJIK
= _gdi_
.LANGUAGE_TAJIK
2135 LANGUAGE_TAMIL
= _gdi_
.LANGUAGE_TAMIL
2136 LANGUAGE_TATAR
= _gdi_
.LANGUAGE_TATAR
2137 LANGUAGE_TELUGU
= _gdi_
.LANGUAGE_TELUGU
2138 LANGUAGE_THAI
= _gdi_
.LANGUAGE_THAI
2139 LANGUAGE_TIBETAN
= _gdi_
.LANGUAGE_TIBETAN
2140 LANGUAGE_TIGRINYA
= _gdi_
.LANGUAGE_TIGRINYA
2141 LANGUAGE_TONGA
= _gdi_
.LANGUAGE_TONGA
2142 LANGUAGE_TSONGA
= _gdi_
.LANGUAGE_TSONGA
2143 LANGUAGE_TURKISH
= _gdi_
.LANGUAGE_TURKISH
2144 LANGUAGE_TURKMEN
= _gdi_
.LANGUAGE_TURKMEN
2145 LANGUAGE_TWI
= _gdi_
.LANGUAGE_TWI
2146 LANGUAGE_UIGHUR
= _gdi_
.LANGUAGE_UIGHUR
2147 LANGUAGE_UKRAINIAN
= _gdi_
.LANGUAGE_UKRAINIAN
2148 LANGUAGE_URDU
= _gdi_
.LANGUAGE_URDU
2149 LANGUAGE_URDU_INDIA
= _gdi_
.LANGUAGE_URDU_INDIA
2150 LANGUAGE_URDU_PAKISTAN
= _gdi_
.LANGUAGE_URDU_PAKISTAN
2151 LANGUAGE_UZBEK
= _gdi_
.LANGUAGE_UZBEK
2152 LANGUAGE_UZBEK_CYRILLIC
= _gdi_
.LANGUAGE_UZBEK_CYRILLIC
2153 LANGUAGE_UZBEK_LATIN
= _gdi_
.LANGUAGE_UZBEK_LATIN
2154 LANGUAGE_VIETNAMESE
= _gdi_
.LANGUAGE_VIETNAMESE
2155 LANGUAGE_VOLAPUK
= _gdi_
.LANGUAGE_VOLAPUK
2156 LANGUAGE_WELSH
= _gdi_
.LANGUAGE_WELSH
2157 LANGUAGE_WOLOF
= _gdi_
.LANGUAGE_WOLOF
2158 LANGUAGE_XHOSA
= _gdi_
.LANGUAGE_XHOSA
2159 LANGUAGE_YIDDISH
= _gdi_
.LANGUAGE_YIDDISH
2160 LANGUAGE_YORUBA
= _gdi_
.LANGUAGE_YORUBA
2161 LANGUAGE_ZHUANG
= _gdi_
.LANGUAGE_ZHUANG
2162 LANGUAGE_ZULU
= _gdi_
.LANGUAGE_ZULU
2163 LANGUAGE_USER_DEFINED
= _gdi_
.LANGUAGE_USER_DEFINED
2164 class LanguageInfo(object):
2165 """Proxy of C++ LanguageInfo class"""
2166 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2167 def __init__(self
): raise AttributeError, "No constructor defined"
2168 __repr__
= _swig_repr
2169 Language
= property(_gdi_
.LanguageInfo_Language_get
, _gdi_
.LanguageInfo_Language_set
)
2170 CanonicalName
= property(_gdi_
.LanguageInfo_CanonicalName_get
, _gdi_
.LanguageInfo_CanonicalName_set
)
2171 Description
= property(_gdi_
.LanguageInfo_Description_get
, _gdi_
.LanguageInfo_Description_set
)
2172 LanguageInfo_swigregister
= _gdi_
.LanguageInfo_swigregister
2173 LanguageInfo_swigregister(LanguageInfo
)
2175 LOCALE_CAT_NUMBER
= _gdi_
.LOCALE_CAT_NUMBER
2176 LOCALE_CAT_DATE
= _gdi_
.LOCALE_CAT_DATE
2177 LOCALE_CAT_MONEY
= _gdi_
.LOCALE_CAT_MONEY
2178 LOCALE_CAT_MAX
= _gdi_
.LOCALE_CAT_MAX
2179 LOCALE_THOUSANDS_SEP
= _gdi_
.LOCALE_THOUSANDS_SEP
2180 LOCALE_DECIMAL_POINT
= _gdi_
.LOCALE_DECIMAL_POINT
2181 LOCALE_LOAD_DEFAULT
= _gdi_
.LOCALE_LOAD_DEFAULT
2182 LOCALE_CONV_ENCODING
= _gdi_
.LOCALE_CONV_ENCODING
2183 class Locale(object):
2184 """Proxy of C++ Locale class"""
2185 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2186 __repr__
= _swig_repr
2187 def __init__(self
, *args
, **kwargs
):
2188 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
2189 _gdi_
.Locale_swiginit(self
,_gdi_
.new_Locale(*args
, **kwargs
))
2190 __swig_destroy__
= _gdi_
.delete_Locale
2191 __del__
= lambda self
: None;
2192 def Init1(*args
, **kwargs
):
2194 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2195 bool bLoadDefault=True,
2196 bool bConvertEncoding=False) -> bool
2198 return _gdi_
.Locale_Init1(*args
, **kwargs
)
2200 def Init2(*args
, **kwargs
):
2201 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2202 return _gdi_
.Locale_Init2(*args
, **kwargs
)
2204 def Init(self
, *_args
, **_kwargs
):
2205 if type(_args
[0]) in [type(''), type(u
'')]:
2206 val
= self
.Init1(*_args
, **_kwargs
)
2208 val
= self
.Init2(*_args
, **_kwargs
)
2211 def GetSystemLanguage(*args
, **kwargs
):
2212 """GetSystemLanguage() -> int"""
2213 return _gdi_
.Locale_GetSystemLanguage(*args
, **kwargs
)
2215 GetSystemLanguage
= staticmethod(GetSystemLanguage
)
2216 def GetSystemEncoding(*args
, **kwargs
):
2217 """GetSystemEncoding() -> int"""
2218 return _gdi_
.Locale_GetSystemEncoding(*args
, **kwargs
)
2220 GetSystemEncoding
= staticmethod(GetSystemEncoding
)
2221 def GetSystemEncodingName(*args
, **kwargs
):
2222 """GetSystemEncodingName() -> String"""
2223 return _gdi_
.Locale_GetSystemEncodingName(*args
, **kwargs
)
2225 GetSystemEncodingName
= staticmethod(GetSystemEncodingName
)
2226 def IsOk(*args
, **kwargs
):
2227 """IsOk(self) -> bool"""
2228 return _gdi_
.Locale_IsOk(*args
, **kwargs
)
2230 def __nonzero__(self
): return self
.IsOk()
2231 def GetLocale(*args
, **kwargs
):
2232 """GetLocale(self) -> String"""
2233 return _gdi_
.Locale_GetLocale(*args
, **kwargs
)
2235 def GetLanguage(*args
, **kwargs
):
2236 """GetLanguage(self) -> int"""
2237 return _gdi_
.Locale_GetLanguage(*args
, **kwargs
)
2239 def GetSysName(*args
, **kwargs
):
2240 """GetSysName(self) -> String"""
2241 return _gdi_
.Locale_GetSysName(*args
, **kwargs
)
2243 def GetCanonicalName(*args
, **kwargs
):
2244 """GetCanonicalName(self) -> String"""
2245 return _gdi_
.Locale_GetCanonicalName(*args
, **kwargs
)
2247 def AddCatalogLookupPathPrefix(*args
, **kwargs
):
2248 """AddCatalogLookupPathPrefix(String prefix)"""
2249 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2251 AddCatalogLookupPathPrefix
= staticmethod(AddCatalogLookupPathPrefix
)
2252 def AddCatalog(*args
, **kwargs
):
2253 """AddCatalog(self, String szDomain) -> bool"""
2254 return _gdi_
.Locale_AddCatalog(*args
, **kwargs
)
2256 def IsLoaded(*args
, **kwargs
):
2257 """IsLoaded(self, String szDomain) -> bool"""
2258 return _gdi_
.Locale_IsLoaded(*args
, **kwargs
)
2260 def GetLanguageInfo(*args
, **kwargs
):
2261 """GetLanguageInfo(int lang) -> LanguageInfo"""
2262 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2264 GetLanguageInfo
= staticmethod(GetLanguageInfo
)
2265 def GetLanguageName(*args
, **kwargs
):
2266 """GetLanguageName(int lang) -> String"""
2267 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2269 GetLanguageName
= staticmethod(GetLanguageName
)
2270 def FindLanguageInfo(*args
, **kwargs
):
2271 """FindLanguageInfo(String locale) -> LanguageInfo"""
2272 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2274 FindLanguageInfo
= staticmethod(FindLanguageInfo
)
2275 def AddLanguage(*args
, **kwargs
):
2276 """AddLanguage(LanguageInfo info)"""
2277 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2279 AddLanguage
= staticmethod(AddLanguage
)
2280 def GetString(*args
, **kwargs
):
2281 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2282 return _gdi_
.Locale_GetString(*args
, **kwargs
)
2284 def GetName(*args
, **kwargs
):
2285 """GetName(self) -> String"""
2286 return _gdi_
.Locale_GetName(*args
, **kwargs
)
2288 Locale_swigregister
= _gdi_
.Locale_swigregister
2289 Locale_swigregister(Locale
)
2291 def Locale_GetSystemLanguage(*args
):
2292 """Locale_GetSystemLanguage() -> int"""
2293 return _gdi_
.Locale_GetSystemLanguage(*args
)
2295 def Locale_GetSystemEncoding(*args
):
2296 """Locale_GetSystemEncoding() -> int"""
2297 return _gdi_
.Locale_GetSystemEncoding(*args
)
2299 def Locale_GetSystemEncodingName(*args
):
2300 """Locale_GetSystemEncodingName() -> String"""
2301 return _gdi_
.Locale_GetSystemEncodingName(*args
)
2303 def Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
):
2304 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2305 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2307 def Locale_GetLanguageInfo(*args
, **kwargs
):
2308 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2309 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2311 def Locale_GetLanguageName(*args
, **kwargs
):
2312 """Locale_GetLanguageName(int lang) -> String"""
2313 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2315 def Locale_FindLanguageInfo(*args
, **kwargs
):
2316 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2317 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2319 def Locale_AddLanguage(*args
, **kwargs
):
2320 """Locale_AddLanguage(LanguageInfo info)"""
2321 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2324 def GetLocale(*args
):
2325 """GetLocale() -> Locale"""
2326 return _gdi_
.GetLocale(*args
)
2327 #---------------------------------------------------------------------------
2329 CONVERT_STRICT
= _gdi_
.CONVERT_STRICT
2330 CONVERT_SUBSTITUTE
= _gdi_
.CONVERT_SUBSTITUTE
2331 PLATFORM_CURRENT
= _gdi_
.PLATFORM_CURRENT
2332 PLATFORM_UNIX
= _gdi_
.PLATFORM_UNIX
2333 PLATFORM_WINDOWS
= _gdi_
.PLATFORM_WINDOWS
2334 PLATFORM_OS2
= _gdi_
.PLATFORM_OS2
2335 PLATFORM_MAC
= _gdi_
.PLATFORM_MAC
2336 class EncodingConverter(_core
.Object
):
2337 """Proxy of C++ EncodingConverter class"""
2338 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2339 __repr__
= _swig_repr
2340 def __init__(self
, *args
, **kwargs
):
2341 """__init__(self) -> EncodingConverter"""
2342 _gdi_
.EncodingConverter_swiginit(self
,_gdi_
.new_EncodingConverter(*args
, **kwargs
))
2343 __swig_destroy__
= _gdi_
.delete_EncodingConverter
2344 __del__
= lambda self
: None;
2345 def Init(*args
, **kwargs
):
2346 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2347 return _gdi_
.EncodingConverter_Init(*args
, **kwargs
)
2349 def Convert(*args
, **kwargs
):
2350 """Convert(self, String input) -> String"""
2351 return _gdi_
.EncodingConverter_Convert(*args
, **kwargs
)
2353 def GetPlatformEquivalents(*args
, **kwargs
):
2354 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2355 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2357 GetPlatformEquivalents
= staticmethod(GetPlatformEquivalents
)
2358 def GetAllEquivalents(*args
, **kwargs
):
2359 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2360 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2362 GetAllEquivalents
= staticmethod(GetAllEquivalents
)
2363 def CanConvert(*args
, **kwargs
):
2364 """CanConvert(int encIn, int encOut) -> bool"""
2365 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2367 CanConvert
= staticmethod(CanConvert
)
2368 def __nonzero__(self
): return self
.IsOk()
2369 EncodingConverter_swigregister
= _gdi_
.EncodingConverter_swigregister
2370 EncodingConverter_swigregister(EncodingConverter
)
2372 def GetTranslation(*args
):
2374 GetTranslation(String str) -> String
2375 GetTranslation(String str, String strPlural, size_t n) -> String
2377 return _gdi_
.GetTranslation(*args
)
2379 def EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
):
2380 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2381 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2383 def EncodingConverter_GetAllEquivalents(*args
, **kwargs
):
2384 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2385 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2387 def EncodingConverter_CanConvert(*args
, **kwargs
):
2388 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2389 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2391 #----------------------------------------------------------------------------
2392 # On MSW add the directory where the wxWidgets catalogs were installed
2393 # to the default catalog path.
2394 if wx
.Platform
== "__WXMSW__":
2396 _localedir
= os
.path
.join(os
.path
.split(__file__
)[0], "locale")
2397 Locale
.AddCatalogLookupPathPrefix(_localedir
)
2400 #----------------------------------------------------------------------------
2402 #---------------------------------------------------------------------------
2404 class DC(_core
.Object
):
2406 A wx.DC is a device context onto which graphics and text can be
2407 drawn. It is intended to represent a number of output devices in a
2408 generic way, so a window can have a device context associated with it,
2409 and a printer also has a device context. In this way, the same piece
2410 of code may write to a number of different devices, if the device
2411 context is used as a parameter.
2413 Derived types of wxDC have documentation for specific features only,
2414 so refer to this section for most device context information.
2416 The wx.DC class is abstract and can not be instantiated, you must use
2417 one of the derived classes instead. Which one will depend on the
2418 situation in which it is used.
2420 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2421 def __init__(self
): raise AttributeError, "No constructor defined"
2422 __repr__
= _swig_repr
2423 __swig_destroy__
= _gdi_
.delete_DC
2424 __del__
= lambda self
: None;
2425 # These have been deprecated in wxWidgets. Since they never
2426 # really did anything to begin with, just make them be NOPs.
2427 def BeginDrawing(self
): pass
2428 def EndDrawing(self
): pass
2430 def FloodFill(*args
, **kwargs
):
2432 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2434 Flood fills the device context starting from the given point, using
2435 the current brush colour, and using a style:
2437 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2438 the given colour is encountered.
2440 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2443 Returns False if the operation failed.
2445 Note: The present implementation for non-Windows platforms may fail to
2446 find colour borders if the pixels do not match the colour
2447 exactly. However the function will still return true.
2449 return _gdi_
.DC_FloodFill(*args
, **kwargs
)
2451 def FloodFillPoint(*args
, **kwargs
):
2453 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2455 Flood fills the device context starting from the given point, using
2456 the current brush colour, and using a style:
2458 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2459 the given colour is encountered.
2461 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2464 Returns False if the operation failed.
2466 Note: The present implementation for non-Windows platforms may fail to
2467 find colour borders if the pixels do not match the colour
2468 exactly. However the function will still return true.
2470 return _gdi_
.DC_FloodFillPoint(*args
, **kwargs
)
2472 def GradientFillConcentric(*args
, **kwargs
):
2474 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2477 Fill the area specified by rect with a radial gradient, starting from
2478 initialColour in the center of the circle and fading to destColour on
2479 the outside of the circle. The circleCenter argument is the relative
2480 coordinants of the center of the circle in the specified rect.
2482 Note: Currently this function is very slow, don't use it for real-time
2485 return _gdi_
.DC_GradientFillConcentric(*args
, **kwargs
)
2487 def GradientFillLinear(*args
, **kwargs
):
2489 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2490 int nDirection=EAST)
2492 Fill the area specified by rect with a linear gradient, starting from
2493 initialColour and eventually fading to destColour. The nDirection
2494 parameter specifies the direction of the colour change, default is to
2495 use initialColour on the left part of the rectangle and destColour on
2498 return _gdi_
.DC_GradientFillLinear(*args
, **kwargs
)
2500 def GetPixel(*args
, **kwargs
):
2502 GetPixel(self, int x, int y) -> Colour
2504 Gets the colour at the specified location on the DC.
2506 return _gdi_
.DC_GetPixel(*args
, **kwargs
)
2508 def GetPixelPoint(*args
, **kwargs
):
2509 """GetPixelPoint(self, Point pt) -> Colour"""
2510 return _gdi_
.DC_GetPixelPoint(*args
, **kwargs
)
2512 def DrawLine(*args
, **kwargs
):
2514 DrawLine(self, int x1, int y1, int x2, int y2)
2516 Draws a line from the first point to the second. The current pen is
2517 used for drawing the line. Note that the second point is *not* part of
2518 the line and is not drawn by this function (this is consistent with
2519 the behaviour of many other toolkits).
2521 return _gdi_
.DC_DrawLine(*args
, **kwargs
)
2523 def DrawLinePoint(*args
, **kwargs
):
2525 DrawLinePoint(self, Point pt1, Point pt2)
2527 Draws a line from the first point to the second. The current pen is
2528 used for drawing the line. Note that the second point is *not* part of
2529 the line and is not drawn by this function (this is consistent with
2530 the behaviour of many other toolkits).
2532 return _gdi_
.DC_DrawLinePoint(*args
, **kwargs
)
2534 def CrossHair(*args
, **kwargs
):
2536 CrossHair(self, int x, int y)
2538 Displays a cross hair using the current pen. This is a vertical and
2539 horizontal line the height and width of the window, centred on the
2542 return _gdi_
.DC_CrossHair(*args
, **kwargs
)
2544 def CrossHairPoint(*args
, **kwargs
):
2546 CrossHairPoint(self, Point pt)
2548 Displays a cross hair using the current pen. This is a vertical and
2549 horizontal line the height and width of the window, centred on the
2552 return _gdi_
.DC_CrossHairPoint(*args
, **kwargs
)
2554 def DrawArc(*args
, **kwargs
):
2556 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
2558 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2559 the first point to the second. The current pen is used for the outline
2560 and the current brush for filling the shape.
2562 The arc is drawn in an anticlockwise direction from the start point to
2565 return _gdi_
.DC_DrawArc(*args
, **kwargs
)
2567 def DrawArcPoint(*args
, **kwargs
):
2569 DrawArcPoint(self, Point pt1, Point pt2, Point center)
2571 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2572 the first point to the second. The current pen is used for the outline
2573 and the current brush for filling the shape.
2575 The arc is drawn in an anticlockwise direction from the start point to
2578 return _gdi_
.DC_DrawArcPoint(*args
, **kwargs
)
2580 def DrawCheckMark(*args
, **kwargs
):
2582 DrawCheckMark(self, int x, int y, int width, int height)
2584 Draws a check mark inside the given rectangle.
2586 return _gdi_
.DC_DrawCheckMark(*args
, **kwargs
)
2588 def DrawCheckMarkRect(*args
, **kwargs
):
2590 DrawCheckMarkRect(self, Rect rect)
2592 Draws a check mark inside the given rectangle.
2594 return _gdi_
.DC_DrawCheckMarkRect(*args
, **kwargs
)
2596 def DrawEllipticArc(*args
, **kwargs
):
2598 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
2600 Draws an arc of an ellipse, with the given rectangle defining the
2601 bounds of the ellipse. The current pen is used for drawing the arc and
2602 the current brush is used for drawing the pie.
2604 The *start* and *end* parameters specify the start and end of the arc
2605 relative to the three-o'clock position from the center of the
2606 rectangle. Angles are specified in degrees (360 is a complete
2607 circle). Positive values mean counter-clockwise motion. If start is
2608 equal to end, a complete ellipse will be drawn.
2610 return _gdi_
.DC_DrawEllipticArc(*args
, **kwargs
)
2612 def DrawEllipticArcPointSize(*args
, **kwargs
):
2614 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
2616 Draws an arc of an ellipse, with the given rectangle defining the
2617 bounds of the ellipse. The current pen is used for drawing the arc and
2618 the current brush is used for drawing the pie.
2620 The *start* and *end* parameters specify the start and end of the arc
2621 relative to the three-o'clock position from the center of the
2622 rectangle. Angles are specified in degrees (360 is a complete
2623 circle). Positive values mean counter-clockwise motion. If start is
2624 equal to end, a complete ellipse will be drawn.
2626 return _gdi_
.DC_DrawEllipticArcPointSize(*args
, **kwargs
)
2628 def DrawPoint(*args
, **kwargs
):
2630 DrawPoint(self, int x, int y)
2632 Draws a point using the current pen.
2634 return _gdi_
.DC_DrawPoint(*args
, **kwargs
)
2636 def DrawPointPoint(*args
, **kwargs
):
2638 DrawPointPoint(self, Point pt)
2640 Draws a point using the current pen.
2642 return _gdi_
.DC_DrawPointPoint(*args
, **kwargs
)
2644 def DrawRectangle(*args
, **kwargs
):
2646 DrawRectangle(self, int x, int y, int width, int height)
2648 Draws a rectangle with the given top left corner, and with the given
2649 size. The current pen is used for the outline and the current brush
2650 for filling the shape.
2652 return _gdi_
.DC_DrawRectangle(*args
, **kwargs
)
2654 def DrawRectangleRect(*args
, **kwargs
):
2656 DrawRectangleRect(self, Rect rect)
2658 Draws a rectangle with the given top left corner, and with the given
2659 size. The current pen is used for the outline and the current brush
2660 for filling the shape.
2662 return _gdi_
.DC_DrawRectangleRect(*args
, **kwargs
)
2664 def DrawRectanglePointSize(*args
, **kwargs
):
2666 DrawRectanglePointSize(self, Point pt, Size sz)
2668 Draws a rectangle with the given top left corner, and with the given
2669 size. The current pen is used for the outline and the current brush
2670 for filling the shape.
2672 return _gdi_
.DC_DrawRectanglePointSize(*args
, **kwargs
)
2674 def DrawRoundedRectangle(*args
, **kwargs
):
2676 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
2678 Draws a rectangle with the given top left corner, and with the given
2679 size. The corners are quarter-circles using the given radius. The
2680 current pen is used for the outline and the current brush for filling
2683 If radius is positive, the value is assumed to be the radius of the
2684 rounded corner. If radius is negative, the absolute value is assumed
2685 to be the proportion of the smallest dimension of the rectangle. This
2686 means that the corner can be a sensible size relative to the size of
2687 the rectangle, and also avoids the strange effects X produces when the
2688 corners are too big for the rectangle.
2690 return _gdi_
.DC_DrawRoundedRectangle(*args
, **kwargs
)
2692 def DrawRoundedRectangleRect(*args
, **kwargs
):
2694 DrawRoundedRectangleRect(self, Rect r, double radius)
2696 Draws a rectangle with the given top left corner, and with the given
2697 size. The corners are quarter-circles using the given radius. The
2698 current pen is used for the outline and the current brush for filling
2701 If radius is positive, the value is assumed to be the radius of the
2702 rounded corner. If radius is negative, the absolute value is assumed
2703 to be the proportion of the smallest dimension of the rectangle. This
2704 means that the corner can be a sensible size relative to the size of
2705 the rectangle, and also avoids the strange effects X produces when the
2706 corners are too big for the rectangle.
2708 return _gdi_
.DC_DrawRoundedRectangleRect(*args
, **kwargs
)
2710 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
2712 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
2714 Draws a rectangle with the given top left corner, and with the given
2715 size. The corners are quarter-circles using the given radius. The
2716 current pen is used for the outline and the current brush for filling
2719 If radius is positive, the value is assumed to be the radius of the
2720 rounded corner. If radius is negative, the absolute value is assumed
2721 to be the proportion of the smallest dimension of the rectangle. This
2722 means that the corner can be a sensible size relative to the size of
2723 the rectangle, and also avoids the strange effects X produces when the
2724 corners are too big for the rectangle.
2726 return _gdi_
.DC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
2728 def DrawCircle(*args
, **kwargs
):
2730 DrawCircle(self, int x, int y, int radius)
2732 Draws a circle with the given center point and radius. The current
2733 pen is used for the outline and the current brush for filling the
2736 return _gdi_
.DC_DrawCircle(*args
, **kwargs
)
2738 def DrawCirclePoint(*args
, **kwargs
):
2740 DrawCirclePoint(self, Point pt, int radius)
2742 Draws a circle with the given center point and radius. The current
2743 pen is used for the outline and the current brush for filling the
2746 return _gdi_
.DC_DrawCirclePoint(*args
, **kwargs
)
2748 def DrawEllipse(*args
, **kwargs
):
2750 DrawEllipse(self, int x, int y, int width, int height)
2752 Draws an ellipse contained in the specified rectangle. The current pen
2753 is used for the outline and the current brush for filling the shape.
2755 return _gdi_
.DC_DrawEllipse(*args
, **kwargs
)
2757 def DrawEllipseRect(*args
, **kwargs
):
2759 DrawEllipseRect(self, Rect rect)
2761 Draws an ellipse contained in the specified rectangle. The current pen
2762 is used for the outline and the current brush for filling the shape.
2764 return _gdi_
.DC_DrawEllipseRect(*args
, **kwargs
)
2766 def DrawEllipsePointSize(*args
, **kwargs
):
2768 DrawEllipsePointSize(self, Point pt, Size sz)
2770 Draws an ellipse contained in the specified rectangle. The current pen
2771 is used for the outline and the current brush for filling the shape.
2773 return _gdi_
.DC_DrawEllipsePointSize(*args
, **kwargs
)
2775 def DrawIcon(*args
, **kwargs
):
2777 DrawIcon(self, Icon icon, int x, int y)
2779 Draw an icon on the display (does nothing if the device context is
2780 PostScript). This can be the simplest way of drawing bitmaps on a
2783 return _gdi_
.DC_DrawIcon(*args
, **kwargs
)
2785 def DrawIconPoint(*args
, **kwargs
):
2787 DrawIconPoint(self, Icon icon, Point pt)
2789 Draw an icon on the display (does nothing if the device context is
2790 PostScript). This can be the simplest way of drawing bitmaps on a
2793 return _gdi_
.DC_DrawIconPoint(*args
, **kwargs
)
2795 def DrawBitmap(*args
, **kwargs
):
2797 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
2799 Draw a bitmap on the device context at the specified point. If
2800 *transparent* is true and the bitmap has a transparency mask, (or
2801 alpha channel on the platforms that support it) then the bitmap will
2802 be drawn transparently.
2804 return _gdi_
.DC_DrawBitmap(*args
, **kwargs
)
2806 def DrawBitmapPoint(*args
, **kwargs
):
2808 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
2810 Draw a bitmap on the device context at the specified point. If
2811 *transparent* is true and the bitmap has a transparency mask, (or
2812 alpha channel on the platforms that support it) then the bitmap will
2813 be drawn transparently.
2815 return _gdi_
.DC_DrawBitmapPoint(*args
, **kwargs
)
2817 def DrawText(*args
, **kwargs
):
2819 DrawText(self, String text, int x, int y)
2821 Draws a text string at the specified point, using the current text
2822 font, and the current text foreground and background colours.
2824 The coordinates refer to the top-left corner of the rectangle bounding
2825 the string. See `GetTextExtent` for how to get the dimensions of a
2826 text string, which can be used to position the text more precisely.
2828 **NOTE**: under wxGTK the current logical function is used by this
2829 function but it is ignored by wxMSW. Thus, you should avoid using
2830 logical functions with this function in portable programs.
2832 return _gdi_
.DC_DrawText(*args
, **kwargs
)
2834 def DrawTextPoint(*args
, **kwargs
):
2836 DrawTextPoint(self, String text, Point pt)
2838 Draws a text string at the specified point, using the current text
2839 font, and the current text foreground and background colours.
2841 The coordinates refer to the top-left corner of the rectangle bounding
2842 the string. See `GetTextExtent` for how to get the dimensions of a
2843 text string, which can be used to position the text more precisely.
2845 **NOTE**: under wxGTK the current logical function is used by this
2846 function but it is ignored by wxMSW. Thus, you should avoid using
2847 logical functions with this function in portable programs.
2849 return _gdi_
.DC_DrawTextPoint(*args
, **kwargs
)
2851 def DrawRotatedText(*args
, **kwargs
):
2853 DrawRotatedText(self, String text, int x, int y, double angle)
2855 Draws the text rotated by *angle* degrees, if supported by the platform.
2857 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
2858 function. In particular, a font different from ``wx.NORMAL_FONT``
2859 should be used as the it is not normally a TrueType
2860 font. ``wx.SWISS_FONT`` is an example of a font which is.
2862 return _gdi_
.DC_DrawRotatedText(*args
, **kwargs
)
2864 def DrawRotatedTextPoint(*args
, **kwargs
):
2866 DrawRotatedTextPoint(self, String text, Point pt, double angle)
2868 Draws the text rotated by *angle* degrees, if supported by the platform.
2870 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
2871 function. In particular, a font different from ``wx.NORMAL_FONT``
2872 should be used as the it is not normally a TrueType
2873 font. ``wx.SWISS_FONT`` is an example of a font which is.
2875 return _gdi_
.DC_DrawRotatedTextPoint(*args
, **kwargs
)
2877 def Blit(*args
, **kwargs
):
2879 Blit(self, int xdest, int ydest, int width, int height, DC source,
2880 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
2881 int xsrcMask=-1, int ysrcMask=-1) -> bool
2883 Copy from a source DC to this DC. Parameters specify the destination
2884 coordinates, size of area to copy, source DC, source coordinates,
2885 logical function, whether to use a bitmap mask, and mask source
2888 return _gdi_
.DC_Blit(*args
, **kwargs
)
2890 def BlitPointSize(*args
, **kwargs
):
2892 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
2893 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
2895 Copy from a source DC to this DC. Parameters specify the destination
2896 coordinates, size of area to copy, source DC, source coordinates,
2897 logical function, whether to use a bitmap mask, and mask source
2900 return _gdi_
.DC_BlitPointSize(*args
, **kwargs
)
2902 def SetClippingRegion(*args
, **kwargs
):
2904 SetClippingRegion(self, int x, int y, int width, int height)
2906 Sets the clipping region for this device context to the intersection
2907 of the given region described by the parameters of this method and the
2908 previously set clipping region. You should call `DestroyClippingRegion`
2909 if you want to set the clipping region exactly to the region
2912 The clipping region is an area to which drawing is
2913 restricted. Possible uses for the clipping region are for clipping
2914 text or for speeding up window redraws when only a known area of the
2917 return _gdi_
.DC_SetClippingRegion(*args
, **kwargs
)
2919 def SetClippingRegionPointSize(*args
, **kwargs
):
2921 SetClippingRegionPointSize(self, Point pt, Size sz)
2923 Sets the clipping region for this device context to the intersection
2924 of the given region described by the parameters of this method and the
2925 previously set clipping region. You should call `DestroyClippingRegion`
2926 if you want to set the clipping region exactly to the region
2929 The clipping region is an area to which drawing is
2930 restricted. Possible uses for the clipping region are for clipping
2931 text or for speeding up window redraws when only a known area of the
2934 return _gdi_
.DC_SetClippingRegionPointSize(*args
, **kwargs
)
2936 def SetClippingRegionAsRegion(*args
, **kwargs
):
2938 SetClippingRegionAsRegion(self, Region region)
2940 Sets the clipping region for this device context to the intersection
2941 of the given region described by the parameters of this method and the
2942 previously set clipping region. You should call `DestroyClippingRegion`
2943 if you want to set the clipping region exactly to the region
2946 The clipping region is an area to which drawing is
2947 restricted. Possible uses for the clipping region are for clipping
2948 text or for speeding up window redraws when only a known area of the
2951 return _gdi_
.DC_SetClippingRegionAsRegion(*args
, **kwargs
)
2953 def SetClippingRect(*args
, **kwargs
):
2955 SetClippingRect(self, Rect rect)
2957 Sets the clipping region for this device context to the intersection
2958 of the given region described by the parameters of this method and the
2959 previously set clipping region. You should call `DestroyClippingRegion`
2960 if you want to set the clipping region exactly to the region
2963 The clipping region is an area to which drawing is
2964 restricted. Possible uses for the clipping region are for clipping
2965 text or for speeding up window redraws when only a known area of the
2968 return _gdi_
.DC_SetClippingRect(*args
, **kwargs
)
2970 def DrawLines(*args
, **kwargs
):
2972 DrawLines(self, List points, int xoffset=0, int yoffset=0)
2974 Draws lines using a sequence of `wx.Point` objects, adding the
2975 optional offset coordinate. The current pen is used for drawing the
2978 return _gdi_
.DC_DrawLines(*args
, **kwargs
)
2980 def DrawPolygon(*args
, **kwargs
):
2982 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
2983 int fillStyle=ODDEVEN_RULE)
2985 Draws a filled polygon using a sequence of `wx.Point` objects, adding
2986 the optional offset coordinate. The last argument specifies the fill
2987 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
2989 The current pen is used for drawing the outline, and the current brush
2990 for filling the shape. Using a transparent brush suppresses
2991 filling. Note that wxWidgets automatically closes the first and last
2994 return _gdi_
.DC_DrawPolygon(*args
, **kwargs
)
2996 def DrawLabel(*args
, **kwargs
):
2998 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3001 Draw *text* within the specified rectangle, abiding by the alignment
3002 flags. Will additionally emphasize the character at *indexAccel* if
3005 return _gdi_
.DC_DrawLabel(*args
, **kwargs
)
3007 def DrawImageLabel(*args
, **kwargs
):
3009 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3010 int indexAccel=-1) -> Rect
3012 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3013 drawing it) within the specified rectangle, abiding by the alignment
3014 flags. Will additionally emphasize the character at *indexAccel* if
3015 it is not -1. Returns the bounding rectangle.
3017 return _gdi_
.DC_DrawImageLabel(*args
, **kwargs
)
3019 def DrawSpline(*args
, **kwargs
):
3021 DrawSpline(self, List points)
3023 Draws a spline between all given control points, (a list of `wx.Point`
3024 objects) using the current pen. The spline is drawn using a series of
3025 lines, using an algorithm taken from the X drawing program 'XFIG'.
3027 return _gdi_
.DC_DrawSpline(*args
, **kwargs
)
3029 def Clear(*args
, **kwargs
):
3033 Clears the device context using the current background brush.
3035 return _gdi_
.DC_Clear(*args
, **kwargs
)
3037 def StartDoc(*args
, **kwargs
):
3039 StartDoc(self, String message) -> bool
3041 Starts a document (only relevant when outputting to a
3042 printer). *Message* is a message to show whilst printing.
3044 return _gdi_
.DC_StartDoc(*args
, **kwargs
)
3046 def EndDoc(*args
, **kwargs
):
3050 Ends a document (only relevant when outputting to a printer).
3052 return _gdi_
.DC_EndDoc(*args
, **kwargs
)
3054 def StartPage(*args
, **kwargs
):
3058 Starts a document page (only relevant when outputting to a printer).
3060 return _gdi_
.DC_StartPage(*args
, **kwargs
)
3062 def EndPage(*args
, **kwargs
):
3066 Ends a document page (only relevant when outputting to a printer).
3068 return _gdi_
.DC_EndPage(*args
, **kwargs
)
3070 def SetFont(*args
, **kwargs
):
3072 SetFont(self, Font font)
3074 Sets the current font for the DC. It must be a valid font, in
3075 particular you should not pass ``wx.NullFont`` to this method.
3077 return _gdi_
.DC_SetFont(*args
, **kwargs
)
3079 def SetPen(*args
, **kwargs
):
3081 SetPen(self, Pen pen)
3083 Sets the current pen for the DC.
3085 If the argument is ``wx.NullPen``, the current pen is selected out of the
3086 device context, and the original pen restored.
3088 return _gdi_
.DC_SetPen(*args
, **kwargs
)
3090 def SetBrush(*args
, **kwargs
):
3092 SetBrush(self, Brush brush)
3094 Sets the current brush for the DC.
3096 If the argument is ``wx.NullBrush``, the current brush is selected out
3097 of the device context, and the original brush restored, allowing the
3098 current brush to be destroyed safely.
3100 return _gdi_
.DC_SetBrush(*args
, **kwargs
)
3102 def SetBackground(*args
, **kwargs
):
3104 SetBackground(self, Brush brush)
3106 Sets the current background brush for the DC.
3108 return _gdi_
.DC_SetBackground(*args
, **kwargs
)
3110 def SetBackgroundMode(*args
, **kwargs
):
3112 SetBackgroundMode(self, int mode)
3114 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3115 determines whether text will be drawn with a background colour or
3118 return _gdi_
.DC_SetBackgroundMode(*args
, **kwargs
)
3120 def SetPalette(*args
, **kwargs
):
3122 SetPalette(self, Palette palette)
3124 If this is a window DC or memory DC, assigns the given palette to the
3125 window or bitmap associated with the DC. If the argument is
3126 ``wx.NullPalette``, the current palette is selected out of the device
3127 context, and the original palette restored.
3129 return _gdi_
.DC_SetPalette(*args
, **kwargs
)
3131 def DestroyClippingRegion(*args
, **kwargs
):
3133 DestroyClippingRegion(self)
3135 Destroys the current clipping region so that none of the DC is
3138 return _gdi_
.DC_DestroyClippingRegion(*args
, **kwargs
)
3140 def GetClippingBox(*args
, **kwargs
):
3142 GetClippingBox() -> (x, y, width, height)
3144 Gets the rectangle surrounding the current clipping region.
3146 return _gdi_
.DC_GetClippingBox(*args
, **kwargs
)
3148 def GetClippingRect(*args
, **kwargs
):
3150 GetClippingRect(self) -> Rect
3152 Gets the rectangle surrounding the current clipping region.
3154 return _gdi_
.DC_GetClippingRect(*args
, **kwargs
)
3156 def GetCharHeight(*args
, **kwargs
):
3158 GetCharHeight(self) -> int
3160 Gets the character height of the currently set font.
3162 return _gdi_
.DC_GetCharHeight(*args
, **kwargs
)
3164 def GetCharWidth(*args
, **kwargs
):
3166 GetCharWidth(self) -> int
3168 Gets the average character width of the currently set font.
3170 return _gdi_
.DC_GetCharWidth(*args
, **kwargs
)
3172 def GetTextExtent(*args
, **kwargs
):
3174 GetTextExtent(wxString string) -> (width, height)
3176 Get the width and height of the text using the current font. Only
3177 works for single line strings.
3179 return _gdi_
.DC_GetTextExtent(*args
, **kwargs
)
3181 def GetFullTextExtent(*args
, **kwargs
):
3183 GetFullTextExtent(wxString string, Font font=None) ->
3184 (width, height, descent, externalLeading)
3186 Get the width, height, decent and leading of the text using the
3187 current or specified font. Only works for single line strings.
3189 return _gdi_
.DC_GetFullTextExtent(*args
, **kwargs
)
3191 def GetMultiLineTextExtent(*args
, **kwargs
):
3193 GetMultiLineTextExtent(wxString string, Font font=None) ->
3194 (width, height, descent, externalLeading)
3196 Get the width, height, decent and leading of the text using the
3197 current or specified font. Works for single as well as multi-line
3200 return _gdi_
.DC_GetMultiLineTextExtent(*args
, **kwargs
)
3202 def GetPartialTextExtents(*args
, **kwargs
):
3204 GetPartialTextExtents(self, text) -> [widths]
3206 Returns a list of integers such that each value is the distance in
3207 pixels from the begining of text to the coresponding character of
3208 *text*. The generic version simply builds a running total of the widths
3209 of each character using GetTextExtent, however if the various
3210 platforms have a native API function that is faster or more accurate
3211 than the generic implementation then it will be used instead.
3213 return _gdi_
.DC_GetPartialTextExtents(*args
, **kwargs
)
3215 def GetSize(*args
, **kwargs
):
3217 GetSize(self) -> Size
3219 This gets the horizontal and vertical resolution in device units. It
3220 can be used to scale graphics to fit the page. For example, if *maxX*
3221 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3222 used in your application, the following code will scale the graphic to
3223 fit on the printer page::
3226 scaleX = maxX*1.0 / w
3227 scaleY = maxY*1.0 / h
3228 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3231 return _gdi_
.DC_GetSize(*args
, **kwargs
)
3233 def GetSizeTuple(*args
, **kwargs
):
3235 GetSizeTuple() -> (width, height)
3237 This gets the horizontal and vertical resolution in device units. It
3238 can be used to scale graphics to fit the page. For example, if *maxX*
3239 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3240 used in your application, the following code will scale the graphic to
3241 fit on the printer page::
3244 scaleX = maxX*1.0 / w
3245 scaleY = maxY*1.0 / h
3246 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3249 return _gdi_
.DC_GetSizeTuple(*args
, **kwargs
)
3251 def GetSizeMM(*args
, **kwargs
):
3253 GetSizeMM(self) -> Size
3255 Get the DC size in milimeters.
3257 return _gdi_
.DC_GetSizeMM(*args
, **kwargs
)
3259 def GetSizeMMTuple(*args
, **kwargs
):
3261 GetSizeMMTuple() -> (width, height)
3263 Get the DC size in milimeters.
3265 return _gdi_
.DC_GetSizeMMTuple(*args
, **kwargs
)
3267 def DeviceToLogicalX(*args
, **kwargs
):
3269 DeviceToLogicalX(self, int x) -> int
3271 Convert device X coordinate to logical coordinate, using the current
3274 return _gdi_
.DC_DeviceToLogicalX(*args
, **kwargs
)
3276 def DeviceToLogicalY(*args
, **kwargs
):
3278 DeviceToLogicalY(self, int y) -> int
3280 Converts device Y coordinate to logical coordinate, using the current
3283 return _gdi_
.DC_DeviceToLogicalY(*args
, **kwargs
)
3285 def DeviceToLogicalXRel(*args
, **kwargs
):
3287 DeviceToLogicalXRel(self, int x) -> int
3289 Convert device X coordinate to relative logical coordinate, using the
3290 current mapping mode but ignoring the x axis orientation. Use this
3291 function for converting a width, for example.
3293 return _gdi_
.DC_DeviceToLogicalXRel(*args
, **kwargs
)
3295 def DeviceToLogicalYRel(*args
, **kwargs
):
3297 DeviceToLogicalYRel(self, int y) -> int
3299 Convert device Y coordinate to relative logical coordinate, using the
3300 current mapping mode but ignoring the y axis orientation. Use this
3301 function for converting a height, for example.
3303 return _gdi_
.DC_DeviceToLogicalYRel(*args
, **kwargs
)
3305 def LogicalToDeviceX(*args
, **kwargs
):
3307 LogicalToDeviceX(self, int x) -> int
3309 Converts logical X coordinate to device coordinate, using the current
3312 return _gdi_
.DC_LogicalToDeviceX(*args
, **kwargs
)
3314 def LogicalToDeviceY(*args
, **kwargs
):
3316 LogicalToDeviceY(self, int y) -> int
3318 Converts logical Y coordinate to device coordinate, using the current
3321 return _gdi_
.DC_LogicalToDeviceY(*args
, **kwargs
)
3323 def LogicalToDeviceXRel(*args
, **kwargs
):
3325 LogicalToDeviceXRel(self, int x) -> int
3327 Converts logical X coordinate to relative device coordinate, using the
3328 current mapping mode but ignoring the x axis orientation. Use this for
3329 converting a width, for example.
3331 return _gdi_
.DC_LogicalToDeviceXRel(*args
, **kwargs
)
3333 def LogicalToDeviceYRel(*args
, **kwargs
):
3335 LogicalToDeviceYRel(self, int y) -> int
3337 Converts logical Y coordinate to relative device coordinate, using the
3338 current mapping mode but ignoring the y axis orientation. Use this for
3339 converting a height, for example.
3341 return _gdi_
.DC_LogicalToDeviceYRel(*args
, **kwargs
)
3343 def CanDrawBitmap(*args
, **kwargs
):
3344 """CanDrawBitmap(self) -> bool"""
3345 return _gdi_
.DC_CanDrawBitmap(*args
, **kwargs
)
3347 def CanGetTextExtent(*args
, **kwargs
):
3348 """CanGetTextExtent(self) -> bool"""
3349 return _gdi_
.DC_CanGetTextExtent(*args
, **kwargs
)
3351 def GetDepth(*args
, **kwargs
):
3353 GetDepth(self) -> int
3355 Returns the colour depth of the DC.
3357 return _gdi_
.DC_GetDepth(*args
, **kwargs
)
3359 def GetPPI(*args
, **kwargs
):
3361 GetPPI(self) -> Size
3363 Resolution in Pixels per inch
3365 return _gdi_
.DC_GetPPI(*args
, **kwargs
)
3367 def Ok(*args
, **kwargs
):
3371 Returns true if the DC is ok to use.
3373 return _gdi_
.DC_Ok(*args
, **kwargs
)
3375 def GetBackgroundMode(*args
, **kwargs
):
3377 GetBackgroundMode(self) -> int
3379 Returns the current background mode, either ``wx.SOLID`` or
3382 return _gdi_
.DC_GetBackgroundMode(*args
, **kwargs
)
3384 def GetBackground(*args
, **kwargs
):
3386 GetBackground(self) -> Brush
3388 Gets the brush used for painting the background.
3390 return _gdi_
.DC_GetBackground(*args
, **kwargs
)
3392 def GetBrush(*args
, **kwargs
):
3394 GetBrush(self) -> Brush
3396 Gets the current brush
3398 return _gdi_
.DC_GetBrush(*args
, **kwargs
)
3400 def GetFont(*args
, **kwargs
):
3402 GetFont(self) -> Font
3404 Gets the current font
3406 return _gdi_
.DC_GetFont(*args
, **kwargs
)
3408 def GetPen(*args
, **kwargs
):
3412 Gets the current pen
3414 return _gdi_
.DC_GetPen(*args
, **kwargs
)
3416 def GetTextBackground(*args
, **kwargs
):
3418 GetTextBackground(self) -> Colour
3420 Gets the current text background colour
3422 return _gdi_
.DC_GetTextBackground(*args
, **kwargs
)
3424 def GetTextForeground(*args
, **kwargs
):
3426 GetTextForeground(self) -> Colour
3428 Gets the current text foreground colour
3430 return _gdi_
.DC_GetTextForeground(*args
, **kwargs
)
3432 def SetTextForeground(*args
, **kwargs
):
3434 SetTextForeground(self, Colour colour)
3436 Sets the current text foreground colour for the DC.
3438 return _gdi_
.DC_SetTextForeground(*args
, **kwargs
)
3440 def SetTextBackground(*args
, **kwargs
):
3442 SetTextBackground(self, Colour colour)
3444 Sets the current text background colour for the DC.
3446 return _gdi_
.DC_SetTextBackground(*args
, **kwargs
)
3448 def GetMapMode(*args
, **kwargs
):
3450 GetMapMode(self) -> int
3452 Gets the current *mapping mode* for the device context
3454 return _gdi_
.DC_GetMapMode(*args
, **kwargs
)
3456 def SetMapMode(*args
, **kwargs
):
3458 SetMapMode(self, int mode)
3460 The *mapping mode* of the device context defines the unit of
3461 measurement used to convert logical units to device units. The
3462 mapping mode can be one of the following:
3464 ================ =============================================
3465 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3467 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3468 wx.MM_METRIC Each logical unit is 1 mm.
3469 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3470 wx.MM_TEXT Each logical unit is 1 pixel.
3471 ================ =============================================
3474 return _gdi_
.DC_SetMapMode(*args
, **kwargs
)
3476 def GetUserScale(*args
, **kwargs
):
3478 GetUserScale(self) -> (xScale, yScale)
3480 Gets the current user scale factor (set by `SetUserScale`).
3482 return _gdi_
.DC_GetUserScale(*args
, **kwargs
)
3484 def SetUserScale(*args
, **kwargs
):
3486 SetUserScale(self, double x, double y)
3488 Sets the user scaling factor, useful for applications which require
3491 return _gdi_
.DC_SetUserScale(*args
, **kwargs
)
3493 def GetLogicalScale(*args
, **kwargs
):
3494 """GetLogicalScale() -> (xScale, yScale)"""
3495 return _gdi_
.DC_GetLogicalScale(*args
, **kwargs
)
3497 def SetLogicalScale(*args
, **kwargs
):
3498 """SetLogicalScale(self, double x, double y)"""
3499 return _gdi_
.DC_SetLogicalScale(*args
, **kwargs
)
3501 def GetLogicalOrigin(*args
, **kwargs
):
3502 """GetLogicalOrigin(self) -> Point"""
3503 return _gdi_
.DC_GetLogicalOrigin(*args
, **kwargs
)
3505 def GetLogicalOriginTuple(*args
, **kwargs
):
3506 """GetLogicalOriginTuple() -> (x,y)"""
3507 return _gdi_
.DC_GetLogicalOriginTuple(*args
, **kwargs
)
3509 def SetLogicalOrigin(*args
, **kwargs
):
3510 """SetLogicalOrigin(self, int x, int y)"""
3511 return _gdi_
.DC_SetLogicalOrigin(*args
, **kwargs
)
3513 def SetLogicalOriginPoint(*args
, **kwargs
):
3514 """SetLogicalOriginPoint(self, Point point)"""
3515 return _gdi_
.DC_SetLogicalOriginPoint(*args
, **kwargs
)
3517 def GetDeviceOrigin(*args
, **kwargs
):
3518 """GetDeviceOrigin(self) -> Point"""
3519 return _gdi_
.DC_GetDeviceOrigin(*args
, **kwargs
)
3521 def GetDeviceOriginTuple(*args
, **kwargs
):
3522 """GetDeviceOriginTuple() -> (x,y)"""
3523 return _gdi_
.DC_GetDeviceOriginTuple(*args
, **kwargs
)
3525 def SetDeviceOrigin(*args
, **kwargs
):
3526 """SetDeviceOrigin(self, int x, int y)"""
3527 return _gdi_
.DC_SetDeviceOrigin(*args
, **kwargs
)
3529 def SetDeviceOriginPoint(*args
, **kwargs
):
3530 """SetDeviceOriginPoint(self, Point point)"""
3531 return _gdi_
.DC_SetDeviceOriginPoint(*args
, **kwargs
)
3533 def SetAxisOrientation(*args
, **kwargs
):
3535 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
3537 Sets the x and y axis orientation (i.e., the direction from lowest to
3538 highest values on the axis). The default orientation is the natural
3539 orientation, e.g. x axis from left to right and y axis from bottom up.
3541 return _gdi_
.DC_SetAxisOrientation(*args
, **kwargs
)
3543 def GetLogicalFunction(*args
, **kwargs
):
3545 GetLogicalFunction(self) -> int
3547 Gets the current logical function (set by `SetLogicalFunction`).
3549 return _gdi_
.DC_GetLogicalFunction(*args
, **kwargs
)
3551 def SetLogicalFunction(*args
, **kwargs
):
3553 SetLogicalFunction(self, int function)
3555 Sets the current logical function for the device context. This
3556 determines how a source pixel (from a pen or brush colour, or source
3557 device context if using `Blit`) combines with a destination pixel in
3558 the current device context.
3560 The possible values and their meaning in terms of source and
3561 destination pixel values are as follows:
3563 ================ ==========================
3565 wx.AND_INVERT (NOT src) AND dst
3566 wx.AND_REVERSE src AND (NOT dst)
3569 wx.EQUIV (NOT src) XOR dst
3571 wx.NAND (NOT src) OR (NOT dst)
3572 wx.NOR (NOT src) AND (NOT dst)
3575 wx.OR_INVERT (NOT src) OR dst
3576 wx.OR_REVERSE src OR (NOT dst)
3578 wx.SRC_INVERT NOT src
3580 ================ ==========================
3582 The default is wx.COPY, which simply draws with the current
3583 colour. The others combine the current colour and the background using
3584 a logical operation. wx.INVERT is commonly used for drawing rubber
3585 bands or moving outlines, since drawing twice reverts to the original
3589 return _gdi_
.DC_SetLogicalFunction(*args
, **kwargs
)
3591 def ComputeScaleAndOrigin(*args
, **kwargs
):
3593 ComputeScaleAndOrigin(self)
3595 Performs all necessary computations for given platform and context
3596 type after each change of scale and origin parameters. Usually called
3597 automatically internally after such changes.
3600 return _gdi_
.DC_ComputeScaleAndOrigin(*args
, **kwargs
)
3602 def SetOptimization(self
, optimize
):
3604 def GetOptimization(self
):
3607 SetOptimization
= wx
._deprecated
(SetOptimization
)
3608 GetOptimization
= wx
._deprecated
(GetOptimization
)
3610 def CalcBoundingBox(*args
, **kwargs
):
3612 CalcBoundingBox(self, int x, int y)
3614 Adds the specified point to the bounding box which can be retrieved
3615 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3617 return _gdi_
.DC_CalcBoundingBox(*args
, **kwargs
)
3619 def CalcBoundingBoxPoint(*args
, **kwargs
):
3621 CalcBoundingBoxPoint(self, Point point)
3623 Adds the specified point to the bounding box which can be retrieved
3624 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3626 return _gdi_
.DC_CalcBoundingBoxPoint(*args
, **kwargs
)
3628 def ResetBoundingBox(*args
, **kwargs
):
3630 ResetBoundingBox(self)
3632 Resets the bounding box: after a call to this function, the bounding
3633 box doesn't contain anything.
3635 return _gdi_
.DC_ResetBoundingBox(*args
, **kwargs
)
3637 def MinX(*args
, **kwargs
):
3641 Gets the minimum horizontal extent used in drawing commands so far.
3643 return _gdi_
.DC_MinX(*args
, **kwargs
)
3645 def MaxX(*args
, **kwargs
):
3649 Gets the maximum horizontal extent used in drawing commands so far.
3651 return _gdi_
.DC_MaxX(*args
, **kwargs
)
3653 def MinY(*args
, **kwargs
):
3657 Gets the minimum vertical extent used in drawing commands so far.
3659 return _gdi_
.DC_MinY(*args
, **kwargs
)
3661 def MaxY(*args
, **kwargs
):
3665 Gets the maximum vertical extent used in drawing commands so far.
3667 return _gdi_
.DC_MaxY(*args
, **kwargs
)
3669 def GetBoundingBox(*args
, **kwargs
):
3671 GetBoundingBox() -> (x1,y1, x2,y2)
3673 Returns the min and max points used in drawing commands so far.
3675 return _gdi_
.DC_GetBoundingBox(*args
, **kwargs
)
3677 def __nonzero__(self
): return self
.Ok()
3678 def _DrawPointList(*args
, **kwargs
):
3679 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3680 return _gdi_
.DC__DrawPointList(*args
, **kwargs
)
3682 def _DrawLineList(*args
, **kwargs
):
3683 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3684 return _gdi_
.DC__DrawLineList(*args
, **kwargs
)
3686 def _DrawRectangleList(*args
, **kwargs
):
3687 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3688 return _gdi_
.DC__DrawRectangleList(*args
, **kwargs
)
3690 def _DrawEllipseList(*args
, **kwargs
):
3691 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3692 return _gdi_
.DC__DrawEllipseList(*args
, **kwargs
)
3694 def _DrawPolygonList(*args
, **kwargs
):
3695 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3696 return _gdi_
.DC__DrawPolygonList(*args
, **kwargs
)
3698 def _DrawTextList(*args
, **kwargs
):
3700 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
3701 PyObject backgroundList) -> PyObject
3703 return _gdi_
.DC__DrawTextList(*args
, **kwargs
)
3705 def DrawPointList(self
, points
, pens
=None):
3707 Draw a list of points as quickly as possible.
3709 :param points: A sequence of 2-element sequences representing
3710 each point to draw, (x,y).
3711 :param pens: If None, then the current pen is used. If a
3712 single pen then it will be used for all points. If
3713 a list of pens then there should be one for each point
3718 elif isinstance(pens
, wx
.Pen
):
3720 elif len(pens
) != len(points
):
3721 raise ValueError('points and pens must have same length')
3722 return self
._DrawPointList
(points
, pens
, [])
3725 def DrawLineList(self
, lines
, pens
=None):
3727 Draw a list of lines as quickly as possible.
3729 :param lines: A sequence of 4-element sequences representing
3730 each line to draw, (x1,y1, x2,y2).
3731 :param pens: If None, then the current pen is used. If a
3732 single pen then it will be used for all lines. If
3733 a list of pens then there should be one for each line
3738 elif isinstance(pens
, wx
.Pen
):
3740 elif len(pens
) != len(lines
):
3741 raise ValueError('lines and pens must have same length')
3742 return self
._DrawLineList
(lines
, pens
, [])
3745 def DrawRectangleList(self
, rectangles
, pens
=None, brushes
=None):
3747 Draw a list of rectangles as quickly as possible.
3749 :param rectangles: A sequence of 4-element sequences representing
3750 each rectangle to draw, (x,y, w,h).
3751 :param pens: If None, then the current pen is used. If a
3752 single pen then it will be used for all rectangles.
3753 If a list of pens then there should be one for each
3754 rectangle in rectangles.
3755 :param brushes: A brush or brushes to be used to fill the rectagles,
3756 with similar semantics as the pens parameter.
3760 elif isinstance(pens
, wx
.Pen
):
3762 elif len(pens
) != len(rectangles
):
3763 raise ValueError('rectangles and pens must have same length')
3766 elif isinstance(brushes
, wx
.Brush
):
3768 elif len(brushes
) != len(rectangles
):
3769 raise ValueError('rectangles and brushes must have same length')
3770 return self
._DrawRectangleList
(rectangles
, pens
, brushes
)
3773 def DrawEllipseList(self
, ellipses
, pens
=None, brushes
=None):
3775 Draw a list of ellipses as quickly as possible.
3777 :param ellipses: A sequence of 4-element sequences representing
3778 each ellipse to draw, (x,y, w,h).
3779 :param pens: If None, then the current pen is used. If a
3780 single pen then it will be used for all ellipses.
3781 If a list of pens then there should be one for each
3782 ellipse in ellipses.
3783 :param brushes: A brush or brushes to be used to fill the ellipses,
3784 with similar semantics as the pens parameter.
3788 elif isinstance(pens
, wx
.Pen
):
3790 elif len(pens
) != len(ellipses
):
3791 raise ValueError('ellipses and pens must have same length')
3794 elif isinstance(brushes
, wx
.Brush
):
3796 elif len(brushes
) != len(ellipses
):
3797 raise ValueError('ellipses and brushes must have same length')
3798 return self
._DrawEllipseList
(ellipses
, pens
, brushes
)
3801 def DrawPolygonList(self
, polygons
, pens
=None, brushes
=None):
3803 Draw a list of polygons, each of which is a list of points.
3805 :param polygons: A sequence of sequences of sequences.
3806 [[(x1,y1),(x2,y2),(x3,y3)...],
3807 [(x1,y1),(x2,y2),(x3,y3)...]]
3809 :param pens: If None, then the current pen is used. If a
3810 single pen then it will be used for all polygons.
3811 If a list of pens then there should be one for each
3813 :param brushes: A brush or brushes to be used to fill the polygons,
3814 with similar semantics as the pens parameter.
3818 elif isinstance(pens
, wx
.Pen
):
3820 elif len(pens
) != len(polygons
):
3821 raise ValueError('polygons and pens must have same length')
3824 elif isinstance(brushes
, wx
.Brush
):
3826 elif len(brushes
) != len(polygons
):
3827 raise ValueError('polygons and brushes must have same length')
3828 return self
._DrawPolygonList
(polygons
, pens
, brushes
)
3831 def DrawTextList(self
, textList
, coords
, foregrounds
= None, backgrounds
= None):
3833 Draw a list of strings using a list of coordinants for positioning each string.
3835 :param textList: A list of strings
3836 :param coords: A list of (x,y) positions
3837 :param foregrounds: A list of `wx.Colour` objects to use for the
3838 foregrounds of the strings.
3839 :param backgrounds: A list of `wx.Colour` objects to use for the
3840 backgrounds of the strings.
3842 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
3843 If you want backgrounds to do anything.
3845 if type(textList
) == type(''):
3846 textList
= [textList
]
3847 elif len(textList
) != len(coords
):
3848 raise ValueError('textlist and coords must have same length')
3849 if foregrounds
is None:
3851 elif isinstance(foregrounds
, wx
.Colour
):
3852 foregrounds
= [foregrounds
]
3853 elif len(foregrounds
) != len(coords
):
3854 raise ValueError('foregrounds and coords must have same length')
3855 if backgrounds
is None:
3857 elif isinstance(backgrounds
, wx
.Colour
):
3858 backgrounds
= [backgrounds
]
3859 elif len(backgrounds
) != len(coords
):
3860 raise ValueError('backgrounds and coords must have same length')
3861 return self
._DrawTextList
(textList
, coords
, foregrounds
, backgrounds
)
3863 DC_swigregister
= _gdi_
.DC_swigregister
3866 #---------------------------------------------------------------------------
3870 A memory device context provides a means to draw graphics onto a
3871 bitmap. A bitmap must be selected into the new memory DC before it may
3872 be used for anything. Typical usage is as follows::
3875 dc.SelectObject(bitmap)
3876 # draw on the dc usign any of the Draw methods
3877 dc.SelectObject(wx.NullBitmap)
3878 # the bitmap now contains wahtever was drawn upon it
3880 Note that the memory DC *must* be deleted (or the bitmap selected out
3881 of it) before a bitmap can be reselected into another memory DC.
3884 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3885 __repr__
= _swig_repr
3886 def __init__(self
, *args
, **kwargs
):
3888 __init__(self) -> MemoryDC
3890 Constructs a new memory device context.
3892 Use the Ok member to test whether the constructor was successful in
3893 creating a usable device context. Don't forget to select a bitmap into
3894 the DC before drawing on it.
3896 _gdi_
.MemoryDC_swiginit(self
,_gdi_
.new_MemoryDC(*args
, **kwargs
))
3897 def SelectObject(*args
, **kwargs
):
3899 SelectObject(self, Bitmap bitmap)
3901 Selects the bitmap into the device context, to use as the memory
3902 bitmap. Selecting the bitmap into a memory DC allows you to draw into
3903 the DC, and therefore the bitmap, and also to use Blit to copy the
3906 If the argument is wx.NullBitmap (or some other uninitialised
3907 `wx.Bitmap`) the current bitmap is selected out of the device context,
3908 and the original bitmap restored, allowing the current bitmap to be
3911 return _gdi_
.MemoryDC_SelectObject(*args
, **kwargs
)
3913 MemoryDC_swigregister
= _gdi_
.MemoryDC_swigregister
3914 MemoryDC_swigregister(MemoryDC
)
3916 def MemoryDCFromDC(*args
, **kwargs
):
3918 MemoryDCFromDC(DC oldDC) -> MemoryDC
3920 Creates a DC that is compatible with the oldDC.
3922 val
= _gdi_
.new_MemoryDCFromDC(*args
, **kwargs
)
3925 #---------------------------------------------------------------------------
3927 BUFFER_VIRTUAL_AREA
= _gdi_
.BUFFER_VIRTUAL_AREA
3928 BUFFER_CLIENT_AREA
= _gdi_
.BUFFER_CLIENT_AREA
3929 class BufferedDC(MemoryDC
):
3931 This simple class provides a simple way to avoid flicker: when drawing
3932 on it, everything is in fact first drawn on an in-memory buffer (a
3933 `wx.Bitmap`) and then copied to the screen only once, when this object
3936 It can be used in the same way as any other device
3937 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
3938 want to use it in your EVT_PAINT handler, you should look at
3939 `wx.BufferedPaintDC`.
3942 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3943 __repr__
= _swig_repr
3944 def __init__(self
, *args
):
3946 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
3947 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
3949 Constructs a buffered DC.
3951 _gdi_
.BufferedDC_swiginit(self
,_gdi_
.new_BufferedDC(*args
))
3952 self
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
3954 __swig_destroy__
= _gdi_
.delete_BufferedDC
3955 __del__
= lambda self
: None;
3956 def UnMask(*args
, **kwargs
):
3960 Blits the buffer to the dc, and detaches the dc from the buffer (so it
3961 can be effectively used once only). This is usually only called in
3964 return _gdi_
.BufferedDC_UnMask(*args
, **kwargs
)
3966 BufferedDC_swigregister
= _gdi_
.BufferedDC_swigregister
3967 BufferedDC_swigregister(BufferedDC
)
3969 class BufferedPaintDC(BufferedDC
):
3971 This is a subclass of `wx.BufferedDC` which can be used inside of an
3972 EVT_PAINT event handler. Just create an object of this class instead
3973 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
3974 flicker. The only thing to watch out for is that if you are using this
3975 class together with `wx.ScrolledWindow`, you probably do **not** want
3976 to call `wx.Window.PrepareDC` on it as it already does this internally
3977 for the real underlying `wx.PaintDC`.
3979 If your window is already fully buffered in a `wx.Bitmap` then your
3980 EVT_PAINT handler can be as simple as just creating a
3981 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
3982 automatically when it is destroyed. For example::
3984 def OnPaint(self, event):
3985 dc = wx.BufferedPaintDC(self, self.buffer)
3992 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3993 __repr__
= _swig_repr
3994 def __init__(self
, *args
, **kwargs
):
3996 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
3998 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
3999 provide the bitmap to be used for buffering or let this object create
4000 one internally (in the latter case, the size of the client part of the
4001 window is automatically used).
4005 _gdi_
.BufferedPaintDC_swiginit(self
,_gdi_
.new_BufferedPaintDC(*args
, **kwargs
))
4006 BufferedPaintDC_swigregister
= _gdi_
.BufferedPaintDC_swigregister
4007 BufferedPaintDC_swigregister(BufferedPaintDC
)
4009 #---------------------------------------------------------------------------
4013 A wxScreenDC can be used to paint anywhere on the screen. This should
4014 normally be constructed as a temporary stack object; don't store a
4018 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4019 __repr__
= _swig_repr
4020 def __init__(self
, *args
, **kwargs
):
4022 __init__(self) -> ScreenDC
4024 A wxScreenDC can be used to paint anywhere on the screen. This should
4025 normally be constructed as a temporary stack object; don't store a
4029 _gdi_
.ScreenDC_swiginit(self
,_gdi_
.new_ScreenDC(*args
, **kwargs
))
4030 def StartDrawingOnTopWin(*args
, **kwargs
):
4032 StartDrawingOnTopWin(self, Window window) -> bool
4034 Specify that the area of the screen to be drawn upon coincides with
4037 :see: `EndDrawingOnTop`
4039 return _gdi_
.ScreenDC_StartDrawingOnTopWin(*args
, **kwargs
)
4041 def StartDrawingOnTop(*args
, **kwargs
):
4043 StartDrawingOnTop(self, Rect rect=None) -> bool
4045 Specify that the area is the given rectangle, or the whole screen if
4048 :see: `EndDrawingOnTop`
4050 return _gdi_
.ScreenDC_StartDrawingOnTop(*args
, **kwargs
)
4052 def EndDrawingOnTop(*args
, **kwargs
):
4054 EndDrawingOnTop(self) -> bool
4056 Use this in conjunction with `StartDrawingOnTop` or
4057 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4058 top of existing windows. Without this, some window systems (such as X)
4059 only allow drawing to take place underneath other windows.
4061 You might use this pair of functions when implementing a drag feature,
4062 for example as in the `wx.SplitterWindow` implementation.
4064 These functions are probably obsolete since the X implementations
4065 allow drawing directly on the screen now. However, the fact that this
4066 function allows the screen to be refreshed afterwards may be useful
4067 to some applications.
4069 return _gdi_
.ScreenDC_EndDrawingOnTop(*args
, **kwargs
)
4071 ScreenDC_swigregister
= _gdi_
.ScreenDC_swigregister
4072 ScreenDC_swigregister(ScreenDC
)
4074 #---------------------------------------------------------------------------
4078 A wx.ClientDC must be constructed if an application wishes to paint on
4079 the client area of a window from outside an EVT_PAINT event. This should
4080 normally be constructed as a temporary stack object; don't store a
4081 wx.ClientDC object long term.
4083 To draw on a window from within an EVT_PAINT handler, construct a
4084 `wx.PaintDC` object.
4086 To draw on the whole window including decorations, construct a
4087 `wx.WindowDC` object (Windows only).
4090 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4091 __repr__
= _swig_repr
4092 def __init__(self
, *args
, **kwargs
):
4094 __init__(self, Window win) -> ClientDC
4096 Constructor. Pass the window on which you wish to paint.
4098 _gdi_
.ClientDC_swiginit(self
,_gdi_
.new_ClientDC(*args
, **kwargs
))
4099 ClientDC_swigregister
= _gdi_
.ClientDC_swigregister
4100 ClientDC_swigregister(ClientDC
)
4102 #---------------------------------------------------------------------------
4106 A wx.PaintDC must be constructed if an application wishes to paint on
4107 the client area of a window from within an EVT_PAINT event
4108 handler. This should normally be constructed as a temporary stack
4109 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4110 handler, you **must** create a wx.PaintDC object within it even if you
4111 don't actually use it.
4113 Using wx.PaintDC within EVT_PAINT handlers is important because it
4114 automatically sets the clipping area to the damaged area of the
4115 window. Attempts to draw outside this area do not appear.
4117 To draw on a window from outside EVT_PAINT handlers, construct a
4118 `wx.ClientDC` object.
4121 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4122 __repr__
= _swig_repr
4123 def __init__(self
, *args
, **kwargs
):
4125 __init__(self, Window win) -> PaintDC
4127 Constructor. Pass the window on which you wish to paint.
4129 _gdi_
.PaintDC_swiginit(self
,_gdi_
.new_PaintDC(*args
, **kwargs
))
4130 PaintDC_swigregister
= _gdi_
.PaintDC_swigregister
4131 PaintDC_swigregister(PaintDC
)
4133 #---------------------------------------------------------------------------
4137 A wx.WindowDC must be constructed if an application wishes to paint on
4138 the whole area of a window (client and decorations). This should
4139 normally be constructed as a temporary stack object; don't store a
4142 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4143 __repr__
= _swig_repr
4144 def __init__(self
, *args
, **kwargs
):
4146 __init__(self, Window win) -> WindowDC
4148 Constructor. Pass the window on which you wish to paint.
4150 _gdi_
.WindowDC_swiginit(self
,_gdi_
.new_WindowDC(*args
, **kwargs
))
4151 WindowDC_swigregister
= _gdi_
.WindowDC_swigregister
4152 WindowDC_swigregister(WindowDC
)
4154 #---------------------------------------------------------------------------
4158 wx.MirrorDC is a simple wrapper class which is always associated with a
4159 real `wx.DC` object and either forwards all of its operations to it
4160 without changes (no mirroring takes place) or exchanges x and y
4161 coordinates which makes it possible to reuse the same code to draw a
4162 figure and its mirror -- i.e. reflection related to the diagonal line
4165 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4166 __repr__
= _swig_repr
4167 def __init__(self
, *args
, **kwargs
):
4169 __init__(self, DC dc, bool mirror) -> MirrorDC
4171 Creates a mirrored DC associated with the real *dc*. Everything drawn
4172 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4175 _gdi_
.MirrorDC_swiginit(self
,_gdi_
.new_MirrorDC(*args
, **kwargs
))
4176 MirrorDC_swigregister
= _gdi_
.MirrorDC_swigregister
4177 MirrorDC_swigregister(MirrorDC
)
4179 #---------------------------------------------------------------------------
4181 class PostScriptDC(DC
):
4182 """This is a `wx.DC` that can write to PostScript files on any platform."""
4183 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4184 __repr__
= _swig_repr
4185 def __init__(self
, *args
, **kwargs
):
4187 __init__(self, wxPrintData printData) -> PostScriptDC
4189 Constructs a PostScript printer device context from a `wx.PrintData`
4192 _gdi_
.PostScriptDC_swiginit(self
,_gdi_
.new_PostScriptDC(*args
, **kwargs
))
4193 def GetPrintData(*args
, **kwargs
):
4194 """GetPrintData(self) -> wxPrintData"""
4195 return _gdi_
.PostScriptDC_GetPrintData(*args
, **kwargs
)
4197 def SetPrintData(*args
, **kwargs
):
4198 """SetPrintData(self, wxPrintData data)"""
4199 return _gdi_
.PostScriptDC_SetPrintData(*args
, **kwargs
)
4201 def SetResolution(*args
, **kwargs
):
4203 SetResolution(int ppi)
4205 Set resolution (in pixels per inch) that will be used in PostScript
4206 output. Default is 720ppi.
4208 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4210 SetResolution
= staticmethod(SetResolution
)
4211 def GetResolution(*args
, **kwargs
):
4213 GetResolution() -> int
4215 Return resolution used in PostScript output.
4217 return _gdi_
.PostScriptDC_GetResolution(*args
, **kwargs
)
4219 GetResolution
= staticmethod(GetResolution
)
4220 PostScriptDC_swigregister
= _gdi_
.PostScriptDC_swigregister
4221 PostScriptDC_swigregister(PostScriptDC
)
4223 def PostScriptDC_SetResolution(*args
, **kwargs
):
4225 PostScriptDC_SetResolution(int ppi)
4227 Set resolution (in pixels per inch) that will be used in PostScript
4228 output. Default is 720ppi.
4230 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4232 def PostScriptDC_GetResolution(*args
):
4234 PostScriptDC_GetResolution() -> int
4236 Return resolution used in PostScript output.
4238 return _gdi_
.PostScriptDC_GetResolution(*args
)
4240 #---------------------------------------------------------------------------
4242 class MetaFile(_core
.Object
):
4243 """Proxy of C++ MetaFile class"""
4244 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4245 __repr__
= _swig_repr
4246 def __init__(self
, *args
, **kwargs
):
4247 """__init__(self, String filename=EmptyString) -> MetaFile"""
4248 _gdi_
.MetaFile_swiginit(self
,_gdi_
.new_MetaFile(*args
, **kwargs
))
4249 __swig_destroy__
= _gdi_
.delete_MetaFile
4250 __del__
= lambda self
: None;
4251 def Ok(*args
, **kwargs
):
4252 """Ok(self) -> bool"""
4253 return _gdi_
.MetaFile_Ok(*args
, **kwargs
)
4255 def SetClipboard(*args
, **kwargs
):
4256 """SetClipboard(self, int width=0, int height=0) -> bool"""
4257 return _gdi_
.MetaFile_SetClipboard(*args
, **kwargs
)
4259 def GetSize(*args
, **kwargs
):
4260 """GetSize(self) -> Size"""
4261 return _gdi_
.MetaFile_GetSize(*args
, **kwargs
)
4263 def GetWidth(*args
, **kwargs
):
4264 """GetWidth(self) -> int"""
4265 return _gdi_
.MetaFile_GetWidth(*args
, **kwargs
)
4267 def GetHeight(*args
, **kwargs
):
4268 """GetHeight(self) -> int"""
4269 return _gdi_
.MetaFile_GetHeight(*args
, **kwargs
)
4271 def __nonzero__(self
): return self
.Ok()
4272 MetaFile_swigregister
= _gdi_
.MetaFile_swigregister
4273 MetaFile_swigregister(MetaFile
)
4275 class MetaFileDC(DC
):
4276 """Proxy of C++ MetaFileDC class"""
4277 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4278 __repr__
= _swig_repr
4279 def __init__(self
, *args
, **kwargs
):
4281 __init__(self, String filename=EmptyString, int width=0, int height=0,
4282 String description=EmptyString) -> MetaFileDC
4284 _gdi_
.MetaFileDC_swiginit(self
,_gdi_
.new_MetaFileDC(*args
, **kwargs
))
4285 def Close(*args
, **kwargs
):
4286 """Close(self) -> MetaFile"""
4287 return _gdi_
.MetaFileDC_Close(*args
, **kwargs
)
4289 MetaFileDC_swigregister
= _gdi_
.MetaFileDC_swigregister
4290 MetaFileDC_swigregister(MetaFileDC
)
4292 class PrinterDC(DC
):
4293 """Proxy of C++ PrinterDC class"""
4294 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4295 __repr__
= _swig_repr
4296 def __init__(self
, *args
, **kwargs
):
4297 """__init__(self, wxPrintData printData) -> PrinterDC"""
4298 _gdi_
.PrinterDC_swiginit(self
,_gdi_
.new_PrinterDC(*args
, **kwargs
))
4299 PrinterDC_swigregister
= _gdi_
.PrinterDC_swigregister
4300 PrinterDC_swigregister(PrinterDC
)
4302 #---------------------------------------------------------------------------
4304 IMAGELIST_DRAW_NORMAL
= _gdi_
.IMAGELIST_DRAW_NORMAL
4305 IMAGELIST_DRAW_TRANSPARENT
= _gdi_
.IMAGELIST_DRAW_TRANSPARENT
4306 IMAGELIST_DRAW_SELECTED
= _gdi_
.IMAGELIST_DRAW_SELECTED
4307 IMAGELIST_DRAW_FOCUSED
= _gdi_
.IMAGELIST_DRAW_FOCUSED
4308 IMAGE_LIST_NORMAL
= _gdi_
.IMAGE_LIST_NORMAL
4309 IMAGE_LIST_SMALL
= _gdi_
.IMAGE_LIST_SMALL
4310 IMAGE_LIST_STATE
= _gdi_
.IMAGE_LIST_STATE
4311 class ImageList(_core
.Object
):
4312 """Proxy of C++ ImageList class"""
4313 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4314 __repr__
= _swig_repr
4315 def __init__(self
, *args
, **kwargs
):
4316 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
4317 _gdi_
.ImageList_swiginit(self
,_gdi_
.new_ImageList(*args
, **kwargs
))
4318 __swig_destroy__
= _gdi_
.delete_ImageList
4319 __del__
= lambda self
: None;
4320 def Add(*args
, **kwargs
):
4321 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
4322 return _gdi_
.ImageList_Add(*args
, **kwargs
)
4324 def AddWithColourMask(*args
, **kwargs
):
4325 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
4326 return _gdi_
.ImageList_AddWithColourMask(*args
, **kwargs
)
4328 def AddIcon(*args
, **kwargs
):
4329 """AddIcon(self, Icon icon) -> int"""
4330 return _gdi_
.ImageList_AddIcon(*args
, **kwargs
)
4332 def GetBitmap(*args
, **kwargs
):
4333 """GetBitmap(self, int index) -> Bitmap"""
4334 return _gdi_
.ImageList_GetBitmap(*args
, **kwargs
)
4336 def GetIcon(*args
, **kwargs
):
4337 """GetIcon(self, int index) -> Icon"""
4338 return _gdi_
.ImageList_GetIcon(*args
, **kwargs
)
4340 def Replace(*args
, **kwargs
):
4341 """Replace(self, int index, Bitmap bitmap) -> bool"""
4342 return _gdi_
.ImageList_Replace(*args
, **kwargs
)
4344 def Draw(*args
, **kwargs
):
4346 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
4347 bool solidBackground=False) -> bool
4349 return _gdi_
.ImageList_Draw(*args
, **kwargs
)
4351 def GetImageCount(*args
, **kwargs
):
4352 """GetImageCount(self) -> int"""
4353 return _gdi_
.ImageList_GetImageCount(*args
, **kwargs
)
4355 def Remove(*args
, **kwargs
):
4356 """Remove(self, int index) -> bool"""
4357 return _gdi_
.ImageList_Remove(*args
, **kwargs
)
4359 def RemoveAll(*args
, **kwargs
):
4360 """RemoveAll(self) -> bool"""
4361 return _gdi_
.ImageList_RemoveAll(*args
, **kwargs
)
4363 def GetSize(*args
, **kwargs
):
4364 """GetSize() -> (width,height)"""
4365 return _gdi_
.ImageList_GetSize(*args
, **kwargs
)
4367 ImageList_swigregister
= _gdi_
.ImageList_swigregister
4368 ImageList_swigregister(ImageList
)
4370 #---------------------------------------------------------------------------
4372 class PenList(_core
.Object
):
4373 """Proxy of C++ PenList class"""
4374 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4375 def __init__(self
): raise AttributeError, "No constructor defined"
4376 __repr__
= _swig_repr
4377 def AddPen(*args
, **kwargs
):
4378 """AddPen(self, Pen pen)"""
4379 return _gdi_
.PenList_AddPen(*args
, **kwargs
)
4381 def FindOrCreatePen(*args
, **kwargs
):
4382 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
4383 return _gdi_
.PenList_FindOrCreatePen(*args
, **kwargs
)
4385 def RemovePen(*args
, **kwargs
):
4386 """RemovePen(self, Pen pen)"""
4387 return _gdi_
.PenList_RemovePen(*args
, **kwargs
)
4389 def GetCount(*args
, **kwargs
):
4390 """GetCount(self) -> int"""
4391 return _gdi_
.PenList_GetCount(*args
, **kwargs
)
4393 PenList_swigregister
= _gdi_
.PenList_swigregister
4394 PenList_swigregister(PenList
)
4396 NORMAL_FONT
= cvar
.NORMAL_FONT
4397 SMALL_FONT
= cvar
.SMALL_FONT
4398 ITALIC_FONT
= cvar
.ITALIC_FONT
4399 SWISS_FONT
= cvar
.SWISS_FONT
4400 RED_PEN
= cvar
.RED_PEN
4401 CYAN_PEN
= cvar
.CYAN_PEN
4402 GREEN_PEN
= cvar
.GREEN_PEN
4403 BLACK_PEN
= cvar
.BLACK_PEN
4404 WHITE_PEN
= cvar
.WHITE_PEN
4405 TRANSPARENT_PEN
= cvar
.TRANSPARENT_PEN
4406 BLACK_DASHED_PEN
= cvar
.BLACK_DASHED_PEN
4407 GREY_PEN
= cvar
.GREY_PEN
4408 MEDIUM_GREY_PEN
= cvar
.MEDIUM_GREY_PEN
4409 LIGHT_GREY_PEN
= cvar
.LIGHT_GREY_PEN
4410 BLUE_BRUSH
= cvar
.BLUE_BRUSH
4411 GREEN_BRUSH
= cvar
.GREEN_BRUSH
4412 WHITE_BRUSH
= cvar
.WHITE_BRUSH
4413 BLACK_BRUSH
= cvar
.BLACK_BRUSH
4414 TRANSPARENT_BRUSH
= cvar
.TRANSPARENT_BRUSH
4415 CYAN_BRUSH
= cvar
.CYAN_BRUSH
4416 RED_BRUSH
= cvar
.RED_BRUSH
4417 GREY_BRUSH
= cvar
.GREY_BRUSH
4418 MEDIUM_GREY_BRUSH
= cvar
.MEDIUM_GREY_BRUSH
4419 LIGHT_GREY_BRUSH
= cvar
.LIGHT_GREY_BRUSH
4426 LIGHT_GREY
= cvar
.LIGHT_GREY
4427 STANDARD_CURSOR
= cvar
.STANDARD_CURSOR
4428 HOURGLASS_CURSOR
= cvar
.HOURGLASS_CURSOR
4429 CROSS_CURSOR
= cvar
.CROSS_CURSOR
4430 NullBitmap
= cvar
.NullBitmap
4431 NullIcon
= cvar
.NullIcon
4432 NullCursor
= cvar
.NullCursor
4433 NullPen
= cvar
.NullPen
4434 NullBrush
= cvar
.NullBrush
4435 NullPalette
= cvar
.NullPalette
4436 NullFont
= cvar
.NullFont
4437 NullColour
= cvar
.NullColour
4439 class BrushList(_core
.Object
):
4440 """Proxy of C++ BrushList class"""
4441 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4442 def __init__(self
): raise AttributeError, "No constructor defined"
4443 __repr__
= _swig_repr
4444 def AddBrush(*args
, **kwargs
):
4445 """AddBrush(self, Brush brush)"""
4446 return _gdi_
.BrushList_AddBrush(*args
, **kwargs
)
4448 def FindOrCreateBrush(*args
, **kwargs
):
4449 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
4450 return _gdi_
.BrushList_FindOrCreateBrush(*args
, **kwargs
)
4452 def RemoveBrush(*args
, **kwargs
):
4453 """RemoveBrush(self, Brush brush)"""
4454 return _gdi_
.BrushList_RemoveBrush(*args
, **kwargs
)
4456 def GetCount(*args
, **kwargs
):
4457 """GetCount(self) -> int"""
4458 return _gdi_
.BrushList_GetCount(*args
, **kwargs
)
4460 BrushList_swigregister
= _gdi_
.BrushList_swigregister
4461 BrushList_swigregister(BrushList
)
4463 class ColourDatabase(_core
.Object
):
4464 """Proxy of C++ ColourDatabase class"""
4465 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4466 __repr__
= _swig_repr
4467 def __init__(self
, *args
, **kwargs
):
4468 """__init__(self) -> ColourDatabase"""
4469 _gdi_
.ColourDatabase_swiginit(self
,_gdi_
.new_ColourDatabase(*args
, **kwargs
))
4470 __swig_destroy__
= _gdi_
.delete_ColourDatabase
4471 __del__
= lambda self
: None;
4472 def Find(*args
, **kwargs
):
4473 """Find(self, String name) -> Colour"""
4474 return _gdi_
.ColourDatabase_Find(*args
, **kwargs
)
4476 def FindName(*args
, **kwargs
):
4477 """FindName(self, Colour colour) -> String"""
4478 return _gdi_
.ColourDatabase_FindName(*args
, **kwargs
)
4481 def AddColour(*args
, **kwargs
):
4482 """AddColour(self, String name, Colour colour)"""
4483 return _gdi_
.ColourDatabase_AddColour(*args
, **kwargs
)
4485 def Append(*args
, **kwargs
):
4486 """Append(self, String name, int red, int green, int blue)"""
4487 return _gdi_
.ColourDatabase_Append(*args
, **kwargs
)
4489 ColourDatabase_swigregister
= _gdi_
.ColourDatabase_swigregister
4490 ColourDatabase_swigregister(ColourDatabase
)
4492 class FontList(_core
.Object
):
4493 """Proxy of C++ FontList class"""
4494 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4495 def __init__(self
): raise AttributeError, "No constructor defined"
4496 __repr__
= _swig_repr
4497 def AddFont(*args
, **kwargs
):
4498 """AddFont(self, Font font)"""
4499 return _gdi_
.FontList_AddFont(*args
, **kwargs
)
4501 def FindOrCreateFont(*args
, **kwargs
):
4503 FindOrCreateFont(self, int point_size, int family, int style, int weight,
4504 bool underline=False, String facename=EmptyString,
4505 int encoding=FONTENCODING_DEFAULT) -> Font
4507 return _gdi_
.FontList_FindOrCreateFont(*args
, **kwargs
)
4509 def RemoveFont(*args
, **kwargs
):
4510 """RemoveFont(self, Font font)"""
4511 return _gdi_
.FontList_RemoveFont(*args
, **kwargs
)
4513 def GetCount(*args
, **kwargs
):
4514 """GetCount(self) -> int"""
4515 return _gdi_
.FontList_GetCount(*args
, **kwargs
)
4517 FontList_swigregister
= _gdi_
.FontList_swigregister
4518 FontList_swigregister(FontList
)
4520 #---------------------------------------------------------------------------
4522 NullColor
= NullColour
4523 #---------------------------------------------------------------------------
4525 class Effects(_core
.Object
):
4526 """Proxy of C++ Effects class"""
4527 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4528 __repr__
= _swig_repr
4529 def __init__(self
, *args
, **kwargs
):
4530 """__init__(self) -> Effects"""
4531 _gdi_
.Effects_swiginit(self
,_gdi_
.new_Effects(*args
, **kwargs
))
4532 def GetHighlightColour(*args
, **kwargs
):
4533 """GetHighlightColour(self) -> Colour"""
4534 return _gdi_
.Effects_GetHighlightColour(*args
, **kwargs
)
4536 def GetLightShadow(*args
, **kwargs
):
4537 """GetLightShadow(self) -> Colour"""
4538 return _gdi_
.Effects_GetLightShadow(*args
, **kwargs
)
4540 def GetFaceColour(*args
, **kwargs
):
4541 """GetFaceColour(self) -> Colour"""
4542 return _gdi_
.Effects_GetFaceColour(*args
, **kwargs
)
4544 def GetMediumShadow(*args
, **kwargs
):
4545 """GetMediumShadow(self) -> Colour"""
4546 return _gdi_
.Effects_GetMediumShadow(*args
, **kwargs
)
4548 def GetDarkShadow(*args
, **kwargs
):
4549 """GetDarkShadow(self) -> Colour"""
4550 return _gdi_
.Effects_GetDarkShadow(*args
, **kwargs
)
4552 def SetHighlightColour(*args
, **kwargs
):
4553 """SetHighlightColour(self, Colour c)"""
4554 return _gdi_
.Effects_SetHighlightColour(*args
, **kwargs
)
4556 def SetLightShadow(*args
, **kwargs
):
4557 """SetLightShadow(self, Colour c)"""
4558 return _gdi_
.Effects_SetLightShadow(*args
, **kwargs
)
4560 def SetFaceColour(*args
, **kwargs
):
4561 """SetFaceColour(self, Colour c)"""
4562 return _gdi_
.Effects_SetFaceColour(*args
, **kwargs
)
4564 def SetMediumShadow(*args
, **kwargs
):
4565 """SetMediumShadow(self, Colour c)"""
4566 return _gdi_
.Effects_SetMediumShadow(*args
, **kwargs
)
4568 def SetDarkShadow(*args
, **kwargs
):
4569 """SetDarkShadow(self, Colour c)"""
4570 return _gdi_
.Effects_SetDarkShadow(*args
, **kwargs
)
4572 def Set(*args
, **kwargs
):
4574 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
4575 Colour mediumShadow, Colour darkShadow)
4577 return _gdi_
.Effects_Set(*args
, **kwargs
)
4579 def DrawSunkenEdge(*args
, **kwargs
):
4580 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
4581 return _gdi_
.Effects_DrawSunkenEdge(*args
, **kwargs
)
4583 def TileBitmap(*args
, **kwargs
):
4584 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
4585 return _gdi_
.Effects_TileBitmap(*args
, **kwargs
)
4587 Effects_swigregister
= _gdi_
.Effects_swigregister
4588 Effects_swigregister(Effects
)
4589 TheFontList
= cvar
.TheFontList
4590 ThePenList
= cvar
.ThePenList
4591 TheBrushList
= cvar
.TheBrushList
4592 TheColourDatabase
= cvar
.TheColourDatabase
4594 #---------------------------------------------------------------------------
4596 CONTROL_DISABLED
= _gdi_
.CONTROL_DISABLED
4597 CONTROL_FOCUSED
= _gdi_
.CONTROL_FOCUSED
4598 CONTROL_PRESSED
= _gdi_
.CONTROL_PRESSED
4599 CONTROL_ISDEFAULT
= _gdi_
.CONTROL_ISDEFAULT
4600 CONTROL_ISSUBMENU
= _gdi_
.CONTROL_ISSUBMENU
4601 CONTROL_EXPANDED
= _gdi_
.CONTROL_EXPANDED
4602 CONTROL_CURRENT
= _gdi_
.CONTROL_CURRENT
4603 CONTROL_SELECTED
= _gdi_
.CONTROL_SELECTED
4604 CONTROL_CHECKED
= _gdi_
.CONTROL_CHECKED
4605 CONTROL_CHECKABLE
= _gdi_
.CONTROL_CHECKABLE
4606 CONTROL_UNDETERMINED
= _gdi_
.CONTROL_UNDETERMINED
4607 CONTROL_FLAGS_MASK
= _gdi_
.CONTROL_FLAGS_MASK
4608 CONTROL_DIRTY
= _gdi_
.CONTROL_DIRTY
4609 class SplitterRenderParams(object):
4611 This is just a simple struct used as a return value of
4612 `wx.RendererNative.GetSplitterParams` and contains some platform
4613 specific metrics about splitters.
4615 * widthSash: the width of the splitter sash.
4616 * border: the width of the border of the splitter window.
4617 * isHotSensitive: ``True`` if the splitter changes its
4618 appearance when the mouse is over it.
4622 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4623 __repr__
= _swig_repr
4624 def __init__(self
, *args
, **kwargs
):
4626 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
4628 This is just a simple struct used as a return value of
4629 `wx.RendererNative.GetSplitterParams` and contains some platform
4630 specific metrics about splitters.
4632 * widthSash: the width of the splitter sash.
4633 * border: the width of the border of the splitter window.
4634 * isHotSensitive: ``True`` if the splitter changes its
4635 appearance when the mouse is over it.
4639 _gdi_
.SplitterRenderParams_swiginit(self
,_gdi_
.new_SplitterRenderParams(*args
, **kwargs
))
4640 __swig_destroy__
= _gdi_
.delete_SplitterRenderParams
4641 __del__
= lambda self
: None;
4642 widthSash
= property(_gdi_
.SplitterRenderParams_widthSash_get
)
4643 border
= property(_gdi_
.SplitterRenderParams_border_get
)
4644 isHotSensitive
= property(_gdi_
.SplitterRenderParams_isHotSensitive_get
)
4645 SplitterRenderParams_swigregister
= _gdi_
.SplitterRenderParams_swigregister
4646 SplitterRenderParams_swigregister(SplitterRenderParams
)
4648 class RendererVersion(object):
4650 This simple struct represents the `wx.RendererNative` interface
4651 version and is only used as the return value of
4652 `wx.RendererNative.GetVersion`.
4654 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4655 __repr__
= _swig_repr
4656 def __init__(self
, *args
, **kwargs
):
4658 __init__(self, int version_, int age_) -> RendererVersion
4660 This simple struct represents the `wx.RendererNative` interface
4661 version and is only used as the return value of
4662 `wx.RendererNative.GetVersion`.
4664 _gdi_
.RendererVersion_swiginit(self
,_gdi_
.new_RendererVersion(*args
, **kwargs
))
4665 __swig_destroy__
= _gdi_
.delete_RendererVersion
4666 __del__
= lambda self
: None;
4667 Current_Version
= _gdi_
.RendererVersion_Current_Version
4668 Current_Age
= _gdi_
.RendererVersion_Current_Age
4669 def IsCompatible(*args
, **kwargs
):
4670 """IsCompatible(RendererVersion ver) -> bool"""
4671 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
4673 IsCompatible
= staticmethod(IsCompatible
)
4674 version
= property(_gdi_
.RendererVersion_version_get
)
4675 age
= property(_gdi_
.RendererVersion_age_get
)
4676 RendererVersion_swigregister
= _gdi_
.RendererVersion_swigregister
4677 RendererVersion_swigregister(RendererVersion
)
4679 def RendererVersion_IsCompatible(*args
, **kwargs
):
4680 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
4681 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
4683 class RendererNative(object):
4685 One of the design principles of wxWidgets is to use the native widgets
4686 on every platform in order to be as close to the native look and feel
4687 on every platform. However there are still cases when some generic
4688 widgets are needed for various reasons, but it can sometimes take a
4689 lot of messy work to make them conform to the native LnF.
4691 The wx.RendererNative class is a collection of functions that have
4692 platform-specific implementations for drawing certain parts of
4693 genereic controls in ways that are as close to the native look as
4697 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4698 def __init__(self
): raise AttributeError, "No constructor defined"
4699 __repr__
= _swig_repr
4700 def DrawHeaderButton(*args
, **kwargs
):
4702 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0)
4704 Draw the header control button (such as what is used by `wx.ListCtrl`
4707 return _gdi_
.RendererNative_DrawHeaderButton(*args
, **kwargs
)
4709 def DrawTreeItemButton(*args
, **kwargs
):
4711 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
4713 Draw the expanded/collapsed icon for a tree control item.
4715 return _gdi_
.RendererNative_DrawTreeItemButton(*args
, **kwargs
)
4717 def DrawSplitterBorder(*args
, **kwargs
):
4719 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
4721 Draw the border for a sash window: this border must be such that the
4722 sash drawn by `DrawSplitterSash` blends into it well.
4724 return _gdi_
.RendererNative_DrawSplitterBorder(*args
, **kwargs
)
4726 def DrawSplitterSash(*args
, **kwargs
):
4728 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
4731 Draw a sash. The orient parameter defines whether the sash should be
4732 vertical or horizontal and how the position should be interpreted.
4734 return _gdi_
.RendererNative_DrawSplitterSash(*args
, **kwargs
)
4736 def DrawComboBoxDropButton(*args
, **kwargs
):
4738 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
4740 Draw a button like the one used by `wx.ComboBox` to show a drop down
4741 window. The usual appearance is a downwards pointing arrow.
4743 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
4744 ``wx.CONTROL_CURRENT`` bits set.
4746 return _gdi_
.RendererNative_DrawComboBoxDropButton(*args
, **kwargs
)
4748 def DrawDropArrow(*args
, **kwargs
):
4750 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
4752 Draw a drop down arrow that is suitable for use outside a combo
4753 box. Arrow will have a transparent background.
4755 ``rect`` is not entirely filled by the arrow. Instead, you should use
4756 bounding rectangle of a drop down button which arrow matches the size
4757 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
4758 ``wx.CONTROL_CURRENT`` bit set.
4760 return _gdi_
.RendererNative_DrawDropArrow(*args
, **kwargs
)
4762 def GetSplitterParams(*args
, **kwargs
):
4764 GetSplitterParams(self, Window win) -> SplitterRenderParams
4766 Get the splitter parameters, see `wx.SplitterRenderParams`.
4768 return _gdi_
.RendererNative_GetSplitterParams(*args
, **kwargs
)
4770 def Get(*args
, **kwargs
):
4772 Get() -> RendererNative
4774 Return the currently used renderer
4776 return _gdi_
.RendererNative_Get(*args
, **kwargs
)
4778 Get
= staticmethod(Get
)
4779 def GetGeneric(*args
, **kwargs
):
4781 GetGeneric() -> RendererNative
4783 Return the generic implementation of the renderer. Under some
4784 platforms, this is the default renderer implementation, others have
4785 platform-specific default renderer which can be retrieved by calling
4788 return _gdi_
.RendererNative_GetGeneric(*args
, **kwargs
)
4790 GetGeneric
= staticmethod(GetGeneric
)
4791 def GetDefault(*args
, **kwargs
):
4793 GetDefault() -> RendererNative
4795 Return the default (native) implementation for this platform -- this
4796 is also the one used by default but this may be changed by calling `Set`
4797 in which case the return value of this method may be different from
4798 the return value of `Get`.
4800 return _gdi_
.RendererNative_GetDefault(*args
, **kwargs
)
4802 GetDefault
= staticmethod(GetDefault
)
4803 def Set(*args
, **kwargs
):
4805 Set(RendererNative renderer) -> RendererNative
4807 Set the renderer to use, passing None reverts to using the default
4808 renderer. Returns the previous renderer used with Set or None.
4810 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
4812 Set
= staticmethod(Set
)
4813 def GetVersion(*args
, **kwargs
):
4815 GetVersion(self) -> RendererVersion
4817 Returns the version of the renderer. Will be used for ensuring
4818 compatibility of dynamically loaded renderers.
4820 return _gdi_
.RendererNative_GetVersion(*args
, **kwargs
)
4822 RendererNative_swigregister
= _gdi_
.RendererNative_swigregister
4823 RendererNative_swigregister(RendererNative
)
4825 def RendererNative_Get(*args
):
4827 RendererNative_Get() -> RendererNative
4829 Return the currently used renderer
4831 return _gdi_
.RendererNative_Get(*args
)
4833 def RendererNative_GetGeneric(*args
):
4835 RendererNative_GetGeneric() -> RendererNative
4837 Return the generic implementation of the renderer. Under some
4838 platforms, this is the default renderer implementation, others have
4839 platform-specific default renderer which can be retrieved by calling
4842 return _gdi_
.RendererNative_GetGeneric(*args
)
4844 def RendererNative_GetDefault(*args
):
4846 RendererNative_GetDefault() -> RendererNative
4848 Return the default (native) implementation for this platform -- this
4849 is also the one used by default but this may be changed by calling `Set`
4850 in which case the return value of this method may be different from
4851 the return value of `Get`.
4853 return _gdi_
.RendererNative_GetDefault(*args
)
4855 def RendererNative_Set(*args
, **kwargs
):
4857 RendererNative_Set(RendererNative renderer) -> RendererNative
4859 Set the renderer to use, passing None reverts to using the default
4860 renderer. Returns the previous renderer used with Set or None.
4862 return _gdi_
.RendererNative_Set(*args
, **kwargs
)