]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/msw/_gdi.py
log wxChoice events in the same format as wxComboBox ones to make it simpler to compa...
[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 2819
b1fcee84
RD
2820 def GradientFillConcentric(*args, **kwargs):
2821 """
2822 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2823 Point circleCenter)
2824
2825 Fill the area specified by rect with a radial gradient, starting from
2826 initialColour in the center of the circle and fading to destColour on
2827 the outside of the circle. The circleCenter argument is the relative
2828 coordinants of the center of the circle in the specified rect.
2829
2830 Note: Currently this function is very slow, don't use it for real-time
2831 drawing.
2832 """
2833 return _gdi_.DC_GradientFillConcentric(*args, **kwargs)
2834
2835 def GradientFillLinear(*args, **kwargs):
2836 """
2837 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2838 int nDirection=EAST)
2839
2840 Fill the area specified by rect with a linear gradient, starting from
2841 initialColour and eventually fading to destColour. The nDirection
2842 parameter specifies the direction of the colour change, default is to
2843 use initialColour on the left part of the rectangle and destColour on
2844 the right side.
2845 """
2846 return _gdi_.DC_GradientFillLinear(*args, **kwargs)
2847
d55e5bfc 2848 def GetPixel(*args, **kwargs):
f5b96ee1
RD
2849 """
2850 GetPixel(self, int x, int y) -> Colour
2851
2852 Gets the colour at the specified location on the DC.
2853 """
d55e5bfc
RD
2854 return _gdi_.DC_GetPixel(*args, **kwargs)
2855
c24da6d6
RD
2856 def GetPixelPoint(*args, **kwargs):
2857 """GetPixelPoint(self, Point pt) -> Colour"""
2858 return _gdi_.DC_GetPixelPoint(*args, **kwargs)
d55e5bfc
RD
2859
2860 def DrawLine(*args, **kwargs):
f5b96ee1
RD
2861 """
2862 DrawLine(self, int x1, int y1, int x2, int y2)
2863
2864 Draws a line from the first point to the second. The current pen is
2865 used for drawing the line. Note that the second point is *not* part of
2866 the line and is not drawn by this function (this is consistent with
2867 the behaviour of many other toolkits).
2868 """
d55e5bfc
RD
2869 return _gdi_.DC_DrawLine(*args, **kwargs)
2870
c24da6d6 2871 def DrawLinePoint(*args, **kwargs):
f5b96ee1
RD
2872 """
2873 DrawLinePoint(self, Point pt1, Point pt2)
2874
2875 Draws a line from the first point to the second. The current pen is
2876 used for drawing the line. Note that the second point is *not* part of
2877 the line and is not drawn by this function (this is consistent with
2878 the behaviour of many other toolkits).
2879 """
c24da6d6 2880 return _gdi_.DC_DrawLinePoint(*args, **kwargs)
d55e5bfc
RD
2881
2882 def CrossHair(*args, **kwargs):
f5b96ee1
RD
2883 """
2884 CrossHair(self, int x, int y)
2885
2886 Displays a cross hair using the current pen. This is a vertical and
2887 horizontal line the height and width of the window, centred on the
2888 given point.
2889 """
d55e5bfc
RD
2890 return _gdi_.DC_CrossHair(*args, **kwargs)
2891
c24da6d6 2892 def CrossHairPoint(*args, **kwargs):
f5b96ee1
RD
2893 """
2894 CrossHairPoint(self, Point pt)
2895
2896 Displays a cross hair using the current pen. This is a vertical and
2897 horizontal line the height and width of the window, centred on the
2898 given point.
2899 """
c24da6d6 2900 return _gdi_.DC_CrossHairPoint(*args, **kwargs)
d55e5bfc
RD
2901
2902 def DrawArc(*args, **kwargs):
f5b96ee1
RD
2903 """
2904 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
2905
2906 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2907 the first point to the second. The current pen is used for the outline
2908 and the current brush for filling the shape.
2909
2910 The arc is drawn in an anticlockwise direction from the start point to
2911 the end point.
2912 """
d55e5bfc
RD
2913 return _gdi_.DC_DrawArc(*args, **kwargs)
2914
c24da6d6 2915 def DrawArcPoint(*args, **kwargs):
f5b96ee1
RD
2916 """
2917 DrawArcPoint(self, Point pt1, Point pt2, Point center)
2918
2919 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2920 the first point to the second. The current pen is used for the outline
2921 and the current brush for filling the shape.
2922
2923 The arc is drawn in an anticlockwise direction from the start point to
2924 the end point.
2925 """
c24da6d6 2926 return _gdi_.DC_DrawArcPoint(*args, **kwargs)
d55e5bfc
RD
2927
2928 def DrawCheckMark(*args, **kwargs):
f5b96ee1
RD
2929 """
2930 DrawCheckMark(self, int x, int y, int width, int height)
2931
2932 Draws a check mark inside the given rectangle.
2933 """
d55e5bfc
RD
2934 return _gdi_.DC_DrawCheckMark(*args, **kwargs)
2935
c24da6d6 2936 def DrawCheckMarkRect(*args, **kwargs):
f5b96ee1
RD
2937 """
2938 DrawCheckMarkRect(self, Rect rect)
2939
2940 Draws a check mark inside the given rectangle.
2941 """
c24da6d6 2942 return _gdi_.DC_DrawCheckMarkRect(*args, **kwargs)
d55e5bfc
RD
2943
2944 def DrawEllipticArc(*args, **kwargs):
f5b96ee1
RD
2945 """
2946 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
2947
2948 Draws an arc of an ellipse, with the given rectangle defining the
2949 bounds of the ellipse. The current pen is used for drawing the arc and
2950 the current brush is used for drawing the pie.
2951
2952 The *start* and *end* parameters specify the start and end of the arc
2953 relative to the three-o'clock position from the center of the
2954 rectangle. Angles are specified in degrees (360 is a complete
2955 circle). Positive values mean counter-clockwise motion. If start is
2956 equal to end, a complete ellipse will be drawn.
2957 """
d55e5bfc
RD
2958 return _gdi_.DC_DrawEllipticArc(*args, **kwargs)
2959
c24da6d6 2960 def DrawEllipticArcPointSize(*args, **kwargs):
f5b96ee1
RD
2961 """
2962 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
2963
2964 Draws an arc of an ellipse, with the given rectangle defining the
2965 bounds of the ellipse. The current pen is used for drawing the arc and
2966 the current brush is used for drawing the pie.
2967
2968 The *start* and *end* parameters specify the start and end of the arc
2969 relative to the three-o'clock position from the center of the
2970 rectangle. Angles are specified in degrees (360 is a complete
2971 circle). Positive values mean counter-clockwise motion. If start is
2972 equal to end, a complete ellipse will be drawn.
2973 """
c24da6d6 2974 return _gdi_.DC_DrawEllipticArcPointSize(*args, **kwargs)
d55e5bfc
RD
2975
2976 def DrawPoint(*args, **kwargs):
f5b96ee1
RD
2977 """
2978 DrawPoint(self, int x, int y)
2979
2980 Draws a point using the current pen.
2981 """
d55e5bfc
RD
2982 return _gdi_.DC_DrawPoint(*args, **kwargs)
2983
c24da6d6 2984 def DrawPointPoint(*args, **kwargs):
f5b96ee1
RD
2985 """
2986 DrawPointPoint(self, Point pt)
2987
2988 Draws a point using the current pen.
2989 """
c24da6d6 2990 return _gdi_.DC_DrawPointPoint(*args, **kwargs)
d55e5bfc
RD
2991
2992 def DrawRectangle(*args, **kwargs):
f5b96ee1
RD
2993 """
2994 DrawRectangle(self, int x, int y, int width, int height)
2995
2996 Draws a rectangle with the given top left corner, and with the given
2997 size. The current pen is used for the outline and the current brush
2998 for filling the shape.
2999 """
d55e5bfc
RD
3000 return _gdi_.DC_DrawRectangle(*args, **kwargs)
3001
3002 def DrawRectangleRect(*args, **kwargs):
f5b96ee1
RD
3003 """
3004 DrawRectangleRect(self, Rect rect)
3005
3006 Draws a rectangle with the given top left corner, and with the given
3007 size. The current pen is used for the outline and the current brush
3008 for filling the shape.
3009 """
d55e5bfc
RD
3010 return _gdi_.DC_DrawRectangleRect(*args, **kwargs)
3011
c24da6d6 3012 def DrawRectanglePointSize(*args, **kwargs):
f5b96ee1
RD
3013 """
3014 DrawRectanglePointSize(self, Point pt, Size sz)
3015
3016 Draws a rectangle with the given top left corner, and with the given
3017 size. The current pen is used for the outline and the current brush
3018 for filling the shape.
3019 """
c24da6d6 3020 return _gdi_.DC_DrawRectanglePointSize(*args, **kwargs)
d55e5bfc
RD
3021
3022 def DrawRoundedRectangle(*args, **kwargs):
f5b96ee1
RD
3023 """
3024 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
3025
3026 Draws a rectangle with the given top left corner, and with the given
3027 size. The corners are quarter-circles using the given radius. The
3028 current pen is used for the outline and the current brush for filling
3029 the shape.
3030
3031 If radius is positive, the value is assumed to be the radius of the
3032 rounded corner. If radius is negative, the absolute value is assumed
3033 to be the proportion of the smallest dimension of the rectangle. This
3034 means that the corner can be a sensible size relative to the size of
3035 the rectangle, and also avoids the strange effects X produces when the
3036 corners are too big for the rectangle.
3037 """
d55e5bfc
RD
3038 return _gdi_.DC_DrawRoundedRectangle(*args, **kwargs)
3039
3040 def DrawRoundedRectangleRect(*args, **kwargs):
f5b96ee1
RD
3041 """
3042 DrawRoundedRectangleRect(self, Rect r, double radius)
3043
3044 Draws a rectangle with the given top left corner, and with the given
3045 size. The corners are quarter-circles using the given radius. The
3046 current pen is used for the outline and the current brush for filling
3047 the shape.
3048
3049 If radius is positive, the value is assumed to be the radius of the
3050 rounded corner. If radius is negative, the absolute value is assumed
3051 to be the proportion of the smallest dimension of the rectangle. This
3052 means that the corner can be a sensible size relative to the size of
3053 the rectangle, and also avoids the strange effects X produces when the
3054 corners are too big for the rectangle.
3055 """
d55e5bfc
RD
3056 return _gdi_.DC_DrawRoundedRectangleRect(*args, **kwargs)
3057
c24da6d6 3058 def DrawRoundedRectanglePointSize(*args, **kwargs):
f5b96ee1
RD
3059 """
3060 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
3061
3062 Draws a rectangle with the given top left corner, and with the given
3063 size. The corners are quarter-circles using the given radius. The
3064 current pen is used for the outline and the current brush for filling
3065 the shape.
3066
3067 If radius is positive, the value is assumed to be the radius of the
3068 rounded corner. If radius is negative, the absolute value is assumed
3069 to be the proportion of the smallest dimension of the rectangle. This
3070 means that the corner can be a sensible size relative to the size of
3071 the rectangle, and also avoids the strange effects X produces when the
3072 corners are too big for the rectangle.
3073 """
c24da6d6 3074 return _gdi_.DC_DrawRoundedRectanglePointSize(*args, **kwargs)
d55e5bfc
RD
3075
3076 def DrawCircle(*args, **kwargs):
f5b96ee1
RD
3077 """
3078 DrawCircle(self, int x, int y, int radius)
3079
3080 Draws a circle with the given center point and radius. The current
3081 pen is used for the outline and the current brush for filling the
3082 shape.
3083 """
d55e5bfc
RD
3084 return _gdi_.DC_DrawCircle(*args, **kwargs)
3085
c24da6d6 3086 def DrawCirclePoint(*args, **kwargs):
f5b96ee1
RD
3087 """
3088 DrawCirclePoint(self, Point pt, int radius)
3089
3090 Draws a circle with the given center point and radius. The current
3091 pen is used for the outline and the current brush for filling the
3092 shape.
3093 """
c24da6d6 3094 return _gdi_.DC_DrawCirclePoint(*args, **kwargs)
d55e5bfc
RD
3095
3096 def DrawEllipse(*args, **kwargs):
f5b96ee1
RD
3097 """
3098 DrawEllipse(self, int x, int y, int width, int height)
3099
3100 Draws an ellipse contained in the specified rectangle. The current pen
3101 is used for the outline and the current brush for filling the shape.
3102 """
d55e5bfc
RD
3103 return _gdi_.DC_DrawEllipse(*args, **kwargs)
3104
3105 def DrawEllipseRect(*args, **kwargs):
f5b96ee1
RD
3106 """
3107 DrawEllipseRect(self, Rect rect)
3108
3109 Draws an ellipse contained in the specified rectangle. The current pen
3110 is used for the outline and the current brush for filling the shape.
3111 """
d55e5bfc
RD
3112 return _gdi_.DC_DrawEllipseRect(*args, **kwargs)
3113
c24da6d6 3114 def DrawEllipsePointSize(*args, **kwargs):
f5b96ee1
RD
3115 """
3116 DrawEllipsePointSize(self, Point pt, Size sz)
3117
3118 Draws an ellipse contained in the specified rectangle. The current pen
3119 is used for the outline and the current brush for filling the shape.
3120 """
c24da6d6 3121 return _gdi_.DC_DrawEllipsePointSize(*args, **kwargs)
d55e5bfc
RD
3122
3123 def DrawIcon(*args, **kwargs):
f5b96ee1
RD
3124 """
3125 DrawIcon(self, Icon icon, int x, int y)
3126
3127 Draw an icon on the display (does nothing if the device context is
3128 PostScript). This can be the simplest way of drawing bitmaps on a
3129 window.
3130 """
d55e5bfc
RD
3131 return _gdi_.DC_DrawIcon(*args, **kwargs)
3132
c24da6d6 3133 def DrawIconPoint(*args, **kwargs):
f5b96ee1
RD
3134 """
3135 DrawIconPoint(self, Icon icon, Point pt)
3136
3137 Draw an icon on the display (does nothing if the device context is
3138 PostScript). This can be the simplest way of drawing bitmaps on a
3139 window.
3140 """
c24da6d6 3141 return _gdi_.DC_DrawIconPoint(*args, **kwargs)
d55e5bfc
RD
3142
3143 def DrawBitmap(*args, **kwargs):
f5b96ee1
RD
3144 """
3145 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
3146
3147 Draw a bitmap on the device context at the specified point. If
3148 *transparent* is true and the bitmap has a transparency mask, (or
3149 alpha channel on the platforms that support it) then the bitmap will
3150 be drawn transparently.
3151 """
d55e5bfc
RD
3152 return _gdi_.DC_DrawBitmap(*args, **kwargs)
3153
c24da6d6 3154 def DrawBitmapPoint(*args, **kwargs):
f5b96ee1
RD
3155 """
3156 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3157
3158 Draw a bitmap on the device context at the specified point. If
3159 *transparent* is true and the bitmap has a transparency mask, (or
3160 alpha channel on the platforms that support it) then the bitmap will
3161 be drawn transparently.
3162 """
c24da6d6 3163 return _gdi_.DC_DrawBitmapPoint(*args, **kwargs)
d55e5bfc
RD
3164
3165 def DrawText(*args, **kwargs):
f5b96ee1
RD
3166 """
3167 DrawText(self, String text, int x, int y)
3168
3169 Draws a text string at the specified point, using the current text
3170 font, and the current text foreground and background colours.
3171
3172 The coordinates refer to the top-left corner of the rectangle bounding
3173 the string. See `GetTextExtent` for how to get the dimensions of a
3174 text string, which can be used to position the text more precisely.
3175
3176 **NOTE**: under wxGTK the current logical function is used by this
3177 function but it is ignored by wxMSW. Thus, you should avoid using
3178 logical functions with this function in portable programs.
3179 """
d55e5bfc
RD
3180 return _gdi_.DC_DrawText(*args, **kwargs)
3181
c24da6d6 3182 def DrawTextPoint(*args, **kwargs):
f5b96ee1
RD
3183 """
3184 DrawTextPoint(self, String text, Point pt)
3185
3186 Draws a text string at the specified point, using the current text
3187 font, and the current text foreground and background colours.
3188
3189 The coordinates refer to the top-left corner of the rectangle bounding
3190 the string. See `GetTextExtent` for how to get the dimensions of a
3191 text string, which can be used to position the text more precisely.
3192
3193 **NOTE**: under wxGTK the current logical function is used by this
3194 function but it is ignored by wxMSW. Thus, you should avoid using
3195 logical functions with this function in portable programs.
3196 """
c24da6d6 3197 return _gdi_.DC_DrawTextPoint(*args, **kwargs)
d55e5bfc
RD
3198
3199 def DrawRotatedText(*args, **kwargs):
f5b96ee1
RD
3200 """
3201 DrawRotatedText(self, String text, int x, int y, double angle)
3202
3203 Draws the text rotated by *angle* degrees, if supported by the platform.
3204
3205 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3206 function. In particular, a font different from ``wx.NORMAL_FONT``
3207 should be used as the it is not normally a TrueType
3208 font. ``wx.SWISS_FONT`` is an example of a font which is.
3209 """
d55e5bfc
RD
3210 return _gdi_.DC_DrawRotatedText(*args, **kwargs)
3211
c24da6d6 3212 def DrawRotatedTextPoint(*args, **kwargs):
f5b96ee1
RD
3213 """
3214 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3215
3216 Draws the text rotated by *angle* degrees, if supported by the platform.
3217
3218 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3219 function. In particular, a font different from ``wx.NORMAL_FONT``
3220 should be used as the it is not normally a TrueType
3221 font. ``wx.SWISS_FONT`` is an example of a font which is.
3222 """
c24da6d6
RD
3223 return _gdi_.DC_DrawRotatedTextPoint(*args, **kwargs)
3224
3225 def Blit(*args, **kwargs):
d55e5bfc 3226 """
c24da6d6 3227 Blit(self, int xdest, int ydest, int width, int height, DC source,
d55e5bfc
RD
3228 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3229 int xsrcMask=-1, int ysrcMask=-1) -> bool
f5b96ee1
RD
3230
3231 Copy from a source DC to this DC. Parameters specify the destination
3232 coordinates, size of area to copy, source DC, source coordinates,
3233 logical function, whether to use a bitmap mask, and mask source
3234 position.
d55e5bfc 3235 """
c24da6d6 3236 return _gdi_.DC_Blit(*args, **kwargs)
d55e5bfc 3237
c24da6d6 3238 def BlitPointSize(*args, **kwargs):
d55e5bfc 3239 """
c24da6d6 3240 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
d55e5bfc 3241 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
f5b96ee1
RD
3242
3243 Copy from a source DC to this DC. Parameters specify the destination
3244 coordinates, size of area to copy, source DC, source coordinates,
3245 logical function, whether to use a bitmap mask, and mask source
3246 position.
d55e5bfc 3247 """
c24da6d6
RD
3248 return _gdi_.DC_BlitPointSize(*args, **kwargs)
3249
3250 def SetClippingRegion(*args, **kwargs):
f5b96ee1
RD
3251 """
3252 SetClippingRegion(self, int x, int y, int width, int height)
3253
3254 Sets the clipping region for this device context to the intersection
3255 of the given region described by the parameters of this method and the
3256 previously set clipping region. You should call `DestroyClippingRegion`
3257 if you want to set the clipping region exactly to the region
3258 specified.
3259
3260 The clipping region is an area to which drawing is
3261 restricted. Possible uses for the clipping region are for clipping
3262 text or for speeding up window redraws when only a known area of the
3263 screen is damaged.
3264 """
c24da6d6
RD
3265 return _gdi_.DC_SetClippingRegion(*args, **kwargs)
3266
3267 def SetClippingRegionPointSize(*args, **kwargs):
f5b96ee1
RD
3268 """
3269 SetClippingRegionPointSize(self, Point pt, Size sz)
3270
3271 Sets the clipping region for this device context to the intersection
3272 of the given region described by the parameters of this method and the
3273 previously set clipping region. You should call `DestroyClippingRegion`
3274 if you want to set the clipping region exactly to the region
3275 specified.
3276
3277 The clipping region is an area to which drawing is
3278 restricted. Possible uses for the clipping region are for clipping
3279 text or for speeding up window redraws when only a known area of the
3280 screen is damaged.
3281 """
c24da6d6
RD
3282 return _gdi_.DC_SetClippingRegionPointSize(*args, **kwargs)
3283
3284 def SetClippingRegionAsRegion(*args, **kwargs):
f5b96ee1
RD
3285 """
3286 SetClippingRegionAsRegion(self, Region region)
3287
3288 Sets the clipping region for this device context to the intersection
3289 of the given region described by the parameters of this method and the
3290 previously set clipping region. You should call `DestroyClippingRegion`
3291 if you want to set the clipping region exactly to the region
3292 specified.
3293
3294 The clipping region is an area to which drawing is
3295 restricted. Possible uses for the clipping region are for clipping
3296 text or for speeding up window redraws when only a known area of the
3297 screen is damaged.
3298 """
c24da6d6
RD
3299 return _gdi_.DC_SetClippingRegionAsRegion(*args, **kwargs)
3300
3301 def SetClippingRect(*args, **kwargs):
f5b96ee1
RD
3302 """
3303 SetClippingRect(self, Rect rect)
3304
3305 Sets the clipping region for this device context to the intersection
3306 of the given region described by the parameters of this method and the
3307 previously set clipping region. You should call `DestroyClippingRegion`
3308 if you want to set the clipping region exactly to the region
3309 specified.
3310
3311 The clipping region is an area to which drawing is
3312 restricted. Possible uses for the clipping region are for clipping
3313 text or for speeding up window redraws when only a known area of the
3314 screen is damaged.
3315 """
c24da6d6 3316 return _gdi_.DC_SetClippingRect(*args, **kwargs)
d55e5bfc
RD
3317
3318 def DrawLines(*args, **kwargs):
f5b96ee1
RD
3319 """
3320 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3321
3322 Draws lines using a sequence of `wx.Point` objects, adding the
3323 optional offset coordinate. The current pen is used for drawing the
3324 lines.
3325 """
d55e5bfc
RD
3326 return _gdi_.DC_DrawLines(*args, **kwargs)
3327
3328 def DrawPolygon(*args, **kwargs):
3329 """
f5b96ee1 3330 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
d55e5bfc 3331 int fillStyle=ODDEVEN_RULE)
f5b96ee1
RD
3332
3333 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3334 the optional offset coordinate. The last argument specifies the fill
3335 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3336
3337 The current pen is used for drawing the outline, and the current brush
3338 for filling the shape. Using a transparent brush suppresses
3339 filling. Note that wxWidgets automatically closes the first and last
3340 points.
d55e5bfc
RD
3341 """
3342 return _gdi_.DC_DrawPolygon(*args, **kwargs)
3343
3344 def DrawLabel(*args, **kwargs):
3345 """
3346 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3347 int indexAccel=-1)
f5b96ee1
RD
3348
3349 Draw *text* within the specified rectangle, abiding by the alignment
3350 flags. Will additionally emphasize the character at *indexAccel* if
3351 it is not -1.
d55e5bfc
RD
3352 """
3353 return _gdi_.DC_DrawLabel(*args, **kwargs)
3354
3355 def DrawImageLabel(*args, **kwargs):
3356 """
3357 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3358 int indexAccel=-1) -> Rect
f5b96ee1
RD
3359
3360 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3361 drawing it) within the specified rectangle, abiding by the alignment
3362 flags. Will additionally emphasize the character at *indexAccel* if
3363 it is not -1. Returns the bounding rectangle.
d55e5bfc
RD
3364 """
3365 return _gdi_.DC_DrawImageLabel(*args, **kwargs)
3366
3367 def DrawSpline(*args, **kwargs):
f5b96ee1
RD
3368 """
3369 DrawSpline(self, List points)
3370
3371 Draws a spline between all given control points, (a list of `wx.Point`
3372 objects) using the current pen. The spline is drawn using a series of
3373 lines, using an algorithm taken from the X drawing program 'XFIG'.
3374 """
d55e5bfc
RD
3375 return _gdi_.DC_DrawSpline(*args, **kwargs)
3376
3377 def Clear(*args, **kwargs):
f5b96ee1
RD
3378 """
3379 Clear(self)
3380
3381 Clears the device context using the current background brush.
3382 """
d55e5bfc
RD
3383 return _gdi_.DC_Clear(*args, **kwargs)
3384
3385 def StartDoc(*args, **kwargs):
f5b96ee1
RD
3386 """
3387 StartDoc(self, String message) -> bool
3388
3389 Starts a document (only relevant when outputting to a
3390 printer). *Message* is a message to show whilst printing.
3391 """
d55e5bfc
RD
3392 return _gdi_.DC_StartDoc(*args, **kwargs)
3393
3394 def EndDoc(*args, **kwargs):
f5b96ee1
RD
3395 """
3396 EndDoc(self)
3397
3398 Ends a document (only relevant when outputting to a printer).
3399 """
d55e5bfc
RD
3400 return _gdi_.DC_EndDoc(*args, **kwargs)
3401
3402 def StartPage(*args, **kwargs):
f5b96ee1
RD
3403 """
3404 StartPage(self)
3405
3406 Starts a document page (only relevant when outputting to a printer).
3407 """
d55e5bfc
RD
3408 return _gdi_.DC_StartPage(*args, **kwargs)
3409
3410 def EndPage(*args, **kwargs):
f5b96ee1
RD
3411 """
3412 EndPage(self)
3413
3414 Ends a document page (only relevant when outputting to a printer).
3415 """
d55e5bfc
RD
3416 return _gdi_.DC_EndPage(*args, **kwargs)
3417
3418 def SetFont(*args, **kwargs):
f5b96ee1
RD
3419 """
3420 SetFont(self, Font font)
3421
3422 Sets the current font for the DC. It must be a valid font, in
3423 particular you should not pass ``wx.NullFont`` to this method.
3424 """
d55e5bfc
RD
3425 return _gdi_.DC_SetFont(*args, **kwargs)
3426
3427 def SetPen(*args, **kwargs):
f5b96ee1
RD
3428 """
3429 SetPen(self, Pen pen)
3430
3431 Sets the current pen for the DC.
3432
3433 If the argument is ``wx.NullPen``, the current pen is selected out of the
3434 device context, and the original pen restored.
3435 """
d55e5bfc
RD
3436 return _gdi_.DC_SetPen(*args, **kwargs)
3437
3438 def SetBrush(*args, **kwargs):
f5b96ee1
RD
3439 """
3440 SetBrush(self, Brush brush)
3441
3442 Sets the current brush for the DC.
3443
3444 If the argument is ``wx.NullBrush``, the current brush is selected out
3445 of the device context, and the original brush restored, allowing the
3446 current brush to be destroyed safely.
3447 """
d55e5bfc
RD
3448 return _gdi_.DC_SetBrush(*args, **kwargs)
3449
3450 def SetBackground(*args, **kwargs):
f5b96ee1
RD
3451 """
3452 SetBackground(self, Brush brush)
3453
3454 Sets the current background brush for the DC.
3455 """
d55e5bfc
RD
3456 return _gdi_.DC_SetBackground(*args, **kwargs)
3457
3458 def SetBackgroundMode(*args, **kwargs):
f5b96ee1
RD
3459 """
3460 SetBackgroundMode(self, int mode)
3461
3462 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3463 determines whether text will be drawn with a background colour or
3464 not.
3465 """
d55e5bfc
RD
3466 return _gdi_.DC_SetBackgroundMode(*args, **kwargs)
3467
3468 def SetPalette(*args, **kwargs):
f5b96ee1
RD
3469 """
3470 SetPalette(self, Palette palette)
3471
3472 If this is a window DC or memory DC, assigns the given palette to the
3473 window or bitmap associated with the DC. If the argument is
3474 ``wx.NullPalette``, the current palette is selected out of the device
3475 context, and the original palette restored.
3476 """
d55e5bfc
RD
3477 return _gdi_.DC_SetPalette(*args, **kwargs)
3478
d55e5bfc 3479 def DestroyClippingRegion(*args, **kwargs):
f5b96ee1
RD
3480 """
3481 DestroyClippingRegion(self)
3482
3483 Destroys the current clipping region so that none of the DC is
3484 clipped.
3485 """
d55e5bfc
RD
3486 return _gdi_.DC_DestroyClippingRegion(*args, **kwargs)
3487
3488 def GetClippingBox(*args, **kwargs):
f5b96ee1
RD
3489 """
3490 GetClippingBox() -> (x, y, width, height)
3491
3492 Gets the rectangle surrounding the current clipping region.
3493 """
d55e5bfc
RD
3494 return _gdi_.DC_GetClippingBox(*args, **kwargs)
3495
3496 def GetClippingRect(*args, **kwargs):
f5b96ee1
RD
3497 """
3498 GetClippingRect(self) -> Rect
3499
3500 Gets the rectangle surrounding the current clipping region.
3501 """
d55e5bfc
RD
3502 return _gdi_.DC_GetClippingRect(*args, **kwargs)
3503
3504 def GetCharHeight(*args, **kwargs):
f5b96ee1
RD
3505 """
3506 GetCharHeight(self) -> int
3507
3508 Gets the character height of the currently set font.
3509 """
d55e5bfc
RD
3510 return _gdi_.DC_GetCharHeight(*args, **kwargs)
3511
3512 def GetCharWidth(*args, **kwargs):
f5b96ee1
RD
3513 """
3514 GetCharWidth(self) -> int
3515
3516 Gets the average character width of the currently set font.
3517 """
d55e5bfc
RD
3518 return _gdi_.DC_GetCharWidth(*args, **kwargs)
3519
3520 def GetTextExtent(*args, **kwargs):
a001823c
RD
3521 """
3522 GetTextExtent(wxString string) -> (width, height)
3523
3524 Get the width and height of the text using the current font. Only
3525 works for single line strings.
3526 """
d55e5bfc
RD
3527 return _gdi_.DC_GetTextExtent(*args, **kwargs)
3528
3529 def GetFullTextExtent(*args, **kwargs):
3530 """
3531 GetFullTextExtent(wxString string, Font font=None) ->
3532 (width, height, descent, externalLeading)
3533
79fccf9d
RD
3534 Get the width, height, decent and leading of the text using the
3535 current or specified font. Only works for single line strings.
d55e5bfc
RD
3536 """
3537 return _gdi_.DC_GetFullTextExtent(*args, **kwargs)
3538
3539 def GetMultiLineTextExtent(*args, **kwargs):
3540 """
3541 GetMultiLineTextExtent(wxString string, Font font=None) ->
3542 (width, height, descent, externalLeading)
a001823c
RD
3543
3544 Get the width, height, decent and leading of the text using the
3545 current or specified font. Works for single as well as multi-line
3546 strings.
d55e5bfc
RD
3547 """
3548 return _gdi_.DC_GetMultiLineTextExtent(*args, **kwargs)
3549
3550 def GetPartialTextExtents(*args, **kwargs):
f5b96ee1
RD
3551 """
3552 GetPartialTextExtents(self, text) -> [widths]
3553
3554 Returns a list of integers such that each value is the distance in
3555 pixels from the begining of text to the coresponding character of
3556 *text*. The generic version simply builds a running total of the widths
3557 of each character using GetTextExtent, however if the various
3558 platforms have a native API function that is faster or more accurate
43e8916f 3559 than the generic implementation then it will be used instead.
f5b96ee1 3560 """
d55e5bfc
RD
3561 return _gdi_.DC_GetPartialTextExtents(*args, **kwargs)
3562
3563 def GetSize(*args, **kwargs):
3564 """
3565 GetSize(self) -> Size
3566
f5b96ee1
RD
3567 This gets the horizontal and vertical resolution in device units. It
3568 can be used to scale graphics to fit the page. For example, if *maxX*
3569 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3570 used in your application, the following code will scale the graphic to
3571 fit on the printer page::
3572
3573 w, h = dc.GetSize()
3574 scaleX = maxX*1.0 / w
3575 scaleY = maxY*1.0 / h
3576 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3577
d55e5bfc
RD
3578 """
3579 return _gdi_.DC_GetSize(*args, **kwargs)
3580
3581 def GetSizeTuple(*args, **kwargs):
3582 """
3583 GetSizeTuple() -> (width, height)
3584
f5b96ee1
RD
3585 This gets the horizontal and vertical resolution in device units. It
3586 can be used to scale graphics to fit the page. For example, if *maxX*
3587 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3588 used in your application, the following code will scale the graphic to
3589 fit on the printer page::
3590
3591 w, h = dc.GetSize()
3592 scaleX = maxX*1.0 / w
3593 scaleY = maxY*1.0 / h
3594 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3595
d55e5bfc
RD
3596 """
3597 return _gdi_.DC_GetSizeTuple(*args, **kwargs)
3598
3599 def GetSizeMM(*args, **kwargs):
3600 """
3601 GetSizeMM(self) -> Size
3602
3603 Get the DC size in milimeters.
3604 """
3605 return _gdi_.DC_GetSizeMM(*args, **kwargs)
3606
3607 def GetSizeMMTuple(*args, **kwargs):
3608 """
3609 GetSizeMMTuple() -> (width, height)
3610
3611 Get the DC size in milimeters.
3612 """
3613 return _gdi_.DC_GetSizeMMTuple(*args, **kwargs)
3614
3615 def DeviceToLogicalX(*args, **kwargs):
f5b96ee1
RD
3616 """
3617 DeviceToLogicalX(self, int x) -> int
3618
3619 Convert device X coordinate to logical coordinate, using the current
3620 mapping mode.
3621 """
d55e5bfc
RD
3622 return _gdi_.DC_DeviceToLogicalX(*args, **kwargs)
3623
3624 def DeviceToLogicalY(*args, **kwargs):
f5b96ee1
RD
3625 """
3626 DeviceToLogicalY(self, int y) -> int
3627
3628 Converts device Y coordinate to logical coordinate, using the current
3629 mapping mode.
3630 """
d55e5bfc
RD
3631 return _gdi_.DC_DeviceToLogicalY(*args, **kwargs)
3632
3633 def DeviceToLogicalXRel(*args, **kwargs):
f5b96ee1
RD
3634 """
3635 DeviceToLogicalXRel(self, int x) -> int
3636
3637 Convert device X coordinate to relative logical coordinate, using the
3638 current mapping mode but ignoring the x axis orientation. Use this
3639 function for converting a width, for example.
3640 """
d55e5bfc
RD
3641 return _gdi_.DC_DeviceToLogicalXRel(*args, **kwargs)
3642
3643 def DeviceToLogicalYRel(*args, **kwargs):
f5b96ee1
RD
3644 """
3645 DeviceToLogicalYRel(self, int y) -> int
3646
3647 Convert device Y coordinate to relative logical coordinate, using the
3648 current mapping mode but ignoring the y axis orientation. Use this
3649 function for converting a height, for example.
3650 """
d55e5bfc
RD
3651 return _gdi_.DC_DeviceToLogicalYRel(*args, **kwargs)
3652
3653 def LogicalToDeviceX(*args, **kwargs):
f5b96ee1
RD
3654 """
3655 LogicalToDeviceX(self, int x) -> int
3656
3657 Converts logical X coordinate to device coordinate, using the current
3658 mapping mode.
3659 """
d55e5bfc
RD
3660 return _gdi_.DC_LogicalToDeviceX(*args, **kwargs)
3661
3662 def LogicalToDeviceY(*args, **kwargs):
f5b96ee1
RD
3663 """
3664 LogicalToDeviceY(self, int y) -> int
3665
3666 Converts logical Y coordinate to device coordinate, using the current
3667 mapping mode.
3668 """
d55e5bfc
RD
3669 return _gdi_.DC_LogicalToDeviceY(*args, **kwargs)
3670
3671 def LogicalToDeviceXRel(*args, **kwargs):
f5b96ee1
RD
3672 """
3673 LogicalToDeviceXRel(self, int x) -> int
3674
3675 Converts logical X coordinate to relative device coordinate, using the
3676 current mapping mode but ignoring the x axis orientation. Use this for
3677 converting a width, for example.
3678 """
d55e5bfc
RD
3679 return _gdi_.DC_LogicalToDeviceXRel(*args, **kwargs)
3680
3681 def LogicalToDeviceYRel(*args, **kwargs):
f5b96ee1
RD
3682 """
3683 LogicalToDeviceYRel(self, int y) -> int
3684
3685 Converts logical Y coordinate to relative device coordinate, using the
3686 current mapping mode but ignoring the y axis orientation. Use this for
3687 converting a height, for example.
3688 """
d55e5bfc
RD
3689 return _gdi_.DC_LogicalToDeviceYRel(*args, **kwargs)
3690
3691 def CanDrawBitmap(*args, **kwargs):
3692 """CanDrawBitmap(self) -> bool"""
3693 return _gdi_.DC_CanDrawBitmap(*args, **kwargs)
3694
3695 def CanGetTextExtent(*args, **kwargs):
3696 """CanGetTextExtent(self) -> bool"""
3697 return _gdi_.DC_CanGetTextExtent(*args, **kwargs)
3698
3699 def GetDepth(*args, **kwargs):
f5b96ee1
RD
3700 """
3701 GetDepth(self) -> int
3702
3703 Returns the colour depth of the DC.
3704 """
d55e5bfc
RD
3705 return _gdi_.DC_GetDepth(*args, **kwargs)
3706
3707 def GetPPI(*args, **kwargs):
f5b96ee1
RD
3708 """
3709 GetPPI(self) -> Size
3710
3711 Resolution in Pixels per inch
3712 """
d55e5bfc
RD
3713 return _gdi_.DC_GetPPI(*args, **kwargs)
3714
3715 def Ok(*args, **kwargs):
f5b96ee1
RD
3716 """
3717 Ok(self) -> bool
3718
3719 Returns true if the DC is ok to use.
3720 """
d55e5bfc
RD
3721 return _gdi_.DC_Ok(*args, **kwargs)
3722
3723 def GetBackgroundMode(*args, **kwargs):
f5b96ee1
RD
3724 """
3725 GetBackgroundMode(self) -> int
3726
3727 Returns the current background mode, either ``wx.SOLID`` or
3728 ``wx.TRANSPARENT``.
3729 """
d55e5bfc
RD
3730 return _gdi_.DC_GetBackgroundMode(*args, **kwargs)
3731
3732 def GetBackground(*args, **kwargs):
f5b96ee1
RD
3733 """
3734 GetBackground(self) -> Brush
3735
3736 Gets the brush used for painting the background.
3737 """
d55e5bfc
RD
3738 return _gdi_.DC_GetBackground(*args, **kwargs)
3739
3740 def GetBrush(*args, **kwargs):
f5b96ee1
RD
3741 """
3742 GetBrush(self) -> Brush
3743
3744 Gets the current brush
3745 """
d55e5bfc
RD
3746 return _gdi_.DC_GetBrush(*args, **kwargs)
3747
3748 def GetFont(*args, **kwargs):
f5b96ee1
RD
3749 """
3750 GetFont(self) -> Font
3751
3752 Gets the current font
3753 """
d55e5bfc
RD
3754 return _gdi_.DC_GetFont(*args, **kwargs)
3755
3756 def GetPen(*args, **kwargs):
f5b96ee1
RD
3757 """
3758 GetPen(self) -> Pen
3759
3760 Gets the current pen
3761 """
d55e5bfc
RD
3762 return _gdi_.DC_GetPen(*args, **kwargs)
3763
3764 def GetTextBackground(*args, **kwargs):
f5b96ee1
RD
3765 """
3766 GetTextBackground(self) -> Colour
3767
3768 Gets the current text background colour
3769 """
d55e5bfc
RD
3770 return _gdi_.DC_GetTextBackground(*args, **kwargs)
3771
3772 def GetTextForeground(*args, **kwargs):
f5b96ee1
RD
3773 """
3774 GetTextForeground(self) -> Colour
3775
3776 Gets the current text foreground colour
3777 """
d55e5bfc
RD
3778 return _gdi_.DC_GetTextForeground(*args, **kwargs)
3779
3780 def SetTextForeground(*args, **kwargs):
f5b96ee1
RD
3781 """
3782 SetTextForeground(self, Colour colour)
3783
3784 Sets the current text foreground colour for the DC.
3785 """
d55e5bfc
RD
3786 return _gdi_.DC_SetTextForeground(*args, **kwargs)
3787
3788 def SetTextBackground(*args, **kwargs):
f5b96ee1
RD
3789 """
3790 SetTextBackground(self, Colour colour)
3791
3792 Sets the current text background colour for the DC.
3793 """
d55e5bfc
RD
3794 return _gdi_.DC_SetTextBackground(*args, **kwargs)
3795
3796 def GetMapMode(*args, **kwargs):
f5b96ee1
RD
3797 """
3798 GetMapMode(self) -> int
3799
3800 Gets the current *mapping mode* for the device context
3801 """
d55e5bfc
RD
3802 return _gdi_.DC_GetMapMode(*args, **kwargs)
3803
3804 def SetMapMode(*args, **kwargs):
f5b96ee1
RD
3805 """
3806 SetMapMode(self, int mode)
3807
3808 The *mapping mode* of the device context defines the unit of
3809 measurement used to convert logical units to device units. The
3810 mapping mode can be one of the following:
3811
3812 ================ =============================================
3813 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3814 of an inch.
3815 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3816 wx.MM_METRIC Each logical unit is 1 mm.
3817 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3818 wx.MM_TEXT Each logical unit is 1 pixel.
3819 ================ =============================================
3820
3821 """
d55e5bfc
RD
3822 return _gdi_.DC_SetMapMode(*args, **kwargs)
3823
3824 def GetUserScale(*args, **kwargs):
f5b96ee1
RD
3825 """
3826 GetUserScale(self) -> (xScale, yScale)
3827
3828 Gets the current user scale factor (set by `SetUserScale`).
3829 """
d55e5bfc
RD
3830 return _gdi_.DC_GetUserScale(*args, **kwargs)
3831
3832 def SetUserScale(*args, **kwargs):
f5b96ee1
RD
3833 """
3834 SetUserScale(self, double x, double y)
3835
3836 Sets the user scaling factor, useful for applications which require
3837 'zooming'.
3838 """
d55e5bfc
RD
3839 return _gdi_.DC_SetUserScale(*args, **kwargs)
3840
3841 def GetLogicalScale(*args, **kwargs):
3842 """GetLogicalScale() -> (xScale, yScale)"""
3843 return _gdi_.DC_GetLogicalScale(*args, **kwargs)
3844
3845 def SetLogicalScale(*args, **kwargs):
3846 """SetLogicalScale(self, double x, double y)"""
3847 return _gdi_.DC_SetLogicalScale(*args, **kwargs)
3848
3849 def GetLogicalOrigin(*args, **kwargs):
3850 """GetLogicalOrigin(self) -> Point"""
3851 return _gdi_.DC_GetLogicalOrigin(*args, **kwargs)
3852
3853 def GetLogicalOriginTuple(*args, **kwargs):
3854 """GetLogicalOriginTuple() -> (x,y)"""
3855 return _gdi_.DC_GetLogicalOriginTuple(*args, **kwargs)
3856
3857 def SetLogicalOrigin(*args, **kwargs):
3858 """SetLogicalOrigin(self, int x, int y)"""
3859 return _gdi_.DC_SetLogicalOrigin(*args, **kwargs)
3860
c24da6d6
RD
3861 def SetLogicalOriginPoint(*args, **kwargs):
3862 """SetLogicalOriginPoint(self, Point point)"""
3863 return _gdi_.DC_SetLogicalOriginPoint(*args, **kwargs)
3864
d55e5bfc
RD
3865 def GetDeviceOrigin(*args, **kwargs):
3866 """GetDeviceOrigin(self) -> Point"""
3867 return _gdi_.DC_GetDeviceOrigin(*args, **kwargs)
3868
3869 def GetDeviceOriginTuple(*args, **kwargs):
3870 """GetDeviceOriginTuple() -> (x,y)"""
3871 return _gdi_.DC_GetDeviceOriginTuple(*args, **kwargs)
3872
3873 def SetDeviceOrigin(*args, **kwargs):
3874 """SetDeviceOrigin(self, int x, int y)"""
3875 return _gdi_.DC_SetDeviceOrigin(*args, **kwargs)
3876
c24da6d6
RD
3877 def SetDeviceOriginPoint(*args, **kwargs):
3878 """SetDeviceOriginPoint(self, Point point)"""
3879 return _gdi_.DC_SetDeviceOriginPoint(*args, **kwargs)
3880
d55e5bfc 3881 def SetAxisOrientation(*args, **kwargs):
f5b96ee1
RD
3882 """
3883 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
3884
3885 Sets the x and y axis orientation (i.e., the direction from lowest to
3886 highest values on the axis). The default orientation is the natural
3887 orientation, e.g. x axis from left to right and y axis from bottom up.
3888 """
d55e5bfc
RD
3889 return _gdi_.DC_SetAxisOrientation(*args, **kwargs)
3890
3891 def GetLogicalFunction(*args, **kwargs):
f5b96ee1
RD
3892 """
3893 GetLogicalFunction(self) -> int
3894
3895 Gets the current logical function (set by `SetLogicalFunction`).
3896 """
d55e5bfc
RD
3897 return _gdi_.DC_GetLogicalFunction(*args, **kwargs)
3898
3899 def SetLogicalFunction(*args, **kwargs):
f5b96ee1
RD
3900 """
3901 SetLogicalFunction(self, int function)
3902
3903 Sets the current logical function for the device context. This
3904 determines how a source pixel (from a pen or brush colour, or source
3905 device context if using `Blit`) combines with a destination pixel in
3906 the current device context.
3907
3908 The possible values and their meaning in terms of source and
3909 destination pixel values are as follows:
3910
3911 ================ ==========================
3912 wx.AND src AND dst
3913 wx.AND_INVERT (NOT src) AND dst
3914 wx.AND_REVERSE src AND (NOT dst)
3915 wx.CLEAR 0
3916 wx.COPY src
3917 wx.EQUIV (NOT src) XOR dst
3918 wx.INVERT NOT dst
3919 wx.NAND (NOT src) OR (NOT dst)
3920 wx.NOR (NOT src) AND (NOT dst)
3921 wx.NO_OP dst
3922 wx.OR src OR dst
3923 wx.OR_INVERT (NOT src) OR dst
3924 wx.OR_REVERSE src OR (NOT dst)
3925 wx.SET 1
3926 wx.SRC_INVERT NOT src
3927 wx.XOR src XOR dst
3928 ================ ==========================
3929
3930 The default is wx.COPY, which simply draws with the current
3931 colour. The others combine the current colour and the background using
3932 a logical operation. wx.INVERT is commonly used for drawing rubber
3933 bands or moving outlines, since drawing twice reverts to the original
3934 colour.
3935
3936 """
d55e5bfc
RD
3937 return _gdi_.DC_SetLogicalFunction(*args, **kwargs)
3938
5cbf236d
RD
3939 def ComputeScaleAndOrigin(*args, **kwargs):
3940 """
3941 ComputeScaleAndOrigin(self)
3942
3943 Performs all necessary computations for given platform and context
3944 type after each change of scale and origin parameters. Usually called
3945 automatically internally after such changes.
3946
3947 """
3948 return _gdi_.DC_ComputeScaleAndOrigin(*args, **kwargs)
3949
b519803b
RD
3950 def SetOptimization(self, optimize):
3951 pass
3952 def GetOptimization(self):
3953 return False
f5b96ee1 3954
b519803b
RD
3955 SetOptimization = wx._deprecated(SetOptimization)
3956 GetOptimization = wx._deprecated(GetOptimization)
d55e5bfc
RD
3957
3958 def CalcBoundingBox(*args, **kwargs):
f5b96ee1
RD
3959 """
3960 CalcBoundingBox(self, int x, int y)
3961
3962 Adds the specified point to the bounding box which can be retrieved
3963 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3964 """
d55e5bfc
RD
3965 return _gdi_.DC_CalcBoundingBox(*args, **kwargs)
3966
c24da6d6 3967 def CalcBoundingBoxPoint(*args, **kwargs):
f5b96ee1
RD
3968 """
3969 CalcBoundingBoxPoint(self, Point point)
3970
3971 Adds the specified point to the bounding box which can be retrieved
3972 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3973 """
c24da6d6
RD
3974 return _gdi_.DC_CalcBoundingBoxPoint(*args, **kwargs)
3975
d55e5bfc 3976 def ResetBoundingBox(*args, **kwargs):
f5b96ee1
RD
3977 """
3978 ResetBoundingBox(self)
3979
3980 Resets the bounding box: after a call to this function, the bounding
3981 box doesn't contain anything.
3982 """
d55e5bfc
RD
3983 return _gdi_.DC_ResetBoundingBox(*args, **kwargs)
3984
3985 def MinX(*args, **kwargs):
f5b96ee1
RD
3986 """
3987 MinX(self) -> int
3988
3989 Gets the minimum horizontal extent used in drawing commands so far.
3990 """
d55e5bfc
RD
3991 return _gdi_.DC_MinX(*args, **kwargs)
3992
3993 def MaxX(*args, **kwargs):
f5b96ee1
RD
3994 """
3995 MaxX(self) -> int
3996
3997 Gets the maximum horizontal extent used in drawing commands so far.
3998 """
d55e5bfc
RD
3999 return _gdi_.DC_MaxX(*args, **kwargs)
4000
4001 def MinY(*args, **kwargs):
f5b96ee1
RD
4002 """
4003 MinY(self) -> int
4004
4005 Gets the minimum vertical extent used in drawing commands so far.
4006 """
d55e5bfc
RD
4007 return _gdi_.DC_MinY(*args, **kwargs)
4008
4009 def MaxY(*args, **kwargs):
f5b96ee1
RD
4010 """
4011 MaxY(self) -> int
4012
4013 Gets the maximum vertical extent used in drawing commands so far.
4014 """
d55e5bfc
RD
4015 return _gdi_.DC_MaxY(*args, **kwargs)
4016
4017 def GetBoundingBox(*args, **kwargs):
f5b96ee1
RD
4018 """
4019 GetBoundingBox() -> (x1,y1, x2,y2)
4020
4021 Returns the min and max points used in drawing commands so far.
4022 """
d55e5bfc
RD
4023 return _gdi_.DC_GetBoundingBox(*args, **kwargs)
4024
4025 def __nonzero__(self): return self.Ok()
0439c23b
RD
4026 def GetHDC(*args, **kwargs):
4027 """GetHDC(self) -> long"""
4028 return _gdi_.DC_GetHDC(*args, **kwargs)
4029
d55e5bfc
RD
4030 def _DrawPointList(*args, **kwargs):
4031 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4032 return _gdi_.DC__DrawPointList(*args, **kwargs)
4033
4034 def _DrawLineList(*args, **kwargs):
4035 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4036 return _gdi_.DC__DrawLineList(*args, **kwargs)
4037
4038 def _DrawRectangleList(*args, **kwargs):
4039 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4040 return _gdi_.DC__DrawRectangleList(*args, **kwargs)
4041
4042 def _DrawEllipseList(*args, **kwargs):
4043 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4044 return _gdi_.DC__DrawEllipseList(*args, **kwargs)
4045
4046 def _DrawPolygonList(*args, **kwargs):
4047 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4048 return _gdi_.DC__DrawPolygonList(*args, **kwargs)
4049
4050 def _DrawTextList(*args, **kwargs):
4051 """
4052 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
4053 PyObject backgroundList) -> PyObject
4054 """
4055 return _gdi_.DC__DrawTextList(*args, **kwargs)
4056
4057 def DrawPointList(self, points, pens=None):
f5b96ee1
RD
4058 """
4059 Draw a list of points as quickly as possible.
4060
4061 :param points: A sequence of 2-element sequences representing
4062 each point to draw, (x,y).
4063 :param pens: If None, then the current pen is used. If a
4064 single pen then it will be used for all points. If
4065 a list of pens then there should be one for each point
4066 in points.
4067 """
d55e5bfc
RD
4068 if pens is None:
4069 pens = []
4070 elif isinstance(pens, wx.Pen):
4071 pens = [pens]
4072 elif len(pens) != len(points):
4073 raise ValueError('points and pens must have same length')
4074 return self._DrawPointList(points, pens, [])
4075
4076
4077 def DrawLineList(self, lines, pens=None):
f5b96ee1
RD
4078 """
4079 Draw a list of lines as quickly as possible.
4080
4081 :param lines: A sequence of 4-element sequences representing
4082 each line to draw, (x1,y1, x2,y2).
4083 :param pens: If None, then the current pen is used. If a
4084 single pen then it will be used for all lines. If
4085 a list of pens then there should be one for each line
4086 in lines.
4087 """
d55e5bfc
RD
4088 if pens is None:
4089 pens = []
4090 elif isinstance(pens, wx.Pen):
4091 pens = [pens]
4092 elif len(pens) != len(lines):
4093 raise ValueError('lines and pens must have same length')
4094 return self._DrawLineList(lines, pens, [])
4095
4096
4097 def DrawRectangleList(self, rectangles, pens=None, brushes=None):
f5b96ee1
RD
4098 """
4099 Draw a list of rectangles as quickly as possible.
4100
4101 :param rectangles: A sequence of 4-element sequences representing
4102 each rectangle 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 rectangles.
4105 If a list of pens then there should be one for each
4106 rectangle in rectangles.
4107 :param brushes: A brush or brushes to be used to fill the rectagles,
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(rectangles):
4115 raise ValueError('rectangles 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(rectangles):
4121 raise ValueError('rectangles and brushes must have same length')
4122 return self._DrawRectangleList(rectangles, pens, brushes)
4123
4124
4125 def DrawEllipseList(self, ellipses, pens=None, brushes=None):
f5b96ee1
RD
4126 """
4127 Draw a list of ellipses as quickly as possible.
4128
4129 :param ellipses: A sequence of 4-element sequences representing
4130 each ellipse to draw, (x,y, w,h).
4131 :param pens: If None, then the current pen is used. If a
4132 single pen then it will be used for all ellipses.
4133 If a list of pens then there should be one for each
4134 ellipse in ellipses.
4135 :param brushes: A brush or brushes to be used to fill the ellipses,
4136 with similar semantics as the pens parameter.
4137 """
d55e5bfc
RD
4138 if pens is None:
4139 pens = []
4140 elif isinstance(pens, wx.Pen):
4141 pens = [pens]
4142 elif len(pens) != len(ellipses):
4143 raise ValueError('ellipses and pens must have same length')
4144 if brushes is None:
4145 brushes = []
4146 elif isinstance(brushes, wx.Brush):
4147 brushes = [brushes]
4148 elif len(brushes) != len(ellipses):
4149 raise ValueError('ellipses and brushes must have same length')
4150 return self._DrawEllipseList(ellipses, pens, brushes)
4151
4152
4153 def DrawPolygonList(self, polygons, pens=None, brushes=None):
f5b96ee1
RD
4154 """
4155 Draw a list of polygons, each of which is a list of points.
4156
4157 :param polygons: A sequence of sequences of sequences.
4158 [[(x1,y1),(x2,y2),(x3,y3)...],
4159 [(x1,y1),(x2,y2),(x3,y3)...]]
4160
4161 :param pens: If None, then the current pen is used. If a
4162 single pen then it will be used for all polygons.
4163 If a list of pens then there should be one for each
4164 polygon.
4165 :param brushes: A brush or brushes to be used to fill the polygons,
4166 with similar semantics as the pens parameter.
4167 """
d55e5bfc
RD
4168 if pens is None:
4169 pens = []
4170 elif isinstance(pens, wx.Pen):
4171 pens = [pens]
4172 elif len(pens) != len(polygons):
4173 raise ValueError('polygons and pens must have same length')
4174 if brushes is None:
4175 brushes = []
4176 elif isinstance(brushes, wx.Brush):
4177 brushes = [brushes]
4178 elif len(brushes) != len(polygons):
4179 raise ValueError('polygons and brushes must have same length')
4180 return self._DrawPolygonList(polygons, pens, brushes)
4181
4182
f5b96ee1
RD
4183 def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None):
4184 """
4185 Draw a list of strings using a list of coordinants for positioning each string.
4186
4187 :param textList: A list of strings
4188 :param coords: A list of (x,y) positions
4189 :param foregrounds: A list of `wx.Colour` objects to use for the
4190 foregrounds of the strings.
4191 :param backgrounds: A list of `wx.Colour` objects to use for the
4192 backgrounds of the strings.
4193
4194 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4195 If you want backgrounds to do anything.
4196 """
d55e5bfc
RD
4197 if type(textList) == type(''):
4198 textList = [textList]
4199 elif len(textList) != len(coords):
4200 raise ValueError('textlist and coords must have same length')
4201 if foregrounds is None:
4202 foregrounds = []
4203 elif isinstance(foregrounds, wx.Colour):
4204 foregrounds = [foregrounds]
4205 elif len(foregrounds) != len(coords):
4206 raise ValueError('foregrounds and coords must have same length')
4207 if backgrounds is None:
4208 backgrounds = []
4209 elif isinstance(backgrounds, wx.Colour):
4210 backgrounds = [backgrounds]
4211 elif len(backgrounds) != len(coords):
4212 raise ValueError('backgrounds and coords must have same length')
4213 return self._DrawTextList(textList, coords, foregrounds, backgrounds)
4214
4215
4216class DCPtr(DC):
4217 def __init__(self, this):
4218 self.this = this
4219 if not hasattr(self,"thisown"): self.thisown = 0
4220 self.__class__ = DC
4221_gdi_.DC_swigregister(DCPtr)
4222
4223#---------------------------------------------------------------------------
4224
4225class MemoryDC(DC):
f5b96ee1
RD
4226 """
4227 A memory device context provides a means to draw graphics onto a
4228 bitmap. A bitmap must be selected into the new memory DC before it may
4229 be used for anything. Typical usage is as follows::
4230
4231 dc = wx.MemoryDC()
4232 dc.SelectObject(bitmap)
4233 # draw on the dc usign any of the Draw methods
4234 dc.SelectObject(wx.NullBitmap)
4235 # the bitmap now contains wahtever was drawn upon it
4236
4237 Note that the memory DC *must* be deleted (or the bitmap selected out
4238 of it) before a bitmap can be reselected into another memory DC.
4239
4240 """
d55e5bfc
RD
4241 def __repr__(self):
4242 return "<%s.%s; proxy of C++ wxMemoryDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4243 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4244 """
4245 __init__(self) -> MemoryDC
4246
4247 Constructs a new memory device context.
4248
4249 Use the Ok member to test whether the constructor was successful in
4250 creating a usable device context. Don't forget to select a bitmap into
4251 the DC before drawing on it.
4252 """
d55e5bfc
RD
4253 newobj = _gdi_.new_MemoryDC(*args, **kwargs)
4254 self.this = newobj.this
4255 self.thisown = 1
4256 del newobj.thisown
4257 def SelectObject(*args, **kwargs):
f5b96ee1
RD
4258 """
4259 SelectObject(self, Bitmap bitmap)
4260
4261 Selects the bitmap into the device context, to use as the memory
4262 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4263 the DC, and therefore the bitmap, and also to use Blit to copy the
4264 bitmap to a window.
4265
4266 If the argument is wx.NullBitmap (or some other uninitialised
4267 `wx.Bitmap`) the current bitmap is selected out of the device context,
4268 and the original bitmap restored, allowing the current bitmap to be
4269 destroyed safely.
4270 """
d55e5bfc
RD
4271 return _gdi_.MemoryDC_SelectObject(*args, **kwargs)
4272
4273
4274class MemoryDCPtr(MemoryDC):
4275 def __init__(self, this):
4276 self.this = this
4277 if not hasattr(self,"thisown"): self.thisown = 0
4278 self.__class__ = MemoryDC
4279_gdi_.MemoryDC_swigregister(MemoryDCPtr)
4280
4281def MemoryDCFromDC(*args, **kwargs):
f5b96ee1
RD
4282 """
4283 MemoryDCFromDC(DC oldDC) -> MemoryDC
4284
4285 Creates a DC that is compatible with the oldDC.
4286 """
d55e5bfc
RD
4287 val = _gdi_.new_MemoryDCFromDC(*args, **kwargs)
4288 val.thisown = 1
4289 return val
4290
4291#---------------------------------------------------------------------------
4292
e2950dbb
RD
4293BUFFER_VIRTUAL_AREA = _gdi_.BUFFER_VIRTUAL_AREA
4294BUFFER_CLIENT_AREA = _gdi_.BUFFER_CLIENT_AREA
d55e5bfc 4295class BufferedDC(MemoryDC):
f5b96ee1
RD
4296 """
4297 This simple class provides a simple way to avoid flicker: when drawing
4298 on it, everything is in fact first drawn on an in-memory buffer (a
4299 `wx.Bitmap`) and then copied to the screen only once, when this object
4300 is destroyed.
4301
4302 It can be used in the same way as any other device
4303 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
4304 want to use it in your EVT_PAINT handler, you should look at
4305 `wx.BufferedPaintDC`.
4306
4307 """
d55e5bfc
RD
4308 def __repr__(self):
4309 return "<%s.%s; proxy of C++ wxBufferedDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4310 def __init__(self, *args):
4311 """
6932ae68 4312 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
e2950dbb 4313 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
f5b96ee1
RD
4314
4315 Constructs a buffered DC.
d55e5bfc
RD
4316 """
4317 newobj = _gdi_.new_BufferedDC(*args)
4318 self.this = newobj.this
4319 self.thisown = 1
4320 del newobj.thisown
f5b96ee1 4321 self.__dc = args[0] # save a ref so the other dc will not be deleted before self
d55e5bfc
RD
4322
4323 def __del__(self, destroy=_gdi_.delete_BufferedDC):
f5b96ee1
RD
4324 """
4325 __del__(self)
4326
4327 Copies everything drawn on the DC so far to the underlying DC
4328 associated with this object, if any.
4329 """
d55e5bfc
RD
4330 try:
4331 if self.thisown: destroy(self)
4332 except: pass
4333
4334 def UnMask(*args, **kwargs):
f5b96ee1
RD
4335 """
4336 UnMask(self)
4337
4338 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4339 can be effectively used once only). This is usually only called in
4340 the destructor.
4341 """
d55e5bfc
RD
4342 return _gdi_.BufferedDC_UnMask(*args, **kwargs)
4343
4344
4345class BufferedDCPtr(BufferedDC):
4346 def __init__(self, this):
4347 self.this = this
4348 if not hasattr(self,"thisown"): self.thisown = 0
4349 self.__class__ = BufferedDC
4350_gdi_.BufferedDC_swigregister(BufferedDCPtr)
4351
d55e5bfc 4352class BufferedPaintDC(BufferedDC):
f5b96ee1
RD
4353 """
4354 This is a subclass of `wx.BufferedDC` which can be used inside of an
4355 EVT_PAINT event handler. Just create an object of this class instead
4356 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4357 flicker. The only thing to watch out for is that if you are using this
4358 class together with `wx.ScrolledWindow`, you probably do **not** want
4359 to call `wx.Window.PrepareDC` on it as it already does this internally
4360 for the real underlying `wx.PaintDC`.
4361
4362 If your window is already fully buffered in a `wx.Bitmap` then your
4363 EVT_PAINT handler can be as simple as just creating a
4364 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4365 automatically when it is destroyed. For example::
4366
4367 def OnPaint(self, event):
4368 dc = wx.BufferedPaintDC(self, self.buffer)
4369
4370
4371
e2950dbb
RD
4372
4373
f5b96ee1 4374 """
d55e5bfc
RD
4375 def __repr__(self):
4376 return "<%s.%s; proxy of C++ wxBufferedPaintDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4377 def __init__(self, *args, **kwargs):
f5b96ee1 4378 """
e2950dbb 4379 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
f5b96ee1
RD
4380
4381 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4382 provide the bitmap to be used for buffering or let this object create
4383 one internally (in the latter case, the size of the client part of the
4384 window is automatically used).
4385
4386
4387 """
d55e5bfc
RD
4388 newobj = _gdi_.new_BufferedPaintDC(*args, **kwargs)
4389 self.this = newobj.this
4390 self.thisown = 1
4391 del newobj.thisown
4392
4393class BufferedPaintDCPtr(BufferedPaintDC):
4394 def __init__(self, this):
4395 self.this = this
4396 if not hasattr(self,"thisown"): self.thisown = 0
4397 self.__class__ = BufferedPaintDC
4398_gdi_.BufferedPaintDC_swigregister(BufferedPaintDCPtr)
4399
4400#---------------------------------------------------------------------------
4401
4402class ScreenDC(DC):
f5b96ee1
RD
4403 """
4404 A wxScreenDC can be used to paint anywhere on the screen. This should
4405 normally be constructed as a temporary stack object; don't store a
4406 wxScreenDC object.
4407
4408 """
d55e5bfc
RD
4409 def __repr__(self):
4410 return "<%s.%s; proxy of C++ wxScreenDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4411 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4412 """
4413 __init__(self) -> ScreenDC
4414
4415 A wxScreenDC can be used to paint anywhere on the screen. This should
4416 normally be constructed as a temporary stack object; don't store a
4417 wxScreenDC object.
4418
4419 """
d55e5bfc
RD
4420 newobj = _gdi_.new_ScreenDC(*args, **kwargs)
4421 self.this = newobj.this
4422 self.thisown = 1
4423 del newobj.thisown
4424 def StartDrawingOnTopWin(*args, **kwargs):
f5b96ee1
RD
4425 """
4426 StartDrawingOnTopWin(self, Window window) -> bool
4427
4428 Specify that the area of the screen to be drawn upon coincides with
4429 the given window.
4430
4431 :see: `EndDrawingOnTop`
4432 """
d55e5bfc
RD
4433 return _gdi_.ScreenDC_StartDrawingOnTopWin(*args, **kwargs)
4434
4435 def StartDrawingOnTop(*args, **kwargs):
f5b96ee1
RD
4436 """
4437 StartDrawingOnTop(self, Rect rect=None) -> bool
4438
4439 Specify that the area is the given rectangle, or the whole screen if
4440 ``None`` is passed.
4441
4442 :see: `EndDrawingOnTop`
4443 """
d55e5bfc
RD
4444 return _gdi_.ScreenDC_StartDrawingOnTop(*args, **kwargs)
4445
4446 def EndDrawingOnTop(*args, **kwargs):
f5b96ee1
RD
4447 """
4448 EndDrawingOnTop(self) -> bool
4449
4450 Use this in conjunction with `StartDrawingOnTop` or
4451 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4452 top of existing windows. Without this, some window systems (such as X)
4453 only allow drawing to take place underneath other windows.
4454
4455 You might use this pair of functions when implementing a drag feature,
4456 for example as in the `wx.SplitterWindow` implementation.
4457
4458 These functions are probably obsolete since the X implementations
4459 allow drawing directly on the screen now. However, the fact that this
4460 function allows the screen to be refreshed afterwards may be useful
4461 to some applications.
4462 """
d55e5bfc
RD
4463 return _gdi_.ScreenDC_EndDrawingOnTop(*args, **kwargs)
4464
4465
4466class ScreenDCPtr(ScreenDC):
4467 def __init__(self, this):
4468 self.this = this
4469 if not hasattr(self,"thisown"): self.thisown = 0
4470 self.__class__ = ScreenDC
4471_gdi_.ScreenDC_swigregister(ScreenDCPtr)
4472
4473#---------------------------------------------------------------------------
4474
4475class ClientDC(DC):
f5b96ee1
RD
4476 """
4477 A wx.ClientDC must be constructed if an application wishes to paint on
4478 the client area of a window from outside an EVT_PAINT event. This should
4479 normally be constructed as a temporary stack object; don't store a
4480 wx.ClientDC object long term.
4481
4482 To draw on a window from within an EVT_PAINT handler, construct a
4483 `wx.PaintDC` object.
4484
4485 To draw on the whole window including decorations, construct a
4486 `wx.WindowDC` object (Windows only).
4487
4488 """
d55e5bfc
RD
4489 def __repr__(self):
4490 return "<%s.%s; proxy of C++ wxClientDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4491 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4492 """
4493 __init__(self, Window win) -> ClientDC
4494
4495 Constructor. Pass the window on which you wish to paint.
4496 """
d55e5bfc
RD
4497 newobj = _gdi_.new_ClientDC(*args, **kwargs)
4498 self.this = newobj.this
4499 self.thisown = 1
4500 del newobj.thisown
4501
4502class ClientDCPtr(ClientDC):
4503 def __init__(self, this):
4504 self.this = this
4505 if not hasattr(self,"thisown"): self.thisown = 0
4506 self.__class__ = ClientDC
4507_gdi_.ClientDC_swigregister(ClientDCPtr)
4508
4509#---------------------------------------------------------------------------
4510
4511class PaintDC(DC):
f5b96ee1
RD
4512 """
4513 A wx.PaintDC must be constructed if an application wishes to paint on
4514 the client area of a window from within an EVT_PAINT event
4515 handler. This should normally be constructed as a temporary stack
4516 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4517 handler, you **must** create a wx.PaintDC object within it even if you
4518 don't actually use it.
4519
4520 Using wx.PaintDC within EVT_PAINT handlers is important because it
4521 automatically sets the clipping area to the damaged area of the
4522 window. Attempts to draw outside this area do not appear.
4523
4524 To draw on a window from outside EVT_PAINT handlers, construct a
4525 `wx.ClientDC` object.
4526
4527 """
d55e5bfc
RD
4528 def __repr__(self):
4529 return "<%s.%s; proxy of C++ wxPaintDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4530 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4531 """
4532 __init__(self, Window win) -> PaintDC
4533
4534 Constructor. Pass the window on which you wish to paint.
4535 """
d55e5bfc
RD
4536 newobj = _gdi_.new_PaintDC(*args, **kwargs)
4537 self.this = newobj.this
4538 self.thisown = 1
4539 del newobj.thisown
4540
4541class PaintDCPtr(PaintDC):
4542 def __init__(self, this):
4543 self.this = this
4544 if not hasattr(self,"thisown"): self.thisown = 0
4545 self.__class__ = PaintDC
4546_gdi_.PaintDC_swigregister(PaintDCPtr)
4547
4548#---------------------------------------------------------------------------
4549
4550class WindowDC(DC):
f5b96ee1
RD
4551 """
4552 A wx.WindowDC must be constructed if an application wishes to paint on
4553 the whole area of a window (client and decorations). This should
4554 normally be constructed as a temporary stack object; don't store a
4555 wx.WindowDC object.
4556 """
d55e5bfc
RD
4557 def __repr__(self):
4558 return "<%s.%s; proxy of C++ wxWindowDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4559 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4560 """
4561 __init__(self, Window win) -> WindowDC
4562
4563 Constructor. Pass the window on which you wish to paint.
4564 """
d55e5bfc
RD
4565 newobj = _gdi_.new_WindowDC(*args, **kwargs)
4566 self.this = newobj.this
4567 self.thisown = 1
4568 del newobj.thisown
4569
4570class WindowDCPtr(WindowDC):
4571 def __init__(self, this):
4572 self.this = this
4573 if not hasattr(self,"thisown"): self.thisown = 0
4574 self.__class__ = WindowDC
4575_gdi_.WindowDC_swigregister(WindowDCPtr)
4576
4577#---------------------------------------------------------------------------
4578
4579class MirrorDC(DC):
f5b96ee1
RD
4580 """
4581 wx.MirrorDC is a simple wrapper class which is always associated with a
4582 real `wx.DC` object and either forwards all of its operations to it
4583 without changes (no mirroring takes place) or exchanges x and y
4584 coordinates which makes it possible to reuse the same code to draw a
4585 figure and its mirror -- i.e. reflection related to the diagonal line
4586 x == y.
4587 """
d55e5bfc
RD
4588 def __repr__(self):
4589 return "<%s.%s; proxy of C++ wxMirrorDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4590 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4591 """
4592 __init__(self, DC dc, bool mirror) -> MirrorDC
4593
4594 Creates a mirrored DC associated with the real *dc*. Everything drawn
4595 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4596 *mirror* is True.
4597 """
d55e5bfc
RD
4598 newobj = _gdi_.new_MirrorDC(*args, **kwargs)
4599 self.this = newobj.this
4600 self.thisown = 1
4601 del newobj.thisown
4602
4603class MirrorDCPtr(MirrorDC):
4604 def __init__(self, this):
4605 self.this = this
4606 if not hasattr(self,"thisown"): self.thisown = 0
4607 self.__class__ = MirrorDC
4608_gdi_.MirrorDC_swigregister(MirrorDCPtr)
4609
4610#---------------------------------------------------------------------------
4611
4612class PostScriptDC(DC):
f5b96ee1 4613 """This is a `wx.DC` that can write to PostScript files on any platform."""
d55e5bfc
RD
4614 def __repr__(self):
4615 return "<%s.%s; proxy of C++ wxPostScriptDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4616 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4617 """
4618 __init__(self, wxPrintData printData) -> PostScriptDC
4619
4620 Constructs a PostScript printer device context from a `wx.PrintData`
4621 object.
4622 """
d55e5bfc
RD
4623 newobj = _gdi_.new_PostScriptDC(*args, **kwargs)
4624 self.this = newobj.this
4625 self.thisown = 1
4626 del newobj.thisown
4627 def GetPrintData(*args, **kwargs):
4628 """GetPrintData(self) -> wxPrintData"""
4629 return _gdi_.PostScriptDC_GetPrintData(*args, **kwargs)
4630
4631 def SetPrintData(*args, **kwargs):
4632 """SetPrintData(self, wxPrintData data)"""
4633 return _gdi_.PostScriptDC_SetPrintData(*args, **kwargs)
4634
4635 def SetResolution(*args, **kwargs):
f5b96ee1
RD
4636 """
4637 SetResolution(int ppi)
4638
4639 Set resolution (in pixels per inch) that will be used in PostScript
4640 output. Default is 720ppi.
4641 """
d55e5bfc
RD
4642 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
4643
4644 SetResolution = staticmethod(SetResolution)
4645 def GetResolution(*args, **kwargs):
f5b96ee1
RD
4646 """
4647 GetResolution() -> int
4648
4649 Return resolution used in PostScript output.
4650 """
d55e5bfc
RD
4651 return _gdi_.PostScriptDC_GetResolution(*args, **kwargs)
4652
4653 GetResolution = staticmethod(GetResolution)
4654
4655class PostScriptDCPtr(PostScriptDC):
4656 def __init__(self, this):
4657 self.this = this
4658 if not hasattr(self,"thisown"): self.thisown = 0
4659 self.__class__ = PostScriptDC
4660_gdi_.PostScriptDC_swigregister(PostScriptDCPtr)
4661
4662def PostScriptDC_SetResolution(*args, **kwargs):
f5b96ee1
RD
4663 """
4664 PostScriptDC_SetResolution(int ppi)
4665
4666 Set resolution (in pixels per inch) that will be used in PostScript
4667 output. Default is 720ppi.
4668 """
d55e5bfc
RD
4669 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
4670
4671def PostScriptDC_GetResolution(*args, **kwargs):
f5b96ee1
RD
4672 """
4673 PostScriptDC_GetResolution() -> int
4674
4675 Return resolution used in PostScript output.
4676 """
d55e5bfc
RD
4677 return _gdi_.PostScriptDC_GetResolution(*args, **kwargs)
4678
4679#---------------------------------------------------------------------------
4680
4681class MetaFile(_core.Object):
093d3ff1 4682 """Proxy of C++ MetaFile class"""
d55e5bfc
RD
4683 def __repr__(self):
4684 return "<%s.%s; proxy of C++ wxMetaFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4685 def __init__(self, *args, **kwargs):
4686 """__init__(self, String filename=EmptyString) -> MetaFile"""
4687 newobj = _gdi_.new_MetaFile(*args, **kwargs)
4688 self.this = newobj.this
4689 self.thisown = 1
4690 del newobj.thisown
4691 def __del__(self, destroy=_gdi_.delete_MetaFile):
4692 """__del__(self)"""
4693 try:
4694 if self.thisown: destroy(self)
4695 except: pass
4696
4697 def Ok(*args, **kwargs):
4698 """Ok(self) -> bool"""
4699 return _gdi_.MetaFile_Ok(*args, **kwargs)
4700
4701 def SetClipboard(*args, **kwargs):
4702 """SetClipboard(self, int width=0, int height=0) -> bool"""
4703 return _gdi_.MetaFile_SetClipboard(*args, **kwargs)
4704
4705 def GetSize(*args, **kwargs):
4706 """GetSize(self) -> Size"""
4707 return _gdi_.MetaFile_GetSize(*args, **kwargs)
4708
4709 def GetWidth(*args, **kwargs):
4710 """GetWidth(self) -> int"""
4711 return _gdi_.MetaFile_GetWidth(*args, **kwargs)
4712
4713 def GetHeight(*args, **kwargs):
4714 """GetHeight(self) -> int"""
4715 return _gdi_.MetaFile_GetHeight(*args, **kwargs)
4716
4717 def GetFileName(*args, **kwargs):
4718 """GetFileName(self) -> String"""
4719 return _gdi_.MetaFile_GetFileName(*args, **kwargs)
4720
4721 def __nonzero__(self): return self.Ok()
4722
4723class MetaFilePtr(MetaFile):
4724 def __init__(self, this):
4725 self.this = this
4726 if not hasattr(self,"thisown"): self.thisown = 0
4727 self.__class__ = MetaFile
4728_gdi_.MetaFile_swigregister(MetaFilePtr)
4729
4730class MetaFileDC(DC):
093d3ff1 4731 """Proxy of C++ MetaFileDC class"""
d55e5bfc
RD
4732 def __repr__(self):
4733 return "<%s.%s; proxy of C++ wxMetaFileDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4734 def __init__(self, *args, **kwargs):
4735 """
4736 __init__(self, String filename=EmptyString, int width=0, int height=0,
4737 String description=EmptyString) -> MetaFileDC
4738 """
4739 newobj = _gdi_.new_MetaFileDC(*args, **kwargs)
4740 self.this = newobj.this
4741 self.thisown = 1
4742 del newobj.thisown
4743 def Close(*args, **kwargs):
4744 """Close(self) -> MetaFile"""
4745 return _gdi_.MetaFileDC_Close(*args, **kwargs)
4746
4747
4748class MetaFileDCPtr(MetaFileDC):
4749 def __init__(self, this):
4750 self.this = this
4751 if not hasattr(self,"thisown"): self.thisown = 0
4752 self.__class__ = MetaFileDC
4753_gdi_.MetaFileDC_swigregister(MetaFileDCPtr)
4754
4755class PrinterDC(DC):
093d3ff1 4756 """Proxy of C++ PrinterDC class"""
d55e5bfc
RD
4757 def __repr__(self):
4758 return "<%s.%s; proxy of C++ wxPrinterDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4759 def __init__(self, *args, **kwargs):
4760 """__init__(self, wxPrintData printData) -> PrinterDC"""
4761 newobj = _gdi_.new_PrinterDC(*args, **kwargs)
4762 self.this = newobj.this
4763 self.thisown = 1
4764 del newobj.thisown
4765
4766class PrinterDCPtr(PrinterDC):
4767 def __init__(self, this):
4768 self.this = this
4769 if not hasattr(self,"thisown"): self.thisown = 0
4770 self.__class__ = PrinterDC
4771_gdi_.PrinterDC_swigregister(PrinterDCPtr)
4772
d55e5bfc
RD
4773#---------------------------------------------------------------------------
4774
4775IMAGELIST_DRAW_NORMAL = _gdi_.IMAGELIST_DRAW_NORMAL
4776IMAGELIST_DRAW_TRANSPARENT = _gdi_.IMAGELIST_DRAW_TRANSPARENT
4777IMAGELIST_DRAW_SELECTED = _gdi_.IMAGELIST_DRAW_SELECTED
4778IMAGELIST_DRAW_FOCUSED = _gdi_.IMAGELIST_DRAW_FOCUSED
4779IMAGE_LIST_NORMAL = _gdi_.IMAGE_LIST_NORMAL
4780IMAGE_LIST_SMALL = _gdi_.IMAGE_LIST_SMALL
4781IMAGE_LIST_STATE = _gdi_.IMAGE_LIST_STATE
4782class ImageList(_core.Object):
093d3ff1 4783 """Proxy of C++ ImageList class"""
d55e5bfc
RD
4784 def __repr__(self):
4785 return "<%s.%s; proxy of C++ wxImageList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4786 def __init__(self, *args, **kwargs):
4787 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
4788 newobj = _gdi_.new_ImageList(*args, **kwargs)
4789 self.this = newobj.this
4790 self.thisown = 1
4791 del newobj.thisown
4792 def __del__(self, destroy=_gdi_.delete_ImageList):
4793 """__del__(self)"""
4794 try:
4795 if self.thisown: destroy(self)
4796 except: pass
4797
4798 def Add(*args, **kwargs):
4799 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
4800 return _gdi_.ImageList_Add(*args, **kwargs)
4801
4802 def AddWithColourMask(*args, **kwargs):
4803 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
4804 return _gdi_.ImageList_AddWithColourMask(*args, **kwargs)
4805
4806 def AddIcon(*args, **kwargs):
4807 """AddIcon(self, Icon icon) -> int"""
4808 return _gdi_.ImageList_AddIcon(*args, **kwargs)
4809
b9d6a5f3
RD
4810 def GetBitmap(*args, **kwargs):
4811 """GetBitmap(self, int index) -> Bitmap"""
4812 return _gdi_.ImageList_GetBitmap(*args, **kwargs)
4813
4814 def GetIcon(*args, **kwargs):
4815 """GetIcon(self, int index) -> Icon"""
4816 return _gdi_.ImageList_GetIcon(*args, **kwargs)
4817
d55e5bfc
RD
4818 def Replace(*args, **kwargs):
4819 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
4820 return _gdi_.ImageList_Replace(*args, **kwargs)
4821
4822 def Draw(*args, **kwargs):
4823 """
4824 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
4825 bool solidBackground=False) -> bool
4826 """
4827 return _gdi_.ImageList_Draw(*args, **kwargs)
4828
4829 def GetImageCount(*args, **kwargs):
4830 """GetImageCount(self) -> int"""
4831 return _gdi_.ImageList_GetImageCount(*args, **kwargs)
4832
4833 def Remove(*args, **kwargs):
4834 """Remove(self, int index) -> bool"""
4835 return _gdi_.ImageList_Remove(*args, **kwargs)
4836
4837 def RemoveAll(*args, **kwargs):
4838 """RemoveAll(self) -> bool"""
4839 return _gdi_.ImageList_RemoveAll(*args, **kwargs)
4840
4841 def GetSize(*args, **kwargs):
4842 """GetSize() -> (width,height)"""
4843 return _gdi_.ImageList_GetSize(*args, **kwargs)
4844
4845
4846class ImageListPtr(ImageList):
4847 def __init__(self, this):
4848 self.this = this
4849 if not hasattr(self,"thisown"): self.thisown = 0
4850 self.__class__ = ImageList
4851_gdi_.ImageList_swigregister(ImageListPtr)
4852
4853#---------------------------------------------------------------------------
4854
4855class PenList(_core.Object):
093d3ff1 4856 """Proxy of C++ PenList class"""
d55e5bfc
RD
4857 def __init__(self): raise RuntimeError, "No constructor defined"
4858 def __repr__(self):
4859 return "<%s.%s; proxy of C++ wxPenList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4860 def AddPen(*args, **kwargs):
4861 """AddPen(self, Pen pen)"""
4862 return _gdi_.PenList_AddPen(*args, **kwargs)
4863
4864 def FindOrCreatePen(*args, **kwargs):
4865 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
4866 return _gdi_.PenList_FindOrCreatePen(*args, **kwargs)
4867
4868 def RemovePen(*args, **kwargs):
4869 """RemovePen(self, Pen pen)"""
4870 return _gdi_.PenList_RemovePen(*args, **kwargs)
4871
4872 def GetCount(*args, **kwargs):
4873 """GetCount(self) -> int"""
4874 return _gdi_.PenList_GetCount(*args, **kwargs)
4875
4876
4877class PenListPtr(PenList):
4878 def __init__(self, this):
4879 self.this = this
4880 if not hasattr(self,"thisown"): self.thisown = 0
4881 self.__class__ = PenList
4882_gdi_.PenList_swigregister(PenListPtr)
4883cvar = _gdi_.cvar
4884NORMAL_FONT = cvar.NORMAL_FONT
4885SMALL_FONT = cvar.SMALL_FONT
4886ITALIC_FONT = cvar.ITALIC_FONT
4887SWISS_FONT = cvar.SWISS_FONT
4888RED_PEN = cvar.RED_PEN
4889CYAN_PEN = cvar.CYAN_PEN
4890GREEN_PEN = cvar.GREEN_PEN
4891BLACK_PEN = cvar.BLACK_PEN
4892WHITE_PEN = cvar.WHITE_PEN
4893TRANSPARENT_PEN = cvar.TRANSPARENT_PEN
4894BLACK_DASHED_PEN = cvar.BLACK_DASHED_PEN
4895GREY_PEN = cvar.GREY_PEN
4896MEDIUM_GREY_PEN = cvar.MEDIUM_GREY_PEN
4897LIGHT_GREY_PEN = cvar.LIGHT_GREY_PEN
4898BLUE_BRUSH = cvar.BLUE_BRUSH
4899GREEN_BRUSH = cvar.GREEN_BRUSH
4900WHITE_BRUSH = cvar.WHITE_BRUSH
4901BLACK_BRUSH = cvar.BLACK_BRUSH
4902TRANSPARENT_BRUSH = cvar.TRANSPARENT_BRUSH
4903CYAN_BRUSH = cvar.CYAN_BRUSH
4904RED_BRUSH = cvar.RED_BRUSH
4905GREY_BRUSH = cvar.GREY_BRUSH
4906MEDIUM_GREY_BRUSH = cvar.MEDIUM_GREY_BRUSH
4907LIGHT_GREY_BRUSH = cvar.LIGHT_GREY_BRUSH
4908BLACK = cvar.BLACK
4909WHITE = cvar.WHITE
4910RED = cvar.RED
4911BLUE = cvar.BLUE
4912GREEN = cvar.GREEN
4913CYAN = cvar.CYAN
4914LIGHT_GREY = cvar.LIGHT_GREY
4915STANDARD_CURSOR = cvar.STANDARD_CURSOR
4916HOURGLASS_CURSOR = cvar.HOURGLASS_CURSOR
4917CROSS_CURSOR = cvar.CROSS_CURSOR
4918NullBitmap = cvar.NullBitmap
4919NullIcon = cvar.NullIcon
4920NullCursor = cvar.NullCursor
4921NullPen = cvar.NullPen
4922NullBrush = cvar.NullBrush
4923NullPalette = cvar.NullPalette
4924NullFont = cvar.NullFont
4925NullColour = cvar.NullColour
4926
4927class BrushList(_core.Object):
093d3ff1 4928 """Proxy of C++ BrushList class"""
d55e5bfc
RD
4929 def __init__(self): raise RuntimeError, "No constructor defined"
4930 def __repr__(self):
4931 return "<%s.%s; proxy of C++ wxBrushList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4932 def AddBrush(*args, **kwargs):
4933 """AddBrush(self, Brush brush)"""
4934 return _gdi_.BrushList_AddBrush(*args, **kwargs)
4935
4936 def FindOrCreateBrush(*args, **kwargs):
ea939623 4937 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
d55e5bfc
RD
4938 return _gdi_.BrushList_FindOrCreateBrush(*args, **kwargs)
4939
4940 def RemoveBrush(*args, **kwargs):
4941 """RemoveBrush(self, Brush brush)"""
4942 return _gdi_.BrushList_RemoveBrush(*args, **kwargs)
4943
4944 def GetCount(*args, **kwargs):
4945 """GetCount(self) -> int"""
4946 return _gdi_.BrushList_GetCount(*args, **kwargs)
4947
4948
4949class BrushListPtr(BrushList):
4950 def __init__(self, this):
4951 self.this = this
4952 if not hasattr(self,"thisown"): self.thisown = 0
4953 self.__class__ = BrushList
4954_gdi_.BrushList_swigregister(BrushListPtr)
4955
4956class ColourDatabase(_core.Object):
093d3ff1 4957 """Proxy of C++ ColourDatabase class"""
d55e5bfc
RD
4958 def __repr__(self):
4959 return "<%s.%s; proxy of C++ wxColourDatabase instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
4960 def __init__(self, *args, **kwargs):
4961 """__init__(self) -> ColourDatabase"""
4962 newobj = _gdi_.new_ColourDatabase(*args, **kwargs)
4963 self.this = newobj.this
4964 self.thisown = 1
4965 del newobj.thisown
4966 def __del__(self, destroy=_gdi_.delete_ColourDatabase):
4967 """__del__(self)"""
4968 try:
4969 if self.thisown: destroy(self)
4970 except: pass
4971
4972 def Find(*args, **kwargs):
4973 """Find(self, String name) -> Colour"""
4974 return _gdi_.ColourDatabase_Find(*args, **kwargs)
4975
4976 def FindName(*args, **kwargs):
4977 """FindName(self, Colour colour) -> String"""
4978 return _gdi_.ColourDatabase_FindName(*args, **kwargs)
4979
4980 FindColour = Find
4981 def AddColour(*args, **kwargs):
4982 """AddColour(self, String name, Colour colour)"""
4983 return _gdi_.ColourDatabase_AddColour(*args, **kwargs)
4984
4985 def Append(*args, **kwargs):
4986 """Append(self, String name, int red, int green, int blue)"""
4987 return _gdi_.ColourDatabase_Append(*args, **kwargs)
4988
4989
4990class ColourDatabasePtr(ColourDatabase):
4991 def __init__(self, this):
4992 self.this = this
4993 if not hasattr(self,"thisown"): self.thisown = 0
4994 self.__class__ = ColourDatabase
4995_gdi_.ColourDatabase_swigregister(ColourDatabasePtr)
4996
4997class FontList(_core.Object):
093d3ff1 4998 """Proxy of C++ FontList class"""
d55e5bfc
RD
4999 def __init__(self): raise RuntimeError, "No constructor defined"
5000 def __repr__(self):
5001 return "<%s.%s; proxy of C++ wxFontList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5002 def AddFont(*args, **kwargs):
5003 """AddFont(self, Font font)"""
5004 return _gdi_.FontList_AddFont(*args, **kwargs)
5005
5006 def FindOrCreateFont(*args, **kwargs):
5007 """
5008 FindOrCreateFont(self, int point_size, int family, int style, int weight,
5009 bool underline=False, String facename=EmptyString,
5010 int encoding=FONTENCODING_DEFAULT) -> Font
5011 """
5012 return _gdi_.FontList_FindOrCreateFont(*args, **kwargs)
5013
5014 def RemoveFont(*args, **kwargs):
5015 """RemoveFont(self, Font font)"""
5016 return _gdi_.FontList_RemoveFont(*args, **kwargs)
5017
5018 def GetCount(*args, **kwargs):
5019 """GetCount(self) -> int"""
5020 return _gdi_.FontList_GetCount(*args, **kwargs)
5021
5022
5023class FontListPtr(FontList):
5024 def __init__(self, this):
5025 self.this = this
5026 if not hasattr(self,"thisown"): self.thisown = 0
5027 self.__class__ = FontList
5028_gdi_.FontList_swigregister(FontListPtr)
5029
5030#---------------------------------------------------------------------------
5031
5032NullColor = NullColour
5033#---------------------------------------------------------------------------
5034
5035class Effects(_core.Object):
093d3ff1 5036 """Proxy of C++ Effects class"""
d55e5bfc
RD
5037 def __repr__(self):
5038 return "<%s.%s; proxy of C++ wxEffects instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5039 def __init__(self, *args, **kwargs):
5040 """__init__(self) -> Effects"""
5041 newobj = _gdi_.new_Effects(*args, **kwargs)
5042 self.this = newobj.this
5043 self.thisown = 1
5044 del newobj.thisown
5045 def GetHighlightColour(*args, **kwargs):
5046 """GetHighlightColour(self) -> Colour"""
5047 return _gdi_.Effects_GetHighlightColour(*args, **kwargs)
5048
5049 def GetLightShadow(*args, **kwargs):
5050 """GetLightShadow(self) -> Colour"""
5051 return _gdi_.Effects_GetLightShadow(*args, **kwargs)
5052
5053 def GetFaceColour(*args, **kwargs):
5054 """GetFaceColour(self) -> Colour"""
5055 return _gdi_.Effects_GetFaceColour(*args, **kwargs)
5056
5057 def GetMediumShadow(*args, **kwargs):
5058 """GetMediumShadow(self) -> Colour"""
5059 return _gdi_.Effects_GetMediumShadow(*args, **kwargs)
5060
5061 def GetDarkShadow(*args, **kwargs):
5062 """GetDarkShadow(self) -> Colour"""
5063 return _gdi_.Effects_GetDarkShadow(*args, **kwargs)
5064
5065 def SetHighlightColour(*args, **kwargs):
5066 """SetHighlightColour(self, Colour c)"""
5067 return _gdi_.Effects_SetHighlightColour(*args, **kwargs)
5068
5069 def SetLightShadow(*args, **kwargs):
5070 """SetLightShadow(self, Colour c)"""
5071 return _gdi_.Effects_SetLightShadow(*args, **kwargs)
5072
5073 def SetFaceColour(*args, **kwargs):
5074 """SetFaceColour(self, Colour c)"""
5075 return _gdi_.Effects_SetFaceColour(*args, **kwargs)
5076
5077 def SetMediumShadow(*args, **kwargs):
5078 """SetMediumShadow(self, Colour c)"""
5079 return _gdi_.Effects_SetMediumShadow(*args, **kwargs)
5080
5081 def SetDarkShadow(*args, **kwargs):
5082 """SetDarkShadow(self, Colour c)"""
5083 return _gdi_.Effects_SetDarkShadow(*args, **kwargs)
5084
5085 def Set(*args, **kwargs):
5086 """
5087 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
5088 Colour mediumShadow, Colour darkShadow)
5089 """
5090 return _gdi_.Effects_Set(*args, **kwargs)
5091
5092 def DrawSunkenEdge(*args, **kwargs):
5093 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
5094 return _gdi_.Effects_DrawSunkenEdge(*args, **kwargs)
5095
5096 def TileBitmap(*args, **kwargs):
5097 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
5098 return _gdi_.Effects_TileBitmap(*args, **kwargs)
5099
5100
5101class EffectsPtr(Effects):
5102 def __init__(self, this):
5103 self.this = this
5104 if not hasattr(self,"thisown"): self.thisown = 0
5105 self.__class__ = Effects
5106_gdi_.Effects_swigregister(EffectsPtr)
5107TheFontList = cvar.TheFontList
5108ThePenList = cvar.ThePenList
5109TheBrushList = cvar.TheBrushList
5110TheColourDatabase = cvar.TheColourDatabase
5111
be9b1dca
RD
5112#---------------------------------------------------------------------------
5113
5114CONTROL_DISABLED = _gdi_.CONTROL_DISABLED
5115CONTROL_FOCUSED = _gdi_.CONTROL_FOCUSED
5116CONTROL_PRESSED = _gdi_.CONTROL_PRESSED
5117CONTROL_ISDEFAULT = _gdi_.CONTROL_ISDEFAULT
5118CONTROL_ISSUBMENU = _gdi_.CONTROL_ISSUBMENU
5119CONTROL_EXPANDED = _gdi_.CONTROL_EXPANDED
5120CONTROL_CURRENT = _gdi_.CONTROL_CURRENT
5121CONTROL_SELECTED = _gdi_.CONTROL_SELECTED
5122CONTROL_CHECKED = _gdi_.CONTROL_CHECKED
5123CONTROL_CHECKABLE = _gdi_.CONTROL_CHECKABLE
5124CONTROL_UNDETERMINED = _gdi_.CONTROL_UNDETERMINED
5125CONTROL_FLAGS_MASK = _gdi_.CONTROL_FLAGS_MASK
5126CONTROL_DIRTY = _gdi_.CONTROL_DIRTY
5127class SplitterRenderParams(object):
5128 """
5129 This is just a simple struct used as a return value of
5130 `wx.RendererNative.GetSplitterParams` and contains some platform
5131 specific metrics about splitters.
5132
5133 * widthSash: the width of the splitter sash.
5134 * border: the width of the border of the splitter window.
5135 * isHotSensitive: ``True`` if the splitter changes its
5136 appearance when the mouse is over it.
5137
5138
5139 """
5140 def __repr__(self):
5141 return "<%s.%s; proxy of C++ wxSplitterRenderParams instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5142 def __init__(self, *args, **kwargs):
5143 """
5144 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5145
5146 This is just a simple struct used as a return value of
5147 `wx.RendererNative.GetSplitterParams` and contains some platform
5148 specific metrics about splitters.
5149
5150 * widthSash: the width of the splitter sash.
5151 * border: the width of the border of the splitter window.
5152 * isHotSensitive: ``True`` if the splitter changes its
5153 appearance when the mouse is over it.
5154
5155
5156 """
5157 newobj = _gdi_.new_SplitterRenderParams(*args, **kwargs)
5158 self.this = newobj.this
5159 self.thisown = 1
5160 del newobj.thisown
5161 def __del__(self, destroy=_gdi_.delete_SplitterRenderParams):
5162 """__del__(self)"""
5163 try:
5164 if self.thisown: destroy(self)
5165 except: pass
5166
5167 widthSash = property(_gdi_.SplitterRenderParams_widthSash_get)
5168 border = property(_gdi_.SplitterRenderParams_border_get)
5169 isHotSensitive = property(_gdi_.SplitterRenderParams_isHotSensitive_get)
5170
5171class SplitterRenderParamsPtr(SplitterRenderParams):
5172 def __init__(self, this):
5173 self.this = this
5174 if not hasattr(self,"thisown"): self.thisown = 0
5175 self.__class__ = SplitterRenderParams
5176_gdi_.SplitterRenderParams_swigregister(SplitterRenderParamsPtr)
5177
5178class RendererVersion(object):
5179 """
5180 This simple struct represents the `wx.RendererNative` interface
5181 version and is only used as the return value of
5182 `wx.RendererNative.GetVersion`.
5183 """
5184 def __repr__(self):
5185 return "<%s.%s; proxy of C++ wxRendererVersion instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5186 def __init__(self, *args, **kwargs):
5187 """
5188 __init__(self, int version_, int age_) -> RendererVersion
5189
5190 This simple struct represents the `wx.RendererNative` interface
5191 version and is only used as the return value of
5192 `wx.RendererNative.GetVersion`.
5193 """
5194 newobj = _gdi_.new_RendererVersion(*args, **kwargs)
5195 self.this = newobj.this
5196 self.thisown = 1
5197 del newobj.thisown
5198 def __del__(self, destroy=_gdi_.delete_RendererVersion):
5199 """__del__(self)"""
5200 try:
5201 if self.thisown: destroy(self)
5202 except: pass
5203
5204 Current_Version = _gdi_.RendererVersion_Current_Version
5205 Current_Age = _gdi_.RendererVersion_Current_Age
5206 def IsCompatible(*args, **kwargs):
5207 """IsCompatible(RendererVersion ver) -> bool"""
5208 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5209
5210 IsCompatible = staticmethod(IsCompatible)
5211 version = property(_gdi_.RendererVersion_version_get)
5212 age = property(_gdi_.RendererVersion_age_get)
5213
5214class RendererVersionPtr(RendererVersion):
5215 def __init__(self, this):
5216 self.this = this
5217 if not hasattr(self,"thisown"): self.thisown = 0
5218 self.__class__ = RendererVersion
5219_gdi_.RendererVersion_swigregister(RendererVersionPtr)
5220
5221def RendererVersion_IsCompatible(*args, **kwargs):
5222 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5223 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5224
5225class RendererNative(object):
5226 """
5227 One of the design principles of wxWidgets is to use the native widgets
5228 on every platform in order to be as close to the native look and feel
5229 on every platform. However there are still cases when some generic
5230 widgets are needed for various reasons, but it can sometimes take a
5231 lot of messy work to make them conform to the native LnF.
5232
5233 The wx.RendererNative class is a collection of functions that have
5234 platform-specific implementations for drawing certain parts of
5235 genereic controls in ways that are as close to the native look as
5236 possible.
5237
5238 """
5239 def __init__(self): raise RuntimeError, "No constructor defined"
5240 def __repr__(self):
5241 return "<%s.%s; proxy of C++ wxRendererNative instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5242 def DrawHeaderButton(*args, **kwargs):
5243 """
5244 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0)
5245
5246 Draw the header control button (such as whar is used by `wx.ListCtrl`
5247 in report mode.)
5248 """
5249 return _gdi_.RendererNative_DrawHeaderButton(*args, **kwargs)
5250
5251 def DrawTreeItemButton(*args, **kwargs):
5252 """
5253 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5254
5255 Draw the expanded/collapsed icon for a tree control item.
5256 """
5257 return _gdi_.RendererNative_DrawTreeItemButton(*args, **kwargs)
5258
5259 def DrawSplitterBorder(*args, **kwargs):
5260 """
5261 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5262
5263 Draw the border for a sash window: this border must be such that the
5264 sash drawn by `DrawSplitterSash` blends into it well.
5265 """
5266 return _gdi_.RendererNative_DrawSplitterBorder(*args, **kwargs)
5267
5268 def DrawSplitterSash(*args, **kwargs):
5269 """
5270 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5271 int flags=0)
5272
5273 Draw a sash. The orient parameter defines whether the sash should be
5274 vertical or horizontal and how the position should be interpreted.
5275 """
5276 return _gdi_.RendererNative_DrawSplitterSash(*args, **kwargs)
5277
5278 def DrawComboBoxDropButton(*args, **kwargs):
5279 """
5280 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5281
5282 Draw a button like the one used by `wx.ComboBox` to show a drop down
5283 window. The usual appearance is a downwards pointing arrow.
5284
5285 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5286 ``wx.CONTROL_CURRENT`` bits set.
5287 """
5288 return _gdi_.RendererNative_DrawComboBoxDropButton(*args, **kwargs)
5289
5290 def DrawDropArrow(*args, **kwargs):
5291 """
5292 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5293
5294 Draw a drop down arrow that is suitable for use outside a combo
5295 box. Arrow will have a transparent background.
5296
5297 ``rect`` is not entirely filled by the arrow. Instead, you should use
5298 bounding rectangle of a drop down button which arrow matches the size
5299 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5300 ``wx.CONTROL_CURRENT`` bit set.
5301 """
5302 return _gdi_.RendererNative_DrawDropArrow(*args, **kwargs)
5303
5304 def GetSplitterParams(*args, **kwargs):
5305 """
5306 GetSplitterParams(self, Window win) -> SplitterRenderParams
5307
5308 Get the splitter parameters, see `wx.SplitterRenderParams`.
5309 """
5310 return _gdi_.RendererNative_GetSplitterParams(*args, **kwargs)
5311
5312 def Get(*args, **kwargs):
5313 """
5314 Get() -> RendererNative
5315
5316 Return the currently used renderer
5317 """
5318 return _gdi_.RendererNative_Get(*args, **kwargs)
5319
5320 Get = staticmethod(Get)
5321 def GetGeneric(*args, **kwargs):
5322 """
5323 GetGeneric() -> RendererNative
5324
5325 Return the generic implementation of the renderer. Under some
5326 platforms, this is the default renderer implementation, others have
5327 platform-specific default renderer which can be retrieved by calling
5328 `GetDefault`.
5329 """
5330 return _gdi_.RendererNative_GetGeneric(*args, **kwargs)
5331
5332 GetGeneric = staticmethod(GetGeneric)
5333 def GetDefault(*args, **kwargs):
5334 """
5335 GetDefault() -> RendererNative
5336
5337 Return the default (native) implementation for this platform -- this
5338 is also the one used by default but this may be changed by calling `Set`
5339 in which case the return value of this method may be different from
5340 the return value of `Get`.
5341 """
5342 return _gdi_.RendererNative_GetDefault(*args, **kwargs)
5343
5344 GetDefault = staticmethod(GetDefault)
5345 def Set(*args, **kwargs):
5346 """
5347 Set(RendererNative renderer) -> RendererNative
5348
5349 Set the renderer to use, passing None reverts to using the default
5350 renderer. Returns the previous renderer used with Set or None.
5351 """
5352 return _gdi_.RendererNative_Set(*args, **kwargs)
5353
5354 Set = staticmethod(Set)
5355 def GetVersion(*args, **kwargs):
5356 """
5357 GetVersion(self) -> RendererVersion
5358
5359 Returns the version of the renderer. Will be used for ensuring
5360 compatibility of dynamically loaded renderers.
5361 """
5362 return _gdi_.RendererNative_GetVersion(*args, **kwargs)
5363
5364
5365class RendererNativePtr(RendererNative):
5366 def __init__(self, this):
5367 self.this = this
5368 if not hasattr(self,"thisown"): self.thisown = 0
5369 self.__class__ = RendererNative
5370_gdi_.RendererNative_swigregister(RendererNativePtr)
5371
5372def RendererNative_Get(*args, **kwargs):
5373 """
5374 RendererNative_Get() -> RendererNative
5375
5376 Return the currently used renderer
5377 """
5378 return _gdi_.RendererNative_Get(*args, **kwargs)
5379
5380def RendererNative_GetGeneric(*args, **kwargs):
5381 """
5382 RendererNative_GetGeneric() -> RendererNative
5383
5384 Return the generic implementation of the renderer. Under some
5385 platforms, this is the default renderer implementation, others have
5386 platform-specific default renderer which can be retrieved by calling
5387 `GetDefault`.
5388 """
5389 return _gdi_.RendererNative_GetGeneric(*args, **kwargs)
5390
5391def RendererNative_GetDefault(*args, **kwargs):
5392 """
5393 RendererNative_GetDefault() -> RendererNative
5394
5395 Return the default (native) implementation for this platform -- this
5396 is also the one used by default but this may be changed by calling `Set`
5397 in which case the return value of this method may be different from
5398 the return value of `Get`.
5399 """
5400 return _gdi_.RendererNative_GetDefault(*args, **kwargs)
5401
5402def RendererNative_Set(*args, **kwargs):
5403 """
5404 RendererNative_Set(RendererNative renderer) -> RendererNative
5405
5406 Set the renderer to use, passing None reverts to using the default
5407 renderer. Returns the previous renderer used with Set or None.
5408 """
5409 return _gdi_.RendererNative_Set(*args, **kwargs)
5410
d55e5bfc 5411
7449af73 5412