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