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 ALPHA_TRANSPARENT
= _gdi_
.ALPHA_TRANSPARENT
79 ALPHA_OPAQUE
= _gdi_
.ALPHA_OPAQUE
80 class Colour(_core
.Object
):
82 A colour is an object representing a combination of Red, Green, and
83 Blue (RGB) intensity values, and is used to determine drawing colours,
84 window colours, etc. Valid RGB values are in the range 0 to 255.
86 In wxPython there are typemaps that will automatically convert from a
87 colour name, from a '#RRGGBB' colour hex value string, or from a 3
88 integer tuple to a wx.Colour object when calling C++ methods that
89 expect a wxColour. This means that the following are all
92 win.SetBackgroundColour(wxColour(0,0,255))
93 win.SetBackgroundColour('BLUE')
94 win.SetBackgroundColour('#0000FF')
95 win.SetBackgroundColour((0,0,255))
97 Additional colour names and their coresponding values can be added
98 using `wx.ColourDatabase`. Various system colours (as set in the
99 user's system preferences) can be retrieved with
100 `wx.SystemSettings.GetColour`.
103 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
104 __repr__
= _swig_repr
105 def __init__(self
, *args
, **kwargs
):
107 __init__(self, byte red=0, byte green=0, byte blue=0, byte alpha=ALPHA_OPAQUE) -> Colour
109 Constructs a colour from red, green and blue values.
111 :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
114 _gdi_
.Colour_swiginit(self
,_gdi_
.new_Colour(*args
, **kwargs
))
115 __swig_destroy__
= _gdi_
.delete_Colour
116 __del__
= lambda self
: None;
117 def Red(*args
, **kwargs
):
121 Returns the red intensity.
123 return _gdi_
.Colour_Red(*args
, **kwargs
)
125 def Green(*args
, **kwargs
):
129 Returns the green intensity.
131 return _gdi_
.Colour_Green(*args
, **kwargs
)
133 def Blue(*args
, **kwargs
):
137 Returns the blue intensity.
139 return _gdi_
.Colour_Blue(*args
, **kwargs
)
141 def Alpha(*args
, **kwargs
):
145 Returns the Alpha value.
147 return _gdi_
.Colour_Alpha(*args
, **kwargs
)
149 def Ok(*args
, **kwargs
):
153 Returns True if the colour object is valid (the colour has been
154 initialised with RGB values).
156 return _gdi_
.Colour_Ok(*args
, **kwargs
)
158 def Set(*args
, **kwargs
):
160 Set(self, byte red, byte green, byte blue, byte alpha=ALPHA_OPAQUE)
162 Sets the RGB intensity values.
164 return _gdi_
.Colour_Set(*args
, **kwargs
)
166 def SetRGB(*args
, **kwargs
):
168 SetRGB(self, unsigned long colRGB)
170 Sets the RGB intensity values from a packed RGB value.
172 return _gdi_
.Colour_SetRGB(*args
, **kwargs
)
174 def SetFromName(*args
, **kwargs
):
176 SetFromName(self, String colourName)
178 Sets the RGB intensity values using a colour name listed in
179 ``wx.TheColourDatabase``.
181 return _gdi_
.Colour_SetFromName(*args
, **kwargs
)
183 def GetAsString(*args
, **kwargs
):
185 GetAsString(self, long flags=wxC2S_NAME|wxC2S_CSS_SYNTAX) -> String
187 Return the colour as a string. Acceptable flags are:
189 =================== ==================================
190 wx.C2S_NAME return colour name, when possible
191 wx.C2S_CSS_SYNTAX return colour in rgb(r,g,b) syntax
192 wx.C2S_HTML_SYNTAX return colour in #rrggbb syntax
193 =================== ==================================
195 return _gdi_
.Colour_GetAsString(*args
, **kwargs
)
197 def GetPixel(*args
, **kwargs
):
199 GetPixel(self) -> long
201 Returns a pixel value which is platform-dependent. On Windows, a
202 COLORREF is returned. On X, an allocated pixel value is returned. -1
203 is returned if the pixel is invalid (on X, unallocated).
205 return _gdi_
.Colour_GetPixel(*args
, **kwargs
)
207 def __eq__(*args
, **kwargs
):
209 __eq__(self, PyObject other) -> bool
211 Compare colours for equality.
213 return _gdi_
.Colour___eq__(*args
, **kwargs
)
215 def __ne__(*args
, **kwargs
):
217 __ne__(self, PyObject other) -> bool
219 Compare colours for inequality.
221 return _gdi_
.Colour___ne__(*args
, **kwargs
)
223 def Get(*args
, **kwargs
):
227 Returns the RGB intensity values as a tuple.
229 return _gdi_
.Colour_Get(*args
, **kwargs
)
231 def GetRGB(*args
, **kwargs
):
233 GetRGB(self) -> unsigned long
235 Return the colour as a packed RGB value
237 return _gdi_
.Colour_GetRGB(*args
, **kwargs
)
239 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
240 def __str__(self
): return str(self
.Get(True))
241 def __repr__(self
): return 'wx.Colour' + str(self
.Get(True))
242 def __nonzero__(self
): return self
.Ok()
243 __safe_for_unpickling__
= True
244 def __reduce__(self
): return (Colour
, self
.Get(True))
246 Pixel
= property(GetPixel
,doc
="See `GetPixel`")
247 RGB
= property(GetRGB
,SetRGB
,doc
="See `GetRGB` and `SetRGB`")
248 _gdi_
.Colour_swigregister(Colour
)
250 def NamedColour(*args
, **kwargs
):
252 NamedColour(String colorName) -> Colour
254 Constructs a colour object using a colour name listed in
255 ``wx.TheColourDatabase``.
257 val
= _gdi_
.new_NamedColour(*args
, **kwargs
)
260 def ColourRGB(*args
, **kwargs
):
262 ColourRGB(unsigned long colRGB) -> Colour
264 Constructs a colour from a packed RGB value.
266 val
= _gdi_
.new_ColourRGB(*args
, **kwargs
)
270 NamedColor
= NamedColour
273 class Palette(GDIObject
):
274 """Proxy of C++ Palette class"""
275 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
276 __repr__
= _swig_repr
277 def __init__(self
, *args
, **kwargs
):
278 """__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette"""
279 _gdi_
.Palette_swiginit(self
,_gdi_
.new_Palette(*args
, **kwargs
))
280 __swig_destroy__
= _gdi_
.delete_Palette
281 __del__
= lambda self
: None;
282 def GetPixel(*args
, **kwargs
):
283 """GetPixel(self, byte red, byte green, byte blue) -> int"""
284 return _gdi_
.Palette_GetPixel(*args
, **kwargs
)
286 def GetRGB(*args
, **kwargs
):
287 """GetRGB(self, int pixel) -> (R,G,B)"""
288 return _gdi_
.Palette_GetRGB(*args
, **kwargs
)
290 def GetColoursCount(*args
, **kwargs
):
291 """GetColoursCount(self) -> int"""
292 return _gdi_
.Palette_GetColoursCount(*args
, **kwargs
)
294 def Ok(*args
, **kwargs
):
295 """Ok(self) -> bool"""
296 return _gdi_
.Palette_Ok(*args
, **kwargs
)
298 def __nonzero__(self
): return self
.Ok()
299 _gdi_
.Palette_swigregister(Palette
)
301 #---------------------------------------------------------------------------
303 class Pen(GDIObject
):
304 """Proxy of C++ Pen class"""
305 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
306 __repr__
= _swig_repr
307 def __init__(self
, *args
, **kwargs
):
308 """__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen"""
309 _gdi_
.Pen_swiginit(self
,_gdi_
.new_Pen(*args
, **kwargs
))
310 __swig_destroy__
= _gdi_
.delete_Pen
311 __del__
= lambda self
: None;
312 def GetCap(*args
, **kwargs
):
313 """GetCap(self) -> int"""
314 return _gdi_
.Pen_GetCap(*args
, **kwargs
)
316 def GetColour(*args
, **kwargs
):
317 """GetColour(self) -> Colour"""
318 return _gdi_
.Pen_GetColour(*args
, **kwargs
)
320 def GetJoin(*args
, **kwargs
):
321 """GetJoin(self) -> int"""
322 return _gdi_
.Pen_GetJoin(*args
, **kwargs
)
324 def GetStyle(*args
, **kwargs
):
325 """GetStyle(self) -> int"""
326 return _gdi_
.Pen_GetStyle(*args
, **kwargs
)
328 def GetWidth(*args
, **kwargs
):
329 """GetWidth(self) -> int"""
330 return _gdi_
.Pen_GetWidth(*args
, **kwargs
)
332 def Ok(*args
, **kwargs
):
333 """Ok(self) -> bool"""
334 return _gdi_
.Pen_Ok(*args
, **kwargs
)
336 def SetCap(*args
, **kwargs
):
337 """SetCap(self, int cap_style)"""
338 return _gdi_
.Pen_SetCap(*args
, **kwargs
)
340 def SetColour(*args
, **kwargs
):
341 """SetColour(self, Colour colour)"""
342 return _gdi_
.Pen_SetColour(*args
, **kwargs
)
344 def SetJoin(*args
, **kwargs
):
345 """SetJoin(self, int join_style)"""
346 return _gdi_
.Pen_SetJoin(*args
, **kwargs
)
348 def SetStyle(*args
, **kwargs
):
349 """SetStyle(self, int style)"""
350 return _gdi_
.Pen_SetStyle(*args
, **kwargs
)
352 def SetWidth(*args
, **kwargs
):
353 """SetWidth(self, int width)"""
354 return _gdi_
.Pen_SetWidth(*args
, **kwargs
)
356 def SetDashes(*args
, **kwargs
):
357 """SetDashes(self, int dashes)"""
358 return _gdi_
.Pen_SetDashes(*args
, **kwargs
)
360 def GetDashes(*args
, **kwargs
):
361 """GetDashes(self) -> PyObject"""
362 return _gdi_
.Pen_GetDashes(*args
, **kwargs
)
364 def _SetDashes(*args
, **kwargs
):
365 """_SetDashes(self, PyObject _self, PyObject pyDashes)"""
366 return _gdi_
.Pen__SetDashes(*args
, **kwargs
)
368 def SetDashes(self
, dashes
):
370 Associate a list of dash lengths with the Pen.
372 self
._SetDashes
(self
, dashes
)
374 def __eq__(*args
, **kwargs
):
375 """__eq__(self, Pen other) -> bool"""
376 return _gdi_
.Pen___eq__(*args
, **kwargs
)
378 def __ne__(*args
, **kwargs
):
379 """__ne__(self, Pen other) -> bool"""
380 return _gdi_
.Pen___ne__(*args
, **kwargs
)
382 def __nonzero__(self
): return self
.Ok()
383 _gdi_
.Pen_swigregister(Pen
)
385 #---------------------------------------------------------------------------
387 class Brush(GDIObject
):
389 A brush is a drawing tool for filling in areas. It is used for
390 painting the background of rectangles, ellipses, etc. when drawing on
391 a `wx.DC`. It has a colour and a style.
393 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
394 __repr__
= _swig_repr
395 def __init__(self
, *args
, **kwargs
):
397 __init__(self, Colour colour, int style=SOLID) -> Brush
399 Constructs a brush from a `wx.Colour` object and a style.
401 _gdi_
.Brush_swiginit(self
,_gdi_
.new_Brush(*args
, **kwargs
))
402 __swig_destroy__
= _gdi_
.delete_Brush
403 __del__
= lambda self
: None;
404 def SetColour(*args
, **kwargs
):
406 SetColour(self, Colour col)
408 Set the brush's `wx.Colour`.
410 return _gdi_
.Brush_SetColour(*args
, **kwargs
)
412 def SetStyle(*args
, **kwargs
):
414 SetStyle(self, int style)
416 Sets the style of the brush. See `__init__` for a listing of styles.
418 return _gdi_
.Brush_SetStyle(*args
, **kwargs
)
420 def SetStipple(*args
, **kwargs
):
422 SetStipple(self, Bitmap stipple)
424 Sets the stipple `wx.Bitmap`.
426 return _gdi_
.Brush_SetStipple(*args
, **kwargs
)
428 def GetColour(*args
, **kwargs
):
430 GetColour(self) -> Colour
432 Returns the `wx.Colour` of the brush.
434 return _gdi_
.Brush_GetColour(*args
, **kwargs
)
436 def GetStyle(*args
, **kwargs
):
438 GetStyle(self) -> int
440 Returns the style of the brush. See `__init__` for a listing of
443 return _gdi_
.Brush_GetStyle(*args
, **kwargs
)
445 def GetStipple(*args
, **kwargs
):
447 GetStipple(self) -> Bitmap
449 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
450 have a wx.STIPPLE style, then the return value may be non-None but an
451 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
453 return _gdi_
.Brush_GetStipple(*args
, **kwargs
)
455 def IsHatch(*args
, **kwargs
):
457 IsHatch(self) -> bool
459 Is the current style a hatch type?
461 return _gdi_
.Brush_IsHatch(*args
, **kwargs
)
463 def Ok(*args
, **kwargs
):
467 Returns True if the brush is initialised and valid.
469 return _gdi_
.Brush_Ok(*args
, **kwargs
)
471 def MacGetTheme(*args
, **kwargs
):
472 """MacGetTheme(self) -> short"""
473 return _gdi_
.Brush_MacGetTheme(*args
, **kwargs
)
475 def MacSetTheme(*args
, **kwargs
):
476 """MacSetTheme(self, short macThemeBrush)"""
477 return _gdi_
.Brush_MacSetTheme(*args
, **kwargs
)
479 def __nonzero__(self
): return self
.Ok()
480 Colour
= property(GetColour
,SetColour
,doc
="See `GetColour` and `SetColour`")
481 Stipple
= property(GetStipple
,SetStipple
,doc
="See `GetStipple` and `SetStipple`")
482 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
483 _gdi_
.Brush_swigregister(Brush
)
485 def BrushFromBitmap(*args
, **kwargs
):
487 BrushFromBitmap(Bitmap stippleBitmap) -> Brush
489 Constructs a stippled brush using a bitmap.
491 val
= _gdi_
.new_BrushFromBitmap(*args
, **kwargs
)
494 class Bitmap(GDIObject
):
496 The wx.Bitmap class encapsulates the concept of a platform-dependent
497 bitmap. It can be either monochrome or colour, and either loaded from
498 a file or created dynamically. A bitmap can be selected into a memory
499 device context (instance of `wx.MemoryDC`). This enables the bitmap to
500 be copied to a window or memory device context using `wx.DC.Blit`, or
501 to be used as a drawing surface.
503 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
504 __repr__
= _swig_repr
505 def __init__(self
, *args
, **kwargs
):
507 __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap
509 Loads a bitmap from a file.
511 _gdi_
.Bitmap_swiginit(self
,_gdi_
.new_Bitmap(*args
, **kwargs
))
512 __swig_destroy__
= _gdi_
.delete_Bitmap
513 __del__
= lambda self
: None;
514 def Ok(*args
, **kwargs
):
515 """Ok(self) -> bool"""
516 return _gdi_
.Bitmap_Ok(*args
, **kwargs
)
518 def GetWidth(*args
, **kwargs
):
520 GetWidth(self) -> int
522 Gets the width of the bitmap in pixels.
524 return _gdi_
.Bitmap_GetWidth(*args
, **kwargs
)
526 def GetHeight(*args
, **kwargs
):
528 GetHeight(self) -> int
530 Gets the height of the bitmap in pixels.
532 return _gdi_
.Bitmap_GetHeight(*args
, **kwargs
)
534 def GetDepth(*args
, **kwargs
):
536 GetDepth(self) -> int
538 Gets the colour depth of the bitmap. A value of 1 indicates a
541 return _gdi_
.Bitmap_GetDepth(*args
, **kwargs
)
543 def GetSize(*args
, **kwargs
):
545 GetSize(self) -> Size
547 Get the size of the bitmap.
549 return _gdi_
.Bitmap_GetSize(*args
, **kwargs
)
551 def ConvertToImage(*args
, **kwargs
):
553 ConvertToImage(self) -> Image
555 Creates a platform-independent image from a platform-dependent
556 bitmap. This preserves mask information so that bitmaps and images can
557 be converted back and forth without loss in that respect.
559 return _gdi_
.Bitmap_ConvertToImage(*args
, **kwargs
)
561 def GetMask(*args
, **kwargs
):
563 GetMask(self) -> Mask
565 Gets the associated mask (if any) which may have been loaded from a
566 file or explpicitly set for the bitmap.
568 :see: `SetMask`, `wx.Mask`
571 return _gdi_
.Bitmap_GetMask(*args
, **kwargs
)
573 def SetMask(*args
, **kwargs
):
575 SetMask(self, Mask mask)
577 Sets the mask for this bitmap.
579 :see: `GetMask`, `wx.Mask`
582 return _gdi_
.Bitmap_SetMask(*args
, **kwargs
)
584 def SetMaskColour(*args
, **kwargs
):
586 SetMaskColour(self, Colour colour)
588 Create a Mask based on a specified colour in the Bitmap.
590 return _gdi_
.Bitmap_SetMaskColour(*args
, **kwargs
)
592 def GetSubBitmap(*args
, **kwargs
):
594 GetSubBitmap(self, Rect rect) -> Bitmap
596 Returns a sub-bitmap of the current one as long as the rect belongs
597 entirely to the bitmap. This function preserves bit depth and mask
600 return _gdi_
.Bitmap_GetSubBitmap(*args
, **kwargs
)
602 def SaveFile(*args
, **kwargs
):
604 SaveFile(self, String name, int type, Palette palette=None) -> bool
606 Saves a bitmap in the named file. See `__init__` for a description of
607 the ``type`` parameter.
609 return _gdi_
.Bitmap_SaveFile(*args
, **kwargs
)
611 def LoadFile(*args
, **kwargs
):
613 LoadFile(self, String name, int type) -> bool
615 Loads a bitmap from a file. See `__init__` for a description of the
618 return _gdi_
.Bitmap_LoadFile(*args
, **kwargs
)
620 def GetPalette(*args
, **kwargs
):
621 """GetPalette(self) -> Palette"""
622 return _gdi_
.Bitmap_GetPalette(*args
, **kwargs
)
624 def CopyFromIcon(*args
, **kwargs
):
625 """CopyFromIcon(self, Icon icon) -> bool"""
626 return _gdi_
.Bitmap_CopyFromIcon(*args
, **kwargs
)
628 def SetHeight(*args
, **kwargs
):
630 SetHeight(self, int height)
632 Set the height property (does not affect the existing bitmap data).
634 return _gdi_
.Bitmap_SetHeight(*args
, **kwargs
)
636 def SetWidth(*args
, **kwargs
):
638 SetWidth(self, int width)
640 Set the width property (does not affect the existing bitmap data).
642 return _gdi_
.Bitmap_SetWidth(*args
, **kwargs
)
644 def SetDepth(*args
, **kwargs
):
646 SetDepth(self, int depth)
648 Set the depth property (does not affect the existing bitmap data).
650 return _gdi_
.Bitmap_SetDepth(*args
, **kwargs
)
652 def SetSize(*args
, **kwargs
):
654 SetSize(self, Size size)
656 Set the bitmap size (does not affect the existing bitmap data).
658 return _gdi_
.Bitmap_SetSize(*args
, **kwargs
)
660 def __nonzero__(self
): return self
.Ok()
661 def __eq__(*args
, **kwargs
):
662 """__eq__(self, Bitmap other) -> bool"""
663 return _gdi_
.Bitmap___eq__(*args
, **kwargs
)
665 def __ne__(*args
, **kwargs
):
666 """__ne__(self, Bitmap other) -> bool"""
667 return _gdi_
.Bitmap___ne__(*args
, **kwargs
)
669 Depth
= property(GetDepth
,SetDepth
,doc
="See `GetDepth` and `SetDepth`")
670 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
671 Mask
= property(GetMask
,SetMask
,doc
="See `GetMask` and `SetMask`")
672 Palette
= property(GetPalette
,doc
="See `GetPalette`")
673 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
674 SubBitmap
= property(GetSubBitmap
,doc
="See `GetSubBitmap`")
675 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
676 _gdi_
.Bitmap_swigregister(Bitmap
)
678 def EmptyBitmap(*args
, **kwargs
):
680 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
682 Creates a new bitmap of the given size. A depth of -1 indicates the
683 depth of the current screen or visual. Some platforms only support 1
684 for monochrome and -1 for the current display depth.
686 val
= _gdi_
.new_EmptyBitmap(*args
, **kwargs
)
689 def BitmapFromIcon(*args
, **kwargs
):
691 BitmapFromIcon(Icon icon) -> Bitmap
693 Create a new bitmap from a `wx.Icon` object.
695 val
= _gdi_
.new_BitmapFromIcon(*args
, **kwargs
)
698 def BitmapFromImage(*args
, **kwargs
):
700 BitmapFromImage(Image image, int depth=-1) -> Bitmap
702 Creates bitmap object from a `wx.Image`. This has to be done to
703 actually display a `wx.Image` as you cannot draw an image directly on
704 a window. The resulting bitmap will use the provided colour depth (or
705 that of the current screen colour depth if depth is -1) which entails
706 that a colour reduction may have to take place.
708 val
= _gdi_
.new_BitmapFromImage(*args
, **kwargs
)
711 def BitmapFromXPMData(*args
, **kwargs
):
713 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
715 Construct a Bitmap from a list of strings formatted as XPM data.
717 val
= _gdi_
.new_BitmapFromXPMData(*args
, **kwargs
)
720 def BitmapFromBits(*args
, **kwargs
):
722 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
724 Creates a bitmap from an array of bits. You should only use this
725 function for monochrome bitmaps (depth 1) in portable programs: in
726 this case the bits parameter should contain an XBM image. For other
727 bit depths, the behaviour is platform dependent.
729 val
= _gdi_
.new_BitmapFromBits(*args
, **kwargs
)
733 def _BitmapFromBufferAlpha(*args
, **kwargs
):
734 """_BitmapFromBufferAlpha(int width, int height, buffer data, buffer alpha) -> Bitmap"""
735 return _gdi_
._BitmapFromBufferAlpha
(*args
, **kwargs
)
737 def _BitmapFromBuffer(*args
, **kwargs
):
738 """_BitmapFromBuffer(int width, int height, buffer data) -> Bitmap"""
739 return _gdi_
._BitmapFromBuffer
(*args
, **kwargs
)
740 def BitmapFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
742 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
743 parameter must be a Python object that implements the buffer
744 interface, such as a string, array, etc. The dataBuffer object is
745 expected to contain a series of RGB bytes and be width*height*3
746 bytes long. A buffer object can optionally be supplied for the
747 image's alpha channel data, and it is expected to be width*height
748 bytes long. On Windows the RGB values are 'premultiplied' by the
749 alpha values. (The other platforms do the multiplication
752 Unlike `wx.ImageFromBuffer` the bitmap created with this function
753 does not share the memory buffer with the buffer object. This is
754 because the native pixel buffer format varies on different
755 platforms, and so instead an efficient as possible copy of the
756 data is made from the buffer objects to the bitmap's native pixel
757 buffer. For direct access to a bitmap's pixel buffer see
758 `wx.NativePixelData` and `wx.AlphaPixelData`.
760 :see: `wx.Bitmap`, `wx.BitmapFromBufferRGBA`, `wx.NativePixelData`,
761 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
763 if alphaBuffer
is not None:
764 return _gdi_
._BitmapFromBufferAlpha
(width
, height
, dataBuffer
, alphaBuffer
)
766 return _gdi_
._BitmapFromBuffer
(width
, height
, dataBuffer
)
769 def _BitmapFromBufferRGBA(*args
, **kwargs
):
770 """_BitmapFromBufferRGBA(int width, int height, buffer data) -> Bitmap"""
771 return _gdi_
._BitmapFromBufferRGBA
(*args
, **kwargs
)
772 def BitmapFromBufferRGBA(width
, height
, dataBuffer
):
774 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
775 parameter must be a Python object that implements the buffer
776 interface, such as a string, array, etc. The dataBuffer object is
777 expected to contain a series of RGBA bytes (red, green, blue and
778 alpha) and be width*height*4 bytes long. On Windows the RGB
779 values are 'premultiplied' by the alpha values. (The other
780 platforms do the multiplication themselves.)
782 Unlike `wx.ImageFromBuffer` the bitmap created with this function
783 does not share the memory buffer with the buffer object. This is
784 because the native pixel buffer format varies on different
785 platforms, and so instead an efficient as possible copy of the
786 data is made from the buffer object to the bitmap's native pixel
787 buffer. For direct access to a bitmap's pixel buffer see
788 `wx.NativePixelData` and `wx.AlphaPixelData`.
790 :see: `wx.Bitmap`, `wx.BitmapFromBuffer`, `wx.NativePixelData`,
791 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
793 return _gdi_
._BitmapFromBufferRGBA
(width
, height
, dataBuffer
)
795 class PixelDataBase(object):
796 """Proxy of C++ PixelDataBase class"""
797 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
798 def __init__(self
): raise AttributeError, "No constructor defined"
799 __repr__
= _swig_repr
800 def GetOrigin(*args
, **kwargs
):
801 """GetOrigin(self) -> Point"""
802 return _gdi_
.PixelDataBase_GetOrigin(*args
, **kwargs
)
804 def GetWidth(*args
, **kwargs
):
805 """GetWidth(self) -> int"""
806 return _gdi_
.PixelDataBase_GetWidth(*args
, **kwargs
)
808 def GetHeight(*args
, **kwargs
):
809 """GetHeight(self) -> int"""
810 return _gdi_
.PixelDataBase_GetHeight(*args
, **kwargs
)
812 def GetSize(*args
, **kwargs
):
813 """GetSize(self) -> Size"""
814 return _gdi_
.PixelDataBase_GetSize(*args
, **kwargs
)
816 def GetRowStride(*args
, **kwargs
):
817 """GetRowStride(self) -> int"""
818 return _gdi_
.PixelDataBase_GetRowStride(*args
, **kwargs
)
820 _gdi_
.PixelDataBase_swigregister(PixelDataBase
)
822 class NativePixelData(PixelDataBase
):
823 """Proxy of C++ NativePixelData class"""
824 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
825 __repr__
= _swig_repr
826 def __init__(self
, *args
):
828 __init__(self, Bitmap bmp) -> NativePixelData
829 __init__(self, Bitmap bmp, Rect rect) -> NativePixelData
830 __init__(self, Bitmap bmp, Point pt, Size sz) -> NativePixelData
832 _gdi_
.NativePixelData_swiginit(self
,_gdi_
.new_NativePixelData(*args
))
833 __swig_destroy__
= _gdi_
.delete_NativePixelData
834 __del__
= lambda self
: None;
835 def GetPixels(*args
, **kwargs
):
836 """GetPixels(self) -> NativePixelData_Accessor"""
837 return _gdi_
.NativePixelData_GetPixels(*args
, **kwargs
)
839 def UseAlpha(*args
, **kwargs
):
841 return _gdi_
.NativePixelData_UseAlpha(*args
, **kwargs
)
843 def __nonzero__(*args
, **kwargs
):
844 """__nonzero__(self) -> bool"""
845 return _gdi_
.NativePixelData___nonzero__(*args
, **kwargs
)
849 Create and return an iterator object for this pixel data
850 object. (It's really a generator but I won't tell if you
853 width
= self
.GetWidth()
854 height
= self
.GetHeight()
855 pixels
= self
.GetPixels()
860 class PixelFacade(object):
863 def Set(self
, *args
, **kw
):
864 return pixels
.Set(*args
, **kw
)
866 return str(self
.Get())
868 return 'pixel(%d,%d): %s' % (x
,y
,self
.Get())
869 X
= property(lambda self
: x
)
870 Y
= property(lambda self
: y
)
873 for y
in xrange(height
):
874 for x
in xrange(width
):
880 pixels
.MoveTo(self
, 0, y
)
882 Pixels
= property(GetPixels
,doc
="See `GetPixels`")
883 _gdi_
.NativePixelData_swigregister(NativePixelData
)
885 class NativePixelData_Accessor(object):
886 """Proxy of C++ NativePixelData_Accessor class"""
887 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
888 __repr__
= _swig_repr
889 def __init__(self
, *args
):
891 __init__(self, NativePixelData data) -> NativePixelData_Accessor
892 __init__(self, Bitmap bmp, NativePixelData data) -> NativePixelData_Accessor
893 __init__(self) -> NativePixelData_Accessor
895 _gdi_
.NativePixelData_Accessor_swiginit(self
,_gdi_
.new_NativePixelData_Accessor(*args
))
896 __swig_destroy__
= _gdi_
.delete_NativePixelData_Accessor
897 __del__
= lambda self
: None;
898 def Reset(*args
, **kwargs
):
899 """Reset(self, NativePixelData data)"""
900 return _gdi_
.NativePixelData_Accessor_Reset(*args
, **kwargs
)
902 def IsOk(*args
, **kwargs
):
903 """IsOk(self) -> bool"""
904 return _gdi_
.NativePixelData_Accessor_IsOk(*args
, **kwargs
)
906 def nextPixel(*args
, **kwargs
):
907 """nextPixel(self)"""
908 return _gdi_
.NativePixelData_Accessor_nextPixel(*args
, **kwargs
)
910 def Offset(*args
, **kwargs
):
911 """Offset(self, NativePixelData data, int x, int y)"""
912 return _gdi_
.NativePixelData_Accessor_Offset(*args
, **kwargs
)
914 def OffsetX(*args
, **kwargs
):
915 """OffsetX(self, NativePixelData data, int x)"""
916 return _gdi_
.NativePixelData_Accessor_OffsetX(*args
, **kwargs
)
918 def OffsetY(*args
, **kwargs
):
919 """OffsetY(self, NativePixelData data, int y)"""
920 return _gdi_
.NativePixelData_Accessor_OffsetY(*args
, **kwargs
)
922 def MoveTo(*args
, **kwargs
):
923 """MoveTo(self, NativePixelData data, int x, int y)"""
924 return _gdi_
.NativePixelData_Accessor_MoveTo(*args
, **kwargs
)
926 def Set(*args
, **kwargs
):
927 """Set(self, byte red, byte green, byte blue)"""
928 return _gdi_
.NativePixelData_Accessor_Set(*args
, **kwargs
)
930 def Get(*args
, **kwargs
):
931 """Get(self) -> PyObject"""
932 return _gdi_
.NativePixelData_Accessor_Get(*args
, **kwargs
)
934 _gdi_
.NativePixelData_Accessor_swigregister(NativePixelData_Accessor
)
936 class AlphaPixelData(PixelDataBase
):
937 """Proxy of C++ AlphaPixelData class"""
938 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
939 __repr__
= _swig_repr
940 def __init__(self
, *args
):
942 __init__(self, Bitmap bmp) -> AlphaPixelData
943 __init__(self, Bitmap bmp, Rect rect) -> AlphaPixelData
944 __init__(self, Bitmap bmp, Point pt, Size sz) -> AlphaPixelData
946 _gdi_
.AlphaPixelData_swiginit(self
,_gdi_
.new_AlphaPixelData(*args
))
949 __swig_destroy__
= _gdi_
.delete_AlphaPixelData
950 __del__
= lambda self
: None;
951 def GetPixels(*args
, **kwargs
):
952 """GetPixels(self) -> AlphaPixelData_Accessor"""
953 return _gdi_
.AlphaPixelData_GetPixels(*args
, **kwargs
)
955 def UseAlpha(*args
, **kwargs
):
957 return _gdi_
.AlphaPixelData_UseAlpha(*args
, **kwargs
)
959 def __nonzero__(*args
, **kwargs
):
960 """__nonzero__(self) -> bool"""
961 return _gdi_
.AlphaPixelData___nonzero__(*args
, **kwargs
)
965 Create and return an iterator object for this pixel data
966 object. (It's really a generator but I won't tell if you
969 width
= self
.GetWidth()
970 height
= self
.GetHeight()
971 pixels
= self
.GetPixels()
976 class PixelFacade(object):
979 def Set(self
, *args
, **kw
):
980 return pixels
.Set(*args
, **kw
)
982 return str(self
.Get())
984 return 'pixel(%d,%d): %s' % (x
,y
,self
.Get())
985 X
= property(lambda self
: x
)
986 Y
= property(lambda self
: y
)
989 for y
in xrange(height
):
990 for x
in xrange(width
):
996 pixels
.MoveTo(self
, 0, y
)
998 Pixels
= property(GetPixels
,doc
="See `GetPixels`")
999 _gdi_
.AlphaPixelData_swigregister(AlphaPixelData
)
1001 class AlphaPixelData_Accessor(object):
1002 """Proxy of C++ AlphaPixelData_Accessor class"""
1003 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1004 __repr__
= _swig_repr
1005 def __init__(self
, *args
):
1007 __init__(self, AlphaPixelData data) -> AlphaPixelData_Accessor
1008 __init__(self, Bitmap bmp, AlphaPixelData data) -> AlphaPixelData_Accessor
1009 __init__(self) -> AlphaPixelData_Accessor
1011 _gdi_
.AlphaPixelData_Accessor_swiginit(self
,_gdi_
.new_AlphaPixelData_Accessor(*args
))
1012 __swig_destroy__
= _gdi_
.delete_AlphaPixelData_Accessor
1013 __del__
= lambda self
: None;
1014 def Reset(*args
, **kwargs
):
1015 """Reset(self, AlphaPixelData data)"""
1016 return _gdi_
.AlphaPixelData_Accessor_Reset(*args
, **kwargs
)
1018 def IsOk(*args
, **kwargs
):
1019 """IsOk(self) -> bool"""
1020 return _gdi_
.AlphaPixelData_Accessor_IsOk(*args
, **kwargs
)
1022 def nextPixel(*args
, **kwargs
):
1023 """nextPixel(self)"""
1024 return _gdi_
.AlphaPixelData_Accessor_nextPixel(*args
, **kwargs
)
1026 def Offset(*args
, **kwargs
):
1027 """Offset(self, AlphaPixelData data, int x, int y)"""
1028 return _gdi_
.AlphaPixelData_Accessor_Offset(*args
, **kwargs
)
1030 def OffsetX(*args
, **kwargs
):
1031 """OffsetX(self, AlphaPixelData data, int x)"""
1032 return _gdi_
.AlphaPixelData_Accessor_OffsetX(*args
, **kwargs
)
1034 def OffsetY(*args
, **kwargs
):
1035 """OffsetY(self, AlphaPixelData data, int y)"""
1036 return _gdi_
.AlphaPixelData_Accessor_OffsetY(*args
, **kwargs
)
1038 def MoveTo(*args
, **kwargs
):
1039 """MoveTo(self, AlphaPixelData data, int x, int y)"""
1040 return _gdi_
.AlphaPixelData_Accessor_MoveTo(*args
, **kwargs
)
1042 def Set(*args
, **kwargs
):
1043 """Set(self, byte red, byte green, byte blue, byte alpha)"""
1044 return _gdi_
.AlphaPixelData_Accessor_Set(*args
, **kwargs
)
1046 def Get(*args
, **kwargs
):
1047 """Get(self) -> PyObject"""
1048 return _gdi_
.AlphaPixelData_Accessor_Get(*args
, **kwargs
)
1050 _gdi_
.AlphaPixelData_Accessor_swigregister(AlphaPixelData_Accessor
)
1052 class Mask(_core
.Object
):
1054 This class encapsulates a monochrome mask bitmap, where the masked
1055 area is black and the unmasked area is white. When associated with a
1056 bitmap and drawn in a device context, the unmasked area of the bitmap
1057 will be drawn, and the masked area will not be drawn.
1059 A mask may be associated with a `wx.Bitmap`. It is used in
1060 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
1061 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
1064 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1065 __repr__
= _swig_repr
1066 def __init__(self
, *args
, **kwargs
):
1068 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
1070 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
1071 that indicates the transparent portions of the mask. In other words,
1072 the pixels in ``bitmap`` that match ``colour`` will be the transparent
1073 portions of the mask. If no ``colour`` or an invalid ``colour`` is
1074 passed then BLACK is used.
1076 :see: `wx.Bitmap`, `wx.Colour`
1078 _gdi_
.Mask_swiginit(self
,_gdi_
.new_Mask(*args
, **kwargs
))
1079 __swig_destroy__
= _gdi_
.delete_Mask
1080 __del__
= lambda self
: None;
1081 _gdi_
.Mask_swigregister(Mask
)
1083 MaskColour
= wx
._deprecated
(Mask
, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
1084 class Icon(GDIObject
):
1085 """Proxy of C++ Icon class"""
1086 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1087 __repr__
= _swig_repr
1088 def __init__(self
, *args
, **kwargs
):
1089 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
1090 _gdi_
.Icon_swiginit(self
,_gdi_
.new_Icon(*args
, **kwargs
))
1091 __swig_destroy__
= _gdi_
.delete_Icon
1092 __del__
= lambda self
: None;
1093 def Ok(*args
, **kwargs
):
1094 """Ok(self) -> bool"""
1095 return _gdi_
.Icon_Ok(*args
, **kwargs
)
1097 def GetWidth(*args
, **kwargs
):
1098 """GetWidth(self) -> int"""
1099 return _gdi_
.Icon_GetWidth(*args
, **kwargs
)
1101 def GetHeight(*args
, **kwargs
):
1102 """GetHeight(self) -> int"""
1103 return _gdi_
.Icon_GetHeight(*args
, **kwargs
)
1105 def GetDepth(*args
, **kwargs
):
1106 """GetDepth(self) -> int"""
1107 return _gdi_
.Icon_GetDepth(*args
, **kwargs
)
1109 def SetWidth(*args
, **kwargs
):
1110 """SetWidth(self, int w)"""
1111 return _gdi_
.Icon_SetWidth(*args
, **kwargs
)
1113 def SetHeight(*args
, **kwargs
):
1114 """SetHeight(self, int h)"""
1115 return _gdi_
.Icon_SetHeight(*args
, **kwargs
)
1117 def SetDepth(*args
, **kwargs
):
1118 """SetDepth(self, int d)"""
1119 return _gdi_
.Icon_SetDepth(*args
, **kwargs
)
1121 def CopyFromBitmap(*args
, **kwargs
):
1122 """CopyFromBitmap(self, Bitmap bmp)"""
1123 return _gdi_
.Icon_CopyFromBitmap(*args
, **kwargs
)
1125 def __nonzero__(self
): return self
.Ok()
1126 Depth
= property(GetDepth
,SetDepth
,doc
="See `GetDepth` and `SetDepth`")
1127 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
1128 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
1129 _gdi_
.Icon_swigregister(Icon
)
1131 def EmptyIcon(*args
, **kwargs
):
1132 """EmptyIcon() -> Icon"""
1133 val
= _gdi_
.new_EmptyIcon(*args
, **kwargs
)
1136 def IconFromLocation(*args
, **kwargs
):
1137 """IconFromLocation(IconLocation loc) -> Icon"""
1138 val
= _gdi_
.new_IconFromLocation(*args
, **kwargs
)
1141 def IconFromBitmap(*args
, **kwargs
):
1142 """IconFromBitmap(Bitmap bmp) -> Icon"""
1143 val
= _gdi_
.new_IconFromBitmap(*args
, **kwargs
)
1146 def IconFromXPMData(*args
, **kwargs
):
1147 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
1148 val
= _gdi_
.new_IconFromXPMData(*args
, **kwargs
)
1151 class IconLocation(object):
1152 """Proxy of C++ IconLocation class"""
1153 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1154 __repr__
= _swig_repr
1155 def __init__(self
, *args
, **kwargs
):
1156 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
1157 _gdi_
.IconLocation_swiginit(self
,_gdi_
.new_IconLocation(*args
, **kwargs
))
1158 __swig_destroy__
= _gdi_
.delete_IconLocation
1159 __del__
= lambda self
: None;
1160 def IsOk(*args
, **kwargs
):
1161 """IsOk(self) -> bool"""
1162 return _gdi_
.IconLocation_IsOk(*args
, **kwargs
)
1164 def __nonzero__(self
): return self
.Ok()
1165 def SetFileName(*args
, **kwargs
):
1166 """SetFileName(self, String filename)"""
1167 return _gdi_
.IconLocation_SetFileName(*args
, **kwargs
)
1169 def GetFileName(*args
, **kwargs
):
1170 """GetFileName(self) -> String"""
1171 return _gdi_
.IconLocation_GetFileName(*args
, **kwargs
)
1173 def SetIndex(*args
, **kwargs
):
1174 """SetIndex(self, int num)"""
1175 return _gdi_
.IconLocation_SetIndex(*args
, **kwargs
)
1177 def GetIndex(*args
, **kwargs
):
1178 """GetIndex(self) -> int"""
1179 return _gdi_
.IconLocation_GetIndex(*args
, **kwargs
)
1181 FileName
= property(GetFileName
,SetFileName
,doc
="See `GetFileName` and `SetFileName`")
1182 Index
= property(GetIndex
,SetIndex
,doc
="See `GetIndex` and `SetIndex`")
1183 _gdi_
.IconLocation_swigregister(IconLocation
)
1185 class IconBundle(object):
1186 """Proxy of C++ IconBundle class"""
1187 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1188 __repr__
= _swig_repr
1189 def __init__(self
, *args
, **kwargs
):
1190 """__init__(self) -> IconBundle"""
1191 _gdi_
.IconBundle_swiginit(self
,_gdi_
.new_IconBundle(*args
, **kwargs
))
1192 __swig_destroy__
= _gdi_
.delete_IconBundle
1193 __del__
= lambda self
: None;
1194 def AddIcon(*args
, **kwargs
):
1195 """AddIcon(self, Icon icon)"""
1196 return _gdi_
.IconBundle_AddIcon(*args
, **kwargs
)
1198 def AddIconFromFile(*args
, **kwargs
):
1199 """AddIconFromFile(self, String file, long type)"""
1200 return _gdi_
.IconBundle_AddIconFromFile(*args
, **kwargs
)
1202 def GetIcon(*args
, **kwargs
):
1203 """GetIcon(self, Size size) -> Icon"""
1204 return _gdi_
.IconBundle_GetIcon(*args
, **kwargs
)
1206 Icon
= property(GetIcon
,doc
="See `GetIcon`")
1207 _gdi_
.IconBundle_swigregister(IconBundle
)
1209 def IconBundleFromFile(*args
, **kwargs
):
1210 """IconBundleFromFile(String file, long type) -> IconBundle"""
1211 val
= _gdi_
.new_IconBundleFromFile(*args
, **kwargs
)
1214 def IconBundleFromIcon(*args
, **kwargs
):
1215 """IconBundleFromIcon(Icon icon) -> IconBundle"""
1216 val
= _gdi_
.new_IconBundleFromIcon(*args
, **kwargs
)
1219 class Cursor(GDIObject
):
1221 A cursor is a small bitmap usually used for denoting where the mouse
1222 pointer is, with a picture that might indicate the interpretation of a
1225 A single cursor object may be used in many windows (any subwindow
1226 type). The wxWindows convention is to set the cursor for a window, as
1227 in X, rather than to set it globally as in MS Windows, although a
1228 global `wx.SetCursor` function is also available for use on MS Windows.
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
):
1235 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
1237 Construct a Cursor from a file. Specify the type of file using
1238 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
1241 _gdi_
.Cursor_swiginit(self
,_gdi_
.new_Cursor(*args
, **kwargs
))
1242 __swig_destroy__
= _gdi_
.delete_Cursor
1243 __del__
= lambda self
: None;
1244 def Ok(*args
, **kwargs
):
1245 """Ok(self) -> bool"""
1246 return _gdi_
.Cursor_Ok(*args
, **kwargs
)
1248 def __nonzero__(self
): return self
.Ok()
1249 _gdi_
.Cursor_swigregister(Cursor
)
1251 def StockCursor(*args
, **kwargs
):
1253 StockCursor(int id) -> Cursor
1255 Create a cursor using one of the stock cursors. Note that not all
1256 stock cursors are available on all platforms.
1258 val
= _gdi_
.new_StockCursor(*args
, **kwargs
)
1261 def CursorFromImage(*args
, **kwargs
):
1263 CursorFromImage(Image image) -> Cursor
1265 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
1266 for setting the transparent portions of the cursor.
1268 val
= _gdi_
.new_CursorFromImage(*args
, **kwargs
)
1271 #---------------------------------------------------------------------------
1273 OutRegion
= _gdi_
.OutRegion
1274 PartRegion
= _gdi_
.PartRegion
1275 InRegion
= _gdi_
.InRegion
1276 class Region(GDIObject
):
1277 """Proxy of C++ Region class"""
1278 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1279 __repr__
= _swig_repr
1280 def __init__(self
, *args
, **kwargs
):
1281 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
1282 _gdi_
.Region_swiginit(self
,_gdi_
.new_Region(*args
, **kwargs
))
1283 __swig_destroy__
= _gdi_
.delete_Region
1284 __del__
= lambda self
: None;
1285 def Clear(*args
, **kwargs
):
1287 return _gdi_
.Region_Clear(*args
, **kwargs
)
1289 def Offset(*args
, **kwargs
):
1290 """Offset(self, int x, int y) -> bool"""
1291 return _gdi_
.Region_Offset(*args
, **kwargs
)
1293 def Contains(*args
, **kwargs
):
1294 """Contains(self, int x, int y) -> int"""
1295 return _gdi_
.Region_Contains(*args
, **kwargs
)
1297 def ContainsPoint(*args
, **kwargs
):
1298 """ContainsPoint(self, Point pt) -> int"""
1299 return _gdi_
.Region_ContainsPoint(*args
, **kwargs
)
1301 def ContainsRect(*args
, **kwargs
):
1302 """ContainsRect(self, Rect rect) -> int"""
1303 return _gdi_
.Region_ContainsRect(*args
, **kwargs
)
1305 def ContainsRectDim(*args
, **kwargs
):
1306 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
1307 return _gdi_
.Region_ContainsRectDim(*args
, **kwargs
)
1309 def GetBox(*args
, **kwargs
):
1310 """GetBox(self) -> Rect"""
1311 return _gdi_
.Region_GetBox(*args
, **kwargs
)
1313 def Intersect(*args
, **kwargs
):
1314 """Intersect(self, int x, int y, int width, int height) -> bool"""
1315 return _gdi_
.Region_Intersect(*args
, **kwargs
)
1317 def IntersectRect(*args
, **kwargs
):
1318 """IntersectRect(self, Rect rect) -> bool"""
1319 return _gdi_
.Region_IntersectRect(*args
, **kwargs
)
1321 def IntersectRegion(*args
, **kwargs
):
1322 """IntersectRegion(self, Region region) -> bool"""
1323 return _gdi_
.Region_IntersectRegion(*args
, **kwargs
)
1325 def IsEmpty(*args
, **kwargs
):
1326 """IsEmpty(self) -> bool"""
1327 return _gdi_
.Region_IsEmpty(*args
, **kwargs
)
1329 def Union(*args
, **kwargs
):
1330 """Union(self, int x, int y, int width, int height) -> bool"""
1331 return _gdi_
.Region_Union(*args
, **kwargs
)
1333 def UnionRect(*args
, **kwargs
):
1334 """UnionRect(self, Rect rect) -> bool"""
1335 return _gdi_
.Region_UnionRect(*args
, **kwargs
)
1337 def UnionRegion(*args
, **kwargs
):
1338 """UnionRegion(self, Region region) -> bool"""
1339 return _gdi_
.Region_UnionRegion(*args
, **kwargs
)
1341 def Subtract(*args
, **kwargs
):
1342 """Subtract(self, int x, int y, int width, int height) -> bool"""
1343 return _gdi_
.Region_Subtract(*args
, **kwargs
)
1345 def SubtractRect(*args
, **kwargs
):
1346 """SubtractRect(self, Rect rect) -> bool"""
1347 return _gdi_
.Region_SubtractRect(*args
, **kwargs
)
1349 def SubtractRegion(*args
, **kwargs
):
1350 """SubtractRegion(self, Region region) -> bool"""
1351 return _gdi_
.Region_SubtractRegion(*args
, **kwargs
)
1353 def Xor(*args
, **kwargs
):
1354 """Xor(self, int x, int y, int width, int height) -> bool"""
1355 return _gdi_
.Region_Xor(*args
, **kwargs
)
1357 def XorRect(*args
, **kwargs
):
1358 """XorRect(self, Rect rect) -> bool"""
1359 return _gdi_
.Region_XorRect(*args
, **kwargs
)
1361 def XorRegion(*args
, **kwargs
):
1362 """XorRegion(self, Region region) -> bool"""
1363 return _gdi_
.Region_XorRegion(*args
, **kwargs
)
1365 def ConvertToBitmap(*args
, **kwargs
):
1366 """ConvertToBitmap(self) -> Bitmap"""
1367 return _gdi_
.Region_ConvertToBitmap(*args
, **kwargs
)
1369 def UnionBitmap(*args
, **kwargs
):
1370 """UnionBitmap(self, Bitmap bmp) -> bool"""
1371 return _gdi_
.Region_UnionBitmap(*args
, **kwargs
)
1373 def UnionBitmapColour(*args
, **kwargs
):
1374 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1375 return _gdi_
.Region_UnionBitmapColour(*args
, **kwargs
)
1377 _gdi_
.Region_swigregister(Region
)
1379 def RegionFromBitmap(*args
, **kwargs
):
1380 """RegionFromBitmap(Bitmap bmp) -> Region"""
1381 val
= _gdi_
.new_RegionFromBitmap(*args
, **kwargs
)
1384 def RegionFromBitmapColour(*args
, **kwargs
):
1385 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1386 val
= _gdi_
.new_RegionFromBitmapColour(*args
, **kwargs
)
1389 def RegionFromPoints(*args
, **kwargs
):
1390 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
1391 val
= _gdi_
.new_RegionFromPoints(*args
, **kwargs
)
1394 class RegionIterator(_core
.Object
):
1395 """Proxy of C++ RegionIterator class"""
1396 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1397 __repr__
= _swig_repr
1398 def __init__(self
, *args
, **kwargs
):
1399 """__init__(self, Region region) -> RegionIterator"""
1400 _gdi_
.RegionIterator_swiginit(self
,_gdi_
.new_RegionIterator(*args
, **kwargs
))
1401 __swig_destroy__
= _gdi_
.delete_RegionIterator
1402 __del__
= lambda self
: None;
1403 def GetX(*args
, **kwargs
):
1404 """GetX(self) -> int"""
1405 return _gdi_
.RegionIterator_GetX(*args
, **kwargs
)
1407 def GetY(*args
, **kwargs
):
1408 """GetY(self) -> int"""
1409 return _gdi_
.RegionIterator_GetY(*args
, **kwargs
)
1411 def GetW(*args
, **kwargs
):
1412 """GetW(self) -> int"""
1413 return _gdi_
.RegionIterator_GetW(*args
, **kwargs
)
1415 def GetWidth(*args
, **kwargs
):
1416 """GetWidth(self) -> int"""
1417 return _gdi_
.RegionIterator_GetWidth(*args
, **kwargs
)
1419 def GetH(*args
, **kwargs
):
1420 """GetH(self) -> int"""
1421 return _gdi_
.RegionIterator_GetH(*args
, **kwargs
)
1423 def GetHeight(*args
, **kwargs
):
1424 """GetHeight(self) -> int"""
1425 return _gdi_
.RegionIterator_GetHeight(*args
, **kwargs
)
1427 def GetRect(*args
, **kwargs
):
1428 """GetRect(self) -> Rect"""
1429 return _gdi_
.RegionIterator_GetRect(*args
, **kwargs
)
1431 def HaveRects(*args
, **kwargs
):
1432 """HaveRects(self) -> bool"""
1433 return _gdi_
.RegionIterator_HaveRects(*args
, **kwargs
)
1435 def Reset(*args
, **kwargs
):
1437 return _gdi_
.RegionIterator_Reset(*args
, **kwargs
)
1439 def Next(*args
, **kwargs
):
1441 return _gdi_
.RegionIterator_Next(*args
, **kwargs
)
1443 def __nonzero__(*args
, **kwargs
):
1444 """__nonzero__(self) -> bool"""
1445 return _gdi_
.RegionIterator___nonzero__(*args
, **kwargs
)
1447 _gdi_
.RegionIterator_swigregister(RegionIterator
)
1449 #---------------------------------------------------------------------------
1451 FONTFAMILY_DEFAULT
= _gdi_
.FONTFAMILY_DEFAULT
1452 FONTFAMILY_DECORATIVE
= _gdi_
.FONTFAMILY_DECORATIVE
1453 FONTFAMILY_ROMAN
= _gdi_
.FONTFAMILY_ROMAN
1454 FONTFAMILY_SCRIPT
= _gdi_
.FONTFAMILY_SCRIPT
1455 FONTFAMILY_SWISS
= _gdi_
.FONTFAMILY_SWISS
1456 FONTFAMILY_MODERN
= _gdi_
.FONTFAMILY_MODERN
1457 FONTFAMILY_TELETYPE
= _gdi_
.FONTFAMILY_TELETYPE
1458 FONTFAMILY_MAX
= _gdi_
.FONTFAMILY_MAX
1459 FONTFAMILY_UNKNOWN
= _gdi_
.FONTFAMILY_UNKNOWN
1460 FONTSTYLE_NORMAL
= _gdi_
.FONTSTYLE_NORMAL
1461 FONTSTYLE_ITALIC
= _gdi_
.FONTSTYLE_ITALIC
1462 FONTSTYLE_SLANT
= _gdi_
.FONTSTYLE_SLANT
1463 FONTSTYLE_MAX
= _gdi_
.FONTSTYLE_MAX
1464 FONTWEIGHT_NORMAL
= _gdi_
.FONTWEIGHT_NORMAL
1465 FONTWEIGHT_LIGHT
= _gdi_
.FONTWEIGHT_LIGHT
1466 FONTWEIGHT_BOLD
= _gdi_
.FONTWEIGHT_BOLD
1467 FONTWEIGHT_MAX
= _gdi_
.FONTWEIGHT_MAX
1468 FONTFLAG_DEFAULT
= _gdi_
.FONTFLAG_DEFAULT
1469 FONTFLAG_ITALIC
= _gdi_
.FONTFLAG_ITALIC
1470 FONTFLAG_SLANT
= _gdi_
.FONTFLAG_SLANT
1471 FONTFLAG_LIGHT
= _gdi_
.FONTFLAG_LIGHT
1472 FONTFLAG_BOLD
= _gdi_
.FONTFLAG_BOLD
1473 FONTFLAG_ANTIALIASED
= _gdi_
.FONTFLAG_ANTIALIASED
1474 FONTFLAG_NOT_ANTIALIASED
= _gdi_
.FONTFLAG_NOT_ANTIALIASED
1475 FONTFLAG_UNDERLINED
= _gdi_
.FONTFLAG_UNDERLINED
1476 FONTFLAG_STRIKETHROUGH
= _gdi_
.FONTFLAG_STRIKETHROUGH
1477 FONTFLAG_MASK
= _gdi_
.FONTFLAG_MASK
1478 FONTENCODING_SYSTEM
= _gdi_
.FONTENCODING_SYSTEM
1479 FONTENCODING_DEFAULT
= _gdi_
.FONTENCODING_DEFAULT
1480 FONTENCODING_ISO8859_1
= _gdi_
.FONTENCODING_ISO8859_1
1481 FONTENCODING_ISO8859_2
= _gdi_
.FONTENCODING_ISO8859_2
1482 FONTENCODING_ISO8859_3
= _gdi_
.FONTENCODING_ISO8859_3
1483 FONTENCODING_ISO8859_4
= _gdi_
.FONTENCODING_ISO8859_4
1484 FONTENCODING_ISO8859_5
= _gdi_
.FONTENCODING_ISO8859_5
1485 FONTENCODING_ISO8859_6
= _gdi_
.FONTENCODING_ISO8859_6
1486 FONTENCODING_ISO8859_7
= _gdi_
.FONTENCODING_ISO8859_7
1487 FONTENCODING_ISO8859_8
= _gdi_
.FONTENCODING_ISO8859_8
1488 FONTENCODING_ISO8859_9
= _gdi_
.FONTENCODING_ISO8859_9
1489 FONTENCODING_ISO8859_10
= _gdi_
.FONTENCODING_ISO8859_10
1490 FONTENCODING_ISO8859_11
= _gdi_
.FONTENCODING_ISO8859_11
1491 FONTENCODING_ISO8859_12
= _gdi_
.FONTENCODING_ISO8859_12
1492 FONTENCODING_ISO8859_13
= _gdi_
.FONTENCODING_ISO8859_13
1493 FONTENCODING_ISO8859_14
= _gdi_
.FONTENCODING_ISO8859_14
1494 FONTENCODING_ISO8859_15
= _gdi_
.FONTENCODING_ISO8859_15
1495 FONTENCODING_ISO8859_MAX
= _gdi_
.FONTENCODING_ISO8859_MAX
1496 FONTENCODING_KOI8
= _gdi_
.FONTENCODING_KOI8
1497 FONTENCODING_KOI8_U
= _gdi_
.FONTENCODING_KOI8_U
1498 FONTENCODING_ALTERNATIVE
= _gdi_
.FONTENCODING_ALTERNATIVE
1499 FONTENCODING_BULGARIAN
= _gdi_
.FONTENCODING_BULGARIAN
1500 FONTENCODING_CP437
= _gdi_
.FONTENCODING_CP437
1501 FONTENCODING_CP850
= _gdi_
.FONTENCODING_CP850
1502 FONTENCODING_CP852
= _gdi_
.FONTENCODING_CP852
1503 FONTENCODING_CP855
= _gdi_
.FONTENCODING_CP855
1504 FONTENCODING_CP866
= _gdi_
.FONTENCODING_CP866
1505 FONTENCODING_CP874
= _gdi_
.FONTENCODING_CP874
1506 FONTENCODING_CP932
= _gdi_
.FONTENCODING_CP932
1507 FONTENCODING_CP936
= _gdi_
.FONTENCODING_CP936
1508 FONTENCODING_CP949
= _gdi_
.FONTENCODING_CP949
1509 FONTENCODING_CP950
= _gdi_
.FONTENCODING_CP950
1510 FONTENCODING_CP1250
= _gdi_
.FONTENCODING_CP1250
1511 FONTENCODING_CP1251
= _gdi_
.FONTENCODING_CP1251
1512 FONTENCODING_CP1252
= _gdi_
.FONTENCODING_CP1252
1513 FONTENCODING_CP1253
= _gdi_
.FONTENCODING_CP1253
1514 FONTENCODING_CP1254
= _gdi_
.FONTENCODING_CP1254
1515 FONTENCODING_CP1255
= _gdi_
.FONTENCODING_CP1255
1516 FONTENCODING_CP1256
= _gdi_
.FONTENCODING_CP1256
1517 FONTENCODING_CP1257
= _gdi_
.FONTENCODING_CP1257
1518 FONTENCODING_CP12_MAX
= _gdi_
.FONTENCODING_CP12_MAX
1519 FONTENCODING_UTF7
= _gdi_
.FONTENCODING_UTF7
1520 FONTENCODING_UTF8
= _gdi_
.FONTENCODING_UTF8
1521 FONTENCODING_EUC_JP
= _gdi_
.FONTENCODING_EUC_JP
1522 FONTENCODING_UTF16BE
= _gdi_
.FONTENCODING_UTF16BE
1523 FONTENCODING_UTF16LE
= _gdi_
.FONTENCODING_UTF16LE
1524 FONTENCODING_UTF32BE
= _gdi_
.FONTENCODING_UTF32BE
1525 FONTENCODING_UTF32LE
= _gdi_
.FONTENCODING_UTF32LE
1526 FONTENCODING_MACROMAN
= _gdi_
.FONTENCODING_MACROMAN
1527 FONTENCODING_MACJAPANESE
= _gdi_
.FONTENCODING_MACJAPANESE
1528 FONTENCODING_MACCHINESETRAD
= _gdi_
.FONTENCODING_MACCHINESETRAD
1529 FONTENCODING_MACKOREAN
= _gdi_
.FONTENCODING_MACKOREAN
1530 FONTENCODING_MACARABIC
= _gdi_
.FONTENCODING_MACARABIC
1531 FONTENCODING_MACHEBREW
= _gdi_
.FONTENCODING_MACHEBREW
1532 FONTENCODING_MACGREEK
= _gdi_
.FONTENCODING_MACGREEK
1533 FONTENCODING_MACCYRILLIC
= _gdi_
.FONTENCODING_MACCYRILLIC
1534 FONTENCODING_MACDEVANAGARI
= _gdi_
.FONTENCODING_MACDEVANAGARI
1535 FONTENCODING_MACGURMUKHI
= _gdi_
.FONTENCODING_MACGURMUKHI
1536 FONTENCODING_MACGUJARATI
= _gdi_
.FONTENCODING_MACGUJARATI
1537 FONTENCODING_MACORIYA
= _gdi_
.FONTENCODING_MACORIYA
1538 FONTENCODING_MACBENGALI
= _gdi_
.FONTENCODING_MACBENGALI
1539 FONTENCODING_MACTAMIL
= _gdi_
.FONTENCODING_MACTAMIL
1540 FONTENCODING_MACTELUGU
= _gdi_
.FONTENCODING_MACTELUGU
1541 FONTENCODING_MACKANNADA
= _gdi_
.FONTENCODING_MACKANNADA
1542 FONTENCODING_MACMALAJALAM
= _gdi_
.FONTENCODING_MACMALAJALAM
1543 FONTENCODING_MACSINHALESE
= _gdi_
.FONTENCODING_MACSINHALESE
1544 FONTENCODING_MACBURMESE
= _gdi_
.FONTENCODING_MACBURMESE
1545 FONTENCODING_MACKHMER
= _gdi_
.FONTENCODING_MACKHMER
1546 FONTENCODING_MACTHAI
= _gdi_
.FONTENCODING_MACTHAI
1547 FONTENCODING_MACLAOTIAN
= _gdi_
.FONTENCODING_MACLAOTIAN
1548 FONTENCODING_MACGEORGIAN
= _gdi_
.FONTENCODING_MACGEORGIAN
1549 FONTENCODING_MACARMENIAN
= _gdi_
.FONTENCODING_MACARMENIAN
1550 FONTENCODING_MACCHINESESIMP
= _gdi_
.FONTENCODING_MACCHINESESIMP
1551 FONTENCODING_MACTIBETAN
= _gdi_
.FONTENCODING_MACTIBETAN
1552 FONTENCODING_MACMONGOLIAN
= _gdi_
.FONTENCODING_MACMONGOLIAN
1553 FONTENCODING_MACETHIOPIC
= _gdi_
.FONTENCODING_MACETHIOPIC
1554 FONTENCODING_MACCENTRALEUR
= _gdi_
.FONTENCODING_MACCENTRALEUR
1555 FONTENCODING_MACVIATNAMESE
= _gdi_
.FONTENCODING_MACVIATNAMESE
1556 FONTENCODING_MACARABICEXT
= _gdi_
.FONTENCODING_MACARABICEXT
1557 FONTENCODING_MACSYMBOL
= _gdi_
.FONTENCODING_MACSYMBOL
1558 FONTENCODING_MACDINGBATS
= _gdi_
.FONTENCODING_MACDINGBATS
1559 FONTENCODING_MACTURKISH
= _gdi_
.FONTENCODING_MACTURKISH
1560 FONTENCODING_MACCROATIAN
= _gdi_
.FONTENCODING_MACCROATIAN
1561 FONTENCODING_MACICELANDIC
= _gdi_
.FONTENCODING_MACICELANDIC
1562 FONTENCODING_MACROMANIAN
= _gdi_
.FONTENCODING_MACROMANIAN
1563 FONTENCODING_MACCELTIC
= _gdi_
.FONTENCODING_MACCELTIC
1564 FONTENCODING_MACGAELIC
= _gdi_
.FONTENCODING_MACGAELIC
1565 FONTENCODING_MACKEYBOARD
= _gdi_
.FONTENCODING_MACKEYBOARD
1566 FONTENCODING_MACMIN
= _gdi_
.FONTENCODING_MACMIN
1567 FONTENCODING_MACMAX
= _gdi_
.FONTENCODING_MACMAX
1568 FONTENCODING_MAX
= _gdi_
.FONTENCODING_MAX
1569 FONTENCODING_UTF16
= _gdi_
.FONTENCODING_UTF16
1570 FONTENCODING_UTF32
= _gdi_
.FONTENCODING_UTF32
1571 FONTENCODING_UNICODE
= _gdi_
.FONTENCODING_UNICODE
1572 FONTENCODING_GB2312
= _gdi_
.FONTENCODING_GB2312
1573 FONTENCODING_BIG5
= _gdi_
.FONTENCODING_BIG5
1574 FONTENCODING_SHIFT_JIS
= _gdi_
.FONTENCODING_SHIFT_JIS
1575 #---------------------------------------------------------------------------
1577 class NativeFontInfo(object):
1578 """Proxy of C++ NativeFontInfo class"""
1579 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1580 __repr__
= _swig_repr
1581 def __init__(self
, *args
, **kwargs
):
1582 """__init__(self) -> NativeFontInfo"""
1583 _gdi_
.NativeFontInfo_swiginit(self
,_gdi_
.new_NativeFontInfo(*args
, **kwargs
))
1584 __swig_destroy__
= _gdi_
.delete_NativeFontInfo
1585 __del__
= lambda self
: None;
1586 def Init(*args
, **kwargs
):
1588 return _gdi_
.NativeFontInfo_Init(*args
, **kwargs
)
1590 def InitFromFont(*args
, **kwargs
):
1591 """InitFromFont(self, Font font)"""
1592 return _gdi_
.NativeFontInfo_InitFromFont(*args
, **kwargs
)
1594 def GetPointSize(*args
, **kwargs
):
1595 """GetPointSize(self) -> int"""
1596 return _gdi_
.NativeFontInfo_GetPointSize(*args
, **kwargs
)
1598 def GetStyle(*args
, **kwargs
):
1599 """GetStyle(self) -> int"""
1600 return _gdi_
.NativeFontInfo_GetStyle(*args
, **kwargs
)
1602 def GetWeight(*args
, **kwargs
):
1603 """GetWeight(self) -> int"""
1604 return _gdi_
.NativeFontInfo_GetWeight(*args
, **kwargs
)
1606 def GetUnderlined(*args
, **kwargs
):
1607 """GetUnderlined(self) -> bool"""
1608 return _gdi_
.NativeFontInfo_GetUnderlined(*args
, **kwargs
)
1610 def GetFaceName(*args
, **kwargs
):
1611 """GetFaceName(self) -> String"""
1612 return _gdi_
.NativeFontInfo_GetFaceName(*args
, **kwargs
)
1614 def GetFamily(*args
, **kwargs
):
1615 """GetFamily(self) -> int"""
1616 return _gdi_
.NativeFontInfo_GetFamily(*args
, **kwargs
)
1618 def GetEncoding(*args
, **kwargs
):
1619 """GetEncoding(self) -> int"""
1620 return _gdi_
.NativeFontInfo_GetEncoding(*args
, **kwargs
)
1622 def SetPointSize(*args
, **kwargs
):
1623 """SetPointSize(self, int pointsize)"""
1624 return _gdi_
.NativeFontInfo_SetPointSize(*args
, **kwargs
)
1626 def SetStyle(*args
, **kwargs
):
1627 """SetStyle(self, int style)"""
1628 return _gdi_
.NativeFontInfo_SetStyle(*args
, **kwargs
)
1630 def SetWeight(*args
, **kwargs
):
1631 """SetWeight(self, int weight)"""
1632 return _gdi_
.NativeFontInfo_SetWeight(*args
, **kwargs
)
1634 def SetUnderlined(*args
, **kwargs
):
1635 """SetUnderlined(self, bool underlined)"""
1636 return _gdi_
.NativeFontInfo_SetUnderlined(*args
, **kwargs
)
1638 def SetFaceName(*args
, **kwargs
):
1639 """SetFaceName(self, String facename) -> bool"""
1640 return _gdi_
.NativeFontInfo_SetFaceName(*args
, **kwargs
)
1642 def SetFamily(*args
, **kwargs
):
1643 """SetFamily(self, int family)"""
1644 return _gdi_
.NativeFontInfo_SetFamily(*args
, **kwargs
)
1646 def SetEncoding(*args
, **kwargs
):
1647 """SetEncoding(self, int encoding)"""
1648 return _gdi_
.NativeFontInfo_SetEncoding(*args
, **kwargs
)
1650 def FromString(*args
, **kwargs
):
1651 """FromString(self, String s) -> bool"""
1652 return _gdi_
.NativeFontInfo_FromString(*args
, **kwargs
)
1654 def ToString(*args
, **kwargs
):
1655 """ToString(self) -> String"""
1656 return _gdi_
.NativeFontInfo_ToString(*args
, **kwargs
)
1658 def __str__(*args
, **kwargs
):
1659 """__str__(self) -> String"""
1660 return _gdi_
.NativeFontInfo___str__(*args
, **kwargs
)
1662 def FromUserString(*args
, **kwargs
):
1663 """FromUserString(self, String s) -> bool"""
1664 return _gdi_
.NativeFontInfo_FromUserString(*args
, **kwargs
)
1666 def ToUserString(*args
, **kwargs
):
1667 """ToUserString(self) -> String"""
1668 return _gdi_
.NativeFontInfo_ToUserString(*args
, **kwargs
)
1670 _gdi_
.NativeFontInfo_swigregister(NativeFontInfo
)
1672 class NativeEncodingInfo(object):
1673 """Proxy of C++ NativeEncodingInfo class"""
1674 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1675 __repr__
= _swig_repr
1676 facename
= property(_gdi_
.NativeEncodingInfo_facename_get
, _gdi_
.NativeEncodingInfo_facename_set
)
1677 encoding
= property(_gdi_
.NativeEncodingInfo_encoding_get
, _gdi_
.NativeEncodingInfo_encoding_set
)
1678 def __init__(self
, *args
, **kwargs
):
1679 """__init__(self) -> NativeEncodingInfo"""
1680 _gdi_
.NativeEncodingInfo_swiginit(self
,_gdi_
.new_NativeEncodingInfo(*args
, **kwargs
))
1681 __swig_destroy__
= _gdi_
.delete_NativeEncodingInfo
1682 __del__
= lambda self
: None;
1683 def FromString(*args
, **kwargs
):
1684 """FromString(self, String s) -> bool"""
1685 return _gdi_
.NativeEncodingInfo_FromString(*args
, **kwargs
)
1687 def ToString(*args
, **kwargs
):
1688 """ToString(self) -> String"""
1689 return _gdi_
.NativeEncodingInfo_ToString(*args
, **kwargs
)
1691 _gdi_
.NativeEncodingInfo_swigregister(NativeEncodingInfo
)
1694 def GetNativeFontEncoding(*args
, **kwargs
):
1695 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
1696 return _gdi_
.GetNativeFontEncoding(*args
, **kwargs
)
1698 def TestFontEncoding(*args
, **kwargs
):
1699 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
1700 return _gdi_
.TestFontEncoding(*args
, **kwargs
)
1701 #---------------------------------------------------------------------------
1703 class FontMapper(object):
1704 """Proxy of C++ FontMapper class"""
1705 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1706 __repr__
= _swig_repr
1707 def __init__(self
, *args
, **kwargs
):
1708 """__init__(self) -> FontMapper"""
1709 _gdi_
.FontMapper_swiginit(self
,_gdi_
.new_FontMapper(*args
, **kwargs
))
1710 __swig_destroy__
= _gdi_
.delete_FontMapper
1711 __del__
= lambda self
: None;
1712 def Get(*args
, **kwargs
):
1713 """Get() -> FontMapper"""
1714 return _gdi_
.FontMapper_Get(*args
, **kwargs
)
1716 Get
= staticmethod(Get
)
1717 def Set(*args
, **kwargs
):
1718 """Set(FontMapper mapper) -> FontMapper"""
1719 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1721 Set
= staticmethod(Set
)
1722 def CharsetToEncoding(*args
, **kwargs
):
1723 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
1724 return _gdi_
.FontMapper_CharsetToEncoding(*args
, **kwargs
)
1726 def GetSupportedEncodingsCount(*args
, **kwargs
):
1727 """GetSupportedEncodingsCount() -> size_t"""
1728 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
, **kwargs
)
1730 GetSupportedEncodingsCount
= staticmethod(GetSupportedEncodingsCount
)
1731 def GetEncoding(*args
, **kwargs
):
1732 """GetEncoding(size_t n) -> int"""
1733 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1735 GetEncoding
= staticmethod(GetEncoding
)
1736 def GetEncodingName(*args
, **kwargs
):
1737 """GetEncodingName(int encoding) -> String"""
1738 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1740 GetEncodingName
= staticmethod(GetEncodingName
)
1741 def GetEncodingDescription(*args
, **kwargs
):
1742 """GetEncodingDescription(int encoding) -> String"""
1743 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1745 GetEncodingDescription
= staticmethod(GetEncodingDescription
)
1746 def GetEncodingFromName(*args
, **kwargs
):
1747 """GetEncodingFromName(String name) -> int"""
1748 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1750 GetEncodingFromName
= staticmethod(GetEncodingFromName
)
1751 def SetConfigPath(*args
, **kwargs
):
1752 """SetConfigPath(self, String prefix)"""
1753 return _gdi_
.FontMapper_SetConfigPath(*args
, **kwargs
)
1755 def GetDefaultConfigPath(*args
, **kwargs
):
1756 """GetDefaultConfigPath() -> String"""
1757 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
, **kwargs
)
1759 GetDefaultConfigPath
= staticmethod(GetDefaultConfigPath
)
1760 def GetAltForEncoding(*args
, **kwargs
):
1761 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
1762 return _gdi_
.FontMapper_GetAltForEncoding(*args
, **kwargs
)
1764 def IsEncodingAvailable(*args
, **kwargs
):
1765 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
1766 return _gdi_
.FontMapper_IsEncodingAvailable(*args
, **kwargs
)
1768 def SetDialogParent(*args
, **kwargs
):
1769 """SetDialogParent(self, Window parent)"""
1770 return _gdi_
.FontMapper_SetDialogParent(*args
, **kwargs
)
1772 def SetDialogTitle(*args
, **kwargs
):
1773 """SetDialogTitle(self, String title)"""
1774 return _gdi_
.FontMapper_SetDialogTitle(*args
, **kwargs
)
1776 AltForEncoding
= property(GetAltForEncoding
,doc
="See `GetAltForEncoding`")
1777 _gdi_
.FontMapper_swigregister(FontMapper
)
1779 def FontMapper_Get(*args
):
1780 """FontMapper_Get() -> FontMapper"""
1781 return _gdi_
.FontMapper_Get(*args
)
1783 def FontMapper_Set(*args
, **kwargs
):
1784 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
1785 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1787 def FontMapper_GetSupportedEncodingsCount(*args
):
1788 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
1789 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
)
1791 def FontMapper_GetEncoding(*args
, **kwargs
):
1792 """FontMapper_GetEncoding(size_t n) -> int"""
1793 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1795 def FontMapper_GetEncodingName(*args
, **kwargs
):
1796 """FontMapper_GetEncodingName(int encoding) -> String"""
1797 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1799 def FontMapper_GetEncodingDescription(*args
, **kwargs
):
1800 """FontMapper_GetEncodingDescription(int encoding) -> String"""
1801 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1803 def FontMapper_GetEncodingFromName(*args
, **kwargs
):
1804 """FontMapper_GetEncodingFromName(String name) -> int"""
1805 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1807 def FontMapper_GetDefaultConfigPath(*args
):
1808 """FontMapper_GetDefaultConfigPath() -> String"""
1809 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
)
1811 #---------------------------------------------------------------------------
1813 class Font(GDIObject
):
1815 A font is an object which determines the appearance of text. Fonts are
1816 used for drawing text to a device context, and setting the appearance
1819 You can retrieve the current system font settings with `wx.SystemSettings`.
1821 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1822 __repr__
= _swig_repr
1823 def __init__(self
, *args
, **kwargs
):
1825 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
1826 String face=EmptyString,
1827 int encoding=FONTENCODING_DEFAULT) -> Font
1829 Creates a font object with the specified attributes.
1831 :param pointSize: The size of the font in points.
1833 :param family: Font family. A generic way of referring to fonts
1834 without specifying actual facename. It can be One of
1835 the ``wx.FONTFAMILY_xxx`` constants.
1837 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1839 :param weight: Font weight, sometimes also referred to as font
1840 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1842 :param underline: The value can be ``True`` or ``False`` and
1843 indicates whether the font will include an underline. This
1844 may not be supported on all platforms.
1846 :param face: An optional string specifying the actual typeface to
1847 be used. If it is an empty string, a default typeface will be
1848 chosen based on the family.
1850 :param encoding: An encoding which may be one of the
1851 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1852 available, no font is created.
1854 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1855 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1858 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1859 _gdi_
.Font_swiginit(self
,_gdi_
.new_Font(*args
, **kwargs
))
1860 __swig_destroy__
= _gdi_
.delete_Font
1861 __del__
= lambda self
: None;
1862 def Ok(*args
, **kwargs
):
1866 Returns ``True`` if this font was successfully created.
1868 return _gdi_
.Font_Ok(*args
, **kwargs
)
1870 def __nonzero__(self
): return self
.Ok()
1871 def __eq__(*args
, **kwargs
):
1872 """__eq__(self, Font other) -> bool"""
1873 return _gdi_
.Font___eq__(*args
, **kwargs
)
1875 def __ne__(*args
, **kwargs
):
1876 """__ne__(self, Font other) -> bool"""
1877 return _gdi_
.Font___ne__(*args
, **kwargs
)
1879 def GetPointSize(*args
, **kwargs
):
1881 GetPointSize(self) -> int
1883 Gets the point size.
1885 return _gdi_
.Font_GetPointSize(*args
, **kwargs
)
1887 def GetPixelSize(*args
, **kwargs
):
1889 GetPixelSize(self) -> Size
1891 Returns the size in pixels if the font was constructed with a pixel
1894 return _gdi_
.Font_GetPixelSize(*args
, **kwargs
)
1896 def IsUsingSizeInPixels(*args
, **kwargs
):
1898 IsUsingSizeInPixels(self) -> bool
1900 Returns ``True`` if the font is using a pixelSize.
1902 return _gdi_
.Font_IsUsingSizeInPixels(*args
, **kwargs
)
1904 def GetFamily(*args
, **kwargs
):
1906 GetFamily(self) -> int
1908 Gets the font family.
1910 return _gdi_
.Font_GetFamily(*args
, **kwargs
)
1912 def GetStyle(*args
, **kwargs
):
1914 GetStyle(self) -> int
1916 Gets the font style.
1918 return _gdi_
.Font_GetStyle(*args
, **kwargs
)
1920 def GetWeight(*args
, **kwargs
):
1922 GetWeight(self) -> int
1924 Gets the font weight.
1926 return _gdi_
.Font_GetWeight(*args
, **kwargs
)
1928 def GetUnderlined(*args
, **kwargs
):
1930 GetUnderlined(self) -> bool
1932 Returns ``True`` if the font is underlined, ``False`` otherwise.
1934 return _gdi_
.Font_GetUnderlined(*args
, **kwargs
)
1936 def GetFaceName(*args
, **kwargs
):
1938 GetFaceName(self) -> String
1940 Returns the typeface name associated with the font, or the empty
1941 string if there is no typeface information.
1943 return _gdi_
.Font_GetFaceName(*args
, **kwargs
)
1945 def GetEncoding(*args
, **kwargs
):
1947 GetEncoding(self) -> int
1949 Get the font's encoding.
1951 return _gdi_
.Font_GetEncoding(*args
, **kwargs
)
1953 def GetNativeFontInfo(*args
, **kwargs
):
1955 GetNativeFontInfo(self) -> NativeFontInfo
1957 Constructs a `wx.NativeFontInfo` object from this font.
1959 return _gdi_
.Font_GetNativeFontInfo(*args
, **kwargs
)
1961 def IsFixedWidth(*args
, **kwargs
):
1963 IsFixedWidth(self) -> bool
1965 Returns true if the font is a fixed width (or monospaced) font, false
1966 if it is a proportional one or font is invalid.
1968 return _gdi_
.Font_IsFixedWidth(*args
, **kwargs
)
1970 def GetNativeFontInfoDesc(*args
, **kwargs
):
1972 GetNativeFontInfoDesc(self) -> String
1974 Returns the platform-dependent string completely describing this font
1975 or an empty string if the font isn't valid.
1977 return _gdi_
.Font_GetNativeFontInfoDesc(*args
, **kwargs
)
1979 def GetNativeFontInfoUserDesc(*args
, **kwargs
):
1981 GetNativeFontInfoUserDesc(self) -> String
1983 Returns a human readable version of `GetNativeFontInfoDesc`.
1985 return _gdi_
.Font_GetNativeFontInfoUserDesc(*args
, **kwargs
)
1987 def SetPointSize(*args
, **kwargs
):
1989 SetPointSize(self, int pointSize)
1991 Sets the point size.
1993 return _gdi_
.Font_SetPointSize(*args
, **kwargs
)
1995 def SetPixelSize(*args
, **kwargs
):
1997 SetPixelSize(self, Size pixelSize)
1999 Sets the size in pixels rather than points. If there is platform API
2000 support for this then it is used, otherwise a font with the closest
2001 size is found using a binary search.
2003 return _gdi_
.Font_SetPixelSize(*args
, **kwargs
)
2005 def SetFamily(*args
, **kwargs
):
2007 SetFamily(self, int family)
2009 Sets the font family.
2011 return _gdi_
.Font_SetFamily(*args
, **kwargs
)
2013 def SetStyle(*args
, **kwargs
):
2015 SetStyle(self, int style)
2017 Sets the font style.
2019 return _gdi_
.Font_SetStyle(*args
, **kwargs
)
2021 def SetWeight(*args
, **kwargs
):
2023 SetWeight(self, int weight)
2025 Sets the font weight.
2027 return _gdi_
.Font_SetWeight(*args
, **kwargs
)
2029 def SetFaceName(*args
, **kwargs
):
2031 SetFaceName(self, String faceName) -> bool
2033 Sets the facename for the font. The facename, which should be a valid
2034 font installed on the end-user's system.
2036 To avoid portability problems, don't rely on a specific face, but
2037 specify the font family instead or as well. A suitable font will be
2038 found on the end-user's system. If both the family and the facename
2039 are specified, wxWidgets will first search for the specific face, and
2040 then for a font belonging to the same family.
2042 return _gdi_
.Font_SetFaceName(*args
, **kwargs
)
2044 def SetUnderlined(*args
, **kwargs
):
2046 SetUnderlined(self, bool underlined)
2050 return _gdi_
.Font_SetUnderlined(*args
, **kwargs
)
2052 def SetEncoding(*args
, **kwargs
):
2054 SetEncoding(self, int encoding)
2056 Set the font encoding.
2058 return _gdi_
.Font_SetEncoding(*args
, **kwargs
)
2060 def SetNativeFontInfo(*args
, **kwargs
):
2062 SetNativeFontInfo(self, NativeFontInfo info)
2064 Set the font's attributes from a `wx.NativeFontInfo` object.
2066 return _gdi_
.Font_SetNativeFontInfo(*args
, **kwargs
)
2068 def SetNativeFontInfoFromString(*args
, **kwargs
):
2070 SetNativeFontInfoFromString(self, String info) -> bool
2072 Set the font's attributes from string representation of a
2073 `wx.NativeFontInfo` object.
2075 return _gdi_
.Font_SetNativeFontInfoFromString(*args
, **kwargs
)
2077 def SetNativeFontInfoUserDesc(*args
, **kwargs
):
2079 SetNativeFontInfoUserDesc(self, String info) -> bool
2081 Set the font's attributes from a string formerly returned from
2082 `GetNativeFontInfoDesc`.
2084 return _gdi_
.Font_SetNativeFontInfoUserDesc(*args
, **kwargs
)
2086 def GetFamilyString(*args
, **kwargs
):
2088 GetFamilyString(self) -> String
2090 Returns a string representation of the font family.
2092 return _gdi_
.Font_GetFamilyString(*args
, **kwargs
)
2094 def GetStyleString(*args
, **kwargs
):
2096 GetStyleString(self) -> String
2098 Returns a string representation of the font style.
2100 return _gdi_
.Font_GetStyleString(*args
, **kwargs
)
2102 def GetWeightString(*args
, **kwargs
):
2104 GetWeightString(self) -> String
2106 Return a string representation of the font weight.
2108 return _gdi_
.Font_GetWeightString(*args
, **kwargs
)
2110 def SetNoAntiAliasing(*args
, **kwargs
):
2111 """SetNoAntiAliasing(self, bool no=True)"""
2112 return _gdi_
.Font_SetNoAntiAliasing(*args
, **kwargs
)
2114 def GetNoAntiAliasing(*args
, **kwargs
):
2115 """GetNoAntiAliasing(self) -> bool"""
2116 return _gdi_
.Font_GetNoAntiAliasing(*args
, **kwargs
)
2118 def GetDefaultEncoding(*args
, **kwargs
):
2120 GetDefaultEncoding() -> int
2122 Returns the encoding used for all fonts created with an encoding of
2123 ``wx.FONTENCODING_DEFAULT``.
2125 return _gdi_
.Font_GetDefaultEncoding(*args
, **kwargs
)
2127 GetDefaultEncoding
= staticmethod(GetDefaultEncoding
)
2128 def SetDefaultEncoding(*args
, **kwargs
):
2130 SetDefaultEncoding(int encoding)
2132 Sets the default font encoding.
2134 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
2136 SetDefaultEncoding
= staticmethod(SetDefaultEncoding
)
2137 Encoding
= property(GetEncoding
,SetEncoding
,doc
="See `GetEncoding` and `SetEncoding`")
2138 FaceName
= property(GetFaceName
,SetFaceName
,doc
="See `GetFaceName` and `SetFaceName`")
2139 Family
= property(GetFamily
,SetFamily
,doc
="See `GetFamily` and `SetFamily`")
2140 FamilyString
= property(GetFamilyString
,doc
="See `GetFamilyString`")
2141 NativeFontInfo
= property(GetNativeFontInfo
,SetNativeFontInfo
,doc
="See `GetNativeFontInfo` and `SetNativeFontInfo`")
2142 NativeFontInfoDesc
= property(GetNativeFontInfoDesc
,doc
="See `GetNativeFontInfoDesc`")
2143 NativeFontInfoUserDesc
= property(GetNativeFontInfoUserDesc
,SetNativeFontInfoUserDesc
,doc
="See `GetNativeFontInfoUserDesc` and `SetNativeFontInfoUserDesc`")
2144 NoAntiAliasing
= property(GetNoAntiAliasing
,SetNoAntiAliasing
,doc
="See `GetNoAntiAliasing` and `SetNoAntiAliasing`")
2145 PixelSize
= property(GetPixelSize
,SetPixelSize
,doc
="See `GetPixelSize` and `SetPixelSize`")
2146 PointSize
= property(GetPointSize
,SetPointSize
,doc
="See `GetPointSize` and `SetPointSize`")
2147 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
2148 StyleString
= property(GetStyleString
,doc
="See `GetStyleString`")
2149 Underlined
= property(GetUnderlined
,SetUnderlined
,doc
="See `GetUnderlined` and `SetUnderlined`")
2150 Weight
= property(GetWeight
,SetWeight
,doc
="See `GetWeight` and `SetWeight`")
2151 WeightString
= property(GetWeightString
,doc
="See `GetWeightString`")
2152 _gdi_
.Font_swigregister(Font
)
2154 def FontFromNativeInfo(*args
, **kwargs
):
2156 FontFromNativeInfo(NativeFontInfo info) -> Font
2158 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
2160 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2161 val
= _gdi_
.new_FontFromNativeInfo(*args
, **kwargs
)
2164 def FontFromNativeInfoString(*args
, **kwargs
):
2166 FontFromNativeInfoString(String info) -> Font
2168 Construct a `wx.Font` from the string representation of a
2169 `wx.NativeFontInfo` object.
2171 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2172 val
= _gdi_
.new_FontFromNativeInfoString(*args
, **kwargs
)
2175 def FFont(*args
, **kwargs
):
2177 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
2178 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2180 A bit of a simpler way to create a `wx.Font` using flags instead of
2181 individual attribute settings. The value of flags can be a
2182 combination of the following:
2184 ============================ ==
2190 wx.FONTFLAG_ANTIALIASED
2191 wx.FONTFLAG_NOT_ANTIALIASED
2192 wx.FONTFLAG_UNDERLINED
2193 wx.FONTFLAG_STRIKETHROUGH
2194 ============================ ==
2196 :see: `wx.Font.__init__`
2198 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2199 val
= _gdi_
.new_FFont(*args
, **kwargs
)
2202 def FontFromPixelSize(*args
, **kwargs
):
2204 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
2205 bool underlined=False, String face=wxEmptyString,
2206 int encoding=FONTENCODING_DEFAULT) -> Font
2208 Creates a font using a size in pixels rather than points. If there is
2209 platform API support for this then it is used, otherwise a font with
2210 the closest size is found using a binary search.
2212 :see: `wx.Font.__init__`
2214 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2215 val
= _gdi_
.new_FontFromPixelSize(*args
, **kwargs
)
2218 def FFontFromPixelSize(*args
, **kwargs
):
2220 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
2221 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2223 Creates a font using a size in pixels rather than points. If there is
2224 platform API support for this then it is used, otherwise a font with
2225 the closest size is found using a binary search.
2227 :see: `wx.Font.__init__`, `wx.FFont`
2229 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2230 val
= _gdi_
.new_FFontFromPixelSize(*args
, **kwargs
)
2233 def Font_GetDefaultEncoding(*args
):
2235 Font_GetDefaultEncoding() -> int
2237 Returns the encoding used for all fonts created with an encoding of
2238 ``wx.FONTENCODING_DEFAULT``.
2240 return _gdi_
.Font_GetDefaultEncoding(*args
)
2242 def Font_SetDefaultEncoding(*args
, **kwargs
):
2244 Font_SetDefaultEncoding(int encoding)
2246 Sets the default font encoding.
2248 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
2250 Font2
= wx
._deprecated
(FFont
, "Use `wx.FFont` instead.")
2251 #---------------------------------------------------------------------------
2253 class FontEnumerator(object):
2254 """Proxy of C++ FontEnumerator class"""
2255 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2256 __repr__
= _swig_repr
2257 def __init__(self
, *args
, **kwargs
):
2258 """__init__(self) -> FontEnumerator"""
2259 _gdi_
.FontEnumerator_swiginit(self
,_gdi_
.new_FontEnumerator(*args
, **kwargs
))
2260 self
._setCallbackInfo
(self
, FontEnumerator
, 0)
2262 __swig_destroy__
= _gdi_
.delete_FontEnumerator
2263 __del__
= lambda self
: None;
2264 def _setCallbackInfo(*args
, **kwargs
):
2265 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
2266 return _gdi_
.FontEnumerator__setCallbackInfo(*args
, **kwargs
)
2268 def EnumerateFacenames(*args
, **kwargs
):
2269 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
2270 return _gdi_
.FontEnumerator_EnumerateFacenames(*args
, **kwargs
)
2272 def EnumerateEncodings(*args
, **kwargs
):
2273 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
2274 return _gdi_
.FontEnumerator_EnumerateEncodings(*args
, **kwargs
)
2276 def GetEncodings(*args
, **kwargs
):
2277 """GetEncodings() -> PyObject"""
2278 return _gdi_
.FontEnumerator_GetEncodings(*args
, **kwargs
)
2280 GetEncodings
= staticmethod(GetEncodings
)
2281 def GetFacenames(*args
, **kwargs
):
2282 """GetFacenames() -> PyObject"""
2283 return _gdi_
.FontEnumerator_GetFacenames(*args
, **kwargs
)
2285 GetFacenames
= staticmethod(GetFacenames
)
2286 def IsValidFacename(*args
, **kwargs
):
2288 IsValidFacename(String str) -> bool
2290 Convenience function that returns true if the given face name exist in
2293 return _gdi_
.FontEnumerator_IsValidFacename(*args
, **kwargs
)
2295 IsValidFacename
= staticmethod(IsValidFacename
)
2296 _gdi_
.FontEnumerator_swigregister(FontEnumerator
)
2298 def FontEnumerator_GetEncodings(*args
):
2299 """FontEnumerator_GetEncodings() -> PyObject"""
2300 return _gdi_
.FontEnumerator_GetEncodings(*args
)
2302 def FontEnumerator_GetFacenames(*args
):
2303 """FontEnumerator_GetFacenames() -> PyObject"""
2304 return _gdi_
.FontEnumerator_GetFacenames(*args
)
2306 def FontEnumerator_IsValidFacename(*args
, **kwargs
):
2308 FontEnumerator_IsValidFacename(String str) -> bool
2310 Convenience function that returns true if the given face name exist in
2313 return _gdi_
.FontEnumerator_IsValidFacename(*args
, **kwargs
)
2315 #---------------------------------------------------------------------------
2317 Layout_Default
= _gdi_
.Layout_Default
2318 Layout_LeftToRight
= _gdi_
.Layout_LeftToRight
2319 Layout_RightToLeft
= _gdi_
.Layout_RightToLeft
2320 LANGUAGE_DEFAULT
= _gdi_
.LANGUAGE_DEFAULT
2321 LANGUAGE_UNKNOWN
= _gdi_
.LANGUAGE_UNKNOWN
2322 LANGUAGE_ABKHAZIAN
= _gdi_
.LANGUAGE_ABKHAZIAN
2323 LANGUAGE_AFAR
= _gdi_
.LANGUAGE_AFAR
2324 LANGUAGE_AFRIKAANS
= _gdi_
.LANGUAGE_AFRIKAANS
2325 LANGUAGE_ALBANIAN
= _gdi_
.LANGUAGE_ALBANIAN
2326 LANGUAGE_AMHARIC
= _gdi_
.LANGUAGE_AMHARIC
2327 LANGUAGE_ARABIC
= _gdi_
.LANGUAGE_ARABIC
2328 LANGUAGE_ARABIC_ALGERIA
= _gdi_
.LANGUAGE_ARABIC_ALGERIA
2329 LANGUAGE_ARABIC_BAHRAIN
= _gdi_
.LANGUAGE_ARABIC_BAHRAIN
2330 LANGUAGE_ARABIC_EGYPT
= _gdi_
.LANGUAGE_ARABIC_EGYPT
2331 LANGUAGE_ARABIC_IRAQ
= _gdi_
.LANGUAGE_ARABIC_IRAQ
2332 LANGUAGE_ARABIC_JORDAN
= _gdi_
.LANGUAGE_ARABIC_JORDAN
2333 LANGUAGE_ARABIC_KUWAIT
= _gdi_
.LANGUAGE_ARABIC_KUWAIT
2334 LANGUAGE_ARABIC_LEBANON
= _gdi_
.LANGUAGE_ARABIC_LEBANON
2335 LANGUAGE_ARABIC_LIBYA
= _gdi_
.LANGUAGE_ARABIC_LIBYA
2336 LANGUAGE_ARABIC_MOROCCO
= _gdi_
.LANGUAGE_ARABIC_MOROCCO
2337 LANGUAGE_ARABIC_OMAN
= _gdi_
.LANGUAGE_ARABIC_OMAN
2338 LANGUAGE_ARABIC_QATAR
= _gdi_
.LANGUAGE_ARABIC_QATAR
2339 LANGUAGE_ARABIC_SAUDI_ARABIA
= _gdi_
.LANGUAGE_ARABIC_SAUDI_ARABIA
2340 LANGUAGE_ARABIC_SUDAN
= _gdi_
.LANGUAGE_ARABIC_SUDAN
2341 LANGUAGE_ARABIC_SYRIA
= _gdi_
.LANGUAGE_ARABIC_SYRIA
2342 LANGUAGE_ARABIC_TUNISIA
= _gdi_
.LANGUAGE_ARABIC_TUNISIA
2343 LANGUAGE_ARABIC_UAE
= _gdi_
.LANGUAGE_ARABIC_UAE
2344 LANGUAGE_ARABIC_YEMEN
= _gdi_
.LANGUAGE_ARABIC_YEMEN
2345 LANGUAGE_ARMENIAN
= _gdi_
.LANGUAGE_ARMENIAN
2346 LANGUAGE_ASSAMESE
= _gdi_
.LANGUAGE_ASSAMESE
2347 LANGUAGE_AYMARA
= _gdi_
.LANGUAGE_AYMARA
2348 LANGUAGE_AZERI
= _gdi_
.LANGUAGE_AZERI
2349 LANGUAGE_AZERI_CYRILLIC
= _gdi_
.LANGUAGE_AZERI_CYRILLIC
2350 LANGUAGE_AZERI_LATIN
= _gdi_
.LANGUAGE_AZERI_LATIN
2351 LANGUAGE_BASHKIR
= _gdi_
.LANGUAGE_BASHKIR
2352 LANGUAGE_BASQUE
= _gdi_
.LANGUAGE_BASQUE
2353 LANGUAGE_BELARUSIAN
= _gdi_
.LANGUAGE_BELARUSIAN
2354 LANGUAGE_BENGALI
= _gdi_
.LANGUAGE_BENGALI
2355 LANGUAGE_BHUTANI
= _gdi_
.LANGUAGE_BHUTANI
2356 LANGUAGE_BIHARI
= _gdi_
.LANGUAGE_BIHARI
2357 LANGUAGE_BISLAMA
= _gdi_
.LANGUAGE_BISLAMA
2358 LANGUAGE_BRETON
= _gdi_
.LANGUAGE_BRETON
2359 LANGUAGE_BULGARIAN
= _gdi_
.LANGUAGE_BULGARIAN
2360 LANGUAGE_BURMESE
= _gdi_
.LANGUAGE_BURMESE
2361 LANGUAGE_CAMBODIAN
= _gdi_
.LANGUAGE_CAMBODIAN
2362 LANGUAGE_CATALAN
= _gdi_
.LANGUAGE_CATALAN
2363 LANGUAGE_CHINESE
= _gdi_
.LANGUAGE_CHINESE
2364 LANGUAGE_CHINESE_SIMPLIFIED
= _gdi_
.LANGUAGE_CHINESE_SIMPLIFIED
2365 LANGUAGE_CHINESE_TRADITIONAL
= _gdi_
.LANGUAGE_CHINESE_TRADITIONAL
2366 LANGUAGE_CHINESE_HONGKONG
= _gdi_
.LANGUAGE_CHINESE_HONGKONG
2367 LANGUAGE_CHINESE_MACAU
= _gdi_
.LANGUAGE_CHINESE_MACAU
2368 LANGUAGE_CHINESE_SINGAPORE
= _gdi_
.LANGUAGE_CHINESE_SINGAPORE
2369 LANGUAGE_CHINESE_TAIWAN
= _gdi_
.LANGUAGE_CHINESE_TAIWAN
2370 LANGUAGE_CORSICAN
= _gdi_
.LANGUAGE_CORSICAN
2371 LANGUAGE_CROATIAN
= _gdi_
.LANGUAGE_CROATIAN
2372 LANGUAGE_CZECH
= _gdi_
.LANGUAGE_CZECH
2373 LANGUAGE_DANISH
= _gdi_
.LANGUAGE_DANISH
2374 LANGUAGE_DUTCH
= _gdi_
.LANGUAGE_DUTCH
2375 LANGUAGE_DUTCH_BELGIAN
= _gdi_
.LANGUAGE_DUTCH_BELGIAN
2376 LANGUAGE_ENGLISH
= _gdi_
.LANGUAGE_ENGLISH
2377 LANGUAGE_ENGLISH_UK
= _gdi_
.LANGUAGE_ENGLISH_UK
2378 LANGUAGE_ENGLISH_US
= _gdi_
.LANGUAGE_ENGLISH_US
2379 LANGUAGE_ENGLISH_AUSTRALIA
= _gdi_
.LANGUAGE_ENGLISH_AUSTRALIA
2380 LANGUAGE_ENGLISH_BELIZE
= _gdi_
.LANGUAGE_ENGLISH_BELIZE
2381 LANGUAGE_ENGLISH_BOTSWANA
= _gdi_
.LANGUAGE_ENGLISH_BOTSWANA
2382 LANGUAGE_ENGLISH_CANADA
= _gdi_
.LANGUAGE_ENGLISH_CANADA
2383 LANGUAGE_ENGLISH_CARIBBEAN
= _gdi_
.LANGUAGE_ENGLISH_CARIBBEAN
2384 LANGUAGE_ENGLISH_DENMARK
= _gdi_
.LANGUAGE_ENGLISH_DENMARK
2385 LANGUAGE_ENGLISH_EIRE
= _gdi_
.LANGUAGE_ENGLISH_EIRE
2386 LANGUAGE_ENGLISH_JAMAICA
= _gdi_
.LANGUAGE_ENGLISH_JAMAICA
2387 LANGUAGE_ENGLISH_NEW_ZEALAND
= _gdi_
.LANGUAGE_ENGLISH_NEW_ZEALAND
2388 LANGUAGE_ENGLISH_PHILIPPINES
= _gdi_
.LANGUAGE_ENGLISH_PHILIPPINES
2389 LANGUAGE_ENGLISH_SOUTH_AFRICA
= _gdi_
.LANGUAGE_ENGLISH_SOUTH_AFRICA
2390 LANGUAGE_ENGLISH_TRINIDAD
= _gdi_
.LANGUAGE_ENGLISH_TRINIDAD
2391 LANGUAGE_ENGLISH_ZIMBABWE
= _gdi_
.LANGUAGE_ENGLISH_ZIMBABWE
2392 LANGUAGE_ESPERANTO
= _gdi_
.LANGUAGE_ESPERANTO
2393 LANGUAGE_ESTONIAN
= _gdi_
.LANGUAGE_ESTONIAN
2394 LANGUAGE_FAEROESE
= _gdi_
.LANGUAGE_FAEROESE
2395 LANGUAGE_FARSI
= _gdi_
.LANGUAGE_FARSI
2396 LANGUAGE_FIJI
= _gdi_
.LANGUAGE_FIJI
2397 LANGUAGE_FINNISH
= _gdi_
.LANGUAGE_FINNISH
2398 LANGUAGE_FRENCH
= _gdi_
.LANGUAGE_FRENCH
2399 LANGUAGE_FRENCH_BELGIAN
= _gdi_
.LANGUAGE_FRENCH_BELGIAN
2400 LANGUAGE_FRENCH_CANADIAN
= _gdi_
.LANGUAGE_FRENCH_CANADIAN
2401 LANGUAGE_FRENCH_LUXEMBOURG
= _gdi_
.LANGUAGE_FRENCH_LUXEMBOURG
2402 LANGUAGE_FRENCH_MONACO
= _gdi_
.LANGUAGE_FRENCH_MONACO
2403 LANGUAGE_FRENCH_SWISS
= _gdi_
.LANGUAGE_FRENCH_SWISS
2404 LANGUAGE_FRISIAN
= _gdi_
.LANGUAGE_FRISIAN
2405 LANGUAGE_GALICIAN
= _gdi_
.LANGUAGE_GALICIAN
2406 LANGUAGE_GEORGIAN
= _gdi_
.LANGUAGE_GEORGIAN
2407 LANGUAGE_GERMAN
= _gdi_
.LANGUAGE_GERMAN
2408 LANGUAGE_GERMAN_AUSTRIAN
= _gdi_
.LANGUAGE_GERMAN_AUSTRIAN
2409 LANGUAGE_GERMAN_BELGIUM
= _gdi_
.LANGUAGE_GERMAN_BELGIUM
2410 LANGUAGE_GERMAN_LIECHTENSTEIN
= _gdi_
.LANGUAGE_GERMAN_LIECHTENSTEIN
2411 LANGUAGE_GERMAN_LUXEMBOURG
= _gdi_
.LANGUAGE_GERMAN_LUXEMBOURG
2412 LANGUAGE_GERMAN_SWISS
= _gdi_
.LANGUAGE_GERMAN_SWISS
2413 LANGUAGE_GREEK
= _gdi_
.LANGUAGE_GREEK
2414 LANGUAGE_GREENLANDIC
= _gdi_
.LANGUAGE_GREENLANDIC
2415 LANGUAGE_GUARANI
= _gdi_
.LANGUAGE_GUARANI
2416 LANGUAGE_GUJARATI
= _gdi_
.LANGUAGE_GUJARATI
2417 LANGUAGE_HAUSA
= _gdi_
.LANGUAGE_HAUSA
2418 LANGUAGE_HEBREW
= _gdi_
.LANGUAGE_HEBREW
2419 LANGUAGE_HINDI
= _gdi_
.LANGUAGE_HINDI
2420 LANGUAGE_HUNGARIAN
= _gdi_
.LANGUAGE_HUNGARIAN
2421 LANGUAGE_ICELANDIC
= _gdi_
.LANGUAGE_ICELANDIC
2422 LANGUAGE_INDONESIAN
= _gdi_
.LANGUAGE_INDONESIAN
2423 LANGUAGE_INTERLINGUA
= _gdi_
.LANGUAGE_INTERLINGUA
2424 LANGUAGE_INTERLINGUE
= _gdi_
.LANGUAGE_INTERLINGUE
2425 LANGUAGE_INUKTITUT
= _gdi_
.LANGUAGE_INUKTITUT
2426 LANGUAGE_INUPIAK
= _gdi_
.LANGUAGE_INUPIAK
2427 LANGUAGE_IRISH
= _gdi_
.LANGUAGE_IRISH
2428 LANGUAGE_ITALIAN
= _gdi_
.LANGUAGE_ITALIAN
2429 LANGUAGE_ITALIAN_SWISS
= _gdi_
.LANGUAGE_ITALIAN_SWISS
2430 LANGUAGE_JAPANESE
= _gdi_
.LANGUAGE_JAPANESE
2431 LANGUAGE_JAVANESE
= _gdi_
.LANGUAGE_JAVANESE
2432 LANGUAGE_KANNADA
= _gdi_
.LANGUAGE_KANNADA
2433 LANGUAGE_KASHMIRI
= _gdi_
.LANGUAGE_KASHMIRI
2434 LANGUAGE_KASHMIRI_INDIA
= _gdi_
.LANGUAGE_KASHMIRI_INDIA
2435 LANGUAGE_KAZAKH
= _gdi_
.LANGUAGE_KAZAKH
2436 LANGUAGE_KERNEWEK
= _gdi_
.LANGUAGE_KERNEWEK
2437 LANGUAGE_KINYARWANDA
= _gdi_
.LANGUAGE_KINYARWANDA
2438 LANGUAGE_KIRGHIZ
= _gdi_
.LANGUAGE_KIRGHIZ
2439 LANGUAGE_KIRUNDI
= _gdi_
.LANGUAGE_KIRUNDI
2440 LANGUAGE_KONKANI
= _gdi_
.LANGUAGE_KONKANI
2441 LANGUAGE_KOREAN
= _gdi_
.LANGUAGE_KOREAN
2442 LANGUAGE_KURDISH
= _gdi_
.LANGUAGE_KURDISH
2443 LANGUAGE_LAOTHIAN
= _gdi_
.LANGUAGE_LAOTHIAN
2444 LANGUAGE_LATIN
= _gdi_
.LANGUAGE_LATIN
2445 LANGUAGE_LATVIAN
= _gdi_
.LANGUAGE_LATVIAN
2446 LANGUAGE_LINGALA
= _gdi_
.LANGUAGE_LINGALA
2447 LANGUAGE_LITHUANIAN
= _gdi_
.LANGUAGE_LITHUANIAN
2448 LANGUAGE_MACEDONIAN
= _gdi_
.LANGUAGE_MACEDONIAN
2449 LANGUAGE_MALAGASY
= _gdi_
.LANGUAGE_MALAGASY
2450 LANGUAGE_MALAY
= _gdi_
.LANGUAGE_MALAY
2451 LANGUAGE_MALAYALAM
= _gdi_
.LANGUAGE_MALAYALAM
2452 LANGUAGE_MALAY_BRUNEI_DARUSSALAM
= _gdi_
.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2453 LANGUAGE_MALAY_MALAYSIA
= _gdi_
.LANGUAGE_MALAY_MALAYSIA
2454 LANGUAGE_MALTESE
= _gdi_
.LANGUAGE_MALTESE
2455 LANGUAGE_MANIPURI
= _gdi_
.LANGUAGE_MANIPURI
2456 LANGUAGE_MAORI
= _gdi_
.LANGUAGE_MAORI
2457 LANGUAGE_MARATHI
= _gdi_
.LANGUAGE_MARATHI
2458 LANGUAGE_MOLDAVIAN
= _gdi_
.LANGUAGE_MOLDAVIAN
2459 LANGUAGE_MONGOLIAN
= _gdi_
.LANGUAGE_MONGOLIAN
2460 LANGUAGE_NAURU
= _gdi_
.LANGUAGE_NAURU
2461 LANGUAGE_NEPALI
= _gdi_
.LANGUAGE_NEPALI
2462 LANGUAGE_NEPALI_INDIA
= _gdi_
.LANGUAGE_NEPALI_INDIA
2463 LANGUAGE_NORWEGIAN_BOKMAL
= _gdi_
.LANGUAGE_NORWEGIAN_BOKMAL
2464 LANGUAGE_NORWEGIAN_NYNORSK
= _gdi_
.LANGUAGE_NORWEGIAN_NYNORSK
2465 LANGUAGE_OCCITAN
= _gdi_
.LANGUAGE_OCCITAN
2466 LANGUAGE_ORIYA
= _gdi_
.LANGUAGE_ORIYA
2467 LANGUAGE_OROMO
= _gdi_
.LANGUAGE_OROMO
2468 LANGUAGE_PASHTO
= _gdi_
.LANGUAGE_PASHTO
2469 LANGUAGE_POLISH
= _gdi_
.LANGUAGE_POLISH
2470 LANGUAGE_PORTUGUESE
= _gdi_
.LANGUAGE_PORTUGUESE
2471 LANGUAGE_PORTUGUESE_BRAZILIAN
= _gdi_
.LANGUAGE_PORTUGUESE_BRAZILIAN
2472 LANGUAGE_PUNJABI
= _gdi_
.LANGUAGE_PUNJABI
2473 LANGUAGE_QUECHUA
= _gdi_
.LANGUAGE_QUECHUA
2474 LANGUAGE_RHAETO_ROMANCE
= _gdi_
.LANGUAGE_RHAETO_ROMANCE
2475 LANGUAGE_ROMANIAN
= _gdi_
.LANGUAGE_ROMANIAN
2476 LANGUAGE_RUSSIAN
= _gdi_
.LANGUAGE_RUSSIAN
2477 LANGUAGE_RUSSIAN_UKRAINE
= _gdi_
.LANGUAGE_RUSSIAN_UKRAINE
2478 LANGUAGE_SAMOAN
= _gdi_
.LANGUAGE_SAMOAN
2479 LANGUAGE_SANGHO
= _gdi_
.LANGUAGE_SANGHO
2480 LANGUAGE_SANSKRIT
= _gdi_
.LANGUAGE_SANSKRIT
2481 LANGUAGE_SCOTS_GAELIC
= _gdi_
.LANGUAGE_SCOTS_GAELIC
2482 LANGUAGE_SERBIAN
= _gdi_
.LANGUAGE_SERBIAN
2483 LANGUAGE_SERBIAN_CYRILLIC
= _gdi_
.LANGUAGE_SERBIAN_CYRILLIC
2484 LANGUAGE_SERBIAN_LATIN
= _gdi_
.LANGUAGE_SERBIAN_LATIN
2485 LANGUAGE_SERBO_CROATIAN
= _gdi_
.LANGUAGE_SERBO_CROATIAN
2486 LANGUAGE_SESOTHO
= _gdi_
.LANGUAGE_SESOTHO
2487 LANGUAGE_SETSWANA
= _gdi_
.LANGUAGE_SETSWANA
2488 LANGUAGE_SHONA
= _gdi_
.LANGUAGE_SHONA
2489 LANGUAGE_SINDHI
= _gdi_
.LANGUAGE_SINDHI
2490 LANGUAGE_SINHALESE
= _gdi_
.LANGUAGE_SINHALESE
2491 LANGUAGE_SISWATI
= _gdi_
.LANGUAGE_SISWATI
2492 LANGUAGE_SLOVAK
= _gdi_
.LANGUAGE_SLOVAK
2493 LANGUAGE_SLOVENIAN
= _gdi_
.LANGUAGE_SLOVENIAN
2494 LANGUAGE_SOMALI
= _gdi_
.LANGUAGE_SOMALI
2495 LANGUAGE_SPANISH
= _gdi_
.LANGUAGE_SPANISH
2496 LANGUAGE_SPANISH_ARGENTINA
= _gdi_
.LANGUAGE_SPANISH_ARGENTINA
2497 LANGUAGE_SPANISH_BOLIVIA
= _gdi_
.LANGUAGE_SPANISH_BOLIVIA
2498 LANGUAGE_SPANISH_CHILE
= _gdi_
.LANGUAGE_SPANISH_CHILE
2499 LANGUAGE_SPANISH_COLOMBIA
= _gdi_
.LANGUAGE_SPANISH_COLOMBIA
2500 LANGUAGE_SPANISH_COSTA_RICA
= _gdi_
.LANGUAGE_SPANISH_COSTA_RICA
2501 LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
= _gdi_
.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2502 LANGUAGE_SPANISH_ECUADOR
= _gdi_
.LANGUAGE_SPANISH_ECUADOR
2503 LANGUAGE_SPANISH_EL_SALVADOR
= _gdi_
.LANGUAGE_SPANISH_EL_SALVADOR
2504 LANGUAGE_SPANISH_GUATEMALA
= _gdi_
.LANGUAGE_SPANISH_GUATEMALA
2505 LANGUAGE_SPANISH_HONDURAS
= _gdi_
.LANGUAGE_SPANISH_HONDURAS
2506 LANGUAGE_SPANISH_MEXICAN
= _gdi_
.LANGUAGE_SPANISH_MEXICAN
2507 LANGUAGE_SPANISH_MODERN
= _gdi_
.LANGUAGE_SPANISH_MODERN
2508 LANGUAGE_SPANISH_NICARAGUA
= _gdi_
.LANGUAGE_SPANISH_NICARAGUA
2509 LANGUAGE_SPANISH_PANAMA
= _gdi_
.LANGUAGE_SPANISH_PANAMA
2510 LANGUAGE_SPANISH_PARAGUAY
= _gdi_
.LANGUAGE_SPANISH_PARAGUAY
2511 LANGUAGE_SPANISH_PERU
= _gdi_
.LANGUAGE_SPANISH_PERU
2512 LANGUAGE_SPANISH_PUERTO_RICO
= _gdi_
.LANGUAGE_SPANISH_PUERTO_RICO
2513 LANGUAGE_SPANISH_URUGUAY
= _gdi_
.LANGUAGE_SPANISH_URUGUAY
2514 LANGUAGE_SPANISH_US
= _gdi_
.LANGUAGE_SPANISH_US
2515 LANGUAGE_SPANISH_VENEZUELA
= _gdi_
.LANGUAGE_SPANISH_VENEZUELA
2516 LANGUAGE_SUNDANESE
= _gdi_
.LANGUAGE_SUNDANESE
2517 LANGUAGE_SWAHILI
= _gdi_
.LANGUAGE_SWAHILI
2518 LANGUAGE_SWEDISH
= _gdi_
.LANGUAGE_SWEDISH
2519 LANGUAGE_SWEDISH_FINLAND
= _gdi_
.LANGUAGE_SWEDISH_FINLAND
2520 LANGUAGE_TAGALOG
= _gdi_
.LANGUAGE_TAGALOG
2521 LANGUAGE_TAJIK
= _gdi_
.LANGUAGE_TAJIK
2522 LANGUAGE_TAMIL
= _gdi_
.LANGUAGE_TAMIL
2523 LANGUAGE_TATAR
= _gdi_
.LANGUAGE_TATAR
2524 LANGUAGE_TELUGU
= _gdi_
.LANGUAGE_TELUGU
2525 LANGUAGE_THAI
= _gdi_
.LANGUAGE_THAI
2526 LANGUAGE_TIBETAN
= _gdi_
.LANGUAGE_TIBETAN
2527 LANGUAGE_TIGRINYA
= _gdi_
.LANGUAGE_TIGRINYA
2528 LANGUAGE_TONGA
= _gdi_
.LANGUAGE_TONGA
2529 LANGUAGE_TSONGA
= _gdi_
.LANGUAGE_TSONGA
2530 LANGUAGE_TURKISH
= _gdi_
.LANGUAGE_TURKISH
2531 LANGUAGE_TURKMEN
= _gdi_
.LANGUAGE_TURKMEN
2532 LANGUAGE_TWI
= _gdi_
.LANGUAGE_TWI
2533 LANGUAGE_UIGHUR
= _gdi_
.LANGUAGE_UIGHUR
2534 LANGUAGE_UKRAINIAN
= _gdi_
.LANGUAGE_UKRAINIAN
2535 LANGUAGE_URDU
= _gdi_
.LANGUAGE_URDU
2536 LANGUAGE_URDU_INDIA
= _gdi_
.LANGUAGE_URDU_INDIA
2537 LANGUAGE_URDU_PAKISTAN
= _gdi_
.LANGUAGE_URDU_PAKISTAN
2538 LANGUAGE_UZBEK
= _gdi_
.LANGUAGE_UZBEK
2539 LANGUAGE_UZBEK_CYRILLIC
= _gdi_
.LANGUAGE_UZBEK_CYRILLIC
2540 LANGUAGE_UZBEK_LATIN
= _gdi_
.LANGUAGE_UZBEK_LATIN
2541 LANGUAGE_VIETNAMESE
= _gdi_
.LANGUAGE_VIETNAMESE
2542 LANGUAGE_VOLAPUK
= _gdi_
.LANGUAGE_VOLAPUK
2543 LANGUAGE_WELSH
= _gdi_
.LANGUAGE_WELSH
2544 LANGUAGE_WOLOF
= _gdi_
.LANGUAGE_WOLOF
2545 LANGUAGE_XHOSA
= _gdi_
.LANGUAGE_XHOSA
2546 LANGUAGE_YIDDISH
= _gdi_
.LANGUAGE_YIDDISH
2547 LANGUAGE_YORUBA
= _gdi_
.LANGUAGE_YORUBA
2548 LANGUAGE_ZHUANG
= _gdi_
.LANGUAGE_ZHUANG
2549 LANGUAGE_ZULU
= _gdi_
.LANGUAGE_ZULU
2550 LANGUAGE_USER_DEFINED
= _gdi_
.LANGUAGE_USER_DEFINED
2551 class LanguageInfo(object):
2552 """Proxy of C++ LanguageInfo class"""
2553 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2554 def __init__(self
): raise AttributeError, "No constructor defined"
2555 __repr__
= _swig_repr
2556 Language
= property(_gdi_
.LanguageInfo_Language_get
, _gdi_
.LanguageInfo_Language_set
)
2557 CanonicalName
= property(_gdi_
.LanguageInfo_CanonicalName_get
, _gdi_
.LanguageInfo_CanonicalName_set
)
2558 Description
= property(_gdi_
.LanguageInfo_Description_get
, _gdi_
.LanguageInfo_Description_set
)
2559 _gdi_
.LanguageInfo_swigregister(LanguageInfo
)
2561 LOCALE_CAT_NUMBER
= _gdi_
.LOCALE_CAT_NUMBER
2562 LOCALE_CAT_DATE
= _gdi_
.LOCALE_CAT_DATE
2563 LOCALE_CAT_MONEY
= _gdi_
.LOCALE_CAT_MONEY
2564 LOCALE_CAT_MAX
= _gdi_
.LOCALE_CAT_MAX
2565 LOCALE_THOUSANDS_SEP
= _gdi_
.LOCALE_THOUSANDS_SEP
2566 LOCALE_DECIMAL_POINT
= _gdi_
.LOCALE_DECIMAL_POINT
2567 LOCALE_LOAD_DEFAULT
= _gdi_
.LOCALE_LOAD_DEFAULT
2568 LOCALE_CONV_ENCODING
= _gdi_
.LOCALE_CONV_ENCODING
2569 class Locale(object):
2570 """Proxy of C++ Locale class"""
2571 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2572 __repr__
= _swig_repr
2573 def __init__(self
, *args
, **kwargs
):
2574 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
2575 _gdi_
.Locale_swiginit(self
,_gdi_
.new_Locale(*args
, **kwargs
))
2576 __swig_destroy__
= _gdi_
.delete_Locale
2577 __del__
= lambda self
: None;
2578 def Init1(*args
, **kwargs
):
2580 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2581 bool bLoadDefault=True,
2582 bool bConvertEncoding=False) -> bool
2584 return _gdi_
.Locale_Init1(*args
, **kwargs
)
2586 def Init2(*args
, **kwargs
):
2587 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2588 return _gdi_
.Locale_Init2(*args
, **kwargs
)
2590 def Init(self
, *_args
, **_kwargs
):
2591 if type(_args
[0]) in [type(''), type(u
'')]:
2592 val
= self
.Init1(*_args
, **_kwargs
)
2594 val
= self
.Init2(*_args
, **_kwargs
)
2597 def GetSystemLanguage(*args
, **kwargs
):
2598 """GetSystemLanguage() -> int"""
2599 return _gdi_
.Locale_GetSystemLanguage(*args
, **kwargs
)
2601 GetSystemLanguage
= staticmethod(GetSystemLanguage
)
2602 def GetSystemEncoding(*args
, **kwargs
):
2603 """GetSystemEncoding() -> int"""
2604 return _gdi_
.Locale_GetSystemEncoding(*args
, **kwargs
)
2606 GetSystemEncoding
= staticmethod(GetSystemEncoding
)
2607 def GetSystemEncodingName(*args
, **kwargs
):
2608 """GetSystemEncodingName() -> String"""
2609 return _gdi_
.Locale_GetSystemEncodingName(*args
, **kwargs
)
2611 GetSystemEncodingName
= staticmethod(GetSystemEncodingName
)
2612 def IsOk(*args
, **kwargs
):
2613 """IsOk(self) -> bool"""
2614 return _gdi_
.Locale_IsOk(*args
, **kwargs
)
2616 def __nonzero__(self
): return self
.IsOk()
2617 def GetLocale(*args
, **kwargs
):
2618 """GetLocale(self) -> String"""
2619 return _gdi_
.Locale_GetLocale(*args
, **kwargs
)
2621 def GetLanguage(*args
, **kwargs
):
2622 """GetLanguage(self) -> int"""
2623 return _gdi_
.Locale_GetLanguage(*args
, **kwargs
)
2625 def GetSysName(*args
, **kwargs
):
2626 """GetSysName(self) -> String"""
2627 return _gdi_
.Locale_GetSysName(*args
, **kwargs
)
2629 def GetCanonicalName(*args
, **kwargs
):
2630 """GetCanonicalName(self) -> String"""
2631 return _gdi_
.Locale_GetCanonicalName(*args
, **kwargs
)
2633 def AddCatalogLookupPathPrefix(*args
, **kwargs
):
2634 """AddCatalogLookupPathPrefix(String prefix)"""
2635 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2637 AddCatalogLookupPathPrefix
= staticmethod(AddCatalogLookupPathPrefix
)
2638 def AddCatalog(*args
, **kwargs
):
2639 """AddCatalog(self, String szDomain) -> bool"""
2640 return _gdi_
.Locale_AddCatalog(*args
, **kwargs
)
2642 def IsLoaded(*args
, **kwargs
):
2643 """IsLoaded(self, String szDomain) -> bool"""
2644 return _gdi_
.Locale_IsLoaded(*args
, **kwargs
)
2646 def GetLanguageInfo(*args
, **kwargs
):
2647 """GetLanguageInfo(int lang) -> LanguageInfo"""
2648 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2650 GetLanguageInfo
= staticmethod(GetLanguageInfo
)
2651 def GetLanguageName(*args
, **kwargs
):
2652 """GetLanguageName(int lang) -> String"""
2653 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2655 GetLanguageName
= staticmethod(GetLanguageName
)
2656 def FindLanguageInfo(*args
, **kwargs
):
2657 """FindLanguageInfo(String locale) -> LanguageInfo"""
2658 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2660 FindLanguageInfo
= staticmethod(FindLanguageInfo
)
2661 def AddLanguage(*args
, **kwargs
):
2662 """AddLanguage(LanguageInfo info)"""
2663 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2665 AddLanguage
= staticmethod(AddLanguage
)
2666 def GetString(*args
, **kwargs
):
2667 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2668 return _gdi_
.Locale_GetString(*args
, **kwargs
)
2670 def GetName(*args
, **kwargs
):
2671 """GetName(self) -> String"""
2672 return _gdi_
.Locale_GetName(*args
, **kwargs
)
2674 CanonicalName
= property(GetCanonicalName
,doc
="See `GetCanonicalName`")
2675 Language
= property(GetLanguage
,doc
="See `GetLanguage`")
2676 Locale
= property(GetLocale
,doc
="See `GetLocale`")
2677 Name
= property(GetName
,doc
="See `GetName`")
2678 String
= property(GetString
,doc
="See `GetString`")
2679 SysName
= property(GetSysName
,doc
="See `GetSysName`")
2680 _gdi_
.Locale_swigregister(Locale
)
2682 def Locale_GetSystemLanguage(*args
):
2683 """Locale_GetSystemLanguage() -> int"""
2684 return _gdi_
.Locale_GetSystemLanguage(*args
)
2686 def Locale_GetSystemEncoding(*args
):
2687 """Locale_GetSystemEncoding() -> int"""
2688 return _gdi_
.Locale_GetSystemEncoding(*args
)
2690 def Locale_GetSystemEncodingName(*args
):
2691 """Locale_GetSystemEncodingName() -> String"""
2692 return _gdi_
.Locale_GetSystemEncodingName(*args
)
2694 def Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
):
2695 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2696 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2698 def Locale_GetLanguageInfo(*args
, **kwargs
):
2699 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2700 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2702 def Locale_GetLanguageName(*args
, **kwargs
):
2703 """Locale_GetLanguageName(int lang) -> String"""
2704 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2706 def Locale_FindLanguageInfo(*args
, **kwargs
):
2707 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2708 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2710 def Locale_AddLanguage(*args
, **kwargs
):
2711 """Locale_AddLanguage(LanguageInfo info)"""
2712 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2714 class PyLocale(Locale
):
2715 """Proxy of C++ PyLocale class"""
2716 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2717 __repr__
= _swig_repr
2718 def __init__(self
, *args
, **kwargs
):
2719 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale"""
2720 _gdi_
.PyLocale_swiginit(self
,_gdi_
.new_PyLocale(*args
, **kwargs
))
2721 self
._setCallbackInfo
(self
, PyLocale
)
2723 __swig_destroy__
= _gdi_
.delete_PyLocale
2724 __del__
= lambda self
: None;
2725 def _setCallbackInfo(*args
, **kwargs
):
2726 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2727 return _gdi_
.PyLocale__setCallbackInfo(*args
, **kwargs
)
2729 def GetSingularString(*args
, **kwargs
):
2730 """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar"""
2731 return _gdi_
.PyLocale_GetSingularString(*args
, **kwargs
)
2733 def GetPluralString(*args
, **kwargs
):
2735 GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n,
2736 wxChar szDomain=None) -> wxChar
2738 return _gdi_
.PyLocale_GetPluralString(*args
, **kwargs
)
2740 _gdi_
.PyLocale_swigregister(PyLocale
)
2743 def GetLocale(*args
):
2744 """GetLocale() -> Locale"""
2745 return _gdi_
.GetLocale(*args
)
2746 #---------------------------------------------------------------------------
2748 CONVERT_STRICT
= _gdi_
.CONVERT_STRICT
2749 CONVERT_SUBSTITUTE
= _gdi_
.CONVERT_SUBSTITUTE
2750 PLATFORM_CURRENT
= _gdi_
.PLATFORM_CURRENT
2751 PLATFORM_UNIX
= _gdi_
.PLATFORM_UNIX
2752 PLATFORM_WINDOWS
= _gdi_
.PLATFORM_WINDOWS
2753 PLATFORM_OS2
= _gdi_
.PLATFORM_OS2
2754 PLATFORM_MAC
= _gdi_
.PLATFORM_MAC
2755 class EncodingConverter(_core
.Object
):
2756 """Proxy of C++ EncodingConverter class"""
2757 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2758 __repr__
= _swig_repr
2759 def __init__(self
, *args
, **kwargs
):
2760 """__init__(self) -> EncodingConverter"""
2761 _gdi_
.EncodingConverter_swiginit(self
,_gdi_
.new_EncodingConverter(*args
, **kwargs
))
2762 __swig_destroy__
= _gdi_
.delete_EncodingConverter
2763 __del__
= lambda self
: None;
2764 def Init(*args
, **kwargs
):
2765 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2766 return _gdi_
.EncodingConverter_Init(*args
, **kwargs
)
2768 def Convert(*args
, **kwargs
):
2769 """Convert(self, String input) -> String"""
2770 return _gdi_
.EncodingConverter_Convert(*args
, **kwargs
)
2772 def GetPlatformEquivalents(*args
, **kwargs
):
2773 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2774 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2776 GetPlatformEquivalents
= staticmethod(GetPlatformEquivalents
)
2777 def GetAllEquivalents(*args
, **kwargs
):
2778 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2779 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2781 GetAllEquivalents
= staticmethod(GetAllEquivalents
)
2782 def CanConvert(*args
, **kwargs
):
2783 """CanConvert(int encIn, int encOut) -> bool"""
2784 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2786 CanConvert
= staticmethod(CanConvert
)
2787 def __nonzero__(self
): return self
.IsOk()
2788 _gdi_
.EncodingConverter_swigregister(EncodingConverter
)
2790 def GetTranslation(*args
):
2792 GetTranslation(String str) -> String
2793 GetTranslation(String str, String domain) -> String
2794 GetTranslation(String str, String strPlural, size_t n) -> String
2795 GetTranslation(String str, String strPlural, size_t n, String domain) -> String
2797 return _gdi_
.GetTranslation(*args
)
2799 def EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
):
2800 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2801 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2803 def EncodingConverter_GetAllEquivalents(*args
, **kwargs
):
2804 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2805 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2807 def EncodingConverter_CanConvert(*args
, **kwargs
):
2808 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2809 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2811 #----------------------------------------------------------------------------
2812 # On MSW add the directory where the wxWidgets catalogs were installed
2813 # to the default catalog path.
2814 if wx
.Platform
== "__WXMSW__":
2816 _localedir
= os
.path
.join(os
.path
.split(__file__
)[0], "i18n")
2817 Locale
.AddCatalogLookupPathPrefix(_localedir
)
2820 #----------------------------------------------------------------------------
2822 #---------------------------------------------------------------------------
2824 class DC(_core
.Object
):
2826 A wx.DC is a device context onto which graphics and text can be
2827 drawn. It is intended to represent a number of output devices in a
2828 generic way, so a window can have a device context associated with it,
2829 and a printer also has a device context. In this way, the same piece
2830 of code may write to a number of different devices, if the device
2831 context is used as a parameter.
2833 Derived types of wxDC have documentation for specific features only,
2834 so refer to this section for most device context information.
2836 The wx.DC class is abstract and can not be instantiated, you must use
2837 one of the derived classes instead. Which one will depend on the
2838 situation in which it is used.
2840 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2841 def __init__(self
): raise AttributeError, "No constructor defined"
2842 __repr__
= _swig_repr
2843 __swig_destroy__
= _gdi_
.delete_DC
2844 __del__
= lambda self
: None;
2845 # These have been deprecated in wxWidgets. Since they never
2846 # really did anything to begin with, just make them be NOPs.
2847 def BeginDrawing(self
): pass
2848 def EndDrawing(self
): pass
2850 def FloodFill(*args
, **kwargs
):
2852 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2854 Flood fills the device context starting from the given point, using
2855 the current brush colour, and using a style:
2857 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2858 the given colour is encountered.
2860 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2863 Returns False if the operation failed.
2865 Note: The present implementation for non-Windows platforms may fail to
2866 find colour borders if the pixels do not match the colour
2867 exactly. However the function will still return true.
2869 return _gdi_
.DC_FloodFill(*args
, **kwargs
)
2871 def FloodFillPoint(*args
, **kwargs
):
2873 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2875 Flood fills the device context starting from the given point, using
2876 the current brush colour, and using a style:
2878 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2879 the given colour is encountered.
2881 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2884 Returns False if the operation failed.
2886 Note: The present implementation for non-Windows platforms may fail to
2887 find colour borders if the pixels do not match the colour
2888 exactly. However the function will still return true.
2890 return _gdi_
.DC_FloodFillPoint(*args
, **kwargs
)
2892 def GradientFillConcentric(*args
, **kwargs
):
2894 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2897 Fill the area specified by rect with a radial gradient, starting from
2898 initialColour in the center of the circle and fading to destColour on
2899 the outside of the circle. The circleCenter argument is the relative
2900 coordinants of the center of the circle in the specified rect.
2902 Note: Currently this function is very slow, don't use it for real-time
2905 return _gdi_
.DC_GradientFillConcentric(*args
, **kwargs
)
2907 def GradientFillLinear(*args
, **kwargs
):
2909 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2910 int nDirection=EAST)
2912 Fill the area specified by rect with a linear gradient, starting from
2913 initialColour and eventually fading to destColour. The nDirection
2914 parameter specifies the direction of the colour change, default is to
2915 use initialColour on the left part of the rectangle and destColour on
2918 return _gdi_
.DC_GradientFillLinear(*args
, **kwargs
)
2920 def GetPixel(*args
, **kwargs
):
2922 GetPixel(self, int x, int y) -> Colour
2924 Gets the colour at the specified location on the DC.
2926 return _gdi_
.DC_GetPixel(*args
, **kwargs
)
2928 def GetPixelPoint(*args
, **kwargs
):
2929 """GetPixelPoint(self, Point pt) -> Colour"""
2930 return _gdi_
.DC_GetPixelPoint(*args
, **kwargs
)
2932 def DrawLine(*args
, **kwargs
):
2934 DrawLine(self, int x1, int y1, int x2, int y2)
2936 Draws a line from the first point to the second. The current pen is
2937 used for drawing the line. Note that the second point is *not* part of
2938 the line and is not drawn by this function (this is consistent with
2939 the behaviour of many other toolkits).
2941 return _gdi_
.DC_DrawLine(*args
, **kwargs
)
2943 def DrawLinePoint(*args
, **kwargs
):
2945 DrawLinePoint(self, Point pt1, Point pt2)
2947 Draws a line from the first point to the second. The current pen is
2948 used for drawing the line. Note that the second point is *not* part of
2949 the line and is not drawn by this function (this is consistent with
2950 the behaviour of many other toolkits).
2952 return _gdi_
.DC_DrawLinePoint(*args
, **kwargs
)
2954 def CrossHair(*args
, **kwargs
):
2956 CrossHair(self, int x, int y)
2958 Displays a cross hair using the current pen. This is a vertical and
2959 horizontal line the height and width of the window, centred on the
2962 return _gdi_
.DC_CrossHair(*args
, **kwargs
)
2964 def CrossHairPoint(*args
, **kwargs
):
2966 CrossHairPoint(self, Point pt)
2968 Displays a cross hair using the current pen. This is a vertical and
2969 horizontal line the height and width of the window, centred on the
2972 return _gdi_
.DC_CrossHairPoint(*args
, **kwargs
)
2974 def DrawArc(*args
, **kwargs
):
2976 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
2978 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2979 the first point to the second. The current pen is used for the outline
2980 and the current brush for filling the shape.
2982 The arc is drawn in an anticlockwise direction from the start point to
2985 return _gdi_
.DC_DrawArc(*args
, **kwargs
)
2987 def DrawArcPoint(*args
, **kwargs
):
2989 DrawArcPoint(self, Point pt1, Point pt2, Point center)
2991 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2992 the first point to the second. The current pen is used for the outline
2993 and the current brush for filling the shape.
2995 The arc is drawn in an anticlockwise direction from the start point to
2998 return _gdi_
.DC_DrawArcPoint(*args
, **kwargs
)
3000 def DrawCheckMark(*args
, **kwargs
):
3002 DrawCheckMark(self, int x, int y, int width, int height)
3004 Draws a check mark inside the given rectangle.
3006 return _gdi_
.DC_DrawCheckMark(*args
, **kwargs
)
3008 def DrawCheckMarkRect(*args
, **kwargs
):
3010 DrawCheckMarkRect(self, Rect rect)
3012 Draws a check mark inside the given rectangle.
3014 return _gdi_
.DC_DrawCheckMarkRect(*args
, **kwargs
)
3016 def DrawEllipticArc(*args
, **kwargs
):
3018 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
3020 Draws an arc of an ellipse, with the given rectangle defining the
3021 bounds of the ellipse. The current pen is used for drawing the arc and
3022 the current brush is used for drawing the pie.
3024 The *start* and *end* parameters specify the start and end of the arc
3025 relative to the three-o'clock position from the center of the
3026 rectangle. Angles are specified in degrees (360 is a complete
3027 circle). Positive values mean counter-clockwise motion. If start is
3028 equal to end, a complete ellipse will be drawn.
3030 return _gdi_
.DC_DrawEllipticArc(*args
, **kwargs
)
3032 def DrawEllipticArcPointSize(*args
, **kwargs
):
3034 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
3036 Draws an arc of an ellipse, with the given rectangle defining the
3037 bounds of the ellipse. The current pen is used for drawing the arc and
3038 the current brush is used for drawing the pie.
3040 The *start* and *end* parameters specify the start and end of the arc
3041 relative to the three-o'clock position from the center of the
3042 rectangle. Angles are specified in degrees (360 is a complete
3043 circle). Positive values mean counter-clockwise motion. If start is
3044 equal to end, a complete ellipse will be drawn.
3046 return _gdi_
.DC_DrawEllipticArcPointSize(*args
, **kwargs
)
3048 def DrawPoint(*args
, **kwargs
):
3050 DrawPoint(self, int x, int y)
3052 Draws a point using the current pen.
3054 return _gdi_
.DC_DrawPoint(*args
, **kwargs
)
3056 def DrawPointPoint(*args
, **kwargs
):
3058 DrawPointPoint(self, Point pt)
3060 Draws a point using the current pen.
3062 return _gdi_
.DC_DrawPointPoint(*args
, **kwargs
)
3064 def DrawRectangle(*args
, **kwargs
):
3066 DrawRectangle(self, int x, int y, int width, int height)
3068 Draws a rectangle with the given top left corner, and with the given
3069 size. The current pen is used for the outline and the current brush
3070 for filling the shape.
3072 return _gdi_
.DC_DrawRectangle(*args
, **kwargs
)
3074 def DrawRectangleRect(*args
, **kwargs
):
3076 DrawRectangleRect(self, Rect rect)
3078 Draws a rectangle with the given top left corner, and with the given
3079 size. The current pen is used for the outline and the current brush
3080 for filling the shape.
3082 return _gdi_
.DC_DrawRectangleRect(*args
, **kwargs
)
3084 def DrawRectanglePointSize(*args
, **kwargs
):
3086 DrawRectanglePointSize(self, Point pt, Size sz)
3088 Draws a rectangle with the given top left corner, and with the given
3089 size. The current pen is used for the outline and the current brush
3090 for filling the shape.
3092 return _gdi_
.DC_DrawRectanglePointSize(*args
, **kwargs
)
3094 def DrawRoundedRectangle(*args
, **kwargs
):
3096 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
3098 Draws a rectangle with the given top left corner, and with the given
3099 size. The corners are quarter-circles using the given radius. The
3100 current pen is used for the outline and the current brush for filling
3103 If radius is positive, the value is assumed to be the radius of the
3104 rounded corner. If radius is negative, the absolute value is assumed
3105 to be the proportion of the smallest dimension of the rectangle. This
3106 means that the corner can be a sensible size relative to the size of
3107 the rectangle, and also avoids the strange effects X produces when the
3108 corners are too big for the rectangle.
3110 return _gdi_
.DC_DrawRoundedRectangle(*args
, **kwargs
)
3112 def DrawRoundedRectangleRect(*args
, **kwargs
):
3114 DrawRoundedRectangleRect(self, Rect r, double radius)
3116 Draws a rectangle with the given top left corner, and with the given
3117 size. The corners are quarter-circles using the given radius. The
3118 current pen is used for the outline and the current brush for filling
3121 If radius is positive, the value is assumed to be the radius of the
3122 rounded corner. If radius is negative, the absolute value is assumed
3123 to be the proportion of the smallest dimension of the rectangle. This
3124 means that the corner can be a sensible size relative to the size of
3125 the rectangle, and also avoids the strange effects X produces when the
3126 corners are too big for the rectangle.
3128 return _gdi_
.DC_DrawRoundedRectangleRect(*args
, **kwargs
)
3130 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
3132 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
3134 Draws a rectangle with the given top left corner, and with the given
3135 size. The corners are quarter-circles using the given radius. The
3136 current pen is used for the outline and the current brush for filling
3139 If radius is positive, the value is assumed to be the radius of the
3140 rounded corner. If radius is negative, the absolute value is assumed
3141 to be the proportion of the smallest dimension of the rectangle. This
3142 means that the corner can be a sensible size relative to the size of
3143 the rectangle, and also avoids the strange effects X produces when the
3144 corners are too big for the rectangle.
3146 return _gdi_
.DC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
3148 def DrawCircle(*args
, **kwargs
):
3150 DrawCircle(self, int x, int y, int radius)
3152 Draws a circle with the given center point and radius. The current
3153 pen is used for the outline and the current brush for filling the
3156 return _gdi_
.DC_DrawCircle(*args
, **kwargs
)
3158 def DrawCirclePoint(*args
, **kwargs
):
3160 DrawCirclePoint(self, Point pt, int radius)
3162 Draws a circle with the given center point and radius. The current
3163 pen is used for the outline and the current brush for filling the
3166 return _gdi_
.DC_DrawCirclePoint(*args
, **kwargs
)
3168 def DrawEllipse(*args
, **kwargs
):
3170 DrawEllipse(self, int x, int y, int width, int height)
3172 Draws an ellipse contained in the specified rectangle. The current pen
3173 is used for the outline and the current brush for filling the shape.
3175 return _gdi_
.DC_DrawEllipse(*args
, **kwargs
)
3177 def DrawEllipseRect(*args
, **kwargs
):
3179 DrawEllipseRect(self, Rect rect)
3181 Draws an ellipse contained in the specified rectangle. The current pen
3182 is used for the outline and the current brush for filling the shape.
3184 return _gdi_
.DC_DrawEllipseRect(*args
, **kwargs
)
3186 def DrawEllipsePointSize(*args
, **kwargs
):
3188 DrawEllipsePointSize(self, Point pt, Size sz)
3190 Draws an ellipse contained in the specified rectangle. The current pen
3191 is used for the outline and the current brush for filling the shape.
3193 return _gdi_
.DC_DrawEllipsePointSize(*args
, **kwargs
)
3195 def DrawIcon(*args
, **kwargs
):
3197 DrawIcon(self, Icon icon, int x, int y)
3199 Draw an icon on the display (does nothing if the device context is
3200 PostScript). This can be the simplest way of drawing bitmaps on a
3203 return _gdi_
.DC_DrawIcon(*args
, **kwargs
)
3205 def DrawIconPoint(*args
, **kwargs
):
3207 DrawIconPoint(self, Icon icon, Point pt)
3209 Draw an icon on the display (does nothing if the device context is
3210 PostScript). This can be the simplest way of drawing bitmaps on a
3213 return _gdi_
.DC_DrawIconPoint(*args
, **kwargs
)
3215 def DrawBitmap(*args
, **kwargs
):
3217 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
3219 Draw a bitmap on the device context at the specified point. If
3220 *transparent* is true and the bitmap has a transparency mask, (or
3221 alpha channel on the platforms that support it) then the bitmap will
3222 be drawn transparently.
3224 return _gdi_
.DC_DrawBitmap(*args
, **kwargs
)
3226 def DrawBitmapPoint(*args
, **kwargs
):
3228 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3230 Draw a bitmap on the device context at the specified point. If
3231 *transparent* is true and the bitmap has a transparency mask, (or
3232 alpha channel on the platforms that support it) then the bitmap will
3233 be drawn transparently.
3235 return _gdi_
.DC_DrawBitmapPoint(*args
, **kwargs
)
3237 def DrawText(*args
, **kwargs
):
3239 DrawText(self, String text, int x, int y)
3241 Draws a text string at the specified point, using the current text
3242 font, and the current text foreground and background colours.
3244 The coordinates refer to the top-left corner of the rectangle bounding
3245 the string. See `GetTextExtent` for how to get the dimensions of a
3246 text string, which can be used to position the text more precisely.
3248 **NOTE**: under wxGTK the current logical function is used by this
3249 function but it is ignored by wxMSW. Thus, you should avoid using
3250 logical functions with this function in portable programs.
3252 return _gdi_
.DC_DrawText(*args
, **kwargs
)
3254 def DrawTextPoint(*args
, **kwargs
):
3256 DrawTextPoint(self, String text, Point pt)
3258 Draws a text string at the specified point, using the current text
3259 font, and the current text foreground and background colours.
3261 The coordinates refer to the top-left corner of the rectangle bounding
3262 the string. See `GetTextExtent` for how to get the dimensions of a
3263 text string, which can be used to position the text more precisely.
3265 **NOTE**: under wxGTK the current logical function is used by this
3266 function but it is ignored by wxMSW. Thus, you should avoid using
3267 logical functions with this function in portable programs.
3269 return _gdi_
.DC_DrawTextPoint(*args
, **kwargs
)
3271 def DrawRotatedText(*args
, **kwargs
):
3273 DrawRotatedText(self, String text, int x, int y, double angle)
3275 Draws the text rotated by *angle* degrees, if supported by the platform.
3277 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3278 function. In particular, a font different from ``wx.NORMAL_FONT``
3279 should be used as the it is not normally a TrueType
3280 font. ``wx.SWISS_FONT`` is an example of a font which is.
3282 return _gdi_
.DC_DrawRotatedText(*args
, **kwargs
)
3284 def DrawRotatedTextPoint(*args
, **kwargs
):
3286 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3288 Draws the text rotated by *angle* degrees, if supported by the platform.
3290 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3291 function. In particular, a font different from ``wx.NORMAL_FONT``
3292 should be used as the it is not normally a TrueType
3293 font. ``wx.SWISS_FONT`` is an example of a font which is.
3295 return _gdi_
.DC_DrawRotatedTextPoint(*args
, **kwargs
)
3297 def Blit(*args
, **kwargs
):
3299 Blit(self, int xdest, int ydest, int width, int height, DC source,
3300 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3301 int xsrcMask=-1, int ysrcMask=-1) -> bool
3303 Copy from a source DC to this DC. Parameters specify the destination
3304 coordinates, size of area to copy, source DC, source coordinates,
3305 logical function, whether to use a bitmap mask, and mask source
3308 return _gdi_
.DC_Blit(*args
, **kwargs
)
3310 def BlitPointSize(*args
, **kwargs
):
3312 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
3313 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
3315 Copy from a source DC to this DC. Parameters specify the destination
3316 coordinates, size of area to copy, source DC, source coordinates,
3317 logical function, whether to use a bitmap mask, and mask source
3320 return _gdi_
.DC_BlitPointSize(*args
, **kwargs
)
3322 def SetClippingRegion(*args
, **kwargs
):
3324 SetClippingRegion(self, int x, int y, int width, int height)
3326 Sets the clipping region for this device context to the intersection
3327 of the given region described by the parameters of this method and the
3328 previously set clipping region. You should call `DestroyClippingRegion`
3329 if you want to set the clipping region exactly to the region
3332 The clipping region is an area to which drawing is
3333 restricted. Possible uses for the clipping region are for clipping
3334 text or for speeding up window redraws when only a known area of the
3337 return _gdi_
.DC_SetClippingRegion(*args
, **kwargs
)
3339 def SetClippingRegionPointSize(*args
, **kwargs
):
3341 SetClippingRegionPointSize(self, Point pt, Size sz)
3343 Sets the clipping region for this device context to the intersection
3344 of the given region described by the parameters of this method and the
3345 previously set clipping region. You should call `DestroyClippingRegion`
3346 if you want to set the clipping region exactly to the region
3349 The clipping region is an area to which drawing is
3350 restricted. Possible uses for the clipping region are for clipping
3351 text or for speeding up window redraws when only a known area of the
3354 return _gdi_
.DC_SetClippingRegionPointSize(*args
, **kwargs
)
3356 def SetClippingRegionAsRegion(*args
, **kwargs
):
3358 SetClippingRegionAsRegion(self, Region region)
3360 Sets the clipping region for this device context to the intersection
3361 of the given region described by the parameters of this method and the
3362 previously set clipping region. You should call `DestroyClippingRegion`
3363 if you want to set the clipping region exactly to the region
3366 The clipping region is an area to which drawing is
3367 restricted. Possible uses for the clipping region are for clipping
3368 text or for speeding up window redraws when only a known area of the
3371 return _gdi_
.DC_SetClippingRegionAsRegion(*args
, **kwargs
)
3373 def SetClippingRect(*args
, **kwargs
):
3375 SetClippingRect(self, Rect rect)
3377 Sets the clipping region for this device context to the intersection
3378 of the given region described by the parameters of this method and the
3379 previously set clipping region. You should call `DestroyClippingRegion`
3380 if you want to set the clipping region exactly to the region
3383 The clipping region is an area to which drawing is
3384 restricted. Possible uses for the clipping region are for clipping
3385 text or for speeding up window redraws when only a known area of the
3388 return _gdi_
.DC_SetClippingRect(*args
, **kwargs
)
3390 def DrawLines(*args
, **kwargs
):
3392 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3394 Draws lines using a sequence of `wx.Point` objects, adding the
3395 optional offset coordinate. The current pen is used for drawing the
3398 return _gdi_
.DC_DrawLines(*args
, **kwargs
)
3400 def DrawPolygon(*args
, **kwargs
):
3402 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
3403 int fillStyle=ODDEVEN_RULE)
3405 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3406 the optional offset coordinate. The last argument specifies the fill
3407 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3409 The current pen is used for drawing the outline, and the current brush
3410 for filling the shape. Using a transparent brush suppresses
3411 filling. Note that wxWidgets automatically closes the first and last
3414 return _gdi_
.DC_DrawPolygon(*args
, **kwargs
)
3416 def DrawLabel(*args
, **kwargs
):
3418 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3421 Draw *text* within the specified rectangle, abiding by the alignment
3422 flags. Will additionally emphasize the character at *indexAccel* if
3425 return _gdi_
.DC_DrawLabel(*args
, **kwargs
)
3427 def DrawImageLabel(*args
, **kwargs
):
3429 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3430 int indexAccel=-1) -> Rect
3432 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3433 drawing it) within the specified rectangle, abiding by the alignment
3434 flags. Will additionally emphasize the character at *indexAccel* if
3435 it is not -1. Returns the bounding rectangle.
3437 return _gdi_
.DC_DrawImageLabel(*args
, **kwargs
)
3439 def DrawSpline(*args
, **kwargs
):
3441 DrawSpline(self, List points)
3443 Draws a spline between all given control points, (a list of `wx.Point`
3444 objects) using the current pen. The spline is drawn using a series of
3445 lines, using an algorithm taken from the X drawing program 'XFIG'.
3447 return _gdi_
.DC_DrawSpline(*args
, **kwargs
)
3449 def Clear(*args
, **kwargs
):
3453 Clears the device context using the current background brush.
3455 return _gdi_
.DC_Clear(*args
, **kwargs
)
3457 def StartDoc(*args
, **kwargs
):
3459 StartDoc(self, String message) -> bool
3461 Starts a document (only relevant when outputting to a
3462 printer). *Message* is a message to show whilst printing.
3464 return _gdi_
.DC_StartDoc(*args
, **kwargs
)
3466 def EndDoc(*args
, **kwargs
):
3470 Ends a document (only relevant when outputting to a printer).
3472 return _gdi_
.DC_EndDoc(*args
, **kwargs
)
3474 def StartPage(*args
, **kwargs
):
3478 Starts a document page (only relevant when outputting to a printer).
3480 return _gdi_
.DC_StartPage(*args
, **kwargs
)
3482 def EndPage(*args
, **kwargs
):
3486 Ends a document page (only relevant when outputting to a printer).
3488 return _gdi_
.DC_EndPage(*args
, **kwargs
)
3490 def SetFont(*args
, **kwargs
):
3492 SetFont(self, Font font)
3494 Sets the current font for the DC. It must be a valid font, in
3495 particular you should not pass ``wx.NullFont`` to this method.
3497 return _gdi_
.DC_SetFont(*args
, **kwargs
)
3499 def SetPen(*args
, **kwargs
):
3501 SetPen(self, Pen pen)
3503 Sets the current pen for the DC.
3505 If the argument is ``wx.NullPen``, the current pen is selected out of the
3506 device context, and the original pen restored.
3508 return _gdi_
.DC_SetPen(*args
, **kwargs
)
3510 def SetBrush(*args
, **kwargs
):
3512 SetBrush(self, Brush brush)
3514 Sets the current brush for the DC.
3516 If the argument is ``wx.NullBrush``, the current brush is selected out
3517 of the device context, and the original brush restored, allowing the
3518 current brush to be destroyed safely.
3520 return _gdi_
.DC_SetBrush(*args
, **kwargs
)
3522 def SetBackground(*args
, **kwargs
):
3524 SetBackground(self, Brush brush)
3526 Sets the current background brush for the DC.
3528 return _gdi_
.DC_SetBackground(*args
, **kwargs
)
3530 def SetBackgroundMode(*args
, **kwargs
):
3532 SetBackgroundMode(self, int mode)
3534 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3535 determines whether text will be drawn with a background colour or
3538 return _gdi_
.DC_SetBackgroundMode(*args
, **kwargs
)
3540 def SetPalette(*args
, **kwargs
):
3542 SetPalette(self, Palette palette)
3544 If this is a window DC or memory DC, assigns the given palette to the
3545 window or bitmap associated with the DC. If the argument is
3546 ``wx.NullPalette``, the current palette is selected out of the device
3547 context, and the original palette restored.
3549 return _gdi_
.DC_SetPalette(*args
, **kwargs
)
3551 def DestroyClippingRegion(*args
, **kwargs
):
3553 DestroyClippingRegion(self)
3555 Destroys the current clipping region so that none of the DC is
3558 return _gdi_
.DC_DestroyClippingRegion(*args
, **kwargs
)
3560 def GetClippingBox(*args
, **kwargs
):
3562 GetClippingBox() -> (x, y, width, height)
3564 Gets the rectangle surrounding the current clipping region.
3566 return _gdi_
.DC_GetClippingBox(*args
, **kwargs
)
3568 def GetClippingRect(*args
, **kwargs
):
3570 GetClippingRect(self) -> Rect
3572 Gets the rectangle surrounding the current clipping region.
3574 return _gdi_
.DC_GetClippingRect(*args
, **kwargs
)
3576 def GetCharHeight(*args
, **kwargs
):
3578 GetCharHeight(self) -> int
3580 Gets the character height of the currently set font.
3582 return _gdi_
.DC_GetCharHeight(*args
, **kwargs
)
3584 def GetCharWidth(*args
, **kwargs
):
3586 GetCharWidth(self) -> int
3588 Gets the average character width of the currently set font.
3590 return _gdi_
.DC_GetCharWidth(*args
, **kwargs
)
3592 def GetTextExtent(*args
, **kwargs
):
3594 GetTextExtent(wxString string) -> (width, height)
3596 Get the width and height of the text using the current font. Only
3597 works for single line strings.
3599 return _gdi_
.DC_GetTextExtent(*args
, **kwargs
)
3601 def GetFullTextExtent(*args
, **kwargs
):
3603 GetFullTextExtent(wxString string, Font font=None) ->
3604 (width, height, descent, externalLeading)
3606 Get the width, height, decent and leading of the text using the
3607 current or specified font. Only works for single line strings.
3609 return _gdi_
.DC_GetFullTextExtent(*args
, **kwargs
)
3611 def GetMultiLineTextExtent(*args
, **kwargs
):
3613 GetMultiLineTextExtent(wxString string, Font font=None) ->
3614 (width, height, lineHeight)
3616 Get the width, height, decent and leading of the text using the
3617 current or specified font. Works for single as well as multi-line
3620 return _gdi_
.DC_GetMultiLineTextExtent(*args
, **kwargs
)
3622 def GetPartialTextExtents(*args
, **kwargs
):
3624 GetPartialTextExtents(self, text) -> [widths]
3626 Returns a list of integers such that each value is the distance in
3627 pixels from the begining of text to the coresponding character of
3628 *text*. The generic version simply builds a running total of the widths
3629 of each character using GetTextExtent, however if the various
3630 platforms have a native API function that is faster or more accurate
3631 than the generic implementation then it will be used instead.
3633 return _gdi_
.DC_GetPartialTextExtents(*args
, **kwargs
)
3635 def GetSize(*args
, **kwargs
):
3637 GetSize(self) -> Size
3639 This gets the horizontal and vertical resolution in device units. It
3640 can be used to scale graphics to fit the page. For example, if *maxX*
3641 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3642 used in your application, the following code will scale the graphic to
3643 fit on the printer page::
3646 scaleX = maxX*1.0 / w
3647 scaleY = maxY*1.0 / h
3648 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3651 return _gdi_
.DC_GetSize(*args
, **kwargs
)
3653 def GetSizeTuple(*args
, **kwargs
):
3655 GetSizeTuple() -> (width, height)
3657 This gets the horizontal and vertical resolution in device units. It
3658 can be used to scale graphics to fit the page. For example, if *maxX*
3659 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3660 used in your application, the following code will scale the graphic to
3661 fit on the printer page::
3664 scaleX = maxX*1.0 / w
3665 scaleY = maxY*1.0 / h
3666 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3669 return _gdi_
.DC_GetSizeTuple(*args
, **kwargs
)
3671 def GetSizeMM(*args
, **kwargs
):
3673 GetSizeMM(self) -> Size
3675 Get the DC size in milimeters.
3677 return _gdi_
.DC_GetSizeMM(*args
, **kwargs
)
3679 def GetSizeMMTuple(*args
, **kwargs
):
3681 GetSizeMMTuple() -> (width, height)
3683 Get the DC size in milimeters.
3685 return _gdi_
.DC_GetSizeMMTuple(*args
, **kwargs
)
3687 def DeviceToLogicalX(*args
, **kwargs
):
3689 DeviceToLogicalX(self, int x) -> int
3691 Convert device X coordinate to logical coordinate, using the current
3694 return _gdi_
.DC_DeviceToLogicalX(*args
, **kwargs
)
3696 def DeviceToLogicalY(*args
, **kwargs
):
3698 DeviceToLogicalY(self, int y) -> int
3700 Converts device Y coordinate to logical coordinate, using the current
3703 return _gdi_
.DC_DeviceToLogicalY(*args
, **kwargs
)
3705 def DeviceToLogicalXRel(*args
, **kwargs
):
3707 DeviceToLogicalXRel(self, int x) -> int
3709 Convert device X coordinate to relative logical coordinate, using the
3710 current mapping mode but ignoring the x axis orientation. Use this
3711 function for converting a width, for example.
3713 return _gdi_
.DC_DeviceToLogicalXRel(*args
, **kwargs
)
3715 def DeviceToLogicalYRel(*args
, **kwargs
):
3717 DeviceToLogicalYRel(self, int y) -> int
3719 Convert device Y coordinate to relative logical coordinate, using the
3720 current mapping mode but ignoring the y axis orientation. Use this
3721 function for converting a height, for example.
3723 return _gdi_
.DC_DeviceToLogicalYRel(*args
, **kwargs
)
3725 def LogicalToDeviceX(*args
, **kwargs
):
3727 LogicalToDeviceX(self, int x) -> int
3729 Converts logical X coordinate to device coordinate, using the current
3732 return _gdi_
.DC_LogicalToDeviceX(*args
, **kwargs
)
3734 def LogicalToDeviceY(*args
, **kwargs
):
3736 LogicalToDeviceY(self, int y) -> int
3738 Converts logical Y coordinate to device coordinate, using the current
3741 return _gdi_
.DC_LogicalToDeviceY(*args
, **kwargs
)
3743 def LogicalToDeviceXRel(*args
, **kwargs
):
3745 LogicalToDeviceXRel(self, int x) -> int
3747 Converts logical X coordinate to relative device coordinate, using the
3748 current mapping mode but ignoring the x axis orientation. Use this for
3749 converting a width, for example.
3751 return _gdi_
.DC_LogicalToDeviceXRel(*args
, **kwargs
)
3753 def LogicalToDeviceYRel(*args
, **kwargs
):
3755 LogicalToDeviceYRel(self, int y) -> int
3757 Converts logical Y coordinate to relative device coordinate, using the
3758 current mapping mode but ignoring the y axis orientation. Use this for
3759 converting a height, for example.
3761 return _gdi_
.DC_LogicalToDeviceYRel(*args
, **kwargs
)
3763 def CanDrawBitmap(*args
, **kwargs
):
3764 """CanDrawBitmap(self) -> bool"""
3765 return _gdi_
.DC_CanDrawBitmap(*args
, **kwargs
)
3767 def CanGetTextExtent(*args
, **kwargs
):
3768 """CanGetTextExtent(self) -> bool"""
3769 return _gdi_
.DC_CanGetTextExtent(*args
, **kwargs
)
3771 def GetDepth(*args
, **kwargs
):
3773 GetDepth(self) -> int
3775 Returns the colour depth of the DC.
3777 return _gdi_
.DC_GetDepth(*args
, **kwargs
)
3779 def GetPPI(*args
, **kwargs
):
3781 GetPPI(self) -> Size
3783 Resolution in pixels per inch
3785 return _gdi_
.DC_GetPPI(*args
, **kwargs
)
3787 def Ok(*args
, **kwargs
):
3791 Returns true if the DC is ok to use.
3793 return _gdi_
.DC_Ok(*args
, **kwargs
)
3795 def GetBackgroundMode(*args
, **kwargs
):
3797 GetBackgroundMode(self) -> int
3799 Returns the current background mode, either ``wx.SOLID`` or
3802 return _gdi_
.DC_GetBackgroundMode(*args
, **kwargs
)
3804 def GetBackground(*args
, **kwargs
):
3806 GetBackground(self) -> Brush
3808 Gets the brush used for painting the background.
3810 return _gdi_
.DC_GetBackground(*args
, **kwargs
)
3812 def GetBrush(*args
, **kwargs
):
3814 GetBrush(self) -> Brush
3816 Gets the current brush
3818 return _gdi_
.DC_GetBrush(*args
, **kwargs
)
3820 def GetFont(*args
, **kwargs
):
3822 GetFont(self) -> Font
3824 Gets the current font
3826 return _gdi_
.DC_GetFont(*args
, **kwargs
)
3828 def GetPen(*args
, **kwargs
):
3832 Gets the current pen
3834 return _gdi_
.DC_GetPen(*args
, **kwargs
)
3836 def GetTextBackground(*args
, **kwargs
):
3838 GetTextBackground(self) -> Colour
3840 Gets the current text background colour
3842 return _gdi_
.DC_GetTextBackground(*args
, **kwargs
)
3844 def GetTextForeground(*args
, **kwargs
):
3846 GetTextForeground(self) -> Colour
3848 Gets the current text foreground colour
3850 return _gdi_
.DC_GetTextForeground(*args
, **kwargs
)
3852 def SetTextForeground(*args
, **kwargs
):
3854 SetTextForeground(self, Colour colour)
3856 Sets the current text foreground colour for the DC.
3858 return _gdi_
.DC_SetTextForeground(*args
, **kwargs
)
3860 def SetTextBackground(*args
, **kwargs
):
3862 SetTextBackground(self, Colour colour)
3864 Sets the current text background colour for the DC.
3866 return _gdi_
.DC_SetTextBackground(*args
, **kwargs
)
3868 def GetMapMode(*args
, **kwargs
):
3870 GetMapMode(self) -> int
3872 Gets the current *mapping mode* for the device context
3874 return _gdi_
.DC_GetMapMode(*args
, **kwargs
)
3876 def SetMapMode(*args
, **kwargs
):
3878 SetMapMode(self, int mode)
3880 The *mapping mode* of the device context defines the unit of
3881 measurement used to convert logical units to device units. The
3882 mapping mode can be one of the following:
3884 ================ =============================================
3885 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3887 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3888 wx.MM_METRIC Each logical unit is 1 mm.
3889 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3890 wx.MM_TEXT Each logical unit is 1 pixel.
3891 ================ =============================================
3894 return _gdi_
.DC_SetMapMode(*args
, **kwargs
)
3896 def GetUserScale(*args
, **kwargs
):
3898 GetUserScale(self) -> (xScale, yScale)
3900 Gets the current user scale factor (set by `SetUserScale`).
3902 return _gdi_
.DC_GetUserScale(*args
, **kwargs
)
3904 def SetUserScale(*args
, **kwargs
):
3906 SetUserScale(self, double x, double y)
3908 Sets the user scaling factor, useful for applications which require
3911 return _gdi_
.DC_SetUserScale(*args
, **kwargs
)
3913 def GetLogicalScale(*args
, **kwargs
):
3914 """GetLogicalScale() -> (xScale, yScale)"""
3915 return _gdi_
.DC_GetLogicalScale(*args
, **kwargs
)
3917 def SetLogicalScale(*args
, **kwargs
):
3918 """SetLogicalScale(self, double x, double y)"""
3919 return _gdi_
.DC_SetLogicalScale(*args
, **kwargs
)
3921 def GetLogicalOrigin(*args
, **kwargs
):
3922 """GetLogicalOrigin(self) -> Point"""
3923 return _gdi_
.DC_GetLogicalOrigin(*args
, **kwargs
)
3925 def GetLogicalOriginTuple(*args
, **kwargs
):
3926 """GetLogicalOriginTuple() -> (x,y)"""
3927 return _gdi_
.DC_GetLogicalOriginTuple(*args
, **kwargs
)
3929 def SetLogicalOrigin(*args
, **kwargs
):
3930 """SetLogicalOrigin(self, int x, int y)"""
3931 return _gdi_
.DC_SetLogicalOrigin(*args
, **kwargs
)
3933 def SetLogicalOriginPoint(*args
, **kwargs
):
3934 """SetLogicalOriginPoint(self, Point point)"""
3935 return _gdi_
.DC_SetLogicalOriginPoint(*args
, **kwargs
)
3937 def GetDeviceOrigin(*args
, **kwargs
):
3938 """GetDeviceOrigin(self) -> Point"""
3939 return _gdi_
.DC_GetDeviceOrigin(*args
, **kwargs
)
3941 def GetDeviceOriginTuple(*args
, **kwargs
):
3942 """GetDeviceOriginTuple() -> (x,y)"""
3943 return _gdi_
.DC_GetDeviceOriginTuple(*args
, **kwargs
)
3945 def SetDeviceOrigin(*args
, **kwargs
):
3946 """SetDeviceOrigin(self, int x, int y)"""
3947 return _gdi_
.DC_SetDeviceOrigin(*args
, **kwargs
)
3949 def SetDeviceOriginPoint(*args
, **kwargs
):
3950 """SetDeviceOriginPoint(self, Point point)"""
3951 return _gdi_
.DC_SetDeviceOriginPoint(*args
, **kwargs
)
3953 def SetAxisOrientation(*args
, **kwargs
):
3955 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
3957 Sets the x and y axis orientation (i.e., the direction from lowest to
3958 highest values on the axis). The default orientation is the natural
3959 orientation, e.g. x axis from left to right and y axis from bottom up.
3961 return _gdi_
.DC_SetAxisOrientation(*args
, **kwargs
)
3963 def GetLogicalFunction(*args
, **kwargs
):
3965 GetLogicalFunction(self) -> int
3967 Gets the current logical function (set by `SetLogicalFunction`).
3969 return _gdi_
.DC_GetLogicalFunction(*args
, **kwargs
)
3971 def SetLogicalFunction(*args
, **kwargs
):
3973 SetLogicalFunction(self, int function)
3975 Sets the current logical function for the device context. This
3976 determines how a source pixel (from a pen or brush colour, or source
3977 device context if using `Blit`) combines with a destination pixel in
3978 the current device context.
3980 The possible values and their meaning in terms of source and
3981 destination pixel values are as follows:
3983 ================ ==========================
3985 wx.AND_INVERT (NOT src) AND dst
3986 wx.AND_REVERSE src AND (NOT dst)
3989 wx.EQUIV (NOT src) XOR dst
3991 wx.NAND (NOT src) OR (NOT dst)
3992 wx.NOR (NOT src) AND (NOT dst)
3995 wx.OR_INVERT (NOT src) OR dst
3996 wx.OR_REVERSE src OR (NOT dst)
3998 wx.SRC_INVERT NOT src
4000 ================ ==========================
4002 The default is wx.COPY, which simply draws with the current
4003 colour. The others combine the current colour and the background using
4004 a logical operation. wx.INVERT is commonly used for drawing rubber
4005 bands or moving outlines, since drawing twice reverts to the original
4009 return _gdi_
.DC_SetLogicalFunction(*args
, **kwargs
)
4011 def ComputeScaleAndOrigin(*args
, **kwargs
):
4013 ComputeScaleAndOrigin(self)
4015 Performs all necessary computations for given platform and context
4016 type after each change of scale and origin parameters. Usually called
4017 automatically internally after such changes.
4020 return _gdi_
.DC_ComputeScaleAndOrigin(*args
, **kwargs
)
4022 def SetOptimization(self
, optimize
):
4024 def GetOptimization(self
):
4027 SetOptimization
= wx
._deprecated
(SetOptimization
)
4028 GetOptimization
= wx
._deprecated
(GetOptimization
)
4030 def CalcBoundingBox(*args
, **kwargs
):
4032 CalcBoundingBox(self, int x, int y)
4034 Adds the specified point to the bounding box which can be retrieved
4035 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4037 return _gdi_
.DC_CalcBoundingBox(*args
, **kwargs
)
4039 def CalcBoundingBoxPoint(*args
, **kwargs
):
4041 CalcBoundingBoxPoint(self, Point point)
4043 Adds the specified point to the bounding box which can be retrieved
4044 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4046 return _gdi_
.DC_CalcBoundingBoxPoint(*args
, **kwargs
)
4048 def ResetBoundingBox(*args
, **kwargs
):
4050 ResetBoundingBox(self)
4052 Resets the bounding box: after a call to this function, the bounding
4053 box doesn't contain anything.
4055 return _gdi_
.DC_ResetBoundingBox(*args
, **kwargs
)
4057 def MinX(*args
, **kwargs
):
4061 Gets the minimum horizontal extent used in drawing commands so far.
4063 return _gdi_
.DC_MinX(*args
, **kwargs
)
4065 def MaxX(*args
, **kwargs
):
4069 Gets the maximum horizontal extent used in drawing commands so far.
4071 return _gdi_
.DC_MaxX(*args
, **kwargs
)
4073 def MinY(*args
, **kwargs
):
4077 Gets the minimum vertical extent used in drawing commands so far.
4079 return _gdi_
.DC_MinY(*args
, **kwargs
)
4081 def MaxY(*args
, **kwargs
):
4085 Gets the maximum vertical extent used in drawing commands so far.
4087 return _gdi_
.DC_MaxY(*args
, **kwargs
)
4089 def GetBoundingBox(*args
, **kwargs
):
4091 GetBoundingBox() -> (x1,y1, x2,y2)
4093 Returns the min and max points used in drawing commands so far.
4095 return _gdi_
.DC_GetBoundingBox(*args
, **kwargs
)
4097 def __nonzero__(self
): return self
.Ok()
4098 def _DrawPointList(*args
, **kwargs
):
4099 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4100 return _gdi_
.DC__DrawPointList(*args
, **kwargs
)
4102 def _DrawLineList(*args
, **kwargs
):
4103 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4104 return _gdi_
.DC__DrawLineList(*args
, **kwargs
)
4106 def _DrawRectangleList(*args
, **kwargs
):
4107 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4108 return _gdi_
.DC__DrawRectangleList(*args
, **kwargs
)
4110 def _DrawEllipseList(*args
, **kwargs
):
4111 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4112 return _gdi_
.DC__DrawEllipseList(*args
, **kwargs
)
4114 def _DrawPolygonList(*args
, **kwargs
):
4115 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4116 return _gdi_
.DC__DrawPolygonList(*args
, **kwargs
)
4118 def _DrawTextList(*args
, **kwargs
):
4120 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
4121 PyObject backgroundList) -> PyObject
4123 return _gdi_
.DC__DrawTextList(*args
, **kwargs
)
4125 def DrawPointList(self
, points
, pens
=None):
4127 Draw a list of points as quickly as possible.
4129 :param points: A sequence of 2-element sequences representing
4130 each point to draw, (x,y).
4131 :param pens: If None, then the current pen is used. If a
4132 single pen then it will be used for all points. If
4133 a list of pens then there should be one for each point
4138 elif isinstance(pens
, wx
.Pen
):
4140 elif len(pens
) != len(points
):
4141 raise ValueError('points and pens must have same length')
4142 return self
._DrawPointList
(points
, pens
, [])
4145 def DrawLineList(self
, lines
, pens
=None):
4147 Draw a list of lines as quickly as possible.
4149 :param lines: A sequence of 4-element sequences representing
4150 each line to draw, (x1,y1, x2,y2).
4151 :param pens: If None, then the current pen is used. If a
4152 single pen then it will be used for all lines. If
4153 a list of pens then there should be one for each line
4158 elif isinstance(pens
, wx
.Pen
):
4160 elif len(pens
) != len(lines
):
4161 raise ValueError('lines and pens must have same length')
4162 return self
._DrawLineList
(lines
, pens
, [])
4165 def DrawRectangleList(self
, rectangles
, pens
=None, brushes
=None):
4167 Draw a list of rectangles as quickly as possible.
4169 :param rectangles: A sequence of 4-element sequences representing
4170 each rectangle to draw, (x,y, w,h).
4171 :param pens: If None, then the current pen is used. If a
4172 single pen then it will be used for all rectangles.
4173 If a list of pens then there should be one for each
4174 rectangle in rectangles.
4175 :param brushes: A brush or brushes to be used to fill the rectagles,
4176 with similar semantics as the pens parameter.
4180 elif isinstance(pens
, wx
.Pen
):
4182 elif len(pens
) != len(rectangles
):
4183 raise ValueError('rectangles and pens must have same length')
4186 elif isinstance(brushes
, wx
.Brush
):
4188 elif len(brushes
) != len(rectangles
):
4189 raise ValueError('rectangles and brushes must have same length')
4190 return self
._DrawRectangleList
(rectangles
, pens
, brushes
)
4193 def DrawEllipseList(self
, ellipses
, pens
=None, brushes
=None):
4195 Draw a list of ellipses as quickly as possible.
4197 :param ellipses: A sequence of 4-element sequences representing
4198 each ellipse to draw, (x,y, w,h).
4199 :param pens: If None, then the current pen is used. If a
4200 single pen then it will be used for all ellipses.
4201 If a list of pens then there should be one for each
4202 ellipse in ellipses.
4203 :param brushes: A brush or brushes to be used to fill the ellipses,
4204 with similar semantics as the pens parameter.
4208 elif isinstance(pens
, wx
.Pen
):
4210 elif len(pens
) != len(ellipses
):
4211 raise ValueError('ellipses and pens must have same length')
4214 elif isinstance(brushes
, wx
.Brush
):
4216 elif len(brushes
) != len(ellipses
):
4217 raise ValueError('ellipses and brushes must have same length')
4218 return self
._DrawEllipseList
(ellipses
, pens
, brushes
)
4221 def DrawPolygonList(self
, polygons
, pens
=None, brushes
=None):
4223 Draw a list of polygons, each of which is a list of points.
4225 :param polygons: A sequence of sequences of sequences.
4226 [[(x1,y1),(x2,y2),(x3,y3)...],
4227 [(x1,y1),(x2,y2),(x3,y3)...]]
4229 :param pens: If None, then the current pen is used. If a
4230 single pen then it will be used for all polygons.
4231 If a list of pens then there should be one for each
4233 :param brushes: A brush or brushes to be used to fill the polygons,
4234 with similar semantics as the pens parameter.
4238 elif isinstance(pens
, wx
.Pen
):
4240 elif len(pens
) != len(polygons
):
4241 raise ValueError('polygons and pens must have same length')
4244 elif isinstance(brushes
, wx
.Brush
):
4246 elif len(brushes
) != len(polygons
):
4247 raise ValueError('polygons and brushes must have same length')
4248 return self
._DrawPolygonList
(polygons
, pens
, brushes
)
4251 def DrawTextList(self
, textList
, coords
, foregrounds
= None, backgrounds
= None):
4253 Draw a list of strings using a list of coordinants for positioning each string.
4255 :param textList: A list of strings
4256 :param coords: A list of (x,y) positions
4257 :param foregrounds: A list of `wx.Colour` objects to use for the
4258 foregrounds of the strings.
4259 :param backgrounds: A list of `wx.Colour` objects to use for the
4260 backgrounds of the strings.
4262 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4263 If you want backgrounds to do anything.
4265 if type(textList
) == type(''):
4266 textList
= [textList
]
4267 elif len(textList
) != len(coords
):
4268 raise ValueError('textlist and coords must have same length')
4269 if foregrounds
is None:
4271 elif isinstance(foregrounds
, wx
.Colour
):
4272 foregrounds
= [foregrounds
]
4273 elif len(foregrounds
) != len(coords
):
4274 raise ValueError('foregrounds and coords must have same length')
4275 if backgrounds
is None:
4277 elif isinstance(backgrounds
, wx
.Colour
):
4278 backgrounds
= [backgrounds
]
4279 elif len(backgrounds
) != len(coords
):
4280 raise ValueError('backgrounds and coords must have same length')
4281 return self
._DrawTextList
(textList
, coords
, foregrounds
, backgrounds
)
4283 Background
= property(GetBackground
,SetBackground
,doc
="See `GetBackground` and `SetBackground`")
4284 BackgroundMode
= property(GetBackgroundMode
,SetBackgroundMode
,doc
="See `GetBackgroundMode` and `SetBackgroundMode`")
4285 BoundingBox
= property(GetBoundingBox
,doc
="See `GetBoundingBox`")
4286 Brush
= property(GetBrush
,SetBrush
,doc
="See `GetBrush` and `SetBrush`")
4287 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
4288 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
4289 ClippingBox
= property(GetClippingBox
,doc
="See `GetClippingBox`")
4290 ClippingRect
= property(GetClippingRect
,SetClippingRect
,doc
="See `GetClippingRect` and `SetClippingRect`")
4291 Depth
= property(GetDepth
,doc
="See `GetDepth`")
4292 DeviceOrigin
= property(GetDeviceOrigin
,SetDeviceOrigin
,doc
="See `GetDeviceOrigin` and `SetDeviceOrigin`")
4293 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
4294 FullTextExtent
= property(GetFullTextExtent
,doc
="See `GetFullTextExtent`")
4295 LogicalFunction
= property(GetLogicalFunction
,SetLogicalFunction
,doc
="See `GetLogicalFunction` and `SetLogicalFunction`")
4296 LogicalOrigin
= property(GetLogicalOrigin
,SetLogicalOrigin
,doc
="See `GetLogicalOrigin` and `SetLogicalOrigin`")
4297 LogicalScale
= property(GetLogicalScale
,SetLogicalScale
,doc
="See `GetLogicalScale` and `SetLogicalScale`")
4298 MapMode
= property(GetMapMode
,SetMapMode
,doc
="See `GetMapMode` and `SetMapMode`")
4299 MultiLineTextExtent
= property(GetMultiLineTextExtent
,doc
="See `GetMultiLineTextExtent`")
4300 Optimization
= property(GetOptimization
,SetOptimization
,doc
="See `GetOptimization` and `SetOptimization`")
4301 PPI
= property(GetPPI
,doc
="See `GetPPI`")
4302 PartialTextExtents
= property(GetPartialTextExtents
,doc
="See `GetPartialTextExtents`")
4303 Pen
= property(GetPen
,SetPen
,doc
="See `GetPen` and `SetPen`")
4304 Pixel
= property(GetPixel
,doc
="See `GetPixel`")
4305 PixelPoint
= property(GetPixelPoint
,doc
="See `GetPixelPoint`")
4306 Size
= property(GetSize
,doc
="See `GetSize`")
4307 SizeMM
= property(GetSizeMM
,doc
="See `GetSizeMM`")
4308 TextBackground
= property(GetTextBackground
,SetTextBackground
,doc
="See `GetTextBackground` and `SetTextBackground`")
4309 TextExtent
= property(GetTextExtent
,doc
="See `GetTextExtent`")
4310 TextForeground
= property(GetTextForeground
,SetTextForeground
,doc
="See `GetTextForeground` and `SetTextForeground`")
4311 UserScale
= property(GetUserScale
,SetUserScale
,doc
="See `GetUserScale` and `SetUserScale`")
4312 _gdi_
.DC_swigregister(DC
)
4314 #---------------------------------------------------------------------------
4318 A memory device context provides a means to draw graphics onto a
4319 bitmap. A bitmap must be selected into the new memory DC before it may
4320 be used for anything. Typical usage is as follows::
4323 dc.SelectObject(bitmap)
4324 # draw on the dc usign any of the Draw methods
4325 dc.SelectObject(wx.NullBitmap)
4326 # the bitmap now contains wahtever was drawn upon it
4328 Note that the memory DC *must* be deleted (or the bitmap selected out
4329 of it) before a bitmap can be reselected into another memory DC.
4332 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4333 __repr__
= _swig_repr
4334 def __init__(self
, *args
, **kwargs
):
4336 __init__(self) -> MemoryDC
4338 Constructs a new memory device context.
4340 Use the Ok member to test whether the constructor was successful in
4341 creating a usable device context. Don't forget to select a bitmap into
4342 the DC before drawing on it.
4344 _gdi_
.MemoryDC_swiginit(self
,_gdi_
.new_MemoryDC(*args
, **kwargs
))
4345 def SelectObject(*args
, **kwargs
):
4347 SelectObject(self, Bitmap bitmap)
4349 Selects the bitmap into the device context, to use as the memory
4350 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4351 the DC, and therefore the bitmap, and also to use Blit to copy the
4354 If the argument is wx.NullBitmap (or some other uninitialised
4355 `wx.Bitmap`) the current bitmap is selected out of the device context,
4356 and the original bitmap restored, allowing the current bitmap to be
4359 return _gdi_
.MemoryDC_SelectObject(*args
, **kwargs
)
4361 _gdi_
.MemoryDC_swigregister(MemoryDC
)
4363 def MemoryDCFromDC(*args
, **kwargs
):
4365 MemoryDCFromDC(DC oldDC) -> MemoryDC
4367 Creates a DC that is compatible with the oldDC.
4369 val
= _gdi_
.new_MemoryDCFromDC(*args
, **kwargs
)
4372 #---------------------------------------------------------------------------
4374 BUFFER_VIRTUAL_AREA
= _gdi_
.BUFFER_VIRTUAL_AREA
4375 BUFFER_CLIENT_AREA
= _gdi_
.BUFFER_CLIENT_AREA
4376 class BufferedDC(MemoryDC
):
4378 This simple class provides a simple way to avoid flicker: when drawing
4379 on it, everything is in fact first drawn on an in-memory buffer (a
4380 `wx.Bitmap`) and then copied to the screen only once, when this object
4383 It can be used in the same way as any other device
4384 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
4385 want to use it in your EVT_PAINT handler, you should look at
4386 `wx.BufferedPaintDC`.
4389 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4390 __repr__
= _swig_repr
4391 def __init__(self
, *args
):
4393 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4394 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4396 Constructs a buffered DC.
4398 _gdi_
.BufferedDC_swiginit(self
,_gdi_
.new_BufferedDC(*args
))
4399 self
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
4401 __swig_destroy__
= _gdi_
.delete_BufferedDC
4402 __del__
= lambda self
: None;
4403 def UnMask(*args
, **kwargs
):
4407 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4408 can be effectively used once only). This is usually only called in
4411 return _gdi_
.BufferedDC_UnMask(*args
, **kwargs
)
4413 _gdi_
.BufferedDC_swigregister(BufferedDC
)
4415 class BufferedPaintDC(BufferedDC
):
4417 This is a subclass of `wx.BufferedDC` which can be used inside of an
4418 EVT_PAINT event handler. Just create an object of this class instead
4419 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4420 flicker. The only thing to watch out for is that if you are using this
4421 class together with `wx.ScrolledWindow`, you probably do **not** want
4422 to call `wx.Window.PrepareDC` on it as it already does this internally
4423 for the real underlying `wx.PaintDC`.
4425 If your window is already fully buffered in a `wx.Bitmap` then your
4426 EVT_PAINT handler can be as simple as just creating a
4427 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4428 automatically when it is destroyed. For example::
4430 def OnPaint(self, event):
4431 dc = wx.BufferedPaintDC(self, self.buffer)
4438 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4439 __repr__
= _swig_repr
4440 def __init__(self
, *args
, **kwargs
):
4442 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
4444 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4445 provide the bitmap to be used for buffering or let this object create
4446 one internally (in the latter case, the size of the client part of the
4447 window is automatically used).
4451 _gdi_
.BufferedPaintDC_swiginit(self
,_gdi_
.new_BufferedPaintDC(*args
, **kwargs
))
4452 _gdi_
.BufferedPaintDC_swigregister(BufferedPaintDC
)
4454 #---------------------------------------------------------------------------
4458 A wxScreenDC can be used to paint anywhere on the screen. This should
4459 normally be constructed as a temporary stack object; don't store a
4463 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4464 __repr__
= _swig_repr
4465 def __init__(self
, *args
, **kwargs
):
4467 __init__(self) -> ScreenDC
4469 A wxScreenDC can be used to paint anywhere on the screen. This should
4470 normally be constructed as a temporary stack object; don't store a
4474 _gdi_
.ScreenDC_swiginit(self
,_gdi_
.new_ScreenDC(*args
, **kwargs
))
4475 def StartDrawingOnTopWin(*args
, **kwargs
):
4477 StartDrawingOnTopWin(self, Window window) -> bool
4479 Specify that the area of the screen to be drawn upon coincides with
4482 :see: `EndDrawingOnTop`
4484 return _gdi_
.ScreenDC_StartDrawingOnTopWin(*args
, **kwargs
)
4486 def StartDrawingOnTop(*args
, **kwargs
):
4488 StartDrawingOnTop(self, Rect rect=None) -> bool
4490 Specify that the area is the given rectangle, or the whole screen if
4493 :see: `EndDrawingOnTop`
4495 return _gdi_
.ScreenDC_StartDrawingOnTop(*args
, **kwargs
)
4497 def EndDrawingOnTop(*args
, **kwargs
):
4499 EndDrawingOnTop(self) -> bool
4501 Use this in conjunction with `StartDrawingOnTop` or
4502 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4503 top of existing windows. Without this, some window systems (such as X)
4504 only allow drawing to take place underneath other windows.
4506 You might use this pair of functions when implementing a drag feature,
4507 for example as in the `wx.SplitterWindow` implementation.
4509 These functions are probably obsolete since the X implementations
4510 allow drawing directly on the screen now. However, the fact that this
4511 function allows the screen to be refreshed afterwards may be useful
4512 to some applications.
4514 return _gdi_
.ScreenDC_EndDrawingOnTop(*args
, **kwargs
)
4516 _gdi_
.ScreenDC_swigregister(ScreenDC
)
4518 #---------------------------------------------------------------------------
4522 A wx.ClientDC must be constructed if an application wishes to paint on
4523 the client area of a window from outside an EVT_PAINT event. This should
4524 normally be constructed as a temporary stack object; don't store a
4525 wx.ClientDC object long term.
4527 To draw on a window from within an EVT_PAINT handler, construct a
4528 `wx.PaintDC` object.
4530 To draw on the whole window including decorations, construct a
4531 `wx.WindowDC` object (Windows only).
4534 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4535 __repr__
= _swig_repr
4536 def __init__(self
, *args
, **kwargs
):
4538 __init__(self, Window win) -> ClientDC
4540 Constructor. Pass the window on which you wish to paint.
4542 _gdi_
.ClientDC_swiginit(self
,_gdi_
.new_ClientDC(*args
, **kwargs
))
4543 _gdi_
.ClientDC_swigregister(ClientDC
)
4545 #---------------------------------------------------------------------------
4549 A wx.PaintDC must be constructed if an application wishes to paint on
4550 the client area of a window from within an EVT_PAINT event
4551 handler. This should normally be constructed as a temporary stack
4552 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4553 handler, you **must** create a wx.PaintDC object within it even if you
4554 don't actually use it.
4556 Using wx.PaintDC within EVT_PAINT handlers is important because it
4557 automatically sets the clipping area to the damaged area of the
4558 window. Attempts to draw outside this area do not appear.
4560 To draw on a window from outside EVT_PAINT handlers, construct a
4561 `wx.ClientDC` object.
4564 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4565 __repr__
= _swig_repr
4566 def __init__(self
, *args
, **kwargs
):
4568 __init__(self, Window win) -> PaintDC
4570 Constructor. Pass the window on which you wish to paint.
4572 _gdi_
.PaintDC_swiginit(self
,_gdi_
.new_PaintDC(*args
, **kwargs
))
4573 _gdi_
.PaintDC_swigregister(PaintDC
)
4575 #---------------------------------------------------------------------------
4579 A wx.WindowDC must be constructed if an application wishes to paint on
4580 the whole area of a window (client and decorations). This should
4581 normally be constructed as a temporary stack object; don't store a
4584 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4585 __repr__
= _swig_repr
4586 def __init__(self
, *args
, **kwargs
):
4588 __init__(self, Window win) -> WindowDC
4590 Constructor. Pass the window on which you wish to paint.
4592 _gdi_
.WindowDC_swiginit(self
,_gdi_
.new_WindowDC(*args
, **kwargs
))
4593 _gdi_
.WindowDC_swigregister(WindowDC
)
4595 #---------------------------------------------------------------------------
4599 wx.MirrorDC is a simple wrapper class which is always associated with a
4600 real `wx.DC` object and either forwards all of its operations to it
4601 without changes (no mirroring takes place) or exchanges x and y
4602 coordinates which makes it possible to reuse the same code to draw a
4603 figure and its mirror -- i.e. reflection related to the diagonal line
4606 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4607 __repr__
= _swig_repr
4608 def __init__(self
, *args
, **kwargs
):
4610 __init__(self, DC dc, bool mirror) -> MirrorDC
4612 Creates a mirrored DC associated with the real *dc*. Everything drawn
4613 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4616 _gdi_
.MirrorDC_swiginit(self
,_gdi_
.new_MirrorDC(*args
, **kwargs
))
4617 _gdi_
.MirrorDC_swigregister(MirrorDC
)
4619 #---------------------------------------------------------------------------
4621 class PostScriptDC(DC
):
4622 """This is a `wx.DC` that can write to PostScript files on any platform."""
4623 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4624 __repr__
= _swig_repr
4625 def __init__(self
, *args
, **kwargs
):
4627 __init__(self, wxPrintData printData) -> PostScriptDC
4629 Constructs a PostScript printer device context from a `wx.PrintData`
4632 _gdi_
.PostScriptDC_swiginit(self
,_gdi_
.new_PostScriptDC(*args
, **kwargs
))
4633 def GetPrintData(*args
, **kwargs
):
4634 """GetPrintData(self) -> wxPrintData"""
4635 return _gdi_
.PostScriptDC_GetPrintData(*args
, **kwargs
)
4637 def SetPrintData(*args
, **kwargs
):
4638 """SetPrintData(self, wxPrintData data)"""
4639 return _gdi_
.PostScriptDC_SetPrintData(*args
, **kwargs
)
4641 def SetResolution(*args
, **kwargs
):
4643 SetResolution(int ppi)
4645 Set resolution (in pixels per inch) that will be used in PostScript
4646 output. Default is 720ppi.
4648 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4650 SetResolution
= staticmethod(SetResolution
)
4651 def GetResolution(*args
, **kwargs
):
4653 GetResolution() -> int
4655 Return resolution used in PostScript output.
4657 return _gdi_
.PostScriptDC_GetResolution(*args
, **kwargs
)
4659 GetResolution
= staticmethod(GetResolution
)
4660 _gdi_
.PostScriptDC_swigregister(PostScriptDC
)
4662 def PostScriptDC_SetResolution(*args
, **kwargs
):
4664 PostScriptDC_SetResolution(int ppi)
4666 Set resolution (in pixels per inch) that will be used in PostScript
4667 output. Default is 720ppi.
4669 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4671 def PostScriptDC_GetResolution(*args
):
4673 PostScriptDC_GetResolution() -> int
4675 Return resolution used in PostScript output.
4677 return _gdi_
.PostScriptDC_GetResolution(*args
)
4679 #---------------------------------------------------------------------------
4681 class MetaFile(_core
.Object
):
4682 """Proxy of C++ MetaFile class"""
4683 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4684 __repr__
= _swig_repr
4685 def __init__(self
, *args
, **kwargs
):
4686 """__init__(self, String filename=EmptyString) -> MetaFile"""
4687 _gdi_
.MetaFile_swiginit(self
,_gdi_
.new_MetaFile(*args
, **kwargs
))
4688 __swig_destroy__
= _gdi_
.delete_MetaFile
4689 __del__
= lambda self
: None;
4690 def Ok(*args
, **kwargs
):
4691 """Ok(self) -> bool"""
4692 return _gdi_
.MetaFile_Ok(*args
, **kwargs
)
4694 def SetClipboard(*args
, **kwargs
):
4695 """SetClipboard(self, int width=0, int height=0) -> bool"""
4696 return _gdi_
.MetaFile_SetClipboard(*args
, **kwargs
)
4698 def GetSize(*args
, **kwargs
):
4699 """GetSize(self) -> Size"""
4700 return _gdi_
.MetaFile_GetSize(*args
, **kwargs
)
4702 def GetWidth(*args
, **kwargs
):
4703 """GetWidth(self) -> int"""
4704 return _gdi_
.MetaFile_GetWidth(*args
, **kwargs
)
4706 def GetHeight(*args
, **kwargs
):
4707 """GetHeight(self) -> int"""
4708 return _gdi_
.MetaFile_GetHeight(*args
, **kwargs
)
4710 def __nonzero__(self
): return self
.Ok()
4711 _gdi_
.MetaFile_swigregister(MetaFile
)
4713 class MetaFileDC(DC
):
4714 """Proxy of C++ MetaFileDC class"""
4715 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4716 __repr__
= _swig_repr
4717 def __init__(self
, *args
, **kwargs
):
4719 __init__(self, String filename=EmptyString, int width=0, int height=0,
4720 String description=EmptyString) -> MetaFileDC
4722 _gdi_
.MetaFileDC_swiginit(self
,_gdi_
.new_MetaFileDC(*args
, **kwargs
))
4723 def Close(*args
, **kwargs
):
4724 """Close(self) -> MetaFile"""
4725 return _gdi_
.MetaFileDC_Close(*args
, **kwargs
)
4727 _gdi_
.MetaFileDC_swigregister(MetaFileDC
)
4729 class PrinterDC(DC
):
4730 """Proxy of C++ PrinterDC class"""
4731 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4732 __repr__
= _swig_repr
4733 def __init__(self
, *args
, **kwargs
):
4734 """__init__(self, wxPrintData printData) -> PrinterDC"""
4735 _gdi_
.PrinterDC_swiginit(self
,_gdi_
.new_PrinterDC(*args
, **kwargs
))
4736 _gdi_
.PrinterDC_swigregister(PrinterDC
)
4738 #---------------------------------------------------------------------------
4740 IMAGELIST_DRAW_NORMAL
= _gdi_
.IMAGELIST_DRAW_NORMAL
4741 IMAGELIST_DRAW_TRANSPARENT
= _gdi_
.IMAGELIST_DRAW_TRANSPARENT
4742 IMAGELIST_DRAW_SELECTED
= _gdi_
.IMAGELIST_DRAW_SELECTED
4743 IMAGELIST_DRAW_FOCUSED
= _gdi_
.IMAGELIST_DRAW_FOCUSED
4744 IMAGE_LIST_NORMAL
= _gdi_
.IMAGE_LIST_NORMAL
4745 IMAGE_LIST_SMALL
= _gdi_
.IMAGE_LIST_SMALL
4746 IMAGE_LIST_STATE
= _gdi_
.IMAGE_LIST_STATE
4747 class ImageList(_core
.Object
):
4748 """Proxy of C++ ImageList class"""
4749 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4750 __repr__
= _swig_repr
4751 def __init__(self
, *args
, **kwargs
):
4752 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
4753 _gdi_
.ImageList_swiginit(self
,_gdi_
.new_ImageList(*args
, **kwargs
))
4754 __swig_destroy__
= _gdi_
.delete_ImageList
4755 __del__
= lambda self
: None;
4756 def Add(*args
, **kwargs
):
4757 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
4758 return _gdi_
.ImageList_Add(*args
, **kwargs
)
4760 def AddWithColourMask(*args
, **kwargs
):
4761 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
4762 return _gdi_
.ImageList_AddWithColourMask(*args
, **kwargs
)
4764 def AddIcon(*args
, **kwargs
):
4765 """AddIcon(self, Icon icon) -> int"""
4766 return _gdi_
.ImageList_AddIcon(*args
, **kwargs
)
4768 def GetBitmap(*args
, **kwargs
):
4769 """GetBitmap(self, int index) -> Bitmap"""
4770 return _gdi_
.ImageList_GetBitmap(*args
, **kwargs
)
4772 def GetIcon(*args
, **kwargs
):
4773 """GetIcon(self, int index) -> Icon"""
4774 return _gdi_
.ImageList_GetIcon(*args
, **kwargs
)
4776 def Replace(*args
, **kwargs
):
4777 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
4778 return _gdi_
.ImageList_Replace(*args
, **kwargs
)
4780 def Draw(*args
, **kwargs
):
4782 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
4783 bool solidBackground=False) -> bool
4785 return _gdi_
.ImageList_Draw(*args
, **kwargs
)
4787 def GetImageCount(*args
, **kwargs
):
4788 """GetImageCount(self) -> int"""
4789 return _gdi_
.ImageList_GetImageCount(*args
, **kwargs
)
4791 def Remove(*args
, **kwargs
):
4792 """Remove(self, int index) -> bool"""
4793 return _gdi_
.ImageList_Remove(*args
, **kwargs
)
4795 def RemoveAll(*args
, **kwargs
):
4796 """RemoveAll(self) -> bool"""
4797 return _gdi_
.ImageList_RemoveAll(*args
, **kwargs
)
4799 def GetSize(*args
, **kwargs
):
4800 """GetSize(index) -> (width,height)"""
4801 return _gdi_
.ImageList_GetSize(*args
, **kwargs
)
4803 ImageCount
= property(GetImageCount
,doc
="See `GetImageCount`")
4804 Size
= property(GetSize
,doc
="See `GetSize`")
4805 _gdi_
.ImageList_swigregister(ImageList
)
4807 #---------------------------------------------------------------------------
4809 class StockGDI(object):
4810 """Proxy of C++ StockGDI class"""
4811 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4812 __repr__
= _swig_repr
4813 BRUSH_BLACK
= _gdi_
.StockGDI_BRUSH_BLACK
4814 BRUSH_BLUE
= _gdi_
.StockGDI_BRUSH_BLUE
4815 BRUSH_CYAN
= _gdi_
.StockGDI_BRUSH_CYAN
4816 BRUSH_GREEN
= _gdi_
.StockGDI_BRUSH_GREEN
4817 BRUSH_GREY
= _gdi_
.StockGDI_BRUSH_GREY
4818 BRUSH_LIGHTGREY
= _gdi_
.StockGDI_BRUSH_LIGHTGREY
4819 BRUSH_MEDIUMGREY
= _gdi_
.StockGDI_BRUSH_MEDIUMGREY
4820 BRUSH_RED
= _gdi_
.StockGDI_BRUSH_RED
4821 BRUSH_TRANSPARENT
= _gdi_
.StockGDI_BRUSH_TRANSPARENT
4822 BRUSH_WHITE
= _gdi_
.StockGDI_BRUSH_WHITE
4823 COLOUR_BLACK
= _gdi_
.StockGDI_COLOUR_BLACK
4824 COLOUR_BLUE
= _gdi_
.StockGDI_COLOUR_BLUE
4825 COLOUR_CYAN
= _gdi_
.StockGDI_COLOUR_CYAN
4826 COLOUR_GREEN
= _gdi_
.StockGDI_COLOUR_GREEN
4827 COLOUR_LIGHTGREY
= _gdi_
.StockGDI_COLOUR_LIGHTGREY
4828 COLOUR_RED
= _gdi_
.StockGDI_COLOUR_RED
4829 COLOUR_WHITE
= _gdi_
.StockGDI_COLOUR_WHITE
4830 CURSOR_CROSS
= _gdi_
.StockGDI_CURSOR_CROSS
4831 CURSOR_HOURGLASS
= _gdi_
.StockGDI_CURSOR_HOURGLASS
4832 CURSOR_STANDARD
= _gdi_
.StockGDI_CURSOR_STANDARD
4833 FONT_ITALIC
= _gdi_
.StockGDI_FONT_ITALIC
4834 FONT_NORMAL
= _gdi_
.StockGDI_FONT_NORMAL
4835 FONT_SMALL
= _gdi_
.StockGDI_FONT_SMALL
4836 FONT_SWISS
= _gdi_
.StockGDI_FONT_SWISS
4837 PEN_BLACK
= _gdi_
.StockGDI_PEN_BLACK
4838 PEN_BLACKDASHED
= _gdi_
.StockGDI_PEN_BLACKDASHED
4839 PEN_CYAN
= _gdi_
.StockGDI_PEN_CYAN
4840 PEN_GREEN
= _gdi_
.StockGDI_PEN_GREEN
4841 PEN_GREY
= _gdi_
.StockGDI_PEN_GREY
4842 PEN_LIGHTGREY
= _gdi_
.StockGDI_PEN_LIGHTGREY
4843 PEN_MEDIUMGREY
= _gdi_
.StockGDI_PEN_MEDIUMGREY
4844 PEN_RED
= _gdi_
.StockGDI_PEN_RED
4845 PEN_TRANSPARENT
= _gdi_
.StockGDI_PEN_TRANSPARENT
4846 PEN_WHITE
= _gdi_
.StockGDI_PEN_WHITE
4847 ITEMCOUNT
= _gdi_
.StockGDI_ITEMCOUNT
4848 def __init__(self
, *args
, **kwargs
):
4849 """__init__(self) -> StockGDI"""
4850 _gdi_
.StockGDI_swiginit(self
,_gdi_
.new_StockGDI(*args
, **kwargs
))
4851 __swig_destroy__
= _gdi_
.delete_StockGDI
4852 __del__
= lambda self
: None;
4853 def DeleteAll(*args
, **kwargs
):
4855 return _gdi_
.StockGDI_DeleteAll(*args
, **kwargs
)
4857 DeleteAll
= staticmethod(DeleteAll
)
4858 def instance(*args
, **kwargs
):
4859 """instance() -> StockGDI"""
4860 return _gdi_
.StockGDI_instance(*args
, **kwargs
)
4862 instance
= staticmethod(instance
)
4863 def GetBrush(*args
, **kwargs
):
4864 """GetBrush(int item) -> Brush"""
4865 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
4867 GetBrush
= staticmethod(GetBrush
)
4868 def GetColour(*args
, **kwargs
):
4869 """GetColour(int item) -> Colour"""
4870 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
4872 GetColour
= staticmethod(GetColour
)
4873 def GetCursor(*args
, **kwargs
):
4874 """GetCursor(int item) -> Cursor"""
4875 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
4877 GetCursor
= staticmethod(GetCursor
)
4878 def GetPen(*args
, **kwargs
):
4879 """GetPen(int item) -> Pen"""
4880 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
4882 GetPen
= staticmethod(GetPen
)
4883 def GetFont(*args
, **kwargs
):
4884 """GetFont(self, int item) -> Font"""
4885 return _gdi_
.StockGDI_GetFont(*args
, **kwargs
)
4887 def _initStockObjects():
4889 wx
.ITALIC_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_ITALIC
).this
4890 wx
.NORMAL_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_NORMAL
).this
4891 wx
.SMALL_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_SMALL
).this
4892 wx
.SWISS_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_SWISS
).this
4894 wx
.BLACK_DASHED_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_BLACKDASHED
).this
4895 wx
.BLACK_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_BLACK
).this
4896 wx
.CYAN_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_CYAN
).this
4897 wx
.GREEN_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_GREEN
).this
4898 wx
.GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_GREY
).this
4899 wx
.LIGHT_GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_LIGHTGREY
).this
4900 wx
.MEDIUM_GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_MEDIUMGREY
).this
4901 wx
.RED_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_RED
).this
4902 wx
.TRANSPARENT_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_TRANSPARENT
).this
4903 wx
.WHITE_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_WHITE
).this
4905 wx
.BLACK_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLACK
).this
4906 wx
.BLUE_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLUE
).this
4907 wx
.CYAN_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_CYAN
).this
4908 wx
.GREEN_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREEN
).this
4909 wx
.GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREY
).this
4910 wx
.LIGHT_GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_LIGHTGREY
).this
4911 wx
.MEDIUM_GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_MEDIUMGREY
).this
4912 wx
.RED_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_RED
).this
4913 wx
.TRANSPARENT_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_TRANSPARENT
).this
4914 wx
.WHITE_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_WHITE
).this
4916 wx
.BLACK
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_BLACK
).this
4917 wx
.BLUE
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_BLUE
).this
4918 wx
.CYAN
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_CYAN
).this
4919 wx
.GREEN
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_GREEN
).this
4920 wx
.LIGHT_GREY
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_LIGHTGREY
).this
4921 wx
.RED
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_RED
).this
4922 wx
.WHITE
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_WHITE
).this
4924 wx
.CROSS_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_CROSS
).this
4925 wx
.HOURGLASS_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_HOURGLASS
).this
4926 wx
.STANDARD_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_STANDARD
).this
4928 wx
.TheFontList
.this
= _wxPyInitTheFontList().this
4929 wx
.ThePenList
.this
= _wxPyInitThePenList().this
4930 wx
.TheBrushList
.this
= _wxPyInitTheBrushList().this
4931 wx
.TheColourDatabase
.this
= _wxPyInitTheColourDatabase().this
4934 _initStockObjects
= staticmethod(_initStockObjects
)
4936 _gdi_
.StockGDI_swigregister(StockGDI
)
4938 def StockGDI_DeleteAll(*args
):
4939 """StockGDI_DeleteAll()"""
4940 return _gdi_
.StockGDI_DeleteAll(*args
)
4942 def StockGDI_instance(*args
):
4943 """StockGDI_instance() -> StockGDI"""
4944 return _gdi_
.StockGDI_instance(*args
)
4946 def StockGDI_GetBrush(*args
, **kwargs
):
4947 """StockGDI_GetBrush(int item) -> Brush"""
4948 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
4950 def StockGDI_GetColour(*args
, **kwargs
):
4951 """StockGDI_GetColour(int item) -> Colour"""
4952 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
4954 def StockGDI_GetCursor(*args
, **kwargs
):
4955 """StockGDI_GetCursor(int item) -> Cursor"""
4956 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
4958 def StockGDI_GetPen(*args
, **kwargs
):
4959 """StockGDI_GetPen(int item) -> Pen"""
4960 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
4962 # Create an uninitialized instance for the stock objects, they will
4963 # be initialized later when the wx.App object is created.
4964 ITALIC_FONT
= Font
.__new
__(Font
)
4965 NORMAL_FONT
= Font
.__new
__(Font
)
4966 SMALL_FONT
= Font
.__new
__(Font
)
4967 SWISS_FONT
= Font
.__new
__(Font
)
4969 BLACK_DASHED_PEN
= Pen
.__new
__(Pen
)
4970 BLACK_PEN
= Pen
.__new
__(Pen
)
4971 CYAN_PEN
= Pen
.__new
__(Pen
)
4972 GREEN_PEN
= Pen
.__new
__(Pen
)
4973 GREY_PEN
= Pen
.__new
__(Pen
)
4974 LIGHT_GREY_PEN
= Pen
.__new
__(Pen
)
4975 MEDIUM_GREY_PEN
= Pen
.__new
__(Pen
)
4976 RED_PEN
= Pen
.__new
__(Pen
)
4977 TRANSPARENT_PEN
= Pen
.__new
__(Pen
)
4978 WHITE_PEN
= Pen
.__new
__(Pen
)
4980 BLACK_BRUSH
= Brush
.__new
__(Brush
)
4981 BLUE_BRUSH
= Brush
.__new
__(Brush
)
4982 CYAN_BRUSH
= Brush
.__new
__(Brush
)
4983 GREEN_BRUSH
= Brush
.__new
__(Brush
)
4984 GREY_BRUSH
= Brush
.__new
__(Brush
)
4985 LIGHT_GREY_BRUSH
= Brush
.__new
__(Brush
)
4986 MEDIUM_GREY_BRUSH
= Brush
.__new
__(Brush
)
4987 RED_BRUSH
= Brush
.__new
__(Brush
)
4988 TRANSPARENT_BRUSH
= Brush
.__new
__(Brush
)
4989 WHITE_BRUSH
= Brush
.__new
__(Brush
)
4991 BLACK
= Colour
.__new
__(Colour
)
4992 BLUE
= Colour
.__new
__(Colour
)
4993 CYAN
= Colour
.__new
__(Colour
)
4994 GREEN
= Colour
.__new
__(Colour
)
4995 LIGHT_GREY
= Colour
.__new
__(Colour
)
4996 RED
= Colour
.__new
__(Colour
)
4997 WHITE
= Colour
.__new
__(Colour
)
4999 CROSS_CURSOR
= Cursor
.__new
__(Cursor
)
5000 HOURGLASS_CURSOR
= Cursor
.__new
__(Cursor
)
5001 STANDARD_CURSOR
= Cursor
.__new
__(Cursor
)
5003 class GDIObjListBase(object):
5004 """Proxy of C++ GDIObjListBase class"""
5005 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5006 __repr__
= _swig_repr
5007 def __init__(self
, *args
, **kwargs
):
5008 """__init__(self) -> GDIObjListBase"""
5009 _gdi_
.GDIObjListBase_swiginit(self
,_gdi_
.new_GDIObjListBase(*args
, **kwargs
))
5010 __swig_destroy__
= _gdi_
.delete_GDIObjListBase
5011 __del__
= lambda self
: None;
5012 _gdi_
.GDIObjListBase_swigregister(GDIObjListBase
)
5014 NullBitmap
= cvar
.NullBitmap
5015 NullIcon
= cvar
.NullIcon
5016 NullCursor
= cvar
.NullCursor
5017 NullPen
= cvar
.NullPen
5018 NullBrush
= cvar
.NullBrush
5019 NullPalette
= cvar
.NullPalette
5020 NullFont
= cvar
.NullFont
5021 NullColour
= cvar
.NullColour
5023 class PenList(GDIObjListBase
):
5024 """Proxy of C++ PenList class"""
5025 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5026 def __init__(self
): raise AttributeError, "No constructor defined"
5027 __repr__
= _swig_repr
5028 def FindOrCreatePen(*args
, **kwargs
):
5029 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
5030 return _gdi_
.PenList_FindOrCreatePen(*args
, **kwargs
)
5032 def AddPen(*args
, **kwargs
):
5033 """AddPen(self, Pen pen)"""
5034 return _gdi_
.PenList_AddPen(*args
, **kwargs
)
5036 def RemovePen(*args
, **kwargs
):
5037 """RemovePen(self, Pen pen)"""
5038 return _gdi_
.PenList_RemovePen(*args
, **kwargs
)
5040 AddPen
= wx
._deprecated
(AddPen
)
5041 RemovePen
= wx
._deprecated
(RemovePen
)
5043 _gdi_
.PenList_swigregister(PenList
)
5045 class BrushList(GDIObjListBase
):
5046 """Proxy of C++ BrushList class"""
5047 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5048 def __init__(self
): raise AttributeError, "No constructor defined"
5049 __repr__
= _swig_repr
5050 def FindOrCreateBrush(*args
, **kwargs
):
5051 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
5052 return _gdi_
.BrushList_FindOrCreateBrush(*args
, **kwargs
)
5054 def AddBrush(*args
, **kwargs
):
5055 """AddBrush(self, Brush brush)"""
5056 return _gdi_
.BrushList_AddBrush(*args
, **kwargs
)
5058 def RemoveBrush(*args
, **kwargs
):
5059 """RemoveBrush(self, Brush brush)"""
5060 return _gdi_
.BrushList_RemoveBrush(*args
, **kwargs
)
5062 AddBrush
= wx
._deprecated
(AddBrush
)
5063 RemoveBrush
= wx
._deprecated
(RemoveBrush
)
5065 _gdi_
.BrushList_swigregister(BrushList
)
5067 class FontList(GDIObjListBase
):
5068 """Proxy of C++ FontList class"""
5069 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5070 def __init__(self
): raise AttributeError, "No constructor defined"
5071 __repr__
= _swig_repr
5072 def FindOrCreateFont(*args
, **kwargs
):
5074 FindOrCreateFont(self, int point_size, int family, int style, int weight,
5075 bool underline=False, String facename=EmptyString,
5076 int encoding=FONTENCODING_DEFAULT) -> Font
5078 return _gdi_
.FontList_FindOrCreateFont(*args
, **kwargs
)
5080 def AddFont(*args
, **kwargs
):
5081 """AddFont(self, Font font)"""
5082 return _gdi_
.FontList_AddFont(*args
, **kwargs
)
5084 def RemoveFont(*args
, **kwargs
):
5085 """RemoveFont(self, Font font)"""
5086 return _gdi_
.FontList_RemoveFont(*args
, **kwargs
)
5088 AddFont
= wx
._deprecated
(AddFont
)
5089 RemoveFont
= wx
._deprecated
(RemoveFont
)
5091 _gdi_
.FontList_swigregister(FontList
)
5093 class ColourDatabase(object):
5094 """Proxy of C++ ColourDatabase class"""
5095 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5096 __repr__
= _swig_repr
5097 def __init__(self
, *args
, **kwargs
):
5098 """__init__(self) -> ColourDatabase"""
5099 _gdi_
.ColourDatabase_swiginit(self
,_gdi_
.new_ColourDatabase(*args
, **kwargs
))
5100 __swig_destroy__
= _gdi_
.delete_ColourDatabase
5101 __del__
= lambda self
: None;
5102 def Find(*args
, **kwargs
):
5103 """Find(self, String name) -> Colour"""
5104 return _gdi_
.ColourDatabase_Find(*args
, **kwargs
)
5106 def FindName(*args
, **kwargs
):
5107 """FindName(self, Colour colour) -> String"""
5108 return _gdi_
.ColourDatabase_FindName(*args
, **kwargs
)
5111 def AddColour(*args
, **kwargs
):
5112 """AddColour(self, String name, Colour colour)"""
5113 return _gdi_
.ColourDatabase_AddColour(*args
, **kwargs
)
5115 def Append(*args
, **kwargs
):
5116 """Append(self, String name, int red, int green, int blue)"""
5117 return _gdi_
.ColourDatabase_Append(*args
, **kwargs
)
5119 _gdi_
.ColourDatabase_swigregister(ColourDatabase
)
5121 #---------------------------------------------------------------------------
5124 def _wxPyInitTheFontList(*args
):
5125 """_wxPyInitTheFontList() -> FontList"""
5126 return _gdi_
._wxPyInitTheFontList
(*args
)
5128 def _wxPyInitThePenList(*args
):
5129 """_wxPyInitThePenList() -> PenList"""
5130 return _gdi_
._wxPyInitThePenList
(*args
)
5132 def _wxPyInitTheBrushList(*args
):
5133 """_wxPyInitTheBrushList() -> BrushList"""
5134 return _gdi_
._wxPyInitTheBrushList
(*args
)
5136 def _wxPyInitTheColourDatabase(*args
):
5137 """_wxPyInitTheColourDatabase() -> ColourDatabase"""
5138 return _gdi_
._wxPyInitTheColourDatabase
(*args
)
5139 # Create an uninitialized instance for the stock objects, they will
5140 # be initialized later when the wx.App object is created.
5141 TheFontList
= FontList
.__new
__(FontList
)
5142 ThePenList
= PenList
.__new
__(PenList
)
5143 TheBrushList
= BrushList
.__new
__(BrushList
)
5144 TheColourDatabase
= ColourDatabase
.__new
__(ColourDatabase
)
5146 NullColor
= NullColour
5147 #---------------------------------------------------------------------------
5149 class Effects(_core
.Object
):
5150 """Proxy of C++ Effects class"""
5151 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5152 __repr__
= _swig_repr
5153 def __init__(self
, *args
, **kwargs
):
5154 """__init__(self) -> Effects"""
5155 _gdi_
.Effects_swiginit(self
,_gdi_
.new_Effects(*args
, **kwargs
))
5156 def GetHighlightColour(*args
, **kwargs
):
5157 """GetHighlightColour(self) -> Colour"""
5158 return _gdi_
.Effects_GetHighlightColour(*args
, **kwargs
)
5160 def GetLightShadow(*args
, **kwargs
):
5161 """GetLightShadow(self) -> Colour"""
5162 return _gdi_
.Effects_GetLightShadow(*args
, **kwargs
)
5164 def GetFaceColour(*args
, **kwargs
):
5165 """GetFaceColour(self) -> Colour"""
5166 return _gdi_
.Effects_GetFaceColour(*args
, **kwargs
)
5168 def GetMediumShadow(*args
, **kwargs
):
5169 """GetMediumShadow(self) -> Colour"""
5170 return _gdi_
.Effects_GetMediumShadow(*args
, **kwargs
)
5172 def GetDarkShadow(*args
, **kwargs
):
5173 """GetDarkShadow(self) -> Colour"""
5174 return _gdi_
.Effects_GetDarkShadow(*args
, **kwargs
)
5176 def SetHighlightColour(*args
, **kwargs
):
5177 """SetHighlightColour(self, Colour c)"""
5178 return _gdi_
.Effects_SetHighlightColour(*args
, **kwargs
)
5180 def SetLightShadow(*args
, **kwargs
):
5181 """SetLightShadow(self, Colour c)"""
5182 return _gdi_
.Effects_SetLightShadow(*args
, **kwargs
)
5184 def SetFaceColour(*args
, **kwargs
):
5185 """SetFaceColour(self, Colour c)"""
5186 return _gdi_
.Effects_SetFaceColour(*args
, **kwargs
)
5188 def SetMediumShadow(*args
, **kwargs
):
5189 """SetMediumShadow(self, Colour c)"""
5190 return _gdi_
.Effects_SetMediumShadow(*args
, **kwargs
)
5192 def SetDarkShadow(*args
, **kwargs
):
5193 """SetDarkShadow(self, Colour c)"""
5194 return _gdi_
.Effects_SetDarkShadow(*args
, **kwargs
)
5196 def Set(*args
, **kwargs
):
5198 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
5199 Colour mediumShadow, Colour darkShadow)
5201 return _gdi_
.Effects_Set(*args
, **kwargs
)
5203 def DrawSunkenEdge(*args
, **kwargs
):
5204 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
5205 return _gdi_
.Effects_DrawSunkenEdge(*args
, **kwargs
)
5207 def TileBitmap(*args
, **kwargs
):
5208 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
5209 return _gdi_
.Effects_TileBitmap(*args
, **kwargs
)
5211 DarkShadow
= property(GetDarkShadow
,SetDarkShadow
,doc
="See `GetDarkShadow` and `SetDarkShadow`")
5212 FaceColour
= property(GetFaceColour
,SetFaceColour
,doc
="See `GetFaceColour` and `SetFaceColour`")
5213 HighlightColour
= property(GetHighlightColour
,SetHighlightColour
,doc
="See `GetHighlightColour` and `SetHighlightColour`")
5214 LightShadow
= property(GetLightShadow
,SetLightShadow
,doc
="See `GetLightShadow` and `SetLightShadow`")
5215 MediumShadow
= property(GetMediumShadow
,SetMediumShadow
,doc
="See `GetMediumShadow` and `SetMediumShadow`")
5216 _gdi_
.Effects_swigregister(Effects
)
5218 #---------------------------------------------------------------------------
5220 CONTROL_DISABLED
= _gdi_
.CONTROL_DISABLED
5221 CONTROL_FOCUSED
= _gdi_
.CONTROL_FOCUSED
5222 CONTROL_PRESSED
= _gdi_
.CONTROL_PRESSED
5223 CONTROL_ISDEFAULT
= _gdi_
.CONTROL_ISDEFAULT
5224 CONTROL_ISSUBMENU
= _gdi_
.CONTROL_ISSUBMENU
5225 CONTROL_EXPANDED
= _gdi_
.CONTROL_EXPANDED
5226 CONTROL_CURRENT
= _gdi_
.CONTROL_CURRENT
5227 CONTROL_SELECTED
= _gdi_
.CONTROL_SELECTED
5228 CONTROL_CHECKED
= _gdi_
.CONTROL_CHECKED
5229 CONTROL_CHECKABLE
= _gdi_
.CONTROL_CHECKABLE
5230 CONTROL_UNDETERMINED
= _gdi_
.CONTROL_UNDETERMINED
5231 CONTROL_FLAGS_MASK
= _gdi_
.CONTROL_FLAGS_MASK
5232 CONTROL_DIRTY
= _gdi_
.CONTROL_DIRTY
5233 class SplitterRenderParams(object):
5235 This is just a simple struct used as a return value of
5236 `wx.RendererNative.GetSplitterParams` and contains some platform
5237 specific metrics about splitters.
5239 * widthSash: the width of the splitter sash.
5240 * border: the width of the border of the splitter window.
5241 * isHotSensitive: ``True`` if the splitter changes its
5242 appearance when the mouse is over it.
5246 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5247 __repr__
= _swig_repr
5248 def __init__(self
, *args
, **kwargs
):
5250 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5252 This is just a simple struct used as a return value of
5253 `wx.RendererNative.GetSplitterParams` and contains some platform
5254 specific metrics about splitters.
5256 * widthSash: the width of the splitter sash.
5257 * border: the width of the border of the splitter window.
5258 * isHotSensitive: ``True`` if the splitter changes its
5259 appearance when the mouse is over it.
5263 _gdi_
.SplitterRenderParams_swiginit(self
,_gdi_
.new_SplitterRenderParams(*args
, **kwargs
))
5264 __swig_destroy__
= _gdi_
.delete_SplitterRenderParams
5265 __del__
= lambda self
: None;
5266 widthSash
= property(_gdi_
.SplitterRenderParams_widthSash_get
)
5267 border
= property(_gdi_
.SplitterRenderParams_border_get
)
5268 isHotSensitive
= property(_gdi_
.SplitterRenderParams_isHotSensitive_get
)
5269 _gdi_
.SplitterRenderParams_swigregister(SplitterRenderParams
)
5271 class RendererVersion(object):
5273 This simple struct represents the `wx.RendererNative` interface
5274 version and is only used as the return value of
5275 `wx.RendererNative.GetVersion`.
5277 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5278 __repr__
= _swig_repr
5279 def __init__(self
, *args
, **kwargs
):
5281 __init__(self, int version_, int age_) -> RendererVersion
5283 This simple struct represents the `wx.RendererNative` interface
5284 version and is only used as the return value of
5285 `wx.RendererNative.GetVersion`.
5287 _gdi_
.RendererVersion_swiginit(self
,_gdi_
.new_RendererVersion(*args
, **kwargs
))
5288 __swig_destroy__
= _gdi_
.delete_RendererVersion
5289 __del__
= lambda self
: None;
5290 Current_Version
= _gdi_
.RendererVersion_Current_Version
5291 Current_Age
= _gdi_
.RendererVersion_Current_Age
5292 def IsCompatible(*args
, **kwargs
):
5293 """IsCompatible(RendererVersion ver) -> bool"""
5294 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
5296 IsCompatible
= staticmethod(IsCompatible
)
5297 version
= property(_gdi_
.RendererVersion_version_get
)
5298 age
= property(_gdi_
.RendererVersion_age_get
)
5299 _gdi_
.RendererVersion_swigregister(RendererVersion
)
5301 def RendererVersion_IsCompatible(*args
, **kwargs
):
5302 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5303 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
5305 class RendererNative(object):
5307 One of the design principles of wxWidgets is to use the native widgets
5308 on every platform in order to be as close to the native look and feel
5309 on every platform. However there are still cases when some generic
5310 widgets are needed for various reasons, but it can sometimes take a
5311 lot of messy work to make them conform to the native LnF.
5313 The wx.RendererNative class is a collection of functions that have
5314 platform-specific implementations for drawing certain parts of
5315 genereic controls in ways that are as close to the native look as
5318 Note that each drawing function restores the `wx.DC` attributes if it
5319 changes them, so it is safe to assume that the same pen, brush and
5320 colours that were active before the call to this function are still in
5324 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5325 def __init__(self
): raise AttributeError, "No constructor defined"
5326 __repr__
= _swig_repr
5327 def DrawHeaderButton(*args
, **kwargs
):
5329 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0)
5331 Draw the header control button (such as what is used by `wx.ListCtrl`
5334 return _gdi_
.RendererNative_DrawHeaderButton(*args
, **kwargs
)
5336 def DrawTreeItemButton(*args
, **kwargs
):
5338 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5340 Draw the expanded/collapsed icon for a tree control item.
5342 return _gdi_
.RendererNative_DrawTreeItemButton(*args
, **kwargs
)
5344 def DrawSplitterBorder(*args
, **kwargs
):
5346 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5348 Draw the border for a sash window: this border must be such that the
5349 sash drawn by `DrawSplitterSash` blends into it well.
5351 return _gdi_
.RendererNative_DrawSplitterBorder(*args
, **kwargs
)
5353 def DrawSplitterSash(*args
, **kwargs
):
5355 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5358 Draw a sash. The orient parameter defines whether the sash should be
5359 vertical or horizontal and how the position should be interpreted.
5361 return _gdi_
.RendererNative_DrawSplitterSash(*args
, **kwargs
)
5363 def DrawComboBoxDropButton(*args
, **kwargs
):
5365 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5367 Draw a button like the one used by `wx.ComboBox` to show a drop down
5368 window. The usual appearance is a downwards pointing arrow.
5370 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5371 ``wx.CONTROL_CURRENT`` bits set.
5373 return _gdi_
.RendererNative_DrawComboBoxDropButton(*args
, **kwargs
)
5375 def DrawDropArrow(*args
, **kwargs
):
5377 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5379 Draw a drop down arrow that is suitable for use outside a combo
5380 box. Arrow will have a transparent background.
5382 ``rect`` is not entirely filled by the arrow. Instead, you should use
5383 bounding rectangle of a drop down button which arrow matches the size
5384 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5385 ``wx.CONTROL_CURRENT`` bit set.
5387 return _gdi_
.RendererNative_DrawDropArrow(*args
, **kwargs
)
5389 def DrawCheckBox(*args
, **kwargs
):
5391 DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0)
5393 Draw a check button. Flags may use wx.CONTROL_CHECKED,
5394 wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.
5396 return _gdi_
.RendererNative_DrawCheckBox(*args
, **kwargs
)
5398 def DrawPushButton(*args
, **kwargs
):
5400 DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0)
5402 Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
5403 wx.CONTROL_ISDEFAULT
5405 return _gdi_
.RendererNative_DrawPushButton(*args
, **kwargs
)
5407 def DrawItemSelectionRect(*args
, **kwargs
):
5409 DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0)
5411 Draw rectangle indicating that an item in e.g. a list control has been
5414 The flags parameter may be:
5416 ==================== ============================================
5417 wx.CONTROL_SELECTED item is selected, e.g. draw background
5418 wx.CONTROL_CURRENT item is the current item, e.g. dotted border
5419 wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
5420 background vs. grey otherwise
5421 ==================== ============================================
5424 return _gdi_
.RendererNative_DrawItemSelectionRect(*args
, **kwargs
)
5426 def GetSplitterParams(*args
, **kwargs
):
5428 GetSplitterParams(self, Window win) -> SplitterRenderParams
5430 Get the splitter parameters, see `wx.SplitterRenderParams`.
5432 return _gdi_
.RendererNative_GetSplitterParams(*args
, **kwargs
)
5434 def Get(*args
, **kwargs
):
5436 Get() -> RendererNative
5438 Return the currently used renderer
5440 return _gdi_
.RendererNative_Get(*args
, **kwargs
)
5442 Get
= staticmethod(Get
)
5443 def GetGeneric(*args
, **kwargs
):
5445 GetGeneric() -> RendererNative
5447 Return the generic implementation of the renderer. Under some
5448 platforms, this is the default renderer implementation, others have
5449 platform-specific default renderer which can be retrieved by calling
5450 `wx.RendererNative.GetDefault`.
5452 return _gdi_
.RendererNative_GetGeneric(*args
, **kwargs
)
5454 GetGeneric
= staticmethod(GetGeneric
)
5455 def GetDefault(*args
, **kwargs
):
5457 GetDefault() -> RendererNative
5459 Return the default (native) implementation for this platform -- this
5460 is also the one used by default but this may be changed by calling
5461 `wx.RendererNative.Set` in which case the return value of this method
5462 may be different from the return value of `wx.RendererNative.Get`.
5464 return _gdi_
.RendererNative_GetDefault(*args
, **kwargs
)
5466 GetDefault
= staticmethod(GetDefault
)
5467 def Set(*args
, **kwargs
):
5469 Set(RendererNative renderer) -> RendererNative
5471 Set the renderer to use, passing None reverts to using the default
5472 renderer. Returns the previous renderer used with Set or None.
5474 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
5476 Set
= staticmethod(Set
)
5477 def GetVersion(*args
, **kwargs
):
5479 GetVersion(self) -> RendererVersion
5481 Returns the version of the renderer. Will be used for ensuring
5482 compatibility of dynamically loaded renderers.
5484 return _gdi_
.RendererNative_GetVersion(*args
, **kwargs
)
5486 _gdi_
.RendererNative_swigregister(RendererNative
)
5488 def RendererNative_Get(*args
):
5490 RendererNative_Get() -> RendererNative
5492 Return the currently used renderer
5494 return _gdi_
.RendererNative_Get(*args
)
5496 def RendererNative_GetGeneric(*args
):
5498 RendererNative_GetGeneric() -> RendererNative
5500 Return the generic implementation of the renderer. Under some
5501 platforms, this is the default renderer implementation, others have
5502 platform-specific default renderer which can be retrieved by calling
5503 `wx.RendererNative.GetDefault`.
5505 return _gdi_
.RendererNative_GetGeneric(*args
)
5507 def RendererNative_GetDefault(*args
):
5509 RendererNative_GetDefault() -> RendererNative
5511 Return the default (native) implementation for this platform -- this
5512 is also the one used by default but this may be changed by calling
5513 `wx.RendererNative.Set` in which case the return value of this method
5514 may be different from the return value of `wx.RendererNative.Get`.
5516 return _gdi_
.RendererNative_GetDefault(*args
)
5518 def RendererNative_Set(*args
, **kwargs
):
5520 RendererNative_Set(RendererNative renderer) -> RendererNative
5522 Set the renderer to use, passing None reverts to using the default
5523 renderer. Returns the previous renderer used with Set or None.
5525 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
5527 #---------------------------------------------------------------------------
5529 class PseudoDC(_core
.Object
):
5531 A PseudoDC is an object that can be used as if it were a `wx.DC`. All
5532 commands issued to the PseudoDC are stored in a list. You can then
5533 play these commands back to a real DC object using the DrawToDC
5534 method. Commands in the command list are indexed by ID. You can use
5535 this to clear the operations associated with a single ID and then
5536 re-draw the object associated with that ID.
5538 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5539 __repr__
= _swig_repr
5540 def __init__(self
, *args
, **kwargs
):
5542 __init__(self) -> PseudoDC
5544 Constructs a new Pseudo device context for recording dc operations
5546 _gdi_
.PseudoDC_swiginit(self
,_gdi_
.new_PseudoDC(*args
, **kwargs
))
5547 def BeginDrawing(*args
, **kwargs
):
5551 Allows for optimization of drawing code on platforms that need it. On
5552 other platforms this is just an empty function and is harmless. To
5553 take advantage of this postential optimization simply enclose each
5554 group of calls to the drawing primitives within calls to
5555 `BeginDrawing` and `EndDrawing`.
5557 return _gdi_
.PseudoDC_BeginDrawing(*args
, **kwargs
)
5559 def EndDrawing(*args
, **kwargs
):
5563 Ends the group of drawing primitives started with `BeginDrawing`, and
5564 invokes whatever optimization is available for this DC type on the
5567 return _gdi_
.PseudoDC_EndDrawing(*args
, **kwargs
)
5569 __swig_destroy__
= _gdi_
.delete_PseudoDC
5570 __del__
= lambda self
: None;
5571 def RemoveAll(*args
, **kwargs
):
5575 Removes all objects and operations from the recorded list.
5577 return _gdi_
.PseudoDC_RemoveAll(*args
, **kwargs
)
5579 def GetLen(*args
, **kwargs
):
5583 Returns the number of operations in the recorded list.
5585 return _gdi_
.PseudoDC_GetLen(*args
, **kwargs
)
5587 def SetId(*args
, **kwargs
):
5591 Sets the id to be associated with subsequent operations.
5593 return _gdi_
.PseudoDC_SetId(*args
, **kwargs
)
5595 def ClearId(*args
, **kwargs
):
5597 ClearId(self, int id)
5599 Removes all operations associated with id so the object can be redrawn.
5601 return _gdi_
.PseudoDC_ClearId(*args
, **kwargs
)
5603 def RemoveId(*args
, **kwargs
):
5605 RemoveId(self, int id)
5607 Remove the object node (and all operations) associated with an id.
5609 return _gdi_
.PseudoDC_RemoveId(*args
, **kwargs
)
5611 def TranslateId(*args
, **kwargs
):
5613 TranslateId(self, int id, int dx, int dy)
5615 Translate the operations of id by dx,dy.
5617 return _gdi_
.PseudoDC_TranslateId(*args
, **kwargs
)
5619 def DrawIdToDC(*args
, **kwargs
):
5621 DrawIdToDC(self, int id, DC dc)
5623 Draw recorded operations of id to dc.
5625 return _gdi_
.PseudoDC_DrawIdToDC(*args
, **kwargs
)
5627 def SetIdBounds(*args
, **kwargs
):
5629 SetIdBounds(self, int id, Rect rect)
5631 Set the bounding rect of a given object. This will create
5632 an object node if one doesn't exist.
5634 return _gdi_
.PseudoDC_SetIdBounds(*args
, **kwargs
)
5636 def GetIdBounds(*args
, **kwargs
):
5638 GetIdBounds(self, int id) -> Rect
5640 Returns the bounding rectangle previouly set with SetIdBounds. If
5641 no bounds have been set, it returns wx.Rect(0,0,0,0).
5643 return _gdi_
.PseudoDC_GetIdBounds(*args
, **kwargs
)
5645 def DrawToDCClipped(*args
, **kwargs
):
5647 DrawToDCClipped(self, DC dc, Rect rect)
5649 Draws the recorded operations to dc unless the operation is known to
5652 return _gdi_
.PseudoDC_DrawToDCClipped(*args
, **kwargs
)
5654 def DrawToDCClippedRgn(*args
, **kwargs
):
5656 DrawToDCClippedRgn(self, DC dc, Region region)
5658 Draws the recorded operations to dc unless the operation is known to
5661 return _gdi_
.PseudoDC_DrawToDCClippedRgn(*args
, **kwargs
)
5663 def DrawToDC(*args
, **kwargs
):
5665 DrawToDC(self, DC dc)
5667 Draws the recorded operations to dc.
5669 return _gdi_
.PseudoDC_DrawToDC(*args
, **kwargs
)
5671 def FloodFill(*args
, **kwargs
):
5673 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE)
5675 Flood fills the device context starting from the given point, using
5676 the current brush colour, and using a style:
5678 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5679 the given colour is encountered.
5681 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5684 Returns False if the operation failed.
5686 Note: The present implementation for non-Windows platforms may fail to
5687 find colour borders if the pixels do not match the colour
5688 exactly. However the function will still return true.
5690 return _gdi_
.PseudoDC_FloodFill(*args
, **kwargs
)
5692 def FloodFillPoint(*args
, **kwargs
):
5694 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE)
5696 Flood fills the device context starting from the given point, using
5697 the current brush colour, and using a style:
5699 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5700 the given colour is encountered.
5702 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5705 Returns False if the operation failed.
5707 Note: The present implementation for non-Windows platforms may fail to
5708 find colour borders if the pixels do not match the colour
5709 exactly. However the function will still return true.
5711 return _gdi_
.PseudoDC_FloodFillPoint(*args
, **kwargs
)
5713 def DrawLine(*args
, **kwargs
):
5715 DrawLine(self, int x1, int y1, int x2, int y2)
5717 Draws a line from the first point to the second. The current pen is
5718 used for drawing the line. Note that the second point is *not* part of
5719 the line and is not drawn by this function (this is consistent with
5720 the behaviour of many other toolkits).
5722 return _gdi_
.PseudoDC_DrawLine(*args
, **kwargs
)
5724 def DrawLinePoint(*args
, **kwargs
):
5726 DrawLinePoint(self, Point pt1, Point pt2)
5728 Draws a line from the first point to the second. The current pen is
5729 used for drawing the line. Note that the second point is *not* part of
5730 the line and is not drawn by this function (this is consistent with
5731 the behaviour of many other toolkits).
5733 return _gdi_
.PseudoDC_DrawLinePoint(*args
, **kwargs
)
5735 def CrossHair(*args
, **kwargs
):
5737 CrossHair(self, int x, int y)
5739 Displays a cross hair using the current pen. This is a vertical and
5740 horizontal line the height and width of the window, centred on the
5743 return _gdi_
.PseudoDC_CrossHair(*args
, **kwargs
)
5745 def CrossHairPoint(*args
, **kwargs
):
5747 CrossHairPoint(self, Point pt)
5749 Displays a cross hair using the current pen. This is a vertical and
5750 horizontal line the height and width of the window, centred on the
5753 return _gdi_
.PseudoDC_CrossHairPoint(*args
, **kwargs
)
5755 def DrawArc(*args
, **kwargs
):
5757 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
5759 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5760 the first point to the second. The current pen is used for the outline
5761 and the current brush for filling the shape.
5763 The arc is drawn in an anticlockwise direction from the start point to
5766 return _gdi_
.PseudoDC_DrawArc(*args
, **kwargs
)
5768 def DrawArcPoint(*args
, **kwargs
):
5770 DrawArcPoint(self, Point pt1, Point pt2, Point center)
5772 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5773 the first point to the second. The current pen is used for the outline
5774 and the current brush for filling the shape.
5776 The arc is drawn in an anticlockwise direction from the start point to
5779 return _gdi_
.PseudoDC_DrawArcPoint(*args
, **kwargs
)
5781 def DrawCheckMark(*args
, **kwargs
):
5783 DrawCheckMark(self, int x, int y, int width, int height)
5785 Draws a check mark inside the given rectangle.
5787 return _gdi_
.PseudoDC_DrawCheckMark(*args
, **kwargs
)
5789 def DrawCheckMarkRect(*args
, **kwargs
):
5791 DrawCheckMarkRect(self, Rect rect)
5793 Draws a check mark inside the given rectangle.
5795 return _gdi_
.PseudoDC_DrawCheckMarkRect(*args
, **kwargs
)
5797 def DrawEllipticArc(*args
, **kwargs
):
5799 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
5801 Draws an arc of an ellipse, with the given rectangle defining the
5802 bounds of the ellipse. The current pen is used for drawing the arc and
5803 the current brush is used for drawing the pie.
5805 The *start* and *end* parameters specify the start and end of the arc
5806 relative to the three-o'clock position from the center of the
5807 rectangle. Angles are specified in degrees (360 is a complete
5808 circle). Positive values mean counter-clockwise motion. If start is
5809 equal to end, a complete ellipse will be drawn.
5811 return _gdi_
.PseudoDC_DrawEllipticArc(*args
, **kwargs
)
5813 def DrawEllipticArcPointSize(*args
, **kwargs
):
5815 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
5817 Draws an arc of an ellipse, with the given rectangle defining the
5818 bounds of the ellipse. The current pen is used for drawing the arc and
5819 the current brush is used for drawing the pie.
5821 The *start* and *end* parameters specify the start and end of the arc
5822 relative to the three-o'clock position from the center of the
5823 rectangle. Angles are specified in degrees (360 is a complete
5824 circle). Positive values mean counter-clockwise motion. If start is
5825 equal to end, a complete ellipse will be drawn.
5827 return _gdi_
.PseudoDC_DrawEllipticArcPointSize(*args
, **kwargs
)
5829 def DrawPoint(*args
, **kwargs
):
5831 DrawPoint(self, int x, int y)
5833 Draws a point using the current pen.
5835 return _gdi_
.PseudoDC_DrawPoint(*args
, **kwargs
)
5837 def DrawPointPoint(*args
, **kwargs
):
5839 DrawPointPoint(self, Point pt)
5841 Draws a point using the current pen.
5843 return _gdi_
.PseudoDC_DrawPointPoint(*args
, **kwargs
)
5845 def DrawRectangle(*args
, **kwargs
):
5847 DrawRectangle(self, int x, int y, int width, int height)
5849 Draws a rectangle with the given top left corner, and with the given
5850 size. The current pen is used for the outline and the current brush
5851 for filling the shape.
5853 return _gdi_
.PseudoDC_DrawRectangle(*args
, **kwargs
)
5855 def DrawRectangleRect(*args
, **kwargs
):
5857 DrawRectangleRect(self, Rect rect)
5859 Draws a rectangle with the given top left corner, and with the given
5860 size. The current pen is used for the outline and the current brush
5861 for filling the shape.
5863 return _gdi_
.PseudoDC_DrawRectangleRect(*args
, **kwargs
)
5865 def DrawRectanglePointSize(*args
, **kwargs
):
5867 DrawRectanglePointSize(self, Point pt, Size sz)
5869 Draws a rectangle with the given top left corner, and with the given
5870 size. The current pen is used for the outline and the current brush
5871 for filling the shape.
5873 return _gdi_
.PseudoDC_DrawRectanglePointSize(*args
, **kwargs
)
5875 def DrawRoundedRectangle(*args
, **kwargs
):
5877 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
5879 Draws a rectangle with the given top left corner, and with the given
5880 size. The corners are quarter-circles using the given radius. The
5881 current pen is used for the outline and the current brush for filling
5884 If radius is positive, the value is assumed to be the radius of the
5885 rounded corner. If radius is negative, the absolute value is assumed
5886 to be the proportion of the smallest dimension of the rectangle. This
5887 means that the corner can be a sensible size relative to the size of
5888 the rectangle, and also avoids the strange effects X produces when the
5889 corners are too big for the rectangle.
5891 return _gdi_
.PseudoDC_DrawRoundedRectangle(*args
, **kwargs
)
5893 def DrawRoundedRectangleRect(*args
, **kwargs
):
5895 DrawRoundedRectangleRect(self, Rect r, double radius)
5897 Draws a rectangle with the given top left corner, and with the given
5898 size. The corners are quarter-circles using the given radius. The
5899 current pen is used for the outline and the current brush for filling
5902 If radius is positive, the value is assumed to be the radius of the
5903 rounded corner. If radius is negative, the absolute value is assumed
5904 to be the proportion of the smallest dimension of the rectangle. This
5905 means that the corner can be a sensible size relative to the size of
5906 the rectangle, and also avoids the strange effects X produces when the
5907 corners are too big for the rectangle.
5909 return _gdi_
.PseudoDC_DrawRoundedRectangleRect(*args
, **kwargs
)
5911 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
5913 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
5915 Draws a rectangle with the given top left corner, and with the given
5916 size. The corners are quarter-circles using the given radius. The
5917 current pen is used for the outline and the current brush for filling
5920 If radius is positive, the value is assumed to be the radius of the
5921 rounded corner. If radius is negative, the absolute value is assumed
5922 to be the proportion of the smallest dimension of the rectangle. This
5923 means that the corner can be a sensible size relative to the size of
5924 the rectangle, and also avoids the strange effects X produces when the
5925 corners are too big for the rectangle.
5927 return _gdi_
.PseudoDC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
5929 def DrawCircle(*args
, **kwargs
):
5931 DrawCircle(self, int x, int y, int radius)
5933 Draws a circle with the given center point and radius. The current
5934 pen is used for the outline and the current brush for filling the
5937 return _gdi_
.PseudoDC_DrawCircle(*args
, **kwargs
)
5939 def DrawCirclePoint(*args
, **kwargs
):
5941 DrawCirclePoint(self, Point pt, int radius)
5943 Draws a circle with the given center point and radius. The current
5944 pen is used for the outline and the current brush for filling the
5947 return _gdi_
.PseudoDC_DrawCirclePoint(*args
, **kwargs
)
5949 def DrawEllipse(*args
, **kwargs
):
5951 DrawEllipse(self, int x, int y, int width, int height)
5953 Draws an ellipse contained in the specified rectangle. The current pen
5954 is used for the outline and the current brush for filling the shape.
5956 return _gdi_
.PseudoDC_DrawEllipse(*args
, **kwargs
)
5958 def DrawEllipseRect(*args
, **kwargs
):
5960 DrawEllipseRect(self, Rect rect)
5962 Draws an ellipse contained in the specified rectangle. The current pen
5963 is used for the outline and the current brush for filling the shape.
5965 return _gdi_
.PseudoDC_DrawEllipseRect(*args
, **kwargs
)
5967 def DrawEllipsePointSize(*args
, **kwargs
):
5969 DrawEllipsePointSize(self, Point pt, Size sz)
5971 Draws an ellipse contained in the specified rectangle. The current pen
5972 is used for the outline and the current brush for filling the shape.
5974 return _gdi_
.PseudoDC_DrawEllipsePointSize(*args
, **kwargs
)
5976 def DrawIcon(*args
, **kwargs
):
5978 DrawIcon(self, Icon icon, int x, int y)
5980 Draw an icon on the display (does nothing if the device context is
5981 PostScript). This can be the simplest way of drawing bitmaps on a
5984 return _gdi_
.PseudoDC_DrawIcon(*args
, **kwargs
)
5986 def DrawIconPoint(*args
, **kwargs
):
5988 DrawIconPoint(self, Icon icon, Point pt)
5990 Draw an icon on the display (does nothing if the device context is
5991 PostScript). This can be the simplest way of drawing bitmaps on a
5994 return _gdi_
.PseudoDC_DrawIconPoint(*args
, **kwargs
)
5996 def DrawBitmap(*args
, **kwargs
):
5998 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
6000 Draw a bitmap on the device context at the specified point. If
6001 *transparent* is true and the bitmap has a transparency mask, (or
6002 alpha channel on the platforms that support it) then the bitmap will
6003 be drawn transparently.
6005 return _gdi_
.PseudoDC_DrawBitmap(*args
, **kwargs
)
6007 def DrawBitmapPoint(*args
, **kwargs
):
6009 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
6011 Draw a bitmap on the device context at the specified point. If
6012 *transparent* is true and the bitmap has a transparency mask, (or
6013 alpha channel on the platforms that support it) then the bitmap will
6014 be drawn transparently.
6016 return _gdi_
.PseudoDC_DrawBitmapPoint(*args
, **kwargs
)
6018 def DrawText(*args
, **kwargs
):
6020 DrawText(self, String text, int x, int y)
6022 Draws a text string at the specified point, using the current text
6023 font, and the current text foreground and background colours.
6025 The coordinates refer to the top-left corner of the rectangle bounding
6026 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6027 a text string, which can be used to position the text more precisely,
6028 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6031 **NOTE**: under wxGTK the current logical function is used by this
6032 function but it is ignored by wxMSW. Thus, you should avoid using
6033 logical functions with this function in portable programs.
6035 return _gdi_
.PseudoDC_DrawText(*args
, **kwargs
)
6037 def DrawTextPoint(*args
, **kwargs
):
6039 DrawTextPoint(self, String text, Point pt)
6041 Draws a text string at the specified point, using the current text
6042 font, and the current text foreground and background colours.
6044 The coordinates refer to the top-left corner of the rectangle bounding
6045 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6046 a text string, which can be used to position the text more precisely,
6047 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6050 **NOTE**: under wxGTK the current logical function is used by this
6051 function but it is ignored by wxMSW. Thus, you should avoid using
6052 logical functions with this function in portable programs.
6054 return _gdi_
.PseudoDC_DrawTextPoint(*args
, **kwargs
)
6056 def DrawRotatedText(*args
, **kwargs
):
6058 DrawRotatedText(self, String text, int x, int y, double angle)
6060 Draws the text rotated by *angle* degrees, if supported by the platform.
6062 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6063 function. In particular, a font different from ``wx.NORMAL_FONT``
6064 should be used as the it is not normally a TrueType
6065 font. ``wx.SWISS_FONT`` is an example of a font which is.
6067 return _gdi_
.PseudoDC_DrawRotatedText(*args
, **kwargs
)
6069 def DrawRotatedTextPoint(*args
, **kwargs
):
6071 DrawRotatedTextPoint(self, String text, Point pt, double angle)
6073 Draws the text rotated by *angle* degrees, if supported by the platform.
6075 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6076 function. In particular, a font different from ``wx.NORMAL_FONT``
6077 should be used as the it is not normally a TrueType
6078 font. ``wx.SWISS_FONT`` is an example of a font which is.
6080 return _gdi_
.PseudoDC_DrawRotatedTextPoint(*args
, **kwargs
)
6082 def DrawLines(*args
, **kwargs
):
6084 DrawLines(self, List points, int xoffset=0, int yoffset=0)
6086 Draws lines using a sequence of `wx.Point` objects, adding the
6087 optional offset coordinate. The current pen is used for drawing the
6090 return _gdi_
.PseudoDC_DrawLines(*args
, **kwargs
)
6092 def DrawPolygon(*args
, **kwargs
):
6094 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
6095 int fillStyle=ODDEVEN_RULE)
6097 Draws a filled polygon using a sequence of `wx.Point` objects, adding
6098 the optional offset coordinate. The last argument specifies the fill
6099 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
6101 The current pen is used for drawing the outline, and the current brush
6102 for filling the shape. Using a transparent brush suppresses
6103 filling. Note that wxWidgets automatically closes the first and last
6106 return _gdi_
.PseudoDC_DrawPolygon(*args
, **kwargs
)
6108 def DrawLabel(*args
, **kwargs
):
6110 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6113 Draw *text* within the specified rectangle, abiding by the alignment
6114 flags. Will additionally emphasize the character at *indexAccel* if
6117 return _gdi_
.PseudoDC_DrawLabel(*args
, **kwargs
)
6119 def DrawImageLabel(*args
, **kwargs
):
6121 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6124 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
6125 drawing it) within the specified rectangle, abiding by the alignment
6126 flags. Will additionally emphasize the character at *indexAccel* if
6129 return _gdi_
.PseudoDC_DrawImageLabel(*args
, **kwargs
)
6131 def DrawSpline(*args
, **kwargs
):
6133 DrawSpline(self, List points)
6135 Draws a spline between all given control points, (a list of `wx.Point`
6136 objects) using the current pen. The spline is drawn using a series of
6137 lines, using an algorithm taken from the X drawing program 'XFIG'.
6139 return _gdi_
.PseudoDC_DrawSpline(*args
, **kwargs
)
6141 def Clear(*args
, **kwargs
):
6145 Clears the device context using the current background brush.
6147 return _gdi_
.PseudoDC_Clear(*args
, **kwargs
)
6149 def SetFont(*args
, **kwargs
):
6151 SetFont(self, Font font)
6153 Sets the current font for the DC. It must be a valid font, in
6154 particular you should not pass ``wx.NullFont`` to this method.
6156 return _gdi_
.PseudoDC_SetFont(*args
, **kwargs
)
6158 def SetPen(*args
, **kwargs
):
6160 SetPen(self, Pen pen)
6162 Sets the current pen for the DC.
6164 If the argument is ``wx.NullPen``, the current pen is selected out of the
6165 device context, and the original pen restored.
6167 return _gdi_
.PseudoDC_SetPen(*args
, **kwargs
)
6169 def SetBrush(*args
, **kwargs
):
6171 SetBrush(self, Brush brush)
6173 Sets the current brush for the DC.
6175 If the argument is ``wx.NullBrush``, the current brush is selected out
6176 of the device context, and the original brush restored, allowing the
6177 current brush to be destroyed safely.
6179 return _gdi_
.PseudoDC_SetBrush(*args
, **kwargs
)
6181 def SetBackground(*args
, **kwargs
):
6183 SetBackground(self, Brush brush)
6185 Sets the current background brush for the DC.
6187 return _gdi_
.PseudoDC_SetBackground(*args
, **kwargs
)
6189 def SetBackgroundMode(*args
, **kwargs
):
6191 SetBackgroundMode(self, int mode)
6193 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
6194 determines whether text will be drawn with a background colour or
6197 return _gdi_
.PseudoDC_SetBackgroundMode(*args
, **kwargs
)
6199 def SetPalette(*args
, **kwargs
):
6201 SetPalette(self, Palette palette)
6203 If this is a window DC or memory DC, assigns the given palette to the
6204 window or bitmap associated with the DC. If the argument is
6205 ``wx.NullPalette``, the current palette is selected out of the device
6206 context, and the original palette restored.
6208 return _gdi_
.PseudoDC_SetPalette(*args
, **kwargs
)
6210 def SetTextForeground(*args
, **kwargs
):
6212 SetTextForeground(self, Colour colour)
6214 Sets the current text foreground colour for the DC.
6216 return _gdi_
.PseudoDC_SetTextForeground(*args
, **kwargs
)
6218 def SetTextBackground(*args
, **kwargs
):
6220 SetTextBackground(self, Colour colour)
6222 Sets the current text background colour for the DC.
6224 return _gdi_
.PseudoDC_SetTextBackground(*args
, **kwargs
)
6226 def SetLogicalFunction(*args
, **kwargs
):
6228 SetLogicalFunction(self, int function)
6230 Sets the current logical function for the device context. This
6231 determines how a source pixel (from a pen or brush colour, combines
6232 with a destination pixel in the current device context.
6234 The possible values and their meaning in terms of source and
6235 destination pixel values are as follows:
6237 ================ ==========================
6239 wx.AND_INVERT (NOT src) AND dst
6240 wx.AND_REVERSE src AND (NOT dst)
6243 wx.EQUIV (NOT src) XOR dst
6245 wx.NAND (NOT src) OR (NOT dst)
6246 wx.NOR (NOT src) AND (NOT dst)
6249 wx.OR_INVERT (NOT src) OR dst
6250 wx.OR_REVERSE src OR (NOT dst)
6252 wx.SRC_INVERT NOT src
6254 ================ ==========================
6256 The default is wx.COPY, which simply draws with the current
6257 colour. The others combine the current colour and the background using
6258 a logical operation. wx.INVERT is commonly used for drawing rubber
6259 bands or moving outlines, since drawing twice reverts to the original
6263 return _gdi_
.PseudoDC_SetLogicalFunction(*args
, **kwargs
)
6265 _gdi_
.PseudoDC_swigregister(PseudoDC
)