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