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