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