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 IsOk(*args
, **kwargs
):
153 Returns True if the colour object is valid (the colour has been
154 initialised with RGB values).
156 return _gdi_
.Colour_IsOk(*args
, **kwargs
)
159 def Set(*args
, **kwargs
):
161 Set(self, byte red, byte green, byte blue, byte alpha=ALPHA_OPAQUE)
163 Sets the RGB intensity values.
165 return _gdi_
.Colour_Set(*args
, **kwargs
)
167 def SetRGB(*args
, **kwargs
):
169 SetRGB(self, unsigned long colRGB)
171 Sets the RGB intensity values from a packed RGB value.
173 return _gdi_
.Colour_SetRGB(*args
, **kwargs
)
175 def SetFromName(*args
, **kwargs
):
177 SetFromName(self, String colourName)
179 Sets the RGB intensity values using a colour name listed in
180 ``wx.TheColourDatabase``.
182 return _gdi_
.Colour_SetFromName(*args
, **kwargs
)
184 def GetAsString(*args
, **kwargs
):
186 GetAsString(self, long flags=wxC2S_NAME|wxC2S_CSS_SYNTAX) -> String
188 Return the colour as a string. Acceptable flags are:
190 =================== ==================================
191 wx.C2S_NAME return colour name, when possible
192 wx.C2S_CSS_SYNTAX return colour in rgb(r,g,b) syntax
193 wx.C2S_HTML_SYNTAX return colour in #rrggbb syntax
194 =================== ==================================
196 return _gdi_
.Colour_GetAsString(*args
, **kwargs
)
198 def GetPixel(*args
, **kwargs
):
200 GetPixel(self) -> long
202 Returns a pixel value which is platform-dependent. On Windows, a
203 COLORREF is returned. On X, an allocated pixel value is returned. -1
204 is returned if the pixel is invalid (on X, unallocated).
206 return _gdi_
.Colour_GetPixel(*args
, **kwargs
)
208 def __eq__(*args
, **kwargs
):
210 __eq__(self, PyObject other) -> bool
212 Compare colours for equality.
214 return _gdi_
.Colour___eq__(*args
, **kwargs
)
216 def __ne__(*args
, **kwargs
):
218 __ne__(self, PyObject other) -> bool
220 Compare colours for inequality.
222 return _gdi_
.Colour___ne__(*args
, **kwargs
)
224 def Get(*args
, **kwargs
):
228 Returns the RGB intensity values as a tuple.
230 return _gdi_
.Colour_Get(*args
, **kwargs
)
232 def GetRGB(*args
, **kwargs
):
234 GetRGB(self) -> unsigned long
236 Return the colour as a packed RGB value
238 return _gdi_
.Colour_GetRGB(*args
, **kwargs
)
240 asTuple
= wx
._deprecated
(Get
, "asTuple is deprecated, use `Get` instead")
241 def __str__(self
): return str(self
.Get(True))
242 def __repr__(self
): return 'wx.Colour' + str(self
.Get(True))
243 def __len__(self
): return len(self
.Get())
244 def __getitem__(self
, index
): return self
.Get()[index
]
245 def __nonzero__(self
): return self
.IsOk()
246 __safe_for_unpickling__
= True
247 def __reduce__(self
): return (Colour
, self
.Get(True))
249 Pixel
= property(GetPixel
,doc
="See `GetPixel`")
250 RGB
= property(GetRGB
,SetRGB
,doc
="See `GetRGB` and `SetRGB`")
251 _gdi_
.Colour_swigregister(Colour
)
253 def NamedColour(*args
, **kwargs
):
255 NamedColour(String colorName) -> Colour
257 Constructs a colour object using a colour name listed in
258 ``wx.TheColourDatabase``.
260 val
= _gdi_
.new_NamedColour(*args
, **kwargs
)
263 def ColourRGB(*args
, **kwargs
):
265 ColourRGB(unsigned long colRGB) -> Colour
267 Constructs a colour from a packed RGB value.
269 val
= _gdi_
.new_ColourRGB(*args
, **kwargs
)
273 NamedColor
= NamedColour
276 class Palette(GDIObject
):
277 """Proxy of C++ Palette class"""
278 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
279 __repr__
= _swig_repr
280 def __init__(self
, *args
, **kwargs
):
281 """__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette"""
282 _gdi_
.Palette_swiginit(self
,_gdi_
.new_Palette(*args
, **kwargs
))
283 __swig_destroy__
= _gdi_
.delete_Palette
284 __del__
= lambda self
: None;
285 def GetPixel(*args
, **kwargs
):
286 """GetPixel(self, byte red, byte green, byte blue) -> int"""
287 return _gdi_
.Palette_GetPixel(*args
, **kwargs
)
289 def GetRGB(*args
, **kwargs
):
290 """GetRGB(self, int pixel) -> (R,G,B)"""
291 return _gdi_
.Palette_GetRGB(*args
, **kwargs
)
293 def GetColoursCount(*args
, **kwargs
):
294 """GetColoursCount(self) -> int"""
295 return _gdi_
.Palette_GetColoursCount(*args
, **kwargs
)
297 def IsOk(*args
, **kwargs
):
298 """IsOk(self) -> bool"""
299 return _gdi_
.Palette_IsOk(*args
, **kwargs
)
302 def __nonzero__(self
): return self
.IsOk()
303 ColoursCount
= property(GetColoursCount
,doc
="See `GetColoursCount`")
304 _gdi_
.Palette_swigregister(Palette
)
306 #---------------------------------------------------------------------------
308 class Pen(GDIObject
):
309 """Proxy of C++ Pen class"""
310 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
311 __repr__
= _swig_repr
312 def __init__(self
, *args
, **kwargs
):
313 """__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen"""
314 _gdi_
.Pen_swiginit(self
,_gdi_
.new_Pen(*args
, **kwargs
))
315 __swig_destroy__
= _gdi_
.delete_Pen
316 __del__
= lambda self
: None;
317 def GetCap(*args
, **kwargs
):
318 """GetCap(self) -> int"""
319 return _gdi_
.Pen_GetCap(*args
, **kwargs
)
321 def GetColour(*args
, **kwargs
):
322 """GetColour(self) -> Colour"""
323 return _gdi_
.Pen_GetColour(*args
, **kwargs
)
325 def GetJoin(*args
, **kwargs
):
326 """GetJoin(self) -> int"""
327 return _gdi_
.Pen_GetJoin(*args
, **kwargs
)
329 def GetStyle(*args
, **kwargs
):
330 """GetStyle(self) -> int"""
331 return _gdi_
.Pen_GetStyle(*args
, **kwargs
)
333 def GetWidth(*args
, **kwargs
):
334 """GetWidth(self) -> int"""
335 return _gdi_
.Pen_GetWidth(*args
, **kwargs
)
337 def IsOk(*args
, **kwargs
):
338 """IsOk(self) -> bool"""
339 return _gdi_
.Pen_IsOk(*args
, **kwargs
)
342 def SetCap(*args
, **kwargs
):
343 """SetCap(self, int cap_style)"""
344 return _gdi_
.Pen_SetCap(*args
, **kwargs
)
346 def SetColour(*args
, **kwargs
):
347 """SetColour(self, Colour colour)"""
348 return _gdi_
.Pen_SetColour(*args
, **kwargs
)
350 def SetJoin(*args
, **kwargs
):
351 """SetJoin(self, int join_style)"""
352 return _gdi_
.Pen_SetJoin(*args
, **kwargs
)
354 def SetStyle(*args
, **kwargs
):
355 """SetStyle(self, int style)"""
356 return _gdi_
.Pen_SetStyle(*args
, **kwargs
)
358 def SetWidth(*args
, **kwargs
):
359 """SetWidth(self, int width)"""
360 return _gdi_
.Pen_SetWidth(*args
, **kwargs
)
362 def SetDashes(*args
, **kwargs
):
363 """SetDashes(self, int dashes)"""
364 return _gdi_
.Pen_SetDashes(*args
, **kwargs
)
366 def GetDashes(*args
, **kwargs
):
367 """GetDashes(self) -> PyObject"""
368 return _gdi_
.Pen_GetDashes(*args
, **kwargs
)
370 def _SetDashes(*args
, **kwargs
):
371 """_SetDashes(self, PyObject _self, PyObject pyDashes)"""
372 return _gdi_
.Pen__SetDashes(*args
, **kwargs
)
374 def SetDashes(self
, dashes
):
376 Associate a list of dash lengths with the Pen.
378 self
._SetDashes
(self
, dashes
)
380 def __eq__(*args
, **kwargs
):
381 """__eq__(self, Pen other) -> bool"""
382 return _gdi_
.Pen___eq__(*args
, **kwargs
)
384 def __ne__(*args
, **kwargs
):
385 """__ne__(self, Pen other) -> bool"""
386 return _gdi_
.Pen___ne__(*args
, **kwargs
)
388 def __nonzero__(self
): return self
.IsOk()
389 Cap
= property(GetCap
,SetCap
,doc
="See `GetCap` and `SetCap`")
390 Colour
= property(GetColour
,SetColour
,doc
="See `GetColour` and `SetColour`")
391 Dashes
= property(GetDashes
,SetDashes
,doc
="See `GetDashes` and `SetDashes`")
392 Join
= property(GetJoin
,SetJoin
,doc
="See `GetJoin` and `SetJoin`")
393 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
394 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
395 _gdi_
.Pen_swigregister(Pen
)
397 #---------------------------------------------------------------------------
399 class Brush(GDIObject
):
401 A brush is a drawing tool for filling in areas. It is used for
402 painting the background of rectangles, ellipses, etc. when drawing on
403 a `wx.DC`. It has a colour and a style.
405 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
406 __repr__
= _swig_repr
407 def __init__(self
, *args
, **kwargs
):
409 __init__(self, Colour colour, int style=SOLID) -> Brush
411 Constructs a brush from a `wx.Colour` object and a style.
413 _gdi_
.Brush_swiginit(self
,_gdi_
.new_Brush(*args
, **kwargs
))
414 __swig_destroy__
= _gdi_
.delete_Brush
415 __del__
= lambda self
: None;
416 def SetColour(*args
, **kwargs
):
418 SetColour(self, Colour col)
420 Set the brush's `wx.Colour`.
422 return _gdi_
.Brush_SetColour(*args
, **kwargs
)
424 def SetStyle(*args
, **kwargs
):
426 SetStyle(self, int style)
428 Sets the style of the brush. See `__init__` for a listing of styles.
430 return _gdi_
.Brush_SetStyle(*args
, **kwargs
)
432 def SetStipple(*args
, **kwargs
):
434 SetStipple(self, Bitmap stipple)
436 Sets the stipple `wx.Bitmap`.
438 return _gdi_
.Brush_SetStipple(*args
, **kwargs
)
440 def GetColour(*args
, **kwargs
):
442 GetColour(self) -> Colour
444 Returns the `wx.Colour` of the brush.
446 return _gdi_
.Brush_GetColour(*args
, **kwargs
)
448 def GetStyle(*args
, **kwargs
):
450 GetStyle(self) -> int
452 Returns the style of the brush. See `__init__` for a listing of
455 return _gdi_
.Brush_GetStyle(*args
, **kwargs
)
457 def GetStipple(*args
, **kwargs
):
459 GetStipple(self) -> Bitmap
461 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
462 have a wx.STIPPLE style, then the return value may be non-None but an
463 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
465 return _gdi_
.Brush_GetStipple(*args
, **kwargs
)
467 def IsHatch(*args
, **kwargs
):
469 IsHatch(self) -> bool
471 Is the current style a hatch type?
473 return _gdi_
.Brush_IsHatch(*args
, **kwargs
)
475 def IsOk(*args
, **kwargs
):
479 Returns True if the brush is initialised and valid.
481 return _gdi_
.Brush_IsOk(*args
, **kwargs
)
484 def MacGetTheme(*args
, **kwargs
):
485 """MacGetTheme(self) -> short"""
486 return _gdi_
.Brush_MacGetTheme(*args
, **kwargs
)
488 def MacSetTheme(*args
, **kwargs
):
489 """MacSetTheme(self, short macThemeBrush)"""
490 return _gdi_
.Brush_MacSetTheme(*args
, **kwargs
)
492 def __nonzero__(self
): return self
.IsOk()
493 Colour
= property(GetColour
,SetColour
,doc
="See `GetColour` and `SetColour`")
494 Stipple
= property(GetStipple
,SetStipple
,doc
="See `GetStipple` and `SetStipple`")
495 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
496 _gdi_
.Brush_swigregister(Brush
)
498 def BrushFromBitmap(*args
, **kwargs
):
500 BrushFromBitmap(Bitmap stippleBitmap) -> Brush
502 Constructs a stippled brush using a bitmap.
504 val
= _gdi_
.new_BrushFromBitmap(*args
, **kwargs
)
507 class Bitmap(GDIObject
):
509 The wx.Bitmap class encapsulates the concept of a platform-dependent
510 bitmap. It can be either monochrome or colour, and either loaded from
511 a file or created dynamically. A bitmap can be selected into a memory
512 device context (instance of `wx.MemoryDC`). This enables the bitmap to
513 be copied to a window or memory device context using `wx.DC.Blit`, or
514 to be used as a drawing surface.
516 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
517 __repr__
= _swig_repr
518 def __init__(self
, *args
, **kwargs
):
520 __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap
522 Loads a bitmap from a file.
524 _gdi_
.Bitmap_swiginit(self
,_gdi_
.new_Bitmap(*args
, **kwargs
))
525 __swig_destroy__
= _gdi_
.delete_Bitmap
526 __del__
= lambda self
: None;
527 def IsOk(*args
, **kwargs
):
528 """IsOk(self) -> bool"""
529 return _gdi_
.Bitmap_IsOk(*args
, **kwargs
)
532 def GetWidth(*args
, **kwargs
):
534 GetWidth(self) -> int
536 Gets the width of the bitmap in pixels.
538 return _gdi_
.Bitmap_GetWidth(*args
, **kwargs
)
540 def GetHeight(*args
, **kwargs
):
542 GetHeight(self) -> int
544 Gets the height of the bitmap in pixels.
546 return _gdi_
.Bitmap_GetHeight(*args
, **kwargs
)
548 def GetDepth(*args
, **kwargs
):
550 GetDepth(self) -> int
552 Gets the colour depth of the bitmap. A value of 1 indicates a
555 return _gdi_
.Bitmap_GetDepth(*args
, **kwargs
)
557 def GetSize(*args
, **kwargs
):
559 GetSize(self) -> Size
561 Get the size of the bitmap.
563 return _gdi_
.Bitmap_GetSize(*args
, **kwargs
)
565 def ConvertToImage(*args
, **kwargs
):
567 ConvertToImage(self) -> Image
569 Creates a platform-independent image from a platform-dependent
570 bitmap. This preserves mask information so that bitmaps and images can
571 be converted back and forth without loss in that respect.
573 return _gdi_
.Bitmap_ConvertToImage(*args
, **kwargs
)
575 def GetMask(*args
, **kwargs
):
577 GetMask(self) -> Mask
579 Gets the associated mask (if any) which may have been loaded from a
580 file or explpicitly set for the bitmap.
582 :see: `SetMask`, `wx.Mask`
585 return _gdi_
.Bitmap_GetMask(*args
, **kwargs
)
587 def SetMask(*args
, **kwargs
):
589 SetMask(self, Mask mask)
591 Sets the mask for this bitmap.
593 :see: `GetMask`, `wx.Mask`
596 return _gdi_
.Bitmap_SetMask(*args
, **kwargs
)
598 def SetMaskColour(*args
, **kwargs
):
600 SetMaskColour(self, Colour colour)
602 Create a Mask based on a specified colour in the Bitmap.
604 return _gdi_
.Bitmap_SetMaskColour(*args
, **kwargs
)
606 def GetSubBitmap(*args
, **kwargs
):
608 GetSubBitmap(self, Rect rect) -> Bitmap
610 Returns a sub-bitmap of the current one as long as the rect belongs
611 entirely to the bitmap. This function preserves bit depth and mask
614 return _gdi_
.Bitmap_GetSubBitmap(*args
, **kwargs
)
616 def SaveFile(*args
, **kwargs
):
618 SaveFile(self, String name, int type, Palette palette=None) -> bool
620 Saves a bitmap in the named file. See `__init__` for a description of
621 the ``type`` parameter.
623 return _gdi_
.Bitmap_SaveFile(*args
, **kwargs
)
625 def LoadFile(*args
, **kwargs
):
627 LoadFile(self, String name, int type) -> bool
629 Loads a bitmap from a file. See `__init__` for a description of the
632 return _gdi_
.Bitmap_LoadFile(*args
, **kwargs
)
634 def GetPalette(*args
, **kwargs
):
635 """GetPalette(self) -> Palette"""
636 return _gdi_
.Bitmap_GetPalette(*args
, **kwargs
)
638 def CopyFromIcon(*args
, **kwargs
):
639 """CopyFromIcon(self, Icon icon) -> bool"""
640 return _gdi_
.Bitmap_CopyFromIcon(*args
, **kwargs
)
642 def SetHeight(*args
, **kwargs
):
644 SetHeight(self, int height)
646 Set the height property (does not affect the existing bitmap data).
648 return _gdi_
.Bitmap_SetHeight(*args
, **kwargs
)
650 def SetWidth(*args
, **kwargs
):
652 SetWidth(self, int width)
654 Set the width property (does not affect the existing bitmap data).
656 return _gdi_
.Bitmap_SetWidth(*args
, **kwargs
)
658 def SetDepth(*args
, **kwargs
):
660 SetDepth(self, int depth)
662 Set the depth property (does not affect the existing bitmap data).
664 return _gdi_
.Bitmap_SetDepth(*args
, **kwargs
)
666 def SetSize(*args
, **kwargs
):
668 SetSize(self, Size size)
670 Set the bitmap size (does not affect the existing bitmap data).
672 return _gdi_
.Bitmap_SetSize(*args
, **kwargs
)
674 def __nonzero__(self
): return self
.IsOk()
675 def __eq__(*args
, **kwargs
):
676 """__eq__(self, Bitmap other) -> bool"""
677 return _gdi_
.Bitmap___eq__(*args
, **kwargs
)
679 def __ne__(*args
, **kwargs
):
680 """__ne__(self, Bitmap other) -> bool"""
681 return _gdi_
.Bitmap___ne__(*args
, **kwargs
)
683 Depth
= property(GetDepth
,SetDepth
,doc
="See `GetDepth` and `SetDepth`")
684 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
685 Mask
= property(GetMask
,SetMask
,doc
="See `GetMask` and `SetMask`")
686 Palette
= property(GetPalette
,doc
="See `GetPalette`")
687 Size
= property(GetSize
,SetSize
,doc
="See `GetSize` and `SetSize`")
688 SubBitmap
= property(GetSubBitmap
,doc
="See `GetSubBitmap`")
689 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
690 _gdi_
.Bitmap_swigregister(Bitmap
)
692 def EmptyBitmap(*args
, **kwargs
):
694 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
696 Creates a new bitmap of the given size. A depth of -1 indicates the
697 depth of the current screen or visual. Some platforms only support 1
698 for monochrome and -1 for the current display depth.
700 val
= _gdi_
.new_EmptyBitmap(*args
, **kwargs
)
703 def BitmapFromIcon(*args
, **kwargs
):
705 BitmapFromIcon(Icon icon) -> Bitmap
707 Create a new bitmap from a `wx.Icon` object.
709 val
= _gdi_
.new_BitmapFromIcon(*args
, **kwargs
)
712 def BitmapFromImage(*args
, **kwargs
):
714 BitmapFromImage(Image image, int depth=-1) -> Bitmap
716 Creates bitmap object from a `wx.Image`. This has to be done to
717 actually display a `wx.Image` as you cannot draw an image directly on
718 a window. The resulting bitmap will use the provided colour depth (or
719 that of the current screen colour depth if depth is -1) which entails
720 that a colour reduction may have to take place.
722 val
= _gdi_
.new_BitmapFromImage(*args
, **kwargs
)
725 def BitmapFromXPMData(*args
, **kwargs
):
727 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
729 Construct a Bitmap from a list of strings formatted as XPM data.
731 val
= _gdi_
.new_BitmapFromXPMData(*args
, **kwargs
)
734 def BitmapFromBits(*args
, **kwargs
):
736 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
738 Creates a bitmap from an array of bits. You should only use this
739 function for monochrome bitmaps (depth 1) in portable programs: in
740 this case the bits parameter should contain an XBM image. For other
741 bit depths, the behaviour is platform dependent.
743 val
= _gdi_
.new_BitmapFromBits(*args
, **kwargs
)
747 def _BitmapFromBufferAlpha(*args
, **kwargs
):
748 """_BitmapFromBufferAlpha(int width, int height, buffer data, buffer alpha) -> Bitmap"""
749 return _gdi_
._BitmapFromBufferAlpha
(*args
, **kwargs
)
751 def _BitmapFromBuffer(*args
, **kwargs
):
752 """_BitmapFromBuffer(int width, int height, buffer data) -> Bitmap"""
753 return _gdi_
._BitmapFromBuffer
(*args
, **kwargs
)
754 def BitmapFromBuffer(width
, height
, dataBuffer
, alphaBuffer
=None):
756 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
757 parameter must be a Python object that implements the buffer
758 interface, such as a string, array, etc. The dataBuffer object is
759 expected to contain a series of RGB bytes and be width*height*3
760 bytes long. A buffer object can optionally be supplied for the
761 image's alpha channel data, and it is expected to be width*height
762 bytes long. On Windows the RGB values are 'premultiplied' by the
763 alpha values. (The other platforms do the multiplication
766 Unlike `wx.ImageFromBuffer` the bitmap created with this function
767 does not share the memory buffer with the buffer object. This is
768 because the native pixel buffer format varies on different
769 platforms, and so instead an efficient as possible copy of the
770 data is made from the buffer objects to the bitmap's native pixel
771 buffer. For direct access to a bitmap's pixel buffer see
772 `wx.NativePixelData` and `wx.AlphaPixelData`.
774 :see: `wx.Bitmap`, `wx.BitmapFromBufferRGBA`, `wx.NativePixelData`,
775 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
777 if alphaBuffer
is not None:
778 return _gdi_
._BitmapFromBufferAlpha
(width
, height
, dataBuffer
, alphaBuffer
)
780 return _gdi_
._BitmapFromBuffer
(width
, height
, dataBuffer
)
783 def _BitmapFromBufferRGBA(*args
, **kwargs
):
784 """_BitmapFromBufferRGBA(int width, int height, buffer data) -> Bitmap"""
785 return _gdi_
._BitmapFromBufferRGBA
(*args
, **kwargs
)
786 def BitmapFromBufferRGBA(width
, height
, dataBuffer
):
788 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
789 parameter must be a Python object that implements the buffer
790 interface, such as a string, array, etc. The dataBuffer object is
791 expected to contain a series of RGBA bytes (red, green, blue and
792 alpha) and be width*height*4 bytes long. On Windows the RGB
793 values are 'premultiplied' by the alpha values. (The other
794 platforms do the multiplication themselves.)
796 Unlike `wx.ImageFromBuffer` the bitmap created with this function
797 does not share the memory buffer with the buffer object. This is
798 because the native pixel buffer format varies on different
799 platforms, and so instead an efficient as possible copy of the
800 data is made from the buffer object to the bitmap's native pixel
801 buffer. For direct access to a bitmap's pixel buffer see
802 `wx.NativePixelData` and `wx.AlphaPixelData`.
804 :see: `wx.Bitmap`, `wx.BitmapFromBuffer`, `wx.NativePixelData`,
805 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
807 return _gdi_
._BitmapFromBufferRGBA
(width
, height
, dataBuffer
)
809 class PixelDataBase(object):
810 """Proxy of C++ PixelDataBase class"""
811 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
812 def __init__(self
): raise AttributeError, "No constructor defined"
813 __repr__
= _swig_repr
814 def GetOrigin(*args
, **kwargs
):
815 """GetOrigin(self) -> Point"""
816 return _gdi_
.PixelDataBase_GetOrigin(*args
, **kwargs
)
818 def GetWidth(*args
, **kwargs
):
819 """GetWidth(self) -> int"""
820 return _gdi_
.PixelDataBase_GetWidth(*args
, **kwargs
)
822 def GetHeight(*args
, **kwargs
):
823 """GetHeight(self) -> int"""
824 return _gdi_
.PixelDataBase_GetHeight(*args
, **kwargs
)
826 def GetSize(*args
, **kwargs
):
827 """GetSize(self) -> Size"""
828 return _gdi_
.PixelDataBase_GetSize(*args
, **kwargs
)
830 def GetRowStride(*args
, **kwargs
):
831 """GetRowStride(self) -> int"""
832 return _gdi_
.PixelDataBase_GetRowStride(*args
, **kwargs
)
834 Height
= property(GetHeight
,doc
="See `GetHeight`")
835 Origin
= property(GetOrigin
,doc
="See `GetOrigin`")
836 RowStride
= property(GetRowStride
,doc
="See `GetRowStride`")
837 Size
= property(GetSize
,doc
="See `GetSize`")
838 Width
= property(GetWidth
,doc
="See `GetWidth`")
839 _gdi_
.PixelDataBase_swigregister(PixelDataBase
)
841 class NativePixelData(PixelDataBase
):
842 """Proxy of C++ NativePixelData class"""
843 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
844 __repr__
= _swig_repr
845 def __init__(self
, *args
):
847 __init__(self, Bitmap bmp) -> NativePixelData
848 __init__(self, Bitmap bmp, Rect rect) -> NativePixelData
849 __init__(self, Bitmap bmp, Point pt, Size sz) -> NativePixelData
851 _gdi_
.NativePixelData_swiginit(self
,_gdi_
.new_NativePixelData(*args
))
852 __swig_destroy__
= _gdi_
.delete_NativePixelData
853 __del__
= lambda self
: None;
854 def GetPixels(*args
, **kwargs
):
855 """GetPixels(self) -> NativePixelData_Accessor"""
856 return _gdi_
.NativePixelData_GetPixels(*args
, **kwargs
)
858 def UseAlpha(*args
, **kwargs
):
860 return _gdi_
.NativePixelData_UseAlpha(*args
, **kwargs
)
862 def __nonzero__(*args
, **kwargs
):
863 """__nonzero__(self) -> bool"""
864 return _gdi_
.NativePixelData___nonzero__(*args
, **kwargs
)
868 Create and return an iterator object for this pixel data
869 object. (It's really a generator but I won't tell if you
872 width
= self
.GetWidth()
873 height
= self
.GetHeight()
874 pixels
= self
.GetPixels()
879 class PixelFacade(object):
882 def Set(self
, *args
, **kw
):
883 return pixels
.Set(*args
, **kw
)
885 return str(self
.Get())
887 return 'pixel(%d,%d): %s' % (x
,y
,self
.Get())
888 X
= property(lambda self
: x
)
889 Y
= property(lambda self
: y
)
892 for y
in xrange(height
):
893 for x
in xrange(width
):
899 pixels
.MoveTo(self
, 0, y
)
901 Pixels
= property(GetPixels
,doc
="See `GetPixels`")
902 _gdi_
.NativePixelData_swigregister(NativePixelData
)
904 class NativePixelData_Accessor(object):
905 """Proxy of C++ NativePixelData_Accessor class"""
906 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
907 __repr__
= _swig_repr
908 def __init__(self
, *args
):
910 __init__(self, NativePixelData data) -> NativePixelData_Accessor
911 __init__(self, Bitmap bmp, NativePixelData data) -> NativePixelData_Accessor
912 __init__(self) -> NativePixelData_Accessor
914 _gdi_
.NativePixelData_Accessor_swiginit(self
,_gdi_
.new_NativePixelData_Accessor(*args
))
915 __swig_destroy__
= _gdi_
.delete_NativePixelData_Accessor
916 __del__
= lambda self
: None;
917 def Reset(*args
, **kwargs
):
918 """Reset(self, NativePixelData data)"""
919 return _gdi_
.NativePixelData_Accessor_Reset(*args
, **kwargs
)
921 def IsOk(*args
, **kwargs
):
922 """IsOk(self) -> bool"""
923 return _gdi_
.NativePixelData_Accessor_IsOk(*args
, **kwargs
)
925 def nextPixel(*args
, **kwargs
):
926 """nextPixel(self)"""
927 return _gdi_
.NativePixelData_Accessor_nextPixel(*args
, **kwargs
)
929 def Offset(*args
, **kwargs
):
930 """Offset(self, NativePixelData data, int x, int y)"""
931 return _gdi_
.NativePixelData_Accessor_Offset(*args
, **kwargs
)
933 def OffsetX(*args
, **kwargs
):
934 """OffsetX(self, NativePixelData data, int x)"""
935 return _gdi_
.NativePixelData_Accessor_OffsetX(*args
, **kwargs
)
937 def OffsetY(*args
, **kwargs
):
938 """OffsetY(self, NativePixelData data, int y)"""
939 return _gdi_
.NativePixelData_Accessor_OffsetY(*args
, **kwargs
)
941 def MoveTo(*args
, **kwargs
):
942 """MoveTo(self, NativePixelData data, int x, int y)"""
943 return _gdi_
.NativePixelData_Accessor_MoveTo(*args
, **kwargs
)
945 def Set(*args
, **kwargs
):
946 """Set(self, byte red, byte green, byte blue)"""
947 return _gdi_
.NativePixelData_Accessor_Set(*args
, **kwargs
)
949 def Get(*args
, **kwargs
):
950 """Get(self) -> PyObject"""
951 return _gdi_
.NativePixelData_Accessor_Get(*args
, **kwargs
)
953 _gdi_
.NativePixelData_Accessor_swigregister(NativePixelData_Accessor
)
955 class AlphaPixelData(PixelDataBase
):
956 """Proxy of C++ AlphaPixelData class"""
957 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
958 __repr__
= _swig_repr
959 def __init__(self
, *args
):
961 __init__(self, Bitmap bmp) -> AlphaPixelData
962 __init__(self, Bitmap bmp, Rect rect) -> AlphaPixelData
963 __init__(self, Bitmap bmp, Point pt, Size sz) -> AlphaPixelData
965 _gdi_
.AlphaPixelData_swiginit(self
,_gdi_
.new_AlphaPixelData(*args
))
968 __swig_destroy__
= _gdi_
.delete_AlphaPixelData
969 __del__
= lambda self
: None;
970 def GetPixels(*args
, **kwargs
):
971 """GetPixels(self) -> AlphaPixelData_Accessor"""
972 return _gdi_
.AlphaPixelData_GetPixels(*args
, **kwargs
)
974 def UseAlpha(*args
, **kwargs
):
976 return _gdi_
.AlphaPixelData_UseAlpha(*args
, **kwargs
)
978 def __nonzero__(*args
, **kwargs
):
979 """__nonzero__(self) -> bool"""
980 return _gdi_
.AlphaPixelData___nonzero__(*args
, **kwargs
)
984 Create and return an iterator object for this pixel data
985 object. (It's really a generator but I won't tell if you
988 width
= self
.GetWidth()
989 height
= self
.GetHeight()
990 pixels
= self
.GetPixels()
995 class PixelFacade(object):
998 def Set(self
, *args
, **kw
):
999 return pixels
.Set(*args
, **kw
)
1001 return str(self
.Get())
1003 return 'pixel(%d,%d): %s' % (x
,y
,self
.Get())
1004 X
= property(lambda self
: x
)
1005 Y
= property(lambda self
: y
)
1008 for y
in xrange(height
):
1009 for x
in xrange(width
):
1015 pixels
.MoveTo(self
, 0, y
)
1017 Pixels
= property(GetPixels
,doc
="See `GetPixels`")
1018 _gdi_
.AlphaPixelData_swigregister(AlphaPixelData
)
1020 class AlphaPixelData_Accessor(object):
1021 """Proxy of C++ AlphaPixelData_Accessor class"""
1022 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1023 __repr__
= _swig_repr
1024 def __init__(self
, *args
):
1026 __init__(self, AlphaPixelData data) -> AlphaPixelData_Accessor
1027 __init__(self, Bitmap bmp, AlphaPixelData data) -> AlphaPixelData_Accessor
1028 __init__(self) -> AlphaPixelData_Accessor
1030 _gdi_
.AlphaPixelData_Accessor_swiginit(self
,_gdi_
.new_AlphaPixelData_Accessor(*args
))
1031 __swig_destroy__
= _gdi_
.delete_AlphaPixelData_Accessor
1032 __del__
= lambda self
: None;
1033 def Reset(*args
, **kwargs
):
1034 """Reset(self, AlphaPixelData data)"""
1035 return _gdi_
.AlphaPixelData_Accessor_Reset(*args
, **kwargs
)
1037 def IsOk(*args
, **kwargs
):
1038 """IsOk(self) -> bool"""
1039 return _gdi_
.AlphaPixelData_Accessor_IsOk(*args
, **kwargs
)
1041 def nextPixel(*args
, **kwargs
):
1042 """nextPixel(self)"""
1043 return _gdi_
.AlphaPixelData_Accessor_nextPixel(*args
, **kwargs
)
1045 def Offset(*args
, **kwargs
):
1046 """Offset(self, AlphaPixelData data, int x, int y)"""
1047 return _gdi_
.AlphaPixelData_Accessor_Offset(*args
, **kwargs
)
1049 def OffsetX(*args
, **kwargs
):
1050 """OffsetX(self, AlphaPixelData data, int x)"""
1051 return _gdi_
.AlphaPixelData_Accessor_OffsetX(*args
, **kwargs
)
1053 def OffsetY(*args
, **kwargs
):
1054 """OffsetY(self, AlphaPixelData data, int y)"""
1055 return _gdi_
.AlphaPixelData_Accessor_OffsetY(*args
, **kwargs
)
1057 def MoveTo(*args
, **kwargs
):
1058 """MoveTo(self, AlphaPixelData data, int x, int y)"""
1059 return _gdi_
.AlphaPixelData_Accessor_MoveTo(*args
, **kwargs
)
1061 def Set(*args
, **kwargs
):
1062 """Set(self, byte red, byte green, byte blue, byte alpha)"""
1063 return _gdi_
.AlphaPixelData_Accessor_Set(*args
, **kwargs
)
1065 def Get(*args
, **kwargs
):
1066 """Get(self) -> PyObject"""
1067 return _gdi_
.AlphaPixelData_Accessor_Get(*args
, **kwargs
)
1069 _gdi_
.AlphaPixelData_Accessor_swigregister(AlphaPixelData_Accessor
)
1071 class Mask(_core
.Object
):
1073 This class encapsulates a monochrome mask bitmap, where the masked
1074 area is black and the unmasked area is white. When associated with a
1075 bitmap and drawn in a device context, the unmasked area of the bitmap
1076 will be drawn, and the masked area will not be drawn.
1078 A mask may be associated with a `wx.Bitmap`. It is used in
1079 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
1080 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
1083 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1084 __repr__
= _swig_repr
1085 def __init__(self
, *args
, **kwargs
):
1087 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
1089 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
1090 that indicates the transparent portions of the mask. In other words,
1091 the pixels in ``bitmap`` that match ``colour`` will be the transparent
1092 portions of the mask. If no ``colour`` or an invalid ``colour`` is
1093 passed then BLACK is used.
1095 :see: `wx.Bitmap`, `wx.Colour`
1097 _gdi_
.Mask_swiginit(self
,_gdi_
.new_Mask(*args
, **kwargs
))
1098 __swig_destroy__
= _gdi_
.delete_Mask
1099 __del__
= lambda self
: None;
1100 _gdi_
.Mask_swigregister(Mask
)
1102 MaskColour
= wx
._deprecated
(Mask
, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
1103 class Icon(GDIObject
):
1104 """Proxy of C++ Icon class"""
1105 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1106 __repr__
= _swig_repr
1107 def __init__(self
, *args
, **kwargs
):
1108 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
1109 _gdi_
.Icon_swiginit(self
,_gdi_
.new_Icon(*args
, **kwargs
))
1110 __swig_destroy__
= _gdi_
.delete_Icon
1111 __del__
= lambda self
: None;
1112 def IsOk(*args
, **kwargs
):
1113 """IsOk(self) -> bool"""
1114 return _gdi_
.Icon_IsOk(*args
, **kwargs
)
1117 def GetWidth(*args
, **kwargs
):
1118 """GetWidth(self) -> int"""
1119 return _gdi_
.Icon_GetWidth(*args
, **kwargs
)
1121 def GetHeight(*args
, **kwargs
):
1122 """GetHeight(self) -> int"""
1123 return _gdi_
.Icon_GetHeight(*args
, **kwargs
)
1125 def GetDepth(*args
, **kwargs
):
1126 """GetDepth(self) -> int"""
1127 return _gdi_
.Icon_GetDepth(*args
, **kwargs
)
1129 def SetWidth(*args
, **kwargs
):
1130 """SetWidth(self, int w)"""
1131 return _gdi_
.Icon_SetWidth(*args
, **kwargs
)
1133 def SetHeight(*args
, **kwargs
):
1134 """SetHeight(self, int h)"""
1135 return _gdi_
.Icon_SetHeight(*args
, **kwargs
)
1137 def SetDepth(*args
, **kwargs
):
1138 """SetDepth(self, int d)"""
1139 return _gdi_
.Icon_SetDepth(*args
, **kwargs
)
1141 def CopyFromBitmap(*args
, **kwargs
):
1142 """CopyFromBitmap(self, Bitmap bmp)"""
1143 return _gdi_
.Icon_CopyFromBitmap(*args
, **kwargs
)
1145 def __nonzero__(self
): return self
.IsOk()
1146 Depth
= property(GetDepth
,SetDepth
,doc
="See `GetDepth` and `SetDepth`")
1147 Height
= property(GetHeight
,SetHeight
,doc
="See `GetHeight` and `SetHeight`")
1148 Width
= property(GetWidth
,SetWidth
,doc
="See `GetWidth` and `SetWidth`")
1149 _gdi_
.Icon_swigregister(Icon
)
1151 def EmptyIcon(*args
, **kwargs
):
1152 """EmptyIcon() -> Icon"""
1153 val
= _gdi_
.new_EmptyIcon(*args
, **kwargs
)
1156 def IconFromLocation(*args
, **kwargs
):
1157 """IconFromLocation(IconLocation loc) -> Icon"""
1158 val
= _gdi_
.new_IconFromLocation(*args
, **kwargs
)
1161 def IconFromBitmap(*args
, **kwargs
):
1162 """IconFromBitmap(Bitmap bmp) -> Icon"""
1163 val
= _gdi_
.new_IconFromBitmap(*args
, **kwargs
)
1166 def IconFromXPMData(*args
, **kwargs
):
1167 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
1168 val
= _gdi_
.new_IconFromXPMData(*args
, **kwargs
)
1171 class IconLocation(object):
1172 """Proxy of C++ IconLocation class"""
1173 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1174 __repr__
= _swig_repr
1175 def __init__(self
, *args
, **kwargs
):
1176 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
1177 _gdi_
.IconLocation_swiginit(self
,_gdi_
.new_IconLocation(*args
, **kwargs
))
1178 __swig_destroy__
= _gdi_
.delete_IconLocation
1179 __del__
= lambda self
: None;
1180 def IsOk(*args
, **kwargs
):
1181 """IsOk(self) -> bool"""
1182 return _gdi_
.IconLocation_IsOk(*args
, **kwargs
)
1184 def __nonzero__(self
): return self
.IsOk()
1185 def SetFileName(*args
, **kwargs
):
1186 """SetFileName(self, String filename)"""
1187 return _gdi_
.IconLocation_SetFileName(*args
, **kwargs
)
1189 def GetFileName(*args
, **kwargs
):
1190 """GetFileName(self) -> String"""
1191 return _gdi_
.IconLocation_GetFileName(*args
, **kwargs
)
1193 def SetIndex(*args
, **kwargs
):
1194 """SetIndex(self, int num)"""
1195 return _gdi_
.IconLocation_SetIndex(*args
, **kwargs
)
1197 def GetIndex(*args
, **kwargs
):
1198 """GetIndex(self) -> int"""
1199 return _gdi_
.IconLocation_GetIndex(*args
, **kwargs
)
1201 FileName
= property(GetFileName
,SetFileName
,doc
="See `GetFileName` and `SetFileName`")
1202 Index
= property(GetIndex
,SetIndex
,doc
="See `GetIndex` and `SetIndex`")
1203 _gdi_
.IconLocation_swigregister(IconLocation
)
1205 class IconBundle(object):
1206 """Proxy of C++ IconBundle class"""
1207 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1208 __repr__
= _swig_repr
1209 def __init__(self
, *args
, **kwargs
):
1210 """__init__(self) -> IconBundle"""
1211 _gdi_
.IconBundle_swiginit(self
,_gdi_
.new_IconBundle(*args
, **kwargs
))
1212 __swig_destroy__
= _gdi_
.delete_IconBundle
1213 __del__
= lambda self
: None;
1214 def AddIcon(*args
, **kwargs
):
1215 """AddIcon(self, Icon icon)"""
1216 return _gdi_
.IconBundle_AddIcon(*args
, **kwargs
)
1218 def AddIconFromFile(*args
, **kwargs
):
1219 """AddIconFromFile(self, String file, long type)"""
1220 return _gdi_
.IconBundle_AddIconFromFile(*args
, **kwargs
)
1222 def GetIcon(*args
, **kwargs
):
1223 """GetIcon(self, Size size) -> Icon"""
1224 return _gdi_
.IconBundle_GetIcon(*args
, **kwargs
)
1226 Icon
= property(GetIcon
,doc
="See `GetIcon`")
1227 _gdi_
.IconBundle_swigregister(IconBundle
)
1229 def IconBundleFromFile(*args
, **kwargs
):
1230 """IconBundleFromFile(String file, long type) -> IconBundle"""
1231 val
= _gdi_
.new_IconBundleFromFile(*args
, **kwargs
)
1234 def IconBundleFromIcon(*args
, **kwargs
):
1235 """IconBundleFromIcon(Icon icon) -> IconBundle"""
1236 val
= _gdi_
.new_IconBundleFromIcon(*args
, **kwargs
)
1239 class Cursor(GDIObject
):
1241 A cursor is a small bitmap usually used for denoting where the mouse
1242 pointer is, with a picture that might indicate the interpretation of a
1245 A single cursor object may be used in many windows (any subwindow
1246 type). The wxWindows convention is to set the cursor for a window, as
1247 in X, rather than to set it globally as in MS Windows, although a
1248 global `wx.SetCursor` function is also available for use on MS Windows.
1251 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1252 __repr__
= _swig_repr
1253 def __init__(self
, *args
, **kwargs
):
1255 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
1257 Construct a Cursor from a file. Specify the type of file using
1258 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
1261 _gdi_
.Cursor_swiginit(self
,_gdi_
.new_Cursor(*args
, **kwargs
))
1262 __swig_destroy__
= _gdi_
.delete_Cursor
1263 __del__
= lambda self
: None;
1264 def IsOk(*args
, **kwargs
):
1265 """IsOk(self) -> bool"""
1266 return _gdi_
.Cursor_IsOk(*args
, **kwargs
)
1269 def __nonzero__(self
): return self
.IsOk()
1270 _gdi_
.Cursor_swigregister(Cursor
)
1272 def StockCursor(*args
, **kwargs
):
1274 StockCursor(int id) -> Cursor
1276 Create a cursor using one of the stock cursors. Note that not all
1277 stock cursors are available on all platforms.
1279 val
= _gdi_
.new_StockCursor(*args
, **kwargs
)
1282 def CursorFromImage(*args
, **kwargs
):
1284 CursorFromImage(Image image) -> Cursor
1286 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
1287 for setting the transparent portions of the cursor.
1289 val
= _gdi_
.new_CursorFromImage(*args
, **kwargs
)
1292 #---------------------------------------------------------------------------
1294 OutRegion
= _gdi_
.OutRegion
1295 PartRegion
= _gdi_
.PartRegion
1296 InRegion
= _gdi_
.InRegion
1297 class Region(GDIObject
):
1298 """Proxy of C++ Region class"""
1299 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1300 __repr__
= _swig_repr
1301 def __init__(self
, *args
, **kwargs
):
1302 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
1303 _gdi_
.Region_swiginit(self
,_gdi_
.new_Region(*args
, **kwargs
))
1304 __swig_destroy__
= _gdi_
.delete_Region
1305 __del__
= lambda self
: None;
1306 def Clear(*args
, **kwargs
):
1308 return _gdi_
.Region_Clear(*args
, **kwargs
)
1310 def Offset(*args
, **kwargs
):
1311 """Offset(self, int x, int y) -> bool"""
1312 return _gdi_
.Region_Offset(*args
, **kwargs
)
1314 def Contains(*args
, **kwargs
):
1315 """Contains(self, int x, int y) -> int"""
1316 return _gdi_
.Region_Contains(*args
, **kwargs
)
1318 def ContainsPoint(*args
, **kwargs
):
1319 """ContainsPoint(self, Point pt) -> int"""
1320 return _gdi_
.Region_ContainsPoint(*args
, **kwargs
)
1322 def ContainsRect(*args
, **kwargs
):
1323 """ContainsRect(self, Rect rect) -> int"""
1324 return _gdi_
.Region_ContainsRect(*args
, **kwargs
)
1326 def ContainsRectDim(*args
, **kwargs
):
1327 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
1328 return _gdi_
.Region_ContainsRectDim(*args
, **kwargs
)
1330 def GetBox(*args
, **kwargs
):
1331 """GetBox(self) -> Rect"""
1332 return _gdi_
.Region_GetBox(*args
, **kwargs
)
1334 def Intersect(*args
, **kwargs
):
1335 """Intersect(self, int x, int y, int width, int height) -> bool"""
1336 return _gdi_
.Region_Intersect(*args
, **kwargs
)
1338 def IntersectRect(*args
, **kwargs
):
1339 """IntersectRect(self, Rect rect) -> bool"""
1340 return _gdi_
.Region_IntersectRect(*args
, **kwargs
)
1342 def IntersectRegion(*args
, **kwargs
):
1343 """IntersectRegion(self, Region region) -> bool"""
1344 return _gdi_
.Region_IntersectRegion(*args
, **kwargs
)
1346 def IsEmpty(*args
, **kwargs
):
1347 """IsEmpty(self) -> bool"""
1348 return _gdi_
.Region_IsEmpty(*args
, **kwargs
)
1350 def IsEqual(*args
, **kwargs
):
1351 """IsEqual(self, Region region) -> bool"""
1352 return _gdi_
.Region_IsEqual(*args
, **kwargs
)
1354 def Union(*args
, **kwargs
):
1355 """Union(self, int x, int y, int width, int height) -> bool"""
1356 return _gdi_
.Region_Union(*args
, **kwargs
)
1358 def UnionRect(*args
, **kwargs
):
1359 """UnionRect(self, Rect rect) -> bool"""
1360 return _gdi_
.Region_UnionRect(*args
, **kwargs
)
1362 def UnionRegion(*args
, **kwargs
):
1363 """UnionRegion(self, Region region) -> bool"""
1364 return _gdi_
.Region_UnionRegion(*args
, **kwargs
)
1366 def Subtract(*args
, **kwargs
):
1367 """Subtract(self, int x, int y, int width, int height) -> bool"""
1368 return _gdi_
.Region_Subtract(*args
, **kwargs
)
1370 def SubtractRect(*args
, **kwargs
):
1371 """SubtractRect(self, Rect rect) -> bool"""
1372 return _gdi_
.Region_SubtractRect(*args
, **kwargs
)
1374 def SubtractRegion(*args
, **kwargs
):
1375 """SubtractRegion(self, Region region) -> bool"""
1376 return _gdi_
.Region_SubtractRegion(*args
, **kwargs
)
1378 def Xor(*args
, **kwargs
):
1379 """Xor(self, int x, int y, int width, int height) -> bool"""
1380 return _gdi_
.Region_Xor(*args
, **kwargs
)
1382 def XorRect(*args
, **kwargs
):
1383 """XorRect(self, Rect rect) -> bool"""
1384 return _gdi_
.Region_XorRect(*args
, **kwargs
)
1386 def XorRegion(*args
, **kwargs
):
1387 """XorRegion(self, Region region) -> bool"""
1388 return _gdi_
.Region_XorRegion(*args
, **kwargs
)
1390 def ConvertToBitmap(*args
, **kwargs
):
1391 """ConvertToBitmap(self) -> Bitmap"""
1392 return _gdi_
.Region_ConvertToBitmap(*args
, **kwargs
)
1394 def UnionBitmap(*args
, **kwargs
):
1395 """UnionBitmap(self, Bitmap bmp) -> bool"""
1396 return _gdi_
.Region_UnionBitmap(*args
, **kwargs
)
1398 def UnionBitmapColour(*args
, **kwargs
):
1399 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1400 return _gdi_
.Region_UnionBitmapColour(*args
, **kwargs
)
1402 Box
= property(GetBox
,doc
="See `GetBox`")
1403 _gdi_
.Region_swigregister(Region
)
1405 def RegionFromBitmap(*args
, **kwargs
):
1406 """RegionFromBitmap(Bitmap bmp) -> Region"""
1407 val
= _gdi_
.new_RegionFromBitmap(*args
, **kwargs
)
1410 def RegionFromBitmapColour(*args
, **kwargs
):
1411 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1412 val
= _gdi_
.new_RegionFromBitmapColour(*args
, **kwargs
)
1415 def RegionFromPoints(*args
, **kwargs
):
1416 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
1417 val
= _gdi_
.new_RegionFromPoints(*args
, **kwargs
)
1420 class RegionIterator(_core
.Object
):
1421 """Proxy of C++ RegionIterator class"""
1422 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1423 __repr__
= _swig_repr
1424 def __init__(self
, *args
, **kwargs
):
1425 """__init__(self, Region region) -> RegionIterator"""
1426 _gdi_
.RegionIterator_swiginit(self
,_gdi_
.new_RegionIterator(*args
, **kwargs
))
1427 __swig_destroy__
= _gdi_
.delete_RegionIterator
1428 __del__
= lambda self
: None;
1429 def GetX(*args
, **kwargs
):
1430 """GetX(self) -> int"""
1431 return _gdi_
.RegionIterator_GetX(*args
, **kwargs
)
1433 def GetY(*args
, **kwargs
):
1434 """GetY(self) -> int"""
1435 return _gdi_
.RegionIterator_GetY(*args
, **kwargs
)
1437 def GetW(*args
, **kwargs
):
1438 """GetW(self) -> int"""
1439 return _gdi_
.RegionIterator_GetW(*args
, **kwargs
)
1441 def GetWidth(*args
, **kwargs
):
1442 """GetWidth(self) -> int"""
1443 return _gdi_
.RegionIterator_GetWidth(*args
, **kwargs
)
1445 def GetH(*args
, **kwargs
):
1446 """GetH(self) -> int"""
1447 return _gdi_
.RegionIterator_GetH(*args
, **kwargs
)
1449 def GetHeight(*args
, **kwargs
):
1450 """GetHeight(self) -> int"""
1451 return _gdi_
.RegionIterator_GetHeight(*args
, **kwargs
)
1453 def GetRect(*args
, **kwargs
):
1454 """GetRect(self) -> Rect"""
1455 return _gdi_
.RegionIterator_GetRect(*args
, **kwargs
)
1457 def HaveRects(*args
, **kwargs
):
1458 """HaveRects(self) -> bool"""
1459 return _gdi_
.RegionIterator_HaveRects(*args
, **kwargs
)
1461 def Reset(*args
, **kwargs
):
1463 return _gdi_
.RegionIterator_Reset(*args
, **kwargs
)
1465 def Next(*args
, **kwargs
):
1467 return _gdi_
.RegionIterator_Next(*args
, **kwargs
)
1469 def __nonzero__(*args
, **kwargs
):
1470 """__nonzero__(self) -> bool"""
1471 return _gdi_
.RegionIterator___nonzero__(*args
, **kwargs
)
1473 H
= property(GetH
,doc
="See `GetH`")
1474 Height
= property(GetHeight
,doc
="See `GetHeight`")
1475 Rect
= property(GetRect
,doc
="See `GetRect`")
1476 W
= property(GetW
,doc
="See `GetW`")
1477 Width
= property(GetWidth
,doc
="See `GetWidth`")
1478 X
= property(GetX
,doc
="See `GetX`")
1479 Y
= property(GetY
,doc
="See `GetY`")
1480 _gdi_
.RegionIterator_swigregister(RegionIterator
)
1482 #---------------------------------------------------------------------------
1484 FONTFAMILY_DEFAULT
= _gdi_
.FONTFAMILY_DEFAULT
1485 FONTFAMILY_DECORATIVE
= _gdi_
.FONTFAMILY_DECORATIVE
1486 FONTFAMILY_ROMAN
= _gdi_
.FONTFAMILY_ROMAN
1487 FONTFAMILY_SCRIPT
= _gdi_
.FONTFAMILY_SCRIPT
1488 FONTFAMILY_SWISS
= _gdi_
.FONTFAMILY_SWISS
1489 FONTFAMILY_MODERN
= _gdi_
.FONTFAMILY_MODERN
1490 FONTFAMILY_TELETYPE
= _gdi_
.FONTFAMILY_TELETYPE
1491 FONTFAMILY_MAX
= _gdi_
.FONTFAMILY_MAX
1492 FONTFAMILY_UNKNOWN
= _gdi_
.FONTFAMILY_UNKNOWN
1493 FONTSTYLE_NORMAL
= _gdi_
.FONTSTYLE_NORMAL
1494 FONTSTYLE_ITALIC
= _gdi_
.FONTSTYLE_ITALIC
1495 FONTSTYLE_SLANT
= _gdi_
.FONTSTYLE_SLANT
1496 FONTSTYLE_MAX
= _gdi_
.FONTSTYLE_MAX
1497 FONTWEIGHT_NORMAL
= _gdi_
.FONTWEIGHT_NORMAL
1498 FONTWEIGHT_LIGHT
= _gdi_
.FONTWEIGHT_LIGHT
1499 FONTWEIGHT_BOLD
= _gdi_
.FONTWEIGHT_BOLD
1500 FONTWEIGHT_MAX
= _gdi_
.FONTWEIGHT_MAX
1501 FONTFLAG_DEFAULT
= _gdi_
.FONTFLAG_DEFAULT
1502 FONTFLAG_ITALIC
= _gdi_
.FONTFLAG_ITALIC
1503 FONTFLAG_SLANT
= _gdi_
.FONTFLAG_SLANT
1504 FONTFLAG_LIGHT
= _gdi_
.FONTFLAG_LIGHT
1505 FONTFLAG_BOLD
= _gdi_
.FONTFLAG_BOLD
1506 FONTFLAG_ANTIALIASED
= _gdi_
.FONTFLAG_ANTIALIASED
1507 FONTFLAG_NOT_ANTIALIASED
= _gdi_
.FONTFLAG_NOT_ANTIALIASED
1508 FONTFLAG_UNDERLINED
= _gdi_
.FONTFLAG_UNDERLINED
1509 FONTFLAG_STRIKETHROUGH
= _gdi_
.FONTFLAG_STRIKETHROUGH
1510 FONTFLAG_MASK
= _gdi_
.FONTFLAG_MASK
1511 FONTENCODING_SYSTEM
= _gdi_
.FONTENCODING_SYSTEM
1512 FONTENCODING_DEFAULT
= _gdi_
.FONTENCODING_DEFAULT
1513 FONTENCODING_ISO8859_1
= _gdi_
.FONTENCODING_ISO8859_1
1514 FONTENCODING_ISO8859_2
= _gdi_
.FONTENCODING_ISO8859_2
1515 FONTENCODING_ISO8859_3
= _gdi_
.FONTENCODING_ISO8859_3
1516 FONTENCODING_ISO8859_4
= _gdi_
.FONTENCODING_ISO8859_4
1517 FONTENCODING_ISO8859_5
= _gdi_
.FONTENCODING_ISO8859_5
1518 FONTENCODING_ISO8859_6
= _gdi_
.FONTENCODING_ISO8859_6
1519 FONTENCODING_ISO8859_7
= _gdi_
.FONTENCODING_ISO8859_7
1520 FONTENCODING_ISO8859_8
= _gdi_
.FONTENCODING_ISO8859_8
1521 FONTENCODING_ISO8859_9
= _gdi_
.FONTENCODING_ISO8859_9
1522 FONTENCODING_ISO8859_10
= _gdi_
.FONTENCODING_ISO8859_10
1523 FONTENCODING_ISO8859_11
= _gdi_
.FONTENCODING_ISO8859_11
1524 FONTENCODING_ISO8859_12
= _gdi_
.FONTENCODING_ISO8859_12
1525 FONTENCODING_ISO8859_13
= _gdi_
.FONTENCODING_ISO8859_13
1526 FONTENCODING_ISO8859_14
= _gdi_
.FONTENCODING_ISO8859_14
1527 FONTENCODING_ISO8859_15
= _gdi_
.FONTENCODING_ISO8859_15
1528 FONTENCODING_ISO8859_MAX
= _gdi_
.FONTENCODING_ISO8859_MAX
1529 FONTENCODING_KOI8
= _gdi_
.FONTENCODING_KOI8
1530 FONTENCODING_KOI8_U
= _gdi_
.FONTENCODING_KOI8_U
1531 FONTENCODING_ALTERNATIVE
= _gdi_
.FONTENCODING_ALTERNATIVE
1532 FONTENCODING_BULGARIAN
= _gdi_
.FONTENCODING_BULGARIAN
1533 FONTENCODING_CP437
= _gdi_
.FONTENCODING_CP437
1534 FONTENCODING_CP850
= _gdi_
.FONTENCODING_CP850
1535 FONTENCODING_CP852
= _gdi_
.FONTENCODING_CP852
1536 FONTENCODING_CP855
= _gdi_
.FONTENCODING_CP855
1537 FONTENCODING_CP866
= _gdi_
.FONTENCODING_CP866
1538 FONTENCODING_CP874
= _gdi_
.FONTENCODING_CP874
1539 FONTENCODING_CP932
= _gdi_
.FONTENCODING_CP932
1540 FONTENCODING_CP936
= _gdi_
.FONTENCODING_CP936
1541 FONTENCODING_CP949
= _gdi_
.FONTENCODING_CP949
1542 FONTENCODING_CP950
= _gdi_
.FONTENCODING_CP950
1543 FONTENCODING_CP1250
= _gdi_
.FONTENCODING_CP1250
1544 FONTENCODING_CP1251
= _gdi_
.FONTENCODING_CP1251
1545 FONTENCODING_CP1252
= _gdi_
.FONTENCODING_CP1252
1546 FONTENCODING_CP1253
= _gdi_
.FONTENCODING_CP1253
1547 FONTENCODING_CP1254
= _gdi_
.FONTENCODING_CP1254
1548 FONTENCODING_CP1255
= _gdi_
.FONTENCODING_CP1255
1549 FONTENCODING_CP1256
= _gdi_
.FONTENCODING_CP1256
1550 FONTENCODING_CP1257
= _gdi_
.FONTENCODING_CP1257
1551 FONTENCODING_CP12_MAX
= _gdi_
.FONTENCODING_CP12_MAX
1552 FONTENCODING_UTF7
= _gdi_
.FONTENCODING_UTF7
1553 FONTENCODING_UTF8
= _gdi_
.FONTENCODING_UTF8
1554 FONTENCODING_EUC_JP
= _gdi_
.FONTENCODING_EUC_JP
1555 FONTENCODING_UTF16BE
= _gdi_
.FONTENCODING_UTF16BE
1556 FONTENCODING_UTF16LE
= _gdi_
.FONTENCODING_UTF16LE
1557 FONTENCODING_UTF32BE
= _gdi_
.FONTENCODING_UTF32BE
1558 FONTENCODING_UTF32LE
= _gdi_
.FONTENCODING_UTF32LE
1559 FONTENCODING_MACROMAN
= _gdi_
.FONTENCODING_MACROMAN
1560 FONTENCODING_MACJAPANESE
= _gdi_
.FONTENCODING_MACJAPANESE
1561 FONTENCODING_MACCHINESETRAD
= _gdi_
.FONTENCODING_MACCHINESETRAD
1562 FONTENCODING_MACKOREAN
= _gdi_
.FONTENCODING_MACKOREAN
1563 FONTENCODING_MACARABIC
= _gdi_
.FONTENCODING_MACARABIC
1564 FONTENCODING_MACHEBREW
= _gdi_
.FONTENCODING_MACHEBREW
1565 FONTENCODING_MACGREEK
= _gdi_
.FONTENCODING_MACGREEK
1566 FONTENCODING_MACCYRILLIC
= _gdi_
.FONTENCODING_MACCYRILLIC
1567 FONTENCODING_MACDEVANAGARI
= _gdi_
.FONTENCODING_MACDEVANAGARI
1568 FONTENCODING_MACGURMUKHI
= _gdi_
.FONTENCODING_MACGURMUKHI
1569 FONTENCODING_MACGUJARATI
= _gdi_
.FONTENCODING_MACGUJARATI
1570 FONTENCODING_MACORIYA
= _gdi_
.FONTENCODING_MACORIYA
1571 FONTENCODING_MACBENGALI
= _gdi_
.FONTENCODING_MACBENGALI
1572 FONTENCODING_MACTAMIL
= _gdi_
.FONTENCODING_MACTAMIL
1573 FONTENCODING_MACTELUGU
= _gdi_
.FONTENCODING_MACTELUGU
1574 FONTENCODING_MACKANNADA
= _gdi_
.FONTENCODING_MACKANNADA
1575 FONTENCODING_MACMALAJALAM
= _gdi_
.FONTENCODING_MACMALAJALAM
1576 FONTENCODING_MACSINHALESE
= _gdi_
.FONTENCODING_MACSINHALESE
1577 FONTENCODING_MACBURMESE
= _gdi_
.FONTENCODING_MACBURMESE
1578 FONTENCODING_MACKHMER
= _gdi_
.FONTENCODING_MACKHMER
1579 FONTENCODING_MACTHAI
= _gdi_
.FONTENCODING_MACTHAI
1580 FONTENCODING_MACLAOTIAN
= _gdi_
.FONTENCODING_MACLAOTIAN
1581 FONTENCODING_MACGEORGIAN
= _gdi_
.FONTENCODING_MACGEORGIAN
1582 FONTENCODING_MACARMENIAN
= _gdi_
.FONTENCODING_MACARMENIAN
1583 FONTENCODING_MACCHINESESIMP
= _gdi_
.FONTENCODING_MACCHINESESIMP
1584 FONTENCODING_MACTIBETAN
= _gdi_
.FONTENCODING_MACTIBETAN
1585 FONTENCODING_MACMONGOLIAN
= _gdi_
.FONTENCODING_MACMONGOLIAN
1586 FONTENCODING_MACETHIOPIC
= _gdi_
.FONTENCODING_MACETHIOPIC
1587 FONTENCODING_MACCENTRALEUR
= _gdi_
.FONTENCODING_MACCENTRALEUR
1588 FONTENCODING_MACVIATNAMESE
= _gdi_
.FONTENCODING_MACVIATNAMESE
1589 FONTENCODING_MACARABICEXT
= _gdi_
.FONTENCODING_MACARABICEXT
1590 FONTENCODING_MACSYMBOL
= _gdi_
.FONTENCODING_MACSYMBOL
1591 FONTENCODING_MACDINGBATS
= _gdi_
.FONTENCODING_MACDINGBATS
1592 FONTENCODING_MACTURKISH
= _gdi_
.FONTENCODING_MACTURKISH
1593 FONTENCODING_MACCROATIAN
= _gdi_
.FONTENCODING_MACCROATIAN
1594 FONTENCODING_MACICELANDIC
= _gdi_
.FONTENCODING_MACICELANDIC
1595 FONTENCODING_MACROMANIAN
= _gdi_
.FONTENCODING_MACROMANIAN
1596 FONTENCODING_MACCELTIC
= _gdi_
.FONTENCODING_MACCELTIC
1597 FONTENCODING_MACGAELIC
= _gdi_
.FONTENCODING_MACGAELIC
1598 FONTENCODING_MACKEYBOARD
= _gdi_
.FONTENCODING_MACKEYBOARD
1599 FONTENCODING_MACMIN
= _gdi_
.FONTENCODING_MACMIN
1600 FONTENCODING_MACMAX
= _gdi_
.FONTENCODING_MACMAX
1601 FONTENCODING_MAX
= _gdi_
.FONTENCODING_MAX
1602 FONTENCODING_UTF16
= _gdi_
.FONTENCODING_UTF16
1603 FONTENCODING_UTF32
= _gdi_
.FONTENCODING_UTF32
1604 FONTENCODING_UNICODE
= _gdi_
.FONTENCODING_UNICODE
1605 FONTENCODING_GB2312
= _gdi_
.FONTENCODING_GB2312
1606 FONTENCODING_BIG5
= _gdi_
.FONTENCODING_BIG5
1607 FONTENCODING_SHIFT_JIS
= _gdi_
.FONTENCODING_SHIFT_JIS
1608 #---------------------------------------------------------------------------
1610 class NativeFontInfo(object):
1611 """Proxy of C++ NativeFontInfo class"""
1612 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1613 __repr__
= _swig_repr
1614 def __init__(self
, *args
, **kwargs
):
1615 """__init__(self) -> NativeFontInfo"""
1616 _gdi_
.NativeFontInfo_swiginit(self
,_gdi_
.new_NativeFontInfo(*args
, **kwargs
))
1617 __swig_destroy__
= _gdi_
.delete_NativeFontInfo
1618 __del__
= lambda self
: None;
1619 def Init(*args
, **kwargs
):
1621 return _gdi_
.NativeFontInfo_Init(*args
, **kwargs
)
1623 def InitFromFont(*args
, **kwargs
):
1624 """InitFromFont(self, Font font)"""
1625 return _gdi_
.NativeFontInfo_InitFromFont(*args
, **kwargs
)
1627 def GetPointSize(*args
, **kwargs
):
1628 """GetPointSize(self) -> int"""
1629 return _gdi_
.NativeFontInfo_GetPointSize(*args
, **kwargs
)
1631 def GetStyle(*args
, **kwargs
):
1632 """GetStyle(self) -> int"""
1633 return _gdi_
.NativeFontInfo_GetStyle(*args
, **kwargs
)
1635 def GetWeight(*args
, **kwargs
):
1636 """GetWeight(self) -> int"""
1637 return _gdi_
.NativeFontInfo_GetWeight(*args
, **kwargs
)
1639 def GetUnderlined(*args
, **kwargs
):
1640 """GetUnderlined(self) -> bool"""
1641 return _gdi_
.NativeFontInfo_GetUnderlined(*args
, **kwargs
)
1643 def GetFaceName(*args
, **kwargs
):
1644 """GetFaceName(self) -> String"""
1645 return _gdi_
.NativeFontInfo_GetFaceName(*args
, **kwargs
)
1647 def GetFamily(*args
, **kwargs
):
1648 """GetFamily(self) -> int"""
1649 return _gdi_
.NativeFontInfo_GetFamily(*args
, **kwargs
)
1651 def GetEncoding(*args
, **kwargs
):
1652 """GetEncoding(self) -> int"""
1653 return _gdi_
.NativeFontInfo_GetEncoding(*args
, **kwargs
)
1655 def SetPointSize(*args
, **kwargs
):
1656 """SetPointSize(self, int pointsize)"""
1657 return _gdi_
.NativeFontInfo_SetPointSize(*args
, **kwargs
)
1659 def SetStyle(*args
, **kwargs
):
1660 """SetStyle(self, int style)"""
1661 return _gdi_
.NativeFontInfo_SetStyle(*args
, **kwargs
)
1663 def SetWeight(*args
, **kwargs
):
1664 """SetWeight(self, int weight)"""
1665 return _gdi_
.NativeFontInfo_SetWeight(*args
, **kwargs
)
1667 def SetUnderlined(*args
, **kwargs
):
1668 """SetUnderlined(self, bool underlined)"""
1669 return _gdi_
.NativeFontInfo_SetUnderlined(*args
, **kwargs
)
1671 def SetFaceName(*args
, **kwargs
):
1672 """SetFaceName(self, String facename) -> bool"""
1673 return _gdi_
.NativeFontInfo_SetFaceName(*args
, **kwargs
)
1675 def SetFamily(*args
, **kwargs
):
1676 """SetFamily(self, int family)"""
1677 return _gdi_
.NativeFontInfo_SetFamily(*args
, **kwargs
)
1679 def SetEncoding(*args
, **kwargs
):
1680 """SetEncoding(self, int encoding)"""
1681 return _gdi_
.NativeFontInfo_SetEncoding(*args
, **kwargs
)
1683 def FromString(*args
, **kwargs
):
1684 """FromString(self, String s) -> bool"""
1685 return _gdi_
.NativeFontInfo_FromString(*args
, **kwargs
)
1687 def ToString(*args
, **kwargs
):
1688 """ToString(self) -> String"""
1689 return _gdi_
.NativeFontInfo_ToString(*args
, **kwargs
)
1691 def __str__(*args
, **kwargs
):
1692 """__str__(self) -> String"""
1693 return _gdi_
.NativeFontInfo___str__(*args
, **kwargs
)
1695 def FromUserString(*args
, **kwargs
):
1696 """FromUserString(self, String s) -> bool"""
1697 return _gdi_
.NativeFontInfo_FromUserString(*args
, **kwargs
)
1699 def ToUserString(*args
, **kwargs
):
1700 """ToUserString(self) -> String"""
1701 return _gdi_
.NativeFontInfo_ToUserString(*args
, **kwargs
)
1703 Encoding
= property(GetEncoding
,SetEncoding
,doc
="See `GetEncoding` and `SetEncoding`")
1704 FaceName
= property(GetFaceName
,SetFaceName
,doc
="See `GetFaceName` and `SetFaceName`")
1705 Family
= property(GetFamily
,SetFamily
,doc
="See `GetFamily` and `SetFamily`")
1706 PointSize
= property(GetPointSize
,SetPointSize
,doc
="See `GetPointSize` and `SetPointSize`")
1707 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
1708 Underlined
= property(GetUnderlined
,SetUnderlined
,doc
="See `GetUnderlined` and `SetUnderlined`")
1709 Weight
= property(GetWeight
,SetWeight
,doc
="See `GetWeight` and `SetWeight`")
1710 _gdi_
.NativeFontInfo_swigregister(NativeFontInfo
)
1712 class NativeEncodingInfo(object):
1713 """Proxy of C++ NativeEncodingInfo class"""
1714 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1715 __repr__
= _swig_repr
1716 facename
= property(_gdi_
.NativeEncodingInfo_facename_get
, _gdi_
.NativeEncodingInfo_facename_set
)
1717 encoding
= property(_gdi_
.NativeEncodingInfo_encoding_get
, _gdi_
.NativeEncodingInfo_encoding_set
)
1718 def __init__(self
, *args
, **kwargs
):
1719 """__init__(self) -> NativeEncodingInfo"""
1720 _gdi_
.NativeEncodingInfo_swiginit(self
,_gdi_
.new_NativeEncodingInfo(*args
, **kwargs
))
1721 __swig_destroy__
= _gdi_
.delete_NativeEncodingInfo
1722 __del__
= lambda self
: None;
1723 def FromString(*args
, **kwargs
):
1724 """FromString(self, String s) -> bool"""
1725 return _gdi_
.NativeEncodingInfo_FromString(*args
, **kwargs
)
1727 def ToString(*args
, **kwargs
):
1728 """ToString(self) -> String"""
1729 return _gdi_
.NativeEncodingInfo_ToString(*args
, **kwargs
)
1731 _gdi_
.NativeEncodingInfo_swigregister(NativeEncodingInfo
)
1734 def GetNativeFontEncoding(*args
, **kwargs
):
1735 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
1736 return _gdi_
.GetNativeFontEncoding(*args
, **kwargs
)
1738 def TestFontEncoding(*args
, **kwargs
):
1739 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
1740 return _gdi_
.TestFontEncoding(*args
, **kwargs
)
1741 #---------------------------------------------------------------------------
1743 class FontMapper(object):
1744 """Proxy of C++ FontMapper class"""
1745 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1746 __repr__
= _swig_repr
1747 def __init__(self
, *args
, **kwargs
):
1748 """__init__(self) -> FontMapper"""
1749 _gdi_
.FontMapper_swiginit(self
,_gdi_
.new_FontMapper(*args
, **kwargs
))
1750 __swig_destroy__
= _gdi_
.delete_FontMapper
1751 __del__
= lambda self
: None;
1752 def Get(*args
, **kwargs
):
1753 """Get() -> FontMapper"""
1754 return _gdi_
.FontMapper_Get(*args
, **kwargs
)
1756 Get
= staticmethod(Get
)
1757 def Set(*args
, **kwargs
):
1758 """Set(FontMapper mapper) -> FontMapper"""
1759 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1761 Set
= staticmethod(Set
)
1762 def CharsetToEncoding(*args
, **kwargs
):
1763 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
1764 return _gdi_
.FontMapper_CharsetToEncoding(*args
, **kwargs
)
1766 def GetSupportedEncodingsCount(*args
, **kwargs
):
1767 """GetSupportedEncodingsCount() -> size_t"""
1768 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
, **kwargs
)
1770 GetSupportedEncodingsCount
= staticmethod(GetSupportedEncodingsCount
)
1771 def GetEncoding(*args
, **kwargs
):
1772 """GetEncoding(size_t n) -> int"""
1773 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1775 GetEncoding
= staticmethod(GetEncoding
)
1776 def GetEncodingName(*args
, **kwargs
):
1777 """GetEncodingName(int encoding) -> String"""
1778 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1780 GetEncodingName
= staticmethod(GetEncodingName
)
1781 def GetEncodingDescription(*args
, **kwargs
):
1782 """GetEncodingDescription(int encoding) -> String"""
1783 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1785 GetEncodingDescription
= staticmethod(GetEncodingDescription
)
1786 def GetEncodingFromName(*args
, **kwargs
):
1787 """GetEncodingFromName(String name) -> int"""
1788 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1790 GetEncodingFromName
= staticmethod(GetEncodingFromName
)
1791 def SetConfigPath(*args
, **kwargs
):
1792 """SetConfigPath(self, String prefix)"""
1793 return _gdi_
.FontMapper_SetConfigPath(*args
, **kwargs
)
1795 def GetDefaultConfigPath(*args
, **kwargs
):
1796 """GetDefaultConfigPath() -> String"""
1797 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
, **kwargs
)
1799 GetDefaultConfigPath
= staticmethod(GetDefaultConfigPath
)
1800 def GetAltForEncoding(*args
, **kwargs
):
1801 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
1802 return _gdi_
.FontMapper_GetAltForEncoding(*args
, **kwargs
)
1804 def IsEncodingAvailable(*args
, **kwargs
):
1805 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
1806 return _gdi_
.FontMapper_IsEncodingAvailable(*args
, **kwargs
)
1808 def SetDialogParent(*args
, **kwargs
):
1809 """SetDialogParent(self, Window parent)"""
1810 return _gdi_
.FontMapper_SetDialogParent(*args
, **kwargs
)
1812 def SetDialogTitle(*args
, **kwargs
):
1813 """SetDialogTitle(self, String title)"""
1814 return _gdi_
.FontMapper_SetDialogTitle(*args
, **kwargs
)
1816 AltForEncoding
= property(GetAltForEncoding
,doc
="See `GetAltForEncoding`")
1817 _gdi_
.FontMapper_swigregister(FontMapper
)
1819 def FontMapper_Get(*args
):
1820 """FontMapper_Get() -> FontMapper"""
1821 return _gdi_
.FontMapper_Get(*args
)
1823 def FontMapper_Set(*args
, **kwargs
):
1824 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
1825 return _gdi_
.FontMapper_Set(*args
, **kwargs
)
1827 def FontMapper_GetSupportedEncodingsCount(*args
):
1828 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
1829 return _gdi_
.FontMapper_GetSupportedEncodingsCount(*args
)
1831 def FontMapper_GetEncoding(*args
, **kwargs
):
1832 """FontMapper_GetEncoding(size_t n) -> int"""
1833 return _gdi_
.FontMapper_GetEncoding(*args
, **kwargs
)
1835 def FontMapper_GetEncodingName(*args
, **kwargs
):
1836 """FontMapper_GetEncodingName(int encoding) -> String"""
1837 return _gdi_
.FontMapper_GetEncodingName(*args
, **kwargs
)
1839 def FontMapper_GetEncodingDescription(*args
, **kwargs
):
1840 """FontMapper_GetEncodingDescription(int encoding) -> String"""
1841 return _gdi_
.FontMapper_GetEncodingDescription(*args
, **kwargs
)
1843 def FontMapper_GetEncodingFromName(*args
, **kwargs
):
1844 """FontMapper_GetEncodingFromName(String name) -> int"""
1845 return _gdi_
.FontMapper_GetEncodingFromName(*args
, **kwargs
)
1847 def FontMapper_GetDefaultConfigPath(*args
):
1848 """FontMapper_GetDefaultConfigPath() -> String"""
1849 return _gdi_
.FontMapper_GetDefaultConfigPath(*args
)
1851 #---------------------------------------------------------------------------
1853 class Font(GDIObject
):
1855 A font is an object which determines the appearance of text. Fonts are
1856 used for drawing text to a device context, and setting the appearance
1859 You can retrieve the current system font settings with `wx.SystemSettings`.
1861 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
1862 __repr__
= _swig_repr
1863 def __init__(self
, *args
, **kwargs
):
1865 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
1866 String face=EmptyString,
1867 int encoding=FONTENCODING_DEFAULT) -> Font
1869 Creates a font object with the specified attributes.
1871 :param pointSize: The size of the font in points.
1873 :param family: Font family. A generic way of referring to fonts
1874 without specifying actual facename. It can be One of
1875 the ``wx.FONTFAMILY_xxx`` constants.
1877 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1879 :param weight: Font weight, sometimes also referred to as font
1880 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1882 :param underline: The value can be ``True`` or ``False`` and
1883 indicates whether the font will include an underline. This
1884 may not be supported on all platforms.
1886 :param face: An optional string specifying the actual typeface to
1887 be used. If it is an empty string, a default typeface will be
1888 chosen based on the family.
1890 :param encoding: An encoding which may be one of the
1891 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1892 available, no font is created.
1894 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1895 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1898 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
1899 _gdi_
.Font_swiginit(self
,_gdi_
.new_Font(*args
, **kwargs
))
1900 __swig_destroy__
= _gdi_
.delete_Font
1901 __del__
= lambda self
: None;
1902 def IsOk(*args
, **kwargs
):
1906 Returns ``True`` if this font was successfully created.
1908 return _gdi_
.Font_IsOk(*args
, **kwargs
)
1911 def __nonzero__(self
): return self
.IsOk()
1912 def __eq__(*args
, **kwargs
):
1913 """__eq__(self, Font other) -> bool"""
1914 return _gdi_
.Font___eq__(*args
, **kwargs
)
1916 def __ne__(*args
, **kwargs
):
1917 """__ne__(self, Font other) -> bool"""
1918 return _gdi_
.Font___ne__(*args
, **kwargs
)
1920 def GetPointSize(*args
, **kwargs
):
1922 GetPointSize(self) -> int
1924 Gets the point size.
1926 return _gdi_
.Font_GetPointSize(*args
, **kwargs
)
1928 def GetPixelSize(*args
, **kwargs
):
1930 GetPixelSize(self) -> Size
1932 Returns the size in pixels if the font was constructed with a pixel
1935 return _gdi_
.Font_GetPixelSize(*args
, **kwargs
)
1937 def IsUsingSizeInPixels(*args
, **kwargs
):
1939 IsUsingSizeInPixels(self) -> bool
1941 Returns ``True`` if the font is using a pixelSize.
1943 return _gdi_
.Font_IsUsingSizeInPixels(*args
, **kwargs
)
1945 def GetFamily(*args
, **kwargs
):
1947 GetFamily(self) -> int
1949 Gets the font family.
1951 return _gdi_
.Font_GetFamily(*args
, **kwargs
)
1953 def GetStyle(*args
, **kwargs
):
1955 GetStyle(self) -> int
1957 Gets the font style.
1959 return _gdi_
.Font_GetStyle(*args
, **kwargs
)
1961 def GetWeight(*args
, **kwargs
):
1963 GetWeight(self) -> int
1965 Gets the font weight.
1967 return _gdi_
.Font_GetWeight(*args
, **kwargs
)
1969 def GetUnderlined(*args
, **kwargs
):
1971 GetUnderlined(self) -> bool
1973 Returns ``True`` if the font is underlined, ``False`` otherwise.
1975 return _gdi_
.Font_GetUnderlined(*args
, **kwargs
)
1977 def GetFaceName(*args
, **kwargs
):
1979 GetFaceName(self) -> String
1981 Returns the typeface name associated with the font, or the empty
1982 string if there is no typeface information.
1984 return _gdi_
.Font_GetFaceName(*args
, **kwargs
)
1986 def GetEncoding(*args
, **kwargs
):
1988 GetEncoding(self) -> int
1990 Get the font's encoding.
1992 return _gdi_
.Font_GetEncoding(*args
, **kwargs
)
1994 def GetNativeFontInfo(*args
, **kwargs
):
1996 GetNativeFontInfo(self) -> NativeFontInfo
1998 Constructs a `wx.NativeFontInfo` object from this font.
2000 return _gdi_
.Font_GetNativeFontInfo(*args
, **kwargs
)
2002 def IsFixedWidth(*args
, **kwargs
):
2004 IsFixedWidth(self) -> bool
2006 Returns true if the font is a fixed width (or monospaced) font, false
2007 if it is a proportional one or font is invalid.
2009 return _gdi_
.Font_IsFixedWidth(*args
, **kwargs
)
2011 def GetNativeFontInfoDesc(*args
, **kwargs
):
2013 GetNativeFontInfoDesc(self) -> String
2015 Returns the platform-dependent string completely describing this font
2016 or an empty string if the font isn't valid.
2018 return _gdi_
.Font_GetNativeFontInfoDesc(*args
, **kwargs
)
2020 def GetNativeFontInfoUserDesc(*args
, **kwargs
):
2022 GetNativeFontInfoUserDesc(self) -> String
2024 Returns a human readable version of `GetNativeFontInfoDesc`.
2026 return _gdi_
.Font_GetNativeFontInfoUserDesc(*args
, **kwargs
)
2028 def SetPointSize(*args
, **kwargs
):
2030 SetPointSize(self, int pointSize)
2032 Sets the point size.
2034 return _gdi_
.Font_SetPointSize(*args
, **kwargs
)
2036 def SetPixelSize(*args
, **kwargs
):
2038 SetPixelSize(self, Size pixelSize)
2040 Sets the size in pixels rather than points. If there is platform API
2041 support for this then it is used, otherwise a font with the closest
2042 size is found using a binary search.
2044 return _gdi_
.Font_SetPixelSize(*args
, **kwargs
)
2046 def SetFamily(*args
, **kwargs
):
2048 SetFamily(self, int family)
2050 Sets the font family.
2052 return _gdi_
.Font_SetFamily(*args
, **kwargs
)
2054 def SetStyle(*args
, **kwargs
):
2056 SetStyle(self, int style)
2058 Sets the font style.
2060 return _gdi_
.Font_SetStyle(*args
, **kwargs
)
2062 def SetWeight(*args
, **kwargs
):
2064 SetWeight(self, int weight)
2066 Sets the font weight.
2068 return _gdi_
.Font_SetWeight(*args
, **kwargs
)
2070 def SetFaceName(*args
, **kwargs
):
2072 SetFaceName(self, String faceName) -> bool
2074 Sets the facename for the font. The facename, which should be a valid
2075 font installed on the end-user's system.
2077 To avoid portability problems, don't rely on a specific face, but
2078 specify the font family instead or as well. A suitable font will be
2079 found on the end-user's system. If both the family and the facename
2080 are specified, wxWidgets will first search for the specific face, and
2081 then for a font belonging to the same family.
2083 return _gdi_
.Font_SetFaceName(*args
, **kwargs
)
2085 def SetUnderlined(*args
, **kwargs
):
2087 SetUnderlined(self, bool underlined)
2091 return _gdi_
.Font_SetUnderlined(*args
, **kwargs
)
2093 def SetEncoding(*args
, **kwargs
):
2095 SetEncoding(self, int encoding)
2097 Set the font encoding.
2099 return _gdi_
.Font_SetEncoding(*args
, **kwargs
)
2101 def SetNativeFontInfo(*args
, **kwargs
):
2103 SetNativeFontInfo(self, NativeFontInfo info)
2105 Set the font's attributes from a `wx.NativeFontInfo` object.
2107 return _gdi_
.Font_SetNativeFontInfo(*args
, **kwargs
)
2109 def SetNativeFontInfoFromString(*args
, **kwargs
):
2111 SetNativeFontInfoFromString(self, String info) -> bool
2113 Set the font's attributes from string representation of a
2114 `wx.NativeFontInfo` object.
2116 return _gdi_
.Font_SetNativeFontInfoFromString(*args
, **kwargs
)
2118 def SetNativeFontInfoUserDesc(*args
, **kwargs
):
2120 SetNativeFontInfoUserDesc(self, String info) -> bool
2122 Set the font's attributes from a string formerly returned from
2123 `GetNativeFontInfoDesc`.
2125 return _gdi_
.Font_SetNativeFontInfoUserDesc(*args
, **kwargs
)
2127 def GetFamilyString(*args
, **kwargs
):
2129 GetFamilyString(self) -> String
2131 Returns a string representation of the font family.
2133 return _gdi_
.Font_GetFamilyString(*args
, **kwargs
)
2135 def GetStyleString(*args
, **kwargs
):
2137 GetStyleString(self) -> String
2139 Returns a string representation of the font style.
2141 return _gdi_
.Font_GetStyleString(*args
, **kwargs
)
2143 def GetWeightString(*args
, **kwargs
):
2145 GetWeightString(self) -> String
2147 Return a string representation of the font weight.
2149 return _gdi_
.Font_GetWeightString(*args
, **kwargs
)
2151 def SetNoAntiAliasing(*args
, **kwargs
):
2152 """SetNoAntiAliasing(self, bool no=True)"""
2153 return _gdi_
.Font_SetNoAntiAliasing(*args
, **kwargs
)
2155 def GetNoAntiAliasing(*args
, **kwargs
):
2156 """GetNoAntiAliasing(self) -> bool"""
2157 return _gdi_
.Font_GetNoAntiAliasing(*args
, **kwargs
)
2159 def GetDefaultEncoding(*args
, **kwargs
):
2161 GetDefaultEncoding() -> int
2163 Returns the encoding used for all fonts created with an encoding of
2164 ``wx.FONTENCODING_DEFAULT``.
2166 return _gdi_
.Font_GetDefaultEncoding(*args
, **kwargs
)
2168 GetDefaultEncoding
= staticmethod(GetDefaultEncoding
)
2169 def SetDefaultEncoding(*args
, **kwargs
):
2171 SetDefaultEncoding(int encoding)
2173 Sets the default font encoding.
2175 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
2177 SetDefaultEncoding
= staticmethod(SetDefaultEncoding
)
2178 Encoding
= property(GetEncoding
,SetEncoding
,doc
="See `GetEncoding` and `SetEncoding`")
2179 FaceName
= property(GetFaceName
,SetFaceName
,doc
="See `GetFaceName` and `SetFaceName`")
2180 Family
= property(GetFamily
,SetFamily
,doc
="See `GetFamily` and `SetFamily`")
2181 FamilyString
= property(GetFamilyString
,doc
="See `GetFamilyString`")
2182 NativeFontInfo
= property(GetNativeFontInfo
,SetNativeFontInfo
,doc
="See `GetNativeFontInfo` and `SetNativeFontInfo`")
2183 NativeFontInfoDesc
= property(GetNativeFontInfoDesc
,doc
="See `GetNativeFontInfoDesc`")
2184 NativeFontInfoUserDesc
= property(GetNativeFontInfoUserDesc
,SetNativeFontInfoUserDesc
,doc
="See `GetNativeFontInfoUserDesc` and `SetNativeFontInfoUserDesc`")
2185 NoAntiAliasing
= property(GetNoAntiAliasing
,SetNoAntiAliasing
,doc
="See `GetNoAntiAliasing` and `SetNoAntiAliasing`")
2186 PixelSize
= property(GetPixelSize
,SetPixelSize
,doc
="See `GetPixelSize` and `SetPixelSize`")
2187 PointSize
= property(GetPointSize
,SetPointSize
,doc
="See `GetPointSize` and `SetPointSize`")
2188 Style
= property(GetStyle
,SetStyle
,doc
="See `GetStyle` and `SetStyle`")
2189 StyleString
= property(GetStyleString
,doc
="See `GetStyleString`")
2190 Underlined
= property(GetUnderlined
,SetUnderlined
,doc
="See `GetUnderlined` and `SetUnderlined`")
2191 Weight
= property(GetWeight
,SetWeight
,doc
="See `GetWeight` and `SetWeight`")
2192 WeightString
= property(GetWeightString
,doc
="See `GetWeightString`")
2193 _gdi_
.Font_swigregister(Font
)
2195 def FontFromNativeInfo(*args
, **kwargs
):
2197 FontFromNativeInfo(NativeFontInfo info) -> Font
2199 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
2201 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2202 val
= _gdi_
.new_FontFromNativeInfo(*args
, **kwargs
)
2205 def FontFromNativeInfoString(*args
, **kwargs
):
2207 FontFromNativeInfoString(String info) -> Font
2209 Construct a `wx.Font` from the string representation of a
2210 `wx.NativeFontInfo` object.
2212 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2213 val
= _gdi_
.new_FontFromNativeInfoString(*args
, **kwargs
)
2216 def FFont(*args
, **kwargs
):
2218 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
2219 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2221 A bit of a simpler way to create a `wx.Font` using flags instead of
2222 individual attribute settings. The value of flags can be a
2223 combination of the following:
2225 ============================ ==
2231 wx.FONTFLAG_ANTIALIASED
2232 wx.FONTFLAG_NOT_ANTIALIASED
2233 wx.FONTFLAG_UNDERLINED
2234 wx.FONTFLAG_STRIKETHROUGH
2235 ============================ ==
2237 :see: `wx.Font.__init__`
2239 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2240 val
= _gdi_
.new_FFont(*args
, **kwargs
)
2243 def FontFromPixelSize(*args
, **kwargs
):
2245 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
2246 bool underlined=False, String face=wxEmptyString,
2247 int encoding=FONTENCODING_DEFAULT) -> Font
2249 Creates a font using a size in pixels rather than points. If there is
2250 platform API support for this then it is used, otherwise a font with
2251 the closest size is found using a binary search.
2253 :see: `wx.Font.__init__`
2255 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2256 val
= _gdi_
.new_FontFromPixelSize(*args
, **kwargs
)
2259 def FFontFromPixelSize(*args
, **kwargs
):
2261 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
2262 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2264 Creates a font using a size in pixels rather than points. If there is
2265 platform API support for this then it is used, otherwise a font with
2266 the closest size is found using a binary search.
2268 :see: `wx.Font.__init__`, `wx.FFont`
2270 if kwargs
.has_key('faceName'): kwargs
['face'] = kwargs
['faceName'];del kwargs
['faceName']
2271 val
= _gdi_
.new_FFontFromPixelSize(*args
, **kwargs
)
2274 def Font_GetDefaultEncoding(*args
):
2276 Font_GetDefaultEncoding() -> int
2278 Returns the encoding used for all fonts created with an encoding of
2279 ``wx.FONTENCODING_DEFAULT``.
2281 return _gdi_
.Font_GetDefaultEncoding(*args
)
2283 def Font_SetDefaultEncoding(*args
, **kwargs
):
2285 Font_SetDefaultEncoding(int encoding)
2287 Sets the default font encoding.
2289 return _gdi_
.Font_SetDefaultEncoding(*args
, **kwargs
)
2291 Font2
= wx
._deprecated
(FFont
, "Use `wx.FFont` instead.")
2292 #---------------------------------------------------------------------------
2294 class FontEnumerator(object):
2295 """Proxy of C++ FontEnumerator class"""
2296 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2297 __repr__
= _swig_repr
2298 def __init__(self
, *args
, **kwargs
):
2299 """__init__(self) -> FontEnumerator"""
2300 _gdi_
.FontEnumerator_swiginit(self
,_gdi_
.new_FontEnumerator(*args
, **kwargs
))
2301 self
._setCallbackInfo
(self
, FontEnumerator
, 0)
2303 __swig_destroy__
= _gdi_
.delete_FontEnumerator
2304 __del__
= lambda self
: None;
2305 def _setCallbackInfo(*args
, **kwargs
):
2306 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
2307 return _gdi_
.FontEnumerator__setCallbackInfo(*args
, **kwargs
)
2309 def EnumerateFacenames(*args
, **kwargs
):
2310 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
2311 return _gdi_
.FontEnumerator_EnumerateFacenames(*args
, **kwargs
)
2313 def EnumerateEncodings(*args
, **kwargs
):
2314 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
2315 return _gdi_
.FontEnumerator_EnumerateEncodings(*args
, **kwargs
)
2317 def GetEncodings(*args
, **kwargs
):
2318 """GetEncodings() -> PyObject"""
2319 return _gdi_
.FontEnumerator_GetEncodings(*args
, **kwargs
)
2321 GetEncodings
= staticmethod(GetEncodings
)
2322 def GetFacenames(*args
, **kwargs
):
2323 """GetFacenames() -> PyObject"""
2324 return _gdi_
.FontEnumerator_GetFacenames(*args
, **kwargs
)
2326 GetFacenames
= staticmethod(GetFacenames
)
2327 def IsValidFacename(*args
, **kwargs
):
2329 IsValidFacename(String str) -> bool
2331 Convenience function that returns true if the given face name exist in
2334 return _gdi_
.FontEnumerator_IsValidFacename(*args
, **kwargs
)
2336 IsValidFacename
= staticmethod(IsValidFacename
)
2337 _gdi_
.FontEnumerator_swigregister(FontEnumerator
)
2339 def FontEnumerator_GetEncodings(*args
):
2340 """FontEnumerator_GetEncodings() -> PyObject"""
2341 return _gdi_
.FontEnumerator_GetEncodings(*args
)
2343 def FontEnumerator_GetFacenames(*args
):
2344 """FontEnumerator_GetFacenames() -> PyObject"""
2345 return _gdi_
.FontEnumerator_GetFacenames(*args
)
2347 def FontEnumerator_IsValidFacename(*args
, **kwargs
):
2349 FontEnumerator_IsValidFacename(String str) -> bool
2351 Convenience function that returns true if the given face name exist in
2354 return _gdi_
.FontEnumerator_IsValidFacename(*args
, **kwargs
)
2356 #---------------------------------------------------------------------------
2358 LANGUAGE_DEFAULT
= _gdi_
.LANGUAGE_DEFAULT
2359 LANGUAGE_UNKNOWN
= _gdi_
.LANGUAGE_UNKNOWN
2360 LANGUAGE_ABKHAZIAN
= _gdi_
.LANGUAGE_ABKHAZIAN
2361 LANGUAGE_AFAR
= _gdi_
.LANGUAGE_AFAR
2362 LANGUAGE_AFRIKAANS
= _gdi_
.LANGUAGE_AFRIKAANS
2363 LANGUAGE_ALBANIAN
= _gdi_
.LANGUAGE_ALBANIAN
2364 LANGUAGE_AMHARIC
= _gdi_
.LANGUAGE_AMHARIC
2365 LANGUAGE_ARABIC
= _gdi_
.LANGUAGE_ARABIC
2366 LANGUAGE_ARABIC_ALGERIA
= _gdi_
.LANGUAGE_ARABIC_ALGERIA
2367 LANGUAGE_ARABIC_BAHRAIN
= _gdi_
.LANGUAGE_ARABIC_BAHRAIN
2368 LANGUAGE_ARABIC_EGYPT
= _gdi_
.LANGUAGE_ARABIC_EGYPT
2369 LANGUAGE_ARABIC_IRAQ
= _gdi_
.LANGUAGE_ARABIC_IRAQ
2370 LANGUAGE_ARABIC_JORDAN
= _gdi_
.LANGUAGE_ARABIC_JORDAN
2371 LANGUAGE_ARABIC_KUWAIT
= _gdi_
.LANGUAGE_ARABIC_KUWAIT
2372 LANGUAGE_ARABIC_LEBANON
= _gdi_
.LANGUAGE_ARABIC_LEBANON
2373 LANGUAGE_ARABIC_LIBYA
= _gdi_
.LANGUAGE_ARABIC_LIBYA
2374 LANGUAGE_ARABIC_MOROCCO
= _gdi_
.LANGUAGE_ARABIC_MOROCCO
2375 LANGUAGE_ARABIC_OMAN
= _gdi_
.LANGUAGE_ARABIC_OMAN
2376 LANGUAGE_ARABIC_QATAR
= _gdi_
.LANGUAGE_ARABIC_QATAR
2377 LANGUAGE_ARABIC_SAUDI_ARABIA
= _gdi_
.LANGUAGE_ARABIC_SAUDI_ARABIA
2378 LANGUAGE_ARABIC_SUDAN
= _gdi_
.LANGUAGE_ARABIC_SUDAN
2379 LANGUAGE_ARABIC_SYRIA
= _gdi_
.LANGUAGE_ARABIC_SYRIA
2380 LANGUAGE_ARABIC_TUNISIA
= _gdi_
.LANGUAGE_ARABIC_TUNISIA
2381 LANGUAGE_ARABIC_UAE
= _gdi_
.LANGUAGE_ARABIC_UAE
2382 LANGUAGE_ARABIC_YEMEN
= _gdi_
.LANGUAGE_ARABIC_YEMEN
2383 LANGUAGE_ARMENIAN
= _gdi_
.LANGUAGE_ARMENIAN
2384 LANGUAGE_ASSAMESE
= _gdi_
.LANGUAGE_ASSAMESE
2385 LANGUAGE_AYMARA
= _gdi_
.LANGUAGE_AYMARA
2386 LANGUAGE_AZERI
= _gdi_
.LANGUAGE_AZERI
2387 LANGUAGE_AZERI_CYRILLIC
= _gdi_
.LANGUAGE_AZERI_CYRILLIC
2388 LANGUAGE_AZERI_LATIN
= _gdi_
.LANGUAGE_AZERI_LATIN
2389 LANGUAGE_BASHKIR
= _gdi_
.LANGUAGE_BASHKIR
2390 LANGUAGE_BASQUE
= _gdi_
.LANGUAGE_BASQUE
2391 LANGUAGE_BELARUSIAN
= _gdi_
.LANGUAGE_BELARUSIAN
2392 LANGUAGE_BENGALI
= _gdi_
.LANGUAGE_BENGALI
2393 LANGUAGE_BHUTANI
= _gdi_
.LANGUAGE_BHUTANI
2394 LANGUAGE_BIHARI
= _gdi_
.LANGUAGE_BIHARI
2395 LANGUAGE_BISLAMA
= _gdi_
.LANGUAGE_BISLAMA
2396 LANGUAGE_BRETON
= _gdi_
.LANGUAGE_BRETON
2397 LANGUAGE_BULGARIAN
= _gdi_
.LANGUAGE_BULGARIAN
2398 LANGUAGE_BURMESE
= _gdi_
.LANGUAGE_BURMESE
2399 LANGUAGE_CAMBODIAN
= _gdi_
.LANGUAGE_CAMBODIAN
2400 LANGUAGE_CATALAN
= _gdi_
.LANGUAGE_CATALAN
2401 LANGUAGE_CHINESE
= _gdi_
.LANGUAGE_CHINESE
2402 LANGUAGE_CHINESE_SIMPLIFIED
= _gdi_
.LANGUAGE_CHINESE_SIMPLIFIED
2403 LANGUAGE_CHINESE_TRADITIONAL
= _gdi_
.LANGUAGE_CHINESE_TRADITIONAL
2404 LANGUAGE_CHINESE_HONGKONG
= _gdi_
.LANGUAGE_CHINESE_HONGKONG
2405 LANGUAGE_CHINESE_MACAU
= _gdi_
.LANGUAGE_CHINESE_MACAU
2406 LANGUAGE_CHINESE_SINGAPORE
= _gdi_
.LANGUAGE_CHINESE_SINGAPORE
2407 LANGUAGE_CHINESE_TAIWAN
= _gdi_
.LANGUAGE_CHINESE_TAIWAN
2408 LANGUAGE_CORSICAN
= _gdi_
.LANGUAGE_CORSICAN
2409 LANGUAGE_CROATIAN
= _gdi_
.LANGUAGE_CROATIAN
2410 LANGUAGE_CZECH
= _gdi_
.LANGUAGE_CZECH
2411 LANGUAGE_DANISH
= _gdi_
.LANGUAGE_DANISH
2412 LANGUAGE_DUTCH
= _gdi_
.LANGUAGE_DUTCH
2413 LANGUAGE_DUTCH_BELGIAN
= _gdi_
.LANGUAGE_DUTCH_BELGIAN
2414 LANGUAGE_ENGLISH
= _gdi_
.LANGUAGE_ENGLISH
2415 LANGUAGE_ENGLISH_UK
= _gdi_
.LANGUAGE_ENGLISH_UK
2416 LANGUAGE_ENGLISH_US
= _gdi_
.LANGUAGE_ENGLISH_US
2417 LANGUAGE_ENGLISH_AUSTRALIA
= _gdi_
.LANGUAGE_ENGLISH_AUSTRALIA
2418 LANGUAGE_ENGLISH_BELIZE
= _gdi_
.LANGUAGE_ENGLISH_BELIZE
2419 LANGUAGE_ENGLISH_BOTSWANA
= _gdi_
.LANGUAGE_ENGLISH_BOTSWANA
2420 LANGUAGE_ENGLISH_CANADA
= _gdi_
.LANGUAGE_ENGLISH_CANADA
2421 LANGUAGE_ENGLISH_CARIBBEAN
= _gdi_
.LANGUAGE_ENGLISH_CARIBBEAN
2422 LANGUAGE_ENGLISH_DENMARK
= _gdi_
.LANGUAGE_ENGLISH_DENMARK
2423 LANGUAGE_ENGLISH_EIRE
= _gdi_
.LANGUAGE_ENGLISH_EIRE
2424 LANGUAGE_ENGLISH_JAMAICA
= _gdi_
.LANGUAGE_ENGLISH_JAMAICA
2425 LANGUAGE_ENGLISH_NEW_ZEALAND
= _gdi_
.LANGUAGE_ENGLISH_NEW_ZEALAND
2426 LANGUAGE_ENGLISH_PHILIPPINES
= _gdi_
.LANGUAGE_ENGLISH_PHILIPPINES
2427 LANGUAGE_ENGLISH_SOUTH_AFRICA
= _gdi_
.LANGUAGE_ENGLISH_SOUTH_AFRICA
2428 LANGUAGE_ENGLISH_TRINIDAD
= _gdi_
.LANGUAGE_ENGLISH_TRINIDAD
2429 LANGUAGE_ENGLISH_ZIMBABWE
= _gdi_
.LANGUAGE_ENGLISH_ZIMBABWE
2430 LANGUAGE_ESPERANTO
= _gdi_
.LANGUAGE_ESPERANTO
2431 LANGUAGE_ESTONIAN
= _gdi_
.LANGUAGE_ESTONIAN
2432 LANGUAGE_FAEROESE
= _gdi_
.LANGUAGE_FAEROESE
2433 LANGUAGE_FARSI
= _gdi_
.LANGUAGE_FARSI
2434 LANGUAGE_FIJI
= _gdi_
.LANGUAGE_FIJI
2435 LANGUAGE_FINNISH
= _gdi_
.LANGUAGE_FINNISH
2436 LANGUAGE_FRENCH
= _gdi_
.LANGUAGE_FRENCH
2437 LANGUAGE_FRENCH_BELGIAN
= _gdi_
.LANGUAGE_FRENCH_BELGIAN
2438 LANGUAGE_FRENCH_CANADIAN
= _gdi_
.LANGUAGE_FRENCH_CANADIAN
2439 LANGUAGE_FRENCH_LUXEMBOURG
= _gdi_
.LANGUAGE_FRENCH_LUXEMBOURG
2440 LANGUAGE_FRENCH_MONACO
= _gdi_
.LANGUAGE_FRENCH_MONACO
2441 LANGUAGE_FRENCH_SWISS
= _gdi_
.LANGUAGE_FRENCH_SWISS
2442 LANGUAGE_FRISIAN
= _gdi_
.LANGUAGE_FRISIAN
2443 LANGUAGE_GALICIAN
= _gdi_
.LANGUAGE_GALICIAN
2444 LANGUAGE_GEORGIAN
= _gdi_
.LANGUAGE_GEORGIAN
2445 LANGUAGE_GERMAN
= _gdi_
.LANGUAGE_GERMAN
2446 LANGUAGE_GERMAN_AUSTRIAN
= _gdi_
.LANGUAGE_GERMAN_AUSTRIAN
2447 LANGUAGE_GERMAN_BELGIUM
= _gdi_
.LANGUAGE_GERMAN_BELGIUM
2448 LANGUAGE_GERMAN_LIECHTENSTEIN
= _gdi_
.LANGUAGE_GERMAN_LIECHTENSTEIN
2449 LANGUAGE_GERMAN_LUXEMBOURG
= _gdi_
.LANGUAGE_GERMAN_LUXEMBOURG
2450 LANGUAGE_GERMAN_SWISS
= _gdi_
.LANGUAGE_GERMAN_SWISS
2451 LANGUAGE_GREEK
= _gdi_
.LANGUAGE_GREEK
2452 LANGUAGE_GREENLANDIC
= _gdi_
.LANGUAGE_GREENLANDIC
2453 LANGUAGE_GUARANI
= _gdi_
.LANGUAGE_GUARANI
2454 LANGUAGE_GUJARATI
= _gdi_
.LANGUAGE_GUJARATI
2455 LANGUAGE_HAUSA
= _gdi_
.LANGUAGE_HAUSA
2456 LANGUAGE_HEBREW
= _gdi_
.LANGUAGE_HEBREW
2457 LANGUAGE_HINDI
= _gdi_
.LANGUAGE_HINDI
2458 LANGUAGE_HUNGARIAN
= _gdi_
.LANGUAGE_HUNGARIAN
2459 LANGUAGE_ICELANDIC
= _gdi_
.LANGUAGE_ICELANDIC
2460 LANGUAGE_INDONESIAN
= _gdi_
.LANGUAGE_INDONESIAN
2461 LANGUAGE_INTERLINGUA
= _gdi_
.LANGUAGE_INTERLINGUA
2462 LANGUAGE_INTERLINGUE
= _gdi_
.LANGUAGE_INTERLINGUE
2463 LANGUAGE_INUKTITUT
= _gdi_
.LANGUAGE_INUKTITUT
2464 LANGUAGE_INUPIAK
= _gdi_
.LANGUAGE_INUPIAK
2465 LANGUAGE_IRISH
= _gdi_
.LANGUAGE_IRISH
2466 LANGUAGE_ITALIAN
= _gdi_
.LANGUAGE_ITALIAN
2467 LANGUAGE_ITALIAN_SWISS
= _gdi_
.LANGUAGE_ITALIAN_SWISS
2468 LANGUAGE_JAPANESE
= _gdi_
.LANGUAGE_JAPANESE
2469 LANGUAGE_JAVANESE
= _gdi_
.LANGUAGE_JAVANESE
2470 LANGUAGE_KANNADA
= _gdi_
.LANGUAGE_KANNADA
2471 LANGUAGE_KASHMIRI
= _gdi_
.LANGUAGE_KASHMIRI
2472 LANGUAGE_KASHMIRI_INDIA
= _gdi_
.LANGUAGE_KASHMIRI_INDIA
2473 LANGUAGE_KAZAKH
= _gdi_
.LANGUAGE_KAZAKH
2474 LANGUAGE_KERNEWEK
= _gdi_
.LANGUAGE_KERNEWEK
2475 LANGUAGE_KINYARWANDA
= _gdi_
.LANGUAGE_KINYARWANDA
2476 LANGUAGE_KIRGHIZ
= _gdi_
.LANGUAGE_KIRGHIZ
2477 LANGUAGE_KIRUNDI
= _gdi_
.LANGUAGE_KIRUNDI
2478 LANGUAGE_KONKANI
= _gdi_
.LANGUAGE_KONKANI
2479 LANGUAGE_KOREAN
= _gdi_
.LANGUAGE_KOREAN
2480 LANGUAGE_KURDISH
= _gdi_
.LANGUAGE_KURDISH
2481 LANGUAGE_LAOTHIAN
= _gdi_
.LANGUAGE_LAOTHIAN
2482 LANGUAGE_LATIN
= _gdi_
.LANGUAGE_LATIN
2483 LANGUAGE_LATVIAN
= _gdi_
.LANGUAGE_LATVIAN
2484 LANGUAGE_LINGALA
= _gdi_
.LANGUAGE_LINGALA
2485 LANGUAGE_LITHUANIAN
= _gdi_
.LANGUAGE_LITHUANIAN
2486 LANGUAGE_MACEDONIAN
= _gdi_
.LANGUAGE_MACEDONIAN
2487 LANGUAGE_MALAGASY
= _gdi_
.LANGUAGE_MALAGASY
2488 LANGUAGE_MALAY
= _gdi_
.LANGUAGE_MALAY
2489 LANGUAGE_MALAYALAM
= _gdi_
.LANGUAGE_MALAYALAM
2490 LANGUAGE_MALAY_BRUNEI_DARUSSALAM
= _gdi_
.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2491 LANGUAGE_MALAY_MALAYSIA
= _gdi_
.LANGUAGE_MALAY_MALAYSIA
2492 LANGUAGE_MALTESE
= _gdi_
.LANGUAGE_MALTESE
2493 LANGUAGE_MANIPURI
= _gdi_
.LANGUAGE_MANIPURI
2494 LANGUAGE_MAORI
= _gdi_
.LANGUAGE_MAORI
2495 LANGUAGE_MARATHI
= _gdi_
.LANGUAGE_MARATHI
2496 LANGUAGE_MOLDAVIAN
= _gdi_
.LANGUAGE_MOLDAVIAN
2497 LANGUAGE_MONGOLIAN
= _gdi_
.LANGUAGE_MONGOLIAN
2498 LANGUAGE_NAURU
= _gdi_
.LANGUAGE_NAURU
2499 LANGUAGE_NEPALI
= _gdi_
.LANGUAGE_NEPALI
2500 LANGUAGE_NEPALI_INDIA
= _gdi_
.LANGUAGE_NEPALI_INDIA
2501 LANGUAGE_NORWEGIAN_BOKMAL
= _gdi_
.LANGUAGE_NORWEGIAN_BOKMAL
2502 LANGUAGE_NORWEGIAN_NYNORSK
= _gdi_
.LANGUAGE_NORWEGIAN_NYNORSK
2503 LANGUAGE_OCCITAN
= _gdi_
.LANGUAGE_OCCITAN
2504 LANGUAGE_ORIYA
= _gdi_
.LANGUAGE_ORIYA
2505 LANGUAGE_OROMO
= _gdi_
.LANGUAGE_OROMO
2506 LANGUAGE_PASHTO
= _gdi_
.LANGUAGE_PASHTO
2507 LANGUAGE_POLISH
= _gdi_
.LANGUAGE_POLISH
2508 LANGUAGE_PORTUGUESE
= _gdi_
.LANGUAGE_PORTUGUESE
2509 LANGUAGE_PORTUGUESE_BRAZILIAN
= _gdi_
.LANGUAGE_PORTUGUESE_BRAZILIAN
2510 LANGUAGE_PUNJABI
= _gdi_
.LANGUAGE_PUNJABI
2511 LANGUAGE_QUECHUA
= _gdi_
.LANGUAGE_QUECHUA
2512 LANGUAGE_RHAETO_ROMANCE
= _gdi_
.LANGUAGE_RHAETO_ROMANCE
2513 LANGUAGE_ROMANIAN
= _gdi_
.LANGUAGE_ROMANIAN
2514 LANGUAGE_RUSSIAN
= _gdi_
.LANGUAGE_RUSSIAN
2515 LANGUAGE_RUSSIAN_UKRAINE
= _gdi_
.LANGUAGE_RUSSIAN_UKRAINE
2516 LANGUAGE_SAMOAN
= _gdi_
.LANGUAGE_SAMOAN
2517 LANGUAGE_SANGHO
= _gdi_
.LANGUAGE_SANGHO
2518 LANGUAGE_SANSKRIT
= _gdi_
.LANGUAGE_SANSKRIT
2519 LANGUAGE_SCOTS_GAELIC
= _gdi_
.LANGUAGE_SCOTS_GAELIC
2520 LANGUAGE_SERBIAN
= _gdi_
.LANGUAGE_SERBIAN
2521 LANGUAGE_SERBIAN_CYRILLIC
= _gdi_
.LANGUAGE_SERBIAN_CYRILLIC
2522 LANGUAGE_SERBIAN_LATIN
= _gdi_
.LANGUAGE_SERBIAN_LATIN
2523 LANGUAGE_SERBO_CROATIAN
= _gdi_
.LANGUAGE_SERBO_CROATIAN
2524 LANGUAGE_SESOTHO
= _gdi_
.LANGUAGE_SESOTHO
2525 LANGUAGE_SETSWANA
= _gdi_
.LANGUAGE_SETSWANA
2526 LANGUAGE_SHONA
= _gdi_
.LANGUAGE_SHONA
2527 LANGUAGE_SINDHI
= _gdi_
.LANGUAGE_SINDHI
2528 LANGUAGE_SINHALESE
= _gdi_
.LANGUAGE_SINHALESE
2529 LANGUAGE_SISWATI
= _gdi_
.LANGUAGE_SISWATI
2530 LANGUAGE_SLOVAK
= _gdi_
.LANGUAGE_SLOVAK
2531 LANGUAGE_SLOVENIAN
= _gdi_
.LANGUAGE_SLOVENIAN
2532 LANGUAGE_SOMALI
= _gdi_
.LANGUAGE_SOMALI
2533 LANGUAGE_SPANISH
= _gdi_
.LANGUAGE_SPANISH
2534 LANGUAGE_SPANISH_ARGENTINA
= _gdi_
.LANGUAGE_SPANISH_ARGENTINA
2535 LANGUAGE_SPANISH_BOLIVIA
= _gdi_
.LANGUAGE_SPANISH_BOLIVIA
2536 LANGUAGE_SPANISH_CHILE
= _gdi_
.LANGUAGE_SPANISH_CHILE
2537 LANGUAGE_SPANISH_COLOMBIA
= _gdi_
.LANGUAGE_SPANISH_COLOMBIA
2538 LANGUAGE_SPANISH_COSTA_RICA
= _gdi_
.LANGUAGE_SPANISH_COSTA_RICA
2539 LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
= _gdi_
.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2540 LANGUAGE_SPANISH_ECUADOR
= _gdi_
.LANGUAGE_SPANISH_ECUADOR
2541 LANGUAGE_SPANISH_EL_SALVADOR
= _gdi_
.LANGUAGE_SPANISH_EL_SALVADOR
2542 LANGUAGE_SPANISH_GUATEMALA
= _gdi_
.LANGUAGE_SPANISH_GUATEMALA
2543 LANGUAGE_SPANISH_HONDURAS
= _gdi_
.LANGUAGE_SPANISH_HONDURAS
2544 LANGUAGE_SPANISH_MEXICAN
= _gdi_
.LANGUAGE_SPANISH_MEXICAN
2545 LANGUAGE_SPANISH_MODERN
= _gdi_
.LANGUAGE_SPANISH_MODERN
2546 LANGUAGE_SPANISH_NICARAGUA
= _gdi_
.LANGUAGE_SPANISH_NICARAGUA
2547 LANGUAGE_SPANISH_PANAMA
= _gdi_
.LANGUAGE_SPANISH_PANAMA
2548 LANGUAGE_SPANISH_PARAGUAY
= _gdi_
.LANGUAGE_SPANISH_PARAGUAY
2549 LANGUAGE_SPANISH_PERU
= _gdi_
.LANGUAGE_SPANISH_PERU
2550 LANGUAGE_SPANISH_PUERTO_RICO
= _gdi_
.LANGUAGE_SPANISH_PUERTO_RICO
2551 LANGUAGE_SPANISH_URUGUAY
= _gdi_
.LANGUAGE_SPANISH_URUGUAY
2552 LANGUAGE_SPANISH_US
= _gdi_
.LANGUAGE_SPANISH_US
2553 LANGUAGE_SPANISH_VENEZUELA
= _gdi_
.LANGUAGE_SPANISH_VENEZUELA
2554 LANGUAGE_SUNDANESE
= _gdi_
.LANGUAGE_SUNDANESE
2555 LANGUAGE_SWAHILI
= _gdi_
.LANGUAGE_SWAHILI
2556 LANGUAGE_SWEDISH
= _gdi_
.LANGUAGE_SWEDISH
2557 LANGUAGE_SWEDISH_FINLAND
= _gdi_
.LANGUAGE_SWEDISH_FINLAND
2558 LANGUAGE_TAGALOG
= _gdi_
.LANGUAGE_TAGALOG
2559 LANGUAGE_TAJIK
= _gdi_
.LANGUAGE_TAJIK
2560 LANGUAGE_TAMIL
= _gdi_
.LANGUAGE_TAMIL
2561 LANGUAGE_TATAR
= _gdi_
.LANGUAGE_TATAR
2562 LANGUAGE_TELUGU
= _gdi_
.LANGUAGE_TELUGU
2563 LANGUAGE_THAI
= _gdi_
.LANGUAGE_THAI
2564 LANGUAGE_TIBETAN
= _gdi_
.LANGUAGE_TIBETAN
2565 LANGUAGE_TIGRINYA
= _gdi_
.LANGUAGE_TIGRINYA
2566 LANGUAGE_TONGA
= _gdi_
.LANGUAGE_TONGA
2567 LANGUAGE_TSONGA
= _gdi_
.LANGUAGE_TSONGA
2568 LANGUAGE_TURKISH
= _gdi_
.LANGUAGE_TURKISH
2569 LANGUAGE_TURKMEN
= _gdi_
.LANGUAGE_TURKMEN
2570 LANGUAGE_TWI
= _gdi_
.LANGUAGE_TWI
2571 LANGUAGE_UIGHUR
= _gdi_
.LANGUAGE_UIGHUR
2572 LANGUAGE_UKRAINIAN
= _gdi_
.LANGUAGE_UKRAINIAN
2573 LANGUAGE_URDU
= _gdi_
.LANGUAGE_URDU
2574 LANGUAGE_URDU_INDIA
= _gdi_
.LANGUAGE_URDU_INDIA
2575 LANGUAGE_URDU_PAKISTAN
= _gdi_
.LANGUAGE_URDU_PAKISTAN
2576 LANGUAGE_UZBEK
= _gdi_
.LANGUAGE_UZBEK
2577 LANGUAGE_UZBEK_CYRILLIC
= _gdi_
.LANGUAGE_UZBEK_CYRILLIC
2578 LANGUAGE_UZBEK_LATIN
= _gdi_
.LANGUAGE_UZBEK_LATIN
2579 LANGUAGE_VIETNAMESE
= _gdi_
.LANGUAGE_VIETNAMESE
2580 LANGUAGE_VOLAPUK
= _gdi_
.LANGUAGE_VOLAPUK
2581 LANGUAGE_WELSH
= _gdi_
.LANGUAGE_WELSH
2582 LANGUAGE_WOLOF
= _gdi_
.LANGUAGE_WOLOF
2583 LANGUAGE_XHOSA
= _gdi_
.LANGUAGE_XHOSA
2584 LANGUAGE_YIDDISH
= _gdi_
.LANGUAGE_YIDDISH
2585 LANGUAGE_YORUBA
= _gdi_
.LANGUAGE_YORUBA
2586 LANGUAGE_ZHUANG
= _gdi_
.LANGUAGE_ZHUANG
2587 LANGUAGE_ZULU
= _gdi_
.LANGUAGE_ZULU
2588 LANGUAGE_USER_DEFINED
= _gdi_
.LANGUAGE_USER_DEFINED
2589 class LanguageInfo(object):
2590 """Proxy of C++ LanguageInfo class"""
2591 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2592 def __init__(self
): raise AttributeError, "No constructor defined"
2593 __repr__
= _swig_repr
2594 Language
= property(_gdi_
.LanguageInfo_Language_get
, _gdi_
.LanguageInfo_Language_set
)
2595 CanonicalName
= property(_gdi_
.LanguageInfo_CanonicalName_get
, _gdi_
.LanguageInfo_CanonicalName_set
)
2596 Description
= property(_gdi_
.LanguageInfo_Description_get
, _gdi_
.LanguageInfo_Description_set
)
2597 _gdi_
.LanguageInfo_swigregister(LanguageInfo
)
2599 LOCALE_CAT_NUMBER
= _gdi_
.LOCALE_CAT_NUMBER
2600 LOCALE_CAT_DATE
= _gdi_
.LOCALE_CAT_DATE
2601 LOCALE_CAT_MONEY
= _gdi_
.LOCALE_CAT_MONEY
2602 LOCALE_CAT_MAX
= _gdi_
.LOCALE_CAT_MAX
2603 LOCALE_THOUSANDS_SEP
= _gdi_
.LOCALE_THOUSANDS_SEP
2604 LOCALE_DECIMAL_POINT
= _gdi_
.LOCALE_DECIMAL_POINT
2605 LOCALE_LOAD_DEFAULT
= _gdi_
.LOCALE_LOAD_DEFAULT
2606 LOCALE_CONV_ENCODING
= _gdi_
.LOCALE_CONV_ENCODING
2607 class Locale(object):
2608 """Proxy of C++ Locale class"""
2609 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2610 __repr__
= _swig_repr
2611 def __init__(self
, *args
, **kwargs
):
2612 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
2613 _gdi_
.Locale_swiginit(self
,_gdi_
.new_Locale(*args
, **kwargs
))
2614 __swig_destroy__
= _gdi_
.delete_Locale
2615 __del__
= lambda self
: None;
2616 def Init1(*args
, **kwargs
):
2618 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2619 bool bLoadDefault=True,
2620 bool bConvertEncoding=False) -> bool
2622 return _gdi_
.Locale_Init1(*args
, **kwargs
)
2624 def Init2(*args
, **kwargs
):
2625 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2626 return _gdi_
.Locale_Init2(*args
, **kwargs
)
2628 def Init(self
, *_args
, **_kwargs
):
2629 if type(_args
[0]) in [type(''), type(u
'')]:
2630 val
= self
.Init1(*_args
, **_kwargs
)
2632 val
= self
.Init2(*_args
, **_kwargs
)
2635 def GetSystemLanguage(*args
, **kwargs
):
2636 """GetSystemLanguage() -> int"""
2637 return _gdi_
.Locale_GetSystemLanguage(*args
, **kwargs
)
2639 GetSystemLanguage
= staticmethod(GetSystemLanguage
)
2640 def GetSystemEncoding(*args
, **kwargs
):
2641 """GetSystemEncoding() -> int"""
2642 return _gdi_
.Locale_GetSystemEncoding(*args
, **kwargs
)
2644 GetSystemEncoding
= staticmethod(GetSystemEncoding
)
2645 def GetSystemEncodingName(*args
, **kwargs
):
2646 """GetSystemEncodingName() -> String"""
2647 return _gdi_
.Locale_GetSystemEncodingName(*args
, **kwargs
)
2649 GetSystemEncodingName
= staticmethod(GetSystemEncodingName
)
2650 def IsOk(*args
, **kwargs
):
2651 """IsOk(self) -> bool"""
2652 return _gdi_
.Locale_IsOk(*args
, **kwargs
)
2654 def __nonzero__(self
): return self
.IsOk()
2655 def GetLocale(*args
, **kwargs
):
2656 """GetLocale(self) -> String"""
2657 return _gdi_
.Locale_GetLocale(*args
, **kwargs
)
2659 def GetLanguage(*args
, **kwargs
):
2660 """GetLanguage(self) -> int"""
2661 return _gdi_
.Locale_GetLanguage(*args
, **kwargs
)
2663 def GetSysName(*args
, **kwargs
):
2664 """GetSysName(self) -> String"""
2665 return _gdi_
.Locale_GetSysName(*args
, **kwargs
)
2667 def GetCanonicalName(*args
, **kwargs
):
2668 """GetCanonicalName(self) -> String"""
2669 return _gdi_
.Locale_GetCanonicalName(*args
, **kwargs
)
2671 def AddCatalogLookupPathPrefix(*args
, **kwargs
):
2672 """AddCatalogLookupPathPrefix(String prefix)"""
2673 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2675 AddCatalogLookupPathPrefix
= staticmethod(AddCatalogLookupPathPrefix
)
2676 def AddCatalog(*args
, **kwargs
):
2677 """AddCatalog(self, String szDomain) -> bool"""
2678 return _gdi_
.Locale_AddCatalog(*args
, **kwargs
)
2680 def IsAvailable(*args
, **kwargs
):
2681 """IsAvailable(int lang) -> bool"""
2682 return _gdi_
.Locale_IsAvailable(*args
, **kwargs
)
2684 IsAvailable
= staticmethod(IsAvailable
)
2685 def IsLoaded(*args
, **kwargs
):
2686 """IsLoaded(self, String szDomain) -> bool"""
2687 return _gdi_
.Locale_IsLoaded(*args
, **kwargs
)
2689 def GetLanguageInfo(*args
, **kwargs
):
2690 """GetLanguageInfo(int lang) -> LanguageInfo"""
2691 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2693 GetLanguageInfo
= staticmethod(GetLanguageInfo
)
2694 def GetLanguageName(*args
, **kwargs
):
2695 """GetLanguageName(int lang) -> String"""
2696 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2698 GetLanguageName
= staticmethod(GetLanguageName
)
2699 def FindLanguageInfo(*args
, **kwargs
):
2700 """FindLanguageInfo(String locale) -> LanguageInfo"""
2701 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2703 FindLanguageInfo
= staticmethod(FindLanguageInfo
)
2704 def AddLanguage(*args
, **kwargs
):
2705 """AddLanguage(LanguageInfo info)"""
2706 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2708 AddLanguage
= staticmethod(AddLanguage
)
2709 def GetString(*args
, **kwargs
):
2710 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2711 return _gdi_
.Locale_GetString(*args
, **kwargs
)
2713 def GetName(*args
, **kwargs
):
2714 """GetName(self) -> String"""
2715 return _gdi_
.Locale_GetName(*args
, **kwargs
)
2717 CanonicalName
= property(GetCanonicalName
,doc
="See `GetCanonicalName`")
2718 Language
= property(GetLanguage
,doc
="See `GetLanguage`")
2719 Locale
= property(GetLocale
,doc
="See `GetLocale`")
2720 Name
= property(GetName
,doc
="See `GetName`")
2721 String
= property(GetString
,doc
="See `GetString`")
2722 SysName
= property(GetSysName
,doc
="See `GetSysName`")
2723 _gdi_
.Locale_swigregister(Locale
)
2725 def Locale_GetSystemLanguage(*args
):
2726 """Locale_GetSystemLanguage() -> int"""
2727 return _gdi_
.Locale_GetSystemLanguage(*args
)
2729 def Locale_GetSystemEncoding(*args
):
2730 """Locale_GetSystemEncoding() -> int"""
2731 return _gdi_
.Locale_GetSystemEncoding(*args
)
2733 def Locale_GetSystemEncodingName(*args
):
2734 """Locale_GetSystemEncodingName() -> String"""
2735 return _gdi_
.Locale_GetSystemEncodingName(*args
)
2737 def Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
):
2738 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2739 return _gdi_
.Locale_AddCatalogLookupPathPrefix(*args
, **kwargs
)
2741 def Locale_IsAvailable(*args
, **kwargs
):
2742 """Locale_IsAvailable(int lang) -> bool"""
2743 return _gdi_
.Locale_IsAvailable(*args
, **kwargs
)
2745 def Locale_GetLanguageInfo(*args
, **kwargs
):
2746 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2747 return _gdi_
.Locale_GetLanguageInfo(*args
, **kwargs
)
2749 def Locale_GetLanguageName(*args
, **kwargs
):
2750 """Locale_GetLanguageName(int lang) -> String"""
2751 return _gdi_
.Locale_GetLanguageName(*args
, **kwargs
)
2753 def Locale_FindLanguageInfo(*args
, **kwargs
):
2754 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2755 return _gdi_
.Locale_FindLanguageInfo(*args
, **kwargs
)
2757 def Locale_AddLanguage(*args
, **kwargs
):
2758 """Locale_AddLanguage(LanguageInfo info)"""
2759 return _gdi_
.Locale_AddLanguage(*args
, **kwargs
)
2761 class PyLocale(Locale
):
2762 """Proxy of C++ PyLocale class"""
2763 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2764 __repr__
= _swig_repr
2765 def __init__(self
, *args
, **kwargs
):
2766 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale"""
2767 _gdi_
.PyLocale_swiginit(self
,_gdi_
.new_PyLocale(*args
, **kwargs
))
2768 self
._setCallbackInfo
(self
, PyLocale
)
2770 __swig_destroy__
= _gdi_
.delete_PyLocale
2771 __del__
= lambda self
: None;
2772 def _setCallbackInfo(*args
, **kwargs
):
2773 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2774 return _gdi_
.PyLocale__setCallbackInfo(*args
, **kwargs
)
2776 def GetSingularString(*args
, **kwargs
):
2777 """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar"""
2778 return _gdi_
.PyLocale_GetSingularString(*args
, **kwargs
)
2780 def GetPluralString(*args
, **kwargs
):
2782 GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n,
2783 wxChar szDomain=None) -> wxChar
2785 return _gdi_
.PyLocale_GetPluralString(*args
, **kwargs
)
2787 _gdi_
.PyLocale_swigregister(PyLocale
)
2790 def GetLocale(*args
):
2791 """GetLocale() -> Locale"""
2792 return _gdi_
.GetLocale(*args
)
2793 #---------------------------------------------------------------------------
2795 CONVERT_STRICT
= _gdi_
.CONVERT_STRICT
2796 CONVERT_SUBSTITUTE
= _gdi_
.CONVERT_SUBSTITUTE
2797 PLATFORM_CURRENT
= _gdi_
.PLATFORM_CURRENT
2798 PLATFORM_UNIX
= _gdi_
.PLATFORM_UNIX
2799 PLATFORM_WINDOWS
= _gdi_
.PLATFORM_WINDOWS
2800 PLATFORM_OS2
= _gdi_
.PLATFORM_OS2
2801 PLATFORM_MAC
= _gdi_
.PLATFORM_MAC
2802 class EncodingConverter(_core
.Object
):
2803 """Proxy of C++ EncodingConverter class"""
2804 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2805 __repr__
= _swig_repr
2806 def __init__(self
, *args
, **kwargs
):
2807 """__init__(self) -> EncodingConverter"""
2808 _gdi_
.EncodingConverter_swiginit(self
,_gdi_
.new_EncodingConverter(*args
, **kwargs
))
2809 __swig_destroy__
= _gdi_
.delete_EncodingConverter
2810 __del__
= lambda self
: None;
2811 def Init(*args
, **kwargs
):
2812 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2813 return _gdi_
.EncodingConverter_Init(*args
, **kwargs
)
2815 def Convert(*args
, **kwargs
):
2816 """Convert(self, String input) -> String"""
2817 return _gdi_
.EncodingConverter_Convert(*args
, **kwargs
)
2819 def GetPlatformEquivalents(*args
, **kwargs
):
2820 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2821 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2823 GetPlatformEquivalents
= staticmethod(GetPlatformEquivalents
)
2824 def GetAllEquivalents(*args
, **kwargs
):
2825 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2826 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2828 GetAllEquivalents
= staticmethod(GetAllEquivalents
)
2829 def CanConvert(*args
, **kwargs
):
2830 """CanConvert(int encIn, int encOut) -> bool"""
2831 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2833 CanConvert
= staticmethod(CanConvert
)
2834 def __nonzero__(self
): return self
.IsOk()
2835 _gdi_
.EncodingConverter_swigregister(EncodingConverter
)
2837 def GetTranslation(*args
):
2839 GetTranslation(String str) -> String
2840 GetTranslation(String str, String domain) -> String
2841 GetTranslation(String str, String strPlural, size_t n) -> String
2842 GetTranslation(String str, String strPlural, size_t n, String domain) -> String
2844 return _gdi_
.GetTranslation(*args
)
2846 def EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
):
2847 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2848 return _gdi_
.EncodingConverter_GetPlatformEquivalents(*args
, **kwargs
)
2850 def EncodingConverter_GetAllEquivalents(*args
, **kwargs
):
2851 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2852 return _gdi_
.EncodingConverter_GetAllEquivalents(*args
, **kwargs
)
2854 def EncodingConverter_CanConvert(*args
, **kwargs
):
2855 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2856 return _gdi_
.EncodingConverter_CanConvert(*args
, **kwargs
)
2858 #----------------------------------------------------------------------------
2859 # On MSW add the directory where the wxWidgets catalogs were installed
2860 # to the default catalog path.
2861 if wx
.Platform
== "__WXMSW__":
2863 _localedir
= os
.path
.join(os
.path
.split(__file__
)[0], "locale")
2864 Locale
.AddCatalogLookupPathPrefix(_localedir
)
2867 #----------------------------------------------------------------------------
2869 #---------------------------------------------------------------------------
2871 class DC(_core
.Object
):
2873 A wx.DC is a device context onto which graphics and text can be
2874 drawn. It is intended to represent a number of output devices in a
2875 generic way, so a window can have a device context associated with it,
2876 and a printer also has a device context. In this way, the same piece
2877 of code may write to a number of different devices, if the device
2878 context is used as a parameter.
2880 Derived types of wxDC have documentation for specific features only,
2881 so refer to this section for most device context information.
2883 The wx.DC class is abstract and can not be instantiated, you must use
2884 one of the derived classes instead. Which one will depend on the
2885 situation in which it is used.
2887 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
2888 def __init__(self
): raise AttributeError, "No constructor defined"
2889 __repr__
= _swig_repr
2890 __swig_destroy__
= _gdi_
.delete_DC
2891 __del__
= lambda self
: None;
2892 # These have been deprecated in wxWidgets. Since they never
2893 # really did anything to begin with, just make them be NOPs.
2894 def BeginDrawing(self
): pass
2895 def EndDrawing(self
): pass
2897 def FloodFill(*args
, **kwargs
):
2899 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2901 Flood fills the device context starting from the given point, using
2902 the current brush colour, and using a style:
2904 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2905 the given colour is encountered.
2907 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2910 Returns False if the operation failed.
2912 Note: The present implementation for non-Windows platforms may fail to
2913 find colour borders if the pixels do not match the colour
2914 exactly. However the function will still return true.
2916 return _gdi_
.DC_FloodFill(*args
, **kwargs
)
2918 def FloodFillPoint(*args
, **kwargs
):
2920 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2922 Flood fills the device context starting from the given point, using
2923 the current brush colour, and using a style:
2925 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2926 the given colour is encountered.
2928 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2931 Returns False if the operation failed.
2933 Note: The present implementation for non-Windows platforms may fail to
2934 find colour borders if the pixels do not match the colour
2935 exactly. However the function will still return true.
2937 return _gdi_
.DC_FloodFillPoint(*args
, **kwargs
)
2939 def GradientFillConcentric(*args
, **kwargs
):
2941 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2944 Fill the area specified by rect with a radial gradient, starting from
2945 initialColour in the center of the circle and fading to destColour on
2946 the outside of the circle. The circleCenter argument is the relative
2947 coordinants of the center of the circle in the specified rect.
2949 Note: Currently this function is very slow, don't use it for real-time
2952 return _gdi_
.DC_GradientFillConcentric(*args
, **kwargs
)
2954 def GradientFillLinear(*args
, **kwargs
):
2956 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2957 int nDirection=EAST)
2959 Fill the area specified by rect with a linear gradient, starting from
2960 initialColour and eventually fading to destColour. The nDirection
2961 parameter specifies the direction of the colour change, default is to
2962 use initialColour on the left part of the rectangle and destColour on
2965 return _gdi_
.DC_GradientFillLinear(*args
, **kwargs
)
2967 def GetPixel(*args
, **kwargs
):
2969 GetPixel(self, int x, int y) -> Colour
2971 Gets the colour at the specified location on the DC.
2973 return _gdi_
.DC_GetPixel(*args
, **kwargs
)
2975 def GetPixelPoint(*args
, **kwargs
):
2976 """GetPixelPoint(self, Point pt) -> Colour"""
2977 return _gdi_
.DC_GetPixelPoint(*args
, **kwargs
)
2979 def DrawLine(*args
, **kwargs
):
2981 DrawLine(self, int x1, int y1, int x2, int y2)
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_DrawLine(*args
, **kwargs
)
2990 def DrawLinePoint(*args
, **kwargs
):
2992 DrawLinePoint(self, Point pt1, Point pt2)
2994 Draws a line from the first point to the second. The current pen is
2995 used for drawing the line. Note that the second point is *not* part of
2996 the line and is not drawn by this function (this is consistent with
2997 the behaviour of many other toolkits).
2999 return _gdi_
.DC_DrawLinePoint(*args
, **kwargs
)
3001 def CrossHair(*args
, **kwargs
):
3003 CrossHair(self, int x, int y)
3005 Displays a cross hair using the current pen. This is a vertical and
3006 horizontal line the height and width of the window, centred on the
3009 return _gdi_
.DC_CrossHair(*args
, **kwargs
)
3011 def CrossHairPoint(*args
, **kwargs
):
3013 CrossHairPoint(self, Point pt)
3015 Displays a cross hair using the current pen. This is a vertical and
3016 horizontal line the height and width of the window, centred on the
3019 return _gdi_
.DC_CrossHairPoint(*args
, **kwargs
)
3021 def DrawArc(*args
, **kwargs
):
3023 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
3025 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3026 the first point to the second. The current pen is used for the outline
3027 and the current brush for filling the shape.
3029 The arc is drawn in an anticlockwise direction from the start point to
3032 return _gdi_
.DC_DrawArc(*args
, **kwargs
)
3034 def DrawArcPoint(*args
, **kwargs
):
3036 DrawArcPoint(self, Point pt1, Point pt2, Point center)
3038 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3039 the first point to the second. The current pen is used for the outline
3040 and the current brush for filling the shape.
3042 The arc is drawn in an anticlockwise direction from the start point to
3045 return _gdi_
.DC_DrawArcPoint(*args
, **kwargs
)
3047 def DrawCheckMark(*args
, **kwargs
):
3049 DrawCheckMark(self, int x, int y, int width, int height)
3051 Draws a check mark inside the given rectangle.
3053 return _gdi_
.DC_DrawCheckMark(*args
, **kwargs
)
3055 def DrawCheckMarkRect(*args
, **kwargs
):
3057 DrawCheckMarkRect(self, Rect rect)
3059 Draws a check mark inside the given rectangle.
3061 return _gdi_
.DC_DrawCheckMarkRect(*args
, **kwargs
)
3063 def DrawEllipticArc(*args
, **kwargs
):
3065 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
3067 Draws an arc of an ellipse, with the given rectangle defining the
3068 bounds of the ellipse. The current pen is used for drawing the arc and
3069 the current brush is used for drawing the pie.
3071 The *start* and *end* parameters specify the start and end of the arc
3072 relative to the three-o'clock position from the center of the
3073 rectangle. Angles are specified in degrees (360 is a complete
3074 circle). Positive values mean counter-clockwise motion. If start is
3075 equal to end, a complete ellipse will be drawn.
3077 return _gdi_
.DC_DrawEllipticArc(*args
, **kwargs
)
3079 def DrawEllipticArcPointSize(*args
, **kwargs
):
3081 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
3083 Draws an arc of an ellipse, with the given rectangle defining the
3084 bounds of the ellipse. The current pen is used for drawing the arc and
3085 the current brush is used for drawing the pie.
3087 The *start* and *end* parameters specify the start and end of the arc
3088 relative to the three-o'clock position from the center of the
3089 rectangle. Angles are specified in degrees (360 is a complete
3090 circle). Positive values mean counter-clockwise motion. If start is
3091 equal to end, a complete ellipse will be drawn.
3093 return _gdi_
.DC_DrawEllipticArcPointSize(*args
, **kwargs
)
3095 def DrawPoint(*args
, **kwargs
):
3097 DrawPoint(self, int x, int y)
3099 Draws a point using the current pen.
3101 return _gdi_
.DC_DrawPoint(*args
, **kwargs
)
3103 def DrawPointPoint(*args
, **kwargs
):
3105 DrawPointPoint(self, Point pt)
3107 Draws a point using the current pen.
3109 return _gdi_
.DC_DrawPointPoint(*args
, **kwargs
)
3111 def DrawRectangle(*args
, **kwargs
):
3113 DrawRectangle(self, int x, int y, int width, int height)
3115 Draws a rectangle with the given top left corner, and with the given
3116 size. The current pen is used for the outline and the current brush
3117 for filling the shape.
3119 return _gdi_
.DC_DrawRectangle(*args
, **kwargs
)
3121 def DrawRectangleRect(*args
, **kwargs
):
3123 DrawRectangleRect(self, Rect rect)
3125 Draws a rectangle with the given top left corner, and with the given
3126 size. The current pen is used for the outline and the current brush
3127 for filling the shape.
3129 return _gdi_
.DC_DrawRectangleRect(*args
, **kwargs
)
3131 def DrawRectanglePointSize(*args
, **kwargs
):
3133 DrawRectanglePointSize(self, Point pt, Size sz)
3135 Draws a rectangle with the given top left corner, and with the given
3136 size. The current pen is used for the outline and the current brush
3137 for filling the shape.
3139 return _gdi_
.DC_DrawRectanglePointSize(*args
, **kwargs
)
3141 def DrawRoundedRectangle(*args
, **kwargs
):
3143 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
3145 Draws a rectangle with the given top left corner, and with the given
3146 size. The corners are quarter-circles using the given radius. The
3147 current pen is used for the outline and the current brush for filling
3150 If radius is positive, the value is assumed to be the radius of the
3151 rounded corner. If radius is negative, the absolute value is assumed
3152 to be the proportion of the smallest dimension of the rectangle. This
3153 means that the corner can be a sensible size relative to the size of
3154 the rectangle, and also avoids the strange effects X produces when the
3155 corners are too big for the rectangle.
3157 return _gdi_
.DC_DrawRoundedRectangle(*args
, **kwargs
)
3159 def DrawRoundedRectangleRect(*args
, **kwargs
):
3161 DrawRoundedRectangleRect(self, Rect r, double radius)
3163 Draws a rectangle with the given top left corner, and with the given
3164 size. The corners are quarter-circles using the given radius. The
3165 current pen is used for the outline and the current brush for filling
3168 If radius is positive, the value is assumed to be the radius of the
3169 rounded corner. If radius is negative, the absolute value is assumed
3170 to be the proportion of the smallest dimension of the rectangle. This
3171 means that the corner can be a sensible size relative to the size of
3172 the rectangle, and also avoids the strange effects X produces when the
3173 corners are too big for the rectangle.
3175 return _gdi_
.DC_DrawRoundedRectangleRect(*args
, **kwargs
)
3177 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
3179 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
3181 Draws a rectangle with the given top left corner, and with the given
3182 size. The corners are quarter-circles using the given radius. The
3183 current pen is used for the outline and the current brush for filling
3186 If radius is positive, the value is assumed to be the radius of the
3187 rounded corner. If radius is negative, the absolute value is assumed
3188 to be the proportion of the smallest dimension of the rectangle. This
3189 means that the corner can be a sensible size relative to the size of
3190 the rectangle, and also avoids the strange effects X produces when the
3191 corners are too big for the rectangle.
3193 return _gdi_
.DC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
3195 def DrawCircle(*args
, **kwargs
):
3197 DrawCircle(self, int x, int y, int radius)
3199 Draws a circle with the given center point and radius. The current
3200 pen is used for the outline and the current brush for filling the
3203 return _gdi_
.DC_DrawCircle(*args
, **kwargs
)
3205 def DrawCirclePoint(*args
, **kwargs
):
3207 DrawCirclePoint(self, Point pt, int radius)
3209 Draws a circle with the given center point and radius. The current
3210 pen is used for the outline and the current brush for filling the
3213 return _gdi_
.DC_DrawCirclePoint(*args
, **kwargs
)
3215 def DrawEllipse(*args
, **kwargs
):
3217 DrawEllipse(self, int x, int y, int width, int height)
3219 Draws an ellipse contained in the specified rectangle. The current pen
3220 is used for the outline and the current brush for filling the shape.
3222 return _gdi_
.DC_DrawEllipse(*args
, **kwargs
)
3224 def DrawEllipseRect(*args
, **kwargs
):
3226 DrawEllipseRect(self, Rect rect)
3228 Draws an ellipse contained in the specified rectangle. The current pen
3229 is used for the outline and the current brush for filling the shape.
3231 return _gdi_
.DC_DrawEllipseRect(*args
, **kwargs
)
3233 def DrawEllipsePointSize(*args
, **kwargs
):
3235 DrawEllipsePointSize(self, Point pt, Size sz)
3237 Draws an ellipse contained in the specified rectangle. The current pen
3238 is used for the outline and the current brush for filling the shape.
3240 return _gdi_
.DC_DrawEllipsePointSize(*args
, **kwargs
)
3242 def DrawIcon(*args
, **kwargs
):
3244 DrawIcon(self, Icon icon, int x, int y)
3246 Draw an icon on the display (does nothing if the device context is
3247 PostScript). This can be the simplest way of drawing bitmaps on a
3250 return _gdi_
.DC_DrawIcon(*args
, **kwargs
)
3252 def DrawIconPoint(*args
, **kwargs
):
3254 DrawIconPoint(self, Icon icon, Point pt)
3256 Draw an icon on the display (does nothing if the device context is
3257 PostScript). This can be the simplest way of drawing bitmaps on a
3260 return _gdi_
.DC_DrawIconPoint(*args
, **kwargs
)
3262 def DrawBitmap(*args
, **kwargs
):
3264 DrawBitmap(self, Bitmap bmp, int x, int y, 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_DrawBitmap(*args
, **kwargs
)
3273 def DrawBitmapPoint(*args
, **kwargs
):
3275 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3277 Draw a bitmap on the device context at the specified point. If
3278 *transparent* is true and the bitmap has a transparency mask, (or
3279 alpha channel on the platforms that support it) then the bitmap will
3280 be drawn transparently.
3282 return _gdi_
.DC_DrawBitmapPoint(*args
, **kwargs
)
3284 def DrawText(*args
, **kwargs
):
3286 DrawText(self, String text, int x, int y)
3288 Draws a text string at the specified point, using the current text
3289 font, and the current text foreground and background colours.
3291 The coordinates refer to the top-left corner of the rectangle bounding
3292 the string. See `GetTextExtent` for how to get the dimensions of a
3293 text string, which can be used to position the text more precisely.
3295 **NOTE**: under wxGTK the current logical function is used by this
3296 function but it is ignored by wxMSW. Thus, you should avoid using
3297 logical functions with this function in portable programs.
3299 return _gdi_
.DC_DrawText(*args
, **kwargs
)
3301 def DrawTextPoint(*args
, **kwargs
):
3303 DrawTextPoint(self, String text, Point pt)
3305 Draws a text string at the specified point, using the current text
3306 font, and the current text foreground and background colours.
3308 The coordinates refer to the top-left corner of the rectangle bounding
3309 the string. See `GetTextExtent` for how to get the dimensions of a
3310 text string, which can be used to position the text more precisely.
3312 **NOTE**: under wxGTK the current logical function is used by this
3313 function but it is ignored by wxMSW. Thus, you should avoid using
3314 logical functions with this function in portable programs.
3316 return _gdi_
.DC_DrawTextPoint(*args
, **kwargs
)
3318 def DrawRotatedText(*args
, **kwargs
):
3320 DrawRotatedText(self, String text, int x, int y, double angle)
3322 Draws the text rotated by *angle* degrees, if supported by the platform.
3324 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3325 function. In particular, a font different from ``wx.NORMAL_FONT``
3326 should be used as the it is not normally a TrueType
3327 font. ``wx.SWISS_FONT`` is an example of a font which is.
3329 return _gdi_
.DC_DrawRotatedText(*args
, **kwargs
)
3331 def DrawRotatedTextPoint(*args
, **kwargs
):
3333 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3335 Draws the text rotated by *angle* degrees, if supported by the platform.
3337 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3338 function. In particular, a font different from ``wx.NORMAL_FONT``
3339 should be used as the it is not normally a TrueType
3340 font. ``wx.SWISS_FONT`` is an example of a font which is.
3342 return _gdi_
.DC_DrawRotatedTextPoint(*args
, **kwargs
)
3344 def Blit(*args
, **kwargs
):
3346 Blit(self, int xdest, int ydest, int width, int height, DC source,
3347 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3348 int xsrcMask=-1, int ysrcMask=-1) -> bool
3350 Copy from a source DC to this DC. Parameters specify the destination
3351 coordinates, size of area to copy, source DC, source coordinates,
3352 logical function, whether to use a bitmap mask, and mask source
3355 return _gdi_
.DC_Blit(*args
, **kwargs
)
3357 def BlitPointSize(*args
, **kwargs
):
3359 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
3360 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
3362 Copy from a source DC to this DC. Parameters specify the destination
3363 coordinates, size of area to copy, source DC, source coordinates,
3364 logical function, whether to use a bitmap mask, and mask source
3367 return _gdi_
.DC_BlitPointSize(*args
, **kwargs
)
3369 def SetClippingRegion(*args
, **kwargs
):
3371 SetClippingRegion(self, int x, int y, int width, int height)
3373 Sets the clipping region for this device context to the intersection
3374 of the given region described by the parameters of this method and the
3375 previously set clipping region. You should call `DestroyClippingRegion`
3376 if you want to set the clipping region exactly to the region
3379 The clipping region is an area to which drawing is
3380 restricted. Possible uses for the clipping region are for clipping
3381 text or for speeding up window redraws when only a known area of the
3384 return _gdi_
.DC_SetClippingRegion(*args
, **kwargs
)
3386 def SetClippingRegionPointSize(*args
, **kwargs
):
3388 SetClippingRegionPointSize(self, Point pt, Size sz)
3390 Sets the clipping region for this device context to the intersection
3391 of the given region described by the parameters of this method and the
3392 previously set clipping region. You should call `DestroyClippingRegion`
3393 if you want to set the clipping region exactly to the region
3396 The clipping region is an area to which drawing is
3397 restricted. Possible uses for the clipping region are for clipping
3398 text or for speeding up window redraws when only a known area of the
3401 return _gdi_
.DC_SetClippingRegionPointSize(*args
, **kwargs
)
3403 def SetClippingRegionAsRegion(*args
, **kwargs
):
3405 SetClippingRegionAsRegion(self, Region region)
3407 Sets the clipping region for this device context to the intersection
3408 of the given region described by the parameters of this method and the
3409 previously set clipping region. You should call `DestroyClippingRegion`
3410 if you want to set the clipping region exactly to the region
3413 The clipping region is an area to which drawing is
3414 restricted. Possible uses for the clipping region are for clipping
3415 text or for speeding up window redraws when only a known area of the
3418 return _gdi_
.DC_SetClippingRegionAsRegion(*args
, **kwargs
)
3420 def SetClippingRect(*args
, **kwargs
):
3422 SetClippingRect(self, Rect rect)
3424 Sets the clipping region for this device context to the intersection
3425 of the given region described by the parameters of this method and the
3426 previously set clipping region. You should call `DestroyClippingRegion`
3427 if you want to set the clipping region exactly to the region
3430 The clipping region is an area to which drawing is
3431 restricted. Possible uses for the clipping region are for clipping
3432 text or for speeding up window redraws when only a known area of the
3435 return _gdi_
.DC_SetClippingRect(*args
, **kwargs
)
3437 def DrawLines(*args
, **kwargs
):
3439 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3441 Draws lines using a sequence of `wx.Point` objects, adding the
3442 optional offset coordinate. The current pen is used for drawing the
3445 return _gdi_
.DC_DrawLines(*args
, **kwargs
)
3447 def DrawPolygon(*args
, **kwargs
):
3449 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
3450 int fillStyle=ODDEVEN_RULE)
3452 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3453 the optional offset coordinate. The last argument specifies the fill
3454 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3456 The current pen is used for drawing the outline, and the current brush
3457 for filling the shape. Using a transparent brush suppresses
3458 filling. Note that wxWidgets automatically closes the first and last
3461 return _gdi_
.DC_DrawPolygon(*args
, **kwargs
)
3463 def DrawLabel(*args
, **kwargs
):
3465 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3468 Draw *text* within the specified rectangle, abiding by the alignment
3469 flags. Will additionally emphasize the character at *indexAccel* if
3472 return _gdi_
.DC_DrawLabel(*args
, **kwargs
)
3474 def DrawImageLabel(*args
, **kwargs
):
3476 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3477 int indexAccel=-1) -> Rect
3479 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3480 drawing it) within the specified rectangle, abiding by the alignment
3481 flags. Will additionally emphasize the character at *indexAccel* if
3482 it is not -1. Returns the bounding rectangle.
3484 return _gdi_
.DC_DrawImageLabel(*args
, **kwargs
)
3486 def DrawSpline(*args
, **kwargs
):
3488 DrawSpline(self, List points)
3490 Draws a spline between all given control points, (a list of `wx.Point`
3491 objects) using the current pen. The spline is drawn using a series of
3492 lines, using an algorithm taken from the X drawing program 'XFIG'.
3494 return _gdi_
.DC_DrawSpline(*args
, **kwargs
)
3496 def Clear(*args
, **kwargs
):
3500 Clears the device context using the current background brush.
3502 return _gdi_
.DC_Clear(*args
, **kwargs
)
3504 def StartDoc(*args
, **kwargs
):
3506 StartDoc(self, String message) -> bool
3508 Starts a document (only relevant when outputting to a
3509 printer). *Message* is a message to show whilst printing.
3511 return _gdi_
.DC_StartDoc(*args
, **kwargs
)
3513 def EndDoc(*args
, **kwargs
):
3517 Ends a document (only relevant when outputting to a printer).
3519 return _gdi_
.DC_EndDoc(*args
, **kwargs
)
3521 def StartPage(*args
, **kwargs
):
3525 Starts a document page (only relevant when outputting to a printer).
3527 return _gdi_
.DC_StartPage(*args
, **kwargs
)
3529 def EndPage(*args
, **kwargs
):
3533 Ends a document page (only relevant when outputting to a printer).
3535 return _gdi_
.DC_EndPage(*args
, **kwargs
)
3537 def SetFont(*args
, **kwargs
):
3539 SetFont(self, Font font)
3541 Sets the current font for the DC. It must be a valid font, in
3542 particular you should not pass ``wx.NullFont`` to this method.
3544 return _gdi_
.DC_SetFont(*args
, **kwargs
)
3546 def SetPen(*args
, **kwargs
):
3548 SetPen(self, Pen pen)
3550 Sets the current pen for the DC.
3552 If the argument is ``wx.NullPen``, the current pen is selected out of the
3553 device context, and the original pen restored.
3555 return _gdi_
.DC_SetPen(*args
, **kwargs
)
3557 def SetBrush(*args
, **kwargs
):
3559 SetBrush(self, Brush brush)
3561 Sets the current brush for the DC.
3563 If the argument is ``wx.NullBrush``, the current brush is selected out
3564 of the device context, and the original brush restored, allowing the
3565 current brush to be destroyed safely.
3567 return _gdi_
.DC_SetBrush(*args
, **kwargs
)
3569 def SetBackground(*args
, **kwargs
):
3571 SetBackground(self, Brush brush)
3573 Sets the current background brush for the DC.
3575 return _gdi_
.DC_SetBackground(*args
, **kwargs
)
3577 def SetBackgroundMode(*args
, **kwargs
):
3579 SetBackgroundMode(self, int mode)
3581 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3582 determines whether text will be drawn with a background colour or
3585 return _gdi_
.DC_SetBackgroundMode(*args
, **kwargs
)
3587 def SetPalette(*args
, **kwargs
):
3589 SetPalette(self, Palette palette)
3591 If this is a window DC or memory DC, assigns the given palette to the
3592 window or bitmap associated with the DC. If the argument is
3593 ``wx.NullPalette``, the current palette is selected out of the device
3594 context, and the original palette restored.
3596 return _gdi_
.DC_SetPalette(*args
, **kwargs
)
3598 def DestroyClippingRegion(*args
, **kwargs
):
3600 DestroyClippingRegion(self)
3602 Destroys the current clipping region so that none of the DC is
3605 return _gdi_
.DC_DestroyClippingRegion(*args
, **kwargs
)
3607 def GetClippingBox(*args
, **kwargs
):
3609 GetClippingBox() -> (x, y, width, height)
3611 Gets the rectangle surrounding the current clipping region.
3613 return _gdi_
.DC_GetClippingBox(*args
, **kwargs
)
3615 def GetClippingRect(*args
, **kwargs
):
3617 GetClippingRect(self) -> Rect
3619 Gets the rectangle surrounding the current clipping region.
3621 return _gdi_
.DC_GetClippingRect(*args
, **kwargs
)
3623 def GetCharHeight(*args
, **kwargs
):
3625 GetCharHeight(self) -> int
3627 Gets the character height of the currently set font.
3629 return _gdi_
.DC_GetCharHeight(*args
, **kwargs
)
3631 def GetCharWidth(*args
, **kwargs
):
3633 GetCharWidth(self) -> int
3635 Gets the average character width of the currently set font.
3637 return _gdi_
.DC_GetCharWidth(*args
, **kwargs
)
3639 def GetTextExtent(*args
, **kwargs
):
3641 GetTextExtent(wxString string) -> (width, height)
3643 Get the width and height of the text using the current font. Only
3644 works for single line strings.
3646 return _gdi_
.DC_GetTextExtent(*args
, **kwargs
)
3648 def GetFullTextExtent(*args
, **kwargs
):
3650 GetFullTextExtent(wxString string, Font font=None) ->
3651 (width, height, descent, externalLeading)
3653 Get the width, height, decent and leading of the text using the
3654 current or specified font. Only works for single line strings.
3656 return _gdi_
.DC_GetFullTextExtent(*args
, **kwargs
)
3658 def GetMultiLineTextExtent(*args
, **kwargs
):
3660 GetMultiLineTextExtent(wxString string, Font font=None) ->
3661 (width, height, lineHeight)
3663 Get the width, height, and line height of the text using the
3664 current or specified font. Works for single as well as multi-line
3667 return _gdi_
.DC_GetMultiLineTextExtent(*args
, **kwargs
)
3669 def GetPartialTextExtents(*args
, **kwargs
):
3671 GetPartialTextExtents(self, text) -> [widths]
3673 Returns a list of integers such that each value is the distance in
3674 pixels from the begining of text to the coresponding character of
3675 *text*. The generic version simply builds a running total of the widths
3676 of each character using GetTextExtent, however if the various
3677 platforms have a native API function that is faster or more accurate
3678 than the generic implementation then it will be used instead.
3680 return _gdi_
.DC_GetPartialTextExtents(*args
, **kwargs
)
3682 def GetSize(*args
, **kwargs
):
3684 GetSize(self) -> Size
3686 This gets the horizontal and vertical resolution in device units. It
3687 can be used to scale graphics to fit the page. For example, if *maxX*
3688 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3689 used in your application, the following code will scale the graphic to
3690 fit on the printer page::
3693 scaleX = maxX*1.0 / w
3694 scaleY = maxY*1.0 / h
3695 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3698 return _gdi_
.DC_GetSize(*args
, **kwargs
)
3700 def GetSizeTuple(*args
, **kwargs
):
3702 GetSizeTuple() -> (width, height)
3704 This gets the horizontal and vertical resolution in device units. It
3705 can be used to scale graphics to fit the page. For example, if *maxX*
3706 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3707 used in your application, the following code will scale the graphic to
3708 fit on the printer page::
3711 scaleX = maxX*1.0 / w
3712 scaleY = maxY*1.0 / h
3713 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3716 return _gdi_
.DC_GetSizeTuple(*args
, **kwargs
)
3718 def GetSizeMM(*args
, **kwargs
):
3720 GetSizeMM(self) -> Size
3722 Get the DC size in milimeters.
3724 return _gdi_
.DC_GetSizeMM(*args
, **kwargs
)
3726 def GetSizeMMTuple(*args
, **kwargs
):
3728 GetSizeMMTuple() -> (width, height)
3730 Get the DC size in milimeters.
3732 return _gdi_
.DC_GetSizeMMTuple(*args
, **kwargs
)
3734 def DeviceToLogicalX(*args
, **kwargs
):
3736 DeviceToLogicalX(self, int x) -> int
3738 Convert device X coordinate to logical coordinate, using the current
3741 return _gdi_
.DC_DeviceToLogicalX(*args
, **kwargs
)
3743 def DeviceToLogicalY(*args
, **kwargs
):
3745 DeviceToLogicalY(self, int y) -> int
3747 Converts device Y coordinate to logical coordinate, using the current
3750 return _gdi_
.DC_DeviceToLogicalY(*args
, **kwargs
)
3752 def DeviceToLogicalXRel(*args
, **kwargs
):
3754 DeviceToLogicalXRel(self, int x) -> int
3756 Convert device X coordinate to relative logical coordinate, using the
3757 current mapping mode but ignoring the x axis orientation. Use this
3758 function for converting a width, for example.
3760 return _gdi_
.DC_DeviceToLogicalXRel(*args
, **kwargs
)
3762 def DeviceToLogicalYRel(*args
, **kwargs
):
3764 DeviceToLogicalYRel(self, int y) -> int
3766 Convert device Y coordinate to relative logical coordinate, using the
3767 current mapping mode but ignoring the y axis orientation. Use this
3768 function for converting a height, for example.
3770 return _gdi_
.DC_DeviceToLogicalYRel(*args
, **kwargs
)
3772 def LogicalToDeviceX(*args
, **kwargs
):
3774 LogicalToDeviceX(self, int x) -> int
3776 Converts logical X coordinate to device coordinate, using the current
3779 return _gdi_
.DC_LogicalToDeviceX(*args
, **kwargs
)
3781 def LogicalToDeviceY(*args
, **kwargs
):
3783 LogicalToDeviceY(self, int y) -> int
3785 Converts logical Y coordinate to device coordinate, using the current
3788 return _gdi_
.DC_LogicalToDeviceY(*args
, **kwargs
)
3790 def LogicalToDeviceXRel(*args
, **kwargs
):
3792 LogicalToDeviceXRel(self, int x) -> int
3794 Converts logical X coordinate to relative device coordinate, using the
3795 current mapping mode but ignoring the x axis orientation. Use this for
3796 converting a width, for example.
3798 return _gdi_
.DC_LogicalToDeviceXRel(*args
, **kwargs
)
3800 def LogicalToDeviceYRel(*args
, **kwargs
):
3802 LogicalToDeviceYRel(self, int y) -> int
3804 Converts logical Y coordinate to relative device coordinate, using the
3805 current mapping mode but ignoring the y axis orientation. Use this for
3806 converting a height, for example.
3808 return _gdi_
.DC_LogicalToDeviceYRel(*args
, **kwargs
)
3810 def CanDrawBitmap(*args
, **kwargs
):
3811 """CanDrawBitmap(self) -> bool"""
3812 return _gdi_
.DC_CanDrawBitmap(*args
, **kwargs
)
3814 def CanGetTextExtent(*args
, **kwargs
):
3815 """CanGetTextExtent(self) -> bool"""
3816 return _gdi_
.DC_CanGetTextExtent(*args
, **kwargs
)
3818 def GetDepth(*args
, **kwargs
):
3820 GetDepth(self) -> int
3822 Returns the colour depth of the DC.
3824 return _gdi_
.DC_GetDepth(*args
, **kwargs
)
3826 def GetPPI(*args
, **kwargs
):
3828 GetPPI(self) -> Size
3830 Resolution in pixels per inch
3832 return _gdi_
.DC_GetPPI(*args
, **kwargs
)
3834 def IsOk(*args
, **kwargs
):
3838 Returns true if the DC is ok to use.
3840 return _gdi_
.DC_IsOk(*args
, **kwargs
)
3843 def GetBackgroundMode(*args
, **kwargs
):
3845 GetBackgroundMode(self) -> int
3847 Returns the current background mode, either ``wx.SOLID`` or
3850 return _gdi_
.DC_GetBackgroundMode(*args
, **kwargs
)
3852 def GetBackground(*args
, **kwargs
):
3854 GetBackground(self) -> Brush
3856 Gets the brush used for painting the background.
3858 return _gdi_
.DC_GetBackground(*args
, **kwargs
)
3860 def GetBrush(*args
, **kwargs
):
3862 GetBrush(self) -> Brush
3864 Gets the current brush
3866 return _gdi_
.DC_GetBrush(*args
, **kwargs
)
3868 def GetFont(*args
, **kwargs
):
3870 GetFont(self) -> Font
3872 Gets the current font
3874 return _gdi_
.DC_GetFont(*args
, **kwargs
)
3876 def GetPen(*args
, **kwargs
):
3880 Gets the current pen
3882 return _gdi_
.DC_GetPen(*args
, **kwargs
)
3884 def GetTextBackground(*args
, **kwargs
):
3886 GetTextBackground(self) -> Colour
3888 Gets the current text background colour
3890 return _gdi_
.DC_GetTextBackground(*args
, **kwargs
)
3892 def GetTextForeground(*args
, **kwargs
):
3894 GetTextForeground(self) -> Colour
3896 Gets the current text foreground colour
3898 return _gdi_
.DC_GetTextForeground(*args
, **kwargs
)
3900 def SetTextForeground(*args
, **kwargs
):
3902 SetTextForeground(self, Colour colour)
3904 Sets the current text foreground colour for the DC.
3906 return _gdi_
.DC_SetTextForeground(*args
, **kwargs
)
3908 def SetTextBackground(*args
, **kwargs
):
3910 SetTextBackground(self, Colour colour)
3912 Sets the current text background colour for the DC.
3914 return _gdi_
.DC_SetTextBackground(*args
, **kwargs
)
3916 def GetMapMode(*args
, **kwargs
):
3918 GetMapMode(self) -> int
3920 Gets the current *mapping mode* for the device context
3922 return _gdi_
.DC_GetMapMode(*args
, **kwargs
)
3924 def SetMapMode(*args
, **kwargs
):
3926 SetMapMode(self, int mode)
3928 The *mapping mode* of the device context defines the unit of
3929 measurement used to convert logical units to device units. The
3930 mapping mode can be one of the following:
3932 ================ =============================================
3933 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3935 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3936 wx.MM_METRIC Each logical unit is 1 mm.
3937 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3938 wx.MM_TEXT Each logical unit is 1 pixel.
3939 ================ =============================================
3942 return _gdi_
.DC_SetMapMode(*args
, **kwargs
)
3944 def GetUserScale(*args
, **kwargs
):
3946 GetUserScale(self) -> (xScale, yScale)
3948 Gets the current user scale factor (set by `SetUserScale`).
3950 return _gdi_
.DC_GetUserScale(*args
, **kwargs
)
3952 def SetUserScale(*args
, **kwargs
):
3954 SetUserScale(self, double x, double y)
3956 Sets the user scaling factor, useful for applications which require
3959 return _gdi_
.DC_SetUserScale(*args
, **kwargs
)
3961 def GetLogicalScale(*args
, **kwargs
):
3962 """GetLogicalScale() -> (xScale, yScale)"""
3963 return _gdi_
.DC_GetLogicalScale(*args
, **kwargs
)
3965 def SetLogicalScale(*args
, **kwargs
):
3966 """SetLogicalScale(self, double x, double y)"""
3967 return _gdi_
.DC_SetLogicalScale(*args
, **kwargs
)
3969 def GetLogicalOrigin(*args
, **kwargs
):
3970 """GetLogicalOrigin(self) -> Point"""
3971 return _gdi_
.DC_GetLogicalOrigin(*args
, **kwargs
)
3973 def GetLogicalOriginTuple(*args
, **kwargs
):
3974 """GetLogicalOriginTuple() -> (x,y)"""
3975 return _gdi_
.DC_GetLogicalOriginTuple(*args
, **kwargs
)
3977 def SetLogicalOrigin(*args
, **kwargs
):
3978 """SetLogicalOrigin(self, int x, int y)"""
3979 return _gdi_
.DC_SetLogicalOrigin(*args
, **kwargs
)
3981 def SetLogicalOriginPoint(*args
, **kwargs
):
3982 """SetLogicalOriginPoint(self, Point point)"""
3983 return _gdi_
.DC_SetLogicalOriginPoint(*args
, **kwargs
)
3985 def GetDeviceOrigin(*args
, **kwargs
):
3986 """GetDeviceOrigin(self) -> Point"""
3987 return _gdi_
.DC_GetDeviceOrigin(*args
, **kwargs
)
3989 def GetDeviceOriginTuple(*args
, **kwargs
):
3990 """GetDeviceOriginTuple() -> (x,y)"""
3991 return _gdi_
.DC_GetDeviceOriginTuple(*args
, **kwargs
)
3993 def SetDeviceOrigin(*args
, **kwargs
):
3994 """SetDeviceOrigin(self, int x, int y)"""
3995 return _gdi_
.DC_SetDeviceOrigin(*args
, **kwargs
)
3997 def SetDeviceOriginPoint(*args
, **kwargs
):
3998 """SetDeviceOriginPoint(self, Point point)"""
3999 return _gdi_
.DC_SetDeviceOriginPoint(*args
, **kwargs
)
4001 def SetAxisOrientation(*args
, **kwargs
):
4003 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
4005 Sets the x and y axis orientation (i.e., the direction from lowest to
4006 highest values on the axis). The default orientation is the natural
4007 orientation, e.g. x axis from left to right and y axis from bottom up.
4009 return _gdi_
.DC_SetAxisOrientation(*args
, **kwargs
)
4011 def GetLogicalFunction(*args
, **kwargs
):
4013 GetLogicalFunction(self) -> int
4015 Gets the current logical function (set by `SetLogicalFunction`).
4017 return _gdi_
.DC_GetLogicalFunction(*args
, **kwargs
)
4019 def SetLogicalFunction(*args
, **kwargs
):
4021 SetLogicalFunction(self, int function)
4023 Sets the current logical function for the device context. This
4024 determines how a source pixel (from a pen or brush colour, or source
4025 device context if using `Blit`) combines with a destination pixel in
4026 the current device context.
4028 The possible values and their meaning in terms of source and
4029 destination pixel values are as follows:
4031 ================ ==========================
4033 wx.AND_INVERT (NOT src) AND dst
4034 wx.AND_REVERSE src AND (NOT dst)
4037 wx.EQUIV (NOT src) XOR dst
4039 wx.NAND (NOT src) OR (NOT dst)
4040 wx.NOR (NOT src) AND (NOT dst)
4043 wx.OR_INVERT (NOT src) OR dst
4044 wx.OR_REVERSE src OR (NOT dst)
4046 wx.SRC_INVERT NOT src
4048 ================ ==========================
4050 The default is wx.COPY, which simply draws with the current
4051 colour. The others combine the current colour and the background using
4052 a logical operation. wx.INVERT is commonly used for drawing rubber
4053 bands or moving outlines, since drawing twice reverts to the original
4057 return _gdi_
.DC_SetLogicalFunction(*args
, **kwargs
)
4059 def ComputeScaleAndOrigin(*args
, **kwargs
):
4061 ComputeScaleAndOrigin(self)
4063 Performs all necessary computations for given platform and context
4064 type after each change of scale and origin parameters. Usually called
4065 automatically internally after such changes.
4068 return _gdi_
.DC_ComputeScaleAndOrigin(*args
, **kwargs
)
4070 def SetOptimization(self
, optimize
):
4072 def GetOptimization(self
):
4075 SetOptimization
= wx
._deprecated
(SetOptimization
)
4076 GetOptimization
= wx
._deprecated
(GetOptimization
)
4078 def CalcBoundingBox(*args
, **kwargs
):
4080 CalcBoundingBox(self, int x, int y)
4082 Adds the specified point to the bounding box which can be retrieved
4083 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4085 return _gdi_
.DC_CalcBoundingBox(*args
, **kwargs
)
4087 def CalcBoundingBoxPoint(*args
, **kwargs
):
4089 CalcBoundingBoxPoint(self, Point point)
4091 Adds the specified point to the bounding box which can be retrieved
4092 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4094 return _gdi_
.DC_CalcBoundingBoxPoint(*args
, **kwargs
)
4096 def ResetBoundingBox(*args
, **kwargs
):
4098 ResetBoundingBox(self)
4100 Resets the bounding box: after a call to this function, the bounding
4101 box doesn't contain anything.
4103 return _gdi_
.DC_ResetBoundingBox(*args
, **kwargs
)
4105 def MinX(*args
, **kwargs
):
4109 Gets the minimum horizontal extent used in drawing commands so far.
4111 return _gdi_
.DC_MinX(*args
, **kwargs
)
4113 def MaxX(*args
, **kwargs
):
4117 Gets the maximum horizontal extent used in drawing commands so far.
4119 return _gdi_
.DC_MaxX(*args
, **kwargs
)
4121 def MinY(*args
, **kwargs
):
4125 Gets the minimum vertical extent used in drawing commands so far.
4127 return _gdi_
.DC_MinY(*args
, **kwargs
)
4129 def MaxY(*args
, **kwargs
):
4133 Gets the maximum vertical extent used in drawing commands so far.
4135 return _gdi_
.DC_MaxY(*args
, **kwargs
)
4137 def GetBoundingBox(*args
, **kwargs
):
4139 GetBoundingBox() -> (x1,y1, x2,y2)
4141 Returns the min and max points used in drawing commands so far.
4143 return _gdi_
.DC_GetBoundingBox(*args
, **kwargs
)
4145 def __nonzero__(self
): return self
.IsOk()
4146 def GetLayoutDirection(*args
, **kwargs
):
4148 GetLayoutDirection(self) -> int
4150 Get the layout direction (LTR or RTL)_ for this dc. On platforms
4151 where RTL layout is supported, the return value will either be
4152 ``wx.Layout_LeftToRight`` or ``wx.Layout_RightToLeft``.
4153 ``wx.Layout_Default`` is returned if layout direction is not
4156 return _gdi_
.DC_GetLayoutDirection(*args
, **kwargs
)
4158 def SetLayoutDirection(*args
, **kwargs
):
4160 SetLayoutDirection(self, int dir)
4162 Change the layout direction for this dc.
4164 return _gdi_
.DC_SetLayoutDirection(*args
, **kwargs
)
4166 def _DrawPointList(*args
, **kwargs
):
4167 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4168 return _gdi_
.DC__DrawPointList(*args
, **kwargs
)
4170 def _DrawLineList(*args
, **kwargs
):
4171 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4172 return _gdi_
.DC__DrawLineList(*args
, **kwargs
)
4174 def _DrawRectangleList(*args
, **kwargs
):
4175 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4176 return _gdi_
.DC__DrawRectangleList(*args
, **kwargs
)
4178 def _DrawEllipseList(*args
, **kwargs
):
4179 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4180 return _gdi_
.DC__DrawEllipseList(*args
, **kwargs
)
4182 def _DrawPolygonList(*args
, **kwargs
):
4183 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4184 return _gdi_
.DC__DrawPolygonList(*args
, **kwargs
)
4186 def _DrawTextList(*args
, **kwargs
):
4188 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
4189 PyObject backgroundList) -> PyObject
4191 return _gdi_
.DC__DrawTextList(*args
, **kwargs
)
4193 def DrawPointList(self
, points
, pens
=None):
4195 Draw a list of points as quickly as possible.
4197 :param points: A sequence of 2-element sequences representing
4198 each point to draw, (x,y).
4199 :param pens: If None, then the current pen is used. If a
4200 single pen then it will be used for all points. If
4201 a list of pens then there should be one for each point
4206 elif isinstance(pens
, wx
.Pen
):
4208 elif len(pens
) != len(points
):
4209 raise ValueError('points and pens must have same length')
4210 return self
._DrawPointList
(points
, pens
, [])
4213 def DrawLineList(self
, lines
, pens
=None):
4215 Draw a list of lines as quickly as possible.
4217 :param lines: A sequence of 4-element sequences representing
4218 each line to draw, (x1,y1, x2,y2).
4219 :param pens: If None, then the current pen is used. If a
4220 single pen then it will be used for all lines. If
4221 a list of pens then there should be one for each line
4226 elif isinstance(pens
, wx
.Pen
):
4228 elif len(pens
) != len(lines
):
4229 raise ValueError('lines and pens must have same length')
4230 return self
._DrawLineList
(lines
, pens
, [])
4233 def DrawRectangleList(self
, rectangles
, pens
=None, brushes
=None):
4235 Draw a list of rectangles as quickly as possible.
4237 :param rectangles: A sequence of 4-element sequences representing
4238 each rectangle to draw, (x,y, w,h).
4239 :param pens: If None, then the current pen is used. If a
4240 single pen then it will be used for all rectangles.
4241 If a list of pens then there should be one for each
4242 rectangle in rectangles.
4243 :param brushes: A brush or brushes to be used to fill the rectagles,
4244 with similar semantics as the pens parameter.
4248 elif isinstance(pens
, wx
.Pen
):
4250 elif len(pens
) != len(rectangles
):
4251 raise ValueError('rectangles and pens must have same length')
4254 elif isinstance(brushes
, wx
.Brush
):
4256 elif len(brushes
) != len(rectangles
):
4257 raise ValueError('rectangles and brushes must have same length')
4258 return self
._DrawRectangleList
(rectangles
, pens
, brushes
)
4261 def DrawEllipseList(self
, ellipses
, pens
=None, brushes
=None):
4263 Draw a list of ellipses as quickly as possible.
4265 :param ellipses: A sequence of 4-element sequences representing
4266 each ellipse to draw, (x,y, w,h).
4267 :param pens: If None, then the current pen is used. If a
4268 single pen then it will be used for all ellipses.
4269 If a list of pens then there should be one for each
4270 ellipse in ellipses.
4271 :param brushes: A brush or brushes to be used to fill the ellipses,
4272 with similar semantics as the pens parameter.
4276 elif isinstance(pens
, wx
.Pen
):
4278 elif len(pens
) != len(ellipses
):
4279 raise ValueError('ellipses and pens must have same length')
4282 elif isinstance(brushes
, wx
.Brush
):
4284 elif len(brushes
) != len(ellipses
):
4285 raise ValueError('ellipses and brushes must have same length')
4286 return self
._DrawEllipseList
(ellipses
, pens
, brushes
)
4289 def DrawPolygonList(self
, polygons
, pens
=None, brushes
=None):
4291 Draw a list of polygons, each of which is a list of points.
4293 :param polygons: A sequence of sequences of sequences.
4294 [[(x1,y1),(x2,y2),(x3,y3)...],
4295 [(x1,y1),(x2,y2),(x3,y3)...]]
4297 :param pens: If None, then the current pen is used. If a
4298 single pen then it will be used for all polygons.
4299 If a list of pens then there should be one for each
4301 :param brushes: A brush or brushes to be used to fill the polygons,
4302 with similar semantics as the pens parameter.
4306 elif isinstance(pens
, wx
.Pen
):
4308 elif len(pens
) != len(polygons
):
4309 raise ValueError('polygons and pens must have same length')
4312 elif isinstance(brushes
, wx
.Brush
):
4314 elif len(brushes
) != len(polygons
):
4315 raise ValueError('polygons and brushes must have same length')
4316 return self
._DrawPolygonList
(polygons
, pens
, brushes
)
4319 def DrawTextList(self
, textList
, coords
, foregrounds
= None, backgrounds
= None):
4321 Draw a list of strings using a list of coordinants for positioning each string.
4323 :param textList: A list of strings
4324 :param coords: A list of (x,y) positions
4325 :param foregrounds: A list of `wx.Colour` objects to use for the
4326 foregrounds of the strings.
4327 :param backgrounds: A list of `wx.Colour` objects to use for the
4328 backgrounds of the strings.
4330 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4331 If you want backgrounds to do anything.
4333 if type(textList
) == type(''):
4334 textList
= [textList
]
4335 elif len(textList
) != len(coords
):
4336 raise ValueError('textlist and coords must have same length')
4337 if foregrounds
is None:
4339 elif isinstance(foregrounds
, wx
.Colour
):
4340 foregrounds
= [foregrounds
]
4341 elif len(foregrounds
) != len(coords
):
4342 raise ValueError('foregrounds and coords must have same length')
4343 if backgrounds
is None:
4345 elif isinstance(backgrounds
, wx
.Colour
):
4346 backgrounds
= [backgrounds
]
4347 elif len(backgrounds
) != len(coords
):
4348 raise ValueError('backgrounds and coords must have same length')
4349 return self
._DrawTextList
(textList
, coords
, foregrounds
, backgrounds
)
4351 Background
= property(GetBackground
,SetBackground
,doc
="See `GetBackground` and `SetBackground`")
4352 BackgroundMode
= property(GetBackgroundMode
,SetBackgroundMode
,doc
="See `GetBackgroundMode` and `SetBackgroundMode`")
4353 BoundingBox
= property(GetBoundingBox
,doc
="See `GetBoundingBox`")
4354 Brush
= property(GetBrush
,SetBrush
,doc
="See `GetBrush` and `SetBrush`")
4355 CharHeight
= property(GetCharHeight
,doc
="See `GetCharHeight`")
4356 CharWidth
= property(GetCharWidth
,doc
="See `GetCharWidth`")
4357 ClippingBox
= property(GetClippingBox
,doc
="See `GetClippingBox`")
4358 ClippingRect
= property(GetClippingRect
,SetClippingRect
,doc
="See `GetClippingRect` and `SetClippingRect`")
4359 Depth
= property(GetDepth
,doc
="See `GetDepth`")
4360 DeviceOrigin
= property(GetDeviceOrigin
,SetDeviceOrigin
,doc
="See `GetDeviceOrigin` and `SetDeviceOrigin`")
4361 Font
= property(GetFont
,SetFont
,doc
="See `GetFont` and `SetFont`")
4362 FullTextExtent
= property(GetFullTextExtent
,doc
="See `GetFullTextExtent`")
4363 LogicalFunction
= property(GetLogicalFunction
,SetLogicalFunction
,doc
="See `GetLogicalFunction` and `SetLogicalFunction`")
4364 LogicalOrigin
= property(GetLogicalOrigin
,SetLogicalOrigin
,doc
="See `GetLogicalOrigin` and `SetLogicalOrigin`")
4365 LogicalScale
= property(GetLogicalScale
,SetLogicalScale
,doc
="See `GetLogicalScale` and `SetLogicalScale`")
4366 MapMode
= property(GetMapMode
,SetMapMode
,doc
="See `GetMapMode` and `SetMapMode`")
4367 MultiLineTextExtent
= property(GetMultiLineTextExtent
,doc
="See `GetMultiLineTextExtent`")
4368 Optimization
= property(GetOptimization
,SetOptimization
,doc
="See `GetOptimization` and `SetOptimization`")
4369 PPI
= property(GetPPI
,doc
="See `GetPPI`")
4370 PartialTextExtents
= property(GetPartialTextExtents
,doc
="See `GetPartialTextExtents`")
4371 Pen
= property(GetPen
,SetPen
,doc
="See `GetPen` and `SetPen`")
4372 Pixel
= property(GetPixel
,doc
="See `GetPixel`")
4373 PixelPoint
= property(GetPixelPoint
,doc
="See `GetPixelPoint`")
4374 Size
= property(GetSize
,doc
="See `GetSize`")
4375 SizeMM
= property(GetSizeMM
,doc
="See `GetSizeMM`")
4376 TextBackground
= property(GetTextBackground
,SetTextBackground
,doc
="See `GetTextBackground` and `SetTextBackground`")
4377 TextExtent
= property(GetTextExtent
,doc
="See `GetTextExtent`")
4378 TextForeground
= property(GetTextForeground
,SetTextForeground
,doc
="See `GetTextForeground` and `SetTextForeground`")
4379 UserScale
= property(GetUserScale
,SetUserScale
,doc
="See `GetUserScale` and `SetUserScale`")
4380 LayoutDirection
= property(GetLayoutDirection
,SetLayoutDirection
)
4381 _gdi_
.DC_swigregister(DC
)
4383 #---------------------------------------------------------------------------
4387 A memory device context provides a means to draw graphics onto a
4388 bitmap. A bitmap must be selected into the new memory DC before it may
4389 be used for anything. Typical usage is as follows::
4392 dc.SelectObject(bitmap)
4393 # draw on the dc usign any of the Draw methods
4394 dc.SelectObject(wx.NullBitmap)
4395 # the bitmap now contains wahtever was drawn upon it
4397 Note that the memory DC *must* be deleted (or the bitmap selected out
4398 of it) before a bitmap can be reselected into another memory DC.
4401 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4402 __repr__
= _swig_repr
4403 def __init__(self
, *args
, **kwargs
):
4405 __init__(self) -> MemoryDC
4407 Constructs a new memory device context.
4409 Use the Ok member to test whether the constructor was successful in
4410 creating a usable device context. Don't forget to select a bitmap into
4411 the DC before drawing on it.
4413 _gdi_
.MemoryDC_swiginit(self
,_gdi_
.new_MemoryDC(*args
, **kwargs
))
4414 def SelectObject(*args
, **kwargs
):
4416 SelectObject(self, Bitmap bitmap)
4418 Selects the bitmap into the device context, to use as the memory
4419 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4420 the DC, and therefore the bitmap, and also to use Blit to copy the
4423 If the argument is wx.NullBitmap (or some other uninitialised
4424 `wx.Bitmap`) the current bitmap is selected out of the device context,
4425 and the original bitmap restored, allowing the current bitmap to be
4428 return _gdi_
.MemoryDC_SelectObject(*args
, **kwargs
)
4430 _gdi_
.MemoryDC_swigregister(MemoryDC
)
4432 def MemoryDCFromDC(*args
, **kwargs
):
4434 MemoryDCFromDC(DC oldDC) -> MemoryDC
4436 Creates a DC that is compatible with the oldDC.
4438 val
= _gdi_
.new_MemoryDCFromDC(*args
, **kwargs
)
4441 #---------------------------------------------------------------------------
4443 BUFFER_VIRTUAL_AREA
= _gdi_
.BUFFER_VIRTUAL_AREA
4444 BUFFER_CLIENT_AREA
= _gdi_
.BUFFER_CLIENT_AREA
4445 class BufferedDC(DC
):
4447 This simple class provides a simple way to avoid flicker: when drawing
4448 on it, everything is in fact first drawn on an in-memory buffer (a
4449 `wx.Bitmap`) and then copied to the screen only once, when this object
4452 It can be used in the same way as any other device context.
4453 wx.BufferedDC itself typically replaces `wx.ClientDC`, if you want to
4454 use it in your EVT_PAINT handler, you should look at
4455 `wx.BufferedPaintDC`.
4457 Please note that GTK+ 2.0 and OS X provide double buffering themselves
4458 natively so using this class on those platforms will normally result
4459 in an unneeded level of buffering.
4462 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4463 __repr__
= _swig_repr
4464 def __init__(self
, *args
):
4466 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4467 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4468 __init__(self, Window win, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4470 Constructs a buffered DC.
4472 _gdi_
.BufferedDC_swiginit(self
,_gdi_
.new_BufferedDC(*args
))
4473 self
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
4475 __swig_destroy__
= _gdi_
.delete_BufferedDC
4476 __del__
= lambda self
: None;
4477 def UnMask(*args
, **kwargs
):
4481 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4482 can be effectively used once only). This is usually only called in
4485 return _gdi_
.BufferedDC_UnMask(*args
, **kwargs
)
4487 _gdi_
.BufferedDC_swigregister(BufferedDC
)
4489 class BufferedPaintDC(BufferedDC
):
4491 This is a subclass of `wx.BufferedDC` which can be used inside of an
4492 EVT_PAINT event handler. Just create an object of this class instead
4493 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4494 flicker. The only thing to watch out for is that if you are using this
4495 class together with `wx.ScrolledWindow`, you probably do **not** want
4496 to call `wx.Window.PrepareDC` on it as it already does this internally
4497 for the real underlying `wx.PaintDC`.
4499 If your window is already fully buffered in a `wx.Bitmap` then your
4500 EVT_PAINT handler can be as simple as just creating a
4501 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4502 automatically when it is destroyed. For example::
4504 def OnPaint(self, event):
4505 dc = wx.BufferedPaintDC(self, self.buffer)
4510 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4511 __repr__
= _swig_repr
4512 def __init__(self
, *args
, **kwargs
):
4514 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
4516 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4517 provide the bitmap to be used for buffering or let this object create
4518 one internally (in the latter case, the size of the client part of the
4519 window is automatically used).
4521 _gdi_
.BufferedPaintDC_swiginit(self
,_gdi_
.new_BufferedPaintDC(*args
, **kwargs
))
4522 _gdi_
.BufferedPaintDC_swigregister(BufferedPaintDC
)
4524 #---------------------------------------------------------------------------
4528 A wxScreenDC can be used to paint anywhere on the screen. This should
4529 normally be constructed as a temporary stack object; don't store a
4533 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4534 __repr__
= _swig_repr
4535 def __init__(self
, *args
, **kwargs
):
4537 __init__(self) -> ScreenDC
4539 A wxScreenDC can be used to paint anywhere on the screen. This should
4540 normally be constructed as a temporary stack object; don't store a
4544 _gdi_
.ScreenDC_swiginit(self
,_gdi_
.new_ScreenDC(*args
, **kwargs
))
4545 def StartDrawingOnTopWin(*args
, **kwargs
):
4547 StartDrawingOnTopWin(self, Window window) -> bool
4549 Specify that the area of the screen to be drawn upon coincides with
4552 :see: `EndDrawingOnTop`
4554 return _gdi_
.ScreenDC_StartDrawingOnTopWin(*args
, **kwargs
)
4556 def StartDrawingOnTop(*args
, **kwargs
):
4558 StartDrawingOnTop(self, Rect rect=None) -> bool
4560 Specify that the area is the given rectangle, or the whole screen if
4563 :see: `EndDrawingOnTop`
4565 return _gdi_
.ScreenDC_StartDrawingOnTop(*args
, **kwargs
)
4567 def EndDrawingOnTop(*args
, **kwargs
):
4569 EndDrawingOnTop(self) -> bool
4571 Use this in conjunction with `StartDrawingOnTop` or
4572 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4573 top of existing windows. Without this, some window systems (such as X)
4574 only allow drawing to take place underneath other windows.
4576 You might use this pair of functions when implementing a drag feature,
4577 for example as in the `wx.SplitterWindow` implementation.
4579 These functions are probably obsolete since the X implementations
4580 allow drawing directly on the screen now. However, the fact that this
4581 function allows the screen to be refreshed afterwards may be useful
4582 to some applications.
4584 return _gdi_
.ScreenDC_EndDrawingOnTop(*args
, **kwargs
)
4586 _gdi_
.ScreenDC_swigregister(ScreenDC
)
4588 #---------------------------------------------------------------------------
4592 A wx.WindowDC must be constructed if an application wishes to paint on
4593 the whole area of a window (client and decorations). This should
4594 normally be constructed as a temporary stack object; don't store a
4597 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4598 __repr__
= _swig_repr
4599 def __init__(self
, *args
, **kwargs
):
4601 __init__(self, Window win) -> WindowDC
4603 Constructor. Pass the window on which you wish to paint.
4605 _gdi_
.WindowDC_swiginit(self
,_gdi_
.new_WindowDC(*args
, **kwargs
))
4606 _gdi_
.WindowDC_swigregister(WindowDC
)
4608 #---------------------------------------------------------------------------
4610 class ClientDC(WindowDC
):
4612 A wx.ClientDC must be constructed if an application wishes to paint on
4613 the client area of a window from outside an EVT_PAINT event. This should
4614 normally be constructed as a temporary stack object; don't store a
4615 wx.ClientDC object long term.
4617 To draw on a window from within an EVT_PAINT handler, construct a
4618 `wx.PaintDC` object.
4620 To draw on the whole window including decorations, construct a
4621 `wx.WindowDC` object (Windows only).
4624 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4625 __repr__
= _swig_repr
4626 def __init__(self
, *args
, **kwargs
):
4628 __init__(self, Window win) -> ClientDC
4630 Constructor. Pass the window on which you wish to paint.
4632 _gdi_
.ClientDC_swiginit(self
,_gdi_
.new_ClientDC(*args
, **kwargs
))
4633 _gdi_
.ClientDC_swigregister(ClientDC
)
4635 #---------------------------------------------------------------------------
4637 class PaintDC(ClientDC
):
4639 A wx.PaintDC must be constructed if an application wishes to paint on
4640 the client area of a window from within an EVT_PAINT event
4641 handler. This should normally be constructed as a temporary stack
4642 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4643 handler, you **must** create a wx.PaintDC object within it even if you
4644 don't actually use it.
4646 Using wx.PaintDC within EVT_PAINT handlers is important because it
4647 automatically sets the clipping area to the damaged area of the
4648 window. Attempts to draw outside this area do not appear.
4650 To draw on a window from outside EVT_PAINT handlers, construct a
4651 `wx.ClientDC` object.
4654 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4655 __repr__
= _swig_repr
4656 def __init__(self
, *args
, **kwargs
):
4658 __init__(self, Window win) -> PaintDC
4660 Constructor. Pass the window on which you wish to paint.
4662 _gdi_
.PaintDC_swiginit(self
,_gdi_
.new_PaintDC(*args
, **kwargs
))
4663 _gdi_
.PaintDC_swigregister(PaintDC
)
4665 #---------------------------------------------------------------------------
4667 if 'wxMac' in wx
.PlatformInfo
or 'gtk2' in wx
.PlatformInfo
:
4668 _AutoBufferedPaintDCBase
= PaintDC
4670 _AutoBufferedPaintDCBase
= BufferedPaintDC
4672 class AutoBufferedPaintDC(_AutoBufferedPaintDCBase
):
4674 If the current platform double buffers by default then this DC is the
4675 same as a plain `wx.PaintDC`, otherwise it is a `wx.BufferedPaintDC`.
4677 def __init__(self
, window
):
4678 _AutoBufferedPaintDCBase
.__init
__(self
, window
)
4680 #---------------------------------------------------------------------------
4684 wx.MirrorDC is a simple wrapper class which is always associated with a
4685 real `wx.DC` object and either forwards all of its operations to it
4686 without changes (no mirroring takes place) or exchanges x and y
4687 coordinates which makes it possible to reuse the same code to draw a
4688 figure and its mirror -- i.e. reflection related to the diagonal line
4691 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4692 __repr__
= _swig_repr
4693 def __init__(self
, *args
, **kwargs
):
4695 __init__(self, DC dc, bool mirror) -> MirrorDC
4697 Creates a mirrored DC associated with the real *dc*. Everything drawn
4698 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4701 _gdi_
.MirrorDC_swiginit(self
,_gdi_
.new_MirrorDC(*args
, **kwargs
))
4702 _gdi_
.MirrorDC_swigregister(MirrorDC
)
4704 #---------------------------------------------------------------------------
4706 class PostScriptDC(DC
):
4707 """This is a `wx.DC` that can write to PostScript files on any platform."""
4708 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4709 __repr__
= _swig_repr
4710 def __init__(self
, *args
, **kwargs
):
4712 __init__(self, wxPrintData printData) -> PostScriptDC
4714 Constructs a PostScript printer device context from a `wx.PrintData`
4717 _gdi_
.PostScriptDC_swiginit(self
,_gdi_
.new_PostScriptDC(*args
, **kwargs
))
4718 def GetPrintData(*args
, **kwargs
):
4719 """GetPrintData(self) -> wxPrintData"""
4720 return _gdi_
.PostScriptDC_GetPrintData(*args
, **kwargs
)
4722 def SetPrintData(*args
, **kwargs
):
4723 """SetPrintData(self, wxPrintData data)"""
4724 return _gdi_
.PostScriptDC_SetPrintData(*args
, **kwargs
)
4726 def SetResolution(*args
, **kwargs
):
4728 SetResolution(int ppi)
4730 Set resolution (in pixels per inch) that will be used in PostScript
4731 output. Default is 720ppi.
4733 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4735 SetResolution
= staticmethod(SetResolution
)
4736 def GetResolution(*args
, **kwargs
):
4738 GetResolution() -> int
4740 Return resolution used in PostScript output.
4742 return _gdi_
.PostScriptDC_GetResolution(*args
, **kwargs
)
4744 GetResolution
= staticmethod(GetResolution
)
4745 PrintData
= property(GetPrintData
,SetPrintData
,doc
="See `GetPrintData` and `SetPrintData`")
4746 _gdi_
.PostScriptDC_swigregister(PostScriptDC
)
4748 def PostScriptDC_SetResolution(*args
, **kwargs
):
4750 PostScriptDC_SetResolution(int ppi)
4752 Set resolution (in pixels per inch) that will be used in PostScript
4753 output. Default is 720ppi.
4755 return _gdi_
.PostScriptDC_SetResolution(*args
, **kwargs
)
4757 def PostScriptDC_GetResolution(*args
):
4759 PostScriptDC_GetResolution() -> int
4761 Return resolution used in PostScript output.
4763 return _gdi_
.PostScriptDC_GetResolution(*args
)
4765 #---------------------------------------------------------------------------
4767 class MetaFile(_core
.Object
):
4768 """Proxy of C++ MetaFile class"""
4769 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4770 __repr__
= _swig_repr
4771 def __init__(self
, *args
, **kwargs
):
4772 """__init__(self, String filename=EmptyString) -> MetaFile"""
4773 _gdi_
.MetaFile_swiginit(self
,_gdi_
.new_MetaFile(*args
, **kwargs
))
4774 __swig_destroy__
= _gdi_
.delete_MetaFile
4775 __del__
= lambda self
: None;
4776 def IsOk(*args
, **kwargs
):
4777 """IsOk(self) -> bool"""
4778 return _gdi_
.MetaFile_IsOk(*args
, **kwargs
)
4781 def SetClipboard(*args
, **kwargs
):
4782 """SetClipboard(self, int width=0, int height=0) -> bool"""
4783 return _gdi_
.MetaFile_SetClipboard(*args
, **kwargs
)
4785 def GetSize(*args
, **kwargs
):
4786 """GetSize(self) -> Size"""
4787 return _gdi_
.MetaFile_GetSize(*args
, **kwargs
)
4789 def GetWidth(*args
, **kwargs
):
4790 """GetWidth(self) -> int"""
4791 return _gdi_
.MetaFile_GetWidth(*args
, **kwargs
)
4793 def GetHeight(*args
, **kwargs
):
4794 """GetHeight(self) -> int"""
4795 return _gdi_
.MetaFile_GetHeight(*args
, **kwargs
)
4797 def __nonzero__(self
): return self
.IsOk()
4798 _gdi_
.MetaFile_swigregister(MetaFile
)
4800 class MetaFileDC(DC
):
4801 """Proxy of C++ MetaFileDC class"""
4802 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4803 __repr__
= _swig_repr
4804 def __init__(self
, *args
, **kwargs
):
4806 __init__(self, String filename=EmptyString, int width=0, int height=0,
4807 String description=EmptyString) -> MetaFileDC
4809 _gdi_
.MetaFileDC_swiginit(self
,_gdi_
.new_MetaFileDC(*args
, **kwargs
))
4810 def Close(*args
, **kwargs
):
4811 """Close(self) -> MetaFile"""
4812 return _gdi_
.MetaFileDC_Close(*args
, **kwargs
)
4814 _gdi_
.MetaFileDC_swigregister(MetaFileDC
)
4816 class PrinterDC(DC
):
4817 """Proxy of C++ PrinterDC class"""
4818 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4819 __repr__
= _swig_repr
4820 def __init__(self
, *args
, **kwargs
):
4821 """__init__(self, wxPrintData printData) -> PrinterDC"""
4822 _gdi_
.PrinterDC_swiginit(self
,_gdi_
.new_PrinterDC(*args
, **kwargs
))
4823 _gdi_
.PrinterDC_swigregister(PrinterDC
)
4825 #---------------------------------------------------------------------------
4827 class GraphicsPath(object):
4828 """Proxy of C++ GraphicsPath class"""
4829 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4830 def __init__(self
): raise AttributeError, "No constructor defined"
4831 __repr__
= _swig_repr
4832 __swig_destroy__
= _gdi_
.delete_GraphicsPath
4833 __del__
= lambda self
: None;
4834 def MoveToPoint(*args
, **kwargs
):
4836 MoveToPoint(self, Double x, Double y)
4838 Begins a new subpath at (x,y)
4840 return _gdi_
.GraphicsPath_MoveToPoint(*args
, **kwargs
)
4842 def AddLineToPoint(*args
, **kwargs
):
4844 AddLineToPoint(self, Double x, Double y)
4846 Adds a straight line from the current point to (x,y)
4848 return _gdi_
.GraphicsPath_AddLineToPoint(*args
, **kwargs
)
4850 def AddCurveToPoint(*args
, **kwargs
):
4852 AddCurveToPoint(self, Double cx1, Double cy1, Double cx2, Double cy2, Double x,
4855 Adds a cubic Bezier curve from the current point, using two control
4856 points and an end point
4858 return _gdi_
.GraphicsPath_AddCurveToPoint(*args
, **kwargs
)
4860 def CloseSubpath(*args
, **kwargs
):
4864 closes the current sub-path
4866 return _gdi_
.GraphicsPath_CloseSubpath(*args
, **kwargs
)
4868 def GetCurrentPoint(*args
, **kwargs
):
4870 GetCurrentPoint(self) -> Point2D
4872 Gets the last point of the current path, (0,0) if not yet set
4874 return _gdi_
.GraphicsPath_GetCurrentPoint(*args
, **kwargs
)
4876 def AddArc(*args
, **kwargs
):
4878 AddArc(self, Double x, Double y, Double r, Double startAngle, Double endAngle,
4881 Adds an arc of a circle centering at (x,y) with radius (r) from
4882 startAngle to endAngle
4884 return _gdi_
.GraphicsPath_AddArc(*args
, **kwargs
)
4886 def AddQuadCurveToPoint(*args
, **kwargs
):
4888 AddQuadCurveToPoint(self, Double cx, Double cy, Double x, Double y)
4890 Adds a quadratic Bezier curve from the current point, using a control
4891 point and an end point
4893 return _gdi_
.GraphicsPath_AddQuadCurveToPoint(*args
, **kwargs
)
4895 def AddRectangle(*args
, **kwargs
):
4897 AddRectangle(self, Double x, Double y, Double w, Double h)
4899 Appends a rectangle as a new closed subpath
4901 return _gdi_
.GraphicsPath_AddRectangle(*args
, **kwargs
)
4903 def AddCircle(*args
, **kwargs
):
4905 AddCircle(self, Double x, Double y, Double r)
4907 Appends a circle as a new closed subpath with the given radius.
4909 return _gdi_
.GraphicsPath_AddCircle(*args
, **kwargs
)
4911 def AddArcToPoint(*args
, **kwargs
):
4913 AddArcToPoint(self, Double x1, Double y1, Double x2, Double y2, Double r)
4915 Draws a an arc to two tangents connecting (current) to (x1,y1) and (x1,y1)
4916 to (x2,y2), also a straight line from (current) to (x1,y1)
4918 return _gdi_
.GraphicsPath_AddArcToPoint(*args
, **kwargs
)
4920 _gdi_
.GraphicsPath_swigregister(GraphicsPath
)
4922 class GraphicsContext(object):
4923 """Proxy of C++ GraphicsContext class"""
4924 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
4925 def __init__(self
): raise AttributeError, "No constructor defined"
4926 __repr__
= _swig_repr
4927 __swig_destroy__
= _gdi_
.delete_GraphicsContext
4928 __del__
= lambda self
: None;
4929 def Create(*args
, **kwargs
):
4930 """Create(WindowDC dc) -> GraphicsContext"""
4931 val
= _gdi_
.GraphicsContext_Create(*args
, **kwargs
)
4932 val
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
4935 Create
= staticmethod(Create
)
4936 def CreatePath(*args
, **kwargs
):
4937 """CreatePath(self) -> GraphicsPath"""
4938 return _gdi_
.GraphicsContext_CreatePath(*args
, **kwargs
)
4940 def PushState(*args
, **kwargs
):
4941 """PushState(self)"""
4942 return _gdi_
.GraphicsContext_PushState(*args
, **kwargs
)
4944 def PopState(*args
, **kwargs
):
4945 """PopState(self)"""
4946 return _gdi_
.GraphicsContext_PopState(*args
, **kwargs
)
4948 def Clip(*args
, **kwargs
):
4949 """Clip(self, Region region)"""
4950 return _gdi_
.GraphicsContext_Clip(*args
, **kwargs
)
4952 def Translate(*args
, **kwargs
):
4953 """Translate(self, Double dx, Double dy)"""
4954 return _gdi_
.GraphicsContext_Translate(*args
, **kwargs
)
4956 def Scale(*args
, **kwargs
):
4957 """Scale(self, Double xScale, Double yScale)"""
4958 return _gdi_
.GraphicsContext_Scale(*args
, **kwargs
)
4960 def Rotate(*args
, **kwargs
):
4961 """Rotate(self, Double angle)"""
4962 return _gdi_
.GraphicsContext_Rotate(*args
, **kwargs
)
4964 def SetPen(*args
, **kwargs
):
4965 """SetPen(self, Pen pen)"""
4966 return _gdi_
.GraphicsContext_SetPen(*args
, **kwargs
)
4968 def SetBrush(*args
, **kwargs
):
4969 """SetBrush(self, Brush brush)"""
4970 return _gdi_
.GraphicsContext_SetBrush(*args
, **kwargs
)
4972 def SetLinearGradientBrush(*args
, **kwargs
):
4974 SetLinearGradientBrush(self, Double x1, Double y1, Double x2, Double y2, Colour c1,
4977 return _gdi_
.GraphicsContext_SetLinearGradientBrush(*args
, **kwargs
)
4979 def SetRadialGradientBrush(*args
, **kwargs
):
4981 SetRadialGradientBrush(self, Double xo, Double yo, Double xc, Double yc, Double radius,
4982 Colour oColor, Colour cColor)
4984 return _gdi_
.GraphicsContext_SetRadialGradientBrush(*args
, **kwargs
)
4986 def SetFont(*args
, **kwargs
):
4987 """SetFont(self, Font font)"""
4988 return _gdi_
.GraphicsContext_SetFont(*args
, **kwargs
)
4990 def SetTextColor(*args
, **kwargs
):
4991 """SetTextColor(self, Colour col)"""
4992 return _gdi_
.GraphicsContext_SetTextColor(*args
, **kwargs
)
4994 def StrokePath(*args
, **kwargs
):
4995 """StrokePath(self, GraphicsPath path)"""
4996 return _gdi_
.GraphicsContext_StrokePath(*args
, **kwargs
)
4998 def FillPath(*args
, **kwargs
):
4999 """FillPath(self, GraphicsPath path, int fillStyle=WINDING_RULE)"""
5000 return _gdi_
.GraphicsContext_FillPath(*args
, **kwargs
)
5002 def DrawPath(*args
, **kwargs
):
5003 """DrawPath(self, GraphicsPath path, int fillStyle=WINDING_RULE)"""
5004 return _gdi_
.GraphicsContext_DrawPath(*args
, **kwargs
)
5006 def DrawText(*args
, **kwargs
):
5007 """DrawText(self, String str, Double x, Double y)"""
5008 return _gdi_
.GraphicsContext_DrawText(*args
, **kwargs
)
5010 def DrawRotatedText(*args
, **kwargs
):
5011 """DrawRotatedText(self, String str, Double x, Double y, Double angle)"""
5012 return _gdi_
.GraphicsContext_DrawRotatedText(*args
, **kwargs
)
5014 def GetTextExtent(*args
, **kwargs
):
5015 """GetTextExtend(self, text) --> (width, height, descent, externalLeading)"""
5016 return _gdi_
.GraphicsContext_GetTextExtent(*args
, **kwargs
)
5018 def GetPartialTextExtents(*args
, **kwargs
):
5019 """GetPartialTextExtents(self, text) -> [widths]"""
5020 return _gdi_
.GraphicsContext_GetPartialTextExtents(*args
, **kwargs
)
5022 def DrawBitmap(*args
, **kwargs
):
5023 """DrawBitmap(self, Bitmap bmp, Double x, Double y, Double w, Double h)"""
5024 return _gdi_
.GraphicsContext_DrawBitmap(*args
, **kwargs
)
5026 def DrawIcon(*args
, **kwargs
):
5027 """DrawIcon(self, Icon icon, Double x, Double y, Double w, Double h)"""
5028 return _gdi_
.GraphicsContext_DrawIcon(*args
, **kwargs
)
5030 def StrokeLine(*args
, **kwargs
):
5031 """StrokeLine(self, Double x1, Double y1, Double x2, Double y2)"""
5032 return _gdi_
.GraphicsContext_StrokeLine(*args
, **kwargs
)
5034 def StrokeLines(*args
, **kwargs
):
5035 """StrokeLines(self, List points)"""
5036 return _gdi_
.GraphicsContext_StrokeLines(*args
, **kwargs
)
5038 def StrokeDisconnectedLines(*args
, **kwargs
):
5039 """StrokeDisconnectedLines(self, PyObject beginPoints, PyObject endPoints)"""
5040 return _gdi_
.GraphicsContext_StrokeDisconnectedLines(*args
, **kwargs
)
5042 def DrawLines(*args
, **kwargs
):
5043 """DrawLines(self, size_t points, int fillStyle=WINDING_RULE)"""
5044 return _gdi_
.GraphicsContext_DrawLines(*args
, **kwargs
)
5046 def DrawRectangle(*args
, **kwargs
):
5047 """DrawRectangle(self, Double x, Double y, Double w, Double h)"""
5048 return _gdi_
.GraphicsContext_DrawRectangle(*args
, **kwargs
)
5050 def DrawEllipse(*args
, **kwargs
):
5051 """DrawEllipse(self, Double x, Double y, Double w, Double h)"""
5052 return _gdi_
.GraphicsContext_DrawEllipse(*args
, **kwargs
)
5054 def DrawRoundedRectangle(*args
, **kwargs
):
5055 """DrawRoundedRectangle(self, Double x, Double y, Double w, Double h, Double radius)"""
5056 return _gdi_
.GraphicsContext_DrawRoundedRectangle(*args
, **kwargs
)
5058 _gdi_
.GraphicsContext_swigregister(GraphicsContext
)
5060 def GraphicsContext_Create(*args
, **kwargs
):
5061 """GraphicsContext_Create(WindowDC dc) -> GraphicsContext"""
5062 val
= _gdi_
.GraphicsContext_Create(*args
, **kwargs
)
5063 val
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
5067 """Proxy of C++ GCDC class"""
5068 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5069 __repr__
= _swig_repr
5070 def __init__(self
, *args
, **kwargs
):
5071 """__init__(self, WindowDC dc) -> GCDC"""
5072 _gdi_
.GCDC_swiginit(self
,_gdi_
.new_GCDC(*args
, **kwargs
))
5073 self
.__dc
= args
[0] # save a ref so the other dc will not be deleted before self
5075 __swig_destroy__
= _gdi_
.delete_GCDC
5076 __del__
= lambda self
: None;
5077 def GetGraphicContext(*args
, **kwargs
):
5078 """GetGraphicContext(self) -> GraphicsContext"""
5079 return _gdi_
.GCDC_GetGraphicContext(*args
, **kwargs
)
5081 _gdi_
.GCDC_swigregister(GCDC
)
5083 class Overlay(object):
5084 """Proxy of C++ Overlay class"""
5085 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5086 __repr__
= _swig_repr
5087 def __init__(self
, *args
, **kwargs
):
5088 """__init__(self) -> Overlay"""
5089 _gdi_
.Overlay_swiginit(self
,_gdi_
.new_Overlay(*args
, **kwargs
))
5090 __swig_destroy__
= _gdi_
.delete_Overlay
5091 __del__
= lambda self
: None;
5092 def Reset(*args
, **kwargs
):
5094 return _gdi_
.Overlay_Reset(*args
, **kwargs
)
5096 _gdi_
.Overlay_swigregister(Overlay
)
5098 class DCOverlay(object):
5099 """Proxy of C++ DCOverlay class"""
5100 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5101 __repr__
= _swig_repr
5102 def __init__(self
, *args
):
5104 __init__(self, Overlay overlay, WindowDC dc, int x, int y, int width,
5105 int height) -> DCOverlay
5106 __init__(self, Overlay overlay, WindowDC dc) -> DCOverlay
5108 _gdi_
.DCOverlay_swiginit(self
,_gdi_
.new_DCOverlay(*args
))
5109 __swig_destroy__
= _gdi_
.delete_DCOverlay
5110 __del__
= lambda self
: None;
5111 def Clear(*args
, **kwargs
):
5113 return _gdi_
.DCOverlay_Clear(*args
, **kwargs
)
5115 _gdi_
.DCOverlay_swigregister(DCOverlay
)
5117 #---------------------------------------------------------------------------
5119 IMAGELIST_DRAW_NORMAL
= _gdi_
.IMAGELIST_DRAW_NORMAL
5120 IMAGELIST_DRAW_TRANSPARENT
= _gdi_
.IMAGELIST_DRAW_TRANSPARENT
5121 IMAGELIST_DRAW_SELECTED
= _gdi_
.IMAGELIST_DRAW_SELECTED
5122 IMAGELIST_DRAW_FOCUSED
= _gdi_
.IMAGELIST_DRAW_FOCUSED
5123 IMAGE_LIST_NORMAL
= _gdi_
.IMAGE_LIST_NORMAL
5124 IMAGE_LIST_SMALL
= _gdi_
.IMAGE_LIST_SMALL
5125 IMAGE_LIST_STATE
= _gdi_
.IMAGE_LIST_STATE
5126 class ImageList(_core
.Object
):
5127 """Proxy of C++ ImageList class"""
5128 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5129 __repr__
= _swig_repr
5130 def __init__(self
, *args
, **kwargs
):
5131 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
5132 _gdi_
.ImageList_swiginit(self
,_gdi_
.new_ImageList(*args
, **kwargs
))
5133 __swig_destroy__
= _gdi_
.delete_ImageList
5134 __del__
= lambda self
: None;
5135 def Add(*args
, **kwargs
):
5136 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
5137 return _gdi_
.ImageList_Add(*args
, **kwargs
)
5139 def AddWithColourMask(*args
, **kwargs
):
5140 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
5141 return _gdi_
.ImageList_AddWithColourMask(*args
, **kwargs
)
5143 def AddIcon(*args
, **kwargs
):
5144 """AddIcon(self, Icon icon) -> int"""
5145 return _gdi_
.ImageList_AddIcon(*args
, **kwargs
)
5147 def GetBitmap(*args
, **kwargs
):
5148 """GetBitmap(self, int index) -> Bitmap"""
5149 return _gdi_
.ImageList_GetBitmap(*args
, **kwargs
)
5151 def GetIcon(*args
, **kwargs
):
5152 """GetIcon(self, int index) -> Icon"""
5153 return _gdi_
.ImageList_GetIcon(*args
, **kwargs
)
5155 def Replace(*args
, **kwargs
):
5156 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
5157 return _gdi_
.ImageList_Replace(*args
, **kwargs
)
5159 def Draw(*args
, **kwargs
):
5161 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
5162 bool solidBackground=False) -> bool
5164 return _gdi_
.ImageList_Draw(*args
, **kwargs
)
5166 def GetImageCount(*args
, **kwargs
):
5167 """GetImageCount(self) -> int"""
5168 return _gdi_
.ImageList_GetImageCount(*args
, **kwargs
)
5170 def Remove(*args
, **kwargs
):
5171 """Remove(self, int index) -> bool"""
5172 return _gdi_
.ImageList_Remove(*args
, **kwargs
)
5174 def RemoveAll(*args
, **kwargs
):
5175 """RemoveAll(self) -> bool"""
5176 return _gdi_
.ImageList_RemoveAll(*args
, **kwargs
)
5178 def GetSize(*args
, **kwargs
):
5179 """GetSize(index) -> (width,height)"""
5180 return _gdi_
.ImageList_GetSize(*args
, **kwargs
)
5182 ImageCount
= property(GetImageCount
,doc
="See `GetImageCount`")
5183 Size
= property(GetSize
,doc
="See `GetSize`")
5184 _gdi_
.ImageList_swigregister(ImageList
)
5186 #---------------------------------------------------------------------------
5188 class StockGDI(object):
5189 """Proxy of C++ StockGDI class"""
5190 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5191 __repr__
= _swig_repr
5192 BRUSH_BLACK
= _gdi_
.StockGDI_BRUSH_BLACK
5193 BRUSH_BLUE
= _gdi_
.StockGDI_BRUSH_BLUE
5194 BRUSH_CYAN
= _gdi_
.StockGDI_BRUSH_CYAN
5195 BRUSH_GREEN
= _gdi_
.StockGDI_BRUSH_GREEN
5196 BRUSH_GREY
= _gdi_
.StockGDI_BRUSH_GREY
5197 BRUSH_LIGHTGREY
= _gdi_
.StockGDI_BRUSH_LIGHTGREY
5198 BRUSH_MEDIUMGREY
= _gdi_
.StockGDI_BRUSH_MEDIUMGREY
5199 BRUSH_RED
= _gdi_
.StockGDI_BRUSH_RED
5200 BRUSH_TRANSPARENT
= _gdi_
.StockGDI_BRUSH_TRANSPARENT
5201 BRUSH_WHITE
= _gdi_
.StockGDI_BRUSH_WHITE
5202 COLOUR_BLACK
= _gdi_
.StockGDI_COLOUR_BLACK
5203 COLOUR_BLUE
= _gdi_
.StockGDI_COLOUR_BLUE
5204 COLOUR_CYAN
= _gdi_
.StockGDI_COLOUR_CYAN
5205 COLOUR_GREEN
= _gdi_
.StockGDI_COLOUR_GREEN
5206 COLOUR_LIGHTGREY
= _gdi_
.StockGDI_COLOUR_LIGHTGREY
5207 COLOUR_RED
= _gdi_
.StockGDI_COLOUR_RED
5208 COLOUR_WHITE
= _gdi_
.StockGDI_COLOUR_WHITE
5209 CURSOR_CROSS
= _gdi_
.StockGDI_CURSOR_CROSS
5210 CURSOR_HOURGLASS
= _gdi_
.StockGDI_CURSOR_HOURGLASS
5211 CURSOR_STANDARD
= _gdi_
.StockGDI_CURSOR_STANDARD
5212 FONT_ITALIC
= _gdi_
.StockGDI_FONT_ITALIC
5213 FONT_NORMAL
= _gdi_
.StockGDI_FONT_NORMAL
5214 FONT_SMALL
= _gdi_
.StockGDI_FONT_SMALL
5215 FONT_SWISS
= _gdi_
.StockGDI_FONT_SWISS
5216 PEN_BLACK
= _gdi_
.StockGDI_PEN_BLACK
5217 PEN_BLACKDASHED
= _gdi_
.StockGDI_PEN_BLACKDASHED
5218 PEN_CYAN
= _gdi_
.StockGDI_PEN_CYAN
5219 PEN_GREEN
= _gdi_
.StockGDI_PEN_GREEN
5220 PEN_GREY
= _gdi_
.StockGDI_PEN_GREY
5221 PEN_LIGHTGREY
= _gdi_
.StockGDI_PEN_LIGHTGREY
5222 PEN_MEDIUMGREY
= _gdi_
.StockGDI_PEN_MEDIUMGREY
5223 PEN_RED
= _gdi_
.StockGDI_PEN_RED
5224 PEN_TRANSPARENT
= _gdi_
.StockGDI_PEN_TRANSPARENT
5225 PEN_WHITE
= _gdi_
.StockGDI_PEN_WHITE
5226 ITEMCOUNT
= _gdi_
.StockGDI_ITEMCOUNT
5227 def __init__(self
, *args
, **kwargs
):
5228 """__init__(self) -> StockGDI"""
5229 _gdi_
.StockGDI_swiginit(self
,_gdi_
.new_StockGDI(*args
, **kwargs
))
5230 __swig_destroy__
= _gdi_
.delete_StockGDI
5231 __del__
= lambda self
: None;
5232 def DeleteAll(*args
, **kwargs
):
5234 return _gdi_
.StockGDI_DeleteAll(*args
, **kwargs
)
5236 DeleteAll
= staticmethod(DeleteAll
)
5237 def instance(*args
, **kwargs
):
5238 """instance() -> StockGDI"""
5239 return _gdi_
.StockGDI_instance(*args
, **kwargs
)
5241 instance
= staticmethod(instance
)
5242 def GetBrush(*args
, **kwargs
):
5243 """GetBrush(int item) -> Brush"""
5244 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
5246 GetBrush
= staticmethod(GetBrush
)
5247 def GetColour(*args
, **kwargs
):
5248 """GetColour(int item) -> Colour"""
5249 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
5251 GetColour
= staticmethod(GetColour
)
5252 def GetCursor(*args
, **kwargs
):
5253 """GetCursor(int item) -> Cursor"""
5254 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
5256 GetCursor
= staticmethod(GetCursor
)
5257 def GetPen(*args
, **kwargs
):
5258 """GetPen(int item) -> Pen"""
5259 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
5261 GetPen
= staticmethod(GetPen
)
5262 def GetFont(*args
, **kwargs
):
5263 """GetFont(self, int item) -> Font"""
5264 return _gdi_
.StockGDI_GetFont(*args
, **kwargs
)
5266 def _initStockObjects():
5268 wx
.ITALIC_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_ITALIC
).this
5269 wx
.NORMAL_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_NORMAL
).this
5270 wx
.SMALL_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_SMALL
).this
5271 wx
.SWISS_FONT
.this
= StockGDI
.instance().GetFont(StockGDI
.FONT_SWISS
).this
5273 wx
.BLACK_DASHED_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_BLACKDASHED
).this
5274 wx
.BLACK_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_BLACK
).this
5275 wx
.CYAN_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_CYAN
).this
5276 wx
.GREEN_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_GREEN
).this
5277 wx
.GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_GREY
).this
5278 wx
.LIGHT_GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_LIGHTGREY
).this
5279 wx
.MEDIUM_GREY_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_MEDIUMGREY
).this
5280 wx
.RED_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_RED
).this
5281 wx
.TRANSPARENT_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_TRANSPARENT
).this
5282 wx
.WHITE_PEN
.this
= StockGDI
.GetPen(StockGDI
.PEN_WHITE
).this
5284 wx
.BLACK_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLACK
).this
5285 wx
.BLUE_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_BLUE
).this
5286 wx
.CYAN_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_CYAN
).this
5287 wx
.GREEN_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREEN
).this
5288 wx
.GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_GREY
).this
5289 wx
.LIGHT_GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_LIGHTGREY
).this
5290 wx
.MEDIUM_GREY_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_MEDIUMGREY
).this
5291 wx
.RED_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_RED
).this
5292 wx
.TRANSPARENT_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_TRANSPARENT
).this
5293 wx
.WHITE_BRUSH
.this
= StockGDI
.GetBrush(StockGDI
.BRUSH_WHITE
).this
5295 wx
.BLACK
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_BLACK
).this
5296 wx
.BLUE
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_BLUE
).this
5297 wx
.CYAN
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_CYAN
).this
5298 wx
.GREEN
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_GREEN
).this
5299 wx
.LIGHT_GREY
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_LIGHTGREY
).this
5300 wx
.RED
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_RED
).this
5301 wx
.WHITE
.this
= StockGDI
.GetColour(StockGDI
.COLOUR_WHITE
).this
5303 wx
.CROSS_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_CROSS
).this
5304 wx
.HOURGLASS_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_HOURGLASS
).this
5305 wx
.STANDARD_CURSOR
.this
= StockGDI
.GetCursor(StockGDI
.CURSOR_STANDARD
).this
5307 wx
.TheFontList
.this
= _wxPyInitTheFontList().this
5308 wx
.ThePenList
.this
= _wxPyInitThePenList().this
5309 wx
.TheBrushList
.this
= _wxPyInitTheBrushList().this
5310 wx
.TheColourDatabase
.this
= _wxPyInitTheColourDatabase().this
5313 _initStockObjects
= staticmethod(_initStockObjects
)
5315 _gdi_
.StockGDI_swigregister(StockGDI
)
5317 def StockGDI_DeleteAll(*args
):
5318 """StockGDI_DeleteAll()"""
5319 return _gdi_
.StockGDI_DeleteAll(*args
)
5321 def StockGDI_instance(*args
):
5322 """StockGDI_instance() -> StockGDI"""
5323 return _gdi_
.StockGDI_instance(*args
)
5325 def StockGDI_GetBrush(*args
, **kwargs
):
5326 """StockGDI_GetBrush(int item) -> Brush"""
5327 return _gdi_
.StockGDI_GetBrush(*args
, **kwargs
)
5329 def StockGDI_GetColour(*args
, **kwargs
):
5330 """StockGDI_GetColour(int item) -> Colour"""
5331 return _gdi_
.StockGDI_GetColour(*args
, **kwargs
)
5333 def StockGDI_GetCursor(*args
, **kwargs
):
5334 """StockGDI_GetCursor(int item) -> Cursor"""
5335 return _gdi_
.StockGDI_GetCursor(*args
, **kwargs
)
5337 def StockGDI_GetPen(*args
, **kwargs
):
5338 """StockGDI_GetPen(int item) -> Pen"""
5339 return _gdi_
.StockGDI_GetPen(*args
, **kwargs
)
5341 # Create an uninitialized instance for the stock objects, they will
5342 # be initialized later when the wx.App object is created.
5343 ITALIC_FONT
= Font
.__new
__(Font
)
5344 NORMAL_FONT
= Font
.__new
__(Font
)
5345 SMALL_FONT
= Font
.__new
__(Font
)
5346 SWISS_FONT
= Font
.__new
__(Font
)
5348 BLACK_DASHED_PEN
= Pen
.__new
__(Pen
)
5349 BLACK_PEN
= Pen
.__new
__(Pen
)
5350 CYAN_PEN
= Pen
.__new
__(Pen
)
5351 GREEN_PEN
= Pen
.__new
__(Pen
)
5352 GREY_PEN
= Pen
.__new
__(Pen
)
5353 LIGHT_GREY_PEN
= Pen
.__new
__(Pen
)
5354 MEDIUM_GREY_PEN
= Pen
.__new
__(Pen
)
5355 RED_PEN
= Pen
.__new
__(Pen
)
5356 TRANSPARENT_PEN
= Pen
.__new
__(Pen
)
5357 WHITE_PEN
= Pen
.__new
__(Pen
)
5359 BLACK_BRUSH
= Brush
.__new
__(Brush
)
5360 BLUE_BRUSH
= Brush
.__new
__(Brush
)
5361 CYAN_BRUSH
= Brush
.__new
__(Brush
)
5362 GREEN_BRUSH
= Brush
.__new
__(Brush
)
5363 GREY_BRUSH
= Brush
.__new
__(Brush
)
5364 LIGHT_GREY_BRUSH
= Brush
.__new
__(Brush
)
5365 MEDIUM_GREY_BRUSH
= Brush
.__new
__(Brush
)
5366 RED_BRUSH
= Brush
.__new
__(Brush
)
5367 TRANSPARENT_BRUSH
= Brush
.__new
__(Brush
)
5368 WHITE_BRUSH
= Brush
.__new
__(Brush
)
5370 BLACK
= Colour
.__new
__(Colour
)
5371 BLUE
= Colour
.__new
__(Colour
)
5372 CYAN
= Colour
.__new
__(Colour
)
5373 GREEN
= Colour
.__new
__(Colour
)
5374 LIGHT_GREY
= Colour
.__new
__(Colour
)
5375 RED
= Colour
.__new
__(Colour
)
5376 WHITE
= Colour
.__new
__(Colour
)
5378 CROSS_CURSOR
= Cursor
.__new
__(Cursor
)
5379 HOURGLASS_CURSOR
= Cursor
.__new
__(Cursor
)
5380 STANDARD_CURSOR
= Cursor
.__new
__(Cursor
)
5382 class GDIObjListBase(object):
5383 """Proxy of C++ GDIObjListBase class"""
5384 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5385 __repr__
= _swig_repr
5386 def __init__(self
, *args
, **kwargs
):
5387 """__init__(self) -> GDIObjListBase"""
5388 _gdi_
.GDIObjListBase_swiginit(self
,_gdi_
.new_GDIObjListBase(*args
, **kwargs
))
5389 __swig_destroy__
= _gdi_
.delete_GDIObjListBase
5390 __del__
= lambda self
: None;
5391 _gdi_
.GDIObjListBase_swigregister(GDIObjListBase
)
5393 NullBitmap
= cvar
.NullBitmap
5394 NullIcon
= cvar
.NullIcon
5395 NullCursor
= cvar
.NullCursor
5396 NullPen
= cvar
.NullPen
5397 NullBrush
= cvar
.NullBrush
5398 NullPalette
= cvar
.NullPalette
5399 NullFont
= cvar
.NullFont
5400 NullColour
= cvar
.NullColour
5402 class PenList(GDIObjListBase
):
5403 """Proxy of C++ PenList class"""
5404 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5405 def __init__(self
): raise AttributeError, "No constructor defined"
5406 __repr__
= _swig_repr
5407 def FindOrCreatePen(*args
, **kwargs
):
5408 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
5409 return _gdi_
.PenList_FindOrCreatePen(*args
, **kwargs
)
5411 def AddPen(*args
, **kwargs
):
5412 """AddPen(self, Pen pen)"""
5413 return _gdi_
.PenList_AddPen(*args
, **kwargs
)
5415 def RemovePen(*args
, **kwargs
):
5416 """RemovePen(self, Pen pen)"""
5417 return _gdi_
.PenList_RemovePen(*args
, **kwargs
)
5419 AddPen
= wx
._deprecated
(AddPen
)
5420 RemovePen
= wx
._deprecated
(RemovePen
)
5422 _gdi_
.PenList_swigregister(PenList
)
5424 class BrushList(GDIObjListBase
):
5425 """Proxy of C++ BrushList class"""
5426 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5427 def __init__(self
): raise AttributeError, "No constructor defined"
5428 __repr__
= _swig_repr
5429 def FindOrCreateBrush(*args
, **kwargs
):
5430 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
5431 return _gdi_
.BrushList_FindOrCreateBrush(*args
, **kwargs
)
5433 def AddBrush(*args
, **kwargs
):
5434 """AddBrush(self, Brush brush)"""
5435 return _gdi_
.BrushList_AddBrush(*args
, **kwargs
)
5437 def RemoveBrush(*args
, **kwargs
):
5438 """RemoveBrush(self, Brush brush)"""
5439 return _gdi_
.BrushList_RemoveBrush(*args
, **kwargs
)
5441 AddBrush
= wx
._deprecated
(AddBrush
)
5442 RemoveBrush
= wx
._deprecated
(RemoveBrush
)
5444 _gdi_
.BrushList_swigregister(BrushList
)
5446 class FontList(GDIObjListBase
):
5447 """Proxy of C++ FontList class"""
5448 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5449 def __init__(self
): raise AttributeError, "No constructor defined"
5450 __repr__
= _swig_repr
5451 def FindOrCreateFont(*args
, **kwargs
):
5453 FindOrCreateFont(self, int point_size, int family, int style, int weight,
5454 bool underline=False, String facename=EmptyString,
5455 int encoding=FONTENCODING_DEFAULT) -> Font
5457 return _gdi_
.FontList_FindOrCreateFont(*args
, **kwargs
)
5459 def AddFont(*args
, **kwargs
):
5460 """AddFont(self, Font font)"""
5461 return _gdi_
.FontList_AddFont(*args
, **kwargs
)
5463 def RemoveFont(*args
, **kwargs
):
5464 """RemoveFont(self, Font font)"""
5465 return _gdi_
.FontList_RemoveFont(*args
, **kwargs
)
5467 AddFont
= wx
._deprecated
(AddFont
)
5468 RemoveFont
= wx
._deprecated
(RemoveFont
)
5470 _gdi_
.FontList_swigregister(FontList
)
5472 class ColourDatabase(object):
5473 """Proxy of C++ ColourDatabase class"""
5474 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5475 __repr__
= _swig_repr
5476 def __init__(self
, *args
, **kwargs
):
5477 """__init__(self) -> ColourDatabase"""
5478 _gdi_
.ColourDatabase_swiginit(self
,_gdi_
.new_ColourDatabase(*args
, **kwargs
))
5479 __swig_destroy__
= _gdi_
.delete_ColourDatabase
5480 __del__
= lambda self
: None;
5481 def Find(*args
, **kwargs
):
5482 """Find(self, String name) -> Colour"""
5483 return _gdi_
.ColourDatabase_Find(*args
, **kwargs
)
5485 def FindName(*args
, **kwargs
):
5486 """FindName(self, Colour colour) -> String"""
5487 return _gdi_
.ColourDatabase_FindName(*args
, **kwargs
)
5490 def AddColour(*args
, **kwargs
):
5491 """AddColour(self, String name, Colour colour)"""
5492 return _gdi_
.ColourDatabase_AddColour(*args
, **kwargs
)
5494 def Append(*args
, **kwargs
):
5495 """Append(self, String name, int red, int green, int blue)"""
5496 return _gdi_
.ColourDatabase_Append(*args
, **kwargs
)
5498 _gdi_
.ColourDatabase_swigregister(ColourDatabase
)
5500 #---------------------------------------------------------------------------
5503 def _wxPyInitTheFontList(*args
):
5504 """_wxPyInitTheFontList() -> FontList"""
5505 return _gdi_
._wxPyInitTheFontList
(*args
)
5507 def _wxPyInitThePenList(*args
):
5508 """_wxPyInitThePenList() -> PenList"""
5509 return _gdi_
._wxPyInitThePenList
(*args
)
5511 def _wxPyInitTheBrushList(*args
):
5512 """_wxPyInitTheBrushList() -> BrushList"""
5513 return _gdi_
._wxPyInitTheBrushList
(*args
)
5515 def _wxPyInitTheColourDatabase(*args
):
5516 """_wxPyInitTheColourDatabase() -> ColourDatabase"""
5517 return _gdi_
._wxPyInitTheColourDatabase
(*args
)
5518 # Create an uninitialized instance for the stock objects, they will
5519 # be initialized later when the wx.App object is created.
5520 TheFontList
= FontList
.__new
__(FontList
)
5521 ThePenList
= PenList
.__new
__(PenList
)
5522 TheBrushList
= BrushList
.__new
__(BrushList
)
5523 TheColourDatabase
= ColourDatabase
.__new
__(ColourDatabase
)
5525 NullColor
= NullColour
5526 #---------------------------------------------------------------------------
5528 class Effects(_core
.Object
):
5529 """Proxy of C++ Effects class"""
5530 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5531 __repr__
= _swig_repr
5532 def __init__(self
, *args
, **kwargs
):
5533 """__init__(self) -> Effects"""
5534 _gdi_
.Effects_swiginit(self
,_gdi_
.new_Effects(*args
, **kwargs
))
5535 def GetHighlightColour(*args
, **kwargs
):
5536 """GetHighlightColour(self) -> Colour"""
5537 return _gdi_
.Effects_GetHighlightColour(*args
, **kwargs
)
5539 def GetLightShadow(*args
, **kwargs
):
5540 """GetLightShadow(self) -> Colour"""
5541 return _gdi_
.Effects_GetLightShadow(*args
, **kwargs
)
5543 def GetFaceColour(*args
, **kwargs
):
5544 """GetFaceColour(self) -> Colour"""
5545 return _gdi_
.Effects_GetFaceColour(*args
, **kwargs
)
5547 def GetMediumShadow(*args
, **kwargs
):
5548 """GetMediumShadow(self) -> Colour"""
5549 return _gdi_
.Effects_GetMediumShadow(*args
, **kwargs
)
5551 def GetDarkShadow(*args
, **kwargs
):
5552 """GetDarkShadow(self) -> Colour"""
5553 return _gdi_
.Effects_GetDarkShadow(*args
, **kwargs
)
5555 def SetHighlightColour(*args
, **kwargs
):
5556 """SetHighlightColour(self, Colour c)"""
5557 return _gdi_
.Effects_SetHighlightColour(*args
, **kwargs
)
5559 def SetLightShadow(*args
, **kwargs
):
5560 """SetLightShadow(self, Colour c)"""
5561 return _gdi_
.Effects_SetLightShadow(*args
, **kwargs
)
5563 def SetFaceColour(*args
, **kwargs
):
5564 """SetFaceColour(self, Colour c)"""
5565 return _gdi_
.Effects_SetFaceColour(*args
, **kwargs
)
5567 def SetMediumShadow(*args
, **kwargs
):
5568 """SetMediumShadow(self, Colour c)"""
5569 return _gdi_
.Effects_SetMediumShadow(*args
, **kwargs
)
5571 def SetDarkShadow(*args
, **kwargs
):
5572 """SetDarkShadow(self, Colour c)"""
5573 return _gdi_
.Effects_SetDarkShadow(*args
, **kwargs
)
5575 def Set(*args
, **kwargs
):
5577 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
5578 Colour mediumShadow, Colour darkShadow)
5580 return _gdi_
.Effects_Set(*args
, **kwargs
)
5582 def DrawSunkenEdge(*args
, **kwargs
):
5583 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
5584 return _gdi_
.Effects_DrawSunkenEdge(*args
, **kwargs
)
5586 def TileBitmap(*args
, **kwargs
):
5587 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
5588 return _gdi_
.Effects_TileBitmap(*args
, **kwargs
)
5590 DarkShadow
= property(GetDarkShadow
,SetDarkShadow
,doc
="See `GetDarkShadow` and `SetDarkShadow`")
5591 FaceColour
= property(GetFaceColour
,SetFaceColour
,doc
="See `GetFaceColour` and `SetFaceColour`")
5592 HighlightColour
= property(GetHighlightColour
,SetHighlightColour
,doc
="See `GetHighlightColour` and `SetHighlightColour`")
5593 LightShadow
= property(GetLightShadow
,SetLightShadow
,doc
="See `GetLightShadow` and `SetLightShadow`")
5594 MediumShadow
= property(GetMediumShadow
,SetMediumShadow
,doc
="See `GetMediumShadow` and `SetMediumShadow`")
5595 _gdi_
.Effects_swigregister(Effects
)
5597 #---------------------------------------------------------------------------
5599 CONTROL_DISABLED
= _gdi_
.CONTROL_DISABLED
5600 CONTROL_FOCUSED
= _gdi_
.CONTROL_FOCUSED
5601 CONTROL_PRESSED
= _gdi_
.CONTROL_PRESSED
5602 CONTROL_SPECIAL
= _gdi_
.CONTROL_SPECIAL
5603 CONTROL_ISDEFAULT
= _gdi_
.CONTROL_ISDEFAULT
5604 CONTROL_ISSUBMENU
= _gdi_
.CONTROL_ISSUBMENU
5605 CONTROL_EXPANDED
= _gdi_
.CONTROL_EXPANDED
5606 CONTROL_SIZEGRIP
= _gdi_
.CONTROL_SIZEGRIP
5607 CONTROL_CURRENT
= _gdi_
.CONTROL_CURRENT
5608 CONTROL_SELECTED
= _gdi_
.CONTROL_SELECTED
5609 CONTROL_CHECKED
= _gdi_
.CONTROL_CHECKED
5610 CONTROL_CHECKABLE
= _gdi_
.CONTROL_CHECKABLE
5611 CONTROL_UNDETERMINED
= _gdi_
.CONTROL_UNDETERMINED
5612 CONTROL_FLAGS_MASK
= _gdi_
.CONTROL_FLAGS_MASK
5613 CONTROL_DIRTY
= _gdi_
.CONTROL_DIRTY
5614 class SplitterRenderParams(object):
5616 This is just a simple struct used as a return value of
5617 `wx.RendererNative.GetSplitterParams` and contains some platform
5618 specific metrics about splitters.
5620 * widthSash: the width of the splitter sash.
5621 * border: the width of the border of the splitter window.
5622 * isHotSensitive: ``True`` if the splitter changes its
5623 appearance when the mouse is over it.
5627 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5628 __repr__
= _swig_repr
5629 def __init__(self
, *args
, **kwargs
):
5631 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5633 This is just a simple struct used as a return value of
5634 `wx.RendererNative.GetSplitterParams` and contains some platform
5635 specific metrics about splitters.
5637 * widthSash: the width of the splitter sash.
5638 * border: the width of the border of the splitter window.
5639 * isHotSensitive: ``True`` if the splitter changes its
5640 appearance when the mouse is over it.
5644 _gdi_
.SplitterRenderParams_swiginit(self
,_gdi_
.new_SplitterRenderParams(*args
, **kwargs
))
5645 __swig_destroy__
= _gdi_
.delete_SplitterRenderParams
5646 __del__
= lambda self
: None;
5647 widthSash
= property(_gdi_
.SplitterRenderParams_widthSash_get
)
5648 border
= property(_gdi_
.SplitterRenderParams_border_get
)
5649 isHotSensitive
= property(_gdi_
.SplitterRenderParams_isHotSensitive_get
)
5650 _gdi_
.SplitterRenderParams_swigregister(SplitterRenderParams
)
5652 class HeaderButtonParams(object):
5653 """Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`"""
5654 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5655 __repr__
= _swig_repr
5656 def __init__(self
, *args
, **kwargs
):
5658 __init__(self) -> HeaderButtonParams
5660 Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`
5662 _gdi_
.HeaderButtonParams_swiginit(self
,_gdi_
.new_HeaderButtonParams(*args
, **kwargs
))
5663 __swig_destroy__
= _gdi_
.delete_HeaderButtonParams
5664 __del__
= lambda self
: None;
5665 m_arrowColour
= property(_gdi_
.HeaderButtonParams_m_arrowColour_get
, _gdi_
.HeaderButtonParams_m_arrowColour_set
)
5666 m_selectionColour
= property(_gdi_
.HeaderButtonParams_m_selectionColour_get
, _gdi_
.HeaderButtonParams_m_selectionColour_set
)
5667 m_labelText
= property(_gdi_
.HeaderButtonParams_m_labelText_get
, _gdi_
.HeaderButtonParams_m_labelText_set
)
5668 m_labelFont
= property(_gdi_
.HeaderButtonParams_m_labelFont_get
, _gdi_
.HeaderButtonParams_m_labelFont_set
)
5669 m_labelColour
= property(_gdi_
.HeaderButtonParams_m_labelColour_get
, _gdi_
.HeaderButtonParams_m_labelColour_set
)
5670 m_labelBitmap
= property(_gdi_
.HeaderButtonParams_m_labelBitmap_get
, _gdi_
.HeaderButtonParams_m_labelBitmap_set
)
5671 m_labelAlignment
= property(_gdi_
.HeaderButtonParams_m_labelAlignment_get
, _gdi_
.HeaderButtonParams_m_labelAlignment_set
)
5672 _gdi_
.HeaderButtonParams_swigregister(HeaderButtonParams
)
5674 HDR_SORT_ICON_NONE
= _gdi_
.HDR_SORT_ICON_NONE
5675 HDR_SORT_ICON_UP
= _gdi_
.HDR_SORT_ICON_UP
5676 HDR_SORT_ICON_DOWN
= _gdi_
.HDR_SORT_ICON_DOWN
5677 class RendererVersion(object):
5679 This simple struct represents the `wx.RendererNative` interface
5680 version and is only used as the return value of
5681 `wx.RendererNative.GetVersion`.
5683 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5684 __repr__
= _swig_repr
5685 def __init__(self
, *args
, **kwargs
):
5687 __init__(self, int version_, int age_) -> RendererVersion
5689 This simple struct represents the `wx.RendererNative` interface
5690 version and is only used as the return value of
5691 `wx.RendererNative.GetVersion`.
5693 _gdi_
.RendererVersion_swiginit(self
,_gdi_
.new_RendererVersion(*args
, **kwargs
))
5694 __swig_destroy__
= _gdi_
.delete_RendererVersion
5695 __del__
= lambda self
: None;
5696 Current_Version
= _gdi_
.RendererVersion_Current_Version
5697 Current_Age
= _gdi_
.RendererVersion_Current_Age
5698 def IsCompatible(*args
, **kwargs
):
5699 """IsCompatible(RendererVersion ver) -> bool"""
5700 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
5702 IsCompatible
= staticmethod(IsCompatible
)
5703 version
= property(_gdi_
.RendererVersion_version_get
)
5704 age
= property(_gdi_
.RendererVersion_age_get
)
5705 _gdi_
.RendererVersion_swigregister(RendererVersion
)
5707 def RendererVersion_IsCompatible(*args
, **kwargs
):
5708 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5709 return _gdi_
.RendererVersion_IsCompatible(*args
, **kwargs
)
5711 class RendererNative(object):
5713 One of the design principles of wxWidgets is to use the native
5714 widgets on every platform in order to be as close as possible to
5715 the native look and feel on every platform. However there are
5716 still cases when some generic widgets are needed for various
5717 reasons, but it can sometimes take a lot of messy work to make
5718 them conform to the native LnF.
5720 The wx.RendererNative class is a collection of functions that have
5721 platform-specific implementations for drawing certain parts of
5722 genereic controls in ways that are as close to the native look as
5725 Note that each drawing function restores the `wx.DC` attributes if it
5726 changes them, so it is safe to assume that the same pen, brush and
5727 colours that were active before the call to this function are still in
5731 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5732 def __init__(self
): raise AttributeError, "No constructor defined"
5733 __repr__
= _swig_repr
5734 def DrawHeaderButton(*args
, **kwargs
):
5736 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE,
5737 HeaderButtonParams params=None)
5739 Draw the header control button (such as what is used by `wx.ListCtrl`
5742 return _gdi_
.RendererNative_DrawHeaderButton(*args
, **kwargs
)
5744 def DrawHeaderButtonContents(*args
, **kwargs
):
5746 DrawHeaderButtonContents(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE,
5747 HeaderButtonParams params=None)
5749 Draw the contents of a header control button, (label, sort
5750 arrows, etc.) Normally this is only called by `DrawHeaderButton`.
5752 return _gdi_
.RendererNative_DrawHeaderButtonContents(*args
, **kwargs
)
5754 def GetHeaderButtonHeight(*args
, **kwargs
):
5756 GetHeaderButtonHeight(self, Window win) -> int
5758 Returns the default height of a header button, either a fixed platform
5759 height if available, or a generic height based on the window's font.
5761 return _gdi_
.RendererNative_GetHeaderButtonHeight(*args
, **kwargs
)
5763 def DrawTreeItemButton(*args
, **kwargs
):
5765 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5767 Draw the expanded/collapsed icon for a tree control item.
5769 return _gdi_
.RendererNative_DrawTreeItemButton(*args
, **kwargs
)
5771 def DrawSplitterBorder(*args
, **kwargs
):
5773 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5775 Draw the border for a sash window: this border must be such that the
5776 sash drawn by `DrawSplitterSash` blends into it well.
5778 return _gdi_
.RendererNative_DrawSplitterBorder(*args
, **kwargs
)
5780 def DrawSplitterSash(*args
, **kwargs
):
5782 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5785 Draw a sash. The orient parameter defines whether the sash should be
5786 vertical or horizontal and how the position should be interpreted.
5788 return _gdi_
.RendererNative_DrawSplitterSash(*args
, **kwargs
)
5790 def DrawComboBoxDropButton(*args
, **kwargs
):
5792 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5794 Draw a button like the one used by `wx.ComboBox` to show a drop down
5795 window. The usual appearance is a downwards pointing arrow.
5797 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5798 ``wx.CONTROL_CURRENT`` bits set.
5800 return _gdi_
.RendererNative_DrawComboBoxDropButton(*args
, **kwargs
)
5802 def DrawDropArrow(*args
, **kwargs
):
5804 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5806 Draw a drop down arrow that is suitable for use outside a combo
5807 box. Arrow will have a transparent background.
5809 ``rect`` is not entirely filled by the arrow. Instead, you should use
5810 bounding rectangle of a drop down button which arrow matches the size
5811 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5812 ``wx.CONTROL_CURRENT`` bit set.
5814 return _gdi_
.RendererNative_DrawDropArrow(*args
, **kwargs
)
5816 def DrawCheckBox(*args
, **kwargs
):
5818 DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0)
5820 Draw a check button. Flags may use wx.CONTROL_CHECKED,
5821 wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.
5823 return _gdi_
.RendererNative_DrawCheckBox(*args
, **kwargs
)
5825 def DrawPushButton(*args
, **kwargs
):
5827 DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0)
5829 Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
5830 wx.CONTROL_ISDEFAULT
5832 return _gdi_
.RendererNative_DrawPushButton(*args
, **kwargs
)
5834 def DrawItemSelectionRect(*args
, **kwargs
):
5836 DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0)
5838 Draw rectangle indicating that an item in e.g. a list control has been
5841 The flags parameter may be:
5843 ==================== ============================================
5844 wx.CONTROL_SELECTED item is selected, e.g. draw background
5845 wx.CONTROL_CURRENT item is the current item, e.g. dotted border
5846 wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
5847 background vs. grey otherwise
5848 ==================== ============================================
5851 return _gdi_
.RendererNative_DrawItemSelectionRect(*args
, **kwargs
)
5853 def GetSplitterParams(*args
, **kwargs
):
5855 GetSplitterParams(self, Window win) -> SplitterRenderParams
5857 Get the splitter parameters, see `wx.SplitterRenderParams`.
5859 return _gdi_
.RendererNative_GetSplitterParams(*args
, **kwargs
)
5861 def Get(*args
, **kwargs
):
5863 Get() -> RendererNative
5865 Return the currently used renderer
5867 return _gdi_
.RendererNative_Get(*args
, **kwargs
)
5869 Get
= staticmethod(Get
)
5870 def GetGeneric(*args
, **kwargs
):
5872 GetGeneric() -> RendererNative
5874 Return the generic implementation of the renderer. Under some
5875 platforms, this is the default renderer implementation, others have
5876 platform-specific default renderer which can be retrieved by calling
5877 `wx.RendererNative.GetDefault`.
5879 return _gdi_
.RendererNative_GetGeneric(*args
, **kwargs
)
5881 GetGeneric
= staticmethod(GetGeneric
)
5882 def GetDefault(*args
, **kwargs
):
5884 GetDefault() -> RendererNative
5886 Return the default (native) implementation for this platform -- this
5887 is also the one used by default but this may be changed by calling
5888 `wx.RendererNative.Set` in which case the return value of this method
5889 may be different from the return value of `wx.RendererNative.Get`.
5891 return _gdi_
.RendererNative_GetDefault(*args
, **kwargs
)
5893 GetDefault
= staticmethod(GetDefault
)
5894 def Set(*args
, **kwargs
):
5896 Set(RendererNative renderer) -> RendererNative
5898 Set the renderer to use, passing None reverts to using the default
5899 renderer. Returns the previous renderer used with Set or None.
5901 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
5903 Set
= staticmethod(Set
)
5904 def GetVersion(*args
, **kwargs
):
5906 GetVersion(self) -> RendererVersion
5908 Returns the version of the renderer. Will be used for ensuring
5909 compatibility of dynamically loaded renderers.
5911 return _gdi_
.RendererNative_GetVersion(*args
, **kwargs
)
5913 SplitterParams
= property(GetSplitterParams
,doc
="See `GetSplitterParams`")
5914 Version
= property(GetVersion
,doc
="See `GetVersion`")
5915 _gdi_
.RendererNative_swigregister(RendererNative
)
5917 def RendererNative_Get(*args
):
5919 RendererNative_Get() -> RendererNative
5921 Return the currently used renderer
5923 return _gdi_
.RendererNative_Get(*args
)
5925 def RendererNative_GetGeneric(*args
):
5927 RendererNative_GetGeneric() -> RendererNative
5929 Return the generic implementation of the renderer. Under some
5930 platforms, this is the default renderer implementation, others have
5931 platform-specific default renderer which can be retrieved by calling
5932 `wx.RendererNative.GetDefault`.
5934 return _gdi_
.RendererNative_GetGeneric(*args
)
5936 def RendererNative_GetDefault(*args
):
5938 RendererNative_GetDefault() -> RendererNative
5940 Return the default (native) implementation for this platform -- this
5941 is also the one used by default but this may be changed by calling
5942 `wx.RendererNative.Set` in which case the return value of this method
5943 may be different from the return value of `wx.RendererNative.Get`.
5945 return _gdi_
.RendererNative_GetDefault(*args
)
5947 def RendererNative_Set(*args
, **kwargs
):
5949 RendererNative_Set(RendererNative renderer) -> RendererNative
5951 Set the renderer to use, passing None reverts to using the default
5952 renderer. Returns the previous renderer used with Set or None.
5954 return _gdi_
.RendererNative_Set(*args
, **kwargs
)
5956 #---------------------------------------------------------------------------
5958 class PseudoDC(_core
.Object
):
5960 A PseudoDC is an object that can be used as if it were a `wx.DC`. All
5961 commands issued to the PseudoDC are stored in a list. You can then
5962 play these commands back to a real DC object using the DrawToDC
5963 method. Commands in the command list are indexed by ID. You can use
5964 this to clear the operations associated with a single ID and then
5965 re-draw the object associated with that ID.
5967 thisown
= property(lambda x
: x
.this
.own(), lambda x
, v
: x
.this
.own(v
), doc
='The membership flag')
5968 __repr__
= _swig_repr
5969 def __init__(self
, *args
, **kwargs
):
5971 __init__(self) -> PseudoDC
5973 Constructs a new Pseudo device context for recording dc operations
5975 _gdi_
.PseudoDC_swiginit(self
,_gdi_
.new_PseudoDC(*args
, **kwargs
))
5976 def BeginDrawing(*args
, **kwargs
):
5980 Allows for optimization of drawing code on platforms that need it. On
5981 other platforms this is just an empty function and is harmless. To
5982 take advantage of this postential optimization simply enclose each
5983 group of calls to the drawing primitives within calls to
5984 `BeginDrawing` and `EndDrawing`.
5986 return _gdi_
.PseudoDC_BeginDrawing(*args
, **kwargs
)
5988 def EndDrawing(*args
, **kwargs
):
5992 Ends the group of drawing primitives started with `BeginDrawing`, and
5993 invokes whatever optimization is available for this DC type on the
5996 return _gdi_
.PseudoDC_EndDrawing(*args
, **kwargs
)
5998 __swig_destroy__
= _gdi_
.delete_PseudoDC
5999 __del__
= lambda self
: None;
6000 def RemoveAll(*args
, **kwargs
):
6004 Removes all objects and operations from the recorded list.
6006 return _gdi_
.PseudoDC_RemoveAll(*args
, **kwargs
)
6008 def GetLen(*args
, **kwargs
):
6012 Returns the number of operations in the recorded list.
6014 return _gdi_
.PseudoDC_GetLen(*args
, **kwargs
)
6016 def SetId(*args
, **kwargs
):
6020 Sets the id to be associated with subsequent operations.
6022 return _gdi_
.PseudoDC_SetId(*args
, **kwargs
)
6024 def ClearId(*args
, **kwargs
):
6026 ClearId(self, int id)
6028 Removes all operations associated with id so the object can be redrawn.
6030 return _gdi_
.PseudoDC_ClearId(*args
, **kwargs
)
6032 def RemoveId(*args
, **kwargs
):
6034 RemoveId(self, int id)
6036 Remove the object node (and all operations) associated with an id.
6038 return _gdi_
.PseudoDC_RemoveId(*args
, **kwargs
)
6040 def TranslateId(*args
, **kwargs
):
6042 TranslateId(self, int id, int dx, int dy)
6044 Translate the operations of id by dx,dy.
6046 return _gdi_
.PseudoDC_TranslateId(*args
, **kwargs
)
6048 def SetIdGreyedOut(*args
, **kwargs
):
6050 SetIdGreyedOut(self, int id, bool greyout=True)
6052 Set whether an object is drawn greyed out or not.
6054 return _gdi_
.PseudoDC_SetIdGreyedOut(*args
, **kwargs
)
6056 def GetIdGreyedOut(*args
, **kwargs
):
6058 GetIdGreyedOut(self, int id) -> bool
6060 Get whether an object is drawn greyed out or not.
6062 return _gdi_
.PseudoDC_GetIdGreyedOut(*args
, **kwargs
)
6064 def FindObjects(*args
, **kwargs
):
6066 FindObjects(self, int x, int y, int radius=1, wxColor bg=*wxWHITE) -> PyObject
6068 Returns a list of all the id's that draw a pixel with color
6069 not equal to bg within radius of (x,y).
6070 Returns an empty list if nothing is found. The list is in
6071 reverse drawing order so list[0] is the top id.
6073 return _gdi_
.PseudoDC_FindObjects(*args
, **kwargs
)
6075 def FindObjectsByBBox(*args
, **kwargs
):
6077 FindObjectsByBBox(self, int x, int y) -> PyObject
6079 Returns a list of all the id's whose bounding boxes include (x,y).
6080 Returns an empty list if nothing is found. The list is in
6081 reverse drawing order so list[0] is the top id.
6083 return _gdi_
.PseudoDC_FindObjectsByBBox(*args
, **kwargs
)
6085 def DrawIdToDC(*args
, **kwargs
):
6087 DrawIdToDC(self, int id, DC dc)
6089 Draw recorded operations of id to dc.
6091 return _gdi_
.PseudoDC_DrawIdToDC(*args
, **kwargs
)
6093 def SetIdBounds(*args
, **kwargs
):
6095 SetIdBounds(self, int id, Rect rect)
6097 Set the bounding rect of a given object. This will create
6098 an object node if one doesn't exist.
6100 return _gdi_
.PseudoDC_SetIdBounds(*args
, **kwargs
)
6102 def GetIdBounds(*args
, **kwargs
):
6104 GetIdBounds(self, int id) -> Rect
6106 Returns the bounding rectangle previouly set with SetIdBounds. If
6107 no bounds have been set, it returns wx.Rect(0,0,0,0).
6109 return _gdi_
.PseudoDC_GetIdBounds(*args
, **kwargs
)
6111 def DrawToDCClipped(*args
, **kwargs
):
6113 DrawToDCClipped(self, DC dc, Rect rect)
6115 Draws the recorded operations to dc unless the operation is known to
6118 return _gdi_
.PseudoDC_DrawToDCClipped(*args
, **kwargs
)
6120 def DrawToDCClippedRgn(*args
, **kwargs
):
6122 DrawToDCClippedRgn(self, DC dc, Region region)
6124 Draws the recorded operations to dc unless the operation is known to
6127 return _gdi_
.PseudoDC_DrawToDCClippedRgn(*args
, **kwargs
)
6129 def DrawToDC(*args
, **kwargs
):
6131 DrawToDC(self, DC dc)
6133 Draws the recorded operations to dc.
6135 return _gdi_
.PseudoDC_DrawToDC(*args
, **kwargs
)
6137 def FloodFill(*args
, **kwargs
):
6139 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE)
6141 Flood fills the device context starting from the given point, using
6142 the current brush colour, and using a style:
6144 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
6145 the given colour is encountered.
6147 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
6150 Returns False if the operation failed.
6152 Note: The present implementation for non-Windows platforms may fail to
6153 find colour borders if the pixels do not match the colour
6154 exactly. However the function will still return true.
6156 return _gdi_
.PseudoDC_FloodFill(*args
, **kwargs
)
6158 def FloodFillPoint(*args
, **kwargs
):
6160 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE)
6162 Flood fills the device context starting from the given point, using
6163 the current brush colour, and using a style:
6165 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
6166 the given colour is encountered.
6168 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
6171 Returns False if the operation failed.
6173 Note: The present implementation for non-Windows platforms may fail to
6174 find colour borders if the pixels do not match the colour
6175 exactly. However the function will still return true.
6177 return _gdi_
.PseudoDC_FloodFillPoint(*args
, **kwargs
)
6179 def DrawLine(*args
, **kwargs
):
6181 DrawLine(self, int x1, int y1, int x2, int y2)
6183 Draws a line from the first point to the second. The current pen is
6184 used for drawing the line. Note that the second point is *not* part of
6185 the line and is not drawn by this function (this is consistent with
6186 the behaviour of many other toolkits).
6188 return _gdi_
.PseudoDC_DrawLine(*args
, **kwargs
)
6190 def DrawLinePoint(*args
, **kwargs
):
6192 DrawLinePoint(self, Point pt1, Point pt2)
6194 Draws a line from the first point to the second. The current pen is
6195 used for drawing the line. Note that the second point is *not* part of
6196 the line and is not drawn by this function (this is consistent with
6197 the behaviour of many other toolkits).
6199 return _gdi_
.PseudoDC_DrawLinePoint(*args
, **kwargs
)
6201 def CrossHair(*args
, **kwargs
):
6203 CrossHair(self, int x, int y)
6205 Displays a cross hair using the current pen. This is a vertical and
6206 horizontal line the height and width of the window, centred on the
6209 return _gdi_
.PseudoDC_CrossHair(*args
, **kwargs
)
6211 def CrossHairPoint(*args
, **kwargs
):
6213 CrossHairPoint(self, Point pt)
6215 Displays a cross hair using the current pen. This is a vertical and
6216 horizontal line the height and width of the window, centred on the
6219 return _gdi_
.PseudoDC_CrossHairPoint(*args
, **kwargs
)
6221 def DrawArc(*args
, **kwargs
):
6223 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
6225 Draws an arc of a circle, centred on the *center* point (xc, yc), from
6226 the first point to the second. The current pen is used for the outline
6227 and the current brush for filling the shape.
6229 The arc is drawn in an anticlockwise direction from the start point to
6232 return _gdi_
.PseudoDC_DrawArc(*args
, **kwargs
)
6234 def DrawArcPoint(*args
, **kwargs
):
6236 DrawArcPoint(self, Point pt1, Point pt2, Point center)
6238 Draws an arc of a circle, centred on the *center* point (xc, yc), from
6239 the first point to the second. The current pen is used for the outline
6240 and the current brush for filling the shape.
6242 The arc is drawn in an anticlockwise direction from the start point to
6245 return _gdi_
.PseudoDC_DrawArcPoint(*args
, **kwargs
)
6247 def DrawCheckMark(*args
, **kwargs
):
6249 DrawCheckMark(self, int x, int y, int width, int height)
6251 Draws a check mark inside the given rectangle.
6253 return _gdi_
.PseudoDC_DrawCheckMark(*args
, **kwargs
)
6255 def DrawCheckMarkRect(*args
, **kwargs
):
6257 DrawCheckMarkRect(self, Rect rect)
6259 Draws a check mark inside the given rectangle.
6261 return _gdi_
.PseudoDC_DrawCheckMarkRect(*args
, **kwargs
)
6263 def DrawEllipticArc(*args
, **kwargs
):
6265 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
6267 Draws an arc of an ellipse, with the given rectangle defining the
6268 bounds of the ellipse. The current pen is used for drawing the arc and
6269 the current brush is used for drawing the pie.
6271 The *start* and *end* parameters specify the start and end of the arc
6272 relative to the three-o'clock position from the center of the
6273 rectangle. Angles are specified in degrees (360 is a complete
6274 circle). Positive values mean counter-clockwise motion. If start is
6275 equal to end, a complete ellipse will be drawn.
6277 return _gdi_
.PseudoDC_DrawEllipticArc(*args
, **kwargs
)
6279 def DrawEllipticArcPointSize(*args
, **kwargs
):
6281 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
6283 Draws an arc of an ellipse, with the given rectangle defining the
6284 bounds of the ellipse. The current pen is used for drawing the arc and
6285 the current brush is used for drawing the pie.
6287 The *start* and *end* parameters specify the start and end of the arc
6288 relative to the three-o'clock position from the center of the
6289 rectangle. Angles are specified in degrees (360 is a complete
6290 circle). Positive values mean counter-clockwise motion. If start is
6291 equal to end, a complete ellipse will be drawn.
6293 return _gdi_
.PseudoDC_DrawEllipticArcPointSize(*args
, **kwargs
)
6295 def DrawPoint(*args
, **kwargs
):
6297 DrawPoint(self, int x, int y)
6299 Draws a point using the current pen.
6301 return _gdi_
.PseudoDC_DrawPoint(*args
, **kwargs
)
6303 def DrawPointPoint(*args
, **kwargs
):
6305 DrawPointPoint(self, Point pt)
6307 Draws a point using the current pen.
6309 return _gdi_
.PseudoDC_DrawPointPoint(*args
, **kwargs
)
6311 def DrawRectangle(*args
, **kwargs
):
6313 DrawRectangle(self, int x, int y, int width, int height)
6315 Draws a rectangle with the given top left corner, and with the given
6316 size. The current pen is used for the outline and the current brush
6317 for filling the shape.
6319 return _gdi_
.PseudoDC_DrawRectangle(*args
, **kwargs
)
6321 def DrawRectangleRect(*args
, **kwargs
):
6323 DrawRectangleRect(self, Rect rect)
6325 Draws a rectangle with the given top left corner, and with the given
6326 size. The current pen is used for the outline and the current brush
6327 for filling the shape.
6329 return _gdi_
.PseudoDC_DrawRectangleRect(*args
, **kwargs
)
6331 def DrawRectanglePointSize(*args
, **kwargs
):
6333 DrawRectanglePointSize(self, Point pt, Size sz)
6335 Draws a rectangle with the given top left corner, and with the given
6336 size. The current pen is used for the outline and the current brush
6337 for filling the shape.
6339 return _gdi_
.PseudoDC_DrawRectanglePointSize(*args
, **kwargs
)
6341 def DrawRoundedRectangle(*args
, **kwargs
):
6343 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
6345 Draws a rectangle with the given top left corner, and with the given
6346 size. The corners are quarter-circles using the given radius. The
6347 current pen is used for the outline and the current brush for filling
6350 If radius is positive, the value is assumed to be the radius of the
6351 rounded corner. If radius is negative, the absolute value is assumed
6352 to be the proportion of the smallest dimension of the rectangle. This
6353 means that the corner can be a sensible size relative to the size of
6354 the rectangle, and also avoids the strange effects X produces when the
6355 corners are too big for the rectangle.
6357 return _gdi_
.PseudoDC_DrawRoundedRectangle(*args
, **kwargs
)
6359 def DrawRoundedRectangleRect(*args
, **kwargs
):
6361 DrawRoundedRectangleRect(self, Rect r, double radius)
6363 Draws a rectangle with the given top left corner, and with the given
6364 size. The corners are quarter-circles using the given radius. The
6365 current pen is used for the outline and the current brush for filling
6368 If radius is positive, the value is assumed to be the radius of the
6369 rounded corner. If radius is negative, the absolute value is assumed
6370 to be the proportion of the smallest dimension of the rectangle. This
6371 means that the corner can be a sensible size relative to the size of
6372 the rectangle, and also avoids the strange effects X produces when the
6373 corners are too big for the rectangle.
6375 return _gdi_
.PseudoDC_DrawRoundedRectangleRect(*args
, **kwargs
)
6377 def DrawRoundedRectanglePointSize(*args
, **kwargs
):
6379 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
6381 Draws a rectangle with the given top left corner, and with the given
6382 size. The corners are quarter-circles using the given radius. The
6383 current pen is used for the outline and the current brush for filling
6386 If radius is positive, the value is assumed to be the radius of the
6387 rounded corner. If radius is negative, the absolute value is assumed
6388 to be the proportion of the smallest dimension of the rectangle. This
6389 means that the corner can be a sensible size relative to the size of
6390 the rectangle, and also avoids the strange effects X produces when the
6391 corners are too big for the rectangle.
6393 return _gdi_
.PseudoDC_DrawRoundedRectanglePointSize(*args
, **kwargs
)
6395 def DrawCircle(*args
, **kwargs
):
6397 DrawCircle(self, int x, int y, int radius)
6399 Draws a circle with the given center point and radius. The current
6400 pen is used for the outline and the current brush for filling the
6403 return _gdi_
.PseudoDC_DrawCircle(*args
, **kwargs
)
6405 def DrawCirclePoint(*args
, **kwargs
):
6407 DrawCirclePoint(self, Point pt, int radius)
6409 Draws a circle with the given center point and radius. The current
6410 pen is used for the outline and the current brush for filling the
6413 return _gdi_
.PseudoDC_DrawCirclePoint(*args
, **kwargs
)
6415 def DrawEllipse(*args
, **kwargs
):
6417 DrawEllipse(self, int x, int y, int width, int height)
6419 Draws an ellipse contained in the specified rectangle. The current pen
6420 is used for the outline and the current brush for filling the shape.
6422 return _gdi_
.PseudoDC_DrawEllipse(*args
, **kwargs
)
6424 def DrawEllipseRect(*args
, **kwargs
):
6426 DrawEllipseRect(self, Rect rect)
6428 Draws an ellipse contained in the specified rectangle. The current pen
6429 is used for the outline and the current brush for filling the shape.
6431 return _gdi_
.PseudoDC_DrawEllipseRect(*args
, **kwargs
)
6433 def DrawEllipsePointSize(*args
, **kwargs
):
6435 DrawEllipsePointSize(self, Point pt, Size sz)
6437 Draws an ellipse contained in the specified rectangle. The current pen
6438 is used for the outline and the current brush for filling the shape.
6440 return _gdi_
.PseudoDC_DrawEllipsePointSize(*args
, **kwargs
)
6442 def DrawIcon(*args
, **kwargs
):
6444 DrawIcon(self, Icon icon, int x, int y)
6446 Draw an icon on the display (does nothing if the device context is
6447 PostScript). This can be the simplest way of drawing bitmaps on a
6450 return _gdi_
.PseudoDC_DrawIcon(*args
, **kwargs
)
6452 def DrawIconPoint(*args
, **kwargs
):
6454 DrawIconPoint(self, Icon icon, Point pt)
6456 Draw an icon on the display (does nothing if the device context is
6457 PostScript). This can be the simplest way of drawing bitmaps on a
6460 return _gdi_
.PseudoDC_DrawIconPoint(*args
, **kwargs
)
6462 def DrawBitmap(*args
, **kwargs
):
6464 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
6466 Draw a bitmap on the device context at the specified point. If
6467 *transparent* is true and the bitmap has a transparency mask, (or
6468 alpha channel on the platforms that support it) then the bitmap will
6469 be drawn transparently.
6471 return _gdi_
.PseudoDC_DrawBitmap(*args
, **kwargs
)
6473 def DrawBitmapPoint(*args
, **kwargs
):
6475 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
6477 Draw a bitmap on the device context at the specified point. If
6478 *transparent* is true and the bitmap has a transparency mask, (or
6479 alpha channel on the platforms that support it) then the bitmap will
6480 be drawn transparently.
6482 return _gdi_
.PseudoDC_DrawBitmapPoint(*args
, **kwargs
)
6484 def DrawText(*args
, **kwargs
):
6486 DrawText(self, String text, int x, int y)
6488 Draws a text string at the specified point, using the current text
6489 font, and the current text foreground and background colours.
6491 The coordinates refer to the top-left corner of the rectangle bounding
6492 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6493 a text string, which can be used to position the text more precisely,
6494 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6497 **NOTE**: under wxGTK the current logical function is used by this
6498 function but it is ignored by wxMSW. Thus, you should avoid using
6499 logical functions with this function in portable programs.
6501 return _gdi_
.PseudoDC_DrawText(*args
, **kwargs
)
6503 def DrawTextPoint(*args
, **kwargs
):
6505 DrawTextPoint(self, String text, Point pt)
6507 Draws a text string at the specified point, using the current text
6508 font, and the current text foreground and background colours.
6510 The coordinates refer to the top-left corner of the rectangle bounding
6511 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6512 a text string, which can be used to position the text more precisely,
6513 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6516 **NOTE**: under wxGTK the current logical function is used by this
6517 function but it is ignored by wxMSW. Thus, you should avoid using
6518 logical functions with this function in portable programs.
6520 return _gdi_
.PseudoDC_DrawTextPoint(*args
, **kwargs
)
6522 def DrawRotatedText(*args
, **kwargs
):
6524 DrawRotatedText(self, String text, int x, int y, double angle)
6526 Draws the text rotated by *angle* degrees, if supported by the platform.
6528 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6529 function. In particular, a font different from ``wx.NORMAL_FONT``
6530 should be used as the it is not normally a TrueType
6531 font. ``wx.SWISS_FONT`` is an example of a font which is.
6533 return _gdi_
.PseudoDC_DrawRotatedText(*args
, **kwargs
)
6535 def DrawRotatedTextPoint(*args
, **kwargs
):
6537 DrawRotatedTextPoint(self, String text, Point pt, double angle)
6539 Draws the text rotated by *angle* degrees, if supported by the platform.
6541 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6542 function. In particular, a font different from ``wx.NORMAL_FONT``
6543 should be used as the it is not normally a TrueType
6544 font. ``wx.SWISS_FONT`` is an example of a font which is.
6546 return _gdi_
.PseudoDC_DrawRotatedTextPoint(*args
, **kwargs
)
6548 def DrawLines(*args
, **kwargs
):
6550 DrawLines(self, List points, int xoffset=0, int yoffset=0)
6552 Draws lines using a sequence of `wx.Point` objects, adding the
6553 optional offset coordinate. The current pen is used for drawing the
6556 return _gdi_
.PseudoDC_DrawLines(*args
, **kwargs
)
6558 def DrawPolygon(*args
, **kwargs
):
6560 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
6561 int fillStyle=ODDEVEN_RULE)
6563 Draws a filled polygon using a sequence of `wx.Point` objects, adding
6564 the optional offset coordinate. The last argument specifies the fill
6565 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
6567 The current pen is used for drawing the outline, and the current brush
6568 for filling the shape. Using a transparent brush suppresses
6569 filling. Note that wxWidgets automatically closes the first and last
6572 return _gdi_
.PseudoDC_DrawPolygon(*args
, **kwargs
)
6574 def DrawLabel(*args
, **kwargs
):
6576 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6579 Draw *text* within the specified rectangle, abiding by the alignment
6580 flags. Will additionally emphasize the character at *indexAccel* if
6583 return _gdi_
.PseudoDC_DrawLabel(*args
, **kwargs
)
6585 def DrawImageLabel(*args
, **kwargs
):
6587 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6590 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
6591 drawing it) within the specified rectangle, abiding by the alignment
6592 flags. Will additionally emphasize the character at *indexAccel* if
6595 return _gdi_
.PseudoDC_DrawImageLabel(*args
, **kwargs
)
6597 def DrawSpline(*args
, **kwargs
):
6599 DrawSpline(self, List points)
6601 Draws a spline between all given control points, (a list of `wx.Point`
6602 objects) using the current pen. The spline is drawn using a series of
6603 lines, using an algorithm taken from the X drawing program 'XFIG'.
6605 return _gdi_
.PseudoDC_DrawSpline(*args
, **kwargs
)
6607 def Clear(*args
, **kwargs
):
6611 Clears the device context using the current background brush.
6613 return _gdi_
.PseudoDC_Clear(*args
, **kwargs
)
6615 def SetFont(*args
, **kwargs
):
6617 SetFont(self, Font font)
6619 Sets the current font for the DC. It must be a valid font, in
6620 particular you should not pass ``wx.NullFont`` to this method.
6622 return _gdi_
.PseudoDC_SetFont(*args
, **kwargs
)
6624 def SetPen(*args
, **kwargs
):
6626 SetPen(self, Pen pen)
6628 Sets the current pen for the DC.
6630 If the argument is ``wx.NullPen``, the current pen is selected out of the
6631 device context, and the original pen restored.
6633 return _gdi_
.PseudoDC_SetPen(*args
, **kwargs
)
6635 def SetBrush(*args
, **kwargs
):
6637 SetBrush(self, Brush brush)
6639 Sets the current brush for the DC.
6641 If the argument is ``wx.NullBrush``, the current brush is selected out
6642 of the device context, and the original brush restored, allowing the
6643 current brush to be destroyed safely.
6645 return _gdi_
.PseudoDC_SetBrush(*args
, **kwargs
)
6647 def SetBackground(*args
, **kwargs
):
6649 SetBackground(self, Brush brush)
6651 Sets the current background brush for the DC.
6653 return _gdi_
.PseudoDC_SetBackground(*args
, **kwargs
)
6655 def SetBackgroundMode(*args
, **kwargs
):
6657 SetBackgroundMode(self, int mode)
6659 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
6660 determines whether text will be drawn with a background colour or
6663 return _gdi_
.PseudoDC_SetBackgroundMode(*args
, **kwargs
)
6665 def SetPalette(*args
, **kwargs
):
6667 SetPalette(self, Palette palette)
6669 If this is a window DC or memory DC, assigns the given palette to the
6670 window or bitmap associated with the DC. If the argument is
6671 ``wx.NullPalette``, the current palette is selected out of the device
6672 context, and the original palette restored.
6674 return _gdi_
.PseudoDC_SetPalette(*args
, **kwargs
)
6676 def SetTextForeground(*args
, **kwargs
):
6678 SetTextForeground(self, Colour colour)
6680 Sets the current text foreground colour for the DC.
6682 return _gdi_
.PseudoDC_SetTextForeground(*args
, **kwargs
)
6684 def SetTextBackground(*args
, **kwargs
):
6686 SetTextBackground(self, Colour colour)
6688 Sets the current text background colour for the DC.
6690 return _gdi_
.PseudoDC_SetTextBackground(*args
, **kwargs
)
6692 def SetLogicalFunction(*args
, **kwargs
):
6694 SetLogicalFunction(self, int function)
6696 Sets the current logical function for the device context. This
6697 determines how a source pixel (from a pen or brush colour, combines
6698 with a destination pixel in the current device context.
6700 The possible values and their meaning in terms of source and
6701 destination pixel values are as follows:
6703 ================ ==========================
6705 wx.AND_INVERT (NOT src) AND dst
6706 wx.AND_REVERSE src AND (NOT dst)
6709 wx.EQUIV (NOT src) XOR dst
6711 wx.NAND (NOT src) OR (NOT dst)
6712 wx.NOR (NOT src) AND (NOT dst)
6715 wx.OR_INVERT (NOT src) OR dst
6716 wx.OR_REVERSE src OR (NOT dst)
6718 wx.SRC_INVERT NOT src
6720 ================ ==========================
6722 The default is wx.COPY, which simply draws with the current
6723 colour. The others combine the current colour and the background using
6724 a logical operation. wx.INVERT is commonly used for drawing rubber
6725 bands or moving outlines, since drawing twice reverts to the original
6729 return _gdi_
.PseudoDC_SetLogicalFunction(*args
, **kwargs
)
6731 IdBounds
= property(GetIdBounds
,SetIdBounds
,doc
="See `GetIdBounds` and `SetIdBounds`")
6732 Len
= property(GetLen
,doc
="See `GetLen`")
6733 _gdi_
.PseudoDC_swigregister(PseudoDC
)