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