]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/gtk/_gdi.py
reSWIGged
[wxWidgets.git] / wxPython / src / gtk / _gdi.py
1 # This file was created automatically by SWIG 1.3.29.
2 # Don't modify this file, modify the SWIG interface instead.
3
4 import _gdi_
5 import new
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)
9 if (name == "this"):
10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
12 return
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
17 else:
18 raise AttributeError("You cannot add attributes to %s" % self)
19
20 def _swig_setattr(self,class_type,name,value):
21 return _swig_setattr_nondynamic(self,class_type,name,value,0)
22
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
28
29 def _swig_repr(self):
30 try: strthis = "proxy of " + self.this.__repr__()
31 except: strthis = ""
32 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
33
34 import types
35 try:
36 _object = types.ObjectType
37 _newclass = 1
38 except AttributeError:
39 class _object : pass
40 _newclass = 0
41 del types
42
43
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"):
48 set(self,name,value)
49 else:
50 raise AttributeError("You cannot add attributes to %s" % self)
51 return set_attr
52
53
54 import _core
55 wx = _core
56 #---------------------------------------------------------------------------
57
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')
61 __repr__ = _swig_repr
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)
70
71 _gdi_.GDIObject_swigregister(GDIObject)
72
73 #---------------------------------------------------------------------------
74
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):
81 """
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.
85
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
90 equivallent::
91
92 win.SetBackgroundColour(wxColour(0,0,255))
93 win.SetBackgroundColour('BLUE')
94 win.SetBackgroundColour('#0000FF')
95 win.SetBackgroundColour((0,0,255))
96
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`.
101
102 """
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):
106 """
107 __init__(self, byte red=0, byte green=0, byte blue=0, byte alpha=ALPHA_OPAQUE) -> Colour
108
109 Constructs a colour from red, green and blue values.
110
111 :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
112
113 """
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):
118 """
119 Red(self) -> byte
120
121 Returns the red intensity.
122 """
123 return _gdi_.Colour_Red(*args, **kwargs)
124
125 def Green(*args, **kwargs):
126 """
127 Green(self) -> byte
128
129 Returns the green intensity.
130 """
131 return _gdi_.Colour_Green(*args, **kwargs)
132
133 def Blue(*args, **kwargs):
134 """
135 Blue(self) -> byte
136
137 Returns the blue intensity.
138 """
139 return _gdi_.Colour_Blue(*args, **kwargs)
140
141 def Alpha(*args, **kwargs):
142 """
143 Alpha(self) -> byte
144
145 Returns the Alpha value.
146 """
147 return _gdi_.Colour_Alpha(*args, **kwargs)
148
149 def Ok(*args, **kwargs):
150 """
151 Ok(self) -> bool
152
153 Returns True if the colour object is valid (the colour has been
154 initialised with RGB values).
155 """
156 return _gdi_.Colour_Ok(*args, **kwargs)
157
158 def Set(*args, **kwargs):
159 """
160 Set(self, byte red, byte green, byte blue, byte alpha=ALPHA_OPAQUE)
161
162 Sets the RGB intensity values.
163 """
164 return _gdi_.Colour_Set(*args, **kwargs)
165
166 def SetRGB(*args, **kwargs):
167 """
168 SetRGB(self, unsigned long colRGB)
169
170 Sets the RGB intensity values from a packed RGB value.
171 """
172 return _gdi_.Colour_SetRGB(*args, **kwargs)
173
174 def SetFromName(*args, **kwargs):
175 """
176 SetFromName(self, String colourName)
177
178 Sets the RGB intensity values using a colour name listed in
179 ``wx.TheColourDatabase``.
180 """
181 return _gdi_.Colour_SetFromName(*args, **kwargs)
182
183 def GetAsString(*args, **kwargs):
184 """
185 GetAsString(self, long flags=wxC2S_NAME|wxC2S_CSS_SYNTAX) -> String
186
187 Return the colour as a string. Acceptable flags are:
188
189 =================== ==================================
190 wx.C2S_NAME return colour name, when possible
191 wx.C2S_CSS_SYNTAX return colour in rgb(r,g,b) syntax
192 wx.C2S_HTML_SYNTAX return colour in #rrggbb syntax
193 =================== ==================================
194 """
195 return _gdi_.Colour_GetAsString(*args, **kwargs)
196
197 def GetPixel(*args, **kwargs):
198 """
199 GetPixel(self) -> long
200
201 Returns a pixel value which is platform-dependent. On Windows, a
202 COLORREF is returned. On X, an allocated pixel value is returned. -1
203 is returned if the pixel is invalid (on X, unallocated).
204 """
205 return _gdi_.Colour_GetPixel(*args, **kwargs)
206
207 def __eq__(*args, **kwargs):
208 """
209 __eq__(self, PyObject other) -> bool
210
211 Compare colours for equality.
212 """
213 return _gdi_.Colour___eq__(*args, **kwargs)
214
215 def __ne__(*args, **kwargs):
216 """
217 __ne__(self, PyObject other) -> bool
218
219 Compare colours for inequality.
220 """
221 return _gdi_.Colour___ne__(*args, **kwargs)
222
223 def Get(*args, **kwargs):
224 """
225 Get() -> (r, g, b)
226
227 Returns the RGB intensity values as a tuple.
228 """
229 return _gdi_.Colour_Get(*args, **kwargs)
230
231 def GetRGB(*args, **kwargs):
232 """
233 GetRGB(self) -> unsigned long
234
235 Return the colour as a packed RGB value
236 """
237 return _gdi_.Colour_GetRGB(*args, **kwargs)
238
239 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
240 def __str__(self): return str(self.Get(True))
241 def __repr__(self): return 'wx.Colour' + str(self.Get(True))
242 def __nonzero__(self): return self.Ok()
243 __safe_for_unpickling__ = True
244 def __reduce__(self): return (Colour, self.Get(True))
245
246 _gdi_.Colour_swigregister(Colour)
247
248 def NamedColour(*args, **kwargs):
249 """
250 NamedColour(String colorName) -> Colour
251
252 Constructs a colour object using a colour name listed in
253 ``wx.TheColourDatabase``.
254 """
255 val = _gdi_.new_NamedColour(*args, **kwargs)
256 return val
257
258 def ColourRGB(*args, **kwargs):
259 """
260 ColourRGB(unsigned long colRGB) -> Colour
261
262 Constructs a colour from a packed RGB value.
263 """
264 val = _gdi_.new_ColourRGB(*args, **kwargs)
265 return val
266
267 Color = Colour
268 NamedColor = NamedColour
269 ColorRGB = ColourRGB
270
271 class Palette(GDIObject):
272 """Proxy of C++ Palette class"""
273 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
274 __repr__ = _swig_repr
275 def __init__(self, *args, **kwargs):
276 """__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette"""
277 _gdi_.Palette_swiginit(self,_gdi_.new_Palette(*args, **kwargs))
278 __swig_destroy__ = _gdi_.delete_Palette
279 __del__ = lambda self : None;
280 def GetPixel(*args, **kwargs):
281 """GetPixel(self, byte red, byte green, byte blue) -> int"""
282 return _gdi_.Palette_GetPixel(*args, **kwargs)
283
284 def GetRGB(*args, **kwargs):
285 """GetRGB(self, int pixel) -> (R,G,B)"""
286 return _gdi_.Palette_GetRGB(*args, **kwargs)
287
288 def GetColoursCount(*args, **kwargs):
289 """GetColoursCount(self) -> int"""
290 return _gdi_.Palette_GetColoursCount(*args, **kwargs)
291
292 def Ok(*args, **kwargs):
293 """Ok(self) -> bool"""
294 return _gdi_.Palette_Ok(*args, **kwargs)
295
296 def __nonzero__(self): return self.Ok()
297 _gdi_.Palette_swigregister(Palette)
298
299 #---------------------------------------------------------------------------
300
301 class Pen(GDIObject):
302 """Proxy of C++ Pen class"""
303 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
304 __repr__ = _swig_repr
305 def __init__(self, *args, **kwargs):
306 """__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen"""
307 _gdi_.Pen_swiginit(self,_gdi_.new_Pen(*args, **kwargs))
308 __swig_destroy__ = _gdi_.delete_Pen
309 __del__ = lambda self : None;
310 def GetCap(*args, **kwargs):
311 """GetCap(self) -> int"""
312 return _gdi_.Pen_GetCap(*args, **kwargs)
313
314 def GetColour(*args, **kwargs):
315 """GetColour(self) -> Colour"""
316 return _gdi_.Pen_GetColour(*args, **kwargs)
317
318 def GetJoin(*args, **kwargs):
319 """GetJoin(self) -> int"""
320 return _gdi_.Pen_GetJoin(*args, **kwargs)
321
322 def GetStyle(*args, **kwargs):
323 """GetStyle(self) -> int"""
324 return _gdi_.Pen_GetStyle(*args, **kwargs)
325
326 def GetWidth(*args, **kwargs):
327 """GetWidth(self) -> int"""
328 return _gdi_.Pen_GetWidth(*args, **kwargs)
329
330 def Ok(*args, **kwargs):
331 """Ok(self) -> bool"""
332 return _gdi_.Pen_Ok(*args, **kwargs)
333
334 def SetCap(*args, **kwargs):
335 """SetCap(self, int cap_style)"""
336 return _gdi_.Pen_SetCap(*args, **kwargs)
337
338 def SetColour(*args, **kwargs):
339 """SetColour(self, Colour colour)"""
340 return _gdi_.Pen_SetColour(*args, **kwargs)
341
342 def SetJoin(*args, **kwargs):
343 """SetJoin(self, int join_style)"""
344 return _gdi_.Pen_SetJoin(*args, **kwargs)
345
346 def SetStyle(*args, **kwargs):
347 """SetStyle(self, int style)"""
348 return _gdi_.Pen_SetStyle(*args, **kwargs)
349
350 def SetWidth(*args, **kwargs):
351 """SetWidth(self, int width)"""
352 return _gdi_.Pen_SetWidth(*args, **kwargs)
353
354 def SetDashes(*args, **kwargs):
355 """SetDashes(self, int dashes)"""
356 return _gdi_.Pen_SetDashes(*args, **kwargs)
357
358 def GetDashes(*args, **kwargs):
359 """GetDashes(self) -> PyObject"""
360 return _gdi_.Pen_GetDashes(*args, **kwargs)
361
362 def _SetDashes(*args, **kwargs):
363 """_SetDashes(self, PyObject _self, PyObject pyDashes)"""
364 return _gdi_.Pen__SetDashes(*args, **kwargs)
365
366 def SetDashes(self, dashes):
367 """
368 Associate a list of dash lengths with the Pen.
369 """
370 self._SetDashes(self, dashes)
371
372 def GetDashCount(*args, **kwargs):
373 """GetDashCount(self) -> int"""
374 return _gdi_.Pen_GetDashCount(*args, **kwargs)
375
376 def __eq__(*args, **kwargs):
377 """__eq__(self, Pen other) -> bool"""
378 return _gdi_.Pen___eq__(*args, **kwargs)
379
380 def __ne__(*args, **kwargs):
381 """__ne__(self, Pen other) -> bool"""
382 return _gdi_.Pen___ne__(*args, **kwargs)
383
384 def __nonzero__(self): return self.Ok()
385 _gdi_.Pen_swigregister(Pen)
386
387 #---------------------------------------------------------------------------
388
389 class Brush(GDIObject):
390 """
391 A brush is a drawing tool for filling in areas. It is used for
392 painting the background of rectangles, ellipses, etc. when drawing on
393 a `wx.DC`. It has a colour and a style.
394 """
395 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
396 __repr__ = _swig_repr
397 def __init__(self, *args, **kwargs):
398 """
399 __init__(self, Colour colour, int style=SOLID) -> Brush
400
401 Constructs a brush from a `wx.Colour` object and a style.
402 """
403 _gdi_.Brush_swiginit(self,_gdi_.new_Brush(*args, **kwargs))
404 __swig_destroy__ = _gdi_.delete_Brush
405 __del__ = lambda self : None;
406 def SetColour(*args, **kwargs):
407 """
408 SetColour(self, Colour col)
409
410 Set the brush's `wx.Colour`.
411 """
412 return _gdi_.Brush_SetColour(*args, **kwargs)
413
414 def SetStyle(*args, **kwargs):
415 """
416 SetStyle(self, int style)
417
418 Sets the style of the brush. See `__init__` for a listing of styles.
419 """
420 return _gdi_.Brush_SetStyle(*args, **kwargs)
421
422 def SetStipple(*args, **kwargs):
423 """
424 SetStipple(self, Bitmap stipple)
425
426 Sets the stipple `wx.Bitmap`.
427 """
428 return _gdi_.Brush_SetStipple(*args, **kwargs)
429
430 def GetColour(*args, **kwargs):
431 """
432 GetColour(self) -> Colour
433
434 Returns the `wx.Colour` of the brush.
435 """
436 return _gdi_.Brush_GetColour(*args, **kwargs)
437
438 def GetStyle(*args, **kwargs):
439 """
440 GetStyle(self) -> int
441
442 Returns the style of the brush. See `__init__` for a listing of
443 styles.
444 """
445 return _gdi_.Brush_GetStyle(*args, **kwargs)
446
447 def GetStipple(*args, **kwargs):
448 """
449 GetStipple(self) -> Bitmap
450
451 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
452 have a wx.STIPPLE style, then the return value may be non-None but an
453 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
454 """
455 return _gdi_.Brush_GetStipple(*args, **kwargs)
456
457 def IsHatch(*args, **kwargs):
458 """
459 IsHatch(self) -> bool
460
461 Is the current style a hatch type?
462 """
463 return _gdi_.Brush_IsHatch(*args, **kwargs)
464
465 def Ok(*args, **kwargs):
466 """
467 Ok(self) -> bool
468
469 Returns True if the brush is initialised and valid.
470 """
471 return _gdi_.Brush_Ok(*args, **kwargs)
472
473 def __nonzero__(self): return self.Ok()
474 _gdi_.Brush_swigregister(Brush)
475
476 def BrushFromBitmap(*args, **kwargs):
477 """
478 BrushFromBitmap(Bitmap stippleBitmap) -> Brush
479
480 Constructs a stippled brush using a bitmap.
481 """
482 val = _gdi_.new_BrushFromBitmap(*args, **kwargs)
483 return val
484
485 class Bitmap(GDIObject):
486 """
487 The wx.Bitmap class encapsulates the concept of a platform-dependent
488 bitmap. It can be either monochrome or colour, and either loaded from
489 a file or created dynamically. A bitmap can be selected into a memory
490 device context (instance of `wx.MemoryDC`). This enables the bitmap to
491 be copied to a window or memory device context using `wx.DC.Blit`, or
492 to be used as a drawing surface.
493 """
494 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
495 __repr__ = _swig_repr
496 def __init__(self, *args, **kwargs):
497 """
498 __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap
499
500 Loads a bitmap from a file.
501 """
502 _gdi_.Bitmap_swiginit(self,_gdi_.new_Bitmap(*args, **kwargs))
503 __swig_destroy__ = _gdi_.delete_Bitmap
504 __del__ = lambda self : None;
505 def Ok(*args, **kwargs):
506 """Ok(self) -> bool"""
507 return _gdi_.Bitmap_Ok(*args, **kwargs)
508
509 def GetWidth(*args, **kwargs):
510 """
511 GetWidth(self) -> int
512
513 Gets the width of the bitmap in pixels.
514 """
515 return _gdi_.Bitmap_GetWidth(*args, **kwargs)
516
517 def GetHeight(*args, **kwargs):
518 """
519 GetHeight(self) -> int
520
521 Gets the height of the bitmap in pixels.
522 """
523 return _gdi_.Bitmap_GetHeight(*args, **kwargs)
524
525 def GetDepth(*args, **kwargs):
526 """
527 GetDepth(self) -> int
528
529 Gets the colour depth of the bitmap. A value of 1 indicates a
530 monochrome bitmap.
531 """
532 return _gdi_.Bitmap_GetDepth(*args, **kwargs)
533
534 def GetSize(*args, **kwargs):
535 """
536 GetSize(self) -> Size
537
538 Get the size of the bitmap.
539 """
540 return _gdi_.Bitmap_GetSize(*args, **kwargs)
541
542 def ConvertToImage(*args, **kwargs):
543 """
544 ConvertToImage(self) -> Image
545
546 Creates a platform-independent image from a platform-dependent
547 bitmap. This preserves mask information so that bitmaps and images can
548 be converted back and forth without loss in that respect.
549 """
550 return _gdi_.Bitmap_ConvertToImage(*args, **kwargs)
551
552 def GetMask(*args, **kwargs):
553 """
554 GetMask(self) -> Mask
555
556 Gets the associated mask (if any) which may have been loaded from a
557 file or explpicitly set for the bitmap.
558
559 :see: `SetMask`, `wx.Mask`
560
561 """
562 return _gdi_.Bitmap_GetMask(*args, **kwargs)
563
564 def SetMask(*args, **kwargs):
565 """
566 SetMask(self, Mask mask)
567
568 Sets the mask for this bitmap.
569
570 :see: `GetMask`, `wx.Mask`
571
572 """
573 return _gdi_.Bitmap_SetMask(*args, **kwargs)
574
575 def SetMaskColour(*args, **kwargs):
576 """
577 SetMaskColour(self, Colour colour)
578
579 Create a Mask based on a specified colour in the Bitmap.
580 """
581 return _gdi_.Bitmap_SetMaskColour(*args, **kwargs)
582
583 def GetSubBitmap(*args, **kwargs):
584 """
585 GetSubBitmap(self, Rect rect) -> Bitmap
586
587 Returns a sub-bitmap of the current one as long as the rect belongs
588 entirely to the bitmap. This function preserves bit depth and mask
589 information.
590 """
591 return _gdi_.Bitmap_GetSubBitmap(*args, **kwargs)
592
593 def SaveFile(*args, **kwargs):
594 """
595 SaveFile(self, String name, int type, Palette palette=None) -> bool
596
597 Saves a bitmap in the named file. See `__init__` for a description of
598 the ``type`` parameter.
599 """
600 return _gdi_.Bitmap_SaveFile(*args, **kwargs)
601
602 def LoadFile(*args, **kwargs):
603 """
604 LoadFile(self, String name, int type) -> bool
605
606 Loads a bitmap from a file. See `__init__` for a description of the
607 ``type`` parameter.
608 """
609 return _gdi_.Bitmap_LoadFile(*args, **kwargs)
610
611 def GetPalette(*args, **kwargs):
612 """GetPalette(self) -> Palette"""
613 return _gdi_.Bitmap_GetPalette(*args, **kwargs)
614
615 def CopyFromIcon(*args, **kwargs):
616 """CopyFromIcon(self, Icon icon) -> bool"""
617 return _gdi_.Bitmap_CopyFromIcon(*args, **kwargs)
618
619 def SetHeight(*args, **kwargs):
620 """
621 SetHeight(self, int height)
622
623 Set the height property (does not affect the existing bitmap data).
624 """
625 return _gdi_.Bitmap_SetHeight(*args, **kwargs)
626
627 def SetWidth(*args, **kwargs):
628 """
629 SetWidth(self, int width)
630
631 Set the width property (does not affect the existing bitmap data).
632 """
633 return _gdi_.Bitmap_SetWidth(*args, **kwargs)
634
635 def SetDepth(*args, **kwargs):
636 """
637 SetDepth(self, int depth)
638
639 Set the depth property (does not affect the existing bitmap data).
640 """
641 return _gdi_.Bitmap_SetDepth(*args, **kwargs)
642
643 def SetSize(*args, **kwargs):
644 """
645 SetSize(self, Size size)
646
647 Set the bitmap size (does not affect the existing bitmap data).
648 """
649 return _gdi_.Bitmap_SetSize(*args, **kwargs)
650
651 def __nonzero__(self): return self.Ok()
652 def __eq__(*args, **kwargs):
653 """__eq__(self, Bitmap other) -> bool"""
654 return _gdi_.Bitmap___eq__(*args, **kwargs)
655
656 def __ne__(*args, **kwargs):
657 """__ne__(self, Bitmap other) -> bool"""
658 return _gdi_.Bitmap___ne__(*args, **kwargs)
659
660 _gdi_.Bitmap_swigregister(Bitmap)
661
662 def EmptyBitmap(*args, **kwargs):
663 """
664 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
665
666 Creates a new bitmap of the given size. A depth of -1 indicates the
667 depth of the current screen or visual. Some platforms only support 1
668 for monochrome and -1 for the current display depth.
669 """
670 val = _gdi_.new_EmptyBitmap(*args, **kwargs)
671 return val
672
673 def BitmapFromIcon(*args, **kwargs):
674 """
675 BitmapFromIcon(Icon icon) -> Bitmap
676
677 Create a new bitmap from a `wx.Icon` object.
678 """
679 val = _gdi_.new_BitmapFromIcon(*args, **kwargs)
680 return val
681
682 def BitmapFromImage(*args, **kwargs):
683 """
684 BitmapFromImage(Image image, int depth=-1) -> Bitmap
685
686 Creates bitmap object from a `wx.Image`. This has to be done to
687 actually display a `wx.Image` as you cannot draw an image directly on
688 a window. The resulting bitmap will use the provided colour depth (or
689 that of the current screen colour depth if depth is -1) which entails
690 that a colour reduction may have to take place.
691 """
692 val = _gdi_.new_BitmapFromImage(*args, **kwargs)
693 return val
694
695 def BitmapFromXPMData(*args, **kwargs):
696 """
697 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
698
699 Construct a Bitmap from a list of strings formatted as XPM data.
700 """
701 val = _gdi_.new_BitmapFromXPMData(*args, **kwargs)
702 return val
703
704 def BitmapFromBits(*args, **kwargs):
705 """
706 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
707
708 Creates a bitmap from an array of bits. You should only use this
709 function for monochrome bitmaps (depth 1) in portable programs: in
710 this case the bits parameter should contain an XBM image. For other
711 bit depths, the behaviour is platform dependent.
712 """
713 val = _gdi_.new_BitmapFromBits(*args, **kwargs)
714 return val
715
716
717 def _BitmapFromBufferAlpha(*args, **kwargs):
718 """_BitmapFromBufferAlpha(int width, int height, buffer data, buffer alpha) -> Bitmap"""
719 return _gdi_._BitmapFromBufferAlpha(*args, **kwargs)
720
721 def _BitmapFromBuffer(*args, **kwargs):
722 """_BitmapFromBuffer(int width, int height, buffer data) -> Bitmap"""
723 return _gdi_._BitmapFromBuffer(*args, **kwargs)
724 def BitmapFromBuffer(width, height, dataBuffer, alphaBuffer=None):
725 """
726 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
727 parameter must be a Python object that implements the buffer
728 interface, such as a string, array, etc. The dataBuffer object is
729 expected to contain a series of RGB bytes and be width*height*3
730 bytes long. A buffer object can optionally be supplied for the
731 image's alpha channel data, and it is expected to be width*height
732 bytes long. On Windows the RGB values are 'premultiplied' by the
733 alpha values. (The other platforms do the multiplication
734 themselves.)
735
736 Unlike `wx.ImageFromBuffer` the bitmap created with this function
737 does not share the memory buffer with the buffer object. This is
738 because the native pixel buffer format varies on different
739 platforms, and so instead an efficient as possible copy of the
740 data is made from the buffer objects to the bitmap's native pixel
741 buffer. For direct access to a bitmap's pixel buffer see
742 `wx.NativePixelData` and `wx.AlphaPixelData`.
743
744 :see: `wx.Bitmap`, `wx.BitmapFromBufferRGBA`, `wx.NativePixelData`,
745 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
746 """
747 if alphaBuffer is not None:
748 return _gdi_._BitmapFromBufferAlpha(width, height, dataBuffer, alphaBuffer)
749 else:
750 return _gdi_._BitmapFromBuffer(width, height, dataBuffer)
751
752
753 def _BitmapFromBufferRGBA(*args, **kwargs):
754 """_BitmapFromBufferRGBA(int width, int height, buffer data) -> Bitmap"""
755 return _gdi_._BitmapFromBufferRGBA(*args, **kwargs)
756 def BitmapFromBufferRGBA(width, height, dataBuffer):
757 """
758 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
759 parameter must be a Python object that implements the buffer
760 interface, such as a string, array, etc. The dataBuffer object is
761 expected to contain a series of RGBA bytes (red, green, blue and
762 alpha) and be width*height*4 bytes long. On Windows the RGB
763 values are 'premultiplied' by the alpha values. (The other
764 platforms do the multiplication themselves.)
765
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 object to the bitmap's native pixel
771 buffer. For direct access to a bitmap's pixel buffer see
772 `wx.NativePixelData` and `wx.AlphaPixelData`.
773
774 :see: `wx.Bitmap`, `wx.BitmapFromBuffer`, `wx.NativePixelData`,
775 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
776 """
777 return _gdi_._BitmapFromBufferRGBA(width, height, dataBuffer)
778
779 class PixelDataBase(object):
780 """Proxy of C++ PixelDataBase class"""
781 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
782 def __init__(self): raise AttributeError, "No constructor defined"
783 __repr__ = _swig_repr
784 def GetOrigin(*args, **kwargs):
785 """GetOrigin(self) -> Point"""
786 return _gdi_.PixelDataBase_GetOrigin(*args, **kwargs)
787
788 def GetWidth(*args, **kwargs):
789 """GetWidth(self) -> int"""
790 return _gdi_.PixelDataBase_GetWidth(*args, **kwargs)
791
792 def GetHeight(*args, **kwargs):
793 """GetHeight(self) -> int"""
794 return _gdi_.PixelDataBase_GetHeight(*args, **kwargs)
795
796 def GetSize(*args, **kwargs):
797 """GetSize(self) -> Size"""
798 return _gdi_.PixelDataBase_GetSize(*args, **kwargs)
799
800 def GetRowStride(*args, **kwargs):
801 """GetRowStride(self) -> int"""
802 return _gdi_.PixelDataBase_GetRowStride(*args, **kwargs)
803
804 _gdi_.PixelDataBase_swigregister(PixelDataBase)
805
806 class NativePixelData(PixelDataBase):
807 """Proxy of C++ NativePixelData class"""
808 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
809 __repr__ = _swig_repr
810 def __init__(self, *args):
811 """
812 __init__(self, Bitmap bmp) -> NativePixelData
813 __init__(self, Bitmap bmp, Rect rect) -> NativePixelData
814 __init__(self, Bitmap bmp, Point pt, Size sz) -> NativePixelData
815 """
816 _gdi_.NativePixelData_swiginit(self,_gdi_.new_NativePixelData(*args))
817 __swig_destroy__ = _gdi_.delete_NativePixelData
818 __del__ = lambda self : None;
819 def GetPixels(*args, **kwargs):
820 """GetPixels(self) -> NativePixelData_Accessor"""
821 return _gdi_.NativePixelData_GetPixels(*args, **kwargs)
822
823 def UseAlpha(*args, **kwargs):
824 """UseAlpha(self)"""
825 return _gdi_.NativePixelData_UseAlpha(*args, **kwargs)
826
827 def __nonzero__(*args, **kwargs):
828 """__nonzero__(self) -> bool"""
829 return _gdi_.NativePixelData___nonzero__(*args, **kwargs)
830
831 def __iter__(self):
832 """
833 Create and return an iterator object for this pixel data
834 object. (It's really a generator but I won't tell if you
835 don't tell.)
836 """
837 width = self.GetWidth()
838 height = self.GetHeight()
839 pixels = self.GetPixels()
840
841
842
843
844 class PixelFacade(object):
845 def Get(self):
846 return pixels.Get()
847 def Set(self, *args, **kw):
848 return pixels.Set(*args, **kw)
849 def __str__(self):
850 return str(self.Get())
851 def __repr__(self):
852 return 'pixel(%d,%d): %s' % (x,y,self.Get())
853 X = property(lambda self: x)
854 Y = property(lambda self: y)
855
856 pf = PixelFacade()
857 for y in xrange(height):
858 for x in xrange(width):
859
860
861
862 yield pf
863 pixels.nextPixel()
864 pixels.MoveTo(self, 0, y)
865
866 _gdi_.NativePixelData_swigregister(NativePixelData)
867
868 class NativePixelData_Accessor(object):
869 """Proxy of C++ NativePixelData_Accessor class"""
870 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
871 __repr__ = _swig_repr
872 def __init__(self, *args):
873 """
874 __init__(self, NativePixelData data) -> NativePixelData_Accessor
875 __init__(self, Bitmap bmp, NativePixelData data) -> NativePixelData_Accessor
876 __init__(self) -> NativePixelData_Accessor
877 """
878 _gdi_.NativePixelData_Accessor_swiginit(self,_gdi_.new_NativePixelData_Accessor(*args))
879 __swig_destroy__ = _gdi_.delete_NativePixelData_Accessor
880 __del__ = lambda self : None;
881 def Reset(*args, **kwargs):
882 """Reset(self, NativePixelData data)"""
883 return _gdi_.NativePixelData_Accessor_Reset(*args, **kwargs)
884
885 def IsOk(*args, **kwargs):
886 """IsOk(self) -> bool"""
887 return _gdi_.NativePixelData_Accessor_IsOk(*args, **kwargs)
888
889 def nextPixel(*args, **kwargs):
890 """nextPixel(self)"""
891 return _gdi_.NativePixelData_Accessor_nextPixel(*args, **kwargs)
892
893 def Offset(*args, **kwargs):
894 """Offset(self, NativePixelData data, int x, int y)"""
895 return _gdi_.NativePixelData_Accessor_Offset(*args, **kwargs)
896
897 def OffsetX(*args, **kwargs):
898 """OffsetX(self, NativePixelData data, int x)"""
899 return _gdi_.NativePixelData_Accessor_OffsetX(*args, **kwargs)
900
901 def OffsetY(*args, **kwargs):
902 """OffsetY(self, NativePixelData data, int y)"""
903 return _gdi_.NativePixelData_Accessor_OffsetY(*args, **kwargs)
904
905 def MoveTo(*args, **kwargs):
906 """MoveTo(self, NativePixelData data, int x, int y)"""
907 return _gdi_.NativePixelData_Accessor_MoveTo(*args, **kwargs)
908
909 def Set(*args, **kwargs):
910 """Set(self, byte red, byte green, byte blue)"""
911 return _gdi_.NativePixelData_Accessor_Set(*args, **kwargs)
912
913 def Get(*args, **kwargs):
914 """Get(self) -> PyObject"""
915 return _gdi_.NativePixelData_Accessor_Get(*args, **kwargs)
916
917 _gdi_.NativePixelData_Accessor_swigregister(NativePixelData_Accessor)
918
919 class AlphaPixelData(PixelDataBase):
920 """Proxy of C++ AlphaPixelData class"""
921 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
922 __repr__ = _swig_repr
923 def __init__(self, *args):
924 """
925 __init__(self, Bitmap bmp) -> AlphaPixelData
926 __init__(self, Bitmap bmp, Rect rect) -> AlphaPixelData
927 __init__(self, Bitmap bmp, Point pt, Size sz) -> AlphaPixelData
928 """
929 _gdi_.AlphaPixelData_swiginit(self,_gdi_.new_AlphaPixelData(*args))
930 self.UseAlpha()
931
932 __swig_destroy__ = _gdi_.delete_AlphaPixelData
933 __del__ = lambda self : None;
934 def GetPixels(*args, **kwargs):
935 """GetPixels(self) -> AlphaPixelData_Accessor"""
936 return _gdi_.AlphaPixelData_GetPixels(*args, **kwargs)
937
938 def UseAlpha(*args, **kwargs):
939 """UseAlpha(self)"""
940 return _gdi_.AlphaPixelData_UseAlpha(*args, **kwargs)
941
942 def __nonzero__(*args, **kwargs):
943 """__nonzero__(self) -> bool"""
944 return _gdi_.AlphaPixelData___nonzero__(*args, **kwargs)
945
946 def __iter__(self):
947 """
948 Create and return an iterator object for this pixel data
949 object. (It's really a generator but I won't tell if you
950 don't tell.)
951 """
952 width = self.GetWidth()
953 height = self.GetHeight()
954 pixels = self.GetPixels()
955
956
957
958
959 class PixelFacade(object):
960 def Get(self):
961 return pixels.Get()
962 def Set(self, *args, **kw):
963 return pixels.Set(*args, **kw)
964 def __str__(self):
965 return str(self.Get())
966 def __repr__(self):
967 return 'pixel(%d,%d): %s' % (x,y,self.Get())
968 X = property(lambda self: x)
969 Y = property(lambda self: y)
970
971 pf = PixelFacade()
972 for y in xrange(height):
973 for x in xrange(width):
974
975
976
977 yield pf
978 pixels.nextPixel()
979 pixels.MoveTo(self, 0, y)
980
981 _gdi_.AlphaPixelData_swigregister(AlphaPixelData)
982
983 class AlphaPixelData_Accessor(object):
984 """Proxy of C++ AlphaPixelData_Accessor class"""
985 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
986 __repr__ = _swig_repr
987 def __init__(self, *args):
988 """
989 __init__(self, AlphaPixelData data) -> AlphaPixelData_Accessor
990 __init__(self, Bitmap bmp, AlphaPixelData data) -> AlphaPixelData_Accessor
991 __init__(self) -> AlphaPixelData_Accessor
992 """
993 _gdi_.AlphaPixelData_Accessor_swiginit(self,_gdi_.new_AlphaPixelData_Accessor(*args))
994 __swig_destroy__ = _gdi_.delete_AlphaPixelData_Accessor
995 __del__ = lambda self : None;
996 def Reset(*args, **kwargs):
997 """Reset(self, AlphaPixelData data)"""
998 return _gdi_.AlphaPixelData_Accessor_Reset(*args, **kwargs)
999
1000 def IsOk(*args, **kwargs):
1001 """IsOk(self) -> bool"""
1002 return _gdi_.AlphaPixelData_Accessor_IsOk(*args, **kwargs)
1003
1004 def nextPixel(*args, **kwargs):
1005 """nextPixel(self)"""
1006 return _gdi_.AlphaPixelData_Accessor_nextPixel(*args, **kwargs)
1007
1008 def Offset(*args, **kwargs):
1009 """Offset(self, AlphaPixelData data, int x, int y)"""
1010 return _gdi_.AlphaPixelData_Accessor_Offset(*args, **kwargs)
1011
1012 def OffsetX(*args, **kwargs):
1013 """OffsetX(self, AlphaPixelData data, int x)"""
1014 return _gdi_.AlphaPixelData_Accessor_OffsetX(*args, **kwargs)
1015
1016 def OffsetY(*args, **kwargs):
1017 """OffsetY(self, AlphaPixelData data, int y)"""
1018 return _gdi_.AlphaPixelData_Accessor_OffsetY(*args, **kwargs)
1019
1020 def MoveTo(*args, **kwargs):
1021 """MoveTo(self, AlphaPixelData data, int x, int y)"""
1022 return _gdi_.AlphaPixelData_Accessor_MoveTo(*args, **kwargs)
1023
1024 def Set(*args, **kwargs):
1025 """Set(self, byte red, byte green, byte blue, byte alpha)"""
1026 return _gdi_.AlphaPixelData_Accessor_Set(*args, **kwargs)
1027
1028 def Get(*args, **kwargs):
1029 """Get(self) -> PyObject"""
1030 return _gdi_.AlphaPixelData_Accessor_Get(*args, **kwargs)
1031
1032 _gdi_.AlphaPixelData_Accessor_swigregister(AlphaPixelData_Accessor)
1033
1034 class Mask(_core.Object):
1035 """
1036 This class encapsulates a monochrome mask bitmap, where the masked
1037 area is black and the unmasked area is white. When associated with a
1038 bitmap and drawn in a device context, the unmasked area of the bitmap
1039 will be drawn, and the masked area will not be drawn.
1040
1041 A mask may be associated with a `wx.Bitmap`. It is used in
1042 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
1043 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
1044 mask.
1045 """
1046 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1047 __repr__ = _swig_repr
1048 def __init__(self, *args, **kwargs):
1049 """
1050 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
1051
1052 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
1053 that indicates the transparent portions of the mask. In other words,
1054 the pixels in ``bitmap`` that match ``colour`` will be the transparent
1055 portions of the mask. If no ``colour`` or an invalid ``colour`` is
1056 passed then BLACK is used.
1057
1058 :see: `wx.Bitmap`, `wx.Colour`
1059 """
1060 _gdi_.Mask_swiginit(self,_gdi_.new_Mask(*args, **kwargs))
1061 __swig_destroy__ = _gdi_.delete_Mask
1062 __del__ = lambda self : None;
1063 _gdi_.Mask_swigregister(Mask)
1064
1065 MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
1066 class Icon(GDIObject):
1067 """Proxy of C++ Icon class"""
1068 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1069 __repr__ = _swig_repr
1070 def __init__(self, *args, **kwargs):
1071 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
1072 _gdi_.Icon_swiginit(self,_gdi_.new_Icon(*args, **kwargs))
1073 __swig_destroy__ = _gdi_.delete_Icon
1074 __del__ = lambda self : None;
1075 def LoadFile(*args, **kwargs):
1076 """LoadFile(self, String name, int type) -> bool"""
1077 return _gdi_.Icon_LoadFile(*args, **kwargs)
1078
1079 def Ok(*args, **kwargs):
1080 """Ok(self) -> bool"""
1081 return _gdi_.Icon_Ok(*args, **kwargs)
1082
1083 def GetWidth(*args, **kwargs):
1084 """GetWidth(self) -> int"""
1085 return _gdi_.Icon_GetWidth(*args, **kwargs)
1086
1087 def GetHeight(*args, **kwargs):
1088 """GetHeight(self) -> int"""
1089 return _gdi_.Icon_GetHeight(*args, **kwargs)
1090
1091 def GetDepth(*args, **kwargs):
1092 """GetDepth(self) -> int"""
1093 return _gdi_.Icon_GetDepth(*args, **kwargs)
1094
1095 def SetWidth(*args, **kwargs):
1096 """SetWidth(self, int w)"""
1097 return _gdi_.Icon_SetWidth(*args, **kwargs)
1098
1099 def SetHeight(*args, **kwargs):
1100 """SetHeight(self, int h)"""
1101 return _gdi_.Icon_SetHeight(*args, **kwargs)
1102
1103 def SetDepth(*args, **kwargs):
1104 """SetDepth(self, int d)"""
1105 return _gdi_.Icon_SetDepth(*args, **kwargs)
1106
1107 def CopyFromBitmap(*args, **kwargs):
1108 """CopyFromBitmap(self, Bitmap bmp)"""
1109 return _gdi_.Icon_CopyFromBitmap(*args, **kwargs)
1110
1111 def __nonzero__(self): return self.Ok()
1112 _gdi_.Icon_swigregister(Icon)
1113
1114 def EmptyIcon(*args, **kwargs):
1115 """EmptyIcon() -> Icon"""
1116 val = _gdi_.new_EmptyIcon(*args, **kwargs)
1117 return val
1118
1119 def IconFromLocation(*args, **kwargs):
1120 """IconFromLocation(IconLocation loc) -> Icon"""
1121 val = _gdi_.new_IconFromLocation(*args, **kwargs)
1122 return val
1123
1124 def IconFromBitmap(*args, **kwargs):
1125 """IconFromBitmap(Bitmap bmp) -> Icon"""
1126 val = _gdi_.new_IconFromBitmap(*args, **kwargs)
1127 return val
1128
1129 def IconFromXPMData(*args, **kwargs):
1130 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
1131 val = _gdi_.new_IconFromXPMData(*args, **kwargs)
1132 return val
1133
1134 class IconLocation(object):
1135 """Proxy of C++ IconLocation class"""
1136 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1137 __repr__ = _swig_repr
1138 def __init__(self, *args, **kwargs):
1139 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
1140 _gdi_.IconLocation_swiginit(self,_gdi_.new_IconLocation(*args, **kwargs))
1141 __swig_destroy__ = _gdi_.delete_IconLocation
1142 __del__ = lambda self : None;
1143 def IsOk(*args, **kwargs):
1144 """IsOk(self) -> bool"""
1145 return _gdi_.IconLocation_IsOk(*args, **kwargs)
1146
1147 def __nonzero__(self): return self.Ok()
1148 def SetFileName(*args, **kwargs):
1149 """SetFileName(self, String filename)"""
1150 return _gdi_.IconLocation_SetFileName(*args, **kwargs)
1151
1152 def GetFileName(*args, **kwargs):
1153 """GetFileName(self) -> String"""
1154 return _gdi_.IconLocation_GetFileName(*args, **kwargs)
1155
1156 def SetIndex(*args, **kwargs):
1157 """SetIndex(self, int num)"""
1158 return _gdi_.IconLocation_SetIndex(*args, **kwargs)
1159
1160 def GetIndex(*args, **kwargs):
1161 """GetIndex(self) -> int"""
1162 return _gdi_.IconLocation_GetIndex(*args, **kwargs)
1163
1164 _gdi_.IconLocation_swigregister(IconLocation)
1165
1166 class IconBundle(object):
1167 """Proxy of C++ IconBundle class"""
1168 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1169 __repr__ = _swig_repr
1170 def __init__(self, *args, **kwargs):
1171 """__init__(self) -> IconBundle"""
1172 _gdi_.IconBundle_swiginit(self,_gdi_.new_IconBundle(*args, **kwargs))
1173 __swig_destroy__ = _gdi_.delete_IconBundle
1174 __del__ = lambda self : None;
1175 def AddIcon(*args, **kwargs):
1176 """AddIcon(self, Icon icon)"""
1177 return _gdi_.IconBundle_AddIcon(*args, **kwargs)
1178
1179 def AddIconFromFile(*args, **kwargs):
1180 """AddIconFromFile(self, String file, long type)"""
1181 return _gdi_.IconBundle_AddIconFromFile(*args, **kwargs)
1182
1183 def GetIcon(*args, **kwargs):
1184 """GetIcon(self, Size size) -> Icon"""
1185 return _gdi_.IconBundle_GetIcon(*args, **kwargs)
1186
1187 _gdi_.IconBundle_swigregister(IconBundle)
1188
1189 def IconBundleFromFile(*args, **kwargs):
1190 """IconBundleFromFile(String file, long type) -> IconBundle"""
1191 val = _gdi_.new_IconBundleFromFile(*args, **kwargs)
1192 return val
1193
1194 def IconBundleFromIcon(*args, **kwargs):
1195 """IconBundleFromIcon(Icon icon) -> IconBundle"""
1196 val = _gdi_.new_IconBundleFromIcon(*args, **kwargs)
1197 return val
1198
1199 class Cursor(GDIObject):
1200 """
1201 A cursor is a small bitmap usually used for denoting where the mouse
1202 pointer is, with a picture that might indicate the interpretation of a
1203 mouse click.
1204
1205 A single cursor object may be used in many windows (any subwindow
1206 type). The wxWindows convention is to set the cursor for a window, as
1207 in X, rather than to set it globally as in MS Windows, although a
1208 global `wx.SetCursor` function is also available for use on MS Windows.
1209
1210 """
1211 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1212 __repr__ = _swig_repr
1213 def __init__(self, *args, **kwargs):
1214 """
1215 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
1216
1217 Construct a Cursor from a file. Specify the type of file using
1218 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
1219 file.
1220 """
1221 _gdi_.Cursor_swiginit(self,_gdi_.new_Cursor(*args, **kwargs))
1222 __swig_destroy__ = _gdi_.delete_Cursor
1223 __del__ = lambda self : None;
1224 def Ok(*args, **kwargs):
1225 """Ok(self) -> bool"""
1226 return _gdi_.Cursor_Ok(*args, **kwargs)
1227
1228 def __nonzero__(self): return self.Ok()
1229 _gdi_.Cursor_swigregister(Cursor)
1230
1231 def StockCursor(*args, **kwargs):
1232 """
1233 StockCursor(int id) -> Cursor
1234
1235 Create a cursor using one of the stock cursors. Note that not all
1236 stock cursors are available on all platforms.
1237 """
1238 val = _gdi_.new_StockCursor(*args, **kwargs)
1239 return val
1240
1241 def CursorFromImage(*args, **kwargs):
1242 """
1243 CursorFromImage(Image image) -> Cursor
1244
1245 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
1246 for setting the transparent portions of the cursor.
1247 """
1248 val = _gdi_.new_CursorFromImage(*args, **kwargs)
1249 return val
1250
1251 #---------------------------------------------------------------------------
1252
1253 OutRegion = _gdi_.OutRegion
1254 PartRegion = _gdi_.PartRegion
1255 InRegion = _gdi_.InRegion
1256 class Region(GDIObject):
1257 """Proxy of C++ Region class"""
1258 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1259 __repr__ = _swig_repr
1260 def __init__(self, *args, **kwargs):
1261 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
1262 _gdi_.Region_swiginit(self,_gdi_.new_Region(*args, **kwargs))
1263 __swig_destroy__ = _gdi_.delete_Region
1264 __del__ = lambda self : None;
1265 def Clear(*args, **kwargs):
1266 """Clear(self)"""
1267 return _gdi_.Region_Clear(*args, **kwargs)
1268
1269 def Offset(*args, **kwargs):
1270 """Offset(self, int x, int y) -> bool"""
1271 return _gdi_.Region_Offset(*args, **kwargs)
1272
1273 def Contains(*args, **kwargs):
1274 """Contains(self, int x, int y) -> int"""
1275 return _gdi_.Region_Contains(*args, **kwargs)
1276
1277 def ContainsPoint(*args, **kwargs):
1278 """ContainsPoint(self, Point pt) -> int"""
1279 return _gdi_.Region_ContainsPoint(*args, **kwargs)
1280
1281 def ContainsRect(*args, **kwargs):
1282 """ContainsRect(self, Rect rect) -> int"""
1283 return _gdi_.Region_ContainsRect(*args, **kwargs)
1284
1285 def ContainsRectDim(*args, **kwargs):
1286 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
1287 return _gdi_.Region_ContainsRectDim(*args, **kwargs)
1288
1289 def GetBox(*args, **kwargs):
1290 """GetBox(self) -> Rect"""
1291 return _gdi_.Region_GetBox(*args, **kwargs)
1292
1293 def Intersect(*args, **kwargs):
1294 """Intersect(self, int x, int y, int width, int height) -> bool"""
1295 return _gdi_.Region_Intersect(*args, **kwargs)
1296
1297 def IntersectRect(*args, **kwargs):
1298 """IntersectRect(self, Rect rect) -> bool"""
1299 return _gdi_.Region_IntersectRect(*args, **kwargs)
1300
1301 def IntersectRegion(*args, **kwargs):
1302 """IntersectRegion(self, Region region) -> bool"""
1303 return _gdi_.Region_IntersectRegion(*args, **kwargs)
1304
1305 def IsEmpty(*args, **kwargs):
1306 """IsEmpty(self) -> bool"""
1307 return _gdi_.Region_IsEmpty(*args, **kwargs)
1308
1309 def Union(*args, **kwargs):
1310 """Union(self, int x, int y, int width, int height) -> bool"""
1311 return _gdi_.Region_Union(*args, **kwargs)
1312
1313 def UnionRect(*args, **kwargs):
1314 """UnionRect(self, Rect rect) -> bool"""
1315 return _gdi_.Region_UnionRect(*args, **kwargs)
1316
1317 def UnionRegion(*args, **kwargs):
1318 """UnionRegion(self, Region region) -> bool"""
1319 return _gdi_.Region_UnionRegion(*args, **kwargs)
1320
1321 def Subtract(*args, **kwargs):
1322 """Subtract(self, int x, int y, int width, int height) -> bool"""
1323 return _gdi_.Region_Subtract(*args, **kwargs)
1324
1325 def SubtractRect(*args, **kwargs):
1326 """SubtractRect(self, Rect rect) -> bool"""
1327 return _gdi_.Region_SubtractRect(*args, **kwargs)
1328
1329 def SubtractRegion(*args, **kwargs):
1330 """SubtractRegion(self, Region region) -> bool"""
1331 return _gdi_.Region_SubtractRegion(*args, **kwargs)
1332
1333 def Xor(*args, **kwargs):
1334 """Xor(self, int x, int y, int width, int height) -> bool"""
1335 return _gdi_.Region_Xor(*args, **kwargs)
1336
1337 def XorRect(*args, **kwargs):
1338 """XorRect(self, Rect rect) -> bool"""
1339 return _gdi_.Region_XorRect(*args, **kwargs)
1340
1341 def XorRegion(*args, **kwargs):
1342 """XorRegion(self, Region region) -> bool"""
1343 return _gdi_.Region_XorRegion(*args, **kwargs)
1344
1345 def ConvertToBitmap(*args, **kwargs):
1346 """ConvertToBitmap(self) -> Bitmap"""
1347 return _gdi_.Region_ConvertToBitmap(*args, **kwargs)
1348
1349 def UnionBitmap(*args, **kwargs):
1350 """UnionBitmap(self, Bitmap bmp) -> bool"""
1351 return _gdi_.Region_UnionBitmap(*args, **kwargs)
1352
1353 def UnionBitmapColour(*args, **kwargs):
1354 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1355 return _gdi_.Region_UnionBitmapColour(*args, **kwargs)
1356
1357 _gdi_.Region_swigregister(Region)
1358
1359 def RegionFromBitmap(*args, **kwargs):
1360 """RegionFromBitmap(Bitmap bmp) -> Region"""
1361 val = _gdi_.new_RegionFromBitmap(*args, **kwargs)
1362 return val
1363
1364 def RegionFromBitmapColour(*args, **kwargs):
1365 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1366 val = _gdi_.new_RegionFromBitmapColour(*args, **kwargs)
1367 return val
1368
1369 def RegionFromPoints(*args, **kwargs):
1370 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
1371 val = _gdi_.new_RegionFromPoints(*args, **kwargs)
1372 return val
1373
1374 class RegionIterator(_core.Object):
1375 """Proxy of C++ RegionIterator class"""
1376 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1377 __repr__ = _swig_repr
1378 def __init__(self, *args, **kwargs):
1379 """__init__(self, Region region) -> RegionIterator"""
1380 _gdi_.RegionIterator_swiginit(self,_gdi_.new_RegionIterator(*args, **kwargs))
1381 __swig_destroy__ = _gdi_.delete_RegionIterator
1382 __del__ = lambda self : None;
1383 def GetX(*args, **kwargs):
1384 """GetX(self) -> int"""
1385 return _gdi_.RegionIterator_GetX(*args, **kwargs)
1386
1387 def GetY(*args, **kwargs):
1388 """GetY(self) -> int"""
1389 return _gdi_.RegionIterator_GetY(*args, **kwargs)
1390
1391 def GetW(*args, **kwargs):
1392 """GetW(self) -> int"""
1393 return _gdi_.RegionIterator_GetW(*args, **kwargs)
1394
1395 def GetWidth(*args, **kwargs):
1396 """GetWidth(self) -> int"""
1397 return _gdi_.RegionIterator_GetWidth(*args, **kwargs)
1398
1399 def GetH(*args, **kwargs):
1400 """GetH(self) -> int"""
1401 return _gdi_.RegionIterator_GetH(*args, **kwargs)
1402
1403 def GetHeight(*args, **kwargs):
1404 """GetHeight(self) -> int"""
1405 return _gdi_.RegionIterator_GetHeight(*args, **kwargs)
1406
1407 def GetRect(*args, **kwargs):
1408 """GetRect(self) -> Rect"""
1409 return _gdi_.RegionIterator_GetRect(*args, **kwargs)
1410
1411 def HaveRects(*args, **kwargs):
1412 """HaveRects(self) -> bool"""
1413 return _gdi_.RegionIterator_HaveRects(*args, **kwargs)
1414
1415 def Reset(*args, **kwargs):
1416 """Reset(self)"""
1417 return _gdi_.RegionIterator_Reset(*args, **kwargs)
1418
1419 def Next(*args, **kwargs):
1420 """Next(self)"""
1421 return _gdi_.RegionIterator_Next(*args, **kwargs)
1422
1423 def __nonzero__(*args, **kwargs):
1424 """__nonzero__(self) -> bool"""
1425 return _gdi_.RegionIterator___nonzero__(*args, **kwargs)
1426
1427 _gdi_.RegionIterator_swigregister(RegionIterator)
1428
1429 #---------------------------------------------------------------------------
1430
1431 FONTFAMILY_DEFAULT = _gdi_.FONTFAMILY_DEFAULT
1432 FONTFAMILY_DECORATIVE = _gdi_.FONTFAMILY_DECORATIVE
1433 FONTFAMILY_ROMAN = _gdi_.FONTFAMILY_ROMAN
1434 FONTFAMILY_SCRIPT = _gdi_.FONTFAMILY_SCRIPT
1435 FONTFAMILY_SWISS = _gdi_.FONTFAMILY_SWISS
1436 FONTFAMILY_MODERN = _gdi_.FONTFAMILY_MODERN
1437 FONTFAMILY_TELETYPE = _gdi_.FONTFAMILY_TELETYPE
1438 FONTFAMILY_MAX = _gdi_.FONTFAMILY_MAX
1439 FONTFAMILY_UNKNOWN = _gdi_.FONTFAMILY_UNKNOWN
1440 FONTSTYLE_NORMAL = _gdi_.FONTSTYLE_NORMAL
1441 FONTSTYLE_ITALIC = _gdi_.FONTSTYLE_ITALIC
1442 FONTSTYLE_SLANT = _gdi_.FONTSTYLE_SLANT
1443 FONTSTYLE_MAX = _gdi_.FONTSTYLE_MAX
1444 FONTWEIGHT_NORMAL = _gdi_.FONTWEIGHT_NORMAL
1445 FONTWEIGHT_LIGHT = _gdi_.FONTWEIGHT_LIGHT
1446 FONTWEIGHT_BOLD = _gdi_.FONTWEIGHT_BOLD
1447 FONTWEIGHT_MAX = _gdi_.FONTWEIGHT_MAX
1448 FONTFLAG_DEFAULT = _gdi_.FONTFLAG_DEFAULT
1449 FONTFLAG_ITALIC = _gdi_.FONTFLAG_ITALIC
1450 FONTFLAG_SLANT = _gdi_.FONTFLAG_SLANT
1451 FONTFLAG_LIGHT = _gdi_.FONTFLAG_LIGHT
1452 FONTFLAG_BOLD = _gdi_.FONTFLAG_BOLD
1453 FONTFLAG_ANTIALIASED = _gdi_.FONTFLAG_ANTIALIASED
1454 FONTFLAG_NOT_ANTIALIASED = _gdi_.FONTFLAG_NOT_ANTIALIASED
1455 FONTFLAG_UNDERLINED = _gdi_.FONTFLAG_UNDERLINED
1456 FONTFLAG_STRIKETHROUGH = _gdi_.FONTFLAG_STRIKETHROUGH
1457 FONTFLAG_MASK = _gdi_.FONTFLAG_MASK
1458 FONTENCODING_SYSTEM = _gdi_.FONTENCODING_SYSTEM
1459 FONTENCODING_DEFAULT = _gdi_.FONTENCODING_DEFAULT
1460 FONTENCODING_ISO8859_1 = _gdi_.FONTENCODING_ISO8859_1
1461 FONTENCODING_ISO8859_2 = _gdi_.FONTENCODING_ISO8859_2
1462 FONTENCODING_ISO8859_3 = _gdi_.FONTENCODING_ISO8859_3
1463 FONTENCODING_ISO8859_4 = _gdi_.FONTENCODING_ISO8859_4
1464 FONTENCODING_ISO8859_5 = _gdi_.FONTENCODING_ISO8859_5
1465 FONTENCODING_ISO8859_6 = _gdi_.FONTENCODING_ISO8859_6
1466 FONTENCODING_ISO8859_7 = _gdi_.FONTENCODING_ISO8859_7
1467 FONTENCODING_ISO8859_8 = _gdi_.FONTENCODING_ISO8859_8
1468 FONTENCODING_ISO8859_9 = _gdi_.FONTENCODING_ISO8859_9
1469 FONTENCODING_ISO8859_10 = _gdi_.FONTENCODING_ISO8859_10
1470 FONTENCODING_ISO8859_11 = _gdi_.FONTENCODING_ISO8859_11
1471 FONTENCODING_ISO8859_12 = _gdi_.FONTENCODING_ISO8859_12
1472 FONTENCODING_ISO8859_13 = _gdi_.FONTENCODING_ISO8859_13
1473 FONTENCODING_ISO8859_14 = _gdi_.FONTENCODING_ISO8859_14
1474 FONTENCODING_ISO8859_15 = _gdi_.FONTENCODING_ISO8859_15
1475 FONTENCODING_ISO8859_MAX = _gdi_.FONTENCODING_ISO8859_MAX
1476 FONTENCODING_KOI8 = _gdi_.FONTENCODING_KOI8
1477 FONTENCODING_KOI8_U = _gdi_.FONTENCODING_KOI8_U
1478 FONTENCODING_ALTERNATIVE = _gdi_.FONTENCODING_ALTERNATIVE
1479 FONTENCODING_BULGARIAN = _gdi_.FONTENCODING_BULGARIAN
1480 FONTENCODING_CP437 = _gdi_.FONTENCODING_CP437
1481 FONTENCODING_CP850 = _gdi_.FONTENCODING_CP850
1482 FONTENCODING_CP852 = _gdi_.FONTENCODING_CP852
1483 FONTENCODING_CP855 = _gdi_.FONTENCODING_CP855
1484 FONTENCODING_CP866 = _gdi_.FONTENCODING_CP866
1485 FONTENCODING_CP874 = _gdi_.FONTENCODING_CP874
1486 FONTENCODING_CP932 = _gdi_.FONTENCODING_CP932
1487 FONTENCODING_CP936 = _gdi_.FONTENCODING_CP936
1488 FONTENCODING_CP949 = _gdi_.FONTENCODING_CP949
1489 FONTENCODING_CP950 = _gdi_.FONTENCODING_CP950
1490 FONTENCODING_CP1250 = _gdi_.FONTENCODING_CP1250
1491 FONTENCODING_CP1251 = _gdi_.FONTENCODING_CP1251
1492 FONTENCODING_CP1252 = _gdi_.FONTENCODING_CP1252
1493 FONTENCODING_CP1253 = _gdi_.FONTENCODING_CP1253
1494 FONTENCODING_CP1254 = _gdi_.FONTENCODING_CP1254
1495 FONTENCODING_CP1255 = _gdi_.FONTENCODING_CP1255
1496 FONTENCODING_CP1256 = _gdi_.FONTENCODING_CP1256
1497 FONTENCODING_CP1257 = _gdi_.FONTENCODING_CP1257
1498 FONTENCODING_CP12_MAX = _gdi_.FONTENCODING_CP12_MAX
1499 FONTENCODING_UTF7 = _gdi_.FONTENCODING_UTF7
1500 FONTENCODING_UTF8 = _gdi_.FONTENCODING_UTF8
1501 FONTENCODING_EUC_JP = _gdi_.FONTENCODING_EUC_JP
1502 FONTENCODING_UTF16BE = _gdi_.FONTENCODING_UTF16BE
1503 FONTENCODING_UTF16LE = _gdi_.FONTENCODING_UTF16LE
1504 FONTENCODING_UTF32BE = _gdi_.FONTENCODING_UTF32BE
1505 FONTENCODING_UTF32LE = _gdi_.FONTENCODING_UTF32LE
1506 FONTENCODING_MACROMAN = _gdi_.FONTENCODING_MACROMAN
1507 FONTENCODING_MACJAPANESE = _gdi_.FONTENCODING_MACJAPANESE
1508 FONTENCODING_MACCHINESETRAD = _gdi_.FONTENCODING_MACCHINESETRAD
1509 FONTENCODING_MACKOREAN = _gdi_.FONTENCODING_MACKOREAN
1510 FONTENCODING_MACARABIC = _gdi_.FONTENCODING_MACARABIC
1511 FONTENCODING_MACHEBREW = _gdi_.FONTENCODING_MACHEBREW
1512 FONTENCODING_MACGREEK = _gdi_.FONTENCODING_MACGREEK
1513 FONTENCODING_MACCYRILLIC = _gdi_.FONTENCODING_MACCYRILLIC
1514 FONTENCODING_MACDEVANAGARI = _gdi_.FONTENCODING_MACDEVANAGARI
1515 FONTENCODING_MACGURMUKHI = _gdi_.FONTENCODING_MACGURMUKHI
1516 FONTENCODING_MACGUJARATI = _gdi_.FONTENCODING_MACGUJARATI
1517 FONTENCODING_MACORIYA = _gdi_.FONTENCODING_MACORIYA
1518 FONTENCODING_MACBENGALI = _gdi_.FONTENCODING_MACBENGALI
1519 FONTENCODING_MACTAMIL = _gdi_.FONTENCODING_MACTAMIL
1520 FONTENCODING_MACTELUGU = _gdi_.FONTENCODING_MACTELUGU
1521 FONTENCODING_MACKANNADA = _gdi_.FONTENCODING_MACKANNADA
1522 FONTENCODING_MACMALAJALAM = _gdi_.FONTENCODING_MACMALAJALAM
1523 FONTENCODING_MACSINHALESE = _gdi_.FONTENCODING_MACSINHALESE
1524 FONTENCODING_MACBURMESE = _gdi_.FONTENCODING_MACBURMESE
1525 FONTENCODING_MACKHMER = _gdi_.FONTENCODING_MACKHMER
1526 FONTENCODING_MACTHAI = _gdi_.FONTENCODING_MACTHAI
1527 FONTENCODING_MACLAOTIAN = _gdi_.FONTENCODING_MACLAOTIAN
1528 FONTENCODING_MACGEORGIAN = _gdi_.FONTENCODING_MACGEORGIAN
1529 FONTENCODING_MACARMENIAN = _gdi_.FONTENCODING_MACARMENIAN
1530 FONTENCODING_MACCHINESESIMP = _gdi_.FONTENCODING_MACCHINESESIMP
1531 FONTENCODING_MACTIBETAN = _gdi_.FONTENCODING_MACTIBETAN
1532 FONTENCODING_MACMONGOLIAN = _gdi_.FONTENCODING_MACMONGOLIAN
1533 FONTENCODING_MACETHIOPIC = _gdi_.FONTENCODING_MACETHIOPIC
1534 FONTENCODING_MACCENTRALEUR = _gdi_.FONTENCODING_MACCENTRALEUR
1535 FONTENCODING_MACVIATNAMESE = _gdi_.FONTENCODING_MACVIATNAMESE
1536 FONTENCODING_MACARABICEXT = _gdi_.FONTENCODING_MACARABICEXT
1537 FONTENCODING_MACSYMBOL = _gdi_.FONTENCODING_MACSYMBOL
1538 FONTENCODING_MACDINGBATS = _gdi_.FONTENCODING_MACDINGBATS
1539 FONTENCODING_MACTURKISH = _gdi_.FONTENCODING_MACTURKISH
1540 FONTENCODING_MACCROATIAN = _gdi_.FONTENCODING_MACCROATIAN
1541 FONTENCODING_MACICELANDIC = _gdi_.FONTENCODING_MACICELANDIC
1542 FONTENCODING_MACROMANIAN = _gdi_.FONTENCODING_MACROMANIAN
1543 FONTENCODING_MACCELTIC = _gdi_.FONTENCODING_MACCELTIC
1544 FONTENCODING_MACGAELIC = _gdi_.FONTENCODING_MACGAELIC
1545 FONTENCODING_MACKEYBOARD = _gdi_.FONTENCODING_MACKEYBOARD
1546 FONTENCODING_MACMIN = _gdi_.FONTENCODING_MACMIN
1547 FONTENCODING_MACMAX = _gdi_.FONTENCODING_MACMAX
1548 FONTENCODING_MAX = _gdi_.FONTENCODING_MAX
1549 FONTENCODING_UTF16 = _gdi_.FONTENCODING_UTF16
1550 FONTENCODING_UTF32 = _gdi_.FONTENCODING_UTF32
1551 FONTENCODING_UNICODE = _gdi_.FONTENCODING_UNICODE
1552 FONTENCODING_GB2312 = _gdi_.FONTENCODING_GB2312
1553 FONTENCODING_BIG5 = _gdi_.FONTENCODING_BIG5
1554 FONTENCODING_SHIFT_JIS = _gdi_.FONTENCODING_SHIFT_JIS
1555 #---------------------------------------------------------------------------
1556
1557 class NativeFontInfo(object):
1558 """Proxy of C++ NativeFontInfo class"""
1559 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1560 __repr__ = _swig_repr
1561 def __init__(self, *args, **kwargs):
1562 """__init__(self) -> NativeFontInfo"""
1563 _gdi_.NativeFontInfo_swiginit(self,_gdi_.new_NativeFontInfo(*args, **kwargs))
1564 __swig_destroy__ = _gdi_.delete_NativeFontInfo
1565 __del__ = lambda self : None;
1566 def Init(*args, **kwargs):
1567 """Init(self)"""
1568 return _gdi_.NativeFontInfo_Init(*args, **kwargs)
1569
1570 def InitFromFont(*args, **kwargs):
1571 """InitFromFont(self, Font font)"""
1572 return _gdi_.NativeFontInfo_InitFromFont(*args, **kwargs)
1573
1574 def GetPointSize(*args, **kwargs):
1575 """GetPointSize(self) -> int"""
1576 return _gdi_.NativeFontInfo_GetPointSize(*args, **kwargs)
1577
1578 def GetStyle(*args, **kwargs):
1579 """GetStyle(self) -> int"""
1580 return _gdi_.NativeFontInfo_GetStyle(*args, **kwargs)
1581
1582 def GetWeight(*args, **kwargs):
1583 """GetWeight(self) -> int"""
1584 return _gdi_.NativeFontInfo_GetWeight(*args, **kwargs)
1585
1586 def GetUnderlined(*args, **kwargs):
1587 """GetUnderlined(self) -> bool"""
1588 return _gdi_.NativeFontInfo_GetUnderlined(*args, **kwargs)
1589
1590 def GetFaceName(*args, **kwargs):
1591 """GetFaceName(self) -> String"""
1592 return _gdi_.NativeFontInfo_GetFaceName(*args, **kwargs)
1593
1594 def GetFamily(*args, **kwargs):
1595 """GetFamily(self) -> int"""
1596 return _gdi_.NativeFontInfo_GetFamily(*args, **kwargs)
1597
1598 def GetEncoding(*args, **kwargs):
1599 """GetEncoding(self) -> int"""
1600 return _gdi_.NativeFontInfo_GetEncoding(*args, **kwargs)
1601
1602 def SetPointSize(*args, **kwargs):
1603 """SetPointSize(self, int pointsize)"""
1604 return _gdi_.NativeFontInfo_SetPointSize(*args, **kwargs)
1605
1606 def SetStyle(*args, **kwargs):
1607 """SetStyle(self, int style)"""
1608 return _gdi_.NativeFontInfo_SetStyle(*args, **kwargs)
1609
1610 def SetWeight(*args, **kwargs):
1611 """SetWeight(self, int weight)"""
1612 return _gdi_.NativeFontInfo_SetWeight(*args, **kwargs)
1613
1614 def SetUnderlined(*args, **kwargs):
1615 """SetUnderlined(self, bool underlined)"""
1616 return _gdi_.NativeFontInfo_SetUnderlined(*args, **kwargs)
1617
1618 def SetFaceName(*args, **kwargs):
1619 """SetFaceName(self, String facename) -> bool"""
1620 return _gdi_.NativeFontInfo_SetFaceName(*args, **kwargs)
1621
1622 def SetFamily(*args, **kwargs):
1623 """SetFamily(self, int family)"""
1624 return _gdi_.NativeFontInfo_SetFamily(*args, **kwargs)
1625
1626 def SetEncoding(*args, **kwargs):
1627 """SetEncoding(self, int encoding)"""
1628 return _gdi_.NativeFontInfo_SetEncoding(*args, **kwargs)
1629
1630 def FromString(*args, **kwargs):
1631 """FromString(self, String s) -> bool"""
1632 return _gdi_.NativeFontInfo_FromString(*args, **kwargs)
1633
1634 def ToString(*args, **kwargs):
1635 """ToString(self) -> String"""
1636 return _gdi_.NativeFontInfo_ToString(*args, **kwargs)
1637
1638 def __str__(*args, **kwargs):
1639 """__str__(self) -> String"""
1640 return _gdi_.NativeFontInfo___str__(*args, **kwargs)
1641
1642 def FromUserString(*args, **kwargs):
1643 """FromUserString(self, String s) -> bool"""
1644 return _gdi_.NativeFontInfo_FromUserString(*args, **kwargs)
1645
1646 def ToUserString(*args, **kwargs):
1647 """ToUserString(self) -> String"""
1648 return _gdi_.NativeFontInfo_ToUserString(*args, **kwargs)
1649
1650 _gdi_.NativeFontInfo_swigregister(NativeFontInfo)
1651
1652 class NativeEncodingInfo(object):
1653 """Proxy of C++ NativeEncodingInfo class"""
1654 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1655 __repr__ = _swig_repr
1656 facename = property(_gdi_.NativeEncodingInfo_facename_get, _gdi_.NativeEncodingInfo_facename_set)
1657 encoding = property(_gdi_.NativeEncodingInfo_encoding_get, _gdi_.NativeEncodingInfo_encoding_set)
1658 def __init__(self, *args, **kwargs):
1659 """__init__(self) -> NativeEncodingInfo"""
1660 _gdi_.NativeEncodingInfo_swiginit(self,_gdi_.new_NativeEncodingInfo(*args, **kwargs))
1661 __swig_destroy__ = _gdi_.delete_NativeEncodingInfo
1662 __del__ = lambda self : None;
1663 def FromString(*args, **kwargs):
1664 """FromString(self, String s) -> bool"""
1665 return _gdi_.NativeEncodingInfo_FromString(*args, **kwargs)
1666
1667 def ToString(*args, **kwargs):
1668 """ToString(self) -> String"""
1669 return _gdi_.NativeEncodingInfo_ToString(*args, **kwargs)
1670
1671 _gdi_.NativeEncodingInfo_swigregister(NativeEncodingInfo)
1672
1673
1674 def GetNativeFontEncoding(*args, **kwargs):
1675 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
1676 return _gdi_.GetNativeFontEncoding(*args, **kwargs)
1677
1678 def TestFontEncoding(*args, **kwargs):
1679 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
1680 return _gdi_.TestFontEncoding(*args, **kwargs)
1681 #---------------------------------------------------------------------------
1682
1683 class FontMapper(object):
1684 """Proxy of C++ FontMapper class"""
1685 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1686 __repr__ = _swig_repr
1687 def __init__(self, *args, **kwargs):
1688 """__init__(self) -> FontMapper"""
1689 _gdi_.FontMapper_swiginit(self,_gdi_.new_FontMapper(*args, **kwargs))
1690 __swig_destroy__ = _gdi_.delete_FontMapper
1691 __del__ = lambda self : None;
1692 def Get(*args, **kwargs):
1693 """Get() -> FontMapper"""
1694 return _gdi_.FontMapper_Get(*args, **kwargs)
1695
1696 Get = staticmethod(Get)
1697 def Set(*args, **kwargs):
1698 """Set(FontMapper mapper) -> FontMapper"""
1699 return _gdi_.FontMapper_Set(*args, **kwargs)
1700
1701 Set = staticmethod(Set)
1702 def CharsetToEncoding(*args, **kwargs):
1703 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
1704 return _gdi_.FontMapper_CharsetToEncoding(*args, **kwargs)
1705
1706 def GetSupportedEncodingsCount(*args, **kwargs):
1707 """GetSupportedEncodingsCount() -> size_t"""
1708 return _gdi_.FontMapper_GetSupportedEncodingsCount(*args, **kwargs)
1709
1710 GetSupportedEncodingsCount = staticmethod(GetSupportedEncodingsCount)
1711 def GetEncoding(*args, **kwargs):
1712 """GetEncoding(size_t n) -> int"""
1713 return _gdi_.FontMapper_GetEncoding(*args, **kwargs)
1714
1715 GetEncoding = staticmethod(GetEncoding)
1716 def GetEncodingName(*args, **kwargs):
1717 """GetEncodingName(int encoding) -> String"""
1718 return _gdi_.FontMapper_GetEncodingName(*args, **kwargs)
1719
1720 GetEncodingName = staticmethod(GetEncodingName)
1721 def GetEncodingDescription(*args, **kwargs):
1722 """GetEncodingDescription(int encoding) -> String"""
1723 return _gdi_.FontMapper_GetEncodingDescription(*args, **kwargs)
1724
1725 GetEncodingDescription = staticmethod(GetEncodingDescription)
1726 def GetEncodingFromName(*args, **kwargs):
1727 """GetEncodingFromName(String name) -> int"""
1728 return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs)
1729
1730 GetEncodingFromName = staticmethod(GetEncodingFromName)
1731 def SetConfigPath(*args, **kwargs):
1732 """SetConfigPath(self, String prefix)"""
1733 return _gdi_.FontMapper_SetConfigPath(*args, **kwargs)
1734
1735 def GetDefaultConfigPath(*args, **kwargs):
1736 """GetDefaultConfigPath() -> String"""
1737 return _gdi_.FontMapper_GetDefaultConfigPath(*args, **kwargs)
1738
1739 GetDefaultConfigPath = staticmethod(GetDefaultConfigPath)
1740 def GetAltForEncoding(*args, **kwargs):
1741 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
1742 return _gdi_.FontMapper_GetAltForEncoding(*args, **kwargs)
1743
1744 def IsEncodingAvailable(*args, **kwargs):
1745 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
1746 return _gdi_.FontMapper_IsEncodingAvailable(*args, **kwargs)
1747
1748 def SetDialogParent(*args, **kwargs):
1749 """SetDialogParent(self, Window parent)"""
1750 return _gdi_.FontMapper_SetDialogParent(*args, **kwargs)
1751
1752 def SetDialogTitle(*args, **kwargs):
1753 """SetDialogTitle(self, String title)"""
1754 return _gdi_.FontMapper_SetDialogTitle(*args, **kwargs)
1755
1756 _gdi_.FontMapper_swigregister(FontMapper)
1757
1758 def FontMapper_Get(*args):
1759 """FontMapper_Get() -> FontMapper"""
1760 return _gdi_.FontMapper_Get(*args)
1761
1762 def FontMapper_Set(*args, **kwargs):
1763 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
1764 return _gdi_.FontMapper_Set(*args, **kwargs)
1765
1766 def FontMapper_GetSupportedEncodingsCount(*args):
1767 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
1768 return _gdi_.FontMapper_GetSupportedEncodingsCount(*args)
1769
1770 def FontMapper_GetEncoding(*args, **kwargs):
1771 """FontMapper_GetEncoding(size_t n) -> int"""
1772 return _gdi_.FontMapper_GetEncoding(*args, **kwargs)
1773
1774 def FontMapper_GetEncodingName(*args, **kwargs):
1775 """FontMapper_GetEncodingName(int encoding) -> String"""
1776 return _gdi_.FontMapper_GetEncodingName(*args, **kwargs)
1777
1778 def FontMapper_GetEncodingDescription(*args, **kwargs):
1779 """FontMapper_GetEncodingDescription(int encoding) -> String"""
1780 return _gdi_.FontMapper_GetEncodingDescription(*args, **kwargs)
1781
1782 def FontMapper_GetEncodingFromName(*args, **kwargs):
1783 """FontMapper_GetEncodingFromName(String name) -> int"""
1784 return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs)
1785
1786 def FontMapper_GetDefaultConfigPath(*args):
1787 """FontMapper_GetDefaultConfigPath() -> String"""
1788 return _gdi_.FontMapper_GetDefaultConfigPath(*args)
1789
1790 #---------------------------------------------------------------------------
1791
1792 class Font(GDIObject):
1793 """
1794 A font is an object which determines the appearance of text. Fonts are
1795 used for drawing text to a device context, and setting the appearance
1796 of a window's text.
1797
1798 You can retrieve the current system font settings with `wx.SystemSettings`.
1799 """
1800 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1801 __repr__ = _swig_repr
1802 def __init__(self, *args, **kwargs):
1803 """
1804 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
1805 String face=EmptyString,
1806 int encoding=FONTENCODING_DEFAULT) -> Font
1807
1808 Creates a font object with the specified attributes.
1809
1810 :param pointSize: The size of the font in points.
1811
1812 :param family: Font family. A generic way of referring to fonts
1813 without specifying actual facename. It can be One of
1814 the ``wx.FONTFAMILY_xxx`` constants.
1815
1816 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1817
1818 :param weight: Font weight, sometimes also referred to as font
1819 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1820
1821 :param underline: The value can be ``True`` or ``False`` and
1822 indicates whether the font will include an underline. This
1823 may not be supported on all platforms.
1824
1825 :param face: An optional string specifying the actual typeface to
1826 be used. If it is an empty string, a default typeface will be
1827 chosen based on the family.
1828
1829 :param encoding: An encoding which may be one of the
1830 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1831 available, no font is created.
1832
1833 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1834 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1835
1836 """
1837 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
1838 _gdi_.Font_swiginit(self,_gdi_.new_Font(*args, **kwargs))
1839 __swig_destroy__ = _gdi_.delete_Font
1840 __del__ = lambda self : None;
1841 def Ok(*args, **kwargs):
1842 """
1843 Ok(self) -> bool
1844
1845 Returns ``True`` if this font was successfully created.
1846 """
1847 return _gdi_.Font_Ok(*args, **kwargs)
1848
1849 def __nonzero__(self): return self.Ok()
1850 def __eq__(*args, **kwargs):
1851 """__eq__(self, Font other) -> bool"""
1852 return _gdi_.Font___eq__(*args, **kwargs)
1853
1854 def __ne__(*args, **kwargs):
1855 """__ne__(self, Font other) -> bool"""
1856 return _gdi_.Font___ne__(*args, **kwargs)
1857
1858 def GetPointSize(*args, **kwargs):
1859 """
1860 GetPointSize(self) -> int
1861
1862 Gets the point size.
1863 """
1864 return _gdi_.Font_GetPointSize(*args, **kwargs)
1865
1866 def GetPixelSize(*args, **kwargs):
1867 """
1868 GetPixelSize(self) -> Size
1869
1870 Returns the size in pixels if the font was constructed with a pixel
1871 size.
1872 """
1873 return _gdi_.Font_GetPixelSize(*args, **kwargs)
1874
1875 def IsUsingSizeInPixels(*args, **kwargs):
1876 """
1877 IsUsingSizeInPixels(self) -> bool
1878
1879 Returns ``True`` if the font is using a pixelSize.
1880 """
1881 return _gdi_.Font_IsUsingSizeInPixels(*args, **kwargs)
1882
1883 def GetFamily(*args, **kwargs):
1884 """
1885 GetFamily(self) -> int
1886
1887 Gets the font family.
1888 """
1889 return _gdi_.Font_GetFamily(*args, **kwargs)
1890
1891 def GetStyle(*args, **kwargs):
1892 """
1893 GetStyle(self) -> int
1894
1895 Gets the font style.
1896 """
1897 return _gdi_.Font_GetStyle(*args, **kwargs)
1898
1899 def GetWeight(*args, **kwargs):
1900 """
1901 GetWeight(self) -> int
1902
1903 Gets the font weight.
1904 """
1905 return _gdi_.Font_GetWeight(*args, **kwargs)
1906
1907 def GetUnderlined(*args, **kwargs):
1908 """
1909 GetUnderlined(self) -> bool
1910
1911 Returns ``True`` if the font is underlined, ``False`` otherwise.
1912 """
1913 return _gdi_.Font_GetUnderlined(*args, **kwargs)
1914
1915 def GetFaceName(*args, **kwargs):
1916 """
1917 GetFaceName(self) -> String
1918
1919 Returns the typeface name associated with the font, or the empty
1920 string if there is no typeface information.
1921 """
1922 return _gdi_.Font_GetFaceName(*args, **kwargs)
1923
1924 def GetEncoding(*args, **kwargs):
1925 """
1926 GetEncoding(self) -> int
1927
1928 Get the font's encoding.
1929 """
1930 return _gdi_.Font_GetEncoding(*args, **kwargs)
1931
1932 def GetNativeFontInfo(*args, **kwargs):
1933 """
1934 GetNativeFontInfo(self) -> NativeFontInfo
1935
1936 Constructs a `wx.NativeFontInfo` object from this font.
1937 """
1938 return _gdi_.Font_GetNativeFontInfo(*args, **kwargs)
1939
1940 def IsFixedWidth(*args, **kwargs):
1941 """
1942 IsFixedWidth(self) -> bool
1943
1944 Returns true if the font is a fixed width (or monospaced) font, false
1945 if it is a proportional one or font is invalid.
1946 """
1947 return _gdi_.Font_IsFixedWidth(*args, **kwargs)
1948
1949 def GetNativeFontInfoDesc(*args, **kwargs):
1950 """
1951 GetNativeFontInfoDesc(self) -> String
1952
1953 Returns the platform-dependent string completely describing this font
1954 or an empty string if the font isn't valid.
1955 """
1956 return _gdi_.Font_GetNativeFontInfoDesc(*args, **kwargs)
1957
1958 def GetNativeFontInfoUserDesc(*args, **kwargs):
1959 """
1960 GetNativeFontInfoUserDesc(self) -> String
1961
1962 Returns a human readable version of `GetNativeFontInfoDesc`.
1963 """
1964 return _gdi_.Font_GetNativeFontInfoUserDesc(*args, **kwargs)
1965
1966 def SetPointSize(*args, **kwargs):
1967 """
1968 SetPointSize(self, int pointSize)
1969
1970 Sets the point size.
1971 """
1972 return _gdi_.Font_SetPointSize(*args, **kwargs)
1973
1974 def SetPixelSize(*args, **kwargs):
1975 """
1976 SetPixelSize(self, Size pixelSize)
1977
1978 Sets the size in pixels rather than points. If there is platform API
1979 support for this then it is used, otherwise a font with the closest
1980 size is found using a binary search.
1981 """
1982 return _gdi_.Font_SetPixelSize(*args, **kwargs)
1983
1984 def SetFamily(*args, **kwargs):
1985 """
1986 SetFamily(self, int family)
1987
1988 Sets the font family.
1989 """
1990 return _gdi_.Font_SetFamily(*args, **kwargs)
1991
1992 def SetStyle(*args, **kwargs):
1993 """
1994 SetStyle(self, int style)
1995
1996 Sets the font style.
1997 """
1998 return _gdi_.Font_SetStyle(*args, **kwargs)
1999
2000 def SetWeight(*args, **kwargs):
2001 """
2002 SetWeight(self, int weight)
2003
2004 Sets the font weight.
2005 """
2006 return _gdi_.Font_SetWeight(*args, **kwargs)
2007
2008 def SetFaceName(*args, **kwargs):
2009 """
2010 SetFaceName(self, String faceName) -> bool
2011
2012 Sets the facename for the font. The facename, which should be a valid
2013 font installed on the end-user's system.
2014
2015 To avoid portability problems, don't rely on a specific face, but
2016 specify the font family instead or as well. A suitable font will be
2017 found on the end-user's system. If both the family and the facename
2018 are specified, wxWidgets will first search for the specific face, and
2019 then for a font belonging to the same family.
2020 """
2021 return _gdi_.Font_SetFaceName(*args, **kwargs)
2022
2023 def SetUnderlined(*args, **kwargs):
2024 """
2025 SetUnderlined(self, bool underlined)
2026
2027 Sets underlining.
2028 """
2029 return _gdi_.Font_SetUnderlined(*args, **kwargs)
2030
2031 def SetEncoding(*args, **kwargs):
2032 """
2033 SetEncoding(self, int encoding)
2034
2035 Set the font encoding.
2036 """
2037 return _gdi_.Font_SetEncoding(*args, **kwargs)
2038
2039 def SetNativeFontInfo(*args, **kwargs):
2040 """
2041 SetNativeFontInfo(self, NativeFontInfo info)
2042
2043 Set the font's attributes from a `wx.NativeFontInfo` object.
2044 """
2045 return _gdi_.Font_SetNativeFontInfo(*args, **kwargs)
2046
2047 def SetNativeFontInfoFromString(*args, **kwargs):
2048 """
2049 SetNativeFontInfoFromString(self, String info) -> bool
2050
2051 Set the font's attributes from string representation of a
2052 `wx.NativeFontInfo` object.
2053 """
2054 return _gdi_.Font_SetNativeFontInfoFromString(*args, **kwargs)
2055
2056 def SetNativeFontInfoUserDesc(*args, **kwargs):
2057 """
2058 SetNativeFontInfoUserDesc(self, String info) -> bool
2059
2060 Set the font's attributes from a string formerly returned from
2061 `GetNativeFontInfoDesc`.
2062 """
2063 return _gdi_.Font_SetNativeFontInfoUserDesc(*args, **kwargs)
2064
2065 def GetFamilyString(*args, **kwargs):
2066 """
2067 GetFamilyString(self) -> String
2068
2069 Returns a string representation of the font family.
2070 """
2071 return _gdi_.Font_GetFamilyString(*args, **kwargs)
2072
2073 def GetStyleString(*args, **kwargs):
2074 """
2075 GetStyleString(self) -> String
2076
2077 Returns a string representation of the font style.
2078 """
2079 return _gdi_.Font_GetStyleString(*args, **kwargs)
2080
2081 def GetWeightString(*args, **kwargs):
2082 """
2083 GetWeightString(self) -> String
2084
2085 Return a string representation of the font weight.
2086 """
2087 return _gdi_.Font_GetWeightString(*args, **kwargs)
2088
2089 def SetNoAntiAliasing(*args, **kwargs):
2090 """SetNoAntiAliasing(self, bool no=True)"""
2091 return _gdi_.Font_SetNoAntiAliasing(*args, **kwargs)
2092
2093 def GetNoAntiAliasing(*args, **kwargs):
2094 """GetNoAntiAliasing(self) -> bool"""
2095 return _gdi_.Font_GetNoAntiAliasing(*args, **kwargs)
2096
2097 def GetDefaultEncoding(*args, **kwargs):
2098 """
2099 GetDefaultEncoding() -> int
2100
2101 Returns the encoding used for all fonts created with an encoding of
2102 ``wx.FONTENCODING_DEFAULT``.
2103 """
2104 return _gdi_.Font_GetDefaultEncoding(*args, **kwargs)
2105
2106 GetDefaultEncoding = staticmethod(GetDefaultEncoding)
2107 def SetDefaultEncoding(*args, **kwargs):
2108 """
2109 SetDefaultEncoding(int encoding)
2110
2111 Sets the default font encoding.
2112 """
2113 return _gdi_.Font_SetDefaultEncoding(*args, **kwargs)
2114
2115 SetDefaultEncoding = staticmethod(SetDefaultEncoding)
2116 _gdi_.Font_swigregister(Font)
2117
2118 def FontFromNativeInfo(*args, **kwargs):
2119 """
2120 FontFromNativeInfo(NativeFontInfo info) -> Font
2121
2122 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
2123 """
2124 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2125 val = _gdi_.new_FontFromNativeInfo(*args, **kwargs)
2126 return val
2127
2128 def FontFromNativeInfoString(*args, **kwargs):
2129 """
2130 FontFromNativeInfoString(String info) -> Font
2131
2132 Construct a `wx.Font` from the string representation of a
2133 `wx.NativeFontInfo` object.
2134 """
2135 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2136 val = _gdi_.new_FontFromNativeInfoString(*args, **kwargs)
2137 return val
2138
2139 def FFont(*args, **kwargs):
2140 """
2141 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
2142 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2143
2144 A bit of a simpler way to create a `wx.Font` using flags instead of
2145 individual attribute settings. The value of flags can be a
2146 combination of the following:
2147
2148 ============================ ==
2149 wx.FONTFLAG_DEFAULT
2150 wx.FONTFLAG_ITALIC
2151 wx.FONTFLAG_SLANT
2152 wx.FONTFLAG_LIGHT
2153 wx.FONTFLAG_BOLD
2154 wx.FONTFLAG_ANTIALIASED
2155 wx.FONTFLAG_NOT_ANTIALIASED
2156 wx.FONTFLAG_UNDERLINED
2157 wx.FONTFLAG_STRIKETHROUGH
2158 ============================ ==
2159
2160 :see: `wx.Font.__init__`
2161 """
2162 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2163 val = _gdi_.new_FFont(*args, **kwargs)
2164 return val
2165
2166 def FontFromPixelSize(*args, **kwargs):
2167 """
2168 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
2169 bool underlined=False, String face=wxEmptyString,
2170 int encoding=FONTENCODING_DEFAULT) -> Font
2171
2172 Creates a font using a size in pixels rather than points. If there is
2173 platform API support for this then it is used, otherwise a font with
2174 the closest size is found using a binary search.
2175
2176 :see: `wx.Font.__init__`
2177 """
2178 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2179 val = _gdi_.new_FontFromPixelSize(*args, **kwargs)
2180 return val
2181
2182 def FFontFromPixelSize(*args, **kwargs):
2183 """
2184 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
2185 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2186
2187 Creates a font using a size in pixels rather than points. If there is
2188 platform API support for this then it is used, otherwise a font with
2189 the closest size is found using a binary search.
2190
2191 :see: `wx.Font.__init__`, `wx.FFont`
2192 """
2193 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2194 val = _gdi_.new_FFontFromPixelSize(*args, **kwargs)
2195 return val
2196
2197 def Font_GetDefaultEncoding(*args):
2198 """
2199 Font_GetDefaultEncoding() -> int
2200
2201 Returns the encoding used for all fonts created with an encoding of
2202 ``wx.FONTENCODING_DEFAULT``.
2203 """
2204 return _gdi_.Font_GetDefaultEncoding(*args)
2205
2206 def Font_SetDefaultEncoding(*args, **kwargs):
2207 """
2208 Font_SetDefaultEncoding(int encoding)
2209
2210 Sets the default font encoding.
2211 """
2212 return _gdi_.Font_SetDefaultEncoding(*args, **kwargs)
2213
2214 Font2 = wx._deprecated(FFont, "Use `wx.FFont` instead.")
2215 #---------------------------------------------------------------------------
2216
2217 class FontEnumerator(object):
2218 """Proxy of C++ FontEnumerator class"""
2219 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2220 __repr__ = _swig_repr
2221 def __init__(self, *args, **kwargs):
2222 """__init__(self) -> FontEnumerator"""
2223 _gdi_.FontEnumerator_swiginit(self,_gdi_.new_FontEnumerator(*args, **kwargs))
2224 self._setCallbackInfo(self, FontEnumerator, 0)
2225
2226 __swig_destroy__ = _gdi_.delete_FontEnumerator
2227 __del__ = lambda self : None;
2228 def _setCallbackInfo(*args, **kwargs):
2229 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
2230 return _gdi_.FontEnumerator__setCallbackInfo(*args, **kwargs)
2231
2232 def EnumerateFacenames(*args, **kwargs):
2233 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
2234 return _gdi_.FontEnumerator_EnumerateFacenames(*args, **kwargs)
2235
2236 def EnumerateEncodings(*args, **kwargs):
2237 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
2238 return _gdi_.FontEnumerator_EnumerateEncodings(*args, **kwargs)
2239
2240 def GetEncodings(*args, **kwargs):
2241 """GetEncodings() -> PyObject"""
2242 return _gdi_.FontEnumerator_GetEncodings(*args, **kwargs)
2243
2244 GetEncodings = staticmethod(GetEncodings)
2245 def GetFacenames(*args, **kwargs):
2246 """GetFacenames() -> PyObject"""
2247 return _gdi_.FontEnumerator_GetFacenames(*args, **kwargs)
2248
2249 GetFacenames = staticmethod(GetFacenames)
2250 def IsValidFacename(*args, **kwargs):
2251 """
2252 IsValidFacename(String str) -> bool
2253
2254 Convenience function that returns true if the given face name exist in
2255 the user's system
2256 """
2257 return _gdi_.FontEnumerator_IsValidFacename(*args, **kwargs)
2258
2259 IsValidFacename = staticmethod(IsValidFacename)
2260 _gdi_.FontEnumerator_swigregister(FontEnumerator)
2261
2262 def FontEnumerator_GetEncodings(*args):
2263 """FontEnumerator_GetEncodings() -> PyObject"""
2264 return _gdi_.FontEnumerator_GetEncodings(*args)
2265
2266 def FontEnumerator_GetFacenames(*args):
2267 """FontEnumerator_GetFacenames() -> PyObject"""
2268 return _gdi_.FontEnumerator_GetFacenames(*args)
2269
2270 def FontEnumerator_IsValidFacename(*args, **kwargs):
2271 """
2272 FontEnumerator_IsValidFacename(String str) -> bool
2273
2274 Convenience function that returns true if the given face name exist in
2275 the user's system
2276 """
2277 return _gdi_.FontEnumerator_IsValidFacename(*args, **kwargs)
2278
2279 #---------------------------------------------------------------------------
2280
2281 LANGUAGE_DEFAULT = _gdi_.LANGUAGE_DEFAULT
2282 LANGUAGE_UNKNOWN = _gdi_.LANGUAGE_UNKNOWN
2283 LANGUAGE_ABKHAZIAN = _gdi_.LANGUAGE_ABKHAZIAN
2284 LANGUAGE_AFAR = _gdi_.LANGUAGE_AFAR
2285 LANGUAGE_AFRIKAANS = _gdi_.LANGUAGE_AFRIKAANS
2286 LANGUAGE_ALBANIAN = _gdi_.LANGUAGE_ALBANIAN
2287 LANGUAGE_AMHARIC = _gdi_.LANGUAGE_AMHARIC
2288 LANGUAGE_ARABIC = _gdi_.LANGUAGE_ARABIC
2289 LANGUAGE_ARABIC_ALGERIA = _gdi_.LANGUAGE_ARABIC_ALGERIA
2290 LANGUAGE_ARABIC_BAHRAIN = _gdi_.LANGUAGE_ARABIC_BAHRAIN
2291 LANGUAGE_ARABIC_EGYPT = _gdi_.LANGUAGE_ARABIC_EGYPT
2292 LANGUAGE_ARABIC_IRAQ = _gdi_.LANGUAGE_ARABIC_IRAQ
2293 LANGUAGE_ARABIC_JORDAN = _gdi_.LANGUAGE_ARABIC_JORDAN
2294 LANGUAGE_ARABIC_KUWAIT = _gdi_.LANGUAGE_ARABIC_KUWAIT
2295 LANGUAGE_ARABIC_LEBANON = _gdi_.LANGUAGE_ARABIC_LEBANON
2296 LANGUAGE_ARABIC_LIBYA = _gdi_.LANGUAGE_ARABIC_LIBYA
2297 LANGUAGE_ARABIC_MOROCCO = _gdi_.LANGUAGE_ARABIC_MOROCCO
2298 LANGUAGE_ARABIC_OMAN = _gdi_.LANGUAGE_ARABIC_OMAN
2299 LANGUAGE_ARABIC_QATAR = _gdi_.LANGUAGE_ARABIC_QATAR
2300 LANGUAGE_ARABIC_SAUDI_ARABIA = _gdi_.LANGUAGE_ARABIC_SAUDI_ARABIA
2301 LANGUAGE_ARABIC_SUDAN = _gdi_.LANGUAGE_ARABIC_SUDAN
2302 LANGUAGE_ARABIC_SYRIA = _gdi_.LANGUAGE_ARABIC_SYRIA
2303 LANGUAGE_ARABIC_TUNISIA = _gdi_.LANGUAGE_ARABIC_TUNISIA
2304 LANGUAGE_ARABIC_UAE = _gdi_.LANGUAGE_ARABIC_UAE
2305 LANGUAGE_ARABIC_YEMEN = _gdi_.LANGUAGE_ARABIC_YEMEN
2306 LANGUAGE_ARMENIAN = _gdi_.LANGUAGE_ARMENIAN
2307 LANGUAGE_ASSAMESE = _gdi_.LANGUAGE_ASSAMESE
2308 LANGUAGE_AYMARA = _gdi_.LANGUAGE_AYMARA
2309 LANGUAGE_AZERI = _gdi_.LANGUAGE_AZERI
2310 LANGUAGE_AZERI_CYRILLIC = _gdi_.LANGUAGE_AZERI_CYRILLIC
2311 LANGUAGE_AZERI_LATIN = _gdi_.LANGUAGE_AZERI_LATIN
2312 LANGUAGE_BASHKIR = _gdi_.LANGUAGE_BASHKIR
2313 LANGUAGE_BASQUE = _gdi_.LANGUAGE_BASQUE
2314 LANGUAGE_BELARUSIAN = _gdi_.LANGUAGE_BELARUSIAN
2315 LANGUAGE_BENGALI = _gdi_.LANGUAGE_BENGALI
2316 LANGUAGE_BHUTANI = _gdi_.LANGUAGE_BHUTANI
2317 LANGUAGE_BIHARI = _gdi_.LANGUAGE_BIHARI
2318 LANGUAGE_BISLAMA = _gdi_.LANGUAGE_BISLAMA
2319 LANGUAGE_BRETON = _gdi_.LANGUAGE_BRETON
2320 LANGUAGE_BULGARIAN = _gdi_.LANGUAGE_BULGARIAN
2321 LANGUAGE_BURMESE = _gdi_.LANGUAGE_BURMESE
2322 LANGUAGE_CAMBODIAN = _gdi_.LANGUAGE_CAMBODIAN
2323 LANGUAGE_CATALAN = _gdi_.LANGUAGE_CATALAN
2324 LANGUAGE_CHINESE = _gdi_.LANGUAGE_CHINESE
2325 LANGUAGE_CHINESE_SIMPLIFIED = _gdi_.LANGUAGE_CHINESE_SIMPLIFIED
2326 LANGUAGE_CHINESE_TRADITIONAL = _gdi_.LANGUAGE_CHINESE_TRADITIONAL
2327 LANGUAGE_CHINESE_HONGKONG = _gdi_.LANGUAGE_CHINESE_HONGKONG
2328 LANGUAGE_CHINESE_MACAU = _gdi_.LANGUAGE_CHINESE_MACAU
2329 LANGUAGE_CHINESE_SINGAPORE = _gdi_.LANGUAGE_CHINESE_SINGAPORE
2330 LANGUAGE_CHINESE_TAIWAN = _gdi_.LANGUAGE_CHINESE_TAIWAN
2331 LANGUAGE_CORSICAN = _gdi_.LANGUAGE_CORSICAN
2332 LANGUAGE_CROATIAN = _gdi_.LANGUAGE_CROATIAN
2333 LANGUAGE_CZECH = _gdi_.LANGUAGE_CZECH
2334 LANGUAGE_DANISH = _gdi_.LANGUAGE_DANISH
2335 LANGUAGE_DUTCH = _gdi_.LANGUAGE_DUTCH
2336 LANGUAGE_DUTCH_BELGIAN = _gdi_.LANGUAGE_DUTCH_BELGIAN
2337 LANGUAGE_ENGLISH = _gdi_.LANGUAGE_ENGLISH
2338 LANGUAGE_ENGLISH_UK = _gdi_.LANGUAGE_ENGLISH_UK
2339 LANGUAGE_ENGLISH_US = _gdi_.LANGUAGE_ENGLISH_US
2340 LANGUAGE_ENGLISH_AUSTRALIA = _gdi_.LANGUAGE_ENGLISH_AUSTRALIA
2341 LANGUAGE_ENGLISH_BELIZE = _gdi_.LANGUAGE_ENGLISH_BELIZE
2342 LANGUAGE_ENGLISH_BOTSWANA = _gdi_.LANGUAGE_ENGLISH_BOTSWANA
2343 LANGUAGE_ENGLISH_CANADA = _gdi_.LANGUAGE_ENGLISH_CANADA
2344 LANGUAGE_ENGLISH_CARIBBEAN = _gdi_.LANGUAGE_ENGLISH_CARIBBEAN
2345 LANGUAGE_ENGLISH_DENMARK = _gdi_.LANGUAGE_ENGLISH_DENMARK
2346 LANGUAGE_ENGLISH_EIRE = _gdi_.LANGUAGE_ENGLISH_EIRE
2347 LANGUAGE_ENGLISH_JAMAICA = _gdi_.LANGUAGE_ENGLISH_JAMAICA
2348 LANGUAGE_ENGLISH_NEW_ZEALAND = _gdi_.LANGUAGE_ENGLISH_NEW_ZEALAND
2349 LANGUAGE_ENGLISH_PHILIPPINES = _gdi_.LANGUAGE_ENGLISH_PHILIPPINES
2350 LANGUAGE_ENGLISH_SOUTH_AFRICA = _gdi_.LANGUAGE_ENGLISH_SOUTH_AFRICA
2351 LANGUAGE_ENGLISH_TRINIDAD = _gdi_.LANGUAGE_ENGLISH_TRINIDAD
2352 LANGUAGE_ENGLISH_ZIMBABWE = _gdi_.LANGUAGE_ENGLISH_ZIMBABWE
2353 LANGUAGE_ESPERANTO = _gdi_.LANGUAGE_ESPERANTO
2354 LANGUAGE_ESTONIAN = _gdi_.LANGUAGE_ESTONIAN
2355 LANGUAGE_FAEROESE = _gdi_.LANGUAGE_FAEROESE
2356 LANGUAGE_FARSI = _gdi_.LANGUAGE_FARSI
2357 LANGUAGE_FIJI = _gdi_.LANGUAGE_FIJI
2358 LANGUAGE_FINNISH = _gdi_.LANGUAGE_FINNISH
2359 LANGUAGE_FRENCH = _gdi_.LANGUAGE_FRENCH
2360 LANGUAGE_FRENCH_BELGIAN = _gdi_.LANGUAGE_FRENCH_BELGIAN
2361 LANGUAGE_FRENCH_CANADIAN = _gdi_.LANGUAGE_FRENCH_CANADIAN
2362 LANGUAGE_FRENCH_LUXEMBOURG = _gdi_.LANGUAGE_FRENCH_LUXEMBOURG
2363 LANGUAGE_FRENCH_MONACO = _gdi_.LANGUAGE_FRENCH_MONACO
2364 LANGUAGE_FRENCH_SWISS = _gdi_.LANGUAGE_FRENCH_SWISS
2365 LANGUAGE_FRISIAN = _gdi_.LANGUAGE_FRISIAN
2366 LANGUAGE_GALICIAN = _gdi_.LANGUAGE_GALICIAN
2367 LANGUAGE_GEORGIAN = _gdi_.LANGUAGE_GEORGIAN
2368 LANGUAGE_GERMAN = _gdi_.LANGUAGE_GERMAN
2369 LANGUAGE_GERMAN_AUSTRIAN = _gdi_.LANGUAGE_GERMAN_AUSTRIAN
2370 LANGUAGE_GERMAN_BELGIUM = _gdi_.LANGUAGE_GERMAN_BELGIUM
2371 LANGUAGE_GERMAN_LIECHTENSTEIN = _gdi_.LANGUAGE_GERMAN_LIECHTENSTEIN
2372 LANGUAGE_GERMAN_LUXEMBOURG = _gdi_.LANGUAGE_GERMAN_LUXEMBOURG
2373 LANGUAGE_GERMAN_SWISS = _gdi_.LANGUAGE_GERMAN_SWISS
2374 LANGUAGE_GREEK = _gdi_.LANGUAGE_GREEK
2375 LANGUAGE_GREENLANDIC = _gdi_.LANGUAGE_GREENLANDIC
2376 LANGUAGE_GUARANI = _gdi_.LANGUAGE_GUARANI
2377 LANGUAGE_GUJARATI = _gdi_.LANGUAGE_GUJARATI
2378 LANGUAGE_HAUSA = _gdi_.LANGUAGE_HAUSA
2379 LANGUAGE_HEBREW = _gdi_.LANGUAGE_HEBREW
2380 LANGUAGE_HINDI = _gdi_.LANGUAGE_HINDI
2381 LANGUAGE_HUNGARIAN = _gdi_.LANGUAGE_HUNGARIAN
2382 LANGUAGE_ICELANDIC = _gdi_.LANGUAGE_ICELANDIC
2383 LANGUAGE_INDONESIAN = _gdi_.LANGUAGE_INDONESIAN
2384 LANGUAGE_INTERLINGUA = _gdi_.LANGUAGE_INTERLINGUA
2385 LANGUAGE_INTERLINGUE = _gdi_.LANGUAGE_INTERLINGUE
2386 LANGUAGE_INUKTITUT = _gdi_.LANGUAGE_INUKTITUT
2387 LANGUAGE_INUPIAK = _gdi_.LANGUAGE_INUPIAK
2388 LANGUAGE_IRISH = _gdi_.LANGUAGE_IRISH
2389 LANGUAGE_ITALIAN = _gdi_.LANGUAGE_ITALIAN
2390 LANGUAGE_ITALIAN_SWISS = _gdi_.LANGUAGE_ITALIAN_SWISS
2391 LANGUAGE_JAPANESE = _gdi_.LANGUAGE_JAPANESE
2392 LANGUAGE_JAVANESE = _gdi_.LANGUAGE_JAVANESE
2393 LANGUAGE_KANNADA = _gdi_.LANGUAGE_KANNADA
2394 LANGUAGE_KASHMIRI = _gdi_.LANGUAGE_KASHMIRI
2395 LANGUAGE_KASHMIRI_INDIA = _gdi_.LANGUAGE_KASHMIRI_INDIA
2396 LANGUAGE_KAZAKH = _gdi_.LANGUAGE_KAZAKH
2397 LANGUAGE_KERNEWEK = _gdi_.LANGUAGE_KERNEWEK
2398 LANGUAGE_KINYARWANDA = _gdi_.LANGUAGE_KINYARWANDA
2399 LANGUAGE_KIRGHIZ = _gdi_.LANGUAGE_KIRGHIZ
2400 LANGUAGE_KIRUNDI = _gdi_.LANGUAGE_KIRUNDI
2401 LANGUAGE_KONKANI = _gdi_.LANGUAGE_KONKANI
2402 LANGUAGE_KOREAN = _gdi_.LANGUAGE_KOREAN
2403 LANGUAGE_KURDISH = _gdi_.LANGUAGE_KURDISH
2404 LANGUAGE_LAOTHIAN = _gdi_.LANGUAGE_LAOTHIAN
2405 LANGUAGE_LATIN = _gdi_.LANGUAGE_LATIN
2406 LANGUAGE_LATVIAN = _gdi_.LANGUAGE_LATVIAN
2407 LANGUAGE_LINGALA = _gdi_.LANGUAGE_LINGALA
2408 LANGUAGE_LITHUANIAN = _gdi_.LANGUAGE_LITHUANIAN
2409 LANGUAGE_MACEDONIAN = _gdi_.LANGUAGE_MACEDONIAN
2410 LANGUAGE_MALAGASY = _gdi_.LANGUAGE_MALAGASY
2411 LANGUAGE_MALAY = _gdi_.LANGUAGE_MALAY
2412 LANGUAGE_MALAYALAM = _gdi_.LANGUAGE_MALAYALAM
2413 LANGUAGE_MALAY_BRUNEI_DARUSSALAM = _gdi_.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2414 LANGUAGE_MALAY_MALAYSIA = _gdi_.LANGUAGE_MALAY_MALAYSIA
2415 LANGUAGE_MALTESE = _gdi_.LANGUAGE_MALTESE
2416 LANGUAGE_MANIPURI = _gdi_.LANGUAGE_MANIPURI
2417 LANGUAGE_MAORI = _gdi_.LANGUAGE_MAORI
2418 LANGUAGE_MARATHI = _gdi_.LANGUAGE_MARATHI
2419 LANGUAGE_MOLDAVIAN = _gdi_.LANGUAGE_MOLDAVIAN
2420 LANGUAGE_MONGOLIAN = _gdi_.LANGUAGE_MONGOLIAN
2421 LANGUAGE_NAURU = _gdi_.LANGUAGE_NAURU
2422 LANGUAGE_NEPALI = _gdi_.LANGUAGE_NEPALI
2423 LANGUAGE_NEPALI_INDIA = _gdi_.LANGUAGE_NEPALI_INDIA
2424 LANGUAGE_NORWEGIAN_BOKMAL = _gdi_.LANGUAGE_NORWEGIAN_BOKMAL
2425 LANGUAGE_NORWEGIAN_NYNORSK = _gdi_.LANGUAGE_NORWEGIAN_NYNORSK
2426 LANGUAGE_OCCITAN = _gdi_.LANGUAGE_OCCITAN
2427 LANGUAGE_ORIYA = _gdi_.LANGUAGE_ORIYA
2428 LANGUAGE_OROMO = _gdi_.LANGUAGE_OROMO
2429 LANGUAGE_PASHTO = _gdi_.LANGUAGE_PASHTO
2430 LANGUAGE_POLISH = _gdi_.LANGUAGE_POLISH
2431 LANGUAGE_PORTUGUESE = _gdi_.LANGUAGE_PORTUGUESE
2432 LANGUAGE_PORTUGUESE_BRAZILIAN = _gdi_.LANGUAGE_PORTUGUESE_BRAZILIAN
2433 LANGUAGE_PUNJABI = _gdi_.LANGUAGE_PUNJABI
2434 LANGUAGE_QUECHUA = _gdi_.LANGUAGE_QUECHUA
2435 LANGUAGE_RHAETO_ROMANCE = _gdi_.LANGUAGE_RHAETO_ROMANCE
2436 LANGUAGE_ROMANIAN = _gdi_.LANGUAGE_ROMANIAN
2437 LANGUAGE_RUSSIAN = _gdi_.LANGUAGE_RUSSIAN
2438 LANGUAGE_RUSSIAN_UKRAINE = _gdi_.LANGUAGE_RUSSIAN_UKRAINE
2439 LANGUAGE_SAMOAN = _gdi_.LANGUAGE_SAMOAN
2440 LANGUAGE_SANGHO = _gdi_.LANGUAGE_SANGHO
2441 LANGUAGE_SANSKRIT = _gdi_.LANGUAGE_SANSKRIT
2442 LANGUAGE_SCOTS_GAELIC = _gdi_.LANGUAGE_SCOTS_GAELIC
2443 LANGUAGE_SERBIAN = _gdi_.LANGUAGE_SERBIAN
2444 LANGUAGE_SERBIAN_CYRILLIC = _gdi_.LANGUAGE_SERBIAN_CYRILLIC
2445 LANGUAGE_SERBIAN_LATIN = _gdi_.LANGUAGE_SERBIAN_LATIN
2446 LANGUAGE_SERBO_CROATIAN = _gdi_.LANGUAGE_SERBO_CROATIAN
2447 LANGUAGE_SESOTHO = _gdi_.LANGUAGE_SESOTHO
2448 LANGUAGE_SETSWANA = _gdi_.LANGUAGE_SETSWANA
2449 LANGUAGE_SHONA = _gdi_.LANGUAGE_SHONA
2450 LANGUAGE_SINDHI = _gdi_.LANGUAGE_SINDHI
2451 LANGUAGE_SINHALESE = _gdi_.LANGUAGE_SINHALESE
2452 LANGUAGE_SISWATI = _gdi_.LANGUAGE_SISWATI
2453 LANGUAGE_SLOVAK = _gdi_.LANGUAGE_SLOVAK
2454 LANGUAGE_SLOVENIAN = _gdi_.LANGUAGE_SLOVENIAN
2455 LANGUAGE_SOMALI = _gdi_.LANGUAGE_SOMALI
2456 LANGUAGE_SPANISH = _gdi_.LANGUAGE_SPANISH
2457 LANGUAGE_SPANISH_ARGENTINA = _gdi_.LANGUAGE_SPANISH_ARGENTINA
2458 LANGUAGE_SPANISH_BOLIVIA = _gdi_.LANGUAGE_SPANISH_BOLIVIA
2459 LANGUAGE_SPANISH_CHILE = _gdi_.LANGUAGE_SPANISH_CHILE
2460 LANGUAGE_SPANISH_COLOMBIA = _gdi_.LANGUAGE_SPANISH_COLOMBIA
2461 LANGUAGE_SPANISH_COSTA_RICA = _gdi_.LANGUAGE_SPANISH_COSTA_RICA
2462 LANGUAGE_SPANISH_DOMINICAN_REPUBLIC = _gdi_.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2463 LANGUAGE_SPANISH_ECUADOR = _gdi_.LANGUAGE_SPANISH_ECUADOR
2464 LANGUAGE_SPANISH_EL_SALVADOR = _gdi_.LANGUAGE_SPANISH_EL_SALVADOR
2465 LANGUAGE_SPANISH_GUATEMALA = _gdi_.LANGUAGE_SPANISH_GUATEMALA
2466 LANGUAGE_SPANISH_HONDURAS = _gdi_.LANGUAGE_SPANISH_HONDURAS
2467 LANGUAGE_SPANISH_MEXICAN = _gdi_.LANGUAGE_SPANISH_MEXICAN
2468 LANGUAGE_SPANISH_MODERN = _gdi_.LANGUAGE_SPANISH_MODERN
2469 LANGUAGE_SPANISH_NICARAGUA = _gdi_.LANGUAGE_SPANISH_NICARAGUA
2470 LANGUAGE_SPANISH_PANAMA = _gdi_.LANGUAGE_SPANISH_PANAMA
2471 LANGUAGE_SPANISH_PARAGUAY = _gdi_.LANGUAGE_SPANISH_PARAGUAY
2472 LANGUAGE_SPANISH_PERU = _gdi_.LANGUAGE_SPANISH_PERU
2473 LANGUAGE_SPANISH_PUERTO_RICO = _gdi_.LANGUAGE_SPANISH_PUERTO_RICO
2474 LANGUAGE_SPANISH_URUGUAY = _gdi_.LANGUAGE_SPANISH_URUGUAY
2475 LANGUAGE_SPANISH_US = _gdi_.LANGUAGE_SPANISH_US
2476 LANGUAGE_SPANISH_VENEZUELA = _gdi_.LANGUAGE_SPANISH_VENEZUELA
2477 LANGUAGE_SUNDANESE = _gdi_.LANGUAGE_SUNDANESE
2478 LANGUAGE_SWAHILI = _gdi_.LANGUAGE_SWAHILI
2479 LANGUAGE_SWEDISH = _gdi_.LANGUAGE_SWEDISH
2480 LANGUAGE_SWEDISH_FINLAND = _gdi_.LANGUAGE_SWEDISH_FINLAND
2481 LANGUAGE_TAGALOG = _gdi_.LANGUAGE_TAGALOG
2482 LANGUAGE_TAJIK = _gdi_.LANGUAGE_TAJIK
2483 LANGUAGE_TAMIL = _gdi_.LANGUAGE_TAMIL
2484 LANGUAGE_TATAR = _gdi_.LANGUAGE_TATAR
2485 LANGUAGE_TELUGU = _gdi_.LANGUAGE_TELUGU
2486 LANGUAGE_THAI = _gdi_.LANGUAGE_THAI
2487 LANGUAGE_TIBETAN = _gdi_.LANGUAGE_TIBETAN
2488 LANGUAGE_TIGRINYA = _gdi_.LANGUAGE_TIGRINYA
2489 LANGUAGE_TONGA = _gdi_.LANGUAGE_TONGA
2490 LANGUAGE_TSONGA = _gdi_.LANGUAGE_TSONGA
2491 LANGUAGE_TURKISH = _gdi_.LANGUAGE_TURKISH
2492 LANGUAGE_TURKMEN = _gdi_.LANGUAGE_TURKMEN
2493 LANGUAGE_TWI = _gdi_.LANGUAGE_TWI
2494 LANGUAGE_UIGHUR = _gdi_.LANGUAGE_UIGHUR
2495 LANGUAGE_UKRAINIAN = _gdi_.LANGUAGE_UKRAINIAN
2496 LANGUAGE_URDU = _gdi_.LANGUAGE_URDU
2497 LANGUAGE_URDU_INDIA = _gdi_.LANGUAGE_URDU_INDIA
2498 LANGUAGE_URDU_PAKISTAN = _gdi_.LANGUAGE_URDU_PAKISTAN
2499 LANGUAGE_UZBEK = _gdi_.LANGUAGE_UZBEK
2500 LANGUAGE_UZBEK_CYRILLIC = _gdi_.LANGUAGE_UZBEK_CYRILLIC
2501 LANGUAGE_UZBEK_LATIN = _gdi_.LANGUAGE_UZBEK_LATIN
2502 LANGUAGE_VIETNAMESE = _gdi_.LANGUAGE_VIETNAMESE
2503 LANGUAGE_VOLAPUK = _gdi_.LANGUAGE_VOLAPUK
2504 LANGUAGE_WELSH = _gdi_.LANGUAGE_WELSH
2505 LANGUAGE_WOLOF = _gdi_.LANGUAGE_WOLOF
2506 LANGUAGE_XHOSA = _gdi_.LANGUAGE_XHOSA
2507 LANGUAGE_YIDDISH = _gdi_.LANGUAGE_YIDDISH
2508 LANGUAGE_YORUBA = _gdi_.LANGUAGE_YORUBA
2509 LANGUAGE_ZHUANG = _gdi_.LANGUAGE_ZHUANG
2510 LANGUAGE_ZULU = _gdi_.LANGUAGE_ZULU
2511 LANGUAGE_USER_DEFINED = _gdi_.LANGUAGE_USER_DEFINED
2512 class LanguageInfo(object):
2513 """Proxy of C++ LanguageInfo class"""
2514 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2515 def __init__(self): raise AttributeError, "No constructor defined"
2516 __repr__ = _swig_repr
2517 Language = property(_gdi_.LanguageInfo_Language_get, _gdi_.LanguageInfo_Language_set)
2518 CanonicalName = property(_gdi_.LanguageInfo_CanonicalName_get, _gdi_.LanguageInfo_CanonicalName_set)
2519 Description = property(_gdi_.LanguageInfo_Description_get, _gdi_.LanguageInfo_Description_set)
2520 _gdi_.LanguageInfo_swigregister(LanguageInfo)
2521
2522 LOCALE_CAT_NUMBER = _gdi_.LOCALE_CAT_NUMBER
2523 LOCALE_CAT_DATE = _gdi_.LOCALE_CAT_DATE
2524 LOCALE_CAT_MONEY = _gdi_.LOCALE_CAT_MONEY
2525 LOCALE_CAT_MAX = _gdi_.LOCALE_CAT_MAX
2526 LOCALE_THOUSANDS_SEP = _gdi_.LOCALE_THOUSANDS_SEP
2527 LOCALE_DECIMAL_POINT = _gdi_.LOCALE_DECIMAL_POINT
2528 LOCALE_LOAD_DEFAULT = _gdi_.LOCALE_LOAD_DEFAULT
2529 LOCALE_CONV_ENCODING = _gdi_.LOCALE_CONV_ENCODING
2530 class Locale(object):
2531 """Proxy of C++ Locale class"""
2532 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2533 __repr__ = _swig_repr
2534 def __init__(self, *args, **kwargs):
2535 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
2536 _gdi_.Locale_swiginit(self,_gdi_.new_Locale(*args, **kwargs))
2537 __swig_destroy__ = _gdi_.delete_Locale
2538 __del__ = lambda self : None;
2539 def Init1(*args, **kwargs):
2540 """
2541 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2542 bool bLoadDefault=True,
2543 bool bConvertEncoding=False) -> bool
2544 """
2545 return _gdi_.Locale_Init1(*args, **kwargs)
2546
2547 def Init2(*args, **kwargs):
2548 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2549 return _gdi_.Locale_Init2(*args, **kwargs)
2550
2551 def Init(self, *_args, **_kwargs):
2552 if type(_args[0]) in [type(''), type(u'')]:
2553 val = self.Init1(*_args, **_kwargs)
2554 else:
2555 val = self.Init2(*_args, **_kwargs)
2556 return val
2557
2558 def GetSystemLanguage(*args, **kwargs):
2559 """GetSystemLanguage() -> int"""
2560 return _gdi_.Locale_GetSystemLanguage(*args, **kwargs)
2561
2562 GetSystemLanguage = staticmethod(GetSystemLanguage)
2563 def GetSystemEncoding(*args, **kwargs):
2564 """GetSystemEncoding() -> int"""
2565 return _gdi_.Locale_GetSystemEncoding(*args, **kwargs)
2566
2567 GetSystemEncoding = staticmethod(GetSystemEncoding)
2568 def GetSystemEncodingName(*args, **kwargs):
2569 """GetSystemEncodingName() -> String"""
2570 return _gdi_.Locale_GetSystemEncodingName(*args, **kwargs)
2571
2572 GetSystemEncodingName = staticmethod(GetSystemEncodingName)
2573 def IsOk(*args, **kwargs):
2574 """IsOk(self) -> bool"""
2575 return _gdi_.Locale_IsOk(*args, **kwargs)
2576
2577 def __nonzero__(self): return self.IsOk()
2578 def GetLocale(*args, **kwargs):
2579 """GetLocale(self) -> String"""
2580 return _gdi_.Locale_GetLocale(*args, **kwargs)
2581
2582 def GetLanguage(*args, **kwargs):
2583 """GetLanguage(self) -> int"""
2584 return _gdi_.Locale_GetLanguage(*args, **kwargs)
2585
2586 def GetSysName(*args, **kwargs):
2587 """GetSysName(self) -> String"""
2588 return _gdi_.Locale_GetSysName(*args, **kwargs)
2589
2590 def GetCanonicalName(*args, **kwargs):
2591 """GetCanonicalName(self) -> String"""
2592 return _gdi_.Locale_GetCanonicalName(*args, **kwargs)
2593
2594 def AddCatalogLookupPathPrefix(*args, **kwargs):
2595 """AddCatalogLookupPathPrefix(String prefix)"""
2596 return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs)
2597
2598 AddCatalogLookupPathPrefix = staticmethod(AddCatalogLookupPathPrefix)
2599 def AddCatalog(*args, **kwargs):
2600 """AddCatalog(self, String szDomain) -> bool"""
2601 return _gdi_.Locale_AddCatalog(*args, **kwargs)
2602
2603 def IsLoaded(*args, **kwargs):
2604 """IsLoaded(self, String szDomain) -> bool"""
2605 return _gdi_.Locale_IsLoaded(*args, **kwargs)
2606
2607 def GetLanguageInfo(*args, **kwargs):
2608 """GetLanguageInfo(int lang) -> LanguageInfo"""
2609 return _gdi_.Locale_GetLanguageInfo(*args, **kwargs)
2610
2611 GetLanguageInfo = staticmethod(GetLanguageInfo)
2612 def GetLanguageName(*args, **kwargs):
2613 """GetLanguageName(int lang) -> String"""
2614 return _gdi_.Locale_GetLanguageName(*args, **kwargs)
2615
2616 GetLanguageName = staticmethod(GetLanguageName)
2617 def FindLanguageInfo(*args, **kwargs):
2618 """FindLanguageInfo(String locale) -> LanguageInfo"""
2619 return _gdi_.Locale_FindLanguageInfo(*args, **kwargs)
2620
2621 FindLanguageInfo = staticmethod(FindLanguageInfo)
2622 def AddLanguage(*args, **kwargs):
2623 """AddLanguage(LanguageInfo info)"""
2624 return _gdi_.Locale_AddLanguage(*args, **kwargs)
2625
2626 AddLanguage = staticmethod(AddLanguage)
2627 def GetString(*args, **kwargs):
2628 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2629 return _gdi_.Locale_GetString(*args, **kwargs)
2630
2631 def GetName(*args, **kwargs):
2632 """GetName(self) -> String"""
2633 return _gdi_.Locale_GetName(*args, **kwargs)
2634
2635 _gdi_.Locale_swigregister(Locale)
2636
2637 def Locale_GetSystemLanguage(*args):
2638 """Locale_GetSystemLanguage() -> int"""
2639 return _gdi_.Locale_GetSystemLanguage(*args)
2640
2641 def Locale_GetSystemEncoding(*args):
2642 """Locale_GetSystemEncoding() -> int"""
2643 return _gdi_.Locale_GetSystemEncoding(*args)
2644
2645 def Locale_GetSystemEncodingName(*args):
2646 """Locale_GetSystemEncodingName() -> String"""
2647 return _gdi_.Locale_GetSystemEncodingName(*args)
2648
2649 def Locale_AddCatalogLookupPathPrefix(*args, **kwargs):
2650 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2651 return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs)
2652
2653 def Locale_GetLanguageInfo(*args, **kwargs):
2654 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2655 return _gdi_.Locale_GetLanguageInfo(*args, **kwargs)
2656
2657 def Locale_GetLanguageName(*args, **kwargs):
2658 """Locale_GetLanguageName(int lang) -> String"""
2659 return _gdi_.Locale_GetLanguageName(*args, **kwargs)
2660
2661 def Locale_FindLanguageInfo(*args, **kwargs):
2662 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2663 return _gdi_.Locale_FindLanguageInfo(*args, **kwargs)
2664
2665 def Locale_AddLanguage(*args, **kwargs):
2666 """Locale_AddLanguage(LanguageInfo info)"""
2667 return _gdi_.Locale_AddLanguage(*args, **kwargs)
2668
2669 class PyLocale(Locale):
2670 """Proxy of C++ PyLocale class"""
2671 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2672 __repr__ = _swig_repr
2673 def __init__(self, *args, **kwargs):
2674 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale"""
2675 _gdi_.PyLocale_swiginit(self,_gdi_.new_PyLocale(*args, **kwargs))
2676 self._setCallbackInfo(self, PyLocale)
2677
2678 __swig_destroy__ = _gdi_.delete_PyLocale
2679 __del__ = lambda self : None;
2680 def _setCallbackInfo(*args, **kwargs):
2681 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2682 return _gdi_.PyLocale__setCallbackInfo(*args, **kwargs)
2683
2684 def GetSingularString(*args, **kwargs):
2685 """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar"""
2686 return _gdi_.PyLocale_GetSingularString(*args, **kwargs)
2687
2688 def GetPluralString(*args, **kwargs):
2689 """
2690 GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n,
2691 wxChar szDomain=None) -> wxChar
2692 """
2693 return _gdi_.PyLocale_GetPluralString(*args, **kwargs)
2694
2695 _gdi_.PyLocale_swigregister(PyLocale)
2696
2697
2698 def GetLocale(*args):
2699 """GetLocale() -> Locale"""
2700 return _gdi_.GetLocale(*args)
2701 #---------------------------------------------------------------------------
2702
2703 CONVERT_STRICT = _gdi_.CONVERT_STRICT
2704 CONVERT_SUBSTITUTE = _gdi_.CONVERT_SUBSTITUTE
2705 PLATFORM_CURRENT = _gdi_.PLATFORM_CURRENT
2706 PLATFORM_UNIX = _gdi_.PLATFORM_UNIX
2707 PLATFORM_WINDOWS = _gdi_.PLATFORM_WINDOWS
2708 PLATFORM_OS2 = _gdi_.PLATFORM_OS2
2709 PLATFORM_MAC = _gdi_.PLATFORM_MAC
2710 class EncodingConverter(_core.Object):
2711 """Proxy of C++ EncodingConverter class"""
2712 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2713 __repr__ = _swig_repr
2714 def __init__(self, *args, **kwargs):
2715 """__init__(self) -> EncodingConverter"""
2716 _gdi_.EncodingConverter_swiginit(self,_gdi_.new_EncodingConverter(*args, **kwargs))
2717 __swig_destroy__ = _gdi_.delete_EncodingConverter
2718 __del__ = lambda self : None;
2719 def Init(*args, **kwargs):
2720 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2721 return _gdi_.EncodingConverter_Init(*args, **kwargs)
2722
2723 def Convert(*args, **kwargs):
2724 """Convert(self, String input) -> String"""
2725 return _gdi_.EncodingConverter_Convert(*args, **kwargs)
2726
2727 def GetPlatformEquivalents(*args, **kwargs):
2728 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2729 return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs)
2730
2731 GetPlatformEquivalents = staticmethod(GetPlatformEquivalents)
2732 def GetAllEquivalents(*args, **kwargs):
2733 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2734 return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs)
2735
2736 GetAllEquivalents = staticmethod(GetAllEquivalents)
2737 def CanConvert(*args, **kwargs):
2738 """CanConvert(int encIn, int encOut) -> bool"""
2739 return _gdi_.EncodingConverter_CanConvert(*args, **kwargs)
2740
2741 CanConvert = staticmethod(CanConvert)
2742 def __nonzero__(self): return self.IsOk()
2743 _gdi_.EncodingConverter_swigregister(EncodingConverter)
2744
2745 def GetTranslation(*args):
2746 """
2747 GetTranslation(String str) -> String
2748 GetTranslation(String str, String domain) -> String
2749 GetTranslation(String str, String strPlural, size_t n) -> String
2750 GetTranslation(String str, String strPlural, size_t n, String domain) -> String
2751 """
2752 return _gdi_.GetTranslation(*args)
2753
2754 def EncodingConverter_GetPlatformEquivalents(*args, **kwargs):
2755 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2756 return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs)
2757
2758 def EncodingConverter_GetAllEquivalents(*args, **kwargs):
2759 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2760 return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs)
2761
2762 def EncodingConverter_CanConvert(*args, **kwargs):
2763 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2764 return _gdi_.EncodingConverter_CanConvert(*args, **kwargs)
2765
2766 #----------------------------------------------------------------------------
2767 # On MSW add the directory where the wxWidgets catalogs were installed
2768 # to the default catalog path.
2769 if wx.Platform == "__WXMSW__":
2770 import os
2771 _localedir = os.path.join(os.path.split(__file__)[0], "locale")
2772 Locale.AddCatalogLookupPathPrefix(_localedir)
2773 del os
2774
2775 #----------------------------------------------------------------------------
2776
2777 #---------------------------------------------------------------------------
2778
2779 class DC(_core.Object):
2780 """
2781 A wx.DC is a device context onto which graphics and text can be
2782 drawn. It is intended to represent a number of output devices in a
2783 generic way, so a window can have a device context associated with it,
2784 and a printer also has a device context. In this way, the same piece
2785 of code may write to a number of different devices, if the device
2786 context is used as a parameter.
2787
2788 Derived types of wxDC have documentation for specific features only,
2789 so refer to this section for most device context information.
2790
2791 The wx.DC class is abstract and can not be instantiated, you must use
2792 one of the derived classes instead. Which one will depend on the
2793 situation in which it is used.
2794 """
2795 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2796 def __init__(self): raise AttributeError, "No constructor defined"
2797 __repr__ = _swig_repr
2798 __swig_destroy__ = _gdi_.delete_DC
2799 __del__ = lambda self : None;
2800 # These have been deprecated in wxWidgets. Since they never
2801 # really did anything to begin with, just make them be NOPs.
2802 def BeginDrawing(self): pass
2803 def EndDrawing(self): pass
2804
2805 def FloodFill(*args, **kwargs):
2806 """
2807 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2808
2809 Flood fills the device context starting from the given point, using
2810 the current brush colour, and using a style:
2811
2812 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2813 the given colour is encountered.
2814
2815 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2816 colour.
2817
2818 Returns False if the operation failed.
2819
2820 Note: The present implementation for non-Windows platforms may fail to
2821 find colour borders if the pixels do not match the colour
2822 exactly. However the function will still return true.
2823 """
2824 return _gdi_.DC_FloodFill(*args, **kwargs)
2825
2826 def FloodFillPoint(*args, **kwargs):
2827 """
2828 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2829
2830 Flood fills the device context starting from the given point, using
2831 the current brush colour, and using a style:
2832
2833 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2834 the given colour is encountered.
2835
2836 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2837 colour.
2838
2839 Returns False if the operation failed.
2840
2841 Note: The present implementation for non-Windows platforms may fail to
2842 find colour borders if the pixels do not match the colour
2843 exactly. However the function will still return true.
2844 """
2845 return _gdi_.DC_FloodFillPoint(*args, **kwargs)
2846
2847 def GradientFillConcentric(*args, **kwargs):
2848 """
2849 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2850 Point circleCenter)
2851
2852 Fill the area specified by rect with a radial gradient, starting from
2853 initialColour in the center of the circle and fading to destColour on
2854 the outside of the circle. The circleCenter argument is the relative
2855 coordinants of the center of the circle in the specified rect.
2856
2857 Note: Currently this function is very slow, don't use it for real-time
2858 drawing.
2859 """
2860 return _gdi_.DC_GradientFillConcentric(*args, **kwargs)
2861
2862 def GradientFillLinear(*args, **kwargs):
2863 """
2864 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2865 int nDirection=EAST)
2866
2867 Fill the area specified by rect with a linear gradient, starting from
2868 initialColour and eventually fading to destColour. The nDirection
2869 parameter specifies the direction of the colour change, default is to
2870 use initialColour on the left part of the rectangle and destColour on
2871 the right side.
2872 """
2873 return _gdi_.DC_GradientFillLinear(*args, **kwargs)
2874
2875 def GetPixel(*args, **kwargs):
2876 """
2877 GetPixel(self, int x, int y) -> Colour
2878
2879 Gets the colour at the specified location on the DC.
2880 """
2881 return _gdi_.DC_GetPixel(*args, **kwargs)
2882
2883 def GetPixelPoint(*args, **kwargs):
2884 """GetPixelPoint(self, Point pt) -> Colour"""
2885 return _gdi_.DC_GetPixelPoint(*args, **kwargs)
2886
2887 def DrawLine(*args, **kwargs):
2888 """
2889 DrawLine(self, int x1, int y1, int x2, int y2)
2890
2891 Draws a line from the first point to the second. The current pen is
2892 used for drawing the line. Note that the second point is *not* part of
2893 the line and is not drawn by this function (this is consistent with
2894 the behaviour of many other toolkits).
2895 """
2896 return _gdi_.DC_DrawLine(*args, **kwargs)
2897
2898 def DrawLinePoint(*args, **kwargs):
2899 """
2900 DrawLinePoint(self, Point pt1, Point pt2)
2901
2902 Draws a line from the first point to the second. The current pen is
2903 used for drawing the line. Note that the second point is *not* part of
2904 the line and is not drawn by this function (this is consistent with
2905 the behaviour of many other toolkits).
2906 """
2907 return _gdi_.DC_DrawLinePoint(*args, **kwargs)
2908
2909 def CrossHair(*args, **kwargs):
2910 """
2911 CrossHair(self, int x, int y)
2912
2913 Displays a cross hair using the current pen. This is a vertical and
2914 horizontal line the height and width of the window, centred on the
2915 given point.
2916 """
2917 return _gdi_.DC_CrossHair(*args, **kwargs)
2918
2919 def CrossHairPoint(*args, **kwargs):
2920 """
2921 CrossHairPoint(self, Point pt)
2922
2923 Displays a cross hair using the current pen. This is a vertical and
2924 horizontal line the height and width of the window, centred on the
2925 given point.
2926 """
2927 return _gdi_.DC_CrossHairPoint(*args, **kwargs)
2928
2929 def DrawArc(*args, **kwargs):
2930 """
2931 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
2932
2933 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2934 the first point to the second. The current pen is used for the outline
2935 and the current brush for filling the shape.
2936
2937 The arc is drawn in an anticlockwise direction from the start point to
2938 the end point.
2939 """
2940 return _gdi_.DC_DrawArc(*args, **kwargs)
2941
2942 def DrawArcPoint(*args, **kwargs):
2943 """
2944 DrawArcPoint(self, Point pt1, Point pt2, Point center)
2945
2946 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2947 the first point to the second. The current pen is used for the outline
2948 and the current brush for filling the shape.
2949
2950 The arc is drawn in an anticlockwise direction from the start point to
2951 the end point.
2952 """
2953 return _gdi_.DC_DrawArcPoint(*args, **kwargs)
2954
2955 def DrawCheckMark(*args, **kwargs):
2956 """
2957 DrawCheckMark(self, int x, int y, int width, int height)
2958
2959 Draws a check mark inside the given rectangle.
2960 """
2961 return _gdi_.DC_DrawCheckMark(*args, **kwargs)
2962
2963 def DrawCheckMarkRect(*args, **kwargs):
2964 """
2965 DrawCheckMarkRect(self, Rect rect)
2966
2967 Draws a check mark inside the given rectangle.
2968 """
2969 return _gdi_.DC_DrawCheckMarkRect(*args, **kwargs)
2970
2971 def DrawEllipticArc(*args, **kwargs):
2972 """
2973 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
2974
2975 Draws an arc of an ellipse, with the given rectangle defining the
2976 bounds of the ellipse. The current pen is used for drawing the arc and
2977 the current brush is used for drawing the pie.
2978
2979 The *start* and *end* parameters specify the start and end of the arc
2980 relative to the three-o'clock position from the center of the
2981 rectangle. Angles are specified in degrees (360 is a complete
2982 circle). Positive values mean counter-clockwise motion. If start is
2983 equal to end, a complete ellipse will be drawn.
2984 """
2985 return _gdi_.DC_DrawEllipticArc(*args, **kwargs)
2986
2987 def DrawEllipticArcPointSize(*args, **kwargs):
2988 """
2989 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
2990
2991 Draws an arc of an ellipse, with the given rectangle defining the
2992 bounds of the ellipse. The current pen is used for drawing the arc and
2993 the current brush is used for drawing the pie.
2994
2995 The *start* and *end* parameters specify the start and end of the arc
2996 relative to the three-o'clock position from the center of the
2997 rectangle. Angles are specified in degrees (360 is a complete
2998 circle). Positive values mean counter-clockwise motion. If start is
2999 equal to end, a complete ellipse will be drawn.
3000 """
3001 return _gdi_.DC_DrawEllipticArcPointSize(*args, **kwargs)
3002
3003 def DrawPoint(*args, **kwargs):
3004 """
3005 DrawPoint(self, int x, int y)
3006
3007 Draws a point using the current pen.
3008 """
3009 return _gdi_.DC_DrawPoint(*args, **kwargs)
3010
3011 def DrawPointPoint(*args, **kwargs):
3012 """
3013 DrawPointPoint(self, Point pt)
3014
3015 Draws a point using the current pen.
3016 """
3017 return _gdi_.DC_DrawPointPoint(*args, **kwargs)
3018
3019 def DrawRectangle(*args, **kwargs):
3020 """
3021 DrawRectangle(self, int x, int y, int width, int height)
3022
3023 Draws a rectangle with the given top left corner, and with the given
3024 size. The current pen is used for the outline and the current brush
3025 for filling the shape.
3026 """
3027 return _gdi_.DC_DrawRectangle(*args, **kwargs)
3028
3029 def DrawRectangleRect(*args, **kwargs):
3030 """
3031 DrawRectangleRect(self, Rect rect)
3032
3033 Draws a rectangle with the given top left corner, and with the given
3034 size. The current pen is used for the outline and the current brush
3035 for filling the shape.
3036 """
3037 return _gdi_.DC_DrawRectangleRect(*args, **kwargs)
3038
3039 def DrawRectanglePointSize(*args, **kwargs):
3040 """
3041 DrawRectanglePointSize(self, Point pt, Size sz)
3042
3043 Draws a rectangle with the given top left corner, and with the given
3044 size. The current pen is used for the outline and the current brush
3045 for filling the shape.
3046 """
3047 return _gdi_.DC_DrawRectanglePointSize(*args, **kwargs)
3048
3049 def DrawRoundedRectangle(*args, **kwargs):
3050 """
3051 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
3052
3053 Draws a rectangle with the given top left corner, and with the given
3054 size. The corners are quarter-circles using the given radius. The
3055 current pen is used for the outline and the current brush for filling
3056 the shape.
3057
3058 If radius is positive, the value is assumed to be the radius of the
3059 rounded corner. If radius is negative, the absolute value is assumed
3060 to be the proportion of the smallest dimension of the rectangle. This
3061 means that the corner can be a sensible size relative to the size of
3062 the rectangle, and also avoids the strange effects X produces when the
3063 corners are too big for the rectangle.
3064 """
3065 return _gdi_.DC_DrawRoundedRectangle(*args, **kwargs)
3066
3067 def DrawRoundedRectangleRect(*args, **kwargs):
3068 """
3069 DrawRoundedRectangleRect(self, Rect r, double radius)
3070
3071 Draws a rectangle with the given top left corner, and with the given
3072 size. The corners are quarter-circles using the given radius. The
3073 current pen is used for the outline and the current brush for filling
3074 the shape.
3075
3076 If radius is positive, the value is assumed to be the radius of the
3077 rounded corner. If radius is negative, the absolute value is assumed
3078 to be the proportion of the smallest dimension of the rectangle. This
3079 means that the corner can be a sensible size relative to the size of
3080 the rectangle, and also avoids the strange effects X produces when the
3081 corners are too big for the rectangle.
3082 """
3083 return _gdi_.DC_DrawRoundedRectangleRect(*args, **kwargs)
3084
3085 def DrawRoundedRectanglePointSize(*args, **kwargs):
3086 """
3087 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
3088
3089 Draws a rectangle with the given top left corner, and with the given
3090 size. The corners are quarter-circles using the given radius. The
3091 current pen is used for the outline and the current brush for filling
3092 the shape.
3093
3094 If radius is positive, the value is assumed to be the radius of the
3095 rounded corner. If radius is negative, the absolute value is assumed
3096 to be the proportion of the smallest dimension of the rectangle. This
3097 means that the corner can be a sensible size relative to the size of
3098 the rectangle, and also avoids the strange effects X produces when the
3099 corners are too big for the rectangle.
3100 """
3101 return _gdi_.DC_DrawRoundedRectanglePointSize(*args, **kwargs)
3102
3103 def DrawCircle(*args, **kwargs):
3104 """
3105 DrawCircle(self, int x, int y, int radius)
3106
3107 Draws a circle with the given center point and radius. The current
3108 pen is used for the outline and the current brush for filling the
3109 shape.
3110 """
3111 return _gdi_.DC_DrawCircle(*args, **kwargs)
3112
3113 def DrawCirclePoint(*args, **kwargs):
3114 """
3115 DrawCirclePoint(self, Point pt, int radius)
3116
3117 Draws a circle with the given center point and radius. The current
3118 pen is used for the outline and the current brush for filling the
3119 shape.
3120 """
3121 return _gdi_.DC_DrawCirclePoint(*args, **kwargs)
3122
3123 def DrawEllipse(*args, **kwargs):
3124 """
3125 DrawEllipse(self, int x, int y, int width, int height)
3126
3127 Draws an ellipse contained in the specified rectangle. The current pen
3128 is used for the outline and the current brush for filling the shape.
3129 """
3130 return _gdi_.DC_DrawEllipse(*args, **kwargs)
3131
3132 def DrawEllipseRect(*args, **kwargs):
3133 """
3134 DrawEllipseRect(self, Rect rect)
3135
3136 Draws an ellipse contained in the specified rectangle. The current pen
3137 is used for the outline and the current brush for filling the shape.
3138 """
3139 return _gdi_.DC_DrawEllipseRect(*args, **kwargs)
3140
3141 def DrawEllipsePointSize(*args, **kwargs):
3142 """
3143 DrawEllipsePointSize(self, Point pt, Size sz)
3144
3145 Draws an ellipse contained in the specified rectangle. The current pen
3146 is used for the outline and the current brush for filling the shape.
3147 """
3148 return _gdi_.DC_DrawEllipsePointSize(*args, **kwargs)
3149
3150 def DrawIcon(*args, **kwargs):
3151 """
3152 DrawIcon(self, Icon icon, int x, int y)
3153
3154 Draw an icon on the display (does nothing if the device context is
3155 PostScript). This can be the simplest way of drawing bitmaps on a
3156 window.
3157 """
3158 return _gdi_.DC_DrawIcon(*args, **kwargs)
3159
3160 def DrawIconPoint(*args, **kwargs):
3161 """
3162 DrawIconPoint(self, Icon icon, Point pt)
3163
3164 Draw an icon on the display (does nothing if the device context is
3165 PostScript). This can be the simplest way of drawing bitmaps on a
3166 window.
3167 """
3168 return _gdi_.DC_DrawIconPoint(*args, **kwargs)
3169
3170 def DrawBitmap(*args, **kwargs):
3171 """
3172 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
3173
3174 Draw a bitmap on the device context at the specified point. If
3175 *transparent* is true and the bitmap has a transparency mask, (or
3176 alpha channel on the platforms that support it) then the bitmap will
3177 be drawn transparently.
3178 """
3179 return _gdi_.DC_DrawBitmap(*args, **kwargs)
3180
3181 def DrawBitmapPoint(*args, **kwargs):
3182 """
3183 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3184
3185 Draw a bitmap on the device context at the specified point. If
3186 *transparent* is true and the bitmap has a transparency mask, (or
3187 alpha channel on the platforms that support it) then the bitmap will
3188 be drawn transparently.
3189 """
3190 return _gdi_.DC_DrawBitmapPoint(*args, **kwargs)
3191
3192 def DrawText(*args, **kwargs):
3193 """
3194 DrawText(self, String text, int x, int y)
3195
3196 Draws a text string at the specified point, using the current text
3197 font, and the current text foreground and background colours.
3198
3199 The coordinates refer to the top-left corner of the rectangle bounding
3200 the string. See `GetTextExtent` for how to get the dimensions of a
3201 text string, which can be used to position the text more precisely.
3202
3203 **NOTE**: under wxGTK the current logical function is used by this
3204 function but it is ignored by wxMSW. Thus, you should avoid using
3205 logical functions with this function in portable programs.
3206 """
3207 return _gdi_.DC_DrawText(*args, **kwargs)
3208
3209 def DrawTextPoint(*args, **kwargs):
3210 """
3211 DrawTextPoint(self, String text, Point pt)
3212
3213 Draws a text string at the specified point, using the current text
3214 font, and the current text foreground and background colours.
3215
3216 The coordinates refer to the top-left corner of the rectangle bounding
3217 the string. See `GetTextExtent` for how to get the dimensions of a
3218 text string, which can be used to position the text more precisely.
3219
3220 **NOTE**: under wxGTK the current logical function is used by this
3221 function but it is ignored by wxMSW. Thus, you should avoid using
3222 logical functions with this function in portable programs.
3223 """
3224 return _gdi_.DC_DrawTextPoint(*args, **kwargs)
3225
3226 def DrawRotatedText(*args, **kwargs):
3227 """
3228 DrawRotatedText(self, String text, int x, int y, double angle)
3229
3230 Draws the text rotated by *angle* degrees, if supported by the platform.
3231
3232 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3233 function. In particular, a font different from ``wx.NORMAL_FONT``
3234 should be used as the it is not normally a TrueType
3235 font. ``wx.SWISS_FONT`` is an example of a font which is.
3236 """
3237 return _gdi_.DC_DrawRotatedText(*args, **kwargs)
3238
3239 def DrawRotatedTextPoint(*args, **kwargs):
3240 """
3241 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3242
3243 Draws the text rotated by *angle* degrees, if supported by the platform.
3244
3245 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3246 function. In particular, a font different from ``wx.NORMAL_FONT``
3247 should be used as the it is not normally a TrueType
3248 font. ``wx.SWISS_FONT`` is an example of a font which is.
3249 """
3250 return _gdi_.DC_DrawRotatedTextPoint(*args, **kwargs)
3251
3252 def Blit(*args, **kwargs):
3253 """
3254 Blit(self, int xdest, int ydest, int width, int height, DC source,
3255 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3256 int xsrcMask=-1, int ysrcMask=-1) -> bool
3257
3258 Copy from a source DC to this DC. Parameters specify the destination
3259 coordinates, size of area to copy, source DC, source coordinates,
3260 logical function, whether to use a bitmap mask, and mask source
3261 position.
3262 """
3263 return _gdi_.DC_Blit(*args, **kwargs)
3264
3265 def BlitPointSize(*args, **kwargs):
3266 """
3267 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
3268 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
3269
3270 Copy from a source DC to this DC. Parameters specify the destination
3271 coordinates, size of area to copy, source DC, source coordinates,
3272 logical function, whether to use a bitmap mask, and mask source
3273 position.
3274 """
3275 return _gdi_.DC_BlitPointSize(*args, **kwargs)
3276
3277 def SetClippingRegion(*args, **kwargs):
3278 """
3279 SetClippingRegion(self, int x, int y, int width, int height)
3280
3281 Sets the clipping region for this device context to the intersection
3282 of the given region described by the parameters of this method and the
3283 previously set clipping region. You should call `DestroyClippingRegion`
3284 if you want to set the clipping region exactly to the region
3285 specified.
3286
3287 The clipping region is an area to which drawing is
3288 restricted. Possible uses for the clipping region are for clipping
3289 text or for speeding up window redraws when only a known area of the
3290 screen is damaged.
3291 """
3292 return _gdi_.DC_SetClippingRegion(*args, **kwargs)
3293
3294 def SetClippingRegionPointSize(*args, **kwargs):
3295 """
3296 SetClippingRegionPointSize(self, Point pt, Size sz)
3297
3298 Sets the clipping region for this device context to the intersection
3299 of the given region described by the parameters of this method and the
3300 previously set clipping region. You should call `DestroyClippingRegion`
3301 if you want to set the clipping region exactly to the region
3302 specified.
3303
3304 The clipping region is an area to which drawing is
3305 restricted. Possible uses for the clipping region are for clipping
3306 text or for speeding up window redraws when only a known area of the
3307 screen is damaged.
3308 """
3309 return _gdi_.DC_SetClippingRegionPointSize(*args, **kwargs)
3310
3311 def SetClippingRegionAsRegion(*args, **kwargs):
3312 """
3313 SetClippingRegionAsRegion(self, Region region)
3314
3315 Sets the clipping region for this device context to the intersection
3316 of the given region described by the parameters of this method and the
3317 previously set clipping region. You should call `DestroyClippingRegion`
3318 if you want to set the clipping region exactly to the region
3319 specified.
3320
3321 The clipping region is an area to which drawing is
3322 restricted. Possible uses for the clipping region are for clipping
3323 text or for speeding up window redraws when only a known area of the
3324 screen is damaged.
3325 """
3326 return _gdi_.DC_SetClippingRegionAsRegion(*args, **kwargs)
3327
3328 def SetClippingRect(*args, **kwargs):
3329 """
3330 SetClippingRect(self, Rect rect)
3331
3332 Sets the clipping region for this device context to the intersection
3333 of the given region described by the parameters of this method and the
3334 previously set clipping region. You should call `DestroyClippingRegion`
3335 if you want to set the clipping region exactly to the region
3336 specified.
3337
3338 The clipping region is an area to which drawing is
3339 restricted. Possible uses for the clipping region are for clipping
3340 text or for speeding up window redraws when only a known area of the
3341 screen is damaged.
3342 """
3343 return _gdi_.DC_SetClippingRect(*args, **kwargs)
3344
3345 def DrawLines(*args, **kwargs):
3346 """
3347 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3348
3349 Draws lines using a sequence of `wx.Point` objects, adding the
3350 optional offset coordinate. The current pen is used for drawing the
3351 lines.
3352 """
3353 return _gdi_.DC_DrawLines(*args, **kwargs)
3354
3355 def DrawPolygon(*args, **kwargs):
3356 """
3357 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
3358 int fillStyle=ODDEVEN_RULE)
3359
3360 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3361 the optional offset coordinate. The last argument specifies the fill
3362 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3363
3364 The current pen is used for drawing the outline, and the current brush
3365 for filling the shape. Using a transparent brush suppresses
3366 filling. Note that wxWidgets automatically closes the first and last
3367 points.
3368 """
3369 return _gdi_.DC_DrawPolygon(*args, **kwargs)
3370
3371 def DrawLabel(*args, **kwargs):
3372 """
3373 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3374 int indexAccel=-1)
3375
3376 Draw *text* within the specified rectangle, abiding by the alignment
3377 flags. Will additionally emphasize the character at *indexAccel* if
3378 it is not -1.
3379 """
3380 return _gdi_.DC_DrawLabel(*args, **kwargs)
3381
3382 def DrawImageLabel(*args, **kwargs):
3383 """
3384 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3385 int indexAccel=-1) -> Rect
3386
3387 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3388 drawing it) within the specified rectangle, abiding by the alignment
3389 flags. Will additionally emphasize the character at *indexAccel* if
3390 it is not -1. Returns the bounding rectangle.
3391 """
3392 return _gdi_.DC_DrawImageLabel(*args, **kwargs)
3393
3394 def DrawSpline(*args, **kwargs):
3395 """
3396 DrawSpline(self, List points)
3397
3398 Draws a spline between all given control points, (a list of `wx.Point`
3399 objects) using the current pen. The spline is drawn using a series of
3400 lines, using an algorithm taken from the X drawing program 'XFIG'.
3401 """
3402 return _gdi_.DC_DrawSpline(*args, **kwargs)
3403
3404 def Clear(*args, **kwargs):
3405 """
3406 Clear(self)
3407
3408 Clears the device context using the current background brush.
3409 """
3410 return _gdi_.DC_Clear(*args, **kwargs)
3411
3412 def StartDoc(*args, **kwargs):
3413 """
3414 StartDoc(self, String message) -> bool
3415
3416 Starts a document (only relevant when outputting to a
3417 printer). *Message* is a message to show whilst printing.
3418 """
3419 return _gdi_.DC_StartDoc(*args, **kwargs)
3420
3421 def EndDoc(*args, **kwargs):
3422 """
3423 EndDoc(self)
3424
3425 Ends a document (only relevant when outputting to a printer).
3426 """
3427 return _gdi_.DC_EndDoc(*args, **kwargs)
3428
3429 def StartPage(*args, **kwargs):
3430 """
3431 StartPage(self)
3432
3433 Starts a document page (only relevant when outputting to a printer).
3434 """
3435 return _gdi_.DC_StartPage(*args, **kwargs)
3436
3437 def EndPage(*args, **kwargs):
3438 """
3439 EndPage(self)
3440
3441 Ends a document page (only relevant when outputting to a printer).
3442 """
3443 return _gdi_.DC_EndPage(*args, **kwargs)
3444
3445 def SetFont(*args, **kwargs):
3446 """
3447 SetFont(self, Font font)
3448
3449 Sets the current font for the DC. It must be a valid font, in
3450 particular you should not pass ``wx.NullFont`` to this method.
3451 """
3452 return _gdi_.DC_SetFont(*args, **kwargs)
3453
3454 def SetPen(*args, **kwargs):
3455 """
3456 SetPen(self, Pen pen)
3457
3458 Sets the current pen for the DC.
3459
3460 If the argument is ``wx.NullPen``, the current pen is selected out of the
3461 device context, and the original pen restored.
3462 """
3463 return _gdi_.DC_SetPen(*args, **kwargs)
3464
3465 def SetBrush(*args, **kwargs):
3466 """
3467 SetBrush(self, Brush brush)
3468
3469 Sets the current brush for the DC.
3470
3471 If the argument is ``wx.NullBrush``, the current brush is selected out
3472 of the device context, and the original brush restored, allowing the
3473 current brush to be destroyed safely.
3474 """
3475 return _gdi_.DC_SetBrush(*args, **kwargs)
3476
3477 def SetBackground(*args, **kwargs):
3478 """
3479 SetBackground(self, Brush brush)
3480
3481 Sets the current background brush for the DC.
3482 """
3483 return _gdi_.DC_SetBackground(*args, **kwargs)
3484
3485 def SetBackgroundMode(*args, **kwargs):
3486 """
3487 SetBackgroundMode(self, int mode)
3488
3489 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3490 determines whether text will be drawn with a background colour or
3491 not.
3492 """
3493 return _gdi_.DC_SetBackgroundMode(*args, **kwargs)
3494
3495 def SetPalette(*args, **kwargs):
3496 """
3497 SetPalette(self, Palette palette)
3498
3499 If this is a window DC or memory DC, assigns the given palette to the
3500 window or bitmap associated with the DC. If the argument is
3501 ``wx.NullPalette``, the current palette is selected out of the device
3502 context, and the original palette restored.
3503 """
3504 return _gdi_.DC_SetPalette(*args, **kwargs)
3505
3506 def DestroyClippingRegion(*args, **kwargs):
3507 """
3508 DestroyClippingRegion(self)
3509
3510 Destroys the current clipping region so that none of the DC is
3511 clipped.
3512 """
3513 return _gdi_.DC_DestroyClippingRegion(*args, **kwargs)
3514
3515 def GetClippingBox(*args, **kwargs):
3516 """
3517 GetClippingBox() -> (x, y, width, height)
3518
3519 Gets the rectangle surrounding the current clipping region.
3520 """
3521 return _gdi_.DC_GetClippingBox(*args, **kwargs)
3522
3523 def GetClippingRect(*args, **kwargs):
3524 """
3525 GetClippingRect(self) -> Rect
3526
3527 Gets the rectangle surrounding the current clipping region.
3528 """
3529 return _gdi_.DC_GetClippingRect(*args, **kwargs)
3530
3531 def GetCharHeight(*args, **kwargs):
3532 """
3533 GetCharHeight(self) -> int
3534
3535 Gets the character height of the currently set font.
3536 """
3537 return _gdi_.DC_GetCharHeight(*args, **kwargs)
3538
3539 def GetCharWidth(*args, **kwargs):
3540 """
3541 GetCharWidth(self) -> int
3542
3543 Gets the average character width of the currently set font.
3544 """
3545 return _gdi_.DC_GetCharWidth(*args, **kwargs)
3546
3547 def GetTextExtent(*args, **kwargs):
3548 """
3549 GetTextExtent(wxString string) -> (width, height)
3550
3551 Get the width and height of the text using the current font. Only
3552 works for single line strings.
3553 """
3554 return _gdi_.DC_GetTextExtent(*args, **kwargs)
3555
3556 def GetFullTextExtent(*args, **kwargs):
3557 """
3558 GetFullTextExtent(wxString string, Font font=None) ->
3559 (width, height, descent, externalLeading)
3560
3561 Get the width, height, decent and leading of the text using the
3562 current or specified font. Only works for single line strings.
3563 """
3564 return _gdi_.DC_GetFullTextExtent(*args, **kwargs)
3565
3566 def GetMultiLineTextExtent(*args, **kwargs):
3567 """
3568 GetMultiLineTextExtent(wxString string, Font font=None) ->
3569 (width, height, lineHeight)
3570
3571 Get the width, height, decent and leading of the text using the
3572 current or specified font. Works for single as well as multi-line
3573 strings.
3574 """
3575 return _gdi_.DC_GetMultiLineTextExtent(*args, **kwargs)
3576
3577 def GetPartialTextExtents(*args, **kwargs):
3578 """
3579 GetPartialTextExtents(self, text) -> [widths]
3580
3581 Returns a list of integers such that each value is the distance in
3582 pixels from the begining of text to the coresponding character of
3583 *text*. The generic version simply builds a running total of the widths
3584 of each character using GetTextExtent, however if the various
3585 platforms have a native API function that is faster or more accurate
3586 than the generic implementation then it will be used instead.
3587 """
3588 return _gdi_.DC_GetPartialTextExtents(*args, **kwargs)
3589
3590 def GetSize(*args, **kwargs):
3591 """
3592 GetSize(self) -> Size
3593
3594 This gets the horizontal and vertical resolution in device units. It
3595 can be used to scale graphics to fit the page. For example, if *maxX*
3596 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3597 used in your application, the following code will scale the graphic to
3598 fit on the printer page::
3599
3600 w, h = dc.GetSize()
3601 scaleX = maxX*1.0 / w
3602 scaleY = maxY*1.0 / h
3603 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3604
3605 """
3606 return _gdi_.DC_GetSize(*args, **kwargs)
3607
3608 def GetSizeTuple(*args, **kwargs):
3609 """
3610 GetSizeTuple() -> (width, height)
3611
3612 This gets the horizontal and vertical resolution in device units. It
3613 can be used to scale graphics to fit the page. For example, if *maxX*
3614 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3615 used in your application, the following code will scale the graphic to
3616 fit on the printer page::
3617
3618 w, h = dc.GetSize()
3619 scaleX = maxX*1.0 / w
3620 scaleY = maxY*1.0 / h
3621 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3622
3623 """
3624 return _gdi_.DC_GetSizeTuple(*args, **kwargs)
3625
3626 def GetSizeMM(*args, **kwargs):
3627 """
3628 GetSizeMM(self) -> Size
3629
3630 Get the DC size in milimeters.
3631 """
3632 return _gdi_.DC_GetSizeMM(*args, **kwargs)
3633
3634 def GetSizeMMTuple(*args, **kwargs):
3635 """
3636 GetSizeMMTuple() -> (width, height)
3637
3638 Get the DC size in milimeters.
3639 """
3640 return _gdi_.DC_GetSizeMMTuple(*args, **kwargs)
3641
3642 def DeviceToLogicalX(*args, **kwargs):
3643 """
3644 DeviceToLogicalX(self, int x) -> int
3645
3646 Convert device X coordinate to logical coordinate, using the current
3647 mapping mode.
3648 """
3649 return _gdi_.DC_DeviceToLogicalX(*args, **kwargs)
3650
3651 def DeviceToLogicalY(*args, **kwargs):
3652 """
3653 DeviceToLogicalY(self, int y) -> int
3654
3655 Converts device Y coordinate to logical coordinate, using the current
3656 mapping mode.
3657 """
3658 return _gdi_.DC_DeviceToLogicalY(*args, **kwargs)
3659
3660 def DeviceToLogicalXRel(*args, **kwargs):
3661 """
3662 DeviceToLogicalXRel(self, int x) -> int
3663
3664 Convert device X coordinate to relative logical coordinate, using the
3665 current mapping mode but ignoring the x axis orientation. Use this
3666 function for converting a width, for example.
3667 """
3668 return _gdi_.DC_DeviceToLogicalXRel(*args, **kwargs)
3669
3670 def DeviceToLogicalYRel(*args, **kwargs):
3671 """
3672 DeviceToLogicalYRel(self, int y) -> int
3673
3674 Convert device Y coordinate to relative logical coordinate, using the
3675 current mapping mode but ignoring the y axis orientation. Use this
3676 function for converting a height, for example.
3677 """
3678 return _gdi_.DC_DeviceToLogicalYRel(*args, **kwargs)
3679
3680 def LogicalToDeviceX(*args, **kwargs):
3681 """
3682 LogicalToDeviceX(self, int x) -> int
3683
3684 Converts logical X coordinate to device coordinate, using the current
3685 mapping mode.
3686 """
3687 return _gdi_.DC_LogicalToDeviceX(*args, **kwargs)
3688
3689 def LogicalToDeviceY(*args, **kwargs):
3690 """
3691 LogicalToDeviceY(self, int y) -> int
3692
3693 Converts logical Y coordinate to device coordinate, using the current
3694 mapping mode.
3695 """
3696 return _gdi_.DC_LogicalToDeviceY(*args, **kwargs)
3697
3698 def LogicalToDeviceXRel(*args, **kwargs):
3699 """
3700 LogicalToDeviceXRel(self, int x) -> int
3701
3702 Converts logical X coordinate to relative device coordinate, using the
3703 current mapping mode but ignoring the x axis orientation. Use this for
3704 converting a width, for example.
3705 """
3706 return _gdi_.DC_LogicalToDeviceXRel(*args, **kwargs)
3707
3708 def LogicalToDeviceYRel(*args, **kwargs):
3709 """
3710 LogicalToDeviceYRel(self, int y) -> int
3711
3712 Converts logical Y coordinate to relative device coordinate, using the
3713 current mapping mode but ignoring the y axis orientation. Use this for
3714 converting a height, for example.
3715 """
3716 return _gdi_.DC_LogicalToDeviceYRel(*args, **kwargs)
3717
3718 def CanDrawBitmap(*args, **kwargs):
3719 """CanDrawBitmap(self) -> bool"""
3720 return _gdi_.DC_CanDrawBitmap(*args, **kwargs)
3721
3722 def CanGetTextExtent(*args, **kwargs):
3723 """CanGetTextExtent(self) -> bool"""
3724 return _gdi_.DC_CanGetTextExtent(*args, **kwargs)
3725
3726 def GetDepth(*args, **kwargs):
3727 """
3728 GetDepth(self) -> int
3729
3730 Returns the colour depth of the DC.
3731 """
3732 return _gdi_.DC_GetDepth(*args, **kwargs)
3733
3734 def GetPPI(*args, **kwargs):
3735 """
3736 GetPPI(self) -> Size
3737
3738 Resolution in pixels per inch
3739 """
3740 return _gdi_.DC_GetPPI(*args, **kwargs)
3741
3742 def Ok(*args, **kwargs):
3743 """
3744 Ok(self) -> bool
3745
3746 Returns true if the DC is ok to use.
3747 """
3748 return _gdi_.DC_Ok(*args, **kwargs)
3749
3750 def GetBackgroundMode(*args, **kwargs):
3751 """
3752 GetBackgroundMode(self) -> int
3753
3754 Returns the current background mode, either ``wx.SOLID`` or
3755 ``wx.TRANSPARENT``.
3756 """
3757 return _gdi_.DC_GetBackgroundMode(*args, **kwargs)
3758
3759 def GetBackground(*args, **kwargs):
3760 """
3761 GetBackground(self) -> Brush
3762
3763 Gets the brush used for painting the background.
3764 """
3765 return _gdi_.DC_GetBackground(*args, **kwargs)
3766
3767 def GetBrush(*args, **kwargs):
3768 """
3769 GetBrush(self) -> Brush
3770
3771 Gets the current brush
3772 """
3773 return _gdi_.DC_GetBrush(*args, **kwargs)
3774
3775 def GetFont(*args, **kwargs):
3776 """
3777 GetFont(self) -> Font
3778
3779 Gets the current font
3780 """
3781 return _gdi_.DC_GetFont(*args, **kwargs)
3782
3783 def GetPen(*args, **kwargs):
3784 """
3785 GetPen(self) -> Pen
3786
3787 Gets the current pen
3788 """
3789 return _gdi_.DC_GetPen(*args, **kwargs)
3790
3791 def GetTextBackground(*args, **kwargs):
3792 """
3793 GetTextBackground(self) -> Colour
3794
3795 Gets the current text background colour
3796 """
3797 return _gdi_.DC_GetTextBackground(*args, **kwargs)
3798
3799 def GetTextForeground(*args, **kwargs):
3800 """
3801 GetTextForeground(self) -> Colour
3802
3803 Gets the current text foreground colour
3804 """
3805 return _gdi_.DC_GetTextForeground(*args, **kwargs)
3806
3807 def SetTextForeground(*args, **kwargs):
3808 """
3809 SetTextForeground(self, Colour colour)
3810
3811 Sets the current text foreground colour for the DC.
3812 """
3813 return _gdi_.DC_SetTextForeground(*args, **kwargs)
3814
3815 def SetTextBackground(*args, **kwargs):
3816 """
3817 SetTextBackground(self, Colour colour)
3818
3819 Sets the current text background colour for the DC.
3820 """
3821 return _gdi_.DC_SetTextBackground(*args, **kwargs)
3822
3823 def GetMapMode(*args, **kwargs):
3824 """
3825 GetMapMode(self) -> int
3826
3827 Gets the current *mapping mode* for the device context
3828 """
3829 return _gdi_.DC_GetMapMode(*args, **kwargs)
3830
3831 def SetMapMode(*args, **kwargs):
3832 """
3833 SetMapMode(self, int mode)
3834
3835 The *mapping mode* of the device context defines the unit of
3836 measurement used to convert logical units to device units. The
3837 mapping mode can be one of the following:
3838
3839 ================ =============================================
3840 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3841 of an inch.
3842 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3843 wx.MM_METRIC Each logical unit is 1 mm.
3844 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3845 wx.MM_TEXT Each logical unit is 1 pixel.
3846 ================ =============================================
3847
3848 """
3849 return _gdi_.DC_SetMapMode(*args, **kwargs)
3850
3851 def GetUserScale(*args, **kwargs):
3852 """
3853 GetUserScale(self) -> (xScale, yScale)
3854
3855 Gets the current user scale factor (set by `SetUserScale`).
3856 """
3857 return _gdi_.DC_GetUserScale(*args, **kwargs)
3858
3859 def SetUserScale(*args, **kwargs):
3860 """
3861 SetUserScale(self, double x, double y)
3862
3863 Sets the user scaling factor, useful for applications which require
3864 'zooming'.
3865 """
3866 return _gdi_.DC_SetUserScale(*args, **kwargs)
3867
3868 def GetLogicalScale(*args, **kwargs):
3869 """GetLogicalScale() -> (xScale, yScale)"""
3870 return _gdi_.DC_GetLogicalScale(*args, **kwargs)
3871
3872 def SetLogicalScale(*args, **kwargs):
3873 """SetLogicalScale(self, double x, double y)"""
3874 return _gdi_.DC_SetLogicalScale(*args, **kwargs)
3875
3876 def GetLogicalOrigin(*args, **kwargs):
3877 """GetLogicalOrigin(self) -> Point"""
3878 return _gdi_.DC_GetLogicalOrigin(*args, **kwargs)
3879
3880 def GetLogicalOriginTuple(*args, **kwargs):
3881 """GetLogicalOriginTuple() -> (x,y)"""
3882 return _gdi_.DC_GetLogicalOriginTuple(*args, **kwargs)
3883
3884 def SetLogicalOrigin(*args, **kwargs):
3885 """SetLogicalOrigin(self, int x, int y)"""
3886 return _gdi_.DC_SetLogicalOrigin(*args, **kwargs)
3887
3888 def SetLogicalOriginPoint(*args, **kwargs):
3889 """SetLogicalOriginPoint(self, Point point)"""
3890 return _gdi_.DC_SetLogicalOriginPoint(*args, **kwargs)
3891
3892 def GetDeviceOrigin(*args, **kwargs):
3893 """GetDeviceOrigin(self) -> Point"""
3894 return _gdi_.DC_GetDeviceOrigin(*args, **kwargs)
3895
3896 def GetDeviceOriginTuple(*args, **kwargs):
3897 """GetDeviceOriginTuple() -> (x,y)"""
3898 return _gdi_.DC_GetDeviceOriginTuple(*args, **kwargs)
3899
3900 def SetDeviceOrigin(*args, **kwargs):
3901 """SetDeviceOrigin(self, int x, int y)"""
3902 return _gdi_.DC_SetDeviceOrigin(*args, **kwargs)
3903
3904 def SetDeviceOriginPoint(*args, **kwargs):
3905 """SetDeviceOriginPoint(self, Point point)"""
3906 return _gdi_.DC_SetDeviceOriginPoint(*args, **kwargs)
3907
3908 def SetAxisOrientation(*args, **kwargs):
3909 """
3910 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
3911
3912 Sets the x and y axis orientation (i.e., the direction from lowest to
3913 highest values on the axis). The default orientation is the natural
3914 orientation, e.g. x axis from left to right and y axis from bottom up.
3915 """
3916 return _gdi_.DC_SetAxisOrientation(*args, **kwargs)
3917
3918 def GetLogicalFunction(*args, **kwargs):
3919 """
3920 GetLogicalFunction(self) -> int
3921
3922 Gets the current logical function (set by `SetLogicalFunction`).
3923 """
3924 return _gdi_.DC_GetLogicalFunction(*args, **kwargs)
3925
3926 def SetLogicalFunction(*args, **kwargs):
3927 """
3928 SetLogicalFunction(self, int function)
3929
3930 Sets the current logical function for the device context. This
3931 determines how a source pixel (from a pen or brush colour, or source
3932 device context if using `Blit`) combines with a destination pixel in
3933 the current device context.
3934
3935 The possible values and their meaning in terms of source and
3936 destination pixel values are as follows:
3937
3938 ================ ==========================
3939 wx.AND src AND dst
3940 wx.AND_INVERT (NOT src) AND dst
3941 wx.AND_REVERSE src AND (NOT dst)
3942 wx.CLEAR 0
3943 wx.COPY src
3944 wx.EQUIV (NOT src) XOR dst
3945 wx.INVERT NOT dst
3946 wx.NAND (NOT src) OR (NOT dst)
3947 wx.NOR (NOT src) AND (NOT dst)
3948 wx.NO_OP dst
3949 wx.OR src OR dst
3950 wx.OR_INVERT (NOT src) OR dst
3951 wx.OR_REVERSE src OR (NOT dst)
3952 wx.SET 1
3953 wx.SRC_INVERT NOT src
3954 wx.XOR src XOR dst
3955 ================ ==========================
3956
3957 The default is wx.COPY, which simply draws with the current
3958 colour. The others combine the current colour and the background using
3959 a logical operation. wx.INVERT is commonly used for drawing rubber
3960 bands or moving outlines, since drawing twice reverts to the original
3961 colour.
3962
3963 """
3964 return _gdi_.DC_SetLogicalFunction(*args, **kwargs)
3965
3966 def ComputeScaleAndOrigin(*args, **kwargs):
3967 """
3968 ComputeScaleAndOrigin(self)
3969
3970 Performs all necessary computations for given platform and context
3971 type after each change of scale and origin parameters. Usually called
3972 automatically internally after such changes.
3973
3974 """
3975 return _gdi_.DC_ComputeScaleAndOrigin(*args, **kwargs)
3976
3977 def SetOptimization(self, optimize):
3978 pass
3979 def GetOptimization(self):
3980 return False
3981
3982 SetOptimization = wx._deprecated(SetOptimization)
3983 GetOptimization = wx._deprecated(GetOptimization)
3984
3985 def CalcBoundingBox(*args, **kwargs):
3986 """
3987 CalcBoundingBox(self, int x, int y)
3988
3989 Adds the specified point to the bounding box which can be retrieved
3990 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3991 """
3992 return _gdi_.DC_CalcBoundingBox(*args, **kwargs)
3993
3994 def CalcBoundingBoxPoint(*args, **kwargs):
3995 """
3996 CalcBoundingBoxPoint(self, Point point)
3997
3998 Adds the specified point to the bounding box which can be retrieved
3999 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4000 """
4001 return _gdi_.DC_CalcBoundingBoxPoint(*args, **kwargs)
4002
4003 def ResetBoundingBox(*args, **kwargs):
4004 """
4005 ResetBoundingBox(self)
4006
4007 Resets the bounding box: after a call to this function, the bounding
4008 box doesn't contain anything.
4009 """
4010 return _gdi_.DC_ResetBoundingBox(*args, **kwargs)
4011
4012 def MinX(*args, **kwargs):
4013 """
4014 MinX(self) -> int
4015
4016 Gets the minimum horizontal extent used in drawing commands so far.
4017 """
4018 return _gdi_.DC_MinX(*args, **kwargs)
4019
4020 def MaxX(*args, **kwargs):
4021 """
4022 MaxX(self) -> int
4023
4024 Gets the maximum horizontal extent used in drawing commands so far.
4025 """
4026 return _gdi_.DC_MaxX(*args, **kwargs)
4027
4028 def MinY(*args, **kwargs):
4029 """
4030 MinY(self) -> int
4031
4032 Gets the minimum vertical extent used in drawing commands so far.
4033 """
4034 return _gdi_.DC_MinY(*args, **kwargs)
4035
4036 def MaxY(*args, **kwargs):
4037 """
4038 MaxY(self) -> int
4039
4040 Gets the maximum vertical extent used in drawing commands so far.
4041 """
4042 return _gdi_.DC_MaxY(*args, **kwargs)
4043
4044 def GetBoundingBox(*args, **kwargs):
4045 """
4046 GetBoundingBox() -> (x1,y1, x2,y2)
4047
4048 Returns the min and max points used in drawing commands so far.
4049 """
4050 return _gdi_.DC_GetBoundingBox(*args, **kwargs)
4051
4052 def __nonzero__(self): return self.Ok()
4053 def _DrawPointList(*args, **kwargs):
4054 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4055 return _gdi_.DC__DrawPointList(*args, **kwargs)
4056
4057 def _DrawLineList(*args, **kwargs):
4058 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4059 return _gdi_.DC__DrawLineList(*args, **kwargs)
4060
4061 def _DrawRectangleList(*args, **kwargs):
4062 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4063 return _gdi_.DC__DrawRectangleList(*args, **kwargs)
4064
4065 def _DrawEllipseList(*args, **kwargs):
4066 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4067 return _gdi_.DC__DrawEllipseList(*args, **kwargs)
4068
4069 def _DrawPolygonList(*args, **kwargs):
4070 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4071 return _gdi_.DC__DrawPolygonList(*args, **kwargs)
4072
4073 def _DrawTextList(*args, **kwargs):
4074 """
4075 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
4076 PyObject backgroundList) -> PyObject
4077 """
4078 return _gdi_.DC__DrawTextList(*args, **kwargs)
4079
4080 def DrawPointList(self, points, pens=None):
4081 """
4082 Draw a list of points as quickly as possible.
4083
4084 :param points: A sequence of 2-element sequences representing
4085 each point to draw, (x,y).
4086 :param pens: If None, then the current pen is used. If a
4087 single pen then it will be used for all points. If
4088 a list of pens then there should be one for each point
4089 in points.
4090 """
4091 if pens is None:
4092 pens = []
4093 elif isinstance(pens, wx.Pen):
4094 pens = [pens]
4095 elif len(pens) != len(points):
4096 raise ValueError('points and pens must have same length')
4097 return self._DrawPointList(points, pens, [])
4098
4099
4100 def DrawLineList(self, lines, pens=None):
4101 """
4102 Draw a list of lines as quickly as possible.
4103
4104 :param lines: A sequence of 4-element sequences representing
4105 each line to draw, (x1,y1, x2,y2).
4106 :param pens: If None, then the current pen is used. If a
4107 single pen then it will be used for all lines. If
4108 a list of pens then there should be one for each line
4109 in lines.
4110 """
4111 if pens is None:
4112 pens = []
4113 elif isinstance(pens, wx.Pen):
4114 pens = [pens]
4115 elif len(pens) != len(lines):
4116 raise ValueError('lines and pens must have same length')
4117 return self._DrawLineList(lines, pens, [])
4118
4119
4120 def DrawRectangleList(self, rectangles, pens=None, brushes=None):
4121 """
4122 Draw a list of rectangles as quickly as possible.
4123
4124 :param rectangles: A sequence of 4-element sequences representing
4125 each rectangle to draw, (x,y, w,h).
4126 :param pens: If None, then the current pen is used. If a
4127 single pen then it will be used for all rectangles.
4128 If a list of pens then there should be one for each
4129 rectangle in rectangles.
4130 :param brushes: A brush or brushes to be used to fill the rectagles,
4131 with similar semantics as the pens parameter.
4132 """
4133 if pens is None:
4134 pens = []
4135 elif isinstance(pens, wx.Pen):
4136 pens = [pens]
4137 elif len(pens) != len(rectangles):
4138 raise ValueError('rectangles and pens must have same length')
4139 if brushes is None:
4140 brushes = []
4141 elif isinstance(brushes, wx.Brush):
4142 brushes = [brushes]
4143 elif len(brushes) != len(rectangles):
4144 raise ValueError('rectangles and brushes must have same length')
4145 return self._DrawRectangleList(rectangles, pens, brushes)
4146
4147
4148 def DrawEllipseList(self, ellipses, pens=None, brushes=None):
4149 """
4150 Draw a list of ellipses as quickly as possible.
4151
4152 :param ellipses: A sequence of 4-element sequences representing
4153 each ellipse to draw, (x,y, w,h).
4154 :param pens: If None, then the current pen is used. If a
4155 single pen then it will be used for all ellipses.
4156 If a list of pens then there should be one for each
4157 ellipse in ellipses.
4158 :param brushes: A brush or brushes to be used to fill the ellipses,
4159 with similar semantics as the pens parameter.
4160 """
4161 if pens is None:
4162 pens = []
4163 elif isinstance(pens, wx.Pen):
4164 pens = [pens]
4165 elif len(pens) != len(ellipses):
4166 raise ValueError('ellipses and pens must have same length')
4167 if brushes is None:
4168 brushes = []
4169 elif isinstance(brushes, wx.Brush):
4170 brushes = [brushes]
4171 elif len(brushes) != len(ellipses):
4172 raise ValueError('ellipses and brushes must have same length')
4173 return self._DrawEllipseList(ellipses, pens, brushes)
4174
4175
4176 def DrawPolygonList(self, polygons, pens=None, brushes=None):
4177 """
4178 Draw a list of polygons, each of which is a list of points.
4179
4180 :param polygons: A sequence of sequences of sequences.
4181 [[(x1,y1),(x2,y2),(x3,y3)...],
4182 [(x1,y1),(x2,y2),(x3,y3)...]]
4183
4184 :param pens: If None, then the current pen is used. If a
4185 single pen then it will be used for all polygons.
4186 If a list of pens then there should be one for each
4187 polygon.
4188 :param brushes: A brush or brushes to be used to fill the polygons,
4189 with similar semantics as the pens parameter.
4190 """
4191 if pens is None:
4192 pens = []
4193 elif isinstance(pens, wx.Pen):
4194 pens = [pens]
4195 elif len(pens) != len(polygons):
4196 raise ValueError('polygons and pens must have same length')
4197 if brushes is None:
4198 brushes = []
4199 elif isinstance(brushes, wx.Brush):
4200 brushes = [brushes]
4201 elif len(brushes) != len(polygons):
4202 raise ValueError('polygons and brushes must have same length')
4203 return self._DrawPolygonList(polygons, pens, brushes)
4204
4205
4206 def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None):
4207 """
4208 Draw a list of strings using a list of coordinants for positioning each string.
4209
4210 :param textList: A list of strings
4211 :param coords: A list of (x,y) positions
4212 :param foregrounds: A list of `wx.Colour` objects to use for the
4213 foregrounds of the strings.
4214 :param backgrounds: A list of `wx.Colour` objects to use for the
4215 backgrounds of the strings.
4216
4217 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4218 If you want backgrounds to do anything.
4219 """
4220 if type(textList) == type(''):
4221 textList = [textList]
4222 elif len(textList) != len(coords):
4223 raise ValueError('textlist and coords must have same length')
4224 if foregrounds is None:
4225 foregrounds = []
4226 elif isinstance(foregrounds, wx.Colour):
4227 foregrounds = [foregrounds]
4228 elif len(foregrounds) != len(coords):
4229 raise ValueError('foregrounds and coords must have same length')
4230 if backgrounds is None:
4231 backgrounds = []
4232 elif isinstance(backgrounds, wx.Colour):
4233 backgrounds = [backgrounds]
4234 elif len(backgrounds) != len(coords):
4235 raise ValueError('backgrounds and coords must have same length')
4236 return self._DrawTextList(textList, coords, foregrounds, backgrounds)
4237
4238 _gdi_.DC_swigregister(DC)
4239
4240 #---------------------------------------------------------------------------
4241
4242 class MemoryDC(DC):
4243 """
4244 A memory device context provides a means to draw graphics onto a
4245 bitmap. A bitmap must be selected into the new memory DC before it may
4246 be used for anything. Typical usage is as follows::
4247
4248 dc = wx.MemoryDC()
4249 dc.SelectObject(bitmap)
4250 # draw on the dc usign any of the Draw methods
4251 dc.SelectObject(wx.NullBitmap)
4252 # the bitmap now contains wahtever was drawn upon it
4253
4254 Note that the memory DC *must* be deleted (or the bitmap selected out
4255 of it) before a bitmap can be reselected into another memory DC.
4256
4257 """
4258 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4259 __repr__ = _swig_repr
4260 def __init__(self, *args, **kwargs):
4261 """
4262 __init__(self) -> MemoryDC
4263
4264 Constructs a new memory device context.
4265
4266 Use the Ok member to test whether the constructor was successful in
4267 creating a usable device context. Don't forget to select a bitmap into
4268 the DC before drawing on it.
4269 """
4270 _gdi_.MemoryDC_swiginit(self,_gdi_.new_MemoryDC(*args, **kwargs))
4271 def SelectObject(*args, **kwargs):
4272 """
4273 SelectObject(self, Bitmap bitmap)
4274
4275 Selects the bitmap into the device context, to use as the memory
4276 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4277 the DC, and therefore the bitmap, and also to use Blit to copy the
4278 bitmap to a window.
4279
4280 If the argument is wx.NullBitmap (or some other uninitialised
4281 `wx.Bitmap`) the current bitmap is selected out of the device context,
4282 and the original bitmap restored, allowing the current bitmap to be
4283 destroyed safely.
4284 """
4285 return _gdi_.MemoryDC_SelectObject(*args, **kwargs)
4286
4287 _gdi_.MemoryDC_swigregister(MemoryDC)
4288
4289 def MemoryDCFromDC(*args, **kwargs):
4290 """
4291 MemoryDCFromDC(DC oldDC) -> MemoryDC
4292
4293 Creates a DC that is compatible with the oldDC.
4294 """
4295 val = _gdi_.new_MemoryDCFromDC(*args, **kwargs)
4296 return val
4297
4298 #---------------------------------------------------------------------------
4299
4300 BUFFER_VIRTUAL_AREA = _gdi_.BUFFER_VIRTUAL_AREA
4301 BUFFER_CLIENT_AREA = _gdi_.BUFFER_CLIENT_AREA
4302 class BufferedDC(MemoryDC):
4303 """
4304 This simple class provides a simple way to avoid flicker: when drawing
4305 on it, everything is in fact first drawn on an in-memory buffer (a
4306 `wx.Bitmap`) and then copied to the screen only once, when this object
4307 is destroyed.
4308
4309 It can be used in the same way as any other device
4310 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
4311 want to use it in your EVT_PAINT handler, you should look at
4312 `wx.BufferedPaintDC`.
4313
4314 """
4315 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4316 __repr__ = _swig_repr
4317 def __init__(self, *args):
4318 """
4319 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4320 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4321
4322 Constructs a buffered DC.
4323 """
4324 _gdi_.BufferedDC_swiginit(self,_gdi_.new_BufferedDC(*args))
4325 self.__dc = args[0] # save a ref so the other dc will not be deleted before self
4326
4327 __swig_destroy__ = _gdi_.delete_BufferedDC
4328 __del__ = lambda self : None;
4329 def UnMask(*args, **kwargs):
4330 """
4331 UnMask(self)
4332
4333 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4334 can be effectively used once only). This is usually only called in
4335 the destructor.
4336 """
4337 return _gdi_.BufferedDC_UnMask(*args, **kwargs)
4338
4339 _gdi_.BufferedDC_swigregister(BufferedDC)
4340
4341 class BufferedPaintDC(BufferedDC):
4342 """
4343 This is a subclass of `wx.BufferedDC` which can be used inside of an
4344 EVT_PAINT event handler. Just create an object of this class instead
4345 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4346 flicker. The only thing to watch out for is that if you are using this
4347 class together with `wx.ScrolledWindow`, you probably do **not** want
4348 to call `wx.Window.PrepareDC` on it as it already does this internally
4349 for the real underlying `wx.PaintDC`.
4350
4351 If your window is already fully buffered in a `wx.Bitmap` then your
4352 EVT_PAINT handler can be as simple as just creating a
4353 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4354 automatically when it is destroyed. For example::
4355
4356 def OnPaint(self, event):
4357 dc = wx.BufferedPaintDC(self, self.buffer)
4358
4359
4360
4361
4362
4363 """
4364 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4365 __repr__ = _swig_repr
4366 def __init__(self, *args, **kwargs):
4367 """
4368 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
4369
4370 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4371 provide the bitmap to be used for buffering or let this object create
4372 one internally (in the latter case, the size of the client part of the
4373 window is automatically used).
4374
4375
4376 """
4377 _gdi_.BufferedPaintDC_swiginit(self,_gdi_.new_BufferedPaintDC(*args, **kwargs))
4378 _gdi_.BufferedPaintDC_swigregister(BufferedPaintDC)
4379
4380 #---------------------------------------------------------------------------
4381
4382 class ScreenDC(DC):
4383 """
4384 A wxScreenDC can be used to paint anywhere on the screen. This should
4385 normally be constructed as a temporary stack object; don't store a
4386 wxScreenDC object.
4387
4388 """
4389 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4390 __repr__ = _swig_repr
4391 def __init__(self, *args, **kwargs):
4392 """
4393 __init__(self) -> ScreenDC
4394
4395 A wxScreenDC can be used to paint anywhere on the screen. This should
4396 normally be constructed as a temporary stack object; don't store a
4397 wxScreenDC object.
4398
4399 """
4400 _gdi_.ScreenDC_swiginit(self,_gdi_.new_ScreenDC(*args, **kwargs))
4401 def StartDrawingOnTopWin(*args, **kwargs):
4402 """
4403 StartDrawingOnTopWin(self, Window window) -> bool
4404
4405 Specify that the area of the screen to be drawn upon coincides with
4406 the given window.
4407
4408 :see: `EndDrawingOnTop`
4409 """
4410 return _gdi_.ScreenDC_StartDrawingOnTopWin(*args, **kwargs)
4411
4412 def StartDrawingOnTop(*args, **kwargs):
4413 """
4414 StartDrawingOnTop(self, Rect rect=None) -> bool
4415
4416 Specify that the area is the given rectangle, or the whole screen if
4417 ``None`` is passed.
4418
4419 :see: `EndDrawingOnTop`
4420 """
4421 return _gdi_.ScreenDC_StartDrawingOnTop(*args, **kwargs)
4422
4423 def EndDrawingOnTop(*args, **kwargs):
4424 """
4425 EndDrawingOnTop(self) -> bool
4426
4427 Use this in conjunction with `StartDrawingOnTop` or
4428 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4429 top of existing windows. Without this, some window systems (such as X)
4430 only allow drawing to take place underneath other windows.
4431
4432 You might use this pair of functions when implementing a drag feature,
4433 for example as in the `wx.SplitterWindow` implementation.
4434
4435 These functions are probably obsolete since the X implementations
4436 allow drawing directly on the screen now. However, the fact that this
4437 function allows the screen to be refreshed afterwards may be useful
4438 to some applications.
4439 """
4440 return _gdi_.ScreenDC_EndDrawingOnTop(*args, **kwargs)
4441
4442 _gdi_.ScreenDC_swigregister(ScreenDC)
4443
4444 #---------------------------------------------------------------------------
4445
4446 class ClientDC(DC):
4447 """
4448 A wx.ClientDC must be constructed if an application wishes to paint on
4449 the client area of a window from outside an EVT_PAINT event. This should
4450 normally be constructed as a temporary stack object; don't store a
4451 wx.ClientDC object long term.
4452
4453 To draw on a window from within an EVT_PAINT handler, construct a
4454 `wx.PaintDC` object.
4455
4456 To draw on the whole window including decorations, construct a
4457 `wx.WindowDC` object (Windows only).
4458
4459 """
4460 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4461 __repr__ = _swig_repr
4462 def __init__(self, *args, **kwargs):
4463 """
4464 __init__(self, Window win) -> ClientDC
4465
4466 Constructor. Pass the window on which you wish to paint.
4467 """
4468 _gdi_.ClientDC_swiginit(self,_gdi_.new_ClientDC(*args, **kwargs))
4469 _gdi_.ClientDC_swigregister(ClientDC)
4470
4471 #---------------------------------------------------------------------------
4472
4473 class PaintDC(DC):
4474 """
4475 A wx.PaintDC must be constructed if an application wishes to paint on
4476 the client area of a window from within an EVT_PAINT event
4477 handler. This should normally be constructed as a temporary stack
4478 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4479 handler, you **must** create a wx.PaintDC object within it even if you
4480 don't actually use it.
4481
4482 Using wx.PaintDC within EVT_PAINT handlers is important because it
4483 automatically sets the clipping area to the damaged area of the
4484 window. Attempts to draw outside this area do not appear.
4485
4486 To draw on a window from outside EVT_PAINT handlers, construct a
4487 `wx.ClientDC` object.
4488
4489 """
4490 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4491 __repr__ = _swig_repr
4492 def __init__(self, *args, **kwargs):
4493 """
4494 __init__(self, Window win) -> PaintDC
4495
4496 Constructor. Pass the window on which you wish to paint.
4497 """
4498 _gdi_.PaintDC_swiginit(self,_gdi_.new_PaintDC(*args, **kwargs))
4499 _gdi_.PaintDC_swigregister(PaintDC)
4500
4501 #---------------------------------------------------------------------------
4502
4503 class WindowDC(DC):
4504 """
4505 A wx.WindowDC must be constructed if an application wishes to paint on
4506 the whole area of a window (client and decorations). This should
4507 normally be constructed as a temporary stack object; don't store a
4508 wx.WindowDC object.
4509 """
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):
4513 """
4514 __init__(self, Window win) -> WindowDC
4515
4516 Constructor. Pass the window on which you wish to paint.
4517 """
4518 _gdi_.WindowDC_swiginit(self,_gdi_.new_WindowDC(*args, **kwargs))
4519 _gdi_.WindowDC_swigregister(WindowDC)
4520
4521 #---------------------------------------------------------------------------
4522
4523 class MirrorDC(DC):
4524 """
4525 wx.MirrorDC is a simple wrapper class which is always associated with a
4526 real `wx.DC` object and either forwards all of its operations to it
4527 without changes (no mirroring takes place) or exchanges x and y
4528 coordinates which makes it possible to reuse the same code to draw a
4529 figure and its mirror -- i.e. reflection related to the diagonal line
4530 x == y.
4531 """
4532 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4533 __repr__ = _swig_repr
4534 def __init__(self, *args, **kwargs):
4535 """
4536 __init__(self, DC dc, bool mirror) -> MirrorDC
4537
4538 Creates a mirrored DC associated with the real *dc*. Everything drawn
4539 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4540 *mirror* is True.
4541 """
4542 _gdi_.MirrorDC_swiginit(self,_gdi_.new_MirrorDC(*args, **kwargs))
4543 _gdi_.MirrorDC_swigregister(MirrorDC)
4544
4545 #---------------------------------------------------------------------------
4546
4547 class PostScriptDC(DC):
4548 """This is a `wx.DC` that can write to PostScript files on any platform."""
4549 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4550 __repr__ = _swig_repr
4551 def __init__(self, *args, **kwargs):
4552 """
4553 __init__(self, wxPrintData printData) -> PostScriptDC
4554
4555 Constructs a PostScript printer device context from a `wx.PrintData`
4556 object.
4557 """
4558 _gdi_.PostScriptDC_swiginit(self,_gdi_.new_PostScriptDC(*args, **kwargs))
4559 def GetPrintData(*args, **kwargs):
4560 """GetPrintData(self) -> wxPrintData"""
4561 return _gdi_.PostScriptDC_GetPrintData(*args, **kwargs)
4562
4563 def SetPrintData(*args, **kwargs):
4564 """SetPrintData(self, wxPrintData data)"""
4565 return _gdi_.PostScriptDC_SetPrintData(*args, **kwargs)
4566
4567 def SetResolution(*args, **kwargs):
4568 """
4569 SetResolution(int ppi)
4570
4571 Set resolution (in pixels per inch) that will be used in PostScript
4572 output. Default is 720ppi.
4573 """
4574 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
4575
4576 SetResolution = staticmethod(SetResolution)
4577 def GetResolution(*args, **kwargs):
4578 """
4579 GetResolution() -> int
4580
4581 Return resolution used in PostScript output.
4582 """
4583 return _gdi_.PostScriptDC_GetResolution(*args, **kwargs)
4584
4585 GetResolution = staticmethod(GetResolution)
4586 _gdi_.PostScriptDC_swigregister(PostScriptDC)
4587
4588 def PostScriptDC_SetResolution(*args, **kwargs):
4589 """
4590 PostScriptDC_SetResolution(int ppi)
4591
4592 Set resolution (in pixels per inch) that will be used in PostScript
4593 output. Default is 720ppi.
4594 """
4595 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
4596
4597 def PostScriptDC_GetResolution(*args):
4598 """
4599 PostScriptDC_GetResolution() -> int
4600
4601 Return resolution used in PostScript output.
4602 """
4603 return _gdi_.PostScriptDC_GetResolution(*args)
4604
4605 #---------------------------------------------------------------------------
4606
4607 class MetaFile(_core.Object):
4608 """Proxy of C++ MetaFile class"""
4609 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4610 __repr__ = _swig_repr
4611 def __init__(self, *args, **kwargs):
4612 """__init__(self, String filename=EmptyString) -> MetaFile"""
4613 _gdi_.MetaFile_swiginit(self,_gdi_.new_MetaFile(*args, **kwargs))
4614 _gdi_.MetaFile_swigregister(MetaFile)
4615
4616 class MetaFileDC(DC):
4617 """Proxy of C++ MetaFileDC class"""
4618 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4619 __repr__ = _swig_repr
4620 def __init__(self, *args, **kwargs):
4621 """
4622 __init__(self, String filename=EmptyString, int width=0, int height=0,
4623 String description=EmptyString) -> MetaFileDC
4624 """
4625 _gdi_.MetaFileDC_swiginit(self,_gdi_.new_MetaFileDC(*args, **kwargs))
4626 _gdi_.MetaFileDC_swigregister(MetaFileDC)
4627
4628 class PrinterDC(DC):
4629 """Proxy of C++ PrinterDC class"""
4630 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4631 __repr__ = _swig_repr
4632 def __init__(self, *args, **kwargs):
4633 """__init__(self, wxPrintData printData) -> PrinterDC"""
4634 _gdi_.PrinterDC_swiginit(self,_gdi_.new_PrinterDC(*args, **kwargs))
4635 _gdi_.PrinterDC_swigregister(PrinterDC)
4636
4637 #---------------------------------------------------------------------------
4638
4639 IMAGELIST_DRAW_NORMAL = _gdi_.IMAGELIST_DRAW_NORMAL
4640 IMAGELIST_DRAW_TRANSPARENT = _gdi_.IMAGELIST_DRAW_TRANSPARENT
4641 IMAGELIST_DRAW_SELECTED = _gdi_.IMAGELIST_DRAW_SELECTED
4642 IMAGELIST_DRAW_FOCUSED = _gdi_.IMAGELIST_DRAW_FOCUSED
4643 IMAGE_LIST_NORMAL = _gdi_.IMAGE_LIST_NORMAL
4644 IMAGE_LIST_SMALL = _gdi_.IMAGE_LIST_SMALL
4645 IMAGE_LIST_STATE = _gdi_.IMAGE_LIST_STATE
4646 class ImageList(_core.Object):
4647 """Proxy of C++ ImageList class"""
4648 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4649 __repr__ = _swig_repr
4650 def __init__(self, *args, **kwargs):
4651 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
4652 _gdi_.ImageList_swiginit(self,_gdi_.new_ImageList(*args, **kwargs))
4653 __swig_destroy__ = _gdi_.delete_ImageList
4654 __del__ = lambda self : None;
4655 def Add(*args, **kwargs):
4656 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
4657 return _gdi_.ImageList_Add(*args, **kwargs)
4658
4659 def AddWithColourMask(*args, **kwargs):
4660 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
4661 return _gdi_.ImageList_AddWithColourMask(*args, **kwargs)
4662
4663 def AddIcon(*args, **kwargs):
4664 """AddIcon(self, Icon icon) -> int"""
4665 return _gdi_.ImageList_AddIcon(*args, **kwargs)
4666
4667 def GetBitmap(*args, **kwargs):
4668 """GetBitmap(self, int index) -> Bitmap"""
4669 return _gdi_.ImageList_GetBitmap(*args, **kwargs)
4670
4671 def GetIcon(*args, **kwargs):
4672 """GetIcon(self, int index) -> Icon"""
4673 return _gdi_.ImageList_GetIcon(*args, **kwargs)
4674
4675 def Replace(*args, **kwargs):
4676 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
4677 return _gdi_.ImageList_Replace(*args, **kwargs)
4678
4679 def Draw(*args, **kwargs):
4680 """
4681 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
4682 bool solidBackground=False) -> bool
4683 """
4684 return _gdi_.ImageList_Draw(*args, **kwargs)
4685
4686 def GetImageCount(*args, **kwargs):
4687 """GetImageCount(self) -> int"""
4688 return _gdi_.ImageList_GetImageCount(*args, **kwargs)
4689
4690 def Remove(*args, **kwargs):
4691 """Remove(self, int index) -> bool"""
4692 return _gdi_.ImageList_Remove(*args, **kwargs)
4693
4694 def RemoveAll(*args, **kwargs):
4695 """RemoveAll(self) -> bool"""
4696 return _gdi_.ImageList_RemoveAll(*args, **kwargs)
4697
4698 def GetSize(*args, **kwargs):
4699 """GetSize(index) -> (width,height)"""
4700 return _gdi_.ImageList_GetSize(*args, **kwargs)
4701
4702 _gdi_.ImageList_swigregister(ImageList)
4703
4704 #---------------------------------------------------------------------------
4705
4706 class StockGDI(object):
4707 """Proxy of C++ StockGDI class"""
4708 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4709 __repr__ = _swig_repr
4710 BRUSH_BLACK = _gdi_.StockGDI_BRUSH_BLACK
4711 BRUSH_BLUE = _gdi_.StockGDI_BRUSH_BLUE
4712 BRUSH_CYAN = _gdi_.StockGDI_BRUSH_CYAN
4713 BRUSH_GREEN = _gdi_.StockGDI_BRUSH_GREEN
4714 BRUSH_GREY = _gdi_.StockGDI_BRUSH_GREY
4715 BRUSH_LIGHTGREY = _gdi_.StockGDI_BRUSH_LIGHTGREY
4716 BRUSH_MEDIUMGREY = _gdi_.StockGDI_BRUSH_MEDIUMGREY
4717 BRUSH_RED = _gdi_.StockGDI_BRUSH_RED
4718 BRUSH_TRANSPARENT = _gdi_.StockGDI_BRUSH_TRANSPARENT
4719 BRUSH_WHITE = _gdi_.StockGDI_BRUSH_WHITE
4720 COLOUR_BLACK = _gdi_.StockGDI_COLOUR_BLACK
4721 COLOUR_BLUE = _gdi_.StockGDI_COLOUR_BLUE
4722 COLOUR_CYAN = _gdi_.StockGDI_COLOUR_CYAN
4723 COLOUR_GREEN = _gdi_.StockGDI_COLOUR_GREEN
4724 COLOUR_LIGHTGREY = _gdi_.StockGDI_COLOUR_LIGHTGREY
4725 COLOUR_RED = _gdi_.StockGDI_COLOUR_RED
4726 COLOUR_WHITE = _gdi_.StockGDI_COLOUR_WHITE
4727 CURSOR_CROSS = _gdi_.StockGDI_CURSOR_CROSS
4728 CURSOR_HOURGLASS = _gdi_.StockGDI_CURSOR_HOURGLASS
4729 CURSOR_STANDARD = _gdi_.StockGDI_CURSOR_STANDARD
4730 FONT_ITALIC = _gdi_.StockGDI_FONT_ITALIC
4731 FONT_NORMAL = _gdi_.StockGDI_FONT_NORMAL
4732 FONT_SMALL = _gdi_.StockGDI_FONT_SMALL
4733 FONT_SWISS = _gdi_.StockGDI_FONT_SWISS
4734 PEN_BLACK = _gdi_.StockGDI_PEN_BLACK
4735 PEN_BLACKDASHED = _gdi_.StockGDI_PEN_BLACKDASHED
4736 PEN_CYAN = _gdi_.StockGDI_PEN_CYAN
4737 PEN_GREEN = _gdi_.StockGDI_PEN_GREEN
4738 PEN_GREY = _gdi_.StockGDI_PEN_GREY
4739 PEN_LIGHTGREY = _gdi_.StockGDI_PEN_LIGHTGREY
4740 PEN_MEDIUMGREY = _gdi_.StockGDI_PEN_MEDIUMGREY
4741 PEN_RED = _gdi_.StockGDI_PEN_RED
4742 PEN_TRANSPARENT = _gdi_.StockGDI_PEN_TRANSPARENT
4743 PEN_WHITE = _gdi_.StockGDI_PEN_WHITE
4744 ITEMCOUNT = _gdi_.StockGDI_ITEMCOUNT
4745 def __init__(self, *args, **kwargs):
4746 """__init__(self) -> StockGDI"""
4747 _gdi_.StockGDI_swiginit(self,_gdi_.new_StockGDI(*args, **kwargs))
4748 __swig_destroy__ = _gdi_.delete_StockGDI
4749 __del__ = lambda self : None;
4750 def DeleteAll(*args, **kwargs):
4751 """DeleteAll()"""
4752 return _gdi_.StockGDI_DeleteAll(*args, **kwargs)
4753
4754 DeleteAll = staticmethod(DeleteAll)
4755 def instance(*args, **kwargs):
4756 """instance() -> StockGDI"""
4757 return _gdi_.StockGDI_instance(*args, **kwargs)
4758
4759 instance = staticmethod(instance)
4760 def GetBrush(*args, **kwargs):
4761 """GetBrush(int item) -> Brush"""
4762 return _gdi_.StockGDI_GetBrush(*args, **kwargs)
4763
4764 GetBrush = staticmethod(GetBrush)
4765 def GetColour(*args, **kwargs):
4766 """GetColour(int item) -> Colour"""
4767 return _gdi_.StockGDI_GetColour(*args, **kwargs)
4768
4769 GetColour = staticmethod(GetColour)
4770 def GetCursor(*args, **kwargs):
4771 """GetCursor(int item) -> Cursor"""
4772 return _gdi_.StockGDI_GetCursor(*args, **kwargs)
4773
4774 GetCursor = staticmethod(GetCursor)
4775 def GetPen(*args, **kwargs):
4776 """GetPen(int item) -> Pen"""
4777 return _gdi_.StockGDI_GetPen(*args, **kwargs)
4778
4779 GetPen = staticmethod(GetPen)
4780 def GetFont(*args, **kwargs):
4781 """GetFont(self, int item) -> Font"""
4782 return _gdi_.StockGDI_GetFont(*args, **kwargs)
4783
4784 def _initStockObjects():
4785 import wx
4786 wx.ITALIC_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_ITALIC).this
4787 wx.NORMAL_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_NORMAL).this
4788 wx.SMALL_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_SMALL).this
4789 wx.SWISS_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_SWISS).this
4790
4791 wx.BLACK_DASHED_PEN.this = StockGDI.GetPen(StockGDI.PEN_BLACKDASHED).this
4792 wx.BLACK_PEN.this = StockGDI.GetPen(StockGDI.PEN_BLACK).this
4793 wx.CYAN_PEN.this = StockGDI.GetPen(StockGDI.PEN_CYAN).this
4794 wx.GREEN_PEN.this = StockGDI.GetPen(StockGDI.PEN_GREEN).this
4795 wx.GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_GREY).this
4796 wx.LIGHT_GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_LIGHTGREY).this
4797 wx.MEDIUM_GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_MEDIUMGREY).this
4798 wx.RED_PEN.this = StockGDI.GetPen(StockGDI.PEN_RED).this
4799 wx.TRANSPARENT_PEN.this = StockGDI.GetPen(StockGDI.PEN_TRANSPARENT).this
4800 wx.WHITE_PEN.this = StockGDI.GetPen(StockGDI.PEN_WHITE).this
4801
4802 wx.BLACK_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_BLACK).this
4803 wx.BLUE_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_BLUE).this
4804 wx.CYAN_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_CYAN).this
4805 wx.GREEN_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_GREEN).this
4806 wx.GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_GREY).this
4807 wx.LIGHT_GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_LIGHTGREY).this
4808 wx.MEDIUM_GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_MEDIUMGREY).this
4809 wx.RED_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_RED).this
4810 wx.TRANSPARENT_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_TRANSPARENT).this
4811 wx.WHITE_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_WHITE).this
4812
4813 wx.BLACK.this = StockGDI.GetColour(StockGDI.COLOUR_BLACK).this
4814 wx.BLUE.this = StockGDI.GetColour(StockGDI.COLOUR_BLUE).this
4815 wx.CYAN.this = StockGDI.GetColour(StockGDI.COLOUR_CYAN).this
4816 wx.GREEN.this = StockGDI.GetColour(StockGDI.COLOUR_GREEN).this
4817 wx.LIGHT_GREY.this = StockGDI.GetColour(StockGDI.COLOUR_LIGHTGREY).this
4818 wx.RED.this = StockGDI.GetColour(StockGDI.COLOUR_RED).this
4819 wx.WHITE.this = StockGDI.GetColour(StockGDI.COLOUR_WHITE).this
4820
4821 wx.CROSS_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_CROSS).this
4822 wx.HOURGLASS_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_HOURGLASS).this
4823 wx.STANDARD_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_STANDARD).this
4824
4825 wx.TheFontList.this = _wxPyInitTheFontList().this
4826 wx.ThePenList.this = _wxPyInitThePenList().this
4827 wx.TheBrushList.this = _wxPyInitTheBrushList().this
4828 wx.TheColourDatabase.this = _wxPyInitTheColourDatabase().this
4829
4830
4831 _initStockObjects = staticmethod(_initStockObjects)
4832
4833 _gdi_.StockGDI_swigregister(StockGDI)
4834
4835 def StockGDI_DeleteAll(*args):
4836 """StockGDI_DeleteAll()"""
4837 return _gdi_.StockGDI_DeleteAll(*args)
4838
4839 def StockGDI_instance(*args):
4840 """StockGDI_instance() -> StockGDI"""
4841 return _gdi_.StockGDI_instance(*args)
4842
4843 def StockGDI_GetBrush(*args, **kwargs):
4844 """StockGDI_GetBrush(int item) -> Brush"""
4845 return _gdi_.StockGDI_GetBrush(*args, **kwargs)
4846
4847 def StockGDI_GetColour(*args, **kwargs):
4848 """StockGDI_GetColour(int item) -> Colour"""
4849 return _gdi_.StockGDI_GetColour(*args, **kwargs)
4850
4851 def StockGDI_GetCursor(*args, **kwargs):
4852 """StockGDI_GetCursor(int item) -> Cursor"""
4853 return _gdi_.StockGDI_GetCursor(*args, **kwargs)
4854
4855 def StockGDI_GetPen(*args, **kwargs):
4856 """StockGDI_GetPen(int item) -> Pen"""
4857 return _gdi_.StockGDI_GetPen(*args, **kwargs)
4858
4859 # Create an uninitialized instance for the stock objects, they will
4860 # be initialized later when the wx.App object is created.
4861 ITALIC_FONT = Font.__new__(Font)
4862 NORMAL_FONT = Font.__new__(Font)
4863 SMALL_FONT = Font.__new__(Font)
4864 SWISS_FONT = Font.__new__(Font)
4865
4866 BLACK_DASHED_PEN = Pen.__new__(Pen)
4867 BLACK_PEN = Pen.__new__(Pen)
4868 CYAN_PEN = Pen.__new__(Pen)
4869 GREEN_PEN = Pen.__new__(Pen)
4870 GREY_PEN = Pen.__new__(Pen)
4871 LIGHT_GREY_PEN = Pen.__new__(Pen)
4872 MEDIUM_GREY_PEN = Pen.__new__(Pen)
4873 RED_PEN = Pen.__new__(Pen)
4874 TRANSPARENT_PEN = Pen.__new__(Pen)
4875 WHITE_PEN = Pen.__new__(Pen)
4876
4877 BLACK_BRUSH = Brush.__new__(Brush)
4878 BLUE_BRUSH = Brush.__new__(Brush)
4879 CYAN_BRUSH = Brush.__new__(Brush)
4880 GREEN_BRUSH = Brush.__new__(Brush)
4881 GREY_BRUSH = Brush.__new__(Brush)
4882 LIGHT_GREY_BRUSH = Brush.__new__(Brush)
4883 MEDIUM_GREY_BRUSH = Brush.__new__(Brush)
4884 RED_BRUSH = Brush.__new__(Brush)
4885 TRANSPARENT_BRUSH = Brush.__new__(Brush)
4886 WHITE_BRUSH = Brush.__new__(Brush)
4887
4888 BLACK = Colour.__new__(Colour)
4889 BLUE = Colour.__new__(Colour)
4890 CYAN = Colour.__new__(Colour)
4891 GREEN = Colour.__new__(Colour)
4892 LIGHT_GREY = Colour.__new__(Colour)
4893 RED = Colour.__new__(Colour)
4894 WHITE = Colour.__new__(Colour)
4895
4896 CROSS_CURSOR = Cursor.__new__(Cursor)
4897 HOURGLASS_CURSOR = Cursor.__new__(Cursor)
4898 STANDARD_CURSOR = Cursor.__new__(Cursor)
4899
4900 class GDIObjListBase(object):
4901 """Proxy of C++ GDIObjListBase class"""
4902 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4903 __repr__ = _swig_repr
4904 def __init__(self, *args, **kwargs):
4905 """__init__(self) -> GDIObjListBase"""
4906 _gdi_.GDIObjListBase_swiginit(self,_gdi_.new_GDIObjListBase(*args, **kwargs))
4907 __swig_destroy__ = _gdi_.delete_GDIObjListBase
4908 __del__ = lambda self : None;
4909 _gdi_.GDIObjListBase_swigregister(GDIObjListBase)
4910 cvar = _gdi_.cvar
4911 NullBitmap = cvar.NullBitmap
4912 NullIcon = cvar.NullIcon
4913 NullCursor = cvar.NullCursor
4914 NullPen = cvar.NullPen
4915 NullBrush = cvar.NullBrush
4916 NullPalette = cvar.NullPalette
4917 NullFont = cvar.NullFont
4918 NullColour = cvar.NullColour
4919
4920 class PenList(GDIObjListBase):
4921 """Proxy of C++ PenList class"""
4922 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4923 def __init__(self): raise AttributeError, "No constructor defined"
4924 __repr__ = _swig_repr
4925 def FindOrCreatePen(*args, **kwargs):
4926 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
4927 return _gdi_.PenList_FindOrCreatePen(*args, **kwargs)
4928
4929 def AddPen(*args, **kwargs):
4930 """AddPen(self, Pen pen)"""
4931 return _gdi_.PenList_AddPen(*args, **kwargs)
4932
4933 def RemovePen(*args, **kwargs):
4934 """RemovePen(self, Pen pen)"""
4935 return _gdi_.PenList_RemovePen(*args, **kwargs)
4936
4937 AddPen = wx._deprecated(AddPen)
4938 RemovePen = wx._deprecated(RemovePen)
4939
4940 _gdi_.PenList_swigregister(PenList)
4941
4942 class BrushList(GDIObjListBase):
4943 """Proxy of C++ BrushList class"""
4944 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4945 def __init__(self): raise AttributeError, "No constructor defined"
4946 __repr__ = _swig_repr
4947 def FindOrCreateBrush(*args, **kwargs):
4948 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
4949 return _gdi_.BrushList_FindOrCreateBrush(*args, **kwargs)
4950
4951 def AddBrush(*args, **kwargs):
4952 """AddBrush(self, Brush brush)"""
4953 return _gdi_.BrushList_AddBrush(*args, **kwargs)
4954
4955 def RemoveBrush(*args, **kwargs):
4956 """RemoveBrush(self, Brush brush)"""
4957 return _gdi_.BrushList_RemoveBrush(*args, **kwargs)
4958
4959 AddBrush = wx._deprecated(AddBrush)
4960 RemoveBrush = wx._deprecated(RemoveBrush)
4961
4962 _gdi_.BrushList_swigregister(BrushList)
4963
4964 class FontList(GDIObjListBase):
4965 """Proxy of C++ FontList class"""
4966 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4967 def __init__(self): raise AttributeError, "No constructor defined"
4968 __repr__ = _swig_repr
4969 def FindOrCreateFont(*args, **kwargs):
4970 """
4971 FindOrCreateFont(self, int point_size, int family, int style, int weight,
4972 bool underline=False, String facename=EmptyString,
4973 int encoding=FONTENCODING_DEFAULT) -> Font
4974 """
4975 return _gdi_.FontList_FindOrCreateFont(*args, **kwargs)
4976
4977 def AddFont(*args, **kwargs):
4978 """AddFont(self, Font font)"""
4979 return _gdi_.FontList_AddFont(*args, **kwargs)
4980
4981 def RemoveFont(*args, **kwargs):
4982 """RemoveFont(self, Font font)"""
4983 return _gdi_.FontList_RemoveFont(*args, **kwargs)
4984
4985 AddFont = wx._deprecated(AddFont)
4986 RemoveFont = wx._deprecated(RemoveFont)
4987
4988 _gdi_.FontList_swigregister(FontList)
4989
4990 class ColourDatabase(object):
4991 """Proxy of C++ ColourDatabase class"""
4992 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4993 __repr__ = _swig_repr
4994 def __init__(self, *args, **kwargs):
4995 """__init__(self) -> ColourDatabase"""
4996 _gdi_.ColourDatabase_swiginit(self,_gdi_.new_ColourDatabase(*args, **kwargs))
4997 __swig_destroy__ = _gdi_.delete_ColourDatabase
4998 __del__ = lambda self : None;
4999 def Find(*args, **kwargs):
5000 """Find(self, String name) -> Colour"""
5001 return _gdi_.ColourDatabase_Find(*args, **kwargs)
5002
5003 def FindName(*args, **kwargs):
5004 """FindName(self, Colour colour) -> String"""
5005 return _gdi_.ColourDatabase_FindName(*args, **kwargs)
5006
5007 FindColour = Find
5008 def AddColour(*args, **kwargs):
5009 """AddColour(self, String name, Colour colour)"""
5010 return _gdi_.ColourDatabase_AddColour(*args, **kwargs)
5011
5012 def Append(*args, **kwargs):
5013 """Append(self, String name, int red, int green, int blue)"""
5014 return _gdi_.ColourDatabase_Append(*args, **kwargs)
5015
5016 _gdi_.ColourDatabase_swigregister(ColourDatabase)
5017
5018 #---------------------------------------------------------------------------
5019
5020
5021 def _wxPyInitTheFontList(*args):
5022 """_wxPyInitTheFontList() -> FontList"""
5023 return _gdi_._wxPyInitTheFontList(*args)
5024
5025 def _wxPyInitThePenList(*args):
5026 """_wxPyInitThePenList() -> PenList"""
5027 return _gdi_._wxPyInitThePenList(*args)
5028
5029 def _wxPyInitTheBrushList(*args):
5030 """_wxPyInitTheBrushList() -> BrushList"""
5031 return _gdi_._wxPyInitTheBrushList(*args)
5032
5033 def _wxPyInitTheColourDatabase(*args):
5034 """_wxPyInitTheColourDatabase() -> ColourDatabase"""
5035 return _gdi_._wxPyInitTheColourDatabase(*args)
5036 # Create an uninitialized instance for the stock objects, they will
5037 # be initialized later when the wx.App object is created.
5038 TheFontList = FontList.__new__(FontList)
5039 ThePenList = PenList.__new__(PenList)
5040 TheBrushList = BrushList.__new__(BrushList)
5041 TheColourDatabase = ColourDatabase.__new__(ColourDatabase)
5042
5043 NullColor = NullColour
5044 #---------------------------------------------------------------------------
5045
5046 class Effects(_core.Object):
5047 """Proxy of C++ Effects class"""
5048 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5049 __repr__ = _swig_repr
5050 def __init__(self, *args, **kwargs):
5051 """__init__(self) -> Effects"""
5052 _gdi_.Effects_swiginit(self,_gdi_.new_Effects(*args, **kwargs))
5053 def GetHighlightColour(*args, **kwargs):
5054 """GetHighlightColour(self) -> Colour"""
5055 return _gdi_.Effects_GetHighlightColour(*args, **kwargs)
5056
5057 def GetLightShadow(*args, **kwargs):
5058 """GetLightShadow(self) -> Colour"""
5059 return _gdi_.Effects_GetLightShadow(*args, **kwargs)
5060
5061 def GetFaceColour(*args, **kwargs):
5062 """GetFaceColour(self) -> Colour"""
5063 return _gdi_.Effects_GetFaceColour(*args, **kwargs)
5064
5065 def GetMediumShadow(*args, **kwargs):
5066 """GetMediumShadow(self) -> Colour"""
5067 return _gdi_.Effects_GetMediumShadow(*args, **kwargs)
5068
5069 def GetDarkShadow(*args, **kwargs):
5070 """GetDarkShadow(self) -> Colour"""
5071 return _gdi_.Effects_GetDarkShadow(*args, **kwargs)
5072
5073 def SetHighlightColour(*args, **kwargs):
5074 """SetHighlightColour(self, Colour c)"""
5075 return _gdi_.Effects_SetHighlightColour(*args, **kwargs)
5076
5077 def SetLightShadow(*args, **kwargs):
5078 """SetLightShadow(self, Colour c)"""
5079 return _gdi_.Effects_SetLightShadow(*args, **kwargs)
5080
5081 def SetFaceColour(*args, **kwargs):
5082 """SetFaceColour(self, Colour c)"""
5083 return _gdi_.Effects_SetFaceColour(*args, **kwargs)
5084
5085 def SetMediumShadow(*args, **kwargs):
5086 """SetMediumShadow(self, Colour c)"""
5087 return _gdi_.Effects_SetMediumShadow(*args, **kwargs)
5088
5089 def SetDarkShadow(*args, **kwargs):
5090 """SetDarkShadow(self, Colour c)"""
5091 return _gdi_.Effects_SetDarkShadow(*args, **kwargs)
5092
5093 def Set(*args, **kwargs):
5094 """
5095 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
5096 Colour mediumShadow, Colour darkShadow)
5097 """
5098 return _gdi_.Effects_Set(*args, **kwargs)
5099
5100 def DrawSunkenEdge(*args, **kwargs):
5101 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
5102 return _gdi_.Effects_DrawSunkenEdge(*args, **kwargs)
5103
5104 def TileBitmap(*args, **kwargs):
5105 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
5106 return _gdi_.Effects_TileBitmap(*args, **kwargs)
5107
5108 _gdi_.Effects_swigregister(Effects)
5109
5110 #---------------------------------------------------------------------------
5111
5112 CONTROL_DISABLED = _gdi_.CONTROL_DISABLED
5113 CONTROL_FOCUSED = _gdi_.CONTROL_FOCUSED
5114 CONTROL_PRESSED = _gdi_.CONTROL_PRESSED
5115 CONTROL_ISDEFAULT = _gdi_.CONTROL_ISDEFAULT
5116 CONTROL_ISSUBMENU = _gdi_.CONTROL_ISSUBMENU
5117 CONTROL_EXPANDED = _gdi_.CONTROL_EXPANDED
5118 CONTROL_CURRENT = _gdi_.CONTROL_CURRENT
5119 CONTROL_SELECTED = _gdi_.CONTROL_SELECTED
5120 CONTROL_CHECKED = _gdi_.CONTROL_CHECKED
5121 CONTROL_CHECKABLE = _gdi_.CONTROL_CHECKABLE
5122 CONTROL_UNDETERMINED = _gdi_.CONTROL_UNDETERMINED
5123 CONTROL_FLAGS_MASK = _gdi_.CONTROL_FLAGS_MASK
5124 CONTROL_DIRTY = _gdi_.CONTROL_DIRTY
5125 class SplitterRenderParams(object):
5126 """
5127 This is just a simple struct used as a return value of
5128 `wx.RendererNative.GetSplitterParams` and contains some platform
5129 specific metrics about splitters.
5130
5131 * widthSash: the width of the splitter sash.
5132 * border: the width of the border of the splitter window.
5133 * isHotSensitive: ``True`` if the splitter changes its
5134 appearance when the mouse is over it.
5135
5136
5137 """
5138 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5139 __repr__ = _swig_repr
5140 def __init__(self, *args, **kwargs):
5141 """
5142 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5143
5144 This is just a simple struct used as a return value of
5145 `wx.RendererNative.GetSplitterParams` and contains some platform
5146 specific metrics about splitters.
5147
5148 * widthSash: the width of the splitter sash.
5149 * border: the width of the border of the splitter window.
5150 * isHotSensitive: ``True`` if the splitter changes its
5151 appearance when the mouse is over it.
5152
5153
5154 """
5155 _gdi_.SplitterRenderParams_swiginit(self,_gdi_.new_SplitterRenderParams(*args, **kwargs))
5156 __swig_destroy__ = _gdi_.delete_SplitterRenderParams
5157 __del__ = lambda self : None;
5158 widthSash = property(_gdi_.SplitterRenderParams_widthSash_get)
5159 border = property(_gdi_.SplitterRenderParams_border_get)
5160 isHotSensitive = property(_gdi_.SplitterRenderParams_isHotSensitive_get)
5161 _gdi_.SplitterRenderParams_swigregister(SplitterRenderParams)
5162
5163 class RendererVersion(object):
5164 """
5165 This simple struct represents the `wx.RendererNative` interface
5166 version and is only used as the return value of
5167 `wx.RendererNative.GetVersion`.
5168 """
5169 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5170 __repr__ = _swig_repr
5171 def __init__(self, *args, **kwargs):
5172 """
5173 __init__(self, int version_, int age_) -> RendererVersion
5174
5175 This simple struct represents the `wx.RendererNative` interface
5176 version and is only used as the return value of
5177 `wx.RendererNative.GetVersion`.
5178 """
5179 _gdi_.RendererVersion_swiginit(self,_gdi_.new_RendererVersion(*args, **kwargs))
5180 __swig_destroy__ = _gdi_.delete_RendererVersion
5181 __del__ = lambda self : None;
5182 Current_Version = _gdi_.RendererVersion_Current_Version
5183 Current_Age = _gdi_.RendererVersion_Current_Age
5184 def IsCompatible(*args, **kwargs):
5185 """IsCompatible(RendererVersion ver) -> bool"""
5186 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5187
5188 IsCompatible = staticmethod(IsCompatible)
5189 version = property(_gdi_.RendererVersion_version_get)
5190 age = property(_gdi_.RendererVersion_age_get)
5191 _gdi_.RendererVersion_swigregister(RendererVersion)
5192
5193 def RendererVersion_IsCompatible(*args, **kwargs):
5194 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5195 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5196
5197 class RendererNative(object):
5198 """
5199 One of the design principles of wxWidgets is to use the native widgets
5200 on every platform in order to be as close to the native look and feel
5201 on every platform. However there are still cases when some generic
5202 widgets are needed for various reasons, but it can sometimes take a
5203 lot of messy work to make them conform to the native LnF.
5204
5205 The wx.RendererNative class is a collection of functions that have
5206 platform-specific implementations for drawing certain parts of
5207 genereic controls in ways that are as close to the native look as
5208 possible.
5209
5210 Note that each drawing function restores the `wx.DC` attributes if it
5211 changes them, so it is safe to assume that the same pen, brush and
5212 colours that were active before the call to this function are still in
5213 effect after it.
5214
5215 """
5216 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5217 def __init__(self): raise AttributeError, "No constructor defined"
5218 __repr__ = _swig_repr
5219 def DrawHeaderButton(*args, **kwargs):
5220 """
5221 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0)
5222
5223 Draw the header control button (such as what is used by `wx.ListCtrl`
5224 in report mode.)
5225 """
5226 return _gdi_.RendererNative_DrawHeaderButton(*args, **kwargs)
5227
5228 def DrawTreeItemButton(*args, **kwargs):
5229 """
5230 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5231
5232 Draw the expanded/collapsed icon for a tree control item.
5233 """
5234 return _gdi_.RendererNative_DrawTreeItemButton(*args, **kwargs)
5235
5236 def DrawSplitterBorder(*args, **kwargs):
5237 """
5238 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5239
5240 Draw the border for a sash window: this border must be such that the
5241 sash drawn by `DrawSplitterSash` blends into it well.
5242 """
5243 return _gdi_.RendererNative_DrawSplitterBorder(*args, **kwargs)
5244
5245 def DrawSplitterSash(*args, **kwargs):
5246 """
5247 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5248 int flags=0)
5249
5250 Draw a sash. The orient parameter defines whether the sash should be
5251 vertical or horizontal and how the position should be interpreted.
5252 """
5253 return _gdi_.RendererNative_DrawSplitterSash(*args, **kwargs)
5254
5255 def DrawComboBoxDropButton(*args, **kwargs):
5256 """
5257 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5258
5259 Draw a button like the one used by `wx.ComboBox` to show a drop down
5260 window. The usual appearance is a downwards pointing arrow.
5261
5262 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5263 ``wx.CONTROL_CURRENT`` bits set.
5264 """
5265 return _gdi_.RendererNative_DrawComboBoxDropButton(*args, **kwargs)
5266
5267 def DrawDropArrow(*args, **kwargs):
5268 """
5269 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5270
5271 Draw a drop down arrow that is suitable for use outside a combo
5272 box. Arrow will have a transparent background.
5273
5274 ``rect`` is not entirely filled by the arrow. Instead, you should use
5275 bounding rectangle of a drop down button which arrow matches the size
5276 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5277 ``wx.CONTROL_CURRENT`` bit set.
5278 """
5279 return _gdi_.RendererNative_DrawDropArrow(*args, **kwargs)
5280
5281 def DrawCheckBox(*args, **kwargs):
5282 """
5283 DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0)
5284
5285 Draw a check button. Flags may use wx.CONTROL_CHECKED,
5286 wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.
5287 """
5288 return _gdi_.RendererNative_DrawCheckBox(*args, **kwargs)
5289
5290 def DrawPushButton(*args, **kwargs):
5291 """
5292 DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0)
5293
5294 Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
5295 wx.CONTROL_ISDEFAULT
5296 """
5297 return _gdi_.RendererNative_DrawPushButton(*args, **kwargs)
5298
5299 def DrawItemSelectionRect(*args, **kwargs):
5300 """
5301 DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0)
5302
5303 Draw rectangle indicating that an item in e.g. a list control has been
5304 selected or focused
5305
5306 The flags parameter may be:
5307
5308 ==================== ============================================
5309 wx.CONTROL_SELECTED item is selected, e.g. draw background
5310 wx.CONTROL_CURRENT item is the current item, e.g. dotted border
5311 wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
5312 background vs. grey otherwise
5313 ==================== ============================================
5314
5315 """
5316 return _gdi_.RendererNative_DrawItemSelectionRect(*args, **kwargs)
5317
5318 def GetSplitterParams(*args, **kwargs):
5319 """
5320 GetSplitterParams(self, Window win) -> SplitterRenderParams
5321
5322 Get the splitter parameters, see `wx.SplitterRenderParams`.
5323 """
5324 return _gdi_.RendererNative_GetSplitterParams(*args, **kwargs)
5325
5326 def Get(*args, **kwargs):
5327 """
5328 Get() -> RendererNative
5329
5330 Return the currently used renderer
5331 """
5332 return _gdi_.RendererNative_Get(*args, **kwargs)
5333
5334 Get = staticmethod(Get)
5335 def GetGeneric(*args, **kwargs):
5336 """
5337 GetGeneric() -> RendererNative
5338
5339 Return the generic implementation of the renderer. Under some
5340 platforms, this is the default renderer implementation, others have
5341 platform-specific default renderer which can be retrieved by calling
5342 `wx.RendererNative.GetDefault`.
5343 """
5344 return _gdi_.RendererNative_GetGeneric(*args, **kwargs)
5345
5346 GetGeneric = staticmethod(GetGeneric)
5347 def GetDefault(*args, **kwargs):
5348 """
5349 GetDefault() -> RendererNative
5350
5351 Return the default (native) implementation for this platform -- this
5352 is also the one used by default but this may be changed by calling
5353 `wx.RendererNative.Set` in which case the return value of this method
5354 may be different from the return value of `wx.RendererNative.Get`.
5355 """
5356 return _gdi_.RendererNative_GetDefault(*args, **kwargs)
5357
5358 GetDefault = staticmethod(GetDefault)
5359 def Set(*args, **kwargs):
5360 """
5361 Set(RendererNative renderer) -> RendererNative
5362
5363 Set the renderer to use, passing None reverts to using the default
5364 renderer. Returns the previous renderer used with Set or None.
5365 """
5366 return _gdi_.RendererNative_Set(*args, **kwargs)
5367
5368 Set = staticmethod(Set)
5369 def GetVersion(*args, **kwargs):
5370 """
5371 GetVersion(self) -> RendererVersion
5372
5373 Returns the version of the renderer. Will be used for ensuring
5374 compatibility of dynamically loaded renderers.
5375 """
5376 return _gdi_.RendererNative_GetVersion(*args, **kwargs)
5377
5378 _gdi_.RendererNative_swigregister(RendererNative)
5379
5380 def RendererNative_Get(*args):
5381 """
5382 RendererNative_Get() -> RendererNative
5383
5384 Return the currently used renderer
5385 """
5386 return _gdi_.RendererNative_Get(*args)
5387
5388 def RendererNative_GetGeneric(*args):
5389 """
5390 RendererNative_GetGeneric() -> RendererNative
5391
5392 Return the generic implementation of the renderer. Under some
5393 platforms, this is the default renderer implementation, others have
5394 platform-specific default renderer which can be retrieved by calling
5395 `wx.RendererNative.GetDefault`.
5396 """
5397 return _gdi_.RendererNative_GetGeneric(*args)
5398
5399 def RendererNative_GetDefault(*args):
5400 """
5401 RendererNative_GetDefault() -> RendererNative
5402
5403 Return the default (native) implementation for this platform -- this
5404 is also the one used by default but this may be changed by calling
5405 `wx.RendererNative.Set` in which case the return value of this method
5406 may be different from the return value of `wx.RendererNative.Get`.
5407 """
5408 return _gdi_.RendererNative_GetDefault(*args)
5409
5410 def RendererNative_Set(*args, **kwargs):
5411 """
5412 RendererNative_Set(RendererNative renderer) -> RendererNative
5413
5414 Set the renderer to use, passing None reverts to using the default
5415 renderer. Returns the previous renderer used with Set or None.
5416 """
5417 return _gdi_.RendererNative_Set(*args, **kwargs)
5418
5419 #---------------------------------------------------------------------------
5420
5421 class PseudoDC(_core.Object):
5422 """
5423 A PseudoDC is an object that can be used as if it were a `wx.DC`. All
5424 commands issued to the PseudoDC are stored in a list. You can then
5425 play these commands back to a real DC object using the DrawToDC
5426 method. Commands in the command list are indexed by ID. You can use
5427 this to clear the operations associated with a single ID and then
5428 re-draw the object associated with that ID.
5429 """
5430 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5431 __repr__ = _swig_repr
5432 def __init__(self, *args, **kwargs):
5433 """
5434 __init__(self) -> PseudoDC
5435
5436 Constructs a new Pseudo device context for recording dc operations
5437 """
5438 _gdi_.PseudoDC_swiginit(self,_gdi_.new_PseudoDC(*args, **kwargs))
5439 def BeginDrawing(*args, **kwargs):
5440 """
5441 BeginDrawing(self)
5442
5443 Allows for optimization of drawing code on platforms that need it. On
5444 other platforms this is just an empty function and is harmless. To
5445 take advantage of this postential optimization simply enclose each
5446 group of calls to the drawing primitives within calls to
5447 `BeginDrawing` and `EndDrawing`.
5448 """
5449 return _gdi_.PseudoDC_BeginDrawing(*args, **kwargs)
5450
5451 def EndDrawing(*args, **kwargs):
5452 """
5453 EndDrawing(self)
5454
5455 Ends the group of drawing primitives started with `BeginDrawing`, and
5456 invokes whatever optimization is available for this DC type on the
5457 current platform.
5458 """
5459 return _gdi_.PseudoDC_EndDrawing(*args, **kwargs)
5460
5461 __swig_destroy__ = _gdi_.delete_PseudoDC
5462 __del__ = lambda self : None;
5463 def RemoveAll(*args, **kwargs):
5464 """
5465 RemoveAll(self)
5466
5467 Removes all objects and operations from the recorded list.
5468 """
5469 return _gdi_.PseudoDC_RemoveAll(*args, **kwargs)
5470
5471 def GetLen(*args, **kwargs):
5472 """
5473 GetLen(self) -> int
5474
5475 Returns the number of operations in the recorded list.
5476 """
5477 return _gdi_.PseudoDC_GetLen(*args, **kwargs)
5478
5479 def SetId(*args, **kwargs):
5480 """
5481 SetId(self, int id)
5482
5483 Sets the id to be associated with subsequent operations.
5484 """
5485 return _gdi_.PseudoDC_SetId(*args, **kwargs)
5486
5487 def ClearId(*args, **kwargs):
5488 """
5489 ClearId(self, int id)
5490
5491 Removes all operations associated with id so the object can be redrawn.
5492 """
5493 return _gdi_.PseudoDC_ClearId(*args, **kwargs)
5494
5495 def RemoveId(*args, **kwargs):
5496 """
5497 RemoveId(self, int id)
5498
5499 Remove the object node (and all operations) associated with an id.
5500 """
5501 return _gdi_.PseudoDC_RemoveId(*args, **kwargs)
5502
5503 def TranslateId(*args, **kwargs):
5504 """
5505 TranslateId(self, int id, int dx, int dy)
5506
5507 Translate the operations of id by dx,dy.
5508 """
5509 return _gdi_.PseudoDC_TranslateId(*args, **kwargs)
5510
5511 def DrawIdToDC(*args, **kwargs):
5512 """
5513 DrawIdToDC(self, int id, DC dc)
5514
5515 Draw recorded operations of id to dc.
5516 """
5517 return _gdi_.PseudoDC_DrawIdToDC(*args, **kwargs)
5518
5519 def SetIdBounds(*args, **kwargs):
5520 """
5521 SetIdBounds(self, int id, Rect rect)
5522
5523 Set the bounding rect of a given object. This will create
5524 an object node if one doesn't exist.
5525 """
5526 return _gdi_.PseudoDC_SetIdBounds(*args, **kwargs)
5527
5528 def GetIdBounds(*args, **kwargs):
5529 """
5530 GetIdBounds(self, int id) -> Rect
5531
5532 Returns the bounding rectangle previouly set with SetIdBounds. If
5533 no bounds have been set, it returns wx.Rect(0,0,0,0).
5534 """
5535 return _gdi_.PseudoDC_GetIdBounds(*args, **kwargs)
5536
5537 def DrawToDCClipped(*args, **kwargs):
5538 """
5539 DrawToDCClipped(self, DC dc, Rect rect)
5540
5541 Draws the recorded operations to dc unless the operation is known to
5542 be outside rect.
5543 """
5544 return _gdi_.PseudoDC_DrawToDCClipped(*args, **kwargs)
5545
5546 def DrawToDCClippedRgn(*args, **kwargs):
5547 """
5548 DrawToDCClippedRgn(self, DC dc, Region region)
5549
5550 Draws the recorded operations to dc unless the operation is known to
5551 be outside rect.
5552 """
5553 return _gdi_.PseudoDC_DrawToDCClippedRgn(*args, **kwargs)
5554
5555 def DrawToDC(*args, **kwargs):
5556 """
5557 DrawToDC(self, DC dc)
5558
5559 Draws the recorded operations to dc.
5560 """
5561 return _gdi_.PseudoDC_DrawToDC(*args, **kwargs)
5562
5563 def FloodFill(*args, **kwargs):
5564 """
5565 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE)
5566
5567 Flood fills the device context starting from the given point, using
5568 the current brush colour, and using a style:
5569
5570 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5571 the given colour is encountered.
5572
5573 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5574 colour.
5575
5576 Returns False if the operation failed.
5577
5578 Note: The present implementation for non-Windows platforms may fail to
5579 find colour borders if the pixels do not match the colour
5580 exactly. However the function will still return true.
5581 """
5582 return _gdi_.PseudoDC_FloodFill(*args, **kwargs)
5583
5584 def FloodFillPoint(*args, **kwargs):
5585 """
5586 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE)
5587
5588 Flood fills the device context starting from the given point, using
5589 the current brush colour, and using a style:
5590
5591 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5592 the given colour is encountered.
5593
5594 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5595 colour.
5596
5597 Returns False if the operation failed.
5598
5599 Note: The present implementation for non-Windows platforms may fail to
5600 find colour borders if the pixels do not match the colour
5601 exactly. However the function will still return true.
5602 """
5603 return _gdi_.PseudoDC_FloodFillPoint(*args, **kwargs)
5604
5605 def DrawLine(*args, **kwargs):
5606 """
5607 DrawLine(self, int x1, int y1, int x2, int y2)
5608
5609 Draws a line from the first point to the second. The current pen is
5610 used for drawing the line. Note that the second point is *not* part of
5611 the line and is not drawn by this function (this is consistent with
5612 the behaviour of many other toolkits).
5613 """
5614 return _gdi_.PseudoDC_DrawLine(*args, **kwargs)
5615
5616 def DrawLinePoint(*args, **kwargs):
5617 """
5618 DrawLinePoint(self, Point pt1, Point pt2)
5619
5620 Draws a line from the first point to the second. The current pen is
5621 used for drawing the line. Note that the second point is *not* part of
5622 the line and is not drawn by this function (this is consistent with
5623 the behaviour of many other toolkits).
5624 """
5625 return _gdi_.PseudoDC_DrawLinePoint(*args, **kwargs)
5626
5627 def CrossHair(*args, **kwargs):
5628 """
5629 CrossHair(self, int x, int y)
5630
5631 Displays a cross hair using the current pen. This is a vertical and
5632 horizontal line the height and width of the window, centred on the
5633 given point.
5634 """
5635 return _gdi_.PseudoDC_CrossHair(*args, **kwargs)
5636
5637 def CrossHairPoint(*args, **kwargs):
5638 """
5639 CrossHairPoint(self, Point pt)
5640
5641 Displays a cross hair using the current pen. This is a vertical and
5642 horizontal line the height and width of the window, centred on the
5643 given point.
5644 """
5645 return _gdi_.PseudoDC_CrossHairPoint(*args, **kwargs)
5646
5647 def DrawArc(*args, **kwargs):
5648 """
5649 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
5650
5651 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5652 the first point to the second. The current pen is used for the outline
5653 and the current brush for filling the shape.
5654
5655 The arc is drawn in an anticlockwise direction from the start point to
5656 the end point.
5657 """
5658 return _gdi_.PseudoDC_DrawArc(*args, **kwargs)
5659
5660 def DrawArcPoint(*args, **kwargs):
5661 """
5662 DrawArcPoint(self, Point pt1, Point pt2, Point center)
5663
5664 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5665 the first point to the second. The current pen is used for the outline
5666 and the current brush for filling the shape.
5667
5668 The arc is drawn in an anticlockwise direction from the start point to
5669 the end point.
5670 """
5671 return _gdi_.PseudoDC_DrawArcPoint(*args, **kwargs)
5672
5673 def DrawCheckMark(*args, **kwargs):
5674 """
5675 DrawCheckMark(self, int x, int y, int width, int height)
5676
5677 Draws a check mark inside the given rectangle.
5678 """
5679 return _gdi_.PseudoDC_DrawCheckMark(*args, **kwargs)
5680
5681 def DrawCheckMarkRect(*args, **kwargs):
5682 """
5683 DrawCheckMarkRect(self, Rect rect)
5684
5685 Draws a check mark inside the given rectangle.
5686 """
5687 return _gdi_.PseudoDC_DrawCheckMarkRect(*args, **kwargs)
5688
5689 def DrawEllipticArc(*args, **kwargs):
5690 """
5691 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
5692
5693 Draws an arc of an ellipse, with the given rectangle defining the
5694 bounds of the ellipse. The current pen is used for drawing the arc and
5695 the current brush is used for drawing the pie.
5696
5697 The *start* and *end* parameters specify the start and end of the arc
5698 relative to the three-o'clock position from the center of the
5699 rectangle. Angles are specified in degrees (360 is a complete
5700 circle). Positive values mean counter-clockwise motion. If start is
5701 equal to end, a complete ellipse will be drawn.
5702 """
5703 return _gdi_.PseudoDC_DrawEllipticArc(*args, **kwargs)
5704
5705 def DrawEllipticArcPointSize(*args, **kwargs):
5706 """
5707 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
5708
5709 Draws an arc of an ellipse, with the given rectangle defining the
5710 bounds of the ellipse. The current pen is used for drawing the arc and
5711 the current brush is used for drawing the pie.
5712
5713 The *start* and *end* parameters specify the start and end of the arc
5714 relative to the three-o'clock position from the center of the
5715 rectangle. Angles are specified in degrees (360 is a complete
5716 circle). Positive values mean counter-clockwise motion. If start is
5717 equal to end, a complete ellipse will be drawn.
5718 """
5719 return _gdi_.PseudoDC_DrawEllipticArcPointSize(*args, **kwargs)
5720
5721 def DrawPoint(*args, **kwargs):
5722 """
5723 DrawPoint(self, int x, int y)
5724
5725 Draws a point using the current pen.
5726 """
5727 return _gdi_.PseudoDC_DrawPoint(*args, **kwargs)
5728
5729 def DrawPointPoint(*args, **kwargs):
5730 """
5731 DrawPointPoint(self, Point pt)
5732
5733 Draws a point using the current pen.
5734 """
5735 return _gdi_.PseudoDC_DrawPointPoint(*args, **kwargs)
5736
5737 def DrawRectangle(*args, **kwargs):
5738 """
5739 DrawRectangle(self, int x, int y, int width, int height)
5740
5741 Draws a rectangle with the given top left corner, and with the given
5742 size. The current pen is used for the outline and the current brush
5743 for filling the shape.
5744 """
5745 return _gdi_.PseudoDC_DrawRectangle(*args, **kwargs)
5746
5747 def DrawRectangleRect(*args, **kwargs):
5748 """
5749 DrawRectangleRect(self, Rect rect)
5750
5751 Draws a rectangle with the given top left corner, and with the given
5752 size. The current pen is used for the outline and the current brush
5753 for filling the shape.
5754 """
5755 return _gdi_.PseudoDC_DrawRectangleRect(*args, **kwargs)
5756
5757 def DrawRectanglePointSize(*args, **kwargs):
5758 """
5759 DrawRectanglePointSize(self, Point pt, Size sz)
5760
5761 Draws a rectangle with the given top left corner, and with the given
5762 size. The current pen is used for the outline and the current brush
5763 for filling the shape.
5764 """
5765 return _gdi_.PseudoDC_DrawRectanglePointSize(*args, **kwargs)
5766
5767 def DrawRoundedRectangle(*args, **kwargs):
5768 """
5769 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
5770
5771 Draws a rectangle with the given top left corner, and with the given
5772 size. The corners are quarter-circles using the given radius. The
5773 current pen is used for the outline and the current brush for filling
5774 the shape.
5775
5776 If radius is positive, the value is assumed to be the radius of the
5777 rounded corner. If radius is negative, the absolute value is assumed
5778 to be the proportion of the smallest dimension of the rectangle. This
5779 means that the corner can be a sensible size relative to the size of
5780 the rectangle, and also avoids the strange effects X produces when the
5781 corners are too big for the rectangle.
5782 """
5783 return _gdi_.PseudoDC_DrawRoundedRectangle(*args, **kwargs)
5784
5785 def DrawRoundedRectangleRect(*args, **kwargs):
5786 """
5787 DrawRoundedRectangleRect(self, Rect r, double radius)
5788
5789 Draws a rectangle with the given top left corner, and with the given
5790 size. The corners are quarter-circles using the given radius. The
5791 current pen is used for the outline and the current brush for filling
5792 the shape.
5793
5794 If radius is positive, the value is assumed to be the radius of the
5795 rounded corner. If radius is negative, the absolute value is assumed
5796 to be the proportion of the smallest dimension of the rectangle. This
5797 means that the corner can be a sensible size relative to the size of
5798 the rectangle, and also avoids the strange effects X produces when the
5799 corners are too big for the rectangle.
5800 """
5801 return _gdi_.PseudoDC_DrawRoundedRectangleRect(*args, **kwargs)
5802
5803 def DrawRoundedRectanglePointSize(*args, **kwargs):
5804 """
5805 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
5806
5807 Draws a rectangle with the given top left corner, and with the given
5808 size. The corners are quarter-circles using the given radius. The
5809 current pen is used for the outline and the current brush for filling
5810 the shape.
5811
5812 If radius is positive, the value is assumed to be the radius of the
5813 rounded corner. If radius is negative, the absolute value is assumed
5814 to be the proportion of the smallest dimension of the rectangle. This
5815 means that the corner can be a sensible size relative to the size of
5816 the rectangle, and also avoids the strange effects X produces when the
5817 corners are too big for the rectangle.
5818 """
5819 return _gdi_.PseudoDC_DrawRoundedRectanglePointSize(*args, **kwargs)
5820
5821 def DrawCircle(*args, **kwargs):
5822 """
5823 DrawCircle(self, int x, int y, int radius)
5824
5825 Draws a circle with the given center point and radius. The current
5826 pen is used for the outline and the current brush for filling the
5827 shape.
5828 """
5829 return _gdi_.PseudoDC_DrawCircle(*args, **kwargs)
5830
5831 def DrawCirclePoint(*args, **kwargs):
5832 """
5833 DrawCirclePoint(self, Point pt, int radius)
5834
5835 Draws a circle with the given center point and radius. The current
5836 pen is used for the outline and the current brush for filling the
5837 shape.
5838 """
5839 return _gdi_.PseudoDC_DrawCirclePoint(*args, **kwargs)
5840
5841 def DrawEllipse(*args, **kwargs):
5842 """
5843 DrawEllipse(self, int x, int y, int width, int height)
5844
5845 Draws an ellipse contained in the specified rectangle. The current pen
5846 is used for the outline and the current brush for filling the shape.
5847 """
5848 return _gdi_.PseudoDC_DrawEllipse(*args, **kwargs)
5849
5850 def DrawEllipseRect(*args, **kwargs):
5851 """
5852 DrawEllipseRect(self, Rect rect)
5853
5854 Draws an ellipse contained in the specified rectangle. The current pen
5855 is used for the outline and the current brush for filling the shape.
5856 """
5857 return _gdi_.PseudoDC_DrawEllipseRect(*args, **kwargs)
5858
5859 def DrawEllipsePointSize(*args, **kwargs):
5860 """
5861 DrawEllipsePointSize(self, Point pt, Size sz)
5862
5863 Draws an ellipse contained in the specified rectangle. The current pen
5864 is used for the outline and the current brush for filling the shape.
5865 """
5866 return _gdi_.PseudoDC_DrawEllipsePointSize(*args, **kwargs)
5867
5868 def DrawIcon(*args, **kwargs):
5869 """
5870 DrawIcon(self, Icon icon, int x, int y)
5871
5872 Draw an icon on the display (does nothing if the device context is
5873 PostScript). This can be the simplest way of drawing bitmaps on a
5874 window.
5875 """
5876 return _gdi_.PseudoDC_DrawIcon(*args, **kwargs)
5877
5878 def DrawIconPoint(*args, **kwargs):
5879 """
5880 DrawIconPoint(self, Icon icon, Point pt)
5881
5882 Draw an icon on the display (does nothing if the device context is
5883 PostScript). This can be the simplest way of drawing bitmaps on a
5884 window.
5885 """
5886 return _gdi_.PseudoDC_DrawIconPoint(*args, **kwargs)
5887
5888 def DrawBitmap(*args, **kwargs):
5889 """
5890 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
5891
5892 Draw a bitmap on the device context at the specified point. If
5893 *transparent* is true and the bitmap has a transparency mask, (or
5894 alpha channel on the platforms that support it) then the bitmap will
5895 be drawn transparently.
5896 """
5897 return _gdi_.PseudoDC_DrawBitmap(*args, **kwargs)
5898
5899 def DrawBitmapPoint(*args, **kwargs):
5900 """
5901 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
5902
5903 Draw a bitmap on the device context at the specified point. If
5904 *transparent* is true and the bitmap has a transparency mask, (or
5905 alpha channel on the platforms that support it) then the bitmap will
5906 be drawn transparently.
5907 """
5908 return _gdi_.PseudoDC_DrawBitmapPoint(*args, **kwargs)
5909
5910 def DrawText(*args, **kwargs):
5911 """
5912 DrawText(self, String text, int x, int y)
5913
5914 Draws a text string at the specified point, using the current text
5915 font, and the current text foreground and background colours.
5916
5917 The coordinates refer to the top-left corner of the rectangle bounding
5918 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
5919 a text string, which can be used to position the text more precisely,
5920 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
5921 not implement it.)
5922
5923 **NOTE**: under wxGTK the current logical function is used by this
5924 function but it is ignored by wxMSW. Thus, you should avoid using
5925 logical functions with this function in portable programs.
5926 """
5927 return _gdi_.PseudoDC_DrawText(*args, **kwargs)
5928
5929 def DrawTextPoint(*args, **kwargs):
5930 """
5931 DrawTextPoint(self, String text, Point pt)
5932
5933 Draws a text string at the specified point, using the current text
5934 font, and the current text foreground and background colours.
5935
5936 The coordinates refer to the top-left corner of the rectangle bounding
5937 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
5938 a text string, which can be used to position the text more precisely,
5939 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
5940 not implement it.)
5941
5942 **NOTE**: under wxGTK the current logical function is used by this
5943 function but it is ignored by wxMSW. Thus, you should avoid using
5944 logical functions with this function in portable programs.
5945 """
5946 return _gdi_.PseudoDC_DrawTextPoint(*args, **kwargs)
5947
5948 def DrawRotatedText(*args, **kwargs):
5949 """
5950 DrawRotatedText(self, String text, int x, int y, double angle)
5951
5952 Draws the text rotated by *angle* degrees, if supported by the platform.
5953
5954 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
5955 function. In particular, a font different from ``wx.NORMAL_FONT``
5956 should be used as the it is not normally a TrueType
5957 font. ``wx.SWISS_FONT`` is an example of a font which is.
5958 """
5959 return _gdi_.PseudoDC_DrawRotatedText(*args, **kwargs)
5960
5961 def DrawRotatedTextPoint(*args, **kwargs):
5962 """
5963 DrawRotatedTextPoint(self, String text, Point pt, double angle)
5964
5965 Draws the text rotated by *angle* degrees, if supported by the platform.
5966
5967 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
5968 function. In particular, a font different from ``wx.NORMAL_FONT``
5969 should be used as the it is not normally a TrueType
5970 font. ``wx.SWISS_FONT`` is an example of a font which is.
5971 """
5972 return _gdi_.PseudoDC_DrawRotatedTextPoint(*args, **kwargs)
5973
5974 def DrawLines(*args, **kwargs):
5975 """
5976 DrawLines(self, List points, int xoffset=0, int yoffset=0)
5977
5978 Draws lines using a sequence of `wx.Point` objects, adding the
5979 optional offset coordinate. The current pen is used for drawing the
5980 lines.
5981 """
5982 return _gdi_.PseudoDC_DrawLines(*args, **kwargs)
5983
5984 def DrawPolygon(*args, **kwargs):
5985 """
5986 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
5987 int fillStyle=ODDEVEN_RULE)
5988
5989 Draws a filled polygon using a sequence of `wx.Point` objects, adding
5990 the optional offset coordinate. The last argument specifies the fill
5991 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
5992
5993 The current pen is used for drawing the outline, and the current brush
5994 for filling the shape. Using a transparent brush suppresses
5995 filling. Note that wxWidgets automatically closes the first and last
5996 points.
5997 """
5998 return _gdi_.PseudoDC_DrawPolygon(*args, **kwargs)
5999
6000 def DrawLabel(*args, **kwargs):
6001 """
6002 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6003 int indexAccel=-1)
6004
6005 Draw *text* within the specified rectangle, abiding by the alignment
6006 flags. Will additionally emphasize the character at *indexAccel* if
6007 it is not -1.
6008 """
6009 return _gdi_.PseudoDC_DrawLabel(*args, **kwargs)
6010
6011 def DrawImageLabel(*args, **kwargs):
6012 """
6013 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6014 int indexAccel=-1)
6015
6016 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
6017 drawing it) within the specified rectangle, abiding by the alignment
6018 flags. Will additionally emphasize the character at *indexAccel* if
6019 it is not -1.
6020 """
6021 return _gdi_.PseudoDC_DrawImageLabel(*args, **kwargs)
6022
6023 def DrawSpline(*args, **kwargs):
6024 """
6025 DrawSpline(self, List points)
6026
6027 Draws a spline between all given control points, (a list of `wx.Point`
6028 objects) using the current pen. The spline is drawn using a series of
6029 lines, using an algorithm taken from the X drawing program 'XFIG'.
6030 """
6031 return _gdi_.PseudoDC_DrawSpline(*args, **kwargs)
6032
6033 def Clear(*args, **kwargs):
6034 """
6035 Clear(self)
6036
6037 Clears the device context using the current background brush.
6038 """
6039 return _gdi_.PseudoDC_Clear(*args, **kwargs)
6040
6041 def SetFont(*args, **kwargs):
6042 """
6043 SetFont(self, Font font)
6044
6045 Sets the current font for the DC. It must be a valid font, in
6046 particular you should not pass ``wx.NullFont`` to this method.
6047 """
6048 return _gdi_.PseudoDC_SetFont(*args, **kwargs)
6049
6050 def SetPen(*args, **kwargs):
6051 """
6052 SetPen(self, Pen pen)
6053
6054 Sets the current pen for the DC.
6055
6056 If the argument is ``wx.NullPen``, the current pen is selected out of the
6057 device context, and the original pen restored.
6058 """
6059 return _gdi_.PseudoDC_SetPen(*args, **kwargs)
6060
6061 def SetBrush(*args, **kwargs):
6062 """
6063 SetBrush(self, Brush brush)
6064
6065 Sets the current brush for the DC.
6066
6067 If the argument is ``wx.NullBrush``, the current brush is selected out
6068 of the device context, and the original brush restored, allowing the
6069 current brush to be destroyed safely.
6070 """
6071 return _gdi_.PseudoDC_SetBrush(*args, **kwargs)
6072
6073 def SetBackground(*args, **kwargs):
6074 """
6075 SetBackground(self, Brush brush)
6076
6077 Sets the current background brush for the DC.
6078 """
6079 return _gdi_.PseudoDC_SetBackground(*args, **kwargs)
6080
6081 def SetBackgroundMode(*args, **kwargs):
6082 """
6083 SetBackgroundMode(self, int mode)
6084
6085 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
6086 determines whether text will be drawn with a background colour or
6087 not.
6088 """
6089 return _gdi_.PseudoDC_SetBackgroundMode(*args, **kwargs)
6090
6091 def SetPalette(*args, **kwargs):
6092 """
6093 SetPalette(self, Palette palette)
6094
6095 If this is a window DC or memory DC, assigns the given palette to the
6096 window or bitmap associated with the DC. If the argument is
6097 ``wx.NullPalette``, the current palette is selected out of the device
6098 context, and the original palette restored.
6099 """
6100 return _gdi_.PseudoDC_SetPalette(*args, **kwargs)
6101
6102 def SetTextForeground(*args, **kwargs):
6103 """
6104 SetTextForeground(self, Colour colour)
6105
6106 Sets the current text foreground colour for the DC.
6107 """
6108 return _gdi_.PseudoDC_SetTextForeground(*args, **kwargs)
6109
6110 def SetTextBackground(*args, **kwargs):
6111 """
6112 SetTextBackground(self, Colour colour)
6113
6114 Sets the current text background colour for the DC.
6115 """
6116 return _gdi_.PseudoDC_SetTextBackground(*args, **kwargs)
6117
6118 def SetLogicalFunction(*args, **kwargs):
6119 """
6120 SetLogicalFunction(self, int function)
6121
6122 Sets the current logical function for the device context. This
6123 determines how a source pixel (from a pen or brush colour, combines
6124 with a destination pixel in the current device context.
6125
6126 The possible values and their meaning in terms of source and
6127 destination pixel values are as follows:
6128
6129 ================ ==========================
6130 wx.AND src AND dst
6131 wx.AND_INVERT (NOT src) AND dst
6132 wx.AND_REVERSE src AND (NOT dst)
6133 wx.CLEAR 0
6134 wx.COPY src
6135 wx.EQUIV (NOT src) XOR dst
6136 wx.INVERT NOT dst
6137 wx.NAND (NOT src) OR (NOT dst)
6138 wx.NOR (NOT src) AND (NOT dst)
6139 wx.NO_OP dst
6140 wx.OR src OR dst
6141 wx.OR_INVERT (NOT src) OR dst
6142 wx.OR_REVERSE src OR (NOT dst)
6143 wx.SET 1
6144 wx.SRC_INVERT NOT src
6145 wx.XOR src XOR dst
6146 ================ ==========================
6147
6148 The default is wx.COPY, which simply draws with the current
6149 colour. The others combine the current colour and the background using
6150 a logical operation. wx.INVERT is commonly used for drawing rubber
6151 bands or moving outlines, since drawing twice reverts to the original
6152 colour.
6153
6154 """
6155 return _gdi_.PseudoDC_SetLogicalFunction(*args, **kwargs)
6156
6157 _gdi_.PseudoDC_swigregister(PseudoDC)
6158
6159
6160