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