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