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