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