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 IsNull(*args
, **kwargs
):
68 """IsNull(self) -> bool"""
69 return _gdi_
.GDIObject_IsNull(*args
, **kwargs
)
71 _gdi_
.GDIObject_swigregister(GDIObject
)
73 #---------------------------------------------------------------------------
75 C2S_NAME
= _gdi_
.C2S_NAME
76 C2S_CSS_SYNTAX
= _gdi_
.C2S_CSS_SYNTAX
77 C2S_HTML_SYNTAX
= _gdi_
.C2S_HTML_SYNTAX
78 class Colour(_core
.Object
):
80 A colour is an object representing a combination of Red, Green, and
81 Blue (RGB) intensity values, and is used to determine drawing colours,
82 window colours, etc. Valid RGB values are in the range 0 to 255.
84 In wxPython there are typemaps that will automatically convert from a
85 colour name, from a '#RRGGBB' colour hex value string, or from a 3
86 integer tuple to a wx.Colour object when calling C++ methods that
87 expect a wxColour. This means that the following are all
90 win.SetBackgroundColour(wxColour(0,0,255))
91 win.SetBackgroundColour('BLUE')
92 win.SetBackgroundColour('#0000FF')
93 win.SetBackgroundColour((0,0,255))
95 Additional colour names and their coresponding values can be added
96 using `wx.ColourDatabase`. Various system colours (as set in the
97 user's system preferences) can be retrieved with
98 `wx.SystemSettings.GetColour`.
101 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
102 __repr__
= _swig_repr
103 def __init__(self
, *args
, **kwargs
):
105 __init__(self, byte red=0, byte green=0, byte blue=0) -> Colour
107 Constructs a colour from red, green and blue values.
109 :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
112 _gdi_
.Colour_swiginit(self
,_gdi_
.new_Colour(*args
, **kwargs
))
113 __swig_destroy__
= _gdi_
.delete_Colour
114 __del__
= lambda self
: None;
115 def Red(*args
, **kwargs
):
119 Returns the red intensity.
121 return _gdi_
.Colour_Red(*args
, **kwargs
)
123 def Green(*args
, **kwargs
):
127 Returns the green intensity.
129 return _gdi_
.Colour_Green(*args
, **kwargs
)
131 def Blue(*args
, **kwargs
):
135 Returns the blue intensity.
137 return _gdi_
.Colour_Blue(*args
, **kwargs
)
139 def Ok(*args
, **kwargs
):
143 Returns True if the colour object is valid (the colour has been
144 initialised with RGB values).
146 return _gdi_
.Colour_Ok(*args
, **kwargs
)
148 def Set(*args
, **kwargs
):
150 Set(self, byte red, byte green, byte blue)
152 Sets the RGB intensity values.
154 return _gdi_
.Colour_Set(*args
, **kwargs
)
156 def SetRGB(*args
, **kwargs
):
158 SetRGB(self, unsigned long colRGB)
160 Sets the RGB intensity values from a packed RGB value.
162 return _gdi_
.Colour_SetRGB(*args
, **kwargs
)
164 def SetFromName(*args
, **kwargs
):
166 SetFromName(self, String colourName)
168 Sets the RGB intensity values using a colour name listed in
169 ``wx.TheColourDatabase``.
171 return _gdi_
.Colour_SetFromName(*args
, **kwargs
)
173 def GetAsString(*args
, **kwargs
):
175 GetAsString(self, long flags=wxC2S_NAME|wxC2S_CSS_SYNTAX) -> String
177 Return the colour as a string. Acceptable flags are:
179 =================== ==================================
180 wx.C2S_NAME return colour name, when possible
181 wx.C2S_CSS_SYNTAX return colour in rgb(r,g,b) syntax
182 wx.C2S_HTML_SYNTAX return colour in #rrggbb syntax
183 =================== ==================================
185 return _gdi_
.Colour_GetAsString(*args
, **kwargs
)
187 def GetPixel(*args
, **kwargs
):
189 GetPixel(self) -> long
191 Returns a pixel value which is platform-dependent. On Windows, a
192 COLORREF is returned. On X, an allocated pixel value is returned. -1
193 is returned if the pixel is invalid (on X, unallocated).
195 return _gdi_
.Colour_GetPixel(*args
, **kwargs
)
197 def __eq__(*args
, **kwargs
):
199 __eq__(self, PyObject other) -> bool
201 Compare colours for equality.
203 return _gdi_
.Colour___eq__(*args
, **kwargs
)
205 def __ne__(*args
, **kwargs
):
207 __ne__(self, PyObject other) -> bool
209 Compare colours for inequality.
211 return _gdi_
.Colour___ne__(*args
, **kwargs
)
213 def Get(*args
, **kwargs
):
217 Returns the RGB intensity values as a tuple.
219 return _gdi_
.Colour_Get(*args
, **kwargs
)
221 def GetRGB(*args
, **kwargs
):
223 GetRGB(self) -> unsigned long
225 Return the colour as a packed RGB value
227 return _gdi_
.Colour_GetRGB(*args
, **kwargs
)
229 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
230 def __str__(self
): return str(self
.Get())
231 def __repr__(self
): return 'wx.Colour' + str(self
.Get())
232 def __nonzero__(self
): return self
.Ok()
233 __safe_for_unpickling__
= True
234 def __reduce__(self
): return (Colour
, self
.Get())
236 _gdi_
.Colour_swigregister(Colour
)
238 def NamedColour(*args
, **kwargs
):
240 NamedColour(String colorName) -> Colour
242 Constructs a colour object using a colour name listed in
243 ``wx.TheColourDatabase``.
245 val
= _gdi_
.new_NamedColour(*args
, **kwargs
)
248 def ColourRGB(*args
, **kwargs
):
250 ColourRGB(unsigned long colRGB) -> Colour
252 Constructs a colour from a packed RGB value.
254 val
= _gdi_
.new_ColourRGB(*args
, **kwargs
)
258 NamedColor
= NamedColour
261 class Palette(GDIObject
):
262 """Proxy of C++ Palette class"""
263 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
264 __repr__
= _swig_repr
265 def __init__(self
, *args
, **kwargs
):
266 """__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette"""
267 _gdi_
.Palette_swiginit(self
,_gdi_
.new_Palette(*args
, **kwargs
))
268 __swig_destroy__
= _gdi_
.delete_Palette
269 __del__
= lambda self
: None;
270 def GetPixel(*args
, **kwargs
):
271 """GetPixel(self, byte red, byte green, byte blue) -> int"""
272 return _gdi_
.Palette_GetPixel(*args
, **kwargs
)
274 def GetRGB(*args
, **kwargs
):
275 """GetRGB(self, int pixel) -> (R,G,B)"""
276 return _gdi_
.Palette_GetRGB(*args
, **kwargs
)
278 def GetColoursCount(*args
, **kwargs
):
279 """GetColoursCount(self) -> int"""
280 return _gdi_
.Palette_GetColoursCount(*args
, **kwargs
)
282 def Ok(*args
, **kwargs
):
283 """Ok(self) -> bool"""
284 return _gdi_
.Palette_Ok(*args
, **kwargs
)
286 def __nonzero__(self
): return self
.Ok()
287 _gdi_
.Palette_swigregister(Palette
)
289 #---------------------------------------------------------------------------
291 class Pen(GDIObject
):
292 """Proxy of C++ Pen class"""
293 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
294 __repr__
= _swig_repr
295 def __init__(self
, *args
, **kwargs
):
296 """__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen"""
297 _gdi_
.Pen_swiginit(self
,_gdi_
.new_Pen(*args
, **kwargs
))
298 __swig_destroy__
= _gdi_
.delete_Pen
299 __del__
= lambda self
: None;
300 def GetCap(*args
, **kwargs
):
301 """GetCap(self) -> int"""
302 return _gdi_
.Pen_GetCap(*args
, **kwargs
)
304 def GetColour(*args
, **kwargs
):
305 """GetColour(self) -> Colour"""
306 return _gdi_
.Pen_GetColour(*args
, **kwargs
)
308 def GetJoin(*args
, **kwargs
):
309 """GetJoin(self) -> int"""
310 return _gdi_
.Pen_GetJoin(*args
, **kwargs
)
312 def GetStyle(*args
, **kwargs
):
313 """GetStyle(self) -> int"""
314 return _gdi_
.Pen_GetStyle(*args
, **kwargs
)
316 def GetWidth(*args
, **kwargs
):
317 """GetWidth(self) -> int"""
318 return _gdi_
.Pen_GetWidth(*args
, **kwargs
)
320 def Ok(*args
, **kwargs
):
321 """Ok(self) -> bool"""
322 return _gdi_
.Pen_Ok(*args
, **kwargs
)
324 def SetCap(*args
, **kwargs
):
325 """SetCap(self, int cap_style)"""
326 return _gdi_
.Pen_SetCap(*args
, **kwargs
)
328 def SetColour(*args
, **kwargs
):
329 """SetColour(self, Colour colour)"""
330 return _gdi_
.Pen_SetColour(*args
, **kwargs
)
332 def SetJoin(*args
, **kwargs
):
333 """SetJoin(self, int join_style)"""
334 return _gdi_
.Pen_SetJoin(*args
, **kwargs
)
336 def SetStyle(*args
, **kwargs
):
337 """SetStyle(self, int style)"""
338 return _gdi_
.Pen_SetStyle(*args
, **kwargs
)
340 def SetWidth(*args
, **kwargs
):
341 """SetWidth(self, int width)"""
342 return _gdi_
.Pen_SetWidth(*args
, **kwargs
)
344 def SetDashes(*args
, **kwargs
):
345 """SetDashes(self, int dashes)"""
346 return _gdi_
.Pen_SetDashes(*args
, **kwargs
)
348 def GetDashes(*args
, **kwargs
):
349 """GetDashes(self) -> PyObject"""
350 return _gdi_
.Pen_GetDashes(*args
, **kwargs
)
352 def _SetDashes(*args
, **kwargs
):
353 """_SetDashes(self, PyObject _self, PyObject pyDashes)"""
354 return _gdi_
.Pen__SetDashes(*args
, **kwargs
)
356 def SetDashes(self
, dashes
):
358 Associate a list of dash lengths with the Pen.
360 self
._SetDashes
(self
, dashes
)
362 def GetDashCount(*args
, **kwargs
):
363 """GetDashCount(self) -> int"""
364 return _gdi_
.Pen_GetDashCount(*args
, **kwargs
)
366 def __eq__(*args
, **kwargs
):
367 """__eq__(self, Pen other) -> bool"""
368 return _gdi_
.Pen___eq__(*args
, **kwargs
)
370 def __ne__(*args
, **kwargs
):
371 """__ne__(self, Pen other) -> bool"""
372 return _gdi_
.Pen___ne__(*args
, **kwargs
)
374 def __nonzero__(self
): return self
.Ok()
375 _gdi_
.Pen_swigregister(Pen
)
377 #---------------------------------------------------------------------------
379 class Brush(GDIObject
):
381 A brush is a drawing tool for filling in areas. It is used for
382 painting the background of rectangles, ellipses, etc. when drawing on
383 a `wx.DC`. It has a colour and a style.
385 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
386 __repr__
= _swig_repr
387 def __init__(self
, *args
, **kwargs
):
389 __init__(self, Colour colour, int style=SOLID) -> Brush
391 Constructs a brush from a `wx.Colour` object and a style.
393 _gdi_
.Brush_swiginit(self
,_gdi_
.new_Brush(*args
, **kwargs
))
394 __swig_destroy__
= _gdi_
.delete_Brush
395 __del__
= lambda self
: None;
396 def SetColour(*args
, **kwargs
):
398 SetColour(self, Colour col)
400 Set the brush's `wx.Colour`.
402 return _gdi_
.Brush_SetColour(*args
, **kwargs
)
404 def SetStyle(*args
, **kwargs
):
406 SetStyle(self, int style)
408 Sets the style of the brush. See `__init__` for a listing of styles.
410 return _gdi_
.Brush_SetStyle(*args
, **kwargs
)
412 def SetStipple(*args
, **kwargs
):
414 SetStipple(self, Bitmap stipple)
416 Sets the stipple `wx.Bitmap`.
418 return _gdi_
.Brush_SetStipple(*args
, **kwargs
)
420 def GetColour(*args
, **kwargs
):
422 GetColour(self) -> Colour
424 Returns the `wx.Colour` of the brush.
426 return _gdi_
.Brush_GetColour(*args
, **kwargs
)
428 def GetStyle(*args
, **kwargs
):
430 GetStyle(self) -> int
432 Returns the style of the brush. See `__init__` for a listing of
435 return _gdi_
.Brush_GetStyle(*args
, **kwargs
)
437 def GetStipple(*args
, **kwargs
):
439 GetStipple(self) -> Bitmap
441 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
442 have a wx.STIPPLE style, then the return value may be non-None but an
443 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
445 return _gdi_
.Brush_GetStipple(*args
, **kwargs
)
447 def IsHatch(*args
, **kwargs
):
449 IsHatch(self) -> bool
451 Is the current style a hatch type?
453 return _gdi_
.Brush_IsHatch(*args
, **kwargs
)
455 def Ok(*args
, **kwargs
):
459 Returns True if the brush is initialised and valid.
461 return _gdi_
.Brush_Ok(*args
, **kwargs
)
463 def __nonzero__(self
): return self
.Ok()
464 _gdi_
.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 _gdi_
.Bitmap_swigregister(Bitmap
)
652 def EmptyBitmap(*args
, **kwargs
):
654 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
656 Creates a new bitmap of the given size. A depth of -1 indicates the
657 depth of the current screen or visual. Some platforms only support 1
658 for monochrome and -1 for the current display depth.
660 val
= _gdi_
.new_EmptyBitmap(*args
, **kwargs
)
663 def BitmapFromIcon(*args
, **kwargs
):
665 BitmapFromIcon(Icon icon) -> Bitmap
667 Create a new bitmap from a `wx.Icon` object.
669 val
= _gdi_
.new_BitmapFromIcon(*args
, **kwargs
)
672 def BitmapFromImage(*args
, **kwargs
):
674 BitmapFromImage(Image image, int depth=-1) -> Bitmap
676 Creates bitmap object from a `wx.Image`. This has to be done to
677 actually display a `wx.Image` as you cannot draw an image directly on
678 a window. The resulting bitmap will use the provided colour depth (or
679 that of the current screen colour depth if depth is -1) which entails
680 that a colour reduction may have to take place.
682 val
= _gdi_
.new_BitmapFromImage(*args
, **kwargs
)
685 def BitmapFromXPMData(*args
, **kwargs
):
687 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
689 Construct a Bitmap from a list of strings formatted as XPM data.
691 val
= _gdi_
.new_BitmapFromXPMData(*args
, **kwargs
)
694 def BitmapFromBits(*args
, **kwargs
):
696 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
698 Creates a bitmap from an array of bits. You should only use this
699 function for monochrome bitmaps (depth 1) in portable programs: in
700 this case the bits parameter should contain an XBM image. For other
701 bit depths, the behaviour is platform dependent.
703 val
= _gdi_
.new_BitmapFromBits(*args
, **kwargs
)
706 class Mask(_core
.Object
):
708 This class encapsulates a monochrome mask bitmap, where the masked
709 area is black and the unmasked area is white. When associated with a
710 bitmap and drawn in a device context, the unmasked area of the bitmap
711 will be drawn, and the masked area will not be drawn.
713 A mask may be associated with a `wx.Bitmap`. It is used in
714 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
715 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
718 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
719 __repr__
= _swig_repr
720 def __init__(self
, *args
, **kwargs
):
722 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
724 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
725 that indicates the transparent portions of the mask. In other words,
726 the pixels in ``bitmap`` that match ``colour`` will be the transparent
727 portions of the mask. If no ``colour`` or an invalid ``colour`` is
728 passed then BLACK is used.
730 :see: `wx.Bitmap`, `wx.Colour`
732 _gdi_
.Mask_swiginit(self
,_gdi_
.new_Mask(*args
, **kwargs
))
733 __swig_destroy__
= _gdi_
.delete_Mask
734 __del__
= lambda self
: None;
735 _gdi_
.Mask_swigregister(Mask
)
737 MaskColour
= wx
._deprecated
(Mask
, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
738 class Icon(GDIObject
):
739 """Proxy of C++ Icon class"""
740 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
741 __repr__
= _swig_repr
742 def __init__(self
, *args
, **kwargs
):
743 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
744 _gdi_
.Icon_swiginit(self
,_gdi_
.new_Icon(*args
, **kwargs
))
745 __swig_destroy__
= _gdi_
.delete_Icon
746 __del__
= lambda self
: None;
747 def LoadFile(*args
, **kwargs
):
748 """LoadFile(self, String name, int type) -> bool"""
749 return _gdi_
.Icon_LoadFile(*args
, **kwargs
)
751 def Ok(*args
, **kwargs
):
752 """Ok(self) -> bool"""
753 return _gdi_
.Icon_Ok(*args
, **kwargs
)
755 def GetWidth(*args
, **kwargs
):
756 """GetWidth(self) -> int"""
757 return _gdi_
.Icon_GetWidth(*args
, **kwargs
)
759 def GetHeight(*args
, **kwargs
):
760 """GetHeight(self) -> int"""
761 return _gdi_
.Icon_GetHeight(*args
, **kwargs
)
763 def GetDepth(*args
, **kwargs
):
764 """GetDepth(self) -> int"""
765 return _gdi_
.Icon_GetDepth(*args
, **kwargs
)
767 def SetWidth(*args
, **kwargs
):
768 """SetWidth(self, int w)"""
769 return _gdi_
.Icon_SetWidth(*args
, **kwargs
)
771 def SetHeight(*args
, **kwargs
):
772 """SetHeight(self, int h)"""
773 return _gdi_
.Icon_SetHeight(*args
, **kwargs
)
775 def SetDepth(*args
, **kwargs
):
776 """SetDepth(self, int d)"""
777 return _gdi_
.Icon_SetDepth(*args
, **kwargs
)
779 def CopyFromBitmap(*args
, **kwargs
):
780 """CopyFromBitmap(self, Bitmap bmp)"""
781 return _gdi_
.Icon_CopyFromBitmap(*args
, **kwargs
)
783 def __nonzero__(self
): return self
.Ok()
784 _gdi_
.Icon_swigregister(Icon
)
786 def EmptyIcon(*args
, **kwargs
):
787 """EmptyIcon() -> Icon"""
788 val
= _gdi_
.new_EmptyIcon(*args
, **kwargs
)
791 def IconFromLocation(*args
, **kwargs
):
792 """IconFromLocation(IconLocation loc) -> Icon"""
793 val
= _gdi_
.new_IconFromLocation(*args
, **kwargs
)
796 def IconFromBitmap(*args
, **kwargs
):
797 """IconFromBitmap(Bitmap bmp) -> Icon"""
798 val
= _gdi_
.new_IconFromBitmap(*args
, **kwargs
)
801 def IconFromXPMData(*args
, **kwargs
):
802 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
803 val
= _gdi_
.new_IconFromXPMData(*args
, **kwargs
)
806 class IconLocation(object):
807 """Proxy of C++ IconLocation class"""
808 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
809 __repr__
= _swig_repr
810 def __init__(self
, *args
, **kwargs
):
811 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
812 _gdi_
.IconLocation_swiginit(self
,_gdi_
.new_IconLocation(*args
, **kwargs
))
813 __swig_destroy__
= _gdi_
.delete_IconLocation
814 __del__
= lambda self
: None;
815 def IsOk(*args
, **kwargs
):
816 """IsOk(self) -> bool"""
817 return _gdi_
.IconLocation_IsOk(*args
, **kwargs
)
819 def __nonzero__(self
): return self
.Ok()
820 def SetFileName(*args
, **kwargs
):
821 """SetFileName(self, String filename)"""
822 return _gdi_
.IconLocation_SetFileName(*args
, **kwargs
)
824 def GetFileName(*args
, **kwargs
):
825 """GetFileName(self) -> String"""
826 return _gdi_
.IconLocation_GetFileName(*args
, **kwargs
)
828 def SetIndex(*args
, **kwargs
):
829 """SetIndex(self, int num)"""
830 return _gdi_
.IconLocation_SetIndex(*args
, **kwargs
)
832 def GetIndex(*args
, **kwargs
):
833 """GetIndex(self) -> int"""
834 return _gdi_
.IconLocation_GetIndex(*args
, **kwargs
)
836 _gdi_
.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 _gdi_
.IconBundle_swigregister(IconBundle
)
861 def IconBundleFromFile(*args
, **kwargs
):
862 """IconBundleFromFile(String file, long type) -> IconBundle"""
863 val
= _gdi_
.new_IconBundleFromFile(*args
, **kwargs
)
866 def IconBundleFromIcon(*args
, **kwargs
):
867 """IconBundleFromIcon(Icon icon) -> IconBundle"""
868 val
= _gdi_
.new_IconBundleFromIcon(*args
, **kwargs
)
871 class Cursor(GDIObject
):
873 A cursor is a small bitmap usually used for denoting where the mouse
874 pointer is, with a picture that might indicate the interpretation of a
877 A single cursor object may be used in many windows (any subwindow
878 type). The wxWindows convention is to set the cursor for a window, as
879 in X, rather than to set it globally as in MS Windows, although a
880 global `wx.SetCursor` function is also available for use on MS Windows.
883 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
884 __repr__
= _swig_repr
885 def __init__(self
, *args
, **kwargs
):
887 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
889 Construct a Cursor from a file. Specify the type of file using
890 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
893 _gdi_
.Cursor_swiginit(self
,_gdi_
.new_Cursor(*args
, **kwargs
))
894 __swig_destroy__
= _gdi_
.delete_Cursor
895 __del__
= lambda self
: None;
896 def Ok(*args
, **kwargs
):
897 """Ok(self) -> bool"""
898 return _gdi_
.Cursor_Ok(*args
, **kwargs
)
900 def __nonzero__(self
): return self
.Ok()
901 _gdi_
.Cursor_swigregister(Cursor
)
903 def StockCursor(*args
, **kwargs
):
905 StockCursor(int id) -> Cursor
907 Create a cursor using one of the stock cursors. Note that not all
908 stock cursors are available on all platforms.
910 val
= _gdi_
.new_StockCursor(*args
, **kwargs
)
913 def CursorFromImage(*args
, **kwargs
):
915 CursorFromImage(Image image) -> Cursor
917 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
918 for setting the transparent portions of the cursor.
920 val
= _gdi_
.new_CursorFromImage(*args
, **kwargs
)
923 #---------------------------------------------------------------------------
925 OutRegion
= _gdi_
.OutRegion
926 PartRegion
= _gdi_
.PartRegion
927 InRegion
= _gdi_
.InRegion
928 class Region(GDIObject
):
929 """Proxy of C++ Region class"""
930 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
931 __repr__
= _swig_repr
932 def __init__(self
, *args
, **kwargs
):
933 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
934 _gdi_
.Region_swiginit(self
,_gdi_
.new_Region(*args
, **kwargs
))
935 __swig_destroy__
= _gdi_
.delete_Region
936 __del__
= lambda self
: None;
937 def Clear(*args
, **kwargs
):
939 return _gdi_
.Region_Clear(*args
, **kwargs
)
941 def Offset(*args
, **kwargs
):
942 """Offset(self, int x, int y) -> bool"""
943 return _gdi_
.Region_Offset(*args
, **kwargs
)
945 def Contains(*args
, **kwargs
):
946 """Contains(self, int x, int y) -> int"""
947 return _gdi_
.Region_Contains(*args
, **kwargs
)
949 def ContainsPoint(*args
, **kwargs
):
950 """ContainsPoint(self, Point pt) -> int"""
951 return _gdi_
.Region_ContainsPoint(*args
, **kwargs
)
953 def ContainsRect(*args
, **kwargs
):
954 """ContainsRect(self, Rect rect) -> int"""
955 return _gdi_
.Region_ContainsRect(*args
, **kwargs
)
957 def ContainsRectDim(*args
, **kwargs
):
958 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
959 return _gdi_
.Region_ContainsRectDim(*args
, **kwargs
)
961 def GetBox(*args
, **kwargs
):
962 """GetBox(self) -> Rect"""
963 return _gdi_
.Region_GetBox(*args
, **kwargs
)
965 def Intersect(*args
, **kwargs
):
966 """Intersect(self, int x, int y, int width, int height) -> bool"""
967 return _gdi_
.Region_Intersect(*args
, **kwargs
)
969 def IntersectRect(*args
, **kwargs
):
970 """IntersectRect(self, Rect rect) -> bool"""
971 return _gdi_
.Region_IntersectRect(*args
, **kwargs
)
973 def IntersectRegion(*args
, **kwargs
):
974 """IntersectRegion(self, Region region) -> bool"""
975 return _gdi_
.Region_IntersectRegion(*args
, **kwargs
)
977 def IsEmpty(*args
, **kwargs
):
978 """IsEmpty(self) -> bool"""
979 return _gdi_
.Region_IsEmpty(*args
, **kwargs
)
981 def Union(*args
, **kwargs
):
982 """Union(self, int x, int y, int width, int height) -> bool"""
983 return _gdi_
.Region_Union(*args
, **kwargs
)
985 def UnionRect(*args
, **kwargs
):
986 """UnionRect(self, Rect rect) -> bool"""
987 return _gdi_
.Region_UnionRect(*args
, **kwargs
)
989 def UnionRegion(*args
, **kwargs
):
990 """UnionRegion(self, Region region) -> bool"""
991 return _gdi_
.Region_UnionRegion(*args
, **kwargs
)
993 def Subtract(*args
, **kwargs
):
994 """Subtract(self, int x, int y, int width, int height) -> bool"""
995 return _gdi_
.Region_Subtract(*args
, **kwargs
)
997 def SubtractRect(*args
, **kwargs
):
998 """SubtractRect(self, Rect rect) -> bool"""
999 return _gdi_
.Region_SubtractRect(*args
, **kwargs
)
1001 def SubtractRegion(*args
, **kwargs
):
1002 """SubtractRegion(self, Region region) -> bool"""
1003 return _gdi_
.Region_SubtractRegion(*args
, **kwargs
)
1005 def Xor(*args
, **kwargs
):
1006 """Xor(self, int x, int y, int width, int height) -> bool"""
1007 return _gdi_
.Region_Xor(*args
, **kwargs
)
1009 def XorRect(*args
, **kwargs
):
1010 """XorRect(self, Rect rect) -> bool"""
1011 return _gdi_
.Region_XorRect(*args
, **kwargs
)
1013 def XorRegion(*args
, **kwargs
):
1014 """XorRegion(self, Region region) -> bool"""
1015 return _gdi_
.Region_XorRegion(*args
, **kwargs
)
1017 def ConvertToBitmap(*args
, **kwargs
):
1018 """ConvertToBitmap(self) -> Bitmap"""
1019 return _gdi_
.Region_ConvertToBitmap(*args
, **kwargs
)
1021 def UnionBitmap(*args
, **kwargs
):
1022 """UnionBitmap(self, Bitmap bmp) -> bool"""
1023 return _gdi_
.Region_UnionBitmap(*args
, **kwargs
)
1025 def UnionBitmapColour(*args
, **kwargs
):
1026 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1027 return _gdi_
.Region_UnionBitmapColour(*args
, **kwargs
)
1029 _gdi_
.Region_swigregister(Region
)
1031 def RegionFromBitmap(*args
, **kwargs
):
1032 """RegionFromBitmap(Bitmap bmp) -> Region"""
1033 val
= _gdi_
.new_RegionFromBitmap(*args
, **kwargs
)
1036 def RegionFromBitmapColour(*args
, **kwargs
):
1037 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1038 val
= _gdi_
.new_RegionFromBitmapColour(*args
, **kwargs
)
1041 def RegionFromPoints(*args
, **kwargs
):
1042 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
1043 val
= _gdi_
.new_RegionFromPoints(*args
, **kwargs
)
1046 class RegionIterator(_core
.Object
):
1047 """Proxy of C++ RegionIterator class"""
1048 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1049 __repr__
= _swig_repr
1050 def __init__(self
, *args
, **kwargs
):
1051 """__init__(self, Region region) -> RegionIterator"""
1052 _gdi_
.RegionIterator_swiginit(self
,_gdi_
.new_RegionIterator(*args
, **kwargs
))
1053 __swig_destroy__
= _gdi_
.delete_RegionIterator
1054 __del__
= lambda self
: None;
1055 def GetX(*args
, **kwargs
):
1056 """GetX(self) -> int"""
1057 return _gdi_
.RegionIterator_GetX(*args
, **kwargs
)
1059 def GetY(*args
, **kwargs
):
1060 """GetY(self) -> int"""
1061 return _gdi_
.RegionIterator_GetY(*args
, **kwargs
)
1063 def GetW(*args
, **kwargs
):
1064 """GetW(self) -> int"""
1065 return _gdi_
.RegionIterator_GetW(*args
, **kwargs
)
1067 def GetWidth(*args
, **kwargs
):
1068 """GetWidth(self) -> int"""
1069 return _gdi_
.RegionIterator_GetWidth(*args
, **kwargs
)
1071 def GetH(*args
, **kwargs
):
1072 """GetH(self) -> int"""
1073 return _gdi_
.RegionIterator_GetH(*args
, **kwargs
)
1075 def GetHeight(*args
, **kwargs
):
1076 """GetHeight(self) -> int"""
1077 return _gdi_
.RegionIterator_GetHeight(*args
, **kwargs
)
1079 def GetRect(*args
, **kwargs
):
1080 """GetRect(self) -> Rect"""
1081 return _gdi_
.RegionIterator_GetRect(*args
, **kwargs
)
1083 def HaveRects(*args
, **kwargs
):
1084 """HaveRects(self) -> bool"""
1085 return _gdi_
.RegionIterator_HaveRects(*args
, **kwargs
)
1087 def Reset(*args
, **kwargs
):
1089 return _gdi_
.RegionIterator_Reset(*args
, **kwargs
)
1091 def Next(*args
, **kwargs
):
1093 return _gdi_
.RegionIterator_Next(*args
, **kwargs
)
1095 def __nonzero__(*args
, **kwargs
):
1096 """__nonzero__(self) -> bool"""
1097 return _gdi_
.RegionIterator___nonzero__(*args
, **kwargs
)
1099 _gdi_
.RegionIterator_swigregister(RegionIterator
)
1101 #---------------------------------------------------------------------------
1103 FONTFAMILY_DEFAULT
= _gdi_
.FONTFAMILY_DEFAULT
1104 FONTFAMILY_DECORATIVE
= _gdi_
.FONTFAMILY_DECORATIVE
1105 FONTFAMILY_ROMAN
= _gdi_
.FONTFAMILY_ROMAN
1106 FONTFAMILY_SCRIPT
= _gdi_
.FONTFAMILY_SCRIPT
1107 FONTFAMILY_SWISS
= _gdi_
.FONTFAMILY_SWISS
1108 FONTFAMILY_MODERN
= _gdi_
.FONTFAMILY_MODERN
1109 FONTFAMILY_TELETYPE
= _gdi_
.FONTFAMILY_TELETYPE
1110 FONTFAMILY_MAX
= _gdi_
.FONTFAMILY_MAX
1111 FONTFAMILY_UNKNOWN
= _gdi_
.FONTFAMILY_UNKNOWN
1112 FONTSTYLE_NORMAL
= _gdi_
.FONTSTYLE_NORMAL
1113 FONTSTYLE_ITALIC
= _gdi_
.FONTSTYLE_ITALIC
1114 FONTSTYLE_SLANT
= _gdi_
.FONTSTYLE_SLANT
1115 FONTSTYLE_MAX
= _gdi_
.FONTSTYLE_MAX
1116 FONTWEIGHT_NORMAL
= _gdi_
.FONTWEIGHT_NORMAL
1117 FONTWEIGHT_LIGHT
= _gdi_
.FONTWEIGHT_LIGHT
1118 FONTWEIGHT_BOLD
= _gdi_
.FONTWEIGHT_BOLD
1119 FONTWEIGHT_MAX
= _gdi_
.FONTWEIGHT_MAX
1120 FONTFLAG_DEFAULT
= _gdi_
.FONTFLAG_DEFAULT
1121 FONTFLAG_ITALIC
= _gdi_
.FONTFLAG_ITALIC
1122 FONTFLAG_SLANT
= _gdi_
.FONTFLAG_SLANT
1123 FONTFLAG_LIGHT
= _gdi_
.FONTFLAG_LIGHT
1124 FONTFLAG_BOLD
= _gdi_
.FONTFLAG_BOLD
1125 FONTFLAG_ANTIALIASED
= _gdi_
.FONTFLAG_ANTIALIASED
1126 FONTFLAG_NOT_ANTIALIASED
= _gdi_
.FONTFLAG_NOT_ANTIALIASED
1127 FONTFLAG_UNDERLINED
= _gdi_
.FONTFLAG_UNDERLINED
1128 FONTFLAG_STRIKETHROUGH
= _gdi_
.FONTFLAG_STRIKETHROUGH
1129 FONTFLAG_MASK
= _gdi_
.FONTFLAG_MASK
1130 FONTENCODING_SYSTEM
= _gdi_
.FONTENCODING_SYSTEM
1131 FONTENCODING_DEFAULT
= _gdi_
.FONTENCODING_DEFAULT
1132 FONTENCODING_ISO8859_1
= _gdi_
.FONTENCODING_ISO8859_1
1133 FONTENCODING_ISO8859_2
= _gdi_
.FONTENCODING_ISO8859_2
1134 FONTENCODING_ISO8859_3
= _gdi_
.FONTENCODING_ISO8859_3
1135 FONTENCODING_ISO8859_4
= _gdi_
.FONTENCODING_ISO8859_4
1136 FONTENCODING_ISO8859_5
= _gdi_
.FONTENCODING_ISO8859_5
1137 FONTENCODING_ISO8859_6
= _gdi_
.FONTENCODING_ISO8859_6
1138 FONTENCODING_ISO8859_7
= _gdi_
.FONTENCODING_ISO8859_7
1139 FONTENCODING_ISO8859_8
= _gdi_
.FONTENCODING_ISO8859_8
1140 FONTENCODING_ISO8859_9
= _gdi_
.FONTENCODING_ISO8859_9
1141 FONTENCODING_ISO8859_10
= _gdi_
.FONTENCODING_ISO8859_10
1142 FONTENCODING_ISO8859_11
= _gdi_
.FONTENCODING_ISO8859_11
1143 FONTENCODING_ISO8859_12
= _gdi_
.FONTENCODING_ISO8859_12
1144 FONTENCODING_ISO8859_13
= _gdi_
.FONTENCODING_ISO8859_13
1145 FONTENCODING_ISO8859_14
= _gdi_
.FONTENCODING_ISO8859_14
1146 FONTENCODING_ISO8859_15
= _gdi_
.FONTENCODING_ISO8859_15
1147 FONTENCODING_ISO8859_MAX
= _gdi_
.FONTENCODING_ISO8859_MAX
1148 FONTENCODING_KOI8
= _gdi_
.FONTENCODING_KOI8
1149 FONTENCODING_KOI8_U
= _gdi_
.FONTENCODING_KOI8_U
1150 FONTENCODING_ALTERNATIVE
= _gdi_
.FONTENCODING_ALTERNATIVE
1151 FONTENCODING_BULGARIAN
= _gdi_
.FONTENCODING_BULGARIAN
1152 FONTENCODING_CP437
= _gdi_
.FONTENCODING_CP437
1153 FONTENCODING_CP850
= _gdi_
.FONTENCODING_CP850
1154 FONTENCODING_CP852
= _gdi_
.FONTENCODING_CP852
1155 FONTENCODING_CP855
= _gdi_
.FONTENCODING_CP855
1156 FONTENCODING_CP866
= _gdi_
.FONTENCODING_CP866
1157 FONTENCODING_CP874
= _gdi_
.FONTENCODING_CP874
1158 FONTENCODING_CP932
= _gdi_
.FONTENCODING_CP932
1159 FONTENCODING_CP936
= _gdi_
.FONTENCODING_CP936
1160 FONTENCODING_CP949
= _gdi_
.FONTENCODING_CP949
1161 FONTENCODING_CP950
= _gdi_
.FONTENCODING_CP950
1162 FONTENCODING_CP1250
= _gdi_
.FONTENCODING_CP1250
1163 FONTENCODING_CP1251
= _gdi_
.FONTENCODING_CP1251
1164 FONTENCODING_CP1252
= _gdi_
.FONTENCODING_CP1252
1165 FONTENCODING_CP1253
= _gdi_
.FONTENCODING_CP1253
1166 FONTENCODING_CP1254
= _gdi_
.FONTENCODING_CP1254
1167 FONTENCODING_CP1255
= _gdi_
.FONTENCODING_CP1255
1168 FONTENCODING_CP1256
= _gdi_
.FONTENCODING_CP1256
1169 FONTENCODING_CP1257
= _gdi_
.FONTENCODING_CP1257
1170 FONTENCODING_CP12_MAX
= _gdi_
.FONTENCODING_CP12_MAX
1171 FONTENCODING_UTF7
= _gdi_
.FONTENCODING_UTF7
1172 FONTENCODING_UTF8
= _gdi_
.FONTENCODING_UTF8
1173 FONTENCODING_EUC_JP
= _gdi_
.FONTENCODING_EUC_JP
1174 FONTENCODING_UTF16BE
= _gdi_
.FONTENCODING_UTF16BE
1175 FONTENCODING_UTF16LE
= _gdi_
.FONTENCODING_UTF16LE
1176 FONTENCODING_UTF32BE
= _gdi_
.FONTENCODING_UTF32BE
1177 FONTENCODING_UTF32LE
= _gdi_
.FONTENCODING_UTF32LE
1178 FONTENCODING_MACROMAN
= _gdi_
.FONTENCODING_MACROMAN
1179 FONTENCODING_MACJAPANESE
= _gdi_
.FONTENCODING_MACJAPANESE
1180 FONTENCODING_MACCHINESETRAD
= _gdi_
.FONTENCODING_MACCHINESETRAD
1181 FONTENCODING_MACKOREAN
= _gdi_
.FONTENCODING_MACKOREAN
1182 FONTENCODING_MACARABIC
= _gdi_
.FONTENCODING_MACARABIC
1183 FONTENCODING_MACHEBREW
= _gdi_
.FONTENCODING_MACHEBREW
1184 FONTENCODING_MACGREEK
= _gdi_
.FONTENCODING_MACGREEK
1185 FONTENCODING_MACCYRILLIC
= _gdi_
.FONTENCODING_MACCYRILLIC
1186 FONTENCODING_MACDEVANAGARI
= _gdi_
.FONTENCODING_MACDEVANAGARI
1187 FONTENCODING_MACGURMUKHI
= _gdi_
.FONTENCODING_MACGURMUKHI
1188 FONTENCODING_MACGUJARATI
= _gdi_
.FONTENCODING_MACGUJARATI
1189 FONTENCODING_MACORIYA
= _gdi_
.FONTENCODING_MACORIYA
1190 FONTENCODING_MACBENGALI
= _gdi_
.FONTENCODING_MACBENGALI
1191 FONTENCODING_MACTAMIL
= _gdi_
.FONTENCODING_MACTAMIL
1192 FONTENCODING_MACTELUGU
= _gdi_
.FONTENCODING_MACTELUGU
1193 FONTENCODING_MACKANNADA
= _gdi_
.FONTENCODING_MACKANNADA
1194 FONTENCODING_MACMALAJALAM
= _gdi_
.FONTENCODING_MACMALAJALAM
1195 FONTENCODING_MACSINHALESE
= _gdi_
.FONTENCODING_MACSINHALESE
1196 FONTENCODING_MACBURMESE
= _gdi_
.FONTENCODING_MACBURMESE
1197 FONTENCODING_MACKHMER
= _gdi_
.FONTENCODING_MACKHMER
1198 FONTENCODING_MACTHAI
= _gdi_
.FONTENCODING_MACTHAI
1199 FONTENCODING_MACLAOTIAN
= _gdi_
.FONTENCODING_MACLAOTIAN
1200 FONTENCODING_MACGEORGIAN
= _gdi_
.FONTENCODING_MACGEORGIAN
1201 FONTENCODING_MACARMENIAN
= _gdi_
.FONTENCODING_MACARMENIAN
1202 FONTENCODING_MACCHINESESIMP
= _gdi_
.FONTENCODING_MACCHINESESIMP
1203 FONTENCODING_MACTIBETAN
= _gdi_
.FONTENCODING_MACTIBETAN
1204 FONTENCODING_MACMONGOLIAN
= _gdi_
.FONTENCODING_MACMONGOLIAN
1205 FONTENCODING_MACETHIOPIC
= _gdi_
.FONTENCODING_MACETHIOPIC
1206 FONTENCODING_MACCENTRALEUR
= _gdi_
.FONTENCODING_MACCENTRALEUR
1207 FONTENCODING_MACVIATNAMESE
= _gdi_
.FONTENCODING_MACVIATNAMESE
1208 FONTENCODING_MACARABICEXT
= _gdi_
.FONTENCODING_MACARABICEXT
1209 FONTENCODING_MACSYMBOL
= _gdi_
.FONTENCODING_MACSYMBOL
1210 FONTENCODING_MACDINGBATS
= _gdi_
.FONTENCODING_MACDINGBATS
1211 FONTENCODING_MACTURKISH
= _gdi_
.FONTENCODING_MACTURKISH
1212 FONTENCODING_MACCROATIAN
= _gdi_
.FONTENCODING_MACCROATIAN
1213 FONTENCODING_MACICELANDIC
= _gdi_
.FONTENCODING_MACICELANDIC
1214 FONTENCODING_MACROMANIAN
= _gdi_
.FONTENCODING_MACROMANIAN
1215 FONTENCODING_MACCELTIC
= _gdi_
.FONTENCODING_MACCELTIC
1216 FONTENCODING_MACGAELIC
= _gdi_
.FONTENCODING_MACGAELIC
1217 FONTENCODING_MACKEYBOARD
= _gdi_
.FONTENCODING_MACKEYBOARD
1218 FONTENCODING_MACMIN
= _gdi_
.FONTENCODING_MACMIN
1219 FONTENCODING_MACMAX
= _gdi_
.FONTENCODING_MACMAX
1220 FONTENCODING_MAX
= _gdi_
.FONTENCODING_MAX
1221 FONTENCODING_UTF16
= _gdi_
.FONTENCODING_UTF16
1222 FONTENCODING_UTF32
= _gdi_
.FONTENCODING_UTF32
1223 FONTENCODING_UNICODE
= _gdi_
.FONTENCODING_UNICODE
1224 FONTENCODING_GB2312
= _gdi_
.FONTENCODING_GB2312
1225 FONTENCODING_BIG5
= _gdi_
.FONTENCODING_BIG5
1226 FONTENCODING_SHIFT_JIS
= _gdi_
.FONTENCODING_SHIFT_JIS
1227 #---------------------------------------------------------------------------
1229 class NativeFontInfo(object):
1230 """Proxy of C++ NativeFontInfo class"""
1231 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1232 __repr__
= _swig_repr
1233 def __init__(self
, *args
, **kwargs
):
1234 """__init__(self) -> NativeFontInfo"""
1235 _gdi_
.NativeFontInfo_swiginit(self
,_gdi_
.new_NativeFontInfo(*args
, **kwargs
))
1236 __swig_destroy__
= _gdi_
.delete_NativeFontInfo
1237 __del__
= lambda self
: None;
1238 def Init(*args
, **kwargs
):
1240 return _gdi_
.NativeFontInfo_Init(*args
, **kwargs
)
1242 def InitFromFont(*args
, **kwargs
):
1243 """InitFromFont(self, Font font)"""
1244 return _gdi_
.NativeFontInfo_InitFromFont(*args
, **kwargs
)
1246 def GetPointSize(*args
, **kwargs
):
1247 """GetPointSize(self) -> int"""
1248 return _gdi_
.NativeFontInfo_GetPointSize(*args
, **kwargs
)
1250 def GetStyle(*args
, **kwargs
):
1251 """GetStyle(self) -> int"""
1252 return _gdi_
.NativeFontInfo_GetStyle(*args
, **kwargs
)
1254 def GetWeight(*args
, **kwargs
):
1255 """GetWeight(self) -> int"""
1256 return _gdi_
.NativeFontInfo_GetWeight(*args
, **kwargs
)
1258 def GetUnderlined(*args
, **kwargs
):
1259 """GetUnderlined(self) -> bool"""
1260 return _gdi_
.NativeFontInfo_GetUnderlined(*args
, **kwargs
)
1262 def GetFaceName(*args
, **kwargs
):
1263 """GetFaceName(self) -> String"""
1264 return _gdi_
.NativeFontInfo_GetFaceName(*args
, **kwargs
)
1266 def GetFamily(*args
, **kwargs
):
1267 """GetFamily(self) -> int"""
1268 return _gdi_
.NativeFontInfo_GetFamily(*args
, **kwargs
)
1270 def GetEncoding(*args
, **kwargs
):
1271 """GetEncoding(self) -> int"""
1272 return _gdi_
.NativeFontInfo_GetEncoding(*args
, **kwargs
)
1274 def SetPointSize(*args
, **kwargs
):
1275 """SetPointSize(self, int pointsize)"""
1276 return _gdi_
.NativeFontInfo_SetPointSize(*args
, **kwargs
)
1278 def SetStyle(*args
, **kwargs
):
1279 """SetStyle(self, int style)"""
1280 return _gdi_
.NativeFontInfo_SetStyle(*args
, **kwargs
)
1282 def SetWeight(*args
, **kwargs
):
1283 """SetWeight(self, int weight)"""
1284 return _gdi_
.NativeFontInfo_SetWeight(*args
, **kwargs
)
1286 def SetUnderlined(*args
, **kwargs
):
1287 """SetUnderlined(self, bool underlined)"""
1288 return _gdi_
.NativeFontInfo_SetUnderlined(*args
, **kwargs
)
1290 def SetFaceName(*args
, **kwargs
):
1291 """SetFaceName(self, String facename)"""
1292 return _gdi_
.NativeFontInfo_SetFaceName(*args
, **kwargs
)
1294 def SetFamily(*args
, **kwargs
):
1295 """SetFamily(self, int family)"""
1296 return _gdi_
.NativeFontInfo_SetFamily(*args
, **kwargs
)
1298 def SetEncoding(*args
, **kwargs
):
1299 """SetEncoding(self, int encoding)"""
1300 return _gdi_
.NativeFontInfo_SetEncoding(*args
, **kwargs
)
1302 def FromString(*args
, **kwargs
):
1303 """FromString(self, String s) -> bool"""
1304 return _gdi_
.NativeFontInfo_FromString(*args
, **kwargs
)
1306 def ToString(*args
, **kwargs
):
1307 """ToString(self) -> String"""
1308 return _gdi_
.NativeFontInfo_ToString(*args
, **kwargs
)
1310 def __str__(*args
, **kwargs
):
1311 """__str__(self) -> String"""
1312 return _gdi_
.NativeFontInfo___str__(*args
, **kwargs
)
1314 def FromUserString(*args
, **kwargs
):
1315 """FromUserString(self, String s) -> bool"""
1316 return _gdi_
.NativeFontInfo_FromUserString(*args
, **kwargs
)
1318 def ToUserString(*args
, **kwargs
):
1319 """ToUserString(self) -> String"""
1320 return _gdi_
.NativeFontInfo_ToUserString(*args
, **kwargs
)
1322 _gdi_
.NativeFontInfo_swigregister(NativeFontInfo
)
1324 class NativeEncodingInfo(object):
1325 """Proxy of C++ NativeEncodingInfo class"""
1326 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1327 __repr__
= _swig_repr
1328 facename
= property(_gdi_
.NativeEncodingInfo_facename_get
, _gdi_
.NativeEncodingInfo_facename_set
)
1329 encoding
= property(_gdi_
.NativeEncodingInfo_encoding_get
, _gdi_
.NativeEncodingInfo_encoding_set
)
1330 def __init__(self
, *args
, **kwargs
):
1331 """__init__(self) -> NativeEncodingInfo"""
1332 _gdi_
.NativeEncodingInfo_swiginit(self
,_gdi_
.new_NativeEncodingInfo(*args
, **kwargs
))
1333 __swig_destroy__
= _gdi_
.delete_NativeEncodingInfo
1334 __del__
= lambda self
: None;
1335 def FromString(*args
, **kwargs
):
1336 """FromString(self, String s) -> bool"""
1337 return _gdi_
.NativeEncodingInfo_FromString(*args
, **kwargs
)
1339 def ToString(*args
, **kwargs
):
1340 """ToString(self) -> String"""
1341 return _gdi_
.NativeEncodingInfo_ToString(*args
, **kwargs
)
1343 _gdi_
.NativeEncodingInfo_swigregister(NativeEncodingInfo
)
1346 def GetNativeFontEncoding(*args
, **kwargs
):
1347 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
1348 return _gdi_
.GetNativeFontEncoding(*args
, **kwargs
)
1350 def TestFontEncoding(*args
, **kwargs
):
1351 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
1352 return _gdi_
.TestFontEncoding(*args
, **kwargs
)
1353 #---------------------------------------------------------------------------
1355 class FontMapper(object):
1356 """Proxy of C++ FontMapper class"""
1357 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1358 __repr__
= _swig_repr
1359 def __init__(self
, *args
, **kwargs
):
1360 """__init__(self) -> FontMapper"""
1361 _gdi_
.FontMapper_swiginit(self
,_gdi_
.new_FontMapper(*args
, **kwargs
))
1362 __swig_destroy__
= _gdi_
.delete_FontMapper
1363 __del__
= lambda self
: None;
1364 def Get(*args
, **kwargs
):
1365 """Get() -> FontMapper"""
1366 return _gdi_
.FontMapper_Get(*args
, **kwargs
)
1368 Get
= staticmethod(Get
)
1369 def Set(*args
, **kwargs
):
1370 """Set(FontMapper mapper) -> FontMapper"""
1371 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1373 Set
= staticmethod(Set
)
1374 def CharsetToEncoding(*args
, **kwargs
):
1375 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
1376 return _gdi_
.FontMapper_CharsetToEncoding(*args
, **kwargs
)
1378 def GetSupportedEncodingsCount(*args
, **kwargs
):
1379 """GetSupportedEncodingsCount() -> size_t"""
1380 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
, **kwargs
)
1382 GetSupportedEncodingsCount
= staticmethod(GetSupportedEncodingsCount
)
1383 def GetEncoding(*args
, **kwargs
):
1384 """GetEncoding(size_t n) -> int"""
1385 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1387 GetEncoding
= staticmethod(GetEncoding
)
1388 def GetEncodingName(*args
, **kwargs
):
1389 """GetEncodingName(int encoding) -> String"""
1390 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1392 GetEncodingName
= staticmethod(GetEncodingName
)
1393 def GetEncodingDescription(*args
, **kwargs
):
1394 """GetEncodingDescription(int encoding) -> String"""
1395 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1397 GetEncodingDescription
= staticmethod(GetEncodingDescription
)
1398 def GetEncodingFromName(*args
, **kwargs
):
1399 """GetEncodingFromName(String name) -> int"""
1400 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1402 GetEncodingFromName
= staticmethod(GetEncodingFromName
)
1403 def SetConfigPath(*args
, **kwargs
):
1404 """SetConfigPath(self, String prefix)"""
1405 return _gdi_
.FontMapper_SetConfigPath(*args
, **kwargs
)
1407 def GetDefaultConfigPath(*args
, **kwargs
):
1408 """GetDefaultConfigPath() -> String"""
1409 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
, **kwargs
)
1411 GetDefaultConfigPath
= staticmethod(GetDefaultConfigPath
)
1412 def GetAltForEncoding(*args
, **kwargs
):
1413 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
1414 return _gdi_
.FontMapper_GetAltForEncoding(*args
, **kwargs
)
1416 def IsEncodingAvailable(*args
, **kwargs
):
1417 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
1418 return _gdi_
.FontMapper_IsEncodingAvailable(*args
, **kwargs
)
1420 def SetDialogParent(*args
, **kwargs
):
1421 """SetDialogParent(self, Window parent)"""
1422 return _gdi_
.FontMapper_SetDialogParent(*args
, **kwargs
)
1424 def SetDialogTitle(*args
, **kwargs
):
1425 """SetDialogTitle(self, String title)"""
1426 return _gdi_
.FontMapper_SetDialogTitle(*args
, **kwargs
)
1428 _gdi_
.FontMapper_swigregister(FontMapper
)
1430 def FontMapper_Get(*args
):
1431 """FontMapper_Get() -> FontMapper"""
1432 return _gdi_
.FontMapper_Get(*args
)
1434 def FontMapper_Set(*args
, **kwargs
):
1435 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
1436 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1438 def FontMapper_GetSupportedEncodingsCount(*args
):
1439 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
1440 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
)
1442 def FontMapper_GetEncoding(*args
, **kwargs
):
1443 """FontMapper_GetEncoding(size_t n) -> int"""
1444 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1446 def FontMapper_GetEncodingName(*args
, **kwargs
):
1447 """FontMapper_GetEncodingName(int encoding) -> String"""
1448 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1450 def FontMapper_GetEncodingDescription(*args
, **kwargs
):
1451 """FontMapper_GetEncodingDescription(int encoding) -> String"""
1452 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1454 def FontMapper_GetEncodingFromName(*args
, **kwargs
):
1455 """FontMapper_GetEncodingFromName(String name) -> int"""
1456 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1458 def FontMapper_GetDefaultConfigPath(*args
):
1459 """FontMapper_GetDefaultConfigPath() -> String"""
1460 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
)
1462 #---------------------------------------------------------------------------
1464 class Font(GDIObject
):
1466 A font is an object which determines the appearance of text. Fonts are
1467 used for drawing text to a device context, and setting the appearance
1470 You can retrieve the current system font settings with `wx.SystemSettings`.
1472 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1473 __repr__
= _swig_repr
1474 def __init__(self
, *args
, **kwargs
):
1476 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
1477 String face=EmptyString,
1478 int encoding=FONTENCODING_DEFAULT) -> Font
1480 Creates a font object with the specified attributes.
1482 :param pointSize: The size of the font in points.
1484 :param family: Font family. A generic way of referring to fonts
1485 without specifying actual facename. It can be One of
1486 the ``wx.FONTFAMILY_xxx`` constants.
1488 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1490 :param weight: Font weight, sometimes also referred to as font
1491 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1493 :param underline: The value can be ``True`` or ``False`` and
1494 indicates whether the font will include an underline. This
1495 may not be supported on all platforms.
1497 :param face: An optional string specifying the actual typeface to
1498 be used. If it is an empty string, a default typeface will be
1499 chosen based on the family.
1501 :param encoding: An encoding which may be one of the
1502 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1503 available, no font is created.
1505 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1506 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1509 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1510 _gdi_
.Font_swiginit(self
,_gdi_
.new_Font(*args
, **kwargs
))
1511 __swig_destroy__
= _gdi_
.delete_Font
1512 __del__
= lambda self
: None;
1513 def Ok(*args
, **kwargs
):
1517 Returns ``True`` if this font was successfully created.
1519 return _gdi_
.Font_Ok(*args
, **kwargs
)
1521 def __nonzero__(self
): return self
.Ok()
1522 def __eq__(*args
, **kwargs
):
1523 """__eq__(self, Font other) -> bool"""
1524 return _gdi_
.Font___eq__(*args
, **kwargs
)
1526 def __ne__(*args
, **kwargs
):
1527 """__ne__(self, Font other) -> bool"""
1528 return _gdi_
.Font___ne__(*args
, **kwargs
)
1530 def GetPointSize(*args
, **kwargs
):
1532 GetPointSize(self) -> int
1534 Gets the point size.
1536 return _gdi_
.Font_GetPointSize(*args
, **kwargs
)
1538 def GetPixelSize(*args
, **kwargs
):
1540 GetPixelSize(self) -> Size
1542 Returns the size in pixels if the font was constructed with a pixel
1545 return _gdi_
.Font_GetPixelSize(*args
, **kwargs
)
1547 def IsUsingSizeInPixels(*args
, **kwargs
):
1549 IsUsingSizeInPixels(self) -> bool
1551 Returns ``True`` if the font is using a pixelSize.
1553 return _gdi_
.Font_IsUsingSizeInPixels(*args
, **kwargs
)
1555 def GetFamily(*args
, **kwargs
):
1557 GetFamily(self) -> int
1559 Gets the font family.
1561 return _gdi_
.Font_GetFamily(*args
, **kwargs
)
1563 def GetStyle(*args
, **kwargs
):
1565 GetStyle(self) -> int
1567 Gets the font style.
1569 return _gdi_
.Font_GetStyle(*args
, **kwargs
)
1571 def GetWeight(*args
, **kwargs
):
1573 GetWeight(self) -> int
1575 Gets the font weight.
1577 return _gdi_
.Font_GetWeight(*args
, **kwargs
)
1579 def GetUnderlined(*args
, **kwargs
):
1581 GetUnderlined(self) -> bool
1583 Returns ``True`` if the font is underlined, ``False`` otherwise.
1585 return _gdi_
.Font_GetUnderlined(*args
, **kwargs
)
1587 def GetFaceName(*args
, **kwargs
):
1589 GetFaceName(self) -> String
1591 Returns the typeface name associated with the font, or the empty
1592 string if there is no typeface information.
1594 return _gdi_
.Font_GetFaceName(*args
, **kwargs
)
1596 def GetEncoding(*args
, **kwargs
):
1598 GetEncoding(self) -> int
1600 Get the font's encoding.
1602 return _gdi_
.Font_GetEncoding(*args
, **kwargs
)
1604 def GetNativeFontInfo(*args
, **kwargs
):
1606 GetNativeFontInfo(self) -> NativeFontInfo
1608 Constructs a `wx.NativeFontInfo` object from this font.
1610 return _gdi_
.Font_GetNativeFontInfo(*args
, **kwargs
)
1612 def IsFixedWidth(*args
, **kwargs
):
1614 IsFixedWidth(self) -> bool
1616 Returns true if the font is a fixed width (or monospaced) font, false
1617 if it is a proportional one or font is invalid.
1619 return _gdi_
.Font_IsFixedWidth(*args
, **kwargs
)
1621 def GetNativeFontInfoDesc(*args
, **kwargs
):
1623 GetNativeFontInfoDesc(self) -> String
1625 Returns the platform-dependent string completely describing this font
1626 or an empty string if the font isn't valid.
1628 return _gdi_
.Font_GetNativeFontInfoDesc(*args
, **kwargs
)
1630 def GetNativeFontInfoUserDesc(*args
, **kwargs
):
1632 GetNativeFontInfoUserDesc(self) -> String
1634 Returns a human readable version of `GetNativeFontInfoDesc`.
1636 return _gdi_
.Font_GetNativeFontInfoUserDesc(*args
, **kwargs
)
1638 def SetPointSize(*args
, **kwargs
):
1640 SetPointSize(self, int pointSize)
1642 Sets the point size.
1644 return _gdi_
.Font_SetPointSize(*args
, **kwargs
)
1646 def SetPixelSize(*args
, **kwargs
):
1648 SetPixelSize(self, Size pixelSize)
1650 Sets the size in pixels rather than points. If there is platform API
1651 support for this then it is used, otherwise a font with the closest
1652 size is found using a binary search.
1654 return _gdi_
.Font_SetPixelSize(*args
, **kwargs
)
1656 def SetFamily(*args
, **kwargs
):
1658 SetFamily(self, int family)
1660 Sets the font family.
1662 return _gdi_
.Font_SetFamily(*args
, **kwargs
)
1664 def SetStyle(*args
, **kwargs
):
1666 SetStyle(self, int style)
1668 Sets the font style.
1670 return _gdi_
.Font_SetStyle(*args
, **kwargs
)
1672 def SetWeight(*args
, **kwargs
):
1674 SetWeight(self, int weight)
1676 Sets the font weight.
1678 return _gdi_
.Font_SetWeight(*args
, **kwargs
)
1680 def SetFaceName(*args
, **kwargs
):
1682 SetFaceName(self, String faceName)
1684 Sets the facename for the font. The facename, which should be a valid
1685 font installed on the end-user's system.
1687 To avoid portability problems, don't rely on a specific face, but
1688 specify the font family instead or as well. A suitable font will be
1689 found on the end-user's system. If both the family and the facename
1690 are specified, wxWidgets will first search for the specific face, and
1691 then for a font belonging to the same family.
1693 return _gdi_
.Font_SetFaceName(*args
, **kwargs
)
1695 def SetUnderlined(*args
, **kwargs
):
1697 SetUnderlined(self, bool underlined)
1701 return _gdi_
.Font_SetUnderlined(*args
, **kwargs
)
1703 def SetEncoding(*args
, **kwargs
):
1705 SetEncoding(self, int encoding)
1707 Set the font encoding.
1709 return _gdi_
.Font_SetEncoding(*args
, **kwargs
)
1711 def SetNativeFontInfo(*args
, **kwargs
):
1713 SetNativeFontInfo(self, NativeFontInfo info)
1715 Set the font's attributes from a `wx.NativeFontInfo` object.
1717 return _gdi_
.Font_SetNativeFontInfo(*args
, **kwargs
)
1719 def SetNativeFontInfoFromString(*args
, **kwargs
):
1721 SetNativeFontInfoFromString(self, String info)
1723 Set the font's attributes from string representation of a
1724 `wx.NativeFontInfo` object.
1726 return _gdi_
.Font_SetNativeFontInfoFromString(*args
, **kwargs
)
1728 def SetNativeFontInfoUserDesc(*args
, **kwargs
):
1730 SetNativeFontInfoUserDesc(self, String info)
1732 Set the font's attributes from a string formerly returned from
1733 `GetNativeFontInfoDesc`.
1735 return _gdi_
.Font_SetNativeFontInfoUserDesc(*args
, **kwargs
)
1737 def GetFamilyString(*args
, **kwargs
):
1739 GetFamilyString(self) -> String
1741 Returns a string representation of the font family.
1743 return _gdi_
.Font_GetFamilyString(*args
, **kwargs
)
1745 def GetStyleString(*args
, **kwargs
):
1747 GetStyleString(self) -> String
1749 Returns a string representation of the font style.
1751 return _gdi_
.Font_GetStyleString(*args
, **kwargs
)
1753 def GetWeightString(*args
, **kwargs
):
1755 GetWeightString(self) -> String
1757 Return a string representation of the font weight.
1759 return _gdi_
.Font_GetWeightString(*args
, **kwargs
)
1761 def SetNoAntiAliasing(*args
, **kwargs
):
1762 """SetNoAntiAliasing(self, bool no=True)"""
1763 return _gdi_
.Font_SetNoAntiAliasing(*args
, **kwargs
)
1765 def GetNoAntiAliasing(*args
, **kwargs
):
1766 """GetNoAntiAliasing(self) -> bool"""
1767 return _gdi_
.Font_GetNoAntiAliasing(*args
, **kwargs
)
1769 def GetDefaultEncoding(*args
, **kwargs
):
1771 GetDefaultEncoding() -> int
1773 Returns the encoding used for all fonts created with an encoding of
1774 ``wx.FONTENCODING_DEFAULT``.
1776 return _gdi_
.Font_GetDefaultEncoding(*args
, **kwargs
)
1778 GetDefaultEncoding
= staticmethod(GetDefaultEncoding
)
1779 def SetDefaultEncoding(*args
, **kwargs
):
1781 SetDefaultEncoding(int encoding)
1783 Sets the default font encoding.
1785 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
1787 SetDefaultEncoding
= staticmethod(SetDefaultEncoding
)
1788 _gdi_
.Font_swigregister(Font
)
1790 def FontFromNativeInfo(*args
, **kwargs
):
1792 FontFromNativeInfo(NativeFontInfo info) -> Font
1794 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
1796 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1797 val
= _gdi_
.new_FontFromNativeInfo(*args
, **kwargs
)
1800 def FontFromNativeInfoString(*args
, **kwargs
):
1802 FontFromNativeInfoString(String info) -> Font
1804 Construct a `wx.Font` from the string representation of a
1805 `wx.NativeFontInfo` object.
1807 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1808 val
= _gdi_
.new_FontFromNativeInfoString(*args
, **kwargs
)
1811 def FFont(*args
, **kwargs
):
1813 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
1814 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
1816 A bit of a simpler way to create a `wx.Font` using flags instead of
1817 individual attribute settings. The value of flags can be a
1818 combination of the following:
1820 ============================ ==
1826 wx.FONTFLAG_ANTIALIASED
1827 wx.FONTFLAG_NOT_ANTIALIASED
1828 wx.FONTFLAG_UNDERLINED
1829 wx.FONTFLAG_STRIKETHROUGH
1830 ============================ ==
1832 :see: `wx.Font.__init__`
1834 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1835 val
= _gdi_
.new_FFont(*args
, **kwargs
)
1838 def FontFromPixelSize(*args
, **kwargs
):
1840 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
1841 bool underlined=False, String face=wxEmptyString,
1842 int encoding=FONTENCODING_DEFAULT) -> Font
1844 Creates a font using a size in pixels rather than points. If there is
1845 platform API support for this then it is used, otherwise a font with
1846 the closest size is found using a binary search.
1848 :see: `wx.Font.__init__`
1850 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1851 val
= _gdi_
.new_FontFromPixelSize(*args
, **kwargs
)
1854 def FFontFromPixelSize(*args
, **kwargs
):
1856 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
1857 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
1859 Creates a font using a size in pixels rather than points. If there is
1860 platform API support for this then it is used, otherwise a font with
1861 the closest size is found using a binary search.
1863 :see: `wx.Font.__init__`, `wx.FFont`
1865 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1866 val
= _gdi_
.new_FFontFromPixelSize(*args
, **kwargs
)
1869 def Font_GetDefaultEncoding(*args
):
1871 Font_GetDefaultEncoding() -> int
1873 Returns the encoding used for all fonts created with an encoding of
1874 ``wx.FONTENCODING_DEFAULT``.
1876 return _gdi_
.Font_GetDefaultEncoding(*args
)
1878 def Font_SetDefaultEncoding(*args
, **kwargs
):
1880 Font_SetDefaultEncoding(int encoding)
1882 Sets the default font encoding.
1884 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
1886 Font2
= wx
._deprecated
(FFont
, "Use `wx.FFont` instead.")
1887 #---------------------------------------------------------------------------
1889 class FontEnumerator(object):
1890 """Proxy of C++ FontEnumerator class"""
1891 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1892 __repr__
= _swig_repr
1893 def __init__(self
, *args
, **kwargs
):
1894 """__init__(self) -> FontEnumerator"""
1895 _gdi_
.FontEnumerator_swiginit(self
,_gdi_
.new_FontEnumerator(*args
, **kwargs
))
1896 self
._setCallbackInfo
(self
, FontEnumerator
, 0)
1898 __swig_destroy__
= _gdi_
.delete_FontEnumerator
1899 __del__
= lambda self
: None;
1900 def _setCallbackInfo(*args
, **kwargs
):
1901 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
1902 return _gdi_
.FontEnumerator__setCallbackInfo(*args
, **kwargs
)
1904 def EnumerateFacenames(*args
, **kwargs
):
1905 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
1906 return _gdi_
.FontEnumerator_EnumerateFacenames(*args
, **kwargs
)
1908 def EnumerateEncodings(*args
, **kwargs
):
1909 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
1910 return _gdi_
.FontEnumerator_EnumerateEncodings(*args
, **kwargs
)
1912 def GetEncodings(*args
, **kwargs
):
1913 """GetEncodings(self) -> PyObject"""
1914 return _gdi_
.FontEnumerator_GetEncodings(*args
, **kwargs
)
1916 def GetFacenames(*args
, **kwargs
):
1917 """GetFacenames(self) -> PyObject"""
1918 return _gdi_
.FontEnumerator_GetFacenames(*args
, **kwargs
)
1920 _gdi_
.FontEnumerator_swigregister(FontEnumerator
)
1922 #---------------------------------------------------------------------------
1924 LANGUAGE_DEFAULT
= _gdi_
.LANGUAGE_DEFAULT
1925 LANGUAGE_UNKNOWN
= _gdi_
.LANGUAGE_UNKNOWN
1926 LANGUAGE_ABKHAZIAN
= _gdi_
.LANGUAGE_ABKHAZIAN
1927 LANGUAGE_AFAR
= _gdi_
.LANGUAGE_AFAR
1928 LANGUAGE_AFRIKAANS
= _gdi_
.LANGUAGE_AFRIKAANS
1929 LANGUAGE_ALBANIAN
= _gdi_
.LANGUAGE_ALBANIAN
1930 LANGUAGE_AMHARIC
= _gdi_
.LANGUAGE_AMHARIC
1931 LANGUAGE_ARABIC
= _gdi_
.LANGUAGE_ARABIC
1932 LANGUAGE_ARABIC_ALGERIA
= _gdi_
.LANGUAGE_ARABIC_ALGERIA
1933 LANGUAGE_ARABIC_BAHRAIN
= _gdi_
.LANGUAGE_ARABIC_BAHRAIN
1934 LANGUAGE_ARABIC_EGYPT
= _gdi_
.LANGUAGE_ARABIC_EGYPT
1935 LANGUAGE_ARABIC_IRAQ
= _gdi_
.LANGUAGE_ARABIC_IRAQ
1936 LANGUAGE_ARABIC_JORDAN
= _gdi_
.LANGUAGE_ARABIC_JORDAN
1937 LANGUAGE_ARABIC_KUWAIT
= _gdi_
.LANGUAGE_ARABIC_KUWAIT
1938 LANGUAGE_ARABIC_LEBANON
= _gdi_
.LANGUAGE_ARABIC_LEBANON
1939 LANGUAGE_ARABIC_LIBYA
= _gdi_
.LANGUAGE_ARABIC_LIBYA
1940 LANGUAGE_ARABIC_MOROCCO
= _gdi_
.LANGUAGE_ARABIC_MOROCCO
1941 LANGUAGE_ARABIC_OMAN
= _gdi_
.LANGUAGE_ARABIC_OMAN
1942 LANGUAGE_ARABIC_QATAR
= _gdi_
.LANGUAGE_ARABIC_QATAR
1943 LANGUAGE_ARABIC_SAUDI_ARABIA
= _gdi_
.LANGUAGE_ARABIC_SAUDI_ARABIA
1944 LANGUAGE_ARABIC_SUDAN
= _gdi_
.LANGUAGE_ARABIC_SUDAN
1945 LANGUAGE_ARABIC_SYRIA
= _gdi_
.LANGUAGE_ARABIC_SYRIA
1946 LANGUAGE_ARABIC_TUNISIA
= _gdi_
.LANGUAGE_ARABIC_TUNISIA
1947 LANGUAGE_ARABIC_UAE
= _gdi_
.LANGUAGE_ARABIC_UAE
1948 LANGUAGE_ARABIC_YEMEN
= _gdi_
.LANGUAGE_ARABIC_YEMEN
1949 LANGUAGE_ARMENIAN
= _gdi_
.LANGUAGE_ARMENIAN
1950 LANGUAGE_ASSAMESE
= _gdi_
.LANGUAGE_ASSAMESE
1951 LANGUAGE_AYMARA
= _gdi_
.LANGUAGE_AYMARA
1952 LANGUAGE_AZERI
= _gdi_
.LANGUAGE_AZERI
1953 LANGUAGE_AZERI_CYRILLIC
= _gdi_
.LANGUAGE_AZERI_CYRILLIC
1954 LANGUAGE_AZERI_LATIN
= _gdi_
.LANGUAGE_AZERI_LATIN
1955 LANGUAGE_BASHKIR
= _gdi_
.LANGUAGE_BASHKIR
1956 LANGUAGE_BASQUE
= _gdi_
.LANGUAGE_BASQUE
1957 LANGUAGE_BELARUSIAN
= _gdi_
.LANGUAGE_BELARUSIAN
1958 LANGUAGE_BENGALI
= _gdi_
.LANGUAGE_BENGALI
1959 LANGUAGE_BHUTANI
= _gdi_
.LANGUAGE_BHUTANI
1960 LANGUAGE_BIHARI
= _gdi_
.LANGUAGE_BIHARI
1961 LANGUAGE_BISLAMA
= _gdi_
.LANGUAGE_BISLAMA
1962 LANGUAGE_BRETON
= _gdi_
.LANGUAGE_BRETON
1963 LANGUAGE_BULGARIAN
= _gdi_
.LANGUAGE_BULGARIAN
1964 LANGUAGE_BURMESE
= _gdi_
.LANGUAGE_BURMESE
1965 LANGUAGE_CAMBODIAN
= _gdi_
.LANGUAGE_CAMBODIAN
1966 LANGUAGE_CATALAN
= _gdi_
.LANGUAGE_CATALAN
1967 LANGUAGE_CHINESE
= _gdi_
.LANGUAGE_CHINESE
1968 LANGUAGE_CHINESE_SIMPLIFIED
= _gdi_
.LANGUAGE_CHINESE_SIMPLIFIED
1969 LANGUAGE_CHINESE_TRADITIONAL
= _gdi_
.LANGUAGE_CHINESE_TRADITIONAL
1970 LANGUAGE_CHINESE_HONGKONG
= _gdi_
.LANGUAGE_CHINESE_HONGKONG
1971 LANGUAGE_CHINESE_MACAU
= _gdi_
.LANGUAGE_CHINESE_MACAU
1972 LANGUAGE_CHINESE_SINGAPORE
= _gdi_
.LANGUAGE_CHINESE_SINGAPORE
1973 LANGUAGE_CHINESE_TAIWAN
= _gdi_
.LANGUAGE_CHINESE_TAIWAN
1974 LANGUAGE_CORSICAN
= _gdi_
.LANGUAGE_CORSICAN
1975 LANGUAGE_CROATIAN
= _gdi_
.LANGUAGE_CROATIAN
1976 LANGUAGE_CZECH
= _gdi_
.LANGUAGE_CZECH
1977 LANGUAGE_DANISH
= _gdi_
.LANGUAGE_DANISH
1978 LANGUAGE_DUTCH
= _gdi_
.LANGUAGE_DUTCH
1979 LANGUAGE_DUTCH_BELGIAN
= _gdi_
.LANGUAGE_DUTCH_BELGIAN
1980 LANGUAGE_ENGLISH
= _gdi_
.LANGUAGE_ENGLISH
1981 LANGUAGE_ENGLISH_UK
= _gdi_
.LANGUAGE_ENGLISH_UK
1982 LANGUAGE_ENGLISH_US
= _gdi_
.LANGUAGE_ENGLISH_US
1983 LANGUAGE_ENGLISH_AUSTRALIA
= _gdi_
.LANGUAGE_ENGLISH_AUSTRALIA
1984 LANGUAGE_ENGLISH_BELIZE
= _gdi_
.LANGUAGE_ENGLISH_BELIZE
1985 LANGUAGE_ENGLISH_BOTSWANA
= _gdi_
.LANGUAGE_ENGLISH_BOTSWANA
1986 LANGUAGE_ENGLISH_CANADA
= _gdi_
.LANGUAGE_ENGLISH_CANADA
1987 LANGUAGE_ENGLISH_CARIBBEAN
= _gdi_
.LANGUAGE_ENGLISH_CARIBBEAN
1988 LANGUAGE_ENGLISH_DENMARK
= _gdi_
.LANGUAGE_ENGLISH_DENMARK
1989 LANGUAGE_ENGLISH_EIRE
= _gdi_
.LANGUAGE_ENGLISH_EIRE
1990 LANGUAGE_ENGLISH_JAMAICA
= _gdi_
.LANGUAGE_ENGLISH_JAMAICA
1991 LANGUAGE_ENGLISH_NEW_ZEALAND
= _gdi_
.LANGUAGE_ENGLISH_NEW_ZEALAND
1992 LANGUAGE_ENGLISH_PHILIPPINES
= _gdi_
.LANGUAGE_ENGLISH_PHILIPPINES
1993 LANGUAGE_ENGLISH_SOUTH_AFRICA
= _gdi_
.LANGUAGE_ENGLISH_SOUTH_AFRICA
1994 LANGUAGE_ENGLISH_TRINIDAD
= _gdi_
.LANGUAGE_ENGLISH_TRINIDAD
1995 LANGUAGE_ENGLISH_ZIMBABWE
= _gdi_
.LANGUAGE_ENGLISH_ZIMBABWE
1996 LANGUAGE_ESPERANTO
= _gdi_
.LANGUAGE_ESPERANTO
1997 LANGUAGE_ESTONIAN
= _gdi_
.LANGUAGE_ESTONIAN
1998 LANGUAGE_FAEROESE
= _gdi_
.LANGUAGE_FAEROESE
1999 LANGUAGE_FARSI
= _gdi_
.LANGUAGE_FARSI
2000 LANGUAGE_FIJI
= _gdi_
.LANGUAGE_FIJI
2001 LANGUAGE_FINNISH
= _gdi_
.LANGUAGE_FINNISH
2002 LANGUAGE_FRENCH
= _gdi_
.LANGUAGE_FRENCH
2003 LANGUAGE_FRENCH_BELGIAN
= _gdi_
.LANGUAGE_FRENCH_BELGIAN
2004 LANGUAGE_FRENCH_CANADIAN
= _gdi_
.LANGUAGE_FRENCH_CANADIAN
2005 LANGUAGE_FRENCH_LUXEMBOURG
= _gdi_
.LANGUAGE_FRENCH_LUXEMBOURG
2006 LANGUAGE_FRENCH_MONACO
= _gdi_
.LANGUAGE_FRENCH_MONACO
2007 LANGUAGE_FRENCH_SWISS
= _gdi_
.LANGUAGE_FRENCH_SWISS
2008 LANGUAGE_FRISIAN
= _gdi_
.LANGUAGE_FRISIAN
2009 LANGUAGE_GALICIAN
= _gdi_
.LANGUAGE_GALICIAN
2010 LANGUAGE_GEORGIAN
= _gdi_
.LANGUAGE_GEORGIAN
2011 LANGUAGE_GERMAN
= _gdi_
.LANGUAGE_GERMAN
2012 LANGUAGE_GERMAN_AUSTRIAN
= _gdi_
.LANGUAGE_GERMAN_AUSTRIAN
2013 LANGUAGE_GERMAN_BELGIUM
= _gdi_
.LANGUAGE_GERMAN_BELGIUM
2014 LANGUAGE_GERMAN_LIECHTENSTEIN
= _gdi_
.LANGUAGE_GERMAN_LIECHTENSTEIN
2015 LANGUAGE_GERMAN_LUXEMBOURG
= _gdi_
.LANGUAGE_GERMAN_LUXEMBOURG
2016 LANGUAGE_GERMAN_SWISS
= _gdi_
.LANGUAGE_GERMAN_SWISS
2017 LANGUAGE_GREEK
= _gdi_
.LANGUAGE_GREEK
2018 LANGUAGE_GREENLANDIC
= _gdi_
.LANGUAGE_GREENLANDIC
2019 LANGUAGE_GUARANI
= _gdi_
.LANGUAGE_GUARANI
2020 LANGUAGE_GUJARATI
= _gdi_
.LANGUAGE_GUJARATI
2021 LANGUAGE_HAUSA
= _gdi_
.LANGUAGE_HAUSA
2022 LANGUAGE_HEBREW
= _gdi_
.LANGUAGE_HEBREW
2023 LANGUAGE_HINDI
= _gdi_
.LANGUAGE_HINDI
2024 LANGUAGE_HUNGARIAN
= _gdi_
.LANGUAGE_HUNGARIAN
2025 LANGUAGE_ICELANDIC
= _gdi_
.LANGUAGE_ICELANDIC
2026 LANGUAGE_INDONESIAN
= _gdi_
.LANGUAGE_INDONESIAN
2027 LANGUAGE_INTERLINGUA
= _gdi_
.LANGUAGE_INTERLINGUA
2028 LANGUAGE_INTERLINGUE
= _gdi_
.LANGUAGE_INTERLINGUE
2029 LANGUAGE_INUKTITUT
= _gdi_
.LANGUAGE_INUKTITUT
2030 LANGUAGE_INUPIAK
= _gdi_
.LANGUAGE_INUPIAK
2031 LANGUAGE_IRISH
= _gdi_
.LANGUAGE_IRISH
2032 LANGUAGE_ITALIAN
= _gdi_
.LANGUAGE_ITALIAN
2033 LANGUAGE_ITALIAN_SWISS
= _gdi_
.LANGUAGE_ITALIAN_SWISS
2034 LANGUAGE_JAPANESE
= _gdi_
.LANGUAGE_JAPANESE
2035 LANGUAGE_JAVANESE
= _gdi_
.LANGUAGE_JAVANESE
2036 LANGUAGE_KANNADA
= _gdi_
.LANGUAGE_KANNADA
2037 LANGUAGE_KASHMIRI
= _gdi_
.LANGUAGE_KASHMIRI
2038 LANGUAGE_KASHMIRI_INDIA
= _gdi_
.LANGUAGE_KASHMIRI_INDIA
2039 LANGUAGE_KAZAKH
= _gdi_
.LANGUAGE_KAZAKH
2040 LANGUAGE_KERNEWEK
= _gdi_
.LANGUAGE_KERNEWEK
2041 LANGUAGE_KINYARWANDA
= _gdi_
.LANGUAGE_KINYARWANDA
2042 LANGUAGE_KIRGHIZ
= _gdi_
.LANGUAGE_KIRGHIZ
2043 LANGUAGE_KIRUNDI
= _gdi_
.LANGUAGE_KIRUNDI
2044 LANGUAGE_KONKANI
= _gdi_
.LANGUAGE_KONKANI
2045 LANGUAGE_KOREAN
= _gdi_
.LANGUAGE_KOREAN
2046 LANGUAGE_KURDISH
= _gdi_
.LANGUAGE_KURDISH
2047 LANGUAGE_LAOTHIAN
= _gdi_
.LANGUAGE_LAOTHIAN
2048 LANGUAGE_LATIN
= _gdi_
.LANGUAGE_LATIN
2049 LANGUAGE_LATVIAN
= _gdi_
.LANGUAGE_LATVIAN
2050 LANGUAGE_LINGALA
= _gdi_
.LANGUAGE_LINGALA
2051 LANGUAGE_LITHUANIAN
= _gdi_
.LANGUAGE_LITHUANIAN
2052 LANGUAGE_MACEDONIAN
= _gdi_
.LANGUAGE_MACEDONIAN
2053 LANGUAGE_MALAGASY
= _gdi_
.LANGUAGE_MALAGASY
2054 LANGUAGE_MALAY
= _gdi_
.LANGUAGE_MALAY
2055 LANGUAGE_MALAYALAM
= _gdi_
.LANGUAGE_MALAYALAM
2056 LANGUAGE_MALAY_BRUNEI_DARUSSALAM
= _gdi_
.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2057 LANGUAGE_MALAY_MALAYSIA
= _gdi_
.LANGUAGE_MALAY_MALAYSIA
2058 LANGUAGE_MALTESE
= _gdi_
.LANGUAGE_MALTESE
2059 LANGUAGE_MANIPURI
= _gdi_
.LANGUAGE_MANIPURI
2060 LANGUAGE_MAORI
= _gdi_
.LANGUAGE_MAORI
2061 LANGUAGE_MARATHI
= _gdi_
.LANGUAGE_MARATHI
2062 LANGUAGE_MOLDAVIAN
= _gdi_
.LANGUAGE_MOLDAVIAN
2063 LANGUAGE_MONGOLIAN
= _gdi_
.LANGUAGE_MONGOLIAN
2064 LANGUAGE_NAURU
= _gdi_
.LANGUAGE_NAURU
2065 LANGUAGE_NEPALI
= _gdi_
.LANGUAGE_NEPALI
2066 LANGUAGE_NEPALI_INDIA
= _gdi_
.LANGUAGE_NEPALI_INDIA
2067 LANGUAGE_NORWEGIAN_BOKMAL
= _gdi_
.LANGUAGE_NORWEGIAN_BOKMAL
2068 LANGUAGE_NORWEGIAN_NYNORSK
= _gdi_
.LANGUAGE_NORWEGIAN_NYNORSK
2069 LANGUAGE_OCCITAN
= _gdi_
.LANGUAGE_OCCITAN
2070 LANGUAGE_ORIYA
= _gdi_
.LANGUAGE_ORIYA
2071 LANGUAGE_OROMO
= _gdi_
.LANGUAGE_OROMO
2072 LANGUAGE_PASHTO
= _gdi_
.LANGUAGE_PASHTO
2073 LANGUAGE_POLISH
= _gdi_
.LANGUAGE_POLISH
2074 LANGUAGE_PORTUGUESE
= _gdi_
.LANGUAGE_PORTUGUESE
2075 LANGUAGE_PORTUGUESE_BRAZILIAN
= _gdi_
.LANGUAGE_PORTUGUESE_BRAZILIAN
2076 LANGUAGE_PUNJABI
= _gdi_
.LANGUAGE_PUNJABI
2077 LANGUAGE_QUECHUA
= _gdi_
.LANGUAGE_QUECHUA
2078 LANGUAGE_RHAETO_ROMANCE
= _gdi_
.LANGUAGE_RHAETO_ROMANCE
2079 LANGUAGE_ROMANIAN
= _gdi_
.LANGUAGE_ROMANIAN
2080 LANGUAGE_RUSSIAN
= _gdi_
.LANGUAGE_RUSSIAN
2081 LANGUAGE_RUSSIAN_UKRAINE
= _gdi_
.LANGUAGE_RUSSIAN_UKRAINE
2082 LANGUAGE_SAMOAN
= _gdi_
.LANGUAGE_SAMOAN
2083 LANGUAGE_SANGHO
= _gdi_
.LANGUAGE_SANGHO
2084 LANGUAGE_SANSKRIT
= _gdi_
.LANGUAGE_SANSKRIT
2085 LANGUAGE_SCOTS_GAELIC
= _gdi_
.LANGUAGE_SCOTS_GAELIC
2086 LANGUAGE_SERBIAN
= _gdi_
.LANGUAGE_SERBIAN
2087 LANGUAGE_SERBIAN_CYRILLIC
= _gdi_
.LANGUAGE_SERBIAN_CYRILLIC
2088 LANGUAGE_SERBIAN_LATIN
= _gdi_
.LANGUAGE_SERBIAN_LATIN
2089 LANGUAGE_SERBO_CROATIAN
= _gdi_
.LANGUAGE_SERBO_CROATIAN
2090 LANGUAGE_SESOTHO
= _gdi_
.LANGUAGE_SESOTHO
2091 LANGUAGE_SETSWANA
= _gdi_
.LANGUAGE_SETSWANA
2092 LANGUAGE_SHONA
= _gdi_
.LANGUAGE_SHONA
2093 LANGUAGE_SINDHI
= _gdi_
.LANGUAGE_SINDHI
2094 LANGUAGE_SINHALESE
= _gdi_
.LANGUAGE_SINHALESE
2095 LANGUAGE_SISWATI
= _gdi_
.LANGUAGE_SISWATI
2096 LANGUAGE_SLOVAK
= _gdi_
.LANGUAGE_SLOVAK
2097 LANGUAGE_SLOVENIAN
= _gdi_
.LANGUAGE_SLOVENIAN
2098 LANGUAGE_SOMALI
= _gdi_
.LANGUAGE_SOMALI
2099 LANGUAGE_SPANISH
= _gdi_
.LANGUAGE_SPANISH
2100 LANGUAGE_SPANISH_ARGENTINA
= _gdi_
.LANGUAGE_SPANISH_ARGENTINA
2101 LANGUAGE_SPANISH_BOLIVIA
= _gdi_
.LANGUAGE_SPANISH_BOLIVIA
2102 LANGUAGE_SPANISH_CHILE
= _gdi_
.LANGUAGE_SPANISH_CHILE
2103 LANGUAGE_SPANISH_COLOMBIA
= _gdi_
.LANGUAGE_SPANISH_COLOMBIA
2104 LANGUAGE_SPANISH_COSTA_RICA
= _gdi_
.LANGUAGE_SPANISH_COSTA_RICA
2105 LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
= _gdi_
.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2106 LANGUAGE_SPANISH_ECUADOR
= _gdi_
.LANGUAGE_SPANISH_ECUADOR
2107 LANGUAGE_SPANISH_EL_SALVADOR
= _gdi_
.LANGUAGE_SPANISH_EL_SALVADOR
2108 LANGUAGE_SPANISH_GUATEMALA
= _gdi_
.LANGUAGE_SPANISH_GUATEMALA
2109 LANGUAGE_SPANISH_HONDURAS
= _gdi_
.LANGUAGE_SPANISH_HONDURAS
2110 LANGUAGE_SPANISH_MEXICAN
= _gdi_
.LANGUAGE_SPANISH_MEXICAN
2111 LANGUAGE_SPANISH_MODERN
= _gdi_
.LANGUAGE_SPANISH_MODERN
2112 LANGUAGE_SPANISH_NICARAGUA
= _gdi_
.LANGUAGE_SPANISH_NICARAGUA
2113 LANGUAGE_SPANISH_PANAMA
= _gdi_
.LANGUAGE_SPANISH_PANAMA
2114 LANGUAGE_SPANISH_PARAGUAY
= _gdi_
.LANGUAGE_SPANISH_PARAGUAY
2115 LANGUAGE_SPANISH_PERU
= _gdi_
.LANGUAGE_SPANISH_PERU
2116 LANGUAGE_SPANISH_PUERTO_RICO
= _gdi_
.LANGUAGE_SPANISH_PUERTO_RICO
2117 LANGUAGE_SPANISH_URUGUAY
= _gdi_
.LANGUAGE_SPANISH_URUGUAY
2118 LANGUAGE_SPANISH_US
= _gdi_
.LANGUAGE_SPANISH_US
2119 LANGUAGE_SPANISH_VENEZUELA
= _gdi_
.LANGUAGE_SPANISH_VENEZUELA
2120 LANGUAGE_SUNDANESE
= _gdi_
.LANGUAGE_SUNDANESE
2121 LANGUAGE_SWAHILI
= _gdi_
.LANGUAGE_SWAHILI
2122 LANGUAGE_SWEDISH
= _gdi_
.LANGUAGE_SWEDISH
2123 LANGUAGE_SWEDISH_FINLAND
= _gdi_
.LANGUAGE_SWEDISH_FINLAND
2124 LANGUAGE_TAGALOG
= _gdi_
.LANGUAGE_TAGALOG
2125 LANGUAGE_TAJIK
= _gdi_
.LANGUAGE_TAJIK
2126 LANGUAGE_TAMIL
= _gdi_
.LANGUAGE_TAMIL
2127 LANGUAGE_TATAR
= _gdi_
.LANGUAGE_TATAR
2128 LANGUAGE_TELUGU
= _gdi_
.LANGUAGE_TELUGU
2129 LANGUAGE_THAI
= _gdi_
.LANGUAGE_THAI
2130 LANGUAGE_TIBETAN
= _gdi_
.LANGUAGE_TIBETAN
2131 LANGUAGE_TIGRINYA
= _gdi_
.LANGUAGE_TIGRINYA
2132 LANGUAGE_TONGA
= _gdi_
.LANGUAGE_TONGA
2133 LANGUAGE_TSONGA
= _gdi_
.LANGUAGE_TSONGA
2134 LANGUAGE_TURKISH
= _gdi_
.LANGUAGE_TURKISH
2135 LANGUAGE_TURKMEN
= _gdi_
.LANGUAGE_TURKMEN
2136 LANGUAGE_TWI
= _gdi_
.LANGUAGE_TWI
2137 LANGUAGE_UIGHUR
= _gdi_
.LANGUAGE_UIGHUR
2138 LANGUAGE_UKRAINIAN
= _gdi_
.LANGUAGE_UKRAINIAN
2139 LANGUAGE_URDU
= _gdi_
.LANGUAGE_URDU
2140 LANGUAGE_URDU_INDIA
= _gdi_
.LANGUAGE_URDU_INDIA
2141 LANGUAGE_URDU_PAKISTAN
= _gdi_
.LANGUAGE_URDU_PAKISTAN
2142 LANGUAGE_UZBEK
= _gdi_
.LANGUAGE_UZBEK
2143 LANGUAGE_UZBEK_CYRILLIC
= _gdi_
.LANGUAGE_UZBEK_CYRILLIC
2144 LANGUAGE_UZBEK_LATIN
= _gdi_
.LANGUAGE_UZBEK_LATIN
2145 LANGUAGE_VIETNAMESE
= _gdi_
.LANGUAGE_VIETNAMESE
2146 LANGUAGE_VOLAPUK
= _gdi_
.LANGUAGE_VOLAPUK
2147 LANGUAGE_WELSH
= _gdi_
.LANGUAGE_WELSH
2148 LANGUAGE_WOLOF
= _gdi_
.LANGUAGE_WOLOF
2149 LANGUAGE_XHOSA
= _gdi_
.LANGUAGE_XHOSA
2150 LANGUAGE_YIDDISH
= _gdi_
.LANGUAGE_YIDDISH
2151 LANGUAGE_YORUBA
= _gdi_
.LANGUAGE_YORUBA
2152 LANGUAGE_ZHUANG
= _gdi_
.LANGUAGE_ZHUANG
2153 LANGUAGE_ZULU
= _gdi_
.LANGUAGE_ZULU
2154 LANGUAGE_USER_DEFINED
= _gdi_
.LANGUAGE_USER_DEFINED
2155 class LanguageInfo(object):
2156 """Proxy of C++ LanguageInfo class"""
2157 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2158 def __init__(self
): raise AttributeError, "No constructor defined"
2159 __repr__
= _swig_repr
2160 Language
= property(_gdi_
.LanguageInfo_Language_get
, _gdi_
.LanguageInfo_Language_set
)
2161 CanonicalName
= property(_gdi_
.LanguageInfo_CanonicalName_get
, _gdi_
.LanguageInfo_CanonicalName_set
)
2162 Description
= property(_gdi_
.LanguageInfo_Description_get
, _gdi_
.LanguageInfo_Description_set
)
2163 _gdi_
.LanguageInfo_swigregister(LanguageInfo
)
2165 LOCALE_CAT_NUMBER
= _gdi_
.LOCALE_CAT_NUMBER
2166 LOCALE_CAT_DATE
= _gdi_
.LOCALE_CAT_DATE
2167 LOCALE_CAT_MONEY
= _gdi_
.LOCALE_CAT_MONEY
2168 LOCALE_CAT_MAX
= _gdi_
.LOCALE_CAT_MAX
2169 LOCALE_THOUSANDS_SEP
= _gdi_
.LOCALE_THOUSANDS_SEP
2170 LOCALE_DECIMAL_POINT
= _gdi_
.LOCALE_DECIMAL_POINT
2171 LOCALE_LOAD_DEFAULT
= _gdi_
.LOCALE_LOAD_DEFAULT
2172 LOCALE_CONV_ENCODING
= _gdi_
.LOCALE_CONV_ENCODING
2173 class Locale(object):
2174 """Proxy of C++ Locale class"""
2175 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2176 __repr__
= _swig_repr
2177 def __init__(self
, *args
, **kwargs
):
2178 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
2179 _gdi_
.Locale_swiginit(self
,_gdi_
.new_Locale(*args
, **kwargs
))
2180 __swig_destroy__
= _gdi_
.delete_Locale
2181 __del__
= lambda self
: None;
2182 def Init1(*args
, **kwargs
):
2184 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2185 bool bLoadDefault=True,
2186 bool bConvertEncoding=False) -> bool
2188 return _gdi_
.Locale_Init1(*args
, **kwargs
)
2190 def Init2(*args
, **kwargs
):
2191 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2192 return _gdi_
.Locale_Init2(*args
, **kwargs
)
2194 def Init(self
, *_args
, **_kwargs
):
2195 if type(_args
[0]) in [type(''), type(u
'')]:
2196 val
= self
.Init1(*_args
, **_kwargs
)
2198 val
= self
.Init2(*_args
, **_kwargs
)
2201 def GetSystemLanguage(*args
, **kwargs
):
2202 """GetSystemLanguage() -> int"""
2203 return _gdi_
.Locale_GetSystemLanguage(*args
, **kwargs
)
2205 GetSystemLanguage
= staticmethod(GetSystemLanguage
)
2206 def GetSystemEncoding(*args
, **kwargs
):
2207 """GetSystemEncoding() -> int"""
2208 return _gdi_
.Locale_GetSystemEncoding(*args
, **kwargs
)
2210 GetSystemEncoding
= staticmethod(GetSystemEncoding
)
2211 def GetSystemEncodingName(*args
, **kwargs
):
2212 """GetSystemEncodingName() -> String"""
2213 return _gdi_
.Locale_GetSystemEncodingName(*args
, **kwargs
)
2215 GetSystemEncodingName
= staticmethod(GetSystemEncodingName
)
2216 def IsOk(*args
, **kwargs
):
2217 """IsOk(self) -> bool"""
2218 return _gdi_
.Locale_IsOk(*args
, **kwargs
)
2220 def __nonzero__(self
): return self
.IsOk()
2221 def GetLocale(*args
, **kwargs
):
2222 """GetLocale(self) -> String"""
2223 return _gdi_
.Locale_GetLocale(*args
, **kwargs
)
2225 def GetLanguage(*args
, **kwargs
):
2226 """GetLanguage(self) -> int"""
2227 return _gdi_
.Locale_GetLanguage(*args
, **kwargs
)
2229 def GetSysName(*args
, **kwargs
):
2230 """GetSysName(self) -> String"""
2231 return _gdi_
.Locale_GetSysName(*args
, **kwargs
)
2233 def GetCanonicalName(*args
, **kwargs
):
2234 """GetCanonicalName(self) -> String"""
2235 return _gdi_
.Locale_GetCanonicalName(*args
, **kwargs
)
2237 def AddCatalogLookupPathPrefix(*args
, **kwargs
):
2238 """AddCatalogLookupPathPrefix(String prefix)"""
2239 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2241 AddCatalogLookupPathPrefix
= staticmethod(AddCatalogLookupPathPrefix
)
2242 def AddCatalog(*args
, **kwargs
):
2243 """AddCatalog(self, String szDomain) -> bool"""
2244 return _gdi_
.Locale_AddCatalog(*args
, **kwargs
)
2246 def IsLoaded(*args
, **kwargs
):
2247 """IsLoaded(self, String szDomain) -> bool"""
2248 return _gdi_
.Locale_IsLoaded(*args
, **kwargs
)
2250 def GetLanguageInfo(*args
, **kwargs
):
2251 """GetLanguageInfo(int lang) -> LanguageInfo"""
2252 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2254 GetLanguageInfo
= staticmethod(GetLanguageInfo
)
2255 def GetLanguageName(*args
, **kwargs
):
2256 """GetLanguageName(int lang) -> String"""
2257 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2259 GetLanguageName
= staticmethod(GetLanguageName
)
2260 def FindLanguageInfo(*args
, **kwargs
):
2261 """FindLanguageInfo(String locale) -> LanguageInfo"""
2262 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2264 FindLanguageInfo
= staticmethod(FindLanguageInfo
)
2265 def AddLanguage(*args
, **kwargs
):
2266 """AddLanguage(LanguageInfo info)"""
2267 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2269 AddLanguage
= staticmethod(AddLanguage
)
2270 def GetString(*args
, **kwargs
):
2271 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2272 return _gdi_
.Locale_GetString(*args
, **kwargs
)
2274 def GetName(*args
, **kwargs
):
2275 """GetName(self) -> String"""
2276 return _gdi_
.Locale_GetName(*args
, **kwargs
)
2278 _gdi_
.Locale_swigregister(Locale
)
2280 def Locale_GetSystemLanguage(*args
):
2281 """Locale_GetSystemLanguage() -> int"""
2282 return _gdi_
.Locale_GetSystemLanguage(*args
)
2284 def Locale_GetSystemEncoding(*args
):
2285 """Locale_GetSystemEncoding() -> int"""
2286 return _gdi_
.Locale_GetSystemEncoding(*args
)
2288 def Locale_GetSystemEncodingName(*args
):
2289 """Locale_GetSystemEncodingName() -> String"""
2290 return _gdi_
.Locale_GetSystemEncodingName(*args
)
2292 def Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
):
2293 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2294 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2296 def Locale_GetLanguageInfo(*args
, **kwargs
):
2297 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2298 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2300 def Locale_GetLanguageName(*args
, **kwargs
):
2301 """Locale_GetLanguageName(int lang) -> String"""
2302 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2304 def Locale_FindLanguageInfo(*args
, **kwargs
):
2305 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2306 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2308 def Locale_AddLanguage(*args
, **kwargs
):
2309 """Locale_AddLanguage(LanguageInfo info)"""
2310 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2313 def GetLocale(*args
):
2314 """GetLocale() -> Locale"""
2315 return _gdi_
.GetLocale(*args
)
2316 #---------------------------------------------------------------------------
2318 CONVERT_STRICT
= _gdi_
.CONVERT_STRICT
2319 CONVERT_SUBSTITUTE
= _gdi_
.CONVERT_SUBSTITUTE
2320 PLATFORM_CURRENT
= _gdi_
.PLATFORM_CURRENT
2321 PLATFORM_UNIX
= _gdi_
.PLATFORM_UNIX
2322 PLATFORM_WINDOWS
= _gdi_
.PLATFORM_WINDOWS
2323 PLATFORM_OS2
= _gdi_
.PLATFORM_OS2
2324 PLATFORM_MAC
= _gdi_
.PLATFORM_MAC
2325 class EncodingConverter(_core
.Object
):
2326 """Proxy of C++ EncodingConverter class"""
2327 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2328 __repr__
= _swig_repr
2329 def __init__(self
, *args
, **kwargs
):
2330 """__init__(self) -> EncodingConverter"""
2331 _gdi_
.EncodingConverter_swiginit(self
,_gdi_
.new_EncodingConverter(*args
, **kwargs
))
2332 __swig_destroy__
= _gdi_
.delete_EncodingConverter
2333 __del__
= lambda self
: None;
2334 def Init(*args
, **kwargs
):
2335 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2336 return _gdi_
.EncodingConverter_Init(*args
, **kwargs
)
2338 def Convert(*args
, **kwargs
):
2339 """Convert(self, String input) -> String"""
2340 return _gdi_
.EncodingConverter_Convert(*args
, **kwargs
)
2342 def GetPlatformEquivalents(*args
, **kwargs
):
2343 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2344 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2346 GetPlatformEquivalents
= staticmethod(GetPlatformEquivalents
)
2347 def GetAllEquivalents(*args
, **kwargs
):
2348 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2349 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2351 GetAllEquivalents
= staticmethod(GetAllEquivalents
)
2352 def CanConvert(*args
, **kwargs
):
2353 """CanConvert(int encIn, int encOut) -> bool"""
2354 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2356 CanConvert
= staticmethod(CanConvert
)
2357 def __nonzero__(self
): return self
.IsOk()
2358 _gdi_
.EncodingConverter_swigregister(EncodingConverter
)
2360 def GetTranslation(*args
):
2362 GetTranslation(String str) -> String
2363 GetTranslation(String str, String strPlural, size_t n) -> String
2365 return _gdi_
.GetTranslation(*args
)
2367 def EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
):
2368 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2369 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2371 def EncodingConverter_GetAllEquivalents(*args
, **kwargs
):
2372 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2373 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2375 def EncodingConverter_CanConvert(*args
, **kwargs
):
2376 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2377 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2379 #----------------------------------------------------------------------------
2380 # On MSW add the directory where the wxWidgets catalogs were installed
2381 # to the default catalog path.
2382 if wx
.Platform
== "__WXMSW__":
2384 _localedir
= os
.path
.join(os
.path
.split(__file__
)[0], "locale")
2385 Locale
.AddCatalogLookupPathPrefix(_localedir
)
2388 #----------------------------------------------------------------------------
2390 #---------------------------------------------------------------------------
2392 class DC(_core
.Object
):
2394 A wx.DC is a device context onto which graphics and text can be
2395 drawn. It is intended to represent a number of output devices in a
2396 generic way, so a window can have a device context associated with it,
2397 and a printer also has a device context. In this way, the same piece
2398 of code may write to a number of different devices, if the device
2399 context is used as a parameter.
2401 Derived types of wxDC have documentation for specific features only,
2402 so refer to this section for most device context information.
2404 The wx.DC class is abstract and can not be instantiated, you must use
2405 one of the derived classes instead. Which one will depend on the
2406 situation in which it is used.
2408 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2409 def __init__(self
): raise AttributeError, "No constructor defined"
2410 __repr__
= _swig_repr
2411 __swig_destroy__
= _gdi_
.delete_DC
2412 __del__
= lambda self
: None;
2413 # These have been deprecated in wxWidgets. Since they never
2414 # really did anything to begin with, just make them be NOPs.
2415 def BeginDrawing(self
): pass
2416 def EndDrawing(self
): pass
2418 def FloodFill(*args
, **kwargs
):
2420 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2422 Flood fills the device context starting from the given point, using
2423 the current brush colour, and using a style:
2425 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2426 the given colour is encountered.
2428 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2431 Returns False if the operation failed.
2433 Note: The present implementation for non-Windows platforms may fail to
2434 find colour borders if the pixels do not match the colour
2435 exactly. However the function will still return true.
2437 return _gdi_
.DC_FloodFill(*args
, **kwargs
)
2439 def FloodFillPoint(*args
, **kwargs
):
2441 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2443 Flood fills the device context starting from the given point, using
2444 the current brush colour, and using a style:
2446 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2447 the given colour is encountered.
2449 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2452 Returns False if the operation failed.
2454 Note: The present implementation for non-Windows platforms may fail to
2455 find colour borders if the pixels do not match the colour
2456 exactly. However the function will still return true.
2458 return _gdi_
.DC_FloodFillPoint(*args
, **kwargs
)
2460 def GradientFillConcentric(*args
, **kwargs
):
2462 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2465 Fill the area specified by rect with a radial gradient, starting from
2466 initialColour in the center of the circle and fading to destColour on
2467 the outside of the circle. The circleCenter argument is the relative
2468 coordinants of the center of the circle in the specified rect.
2470 Note: Currently this function is very slow, don't use it for real-time
2473 return _gdi_
.DC_GradientFillConcentric(*args
, **kwargs
)
2475 def GradientFillLinear(*args
, **kwargs
):
2477 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2478 int nDirection=EAST)
2480 Fill the area specified by rect with a linear gradient, starting from
2481 initialColour and eventually fading to destColour. The nDirection
2482 parameter specifies the direction of the colour change, default is to
2483 use initialColour on the left part of the rectangle and destColour on
2486 return _gdi_
.DC_GradientFillLinear(*args
, **kwargs
)
2488 def GetPixel(*args
, **kwargs
):
2490 GetPixel(self, int x, int y) -> Colour
2492 Gets the colour at the specified location on the DC.
2494 return _gdi_
.DC_GetPixel(*args
, **kwargs
)
2496 def GetPixelPoint(*args
, **kwargs
):
2497 """GetPixelPoint(self, Point pt) -> Colour"""
2498 return _gdi_
.DC_GetPixelPoint(*args
, **kwargs
)
2500 def DrawLine(*args
, **kwargs
):
2502 DrawLine(self, int x1, int y1, int x2, int y2)
2504 Draws a line from the first point to the second. The current pen is
2505 used for drawing the line. Note that the second point is *not* part of
2506 the line and is not drawn by this function (this is consistent with
2507 the behaviour of many other toolkits).
2509 return _gdi_
.DC_DrawLine(*args
, **kwargs
)
2511 def DrawLinePoint(*args
, **kwargs
):
2513 DrawLinePoint(self, Point pt1, Point pt2)
2515 Draws a line from the first point to the second. The current pen is
2516 used for drawing the line. Note that the second point is *not* part of
2517 the line and is not drawn by this function (this is consistent with
2518 the behaviour of many other toolkits).
2520 return _gdi_
.DC_DrawLinePoint(*args
, **kwargs
)
2522 def CrossHair(*args
, **kwargs
):
2524 CrossHair(self, int x, int y)
2526 Displays a cross hair using the current pen. This is a vertical and
2527 horizontal line the height and width of the window, centred on the
2530 return _gdi_
.DC_CrossHair(*args
, **kwargs
)
2532 def CrossHairPoint(*args
, **kwargs
):
2534 CrossHairPoint(self, Point pt)
2536 Displays a cross hair using the current pen. This is a vertical and
2537 horizontal line the height and width of the window, centred on the
2540 return _gdi_
.DC_CrossHairPoint(*args
, **kwargs
)
2542 def DrawArc(*args
, **kwargs
):
2544 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
2546 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2547 the first point to the second. The current pen is used for the outline
2548 and the current brush for filling the shape.
2550 The arc is drawn in an anticlockwise direction from the start point to
2553 return _gdi_
.DC_DrawArc(*args
, **kwargs
)
2555 def DrawArcPoint(*args
, **kwargs
):
2557 DrawArcPoint(self, Point pt1, Point pt2, Point center)
2559 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2560 the first point to the second. The current pen is used for the outline
2561 and the current brush for filling the shape.
2563 The arc is drawn in an anticlockwise direction from the start point to
2566 return _gdi_
.DC_DrawArcPoint(*args
, **kwargs
)
2568 def DrawCheckMark(*args
, **kwargs
):
2570 DrawCheckMark(self, int x, int y, int width, int height)
2572 Draws a check mark inside the given rectangle.
2574 return _gdi_
.DC_DrawCheckMark(*args
, **kwargs
)
2576 def DrawCheckMarkRect(*args
, **kwargs
):
2578 DrawCheckMarkRect(self, Rect rect)
2580 Draws a check mark inside the given rectangle.
2582 return _gdi_
.DC_DrawCheckMarkRect(*args
, **kwargs
)
2584 def DrawEllipticArc(*args
, **kwargs
):
2586 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
2588 Draws an arc of an ellipse, with the given rectangle defining the
2589 bounds of the ellipse. The current pen is used for drawing the arc and
2590 the current brush is used for drawing the pie.
2592 The *start* and *end* parameters specify the start and end of the arc
2593 relative to the three-o'clock position from the center of the
2594 rectangle. Angles are specified in degrees (360 is a complete
2595 circle). Positive values mean counter-clockwise motion. If start is
2596 equal to end, a complete ellipse will be drawn.
2598 return _gdi_
.DC_DrawEllipticArc(*args
, **kwargs
)
2600 def DrawEllipticArcPointSize(*args
, **kwargs
):
2602 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
2604 Draws an arc of an ellipse, with the given rectangle defining the
2605 bounds of the ellipse. The current pen is used for drawing the arc and
2606 the current brush is used for drawing the pie.
2608 The *start* and *end* parameters specify the start and end of the arc
2609 relative to the three-o'clock position from the center of the
2610 rectangle. Angles are specified in degrees (360 is a complete
2611 circle). Positive values mean counter-clockwise motion. If start is
2612 equal to end, a complete ellipse will be drawn.
2614 return _gdi_
.DC_DrawEllipticArcPointSize(*args
, **kwargs
)
2616 def DrawPoint(*args
, **kwargs
):
2618 DrawPoint(self, int x, int y)
2620 Draws a point using the current pen.
2622 return _gdi_
.DC_DrawPoint(*args
, **kwargs
)
2624 def DrawPointPoint(*args
, **kwargs
):
2626 DrawPointPoint(self, Point pt)
2628 Draws a point using the current pen.
2630 return _gdi_
.DC_DrawPointPoint(*args
, **kwargs
)
2632 def DrawRectangle(*args
, **kwargs
):
2634 DrawRectangle(self, int x, int y, int width, int height)
2636 Draws a rectangle with the given top left corner, and with the given
2637 size. The current pen is used for the outline and the current brush
2638 for filling the shape.
2640 return _gdi_
.DC_DrawRectangle(*args
, **kwargs
)
2642 def DrawRectangleRect(*args
, **kwargs
):
2644 DrawRectangleRect(self, Rect rect)
2646 Draws a rectangle with the given top left corner, and with the given
2647 size. The current pen is used for the outline and the current brush
2648 for filling the shape.
2650 return _gdi_
.DC_DrawRectangleRect(*args
, **kwargs
)
2652 def DrawRectanglePointSize(*args
, **kwargs
):
2654 DrawRectanglePointSize(self, Point pt, Size sz)
2656 Draws a rectangle with the given top left corner, and with the given
2657 size. The current pen is used for the outline and the current brush
2658 for filling the shape.
2660 return _gdi_
.DC_DrawRectanglePointSize(*args
, **kwargs
)
2662 def DrawRoundedRectangle(*args
, **kwargs
):
2664 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
2666 Draws a rectangle with the given top left corner, and with the given
2667 size. The corners are quarter-circles using the given radius. The
2668 current pen is used for the outline and the current brush for filling
2671 If radius is positive, the value is assumed to be the radius of the
2672 rounded corner. If radius is negative, the absolute value is assumed
2673 to be the proportion of the smallest dimension of the rectangle. This
2674 means that the corner can be a sensible size relative to the size of
2675 the rectangle, and also avoids the strange effects X produces when the
2676 corners are too big for the rectangle.
2678 return _gdi_
.DC_DrawRoundedRectangle(*args
, **kwargs
)
2680 def DrawRoundedRectangleRect(*args
, **kwargs
):
2682 DrawRoundedRectangleRect(self, Rect r, double radius)
2684 Draws a rectangle with the given top left corner, and with the given
2685 size. The corners are quarter-circles using the given radius. The
2686 current pen is used for the outline and the current brush for filling
2689 If radius is positive, the value is assumed to be the radius of the
2690 rounded corner. If radius is negative, the absolute value is assumed
2691 to be the proportion of the smallest dimension of the rectangle. This
2692 means that the corner can be a sensible size relative to the size of
2693 the rectangle, and also avoids the strange effects X produces when the
2694 corners are too big for the rectangle.
2696 return _gdi_
.DC_DrawRoundedRectangleRect(*args
, **kwargs
)
2698 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
2700 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
2702 Draws a rectangle with the given top left corner, and with the given
2703 size. The corners are quarter-circles using the given radius. The
2704 current pen is used for the outline and the current brush for filling
2707 If radius is positive, the value is assumed to be the radius of the
2708 rounded corner. If radius is negative, the absolute value is assumed
2709 to be the proportion of the smallest dimension of the rectangle. This
2710 means that the corner can be a sensible size relative to the size of
2711 the rectangle, and also avoids the strange effects X produces when the
2712 corners are too big for the rectangle.
2714 return _gdi_
.DC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
2716 def DrawCircle(*args
, **kwargs
):
2718 DrawCircle(self, int x, int y, int radius)
2720 Draws a circle with the given center point and radius. The current
2721 pen is used for the outline and the current brush for filling the
2724 return _gdi_
.DC_DrawCircle(*args
, **kwargs
)
2726 def DrawCirclePoint(*args
, **kwargs
):
2728 DrawCirclePoint(self, Point pt, int radius)
2730 Draws a circle with the given center point and radius. The current
2731 pen is used for the outline and the current brush for filling the
2734 return _gdi_
.DC_DrawCirclePoint(*args
, **kwargs
)
2736 def DrawEllipse(*args
, **kwargs
):
2738 DrawEllipse(self, int x, int y, int width, int height)
2740 Draws an ellipse contained in the specified rectangle. The current pen
2741 is used for the outline and the current brush for filling the shape.
2743 return _gdi_
.DC_DrawEllipse(*args
, **kwargs
)
2745 def DrawEllipseRect(*args
, **kwargs
):
2747 DrawEllipseRect(self, Rect rect)
2749 Draws an ellipse contained in the specified rectangle. The current pen
2750 is used for the outline and the current brush for filling the shape.
2752 return _gdi_
.DC_DrawEllipseRect(*args
, **kwargs
)
2754 def DrawEllipsePointSize(*args
, **kwargs
):
2756 DrawEllipsePointSize(self, Point pt, Size sz)
2758 Draws an ellipse contained in the specified rectangle. The current pen
2759 is used for the outline and the current brush for filling the shape.
2761 return _gdi_
.DC_DrawEllipsePointSize(*args
, **kwargs
)
2763 def DrawIcon(*args
, **kwargs
):
2765 DrawIcon(self, Icon icon, int x, int y)
2767 Draw an icon on the display (does nothing if the device context is
2768 PostScript). This can be the simplest way of drawing bitmaps on a
2771 return _gdi_
.DC_DrawIcon(*args
, **kwargs
)
2773 def DrawIconPoint(*args
, **kwargs
):
2775 DrawIconPoint(self, Icon icon, Point pt)
2777 Draw an icon on the display (does nothing if the device context is
2778 PostScript). This can be the simplest way of drawing bitmaps on a
2781 return _gdi_
.DC_DrawIconPoint(*args
, **kwargs
)
2783 def DrawBitmap(*args
, **kwargs
):
2785 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
2787 Draw a bitmap on the device context at the specified point. If
2788 *transparent* is true and the bitmap has a transparency mask, (or
2789 alpha channel on the platforms that support it) then the bitmap will
2790 be drawn transparently.
2792 return _gdi_
.DC_DrawBitmap(*args
, **kwargs
)
2794 def DrawBitmapPoint(*args
, **kwargs
):
2796 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
2798 Draw a bitmap on the device context at the specified point. If
2799 *transparent* is true and the bitmap has a transparency mask, (or
2800 alpha channel on the platforms that support it) then the bitmap will
2801 be drawn transparently.
2803 return _gdi_
.DC_DrawBitmapPoint(*args
, **kwargs
)
2805 def DrawText(*args
, **kwargs
):
2807 DrawText(self, String text, int x, int y)
2809 Draws a text string at the specified point, using the current text
2810 font, and the current text foreground and background colours.
2812 The coordinates refer to the top-left corner of the rectangle bounding
2813 the string. See `GetTextExtent` for how to get the dimensions of a
2814 text string, which can be used to position the text more precisely.
2816 **NOTE**: under wxGTK the current logical function is used by this
2817 function but it is ignored by wxMSW. Thus, you should avoid using
2818 logical functions with this function in portable programs.
2820 return _gdi_
.DC_DrawText(*args
, **kwargs
)
2822 def DrawTextPoint(*args
, **kwargs
):
2824 DrawTextPoint(self, String text, Point pt)
2826 Draws a text string at the specified point, using the current text
2827 font, and the current text foreground and background colours.
2829 The coordinates refer to the top-left corner of the rectangle bounding
2830 the string. See `GetTextExtent` for how to get the dimensions of a
2831 text string, which can be used to position the text more precisely.
2833 **NOTE**: under wxGTK the current logical function is used by this
2834 function but it is ignored by wxMSW. Thus, you should avoid using
2835 logical functions with this function in portable programs.
2837 return _gdi_
.DC_DrawTextPoint(*args
, **kwargs
)
2839 def DrawRotatedText(*args
, **kwargs
):
2841 DrawRotatedText(self, String text, int x, int y, double angle)
2843 Draws the text rotated by *angle* degrees, if supported by the platform.
2845 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
2846 function. In particular, a font different from ``wx.NORMAL_FONT``
2847 should be used as the it is not normally a TrueType
2848 font. ``wx.SWISS_FONT`` is an example of a font which is.
2850 return _gdi_
.DC_DrawRotatedText(*args
, **kwargs
)
2852 def DrawRotatedTextPoint(*args
, **kwargs
):
2854 DrawRotatedTextPoint(self, String text, Point pt, double angle)
2856 Draws the text rotated by *angle* degrees, if supported by the platform.
2858 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
2859 function. In particular, a font different from ``wx.NORMAL_FONT``
2860 should be used as the it is not normally a TrueType
2861 font. ``wx.SWISS_FONT`` is an example of a font which is.
2863 return _gdi_
.DC_DrawRotatedTextPoint(*args
, **kwargs
)
2865 def Blit(*args
, **kwargs
):
2867 Blit(self, int xdest, int ydest, int width, int height, DC source,
2868 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
2869 int xsrcMask=-1, int ysrcMask=-1) -> bool
2871 Copy from a source DC to this DC. Parameters specify the destination
2872 coordinates, size of area to copy, source DC, source coordinates,
2873 logical function, whether to use a bitmap mask, and mask source
2876 return _gdi_
.DC_Blit(*args
, **kwargs
)
2878 def BlitPointSize(*args
, **kwargs
):
2880 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
2881 bool useMask=False, Point srcPtMask=DefaultPosition) -> 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_BlitPointSize(*args
, **kwargs
)
2890 def SetClippingRegion(*args
, **kwargs
):
2892 SetClippingRegion(self, int x, int y, int width, int height)
2894 Sets the clipping region for this device context to the intersection
2895 of the given region described by the parameters of this method and the
2896 previously set clipping region. You should call `DestroyClippingRegion`
2897 if you want to set the clipping region exactly to the region
2900 The clipping region is an area to which drawing is
2901 restricted. Possible uses for the clipping region are for clipping
2902 text or for speeding up window redraws when only a known area of the
2905 return _gdi_
.DC_SetClippingRegion(*args
, **kwargs
)
2907 def SetClippingRegionPointSize(*args
, **kwargs
):
2909 SetClippingRegionPointSize(self, Point pt, Size sz)
2911 Sets the clipping region for this device context to the intersection
2912 of the given region described by the parameters of this method and the
2913 previously set clipping region. You should call `DestroyClippingRegion`
2914 if you want to set the clipping region exactly to the region
2917 The clipping region is an area to which drawing is
2918 restricted. Possible uses for the clipping region are for clipping
2919 text or for speeding up window redraws when only a known area of the
2922 return _gdi_
.DC_SetClippingRegionPointSize(*args
, **kwargs
)
2924 def SetClippingRegionAsRegion(*args
, **kwargs
):
2926 SetClippingRegionAsRegion(self, Region region)
2928 Sets the clipping region for this device context to the intersection
2929 of the given region described by the parameters of this method and the
2930 previously set clipping region. You should call `DestroyClippingRegion`
2931 if you want to set the clipping region exactly to the region
2934 The clipping region is an area to which drawing is
2935 restricted. Possible uses for the clipping region are for clipping
2936 text or for speeding up window redraws when only a known area of the
2939 return _gdi_
.DC_SetClippingRegionAsRegion(*args
, **kwargs
)
2941 def SetClippingRect(*args
, **kwargs
):
2943 SetClippingRect(self, Rect rect)
2945 Sets the clipping region for this device context to the intersection
2946 of the given region described by the parameters of this method and the
2947 previously set clipping region. You should call `DestroyClippingRegion`
2948 if you want to set the clipping region exactly to the region
2951 The clipping region is an area to which drawing is
2952 restricted. Possible uses for the clipping region are for clipping
2953 text or for speeding up window redraws when only a known area of the
2956 return _gdi_
.DC_SetClippingRect(*args
, **kwargs
)
2958 def DrawLines(*args
, **kwargs
):
2960 DrawLines(self, List points, int xoffset=0, int yoffset=0)
2962 Draws lines using a sequence of `wx.Point` objects, adding the
2963 optional offset coordinate. The current pen is used for drawing the
2966 return _gdi_
.DC_DrawLines(*args
, **kwargs
)
2968 def DrawPolygon(*args
, **kwargs
):
2970 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
2971 int fillStyle=ODDEVEN_RULE)
2973 Draws a filled polygon using a sequence of `wx.Point` objects, adding
2974 the optional offset coordinate. The last argument specifies the fill
2975 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
2977 The current pen is used for drawing the outline, and the current brush
2978 for filling the shape. Using a transparent brush suppresses
2979 filling. Note that wxWidgets automatically closes the first and last
2982 return _gdi_
.DC_DrawPolygon(*args
, **kwargs
)
2984 def DrawLabel(*args
, **kwargs
):
2986 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
2989 Draw *text* within the specified rectangle, abiding by the alignment
2990 flags. Will additionally emphasize the character at *indexAccel* if
2993 return _gdi_
.DC_DrawLabel(*args
, **kwargs
)
2995 def DrawImageLabel(*args
, **kwargs
):
2997 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
2998 int indexAccel=-1) -> Rect
3000 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3001 drawing it) within the specified rectangle, abiding by the alignment
3002 flags. Will additionally emphasize the character at *indexAccel* if
3003 it is not -1. Returns the bounding rectangle.
3005 return _gdi_
.DC_DrawImageLabel(*args
, **kwargs
)
3007 def DrawSpline(*args
, **kwargs
):
3009 DrawSpline(self, List points)
3011 Draws a spline between all given control points, (a list of `wx.Point`
3012 objects) using the current pen. The spline is drawn using a series of
3013 lines, using an algorithm taken from the X drawing program 'XFIG'.
3015 return _gdi_
.DC_DrawSpline(*args
, **kwargs
)
3017 def Clear(*args
, **kwargs
):
3021 Clears the device context using the current background brush.
3023 return _gdi_
.DC_Clear(*args
, **kwargs
)
3025 def StartDoc(*args
, **kwargs
):
3027 StartDoc(self, String message) -> bool
3029 Starts a document (only relevant when outputting to a
3030 printer). *Message* is a message to show whilst printing.
3032 return _gdi_
.DC_StartDoc(*args
, **kwargs
)
3034 def EndDoc(*args
, **kwargs
):
3038 Ends a document (only relevant when outputting to a printer).
3040 return _gdi_
.DC_EndDoc(*args
, **kwargs
)
3042 def StartPage(*args
, **kwargs
):
3046 Starts a document page (only relevant when outputting to a printer).
3048 return _gdi_
.DC_StartPage(*args
, **kwargs
)
3050 def EndPage(*args
, **kwargs
):
3054 Ends a document page (only relevant when outputting to a printer).
3056 return _gdi_
.DC_EndPage(*args
, **kwargs
)
3058 def SetFont(*args
, **kwargs
):
3060 SetFont(self, Font font)
3062 Sets the current font for the DC. It must be a valid font, in
3063 particular you should not pass ``wx.NullFont`` to this method.
3065 return _gdi_
.DC_SetFont(*args
, **kwargs
)
3067 def SetPen(*args
, **kwargs
):
3069 SetPen(self, Pen pen)
3071 Sets the current pen for the DC.
3073 If the argument is ``wx.NullPen``, the current pen is selected out of the
3074 device context, and the original pen restored.
3076 return _gdi_
.DC_SetPen(*args
, **kwargs
)
3078 def SetBrush(*args
, **kwargs
):
3080 SetBrush(self, Brush brush)
3082 Sets the current brush for the DC.
3084 If the argument is ``wx.NullBrush``, the current brush is selected out
3085 of the device context, and the original brush restored, allowing the
3086 current brush to be destroyed safely.
3088 return _gdi_
.DC_SetBrush(*args
, **kwargs
)
3090 def SetBackground(*args
, **kwargs
):
3092 SetBackground(self, Brush brush)
3094 Sets the current background brush for the DC.
3096 return _gdi_
.DC_SetBackground(*args
, **kwargs
)
3098 def SetBackgroundMode(*args
, **kwargs
):
3100 SetBackgroundMode(self, int mode)
3102 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3103 determines whether text will be drawn with a background colour or
3106 return _gdi_
.DC_SetBackgroundMode(*args
, **kwargs
)
3108 def SetPalette(*args
, **kwargs
):
3110 SetPalette(self, Palette palette)
3112 If this is a window DC or memory DC, assigns the given palette to the
3113 window or bitmap associated with the DC. If the argument is
3114 ``wx.NullPalette``, the current palette is selected out of the device
3115 context, and the original palette restored.
3117 return _gdi_
.DC_SetPalette(*args
, **kwargs
)
3119 def DestroyClippingRegion(*args
, **kwargs
):
3121 DestroyClippingRegion(self)
3123 Destroys the current clipping region so that none of the DC is
3126 return _gdi_
.DC_DestroyClippingRegion(*args
, **kwargs
)
3128 def GetClippingBox(*args
, **kwargs
):
3130 GetClippingBox() -> (x, y, width, height)
3132 Gets the rectangle surrounding the current clipping region.
3134 return _gdi_
.DC_GetClippingBox(*args
, **kwargs
)
3136 def GetClippingRect(*args
, **kwargs
):
3138 GetClippingRect(self) -> Rect
3140 Gets the rectangle surrounding the current clipping region.
3142 return _gdi_
.DC_GetClippingRect(*args
, **kwargs
)
3144 def GetCharHeight(*args
, **kwargs
):
3146 GetCharHeight(self) -> int
3148 Gets the character height of the currently set font.
3150 return _gdi_
.DC_GetCharHeight(*args
, **kwargs
)
3152 def GetCharWidth(*args
, **kwargs
):
3154 GetCharWidth(self) -> int
3156 Gets the average character width of the currently set font.
3158 return _gdi_
.DC_GetCharWidth(*args
, **kwargs
)
3160 def GetTextExtent(*args
, **kwargs
):
3162 GetTextExtent(wxString string) -> (width, height)
3164 Get the width and height of the text using the current font. Only
3165 works for single line strings.
3167 return _gdi_
.DC_GetTextExtent(*args
, **kwargs
)
3169 def GetFullTextExtent(*args
, **kwargs
):
3171 GetFullTextExtent(wxString string, Font font=None) ->
3172 (width, height, descent, externalLeading)
3174 Get the width, height, decent and leading of the text using the
3175 current or specified font. Only works for single line strings.
3177 return _gdi_
.DC_GetFullTextExtent(*args
, **kwargs
)
3179 def GetMultiLineTextExtent(*args
, **kwargs
):
3181 GetMultiLineTextExtent(wxString string, Font font=None) ->
3182 (width, height, descent, externalLeading)
3184 Get the width, height, decent and leading of the text using the
3185 current or specified font. Works for single as well as multi-line
3188 return _gdi_
.DC_GetMultiLineTextExtent(*args
, **kwargs
)
3190 def GetPartialTextExtents(*args
, **kwargs
):
3192 GetPartialTextExtents(self, text) -> [widths]
3194 Returns a list of integers such that each value is the distance in
3195 pixels from the begining of text to the coresponding character of
3196 *text*. The generic version simply builds a running total of the widths
3197 of each character using GetTextExtent, however if the various
3198 platforms have a native API function that is faster or more accurate
3199 than the generic implementation then it will be used instead.
3201 return _gdi_
.DC_GetPartialTextExtents(*args
, **kwargs
)
3203 def GetSize(*args
, **kwargs
):
3205 GetSize(self) -> Size
3207 This gets the horizontal and vertical resolution in device units. It
3208 can be used to scale graphics to fit the page. For example, if *maxX*
3209 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3210 used in your application, the following code will scale the graphic to
3211 fit on the printer page::
3214 scaleX = maxX*1.0 / w
3215 scaleY = maxY*1.0 / h
3216 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3219 return _gdi_
.DC_GetSize(*args
, **kwargs
)
3221 def GetSizeTuple(*args
, **kwargs
):
3223 GetSizeTuple() -> (width, height)
3225 This gets the horizontal and vertical resolution in device units. It
3226 can be used to scale graphics to fit the page. For example, if *maxX*
3227 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3228 used in your application, the following code will scale the graphic to
3229 fit on the printer page::
3232 scaleX = maxX*1.0 / w
3233 scaleY = maxY*1.0 / h
3234 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3237 return _gdi_
.DC_GetSizeTuple(*args
, **kwargs
)
3239 def GetSizeMM(*args
, **kwargs
):
3241 GetSizeMM(self) -> Size
3243 Get the DC size in milimeters.
3245 return _gdi_
.DC_GetSizeMM(*args
, **kwargs
)
3247 def GetSizeMMTuple(*args
, **kwargs
):
3249 GetSizeMMTuple() -> (width, height)
3251 Get the DC size in milimeters.
3253 return _gdi_
.DC_GetSizeMMTuple(*args
, **kwargs
)
3255 def DeviceToLogicalX(*args
, **kwargs
):
3257 DeviceToLogicalX(self, int x) -> int
3259 Convert device X coordinate to logical coordinate, using the current
3262 return _gdi_
.DC_DeviceToLogicalX(*args
, **kwargs
)
3264 def DeviceToLogicalY(*args
, **kwargs
):
3266 DeviceToLogicalY(self, int y) -> int
3268 Converts device Y coordinate to logical coordinate, using the current
3271 return _gdi_
.DC_DeviceToLogicalY(*args
, **kwargs
)
3273 def DeviceToLogicalXRel(*args
, **kwargs
):
3275 DeviceToLogicalXRel(self, int x) -> int
3277 Convert device X coordinate to relative logical coordinate, using the
3278 current mapping mode but ignoring the x axis orientation. Use this
3279 function for converting a width, for example.
3281 return _gdi_
.DC_DeviceToLogicalXRel(*args
, **kwargs
)
3283 def DeviceToLogicalYRel(*args
, **kwargs
):
3285 DeviceToLogicalYRel(self, int y) -> int
3287 Convert device Y coordinate to relative logical coordinate, using the
3288 current mapping mode but ignoring the y axis orientation. Use this
3289 function for converting a height, for example.
3291 return _gdi_
.DC_DeviceToLogicalYRel(*args
, **kwargs
)
3293 def LogicalToDeviceX(*args
, **kwargs
):
3295 LogicalToDeviceX(self, int x) -> int
3297 Converts logical X coordinate to device coordinate, using the current
3300 return _gdi_
.DC_LogicalToDeviceX(*args
, **kwargs
)
3302 def LogicalToDeviceY(*args
, **kwargs
):
3304 LogicalToDeviceY(self, int y) -> int
3306 Converts logical Y coordinate to device coordinate, using the current
3309 return _gdi_
.DC_LogicalToDeviceY(*args
, **kwargs
)
3311 def LogicalToDeviceXRel(*args
, **kwargs
):
3313 LogicalToDeviceXRel(self, int x) -> int
3315 Converts logical X coordinate to relative device coordinate, using the
3316 current mapping mode but ignoring the x axis orientation. Use this for
3317 converting a width, for example.
3319 return _gdi_
.DC_LogicalToDeviceXRel(*args
, **kwargs
)
3321 def LogicalToDeviceYRel(*args
, **kwargs
):
3323 LogicalToDeviceYRel(self, int y) -> int
3325 Converts logical Y coordinate to relative device coordinate, using the
3326 current mapping mode but ignoring the y axis orientation. Use this for
3327 converting a height, for example.
3329 return _gdi_
.DC_LogicalToDeviceYRel(*args
, **kwargs
)
3331 def CanDrawBitmap(*args
, **kwargs
):
3332 """CanDrawBitmap(self) -> bool"""
3333 return _gdi_
.DC_CanDrawBitmap(*args
, **kwargs
)
3335 def CanGetTextExtent(*args
, **kwargs
):
3336 """CanGetTextExtent(self) -> bool"""
3337 return _gdi_
.DC_CanGetTextExtent(*args
, **kwargs
)
3339 def GetDepth(*args
, **kwargs
):
3341 GetDepth(self) -> int
3343 Returns the colour depth of the DC.
3345 return _gdi_
.DC_GetDepth(*args
, **kwargs
)
3347 def GetPPI(*args
, **kwargs
):
3349 GetPPI(self) -> Size
3351 Resolution in Pixels per inch
3353 return _gdi_
.DC_GetPPI(*args
, **kwargs
)
3355 def Ok(*args
, **kwargs
):
3359 Returns true if the DC is ok to use.
3361 return _gdi_
.DC_Ok(*args
, **kwargs
)
3363 def GetBackgroundMode(*args
, **kwargs
):
3365 GetBackgroundMode(self) -> int
3367 Returns the current background mode, either ``wx.SOLID`` or
3370 return _gdi_
.DC_GetBackgroundMode(*args
, **kwargs
)
3372 def GetBackground(*args
, **kwargs
):
3374 GetBackground(self) -> Brush
3376 Gets the brush used for painting the background.
3378 return _gdi_
.DC_GetBackground(*args
, **kwargs
)
3380 def GetBrush(*args
, **kwargs
):
3382 GetBrush(self) -> Brush
3384 Gets the current brush
3386 return _gdi_
.DC_GetBrush(*args
, **kwargs
)
3388 def GetFont(*args
, **kwargs
):
3390 GetFont(self) -> Font
3392 Gets the current font
3394 return _gdi_
.DC_GetFont(*args
, **kwargs
)
3396 def GetPen(*args
, **kwargs
):
3400 Gets the current pen
3402 return _gdi_
.DC_GetPen(*args
, **kwargs
)
3404 def GetTextBackground(*args
, **kwargs
):
3406 GetTextBackground(self) -> Colour
3408 Gets the current text background colour
3410 return _gdi_
.DC_GetTextBackground(*args
, **kwargs
)
3412 def GetTextForeground(*args
, **kwargs
):
3414 GetTextForeground(self) -> Colour
3416 Gets the current text foreground colour
3418 return _gdi_
.DC_GetTextForeground(*args
, **kwargs
)
3420 def SetTextForeground(*args
, **kwargs
):
3422 SetTextForeground(self, Colour colour)
3424 Sets the current text foreground colour for the DC.
3426 return _gdi_
.DC_SetTextForeground(*args
, **kwargs
)
3428 def SetTextBackground(*args
, **kwargs
):
3430 SetTextBackground(self, Colour colour)
3432 Sets the current text background colour for the DC.
3434 return _gdi_
.DC_SetTextBackground(*args
, **kwargs
)
3436 def GetMapMode(*args
, **kwargs
):
3438 GetMapMode(self) -> int
3440 Gets the current *mapping mode* for the device context
3442 return _gdi_
.DC_GetMapMode(*args
, **kwargs
)
3444 def SetMapMode(*args
, **kwargs
):
3446 SetMapMode(self, int mode)
3448 The *mapping mode* of the device context defines the unit of
3449 measurement used to convert logical units to device units. The
3450 mapping mode can be one of the following:
3452 ================ =============================================
3453 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3455 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3456 wx.MM_METRIC Each logical unit is 1 mm.
3457 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3458 wx.MM_TEXT Each logical unit is 1 pixel.
3459 ================ =============================================
3462 return _gdi_
.DC_SetMapMode(*args
, **kwargs
)
3464 def GetUserScale(*args
, **kwargs
):
3466 GetUserScale(self) -> (xScale, yScale)
3468 Gets the current user scale factor (set by `SetUserScale`).
3470 return _gdi_
.DC_GetUserScale(*args
, **kwargs
)
3472 def SetUserScale(*args
, **kwargs
):
3474 SetUserScale(self, double x, double y)
3476 Sets the user scaling factor, useful for applications which require
3479 return _gdi_
.DC_SetUserScale(*args
, **kwargs
)
3481 def GetLogicalScale(*args
, **kwargs
):
3482 """GetLogicalScale() -> (xScale, yScale)"""
3483 return _gdi_
.DC_GetLogicalScale(*args
, **kwargs
)
3485 def SetLogicalScale(*args
, **kwargs
):
3486 """SetLogicalScale(self, double x, double y)"""
3487 return _gdi_
.DC_SetLogicalScale(*args
, **kwargs
)
3489 def GetLogicalOrigin(*args
, **kwargs
):
3490 """GetLogicalOrigin(self) -> Point"""
3491 return _gdi_
.DC_GetLogicalOrigin(*args
, **kwargs
)
3493 def GetLogicalOriginTuple(*args
, **kwargs
):
3494 """GetLogicalOriginTuple() -> (x,y)"""
3495 return _gdi_
.DC_GetLogicalOriginTuple(*args
, **kwargs
)
3497 def SetLogicalOrigin(*args
, **kwargs
):
3498 """SetLogicalOrigin(self, int x, int y)"""
3499 return _gdi_
.DC_SetLogicalOrigin(*args
, **kwargs
)
3501 def SetLogicalOriginPoint(*args
, **kwargs
):
3502 """SetLogicalOriginPoint(self, Point point)"""
3503 return _gdi_
.DC_SetLogicalOriginPoint(*args
, **kwargs
)
3505 def GetDeviceOrigin(*args
, **kwargs
):
3506 """GetDeviceOrigin(self) -> Point"""
3507 return _gdi_
.DC_GetDeviceOrigin(*args
, **kwargs
)
3509 def GetDeviceOriginTuple(*args
, **kwargs
):
3510 """GetDeviceOriginTuple() -> (x,y)"""
3511 return _gdi_
.DC_GetDeviceOriginTuple(*args
, **kwargs
)
3513 def SetDeviceOrigin(*args
, **kwargs
):
3514 """SetDeviceOrigin(self, int x, int y)"""
3515 return _gdi_
.DC_SetDeviceOrigin(*args
, **kwargs
)
3517 def SetDeviceOriginPoint(*args
, **kwargs
):
3518 """SetDeviceOriginPoint(self, Point point)"""
3519 return _gdi_
.DC_SetDeviceOriginPoint(*args
, **kwargs
)
3521 def SetAxisOrientation(*args
, **kwargs
):
3523 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
3525 Sets the x and y axis orientation (i.e., the direction from lowest to
3526 highest values on the axis). The default orientation is the natural
3527 orientation, e.g. x axis from left to right and y axis from bottom up.
3529 return _gdi_
.DC_SetAxisOrientation(*args
, **kwargs
)
3531 def GetLogicalFunction(*args
, **kwargs
):
3533 GetLogicalFunction(self) -> int
3535 Gets the current logical function (set by `SetLogicalFunction`).
3537 return _gdi_
.DC_GetLogicalFunction(*args
, **kwargs
)
3539 def SetLogicalFunction(*args
, **kwargs
):
3541 SetLogicalFunction(self, int function)
3543 Sets the current logical function for the device context. This
3544 determines how a source pixel (from a pen or brush colour, or source
3545 device context if using `Blit`) combines with a destination pixel in
3546 the current device context.
3548 The possible values and their meaning in terms of source and
3549 destination pixel values are as follows:
3551 ================ ==========================
3553 wx.AND_INVERT (NOT src) AND dst
3554 wx.AND_REVERSE src AND (NOT dst)
3557 wx.EQUIV (NOT src) XOR dst
3559 wx.NAND (NOT src) OR (NOT dst)
3560 wx.NOR (NOT src) AND (NOT dst)
3563 wx.OR_INVERT (NOT src) OR dst
3564 wx.OR_REVERSE src OR (NOT dst)
3566 wx.SRC_INVERT NOT src
3568 ================ ==========================
3570 The default is wx.COPY, which simply draws with the current
3571 colour. The others combine the current colour and the background using
3572 a logical operation. wx.INVERT is commonly used for drawing rubber
3573 bands or moving outlines, since drawing twice reverts to the original
3577 return _gdi_
.DC_SetLogicalFunction(*args
, **kwargs
)
3579 def ComputeScaleAndOrigin(*args
, **kwargs
):
3581 ComputeScaleAndOrigin(self)
3583 Performs all necessary computations for given platform and context
3584 type after each change of scale and origin parameters. Usually called
3585 automatically internally after such changes.
3588 return _gdi_
.DC_ComputeScaleAndOrigin(*args
, **kwargs
)
3590 def SetOptimization(self
, optimize
):
3592 def GetOptimization(self
):
3595 SetOptimization
= wx
._deprecated
(SetOptimization
)
3596 GetOptimization
= wx
._deprecated
(GetOptimization
)
3598 def CalcBoundingBox(*args
, **kwargs
):
3600 CalcBoundingBox(self, int x, int y)
3602 Adds the specified point to the bounding box which can be retrieved
3603 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3605 return _gdi_
.DC_CalcBoundingBox(*args
, **kwargs
)
3607 def CalcBoundingBoxPoint(*args
, **kwargs
):
3609 CalcBoundingBoxPoint(self, Point point)
3611 Adds the specified point to the bounding box which can be retrieved
3612 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3614 return _gdi_
.DC_CalcBoundingBoxPoint(*args
, **kwargs
)
3616 def ResetBoundingBox(*args
, **kwargs
):
3618 ResetBoundingBox(self)
3620 Resets the bounding box: after a call to this function, the bounding
3621 box doesn't contain anything.
3623 return _gdi_
.DC_ResetBoundingBox(*args
, **kwargs
)
3625 def MinX(*args
, **kwargs
):
3629 Gets the minimum horizontal extent used in drawing commands so far.
3631 return _gdi_
.DC_MinX(*args
, **kwargs
)
3633 def MaxX(*args
, **kwargs
):
3637 Gets the maximum horizontal extent used in drawing commands so far.
3639 return _gdi_
.DC_MaxX(*args
, **kwargs
)
3641 def MinY(*args
, **kwargs
):
3645 Gets the minimum vertical extent used in drawing commands so far.
3647 return _gdi_
.DC_MinY(*args
, **kwargs
)
3649 def MaxY(*args
, **kwargs
):
3653 Gets the maximum vertical extent used in drawing commands so far.
3655 return _gdi_
.DC_MaxY(*args
, **kwargs
)
3657 def GetBoundingBox(*args
, **kwargs
):
3659 GetBoundingBox() -> (x1,y1, x2,y2)
3661 Returns the min and max points used in drawing commands so far.
3663 return _gdi_
.DC_GetBoundingBox(*args
, **kwargs
)
3665 def __nonzero__(self
): return self
.Ok()
3666 def _DrawPointList(*args
, **kwargs
):
3667 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3668 return _gdi_
.DC__DrawPointList(*args
, **kwargs
)
3670 def _DrawLineList(*args
, **kwargs
):
3671 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3672 return _gdi_
.DC__DrawLineList(*args
, **kwargs
)
3674 def _DrawRectangleList(*args
, **kwargs
):
3675 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3676 return _gdi_
.DC__DrawRectangleList(*args
, **kwargs
)
3678 def _DrawEllipseList(*args
, **kwargs
):
3679 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3680 return _gdi_
.DC__DrawEllipseList(*args
, **kwargs
)
3682 def _DrawPolygonList(*args
, **kwargs
):
3683 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
3684 return _gdi_
.DC__DrawPolygonList(*args
, **kwargs
)
3686 def _DrawTextList(*args
, **kwargs
):
3688 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
3689 PyObject backgroundList) -> PyObject
3691 return _gdi_
.DC__DrawTextList(*args
, **kwargs
)
3693 def DrawPointList(self
, points
, pens
=None):
3695 Draw a list of points as quickly as possible.
3697 :param points: A sequence of 2-element sequences representing
3698 each point to draw, (x,y).
3699 :param pens: If None, then the current pen is used. If a
3700 single pen then it will be used for all points. If
3701 a list of pens then there should be one for each point
3706 elif isinstance(pens
, wx
.Pen
):
3708 elif len(pens
) != len(points
):
3709 raise ValueError('points and pens must have same length')
3710 return self
._DrawPointList
(points
, pens
, [])
3713 def DrawLineList(self
, lines
, pens
=None):
3715 Draw a list of lines as quickly as possible.
3717 :param lines: A sequence of 4-element sequences representing
3718 each line to draw, (x1,y1, x2,y2).
3719 :param pens: If None, then the current pen is used. If a
3720 single pen then it will be used for all lines. If
3721 a list of pens then there should be one for each line
3726 elif isinstance(pens
, wx
.Pen
):
3728 elif len(pens
) != len(lines
):
3729 raise ValueError('lines and pens must have same length')
3730 return self
._DrawLineList
(lines
, pens
, [])
3733 def DrawRectangleList(self
, rectangles
, pens
=None, brushes
=None):
3735 Draw a list of rectangles as quickly as possible.
3737 :param rectangles: A sequence of 4-element sequences representing
3738 each rectangle to draw, (x,y, w,h).
3739 :param pens: If None, then the current pen is used. If a
3740 single pen then it will be used for all rectangles.
3741 If a list of pens then there should be one for each
3742 rectangle in rectangles.
3743 :param brushes: A brush or brushes to be used to fill the rectagles,
3744 with similar semantics as the pens parameter.
3748 elif isinstance(pens
, wx
.Pen
):
3750 elif len(pens
) != len(rectangles
):
3751 raise ValueError('rectangles and pens must have same length')
3754 elif isinstance(brushes
, wx
.Brush
):
3756 elif len(brushes
) != len(rectangles
):
3757 raise ValueError('rectangles and brushes must have same length')
3758 return self
._DrawRectangleList
(rectangles
, pens
, brushes
)
3761 def DrawEllipseList(self
, ellipses
, pens
=None, brushes
=None):
3763 Draw a list of ellipses as quickly as possible.
3765 :param ellipses: A sequence of 4-element sequences representing
3766 each ellipse to draw, (x,y, w,h).
3767 :param pens: If None, then the current pen is used. If a
3768 single pen then it will be used for all ellipses.
3769 If a list of pens then there should be one for each
3770 ellipse in ellipses.
3771 :param brushes: A brush or brushes to be used to fill the ellipses,
3772 with similar semantics as the pens parameter.
3776 elif isinstance(pens
, wx
.Pen
):
3778 elif len(pens
) != len(ellipses
):
3779 raise ValueError('ellipses and pens must have same length')
3782 elif isinstance(brushes
, wx
.Brush
):
3784 elif len(brushes
) != len(ellipses
):
3785 raise ValueError('ellipses and brushes must have same length')
3786 return self
._DrawEllipseList
(ellipses
, pens
, brushes
)
3789 def DrawPolygonList(self
, polygons
, pens
=None, brushes
=None):
3791 Draw a list of polygons, each of which is a list of points.
3793 :param polygons: A sequence of sequences of sequences.
3794 [[(x1,y1),(x2,y2),(x3,y3)...],
3795 [(x1,y1),(x2,y2),(x3,y3)...]]
3797 :param pens: If None, then the current pen is used. If a
3798 single pen then it will be used for all polygons.
3799 If a list of pens then there should be one for each
3801 :param brushes: A brush or brushes to be used to fill the polygons,
3802 with similar semantics as the pens parameter.
3806 elif isinstance(pens
, wx
.Pen
):
3808 elif len(pens
) != len(polygons
):
3809 raise ValueError('polygons and pens must have same length')
3812 elif isinstance(brushes
, wx
.Brush
):
3814 elif len(brushes
) != len(polygons
):
3815 raise ValueError('polygons and brushes must have same length')
3816 return self
._DrawPolygonList
(polygons
, pens
, brushes
)
3819 def DrawTextList(self
, textList
, coords
, foregrounds
= None, backgrounds
= None):
3821 Draw a list of strings using a list of coordinants for positioning each string.
3823 :param textList: A list of strings
3824 :param coords: A list of (x,y) positions
3825 :param foregrounds: A list of `wx.Colour` objects to use for the
3826 foregrounds of the strings.
3827 :param backgrounds: A list of `wx.Colour` objects to use for the
3828 backgrounds of the strings.
3830 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
3831 If you want backgrounds to do anything.
3833 if type(textList
) == type(''):
3834 textList
= [textList
]
3835 elif len(textList
) != len(coords
):
3836 raise ValueError('textlist and coords must have same length')
3837 if foregrounds
is None:
3839 elif isinstance(foregrounds
, wx
.Colour
):
3840 foregrounds
= [foregrounds
]
3841 elif len(foregrounds
) != len(coords
):
3842 raise ValueError('foregrounds and coords must have same length')
3843 if backgrounds
is None:
3845 elif isinstance(backgrounds
, wx
.Colour
):
3846 backgrounds
= [backgrounds
]
3847 elif len(backgrounds
) != len(coords
):
3848 raise ValueError('backgrounds and coords must have same length')
3849 return self
._DrawTextList
(textList
, coords
, foregrounds
, backgrounds
)
3851 _gdi_
.DC_swigregister(DC
)
3853 #---------------------------------------------------------------------------
3857 A memory device context provides a means to draw graphics onto a
3858 bitmap. A bitmap must be selected into the new memory DC before it may
3859 be used for anything. Typical usage is as follows::
3862 dc.SelectObject(bitmap)
3863 # draw on the dc usign any of the Draw methods
3864 dc.SelectObject(wx.NullBitmap)
3865 # the bitmap now contains wahtever was drawn upon it
3867 Note that the memory DC *must* be deleted (or the bitmap selected out
3868 of it) before a bitmap can be reselected into another memory DC.
3871 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3872 __repr__
= _swig_repr
3873 def __init__(self
, *args
, **kwargs
):
3875 __init__(self) -> MemoryDC
3877 Constructs a new memory device context.
3879 Use the Ok member to test whether the constructor was successful in
3880 creating a usable device context. Don't forget to select a bitmap into
3881 the DC before drawing on it.
3883 _gdi_
.MemoryDC_swiginit(self
,_gdi_
.new_MemoryDC(*args
, **kwargs
))
3884 def SelectObject(*args
, **kwargs
):
3886 SelectObject(self, Bitmap bitmap)
3888 Selects the bitmap into the device context, to use as the memory
3889 bitmap. Selecting the bitmap into a memory DC allows you to draw into
3890 the DC, and therefore the bitmap, and also to use Blit to copy the
3893 If the argument is wx.NullBitmap (or some other uninitialised
3894 `wx.Bitmap`) the current bitmap is selected out of the device context,
3895 and the original bitmap restored, allowing the current bitmap to be
3898 return _gdi_
.MemoryDC_SelectObject(*args
, **kwargs
)
3900 _gdi_
.MemoryDC_swigregister(MemoryDC
)
3902 def MemoryDCFromDC(*args
, **kwargs
):
3904 MemoryDCFromDC(DC oldDC) -> MemoryDC
3906 Creates a DC that is compatible with the oldDC.
3908 val
= _gdi_
.new_MemoryDCFromDC(*args
, **kwargs
)
3911 #---------------------------------------------------------------------------
3913 BUFFER_VIRTUAL_AREA
= _gdi_
.BUFFER_VIRTUAL_AREA
3914 BUFFER_CLIENT_AREA
= _gdi_
.BUFFER_CLIENT_AREA
3915 class BufferedDC(MemoryDC
):
3917 This simple class provides a simple way to avoid flicker: when drawing
3918 on it, everything is in fact first drawn on an in-memory buffer (a
3919 `wx.Bitmap`) and then copied to the screen only once, when this object
3922 It can be used in the same way as any other device
3923 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
3924 want to use it in your EVT_PAINT handler, you should look at
3925 `wx.BufferedPaintDC`.
3928 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3929 __repr__
= _swig_repr
3930 def __init__(self
, *args
):
3932 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
3933 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
3935 Constructs a buffered DC.
3937 _gdi_
.BufferedDC_swiginit(self
,_gdi_
.new_BufferedDC(*args
))
3938 self
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
3940 __swig_destroy__
= _gdi_
.delete_BufferedDC
3941 __del__
= lambda self
: None;
3942 def UnMask(*args
, **kwargs
):
3946 Blits the buffer to the dc, and detaches the dc from the buffer (so it
3947 can be effectively used once only). This is usually only called in
3950 return _gdi_
.BufferedDC_UnMask(*args
, **kwargs
)
3952 _gdi_
.BufferedDC_swigregister(BufferedDC
)
3954 class BufferedPaintDC(BufferedDC
):
3956 This is a subclass of `wx.BufferedDC` which can be used inside of an
3957 EVT_PAINT event handler. Just create an object of this class instead
3958 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
3959 flicker. The only thing to watch out for is that if you are using this
3960 class together with `wx.ScrolledWindow`, you probably do **not** want
3961 to call `wx.Window.PrepareDC` on it as it already does this internally
3962 for the real underlying `wx.PaintDC`.
3964 If your window is already fully buffered in a `wx.Bitmap` then your
3965 EVT_PAINT handler can be as simple as just creating a
3966 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
3967 automatically when it is destroyed. For example::
3969 def OnPaint(self, event):
3970 dc = wx.BufferedPaintDC(self, self.buffer)
3977 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
3978 __repr__
= _swig_repr
3979 def __init__(self
, *args
, **kwargs
):
3981 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
3983 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
3984 provide the bitmap to be used for buffering or let this object create
3985 one internally (in the latter case, the size of the client part of the
3986 window is automatically used).
3990 _gdi_
.BufferedPaintDC_swiginit(self
,_gdi_
.new_BufferedPaintDC(*args
, **kwargs
))
3991 _gdi_
.BufferedPaintDC_swigregister(BufferedPaintDC
)
3993 #---------------------------------------------------------------------------
3997 A wxScreenDC can be used to paint anywhere on the screen. This should
3998 normally be constructed as a temporary stack object; don't store a
4002 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4003 __repr__
= _swig_repr
4004 def __init__(self
, *args
, **kwargs
):
4006 __init__(self) -> ScreenDC
4008 A wxScreenDC can be used to paint anywhere on the screen. This should
4009 normally be constructed as a temporary stack object; don't store a
4013 _gdi_
.ScreenDC_swiginit(self
,_gdi_
.new_ScreenDC(*args
, **kwargs
))
4014 def StartDrawingOnTopWin(*args
, **kwargs
):
4016 StartDrawingOnTopWin(self, Window window) -> bool
4018 Specify that the area of the screen to be drawn upon coincides with
4021 :see: `EndDrawingOnTop`
4023 return _gdi_
.ScreenDC_StartDrawingOnTopWin(*args
, **kwargs
)
4025 def StartDrawingOnTop(*args
, **kwargs
):
4027 StartDrawingOnTop(self, Rect rect=None) -> bool
4029 Specify that the area is the given rectangle, or the whole screen if
4032 :see: `EndDrawingOnTop`
4034 return _gdi_
.ScreenDC_StartDrawingOnTop(*args
, **kwargs
)
4036 def EndDrawingOnTop(*args
, **kwargs
):
4038 EndDrawingOnTop(self) -> bool
4040 Use this in conjunction with `StartDrawingOnTop` or
4041 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4042 top of existing windows. Without this, some window systems (such as X)
4043 only allow drawing to take place underneath other windows.
4045 You might use this pair of functions when implementing a drag feature,
4046 for example as in the `wx.SplitterWindow` implementation.
4048 These functions are probably obsolete since the X implementations
4049 allow drawing directly on the screen now. However, the fact that this
4050 function allows the screen to be refreshed afterwards may be useful
4051 to some applications.
4053 return _gdi_
.ScreenDC_EndDrawingOnTop(*args
, **kwargs
)
4055 _gdi_
.ScreenDC_swigregister(ScreenDC
)
4057 #---------------------------------------------------------------------------
4061 A wx.ClientDC must be constructed if an application wishes to paint on
4062 the client area of a window from outside an EVT_PAINT event. This should
4063 normally be constructed as a temporary stack object; don't store a
4064 wx.ClientDC object long term.
4066 To draw on a window from within an EVT_PAINT handler, construct a
4067 `wx.PaintDC` object.
4069 To draw on the whole window including decorations, construct a
4070 `wx.WindowDC` object (Windows only).
4073 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4074 __repr__
= _swig_repr
4075 def __init__(self
, *args
, **kwargs
):
4077 __init__(self, Window win) -> ClientDC
4079 Constructor. Pass the window on which you wish to paint.
4081 _gdi_
.ClientDC_swiginit(self
,_gdi_
.new_ClientDC(*args
, **kwargs
))
4082 _gdi_
.ClientDC_swigregister(ClientDC
)
4084 #---------------------------------------------------------------------------
4088 A wx.PaintDC must be constructed if an application wishes to paint on
4089 the client area of a window from within an EVT_PAINT event
4090 handler. This should normally be constructed as a temporary stack
4091 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4092 handler, you **must** create a wx.PaintDC object within it even if you
4093 don't actually use it.
4095 Using wx.PaintDC within EVT_PAINT handlers is important because it
4096 automatically sets the clipping area to the damaged area of the
4097 window. Attempts to draw outside this area do not appear.
4099 To draw on a window from outside EVT_PAINT handlers, construct a
4100 `wx.ClientDC` object.
4103 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4104 __repr__
= _swig_repr
4105 def __init__(self
, *args
, **kwargs
):
4107 __init__(self, Window win) -> PaintDC
4109 Constructor. Pass the window on which you wish to paint.
4111 _gdi_
.PaintDC_swiginit(self
,_gdi_
.new_PaintDC(*args
, **kwargs
))
4112 _gdi_
.PaintDC_swigregister(PaintDC
)
4114 #---------------------------------------------------------------------------
4118 A wx.WindowDC must be constructed if an application wishes to paint on
4119 the whole area of a window (client and decorations). This should
4120 normally be constructed as a temporary stack object; don't store a
4123 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4124 __repr__
= _swig_repr
4125 def __init__(self
, *args
, **kwargs
):
4127 __init__(self, Window win) -> WindowDC
4129 Constructor. Pass the window on which you wish to paint.
4131 _gdi_
.WindowDC_swiginit(self
,_gdi_
.new_WindowDC(*args
, **kwargs
))
4132 _gdi_
.WindowDC_swigregister(WindowDC
)
4134 #---------------------------------------------------------------------------
4138 wx.MirrorDC is a simple wrapper class which is always associated with a
4139 real `wx.DC` object and either forwards all of its operations to it
4140 without changes (no mirroring takes place) or exchanges x and y
4141 coordinates which makes it possible to reuse the same code to draw a
4142 figure and its mirror -- i.e. reflection related to the diagonal line
4145 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4146 __repr__
= _swig_repr
4147 def __init__(self
, *args
, **kwargs
):
4149 __init__(self, DC dc, bool mirror) -> MirrorDC
4151 Creates a mirrored DC associated with the real *dc*. Everything drawn
4152 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4155 _gdi_
.MirrorDC_swiginit(self
,_gdi_
.new_MirrorDC(*args
, **kwargs
))
4156 _gdi_
.MirrorDC_swigregister(MirrorDC
)
4158 #---------------------------------------------------------------------------
4160 class PostScriptDC(DC
):
4161 """This is a `wx.DC` that can write to PostScript files on any platform."""
4162 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4163 __repr__
= _swig_repr
4164 def __init__(self
, *args
, **kwargs
):
4166 __init__(self, wxPrintData printData) -> PostScriptDC
4168 Constructs a PostScript printer device context from a `wx.PrintData`
4171 _gdi_
.PostScriptDC_swiginit(self
,_gdi_
.new_PostScriptDC(*args
, **kwargs
))
4172 def GetPrintData(*args
, **kwargs
):
4173 """GetPrintData(self) -> wxPrintData"""
4174 return _gdi_
.PostScriptDC_GetPrintData(*args
, **kwargs
)
4176 def SetPrintData(*args
, **kwargs
):
4177 """SetPrintData(self, wxPrintData data)"""
4178 return _gdi_
.PostScriptDC_SetPrintData(*args
, **kwargs
)
4180 def SetResolution(*args
, **kwargs
):
4182 SetResolution(int ppi)
4184 Set resolution (in pixels per inch) that will be used in PostScript
4185 output. Default is 720ppi.
4187 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4189 SetResolution
= staticmethod(SetResolution
)
4190 def GetResolution(*args
, **kwargs
):
4192 GetResolution() -> int
4194 Return resolution used in PostScript output.
4196 return _gdi_
.PostScriptDC_GetResolution(*args
, **kwargs
)
4198 GetResolution
= staticmethod(GetResolution
)
4199 _gdi_
.PostScriptDC_swigregister(PostScriptDC
)
4201 def PostScriptDC_SetResolution(*args
, **kwargs
):
4203 PostScriptDC_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 def PostScriptDC_GetResolution(*args
):
4212 PostScriptDC_GetResolution() -> int
4214 Return resolution used in PostScript output.
4216 return _gdi_
.PostScriptDC_GetResolution(*args
)
4218 #---------------------------------------------------------------------------
4220 class MetaFile(_core
.Object
):
4221 """Proxy of C++ MetaFile class"""
4222 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4223 __repr__
= _swig_repr
4224 def __init__(self
, *args
, **kwargs
):
4225 """__init__(self, String filename=EmptyString) -> MetaFile"""
4226 _gdi_
.MetaFile_swiginit(self
,_gdi_
.new_MetaFile(*args
, **kwargs
))
4227 _gdi_
.MetaFile_swigregister(MetaFile
)
4229 class MetaFileDC(DC
):
4230 """Proxy of C++ MetaFileDC class"""
4231 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4232 __repr__
= _swig_repr
4233 def __init__(self
, *args
, **kwargs
):
4235 __init__(self, String filename=EmptyString, int width=0, int height=0,
4236 String description=EmptyString) -> MetaFileDC
4238 _gdi_
.MetaFileDC_swiginit(self
,_gdi_
.new_MetaFileDC(*args
, **kwargs
))
4239 _gdi_
.MetaFileDC_swigregister(MetaFileDC
)
4241 class PrinterDC(DC
):
4242 """Proxy of C++ PrinterDC class"""
4243 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4244 __repr__
= _swig_repr
4245 def __init__(self
, *args
, **kwargs
):
4246 """__init__(self, wxPrintData printData) -> PrinterDC"""
4247 _gdi_
.PrinterDC_swiginit(self
,_gdi_
.new_PrinterDC(*args
, **kwargs
))
4248 _gdi_
.PrinterDC_swigregister(PrinterDC
)
4250 #---------------------------------------------------------------------------
4252 IMAGELIST_DRAW_NORMAL
= _gdi_
.IMAGELIST_DRAW_NORMAL
4253 IMAGELIST_DRAW_TRANSPARENT
= _gdi_
.IMAGELIST_DRAW_TRANSPARENT
4254 IMAGELIST_DRAW_SELECTED
= _gdi_
.IMAGELIST_DRAW_SELECTED
4255 IMAGELIST_DRAW_FOCUSED
= _gdi_
.IMAGELIST_DRAW_FOCUSED
4256 IMAGE_LIST_NORMAL
= _gdi_
.IMAGE_LIST_NORMAL
4257 IMAGE_LIST_SMALL
= _gdi_
.IMAGE_LIST_SMALL
4258 IMAGE_LIST_STATE
= _gdi_
.IMAGE_LIST_STATE
4259 class ImageList(_core
.Object
):
4260 """Proxy of C++ ImageList class"""
4261 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4262 __repr__
= _swig_repr
4263 def __init__(self
, *args
, **kwargs
):
4264 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
4265 _gdi_
.ImageList_swiginit(self
,_gdi_
.new_ImageList(*args
, **kwargs
))
4266 __swig_destroy__
= _gdi_
.delete_ImageList
4267 __del__
= lambda self
: None;
4268 def Add(*args
, **kwargs
):
4269 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
4270 return _gdi_
.ImageList_Add(*args
, **kwargs
)
4272 def AddWithColourMask(*args
, **kwargs
):
4273 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
4274 return _gdi_
.ImageList_AddWithColourMask(*args
, **kwargs
)
4276 def AddIcon(*args
, **kwargs
):
4277 """AddIcon(self, Icon icon) -> int"""
4278 return _gdi_
.ImageList_AddIcon(*args
, **kwargs
)
4280 def GetBitmap(*args
, **kwargs
):
4281 """GetBitmap(self, int index) -> Bitmap"""
4282 return _gdi_
.ImageList_GetBitmap(*args
, **kwargs
)
4284 def GetIcon(*args
, **kwargs
):
4285 """GetIcon(self, int index) -> Icon"""
4286 return _gdi_
.ImageList_GetIcon(*args
, **kwargs
)
4288 def Replace(*args
, **kwargs
):
4289 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
4290 return _gdi_
.ImageList_Replace(*args
, **kwargs
)
4292 def Draw(*args
, **kwargs
):
4294 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
4295 bool solidBackground=False) -> bool
4297 return _gdi_
.ImageList_Draw(*args
, **kwargs
)
4299 def GetImageCount(*args
, **kwargs
):
4300 """GetImageCount(self) -> int"""
4301 return _gdi_
.ImageList_GetImageCount(*args
, **kwargs
)
4303 def Remove(*args
, **kwargs
):
4304 """Remove(self, int index) -> bool"""
4305 return _gdi_
.ImageList_Remove(*args
, **kwargs
)
4307 def RemoveAll(*args
, **kwargs
):
4308 """RemoveAll(self) -> bool"""
4309 return _gdi_
.ImageList_RemoveAll(*args
, **kwargs
)
4311 def GetSize(*args
, **kwargs
):
4312 """GetSize() -> (width,height)"""
4313 return _gdi_
.ImageList_GetSize(*args
, **kwargs
)
4315 _gdi_
.ImageList_swigregister(ImageList
)
4317 #---------------------------------------------------------------------------
4319 class StockGDI(object):
4320 """Proxy of C++ StockGDI class"""
4321 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4322 __repr__
= _swig_repr
4323 BRUSH_BLACK
= _gdi_
.StockGDI_BRUSH_BLACK
4324 BRUSH_BLUE
= _gdi_
.StockGDI_BRUSH_BLUE
4325 BRUSH_CYAN
= _gdi_
.StockGDI_BRUSH_CYAN
4326 BRUSH_GREEN
= _gdi_
.StockGDI_BRUSH_GREEN
4327 BRUSH_GREY
= _gdi_
.StockGDI_BRUSH_GREY
4328 BRUSH_LIGHTGREY
= _gdi_
.StockGDI_BRUSH_LIGHTGREY
4329 BRUSH_MEDIUMGREY
= _gdi_
.StockGDI_BRUSH_MEDIUMGREY
4330 BRUSH_RED
= _gdi_
.StockGDI_BRUSH_RED
4331 BRUSH_TRANSPARENT
= _gdi_
.StockGDI_BRUSH_TRANSPARENT
4332 BRUSH_WHITE
= _gdi_
.StockGDI_BRUSH_WHITE
4333 COLOUR_BLACK
= _gdi_
.StockGDI_COLOUR_BLACK
4334 COLOUR_BLUE
= _gdi_
.StockGDI_COLOUR_BLUE
4335 COLOUR_CYAN
= _gdi_
.StockGDI_COLOUR_CYAN
4336 COLOUR_GREEN
= _gdi_
.StockGDI_COLOUR_GREEN
4337 COLOUR_LIGHTGREY
= _gdi_
.StockGDI_COLOUR_LIGHTGREY
4338 COLOUR_RED
= _gdi_
.StockGDI_COLOUR_RED
4339 COLOUR_WHITE
= _gdi_
.StockGDI_COLOUR_WHITE
4340 CURSOR_CROSS
= _gdi_
.StockGDI_CURSOR_CROSS
4341 CURSOR_HOURGLASS
= _gdi_
.StockGDI_CURSOR_HOURGLASS
4342 CURSOR_STANDARD
= _gdi_
.StockGDI_CURSOR_STANDARD
4343 FONT_ITALIC
= _gdi_
.StockGDI_FONT_ITALIC
4344 FONT_NORMAL
= _gdi_
.StockGDI_FONT_NORMAL
4345 FONT_SMALL
= _gdi_
.StockGDI_FONT_SMALL
4346 FONT_SWISS
= _gdi_
.StockGDI_FONT_SWISS
4347 PEN_BLACK
= _gdi_
.StockGDI_PEN_BLACK
4348 PEN_BLACKDASHED
= _gdi_
.StockGDI_PEN_BLACKDASHED
4349 PEN_CYAN
= _gdi_
.StockGDI_PEN_CYAN
4350 PEN_GREEN
= _gdi_
.StockGDI_PEN_GREEN
4351 PEN_GREY
= _gdi_
.StockGDI_PEN_GREY
4352 PEN_LIGHTGREY
= _gdi_
.StockGDI_PEN_LIGHTGREY
4353 PEN_MEDIUMGREY
= _gdi_
.StockGDI_PEN_MEDIUMGREY
4354 PEN_RED
= _gdi_
.StockGDI_PEN_RED
4355 PEN_TRANSPARENT
= _gdi_
.StockGDI_PEN_TRANSPARENT
4356 PEN_WHITE
= _gdi_
.StockGDI_PEN_WHITE
4357 ITEMCOUNT
= _gdi_
.StockGDI_ITEMCOUNT
4358 def __init__(self
, *args
, **kwargs
):
4359 """__init__(self) -> StockGDI"""
4360 _gdi_
.StockGDI_swiginit(self
,_gdi_
.new_StockGDI(*args
, **kwargs
))
4361 __swig_destroy__
= _gdi_
.delete_StockGDI
4362 __del__
= lambda self
: None;
4363 def DeleteAll(*args
, **kwargs
):
4365 return _gdi_
.StockGDI_DeleteAll(*args
, **kwargs
)
4367 DeleteAll
= staticmethod(DeleteAll
)
4368 def instance(*args
, **kwargs
):
4369 """instance() -> StockGDI"""
4370 return _gdi_
.StockGDI_instance(*args
, **kwargs
)
4372 instance
= staticmethod(instance
)
4373 def GetBrush(*args
, **kwargs
):
4374 """GetBrush(int item) -> Brush"""
4375 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
4377 GetBrush
= staticmethod(GetBrush
)
4378 def GetColour(*args
, **kwargs
):
4379 """GetColour(int item) -> Colour"""
4380 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
4382 GetColour
= staticmethod(GetColour
)
4383 def GetCursor(*args
, **kwargs
):
4384 """GetCursor(int item) -> Cursor"""
4385 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
4387 GetCursor
= staticmethod(GetCursor
)
4388 def GetPen(*args
, **kwargs
):
4389 """GetPen(int item) -> Pen"""
4390 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
4392 GetPen
= staticmethod(GetPen
)
4393 def GetFont(*args
, **kwargs
):
4394 """GetFont(self, int item) -> Font"""
4395 return _gdi_
.StockGDI_GetFont(*args
, **kwargs
)
4397 def _initStockObjects():
4399 wx
.ITALIC_FONT
= StockGDI
.instance().GetFont(StockGDI
.FONT_ITALIC
)
4400 wx
.NORMAL_FONT
= StockGDI
.instance().GetFont(StockGDI
.FONT_NORMAL
)
4401 wx
.SMALL_FONT
= StockGDI
.instance().GetFont(StockGDI
.FONT_SMALL
)
4402 wx
.SWISS_FONT
= StockGDI
.instance().GetFont(StockGDI
.FONT_SWISS
)
4404 wx
.BLACK_DASHED_PEN
= StockGDI
.GetPen(StockGDI
.PEN_BLACKDASHED
)
4405 wx
.BLACK_PEN
= StockGDI
.GetPen(StockGDI
.PEN_BLACK
)
4406 wx
.CYAN_PEN
= StockGDI
.GetPen(StockGDI
.PEN_CYAN
)
4407 wx
.GREEN_PEN
= StockGDI
.GetPen(StockGDI
.PEN_GREEN
)
4408 wx
.GREY_PEN
= StockGDI
.GetPen(StockGDI
.PEN_GREY
)
4409 wx
.LIGHT_GREY_PEN
= StockGDI
.GetPen(StockGDI
.PEN_LIGHTGREY
)
4410 wx
.MEDIUM_GREY_PEN
= StockGDI
.GetPen(StockGDI
.PEN_MEDIUMGREY
)
4411 wx
.RED_PEN
= StockGDI
.GetPen(StockGDI
.PEN_RED
)
4412 wx
.TRANSPARENT_PEN
= StockGDI
.GetPen(StockGDI
.PEN_TRANSPARENT
)
4413 wx
.WHITE_PEN
= StockGDI
.GetPen(StockGDI
.PEN_WHITE
)
4415 wx
.BLACK_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLACK
)
4416 wx
.BLUE_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLUE
)
4417 wx
.CYAN_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_CYAN
)
4418 wx
.GREEN_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREEN
)
4419 wx
.GREY_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREY
)
4420 wx
.LIGHT_GREY_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_LIGHTGREY
)
4421 wx
.MEDIUM_GREY_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_MEDIUMGREY
)
4422 wx
.RED_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_RED
)
4423 wx
.TRANSPARENT_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_TRANSPARENT
)
4424 wx
.WHITE_BRUSH
= StockGDI
.GetBrush(StockGDI
.BRUSH_WHITE
)
4426 wx
.BLACK
= StockGDI
.GetColour(StockGDI
.COLOUR_BLACK
)
4427 wx
.BLUE
= StockGDI
.GetColour(StockGDI
.COLOUR_BLUE
)
4428 wx
.CYAN
= StockGDI
.GetColour(StockGDI
.COLOUR_CYAN
)
4429 wx
.GREEN
= StockGDI
.GetColour(StockGDI
.COLOUR_GREEN
)
4430 wx
.LIGHT_GREY
= StockGDI
.GetColour(StockGDI
.COLOUR_LIGHTGREY
)
4431 wx
.RED
= StockGDI
.GetColour(StockGDI
.COLOUR_RED
)
4432 wx
.WHITE
= StockGDI
.GetColour(StockGDI
.COLOUR_WHITE
)
4434 wx
.CROSS_CURSOR
= StockGDI
.GetCursor(StockGDI
.CURSOR_CROSS
)
4435 wx
.HOURGLASS_CURSOR
= StockGDI
.GetCursor(StockGDI
.CURSOR_HOURGLASS
)
4436 wx
.STANDARD_CURSOR
= StockGDI
.GetCursor(StockGDI
.CURSOR_STANDARD
)
4438 _initStockObjects
= staticmethod(_initStockObjects
)
4440 _gdi_
.StockGDI_swigregister(StockGDI
)
4442 def StockGDI_DeleteAll(*args
):
4443 """StockGDI_DeleteAll()"""
4444 return _gdi_
.StockGDI_DeleteAll(*args
)
4446 def StockGDI_instance(*args
):
4447 """StockGDI_instance() -> StockGDI"""
4448 return _gdi_
.StockGDI_instance(*args
)
4450 def StockGDI_GetBrush(*args
, **kwargs
):
4451 """StockGDI_GetBrush(int item) -> Brush"""
4452 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
4454 def StockGDI_GetColour(*args
, **kwargs
):
4455 """StockGDI_GetColour(int item) -> Colour"""
4456 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
4458 def StockGDI_GetCursor(*args
, **kwargs
):
4459 """StockGDI_GetCursor(int item) -> Cursor"""
4460 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
4462 def StockGDI_GetPen(*args
, **kwargs
):
4463 """StockGDI_GetPen(int item) -> Pen"""
4464 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
4466 class GDIObjListBase(object):
4467 """Proxy of C++ GDIObjListBase class"""
4468 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4469 __repr__
= _swig_repr
4470 def __init__(self
, *args
, **kwargs
):
4471 """__init__(self) -> GDIObjListBase"""
4472 _gdi_
.GDIObjListBase_swiginit(self
,_gdi_
.new_GDIObjListBase(*args
, **kwargs
))
4473 __swig_destroy__
= _gdi_
.delete_GDIObjListBase
4474 __del__
= lambda self
: None;
4475 _gdi_
.GDIObjListBase_swigregister(GDIObjListBase
)
4477 NullBitmap
= cvar
.NullBitmap
4478 NullIcon
= cvar
.NullIcon
4479 NullCursor
= cvar
.NullCursor
4480 NullPen
= cvar
.NullPen
4481 NullBrush
= cvar
.NullBrush
4482 NullPalette
= cvar
.NullPalette
4483 NullFont
= cvar
.NullFont
4484 NullColour
= cvar
.NullColour
4486 class PenList(GDIObjListBase
):
4487 """Proxy of C++ PenList class"""
4488 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4489 def __init__(self
): raise AttributeError, "No constructor defined"
4490 __repr__
= _swig_repr
4491 def FindOrCreatePen(*args
, **kwargs
):
4492 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
4493 return _gdi_
.PenList_FindOrCreatePen(*args
, **kwargs
)
4495 def AddPen(*args
, **kwargs
):
4496 """AddPen(self, Pen pen)"""
4497 return _gdi_
.PenList_AddPen(*args
, **kwargs
)
4499 def RemovePen(*args
, **kwargs
):
4500 """RemovePen(self, Pen pen)"""
4501 return _gdi_
.PenList_RemovePen(*args
, **kwargs
)
4503 AddPen
= wx
._deprecated
(AddPen
)
4504 RemovePen
= wx
._deprecated
(RemovePen
)
4506 _gdi_
.PenList_swigregister(PenList
)
4508 class BrushList(GDIObjListBase
):
4509 """Proxy of C++ BrushList class"""
4510 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4511 def __init__(self
): raise AttributeError, "No constructor defined"
4512 __repr__
= _swig_repr
4513 def FindOrCreateBrush(*args
, **kwargs
):
4514 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
4515 return _gdi_
.BrushList_FindOrCreateBrush(*args
, **kwargs
)
4517 def AddBrush(*args
, **kwargs
):
4518 """AddBrush(self, Brush brush)"""
4519 return _gdi_
.BrushList_AddBrush(*args
, **kwargs
)
4521 def RemoveBrush(*args
, **kwargs
):
4522 """RemoveBrush(self, Brush brush)"""
4523 return _gdi_
.BrushList_RemoveBrush(*args
, **kwargs
)
4525 AddBrush
= wx
._deprecated
(AddBrush
)
4526 RemoveBrush
= wx
._deprecated
(RemoveBrush
)
4528 _gdi_
.BrushList_swigregister(BrushList
)
4530 class FontList(GDIObjListBase
):
4531 """Proxy of C++ FontList class"""
4532 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4533 def __init__(self
): raise AttributeError, "No constructor defined"
4534 __repr__
= _swig_repr
4535 def FindOrCreateFont(*args
, **kwargs
):
4537 FindOrCreateFont(self, int point_size, int family, int style, int weight,
4538 bool underline=False, String facename=EmptyString,
4539 int encoding=FONTENCODING_DEFAULT) -> Font
4541 return _gdi_
.FontList_FindOrCreateFont(*args
, **kwargs
)
4543 def AddFont(*args
, **kwargs
):
4544 """AddFont(self, Font font)"""
4545 return _gdi_
.FontList_AddFont(*args
, **kwargs
)
4547 def RemoveFont(*args
, **kwargs
):
4548 """RemoveFont(self, Font font)"""
4549 return _gdi_
.FontList_RemoveFont(*args
, **kwargs
)
4551 AddFont
= wx
._deprecated
(AddFont
)
4552 RemoveFont
= wx
._deprecated
(RemoveFont
)
4554 _gdi_
.FontList_swigregister(FontList
)
4556 class ColourDatabase(object):
4557 """Proxy of C++ ColourDatabase class"""
4558 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4559 __repr__
= _swig_repr
4560 def __init__(self
, *args
, **kwargs
):
4561 """__init__(self) -> ColourDatabase"""
4562 _gdi_
.ColourDatabase_swiginit(self
,_gdi_
.new_ColourDatabase(*args
, **kwargs
))
4563 __swig_destroy__
= _gdi_
.delete_ColourDatabase
4564 __del__
= lambda self
: None;
4565 def Find(*args
, **kwargs
):
4566 """Find(self, String name) -> Colour"""
4567 return _gdi_
.ColourDatabase_Find(*args
, **kwargs
)
4569 def FindName(*args
, **kwargs
):
4570 """FindName(self, Colour colour) -> String"""
4571 return _gdi_
.ColourDatabase_FindName(*args
, **kwargs
)
4574 def AddColour(*args
, **kwargs
):
4575 """AddColour(self, String name, Colour colour)"""
4576 return _gdi_
.ColourDatabase_AddColour(*args
, **kwargs
)
4578 def Append(*args
, **kwargs
):
4579 """Append(self, String name, int red, int green, int blue)"""
4580 return _gdi_
.ColourDatabase_Append(*args
, **kwargs
)
4582 _gdi_
.ColourDatabase_swigregister(ColourDatabase
)
4584 #---------------------------------------------------------------------------
4587 def _wxPyInitTheFontList(*args
):
4588 """_wxPyInitTheFontList() -> FontList"""
4589 return _gdi_
._wxPyInitTheFontList
(*args
)
4591 def _wxPyInitThePenList(*args
):
4592 """_wxPyInitThePenList() -> PenList"""
4593 return _gdi_
._wxPyInitThePenList
(*args
)
4595 def _wxPyInitTheBrushList(*args
):
4596 """_wxPyInitTheBrushList() -> BrushList"""
4597 return _gdi_
._wxPyInitTheBrushList
(*args
)
4599 def _wxPyInitTheColourDatabase(*args
):
4600 """_wxPyInitTheColourDatabase() -> ColourDatabase"""
4601 return _gdi_
._wxPyInitTheColourDatabase
(*args
)
4602 # This function makes a class used to do delayed initialization of some
4603 # stock wx objects. When they are used the first time then an init function
4604 # is called to make the real instance, which is then used to replace the
4605 # original instance and class seen by the programmer.
4606 def _wxPyMakeDelayedInitWrapper(initFunc
):
4607 class _wxPyStockObjectWrapper(object):
4608 def __init__(self
, *args
):
4610 def __getattr__(self
, name
):
4611 obj
= initFunc(*self
._args
)
4612 self
.__class
__ = obj
.__class
__
4613 self
.__dict
__ = obj
.__dict
__
4614 return getattr(self
, name
)
4616 return self
.__getattr
__("__str__")()
4618 return self
.__getattr
__("__repr__")()
4619 return _wxPyStockObjectWrapper
4621 TheFontList
= _wxPyMakeDelayedInitWrapper(_wxPyInitTheFontList
)()
4622 ThePenList
= _wxPyMakeDelayedInitWrapper(_wxPyInitThePenList
)()
4623 TheBrushList
= _wxPyMakeDelayedInitWrapper(_wxPyInitTheBrushList
)()
4624 TheColourDatabase
= _wxPyMakeDelayedInitWrapper(_wxPyInitTheColourDatabase
)()
4626 NullColor
= NullColour
4627 #---------------------------------------------------------------------------
4629 class Effects(_core
.Object
):
4630 """Proxy of C++ Effects class"""
4631 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4632 __repr__
= _swig_repr
4633 def __init__(self
, *args
, **kwargs
):
4634 """__init__(self) -> Effects"""
4635 _gdi_
.Effects_swiginit(self
,_gdi_
.new_Effects(*args
, **kwargs
))
4636 def GetHighlightColour(*args
, **kwargs
):
4637 """GetHighlightColour(self) -> Colour"""
4638 return _gdi_
.Effects_GetHighlightColour(*args
, **kwargs
)
4640 def GetLightShadow(*args
, **kwargs
):
4641 """GetLightShadow(self) -> Colour"""
4642 return _gdi_
.Effects_GetLightShadow(*args
, **kwargs
)
4644 def GetFaceColour(*args
, **kwargs
):
4645 """GetFaceColour(self) -> Colour"""
4646 return _gdi_
.Effects_GetFaceColour(*args
, **kwargs
)
4648 def GetMediumShadow(*args
, **kwargs
):
4649 """GetMediumShadow(self) -> Colour"""
4650 return _gdi_
.Effects_GetMediumShadow(*args
, **kwargs
)
4652 def GetDarkShadow(*args
, **kwargs
):
4653 """GetDarkShadow(self) -> Colour"""
4654 return _gdi_
.Effects_GetDarkShadow(*args
, **kwargs
)
4656 def SetHighlightColour(*args
, **kwargs
):
4657 """SetHighlightColour(self, Colour c)"""
4658 return _gdi_
.Effects_SetHighlightColour(*args
, **kwargs
)
4660 def SetLightShadow(*args
, **kwargs
):
4661 """SetLightShadow(self, Colour c)"""
4662 return _gdi_
.Effects_SetLightShadow(*args
, **kwargs
)
4664 def SetFaceColour(*args
, **kwargs
):
4665 """SetFaceColour(self, Colour c)"""
4666 return _gdi_
.Effects_SetFaceColour(*args
, **kwargs
)
4668 def SetMediumShadow(*args
, **kwargs
):
4669 """SetMediumShadow(self, Colour c)"""
4670 return _gdi_
.Effects_SetMediumShadow(*args
, **kwargs
)
4672 def SetDarkShadow(*args
, **kwargs
):
4673 """SetDarkShadow(self, Colour c)"""
4674 return _gdi_
.Effects_SetDarkShadow(*args
, **kwargs
)
4676 def Set(*args
, **kwargs
):
4678 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
4679 Colour mediumShadow, Colour darkShadow)
4681 return _gdi_
.Effects_Set(*args
, **kwargs
)
4683 def DrawSunkenEdge(*args
, **kwargs
):
4684 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
4685 return _gdi_
.Effects_DrawSunkenEdge(*args
, **kwargs
)
4687 def TileBitmap(*args
, **kwargs
):
4688 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
4689 return _gdi_
.Effects_TileBitmap(*args
, **kwargs
)
4691 _gdi_
.Effects_swigregister(Effects
)
4693 #---------------------------------------------------------------------------
4695 CONTROL_DISABLED
= _gdi_
.CONTROL_DISABLED
4696 CONTROL_FOCUSED
= _gdi_
.CONTROL_FOCUSED
4697 CONTROL_PRESSED
= _gdi_
.CONTROL_PRESSED
4698 CONTROL_ISDEFAULT
= _gdi_
.CONTROL_ISDEFAULT
4699 CONTROL_ISSUBMENU
= _gdi_
.CONTROL_ISSUBMENU
4700 CONTROL_EXPANDED
= _gdi_
.CONTROL_EXPANDED
4701 CONTROL_CURRENT
= _gdi_
.CONTROL_CURRENT
4702 CONTROL_SELECTED
= _gdi_
.CONTROL_SELECTED
4703 CONTROL_CHECKED
= _gdi_
.CONTROL_CHECKED
4704 CONTROL_CHECKABLE
= _gdi_
.CONTROL_CHECKABLE
4705 CONTROL_UNDETERMINED
= _gdi_
.CONTROL_UNDETERMINED
4706 CONTROL_FLAGS_MASK
= _gdi_
.CONTROL_FLAGS_MASK
4707 CONTROL_DIRTY
= _gdi_
.CONTROL_DIRTY
4708 class SplitterRenderParams(object):
4710 This is just a simple struct used as a return value of
4711 `wx.RendererNative.GetSplitterParams` and contains some platform
4712 specific metrics about splitters.
4714 * widthSash: the width of the splitter sash.
4715 * border: the width of the border of the splitter window.
4716 * isHotSensitive: ``True`` if the splitter changes its
4717 appearance when the mouse is over it.
4721 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4722 __repr__
= _swig_repr
4723 def __init__(self
, *args
, **kwargs
):
4725 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
4727 This is just a simple struct used as a return value of
4728 `wx.RendererNative.GetSplitterParams` and contains some platform
4729 specific metrics about splitters.
4731 * widthSash: the width of the splitter sash.
4732 * border: the width of the border of the splitter window.
4733 * isHotSensitive: ``True`` if the splitter changes its
4734 appearance when the mouse is over it.
4738 _gdi_
.SplitterRenderParams_swiginit(self
,_gdi_
.new_SplitterRenderParams(*args
, **kwargs
))
4739 __swig_destroy__
= _gdi_
.delete_SplitterRenderParams
4740 __del__
= lambda self
: None;
4741 widthSash
= property(_gdi_
.SplitterRenderParams_widthSash_get
)
4742 border
= property(_gdi_
.SplitterRenderParams_border_get
)
4743 isHotSensitive
= property(_gdi_
.SplitterRenderParams_isHotSensitive_get
)
4744 _gdi_
.SplitterRenderParams_swigregister(SplitterRenderParams
)
4746 class RendererVersion(object):
4748 This simple struct represents the `wx.RendererNative` interface
4749 version and is only used as the return value of
4750 `wx.RendererNative.GetVersion`.
4752 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4753 __repr__
= _swig_repr
4754 def __init__(self
, *args
, **kwargs
):
4756 __init__(self, int version_, int age_) -> RendererVersion
4758 This simple struct represents the `wx.RendererNative` interface
4759 version and is only used as the return value of
4760 `wx.RendererNative.GetVersion`.
4762 _gdi_
.RendererVersion_swiginit(self
,_gdi_
.new_RendererVersion(*args
, **kwargs
))
4763 __swig_destroy__
= _gdi_
.delete_RendererVersion
4764 __del__
= lambda self
: None;
4765 Current_Version
= _gdi_
.RendererVersion_Current_Version
4766 Current_Age
= _gdi_
.RendererVersion_Current_Age
4767 def IsCompatible(*args
, **kwargs
):
4768 """IsCompatible(RendererVersion ver) -> bool"""
4769 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
4771 IsCompatible
= staticmethod(IsCompatible
)
4772 version
= property(_gdi_
.RendererVersion_version_get
)
4773 age
= property(_gdi_
.RendererVersion_age_get
)
4774 _gdi_
.RendererVersion_swigregister(RendererVersion
)
4776 def RendererVersion_IsCompatible(*args
, **kwargs
):
4777 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
4778 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
4780 class RendererNative(object):
4782 One of the design principles of wxWidgets is to use the native widgets
4783 on every platform in order to be as close to the native look and feel
4784 on every platform. However there are still cases when some generic
4785 widgets are needed for various reasons, but it can sometimes take a
4786 lot of messy work to make them conform to the native LnF.
4788 The wx.RendererNative class is a collection of functions that have
4789 platform-specific implementations for drawing certain parts of
4790 genereic controls in ways that are as close to the native look as
4793 Note that each drawing function restores the `wx.DC` attributes if it
4794 changes them, so it is safe to assume that the same pen, brush and
4795 colours that were active before the call to this function are still in
4799 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4800 def __init__(self
): raise AttributeError, "No constructor defined"
4801 __repr__
= _swig_repr
4802 def DrawHeaderButton(*args
, **kwargs
):
4804 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0)
4806 Draw the header control button (such as what is used by `wx.ListCtrl`
4809 return _gdi_
.RendererNative_DrawHeaderButton(*args
, **kwargs
)
4811 def DrawTreeItemButton(*args
, **kwargs
):
4813 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
4815 Draw the expanded/collapsed icon for a tree control item.
4817 return _gdi_
.RendererNative_DrawTreeItemButton(*args
, **kwargs
)
4819 def DrawSplitterBorder(*args
, **kwargs
):
4821 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
4823 Draw the border for a sash window: this border must be such that the
4824 sash drawn by `DrawSplitterSash` blends into it well.
4826 return _gdi_
.RendererNative_DrawSplitterBorder(*args
, **kwargs
)
4828 def DrawSplitterSash(*args
, **kwargs
):
4830 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
4833 Draw a sash. The orient parameter defines whether the sash should be
4834 vertical or horizontal and how the position should be interpreted.
4836 return _gdi_
.RendererNative_DrawSplitterSash(*args
, **kwargs
)
4838 def DrawComboBoxDropButton(*args
, **kwargs
):
4840 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
4842 Draw a button like the one used by `wx.ComboBox` to show a drop down
4843 window. The usual appearance is a downwards pointing arrow.
4845 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
4846 ``wx.CONTROL_CURRENT`` bits set.
4848 return _gdi_
.RendererNative_DrawComboBoxDropButton(*args
, **kwargs
)
4850 def DrawDropArrow(*args
, **kwargs
):
4852 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
4854 Draw a drop down arrow that is suitable for use outside a combo
4855 box. Arrow will have a transparent background.
4857 ``rect`` is not entirely filled by the arrow. Instead, you should use
4858 bounding rectangle of a drop down button which arrow matches the size
4859 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
4860 ``wx.CONTROL_CURRENT`` bit set.
4862 return _gdi_
.RendererNative_DrawDropArrow(*args
, **kwargs
)
4864 def DrawCheckBox(*args
, **kwargs
):
4866 DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0)
4868 Draw a check button. Flags may use wx.CONTROL_CHECKED,
4869 wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.
4871 return _gdi_
.RendererNative_DrawCheckBox(*args
, **kwargs
)
4873 def DrawPushButton(*args
, **kwargs
):
4875 DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0)
4877 Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
4878 wx.CONTROL_ISDEFAULT
4880 return _gdi_
.RendererNative_DrawPushButton(*args
, **kwargs
)
4882 def DrawItemSelectionRect(*args
, **kwargs
):
4884 DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0)
4886 Draw rectangle indicating that an item in e.g. a list control has been
4889 The flags parameter may be:
4891 ==================== ============================================
4892 wx.CONTROL_SELECTED item is selected, e.g. draw background
4893 wx.CONTROL_CURRENT item is the current item, e.g. dotted border
4894 wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
4895 background vs. grey otherwise
4896 ==================== ============================================
4899 return _gdi_
.RendererNative_DrawItemSelectionRect(*args
, **kwargs
)
4901 def GetSplitterParams(*args
, **kwargs
):
4903 GetSplitterParams(self, Window win) -> SplitterRenderParams
4905 Get the splitter parameters, see `wx.SplitterRenderParams`.
4907 return _gdi_
.RendererNative_GetSplitterParams(*args
, **kwargs
)
4909 def Get(*args
, **kwargs
):
4911 Get() -> RendererNative
4913 Return the currently used renderer
4915 return _gdi_
.RendererNative_Get(*args
, **kwargs
)
4917 Get
= staticmethod(Get
)
4918 def GetGeneric(*args
, **kwargs
):
4920 GetGeneric() -> RendererNative
4922 Return the generic implementation of the renderer. Under some
4923 platforms, this is the default renderer implementation, others have
4924 platform-specific default renderer which can be retrieved by calling
4927 return _gdi_
.RendererNative_GetGeneric(*args
, **kwargs
)
4929 GetGeneric
= staticmethod(GetGeneric
)
4930 def GetDefault(*args
, **kwargs
):
4932 GetDefault() -> RendererNative
4934 Return the default (native) implementation for this platform -- this
4935 is also the one used by default but this may be changed by calling `Set`
4936 in which case the return value of this method may be different from
4937 the return value of `Get`.
4939 return _gdi_
.RendererNative_GetDefault(*args
, **kwargs
)
4941 GetDefault
= staticmethod(GetDefault
)
4942 def Set(*args
, **kwargs
):
4944 Set(RendererNative renderer) -> RendererNative
4946 Set the renderer to use, passing None reverts to using the default
4947 renderer. Returns the previous renderer used with Set or None.
4949 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
4951 Set
= staticmethod(Set
)
4952 def GetVersion(*args
, **kwargs
):
4954 GetVersion(self) -> RendererVersion
4956 Returns the version of the renderer. Will be used for ensuring
4957 compatibility of dynamically loaded renderers.
4959 return _gdi_
.RendererNative_GetVersion(*args
, **kwargs
)
4961 _gdi_
.RendererNative_swigregister(RendererNative
)
4963 def RendererNative_Get(*args
):
4965 RendererNative_Get() -> RendererNative
4967 Return the currently used renderer
4969 return _gdi_
.RendererNative_Get(*args
)
4971 def RendererNative_GetGeneric(*args
):
4973 RendererNative_GetGeneric() -> RendererNative
4975 Return the generic implementation of the renderer. Under some
4976 platforms, this is the default renderer implementation, others have
4977 platform-specific default renderer which can be retrieved by calling
4980 return _gdi_
.RendererNative_GetGeneric(*args
)
4982 def RendererNative_GetDefault(*args
):
4984 RendererNative_GetDefault() -> RendererNative
4986 Return the default (native) implementation for this platform -- this
4987 is also the one used by default but this may be changed by calling `Set`
4988 in which case the return value of this method may be different from
4989 the return value of `Get`.
4991 return _gdi_
.RendererNative_GetDefault(*args
)
4993 def RendererNative_Set(*args
, **kwargs
):
4995 RendererNative_Set(RendererNative renderer) -> RendererNative
4997 Set the renderer to use, passing None reverts to using the default
4998 renderer. Returns the previous renderer used with Set or None.
5000 return _gdi_
.RendererNative_Set(*args
, **kwargs
)