]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/msw/_gdi.py
944c292c95fbdca0fe51c9f9b2a1d746dfb1acfb
[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 LANGUAGE_DEFAULT = _gdi_.LANGUAGE_DEFAULT
2435 LANGUAGE_UNKNOWN = _gdi_.LANGUAGE_UNKNOWN
2436 LANGUAGE_ABKHAZIAN = _gdi_.LANGUAGE_ABKHAZIAN
2437 LANGUAGE_AFAR = _gdi_.LANGUAGE_AFAR
2438 LANGUAGE_AFRIKAANS = _gdi_.LANGUAGE_AFRIKAANS
2439 LANGUAGE_ALBANIAN = _gdi_.LANGUAGE_ALBANIAN
2440 LANGUAGE_AMHARIC = _gdi_.LANGUAGE_AMHARIC
2441 LANGUAGE_ARABIC = _gdi_.LANGUAGE_ARABIC
2442 LANGUAGE_ARABIC_ALGERIA = _gdi_.LANGUAGE_ARABIC_ALGERIA
2443 LANGUAGE_ARABIC_BAHRAIN = _gdi_.LANGUAGE_ARABIC_BAHRAIN
2444 LANGUAGE_ARABIC_EGYPT = _gdi_.LANGUAGE_ARABIC_EGYPT
2445 LANGUAGE_ARABIC_IRAQ = _gdi_.LANGUAGE_ARABIC_IRAQ
2446 LANGUAGE_ARABIC_JORDAN = _gdi_.LANGUAGE_ARABIC_JORDAN
2447 LANGUAGE_ARABIC_KUWAIT = _gdi_.LANGUAGE_ARABIC_KUWAIT
2448 LANGUAGE_ARABIC_LEBANON = _gdi_.LANGUAGE_ARABIC_LEBANON
2449 LANGUAGE_ARABIC_LIBYA = _gdi_.LANGUAGE_ARABIC_LIBYA
2450 LANGUAGE_ARABIC_MOROCCO = _gdi_.LANGUAGE_ARABIC_MOROCCO
2451 LANGUAGE_ARABIC_OMAN = _gdi_.LANGUAGE_ARABIC_OMAN
2452 LANGUAGE_ARABIC_QATAR = _gdi_.LANGUAGE_ARABIC_QATAR
2453 LANGUAGE_ARABIC_SAUDI_ARABIA = _gdi_.LANGUAGE_ARABIC_SAUDI_ARABIA
2454 LANGUAGE_ARABIC_SUDAN = _gdi_.LANGUAGE_ARABIC_SUDAN
2455 LANGUAGE_ARABIC_SYRIA = _gdi_.LANGUAGE_ARABIC_SYRIA
2456 LANGUAGE_ARABIC_TUNISIA = _gdi_.LANGUAGE_ARABIC_TUNISIA
2457 LANGUAGE_ARABIC_UAE = _gdi_.LANGUAGE_ARABIC_UAE
2458 LANGUAGE_ARABIC_YEMEN = _gdi_.LANGUAGE_ARABIC_YEMEN
2459 LANGUAGE_ARMENIAN = _gdi_.LANGUAGE_ARMENIAN
2460 LANGUAGE_ASSAMESE = _gdi_.LANGUAGE_ASSAMESE
2461 LANGUAGE_AYMARA = _gdi_.LANGUAGE_AYMARA
2462 LANGUAGE_AZERI = _gdi_.LANGUAGE_AZERI
2463 LANGUAGE_AZERI_CYRILLIC = _gdi_.LANGUAGE_AZERI_CYRILLIC
2464 LANGUAGE_AZERI_LATIN = _gdi_.LANGUAGE_AZERI_LATIN
2465 LANGUAGE_BASHKIR = _gdi_.LANGUAGE_BASHKIR
2466 LANGUAGE_BASQUE = _gdi_.LANGUAGE_BASQUE
2467 LANGUAGE_BELARUSIAN = _gdi_.LANGUAGE_BELARUSIAN
2468 LANGUAGE_BENGALI = _gdi_.LANGUAGE_BENGALI
2469 LANGUAGE_BHUTANI = _gdi_.LANGUAGE_BHUTANI
2470 LANGUAGE_BIHARI = _gdi_.LANGUAGE_BIHARI
2471 LANGUAGE_BISLAMA = _gdi_.LANGUAGE_BISLAMA
2472 LANGUAGE_BRETON = _gdi_.LANGUAGE_BRETON
2473 LANGUAGE_BULGARIAN = _gdi_.LANGUAGE_BULGARIAN
2474 LANGUAGE_BURMESE = _gdi_.LANGUAGE_BURMESE
2475 LANGUAGE_CAMBODIAN = _gdi_.LANGUAGE_CAMBODIAN
2476 LANGUAGE_CATALAN = _gdi_.LANGUAGE_CATALAN
2477 LANGUAGE_CHINESE = _gdi_.LANGUAGE_CHINESE
2478 LANGUAGE_CHINESE_SIMPLIFIED = _gdi_.LANGUAGE_CHINESE_SIMPLIFIED
2479 LANGUAGE_CHINESE_TRADITIONAL = _gdi_.LANGUAGE_CHINESE_TRADITIONAL
2480 LANGUAGE_CHINESE_HONGKONG = _gdi_.LANGUAGE_CHINESE_HONGKONG
2481 LANGUAGE_CHINESE_MACAU = _gdi_.LANGUAGE_CHINESE_MACAU
2482 LANGUAGE_CHINESE_SINGAPORE = _gdi_.LANGUAGE_CHINESE_SINGAPORE
2483 LANGUAGE_CHINESE_TAIWAN = _gdi_.LANGUAGE_CHINESE_TAIWAN
2484 LANGUAGE_CORSICAN = _gdi_.LANGUAGE_CORSICAN
2485 LANGUAGE_CROATIAN = _gdi_.LANGUAGE_CROATIAN
2486 LANGUAGE_CZECH = _gdi_.LANGUAGE_CZECH
2487 LANGUAGE_DANISH = _gdi_.LANGUAGE_DANISH
2488 LANGUAGE_DUTCH = _gdi_.LANGUAGE_DUTCH
2489 LANGUAGE_DUTCH_BELGIAN = _gdi_.LANGUAGE_DUTCH_BELGIAN
2490 LANGUAGE_ENGLISH = _gdi_.LANGUAGE_ENGLISH
2491 LANGUAGE_ENGLISH_UK = _gdi_.LANGUAGE_ENGLISH_UK
2492 LANGUAGE_ENGLISH_US = _gdi_.LANGUAGE_ENGLISH_US
2493 LANGUAGE_ENGLISH_AUSTRALIA = _gdi_.LANGUAGE_ENGLISH_AUSTRALIA
2494 LANGUAGE_ENGLISH_BELIZE = _gdi_.LANGUAGE_ENGLISH_BELIZE
2495 LANGUAGE_ENGLISH_BOTSWANA = _gdi_.LANGUAGE_ENGLISH_BOTSWANA
2496 LANGUAGE_ENGLISH_CANADA = _gdi_.LANGUAGE_ENGLISH_CANADA
2497 LANGUAGE_ENGLISH_CARIBBEAN = _gdi_.LANGUAGE_ENGLISH_CARIBBEAN
2498 LANGUAGE_ENGLISH_DENMARK = _gdi_.LANGUAGE_ENGLISH_DENMARK
2499 LANGUAGE_ENGLISH_EIRE = _gdi_.LANGUAGE_ENGLISH_EIRE
2500 LANGUAGE_ENGLISH_JAMAICA = _gdi_.LANGUAGE_ENGLISH_JAMAICA
2501 LANGUAGE_ENGLISH_NEW_ZEALAND = _gdi_.LANGUAGE_ENGLISH_NEW_ZEALAND
2502 LANGUAGE_ENGLISH_PHILIPPINES = _gdi_.LANGUAGE_ENGLISH_PHILIPPINES
2503 LANGUAGE_ENGLISH_SOUTH_AFRICA = _gdi_.LANGUAGE_ENGLISH_SOUTH_AFRICA
2504 LANGUAGE_ENGLISH_TRINIDAD = _gdi_.LANGUAGE_ENGLISH_TRINIDAD
2505 LANGUAGE_ENGLISH_ZIMBABWE = _gdi_.LANGUAGE_ENGLISH_ZIMBABWE
2506 LANGUAGE_ESPERANTO = _gdi_.LANGUAGE_ESPERANTO
2507 LANGUAGE_ESTONIAN = _gdi_.LANGUAGE_ESTONIAN
2508 LANGUAGE_FAEROESE = _gdi_.LANGUAGE_FAEROESE
2509 LANGUAGE_FARSI = _gdi_.LANGUAGE_FARSI
2510 LANGUAGE_FIJI = _gdi_.LANGUAGE_FIJI
2511 LANGUAGE_FINNISH = _gdi_.LANGUAGE_FINNISH
2512 LANGUAGE_FRENCH = _gdi_.LANGUAGE_FRENCH
2513 LANGUAGE_FRENCH_BELGIAN = _gdi_.LANGUAGE_FRENCH_BELGIAN
2514 LANGUAGE_FRENCH_CANADIAN = _gdi_.LANGUAGE_FRENCH_CANADIAN
2515 LANGUAGE_FRENCH_LUXEMBOURG = _gdi_.LANGUAGE_FRENCH_LUXEMBOURG
2516 LANGUAGE_FRENCH_MONACO = _gdi_.LANGUAGE_FRENCH_MONACO
2517 LANGUAGE_FRENCH_SWISS = _gdi_.LANGUAGE_FRENCH_SWISS
2518 LANGUAGE_FRISIAN = _gdi_.LANGUAGE_FRISIAN
2519 LANGUAGE_GALICIAN = _gdi_.LANGUAGE_GALICIAN
2520 LANGUAGE_GEORGIAN = _gdi_.LANGUAGE_GEORGIAN
2521 LANGUAGE_GERMAN = _gdi_.LANGUAGE_GERMAN
2522 LANGUAGE_GERMAN_AUSTRIAN = _gdi_.LANGUAGE_GERMAN_AUSTRIAN
2523 LANGUAGE_GERMAN_BELGIUM = _gdi_.LANGUAGE_GERMAN_BELGIUM
2524 LANGUAGE_GERMAN_LIECHTENSTEIN = _gdi_.LANGUAGE_GERMAN_LIECHTENSTEIN
2525 LANGUAGE_GERMAN_LUXEMBOURG = _gdi_.LANGUAGE_GERMAN_LUXEMBOURG
2526 LANGUAGE_GERMAN_SWISS = _gdi_.LANGUAGE_GERMAN_SWISS
2527 LANGUAGE_GREEK = _gdi_.LANGUAGE_GREEK
2528 LANGUAGE_GREENLANDIC = _gdi_.LANGUAGE_GREENLANDIC
2529 LANGUAGE_GUARANI = _gdi_.LANGUAGE_GUARANI
2530 LANGUAGE_GUJARATI = _gdi_.LANGUAGE_GUJARATI
2531 LANGUAGE_HAUSA = _gdi_.LANGUAGE_HAUSA
2532 LANGUAGE_HEBREW = _gdi_.LANGUAGE_HEBREW
2533 LANGUAGE_HINDI = _gdi_.LANGUAGE_HINDI
2534 LANGUAGE_HUNGARIAN = _gdi_.LANGUAGE_HUNGARIAN
2535 LANGUAGE_ICELANDIC = _gdi_.LANGUAGE_ICELANDIC
2536 LANGUAGE_INDONESIAN = _gdi_.LANGUAGE_INDONESIAN
2537 LANGUAGE_INTERLINGUA = _gdi_.LANGUAGE_INTERLINGUA
2538 LANGUAGE_INTERLINGUE = _gdi_.LANGUAGE_INTERLINGUE
2539 LANGUAGE_INUKTITUT = _gdi_.LANGUAGE_INUKTITUT
2540 LANGUAGE_INUPIAK = _gdi_.LANGUAGE_INUPIAK
2541 LANGUAGE_IRISH = _gdi_.LANGUAGE_IRISH
2542 LANGUAGE_ITALIAN = _gdi_.LANGUAGE_ITALIAN
2543 LANGUAGE_ITALIAN_SWISS = _gdi_.LANGUAGE_ITALIAN_SWISS
2544 LANGUAGE_JAPANESE = _gdi_.LANGUAGE_JAPANESE
2545 LANGUAGE_JAVANESE = _gdi_.LANGUAGE_JAVANESE
2546 LANGUAGE_KANNADA = _gdi_.LANGUAGE_KANNADA
2547 LANGUAGE_KASHMIRI = _gdi_.LANGUAGE_KASHMIRI
2548 LANGUAGE_KASHMIRI_INDIA = _gdi_.LANGUAGE_KASHMIRI_INDIA
2549 LANGUAGE_KAZAKH = _gdi_.LANGUAGE_KAZAKH
2550 LANGUAGE_KERNEWEK = _gdi_.LANGUAGE_KERNEWEK
2551 LANGUAGE_KINYARWANDA = _gdi_.LANGUAGE_KINYARWANDA
2552 LANGUAGE_KIRGHIZ = _gdi_.LANGUAGE_KIRGHIZ
2553 LANGUAGE_KIRUNDI = _gdi_.LANGUAGE_KIRUNDI
2554 LANGUAGE_KONKANI = _gdi_.LANGUAGE_KONKANI
2555 LANGUAGE_KOREAN = _gdi_.LANGUAGE_KOREAN
2556 LANGUAGE_KURDISH = _gdi_.LANGUAGE_KURDISH
2557 LANGUAGE_LAOTHIAN = _gdi_.LANGUAGE_LAOTHIAN
2558 LANGUAGE_LATIN = _gdi_.LANGUAGE_LATIN
2559 LANGUAGE_LATVIAN = _gdi_.LANGUAGE_LATVIAN
2560 LANGUAGE_LINGALA = _gdi_.LANGUAGE_LINGALA
2561 LANGUAGE_LITHUANIAN = _gdi_.LANGUAGE_LITHUANIAN
2562 LANGUAGE_MACEDONIAN = _gdi_.LANGUAGE_MACEDONIAN
2563 LANGUAGE_MALAGASY = _gdi_.LANGUAGE_MALAGASY
2564 LANGUAGE_MALAY = _gdi_.LANGUAGE_MALAY
2565 LANGUAGE_MALAYALAM = _gdi_.LANGUAGE_MALAYALAM
2566 LANGUAGE_MALAY_BRUNEI_DARUSSALAM = _gdi_.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2567 LANGUAGE_MALAY_MALAYSIA = _gdi_.LANGUAGE_MALAY_MALAYSIA
2568 LANGUAGE_MALTESE = _gdi_.LANGUAGE_MALTESE
2569 LANGUAGE_MANIPURI = _gdi_.LANGUAGE_MANIPURI
2570 LANGUAGE_MAORI = _gdi_.LANGUAGE_MAORI
2571 LANGUAGE_MARATHI = _gdi_.LANGUAGE_MARATHI
2572 LANGUAGE_MOLDAVIAN = _gdi_.LANGUAGE_MOLDAVIAN
2573 LANGUAGE_MONGOLIAN = _gdi_.LANGUAGE_MONGOLIAN
2574 LANGUAGE_NAURU = _gdi_.LANGUAGE_NAURU
2575 LANGUAGE_NEPALI = _gdi_.LANGUAGE_NEPALI
2576 LANGUAGE_NEPALI_INDIA = _gdi_.LANGUAGE_NEPALI_INDIA
2577 LANGUAGE_NORWEGIAN_BOKMAL = _gdi_.LANGUAGE_NORWEGIAN_BOKMAL
2578 LANGUAGE_NORWEGIAN_NYNORSK = _gdi_.LANGUAGE_NORWEGIAN_NYNORSK
2579 LANGUAGE_OCCITAN = _gdi_.LANGUAGE_OCCITAN
2580 LANGUAGE_ORIYA = _gdi_.LANGUAGE_ORIYA
2581 LANGUAGE_OROMO = _gdi_.LANGUAGE_OROMO
2582 LANGUAGE_PASHTO = _gdi_.LANGUAGE_PASHTO
2583 LANGUAGE_POLISH = _gdi_.LANGUAGE_POLISH
2584 LANGUAGE_PORTUGUESE = _gdi_.LANGUAGE_PORTUGUESE
2585 LANGUAGE_PORTUGUESE_BRAZILIAN = _gdi_.LANGUAGE_PORTUGUESE_BRAZILIAN
2586 LANGUAGE_PUNJABI = _gdi_.LANGUAGE_PUNJABI
2587 LANGUAGE_QUECHUA = _gdi_.LANGUAGE_QUECHUA
2588 LANGUAGE_RHAETO_ROMANCE = _gdi_.LANGUAGE_RHAETO_ROMANCE
2589 LANGUAGE_ROMANIAN = _gdi_.LANGUAGE_ROMANIAN
2590 LANGUAGE_RUSSIAN = _gdi_.LANGUAGE_RUSSIAN
2591 LANGUAGE_RUSSIAN_UKRAINE = _gdi_.LANGUAGE_RUSSIAN_UKRAINE
2592 LANGUAGE_SAMOAN = _gdi_.LANGUAGE_SAMOAN
2593 LANGUAGE_SANGHO = _gdi_.LANGUAGE_SANGHO
2594 LANGUAGE_SANSKRIT = _gdi_.LANGUAGE_SANSKRIT
2595 LANGUAGE_SCOTS_GAELIC = _gdi_.LANGUAGE_SCOTS_GAELIC
2596 LANGUAGE_SERBIAN = _gdi_.LANGUAGE_SERBIAN
2597 LANGUAGE_SERBIAN_CYRILLIC = _gdi_.LANGUAGE_SERBIAN_CYRILLIC
2598 LANGUAGE_SERBIAN_LATIN = _gdi_.LANGUAGE_SERBIAN_LATIN
2599 LANGUAGE_SERBO_CROATIAN = _gdi_.LANGUAGE_SERBO_CROATIAN
2600 LANGUAGE_SESOTHO = _gdi_.LANGUAGE_SESOTHO
2601 LANGUAGE_SETSWANA = _gdi_.LANGUAGE_SETSWANA
2602 LANGUAGE_SHONA = _gdi_.LANGUAGE_SHONA
2603 LANGUAGE_SINDHI = _gdi_.LANGUAGE_SINDHI
2604 LANGUAGE_SINHALESE = _gdi_.LANGUAGE_SINHALESE
2605 LANGUAGE_SISWATI = _gdi_.LANGUAGE_SISWATI
2606 LANGUAGE_SLOVAK = _gdi_.LANGUAGE_SLOVAK
2607 LANGUAGE_SLOVENIAN = _gdi_.LANGUAGE_SLOVENIAN
2608 LANGUAGE_SOMALI = _gdi_.LANGUAGE_SOMALI
2609 LANGUAGE_SPANISH = _gdi_.LANGUAGE_SPANISH
2610 LANGUAGE_SPANISH_ARGENTINA = _gdi_.LANGUAGE_SPANISH_ARGENTINA
2611 LANGUAGE_SPANISH_BOLIVIA = _gdi_.LANGUAGE_SPANISH_BOLIVIA
2612 LANGUAGE_SPANISH_CHILE = _gdi_.LANGUAGE_SPANISH_CHILE
2613 LANGUAGE_SPANISH_COLOMBIA = _gdi_.LANGUAGE_SPANISH_COLOMBIA
2614 LANGUAGE_SPANISH_COSTA_RICA = _gdi_.LANGUAGE_SPANISH_COSTA_RICA
2615 LANGUAGE_SPANISH_DOMINICAN_REPUBLIC = _gdi_.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2616 LANGUAGE_SPANISH_ECUADOR = _gdi_.LANGUAGE_SPANISH_ECUADOR
2617 LANGUAGE_SPANISH_EL_SALVADOR = _gdi_.LANGUAGE_SPANISH_EL_SALVADOR
2618 LANGUAGE_SPANISH_GUATEMALA = _gdi_.LANGUAGE_SPANISH_GUATEMALA
2619 LANGUAGE_SPANISH_HONDURAS = _gdi_.LANGUAGE_SPANISH_HONDURAS
2620 LANGUAGE_SPANISH_MEXICAN = _gdi_.LANGUAGE_SPANISH_MEXICAN
2621 LANGUAGE_SPANISH_MODERN = _gdi_.LANGUAGE_SPANISH_MODERN
2622 LANGUAGE_SPANISH_NICARAGUA = _gdi_.LANGUAGE_SPANISH_NICARAGUA
2623 LANGUAGE_SPANISH_PANAMA = _gdi_.LANGUAGE_SPANISH_PANAMA
2624 LANGUAGE_SPANISH_PARAGUAY = _gdi_.LANGUAGE_SPANISH_PARAGUAY
2625 LANGUAGE_SPANISH_PERU = _gdi_.LANGUAGE_SPANISH_PERU
2626 LANGUAGE_SPANISH_PUERTO_RICO = _gdi_.LANGUAGE_SPANISH_PUERTO_RICO
2627 LANGUAGE_SPANISH_URUGUAY = _gdi_.LANGUAGE_SPANISH_URUGUAY
2628 LANGUAGE_SPANISH_US = _gdi_.LANGUAGE_SPANISH_US
2629 LANGUAGE_SPANISH_VENEZUELA = _gdi_.LANGUAGE_SPANISH_VENEZUELA
2630 LANGUAGE_SUNDANESE = _gdi_.LANGUAGE_SUNDANESE
2631 LANGUAGE_SWAHILI = _gdi_.LANGUAGE_SWAHILI
2632 LANGUAGE_SWEDISH = _gdi_.LANGUAGE_SWEDISH
2633 LANGUAGE_SWEDISH_FINLAND = _gdi_.LANGUAGE_SWEDISH_FINLAND
2634 LANGUAGE_TAGALOG = _gdi_.LANGUAGE_TAGALOG
2635 LANGUAGE_TAJIK = _gdi_.LANGUAGE_TAJIK
2636 LANGUAGE_TAMIL = _gdi_.LANGUAGE_TAMIL
2637 LANGUAGE_TATAR = _gdi_.LANGUAGE_TATAR
2638 LANGUAGE_TELUGU = _gdi_.LANGUAGE_TELUGU
2639 LANGUAGE_THAI = _gdi_.LANGUAGE_THAI
2640 LANGUAGE_TIBETAN = _gdi_.LANGUAGE_TIBETAN
2641 LANGUAGE_TIGRINYA = _gdi_.LANGUAGE_TIGRINYA
2642 LANGUAGE_TONGA = _gdi_.LANGUAGE_TONGA
2643 LANGUAGE_TSONGA = _gdi_.LANGUAGE_TSONGA
2644 LANGUAGE_TURKISH = _gdi_.LANGUAGE_TURKISH
2645 LANGUAGE_TURKMEN = _gdi_.LANGUAGE_TURKMEN
2646 LANGUAGE_TWI = _gdi_.LANGUAGE_TWI
2647 LANGUAGE_UIGHUR = _gdi_.LANGUAGE_UIGHUR
2648 LANGUAGE_UKRAINIAN = _gdi_.LANGUAGE_UKRAINIAN
2649 LANGUAGE_URDU = _gdi_.LANGUAGE_URDU
2650 LANGUAGE_URDU_INDIA = _gdi_.LANGUAGE_URDU_INDIA
2651 LANGUAGE_URDU_PAKISTAN = _gdi_.LANGUAGE_URDU_PAKISTAN
2652 LANGUAGE_UZBEK = _gdi_.LANGUAGE_UZBEK
2653 LANGUAGE_UZBEK_CYRILLIC = _gdi_.LANGUAGE_UZBEK_CYRILLIC
2654 LANGUAGE_UZBEK_LATIN = _gdi_.LANGUAGE_UZBEK_LATIN
2655 LANGUAGE_VIETNAMESE = _gdi_.LANGUAGE_VIETNAMESE
2656 LANGUAGE_VOLAPUK = _gdi_.LANGUAGE_VOLAPUK
2657 LANGUAGE_WELSH = _gdi_.LANGUAGE_WELSH
2658 LANGUAGE_WOLOF = _gdi_.LANGUAGE_WOLOF
2659 LANGUAGE_XHOSA = _gdi_.LANGUAGE_XHOSA
2660 LANGUAGE_YIDDISH = _gdi_.LANGUAGE_YIDDISH
2661 LANGUAGE_YORUBA = _gdi_.LANGUAGE_YORUBA
2662 LANGUAGE_ZHUANG = _gdi_.LANGUAGE_ZHUANG
2663 LANGUAGE_ZULU = _gdi_.LANGUAGE_ZULU
2664 LANGUAGE_USER_DEFINED = _gdi_.LANGUAGE_USER_DEFINED
2665 class LanguageInfo(object):
2666 """Proxy of C++ LanguageInfo class"""
2667 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2668 def __init__(self): raise AttributeError, "No constructor defined"
2669 __repr__ = _swig_repr
2670 Language = property(_gdi_.LanguageInfo_Language_get, _gdi_.LanguageInfo_Language_set)
2671 CanonicalName = property(_gdi_.LanguageInfo_CanonicalName_get, _gdi_.LanguageInfo_CanonicalName_set)
2672 Description = property(_gdi_.LanguageInfo_Description_get, _gdi_.LanguageInfo_Description_set)
2673 _gdi_.LanguageInfo_swigregister(LanguageInfo)
2674
2675 LOCALE_CAT_NUMBER = _gdi_.LOCALE_CAT_NUMBER
2676 LOCALE_CAT_DATE = _gdi_.LOCALE_CAT_DATE
2677 LOCALE_CAT_MONEY = _gdi_.LOCALE_CAT_MONEY
2678 LOCALE_CAT_MAX = _gdi_.LOCALE_CAT_MAX
2679 LOCALE_THOUSANDS_SEP = _gdi_.LOCALE_THOUSANDS_SEP
2680 LOCALE_DECIMAL_POINT = _gdi_.LOCALE_DECIMAL_POINT
2681 LOCALE_LOAD_DEFAULT = _gdi_.LOCALE_LOAD_DEFAULT
2682 LOCALE_CONV_ENCODING = _gdi_.LOCALE_CONV_ENCODING
2683 class Locale(object):
2684 """Proxy of C++ Locale class"""
2685 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2686 __repr__ = _swig_repr
2687 def __init__(self, *args, **kwargs):
2688 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
2689 _gdi_.Locale_swiginit(self,_gdi_.new_Locale(*args, **kwargs))
2690 __swig_destroy__ = _gdi_.delete_Locale
2691 __del__ = lambda self : None;
2692 def Init1(*args, **kwargs):
2693 """
2694 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2695 bool bLoadDefault=True,
2696 bool bConvertEncoding=False) -> bool
2697 """
2698 return _gdi_.Locale_Init1(*args, **kwargs)
2699
2700 def Init2(*args, **kwargs):
2701 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2702 return _gdi_.Locale_Init2(*args, **kwargs)
2703
2704 def Init(self, *_args, **_kwargs):
2705 if type(_args[0]) in [type(''), type(u'')]:
2706 val = self.Init1(*_args, **_kwargs)
2707 else:
2708 val = self.Init2(*_args, **_kwargs)
2709 return val
2710
2711 def GetSystemLanguage(*args, **kwargs):
2712 """GetSystemLanguage() -> int"""
2713 return _gdi_.Locale_GetSystemLanguage(*args, **kwargs)
2714
2715 GetSystemLanguage = staticmethod(GetSystemLanguage)
2716 def GetSystemEncoding(*args, **kwargs):
2717 """GetSystemEncoding() -> int"""
2718 return _gdi_.Locale_GetSystemEncoding(*args, **kwargs)
2719
2720 GetSystemEncoding = staticmethod(GetSystemEncoding)
2721 def GetSystemEncodingName(*args, **kwargs):
2722 """GetSystemEncodingName() -> String"""
2723 return _gdi_.Locale_GetSystemEncodingName(*args, **kwargs)
2724
2725 GetSystemEncodingName = staticmethod(GetSystemEncodingName)
2726 def IsOk(*args, **kwargs):
2727 """IsOk(self) -> bool"""
2728 return _gdi_.Locale_IsOk(*args, **kwargs)
2729
2730 def __nonzero__(self): return self.IsOk()
2731 def GetLocale(*args, **kwargs):
2732 """GetLocale(self) -> String"""
2733 return _gdi_.Locale_GetLocale(*args, **kwargs)
2734
2735 def GetLanguage(*args, **kwargs):
2736 """GetLanguage(self) -> int"""
2737 return _gdi_.Locale_GetLanguage(*args, **kwargs)
2738
2739 def GetSysName(*args, **kwargs):
2740 """GetSysName(self) -> String"""
2741 return _gdi_.Locale_GetSysName(*args, **kwargs)
2742
2743 def GetCanonicalName(*args, **kwargs):
2744 """GetCanonicalName(self) -> String"""
2745 return _gdi_.Locale_GetCanonicalName(*args, **kwargs)
2746
2747 def AddCatalogLookupPathPrefix(*args, **kwargs):
2748 """AddCatalogLookupPathPrefix(String prefix)"""
2749 return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs)
2750
2751 AddCatalogLookupPathPrefix = staticmethod(AddCatalogLookupPathPrefix)
2752 def AddCatalog(*args, **kwargs):
2753 """AddCatalog(self, String szDomain) -> bool"""
2754 return _gdi_.Locale_AddCatalog(*args, **kwargs)
2755
2756 def IsAvailable(*args, **kwargs):
2757 """IsAvailable(int lang) -> bool"""
2758 return _gdi_.Locale_IsAvailable(*args, **kwargs)
2759
2760 IsAvailable = staticmethod(IsAvailable)
2761 def IsLoaded(*args, **kwargs):
2762 """IsLoaded(self, String szDomain) -> bool"""
2763 return _gdi_.Locale_IsLoaded(*args, **kwargs)
2764
2765 def GetLanguageInfo(*args, **kwargs):
2766 """GetLanguageInfo(int lang) -> LanguageInfo"""
2767 return _gdi_.Locale_GetLanguageInfo(*args, **kwargs)
2768
2769 GetLanguageInfo = staticmethod(GetLanguageInfo)
2770 def GetLanguageName(*args, **kwargs):
2771 """GetLanguageName(int lang) -> String"""
2772 return _gdi_.Locale_GetLanguageName(*args, **kwargs)
2773
2774 GetLanguageName = staticmethod(GetLanguageName)
2775 def FindLanguageInfo(*args, **kwargs):
2776 """FindLanguageInfo(String locale) -> LanguageInfo"""
2777 return _gdi_.Locale_FindLanguageInfo(*args, **kwargs)
2778
2779 FindLanguageInfo = staticmethod(FindLanguageInfo)
2780 def AddLanguage(*args, **kwargs):
2781 """AddLanguage(LanguageInfo info)"""
2782 return _gdi_.Locale_AddLanguage(*args, **kwargs)
2783
2784 AddLanguage = staticmethod(AddLanguage)
2785 def GetString(*args, **kwargs):
2786 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2787 return _gdi_.Locale_GetString(*args, **kwargs)
2788
2789 def GetName(*args, **kwargs):
2790 """GetName(self) -> String"""
2791 return _gdi_.Locale_GetName(*args, **kwargs)
2792
2793 CanonicalName = property(GetCanonicalName,doc="See `GetCanonicalName`")
2794 Language = property(GetLanguage,doc="See `GetLanguage`")
2795 Locale = property(GetLocale,doc="See `GetLocale`")
2796 Name = property(GetName,doc="See `GetName`")
2797 String = property(GetString,doc="See `GetString`")
2798 SysName = property(GetSysName,doc="See `GetSysName`")
2799 _gdi_.Locale_swigregister(Locale)
2800
2801 def Locale_GetSystemLanguage(*args):
2802 """Locale_GetSystemLanguage() -> int"""
2803 return _gdi_.Locale_GetSystemLanguage(*args)
2804
2805 def Locale_GetSystemEncoding(*args):
2806 """Locale_GetSystemEncoding() -> int"""
2807 return _gdi_.Locale_GetSystemEncoding(*args)
2808
2809 def Locale_GetSystemEncodingName(*args):
2810 """Locale_GetSystemEncodingName() -> String"""
2811 return _gdi_.Locale_GetSystemEncodingName(*args)
2812
2813 def Locale_AddCatalogLookupPathPrefix(*args, **kwargs):
2814 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2815 return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs)
2816
2817 def Locale_IsAvailable(*args, **kwargs):
2818 """Locale_IsAvailable(int lang) -> bool"""
2819 return _gdi_.Locale_IsAvailable(*args, **kwargs)
2820
2821 def Locale_GetLanguageInfo(*args, **kwargs):
2822 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2823 return _gdi_.Locale_GetLanguageInfo(*args, **kwargs)
2824
2825 def Locale_GetLanguageName(*args, **kwargs):
2826 """Locale_GetLanguageName(int lang) -> String"""
2827 return _gdi_.Locale_GetLanguageName(*args, **kwargs)
2828
2829 def Locale_FindLanguageInfo(*args, **kwargs):
2830 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2831 return _gdi_.Locale_FindLanguageInfo(*args, **kwargs)
2832
2833 def Locale_AddLanguage(*args, **kwargs):
2834 """Locale_AddLanguage(LanguageInfo info)"""
2835 return _gdi_.Locale_AddLanguage(*args, **kwargs)
2836
2837 class PyLocale(Locale):
2838 """Proxy of C++ PyLocale class"""
2839 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2840 __repr__ = _swig_repr
2841 def __init__(self, *args, **kwargs):
2842 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale"""
2843 _gdi_.PyLocale_swiginit(self,_gdi_.new_PyLocale(*args, **kwargs))
2844 self._setCallbackInfo(self, PyLocale)
2845
2846 __swig_destroy__ = _gdi_.delete_PyLocale
2847 __del__ = lambda self : None;
2848 def _setCallbackInfo(*args, **kwargs):
2849 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2850 return _gdi_.PyLocale__setCallbackInfo(*args, **kwargs)
2851
2852 def GetSingularString(*args, **kwargs):
2853 """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar"""
2854 return _gdi_.PyLocale_GetSingularString(*args, **kwargs)
2855
2856 def GetPluralString(*args, **kwargs):
2857 """
2858 GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n,
2859 wxChar szDomain=None) -> wxChar
2860 """
2861 return _gdi_.PyLocale_GetPluralString(*args, **kwargs)
2862
2863 _gdi_.PyLocale_swigregister(PyLocale)
2864
2865
2866 def GetLocale(*args):
2867 """GetLocale() -> Locale"""
2868 return _gdi_.GetLocale(*args)
2869 #---------------------------------------------------------------------------
2870
2871 CONVERT_STRICT = _gdi_.CONVERT_STRICT
2872 CONVERT_SUBSTITUTE = _gdi_.CONVERT_SUBSTITUTE
2873 PLATFORM_CURRENT = _gdi_.PLATFORM_CURRENT
2874 PLATFORM_UNIX = _gdi_.PLATFORM_UNIX
2875 PLATFORM_WINDOWS = _gdi_.PLATFORM_WINDOWS
2876 PLATFORM_OS2 = _gdi_.PLATFORM_OS2
2877 PLATFORM_MAC = _gdi_.PLATFORM_MAC
2878 class EncodingConverter(_core.Object):
2879 """Proxy of C++ EncodingConverter class"""
2880 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2881 __repr__ = _swig_repr
2882 def __init__(self, *args, **kwargs):
2883 """__init__(self) -> EncodingConverter"""
2884 _gdi_.EncodingConverter_swiginit(self,_gdi_.new_EncodingConverter(*args, **kwargs))
2885 __swig_destroy__ = _gdi_.delete_EncodingConverter
2886 __del__ = lambda self : None;
2887 def Init(*args, **kwargs):
2888 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2889 return _gdi_.EncodingConverter_Init(*args, **kwargs)
2890
2891 def Convert(*args, **kwargs):
2892 """Convert(self, String input) -> String"""
2893 return _gdi_.EncodingConverter_Convert(*args, **kwargs)
2894
2895 def GetPlatformEquivalents(*args, **kwargs):
2896 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2897 return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs)
2898
2899 GetPlatformEquivalents = staticmethod(GetPlatformEquivalents)
2900 def GetAllEquivalents(*args, **kwargs):
2901 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2902 return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs)
2903
2904 GetAllEquivalents = staticmethod(GetAllEquivalents)
2905 def CanConvert(*args, **kwargs):
2906 """CanConvert(int encIn, int encOut) -> bool"""
2907 return _gdi_.EncodingConverter_CanConvert(*args, **kwargs)
2908
2909 CanConvert = staticmethod(CanConvert)
2910 def __nonzero__(self): return self.IsOk()
2911 _gdi_.EncodingConverter_swigregister(EncodingConverter)
2912
2913 def GetTranslation(*args):
2914 """
2915 GetTranslation(String str) -> String
2916 GetTranslation(String str, String domain) -> String
2917 GetTranslation(String str, String strPlural, size_t n) -> String
2918 GetTranslation(String str, String strPlural, size_t n, String domain) -> String
2919 """
2920 return _gdi_.GetTranslation(*args)
2921
2922 def EncodingConverter_GetPlatformEquivalents(*args, **kwargs):
2923 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2924 return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs)
2925
2926 def EncodingConverter_GetAllEquivalents(*args, **kwargs):
2927 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2928 return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs)
2929
2930 def EncodingConverter_CanConvert(*args, **kwargs):
2931 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2932 return _gdi_.EncodingConverter_CanConvert(*args, **kwargs)
2933
2934 #----------------------------------------------------------------------------
2935 # On MSW add the directory where the wxWidgets catalogs were installed
2936 # to the default catalog path.
2937 if wx.Platform == "__WXMSW__":
2938 import os
2939 _localedir = os.path.join(os.path.split(__file__)[0], "i18n")
2940 Locale.AddCatalogLookupPathPrefix(_localedir)
2941 del os
2942
2943 #----------------------------------------------------------------------------
2944
2945 #---------------------------------------------------------------------------
2946
2947 class DC(_core.Object):
2948 """
2949 A wx.DC is a device context onto which graphics and text can be
2950 drawn. It is intended to represent a number of output devices in a
2951 generic way, so a window can have a device context associated with it,
2952 and a printer also has a device context. In this way, the same piece
2953 of code may write to a number of different devices, if the device
2954 context is used as a parameter.
2955
2956 Derived types of wxDC have documentation for specific features only,
2957 so refer to this section for most device context information.
2958
2959 The wx.DC class is abstract and can not be instantiated, you must use
2960 one of the derived classes instead. Which one will depend on the
2961 situation in which it is used.
2962 """
2963 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2964 def __init__(self): raise AttributeError, "No constructor defined"
2965 __repr__ = _swig_repr
2966 __swig_destroy__ = _gdi_.delete_DC
2967 __del__ = lambda self : None;
2968 # These have been deprecated in wxWidgets. Since they never
2969 # really did anything to begin with, just make them be NOPs.
2970 def BeginDrawing(self): pass
2971 def EndDrawing(self): pass
2972
2973 def FloodFill(*args, **kwargs):
2974 """
2975 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2976
2977 Flood fills the device context starting from the given point, using
2978 the current brush colour, and using a style:
2979
2980 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2981 the given colour is encountered.
2982
2983 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2984 colour.
2985
2986 Returns False if the operation failed.
2987
2988 Note: The present implementation for non-Windows platforms may fail to
2989 find colour borders if the pixels do not match the colour
2990 exactly. However the function will still return true.
2991 """
2992 return _gdi_.DC_FloodFill(*args, **kwargs)
2993
2994 def FloodFillPoint(*args, **kwargs):
2995 """
2996 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2997
2998 Flood fills the device context starting from the given point, using
2999 the current brush colour, and using a style:
3000
3001 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
3002 the given colour is encountered.
3003
3004 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
3005 colour.
3006
3007 Returns False if the operation failed.
3008
3009 Note: The present implementation for non-Windows platforms may fail to
3010 find colour borders if the pixels do not match the colour
3011 exactly. However the function will still return true.
3012 """
3013 return _gdi_.DC_FloodFillPoint(*args, **kwargs)
3014
3015 def GradientFillConcentric(*args, **kwargs):
3016 """
3017 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
3018 Point circleCenter)
3019
3020 Fill the area specified by rect with a radial gradient, starting from
3021 initialColour in the center of the circle and fading to destColour on
3022 the outside of the circle. The circleCenter argument is the relative
3023 coordinants of the center of the circle in the specified rect.
3024
3025 Note: Currently this function is very slow, don't use it for real-time
3026 drawing.
3027 """
3028 return _gdi_.DC_GradientFillConcentric(*args, **kwargs)
3029
3030 def GradientFillLinear(*args, **kwargs):
3031 """
3032 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
3033 int nDirection=EAST)
3034
3035 Fill the area specified by rect with a linear gradient, starting from
3036 initialColour and eventually fading to destColour. The nDirection
3037 parameter specifies the direction of the colour change, default is to
3038 use initialColour on the left part of the rectangle and destColour on
3039 the right side.
3040 """
3041 return _gdi_.DC_GradientFillLinear(*args, **kwargs)
3042
3043 def GetPixel(*args, **kwargs):
3044 """
3045 GetPixel(self, int x, int y) -> Colour
3046
3047 Gets the colour at the specified location on the DC.
3048 """
3049 return _gdi_.DC_GetPixel(*args, **kwargs)
3050
3051 def GetPixelPoint(*args, **kwargs):
3052 """GetPixelPoint(self, Point pt) -> Colour"""
3053 return _gdi_.DC_GetPixelPoint(*args, **kwargs)
3054
3055 def DrawLine(*args, **kwargs):
3056 """
3057 DrawLine(self, int x1, int y1, int x2, int y2)
3058
3059 Draws a line from the first point to the second. The current pen is
3060 used for drawing the line. Note that the second point is *not* part of
3061 the line and is not drawn by this function (this is consistent with
3062 the behaviour of many other toolkits).
3063 """
3064 return _gdi_.DC_DrawLine(*args, **kwargs)
3065
3066 def DrawLinePoint(*args, **kwargs):
3067 """
3068 DrawLinePoint(self, Point pt1, Point pt2)
3069
3070 Draws a line from the first point to the second. The current pen is
3071 used for drawing the line. Note that the second point is *not* part of
3072 the line and is not drawn by this function (this is consistent with
3073 the behaviour of many other toolkits).
3074 """
3075 return _gdi_.DC_DrawLinePoint(*args, **kwargs)
3076
3077 def CrossHair(*args, **kwargs):
3078 """
3079 CrossHair(self, int x, int y)
3080
3081 Displays a cross hair using the current pen. This is a vertical and
3082 horizontal line the height and width of the window, centred on the
3083 given point.
3084 """
3085 return _gdi_.DC_CrossHair(*args, **kwargs)
3086
3087 def CrossHairPoint(*args, **kwargs):
3088 """
3089 CrossHairPoint(self, Point pt)
3090
3091 Displays a cross hair using the current pen. This is a vertical and
3092 horizontal line the height and width of the window, centred on the
3093 given point.
3094 """
3095 return _gdi_.DC_CrossHairPoint(*args, **kwargs)
3096
3097 def DrawArc(*args, **kwargs):
3098 """
3099 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
3100
3101 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3102 the first point to the second. The current pen is used for the outline
3103 and the current brush for filling the shape.
3104
3105 The arc is drawn in an anticlockwise direction from the start point to
3106 the end point.
3107 """
3108 return _gdi_.DC_DrawArc(*args, **kwargs)
3109
3110 def DrawArcPoint(*args, **kwargs):
3111 """
3112 DrawArcPoint(self, Point pt1, Point pt2, Point center)
3113
3114 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3115 the first point to the second. The current pen is used for the outline
3116 and the current brush for filling the shape.
3117
3118 The arc is drawn in an anticlockwise direction from the start point to
3119 the end point.
3120 """
3121 return _gdi_.DC_DrawArcPoint(*args, **kwargs)
3122
3123 def DrawCheckMark(*args, **kwargs):
3124 """
3125 DrawCheckMark(self, int x, int y, int width, int height)
3126
3127 Draws a check mark inside the given rectangle.
3128 """
3129 return _gdi_.DC_DrawCheckMark(*args, **kwargs)
3130
3131 def DrawCheckMarkRect(*args, **kwargs):
3132 """
3133 DrawCheckMarkRect(self, Rect rect)
3134
3135 Draws a check mark inside the given rectangle.
3136 """
3137 return _gdi_.DC_DrawCheckMarkRect(*args, **kwargs)
3138
3139 def DrawEllipticArc(*args, **kwargs):
3140 """
3141 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
3142
3143 Draws an arc of an ellipse, with the given rectangle defining the
3144 bounds of the ellipse. The current pen is used for drawing the arc and
3145 the current brush is used for drawing the pie.
3146
3147 The *start* and *end* parameters specify the start and end of the arc
3148 relative to the three-o'clock position from the center of the
3149 rectangle. Angles are specified in degrees (360 is a complete
3150 circle). Positive values mean counter-clockwise motion. If start is
3151 equal to end, a complete ellipse will be drawn.
3152 """
3153 return _gdi_.DC_DrawEllipticArc(*args, **kwargs)
3154
3155 def DrawEllipticArcPointSize(*args, **kwargs):
3156 """
3157 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
3158
3159 Draws an arc of an ellipse, with the given rectangle defining the
3160 bounds of the ellipse. The current pen is used for drawing the arc and
3161 the current brush is used for drawing the pie.
3162
3163 The *start* and *end* parameters specify the start and end of the arc
3164 relative to the three-o'clock position from the center of the
3165 rectangle. Angles are specified in degrees (360 is a complete
3166 circle). Positive values mean counter-clockwise motion. If start is
3167 equal to end, a complete ellipse will be drawn.
3168 """
3169 return _gdi_.DC_DrawEllipticArcPointSize(*args, **kwargs)
3170
3171 def DrawPoint(*args, **kwargs):
3172 """
3173 DrawPoint(self, int x, int y)
3174
3175 Draws a point using the current pen.
3176 """
3177 return _gdi_.DC_DrawPoint(*args, **kwargs)
3178
3179 def DrawPointPoint(*args, **kwargs):
3180 """
3181 DrawPointPoint(self, Point pt)
3182
3183 Draws a point using the current pen.
3184 """
3185 return _gdi_.DC_DrawPointPoint(*args, **kwargs)
3186
3187 def DrawRectangle(*args, **kwargs):
3188 """
3189 DrawRectangle(self, int x, int y, int width, int height)
3190
3191 Draws a rectangle with the given top left corner, and with the given
3192 size. The current pen is used for the outline and the current brush
3193 for filling the shape.
3194 """
3195 return _gdi_.DC_DrawRectangle(*args, **kwargs)
3196
3197 def DrawRectangleRect(*args, **kwargs):
3198 """
3199 DrawRectangleRect(self, Rect rect)
3200
3201 Draws a rectangle with the given top left corner, and with the given
3202 size. The current pen is used for the outline and the current brush
3203 for filling the shape.
3204 """
3205 return _gdi_.DC_DrawRectangleRect(*args, **kwargs)
3206
3207 def DrawRectanglePointSize(*args, **kwargs):
3208 """
3209 DrawRectanglePointSize(self, Point pt, Size sz)
3210
3211 Draws a rectangle with the given top left corner, and with the given
3212 size. The current pen is used for the outline and the current brush
3213 for filling the shape.
3214 """
3215 return _gdi_.DC_DrawRectanglePointSize(*args, **kwargs)
3216
3217 def DrawRoundedRectangle(*args, **kwargs):
3218 """
3219 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
3220
3221 Draws a rectangle with the given top left corner, and with the given
3222 size. The corners are quarter-circles using the given radius. The
3223 current pen is used for the outline and the current brush for filling
3224 the shape.
3225
3226 If radius is positive, the value is assumed to be the radius of the
3227 rounded corner. If radius is negative, the absolute value is assumed
3228 to be the proportion of the smallest dimension of the rectangle. This
3229 means that the corner can be a sensible size relative to the size of
3230 the rectangle, and also avoids the strange effects X produces when the
3231 corners are too big for the rectangle.
3232 """
3233 return _gdi_.DC_DrawRoundedRectangle(*args, **kwargs)
3234
3235 def DrawRoundedRectangleRect(*args, **kwargs):
3236 """
3237 DrawRoundedRectangleRect(self, Rect r, double radius)
3238
3239 Draws a rectangle with the given top left corner, and with the given
3240 size. The corners are quarter-circles using the given radius. The
3241 current pen is used for the outline and the current brush for filling
3242 the shape.
3243
3244 If radius is positive, the value is assumed to be the radius of the
3245 rounded corner. If radius is negative, the absolute value is assumed
3246 to be the proportion of the smallest dimension of the rectangle. This
3247 means that the corner can be a sensible size relative to the size of
3248 the rectangle, and also avoids the strange effects X produces when the
3249 corners are too big for the rectangle.
3250 """
3251 return _gdi_.DC_DrawRoundedRectangleRect(*args, **kwargs)
3252
3253 def DrawRoundedRectanglePointSize(*args, **kwargs):
3254 """
3255 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
3256
3257 Draws a rectangle with the given top left corner, and with the given
3258 size. The corners are quarter-circles using the given radius. The
3259 current pen is used for the outline and the current brush for filling
3260 the shape.
3261
3262 If radius is positive, the value is assumed to be the radius of the
3263 rounded corner. If radius is negative, the absolute value is assumed
3264 to be the proportion of the smallest dimension of the rectangle. This
3265 means that the corner can be a sensible size relative to the size of
3266 the rectangle, and also avoids the strange effects X produces when the
3267 corners are too big for the rectangle.
3268 """
3269 return _gdi_.DC_DrawRoundedRectanglePointSize(*args, **kwargs)
3270
3271 def DrawCircle(*args, **kwargs):
3272 """
3273 DrawCircle(self, int x, int y, int radius)
3274
3275 Draws a circle with the given center point and radius. The current
3276 pen is used for the outline and the current brush for filling the
3277 shape.
3278 """
3279 return _gdi_.DC_DrawCircle(*args, **kwargs)
3280
3281 def DrawCirclePoint(*args, **kwargs):
3282 """
3283 DrawCirclePoint(self, Point pt, int radius)
3284
3285 Draws a circle with the given center point and radius. The current
3286 pen is used for the outline and the current brush for filling the
3287 shape.
3288 """
3289 return _gdi_.DC_DrawCirclePoint(*args, **kwargs)
3290
3291 def DrawEllipse(*args, **kwargs):
3292 """
3293 DrawEllipse(self, int x, int y, int width, int height)
3294
3295 Draws an ellipse contained in the specified rectangle. The current pen
3296 is used for the outline and the current brush for filling the shape.
3297 """
3298 return _gdi_.DC_DrawEllipse(*args, **kwargs)
3299
3300 def DrawEllipseRect(*args, **kwargs):
3301 """
3302 DrawEllipseRect(self, Rect rect)
3303
3304 Draws an ellipse contained in the specified rectangle. The current pen
3305 is used for the outline and the current brush for filling the shape.
3306 """
3307 return _gdi_.DC_DrawEllipseRect(*args, **kwargs)
3308
3309 def DrawEllipsePointSize(*args, **kwargs):
3310 """
3311 DrawEllipsePointSize(self, Point pt, Size sz)
3312
3313 Draws an ellipse contained in the specified rectangle. The current pen
3314 is used for the outline and the current brush for filling the shape.
3315 """
3316 return _gdi_.DC_DrawEllipsePointSize(*args, **kwargs)
3317
3318 def DrawIcon(*args, **kwargs):
3319 """
3320 DrawIcon(self, Icon icon, int x, int y)
3321
3322 Draw an icon on the display (does nothing if the device context is
3323 PostScript). This can be the simplest way of drawing bitmaps on a
3324 window.
3325 """
3326 return _gdi_.DC_DrawIcon(*args, **kwargs)
3327
3328 def DrawIconPoint(*args, **kwargs):
3329 """
3330 DrawIconPoint(self, Icon icon, Point pt)
3331
3332 Draw an icon on the display (does nothing if the device context is
3333 PostScript). This can be the simplest way of drawing bitmaps on a
3334 window.
3335 """
3336 return _gdi_.DC_DrawIconPoint(*args, **kwargs)
3337
3338 def DrawBitmap(*args, **kwargs):
3339 """
3340 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
3341
3342 Draw a bitmap on the device context at the specified point. If
3343 *transparent* is true and the bitmap has a transparency mask, (or
3344 alpha channel on the platforms that support it) then the bitmap will
3345 be drawn transparently.
3346 """
3347 return _gdi_.DC_DrawBitmap(*args, **kwargs)
3348
3349 def DrawBitmapPoint(*args, **kwargs):
3350 """
3351 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3352
3353 Draw a bitmap on the device context at the specified point. If
3354 *transparent* is true and the bitmap has a transparency mask, (or
3355 alpha channel on the platforms that support it) then the bitmap will
3356 be drawn transparently.
3357 """
3358 return _gdi_.DC_DrawBitmapPoint(*args, **kwargs)
3359
3360 def DrawText(*args, **kwargs):
3361 """
3362 DrawText(self, String text, int x, int y)
3363
3364 Draws a text string at the specified point, using the current text
3365 font, and the current text foreground and background colours.
3366
3367 The coordinates refer to the top-left corner of the rectangle bounding
3368 the string. See `GetTextExtent` for how to get the dimensions of a
3369 text string, which can be used to position the text more precisely.
3370
3371 **NOTE**: under wxGTK the current logical function is used by this
3372 function but it is ignored by wxMSW. Thus, you should avoid using
3373 logical functions with this function in portable programs.
3374 """
3375 return _gdi_.DC_DrawText(*args, **kwargs)
3376
3377 def DrawTextPoint(*args, **kwargs):
3378 """
3379 DrawTextPoint(self, String text, Point pt)
3380
3381 Draws a text string at the specified point, using the current text
3382 font, and the current text foreground and background colours.
3383
3384 The coordinates refer to the top-left corner of the rectangle bounding
3385 the string. See `GetTextExtent` for how to get the dimensions of a
3386 text string, which can be used to position the text more precisely.
3387
3388 **NOTE**: under wxGTK the current logical function is used by this
3389 function but it is ignored by wxMSW. Thus, you should avoid using
3390 logical functions with this function in portable programs.
3391 """
3392 return _gdi_.DC_DrawTextPoint(*args, **kwargs)
3393
3394 def DrawRotatedText(*args, **kwargs):
3395 """
3396 DrawRotatedText(self, String text, int x, int y, double angle)
3397
3398 Draws the text rotated by *angle* degrees, if supported by the platform.
3399
3400 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3401 function. In particular, a font different from ``wx.NORMAL_FONT``
3402 should be used as the it is not normally a TrueType
3403 font. ``wx.SWISS_FONT`` is an example of a font which is.
3404 """
3405 return _gdi_.DC_DrawRotatedText(*args, **kwargs)
3406
3407 def DrawRotatedTextPoint(*args, **kwargs):
3408 """
3409 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3410
3411 Draws the text rotated by *angle* degrees, if supported by the platform.
3412
3413 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3414 function. In particular, a font different from ``wx.NORMAL_FONT``
3415 should be used as the it is not normally a TrueType
3416 font. ``wx.SWISS_FONT`` is an example of a font which is.
3417 """
3418 return _gdi_.DC_DrawRotatedTextPoint(*args, **kwargs)
3419
3420 def Blit(*args, **kwargs):
3421 """
3422 Blit(self, int xdest, int ydest, int width, int height, DC source,
3423 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3424 int xsrcMask=-1, int ysrcMask=-1) -> bool
3425
3426 Copy from a source DC to this DC. Parameters specify the destination
3427 coordinates, size of area to copy, source DC, source coordinates,
3428 logical function, whether to use a bitmap mask, and mask source
3429 position.
3430 """
3431 return _gdi_.DC_Blit(*args, **kwargs)
3432
3433 def BlitPointSize(*args, **kwargs):
3434 """
3435 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
3436 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
3437
3438 Copy from a source DC to this DC. Parameters specify the destination
3439 coordinates, size of area to copy, source DC, source coordinates,
3440 logical function, whether to use a bitmap mask, and mask source
3441 position.
3442 """
3443 return _gdi_.DC_BlitPointSize(*args, **kwargs)
3444
3445 def SetClippingRegion(*args, **kwargs):
3446 """
3447 SetClippingRegion(self, int x, int y, int width, int height)
3448
3449 Sets the clipping region for this device context to the intersection
3450 of the given region described by the parameters of this method and the
3451 previously set clipping region. You should call `DestroyClippingRegion`
3452 if you want to set the clipping region exactly to the region
3453 specified.
3454
3455 The clipping region is an area to which drawing is
3456 restricted. Possible uses for the clipping region are for clipping
3457 text or for speeding up window redraws when only a known area of the
3458 screen is damaged.
3459 """
3460 return _gdi_.DC_SetClippingRegion(*args, **kwargs)
3461
3462 def SetClippingRegionPointSize(*args, **kwargs):
3463 """
3464 SetClippingRegionPointSize(self, Point pt, Size sz)
3465
3466 Sets the clipping region for this device context to the intersection
3467 of the given region described by the parameters of this method and the
3468 previously set clipping region. You should call `DestroyClippingRegion`
3469 if you want to set the clipping region exactly to the region
3470 specified.
3471
3472 The clipping region is an area to which drawing is
3473 restricted. Possible uses for the clipping region are for clipping
3474 text or for speeding up window redraws when only a known area of the
3475 screen is damaged.
3476 """
3477 return _gdi_.DC_SetClippingRegionPointSize(*args, **kwargs)
3478
3479 def SetClippingRegionAsRegion(*args, **kwargs):
3480 """
3481 SetClippingRegionAsRegion(self, Region region)
3482
3483 Sets the clipping region for this device context to the intersection
3484 of the given region described by the parameters of this method and the
3485 previously set clipping region. You should call `DestroyClippingRegion`
3486 if you want to set the clipping region exactly to the region
3487 specified.
3488
3489 The clipping region is an area to which drawing is
3490 restricted. Possible uses for the clipping region are for clipping
3491 text or for speeding up window redraws when only a known area of the
3492 screen is damaged.
3493 """
3494 return _gdi_.DC_SetClippingRegionAsRegion(*args, **kwargs)
3495
3496 def SetClippingRect(*args, **kwargs):
3497 """
3498 SetClippingRect(self, Rect rect)
3499
3500 Sets the clipping region for this device context to the intersection
3501 of the given region described by the parameters of this method and the
3502 previously set clipping region. You should call `DestroyClippingRegion`
3503 if you want to set the clipping region exactly to the region
3504 specified.
3505
3506 The clipping region is an area to which drawing is
3507 restricted. Possible uses for the clipping region are for clipping
3508 text or for speeding up window redraws when only a known area of the
3509 screen is damaged.
3510 """
3511 return _gdi_.DC_SetClippingRect(*args, **kwargs)
3512
3513 def DrawLines(*args, **kwargs):
3514 """
3515 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3516
3517 Draws lines using a sequence of `wx.Point` objects, adding the
3518 optional offset coordinate. The current pen is used for drawing the
3519 lines.
3520 """
3521 return _gdi_.DC_DrawLines(*args, **kwargs)
3522
3523 def DrawPolygon(*args, **kwargs):
3524 """
3525 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
3526 int fillStyle=ODDEVEN_RULE)
3527
3528 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3529 the optional offset coordinate. The last argument specifies the fill
3530 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3531
3532 The current pen is used for drawing the outline, and the current brush
3533 for filling the shape. Using a transparent brush suppresses
3534 filling. Note that wxWidgets automatically closes the first and last
3535 points.
3536 """
3537 return _gdi_.DC_DrawPolygon(*args, **kwargs)
3538
3539 def DrawLabel(*args, **kwargs):
3540 """
3541 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3542 int indexAccel=-1)
3543
3544 Draw *text* within the specified rectangle, abiding by the alignment
3545 flags. Will additionally emphasize the character at *indexAccel* if
3546 it is not -1.
3547 """
3548 return _gdi_.DC_DrawLabel(*args, **kwargs)
3549
3550 def DrawImageLabel(*args, **kwargs):
3551 """
3552 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3553 int indexAccel=-1) -> Rect
3554
3555 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3556 drawing it) within the specified rectangle, abiding by the alignment
3557 flags. Will additionally emphasize the character at *indexAccel* if
3558 it is not -1. Returns the bounding rectangle.
3559 """
3560 return _gdi_.DC_DrawImageLabel(*args, **kwargs)
3561
3562 def DrawSpline(*args, **kwargs):
3563 """
3564 DrawSpline(self, List points)
3565
3566 Draws a spline between all given control points, (a list of `wx.Point`
3567 objects) using the current pen. The spline is drawn using a series of
3568 lines, using an algorithm taken from the X drawing program 'XFIG'.
3569 """
3570 return _gdi_.DC_DrawSpline(*args, **kwargs)
3571
3572 def Clear(*args, **kwargs):
3573 """
3574 Clear(self)
3575
3576 Clears the device context using the current background brush.
3577 """
3578 return _gdi_.DC_Clear(*args, **kwargs)
3579
3580 def StartDoc(*args, **kwargs):
3581 """
3582 StartDoc(self, String message) -> bool
3583
3584 Starts a document (only relevant when outputting to a
3585 printer). *Message* is a message to show whilst printing.
3586 """
3587 return _gdi_.DC_StartDoc(*args, **kwargs)
3588
3589 def EndDoc(*args, **kwargs):
3590 """
3591 EndDoc(self)
3592
3593 Ends a document (only relevant when outputting to a printer).
3594 """
3595 return _gdi_.DC_EndDoc(*args, **kwargs)
3596
3597 def StartPage(*args, **kwargs):
3598 """
3599 StartPage(self)
3600
3601 Starts a document page (only relevant when outputting to a printer).
3602 """
3603 return _gdi_.DC_StartPage(*args, **kwargs)
3604
3605 def EndPage(*args, **kwargs):
3606 """
3607 EndPage(self)
3608
3609 Ends a document page (only relevant when outputting to a printer).
3610 """
3611 return _gdi_.DC_EndPage(*args, **kwargs)
3612
3613 def SetFont(*args, **kwargs):
3614 """
3615 SetFont(self, Font font)
3616
3617 Sets the current font for the DC. It must be a valid font, in
3618 particular you should not pass ``wx.NullFont`` to this method.
3619 """
3620 return _gdi_.DC_SetFont(*args, **kwargs)
3621
3622 def SetPen(*args, **kwargs):
3623 """
3624 SetPen(self, Pen pen)
3625
3626 Sets the current pen for the DC.
3627
3628 If the argument is ``wx.NullPen``, the current pen is selected out of the
3629 device context, and the original pen restored.
3630 """
3631 return _gdi_.DC_SetPen(*args, **kwargs)
3632
3633 def SetBrush(*args, **kwargs):
3634 """
3635 SetBrush(self, Brush brush)
3636
3637 Sets the current brush for the DC.
3638
3639 If the argument is ``wx.NullBrush``, the current brush is selected out
3640 of the device context, and the original brush restored, allowing the
3641 current brush to be destroyed safely.
3642 """
3643 return _gdi_.DC_SetBrush(*args, **kwargs)
3644
3645 def SetBackground(*args, **kwargs):
3646 """
3647 SetBackground(self, Brush brush)
3648
3649 Sets the current background brush for the DC.
3650 """
3651 return _gdi_.DC_SetBackground(*args, **kwargs)
3652
3653 def SetBackgroundMode(*args, **kwargs):
3654 """
3655 SetBackgroundMode(self, int mode)
3656
3657 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3658 determines whether text will be drawn with a background colour or
3659 not.
3660 """
3661 return _gdi_.DC_SetBackgroundMode(*args, **kwargs)
3662
3663 def SetPalette(*args, **kwargs):
3664 """
3665 SetPalette(self, Palette palette)
3666
3667 If this is a window DC or memory DC, assigns the given palette to the
3668 window or bitmap associated with the DC. If the argument is
3669 ``wx.NullPalette``, the current palette is selected out of the device
3670 context, and the original palette restored.
3671 """
3672 return _gdi_.DC_SetPalette(*args, **kwargs)
3673
3674 def DestroyClippingRegion(*args, **kwargs):
3675 """
3676 DestroyClippingRegion(self)
3677
3678 Destroys the current clipping region so that none of the DC is
3679 clipped.
3680 """
3681 return _gdi_.DC_DestroyClippingRegion(*args, **kwargs)
3682
3683 def GetClippingBox(*args, **kwargs):
3684 """
3685 GetClippingBox() -> (x, y, width, height)
3686
3687 Gets the rectangle surrounding the current clipping region.
3688 """
3689 return _gdi_.DC_GetClippingBox(*args, **kwargs)
3690
3691 def GetClippingRect(*args, **kwargs):
3692 """
3693 GetClippingRect(self) -> Rect
3694
3695 Gets the rectangle surrounding the current clipping region.
3696 """
3697 return _gdi_.DC_GetClippingRect(*args, **kwargs)
3698
3699 def GetCharHeight(*args, **kwargs):
3700 """
3701 GetCharHeight(self) -> int
3702
3703 Gets the character height of the currently set font.
3704 """
3705 return _gdi_.DC_GetCharHeight(*args, **kwargs)
3706
3707 def GetCharWidth(*args, **kwargs):
3708 """
3709 GetCharWidth(self) -> int
3710
3711 Gets the average character width of the currently set font.
3712 """
3713 return _gdi_.DC_GetCharWidth(*args, **kwargs)
3714
3715 def GetTextExtent(*args, **kwargs):
3716 """
3717 GetTextExtent(wxString string) -> (width, height)
3718
3719 Get the width and height of the text using the current font. Only
3720 works for single line strings.
3721 """
3722 return _gdi_.DC_GetTextExtent(*args, **kwargs)
3723
3724 def GetFullTextExtent(*args, **kwargs):
3725 """
3726 GetFullTextExtent(wxString string, Font font=None) ->
3727 (width, height, descent, externalLeading)
3728
3729 Get the width, height, decent and leading of the text using the
3730 current or specified font. Only works for single line strings.
3731 """
3732 return _gdi_.DC_GetFullTextExtent(*args, **kwargs)
3733
3734 def GetMultiLineTextExtent(*args, **kwargs):
3735 """
3736 GetMultiLineTextExtent(wxString string, Font font=None) ->
3737 (width, height, lineHeight)
3738
3739 Get the width, height, decent and leading of the text using the
3740 current or specified font. Works for single as well as multi-line
3741 strings.
3742 """
3743 return _gdi_.DC_GetMultiLineTextExtent(*args, **kwargs)
3744
3745 def GetPartialTextExtents(*args, **kwargs):
3746 """
3747 GetPartialTextExtents(self, text) -> [widths]
3748
3749 Returns a list of integers such that each value is the distance in
3750 pixels from the begining of text to the coresponding character of
3751 *text*. The generic version simply builds a running total of the widths
3752 of each character using GetTextExtent, however if the various
3753 platforms have a native API function that is faster or more accurate
3754 than the generic implementation then it will be used instead.
3755 """
3756 return _gdi_.DC_GetPartialTextExtents(*args, **kwargs)
3757
3758 def GetSize(*args, **kwargs):
3759 """
3760 GetSize(self) -> Size
3761
3762 This gets the horizontal and vertical resolution in device units. It
3763 can be used to scale graphics to fit the page. For example, if *maxX*
3764 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3765 used in your application, the following code will scale the graphic to
3766 fit on the printer page::
3767
3768 w, h = dc.GetSize()
3769 scaleX = maxX*1.0 / w
3770 scaleY = maxY*1.0 / h
3771 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3772
3773 """
3774 return _gdi_.DC_GetSize(*args, **kwargs)
3775
3776 def GetSizeTuple(*args, **kwargs):
3777 """
3778 GetSizeTuple() -> (width, height)
3779
3780 This gets the horizontal and vertical resolution in device units. It
3781 can be used to scale graphics to fit the page. For example, if *maxX*
3782 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3783 used in your application, the following code will scale the graphic to
3784 fit on the printer page::
3785
3786 w, h = dc.GetSize()
3787 scaleX = maxX*1.0 / w
3788 scaleY = maxY*1.0 / h
3789 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3790
3791 """
3792 return _gdi_.DC_GetSizeTuple(*args, **kwargs)
3793
3794 def GetSizeMM(*args, **kwargs):
3795 """
3796 GetSizeMM(self) -> Size
3797
3798 Get the DC size in milimeters.
3799 """
3800 return _gdi_.DC_GetSizeMM(*args, **kwargs)
3801
3802 def GetSizeMMTuple(*args, **kwargs):
3803 """
3804 GetSizeMMTuple() -> (width, height)
3805
3806 Get the DC size in milimeters.
3807 """
3808 return _gdi_.DC_GetSizeMMTuple(*args, **kwargs)
3809
3810 def DeviceToLogicalX(*args, **kwargs):
3811 """
3812 DeviceToLogicalX(self, int x) -> int
3813
3814 Convert device X coordinate to logical coordinate, using the current
3815 mapping mode.
3816 """
3817 return _gdi_.DC_DeviceToLogicalX(*args, **kwargs)
3818
3819 def DeviceToLogicalY(*args, **kwargs):
3820 """
3821 DeviceToLogicalY(self, int y) -> int
3822
3823 Converts device Y coordinate to logical coordinate, using the current
3824 mapping mode.
3825 """
3826 return _gdi_.DC_DeviceToLogicalY(*args, **kwargs)
3827
3828 def DeviceToLogicalXRel(*args, **kwargs):
3829 """
3830 DeviceToLogicalXRel(self, int x) -> int
3831
3832 Convert device X coordinate to relative logical coordinate, using the
3833 current mapping mode but ignoring the x axis orientation. Use this
3834 function for converting a width, for example.
3835 """
3836 return _gdi_.DC_DeviceToLogicalXRel(*args, **kwargs)
3837
3838 def DeviceToLogicalYRel(*args, **kwargs):
3839 """
3840 DeviceToLogicalYRel(self, int y) -> int
3841
3842 Convert device Y coordinate to relative logical coordinate, using the
3843 current mapping mode but ignoring the y axis orientation. Use this
3844 function for converting a height, for example.
3845 """
3846 return _gdi_.DC_DeviceToLogicalYRel(*args, **kwargs)
3847
3848 def LogicalToDeviceX(*args, **kwargs):
3849 """
3850 LogicalToDeviceX(self, int x) -> int
3851
3852 Converts logical X coordinate to device coordinate, using the current
3853 mapping mode.
3854 """
3855 return _gdi_.DC_LogicalToDeviceX(*args, **kwargs)
3856
3857 def LogicalToDeviceY(*args, **kwargs):
3858 """
3859 LogicalToDeviceY(self, int y) -> int
3860
3861 Converts logical Y coordinate to device coordinate, using the current
3862 mapping mode.
3863 """
3864 return _gdi_.DC_LogicalToDeviceY(*args, **kwargs)
3865
3866 def LogicalToDeviceXRel(*args, **kwargs):
3867 """
3868 LogicalToDeviceXRel(self, int x) -> int
3869
3870 Converts logical X coordinate to relative device coordinate, using the
3871 current mapping mode but ignoring the x axis orientation. Use this for
3872 converting a width, for example.
3873 """
3874 return _gdi_.DC_LogicalToDeviceXRel(*args, **kwargs)
3875
3876 def LogicalToDeviceYRel(*args, **kwargs):
3877 """
3878 LogicalToDeviceYRel(self, int y) -> int
3879
3880 Converts logical Y coordinate to relative device coordinate, using the
3881 current mapping mode but ignoring the y axis orientation. Use this for
3882 converting a height, for example.
3883 """
3884 return _gdi_.DC_LogicalToDeviceYRel(*args, **kwargs)
3885
3886 def CanDrawBitmap(*args, **kwargs):
3887 """CanDrawBitmap(self) -> bool"""
3888 return _gdi_.DC_CanDrawBitmap(*args, **kwargs)
3889
3890 def CanGetTextExtent(*args, **kwargs):
3891 """CanGetTextExtent(self) -> bool"""
3892 return _gdi_.DC_CanGetTextExtent(*args, **kwargs)
3893
3894 def GetDepth(*args, **kwargs):
3895 """
3896 GetDepth(self) -> int
3897
3898 Returns the colour depth of the DC.
3899 """
3900 return _gdi_.DC_GetDepth(*args, **kwargs)
3901
3902 def GetPPI(*args, **kwargs):
3903 """
3904 GetPPI(self) -> Size
3905
3906 Resolution in pixels per inch
3907 """
3908 return _gdi_.DC_GetPPI(*args, **kwargs)
3909
3910 def Ok(*args, **kwargs):
3911 """
3912 Ok(self) -> bool
3913
3914 Returns true if the DC is ok to use.
3915 """
3916 return _gdi_.DC_Ok(*args, **kwargs)
3917
3918 def GetBackgroundMode(*args, **kwargs):
3919 """
3920 GetBackgroundMode(self) -> int
3921
3922 Returns the current background mode, either ``wx.SOLID`` or
3923 ``wx.TRANSPARENT``.
3924 """
3925 return _gdi_.DC_GetBackgroundMode(*args, **kwargs)
3926
3927 def GetBackground(*args, **kwargs):
3928 """
3929 GetBackground(self) -> Brush
3930
3931 Gets the brush used for painting the background.
3932 """
3933 return _gdi_.DC_GetBackground(*args, **kwargs)
3934
3935 def GetBrush(*args, **kwargs):
3936 """
3937 GetBrush(self) -> Brush
3938
3939 Gets the current brush
3940 """
3941 return _gdi_.DC_GetBrush(*args, **kwargs)
3942
3943 def GetFont(*args, **kwargs):
3944 """
3945 GetFont(self) -> Font
3946
3947 Gets the current font
3948 """
3949 return _gdi_.DC_GetFont(*args, **kwargs)
3950
3951 def GetPen(*args, **kwargs):
3952 """
3953 GetPen(self) -> Pen
3954
3955 Gets the current pen
3956 """
3957 return _gdi_.DC_GetPen(*args, **kwargs)
3958
3959 def GetTextBackground(*args, **kwargs):
3960 """
3961 GetTextBackground(self) -> Colour
3962
3963 Gets the current text background colour
3964 """
3965 return _gdi_.DC_GetTextBackground(*args, **kwargs)
3966
3967 def GetTextForeground(*args, **kwargs):
3968 """
3969 GetTextForeground(self) -> Colour
3970
3971 Gets the current text foreground colour
3972 """
3973 return _gdi_.DC_GetTextForeground(*args, **kwargs)
3974
3975 def SetTextForeground(*args, **kwargs):
3976 """
3977 SetTextForeground(self, Colour colour)
3978
3979 Sets the current text foreground colour for the DC.
3980 """
3981 return _gdi_.DC_SetTextForeground(*args, **kwargs)
3982
3983 def SetTextBackground(*args, **kwargs):
3984 """
3985 SetTextBackground(self, Colour colour)
3986
3987 Sets the current text background colour for the DC.
3988 """
3989 return _gdi_.DC_SetTextBackground(*args, **kwargs)
3990
3991 def GetMapMode(*args, **kwargs):
3992 """
3993 GetMapMode(self) -> int
3994
3995 Gets the current *mapping mode* for the device context
3996 """
3997 return _gdi_.DC_GetMapMode(*args, **kwargs)
3998
3999 def SetMapMode(*args, **kwargs):
4000 """
4001 SetMapMode(self, int mode)
4002
4003 The *mapping mode* of the device context defines the unit of
4004 measurement used to convert logical units to device units. The
4005 mapping mode can be one of the following:
4006
4007 ================ =============================================
4008 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
4009 of an inch.
4010 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
4011 wx.MM_METRIC Each logical unit is 1 mm.
4012 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
4013 wx.MM_TEXT Each logical unit is 1 pixel.
4014 ================ =============================================
4015
4016 """
4017 return _gdi_.DC_SetMapMode(*args, **kwargs)
4018
4019 def GetUserScale(*args, **kwargs):
4020 """
4021 GetUserScale(self) -> (xScale, yScale)
4022
4023 Gets the current user scale factor (set by `SetUserScale`).
4024 """
4025 return _gdi_.DC_GetUserScale(*args, **kwargs)
4026
4027 def SetUserScale(*args, **kwargs):
4028 """
4029 SetUserScale(self, double x, double y)
4030
4031 Sets the user scaling factor, useful for applications which require
4032 'zooming'.
4033 """
4034 return _gdi_.DC_SetUserScale(*args, **kwargs)
4035
4036 def GetLogicalScale(*args, **kwargs):
4037 """GetLogicalScale() -> (xScale, yScale)"""
4038 return _gdi_.DC_GetLogicalScale(*args, **kwargs)
4039
4040 def SetLogicalScale(*args, **kwargs):
4041 """SetLogicalScale(self, double x, double y)"""
4042 return _gdi_.DC_SetLogicalScale(*args, **kwargs)
4043
4044 def GetLogicalOrigin(*args, **kwargs):
4045 """GetLogicalOrigin(self) -> Point"""
4046 return _gdi_.DC_GetLogicalOrigin(*args, **kwargs)
4047
4048 def GetLogicalOriginTuple(*args, **kwargs):
4049 """GetLogicalOriginTuple() -> (x,y)"""
4050 return _gdi_.DC_GetLogicalOriginTuple(*args, **kwargs)
4051
4052 def SetLogicalOrigin(*args, **kwargs):
4053 """SetLogicalOrigin(self, int x, int y)"""
4054 return _gdi_.DC_SetLogicalOrigin(*args, **kwargs)
4055
4056 def SetLogicalOriginPoint(*args, **kwargs):
4057 """SetLogicalOriginPoint(self, Point point)"""
4058 return _gdi_.DC_SetLogicalOriginPoint(*args, **kwargs)
4059
4060 def GetDeviceOrigin(*args, **kwargs):
4061 """GetDeviceOrigin(self) -> Point"""
4062 return _gdi_.DC_GetDeviceOrigin(*args, **kwargs)
4063
4064 def GetDeviceOriginTuple(*args, **kwargs):
4065 """GetDeviceOriginTuple() -> (x,y)"""
4066 return _gdi_.DC_GetDeviceOriginTuple(*args, **kwargs)
4067
4068 def SetDeviceOrigin(*args, **kwargs):
4069 """SetDeviceOrigin(self, int x, int y)"""
4070 return _gdi_.DC_SetDeviceOrigin(*args, **kwargs)
4071
4072 def SetDeviceOriginPoint(*args, **kwargs):
4073 """SetDeviceOriginPoint(self, Point point)"""
4074 return _gdi_.DC_SetDeviceOriginPoint(*args, **kwargs)
4075
4076 def SetAxisOrientation(*args, **kwargs):
4077 """
4078 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
4079
4080 Sets the x and y axis orientation (i.e., the direction from lowest to
4081 highest values on the axis). The default orientation is the natural
4082 orientation, e.g. x axis from left to right and y axis from bottom up.
4083 """
4084 return _gdi_.DC_SetAxisOrientation(*args, **kwargs)
4085
4086 def GetLogicalFunction(*args, **kwargs):
4087 """
4088 GetLogicalFunction(self) -> int
4089
4090 Gets the current logical function (set by `SetLogicalFunction`).
4091 """
4092 return _gdi_.DC_GetLogicalFunction(*args, **kwargs)
4093
4094 def SetLogicalFunction(*args, **kwargs):
4095 """
4096 SetLogicalFunction(self, int function)
4097
4098 Sets the current logical function for the device context. This
4099 determines how a source pixel (from a pen or brush colour, or source
4100 device context if using `Blit`) combines with a destination pixel in
4101 the current device context.
4102
4103 The possible values and their meaning in terms of source and
4104 destination pixel values are as follows:
4105
4106 ================ ==========================
4107 wx.AND src AND dst
4108 wx.AND_INVERT (NOT src) AND dst
4109 wx.AND_REVERSE src AND (NOT dst)
4110 wx.CLEAR 0
4111 wx.COPY src
4112 wx.EQUIV (NOT src) XOR dst
4113 wx.INVERT NOT dst
4114 wx.NAND (NOT src) OR (NOT dst)
4115 wx.NOR (NOT src) AND (NOT dst)
4116 wx.NO_OP dst
4117 wx.OR src OR dst
4118 wx.OR_INVERT (NOT src) OR dst
4119 wx.OR_REVERSE src OR (NOT dst)
4120 wx.SET 1
4121 wx.SRC_INVERT NOT src
4122 wx.XOR src XOR dst
4123 ================ ==========================
4124
4125 The default is wx.COPY, which simply draws with the current
4126 colour. The others combine the current colour and the background using
4127 a logical operation. wx.INVERT is commonly used for drawing rubber
4128 bands or moving outlines, since drawing twice reverts to the original
4129 colour.
4130
4131 """
4132 return _gdi_.DC_SetLogicalFunction(*args, **kwargs)
4133
4134 def ComputeScaleAndOrigin(*args, **kwargs):
4135 """
4136 ComputeScaleAndOrigin(self)
4137
4138 Performs all necessary computations for given platform and context
4139 type after each change of scale and origin parameters. Usually called
4140 automatically internally after such changes.
4141
4142 """
4143 return _gdi_.DC_ComputeScaleAndOrigin(*args, **kwargs)
4144
4145 def SetOptimization(self, optimize):
4146 pass
4147 def GetOptimization(self):
4148 return False
4149
4150 SetOptimization = wx._deprecated(SetOptimization)
4151 GetOptimization = wx._deprecated(GetOptimization)
4152
4153 def CalcBoundingBox(*args, **kwargs):
4154 """
4155 CalcBoundingBox(self, int x, int y)
4156
4157 Adds the specified point to the bounding box which can be retrieved
4158 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4159 """
4160 return _gdi_.DC_CalcBoundingBox(*args, **kwargs)
4161
4162 def CalcBoundingBoxPoint(*args, **kwargs):
4163 """
4164 CalcBoundingBoxPoint(self, Point point)
4165
4166 Adds the specified point to the bounding box which can be retrieved
4167 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4168 """
4169 return _gdi_.DC_CalcBoundingBoxPoint(*args, **kwargs)
4170
4171 def ResetBoundingBox(*args, **kwargs):
4172 """
4173 ResetBoundingBox(self)
4174
4175 Resets the bounding box: after a call to this function, the bounding
4176 box doesn't contain anything.
4177 """
4178 return _gdi_.DC_ResetBoundingBox(*args, **kwargs)
4179
4180 def MinX(*args, **kwargs):
4181 """
4182 MinX(self) -> int
4183
4184 Gets the minimum horizontal extent used in drawing commands so far.
4185 """
4186 return _gdi_.DC_MinX(*args, **kwargs)
4187
4188 def MaxX(*args, **kwargs):
4189 """
4190 MaxX(self) -> int
4191
4192 Gets the maximum horizontal extent used in drawing commands so far.
4193 """
4194 return _gdi_.DC_MaxX(*args, **kwargs)
4195
4196 def MinY(*args, **kwargs):
4197 """
4198 MinY(self) -> int
4199
4200 Gets the minimum vertical extent used in drawing commands so far.
4201 """
4202 return _gdi_.DC_MinY(*args, **kwargs)
4203
4204 def MaxY(*args, **kwargs):
4205 """
4206 MaxY(self) -> int
4207
4208 Gets the maximum vertical extent used in drawing commands so far.
4209 """
4210 return _gdi_.DC_MaxY(*args, **kwargs)
4211
4212 def GetBoundingBox(*args, **kwargs):
4213 """
4214 GetBoundingBox() -> (x1,y1, x2,y2)
4215
4216 Returns the min and max points used in drawing commands so far.
4217 """
4218 return _gdi_.DC_GetBoundingBox(*args, **kwargs)
4219
4220 def __nonzero__(self): return self.Ok()
4221 def GetHDC(*args, **kwargs):
4222 """GetHDC(self) -> long"""
4223 return _gdi_.DC_GetHDC(*args, **kwargs)
4224
4225 def _DrawPointList(*args, **kwargs):
4226 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4227 return _gdi_.DC__DrawPointList(*args, **kwargs)
4228
4229 def _DrawLineList(*args, **kwargs):
4230 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4231 return _gdi_.DC__DrawLineList(*args, **kwargs)
4232
4233 def _DrawRectangleList(*args, **kwargs):
4234 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4235 return _gdi_.DC__DrawRectangleList(*args, **kwargs)
4236
4237 def _DrawEllipseList(*args, **kwargs):
4238 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4239 return _gdi_.DC__DrawEllipseList(*args, **kwargs)
4240
4241 def _DrawPolygonList(*args, **kwargs):
4242 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4243 return _gdi_.DC__DrawPolygonList(*args, **kwargs)
4244
4245 def _DrawTextList(*args, **kwargs):
4246 """
4247 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
4248 PyObject backgroundList) -> PyObject
4249 """
4250 return _gdi_.DC__DrawTextList(*args, **kwargs)
4251
4252 def DrawPointList(self, points, pens=None):
4253 """
4254 Draw a list of points as quickly as possible.
4255
4256 :param points: A sequence of 2-element sequences representing
4257 each point to draw, (x,y).
4258 :param pens: If None, then the current pen is used. If a
4259 single pen then it will be used for all points. If
4260 a list of pens then there should be one for each point
4261 in points.
4262 """
4263 if pens is None:
4264 pens = []
4265 elif isinstance(pens, wx.Pen):
4266 pens = [pens]
4267 elif len(pens) != len(points):
4268 raise ValueError('points and pens must have same length')
4269 return self._DrawPointList(points, pens, [])
4270
4271
4272 def DrawLineList(self, lines, pens=None):
4273 """
4274 Draw a list of lines as quickly as possible.
4275
4276 :param lines: A sequence of 4-element sequences representing
4277 each line to draw, (x1,y1, x2,y2).
4278 :param pens: If None, then the current pen is used. If a
4279 single pen then it will be used for all lines. If
4280 a list of pens then there should be one for each line
4281 in lines.
4282 """
4283 if pens is None:
4284 pens = []
4285 elif isinstance(pens, wx.Pen):
4286 pens = [pens]
4287 elif len(pens) != len(lines):
4288 raise ValueError('lines and pens must have same length')
4289 return self._DrawLineList(lines, pens, [])
4290
4291
4292 def DrawRectangleList(self, rectangles, pens=None, brushes=None):
4293 """
4294 Draw a list of rectangles as quickly as possible.
4295
4296 :param rectangles: A sequence of 4-element sequences representing
4297 each rectangle to draw, (x,y, w,h).
4298 :param pens: If None, then the current pen is used. If a
4299 single pen then it will be used for all rectangles.
4300 If a list of pens then there should be one for each
4301 rectangle in rectangles.
4302 :param brushes: A brush or brushes to be used to fill the rectagles,
4303 with similar semantics as the pens parameter.
4304 """
4305 if pens is None:
4306 pens = []
4307 elif isinstance(pens, wx.Pen):
4308 pens = [pens]
4309 elif len(pens) != len(rectangles):
4310 raise ValueError('rectangles and pens must have same length')
4311 if brushes is None:
4312 brushes = []
4313 elif isinstance(brushes, wx.Brush):
4314 brushes = [brushes]
4315 elif len(brushes) != len(rectangles):
4316 raise ValueError('rectangles and brushes must have same length')
4317 return self._DrawRectangleList(rectangles, pens, brushes)
4318
4319
4320 def DrawEllipseList(self, ellipses, pens=None, brushes=None):
4321 """
4322 Draw a list of ellipses as quickly as possible.
4323
4324 :param ellipses: A sequence of 4-element sequences representing
4325 each ellipse to draw, (x,y, w,h).
4326 :param pens: If None, then the current pen is used. If a
4327 single pen then it will be used for all ellipses.
4328 If a list of pens then there should be one for each
4329 ellipse in ellipses.
4330 :param brushes: A brush or brushes to be used to fill the ellipses,
4331 with similar semantics as the pens parameter.
4332 """
4333 if pens is None:
4334 pens = []
4335 elif isinstance(pens, wx.Pen):
4336 pens = [pens]
4337 elif len(pens) != len(ellipses):
4338 raise ValueError('ellipses and pens must have same length')
4339 if brushes is None:
4340 brushes = []
4341 elif isinstance(brushes, wx.Brush):
4342 brushes = [brushes]
4343 elif len(brushes) != len(ellipses):
4344 raise ValueError('ellipses and brushes must have same length')
4345 return self._DrawEllipseList(ellipses, pens, brushes)
4346
4347
4348 def DrawPolygonList(self, polygons, pens=None, brushes=None):
4349 """
4350 Draw a list of polygons, each of which is a list of points.
4351
4352 :param polygons: A sequence of sequences of sequences.
4353 [[(x1,y1),(x2,y2),(x3,y3)...],
4354 [(x1,y1),(x2,y2),(x3,y3)...]]
4355
4356 :param pens: If None, then the current pen is used. If a
4357 single pen then it will be used for all polygons.
4358 If a list of pens then there should be one for each
4359 polygon.
4360 :param brushes: A brush or brushes to be used to fill the polygons,
4361 with similar semantics as the pens parameter.
4362 """
4363 if pens is None:
4364 pens = []
4365 elif isinstance(pens, wx.Pen):
4366 pens = [pens]
4367 elif len(pens) != len(polygons):
4368 raise ValueError('polygons and pens must have same length')
4369 if brushes is None:
4370 brushes = []
4371 elif isinstance(brushes, wx.Brush):
4372 brushes = [brushes]
4373 elif len(brushes) != len(polygons):
4374 raise ValueError('polygons and brushes must have same length')
4375 return self._DrawPolygonList(polygons, pens, brushes)
4376
4377
4378 def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None):
4379 """
4380 Draw a list of strings using a list of coordinants for positioning each string.
4381
4382 :param textList: A list of strings
4383 :param coords: A list of (x,y) positions
4384 :param foregrounds: A list of `wx.Colour` objects to use for the
4385 foregrounds of the strings.
4386 :param backgrounds: A list of `wx.Colour` objects to use for the
4387 backgrounds of the strings.
4388
4389 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4390 If you want backgrounds to do anything.
4391 """
4392 if type(textList) == type(''):
4393 textList = [textList]
4394 elif len(textList) != len(coords):
4395 raise ValueError('textlist and coords must have same length')
4396 if foregrounds is None:
4397 foregrounds = []
4398 elif isinstance(foregrounds, wx.Colour):
4399 foregrounds = [foregrounds]
4400 elif len(foregrounds) != len(coords):
4401 raise ValueError('foregrounds and coords must have same length')
4402 if backgrounds is None:
4403 backgrounds = []
4404 elif isinstance(backgrounds, wx.Colour):
4405 backgrounds = [backgrounds]
4406 elif len(backgrounds) != len(coords):
4407 raise ValueError('backgrounds and coords must have same length')
4408 return self._DrawTextList(textList, coords, foregrounds, backgrounds)
4409
4410 Background = property(GetBackground,SetBackground,doc="See `GetBackground` and `SetBackground`")
4411 BackgroundMode = property(GetBackgroundMode,SetBackgroundMode,doc="See `GetBackgroundMode` and `SetBackgroundMode`")
4412 BoundingBox = property(GetBoundingBox,doc="See `GetBoundingBox`")
4413 Brush = property(GetBrush,SetBrush,doc="See `GetBrush` and `SetBrush`")
4414 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
4415 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
4416 ClippingBox = property(GetClippingBox,doc="See `GetClippingBox`")
4417 ClippingRect = property(GetClippingRect,SetClippingRect,doc="See `GetClippingRect` and `SetClippingRect`")
4418 Depth = property(GetDepth,doc="See `GetDepth`")
4419 DeviceOrigin = property(GetDeviceOrigin,SetDeviceOrigin,doc="See `GetDeviceOrigin` and `SetDeviceOrigin`")
4420 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
4421 FullTextExtent = property(GetFullTextExtent,doc="See `GetFullTextExtent`")
4422 LogicalFunction = property(GetLogicalFunction,SetLogicalFunction,doc="See `GetLogicalFunction` and `SetLogicalFunction`")
4423 LogicalOrigin = property(GetLogicalOrigin,SetLogicalOrigin,doc="See `GetLogicalOrigin` and `SetLogicalOrigin`")
4424 LogicalScale = property(GetLogicalScale,SetLogicalScale,doc="See `GetLogicalScale` and `SetLogicalScale`")
4425 MapMode = property(GetMapMode,SetMapMode,doc="See `GetMapMode` and `SetMapMode`")
4426 MultiLineTextExtent = property(GetMultiLineTextExtent,doc="See `GetMultiLineTextExtent`")
4427 Optimization = property(GetOptimization,SetOptimization,doc="See `GetOptimization` and `SetOptimization`")
4428 PPI = property(GetPPI,doc="See `GetPPI`")
4429 PartialTextExtents = property(GetPartialTextExtents,doc="See `GetPartialTextExtents`")
4430 Pen = property(GetPen,SetPen,doc="See `GetPen` and `SetPen`")
4431 Pixel = property(GetPixel,doc="See `GetPixel`")
4432 PixelPoint = property(GetPixelPoint,doc="See `GetPixelPoint`")
4433 Size = property(GetSize,doc="See `GetSize`")
4434 SizeMM = property(GetSizeMM,doc="See `GetSizeMM`")
4435 TextBackground = property(GetTextBackground,SetTextBackground,doc="See `GetTextBackground` and `SetTextBackground`")
4436 TextExtent = property(GetTextExtent,doc="See `GetTextExtent`")
4437 TextForeground = property(GetTextForeground,SetTextForeground,doc="See `GetTextForeground` and `SetTextForeground`")
4438 UserScale = property(GetUserScale,SetUserScale,doc="See `GetUserScale` and `SetUserScale`")
4439 _gdi_.DC_swigregister(DC)
4440
4441 #---------------------------------------------------------------------------
4442
4443 class MemoryDC(DC):
4444 """
4445 A memory device context provides a means to draw graphics onto a
4446 bitmap. A bitmap must be selected into the new memory DC before it may
4447 be used for anything. Typical usage is as follows::
4448
4449 dc = wx.MemoryDC()
4450 dc.SelectObject(bitmap)
4451 # draw on the dc usign any of the Draw methods
4452 dc.SelectObject(wx.NullBitmap)
4453 # the bitmap now contains wahtever was drawn upon it
4454
4455 Note that the memory DC *must* be deleted (or the bitmap selected out
4456 of it) before a bitmap can be reselected into another memory DC.
4457
4458 """
4459 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4460 __repr__ = _swig_repr
4461 def __init__(self, *args, **kwargs):
4462 """
4463 __init__(self) -> MemoryDC
4464
4465 Constructs a new memory device context.
4466
4467 Use the Ok member to test whether the constructor was successful in
4468 creating a usable device context. Don't forget to select a bitmap into
4469 the DC before drawing on it.
4470 """
4471 _gdi_.MemoryDC_swiginit(self,_gdi_.new_MemoryDC(*args, **kwargs))
4472 def SelectObject(*args, **kwargs):
4473 """
4474 SelectObject(self, Bitmap bitmap)
4475
4476 Selects the bitmap into the device context, to use as the memory
4477 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4478 the DC, and therefore the bitmap, and also to use Blit to copy the
4479 bitmap to a window.
4480
4481 If the argument is wx.NullBitmap (or some other uninitialised
4482 `wx.Bitmap`) the current bitmap is selected out of the device context,
4483 and the original bitmap restored, allowing the current bitmap to be
4484 destroyed safely.
4485 """
4486 return _gdi_.MemoryDC_SelectObject(*args, **kwargs)
4487
4488 _gdi_.MemoryDC_swigregister(MemoryDC)
4489
4490 def MemoryDCFromDC(*args, **kwargs):
4491 """
4492 MemoryDCFromDC(DC oldDC) -> MemoryDC
4493
4494 Creates a DC that is compatible with the oldDC.
4495 """
4496 val = _gdi_.new_MemoryDCFromDC(*args, **kwargs)
4497 return val
4498
4499 #---------------------------------------------------------------------------
4500
4501 BUFFER_VIRTUAL_AREA = _gdi_.BUFFER_VIRTUAL_AREA
4502 BUFFER_CLIENT_AREA = _gdi_.BUFFER_CLIENT_AREA
4503 class BufferedDC(MemoryDC):
4504 """
4505 This simple class provides a simple way to avoid flicker: when drawing
4506 on it, everything is in fact first drawn on an in-memory buffer (a
4507 `wx.Bitmap`) and then copied to the screen only once, when this object
4508 is destroyed.
4509
4510 It can be used in the same way as any other device
4511 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
4512 want to use it in your EVT_PAINT handler, you should look at
4513 `wx.BufferedPaintDC`.
4514
4515 """
4516 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4517 __repr__ = _swig_repr
4518 def __init__(self, *args):
4519 """
4520 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4521 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
4522
4523 Constructs a buffered DC.
4524 """
4525 _gdi_.BufferedDC_swiginit(self,_gdi_.new_BufferedDC(*args))
4526 self.__dc = args[0] # save a ref so the other dc will not be deleted before self
4527
4528 __swig_destroy__ = _gdi_.delete_BufferedDC
4529 __del__ = lambda self : None;
4530 def UnMask(*args, **kwargs):
4531 """
4532 UnMask(self)
4533
4534 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4535 can be effectively used once only). This is usually only called in
4536 the destructor.
4537 """
4538 return _gdi_.BufferedDC_UnMask(*args, **kwargs)
4539
4540 _gdi_.BufferedDC_swigregister(BufferedDC)
4541
4542 class BufferedPaintDC(BufferedDC):
4543 """
4544 This is a subclass of `wx.BufferedDC` which can be used inside of an
4545 EVT_PAINT event handler. Just create an object of this class instead
4546 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4547 flicker. The only thing to watch out for is that if you are using this
4548 class together with `wx.ScrolledWindow`, you probably do **not** want
4549 to call `wx.Window.PrepareDC` on it as it already does this internally
4550 for the real underlying `wx.PaintDC`.
4551
4552 If your window is already fully buffered in a `wx.Bitmap` then your
4553 EVT_PAINT handler can be as simple as just creating a
4554 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4555 automatically when it is destroyed. For example::
4556
4557 def OnPaint(self, event):
4558 dc = wx.BufferedPaintDC(self, self.buffer)
4559
4560
4561
4562
4563
4564 """
4565 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4566 __repr__ = _swig_repr
4567 def __init__(self, *args, **kwargs):
4568 """
4569 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
4570
4571 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4572 provide the bitmap to be used for buffering or let this object create
4573 one internally (in the latter case, the size of the client part of the
4574 window is automatically used).
4575
4576
4577 """
4578 _gdi_.BufferedPaintDC_swiginit(self,_gdi_.new_BufferedPaintDC(*args, **kwargs))
4579 _gdi_.BufferedPaintDC_swigregister(BufferedPaintDC)
4580
4581 #---------------------------------------------------------------------------
4582
4583 class ScreenDC(DC):
4584 """
4585 A wxScreenDC can be used to paint anywhere on the screen. This should
4586 normally be constructed as a temporary stack object; don't store a
4587 wxScreenDC object.
4588
4589 """
4590 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4591 __repr__ = _swig_repr
4592 def __init__(self, *args, **kwargs):
4593 """
4594 __init__(self) -> ScreenDC
4595
4596 A wxScreenDC can be used to paint anywhere on the screen. This should
4597 normally be constructed as a temporary stack object; don't store a
4598 wxScreenDC object.
4599
4600 """
4601 _gdi_.ScreenDC_swiginit(self,_gdi_.new_ScreenDC(*args, **kwargs))
4602 def StartDrawingOnTopWin(*args, **kwargs):
4603 """
4604 StartDrawingOnTopWin(self, Window window) -> bool
4605
4606 Specify that the area of the screen to be drawn upon coincides with
4607 the given window.
4608
4609 :see: `EndDrawingOnTop`
4610 """
4611 return _gdi_.ScreenDC_StartDrawingOnTopWin(*args, **kwargs)
4612
4613 def StartDrawingOnTop(*args, **kwargs):
4614 """
4615 StartDrawingOnTop(self, Rect rect=None) -> bool
4616
4617 Specify that the area is the given rectangle, or the whole screen if
4618 ``None`` is passed.
4619
4620 :see: `EndDrawingOnTop`
4621 """
4622 return _gdi_.ScreenDC_StartDrawingOnTop(*args, **kwargs)
4623
4624 def EndDrawingOnTop(*args, **kwargs):
4625 """
4626 EndDrawingOnTop(self) -> bool
4627
4628 Use this in conjunction with `StartDrawingOnTop` or
4629 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4630 top of existing windows. Without this, some window systems (such as X)
4631 only allow drawing to take place underneath other windows.
4632
4633 You might use this pair of functions when implementing a drag feature,
4634 for example as in the `wx.SplitterWindow` implementation.
4635
4636 These functions are probably obsolete since the X implementations
4637 allow drawing directly on the screen now. However, the fact that this
4638 function allows the screen to be refreshed afterwards may be useful
4639 to some applications.
4640 """
4641 return _gdi_.ScreenDC_EndDrawingOnTop(*args, **kwargs)
4642
4643 _gdi_.ScreenDC_swigregister(ScreenDC)
4644
4645 #---------------------------------------------------------------------------
4646
4647 class ClientDC(DC):
4648 """
4649 A wx.ClientDC must be constructed if an application wishes to paint on
4650 the client area of a window from outside an EVT_PAINT event. This should
4651 normally be constructed as a temporary stack object; don't store a
4652 wx.ClientDC object long term.
4653
4654 To draw on a window from within an EVT_PAINT handler, construct a
4655 `wx.PaintDC` object.
4656
4657 To draw on the whole window including decorations, construct a
4658 `wx.WindowDC` object (Windows only).
4659
4660 """
4661 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4662 __repr__ = _swig_repr
4663 def __init__(self, *args, **kwargs):
4664 """
4665 __init__(self, Window win) -> ClientDC
4666
4667 Constructor. Pass the window on which you wish to paint.
4668 """
4669 _gdi_.ClientDC_swiginit(self,_gdi_.new_ClientDC(*args, **kwargs))
4670 _gdi_.ClientDC_swigregister(ClientDC)
4671
4672 #---------------------------------------------------------------------------
4673
4674 class PaintDC(DC):
4675 """
4676 A wx.PaintDC must be constructed if an application wishes to paint on
4677 the client area of a window from within an EVT_PAINT event
4678 handler. This should normally be constructed as a temporary stack
4679 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4680 handler, you **must** create a wx.PaintDC object within it even if you
4681 don't actually use it.
4682
4683 Using wx.PaintDC within EVT_PAINT handlers is important because it
4684 automatically sets the clipping area to the damaged area of the
4685 window. Attempts to draw outside this area do not appear.
4686
4687 To draw on a window from outside EVT_PAINT handlers, construct a
4688 `wx.ClientDC` object.
4689
4690 """
4691 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4692 __repr__ = _swig_repr
4693 def __init__(self, *args, **kwargs):
4694 """
4695 __init__(self, Window win) -> PaintDC
4696
4697 Constructor. Pass the window on which you wish to paint.
4698 """
4699 _gdi_.PaintDC_swiginit(self,_gdi_.new_PaintDC(*args, **kwargs))
4700 _gdi_.PaintDC_swigregister(PaintDC)
4701
4702 #---------------------------------------------------------------------------
4703
4704 class WindowDC(DC):
4705 """
4706 A wx.WindowDC must be constructed if an application wishes to paint on
4707 the whole area of a window (client and decorations). This should
4708 normally be constructed as a temporary stack object; don't store a
4709 wx.WindowDC object.
4710 """
4711 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4712 __repr__ = _swig_repr
4713 def __init__(self, *args, **kwargs):
4714 """
4715 __init__(self, Window win) -> WindowDC
4716
4717 Constructor. Pass the window on which you wish to paint.
4718 """
4719 _gdi_.WindowDC_swiginit(self,_gdi_.new_WindowDC(*args, **kwargs))
4720 _gdi_.WindowDC_swigregister(WindowDC)
4721
4722 #---------------------------------------------------------------------------
4723
4724 class MirrorDC(DC):
4725 """
4726 wx.MirrorDC is a simple wrapper class which is always associated with a
4727 real `wx.DC` object and either forwards all of its operations to it
4728 without changes (no mirroring takes place) or exchanges x and y
4729 coordinates which makes it possible to reuse the same code to draw a
4730 figure and its mirror -- i.e. reflection related to the diagonal line
4731 x == y.
4732 """
4733 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4734 __repr__ = _swig_repr
4735 def __init__(self, *args, **kwargs):
4736 """
4737 __init__(self, DC dc, bool mirror) -> MirrorDC
4738
4739 Creates a mirrored DC associated with the real *dc*. Everything drawn
4740 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4741 *mirror* is True.
4742 """
4743 _gdi_.MirrorDC_swiginit(self,_gdi_.new_MirrorDC(*args, **kwargs))
4744 _gdi_.MirrorDC_swigregister(MirrorDC)
4745
4746 #---------------------------------------------------------------------------
4747
4748 class PostScriptDC(DC):
4749 """This is a `wx.DC` that can write to PostScript files on any platform."""
4750 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4751 __repr__ = _swig_repr
4752 def __init__(self, *args, **kwargs):
4753 """
4754 __init__(self, wxPrintData printData) -> PostScriptDC
4755
4756 Constructs a PostScript printer device context from a `wx.PrintData`
4757 object.
4758 """
4759 _gdi_.PostScriptDC_swiginit(self,_gdi_.new_PostScriptDC(*args, **kwargs))
4760 def GetPrintData(*args, **kwargs):
4761 """GetPrintData(self) -> wxPrintData"""
4762 return _gdi_.PostScriptDC_GetPrintData(*args, **kwargs)
4763
4764 def SetPrintData(*args, **kwargs):
4765 """SetPrintData(self, wxPrintData data)"""
4766 return _gdi_.PostScriptDC_SetPrintData(*args, **kwargs)
4767
4768 def SetResolution(*args, **kwargs):
4769 """
4770 SetResolution(int ppi)
4771
4772 Set resolution (in pixels per inch) that will be used in PostScript
4773 output. Default is 720ppi.
4774 """
4775 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
4776
4777 SetResolution = staticmethod(SetResolution)
4778 def GetResolution(*args, **kwargs):
4779 """
4780 GetResolution() -> int
4781
4782 Return resolution used in PostScript output.
4783 """
4784 return _gdi_.PostScriptDC_GetResolution(*args, **kwargs)
4785
4786 GetResolution = staticmethod(GetResolution)
4787 PrintData = property(GetPrintData,SetPrintData,doc="See `GetPrintData` and `SetPrintData`")
4788 _gdi_.PostScriptDC_swigregister(PostScriptDC)
4789
4790 def PostScriptDC_SetResolution(*args, **kwargs):
4791 """
4792 PostScriptDC_SetResolution(int ppi)
4793
4794 Set resolution (in pixels per inch) that will be used in PostScript
4795 output. Default is 720ppi.
4796 """
4797 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
4798
4799 def PostScriptDC_GetResolution(*args):
4800 """
4801 PostScriptDC_GetResolution() -> int
4802
4803 Return resolution used in PostScript output.
4804 """
4805 return _gdi_.PostScriptDC_GetResolution(*args)
4806
4807 #---------------------------------------------------------------------------
4808
4809 class MetaFile(_core.Object):
4810 """Proxy of C++ MetaFile class"""
4811 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4812 __repr__ = _swig_repr
4813 def __init__(self, *args, **kwargs):
4814 """__init__(self, String filename=EmptyString) -> MetaFile"""
4815 _gdi_.MetaFile_swiginit(self,_gdi_.new_MetaFile(*args, **kwargs))
4816 __swig_destroy__ = _gdi_.delete_MetaFile
4817 __del__ = lambda self : None;
4818 def Ok(*args, **kwargs):
4819 """Ok(self) -> bool"""
4820 return _gdi_.MetaFile_Ok(*args, **kwargs)
4821
4822 def SetClipboard(*args, **kwargs):
4823 """SetClipboard(self, int width=0, int height=0) -> bool"""
4824 return _gdi_.MetaFile_SetClipboard(*args, **kwargs)
4825
4826 def GetSize(*args, **kwargs):
4827 """GetSize(self) -> Size"""
4828 return _gdi_.MetaFile_GetSize(*args, **kwargs)
4829
4830 def GetWidth(*args, **kwargs):
4831 """GetWidth(self) -> int"""
4832 return _gdi_.MetaFile_GetWidth(*args, **kwargs)
4833
4834 def GetHeight(*args, **kwargs):
4835 """GetHeight(self) -> int"""
4836 return _gdi_.MetaFile_GetHeight(*args, **kwargs)
4837
4838 def GetFileName(*args, **kwargs):
4839 """GetFileName(self) -> String"""
4840 return _gdi_.MetaFile_GetFileName(*args, **kwargs)
4841
4842 def __nonzero__(self): return self.Ok()
4843 _gdi_.MetaFile_swigregister(MetaFile)
4844
4845 class MetaFileDC(DC):
4846 """Proxy of C++ MetaFileDC class"""
4847 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4848 __repr__ = _swig_repr
4849 def __init__(self, *args, **kwargs):
4850 """
4851 __init__(self, String filename=EmptyString, int width=0, int height=0,
4852 String description=EmptyString) -> MetaFileDC
4853 """
4854 _gdi_.MetaFileDC_swiginit(self,_gdi_.new_MetaFileDC(*args, **kwargs))
4855 def Close(*args, **kwargs):
4856 """Close(self) -> MetaFile"""
4857 return _gdi_.MetaFileDC_Close(*args, **kwargs)
4858
4859 _gdi_.MetaFileDC_swigregister(MetaFileDC)
4860
4861 class PrinterDC(DC):
4862 """Proxy of C++ PrinterDC class"""
4863 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4864 __repr__ = _swig_repr
4865 def __init__(self, *args, **kwargs):
4866 """__init__(self, wxPrintData printData) -> PrinterDC"""
4867 _gdi_.PrinterDC_swiginit(self,_gdi_.new_PrinterDC(*args, **kwargs))
4868 _gdi_.PrinterDC_swigregister(PrinterDC)
4869
4870 #---------------------------------------------------------------------------
4871
4872 IMAGELIST_DRAW_NORMAL = _gdi_.IMAGELIST_DRAW_NORMAL
4873 IMAGELIST_DRAW_TRANSPARENT = _gdi_.IMAGELIST_DRAW_TRANSPARENT
4874 IMAGELIST_DRAW_SELECTED = _gdi_.IMAGELIST_DRAW_SELECTED
4875 IMAGELIST_DRAW_FOCUSED = _gdi_.IMAGELIST_DRAW_FOCUSED
4876 IMAGE_LIST_NORMAL = _gdi_.IMAGE_LIST_NORMAL
4877 IMAGE_LIST_SMALL = _gdi_.IMAGE_LIST_SMALL
4878 IMAGE_LIST_STATE = _gdi_.IMAGE_LIST_STATE
4879 class ImageList(_core.Object):
4880 """Proxy of C++ ImageList class"""
4881 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4882 __repr__ = _swig_repr
4883 def __init__(self, *args, **kwargs):
4884 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
4885 _gdi_.ImageList_swiginit(self,_gdi_.new_ImageList(*args, **kwargs))
4886 __swig_destroy__ = _gdi_.delete_ImageList
4887 __del__ = lambda self : None;
4888 def Add(*args, **kwargs):
4889 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
4890 return _gdi_.ImageList_Add(*args, **kwargs)
4891
4892 def AddWithColourMask(*args, **kwargs):
4893 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
4894 return _gdi_.ImageList_AddWithColourMask(*args, **kwargs)
4895
4896 def AddIcon(*args, **kwargs):
4897 """AddIcon(self, Icon icon) -> int"""
4898 return _gdi_.ImageList_AddIcon(*args, **kwargs)
4899
4900 def GetBitmap(*args, **kwargs):
4901 """GetBitmap(self, int index) -> Bitmap"""
4902 return _gdi_.ImageList_GetBitmap(*args, **kwargs)
4903
4904 def GetIcon(*args, **kwargs):
4905 """GetIcon(self, int index) -> Icon"""
4906 return _gdi_.ImageList_GetIcon(*args, **kwargs)
4907
4908 def Replace(*args, **kwargs):
4909 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
4910 return _gdi_.ImageList_Replace(*args, **kwargs)
4911
4912 def Draw(*args, **kwargs):
4913 """
4914 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
4915 bool solidBackground=False) -> bool
4916 """
4917 return _gdi_.ImageList_Draw(*args, **kwargs)
4918
4919 def GetImageCount(*args, **kwargs):
4920 """GetImageCount(self) -> int"""
4921 return _gdi_.ImageList_GetImageCount(*args, **kwargs)
4922
4923 def Remove(*args, **kwargs):
4924 """Remove(self, int index) -> bool"""
4925 return _gdi_.ImageList_Remove(*args, **kwargs)
4926
4927 def RemoveAll(*args, **kwargs):
4928 """RemoveAll(self) -> bool"""
4929 return _gdi_.ImageList_RemoveAll(*args, **kwargs)
4930
4931 def GetSize(*args, **kwargs):
4932 """GetSize(index) -> (width,height)"""
4933 return _gdi_.ImageList_GetSize(*args, **kwargs)
4934
4935 ImageCount = property(GetImageCount,doc="See `GetImageCount`")
4936 Size = property(GetSize,doc="See `GetSize`")
4937 _gdi_.ImageList_swigregister(ImageList)
4938
4939 #---------------------------------------------------------------------------
4940
4941 class StockGDI(object):
4942 """Proxy of C++ StockGDI class"""
4943 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4944 __repr__ = _swig_repr
4945 BRUSH_BLACK = _gdi_.StockGDI_BRUSH_BLACK
4946 BRUSH_BLUE = _gdi_.StockGDI_BRUSH_BLUE
4947 BRUSH_CYAN = _gdi_.StockGDI_BRUSH_CYAN
4948 BRUSH_GREEN = _gdi_.StockGDI_BRUSH_GREEN
4949 BRUSH_GREY = _gdi_.StockGDI_BRUSH_GREY
4950 BRUSH_LIGHTGREY = _gdi_.StockGDI_BRUSH_LIGHTGREY
4951 BRUSH_MEDIUMGREY = _gdi_.StockGDI_BRUSH_MEDIUMGREY
4952 BRUSH_RED = _gdi_.StockGDI_BRUSH_RED
4953 BRUSH_TRANSPARENT = _gdi_.StockGDI_BRUSH_TRANSPARENT
4954 BRUSH_WHITE = _gdi_.StockGDI_BRUSH_WHITE
4955 COLOUR_BLACK = _gdi_.StockGDI_COLOUR_BLACK
4956 COLOUR_BLUE = _gdi_.StockGDI_COLOUR_BLUE
4957 COLOUR_CYAN = _gdi_.StockGDI_COLOUR_CYAN
4958 COLOUR_GREEN = _gdi_.StockGDI_COLOUR_GREEN
4959 COLOUR_LIGHTGREY = _gdi_.StockGDI_COLOUR_LIGHTGREY
4960 COLOUR_RED = _gdi_.StockGDI_COLOUR_RED
4961 COLOUR_WHITE = _gdi_.StockGDI_COLOUR_WHITE
4962 CURSOR_CROSS = _gdi_.StockGDI_CURSOR_CROSS
4963 CURSOR_HOURGLASS = _gdi_.StockGDI_CURSOR_HOURGLASS
4964 CURSOR_STANDARD = _gdi_.StockGDI_CURSOR_STANDARD
4965 FONT_ITALIC = _gdi_.StockGDI_FONT_ITALIC
4966 FONT_NORMAL = _gdi_.StockGDI_FONT_NORMAL
4967 FONT_SMALL = _gdi_.StockGDI_FONT_SMALL
4968 FONT_SWISS = _gdi_.StockGDI_FONT_SWISS
4969 PEN_BLACK = _gdi_.StockGDI_PEN_BLACK
4970 PEN_BLACKDASHED = _gdi_.StockGDI_PEN_BLACKDASHED
4971 PEN_CYAN = _gdi_.StockGDI_PEN_CYAN
4972 PEN_GREEN = _gdi_.StockGDI_PEN_GREEN
4973 PEN_GREY = _gdi_.StockGDI_PEN_GREY
4974 PEN_LIGHTGREY = _gdi_.StockGDI_PEN_LIGHTGREY
4975 PEN_MEDIUMGREY = _gdi_.StockGDI_PEN_MEDIUMGREY
4976 PEN_RED = _gdi_.StockGDI_PEN_RED
4977 PEN_TRANSPARENT = _gdi_.StockGDI_PEN_TRANSPARENT
4978 PEN_WHITE = _gdi_.StockGDI_PEN_WHITE
4979 ITEMCOUNT = _gdi_.StockGDI_ITEMCOUNT
4980 def __init__(self, *args, **kwargs):
4981 """__init__(self) -> StockGDI"""
4982 _gdi_.StockGDI_swiginit(self,_gdi_.new_StockGDI(*args, **kwargs))
4983 __swig_destroy__ = _gdi_.delete_StockGDI
4984 __del__ = lambda self : None;
4985 def DeleteAll(*args, **kwargs):
4986 """DeleteAll()"""
4987 return _gdi_.StockGDI_DeleteAll(*args, **kwargs)
4988
4989 DeleteAll = staticmethod(DeleteAll)
4990 def instance(*args, **kwargs):
4991 """instance() -> StockGDI"""
4992 return _gdi_.StockGDI_instance(*args, **kwargs)
4993
4994 instance = staticmethod(instance)
4995 def GetBrush(*args, **kwargs):
4996 """GetBrush(int item) -> Brush"""
4997 return _gdi_.StockGDI_GetBrush(*args, **kwargs)
4998
4999 GetBrush = staticmethod(GetBrush)
5000 def GetColour(*args, **kwargs):
5001 """GetColour(int item) -> Colour"""
5002 return _gdi_.StockGDI_GetColour(*args, **kwargs)
5003
5004 GetColour = staticmethod(GetColour)
5005 def GetCursor(*args, **kwargs):
5006 """GetCursor(int item) -> Cursor"""
5007 return _gdi_.StockGDI_GetCursor(*args, **kwargs)
5008
5009 GetCursor = staticmethod(GetCursor)
5010 def GetPen(*args, **kwargs):
5011 """GetPen(int item) -> Pen"""
5012 return _gdi_.StockGDI_GetPen(*args, **kwargs)
5013
5014 GetPen = staticmethod(GetPen)
5015 def GetFont(*args, **kwargs):
5016 """GetFont(self, int item) -> Font"""
5017 return _gdi_.StockGDI_GetFont(*args, **kwargs)
5018
5019 def _initStockObjects():
5020 import wx
5021 wx.ITALIC_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_ITALIC).this
5022 wx.NORMAL_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_NORMAL).this
5023 wx.SMALL_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_SMALL).this
5024 wx.SWISS_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_SWISS).this
5025
5026 wx.BLACK_DASHED_PEN.this = StockGDI.GetPen(StockGDI.PEN_BLACKDASHED).this
5027 wx.BLACK_PEN.this = StockGDI.GetPen(StockGDI.PEN_BLACK).this
5028 wx.CYAN_PEN.this = StockGDI.GetPen(StockGDI.PEN_CYAN).this
5029 wx.GREEN_PEN.this = StockGDI.GetPen(StockGDI.PEN_GREEN).this
5030 wx.GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_GREY).this
5031 wx.LIGHT_GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_LIGHTGREY).this
5032 wx.MEDIUM_GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_MEDIUMGREY).this
5033 wx.RED_PEN.this = StockGDI.GetPen(StockGDI.PEN_RED).this
5034 wx.TRANSPARENT_PEN.this = StockGDI.GetPen(StockGDI.PEN_TRANSPARENT).this
5035 wx.WHITE_PEN.this = StockGDI.GetPen(StockGDI.PEN_WHITE).this
5036
5037 wx.BLACK_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_BLACK).this
5038 wx.BLUE_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_BLUE).this
5039 wx.CYAN_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_CYAN).this
5040 wx.GREEN_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_GREEN).this
5041 wx.GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_GREY).this
5042 wx.LIGHT_GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_LIGHTGREY).this
5043 wx.MEDIUM_GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_MEDIUMGREY).this
5044 wx.RED_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_RED).this
5045 wx.TRANSPARENT_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_TRANSPARENT).this
5046 wx.WHITE_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_WHITE).this
5047
5048 wx.BLACK.this = StockGDI.GetColour(StockGDI.COLOUR_BLACK).this
5049 wx.BLUE.this = StockGDI.GetColour(StockGDI.COLOUR_BLUE).this
5050 wx.CYAN.this = StockGDI.GetColour(StockGDI.COLOUR_CYAN).this
5051 wx.GREEN.this = StockGDI.GetColour(StockGDI.COLOUR_GREEN).this
5052 wx.LIGHT_GREY.this = StockGDI.GetColour(StockGDI.COLOUR_LIGHTGREY).this
5053 wx.RED.this = StockGDI.GetColour(StockGDI.COLOUR_RED).this
5054 wx.WHITE.this = StockGDI.GetColour(StockGDI.COLOUR_WHITE).this
5055
5056 wx.CROSS_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_CROSS).this
5057 wx.HOURGLASS_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_HOURGLASS).this
5058 wx.STANDARD_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_STANDARD).this
5059
5060 wx.TheFontList.this = _wxPyInitTheFontList().this
5061 wx.ThePenList.this = _wxPyInitThePenList().this
5062 wx.TheBrushList.this = _wxPyInitTheBrushList().this
5063 wx.TheColourDatabase.this = _wxPyInitTheColourDatabase().this
5064
5065
5066 _initStockObjects = staticmethod(_initStockObjects)
5067
5068 _gdi_.StockGDI_swigregister(StockGDI)
5069
5070 def StockGDI_DeleteAll(*args):
5071 """StockGDI_DeleteAll()"""
5072 return _gdi_.StockGDI_DeleteAll(*args)
5073
5074 def StockGDI_instance(*args):
5075 """StockGDI_instance() -> StockGDI"""
5076 return _gdi_.StockGDI_instance(*args)
5077
5078 def StockGDI_GetBrush(*args, **kwargs):
5079 """StockGDI_GetBrush(int item) -> Brush"""
5080 return _gdi_.StockGDI_GetBrush(*args, **kwargs)
5081
5082 def StockGDI_GetColour(*args, **kwargs):
5083 """StockGDI_GetColour(int item) -> Colour"""
5084 return _gdi_.StockGDI_GetColour(*args, **kwargs)
5085
5086 def StockGDI_GetCursor(*args, **kwargs):
5087 """StockGDI_GetCursor(int item) -> Cursor"""
5088 return _gdi_.StockGDI_GetCursor(*args, **kwargs)
5089
5090 def StockGDI_GetPen(*args, **kwargs):
5091 """StockGDI_GetPen(int item) -> Pen"""
5092 return _gdi_.StockGDI_GetPen(*args, **kwargs)
5093
5094 # Create an uninitialized instance for the stock objects, they will
5095 # be initialized later when the wx.App object is created.
5096 ITALIC_FONT = Font.__new__(Font)
5097 NORMAL_FONT = Font.__new__(Font)
5098 SMALL_FONT = Font.__new__(Font)
5099 SWISS_FONT = Font.__new__(Font)
5100
5101 BLACK_DASHED_PEN = Pen.__new__(Pen)
5102 BLACK_PEN = Pen.__new__(Pen)
5103 CYAN_PEN = Pen.__new__(Pen)
5104 GREEN_PEN = Pen.__new__(Pen)
5105 GREY_PEN = Pen.__new__(Pen)
5106 LIGHT_GREY_PEN = Pen.__new__(Pen)
5107 MEDIUM_GREY_PEN = Pen.__new__(Pen)
5108 RED_PEN = Pen.__new__(Pen)
5109 TRANSPARENT_PEN = Pen.__new__(Pen)
5110 WHITE_PEN = Pen.__new__(Pen)
5111
5112 BLACK_BRUSH = Brush.__new__(Brush)
5113 BLUE_BRUSH = Brush.__new__(Brush)
5114 CYAN_BRUSH = Brush.__new__(Brush)
5115 GREEN_BRUSH = Brush.__new__(Brush)
5116 GREY_BRUSH = Brush.__new__(Brush)
5117 LIGHT_GREY_BRUSH = Brush.__new__(Brush)
5118 MEDIUM_GREY_BRUSH = Brush.__new__(Brush)
5119 RED_BRUSH = Brush.__new__(Brush)
5120 TRANSPARENT_BRUSH = Brush.__new__(Brush)
5121 WHITE_BRUSH = Brush.__new__(Brush)
5122
5123 BLACK = Colour.__new__(Colour)
5124 BLUE = Colour.__new__(Colour)
5125 CYAN = Colour.__new__(Colour)
5126 GREEN = Colour.__new__(Colour)
5127 LIGHT_GREY = Colour.__new__(Colour)
5128 RED = Colour.__new__(Colour)
5129 WHITE = Colour.__new__(Colour)
5130
5131 CROSS_CURSOR = Cursor.__new__(Cursor)
5132 HOURGLASS_CURSOR = Cursor.__new__(Cursor)
5133 STANDARD_CURSOR = Cursor.__new__(Cursor)
5134
5135 class GDIObjListBase(object):
5136 """Proxy of C++ GDIObjListBase class"""
5137 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5138 __repr__ = _swig_repr
5139 def __init__(self, *args, **kwargs):
5140 """__init__(self) -> GDIObjListBase"""
5141 _gdi_.GDIObjListBase_swiginit(self,_gdi_.new_GDIObjListBase(*args, **kwargs))
5142 __swig_destroy__ = _gdi_.delete_GDIObjListBase
5143 __del__ = lambda self : None;
5144 _gdi_.GDIObjListBase_swigregister(GDIObjListBase)
5145 cvar = _gdi_.cvar
5146 NullBitmap = cvar.NullBitmap
5147 NullIcon = cvar.NullIcon
5148 NullCursor = cvar.NullCursor
5149 NullPen = cvar.NullPen
5150 NullBrush = cvar.NullBrush
5151 NullPalette = cvar.NullPalette
5152 NullFont = cvar.NullFont
5153 NullColour = cvar.NullColour
5154
5155 class PenList(GDIObjListBase):
5156 """Proxy of C++ PenList class"""
5157 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5158 def __init__(self): raise AttributeError, "No constructor defined"
5159 __repr__ = _swig_repr
5160 def FindOrCreatePen(*args, **kwargs):
5161 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
5162 return _gdi_.PenList_FindOrCreatePen(*args, **kwargs)
5163
5164 def AddPen(*args, **kwargs):
5165 """AddPen(self, Pen pen)"""
5166 return _gdi_.PenList_AddPen(*args, **kwargs)
5167
5168 def RemovePen(*args, **kwargs):
5169 """RemovePen(self, Pen pen)"""
5170 return _gdi_.PenList_RemovePen(*args, **kwargs)
5171
5172 AddPen = wx._deprecated(AddPen)
5173 RemovePen = wx._deprecated(RemovePen)
5174
5175 _gdi_.PenList_swigregister(PenList)
5176
5177 class BrushList(GDIObjListBase):
5178 """Proxy of C++ BrushList class"""
5179 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5180 def __init__(self): raise AttributeError, "No constructor defined"
5181 __repr__ = _swig_repr
5182 def FindOrCreateBrush(*args, **kwargs):
5183 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
5184 return _gdi_.BrushList_FindOrCreateBrush(*args, **kwargs)
5185
5186 def AddBrush(*args, **kwargs):
5187 """AddBrush(self, Brush brush)"""
5188 return _gdi_.BrushList_AddBrush(*args, **kwargs)
5189
5190 def RemoveBrush(*args, **kwargs):
5191 """RemoveBrush(self, Brush brush)"""
5192 return _gdi_.BrushList_RemoveBrush(*args, **kwargs)
5193
5194 AddBrush = wx._deprecated(AddBrush)
5195 RemoveBrush = wx._deprecated(RemoveBrush)
5196
5197 _gdi_.BrushList_swigregister(BrushList)
5198
5199 class FontList(GDIObjListBase):
5200 """Proxy of C++ FontList class"""
5201 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5202 def __init__(self): raise AttributeError, "No constructor defined"
5203 __repr__ = _swig_repr
5204 def FindOrCreateFont(*args, **kwargs):
5205 """
5206 FindOrCreateFont(self, int point_size, int family, int style, int weight,
5207 bool underline=False, String facename=EmptyString,
5208 int encoding=FONTENCODING_DEFAULT) -> Font
5209 """
5210 return _gdi_.FontList_FindOrCreateFont(*args, **kwargs)
5211
5212 def AddFont(*args, **kwargs):
5213 """AddFont(self, Font font)"""
5214 return _gdi_.FontList_AddFont(*args, **kwargs)
5215
5216 def RemoveFont(*args, **kwargs):
5217 """RemoveFont(self, Font font)"""
5218 return _gdi_.FontList_RemoveFont(*args, **kwargs)
5219
5220 AddFont = wx._deprecated(AddFont)
5221 RemoveFont = wx._deprecated(RemoveFont)
5222
5223 _gdi_.FontList_swigregister(FontList)
5224
5225 class ColourDatabase(object):
5226 """Proxy of C++ ColourDatabase class"""
5227 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5228 __repr__ = _swig_repr
5229 def __init__(self, *args, **kwargs):
5230 """__init__(self) -> ColourDatabase"""
5231 _gdi_.ColourDatabase_swiginit(self,_gdi_.new_ColourDatabase(*args, **kwargs))
5232 __swig_destroy__ = _gdi_.delete_ColourDatabase
5233 __del__ = lambda self : None;
5234 def Find(*args, **kwargs):
5235 """Find(self, String name) -> Colour"""
5236 return _gdi_.ColourDatabase_Find(*args, **kwargs)
5237
5238 def FindName(*args, **kwargs):
5239 """FindName(self, Colour colour) -> String"""
5240 return _gdi_.ColourDatabase_FindName(*args, **kwargs)
5241
5242 FindColour = Find
5243 def AddColour(*args, **kwargs):
5244 """AddColour(self, String name, Colour colour)"""
5245 return _gdi_.ColourDatabase_AddColour(*args, **kwargs)
5246
5247 def Append(*args, **kwargs):
5248 """Append(self, String name, int red, int green, int blue)"""
5249 return _gdi_.ColourDatabase_Append(*args, **kwargs)
5250
5251 _gdi_.ColourDatabase_swigregister(ColourDatabase)
5252
5253 #---------------------------------------------------------------------------
5254
5255
5256 def _wxPyInitTheFontList(*args):
5257 """_wxPyInitTheFontList() -> FontList"""
5258 return _gdi_._wxPyInitTheFontList(*args)
5259
5260 def _wxPyInitThePenList(*args):
5261 """_wxPyInitThePenList() -> PenList"""
5262 return _gdi_._wxPyInitThePenList(*args)
5263
5264 def _wxPyInitTheBrushList(*args):
5265 """_wxPyInitTheBrushList() -> BrushList"""
5266 return _gdi_._wxPyInitTheBrushList(*args)
5267
5268 def _wxPyInitTheColourDatabase(*args):
5269 """_wxPyInitTheColourDatabase() -> ColourDatabase"""
5270 return _gdi_._wxPyInitTheColourDatabase(*args)
5271 # Create an uninitialized instance for the stock objects, they will
5272 # be initialized later when the wx.App object is created.
5273 TheFontList = FontList.__new__(FontList)
5274 ThePenList = PenList.__new__(PenList)
5275 TheBrushList = BrushList.__new__(BrushList)
5276 TheColourDatabase = ColourDatabase.__new__(ColourDatabase)
5277
5278 NullColor = NullColour
5279 #---------------------------------------------------------------------------
5280
5281 class Effects(_core.Object):
5282 """Proxy of C++ Effects class"""
5283 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5284 __repr__ = _swig_repr
5285 def __init__(self, *args, **kwargs):
5286 """__init__(self) -> Effects"""
5287 _gdi_.Effects_swiginit(self,_gdi_.new_Effects(*args, **kwargs))
5288 def GetHighlightColour(*args, **kwargs):
5289 """GetHighlightColour(self) -> Colour"""
5290 return _gdi_.Effects_GetHighlightColour(*args, **kwargs)
5291
5292 def GetLightShadow(*args, **kwargs):
5293 """GetLightShadow(self) -> Colour"""
5294 return _gdi_.Effects_GetLightShadow(*args, **kwargs)
5295
5296 def GetFaceColour(*args, **kwargs):
5297 """GetFaceColour(self) -> Colour"""
5298 return _gdi_.Effects_GetFaceColour(*args, **kwargs)
5299
5300 def GetMediumShadow(*args, **kwargs):
5301 """GetMediumShadow(self) -> Colour"""
5302 return _gdi_.Effects_GetMediumShadow(*args, **kwargs)
5303
5304 def GetDarkShadow(*args, **kwargs):
5305 """GetDarkShadow(self) -> Colour"""
5306 return _gdi_.Effects_GetDarkShadow(*args, **kwargs)
5307
5308 def SetHighlightColour(*args, **kwargs):
5309 """SetHighlightColour(self, Colour c)"""
5310 return _gdi_.Effects_SetHighlightColour(*args, **kwargs)
5311
5312 def SetLightShadow(*args, **kwargs):
5313 """SetLightShadow(self, Colour c)"""
5314 return _gdi_.Effects_SetLightShadow(*args, **kwargs)
5315
5316 def SetFaceColour(*args, **kwargs):
5317 """SetFaceColour(self, Colour c)"""
5318 return _gdi_.Effects_SetFaceColour(*args, **kwargs)
5319
5320 def SetMediumShadow(*args, **kwargs):
5321 """SetMediumShadow(self, Colour c)"""
5322 return _gdi_.Effects_SetMediumShadow(*args, **kwargs)
5323
5324 def SetDarkShadow(*args, **kwargs):
5325 """SetDarkShadow(self, Colour c)"""
5326 return _gdi_.Effects_SetDarkShadow(*args, **kwargs)
5327
5328 def Set(*args, **kwargs):
5329 """
5330 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
5331 Colour mediumShadow, Colour darkShadow)
5332 """
5333 return _gdi_.Effects_Set(*args, **kwargs)
5334
5335 def DrawSunkenEdge(*args, **kwargs):
5336 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
5337 return _gdi_.Effects_DrawSunkenEdge(*args, **kwargs)
5338
5339 def TileBitmap(*args, **kwargs):
5340 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
5341 return _gdi_.Effects_TileBitmap(*args, **kwargs)
5342
5343 DarkShadow = property(GetDarkShadow,SetDarkShadow,doc="See `GetDarkShadow` and `SetDarkShadow`")
5344 FaceColour = property(GetFaceColour,SetFaceColour,doc="See `GetFaceColour` and `SetFaceColour`")
5345 HighlightColour = property(GetHighlightColour,SetHighlightColour,doc="See `GetHighlightColour` and `SetHighlightColour`")
5346 LightShadow = property(GetLightShadow,SetLightShadow,doc="See `GetLightShadow` and `SetLightShadow`")
5347 MediumShadow = property(GetMediumShadow,SetMediumShadow,doc="See `GetMediumShadow` and `SetMediumShadow`")
5348 _gdi_.Effects_swigregister(Effects)
5349
5350 #---------------------------------------------------------------------------
5351
5352 CONTROL_DISABLED = _gdi_.CONTROL_DISABLED
5353 CONTROL_FOCUSED = _gdi_.CONTROL_FOCUSED
5354 CONTROL_PRESSED = _gdi_.CONTROL_PRESSED
5355 CONTROL_ISDEFAULT = _gdi_.CONTROL_ISDEFAULT
5356 CONTROL_ISSUBMENU = _gdi_.CONTROL_ISSUBMENU
5357 CONTROL_EXPANDED = _gdi_.CONTROL_EXPANDED
5358 CONTROL_CURRENT = _gdi_.CONTROL_CURRENT
5359 CONTROL_SELECTED = _gdi_.CONTROL_SELECTED
5360 CONTROL_CHECKED = _gdi_.CONTROL_CHECKED
5361 CONTROL_CHECKABLE = _gdi_.CONTROL_CHECKABLE
5362 CONTROL_UNDETERMINED = _gdi_.CONTROL_UNDETERMINED
5363 CONTROL_FLAGS_MASK = _gdi_.CONTROL_FLAGS_MASK
5364 CONTROL_DIRTY = _gdi_.CONTROL_DIRTY
5365 class SplitterRenderParams(object):
5366 """
5367 This is just a simple struct used as a return value of
5368 `wx.RendererNative.GetSplitterParams` and contains some platform
5369 specific metrics about splitters.
5370
5371 * widthSash: the width of the splitter sash.
5372 * border: the width of the border of the splitter window.
5373 * isHotSensitive: ``True`` if the splitter changes its
5374 appearance when the mouse is over it.
5375
5376
5377 """
5378 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5379 __repr__ = _swig_repr
5380 def __init__(self, *args, **kwargs):
5381 """
5382 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5383
5384 This is just a simple struct used as a return value of
5385 `wx.RendererNative.GetSplitterParams` and contains some platform
5386 specific metrics about splitters.
5387
5388 * widthSash: the width of the splitter sash.
5389 * border: the width of the border of the splitter window.
5390 * isHotSensitive: ``True`` if the splitter changes its
5391 appearance when the mouse is over it.
5392
5393
5394 """
5395 _gdi_.SplitterRenderParams_swiginit(self,_gdi_.new_SplitterRenderParams(*args, **kwargs))
5396 __swig_destroy__ = _gdi_.delete_SplitterRenderParams
5397 __del__ = lambda self : None;
5398 widthSash = property(_gdi_.SplitterRenderParams_widthSash_get)
5399 border = property(_gdi_.SplitterRenderParams_border_get)
5400 isHotSensitive = property(_gdi_.SplitterRenderParams_isHotSensitive_get)
5401 _gdi_.SplitterRenderParams_swigregister(SplitterRenderParams)
5402
5403 class HeaderButtonParams(object):
5404 """Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`"""
5405 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5406 __repr__ = _swig_repr
5407 def __init__(self, *args, **kwargs):
5408 """
5409 __init__(self) -> HeaderButtonParams
5410
5411 Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`
5412 """
5413 _gdi_.HeaderButtonParams_swiginit(self,_gdi_.new_HeaderButtonParams(*args, **kwargs))
5414 __swig_destroy__ = _gdi_.delete_HeaderButtonParams
5415 __del__ = lambda self : None;
5416 m_arrowColour = property(_gdi_.HeaderButtonParams_m_arrowColour_get, _gdi_.HeaderButtonParams_m_arrowColour_set)
5417 m_selectionColour = property(_gdi_.HeaderButtonParams_m_selectionColour_get, _gdi_.HeaderButtonParams_m_selectionColour_set)
5418 m_labelText = property(_gdi_.HeaderButtonParams_m_labelText_get, _gdi_.HeaderButtonParams_m_labelText_set)
5419 m_labelFont = property(_gdi_.HeaderButtonParams_m_labelFont_get, _gdi_.HeaderButtonParams_m_labelFont_set)
5420 m_labelColour = property(_gdi_.HeaderButtonParams_m_labelColour_get, _gdi_.HeaderButtonParams_m_labelColour_set)
5421 m_labelBitmap = property(_gdi_.HeaderButtonParams_m_labelBitmap_get, _gdi_.HeaderButtonParams_m_labelBitmap_set)
5422 m_labelAlignment = property(_gdi_.HeaderButtonParams_m_labelAlignment_get, _gdi_.HeaderButtonParams_m_labelAlignment_set)
5423 _gdi_.HeaderButtonParams_swigregister(HeaderButtonParams)
5424
5425 HDR_SORT_ICON_NONE = _gdi_.HDR_SORT_ICON_NONE
5426 HDR_SORT_ICON_UP = _gdi_.HDR_SORT_ICON_UP
5427 HDR_SORT_ICON_DOWN = _gdi_.HDR_SORT_ICON_DOWN
5428 class RendererVersion(object):
5429 """
5430 This simple struct represents the `wx.RendererNative` interface
5431 version and is only used as the return value of
5432 `wx.RendererNative.GetVersion`.
5433 """
5434 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5435 __repr__ = _swig_repr
5436 def __init__(self, *args, **kwargs):
5437 """
5438 __init__(self, int version_, int age_) -> RendererVersion
5439
5440 This simple struct represents the `wx.RendererNative` interface
5441 version and is only used as the return value of
5442 `wx.RendererNative.GetVersion`.
5443 """
5444 _gdi_.RendererVersion_swiginit(self,_gdi_.new_RendererVersion(*args, **kwargs))
5445 __swig_destroy__ = _gdi_.delete_RendererVersion
5446 __del__ = lambda self : None;
5447 Current_Version = _gdi_.RendererVersion_Current_Version
5448 Current_Age = _gdi_.RendererVersion_Current_Age
5449 def IsCompatible(*args, **kwargs):
5450 """IsCompatible(RendererVersion ver) -> bool"""
5451 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5452
5453 IsCompatible = staticmethod(IsCompatible)
5454 version = property(_gdi_.RendererVersion_version_get)
5455 age = property(_gdi_.RendererVersion_age_get)
5456 _gdi_.RendererVersion_swigregister(RendererVersion)
5457
5458 def RendererVersion_IsCompatible(*args, **kwargs):
5459 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5460 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5461
5462 class RendererNative(object):
5463 """
5464 One of the design principles of wxWidgets is to use the native
5465 widgets on every platform in order to be as close as possible to
5466 the native look and feel on every platform. However there are
5467 still cases when some generic widgets are needed for various
5468 reasons, but it can sometimes take a lot of messy work to make
5469 them conform to the native LnF.
5470
5471 The wx.RendererNative class is a collection of functions that have
5472 platform-specific implementations for drawing certain parts of
5473 genereic controls in ways that are as close to the native look as
5474 possible.
5475
5476 Note that each drawing function restores the `wx.DC` attributes if it
5477 changes them, so it is safe to assume that the same pen, brush and
5478 colours that were active before the call to this function are still in
5479 effect after it.
5480
5481 """
5482 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5483 def __init__(self): raise AttributeError, "No constructor defined"
5484 __repr__ = _swig_repr
5485 def DrawHeaderButton(*args, **kwargs):
5486 """
5487 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE,
5488 HeaderButtonParams params=None)
5489
5490 Draw the header control button (such as what is used by `wx.ListCtrl`
5491 in report mode.)
5492 """
5493 return _gdi_.RendererNative_DrawHeaderButton(*args, **kwargs)
5494
5495 def DrawHeaderButtonContents(*args, **kwargs):
5496 """
5497 DrawHeaderButtonContents(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE,
5498 HeaderButtonParams params=None)
5499
5500 Draw the contents of a header control button, (label, sort
5501 arrows, etc.) Normally this is only called by `DrawHeaderButton`.
5502 """
5503 return _gdi_.RendererNative_DrawHeaderButtonContents(*args, **kwargs)
5504
5505 def GetHeaderButtonHeight(*args, **kwargs):
5506 """
5507 GetHeaderButtonHeight(self, Window win) -> int
5508
5509 Returns the default height of a header button, either a fixed platform
5510 height if available, or a generic height based on the window's font.
5511 """
5512 return _gdi_.RendererNative_GetHeaderButtonHeight(*args, **kwargs)
5513
5514 def DrawTreeItemButton(*args, **kwargs):
5515 """
5516 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5517
5518 Draw the expanded/collapsed icon for a tree control item.
5519 """
5520 return _gdi_.RendererNative_DrawTreeItemButton(*args, **kwargs)
5521
5522 def DrawSplitterBorder(*args, **kwargs):
5523 """
5524 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5525
5526 Draw the border for a sash window: this border must be such that the
5527 sash drawn by `DrawSplitterSash` blends into it well.
5528 """
5529 return _gdi_.RendererNative_DrawSplitterBorder(*args, **kwargs)
5530
5531 def DrawSplitterSash(*args, **kwargs):
5532 """
5533 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5534 int flags=0)
5535
5536 Draw a sash. The orient parameter defines whether the sash should be
5537 vertical or horizontal and how the position should be interpreted.
5538 """
5539 return _gdi_.RendererNative_DrawSplitterSash(*args, **kwargs)
5540
5541 def DrawComboBoxDropButton(*args, **kwargs):
5542 """
5543 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5544
5545 Draw a button like the one used by `wx.ComboBox` to show a drop down
5546 window. The usual appearance is a downwards pointing arrow.
5547
5548 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5549 ``wx.CONTROL_CURRENT`` bits set.
5550 """
5551 return _gdi_.RendererNative_DrawComboBoxDropButton(*args, **kwargs)
5552
5553 def DrawDropArrow(*args, **kwargs):
5554 """
5555 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5556
5557 Draw a drop down arrow that is suitable for use outside a combo
5558 box. Arrow will have a transparent background.
5559
5560 ``rect`` is not entirely filled by the arrow. Instead, you should use
5561 bounding rectangle of a drop down button which arrow matches the size
5562 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5563 ``wx.CONTROL_CURRENT`` bit set.
5564 """
5565 return _gdi_.RendererNative_DrawDropArrow(*args, **kwargs)
5566
5567 def DrawCheckBox(*args, **kwargs):
5568 """
5569 DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0)
5570
5571 Draw a check button. Flags may use wx.CONTROL_CHECKED,
5572 wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.
5573 """
5574 return _gdi_.RendererNative_DrawCheckBox(*args, **kwargs)
5575
5576 def DrawPushButton(*args, **kwargs):
5577 """
5578 DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0)
5579
5580 Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
5581 wx.CONTROL_ISDEFAULT
5582 """
5583 return _gdi_.RendererNative_DrawPushButton(*args, **kwargs)
5584
5585 def DrawItemSelectionRect(*args, **kwargs):
5586 """
5587 DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0)
5588
5589 Draw rectangle indicating that an item in e.g. a list control has been
5590 selected or focused
5591
5592 The flags parameter may be:
5593
5594 ==================== ============================================
5595 wx.CONTROL_SELECTED item is selected, e.g. draw background
5596 wx.CONTROL_CURRENT item is the current item, e.g. dotted border
5597 wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
5598 background vs. grey otherwise
5599 ==================== ============================================
5600
5601 """
5602 return _gdi_.RendererNative_DrawItemSelectionRect(*args, **kwargs)
5603
5604 def GetSplitterParams(*args, **kwargs):
5605 """
5606 GetSplitterParams(self, Window win) -> SplitterRenderParams
5607
5608 Get the splitter parameters, see `wx.SplitterRenderParams`.
5609 """
5610 return _gdi_.RendererNative_GetSplitterParams(*args, **kwargs)
5611
5612 def Get(*args, **kwargs):
5613 """
5614 Get() -> RendererNative
5615
5616 Return the currently used renderer
5617 """
5618 return _gdi_.RendererNative_Get(*args, **kwargs)
5619
5620 Get = staticmethod(Get)
5621 def GetGeneric(*args, **kwargs):
5622 """
5623 GetGeneric() -> RendererNative
5624
5625 Return the generic implementation of the renderer. Under some
5626 platforms, this is the default renderer implementation, others have
5627 platform-specific default renderer which can be retrieved by calling
5628 `wx.RendererNative.GetDefault`.
5629 """
5630 return _gdi_.RendererNative_GetGeneric(*args, **kwargs)
5631
5632 GetGeneric = staticmethod(GetGeneric)
5633 def GetDefault(*args, **kwargs):
5634 """
5635 GetDefault() -> RendererNative
5636
5637 Return the default (native) implementation for this platform -- this
5638 is also the one used by default but this may be changed by calling
5639 `wx.RendererNative.Set` in which case the return value of this method
5640 may be different from the return value of `wx.RendererNative.Get`.
5641 """
5642 return _gdi_.RendererNative_GetDefault(*args, **kwargs)
5643
5644 GetDefault = staticmethod(GetDefault)
5645 def Set(*args, **kwargs):
5646 """
5647 Set(RendererNative renderer) -> RendererNative
5648
5649 Set the renderer to use, passing None reverts to using the default
5650 renderer. Returns the previous renderer used with Set or None.
5651 """
5652 return _gdi_.RendererNative_Set(*args, **kwargs)
5653
5654 Set = staticmethod(Set)
5655 def GetVersion(*args, **kwargs):
5656 """
5657 GetVersion(self) -> RendererVersion
5658
5659 Returns the version of the renderer. Will be used for ensuring
5660 compatibility of dynamically loaded renderers.
5661 """
5662 return _gdi_.RendererNative_GetVersion(*args, **kwargs)
5663
5664 SplitterParams = property(GetSplitterParams,doc="See `GetSplitterParams`")
5665 Version = property(GetVersion,doc="See `GetVersion`")
5666 _gdi_.RendererNative_swigregister(RendererNative)
5667
5668 def RendererNative_Get(*args):
5669 """
5670 RendererNative_Get() -> RendererNative
5671
5672 Return the currently used renderer
5673 """
5674 return _gdi_.RendererNative_Get(*args)
5675
5676 def RendererNative_GetGeneric(*args):
5677 """
5678 RendererNative_GetGeneric() -> RendererNative
5679
5680 Return the generic implementation of the renderer. Under some
5681 platforms, this is the default renderer implementation, others have
5682 platform-specific default renderer which can be retrieved by calling
5683 `wx.RendererNative.GetDefault`.
5684 """
5685 return _gdi_.RendererNative_GetGeneric(*args)
5686
5687 def RendererNative_GetDefault(*args):
5688 """
5689 RendererNative_GetDefault() -> RendererNative
5690
5691 Return the default (native) implementation for this platform -- this
5692 is also the one used by default but this may be changed by calling
5693 `wx.RendererNative.Set` in which case the return value of this method
5694 may be different from the return value of `wx.RendererNative.Get`.
5695 """
5696 return _gdi_.RendererNative_GetDefault(*args)
5697
5698 def RendererNative_Set(*args, **kwargs):
5699 """
5700 RendererNative_Set(RendererNative renderer) -> RendererNative
5701
5702 Set the renderer to use, passing None reverts to using the default
5703 renderer. Returns the previous renderer used with Set or None.
5704 """
5705 return _gdi_.RendererNative_Set(*args, **kwargs)
5706
5707 #---------------------------------------------------------------------------
5708
5709 class PseudoDC(_core.Object):
5710 """
5711 A PseudoDC is an object that can be used as if it were a `wx.DC`. All
5712 commands issued to the PseudoDC are stored in a list. You can then
5713 play these commands back to a real DC object using the DrawToDC
5714 method. Commands in the command list are indexed by ID. You can use
5715 this to clear the operations associated with a single ID and then
5716 re-draw the object associated with that ID.
5717 """
5718 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5719 __repr__ = _swig_repr
5720 def __init__(self, *args, **kwargs):
5721 """
5722 __init__(self) -> PseudoDC
5723
5724 Constructs a new Pseudo device context for recording dc operations
5725 """
5726 _gdi_.PseudoDC_swiginit(self,_gdi_.new_PseudoDC(*args, **kwargs))
5727 def BeginDrawing(*args, **kwargs):
5728 """
5729 BeginDrawing(self)
5730
5731 Allows for optimization of drawing code on platforms that need it. On
5732 other platforms this is just an empty function and is harmless. To
5733 take advantage of this postential optimization simply enclose each
5734 group of calls to the drawing primitives within calls to
5735 `BeginDrawing` and `EndDrawing`.
5736 """
5737 return _gdi_.PseudoDC_BeginDrawing(*args, **kwargs)
5738
5739 def EndDrawing(*args, **kwargs):
5740 """
5741 EndDrawing(self)
5742
5743 Ends the group of drawing primitives started with `BeginDrawing`, and
5744 invokes whatever optimization is available for this DC type on the
5745 current platform.
5746 """
5747 return _gdi_.PseudoDC_EndDrawing(*args, **kwargs)
5748
5749 __swig_destroy__ = _gdi_.delete_PseudoDC
5750 __del__ = lambda self : None;
5751 def RemoveAll(*args, **kwargs):
5752 """
5753 RemoveAll(self)
5754
5755 Removes all objects and operations from the recorded list.
5756 """
5757 return _gdi_.PseudoDC_RemoveAll(*args, **kwargs)
5758
5759 def GetLen(*args, **kwargs):
5760 """
5761 GetLen(self) -> int
5762
5763 Returns the number of operations in the recorded list.
5764 """
5765 return _gdi_.PseudoDC_GetLen(*args, **kwargs)
5766
5767 def SetId(*args, **kwargs):
5768 """
5769 SetId(self, int id)
5770
5771 Sets the id to be associated with subsequent operations.
5772 """
5773 return _gdi_.PseudoDC_SetId(*args, **kwargs)
5774
5775 def ClearId(*args, **kwargs):
5776 """
5777 ClearId(self, int id)
5778
5779 Removes all operations associated with id so the object can be redrawn.
5780 """
5781 return _gdi_.PseudoDC_ClearId(*args, **kwargs)
5782
5783 def RemoveId(*args, **kwargs):
5784 """
5785 RemoveId(self, int id)
5786
5787 Remove the object node (and all operations) associated with an id.
5788 """
5789 return _gdi_.PseudoDC_RemoveId(*args, **kwargs)
5790
5791 def TranslateId(*args, **kwargs):
5792 """
5793 TranslateId(self, int id, int dx, int dy)
5794
5795 Translate the operations of id by dx,dy.
5796 """
5797 return _gdi_.PseudoDC_TranslateId(*args, **kwargs)
5798
5799 def DrawIdToDC(*args, **kwargs):
5800 """
5801 DrawIdToDC(self, int id, DC dc)
5802
5803 Draw recorded operations of id to dc.
5804 """
5805 return _gdi_.PseudoDC_DrawIdToDC(*args, **kwargs)
5806
5807 def SetIdBounds(*args, **kwargs):
5808 """
5809 SetIdBounds(self, int id, Rect rect)
5810
5811 Set the bounding rect of a given object. This will create
5812 an object node if one doesn't exist.
5813 """
5814 return _gdi_.PseudoDC_SetIdBounds(*args, **kwargs)
5815
5816 def GetIdBounds(*args, **kwargs):
5817 """
5818 GetIdBounds(self, int id) -> Rect
5819
5820 Returns the bounding rectangle previouly set with SetIdBounds. If
5821 no bounds have been set, it returns wx.Rect(0,0,0,0).
5822 """
5823 return _gdi_.PseudoDC_GetIdBounds(*args, **kwargs)
5824
5825 def DrawToDCClipped(*args, **kwargs):
5826 """
5827 DrawToDCClipped(self, DC dc, Rect rect)
5828
5829 Draws the recorded operations to dc unless the operation is known to
5830 be outside rect.
5831 """
5832 return _gdi_.PseudoDC_DrawToDCClipped(*args, **kwargs)
5833
5834 def DrawToDCClippedRgn(*args, **kwargs):
5835 """
5836 DrawToDCClippedRgn(self, DC dc, Region region)
5837
5838 Draws the recorded operations to dc unless the operation is known to
5839 be outside rect.
5840 """
5841 return _gdi_.PseudoDC_DrawToDCClippedRgn(*args, **kwargs)
5842
5843 def DrawToDC(*args, **kwargs):
5844 """
5845 DrawToDC(self, DC dc)
5846
5847 Draws the recorded operations to dc.
5848 """
5849 return _gdi_.PseudoDC_DrawToDC(*args, **kwargs)
5850
5851 def FloodFill(*args, **kwargs):
5852 """
5853 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE)
5854
5855 Flood fills the device context starting from the given point, using
5856 the current brush colour, and using a style:
5857
5858 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5859 the given colour is encountered.
5860
5861 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5862 colour.
5863
5864 Returns False if the operation failed.
5865
5866 Note: The present implementation for non-Windows platforms may fail to
5867 find colour borders if the pixels do not match the colour
5868 exactly. However the function will still return true.
5869 """
5870 return _gdi_.PseudoDC_FloodFill(*args, **kwargs)
5871
5872 def FloodFillPoint(*args, **kwargs):
5873 """
5874 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE)
5875
5876 Flood fills the device context starting from the given point, using
5877 the current brush colour, and using a style:
5878
5879 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
5880 the given colour is encountered.
5881
5882 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
5883 colour.
5884
5885 Returns False if the operation failed.
5886
5887 Note: The present implementation for non-Windows platforms may fail to
5888 find colour borders if the pixels do not match the colour
5889 exactly. However the function will still return true.
5890 """
5891 return _gdi_.PseudoDC_FloodFillPoint(*args, **kwargs)
5892
5893 def DrawLine(*args, **kwargs):
5894 """
5895 DrawLine(self, int x1, int y1, int x2, int y2)
5896
5897 Draws a line from the first point to the second. The current pen is
5898 used for drawing the line. Note that the second point is *not* part of
5899 the line and is not drawn by this function (this is consistent with
5900 the behaviour of many other toolkits).
5901 """
5902 return _gdi_.PseudoDC_DrawLine(*args, **kwargs)
5903
5904 def DrawLinePoint(*args, **kwargs):
5905 """
5906 DrawLinePoint(self, Point pt1, Point pt2)
5907
5908 Draws a line from the first point to the second. The current pen is
5909 used for drawing the line. Note that the second point is *not* part of
5910 the line and is not drawn by this function (this is consistent with
5911 the behaviour of many other toolkits).
5912 """
5913 return _gdi_.PseudoDC_DrawLinePoint(*args, **kwargs)
5914
5915 def CrossHair(*args, **kwargs):
5916 """
5917 CrossHair(self, int x, int y)
5918
5919 Displays a cross hair using the current pen. This is a vertical and
5920 horizontal line the height and width of the window, centred on the
5921 given point.
5922 """
5923 return _gdi_.PseudoDC_CrossHair(*args, **kwargs)
5924
5925 def CrossHairPoint(*args, **kwargs):
5926 """
5927 CrossHairPoint(self, Point pt)
5928
5929 Displays a cross hair using the current pen. This is a vertical and
5930 horizontal line the height and width of the window, centred on the
5931 given point.
5932 """
5933 return _gdi_.PseudoDC_CrossHairPoint(*args, **kwargs)
5934
5935 def DrawArc(*args, **kwargs):
5936 """
5937 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
5938
5939 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5940 the first point to the second. The current pen is used for the outline
5941 and the current brush for filling the shape.
5942
5943 The arc is drawn in an anticlockwise direction from the start point to
5944 the end point.
5945 """
5946 return _gdi_.PseudoDC_DrawArc(*args, **kwargs)
5947
5948 def DrawArcPoint(*args, **kwargs):
5949 """
5950 DrawArcPoint(self, Point pt1, Point pt2, Point center)
5951
5952 Draws an arc of a circle, centred on the *center* point (xc, yc), from
5953 the first point to the second. The current pen is used for the outline
5954 and the current brush for filling the shape.
5955
5956 The arc is drawn in an anticlockwise direction from the start point to
5957 the end point.
5958 """
5959 return _gdi_.PseudoDC_DrawArcPoint(*args, **kwargs)
5960
5961 def DrawCheckMark(*args, **kwargs):
5962 """
5963 DrawCheckMark(self, int x, int y, int width, int height)
5964
5965 Draws a check mark inside the given rectangle.
5966 """
5967 return _gdi_.PseudoDC_DrawCheckMark(*args, **kwargs)
5968
5969 def DrawCheckMarkRect(*args, **kwargs):
5970 """
5971 DrawCheckMarkRect(self, Rect rect)
5972
5973 Draws a check mark inside the given rectangle.
5974 """
5975 return _gdi_.PseudoDC_DrawCheckMarkRect(*args, **kwargs)
5976
5977 def DrawEllipticArc(*args, **kwargs):
5978 """
5979 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
5980
5981 Draws an arc of an ellipse, with the given rectangle defining the
5982 bounds of the ellipse. The current pen is used for drawing the arc and
5983 the current brush is used for drawing the pie.
5984
5985 The *start* and *end* parameters specify the start and end of the arc
5986 relative to the three-o'clock position from the center of the
5987 rectangle. Angles are specified in degrees (360 is a complete
5988 circle). Positive values mean counter-clockwise motion. If start is
5989 equal to end, a complete ellipse will be drawn.
5990 """
5991 return _gdi_.PseudoDC_DrawEllipticArc(*args, **kwargs)
5992
5993 def DrawEllipticArcPointSize(*args, **kwargs):
5994 """
5995 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
5996
5997 Draws an arc of an ellipse, with the given rectangle defining the
5998 bounds of the ellipse. The current pen is used for drawing the arc and
5999 the current brush is used for drawing the pie.
6000
6001 The *start* and *end* parameters specify the start and end of the arc
6002 relative to the three-o'clock position from the center of the
6003 rectangle. Angles are specified in degrees (360 is a complete
6004 circle). Positive values mean counter-clockwise motion. If start is
6005 equal to end, a complete ellipse will be drawn.
6006 """
6007 return _gdi_.PseudoDC_DrawEllipticArcPointSize(*args, **kwargs)
6008
6009 def DrawPoint(*args, **kwargs):
6010 """
6011 DrawPoint(self, int x, int y)
6012
6013 Draws a point using the current pen.
6014 """
6015 return _gdi_.PseudoDC_DrawPoint(*args, **kwargs)
6016
6017 def DrawPointPoint(*args, **kwargs):
6018 """
6019 DrawPointPoint(self, Point pt)
6020
6021 Draws a point using the current pen.
6022 """
6023 return _gdi_.PseudoDC_DrawPointPoint(*args, **kwargs)
6024
6025 def DrawRectangle(*args, **kwargs):
6026 """
6027 DrawRectangle(self, int x, int y, int width, int height)
6028
6029 Draws a rectangle with the given top left corner, and with the given
6030 size. The current pen is used for the outline and the current brush
6031 for filling the shape.
6032 """
6033 return _gdi_.PseudoDC_DrawRectangle(*args, **kwargs)
6034
6035 def DrawRectangleRect(*args, **kwargs):
6036 """
6037 DrawRectangleRect(self, Rect rect)
6038
6039 Draws a rectangle with the given top left corner, and with the given
6040 size. The current pen is used for the outline and the current brush
6041 for filling the shape.
6042 """
6043 return _gdi_.PseudoDC_DrawRectangleRect(*args, **kwargs)
6044
6045 def DrawRectanglePointSize(*args, **kwargs):
6046 """
6047 DrawRectanglePointSize(self, Point pt, Size sz)
6048
6049 Draws a rectangle with the given top left corner, and with the given
6050 size. The current pen is used for the outline and the current brush
6051 for filling the shape.
6052 """
6053 return _gdi_.PseudoDC_DrawRectanglePointSize(*args, **kwargs)
6054
6055 def DrawRoundedRectangle(*args, **kwargs):
6056 """
6057 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
6058
6059 Draws a rectangle with the given top left corner, and with the given
6060 size. The corners are quarter-circles using the given radius. The
6061 current pen is used for the outline and the current brush for filling
6062 the shape.
6063
6064 If radius is positive, the value is assumed to be the radius of the
6065 rounded corner. If radius is negative, the absolute value is assumed
6066 to be the proportion of the smallest dimension of the rectangle. This
6067 means that the corner can be a sensible size relative to the size of
6068 the rectangle, and also avoids the strange effects X produces when the
6069 corners are too big for the rectangle.
6070 """
6071 return _gdi_.PseudoDC_DrawRoundedRectangle(*args, **kwargs)
6072
6073 def DrawRoundedRectangleRect(*args, **kwargs):
6074 """
6075 DrawRoundedRectangleRect(self, Rect r, double radius)
6076
6077 Draws a rectangle with the given top left corner, and with the given
6078 size. The corners are quarter-circles using the given radius. The
6079 current pen is used for the outline and the current brush for filling
6080 the shape.
6081
6082 If radius is positive, the value is assumed to be the radius of the
6083 rounded corner. If radius is negative, the absolute value is assumed
6084 to be the proportion of the smallest dimension of the rectangle. This
6085 means that the corner can be a sensible size relative to the size of
6086 the rectangle, and also avoids the strange effects X produces when the
6087 corners are too big for the rectangle.
6088 """
6089 return _gdi_.PseudoDC_DrawRoundedRectangleRect(*args, **kwargs)
6090
6091 def DrawRoundedRectanglePointSize(*args, **kwargs):
6092 """
6093 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
6094
6095 Draws a rectangle with the given top left corner, and with the given
6096 size. The corners are quarter-circles using the given radius. The
6097 current pen is used for the outline and the current brush for filling
6098 the shape.
6099
6100 If radius is positive, the value is assumed to be the radius of the
6101 rounded corner. If radius is negative, the absolute value is assumed
6102 to be the proportion of the smallest dimension of the rectangle. This
6103 means that the corner can be a sensible size relative to the size of
6104 the rectangle, and also avoids the strange effects X produces when the
6105 corners are too big for the rectangle.
6106 """
6107 return _gdi_.PseudoDC_DrawRoundedRectanglePointSize(*args, **kwargs)
6108
6109 def DrawCircle(*args, **kwargs):
6110 """
6111 DrawCircle(self, int x, int y, int radius)
6112
6113 Draws a circle with the given center point and radius. The current
6114 pen is used for the outline and the current brush for filling the
6115 shape.
6116 """
6117 return _gdi_.PseudoDC_DrawCircle(*args, **kwargs)
6118
6119 def DrawCirclePoint(*args, **kwargs):
6120 """
6121 DrawCirclePoint(self, Point pt, int radius)
6122
6123 Draws a circle with the given center point and radius. The current
6124 pen is used for the outline and the current brush for filling the
6125 shape.
6126 """
6127 return _gdi_.PseudoDC_DrawCirclePoint(*args, **kwargs)
6128
6129 def DrawEllipse(*args, **kwargs):
6130 """
6131 DrawEllipse(self, int x, int y, int width, int height)
6132
6133 Draws an ellipse contained in the specified rectangle. The current pen
6134 is used for the outline and the current brush for filling the shape.
6135 """
6136 return _gdi_.PseudoDC_DrawEllipse(*args, **kwargs)
6137
6138 def DrawEllipseRect(*args, **kwargs):
6139 """
6140 DrawEllipseRect(self, Rect rect)
6141
6142 Draws an ellipse contained in the specified rectangle. The current pen
6143 is used for the outline and the current brush for filling the shape.
6144 """
6145 return _gdi_.PseudoDC_DrawEllipseRect(*args, **kwargs)
6146
6147 def DrawEllipsePointSize(*args, **kwargs):
6148 """
6149 DrawEllipsePointSize(self, Point pt, Size sz)
6150
6151 Draws an ellipse contained in the specified rectangle. The current pen
6152 is used for the outline and the current brush for filling the shape.
6153 """
6154 return _gdi_.PseudoDC_DrawEllipsePointSize(*args, **kwargs)
6155
6156 def DrawIcon(*args, **kwargs):
6157 """
6158 DrawIcon(self, Icon icon, int x, int y)
6159
6160 Draw an icon on the display (does nothing if the device context is
6161 PostScript). This can be the simplest way of drawing bitmaps on a
6162 window.
6163 """
6164 return _gdi_.PseudoDC_DrawIcon(*args, **kwargs)
6165
6166 def DrawIconPoint(*args, **kwargs):
6167 """
6168 DrawIconPoint(self, Icon icon, Point pt)
6169
6170 Draw an icon on the display (does nothing if the device context is
6171 PostScript). This can be the simplest way of drawing bitmaps on a
6172 window.
6173 """
6174 return _gdi_.PseudoDC_DrawIconPoint(*args, **kwargs)
6175
6176 def DrawBitmap(*args, **kwargs):
6177 """
6178 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
6179
6180 Draw a bitmap on the device context at the specified point. If
6181 *transparent* is true and the bitmap has a transparency mask, (or
6182 alpha channel on the platforms that support it) then the bitmap will
6183 be drawn transparently.
6184 """
6185 return _gdi_.PseudoDC_DrawBitmap(*args, **kwargs)
6186
6187 def DrawBitmapPoint(*args, **kwargs):
6188 """
6189 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
6190
6191 Draw a bitmap on the device context at the specified point. If
6192 *transparent* is true and the bitmap has a transparency mask, (or
6193 alpha channel on the platforms that support it) then the bitmap will
6194 be drawn transparently.
6195 """
6196 return _gdi_.PseudoDC_DrawBitmapPoint(*args, **kwargs)
6197
6198 def DrawText(*args, **kwargs):
6199 """
6200 DrawText(self, String text, int x, int y)
6201
6202 Draws a text string at the specified point, using the current text
6203 font, and the current text foreground and background colours.
6204
6205 The coordinates refer to the top-left corner of the rectangle bounding
6206 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6207 a text string, which can be used to position the text more precisely,
6208 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6209 not implement it.)
6210
6211 **NOTE**: under wxGTK the current logical function is used by this
6212 function but it is ignored by wxMSW. Thus, you should avoid using
6213 logical functions with this function in portable programs.
6214 """
6215 return _gdi_.PseudoDC_DrawText(*args, **kwargs)
6216
6217 def DrawTextPoint(*args, **kwargs):
6218 """
6219 DrawTextPoint(self, String text, Point pt)
6220
6221 Draws a text string at the specified point, using the current text
6222 font, and the current text foreground and background colours.
6223
6224 The coordinates refer to the top-left corner of the rectangle bounding
6225 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6226 a text string, which can be used to position the text more precisely,
6227 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6228 not implement it.)
6229
6230 **NOTE**: under wxGTK the current logical function is used by this
6231 function but it is ignored by wxMSW. Thus, you should avoid using
6232 logical functions with this function in portable programs.
6233 """
6234 return _gdi_.PseudoDC_DrawTextPoint(*args, **kwargs)
6235
6236 def DrawRotatedText(*args, **kwargs):
6237 """
6238 DrawRotatedText(self, String text, int x, int y, double angle)
6239
6240 Draws the text rotated by *angle* degrees, if supported by the platform.
6241
6242 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6243 function. In particular, a font different from ``wx.NORMAL_FONT``
6244 should be used as the it is not normally a TrueType
6245 font. ``wx.SWISS_FONT`` is an example of a font which is.
6246 """
6247 return _gdi_.PseudoDC_DrawRotatedText(*args, **kwargs)
6248
6249 def DrawRotatedTextPoint(*args, **kwargs):
6250 """
6251 DrawRotatedTextPoint(self, String text, Point pt, double angle)
6252
6253 Draws the text rotated by *angle* degrees, if supported by the platform.
6254
6255 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6256 function. In particular, a font different from ``wx.NORMAL_FONT``
6257 should be used as the it is not normally a TrueType
6258 font. ``wx.SWISS_FONT`` is an example of a font which is.
6259 """
6260 return _gdi_.PseudoDC_DrawRotatedTextPoint(*args, **kwargs)
6261
6262 def DrawLines(*args, **kwargs):
6263 """
6264 DrawLines(self, List points, int xoffset=0, int yoffset=0)
6265
6266 Draws lines using a sequence of `wx.Point` objects, adding the
6267 optional offset coordinate. The current pen is used for drawing the
6268 lines.
6269 """
6270 return _gdi_.PseudoDC_DrawLines(*args, **kwargs)
6271
6272 def DrawPolygon(*args, **kwargs):
6273 """
6274 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
6275 int fillStyle=ODDEVEN_RULE)
6276
6277 Draws a filled polygon using a sequence of `wx.Point` objects, adding
6278 the optional offset coordinate. The last argument specifies the fill
6279 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
6280
6281 The current pen is used for drawing the outline, and the current brush
6282 for filling the shape. Using a transparent brush suppresses
6283 filling. Note that wxWidgets automatically closes the first and last
6284 points.
6285 """
6286 return _gdi_.PseudoDC_DrawPolygon(*args, **kwargs)
6287
6288 def DrawLabel(*args, **kwargs):
6289 """
6290 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6291 int indexAccel=-1)
6292
6293 Draw *text* within the specified rectangle, abiding by the alignment
6294 flags. Will additionally emphasize the character at *indexAccel* if
6295 it is not -1.
6296 """
6297 return _gdi_.PseudoDC_DrawLabel(*args, **kwargs)
6298
6299 def DrawImageLabel(*args, **kwargs):
6300 """
6301 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6302 int indexAccel=-1)
6303
6304 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
6305 drawing it) within the specified rectangle, abiding by the alignment
6306 flags. Will additionally emphasize the character at *indexAccel* if
6307 it is not -1.
6308 """
6309 return _gdi_.PseudoDC_DrawImageLabel(*args, **kwargs)
6310
6311 def DrawSpline(*args, **kwargs):
6312 """
6313 DrawSpline(self, List points)
6314
6315 Draws a spline between all given control points, (a list of `wx.Point`
6316 objects) using the current pen. The spline is drawn using a series of
6317 lines, using an algorithm taken from the X drawing program 'XFIG'.
6318 """
6319 return _gdi_.PseudoDC_DrawSpline(*args, **kwargs)
6320
6321 def Clear(*args, **kwargs):
6322 """
6323 Clear(self)
6324
6325 Clears the device context using the current background brush.
6326 """
6327 return _gdi_.PseudoDC_Clear(*args, **kwargs)
6328
6329 def SetFont(*args, **kwargs):
6330 """
6331 SetFont(self, Font font)
6332
6333 Sets the current font for the DC. It must be a valid font, in
6334 particular you should not pass ``wx.NullFont`` to this method.
6335 """
6336 return _gdi_.PseudoDC_SetFont(*args, **kwargs)
6337
6338 def SetPen(*args, **kwargs):
6339 """
6340 SetPen(self, Pen pen)
6341
6342 Sets the current pen for the DC.
6343
6344 If the argument is ``wx.NullPen``, the current pen is selected out of the
6345 device context, and the original pen restored.
6346 """
6347 return _gdi_.PseudoDC_SetPen(*args, **kwargs)
6348
6349 def SetBrush(*args, **kwargs):
6350 """
6351 SetBrush(self, Brush brush)
6352
6353 Sets the current brush for the DC.
6354
6355 If the argument is ``wx.NullBrush``, the current brush is selected out
6356 of the device context, and the original brush restored, allowing the
6357 current brush to be destroyed safely.
6358 """
6359 return _gdi_.PseudoDC_SetBrush(*args, **kwargs)
6360
6361 def SetBackground(*args, **kwargs):
6362 """
6363 SetBackground(self, Brush brush)
6364
6365 Sets the current background brush for the DC.
6366 """
6367 return _gdi_.PseudoDC_SetBackground(*args, **kwargs)
6368
6369 def SetBackgroundMode(*args, **kwargs):
6370 """
6371 SetBackgroundMode(self, int mode)
6372
6373 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
6374 determines whether text will be drawn with a background colour or
6375 not.
6376 """
6377 return _gdi_.PseudoDC_SetBackgroundMode(*args, **kwargs)
6378
6379 def SetPalette(*args, **kwargs):
6380 """
6381 SetPalette(self, Palette palette)
6382
6383 If this is a window DC or memory DC, assigns the given palette to the
6384 window or bitmap associated with the DC. If the argument is
6385 ``wx.NullPalette``, the current palette is selected out of the device
6386 context, and the original palette restored.
6387 """
6388 return _gdi_.PseudoDC_SetPalette(*args, **kwargs)
6389
6390 def SetTextForeground(*args, **kwargs):
6391 """
6392 SetTextForeground(self, Colour colour)
6393
6394 Sets the current text foreground colour for the DC.
6395 """
6396 return _gdi_.PseudoDC_SetTextForeground(*args, **kwargs)
6397
6398 def SetTextBackground(*args, **kwargs):
6399 """
6400 SetTextBackground(self, Colour colour)
6401
6402 Sets the current text background colour for the DC.
6403 """
6404 return _gdi_.PseudoDC_SetTextBackground(*args, **kwargs)
6405
6406 def SetLogicalFunction(*args, **kwargs):
6407 """
6408 SetLogicalFunction(self, int function)
6409
6410 Sets the current logical function for the device context. This
6411 determines how a source pixel (from a pen or brush colour, combines
6412 with a destination pixel in the current device context.
6413
6414 The possible values and their meaning in terms of source and
6415 destination pixel values are as follows:
6416
6417 ================ ==========================
6418 wx.AND src AND dst
6419 wx.AND_INVERT (NOT src) AND dst
6420 wx.AND_REVERSE src AND (NOT dst)
6421 wx.CLEAR 0
6422 wx.COPY src
6423 wx.EQUIV (NOT src) XOR dst
6424 wx.INVERT NOT dst
6425 wx.NAND (NOT src) OR (NOT dst)
6426 wx.NOR (NOT src) AND (NOT dst)
6427 wx.NO_OP dst
6428 wx.OR src OR dst
6429 wx.OR_INVERT (NOT src) OR dst
6430 wx.OR_REVERSE src OR (NOT dst)
6431 wx.SET 1
6432 wx.SRC_INVERT NOT src
6433 wx.XOR src XOR dst
6434 ================ ==========================
6435
6436 The default is wx.COPY, which simply draws with the current
6437 colour. The others combine the current colour and the background using
6438 a logical operation. wx.INVERT is commonly used for drawing rubber
6439 bands or moving outlines, since drawing twice reverts to the original
6440 colour.
6441
6442 """
6443 return _gdi_.PseudoDC_SetLogicalFunction(*args, **kwargs)
6444
6445 IdBounds = property(GetIdBounds,SetIdBounds,doc="See `GetIdBounds` and `SetIdBounds`")
6446 Len = property(GetLen,doc="See `GetLen`")
6447 _gdi_.PseudoDC_swigregister(PseudoDC)
6448
6449
6450