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