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 ColoursCount
= property(GetColoursCount
,doc
="See `GetColoursCount`")
300 _gdi_
.Palette_swigregister(Palette
)
302 #---------------------------------------------------------------------------
304 class Pen(GDIObject
):
305 """Proxy of C++ Pen class"""
306 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
307 __repr__
= _swig_repr
308 def __init__(self
, *args
, **kwargs
):
309 """__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen"""
310 _gdi_
.Pen_swiginit(self
,_gdi_
.new_Pen(*args
, **kwargs
))
311 __swig_destroy__
= _gdi_
.delete_Pen
312 __del__
= lambda self
: None;
313 def GetCap(*args
, **kwargs
):
314 """GetCap(self) -> int"""
315 return _gdi_
.Pen_GetCap(*args
, **kwargs
)
317 def GetColour(*args
, **kwargs
):
318 """GetColour(self) -> Colour"""
319 return _gdi_
.Pen_GetColour(*args
, **kwargs
)
321 def GetJoin(*args
, **kwargs
):
322 """GetJoin(self) -> int"""
323 return _gdi_
.Pen_GetJoin(*args
, **kwargs
)
325 def GetStyle(*args
, **kwargs
):
326 """GetStyle(self) -> int"""
327 return _gdi_
.Pen_GetStyle(*args
, **kwargs
)
329 def GetWidth(*args
, **kwargs
):
330 """GetWidth(self) -> int"""
331 return _gdi_
.Pen_GetWidth(*args
, **kwargs
)
333 def Ok(*args
, **kwargs
):
334 """Ok(self) -> bool"""
335 return _gdi_
.Pen_Ok(*args
, **kwargs
)
337 def SetCap(*args
, **kwargs
):
338 """SetCap(self, int cap_style)"""
339 return _gdi_
.Pen_SetCap(*args
, **kwargs
)
341 def SetColour(*args
, **kwargs
):
342 """SetColour(self, Colour colour)"""
343 return _gdi_
.Pen_SetColour(*args
, **kwargs
)
345 def SetJoin(*args
, **kwargs
):
346 """SetJoin(self, int join_style)"""
347 return _gdi_
.Pen_SetJoin(*args
, **kwargs
)
349 def SetStyle(*args
, **kwargs
):
350 """SetStyle(self, int style)"""
351 return _gdi_
.Pen_SetStyle(*args
, **kwargs
)
353 def SetWidth(*args
, **kwargs
):
354 """SetWidth(self, int width)"""
355 return _gdi_
.Pen_SetWidth(*args
, **kwargs
)
357 def SetDashes(*args
, **kwargs
):
358 """SetDashes(self, int dashes)"""
359 return _gdi_
.Pen_SetDashes(*args
, **kwargs
)
361 def GetDashes(*args
, **kwargs
):
362 """GetDashes(self) -> PyObject"""
363 return _gdi_
.Pen_GetDashes(*args
, **kwargs
)
365 def _SetDashes(*args
, **kwargs
):
366 """_SetDashes(self, PyObject _self, PyObject pyDashes)"""
367 return _gdi_
.Pen__SetDashes(*args
, **kwargs
)
369 def SetDashes(self
, dashes
):
371 Associate a list of dash lengths with the Pen.
373 self
._SetDashes
(self
, dashes
)
375 def __eq__(*args
, **kwargs
):
376 """__eq__(self, Pen other) -> bool"""
377 return _gdi_
.Pen___eq__(*args
, **kwargs
)
379 def __ne__(*args
, **kwargs
):
380 """__ne__(self, Pen other) -> bool"""
381 return _gdi_
.Pen___ne__(*args
, **kwargs
)
383 def __nonzero__(self
): return self
.Ok()
384 Cap
= property(GetCap
,SetCap
,doc
="See `GetCap` and `SetCap`")
385 Colour
= property(GetColour
,SetColour
,doc
="See `GetColour` and `SetColour`")
386 Dashes
= property(GetDashes
,SetDashes
,doc
="See `GetDashes` and `SetDashes`")
387 Join
= property(GetJoin
,SetJoin
,doc
="See `GetJoin` and `SetJoin`")
388 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
389 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
390 _gdi_
.Pen_swigregister(Pen
)
392 #---------------------------------------------------------------------------
394 class Brush(GDIObject
):
396 A brush is a drawing tool for filling in areas. It is used for
397 painting the background of rectangles, ellipses, etc. when drawing on
398 a `wx.DC`. It has a colour and a style.
400 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
401 __repr__
= _swig_repr
402 def __init__(self
, *args
, **kwargs
):
404 __init__(self, Colour colour, int style=SOLID) -> Brush
406 Constructs a brush from a `wx.Colour` object and a style.
408 _gdi_
.Brush_swiginit(self
,_gdi_
.new_Brush(*args
, **kwargs
))
409 __swig_destroy__
= _gdi_
.delete_Brush
410 __del__
= lambda self
: None;
411 def SetColour(*args
, **kwargs
):
413 SetColour(self, Colour col)
415 Set the brush's `wx.Colour`.
417 return _gdi_
.Brush_SetColour(*args
, **kwargs
)
419 def SetStyle(*args
, **kwargs
):
421 SetStyle(self, int style)
423 Sets the style of the brush. See `__init__` for a listing of styles.
425 return _gdi_
.Brush_SetStyle(*args
, **kwargs
)
427 def SetStipple(*args
, **kwargs
):
429 SetStipple(self, Bitmap stipple)
431 Sets the stipple `wx.Bitmap`.
433 return _gdi_
.Brush_SetStipple(*args
, **kwargs
)
435 def GetColour(*args
, **kwargs
):
437 GetColour(self) -> Colour
439 Returns the `wx.Colour` of the brush.
441 return _gdi_
.Brush_GetColour(*args
, **kwargs
)
443 def GetStyle(*args
, **kwargs
):
445 GetStyle(self) -> int
447 Returns the style of the brush. See `__init__` for a listing of
450 return _gdi_
.Brush_GetStyle(*args
, **kwargs
)
452 def GetStipple(*args
, **kwargs
):
454 GetStipple(self) -> Bitmap
456 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
457 have a wx.STIPPLE style, then the return value may be non-None but an
458 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
460 return _gdi_
.Brush_GetStipple(*args
, **kwargs
)
462 def IsHatch(*args
, **kwargs
):
464 IsHatch(self) -> bool
466 Is the current style a hatch type?
468 return _gdi_
.Brush_IsHatch(*args
, **kwargs
)
470 def Ok(*args
, **kwargs
):
474 Returns True if the brush is initialised and valid.
476 return _gdi_
.Brush_Ok(*args
, **kwargs
)
478 def MacGetTheme(*args
, **kwargs
):
479 """MacGetTheme(self) -> short"""
480 return _gdi_
.Brush_MacGetTheme(*args
, **kwargs
)
482 def MacSetTheme(*args
, **kwargs
):
483 """MacSetTheme(self, short macThemeBrush)"""
484 return _gdi_
.Brush_MacSetTheme(*args
, **kwargs
)
486 def __nonzero__(self
): return self
.Ok()
487 Colour
= property(GetColour
,SetColour
,doc
="See `GetColour` and `SetColour`")
488 Stipple
= property(GetStipple
,SetStipple
,doc
="See `GetStipple` and `SetStipple`")
489 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
490 _gdi_
.Brush_swigregister(Brush
)
492 def BrushFromBitmap(*args
, **kwargs
):
494 BrushFromBitmap(Bitmap stippleBitmap) -> Brush
496 Constructs a stippled brush using a bitmap.
498 val
= _gdi_
.new_BrushFromBitmap(*args
, **kwargs
)
501 class Bitmap(GDIObject
):
503 The wx.Bitmap class encapsulates the concept of a platform-dependent
504 bitmap. It can be either monochrome or colour, and either loaded from
505 a file or created dynamically. A bitmap can be selected into a memory
506 device context (instance of `wx.MemoryDC`). This enables the bitmap to
507 be copied to a window or memory device context using `wx.DC.Blit`, or
508 to be used as a drawing surface.
510 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
511 __repr__
= _swig_repr
512 def __init__(self
, *args
, **kwargs
):
514 __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap
516 Loads a bitmap from a file.
518 _gdi_
.Bitmap_swiginit(self
,_gdi_
.new_Bitmap(*args
, **kwargs
))
519 __swig_destroy__
= _gdi_
.delete_Bitmap
520 __del__
= lambda self
: None;
521 def Ok(*args
, **kwargs
):
522 """Ok(self) -> bool"""
523 return _gdi_
.Bitmap_Ok(*args
, **kwargs
)
525 def GetWidth(*args
, **kwargs
):
527 GetWidth(self) -> int
529 Gets the width of the bitmap in pixels.
531 return _gdi_
.Bitmap_GetWidth(*args
, **kwargs
)
533 def GetHeight(*args
, **kwargs
):
535 GetHeight(self) -> int
537 Gets the height of the bitmap in pixels.
539 return _gdi_
.Bitmap_GetHeight(*args
, **kwargs
)
541 def GetDepth(*args
, **kwargs
):
543 GetDepth(self) -> int
545 Gets the colour depth of the bitmap. A value of 1 indicates a
548 return _gdi_
.Bitmap_GetDepth(*args
, **kwargs
)
550 def GetSize(*args
, **kwargs
):
552 GetSize(self) -> Size
554 Get the size of the bitmap.
556 return _gdi_
.Bitmap_GetSize(*args
, **kwargs
)
558 def ConvertToImage(*args
, **kwargs
):
560 ConvertToImage(self) -> Image
562 Creates a platform-independent image from a platform-dependent
563 bitmap. This preserves mask information so that bitmaps and images can
564 be converted back and forth without loss in that respect.
566 return _gdi_
.Bitmap_ConvertToImage(*args
, **kwargs
)
568 def GetMask(*args
, **kwargs
):
570 GetMask(self) -> Mask
572 Gets the associated mask (if any) which may have been loaded from a
573 file or explpicitly set for the bitmap.
575 :see: `SetMask`, `wx.Mask`
578 return _gdi_
.Bitmap_GetMask(*args
, **kwargs
)
580 def SetMask(*args
, **kwargs
):
582 SetMask(self, Mask mask)
584 Sets the mask for this bitmap.
586 :see: `GetMask`, `wx.Mask`
589 return _gdi_
.Bitmap_SetMask(*args
, **kwargs
)
591 def SetMaskColour(*args
, **kwargs
):
593 SetMaskColour(self, Colour colour)
595 Create a Mask based on a specified colour in the Bitmap.
597 return _gdi_
.Bitmap_SetMaskColour(*args
, **kwargs
)
599 def GetSubBitmap(*args
, **kwargs
):
601 GetSubBitmap(self, Rect rect) -> Bitmap
603 Returns a sub-bitmap of the current one as long as the rect belongs
604 entirely to the bitmap. This function preserves bit depth and mask
607 return _gdi_
.Bitmap_GetSubBitmap(*args
, **kwargs
)
609 def SaveFile(*args
, **kwargs
):
611 SaveFile(self, String name, int type, Palette palette=None) -> bool
613 Saves a bitmap in the named file. See `__init__` for a description of
614 the ``type`` parameter.
616 return _gdi_
.Bitmap_SaveFile(*args
, **kwargs
)
618 def LoadFile(*args
, **kwargs
):
620 LoadFile(self, String name, int type) -> bool
622 Loads a bitmap from a file. See `__init__` for a description of the
625 return _gdi_
.Bitmap_LoadFile(*args
, **kwargs
)
627 def GetPalette(*args
, **kwargs
):
628 """GetPalette(self) -> Palette"""
629 return _gdi_
.Bitmap_GetPalette(*args
, **kwargs
)
631 def CopyFromIcon(*args
, **kwargs
):
632 """CopyFromIcon(self, Icon icon) -> bool"""
633 return _gdi_
.Bitmap_CopyFromIcon(*args
, **kwargs
)
635 def SetHeight(*args
, **kwargs
):
637 SetHeight(self, int height)
639 Set the height property (does not affect the existing bitmap data).
641 return _gdi_
.Bitmap_SetHeight(*args
, **kwargs
)
643 def SetWidth(*args
, **kwargs
):
645 SetWidth(self, int width)
647 Set the width property (does not affect the existing bitmap data).
649 return _gdi_
.Bitmap_SetWidth(*args
, **kwargs
)
651 def SetDepth(*args
, **kwargs
):
653 SetDepth(self, int depth)
655 Set the depth property (does not affect the existing bitmap data).
657 return _gdi_
.Bitmap_SetDepth(*args
, **kwargs
)
659 def SetSize(*args
, **kwargs
):
661 SetSize(self, Size size)
663 Set the bitmap size (does not affect the existing bitmap data).
665 return _gdi_
.Bitmap_SetSize(*args
, **kwargs
)
667 def __nonzero__(self
): return self
.Ok()
668 def __eq__(*args
, **kwargs
):
669 """__eq__(self, Bitmap other) -> bool"""
670 return _gdi_
.Bitmap___eq__(*args
, **kwargs
)
672 def __ne__(*args
, **kwargs
):
673 """__ne__(self, Bitmap other) -> bool"""
674 return _gdi_
.Bitmap___ne__(*args
, **kwargs
)
676 Depth
= property(GetDepth
,SetDepth
,doc
="See `GetDepth` and `SetDepth`")
677 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
678 Mask
= property(GetMask
,SetMask
,doc
="See `GetMask` and `SetMask`")
679 Palette
= property(GetPalette
,doc
="See `GetPalette`")
680 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
681 SubBitmap
= property(GetSubBitmap
,doc
="See `GetSubBitmap`")
682 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
683 _gdi_
.Bitmap_swigregister(Bitmap
)
685 def EmptyBitmap(*args
, **kwargs
):
687 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
689 Creates a new bitmap of the given size. A depth of -1 indicates the
690 depth of the current screen or visual. Some platforms only support 1
691 for monochrome and -1 for the current display depth.
693 val
= _gdi_
.new_EmptyBitmap(*args
, **kwargs
)
696 def BitmapFromIcon(*args
, **kwargs
):
698 BitmapFromIcon(Icon icon) -> Bitmap
700 Create a new bitmap from a `wx.Icon` object.
702 val
= _gdi_
.new_BitmapFromIcon(*args
, **kwargs
)
705 def BitmapFromImage(*args
, **kwargs
):
707 BitmapFromImage(Image image, int depth=-1) -> Bitmap
709 Creates bitmap object from a `wx.Image`. This has to be done to
710 actually display a `wx.Image` as you cannot draw an image directly on
711 a window. The resulting bitmap will use the provided colour depth (or
712 that of the current screen colour depth if depth is -1) which entails
713 that a colour reduction may have to take place.
715 val
= _gdi_
.new_BitmapFromImage(*args
, **kwargs
)
718 def BitmapFromXPMData(*args
, **kwargs
):
720 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
722 Construct a Bitmap from a list of strings formatted as XPM data.
724 val
= _gdi_
.new_BitmapFromXPMData(*args
, **kwargs
)
727 def BitmapFromBits(*args
, **kwargs
):
729 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
731 Creates a bitmap from an array of bits. You should only use this
732 function for monochrome bitmaps (depth 1) in portable programs: in
733 this case the bits parameter should contain an XBM image. For other
734 bit depths, the behaviour is platform dependent.
736 val
= _gdi_
.new_BitmapFromBits(*args
, **kwargs
)
740 def _BitmapFromBufferAlpha(*args
, **kwargs
):
741 """_BitmapFromBufferAlpha(int width, int height, buffer data, buffer alpha) -> Bitmap"""
742 return _gdi_
._BitmapFromBufferAlpha
(*args
, **kwargs
)
744 def _BitmapFromBuffer(*args
, **kwargs
):
745 """_BitmapFromBuffer(int width, int height, buffer data) -> Bitmap"""
746 return _gdi_
._BitmapFromBuffer
(*args
, **kwargs
)
747 def BitmapFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
749 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
750 parameter must be a Python object that implements the buffer
751 interface, such as a string, array, etc. The dataBuffer object is
752 expected to contain a series of RGB bytes and be width*height*3
753 bytes long. A buffer object can optionally be supplied for the
754 image's alpha channel data, and it is expected to be width*height
755 bytes long. On Windows the RGB values are 'premultiplied' by the
756 alpha values. (The other platforms do the multiplication
759 Unlike `wx.ImageFromBuffer` the bitmap created with this function
760 does not share the memory buffer with the buffer object. This is
761 because the native pixel buffer format varies on different
762 platforms, and so instead an efficient as possible copy of the
763 data is made from the buffer objects to the bitmap's native pixel
764 buffer. For direct access to a bitmap's pixel buffer see
765 `wx.NativePixelData` and `wx.AlphaPixelData`.
767 :see: `wx.Bitmap`, `wx.BitmapFromBufferRGBA`, `wx.NativePixelData`,
768 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
770 if alphaBuffer
is not None:
771 return _gdi_
._BitmapFromBufferAlpha
(width
, height
, dataBuffer
, alphaBuffer
)
773 return _gdi_
._BitmapFromBuffer
(width
, height
, dataBuffer
)
776 def _BitmapFromBufferRGBA(*args
, **kwargs
):
777 """_BitmapFromBufferRGBA(int width, int height, buffer data) -> Bitmap"""
778 return _gdi_
._BitmapFromBufferRGBA
(*args
, **kwargs
)
779 def BitmapFromBufferRGBA(width
, height
, dataBuffer
):
781 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
782 parameter must be a Python object that implements the buffer
783 interface, such as a string, array, etc. The dataBuffer object is
784 expected to contain a series of RGBA bytes (red, green, blue and
785 alpha) and be width*height*4 bytes long. On Windows the RGB
786 values are 'premultiplied' by the alpha values. (The other
787 platforms do the multiplication themselves.)
789 Unlike `wx.ImageFromBuffer` the bitmap created with this function
790 does not share the memory buffer with the buffer object. This is
791 because the native pixel buffer format varies on different
792 platforms, and so instead an efficient as possible copy of the
793 data is made from the buffer object to the bitmap's native pixel
794 buffer. For direct access to a bitmap's pixel buffer see
795 `wx.NativePixelData` and `wx.AlphaPixelData`.
797 :see: `wx.Bitmap`, `wx.BitmapFromBuffer`, `wx.NativePixelData`,
798 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
800 return _gdi_
._BitmapFromBufferRGBA
(width
, height
, dataBuffer
)
802 class PixelDataBase(object):
803 """Proxy of C++ PixelDataBase class"""
804 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
805 def __init__(self
): raise AttributeError, "No constructor defined"
806 __repr__
= _swig_repr
807 def GetOrigin(*args
, **kwargs
):
808 """GetOrigin(self) -> Point"""
809 return _gdi_
.PixelDataBase_GetOrigin(*args
, **kwargs
)
811 def GetWidth(*args
, **kwargs
):
812 """GetWidth(self) -> int"""
813 return _gdi_
.PixelDataBase_GetWidth(*args
, **kwargs
)
815 def GetHeight(*args
, **kwargs
):
816 """GetHeight(self) -> int"""
817 return _gdi_
.PixelDataBase_GetHeight(*args
, **kwargs
)
819 def GetSize(*args
, **kwargs
):
820 """GetSize(self) -> Size"""
821 return _gdi_
.PixelDataBase_GetSize(*args
, **kwargs
)
823 def GetRowStride(*args
, **kwargs
):
824 """GetRowStride(self) -> int"""
825 return _gdi_
.PixelDataBase_GetRowStride(*args
, **kwargs
)
827 Height
= property(GetHeight
,doc
="See `GetHeight`")
828 Origin
= property(GetOrigin
,doc
="See `GetOrigin`")
829 RowStride
= property(GetRowStride
,doc
="See `GetRowStride`")
830 Size
= property(GetSize
,doc
="See `GetSize`")
831 Width
= property(GetWidth
,doc
="See `GetWidth`")
832 _gdi_
.PixelDataBase_swigregister(PixelDataBase
)
834 class NativePixelData(PixelDataBase
):
835 """Proxy of C++ NativePixelData class"""
836 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
837 __repr__
= _swig_repr
838 def __init__(self
, *args
):
840 __init__(self, Bitmap bmp) -> NativePixelData
841 __init__(self, Bitmap bmp, Rect rect) -> NativePixelData
842 __init__(self, Bitmap bmp, Point pt, Size sz) -> NativePixelData
844 _gdi_
.NativePixelData_swiginit(self
,_gdi_
.new_NativePixelData(*args
))
845 __swig_destroy__
= _gdi_
.delete_NativePixelData
846 __del__
= lambda self
: None;
847 def GetPixels(*args
, **kwargs
):
848 """GetPixels(self) -> NativePixelData_Accessor"""
849 return _gdi_
.NativePixelData_GetPixels(*args
, **kwargs
)
851 def UseAlpha(*args
, **kwargs
):
853 return _gdi_
.NativePixelData_UseAlpha(*args
, **kwargs
)
855 def __nonzero__(*args
, **kwargs
):
856 """__nonzero__(self) -> bool"""
857 return _gdi_
.NativePixelData___nonzero__(*args
, **kwargs
)
861 Create and return an iterator object for this pixel data
862 object. (It's really a generator but I won't tell if you
865 width
= self
.GetWidth()
866 height
= self
.GetHeight()
867 pixels
= self
.GetPixels()
872 class PixelFacade(object):
875 def Set(self
, *args
, **kw
):
876 return pixels
.Set(*args
, **kw
)
878 return str(self
.Get())
880 return 'pixel(%d,%d): %s' % (x
,y
,self
.Get())
881 X
= property(lambda self
: x
)
882 Y
= property(lambda self
: y
)
885 for y
in xrange(height
):
886 for x
in xrange(width
):
892 pixels
.MoveTo(self
, 0, y
)
894 Pixels
= property(GetPixels
,doc
="See `GetPixels`")
895 _gdi_
.NativePixelData_swigregister(NativePixelData
)
897 class NativePixelData_Accessor(object):
898 """Proxy of C++ NativePixelData_Accessor class"""
899 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
900 __repr__
= _swig_repr
901 def __init__(self
, *args
):
903 __init__(self, NativePixelData data) -> NativePixelData_Accessor
904 __init__(self, Bitmap bmp, NativePixelData data) -> NativePixelData_Accessor
905 __init__(self) -> NativePixelData_Accessor
907 _gdi_
.NativePixelData_Accessor_swiginit(self
,_gdi_
.new_NativePixelData_Accessor(*args
))
908 __swig_destroy__
= _gdi_
.delete_NativePixelData_Accessor
909 __del__
= lambda self
: None;
910 def Reset(*args
, **kwargs
):
911 """Reset(self, NativePixelData data)"""
912 return _gdi_
.NativePixelData_Accessor_Reset(*args
, **kwargs
)
914 def IsOk(*args
, **kwargs
):
915 """IsOk(self) -> bool"""
916 return _gdi_
.NativePixelData_Accessor_IsOk(*args
, **kwargs
)
918 def nextPixel(*args
, **kwargs
):
919 """nextPixel(self)"""
920 return _gdi_
.NativePixelData_Accessor_nextPixel(*args
, **kwargs
)
922 def Offset(*args
, **kwargs
):
923 """Offset(self, NativePixelData data, int x, int y)"""
924 return _gdi_
.NativePixelData_Accessor_Offset(*args
, **kwargs
)
926 def OffsetX(*args
, **kwargs
):
927 """OffsetX(self, NativePixelData data, int x)"""
928 return _gdi_
.NativePixelData_Accessor_OffsetX(*args
, **kwargs
)
930 def OffsetY(*args
, **kwargs
):
931 """OffsetY(self, NativePixelData data, int y)"""
932 return _gdi_
.NativePixelData_Accessor_OffsetY(*args
, **kwargs
)
934 def MoveTo(*args
, **kwargs
):
935 """MoveTo(self, NativePixelData data, int x, int y)"""
936 return _gdi_
.NativePixelData_Accessor_MoveTo(*args
, **kwargs
)
938 def Set(*args
, **kwargs
):
939 """Set(self, byte red, byte green, byte blue)"""
940 return _gdi_
.NativePixelData_Accessor_Set(*args
, **kwargs
)
942 def Get(*args
, **kwargs
):
943 """Get(self) -> PyObject"""
944 return _gdi_
.NativePixelData_Accessor_Get(*args
, **kwargs
)
946 _gdi_
.NativePixelData_Accessor_swigregister(NativePixelData_Accessor
)
948 class AlphaPixelData(PixelDataBase
):
949 """Proxy of C++ AlphaPixelData class"""
950 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
951 __repr__
= _swig_repr
952 def __init__(self
, *args
):
954 __init__(self, Bitmap bmp) -> AlphaPixelData
955 __init__(self, Bitmap bmp, Rect rect) -> AlphaPixelData
956 __init__(self, Bitmap bmp, Point pt, Size sz) -> AlphaPixelData
958 _gdi_
.AlphaPixelData_swiginit(self
,_gdi_
.new_AlphaPixelData(*args
))
961 __swig_destroy__
= _gdi_
.delete_AlphaPixelData
962 __del__
= lambda self
: None;
963 def GetPixels(*args
, **kwargs
):
964 """GetPixels(self) -> AlphaPixelData_Accessor"""
965 return _gdi_
.AlphaPixelData_GetPixels(*args
, **kwargs
)
967 def UseAlpha(*args
, **kwargs
):
969 return _gdi_
.AlphaPixelData_UseAlpha(*args
, **kwargs
)
971 def __nonzero__(*args
, **kwargs
):
972 """__nonzero__(self) -> bool"""
973 return _gdi_
.AlphaPixelData___nonzero__(*args
, **kwargs
)
977 Create and return an iterator object for this pixel data
978 object. (It's really a generator but I won't tell if you
981 width
= self
.GetWidth()
982 height
= self
.GetHeight()
983 pixels
= self
.GetPixels()
988 class PixelFacade(object):
991 def Set(self
, *args
, **kw
):
992 return pixels
.Set(*args
, **kw
)
994 return str(self
.Get())
996 return 'pixel(%d,%d): %s' % (x
,y
,self
.Get())
997 X
= property(lambda self
: x
)
998 Y
= property(lambda self
: y
)
1001 for y
in xrange(height
):
1002 for x
in xrange(width
):
1008 pixels
.MoveTo(self
, 0, y
)
1010 Pixels
= property(GetPixels
,doc
="See `GetPixels`")
1011 _gdi_
.AlphaPixelData_swigregister(AlphaPixelData
)
1013 class AlphaPixelData_Accessor(object):
1014 """Proxy of C++ AlphaPixelData_Accessor class"""
1015 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1016 __repr__
= _swig_repr
1017 def __init__(self
, *args
):
1019 __init__(self, AlphaPixelData data) -> AlphaPixelData_Accessor
1020 __init__(self, Bitmap bmp, AlphaPixelData data) -> AlphaPixelData_Accessor
1021 __init__(self) -> AlphaPixelData_Accessor
1023 _gdi_
.AlphaPixelData_Accessor_swiginit(self
,_gdi_
.new_AlphaPixelData_Accessor(*args
))
1024 __swig_destroy__
= _gdi_
.delete_AlphaPixelData_Accessor
1025 __del__
= lambda self
: None;
1026 def Reset(*args
, **kwargs
):
1027 """Reset(self, AlphaPixelData data)"""
1028 return _gdi_
.AlphaPixelData_Accessor_Reset(*args
, **kwargs
)
1030 def IsOk(*args
, **kwargs
):
1031 """IsOk(self) -> bool"""
1032 return _gdi_
.AlphaPixelData_Accessor_IsOk(*args
, **kwargs
)
1034 def nextPixel(*args
, **kwargs
):
1035 """nextPixel(self)"""
1036 return _gdi_
.AlphaPixelData_Accessor_nextPixel(*args
, **kwargs
)
1038 def Offset(*args
, **kwargs
):
1039 """Offset(self, AlphaPixelData data, int x, int y)"""
1040 return _gdi_
.AlphaPixelData_Accessor_Offset(*args
, **kwargs
)
1042 def OffsetX(*args
, **kwargs
):
1043 """OffsetX(self, AlphaPixelData data, int x)"""
1044 return _gdi_
.AlphaPixelData_Accessor_OffsetX(*args
, **kwargs
)
1046 def OffsetY(*args
, **kwargs
):
1047 """OffsetY(self, AlphaPixelData data, int y)"""
1048 return _gdi_
.AlphaPixelData_Accessor_OffsetY(*args
, **kwargs
)
1050 def MoveTo(*args
, **kwargs
):
1051 """MoveTo(self, AlphaPixelData data, int x, int y)"""
1052 return _gdi_
.AlphaPixelData_Accessor_MoveTo(*args
, **kwargs
)
1054 def Set(*args
, **kwargs
):
1055 """Set(self, byte red, byte green, byte blue, byte alpha)"""
1056 return _gdi_
.AlphaPixelData_Accessor_Set(*args
, **kwargs
)
1058 def Get(*args
, **kwargs
):
1059 """Get(self) -> PyObject"""
1060 return _gdi_
.AlphaPixelData_Accessor_Get(*args
, **kwargs
)
1062 _gdi_
.AlphaPixelData_Accessor_swigregister(AlphaPixelData_Accessor
)
1064 class Mask(_core
.Object
):
1066 This class encapsulates a monochrome mask bitmap, where the masked
1067 area is black and the unmasked area is white. When associated with a
1068 bitmap and drawn in a device context, the unmasked area of the bitmap
1069 will be drawn, and the masked area will not be drawn.
1071 A mask may be associated with a `wx.Bitmap`. It is used in
1072 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
1073 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
1076 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1077 __repr__
= _swig_repr
1078 def __init__(self
, *args
, **kwargs
):
1080 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
1082 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
1083 that indicates the transparent portions of the mask. In other words,
1084 the pixels in ``bitmap`` that match ``colour`` will be the transparent
1085 portions of the mask. If no ``colour`` or an invalid ``colour`` is
1086 passed then BLACK is used.
1088 :see: `wx.Bitmap`, `wx.Colour`
1090 _gdi_
.Mask_swiginit(self
,_gdi_
.new_Mask(*args
, **kwargs
))
1091 __swig_destroy__
= _gdi_
.delete_Mask
1092 __del__
= lambda self
: None;
1093 _gdi_
.Mask_swigregister(Mask
)
1095 MaskColour
= wx
._deprecated
(Mask
, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
1096 class Icon(GDIObject
):
1097 """Proxy of C++ Icon class"""
1098 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1099 __repr__
= _swig_repr
1100 def __init__(self
, *args
, **kwargs
):
1101 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
1102 _gdi_
.Icon_swiginit(self
,_gdi_
.new_Icon(*args
, **kwargs
))
1103 __swig_destroy__
= _gdi_
.delete_Icon
1104 __del__
= lambda self
: None;
1105 def Ok(*args
, **kwargs
):
1106 """Ok(self) -> bool"""
1107 return _gdi_
.Icon_Ok(*args
, **kwargs
)
1109 def GetWidth(*args
, **kwargs
):
1110 """GetWidth(self) -> int"""
1111 return _gdi_
.Icon_GetWidth(*args
, **kwargs
)
1113 def GetHeight(*args
, **kwargs
):
1114 """GetHeight(self) -> int"""
1115 return _gdi_
.Icon_GetHeight(*args
, **kwargs
)
1117 def GetDepth(*args
, **kwargs
):
1118 """GetDepth(self) -> int"""
1119 return _gdi_
.Icon_GetDepth(*args
, **kwargs
)
1121 def SetWidth(*args
, **kwargs
):
1122 """SetWidth(self, int w)"""
1123 return _gdi_
.Icon_SetWidth(*args
, **kwargs
)
1125 def SetHeight(*args
, **kwargs
):
1126 """SetHeight(self, int h)"""
1127 return _gdi_
.Icon_SetHeight(*args
, **kwargs
)
1129 def SetDepth(*args
, **kwargs
):
1130 """SetDepth(self, int d)"""
1131 return _gdi_
.Icon_SetDepth(*args
, **kwargs
)
1133 def CopyFromBitmap(*args
, **kwargs
):
1134 """CopyFromBitmap(self, Bitmap bmp)"""
1135 return _gdi_
.Icon_CopyFromBitmap(*args
, **kwargs
)
1137 def __nonzero__(self
): return self
.Ok()
1138 Depth
= property(GetDepth
,SetDepth
,doc
="See `GetDepth` and `SetDepth`")
1139 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
1140 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
1141 _gdi_
.Icon_swigregister(Icon
)
1143 def EmptyIcon(*args
, **kwargs
):
1144 """EmptyIcon() -> Icon"""
1145 val
= _gdi_
.new_EmptyIcon(*args
, **kwargs
)
1148 def IconFromLocation(*args
, **kwargs
):
1149 """IconFromLocation(IconLocation loc) -> Icon"""
1150 val
= _gdi_
.new_IconFromLocation(*args
, **kwargs
)
1153 def IconFromBitmap(*args
, **kwargs
):
1154 """IconFromBitmap(Bitmap bmp) -> Icon"""
1155 val
= _gdi_
.new_IconFromBitmap(*args
, **kwargs
)
1158 def IconFromXPMData(*args
, **kwargs
):
1159 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
1160 val
= _gdi_
.new_IconFromXPMData(*args
, **kwargs
)
1163 class IconLocation(object):
1164 """Proxy of C++ IconLocation class"""
1165 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1166 __repr__
= _swig_repr
1167 def __init__(self
, *args
, **kwargs
):
1168 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
1169 _gdi_
.IconLocation_swiginit(self
,_gdi_
.new_IconLocation(*args
, **kwargs
))
1170 __swig_destroy__
= _gdi_
.delete_IconLocation
1171 __del__
= lambda self
: None;
1172 def IsOk(*args
, **kwargs
):
1173 """IsOk(self) -> bool"""
1174 return _gdi_
.IconLocation_IsOk(*args
, **kwargs
)
1176 def __nonzero__(self
): return self
.Ok()
1177 def SetFileName(*args
, **kwargs
):
1178 """SetFileName(self, String filename)"""
1179 return _gdi_
.IconLocation_SetFileName(*args
, **kwargs
)
1181 def GetFileName(*args
, **kwargs
):
1182 """GetFileName(self) -> String"""
1183 return _gdi_
.IconLocation_GetFileName(*args
, **kwargs
)
1185 def SetIndex(*args
, **kwargs
):
1186 """SetIndex(self, int num)"""
1187 return _gdi_
.IconLocation_SetIndex(*args
, **kwargs
)
1189 def GetIndex(*args
, **kwargs
):
1190 """GetIndex(self) -> int"""
1191 return _gdi_
.IconLocation_GetIndex(*args
, **kwargs
)
1193 FileName
= property(GetFileName
,SetFileName
,doc
="See `GetFileName` and `SetFileName`")
1194 Index
= property(GetIndex
,SetIndex
,doc
="See `GetIndex` and `SetIndex`")
1195 _gdi_
.IconLocation_swigregister(IconLocation
)
1197 class IconBundle(object):
1198 """Proxy of C++ IconBundle class"""
1199 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1200 __repr__
= _swig_repr
1201 def __init__(self
, *args
, **kwargs
):
1202 """__init__(self) -> IconBundle"""
1203 _gdi_
.IconBundle_swiginit(self
,_gdi_
.new_IconBundle(*args
, **kwargs
))
1204 __swig_destroy__
= _gdi_
.delete_IconBundle
1205 __del__
= lambda self
: None;
1206 def AddIcon(*args
, **kwargs
):
1207 """AddIcon(self, Icon icon)"""
1208 return _gdi_
.IconBundle_AddIcon(*args
, **kwargs
)
1210 def AddIconFromFile(*args
, **kwargs
):
1211 """AddIconFromFile(self, String file, long type)"""
1212 return _gdi_
.IconBundle_AddIconFromFile(*args
, **kwargs
)
1214 def GetIcon(*args
, **kwargs
):
1215 """GetIcon(self, Size size) -> Icon"""
1216 return _gdi_
.IconBundle_GetIcon(*args
, **kwargs
)
1218 Icon
= property(GetIcon
,doc
="See `GetIcon`")
1219 _gdi_
.IconBundle_swigregister(IconBundle
)
1221 def IconBundleFromFile(*args
, **kwargs
):
1222 """IconBundleFromFile(String file, long type) -> IconBundle"""
1223 val
= _gdi_
.new_IconBundleFromFile(*args
, **kwargs
)
1226 def IconBundleFromIcon(*args
, **kwargs
):
1227 """IconBundleFromIcon(Icon icon) -> IconBundle"""
1228 val
= _gdi_
.new_IconBundleFromIcon(*args
, **kwargs
)
1231 class Cursor(GDIObject
):
1233 A cursor is a small bitmap usually used for denoting where the mouse
1234 pointer is, with a picture that might indicate the interpretation of a
1237 A single cursor object may be used in many windows (any subwindow
1238 type). The wxWindows convention is to set the cursor for a window, as
1239 in X, rather than to set it globally as in MS Windows, although a
1240 global `wx.SetCursor` function is also available for use on MS Windows.
1243 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1244 __repr__
= _swig_repr
1245 def __init__(self
, *args
, **kwargs
):
1247 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
1249 Construct a Cursor from a file. Specify the type of file using
1250 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
1253 _gdi_
.Cursor_swiginit(self
,_gdi_
.new_Cursor(*args
, **kwargs
))
1254 __swig_destroy__
= _gdi_
.delete_Cursor
1255 __del__
= lambda self
: None;
1256 def Ok(*args
, **kwargs
):
1257 """Ok(self) -> bool"""
1258 return _gdi_
.Cursor_Ok(*args
, **kwargs
)
1260 def __nonzero__(self
): return self
.Ok()
1261 _gdi_
.Cursor_swigregister(Cursor
)
1263 def StockCursor(*args
, **kwargs
):
1265 StockCursor(int id) -> Cursor
1267 Create a cursor using one of the stock cursors. Note that not all
1268 stock cursors are available on all platforms.
1270 val
= _gdi_
.new_StockCursor(*args
, **kwargs
)
1273 def CursorFromImage(*args
, **kwargs
):
1275 CursorFromImage(Image image) -> Cursor
1277 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
1278 for setting the transparent portions of the cursor.
1280 val
= _gdi_
.new_CursorFromImage(*args
, **kwargs
)
1283 #---------------------------------------------------------------------------
1285 OutRegion
= _gdi_
.OutRegion
1286 PartRegion
= _gdi_
.PartRegion
1287 InRegion
= _gdi_
.InRegion
1288 class Region(GDIObject
):
1289 """Proxy of C++ Region class"""
1290 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1291 __repr__
= _swig_repr
1292 def __init__(self
, *args
, **kwargs
):
1293 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
1294 _gdi_
.Region_swiginit(self
,_gdi_
.new_Region(*args
, **kwargs
))
1295 __swig_destroy__
= _gdi_
.delete_Region
1296 __del__
= lambda self
: None;
1297 def Clear(*args
, **kwargs
):
1299 return _gdi_
.Region_Clear(*args
, **kwargs
)
1301 def Offset(*args
, **kwargs
):
1302 """Offset(self, int x, int y) -> bool"""
1303 return _gdi_
.Region_Offset(*args
, **kwargs
)
1305 def Contains(*args
, **kwargs
):
1306 """Contains(self, int x, int y) -> int"""
1307 return _gdi_
.Region_Contains(*args
, **kwargs
)
1309 def ContainsPoint(*args
, **kwargs
):
1310 """ContainsPoint(self, Point pt) -> int"""
1311 return _gdi_
.Region_ContainsPoint(*args
, **kwargs
)
1313 def ContainsRect(*args
, **kwargs
):
1314 """ContainsRect(self, Rect rect) -> int"""
1315 return _gdi_
.Region_ContainsRect(*args
, **kwargs
)
1317 def ContainsRectDim(*args
, **kwargs
):
1318 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
1319 return _gdi_
.Region_ContainsRectDim(*args
, **kwargs
)
1321 def GetBox(*args
, **kwargs
):
1322 """GetBox(self) -> Rect"""
1323 return _gdi_
.Region_GetBox(*args
, **kwargs
)
1325 def Intersect(*args
, **kwargs
):
1326 """Intersect(self, int x, int y, int width, int height) -> bool"""
1327 return _gdi_
.Region_Intersect(*args
, **kwargs
)
1329 def IntersectRect(*args
, **kwargs
):
1330 """IntersectRect(self, Rect rect) -> bool"""
1331 return _gdi_
.Region_IntersectRect(*args
, **kwargs
)
1333 def IntersectRegion(*args
, **kwargs
):
1334 """IntersectRegion(self, Region region) -> bool"""
1335 return _gdi_
.Region_IntersectRegion(*args
, **kwargs
)
1337 def IsEmpty(*args
, **kwargs
):
1338 """IsEmpty(self) -> bool"""
1339 return _gdi_
.Region_IsEmpty(*args
, **kwargs
)
1341 def Union(*args
, **kwargs
):
1342 """Union(self, int x, int y, int width, int height) -> bool"""
1343 return _gdi_
.Region_Union(*args
, **kwargs
)
1345 def UnionRect(*args
, **kwargs
):
1346 """UnionRect(self, Rect rect) -> bool"""
1347 return _gdi_
.Region_UnionRect(*args
, **kwargs
)
1349 def UnionRegion(*args
, **kwargs
):
1350 """UnionRegion(self, Region region) -> bool"""
1351 return _gdi_
.Region_UnionRegion(*args
, **kwargs
)
1353 def Subtract(*args
, **kwargs
):
1354 """Subtract(self, int x, int y, int width, int height) -> bool"""
1355 return _gdi_
.Region_Subtract(*args
, **kwargs
)
1357 def SubtractRect(*args
, **kwargs
):
1358 """SubtractRect(self, Rect rect) -> bool"""
1359 return _gdi_
.Region_SubtractRect(*args
, **kwargs
)
1361 def SubtractRegion(*args
, **kwargs
):
1362 """SubtractRegion(self, Region region) -> bool"""
1363 return _gdi_
.Region_SubtractRegion(*args
, **kwargs
)
1365 def Xor(*args
, **kwargs
):
1366 """Xor(self, int x, int y, int width, int height) -> bool"""
1367 return _gdi_
.Region_Xor(*args
, **kwargs
)
1369 def XorRect(*args
, **kwargs
):
1370 """XorRect(self, Rect rect) -> bool"""
1371 return _gdi_
.Region_XorRect(*args
, **kwargs
)
1373 def XorRegion(*args
, **kwargs
):
1374 """XorRegion(self, Region region) -> bool"""
1375 return _gdi_
.Region_XorRegion(*args
, **kwargs
)
1377 def ConvertToBitmap(*args
, **kwargs
):
1378 """ConvertToBitmap(self) -> Bitmap"""
1379 return _gdi_
.Region_ConvertToBitmap(*args
, **kwargs
)
1381 def UnionBitmap(*args
, **kwargs
):
1382 """UnionBitmap(self, Bitmap bmp) -> bool"""
1383 return _gdi_
.Region_UnionBitmap(*args
, **kwargs
)
1385 def UnionBitmapColour(*args
, **kwargs
):
1386 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1387 return _gdi_
.Region_UnionBitmapColour(*args
, **kwargs
)
1389 Box
= property(GetBox
,doc
="See `GetBox`")
1390 _gdi_
.Region_swigregister(Region
)
1392 def RegionFromBitmap(*args
, **kwargs
):
1393 """RegionFromBitmap(Bitmap bmp) -> Region"""
1394 val
= _gdi_
.new_RegionFromBitmap(*args
, **kwargs
)
1397 def RegionFromBitmapColour(*args
, **kwargs
):
1398 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1399 val
= _gdi_
.new_RegionFromBitmapColour(*args
, **kwargs
)
1402 def RegionFromPoints(*args
, **kwargs
):
1403 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
1404 val
= _gdi_
.new_RegionFromPoints(*args
, **kwargs
)
1407 class RegionIterator(_core
.Object
):
1408 """Proxy of C++ RegionIterator class"""
1409 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1410 __repr__
= _swig_repr
1411 def __init__(self
, *args
, **kwargs
):
1412 """__init__(self, Region region) -> RegionIterator"""
1413 _gdi_
.RegionIterator_swiginit(self
,_gdi_
.new_RegionIterator(*args
, **kwargs
))
1414 __swig_destroy__
= _gdi_
.delete_RegionIterator
1415 __del__
= lambda self
: None;
1416 def GetX(*args
, **kwargs
):
1417 """GetX(self) -> int"""
1418 return _gdi_
.RegionIterator_GetX(*args
, **kwargs
)
1420 def GetY(*args
, **kwargs
):
1421 """GetY(self) -> int"""
1422 return _gdi_
.RegionIterator_GetY(*args
, **kwargs
)
1424 def GetW(*args
, **kwargs
):
1425 """GetW(self) -> int"""
1426 return _gdi_
.RegionIterator_GetW(*args
, **kwargs
)
1428 def GetWidth(*args
, **kwargs
):
1429 """GetWidth(self) -> int"""
1430 return _gdi_
.RegionIterator_GetWidth(*args
, **kwargs
)
1432 def GetH(*args
, **kwargs
):
1433 """GetH(self) -> int"""
1434 return _gdi_
.RegionIterator_GetH(*args
, **kwargs
)
1436 def GetHeight(*args
, **kwargs
):
1437 """GetHeight(self) -> int"""
1438 return _gdi_
.RegionIterator_GetHeight(*args
, **kwargs
)
1440 def GetRect(*args
, **kwargs
):
1441 """GetRect(self) -> Rect"""
1442 return _gdi_
.RegionIterator_GetRect(*args
, **kwargs
)
1444 def HaveRects(*args
, **kwargs
):
1445 """HaveRects(self) -> bool"""
1446 return _gdi_
.RegionIterator_HaveRects(*args
, **kwargs
)
1448 def Reset(*args
, **kwargs
):
1450 return _gdi_
.RegionIterator_Reset(*args
, **kwargs
)
1452 def Next(*args
, **kwargs
):
1454 return _gdi_
.RegionIterator_Next(*args
, **kwargs
)
1456 def __nonzero__(*args
, **kwargs
):
1457 """__nonzero__(self) -> bool"""
1458 return _gdi_
.RegionIterator___nonzero__(*args
, **kwargs
)
1460 H
= property(GetH
,doc
="See `GetH`")
1461 Height
= property(GetHeight
,doc
="See `GetHeight`")
1462 Rect
= property(GetRect
,doc
="See `GetRect`")
1463 W
= property(GetW
,doc
="See `GetW`")
1464 Width
= property(GetWidth
,doc
="See `GetWidth`")
1465 X
= property(GetX
,doc
="See `GetX`")
1466 Y
= property(GetY
,doc
="See `GetY`")
1467 _gdi_
.RegionIterator_swigregister(RegionIterator
)
1469 #---------------------------------------------------------------------------
1471 FONTFAMILY_DEFAULT
= _gdi_
.FONTFAMILY_DEFAULT
1472 FONTFAMILY_DECORATIVE
= _gdi_
.FONTFAMILY_DECORATIVE
1473 FONTFAMILY_ROMAN
= _gdi_
.FONTFAMILY_ROMAN
1474 FONTFAMILY_SCRIPT
= _gdi_
.FONTFAMILY_SCRIPT
1475 FONTFAMILY_SWISS
= _gdi_
.FONTFAMILY_SWISS
1476 FONTFAMILY_MODERN
= _gdi_
.FONTFAMILY_MODERN
1477 FONTFAMILY_TELETYPE
= _gdi_
.FONTFAMILY_TELETYPE
1478 FONTFAMILY_MAX
= _gdi_
.FONTFAMILY_MAX
1479 FONTFAMILY_UNKNOWN
= _gdi_
.FONTFAMILY_UNKNOWN
1480 FONTSTYLE_NORMAL
= _gdi_
.FONTSTYLE_NORMAL
1481 FONTSTYLE_ITALIC
= _gdi_
.FONTSTYLE_ITALIC
1482 FONTSTYLE_SLANT
= _gdi_
.FONTSTYLE_SLANT
1483 FONTSTYLE_MAX
= _gdi_
.FONTSTYLE_MAX
1484 FONTWEIGHT_NORMAL
= _gdi_
.FONTWEIGHT_NORMAL
1485 FONTWEIGHT_LIGHT
= _gdi_
.FONTWEIGHT_LIGHT
1486 FONTWEIGHT_BOLD
= _gdi_
.FONTWEIGHT_BOLD
1487 FONTWEIGHT_MAX
= _gdi_
.FONTWEIGHT_MAX
1488 FONTFLAG_DEFAULT
= _gdi_
.FONTFLAG_DEFAULT
1489 FONTFLAG_ITALIC
= _gdi_
.FONTFLAG_ITALIC
1490 FONTFLAG_SLANT
= _gdi_
.FONTFLAG_SLANT
1491 FONTFLAG_LIGHT
= _gdi_
.FONTFLAG_LIGHT
1492 FONTFLAG_BOLD
= _gdi_
.FONTFLAG_BOLD
1493 FONTFLAG_ANTIALIASED
= _gdi_
.FONTFLAG_ANTIALIASED
1494 FONTFLAG_NOT_ANTIALIASED
= _gdi_
.FONTFLAG_NOT_ANTIALIASED
1495 FONTFLAG_UNDERLINED
= _gdi_
.FONTFLAG_UNDERLINED
1496 FONTFLAG_STRIKETHROUGH
= _gdi_
.FONTFLAG_STRIKETHROUGH
1497 FONTFLAG_MASK
= _gdi_
.FONTFLAG_MASK
1498 FONTENCODING_SYSTEM
= _gdi_
.FONTENCODING_SYSTEM
1499 FONTENCODING_DEFAULT
= _gdi_
.FONTENCODING_DEFAULT
1500 FONTENCODING_ISO8859_1
= _gdi_
.FONTENCODING_ISO8859_1
1501 FONTENCODING_ISO8859_2
= _gdi_
.FONTENCODING_ISO8859_2
1502 FONTENCODING_ISO8859_3
= _gdi_
.FONTENCODING_ISO8859_3
1503 FONTENCODING_ISO8859_4
= _gdi_
.FONTENCODING_ISO8859_4
1504 FONTENCODING_ISO8859_5
= _gdi_
.FONTENCODING_ISO8859_5
1505 FONTENCODING_ISO8859_6
= _gdi_
.FONTENCODING_ISO8859_6
1506 FONTENCODING_ISO8859_7
= _gdi_
.FONTENCODING_ISO8859_7
1507 FONTENCODING_ISO8859_8
= _gdi_
.FONTENCODING_ISO8859_8
1508 FONTENCODING_ISO8859_9
= _gdi_
.FONTENCODING_ISO8859_9
1509 FONTENCODING_ISO8859_10
= _gdi_
.FONTENCODING_ISO8859_10
1510 FONTENCODING_ISO8859_11
= _gdi_
.FONTENCODING_ISO8859_11
1511 FONTENCODING_ISO8859_12
= _gdi_
.FONTENCODING_ISO8859_12
1512 FONTENCODING_ISO8859_13
= _gdi_
.FONTENCODING_ISO8859_13
1513 FONTENCODING_ISO8859_14
= _gdi_
.FONTENCODING_ISO8859_14
1514 FONTENCODING_ISO8859_15
= _gdi_
.FONTENCODING_ISO8859_15
1515 FONTENCODING_ISO8859_MAX
= _gdi_
.FONTENCODING_ISO8859_MAX
1516 FONTENCODING_KOI8
= _gdi_
.FONTENCODING_KOI8
1517 FONTENCODING_KOI8_U
= _gdi_
.FONTENCODING_KOI8_U
1518 FONTENCODING_ALTERNATIVE
= _gdi_
.FONTENCODING_ALTERNATIVE
1519 FONTENCODING_BULGARIAN
= _gdi_
.FONTENCODING_BULGARIAN
1520 FONTENCODING_CP437
= _gdi_
.FONTENCODING_CP437
1521 FONTENCODING_CP850
= _gdi_
.FONTENCODING_CP850
1522 FONTENCODING_CP852
= _gdi_
.FONTENCODING_CP852
1523 FONTENCODING_CP855
= _gdi_
.FONTENCODING_CP855
1524 FONTENCODING_CP866
= _gdi_
.FONTENCODING_CP866
1525 FONTENCODING_CP874
= _gdi_
.FONTENCODING_CP874
1526 FONTENCODING_CP932
= _gdi_
.FONTENCODING_CP932
1527 FONTENCODING_CP936
= _gdi_
.FONTENCODING_CP936
1528 FONTENCODING_CP949
= _gdi_
.FONTENCODING_CP949
1529 FONTENCODING_CP950
= _gdi_
.FONTENCODING_CP950
1530 FONTENCODING_CP1250
= _gdi_
.FONTENCODING_CP1250
1531 FONTENCODING_CP1251
= _gdi_
.FONTENCODING_CP1251
1532 FONTENCODING_CP1252
= _gdi_
.FONTENCODING_CP1252
1533 FONTENCODING_CP1253
= _gdi_
.FONTENCODING_CP1253
1534 FONTENCODING_CP1254
= _gdi_
.FONTENCODING_CP1254
1535 FONTENCODING_CP1255
= _gdi_
.FONTENCODING_CP1255
1536 FONTENCODING_CP1256
= _gdi_
.FONTENCODING_CP1256
1537 FONTENCODING_CP1257
= _gdi_
.FONTENCODING_CP1257
1538 FONTENCODING_CP12_MAX
= _gdi_
.FONTENCODING_CP12_MAX
1539 FONTENCODING_UTF7
= _gdi_
.FONTENCODING_UTF7
1540 FONTENCODING_UTF8
= _gdi_
.FONTENCODING_UTF8
1541 FONTENCODING_EUC_JP
= _gdi_
.FONTENCODING_EUC_JP
1542 FONTENCODING_UTF16BE
= _gdi_
.FONTENCODING_UTF16BE
1543 FONTENCODING_UTF16LE
= _gdi_
.FONTENCODING_UTF16LE
1544 FONTENCODING_UTF32BE
= _gdi_
.FONTENCODING_UTF32BE
1545 FONTENCODING_UTF32LE
= _gdi_
.FONTENCODING_UTF32LE
1546 FONTENCODING_MACROMAN
= _gdi_
.FONTENCODING_MACROMAN
1547 FONTENCODING_MACJAPANESE
= _gdi_
.FONTENCODING_MACJAPANESE
1548 FONTENCODING_MACCHINESETRAD
= _gdi_
.FONTENCODING_MACCHINESETRAD
1549 FONTENCODING_MACKOREAN
= _gdi_
.FONTENCODING_MACKOREAN
1550 FONTENCODING_MACARABIC
= _gdi_
.FONTENCODING_MACARABIC
1551 FONTENCODING_MACHEBREW
= _gdi_
.FONTENCODING_MACHEBREW
1552 FONTENCODING_MACGREEK
= _gdi_
.FONTENCODING_MACGREEK
1553 FONTENCODING_MACCYRILLIC
= _gdi_
.FONTENCODING_MACCYRILLIC
1554 FONTENCODING_MACDEVANAGARI
= _gdi_
.FONTENCODING_MACDEVANAGARI
1555 FONTENCODING_MACGURMUKHI
= _gdi_
.FONTENCODING_MACGURMUKHI
1556 FONTENCODING_MACGUJARATI
= _gdi_
.FONTENCODING_MACGUJARATI
1557 FONTENCODING_MACORIYA
= _gdi_
.FONTENCODING_MACORIYA
1558 FONTENCODING_MACBENGALI
= _gdi_
.FONTENCODING_MACBENGALI
1559 FONTENCODING_MACTAMIL
= _gdi_
.FONTENCODING_MACTAMIL
1560 FONTENCODING_MACTELUGU
= _gdi_
.FONTENCODING_MACTELUGU
1561 FONTENCODING_MACKANNADA
= _gdi_
.FONTENCODING_MACKANNADA
1562 FONTENCODING_MACMALAJALAM
= _gdi_
.FONTENCODING_MACMALAJALAM
1563 FONTENCODING_MACSINHALESE
= _gdi_
.FONTENCODING_MACSINHALESE
1564 FONTENCODING_MACBURMESE
= _gdi_
.FONTENCODING_MACBURMESE
1565 FONTENCODING_MACKHMER
= _gdi_
.FONTENCODING_MACKHMER
1566 FONTENCODING_MACTHAI
= _gdi_
.FONTENCODING_MACTHAI
1567 FONTENCODING_MACLAOTIAN
= _gdi_
.FONTENCODING_MACLAOTIAN
1568 FONTENCODING_MACGEORGIAN
= _gdi_
.FONTENCODING_MACGEORGIAN
1569 FONTENCODING_MACARMENIAN
= _gdi_
.FONTENCODING_MACARMENIAN
1570 FONTENCODING_MACCHINESESIMP
= _gdi_
.FONTENCODING_MACCHINESESIMP
1571 FONTENCODING_MACTIBETAN
= _gdi_
.FONTENCODING_MACTIBETAN
1572 FONTENCODING_MACMONGOLIAN
= _gdi_
.FONTENCODING_MACMONGOLIAN
1573 FONTENCODING_MACETHIOPIC
= _gdi_
.FONTENCODING_MACETHIOPIC
1574 FONTENCODING_MACCENTRALEUR
= _gdi_
.FONTENCODING_MACCENTRALEUR
1575 FONTENCODING_MACVIATNAMESE
= _gdi_
.FONTENCODING_MACVIATNAMESE
1576 FONTENCODING_MACARABICEXT
= _gdi_
.FONTENCODING_MACARABICEXT
1577 FONTENCODING_MACSYMBOL
= _gdi_
.FONTENCODING_MACSYMBOL
1578 FONTENCODING_MACDINGBATS
= _gdi_
.FONTENCODING_MACDINGBATS
1579 FONTENCODING_MACTURKISH
= _gdi_
.FONTENCODING_MACTURKISH
1580 FONTENCODING_MACCROATIAN
= _gdi_
.FONTENCODING_MACCROATIAN
1581 FONTENCODING_MACICELANDIC
= _gdi_
.FONTENCODING_MACICELANDIC
1582 FONTENCODING_MACROMANIAN
= _gdi_
.FONTENCODING_MACROMANIAN
1583 FONTENCODING_MACCELTIC
= _gdi_
.FONTENCODING_MACCELTIC
1584 FONTENCODING_MACGAELIC
= _gdi_
.FONTENCODING_MACGAELIC
1585 FONTENCODING_MACKEYBOARD
= _gdi_
.FONTENCODING_MACKEYBOARD
1586 FONTENCODING_MACMIN
= _gdi_
.FONTENCODING_MACMIN
1587 FONTENCODING_MACMAX
= _gdi_
.FONTENCODING_MACMAX
1588 FONTENCODING_MAX
= _gdi_
.FONTENCODING_MAX
1589 FONTENCODING_UTF16
= _gdi_
.FONTENCODING_UTF16
1590 FONTENCODING_UTF32
= _gdi_
.FONTENCODING_UTF32
1591 FONTENCODING_UNICODE
= _gdi_
.FONTENCODING_UNICODE
1592 FONTENCODING_GB2312
= _gdi_
.FONTENCODING_GB2312
1593 FONTENCODING_BIG5
= _gdi_
.FONTENCODING_BIG5
1594 FONTENCODING_SHIFT_JIS
= _gdi_
.FONTENCODING_SHIFT_JIS
1595 #---------------------------------------------------------------------------
1597 class NativeFontInfo(object):
1598 """Proxy of C++ NativeFontInfo class"""
1599 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1600 __repr__
= _swig_repr
1601 def __init__(self
, *args
, **kwargs
):
1602 """__init__(self) -> NativeFontInfo"""
1603 _gdi_
.NativeFontInfo_swiginit(self
,_gdi_
.new_NativeFontInfo(*args
, **kwargs
))
1604 __swig_destroy__
= _gdi_
.delete_NativeFontInfo
1605 __del__
= lambda self
: None;
1606 def Init(*args
, **kwargs
):
1608 return _gdi_
.NativeFontInfo_Init(*args
, **kwargs
)
1610 def InitFromFont(*args
, **kwargs
):
1611 """InitFromFont(self, Font font)"""
1612 return _gdi_
.NativeFontInfo_InitFromFont(*args
, **kwargs
)
1614 def GetPointSize(*args
, **kwargs
):
1615 """GetPointSize(self) -> int"""
1616 return _gdi_
.NativeFontInfo_GetPointSize(*args
, **kwargs
)
1618 def GetStyle(*args
, **kwargs
):
1619 """GetStyle(self) -> int"""
1620 return _gdi_
.NativeFontInfo_GetStyle(*args
, **kwargs
)
1622 def GetWeight(*args
, **kwargs
):
1623 """GetWeight(self) -> int"""
1624 return _gdi_
.NativeFontInfo_GetWeight(*args
, **kwargs
)
1626 def GetUnderlined(*args
, **kwargs
):
1627 """GetUnderlined(self) -> bool"""
1628 return _gdi_
.NativeFontInfo_GetUnderlined(*args
, **kwargs
)
1630 def GetFaceName(*args
, **kwargs
):
1631 """GetFaceName(self) -> String"""
1632 return _gdi_
.NativeFontInfo_GetFaceName(*args
, **kwargs
)
1634 def GetFamily(*args
, **kwargs
):
1635 """GetFamily(self) -> int"""
1636 return _gdi_
.NativeFontInfo_GetFamily(*args
, **kwargs
)
1638 def GetEncoding(*args
, **kwargs
):
1639 """GetEncoding(self) -> int"""
1640 return _gdi_
.NativeFontInfo_GetEncoding(*args
, **kwargs
)
1642 def SetPointSize(*args
, **kwargs
):
1643 """SetPointSize(self, int pointsize)"""
1644 return _gdi_
.NativeFontInfo_SetPointSize(*args
, **kwargs
)
1646 def SetStyle(*args
, **kwargs
):
1647 """SetStyle(self, int style)"""
1648 return _gdi_
.NativeFontInfo_SetStyle(*args
, **kwargs
)
1650 def SetWeight(*args
, **kwargs
):
1651 """SetWeight(self, int weight)"""
1652 return _gdi_
.NativeFontInfo_SetWeight(*args
, **kwargs
)
1654 def SetUnderlined(*args
, **kwargs
):
1655 """SetUnderlined(self, bool underlined)"""
1656 return _gdi_
.NativeFontInfo_SetUnderlined(*args
, **kwargs
)
1658 def SetFaceName(*args
, **kwargs
):
1659 """SetFaceName(self, String facename) -> bool"""
1660 return _gdi_
.NativeFontInfo_SetFaceName(*args
, **kwargs
)
1662 def SetFamily(*args
, **kwargs
):
1663 """SetFamily(self, int family)"""
1664 return _gdi_
.NativeFontInfo_SetFamily(*args
, **kwargs
)
1666 def SetEncoding(*args
, **kwargs
):
1667 """SetEncoding(self, int encoding)"""
1668 return _gdi_
.NativeFontInfo_SetEncoding(*args
, **kwargs
)
1670 def FromString(*args
, **kwargs
):
1671 """FromString(self, String s) -> bool"""
1672 return _gdi_
.NativeFontInfo_FromString(*args
, **kwargs
)
1674 def ToString(*args
, **kwargs
):
1675 """ToString(self) -> String"""
1676 return _gdi_
.NativeFontInfo_ToString(*args
, **kwargs
)
1678 def __str__(*args
, **kwargs
):
1679 """__str__(self) -> String"""
1680 return _gdi_
.NativeFontInfo___str__(*args
, **kwargs
)
1682 def FromUserString(*args
, **kwargs
):
1683 """FromUserString(self, String s) -> bool"""
1684 return _gdi_
.NativeFontInfo_FromUserString(*args
, **kwargs
)
1686 def ToUserString(*args
, **kwargs
):
1687 """ToUserString(self) -> String"""
1688 return _gdi_
.NativeFontInfo_ToUserString(*args
, **kwargs
)
1690 Encoding
= property(GetEncoding
,SetEncoding
,doc
="See `GetEncoding` and `SetEncoding`")
1691 FaceName
= property(GetFaceName
,SetFaceName
,doc
="See `GetFaceName` and `SetFaceName`")
1692 Family
= property(GetFamily
,SetFamily
,doc
="See `GetFamily` and `SetFamily`")
1693 PointSize
= property(GetPointSize
,SetPointSize
,doc
="See `GetPointSize` and `SetPointSize`")
1694 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
1695 Underlined
= property(GetUnderlined
,SetUnderlined
,doc
="See `GetUnderlined` and `SetUnderlined`")
1696 Weight
= property(GetWeight
,SetWeight
,doc
="See `GetWeight` and `SetWeight`")
1697 _gdi_
.NativeFontInfo_swigregister(NativeFontInfo
)
1699 class NativeEncodingInfo(object):
1700 """Proxy of C++ NativeEncodingInfo class"""
1701 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1702 __repr__
= _swig_repr
1703 facename
= property(_gdi_
.NativeEncodingInfo_facename_get
, _gdi_
.NativeEncodingInfo_facename_set
)
1704 encoding
= property(_gdi_
.NativeEncodingInfo_encoding_get
, _gdi_
.NativeEncodingInfo_encoding_set
)
1705 def __init__(self
, *args
, **kwargs
):
1706 """__init__(self) -> NativeEncodingInfo"""
1707 _gdi_
.NativeEncodingInfo_swiginit(self
,_gdi_
.new_NativeEncodingInfo(*args
, **kwargs
))
1708 __swig_destroy__
= _gdi_
.delete_NativeEncodingInfo
1709 __del__
= lambda self
: None;
1710 def FromString(*args
, **kwargs
):
1711 """FromString(self, String s) -> bool"""
1712 return _gdi_
.NativeEncodingInfo_FromString(*args
, **kwargs
)
1714 def ToString(*args
, **kwargs
):
1715 """ToString(self) -> String"""
1716 return _gdi_
.NativeEncodingInfo_ToString(*args
, **kwargs
)
1718 _gdi_
.NativeEncodingInfo_swigregister(NativeEncodingInfo
)
1721 def GetNativeFontEncoding(*args
, **kwargs
):
1722 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
1723 return _gdi_
.GetNativeFontEncoding(*args
, **kwargs
)
1725 def TestFontEncoding(*args
, **kwargs
):
1726 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
1727 return _gdi_
.TestFontEncoding(*args
, **kwargs
)
1728 #---------------------------------------------------------------------------
1730 class FontMapper(object):
1731 """Proxy of C++ FontMapper class"""
1732 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1733 __repr__
= _swig_repr
1734 def __init__(self
, *args
, **kwargs
):
1735 """__init__(self) -> FontMapper"""
1736 _gdi_
.FontMapper_swiginit(self
,_gdi_
.new_FontMapper(*args
, **kwargs
))
1737 __swig_destroy__
= _gdi_
.delete_FontMapper
1738 __del__
= lambda self
: None;
1739 def Get(*args
, **kwargs
):
1740 """Get() -> FontMapper"""
1741 return _gdi_
.FontMapper_Get(*args
, **kwargs
)
1743 Get
= staticmethod(Get
)
1744 def Set(*args
, **kwargs
):
1745 """Set(FontMapper mapper) -> FontMapper"""
1746 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1748 Set
= staticmethod(Set
)
1749 def CharsetToEncoding(*args
, **kwargs
):
1750 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
1751 return _gdi_
.FontMapper_CharsetToEncoding(*args
, **kwargs
)
1753 def GetSupportedEncodingsCount(*args
, **kwargs
):
1754 """GetSupportedEncodingsCount() -> size_t"""
1755 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
, **kwargs
)
1757 GetSupportedEncodingsCount
= staticmethod(GetSupportedEncodingsCount
)
1758 def GetEncoding(*args
, **kwargs
):
1759 """GetEncoding(size_t n) -> int"""
1760 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1762 GetEncoding
= staticmethod(GetEncoding
)
1763 def GetEncodingName(*args
, **kwargs
):
1764 """GetEncodingName(int encoding) -> String"""
1765 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1767 GetEncodingName
= staticmethod(GetEncodingName
)
1768 def GetEncodingDescription(*args
, **kwargs
):
1769 """GetEncodingDescription(int encoding) -> String"""
1770 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1772 GetEncodingDescription
= staticmethod(GetEncodingDescription
)
1773 def GetEncodingFromName(*args
, **kwargs
):
1774 """GetEncodingFromName(String name) -> int"""
1775 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1777 GetEncodingFromName
= staticmethod(GetEncodingFromName
)
1778 def SetConfigPath(*args
, **kwargs
):
1779 """SetConfigPath(self, String prefix)"""
1780 return _gdi_
.FontMapper_SetConfigPath(*args
, **kwargs
)
1782 def GetDefaultConfigPath(*args
, **kwargs
):
1783 """GetDefaultConfigPath() -> String"""
1784 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
, **kwargs
)
1786 GetDefaultConfigPath
= staticmethod(GetDefaultConfigPath
)
1787 def GetAltForEncoding(*args
, **kwargs
):
1788 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
1789 return _gdi_
.FontMapper_GetAltForEncoding(*args
, **kwargs
)
1791 def IsEncodingAvailable(*args
, **kwargs
):
1792 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
1793 return _gdi_
.FontMapper_IsEncodingAvailable(*args
, **kwargs
)
1795 def SetDialogParent(*args
, **kwargs
):
1796 """SetDialogParent(self, Window parent)"""
1797 return _gdi_
.FontMapper_SetDialogParent(*args
, **kwargs
)
1799 def SetDialogTitle(*args
, **kwargs
):
1800 """SetDialogTitle(self, String title)"""
1801 return _gdi_
.FontMapper_SetDialogTitle(*args
, **kwargs
)
1803 AltForEncoding
= property(GetAltForEncoding
,doc
="See `GetAltForEncoding`")
1804 _gdi_
.FontMapper_swigregister(FontMapper
)
1806 def FontMapper_Get(*args
):
1807 """FontMapper_Get() -> FontMapper"""
1808 return _gdi_
.FontMapper_Get(*args
)
1810 def FontMapper_Set(*args
, **kwargs
):
1811 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
1812 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1814 def FontMapper_GetSupportedEncodingsCount(*args
):
1815 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
1816 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
)
1818 def FontMapper_GetEncoding(*args
, **kwargs
):
1819 """FontMapper_GetEncoding(size_t n) -> int"""
1820 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1822 def FontMapper_GetEncodingName(*args
, **kwargs
):
1823 """FontMapper_GetEncodingName(int encoding) -> String"""
1824 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1826 def FontMapper_GetEncodingDescription(*args
, **kwargs
):
1827 """FontMapper_GetEncodingDescription(int encoding) -> String"""
1828 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1830 def FontMapper_GetEncodingFromName(*args
, **kwargs
):
1831 """FontMapper_GetEncodingFromName(String name) -> int"""
1832 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1834 def FontMapper_GetDefaultConfigPath(*args
):
1835 """FontMapper_GetDefaultConfigPath() -> String"""
1836 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
)
1838 #---------------------------------------------------------------------------
1840 class Font(GDIObject
):
1842 A font is an object which determines the appearance of text. Fonts are
1843 used for drawing text to a device context, and setting the appearance
1846 You can retrieve the current system font settings with `wx.SystemSettings`.
1848 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1849 __repr__
= _swig_repr
1850 def __init__(self
, *args
, **kwargs
):
1852 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
1853 String face=EmptyString,
1854 int encoding=FONTENCODING_DEFAULT) -> Font
1856 Creates a font object with the specified attributes.
1858 :param pointSize: The size of the font in points.
1860 :param family: Font family. A generic way of referring to fonts
1861 without specifying actual facename. It can be One of
1862 the ``wx.FONTFAMILY_xxx`` constants.
1864 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1866 :param weight: Font weight, sometimes also referred to as font
1867 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1869 :param underline: The value can be ``True`` or ``False`` and
1870 indicates whether the font will include an underline. This
1871 may not be supported on all platforms.
1873 :param face: An optional string specifying the actual typeface to
1874 be used. If it is an empty string, a default typeface will be
1875 chosen based on the family.
1877 :param encoding: An encoding which may be one of the
1878 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1879 available, no font is created.
1881 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1882 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1885 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1886 _gdi_
.Font_swiginit(self
,_gdi_
.new_Font(*args
, **kwargs
))
1887 __swig_destroy__
= _gdi_
.delete_Font
1888 __del__
= lambda self
: None;
1889 def Ok(*args
, **kwargs
):
1893 Returns ``True`` if this font was successfully created.
1895 return _gdi_
.Font_Ok(*args
, **kwargs
)
1897 def __nonzero__(self
): return self
.Ok()
1898 def __eq__(*args
, **kwargs
):
1899 """__eq__(self, Font other) -> bool"""
1900 return _gdi_
.Font___eq__(*args
, **kwargs
)
1902 def __ne__(*args
, **kwargs
):
1903 """__ne__(self, Font other) -> bool"""
1904 return _gdi_
.Font___ne__(*args
, **kwargs
)
1906 def GetPointSize(*args
, **kwargs
):
1908 GetPointSize(self) -> int
1910 Gets the point size.
1912 return _gdi_
.Font_GetPointSize(*args
, **kwargs
)
1914 def GetPixelSize(*args
, **kwargs
):
1916 GetPixelSize(self) -> Size
1918 Returns the size in pixels if the font was constructed with a pixel
1921 return _gdi_
.Font_GetPixelSize(*args
, **kwargs
)
1923 def IsUsingSizeInPixels(*args
, **kwargs
):
1925 IsUsingSizeInPixels(self) -> bool
1927 Returns ``True`` if the font is using a pixelSize.
1929 return _gdi_
.Font_IsUsingSizeInPixels(*args
, **kwargs
)
1931 def GetFamily(*args
, **kwargs
):
1933 GetFamily(self) -> int
1935 Gets the font family.
1937 return _gdi_
.Font_GetFamily(*args
, **kwargs
)
1939 def GetStyle(*args
, **kwargs
):
1941 GetStyle(self) -> int
1943 Gets the font style.
1945 return _gdi_
.Font_GetStyle(*args
, **kwargs
)
1947 def GetWeight(*args
, **kwargs
):
1949 GetWeight(self) -> int
1951 Gets the font weight.
1953 return _gdi_
.Font_GetWeight(*args
, **kwargs
)
1955 def GetUnderlined(*args
, **kwargs
):
1957 GetUnderlined(self) -> bool
1959 Returns ``True`` if the font is underlined, ``False`` otherwise.
1961 return _gdi_
.Font_GetUnderlined(*args
, **kwargs
)
1963 def GetFaceName(*args
, **kwargs
):
1965 GetFaceName(self) -> String
1967 Returns the typeface name associated with the font, or the empty
1968 string if there is no typeface information.
1970 return _gdi_
.Font_GetFaceName(*args
, **kwargs
)
1972 def GetEncoding(*args
, **kwargs
):
1974 GetEncoding(self) -> int
1976 Get the font's encoding.
1978 return _gdi_
.Font_GetEncoding(*args
, **kwargs
)
1980 def GetNativeFontInfo(*args
, **kwargs
):
1982 GetNativeFontInfo(self) -> NativeFontInfo
1984 Constructs a `wx.NativeFontInfo` object from this font.
1986 return _gdi_
.Font_GetNativeFontInfo(*args
, **kwargs
)
1988 def IsFixedWidth(*args
, **kwargs
):
1990 IsFixedWidth(self) -> bool
1992 Returns true if the font is a fixed width (or monospaced) font, false
1993 if it is a proportional one or font is invalid.
1995 return _gdi_
.Font_IsFixedWidth(*args
, **kwargs
)
1997 def GetNativeFontInfoDesc(*args
, **kwargs
):
1999 GetNativeFontInfoDesc(self) -> String
2001 Returns the platform-dependent string completely describing this font
2002 or an empty string if the font isn't valid.
2004 return _gdi_
.Font_GetNativeFontInfoDesc(*args
, **kwargs
)
2006 def GetNativeFontInfoUserDesc(*args
, **kwargs
):
2008 GetNativeFontInfoUserDesc(self) -> String
2010 Returns a human readable version of `GetNativeFontInfoDesc`.
2012 return _gdi_
.Font_GetNativeFontInfoUserDesc(*args
, **kwargs
)
2014 def SetPointSize(*args
, **kwargs
):
2016 SetPointSize(self, int pointSize)
2018 Sets the point size.
2020 return _gdi_
.Font_SetPointSize(*args
, **kwargs
)
2022 def SetPixelSize(*args
, **kwargs
):
2024 SetPixelSize(self, Size pixelSize)
2026 Sets the size in pixels rather than points. If there is platform API
2027 support for this then it is used, otherwise a font with the closest
2028 size is found using a binary search.
2030 return _gdi_
.Font_SetPixelSize(*args
, **kwargs
)
2032 def SetFamily(*args
, **kwargs
):
2034 SetFamily(self, int family)
2036 Sets the font family.
2038 return _gdi_
.Font_SetFamily(*args
, **kwargs
)
2040 def SetStyle(*args
, **kwargs
):
2042 SetStyle(self, int style)
2044 Sets the font style.
2046 return _gdi_
.Font_SetStyle(*args
, **kwargs
)
2048 def SetWeight(*args
, **kwargs
):
2050 SetWeight(self, int weight)
2052 Sets the font weight.
2054 return _gdi_
.Font_SetWeight(*args
, **kwargs
)
2056 def SetFaceName(*args
, **kwargs
):
2058 SetFaceName(self, String faceName) -> bool
2060 Sets the facename for the font. The facename, which should be a valid
2061 font installed on the end-user's system.
2063 To avoid portability problems, don't rely on a specific face, but
2064 specify the font family instead or as well. A suitable font will be
2065 found on the end-user's system. If both the family and the facename
2066 are specified, wxWidgets will first search for the specific face, and
2067 then for a font belonging to the same family.
2069 return _gdi_
.Font_SetFaceName(*args
, **kwargs
)
2071 def SetUnderlined(*args
, **kwargs
):
2073 SetUnderlined(self, bool underlined)
2077 return _gdi_
.Font_SetUnderlined(*args
, **kwargs
)
2079 def SetEncoding(*args
, **kwargs
):
2081 SetEncoding(self, int encoding)
2083 Set the font encoding.
2085 return _gdi_
.Font_SetEncoding(*args
, **kwargs
)
2087 def SetNativeFontInfo(*args
, **kwargs
):
2089 SetNativeFontInfo(self, NativeFontInfo info)
2091 Set the font's attributes from a `wx.NativeFontInfo` object.
2093 return _gdi_
.Font_SetNativeFontInfo(*args
, **kwargs
)
2095 def SetNativeFontInfoFromString(*args
, **kwargs
):
2097 SetNativeFontInfoFromString(self, String info) -> bool
2099 Set the font's attributes from string representation of a
2100 `wx.NativeFontInfo` object.
2102 return _gdi_
.Font_SetNativeFontInfoFromString(*args
, **kwargs
)
2104 def SetNativeFontInfoUserDesc(*args
, **kwargs
):
2106 SetNativeFontInfoUserDesc(self, String info) -> bool
2108 Set the font's attributes from a string formerly returned from
2109 `GetNativeFontInfoDesc`.
2111 return _gdi_
.Font_SetNativeFontInfoUserDesc(*args
, **kwargs
)
2113 def GetFamilyString(*args
, **kwargs
):
2115 GetFamilyString(self) -> String
2117 Returns a string representation of the font family.
2119 return _gdi_
.Font_GetFamilyString(*args
, **kwargs
)
2121 def GetStyleString(*args
, **kwargs
):
2123 GetStyleString(self) -> String
2125 Returns a string representation of the font style.
2127 return _gdi_
.Font_GetStyleString(*args
, **kwargs
)
2129 def GetWeightString(*args
, **kwargs
):
2131 GetWeightString(self) -> String
2133 Return a string representation of the font weight.
2135 return _gdi_
.Font_GetWeightString(*args
, **kwargs
)
2137 def SetNoAntiAliasing(*args
, **kwargs
):
2138 """SetNoAntiAliasing(self, bool no=True)"""
2139 return _gdi_
.Font_SetNoAntiAliasing(*args
, **kwargs
)
2141 def GetNoAntiAliasing(*args
, **kwargs
):
2142 """GetNoAntiAliasing(self) -> bool"""
2143 return _gdi_
.Font_GetNoAntiAliasing(*args
, **kwargs
)
2145 def GetDefaultEncoding(*args
, **kwargs
):
2147 GetDefaultEncoding() -> int
2149 Returns the encoding used for all fonts created with an encoding of
2150 ``wx.FONTENCODING_DEFAULT``.
2152 return _gdi_
.Font_GetDefaultEncoding(*args
, **kwargs
)
2154 GetDefaultEncoding
= staticmethod(GetDefaultEncoding
)
2155 def SetDefaultEncoding(*args
, **kwargs
):
2157 SetDefaultEncoding(int encoding)
2159 Sets the default font encoding.
2161 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
2163 SetDefaultEncoding
= staticmethod(SetDefaultEncoding
)
2164 Encoding
= property(GetEncoding
,SetEncoding
,doc
="See `GetEncoding` and `SetEncoding`")
2165 FaceName
= property(GetFaceName
,SetFaceName
,doc
="See `GetFaceName` and `SetFaceName`")
2166 Family
= property(GetFamily
,SetFamily
,doc
="See `GetFamily` and `SetFamily`")
2167 FamilyString
= property(GetFamilyString
,doc
="See `GetFamilyString`")
2168 NativeFontInfo
= property(GetNativeFontInfo
,SetNativeFontInfo
,doc
="See `GetNativeFontInfo` and `SetNativeFontInfo`")
2169 NativeFontInfoDesc
= property(GetNativeFontInfoDesc
,doc
="See `GetNativeFontInfoDesc`")
2170 NativeFontInfoUserDesc
= property(GetNativeFontInfoUserDesc
,SetNativeFontInfoUserDesc
,doc
="See `GetNativeFontInfoUserDesc` and `SetNativeFontInfoUserDesc`")
2171 NoAntiAliasing
= property(GetNoAntiAliasing
,SetNoAntiAliasing
,doc
="See `GetNoAntiAliasing` and `SetNoAntiAliasing`")
2172 PixelSize
= property(GetPixelSize
,SetPixelSize
,doc
="See `GetPixelSize` and `SetPixelSize`")
2173 PointSize
= property(GetPointSize
,SetPointSize
,doc
="See `GetPointSize` and `SetPointSize`")
2174 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
2175 StyleString
= property(GetStyleString
,doc
="See `GetStyleString`")
2176 Underlined
= property(GetUnderlined
,SetUnderlined
,doc
="See `GetUnderlined` and `SetUnderlined`")
2177 Weight
= property(GetWeight
,SetWeight
,doc
="See `GetWeight` and `SetWeight`")
2178 WeightString
= property(GetWeightString
,doc
="See `GetWeightString`")
2179 _gdi_
.Font_swigregister(Font
)
2181 def FontFromNativeInfo(*args
, **kwargs
):
2183 FontFromNativeInfo(NativeFontInfo info) -> Font
2185 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
2187 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2188 val
= _gdi_
.new_FontFromNativeInfo(*args
, **kwargs
)
2191 def FontFromNativeInfoString(*args
, **kwargs
):
2193 FontFromNativeInfoString(String info) -> Font
2195 Construct a `wx.Font` from the string representation of a
2196 `wx.NativeFontInfo` object.
2198 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2199 val
= _gdi_
.new_FontFromNativeInfoString(*args
, **kwargs
)
2202 def FFont(*args
, **kwargs
):
2204 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
2205 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2207 A bit of a simpler way to create a `wx.Font` using flags instead of
2208 individual attribute settings. The value of flags can be a
2209 combination of the following:
2211 ============================ ==
2217 wx.FONTFLAG_ANTIALIASED
2218 wx.FONTFLAG_NOT_ANTIALIASED
2219 wx.FONTFLAG_UNDERLINED
2220 wx.FONTFLAG_STRIKETHROUGH
2221 ============================ ==
2223 :see: `wx.Font.__init__`
2225 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2226 val
= _gdi_
.new_FFont(*args
, **kwargs
)
2229 def FontFromPixelSize(*args
, **kwargs
):
2231 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
2232 bool underlined=False, String face=wxEmptyString,
2233 int encoding=FONTENCODING_DEFAULT) -> Font
2235 Creates a font using a size in pixels rather than points. If there is
2236 platform API support for this then it is used, otherwise a font with
2237 the closest size is found using a binary search.
2239 :see: `wx.Font.__init__`
2241 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2242 val
= _gdi_
.new_FontFromPixelSize(*args
, **kwargs
)
2245 def FFontFromPixelSize(*args
, **kwargs
):
2247 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
2248 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2250 Creates a font using a size in pixels rather than points. If there is
2251 platform API support for this then it is used, otherwise a font with
2252 the closest size is found using a binary search.
2254 :see: `wx.Font.__init__`, `wx.FFont`
2256 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2257 val
= _gdi_
.new_FFontFromPixelSize(*args
, **kwargs
)
2260 def Font_GetDefaultEncoding(*args
):
2262 Font_GetDefaultEncoding() -> int
2264 Returns the encoding used for all fonts created with an encoding of
2265 ``wx.FONTENCODING_DEFAULT``.
2267 return _gdi_
.Font_GetDefaultEncoding(*args
)
2269 def Font_SetDefaultEncoding(*args
, **kwargs
):
2271 Font_SetDefaultEncoding(int encoding)
2273 Sets the default font encoding.
2275 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
2277 Font2
= wx
._deprecated
(FFont
, "Use `wx.FFont` instead.")
2278 #---------------------------------------------------------------------------
2280 class FontEnumerator(object):
2281 """Proxy of C++ FontEnumerator class"""
2282 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2283 __repr__
= _swig_repr
2284 def __init__(self
, *args
, **kwargs
):
2285 """__init__(self) -> FontEnumerator"""
2286 _gdi_
.FontEnumerator_swiginit(self
,_gdi_
.new_FontEnumerator(*args
, **kwargs
))
2287 self
._setCallbackInfo
(self
, FontEnumerator
, 0)
2289 __swig_destroy__
= _gdi_
.delete_FontEnumerator
2290 __del__
= lambda self
: None;
2291 def _setCallbackInfo(*args
, **kwargs
):
2292 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
2293 return _gdi_
.FontEnumerator__setCallbackInfo(*args
, **kwargs
)
2295 def EnumerateFacenames(*args
, **kwargs
):
2296 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
2297 return _gdi_
.FontEnumerator_EnumerateFacenames(*args
, **kwargs
)
2299 def EnumerateEncodings(*args
, **kwargs
):
2300 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
2301 return _gdi_
.FontEnumerator_EnumerateEncodings(*args
, **kwargs
)
2303 def GetEncodings(*args
, **kwargs
):
2304 """GetEncodings() -> PyObject"""
2305 return _gdi_
.FontEnumerator_GetEncodings(*args
, **kwargs
)
2307 GetEncodings
= staticmethod(GetEncodings
)
2308 def GetFacenames(*args
, **kwargs
):
2309 """GetFacenames() -> PyObject"""
2310 return _gdi_
.FontEnumerator_GetFacenames(*args
, **kwargs
)
2312 GetFacenames
= staticmethod(GetFacenames
)
2313 def IsValidFacename(*args
, **kwargs
):
2315 IsValidFacename(String str) -> bool
2317 Convenience function that returns true if the given face name exist in
2320 return _gdi_
.FontEnumerator_IsValidFacename(*args
, **kwargs
)
2322 IsValidFacename
= staticmethod(IsValidFacename
)
2323 _gdi_
.FontEnumerator_swigregister(FontEnumerator
)
2325 def FontEnumerator_GetEncodings(*args
):
2326 """FontEnumerator_GetEncodings() -> PyObject"""
2327 return _gdi_
.FontEnumerator_GetEncodings(*args
)
2329 def FontEnumerator_GetFacenames(*args
):
2330 """FontEnumerator_GetFacenames() -> PyObject"""
2331 return _gdi_
.FontEnumerator_GetFacenames(*args
)
2333 def FontEnumerator_IsValidFacename(*args
, **kwargs
):
2335 FontEnumerator_IsValidFacename(String str) -> bool
2337 Convenience function that returns true if the given face name exist in
2340 return _gdi_
.FontEnumerator_IsValidFacename(*args
, **kwargs
)
2342 #---------------------------------------------------------------------------
2344 Layout_Default
= _gdi_
.Layout_Default
2345 Layout_LeftToRight
= _gdi_
.Layout_LeftToRight
2346 Layout_RightToLeft
= _gdi_
.Layout_RightToLeft
2347 LANGUAGE_DEFAULT
= _gdi_
.LANGUAGE_DEFAULT
2348 LANGUAGE_UNKNOWN
= _gdi_
.LANGUAGE_UNKNOWN
2349 LANGUAGE_ABKHAZIAN
= _gdi_
.LANGUAGE_ABKHAZIAN
2350 LANGUAGE_AFAR
= _gdi_
.LANGUAGE_AFAR
2351 LANGUAGE_AFRIKAANS
= _gdi_
.LANGUAGE_AFRIKAANS
2352 LANGUAGE_ALBANIAN
= _gdi_
.LANGUAGE_ALBANIAN
2353 LANGUAGE_AMHARIC
= _gdi_
.LANGUAGE_AMHARIC
2354 LANGUAGE_ARABIC
= _gdi_
.LANGUAGE_ARABIC
2355 LANGUAGE_ARABIC_ALGERIA
= _gdi_
.LANGUAGE_ARABIC_ALGERIA
2356 LANGUAGE_ARABIC_BAHRAIN
= _gdi_
.LANGUAGE_ARABIC_BAHRAIN
2357 LANGUAGE_ARABIC_EGYPT
= _gdi_
.LANGUAGE_ARABIC_EGYPT
2358 LANGUAGE_ARABIC_IRAQ
= _gdi_
.LANGUAGE_ARABIC_IRAQ
2359 LANGUAGE_ARABIC_JORDAN
= _gdi_
.LANGUAGE_ARABIC_JORDAN
2360 LANGUAGE_ARABIC_KUWAIT
= _gdi_
.LANGUAGE_ARABIC_KUWAIT
2361 LANGUAGE_ARABIC_LEBANON
= _gdi_
.LANGUAGE_ARABIC_LEBANON
2362 LANGUAGE_ARABIC_LIBYA
= _gdi_
.LANGUAGE_ARABIC_LIBYA
2363 LANGUAGE_ARABIC_MOROCCO
= _gdi_
.LANGUAGE_ARABIC_MOROCCO
2364 LANGUAGE_ARABIC_OMAN
= _gdi_
.LANGUAGE_ARABIC_OMAN
2365 LANGUAGE_ARABIC_QATAR
= _gdi_
.LANGUAGE_ARABIC_QATAR
2366 LANGUAGE_ARABIC_SAUDI_ARABIA
= _gdi_
.LANGUAGE_ARABIC_SAUDI_ARABIA
2367 LANGUAGE_ARABIC_SUDAN
= _gdi_
.LANGUAGE_ARABIC_SUDAN
2368 LANGUAGE_ARABIC_SYRIA
= _gdi_
.LANGUAGE_ARABIC_SYRIA
2369 LANGUAGE_ARABIC_TUNISIA
= _gdi_
.LANGUAGE_ARABIC_TUNISIA
2370 LANGUAGE_ARABIC_UAE
= _gdi_
.LANGUAGE_ARABIC_UAE
2371 LANGUAGE_ARABIC_YEMEN
= _gdi_
.LANGUAGE_ARABIC_YEMEN
2372 LANGUAGE_ARMENIAN
= _gdi_
.LANGUAGE_ARMENIAN
2373 LANGUAGE_ASSAMESE
= _gdi_
.LANGUAGE_ASSAMESE
2374 LANGUAGE_AYMARA
= _gdi_
.LANGUAGE_AYMARA
2375 LANGUAGE_AZERI
= _gdi_
.LANGUAGE_AZERI
2376 LANGUAGE_AZERI_CYRILLIC
= _gdi_
.LANGUAGE_AZERI_CYRILLIC
2377 LANGUAGE_AZERI_LATIN
= _gdi_
.LANGUAGE_AZERI_LATIN
2378 LANGUAGE_BASHKIR
= _gdi_
.LANGUAGE_BASHKIR
2379 LANGUAGE_BASQUE
= _gdi_
.LANGUAGE_BASQUE
2380 LANGUAGE_BELARUSIAN
= _gdi_
.LANGUAGE_BELARUSIAN
2381 LANGUAGE_BENGALI
= _gdi_
.LANGUAGE_BENGALI
2382 LANGUAGE_BHUTANI
= _gdi_
.LANGUAGE_BHUTANI
2383 LANGUAGE_BIHARI
= _gdi_
.LANGUAGE_BIHARI
2384 LANGUAGE_BISLAMA
= _gdi_
.LANGUAGE_BISLAMA
2385 LANGUAGE_BRETON
= _gdi_
.LANGUAGE_BRETON
2386 LANGUAGE_BULGARIAN
= _gdi_
.LANGUAGE_BULGARIAN
2387 LANGUAGE_BURMESE
= _gdi_
.LANGUAGE_BURMESE
2388 LANGUAGE_CAMBODIAN
= _gdi_
.LANGUAGE_CAMBODIAN
2389 LANGUAGE_CATALAN
= _gdi_
.LANGUAGE_CATALAN
2390 LANGUAGE_CHINESE
= _gdi_
.LANGUAGE_CHINESE
2391 LANGUAGE_CHINESE_SIMPLIFIED
= _gdi_
.LANGUAGE_CHINESE_SIMPLIFIED
2392 LANGUAGE_CHINESE_TRADITIONAL
= _gdi_
.LANGUAGE_CHINESE_TRADITIONAL
2393 LANGUAGE_CHINESE_HONGKONG
= _gdi_
.LANGUAGE_CHINESE_HONGKONG
2394 LANGUAGE_CHINESE_MACAU
= _gdi_
.LANGUAGE_CHINESE_MACAU
2395 LANGUAGE_CHINESE_SINGAPORE
= _gdi_
.LANGUAGE_CHINESE_SINGAPORE
2396 LANGUAGE_CHINESE_TAIWAN
= _gdi_
.LANGUAGE_CHINESE_TAIWAN
2397 LANGUAGE_CORSICAN
= _gdi_
.LANGUAGE_CORSICAN
2398 LANGUAGE_CROATIAN
= _gdi_
.LANGUAGE_CROATIAN
2399 LANGUAGE_CZECH
= _gdi_
.LANGUAGE_CZECH
2400 LANGUAGE_DANISH
= _gdi_
.LANGUAGE_DANISH
2401 LANGUAGE_DUTCH
= _gdi_
.LANGUAGE_DUTCH
2402 LANGUAGE_DUTCH_BELGIAN
= _gdi_
.LANGUAGE_DUTCH_BELGIAN
2403 LANGUAGE_ENGLISH
= _gdi_
.LANGUAGE_ENGLISH
2404 LANGUAGE_ENGLISH_UK
= _gdi_
.LANGUAGE_ENGLISH_UK
2405 LANGUAGE_ENGLISH_US
= _gdi_
.LANGUAGE_ENGLISH_US
2406 LANGUAGE_ENGLISH_AUSTRALIA
= _gdi_
.LANGUAGE_ENGLISH_AUSTRALIA
2407 LANGUAGE_ENGLISH_BELIZE
= _gdi_
.LANGUAGE_ENGLISH_BELIZE
2408 LANGUAGE_ENGLISH_BOTSWANA
= _gdi_
.LANGUAGE_ENGLISH_BOTSWANA
2409 LANGUAGE_ENGLISH_CANADA
= _gdi_
.LANGUAGE_ENGLISH_CANADA
2410 LANGUAGE_ENGLISH_CARIBBEAN
= _gdi_
.LANGUAGE_ENGLISH_CARIBBEAN
2411 LANGUAGE_ENGLISH_DENMARK
= _gdi_
.LANGUAGE_ENGLISH_DENMARK
2412 LANGUAGE_ENGLISH_EIRE
= _gdi_
.LANGUAGE_ENGLISH_EIRE
2413 LANGUAGE_ENGLISH_JAMAICA
= _gdi_
.LANGUAGE_ENGLISH_JAMAICA
2414 LANGUAGE_ENGLISH_NEW_ZEALAND
= _gdi_
.LANGUAGE_ENGLISH_NEW_ZEALAND
2415 LANGUAGE_ENGLISH_PHILIPPINES
= _gdi_
.LANGUAGE_ENGLISH_PHILIPPINES
2416 LANGUAGE_ENGLISH_SOUTH_AFRICA
= _gdi_
.LANGUAGE_ENGLISH_SOUTH_AFRICA
2417 LANGUAGE_ENGLISH_TRINIDAD
= _gdi_
.LANGUAGE_ENGLISH_TRINIDAD
2418 LANGUAGE_ENGLISH_ZIMBABWE
= _gdi_
.LANGUAGE_ENGLISH_ZIMBABWE
2419 LANGUAGE_ESPERANTO
= _gdi_
.LANGUAGE_ESPERANTO
2420 LANGUAGE_ESTONIAN
= _gdi_
.LANGUAGE_ESTONIAN
2421 LANGUAGE_FAEROESE
= _gdi_
.LANGUAGE_FAEROESE
2422 LANGUAGE_FARSI
= _gdi_
.LANGUAGE_FARSI
2423 LANGUAGE_FIJI
= _gdi_
.LANGUAGE_FIJI
2424 LANGUAGE_FINNISH
= _gdi_
.LANGUAGE_FINNISH
2425 LANGUAGE_FRENCH
= _gdi_
.LANGUAGE_FRENCH
2426 LANGUAGE_FRENCH_BELGIAN
= _gdi_
.LANGUAGE_FRENCH_BELGIAN
2427 LANGUAGE_FRENCH_CANADIAN
= _gdi_
.LANGUAGE_FRENCH_CANADIAN
2428 LANGUAGE_FRENCH_LUXEMBOURG
= _gdi_
.LANGUAGE_FRENCH_LUXEMBOURG
2429 LANGUAGE_FRENCH_MONACO
= _gdi_
.LANGUAGE_FRENCH_MONACO
2430 LANGUAGE_FRENCH_SWISS
= _gdi_
.LANGUAGE_FRENCH_SWISS
2431 LANGUAGE_FRISIAN
= _gdi_
.LANGUAGE_FRISIAN
2432 LANGUAGE_GALICIAN
= _gdi_
.LANGUAGE_GALICIAN
2433 LANGUAGE_GEORGIAN
= _gdi_
.LANGUAGE_GEORGIAN
2434 LANGUAGE_GERMAN
= _gdi_
.LANGUAGE_GERMAN
2435 LANGUAGE_GERMAN_AUSTRIAN
= _gdi_
.LANGUAGE_GERMAN_AUSTRIAN
2436 LANGUAGE_GERMAN_BELGIUM
= _gdi_
.LANGUAGE_GERMAN_BELGIUM
2437 LANGUAGE_GERMAN_LIECHTENSTEIN
= _gdi_
.LANGUAGE_GERMAN_LIECHTENSTEIN
2438 LANGUAGE_GERMAN_LUXEMBOURG
= _gdi_
.LANGUAGE_GERMAN_LUXEMBOURG
2439 LANGUAGE_GERMAN_SWISS
= _gdi_
.LANGUAGE_GERMAN_SWISS
2440 LANGUAGE_GREEK
= _gdi_
.LANGUAGE_GREEK
2441 LANGUAGE_GREENLANDIC
= _gdi_
.LANGUAGE_GREENLANDIC
2442 LANGUAGE_GUARANI
= _gdi_
.LANGUAGE_GUARANI
2443 LANGUAGE_GUJARATI
= _gdi_
.LANGUAGE_GUJARATI
2444 LANGUAGE_HAUSA
= _gdi_
.LANGUAGE_HAUSA
2445 LANGUAGE_HEBREW
= _gdi_
.LANGUAGE_HEBREW
2446 LANGUAGE_HINDI
= _gdi_
.LANGUAGE_HINDI
2447 LANGUAGE_HUNGARIAN
= _gdi_
.LANGUAGE_HUNGARIAN
2448 LANGUAGE_ICELANDIC
= _gdi_
.LANGUAGE_ICELANDIC
2449 LANGUAGE_INDONESIAN
= _gdi_
.LANGUAGE_INDONESIAN
2450 LANGUAGE_INTERLINGUA
= _gdi_
.LANGUAGE_INTERLINGUA
2451 LANGUAGE_INTERLINGUE
= _gdi_
.LANGUAGE_INTERLINGUE
2452 LANGUAGE_INUKTITUT
= _gdi_
.LANGUAGE_INUKTITUT
2453 LANGUAGE_INUPIAK
= _gdi_
.LANGUAGE_INUPIAK
2454 LANGUAGE_IRISH
= _gdi_
.LANGUAGE_IRISH
2455 LANGUAGE_ITALIAN
= _gdi_
.LANGUAGE_ITALIAN
2456 LANGUAGE_ITALIAN_SWISS
= _gdi_
.LANGUAGE_ITALIAN_SWISS
2457 LANGUAGE_JAPANESE
= _gdi_
.LANGUAGE_JAPANESE
2458 LANGUAGE_JAVANESE
= _gdi_
.LANGUAGE_JAVANESE
2459 LANGUAGE_KANNADA
= _gdi_
.LANGUAGE_KANNADA
2460 LANGUAGE_KASHMIRI
= _gdi_
.LANGUAGE_KASHMIRI
2461 LANGUAGE_KASHMIRI_INDIA
= _gdi_
.LANGUAGE_KASHMIRI_INDIA
2462 LANGUAGE_KAZAKH
= _gdi_
.LANGUAGE_KAZAKH
2463 LANGUAGE_KERNEWEK
= _gdi_
.LANGUAGE_KERNEWEK
2464 LANGUAGE_KINYARWANDA
= _gdi_
.LANGUAGE_KINYARWANDA
2465 LANGUAGE_KIRGHIZ
= _gdi_
.LANGUAGE_KIRGHIZ
2466 LANGUAGE_KIRUNDI
= _gdi_
.LANGUAGE_KIRUNDI
2467 LANGUAGE_KONKANI
= _gdi_
.LANGUAGE_KONKANI
2468 LANGUAGE_KOREAN
= _gdi_
.LANGUAGE_KOREAN
2469 LANGUAGE_KURDISH
= _gdi_
.LANGUAGE_KURDISH
2470 LANGUAGE_LAOTHIAN
= _gdi_
.LANGUAGE_LAOTHIAN
2471 LANGUAGE_LATIN
= _gdi_
.LANGUAGE_LATIN
2472 LANGUAGE_LATVIAN
= _gdi_
.LANGUAGE_LATVIAN
2473 LANGUAGE_LINGALA
= _gdi_
.LANGUAGE_LINGALA
2474 LANGUAGE_LITHUANIAN
= _gdi_
.LANGUAGE_LITHUANIAN
2475 LANGUAGE_MACEDONIAN
= _gdi_
.LANGUAGE_MACEDONIAN
2476 LANGUAGE_MALAGASY
= _gdi_
.LANGUAGE_MALAGASY
2477 LANGUAGE_MALAY
= _gdi_
.LANGUAGE_MALAY
2478 LANGUAGE_MALAYALAM
= _gdi_
.LANGUAGE_MALAYALAM
2479 LANGUAGE_MALAY_BRUNEI_DARUSSALAM
= _gdi_
.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2480 LANGUAGE_MALAY_MALAYSIA
= _gdi_
.LANGUAGE_MALAY_MALAYSIA
2481 LANGUAGE_MALTESE
= _gdi_
.LANGUAGE_MALTESE
2482 LANGUAGE_MANIPURI
= _gdi_
.LANGUAGE_MANIPURI
2483 LANGUAGE_MAORI
= _gdi_
.LANGUAGE_MAORI
2484 LANGUAGE_MARATHI
= _gdi_
.LANGUAGE_MARATHI
2485 LANGUAGE_MOLDAVIAN
= _gdi_
.LANGUAGE_MOLDAVIAN
2486 LANGUAGE_MONGOLIAN
= _gdi_
.LANGUAGE_MONGOLIAN
2487 LANGUAGE_NAURU
= _gdi_
.LANGUAGE_NAURU
2488 LANGUAGE_NEPALI
= _gdi_
.LANGUAGE_NEPALI
2489 LANGUAGE_NEPALI_INDIA
= _gdi_
.LANGUAGE_NEPALI_INDIA
2490 LANGUAGE_NORWEGIAN_BOKMAL
= _gdi_
.LANGUAGE_NORWEGIAN_BOKMAL
2491 LANGUAGE_NORWEGIAN_NYNORSK
= _gdi_
.LANGUAGE_NORWEGIAN_NYNORSK
2492 LANGUAGE_OCCITAN
= _gdi_
.LANGUAGE_OCCITAN
2493 LANGUAGE_ORIYA
= _gdi_
.LANGUAGE_ORIYA
2494 LANGUAGE_OROMO
= _gdi_
.LANGUAGE_OROMO
2495 LANGUAGE_PASHTO
= _gdi_
.LANGUAGE_PASHTO
2496 LANGUAGE_POLISH
= _gdi_
.LANGUAGE_POLISH
2497 LANGUAGE_PORTUGUESE
= _gdi_
.LANGUAGE_PORTUGUESE
2498 LANGUAGE_PORTUGUESE_BRAZILIAN
= _gdi_
.LANGUAGE_PORTUGUESE_BRAZILIAN
2499 LANGUAGE_PUNJABI
= _gdi_
.LANGUAGE_PUNJABI
2500 LANGUAGE_QUECHUA
= _gdi_
.LANGUAGE_QUECHUA
2501 LANGUAGE_RHAETO_ROMANCE
= _gdi_
.LANGUAGE_RHAETO_ROMANCE
2502 LANGUAGE_ROMANIAN
= _gdi_
.LANGUAGE_ROMANIAN
2503 LANGUAGE_RUSSIAN
= _gdi_
.LANGUAGE_RUSSIAN
2504 LANGUAGE_RUSSIAN_UKRAINE
= _gdi_
.LANGUAGE_RUSSIAN_UKRAINE
2505 LANGUAGE_SAMOAN
= _gdi_
.LANGUAGE_SAMOAN
2506 LANGUAGE_SANGHO
= _gdi_
.LANGUAGE_SANGHO
2507 LANGUAGE_SANSKRIT
= _gdi_
.LANGUAGE_SANSKRIT
2508 LANGUAGE_SCOTS_GAELIC
= _gdi_
.LANGUAGE_SCOTS_GAELIC
2509 LANGUAGE_SERBIAN
= _gdi_
.LANGUAGE_SERBIAN
2510 LANGUAGE_SERBIAN_CYRILLIC
= _gdi_
.LANGUAGE_SERBIAN_CYRILLIC
2511 LANGUAGE_SERBIAN_LATIN
= _gdi_
.LANGUAGE_SERBIAN_LATIN
2512 LANGUAGE_SERBO_CROATIAN
= _gdi_
.LANGUAGE_SERBO_CROATIAN
2513 LANGUAGE_SESOTHO
= _gdi_
.LANGUAGE_SESOTHO
2514 LANGUAGE_SETSWANA
= _gdi_
.LANGUAGE_SETSWANA
2515 LANGUAGE_SHONA
= _gdi_
.LANGUAGE_SHONA
2516 LANGUAGE_SINDHI
= _gdi_
.LANGUAGE_SINDHI
2517 LANGUAGE_SINHALESE
= _gdi_
.LANGUAGE_SINHALESE
2518 LANGUAGE_SISWATI
= _gdi_
.LANGUAGE_SISWATI
2519 LANGUAGE_SLOVAK
= _gdi_
.LANGUAGE_SLOVAK
2520 LANGUAGE_SLOVENIAN
= _gdi_
.LANGUAGE_SLOVENIAN
2521 LANGUAGE_SOMALI
= _gdi_
.LANGUAGE_SOMALI
2522 LANGUAGE_SPANISH
= _gdi_
.LANGUAGE_SPANISH
2523 LANGUAGE_SPANISH_ARGENTINA
= _gdi_
.LANGUAGE_SPANISH_ARGENTINA
2524 LANGUAGE_SPANISH_BOLIVIA
= _gdi_
.LANGUAGE_SPANISH_BOLIVIA
2525 LANGUAGE_SPANISH_CHILE
= _gdi_
.LANGUAGE_SPANISH_CHILE
2526 LANGUAGE_SPANISH_COLOMBIA
= _gdi_
.LANGUAGE_SPANISH_COLOMBIA
2527 LANGUAGE_SPANISH_COSTA_RICA
= _gdi_
.LANGUAGE_SPANISH_COSTA_RICA
2528 LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
= _gdi_
.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2529 LANGUAGE_SPANISH_ECUADOR
= _gdi_
.LANGUAGE_SPANISH_ECUADOR
2530 LANGUAGE_SPANISH_EL_SALVADOR
= _gdi_
.LANGUAGE_SPANISH_EL_SALVADOR
2531 LANGUAGE_SPANISH_GUATEMALA
= _gdi_
.LANGUAGE_SPANISH_GUATEMALA
2532 LANGUAGE_SPANISH_HONDURAS
= _gdi_
.LANGUAGE_SPANISH_HONDURAS
2533 LANGUAGE_SPANISH_MEXICAN
= _gdi_
.LANGUAGE_SPANISH_MEXICAN
2534 LANGUAGE_SPANISH_MODERN
= _gdi_
.LANGUAGE_SPANISH_MODERN
2535 LANGUAGE_SPANISH_NICARAGUA
= _gdi_
.LANGUAGE_SPANISH_NICARAGUA
2536 LANGUAGE_SPANISH_PANAMA
= _gdi_
.LANGUAGE_SPANISH_PANAMA
2537 LANGUAGE_SPANISH_PARAGUAY
= _gdi_
.LANGUAGE_SPANISH_PARAGUAY
2538 LANGUAGE_SPANISH_PERU
= _gdi_
.LANGUAGE_SPANISH_PERU
2539 LANGUAGE_SPANISH_PUERTO_RICO
= _gdi_
.LANGUAGE_SPANISH_PUERTO_RICO
2540 LANGUAGE_SPANISH_URUGUAY
= _gdi_
.LANGUAGE_SPANISH_URUGUAY
2541 LANGUAGE_SPANISH_US
= _gdi_
.LANGUAGE_SPANISH_US
2542 LANGUAGE_SPANISH_VENEZUELA
= _gdi_
.LANGUAGE_SPANISH_VENEZUELA
2543 LANGUAGE_SUNDANESE
= _gdi_
.LANGUAGE_SUNDANESE
2544 LANGUAGE_SWAHILI
= _gdi_
.LANGUAGE_SWAHILI
2545 LANGUAGE_SWEDISH
= _gdi_
.LANGUAGE_SWEDISH
2546 LANGUAGE_SWEDISH_FINLAND
= _gdi_
.LANGUAGE_SWEDISH_FINLAND
2547 LANGUAGE_TAGALOG
= _gdi_
.LANGUAGE_TAGALOG
2548 LANGUAGE_TAJIK
= _gdi_
.LANGUAGE_TAJIK
2549 LANGUAGE_TAMIL
= _gdi_
.LANGUAGE_TAMIL
2550 LANGUAGE_TATAR
= _gdi_
.LANGUAGE_TATAR
2551 LANGUAGE_TELUGU
= _gdi_
.LANGUAGE_TELUGU
2552 LANGUAGE_THAI
= _gdi_
.LANGUAGE_THAI
2553 LANGUAGE_TIBETAN
= _gdi_
.LANGUAGE_TIBETAN
2554 LANGUAGE_TIGRINYA
= _gdi_
.LANGUAGE_TIGRINYA
2555 LANGUAGE_TONGA
= _gdi_
.LANGUAGE_TONGA
2556 LANGUAGE_TSONGA
= _gdi_
.LANGUAGE_TSONGA
2557 LANGUAGE_TURKISH
= _gdi_
.LANGUAGE_TURKISH
2558 LANGUAGE_TURKMEN
= _gdi_
.LANGUAGE_TURKMEN
2559 LANGUAGE_TWI
= _gdi_
.LANGUAGE_TWI
2560 LANGUAGE_UIGHUR
= _gdi_
.LANGUAGE_UIGHUR
2561 LANGUAGE_UKRAINIAN
= _gdi_
.LANGUAGE_UKRAINIAN
2562 LANGUAGE_URDU
= _gdi_
.LANGUAGE_URDU
2563 LANGUAGE_URDU_INDIA
= _gdi_
.LANGUAGE_URDU_INDIA
2564 LANGUAGE_URDU_PAKISTAN
= _gdi_
.LANGUAGE_URDU_PAKISTAN
2565 LANGUAGE_UZBEK
= _gdi_
.LANGUAGE_UZBEK
2566 LANGUAGE_UZBEK_CYRILLIC
= _gdi_
.LANGUAGE_UZBEK_CYRILLIC
2567 LANGUAGE_UZBEK_LATIN
= _gdi_
.LANGUAGE_UZBEK_LATIN
2568 LANGUAGE_VIETNAMESE
= _gdi_
.LANGUAGE_VIETNAMESE
2569 LANGUAGE_VOLAPUK
= _gdi_
.LANGUAGE_VOLAPUK
2570 LANGUAGE_WELSH
= _gdi_
.LANGUAGE_WELSH
2571 LANGUAGE_WOLOF
= _gdi_
.LANGUAGE_WOLOF
2572 LANGUAGE_XHOSA
= _gdi_
.LANGUAGE_XHOSA
2573 LANGUAGE_YIDDISH
= _gdi_
.LANGUAGE_YIDDISH
2574 LANGUAGE_YORUBA
= _gdi_
.LANGUAGE_YORUBA
2575 LANGUAGE_ZHUANG
= _gdi_
.LANGUAGE_ZHUANG
2576 LANGUAGE_ZULU
= _gdi_
.LANGUAGE_ZULU
2577 LANGUAGE_USER_DEFINED
= _gdi_
.LANGUAGE_USER_DEFINED
2578 class LanguageInfo(object):
2579 """Proxy of C++ LanguageInfo class"""
2580 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2581 def __init__(self
): raise AttributeError, "No constructor defined"
2582 __repr__
= _swig_repr
2583 Language
= property(_gdi_
.LanguageInfo_Language_get
, _gdi_
.LanguageInfo_Language_set
)
2584 CanonicalName
= property(_gdi_
.LanguageInfo_CanonicalName_get
, _gdi_
.LanguageInfo_CanonicalName_set
)
2585 Description
= property(_gdi_
.LanguageInfo_Description_get
, _gdi_
.LanguageInfo_Description_set
)
2586 _gdi_
.LanguageInfo_swigregister(LanguageInfo
)
2588 LOCALE_CAT_NUMBER
= _gdi_
.LOCALE_CAT_NUMBER
2589 LOCALE_CAT_DATE
= _gdi_
.LOCALE_CAT_DATE
2590 LOCALE_CAT_MONEY
= _gdi_
.LOCALE_CAT_MONEY
2591 LOCALE_CAT_MAX
= _gdi_
.LOCALE_CAT_MAX
2592 LOCALE_THOUSANDS_SEP
= _gdi_
.LOCALE_THOUSANDS_SEP
2593 LOCALE_DECIMAL_POINT
= _gdi_
.LOCALE_DECIMAL_POINT
2594 LOCALE_LOAD_DEFAULT
= _gdi_
.LOCALE_LOAD_DEFAULT
2595 LOCALE_CONV_ENCODING
= _gdi_
.LOCALE_CONV_ENCODING
2596 class Locale(object):
2597 """Proxy of C++ Locale class"""
2598 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2599 __repr__
= _swig_repr
2600 def __init__(self
, *args
, **kwargs
):
2601 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
2602 _gdi_
.Locale_swiginit(self
,_gdi_
.new_Locale(*args
, **kwargs
))
2603 __swig_destroy__
= _gdi_
.delete_Locale
2604 __del__
= lambda self
: None;
2605 def Init1(*args
, **kwargs
):
2607 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2608 bool bLoadDefault=True,
2609 bool bConvertEncoding=False) -> bool
2611 return _gdi_
.Locale_Init1(*args
, **kwargs
)
2613 def Init2(*args
, **kwargs
):
2614 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2615 return _gdi_
.Locale_Init2(*args
, **kwargs
)
2617 def Init(self
, *_args
, **_kwargs
):
2618 if type(_args
[0]) in [type(''), type(u
'')]:
2619 val
= self
.Init1(*_args
, **_kwargs
)
2621 val
= self
.Init2(*_args
, **_kwargs
)
2624 def GetSystemLanguage(*args
, **kwargs
):
2625 """GetSystemLanguage() -> int"""
2626 return _gdi_
.Locale_GetSystemLanguage(*args
, **kwargs
)
2628 GetSystemLanguage
= staticmethod(GetSystemLanguage
)
2629 def GetSystemEncoding(*args
, **kwargs
):
2630 """GetSystemEncoding() -> int"""
2631 return _gdi_
.Locale_GetSystemEncoding(*args
, **kwargs
)
2633 GetSystemEncoding
= staticmethod(GetSystemEncoding
)
2634 def GetSystemEncodingName(*args
, **kwargs
):
2635 """GetSystemEncodingName() -> String"""
2636 return _gdi_
.Locale_GetSystemEncodingName(*args
, **kwargs
)
2638 GetSystemEncodingName
= staticmethod(GetSystemEncodingName
)
2639 def IsOk(*args
, **kwargs
):
2640 """IsOk(self) -> bool"""
2641 return _gdi_
.Locale_IsOk(*args
, **kwargs
)
2643 def __nonzero__(self
): return self
.IsOk()
2644 def GetLocale(*args
, **kwargs
):
2645 """GetLocale(self) -> String"""
2646 return _gdi_
.Locale_GetLocale(*args
, **kwargs
)
2648 def GetLanguage(*args
, **kwargs
):
2649 """GetLanguage(self) -> int"""
2650 return _gdi_
.Locale_GetLanguage(*args
, **kwargs
)
2652 def GetSysName(*args
, **kwargs
):
2653 """GetSysName(self) -> String"""
2654 return _gdi_
.Locale_GetSysName(*args
, **kwargs
)
2656 def GetCanonicalName(*args
, **kwargs
):
2657 """GetCanonicalName(self) -> String"""
2658 return _gdi_
.Locale_GetCanonicalName(*args
, **kwargs
)
2660 def AddCatalogLookupPathPrefix(*args
, **kwargs
):
2661 """AddCatalogLookupPathPrefix(String prefix)"""
2662 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2664 AddCatalogLookupPathPrefix
= staticmethod(AddCatalogLookupPathPrefix
)
2665 def AddCatalog(*args
, **kwargs
):
2666 """AddCatalog(self, String szDomain) -> bool"""
2667 return _gdi_
.Locale_AddCatalog(*args
, **kwargs
)
2669 def IsAvailable(*args
, **kwargs
):
2670 """IsAvailable(int lang) -> bool"""
2671 return _gdi_
.Locale_IsAvailable(*args
, **kwargs
)
2673 IsAvailable
= staticmethod(IsAvailable
)
2674 def IsLoaded(*args
, **kwargs
):
2675 """IsLoaded(self, String szDomain) -> bool"""
2676 return _gdi_
.Locale_IsLoaded(*args
, **kwargs
)
2678 def GetLanguageInfo(*args
, **kwargs
):
2679 """GetLanguageInfo(int lang) -> LanguageInfo"""
2680 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2682 GetLanguageInfo
= staticmethod(GetLanguageInfo
)
2683 def GetLanguageName(*args
, **kwargs
):
2684 """GetLanguageName(int lang) -> String"""
2685 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2687 GetLanguageName
= staticmethod(GetLanguageName
)
2688 def FindLanguageInfo(*args
, **kwargs
):
2689 """FindLanguageInfo(String locale) -> LanguageInfo"""
2690 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2692 FindLanguageInfo
= staticmethod(FindLanguageInfo
)
2693 def AddLanguage(*args
, **kwargs
):
2694 """AddLanguage(LanguageInfo info)"""
2695 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2697 AddLanguage
= staticmethod(AddLanguage
)
2698 def GetString(*args
, **kwargs
):
2699 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2700 return _gdi_
.Locale_GetString(*args
, **kwargs
)
2702 def GetName(*args
, **kwargs
):
2703 """GetName(self) -> String"""
2704 return _gdi_
.Locale_GetName(*args
, **kwargs
)
2706 CanonicalName
= property(GetCanonicalName
,doc
="See `GetCanonicalName`")
2707 Language
= property(GetLanguage
,doc
="See `GetLanguage`")
2708 Locale
= property(GetLocale
,doc
="See `GetLocale`")
2709 Name
= property(GetName
,doc
="See `GetName`")
2710 String
= property(GetString
,doc
="See `GetString`")
2711 SysName
= property(GetSysName
,doc
="See `GetSysName`")
2712 _gdi_
.Locale_swigregister(Locale
)
2714 def Locale_GetSystemLanguage(*args
):
2715 """Locale_GetSystemLanguage() -> int"""
2716 return _gdi_
.Locale_GetSystemLanguage(*args
)
2718 def Locale_GetSystemEncoding(*args
):
2719 """Locale_GetSystemEncoding() -> int"""
2720 return _gdi_
.Locale_GetSystemEncoding(*args
)
2722 def Locale_GetSystemEncodingName(*args
):
2723 """Locale_GetSystemEncodingName() -> String"""
2724 return _gdi_
.Locale_GetSystemEncodingName(*args
)
2726 def Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
):
2727 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2728 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2730 def Locale_IsAvailable(*args
, **kwargs
):
2731 """Locale_IsAvailable(int lang) -> bool"""
2732 return _gdi_
.Locale_IsAvailable(*args
, **kwargs
)
2734 def Locale_GetLanguageInfo(*args
, **kwargs
):
2735 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2736 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2738 def Locale_GetLanguageName(*args
, **kwargs
):
2739 """Locale_GetLanguageName(int lang) -> String"""
2740 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2742 def Locale_FindLanguageInfo(*args
, **kwargs
):
2743 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2744 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2746 def Locale_AddLanguage(*args
, **kwargs
):
2747 """Locale_AddLanguage(LanguageInfo info)"""
2748 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2750 class PyLocale(Locale
):
2751 """Proxy of C++ PyLocale class"""
2752 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2753 __repr__
= _swig_repr
2754 def __init__(self
, *args
, **kwargs
):
2755 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale"""
2756 _gdi_
.PyLocale_swiginit(self
,_gdi_
.new_PyLocale(*args
, **kwargs
))
2757 self
._setCallbackInfo
(self
, PyLocale
)
2759 __swig_destroy__
= _gdi_
.delete_PyLocale
2760 __del__
= lambda self
: None;
2761 def _setCallbackInfo(*args
, **kwargs
):
2762 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2763 return _gdi_
.PyLocale__setCallbackInfo(*args
, **kwargs
)
2765 def GetSingularString(*args
, **kwargs
):
2766 """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar"""
2767 return _gdi_
.PyLocale_GetSingularString(*args
, **kwargs
)
2769 def GetPluralString(*args
, **kwargs
):
2771 GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n,
2772 wxChar szDomain=None) -> wxChar
2774 return _gdi_
.PyLocale_GetPluralString(*args
, **kwargs
)
2776 _gdi_
.PyLocale_swigregister(PyLocale
)
2779 def GetLocale(*args
):
2780 """GetLocale() -> Locale"""
2781 return _gdi_
.GetLocale(*args
)
2782 #---------------------------------------------------------------------------
2784 CONVERT_STRICT
= _gdi_
.CONVERT_STRICT
2785 CONVERT_SUBSTITUTE
= _gdi_
.CONVERT_SUBSTITUTE
2786 PLATFORM_CURRENT
= _gdi_
.PLATFORM_CURRENT
2787 PLATFORM_UNIX
= _gdi_
.PLATFORM_UNIX
2788 PLATFORM_WINDOWS
= _gdi_
.PLATFORM_WINDOWS
2789 PLATFORM_OS2
= _gdi_
.PLATFORM_OS2
2790 PLATFORM_MAC
= _gdi_
.PLATFORM_MAC
2791 class EncodingConverter(_core
.Object
):
2792 """Proxy of C++ EncodingConverter class"""
2793 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2794 __repr__
= _swig_repr
2795 def __init__(self
, *args
, **kwargs
):
2796 """__init__(self) -> EncodingConverter"""
2797 _gdi_
.EncodingConverter_swiginit(self
,_gdi_
.new_EncodingConverter(*args
, **kwargs
))
2798 __swig_destroy__
= _gdi_
.delete_EncodingConverter
2799 __del__
= lambda self
: None;
2800 def Init(*args
, **kwargs
):
2801 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2802 return _gdi_
.EncodingConverter_Init(*args
, **kwargs
)
2804 def Convert(*args
, **kwargs
):
2805 """Convert(self, String input) -> String"""
2806 return _gdi_
.EncodingConverter_Convert(*args
, **kwargs
)
2808 def GetPlatformEquivalents(*args
, **kwargs
):
2809 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2810 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2812 GetPlatformEquivalents
= staticmethod(GetPlatformEquivalents
)
2813 def GetAllEquivalents(*args
, **kwargs
):
2814 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2815 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2817 GetAllEquivalents
= staticmethod(GetAllEquivalents
)
2818 def CanConvert(*args
, **kwargs
):
2819 """CanConvert(int encIn, int encOut) -> bool"""
2820 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2822 CanConvert
= staticmethod(CanConvert
)
2823 def __nonzero__(self
): return self
.IsOk()
2824 _gdi_
.EncodingConverter_swigregister(EncodingConverter
)
2826 def GetTranslation(*args
):
2828 GetTranslation(String str) -> String
2829 GetTranslation(String str, String domain) -> String
2830 GetTranslation(String str, String strPlural, size_t n) -> String
2831 GetTranslation(String str, String strPlural, size_t n, String domain) -> String
2833 return _gdi_
.GetTranslation(*args
)
2835 def EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
):
2836 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2837 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2839 def EncodingConverter_GetAllEquivalents(*args
, **kwargs
):
2840 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2841 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2843 def EncodingConverter_CanConvert(*args
, **kwargs
):
2844 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2845 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2847 #----------------------------------------------------------------------------
2848 # On MSW add the directory where the wxWidgets catalogs were installed
2849 # to the default catalog path.
2850 if wx
.Platform
== "__WXMSW__":
2852 _localedir
= os
.path
.join(os
.path
.split(__file__
)[0], "i18n")
2853 Locale
.AddCatalogLookupPathPrefix(_localedir
)
2856 #----------------------------------------------------------------------------
2858 #---------------------------------------------------------------------------
2860 class DC(_core
.Object
):
2862 A wx.DC is a device context onto which graphics and text can be
2863 drawn. It is intended to represent a number of output devices in a
2864 generic way, so a window can have a device context associated with it,
2865 and a printer also has a device context. In this way, the same piece
2866 of code may write to a number of different devices, if the device
2867 context is used as a parameter.
2869 Derived types of wxDC have documentation for specific features only,
2870 so refer to this section for most device context information.
2872 The wx.DC class is abstract and can not be instantiated, you must use
2873 one of the derived classes instead. Which one will depend on the
2874 situation in which it is used.
2876 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2877 def __init__(self
): raise AttributeError, "No constructor defined"
2878 __repr__
= _swig_repr
2879 __swig_destroy__
= _gdi_
.delete_DC
2880 __del__
= lambda self
: None;
2881 # These have been deprecated in wxWidgets. Since they never
2882 # really did anything to begin with, just make them be NOPs.
2883 def BeginDrawing(self
): pass
2884 def EndDrawing(self
): pass
2886 def FloodFill(*args
, **kwargs
):
2888 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2890 Flood fills the device context starting from the given point, using
2891 the current brush colour, and using a style:
2893 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2894 the given colour is encountered.
2896 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2899 Returns False if the operation failed.
2901 Note: The present implementation for non-Windows platforms may fail to
2902 find colour borders if the pixels do not match the colour
2903 exactly. However the function will still return true.
2905 return _gdi_
.DC_FloodFill(*args
, **kwargs
)
2907 def FloodFillPoint(*args
, **kwargs
):
2909 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2911 Flood fills the device context starting from the given point, using
2912 the current brush colour, and using a style:
2914 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2915 the given colour is encountered.
2917 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2920 Returns False if the operation failed.
2922 Note: The present implementation for non-Windows platforms may fail to
2923 find colour borders if the pixels do not match the colour
2924 exactly. However the function will still return true.
2926 return _gdi_
.DC_FloodFillPoint(*args
, **kwargs
)
2928 def GradientFillConcentric(*args
, **kwargs
):
2930 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2933 Fill the area specified by rect with a radial gradient, starting from
2934 initialColour in the center of the circle and fading to destColour on
2935 the outside of the circle. The circleCenter argument is the relative
2936 coordinants of the center of the circle in the specified rect.
2938 Note: Currently this function is very slow, don't use it for real-time
2941 return _gdi_
.DC_GradientFillConcentric(*args
, **kwargs
)
2943 def GradientFillLinear(*args
, **kwargs
):
2945 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2946 int nDirection=EAST)
2948 Fill the area specified by rect with a linear gradient, starting from
2949 initialColour and eventually fading to destColour. The nDirection
2950 parameter specifies the direction of the colour change, default is to
2951 use initialColour on the left part of the rectangle and destColour on
2954 return _gdi_
.DC_GradientFillLinear(*args
, **kwargs
)
2956 def GetPixel(*args
, **kwargs
):
2958 GetPixel(self, int x, int y) -> Colour
2960 Gets the colour at the specified location on the DC.
2962 return _gdi_
.DC_GetPixel(*args
, **kwargs
)
2964 def GetPixelPoint(*args
, **kwargs
):
2965 """GetPixelPoint(self, Point pt) -> Colour"""
2966 return _gdi_
.DC_GetPixelPoint(*args
, **kwargs
)
2968 def DrawLine(*args
, **kwargs
):
2970 DrawLine(self, int x1, int y1, int x2, int y2)
2972 Draws a line from the first point to the second. The current pen is
2973 used for drawing the line. Note that the second point is *not* part of
2974 the line and is not drawn by this function (this is consistent with
2975 the behaviour of many other toolkits).
2977 return _gdi_
.DC_DrawLine(*args
, **kwargs
)
2979 def DrawLinePoint(*args
, **kwargs
):
2981 DrawLinePoint(self, Point pt1, Point pt2)
2983 Draws a line from the first point to the second. The current pen is
2984 used for drawing the line. Note that the second point is *not* part of
2985 the line and is not drawn by this function (this is consistent with
2986 the behaviour of many other toolkits).
2988 return _gdi_
.DC_DrawLinePoint(*args
, **kwargs
)
2990 def CrossHair(*args
, **kwargs
):
2992 CrossHair(self, int x, int y)
2994 Displays a cross hair using the current pen. This is a vertical and
2995 horizontal line the height and width of the window, centred on the
2998 return _gdi_
.DC_CrossHair(*args
, **kwargs
)
3000 def CrossHairPoint(*args
, **kwargs
):
3002 CrossHairPoint(self, Point pt)
3004 Displays a cross hair using the current pen. This is a vertical and
3005 horizontal line the height and width of the window, centred on the
3008 return _gdi_
.DC_CrossHairPoint(*args
, **kwargs
)
3010 def DrawArc(*args
, **kwargs
):
3012 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
3014 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3015 the first point to the second. The current pen is used for the outline
3016 and the current brush for filling the shape.
3018 The arc is drawn in an anticlockwise direction from the start point to
3021 return _gdi_
.DC_DrawArc(*args
, **kwargs
)
3023 def DrawArcPoint(*args
, **kwargs
):
3025 DrawArcPoint(self, Point pt1, Point pt2, Point center)
3027 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3028 the first point to the second. The current pen is used for the outline
3029 and the current brush for filling the shape.
3031 The arc is drawn in an anticlockwise direction from the start point to
3034 return _gdi_
.DC_DrawArcPoint(*args
, **kwargs
)
3036 def DrawCheckMark(*args
, **kwargs
):
3038 DrawCheckMark(self, int x, int y, int width, int height)
3040 Draws a check mark inside the given rectangle.
3042 return _gdi_
.DC_DrawCheckMark(*args
, **kwargs
)
3044 def DrawCheckMarkRect(*args
, **kwargs
):
3046 DrawCheckMarkRect(self, Rect rect)
3048 Draws a check mark inside the given rectangle.
3050 return _gdi_
.DC_DrawCheckMarkRect(*args
, **kwargs
)
3052 def DrawEllipticArc(*args
, **kwargs
):
3054 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
3056 Draws an arc of an ellipse, with the given rectangle defining the
3057 bounds of the ellipse. The current pen is used for drawing the arc and
3058 the current brush is used for drawing the pie.
3060 The *start* and *end* parameters specify the start and end of the arc
3061 relative to the three-o'clock position from the center of the
3062 rectangle. Angles are specified in degrees (360 is a complete
3063 circle). Positive values mean counter-clockwise motion. If start is
3064 equal to end, a complete ellipse will be drawn.
3066 return _gdi_
.DC_DrawEllipticArc(*args
, **kwargs
)
3068 def DrawEllipticArcPointSize(*args
, **kwargs
):
3070 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
3072 Draws an arc of an ellipse, with the given rectangle defining the
3073 bounds of the ellipse. The current pen is used for drawing the arc and
3074 the current brush is used for drawing the pie.
3076 The *start* and *end* parameters specify the start and end of the arc
3077 relative to the three-o'clock position from the center of the
3078 rectangle. Angles are specified in degrees (360 is a complete
3079 circle). Positive values mean counter-clockwise motion. If start is
3080 equal to end, a complete ellipse will be drawn.
3082 return _gdi_
.DC_DrawEllipticArcPointSize(*args
, **kwargs
)
3084 def DrawPoint(*args
, **kwargs
):
3086 DrawPoint(self, int x, int y)
3088 Draws a point using the current pen.
3090 return _gdi_
.DC_DrawPoint(*args
, **kwargs
)
3092 def DrawPointPoint(*args
, **kwargs
):
3094 DrawPointPoint(self, Point pt)
3096 Draws a point using the current pen.
3098 return _gdi_
.DC_DrawPointPoint(*args
, **kwargs
)
3100 def DrawRectangle(*args
, **kwargs
):
3102 DrawRectangle(self, int x, int y, int width, int height)
3104 Draws a rectangle with the given top left corner, and with the given
3105 size. The current pen is used for the outline and the current brush
3106 for filling the shape.
3108 return _gdi_
.DC_DrawRectangle(*args
, **kwargs
)
3110 def DrawRectangleRect(*args
, **kwargs
):
3112 DrawRectangleRect(self, Rect rect)
3114 Draws a rectangle with the given top left corner, and with the given
3115 size. The current pen is used for the outline and the current brush
3116 for filling the shape.
3118 return _gdi_
.DC_DrawRectangleRect(*args
, **kwargs
)
3120 def DrawRectanglePointSize(*args
, **kwargs
):
3122 DrawRectanglePointSize(self, Point pt, Size sz)
3124 Draws a rectangle with the given top left corner, and with the given
3125 size. The current pen is used for the outline and the current brush
3126 for filling the shape.
3128 return _gdi_
.DC_DrawRectanglePointSize(*args
, **kwargs
)
3130 def DrawRoundedRectangle(*args
, **kwargs
):
3132 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
3134 Draws a rectangle with the given top left corner, and with the given
3135 size. The corners are quarter-circles using the given radius. The
3136 current pen is used for the outline and the current brush for filling
3139 If radius is positive, the value is assumed to be the radius of the
3140 rounded corner. If radius is negative, the absolute value is assumed
3141 to be the proportion of the smallest dimension of the rectangle. This
3142 means that the corner can be a sensible size relative to the size of
3143 the rectangle, and also avoids the strange effects X produces when the
3144 corners are too big for the rectangle.
3146 return _gdi_
.DC_DrawRoundedRectangle(*args
, **kwargs
)
3148 def DrawRoundedRectangleRect(*args
, **kwargs
):
3150 DrawRoundedRectangleRect(self, Rect r, double radius)
3152 Draws a rectangle with the given top left corner, and with the given
3153 size. The corners are quarter-circles using the given radius. The
3154 current pen is used for the outline and the current brush for filling
3157 If radius is positive, the value is assumed to be the radius of the
3158 rounded corner. If radius is negative, the absolute value is assumed
3159 to be the proportion of the smallest dimension of the rectangle. This
3160 means that the corner can be a sensible size relative to the size of
3161 the rectangle, and also avoids the strange effects X produces when the
3162 corners are too big for the rectangle.
3164 return _gdi_
.DC_DrawRoundedRectangleRect(*args
, **kwargs
)
3166 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
3168 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
3170 Draws a rectangle with the given top left corner, and with the given
3171 size. The corners are quarter-circles using the given radius. The
3172 current pen is used for the outline and the current brush for filling
3175 If radius is positive, the value is assumed to be the radius of the
3176 rounded corner. If radius is negative, the absolute value is assumed
3177 to be the proportion of the smallest dimension of the rectangle. This
3178 means that the corner can be a sensible size relative to the size of
3179 the rectangle, and also avoids the strange effects X produces when the
3180 corners are too big for the rectangle.
3182 return _gdi_
.DC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
3184 def DrawCircle(*args
, **kwargs
):
3186 DrawCircle(self, int x, int y, int radius)
3188 Draws a circle with the given center point and radius. The current
3189 pen is used for the outline and the current brush for filling the
3192 return _gdi_
.DC_DrawCircle(*args
, **kwargs
)
3194 def DrawCirclePoint(*args
, **kwargs
):
3196 DrawCirclePoint(self, Point pt, int radius)
3198 Draws a circle with the given center point and radius. The current
3199 pen is used for the outline and the current brush for filling the
3202 return _gdi_
.DC_DrawCirclePoint(*args
, **kwargs
)
3204 def DrawEllipse(*args
, **kwargs
):
3206 DrawEllipse(self, int x, int y, int width, int height)
3208 Draws an ellipse contained in the specified rectangle. The current pen
3209 is used for the outline and the current brush for filling the shape.
3211 return _gdi_
.DC_DrawEllipse(*args
, **kwargs
)
3213 def DrawEllipseRect(*args
, **kwargs
):
3215 DrawEllipseRect(self, Rect rect)
3217 Draws an ellipse contained in the specified rectangle. The current pen
3218 is used for the outline and the current brush for filling the shape.
3220 return _gdi_
.DC_DrawEllipseRect(*args
, **kwargs
)
3222 def DrawEllipsePointSize(*args
, **kwargs
):
3224 DrawEllipsePointSize(self, Point pt, Size sz)
3226 Draws an ellipse contained in the specified rectangle. The current pen
3227 is used for the outline and the current brush for filling the shape.
3229 return _gdi_
.DC_DrawEllipsePointSize(*args
, **kwargs
)
3231 def DrawIcon(*args
, **kwargs
):
3233 DrawIcon(self, Icon icon, int x, int y)
3235 Draw an icon on the display (does nothing if the device context is
3236 PostScript). This can be the simplest way of drawing bitmaps on a
3239 return _gdi_
.DC_DrawIcon(*args
, **kwargs
)
3241 def DrawIconPoint(*args
, **kwargs
):
3243 DrawIconPoint(self, Icon icon, Point pt)
3245 Draw an icon on the display (does nothing if the device context is
3246 PostScript). This can be the simplest way of drawing bitmaps on a
3249 return _gdi_
.DC_DrawIconPoint(*args
, **kwargs
)
3251 def DrawBitmap(*args
, **kwargs
):
3253 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
3255 Draw a bitmap on the device context at the specified point. If
3256 *transparent* is true and the bitmap has a transparency mask, (or
3257 alpha channel on the platforms that support it) then the bitmap will
3258 be drawn transparently.
3260 return _gdi_
.DC_DrawBitmap(*args
, **kwargs
)
3262 def DrawBitmapPoint(*args
, **kwargs
):
3264 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3266 Draw a bitmap on the device context at the specified point. If
3267 *transparent* is true and the bitmap has a transparency mask, (or
3268 alpha channel on the platforms that support it) then the bitmap will
3269 be drawn transparently.
3271 return _gdi_
.DC_DrawBitmapPoint(*args
, **kwargs
)
3273 def DrawText(*args
, **kwargs
):
3275 DrawText(self, String text, int x, int y)
3277 Draws a text string at the specified point, using the current text
3278 font, and the current text foreground and background colours.
3280 The coordinates refer to the top-left corner of the rectangle bounding
3281 the string. See `GetTextExtent` for how to get the dimensions of a
3282 text string, which can be used to position the text more precisely.
3284 **NOTE**: under wxGTK the current logical function is used by this
3285 function but it is ignored by wxMSW. Thus, you should avoid using
3286 logical functions with this function in portable programs.
3288 return _gdi_
.DC_DrawText(*args
, **kwargs
)
3290 def DrawTextPoint(*args
, **kwargs
):
3292 DrawTextPoint(self, String text, Point pt)
3294 Draws a text string at the specified point, using the current text
3295 font, and the current text foreground and background colours.
3297 The coordinates refer to the top-left corner of the rectangle bounding
3298 the string. See `GetTextExtent` for how to get the dimensions of a
3299 text string, which can be used to position the text more precisely.
3301 **NOTE**: under wxGTK the current logical function is used by this
3302 function but it is ignored by wxMSW. Thus, you should avoid using
3303 logical functions with this function in portable programs.
3305 return _gdi_
.DC_DrawTextPoint(*args
, **kwargs
)
3307 def DrawRotatedText(*args
, **kwargs
):
3309 DrawRotatedText(self, String text, int x, int y, double angle)
3311 Draws the text rotated by *angle* degrees, if supported by the platform.
3313 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3314 function. In particular, a font different from ``wx.NORMAL_FONT``
3315 should be used as the it is not normally a TrueType
3316 font. ``wx.SWISS_FONT`` is an example of a font which is.
3318 return _gdi_
.DC_DrawRotatedText(*args
, **kwargs
)
3320 def DrawRotatedTextPoint(*args
, **kwargs
):
3322 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3324 Draws the text rotated by *angle* degrees, if supported by the platform.
3326 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3327 function. In particular, a font different from ``wx.NORMAL_FONT``
3328 should be used as the it is not normally a TrueType
3329 font. ``wx.SWISS_FONT`` is an example of a font which is.
3331 return _gdi_
.DC_DrawRotatedTextPoint(*args
, **kwargs
)
3333 def Blit(*args
, **kwargs
):
3335 Blit(self, int xdest, int ydest, int width, int height, DC source,
3336 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3337 int xsrcMask=-1, int ysrcMask=-1) -> bool
3339 Copy from a source DC to this DC. Parameters specify the destination
3340 coordinates, size of area to copy, source DC, source coordinates,
3341 logical function, whether to use a bitmap mask, and mask source
3344 return _gdi_
.DC_Blit(*args
, **kwargs
)
3346 def BlitPointSize(*args
, **kwargs
):
3348 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
3349 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
3351 Copy from a source DC to this DC. Parameters specify the destination
3352 coordinates, size of area to copy, source DC, source coordinates,
3353 logical function, whether to use a bitmap mask, and mask source
3356 return _gdi_
.DC_BlitPointSize(*args
, **kwargs
)
3358 def SetClippingRegion(*args
, **kwargs
):
3360 SetClippingRegion(self, int x, int y, int width, int height)
3362 Sets the clipping region for this device context to the intersection
3363 of the given region described by the parameters of this method and the
3364 previously set clipping region. You should call `DestroyClippingRegion`
3365 if you want to set the clipping region exactly to the region
3368 The clipping region is an area to which drawing is
3369 restricted. Possible uses for the clipping region are for clipping
3370 text or for speeding up window redraws when only a known area of the
3373 return _gdi_
.DC_SetClippingRegion(*args
, **kwargs
)
3375 def SetClippingRegionPointSize(*args
, **kwargs
):
3377 SetClippingRegionPointSize(self, Point pt, Size sz)
3379 Sets the clipping region for this device context to the intersection
3380 of the given region described by the parameters of this method and the
3381 previously set clipping region. You should call `DestroyClippingRegion`
3382 if you want to set the clipping region exactly to the region
3385 The clipping region is an area to which drawing is
3386 restricted. Possible uses for the clipping region are for clipping
3387 text or for speeding up window redraws when only a known area of the
3390 return _gdi_
.DC_SetClippingRegionPointSize(*args
, **kwargs
)
3392 def SetClippingRegionAsRegion(*args
, **kwargs
):
3394 SetClippingRegionAsRegion(self, Region region)
3396 Sets the clipping region for this device context to the intersection
3397 of the given region described by the parameters of this method and the
3398 previously set clipping region. You should call `DestroyClippingRegion`
3399 if you want to set the clipping region exactly to the region
3402 The clipping region is an area to which drawing is
3403 restricted. Possible uses for the clipping region are for clipping
3404 text or for speeding up window redraws when only a known area of the
3407 return _gdi_
.DC_SetClippingRegionAsRegion(*args
, **kwargs
)
3409 def SetClippingRect(*args
, **kwargs
):
3411 SetClippingRect(self, Rect rect)
3413 Sets the clipping region for this device context to the intersection
3414 of the given region described by the parameters of this method and the
3415 previously set clipping region. You should call `DestroyClippingRegion`
3416 if you want to set the clipping region exactly to the region
3419 The clipping region is an area to which drawing is
3420 restricted. Possible uses for the clipping region are for clipping
3421 text or for speeding up window redraws when only a known area of the
3424 return _gdi_
.DC_SetClippingRect(*args
, **kwargs
)
3426 def DrawLines(*args
, **kwargs
):
3428 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3430 Draws lines using a sequence of `wx.Point` objects, adding the
3431 optional offset coordinate. The current pen is used for drawing the
3434 return _gdi_
.DC_DrawLines(*args
, **kwargs
)
3436 def DrawPolygon(*args
, **kwargs
):
3438 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
3439 int fillStyle=ODDEVEN_RULE)
3441 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3442 the optional offset coordinate. The last argument specifies the fill
3443 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3445 The current pen is used for drawing the outline, and the current brush
3446 for filling the shape. Using a transparent brush suppresses
3447 filling. Note that wxWidgets automatically closes the first and last
3450 return _gdi_
.DC_DrawPolygon(*args
, **kwargs
)
3452 def DrawLabel(*args
, **kwargs
):
3454 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3457 Draw *text* within the specified rectangle, abiding by the alignment
3458 flags. Will additionally emphasize the character at *indexAccel* if
3461 return _gdi_
.DC_DrawLabel(*args
, **kwargs
)
3463 def DrawImageLabel(*args
, **kwargs
):
3465 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3466 int indexAccel=-1) -> Rect
3468 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3469 drawing it) within the specified rectangle, abiding by the alignment
3470 flags. Will additionally emphasize the character at *indexAccel* if
3471 it is not -1. Returns the bounding rectangle.
3473 return _gdi_
.DC_DrawImageLabel(*args
, **kwargs
)
3475 def DrawSpline(*args
, **kwargs
):
3477 DrawSpline(self, List points)
3479 Draws a spline between all given control points, (a list of `wx.Point`
3480 objects) using the current pen. The spline is drawn using a series of
3481 lines, using an algorithm taken from the X drawing program 'XFIG'.
3483 return _gdi_
.DC_DrawSpline(*args
, **kwargs
)
3485 def Clear(*args
, **kwargs
):
3489 Clears the device context using the current background brush.
3491 return _gdi_
.DC_Clear(*args
, **kwargs
)
3493 def StartDoc(*args
, **kwargs
):
3495 StartDoc(self, String message) -> bool
3497 Starts a document (only relevant when outputting to a
3498 printer). *Message* is a message to show whilst printing.
3500 return _gdi_
.DC_StartDoc(*args
, **kwargs
)
3502 def EndDoc(*args
, **kwargs
):
3506 Ends a document (only relevant when outputting to a printer).
3508 return _gdi_
.DC_EndDoc(*args
, **kwargs
)
3510 def StartPage(*args
, **kwargs
):
3514 Starts a document page (only relevant when outputting to a printer).
3516 return _gdi_
.DC_StartPage(*args
, **kwargs
)
3518 def EndPage(*args
, **kwargs
):
3522 Ends a document page (only relevant when outputting to a printer).
3524 return _gdi_
.DC_EndPage(*args
, **kwargs
)
3526 def SetFont(*args
, **kwargs
):
3528 SetFont(self, Font font)
3530 Sets the current font for the DC. It must be a valid font, in
3531 particular you should not pass ``wx.NullFont`` to this method.
3533 return _gdi_
.DC_SetFont(*args
, **kwargs
)
3535 def SetPen(*args
, **kwargs
):
3537 SetPen(self, Pen pen)
3539 Sets the current pen for the DC.
3541 If the argument is ``wx.NullPen``, the current pen is selected out of the
3542 device context, and the original pen restored.
3544 return _gdi_
.DC_SetPen(*args
, **kwargs
)
3546 def SetBrush(*args
, **kwargs
):
3548 SetBrush(self, Brush brush)
3550 Sets the current brush for the DC.
3552 If the argument is ``wx.NullBrush``, the current brush is selected out
3553 of the device context, and the original brush restored, allowing the
3554 current brush to be destroyed safely.
3556 return _gdi_
.DC_SetBrush(*args
, **kwargs
)
3558 def SetBackground(*args
, **kwargs
):
3560 SetBackground(self, Brush brush)
3562 Sets the current background brush for the DC.
3564 return _gdi_
.DC_SetBackground(*args
, **kwargs
)
3566 def SetBackgroundMode(*args
, **kwargs
):
3568 SetBackgroundMode(self, int mode)
3570 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3571 determines whether text will be drawn with a background colour or
3574 return _gdi_
.DC_SetBackgroundMode(*args
, **kwargs
)
3576 def SetPalette(*args
, **kwargs
):
3578 SetPalette(self, Palette palette)
3580 If this is a window DC or memory DC, assigns the given palette to the
3581 window or bitmap associated with the DC. If the argument is
3582 ``wx.NullPalette``, the current palette is selected out of the device
3583 context, and the original palette restored.
3585 return _gdi_
.DC_SetPalette(*args
, **kwargs
)
3587 def DestroyClippingRegion(*args
, **kwargs
):
3589 DestroyClippingRegion(self)
3591 Destroys the current clipping region so that none of the DC is
3594 return _gdi_
.DC_DestroyClippingRegion(*args
, **kwargs
)
3596 def GetClippingBox(*args
, **kwargs
):
3598 GetClippingBox() -> (x, y, width, height)
3600 Gets the rectangle surrounding the current clipping region.
3602 return _gdi_
.DC_GetClippingBox(*args
, **kwargs
)
3604 def GetClippingRect(*args
, **kwargs
):
3606 GetClippingRect(self) -> Rect
3608 Gets the rectangle surrounding the current clipping region.
3610 return _gdi_
.DC_GetClippingRect(*args
, **kwargs
)
3612 def GetCharHeight(*args
, **kwargs
):
3614 GetCharHeight(self) -> int
3616 Gets the character height of the currently set font.
3618 return _gdi_
.DC_GetCharHeight(*args
, **kwargs
)
3620 def GetCharWidth(*args
, **kwargs
):
3622 GetCharWidth(self) -> int
3624 Gets the average character width of the currently set font.
3626 return _gdi_
.DC_GetCharWidth(*args
, **kwargs
)
3628 def GetTextExtent(*args
, **kwargs
):
3630 GetTextExtent(wxString string) -> (width, height)
3632 Get the width and height of the text using the current font. Only
3633 works for single line strings.
3635 return _gdi_
.DC_GetTextExtent(*args
, **kwargs
)
3637 def GetFullTextExtent(*args
, **kwargs
):
3639 GetFullTextExtent(wxString string, Font font=None) ->
3640 (width, height, descent, externalLeading)
3642 Get the width, height, decent and leading of the text using the
3643 current or specified font. Only works for single line strings.
3645 return _gdi_
.DC_GetFullTextExtent(*args
, **kwargs
)
3647 def GetMultiLineTextExtent(*args
, **kwargs
):
3649 GetMultiLineTextExtent(wxString string, Font font=None) ->
3650 (width, height, lineHeight)
3652 Get the width, height, decent and leading of the text using the
3653 current or specified font. Works for single as well as multi-line
3656 return _gdi_
.DC_GetMultiLineTextExtent(*args
, **kwargs
)
3658 def GetPartialTextExtents(*args
, **kwargs
):
3660 GetPartialTextExtents(self, text) -> [widths]
3662 Returns a list of integers such that each value is the distance in
3663 pixels from the begining of text to the coresponding character of
3664 *text*. The generic version simply builds a running total of the widths
3665 of each character using GetTextExtent, however if the various
3666 platforms have a native API function that is faster or more accurate
3667 than the generic implementation then it will be used instead.
3669 return _gdi_
.DC_GetPartialTextExtents(*args
, **kwargs
)
3671 def GetSize(*args
, **kwargs
):
3673 GetSize(self) -> Size
3675 This gets the horizontal and vertical resolution in device units. It
3676 can be used to scale graphics to fit the page. For example, if *maxX*
3677 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3678 used in your application, the following code will scale the graphic to
3679 fit on the printer page::
3682 scaleX = maxX*1.0 / w
3683 scaleY = maxY*1.0 / h
3684 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3687 return _gdi_
.DC_GetSize(*args
, **kwargs
)
3689 def GetSizeTuple(*args
, **kwargs
):
3691 GetSizeTuple() -> (width, height)
3693 This gets the horizontal and vertical resolution in device units. It
3694 can be used to scale graphics to fit the page. For example, if *maxX*
3695 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3696 used in your application, the following code will scale the graphic to
3697 fit on the printer page::
3700 scaleX = maxX*1.0 / w
3701 scaleY = maxY*1.0 / h
3702 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3705 return _gdi_
.DC_GetSizeTuple(*args
, **kwargs
)
3707 def GetSizeMM(*args
, **kwargs
):
3709 GetSizeMM(self) -> Size
3711 Get the DC size in milimeters.
3713 return _gdi_
.DC_GetSizeMM(*args
, **kwargs
)
3715 def GetSizeMMTuple(*args
, **kwargs
):
3717 GetSizeMMTuple() -> (width, height)
3719 Get the DC size in milimeters.
3721 return _gdi_
.DC_GetSizeMMTuple(*args
, **kwargs
)
3723 def DeviceToLogicalX(*args
, **kwargs
):
3725 DeviceToLogicalX(self, int x) -> int
3727 Convert device X coordinate to logical coordinate, using the current
3730 return _gdi_
.DC_DeviceToLogicalX(*args
, **kwargs
)
3732 def DeviceToLogicalY(*args
, **kwargs
):
3734 DeviceToLogicalY(self, int y) -> int
3736 Converts device Y coordinate to logical coordinate, using the current
3739 return _gdi_
.DC_DeviceToLogicalY(*args
, **kwargs
)
3741 def DeviceToLogicalXRel(*args
, **kwargs
):
3743 DeviceToLogicalXRel(self, int x) -> int
3745 Convert device X coordinate to relative logical coordinate, using the
3746 current mapping mode but ignoring the x axis orientation. Use this
3747 function for converting a width, for example.
3749 return _gdi_
.DC_DeviceToLogicalXRel(*args
, **kwargs
)
3751 def DeviceToLogicalYRel(*args
, **kwargs
):
3753 DeviceToLogicalYRel(self, int y) -> int
3755 Convert device Y coordinate to relative logical coordinate, using the
3756 current mapping mode but ignoring the y axis orientation. Use this
3757 function for converting a height, for example.
3759 return _gdi_
.DC_DeviceToLogicalYRel(*args
, **kwargs
)
3761 def LogicalToDeviceX(*args
, **kwargs
):
3763 LogicalToDeviceX(self, int x) -> int
3765 Converts logical X coordinate to device coordinate, using the current
3768 return _gdi_
.DC_LogicalToDeviceX(*args
, **kwargs
)
3770 def LogicalToDeviceY(*args
, **kwargs
):
3772 LogicalToDeviceY(self, int y) -> int
3774 Converts logical Y coordinate to device coordinate, using the current
3777 return _gdi_
.DC_LogicalToDeviceY(*args
, **kwargs
)
3779 def LogicalToDeviceXRel(*args
, **kwargs
):
3781 LogicalToDeviceXRel(self, int x) -> int
3783 Converts logical X coordinate to relative device coordinate, using the
3784 current mapping mode but ignoring the x axis orientation. Use this for
3785 converting a width, for example.
3787 return _gdi_
.DC_LogicalToDeviceXRel(*args
, **kwargs
)
3789 def LogicalToDeviceYRel(*args
, **kwargs
):
3791 LogicalToDeviceYRel(self, int y) -> int
3793 Converts logical Y coordinate to relative device coordinate, using the
3794 current mapping mode but ignoring the y axis orientation. Use this for
3795 converting a height, for example.
3797 return _gdi_
.DC_LogicalToDeviceYRel(*args
, **kwargs
)
3799 def CanDrawBitmap(*args
, **kwargs
):
3800 """CanDrawBitmap(self) -> bool"""
3801 return _gdi_
.DC_CanDrawBitmap(*args
, **kwargs
)
3803 def CanGetTextExtent(*args
, **kwargs
):
3804 """CanGetTextExtent(self) -> bool"""
3805 return _gdi_
.DC_CanGetTextExtent(*args
, **kwargs
)
3807 def GetDepth(*args
, **kwargs
):
3809 GetDepth(self) -> int
3811 Returns the colour depth of the DC.
3813 return _gdi_
.DC_GetDepth(*args
, **kwargs
)
3815 def GetPPI(*args
, **kwargs
):
3817 GetPPI(self) -> Size
3819 Resolution in pixels per inch
3821 return _gdi_
.DC_GetPPI(*args
, **kwargs
)
3823 def Ok(*args
, **kwargs
):
3827 Returns true if the DC is ok to use.
3829 return _gdi_
.DC_Ok(*args
, **kwargs
)
3831 def GetBackgroundMode(*args
, **kwargs
):
3833 GetBackgroundMode(self) -> int
3835 Returns the current background mode, either ``wx.SOLID`` or
3838 return _gdi_
.DC_GetBackgroundMode(*args
, **kwargs
)
3840 def GetBackground(*args
, **kwargs
):
3842 GetBackground(self) -> Brush
3844 Gets the brush used for painting the background.
3846 return _gdi_
.DC_GetBackground(*args
, **kwargs
)
3848 def GetBrush(*args
, **kwargs
):
3850 GetBrush(self) -> Brush
3852 Gets the current brush
3854 return _gdi_
.DC_GetBrush(*args
, **kwargs
)
3856 def GetFont(*args
, **kwargs
):
3858 GetFont(self) -> Font
3860 Gets the current font
3862 return _gdi_
.DC_GetFont(*args
, **kwargs
)
3864 def GetPen(*args
, **kwargs
):
3868 Gets the current pen
3870 return _gdi_
.DC_GetPen(*args
, **kwargs
)
3872 def GetTextBackground(*args
, **kwargs
):
3874 GetTextBackground(self) -> Colour
3876 Gets the current text background colour
3878 return _gdi_
.DC_GetTextBackground(*args
, **kwargs
)
3880 def GetTextForeground(*args
, **kwargs
):
3882 GetTextForeground(self) -> Colour
3884 Gets the current text foreground colour
3886 return _gdi_
.DC_GetTextForeground(*args
, **kwargs
)
3888 def SetTextForeground(*args
, **kwargs
):
3890 SetTextForeground(self, Colour colour)
3892 Sets the current text foreground colour for the DC.
3894 return _gdi_
.DC_SetTextForeground(*args
, **kwargs
)
3896 def SetTextBackground(*args
, **kwargs
):
3898 SetTextBackground(self, Colour colour)
3900 Sets the current text background colour for the DC.
3902 return _gdi_
.DC_SetTextBackground(*args
, **kwargs
)
3904 def GetMapMode(*args
, **kwargs
):
3906 GetMapMode(self) -> int
3908 Gets the current *mapping mode* for the device context
3910 return _gdi_
.DC_GetMapMode(*args
, **kwargs
)
3912 def SetMapMode(*args
, **kwargs
):
3914 SetMapMode(self, int mode)
3916 The *mapping mode* of the device context defines the unit of
3917 measurement used to convert logical units to device units. The
3918 mapping mode can be one of the following:
3920 ================ =============================================
3921 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3923 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3924 wx.MM_METRIC Each logical unit is 1 mm.
3925 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3926 wx.MM_TEXT Each logical unit is 1 pixel.
3927 ================ =============================================
3930 return _gdi_
.DC_SetMapMode(*args
, **kwargs
)
3932 def GetUserScale(*args
, **kwargs
):
3934 GetUserScale(self) -> (xScale, yScale)
3936 Gets the current user scale factor (set by `SetUserScale`).
3938 return _gdi_
.DC_GetUserScale(*args
, **kwargs
)
3940 def SetUserScale(*args
, **kwargs
):
3942 SetUserScale(self, double x, double y)
3944 Sets the user scaling factor, useful for applications which require
3947 return _gdi_
.DC_SetUserScale(*args
, **kwargs
)
3949 def GetLogicalScale(*args
, **kwargs
):
3950 """GetLogicalScale() -> (xScale, yScale)"""
3951 return _gdi_
.DC_GetLogicalScale(*args
, **kwargs
)
3953 def SetLogicalScale(*args
, **kwargs
):
3954 """SetLogicalScale(self, double x, double y)"""
3955 return _gdi_
.DC_SetLogicalScale(*args
, **kwargs
)
3957 def GetLogicalOrigin(*args
, **kwargs
):
3958 """GetLogicalOrigin(self) -> Point"""
3959 return _gdi_
.DC_GetLogicalOrigin(*args
, **kwargs
)
3961 def GetLogicalOriginTuple(*args
, **kwargs
):
3962 """GetLogicalOriginTuple() -> (x,y)"""
3963 return _gdi_
.DC_GetLogicalOriginTuple(*args
, **kwargs
)
3965 def SetLogicalOrigin(*args
, **kwargs
):
3966 """SetLogicalOrigin(self, int x, int y)"""
3967 return _gdi_
.DC_SetLogicalOrigin(*args
, **kwargs
)
3969 def SetLogicalOriginPoint(*args
, **kwargs
):
3970 """SetLogicalOriginPoint(self, Point point)"""
3971 return _gdi_
.DC_SetLogicalOriginPoint(*args
, **kwargs
)
3973 def GetDeviceOrigin(*args
, **kwargs
):
3974 """GetDeviceOrigin(self) -> Point"""
3975 return _gdi_
.DC_GetDeviceOrigin(*args
, **kwargs
)
3977 def GetDeviceOriginTuple(*args
, **kwargs
):
3978 """GetDeviceOriginTuple() -> (x,y)"""
3979 return _gdi_
.DC_GetDeviceOriginTuple(*args
, **kwargs
)
3981 def SetDeviceOrigin(*args
, **kwargs
):
3982 """SetDeviceOrigin(self, int x, int y)"""
3983 return _gdi_
.DC_SetDeviceOrigin(*args
, **kwargs
)
3985 def SetDeviceOriginPoint(*args
, **kwargs
):
3986 """SetDeviceOriginPoint(self, Point point)"""
3987 return _gdi_
.DC_SetDeviceOriginPoint(*args
, **kwargs
)
3989 def SetAxisOrientation(*args
, **kwargs
):
3991 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
3993 Sets the x and y axis orientation (i.e., the direction from lowest to
3994 highest values on the axis). The default orientation is the natural
3995 orientation, e.g. x axis from left to right and y axis from bottom up.
3997 return _gdi_
.DC_SetAxisOrientation(*args
, **kwargs
)
3999 def GetLogicalFunction(*args
, **kwargs
):
4001 GetLogicalFunction(self) -> int
4003 Gets the current logical function (set by `SetLogicalFunction`).
4005 return _gdi_
.DC_GetLogicalFunction(*args
, **kwargs
)
4007 def SetLogicalFunction(*args
, **kwargs
):
4009 SetLogicalFunction(self, int function)
4011 Sets the current logical function for the device context. This
4012 determines how a source pixel (from a pen or brush colour, or source
4013 device context if using `Blit`) combines with a destination pixel in
4014 the current device context.
4016 The possible values and their meaning in terms of source and
4017 destination pixel values are as follows:
4019 ================ ==========================
4021 wx.AND_INVERT (NOT src) AND dst
4022 wx.AND_REVERSE src AND (NOT dst)
4025 wx.EQUIV (NOT src) XOR dst
4027 wx.NAND (NOT src) OR (NOT dst)
4028 wx.NOR (NOT src) AND (NOT dst)
4031 wx.OR_INVERT (NOT src) OR dst
4032 wx.OR_REVERSE src OR (NOT dst)
4034 wx.SRC_INVERT NOT src
4036 ================ ==========================
4038 The default is wx.COPY, which simply draws with the current
4039 colour. The others combine the current colour and the background using
4040 a logical operation. wx.INVERT is commonly used for drawing rubber
4041 bands or moving outlines, since drawing twice reverts to the original
4045 return _gdi_
.DC_SetLogicalFunction(*args
, **kwargs
)
4047 def ComputeScaleAndOrigin(*args
, **kwargs
):
4049 ComputeScaleAndOrigin(self)
4051 Performs all necessary computations for given platform and context
4052 type after each change of scale and origin parameters. Usually called
4053 automatically internally after such changes.
4056 return _gdi_
.DC_ComputeScaleAndOrigin(*args
, **kwargs
)
4058 def SetOptimization(self
, optimize
):
4060 def GetOptimization(self
):
4063 SetOptimization
= wx
._deprecated
(SetOptimization
)
4064 GetOptimization
= wx
._deprecated
(GetOptimization
)
4066 def CalcBoundingBox(*args
, **kwargs
):
4068 CalcBoundingBox(self, int x, int y)
4070 Adds the specified point to the bounding box which can be retrieved
4071 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4073 return _gdi_
.DC_CalcBoundingBox(*args
, **kwargs
)
4075 def CalcBoundingBoxPoint(*args
, **kwargs
):
4077 CalcBoundingBoxPoint(self, Point point)
4079 Adds the specified point to the bounding box which can be retrieved
4080 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4082 return _gdi_
.DC_CalcBoundingBoxPoint(*args
, **kwargs
)
4084 def ResetBoundingBox(*args
, **kwargs
):
4086 ResetBoundingBox(self)
4088 Resets the bounding box: after a call to this function, the bounding
4089 box doesn't contain anything.
4091 return _gdi_
.DC_ResetBoundingBox(*args
, **kwargs
)
4093 def MinX(*args
, **kwargs
):
4097 Gets the minimum horizontal extent used in drawing commands so far.
4099 return _gdi_
.DC_MinX(*args
, **kwargs
)
4101 def MaxX(*args
, **kwargs
):
4105 Gets the maximum horizontal extent used in drawing commands so far.
4107 return _gdi_
.DC_MaxX(*args
, **kwargs
)
4109 def MinY(*args
, **kwargs
):
4113 Gets the minimum vertical extent used in drawing commands so far.
4115 return _gdi_
.DC_MinY(*args
, **kwargs
)
4117 def MaxY(*args
, **kwargs
):
4121 Gets the maximum vertical extent used in drawing commands so far.
4123 return _gdi_
.DC_MaxY(*args
, **kwargs
)
4125 def GetBoundingBox(*args
, **kwargs
):
4127 GetBoundingBox() -> (x1,y1, x2,y2)
4129 Returns the min and max points used in drawing commands so far.
4131 return _gdi_
.DC_GetBoundingBox(*args
, **kwargs
)
4133 def __nonzero__(self
): return self
.Ok()
4134 def _DrawPointList(*args
, **kwargs
):
4135 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4136 return _gdi_
.DC__DrawPointList(*args
, **kwargs
)
4138 def _DrawLineList(*args
, **kwargs
):
4139 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4140 return _gdi_
.DC__DrawLineList(*args
, **kwargs
)
4142 def _DrawRectangleList(*args
, **kwargs
):
4143 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4144 return _gdi_
.DC__DrawRectangleList(*args
, **kwargs
)
4146 def _DrawEllipseList(*args
, **kwargs
):
4147 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4148 return _gdi_
.DC__DrawEllipseList(*args
, **kwargs
)
4150 def _DrawPolygonList(*args
, **kwargs
):
4151 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4152 return _gdi_
.DC__DrawPolygonList(*args
, **kwargs
)
4154 def _DrawTextList(*args
, **kwargs
):
4156 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
4157 PyObject backgroundList) -> PyObject
4159 return _gdi_
.DC__DrawTextList(*args
, **kwargs
)
4161 def DrawPointList(self
, points
, pens
=None):
4163 Draw a list of points as quickly as possible.
4165 :param points: A sequence of 2-element sequences representing
4166 each point to draw, (x,y).
4167 :param pens: If None, then the current pen is used. If a
4168 single pen then it will be used for all points. If
4169 a list of pens then there should be one for each point
4174 elif isinstance(pens
, wx
.Pen
):
4176 elif len(pens
) != len(points
):
4177 raise ValueError('points and pens must have same length')
4178 return self
._DrawPointList
(points
, pens
, [])
4181 def DrawLineList(self
, lines
, pens
=None):
4183 Draw a list of lines as quickly as possible.
4185 :param lines: A sequence of 4-element sequences representing
4186 each line to draw, (x1,y1, x2,y2).
4187 :param pens: If None, then the current pen is used. If a
4188 single pen then it will be used for all lines. If
4189 a list of pens then there should be one for each line
4194 elif isinstance(pens
, wx
.Pen
):
4196 elif len(pens
) != len(lines
):
4197 raise ValueError('lines and pens must have same length')
4198 return self
._DrawLineList
(lines
, pens
, [])
4201 def DrawRectangleList(self
, rectangles
, pens
=None, brushes
=None):
4203 Draw a list of rectangles as quickly as possible.
4205 :param rectangles: A sequence of 4-element sequences representing
4206 each rectangle to draw, (x,y, w,h).
4207 :param pens: If None, then the current pen is used. If a
4208 single pen then it will be used for all rectangles.
4209 If a list of pens then there should be one for each
4210 rectangle in rectangles.
4211 :param brushes: A brush or brushes to be used to fill the rectagles,
4212 with similar semantics as the pens parameter.
4216 elif isinstance(pens
, wx
.Pen
):
4218 elif len(pens
) != len(rectangles
):
4219 raise ValueError('rectangles and pens must have same length')
4222 elif isinstance(brushes
, wx
.Brush
):
4224 elif len(brushes
) != len(rectangles
):
4225 raise ValueError('rectangles and brushes must have same length')
4226 return self
._DrawRectangleList
(rectangles
, pens
, brushes
)
4229 def DrawEllipseList(self
, ellipses
, pens
=None, brushes
=None):
4231 Draw a list of ellipses as quickly as possible.
4233 :param ellipses: A sequence of 4-element sequences representing
4234 each ellipse to draw, (x,y, w,h).
4235 :param pens: If None, then the current pen is used. If a
4236 single pen then it will be used for all ellipses.
4237 If a list of pens then there should be one for each
4238 ellipse in ellipses.
4239 :param brushes: A brush or brushes to be used to fill the ellipses,
4240 with similar semantics as the pens parameter.
4244 elif isinstance(pens
, wx
.Pen
):
4246 elif len(pens
) != len(ellipses
):
4247 raise ValueError('ellipses and pens must have same length')
4250 elif isinstance(brushes
, wx
.Brush
):
4252 elif len(brushes
) != len(ellipses
):
4253 raise ValueError('ellipses and brushes must have same length')
4254 return self
._DrawEllipseList
(ellipses
, pens
, brushes
)
4257 def DrawPolygonList(self
, polygons
, pens
=None, brushes
=None):
4259 Draw a list of polygons, each of which is a list of points.
4261 :param polygons: A sequence of sequences of sequences.
4262 [[(x1,y1),(x2,y2),(x3,y3)...],
4263 [(x1,y1),(x2,y2),(x3,y3)...]]
4265 :param pens: If None, then the current pen is used. If a
4266 single pen then it will be used for all polygons.
4267 If a list of pens then there should be one for each
4269 :param brushes: A brush or brushes to be used to fill the polygons,
4270 with similar semantics as the pens parameter.
4274 elif isinstance(pens
, wx
.Pen
):
4276 elif len(pens
) != len(polygons
):
4277 raise ValueError('polygons and pens must have same length')
4280 elif isinstance(brushes
, wx
.Brush
):
4282 elif len(brushes
) != len(polygons
):
4283 raise ValueError('polygons and brushes must have same length')
4284 return self
._DrawPolygonList
(polygons
, pens
, brushes
)
4287 def DrawTextList(self
, textList
, coords
, foregrounds
= None, backgrounds
= None):
4289 Draw a list of strings using a list of coordinants for positioning each string.
4291 :param textList: A list of strings
4292 :param coords: A list of (x,y) positions
4293 :param foregrounds: A list of `wx.Colour` objects to use for the
4294 foregrounds of the strings.
4295 :param backgrounds: A list of `wx.Colour` objects to use for the
4296 backgrounds of the strings.
4298 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4299 If you want backgrounds to do anything.
4301 if type(textList
) == type(''):
4302 textList
= [textList
]
4303 elif len(textList
) != len(coords
):
4304 raise ValueError('textlist and coords must have same length')
4305 if foregrounds
is None:
4307 elif isinstance(foregrounds
, wx
.Colour
):
4308 foregrounds
= [foregrounds
]
4309 elif len(foregrounds
) != len(coords
):
4310 raise ValueError('foregrounds and coords must have same length')
4311 if backgrounds
is None:
4313 elif isinstance(backgrounds
, wx
.Colour
):
4314 backgrounds
= [backgrounds
]
4315 elif len(backgrounds
) != len(coords
):
4316 raise ValueError('backgrounds and coords must have same length')
4317 return self
._DrawTextList
(textList
, coords
, foregrounds
, backgrounds
)
4319 Background
= property(GetBackground
,SetBackground
,doc
="See `GetBackground` and `SetBackground`")
4320 BackgroundMode
= property(GetBackgroundMode
,SetBackgroundMode
,doc
="See `GetBackgroundMode` and `SetBackgroundMode`")
4321 BoundingBox
= property(GetBoundingBox
,doc
="See `GetBoundingBox`")
4322 Brush
= property(GetBrush
,SetBrush
,doc
="See `GetBrush` and `SetBrush`")
4323 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
4324 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
4325 ClippingBox
= property(GetClippingBox
,doc
="See `GetClippingBox`")
4326 ClippingRect
= property(GetClippingRect
,SetClippingRect
,doc
="See `GetClippingRect` and `SetClippingRect`")
4327 Depth
= property(GetDepth
,doc
="See `GetDepth`")
4328 DeviceOrigin
= property(GetDeviceOrigin
,SetDeviceOrigin
,doc
="See `GetDeviceOrigin` and `SetDeviceOrigin`")
4329 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
4330 FullTextExtent
= property(GetFullTextExtent
,doc
="See `GetFullTextExtent`")
4331 LogicalFunction
= property(GetLogicalFunction
,SetLogicalFunction
,doc
="See `GetLogicalFunction` and `SetLogicalFunction`")
4332 LogicalOrigin
= property(GetLogicalOrigin
,SetLogicalOrigin
,doc
="See `GetLogicalOrigin` and `SetLogicalOrigin`")
4333 LogicalScale
= property(GetLogicalScale
,SetLogicalScale
,doc
="See `GetLogicalScale` and `SetLogicalScale`")
4334 MapMode
= property(GetMapMode
,SetMapMode
,doc
="See `GetMapMode` and `SetMapMode`")
4335 MultiLineTextExtent
= property(GetMultiLineTextExtent
,doc
="See `GetMultiLineTextExtent`")
4336 Optimization
= property(GetOptimization
,SetOptimization
,doc
="See `GetOptimization` and `SetOptimization`")
4337 PPI
= property(GetPPI
,doc
="See `GetPPI`")
4338 PartialTextExtents
= property(GetPartialTextExtents
,doc
="See `GetPartialTextExtents`")
4339 Pen
= property(GetPen
,SetPen
,doc
="See `GetPen` and `SetPen`")
4340 Pixel
= property(GetPixel
,doc
="See `GetPixel`")
4341 PixelPoint
= property(GetPixelPoint
,doc
="See `GetPixelPoint`")
4342 Size
= property(GetSize
,doc
="See `GetSize`")
4343 SizeMM
= property(GetSizeMM
,doc
="See `GetSizeMM`")
4344 TextBackground
= property(GetTextBackground
,SetTextBackground
,doc
="See `GetTextBackground` and `SetTextBackground`")
4345 TextExtent
= property(GetTextExtent
,doc
="See `GetTextExtent`")
4346 TextForeground
= property(GetTextForeground
,SetTextForeground
,doc
="See `GetTextForeground` and `SetTextForeground`")
4347 UserScale
= property(GetUserScale
,SetUserScale
,doc
="See `GetUserScale` and `SetUserScale`")
4348 _gdi_
.DC_swigregister(DC
)
4350 #---------------------------------------------------------------------------
4354 A memory device context provides a means to draw graphics onto a
4355 bitmap. A bitmap must be selected into the new memory DC before it may
4356 be used for anything. Typical usage is as follows::
4359 dc.SelectObject(bitmap)
4360 # draw on the dc usign any of the Draw methods
4361 dc.SelectObject(wx.NullBitmap)
4362 # the bitmap now contains wahtever was drawn upon it
4364 Note that the memory DC *must* be deleted (or the bitmap selected out
4365 of it) before a bitmap can be reselected into another memory DC.
4368 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4369 __repr__
= _swig_repr
4370 def __init__(self
, *args
, **kwargs
):
4372 __init__(self) -> MemoryDC
4374 Constructs a new memory device context.
4376 Use the Ok member to test whether the constructor was successful in
4377 creating a usable device context. Don't forget to select a bitmap into
4378 the DC before drawing on it.
4380 _gdi_
.MemoryDC_swiginit(self
,_gdi_
.new_MemoryDC(*args
, **kwargs
))
4381 def SelectObject(*args
, **kwargs
):
4383 SelectObject(self, Bitmap bitmap)
4385 Selects the bitmap into the device context, to use as the memory
4386 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4387 the DC, and therefore the bitmap, and also to use Blit to copy the
4390 If the argument is wx.NullBitmap (or some other uninitialised
4391 `wx.Bitmap`) the current bitmap is selected out of the device context,
4392 and the original bitmap restored, allowing the current bitmap to be
4395 return _gdi_
.MemoryDC_SelectObject(*args
, **kwargs
)
4397 _gdi_
.MemoryDC_swigregister(MemoryDC
)
4399 def MemoryDCFromDC(*args
, **kwargs
):
4401 MemoryDCFromDC(DC oldDC) -> MemoryDC
4403 Creates a DC that is compatible with the oldDC.
4405 val
= _gdi_
.new_MemoryDCFromDC(*args
, **kwargs
)
4408 #---------------------------------------------------------------------------
4410 BUFFER_VIRTUAL_AREA
= _gdi_
.BUFFER_VIRTUAL_AREA
4411 BUFFER_CLIENT_AREA
= _gdi_
.BUFFER_CLIENT_AREA
4412 class BufferedDC(MemoryDC
):
4414 This simple class provides a simple way to avoid flicker: when drawing
4415 on it, everything is in fact first drawn on an in-memory buffer (a
4416 `wx.Bitmap`) and then copied to the screen only once, when this object
4419 It can be used in the same way as any other device
4420 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
4421 want to use it in your EVT_PAINT handler, you should look at
4422 `wx.BufferedPaintDC`.
4425 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4426 __repr__
= _swig_repr
4427 def __init__(self
, *args
):
4429 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4430 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4432 Constructs a buffered DC.
4434 _gdi_
.BufferedDC_swiginit(self
,_gdi_
.new_BufferedDC(*args
))
4435 self
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
4437 __swig_destroy__
= _gdi_
.delete_BufferedDC
4438 __del__
= lambda self
: None;
4439 def UnMask(*args
, **kwargs
):
4443 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4444 can be effectively used once only). This is usually only called in
4447 return _gdi_
.BufferedDC_UnMask(*args
, **kwargs
)
4449 _gdi_
.BufferedDC_swigregister(BufferedDC
)
4451 class BufferedPaintDC(BufferedDC
):
4453 This is a subclass of `wx.BufferedDC` which can be used inside of an
4454 EVT_PAINT event handler. Just create an object of this class instead
4455 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4456 flicker. The only thing to watch out for is that if you are using this
4457 class together with `wx.ScrolledWindow`, you probably do **not** want
4458 to call `wx.Window.PrepareDC` on it as it already does this internally
4459 for the real underlying `wx.PaintDC`.
4461 If your window is already fully buffered in a `wx.Bitmap` then your
4462 EVT_PAINT handler can be as simple as just creating a
4463 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4464 automatically when it is destroyed. For example::
4466 def OnPaint(self, event):
4467 dc = wx.BufferedPaintDC(self, self.buffer)
4474 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4475 __repr__
= _swig_repr
4476 def __init__(self
, *args
, **kwargs
):
4478 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
4480 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4481 provide the bitmap to be used for buffering or let this object create
4482 one internally (in the latter case, the size of the client part of the
4483 window is automatically used).
4487 _gdi_
.BufferedPaintDC_swiginit(self
,_gdi_
.new_BufferedPaintDC(*args
, **kwargs
))
4488 _gdi_
.BufferedPaintDC_swigregister(BufferedPaintDC
)
4490 #---------------------------------------------------------------------------
4494 A wxScreenDC can be used to paint anywhere on the screen. This should
4495 normally be constructed as a temporary stack object; don't store a
4499 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4500 __repr__
= _swig_repr
4501 def __init__(self
, *args
, **kwargs
):
4503 __init__(self) -> ScreenDC
4505 A wxScreenDC can be used to paint anywhere on the screen. This should
4506 normally be constructed as a temporary stack object; don't store a
4510 _gdi_
.ScreenDC_swiginit(self
,_gdi_
.new_ScreenDC(*args
, **kwargs
))
4511 def StartDrawingOnTopWin(*args
, **kwargs
):
4513 StartDrawingOnTopWin(self, Window window) -> bool
4515 Specify that the area of the screen to be drawn upon coincides with
4518 :see: `EndDrawingOnTop`
4520 return _gdi_
.ScreenDC_StartDrawingOnTopWin(*args
, **kwargs
)
4522 def StartDrawingOnTop(*args
, **kwargs
):
4524 StartDrawingOnTop(self, Rect rect=None) -> bool
4526 Specify that the area is the given rectangle, or the whole screen if
4529 :see: `EndDrawingOnTop`
4531 return _gdi_
.ScreenDC_StartDrawingOnTop(*args
, **kwargs
)
4533 def EndDrawingOnTop(*args
, **kwargs
):
4535 EndDrawingOnTop(self) -> bool
4537 Use this in conjunction with `StartDrawingOnTop` or
4538 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4539 top of existing windows. Without this, some window systems (such as X)
4540 only allow drawing to take place underneath other windows.
4542 You might use this pair of functions when implementing a drag feature,
4543 for example as in the `wx.SplitterWindow` implementation.
4545 These functions are probably obsolete since the X implementations
4546 allow drawing directly on the screen now. However, the fact that this
4547 function allows the screen to be refreshed afterwards may be useful
4548 to some applications.
4550 return _gdi_
.ScreenDC_EndDrawingOnTop(*args
, **kwargs
)
4552 _gdi_
.ScreenDC_swigregister(ScreenDC
)
4554 #---------------------------------------------------------------------------
4558 A wx.ClientDC must be constructed if an application wishes to paint on
4559 the client area of a window from outside an EVT_PAINT event. This should
4560 normally be constructed as a temporary stack object; don't store a
4561 wx.ClientDC object long term.
4563 To draw on a window from within an EVT_PAINT handler, construct a
4564 `wx.PaintDC` object.
4566 To draw on the whole window including decorations, construct a
4567 `wx.WindowDC` object (Windows only).
4570 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4571 __repr__
= _swig_repr
4572 def __init__(self
, *args
, **kwargs
):
4574 __init__(self, Window win) -> ClientDC
4576 Constructor. Pass the window on which you wish to paint.
4578 _gdi_
.ClientDC_swiginit(self
,_gdi_
.new_ClientDC(*args
, **kwargs
))
4579 _gdi_
.ClientDC_swigregister(ClientDC
)
4581 #---------------------------------------------------------------------------
4585 A wx.PaintDC must be constructed if an application wishes to paint on
4586 the client area of a window from within an EVT_PAINT event
4587 handler. This should normally be constructed as a temporary stack
4588 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4589 handler, you **must** create a wx.PaintDC object within it even if you
4590 don't actually use it.
4592 Using wx.PaintDC within EVT_PAINT handlers is important because it
4593 automatically sets the clipping area to the damaged area of the
4594 window. Attempts to draw outside this area do not appear.
4596 To draw on a window from outside EVT_PAINT handlers, construct a
4597 `wx.ClientDC` object.
4600 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4601 __repr__
= _swig_repr
4602 def __init__(self
, *args
, **kwargs
):
4604 __init__(self, Window win) -> PaintDC
4606 Constructor. Pass the window on which you wish to paint.
4608 _gdi_
.PaintDC_swiginit(self
,_gdi_
.new_PaintDC(*args
, **kwargs
))
4609 _gdi_
.PaintDC_swigregister(PaintDC
)
4611 #---------------------------------------------------------------------------
4615 A wx.WindowDC must be constructed if an application wishes to paint on
4616 the whole area of a window (client and decorations). This should
4617 normally be constructed as a temporary stack object; don't store a
4620 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4621 __repr__
= _swig_repr
4622 def __init__(self
, *args
, **kwargs
):
4624 __init__(self, Window win) -> WindowDC
4626 Constructor. Pass the window on which you wish to paint.
4628 _gdi_
.WindowDC_swiginit(self
,_gdi_
.new_WindowDC(*args
, **kwargs
))
4629 _gdi_
.WindowDC_swigregister(WindowDC
)
4631 #---------------------------------------------------------------------------
4635 wx.MirrorDC is a simple wrapper class which is always associated with a
4636 real `wx.DC` object and either forwards all of its operations to it
4637 without changes (no mirroring takes place) or exchanges x and y
4638 coordinates which makes it possible to reuse the same code to draw a
4639 figure and its mirror -- i.e. reflection related to the diagonal line
4642 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4643 __repr__
= _swig_repr
4644 def __init__(self
, *args
, **kwargs
):
4646 __init__(self, DC dc, bool mirror) -> MirrorDC
4648 Creates a mirrored DC associated with the real *dc*. Everything drawn
4649 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4652 _gdi_
.MirrorDC_swiginit(self
,_gdi_
.new_MirrorDC(*args
, **kwargs
))
4653 _gdi_
.MirrorDC_swigregister(MirrorDC
)
4655 #---------------------------------------------------------------------------
4657 class PostScriptDC(DC
):
4658 """This is a `wx.DC` that can write to PostScript files on any platform."""
4659 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4660 __repr__
= _swig_repr
4661 def __init__(self
, *args
, **kwargs
):
4663 __init__(self, wxPrintData printData) -> PostScriptDC
4665 Constructs a PostScript printer device context from a `wx.PrintData`
4668 _gdi_
.PostScriptDC_swiginit(self
,_gdi_
.new_PostScriptDC(*args
, **kwargs
))
4669 def GetPrintData(*args
, **kwargs
):
4670 """GetPrintData(self) -> wxPrintData"""
4671 return _gdi_
.PostScriptDC_GetPrintData(*args
, **kwargs
)
4673 def SetPrintData(*args
, **kwargs
):
4674 """SetPrintData(self, wxPrintData data)"""
4675 return _gdi_
.PostScriptDC_SetPrintData(*args
, **kwargs
)
4677 def SetResolution(*args
, **kwargs
):
4679 SetResolution(int ppi)
4681 Set resolution (in pixels per inch) that will be used in PostScript
4682 output. Default is 720ppi.
4684 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4686 SetResolution
= staticmethod(SetResolution
)
4687 def GetResolution(*args
, **kwargs
):
4689 GetResolution() -> int
4691 Return resolution used in PostScript output.
4693 return _gdi_
.PostScriptDC_GetResolution(*args
, **kwargs
)
4695 GetResolution
= staticmethod(GetResolution
)
4696 PrintData
= property(GetPrintData
,SetPrintData
,doc
="See `GetPrintData` and `SetPrintData`")
4697 _gdi_
.PostScriptDC_swigregister(PostScriptDC
)
4699 def PostScriptDC_SetResolution(*args
, **kwargs
):
4701 PostScriptDC_SetResolution(int ppi)
4703 Set resolution (in pixels per inch) that will be used in PostScript
4704 output. Default is 720ppi.
4706 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4708 def PostScriptDC_GetResolution(*args
):
4710 PostScriptDC_GetResolution() -> int
4712 Return resolution used in PostScript output.
4714 return _gdi_
.PostScriptDC_GetResolution(*args
)
4716 #---------------------------------------------------------------------------
4718 class MetaFile(_core
.Object
):
4719 """Proxy of C++ MetaFile class"""
4720 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4721 __repr__
= _swig_repr
4722 def __init__(self
, *args
, **kwargs
):
4723 """__init__(self, String filename=EmptyString) -> MetaFile"""
4724 _gdi_
.MetaFile_swiginit(self
,_gdi_
.new_MetaFile(*args
, **kwargs
))
4725 __swig_destroy__
= _gdi_
.delete_MetaFile
4726 __del__
= lambda self
: None;
4727 def Ok(*args
, **kwargs
):
4728 """Ok(self) -> bool"""
4729 return _gdi_
.MetaFile_Ok(*args
, **kwargs
)
4731 def SetClipboard(*args
, **kwargs
):
4732 """SetClipboard(self, int width=0, int height=0) -> bool"""
4733 return _gdi_
.MetaFile_SetClipboard(*args
, **kwargs
)
4735 def GetSize(*args
, **kwargs
):
4736 """GetSize(self) -> Size"""
4737 return _gdi_
.MetaFile_GetSize(*args
, **kwargs
)
4739 def GetWidth(*args
, **kwargs
):
4740 """GetWidth(self) -> int"""
4741 return _gdi_
.MetaFile_GetWidth(*args
, **kwargs
)
4743 def GetHeight(*args
, **kwargs
):
4744 """GetHeight(self) -> int"""
4745 return _gdi_
.MetaFile_GetHeight(*args
, **kwargs
)
4747 def __nonzero__(self
): return self
.Ok()
4748 _gdi_
.MetaFile_swigregister(MetaFile
)
4750 class MetaFileDC(DC
):
4751 """Proxy of C++ MetaFileDC class"""
4752 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4753 __repr__
= _swig_repr
4754 def __init__(self
, *args
, **kwargs
):
4756 __init__(self, String filename=EmptyString, int width=0, int height=0,
4757 String description=EmptyString) -> MetaFileDC
4759 _gdi_
.MetaFileDC_swiginit(self
,_gdi_
.new_MetaFileDC(*args
, **kwargs
))
4760 def Close(*args
, **kwargs
):
4761 """Close(self) -> MetaFile"""
4762 return _gdi_
.MetaFileDC_Close(*args
, **kwargs
)
4764 _gdi_
.MetaFileDC_swigregister(MetaFileDC
)
4766 class PrinterDC(DC
):
4767 """Proxy of C++ PrinterDC class"""
4768 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4769 __repr__
= _swig_repr
4770 def __init__(self
, *args
, **kwargs
):
4771 """__init__(self, wxPrintData printData) -> PrinterDC"""
4772 _gdi_
.PrinterDC_swiginit(self
,_gdi_
.new_PrinterDC(*args
, **kwargs
))
4773 _gdi_
.PrinterDC_swigregister(PrinterDC
)
4775 #---------------------------------------------------------------------------
4777 IMAGELIST_DRAW_NORMAL
= _gdi_
.IMAGELIST_DRAW_NORMAL
4778 IMAGELIST_DRAW_TRANSPARENT
= _gdi_
.IMAGELIST_DRAW_TRANSPARENT
4779 IMAGELIST_DRAW_SELECTED
= _gdi_
.IMAGELIST_DRAW_SELECTED
4780 IMAGELIST_DRAW_FOCUSED
= _gdi_
.IMAGELIST_DRAW_FOCUSED
4781 IMAGE_LIST_NORMAL
= _gdi_
.IMAGE_LIST_NORMAL
4782 IMAGE_LIST_SMALL
= _gdi_
.IMAGE_LIST_SMALL
4783 IMAGE_LIST_STATE
= _gdi_
.IMAGE_LIST_STATE
4784 class ImageList(_core
.Object
):
4785 """Proxy of C++ ImageList class"""
4786 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4787 __repr__
= _swig_repr
4788 def __init__(self
, *args
, **kwargs
):
4789 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
4790 _gdi_
.ImageList_swiginit(self
,_gdi_
.new_ImageList(*args
, **kwargs
))
4791 __swig_destroy__
= _gdi_
.delete_ImageList
4792 __del__
= lambda self
: None;
4793 def Add(*args
, **kwargs
):
4794 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
4795 return _gdi_
.ImageList_Add(*args
, **kwargs
)
4797 def AddWithColourMask(*args
, **kwargs
):
4798 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
4799 return _gdi_
.ImageList_AddWithColourMask(*args
, **kwargs
)
4801 def AddIcon(*args
, **kwargs
):
4802 """AddIcon(self, Icon icon) -> int"""
4803 return _gdi_
.ImageList_AddIcon(*args
, **kwargs
)
4805 def GetBitmap(*args
, **kwargs
):
4806 """GetBitmap(self, int index) -> Bitmap"""
4807 return _gdi_
.ImageList_GetBitmap(*args
, **kwargs
)
4809 def GetIcon(*args
, **kwargs
):
4810 """GetIcon(self, int index) -> Icon"""
4811 return _gdi_
.ImageList_GetIcon(*args
, **kwargs
)
4813 def Replace(*args
, **kwargs
):
4814 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
4815 return _gdi_
.ImageList_Replace(*args
, **kwargs
)
4817 def Draw(*args
, **kwargs
):
4819 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
4820 bool solidBackground=False) -> bool
4822 return _gdi_
.ImageList_Draw(*args
, **kwargs
)
4824 def GetImageCount(*args
, **kwargs
):
4825 """GetImageCount(self) -> int"""
4826 return _gdi_
.ImageList_GetImageCount(*args
, **kwargs
)
4828 def Remove(*args
, **kwargs
):
4829 """Remove(self, int index) -> bool"""
4830 return _gdi_
.ImageList_Remove(*args
, **kwargs
)
4832 def RemoveAll(*args
, **kwargs
):
4833 """RemoveAll(self) -> bool"""
4834 return _gdi_
.ImageList_RemoveAll(*args
, **kwargs
)
4836 def GetSize(*args
, **kwargs
):
4837 """GetSize(index) -> (width,height)"""
4838 return _gdi_
.ImageList_GetSize(*args
, **kwargs
)
4840 ImageCount
= property(GetImageCount
,doc
="See `GetImageCount`")
4841 Size
= property(GetSize
,doc
="See `GetSize`")
4842 _gdi_
.ImageList_swigregister(ImageList
)
4844 #---------------------------------------------------------------------------
4846 class StockGDI(object):
4847 """Proxy of C++ StockGDI class"""
4848 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4849 __repr__
= _swig_repr
4850 BRUSH_BLACK
= _gdi_
.StockGDI_BRUSH_BLACK
4851 BRUSH_BLUE
= _gdi_
.StockGDI_BRUSH_BLUE
4852 BRUSH_CYAN
= _gdi_
.StockGDI_BRUSH_CYAN
4853 BRUSH_GREEN
= _gdi_
.StockGDI_BRUSH_GREEN
4854 BRUSH_GREY
= _gdi_
.StockGDI_BRUSH_GREY
4855 BRUSH_LIGHTGREY
= _gdi_
.StockGDI_BRUSH_LIGHTGREY
4856 BRUSH_MEDIUMGREY
= _gdi_
.StockGDI_BRUSH_MEDIUMGREY
4857 BRUSH_RED
= _gdi_
.StockGDI_BRUSH_RED
4858 BRUSH_TRANSPARENT
= _gdi_
.StockGDI_BRUSH_TRANSPARENT
4859 BRUSH_WHITE
= _gdi_
.StockGDI_BRUSH_WHITE
4860 COLOUR_BLACK
= _gdi_
.StockGDI_COLOUR_BLACK
4861 COLOUR_BLUE
= _gdi_
.StockGDI_COLOUR_BLUE
4862 COLOUR_CYAN
= _gdi_
.StockGDI_COLOUR_CYAN
4863 COLOUR_GREEN
= _gdi_
.StockGDI_COLOUR_GREEN
4864 COLOUR_LIGHTGREY
= _gdi_
.StockGDI_COLOUR_LIGHTGREY
4865 COLOUR_RED
= _gdi_
.StockGDI_COLOUR_RED
4866 COLOUR_WHITE
= _gdi_
.StockGDI_COLOUR_WHITE
4867 CURSOR_CROSS
= _gdi_
.StockGDI_CURSOR_CROSS
4868 CURSOR_HOURGLASS
= _gdi_
.StockGDI_CURSOR_HOURGLASS
4869 CURSOR_STANDARD
= _gdi_
.StockGDI_CURSOR_STANDARD
4870 FONT_ITALIC
= _gdi_
.StockGDI_FONT_ITALIC
4871 FONT_NORMAL
= _gdi_
.StockGDI_FONT_NORMAL
4872 FONT_SMALL
= _gdi_
.StockGDI_FONT_SMALL
4873 FONT_SWISS
= _gdi_
.StockGDI_FONT_SWISS
4874 PEN_BLACK
= _gdi_
.StockGDI_PEN_BLACK
4875 PEN_BLACKDASHED
= _gdi_
.StockGDI_PEN_BLACKDASHED
4876 PEN_CYAN
= _gdi_
.StockGDI_PEN_CYAN
4877 PEN_GREEN
= _gdi_
.StockGDI_PEN_GREEN
4878 PEN_GREY
= _gdi_
.StockGDI_PEN_GREY
4879 PEN_LIGHTGREY
= _gdi_
.StockGDI_PEN_LIGHTGREY
4880 PEN_MEDIUMGREY
= _gdi_
.StockGDI_PEN_MEDIUMGREY
4881 PEN_RED
= _gdi_
.StockGDI_PEN_RED
4882 PEN_TRANSPARENT
= _gdi_
.StockGDI_PEN_TRANSPARENT
4883 PEN_WHITE
= _gdi_
.StockGDI_PEN_WHITE
4884 ITEMCOUNT
= _gdi_
.StockGDI_ITEMCOUNT
4885 def __init__(self
, *args
, **kwargs
):
4886 """__init__(self) -> StockGDI"""
4887 _gdi_
.StockGDI_swiginit(self
,_gdi_
.new_StockGDI(*args
, **kwargs
))
4888 __swig_destroy__
= _gdi_
.delete_StockGDI
4889 __del__
= lambda self
: None;
4890 def DeleteAll(*args
, **kwargs
):
4892 return _gdi_
.StockGDI_DeleteAll(*args
, **kwargs
)
4894 DeleteAll
= staticmethod(DeleteAll
)
4895 def instance(*args
, **kwargs
):
4896 """instance() -> StockGDI"""
4897 return _gdi_
.StockGDI_instance(*args
, **kwargs
)
4899 instance
= staticmethod(instance
)
4900 def GetBrush(*args
, **kwargs
):
4901 """GetBrush(int item) -> Brush"""
4902 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
4904 GetBrush
= staticmethod(GetBrush
)
4905 def GetColour(*args
, **kwargs
):
4906 """GetColour(int item) -> Colour"""
4907 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
4909 GetColour
= staticmethod(GetColour
)
4910 def GetCursor(*args
, **kwargs
):
4911 """GetCursor(int item) -> Cursor"""
4912 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
4914 GetCursor
= staticmethod(GetCursor
)
4915 def GetPen(*args
, **kwargs
):
4916 """GetPen(int item) -> Pen"""
4917 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
4919 GetPen
= staticmethod(GetPen
)
4920 def GetFont(*args
, **kwargs
):
4921 """GetFont(self, int item) -> Font"""
4922 return _gdi_
.StockGDI_GetFont(*args
, **kwargs
)
4924 def _initStockObjects():
4926 wx
.ITALIC_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_ITALIC
).this
4927 wx
.NORMAL_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_NORMAL
).this
4928 wx
.SMALL_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_SMALL
).this
4929 wx
.SWISS_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_SWISS
).this
4931 wx
.BLACK_DASHED_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_BLACKDASHED
).this
4932 wx
.BLACK_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_BLACK
).this
4933 wx
.CYAN_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_CYAN
).this
4934 wx
.GREEN_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_GREEN
).this
4935 wx
.GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_GREY
).this
4936 wx
.LIGHT_GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_LIGHTGREY
).this
4937 wx
.MEDIUM_GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_MEDIUMGREY
).this
4938 wx
.RED_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_RED
).this
4939 wx
.TRANSPARENT_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_TRANSPARENT
).this
4940 wx
.WHITE_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_WHITE
).this
4942 wx
.BLACK_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLACK
).this
4943 wx
.BLUE_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLUE
).this
4944 wx
.CYAN_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_CYAN
).this
4945 wx
.GREEN_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREEN
).this
4946 wx
.GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREY
).this
4947 wx
.LIGHT_GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_LIGHTGREY
).this
4948 wx
.MEDIUM_GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_MEDIUMGREY
).this
4949 wx
.RED_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_RED
).this
4950 wx
.TRANSPARENT_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_TRANSPARENT
).this
4951 wx
.WHITE_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_WHITE
).this
4953 wx
.BLACK
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_BLACK
).this
4954 wx
.BLUE
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_BLUE
).this
4955 wx
.CYAN
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_CYAN
).this
4956 wx
.GREEN
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_GREEN
).this
4957 wx
.LIGHT_GREY
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_LIGHTGREY
).this
4958 wx
.RED
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_RED
).this
4959 wx
.WHITE
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_WHITE
).this
4961 wx
.CROSS_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_CROSS
).this
4962 wx
.HOURGLASS_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_HOURGLASS
).this
4963 wx
.STANDARD_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_STANDARD
).this
4965 wx
.TheFontList
.this
= _wxPyInitTheFontList().this
4966 wx
.ThePenList
.this
= _wxPyInitThePenList().this
4967 wx
.TheBrushList
.this
= _wxPyInitTheBrushList().this
4968 wx
.TheColourDatabase
.this
= _wxPyInitTheColourDatabase().this
4971 _initStockObjects
= staticmethod(_initStockObjects
)
4973 _gdi_
.StockGDI_swigregister(StockGDI
)
4975 def StockGDI_DeleteAll(*args
):
4976 """StockGDI_DeleteAll()"""
4977 return _gdi_
.StockGDI_DeleteAll(*args
)
4979 def StockGDI_instance(*args
):
4980 """StockGDI_instance() -> StockGDI"""
4981 return _gdi_
.StockGDI_instance(*args
)
4983 def StockGDI_GetBrush(*args
, **kwargs
):
4984 """StockGDI_GetBrush(int item) -> Brush"""
4985 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
4987 def StockGDI_GetColour(*args
, **kwargs
):
4988 """StockGDI_GetColour(int item) -> Colour"""
4989 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
4991 def StockGDI_GetCursor(*args
, **kwargs
):
4992 """StockGDI_GetCursor(int item) -> Cursor"""
4993 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
4995 def StockGDI_GetPen(*args
, **kwargs
):
4996 """StockGDI_GetPen(int item) -> Pen"""
4997 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
4999 # Create an uninitialized instance for the stock objects, they will
5000 # be initialized later when the wx.App object is created.
5001 ITALIC_FONT
= Font
.__new
__(Font
)
5002 NORMAL_FONT
= Font
.__new
__(Font
)
5003 SMALL_FONT
= Font
.__new
__(Font
)
5004 SWISS_FONT
= Font
.__new
__(Font
)
5006 BLACK_DASHED_PEN
= Pen
.__new
__(Pen
)
5007 BLACK_PEN
= Pen
.__new
__(Pen
)
5008 CYAN_PEN
= Pen
.__new
__(Pen
)
5009 GREEN_PEN
= Pen
.__new
__(Pen
)
5010 GREY_PEN
= Pen
.__new
__(Pen
)
5011 LIGHT_GREY_PEN
= Pen
.__new
__(Pen
)
5012 MEDIUM_GREY_PEN
= Pen
.__new
__(Pen
)
5013 RED_PEN
= Pen
.__new
__(Pen
)
5014 TRANSPARENT_PEN
= Pen
.__new
__(Pen
)
5015 WHITE_PEN
= Pen
.__new
__(Pen
)
5017 BLACK_BRUSH
= Brush
.__new
__(Brush
)
5018 BLUE_BRUSH
= Brush
.__new
__(Brush
)
5019 CYAN_BRUSH
= Brush
.__new
__(Brush
)
5020 GREEN_BRUSH
= Brush
.__new
__(Brush
)
5021 GREY_BRUSH
= Brush
.__new
__(Brush
)
5022 LIGHT_GREY_BRUSH
= Brush
.__new
__(Brush
)
5023 MEDIUM_GREY_BRUSH
= Brush
.__new
__(Brush
)
5024 RED_BRUSH
= Brush
.__new
__(Brush
)
5025 TRANSPARENT_BRUSH
= Brush
.__new
__(Brush
)
5026 WHITE_BRUSH
= Brush
.__new
__(Brush
)
5028 BLACK
= Colour
.__new
__(Colour
)
5029 BLUE
= Colour
.__new
__(Colour
)
5030 CYAN
= Colour
.__new
__(Colour
)
5031 GREEN
= Colour
.__new
__(Colour
)
5032 LIGHT_GREY
= Colour
.__new
__(Colour
)
5033 RED
= Colour
.__new
__(Colour
)
5034 WHITE
= Colour
.__new
__(Colour
)
5036 CROSS_CURSOR
= Cursor
.__new
__(Cursor
)
5037 HOURGLASS_CURSOR
= Cursor
.__new
__(Cursor
)
5038 STANDARD_CURSOR
= Cursor
.__new
__(Cursor
)
5040 class GDIObjListBase(object):
5041 """Proxy of C++ GDIObjListBase class"""
5042 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5043 __repr__
= _swig_repr
5044 def __init__(self
, *args
, **kwargs
):
5045 """__init__(self) -> GDIObjListBase"""
5046 _gdi_
.GDIObjListBase_swiginit(self
,_gdi_
.new_GDIObjListBase(*args
, **kwargs
))
5047 __swig_destroy__
= _gdi_
.delete_GDIObjListBase
5048 __del__
= lambda self
: None;
5049 _gdi_
.GDIObjListBase_swigregister(GDIObjListBase
)
5051 NullBitmap
= cvar
.NullBitmap
5052 NullIcon
= cvar
.NullIcon
5053 NullCursor
= cvar
.NullCursor
5054 NullPen
= cvar
.NullPen
5055 NullBrush
= cvar
.NullBrush
5056 NullPalette
= cvar
.NullPalette
5057 NullFont
= cvar
.NullFont
5058 NullColour
= cvar
.NullColour
5060 class PenList(GDIObjListBase
):
5061 """Proxy of C++ PenList class"""
5062 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5063 def __init__(self
): raise AttributeError, "No constructor defined"
5064 __repr__
= _swig_repr
5065 def FindOrCreatePen(*args
, **kwargs
):
5066 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
5067 return _gdi_
.PenList_FindOrCreatePen(*args
, **kwargs
)
5069 def AddPen(*args
, **kwargs
):
5070 """AddPen(self, Pen pen)"""
5071 return _gdi_
.PenList_AddPen(*args
, **kwargs
)
5073 def RemovePen(*args
, **kwargs
):
5074 """RemovePen(self, Pen pen)"""
5075 return _gdi_
.PenList_RemovePen(*args
, **kwargs
)
5077 AddPen
= wx
._deprecated
(AddPen
)
5078 RemovePen
= wx
._deprecated
(RemovePen
)
5080 _gdi_
.PenList_swigregister(PenList
)
5082 class BrushList(GDIObjListBase
):
5083 """Proxy of C++ BrushList class"""
5084 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5085 def __init__(self
): raise AttributeError, "No constructor defined"
5086 __repr__
= _swig_repr
5087 def FindOrCreateBrush(*args
, **kwargs
):
5088 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
5089 return _gdi_
.BrushList_FindOrCreateBrush(*args
, **kwargs
)
5091 def AddBrush(*args
, **kwargs
):
5092 """AddBrush(self, Brush brush)"""
5093 return _gdi_
.BrushList_AddBrush(*args
, **kwargs
)
5095 def RemoveBrush(*args
, **kwargs
):
5096 """RemoveBrush(self, Brush brush)"""
5097 return _gdi_
.BrushList_RemoveBrush(*args
, **kwargs
)
5099 AddBrush
= wx
._deprecated
(AddBrush
)
5100 RemoveBrush
= wx
._deprecated
(RemoveBrush
)
5102 _gdi_
.BrushList_swigregister(BrushList
)
5104 class FontList(GDIObjListBase
):
5105 """Proxy of C++ FontList class"""
5106 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5107 def __init__(self
): raise AttributeError, "No constructor defined"
5108 __repr__
= _swig_repr
5109 def FindOrCreateFont(*args
, **kwargs
):
5111 FindOrCreateFont(self, int point_size, int family, int style, int weight,
5112 bool underline=False, String facename=EmptyString,
5113 int encoding=FONTENCODING_DEFAULT) -> Font
5115 return _gdi_
.FontList_FindOrCreateFont(*args
, **kwargs
)
5117 def AddFont(*args
, **kwargs
):
5118 """AddFont(self, Font font)"""
5119 return _gdi_
.FontList_AddFont(*args
, **kwargs
)
5121 def RemoveFont(*args
, **kwargs
):
5122 """RemoveFont(self, Font font)"""
5123 return _gdi_
.FontList_RemoveFont(*args
, **kwargs
)
5125 AddFont
= wx
._deprecated
(AddFont
)
5126 RemoveFont
= wx
._deprecated
(RemoveFont
)
5128 _gdi_
.FontList_swigregister(FontList
)
5130 class ColourDatabase(object):
5131 """Proxy of C++ ColourDatabase class"""
5132 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5133 __repr__
= _swig_repr
5134 def __init__(self
, *args
, **kwargs
):
5135 """__init__(self) -> ColourDatabase"""
5136 _gdi_
.ColourDatabase_swiginit(self
,_gdi_
.new_ColourDatabase(*args
, **kwargs
))
5137 __swig_destroy__
= _gdi_
.delete_ColourDatabase
5138 __del__
= lambda self
: None;
5139 def Find(*args
, **kwargs
):
5140 """Find(self, String name) -> Colour"""
5141 return _gdi_
.ColourDatabase_Find(*args
, **kwargs
)
5143 def FindName(*args
, **kwargs
):
5144 """FindName(self, Colour colour) -> String"""
5145 return _gdi_
.ColourDatabase_FindName(*args
, **kwargs
)
5148 def AddColour(*args
, **kwargs
):
5149 """AddColour(self, String name, Colour colour)"""
5150 return _gdi_
.ColourDatabase_AddColour(*args
, **kwargs
)
5152 def Append(*args
, **kwargs
):
5153 """Append(self, String name, int red, int green, int blue)"""
5154 return _gdi_
.ColourDatabase_Append(*args
, **kwargs
)
5156 _gdi_
.ColourDatabase_swigregister(ColourDatabase
)
5158 #---------------------------------------------------------------------------
5161 def _wxPyInitTheFontList(*args
):
5162 """_wxPyInitTheFontList() -> FontList"""
5163 return _gdi_
._wxPyInitTheFontList
(*args
)
5165 def _wxPyInitThePenList(*args
):
5166 """_wxPyInitThePenList() -> PenList"""
5167 return _gdi_
._wxPyInitThePenList
(*args
)
5169 def _wxPyInitTheBrushList(*args
):
5170 """_wxPyInitTheBrushList() -> BrushList"""
5171 return _gdi_
._wxPyInitTheBrushList
(*args
)
5173 def _wxPyInitTheColourDatabase(*args
):
5174 """_wxPyInitTheColourDatabase() -> ColourDatabase"""
5175 return _gdi_
._wxPyInitTheColourDatabase
(*args
)
5176 # Create an uninitialized instance for the stock objects, they will
5177 # be initialized later when the wx.App object is created.
5178 TheFontList
= FontList
.__new
__(FontList
)
5179 ThePenList
= PenList
.__new
__(PenList
)
5180 TheBrushList
= BrushList
.__new
__(BrushList
)
5181 TheColourDatabase
= ColourDatabase
.__new
__(ColourDatabase
)
5183 NullColor
= NullColour
5184 #---------------------------------------------------------------------------
5186 class Effects(_core
.Object
):
5187 """Proxy of C++ Effects class"""
5188 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5189 __repr__
= _swig_repr
5190 def __init__(self
, *args
, **kwargs
):
5191 """__init__(self) -> Effects"""
5192 _gdi_
.Effects_swiginit(self
,_gdi_
.new_Effects(*args
, **kwargs
))
5193 def GetHighlightColour(*args
, **kwargs
):
5194 """GetHighlightColour(self) -> Colour"""
5195 return _gdi_
.Effects_GetHighlightColour(*args
, **kwargs
)
5197 def GetLightShadow(*args
, **kwargs
):
5198 """GetLightShadow(self) -> Colour"""
5199 return _gdi_
.Effects_GetLightShadow(*args
, **kwargs
)
5201 def GetFaceColour(*args
, **kwargs
):
5202 """GetFaceColour(self) -> Colour"""
5203 return _gdi_
.Effects_GetFaceColour(*args
, **kwargs
)
5205 def GetMediumShadow(*args
, **kwargs
):
5206 """GetMediumShadow(self) -> Colour"""
5207 return _gdi_
.Effects_GetMediumShadow(*args
, **kwargs
)
5209 def GetDarkShadow(*args
, **kwargs
):
5210 """GetDarkShadow(self) -> Colour"""
5211 return _gdi_
.Effects_GetDarkShadow(*args
, **kwargs
)
5213 def SetHighlightColour(*args
, **kwargs
):
5214 """SetHighlightColour(self, Colour c)"""
5215 return _gdi_
.Effects_SetHighlightColour(*args
, **kwargs
)
5217 def SetLightShadow(*args
, **kwargs
):
5218 """SetLightShadow(self, Colour c)"""
5219 return _gdi_
.Effects_SetLightShadow(*args
, **kwargs
)
5221 def SetFaceColour(*args
, **kwargs
):
5222 """SetFaceColour(self, Colour c)"""
5223 return _gdi_
.Effects_SetFaceColour(*args
, **kwargs
)
5225 def SetMediumShadow(*args
, **kwargs
):
5226 """SetMediumShadow(self, Colour c)"""
5227 return _gdi_
.Effects_SetMediumShadow(*args
, **kwargs
)
5229 def SetDarkShadow(*args
, **kwargs
):
5230 """SetDarkShadow(self, Colour c)"""
5231 return _gdi_
.Effects_SetDarkShadow(*args
, **kwargs
)
5233 def Set(*args
, **kwargs
):
5235 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
5236 Colour mediumShadow, Colour darkShadow)
5238 return _gdi_
.Effects_Set(*args
, **kwargs
)
5240 def DrawSunkenEdge(*args
, **kwargs
):
5241 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
5242 return _gdi_
.Effects_DrawSunkenEdge(*args
, **kwargs
)
5244 def TileBitmap(*args
, **kwargs
):
5245 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
5246 return _gdi_
.Effects_TileBitmap(*args
, **kwargs
)
5248 DarkShadow
= property(GetDarkShadow
,SetDarkShadow
,doc
="See `GetDarkShadow` and `SetDarkShadow`")
5249 FaceColour
= property(GetFaceColour
,SetFaceColour
,doc
="See `GetFaceColour` and `SetFaceColour`")
5250 HighlightColour
= property(GetHighlightColour
,SetHighlightColour
,doc
="See `GetHighlightColour` and `SetHighlightColour`")
5251 LightShadow
= property(GetLightShadow
,SetLightShadow
,doc
="See `GetLightShadow` and `SetLightShadow`")
5252 MediumShadow
= property(GetMediumShadow
,SetMediumShadow
,doc
="See `GetMediumShadow` and `SetMediumShadow`")
5253 _gdi_
.Effects_swigregister(Effects
)
5255 #---------------------------------------------------------------------------
5257 CONTROL_DISABLED
= _gdi_
.CONTROL_DISABLED
5258 CONTROL_FOCUSED
= _gdi_
.CONTROL_FOCUSED
5259 CONTROL_PRESSED
= _gdi_
.CONTROL_PRESSED
5260 CONTROL_ISDEFAULT
= _gdi_
.CONTROL_ISDEFAULT
5261 CONTROL_ISSUBMENU
= _gdi_
.CONTROL_ISSUBMENU
5262 CONTROL_EXPANDED
= _gdi_
.CONTROL_EXPANDED
5263 CONTROL_CURRENT
= _gdi_
.CONTROL_CURRENT
5264 CONTROL_SELECTED
= _gdi_
.CONTROL_SELECTED
5265 CONTROL_CHECKED
= _gdi_
.CONTROL_CHECKED
5266 CONTROL_CHECKABLE
= _gdi_
.CONTROL_CHECKABLE
5267 CONTROL_UNDETERMINED
= _gdi_
.CONTROL_UNDETERMINED
5268 CONTROL_FLAGS_MASK
= _gdi_
.CONTROL_FLAGS_MASK
5269 CONTROL_DIRTY
= _gdi_
.CONTROL_DIRTY
5270 class SplitterRenderParams(object):
5272 This is just a simple struct used as a return value of
5273 `wx.RendererNative.GetSplitterParams` and contains some platform
5274 specific metrics about splitters.
5276 * widthSash: the width of the splitter sash.
5277 * border: the width of the border of the splitter window.
5278 * isHotSensitive: ``True`` if the splitter changes its
5279 appearance when the mouse is over it.
5283 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5284 __repr__
= _swig_repr
5285 def __init__(self
, *args
, **kwargs
):
5287 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5289 This is just a simple struct used as a return value of
5290 `wx.RendererNative.GetSplitterParams` and contains some platform
5291 specific metrics about splitters.
5293 * widthSash: the width of the splitter sash.
5294 * border: the width of the border of the splitter window.
5295 * isHotSensitive: ``True`` if the splitter changes its
5296 appearance when the mouse is over it.
5300 _gdi_
.SplitterRenderParams_swiginit(self
,_gdi_
.new_SplitterRenderParams(*args
, **kwargs
))
5301 __swig_destroy__
= _gdi_
.delete_SplitterRenderParams
5302 __del__
= lambda self
: None;
5303 widthSash
= property(_gdi_
.SplitterRenderParams_widthSash_get
)
5304 border
= property(_gdi_
.SplitterRenderParams_border_get
)
5305 isHotSensitive
= property(_gdi_
.SplitterRenderParams_isHotSensitive_get
)
5306 _gdi_
.SplitterRenderParams_swigregister(SplitterRenderParams
)
5308 class HeaderButtonParams(object):
5309 """Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`"""
5310 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5311 __repr__
= _swig_repr
5312 def __init__(self
, *args
, **kwargs
):
5314 __init__(self) -> HeaderButtonParams
5316 Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`
5318 _gdi_
.HeaderButtonParams_swiginit(self
,_gdi_
.new_HeaderButtonParams(*args
, **kwargs
))
5319 __swig_destroy__
= _gdi_
.delete_HeaderButtonParams
5320 __del__
= lambda self
: None;
5321 m_arrowColour
= property(_gdi_
.HeaderButtonParams_m_arrowColour_get
, _gdi_
.HeaderButtonParams_m_arrowColour_set
)
5322 m_selectionColour
= property(_gdi_
.HeaderButtonParams_m_selectionColour_get
, _gdi_
.HeaderButtonParams_m_selectionColour_set
)
5323 m_labelText
= property(_gdi_
.HeaderButtonParams_m_labelText_get
, _gdi_
.HeaderButtonParams_m_labelText_set
)
5324 m_labelFont
= property(_gdi_
.HeaderButtonParams_m_labelFont_get
, _gdi_
.HeaderButtonParams_m_labelFont_set
)
5325 m_labelColour
= property(_gdi_
.HeaderButtonParams_m_labelColour_get
, _gdi_
.HeaderButtonParams_m_labelColour_set
)
5326 m_labelBitmap
= property(_gdi_
.HeaderButtonParams_m_labelBitmap_get
, _gdi_
.HeaderButtonParams_m_labelBitmap_set
)
5327 m_labelAlignment
= property(_gdi_
.HeaderButtonParams_m_labelAlignment_get
, _gdi_
.HeaderButtonParams_m_labelAlignment_set
)
5328 _gdi_
.HeaderButtonParams_swigregister(HeaderButtonParams
)
5330 HDR_SORT_ICON_NONE
= _gdi_
.HDR_SORT_ICON_NONE
5331 HDR_SORT_ICON_UP
= _gdi_
.HDR_SORT_ICON_UP
5332 HDR_SORT_ICON_DOWN
= _gdi_
.HDR_SORT_ICON_DOWN
5333 class RendererVersion(object):
5335 This simple struct represents the `wx.RendererNative` interface
5336 version and is only used as the return value of
5337 `wx.RendererNative.GetVersion`.
5339 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5340 __repr__
= _swig_repr
5341 def __init__(self
, *args
, **kwargs
):
5343 __init__(self, int version_, int age_) -> RendererVersion
5345 This simple struct represents the `wx.RendererNative` interface
5346 version and is only used as the return value of
5347 `wx.RendererNative.GetVersion`.
5349 _gdi_
.RendererVersion_swiginit(self
,_gdi_
.new_RendererVersion(*args
, **kwargs
))
5350 __swig_destroy__
= _gdi_
.delete_RendererVersion
5351 __del__
= lambda self
: None;
5352 Current_Version
= _gdi_
.RendererVersion_Current_Version
5353 Current_Age
= _gdi_
.RendererVersion_Current_Age
5354 def IsCompatible(*args
, **kwargs
):
5355 """IsCompatible(RendererVersion ver) -> bool"""
5356 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
5358 IsCompatible
= staticmethod(IsCompatible
)
5359 version
= property(_gdi_
.RendererVersion_version_get
)
5360 age
= property(_gdi_
.RendererVersion_age_get
)
5361 _gdi_
.RendererVersion_swigregister(RendererVersion
)
5363 def RendererVersion_IsCompatible(*args
, **kwargs
):
5364 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5365 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
5367 class RendererNative(object):
5369 One of the design principles of wxWidgets is to use the native
5370 widgets on every platform in order to be as close as possible to
5371 the native look and feel on every platform. However there are
5372 still cases when some generic widgets are needed for various
5373 reasons, but it can sometimes take a lot of messy work to make
5374 them conform to the native LnF.
5376 The wx.RendererNative class is a collection of functions that have
5377 platform-specific implementations for drawing certain parts of
5378 genereic controls in ways that are as close to the native look as
5381 Note that each drawing function restores the `wx.DC` attributes if it
5382 changes them, so it is safe to assume that the same pen, brush and
5383 colours that were active before the call to this function are still in
5387 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5388 def __init__(self
): raise AttributeError, "No constructor defined"
5389 __repr__
= _swig_repr
5390 def DrawHeaderButton(*args
, **kwargs
):
5392 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE,
5393 HeaderButtonParams params=None)
5395 Draw the header control button (such as what is used by `wx.ListCtrl`
5398 return _gdi_
.RendererNative_DrawHeaderButton(*args
, **kwargs
)
5400 def DrawHeaderButtonContents(*args
, **kwargs
):
5402 DrawHeaderButtonContents(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE,
5403 HeaderButtonParams params=None)
5405 Draw the contents of a header control button, (label, sort
5406 arrows, etc.) Normally this is only called by `DrawHeaderButton`.
5408 return _gdi_
.RendererNative_DrawHeaderButtonContents(*args
, **kwargs
)
5410 def GetHeaderButtonHeight(*args
, **kwargs
):
5412 GetHeaderButtonHeight(self, Window win) -> int
5414 Returns the default height of a header button, either a fixed platform
5415 height if available, or a generic height based on the window's font.
5417 return _gdi_
.RendererNative_GetHeaderButtonHeight(*args
, **kwargs
)
5419 def DrawTreeItemButton(*args
, **kwargs
):
5421 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5423 Draw the expanded/collapsed icon for a tree control item.
5425 return _gdi_
.RendererNative_DrawTreeItemButton(*args
, **kwargs
)
5427 def DrawSplitterBorder(*args
, **kwargs
):
5429 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5431 Draw the border for a sash window: this border must be such that the
5432 sash drawn by `DrawSplitterSash` blends into it well.
5434 return _gdi_
.RendererNative_DrawSplitterBorder(*args
, **kwargs
)
5436 def DrawSplitterSash(*args
, **kwargs
):
5438 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5441 Draw a sash. The orient parameter defines whether the sash should be
5442 vertical or horizontal and how the position should be interpreted.
5444 return _gdi_
.RendererNative_DrawSplitterSash(*args
, **kwargs
)
5446 def DrawComboBoxDropButton(*args
, **kwargs
):
5448 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5450 Draw a button like the one used by `wx.ComboBox` to show a drop down
5451 window. The usual appearance is a downwards pointing arrow.
5453 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5454 ``wx.CONTROL_CURRENT`` bits set.
5456 return _gdi_
.RendererNative_DrawComboBoxDropButton(*args
, **kwargs
)
5458 def DrawDropArrow(*args
, **kwargs
):
5460 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5462 Draw a drop down arrow that is suitable for use outside a combo
5463 box. Arrow will have a transparent background.
5465 ``rect`` is not entirely filled by the arrow. Instead, you should use
5466 bounding rectangle of a drop down button which arrow matches the size
5467 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5468 ``wx.CONTROL_CURRENT`` bit set.
5470 return _gdi_
.RendererNative_DrawDropArrow(*args
, **kwargs
)
5472 def DrawCheckBox(*args
, **kwargs
):
5474 DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0)
5476 Draw a check button. Flags may use wx.CONTROL_CHECKED,
5477 wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.
5479 return _gdi_
.RendererNative_DrawCheckBox(*args
, **kwargs
)
5481 def DrawPushButton(*args
, **kwargs
):
5483 DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0)
5485 Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
5486 wx.CONTROL_ISDEFAULT
5488 return _gdi_
.RendererNative_DrawPushButton(*args
, **kwargs
)
5490 def DrawItemSelectionRect(*args
, **kwargs
):
5492 DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0)
5494 Draw rectangle indicating that an item in e.g. a list control has been
5497 The flags parameter may be:
5499 ==================== ============================================
5500 wx.CONTROL_SELECTED item is selected, e.g. draw background
5501 wx.CONTROL_CURRENT item is the current item, e.g. dotted border
5502 wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
5503 background vs. grey otherwise
5504 ==================== ============================================
5507 return _gdi_
.RendererNative_DrawItemSelectionRect(*args
, **kwargs
)
5509 def GetSplitterParams(*args
, **kwargs
):
5511 GetSplitterParams(self, Window win) -> SplitterRenderParams
5513 Get the splitter parameters, see `wx.SplitterRenderParams`.
5515 return _gdi_
.RendererNative_GetSplitterParams(*args
, **kwargs
)
5517 def Get(*args
, **kwargs
):
5519 Get() -> RendererNative
5521 Return the currently used renderer
5523 return _gdi_
.RendererNative_Get(*args
, **kwargs
)
5525 Get
= staticmethod(Get
)
5526 def GetGeneric(*args
, **kwargs
):
5528 GetGeneric() -> RendererNative
5530 Return the generic implementation of the renderer. Under some
5531 platforms, this is the default renderer implementation, others have
5532 platform-specific default renderer which can be retrieved by calling
5533 `wx.RendererNative.GetDefault`.
5535 return _gdi_
.RendererNative_GetGeneric(*args
, **kwargs
)
5537 GetGeneric
= staticmethod(GetGeneric
)
5538 def GetDefault(*args
, **kwargs
):
5540 GetDefault() -> RendererNative
5542 Return the default (native) implementation for this platform -- this
5543 is also the one used by default but this may be changed by calling
5544 `wx.RendererNative.Set` in which case the return value of this method
5545 may be different from the return value of `wx.RendererNative.Get`.
5547 return _gdi_
.RendererNative_GetDefault(*args
, **kwargs
)
5549 GetDefault
= staticmethod(GetDefault
)
5550 def Set(*args
, **kwargs
):
5552 Set(RendererNative renderer) -> RendererNative
5554 Set the renderer to use, passing None reverts to using the default
5555 renderer. Returns the previous renderer used with Set or None.
5557 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
5559 Set
= staticmethod(Set
)
5560 def GetVersion(*args
, **kwargs
):
5562 GetVersion(self) -> RendererVersion
5564 Returns the version of the renderer. Will be used for ensuring
5565 compatibility of dynamically loaded renderers.
5567 return _gdi_
.RendererNative_GetVersion(*args
, **kwargs
)
5569 SplitterParams
= property(GetSplitterParams
,doc
="See `GetSplitterParams`")
5570 Version
= property(GetVersion
,doc
="See `GetVersion`")
5571 _gdi_
.RendererNative_swigregister(RendererNative
)
5573 def RendererNative_Get(*args
):
5575 RendererNative_Get() -> RendererNative
5577 Return the currently used renderer
5579 return _gdi_
.RendererNative_Get(*args
)
5581 def RendererNative_GetGeneric(*args
):
5583 RendererNative_GetGeneric() -> RendererNative
5585 Return the generic implementation of the renderer. Under some
5586 platforms, this is the default renderer implementation, others have
5587 platform-specific default renderer which can be retrieved by calling
5588 `wx.RendererNative.GetDefault`.
5590 return _gdi_
.RendererNative_GetGeneric(*args
)
5592 def RendererNative_GetDefault(*args
):
5594 RendererNative_GetDefault() -> RendererNative
5596 Return the default (native) implementation for this platform -- this
5597 is also the one used by default but this may be changed by calling
5598 `wx.RendererNative.Set` in which case the return value of this method
5599 may be different from the return value of `wx.RendererNative.Get`.
5601 return _gdi_
.RendererNative_GetDefault(*args
)
5603 def RendererNative_Set(*args
, **kwargs
):
5605 RendererNative_Set(RendererNative renderer) -> RendererNative
5607 Set the renderer to use, passing None reverts to using the default
5608 renderer. Returns the previous renderer used with Set or None.
5610 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
5612 #---------------------------------------------------------------------------
5614 class PseudoDC(_core
.Object
):
5616 A PseudoDC is an object that can be used as if it were a `wx.DC`. All
5617 commands issued to the PseudoDC are stored in a list. You can then
5618 play these commands back to a real DC object using the DrawToDC
5619 method. Commands in the command list are indexed by ID. You can use
5620 this to clear the operations associated with a single ID and then
5621 re-draw the object associated with that ID.
5623 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5624 __repr__
= _swig_repr
5625 def __init__(self
, *args
, **kwargs
):
5627 __init__(self) -> PseudoDC
5629 Constructs a new Pseudo device context for recording dc operations
5631 _gdi_
.PseudoDC_swiginit(self
,_gdi_
.new_PseudoDC(*args
, **kwargs
))
5632 def BeginDrawing(*args
, **kwargs
):
5636 Allows for optimization of drawing code on platforms that need it. On
5637 other platforms this is just an empty function and is harmless. To
5638 take advantage of this postential optimization simply enclose each
5639 group of calls to the drawing primitives within calls to
5640 `BeginDrawing` and `EndDrawing`.
5642 return _gdi_
.PseudoDC_BeginDrawing(*args
, **kwargs
)
5644 def EndDrawing(*args
, **kwargs
):
5648 Ends the group of drawing primitives started with `BeginDrawing`, and
5649 invokes whatever optimization is available for this DC type on the
5652 return _gdi_
.PseudoDC_EndDrawing(*args
, **kwargs
)
5654 __swig_destroy__
= _gdi_
.delete_PseudoDC
5655 __del__
= lambda self
: None;
5656 def RemoveAll(*args
, **kwargs
):
5660 Removes all objects and operations from the recorded list.
5662 return _gdi_
.PseudoDC_RemoveAll(*args
, **kwargs
)
5664 def GetLen(*args
, **kwargs
):
5668 Returns the number of operations in the recorded list.
5670 return _gdi_
.PseudoDC_GetLen(*args
, **kwargs
)
5672 def SetId(*args
, **kwargs
):
5676 Sets the id to be associated with subsequent operations.
5678 return _gdi_
.PseudoDC_SetId(*args
, **kwargs
)
5680 def ClearId(*args
, **kwargs
):
5682 ClearId(self, int id)
5684 Removes all operations associated with id so the object can be redrawn.
5686 return _gdi_
.PseudoDC_ClearId(*args
, **kwargs
)
5688 def RemoveId(*args
, **kwargs
):
5690 RemoveId(self, int id)
5692 Remove the object node (and all operations) associated with an id.
5694 return _gdi_
.PseudoDC_RemoveId(*args
, **kwargs
)
5696 def TranslateId(*args
, **kwargs
):
5698 TranslateId(self, int id, int dx, int dy)
5700 Translate the operations of id by dx,dy.
5702 return _gdi_
.PseudoDC_TranslateId(*args
, **kwargs
)
5704 def DrawIdToDC(*args
, **kwargs
):
5706 DrawIdToDC(self, int id, DC dc)
5708 Draw recorded operations of id to dc.
5710 return _gdi_
.PseudoDC_DrawIdToDC(*args
, **kwargs
)
5712 def SetIdBounds(*args
, **kwargs
):
5714 SetIdBounds(self, int id, Rect rect)
5716 Set the bounding rect of a given object. This will create
5717 an object node if one doesn't exist.
5719 return _gdi_
.PseudoDC_SetIdBounds(*args
, **kwargs
)
5721 def GetIdBounds(*args
, **kwargs
):
5723 GetIdBounds(self, int id) -> Rect
5725 Returns the bounding rectangle previouly set with SetIdBounds. If
5726 no bounds have been set, it returns wx.Rect(0,0,0,0).
5728 return _gdi_
.PseudoDC_GetIdBounds(*args
, **kwargs
)
5730 def DrawToDCClipped(*args
, **kwargs
):
5732 DrawToDCClipped(self, DC dc, Rect rect)
5734 Draws the recorded operations to dc unless the operation is known to
5737 return _gdi_
.PseudoDC_DrawToDCClipped(*args
, **kwargs
)
5739 def DrawToDCClippedRgn(*args
, **kwargs
):
5741 DrawToDCClippedRgn(self, DC dc, Region region)
5743 Draws the recorded operations to dc unless the operation is known to
5746 return _gdi_
.PseudoDC_DrawToDCClippedRgn(*args
, **kwargs
)
5748 def DrawToDC(*args
, **kwargs
):
5750 DrawToDC(self, DC dc)
5752 Draws the recorded operations to dc.
5754 return _gdi_
.PseudoDC_DrawToDC(*args
, **kwargs
)
5756 def FloodFill(*args
, **kwargs
):
5758 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE)
5760 Flood fills the device context starting from the given point, using
5761 the current brush colour, and using a style:
5763 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5764 the given colour is encountered.
5766 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5769 Returns False if the operation failed.
5771 Note: The present implementation for non-Windows platforms may fail to
5772 find colour borders if the pixels do not match the colour
5773 exactly. However the function will still return true.
5775 return _gdi_
.PseudoDC_FloodFill(*args
, **kwargs
)
5777 def FloodFillPoint(*args
, **kwargs
):
5779 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE)
5781 Flood fills the device context starting from the given point, using
5782 the current brush colour, and using a style:
5784 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5785 the given colour is encountered.
5787 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5790 Returns False if the operation failed.
5792 Note: The present implementation for non-Windows platforms may fail to
5793 find colour borders if the pixels do not match the colour
5794 exactly. However the function will still return true.
5796 return _gdi_
.PseudoDC_FloodFillPoint(*args
, **kwargs
)
5798 def DrawLine(*args
, **kwargs
):
5800 DrawLine(self, int x1, int y1, int x2, int y2)
5802 Draws a line from the first point to the second. The current pen is
5803 used for drawing the line. Note that the second point is *not* part of
5804 the line and is not drawn by this function (this is consistent with
5805 the behaviour of many other toolkits).
5807 return _gdi_
.PseudoDC_DrawLine(*args
, **kwargs
)
5809 def DrawLinePoint(*args
, **kwargs
):
5811 DrawLinePoint(self, Point pt1, Point pt2)
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_DrawLinePoint(*args
, **kwargs
)
5820 def CrossHair(*args
, **kwargs
):
5822 CrossHair(self, int x, int y)
5824 Displays a cross hair using the current pen. This is a vertical and
5825 horizontal line the height and width of the window, centred on the
5828 return _gdi_
.PseudoDC_CrossHair(*args
, **kwargs
)
5830 def CrossHairPoint(*args
, **kwargs
):
5832 CrossHairPoint(self, Point pt)
5834 Displays a cross hair using the current pen. This is a vertical and
5835 horizontal line the height and width of the window, centred on the
5838 return _gdi_
.PseudoDC_CrossHairPoint(*args
, **kwargs
)
5840 def DrawArc(*args
, **kwargs
):
5842 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
5844 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5845 the first point to the second. The current pen is used for the outline
5846 and the current brush for filling the shape.
5848 The arc is drawn in an anticlockwise direction from the start point to
5851 return _gdi_
.PseudoDC_DrawArc(*args
, **kwargs
)
5853 def DrawArcPoint(*args
, **kwargs
):
5855 DrawArcPoint(self, Point pt1, Point pt2, Point center)
5857 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5858 the first point to the second. The current pen is used for the outline
5859 and the current brush for filling the shape.
5861 The arc is drawn in an anticlockwise direction from the start point to
5864 return _gdi_
.PseudoDC_DrawArcPoint(*args
, **kwargs
)
5866 def DrawCheckMark(*args
, **kwargs
):
5868 DrawCheckMark(self, int x, int y, int width, int height)
5870 Draws a check mark inside the given rectangle.
5872 return _gdi_
.PseudoDC_DrawCheckMark(*args
, **kwargs
)
5874 def DrawCheckMarkRect(*args
, **kwargs
):
5876 DrawCheckMarkRect(self, Rect rect)
5878 Draws a check mark inside the given rectangle.
5880 return _gdi_
.PseudoDC_DrawCheckMarkRect(*args
, **kwargs
)
5882 def DrawEllipticArc(*args
, **kwargs
):
5884 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
5886 Draws an arc of an ellipse, with the given rectangle defining the
5887 bounds of the ellipse. The current pen is used for drawing the arc and
5888 the current brush is used for drawing the pie.
5890 The *start* and *end* parameters specify the start and end of the arc
5891 relative to the three-o'clock position from the center of the
5892 rectangle. Angles are specified in degrees (360 is a complete
5893 circle). Positive values mean counter-clockwise motion. If start is
5894 equal to end, a complete ellipse will be drawn.
5896 return _gdi_
.PseudoDC_DrawEllipticArc(*args
, **kwargs
)
5898 def DrawEllipticArcPointSize(*args
, **kwargs
):
5900 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
5902 Draws an arc of an ellipse, with the given rectangle defining the
5903 bounds of the ellipse. The current pen is used for drawing the arc and
5904 the current brush is used for drawing the pie.
5906 The *start* and *end* parameters specify the start and end of the arc
5907 relative to the three-o'clock position from the center of the
5908 rectangle. Angles are specified in degrees (360 is a complete
5909 circle). Positive values mean counter-clockwise motion. If start is
5910 equal to end, a complete ellipse will be drawn.
5912 return _gdi_
.PseudoDC_DrawEllipticArcPointSize(*args
, **kwargs
)
5914 def DrawPoint(*args
, **kwargs
):
5916 DrawPoint(self, int x, int y)
5918 Draws a point using the current pen.
5920 return _gdi_
.PseudoDC_DrawPoint(*args
, **kwargs
)
5922 def DrawPointPoint(*args
, **kwargs
):
5924 DrawPointPoint(self, Point pt)
5926 Draws a point using the current pen.
5928 return _gdi_
.PseudoDC_DrawPointPoint(*args
, **kwargs
)
5930 def DrawRectangle(*args
, **kwargs
):
5932 DrawRectangle(self, int x, int y, int width, int height)
5934 Draws a rectangle with the given top left corner, and with the given
5935 size. The current pen is used for the outline and the current brush
5936 for filling the shape.
5938 return _gdi_
.PseudoDC_DrawRectangle(*args
, **kwargs
)
5940 def DrawRectangleRect(*args
, **kwargs
):
5942 DrawRectangleRect(self, Rect rect)
5944 Draws a rectangle with the given top left corner, and with the given
5945 size. The current pen is used for the outline and the current brush
5946 for filling the shape.
5948 return _gdi_
.PseudoDC_DrawRectangleRect(*args
, **kwargs
)
5950 def DrawRectanglePointSize(*args
, **kwargs
):
5952 DrawRectanglePointSize(self, Point pt, Size sz)
5954 Draws a rectangle with the given top left corner, and with the given
5955 size. The current pen is used for the outline and the current brush
5956 for filling the shape.
5958 return _gdi_
.PseudoDC_DrawRectanglePointSize(*args
, **kwargs
)
5960 def DrawRoundedRectangle(*args
, **kwargs
):
5962 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
5964 Draws a rectangle with the given top left corner, and with the given
5965 size. The corners are quarter-circles using the given radius. The
5966 current pen is used for the outline and the current brush for filling
5969 If radius is positive, the value is assumed to be the radius of the
5970 rounded corner. If radius is negative, the absolute value is assumed
5971 to be the proportion of the smallest dimension of the rectangle. This
5972 means that the corner can be a sensible size relative to the size of
5973 the rectangle, and also avoids the strange effects X produces when the
5974 corners are too big for the rectangle.
5976 return _gdi_
.PseudoDC_DrawRoundedRectangle(*args
, **kwargs
)
5978 def DrawRoundedRectangleRect(*args
, **kwargs
):
5980 DrawRoundedRectangleRect(self, Rect r, double radius)
5982 Draws a rectangle with the given top left corner, and with the given
5983 size. The corners are quarter-circles using the given radius. The
5984 current pen is used for the outline and the current brush for filling
5987 If radius is positive, the value is assumed to be the radius of the
5988 rounded corner. If radius is negative, the absolute value is assumed
5989 to be the proportion of the smallest dimension of the rectangle. This
5990 means that the corner can be a sensible size relative to the size of
5991 the rectangle, and also avoids the strange effects X produces when the
5992 corners are too big for the rectangle.
5994 return _gdi_
.PseudoDC_DrawRoundedRectangleRect(*args
, **kwargs
)
5996 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
5998 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
6000 Draws a rectangle with the given top left corner, and with the given
6001 size. The corners are quarter-circles using the given radius. The
6002 current pen is used for the outline and the current brush for filling
6005 If radius is positive, the value is assumed to be the radius of the
6006 rounded corner. If radius is negative, the absolute value is assumed
6007 to be the proportion of the smallest dimension of the rectangle. This
6008 means that the corner can be a sensible size relative to the size of
6009 the rectangle, and also avoids the strange effects X produces when the
6010 corners are too big for the rectangle.
6012 return _gdi_
.PseudoDC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
6014 def DrawCircle(*args
, **kwargs
):
6016 DrawCircle(self, int x, int y, int radius)
6018 Draws a circle with the given center point and radius. The current
6019 pen is used for the outline and the current brush for filling the
6022 return _gdi_
.PseudoDC_DrawCircle(*args
, **kwargs
)
6024 def DrawCirclePoint(*args
, **kwargs
):
6026 DrawCirclePoint(self, Point pt, int radius)
6028 Draws a circle with the given center point and radius. The current
6029 pen is used for the outline and the current brush for filling the
6032 return _gdi_
.PseudoDC_DrawCirclePoint(*args
, **kwargs
)
6034 def DrawEllipse(*args
, **kwargs
):
6036 DrawEllipse(self, int x, int y, int width, int height)
6038 Draws an ellipse contained in the specified rectangle. The current pen
6039 is used for the outline and the current brush for filling the shape.
6041 return _gdi_
.PseudoDC_DrawEllipse(*args
, **kwargs
)
6043 def DrawEllipseRect(*args
, **kwargs
):
6045 DrawEllipseRect(self, Rect rect)
6047 Draws an ellipse contained in the specified rectangle. The current pen
6048 is used for the outline and the current brush for filling the shape.
6050 return _gdi_
.PseudoDC_DrawEllipseRect(*args
, **kwargs
)
6052 def DrawEllipsePointSize(*args
, **kwargs
):
6054 DrawEllipsePointSize(self, Point pt, Size sz)
6056 Draws an ellipse contained in the specified rectangle. The current pen
6057 is used for the outline and the current brush for filling the shape.
6059 return _gdi_
.PseudoDC_DrawEllipsePointSize(*args
, **kwargs
)
6061 def DrawIcon(*args
, **kwargs
):
6063 DrawIcon(self, Icon icon, int x, int y)
6065 Draw an icon on the display (does nothing if the device context is
6066 PostScript). This can be the simplest way of drawing bitmaps on a
6069 return _gdi_
.PseudoDC_DrawIcon(*args
, **kwargs
)
6071 def DrawIconPoint(*args
, **kwargs
):
6073 DrawIconPoint(self, Icon icon, Point pt)
6075 Draw an icon on the display (does nothing if the device context is
6076 PostScript). This can be the simplest way of drawing bitmaps on a
6079 return _gdi_
.PseudoDC_DrawIconPoint(*args
, **kwargs
)
6081 def DrawBitmap(*args
, **kwargs
):
6083 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
6085 Draw a bitmap on the device context at the specified point. If
6086 *transparent* is true and the bitmap has a transparency mask, (or
6087 alpha channel on the platforms that support it) then the bitmap will
6088 be drawn transparently.
6090 return _gdi_
.PseudoDC_DrawBitmap(*args
, **kwargs
)
6092 def DrawBitmapPoint(*args
, **kwargs
):
6094 DrawBitmapPoint(self, Bitmap bmp, Point pt, 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_DrawBitmapPoint(*args
, **kwargs
)
6103 def DrawText(*args
, **kwargs
):
6105 DrawText(self, String text, int x, int y)
6107 Draws a text string at the specified point, using the current text
6108 font, and the current text foreground and background colours.
6110 The coordinates refer to the top-left corner of the rectangle bounding
6111 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6112 a text string, which can be used to position the text more precisely,
6113 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6116 **NOTE**: under wxGTK the current logical function is used by this
6117 function but it is ignored by wxMSW. Thus, you should avoid using
6118 logical functions with this function in portable programs.
6120 return _gdi_
.PseudoDC_DrawText(*args
, **kwargs
)
6122 def DrawTextPoint(*args
, **kwargs
):
6124 DrawTextPoint(self, String text, Point pt)
6126 Draws a text string at the specified point, using the current text
6127 font, and the current text foreground and background colours.
6129 The coordinates refer to the top-left corner of the rectangle bounding
6130 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6131 a text string, which can be used to position the text more precisely,
6132 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6135 **NOTE**: under wxGTK the current logical function is used by this
6136 function but it is ignored by wxMSW. Thus, you should avoid using
6137 logical functions with this function in portable programs.
6139 return _gdi_
.PseudoDC_DrawTextPoint(*args
, **kwargs
)
6141 def DrawRotatedText(*args
, **kwargs
):
6143 DrawRotatedText(self, String text, int x, int y, double angle)
6145 Draws the text rotated by *angle* degrees, if supported by the platform.
6147 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6148 function. In particular, a font different from ``wx.NORMAL_FONT``
6149 should be used as the it is not normally a TrueType
6150 font. ``wx.SWISS_FONT`` is an example of a font which is.
6152 return _gdi_
.PseudoDC_DrawRotatedText(*args
, **kwargs
)
6154 def DrawRotatedTextPoint(*args
, **kwargs
):
6156 DrawRotatedTextPoint(self, String text, Point pt, double angle)
6158 Draws the text rotated by *angle* degrees, if supported by the platform.
6160 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6161 function. In particular, a font different from ``wx.NORMAL_FONT``
6162 should be used as the it is not normally a TrueType
6163 font. ``wx.SWISS_FONT`` is an example of a font which is.
6165 return _gdi_
.PseudoDC_DrawRotatedTextPoint(*args
, **kwargs
)
6167 def DrawLines(*args
, **kwargs
):
6169 DrawLines(self, List points, int xoffset=0, int yoffset=0)
6171 Draws lines using a sequence of `wx.Point` objects, adding the
6172 optional offset coordinate. The current pen is used for drawing the
6175 return _gdi_
.PseudoDC_DrawLines(*args
, **kwargs
)
6177 def DrawPolygon(*args
, **kwargs
):
6179 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
6180 int fillStyle=ODDEVEN_RULE)
6182 Draws a filled polygon using a sequence of `wx.Point` objects, adding
6183 the optional offset coordinate. The last argument specifies the fill
6184 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
6186 The current pen is used for drawing the outline, and the current brush
6187 for filling the shape. Using a transparent brush suppresses
6188 filling. Note that wxWidgets automatically closes the first and last
6191 return _gdi_
.PseudoDC_DrawPolygon(*args
, **kwargs
)
6193 def DrawLabel(*args
, **kwargs
):
6195 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6198 Draw *text* within the specified rectangle, abiding by the alignment
6199 flags. Will additionally emphasize the character at *indexAccel* if
6202 return _gdi_
.PseudoDC_DrawLabel(*args
, **kwargs
)
6204 def DrawImageLabel(*args
, **kwargs
):
6206 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6209 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
6210 drawing it) within the specified rectangle, abiding by the alignment
6211 flags. Will additionally emphasize the character at *indexAccel* if
6214 return _gdi_
.PseudoDC_DrawImageLabel(*args
, **kwargs
)
6216 def DrawSpline(*args
, **kwargs
):
6218 DrawSpline(self, List points)
6220 Draws a spline between all given control points, (a list of `wx.Point`
6221 objects) using the current pen. The spline is drawn using a series of
6222 lines, using an algorithm taken from the X drawing program 'XFIG'.
6224 return _gdi_
.PseudoDC_DrawSpline(*args
, **kwargs
)
6226 def Clear(*args
, **kwargs
):
6230 Clears the device context using the current background brush.
6232 return _gdi_
.PseudoDC_Clear(*args
, **kwargs
)
6234 def SetFont(*args
, **kwargs
):
6236 SetFont(self, Font font)
6238 Sets the current font for the DC. It must be a valid font, in
6239 particular you should not pass ``wx.NullFont`` to this method.
6241 return _gdi_
.PseudoDC_SetFont(*args
, **kwargs
)
6243 def SetPen(*args
, **kwargs
):
6245 SetPen(self, Pen pen)
6247 Sets the current pen for the DC.
6249 If the argument is ``wx.NullPen``, the current pen is selected out of the
6250 device context, and the original pen restored.
6252 return _gdi_
.PseudoDC_SetPen(*args
, **kwargs
)
6254 def SetBrush(*args
, **kwargs
):
6256 SetBrush(self, Brush brush)
6258 Sets the current brush for the DC.
6260 If the argument is ``wx.NullBrush``, the current brush is selected out
6261 of the device context, and the original brush restored, allowing the
6262 current brush to be destroyed safely.
6264 return _gdi_
.PseudoDC_SetBrush(*args
, **kwargs
)
6266 def SetBackground(*args
, **kwargs
):
6268 SetBackground(self, Brush brush)
6270 Sets the current background brush for the DC.
6272 return _gdi_
.PseudoDC_SetBackground(*args
, **kwargs
)
6274 def SetBackgroundMode(*args
, **kwargs
):
6276 SetBackgroundMode(self, int mode)
6278 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
6279 determines whether text will be drawn with a background colour or
6282 return _gdi_
.PseudoDC_SetBackgroundMode(*args
, **kwargs
)
6284 def SetPalette(*args
, **kwargs
):
6286 SetPalette(self, Palette palette)
6288 If this is a window DC or memory DC, assigns the given palette to the
6289 window or bitmap associated with the DC. If the argument is
6290 ``wx.NullPalette``, the current palette is selected out of the device
6291 context, and the original palette restored.
6293 return _gdi_
.PseudoDC_SetPalette(*args
, **kwargs
)
6295 def SetTextForeground(*args
, **kwargs
):
6297 SetTextForeground(self, Colour colour)
6299 Sets the current text foreground colour for the DC.
6301 return _gdi_
.PseudoDC_SetTextForeground(*args
, **kwargs
)
6303 def SetTextBackground(*args
, **kwargs
):
6305 SetTextBackground(self, Colour colour)
6307 Sets the current text background colour for the DC.
6309 return _gdi_
.PseudoDC_SetTextBackground(*args
, **kwargs
)
6311 def SetLogicalFunction(*args
, **kwargs
):
6313 SetLogicalFunction(self, int function)
6315 Sets the current logical function for the device context. This
6316 determines how a source pixel (from a pen or brush colour, combines
6317 with a destination pixel in the current device context.
6319 The possible values and their meaning in terms of source and
6320 destination pixel values are as follows:
6322 ================ ==========================
6324 wx.AND_INVERT (NOT src) AND dst
6325 wx.AND_REVERSE src AND (NOT dst)
6328 wx.EQUIV (NOT src) XOR dst
6330 wx.NAND (NOT src) OR (NOT dst)
6331 wx.NOR (NOT src) AND (NOT dst)
6334 wx.OR_INVERT (NOT src) OR dst
6335 wx.OR_REVERSE src OR (NOT dst)
6337 wx.SRC_INVERT NOT src
6339 ================ ==========================
6341 The default is wx.COPY, which simply draws with the current
6342 colour. The others combine the current colour and the background using
6343 a logical operation. wx.INVERT is commonly used for drawing rubber
6344 bands or moving outlines, since drawing twice reverts to the original
6348 return _gdi_
.PseudoDC_SetLogicalFunction(*args
, **kwargs
)
6350 IdBounds
= property(GetIdBounds
,SetIdBounds
,doc
="See `GetIdBounds` and `SetIdBounds`")
6351 Len
= property(GetLen
,doc
="See `GetLen`")
6352 _gdi_
.PseudoDC_swigregister(PseudoDC
)