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 GetDashCount(*args
, **kwargs
):
375 """GetDashCount(self) -> int"""
376 return _gdi_
.Pen_GetDashCount(*args
, **kwargs
)
378 def GetStipple(*args
, **kwargs
):
379 """GetStipple(self) -> Bitmap"""
380 return _gdi_
.Pen_GetStipple(*args
, **kwargs
)
382 def SetStipple(*args
, **kwargs
):
383 """SetStipple(self, Bitmap stipple)"""
384 return _gdi_
.Pen_SetStipple(*args
, **kwargs
)
386 def __eq__(*args
, **kwargs
):
387 """__eq__(self, Pen other) -> bool"""
388 return _gdi_
.Pen___eq__(*args
, **kwargs
)
390 def __ne__(*args
, **kwargs
):
391 """__ne__(self, Pen other) -> bool"""
392 return _gdi_
.Pen___ne__(*args
, **kwargs
)
394 def __nonzero__(self
): return self
.Ok()
395 _gdi_
.Pen_swigregister(Pen
)
397 #---------------------------------------------------------------------------
399 class Brush(GDIObject
):
401 A brush is a drawing tool for filling in areas. It is used for
402 painting the background of rectangles, ellipses, etc. when drawing on
403 a `wx.DC`. It has a colour and a style.
405 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
406 __repr__
= _swig_repr
407 def __init__(self
, *args
, **kwargs
):
409 __init__(self, Colour colour, int style=SOLID) -> Brush
411 Constructs a brush from a `wx.Colour` object and a style.
413 _gdi_
.Brush_swiginit(self
,_gdi_
.new_Brush(*args
, **kwargs
))
414 __swig_destroy__
= _gdi_
.delete_Brush
415 __del__
= lambda self
: None;
416 def SetColour(*args
, **kwargs
):
418 SetColour(self, Colour col)
420 Set the brush's `wx.Colour`.
422 return _gdi_
.Brush_SetColour(*args
, **kwargs
)
424 def SetStyle(*args
, **kwargs
):
426 SetStyle(self, int style)
428 Sets the style of the brush. See `__init__` for a listing of styles.
430 return _gdi_
.Brush_SetStyle(*args
, **kwargs
)
432 def SetStipple(*args
, **kwargs
):
434 SetStipple(self, Bitmap stipple)
436 Sets the stipple `wx.Bitmap`.
438 return _gdi_
.Brush_SetStipple(*args
, **kwargs
)
440 def GetColour(*args
, **kwargs
):
442 GetColour(self) -> Colour
444 Returns the `wx.Colour` of the brush.
446 return _gdi_
.Brush_GetColour(*args
, **kwargs
)
448 def GetStyle(*args
, **kwargs
):
450 GetStyle(self) -> int
452 Returns the style of the brush. See `__init__` for a listing of
455 return _gdi_
.Brush_GetStyle(*args
, **kwargs
)
457 def GetStipple(*args
, **kwargs
):
459 GetStipple(self) -> Bitmap
461 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
462 have a wx.STIPPLE style, then the return value may be non-None but an
463 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
465 return _gdi_
.Brush_GetStipple(*args
, **kwargs
)
467 def IsHatch(*args
, **kwargs
):
469 IsHatch(self) -> bool
471 Is the current style a hatch type?
473 return _gdi_
.Brush_IsHatch(*args
, **kwargs
)
475 def Ok(*args
, **kwargs
):
479 Returns True if the brush is initialised and valid.
481 return _gdi_
.Brush_Ok(*args
, **kwargs
)
483 def __nonzero__(self
): return self
.Ok()
484 Colour
= property(GetColour
,SetColour
,doc
="See `GetColour` and `SetColour`")
485 Stipple
= property(GetStipple
,SetStipple
,doc
="See `GetStipple` and `SetStipple`")
486 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
487 _gdi_
.Brush_swigregister(Brush
)
489 def BrushFromBitmap(*args
, **kwargs
):
491 BrushFromBitmap(Bitmap stippleBitmap) -> Brush
493 Constructs a stippled brush using a bitmap.
495 val
= _gdi_
.new_BrushFromBitmap(*args
, **kwargs
)
498 class Bitmap(GDIObject
):
500 The wx.Bitmap class encapsulates the concept of a platform-dependent
501 bitmap. It can be either monochrome or colour, and either loaded from
502 a file or created dynamically. A bitmap can be selected into a memory
503 device context (instance of `wx.MemoryDC`). This enables the bitmap to
504 be copied to a window or memory device context using `wx.DC.Blit`, or
505 to be used as a drawing surface.
507 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
508 __repr__
= _swig_repr
509 def __init__(self
, *args
, **kwargs
):
511 __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap
513 Loads a bitmap from a file.
515 _gdi_
.Bitmap_swiginit(self
,_gdi_
.new_Bitmap(*args
, **kwargs
))
516 __swig_destroy__
= _gdi_
.delete_Bitmap
517 __del__
= lambda self
: None;
518 def GetHandle(*args
, **kwargs
):
519 """GetHandle(self) -> long"""
520 return _gdi_
.Bitmap_GetHandle(*args
, **kwargs
)
522 def SetHandle(*args
, **kwargs
):
523 """SetHandle(self, long handle)"""
524 return _gdi_
.Bitmap_SetHandle(*args
, **kwargs
)
526 def Ok(*args
, **kwargs
):
527 """Ok(self) -> bool"""
528 return _gdi_
.Bitmap_Ok(*args
, **kwargs
)
530 def GetWidth(*args
, **kwargs
):
532 GetWidth(self) -> int
534 Gets the width of the bitmap in pixels.
536 return _gdi_
.Bitmap_GetWidth(*args
, **kwargs
)
538 def GetHeight(*args
, **kwargs
):
540 GetHeight(self) -> int
542 Gets the height of the bitmap in pixels.
544 return _gdi_
.Bitmap_GetHeight(*args
, **kwargs
)
546 def GetDepth(*args
, **kwargs
):
548 GetDepth(self) -> int
550 Gets the colour depth of the bitmap. A value of 1 indicates a
553 return _gdi_
.Bitmap_GetDepth(*args
, **kwargs
)
555 def GetSize(*args
, **kwargs
):
557 GetSize(self) -> Size
559 Get the size of the bitmap.
561 return _gdi_
.Bitmap_GetSize(*args
, **kwargs
)
563 def ConvertToImage(*args
, **kwargs
):
565 ConvertToImage(self) -> Image
567 Creates a platform-independent image from a platform-dependent
568 bitmap. This preserves mask information so that bitmaps and images can
569 be converted back and forth without loss in that respect.
571 return _gdi_
.Bitmap_ConvertToImage(*args
, **kwargs
)
573 def GetMask(*args
, **kwargs
):
575 GetMask(self) -> Mask
577 Gets the associated mask (if any) which may have been loaded from a
578 file or explpicitly set for the bitmap.
580 :see: `SetMask`, `wx.Mask`
583 return _gdi_
.Bitmap_GetMask(*args
, **kwargs
)
585 def SetMask(*args
, **kwargs
):
587 SetMask(self, Mask mask)
589 Sets the mask for this bitmap.
591 :see: `GetMask`, `wx.Mask`
594 return _gdi_
.Bitmap_SetMask(*args
, **kwargs
)
596 def SetMaskColour(*args
, **kwargs
):
598 SetMaskColour(self, Colour colour)
600 Create a Mask based on a specified colour in the Bitmap.
602 return _gdi_
.Bitmap_SetMaskColour(*args
, **kwargs
)
604 def GetSubBitmap(*args
, **kwargs
):
606 GetSubBitmap(self, Rect rect) -> Bitmap
608 Returns a sub-bitmap of the current one as long as the rect belongs
609 entirely to the bitmap. This function preserves bit depth and mask
612 return _gdi_
.Bitmap_GetSubBitmap(*args
, **kwargs
)
614 def SaveFile(*args
, **kwargs
):
616 SaveFile(self, String name, int type, Palette palette=None) -> bool
618 Saves a bitmap in the named file. See `__init__` for a description of
619 the ``type`` parameter.
621 return _gdi_
.Bitmap_SaveFile(*args
, **kwargs
)
623 def LoadFile(*args
, **kwargs
):
625 LoadFile(self, String name, int type) -> bool
627 Loads a bitmap from a file. See `__init__` for a description of the
630 return _gdi_
.Bitmap_LoadFile(*args
, **kwargs
)
632 def GetPalette(*args
, **kwargs
):
633 """GetPalette(self) -> Palette"""
634 return _gdi_
.Bitmap_GetPalette(*args
, **kwargs
)
636 def SetPalette(*args
, **kwargs
):
637 """SetPalette(self, Palette palette)"""
638 return _gdi_
.Bitmap_SetPalette(*args
, **kwargs
)
640 def CopyFromIcon(*args
, **kwargs
):
641 """CopyFromIcon(self, Icon icon) -> bool"""
642 return _gdi_
.Bitmap_CopyFromIcon(*args
, **kwargs
)
644 def SetHeight(*args
, **kwargs
):
646 SetHeight(self, int height)
648 Set the height property (does not affect the existing bitmap data).
650 return _gdi_
.Bitmap_SetHeight(*args
, **kwargs
)
652 def SetWidth(*args
, **kwargs
):
654 SetWidth(self, int width)
656 Set the width property (does not affect the existing bitmap data).
658 return _gdi_
.Bitmap_SetWidth(*args
, **kwargs
)
660 def SetDepth(*args
, **kwargs
):
662 SetDepth(self, int depth)
664 Set the depth property (does not affect the existing bitmap data).
666 return _gdi_
.Bitmap_SetDepth(*args
, **kwargs
)
668 def SetSize(*args
, **kwargs
):
670 SetSize(self, Size size)
672 Set the bitmap size (does not affect the existing bitmap data).
674 return _gdi_
.Bitmap_SetSize(*args
, **kwargs
)
676 def CopyFromCursor(*args
, **kwargs
):
677 """CopyFromCursor(self, Cursor cursor) -> bool"""
678 return _gdi_
.Bitmap_CopyFromCursor(*args
, **kwargs
)
680 def __nonzero__(self
): return self
.Ok()
681 def __eq__(*args
, **kwargs
):
682 """__eq__(self, Bitmap other) -> bool"""
683 return _gdi_
.Bitmap___eq__(*args
, **kwargs
)
685 def __ne__(*args
, **kwargs
):
686 """__ne__(self, Bitmap other) -> bool"""
687 return _gdi_
.Bitmap___ne__(*args
, **kwargs
)
689 Depth
= property(GetDepth
,SetDepth
,doc
="See `GetDepth` and `SetDepth`")
690 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
691 Mask
= property(GetMask
,SetMask
,doc
="See `GetMask` and `SetMask`")
692 Palette
= property(GetPalette
,doc
="See `GetPalette`")
693 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
694 SubBitmap
= property(GetSubBitmap
,doc
="See `GetSubBitmap`")
695 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
696 _gdi_
.Bitmap_swigregister(Bitmap
)
698 def EmptyBitmap(*args
, **kwargs
):
700 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
702 Creates a new bitmap of the given size. A depth of -1 indicates the
703 depth of the current screen or visual. Some platforms only support 1
704 for monochrome and -1 for the current display depth.
706 val
= _gdi_
.new_EmptyBitmap(*args
, **kwargs
)
709 def BitmapFromIcon(*args
, **kwargs
):
711 BitmapFromIcon(Icon icon) -> Bitmap
713 Create a new bitmap from a `wx.Icon` object.
715 val
= _gdi_
.new_BitmapFromIcon(*args
, **kwargs
)
718 def BitmapFromImage(*args
, **kwargs
):
720 BitmapFromImage(Image image, int depth=-1) -> Bitmap
722 Creates bitmap object from a `wx.Image`. This has to be done to
723 actually display a `wx.Image` as you cannot draw an image directly on
724 a window. The resulting bitmap will use the provided colour depth (or
725 that of the current screen colour depth if depth is -1) which entails
726 that a colour reduction may have to take place.
728 val
= _gdi_
.new_BitmapFromImage(*args
, **kwargs
)
731 def BitmapFromXPMData(*args
, **kwargs
):
733 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
735 Construct a Bitmap from a list of strings formatted as XPM data.
737 val
= _gdi_
.new_BitmapFromXPMData(*args
, **kwargs
)
740 def BitmapFromBits(*args
, **kwargs
):
742 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
744 Creates a bitmap from an array of bits. You should only use this
745 function for monochrome bitmaps (depth 1) in portable programs: in
746 this case the bits parameter should contain an XBM image. For other
747 bit depths, the behaviour is platform dependent.
749 val
= _gdi_
.new_BitmapFromBits(*args
, **kwargs
)
753 def _BitmapFromBufferAlpha(*args
, **kwargs
):
754 """_BitmapFromBufferAlpha(int width, int height, buffer data, buffer alpha) -> Bitmap"""
755 return _gdi_
._BitmapFromBufferAlpha
(*args
, **kwargs
)
757 def _BitmapFromBuffer(*args
, **kwargs
):
758 """_BitmapFromBuffer(int width, int height, buffer data) -> Bitmap"""
759 return _gdi_
._BitmapFromBuffer
(*args
, **kwargs
)
760 def BitmapFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
762 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
763 parameter must be a Python object that implements the buffer
764 interface, such as a string, array, etc. The dataBuffer object is
765 expected to contain a series of RGB bytes and be width*height*3
766 bytes long. A buffer object can optionally be supplied for the
767 image's alpha channel data, and it is expected to be width*height
768 bytes long. On Windows the RGB values are 'premultiplied' by the
769 alpha values. (The other platforms do the multiplication
772 Unlike `wx.ImageFromBuffer` the bitmap created with this function
773 does not share the memory buffer with the buffer object. This is
774 because the native pixel buffer format varies on different
775 platforms, and so instead an efficient as possible copy of the
776 data is made from the buffer objects to the bitmap's native pixel
777 buffer. For direct access to a bitmap's pixel buffer see
778 `wx.NativePixelData` and `wx.AlphaPixelData`.
780 :see: `wx.Bitmap`, `wx.BitmapFromBufferRGBA`, `wx.NativePixelData`,
781 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
783 if alphaBuffer
is not None:
784 return _gdi_
._BitmapFromBufferAlpha
(width
, height
, dataBuffer
, alphaBuffer
)
786 return _gdi_
._BitmapFromBuffer
(width
, height
, dataBuffer
)
789 def _BitmapFromBufferRGBA(*args
, **kwargs
):
790 """_BitmapFromBufferRGBA(int width, int height, buffer data) -> Bitmap"""
791 return _gdi_
._BitmapFromBufferRGBA
(*args
, **kwargs
)
792 def BitmapFromBufferRGBA(width
, height
, dataBuffer
):
794 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
795 parameter must be a Python object that implements the buffer
796 interface, such as a string, array, etc. The dataBuffer object is
797 expected to contain a series of RGBA bytes (red, green, blue and
798 alpha) and be width*height*4 bytes long. On Windows the RGB
799 values are 'premultiplied' by the alpha values. (The other
800 platforms do the multiplication themselves.)
802 Unlike `wx.ImageFromBuffer` the bitmap created with this function
803 does not share the memory buffer with the buffer object. This is
804 because the native pixel buffer format varies on different
805 platforms, and so instead an efficient as possible copy of the
806 data is made from the buffer object to the bitmap's native pixel
807 buffer. For direct access to a bitmap's pixel buffer see
808 `wx.NativePixelData` and `wx.AlphaPixelData`.
810 :see: `wx.Bitmap`, `wx.BitmapFromBuffer`, `wx.NativePixelData`,
811 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
813 return _gdi_
._BitmapFromBufferRGBA
(width
, height
, dataBuffer
)
815 class PixelDataBase(object):
816 """Proxy of C++ PixelDataBase class"""
817 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
818 def __init__(self
): raise AttributeError, "No constructor defined"
819 __repr__
= _swig_repr
820 def GetOrigin(*args
, **kwargs
):
821 """GetOrigin(self) -> Point"""
822 return _gdi_
.PixelDataBase_GetOrigin(*args
, **kwargs
)
824 def GetWidth(*args
, **kwargs
):
825 """GetWidth(self) -> int"""
826 return _gdi_
.PixelDataBase_GetWidth(*args
, **kwargs
)
828 def GetHeight(*args
, **kwargs
):
829 """GetHeight(self) -> int"""
830 return _gdi_
.PixelDataBase_GetHeight(*args
, **kwargs
)
832 def GetSize(*args
, **kwargs
):
833 """GetSize(self) -> Size"""
834 return _gdi_
.PixelDataBase_GetSize(*args
, **kwargs
)
836 def GetRowStride(*args
, **kwargs
):
837 """GetRowStride(self) -> int"""
838 return _gdi_
.PixelDataBase_GetRowStride(*args
, **kwargs
)
840 _gdi_
.PixelDataBase_swigregister(PixelDataBase
)
842 class NativePixelData(PixelDataBase
):
843 """Proxy of C++ NativePixelData class"""
844 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
845 __repr__
= _swig_repr
846 def __init__(self
, *args
):
848 __init__(self, Bitmap bmp) -> NativePixelData
849 __init__(self, Bitmap bmp, Rect rect) -> NativePixelData
850 __init__(self, Bitmap bmp, Point pt, Size sz) -> NativePixelData
852 _gdi_
.NativePixelData_swiginit(self
,_gdi_
.new_NativePixelData(*args
))
853 __swig_destroy__
= _gdi_
.delete_NativePixelData
854 __del__
= lambda self
: None;
855 def GetPixels(*args
, **kwargs
):
856 """GetPixels(self) -> NativePixelData_Accessor"""
857 return _gdi_
.NativePixelData_GetPixels(*args
, **kwargs
)
859 def UseAlpha(*args
, **kwargs
):
861 return _gdi_
.NativePixelData_UseAlpha(*args
, **kwargs
)
863 def __nonzero__(*args
, **kwargs
):
864 """__nonzero__(self) -> bool"""
865 return _gdi_
.NativePixelData___nonzero__(*args
, **kwargs
)
869 Create and return an iterator object for this pixel data
870 object. (It's really a generator but I won't tell if you
873 width
= self
.GetWidth()
874 height
= self
.GetHeight()
875 pixels
= self
.GetPixels()
880 class PixelFacade(object):
883 def Set(self
, *args
, **kw
):
884 return pixels
.Set(*args
, **kw
)
886 return str(self
.Get())
888 return 'pixel(%d,%d): %s' % (x
,y
,self
.Get())
889 X
= property(lambda self
: x
)
890 Y
= property(lambda self
: y
)
893 for y
in xrange(height
):
894 for x
in xrange(width
):
900 pixels
.MoveTo(self
, 0, y
)
902 Pixels
= property(GetPixels
,doc
="See `GetPixels`")
903 _gdi_
.NativePixelData_swigregister(NativePixelData
)
905 class NativePixelData_Accessor(object):
906 """Proxy of C++ NativePixelData_Accessor class"""
907 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
908 __repr__
= _swig_repr
909 def __init__(self
, *args
):
911 __init__(self, NativePixelData data) -> NativePixelData_Accessor
912 __init__(self, Bitmap bmp, NativePixelData data) -> NativePixelData_Accessor
913 __init__(self) -> NativePixelData_Accessor
915 _gdi_
.NativePixelData_Accessor_swiginit(self
,_gdi_
.new_NativePixelData_Accessor(*args
))
916 __swig_destroy__
= _gdi_
.delete_NativePixelData_Accessor
917 __del__
= lambda self
: None;
918 def Reset(*args
, **kwargs
):
919 """Reset(self, NativePixelData data)"""
920 return _gdi_
.NativePixelData_Accessor_Reset(*args
, **kwargs
)
922 def IsOk(*args
, **kwargs
):
923 """IsOk(self) -> bool"""
924 return _gdi_
.NativePixelData_Accessor_IsOk(*args
, **kwargs
)
926 def nextPixel(*args
, **kwargs
):
927 """nextPixel(self)"""
928 return _gdi_
.NativePixelData_Accessor_nextPixel(*args
, **kwargs
)
930 def Offset(*args
, **kwargs
):
931 """Offset(self, NativePixelData data, int x, int y)"""
932 return _gdi_
.NativePixelData_Accessor_Offset(*args
, **kwargs
)
934 def OffsetX(*args
, **kwargs
):
935 """OffsetX(self, NativePixelData data, int x)"""
936 return _gdi_
.NativePixelData_Accessor_OffsetX(*args
, **kwargs
)
938 def OffsetY(*args
, **kwargs
):
939 """OffsetY(self, NativePixelData data, int y)"""
940 return _gdi_
.NativePixelData_Accessor_OffsetY(*args
, **kwargs
)
942 def MoveTo(*args
, **kwargs
):
943 """MoveTo(self, NativePixelData data, int x, int y)"""
944 return _gdi_
.NativePixelData_Accessor_MoveTo(*args
, **kwargs
)
946 def Set(*args
, **kwargs
):
947 """Set(self, byte red, byte green, byte blue)"""
948 return _gdi_
.NativePixelData_Accessor_Set(*args
, **kwargs
)
950 def Get(*args
, **kwargs
):
951 """Get(self) -> PyObject"""
952 return _gdi_
.NativePixelData_Accessor_Get(*args
, **kwargs
)
954 _gdi_
.NativePixelData_Accessor_swigregister(NativePixelData_Accessor
)
956 class AlphaPixelData(PixelDataBase
):
957 """Proxy of C++ AlphaPixelData class"""
958 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
959 __repr__
= _swig_repr
960 def __init__(self
, *args
):
962 __init__(self, Bitmap bmp) -> AlphaPixelData
963 __init__(self, Bitmap bmp, Rect rect) -> AlphaPixelData
964 __init__(self, Bitmap bmp, Point pt, Size sz) -> AlphaPixelData
966 _gdi_
.AlphaPixelData_swiginit(self
,_gdi_
.new_AlphaPixelData(*args
))
969 __swig_destroy__
= _gdi_
.delete_AlphaPixelData
970 __del__
= lambda self
: None;
971 def GetPixels(*args
, **kwargs
):
972 """GetPixels(self) -> AlphaPixelData_Accessor"""
973 return _gdi_
.AlphaPixelData_GetPixels(*args
, **kwargs
)
975 def UseAlpha(*args
, **kwargs
):
977 return _gdi_
.AlphaPixelData_UseAlpha(*args
, **kwargs
)
979 def __nonzero__(*args
, **kwargs
):
980 """__nonzero__(self) -> bool"""
981 return _gdi_
.AlphaPixelData___nonzero__(*args
, **kwargs
)
985 Create and return an iterator object for this pixel data
986 object. (It's really a generator but I won't tell if you
989 width
= self
.GetWidth()
990 height
= self
.GetHeight()
991 pixels
= self
.GetPixels()
996 class PixelFacade(object):
999 def Set(self
, *args
, **kw
):
1000 return pixels
.Set(*args
, **kw
)
1002 return str(self
.Get())
1004 return 'pixel(%d,%d): %s' % (x
,y
,self
.Get())
1005 X
= property(lambda self
: x
)
1006 Y
= property(lambda self
: y
)
1009 for y
in xrange(height
):
1010 for x
in xrange(width
):
1016 pixels
.MoveTo(self
, 0, y
)
1018 Pixels
= property(GetPixels
,doc
="See `GetPixels`")
1019 _gdi_
.AlphaPixelData_swigregister(AlphaPixelData
)
1021 class AlphaPixelData_Accessor(object):
1022 """Proxy of C++ AlphaPixelData_Accessor class"""
1023 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1024 __repr__
= _swig_repr
1025 def __init__(self
, *args
):
1027 __init__(self, AlphaPixelData data) -> AlphaPixelData_Accessor
1028 __init__(self, Bitmap bmp, AlphaPixelData data) -> AlphaPixelData_Accessor
1029 __init__(self) -> AlphaPixelData_Accessor
1031 _gdi_
.AlphaPixelData_Accessor_swiginit(self
,_gdi_
.new_AlphaPixelData_Accessor(*args
))
1032 __swig_destroy__
= _gdi_
.delete_AlphaPixelData_Accessor
1033 __del__
= lambda self
: None;
1034 def Reset(*args
, **kwargs
):
1035 """Reset(self, AlphaPixelData data)"""
1036 return _gdi_
.AlphaPixelData_Accessor_Reset(*args
, **kwargs
)
1038 def IsOk(*args
, **kwargs
):
1039 """IsOk(self) -> bool"""
1040 return _gdi_
.AlphaPixelData_Accessor_IsOk(*args
, **kwargs
)
1042 def nextPixel(*args
, **kwargs
):
1043 """nextPixel(self)"""
1044 return _gdi_
.AlphaPixelData_Accessor_nextPixel(*args
, **kwargs
)
1046 def Offset(*args
, **kwargs
):
1047 """Offset(self, AlphaPixelData data, int x, int y)"""
1048 return _gdi_
.AlphaPixelData_Accessor_Offset(*args
, **kwargs
)
1050 def OffsetX(*args
, **kwargs
):
1051 """OffsetX(self, AlphaPixelData data, int x)"""
1052 return _gdi_
.AlphaPixelData_Accessor_OffsetX(*args
, **kwargs
)
1054 def OffsetY(*args
, **kwargs
):
1055 """OffsetY(self, AlphaPixelData data, int y)"""
1056 return _gdi_
.AlphaPixelData_Accessor_OffsetY(*args
, **kwargs
)
1058 def MoveTo(*args
, **kwargs
):
1059 """MoveTo(self, AlphaPixelData data, int x, int y)"""
1060 return _gdi_
.AlphaPixelData_Accessor_MoveTo(*args
, **kwargs
)
1062 def Set(*args
, **kwargs
):
1063 """Set(self, byte red, byte green, byte blue, byte alpha)"""
1064 return _gdi_
.AlphaPixelData_Accessor_Set(*args
, **kwargs
)
1066 def Get(*args
, **kwargs
):
1067 """Get(self) -> PyObject"""
1068 return _gdi_
.AlphaPixelData_Accessor_Get(*args
, **kwargs
)
1070 _gdi_
.AlphaPixelData_Accessor_swigregister(AlphaPixelData_Accessor
)
1072 class Mask(_core
.Object
):
1074 This class encapsulates a monochrome mask bitmap, where the masked
1075 area is black and the unmasked area is white. When associated with a
1076 bitmap and drawn in a device context, the unmasked area of the bitmap
1077 will be drawn, and the masked area will not be drawn.
1079 A mask may be associated with a `wx.Bitmap`. It is used in
1080 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
1081 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
1084 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1085 __repr__
= _swig_repr
1086 def __init__(self
, *args
, **kwargs
):
1088 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
1090 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
1091 that indicates the transparent portions of the mask. In other words,
1092 the pixels in ``bitmap`` that match ``colour`` will be the transparent
1093 portions of the mask. If no ``colour`` or an invalid ``colour`` is
1094 passed then BLACK is used.
1096 :see: `wx.Bitmap`, `wx.Colour`
1098 _gdi_
.Mask_swiginit(self
,_gdi_
.new_Mask(*args
, **kwargs
))
1099 __swig_destroy__
= _gdi_
.delete_Mask
1100 __del__
= lambda self
: None;
1101 _gdi_
.Mask_swigregister(Mask
)
1103 MaskColour
= wx
._deprecated
(Mask
, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
1104 class Icon(GDIObject
):
1105 """Proxy of C++ Icon class"""
1106 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1107 __repr__
= _swig_repr
1108 def __init__(self
, *args
, **kwargs
):
1109 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
1110 _gdi_
.Icon_swiginit(self
,_gdi_
.new_Icon(*args
, **kwargs
))
1111 __swig_destroy__
= _gdi_
.delete_Icon
1112 __del__
= lambda self
: None;
1113 def LoadFile(*args
, **kwargs
):
1114 """LoadFile(self, String name, int type) -> bool"""
1115 return _gdi_
.Icon_LoadFile(*args
, **kwargs
)
1117 def GetHandle(*args
, **kwargs
):
1118 """GetHandle(self) -> long"""
1119 return _gdi_
.Icon_GetHandle(*args
, **kwargs
)
1121 def SetHandle(*args
, **kwargs
):
1122 """SetHandle(self, long handle)"""
1123 return _gdi_
.Icon_SetHandle(*args
, **kwargs
)
1125 def Ok(*args
, **kwargs
):
1126 """Ok(self) -> bool"""
1127 return _gdi_
.Icon_Ok(*args
, **kwargs
)
1129 def GetWidth(*args
, **kwargs
):
1130 """GetWidth(self) -> int"""
1131 return _gdi_
.Icon_GetWidth(*args
, **kwargs
)
1133 def GetHeight(*args
, **kwargs
):
1134 """GetHeight(self) -> int"""
1135 return _gdi_
.Icon_GetHeight(*args
, **kwargs
)
1137 def GetDepth(*args
, **kwargs
):
1138 """GetDepth(self) -> int"""
1139 return _gdi_
.Icon_GetDepth(*args
, **kwargs
)
1141 def SetWidth(*args
, **kwargs
):
1142 """SetWidth(self, int w)"""
1143 return _gdi_
.Icon_SetWidth(*args
, **kwargs
)
1145 def SetHeight(*args
, **kwargs
):
1146 """SetHeight(self, int h)"""
1147 return _gdi_
.Icon_SetHeight(*args
, **kwargs
)
1149 def SetDepth(*args
, **kwargs
):
1150 """SetDepth(self, int d)"""
1151 return _gdi_
.Icon_SetDepth(*args
, **kwargs
)
1153 def SetSize(*args
, **kwargs
):
1154 """SetSize(self, Size size)"""
1155 return _gdi_
.Icon_SetSize(*args
, **kwargs
)
1157 def CopyFromBitmap(*args
, **kwargs
):
1158 """CopyFromBitmap(self, Bitmap bmp)"""
1159 return _gdi_
.Icon_CopyFromBitmap(*args
, **kwargs
)
1161 def __nonzero__(self
): return self
.Ok()
1162 Depth
= property(GetDepth
,SetDepth
,doc
="See `GetDepth` and `SetDepth`")
1163 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
1164 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
1165 _gdi_
.Icon_swigregister(Icon
)
1167 def EmptyIcon(*args
, **kwargs
):
1168 """EmptyIcon() -> Icon"""
1169 val
= _gdi_
.new_EmptyIcon(*args
, **kwargs
)
1172 def IconFromLocation(*args
, **kwargs
):
1173 """IconFromLocation(IconLocation loc) -> Icon"""
1174 val
= _gdi_
.new_IconFromLocation(*args
, **kwargs
)
1177 def IconFromBitmap(*args
, **kwargs
):
1178 """IconFromBitmap(Bitmap bmp) -> Icon"""
1179 val
= _gdi_
.new_IconFromBitmap(*args
, **kwargs
)
1182 def IconFromXPMData(*args
, **kwargs
):
1183 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
1184 val
= _gdi_
.new_IconFromXPMData(*args
, **kwargs
)
1187 class IconLocation(object):
1188 """Proxy of C++ IconLocation class"""
1189 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1190 __repr__
= _swig_repr
1191 def __init__(self
, *args
, **kwargs
):
1192 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
1193 _gdi_
.IconLocation_swiginit(self
,_gdi_
.new_IconLocation(*args
, **kwargs
))
1194 __swig_destroy__
= _gdi_
.delete_IconLocation
1195 __del__
= lambda self
: None;
1196 def IsOk(*args
, **kwargs
):
1197 """IsOk(self) -> bool"""
1198 return _gdi_
.IconLocation_IsOk(*args
, **kwargs
)
1200 def __nonzero__(self
): return self
.Ok()
1201 def SetFileName(*args
, **kwargs
):
1202 """SetFileName(self, String filename)"""
1203 return _gdi_
.IconLocation_SetFileName(*args
, **kwargs
)
1205 def GetFileName(*args
, **kwargs
):
1206 """GetFileName(self) -> String"""
1207 return _gdi_
.IconLocation_GetFileName(*args
, **kwargs
)
1209 def SetIndex(*args
, **kwargs
):
1210 """SetIndex(self, int num)"""
1211 return _gdi_
.IconLocation_SetIndex(*args
, **kwargs
)
1213 def GetIndex(*args
, **kwargs
):
1214 """GetIndex(self) -> int"""
1215 return _gdi_
.IconLocation_GetIndex(*args
, **kwargs
)
1217 FileName
= property(GetFileName
,SetFileName
,doc
="See `GetFileName` and `SetFileName`")
1218 Index
= property(GetIndex
,SetIndex
,doc
="See `GetIndex` and `SetIndex`")
1219 _gdi_
.IconLocation_swigregister(IconLocation
)
1221 class IconBundle(object):
1222 """Proxy of C++ IconBundle class"""
1223 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1224 __repr__
= _swig_repr
1225 def __init__(self
, *args
, **kwargs
):
1226 """__init__(self) -> IconBundle"""
1227 _gdi_
.IconBundle_swiginit(self
,_gdi_
.new_IconBundle(*args
, **kwargs
))
1228 __swig_destroy__
= _gdi_
.delete_IconBundle
1229 __del__
= lambda self
: None;
1230 def AddIcon(*args
, **kwargs
):
1231 """AddIcon(self, Icon icon)"""
1232 return _gdi_
.IconBundle_AddIcon(*args
, **kwargs
)
1234 def AddIconFromFile(*args
, **kwargs
):
1235 """AddIconFromFile(self, String file, long type)"""
1236 return _gdi_
.IconBundle_AddIconFromFile(*args
, **kwargs
)
1238 def GetIcon(*args
, **kwargs
):
1239 """GetIcon(self, Size size) -> Icon"""
1240 return _gdi_
.IconBundle_GetIcon(*args
, **kwargs
)
1242 Icon
= property(GetIcon
,doc
="See `GetIcon`")
1243 _gdi_
.IconBundle_swigregister(IconBundle
)
1245 def IconBundleFromFile(*args
, **kwargs
):
1246 """IconBundleFromFile(String file, long type) -> IconBundle"""
1247 val
= _gdi_
.new_IconBundleFromFile(*args
, **kwargs
)
1250 def IconBundleFromIcon(*args
, **kwargs
):
1251 """IconBundleFromIcon(Icon icon) -> IconBundle"""
1252 val
= _gdi_
.new_IconBundleFromIcon(*args
, **kwargs
)
1255 class Cursor(GDIObject
):
1257 A cursor is a small bitmap usually used for denoting where the mouse
1258 pointer is, with a picture that might indicate the interpretation of a
1261 A single cursor object may be used in many windows (any subwindow
1262 type). The wxWindows convention is to set the cursor for a window, as
1263 in X, rather than to set it globally as in MS Windows, although a
1264 global `wx.SetCursor` function is also available for use on MS Windows.
1267 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1268 __repr__
= _swig_repr
1269 def __init__(self
, *args
, **kwargs
):
1271 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
1273 Construct a Cursor from a file. Specify the type of file using
1274 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
1277 _gdi_
.Cursor_swiginit(self
,_gdi_
.new_Cursor(*args
, **kwargs
))
1278 __swig_destroy__
= _gdi_
.delete_Cursor
1279 __del__
= lambda self
: None;
1280 def GetHandle(*args
, **kwargs
):
1282 GetHandle(self) -> long
1284 Get the MS Windows handle for the cursor
1286 return _gdi_
.Cursor_GetHandle(*args
, **kwargs
)
1288 def SetHandle(*args
, **kwargs
):
1290 SetHandle(self, long handle)
1292 Set the MS Windows handle to use for the cursor
1294 return _gdi_
.Cursor_SetHandle(*args
, **kwargs
)
1296 def Ok(*args
, **kwargs
):
1297 """Ok(self) -> bool"""
1298 return _gdi_
.Cursor_Ok(*args
, **kwargs
)
1300 def __nonzero__(self
): return self
.Ok()
1301 def GetWidth(*args
, **kwargs
):
1302 """GetWidth(self) -> int"""
1303 return _gdi_
.Cursor_GetWidth(*args
, **kwargs
)
1305 def GetHeight(*args
, **kwargs
):
1306 """GetHeight(self) -> int"""
1307 return _gdi_
.Cursor_GetHeight(*args
, **kwargs
)
1309 def GetDepth(*args
, **kwargs
):
1310 """GetDepth(self) -> int"""
1311 return _gdi_
.Cursor_GetDepth(*args
, **kwargs
)
1313 def SetWidth(*args
, **kwargs
):
1314 """SetWidth(self, int w)"""
1315 return _gdi_
.Cursor_SetWidth(*args
, **kwargs
)
1317 def SetHeight(*args
, **kwargs
):
1318 """SetHeight(self, int h)"""
1319 return _gdi_
.Cursor_SetHeight(*args
, **kwargs
)
1321 def SetDepth(*args
, **kwargs
):
1322 """SetDepth(self, int d)"""
1323 return _gdi_
.Cursor_SetDepth(*args
, **kwargs
)
1325 def SetSize(*args
, **kwargs
):
1326 """SetSize(self, Size size)"""
1327 return _gdi_
.Cursor_SetSize(*args
, **kwargs
)
1329 _gdi_
.Cursor_swigregister(Cursor
)
1331 def StockCursor(*args
, **kwargs
):
1333 StockCursor(int id) -> Cursor
1335 Create a cursor using one of the stock cursors. Note that not all
1336 stock cursors are available on all platforms.
1338 val
= _gdi_
.new_StockCursor(*args
, **kwargs
)
1341 def CursorFromImage(*args
, **kwargs
):
1343 CursorFromImage(Image image) -> Cursor
1345 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
1346 for setting the transparent portions of the cursor.
1348 val
= _gdi_
.new_CursorFromImage(*args
, **kwargs
)
1351 #---------------------------------------------------------------------------
1353 OutRegion
= _gdi_
.OutRegion
1354 PartRegion
= _gdi_
.PartRegion
1355 InRegion
= _gdi_
.InRegion
1356 class Region(GDIObject
):
1357 """Proxy of C++ Region class"""
1358 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1359 __repr__
= _swig_repr
1360 def __init__(self
, *args
, **kwargs
):
1361 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
1362 _gdi_
.Region_swiginit(self
,_gdi_
.new_Region(*args
, **kwargs
))
1363 __swig_destroy__
= _gdi_
.delete_Region
1364 __del__
= lambda self
: None;
1365 def Clear(*args
, **kwargs
):
1367 return _gdi_
.Region_Clear(*args
, **kwargs
)
1369 def Offset(*args
, **kwargs
):
1370 """Offset(self, int x, int y) -> bool"""
1371 return _gdi_
.Region_Offset(*args
, **kwargs
)
1373 def Contains(*args
, **kwargs
):
1374 """Contains(self, int x, int y) -> int"""
1375 return _gdi_
.Region_Contains(*args
, **kwargs
)
1377 def ContainsPoint(*args
, **kwargs
):
1378 """ContainsPoint(self, Point pt) -> int"""
1379 return _gdi_
.Region_ContainsPoint(*args
, **kwargs
)
1381 def ContainsRect(*args
, **kwargs
):
1382 """ContainsRect(self, Rect rect) -> int"""
1383 return _gdi_
.Region_ContainsRect(*args
, **kwargs
)
1385 def ContainsRectDim(*args
, **kwargs
):
1386 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
1387 return _gdi_
.Region_ContainsRectDim(*args
, **kwargs
)
1389 def GetBox(*args
, **kwargs
):
1390 """GetBox(self) -> Rect"""
1391 return _gdi_
.Region_GetBox(*args
, **kwargs
)
1393 def Intersect(*args
, **kwargs
):
1394 """Intersect(self, int x, int y, int width, int height) -> bool"""
1395 return _gdi_
.Region_Intersect(*args
, **kwargs
)
1397 def IntersectRect(*args
, **kwargs
):
1398 """IntersectRect(self, Rect rect) -> bool"""
1399 return _gdi_
.Region_IntersectRect(*args
, **kwargs
)
1401 def IntersectRegion(*args
, **kwargs
):
1402 """IntersectRegion(self, Region region) -> bool"""
1403 return _gdi_
.Region_IntersectRegion(*args
, **kwargs
)
1405 def IsEmpty(*args
, **kwargs
):
1406 """IsEmpty(self) -> bool"""
1407 return _gdi_
.Region_IsEmpty(*args
, **kwargs
)
1409 def Union(*args
, **kwargs
):
1410 """Union(self, int x, int y, int width, int height) -> bool"""
1411 return _gdi_
.Region_Union(*args
, **kwargs
)
1413 def UnionRect(*args
, **kwargs
):
1414 """UnionRect(self, Rect rect) -> bool"""
1415 return _gdi_
.Region_UnionRect(*args
, **kwargs
)
1417 def UnionRegion(*args
, **kwargs
):
1418 """UnionRegion(self, Region region) -> bool"""
1419 return _gdi_
.Region_UnionRegion(*args
, **kwargs
)
1421 def Subtract(*args
, **kwargs
):
1422 """Subtract(self, int x, int y, int width, int height) -> bool"""
1423 return _gdi_
.Region_Subtract(*args
, **kwargs
)
1425 def SubtractRect(*args
, **kwargs
):
1426 """SubtractRect(self, Rect rect) -> bool"""
1427 return _gdi_
.Region_SubtractRect(*args
, **kwargs
)
1429 def SubtractRegion(*args
, **kwargs
):
1430 """SubtractRegion(self, Region region) -> bool"""
1431 return _gdi_
.Region_SubtractRegion(*args
, **kwargs
)
1433 def Xor(*args
, **kwargs
):
1434 """Xor(self, int x, int y, int width, int height) -> bool"""
1435 return _gdi_
.Region_Xor(*args
, **kwargs
)
1437 def XorRect(*args
, **kwargs
):
1438 """XorRect(self, Rect rect) -> bool"""
1439 return _gdi_
.Region_XorRect(*args
, **kwargs
)
1441 def XorRegion(*args
, **kwargs
):
1442 """XorRegion(self, Region region) -> bool"""
1443 return _gdi_
.Region_XorRegion(*args
, **kwargs
)
1445 def ConvertToBitmap(*args
, **kwargs
):
1446 """ConvertToBitmap(self) -> Bitmap"""
1447 return _gdi_
.Region_ConvertToBitmap(*args
, **kwargs
)
1449 def UnionBitmap(*args
, **kwargs
):
1450 """UnionBitmap(self, Bitmap bmp) -> bool"""
1451 return _gdi_
.Region_UnionBitmap(*args
, **kwargs
)
1453 def UnionBitmapColour(*args
, **kwargs
):
1454 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1455 return _gdi_
.Region_UnionBitmapColour(*args
, **kwargs
)
1457 _gdi_
.Region_swigregister(Region
)
1459 def RegionFromBitmap(*args
, **kwargs
):
1460 """RegionFromBitmap(Bitmap bmp) -> Region"""
1461 val
= _gdi_
.new_RegionFromBitmap(*args
, **kwargs
)
1464 def RegionFromBitmapColour(*args
, **kwargs
):
1465 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1466 val
= _gdi_
.new_RegionFromBitmapColour(*args
, **kwargs
)
1469 def RegionFromPoints(*args
, **kwargs
):
1470 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
1471 val
= _gdi_
.new_RegionFromPoints(*args
, **kwargs
)
1474 class RegionIterator(_core
.Object
):
1475 """Proxy of C++ RegionIterator class"""
1476 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1477 __repr__
= _swig_repr
1478 def __init__(self
, *args
, **kwargs
):
1479 """__init__(self, Region region) -> RegionIterator"""
1480 _gdi_
.RegionIterator_swiginit(self
,_gdi_
.new_RegionIterator(*args
, **kwargs
))
1481 __swig_destroy__
= _gdi_
.delete_RegionIterator
1482 __del__
= lambda self
: None;
1483 def GetX(*args
, **kwargs
):
1484 """GetX(self) -> int"""
1485 return _gdi_
.RegionIterator_GetX(*args
, **kwargs
)
1487 def GetY(*args
, **kwargs
):
1488 """GetY(self) -> int"""
1489 return _gdi_
.RegionIterator_GetY(*args
, **kwargs
)
1491 def GetW(*args
, **kwargs
):
1492 """GetW(self) -> int"""
1493 return _gdi_
.RegionIterator_GetW(*args
, **kwargs
)
1495 def GetWidth(*args
, **kwargs
):
1496 """GetWidth(self) -> int"""
1497 return _gdi_
.RegionIterator_GetWidth(*args
, **kwargs
)
1499 def GetH(*args
, **kwargs
):
1500 """GetH(self) -> int"""
1501 return _gdi_
.RegionIterator_GetH(*args
, **kwargs
)
1503 def GetHeight(*args
, **kwargs
):
1504 """GetHeight(self) -> int"""
1505 return _gdi_
.RegionIterator_GetHeight(*args
, **kwargs
)
1507 def GetRect(*args
, **kwargs
):
1508 """GetRect(self) -> Rect"""
1509 return _gdi_
.RegionIterator_GetRect(*args
, **kwargs
)
1511 def HaveRects(*args
, **kwargs
):
1512 """HaveRects(self) -> bool"""
1513 return _gdi_
.RegionIterator_HaveRects(*args
, **kwargs
)
1515 def Reset(*args
, **kwargs
):
1517 return _gdi_
.RegionIterator_Reset(*args
, **kwargs
)
1519 def Next(*args
, **kwargs
):
1521 return _gdi_
.RegionIterator_Next(*args
, **kwargs
)
1523 def __nonzero__(*args
, **kwargs
):
1524 """__nonzero__(self) -> bool"""
1525 return _gdi_
.RegionIterator___nonzero__(*args
, **kwargs
)
1527 _gdi_
.RegionIterator_swigregister(RegionIterator
)
1529 #---------------------------------------------------------------------------
1531 FONTFAMILY_DEFAULT
= _gdi_
.FONTFAMILY_DEFAULT
1532 FONTFAMILY_DECORATIVE
= _gdi_
.FONTFAMILY_DECORATIVE
1533 FONTFAMILY_ROMAN
= _gdi_
.FONTFAMILY_ROMAN
1534 FONTFAMILY_SCRIPT
= _gdi_
.FONTFAMILY_SCRIPT
1535 FONTFAMILY_SWISS
= _gdi_
.FONTFAMILY_SWISS
1536 FONTFAMILY_MODERN
= _gdi_
.FONTFAMILY_MODERN
1537 FONTFAMILY_TELETYPE
= _gdi_
.FONTFAMILY_TELETYPE
1538 FONTFAMILY_MAX
= _gdi_
.FONTFAMILY_MAX
1539 FONTFAMILY_UNKNOWN
= _gdi_
.FONTFAMILY_UNKNOWN
1540 FONTSTYLE_NORMAL
= _gdi_
.FONTSTYLE_NORMAL
1541 FONTSTYLE_ITALIC
= _gdi_
.FONTSTYLE_ITALIC
1542 FONTSTYLE_SLANT
= _gdi_
.FONTSTYLE_SLANT
1543 FONTSTYLE_MAX
= _gdi_
.FONTSTYLE_MAX
1544 FONTWEIGHT_NORMAL
= _gdi_
.FONTWEIGHT_NORMAL
1545 FONTWEIGHT_LIGHT
= _gdi_
.FONTWEIGHT_LIGHT
1546 FONTWEIGHT_BOLD
= _gdi_
.FONTWEIGHT_BOLD
1547 FONTWEIGHT_MAX
= _gdi_
.FONTWEIGHT_MAX
1548 FONTFLAG_DEFAULT
= _gdi_
.FONTFLAG_DEFAULT
1549 FONTFLAG_ITALIC
= _gdi_
.FONTFLAG_ITALIC
1550 FONTFLAG_SLANT
= _gdi_
.FONTFLAG_SLANT
1551 FONTFLAG_LIGHT
= _gdi_
.FONTFLAG_LIGHT
1552 FONTFLAG_BOLD
= _gdi_
.FONTFLAG_BOLD
1553 FONTFLAG_ANTIALIASED
= _gdi_
.FONTFLAG_ANTIALIASED
1554 FONTFLAG_NOT_ANTIALIASED
= _gdi_
.FONTFLAG_NOT_ANTIALIASED
1555 FONTFLAG_UNDERLINED
= _gdi_
.FONTFLAG_UNDERLINED
1556 FONTFLAG_STRIKETHROUGH
= _gdi_
.FONTFLAG_STRIKETHROUGH
1557 FONTFLAG_MASK
= _gdi_
.FONTFLAG_MASK
1558 FONTENCODING_SYSTEM
= _gdi_
.FONTENCODING_SYSTEM
1559 FONTENCODING_DEFAULT
= _gdi_
.FONTENCODING_DEFAULT
1560 FONTENCODING_ISO8859_1
= _gdi_
.FONTENCODING_ISO8859_1
1561 FONTENCODING_ISO8859_2
= _gdi_
.FONTENCODING_ISO8859_2
1562 FONTENCODING_ISO8859_3
= _gdi_
.FONTENCODING_ISO8859_3
1563 FONTENCODING_ISO8859_4
= _gdi_
.FONTENCODING_ISO8859_4
1564 FONTENCODING_ISO8859_5
= _gdi_
.FONTENCODING_ISO8859_5
1565 FONTENCODING_ISO8859_6
= _gdi_
.FONTENCODING_ISO8859_6
1566 FONTENCODING_ISO8859_7
= _gdi_
.FONTENCODING_ISO8859_7
1567 FONTENCODING_ISO8859_8
= _gdi_
.FONTENCODING_ISO8859_8
1568 FONTENCODING_ISO8859_9
= _gdi_
.FONTENCODING_ISO8859_9
1569 FONTENCODING_ISO8859_10
= _gdi_
.FONTENCODING_ISO8859_10
1570 FONTENCODING_ISO8859_11
= _gdi_
.FONTENCODING_ISO8859_11
1571 FONTENCODING_ISO8859_12
= _gdi_
.FONTENCODING_ISO8859_12
1572 FONTENCODING_ISO8859_13
= _gdi_
.FONTENCODING_ISO8859_13
1573 FONTENCODING_ISO8859_14
= _gdi_
.FONTENCODING_ISO8859_14
1574 FONTENCODING_ISO8859_15
= _gdi_
.FONTENCODING_ISO8859_15
1575 FONTENCODING_ISO8859_MAX
= _gdi_
.FONTENCODING_ISO8859_MAX
1576 FONTENCODING_KOI8
= _gdi_
.FONTENCODING_KOI8
1577 FONTENCODING_KOI8_U
= _gdi_
.FONTENCODING_KOI8_U
1578 FONTENCODING_ALTERNATIVE
= _gdi_
.FONTENCODING_ALTERNATIVE
1579 FONTENCODING_BULGARIAN
= _gdi_
.FONTENCODING_BULGARIAN
1580 FONTENCODING_CP437
= _gdi_
.FONTENCODING_CP437
1581 FONTENCODING_CP850
= _gdi_
.FONTENCODING_CP850
1582 FONTENCODING_CP852
= _gdi_
.FONTENCODING_CP852
1583 FONTENCODING_CP855
= _gdi_
.FONTENCODING_CP855
1584 FONTENCODING_CP866
= _gdi_
.FONTENCODING_CP866
1585 FONTENCODING_CP874
= _gdi_
.FONTENCODING_CP874
1586 FONTENCODING_CP932
= _gdi_
.FONTENCODING_CP932
1587 FONTENCODING_CP936
= _gdi_
.FONTENCODING_CP936
1588 FONTENCODING_CP949
= _gdi_
.FONTENCODING_CP949
1589 FONTENCODING_CP950
= _gdi_
.FONTENCODING_CP950
1590 FONTENCODING_CP1250
= _gdi_
.FONTENCODING_CP1250
1591 FONTENCODING_CP1251
= _gdi_
.FONTENCODING_CP1251
1592 FONTENCODING_CP1252
= _gdi_
.FONTENCODING_CP1252
1593 FONTENCODING_CP1253
= _gdi_
.FONTENCODING_CP1253
1594 FONTENCODING_CP1254
= _gdi_
.FONTENCODING_CP1254
1595 FONTENCODING_CP1255
= _gdi_
.FONTENCODING_CP1255
1596 FONTENCODING_CP1256
= _gdi_
.FONTENCODING_CP1256
1597 FONTENCODING_CP1257
= _gdi_
.FONTENCODING_CP1257
1598 FONTENCODING_CP12_MAX
= _gdi_
.FONTENCODING_CP12_MAX
1599 FONTENCODING_UTF7
= _gdi_
.FONTENCODING_UTF7
1600 FONTENCODING_UTF8
= _gdi_
.FONTENCODING_UTF8
1601 FONTENCODING_EUC_JP
= _gdi_
.FONTENCODING_EUC_JP
1602 FONTENCODING_UTF16BE
= _gdi_
.FONTENCODING_UTF16BE
1603 FONTENCODING_UTF16LE
= _gdi_
.FONTENCODING_UTF16LE
1604 FONTENCODING_UTF32BE
= _gdi_
.FONTENCODING_UTF32BE
1605 FONTENCODING_UTF32LE
= _gdi_
.FONTENCODING_UTF32LE
1606 FONTENCODING_MACROMAN
= _gdi_
.FONTENCODING_MACROMAN
1607 FONTENCODING_MACJAPANESE
= _gdi_
.FONTENCODING_MACJAPANESE
1608 FONTENCODING_MACCHINESETRAD
= _gdi_
.FONTENCODING_MACCHINESETRAD
1609 FONTENCODING_MACKOREAN
= _gdi_
.FONTENCODING_MACKOREAN
1610 FONTENCODING_MACARABIC
= _gdi_
.FONTENCODING_MACARABIC
1611 FONTENCODING_MACHEBREW
= _gdi_
.FONTENCODING_MACHEBREW
1612 FONTENCODING_MACGREEK
= _gdi_
.FONTENCODING_MACGREEK
1613 FONTENCODING_MACCYRILLIC
= _gdi_
.FONTENCODING_MACCYRILLIC
1614 FONTENCODING_MACDEVANAGARI
= _gdi_
.FONTENCODING_MACDEVANAGARI
1615 FONTENCODING_MACGURMUKHI
= _gdi_
.FONTENCODING_MACGURMUKHI
1616 FONTENCODING_MACGUJARATI
= _gdi_
.FONTENCODING_MACGUJARATI
1617 FONTENCODING_MACORIYA
= _gdi_
.FONTENCODING_MACORIYA
1618 FONTENCODING_MACBENGALI
= _gdi_
.FONTENCODING_MACBENGALI
1619 FONTENCODING_MACTAMIL
= _gdi_
.FONTENCODING_MACTAMIL
1620 FONTENCODING_MACTELUGU
= _gdi_
.FONTENCODING_MACTELUGU
1621 FONTENCODING_MACKANNADA
= _gdi_
.FONTENCODING_MACKANNADA
1622 FONTENCODING_MACMALAJALAM
= _gdi_
.FONTENCODING_MACMALAJALAM
1623 FONTENCODING_MACSINHALESE
= _gdi_
.FONTENCODING_MACSINHALESE
1624 FONTENCODING_MACBURMESE
= _gdi_
.FONTENCODING_MACBURMESE
1625 FONTENCODING_MACKHMER
= _gdi_
.FONTENCODING_MACKHMER
1626 FONTENCODING_MACTHAI
= _gdi_
.FONTENCODING_MACTHAI
1627 FONTENCODING_MACLAOTIAN
= _gdi_
.FONTENCODING_MACLAOTIAN
1628 FONTENCODING_MACGEORGIAN
= _gdi_
.FONTENCODING_MACGEORGIAN
1629 FONTENCODING_MACARMENIAN
= _gdi_
.FONTENCODING_MACARMENIAN
1630 FONTENCODING_MACCHINESESIMP
= _gdi_
.FONTENCODING_MACCHINESESIMP
1631 FONTENCODING_MACTIBETAN
= _gdi_
.FONTENCODING_MACTIBETAN
1632 FONTENCODING_MACMONGOLIAN
= _gdi_
.FONTENCODING_MACMONGOLIAN
1633 FONTENCODING_MACETHIOPIC
= _gdi_
.FONTENCODING_MACETHIOPIC
1634 FONTENCODING_MACCENTRALEUR
= _gdi_
.FONTENCODING_MACCENTRALEUR
1635 FONTENCODING_MACVIATNAMESE
= _gdi_
.FONTENCODING_MACVIATNAMESE
1636 FONTENCODING_MACARABICEXT
= _gdi_
.FONTENCODING_MACARABICEXT
1637 FONTENCODING_MACSYMBOL
= _gdi_
.FONTENCODING_MACSYMBOL
1638 FONTENCODING_MACDINGBATS
= _gdi_
.FONTENCODING_MACDINGBATS
1639 FONTENCODING_MACTURKISH
= _gdi_
.FONTENCODING_MACTURKISH
1640 FONTENCODING_MACCROATIAN
= _gdi_
.FONTENCODING_MACCROATIAN
1641 FONTENCODING_MACICELANDIC
= _gdi_
.FONTENCODING_MACICELANDIC
1642 FONTENCODING_MACROMANIAN
= _gdi_
.FONTENCODING_MACROMANIAN
1643 FONTENCODING_MACCELTIC
= _gdi_
.FONTENCODING_MACCELTIC
1644 FONTENCODING_MACGAELIC
= _gdi_
.FONTENCODING_MACGAELIC
1645 FONTENCODING_MACKEYBOARD
= _gdi_
.FONTENCODING_MACKEYBOARD
1646 FONTENCODING_MACMIN
= _gdi_
.FONTENCODING_MACMIN
1647 FONTENCODING_MACMAX
= _gdi_
.FONTENCODING_MACMAX
1648 FONTENCODING_MAX
= _gdi_
.FONTENCODING_MAX
1649 FONTENCODING_UTF16
= _gdi_
.FONTENCODING_UTF16
1650 FONTENCODING_UTF32
= _gdi_
.FONTENCODING_UTF32
1651 FONTENCODING_UNICODE
= _gdi_
.FONTENCODING_UNICODE
1652 FONTENCODING_GB2312
= _gdi_
.FONTENCODING_GB2312
1653 FONTENCODING_BIG5
= _gdi_
.FONTENCODING_BIG5
1654 FONTENCODING_SHIFT_JIS
= _gdi_
.FONTENCODING_SHIFT_JIS
1655 #---------------------------------------------------------------------------
1657 class NativeFontInfo(object):
1658 """Proxy of C++ NativeFontInfo class"""
1659 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1660 __repr__
= _swig_repr
1661 def __init__(self
, *args
, **kwargs
):
1662 """__init__(self) -> NativeFontInfo"""
1663 _gdi_
.NativeFontInfo_swiginit(self
,_gdi_
.new_NativeFontInfo(*args
, **kwargs
))
1664 __swig_destroy__
= _gdi_
.delete_NativeFontInfo
1665 __del__
= lambda self
: None;
1666 def Init(*args
, **kwargs
):
1668 return _gdi_
.NativeFontInfo_Init(*args
, **kwargs
)
1670 def InitFromFont(*args
, **kwargs
):
1671 """InitFromFont(self, Font font)"""
1672 return _gdi_
.NativeFontInfo_InitFromFont(*args
, **kwargs
)
1674 def GetPointSize(*args
, **kwargs
):
1675 """GetPointSize(self) -> int"""
1676 return _gdi_
.NativeFontInfo_GetPointSize(*args
, **kwargs
)
1678 def GetPixelSize(*args
, **kwargs
):
1679 """GetPixelSize(self) -> Size"""
1680 return _gdi_
.NativeFontInfo_GetPixelSize(*args
, **kwargs
)
1682 def GetStyle(*args
, **kwargs
):
1683 """GetStyle(self) -> int"""
1684 return _gdi_
.NativeFontInfo_GetStyle(*args
, **kwargs
)
1686 def GetWeight(*args
, **kwargs
):
1687 """GetWeight(self) -> int"""
1688 return _gdi_
.NativeFontInfo_GetWeight(*args
, **kwargs
)
1690 def GetUnderlined(*args
, **kwargs
):
1691 """GetUnderlined(self) -> bool"""
1692 return _gdi_
.NativeFontInfo_GetUnderlined(*args
, **kwargs
)
1694 def GetFaceName(*args
, **kwargs
):
1695 """GetFaceName(self) -> String"""
1696 return _gdi_
.NativeFontInfo_GetFaceName(*args
, **kwargs
)
1698 def GetFamily(*args
, **kwargs
):
1699 """GetFamily(self) -> int"""
1700 return _gdi_
.NativeFontInfo_GetFamily(*args
, **kwargs
)
1702 def GetEncoding(*args
, **kwargs
):
1703 """GetEncoding(self) -> int"""
1704 return _gdi_
.NativeFontInfo_GetEncoding(*args
, **kwargs
)
1706 def SetPointSize(*args
, **kwargs
):
1707 """SetPointSize(self, int pointsize)"""
1708 return _gdi_
.NativeFontInfo_SetPointSize(*args
, **kwargs
)
1710 def SetPixelSize(*args
, **kwargs
):
1711 """SetPixelSize(self, Size pixelSize)"""
1712 return _gdi_
.NativeFontInfo_SetPixelSize(*args
, **kwargs
)
1714 def SetStyle(*args
, **kwargs
):
1715 """SetStyle(self, int style)"""
1716 return _gdi_
.NativeFontInfo_SetStyle(*args
, **kwargs
)
1718 def SetWeight(*args
, **kwargs
):
1719 """SetWeight(self, int weight)"""
1720 return _gdi_
.NativeFontInfo_SetWeight(*args
, **kwargs
)
1722 def SetUnderlined(*args
, **kwargs
):
1723 """SetUnderlined(self, bool underlined)"""
1724 return _gdi_
.NativeFontInfo_SetUnderlined(*args
, **kwargs
)
1726 def SetFaceName(*args
, **kwargs
):
1727 """SetFaceName(self, String facename) -> bool"""
1728 return _gdi_
.NativeFontInfo_SetFaceName(*args
, **kwargs
)
1730 def SetFamily(*args
, **kwargs
):
1731 """SetFamily(self, int family)"""
1732 return _gdi_
.NativeFontInfo_SetFamily(*args
, **kwargs
)
1734 def SetEncoding(*args
, **kwargs
):
1735 """SetEncoding(self, int encoding)"""
1736 return _gdi_
.NativeFontInfo_SetEncoding(*args
, **kwargs
)
1738 def FromString(*args
, **kwargs
):
1739 """FromString(self, String s) -> bool"""
1740 return _gdi_
.NativeFontInfo_FromString(*args
, **kwargs
)
1742 def ToString(*args
, **kwargs
):
1743 """ToString(self) -> String"""
1744 return _gdi_
.NativeFontInfo_ToString(*args
, **kwargs
)
1746 def __str__(*args
, **kwargs
):
1747 """__str__(self) -> String"""
1748 return _gdi_
.NativeFontInfo___str__(*args
, **kwargs
)
1750 def FromUserString(*args
, **kwargs
):
1751 """FromUserString(self, String s) -> bool"""
1752 return _gdi_
.NativeFontInfo_FromUserString(*args
, **kwargs
)
1754 def ToUserString(*args
, **kwargs
):
1755 """ToUserString(self) -> String"""
1756 return _gdi_
.NativeFontInfo_ToUserString(*args
, **kwargs
)
1758 _gdi_
.NativeFontInfo_swigregister(NativeFontInfo
)
1760 class NativeEncodingInfo(object):
1761 """Proxy of C++ NativeEncodingInfo class"""
1762 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1763 __repr__
= _swig_repr
1764 facename
= property(_gdi_
.NativeEncodingInfo_facename_get
, _gdi_
.NativeEncodingInfo_facename_set
)
1765 encoding
= property(_gdi_
.NativeEncodingInfo_encoding_get
, _gdi_
.NativeEncodingInfo_encoding_set
)
1766 def __init__(self
, *args
, **kwargs
):
1767 """__init__(self) -> NativeEncodingInfo"""
1768 _gdi_
.NativeEncodingInfo_swiginit(self
,_gdi_
.new_NativeEncodingInfo(*args
, **kwargs
))
1769 __swig_destroy__
= _gdi_
.delete_NativeEncodingInfo
1770 __del__
= lambda self
: None;
1771 def FromString(*args
, **kwargs
):
1772 """FromString(self, String s) -> bool"""
1773 return _gdi_
.NativeEncodingInfo_FromString(*args
, **kwargs
)
1775 def ToString(*args
, **kwargs
):
1776 """ToString(self) -> String"""
1777 return _gdi_
.NativeEncodingInfo_ToString(*args
, **kwargs
)
1779 _gdi_
.NativeEncodingInfo_swigregister(NativeEncodingInfo
)
1782 def GetNativeFontEncoding(*args
, **kwargs
):
1783 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
1784 return _gdi_
.GetNativeFontEncoding(*args
, **kwargs
)
1786 def TestFontEncoding(*args
, **kwargs
):
1787 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
1788 return _gdi_
.TestFontEncoding(*args
, **kwargs
)
1789 #---------------------------------------------------------------------------
1791 class FontMapper(object):
1792 """Proxy of C++ FontMapper class"""
1793 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1794 __repr__
= _swig_repr
1795 def __init__(self
, *args
, **kwargs
):
1796 """__init__(self) -> FontMapper"""
1797 _gdi_
.FontMapper_swiginit(self
,_gdi_
.new_FontMapper(*args
, **kwargs
))
1798 __swig_destroy__
= _gdi_
.delete_FontMapper
1799 __del__
= lambda self
: None;
1800 def Get(*args
, **kwargs
):
1801 """Get() -> FontMapper"""
1802 return _gdi_
.FontMapper_Get(*args
, **kwargs
)
1804 Get
= staticmethod(Get
)
1805 def Set(*args
, **kwargs
):
1806 """Set(FontMapper mapper) -> FontMapper"""
1807 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1809 Set
= staticmethod(Set
)
1810 def CharsetToEncoding(*args
, **kwargs
):
1811 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
1812 return _gdi_
.FontMapper_CharsetToEncoding(*args
, **kwargs
)
1814 def GetSupportedEncodingsCount(*args
, **kwargs
):
1815 """GetSupportedEncodingsCount() -> size_t"""
1816 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
, **kwargs
)
1818 GetSupportedEncodingsCount
= staticmethod(GetSupportedEncodingsCount
)
1819 def GetEncoding(*args
, **kwargs
):
1820 """GetEncoding(size_t n) -> int"""
1821 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1823 GetEncoding
= staticmethod(GetEncoding
)
1824 def GetEncodingName(*args
, **kwargs
):
1825 """GetEncodingName(int encoding) -> String"""
1826 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1828 GetEncodingName
= staticmethod(GetEncodingName
)
1829 def GetEncodingDescription(*args
, **kwargs
):
1830 """GetEncodingDescription(int encoding) -> String"""
1831 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1833 GetEncodingDescription
= staticmethod(GetEncodingDescription
)
1834 def GetEncodingFromName(*args
, **kwargs
):
1835 """GetEncodingFromName(String name) -> int"""
1836 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1838 GetEncodingFromName
= staticmethod(GetEncodingFromName
)
1839 def SetConfigPath(*args
, **kwargs
):
1840 """SetConfigPath(self, String prefix)"""
1841 return _gdi_
.FontMapper_SetConfigPath(*args
, **kwargs
)
1843 def GetDefaultConfigPath(*args
, **kwargs
):
1844 """GetDefaultConfigPath() -> String"""
1845 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
, **kwargs
)
1847 GetDefaultConfigPath
= staticmethod(GetDefaultConfigPath
)
1848 def GetAltForEncoding(*args
, **kwargs
):
1849 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
1850 return _gdi_
.FontMapper_GetAltForEncoding(*args
, **kwargs
)
1852 def IsEncodingAvailable(*args
, **kwargs
):
1853 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
1854 return _gdi_
.FontMapper_IsEncodingAvailable(*args
, **kwargs
)
1856 def SetDialogParent(*args
, **kwargs
):
1857 """SetDialogParent(self, Window parent)"""
1858 return _gdi_
.FontMapper_SetDialogParent(*args
, **kwargs
)
1860 def SetDialogTitle(*args
, **kwargs
):
1861 """SetDialogTitle(self, String title)"""
1862 return _gdi_
.FontMapper_SetDialogTitle(*args
, **kwargs
)
1864 AltForEncoding
= property(GetAltForEncoding
,doc
="See `GetAltForEncoding`")
1865 _gdi_
.FontMapper_swigregister(FontMapper
)
1867 def FontMapper_Get(*args
):
1868 """FontMapper_Get() -> FontMapper"""
1869 return _gdi_
.FontMapper_Get(*args
)
1871 def FontMapper_Set(*args
, **kwargs
):
1872 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
1873 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1875 def FontMapper_GetSupportedEncodingsCount(*args
):
1876 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
1877 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
)
1879 def FontMapper_GetEncoding(*args
, **kwargs
):
1880 """FontMapper_GetEncoding(size_t n) -> int"""
1881 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1883 def FontMapper_GetEncodingName(*args
, **kwargs
):
1884 """FontMapper_GetEncodingName(int encoding) -> String"""
1885 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1887 def FontMapper_GetEncodingDescription(*args
, **kwargs
):
1888 """FontMapper_GetEncodingDescription(int encoding) -> String"""
1889 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1891 def FontMapper_GetEncodingFromName(*args
, **kwargs
):
1892 """FontMapper_GetEncodingFromName(String name) -> int"""
1893 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1895 def FontMapper_GetDefaultConfigPath(*args
):
1896 """FontMapper_GetDefaultConfigPath() -> String"""
1897 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
)
1899 #---------------------------------------------------------------------------
1901 class Font(GDIObject
):
1903 A font is an object which determines the appearance of text. Fonts are
1904 used for drawing text to a device context, and setting the appearance
1907 You can retrieve the current system font settings with `wx.SystemSettings`.
1909 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1910 __repr__
= _swig_repr
1911 def __init__(self
, *args
, **kwargs
):
1913 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
1914 String face=EmptyString,
1915 int encoding=FONTENCODING_DEFAULT) -> Font
1917 Creates a font object with the specified attributes.
1919 :param pointSize: The size of the font in points.
1921 :param family: Font family. A generic way of referring to fonts
1922 without specifying actual facename. It can be One of
1923 the ``wx.FONTFAMILY_xxx`` constants.
1925 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1927 :param weight: Font weight, sometimes also referred to as font
1928 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1930 :param underline: The value can be ``True`` or ``False`` and
1931 indicates whether the font will include an underline. This
1932 may not be supported on all platforms.
1934 :param face: An optional string specifying the actual typeface to
1935 be used. If it is an empty string, a default typeface will be
1936 chosen based on the family.
1938 :param encoding: An encoding which may be one of the
1939 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1940 available, no font is created.
1942 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1943 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1946 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1947 _gdi_
.Font_swiginit(self
,_gdi_
.new_Font(*args
, **kwargs
))
1948 __swig_destroy__
= _gdi_
.delete_Font
1949 __del__
= lambda self
: None;
1950 def Ok(*args
, **kwargs
):
1954 Returns ``True`` if this font was successfully created.
1956 return _gdi_
.Font_Ok(*args
, **kwargs
)
1958 def __nonzero__(self
): return self
.Ok()
1959 def __eq__(*args
, **kwargs
):
1960 """__eq__(self, Font other) -> bool"""
1961 return _gdi_
.Font___eq__(*args
, **kwargs
)
1963 def __ne__(*args
, **kwargs
):
1964 """__ne__(self, Font other) -> bool"""
1965 return _gdi_
.Font___ne__(*args
, **kwargs
)
1967 def GetPointSize(*args
, **kwargs
):
1969 GetPointSize(self) -> int
1971 Gets the point size.
1973 return _gdi_
.Font_GetPointSize(*args
, **kwargs
)
1975 def GetPixelSize(*args
, **kwargs
):
1977 GetPixelSize(self) -> Size
1979 Returns the size in pixels if the font was constructed with a pixel
1982 return _gdi_
.Font_GetPixelSize(*args
, **kwargs
)
1984 def IsUsingSizeInPixels(*args
, **kwargs
):
1986 IsUsingSizeInPixels(self) -> bool
1988 Returns ``True`` if the font is using a pixelSize.
1990 return _gdi_
.Font_IsUsingSizeInPixels(*args
, **kwargs
)
1992 def GetFamily(*args
, **kwargs
):
1994 GetFamily(self) -> int
1996 Gets the font family.
1998 return _gdi_
.Font_GetFamily(*args
, **kwargs
)
2000 def GetStyle(*args
, **kwargs
):
2002 GetStyle(self) -> int
2004 Gets the font style.
2006 return _gdi_
.Font_GetStyle(*args
, **kwargs
)
2008 def GetWeight(*args
, **kwargs
):
2010 GetWeight(self) -> int
2012 Gets the font weight.
2014 return _gdi_
.Font_GetWeight(*args
, **kwargs
)
2016 def GetUnderlined(*args
, **kwargs
):
2018 GetUnderlined(self) -> bool
2020 Returns ``True`` if the font is underlined, ``False`` otherwise.
2022 return _gdi_
.Font_GetUnderlined(*args
, **kwargs
)
2024 def GetFaceName(*args
, **kwargs
):
2026 GetFaceName(self) -> String
2028 Returns the typeface name associated with the font, or the empty
2029 string if there is no typeface information.
2031 return _gdi_
.Font_GetFaceName(*args
, **kwargs
)
2033 def GetEncoding(*args
, **kwargs
):
2035 GetEncoding(self) -> int
2037 Get the font's encoding.
2039 return _gdi_
.Font_GetEncoding(*args
, **kwargs
)
2041 def GetNativeFontInfo(*args
, **kwargs
):
2043 GetNativeFontInfo(self) -> NativeFontInfo
2045 Constructs a `wx.NativeFontInfo` object from this font.
2047 return _gdi_
.Font_GetNativeFontInfo(*args
, **kwargs
)
2049 def IsFixedWidth(*args
, **kwargs
):
2051 IsFixedWidth(self) -> bool
2053 Returns true if the font is a fixed width (or monospaced) font, false
2054 if it is a proportional one or font is invalid.
2056 return _gdi_
.Font_IsFixedWidth(*args
, **kwargs
)
2058 def GetNativeFontInfoDesc(*args
, **kwargs
):
2060 GetNativeFontInfoDesc(self) -> String
2062 Returns the platform-dependent string completely describing this font
2063 or an empty string if the font isn't valid.
2065 return _gdi_
.Font_GetNativeFontInfoDesc(*args
, **kwargs
)
2067 def GetNativeFontInfoUserDesc(*args
, **kwargs
):
2069 GetNativeFontInfoUserDesc(self) -> String
2071 Returns a human readable version of `GetNativeFontInfoDesc`.
2073 return _gdi_
.Font_GetNativeFontInfoUserDesc(*args
, **kwargs
)
2075 def SetPointSize(*args
, **kwargs
):
2077 SetPointSize(self, int pointSize)
2079 Sets the point size.
2081 return _gdi_
.Font_SetPointSize(*args
, **kwargs
)
2083 def SetPixelSize(*args
, **kwargs
):
2085 SetPixelSize(self, Size pixelSize)
2087 Sets the size in pixels rather than points. If there is platform API
2088 support for this then it is used, otherwise a font with the closest
2089 size is found using a binary search.
2091 return _gdi_
.Font_SetPixelSize(*args
, **kwargs
)
2093 def SetFamily(*args
, **kwargs
):
2095 SetFamily(self, int family)
2097 Sets the font family.
2099 return _gdi_
.Font_SetFamily(*args
, **kwargs
)
2101 def SetStyle(*args
, **kwargs
):
2103 SetStyle(self, int style)
2105 Sets the font style.
2107 return _gdi_
.Font_SetStyle(*args
, **kwargs
)
2109 def SetWeight(*args
, **kwargs
):
2111 SetWeight(self, int weight)
2113 Sets the font weight.
2115 return _gdi_
.Font_SetWeight(*args
, **kwargs
)
2117 def SetFaceName(*args
, **kwargs
):
2119 SetFaceName(self, String faceName) -> bool
2121 Sets the facename for the font. The facename, which should be a valid
2122 font installed on the end-user's system.
2124 To avoid portability problems, don't rely on a specific face, but
2125 specify the font family instead or as well. A suitable font will be
2126 found on the end-user's system. If both the family and the facename
2127 are specified, wxWidgets will first search for the specific face, and
2128 then for a font belonging to the same family.
2130 return _gdi_
.Font_SetFaceName(*args
, **kwargs
)
2132 def SetUnderlined(*args
, **kwargs
):
2134 SetUnderlined(self, bool underlined)
2138 return _gdi_
.Font_SetUnderlined(*args
, **kwargs
)
2140 def SetEncoding(*args
, **kwargs
):
2142 SetEncoding(self, int encoding)
2144 Set the font encoding.
2146 return _gdi_
.Font_SetEncoding(*args
, **kwargs
)
2148 def SetNativeFontInfo(*args
, **kwargs
):
2150 SetNativeFontInfo(self, NativeFontInfo info)
2152 Set the font's attributes from a `wx.NativeFontInfo` object.
2154 return _gdi_
.Font_SetNativeFontInfo(*args
, **kwargs
)
2156 def SetNativeFontInfoFromString(*args
, **kwargs
):
2158 SetNativeFontInfoFromString(self, String info) -> bool
2160 Set the font's attributes from string representation of a
2161 `wx.NativeFontInfo` object.
2163 return _gdi_
.Font_SetNativeFontInfoFromString(*args
, **kwargs
)
2165 def SetNativeFontInfoUserDesc(*args
, **kwargs
):
2167 SetNativeFontInfoUserDesc(self, String info) -> bool
2169 Set the font's attributes from a string formerly returned from
2170 `GetNativeFontInfoDesc`.
2172 return _gdi_
.Font_SetNativeFontInfoUserDesc(*args
, **kwargs
)
2174 def GetFamilyString(*args
, **kwargs
):
2176 GetFamilyString(self) -> String
2178 Returns a string representation of the font family.
2180 return _gdi_
.Font_GetFamilyString(*args
, **kwargs
)
2182 def GetStyleString(*args
, **kwargs
):
2184 GetStyleString(self) -> String
2186 Returns a string representation of the font style.
2188 return _gdi_
.Font_GetStyleString(*args
, **kwargs
)
2190 def GetWeightString(*args
, **kwargs
):
2192 GetWeightString(self) -> String
2194 Return a string representation of the font weight.
2196 return _gdi_
.Font_GetWeightString(*args
, **kwargs
)
2198 def SetNoAntiAliasing(*args
, **kwargs
):
2199 """SetNoAntiAliasing(self, bool no=True)"""
2200 return _gdi_
.Font_SetNoAntiAliasing(*args
, **kwargs
)
2202 def GetNoAntiAliasing(*args
, **kwargs
):
2203 """GetNoAntiAliasing(self) -> bool"""
2204 return _gdi_
.Font_GetNoAntiAliasing(*args
, **kwargs
)
2206 def GetDefaultEncoding(*args
, **kwargs
):
2208 GetDefaultEncoding() -> int
2210 Returns the encoding used for all fonts created with an encoding of
2211 ``wx.FONTENCODING_DEFAULT``.
2213 return _gdi_
.Font_GetDefaultEncoding(*args
, **kwargs
)
2215 GetDefaultEncoding
= staticmethod(GetDefaultEncoding
)
2216 def SetDefaultEncoding(*args
, **kwargs
):
2218 SetDefaultEncoding(int encoding)
2220 Sets the default font encoding.
2222 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
2224 SetDefaultEncoding
= staticmethod(SetDefaultEncoding
)
2225 Encoding
= property(GetEncoding
,SetEncoding
,doc
="See `GetEncoding` and `SetEncoding`")
2226 FaceName
= property(GetFaceName
,SetFaceName
,doc
="See `GetFaceName` and `SetFaceName`")
2227 Family
= property(GetFamily
,SetFamily
,doc
="See `GetFamily` and `SetFamily`")
2228 FamilyString
= property(GetFamilyString
,doc
="See `GetFamilyString`")
2229 NativeFontInfo
= property(GetNativeFontInfo
,SetNativeFontInfo
,doc
="See `GetNativeFontInfo` and `SetNativeFontInfo`")
2230 NativeFontInfoDesc
= property(GetNativeFontInfoDesc
,doc
="See `GetNativeFontInfoDesc`")
2231 NativeFontInfoUserDesc
= property(GetNativeFontInfoUserDesc
,SetNativeFontInfoUserDesc
,doc
="See `GetNativeFontInfoUserDesc` and `SetNativeFontInfoUserDesc`")
2232 NoAntiAliasing
= property(GetNoAntiAliasing
,SetNoAntiAliasing
,doc
="See `GetNoAntiAliasing` and `SetNoAntiAliasing`")
2233 PixelSize
= property(GetPixelSize
,SetPixelSize
,doc
="See `GetPixelSize` and `SetPixelSize`")
2234 PointSize
= property(GetPointSize
,SetPointSize
,doc
="See `GetPointSize` and `SetPointSize`")
2235 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
2236 StyleString
= property(GetStyleString
,doc
="See `GetStyleString`")
2237 Underlined
= property(GetUnderlined
,SetUnderlined
,doc
="See `GetUnderlined` and `SetUnderlined`")
2238 Weight
= property(GetWeight
,SetWeight
,doc
="See `GetWeight` and `SetWeight`")
2239 WeightString
= property(GetWeightString
,doc
="See `GetWeightString`")
2240 _gdi_
.Font_swigregister(Font
)
2242 def FontFromNativeInfo(*args
, **kwargs
):
2244 FontFromNativeInfo(NativeFontInfo info) -> Font
2246 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
2248 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2249 val
= _gdi_
.new_FontFromNativeInfo(*args
, **kwargs
)
2252 def FontFromNativeInfoString(*args
, **kwargs
):
2254 FontFromNativeInfoString(String info) -> Font
2256 Construct a `wx.Font` from the string representation of a
2257 `wx.NativeFontInfo` object.
2259 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2260 val
= _gdi_
.new_FontFromNativeInfoString(*args
, **kwargs
)
2263 def FFont(*args
, **kwargs
):
2265 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
2266 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2268 A bit of a simpler way to create a `wx.Font` using flags instead of
2269 individual attribute settings. The value of flags can be a
2270 combination of the following:
2272 ============================ ==
2278 wx.FONTFLAG_ANTIALIASED
2279 wx.FONTFLAG_NOT_ANTIALIASED
2280 wx.FONTFLAG_UNDERLINED
2281 wx.FONTFLAG_STRIKETHROUGH
2282 ============================ ==
2284 :see: `wx.Font.__init__`
2286 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2287 val
= _gdi_
.new_FFont(*args
, **kwargs
)
2290 def FontFromPixelSize(*args
, **kwargs
):
2292 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
2293 bool underlined=False, String face=wxEmptyString,
2294 int encoding=FONTENCODING_DEFAULT) -> Font
2296 Creates a font using a size in pixels rather than points. If there is
2297 platform API support for this then it is used, otherwise a font with
2298 the closest size is found using a binary search.
2300 :see: `wx.Font.__init__`
2302 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2303 val
= _gdi_
.new_FontFromPixelSize(*args
, **kwargs
)
2306 def FFontFromPixelSize(*args
, **kwargs
):
2308 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
2309 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2311 Creates a font using a size in pixels rather than points. If there is
2312 platform API support for this then it is used, otherwise a font with
2313 the closest size is found using a binary search.
2315 :see: `wx.Font.__init__`, `wx.FFont`
2317 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2318 val
= _gdi_
.new_FFontFromPixelSize(*args
, **kwargs
)
2321 def Font_GetDefaultEncoding(*args
):
2323 Font_GetDefaultEncoding() -> int
2325 Returns the encoding used for all fonts created with an encoding of
2326 ``wx.FONTENCODING_DEFAULT``.
2328 return _gdi_
.Font_GetDefaultEncoding(*args
)
2330 def Font_SetDefaultEncoding(*args
, **kwargs
):
2332 Font_SetDefaultEncoding(int encoding)
2334 Sets the default font encoding.
2336 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
2338 Font2
= wx
._deprecated
(FFont
, "Use `wx.FFont` instead.")
2339 #---------------------------------------------------------------------------
2341 class FontEnumerator(object):
2342 """Proxy of C++ FontEnumerator class"""
2343 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2344 __repr__
= _swig_repr
2345 def __init__(self
, *args
, **kwargs
):
2346 """__init__(self) -> FontEnumerator"""
2347 _gdi_
.FontEnumerator_swiginit(self
,_gdi_
.new_FontEnumerator(*args
, **kwargs
))
2348 self
._setCallbackInfo
(self
, FontEnumerator
, 0)
2350 __swig_destroy__
= _gdi_
.delete_FontEnumerator
2351 __del__
= lambda self
: None;
2352 def _setCallbackInfo(*args
, **kwargs
):
2353 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
2354 return _gdi_
.FontEnumerator__setCallbackInfo(*args
, **kwargs
)
2356 def EnumerateFacenames(*args
, **kwargs
):
2357 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
2358 return _gdi_
.FontEnumerator_EnumerateFacenames(*args
, **kwargs
)
2360 def EnumerateEncodings(*args
, **kwargs
):
2361 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
2362 return _gdi_
.FontEnumerator_EnumerateEncodings(*args
, **kwargs
)
2364 def GetEncodings(*args
, **kwargs
):
2365 """GetEncodings() -> PyObject"""
2366 return _gdi_
.FontEnumerator_GetEncodings(*args
, **kwargs
)
2368 GetEncodings
= staticmethod(GetEncodings
)
2369 def GetFacenames(*args
, **kwargs
):
2370 """GetFacenames() -> PyObject"""
2371 return _gdi_
.FontEnumerator_GetFacenames(*args
, **kwargs
)
2373 GetFacenames
= staticmethod(GetFacenames
)
2374 def IsValidFacename(*args
, **kwargs
):
2376 IsValidFacename(String str) -> bool
2378 Convenience function that returns true if the given face name exist in
2381 return _gdi_
.FontEnumerator_IsValidFacename(*args
, **kwargs
)
2383 IsValidFacename
= staticmethod(IsValidFacename
)
2384 _gdi_
.FontEnumerator_swigregister(FontEnumerator
)
2386 def FontEnumerator_GetEncodings(*args
):
2387 """FontEnumerator_GetEncodings() -> PyObject"""
2388 return _gdi_
.FontEnumerator_GetEncodings(*args
)
2390 def FontEnumerator_GetFacenames(*args
):
2391 """FontEnumerator_GetFacenames() -> PyObject"""
2392 return _gdi_
.FontEnumerator_GetFacenames(*args
)
2394 def FontEnumerator_IsValidFacename(*args
, **kwargs
):
2396 FontEnumerator_IsValidFacename(String str) -> bool
2398 Convenience function that returns true if the given face name exist in
2401 return _gdi_
.FontEnumerator_IsValidFacename(*args
, **kwargs
)
2403 #---------------------------------------------------------------------------
2405 Layout_Default
= _gdi_
.Layout_Default
2406 Layout_LeftToRight
= _gdi_
.Layout_LeftToRight
2407 Layout_RightToLeft
= _gdi_
.Layout_RightToLeft
2408 LANGUAGE_DEFAULT
= _gdi_
.LANGUAGE_DEFAULT
2409 LANGUAGE_UNKNOWN
= _gdi_
.LANGUAGE_UNKNOWN
2410 LANGUAGE_ABKHAZIAN
= _gdi_
.LANGUAGE_ABKHAZIAN
2411 LANGUAGE_AFAR
= _gdi_
.LANGUAGE_AFAR
2412 LANGUAGE_AFRIKAANS
= _gdi_
.LANGUAGE_AFRIKAANS
2413 LANGUAGE_ALBANIAN
= _gdi_
.LANGUAGE_ALBANIAN
2414 LANGUAGE_AMHARIC
= _gdi_
.LANGUAGE_AMHARIC
2415 LANGUAGE_ARABIC
= _gdi_
.LANGUAGE_ARABIC
2416 LANGUAGE_ARABIC_ALGERIA
= _gdi_
.LANGUAGE_ARABIC_ALGERIA
2417 LANGUAGE_ARABIC_BAHRAIN
= _gdi_
.LANGUAGE_ARABIC_BAHRAIN
2418 LANGUAGE_ARABIC_EGYPT
= _gdi_
.LANGUAGE_ARABIC_EGYPT
2419 LANGUAGE_ARABIC_IRAQ
= _gdi_
.LANGUAGE_ARABIC_IRAQ
2420 LANGUAGE_ARABIC_JORDAN
= _gdi_
.LANGUAGE_ARABIC_JORDAN
2421 LANGUAGE_ARABIC_KUWAIT
= _gdi_
.LANGUAGE_ARABIC_KUWAIT
2422 LANGUAGE_ARABIC_LEBANON
= _gdi_
.LANGUAGE_ARABIC_LEBANON
2423 LANGUAGE_ARABIC_LIBYA
= _gdi_
.LANGUAGE_ARABIC_LIBYA
2424 LANGUAGE_ARABIC_MOROCCO
= _gdi_
.LANGUAGE_ARABIC_MOROCCO
2425 LANGUAGE_ARABIC_OMAN
= _gdi_
.LANGUAGE_ARABIC_OMAN
2426 LANGUAGE_ARABIC_QATAR
= _gdi_
.LANGUAGE_ARABIC_QATAR
2427 LANGUAGE_ARABIC_SAUDI_ARABIA
= _gdi_
.LANGUAGE_ARABIC_SAUDI_ARABIA
2428 LANGUAGE_ARABIC_SUDAN
= _gdi_
.LANGUAGE_ARABIC_SUDAN
2429 LANGUAGE_ARABIC_SYRIA
= _gdi_
.LANGUAGE_ARABIC_SYRIA
2430 LANGUAGE_ARABIC_TUNISIA
= _gdi_
.LANGUAGE_ARABIC_TUNISIA
2431 LANGUAGE_ARABIC_UAE
= _gdi_
.LANGUAGE_ARABIC_UAE
2432 LANGUAGE_ARABIC_YEMEN
= _gdi_
.LANGUAGE_ARABIC_YEMEN
2433 LANGUAGE_ARMENIAN
= _gdi_
.LANGUAGE_ARMENIAN
2434 LANGUAGE_ASSAMESE
= _gdi_
.LANGUAGE_ASSAMESE
2435 LANGUAGE_AYMARA
= _gdi_
.LANGUAGE_AYMARA
2436 LANGUAGE_AZERI
= _gdi_
.LANGUAGE_AZERI
2437 LANGUAGE_AZERI_CYRILLIC
= _gdi_
.LANGUAGE_AZERI_CYRILLIC
2438 LANGUAGE_AZERI_LATIN
= _gdi_
.LANGUAGE_AZERI_LATIN
2439 LANGUAGE_BASHKIR
= _gdi_
.LANGUAGE_BASHKIR
2440 LANGUAGE_BASQUE
= _gdi_
.LANGUAGE_BASQUE
2441 LANGUAGE_BELARUSIAN
= _gdi_
.LANGUAGE_BELARUSIAN
2442 LANGUAGE_BENGALI
= _gdi_
.LANGUAGE_BENGALI
2443 LANGUAGE_BHUTANI
= _gdi_
.LANGUAGE_BHUTANI
2444 LANGUAGE_BIHARI
= _gdi_
.LANGUAGE_BIHARI
2445 LANGUAGE_BISLAMA
= _gdi_
.LANGUAGE_BISLAMA
2446 LANGUAGE_BRETON
= _gdi_
.LANGUAGE_BRETON
2447 LANGUAGE_BULGARIAN
= _gdi_
.LANGUAGE_BULGARIAN
2448 LANGUAGE_BURMESE
= _gdi_
.LANGUAGE_BURMESE
2449 LANGUAGE_CAMBODIAN
= _gdi_
.LANGUAGE_CAMBODIAN
2450 LANGUAGE_CATALAN
= _gdi_
.LANGUAGE_CATALAN
2451 LANGUAGE_CHINESE
= _gdi_
.LANGUAGE_CHINESE
2452 LANGUAGE_CHINESE_SIMPLIFIED
= _gdi_
.LANGUAGE_CHINESE_SIMPLIFIED
2453 LANGUAGE_CHINESE_TRADITIONAL
= _gdi_
.LANGUAGE_CHINESE_TRADITIONAL
2454 LANGUAGE_CHINESE_HONGKONG
= _gdi_
.LANGUAGE_CHINESE_HONGKONG
2455 LANGUAGE_CHINESE_MACAU
= _gdi_
.LANGUAGE_CHINESE_MACAU
2456 LANGUAGE_CHINESE_SINGAPORE
= _gdi_
.LANGUAGE_CHINESE_SINGAPORE
2457 LANGUAGE_CHINESE_TAIWAN
= _gdi_
.LANGUAGE_CHINESE_TAIWAN
2458 LANGUAGE_CORSICAN
= _gdi_
.LANGUAGE_CORSICAN
2459 LANGUAGE_CROATIAN
= _gdi_
.LANGUAGE_CROATIAN
2460 LANGUAGE_CZECH
= _gdi_
.LANGUAGE_CZECH
2461 LANGUAGE_DANISH
= _gdi_
.LANGUAGE_DANISH
2462 LANGUAGE_DUTCH
= _gdi_
.LANGUAGE_DUTCH
2463 LANGUAGE_DUTCH_BELGIAN
= _gdi_
.LANGUAGE_DUTCH_BELGIAN
2464 LANGUAGE_ENGLISH
= _gdi_
.LANGUAGE_ENGLISH
2465 LANGUAGE_ENGLISH_UK
= _gdi_
.LANGUAGE_ENGLISH_UK
2466 LANGUAGE_ENGLISH_US
= _gdi_
.LANGUAGE_ENGLISH_US
2467 LANGUAGE_ENGLISH_AUSTRALIA
= _gdi_
.LANGUAGE_ENGLISH_AUSTRALIA
2468 LANGUAGE_ENGLISH_BELIZE
= _gdi_
.LANGUAGE_ENGLISH_BELIZE
2469 LANGUAGE_ENGLISH_BOTSWANA
= _gdi_
.LANGUAGE_ENGLISH_BOTSWANA
2470 LANGUAGE_ENGLISH_CANADA
= _gdi_
.LANGUAGE_ENGLISH_CANADA
2471 LANGUAGE_ENGLISH_CARIBBEAN
= _gdi_
.LANGUAGE_ENGLISH_CARIBBEAN
2472 LANGUAGE_ENGLISH_DENMARK
= _gdi_
.LANGUAGE_ENGLISH_DENMARK
2473 LANGUAGE_ENGLISH_EIRE
= _gdi_
.LANGUAGE_ENGLISH_EIRE
2474 LANGUAGE_ENGLISH_JAMAICA
= _gdi_
.LANGUAGE_ENGLISH_JAMAICA
2475 LANGUAGE_ENGLISH_NEW_ZEALAND
= _gdi_
.LANGUAGE_ENGLISH_NEW_ZEALAND
2476 LANGUAGE_ENGLISH_PHILIPPINES
= _gdi_
.LANGUAGE_ENGLISH_PHILIPPINES
2477 LANGUAGE_ENGLISH_SOUTH_AFRICA
= _gdi_
.LANGUAGE_ENGLISH_SOUTH_AFRICA
2478 LANGUAGE_ENGLISH_TRINIDAD
= _gdi_
.LANGUAGE_ENGLISH_TRINIDAD
2479 LANGUAGE_ENGLISH_ZIMBABWE
= _gdi_
.LANGUAGE_ENGLISH_ZIMBABWE
2480 LANGUAGE_ESPERANTO
= _gdi_
.LANGUAGE_ESPERANTO
2481 LANGUAGE_ESTONIAN
= _gdi_
.LANGUAGE_ESTONIAN
2482 LANGUAGE_FAEROESE
= _gdi_
.LANGUAGE_FAEROESE
2483 LANGUAGE_FARSI
= _gdi_
.LANGUAGE_FARSI
2484 LANGUAGE_FIJI
= _gdi_
.LANGUAGE_FIJI
2485 LANGUAGE_FINNISH
= _gdi_
.LANGUAGE_FINNISH
2486 LANGUAGE_FRENCH
= _gdi_
.LANGUAGE_FRENCH
2487 LANGUAGE_FRENCH_BELGIAN
= _gdi_
.LANGUAGE_FRENCH_BELGIAN
2488 LANGUAGE_FRENCH_CANADIAN
= _gdi_
.LANGUAGE_FRENCH_CANADIAN
2489 LANGUAGE_FRENCH_LUXEMBOURG
= _gdi_
.LANGUAGE_FRENCH_LUXEMBOURG
2490 LANGUAGE_FRENCH_MONACO
= _gdi_
.LANGUAGE_FRENCH_MONACO
2491 LANGUAGE_FRENCH_SWISS
= _gdi_
.LANGUAGE_FRENCH_SWISS
2492 LANGUAGE_FRISIAN
= _gdi_
.LANGUAGE_FRISIAN
2493 LANGUAGE_GALICIAN
= _gdi_
.LANGUAGE_GALICIAN
2494 LANGUAGE_GEORGIAN
= _gdi_
.LANGUAGE_GEORGIAN
2495 LANGUAGE_GERMAN
= _gdi_
.LANGUAGE_GERMAN
2496 LANGUAGE_GERMAN_AUSTRIAN
= _gdi_
.LANGUAGE_GERMAN_AUSTRIAN
2497 LANGUAGE_GERMAN_BELGIUM
= _gdi_
.LANGUAGE_GERMAN_BELGIUM
2498 LANGUAGE_GERMAN_LIECHTENSTEIN
= _gdi_
.LANGUAGE_GERMAN_LIECHTENSTEIN
2499 LANGUAGE_GERMAN_LUXEMBOURG
= _gdi_
.LANGUAGE_GERMAN_LUXEMBOURG
2500 LANGUAGE_GERMAN_SWISS
= _gdi_
.LANGUAGE_GERMAN_SWISS
2501 LANGUAGE_GREEK
= _gdi_
.LANGUAGE_GREEK
2502 LANGUAGE_GREENLANDIC
= _gdi_
.LANGUAGE_GREENLANDIC
2503 LANGUAGE_GUARANI
= _gdi_
.LANGUAGE_GUARANI
2504 LANGUAGE_GUJARATI
= _gdi_
.LANGUAGE_GUJARATI
2505 LANGUAGE_HAUSA
= _gdi_
.LANGUAGE_HAUSA
2506 LANGUAGE_HEBREW
= _gdi_
.LANGUAGE_HEBREW
2507 LANGUAGE_HINDI
= _gdi_
.LANGUAGE_HINDI
2508 LANGUAGE_HUNGARIAN
= _gdi_
.LANGUAGE_HUNGARIAN
2509 LANGUAGE_ICELANDIC
= _gdi_
.LANGUAGE_ICELANDIC
2510 LANGUAGE_INDONESIAN
= _gdi_
.LANGUAGE_INDONESIAN
2511 LANGUAGE_INTERLINGUA
= _gdi_
.LANGUAGE_INTERLINGUA
2512 LANGUAGE_INTERLINGUE
= _gdi_
.LANGUAGE_INTERLINGUE
2513 LANGUAGE_INUKTITUT
= _gdi_
.LANGUAGE_INUKTITUT
2514 LANGUAGE_INUPIAK
= _gdi_
.LANGUAGE_INUPIAK
2515 LANGUAGE_IRISH
= _gdi_
.LANGUAGE_IRISH
2516 LANGUAGE_ITALIAN
= _gdi_
.LANGUAGE_ITALIAN
2517 LANGUAGE_ITALIAN_SWISS
= _gdi_
.LANGUAGE_ITALIAN_SWISS
2518 LANGUAGE_JAPANESE
= _gdi_
.LANGUAGE_JAPANESE
2519 LANGUAGE_JAVANESE
= _gdi_
.LANGUAGE_JAVANESE
2520 LANGUAGE_KANNADA
= _gdi_
.LANGUAGE_KANNADA
2521 LANGUAGE_KASHMIRI
= _gdi_
.LANGUAGE_KASHMIRI
2522 LANGUAGE_KASHMIRI_INDIA
= _gdi_
.LANGUAGE_KASHMIRI_INDIA
2523 LANGUAGE_KAZAKH
= _gdi_
.LANGUAGE_KAZAKH
2524 LANGUAGE_KERNEWEK
= _gdi_
.LANGUAGE_KERNEWEK
2525 LANGUAGE_KINYARWANDA
= _gdi_
.LANGUAGE_KINYARWANDA
2526 LANGUAGE_KIRGHIZ
= _gdi_
.LANGUAGE_KIRGHIZ
2527 LANGUAGE_KIRUNDI
= _gdi_
.LANGUAGE_KIRUNDI
2528 LANGUAGE_KONKANI
= _gdi_
.LANGUAGE_KONKANI
2529 LANGUAGE_KOREAN
= _gdi_
.LANGUAGE_KOREAN
2530 LANGUAGE_KURDISH
= _gdi_
.LANGUAGE_KURDISH
2531 LANGUAGE_LAOTHIAN
= _gdi_
.LANGUAGE_LAOTHIAN
2532 LANGUAGE_LATIN
= _gdi_
.LANGUAGE_LATIN
2533 LANGUAGE_LATVIAN
= _gdi_
.LANGUAGE_LATVIAN
2534 LANGUAGE_LINGALA
= _gdi_
.LANGUAGE_LINGALA
2535 LANGUAGE_LITHUANIAN
= _gdi_
.LANGUAGE_LITHUANIAN
2536 LANGUAGE_MACEDONIAN
= _gdi_
.LANGUAGE_MACEDONIAN
2537 LANGUAGE_MALAGASY
= _gdi_
.LANGUAGE_MALAGASY
2538 LANGUAGE_MALAY
= _gdi_
.LANGUAGE_MALAY
2539 LANGUAGE_MALAYALAM
= _gdi_
.LANGUAGE_MALAYALAM
2540 LANGUAGE_MALAY_BRUNEI_DARUSSALAM
= _gdi_
.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2541 LANGUAGE_MALAY_MALAYSIA
= _gdi_
.LANGUAGE_MALAY_MALAYSIA
2542 LANGUAGE_MALTESE
= _gdi_
.LANGUAGE_MALTESE
2543 LANGUAGE_MANIPURI
= _gdi_
.LANGUAGE_MANIPURI
2544 LANGUAGE_MAORI
= _gdi_
.LANGUAGE_MAORI
2545 LANGUAGE_MARATHI
= _gdi_
.LANGUAGE_MARATHI
2546 LANGUAGE_MOLDAVIAN
= _gdi_
.LANGUAGE_MOLDAVIAN
2547 LANGUAGE_MONGOLIAN
= _gdi_
.LANGUAGE_MONGOLIAN
2548 LANGUAGE_NAURU
= _gdi_
.LANGUAGE_NAURU
2549 LANGUAGE_NEPALI
= _gdi_
.LANGUAGE_NEPALI
2550 LANGUAGE_NEPALI_INDIA
= _gdi_
.LANGUAGE_NEPALI_INDIA
2551 LANGUAGE_NORWEGIAN_BOKMAL
= _gdi_
.LANGUAGE_NORWEGIAN_BOKMAL
2552 LANGUAGE_NORWEGIAN_NYNORSK
= _gdi_
.LANGUAGE_NORWEGIAN_NYNORSK
2553 LANGUAGE_OCCITAN
= _gdi_
.LANGUAGE_OCCITAN
2554 LANGUAGE_ORIYA
= _gdi_
.LANGUAGE_ORIYA
2555 LANGUAGE_OROMO
= _gdi_
.LANGUAGE_OROMO
2556 LANGUAGE_PASHTO
= _gdi_
.LANGUAGE_PASHTO
2557 LANGUAGE_POLISH
= _gdi_
.LANGUAGE_POLISH
2558 LANGUAGE_PORTUGUESE
= _gdi_
.LANGUAGE_PORTUGUESE
2559 LANGUAGE_PORTUGUESE_BRAZILIAN
= _gdi_
.LANGUAGE_PORTUGUESE_BRAZILIAN
2560 LANGUAGE_PUNJABI
= _gdi_
.LANGUAGE_PUNJABI
2561 LANGUAGE_QUECHUA
= _gdi_
.LANGUAGE_QUECHUA
2562 LANGUAGE_RHAETO_ROMANCE
= _gdi_
.LANGUAGE_RHAETO_ROMANCE
2563 LANGUAGE_ROMANIAN
= _gdi_
.LANGUAGE_ROMANIAN
2564 LANGUAGE_RUSSIAN
= _gdi_
.LANGUAGE_RUSSIAN
2565 LANGUAGE_RUSSIAN_UKRAINE
= _gdi_
.LANGUAGE_RUSSIAN_UKRAINE
2566 LANGUAGE_SAMOAN
= _gdi_
.LANGUAGE_SAMOAN
2567 LANGUAGE_SANGHO
= _gdi_
.LANGUAGE_SANGHO
2568 LANGUAGE_SANSKRIT
= _gdi_
.LANGUAGE_SANSKRIT
2569 LANGUAGE_SCOTS_GAELIC
= _gdi_
.LANGUAGE_SCOTS_GAELIC
2570 LANGUAGE_SERBIAN
= _gdi_
.LANGUAGE_SERBIAN
2571 LANGUAGE_SERBIAN_CYRILLIC
= _gdi_
.LANGUAGE_SERBIAN_CYRILLIC
2572 LANGUAGE_SERBIAN_LATIN
= _gdi_
.LANGUAGE_SERBIAN_LATIN
2573 LANGUAGE_SERBO_CROATIAN
= _gdi_
.LANGUAGE_SERBO_CROATIAN
2574 LANGUAGE_SESOTHO
= _gdi_
.LANGUAGE_SESOTHO
2575 LANGUAGE_SETSWANA
= _gdi_
.LANGUAGE_SETSWANA
2576 LANGUAGE_SHONA
= _gdi_
.LANGUAGE_SHONA
2577 LANGUAGE_SINDHI
= _gdi_
.LANGUAGE_SINDHI
2578 LANGUAGE_SINHALESE
= _gdi_
.LANGUAGE_SINHALESE
2579 LANGUAGE_SISWATI
= _gdi_
.LANGUAGE_SISWATI
2580 LANGUAGE_SLOVAK
= _gdi_
.LANGUAGE_SLOVAK
2581 LANGUAGE_SLOVENIAN
= _gdi_
.LANGUAGE_SLOVENIAN
2582 LANGUAGE_SOMALI
= _gdi_
.LANGUAGE_SOMALI
2583 LANGUAGE_SPANISH
= _gdi_
.LANGUAGE_SPANISH
2584 LANGUAGE_SPANISH_ARGENTINA
= _gdi_
.LANGUAGE_SPANISH_ARGENTINA
2585 LANGUAGE_SPANISH_BOLIVIA
= _gdi_
.LANGUAGE_SPANISH_BOLIVIA
2586 LANGUAGE_SPANISH_CHILE
= _gdi_
.LANGUAGE_SPANISH_CHILE
2587 LANGUAGE_SPANISH_COLOMBIA
= _gdi_
.LANGUAGE_SPANISH_COLOMBIA
2588 LANGUAGE_SPANISH_COSTA_RICA
= _gdi_
.LANGUAGE_SPANISH_COSTA_RICA
2589 LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
= _gdi_
.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2590 LANGUAGE_SPANISH_ECUADOR
= _gdi_
.LANGUAGE_SPANISH_ECUADOR
2591 LANGUAGE_SPANISH_EL_SALVADOR
= _gdi_
.LANGUAGE_SPANISH_EL_SALVADOR
2592 LANGUAGE_SPANISH_GUATEMALA
= _gdi_
.LANGUAGE_SPANISH_GUATEMALA
2593 LANGUAGE_SPANISH_HONDURAS
= _gdi_
.LANGUAGE_SPANISH_HONDURAS
2594 LANGUAGE_SPANISH_MEXICAN
= _gdi_
.LANGUAGE_SPANISH_MEXICAN
2595 LANGUAGE_SPANISH_MODERN
= _gdi_
.LANGUAGE_SPANISH_MODERN
2596 LANGUAGE_SPANISH_NICARAGUA
= _gdi_
.LANGUAGE_SPANISH_NICARAGUA
2597 LANGUAGE_SPANISH_PANAMA
= _gdi_
.LANGUAGE_SPANISH_PANAMA
2598 LANGUAGE_SPANISH_PARAGUAY
= _gdi_
.LANGUAGE_SPANISH_PARAGUAY
2599 LANGUAGE_SPANISH_PERU
= _gdi_
.LANGUAGE_SPANISH_PERU
2600 LANGUAGE_SPANISH_PUERTO_RICO
= _gdi_
.LANGUAGE_SPANISH_PUERTO_RICO
2601 LANGUAGE_SPANISH_URUGUAY
= _gdi_
.LANGUAGE_SPANISH_URUGUAY
2602 LANGUAGE_SPANISH_US
= _gdi_
.LANGUAGE_SPANISH_US
2603 LANGUAGE_SPANISH_VENEZUELA
= _gdi_
.LANGUAGE_SPANISH_VENEZUELA
2604 LANGUAGE_SUNDANESE
= _gdi_
.LANGUAGE_SUNDANESE
2605 LANGUAGE_SWAHILI
= _gdi_
.LANGUAGE_SWAHILI
2606 LANGUAGE_SWEDISH
= _gdi_
.LANGUAGE_SWEDISH
2607 LANGUAGE_SWEDISH_FINLAND
= _gdi_
.LANGUAGE_SWEDISH_FINLAND
2608 LANGUAGE_TAGALOG
= _gdi_
.LANGUAGE_TAGALOG
2609 LANGUAGE_TAJIK
= _gdi_
.LANGUAGE_TAJIK
2610 LANGUAGE_TAMIL
= _gdi_
.LANGUAGE_TAMIL
2611 LANGUAGE_TATAR
= _gdi_
.LANGUAGE_TATAR
2612 LANGUAGE_TELUGU
= _gdi_
.LANGUAGE_TELUGU
2613 LANGUAGE_THAI
= _gdi_
.LANGUAGE_THAI
2614 LANGUAGE_TIBETAN
= _gdi_
.LANGUAGE_TIBETAN
2615 LANGUAGE_TIGRINYA
= _gdi_
.LANGUAGE_TIGRINYA
2616 LANGUAGE_TONGA
= _gdi_
.LANGUAGE_TONGA
2617 LANGUAGE_TSONGA
= _gdi_
.LANGUAGE_TSONGA
2618 LANGUAGE_TURKISH
= _gdi_
.LANGUAGE_TURKISH
2619 LANGUAGE_TURKMEN
= _gdi_
.LANGUAGE_TURKMEN
2620 LANGUAGE_TWI
= _gdi_
.LANGUAGE_TWI
2621 LANGUAGE_UIGHUR
= _gdi_
.LANGUAGE_UIGHUR
2622 LANGUAGE_UKRAINIAN
= _gdi_
.LANGUAGE_UKRAINIAN
2623 LANGUAGE_URDU
= _gdi_
.LANGUAGE_URDU
2624 LANGUAGE_URDU_INDIA
= _gdi_
.LANGUAGE_URDU_INDIA
2625 LANGUAGE_URDU_PAKISTAN
= _gdi_
.LANGUAGE_URDU_PAKISTAN
2626 LANGUAGE_UZBEK
= _gdi_
.LANGUAGE_UZBEK
2627 LANGUAGE_UZBEK_CYRILLIC
= _gdi_
.LANGUAGE_UZBEK_CYRILLIC
2628 LANGUAGE_UZBEK_LATIN
= _gdi_
.LANGUAGE_UZBEK_LATIN
2629 LANGUAGE_VIETNAMESE
= _gdi_
.LANGUAGE_VIETNAMESE
2630 LANGUAGE_VOLAPUK
= _gdi_
.LANGUAGE_VOLAPUK
2631 LANGUAGE_WELSH
= _gdi_
.LANGUAGE_WELSH
2632 LANGUAGE_WOLOF
= _gdi_
.LANGUAGE_WOLOF
2633 LANGUAGE_XHOSA
= _gdi_
.LANGUAGE_XHOSA
2634 LANGUAGE_YIDDISH
= _gdi_
.LANGUAGE_YIDDISH
2635 LANGUAGE_YORUBA
= _gdi_
.LANGUAGE_YORUBA
2636 LANGUAGE_ZHUANG
= _gdi_
.LANGUAGE_ZHUANG
2637 LANGUAGE_ZULU
= _gdi_
.LANGUAGE_ZULU
2638 LANGUAGE_USER_DEFINED
= _gdi_
.LANGUAGE_USER_DEFINED
2639 class LanguageInfo(object):
2640 """Proxy of C++ LanguageInfo class"""
2641 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2642 def __init__(self
): raise AttributeError, "No constructor defined"
2643 __repr__
= _swig_repr
2644 Language
= property(_gdi_
.LanguageInfo_Language_get
, _gdi_
.LanguageInfo_Language_set
)
2645 CanonicalName
= property(_gdi_
.LanguageInfo_CanonicalName_get
, _gdi_
.LanguageInfo_CanonicalName_set
)
2646 Description
= property(_gdi_
.LanguageInfo_Description_get
, _gdi_
.LanguageInfo_Description_set
)
2647 _gdi_
.LanguageInfo_swigregister(LanguageInfo
)
2649 LOCALE_CAT_NUMBER
= _gdi_
.LOCALE_CAT_NUMBER
2650 LOCALE_CAT_DATE
= _gdi_
.LOCALE_CAT_DATE
2651 LOCALE_CAT_MONEY
= _gdi_
.LOCALE_CAT_MONEY
2652 LOCALE_CAT_MAX
= _gdi_
.LOCALE_CAT_MAX
2653 LOCALE_THOUSANDS_SEP
= _gdi_
.LOCALE_THOUSANDS_SEP
2654 LOCALE_DECIMAL_POINT
= _gdi_
.LOCALE_DECIMAL_POINT
2655 LOCALE_LOAD_DEFAULT
= _gdi_
.LOCALE_LOAD_DEFAULT
2656 LOCALE_CONV_ENCODING
= _gdi_
.LOCALE_CONV_ENCODING
2657 class Locale(object):
2658 """Proxy of C++ Locale class"""
2659 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2660 __repr__
= _swig_repr
2661 def __init__(self
, *args
, **kwargs
):
2662 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
2663 _gdi_
.Locale_swiginit(self
,_gdi_
.new_Locale(*args
, **kwargs
))
2664 __swig_destroy__
= _gdi_
.delete_Locale
2665 __del__
= lambda self
: None;
2666 def Init1(*args
, **kwargs
):
2668 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2669 bool bLoadDefault=True,
2670 bool bConvertEncoding=False) -> bool
2672 return _gdi_
.Locale_Init1(*args
, **kwargs
)
2674 def Init2(*args
, **kwargs
):
2675 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2676 return _gdi_
.Locale_Init2(*args
, **kwargs
)
2678 def Init(self
, *_args
, **_kwargs
):
2679 if type(_args
[0]) in [type(''), type(u
'')]:
2680 val
= self
.Init1(*_args
, **_kwargs
)
2682 val
= self
.Init2(*_args
, **_kwargs
)
2685 def GetSystemLanguage(*args
, **kwargs
):
2686 """GetSystemLanguage() -> int"""
2687 return _gdi_
.Locale_GetSystemLanguage(*args
, **kwargs
)
2689 GetSystemLanguage
= staticmethod(GetSystemLanguage
)
2690 def GetSystemEncoding(*args
, **kwargs
):
2691 """GetSystemEncoding() -> int"""
2692 return _gdi_
.Locale_GetSystemEncoding(*args
, **kwargs
)
2694 GetSystemEncoding
= staticmethod(GetSystemEncoding
)
2695 def GetSystemEncodingName(*args
, **kwargs
):
2696 """GetSystemEncodingName() -> String"""
2697 return _gdi_
.Locale_GetSystemEncodingName(*args
, **kwargs
)
2699 GetSystemEncodingName
= staticmethod(GetSystemEncodingName
)
2700 def IsOk(*args
, **kwargs
):
2701 """IsOk(self) -> bool"""
2702 return _gdi_
.Locale_IsOk(*args
, **kwargs
)
2704 def __nonzero__(self
): return self
.IsOk()
2705 def GetLocale(*args
, **kwargs
):
2706 """GetLocale(self) -> String"""
2707 return _gdi_
.Locale_GetLocale(*args
, **kwargs
)
2709 def GetLanguage(*args
, **kwargs
):
2710 """GetLanguage(self) -> int"""
2711 return _gdi_
.Locale_GetLanguage(*args
, **kwargs
)
2713 def GetSysName(*args
, **kwargs
):
2714 """GetSysName(self) -> String"""
2715 return _gdi_
.Locale_GetSysName(*args
, **kwargs
)
2717 def GetCanonicalName(*args
, **kwargs
):
2718 """GetCanonicalName(self) -> String"""
2719 return _gdi_
.Locale_GetCanonicalName(*args
, **kwargs
)
2721 def AddCatalogLookupPathPrefix(*args
, **kwargs
):
2722 """AddCatalogLookupPathPrefix(String prefix)"""
2723 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2725 AddCatalogLookupPathPrefix
= staticmethod(AddCatalogLookupPathPrefix
)
2726 def AddCatalog(*args
, **kwargs
):
2727 """AddCatalog(self, String szDomain) -> bool"""
2728 return _gdi_
.Locale_AddCatalog(*args
, **kwargs
)
2730 def IsLoaded(*args
, **kwargs
):
2731 """IsLoaded(self, String szDomain) -> bool"""
2732 return _gdi_
.Locale_IsLoaded(*args
, **kwargs
)
2734 def GetLanguageInfo(*args
, **kwargs
):
2735 """GetLanguageInfo(int lang) -> LanguageInfo"""
2736 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2738 GetLanguageInfo
= staticmethod(GetLanguageInfo
)
2739 def GetLanguageName(*args
, **kwargs
):
2740 """GetLanguageName(int lang) -> String"""
2741 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2743 GetLanguageName
= staticmethod(GetLanguageName
)
2744 def FindLanguageInfo(*args
, **kwargs
):
2745 """FindLanguageInfo(String locale) -> LanguageInfo"""
2746 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2748 FindLanguageInfo
= staticmethod(FindLanguageInfo
)
2749 def AddLanguage(*args
, **kwargs
):
2750 """AddLanguage(LanguageInfo info)"""
2751 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2753 AddLanguage
= staticmethod(AddLanguage
)
2754 def GetString(*args
, **kwargs
):
2755 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2756 return _gdi_
.Locale_GetString(*args
, **kwargs
)
2758 def GetName(*args
, **kwargs
):
2759 """GetName(self) -> String"""
2760 return _gdi_
.Locale_GetName(*args
, **kwargs
)
2762 CanonicalName
= property(GetCanonicalName
,doc
="See `GetCanonicalName`")
2763 Language
= property(GetLanguage
,doc
="See `GetLanguage`")
2764 Locale
= property(GetLocale
,doc
="See `GetLocale`")
2765 Name
= property(GetName
,doc
="See `GetName`")
2766 String
= property(GetString
,doc
="See `GetString`")
2767 SysName
= property(GetSysName
,doc
="See `GetSysName`")
2768 _gdi_
.Locale_swigregister(Locale
)
2770 def Locale_GetSystemLanguage(*args
):
2771 """Locale_GetSystemLanguage() -> int"""
2772 return _gdi_
.Locale_GetSystemLanguage(*args
)
2774 def Locale_GetSystemEncoding(*args
):
2775 """Locale_GetSystemEncoding() -> int"""
2776 return _gdi_
.Locale_GetSystemEncoding(*args
)
2778 def Locale_GetSystemEncodingName(*args
):
2779 """Locale_GetSystemEncodingName() -> String"""
2780 return _gdi_
.Locale_GetSystemEncodingName(*args
)
2782 def Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
):
2783 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2784 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2786 def Locale_GetLanguageInfo(*args
, **kwargs
):
2787 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2788 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2790 def Locale_GetLanguageName(*args
, **kwargs
):
2791 """Locale_GetLanguageName(int lang) -> String"""
2792 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2794 def Locale_FindLanguageInfo(*args
, **kwargs
):
2795 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2796 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2798 def Locale_AddLanguage(*args
, **kwargs
):
2799 """Locale_AddLanguage(LanguageInfo info)"""
2800 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2802 class PyLocale(Locale
):
2803 """Proxy of C++ PyLocale class"""
2804 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2805 __repr__
= _swig_repr
2806 def __init__(self
, *args
, **kwargs
):
2807 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale"""
2808 _gdi_
.PyLocale_swiginit(self
,_gdi_
.new_PyLocale(*args
, **kwargs
))
2809 self
._setCallbackInfo
(self
, PyLocale
)
2811 __swig_destroy__
= _gdi_
.delete_PyLocale
2812 __del__
= lambda self
: None;
2813 def _setCallbackInfo(*args
, **kwargs
):
2814 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2815 return _gdi_
.PyLocale__setCallbackInfo(*args
, **kwargs
)
2817 def GetSingularString(*args
, **kwargs
):
2818 """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar"""
2819 return _gdi_
.PyLocale_GetSingularString(*args
, **kwargs
)
2821 def GetPluralString(*args
, **kwargs
):
2823 GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n,
2824 wxChar szDomain=None) -> wxChar
2826 return _gdi_
.PyLocale_GetPluralString(*args
, **kwargs
)
2828 _gdi_
.PyLocale_swigregister(PyLocale
)
2831 def GetLocale(*args
):
2832 """GetLocale() -> Locale"""
2833 return _gdi_
.GetLocale(*args
)
2834 #---------------------------------------------------------------------------
2836 CONVERT_STRICT
= _gdi_
.CONVERT_STRICT
2837 CONVERT_SUBSTITUTE
= _gdi_
.CONVERT_SUBSTITUTE
2838 PLATFORM_CURRENT
= _gdi_
.PLATFORM_CURRENT
2839 PLATFORM_UNIX
= _gdi_
.PLATFORM_UNIX
2840 PLATFORM_WINDOWS
= _gdi_
.PLATFORM_WINDOWS
2841 PLATFORM_OS2
= _gdi_
.PLATFORM_OS2
2842 PLATFORM_MAC
= _gdi_
.PLATFORM_MAC
2843 class EncodingConverter(_core
.Object
):
2844 """Proxy of C++ EncodingConverter class"""
2845 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2846 __repr__
= _swig_repr
2847 def __init__(self
, *args
, **kwargs
):
2848 """__init__(self) -> EncodingConverter"""
2849 _gdi_
.EncodingConverter_swiginit(self
,_gdi_
.new_EncodingConverter(*args
, **kwargs
))
2850 __swig_destroy__
= _gdi_
.delete_EncodingConverter
2851 __del__
= lambda self
: None;
2852 def Init(*args
, **kwargs
):
2853 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2854 return _gdi_
.EncodingConverter_Init(*args
, **kwargs
)
2856 def Convert(*args
, **kwargs
):
2857 """Convert(self, String input) -> String"""
2858 return _gdi_
.EncodingConverter_Convert(*args
, **kwargs
)
2860 def GetPlatformEquivalents(*args
, **kwargs
):
2861 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2862 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2864 GetPlatformEquivalents
= staticmethod(GetPlatformEquivalents
)
2865 def GetAllEquivalents(*args
, **kwargs
):
2866 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2867 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2869 GetAllEquivalents
= staticmethod(GetAllEquivalents
)
2870 def CanConvert(*args
, **kwargs
):
2871 """CanConvert(int encIn, int encOut) -> bool"""
2872 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2874 CanConvert
= staticmethod(CanConvert
)
2875 def __nonzero__(self
): return self
.IsOk()
2876 _gdi_
.EncodingConverter_swigregister(EncodingConverter
)
2878 def GetTranslation(*args
):
2880 GetTranslation(String str) -> String
2881 GetTranslation(String str, String domain) -> String
2882 GetTranslation(String str, String strPlural, size_t n) -> String
2883 GetTranslation(String str, String strPlural, size_t n, String domain) -> String
2885 return _gdi_
.GetTranslation(*args
)
2887 def EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
):
2888 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2889 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2891 def EncodingConverter_GetAllEquivalents(*args
, **kwargs
):
2892 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2893 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2895 def EncodingConverter_CanConvert(*args
, **kwargs
):
2896 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2897 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2899 #----------------------------------------------------------------------------
2900 # On MSW add the directory where the wxWidgets catalogs were installed
2901 # to the default catalog path.
2902 if wx
.Platform
== "__WXMSW__":
2904 _localedir
= os
.path
.join(os
.path
.split(__file__
)[0], "i18n")
2905 Locale
.AddCatalogLookupPathPrefix(_localedir
)
2908 #----------------------------------------------------------------------------
2910 #---------------------------------------------------------------------------
2912 class DC(_core
.Object
):
2914 A wx.DC is a device context onto which graphics and text can be
2915 drawn. It is intended to represent a number of output devices in a
2916 generic way, so a window can have a device context associated with it,
2917 and a printer also has a device context. In this way, the same piece
2918 of code may write to a number of different devices, if the device
2919 context is used as a parameter.
2921 Derived types of wxDC have documentation for specific features only,
2922 so refer to this section for most device context information.
2924 The wx.DC class is abstract and can not be instantiated, you must use
2925 one of the derived classes instead. Which one will depend on the
2926 situation in which it is used.
2928 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2929 def __init__(self
): raise AttributeError, "No constructor defined"
2930 __repr__
= _swig_repr
2931 __swig_destroy__
= _gdi_
.delete_DC
2932 __del__
= lambda self
: None;
2933 # These have been deprecated in wxWidgets. Since they never
2934 # really did anything to begin with, just make them be NOPs.
2935 def BeginDrawing(self
): pass
2936 def EndDrawing(self
): pass
2938 def FloodFill(*args
, **kwargs
):
2940 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2942 Flood fills the device context starting from the given point, using
2943 the current brush colour, and using a style:
2945 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2946 the given colour is encountered.
2948 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2951 Returns False if the operation failed.
2953 Note: The present implementation for non-Windows platforms may fail to
2954 find colour borders if the pixels do not match the colour
2955 exactly. However the function will still return true.
2957 return _gdi_
.DC_FloodFill(*args
, **kwargs
)
2959 def FloodFillPoint(*args
, **kwargs
):
2961 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2963 Flood fills the device context starting from the given point, using
2964 the current brush colour, and using a style:
2966 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2967 the given colour is encountered.
2969 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2972 Returns False if the operation failed.
2974 Note: The present implementation for non-Windows platforms may fail to
2975 find colour borders if the pixels do not match the colour
2976 exactly. However the function will still return true.
2978 return _gdi_
.DC_FloodFillPoint(*args
, **kwargs
)
2980 def GradientFillConcentric(*args
, **kwargs
):
2982 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2985 Fill the area specified by rect with a radial gradient, starting from
2986 initialColour in the center of the circle and fading to destColour on
2987 the outside of the circle. The circleCenter argument is the relative
2988 coordinants of the center of the circle in the specified rect.
2990 Note: Currently this function is very slow, don't use it for real-time
2993 return _gdi_
.DC_GradientFillConcentric(*args
, **kwargs
)
2995 def GradientFillLinear(*args
, **kwargs
):
2997 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2998 int nDirection=EAST)
3000 Fill the area specified by rect with a linear gradient, starting from
3001 initialColour and eventually fading to destColour. The nDirection
3002 parameter specifies the direction of the colour change, default is to
3003 use initialColour on the left part of the rectangle and destColour on
3006 return _gdi_
.DC_GradientFillLinear(*args
, **kwargs
)
3008 def GetPixel(*args
, **kwargs
):
3010 GetPixel(self, int x, int y) -> Colour
3012 Gets the colour at the specified location on the DC.
3014 return _gdi_
.DC_GetPixel(*args
, **kwargs
)
3016 def GetPixelPoint(*args
, **kwargs
):
3017 """GetPixelPoint(self, Point pt) -> Colour"""
3018 return _gdi_
.DC_GetPixelPoint(*args
, **kwargs
)
3020 def DrawLine(*args
, **kwargs
):
3022 DrawLine(self, int x1, int y1, int x2, int y2)
3024 Draws a line from the first point to the second. The current pen is
3025 used for drawing the line. Note that the second point is *not* part of
3026 the line and is not drawn by this function (this is consistent with
3027 the behaviour of many other toolkits).
3029 return _gdi_
.DC_DrawLine(*args
, **kwargs
)
3031 def DrawLinePoint(*args
, **kwargs
):
3033 DrawLinePoint(self, Point pt1, Point pt2)
3035 Draws a line from the first point to the second. The current pen is
3036 used for drawing the line. Note that the second point is *not* part of
3037 the line and is not drawn by this function (this is consistent with
3038 the behaviour of many other toolkits).
3040 return _gdi_
.DC_DrawLinePoint(*args
, **kwargs
)
3042 def CrossHair(*args
, **kwargs
):
3044 CrossHair(self, int x, int y)
3046 Displays a cross hair using the current pen. This is a vertical and
3047 horizontal line the height and width of the window, centred on the
3050 return _gdi_
.DC_CrossHair(*args
, **kwargs
)
3052 def CrossHairPoint(*args
, **kwargs
):
3054 CrossHairPoint(self, Point pt)
3056 Displays a cross hair using the current pen. This is a vertical and
3057 horizontal line the height and width of the window, centred on the
3060 return _gdi_
.DC_CrossHairPoint(*args
, **kwargs
)
3062 def DrawArc(*args
, **kwargs
):
3064 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
3066 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3067 the first point to the second. The current pen is used for the outline
3068 and the current brush for filling the shape.
3070 The arc is drawn in an anticlockwise direction from the start point to
3073 return _gdi_
.DC_DrawArc(*args
, **kwargs
)
3075 def DrawArcPoint(*args
, **kwargs
):
3077 DrawArcPoint(self, Point pt1, Point pt2, Point center)
3079 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3080 the first point to the second. The current pen is used for the outline
3081 and the current brush for filling the shape.
3083 The arc is drawn in an anticlockwise direction from the start point to
3086 return _gdi_
.DC_DrawArcPoint(*args
, **kwargs
)
3088 def DrawCheckMark(*args
, **kwargs
):
3090 DrawCheckMark(self, int x, int y, int width, int height)
3092 Draws a check mark inside the given rectangle.
3094 return _gdi_
.DC_DrawCheckMark(*args
, **kwargs
)
3096 def DrawCheckMarkRect(*args
, **kwargs
):
3098 DrawCheckMarkRect(self, Rect rect)
3100 Draws a check mark inside the given rectangle.
3102 return _gdi_
.DC_DrawCheckMarkRect(*args
, **kwargs
)
3104 def DrawEllipticArc(*args
, **kwargs
):
3106 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
3108 Draws an arc of an ellipse, with the given rectangle defining the
3109 bounds of the ellipse. The current pen is used for drawing the arc and
3110 the current brush is used for drawing the pie.
3112 The *start* and *end* parameters specify the start and end of the arc
3113 relative to the three-o'clock position from the center of the
3114 rectangle. Angles are specified in degrees (360 is a complete
3115 circle). Positive values mean counter-clockwise motion. If start is
3116 equal to end, a complete ellipse will be drawn.
3118 return _gdi_
.DC_DrawEllipticArc(*args
, **kwargs
)
3120 def DrawEllipticArcPointSize(*args
, **kwargs
):
3122 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
3124 Draws an arc of an ellipse, with the given rectangle defining the
3125 bounds of the ellipse. The current pen is used for drawing the arc and
3126 the current brush is used for drawing the pie.
3128 The *start* and *end* parameters specify the start and end of the arc
3129 relative to the three-o'clock position from the center of the
3130 rectangle. Angles are specified in degrees (360 is a complete
3131 circle). Positive values mean counter-clockwise motion. If start is
3132 equal to end, a complete ellipse will be drawn.
3134 return _gdi_
.DC_DrawEllipticArcPointSize(*args
, **kwargs
)
3136 def DrawPoint(*args
, **kwargs
):
3138 DrawPoint(self, int x, int y)
3140 Draws a point using the current pen.
3142 return _gdi_
.DC_DrawPoint(*args
, **kwargs
)
3144 def DrawPointPoint(*args
, **kwargs
):
3146 DrawPointPoint(self, Point pt)
3148 Draws a point using the current pen.
3150 return _gdi_
.DC_DrawPointPoint(*args
, **kwargs
)
3152 def DrawRectangle(*args
, **kwargs
):
3154 DrawRectangle(self, int x, int y, int width, int height)
3156 Draws a rectangle with the given top left corner, and with the given
3157 size. The current pen is used for the outline and the current brush
3158 for filling the shape.
3160 return _gdi_
.DC_DrawRectangle(*args
, **kwargs
)
3162 def DrawRectangleRect(*args
, **kwargs
):
3164 DrawRectangleRect(self, Rect rect)
3166 Draws a rectangle with the given top left corner, and with the given
3167 size. The current pen is used for the outline and the current brush
3168 for filling the shape.
3170 return _gdi_
.DC_DrawRectangleRect(*args
, **kwargs
)
3172 def DrawRectanglePointSize(*args
, **kwargs
):
3174 DrawRectanglePointSize(self, Point pt, Size sz)
3176 Draws a rectangle with the given top left corner, and with the given
3177 size. The current pen is used for the outline and the current brush
3178 for filling the shape.
3180 return _gdi_
.DC_DrawRectanglePointSize(*args
, **kwargs
)
3182 def DrawRoundedRectangle(*args
, **kwargs
):
3184 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
3186 Draws a rectangle with the given top left corner, and with the given
3187 size. The corners are quarter-circles using the given radius. The
3188 current pen is used for the outline and the current brush for filling
3191 If radius is positive, the value is assumed to be the radius of the
3192 rounded corner. If radius is negative, the absolute value is assumed
3193 to be the proportion of the smallest dimension of the rectangle. This
3194 means that the corner can be a sensible size relative to the size of
3195 the rectangle, and also avoids the strange effects X produces when the
3196 corners are too big for the rectangle.
3198 return _gdi_
.DC_DrawRoundedRectangle(*args
, **kwargs
)
3200 def DrawRoundedRectangleRect(*args
, **kwargs
):
3202 DrawRoundedRectangleRect(self, Rect r, double radius)
3204 Draws a rectangle with the given top left corner, and with the given
3205 size. The corners are quarter-circles using the given radius. The
3206 current pen is used for the outline and the current brush for filling
3209 If radius is positive, the value is assumed to be the radius of the
3210 rounded corner. If radius is negative, the absolute value is assumed
3211 to be the proportion of the smallest dimension of the rectangle. This
3212 means that the corner can be a sensible size relative to the size of
3213 the rectangle, and also avoids the strange effects X produces when the
3214 corners are too big for the rectangle.
3216 return _gdi_
.DC_DrawRoundedRectangleRect(*args
, **kwargs
)
3218 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
3220 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
3222 Draws a rectangle with the given top left corner, and with the given
3223 size. The corners are quarter-circles using the given radius. The
3224 current pen is used for the outline and the current brush for filling
3227 If radius is positive, the value is assumed to be the radius of the
3228 rounded corner. If radius is negative, the absolute value is assumed
3229 to be the proportion of the smallest dimension of the rectangle. This
3230 means that the corner can be a sensible size relative to the size of
3231 the rectangle, and also avoids the strange effects X produces when the
3232 corners are too big for the rectangle.
3234 return _gdi_
.DC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
3236 def DrawCircle(*args
, **kwargs
):
3238 DrawCircle(self, int x, int y, int radius)
3240 Draws a circle with the given center point and radius. The current
3241 pen is used for the outline and the current brush for filling the
3244 return _gdi_
.DC_DrawCircle(*args
, **kwargs
)
3246 def DrawCirclePoint(*args
, **kwargs
):
3248 DrawCirclePoint(self, Point pt, int radius)
3250 Draws a circle with the given center point and radius. The current
3251 pen is used for the outline and the current brush for filling the
3254 return _gdi_
.DC_DrawCirclePoint(*args
, **kwargs
)
3256 def DrawEllipse(*args
, **kwargs
):
3258 DrawEllipse(self, int x, int y, int width, int height)
3260 Draws an ellipse contained in the specified rectangle. The current pen
3261 is used for the outline and the current brush for filling the shape.
3263 return _gdi_
.DC_DrawEllipse(*args
, **kwargs
)
3265 def DrawEllipseRect(*args
, **kwargs
):
3267 DrawEllipseRect(self, Rect rect)
3269 Draws an ellipse contained in the specified rectangle. The current pen
3270 is used for the outline and the current brush for filling the shape.
3272 return _gdi_
.DC_DrawEllipseRect(*args
, **kwargs
)
3274 def DrawEllipsePointSize(*args
, **kwargs
):
3276 DrawEllipsePointSize(self, Point pt, Size sz)
3278 Draws an ellipse contained in the specified rectangle. The current pen
3279 is used for the outline and the current brush for filling the shape.
3281 return _gdi_
.DC_DrawEllipsePointSize(*args
, **kwargs
)
3283 def DrawIcon(*args
, **kwargs
):
3285 DrawIcon(self, Icon icon, int x, int y)
3287 Draw an icon on the display (does nothing if the device context is
3288 PostScript). This can be the simplest way of drawing bitmaps on a
3291 return _gdi_
.DC_DrawIcon(*args
, **kwargs
)
3293 def DrawIconPoint(*args
, **kwargs
):
3295 DrawIconPoint(self, Icon icon, Point pt)
3297 Draw an icon on the display (does nothing if the device context is
3298 PostScript). This can be the simplest way of drawing bitmaps on a
3301 return _gdi_
.DC_DrawIconPoint(*args
, **kwargs
)
3303 def DrawBitmap(*args
, **kwargs
):
3305 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
3307 Draw a bitmap on the device context at the specified point. If
3308 *transparent* is true and the bitmap has a transparency mask, (or
3309 alpha channel on the platforms that support it) then the bitmap will
3310 be drawn transparently.
3312 return _gdi_
.DC_DrawBitmap(*args
, **kwargs
)
3314 def DrawBitmapPoint(*args
, **kwargs
):
3316 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3318 Draw a bitmap on the device context at the specified point. If
3319 *transparent* is true and the bitmap has a transparency mask, (or
3320 alpha channel on the platforms that support it) then the bitmap will
3321 be drawn transparently.
3323 return _gdi_
.DC_DrawBitmapPoint(*args
, **kwargs
)
3325 def DrawText(*args
, **kwargs
):
3327 DrawText(self, String text, int x, int y)
3329 Draws a text string at the specified point, using the current text
3330 font, and the current text foreground and background colours.
3332 The coordinates refer to the top-left corner of the rectangle bounding
3333 the string. See `GetTextExtent` for how to get the dimensions of a
3334 text string, which can be used to position the text more precisely.
3336 **NOTE**: under wxGTK the current logical function is used by this
3337 function but it is ignored by wxMSW. Thus, you should avoid using
3338 logical functions with this function in portable programs.
3340 return _gdi_
.DC_DrawText(*args
, **kwargs
)
3342 def DrawTextPoint(*args
, **kwargs
):
3344 DrawTextPoint(self, String text, Point pt)
3346 Draws a text string at the specified point, using the current text
3347 font, and the current text foreground and background colours.
3349 The coordinates refer to the top-left corner of the rectangle bounding
3350 the string. See `GetTextExtent` for how to get the dimensions of a
3351 text string, which can be used to position the text more precisely.
3353 **NOTE**: under wxGTK the current logical function is used by this
3354 function but it is ignored by wxMSW. Thus, you should avoid using
3355 logical functions with this function in portable programs.
3357 return _gdi_
.DC_DrawTextPoint(*args
, **kwargs
)
3359 def DrawRotatedText(*args
, **kwargs
):
3361 DrawRotatedText(self, String text, int x, int y, double angle)
3363 Draws the text rotated by *angle* degrees, if supported by the platform.
3365 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3366 function. In particular, a font different from ``wx.NORMAL_FONT``
3367 should be used as the it is not normally a TrueType
3368 font. ``wx.SWISS_FONT`` is an example of a font which is.
3370 return _gdi_
.DC_DrawRotatedText(*args
, **kwargs
)
3372 def DrawRotatedTextPoint(*args
, **kwargs
):
3374 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3376 Draws the text rotated by *angle* degrees, if supported by the platform.
3378 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3379 function. In particular, a font different from ``wx.NORMAL_FONT``
3380 should be used as the it is not normally a TrueType
3381 font. ``wx.SWISS_FONT`` is an example of a font which is.
3383 return _gdi_
.DC_DrawRotatedTextPoint(*args
, **kwargs
)
3385 def Blit(*args
, **kwargs
):
3387 Blit(self, int xdest, int ydest, int width, int height, DC source,
3388 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3389 int xsrcMask=-1, int ysrcMask=-1) -> bool
3391 Copy from a source DC to this DC. Parameters specify the destination
3392 coordinates, size of area to copy, source DC, source coordinates,
3393 logical function, whether to use a bitmap mask, and mask source
3396 return _gdi_
.DC_Blit(*args
, **kwargs
)
3398 def BlitPointSize(*args
, **kwargs
):
3400 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
3401 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
3403 Copy from a source DC to this DC. Parameters specify the destination
3404 coordinates, size of area to copy, source DC, source coordinates,
3405 logical function, whether to use a bitmap mask, and mask source
3408 return _gdi_
.DC_BlitPointSize(*args
, **kwargs
)
3410 def SetClippingRegion(*args
, **kwargs
):
3412 SetClippingRegion(self, int x, int y, int width, int height)
3414 Sets the clipping region for this device context to the intersection
3415 of the given region described by the parameters of this method and the
3416 previously set clipping region. You should call `DestroyClippingRegion`
3417 if you want to set the clipping region exactly to the region
3420 The clipping region is an area to which drawing is
3421 restricted. Possible uses for the clipping region are for clipping
3422 text or for speeding up window redraws when only a known area of the
3425 return _gdi_
.DC_SetClippingRegion(*args
, **kwargs
)
3427 def SetClippingRegionPointSize(*args
, **kwargs
):
3429 SetClippingRegionPointSize(self, Point pt, Size sz)
3431 Sets the clipping region for this device context to the intersection
3432 of the given region described by the parameters of this method and the
3433 previously set clipping region. You should call `DestroyClippingRegion`
3434 if you want to set the clipping region exactly to the region
3437 The clipping region is an area to which drawing is
3438 restricted. Possible uses for the clipping region are for clipping
3439 text or for speeding up window redraws when only a known area of the
3442 return _gdi_
.DC_SetClippingRegionPointSize(*args
, **kwargs
)
3444 def SetClippingRegionAsRegion(*args
, **kwargs
):
3446 SetClippingRegionAsRegion(self, Region region)
3448 Sets the clipping region for this device context to the intersection
3449 of the given region described by the parameters of this method and the
3450 previously set clipping region. You should call `DestroyClippingRegion`
3451 if you want to set the clipping region exactly to the region
3454 The clipping region is an area to which drawing is
3455 restricted. Possible uses for the clipping region are for clipping
3456 text or for speeding up window redraws when only a known area of the
3459 return _gdi_
.DC_SetClippingRegionAsRegion(*args
, **kwargs
)
3461 def SetClippingRect(*args
, **kwargs
):
3463 SetClippingRect(self, Rect rect)
3465 Sets the clipping region for this device context to the intersection
3466 of the given region described by the parameters of this method and the
3467 previously set clipping region. You should call `DestroyClippingRegion`
3468 if you want to set the clipping region exactly to the region
3471 The clipping region is an area to which drawing is
3472 restricted. Possible uses for the clipping region are for clipping
3473 text or for speeding up window redraws when only a known area of the
3476 return _gdi_
.DC_SetClippingRect(*args
, **kwargs
)
3478 def DrawLines(*args
, **kwargs
):
3480 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3482 Draws lines using a sequence of `wx.Point` objects, adding the
3483 optional offset coordinate. The current pen is used for drawing the
3486 return _gdi_
.DC_DrawLines(*args
, **kwargs
)
3488 def DrawPolygon(*args
, **kwargs
):
3490 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
3491 int fillStyle=ODDEVEN_RULE)
3493 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3494 the optional offset coordinate. The last argument specifies the fill
3495 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3497 The current pen is used for drawing the outline, and the current brush
3498 for filling the shape. Using a transparent brush suppresses
3499 filling. Note that wxWidgets automatically closes the first and last
3502 return _gdi_
.DC_DrawPolygon(*args
, **kwargs
)
3504 def DrawLabel(*args
, **kwargs
):
3506 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3509 Draw *text* within the specified rectangle, abiding by the alignment
3510 flags. Will additionally emphasize the character at *indexAccel* if
3513 return _gdi_
.DC_DrawLabel(*args
, **kwargs
)
3515 def DrawImageLabel(*args
, **kwargs
):
3517 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3518 int indexAccel=-1) -> Rect
3520 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3521 drawing it) within the specified rectangle, abiding by the alignment
3522 flags. Will additionally emphasize the character at *indexAccel* if
3523 it is not -1. Returns the bounding rectangle.
3525 return _gdi_
.DC_DrawImageLabel(*args
, **kwargs
)
3527 def DrawSpline(*args
, **kwargs
):
3529 DrawSpline(self, List points)
3531 Draws a spline between all given control points, (a list of `wx.Point`
3532 objects) using the current pen. The spline is drawn using a series of
3533 lines, using an algorithm taken from the X drawing program 'XFIG'.
3535 return _gdi_
.DC_DrawSpline(*args
, **kwargs
)
3537 def Clear(*args
, **kwargs
):
3541 Clears the device context using the current background brush.
3543 return _gdi_
.DC_Clear(*args
, **kwargs
)
3545 def StartDoc(*args
, **kwargs
):
3547 StartDoc(self, String message) -> bool
3549 Starts a document (only relevant when outputting to a
3550 printer). *Message* is a message to show whilst printing.
3552 return _gdi_
.DC_StartDoc(*args
, **kwargs
)
3554 def EndDoc(*args
, **kwargs
):
3558 Ends a document (only relevant when outputting to a printer).
3560 return _gdi_
.DC_EndDoc(*args
, **kwargs
)
3562 def StartPage(*args
, **kwargs
):
3566 Starts a document page (only relevant when outputting to a printer).
3568 return _gdi_
.DC_StartPage(*args
, **kwargs
)
3570 def EndPage(*args
, **kwargs
):
3574 Ends a document page (only relevant when outputting to a printer).
3576 return _gdi_
.DC_EndPage(*args
, **kwargs
)
3578 def SetFont(*args
, **kwargs
):
3580 SetFont(self, Font font)
3582 Sets the current font for the DC. It must be a valid font, in
3583 particular you should not pass ``wx.NullFont`` to this method.
3585 return _gdi_
.DC_SetFont(*args
, **kwargs
)
3587 def SetPen(*args
, **kwargs
):
3589 SetPen(self, Pen pen)
3591 Sets the current pen for the DC.
3593 If the argument is ``wx.NullPen``, the current pen is selected out of the
3594 device context, and the original pen restored.
3596 return _gdi_
.DC_SetPen(*args
, **kwargs
)
3598 def SetBrush(*args
, **kwargs
):
3600 SetBrush(self, Brush brush)
3602 Sets the current brush for the DC.
3604 If the argument is ``wx.NullBrush``, the current brush is selected out
3605 of the device context, and the original brush restored, allowing the
3606 current brush to be destroyed safely.
3608 return _gdi_
.DC_SetBrush(*args
, **kwargs
)
3610 def SetBackground(*args
, **kwargs
):
3612 SetBackground(self, Brush brush)
3614 Sets the current background brush for the DC.
3616 return _gdi_
.DC_SetBackground(*args
, **kwargs
)
3618 def SetBackgroundMode(*args
, **kwargs
):
3620 SetBackgroundMode(self, int mode)
3622 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3623 determines whether text will be drawn with a background colour or
3626 return _gdi_
.DC_SetBackgroundMode(*args
, **kwargs
)
3628 def SetPalette(*args
, **kwargs
):
3630 SetPalette(self, Palette palette)
3632 If this is a window DC or memory DC, assigns the given palette to the
3633 window or bitmap associated with the DC. If the argument is
3634 ``wx.NullPalette``, the current palette is selected out of the device
3635 context, and the original palette restored.
3637 return _gdi_
.DC_SetPalette(*args
, **kwargs
)
3639 def DestroyClippingRegion(*args
, **kwargs
):
3641 DestroyClippingRegion(self)
3643 Destroys the current clipping region so that none of the DC is
3646 return _gdi_
.DC_DestroyClippingRegion(*args
, **kwargs
)
3648 def GetClippingBox(*args
, **kwargs
):
3650 GetClippingBox() -> (x, y, width, height)
3652 Gets the rectangle surrounding the current clipping region.
3654 return _gdi_
.DC_GetClippingBox(*args
, **kwargs
)
3656 def GetClippingRect(*args
, **kwargs
):
3658 GetClippingRect(self) -> Rect
3660 Gets the rectangle surrounding the current clipping region.
3662 return _gdi_
.DC_GetClippingRect(*args
, **kwargs
)
3664 def GetCharHeight(*args
, **kwargs
):
3666 GetCharHeight(self) -> int
3668 Gets the character height of the currently set font.
3670 return _gdi_
.DC_GetCharHeight(*args
, **kwargs
)
3672 def GetCharWidth(*args
, **kwargs
):
3674 GetCharWidth(self) -> int
3676 Gets the average character width of the currently set font.
3678 return _gdi_
.DC_GetCharWidth(*args
, **kwargs
)
3680 def GetTextExtent(*args
, **kwargs
):
3682 GetTextExtent(wxString string) -> (width, height)
3684 Get the width and height of the text using the current font. Only
3685 works for single line strings.
3687 return _gdi_
.DC_GetTextExtent(*args
, **kwargs
)
3689 def GetFullTextExtent(*args
, **kwargs
):
3691 GetFullTextExtent(wxString string, Font font=None) ->
3692 (width, height, descent, externalLeading)
3694 Get the width, height, decent and leading of the text using the
3695 current or specified font. Only works for single line strings.
3697 return _gdi_
.DC_GetFullTextExtent(*args
, **kwargs
)
3699 def GetMultiLineTextExtent(*args
, **kwargs
):
3701 GetMultiLineTextExtent(wxString string, Font font=None) ->
3702 (width, height, lineHeight)
3704 Get the width, height, decent and leading of the text using the
3705 current or specified font. Works for single as well as multi-line
3708 return _gdi_
.DC_GetMultiLineTextExtent(*args
, **kwargs
)
3710 def GetPartialTextExtents(*args
, **kwargs
):
3712 GetPartialTextExtents(self, text) -> [widths]
3714 Returns a list of integers such that each value is the distance in
3715 pixels from the begining of text to the coresponding character of
3716 *text*. The generic version simply builds a running total of the widths
3717 of each character using GetTextExtent, however if the various
3718 platforms have a native API function that is faster or more accurate
3719 than the generic implementation then it will be used instead.
3721 return _gdi_
.DC_GetPartialTextExtents(*args
, **kwargs
)
3723 def GetSize(*args
, **kwargs
):
3725 GetSize(self) -> Size
3727 This gets the horizontal and vertical resolution in device units. It
3728 can be used to scale graphics to fit the page. For example, if *maxX*
3729 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3730 used in your application, the following code will scale the graphic to
3731 fit on the printer page::
3734 scaleX = maxX*1.0 / w
3735 scaleY = maxY*1.0 / h
3736 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3739 return _gdi_
.DC_GetSize(*args
, **kwargs
)
3741 def GetSizeTuple(*args
, **kwargs
):
3743 GetSizeTuple() -> (width, height)
3745 This gets the horizontal and vertical resolution in device units. It
3746 can be used to scale graphics to fit the page. For example, if *maxX*
3747 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3748 used in your application, the following code will scale the graphic to
3749 fit on the printer page::
3752 scaleX = maxX*1.0 / w
3753 scaleY = maxY*1.0 / h
3754 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3757 return _gdi_
.DC_GetSizeTuple(*args
, **kwargs
)
3759 def GetSizeMM(*args
, **kwargs
):
3761 GetSizeMM(self) -> Size
3763 Get the DC size in milimeters.
3765 return _gdi_
.DC_GetSizeMM(*args
, **kwargs
)
3767 def GetSizeMMTuple(*args
, **kwargs
):
3769 GetSizeMMTuple() -> (width, height)
3771 Get the DC size in milimeters.
3773 return _gdi_
.DC_GetSizeMMTuple(*args
, **kwargs
)
3775 def DeviceToLogicalX(*args
, **kwargs
):
3777 DeviceToLogicalX(self, int x) -> int
3779 Convert device X coordinate to logical coordinate, using the current
3782 return _gdi_
.DC_DeviceToLogicalX(*args
, **kwargs
)
3784 def DeviceToLogicalY(*args
, **kwargs
):
3786 DeviceToLogicalY(self, int y) -> int
3788 Converts device Y coordinate to logical coordinate, using the current
3791 return _gdi_
.DC_DeviceToLogicalY(*args
, **kwargs
)
3793 def DeviceToLogicalXRel(*args
, **kwargs
):
3795 DeviceToLogicalXRel(self, int x) -> int
3797 Convert device X coordinate to relative logical coordinate, using the
3798 current mapping mode but ignoring the x axis orientation. Use this
3799 function for converting a width, for example.
3801 return _gdi_
.DC_DeviceToLogicalXRel(*args
, **kwargs
)
3803 def DeviceToLogicalYRel(*args
, **kwargs
):
3805 DeviceToLogicalYRel(self, int y) -> int
3807 Convert device Y coordinate to relative logical coordinate, using the
3808 current mapping mode but ignoring the y axis orientation. Use this
3809 function for converting a height, for example.
3811 return _gdi_
.DC_DeviceToLogicalYRel(*args
, **kwargs
)
3813 def LogicalToDeviceX(*args
, **kwargs
):
3815 LogicalToDeviceX(self, int x) -> int
3817 Converts logical X coordinate to device coordinate, using the current
3820 return _gdi_
.DC_LogicalToDeviceX(*args
, **kwargs
)
3822 def LogicalToDeviceY(*args
, **kwargs
):
3824 LogicalToDeviceY(self, int y) -> int
3826 Converts logical Y coordinate to device coordinate, using the current
3829 return _gdi_
.DC_LogicalToDeviceY(*args
, **kwargs
)
3831 def LogicalToDeviceXRel(*args
, **kwargs
):
3833 LogicalToDeviceXRel(self, int x) -> int
3835 Converts logical X coordinate to relative device coordinate, using the
3836 current mapping mode but ignoring the x axis orientation. Use this for
3837 converting a width, for example.
3839 return _gdi_
.DC_LogicalToDeviceXRel(*args
, **kwargs
)
3841 def LogicalToDeviceYRel(*args
, **kwargs
):
3843 LogicalToDeviceYRel(self, int y) -> int
3845 Converts logical Y coordinate to relative device coordinate, using the
3846 current mapping mode but ignoring the y axis orientation. Use this for
3847 converting a height, for example.
3849 return _gdi_
.DC_LogicalToDeviceYRel(*args
, **kwargs
)
3851 def CanDrawBitmap(*args
, **kwargs
):
3852 """CanDrawBitmap(self) -> bool"""
3853 return _gdi_
.DC_CanDrawBitmap(*args
, **kwargs
)
3855 def CanGetTextExtent(*args
, **kwargs
):
3856 """CanGetTextExtent(self) -> bool"""
3857 return _gdi_
.DC_CanGetTextExtent(*args
, **kwargs
)
3859 def GetDepth(*args
, **kwargs
):
3861 GetDepth(self) -> int
3863 Returns the colour depth of the DC.
3865 return _gdi_
.DC_GetDepth(*args
, **kwargs
)
3867 def GetPPI(*args
, **kwargs
):
3869 GetPPI(self) -> Size
3871 Resolution in pixels per inch
3873 return _gdi_
.DC_GetPPI(*args
, **kwargs
)
3875 def Ok(*args
, **kwargs
):
3879 Returns true if the DC is ok to use.
3881 return _gdi_
.DC_Ok(*args
, **kwargs
)
3883 def GetBackgroundMode(*args
, **kwargs
):
3885 GetBackgroundMode(self) -> int
3887 Returns the current background mode, either ``wx.SOLID`` or
3890 return _gdi_
.DC_GetBackgroundMode(*args
, **kwargs
)
3892 def GetBackground(*args
, **kwargs
):
3894 GetBackground(self) -> Brush
3896 Gets the brush used for painting the background.
3898 return _gdi_
.DC_GetBackground(*args
, **kwargs
)
3900 def GetBrush(*args
, **kwargs
):
3902 GetBrush(self) -> Brush
3904 Gets the current brush
3906 return _gdi_
.DC_GetBrush(*args
, **kwargs
)
3908 def GetFont(*args
, **kwargs
):
3910 GetFont(self) -> Font
3912 Gets the current font
3914 return _gdi_
.DC_GetFont(*args
, **kwargs
)
3916 def GetPen(*args
, **kwargs
):
3920 Gets the current pen
3922 return _gdi_
.DC_GetPen(*args
, **kwargs
)
3924 def GetTextBackground(*args
, **kwargs
):
3926 GetTextBackground(self) -> Colour
3928 Gets the current text background colour
3930 return _gdi_
.DC_GetTextBackground(*args
, **kwargs
)
3932 def GetTextForeground(*args
, **kwargs
):
3934 GetTextForeground(self) -> Colour
3936 Gets the current text foreground colour
3938 return _gdi_
.DC_GetTextForeground(*args
, **kwargs
)
3940 def SetTextForeground(*args
, **kwargs
):
3942 SetTextForeground(self, Colour colour)
3944 Sets the current text foreground colour for the DC.
3946 return _gdi_
.DC_SetTextForeground(*args
, **kwargs
)
3948 def SetTextBackground(*args
, **kwargs
):
3950 SetTextBackground(self, Colour colour)
3952 Sets the current text background colour for the DC.
3954 return _gdi_
.DC_SetTextBackground(*args
, **kwargs
)
3956 def GetMapMode(*args
, **kwargs
):
3958 GetMapMode(self) -> int
3960 Gets the current *mapping mode* for the device context
3962 return _gdi_
.DC_GetMapMode(*args
, **kwargs
)
3964 def SetMapMode(*args
, **kwargs
):
3966 SetMapMode(self, int mode)
3968 The *mapping mode* of the device context defines the unit of
3969 measurement used to convert logical units to device units. The
3970 mapping mode can be one of the following:
3972 ================ =============================================
3973 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3975 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3976 wx.MM_METRIC Each logical unit is 1 mm.
3977 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3978 wx.MM_TEXT Each logical unit is 1 pixel.
3979 ================ =============================================
3982 return _gdi_
.DC_SetMapMode(*args
, **kwargs
)
3984 def GetUserScale(*args
, **kwargs
):
3986 GetUserScale(self) -> (xScale, yScale)
3988 Gets the current user scale factor (set by `SetUserScale`).
3990 return _gdi_
.DC_GetUserScale(*args
, **kwargs
)
3992 def SetUserScale(*args
, **kwargs
):
3994 SetUserScale(self, double x, double y)
3996 Sets the user scaling factor, useful for applications which require
3999 return _gdi_
.DC_SetUserScale(*args
, **kwargs
)
4001 def GetLogicalScale(*args
, **kwargs
):
4002 """GetLogicalScale() -> (xScale, yScale)"""
4003 return _gdi_
.DC_GetLogicalScale(*args
, **kwargs
)
4005 def SetLogicalScale(*args
, **kwargs
):
4006 """SetLogicalScale(self, double x, double y)"""
4007 return _gdi_
.DC_SetLogicalScale(*args
, **kwargs
)
4009 def GetLogicalOrigin(*args
, **kwargs
):
4010 """GetLogicalOrigin(self) -> Point"""
4011 return _gdi_
.DC_GetLogicalOrigin(*args
, **kwargs
)
4013 def GetLogicalOriginTuple(*args
, **kwargs
):
4014 """GetLogicalOriginTuple() -> (x,y)"""
4015 return _gdi_
.DC_GetLogicalOriginTuple(*args
, **kwargs
)
4017 def SetLogicalOrigin(*args
, **kwargs
):
4018 """SetLogicalOrigin(self, int x, int y)"""
4019 return _gdi_
.DC_SetLogicalOrigin(*args
, **kwargs
)
4021 def SetLogicalOriginPoint(*args
, **kwargs
):
4022 """SetLogicalOriginPoint(self, Point point)"""
4023 return _gdi_
.DC_SetLogicalOriginPoint(*args
, **kwargs
)
4025 def GetDeviceOrigin(*args
, **kwargs
):
4026 """GetDeviceOrigin(self) -> Point"""
4027 return _gdi_
.DC_GetDeviceOrigin(*args
, **kwargs
)
4029 def GetDeviceOriginTuple(*args
, **kwargs
):
4030 """GetDeviceOriginTuple() -> (x,y)"""
4031 return _gdi_
.DC_GetDeviceOriginTuple(*args
, **kwargs
)
4033 def SetDeviceOrigin(*args
, **kwargs
):
4034 """SetDeviceOrigin(self, int x, int y)"""
4035 return _gdi_
.DC_SetDeviceOrigin(*args
, **kwargs
)
4037 def SetDeviceOriginPoint(*args
, **kwargs
):
4038 """SetDeviceOriginPoint(self, Point point)"""
4039 return _gdi_
.DC_SetDeviceOriginPoint(*args
, **kwargs
)
4041 def SetAxisOrientation(*args
, **kwargs
):
4043 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
4045 Sets the x and y axis orientation (i.e., the direction from lowest to
4046 highest values on the axis). The default orientation is the natural
4047 orientation, e.g. x axis from left to right and y axis from bottom up.
4049 return _gdi_
.DC_SetAxisOrientation(*args
, **kwargs
)
4051 def GetLogicalFunction(*args
, **kwargs
):
4053 GetLogicalFunction(self) -> int
4055 Gets the current logical function (set by `SetLogicalFunction`).
4057 return _gdi_
.DC_GetLogicalFunction(*args
, **kwargs
)
4059 def SetLogicalFunction(*args
, **kwargs
):
4061 SetLogicalFunction(self, int function)
4063 Sets the current logical function for the device context. This
4064 determines how a source pixel (from a pen or brush colour, or source
4065 device context if using `Blit`) combines with a destination pixel in
4066 the current device context.
4068 The possible values and their meaning in terms of source and
4069 destination pixel values are as follows:
4071 ================ ==========================
4073 wx.AND_INVERT (NOT src) AND dst
4074 wx.AND_REVERSE src AND (NOT dst)
4077 wx.EQUIV (NOT src) XOR dst
4079 wx.NAND (NOT src) OR (NOT dst)
4080 wx.NOR (NOT src) AND (NOT dst)
4083 wx.OR_INVERT (NOT src) OR dst
4084 wx.OR_REVERSE src OR (NOT dst)
4086 wx.SRC_INVERT NOT src
4088 ================ ==========================
4090 The default is wx.COPY, which simply draws with the current
4091 colour. The others combine the current colour and the background using
4092 a logical operation. wx.INVERT is commonly used for drawing rubber
4093 bands or moving outlines, since drawing twice reverts to the original
4097 return _gdi_
.DC_SetLogicalFunction(*args
, **kwargs
)
4099 def ComputeScaleAndOrigin(*args
, **kwargs
):
4101 ComputeScaleAndOrigin(self)
4103 Performs all necessary computations for given platform and context
4104 type after each change of scale and origin parameters. Usually called
4105 automatically internally after such changes.
4108 return _gdi_
.DC_ComputeScaleAndOrigin(*args
, **kwargs
)
4110 def SetOptimization(self
, optimize
):
4112 def GetOptimization(self
):
4115 SetOptimization
= wx
._deprecated
(SetOptimization
)
4116 GetOptimization
= wx
._deprecated
(GetOptimization
)
4118 def CalcBoundingBox(*args
, **kwargs
):
4120 CalcBoundingBox(self, int x, int y)
4122 Adds the specified point to the bounding box which can be retrieved
4123 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4125 return _gdi_
.DC_CalcBoundingBox(*args
, **kwargs
)
4127 def CalcBoundingBoxPoint(*args
, **kwargs
):
4129 CalcBoundingBoxPoint(self, Point point)
4131 Adds the specified point to the bounding box which can be retrieved
4132 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4134 return _gdi_
.DC_CalcBoundingBoxPoint(*args
, **kwargs
)
4136 def ResetBoundingBox(*args
, **kwargs
):
4138 ResetBoundingBox(self)
4140 Resets the bounding box: after a call to this function, the bounding
4141 box doesn't contain anything.
4143 return _gdi_
.DC_ResetBoundingBox(*args
, **kwargs
)
4145 def MinX(*args
, **kwargs
):
4149 Gets the minimum horizontal extent used in drawing commands so far.
4151 return _gdi_
.DC_MinX(*args
, **kwargs
)
4153 def MaxX(*args
, **kwargs
):
4157 Gets the maximum horizontal extent used in drawing commands so far.
4159 return _gdi_
.DC_MaxX(*args
, **kwargs
)
4161 def MinY(*args
, **kwargs
):
4165 Gets the minimum vertical extent used in drawing commands so far.
4167 return _gdi_
.DC_MinY(*args
, **kwargs
)
4169 def MaxY(*args
, **kwargs
):
4173 Gets the maximum vertical extent used in drawing commands so far.
4175 return _gdi_
.DC_MaxY(*args
, **kwargs
)
4177 def GetBoundingBox(*args
, **kwargs
):
4179 GetBoundingBox() -> (x1,y1, x2,y2)
4181 Returns the min and max points used in drawing commands so far.
4183 return _gdi_
.DC_GetBoundingBox(*args
, **kwargs
)
4185 def __nonzero__(self
): return self
.Ok()
4186 def GetHDC(*args
, **kwargs
):
4187 """GetHDC(self) -> long"""
4188 return _gdi_
.DC_GetHDC(*args
, **kwargs
)
4190 def _DrawPointList(*args
, **kwargs
):
4191 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4192 return _gdi_
.DC__DrawPointList(*args
, **kwargs
)
4194 def _DrawLineList(*args
, **kwargs
):
4195 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4196 return _gdi_
.DC__DrawLineList(*args
, **kwargs
)
4198 def _DrawRectangleList(*args
, **kwargs
):
4199 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4200 return _gdi_
.DC__DrawRectangleList(*args
, **kwargs
)
4202 def _DrawEllipseList(*args
, **kwargs
):
4203 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4204 return _gdi_
.DC__DrawEllipseList(*args
, **kwargs
)
4206 def _DrawPolygonList(*args
, **kwargs
):
4207 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4208 return _gdi_
.DC__DrawPolygonList(*args
, **kwargs
)
4210 def _DrawTextList(*args
, **kwargs
):
4212 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
4213 PyObject backgroundList) -> PyObject
4215 return _gdi_
.DC__DrawTextList(*args
, **kwargs
)
4217 def DrawPointList(self
, points
, pens
=None):
4219 Draw a list of points as quickly as possible.
4221 :param points: A sequence of 2-element sequences representing
4222 each point to draw, (x,y).
4223 :param pens: If None, then the current pen is used. If a
4224 single pen then it will be used for all points. If
4225 a list of pens then there should be one for each point
4230 elif isinstance(pens
, wx
.Pen
):
4232 elif len(pens
) != len(points
):
4233 raise ValueError('points and pens must have same length')
4234 return self
._DrawPointList
(points
, pens
, [])
4237 def DrawLineList(self
, lines
, pens
=None):
4239 Draw a list of lines as quickly as possible.
4241 :param lines: A sequence of 4-element sequences representing
4242 each line to draw, (x1,y1, x2,y2).
4243 :param pens: If None, then the current pen is used. If a
4244 single pen then it will be used for all lines. If
4245 a list of pens then there should be one for each line
4250 elif isinstance(pens
, wx
.Pen
):
4252 elif len(pens
) != len(lines
):
4253 raise ValueError('lines and pens must have same length')
4254 return self
._DrawLineList
(lines
, pens
, [])
4257 def DrawRectangleList(self
, rectangles
, pens
=None, brushes
=None):
4259 Draw a list of rectangles as quickly as possible.
4261 :param rectangles: A sequence of 4-element sequences representing
4262 each rectangle to draw, (x,y, w,h).
4263 :param pens: If None, then the current pen is used. If a
4264 single pen then it will be used for all rectangles.
4265 If a list of pens then there should be one for each
4266 rectangle in rectangles.
4267 :param brushes: A brush or brushes to be used to fill the rectagles,
4268 with similar semantics as the pens parameter.
4272 elif isinstance(pens
, wx
.Pen
):
4274 elif len(pens
) != len(rectangles
):
4275 raise ValueError('rectangles and pens must have same length')
4278 elif isinstance(brushes
, wx
.Brush
):
4280 elif len(brushes
) != len(rectangles
):
4281 raise ValueError('rectangles and brushes must have same length')
4282 return self
._DrawRectangleList
(rectangles
, pens
, brushes
)
4285 def DrawEllipseList(self
, ellipses
, pens
=None, brushes
=None):
4287 Draw a list of ellipses as quickly as possible.
4289 :param ellipses: A sequence of 4-element sequences representing
4290 each ellipse to draw, (x,y, w,h).
4291 :param pens: If None, then the current pen is used. If a
4292 single pen then it will be used for all ellipses.
4293 If a list of pens then there should be one for each
4294 ellipse in ellipses.
4295 :param brushes: A brush or brushes to be used to fill the ellipses,
4296 with similar semantics as the pens parameter.
4300 elif isinstance(pens
, wx
.Pen
):
4302 elif len(pens
) != len(ellipses
):
4303 raise ValueError('ellipses and pens must have same length')
4306 elif isinstance(brushes
, wx
.Brush
):
4308 elif len(brushes
) != len(ellipses
):
4309 raise ValueError('ellipses and brushes must have same length')
4310 return self
._DrawEllipseList
(ellipses
, pens
, brushes
)
4313 def DrawPolygonList(self
, polygons
, pens
=None, brushes
=None):
4315 Draw a list of polygons, each of which is a list of points.
4317 :param polygons: A sequence of sequences of sequences.
4318 [[(x1,y1),(x2,y2),(x3,y3)...],
4319 [(x1,y1),(x2,y2),(x3,y3)...]]
4321 :param pens: If None, then the current pen is used. If a
4322 single pen then it will be used for all polygons.
4323 If a list of pens then there should be one for each
4325 :param brushes: A brush or brushes to be used to fill the polygons,
4326 with similar semantics as the pens parameter.
4330 elif isinstance(pens
, wx
.Pen
):
4332 elif len(pens
) != len(polygons
):
4333 raise ValueError('polygons and pens must have same length')
4336 elif isinstance(brushes
, wx
.Brush
):
4338 elif len(brushes
) != len(polygons
):
4339 raise ValueError('polygons and brushes must have same length')
4340 return self
._DrawPolygonList
(polygons
, pens
, brushes
)
4343 def DrawTextList(self
, textList
, coords
, foregrounds
= None, backgrounds
= None):
4345 Draw a list of strings using a list of coordinants for positioning each string.
4347 :param textList: A list of strings
4348 :param coords: A list of (x,y) positions
4349 :param foregrounds: A list of `wx.Colour` objects to use for the
4350 foregrounds of the strings.
4351 :param backgrounds: A list of `wx.Colour` objects to use for the
4352 backgrounds of the strings.
4354 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4355 If you want backgrounds to do anything.
4357 if type(textList
) == type(''):
4358 textList
= [textList
]
4359 elif len(textList
) != len(coords
):
4360 raise ValueError('textlist and coords must have same length')
4361 if foregrounds
is None:
4363 elif isinstance(foregrounds
, wx
.Colour
):
4364 foregrounds
= [foregrounds
]
4365 elif len(foregrounds
) != len(coords
):
4366 raise ValueError('foregrounds and coords must have same length')
4367 if backgrounds
is None:
4369 elif isinstance(backgrounds
, wx
.Colour
):
4370 backgrounds
= [backgrounds
]
4371 elif len(backgrounds
) != len(coords
):
4372 raise ValueError('backgrounds and coords must have same length')
4373 return self
._DrawTextList
(textList
, coords
, foregrounds
, backgrounds
)
4375 Background
= property(GetBackground
,SetBackground
,doc
="See `GetBackground` and `SetBackground`")
4376 BackgroundMode
= property(GetBackgroundMode
,SetBackgroundMode
,doc
="See `GetBackgroundMode` and `SetBackgroundMode`")
4377 BoundingBox
= property(GetBoundingBox
,doc
="See `GetBoundingBox`")
4378 Brush
= property(GetBrush
,SetBrush
,doc
="See `GetBrush` and `SetBrush`")
4379 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
4380 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
4381 ClippingBox
= property(GetClippingBox
,doc
="See `GetClippingBox`")
4382 ClippingRect
= property(GetClippingRect
,SetClippingRect
,doc
="See `GetClippingRect` and `SetClippingRect`")
4383 Depth
= property(GetDepth
,doc
="See `GetDepth`")
4384 DeviceOrigin
= property(GetDeviceOrigin
,SetDeviceOrigin
,doc
="See `GetDeviceOrigin` and `SetDeviceOrigin`")
4385 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
4386 FullTextExtent
= property(GetFullTextExtent
,doc
="See `GetFullTextExtent`")
4387 LogicalFunction
= property(GetLogicalFunction
,SetLogicalFunction
,doc
="See `GetLogicalFunction` and `SetLogicalFunction`")
4388 LogicalOrigin
= property(GetLogicalOrigin
,SetLogicalOrigin
,doc
="See `GetLogicalOrigin` and `SetLogicalOrigin`")
4389 LogicalScale
= property(GetLogicalScale
,SetLogicalScale
,doc
="See `GetLogicalScale` and `SetLogicalScale`")
4390 MapMode
= property(GetMapMode
,SetMapMode
,doc
="See `GetMapMode` and `SetMapMode`")
4391 MultiLineTextExtent
= property(GetMultiLineTextExtent
,doc
="See `GetMultiLineTextExtent`")
4392 Optimization
= property(GetOptimization
,SetOptimization
,doc
="See `GetOptimization` and `SetOptimization`")
4393 PPI
= property(GetPPI
,doc
="See `GetPPI`")
4394 PartialTextExtents
= property(GetPartialTextExtents
,doc
="See `GetPartialTextExtents`")
4395 Pen
= property(GetPen
,SetPen
,doc
="See `GetPen` and `SetPen`")
4396 Pixel
= property(GetPixel
,doc
="See `GetPixel`")
4397 PixelPoint
= property(GetPixelPoint
,doc
="See `GetPixelPoint`")
4398 Size
= property(GetSize
,doc
="See `GetSize`")
4399 SizeMM
= property(GetSizeMM
,doc
="See `GetSizeMM`")
4400 TextBackground
= property(GetTextBackground
,SetTextBackground
,doc
="See `GetTextBackground` and `SetTextBackground`")
4401 TextExtent
= property(GetTextExtent
,doc
="See `GetTextExtent`")
4402 TextForeground
= property(GetTextForeground
,SetTextForeground
,doc
="See `GetTextForeground` and `SetTextForeground`")
4403 UserScale
= property(GetUserScale
,SetUserScale
,doc
="See `GetUserScale` and `SetUserScale`")
4404 _gdi_
.DC_swigregister(DC
)
4406 #---------------------------------------------------------------------------
4410 A memory device context provides a means to draw graphics onto a
4411 bitmap. A bitmap must be selected into the new memory DC before it may
4412 be used for anything. Typical usage is as follows::
4415 dc.SelectObject(bitmap)
4416 # draw on the dc usign any of the Draw methods
4417 dc.SelectObject(wx.NullBitmap)
4418 # the bitmap now contains wahtever was drawn upon it
4420 Note that the memory DC *must* be deleted (or the bitmap selected out
4421 of it) before a bitmap can be reselected into another memory DC.
4424 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4425 __repr__
= _swig_repr
4426 def __init__(self
, *args
, **kwargs
):
4428 __init__(self) -> MemoryDC
4430 Constructs a new memory device context.
4432 Use the Ok member to test whether the constructor was successful in
4433 creating a usable device context. Don't forget to select a bitmap into
4434 the DC before drawing on it.
4436 _gdi_
.MemoryDC_swiginit(self
,_gdi_
.new_MemoryDC(*args
, **kwargs
))
4437 def SelectObject(*args
, **kwargs
):
4439 SelectObject(self, Bitmap bitmap)
4441 Selects the bitmap into the device context, to use as the memory
4442 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4443 the DC, and therefore the bitmap, and also to use Blit to copy the
4446 If the argument is wx.NullBitmap (or some other uninitialised
4447 `wx.Bitmap`) the current bitmap is selected out of the device context,
4448 and the original bitmap restored, allowing the current bitmap to be
4451 return _gdi_
.MemoryDC_SelectObject(*args
, **kwargs
)
4453 _gdi_
.MemoryDC_swigregister(MemoryDC
)
4455 def MemoryDCFromDC(*args
, **kwargs
):
4457 MemoryDCFromDC(DC oldDC) -> MemoryDC
4459 Creates a DC that is compatible with the oldDC.
4461 val
= _gdi_
.new_MemoryDCFromDC(*args
, **kwargs
)
4464 #---------------------------------------------------------------------------
4466 BUFFER_VIRTUAL_AREA
= _gdi_
.BUFFER_VIRTUAL_AREA
4467 BUFFER_CLIENT_AREA
= _gdi_
.BUFFER_CLIENT_AREA
4468 class BufferedDC(MemoryDC
):
4470 This simple class provides a simple way to avoid flicker: when drawing
4471 on it, everything is in fact first drawn on an in-memory buffer (a
4472 `wx.Bitmap`) and then copied to the screen only once, when this object
4475 It can be used in the same way as any other device
4476 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
4477 want to use it in your EVT_PAINT handler, you should look at
4478 `wx.BufferedPaintDC`.
4481 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4482 __repr__
= _swig_repr
4483 def __init__(self
, *args
):
4485 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4486 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4488 Constructs a buffered DC.
4490 _gdi_
.BufferedDC_swiginit(self
,_gdi_
.new_BufferedDC(*args
))
4491 self
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
4493 __swig_destroy__
= _gdi_
.delete_BufferedDC
4494 __del__
= lambda self
: None;
4495 def UnMask(*args
, **kwargs
):
4499 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4500 can be effectively used once only). This is usually only called in
4503 return _gdi_
.BufferedDC_UnMask(*args
, **kwargs
)
4505 _gdi_
.BufferedDC_swigregister(BufferedDC
)
4507 class BufferedPaintDC(BufferedDC
):
4509 This is a subclass of `wx.BufferedDC` which can be used inside of an
4510 EVT_PAINT event handler. Just create an object of this class instead
4511 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4512 flicker. The only thing to watch out for is that if you are using this
4513 class together with `wx.ScrolledWindow`, you probably do **not** want
4514 to call `wx.Window.PrepareDC` on it as it already does this internally
4515 for the real underlying `wx.PaintDC`.
4517 If your window is already fully buffered in a `wx.Bitmap` then your
4518 EVT_PAINT handler can be as simple as just creating a
4519 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4520 automatically when it is destroyed. For example::
4522 def OnPaint(self, event):
4523 dc = wx.BufferedPaintDC(self, self.buffer)
4530 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4531 __repr__
= _swig_repr
4532 def __init__(self
, *args
, **kwargs
):
4534 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
4536 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4537 provide the bitmap to be used for buffering or let this object create
4538 one internally (in the latter case, the size of the client part of the
4539 window is automatically used).
4543 _gdi_
.BufferedPaintDC_swiginit(self
,_gdi_
.new_BufferedPaintDC(*args
, **kwargs
))
4544 _gdi_
.BufferedPaintDC_swigregister(BufferedPaintDC
)
4546 #---------------------------------------------------------------------------
4550 A wxScreenDC can be used to paint anywhere on the screen. This should
4551 normally be constructed as a temporary stack object; don't store a
4555 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4556 __repr__
= _swig_repr
4557 def __init__(self
, *args
, **kwargs
):
4559 __init__(self) -> ScreenDC
4561 A wxScreenDC can be used to paint anywhere on the screen. This should
4562 normally be constructed as a temporary stack object; don't store a
4566 _gdi_
.ScreenDC_swiginit(self
,_gdi_
.new_ScreenDC(*args
, **kwargs
))
4567 def StartDrawingOnTopWin(*args
, **kwargs
):
4569 StartDrawingOnTopWin(self, Window window) -> bool
4571 Specify that the area of the screen to be drawn upon coincides with
4574 :see: `EndDrawingOnTop`
4576 return _gdi_
.ScreenDC_StartDrawingOnTopWin(*args
, **kwargs
)
4578 def StartDrawingOnTop(*args
, **kwargs
):
4580 StartDrawingOnTop(self, Rect rect=None) -> bool
4582 Specify that the area is the given rectangle, or the whole screen if
4585 :see: `EndDrawingOnTop`
4587 return _gdi_
.ScreenDC_StartDrawingOnTop(*args
, **kwargs
)
4589 def EndDrawingOnTop(*args
, **kwargs
):
4591 EndDrawingOnTop(self) -> bool
4593 Use this in conjunction with `StartDrawingOnTop` or
4594 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4595 top of existing windows. Without this, some window systems (such as X)
4596 only allow drawing to take place underneath other windows.
4598 You might use this pair of functions when implementing a drag feature,
4599 for example as in the `wx.SplitterWindow` implementation.
4601 These functions are probably obsolete since the X implementations
4602 allow drawing directly on the screen now. However, the fact that this
4603 function allows the screen to be refreshed afterwards may be useful
4604 to some applications.
4606 return _gdi_
.ScreenDC_EndDrawingOnTop(*args
, **kwargs
)
4608 _gdi_
.ScreenDC_swigregister(ScreenDC
)
4610 #---------------------------------------------------------------------------
4614 A wx.ClientDC must be constructed if an application wishes to paint on
4615 the client area of a window from outside an EVT_PAINT event. This should
4616 normally be constructed as a temporary stack object; don't store a
4617 wx.ClientDC object long term.
4619 To draw on a window from within an EVT_PAINT handler, construct a
4620 `wx.PaintDC` object.
4622 To draw on the whole window including decorations, construct a
4623 `wx.WindowDC` object (Windows only).
4626 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4627 __repr__
= _swig_repr
4628 def __init__(self
, *args
, **kwargs
):
4630 __init__(self, Window win) -> ClientDC
4632 Constructor. Pass the window on which you wish to paint.
4634 _gdi_
.ClientDC_swiginit(self
,_gdi_
.new_ClientDC(*args
, **kwargs
))
4635 _gdi_
.ClientDC_swigregister(ClientDC
)
4637 #---------------------------------------------------------------------------
4641 A wx.PaintDC must be constructed if an application wishes to paint on
4642 the client area of a window from within an EVT_PAINT event
4643 handler. This should normally be constructed as a temporary stack
4644 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4645 handler, you **must** create a wx.PaintDC object within it even if you
4646 don't actually use it.
4648 Using wx.PaintDC within EVT_PAINT handlers is important because it
4649 automatically sets the clipping area to the damaged area of the
4650 window. Attempts to draw outside this area do not appear.
4652 To draw on a window from outside EVT_PAINT handlers, construct a
4653 `wx.ClientDC` object.
4656 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4657 __repr__
= _swig_repr
4658 def __init__(self
, *args
, **kwargs
):
4660 __init__(self, Window win) -> PaintDC
4662 Constructor. Pass the window on which you wish to paint.
4664 _gdi_
.PaintDC_swiginit(self
,_gdi_
.new_PaintDC(*args
, **kwargs
))
4665 _gdi_
.PaintDC_swigregister(PaintDC
)
4667 #---------------------------------------------------------------------------
4671 A wx.WindowDC must be constructed if an application wishes to paint on
4672 the whole area of a window (client and decorations). This should
4673 normally be constructed as a temporary stack object; don't store a
4676 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4677 __repr__
= _swig_repr
4678 def __init__(self
, *args
, **kwargs
):
4680 __init__(self, Window win) -> WindowDC
4682 Constructor. Pass the window on which you wish to paint.
4684 _gdi_
.WindowDC_swiginit(self
,_gdi_
.new_WindowDC(*args
, **kwargs
))
4685 _gdi_
.WindowDC_swigregister(WindowDC
)
4687 #---------------------------------------------------------------------------
4691 wx.MirrorDC is a simple wrapper class which is always associated with a
4692 real `wx.DC` object and either forwards all of its operations to it
4693 without changes (no mirroring takes place) or exchanges x and y
4694 coordinates which makes it possible to reuse the same code to draw a
4695 figure and its mirror -- i.e. reflection related to the diagonal line
4698 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4699 __repr__
= _swig_repr
4700 def __init__(self
, *args
, **kwargs
):
4702 __init__(self, DC dc, bool mirror) -> MirrorDC
4704 Creates a mirrored DC associated with the real *dc*. Everything drawn
4705 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4708 _gdi_
.MirrorDC_swiginit(self
,_gdi_
.new_MirrorDC(*args
, **kwargs
))
4709 _gdi_
.MirrorDC_swigregister(MirrorDC
)
4711 #---------------------------------------------------------------------------
4713 class PostScriptDC(DC
):
4714 """This is a `wx.DC` that can write to PostScript files on any platform."""
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, wxPrintData printData) -> PostScriptDC
4721 Constructs a PostScript printer device context from a `wx.PrintData`
4724 _gdi_
.PostScriptDC_swiginit(self
,_gdi_
.new_PostScriptDC(*args
, **kwargs
))
4725 def GetPrintData(*args
, **kwargs
):
4726 """GetPrintData(self) -> wxPrintData"""
4727 return _gdi_
.PostScriptDC_GetPrintData(*args
, **kwargs
)
4729 def SetPrintData(*args
, **kwargs
):
4730 """SetPrintData(self, wxPrintData data)"""
4731 return _gdi_
.PostScriptDC_SetPrintData(*args
, **kwargs
)
4733 def SetResolution(*args
, **kwargs
):
4735 SetResolution(int ppi)
4737 Set resolution (in pixels per inch) that will be used in PostScript
4738 output. Default is 720ppi.
4740 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4742 SetResolution
= staticmethod(SetResolution
)
4743 def GetResolution(*args
, **kwargs
):
4745 GetResolution() -> int
4747 Return resolution used in PostScript output.
4749 return _gdi_
.PostScriptDC_GetResolution(*args
, **kwargs
)
4751 GetResolution
= staticmethod(GetResolution
)
4752 _gdi_
.PostScriptDC_swigregister(PostScriptDC
)
4754 def PostScriptDC_SetResolution(*args
, **kwargs
):
4756 PostScriptDC_SetResolution(int ppi)
4758 Set resolution (in pixels per inch) that will be used in PostScript
4759 output. Default is 720ppi.
4761 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4763 def PostScriptDC_GetResolution(*args
):
4765 PostScriptDC_GetResolution() -> int
4767 Return resolution used in PostScript output.
4769 return _gdi_
.PostScriptDC_GetResolution(*args
)
4771 #---------------------------------------------------------------------------
4773 class MetaFile(_core
.Object
):
4774 """Proxy of C++ MetaFile class"""
4775 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4776 __repr__
= _swig_repr
4777 def __init__(self
, *args
, **kwargs
):
4778 """__init__(self, String filename=EmptyString) -> MetaFile"""
4779 _gdi_
.MetaFile_swiginit(self
,_gdi_
.new_MetaFile(*args
, **kwargs
))
4780 __swig_destroy__
= _gdi_
.delete_MetaFile
4781 __del__
= lambda self
: None;
4782 def Ok(*args
, **kwargs
):
4783 """Ok(self) -> bool"""
4784 return _gdi_
.MetaFile_Ok(*args
, **kwargs
)
4786 def SetClipboard(*args
, **kwargs
):
4787 """SetClipboard(self, int width=0, int height=0) -> bool"""
4788 return _gdi_
.MetaFile_SetClipboard(*args
, **kwargs
)
4790 def GetSize(*args
, **kwargs
):
4791 """GetSize(self) -> Size"""
4792 return _gdi_
.MetaFile_GetSize(*args
, **kwargs
)
4794 def GetWidth(*args
, **kwargs
):
4795 """GetWidth(self) -> int"""
4796 return _gdi_
.MetaFile_GetWidth(*args
, **kwargs
)
4798 def GetHeight(*args
, **kwargs
):
4799 """GetHeight(self) -> int"""
4800 return _gdi_
.MetaFile_GetHeight(*args
, **kwargs
)
4802 def GetFileName(*args
, **kwargs
):
4803 """GetFileName(self) -> String"""
4804 return _gdi_
.MetaFile_GetFileName(*args
, **kwargs
)
4806 def __nonzero__(self
): return self
.Ok()
4807 _gdi_
.MetaFile_swigregister(MetaFile
)
4809 class MetaFileDC(DC
):
4810 """Proxy of C++ MetaFileDC 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 def __init__(self
, *args
, **kwargs
):
4815 __init__(self, String filename=EmptyString, int width=0, int height=0,
4816 String description=EmptyString) -> MetaFileDC
4818 _gdi_
.MetaFileDC_swiginit(self
,_gdi_
.new_MetaFileDC(*args
, **kwargs
))
4819 def Close(*args
, **kwargs
):
4820 """Close(self) -> MetaFile"""
4821 return _gdi_
.MetaFileDC_Close(*args
, **kwargs
)
4823 _gdi_
.MetaFileDC_swigregister(MetaFileDC
)
4825 class PrinterDC(DC
):
4826 """Proxy of C++ PrinterDC class"""
4827 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4828 __repr__
= _swig_repr
4829 def __init__(self
, *args
, **kwargs
):
4830 """__init__(self, wxPrintData printData) -> PrinterDC"""
4831 _gdi_
.PrinterDC_swiginit(self
,_gdi_
.new_PrinterDC(*args
, **kwargs
))
4832 _gdi_
.PrinterDC_swigregister(PrinterDC
)
4834 #---------------------------------------------------------------------------
4836 IMAGELIST_DRAW_NORMAL
= _gdi_
.IMAGELIST_DRAW_NORMAL
4837 IMAGELIST_DRAW_TRANSPARENT
= _gdi_
.IMAGELIST_DRAW_TRANSPARENT
4838 IMAGELIST_DRAW_SELECTED
= _gdi_
.IMAGELIST_DRAW_SELECTED
4839 IMAGELIST_DRAW_FOCUSED
= _gdi_
.IMAGELIST_DRAW_FOCUSED
4840 IMAGE_LIST_NORMAL
= _gdi_
.IMAGE_LIST_NORMAL
4841 IMAGE_LIST_SMALL
= _gdi_
.IMAGE_LIST_SMALL
4842 IMAGE_LIST_STATE
= _gdi_
.IMAGE_LIST_STATE
4843 class ImageList(_core
.Object
):
4844 """Proxy of C++ ImageList class"""
4845 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4846 __repr__
= _swig_repr
4847 def __init__(self
, *args
, **kwargs
):
4848 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
4849 _gdi_
.ImageList_swiginit(self
,_gdi_
.new_ImageList(*args
, **kwargs
))
4850 __swig_destroy__
= _gdi_
.delete_ImageList
4851 __del__
= lambda self
: None;
4852 def Add(*args
, **kwargs
):
4853 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
4854 return _gdi_
.ImageList_Add(*args
, **kwargs
)
4856 def AddWithColourMask(*args
, **kwargs
):
4857 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
4858 return _gdi_
.ImageList_AddWithColourMask(*args
, **kwargs
)
4860 def AddIcon(*args
, **kwargs
):
4861 """AddIcon(self, Icon icon) -> int"""
4862 return _gdi_
.ImageList_AddIcon(*args
, **kwargs
)
4864 def GetBitmap(*args
, **kwargs
):
4865 """GetBitmap(self, int index) -> Bitmap"""
4866 return _gdi_
.ImageList_GetBitmap(*args
, **kwargs
)
4868 def GetIcon(*args
, **kwargs
):
4869 """GetIcon(self, int index) -> Icon"""
4870 return _gdi_
.ImageList_GetIcon(*args
, **kwargs
)
4872 def Replace(*args
, **kwargs
):
4873 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
4874 return _gdi_
.ImageList_Replace(*args
, **kwargs
)
4876 def Draw(*args
, **kwargs
):
4878 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
4879 bool solidBackground=False) -> bool
4881 return _gdi_
.ImageList_Draw(*args
, **kwargs
)
4883 def GetImageCount(*args
, **kwargs
):
4884 """GetImageCount(self) -> int"""
4885 return _gdi_
.ImageList_GetImageCount(*args
, **kwargs
)
4887 def Remove(*args
, **kwargs
):
4888 """Remove(self, int index) -> bool"""
4889 return _gdi_
.ImageList_Remove(*args
, **kwargs
)
4891 def RemoveAll(*args
, **kwargs
):
4892 """RemoveAll(self) -> bool"""
4893 return _gdi_
.ImageList_RemoveAll(*args
, **kwargs
)
4895 def GetSize(*args
, **kwargs
):
4896 """GetSize(index) -> (width,height)"""
4897 return _gdi_
.ImageList_GetSize(*args
, **kwargs
)
4899 ImageCount
= property(GetImageCount
,doc
="See `GetImageCount`")
4900 Size
= property(GetSize
,doc
="See `GetSize`")
4901 _gdi_
.ImageList_swigregister(ImageList
)
4903 #---------------------------------------------------------------------------
4905 class StockGDI(object):
4906 """Proxy of C++ StockGDI class"""
4907 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4908 __repr__
= _swig_repr
4909 BRUSH_BLACK
= _gdi_
.StockGDI_BRUSH_BLACK
4910 BRUSH_BLUE
= _gdi_
.StockGDI_BRUSH_BLUE
4911 BRUSH_CYAN
= _gdi_
.StockGDI_BRUSH_CYAN
4912 BRUSH_GREEN
= _gdi_
.StockGDI_BRUSH_GREEN
4913 BRUSH_GREY
= _gdi_
.StockGDI_BRUSH_GREY
4914 BRUSH_LIGHTGREY
= _gdi_
.StockGDI_BRUSH_LIGHTGREY
4915 BRUSH_MEDIUMGREY
= _gdi_
.StockGDI_BRUSH_MEDIUMGREY
4916 BRUSH_RED
= _gdi_
.StockGDI_BRUSH_RED
4917 BRUSH_TRANSPARENT
= _gdi_
.StockGDI_BRUSH_TRANSPARENT
4918 BRUSH_WHITE
= _gdi_
.StockGDI_BRUSH_WHITE
4919 COLOUR_BLACK
= _gdi_
.StockGDI_COLOUR_BLACK
4920 COLOUR_BLUE
= _gdi_
.StockGDI_COLOUR_BLUE
4921 COLOUR_CYAN
= _gdi_
.StockGDI_COLOUR_CYAN
4922 COLOUR_GREEN
= _gdi_
.StockGDI_COLOUR_GREEN
4923 COLOUR_LIGHTGREY
= _gdi_
.StockGDI_COLOUR_LIGHTGREY
4924 COLOUR_RED
= _gdi_
.StockGDI_COLOUR_RED
4925 COLOUR_WHITE
= _gdi_
.StockGDI_COLOUR_WHITE
4926 CURSOR_CROSS
= _gdi_
.StockGDI_CURSOR_CROSS
4927 CURSOR_HOURGLASS
= _gdi_
.StockGDI_CURSOR_HOURGLASS
4928 CURSOR_STANDARD
= _gdi_
.StockGDI_CURSOR_STANDARD
4929 FONT_ITALIC
= _gdi_
.StockGDI_FONT_ITALIC
4930 FONT_NORMAL
= _gdi_
.StockGDI_FONT_NORMAL
4931 FONT_SMALL
= _gdi_
.StockGDI_FONT_SMALL
4932 FONT_SWISS
= _gdi_
.StockGDI_FONT_SWISS
4933 PEN_BLACK
= _gdi_
.StockGDI_PEN_BLACK
4934 PEN_BLACKDASHED
= _gdi_
.StockGDI_PEN_BLACKDASHED
4935 PEN_CYAN
= _gdi_
.StockGDI_PEN_CYAN
4936 PEN_GREEN
= _gdi_
.StockGDI_PEN_GREEN
4937 PEN_GREY
= _gdi_
.StockGDI_PEN_GREY
4938 PEN_LIGHTGREY
= _gdi_
.StockGDI_PEN_LIGHTGREY
4939 PEN_MEDIUMGREY
= _gdi_
.StockGDI_PEN_MEDIUMGREY
4940 PEN_RED
= _gdi_
.StockGDI_PEN_RED
4941 PEN_TRANSPARENT
= _gdi_
.StockGDI_PEN_TRANSPARENT
4942 PEN_WHITE
= _gdi_
.StockGDI_PEN_WHITE
4943 ITEMCOUNT
= _gdi_
.StockGDI_ITEMCOUNT
4944 def __init__(self
, *args
, **kwargs
):
4945 """__init__(self) -> StockGDI"""
4946 _gdi_
.StockGDI_swiginit(self
,_gdi_
.new_StockGDI(*args
, **kwargs
))
4947 __swig_destroy__
= _gdi_
.delete_StockGDI
4948 __del__
= lambda self
: None;
4949 def DeleteAll(*args
, **kwargs
):
4951 return _gdi_
.StockGDI_DeleteAll(*args
, **kwargs
)
4953 DeleteAll
= staticmethod(DeleteAll
)
4954 def instance(*args
, **kwargs
):
4955 """instance() -> StockGDI"""
4956 return _gdi_
.StockGDI_instance(*args
, **kwargs
)
4958 instance
= staticmethod(instance
)
4959 def GetBrush(*args
, **kwargs
):
4960 """GetBrush(int item) -> Brush"""
4961 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
4963 GetBrush
= staticmethod(GetBrush
)
4964 def GetColour(*args
, **kwargs
):
4965 """GetColour(int item) -> Colour"""
4966 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
4968 GetColour
= staticmethod(GetColour
)
4969 def GetCursor(*args
, **kwargs
):
4970 """GetCursor(int item) -> Cursor"""
4971 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
4973 GetCursor
= staticmethod(GetCursor
)
4974 def GetPen(*args
, **kwargs
):
4975 """GetPen(int item) -> Pen"""
4976 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
4978 GetPen
= staticmethod(GetPen
)
4979 def GetFont(*args
, **kwargs
):
4980 """GetFont(self, int item) -> Font"""
4981 return _gdi_
.StockGDI_GetFont(*args
, **kwargs
)
4983 def _initStockObjects():
4985 wx
.ITALIC_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_ITALIC
).this
4986 wx
.NORMAL_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_NORMAL
).this
4987 wx
.SMALL_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_SMALL
).this
4988 wx
.SWISS_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_SWISS
).this
4990 wx
.BLACK_DASHED_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_BLACKDASHED
).this
4991 wx
.BLACK_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_BLACK
).this
4992 wx
.CYAN_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_CYAN
).this
4993 wx
.GREEN_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_GREEN
).this
4994 wx
.GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_GREY
).this
4995 wx
.LIGHT_GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_LIGHTGREY
).this
4996 wx
.MEDIUM_GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_MEDIUMGREY
).this
4997 wx
.RED_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_RED
).this
4998 wx
.TRANSPARENT_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_TRANSPARENT
).this
4999 wx
.WHITE_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_WHITE
).this
5001 wx
.BLACK_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLACK
).this
5002 wx
.BLUE_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLUE
).this
5003 wx
.CYAN_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_CYAN
).this
5004 wx
.GREEN_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREEN
).this
5005 wx
.GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREY
).this
5006 wx
.LIGHT_GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_LIGHTGREY
).this
5007 wx
.MEDIUM_GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_MEDIUMGREY
).this
5008 wx
.RED_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_RED
).this
5009 wx
.TRANSPARENT_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_TRANSPARENT
).this
5010 wx
.WHITE_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_WHITE
).this
5012 wx
.BLACK
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_BLACK
).this
5013 wx
.BLUE
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_BLUE
).this
5014 wx
.CYAN
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_CYAN
).this
5015 wx
.GREEN
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_GREEN
).this
5016 wx
.LIGHT_GREY
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_LIGHTGREY
).this
5017 wx
.RED
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_RED
).this
5018 wx
.WHITE
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_WHITE
).this
5020 wx
.CROSS_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_CROSS
).this
5021 wx
.HOURGLASS_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_HOURGLASS
).this
5022 wx
.STANDARD_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_STANDARD
).this
5024 wx
.TheFontList
.this
= _wxPyInitTheFontList().this
5025 wx
.ThePenList
.this
= _wxPyInitThePenList().this
5026 wx
.TheBrushList
.this
= _wxPyInitTheBrushList().this
5027 wx
.TheColourDatabase
.this
= _wxPyInitTheColourDatabase().this
5030 _initStockObjects
= staticmethod(_initStockObjects
)
5032 _gdi_
.StockGDI_swigregister(StockGDI
)
5034 def StockGDI_DeleteAll(*args
):
5035 """StockGDI_DeleteAll()"""
5036 return _gdi_
.StockGDI_DeleteAll(*args
)
5038 def StockGDI_instance(*args
):
5039 """StockGDI_instance() -> StockGDI"""
5040 return _gdi_
.StockGDI_instance(*args
)
5042 def StockGDI_GetBrush(*args
, **kwargs
):
5043 """StockGDI_GetBrush(int item) -> Brush"""
5044 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
5046 def StockGDI_GetColour(*args
, **kwargs
):
5047 """StockGDI_GetColour(int item) -> Colour"""
5048 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
5050 def StockGDI_GetCursor(*args
, **kwargs
):
5051 """StockGDI_GetCursor(int item) -> Cursor"""
5052 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
5054 def StockGDI_GetPen(*args
, **kwargs
):
5055 """StockGDI_GetPen(int item) -> Pen"""
5056 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
5058 # Create an uninitialized instance for the stock objects, they will
5059 # be initialized later when the wx.App object is created.
5060 ITALIC_FONT
= Font
.__new
__(Font
)
5061 NORMAL_FONT
= Font
.__new
__(Font
)
5062 SMALL_FONT
= Font
.__new
__(Font
)
5063 SWISS_FONT
= Font
.__new
__(Font
)
5065 BLACK_DASHED_PEN
= Pen
.__new
__(Pen
)
5066 BLACK_PEN
= Pen
.__new
__(Pen
)
5067 CYAN_PEN
= Pen
.__new
__(Pen
)
5068 GREEN_PEN
= Pen
.__new
__(Pen
)
5069 GREY_PEN
= Pen
.__new
__(Pen
)
5070 LIGHT_GREY_PEN
= Pen
.__new
__(Pen
)
5071 MEDIUM_GREY_PEN
= Pen
.__new
__(Pen
)
5072 RED_PEN
= Pen
.__new
__(Pen
)
5073 TRANSPARENT_PEN
= Pen
.__new
__(Pen
)
5074 WHITE_PEN
= Pen
.__new
__(Pen
)
5076 BLACK_BRUSH
= Brush
.__new
__(Brush
)
5077 BLUE_BRUSH
= Brush
.__new
__(Brush
)
5078 CYAN_BRUSH
= Brush
.__new
__(Brush
)
5079 GREEN_BRUSH
= Brush
.__new
__(Brush
)
5080 GREY_BRUSH
= Brush
.__new
__(Brush
)
5081 LIGHT_GREY_BRUSH
= Brush
.__new
__(Brush
)
5082 MEDIUM_GREY_BRUSH
= Brush
.__new
__(Brush
)
5083 RED_BRUSH
= Brush
.__new
__(Brush
)
5084 TRANSPARENT_BRUSH
= Brush
.__new
__(Brush
)
5085 WHITE_BRUSH
= Brush
.__new
__(Brush
)
5087 BLACK
= Colour
.__new
__(Colour
)
5088 BLUE
= Colour
.__new
__(Colour
)
5089 CYAN
= Colour
.__new
__(Colour
)
5090 GREEN
= Colour
.__new
__(Colour
)
5091 LIGHT_GREY
= Colour
.__new
__(Colour
)
5092 RED
= Colour
.__new
__(Colour
)
5093 WHITE
= Colour
.__new
__(Colour
)
5095 CROSS_CURSOR
= Cursor
.__new
__(Cursor
)
5096 HOURGLASS_CURSOR
= Cursor
.__new
__(Cursor
)
5097 STANDARD_CURSOR
= Cursor
.__new
__(Cursor
)
5099 class GDIObjListBase(object):
5100 """Proxy of C++ GDIObjListBase class"""
5101 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5102 __repr__
= _swig_repr
5103 def __init__(self
, *args
, **kwargs
):
5104 """__init__(self) -> GDIObjListBase"""
5105 _gdi_
.GDIObjListBase_swiginit(self
,_gdi_
.new_GDIObjListBase(*args
, **kwargs
))
5106 __swig_destroy__
= _gdi_
.delete_GDIObjListBase
5107 __del__
= lambda self
: None;
5108 _gdi_
.GDIObjListBase_swigregister(GDIObjListBase
)
5110 NullBitmap
= cvar
.NullBitmap
5111 NullIcon
= cvar
.NullIcon
5112 NullCursor
= cvar
.NullCursor
5113 NullPen
= cvar
.NullPen
5114 NullBrush
= cvar
.NullBrush
5115 NullPalette
= cvar
.NullPalette
5116 NullFont
= cvar
.NullFont
5117 NullColour
= cvar
.NullColour
5119 class PenList(GDIObjListBase
):
5120 """Proxy of C++ PenList class"""
5121 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5122 def __init__(self
): raise AttributeError, "No constructor defined"
5123 __repr__
= _swig_repr
5124 def FindOrCreatePen(*args
, **kwargs
):
5125 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
5126 return _gdi_
.PenList_FindOrCreatePen(*args
, **kwargs
)
5128 def AddPen(*args
, **kwargs
):
5129 """AddPen(self, Pen pen)"""
5130 return _gdi_
.PenList_AddPen(*args
, **kwargs
)
5132 def RemovePen(*args
, **kwargs
):
5133 """RemovePen(self, Pen pen)"""
5134 return _gdi_
.PenList_RemovePen(*args
, **kwargs
)
5136 AddPen
= wx
._deprecated
(AddPen
)
5137 RemovePen
= wx
._deprecated
(RemovePen
)
5139 _gdi_
.PenList_swigregister(PenList
)
5141 class BrushList(GDIObjListBase
):
5142 """Proxy of C++ BrushList class"""
5143 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5144 def __init__(self
): raise AttributeError, "No constructor defined"
5145 __repr__
= _swig_repr
5146 def FindOrCreateBrush(*args
, **kwargs
):
5147 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
5148 return _gdi_
.BrushList_FindOrCreateBrush(*args
, **kwargs
)
5150 def AddBrush(*args
, **kwargs
):
5151 """AddBrush(self, Brush brush)"""
5152 return _gdi_
.BrushList_AddBrush(*args
, **kwargs
)
5154 def RemoveBrush(*args
, **kwargs
):
5155 """RemoveBrush(self, Brush brush)"""
5156 return _gdi_
.BrushList_RemoveBrush(*args
, **kwargs
)
5158 AddBrush
= wx
._deprecated
(AddBrush
)
5159 RemoveBrush
= wx
._deprecated
(RemoveBrush
)
5161 _gdi_
.BrushList_swigregister(BrushList
)
5163 class FontList(GDIObjListBase
):
5164 """Proxy of C++ FontList class"""
5165 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5166 def __init__(self
): raise AttributeError, "No constructor defined"
5167 __repr__
= _swig_repr
5168 def FindOrCreateFont(*args
, **kwargs
):
5170 FindOrCreateFont(self, int point_size, int family, int style, int weight,
5171 bool underline=False, String facename=EmptyString,
5172 int encoding=FONTENCODING_DEFAULT) -> Font
5174 return _gdi_
.FontList_FindOrCreateFont(*args
, **kwargs
)
5176 def AddFont(*args
, **kwargs
):
5177 """AddFont(self, Font font)"""
5178 return _gdi_
.FontList_AddFont(*args
, **kwargs
)
5180 def RemoveFont(*args
, **kwargs
):
5181 """RemoveFont(self, Font font)"""
5182 return _gdi_
.FontList_RemoveFont(*args
, **kwargs
)
5184 AddFont
= wx
._deprecated
(AddFont
)
5185 RemoveFont
= wx
._deprecated
(RemoveFont
)
5187 _gdi_
.FontList_swigregister(FontList
)
5189 class ColourDatabase(object):
5190 """Proxy of C++ ColourDatabase class"""
5191 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5192 __repr__
= _swig_repr
5193 def __init__(self
, *args
, **kwargs
):
5194 """__init__(self) -> ColourDatabase"""
5195 _gdi_
.ColourDatabase_swiginit(self
,_gdi_
.new_ColourDatabase(*args
, **kwargs
))
5196 __swig_destroy__
= _gdi_
.delete_ColourDatabase
5197 __del__
= lambda self
: None;
5198 def Find(*args
, **kwargs
):
5199 """Find(self, String name) -> Colour"""
5200 return _gdi_
.ColourDatabase_Find(*args
, **kwargs
)
5202 def FindName(*args
, **kwargs
):
5203 """FindName(self, Colour colour) -> String"""
5204 return _gdi_
.ColourDatabase_FindName(*args
, **kwargs
)
5207 def AddColour(*args
, **kwargs
):
5208 """AddColour(self, String name, Colour colour)"""
5209 return _gdi_
.ColourDatabase_AddColour(*args
, **kwargs
)
5211 def Append(*args
, **kwargs
):
5212 """Append(self, String name, int red, int green, int blue)"""
5213 return _gdi_
.ColourDatabase_Append(*args
, **kwargs
)
5215 _gdi_
.ColourDatabase_swigregister(ColourDatabase
)
5217 #---------------------------------------------------------------------------
5220 def _wxPyInitTheFontList(*args
):
5221 """_wxPyInitTheFontList() -> FontList"""
5222 return _gdi_
._wxPyInitTheFontList
(*args
)
5224 def _wxPyInitThePenList(*args
):
5225 """_wxPyInitThePenList() -> PenList"""
5226 return _gdi_
._wxPyInitThePenList
(*args
)
5228 def _wxPyInitTheBrushList(*args
):
5229 """_wxPyInitTheBrushList() -> BrushList"""
5230 return _gdi_
._wxPyInitTheBrushList
(*args
)
5232 def _wxPyInitTheColourDatabase(*args
):
5233 """_wxPyInitTheColourDatabase() -> ColourDatabase"""
5234 return _gdi_
._wxPyInitTheColourDatabase
(*args
)
5235 # Create an uninitialized instance for the stock objects, they will
5236 # be initialized later when the wx.App object is created.
5237 TheFontList
= FontList
.__new
__(FontList
)
5238 ThePenList
= PenList
.__new
__(PenList
)
5239 TheBrushList
= BrushList
.__new
__(BrushList
)
5240 TheColourDatabase
= ColourDatabase
.__new
__(ColourDatabase
)
5242 NullColor
= NullColour
5243 #---------------------------------------------------------------------------
5245 class Effects(_core
.Object
):
5246 """Proxy of C++ Effects class"""
5247 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5248 __repr__
= _swig_repr
5249 def __init__(self
, *args
, **kwargs
):
5250 """__init__(self) -> Effects"""
5251 _gdi_
.Effects_swiginit(self
,_gdi_
.new_Effects(*args
, **kwargs
))
5252 def GetHighlightColour(*args
, **kwargs
):
5253 """GetHighlightColour(self) -> Colour"""
5254 return _gdi_
.Effects_GetHighlightColour(*args
, **kwargs
)
5256 def GetLightShadow(*args
, **kwargs
):
5257 """GetLightShadow(self) -> Colour"""
5258 return _gdi_
.Effects_GetLightShadow(*args
, **kwargs
)
5260 def GetFaceColour(*args
, **kwargs
):
5261 """GetFaceColour(self) -> Colour"""
5262 return _gdi_
.Effects_GetFaceColour(*args
, **kwargs
)
5264 def GetMediumShadow(*args
, **kwargs
):
5265 """GetMediumShadow(self) -> Colour"""
5266 return _gdi_
.Effects_GetMediumShadow(*args
, **kwargs
)
5268 def GetDarkShadow(*args
, **kwargs
):
5269 """GetDarkShadow(self) -> Colour"""
5270 return _gdi_
.Effects_GetDarkShadow(*args
, **kwargs
)
5272 def SetHighlightColour(*args
, **kwargs
):
5273 """SetHighlightColour(self, Colour c)"""
5274 return _gdi_
.Effects_SetHighlightColour(*args
, **kwargs
)
5276 def SetLightShadow(*args
, **kwargs
):
5277 """SetLightShadow(self, Colour c)"""
5278 return _gdi_
.Effects_SetLightShadow(*args
, **kwargs
)
5280 def SetFaceColour(*args
, **kwargs
):
5281 """SetFaceColour(self, Colour c)"""
5282 return _gdi_
.Effects_SetFaceColour(*args
, **kwargs
)
5284 def SetMediumShadow(*args
, **kwargs
):
5285 """SetMediumShadow(self, Colour c)"""
5286 return _gdi_
.Effects_SetMediumShadow(*args
, **kwargs
)
5288 def SetDarkShadow(*args
, **kwargs
):
5289 """SetDarkShadow(self, Colour c)"""
5290 return _gdi_
.Effects_SetDarkShadow(*args
, **kwargs
)
5292 def Set(*args
, **kwargs
):
5294 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
5295 Colour mediumShadow, Colour darkShadow)
5297 return _gdi_
.Effects_Set(*args
, **kwargs
)
5299 def DrawSunkenEdge(*args
, **kwargs
):
5300 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
5301 return _gdi_
.Effects_DrawSunkenEdge(*args
, **kwargs
)
5303 def TileBitmap(*args
, **kwargs
):
5304 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
5305 return _gdi_
.Effects_TileBitmap(*args
, **kwargs
)
5307 DarkShadow
= property(GetDarkShadow
,SetDarkShadow
,doc
="See `GetDarkShadow` and `SetDarkShadow`")
5308 FaceColour
= property(GetFaceColour
,SetFaceColour
,doc
="See `GetFaceColour` and `SetFaceColour`")
5309 HighlightColour
= property(GetHighlightColour
,SetHighlightColour
,doc
="See `GetHighlightColour` and `SetHighlightColour`")
5310 LightShadow
= property(GetLightShadow
,SetLightShadow
,doc
="See `GetLightShadow` and `SetLightShadow`")
5311 MediumShadow
= property(GetMediumShadow
,SetMediumShadow
,doc
="See `GetMediumShadow` and `SetMediumShadow`")
5312 _gdi_
.Effects_swigregister(Effects
)
5314 #---------------------------------------------------------------------------
5316 CONTROL_DISABLED
= _gdi_
.CONTROL_DISABLED
5317 CONTROL_FOCUSED
= _gdi_
.CONTROL_FOCUSED
5318 CONTROL_PRESSED
= _gdi_
.CONTROL_PRESSED
5319 CONTROL_ISDEFAULT
= _gdi_
.CONTROL_ISDEFAULT
5320 CONTROL_ISSUBMENU
= _gdi_
.CONTROL_ISSUBMENU
5321 CONTROL_EXPANDED
= _gdi_
.CONTROL_EXPANDED
5322 CONTROL_CURRENT
= _gdi_
.CONTROL_CURRENT
5323 CONTROL_SELECTED
= _gdi_
.CONTROL_SELECTED
5324 CONTROL_CHECKED
= _gdi_
.CONTROL_CHECKED
5325 CONTROL_CHECKABLE
= _gdi_
.CONTROL_CHECKABLE
5326 CONTROL_UNDETERMINED
= _gdi_
.CONTROL_UNDETERMINED
5327 CONTROL_FLAGS_MASK
= _gdi_
.CONTROL_FLAGS_MASK
5328 CONTROL_DIRTY
= _gdi_
.CONTROL_DIRTY
5329 class SplitterRenderParams(object):
5331 This is just a simple struct used as a return value of
5332 `wx.RendererNative.GetSplitterParams` and contains some platform
5333 specific metrics about splitters.
5335 * widthSash: the width of the splitter sash.
5336 * border: the width of the border of the splitter window.
5337 * isHotSensitive: ``True`` if the splitter changes its
5338 appearance when the mouse is over it.
5342 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5343 __repr__
= _swig_repr
5344 def __init__(self
, *args
, **kwargs
):
5346 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5348 This is just a simple struct used as a return value of
5349 `wx.RendererNative.GetSplitterParams` and contains some platform
5350 specific metrics about splitters.
5352 * widthSash: the width of the splitter sash.
5353 * border: the width of the border of the splitter window.
5354 * isHotSensitive: ``True`` if the splitter changes its
5355 appearance when the mouse is over it.
5359 _gdi_
.SplitterRenderParams_swiginit(self
,_gdi_
.new_SplitterRenderParams(*args
, **kwargs
))
5360 __swig_destroy__
= _gdi_
.delete_SplitterRenderParams
5361 __del__
= lambda self
: None;
5362 widthSash
= property(_gdi_
.SplitterRenderParams_widthSash_get
)
5363 border
= property(_gdi_
.SplitterRenderParams_border_get
)
5364 isHotSensitive
= property(_gdi_
.SplitterRenderParams_isHotSensitive_get
)
5365 _gdi_
.SplitterRenderParams_swigregister(SplitterRenderParams
)
5367 class RendererVersion(object):
5369 This simple struct represents the `wx.RendererNative` interface
5370 version and is only used as the return value of
5371 `wx.RendererNative.GetVersion`.
5373 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5374 __repr__
= _swig_repr
5375 def __init__(self
, *args
, **kwargs
):
5377 __init__(self, int version_, int age_) -> RendererVersion
5379 This simple struct represents the `wx.RendererNative` interface
5380 version and is only used as the return value of
5381 `wx.RendererNative.GetVersion`.
5383 _gdi_
.RendererVersion_swiginit(self
,_gdi_
.new_RendererVersion(*args
, **kwargs
))
5384 __swig_destroy__
= _gdi_
.delete_RendererVersion
5385 __del__
= lambda self
: None;
5386 Current_Version
= _gdi_
.RendererVersion_Current_Version
5387 Current_Age
= _gdi_
.RendererVersion_Current_Age
5388 def IsCompatible(*args
, **kwargs
):
5389 """IsCompatible(RendererVersion ver) -> bool"""
5390 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
5392 IsCompatible
= staticmethod(IsCompatible
)
5393 version
= property(_gdi_
.RendererVersion_version_get
)
5394 age
= property(_gdi_
.RendererVersion_age_get
)
5395 _gdi_
.RendererVersion_swigregister(RendererVersion
)
5397 def RendererVersion_IsCompatible(*args
, **kwargs
):
5398 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5399 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
5401 class RendererNative(object):
5403 One of the design principles of wxWidgets is to use the native widgets
5404 on every platform in order to be as close to the native look and feel
5405 on every platform. However there are still cases when some generic
5406 widgets are needed for various reasons, but it can sometimes take a
5407 lot of messy work to make them conform to the native LnF.
5409 The wx.RendererNative class is a collection of functions that have
5410 platform-specific implementations for drawing certain parts of
5411 genereic controls in ways that are as close to the native look as
5414 Note that each drawing function restores the `wx.DC` attributes if it
5415 changes them, so it is safe to assume that the same pen, brush and
5416 colours that were active before the call to this function are still in
5420 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5421 def __init__(self
): raise AttributeError, "No constructor defined"
5422 __repr__
= _swig_repr
5423 def DrawHeaderButton(*args
, **kwargs
):
5425 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0)
5427 Draw the header control button (such as what is used by `wx.ListCtrl`
5430 return _gdi_
.RendererNative_DrawHeaderButton(*args
, **kwargs
)
5432 def DrawTreeItemButton(*args
, **kwargs
):
5434 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5436 Draw the expanded/collapsed icon for a tree control item.
5438 return _gdi_
.RendererNative_DrawTreeItemButton(*args
, **kwargs
)
5440 def DrawSplitterBorder(*args
, **kwargs
):
5442 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5444 Draw the border for a sash window: this border must be such that the
5445 sash drawn by `DrawSplitterSash` blends into it well.
5447 return _gdi_
.RendererNative_DrawSplitterBorder(*args
, **kwargs
)
5449 def DrawSplitterSash(*args
, **kwargs
):
5451 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5454 Draw a sash. The orient parameter defines whether the sash should be
5455 vertical or horizontal and how the position should be interpreted.
5457 return _gdi_
.RendererNative_DrawSplitterSash(*args
, **kwargs
)
5459 def DrawComboBoxDropButton(*args
, **kwargs
):
5461 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5463 Draw a button like the one used by `wx.ComboBox` to show a drop down
5464 window. The usual appearance is a downwards pointing arrow.
5466 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5467 ``wx.CONTROL_CURRENT`` bits set.
5469 return _gdi_
.RendererNative_DrawComboBoxDropButton(*args
, **kwargs
)
5471 def DrawDropArrow(*args
, **kwargs
):
5473 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5475 Draw a drop down arrow that is suitable for use outside a combo
5476 box. Arrow will have a transparent background.
5478 ``rect`` is not entirely filled by the arrow. Instead, you should use
5479 bounding rectangle of a drop down button which arrow matches the size
5480 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5481 ``wx.CONTROL_CURRENT`` bit set.
5483 return _gdi_
.RendererNative_DrawDropArrow(*args
, **kwargs
)
5485 def DrawCheckBox(*args
, **kwargs
):
5487 DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0)
5489 Draw a check button. Flags may use wx.CONTROL_CHECKED,
5490 wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.
5492 return _gdi_
.RendererNative_DrawCheckBox(*args
, **kwargs
)
5494 def DrawPushButton(*args
, **kwargs
):
5496 DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0)
5498 Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
5499 wx.CONTROL_ISDEFAULT
5501 return _gdi_
.RendererNative_DrawPushButton(*args
, **kwargs
)
5503 def DrawItemSelectionRect(*args
, **kwargs
):
5505 DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0)
5507 Draw rectangle indicating that an item in e.g. a list control has been
5510 The flags parameter may be:
5512 ==================== ============================================
5513 wx.CONTROL_SELECTED item is selected, e.g. draw background
5514 wx.CONTROL_CURRENT item is the current item, e.g. dotted border
5515 wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
5516 background vs. grey otherwise
5517 ==================== ============================================
5520 return _gdi_
.RendererNative_DrawItemSelectionRect(*args
, **kwargs
)
5522 def GetSplitterParams(*args
, **kwargs
):
5524 GetSplitterParams(self, Window win) -> SplitterRenderParams
5526 Get the splitter parameters, see `wx.SplitterRenderParams`.
5528 return _gdi_
.RendererNative_GetSplitterParams(*args
, **kwargs
)
5530 def Get(*args
, **kwargs
):
5532 Get() -> RendererNative
5534 Return the currently used renderer
5536 return _gdi_
.RendererNative_Get(*args
, **kwargs
)
5538 Get
= staticmethod(Get
)
5539 def GetGeneric(*args
, **kwargs
):
5541 GetGeneric() -> RendererNative
5543 Return the generic implementation of the renderer. Under some
5544 platforms, this is the default renderer implementation, others have
5545 platform-specific default renderer which can be retrieved by calling
5546 `wx.RendererNative.GetDefault`.
5548 return _gdi_
.RendererNative_GetGeneric(*args
, **kwargs
)
5550 GetGeneric
= staticmethod(GetGeneric
)
5551 def GetDefault(*args
, **kwargs
):
5553 GetDefault() -> RendererNative
5555 Return the default (native) implementation for this platform -- this
5556 is also the one used by default but this may be changed by calling
5557 `wx.RendererNative.Set` in which case the return value of this method
5558 may be different from the return value of `wx.RendererNative.Get`.
5560 return _gdi_
.RendererNative_GetDefault(*args
, **kwargs
)
5562 GetDefault
= staticmethod(GetDefault
)
5563 def Set(*args
, **kwargs
):
5565 Set(RendererNative renderer) -> RendererNative
5567 Set the renderer to use, passing None reverts to using the default
5568 renderer. Returns the previous renderer used with Set or None.
5570 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
5572 Set
= staticmethod(Set
)
5573 def GetVersion(*args
, **kwargs
):
5575 GetVersion(self) -> RendererVersion
5577 Returns the version of the renderer. Will be used for ensuring
5578 compatibility of dynamically loaded renderers.
5580 return _gdi_
.RendererNative_GetVersion(*args
, **kwargs
)
5582 _gdi_
.RendererNative_swigregister(RendererNative
)
5584 def RendererNative_Get(*args
):
5586 RendererNative_Get() -> RendererNative
5588 Return the currently used renderer
5590 return _gdi_
.RendererNative_Get(*args
)
5592 def RendererNative_GetGeneric(*args
):
5594 RendererNative_GetGeneric() -> RendererNative
5596 Return the generic implementation of the renderer. Under some
5597 platforms, this is the default renderer implementation, others have
5598 platform-specific default renderer which can be retrieved by calling
5599 `wx.RendererNative.GetDefault`.
5601 return _gdi_
.RendererNative_GetGeneric(*args
)
5603 def RendererNative_GetDefault(*args
):
5605 RendererNative_GetDefault() -> RendererNative
5607 Return the default (native) implementation for this platform -- this
5608 is also the one used by default but this may be changed by calling
5609 `wx.RendererNative.Set` in which case the return value of this method
5610 may be different from the return value of `wx.RendererNative.Get`.
5612 return _gdi_
.RendererNative_GetDefault(*args
)
5614 def RendererNative_Set(*args
, **kwargs
):
5616 RendererNative_Set(RendererNative renderer) -> RendererNative
5618 Set the renderer to use, passing None reverts to using the default
5619 renderer. Returns the previous renderer used with Set or None.
5621 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
5623 #---------------------------------------------------------------------------
5625 class PseudoDC(_core
.Object
):
5627 A PseudoDC is an object that can be used as if it were a `wx.DC`. All
5628 commands issued to the PseudoDC are stored in a list. You can then
5629 play these commands back to a real DC object using the DrawToDC
5630 method. Commands in the command list are indexed by ID. You can use
5631 this to clear the operations associated with a single ID and then
5632 re-draw the object associated with that ID.
5634 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5635 __repr__
= _swig_repr
5636 def __init__(self
, *args
, **kwargs
):
5638 __init__(self) -> PseudoDC
5640 Constructs a new Pseudo device context for recording dc operations
5642 _gdi_
.PseudoDC_swiginit(self
,_gdi_
.new_PseudoDC(*args
, **kwargs
))
5643 def BeginDrawing(*args
, **kwargs
):
5647 Allows for optimization of drawing code on platforms that need it. On
5648 other platforms this is just an empty function and is harmless. To
5649 take advantage of this postential optimization simply enclose each
5650 group of calls to the drawing primitives within calls to
5651 `BeginDrawing` and `EndDrawing`.
5653 return _gdi_
.PseudoDC_BeginDrawing(*args
, **kwargs
)
5655 def EndDrawing(*args
, **kwargs
):
5659 Ends the group of drawing primitives started with `BeginDrawing`, and
5660 invokes whatever optimization is available for this DC type on the
5663 return _gdi_
.PseudoDC_EndDrawing(*args
, **kwargs
)
5665 __swig_destroy__
= _gdi_
.delete_PseudoDC
5666 __del__
= lambda self
: None;
5667 def RemoveAll(*args
, **kwargs
):
5671 Removes all objects and operations from the recorded list.
5673 return _gdi_
.PseudoDC_RemoveAll(*args
, **kwargs
)
5675 def GetLen(*args
, **kwargs
):
5679 Returns the number of operations in the recorded list.
5681 return _gdi_
.PseudoDC_GetLen(*args
, **kwargs
)
5683 def SetId(*args
, **kwargs
):
5687 Sets the id to be associated with subsequent operations.
5689 return _gdi_
.PseudoDC_SetId(*args
, **kwargs
)
5691 def ClearId(*args
, **kwargs
):
5693 ClearId(self, int id)
5695 Removes all operations associated with id so the object can be redrawn.
5697 return _gdi_
.PseudoDC_ClearId(*args
, **kwargs
)
5699 def RemoveId(*args
, **kwargs
):
5701 RemoveId(self, int id)
5703 Remove the object node (and all operations) associated with an id.
5705 return _gdi_
.PseudoDC_RemoveId(*args
, **kwargs
)
5707 def TranslateId(*args
, **kwargs
):
5709 TranslateId(self, int id, int dx, int dy)
5711 Translate the operations of id by dx,dy.
5713 return _gdi_
.PseudoDC_TranslateId(*args
, **kwargs
)
5715 def DrawIdToDC(*args
, **kwargs
):
5717 DrawIdToDC(self, int id, DC dc)
5719 Draw recorded operations of id to dc.
5721 return _gdi_
.PseudoDC_DrawIdToDC(*args
, **kwargs
)
5723 def SetIdBounds(*args
, **kwargs
):
5725 SetIdBounds(self, int id, Rect rect)
5727 Set the bounding rect of a given object. This will create
5728 an object node if one doesn't exist.
5730 return _gdi_
.PseudoDC_SetIdBounds(*args
, **kwargs
)
5732 def GetIdBounds(*args
, **kwargs
):
5734 GetIdBounds(self, int id) -> Rect
5736 Returns the bounding rectangle previouly set with SetIdBounds. If
5737 no bounds have been set, it returns wx.Rect(0,0,0,0).
5739 return _gdi_
.PseudoDC_GetIdBounds(*args
, **kwargs
)
5741 def DrawToDCClipped(*args
, **kwargs
):
5743 DrawToDCClipped(self, DC dc, Rect rect)
5745 Draws the recorded operations to dc unless the operation is known to
5748 return _gdi_
.PseudoDC_DrawToDCClipped(*args
, **kwargs
)
5750 def DrawToDCClippedRgn(*args
, **kwargs
):
5752 DrawToDCClippedRgn(self, DC dc, Region region)
5754 Draws the recorded operations to dc unless the operation is known to
5757 return _gdi_
.PseudoDC_DrawToDCClippedRgn(*args
, **kwargs
)
5759 def DrawToDC(*args
, **kwargs
):
5761 DrawToDC(self, DC dc)
5763 Draws the recorded operations to dc.
5765 return _gdi_
.PseudoDC_DrawToDC(*args
, **kwargs
)
5767 def FloodFill(*args
, **kwargs
):
5769 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE)
5771 Flood fills the device context starting from the given point, using
5772 the current brush colour, and using a style:
5774 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5775 the given colour is encountered.
5777 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5780 Returns False if the operation failed.
5782 Note: The present implementation for non-Windows platforms may fail to
5783 find colour borders if the pixels do not match the colour
5784 exactly. However the function will still return true.
5786 return _gdi_
.PseudoDC_FloodFill(*args
, **kwargs
)
5788 def FloodFillPoint(*args
, **kwargs
):
5790 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE)
5792 Flood fills the device context starting from the given point, using
5793 the current brush colour, and using a style:
5795 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5796 the given colour is encountered.
5798 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5801 Returns False if the operation failed.
5803 Note: The present implementation for non-Windows platforms may fail to
5804 find colour borders if the pixels do not match the colour
5805 exactly. However the function will still return true.
5807 return _gdi_
.PseudoDC_FloodFillPoint(*args
, **kwargs
)
5809 def DrawLine(*args
, **kwargs
):
5811 DrawLine(self, int x1, int y1, int x2, int y2)
5813 Draws a line from the first point to the second. The current pen is
5814 used for drawing the line. Note that the second point is *not* part of
5815 the line and is not drawn by this function (this is consistent with
5816 the behaviour of many other toolkits).
5818 return _gdi_
.PseudoDC_DrawLine(*args
, **kwargs
)
5820 def DrawLinePoint(*args
, **kwargs
):
5822 DrawLinePoint(self, Point pt1, Point pt2)
5824 Draws a line from the first point to the second. The current pen is
5825 used for drawing the line. Note that the second point is *not* part of
5826 the line and is not drawn by this function (this is consistent with
5827 the behaviour of many other toolkits).
5829 return _gdi_
.PseudoDC_DrawLinePoint(*args
, **kwargs
)
5831 def CrossHair(*args
, **kwargs
):
5833 CrossHair(self, int x, int y)
5835 Displays a cross hair using the current pen. This is a vertical and
5836 horizontal line the height and width of the window, centred on the
5839 return _gdi_
.PseudoDC_CrossHair(*args
, **kwargs
)
5841 def CrossHairPoint(*args
, **kwargs
):
5843 CrossHairPoint(self, Point pt)
5845 Displays a cross hair using the current pen. This is a vertical and
5846 horizontal line the height and width of the window, centred on the
5849 return _gdi_
.PseudoDC_CrossHairPoint(*args
, **kwargs
)
5851 def DrawArc(*args
, **kwargs
):
5853 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
5855 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5856 the first point to the second. The current pen is used for the outline
5857 and the current brush for filling the shape.
5859 The arc is drawn in an anticlockwise direction from the start point to
5862 return _gdi_
.PseudoDC_DrawArc(*args
, **kwargs
)
5864 def DrawArcPoint(*args
, **kwargs
):
5866 DrawArcPoint(self, Point pt1, Point pt2, Point center)
5868 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5869 the first point to the second. The current pen is used for the outline
5870 and the current brush for filling the shape.
5872 The arc is drawn in an anticlockwise direction from the start point to
5875 return _gdi_
.PseudoDC_DrawArcPoint(*args
, **kwargs
)
5877 def DrawCheckMark(*args
, **kwargs
):
5879 DrawCheckMark(self, int x, int y, int width, int height)
5881 Draws a check mark inside the given rectangle.
5883 return _gdi_
.PseudoDC_DrawCheckMark(*args
, **kwargs
)
5885 def DrawCheckMarkRect(*args
, **kwargs
):
5887 DrawCheckMarkRect(self, Rect rect)
5889 Draws a check mark inside the given rectangle.
5891 return _gdi_
.PseudoDC_DrawCheckMarkRect(*args
, **kwargs
)
5893 def DrawEllipticArc(*args
, **kwargs
):
5895 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
5897 Draws an arc of an ellipse, with the given rectangle defining the
5898 bounds of the ellipse. The current pen is used for drawing the arc and
5899 the current brush is used for drawing the pie.
5901 The *start* and *end* parameters specify the start and end of the arc
5902 relative to the three-o'clock position from the center of the
5903 rectangle. Angles are specified in degrees (360 is a complete
5904 circle). Positive values mean counter-clockwise motion. If start is
5905 equal to end, a complete ellipse will be drawn.
5907 return _gdi_
.PseudoDC_DrawEllipticArc(*args
, **kwargs
)
5909 def DrawEllipticArcPointSize(*args
, **kwargs
):
5911 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
5913 Draws an arc of an ellipse, with the given rectangle defining the
5914 bounds of the ellipse. The current pen is used for drawing the arc and
5915 the current brush is used for drawing the pie.
5917 The *start* and *end* parameters specify the start and end of the arc
5918 relative to the three-o'clock position from the center of the
5919 rectangle. Angles are specified in degrees (360 is a complete
5920 circle). Positive values mean counter-clockwise motion. If start is
5921 equal to end, a complete ellipse will be drawn.
5923 return _gdi_
.PseudoDC_DrawEllipticArcPointSize(*args
, **kwargs
)
5925 def DrawPoint(*args
, **kwargs
):
5927 DrawPoint(self, int x, int y)
5929 Draws a point using the current pen.
5931 return _gdi_
.PseudoDC_DrawPoint(*args
, **kwargs
)
5933 def DrawPointPoint(*args
, **kwargs
):
5935 DrawPointPoint(self, Point pt)
5937 Draws a point using the current pen.
5939 return _gdi_
.PseudoDC_DrawPointPoint(*args
, **kwargs
)
5941 def DrawRectangle(*args
, **kwargs
):
5943 DrawRectangle(self, int x, int y, int width, int height)
5945 Draws a rectangle with the given top left corner, and with the given
5946 size. The current pen is used for the outline and the current brush
5947 for filling the shape.
5949 return _gdi_
.PseudoDC_DrawRectangle(*args
, **kwargs
)
5951 def DrawRectangleRect(*args
, **kwargs
):
5953 DrawRectangleRect(self, Rect rect)
5955 Draws a rectangle with the given top left corner, and with the given
5956 size. The current pen is used for the outline and the current brush
5957 for filling the shape.
5959 return _gdi_
.PseudoDC_DrawRectangleRect(*args
, **kwargs
)
5961 def DrawRectanglePointSize(*args
, **kwargs
):
5963 DrawRectanglePointSize(self, Point pt, Size sz)
5965 Draws a rectangle with the given top left corner, and with the given
5966 size. The current pen is used for the outline and the current brush
5967 for filling the shape.
5969 return _gdi_
.PseudoDC_DrawRectanglePointSize(*args
, **kwargs
)
5971 def DrawRoundedRectangle(*args
, **kwargs
):
5973 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
5975 Draws a rectangle with the given top left corner, and with the given
5976 size. The corners are quarter-circles using the given radius. The
5977 current pen is used for the outline and the current brush for filling
5980 If radius is positive, the value is assumed to be the radius of the
5981 rounded corner. If radius is negative, the absolute value is assumed
5982 to be the proportion of the smallest dimension of the rectangle. This
5983 means that the corner can be a sensible size relative to the size of
5984 the rectangle, and also avoids the strange effects X produces when the
5985 corners are too big for the rectangle.
5987 return _gdi_
.PseudoDC_DrawRoundedRectangle(*args
, **kwargs
)
5989 def DrawRoundedRectangleRect(*args
, **kwargs
):
5991 DrawRoundedRectangleRect(self, Rect r, double radius)
5993 Draws a rectangle with the given top left corner, and with the given
5994 size. The corners are quarter-circles using the given radius. The
5995 current pen is used for the outline and the current brush for filling
5998 If radius is positive, the value is assumed to be the radius of the
5999 rounded corner. If radius is negative, the absolute value is assumed
6000 to be the proportion of the smallest dimension of the rectangle. This
6001 means that the corner can be a sensible size relative to the size of
6002 the rectangle, and also avoids the strange effects X produces when the
6003 corners are too big for the rectangle.
6005 return _gdi_
.PseudoDC_DrawRoundedRectangleRect(*args
, **kwargs
)
6007 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
6009 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
6011 Draws a rectangle with the given top left corner, and with the given
6012 size. The corners are quarter-circles using the given radius. The
6013 current pen is used for the outline and the current brush for filling
6016 If radius is positive, the value is assumed to be the radius of the
6017 rounded corner. If radius is negative, the absolute value is assumed
6018 to be the proportion of the smallest dimension of the rectangle. This
6019 means that the corner can be a sensible size relative to the size of
6020 the rectangle, and also avoids the strange effects X produces when the
6021 corners are too big for the rectangle.
6023 return _gdi_
.PseudoDC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
6025 def DrawCircle(*args
, **kwargs
):
6027 DrawCircle(self, int x, int y, int radius)
6029 Draws a circle with the given center point and radius. The current
6030 pen is used for the outline and the current brush for filling the
6033 return _gdi_
.PseudoDC_DrawCircle(*args
, **kwargs
)
6035 def DrawCirclePoint(*args
, **kwargs
):
6037 DrawCirclePoint(self, Point pt, int radius)
6039 Draws a circle with the given center point and radius. The current
6040 pen is used for the outline and the current brush for filling the
6043 return _gdi_
.PseudoDC_DrawCirclePoint(*args
, **kwargs
)
6045 def DrawEllipse(*args
, **kwargs
):
6047 DrawEllipse(self, int x, int y, int width, int height)
6049 Draws an ellipse contained in the specified rectangle. The current pen
6050 is used for the outline and the current brush for filling the shape.
6052 return _gdi_
.PseudoDC_DrawEllipse(*args
, **kwargs
)
6054 def DrawEllipseRect(*args
, **kwargs
):
6056 DrawEllipseRect(self, Rect rect)
6058 Draws an ellipse contained in the specified rectangle. The current pen
6059 is used for the outline and the current brush for filling the shape.
6061 return _gdi_
.PseudoDC_DrawEllipseRect(*args
, **kwargs
)
6063 def DrawEllipsePointSize(*args
, **kwargs
):
6065 DrawEllipsePointSize(self, Point pt, Size sz)
6067 Draws an ellipse contained in the specified rectangle. The current pen
6068 is used for the outline and the current brush for filling the shape.
6070 return _gdi_
.PseudoDC_DrawEllipsePointSize(*args
, **kwargs
)
6072 def DrawIcon(*args
, **kwargs
):
6074 DrawIcon(self, Icon icon, int x, int y)
6076 Draw an icon on the display (does nothing if the device context is
6077 PostScript). This can be the simplest way of drawing bitmaps on a
6080 return _gdi_
.PseudoDC_DrawIcon(*args
, **kwargs
)
6082 def DrawIconPoint(*args
, **kwargs
):
6084 DrawIconPoint(self, Icon icon, Point pt)
6086 Draw an icon on the display (does nothing if the device context is
6087 PostScript). This can be the simplest way of drawing bitmaps on a
6090 return _gdi_
.PseudoDC_DrawIconPoint(*args
, **kwargs
)
6092 def DrawBitmap(*args
, **kwargs
):
6094 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
6096 Draw a bitmap on the device context at the specified point. If
6097 *transparent* is true and the bitmap has a transparency mask, (or
6098 alpha channel on the platforms that support it) then the bitmap will
6099 be drawn transparently.
6101 return _gdi_
.PseudoDC_DrawBitmap(*args
, **kwargs
)
6103 def DrawBitmapPoint(*args
, **kwargs
):
6105 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
6107 Draw a bitmap on the device context at the specified point. If
6108 *transparent* is true and the bitmap has a transparency mask, (or
6109 alpha channel on the platforms that support it) then the bitmap will
6110 be drawn transparently.
6112 return _gdi_
.PseudoDC_DrawBitmapPoint(*args
, **kwargs
)
6114 def DrawText(*args
, **kwargs
):
6116 DrawText(self, String text, int x, int y)
6118 Draws a text string at the specified point, using the current text
6119 font, and the current text foreground and background colours.
6121 The coordinates refer to the top-left corner of the rectangle bounding
6122 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6123 a text string, which can be used to position the text more precisely,
6124 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6127 **NOTE**: under wxGTK the current logical function is used by this
6128 function but it is ignored by wxMSW. Thus, you should avoid using
6129 logical functions with this function in portable programs.
6131 return _gdi_
.PseudoDC_DrawText(*args
, **kwargs
)
6133 def DrawTextPoint(*args
, **kwargs
):
6135 DrawTextPoint(self, String text, Point pt)
6137 Draws a text string at the specified point, using the current text
6138 font, and the current text foreground and background colours.
6140 The coordinates refer to the top-left corner of the rectangle bounding
6141 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6142 a text string, which can be used to position the text more precisely,
6143 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6146 **NOTE**: under wxGTK the current logical function is used by this
6147 function but it is ignored by wxMSW. Thus, you should avoid using
6148 logical functions with this function in portable programs.
6150 return _gdi_
.PseudoDC_DrawTextPoint(*args
, **kwargs
)
6152 def DrawRotatedText(*args
, **kwargs
):
6154 DrawRotatedText(self, String text, int x, int y, double angle)
6156 Draws the text rotated by *angle* degrees, if supported by the platform.
6158 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6159 function. In particular, a font different from ``wx.NORMAL_FONT``
6160 should be used as the it is not normally a TrueType
6161 font. ``wx.SWISS_FONT`` is an example of a font which is.
6163 return _gdi_
.PseudoDC_DrawRotatedText(*args
, **kwargs
)
6165 def DrawRotatedTextPoint(*args
, **kwargs
):
6167 DrawRotatedTextPoint(self, String text, Point pt, double angle)
6169 Draws the text rotated by *angle* degrees, if supported by the platform.
6171 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6172 function. In particular, a font different from ``wx.NORMAL_FONT``
6173 should be used as the it is not normally a TrueType
6174 font. ``wx.SWISS_FONT`` is an example of a font which is.
6176 return _gdi_
.PseudoDC_DrawRotatedTextPoint(*args
, **kwargs
)
6178 def DrawLines(*args
, **kwargs
):
6180 DrawLines(self, List points, int xoffset=0, int yoffset=0)
6182 Draws lines using a sequence of `wx.Point` objects, adding the
6183 optional offset coordinate. The current pen is used for drawing the
6186 return _gdi_
.PseudoDC_DrawLines(*args
, **kwargs
)
6188 def DrawPolygon(*args
, **kwargs
):
6190 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
6191 int fillStyle=ODDEVEN_RULE)
6193 Draws a filled polygon using a sequence of `wx.Point` objects, adding
6194 the optional offset coordinate. The last argument specifies the fill
6195 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
6197 The current pen is used for drawing the outline, and the current brush
6198 for filling the shape. Using a transparent brush suppresses
6199 filling. Note that wxWidgets automatically closes the first and last
6202 return _gdi_
.PseudoDC_DrawPolygon(*args
, **kwargs
)
6204 def DrawLabel(*args
, **kwargs
):
6206 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6209 Draw *text* within the specified rectangle, abiding by the alignment
6210 flags. Will additionally emphasize the character at *indexAccel* if
6213 return _gdi_
.PseudoDC_DrawLabel(*args
, **kwargs
)
6215 def DrawImageLabel(*args
, **kwargs
):
6217 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6220 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
6221 drawing it) within the specified rectangle, abiding by the alignment
6222 flags. Will additionally emphasize the character at *indexAccel* if
6225 return _gdi_
.PseudoDC_DrawImageLabel(*args
, **kwargs
)
6227 def DrawSpline(*args
, **kwargs
):
6229 DrawSpline(self, List points)
6231 Draws a spline between all given control points, (a list of `wx.Point`
6232 objects) using the current pen. The spline is drawn using a series of
6233 lines, using an algorithm taken from the X drawing program 'XFIG'.
6235 return _gdi_
.PseudoDC_DrawSpline(*args
, **kwargs
)
6237 def Clear(*args
, **kwargs
):
6241 Clears the device context using the current background brush.
6243 return _gdi_
.PseudoDC_Clear(*args
, **kwargs
)
6245 def SetFont(*args
, **kwargs
):
6247 SetFont(self, Font font)
6249 Sets the current font for the DC. It must be a valid font, in
6250 particular you should not pass ``wx.NullFont`` to this method.
6252 return _gdi_
.PseudoDC_SetFont(*args
, **kwargs
)
6254 def SetPen(*args
, **kwargs
):
6256 SetPen(self, Pen pen)
6258 Sets the current pen for the DC.
6260 If the argument is ``wx.NullPen``, the current pen is selected out of the
6261 device context, and the original pen restored.
6263 return _gdi_
.PseudoDC_SetPen(*args
, **kwargs
)
6265 def SetBrush(*args
, **kwargs
):
6267 SetBrush(self, Brush brush)
6269 Sets the current brush for the DC.
6271 If the argument is ``wx.NullBrush``, the current brush is selected out
6272 of the device context, and the original brush restored, allowing the
6273 current brush to be destroyed safely.
6275 return _gdi_
.PseudoDC_SetBrush(*args
, **kwargs
)
6277 def SetBackground(*args
, **kwargs
):
6279 SetBackground(self, Brush brush)
6281 Sets the current background brush for the DC.
6283 return _gdi_
.PseudoDC_SetBackground(*args
, **kwargs
)
6285 def SetBackgroundMode(*args
, **kwargs
):
6287 SetBackgroundMode(self, int mode)
6289 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
6290 determines whether text will be drawn with a background colour or
6293 return _gdi_
.PseudoDC_SetBackgroundMode(*args
, **kwargs
)
6295 def SetPalette(*args
, **kwargs
):
6297 SetPalette(self, Palette palette)
6299 If this is a window DC or memory DC, assigns the given palette to the
6300 window or bitmap associated with the DC. If the argument is
6301 ``wx.NullPalette``, the current palette is selected out of the device
6302 context, and the original palette restored.
6304 return _gdi_
.PseudoDC_SetPalette(*args
, **kwargs
)
6306 def SetTextForeground(*args
, **kwargs
):
6308 SetTextForeground(self, Colour colour)
6310 Sets the current text foreground colour for the DC.
6312 return _gdi_
.PseudoDC_SetTextForeground(*args
, **kwargs
)
6314 def SetTextBackground(*args
, **kwargs
):
6316 SetTextBackground(self, Colour colour)
6318 Sets the current text background colour for the DC.
6320 return _gdi_
.PseudoDC_SetTextBackground(*args
, **kwargs
)
6322 def SetLogicalFunction(*args
, **kwargs
):
6324 SetLogicalFunction(self, int function)
6326 Sets the current logical function for the device context. This
6327 determines how a source pixel (from a pen or brush colour, combines
6328 with a destination pixel in the current device context.
6330 The possible values and their meaning in terms of source and
6331 destination pixel values are as follows:
6333 ================ ==========================
6335 wx.AND_INVERT (NOT src) AND dst
6336 wx.AND_REVERSE src AND (NOT dst)
6339 wx.EQUIV (NOT src) XOR dst
6341 wx.NAND (NOT src) OR (NOT dst)
6342 wx.NOR (NOT src) AND (NOT dst)
6345 wx.OR_INVERT (NOT src) OR dst
6346 wx.OR_REVERSE src OR (NOT dst)
6348 wx.SRC_INVERT NOT src
6350 ================ ==========================
6352 The default is wx.COPY, which simply draws with the current
6353 colour. The others combine the current colour and the background using
6354 a logical operation. wx.INVERT is commonly used for drawing rubber
6355 bands or moving outlines, since drawing twice reverts to the original
6359 return _gdi_
.PseudoDC_SetLogicalFunction(*args
, **kwargs
)
6361 _gdi_
.PseudoDC_swigregister(PseudoDC
)