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