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