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