]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/mac/_gdi.py
Version number bump
[wxWidgets.git] / wxPython / src / mac / _gdi.py
CommitLineData
1bd55598 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_
1bd55598
RD
5import new
6new_instancemethod = new.instancemethod
36ed4f51 7def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
1bd55598 8 if (name == "thisown"): return self.this.own(value)
36ed4f51 9 if (name == "this"):
1bd55598
RD
10 if type(value).__name__ == 'PySwigObject':
11 self.__dict__[name] = value
36ed4f51
RD
12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
1bd55598 15 if (not static) or hasattr(self,name):
36ed4f51
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):
1bd55598 24 if (name == "thisown"): return self.this.own()
36ed4f51
RD
25 method = class_type.__swig_getmethods__.get(name,None)
26 if method: return method(self)
27 raise AttributeError,name
28
1bd55598
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
36ed4f51
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):
1bd55598
RD
46 if (name == "thisown"): return self.this.own(value)
47 if hasattr(self,name) or (name == "this"):
36ed4f51
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):
36ed4f51 59 """Proxy of C++ GDIObject class"""
1bd55598
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"""
1bd55598
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
2131d850
RD
75C2S_NAME = _gdi_.C2S_NAME
76C2S_CSS_SYNTAX = _gdi_.C2S_CSS_SYNTAX
77C2S_HTML_SYNTAX = _gdi_.C2S_HTML_SYNTAX
fc46b7f3
RD
78ALPHA_TRANSPARENT = _gdi_.ALPHA_TRANSPARENT
79ALPHA_OPAQUE = _gdi_.ALPHA_OPAQUE
d55e5bfc
RD
80class Colour(_core.Object):
81 """
15817c7e
RD
82 A colour is an object representing a combination of Red, Green, and
83 Blue (RGB) intensity values, and is used to determine drawing colours,
84 window colours, etc. Valid RGB values are in the range 0 to 255.
d55e5bfc 85
15817c7e 86 In wxPython there are typemaps that will automatically convert from a
32fe5131
RD
87 colour name, from a '#RRGGBB' colour hex value string, or from a 3
88 integer tuple to a wx.Colour object when calling C++ methods that
89 expect a wxColour. This means that the following are all
90 equivallent::
d55e5bfc
RD
91
92 win.SetBackgroundColour(wxColour(0,0,255))
93 win.SetBackgroundColour('BLUE')
94 win.SetBackgroundColour('#0000FF')
32fe5131 95 win.SetBackgroundColour((0,0,255))
d55e5bfc 96
15817c7e
RD
97 Additional colour names and their coresponding values can be added
98 using `wx.ColourDatabase`. Various system colours (as set in the
99 user's system preferences) can be retrieved with
100 `wx.SystemSettings.GetColour`.
101
d55e5bfc 102 """
1bd55598
RD
103 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
104 __repr__ = _swig_repr
105 def __init__(self, *args, **kwargs):
d55e5bfc 106 """
fc46b7f3 107 __init__(self, byte red=0, byte green=0, byte blue=0, byte alpha=ALPHA_OPAQUE) -> Colour
d55e5bfc
RD
108
109 Constructs a colour from red, green and blue values.
15817c7e
RD
110
111 :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
112
d55e5bfc 113 """
1bd55598
RD
114 _gdi_.Colour_swiginit(self,_gdi_.new_Colour(*args, **kwargs))
115 __swig_destroy__ = _gdi_.delete_Colour
116 __del__ = lambda self : None;
d55e5bfc
RD
117 def Red(*args, **kwargs):
118 """
15817c7e 119 Red(self) -> byte
d55e5bfc
RD
120
121 Returns the red intensity.
122 """
123 return _gdi_.Colour_Red(*args, **kwargs)
124
125 def Green(*args, **kwargs):
126 """
15817c7e 127 Green(self) -> byte
d55e5bfc
RD
128
129 Returns the green intensity.
130 """
131 return _gdi_.Colour_Green(*args, **kwargs)
132
133 def Blue(*args, **kwargs):
134 """
15817c7e 135 Blue(self) -> byte
d55e5bfc
RD
136
137 Returns the blue intensity.
138 """
139 return _gdi_.Colour_Blue(*args, **kwargs)
140
fc46b7f3
RD
141 def Alpha(*args, **kwargs):
142 """
143 Alpha(self) -> byte
144
145 Returns the Alpha value.
146 """
147 return _gdi_.Colour_Alpha(*args, **kwargs)
148
d55e5bfc
RD
149 def Ok(*args, **kwargs):
150 """
151 Ok(self) -> bool
152
153 Returns True if the colour object is valid (the colour has been
154 initialised with RGB values).
155 """
156 return _gdi_.Colour_Ok(*args, **kwargs)
157
158 def Set(*args, **kwargs):
159 """
fc46b7f3 160 Set(self, byte red, byte green, byte blue, byte alpha=ALPHA_OPAQUE)
d55e5bfc
RD
161
162 Sets the RGB intensity values.
163 """
164 return _gdi_.Colour_Set(*args, **kwargs)
165
166 def SetRGB(*args, **kwargs):
167 """
168 SetRGB(self, unsigned long colRGB)
169
170 Sets the RGB intensity values from a packed RGB value.
171 """
172 return _gdi_.Colour_SetRGB(*args, **kwargs)
173
174 def SetFromName(*args, **kwargs):
175 """
176 SetFromName(self, String colourName)
177
15817c7e
RD
178 Sets the RGB intensity values using a colour name listed in
179 ``wx.TheColourDatabase``.
d55e5bfc
RD
180 """
181 return _gdi_.Colour_SetFromName(*args, **kwargs)
182
2131d850
RD
183 def GetAsString(*args, **kwargs):
184 """
185 GetAsString(self, long flags=wxC2S_NAME|wxC2S_CSS_SYNTAX) -> String
186
187 Return the colour as a string. Acceptable flags are:
188
189 =================== ==================================
190 wx.C2S_NAME return colour name, when possible
191 wx.C2S_CSS_SYNTAX return colour in rgb(r,g,b) syntax
192 wx.C2S_HTML_SYNTAX return colour in #rrggbb syntax
193 =================== ==================================
194 """
195 return _gdi_.Colour_GetAsString(*args, **kwargs)
196
d55e5bfc
RD
197 def GetPixel(*args, **kwargs):
198 """
199 GetPixel(self) -> long
200
201 Returns a pixel value which is platform-dependent. On Windows, a
15817c7e
RD
202 COLORREF is returned. On X, an allocated pixel value is returned. -1
203 is returned if the pixel is invalid (on X, unallocated).
d55e5bfc
RD
204 """
205 return _gdi_.Colour_GetPixel(*args, **kwargs)
206
207 def __eq__(*args, **kwargs):
208 """
e9d6f3a4 209 __eq__(self, PyObject other) -> bool
d55e5bfc 210
e9d6f3a4 211 Compare colours for equality.
d55e5bfc
RD
212 """
213 return _gdi_.Colour___eq__(*args, **kwargs)
214
215 def __ne__(*args, **kwargs):
216 """
e9d6f3a4 217 __ne__(self, PyObject other) -> bool
d55e5bfc 218
e9d6f3a4 219 Compare colours for inequality.
d55e5bfc
RD
220 """
221 return _gdi_.Colour___ne__(*args, **kwargs)
222
223 def Get(*args, **kwargs):
224 """
225 Get() -> (r, g, b)
226
227 Returns the RGB intensity values as a tuple.
228 """
229 return _gdi_.Colour_Get(*args, **kwargs)
230
231 def GetRGB(*args, **kwargs):
232 """
233 GetRGB(self) -> unsigned long
234
235 Return the colour as a packed RGB value
236 """
237 return _gdi_.Colour_GetRGB(*args, **kwargs)
238
15817c7e 239 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
fc46b7f3
RD
240 def __str__(self): return str(self.Get(True))
241 def __repr__(self): return 'wx.Colour' + str(self.Get(True))
d55e5bfc
RD
242 def __nonzero__(self): return self.Ok()
243 __safe_for_unpickling__ = True
fc46b7f3 244 def __reduce__(self): return (Colour, self.Get(True))
d55e5bfc 245
2bf58437
RD
246 Pixel = property(GetPixel,doc="See `GetPixel`")
247 RGB = property(GetRGB,SetRGB,doc="See `GetRGB` and `SetRGB`")
2131d850 248_gdi_.Colour_swigregister(Colour)
d55e5bfc
RD
249
250def NamedColour(*args, **kwargs):
251 """
252 NamedColour(String colorName) -> Colour
253
15817c7e
RD
254 Constructs a colour object using a colour name listed in
255 ``wx.TheColourDatabase``.
d55e5bfc
RD
256 """
257 val = _gdi_.new_NamedColour(*args, **kwargs)
d55e5bfc
RD
258 return val
259
260def ColourRGB(*args, **kwargs):
261 """
262 ColourRGB(unsigned long colRGB) -> Colour
263
264 Constructs a colour from a packed RGB value.
265 """
266 val = _gdi_.new_ColourRGB(*args, **kwargs)
d55e5bfc
RD
267 return val
268
269Color = Colour
270NamedColor = NamedColour
271ColorRGB = ColourRGB
272
273class Palette(GDIObject):
36ed4f51 274 """Proxy of C++ Palette class"""
1bd55598
RD
275 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
276 __repr__ = _swig_repr
277 def __init__(self, *args, **kwargs):
d55e5bfc 278 """__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette"""
1bd55598
RD
279 _gdi_.Palette_swiginit(self,_gdi_.new_Palette(*args, **kwargs))
280 __swig_destroy__ = _gdi_.delete_Palette
281 __del__ = lambda self : None;
d55e5bfc
RD
282 def GetPixel(*args, **kwargs):
283 """GetPixel(self, byte red, byte green, byte blue) -> int"""
284 return _gdi_.Palette_GetPixel(*args, **kwargs)
285
286 def GetRGB(*args, **kwargs):
070c48b4 287 """GetRGB(self, int pixel) -> (R,G,B)"""
d55e5bfc
RD
288 return _gdi_.Palette_GetRGB(*args, **kwargs)
289
5cbf236d
RD
290 def GetColoursCount(*args, **kwargs):
291 """GetColoursCount(self) -> int"""
292 return _gdi_.Palette_GetColoursCount(*args, **kwargs)
293
d55e5bfc
RD
294 def Ok(*args, **kwargs):
295 """Ok(self) -> bool"""
296 return _gdi_.Palette_Ok(*args, **kwargs)
297
298 def __nonzero__(self): return self.Ok()
33d6fd3b 299 ColoursCount = property(GetColoursCount,doc="See `GetColoursCount`")
2131d850 300_gdi_.Palette_swigregister(Palette)
d55e5bfc
RD
301
302#---------------------------------------------------------------------------
303
304class Pen(GDIObject):
36ed4f51 305 """Proxy of C++ Pen class"""
1bd55598
RD
306 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
307 __repr__ = _swig_repr
308 def __init__(self, *args, **kwargs):
d55e5bfc 309 """__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen"""
1bd55598
RD
310 _gdi_.Pen_swiginit(self,_gdi_.new_Pen(*args, **kwargs))
311 __swig_destroy__ = _gdi_.delete_Pen
312 __del__ = lambda self : None;
d55e5bfc
RD
313 def GetCap(*args, **kwargs):
314 """GetCap(self) -> int"""
315 return _gdi_.Pen_GetCap(*args, **kwargs)
316
317 def GetColour(*args, **kwargs):
318 """GetColour(self) -> Colour"""
319 return _gdi_.Pen_GetColour(*args, **kwargs)
320
321 def GetJoin(*args, **kwargs):
322 """GetJoin(self) -> int"""
323 return _gdi_.Pen_GetJoin(*args, **kwargs)
324
325 def GetStyle(*args, **kwargs):
326 """GetStyle(self) -> int"""
327 return _gdi_.Pen_GetStyle(*args, **kwargs)
328
329 def GetWidth(*args, **kwargs):
330 """GetWidth(self) -> int"""
331 return _gdi_.Pen_GetWidth(*args, **kwargs)
332
333 def Ok(*args, **kwargs):
334 """Ok(self) -> bool"""
335 return _gdi_.Pen_Ok(*args, **kwargs)
336
337 def SetCap(*args, **kwargs):
338 """SetCap(self, int cap_style)"""
339 return _gdi_.Pen_SetCap(*args, **kwargs)
340
341 def SetColour(*args, **kwargs):
342 """SetColour(self, Colour colour)"""
343 return _gdi_.Pen_SetColour(*args, **kwargs)
344
345 def SetJoin(*args, **kwargs):
346 """SetJoin(self, int join_style)"""
347 return _gdi_.Pen_SetJoin(*args, **kwargs)
348
349 def SetStyle(*args, **kwargs):
350 """SetStyle(self, int style)"""
351 return _gdi_.Pen_SetStyle(*args, **kwargs)
352
353 def SetWidth(*args, **kwargs):
354 """SetWidth(self, int width)"""
355 return _gdi_.Pen_SetWidth(*args, **kwargs)
356
357 def SetDashes(*args, **kwargs):
36ed4f51 358 """SetDashes(self, int dashes)"""
d55e5bfc
RD
359 return _gdi_.Pen_SetDashes(*args, **kwargs)
360
361 def GetDashes(*args, **kwargs):
362 """GetDashes(self) -> PyObject"""
363 return _gdi_.Pen_GetDashes(*args, **kwargs)
364
d6c14a4c
RD
365 def _SetDashes(*args, **kwargs):
366 """_SetDashes(self, PyObject _self, PyObject pyDashes)"""
367 return _gdi_.Pen__SetDashes(*args, **kwargs)
368
369 def SetDashes(self, dashes):
370 """
371 Associate a list of dash lengths with the Pen.
372 """
373 self._SetDashes(self, dashes)
374
d55e5bfc
RD
375 def __eq__(*args, **kwargs):
376 """__eq__(self, Pen other) -> bool"""
377 return _gdi_.Pen___eq__(*args, **kwargs)
378
379 def __ne__(*args, **kwargs):
380 """__ne__(self, Pen other) -> bool"""
381 return _gdi_.Pen___ne__(*args, **kwargs)
382
383 def __nonzero__(self): return self.Ok()
33d6fd3b
RD
384 Cap = property(GetCap,SetCap,doc="See `GetCap` and `SetCap`")
385 Colour = property(GetColour,SetColour,doc="See `GetColour` and `SetColour`")
386 Dashes = property(GetDashes,SetDashes,doc="See `GetDashes` and `SetDashes`")
387 Join = property(GetJoin,SetJoin,doc="See `GetJoin` and `SetJoin`")
388 Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`")
389 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
2131d850 390_gdi_.Pen_swigregister(Pen)
d55e5bfc 391
d6c14a4c 392#---------------------------------------------------------------------------
d55e5bfc 393
d6c14a4c
RD
394class Brush(GDIObject):
395 """
396 A brush is a drawing tool for filling in areas. It is used for
397 painting the background of rectangles, ellipses, etc. when drawing on
398 a `wx.DC`. It has a colour and a style.
d55e5bfc 399 """
1bd55598
RD
400 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
401 __repr__ = _swig_repr
402 def __init__(self, *args, **kwargs):
d55e5bfc
RD
403 """
404 __init__(self, Colour colour, int style=SOLID) -> Brush
405
15817c7e 406 Constructs a brush from a `wx.Colour` object and a style.
d55e5bfc 407 """
1bd55598
RD
408 _gdi_.Brush_swiginit(self,_gdi_.new_Brush(*args, **kwargs))
409 __swig_destroy__ = _gdi_.delete_Brush
410 __del__ = lambda self : None;
d55e5bfc 411 def SetColour(*args, **kwargs):
d6c14a4c
RD
412 """
413 SetColour(self, Colour col)
414
415 Set the brush's `wx.Colour`.
416 """
d55e5bfc
RD
417 return _gdi_.Brush_SetColour(*args, **kwargs)
418
419 def SetStyle(*args, **kwargs):
d6c14a4c
RD
420 """
421 SetStyle(self, int style)
422
423 Sets the style of the brush. See `__init__` for a listing of styles.
424 """
d55e5bfc
RD
425 return _gdi_.Brush_SetStyle(*args, **kwargs)
426
427 def SetStipple(*args, **kwargs):
d6c14a4c
RD
428 """
429 SetStipple(self, Bitmap stipple)
430
431 Sets the stipple `wx.Bitmap`.
432 """
d55e5bfc
RD
433 return _gdi_.Brush_SetStipple(*args, **kwargs)
434
435 def GetColour(*args, **kwargs):
d6c14a4c
RD
436 """
437 GetColour(self) -> Colour
438
439 Returns the `wx.Colour` of the brush.
440 """
d55e5bfc
RD
441 return _gdi_.Brush_GetColour(*args, **kwargs)
442
443 def GetStyle(*args, **kwargs):
d6c14a4c
RD
444 """
445 GetStyle(self) -> int
446
447 Returns the style of the brush. See `__init__` for a listing of
448 styles.
449 """
d55e5bfc
RD
450 return _gdi_.Brush_GetStyle(*args, **kwargs)
451
452 def GetStipple(*args, **kwargs):
d6c14a4c
RD
453 """
454 GetStipple(self) -> Bitmap
455
456 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
457 have a wx.STIPPLE style, then the return value may be non-None but an
458 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
459 """
d55e5bfc
RD
460 return _gdi_.Brush_GetStipple(*args, **kwargs)
461
f78cc896
RD
462 def IsHatch(*args, **kwargs):
463 """
464 IsHatch(self) -> bool
465
466 Is the current style a hatch type?
467 """
468 return _gdi_.Brush_IsHatch(*args, **kwargs)
469
d55e5bfc 470 def Ok(*args, **kwargs):
d6c14a4c
RD
471 """
472 Ok(self) -> bool
473
474 Returns True if the brush is initialised and valid.
475 """
d55e5bfc
RD
476 return _gdi_.Brush_Ok(*args, **kwargs)
477
478 def MacGetTheme(*args, **kwargs):
479 """MacGetTheme(self) -> short"""
480 return _gdi_.Brush_MacGetTheme(*args, **kwargs)
481
482 def MacSetTheme(*args, **kwargs):
483 """MacSetTheme(self, short macThemeBrush)"""
484 return _gdi_.Brush_MacSetTheme(*args, **kwargs)
485
486 def __nonzero__(self): return self.Ok()
2bf58437
RD
487 Colour = property(GetColour,SetColour,doc="See `GetColour` and `SetColour`")
488 Stipple = property(GetStipple,SetStipple,doc="See `GetStipple` and `SetStipple`")
489 Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`")
2131d850 490_gdi_.Brush_swigregister(Brush)
d55e5bfc 491
d04418a7
RD
492def BrushFromBitmap(*args, **kwargs):
493 """
494 BrushFromBitmap(Bitmap stippleBitmap) -> Brush
495
496 Constructs a stippled brush using a bitmap.
497 """
498 val = _gdi_.new_BrushFromBitmap(*args, **kwargs)
d04418a7
RD
499 return val
500
d55e5bfc 501class Bitmap(GDIObject):
d6c14a4c
RD
502 """
503 The wx.Bitmap class encapsulates the concept of a platform-dependent
504 bitmap. It can be either monochrome or colour, and either loaded from
505 a file or created dynamically. A bitmap can be selected into a memory
506 device context (instance of `wx.MemoryDC`). This enables the bitmap to
507 be copied to a window or memory device context using `wx.DC.Blit`, or
508 to be used as a drawing surface.
d6c14a4c 509 """
1bd55598
RD
510 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
511 __repr__ = _swig_repr
512 def __init__(self, *args, **kwargs):
d55e5bfc
RD
513 """
514 __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap
515
516 Loads a bitmap from a file.
517 """
1bd55598
RD
518 _gdi_.Bitmap_swiginit(self,_gdi_.new_Bitmap(*args, **kwargs))
519 __swig_destroy__ = _gdi_.delete_Bitmap
520 __del__ = lambda self : None;
d55e5bfc
RD
521 def Ok(*args, **kwargs):
522 """Ok(self) -> bool"""
523 return _gdi_.Bitmap_Ok(*args, **kwargs)
524
525 def GetWidth(*args, **kwargs):
526 """
527 GetWidth(self) -> int
528
529 Gets the width of the bitmap in pixels.
530 """
531 return _gdi_.Bitmap_GetWidth(*args, **kwargs)
532
533 def GetHeight(*args, **kwargs):
534 """
535 GetHeight(self) -> int
536
537 Gets the height of the bitmap in pixels.
538 """
539 return _gdi_.Bitmap_GetHeight(*args, **kwargs)
540
541 def GetDepth(*args, **kwargs):
542 """
543 GetDepth(self) -> int
544
545 Gets the colour depth of the bitmap. A value of 1 indicates a
546 monochrome bitmap.
547 """
548 return _gdi_.Bitmap_GetDepth(*args, **kwargs)
549
550 def GetSize(*args, **kwargs):
551 """
552 GetSize(self) -> Size
553
554 Get the size of the bitmap.
555 """
556 return _gdi_.Bitmap_GetSize(*args, **kwargs)
557
558 def ConvertToImage(*args, **kwargs):
559 """
560 ConvertToImage(self) -> Image
561
d6c14a4c
RD
562 Creates a platform-independent image from a platform-dependent
563 bitmap. This preserves mask information so that bitmaps and images can
564 be converted back and forth without loss in that respect.
d55e5bfc
RD
565 """
566 return _gdi_.Bitmap_ConvertToImage(*args, **kwargs)
567
568 def GetMask(*args, **kwargs):
569 """
570 GetMask(self) -> Mask
571
d6c14a4c
RD
572 Gets the associated mask (if any) which may have been loaded from a
573 file or explpicitly set for the bitmap.
574
575 :see: `SetMask`, `wx.Mask`
576
d55e5bfc
RD
577 """
578 return _gdi_.Bitmap_GetMask(*args, **kwargs)
579
580 def SetMask(*args, **kwargs):
581 """
582 SetMask(self, Mask mask)
583
584 Sets the mask for this bitmap.
d6c14a4c
RD
585
586 :see: `GetMask`, `wx.Mask`
587
d55e5bfc
RD
588 """
589 return _gdi_.Bitmap_SetMask(*args, **kwargs)
590
591 def SetMaskColour(*args, **kwargs):
592 """
593 SetMaskColour(self, Colour colour)
594
595 Create a Mask based on a specified colour in the Bitmap.
596 """
597 return _gdi_.Bitmap_SetMaskColour(*args, **kwargs)
598
599 def GetSubBitmap(*args, **kwargs):
600 """
601 GetSubBitmap(self, Rect rect) -> Bitmap
602
d6c14a4c
RD
603 Returns a sub-bitmap of the current one as long as the rect belongs
604 entirely to the bitmap. This function preserves bit depth and mask
605 information.
d55e5bfc
RD
606 """
607 return _gdi_.Bitmap_GetSubBitmap(*args, **kwargs)
608
609 def SaveFile(*args, **kwargs):
610 """
d6c14a4c 611 SaveFile(self, String name, int type, Palette palette=None) -> bool
d55e5bfc 612
d6c14a4c
RD
613 Saves a bitmap in the named file. See `__init__` for a description of
614 the ``type`` parameter.
d55e5bfc
RD
615 """
616 return _gdi_.Bitmap_SaveFile(*args, **kwargs)
617
618 def LoadFile(*args, **kwargs):
619 """
620 LoadFile(self, String name, int type) -> bool
621
d6c14a4c
RD
622 Loads a bitmap from a file. See `__init__` for a description of the
623 ``type`` parameter.
d55e5bfc
RD
624 """
625 return _gdi_.Bitmap_LoadFile(*args, **kwargs)
626
070c48b4
RD
627 def GetPalette(*args, **kwargs):
628 """GetPalette(self) -> Palette"""
629 return _gdi_.Bitmap_GetPalette(*args, **kwargs)
630
d55e5bfc
RD
631 def CopyFromIcon(*args, **kwargs):
632 """CopyFromIcon(self, Icon icon) -> bool"""
633 return _gdi_.Bitmap_CopyFromIcon(*args, **kwargs)
634
635 def SetHeight(*args, **kwargs):
636 """
637 SetHeight(self, int height)
638
d6c14a4c 639 Set the height property (does not affect the existing bitmap data).
d55e5bfc
RD
640 """
641 return _gdi_.Bitmap_SetHeight(*args, **kwargs)
642
643 def SetWidth(*args, **kwargs):
644 """
645 SetWidth(self, int width)
646
d6c14a4c 647 Set the width property (does not affect the existing bitmap data).
d55e5bfc
RD
648 """
649 return _gdi_.Bitmap_SetWidth(*args, **kwargs)
650
651 def SetDepth(*args, **kwargs):
652 """
653 SetDepth(self, int depth)
654
d6c14a4c 655 Set the depth property (does not affect the existing bitmap data).
d55e5bfc
RD
656 """
657 return _gdi_.Bitmap_SetDepth(*args, **kwargs)
658
659 def SetSize(*args, **kwargs):
660 """
661 SetSize(self, Size size)
662
d6c14a4c 663 Set the bitmap size (does not affect the existing bitmap data).
d55e5bfc
RD
664 """
665 return _gdi_.Bitmap_SetSize(*args, **kwargs)
666
667 def __nonzero__(self): return self.Ok()
668 def __eq__(*args, **kwargs):
669 """__eq__(self, Bitmap other) -> bool"""
670 return _gdi_.Bitmap___eq__(*args, **kwargs)
671
672 def __ne__(*args, **kwargs):
673 """__ne__(self, Bitmap other) -> bool"""
674 return _gdi_.Bitmap___ne__(*args, **kwargs)
675
2bf58437
RD
676 Depth = property(GetDepth,SetDepth,doc="See `GetDepth` and `SetDepth`")
677 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
678 Mask = property(GetMask,SetMask,doc="See `GetMask` and `SetMask`")
679 Palette = property(GetPalette,doc="See `GetPalette`")
680 Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
681 SubBitmap = property(GetSubBitmap,doc="See `GetSubBitmap`")
682 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
2131d850 683_gdi_.Bitmap_swigregister(Bitmap)
d55e5bfc 684
d6c14a4c
RD
685def EmptyBitmap(*args, **kwargs):
686 """
687 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
688
689 Creates a new bitmap of the given size. A depth of -1 indicates the
690 depth of the current screen or visual. Some platforms only support 1
1bd55598 691 for monochrome and -1 for the current display depth.
d6c14a4c
RD
692 """
693 val = _gdi_.new_EmptyBitmap(*args, **kwargs)
d6c14a4c
RD
694 return val
695
d55e5bfc
RD
696def BitmapFromIcon(*args, **kwargs):
697 """
698 BitmapFromIcon(Icon icon) -> Bitmap
699
d6c14a4c 700 Create a new bitmap from a `wx.Icon` object.
d55e5bfc
RD
701 """
702 val = _gdi_.new_BitmapFromIcon(*args, **kwargs)
d55e5bfc
RD
703 return val
704
705def BitmapFromImage(*args, **kwargs):
706 """
707 BitmapFromImage(Image image, int depth=-1) -> Bitmap
708
d6c14a4c
RD
709 Creates bitmap object from a `wx.Image`. This has to be done to
710 actually display a `wx.Image` as you cannot draw an image directly on
711 a window. The resulting bitmap will use the provided colour depth (or
712 that of the current screen colour depth if depth is -1) which entails
713 that a colour reduction may have to take place.
d55e5bfc
RD
714 """
715 val = _gdi_.new_BitmapFromImage(*args, **kwargs)
d55e5bfc
RD
716 return val
717
718def BitmapFromXPMData(*args, **kwargs):
719 """
720 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
721
722 Construct a Bitmap from a list of strings formatted as XPM data.
723 """
724 val = _gdi_.new_BitmapFromXPMData(*args, **kwargs)
d55e5bfc
RD
725 return val
726
727def BitmapFromBits(*args, **kwargs):
728 """
729 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
730
d6c14a4c
RD
731 Creates a bitmap from an array of bits. You should only use this
732 function for monochrome bitmaps (depth 1) in portable programs: in
733 this case the bits parameter should contain an XBM image. For other
734 bit depths, the behaviour is platform dependent.
d55e5bfc
RD
735 """
736 val = _gdi_.new_BitmapFromBits(*args, **kwargs)
d55e5bfc
RD
737 return val
738
fc46b7f3
RD
739
740def _BitmapFromBufferAlpha(*args, **kwargs):
741 """_BitmapFromBufferAlpha(int width, int height, buffer data, buffer alpha) -> Bitmap"""
742 return _gdi_._BitmapFromBufferAlpha(*args, **kwargs)
743
744def _BitmapFromBuffer(*args, **kwargs):
745 """_BitmapFromBuffer(int width, int height, buffer data) -> Bitmap"""
746 return _gdi_._BitmapFromBuffer(*args, **kwargs)
747def BitmapFromBuffer(width, height, dataBuffer, alphaBuffer=None):
748 """
749 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
eec1c382
RD
750 parameter must be a Python object that implements the buffer
751 interface, such as a string, array, etc. The dataBuffer object is
752 expected to contain a series of RGB bytes and be width*height*3
753 bytes long. A buffer object can optionally be supplied for the
754 image's alpha channel data, and it is expected to be width*height
755 bytes long. On Windows the RGB values are 'premultiplied' by the
756 alpha values. (The other platforms do the multiplication
757 themselves.)
758
759 Unlike `wx.ImageFromBuffer` the bitmap created with this function
760 does not share the memory buffer with the buffer object. This is
761 because the native pixel buffer format varies on different
762 platforms, and so instead an efficient as possible copy of the
763 data is made from the buffer objects to the bitmap's native pixel
764 buffer. For direct access to a bitmap's pixel buffer see
765 `wx.NativePixelData` and `wx.AlphaPixelData`.
fc46b7f3
RD
766
767 :see: `wx.Bitmap`, `wx.BitmapFromBufferRGBA`, `wx.NativePixelData`,
768 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
769 """
fc46b7f3
RD
770 if alphaBuffer is not None:
771 return _gdi_._BitmapFromBufferAlpha(width, height, dataBuffer, alphaBuffer)
772 else:
773 return _gdi_._BitmapFromBuffer(width, height, dataBuffer)
774
775
776def _BitmapFromBufferRGBA(*args, **kwargs):
777 """_BitmapFromBufferRGBA(int width, int height, buffer data) -> Bitmap"""
778 return _gdi_._BitmapFromBufferRGBA(*args, **kwargs)
779def BitmapFromBufferRGBA(width, height, dataBuffer):
780 """
781 Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer
eec1c382
RD
782 parameter must be a Python object that implements the buffer
783 interface, such as a string, array, etc. The dataBuffer object is
784 expected to contain a series of RGBA bytes (red, green, blue and
785 alpha) and be width*height*4 bytes long. On Windows the RGB
786 values are 'premultiplied' by the alpha values. (The other
787 platforms do the multiplication themselves.)
788
789 Unlike `wx.ImageFromBuffer` the bitmap created with this function
790 does not share the memory buffer with the buffer object. This is
791 because the native pixel buffer format varies on different
792 platforms, and so instead an efficient as possible copy of the
793 data is made from the buffer object to the bitmap's native pixel
794 buffer. For direct access to a bitmap's pixel buffer see
795 `wx.NativePixelData` and `wx.AlphaPixelData`.
fc46b7f3
RD
796
797 :see: `wx.Bitmap`, `wx.BitmapFromBuffer`, `wx.NativePixelData`,
798 `wx.AlphaPixelData`, `wx.ImageFromBuffer`
799 """
fc46b7f3
RD
800 return _gdi_._BitmapFromBufferRGBA(width, height, dataBuffer)
801
802class PixelDataBase(object):
803 """Proxy of C++ PixelDataBase class"""
804 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
805 def __init__(self): raise AttributeError, "No constructor defined"
806 __repr__ = _swig_repr
807 def GetOrigin(*args, **kwargs):
808 """GetOrigin(self) -> Point"""
809 return _gdi_.PixelDataBase_GetOrigin(*args, **kwargs)
810
811 def GetWidth(*args, **kwargs):
812 """GetWidth(self) -> int"""
813 return _gdi_.PixelDataBase_GetWidth(*args, **kwargs)
814
815 def GetHeight(*args, **kwargs):
816 """GetHeight(self) -> int"""
817 return _gdi_.PixelDataBase_GetHeight(*args, **kwargs)
818
819 def GetSize(*args, **kwargs):
820 """GetSize(self) -> Size"""
821 return _gdi_.PixelDataBase_GetSize(*args, **kwargs)
822
823 def GetRowStride(*args, **kwargs):
824 """GetRowStride(self) -> int"""
825 return _gdi_.PixelDataBase_GetRowStride(*args, **kwargs)
826
33d6fd3b
RD
827 Height = property(GetHeight,doc="See `GetHeight`")
828 Origin = property(GetOrigin,doc="See `GetOrigin`")
829 RowStride = property(GetRowStride,doc="See `GetRowStride`")
830 Size = property(GetSize,doc="See `GetSize`")
831 Width = property(GetWidth,doc="See `GetWidth`")
fc46b7f3
RD
832_gdi_.PixelDataBase_swigregister(PixelDataBase)
833
834class NativePixelData(PixelDataBase):
835 """Proxy of C++ NativePixelData class"""
836 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
837 __repr__ = _swig_repr
838 def __init__(self, *args):
839 """
840 __init__(self, Bitmap bmp) -> NativePixelData
841 __init__(self, Bitmap bmp, Rect rect) -> NativePixelData
842 __init__(self, Bitmap bmp, Point pt, Size sz) -> NativePixelData
843 """
844 _gdi_.NativePixelData_swiginit(self,_gdi_.new_NativePixelData(*args))
845 __swig_destroy__ = _gdi_.delete_NativePixelData
846 __del__ = lambda self : None;
847 def GetPixels(*args, **kwargs):
848 """GetPixels(self) -> NativePixelData_Accessor"""
849 return _gdi_.NativePixelData_GetPixels(*args, **kwargs)
850
851 def UseAlpha(*args, **kwargs):
852 """UseAlpha(self)"""
853 return _gdi_.NativePixelData_UseAlpha(*args, **kwargs)
854
855 def __nonzero__(*args, **kwargs):
856 """__nonzero__(self) -> bool"""
857 return _gdi_.NativePixelData___nonzero__(*args, **kwargs)
858
859 def __iter__(self):
195a89b4
RD
860 """
861 Create and return an iterator object for this pixel data
862 object. (It's really a generator but I won't tell if you
863 don't tell.)
864 """
865 width = self.GetWidth()
866 height = self.GetHeight()
867 pixels = self.GetPixels()
868
869
870
871
872 class PixelFacade(object):
fc46b7f3 873 def Get(self):
195a89b4
RD
874 return pixels.Get()
875 def Set(self, *args, **kw):
876 return pixels.Set(*args, **kw)
877 def __str__(self):
878 return str(self.Get())
879 def __repr__(self):
880 return 'pixel(%d,%d): %s' % (x,y,self.Get())
881 X = property(lambda self: x)
882 Y = property(lambda self: y)
883
884 pf = PixelFacade()
885 for y in xrange(height):
886 for x in xrange(width):
887
888
889
890 yield pf
891 pixels.nextPixel()
892 pixels.MoveTo(self, 0, y)
fc46b7f3 893
2bf58437 894 Pixels = property(GetPixels,doc="See `GetPixels`")
fc46b7f3
RD
895_gdi_.NativePixelData_swigregister(NativePixelData)
896
897class NativePixelData_Accessor(object):
898 """Proxy of C++ NativePixelData_Accessor class"""
899 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
900 __repr__ = _swig_repr
901 def __init__(self, *args):
902 """
903 __init__(self, NativePixelData data) -> NativePixelData_Accessor
904 __init__(self, Bitmap bmp, NativePixelData data) -> NativePixelData_Accessor
905 __init__(self) -> NativePixelData_Accessor
906 """
907 _gdi_.NativePixelData_Accessor_swiginit(self,_gdi_.new_NativePixelData_Accessor(*args))
908 __swig_destroy__ = _gdi_.delete_NativePixelData_Accessor
909 __del__ = lambda self : None;
910 def Reset(*args, **kwargs):
911 """Reset(self, NativePixelData data)"""
912 return _gdi_.NativePixelData_Accessor_Reset(*args, **kwargs)
913
914 def IsOk(*args, **kwargs):
915 """IsOk(self) -> bool"""
916 return _gdi_.NativePixelData_Accessor_IsOk(*args, **kwargs)
917
918 def nextPixel(*args, **kwargs):
919 """nextPixel(self)"""
920 return _gdi_.NativePixelData_Accessor_nextPixel(*args, **kwargs)
921
922 def Offset(*args, **kwargs):
923 """Offset(self, NativePixelData data, int x, int y)"""
924 return _gdi_.NativePixelData_Accessor_Offset(*args, **kwargs)
925
926 def OffsetX(*args, **kwargs):
927 """OffsetX(self, NativePixelData data, int x)"""
928 return _gdi_.NativePixelData_Accessor_OffsetX(*args, **kwargs)
929
930 def OffsetY(*args, **kwargs):
931 """OffsetY(self, NativePixelData data, int y)"""
932 return _gdi_.NativePixelData_Accessor_OffsetY(*args, **kwargs)
933
934 def MoveTo(*args, **kwargs):
935 """MoveTo(self, NativePixelData data, int x, int y)"""
936 return _gdi_.NativePixelData_Accessor_MoveTo(*args, **kwargs)
937
938 def Set(*args, **kwargs):
939 """Set(self, byte red, byte green, byte blue)"""
940 return _gdi_.NativePixelData_Accessor_Set(*args, **kwargs)
941
942 def Get(*args, **kwargs):
943 """Get(self) -> PyObject"""
944 return _gdi_.NativePixelData_Accessor_Get(*args, **kwargs)
945
946_gdi_.NativePixelData_Accessor_swigregister(NativePixelData_Accessor)
947
948class AlphaPixelData(PixelDataBase):
949 """Proxy of C++ AlphaPixelData class"""
950 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
951 __repr__ = _swig_repr
952 def __init__(self, *args):
953 """
954 __init__(self, Bitmap bmp) -> AlphaPixelData
955 __init__(self, Bitmap bmp, Rect rect) -> AlphaPixelData
956 __init__(self, Bitmap bmp, Point pt, Size sz) -> AlphaPixelData
957 """
958 _gdi_.AlphaPixelData_swiginit(self,_gdi_.new_AlphaPixelData(*args))
959 self.UseAlpha()
960
961 __swig_destroy__ = _gdi_.delete_AlphaPixelData
962 __del__ = lambda self : None;
963 def GetPixels(*args, **kwargs):
964 """GetPixels(self) -> AlphaPixelData_Accessor"""
965 return _gdi_.AlphaPixelData_GetPixels(*args, **kwargs)
966
967 def UseAlpha(*args, **kwargs):
968 """UseAlpha(self)"""
969 return _gdi_.AlphaPixelData_UseAlpha(*args, **kwargs)
970
971 def __nonzero__(*args, **kwargs):
972 """__nonzero__(self) -> bool"""
973 return _gdi_.AlphaPixelData___nonzero__(*args, **kwargs)
974
975 def __iter__(self):
195a89b4
RD
976 """
977 Create and return an iterator object for this pixel data
978 object. (It's really a generator but I won't tell if you
979 don't tell.)
980 """
981 width = self.GetWidth()
982 height = self.GetHeight()
983 pixels = self.GetPixels()
984
985
986
987
988 class PixelFacade(object):
fc46b7f3 989 def Get(self):
195a89b4
RD
990 return pixels.Get()
991 def Set(self, *args, **kw):
992 return pixels.Set(*args, **kw)
993 def __str__(self):
994 return str(self.Get())
995 def __repr__(self):
996 return 'pixel(%d,%d): %s' % (x,y,self.Get())
997 X = property(lambda self: x)
998 Y = property(lambda self: y)
999
1000 pf = PixelFacade()
1001 for y in xrange(height):
1002 for x in xrange(width):
1003
1004
1005
1006 yield pf
1007 pixels.nextPixel()
1008 pixels.MoveTo(self, 0, y)
fc46b7f3 1009
2bf58437 1010 Pixels = property(GetPixels,doc="See `GetPixels`")
fc46b7f3
RD
1011_gdi_.AlphaPixelData_swigregister(AlphaPixelData)
1012
1013class AlphaPixelData_Accessor(object):
1014 """Proxy of C++ AlphaPixelData_Accessor class"""
1015 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1016 __repr__ = _swig_repr
1017 def __init__(self, *args):
1018 """
1019 __init__(self, AlphaPixelData data) -> AlphaPixelData_Accessor
1020 __init__(self, Bitmap bmp, AlphaPixelData data) -> AlphaPixelData_Accessor
1021 __init__(self) -> AlphaPixelData_Accessor
1022 """
1023 _gdi_.AlphaPixelData_Accessor_swiginit(self,_gdi_.new_AlphaPixelData_Accessor(*args))
1024 __swig_destroy__ = _gdi_.delete_AlphaPixelData_Accessor
1025 __del__ = lambda self : None;
1026 def Reset(*args, **kwargs):
1027 """Reset(self, AlphaPixelData data)"""
1028 return _gdi_.AlphaPixelData_Accessor_Reset(*args, **kwargs)
1029
1030 def IsOk(*args, **kwargs):
1031 """IsOk(self) -> bool"""
1032 return _gdi_.AlphaPixelData_Accessor_IsOk(*args, **kwargs)
1033
1034 def nextPixel(*args, **kwargs):
1035 """nextPixel(self)"""
1036 return _gdi_.AlphaPixelData_Accessor_nextPixel(*args, **kwargs)
1037
1038 def Offset(*args, **kwargs):
1039 """Offset(self, AlphaPixelData data, int x, int y)"""
1040 return _gdi_.AlphaPixelData_Accessor_Offset(*args, **kwargs)
1041
1042 def OffsetX(*args, **kwargs):
1043 """OffsetX(self, AlphaPixelData data, int x)"""
1044 return _gdi_.AlphaPixelData_Accessor_OffsetX(*args, **kwargs)
1045
1046 def OffsetY(*args, **kwargs):
1047 """OffsetY(self, AlphaPixelData data, int y)"""
1048 return _gdi_.AlphaPixelData_Accessor_OffsetY(*args, **kwargs)
1049
1050 def MoveTo(*args, **kwargs):
1051 """MoveTo(self, AlphaPixelData data, int x, int y)"""
1052 return _gdi_.AlphaPixelData_Accessor_MoveTo(*args, **kwargs)
1053
1054 def Set(*args, **kwargs):
1055 """Set(self, byte red, byte green, byte blue, byte alpha)"""
1056 return _gdi_.AlphaPixelData_Accessor_Set(*args, **kwargs)
1057
1058 def Get(*args, **kwargs):
1059 """Get(self) -> PyObject"""
1060 return _gdi_.AlphaPixelData_Accessor_Get(*args, **kwargs)
1061
1062_gdi_.AlphaPixelData_Accessor_swigregister(AlphaPixelData_Accessor)
1063
d6c14a4c 1064class Mask(_core.Object):
d55e5bfc 1065 """
d6c14a4c
RD
1066 This class encapsulates a monochrome mask bitmap, where the masked
1067 area is black and the unmasked area is white. When associated with a
1068 bitmap and drawn in a device context, the unmasked area of the bitmap
1069 will be drawn, and the masked area will not be drawn.
d55e5bfc 1070
d6c14a4c
RD
1071 A mask may be associated with a `wx.Bitmap`. It is used in
1072 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
1073 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
1074 mask.
d55e5bfc 1075 """
1bd55598
RD
1076 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1077 __repr__ = _swig_repr
1078 def __init__(self, *args, **kwargs):
d55e5bfc
RD
1079 """
1080 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
1081
d6c14a4c
RD
1082 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
1083 that indicates the transparent portions of the mask. In other words,
1084 the pixels in ``bitmap`` that match ``colour`` will be the transparent
1085 portions of the mask. If no ``colour`` or an invalid ``colour`` is
1086 passed then BLACK is used.
1087
1088 :see: `wx.Bitmap`, `wx.Colour`
d55e5bfc 1089 """
1bd55598
RD
1090 _gdi_.Mask_swiginit(self,_gdi_.new_Mask(*args, **kwargs))
1091 __swig_destroy__ = _gdi_.delete_Mask
1092 __del__ = lambda self : None;
2131d850 1093_gdi_.Mask_swigregister(Mask)
d55e5bfc 1094
d6c14a4c 1095MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
d55e5bfc 1096class Icon(GDIObject):
36ed4f51 1097 """Proxy of C++ Icon class"""
1bd55598
RD
1098 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1099 __repr__ = _swig_repr
1100 def __init__(self, *args, **kwargs):
d55e5bfc 1101 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
1bd55598
RD
1102 _gdi_.Icon_swiginit(self,_gdi_.new_Icon(*args, **kwargs))
1103 __swig_destroy__ = _gdi_.delete_Icon
1104 __del__ = lambda self : None;
d55e5bfc
RD
1105 def Ok(*args, **kwargs):
1106 """Ok(self) -> bool"""
1107 return _gdi_.Icon_Ok(*args, **kwargs)
1108
1109 def GetWidth(*args, **kwargs):
1110 """GetWidth(self) -> int"""
1111 return _gdi_.Icon_GetWidth(*args, **kwargs)
1112
1113 def GetHeight(*args, **kwargs):
1114 """GetHeight(self) -> int"""
1115 return _gdi_.Icon_GetHeight(*args, **kwargs)
1116
1117 def GetDepth(*args, **kwargs):
1118 """GetDepth(self) -> int"""
1119 return _gdi_.Icon_GetDepth(*args, **kwargs)
1120
1121 def SetWidth(*args, **kwargs):
1122 """SetWidth(self, int w)"""
1123 return _gdi_.Icon_SetWidth(*args, **kwargs)
1124
1125 def SetHeight(*args, **kwargs):
1126 """SetHeight(self, int h)"""
1127 return _gdi_.Icon_SetHeight(*args, **kwargs)
1128
1129 def SetDepth(*args, **kwargs):
1130 """SetDepth(self, int d)"""
1131 return _gdi_.Icon_SetDepth(*args, **kwargs)
1132
1133 def CopyFromBitmap(*args, **kwargs):
1134 """CopyFromBitmap(self, Bitmap bmp)"""
1135 return _gdi_.Icon_CopyFromBitmap(*args, **kwargs)
1136
1137 def __nonzero__(self): return self.Ok()
ac5d357a
RD
1138 Depth = property(GetDepth,SetDepth,doc="See `GetDepth` and `SetDepth`")
1139 Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`")
1140 Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`")
2131d850 1141_gdi_.Icon_swigregister(Icon)
d55e5bfc
RD
1142
1143def EmptyIcon(*args, **kwargs):
1144 """EmptyIcon() -> Icon"""
1145 val = _gdi_.new_EmptyIcon(*args, **kwargs)
d55e5bfc
RD
1146 return val
1147
1148def IconFromLocation(*args, **kwargs):
1149 """IconFromLocation(IconLocation loc) -> Icon"""
1150 val = _gdi_.new_IconFromLocation(*args, **kwargs)
d55e5bfc
RD
1151 return val
1152
1153def IconFromBitmap(*args, **kwargs):
1154 """IconFromBitmap(Bitmap bmp) -> Icon"""
1155 val = _gdi_.new_IconFromBitmap(*args, **kwargs)
d55e5bfc
RD
1156 return val
1157
1158def IconFromXPMData(*args, **kwargs):
1159 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
1160 val = _gdi_.new_IconFromXPMData(*args, **kwargs)
d55e5bfc
RD
1161 return val
1162
1163class IconLocation(object):
36ed4f51 1164 """Proxy of C++ IconLocation class"""
1bd55598
RD
1165 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1166 __repr__ = _swig_repr
1167 def __init__(self, *args, **kwargs):
d55e5bfc 1168 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
1bd55598
RD
1169 _gdi_.IconLocation_swiginit(self,_gdi_.new_IconLocation(*args, **kwargs))
1170 __swig_destroy__ = _gdi_.delete_IconLocation
1171 __del__ = lambda self : None;
d55e5bfc
RD
1172 def IsOk(*args, **kwargs):
1173 """IsOk(self) -> bool"""
1174 return _gdi_.IconLocation_IsOk(*args, **kwargs)
1175
1176 def __nonzero__(self): return self.Ok()
1177 def SetFileName(*args, **kwargs):
1178 """SetFileName(self, String filename)"""
1179 return _gdi_.IconLocation_SetFileName(*args, **kwargs)
1180
1181 def GetFileName(*args, **kwargs):
1182 """GetFileName(self) -> String"""
1183 return _gdi_.IconLocation_GetFileName(*args, **kwargs)
1184
1185 def SetIndex(*args, **kwargs):
1186 """SetIndex(self, int num)"""
1187 return _gdi_.IconLocation_SetIndex(*args, **kwargs)
1188
1189 def GetIndex(*args, **kwargs):
1190 """GetIndex(self) -> int"""
1191 return _gdi_.IconLocation_GetIndex(*args, **kwargs)
1192
ac5d357a
RD
1193 FileName = property(GetFileName,SetFileName,doc="See `GetFileName` and `SetFileName`")
1194 Index = property(GetIndex,SetIndex,doc="See `GetIndex` and `SetIndex`")
2131d850 1195_gdi_.IconLocation_swigregister(IconLocation)
d55e5bfc
RD
1196
1197class IconBundle(object):
36ed4f51 1198 """Proxy of C++ IconBundle class"""
1bd55598
RD
1199 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1200 __repr__ = _swig_repr
1201 def __init__(self, *args, **kwargs):
d55e5bfc 1202 """__init__(self) -> IconBundle"""
1bd55598
RD
1203 _gdi_.IconBundle_swiginit(self,_gdi_.new_IconBundle(*args, **kwargs))
1204 __swig_destroy__ = _gdi_.delete_IconBundle
1205 __del__ = lambda self : None;
d55e5bfc
RD
1206 def AddIcon(*args, **kwargs):
1207 """AddIcon(self, Icon icon)"""
1208 return _gdi_.IconBundle_AddIcon(*args, **kwargs)
1209
1210 def AddIconFromFile(*args, **kwargs):
1211 """AddIconFromFile(self, String file, long type)"""
1212 return _gdi_.IconBundle_AddIconFromFile(*args, **kwargs)
1213
1214 def GetIcon(*args, **kwargs):
1215 """GetIcon(self, Size size) -> Icon"""
1216 return _gdi_.IconBundle_GetIcon(*args, **kwargs)
1217
ac5d357a 1218 Icon = property(GetIcon,doc="See `GetIcon`")
2131d850 1219_gdi_.IconBundle_swigregister(IconBundle)
d55e5bfc
RD
1220
1221def IconBundleFromFile(*args, **kwargs):
1222 """IconBundleFromFile(String file, long type) -> IconBundle"""
1223 val = _gdi_.new_IconBundleFromFile(*args, **kwargs)
d55e5bfc
RD
1224 return val
1225
1226def IconBundleFromIcon(*args, **kwargs):
1227 """IconBundleFromIcon(Icon icon) -> IconBundle"""
1228 val = _gdi_.new_IconBundleFromIcon(*args, **kwargs)
d55e5bfc
RD
1229 return val
1230
1231class Cursor(GDIObject):
1232 """
15817c7e
RD
1233 A cursor is a small bitmap usually used for denoting where the mouse
1234 pointer is, with a picture that might indicate the interpretation of a
1235 mouse click.
d55e5bfc
RD
1236
1237 A single cursor object may be used in many windows (any subwindow
15817c7e
RD
1238 type). The wxWindows convention is to set the cursor for a window, as
1239 in X, rather than to set it globally as in MS Windows, although a
1240 global `wx.SetCursor` function is also available for use on MS Windows.
1241
d55e5bfc 1242 """
1bd55598
RD
1243 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1244 __repr__ = _swig_repr
1245 def __init__(self, *args, **kwargs):
d55e5bfc
RD
1246 """
1247 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
1248
1249 Construct a Cursor from a file. Specify the type of file using
fef4c27a 1250 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
15817c7e 1251 file.
d55e5bfc 1252 """
1bd55598
RD
1253 _gdi_.Cursor_swiginit(self,_gdi_.new_Cursor(*args, **kwargs))
1254 __swig_destroy__ = _gdi_.delete_Cursor
1255 __del__ = lambda self : None;
d55e5bfc
RD
1256 def Ok(*args, **kwargs):
1257 """Ok(self) -> bool"""
1258 return _gdi_.Cursor_Ok(*args, **kwargs)
1259
1260 def __nonzero__(self): return self.Ok()
2131d850 1261_gdi_.Cursor_swigregister(Cursor)
d55e5bfc
RD
1262
1263def StockCursor(*args, **kwargs):
1264 """
1265 StockCursor(int id) -> Cursor
1266
15817c7e 1267 Create a cursor using one of the stock cursors. Note that not all
fef4c27a 1268 stock cursors are available on all platforms.
d55e5bfc
RD
1269 """
1270 val = _gdi_.new_StockCursor(*args, **kwargs)
d55e5bfc
RD
1271 return val
1272
1273def CursorFromImage(*args, **kwargs):
1274 """
1275 CursorFromImage(Image image) -> Cursor
1276
fef4c27a 1277 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
53aa7709 1278 for setting the transparent portions of the cursor.
d55e5bfc
RD
1279 """
1280 val = _gdi_.new_CursorFromImage(*args, **kwargs)
d55e5bfc
RD
1281 return val
1282
1283#---------------------------------------------------------------------------
1284
1285OutRegion = _gdi_.OutRegion
1286PartRegion = _gdi_.PartRegion
1287InRegion = _gdi_.InRegion
1288class Region(GDIObject):
36ed4f51 1289 """Proxy of C++ Region class"""
1bd55598
RD
1290 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1291 __repr__ = _swig_repr
1292 def __init__(self, *args, **kwargs):
d55e5bfc 1293 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
1bd55598
RD
1294 _gdi_.Region_swiginit(self,_gdi_.new_Region(*args, **kwargs))
1295 __swig_destroy__ = _gdi_.delete_Region
1296 __del__ = lambda self : None;
d55e5bfc
RD
1297 def Clear(*args, **kwargs):
1298 """Clear(self)"""
1299 return _gdi_.Region_Clear(*args, **kwargs)
1300
070c48b4
RD
1301 def Offset(*args, **kwargs):
1302 """Offset(self, int x, int y) -> bool"""
1303 return _gdi_.Region_Offset(*args, **kwargs)
1304
d55e5bfc
RD
1305 def Contains(*args, **kwargs):
1306 """Contains(self, int x, int y) -> int"""
1307 return _gdi_.Region_Contains(*args, **kwargs)
1308
1309 def ContainsPoint(*args, **kwargs):
1310 """ContainsPoint(self, Point pt) -> int"""
1311 return _gdi_.Region_ContainsPoint(*args, **kwargs)
1312
1313 def ContainsRect(*args, **kwargs):
1314 """ContainsRect(self, Rect rect) -> int"""
1315 return _gdi_.Region_ContainsRect(*args, **kwargs)
1316
1317 def ContainsRectDim(*args, **kwargs):
1318 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
1319 return _gdi_.Region_ContainsRectDim(*args, **kwargs)
1320
1321 def GetBox(*args, **kwargs):
1322 """GetBox(self) -> Rect"""
1323 return _gdi_.Region_GetBox(*args, **kwargs)
1324
1325 def Intersect(*args, **kwargs):
1326 """Intersect(self, int x, int y, int width, int height) -> bool"""
1327 return _gdi_.Region_Intersect(*args, **kwargs)
1328
1329 def IntersectRect(*args, **kwargs):
1330 """IntersectRect(self, Rect rect) -> bool"""
1331 return _gdi_.Region_IntersectRect(*args, **kwargs)
1332
1333 def IntersectRegion(*args, **kwargs):
1334 """IntersectRegion(self, Region region) -> bool"""
1335 return _gdi_.Region_IntersectRegion(*args, **kwargs)
1336
1337 def IsEmpty(*args, **kwargs):
1338 """IsEmpty(self) -> bool"""
1339 return _gdi_.Region_IsEmpty(*args, **kwargs)
1340
f5263701
RD
1341 def IsEqual(*args, **kwargs):
1342 """IsEqual(self, Region region) -> bool"""
1343 return _gdi_.Region_IsEqual(*args, **kwargs)
1344
d55e5bfc
RD
1345 def Union(*args, **kwargs):
1346 """Union(self, int x, int y, int width, int height) -> bool"""
1347 return _gdi_.Region_Union(*args, **kwargs)
1348
1349 def UnionRect(*args, **kwargs):
1350 """UnionRect(self, Rect rect) -> bool"""
1351 return _gdi_.Region_UnionRect(*args, **kwargs)
1352
1353 def UnionRegion(*args, **kwargs):
1354 """UnionRegion(self, Region region) -> bool"""
1355 return _gdi_.Region_UnionRegion(*args, **kwargs)
1356
1357 def Subtract(*args, **kwargs):
1358 """Subtract(self, int x, int y, int width, int height) -> bool"""
1359 return _gdi_.Region_Subtract(*args, **kwargs)
1360
1361 def SubtractRect(*args, **kwargs):
1362 """SubtractRect(self, Rect rect) -> bool"""
1363 return _gdi_.Region_SubtractRect(*args, **kwargs)
1364
1365 def SubtractRegion(*args, **kwargs):
1366 """SubtractRegion(self, Region region) -> bool"""
1367 return _gdi_.Region_SubtractRegion(*args, **kwargs)
1368
1369 def Xor(*args, **kwargs):
1370 """Xor(self, int x, int y, int width, int height) -> bool"""
1371 return _gdi_.Region_Xor(*args, **kwargs)
1372
1373 def XorRect(*args, **kwargs):
1374 """XorRect(self, Rect rect) -> bool"""
1375 return _gdi_.Region_XorRect(*args, **kwargs)
1376
1377 def XorRegion(*args, **kwargs):
1378 """XorRegion(self, Region region) -> bool"""
1379 return _gdi_.Region_XorRegion(*args, **kwargs)
1380
1381 def ConvertToBitmap(*args, **kwargs):
1382 """ConvertToBitmap(self) -> Bitmap"""
1383 return _gdi_.Region_ConvertToBitmap(*args, **kwargs)
1384
1385 def UnionBitmap(*args, **kwargs):
d07096ad 1386 """UnionBitmap(self, Bitmap bmp) -> bool"""
d55e5bfc
RD
1387 return _gdi_.Region_UnionBitmap(*args, **kwargs)
1388
d07096ad
RD
1389 def UnionBitmapColour(*args, **kwargs):
1390 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1391 return _gdi_.Region_UnionBitmapColour(*args, **kwargs)
1392
33d6fd3b 1393 Box = property(GetBox,doc="See `GetBox`")
2131d850 1394_gdi_.Region_swigregister(Region)
d55e5bfc
RD
1395
1396def RegionFromBitmap(*args, **kwargs):
d07096ad 1397 """RegionFromBitmap(Bitmap bmp) -> Region"""
d55e5bfc 1398 val = _gdi_.new_RegionFromBitmap(*args, **kwargs)
d55e5bfc
RD
1399 return val
1400
d07096ad
RD
1401def RegionFromBitmapColour(*args, **kwargs):
1402 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1403 val = _gdi_.new_RegionFromBitmapColour(*args, **kwargs)
d07096ad
RD
1404 return val
1405
d55e5bfc 1406def RegionFromPoints(*args, **kwargs):
36ed4f51 1407 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
d55e5bfc 1408 val = _gdi_.new_RegionFromPoints(*args, **kwargs)
d55e5bfc
RD
1409 return val
1410
1411class RegionIterator(_core.Object):
36ed4f51 1412 """Proxy of C++ RegionIterator class"""
1bd55598
RD
1413 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1414 __repr__ = _swig_repr
1415 def __init__(self, *args, **kwargs):
d55e5bfc 1416 """__init__(self, Region region) -> RegionIterator"""
1bd55598
RD
1417 _gdi_.RegionIterator_swiginit(self,_gdi_.new_RegionIterator(*args, **kwargs))
1418 __swig_destroy__ = _gdi_.delete_RegionIterator
1419 __del__ = lambda self : None;
d55e5bfc
RD
1420 def GetX(*args, **kwargs):
1421 """GetX(self) -> int"""
1422 return _gdi_.RegionIterator_GetX(*args, **kwargs)
1423
1424 def GetY(*args, **kwargs):
1425 """GetY(self) -> int"""
1426 return _gdi_.RegionIterator_GetY(*args, **kwargs)
1427
1428 def GetW(*args, **kwargs):
1429 """GetW(self) -> int"""
1430 return _gdi_.RegionIterator_GetW(*args, **kwargs)
1431
1432 def GetWidth(*args, **kwargs):
1433 """GetWidth(self) -> int"""
1434 return _gdi_.RegionIterator_GetWidth(*args, **kwargs)
1435
1436 def GetH(*args, **kwargs):
1437 """GetH(self) -> int"""
1438 return _gdi_.RegionIterator_GetH(*args, **kwargs)
1439
1440 def GetHeight(*args, **kwargs):
1441 """GetHeight(self) -> int"""
1442 return _gdi_.RegionIterator_GetHeight(*args, **kwargs)
1443
1444 def GetRect(*args, **kwargs):
1445 """GetRect(self) -> Rect"""
1446 return _gdi_.RegionIterator_GetRect(*args, **kwargs)
1447
1448 def HaveRects(*args, **kwargs):
1449 """HaveRects(self) -> bool"""
1450 return _gdi_.RegionIterator_HaveRects(*args, **kwargs)
1451
1452 def Reset(*args, **kwargs):
1453 """Reset(self)"""
1454 return _gdi_.RegionIterator_Reset(*args, **kwargs)
1455
1456 def Next(*args, **kwargs):
1457 """Next(self)"""
1458 return _gdi_.RegionIterator_Next(*args, **kwargs)
1459
1460 def __nonzero__(*args, **kwargs):
1461 """__nonzero__(self) -> bool"""
1462 return _gdi_.RegionIterator___nonzero__(*args, **kwargs)
1463
33d6fd3b
RD
1464 H = property(GetH,doc="See `GetH`")
1465 Height = property(GetHeight,doc="See `GetHeight`")
1466 Rect = property(GetRect,doc="See `GetRect`")
1467 W = property(GetW,doc="See `GetW`")
1468 Width = property(GetWidth,doc="See `GetWidth`")
1469 X = property(GetX,doc="See `GetX`")
1470 Y = property(GetY,doc="See `GetY`")
2131d850 1471_gdi_.RegionIterator_swigregister(RegionIterator)
d55e5bfc
RD
1472
1473#---------------------------------------------------------------------------
1474
1475FONTFAMILY_DEFAULT = _gdi_.FONTFAMILY_DEFAULT
1476FONTFAMILY_DECORATIVE = _gdi_.FONTFAMILY_DECORATIVE
1477FONTFAMILY_ROMAN = _gdi_.FONTFAMILY_ROMAN
1478FONTFAMILY_SCRIPT = _gdi_.FONTFAMILY_SCRIPT
1479FONTFAMILY_SWISS = _gdi_.FONTFAMILY_SWISS
1480FONTFAMILY_MODERN = _gdi_.FONTFAMILY_MODERN
1481FONTFAMILY_TELETYPE = _gdi_.FONTFAMILY_TELETYPE
1482FONTFAMILY_MAX = _gdi_.FONTFAMILY_MAX
1483FONTFAMILY_UNKNOWN = _gdi_.FONTFAMILY_UNKNOWN
1484FONTSTYLE_NORMAL = _gdi_.FONTSTYLE_NORMAL
1485FONTSTYLE_ITALIC = _gdi_.FONTSTYLE_ITALIC
1486FONTSTYLE_SLANT = _gdi_.FONTSTYLE_SLANT
1487FONTSTYLE_MAX = _gdi_.FONTSTYLE_MAX
1488FONTWEIGHT_NORMAL = _gdi_.FONTWEIGHT_NORMAL
1489FONTWEIGHT_LIGHT = _gdi_.FONTWEIGHT_LIGHT
1490FONTWEIGHT_BOLD = _gdi_.FONTWEIGHT_BOLD
1491FONTWEIGHT_MAX = _gdi_.FONTWEIGHT_MAX
1492FONTFLAG_DEFAULT = _gdi_.FONTFLAG_DEFAULT
1493FONTFLAG_ITALIC = _gdi_.FONTFLAG_ITALIC
1494FONTFLAG_SLANT = _gdi_.FONTFLAG_SLANT
1495FONTFLAG_LIGHT = _gdi_.FONTFLAG_LIGHT
1496FONTFLAG_BOLD = _gdi_.FONTFLAG_BOLD
1497FONTFLAG_ANTIALIASED = _gdi_.FONTFLAG_ANTIALIASED
1498FONTFLAG_NOT_ANTIALIASED = _gdi_.FONTFLAG_NOT_ANTIALIASED
1499FONTFLAG_UNDERLINED = _gdi_.FONTFLAG_UNDERLINED
1500FONTFLAG_STRIKETHROUGH = _gdi_.FONTFLAG_STRIKETHROUGH
1501FONTFLAG_MASK = _gdi_.FONTFLAG_MASK
1502FONTENCODING_SYSTEM = _gdi_.FONTENCODING_SYSTEM
1503FONTENCODING_DEFAULT = _gdi_.FONTENCODING_DEFAULT
1504FONTENCODING_ISO8859_1 = _gdi_.FONTENCODING_ISO8859_1
1505FONTENCODING_ISO8859_2 = _gdi_.FONTENCODING_ISO8859_2
1506FONTENCODING_ISO8859_3 = _gdi_.FONTENCODING_ISO8859_3
1507FONTENCODING_ISO8859_4 = _gdi_.FONTENCODING_ISO8859_4
1508FONTENCODING_ISO8859_5 = _gdi_.FONTENCODING_ISO8859_5
1509FONTENCODING_ISO8859_6 = _gdi_.FONTENCODING_ISO8859_6
1510FONTENCODING_ISO8859_7 = _gdi_.FONTENCODING_ISO8859_7
1511FONTENCODING_ISO8859_8 = _gdi_.FONTENCODING_ISO8859_8
1512FONTENCODING_ISO8859_9 = _gdi_.FONTENCODING_ISO8859_9
1513FONTENCODING_ISO8859_10 = _gdi_.FONTENCODING_ISO8859_10
1514FONTENCODING_ISO8859_11 = _gdi_.FONTENCODING_ISO8859_11
1515FONTENCODING_ISO8859_12 = _gdi_.FONTENCODING_ISO8859_12
1516FONTENCODING_ISO8859_13 = _gdi_.FONTENCODING_ISO8859_13
1517FONTENCODING_ISO8859_14 = _gdi_.FONTENCODING_ISO8859_14
1518FONTENCODING_ISO8859_15 = _gdi_.FONTENCODING_ISO8859_15
1519FONTENCODING_ISO8859_MAX = _gdi_.FONTENCODING_ISO8859_MAX
1520FONTENCODING_KOI8 = _gdi_.FONTENCODING_KOI8
1521FONTENCODING_KOI8_U = _gdi_.FONTENCODING_KOI8_U
1522FONTENCODING_ALTERNATIVE = _gdi_.FONTENCODING_ALTERNATIVE
1523FONTENCODING_BULGARIAN = _gdi_.FONTENCODING_BULGARIAN
1524FONTENCODING_CP437 = _gdi_.FONTENCODING_CP437
1525FONTENCODING_CP850 = _gdi_.FONTENCODING_CP850
1526FONTENCODING_CP852 = _gdi_.FONTENCODING_CP852
1527FONTENCODING_CP855 = _gdi_.FONTENCODING_CP855
1528FONTENCODING_CP866 = _gdi_.FONTENCODING_CP866
1529FONTENCODING_CP874 = _gdi_.FONTENCODING_CP874
1530FONTENCODING_CP932 = _gdi_.FONTENCODING_CP932
1531FONTENCODING_CP936 = _gdi_.FONTENCODING_CP936
1532FONTENCODING_CP949 = _gdi_.FONTENCODING_CP949
1533FONTENCODING_CP950 = _gdi_.FONTENCODING_CP950
1534FONTENCODING_CP1250 = _gdi_.FONTENCODING_CP1250
1535FONTENCODING_CP1251 = _gdi_.FONTENCODING_CP1251
1536FONTENCODING_CP1252 = _gdi_.FONTENCODING_CP1252
1537FONTENCODING_CP1253 = _gdi_.FONTENCODING_CP1253
1538FONTENCODING_CP1254 = _gdi_.FONTENCODING_CP1254
1539FONTENCODING_CP1255 = _gdi_.FONTENCODING_CP1255
1540FONTENCODING_CP1256 = _gdi_.FONTENCODING_CP1256
1541FONTENCODING_CP1257 = _gdi_.FONTENCODING_CP1257
1542FONTENCODING_CP12_MAX = _gdi_.FONTENCODING_CP12_MAX
1543FONTENCODING_UTF7 = _gdi_.FONTENCODING_UTF7
1544FONTENCODING_UTF8 = _gdi_.FONTENCODING_UTF8
1545FONTENCODING_EUC_JP = _gdi_.FONTENCODING_EUC_JP
1546FONTENCODING_UTF16BE = _gdi_.FONTENCODING_UTF16BE
1547FONTENCODING_UTF16LE = _gdi_.FONTENCODING_UTF16LE
1548FONTENCODING_UTF32BE = _gdi_.FONTENCODING_UTF32BE
1549FONTENCODING_UTF32LE = _gdi_.FONTENCODING_UTF32LE
1550FONTENCODING_MACROMAN = _gdi_.FONTENCODING_MACROMAN
1551FONTENCODING_MACJAPANESE = _gdi_.FONTENCODING_MACJAPANESE
1552FONTENCODING_MACCHINESETRAD = _gdi_.FONTENCODING_MACCHINESETRAD
1553FONTENCODING_MACKOREAN = _gdi_.FONTENCODING_MACKOREAN
1554FONTENCODING_MACARABIC = _gdi_.FONTENCODING_MACARABIC
1555FONTENCODING_MACHEBREW = _gdi_.FONTENCODING_MACHEBREW
1556FONTENCODING_MACGREEK = _gdi_.FONTENCODING_MACGREEK
1557FONTENCODING_MACCYRILLIC = _gdi_.FONTENCODING_MACCYRILLIC
1558FONTENCODING_MACDEVANAGARI = _gdi_.FONTENCODING_MACDEVANAGARI
1559FONTENCODING_MACGURMUKHI = _gdi_.FONTENCODING_MACGURMUKHI
1560FONTENCODING_MACGUJARATI = _gdi_.FONTENCODING_MACGUJARATI
1561FONTENCODING_MACORIYA = _gdi_.FONTENCODING_MACORIYA
1562FONTENCODING_MACBENGALI = _gdi_.FONTENCODING_MACBENGALI
1563FONTENCODING_MACTAMIL = _gdi_.FONTENCODING_MACTAMIL
1564FONTENCODING_MACTELUGU = _gdi_.FONTENCODING_MACTELUGU
1565FONTENCODING_MACKANNADA = _gdi_.FONTENCODING_MACKANNADA
1566FONTENCODING_MACMALAJALAM = _gdi_.FONTENCODING_MACMALAJALAM
1567FONTENCODING_MACSINHALESE = _gdi_.FONTENCODING_MACSINHALESE
1568FONTENCODING_MACBURMESE = _gdi_.FONTENCODING_MACBURMESE
1569FONTENCODING_MACKHMER = _gdi_.FONTENCODING_MACKHMER
1570FONTENCODING_MACTHAI = _gdi_.FONTENCODING_MACTHAI
1571FONTENCODING_MACLAOTIAN = _gdi_.FONTENCODING_MACLAOTIAN
1572FONTENCODING_MACGEORGIAN = _gdi_.FONTENCODING_MACGEORGIAN
1573FONTENCODING_MACARMENIAN = _gdi_.FONTENCODING_MACARMENIAN
1574FONTENCODING_MACCHINESESIMP = _gdi_.FONTENCODING_MACCHINESESIMP
1575FONTENCODING_MACTIBETAN = _gdi_.FONTENCODING_MACTIBETAN
1576FONTENCODING_MACMONGOLIAN = _gdi_.FONTENCODING_MACMONGOLIAN
1577FONTENCODING_MACETHIOPIC = _gdi_.FONTENCODING_MACETHIOPIC
1578FONTENCODING_MACCENTRALEUR = _gdi_.FONTENCODING_MACCENTRALEUR
1579FONTENCODING_MACVIATNAMESE = _gdi_.FONTENCODING_MACVIATNAMESE
1580FONTENCODING_MACARABICEXT = _gdi_.FONTENCODING_MACARABICEXT
1581FONTENCODING_MACSYMBOL = _gdi_.FONTENCODING_MACSYMBOL
1582FONTENCODING_MACDINGBATS = _gdi_.FONTENCODING_MACDINGBATS
1583FONTENCODING_MACTURKISH = _gdi_.FONTENCODING_MACTURKISH
1584FONTENCODING_MACCROATIAN = _gdi_.FONTENCODING_MACCROATIAN
1585FONTENCODING_MACICELANDIC = _gdi_.FONTENCODING_MACICELANDIC
1586FONTENCODING_MACROMANIAN = _gdi_.FONTENCODING_MACROMANIAN
1587FONTENCODING_MACCELTIC = _gdi_.FONTENCODING_MACCELTIC
1588FONTENCODING_MACGAELIC = _gdi_.FONTENCODING_MACGAELIC
1589FONTENCODING_MACKEYBOARD = _gdi_.FONTENCODING_MACKEYBOARD
1590FONTENCODING_MACMIN = _gdi_.FONTENCODING_MACMIN
1591FONTENCODING_MACMAX = _gdi_.FONTENCODING_MACMAX
1592FONTENCODING_MAX = _gdi_.FONTENCODING_MAX
1593FONTENCODING_UTF16 = _gdi_.FONTENCODING_UTF16
1594FONTENCODING_UTF32 = _gdi_.FONTENCODING_UTF32
1595FONTENCODING_UNICODE = _gdi_.FONTENCODING_UNICODE
1596FONTENCODING_GB2312 = _gdi_.FONTENCODING_GB2312
1597FONTENCODING_BIG5 = _gdi_.FONTENCODING_BIG5
1598FONTENCODING_SHIFT_JIS = _gdi_.FONTENCODING_SHIFT_JIS
1599#---------------------------------------------------------------------------
1600
1601class NativeFontInfo(object):
36ed4f51 1602 """Proxy of C++ NativeFontInfo class"""
1bd55598
RD
1603 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1604 __repr__ = _swig_repr
1605 def __init__(self, *args, **kwargs):
d55e5bfc 1606 """__init__(self) -> NativeFontInfo"""
1bd55598
RD
1607 _gdi_.NativeFontInfo_swiginit(self,_gdi_.new_NativeFontInfo(*args, **kwargs))
1608 __swig_destroy__ = _gdi_.delete_NativeFontInfo
1609 __del__ = lambda self : None;
d55e5bfc
RD
1610 def Init(*args, **kwargs):
1611 """Init(self)"""
1612 return _gdi_.NativeFontInfo_Init(*args, **kwargs)
1613
1614 def InitFromFont(*args, **kwargs):
1615 """InitFromFont(self, Font font)"""
1616 return _gdi_.NativeFontInfo_InitFromFont(*args, **kwargs)
1617
1618 def GetPointSize(*args, **kwargs):
1619 """GetPointSize(self) -> int"""
1620 return _gdi_.NativeFontInfo_GetPointSize(*args, **kwargs)
1621
1622 def GetStyle(*args, **kwargs):
1623 """GetStyle(self) -> int"""
1624 return _gdi_.NativeFontInfo_GetStyle(*args, **kwargs)
1625
1626 def GetWeight(*args, **kwargs):
1627 """GetWeight(self) -> int"""
1628 return _gdi_.NativeFontInfo_GetWeight(*args, **kwargs)
1629
1630 def GetUnderlined(*args, **kwargs):
1631 """GetUnderlined(self) -> bool"""
1632 return _gdi_.NativeFontInfo_GetUnderlined(*args, **kwargs)
1633
1634 def GetFaceName(*args, **kwargs):
1635 """GetFaceName(self) -> String"""
1636 return _gdi_.NativeFontInfo_GetFaceName(*args, **kwargs)
1637
1638 def GetFamily(*args, **kwargs):
1639 """GetFamily(self) -> int"""
1640 return _gdi_.NativeFontInfo_GetFamily(*args, **kwargs)
1641
1642 def GetEncoding(*args, **kwargs):
1643 """GetEncoding(self) -> int"""
1644 return _gdi_.NativeFontInfo_GetEncoding(*args, **kwargs)
1645
1646 def SetPointSize(*args, **kwargs):
1647 """SetPointSize(self, int pointsize)"""
1648 return _gdi_.NativeFontInfo_SetPointSize(*args, **kwargs)
1649
1650 def SetStyle(*args, **kwargs):
1651 """SetStyle(self, int style)"""
1652 return _gdi_.NativeFontInfo_SetStyle(*args, **kwargs)
1653
1654 def SetWeight(*args, **kwargs):
1655 """SetWeight(self, int weight)"""
1656 return _gdi_.NativeFontInfo_SetWeight(*args, **kwargs)
1657
1658 def SetUnderlined(*args, **kwargs):
1659 """SetUnderlined(self, bool underlined)"""
1660 return _gdi_.NativeFontInfo_SetUnderlined(*args, **kwargs)
1661
1662 def SetFaceName(*args, **kwargs):
704eda0c 1663 """SetFaceName(self, String facename) -> bool"""
d55e5bfc
RD
1664 return _gdi_.NativeFontInfo_SetFaceName(*args, **kwargs)
1665
1666 def SetFamily(*args, **kwargs):
1667 """SetFamily(self, int family)"""
1668 return _gdi_.NativeFontInfo_SetFamily(*args, **kwargs)
1669
1670 def SetEncoding(*args, **kwargs):
1671 """SetEncoding(self, int encoding)"""
1672 return _gdi_.NativeFontInfo_SetEncoding(*args, **kwargs)
1673
1674 def FromString(*args, **kwargs):
1675 """FromString(self, String s) -> bool"""
1676 return _gdi_.NativeFontInfo_FromString(*args, **kwargs)
1677
1678 def ToString(*args, **kwargs):
1679 """ToString(self) -> String"""
1680 return _gdi_.NativeFontInfo_ToString(*args, **kwargs)
1681
1682 def __str__(*args, **kwargs):
1683 """__str__(self) -> String"""
1684 return _gdi_.NativeFontInfo___str__(*args, **kwargs)
1685
1686 def FromUserString(*args, **kwargs):
1687 """FromUserString(self, String s) -> bool"""
1688 return _gdi_.NativeFontInfo_FromUserString(*args, **kwargs)
1689
1690 def ToUserString(*args, **kwargs):
1691 """ToUserString(self) -> String"""
1692 return _gdi_.NativeFontInfo_ToUserString(*args, **kwargs)
1693
57332a5a
RD
1694 Encoding = property(GetEncoding,SetEncoding,doc="See `GetEncoding` and `SetEncoding`")
1695 FaceName = property(GetFaceName,SetFaceName,doc="See `GetFaceName` and `SetFaceName`")
1696 Family = property(GetFamily,SetFamily,doc="See `GetFamily` and `SetFamily`")
1697 PointSize = property(GetPointSize,SetPointSize,doc="See `GetPointSize` and `SetPointSize`")
1698 Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`")
1699 Underlined = property(GetUnderlined,SetUnderlined,doc="See `GetUnderlined` and `SetUnderlined`")
1700 Weight = property(GetWeight,SetWeight,doc="See `GetWeight` and `SetWeight`")
2131d850 1701_gdi_.NativeFontInfo_swigregister(NativeFontInfo)
d55e5bfc
RD
1702
1703class NativeEncodingInfo(object):
36ed4f51 1704 """Proxy of C++ NativeEncodingInfo class"""
1bd55598
RD
1705 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1706 __repr__ = _swig_repr
d55e5bfc
RD
1707 facename = property(_gdi_.NativeEncodingInfo_facename_get, _gdi_.NativeEncodingInfo_facename_set)
1708 encoding = property(_gdi_.NativeEncodingInfo_encoding_get, _gdi_.NativeEncodingInfo_encoding_set)
1bd55598 1709 def __init__(self, *args, **kwargs):
d55e5bfc 1710 """__init__(self) -> NativeEncodingInfo"""
1bd55598
RD
1711 _gdi_.NativeEncodingInfo_swiginit(self,_gdi_.new_NativeEncodingInfo(*args, **kwargs))
1712 __swig_destroy__ = _gdi_.delete_NativeEncodingInfo
1713 __del__ = lambda self : None;
d55e5bfc
RD
1714 def FromString(*args, **kwargs):
1715 """FromString(self, String s) -> bool"""
1716 return _gdi_.NativeEncodingInfo_FromString(*args, **kwargs)
1717
1718 def ToString(*args, **kwargs):
1719 """ToString(self) -> String"""
1720 return _gdi_.NativeEncodingInfo_ToString(*args, **kwargs)
1721
2131d850 1722_gdi_.NativeEncodingInfo_swigregister(NativeEncodingInfo)
d55e5bfc
RD
1723
1724
1725def GetNativeFontEncoding(*args, **kwargs):
1bd55598
RD
1726 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
1727 return _gdi_.GetNativeFontEncoding(*args, **kwargs)
d55e5bfc
RD
1728
1729def TestFontEncoding(*args, **kwargs):
1bd55598
RD
1730 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
1731 return _gdi_.TestFontEncoding(*args, **kwargs)
d55e5bfc
RD
1732#---------------------------------------------------------------------------
1733
1734class FontMapper(object):
36ed4f51 1735 """Proxy of C++ FontMapper class"""
1bd55598
RD
1736 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1737 __repr__ = _swig_repr
1738 def __init__(self, *args, **kwargs):
d55e5bfc 1739 """__init__(self) -> FontMapper"""
1bd55598
RD
1740 _gdi_.FontMapper_swiginit(self,_gdi_.new_FontMapper(*args, **kwargs))
1741 __swig_destroy__ = _gdi_.delete_FontMapper
1742 __del__ = lambda self : None;
d55e5bfc 1743 def Get(*args, **kwargs):
d6c14a4c 1744 """Get() -> FontMapper"""
d55e5bfc
RD
1745 return _gdi_.FontMapper_Get(*args, **kwargs)
1746
1747 Get = staticmethod(Get)
1748 def Set(*args, **kwargs):
d6c14a4c 1749 """Set(FontMapper mapper) -> FontMapper"""
d55e5bfc
RD
1750 return _gdi_.FontMapper_Set(*args, **kwargs)
1751
1752 Set = staticmethod(Set)
1753 def CharsetToEncoding(*args, **kwargs):
1754 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
1755 return _gdi_.FontMapper_CharsetToEncoding(*args, **kwargs)
1756
1757 def GetSupportedEncodingsCount(*args, **kwargs):
d6c14a4c 1758 """GetSupportedEncodingsCount() -> size_t"""
d55e5bfc
RD
1759 return _gdi_.FontMapper_GetSupportedEncodingsCount(*args, **kwargs)
1760
1761 GetSupportedEncodingsCount = staticmethod(GetSupportedEncodingsCount)
1762 def GetEncoding(*args, **kwargs):
d6c14a4c 1763 """GetEncoding(size_t n) -> int"""
d55e5bfc
RD
1764 return _gdi_.FontMapper_GetEncoding(*args, **kwargs)
1765
1766 GetEncoding = staticmethod(GetEncoding)
1767 def GetEncodingName(*args, **kwargs):
d6c14a4c 1768 """GetEncodingName(int encoding) -> String"""
d55e5bfc
RD
1769 return _gdi_.FontMapper_GetEncodingName(*args, **kwargs)
1770
1771 GetEncodingName = staticmethod(GetEncodingName)
1772 def GetEncodingDescription(*args, **kwargs):
d6c14a4c 1773 """GetEncodingDescription(int encoding) -> String"""
d55e5bfc
RD
1774 return _gdi_.FontMapper_GetEncodingDescription(*args, **kwargs)
1775
1776 GetEncodingDescription = staticmethod(GetEncodingDescription)
1777 def GetEncodingFromName(*args, **kwargs):
d6c14a4c 1778 """GetEncodingFromName(String name) -> int"""
d55e5bfc
RD
1779 return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs)
1780
1781 GetEncodingFromName = staticmethod(GetEncodingFromName)
d55e5bfc
RD
1782 def SetConfigPath(*args, **kwargs):
1783 """SetConfigPath(self, String prefix)"""
1784 return _gdi_.FontMapper_SetConfigPath(*args, **kwargs)
1785
1786 def GetDefaultConfigPath(*args, **kwargs):
d6c14a4c 1787 """GetDefaultConfigPath() -> String"""
d55e5bfc
RD
1788 return _gdi_.FontMapper_GetDefaultConfigPath(*args, **kwargs)
1789
1790 GetDefaultConfigPath = staticmethod(GetDefaultConfigPath)
1791 def GetAltForEncoding(*args, **kwargs):
1792 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
1793 return _gdi_.FontMapper_GetAltForEncoding(*args, **kwargs)
1794
1795 def IsEncodingAvailable(*args, **kwargs):
1796 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
1797 return _gdi_.FontMapper_IsEncodingAvailable(*args, **kwargs)
1798
1799 def SetDialogParent(*args, **kwargs):
1800 """SetDialogParent(self, Window parent)"""
1801 return _gdi_.FontMapper_SetDialogParent(*args, **kwargs)
1802
1803 def SetDialogTitle(*args, **kwargs):
1804 """SetDialogTitle(self, String title)"""
1805 return _gdi_.FontMapper_SetDialogTitle(*args, **kwargs)
1806
ac5d357a 1807 AltForEncoding = property(GetAltForEncoding,doc="See `GetAltForEncoding`")
2131d850 1808_gdi_.FontMapper_swigregister(FontMapper)
d55e5bfc 1809
1bd55598
RD
1810def FontMapper_Get(*args):
1811 """FontMapper_Get() -> FontMapper"""
1812 return _gdi_.FontMapper_Get(*args)
d55e5bfc
RD
1813
1814def FontMapper_Set(*args, **kwargs):
1bd55598
RD
1815 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
1816 return _gdi_.FontMapper_Set(*args, **kwargs)
d55e5bfc 1817
1bd55598
RD
1818def FontMapper_GetSupportedEncodingsCount(*args):
1819 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
1820 return _gdi_.FontMapper_GetSupportedEncodingsCount(*args)
d55e5bfc
RD
1821
1822def FontMapper_GetEncoding(*args, **kwargs):
1bd55598
RD
1823 """FontMapper_GetEncoding(size_t n) -> int"""
1824 return _gdi_.FontMapper_GetEncoding(*args, **kwargs)
d55e5bfc
RD
1825
1826def FontMapper_GetEncodingName(*args, **kwargs):
1bd55598
RD
1827 """FontMapper_GetEncodingName(int encoding) -> String"""
1828 return _gdi_.FontMapper_GetEncodingName(*args, **kwargs)
d55e5bfc
RD
1829
1830def FontMapper_GetEncodingDescription(*args, **kwargs):
1bd55598
RD
1831 """FontMapper_GetEncodingDescription(int encoding) -> String"""
1832 return _gdi_.FontMapper_GetEncodingDescription(*args, **kwargs)
d55e5bfc
RD
1833
1834def FontMapper_GetEncodingFromName(*args, **kwargs):
1bd55598
RD
1835 """FontMapper_GetEncodingFromName(String name) -> int"""
1836 return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs)
d55e5bfc 1837
1bd55598
RD
1838def FontMapper_GetDefaultConfigPath(*args):
1839 """FontMapper_GetDefaultConfigPath() -> String"""
1840 return _gdi_.FontMapper_GetDefaultConfigPath(*args)
d55e5bfc
RD
1841
1842#---------------------------------------------------------------------------
1843
1844class Font(GDIObject):
a97cefba
RD
1845 """
1846 A font is an object which determines the appearance of text. Fonts are
1847 used for drawing text to a device context, and setting the appearance
1848 of a window's text.
1849
1850 You can retrieve the current system font settings with `wx.SystemSettings`.
1851 """
1bd55598
RD
1852 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1853 __repr__ = _swig_repr
1854 def __init__(self, *args, **kwargs):
d55e5bfc
RD
1855 """
1856 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
1857 String face=EmptyString,
1858 int encoding=FONTENCODING_DEFAULT) -> Font
a97cefba
RD
1859
1860 Creates a font object with the specified attributes.
1861
1862 :param pointSize: The size of the font in points.
1863
1864 :param family: Font family. A generic way of referring to fonts
1865 without specifying actual facename. It can be One of
1866 the ``wx.FONTFAMILY_xxx`` constants.
1867
1868 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1869
1870 :param weight: Font weight, sometimes also referred to as font
1871 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1872
1873 :param underline: The value can be ``True`` or ``False`` and
1874 indicates whether the font will include an underline. This
1875 may not be supported on all platforms.
1876
1877 :param face: An optional string specifying the actual typeface to
1878 be used. If it is an empty string, a default typeface will be
1879 chosen based on the family.
1880
1881 :param encoding: An encoding which may be one of the
1882 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1883 available, no font is created.
1884
1885 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1886 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1887
d55e5bfc 1888 """
a5ee0656 1889 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
1bd55598
RD
1890 _gdi_.Font_swiginit(self,_gdi_.new_Font(*args, **kwargs))
1891 __swig_destroy__ = _gdi_.delete_Font
1892 __del__ = lambda self : None;
d55e5bfc 1893 def Ok(*args, **kwargs):
a97cefba
RD
1894 """
1895 Ok(self) -> bool
1896
1897 Returns ``True`` if this font was successfully created.
1898 """
d55e5bfc
RD
1899 return _gdi_.Font_Ok(*args, **kwargs)
1900
1901 def __nonzero__(self): return self.Ok()
1902 def __eq__(*args, **kwargs):
1903 """__eq__(self, Font other) -> bool"""
1904 return _gdi_.Font___eq__(*args, **kwargs)
1905
1906 def __ne__(*args, **kwargs):
1907 """__ne__(self, Font other) -> bool"""
1908 return _gdi_.Font___ne__(*args, **kwargs)
1909
1910 def GetPointSize(*args, **kwargs):
a97cefba
RD
1911 """
1912 GetPointSize(self) -> int
1913
1914 Gets the point size.
1915 """
d55e5bfc
RD
1916 return _gdi_.Font_GetPointSize(*args, **kwargs)
1917
5e483524 1918 def GetPixelSize(*args, **kwargs):
a97cefba
RD
1919 """
1920 GetPixelSize(self) -> Size
1921
1922 Returns the size in pixels if the font was constructed with a pixel
1923 size.
1924 """
5e483524
RD
1925 return _gdi_.Font_GetPixelSize(*args, **kwargs)
1926
1927 def IsUsingSizeInPixels(*args, **kwargs):
a97cefba
RD
1928 """
1929 IsUsingSizeInPixels(self) -> bool
1930
1931 Returns ``True`` if the font is using a pixelSize.
1932 """
5e483524
RD
1933 return _gdi_.Font_IsUsingSizeInPixels(*args, **kwargs)
1934
d55e5bfc 1935 def GetFamily(*args, **kwargs):
a97cefba
RD
1936 """
1937 GetFamily(self) -> int
1938
1939 Gets the font family.
1940 """
d55e5bfc
RD
1941 return _gdi_.Font_GetFamily(*args, **kwargs)
1942
1943 def GetStyle(*args, **kwargs):
a97cefba
RD
1944 """
1945 GetStyle(self) -> int
1946
1947 Gets the font style.
1948 """
d55e5bfc
RD
1949 return _gdi_.Font_GetStyle(*args, **kwargs)
1950
1951 def GetWeight(*args, **kwargs):
a97cefba
RD
1952 """
1953 GetWeight(self) -> int
1954
1955 Gets the font weight.
1956 """
d55e5bfc
RD
1957 return _gdi_.Font_GetWeight(*args, **kwargs)
1958
1959 def GetUnderlined(*args, **kwargs):
a97cefba
RD
1960 """
1961 GetUnderlined(self) -> bool
1962
1963 Returns ``True`` if the font is underlined, ``False`` otherwise.
1964 """
d55e5bfc
RD
1965 return _gdi_.Font_GetUnderlined(*args, **kwargs)
1966
1967 def GetFaceName(*args, **kwargs):
a97cefba
RD
1968 """
1969 GetFaceName(self) -> String
1970
1971 Returns the typeface name associated with the font, or the empty
1972 string if there is no typeface information.
1973 """
d55e5bfc
RD
1974 return _gdi_.Font_GetFaceName(*args, **kwargs)
1975
1976 def GetEncoding(*args, **kwargs):
a97cefba
RD
1977 """
1978 GetEncoding(self) -> int
1979
1980 Get the font's encoding.
1981 """
d55e5bfc
RD
1982 return _gdi_.Font_GetEncoding(*args, **kwargs)
1983
1984 def GetNativeFontInfo(*args, **kwargs):
a97cefba
RD
1985 """
1986 GetNativeFontInfo(self) -> NativeFontInfo
1987
1988 Constructs a `wx.NativeFontInfo` object from this font.
1989 """
d55e5bfc
RD
1990 return _gdi_.Font_GetNativeFontInfo(*args, **kwargs)
1991
1992 def IsFixedWidth(*args, **kwargs):
a97cefba
RD
1993 """
1994 IsFixedWidth(self) -> bool
1995
1996 Returns true if the font is a fixed width (or monospaced) font, false
1997 if it is a proportional one or font is invalid.
1998 """
d55e5bfc
RD
1999 return _gdi_.Font_IsFixedWidth(*args, **kwargs)
2000
2001 def GetNativeFontInfoDesc(*args, **kwargs):
a97cefba
RD
2002 """
2003 GetNativeFontInfoDesc(self) -> String
2004
2005 Returns the platform-dependent string completely describing this font
2006 or an empty string if the font isn't valid.
2007 """
d55e5bfc
RD
2008 return _gdi_.Font_GetNativeFontInfoDesc(*args, **kwargs)
2009
2010 def GetNativeFontInfoUserDesc(*args, **kwargs):
a97cefba
RD
2011 """
2012 GetNativeFontInfoUserDesc(self) -> String
2013
2014 Returns a human readable version of `GetNativeFontInfoDesc`.
2015 """
d55e5bfc
RD
2016 return _gdi_.Font_GetNativeFontInfoUserDesc(*args, **kwargs)
2017
2018 def SetPointSize(*args, **kwargs):
a97cefba
RD
2019 """
2020 SetPointSize(self, int pointSize)
2021
2022 Sets the point size.
2023 """
d55e5bfc
RD
2024 return _gdi_.Font_SetPointSize(*args, **kwargs)
2025
5e483524 2026 def SetPixelSize(*args, **kwargs):
a97cefba
RD
2027 """
2028 SetPixelSize(self, Size pixelSize)
2029
2030 Sets the size in pixels rather than points. If there is platform API
2031 support for this then it is used, otherwise a font with the closest
2032 size is found using a binary search.
2033 """
5e483524
RD
2034 return _gdi_.Font_SetPixelSize(*args, **kwargs)
2035
d55e5bfc 2036 def SetFamily(*args, **kwargs):
a97cefba
RD
2037 """
2038 SetFamily(self, int family)
2039
2040 Sets the font family.
2041 """
d55e5bfc
RD
2042 return _gdi_.Font_SetFamily(*args, **kwargs)
2043
2044 def SetStyle(*args, **kwargs):
a97cefba
RD
2045 """
2046 SetStyle(self, int style)
2047
2048 Sets the font style.
2049 """
d55e5bfc
RD
2050 return _gdi_.Font_SetStyle(*args, **kwargs)
2051
2052 def SetWeight(*args, **kwargs):
a97cefba
RD
2053 """
2054 SetWeight(self, int weight)
2055
2056 Sets the font weight.
2057 """
d55e5bfc
RD
2058 return _gdi_.Font_SetWeight(*args, **kwargs)
2059
2060 def SetFaceName(*args, **kwargs):
a97cefba 2061 """
704eda0c 2062 SetFaceName(self, String faceName) -> bool
a97cefba
RD
2063
2064 Sets the facename for the font. The facename, which should be a valid
2065 font installed on the end-user's system.
2066
2067 To avoid portability problems, don't rely on a specific face, but
2068 specify the font family instead or as well. A suitable font will be
2069 found on the end-user's system. If both the family and the facename
2070 are specified, wxWidgets will first search for the specific face, and
2071 then for a font belonging to the same family.
2072 """
d55e5bfc
RD
2073 return _gdi_.Font_SetFaceName(*args, **kwargs)
2074
2075 def SetUnderlined(*args, **kwargs):
a97cefba
RD
2076 """
2077 SetUnderlined(self, bool underlined)
2078
2079 Sets underlining.
2080 """
d55e5bfc
RD
2081 return _gdi_.Font_SetUnderlined(*args, **kwargs)
2082
2083 def SetEncoding(*args, **kwargs):
a97cefba
RD
2084 """
2085 SetEncoding(self, int encoding)
2086
2087 Set the font encoding.
2088 """
d55e5bfc
RD
2089 return _gdi_.Font_SetEncoding(*args, **kwargs)
2090
2091 def SetNativeFontInfo(*args, **kwargs):
a97cefba
RD
2092 """
2093 SetNativeFontInfo(self, NativeFontInfo info)
2094
2095 Set the font's attributes from a `wx.NativeFontInfo` object.
2096 """
d55e5bfc
RD
2097 return _gdi_.Font_SetNativeFontInfo(*args, **kwargs)
2098
2099 def SetNativeFontInfoFromString(*args, **kwargs):
a97cefba 2100 """
704eda0c 2101 SetNativeFontInfoFromString(self, String info) -> bool
a97cefba
RD
2102
2103 Set the font's attributes from string representation of a
2104 `wx.NativeFontInfo` object.
2105 """
d55e5bfc
RD
2106 return _gdi_.Font_SetNativeFontInfoFromString(*args, **kwargs)
2107
2108 def SetNativeFontInfoUserDesc(*args, **kwargs):
a97cefba 2109 """
704eda0c 2110 SetNativeFontInfoUserDesc(self, String info) -> bool
a97cefba
RD
2111
2112 Set the font's attributes from a string formerly returned from
2113 `GetNativeFontInfoDesc`.
2114 """
d55e5bfc
RD
2115 return _gdi_.Font_SetNativeFontInfoUserDesc(*args, **kwargs)
2116
2117 def GetFamilyString(*args, **kwargs):
a97cefba
RD
2118 """
2119 GetFamilyString(self) -> String
2120
2121 Returns a string representation of the font family.
2122 """
d55e5bfc
RD
2123 return _gdi_.Font_GetFamilyString(*args, **kwargs)
2124
2125 def GetStyleString(*args, **kwargs):
a97cefba
RD
2126 """
2127 GetStyleString(self) -> String
2128
2129 Returns a string representation of the font style.
2130 """
d55e5bfc
RD
2131 return _gdi_.Font_GetStyleString(*args, **kwargs)
2132
2133 def GetWeightString(*args, **kwargs):
a97cefba
RD
2134 """
2135 GetWeightString(self) -> String
2136
2137 Return a string representation of the font weight.
2138 """
d55e5bfc
RD
2139 return _gdi_.Font_GetWeightString(*args, **kwargs)
2140
2141 def SetNoAntiAliasing(*args, **kwargs):
2142 """SetNoAntiAliasing(self, bool no=True)"""
2143 return _gdi_.Font_SetNoAntiAliasing(*args, **kwargs)
2144
2145 def GetNoAntiAliasing(*args, **kwargs):
2146 """GetNoAntiAliasing(self) -> bool"""
2147 return _gdi_.Font_GetNoAntiAliasing(*args, **kwargs)
2148
2149 def GetDefaultEncoding(*args, **kwargs):
a97cefba
RD
2150 """
2151 GetDefaultEncoding() -> int
2152
2153 Returns the encoding used for all fonts created with an encoding of
2154 ``wx.FONTENCODING_DEFAULT``.
2155 """
d55e5bfc
RD
2156 return _gdi_.Font_GetDefaultEncoding(*args, **kwargs)
2157
2158 GetDefaultEncoding = staticmethod(GetDefaultEncoding)
2159 def SetDefaultEncoding(*args, **kwargs):
a97cefba
RD
2160 """
2161 SetDefaultEncoding(int encoding)
2162
2163 Sets the default font encoding.
2164 """
d55e5bfc
RD
2165 return _gdi_.Font_SetDefaultEncoding(*args, **kwargs)
2166
2167 SetDefaultEncoding = staticmethod(SetDefaultEncoding)
ac5d357a
RD
2168 Encoding = property(GetEncoding,SetEncoding,doc="See `GetEncoding` and `SetEncoding`")
2169 FaceName = property(GetFaceName,SetFaceName,doc="See `GetFaceName` and `SetFaceName`")
2170 Family = property(GetFamily,SetFamily,doc="See `GetFamily` and `SetFamily`")
2171 FamilyString = property(GetFamilyString,doc="See `GetFamilyString`")
2172 NativeFontInfo = property(GetNativeFontInfo,SetNativeFontInfo,doc="See `GetNativeFontInfo` and `SetNativeFontInfo`")
2173 NativeFontInfoDesc = property(GetNativeFontInfoDesc,doc="See `GetNativeFontInfoDesc`")
2174 NativeFontInfoUserDesc = property(GetNativeFontInfoUserDesc,SetNativeFontInfoUserDesc,doc="See `GetNativeFontInfoUserDesc` and `SetNativeFontInfoUserDesc`")
2175 NoAntiAliasing = property(GetNoAntiAliasing,SetNoAntiAliasing,doc="See `GetNoAntiAliasing` and `SetNoAntiAliasing`")
2176 PixelSize = property(GetPixelSize,SetPixelSize,doc="See `GetPixelSize` and `SetPixelSize`")
2177 PointSize = property(GetPointSize,SetPointSize,doc="See `GetPointSize` and `SetPointSize`")
2178 Style = property(GetStyle,SetStyle,doc="See `GetStyle` and `SetStyle`")
2179 StyleString = property(GetStyleString,doc="See `GetStyleString`")
2180 Underlined = property(GetUnderlined,SetUnderlined,doc="See `GetUnderlined` and `SetUnderlined`")
2181 Weight = property(GetWeight,SetWeight,doc="See `GetWeight` and `SetWeight`")
2182 WeightString = property(GetWeightString,doc="See `GetWeightString`")
2131d850 2183_gdi_.Font_swigregister(Font)
d55e5bfc
RD
2184
2185def FontFromNativeInfo(*args, **kwargs):
a97cefba
RD
2186 """
2187 FontFromNativeInfo(NativeFontInfo info) -> Font
2188
2189 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
2190 """
a5ee0656 2191 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
d55e5bfc 2192 val = _gdi_.new_FontFromNativeInfo(*args, **kwargs)
d55e5bfc
RD
2193 return val
2194
2195def FontFromNativeInfoString(*args, **kwargs):
a97cefba
RD
2196 """
2197 FontFromNativeInfoString(String info) -> Font
2198
2199 Construct a `wx.Font` from the string representation of a
2200 `wx.NativeFontInfo` object.
2201 """
a5ee0656 2202 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
d55e5bfc 2203 val = _gdi_.new_FontFromNativeInfoString(*args, **kwargs)
d55e5bfc
RD
2204 return val
2205
a97cefba 2206def FFont(*args, **kwargs):
d55e5bfc 2207 """
a97cefba 2208 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
d55e5bfc 2209 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
a97cefba
RD
2210
2211 A bit of a simpler way to create a `wx.Font` using flags instead of
2212 individual attribute settings. The value of flags can be a
2213 combination of the following:
2214
2215 ============================ ==
2216 wx.FONTFLAG_DEFAULT
2217 wx.FONTFLAG_ITALIC
2218 wx.FONTFLAG_SLANT
2219 wx.FONTFLAG_LIGHT
2220 wx.FONTFLAG_BOLD
2221 wx.FONTFLAG_ANTIALIASED
2222 wx.FONTFLAG_NOT_ANTIALIASED
2223 wx.FONTFLAG_UNDERLINED
2224 wx.FONTFLAG_STRIKETHROUGH
2225 ============================ ==
2226
2227 :see: `wx.Font.__init__`
d55e5bfc 2228 """
a5ee0656 2229 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
a97cefba 2230 val = _gdi_.new_FFont(*args, **kwargs)
d55e5bfc
RD
2231 return val
2232
5e483524
RD
2233def FontFromPixelSize(*args, **kwargs):
2234 """
2235 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
2236 bool underlined=False, String face=wxEmptyString,
2237 int encoding=FONTENCODING_DEFAULT) -> Font
a97cefba
RD
2238
2239 Creates a font using a size in pixels rather than points. If there is
2240 platform API support for this then it is used, otherwise a font with
2241 the closest size is found using a binary search.
2242
2243 :see: `wx.Font.__init__`
5e483524
RD
2244 """
2245 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2246 val = _gdi_.new_FontFromPixelSize(*args, **kwargs)
5e483524
RD
2247 return val
2248
a97cefba
RD
2249def FFontFromPixelSize(*args, **kwargs):
2250 """
2251 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
2252 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
2253
2254 Creates a font using a size in pixels rather than points. If there is
2255 platform API support for this then it is used, otherwise a font with
2256 the closest size is found using a binary search.
2257
2258 :see: `wx.Font.__init__`, `wx.FFont`
2259 """
2260 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2261 val = _gdi_.new_FFontFromPixelSize(*args, **kwargs)
a97cefba
RD
2262 return val
2263
1bd55598
RD
2264def Font_GetDefaultEncoding(*args):
2265 """
a97cefba
RD
2266 Font_GetDefaultEncoding() -> int
2267
2268 Returns the encoding used for all fonts created with an encoding of
2269 ``wx.FONTENCODING_DEFAULT``.
2270 """
1bd55598 2271 return _gdi_.Font_GetDefaultEncoding(*args)
d55e5bfc
RD
2272
2273def Font_SetDefaultEncoding(*args, **kwargs):
1bd55598 2274 """
a97cefba
RD
2275 Font_SetDefaultEncoding(int encoding)
2276
2277 Sets the default font encoding.
2278 """
1bd55598 2279 return _gdi_.Font_SetDefaultEncoding(*args, **kwargs)
d55e5bfc 2280
a97cefba 2281Font2 = wx._deprecated(FFont, "Use `wx.FFont` instead.")
d55e5bfc
RD
2282#---------------------------------------------------------------------------
2283
2284class FontEnumerator(object):
36ed4f51 2285 """Proxy of C++ FontEnumerator class"""
1bd55598
RD
2286 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2287 __repr__ = _swig_repr
2288 def __init__(self, *args, **kwargs):
d55e5bfc 2289 """__init__(self) -> FontEnumerator"""
1bd55598 2290 _gdi_.FontEnumerator_swiginit(self,_gdi_.new_FontEnumerator(*args, **kwargs))
d55e5bfc
RD
2291 self._setCallbackInfo(self, FontEnumerator, 0)
2292
1bd55598
RD
2293 __swig_destroy__ = _gdi_.delete_FontEnumerator
2294 __del__ = lambda self : None;
d55e5bfc
RD
2295 def _setCallbackInfo(*args, **kwargs):
2296 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
2297 return _gdi_.FontEnumerator__setCallbackInfo(*args, **kwargs)
2298
2299 def EnumerateFacenames(*args, **kwargs):
2300 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
2301 return _gdi_.FontEnumerator_EnumerateFacenames(*args, **kwargs)
2302
2303 def EnumerateEncodings(*args, **kwargs):
2304 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
2305 return _gdi_.FontEnumerator_EnumerateEncodings(*args, **kwargs)
2306
2307 def GetEncodings(*args, **kwargs):
704eda0c 2308 """GetEncodings() -> PyObject"""
d55e5bfc
RD
2309 return _gdi_.FontEnumerator_GetEncodings(*args, **kwargs)
2310
704eda0c 2311 GetEncodings = staticmethod(GetEncodings)
d55e5bfc 2312 def GetFacenames(*args, **kwargs):
704eda0c 2313 """GetFacenames() -> PyObject"""
d55e5bfc
RD
2314 return _gdi_.FontEnumerator_GetFacenames(*args, **kwargs)
2315
704eda0c
RD
2316 GetFacenames = staticmethod(GetFacenames)
2317 def IsValidFacename(*args, **kwargs):
2318 """
2319 IsValidFacename(String str) -> bool
2320
2321 Convenience function that returns true if the given face name exist in
2322 the user's system
2323 """
2324 return _gdi_.FontEnumerator_IsValidFacename(*args, **kwargs)
2325
2326 IsValidFacename = staticmethod(IsValidFacename)
2131d850 2327_gdi_.FontEnumerator_swigregister(FontEnumerator)
d55e5bfc 2328
704eda0c
RD
2329def FontEnumerator_GetEncodings(*args):
2330 """FontEnumerator_GetEncodings() -> PyObject"""
2331 return _gdi_.FontEnumerator_GetEncodings(*args)
2332
2333def FontEnumerator_GetFacenames(*args):
2334 """FontEnumerator_GetFacenames() -> PyObject"""
2335 return _gdi_.FontEnumerator_GetFacenames(*args)
2336
2337def FontEnumerator_IsValidFacename(*args, **kwargs):
2338 """
2339 FontEnumerator_IsValidFacename(String str) -> bool
2340
2341 Convenience function that returns true if the given face name exist in
2342 the user's system
2343 """
2344 return _gdi_.FontEnumerator_IsValidFacename(*args, **kwargs)
2345
d55e5bfc
RD
2346#---------------------------------------------------------------------------
2347
2348LANGUAGE_DEFAULT = _gdi_.LANGUAGE_DEFAULT
2349LANGUAGE_UNKNOWN = _gdi_.LANGUAGE_UNKNOWN
2350LANGUAGE_ABKHAZIAN = _gdi_.LANGUAGE_ABKHAZIAN
2351LANGUAGE_AFAR = _gdi_.LANGUAGE_AFAR
2352LANGUAGE_AFRIKAANS = _gdi_.LANGUAGE_AFRIKAANS
2353LANGUAGE_ALBANIAN = _gdi_.LANGUAGE_ALBANIAN
2354LANGUAGE_AMHARIC = _gdi_.LANGUAGE_AMHARIC
2355LANGUAGE_ARABIC = _gdi_.LANGUAGE_ARABIC
2356LANGUAGE_ARABIC_ALGERIA = _gdi_.LANGUAGE_ARABIC_ALGERIA
2357LANGUAGE_ARABIC_BAHRAIN = _gdi_.LANGUAGE_ARABIC_BAHRAIN
2358LANGUAGE_ARABIC_EGYPT = _gdi_.LANGUAGE_ARABIC_EGYPT
2359LANGUAGE_ARABIC_IRAQ = _gdi_.LANGUAGE_ARABIC_IRAQ
2360LANGUAGE_ARABIC_JORDAN = _gdi_.LANGUAGE_ARABIC_JORDAN
2361LANGUAGE_ARABIC_KUWAIT = _gdi_.LANGUAGE_ARABIC_KUWAIT
2362LANGUAGE_ARABIC_LEBANON = _gdi_.LANGUAGE_ARABIC_LEBANON
2363LANGUAGE_ARABIC_LIBYA = _gdi_.LANGUAGE_ARABIC_LIBYA
2364LANGUAGE_ARABIC_MOROCCO = _gdi_.LANGUAGE_ARABIC_MOROCCO
2365LANGUAGE_ARABIC_OMAN = _gdi_.LANGUAGE_ARABIC_OMAN
2366LANGUAGE_ARABIC_QATAR = _gdi_.LANGUAGE_ARABIC_QATAR
2367LANGUAGE_ARABIC_SAUDI_ARABIA = _gdi_.LANGUAGE_ARABIC_SAUDI_ARABIA
2368LANGUAGE_ARABIC_SUDAN = _gdi_.LANGUAGE_ARABIC_SUDAN
2369LANGUAGE_ARABIC_SYRIA = _gdi_.LANGUAGE_ARABIC_SYRIA
2370LANGUAGE_ARABIC_TUNISIA = _gdi_.LANGUAGE_ARABIC_TUNISIA
2371LANGUAGE_ARABIC_UAE = _gdi_.LANGUAGE_ARABIC_UAE
2372LANGUAGE_ARABIC_YEMEN = _gdi_.LANGUAGE_ARABIC_YEMEN
2373LANGUAGE_ARMENIAN = _gdi_.LANGUAGE_ARMENIAN
2374LANGUAGE_ASSAMESE = _gdi_.LANGUAGE_ASSAMESE
2375LANGUAGE_AYMARA = _gdi_.LANGUAGE_AYMARA
2376LANGUAGE_AZERI = _gdi_.LANGUAGE_AZERI
2377LANGUAGE_AZERI_CYRILLIC = _gdi_.LANGUAGE_AZERI_CYRILLIC
2378LANGUAGE_AZERI_LATIN = _gdi_.LANGUAGE_AZERI_LATIN
2379LANGUAGE_BASHKIR = _gdi_.LANGUAGE_BASHKIR
2380LANGUAGE_BASQUE = _gdi_.LANGUAGE_BASQUE
2381LANGUAGE_BELARUSIAN = _gdi_.LANGUAGE_BELARUSIAN
2382LANGUAGE_BENGALI = _gdi_.LANGUAGE_BENGALI
2383LANGUAGE_BHUTANI = _gdi_.LANGUAGE_BHUTANI
2384LANGUAGE_BIHARI = _gdi_.LANGUAGE_BIHARI
2385LANGUAGE_BISLAMA = _gdi_.LANGUAGE_BISLAMA
2386LANGUAGE_BRETON = _gdi_.LANGUAGE_BRETON
2387LANGUAGE_BULGARIAN = _gdi_.LANGUAGE_BULGARIAN
2388LANGUAGE_BURMESE = _gdi_.LANGUAGE_BURMESE
2389LANGUAGE_CAMBODIAN = _gdi_.LANGUAGE_CAMBODIAN
2390LANGUAGE_CATALAN = _gdi_.LANGUAGE_CATALAN
2391LANGUAGE_CHINESE = _gdi_.LANGUAGE_CHINESE
2392LANGUAGE_CHINESE_SIMPLIFIED = _gdi_.LANGUAGE_CHINESE_SIMPLIFIED
2393LANGUAGE_CHINESE_TRADITIONAL = _gdi_.LANGUAGE_CHINESE_TRADITIONAL
2394LANGUAGE_CHINESE_HONGKONG = _gdi_.LANGUAGE_CHINESE_HONGKONG
2395LANGUAGE_CHINESE_MACAU = _gdi_.LANGUAGE_CHINESE_MACAU
2396LANGUAGE_CHINESE_SINGAPORE = _gdi_.LANGUAGE_CHINESE_SINGAPORE
2397LANGUAGE_CHINESE_TAIWAN = _gdi_.LANGUAGE_CHINESE_TAIWAN
2398LANGUAGE_CORSICAN = _gdi_.LANGUAGE_CORSICAN
2399LANGUAGE_CROATIAN = _gdi_.LANGUAGE_CROATIAN
2400LANGUAGE_CZECH = _gdi_.LANGUAGE_CZECH
2401LANGUAGE_DANISH = _gdi_.LANGUAGE_DANISH
2402LANGUAGE_DUTCH = _gdi_.LANGUAGE_DUTCH
2403LANGUAGE_DUTCH_BELGIAN = _gdi_.LANGUAGE_DUTCH_BELGIAN
2404LANGUAGE_ENGLISH = _gdi_.LANGUAGE_ENGLISH
2405LANGUAGE_ENGLISH_UK = _gdi_.LANGUAGE_ENGLISH_UK
2406LANGUAGE_ENGLISH_US = _gdi_.LANGUAGE_ENGLISH_US
2407LANGUAGE_ENGLISH_AUSTRALIA = _gdi_.LANGUAGE_ENGLISH_AUSTRALIA
2408LANGUAGE_ENGLISH_BELIZE = _gdi_.LANGUAGE_ENGLISH_BELIZE
2409LANGUAGE_ENGLISH_BOTSWANA = _gdi_.LANGUAGE_ENGLISH_BOTSWANA
2410LANGUAGE_ENGLISH_CANADA = _gdi_.LANGUAGE_ENGLISH_CANADA
2411LANGUAGE_ENGLISH_CARIBBEAN = _gdi_.LANGUAGE_ENGLISH_CARIBBEAN
2412LANGUAGE_ENGLISH_DENMARK = _gdi_.LANGUAGE_ENGLISH_DENMARK
2413LANGUAGE_ENGLISH_EIRE = _gdi_.LANGUAGE_ENGLISH_EIRE
2414LANGUAGE_ENGLISH_JAMAICA = _gdi_.LANGUAGE_ENGLISH_JAMAICA
2415LANGUAGE_ENGLISH_NEW_ZEALAND = _gdi_.LANGUAGE_ENGLISH_NEW_ZEALAND
2416LANGUAGE_ENGLISH_PHILIPPINES = _gdi_.LANGUAGE_ENGLISH_PHILIPPINES
2417LANGUAGE_ENGLISH_SOUTH_AFRICA = _gdi_.LANGUAGE_ENGLISH_SOUTH_AFRICA
2418LANGUAGE_ENGLISH_TRINIDAD = _gdi_.LANGUAGE_ENGLISH_TRINIDAD
2419LANGUAGE_ENGLISH_ZIMBABWE = _gdi_.LANGUAGE_ENGLISH_ZIMBABWE
2420LANGUAGE_ESPERANTO = _gdi_.LANGUAGE_ESPERANTO
2421LANGUAGE_ESTONIAN = _gdi_.LANGUAGE_ESTONIAN
2422LANGUAGE_FAEROESE = _gdi_.LANGUAGE_FAEROESE
2423LANGUAGE_FARSI = _gdi_.LANGUAGE_FARSI
2424LANGUAGE_FIJI = _gdi_.LANGUAGE_FIJI
2425LANGUAGE_FINNISH = _gdi_.LANGUAGE_FINNISH
2426LANGUAGE_FRENCH = _gdi_.LANGUAGE_FRENCH
2427LANGUAGE_FRENCH_BELGIAN = _gdi_.LANGUAGE_FRENCH_BELGIAN
2428LANGUAGE_FRENCH_CANADIAN = _gdi_.LANGUAGE_FRENCH_CANADIAN
2429LANGUAGE_FRENCH_LUXEMBOURG = _gdi_.LANGUAGE_FRENCH_LUXEMBOURG
2430LANGUAGE_FRENCH_MONACO = _gdi_.LANGUAGE_FRENCH_MONACO
2431LANGUAGE_FRENCH_SWISS = _gdi_.LANGUAGE_FRENCH_SWISS
2432LANGUAGE_FRISIAN = _gdi_.LANGUAGE_FRISIAN
2433LANGUAGE_GALICIAN = _gdi_.LANGUAGE_GALICIAN
2434LANGUAGE_GEORGIAN = _gdi_.LANGUAGE_GEORGIAN
2435LANGUAGE_GERMAN = _gdi_.LANGUAGE_GERMAN
2436LANGUAGE_GERMAN_AUSTRIAN = _gdi_.LANGUAGE_GERMAN_AUSTRIAN
2437LANGUAGE_GERMAN_BELGIUM = _gdi_.LANGUAGE_GERMAN_BELGIUM
2438LANGUAGE_GERMAN_LIECHTENSTEIN = _gdi_.LANGUAGE_GERMAN_LIECHTENSTEIN
2439LANGUAGE_GERMAN_LUXEMBOURG = _gdi_.LANGUAGE_GERMAN_LUXEMBOURG
2440LANGUAGE_GERMAN_SWISS = _gdi_.LANGUAGE_GERMAN_SWISS
2441LANGUAGE_GREEK = _gdi_.LANGUAGE_GREEK
2442LANGUAGE_GREENLANDIC = _gdi_.LANGUAGE_GREENLANDIC
2443LANGUAGE_GUARANI = _gdi_.LANGUAGE_GUARANI
2444LANGUAGE_GUJARATI = _gdi_.LANGUAGE_GUJARATI
2445LANGUAGE_HAUSA = _gdi_.LANGUAGE_HAUSA
2446LANGUAGE_HEBREW = _gdi_.LANGUAGE_HEBREW
2447LANGUAGE_HINDI = _gdi_.LANGUAGE_HINDI
2448LANGUAGE_HUNGARIAN = _gdi_.LANGUAGE_HUNGARIAN
2449LANGUAGE_ICELANDIC = _gdi_.LANGUAGE_ICELANDIC
2450LANGUAGE_INDONESIAN = _gdi_.LANGUAGE_INDONESIAN
2451LANGUAGE_INTERLINGUA = _gdi_.LANGUAGE_INTERLINGUA
2452LANGUAGE_INTERLINGUE = _gdi_.LANGUAGE_INTERLINGUE
2453LANGUAGE_INUKTITUT = _gdi_.LANGUAGE_INUKTITUT
2454LANGUAGE_INUPIAK = _gdi_.LANGUAGE_INUPIAK
2455LANGUAGE_IRISH = _gdi_.LANGUAGE_IRISH
2456LANGUAGE_ITALIAN = _gdi_.LANGUAGE_ITALIAN
2457LANGUAGE_ITALIAN_SWISS = _gdi_.LANGUAGE_ITALIAN_SWISS
2458LANGUAGE_JAPANESE = _gdi_.LANGUAGE_JAPANESE
2459LANGUAGE_JAVANESE = _gdi_.LANGUAGE_JAVANESE
2460LANGUAGE_KANNADA = _gdi_.LANGUAGE_KANNADA
2461LANGUAGE_KASHMIRI = _gdi_.LANGUAGE_KASHMIRI
2462LANGUAGE_KASHMIRI_INDIA = _gdi_.LANGUAGE_KASHMIRI_INDIA
2463LANGUAGE_KAZAKH = _gdi_.LANGUAGE_KAZAKH
2464LANGUAGE_KERNEWEK = _gdi_.LANGUAGE_KERNEWEK
2465LANGUAGE_KINYARWANDA = _gdi_.LANGUAGE_KINYARWANDA
2466LANGUAGE_KIRGHIZ = _gdi_.LANGUAGE_KIRGHIZ
2467LANGUAGE_KIRUNDI = _gdi_.LANGUAGE_KIRUNDI
2468LANGUAGE_KONKANI = _gdi_.LANGUAGE_KONKANI
2469LANGUAGE_KOREAN = _gdi_.LANGUAGE_KOREAN
2470LANGUAGE_KURDISH = _gdi_.LANGUAGE_KURDISH
2471LANGUAGE_LAOTHIAN = _gdi_.LANGUAGE_LAOTHIAN
2472LANGUAGE_LATIN = _gdi_.LANGUAGE_LATIN
2473LANGUAGE_LATVIAN = _gdi_.LANGUAGE_LATVIAN
2474LANGUAGE_LINGALA = _gdi_.LANGUAGE_LINGALA
2475LANGUAGE_LITHUANIAN = _gdi_.LANGUAGE_LITHUANIAN
2476LANGUAGE_MACEDONIAN = _gdi_.LANGUAGE_MACEDONIAN
2477LANGUAGE_MALAGASY = _gdi_.LANGUAGE_MALAGASY
2478LANGUAGE_MALAY = _gdi_.LANGUAGE_MALAY
2479LANGUAGE_MALAYALAM = _gdi_.LANGUAGE_MALAYALAM
2480LANGUAGE_MALAY_BRUNEI_DARUSSALAM = _gdi_.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2481LANGUAGE_MALAY_MALAYSIA = _gdi_.LANGUAGE_MALAY_MALAYSIA
2482LANGUAGE_MALTESE = _gdi_.LANGUAGE_MALTESE
2483LANGUAGE_MANIPURI = _gdi_.LANGUAGE_MANIPURI
2484LANGUAGE_MAORI = _gdi_.LANGUAGE_MAORI
2485LANGUAGE_MARATHI = _gdi_.LANGUAGE_MARATHI
2486LANGUAGE_MOLDAVIAN = _gdi_.LANGUAGE_MOLDAVIAN
2487LANGUAGE_MONGOLIAN = _gdi_.LANGUAGE_MONGOLIAN
2488LANGUAGE_NAURU = _gdi_.LANGUAGE_NAURU
2489LANGUAGE_NEPALI = _gdi_.LANGUAGE_NEPALI
2490LANGUAGE_NEPALI_INDIA = _gdi_.LANGUAGE_NEPALI_INDIA
2491LANGUAGE_NORWEGIAN_BOKMAL = _gdi_.LANGUAGE_NORWEGIAN_BOKMAL
2492LANGUAGE_NORWEGIAN_NYNORSK = _gdi_.LANGUAGE_NORWEGIAN_NYNORSK
2493LANGUAGE_OCCITAN = _gdi_.LANGUAGE_OCCITAN
2494LANGUAGE_ORIYA = _gdi_.LANGUAGE_ORIYA
2495LANGUAGE_OROMO = _gdi_.LANGUAGE_OROMO
2496LANGUAGE_PASHTO = _gdi_.LANGUAGE_PASHTO
2497LANGUAGE_POLISH = _gdi_.LANGUAGE_POLISH
2498LANGUAGE_PORTUGUESE = _gdi_.LANGUAGE_PORTUGUESE
2499LANGUAGE_PORTUGUESE_BRAZILIAN = _gdi_.LANGUAGE_PORTUGUESE_BRAZILIAN
2500LANGUAGE_PUNJABI = _gdi_.LANGUAGE_PUNJABI
2501LANGUAGE_QUECHUA = _gdi_.LANGUAGE_QUECHUA
2502LANGUAGE_RHAETO_ROMANCE = _gdi_.LANGUAGE_RHAETO_ROMANCE
2503LANGUAGE_ROMANIAN = _gdi_.LANGUAGE_ROMANIAN
2504LANGUAGE_RUSSIAN = _gdi_.LANGUAGE_RUSSIAN
2505LANGUAGE_RUSSIAN_UKRAINE = _gdi_.LANGUAGE_RUSSIAN_UKRAINE
2506LANGUAGE_SAMOAN = _gdi_.LANGUAGE_SAMOAN
2507LANGUAGE_SANGHO = _gdi_.LANGUAGE_SANGHO
2508LANGUAGE_SANSKRIT = _gdi_.LANGUAGE_SANSKRIT
2509LANGUAGE_SCOTS_GAELIC = _gdi_.LANGUAGE_SCOTS_GAELIC
2510LANGUAGE_SERBIAN = _gdi_.LANGUAGE_SERBIAN
2511LANGUAGE_SERBIAN_CYRILLIC = _gdi_.LANGUAGE_SERBIAN_CYRILLIC
2512LANGUAGE_SERBIAN_LATIN = _gdi_.LANGUAGE_SERBIAN_LATIN
2513LANGUAGE_SERBO_CROATIAN = _gdi_.LANGUAGE_SERBO_CROATIAN
2514LANGUAGE_SESOTHO = _gdi_.LANGUAGE_SESOTHO
2515LANGUAGE_SETSWANA = _gdi_.LANGUAGE_SETSWANA
2516LANGUAGE_SHONA = _gdi_.LANGUAGE_SHONA
2517LANGUAGE_SINDHI = _gdi_.LANGUAGE_SINDHI
2518LANGUAGE_SINHALESE = _gdi_.LANGUAGE_SINHALESE
2519LANGUAGE_SISWATI = _gdi_.LANGUAGE_SISWATI
2520LANGUAGE_SLOVAK = _gdi_.LANGUAGE_SLOVAK
2521LANGUAGE_SLOVENIAN = _gdi_.LANGUAGE_SLOVENIAN
2522LANGUAGE_SOMALI = _gdi_.LANGUAGE_SOMALI
2523LANGUAGE_SPANISH = _gdi_.LANGUAGE_SPANISH
2524LANGUAGE_SPANISH_ARGENTINA = _gdi_.LANGUAGE_SPANISH_ARGENTINA
2525LANGUAGE_SPANISH_BOLIVIA = _gdi_.LANGUAGE_SPANISH_BOLIVIA
2526LANGUAGE_SPANISH_CHILE = _gdi_.LANGUAGE_SPANISH_CHILE
2527LANGUAGE_SPANISH_COLOMBIA = _gdi_.LANGUAGE_SPANISH_COLOMBIA
2528LANGUAGE_SPANISH_COSTA_RICA = _gdi_.LANGUAGE_SPANISH_COSTA_RICA
2529LANGUAGE_SPANISH_DOMINICAN_REPUBLIC = _gdi_.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2530LANGUAGE_SPANISH_ECUADOR = _gdi_.LANGUAGE_SPANISH_ECUADOR
2531LANGUAGE_SPANISH_EL_SALVADOR = _gdi_.LANGUAGE_SPANISH_EL_SALVADOR
2532LANGUAGE_SPANISH_GUATEMALA = _gdi_.LANGUAGE_SPANISH_GUATEMALA
2533LANGUAGE_SPANISH_HONDURAS = _gdi_.LANGUAGE_SPANISH_HONDURAS
2534LANGUAGE_SPANISH_MEXICAN = _gdi_.LANGUAGE_SPANISH_MEXICAN
2535LANGUAGE_SPANISH_MODERN = _gdi_.LANGUAGE_SPANISH_MODERN
2536LANGUAGE_SPANISH_NICARAGUA = _gdi_.LANGUAGE_SPANISH_NICARAGUA
2537LANGUAGE_SPANISH_PANAMA = _gdi_.LANGUAGE_SPANISH_PANAMA
2538LANGUAGE_SPANISH_PARAGUAY = _gdi_.LANGUAGE_SPANISH_PARAGUAY
2539LANGUAGE_SPANISH_PERU = _gdi_.LANGUAGE_SPANISH_PERU
2540LANGUAGE_SPANISH_PUERTO_RICO = _gdi_.LANGUAGE_SPANISH_PUERTO_RICO
2541LANGUAGE_SPANISH_URUGUAY = _gdi_.LANGUAGE_SPANISH_URUGUAY
2542LANGUAGE_SPANISH_US = _gdi_.LANGUAGE_SPANISH_US
2543LANGUAGE_SPANISH_VENEZUELA = _gdi_.LANGUAGE_SPANISH_VENEZUELA
2544LANGUAGE_SUNDANESE = _gdi_.LANGUAGE_SUNDANESE
2545LANGUAGE_SWAHILI = _gdi_.LANGUAGE_SWAHILI
2546LANGUAGE_SWEDISH = _gdi_.LANGUAGE_SWEDISH
2547LANGUAGE_SWEDISH_FINLAND = _gdi_.LANGUAGE_SWEDISH_FINLAND
2548LANGUAGE_TAGALOG = _gdi_.LANGUAGE_TAGALOG
2549LANGUAGE_TAJIK = _gdi_.LANGUAGE_TAJIK
2550LANGUAGE_TAMIL = _gdi_.LANGUAGE_TAMIL
2551LANGUAGE_TATAR = _gdi_.LANGUAGE_TATAR
2552LANGUAGE_TELUGU = _gdi_.LANGUAGE_TELUGU
2553LANGUAGE_THAI = _gdi_.LANGUAGE_THAI
2554LANGUAGE_TIBETAN = _gdi_.LANGUAGE_TIBETAN
2555LANGUAGE_TIGRINYA = _gdi_.LANGUAGE_TIGRINYA
2556LANGUAGE_TONGA = _gdi_.LANGUAGE_TONGA
2557LANGUAGE_TSONGA = _gdi_.LANGUAGE_TSONGA
2558LANGUAGE_TURKISH = _gdi_.LANGUAGE_TURKISH
2559LANGUAGE_TURKMEN = _gdi_.LANGUAGE_TURKMEN
2560LANGUAGE_TWI = _gdi_.LANGUAGE_TWI
2561LANGUAGE_UIGHUR = _gdi_.LANGUAGE_UIGHUR
2562LANGUAGE_UKRAINIAN = _gdi_.LANGUAGE_UKRAINIAN
2563LANGUAGE_URDU = _gdi_.LANGUAGE_URDU
2564LANGUAGE_URDU_INDIA = _gdi_.LANGUAGE_URDU_INDIA
2565LANGUAGE_URDU_PAKISTAN = _gdi_.LANGUAGE_URDU_PAKISTAN
2566LANGUAGE_UZBEK = _gdi_.LANGUAGE_UZBEK
2567LANGUAGE_UZBEK_CYRILLIC = _gdi_.LANGUAGE_UZBEK_CYRILLIC
2568LANGUAGE_UZBEK_LATIN = _gdi_.LANGUAGE_UZBEK_LATIN
2569LANGUAGE_VIETNAMESE = _gdi_.LANGUAGE_VIETNAMESE
2570LANGUAGE_VOLAPUK = _gdi_.LANGUAGE_VOLAPUK
2571LANGUAGE_WELSH = _gdi_.LANGUAGE_WELSH
2572LANGUAGE_WOLOF = _gdi_.LANGUAGE_WOLOF
2573LANGUAGE_XHOSA = _gdi_.LANGUAGE_XHOSA
2574LANGUAGE_YIDDISH = _gdi_.LANGUAGE_YIDDISH
2575LANGUAGE_YORUBA = _gdi_.LANGUAGE_YORUBA
2576LANGUAGE_ZHUANG = _gdi_.LANGUAGE_ZHUANG
2577LANGUAGE_ZULU = _gdi_.LANGUAGE_ZULU
2578LANGUAGE_USER_DEFINED = _gdi_.LANGUAGE_USER_DEFINED
2579class LanguageInfo(object):
36ed4f51 2580 """Proxy of C++ LanguageInfo class"""
1bd55598
RD
2581 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2582 def __init__(self): raise AttributeError, "No constructor defined"
2583 __repr__ = _swig_repr
d55e5bfc
RD
2584 Language = property(_gdi_.LanguageInfo_Language_get, _gdi_.LanguageInfo_Language_set)
2585 CanonicalName = property(_gdi_.LanguageInfo_CanonicalName_get, _gdi_.LanguageInfo_CanonicalName_set)
2586 Description = property(_gdi_.LanguageInfo_Description_get, _gdi_.LanguageInfo_Description_set)
2131d850 2587_gdi_.LanguageInfo_swigregister(LanguageInfo)
d55e5bfc
RD
2588
2589LOCALE_CAT_NUMBER = _gdi_.LOCALE_CAT_NUMBER
2590LOCALE_CAT_DATE = _gdi_.LOCALE_CAT_DATE
2591LOCALE_CAT_MONEY = _gdi_.LOCALE_CAT_MONEY
2592LOCALE_CAT_MAX = _gdi_.LOCALE_CAT_MAX
2593LOCALE_THOUSANDS_SEP = _gdi_.LOCALE_THOUSANDS_SEP
2594LOCALE_DECIMAL_POINT = _gdi_.LOCALE_DECIMAL_POINT
2595LOCALE_LOAD_DEFAULT = _gdi_.LOCALE_LOAD_DEFAULT
2596LOCALE_CONV_ENCODING = _gdi_.LOCALE_CONV_ENCODING
2597class Locale(object):
36ed4f51 2598 """Proxy of C++ Locale class"""
1bd55598
RD
2599 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2600 __repr__ = _swig_repr
2601 def __init__(self, *args, **kwargs):
15817c7e 2602 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
1bd55598
RD
2603 _gdi_.Locale_swiginit(self,_gdi_.new_Locale(*args, **kwargs))
2604 __swig_destroy__ = _gdi_.delete_Locale
2605 __del__ = lambda self : None;
d55e5bfc
RD
2606 def Init1(*args, **kwargs):
2607 """
2608 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
2609 bool bLoadDefault=True,
2610 bool bConvertEncoding=False) -> bool
2611 """
2612 return _gdi_.Locale_Init1(*args, **kwargs)
2613
2614 def Init2(*args, **kwargs):
2615 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
2616 return _gdi_.Locale_Init2(*args, **kwargs)
2617
2618 def Init(self, *_args, **_kwargs):
2619 if type(_args[0]) in [type(''), type(u'')]:
2620 val = self.Init1(*_args, **_kwargs)
2621 else:
2622 val = self.Init2(*_args, **_kwargs)
2623 return val
2624
2625 def GetSystemLanguage(*args, **kwargs):
d6c14a4c 2626 """GetSystemLanguage() -> int"""
d55e5bfc
RD
2627 return _gdi_.Locale_GetSystemLanguage(*args, **kwargs)
2628
2629 GetSystemLanguage = staticmethod(GetSystemLanguage)
2630 def GetSystemEncoding(*args, **kwargs):
d6c14a4c 2631 """GetSystemEncoding() -> int"""
d55e5bfc
RD
2632 return _gdi_.Locale_GetSystemEncoding(*args, **kwargs)
2633
2634 GetSystemEncoding = staticmethod(GetSystemEncoding)
2635 def GetSystemEncodingName(*args, **kwargs):
d6c14a4c 2636 """GetSystemEncodingName() -> String"""
d55e5bfc
RD
2637 return _gdi_.Locale_GetSystemEncodingName(*args, **kwargs)
2638
2639 GetSystemEncodingName = staticmethod(GetSystemEncodingName)
2640 def IsOk(*args, **kwargs):
2641 """IsOk(self) -> bool"""
2642 return _gdi_.Locale_IsOk(*args, **kwargs)
2643
2644 def __nonzero__(self): return self.IsOk()
2645 def GetLocale(*args, **kwargs):
2646 """GetLocale(self) -> String"""
2647 return _gdi_.Locale_GetLocale(*args, **kwargs)
2648
2649 def GetLanguage(*args, **kwargs):
2650 """GetLanguage(self) -> int"""
2651 return _gdi_.Locale_GetLanguage(*args, **kwargs)
2652
2653 def GetSysName(*args, **kwargs):
2654 """GetSysName(self) -> String"""
2655 return _gdi_.Locale_GetSysName(*args, **kwargs)
2656
2657 def GetCanonicalName(*args, **kwargs):
2658 """GetCanonicalName(self) -> String"""
2659 return _gdi_.Locale_GetCanonicalName(*args, **kwargs)
2660
2661 def AddCatalogLookupPathPrefix(*args, **kwargs):
d6c14a4c 2662 """AddCatalogLookupPathPrefix(String prefix)"""
d55e5bfc
RD
2663 return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs)
2664
2665 AddCatalogLookupPathPrefix = staticmethod(AddCatalogLookupPathPrefix)
2666 def AddCatalog(*args, **kwargs):
2667 """AddCatalog(self, String szDomain) -> bool"""
2668 return _gdi_.Locale_AddCatalog(*args, **kwargs)
2669
33d6fd3b
RD
2670 def IsAvailable(*args, **kwargs):
2671 """IsAvailable(int lang) -> bool"""
2672 return _gdi_.Locale_IsAvailable(*args, **kwargs)
2673
2674 IsAvailable = staticmethod(IsAvailable)
d55e5bfc
RD
2675 def IsLoaded(*args, **kwargs):
2676 """IsLoaded(self, String szDomain) -> bool"""
2677 return _gdi_.Locale_IsLoaded(*args, **kwargs)
2678
2679 def GetLanguageInfo(*args, **kwargs):
d6c14a4c 2680 """GetLanguageInfo(int lang) -> LanguageInfo"""
d55e5bfc
RD
2681 return _gdi_.Locale_GetLanguageInfo(*args, **kwargs)
2682
2683 GetLanguageInfo = staticmethod(GetLanguageInfo)
2684 def GetLanguageName(*args, **kwargs):
d6c14a4c 2685 """GetLanguageName(int lang) -> String"""
d55e5bfc
RD
2686 return _gdi_.Locale_GetLanguageName(*args, **kwargs)
2687
2688 GetLanguageName = staticmethod(GetLanguageName)
2689 def FindLanguageInfo(*args, **kwargs):
d6c14a4c 2690 """FindLanguageInfo(String locale) -> LanguageInfo"""
d55e5bfc
RD
2691 return _gdi_.Locale_FindLanguageInfo(*args, **kwargs)
2692
2693 FindLanguageInfo = staticmethod(FindLanguageInfo)
2694 def AddLanguage(*args, **kwargs):
d6c14a4c 2695 """AddLanguage(LanguageInfo info)"""
d55e5bfc
RD
2696 return _gdi_.Locale_AddLanguage(*args, **kwargs)
2697
2698 AddLanguage = staticmethod(AddLanguage)
2699 def GetString(*args, **kwargs):
2700 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
2701 return _gdi_.Locale_GetString(*args, **kwargs)
2702
2703 def GetName(*args, **kwargs):
2704 """GetName(self) -> String"""
2705 return _gdi_.Locale_GetName(*args, **kwargs)
2706
ac5d357a
RD
2707 CanonicalName = property(GetCanonicalName,doc="See `GetCanonicalName`")
2708 Language = property(GetLanguage,doc="See `GetLanguage`")
2709 Locale = property(GetLocale,doc="See `GetLocale`")
2710 Name = property(GetName,doc="See `GetName`")
2711 String = property(GetString,doc="See `GetString`")
2712 SysName = property(GetSysName,doc="See `GetSysName`")
2131d850 2713_gdi_.Locale_swigregister(Locale)
d55e5bfc 2714
1bd55598
RD
2715def Locale_GetSystemLanguage(*args):
2716 """Locale_GetSystemLanguage() -> int"""
2717 return _gdi_.Locale_GetSystemLanguage(*args)
d55e5bfc 2718
1bd55598
RD
2719def Locale_GetSystemEncoding(*args):
2720 """Locale_GetSystemEncoding() -> int"""
2721 return _gdi_.Locale_GetSystemEncoding(*args)
d55e5bfc 2722
1bd55598
RD
2723def Locale_GetSystemEncodingName(*args):
2724 """Locale_GetSystemEncodingName() -> String"""
2725 return _gdi_.Locale_GetSystemEncodingName(*args)
d55e5bfc
RD
2726
2727def Locale_AddCatalogLookupPathPrefix(*args, **kwargs):
1bd55598
RD
2728 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
2729 return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs)
d55e5bfc 2730
33d6fd3b
RD
2731def Locale_IsAvailable(*args, **kwargs):
2732 """Locale_IsAvailable(int lang) -> bool"""
2733 return _gdi_.Locale_IsAvailable(*args, **kwargs)
2734
d55e5bfc 2735def Locale_GetLanguageInfo(*args, **kwargs):
1bd55598
RD
2736 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
2737 return _gdi_.Locale_GetLanguageInfo(*args, **kwargs)
d55e5bfc
RD
2738
2739def Locale_GetLanguageName(*args, **kwargs):
1bd55598
RD
2740 """Locale_GetLanguageName(int lang) -> String"""
2741 return _gdi_.Locale_GetLanguageName(*args, **kwargs)
d55e5bfc
RD
2742
2743def Locale_FindLanguageInfo(*args, **kwargs):
1bd55598
RD
2744 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
2745 return _gdi_.Locale_FindLanguageInfo(*args, **kwargs)
d55e5bfc
RD
2746
2747def Locale_AddLanguage(*args, **kwargs):
1bd55598
RD
2748 """Locale_AddLanguage(LanguageInfo info)"""
2749 return _gdi_.Locale_AddLanguage(*args, **kwargs)
d55e5bfc 2750
fc46b7f3
RD
2751class PyLocale(Locale):
2752 """Proxy of C++ PyLocale class"""
2753 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2754 __repr__ = _swig_repr
2755 def __init__(self, *args, **kwargs):
2756 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> PyLocale"""
2757 _gdi_.PyLocale_swiginit(self,_gdi_.new_PyLocale(*args, **kwargs))
2758 self._setCallbackInfo(self, PyLocale)
2759
2760 __swig_destroy__ = _gdi_.delete_PyLocale
2761 __del__ = lambda self : None;
2762 def _setCallbackInfo(*args, **kwargs):
2763 """_setCallbackInfo(self, PyObject self, PyObject _class)"""
2764 return _gdi_.PyLocale__setCallbackInfo(*args, **kwargs)
2765
2766 def GetSingularString(*args, **kwargs):
2767 """GetSingularString(self, wxChar szOrigString, wxChar szDomain=None) -> wxChar"""
2768 return _gdi_.PyLocale_GetSingularString(*args, **kwargs)
2769
2770 def GetPluralString(*args, **kwargs):
2771 """
2772 GetPluralString(self, wxChar szOrigString, wxChar szOrigString2, size_t n,
2773 wxChar szDomain=None) -> wxChar
2774 """
2775 return _gdi_.PyLocale_GetPluralString(*args, **kwargs)
2776
2777_gdi_.PyLocale_swigregister(PyLocale)
2778
d55e5bfc 2779
1bd55598
RD
2780def GetLocale(*args):
2781 """GetLocale() -> Locale"""
2782 return _gdi_.GetLocale(*args)
d55e5bfc
RD
2783#---------------------------------------------------------------------------
2784
2785CONVERT_STRICT = _gdi_.CONVERT_STRICT
2786CONVERT_SUBSTITUTE = _gdi_.CONVERT_SUBSTITUTE
2787PLATFORM_CURRENT = _gdi_.PLATFORM_CURRENT
2788PLATFORM_UNIX = _gdi_.PLATFORM_UNIX
2789PLATFORM_WINDOWS = _gdi_.PLATFORM_WINDOWS
2790PLATFORM_OS2 = _gdi_.PLATFORM_OS2
2791PLATFORM_MAC = _gdi_.PLATFORM_MAC
2792class EncodingConverter(_core.Object):
36ed4f51 2793 """Proxy of C++ EncodingConverter class"""
1bd55598
RD
2794 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2795 __repr__ = _swig_repr
2796 def __init__(self, *args, **kwargs):
d55e5bfc 2797 """__init__(self) -> EncodingConverter"""
1bd55598
RD
2798 _gdi_.EncodingConverter_swiginit(self,_gdi_.new_EncodingConverter(*args, **kwargs))
2799 __swig_destroy__ = _gdi_.delete_EncodingConverter
2800 __del__ = lambda self : None;
d55e5bfc
RD
2801 def Init(*args, **kwargs):
2802 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
2803 return _gdi_.EncodingConverter_Init(*args, **kwargs)
2804
2805 def Convert(*args, **kwargs):
2806 """Convert(self, String input) -> String"""
2807 return _gdi_.EncodingConverter_Convert(*args, **kwargs)
2808
2809 def GetPlatformEquivalents(*args, **kwargs):
d6c14a4c 2810 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
d55e5bfc
RD
2811 return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs)
2812
2813 GetPlatformEquivalents = staticmethod(GetPlatformEquivalents)
2814 def GetAllEquivalents(*args, **kwargs):
d6c14a4c 2815 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
d55e5bfc
RD
2816 return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs)
2817
2818 GetAllEquivalents = staticmethod(GetAllEquivalents)
2819 def CanConvert(*args, **kwargs):
d6c14a4c 2820 """CanConvert(int encIn, int encOut) -> bool"""
d55e5bfc
RD
2821 return _gdi_.EncodingConverter_CanConvert(*args, **kwargs)
2822
2823 CanConvert = staticmethod(CanConvert)
2824 def __nonzero__(self): return self.IsOk()
2131d850 2825_gdi_.EncodingConverter_swigregister(EncodingConverter)
d55e5bfc
RD
2826
2827def GetTranslation(*args):
1bd55598 2828 """
d55e5bfc 2829 GetTranslation(String str) -> String
fc46b7f3 2830 GetTranslation(String str, String domain) -> String
d55e5bfc 2831 GetTranslation(String str, String strPlural, size_t n) -> String
fc46b7f3 2832 GetTranslation(String str, String strPlural, size_t n, String domain) -> String
d55e5bfc 2833 """
1bd55598 2834 return _gdi_.GetTranslation(*args)
d55e5bfc
RD
2835
2836def EncodingConverter_GetPlatformEquivalents(*args, **kwargs):
1bd55598
RD
2837 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
2838 return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs)
d55e5bfc
RD
2839
2840def EncodingConverter_GetAllEquivalents(*args, **kwargs):
1bd55598
RD
2841 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
2842 return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs)
d55e5bfc
RD
2843
2844def EncodingConverter_CanConvert(*args, **kwargs):
1bd55598
RD
2845 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
2846 return _gdi_.EncodingConverter_CanConvert(*args, **kwargs)
d55e5bfc
RD
2847
2848#----------------------------------------------------------------------------
68e533f8 2849# On MSW add the directory where the wxWidgets catalogs were installed
d55e5bfc
RD
2850# to the default catalog path.
2851if wx.Platform == "__WXMSW__":
2852 import os
c2829a8f 2853 _localedir = os.path.join(os.path.split(__file__)[0], "locale")
8fb0e70a 2854 Locale.AddCatalogLookupPathPrefix(_localedir)
d55e5bfc
RD
2855 del os
2856
2857#----------------------------------------------------------------------------
2858
2859#---------------------------------------------------------------------------
2860
2861class DC(_core.Object):
f5b96ee1
RD
2862 """
2863 A wx.DC is a device context onto which graphics and text can be
2864 drawn. It is intended to represent a number of output devices in a
2865 generic way, so a window can have a device context associated with it,
2866 and a printer also has a device context. In this way, the same piece
2867 of code may write to a number of different devices, if the device
2868 context is used as a parameter.
2869
2870 Derived types of wxDC have documentation for specific features only,
2871 so refer to this section for most device context information.
2872
2873 The wx.DC class is abstract and can not be instantiated, you must use
2874 one of the derived classes instead. Which one will depend on the
2875 situation in which it is used.
2876 """
1bd55598
RD
2877 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
2878 def __init__(self): raise AttributeError, "No constructor defined"
2879 __repr__ = _swig_repr
2880 __swig_destroy__ = _gdi_.delete_DC
2881 __del__ = lambda self : None;
7f7aa166
RD
2882 # These have been deprecated in wxWidgets. Since they never
2883 # really did anything to begin with, just make them be NOPs.
2884 def BeginDrawing(self): pass
2885 def EndDrawing(self): pass
d55e5bfc 2886
d55e5bfc 2887 def FloodFill(*args, **kwargs):
f5b96ee1
RD
2888 """
2889 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2890
2891 Flood fills the device context starting from the given point, using
2892 the current brush colour, and using a style:
2893
2894 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2895 the given colour is encountered.
2896
2897 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2898 colour.
2899
2900 Returns False if the operation failed.
2901
2902 Note: The present implementation for non-Windows platforms may fail to
2903 find colour borders if the pixels do not match the colour
2904 exactly. However the function will still return true.
2905 """
d55e5bfc
RD
2906 return _gdi_.DC_FloodFill(*args, **kwargs)
2907
d6c14a4c 2908 def FloodFillPoint(*args, **kwargs):
f5b96ee1
RD
2909 """
2910 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2911
2912 Flood fills the device context starting from the given point, using
2913 the current brush colour, and using a style:
2914
2915 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2916 the given colour is encountered.
2917
2918 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2919 colour.
2920
2921 Returns False if the operation failed.
2922
2923 Note: The present implementation for non-Windows platforms may fail to
2924 find colour borders if the pixels do not match the colour
2925 exactly. However the function will still return true.
2926 """
d6c14a4c 2927 return _gdi_.DC_FloodFillPoint(*args, **kwargs)
d55e5bfc 2928
b1fcee84
RD
2929 def GradientFillConcentric(*args, **kwargs):
2930 """
2931 GradientFillConcentric(self, Rect rect, Colour initialColour, Colour destColour,
2932 Point circleCenter)
2933
2934 Fill the area specified by rect with a radial gradient, starting from
2935 initialColour in the center of the circle and fading to destColour on
2936 the outside of the circle. The circleCenter argument is the relative
2937 coordinants of the center of the circle in the specified rect.
2938
2939 Note: Currently this function is very slow, don't use it for real-time
2940 drawing.
2941 """
2942 return _gdi_.DC_GradientFillConcentric(*args, **kwargs)
2943
2944 def GradientFillLinear(*args, **kwargs):
2945 """
2946 GradientFillLinear(self, Rect rect, Colour initialColour, Colour destColour,
2947 int nDirection=EAST)
2948
2949 Fill the area specified by rect with a linear gradient, starting from
2950 initialColour and eventually fading to destColour. The nDirection
2951 parameter specifies the direction of the colour change, default is to
2952 use initialColour on the left part of the rectangle and destColour on
2953 the right side.
2954 """
2955 return _gdi_.DC_GradientFillLinear(*args, **kwargs)
2956
d55e5bfc 2957 def GetPixel(*args, **kwargs):
f5b96ee1
RD
2958 """
2959 GetPixel(self, int x, int y) -> Colour
2960
2961 Gets the colour at the specified location on the DC.
2962 """
d55e5bfc
RD
2963 return _gdi_.DC_GetPixel(*args, **kwargs)
2964
d6c14a4c
RD
2965 def GetPixelPoint(*args, **kwargs):
2966 """GetPixelPoint(self, Point pt) -> Colour"""
2967 return _gdi_.DC_GetPixelPoint(*args, **kwargs)
d55e5bfc
RD
2968
2969 def DrawLine(*args, **kwargs):
f5b96ee1
RD
2970 """
2971 DrawLine(self, int x1, int y1, int x2, int y2)
2972
2973 Draws a line from the first point to the second. The current pen is
2974 used for drawing the line. Note that the second point is *not* part of
2975 the line and is not drawn by this function (this is consistent with
2976 the behaviour of many other toolkits).
2977 """
d55e5bfc
RD
2978 return _gdi_.DC_DrawLine(*args, **kwargs)
2979
d6c14a4c 2980 def DrawLinePoint(*args, **kwargs):
f5b96ee1
RD
2981 """
2982 DrawLinePoint(self, Point pt1, Point pt2)
2983
2984 Draws a line from the first point to the second. The current pen is
2985 used for drawing the line. Note that the second point is *not* part of
2986 the line and is not drawn by this function (this is consistent with
2987 the behaviour of many other toolkits).
2988 """
d6c14a4c 2989 return _gdi_.DC_DrawLinePoint(*args, **kwargs)
d55e5bfc
RD
2990
2991 def CrossHair(*args, **kwargs):
f5b96ee1
RD
2992 """
2993 CrossHair(self, int x, int y)
2994
2995 Displays a cross hair using the current pen. This is a vertical and
2996 horizontal line the height and width of the window, centred on the
2997 given point.
2998 """
d55e5bfc
RD
2999 return _gdi_.DC_CrossHair(*args, **kwargs)
3000
d6c14a4c 3001 def CrossHairPoint(*args, **kwargs):
f5b96ee1
RD
3002 """
3003 CrossHairPoint(self, Point pt)
3004
3005 Displays a cross hair using the current pen. This is a vertical and
3006 horizontal line the height and width of the window, centred on the
3007 given point.
3008 """
d6c14a4c 3009 return _gdi_.DC_CrossHairPoint(*args, **kwargs)
d55e5bfc
RD
3010
3011 def DrawArc(*args, **kwargs):
f5b96ee1
RD
3012 """
3013 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
3014
3015 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3016 the first point to the second. The current pen is used for the outline
3017 and the current brush for filling the shape.
3018
3019 The arc is drawn in an anticlockwise direction from the start point to
3020 the end point.
3021 """
d55e5bfc
RD
3022 return _gdi_.DC_DrawArc(*args, **kwargs)
3023
d6c14a4c 3024 def DrawArcPoint(*args, **kwargs):
f5b96ee1
RD
3025 """
3026 DrawArcPoint(self, Point pt1, Point pt2, Point center)
3027
3028 Draws an arc of a circle, centred on the *center* point (xc, yc), from
3029 the first point to the second. The current pen is used for the outline
3030 and the current brush for filling the shape.
3031
3032 The arc is drawn in an anticlockwise direction from the start point to
3033 the end point.
3034 """
d6c14a4c 3035 return _gdi_.DC_DrawArcPoint(*args, **kwargs)
d55e5bfc
RD
3036
3037 def DrawCheckMark(*args, **kwargs):
f5b96ee1
RD
3038 """
3039 DrawCheckMark(self, int x, int y, int width, int height)
3040
3041 Draws a check mark inside the given rectangle.
3042 """
d55e5bfc
RD
3043 return _gdi_.DC_DrawCheckMark(*args, **kwargs)
3044
d6c14a4c 3045 def DrawCheckMarkRect(*args, **kwargs):
f5b96ee1
RD
3046 """
3047 DrawCheckMarkRect(self, Rect rect)
3048
3049 Draws a check mark inside the given rectangle.
3050 """
d6c14a4c 3051 return _gdi_.DC_DrawCheckMarkRect(*args, **kwargs)
d55e5bfc
RD
3052
3053 def DrawEllipticArc(*args, **kwargs):
f5b96ee1
RD
3054 """
3055 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
3056
3057 Draws an arc of an ellipse, with the given rectangle defining the
3058 bounds of the ellipse. The current pen is used for drawing the arc and
3059 the current brush is used for drawing the pie.
3060
3061 The *start* and *end* parameters specify the start and end of the arc
3062 relative to the three-o'clock position from the center of the
3063 rectangle. Angles are specified in degrees (360 is a complete
3064 circle). Positive values mean counter-clockwise motion. If start is
3065 equal to end, a complete ellipse will be drawn.
3066 """
d55e5bfc
RD
3067 return _gdi_.DC_DrawEllipticArc(*args, **kwargs)
3068
d6c14a4c 3069 def DrawEllipticArcPointSize(*args, **kwargs):
f5b96ee1
RD
3070 """
3071 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
3072
3073 Draws an arc of an ellipse, with the given rectangle defining the
3074 bounds of the ellipse. The current pen is used for drawing the arc and
3075 the current brush is used for drawing the pie.
3076
3077 The *start* and *end* parameters specify the start and end of the arc
3078 relative to the three-o'clock position from the center of the
3079 rectangle. Angles are specified in degrees (360 is a complete
3080 circle). Positive values mean counter-clockwise motion. If start is
3081 equal to end, a complete ellipse will be drawn.
3082 """
d6c14a4c 3083 return _gdi_.DC_DrawEllipticArcPointSize(*args, **kwargs)
d55e5bfc
RD
3084
3085 def DrawPoint(*args, **kwargs):
f5b96ee1
RD
3086 """
3087 DrawPoint(self, int x, int y)
3088
3089 Draws a point using the current pen.
3090 """
d55e5bfc
RD
3091 return _gdi_.DC_DrawPoint(*args, **kwargs)
3092
d6c14a4c 3093 def DrawPointPoint(*args, **kwargs):
f5b96ee1
RD
3094 """
3095 DrawPointPoint(self, Point pt)
3096
3097 Draws a point using the current pen.
3098 """
d6c14a4c 3099 return _gdi_.DC_DrawPointPoint(*args, **kwargs)
d55e5bfc
RD
3100
3101 def DrawRectangle(*args, **kwargs):
f5b96ee1
RD
3102 """
3103 DrawRectangle(self, int x, int y, int width, int height)
3104
3105 Draws a rectangle with the given top left corner, and with the given
3106 size. The current pen is used for the outline and the current brush
3107 for filling the shape.
3108 """
d55e5bfc
RD
3109 return _gdi_.DC_DrawRectangle(*args, **kwargs)
3110
3111 def DrawRectangleRect(*args, **kwargs):
f5b96ee1
RD
3112 """
3113 DrawRectangleRect(self, Rect rect)
3114
3115 Draws a rectangle with the given top left corner, and with the given
3116 size. The current pen is used for the outline and the current brush
3117 for filling the shape.
3118 """
d55e5bfc
RD
3119 return _gdi_.DC_DrawRectangleRect(*args, **kwargs)
3120
d6c14a4c 3121 def DrawRectanglePointSize(*args, **kwargs):
f5b96ee1
RD
3122 """
3123 DrawRectanglePointSize(self, Point pt, Size sz)
3124
3125 Draws a rectangle with the given top left corner, and with the given
3126 size. The current pen is used for the outline and the current brush
3127 for filling the shape.
3128 """
d6c14a4c 3129 return _gdi_.DC_DrawRectanglePointSize(*args, **kwargs)
d55e5bfc
RD
3130
3131 def DrawRoundedRectangle(*args, **kwargs):
f5b96ee1
RD
3132 """
3133 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
3134
3135 Draws a rectangle with the given top left corner, and with the given
3136 size. The corners are quarter-circles using the given radius. The
3137 current pen is used for the outline and the current brush for filling
3138 the shape.
3139
3140 If radius is positive, the value is assumed to be the radius of the
3141 rounded corner. If radius is negative, the absolute value is assumed
3142 to be the proportion of the smallest dimension of the rectangle. This
3143 means that the corner can be a sensible size relative to the size of
3144 the rectangle, and also avoids the strange effects X produces when the
3145 corners are too big for the rectangle.
3146 """
d55e5bfc
RD
3147 return _gdi_.DC_DrawRoundedRectangle(*args, **kwargs)
3148
3149 def DrawRoundedRectangleRect(*args, **kwargs):
f5b96ee1
RD
3150 """
3151 DrawRoundedRectangleRect(self, Rect r, double radius)
3152
3153 Draws a rectangle with the given top left corner, and with the given
3154 size. The corners are quarter-circles using the given radius. The
3155 current pen is used for the outline and the current brush for filling
3156 the shape.
3157
3158 If radius is positive, the value is assumed to be the radius of the
3159 rounded corner. If radius is negative, the absolute value is assumed
3160 to be the proportion of the smallest dimension of the rectangle. This
3161 means that the corner can be a sensible size relative to the size of
3162 the rectangle, and also avoids the strange effects X produces when the
3163 corners are too big for the rectangle.
3164 """
d55e5bfc
RD
3165 return _gdi_.DC_DrawRoundedRectangleRect(*args, **kwargs)
3166
d6c14a4c 3167 def DrawRoundedRectanglePointSize(*args, **kwargs):
f5b96ee1
RD
3168 """
3169 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
3170
3171 Draws a rectangle with the given top left corner, and with the given
3172 size. The corners are quarter-circles using the given radius. The
3173 current pen is used for the outline and the current brush for filling
3174 the shape.
3175
3176 If radius is positive, the value is assumed to be the radius of the
3177 rounded corner. If radius is negative, the absolute value is assumed
3178 to be the proportion of the smallest dimension of the rectangle. This
3179 means that the corner can be a sensible size relative to the size of
3180 the rectangle, and also avoids the strange effects X produces when the
3181 corners are too big for the rectangle.
3182 """
d6c14a4c 3183 return _gdi_.DC_DrawRoundedRectanglePointSize(*args, **kwargs)
d55e5bfc
RD
3184
3185 def DrawCircle(*args, **kwargs):
f5b96ee1
RD
3186 """
3187 DrawCircle(self, int x, int y, int radius)
3188
3189 Draws a circle with the given center point and radius. The current
3190 pen is used for the outline and the current brush for filling the
3191 shape.
3192 """
d55e5bfc
RD
3193 return _gdi_.DC_DrawCircle(*args, **kwargs)
3194
d6c14a4c 3195 def DrawCirclePoint(*args, **kwargs):
f5b96ee1
RD
3196 """
3197 DrawCirclePoint(self, Point pt, int radius)
3198
3199 Draws a circle with the given center point and radius. The current
3200 pen is used for the outline and the current brush for filling the
3201 shape.
3202 """
d6c14a4c 3203 return _gdi_.DC_DrawCirclePoint(*args, **kwargs)
d55e5bfc
RD
3204
3205 def DrawEllipse(*args, **kwargs):
f5b96ee1
RD
3206 """
3207 DrawEllipse(self, int x, int y, int width, int height)
3208
3209 Draws an ellipse contained in the specified rectangle. The current pen
3210 is used for the outline and the current brush for filling the shape.
3211 """
d55e5bfc
RD
3212 return _gdi_.DC_DrawEllipse(*args, **kwargs)
3213
3214 def DrawEllipseRect(*args, **kwargs):
f5b96ee1
RD
3215 """
3216 DrawEllipseRect(self, Rect rect)
3217
3218 Draws an ellipse contained in the specified rectangle. The current pen
3219 is used for the outline and the current brush for filling the shape.
3220 """
d55e5bfc
RD
3221 return _gdi_.DC_DrawEllipseRect(*args, **kwargs)
3222
d6c14a4c 3223 def DrawEllipsePointSize(*args, **kwargs):
f5b96ee1
RD
3224 """
3225 DrawEllipsePointSize(self, Point pt, Size sz)
3226
3227 Draws an ellipse contained in the specified rectangle. The current pen
3228 is used for the outline and the current brush for filling the shape.
3229 """
d6c14a4c 3230 return _gdi_.DC_DrawEllipsePointSize(*args, **kwargs)
d55e5bfc
RD
3231
3232 def DrawIcon(*args, **kwargs):
f5b96ee1
RD
3233 """
3234 DrawIcon(self, Icon icon, int x, int y)
3235
3236 Draw an icon on the display (does nothing if the device context is
3237 PostScript). This can be the simplest way of drawing bitmaps on a
3238 window.
3239 """
d55e5bfc
RD
3240 return _gdi_.DC_DrawIcon(*args, **kwargs)
3241
d6c14a4c 3242 def DrawIconPoint(*args, **kwargs):
f5b96ee1
RD
3243 """
3244 DrawIconPoint(self, Icon icon, Point pt)
3245
3246 Draw an icon on the display (does nothing if the device context is
3247 PostScript). This can be the simplest way of drawing bitmaps on a
3248 window.
3249 """
d6c14a4c 3250 return _gdi_.DC_DrawIconPoint(*args, **kwargs)
d55e5bfc
RD
3251
3252 def DrawBitmap(*args, **kwargs):
f5b96ee1
RD
3253 """
3254 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
3255
3256 Draw a bitmap on the device context at the specified point. If
3257 *transparent* is true and the bitmap has a transparency mask, (or
3258 alpha channel on the platforms that support it) then the bitmap will
3259 be drawn transparently.
3260 """
d55e5bfc
RD
3261 return _gdi_.DC_DrawBitmap(*args, **kwargs)
3262
d6c14a4c 3263 def DrawBitmapPoint(*args, **kwargs):
f5b96ee1
RD
3264 """
3265 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3266
3267 Draw a bitmap on the device context at the specified point. If
3268 *transparent* is true and the bitmap has a transparency mask, (or
3269 alpha channel on the platforms that support it) then the bitmap will
3270 be drawn transparently.
3271 """
d6c14a4c 3272 return _gdi_.DC_DrawBitmapPoint(*args, **kwargs)
d55e5bfc
RD
3273
3274 def DrawText(*args, **kwargs):
f5b96ee1
RD
3275 """
3276 DrawText(self, String text, int x, int y)
3277
3278 Draws a text string at the specified point, using the current text
3279 font, and the current text foreground and background colours.
3280
3281 The coordinates refer to the top-left corner of the rectangle bounding
3282 the string. See `GetTextExtent` for how to get the dimensions of a
3283 text string, which can be used to position the text more precisely.
3284
3285 **NOTE**: under wxGTK the current logical function is used by this
3286 function but it is ignored by wxMSW. Thus, you should avoid using
3287 logical functions with this function in portable programs.
3288 """
d55e5bfc
RD
3289 return _gdi_.DC_DrawText(*args, **kwargs)
3290
d6c14a4c 3291 def DrawTextPoint(*args, **kwargs):
f5b96ee1
RD
3292 """
3293 DrawTextPoint(self, String text, Point pt)
3294
3295 Draws a text string at the specified point, using the current text
3296 font, and the current text foreground and background colours.
3297
3298 The coordinates refer to the top-left corner of the rectangle bounding
3299 the string. See `GetTextExtent` for how to get the dimensions of a
3300 text string, which can be used to position the text more precisely.
3301
3302 **NOTE**: under wxGTK the current logical function is used by this
3303 function but it is ignored by wxMSW. Thus, you should avoid using
3304 logical functions with this function in portable programs.
3305 """
d6c14a4c 3306 return _gdi_.DC_DrawTextPoint(*args, **kwargs)
d55e5bfc
RD
3307
3308 def DrawRotatedText(*args, **kwargs):
f5b96ee1
RD
3309 """
3310 DrawRotatedText(self, String text, int x, int y, double angle)
3311
3312 Draws the text rotated by *angle* degrees, if supported by the platform.
3313
3314 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3315 function. In particular, a font different from ``wx.NORMAL_FONT``
3316 should be used as the it is not normally a TrueType
3317 font. ``wx.SWISS_FONT`` is an example of a font which is.
3318 """
d55e5bfc
RD
3319 return _gdi_.DC_DrawRotatedText(*args, **kwargs)
3320
d6c14a4c 3321 def DrawRotatedTextPoint(*args, **kwargs):
f5b96ee1
RD
3322 """
3323 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3324
3325 Draws the text rotated by *angle* degrees, if supported by the platform.
3326
3327 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3328 function. In particular, a font different from ``wx.NORMAL_FONT``
3329 should be used as the it is not normally a TrueType
3330 font. ``wx.SWISS_FONT`` is an example of a font which is.
3331 """
d6c14a4c
RD
3332 return _gdi_.DC_DrawRotatedTextPoint(*args, **kwargs)
3333
3334 def Blit(*args, **kwargs):
d55e5bfc 3335 """
d6c14a4c 3336 Blit(self, int xdest, int ydest, int width, int height, DC source,
d55e5bfc
RD
3337 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3338 int xsrcMask=-1, int ysrcMask=-1) -> bool
f5b96ee1
RD
3339
3340 Copy from a source DC to this DC. Parameters specify the destination
3341 coordinates, size of area to copy, source DC, source coordinates,
3342 logical function, whether to use a bitmap mask, and mask source
3343 position.
d55e5bfc 3344 """
d6c14a4c 3345 return _gdi_.DC_Blit(*args, **kwargs)
d55e5bfc 3346
d6c14a4c 3347 def BlitPointSize(*args, **kwargs):
d55e5bfc 3348 """
d6c14a4c 3349 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
d55e5bfc 3350 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
f5b96ee1
RD
3351
3352 Copy from a source DC to this DC. Parameters specify the destination
3353 coordinates, size of area to copy, source DC, source coordinates,
3354 logical function, whether to use a bitmap mask, and mask source
3355 position.
d55e5bfc 3356 """
d6c14a4c
RD
3357 return _gdi_.DC_BlitPointSize(*args, **kwargs)
3358
3359 def SetClippingRegion(*args, **kwargs):
f5b96ee1
RD
3360 """
3361 SetClippingRegion(self, int x, int y, int width, int height)
3362
3363 Sets the clipping region for this device context to the intersection
3364 of the given region described by the parameters of this method and the
3365 previously set clipping region. You should call `DestroyClippingRegion`
3366 if you want to set the clipping region exactly to the region
3367 specified.
3368
3369 The clipping region is an area to which drawing is
3370 restricted. Possible uses for the clipping region are for clipping
3371 text or for speeding up window redraws when only a known area of the
3372 screen is damaged.
3373 """
d6c14a4c
RD
3374 return _gdi_.DC_SetClippingRegion(*args, **kwargs)
3375
3376 def SetClippingRegionPointSize(*args, **kwargs):
f5b96ee1
RD
3377 """
3378 SetClippingRegionPointSize(self, Point pt, Size sz)
3379
3380 Sets the clipping region for this device context to the intersection
3381 of the given region described by the parameters of this method and the
3382 previously set clipping region. You should call `DestroyClippingRegion`
3383 if you want to set the clipping region exactly to the region
3384 specified.
3385
3386 The clipping region is an area to which drawing is
3387 restricted. Possible uses for the clipping region are for clipping
3388 text or for speeding up window redraws when only a known area of the
3389 screen is damaged.
3390 """
d6c14a4c
RD
3391 return _gdi_.DC_SetClippingRegionPointSize(*args, **kwargs)
3392
3393 def SetClippingRegionAsRegion(*args, **kwargs):
f5b96ee1
RD
3394 """
3395 SetClippingRegionAsRegion(self, Region region)
3396
3397 Sets the clipping region for this device context to the intersection
3398 of the given region described by the parameters of this method and the
3399 previously set clipping region. You should call `DestroyClippingRegion`
3400 if you want to set the clipping region exactly to the region
3401 specified.
3402
3403 The clipping region is an area to which drawing is
3404 restricted. Possible uses for the clipping region are for clipping
3405 text or for speeding up window redraws when only a known area of the
3406 screen is damaged.
3407 """
d6c14a4c
RD
3408 return _gdi_.DC_SetClippingRegionAsRegion(*args, **kwargs)
3409
3410 def SetClippingRect(*args, **kwargs):
f5b96ee1
RD
3411 """
3412 SetClippingRect(self, Rect rect)
3413
3414 Sets the clipping region for this device context to the intersection
3415 of the given region described by the parameters of this method and the
3416 previously set clipping region. You should call `DestroyClippingRegion`
3417 if you want to set the clipping region exactly to the region
3418 specified.
3419
3420 The clipping region is an area to which drawing is
3421 restricted. Possible uses for the clipping region are for clipping
3422 text or for speeding up window redraws when only a known area of the
3423 screen is damaged.
3424 """
d6c14a4c 3425 return _gdi_.DC_SetClippingRect(*args, **kwargs)
d55e5bfc
RD
3426
3427 def DrawLines(*args, **kwargs):
f5b96ee1
RD
3428 """
3429 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3430
3431 Draws lines using a sequence of `wx.Point` objects, adding the
3432 optional offset coordinate. The current pen is used for drawing the
3433 lines.
3434 """
d55e5bfc
RD
3435 return _gdi_.DC_DrawLines(*args, **kwargs)
3436
3437 def DrawPolygon(*args, **kwargs):
3438 """
f5b96ee1 3439 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
d55e5bfc 3440 int fillStyle=ODDEVEN_RULE)
f5b96ee1
RD
3441
3442 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3443 the optional offset coordinate. The last argument specifies the fill
3444 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3445
3446 The current pen is used for drawing the outline, and the current brush
3447 for filling the shape. Using a transparent brush suppresses
3448 filling. Note that wxWidgets automatically closes the first and last
3449 points.
d55e5bfc
RD
3450 """
3451 return _gdi_.DC_DrawPolygon(*args, **kwargs)
3452
3453 def DrawLabel(*args, **kwargs):
3454 """
3455 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3456 int indexAccel=-1)
f5b96ee1
RD
3457
3458 Draw *text* within the specified rectangle, abiding by the alignment
3459 flags. Will additionally emphasize the character at *indexAccel* if
3460 it is not -1.
d55e5bfc
RD
3461 """
3462 return _gdi_.DC_DrawLabel(*args, **kwargs)
3463
3464 def DrawImageLabel(*args, **kwargs):
3465 """
3466 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
3467 int indexAccel=-1) -> Rect
f5b96ee1
RD
3468
3469 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3470 drawing it) within the specified rectangle, abiding by the alignment
3471 flags. Will additionally emphasize the character at *indexAccel* if
3472 it is not -1. Returns the bounding rectangle.
d55e5bfc
RD
3473 """
3474 return _gdi_.DC_DrawImageLabel(*args, **kwargs)
3475
3476 def DrawSpline(*args, **kwargs):
f5b96ee1
RD
3477 """
3478 DrawSpline(self, List points)
3479
3480 Draws a spline between all given control points, (a list of `wx.Point`
3481 objects) using the current pen. The spline is drawn using a series of
3482 lines, using an algorithm taken from the X drawing program 'XFIG'.
3483 """
d55e5bfc
RD
3484 return _gdi_.DC_DrawSpline(*args, **kwargs)
3485
3486 def Clear(*args, **kwargs):
f5b96ee1
RD
3487 """
3488 Clear(self)
3489
3490 Clears the device context using the current background brush.
3491 """
d55e5bfc
RD
3492 return _gdi_.DC_Clear(*args, **kwargs)
3493
3494 def StartDoc(*args, **kwargs):
f5b96ee1
RD
3495 """
3496 StartDoc(self, String message) -> bool
3497
3498 Starts a document (only relevant when outputting to a
3499 printer). *Message* is a message to show whilst printing.
3500 """
d55e5bfc
RD
3501 return _gdi_.DC_StartDoc(*args, **kwargs)
3502
3503 def EndDoc(*args, **kwargs):
f5b96ee1
RD
3504 """
3505 EndDoc(self)
3506
3507 Ends a document (only relevant when outputting to a printer).
3508 """
d55e5bfc
RD
3509 return _gdi_.DC_EndDoc(*args, **kwargs)
3510
3511 def StartPage(*args, **kwargs):
f5b96ee1
RD
3512 """
3513 StartPage(self)
3514
3515 Starts a document page (only relevant when outputting to a printer).
3516 """
d55e5bfc
RD
3517 return _gdi_.DC_StartPage(*args, **kwargs)
3518
3519 def EndPage(*args, **kwargs):
f5b96ee1
RD
3520 """
3521 EndPage(self)
3522
3523 Ends a document page (only relevant when outputting to a printer).
3524 """
d55e5bfc
RD
3525 return _gdi_.DC_EndPage(*args, **kwargs)
3526
3527 def SetFont(*args, **kwargs):
f5b96ee1
RD
3528 """
3529 SetFont(self, Font font)
3530
3531 Sets the current font for the DC. It must be a valid font, in
3532 particular you should not pass ``wx.NullFont`` to this method.
3533 """
d55e5bfc
RD
3534 return _gdi_.DC_SetFont(*args, **kwargs)
3535
3536 def SetPen(*args, **kwargs):
f5b96ee1
RD
3537 """
3538 SetPen(self, Pen pen)
3539
3540 Sets the current pen for the DC.
3541
3542 If the argument is ``wx.NullPen``, the current pen is selected out of the
3543 device context, and the original pen restored.
3544 """
d55e5bfc
RD
3545 return _gdi_.DC_SetPen(*args, **kwargs)
3546
3547 def SetBrush(*args, **kwargs):
f5b96ee1
RD
3548 """
3549 SetBrush(self, Brush brush)
3550
3551 Sets the current brush for the DC.
3552
3553 If the argument is ``wx.NullBrush``, the current brush is selected out
3554 of the device context, and the original brush restored, allowing the
3555 current brush to be destroyed safely.
3556 """
d55e5bfc
RD
3557 return _gdi_.DC_SetBrush(*args, **kwargs)
3558
3559 def SetBackground(*args, **kwargs):
f5b96ee1
RD
3560 """
3561 SetBackground(self, Brush brush)
3562
3563 Sets the current background brush for the DC.
3564 """
d55e5bfc
RD
3565 return _gdi_.DC_SetBackground(*args, **kwargs)
3566
3567 def SetBackgroundMode(*args, **kwargs):
f5b96ee1
RD
3568 """
3569 SetBackgroundMode(self, int mode)
3570
3571 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3572 determines whether text will be drawn with a background colour or
3573 not.
3574 """
d55e5bfc
RD
3575 return _gdi_.DC_SetBackgroundMode(*args, **kwargs)
3576
3577 def SetPalette(*args, **kwargs):
f5b96ee1
RD
3578 """
3579 SetPalette(self, Palette palette)
3580
3581 If this is a window DC or memory DC, assigns the given palette to the
3582 window or bitmap associated with the DC. If the argument is
3583 ``wx.NullPalette``, the current palette is selected out of the device
3584 context, and the original palette restored.
3585 """
d55e5bfc
RD
3586 return _gdi_.DC_SetPalette(*args, **kwargs)
3587
d55e5bfc 3588 def DestroyClippingRegion(*args, **kwargs):
f5b96ee1
RD
3589 """
3590 DestroyClippingRegion(self)
3591
3592 Destroys the current clipping region so that none of the DC is
3593 clipped.
3594 """
d55e5bfc
RD
3595 return _gdi_.DC_DestroyClippingRegion(*args, **kwargs)
3596
3597 def GetClippingBox(*args, **kwargs):
f5b96ee1
RD
3598 """
3599 GetClippingBox() -> (x, y, width, height)
3600
3601 Gets the rectangle surrounding the current clipping region.
3602 """
d55e5bfc
RD
3603 return _gdi_.DC_GetClippingBox(*args, **kwargs)
3604
3605 def GetClippingRect(*args, **kwargs):
f5b96ee1
RD
3606 """
3607 GetClippingRect(self) -> Rect
3608
3609 Gets the rectangle surrounding the current clipping region.
3610 """
d55e5bfc
RD
3611 return _gdi_.DC_GetClippingRect(*args, **kwargs)
3612
3613 def GetCharHeight(*args, **kwargs):
f5b96ee1
RD
3614 """
3615 GetCharHeight(self) -> int
3616
3617 Gets the character height of the currently set font.
3618 """
d55e5bfc
RD
3619 return _gdi_.DC_GetCharHeight(*args, **kwargs)
3620
3621 def GetCharWidth(*args, **kwargs):
f5b96ee1
RD
3622 """
3623 GetCharWidth(self) -> int
3624
3625 Gets the average character width of the currently set font.
3626 """
d55e5bfc
RD
3627 return _gdi_.DC_GetCharWidth(*args, **kwargs)
3628
3629 def GetTextExtent(*args, **kwargs):
a001823c
RD
3630 """
3631 GetTextExtent(wxString string) -> (width, height)
3632
3633 Get the width and height of the text using the current font. Only
3634 works for single line strings.
3635 """
d55e5bfc
RD
3636 return _gdi_.DC_GetTextExtent(*args, **kwargs)
3637
3638 def GetFullTextExtent(*args, **kwargs):
3639 """
3640 GetFullTextExtent(wxString string, Font font=None) ->
3641 (width, height, descent, externalLeading)
3642
15817c7e
RD
3643 Get the width, height, decent and leading of the text using the
3644 current or specified font. Only works for single line strings.
d55e5bfc
RD
3645 """
3646 return _gdi_.DC_GetFullTextExtent(*args, **kwargs)
3647
3648 def GetMultiLineTextExtent(*args, **kwargs):
3649 """
3650 GetMultiLineTextExtent(wxString string, Font font=None) ->
fc46b7f3 3651 (width, height, lineHeight)
a001823c 3652
777e547f 3653 Get the width, height, and line height of the text using the
a001823c
RD
3654 current or specified font. Works for single as well as multi-line
3655 strings.
d55e5bfc
RD
3656 """
3657 return _gdi_.DC_GetMultiLineTextExtent(*args, **kwargs)
3658
3659 def GetPartialTextExtents(*args, **kwargs):
f5b96ee1
RD
3660 """
3661 GetPartialTextExtents(self, text) -> [widths]
3662
3663 Returns a list of integers such that each value is the distance in
3664 pixels from the begining of text to the coresponding character of
3665 *text*. The generic version simply builds a running total of the widths
3666 of each character using GetTextExtent, however if the various
3667 platforms have a native API function that is faster or more accurate
43e8916f 3668 than the generic implementation then it will be used instead.
f5b96ee1 3669 """
d55e5bfc
RD
3670 return _gdi_.DC_GetPartialTextExtents(*args, **kwargs)
3671
3672 def GetSize(*args, **kwargs):
3673 """
3674 GetSize(self) -> Size
3675
f5b96ee1
RD
3676 This gets the horizontal and vertical resolution in device units. It
3677 can be used to scale graphics to fit the page. For example, if *maxX*
3678 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3679 used in your application, the following code will scale the graphic to
3680 fit on the printer page::
3681
3682 w, h = dc.GetSize()
3683 scaleX = maxX*1.0 / w
3684 scaleY = maxY*1.0 / h
3685 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3686
d55e5bfc
RD
3687 """
3688 return _gdi_.DC_GetSize(*args, **kwargs)
3689
3690 def GetSizeTuple(*args, **kwargs):
3691 """
3692 GetSizeTuple() -> (width, height)
3693
f5b96ee1
RD
3694 This gets the horizontal and vertical resolution in device units. It
3695 can be used to scale graphics to fit the page. For example, if *maxX*
3696 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3697 used in your application, the following code will scale the graphic to
3698 fit on the printer page::
3699
3700 w, h = dc.GetSize()
3701 scaleX = maxX*1.0 / w
3702 scaleY = maxY*1.0 / h
3703 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3704
d55e5bfc
RD
3705 """
3706 return _gdi_.DC_GetSizeTuple(*args, **kwargs)
3707
3708 def GetSizeMM(*args, **kwargs):
3709 """
3710 GetSizeMM(self) -> Size
3711
3712 Get the DC size in milimeters.
3713 """
3714 return _gdi_.DC_GetSizeMM(*args, **kwargs)
3715
3716 def GetSizeMMTuple(*args, **kwargs):
3717 """
3718 GetSizeMMTuple() -> (width, height)
3719
3720 Get the DC size in milimeters.
3721 """
3722 return _gdi_.DC_GetSizeMMTuple(*args, **kwargs)
3723
3724 def DeviceToLogicalX(*args, **kwargs):
f5b96ee1
RD
3725 """
3726 DeviceToLogicalX(self, int x) -> int
3727
3728 Convert device X coordinate to logical coordinate, using the current
3729 mapping mode.
3730 """
d55e5bfc
RD
3731 return _gdi_.DC_DeviceToLogicalX(*args, **kwargs)
3732
3733 def DeviceToLogicalY(*args, **kwargs):
f5b96ee1
RD
3734 """
3735 DeviceToLogicalY(self, int y) -> int
3736
3737 Converts device Y coordinate to logical coordinate, using the current
3738 mapping mode.
3739 """
d55e5bfc
RD
3740 return _gdi_.DC_DeviceToLogicalY(*args, **kwargs)
3741
3742 def DeviceToLogicalXRel(*args, **kwargs):
f5b96ee1
RD
3743 """
3744 DeviceToLogicalXRel(self, int x) -> int
3745
3746 Convert device X coordinate to relative logical coordinate, using the
3747 current mapping mode but ignoring the x axis orientation. Use this
3748 function for converting a width, for example.
3749 """
d55e5bfc
RD
3750 return _gdi_.DC_DeviceToLogicalXRel(*args, **kwargs)
3751
3752 def DeviceToLogicalYRel(*args, **kwargs):
f5b96ee1
RD
3753 """
3754 DeviceToLogicalYRel(self, int y) -> int
3755
3756 Convert device Y coordinate to relative logical coordinate, using the
3757 current mapping mode but ignoring the y axis orientation. Use this
3758 function for converting a height, for example.
3759 """
d55e5bfc
RD
3760 return _gdi_.DC_DeviceToLogicalYRel(*args, **kwargs)
3761
3762 def LogicalToDeviceX(*args, **kwargs):
f5b96ee1
RD
3763 """
3764 LogicalToDeviceX(self, int x) -> int
3765
3766 Converts logical X coordinate to device coordinate, using the current
3767 mapping mode.
3768 """
d55e5bfc
RD
3769 return _gdi_.DC_LogicalToDeviceX(*args, **kwargs)
3770
3771 def LogicalToDeviceY(*args, **kwargs):
f5b96ee1
RD
3772 """
3773 LogicalToDeviceY(self, int y) -> int
3774
3775 Converts logical Y coordinate to device coordinate, using the current
3776 mapping mode.
3777 """
d55e5bfc
RD
3778 return _gdi_.DC_LogicalToDeviceY(*args, **kwargs)
3779
3780 def LogicalToDeviceXRel(*args, **kwargs):
f5b96ee1
RD
3781 """
3782 LogicalToDeviceXRel(self, int x) -> int
3783
3784 Converts logical X coordinate to relative device coordinate, using the
3785 current mapping mode but ignoring the x axis orientation. Use this for
3786 converting a width, for example.
3787 """
d55e5bfc
RD
3788 return _gdi_.DC_LogicalToDeviceXRel(*args, **kwargs)
3789
3790 def LogicalToDeviceYRel(*args, **kwargs):
f5b96ee1
RD
3791 """
3792 LogicalToDeviceYRel(self, int y) -> int
3793
3794 Converts logical Y coordinate to relative device coordinate, using the
3795 current mapping mode but ignoring the y axis orientation. Use this for
3796 converting a height, for example.
3797 """
d55e5bfc
RD
3798 return _gdi_.DC_LogicalToDeviceYRel(*args, **kwargs)
3799
3800 def CanDrawBitmap(*args, **kwargs):
3801 """CanDrawBitmap(self) -> bool"""
3802 return _gdi_.DC_CanDrawBitmap(*args, **kwargs)
3803
3804 def CanGetTextExtent(*args, **kwargs):
3805 """CanGetTextExtent(self) -> bool"""
3806 return _gdi_.DC_CanGetTextExtent(*args, **kwargs)
3807
3808 def GetDepth(*args, **kwargs):
f5b96ee1
RD
3809 """
3810 GetDepth(self) -> int
3811
3812 Returns the colour depth of the DC.
3813 """
d55e5bfc
RD
3814 return _gdi_.DC_GetDepth(*args, **kwargs)
3815
3816 def GetPPI(*args, **kwargs):
f5b96ee1
RD
3817 """
3818 GetPPI(self) -> Size
3819
92515dfc 3820 Resolution in pixels per inch
f5b96ee1 3821 """
d55e5bfc
RD
3822 return _gdi_.DC_GetPPI(*args, **kwargs)
3823
3824 def Ok(*args, **kwargs):
f5b96ee1
RD
3825 """
3826 Ok(self) -> bool
3827
3828 Returns true if the DC is ok to use.
3829 """
d55e5bfc
RD
3830 return _gdi_.DC_Ok(*args, **kwargs)
3831
3832 def GetBackgroundMode(*args, **kwargs):
f5b96ee1
RD
3833 """
3834 GetBackgroundMode(self) -> int
3835
3836 Returns the current background mode, either ``wx.SOLID`` or
3837 ``wx.TRANSPARENT``.
3838 """
d55e5bfc
RD
3839 return _gdi_.DC_GetBackgroundMode(*args, **kwargs)
3840
3841 def GetBackground(*args, **kwargs):
f5b96ee1
RD
3842 """
3843 GetBackground(self) -> Brush
3844
3845 Gets the brush used for painting the background.
3846 """
d55e5bfc
RD
3847 return _gdi_.DC_GetBackground(*args, **kwargs)
3848
3849 def GetBrush(*args, **kwargs):
f5b96ee1
RD
3850 """
3851 GetBrush(self) -> Brush
3852
3853 Gets the current brush
3854 """
d55e5bfc
RD
3855 return _gdi_.DC_GetBrush(*args, **kwargs)
3856
3857 def GetFont(*args, **kwargs):
f5b96ee1
RD
3858 """
3859 GetFont(self) -> Font
3860
3861 Gets the current font
3862 """
d55e5bfc
RD
3863 return _gdi_.DC_GetFont(*args, **kwargs)
3864
3865 def GetPen(*args, **kwargs):
f5b96ee1
RD
3866 """
3867 GetPen(self) -> Pen
3868
3869 Gets the current pen
3870 """
d55e5bfc
RD
3871 return _gdi_.DC_GetPen(*args, **kwargs)
3872
3873 def GetTextBackground(*args, **kwargs):
f5b96ee1
RD
3874 """
3875 GetTextBackground(self) -> Colour
3876
3877 Gets the current text background colour
3878 """
d55e5bfc
RD
3879 return _gdi_.DC_GetTextBackground(*args, **kwargs)
3880
3881 def GetTextForeground(*args, **kwargs):
f5b96ee1
RD
3882 """
3883 GetTextForeground(self) -> Colour
3884
3885 Gets the current text foreground colour
3886 """
d55e5bfc
RD
3887 return _gdi_.DC_GetTextForeground(*args, **kwargs)
3888
3889 def SetTextForeground(*args, **kwargs):
f5b96ee1
RD
3890 """
3891 SetTextForeground(self, Colour colour)
3892
3893 Sets the current text foreground colour for the DC.
3894 """
d55e5bfc
RD
3895 return _gdi_.DC_SetTextForeground(*args, **kwargs)
3896
3897 def SetTextBackground(*args, **kwargs):
f5b96ee1
RD
3898 """
3899 SetTextBackground(self, Colour colour)
3900
3901 Sets the current text background colour for the DC.
3902 """
d55e5bfc
RD
3903 return _gdi_.DC_SetTextBackground(*args, **kwargs)
3904
3905 def GetMapMode(*args, **kwargs):
f5b96ee1
RD
3906 """
3907 GetMapMode(self) -> int
3908
3909 Gets the current *mapping mode* for the device context
3910 """
d55e5bfc
RD
3911 return _gdi_.DC_GetMapMode(*args, **kwargs)
3912
3913 def SetMapMode(*args, **kwargs):
f5b96ee1
RD
3914 """
3915 SetMapMode(self, int mode)
3916
3917 The *mapping mode* of the device context defines the unit of
3918 measurement used to convert logical units to device units. The
3919 mapping mode can be one of the following:
3920
3921 ================ =============================================
3922 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3923 of an inch.
3924 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3925 wx.MM_METRIC Each logical unit is 1 mm.
3926 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3927 wx.MM_TEXT Each logical unit is 1 pixel.
3928 ================ =============================================
3929
3930 """
d55e5bfc
RD
3931 return _gdi_.DC_SetMapMode(*args, **kwargs)
3932
3933 def GetUserScale(*args, **kwargs):
f5b96ee1
RD
3934 """
3935 GetUserScale(self) -> (xScale, yScale)
3936
3937 Gets the current user scale factor (set by `SetUserScale`).
3938 """
d55e5bfc
RD
3939 return _gdi_.DC_GetUserScale(*args, **kwargs)
3940
3941 def SetUserScale(*args, **kwargs):
f5b96ee1
RD
3942 """
3943 SetUserScale(self, double x, double y)
3944
3945 Sets the user scaling factor, useful for applications which require
3946 'zooming'.
3947 """
d55e5bfc
RD
3948 return _gdi_.DC_SetUserScale(*args, **kwargs)
3949
3950 def GetLogicalScale(*args, **kwargs):
3951 """GetLogicalScale() -> (xScale, yScale)"""
3952 return _gdi_.DC_GetLogicalScale(*args, **kwargs)
3953
3954 def SetLogicalScale(*args, **kwargs):
3955 """SetLogicalScale(self, double x, double y)"""
3956 return _gdi_.DC_SetLogicalScale(*args, **kwargs)
3957
3958 def GetLogicalOrigin(*args, **kwargs):
3959 """GetLogicalOrigin(self) -> Point"""
3960 return _gdi_.DC_GetLogicalOrigin(*args, **kwargs)
3961
3962 def GetLogicalOriginTuple(*args, **kwargs):
3963 """GetLogicalOriginTuple() -> (x,y)"""
3964 return _gdi_.DC_GetLogicalOriginTuple(*args, **kwargs)
3965
3966 def SetLogicalOrigin(*args, **kwargs):
3967 """SetLogicalOrigin(self, int x, int y)"""
3968 return _gdi_.DC_SetLogicalOrigin(*args, **kwargs)
3969
d6c14a4c
RD
3970 def SetLogicalOriginPoint(*args, **kwargs):
3971 """SetLogicalOriginPoint(self, Point point)"""
3972 return _gdi_.DC_SetLogicalOriginPoint(*args, **kwargs)
3973
d55e5bfc
RD
3974 def GetDeviceOrigin(*args, **kwargs):
3975 """GetDeviceOrigin(self) -> Point"""
3976 return _gdi_.DC_GetDeviceOrigin(*args, **kwargs)
3977
3978 def GetDeviceOriginTuple(*args, **kwargs):
3979 """GetDeviceOriginTuple() -> (x,y)"""
3980 return _gdi_.DC_GetDeviceOriginTuple(*args, **kwargs)
3981
3982 def SetDeviceOrigin(*args, **kwargs):
3983 """SetDeviceOrigin(self, int x, int y)"""
3984 return _gdi_.DC_SetDeviceOrigin(*args, **kwargs)
3985
d6c14a4c
RD
3986 def SetDeviceOriginPoint(*args, **kwargs):
3987 """SetDeviceOriginPoint(self, Point point)"""
3988 return _gdi_.DC_SetDeviceOriginPoint(*args, **kwargs)
3989
d55e5bfc 3990 def SetAxisOrientation(*args, **kwargs):
f5b96ee1
RD
3991 """
3992 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
3993
3994 Sets the x and y axis orientation (i.e., the direction from lowest to
3995 highest values on the axis). The default orientation is the natural
3996 orientation, e.g. x axis from left to right and y axis from bottom up.
3997 """
d55e5bfc
RD
3998 return _gdi_.DC_SetAxisOrientation(*args, **kwargs)
3999
4000 def GetLogicalFunction(*args, **kwargs):
f5b96ee1
RD
4001 """
4002 GetLogicalFunction(self) -> int
4003
4004 Gets the current logical function (set by `SetLogicalFunction`).
4005 """
d55e5bfc
RD
4006 return _gdi_.DC_GetLogicalFunction(*args, **kwargs)
4007
4008 def SetLogicalFunction(*args, **kwargs):
f5b96ee1
RD
4009 """
4010 SetLogicalFunction(self, int function)
4011
4012 Sets the current logical function for the device context. This
4013 determines how a source pixel (from a pen or brush colour, or source
4014 device context if using `Blit`) combines with a destination pixel in
4015 the current device context.
4016
4017 The possible values and their meaning in terms of source and
4018 destination pixel values are as follows:
4019
4020 ================ ==========================
4021 wx.AND src AND dst
4022 wx.AND_INVERT (NOT src) AND dst
4023 wx.AND_REVERSE src AND (NOT dst)
4024 wx.CLEAR 0
4025 wx.COPY src
4026 wx.EQUIV (NOT src) XOR dst
4027 wx.INVERT NOT dst
4028 wx.NAND (NOT src) OR (NOT dst)
4029 wx.NOR (NOT src) AND (NOT dst)
4030 wx.NO_OP dst
4031 wx.OR src OR dst
4032 wx.OR_INVERT (NOT src) OR dst
4033 wx.OR_REVERSE src OR (NOT dst)
4034 wx.SET 1
4035 wx.SRC_INVERT NOT src
4036 wx.XOR src XOR dst
4037 ================ ==========================
4038
4039 The default is wx.COPY, which simply draws with the current
4040 colour. The others combine the current colour and the background using
4041 a logical operation. wx.INVERT is commonly used for drawing rubber
4042 bands or moving outlines, since drawing twice reverts to the original
4043 colour.
4044
4045 """
d55e5bfc
RD
4046 return _gdi_.DC_SetLogicalFunction(*args, **kwargs)
4047
5cbf236d 4048 def ComputeScaleAndOrigin(*args, **kwargs):
f5b96ee1 4049 """
5cbf236d 4050 ComputeScaleAndOrigin(self)
f5b96ee1 4051
5cbf236d
RD
4052 Performs all necessary computations for given platform and context
4053 type after each change of scale and origin parameters. Usually called
4054 automatically internally after such changes.
f5b96ee1 4055
f5b96ee1 4056 """
5cbf236d 4057 return _gdi_.DC_ComputeScaleAndOrigin(*args, **kwargs)
d55e5bfc 4058
5cbf236d
RD
4059 def SetOptimization(self, optimize):
4060 pass
4061 def GetOptimization(self):
4062 return False
f5b96ee1 4063
5cbf236d
RD
4064 SetOptimization = wx._deprecated(SetOptimization)
4065 GetOptimization = wx._deprecated(GetOptimization)
d55e5bfc
RD
4066
4067 def CalcBoundingBox(*args, **kwargs):
f5b96ee1
RD
4068 """
4069 CalcBoundingBox(self, int x, int y)
4070
4071 Adds the specified point to the bounding box which can be retrieved
4072 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4073 """
d55e5bfc
RD
4074 return _gdi_.DC_CalcBoundingBox(*args, **kwargs)
4075
d6c14a4c 4076 def CalcBoundingBoxPoint(*args, **kwargs):
f5b96ee1
RD
4077 """
4078 CalcBoundingBoxPoint(self, Point point)
4079
4080 Adds the specified point to the bounding box which can be retrieved
4081 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
4082 """
d6c14a4c
RD
4083 return _gdi_.DC_CalcBoundingBoxPoint(*args, **kwargs)
4084
d55e5bfc 4085 def ResetBoundingBox(*args, **kwargs):
f5b96ee1
RD
4086 """
4087 ResetBoundingBox(self)
4088
4089 Resets the bounding box: after a call to this function, the bounding
4090 box doesn't contain anything.
4091 """
d55e5bfc
RD
4092 return _gdi_.DC_ResetBoundingBox(*args, **kwargs)
4093
4094 def MinX(*args, **kwargs):
f5b96ee1
RD
4095 """
4096 MinX(self) -> int
4097
4098 Gets the minimum horizontal extent used in drawing commands so far.
4099 """
d55e5bfc
RD
4100 return _gdi_.DC_MinX(*args, **kwargs)
4101
4102 def MaxX(*args, **kwargs):
f5b96ee1
RD
4103 """
4104 MaxX(self) -> int
4105
4106 Gets the maximum horizontal extent used in drawing commands so far.
4107 """
d55e5bfc
RD
4108 return _gdi_.DC_MaxX(*args, **kwargs)
4109
4110 def MinY(*args, **kwargs):
f5b96ee1
RD
4111 """
4112 MinY(self) -> int
4113
4114 Gets the minimum vertical extent used in drawing commands so far.
4115 """
d55e5bfc
RD
4116 return _gdi_.DC_MinY(*args, **kwargs)
4117
4118 def MaxY(*args, **kwargs):
f5b96ee1
RD
4119 """
4120 MaxY(self) -> int
4121
4122 Gets the maximum vertical extent used in drawing commands so far.
4123 """
d55e5bfc
RD
4124 return _gdi_.DC_MaxY(*args, **kwargs)
4125
4126 def GetBoundingBox(*args, **kwargs):
f5b96ee1
RD
4127 """
4128 GetBoundingBox() -> (x1,y1, x2,y2)
4129
4130 Returns the min and max points used in drawing commands so far.
4131 """
d55e5bfc
RD
4132 return _gdi_.DC_GetBoundingBox(*args, **kwargs)
4133
4134 def __nonzero__(self): return self.Ok()
4135 def _DrawPointList(*args, **kwargs):
4136 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4137 return _gdi_.DC__DrawPointList(*args, **kwargs)
4138
4139 def _DrawLineList(*args, **kwargs):
4140 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4141 return _gdi_.DC__DrawLineList(*args, **kwargs)
4142
4143 def _DrawRectangleList(*args, **kwargs):
4144 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4145 return _gdi_.DC__DrawRectangleList(*args, **kwargs)
4146
4147 def _DrawEllipseList(*args, **kwargs):
4148 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4149 return _gdi_.DC__DrawEllipseList(*args, **kwargs)
4150
4151 def _DrawPolygonList(*args, **kwargs):
4152 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
4153 return _gdi_.DC__DrawPolygonList(*args, **kwargs)
4154
4155 def _DrawTextList(*args, **kwargs):
4156 """
4157 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
4158 PyObject backgroundList) -> PyObject
4159 """
4160 return _gdi_.DC__DrawTextList(*args, **kwargs)
4161
4162 def DrawPointList(self, points, pens=None):
f5b96ee1
RD
4163 """
4164 Draw a list of points as quickly as possible.
4165
4166 :param points: A sequence of 2-element sequences representing
4167 each point to draw, (x,y).
4168 :param pens: If None, then the current pen is used. If a
4169 single pen then it will be used for all points. If
4170 a list of pens then there should be one for each point
4171 in points.
4172 """
d55e5bfc
RD
4173 if pens is None:
4174 pens = []
4175 elif isinstance(pens, wx.Pen):
4176 pens = [pens]
4177 elif len(pens) != len(points):
4178 raise ValueError('points and pens must have same length')
4179 return self._DrawPointList(points, pens, [])
4180
4181
4182 def DrawLineList(self, lines, pens=None):
f5b96ee1
RD
4183 """
4184 Draw a list of lines as quickly as possible.
4185
4186 :param lines: A sequence of 4-element sequences representing
4187 each line to draw, (x1,y1, x2,y2).
4188 :param pens: If None, then the current pen is used. If a
4189 single pen then it will be used for all lines. If
4190 a list of pens then there should be one for each line
4191 in lines.
4192 """
d55e5bfc
RD
4193 if pens is None:
4194 pens = []
4195 elif isinstance(pens, wx.Pen):
4196 pens = [pens]
4197 elif len(pens) != len(lines):
4198 raise ValueError('lines and pens must have same length')
4199 return self._DrawLineList(lines, pens, [])
4200
4201
4202 def DrawRectangleList(self, rectangles, pens=None, brushes=None):
f5b96ee1
RD
4203 """
4204 Draw a list of rectangles as quickly as possible.
4205
4206 :param rectangles: A sequence of 4-element sequences representing
4207 each rectangle to draw, (x,y, w,h).
4208 :param pens: If None, then the current pen is used. If a
4209 single pen then it will be used for all rectangles.
4210 If a list of pens then there should be one for each
4211 rectangle in rectangles.
4212 :param brushes: A brush or brushes to be used to fill the rectagles,
4213 with similar semantics as the pens parameter.
4214 """
d55e5bfc
RD
4215 if pens is None:
4216 pens = []
4217 elif isinstance(pens, wx.Pen):
4218 pens = [pens]
4219 elif len(pens) != len(rectangles):
4220 raise ValueError('rectangles and pens must have same length')
4221 if brushes is None:
4222 brushes = []
4223 elif isinstance(brushes, wx.Brush):
4224 brushes = [brushes]
4225 elif len(brushes) != len(rectangles):
4226 raise ValueError('rectangles and brushes must have same length')
4227 return self._DrawRectangleList(rectangles, pens, brushes)
4228
4229
4230 def DrawEllipseList(self, ellipses, pens=None, brushes=None):
f5b96ee1
RD
4231 """
4232 Draw a list of ellipses as quickly as possible.
4233
4234 :param ellipses: A sequence of 4-element sequences representing
4235 each ellipse to draw, (x,y, w,h).
4236 :param pens: If None, then the current pen is used. If a
4237 single pen then it will be used for all ellipses.
4238 If a list of pens then there should be one for each
4239 ellipse in ellipses.
4240 :param brushes: A brush or brushes to be used to fill the ellipses,
4241 with similar semantics as the pens parameter.
4242 """
d55e5bfc
RD
4243 if pens is None:
4244 pens = []
4245 elif isinstance(pens, wx.Pen):
4246 pens = [pens]
4247 elif len(pens) != len(ellipses):
4248 raise ValueError('ellipses and pens must have same length')
4249 if brushes is None:
4250 brushes = []
4251 elif isinstance(brushes, wx.Brush):
4252 brushes = [brushes]
4253 elif len(brushes) != len(ellipses):
4254 raise ValueError('ellipses and brushes must have same length')
4255 return self._DrawEllipseList(ellipses, pens, brushes)
4256
4257
4258 def DrawPolygonList(self, polygons, pens=None, brushes=None):
f5b96ee1
RD
4259 """
4260 Draw a list of polygons, each of which is a list of points.
4261
4262 :param polygons: A sequence of sequences of sequences.
4263 [[(x1,y1),(x2,y2),(x3,y3)...],
4264 [(x1,y1),(x2,y2),(x3,y3)...]]
4265
4266 :param pens: If None, then the current pen is used. If a
4267 single pen then it will be used for all polygons.
4268 If a list of pens then there should be one for each
4269 polygon.
4270 :param brushes: A brush or brushes to be used to fill the polygons,
4271 with similar semantics as the pens parameter.
4272 """
d55e5bfc
RD
4273 if pens is None:
4274 pens = []
4275 elif isinstance(pens, wx.Pen):
4276 pens = [pens]
4277 elif len(pens) != len(polygons):
4278 raise ValueError('polygons and pens must have same length')
4279 if brushes is None:
4280 brushes = []
4281 elif isinstance(brushes, wx.Brush):
4282 brushes = [brushes]
4283 elif len(brushes) != len(polygons):
4284 raise ValueError('polygons and brushes must have same length')
4285 return self._DrawPolygonList(polygons, pens, brushes)
4286
4287
f5b96ee1
RD
4288 def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None):
4289 """
4290 Draw a list of strings using a list of coordinants for positioning each string.
4291
4292 :param textList: A list of strings
4293 :param coords: A list of (x,y) positions
4294 :param foregrounds: A list of `wx.Colour` objects to use for the
4295 foregrounds of the strings.
4296 :param backgrounds: A list of `wx.Colour` objects to use for the
4297 backgrounds of the strings.
4298
4299 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4300 If you want backgrounds to do anything.
4301 """
d55e5bfc
RD
4302 if type(textList) == type(''):
4303 textList = [textList]
4304 elif len(textList) != len(coords):
4305 raise ValueError('textlist and coords must have same length')
4306 if foregrounds is None:
4307 foregrounds = []
4308 elif isinstance(foregrounds, wx.Colour):
4309 foregrounds = [foregrounds]
4310 elif len(foregrounds) != len(coords):
4311 raise ValueError('foregrounds and coords must have same length')
4312 if backgrounds is None:
4313 backgrounds = []
4314 elif isinstance(backgrounds, wx.Colour):
4315 backgrounds = [backgrounds]
4316 elif len(backgrounds) != len(coords):
4317 raise ValueError('backgrounds and coords must have same length')
4318 return self._DrawTextList(textList, coords, foregrounds, backgrounds)
4319
2bf58437
RD
4320 Background = property(GetBackground,SetBackground,doc="See `GetBackground` and `SetBackground`")
4321 BackgroundMode = property(GetBackgroundMode,SetBackgroundMode,doc="See `GetBackgroundMode` and `SetBackgroundMode`")
4322 BoundingBox = property(GetBoundingBox,doc="See `GetBoundingBox`")
4323 Brush = property(GetBrush,SetBrush,doc="See `GetBrush` and `SetBrush`")
4324 CharHeight = property(GetCharHeight,doc="See `GetCharHeight`")
4325 CharWidth = property(GetCharWidth,doc="See `GetCharWidth`")
4326 ClippingBox = property(GetClippingBox,doc="See `GetClippingBox`")
4327 ClippingRect = property(GetClippingRect,SetClippingRect,doc="See `GetClippingRect` and `SetClippingRect`")
4328 Depth = property(GetDepth,doc="See `GetDepth`")
4329 DeviceOrigin = property(GetDeviceOrigin,SetDeviceOrigin,doc="See `GetDeviceOrigin` and `SetDeviceOrigin`")
4330 Font = property(GetFont,SetFont,doc="See `GetFont` and `SetFont`")
4331 FullTextExtent = property(GetFullTextExtent,doc="See `GetFullTextExtent`")
4332 LogicalFunction = property(GetLogicalFunction,SetLogicalFunction,doc="See `GetLogicalFunction` and `SetLogicalFunction`")
4333 LogicalOrigin = property(GetLogicalOrigin,SetLogicalOrigin,doc="See `GetLogicalOrigin` and `SetLogicalOrigin`")
4334 LogicalScale = property(GetLogicalScale,SetLogicalScale,doc="See `GetLogicalScale` and `SetLogicalScale`")
4335 MapMode = property(GetMapMode,SetMapMode,doc="See `GetMapMode` and `SetMapMode`")
4336 MultiLineTextExtent = property(GetMultiLineTextExtent,doc="See `GetMultiLineTextExtent`")
4337 Optimization = property(GetOptimization,SetOptimization,doc="See `GetOptimization` and `SetOptimization`")
4338 PPI = property(GetPPI,doc="See `GetPPI`")
4339 PartialTextExtents = property(GetPartialTextExtents,doc="See `GetPartialTextExtents`")
4340 Pen = property(GetPen,SetPen,doc="See `GetPen` and `SetPen`")
4341 Pixel = property(GetPixel,doc="See `GetPixel`")
4342 PixelPoint = property(GetPixelPoint,doc="See `GetPixelPoint`")
4343 Size = property(GetSize,doc="See `GetSize`")
4344 SizeMM = property(GetSizeMM,doc="See `GetSizeMM`")
4345 TextBackground = property(GetTextBackground,SetTextBackground,doc="See `GetTextBackground` and `SetTextBackground`")
4346 TextExtent = property(GetTextExtent,doc="See `GetTextExtent`")
4347 TextForeground = property(GetTextForeground,SetTextForeground,doc="See `GetTextForeground` and `SetTextForeground`")
4348 UserScale = property(GetUserScale,SetUserScale,doc="See `GetUserScale` and `SetUserScale`")
2131d850 4349_gdi_.DC_swigregister(DC)
d55e5bfc
RD
4350
4351#---------------------------------------------------------------------------
4352
4353class MemoryDC(DC):
f5b96ee1
RD
4354 """
4355 A memory device context provides a means to draw graphics onto a
4356 bitmap. A bitmap must be selected into the new memory DC before it may
4357 be used for anything. Typical usage is as follows::
4358
4359 dc = wx.MemoryDC()
4360 dc.SelectObject(bitmap)
4361 # draw on the dc usign any of the Draw methods
4362 dc.SelectObject(wx.NullBitmap)
4363 # the bitmap now contains wahtever was drawn upon it
4364
4365 Note that the memory DC *must* be deleted (or the bitmap selected out
4366 of it) before a bitmap can be reselected into another memory DC.
4367
4368 """
1bd55598
RD
4369 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4370 __repr__ = _swig_repr
4371 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4372 """
4373 __init__(self) -> MemoryDC
4374
4375 Constructs a new memory device context.
4376
4377 Use the Ok member to test whether the constructor was successful in
4378 creating a usable device context. Don't forget to select a bitmap into
4379 the DC before drawing on it.
4380 """
1bd55598 4381 _gdi_.MemoryDC_swiginit(self,_gdi_.new_MemoryDC(*args, **kwargs))
d55e5bfc 4382 def SelectObject(*args, **kwargs):
f5b96ee1
RD
4383 """
4384 SelectObject(self, Bitmap bitmap)
4385
4386 Selects the bitmap into the device context, to use as the memory
4387 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4388 the DC, and therefore the bitmap, and also to use Blit to copy the
4389 bitmap to a window.
4390
4391 If the argument is wx.NullBitmap (or some other uninitialised
4392 `wx.Bitmap`) the current bitmap is selected out of the device context,
4393 and the original bitmap restored, allowing the current bitmap to be
4394 destroyed safely.
4395 """
d55e5bfc
RD
4396 return _gdi_.MemoryDC_SelectObject(*args, **kwargs)
4397
2131d850 4398_gdi_.MemoryDC_swigregister(MemoryDC)
d55e5bfc
RD
4399
4400def MemoryDCFromDC(*args, **kwargs):
f5b96ee1
RD
4401 """
4402 MemoryDCFromDC(DC oldDC) -> MemoryDC
4403
4404 Creates a DC that is compatible with the oldDC.
4405 """
d55e5bfc 4406 val = _gdi_.new_MemoryDCFromDC(*args, **kwargs)
d55e5bfc
RD
4407 return val
4408
4409#---------------------------------------------------------------------------
4410
e2950dbb
RD
4411BUFFER_VIRTUAL_AREA = _gdi_.BUFFER_VIRTUAL_AREA
4412BUFFER_CLIENT_AREA = _gdi_.BUFFER_CLIENT_AREA
d55e5bfc 4413class BufferedDC(MemoryDC):
f5b96ee1
RD
4414 """
4415 This simple class provides a simple way to avoid flicker: when drawing
4416 on it, everything is in fact first drawn on an in-memory buffer (a
4417 `wx.Bitmap`) and then copied to the screen only once, when this object
4418 is destroyed.
4419
6a223074
RD
4420 It can be used in the same way as any other device context.
4421 wx.BufferedDC itself typically replaces `wx.ClientDC`, if you want to
4422 use it in your EVT_PAINT handler, you should look at
f5b96ee1
RD
4423 `wx.BufferedPaintDC`.
4424
6a223074
RD
4425 Please note that GTK+ 2.0 and OS X provide double buffering themselves
4426 natively so using this class on those platforms will normally result
4427 in an unneeded level of buffering.
4428
f5b96ee1 4429 """
1bd55598
RD
4430 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4431 __repr__ = _swig_repr
4432 def __init__(self, *args):
d55e5bfc 4433 """
f491ed97 4434 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
e2950dbb 4435 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
f5b96ee1
RD
4436
4437 Constructs a buffered DC.
d55e5bfc 4438 """
1bd55598 4439 _gdi_.BufferedDC_swiginit(self,_gdi_.new_BufferedDC(*args))
f5b96ee1 4440 self.__dc = args[0] # save a ref so the other dc will not be deleted before self
d55e5bfc 4441
1bd55598
RD
4442 __swig_destroy__ = _gdi_.delete_BufferedDC
4443 __del__ = lambda self : None;
d55e5bfc 4444 def UnMask(*args, **kwargs):
f5b96ee1
RD
4445 """
4446 UnMask(self)
4447
4448 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4449 can be effectively used once only). This is usually only called in
4450 the destructor.
4451 """
d55e5bfc
RD
4452 return _gdi_.BufferedDC_UnMask(*args, **kwargs)
4453
2131d850 4454_gdi_.BufferedDC_swigregister(BufferedDC)
d55e5bfc 4455
d55e5bfc 4456class BufferedPaintDC(BufferedDC):
f5b96ee1
RD
4457 """
4458 This is a subclass of `wx.BufferedDC` which can be used inside of an
4459 EVT_PAINT event handler. Just create an object of this class instead
4460 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4461 flicker. The only thing to watch out for is that if you are using this
4462 class together with `wx.ScrolledWindow`, you probably do **not** want
4463 to call `wx.Window.PrepareDC` on it as it already does this internally
4464 for the real underlying `wx.PaintDC`.
4465
4466 If your window is already fully buffered in a `wx.Bitmap` then your
4467 EVT_PAINT handler can be as simple as just creating a
4468 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4469 automatically when it is destroyed. For example::
4470
4471 def OnPaint(self, event):
4472 dc = wx.BufferedPaintDC(self, self.buffer)
4473
4474
4475
e2950dbb
RD
4476
4477
f5b96ee1 4478 """
1bd55598
RD
4479 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4480 __repr__ = _swig_repr
4481 def __init__(self, *args, **kwargs):
f5b96ee1 4482 """
e2950dbb 4483 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
f5b96ee1
RD
4484
4485 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4486 provide the bitmap to be used for buffering or let this object create
4487 one internally (in the latter case, the size of the client part of the
4488 window is automatically used).
4489
4490
4491 """
1bd55598 4492 _gdi_.BufferedPaintDC_swiginit(self,_gdi_.new_BufferedPaintDC(*args, **kwargs))
2131d850 4493_gdi_.BufferedPaintDC_swigregister(BufferedPaintDC)
d55e5bfc
RD
4494
4495#---------------------------------------------------------------------------
4496
4497class ScreenDC(DC):
f5b96ee1
RD
4498 """
4499 A wxScreenDC can be used to paint anywhere on the screen. This should
4500 normally be constructed as a temporary stack object; don't store a
4501 wxScreenDC object.
4502
4503 """
1bd55598
RD
4504 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4505 __repr__ = _swig_repr
4506 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4507 """
4508 __init__(self) -> ScreenDC
4509
4510 A wxScreenDC can be used to paint anywhere on the screen. This should
4511 normally be constructed as a temporary stack object; don't store a
4512 wxScreenDC object.
4513
4514 """
1bd55598 4515 _gdi_.ScreenDC_swiginit(self,_gdi_.new_ScreenDC(*args, **kwargs))
d55e5bfc 4516 def StartDrawingOnTopWin(*args, **kwargs):
f5b96ee1
RD
4517 """
4518 StartDrawingOnTopWin(self, Window window) -> bool
4519
4520 Specify that the area of the screen to be drawn upon coincides with
4521 the given window.
4522
4523 :see: `EndDrawingOnTop`
4524 """
d55e5bfc
RD
4525 return _gdi_.ScreenDC_StartDrawingOnTopWin(*args, **kwargs)
4526
4527 def StartDrawingOnTop(*args, **kwargs):
f5b96ee1
RD
4528 """
4529 StartDrawingOnTop(self, Rect rect=None) -> bool
4530
4531 Specify that the area is the given rectangle, or the whole screen if
4532 ``None`` is passed.
4533
4534 :see: `EndDrawingOnTop`
4535 """
d55e5bfc
RD
4536 return _gdi_.ScreenDC_StartDrawingOnTop(*args, **kwargs)
4537
4538 def EndDrawingOnTop(*args, **kwargs):
f5b96ee1
RD
4539 """
4540 EndDrawingOnTop(self) -> bool
4541
4542 Use this in conjunction with `StartDrawingOnTop` or
4543 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4544 top of existing windows. Without this, some window systems (such as X)
4545 only allow drawing to take place underneath other windows.
4546
4547 You might use this pair of functions when implementing a drag feature,
4548 for example as in the `wx.SplitterWindow` implementation.
4549
4550 These functions are probably obsolete since the X implementations
4551 allow drawing directly on the screen now. However, the fact that this
4552 function allows the screen to be refreshed afterwards may be useful
4553 to some applications.
4554 """
d55e5bfc
RD
4555 return _gdi_.ScreenDC_EndDrawingOnTop(*args, **kwargs)
4556
2131d850 4557_gdi_.ScreenDC_swigregister(ScreenDC)
d55e5bfc
RD
4558
4559#---------------------------------------------------------------------------
4560
72ef6efb
RD
4561class WindowDC(DC):
4562 """
4563 A wx.WindowDC must be constructed if an application wishes to paint on
4564 the whole area of a window (client and decorations). This should
4565 normally be constructed as a temporary stack object; don't store a
4566 wx.WindowDC object.
4567 """
4568 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4569 __repr__ = _swig_repr
4570 def __init__(self, *args, **kwargs):
4571 """
4572 __init__(self, Window win) -> WindowDC
4573
4574 Constructor. Pass the window on which you wish to paint.
4575 """
4576 _gdi_.WindowDC_swiginit(self,_gdi_.new_WindowDC(*args, **kwargs))
4577_gdi_.WindowDC_swigregister(WindowDC)
4578
4579#---------------------------------------------------------------------------
4580
4581class ClientDC(WindowDC):
f5b96ee1
RD
4582 """
4583 A wx.ClientDC must be constructed if an application wishes to paint on
4584 the client area of a window from outside an EVT_PAINT event. This should
4585 normally be constructed as a temporary stack object; don't store a
4586 wx.ClientDC object long term.
4587
4588 To draw on a window from within an EVT_PAINT handler, construct a
4589 `wx.PaintDC` object.
4590
4591 To draw on the whole window including decorations, construct a
4592 `wx.WindowDC` object (Windows only).
4593
4594 """
1bd55598
RD
4595 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4596 __repr__ = _swig_repr
4597 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4598 """
4599 __init__(self, Window win) -> ClientDC
4600
4601 Constructor. Pass the window on which you wish to paint.
4602 """
1bd55598 4603 _gdi_.ClientDC_swiginit(self,_gdi_.new_ClientDC(*args, **kwargs))
2131d850 4604_gdi_.ClientDC_swigregister(ClientDC)
d55e5bfc
RD
4605
4606#---------------------------------------------------------------------------
4607
72ef6efb 4608class PaintDC(ClientDC):
f5b96ee1
RD
4609 """
4610 A wx.PaintDC must be constructed if an application wishes to paint on
4611 the client area of a window from within an EVT_PAINT event
4612 handler. This should normally be constructed as a temporary stack
4613 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4614 handler, you **must** create a wx.PaintDC object within it even if you
4615 don't actually use it.
4616
4617 Using wx.PaintDC within EVT_PAINT handlers is important because it
4618 automatically sets the clipping area to the damaged area of the
4619 window. Attempts to draw outside this area do not appear.
4620
4621 To draw on a window from outside EVT_PAINT handlers, construct a
4622 `wx.ClientDC` object.
4623
4624 """
1bd55598
RD
4625 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4626 __repr__ = _swig_repr
4627 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4628 """
4629 __init__(self, Window win) -> PaintDC
4630
4631 Constructor. Pass the window on which you wish to paint.
4632 """
1bd55598 4633 _gdi_.PaintDC_swiginit(self,_gdi_.new_PaintDC(*args, **kwargs))
2131d850 4634_gdi_.PaintDC_swigregister(PaintDC)
d55e5bfc
RD
4635
4636#---------------------------------------------------------------------------
4637
d55e5bfc 4638class MirrorDC(DC):
f5b96ee1
RD
4639 """
4640 wx.MirrorDC is a simple wrapper class which is always associated with a
4641 real `wx.DC` object and either forwards all of its operations to it
4642 without changes (no mirroring takes place) or exchanges x and y
4643 coordinates which makes it possible to reuse the same code to draw a
4644 figure and its mirror -- i.e. reflection related to the diagonal line
4645 x == y.
4646 """
1bd55598
RD
4647 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4648 __repr__ = _swig_repr
4649 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4650 """
4651 __init__(self, DC dc, bool mirror) -> MirrorDC
4652
4653 Creates a mirrored DC associated with the real *dc*. Everything drawn
4654 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4655 *mirror* is True.
4656 """
1bd55598 4657 _gdi_.MirrorDC_swiginit(self,_gdi_.new_MirrorDC(*args, **kwargs))
2131d850 4658_gdi_.MirrorDC_swigregister(MirrorDC)
d55e5bfc
RD
4659
4660#---------------------------------------------------------------------------
4661
4662class PostScriptDC(DC):
f5b96ee1 4663 """This is a `wx.DC` that can write to PostScript files on any platform."""
1bd55598
RD
4664 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4665 __repr__ = _swig_repr
4666 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4667 """
4668 __init__(self, wxPrintData printData) -> PostScriptDC
4669
4670 Constructs a PostScript printer device context from a `wx.PrintData`
4671 object.
4672 """
1bd55598 4673 _gdi_.PostScriptDC_swiginit(self,_gdi_.new_PostScriptDC(*args, **kwargs))
d55e5bfc
RD
4674 def GetPrintData(*args, **kwargs):
4675 """GetPrintData(self) -> wxPrintData"""
4676 return _gdi_.PostScriptDC_GetPrintData(*args, **kwargs)
4677
4678 def SetPrintData(*args, **kwargs):
4679 """SetPrintData(self, wxPrintData data)"""
4680 return _gdi_.PostScriptDC_SetPrintData(*args, **kwargs)
4681
4682 def SetResolution(*args, **kwargs):
f5b96ee1
RD
4683 """
4684 SetResolution(int ppi)
4685
4686 Set resolution (in pixels per inch) that will be used in PostScript
4687 output. Default is 720ppi.
4688 """
d55e5bfc
RD
4689 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
4690
4691 SetResolution = staticmethod(SetResolution)
4692 def GetResolution(*args, **kwargs):
f5b96ee1
RD
4693 """
4694 GetResolution() -> int
4695
4696 Return resolution used in PostScript output.
4697 """
d55e5bfc
RD
4698 return _gdi_.PostScriptDC_GetResolution(*args, **kwargs)
4699
4700 GetResolution = staticmethod(GetResolution)
33d6fd3b 4701 PrintData = property(GetPrintData,SetPrintData,doc="See `GetPrintData` and `SetPrintData`")
2131d850 4702_gdi_.PostScriptDC_swigregister(PostScriptDC)
d55e5bfc
RD
4703
4704def PostScriptDC_SetResolution(*args, **kwargs):
1bd55598 4705 """
f5b96ee1
RD
4706 PostScriptDC_SetResolution(int ppi)
4707
4708 Set resolution (in pixels per inch) that will be used in PostScript
4709 output. Default is 720ppi.
4710 """
1bd55598 4711 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
d55e5bfc 4712
1bd55598
RD
4713def PostScriptDC_GetResolution(*args):
4714 """
f5b96ee1
RD
4715 PostScriptDC_GetResolution() -> int
4716
4717 Return resolution used in PostScript output.
4718 """
1bd55598 4719 return _gdi_.PostScriptDC_GetResolution(*args)
d55e5bfc
RD
4720
4721#---------------------------------------------------------------------------
4722
4723class MetaFile(_core.Object):
36ed4f51 4724 """Proxy of C++ MetaFile class"""
1bd55598
RD
4725 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4726 __repr__ = _swig_repr
4727 def __init__(self, *args, **kwargs):
d55e5bfc 4728 """__init__(self, String filename=EmptyString) -> MetaFile"""
1bd55598
RD
4729 _gdi_.MetaFile_swiginit(self,_gdi_.new_MetaFile(*args, **kwargs))
4730 __swig_destroy__ = _gdi_.delete_MetaFile
4731 __del__ = lambda self : None;
d55e5bfc
RD
4732 def Ok(*args, **kwargs):
4733 """Ok(self) -> bool"""
4734 return _gdi_.MetaFile_Ok(*args, **kwargs)
4735
4736 def SetClipboard(*args, **kwargs):
4737 """SetClipboard(self, int width=0, int height=0) -> bool"""
4738 return _gdi_.MetaFile_SetClipboard(*args, **kwargs)
4739
4740 def GetSize(*args, **kwargs):
4741 """GetSize(self) -> Size"""
4742 return _gdi_.MetaFile_GetSize(*args, **kwargs)
4743
4744 def GetWidth(*args, **kwargs):
4745 """GetWidth(self) -> int"""
4746 return _gdi_.MetaFile_GetWidth(*args, **kwargs)
4747
4748 def GetHeight(*args, **kwargs):
4749 """GetHeight(self) -> int"""
4750 return _gdi_.MetaFile_GetHeight(*args, **kwargs)
4751
4752 def __nonzero__(self): return self.Ok()
2131d850 4753_gdi_.MetaFile_swigregister(MetaFile)
d55e5bfc
RD
4754
4755class MetaFileDC(DC):
36ed4f51 4756 """Proxy of C++ MetaFileDC class"""
1bd55598
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
RD
4760 """
4761 __init__(self, String filename=EmptyString, int width=0, int height=0,
4762 String description=EmptyString) -> MetaFileDC
4763 """
1bd55598 4764 _gdi_.MetaFileDC_swiginit(self,_gdi_.new_MetaFileDC(*args, **kwargs))
d55e5bfc
RD
4765 def Close(*args, **kwargs):
4766 """Close(self) -> MetaFile"""
4767 return _gdi_.MetaFileDC_Close(*args, **kwargs)
4768
2131d850 4769_gdi_.MetaFileDC_swigregister(MetaFileDC)
d55e5bfc
RD
4770
4771class PrinterDC(DC):
36ed4f51 4772 """Proxy of C++ PrinterDC class"""
1bd55598
RD
4773 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4774 __repr__ = _swig_repr
4775 def __init__(self, *args, **kwargs):
d55e5bfc 4776 """__init__(self, wxPrintData printData) -> PrinterDC"""
1bd55598 4777 _gdi_.PrinterDC_swiginit(self,_gdi_.new_PrinterDC(*args, **kwargs))
2131d850 4778_gdi_.PrinterDC_swigregister(PrinterDC)
d55e5bfc 4779
d55e5bfc
RD
4780#---------------------------------------------------------------------------
4781
72ef6efb
RD
4782class GraphicsPath(object):
4783 """Proxy of C++ GraphicsPath class"""
4784 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4785 def __init__(self): raise AttributeError, "No constructor defined"
4786 __repr__ = _swig_repr
4787 __swig_destroy__ = _gdi_.delete_GraphicsPath
4788 __del__ = lambda self : None;
4789 def MoveToPoint(*args, **kwargs):
4790 """
4791 MoveToPoint(self, Double x, Double y)
4792
4793 Begins a new subpath at (x,y)
4794 """
4795 return _gdi_.GraphicsPath_MoveToPoint(*args, **kwargs)
4796
4797 def AddLineToPoint(*args, **kwargs):
4798 """
4799 AddLineToPoint(self, Double x, Double y)
4800
4801 Adds a straight line from the current point to (x,y)
4802 """
4803 return _gdi_.GraphicsPath_AddLineToPoint(*args, **kwargs)
4804
4805 def AddCurveToPoint(*args, **kwargs):
4806 """
4807 AddCurveToPoint(self, Double cx1, Double cy1, Double cx2, Double cy2, Double x,
4808 Double y)
4809
4810 Adds a cubic Bezier curve from the current point, using two control
4811 points and an end point
4812 """
4813 return _gdi_.GraphicsPath_AddCurveToPoint(*args, **kwargs)
4814
4815 def CloseSubpath(*args, **kwargs):
4816 """
4817 CloseSubpath(self)
4818
4819 closes the current sub-path
4820 """
4821 return _gdi_.GraphicsPath_CloseSubpath(*args, **kwargs)
4822
4823 def GetCurrentPoint(*args, **kwargs):
4824 """
4825 GetCurrentPoint(self) -> Point2D
4826
4827 Gets the last point of the current path, (0,0) if not yet set
4828 """
4829 return _gdi_.GraphicsPath_GetCurrentPoint(*args, **kwargs)
4830
4831 def AddArc(*args, **kwargs):
4832 """
4833 AddArc(self, Double x, Double y, Double r, Double startAngle, Double endAngle,
4834 bool clockwise)
4835
4836 Adds an arc of a circle centering at (x,y) with radius (r) from
4837 startAngle to endAngle
4838 """
4839 return _gdi_.GraphicsPath_AddArc(*args, **kwargs)
4840
4841 def AddQuadCurveToPoint(*args, **kwargs):
4842 """
4843 AddQuadCurveToPoint(self, Double cx, Double cy, Double x, Double y)
4844
4845 Adds a quadratic Bezier curve from the current point, using a control
4846 point and an end point
4847 """
4848 return _gdi_.GraphicsPath_AddQuadCurveToPoint(*args, **kwargs)
4849
4850 def AddRectangle(*args, **kwargs):
4851 """
4852 AddRectangle(self, Double x, Double y, Double w, Double h)
4853
4854 Appends a rectangle as a new closed subpath
4855 """
4856 return _gdi_.GraphicsPath_AddRectangle(*args, **kwargs)
4857
4858 def AddCircle(*args, **kwargs):
4859 """
4860 AddCircle(self, Double x, Double y, Double r)
4861
4862 Appends an ellipsis as a new closed subpath fitting the passed rectangle
4863 """
4864 return _gdi_.GraphicsPath_AddCircle(*args, **kwargs)
4865
4866 def AddArcToPoint(*args, **kwargs):
4867 """
4868 AddArcToPoint(self, Double x1, Double y1, Double x2, Double y2, Double r)
4869
4870 Draws a an arc to two tangents connecting (current) to (x1,y1) and (x1,y1)
4871 to (x2,y2), also a straight line from (current) to (x1,y1)
4872 """
4873 return _gdi_.GraphicsPath_AddArcToPoint(*args, **kwargs)
4874
4875_gdi_.GraphicsPath_swigregister(GraphicsPath)
4876
4877class GraphicsContext(object):
4878 """Proxy of C++ GraphicsContext class"""
4879 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
4880 def __init__(self): raise AttributeError, "No constructor defined"
4881 __repr__ = _swig_repr
4882 __swig_destroy__ = _gdi_.delete_GraphicsContext
4883 __del__ = lambda self : None;
4884 def Create(*args, **kwargs):
4885 """Create(WindowDC dc) -> GraphicsContext"""
4886 val = _gdi_.GraphicsContext_Create(*args, **kwargs)
4887 val.__dc = args[0] # save a ref so the other dc will not be deleted before self
4888 return val
4889
4890 Create = staticmethod(Create)
4891 def CreatePath(*args, **kwargs):
4892 """CreatePath(self) -> GraphicsPath"""
4893 return _gdi_.GraphicsContext_CreatePath(*args, **kwargs)
4894
4895 def PushState(*args, **kwargs):
4896 """PushState(self)"""
4897 return _gdi_.GraphicsContext_PushState(*args, **kwargs)
4898
4899 def PopState(*args, **kwargs):
4900 """PopState(self)"""
4901 return _gdi_.GraphicsContext_PopState(*args, **kwargs)
4902
4903 def Clip(*args, **kwargs):
4904 """Clip(self, Region region)"""
4905 return _gdi_.GraphicsContext_Clip(*args, **kwargs)
4906
4907 def Translate(*args, **kwargs):
4908 """Translate(self, Double dx, Double dy)"""
4909 return _gdi_.GraphicsContext_Translate(*args, **kwargs)
4910
4911 def Scale(*args, **kwargs):
4912 """Scale(self, Double xScale, Double yScale)"""
4913 return _gdi_.GraphicsContext_Scale(*args, **kwargs)
4914
4915 def Rotate(*args, **kwargs):
4916 """Rotate(self, Double angle)"""
4917 return _gdi_.GraphicsContext_Rotate(*args, **kwargs)
4918
4919 def SetPen(*args, **kwargs):
4920 """SetPen(self, Pen pen)"""
4921 return _gdi_.GraphicsContext_SetPen(*args, **kwargs)
4922
4923 def SetBrush(*args, **kwargs):
4924 """SetBrush(self, Brush brush)"""
4925 return _gdi_.GraphicsContext_SetBrush(*args, **kwargs)
4926
4927 def SetLinearGradientBrush(*args, **kwargs):
4928 """
4929 SetLinearGradientBrush(self, Double x1, Double y1, Double x2, Double y2, Colour c1,
4930 Colour c2)
4931 """
4932 return _gdi_.GraphicsContext_SetLinearGradientBrush(*args, **kwargs)
4933
4934 def SetRadialGradientBrush(*args, **kwargs):
4935 """
4936 SetRadialGradientBrush(self, Double xo, Double yo, Double xc, Double yc, Double radius,
4937 Colour oColor, Colour cColor)
4938 """
4939 return _gdi_.GraphicsContext_SetRadialGradientBrush(*args, **kwargs)
4940
4941 def SetFont(*args, **kwargs):
4942 """SetFont(self, Font font)"""
4943 return _gdi_.GraphicsContext_SetFont(*args, **kwargs)
4944
4945 def SetTextColor(*args, **kwargs):
4946 """SetTextColor(self, Colour col)"""
4947 return _gdi_.GraphicsContext_SetTextColor(*args, **kwargs)
4948
4949 def StrokePath(*args, **kwargs):
4950 """StrokePath(self, GraphicsPath path)"""
4951 return _gdi_.GraphicsContext_StrokePath(*args, **kwargs)
4952
4953 def FillPath(*args, **kwargs):
4954 """FillPath(self, GraphicsPath path, int fillStyle=WINDING_RULE)"""
4955 return _gdi_.GraphicsContext_FillPath(*args, **kwargs)
4956
4957 def DrawPath(*args, **kwargs):
4958 """DrawPath(self, GraphicsPath path, int fillStyle=WINDING_RULE)"""
4959 return _gdi_.GraphicsContext_DrawPath(*args, **kwargs)
4960
4961 def DrawText(*args):
4962 """
4963 DrawText(self, String str, Double x, Double y)
4964 DrawText(self, String str, Double x, Double y, Double angle)
4965 """
4966 return _gdi_.GraphicsContext_DrawText(*args)
4967
4968 def GetTextExtent(*args, **kwargs):
4969 """
4970 GetTextExtent(self, String text, Double OUTPUT, Double OUTPUT, Double OUTPUT,
4971 Double OUTPUT)
4972 """
4973 return _gdi_.GraphicsContext_GetTextExtent(*args, **kwargs)
4974
4975 def GetPartialTextExtents(*args, **kwargs):
4976 """GetPartialTextExtents(self, String text, wxArrayDouble widths)"""
4977 return _gdi_.GraphicsContext_GetPartialTextExtents(*args, **kwargs)
4978
4979 def DrawBitmap(*args, **kwargs):
4980 """DrawBitmap(self, Bitmap bmp, Double x, Double y, Double w, Double h)"""
4981 return _gdi_.GraphicsContext_DrawBitmap(*args, **kwargs)
4982
4983 def DrawIcon(*args, **kwargs):
4984 """DrawIcon(self, Icon icon, Double x, Double y, Double w, Double h)"""
4985 return _gdi_.GraphicsContext_DrawIcon(*args, **kwargs)
4986
4987 def StrokeLine(*args, **kwargs):
4988 """StrokeLine(self, Double x1, Double y1, Double x2, Double y2)"""
4989 return _gdi_.GraphicsContext_StrokeLine(*args, **kwargs)
4990
4991 def StrokeLines(*args):
4992 """
4993 StrokeLines(self, size_t n, Point2D points)
4994 StrokeLines(self, size_t n, Point2D beginPoints, Point2D endPoints)
4995 """
4996 return _gdi_.GraphicsContext_StrokeLines(*args)
4997
4998 def DrawLines(*args, **kwargs):
4999 """DrawLines(self, size_t n, Point2D points, int fillStyle=WINDING_RULE)"""
5000 return _gdi_.GraphicsContext_DrawLines(*args, **kwargs)
5001
5002 def DrawRectangle(*args, **kwargs):
5003 """DrawRectangle(self, Double x, Double y, Double w, Double h)"""
5004 return _gdi_.GraphicsContext_DrawRectangle(*args, **kwargs)
5005
5006 def DrawEllipse(*args, **kwargs):
5007 """DrawEllipse(self, Double x, Double y, Double w, Double h)"""
5008 return _gdi_.GraphicsContext_DrawEllipse(*args, **kwargs)
5009
5010 def DrawRoundedRectangle(*args, **kwargs):
5011 """DrawRoundedRectangle(self, Double x, Double y, Double w, Double h, Double radius)"""
5012 return _gdi_.GraphicsContext_DrawRoundedRectangle(*args, **kwargs)
5013
5014_gdi_.GraphicsContext_swigregister(GraphicsContext)
5015
5016def GraphicsContext_Create(*args, **kwargs):
5017 """GraphicsContext_Create(WindowDC dc) -> GraphicsContext"""
5018 val = _gdi_.GraphicsContext_Create(*args, **kwargs)
5019 val.__dc = args[0] # save a ref so the other dc will not be deleted before self
5020 return val
5021
5022class GCDC(DC):
5023 """Proxy of C++ GCDC class"""
5024 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5025 __repr__ = _swig_repr
5026 def __init__(self, *args, **kwargs):
5027 """__init__(self, WindowDC dc) -> GCDC"""
5028 _gdi_.GCDC_swiginit(self,_gdi_.new_GCDC(*args, **kwargs))
5029 self.__dc = args[0] # save a ref so the other dc will not be deleted before self
5030
5031 __swig_destroy__ = _gdi_.delete_GCDC
5032 __del__ = lambda self : None;
5033 def GetGraphicContext(*args, **kwargs):
5034 """GetGraphicContext(self) -> GraphicsContext"""
5035 return _gdi_.GCDC_GetGraphicContext(*args, **kwargs)
5036
5037_gdi_.GCDC_swigregister(GCDC)
5038
5039#---------------------------------------------------------------------------
5040
d55e5bfc
RD
5041IMAGELIST_DRAW_NORMAL = _gdi_.IMAGELIST_DRAW_NORMAL
5042IMAGELIST_DRAW_TRANSPARENT = _gdi_.IMAGELIST_DRAW_TRANSPARENT
5043IMAGELIST_DRAW_SELECTED = _gdi_.IMAGELIST_DRAW_SELECTED
5044IMAGELIST_DRAW_FOCUSED = _gdi_.IMAGELIST_DRAW_FOCUSED
5045IMAGE_LIST_NORMAL = _gdi_.IMAGE_LIST_NORMAL
5046IMAGE_LIST_SMALL = _gdi_.IMAGE_LIST_SMALL
5047IMAGE_LIST_STATE = _gdi_.IMAGE_LIST_STATE
5048class ImageList(_core.Object):
36ed4f51 5049 """Proxy of C++ ImageList class"""
1bd55598
RD
5050 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5051 __repr__ = _swig_repr
5052 def __init__(self, *args, **kwargs):
d55e5bfc 5053 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
1bd55598
RD
5054 _gdi_.ImageList_swiginit(self,_gdi_.new_ImageList(*args, **kwargs))
5055 __swig_destroy__ = _gdi_.delete_ImageList
5056 __del__ = lambda self : None;
d55e5bfc
RD
5057 def Add(*args, **kwargs):
5058 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
5059 return _gdi_.ImageList_Add(*args, **kwargs)
5060
5061 def AddWithColourMask(*args, **kwargs):
5062 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
5063 return _gdi_.ImageList_AddWithColourMask(*args, **kwargs)
5064
5065 def AddIcon(*args, **kwargs):
5066 """AddIcon(self, Icon icon) -> int"""
5067 return _gdi_.ImageList_AddIcon(*args, **kwargs)
5068
7fbf8399
RD
5069 def GetBitmap(*args, **kwargs):
5070 """GetBitmap(self, int index) -> Bitmap"""
5071 return _gdi_.ImageList_GetBitmap(*args, **kwargs)
5072
5073 def GetIcon(*args, **kwargs):
5074 """GetIcon(self, int index) -> Icon"""
5075 return _gdi_.ImageList_GetIcon(*args, **kwargs)
5076
d55e5bfc 5077 def Replace(*args, **kwargs):
2131d850 5078 """Replace(self, int index, Bitmap bitmap, Bitmap mask=NullBitmap) -> bool"""
d55e5bfc
RD
5079 return _gdi_.ImageList_Replace(*args, **kwargs)
5080
5081 def Draw(*args, **kwargs):
5082 """
5083 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
5084 bool solidBackground=False) -> bool
5085 """
5086 return _gdi_.ImageList_Draw(*args, **kwargs)
5087
5088 def GetImageCount(*args, **kwargs):
5089 """GetImageCount(self) -> int"""
5090 return _gdi_.ImageList_GetImageCount(*args, **kwargs)
5091
5092 def Remove(*args, **kwargs):
5093 """Remove(self, int index) -> bool"""
5094 return _gdi_.ImageList_Remove(*args, **kwargs)
5095
5096 def RemoveAll(*args, **kwargs):
5097 """RemoveAll(self) -> bool"""
5098 return _gdi_.ImageList_RemoveAll(*args, **kwargs)
5099
5100 def GetSize(*args, **kwargs):
b850e7f3 5101 """GetSize(index) -> (width,height)"""
d55e5bfc
RD
5102 return _gdi_.ImageList_GetSize(*args, **kwargs)
5103
ac5d357a
RD
5104 ImageCount = property(GetImageCount,doc="See `GetImageCount`")
5105 Size = property(GetSize,doc="See `GetSize`")
2131d850 5106_gdi_.ImageList_swigregister(ImageList)
d55e5bfc
RD
5107
5108#---------------------------------------------------------------------------
5109
da91cb0f
RD
5110class StockGDI(object):
5111 """Proxy of C++ StockGDI class"""
1bd55598 5112 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
1bd55598 5113 __repr__ = _swig_repr
da91cb0f
RD
5114 BRUSH_BLACK = _gdi_.StockGDI_BRUSH_BLACK
5115 BRUSH_BLUE = _gdi_.StockGDI_BRUSH_BLUE
5116 BRUSH_CYAN = _gdi_.StockGDI_BRUSH_CYAN
5117 BRUSH_GREEN = _gdi_.StockGDI_BRUSH_GREEN
5118 BRUSH_GREY = _gdi_.StockGDI_BRUSH_GREY
5119 BRUSH_LIGHTGREY = _gdi_.StockGDI_BRUSH_LIGHTGREY
5120 BRUSH_MEDIUMGREY = _gdi_.StockGDI_BRUSH_MEDIUMGREY
5121 BRUSH_RED = _gdi_.StockGDI_BRUSH_RED
5122 BRUSH_TRANSPARENT = _gdi_.StockGDI_BRUSH_TRANSPARENT
5123 BRUSH_WHITE = _gdi_.StockGDI_BRUSH_WHITE
5124 COLOUR_BLACK = _gdi_.StockGDI_COLOUR_BLACK
5125 COLOUR_BLUE = _gdi_.StockGDI_COLOUR_BLUE
5126 COLOUR_CYAN = _gdi_.StockGDI_COLOUR_CYAN
5127 COLOUR_GREEN = _gdi_.StockGDI_COLOUR_GREEN
5128 COLOUR_LIGHTGREY = _gdi_.StockGDI_COLOUR_LIGHTGREY
5129 COLOUR_RED = _gdi_.StockGDI_COLOUR_RED
5130 COLOUR_WHITE = _gdi_.StockGDI_COLOUR_WHITE
5131 CURSOR_CROSS = _gdi_.StockGDI_CURSOR_CROSS
5132 CURSOR_HOURGLASS = _gdi_.StockGDI_CURSOR_HOURGLASS
5133 CURSOR_STANDARD = _gdi_.StockGDI_CURSOR_STANDARD
5134 FONT_ITALIC = _gdi_.StockGDI_FONT_ITALIC
5135 FONT_NORMAL = _gdi_.StockGDI_FONT_NORMAL
5136 FONT_SMALL = _gdi_.StockGDI_FONT_SMALL
5137 FONT_SWISS = _gdi_.StockGDI_FONT_SWISS
5138 PEN_BLACK = _gdi_.StockGDI_PEN_BLACK
5139 PEN_BLACKDASHED = _gdi_.StockGDI_PEN_BLACKDASHED
5140 PEN_CYAN = _gdi_.StockGDI_PEN_CYAN
5141 PEN_GREEN = _gdi_.StockGDI_PEN_GREEN
5142 PEN_GREY = _gdi_.StockGDI_PEN_GREY
5143 PEN_LIGHTGREY = _gdi_.StockGDI_PEN_LIGHTGREY
5144 PEN_MEDIUMGREY = _gdi_.StockGDI_PEN_MEDIUMGREY
5145 PEN_RED = _gdi_.StockGDI_PEN_RED
5146 PEN_TRANSPARENT = _gdi_.StockGDI_PEN_TRANSPARENT
5147 PEN_WHITE = _gdi_.StockGDI_PEN_WHITE
5148 ITEMCOUNT = _gdi_.StockGDI_ITEMCOUNT
5149 def __init__(self, *args, **kwargs):
5150 """__init__(self) -> StockGDI"""
5151 _gdi_.StockGDI_swiginit(self,_gdi_.new_StockGDI(*args, **kwargs))
5152 __swig_destroy__ = _gdi_.delete_StockGDI
5153 __del__ = lambda self : None;
5154 def DeleteAll(*args, **kwargs):
5155 """DeleteAll()"""
5156 return _gdi_.StockGDI_DeleteAll(*args, **kwargs)
d55e5bfc 5157
da91cb0f
RD
5158 DeleteAll = staticmethod(DeleteAll)
5159 def instance(*args, **kwargs):
5160 """instance() -> StockGDI"""
5161 return _gdi_.StockGDI_instance(*args, **kwargs)
d55e5bfc 5162
da91cb0f
RD
5163 instance = staticmethod(instance)
5164 def GetBrush(*args, **kwargs):
5165 """GetBrush(int item) -> Brush"""
5166 return _gdi_.StockGDI_GetBrush(*args, **kwargs)
d55e5bfc 5167
da91cb0f
RD
5168 GetBrush = staticmethod(GetBrush)
5169 def GetColour(*args, **kwargs):
5170 """GetColour(int item) -> Colour"""
5171 return _gdi_.StockGDI_GetColour(*args, **kwargs)
d55e5bfc 5172
da91cb0f
RD
5173 GetColour = staticmethod(GetColour)
5174 def GetCursor(*args, **kwargs):
5175 """GetCursor(int item) -> Cursor"""
5176 return _gdi_.StockGDI_GetCursor(*args, **kwargs)
5177
5178 GetCursor = staticmethod(GetCursor)
5179 def GetPen(*args, **kwargs):
5180 """GetPen(int item) -> Pen"""
5181 return _gdi_.StockGDI_GetPen(*args, **kwargs)
5182
5183 GetPen = staticmethod(GetPen)
5184 def GetFont(*args, **kwargs):
5185 """GetFont(self, int item) -> Font"""
5186 return _gdi_.StockGDI_GetFont(*args, **kwargs)
5187
2131d850
RD
5188 def _initStockObjects():
5189 import wx
704eda0c
RD
5190 wx.ITALIC_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_ITALIC).this
5191 wx.NORMAL_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_NORMAL).this
5192 wx.SMALL_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_SMALL).this
5193 wx.SWISS_FONT.this = StockGDI.instance().GetFont(StockGDI.FONT_SWISS).this
2131d850 5194
704eda0c
RD
5195 wx.BLACK_DASHED_PEN.this = StockGDI.GetPen(StockGDI.PEN_BLACKDASHED).this
5196 wx.BLACK_PEN.this = StockGDI.GetPen(StockGDI.PEN_BLACK).this
5197 wx.CYAN_PEN.this = StockGDI.GetPen(StockGDI.PEN_CYAN).this
5198 wx.GREEN_PEN.this = StockGDI.GetPen(StockGDI.PEN_GREEN).this
5199 wx.GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_GREY).this
5200 wx.LIGHT_GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_LIGHTGREY).this
5201 wx.MEDIUM_GREY_PEN.this = StockGDI.GetPen(StockGDI.PEN_MEDIUMGREY).this
5202 wx.RED_PEN.this = StockGDI.GetPen(StockGDI.PEN_RED).this
5203 wx.TRANSPARENT_PEN.this = StockGDI.GetPen(StockGDI.PEN_TRANSPARENT).this
5204 wx.WHITE_PEN.this = StockGDI.GetPen(StockGDI.PEN_WHITE).this
5205
5206 wx.BLACK_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_BLACK).this
5207 wx.BLUE_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_BLUE).this
5208 wx.CYAN_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_CYAN).this
5209 wx.GREEN_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_GREEN).this
5210 wx.GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_GREY).this
5211 wx.LIGHT_GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_LIGHTGREY).this
5212 wx.MEDIUM_GREY_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_MEDIUMGREY).this
5213 wx.RED_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_RED).this
5214 wx.TRANSPARENT_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_TRANSPARENT).this
5215 wx.WHITE_BRUSH.this = StockGDI.GetBrush(StockGDI.BRUSH_WHITE).this
5216
5217 wx.BLACK.this = StockGDI.GetColour(StockGDI.COLOUR_BLACK).this
5218 wx.BLUE.this = StockGDI.GetColour(StockGDI.COLOUR_BLUE).this
5219 wx.CYAN.this = StockGDI.GetColour(StockGDI.COLOUR_CYAN).this
5220 wx.GREEN.this = StockGDI.GetColour(StockGDI.COLOUR_GREEN).this
5221 wx.LIGHT_GREY.this = StockGDI.GetColour(StockGDI.COLOUR_LIGHTGREY).this
5222 wx.RED.this = StockGDI.GetColour(StockGDI.COLOUR_RED).this
5223 wx.WHITE.this = StockGDI.GetColour(StockGDI.COLOUR_WHITE).this
5224
5225 wx.CROSS_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_CROSS).this
5226 wx.HOURGLASS_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_HOURGLASS).this
5227 wx.STANDARD_CURSOR.this = StockGDI.GetCursor(StockGDI.CURSOR_STANDARD).this
5228
5229 wx.TheFontList.this = _wxPyInitTheFontList().this
5230 wx.ThePenList.this = _wxPyInitThePenList().this
5231 wx.TheBrushList.this = _wxPyInitTheBrushList().this
5232 wx.TheColourDatabase.this = _wxPyInitTheColourDatabase().this
5233
2131d850
RD
5234
5235 _initStockObjects = staticmethod(_initStockObjects)
5236
5237_gdi_.StockGDI_swigregister(StockGDI)
da91cb0f
RD
5238
5239def StockGDI_DeleteAll(*args):
5240 """StockGDI_DeleteAll()"""
5241 return _gdi_.StockGDI_DeleteAll(*args)
5242
5243def StockGDI_instance(*args):
5244 """StockGDI_instance() -> StockGDI"""
5245 return _gdi_.StockGDI_instance(*args)
5246
5247def StockGDI_GetBrush(*args, **kwargs):
5248 """StockGDI_GetBrush(int item) -> Brush"""
5249 return _gdi_.StockGDI_GetBrush(*args, **kwargs)
5250
5251def StockGDI_GetColour(*args, **kwargs):
5252 """StockGDI_GetColour(int item) -> Colour"""
5253 return _gdi_.StockGDI_GetColour(*args, **kwargs)
5254
5255def StockGDI_GetCursor(*args, **kwargs):
5256 """StockGDI_GetCursor(int item) -> Cursor"""
5257 return _gdi_.StockGDI_GetCursor(*args, **kwargs)
5258
5259def StockGDI_GetPen(*args, **kwargs):
5260 """StockGDI_GetPen(int item) -> Pen"""
5261 return _gdi_.StockGDI_GetPen(*args, **kwargs)
5262
704eda0c
RD
5263# Create an uninitialized instance for the stock objects, they will
5264# be initialized later when the wx.App object is created.
5265ITALIC_FONT = Font.__new__(Font)
5266NORMAL_FONT = Font.__new__(Font)
5267SMALL_FONT = Font.__new__(Font)
5268SWISS_FONT = Font.__new__(Font)
5269
5270BLACK_DASHED_PEN = Pen.__new__(Pen)
5271BLACK_PEN = Pen.__new__(Pen)
5272CYAN_PEN = Pen.__new__(Pen)
5273GREEN_PEN = Pen.__new__(Pen)
5274GREY_PEN = Pen.__new__(Pen)
5275LIGHT_GREY_PEN = Pen.__new__(Pen)
5276MEDIUM_GREY_PEN = Pen.__new__(Pen)
5277RED_PEN = Pen.__new__(Pen)
5278TRANSPARENT_PEN = Pen.__new__(Pen)
5279WHITE_PEN = Pen.__new__(Pen)
5280
5281BLACK_BRUSH = Brush.__new__(Brush)
5282BLUE_BRUSH = Brush.__new__(Brush)
5283CYAN_BRUSH = Brush.__new__(Brush)
5284GREEN_BRUSH = Brush.__new__(Brush)
5285GREY_BRUSH = Brush.__new__(Brush)
5286LIGHT_GREY_BRUSH = Brush.__new__(Brush)
5287MEDIUM_GREY_BRUSH = Brush.__new__(Brush)
5288RED_BRUSH = Brush.__new__(Brush)
5289TRANSPARENT_BRUSH = Brush.__new__(Brush)
5290WHITE_BRUSH = Brush.__new__(Brush)
5291
5292BLACK = Colour.__new__(Colour)
5293BLUE = Colour.__new__(Colour)
5294CYAN = Colour.__new__(Colour)
5295GREEN = Colour.__new__(Colour)
5296LIGHT_GREY = Colour.__new__(Colour)
5297RED = Colour.__new__(Colour)
5298WHITE = Colour.__new__(Colour)
5299
5300CROSS_CURSOR = Cursor.__new__(Cursor)
5301HOURGLASS_CURSOR = Cursor.__new__(Cursor)
5302STANDARD_CURSOR = Cursor.__new__(Cursor)
5303
da91cb0f
RD
5304class GDIObjListBase(object):
5305 """Proxy of C++ GDIObjListBase class"""
5306 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5307 __repr__ = _swig_repr
5308 def __init__(self, *args, **kwargs):
5309 """__init__(self) -> GDIObjListBase"""
5310 _gdi_.GDIObjListBase_swiginit(self,_gdi_.new_GDIObjListBase(*args, **kwargs))
5311 __swig_destroy__ = _gdi_.delete_GDIObjListBase
5312 __del__ = lambda self : None;
2131d850 5313_gdi_.GDIObjListBase_swigregister(GDIObjListBase)
d55e5bfc 5314cvar = _gdi_.cvar
d55e5bfc
RD
5315NullBitmap = cvar.NullBitmap
5316NullIcon = cvar.NullIcon
5317NullCursor = cvar.NullCursor
5318NullPen = cvar.NullPen
5319NullBrush = cvar.NullBrush
5320NullPalette = cvar.NullPalette
5321NullFont = cvar.NullFont
5322NullColour = cvar.NullColour
5323
da91cb0f
RD
5324class PenList(GDIObjListBase):
5325 """Proxy of C++ PenList class"""
1bd55598
RD
5326 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5327 def __init__(self): raise AttributeError, "No constructor defined"
5328 __repr__ = _swig_repr
da91cb0f
RD
5329 def FindOrCreatePen(*args, **kwargs):
5330 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
5331 return _gdi_.PenList_FindOrCreatePen(*args, **kwargs)
5332
5333 def AddPen(*args, **kwargs):
5334 """AddPen(self, Pen pen)"""
5335 return _gdi_.PenList_AddPen(*args, **kwargs)
d55e5bfc 5336
da91cb0f
RD
5337 def RemovePen(*args, **kwargs):
5338 """RemovePen(self, Pen pen)"""
5339 return _gdi_.PenList_RemovePen(*args, **kwargs)
5340
5341 AddPen = wx._deprecated(AddPen)
5342 RemovePen = wx._deprecated(RemovePen)
5343
2131d850 5344_gdi_.PenList_swigregister(PenList)
da91cb0f
RD
5345
5346class BrushList(GDIObjListBase):
5347 """Proxy of C++ BrushList class"""
5348 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5349 def __init__(self): raise AttributeError, "No constructor defined"
5350 __repr__ = _swig_repr
d55e5bfc 5351 def FindOrCreateBrush(*args, **kwargs):
bb2ef2cc 5352 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
d55e5bfc
RD
5353 return _gdi_.BrushList_FindOrCreateBrush(*args, **kwargs)
5354
da91cb0f
RD
5355 def AddBrush(*args, **kwargs):
5356 """AddBrush(self, Brush brush)"""
5357 return _gdi_.BrushList_AddBrush(*args, **kwargs)
5358
d55e5bfc
RD
5359 def RemoveBrush(*args, **kwargs):
5360 """RemoveBrush(self, Brush brush)"""
5361 return _gdi_.BrushList_RemoveBrush(*args, **kwargs)
5362
da91cb0f
RD
5363 AddBrush = wx._deprecated(AddBrush)
5364 RemoveBrush = wx._deprecated(RemoveBrush)
d55e5bfc 5365
2131d850 5366_gdi_.BrushList_swigregister(BrushList)
d55e5bfc 5367
da91cb0f
RD
5368class FontList(GDIObjListBase):
5369 """Proxy of C++ FontList class"""
5370 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5371 def __init__(self): raise AttributeError, "No constructor defined"
5372 __repr__ = _swig_repr
5373 def FindOrCreateFont(*args, **kwargs):
5374 """
5375 FindOrCreateFont(self, int point_size, int family, int style, int weight,
5376 bool underline=False, String facename=EmptyString,
5377 int encoding=FONTENCODING_DEFAULT) -> Font
5378 """
5379 return _gdi_.FontList_FindOrCreateFont(*args, **kwargs)
5380
5381 def AddFont(*args, **kwargs):
5382 """AddFont(self, Font font)"""
5383 return _gdi_.FontList_AddFont(*args, **kwargs)
5384
5385 def RemoveFont(*args, **kwargs):
5386 """RemoveFont(self, Font font)"""
5387 return _gdi_.FontList_RemoveFont(*args, **kwargs)
5388
5389 AddFont = wx._deprecated(AddFont)
5390 RemoveFont = wx._deprecated(RemoveFont)
5391
2131d850 5392_gdi_.FontList_swigregister(FontList)
da91cb0f
RD
5393
5394class ColourDatabase(object):
36ed4f51 5395 """Proxy of C++ ColourDatabase class"""
1bd55598
RD
5396 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5397 __repr__ = _swig_repr
5398 def __init__(self, *args, **kwargs):
d55e5bfc 5399 """__init__(self) -> ColourDatabase"""
1bd55598
RD
5400 _gdi_.ColourDatabase_swiginit(self,_gdi_.new_ColourDatabase(*args, **kwargs))
5401 __swig_destroy__ = _gdi_.delete_ColourDatabase
5402 __del__ = lambda self : None;
d55e5bfc
RD
5403 def Find(*args, **kwargs):
5404 """Find(self, String name) -> Colour"""
5405 return _gdi_.ColourDatabase_Find(*args, **kwargs)
5406
5407 def FindName(*args, **kwargs):
5408 """FindName(self, Colour colour) -> String"""
5409 return _gdi_.ColourDatabase_FindName(*args, **kwargs)
5410
5411 FindColour = Find
5412 def AddColour(*args, **kwargs):
5413 """AddColour(self, String name, Colour colour)"""
5414 return _gdi_.ColourDatabase_AddColour(*args, **kwargs)
5415
5416 def Append(*args, **kwargs):
5417 """Append(self, String name, int red, int green, int blue)"""
5418 return _gdi_.ColourDatabase_Append(*args, **kwargs)
5419
2131d850 5420_gdi_.ColourDatabase_swigregister(ColourDatabase)
d55e5bfc 5421
da91cb0f 5422#---------------------------------------------------------------------------
d55e5bfc 5423
d55e5bfc 5424
da91cb0f
RD
5425def _wxPyInitTheFontList(*args):
5426 """_wxPyInitTheFontList() -> FontList"""
5427 return _gdi_._wxPyInitTheFontList(*args)
d55e5bfc 5428
da91cb0f
RD
5429def _wxPyInitThePenList(*args):
5430 """_wxPyInitThePenList() -> PenList"""
5431 return _gdi_._wxPyInitThePenList(*args)
d55e5bfc 5432
da91cb0f
RD
5433def _wxPyInitTheBrushList(*args):
5434 """_wxPyInitTheBrushList() -> BrushList"""
5435 return _gdi_._wxPyInitTheBrushList(*args)
d55e5bfc 5436
da91cb0f
RD
5437def _wxPyInitTheColourDatabase(*args):
5438 """_wxPyInitTheColourDatabase() -> ColourDatabase"""
5439 return _gdi_._wxPyInitTheColourDatabase(*args)
704eda0c
RD
5440# Create an uninitialized instance for the stock objects, they will
5441# be initialized later when the wx.App object is created.
5442TheFontList = FontList.__new__(FontList)
5443ThePenList = PenList.__new__(PenList)
5444TheBrushList = BrushList.__new__(BrushList)
5445TheColourDatabase = ColourDatabase.__new__(ColourDatabase)
d55e5bfc
RD
5446
5447NullColor = NullColour
5448#---------------------------------------------------------------------------
5449
5450class Effects(_core.Object):
36ed4f51 5451 """Proxy of C++ Effects class"""
1bd55598
RD
5452 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5453 __repr__ = _swig_repr
5454 def __init__(self, *args, **kwargs):
d55e5bfc 5455 """__init__(self) -> Effects"""
1bd55598 5456 _gdi_.Effects_swiginit(self,_gdi_.new_Effects(*args, **kwargs))
d55e5bfc
RD
5457 def GetHighlightColour(*args, **kwargs):
5458 """GetHighlightColour(self) -> Colour"""
5459 return _gdi_.Effects_GetHighlightColour(*args, **kwargs)
5460
5461 def GetLightShadow(*args, **kwargs):
5462 """GetLightShadow(self) -> Colour"""
5463 return _gdi_.Effects_GetLightShadow(*args, **kwargs)
5464
5465 def GetFaceColour(*args, **kwargs):
5466 """GetFaceColour(self) -> Colour"""
5467 return _gdi_.Effects_GetFaceColour(*args, **kwargs)
5468
5469 def GetMediumShadow(*args, **kwargs):
5470 """GetMediumShadow(self) -> Colour"""
5471 return _gdi_.Effects_GetMediumShadow(*args, **kwargs)
5472
5473 def GetDarkShadow(*args, **kwargs):
5474 """GetDarkShadow(self) -> Colour"""
5475 return _gdi_.Effects_GetDarkShadow(*args, **kwargs)
5476
5477 def SetHighlightColour(*args, **kwargs):
5478 """SetHighlightColour(self, Colour c)"""
5479 return _gdi_.Effects_SetHighlightColour(*args, **kwargs)
5480
5481 def SetLightShadow(*args, **kwargs):
5482 """SetLightShadow(self, Colour c)"""
5483 return _gdi_.Effects_SetLightShadow(*args, **kwargs)
5484
5485 def SetFaceColour(*args, **kwargs):
5486 """SetFaceColour(self, Colour c)"""
5487 return _gdi_.Effects_SetFaceColour(*args, **kwargs)
5488
5489 def SetMediumShadow(*args, **kwargs):
5490 """SetMediumShadow(self, Colour c)"""
5491 return _gdi_.Effects_SetMediumShadow(*args, **kwargs)
5492
5493 def SetDarkShadow(*args, **kwargs):
5494 """SetDarkShadow(self, Colour c)"""
5495 return _gdi_.Effects_SetDarkShadow(*args, **kwargs)
5496
5497 def Set(*args, **kwargs):
5498 """
5499 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
5500 Colour mediumShadow, Colour darkShadow)
5501 """
5502 return _gdi_.Effects_Set(*args, **kwargs)
5503
5504 def DrawSunkenEdge(*args, **kwargs):
5505 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
5506 return _gdi_.Effects_DrawSunkenEdge(*args, **kwargs)
5507
5508 def TileBitmap(*args, **kwargs):
5509 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
5510 return _gdi_.Effects_TileBitmap(*args, **kwargs)
5511
ac5d357a
RD
5512 DarkShadow = property(GetDarkShadow,SetDarkShadow,doc="See `GetDarkShadow` and `SetDarkShadow`")
5513 FaceColour = property(GetFaceColour,SetFaceColour,doc="See `GetFaceColour` and `SetFaceColour`")
5514 HighlightColour = property(GetHighlightColour,SetHighlightColour,doc="See `GetHighlightColour` and `SetHighlightColour`")
5515 LightShadow = property(GetLightShadow,SetLightShadow,doc="See `GetLightShadow` and `SetLightShadow`")
5516 MediumShadow = property(GetMediumShadow,SetMediumShadow,doc="See `GetMediumShadow` and `SetMediumShadow`")
2131d850 5517_gdi_.Effects_swigregister(Effects)
d55e5bfc 5518
be9b1dca
RD
5519#---------------------------------------------------------------------------
5520
5521CONTROL_DISABLED = _gdi_.CONTROL_DISABLED
5522CONTROL_FOCUSED = _gdi_.CONTROL_FOCUSED
5523CONTROL_PRESSED = _gdi_.CONTROL_PRESSED
79df624a 5524CONTROL_SPECIAL = _gdi_.CONTROL_SPECIAL
be9b1dca
RD
5525CONTROL_ISDEFAULT = _gdi_.CONTROL_ISDEFAULT
5526CONTROL_ISSUBMENU = _gdi_.CONTROL_ISSUBMENU
5527CONTROL_EXPANDED = _gdi_.CONTROL_EXPANDED
79df624a 5528CONTROL_SIZEGRIP = _gdi_.CONTROL_SIZEGRIP
be9b1dca
RD
5529CONTROL_CURRENT = _gdi_.CONTROL_CURRENT
5530CONTROL_SELECTED = _gdi_.CONTROL_SELECTED
5531CONTROL_CHECKED = _gdi_.CONTROL_CHECKED
5532CONTROL_CHECKABLE = _gdi_.CONTROL_CHECKABLE
5533CONTROL_UNDETERMINED = _gdi_.CONTROL_UNDETERMINED
5534CONTROL_FLAGS_MASK = _gdi_.CONTROL_FLAGS_MASK
5535CONTROL_DIRTY = _gdi_.CONTROL_DIRTY
5536class SplitterRenderParams(object):
5537 """
5538 This is just a simple struct used as a return value of
5539 `wx.RendererNative.GetSplitterParams` and contains some platform
5540 specific metrics about splitters.
5541
5542 * widthSash: the width of the splitter sash.
5543 * border: the width of the border of the splitter window.
5544 * isHotSensitive: ``True`` if the splitter changes its
5545 appearance when the mouse is over it.
5546
5547
5548 """
1bd55598
RD
5549 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5550 __repr__ = _swig_repr
5551 def __init__(self, *args, **kwargs):
be9b1dca
RD
5552 """
5553 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5554
5555 This is just a simple struct used as a return value of
5556 `wx.RendererNative.GetSplitterParams` and contains some platform
5557 specific metrics about splitters.
5558
5559 * widthSash: the width of the splitter sash.
5560 * border: the width of the border of the splitter window.
5561 * isHotSensitive: ``True`` if the splitter changes its
5562 appearance when the mouse is over it.
5563
5564
5565 """
1bd55598
RD
5566 _gdi_.SplitterRenderParams_swiginit(self,_gdi_.new_SplitterRenderParams(*args, **kwargs))
5567 __swig_destroy__ = _gdi_.delete_SplitterRenderParams
5568 __del__ = lambda self : None;
be9b1dca
RD
5569 widthSash = property(_gdi_.SplitterRenderParams_widthSash_get)
5570 border = property(_gdi_.SplitterRenderParams_border_get)
5571 isHotSensitive = property(_gdi_.SplitterRenderParams_isHotSensitive_get)
2131d850 5572_gdi_.SplitterRenderParams_swigregister(SplitterRenderParams)
be9b1dca 5573
33d6fd3b
RD
5574class HeaderButtonParams(object):
5575 """Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`"""
5576 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5577 __repr__ = _swig_repr
5578 def __init__(self, *args, **kwargs):
5579 """
5580 __init__(self) -> HeaderButtonParams
5581
5582 Extra (optional) parameters for `wx.RendererNative.DrawHeaderButton`
5583 """
5584 _gdi_.HeaderButtonParams_swiginit(self,_gdi_.new_HeaderButtonParams(*args, **kwargs))
5585 __swig_destroy__ = _gdi_.delete_HeaderButtonParams
5586 __del__ = lambda self : None;
5587 m_arrowColour = property(_gdi_.HeaderButtonParams_m_arrowColour_get, _gdi_.HeaderButtonParams_m_arrowColour_set)
5588 m_selectionColour = property(_gdi_.HeaderButtonParams_m_selectionColour_get, _gdi_.HeaderButtonParams_m_selectionColour_set)
5589 m_labelText = property(_gdi_.HeaderButtonParams_m_labelText_get, _gdi_.HeaderButtonParams_m_labelText_set)
5590 m_labelFont = property(_gdi_.HeaderButtonParams_m_labelFont_get, _gdi_.HeaderButtonParams_m_labelFont_set)
5591 m_labelColour = property(_gdi_.HeaderButtonParams_m_labelColour_get, _gdi_.HeaderButtonParams_m_labelColour_set)
5592 m_labelBitmap = property(_gdi_.HeaderButtonParams_m_labelBitmap_get, _gdi_.HeaderButtonParams_m_labelBitmap_set)
5593 m_labelAlignment = property(_gdi_.HeaderButtonParams_m_labelAlignment_get, _gdi_.HeaderButtonParams_m_labelAlignment_set)
5594_gdi_.HeaderButtonParams_swigregister(HeaderButtonParams)
5595
5596HDR_SORT_ICON_NONE = _gdi_.HDR_SORT_ICON_NONE
5597HDR_SORT_ICON_UP = _gdi_.HDR_SORT_ICON_UP
5598HDR_SORT_ICON_DOWN = _gdi_.HDR_SORT_ICON_DOWN
be9b1dca
RD
5599class RendererVersion(object):
5600 """
5601 This simple struct represents the `wx.RendererNative` interface
5602 version and is only used as the return value of
5603 `wx.RendererNative.GetVersion`.
5604 """
1bd55598
RD
5605 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5606 __repr__ = _swig_repr
5607 def __init__(self, *args, **kwargs):
be9b1dca
RD
5608 """
5609 __init__(self, int version_, int age_) -> RendererVersion
5610
5611 This simple struct represents the `wx.RendererNative` interface
5612 version and is only used as the return value of
5613 `wx.RendererNative.GetVersion`.
5614 """
1bd55598
RD
5615 _gdi_.RendererVersion_swiginit(self,_gdi_.new_RendererVersion(*args, **kwargs))
5616 __swig_destroy__ = _gdi_.delete_RendererVersion
5617 __del__ = lambda self : None;
be9b1dca
RD
5618 Current_Version = _gdi_.RendererVersion_Current_Version
5619 Current_Age = _gdi_.RendererVersion_Current_Age
5620 def IsCompatible(*args, **kwargs):
5621 """IsCompatible(RendererVersion ver) -> bool"""
5622 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5623
5624 IsCompatible = staticmethod(IsCompatible)
5625 version = property(_gdi_.RendererVersion_version_get)
5626 age = property(_gdi_.RendererVersion_age_get)
2131d850 5627_gdi_.RendererVersion_swigregister(RendererVersion)
be9b1dca
RD
5628
5629def RendererVersion_IsCompatible(*args, **kwargs):
1bd55598
RD
5630 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5631 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
be9b1dca
RD
5632
5633class RendererNative(object):
5634 """
33d6fd3b
RD
5635 One of the design principles of wxWidgets is to use the native
5636 widgets on every platform in order to be as close as possible to
5637 the native look and feel on every platform. However there are
5638 still cases when some generic widgets are needed for various
5639 reasons, but it can sometimes take a lot of messy work to make
5640 them conform to the native LnF.
be9b1dca
RD
5641
5642 The wx.RendererNative class is a collection of functions that have
5643 platform-specific implementations for drawing certain parts of
5644 genereic controls in ways that are as close to the native look as
5645 possible.
5646
704eda0c
RD
5647 Note that each drawing function restores the `wx.DC` attributes if it
5648 changes them, so it is safe to assume that the same pen, brush and
5649 colours that were active before the call to this function are still in
5650 effect after it.
5651
be9b1dca 5652 """
1bd55598
RD
5653 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5654 def __init__(self): raise AttributeError, "No constructor defined"
5655 __repr__ = _swig_repr
be9b1dca
RD
5656 def DrawHeaderButton(*args, **kwargs):
5657 """
33d6fd3b
RD
5658 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE,
5659 HeaderButtonParams params=None)
be9b1dca 5660
1c71765a 5661 Draw the header control button (such as what is used by `wx.ListCtrl`
be9b1dca
RD
5662 in report mode.)
5663 """
5664 return _gdi_.RendererNative_DrawHeaderButton(*args, **kwargs)
5665
33d6fd3b
RD
5666 def DrawHeaderButtonContents(*args, **kwargs):
5667 """
5668 DrawHeaderButtonContents(self, Window win, DC dc, Rect rect, int flags=0, int sortArrow=HDR_SORT_ICON_NONE,
5669 HeaderButtonParams params=None)
5670
5671 Draw the contents of a header control button, (label, sort
5672 arrows, etc.) Normally this is only called by `DrawHeaderButton`.
5673 """
5674 return _gdi_.RendererNative_DrawHeaderButtonContents(*args, **kwargs)
5675
5676 def GetHeaderButtonHeight(*args, **kwargs):
5677 """
5678 GetHeaderButtonHeight(self, Window win) -> int
5679
5680 Returns the default height of a header button, either a fixed platform
5681 height if available, or a generic height based on the window's font.
5682 """
5683 return _gdi_.RendererNative_GetHeaderButtonHeight(*args, **kwargs)
5684
be9b1dca
RD
5685 def DrawTreeItemButton(*args, **kwargs):
5686 """
5687 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5688
5689 Draw the expanded/collapsed icon for a tree control item.
5690 """
5691 return _gdi_.RendererNative_DrawTreeItemButton(*args, **kwargs)
5692
5693 def DrawSplitterBorder(*args, **kwargs):
5694 """
5695 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5696
5697 Draw the border for a sash window: this border must be such that the
5698 sash drawn by `DrawSplitterSash` blends into it well.
5699 """
5700 return _gdi_.RendererNative_DrawSplitterBorder(*args, **kwargs)
5701
5702 def DrawSplitterSash(*args, **kwargs):
5703 """
5704 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5705 int flags=0)
5706
5707 Draw a sash. The orient parameter defines whether the sash should be
5708 vertical or horizontal and how the position should be interpreted.
5709 """
5710 return _gdi_.RendererNative_DrawSplitterSash(*args, **kwargs)
5711
5712 def DrawComboBoxDropButton(*args, **kwargs):
5713 """
5714 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5715
5716 Draw a button like the one used by `wx.ComboBox` to show a drop down
5717 window. The usual appearance is a downwards pointing arrow.
5718
5719 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5720 ``wx.CONTROL_CURRENT`` bits set.
5721 """
5722 return _gdi_.RendererNative_DrawComboBoxDropButton(*args, **kwargs)
5723
5724 def DrawDropArrow(*args, **kwargs):
5725 """
5726 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5727
5728 Draw a drop down arrow that is suitable for use outside a combo
5729 box. Arrow will have a transparent background.
5730
5731 ``rect`` is not entirely filled by the arrow. Instead, you should use
5732 bounding rectangle of a drop down button which arrow matches the size
5733 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5734 ``wx.CONTROL_CURRENT`` bit set.
5735 """
5736 return _gdi_.RendererNative_DrawDropArrow(*args, **kwargs)
5737
2131d850 5738 def DrawCheckBox(*args, **kwargs):
da91cb0f 5739 """
2131d850 5740 DrawCheckBox(self, Window win, DC dc, Rect rect, int flags=0)
da91cb0f
RD
5741
5742 Draw a check button. Flags may use wx.CONTROL_CHECKED,
5743 wx.CONTROL_UNDETERMINED and wx.CONTROL_CURRENT.
5744 """
2131d850
RD
5745 return _gdi_.RendererNative_DrawCheckBox(*args, **kwargs)
5746
5747 def DrawPushButton(*args, **kwargs):
5748 """
5749 DrawPushButton(self, Window win, DC dc, Rect rect, int flags=0)
5750
5751 Draw a blank button. Flags may be wx.CONTROL_PRESSED, wx.CONTROL_CURRENT and
5752 wx.CONTROL_ISDEFAULT
5753 """
5754 return _gdi_.RendererNative_DrawPushButton(*args, **kwargs)
5755
5756 def DrawItemSelectionRect(*args, **kwargs):
5757 """
5758 DrawItemSelectionRect(self, Window win, DC dc, Rect rect, int flags=0)
5759
5760 Draw rectangle indicating that an item in e.g. a list control has been
5761 selected or focused
5762
5763 The flags parameter may be:
5764
5765 ==================== ============================================
5766 wx.CONTROL_SELECTED item is selected, e.g. draw background
5767 wx.CONTROL_CURRENT item is the current item, e.g. dotted border
5768 wx.CONTROL_FOCUSED the whole control has focus, e.g. blue
5769 background vs. grey otherwise
5770 ==================== ============================================
5771
5772 """
5773 return _gdi_.RendererNative_DrawItemSelectionRect(*args, **kwargs)
da91cb0f 5774
be9b1dca
RD
5775 def GetSplitterParams(*args, **kwargs):
5776 """
5777 GetSplitterParams(self, Window win) -> SplitterRenderParams
5778
5779 Get the splitter parameters, see `wx.SplitterRenderParams`.
5780 """
5781 return _gdi_.RendererNative_GetSplitterParams(*args, **kwargs)
5782
5783 def Get(*args, **kwargs):
5784 """
5785 Get() -> RendererNative
5786
5787 Return the currently used renderer
5788 """
5789 return _gdi_.RendererNative_Get(*args, **kwargs)
5790
5791 Get = staticmethod(Get)
5792 def GetGeneric(*args, **kwargs):
5793 """
5794 GetGeneric() -> RendererNative
5795
5796 Return the generic implementation of the renderer. Under some
5797 platforms, this is the default renderer implementation, others have
5798 platform-specific default renderer which can be retrieved by calling
1d5ee749 5799 `wx.RendererNative.GetDefault`.
be9b1dca
RD
5800 """
5801 return _gdi_.RendererNative_GetGeneric(*args, **kwargs)
5802
5803 GetGeneric = staticmethod(GetGeneric)
5804 def GetDefault(*args, **kwargs):
5805 """
5806 GetDefault() -> RendererNative
5807
5808 Return the default (native) implementation for this platform -- this
1d5ee749
RD
5809 is also the one used by default but this may be changed by calling
5810 `wx.RendererNative.Set` in which case the return value of this method
5811 may be different from the return value of `wx.RendererNative.Get`.
be9b1dca
RD
5812 """
5813 return _gdi_.RendererNative_GetDefault(*args, **kwargs)
5814
5815 GetDefault = staticmethod(GetDefault)
5816 def Set(*args, **kwargs):
5817 """
5818 Set(RendererNative renderer) -> RendererNative
5819
5820 Set the renderer to use, passing None reverts to using the default
5821 renderer. Returns the previous renderer used with Set or None.
5822 """
5823 return _gdi_.RendererNative_Set(*args, **kwargs)
5824
5825 Set = staticmethod(Set)
5826 def GetVersion(*args, **kwargs):
5827 """
5828 GetVersion(self) -> RendererVersion
5829
5830 Returns the version of the renderer. Will be used for ensuring
5831 compatibility of dynamically loaded renderers.
5832 """
5833 return _gdi_.RendererNative_GetVersion(*args, **kwargs)
5834
33d6fd3b
RD
5835 SplitterParams = property(GetSplitterParams,doc="See `GetSplitterParams`")
5836 Version = property(GetVersion,doc="See `GetVersion`")
2131d850 5837_gdi_.RendererNative_swigregister(RendererNative)
be9b1dca 5838
1bd55598
RD
5839def RendererNative_Get(*args):
5840 """
be9b1dca
RD
5841 RendererNative_Get() -> RendererNative
5842
5843 Return the currently used renderer
5844 """
1bd55598 5845 return _gdi_.RendererNative_Get(*args)
be9b1dca 5846
1bd55598
RD
5847def RendererNative_GetGeneric(*args):
5848 """
be9b1dca
RD
5849 RendererNative_GetGeneric() -> RendererNative
5850
5851 Return the generic implementation of the renderer. Under some
5852 platforms, this is the default renderer implementation, others have
5853 platform-specific default renderer which can be retrieved by calling
1d5ee749 5854 `wx.RendererNative.GetDefault`.
be9b1dca 5855 """
1bd55598 5856 return _gdi_.RendererNative_GetGeneric(*args)
be9b1dca 5857
1bd55598
RD
5858def RendererNative_GetDefault(*args):
5859 """
be9b1dca
RD
5860 RendererNative_GetDefault() -> RendererNative
5861
5862 Return the default (native) implementation for this platform -- this
1d5ee749
RD
5863 is also the one used by default but this may be changed by calling
5864 `wx.RendererNative.Set` in which case the return value of this method
5865 may be different from the return value of `wx.RendererNative.Get`.
be9b1dca 5866 """
1bd55598 5867 return _gdi_.RendererNative_GetDefault(*args)
be9b1dca
RD
5868
5869def RendererNative_Set(*args, **kwargs):
1bd55598 5870 """
be9b1dca
RD
5871 RendererNative_Set(RendererNative renderer) -> RendererNative
5872
5873 Set the renderer to use, passing None reverts to using the default
5874 renderer. Returns the previous renderer used with Set or None.
5875 """
1bd55598 5876 return _gdi_.RendererNative_Set(*args, **kwargs)
be9b1dca 5877
27e45892
RD
5878#---------------------------------------------------------------------------
5879
5880class PseudoDC(_core.Object):
5881 """
5882 A PseudoDC is an object that can be used as if it were a `wx.DC`. All
5883 commands issued to the PseudoDC are stored in a list. You can then
5884 play these commands back to a real DC object using the DrawToDC
5885 method. Commands in the command list are indexed by ID. You can use
5886 this to clear the operations associated with a single ID and then
5887 re-draw the object associated with that ID.
5888 """
5889 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
5890 __repr__ = _swig_repr
5891 def __init__(self, *args, **kwargs):
5892 """
5893 __init__(self) -> PseudoDC
5894
5895 Constructs a new Pseudo device context for recording dc operations
5896 """
5897 _gdi_.PseudoDC_swiginit(self,_gdi_.new_PseudoDC(*args, **kwargs))
5898 def BeginDrawing(*args, **kwargs):
5899 """
5900 BeginDrawing(self)
5901
5902 Allows for optimization of drawing code on platforms that need it. On
5903 other platforms this is just an empty function and is harmless. To
5904 take advantage of this postential optimization simply enclose each
5905 group of calls to the drawing primitives within calls to
5906 `BeginDrawing` and `EndDrawing`.
5907 """
5908 return _gdi_.PseudoDC_BeginDrawing(*args, **kwargs)
5909
5910 def EndDrawing(*args, **kwargs):
5911 """
5912 EndDrawing(self)
5913
5914 Ends the group of drawing primitives started with `BeginDrawing`, and
5915 invokes whatever optimization is available for this DC type on the
5916 current platform.
5917 """
5918 return _gdi_.PseudoDC_EndDrawing(*args, **kwargs)
5919
5920 __swig_destroy__ = _gdi_.delete_PseudoDC
5921 __del__ = lambda self : None;
5922 def RemoveAll(*args, **kwargs):
5923 """
5924 RemoveAll(self)
5925
5926 Removes all objects and operations from the recorded list.
5927 """
5928 return _gdi_.PseudoDC_RemoveAll(*args, **kwargs)
5929
5930 def GetLen(*args, **kwargs):
5931 """
5932 GetLen(self) -> int
5933
5934 Returns the number of operations in the recorded list.
5935 """
5936 return _gdi_.PseudoDC_GetLen(*args, **kwargs)
5937
5938 def SetId(*args, **kwargs):
5939 """
5940 SetId(self, int id)
5941
5942 Sets the id to be associated with subsequent operations.
5943 """
5944 return _gdi_.PseudoDC_SetId(*args, **kwargs)
5945
5946 def ClearId(*args, **kwargs):
5947 """
5948 ClearId(self, int id)
5949
5950 Removes all operations associated with id so the object can be redrawn.
5951 """
5952 return _gdi_.PseudoDC_ClearId(*args, **kwargs)
5953
5954 def RemoveId(*args, **kwargs):
5955 """
5956 RemoveId(self, int id)
5957
5958 Remove the object node (and all operations) associated with an id.
5959 """
5960 return _gdi_.PseudoDC_RemoveId(*args, **kwargs)
5961
5962 def TranslateId(*args, **kwargs):
5963 """
5964 TranslateId(self, int id, int dx, int dy)
5965
5966 Translate the operations of id by dx,dy.
5967 """
5968 return _gdi_.PseudoDC_TranslateId(*args, **kwargs)
5969
72ef6efb
RD
5970 def SetIdGreyedOut(*args, **kwargs):
5971 """
5972 SetIdGreyedOut(self, int id, bool greyout=True)
5973
5974 Set whether an object is drawn greyed out or not.
5975 """
5976 return _gdi_.PseudoDC_SetIdGreyedOut(*args, **kwargs)
5977
5978 def GetIdGreyedOut(*args, **kwargs):
5979 """
5980 GetIdGreyedOut(self, int id) -> bool
5981
5982 Get whether an object is drawn greyed out or not.
5983 """
5984 return _gdi_.PseudoDC_GetIdGreyedOut(*args, **kwargs)
5985
5986 def FindObjects(*args, **kwargs):
5987 """
5988 FindObjects(self, int x, int y, int radius=1, wxColor bg=*wxWHITE) -> PyObject
5989
5990 Returns a list of all the id's that draw a pixel with color
5991 not equal to bg within radius of (x,y).
5992 Returns an empty list if nothing is found. The list is in
5993 reverse drawing order so list[0] is the top id.
5994 """
5995 return _gdi_.PseudoDC_FindObjects(*args, **kwargs)
5996
5997 def FindObjectsByBBox(*args, **kwargs):
5998 """
5999 FindObjectsByBBox(self, int x, int y) -> PyObject
6000
6001 Returns a list of all the id's whose bounding boxes include (x,y).
6002 Returns an empty list if nothing is found. The list is in
6003 reverse drawing order so list[0] is the top id.
6004 """
6005 return _gdi_.PseudoDC_FindObjectsByBBox(*args, **kwargs)
6006
27e45892
RD
6007 def DrawIdToDC(*args, **kwargs):
6008 """
6009 DrawIdToDC(self, int id, DC dc)
6010
6011 Draw recorded operations of id to dc.
6012 """
6013 return _gdi_.PseudoDC_DrawIdToDC(*args, **kwargs)
6014
6015 def SetIdBounds(*args, **kwargs):
6016 """
6017 SetIdBounds(self, int id, Rect rect)
6018
6019 Set the bounding rect of a given object. This will create
6020 an object node if one doesn't exist.
6021 """
6022 return _gdi_.PseudoDC_SetIdBounds(*args, **kwargs)
6023
6024 def GetIdBounds(*args, **kwargs):
6025 """
6026 GetIdBounds(self, int id) -> Rect
6027
6028 Returns the bounding rectangle previouly set with SetIdBounds. If
6029 no bounds have been set, it returns wx.Rect(0,0,0,0).
6030 """
6031 return _gdi_.PseudoDC_GetIdBounds(*args, **kwargs)
6032
6033 def DrawToDCClipped(*args, **kwargs):
6034 """
6035 DrawToDCClipped(self, DC dc, Rect rect)
6036
6037 Draws the recorded operations to dc unless the operation is known to
6038 be outside rect.
6039 """
6040 return _gdi_.PseudoDC_DrawToDCClipped(*args, **kwargs)
6041
6042 def DrawToDCClippedRgn(*args, **kwargs):
6043 """
6044 DrawToDCClippedRgn(self, DC dc, Region region)
6045
6046 Draws the recorded operations to dc unless the operation is known to
6047 be outside rect.
6048 """
6049 return _gdi_.PseudoDC_DrawToDCClippedRgn(*args, **kwargs)
6050
6051 def DrawToDC(*args, **kwargs):
6052 """
6053 DrawToDC(self, DC dc)
6054
6055 Draws the recorded operations to dc.
6056 """
6057 return _gdi_.PseudoDC_DrawToDC(*args, **kwargs)
6058
6059 def FloodFill(*args, **kwargs):
6060 """
6061 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE)
6062
6063 Flood fills the device context starting from the given point, using
6064 the current brush colour, and using a style:
6065
6066 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
6067 the given colour is encountered.
6068
6069 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
6070 colour.
6071
6072 Returns False if the operation failed.
6073
6074 Note: The present implementation for non-Windows platforms may fail to
6075 find colour borders if the pixels do not match the colour
6076 exactly. However the function will still return true.
6077 """
6078 return _gdi_.PseudoDC_FloodFill(*args, **kwargs)
6079
6080 def FloodFillPoint(*args, **kwargs):
6081 """
6082 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE)
6083
6084 Flood fills the device context starting from the given point, using
6085 the current brush colour, and using a style:
6086
6087 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
6088 the given colour is encountered.
6089
6090 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
6091 colour.
6092
6093 Returns False if the operation failed.
6094
6095 Note: The present implementation for non-Windows platforms may fail to
6096 find colour borders if the pixels do not match the colour
6097 exactly. However the function will still return true.
6098 """
6099 return _gdi_.PseudoDC_FloodFillPoint(*args, **kwargs)
6100
6101 def DrawLine(*args, **kwargs):
6102 """
6103 DrawLine(self, int x1, int y1, int x2, int y2)
6104
6105 Draws a line from the first point to the second. The current pen is
6106 used for drawing the line. Note that the second point is *not* part of
6107 the line and is not drawn by this function (this is consistent with
6108 the behaviour of many other toolkits).
6109 """
6110 return _gdi_.PseudoDC_DrawLine(*args, **kwargs)
6111
6112 def DrawLinePoint(*args, **kwargs):
6113 """
6114 DrawLinePoint(self, Point pt1, Point pt2)
6115
6116 Draws a line from the first point to the second. The current pen is
6117 used for drawing the line. Note that the second point is *not* part of
6118 the line and is not drawn by this function (this is consistent with
6119 the behaviour of many other toolkits).
6120 """
6121 return _gdi_.PseudoDC_DrawLinePoint(*args, **kwargs)
6122
6123 def CrossHair(*args, **kwargs):
6124 """
6125 CrossHair(self, int x, int y)
6126
6127 Displays a cross hair using the current pen. This is a vertical and
6128 horizontal line the height and width of the window, centred on the
6129 given point.
6130 """
6131 return _gdi_.PseudoDC_CrossHair(*args, **kwargs)
6132
6133 def CrossHairPoint(*args, **kwargs):
6134 """
6135 CrossHairPoint(self, Point pt)
6136
6137 Displays a cross hair using the current pen. This is a vertical and
6138 horizontal line the height and width of the window, centred on the
6139 given point.
6140 """
6141 return _gdi_.PseudoDC_CrossHairPoint(*args, **kwargs)
6142
6143 def DrawArc(*args, **kwargs):
6144 """
6145 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
6146
6147 Draws an arc of a circle, centred on the *center* point (xc, yc), from
6148 the first point to the second. The current pen is used for the outline
6149 and the current brush for filling the shape.
6150
6151 The arc is drawn in an anticlockwise direction from the start point to
6152 the end point.
6153 """
6154 return _gdi_.PseudoDC_DrawArc(*args, **kwargs)
6155
6156 def DrawArcPoint(*args, **kwargs):
6157 """
6158 DrawArcPoint(self, Point pt1, Point pt2, Point center)
6159
6160 Draws an arc of a circle, centred on the *center* point (xc, yc), from
6161 the first point to the second. The current pen is used for the outline
6162 and the current brush for filling the shape.
6163
6164 The arc is drawn in an anticlockwise direction from the start point to
6165 the end point.
6166 """
6167 return _gdi_.PseudoDC_DrawArcPoint(*args, **kwargs)
6168
6169 def DrawCheckMark(*args, **kwargs):
6170 """
6171 DrawCheckMark(self, int x, int y, int width, int height)
6172
6173 Draws a check mark inside the given rectangle.
6174 """
6175 return _gdi_.PseudoDC_DrawCheckMark(*args, **kwargs)
6176
6177 def DrawCheckMarkRect(*args, **kwargs):
6178 """
6179 DrawCheckMarkRect(self, Rect rect)
6180
6181 Draws a check mark inside the given rectangle.
6182 """
6183 return _gdi_.PseudoDC_DrawCheckMarkRect(*args, **kwargs)
6184
6185 def DrawEllipticArc(*args, **kwargs):
6186 """
6187 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
6188
6189 Draws an arc of an ellipse, with the given rectangle defining the
6190 bounds of the ellipse. The current pen is used for drawing the arc and
6191 the current brush is used for drawing the pie.
6192
6193 The *start* and *end* parameters specify the start and end of the arc
6194 relative to the three-o'clock position from the center of the
6195 rectangle. Angles are specified in degrees (360 is a complete
6196 circle). Positive values mean counter-clockwise motion. If start is
6197 equal to end, a complete ellipse will be drawn.
6198 """
6199 return _gdi_.PseudoDC_DrawEllipticArc(*args, **kwargs)
6200
6201 def DrawEllipticArcPointSize(*args, **kwargs):
6202 """
6203 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
6204
6205 Draws an arc of an ellipse, with the given rectangle defining the
6206 bounds of the ellipse. The current pen is used for drawing the arc and
6207 the current brush is used for drawing the pie.
6208
6209 The *start* and *end* parameters specify the start and end of the arc
6210 relative to the three-o'clock position from the center of the
6211 rectangle. Angles are specified in degrees (360 is a complete
6212 circle). Positive values mean counter-clockwise motion. If start is
6213 equal to end, a complete ellipse will be drawn.
6214 """
6215 return _gdi_.PseudoDC_DrawEllipticArcPointSize(*args, **kwargs)
6216
6217 def DrawPoint(*args, **kwargs):
6218 """
6219 DrawPoint(self, int x, int y)
6220
6221 Draws a point using the current pen.
6222 """
6223 return _gdi_.PseudoDC_DrawPoint(*args, **kwargs)
6224
6225 def DrawPointPoint(*args, **kwargs):
6226 """
6227 DrawPointPoint(self, Point pt)
6228
6229 Draws a point using the current pen.
6230 """
6231 return _gdi_.PseudoDC_DrawPointPoint(*args, **kwargs)
6232
6233 def DrawRectangle(*args, **kwargs):
6234 """
6235 DrawRectangle(self, int x, int y, int width, int height)
6236
6237 Draws a rectangle with the given top left corner, and with the given
6238 size. The current pen is used for the outline and the current brush
6239 for filling the shape.
6240 """
6241 return _gdi_.PseudoDC_DrawRectangle(*args, **kwargs)
6242
6243 def DrawRectangleRect(*args, **kwargs):
6244 """
6245 DrawRectangleRect(self, Rect rect)
6246
6247 Draws a rectangle with the given top left corner, and with the given
6248 size. The current pen is used for the outline and the current brush
6249 for filling the shape.
6250 """
6251 return _gdi_.PseudoDC_DrawRectangleRect(*args, **kwargs)
6252
6253 def DrawRectanglePointSize(*args, **kwargs):
6254 """
6255 DrawRectanglePointSize(self, Point pt, Size sz)
6256
6257 Draws a rectangle with the given top left corner, and with the given
6258 size. The current pen is used for the outline and the current brush
6259 for filling the shape.
6260 """
6261 return _gdi_.PseudoDC_DrawRectanglePointSize(*args, **kwargs)
6262
6263 def DrawRoundedRectangle(*args, **kwargs):
6264 """
6265 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
6266
6267 Draws a rectangle with the given top left corner, and with the given
6268 size. The corners are quarter-circles using the given radius. The
6269 current pen is used for the outline and the current brush for filling
6270 the shape.
6271
6272 If radius is positive, the value is assumed to be the radius of the
6273 rounded corner. If radius is negative, the absolute value is assumed
6274 to be the proportion of the smallest dimension of the rectangle. This
6275 means that the corner can be a sensible size relative to the size of
6276 the rectangle, and also avoids the strange effects X produces when the
6277 corners are too big for the rectangle.
6278 """
6279 return _gdi_.PseudoDC_DrawRoundedRectangle(*args, **kwargs)
6280
6281 def DrawRoundedRectangleRect(*args, **kwargs):
6282 """
6283 DrawRoundedRectangleRect(self, Rect r, double radius)
6284
6285 Draws a rectangle with the given top left corner, and with the given
6286 size. The corners are quarter-circles using the given radius. The
6287 current pen is used for the outline and the current brush for filling
6288 the shape.
6289
6290 If radius is positive, the value is assumed to be the radius of the
6291 rounded corner. If radius is negative, the absolute value is assumed
6292 to be the proportion of the smallest dimension of the rectangle. This
6293 means that the corner can be a sensible size relative to the size of
6294 the rectangle, and also avoids the strange effects X produces when the
6295 corners are too big for the rectangle.
6296 """
6297 return _gdi_.PseudoDC_DrawRoundedRectangleRect(*args, **kwargs)
6298
6299 def DrawRoundedRectanglePointSize(*args, **kwargs):
6300 """
6301 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
6302
6303 Draws a rectangle with the given top left corner, and with the given
6304 size. The corners are quarter-circles using the given radius. The
6305 current pen is used for the outline and the current brush for filling
6306 the shape.
6307
6308 If radius is positive, the value is assumed to be the radius of the
6309 rounded corner. If radius is negative, the absolute value is assumed
6310 to be the proportion of the smallest dimension of the rectangle. This
6311 means that the corner can be a sensible size relative to the size of
6312 the rectangle, and also avoids the strange effects X produces when the
6313 corners are too big for the rectangle.
6314 """
6315 return _gdi_.PseudoDC_DrawRoundedRectanglePointSize(*args, **kwargs)
6316
6317 def DrawCircle(*args, **kwargs):
6318 """
6319 DrawCircle(self, int x, int y, int radius)
6320
6321 Draws a circle with the given center point and radius. The current
6322 pen is used for the outline and the current brush for filling the
6323 shape.
6324 """
6325 return _gdi_.PseudoDC_DrawCircle(*args, **kwargs)
6326
6327 def DrawCirclePoint(*args, **kwargs):
6328 """
6329 DrawCirclePoint(self, Point pt, int radius)
6330
6331 Draws a circle with the given center point and radius. The current
6332 pen is used for the outline and the current brush for filling the
6333 shape.
6334 """
6335 return _gdi_.PseudoDC_DrawCirclePoint(*args, **kwargs)
6336
6337 def DrawEllipse(*args, **kwargs):
6338 """
6339 DrawEllipse(self, int x, int y, int width, int height)
6340
6341 Draws an ellipse contained in the specified rectangle. The current pen
6342 is used for the outline and the current brush for filling the shape.
6343 """
6344 return _gdi_.PseudoDC_DrawEllipse(*args, **kwargs)
6345
6346 def DrawEllipseRect(*args, **kwargs):
6347 """
6348 DrawEllipseRect(self, Rect rect)
6349
6350 Draws an ellipse contained in the specified rectangle. The current pen
6351 is used for the outline and the current brush for filling the shape.
6352 """
6353 return _gdi_.PseudoDC_DrawEllipseRect(*args, **kwargs)
6354
6355 def DrawEllipsePointSize(*args, **kwargs):
6356 """
6357 DrawEllipsePointSize(self, Point pt, Size sz)
6358
6359 Draws an ellipse contained in the specified rectangle. The current pen
6360 is used for the outline and the current brush for filling the shape.
6361 """
6362 return _gdi_.PseudoDC_DrawEllipsePointSize(*args, **kwargs)
6363
6364 def DrawIcon(*args, **kwargs):
6365 """
6366 DrawIcon(self, Icon icon, int x, int y)
6367
6368 Draw an icon on the display (does nothing if the device context is
6369 PostScript). This can be the simplest way of drawing bitmaps on a
6370 window.
6371 """
6372 return _gdi_.PseudoDC_DrawIcon(*args, **kwargs)
6373
6374 def DrawIconPoint(*args, **kwargs):
6375 """
6376 DrawIconPoint(self, Icon icon, Point pt)
6377
6378 Draw an icon on the display (does nothing if the device context is
6379 PostScript). This can be the simplest way of drawing bitmaps on a
6380 window.
6381 """
6382 return _gdi_.PseudoDC_DrawIconPoint(*args, **kwargs)
6383
6384 def DrawBitmap(*args, **kwargs):
6385 """
6386 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
6387
6388 Draw a bitmap on the device context at the specified point. If
6389 *transparent* is true and the bitmap has a transparency mask, (or
6390 alpha channel on the platforms that support it) then the bitmap will
6391 be drawn transparently.
6392 """
6393 return _gdi_.PseudoDC_DrawBitmap(*args, **kwargs)
6394
6395 def DrawBitmapPoint(*args, **kwargs):
6396 """
6397 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
6398
6399 Draw a bitmap on the device context at the specified point. If
6400 *transparent* is true and the bitmap has a transparency mask, (or
6401 alpha channel on the platforms that support it) then the bitmap will
6402 be drawn transparently.
6403 """
6404 return _gdi_.PseudoDC_DrawBitmapPoint(*args, **kwargs)
6405
6406 def DrawText(*args, **kwargs):
6407 """
6408 DrawText(self, String text, int x, int y)
6409
6410 Draws a text string at the specified point, using the current text
6411 font, and the current text foreground and background colours.
6412
6413 The coordinates refer to the top-left corner of the rectangle bounding
1d5ee749
RD
6414 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6415 a text string, which can be used to position the text more precisely,
6416 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6417 not implement it.)
27e45892
RD
6418
6419 **NOTE**: under wxGTK the current logical function is used by this
6420 function but it is ignored by wxMSW. Thus, you should avoid using
6421 logical functions with this function in portable programs.
6422 """
6423 return _gdi_.PseudoDC_DrawText(*args, **kwargs)
6424
6425 def DrawTextPoint(*args, **kwargs):
6426 """
6427 DrawTextPoint(self, String text, Point pt)
6428
6429 Draws a text string at the specified point, using the current text
6430 font, and the current text foreground and background colours.
6431
6432 The coordinates refer to the top-left corner of the rectangle bounding
1d5ee749
RD
6433 the string. See `wx.DC.GetTextExtent` for how to get the dimensions of
6434 a text string, which can be used to position the text more precisely,
6435 (you will need to use a real DC with GetTextExtent as wx.PseudoDC does
6436 not implement it.)
27e45892
RD
6437
6438 **NOTE**: under wxGTK the current logical function is used by this
6439 function but it is ignored by wxMSW. Thus, you should avoid using
6440 logical functions with this function in portable programs.
6441 """
6442 return _gdi_.PseudoDC_DrawTextPoint(*args, **kwargs)
6443
6444 def DrawRotatedText(*args, **kwargs):
6445 """
6446 DrawRotatedText(self, String text, int x, int y, double angle)
6447
6448 Draws the text rotated by *angle* degrees, if supported by the platform.
6449
6450 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6451 function. In particular, a font different from ``wx.NORMAL_FONT``
6452 should be used as the it is not normally a TrueType
6453 font. ``wx.SWISS_FONT`` is an example of a font which is.
6454 """
6455 return _gdi_.PseudoDC_DrawRotatedText(*args, **kwargs)
6456
6457 def DrawRotatedTextPoint(*args, **kwargs):
6458 """
6459 DrawRotatedTextPoint(self, String text, Point pt, double angle)
6460
6461 Draws the text rotated by *angle* degrees, if supported by the platform.
6462
6463 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
6464 function. In particular, a font different from ``wx.NORMAL_FONT``
6465 should be used as the it is not normally a TrueType
6466 font. ``wx.SWISS_FONT`` is an example of a font which is.
6467 """
6468 return _gdi_.PseudoDC_DrawRotatedTextPoint(*args, **kwargs)
6469
6470 def DrawLines(*args, **kwargs):
6471 """
6472 DrawLines(self, List points, int xoffset=0, int yoffset=0)
6473
6474 Draws lines using a sequence of `wx.Point` objects, adding the
6475 optional offset coordinate. The current pen is used for drawing the
6476 lines.
6477 """
6478 return _gdi_.PseudoDC_DrawLines(*args, **kwargs)
6479
6480 def DrawPolygon(*args, **kwargs):
6481 """
6482 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
6483 int fillStyle=ODDEVEN_RULE)
6484
6485 Draws a filled polygon using a sequence of `wx.Point` objects, adding
6486 the optional offset coordinate. The last argument specifies the fill
6487 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
6488
6489 The current pen is used for drawing the outline, and the current brush
6490 for filling the shape. Using a transparent brush suppresses
6491 filling. Note that wxWidgets automatically closes the first and last
6492 points.
6493 """
6494 return _gdi_.PseudoDC_DrawPolygon(*args, **kwargs)
6495
6496 def DrawLabel(*args, **kwargs):
6497 """
6498 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6499 int indexAccel=-1)
6500
6501 Draw *text* within the specified rectangle, abiding by the alignment
6502 flags. Will additionally emphasize the character at *indexAccel* if
6503 it is not -1.
6504 """
6505 return _gdi_.PseudoDC_DrawLabel(*args, **kwargs)
6506
6507 def DrawImageLabel(*args, **kwargs):
6508 """
6509 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
6510 int indexAccel=-1)
6511
6512 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
6513 drawing it) within the specified rectangle, abiding by the alignment
6514 flags. Will additionally emphasize the character at *indexAccel* if
6515 it is not -1.
6516 """
6517 return _gdi_.PseudoDC_DrawImageLabel(*args, **kwargs)
6518
6519 def DrawSpline(*args, **kwargs):
6520 """
6521 DrawSpline(self, List points)
6522
6523 Draws a spline between all given control points, (a list of `wx.Point`
6524 objects) using the current pen. The spline is drawn using a series of
6525 lines, using an algorithm taken from the X drawing program 'XFIG'.
6526 """
6527 return _gdi_.PseudoDC_DrawSpline(*args, **kwargs)
6528
6529 def Clear(*args, **kwargs):
6530 """
6531 Clear(self)
6532
6533 Clears the device context using the current background brush.
6534 """
6535 return _gdi_.PseudoDC_Clear(*args, **kwargs)
6536
6537 def SetFont(*args, **kwargs):
6538 """
6539 SetFont(self, Font font)
6540
6541 Sets the current font for the DC. It must be a valid font, in
6542 particular you should not pass ``wx.NullFont`` to this method.
6543 """
6544 return _gdi_.PseudoDC_SetFont(*args, **kwargs)
6545
6546 def SetPen(*args, **kwargs):
6547 """
6548 SetPen(self, Pen pen)
6549
6550 Sets the current pen for the DC.
6551
6552 If the argument is ``wx.NullPen``, the current pen is selected out of the
6553 device context, and the original pen restored.
6554 """
6555 return _gdi_.PseudoDC_SetPen(*args, **kwargs)
6556
6557 def SetBrush(*args, **kwargs):
6558 """
6559 SetBrush(self, Brush brush)
6560
6561 Sets the current brush for the DC.
6562
6563 If the argument is ``wx.NullBrush``, the current brush is selected out
6564 of the device context, and the original brush restored, allowing the
6565 current brush to be destroyed safely.
6566 """
6567 return _gdi_.PseudoDC_SetBrush(*args, **kwargs)
6568
6569 def SetBackground(*args, **kwargs):
6570 """
6571 SetBackground(self, Brush brush)
6572
6573 Sets the current background brush for the DC.
6574 """
6575 return _gdi_.PseudoDC_SetBackground(*args, **kwargs)
6576
6577 def SetBackgroundMode(*args, **kwargs):
6578 """
6579 SetBackgroundMode(self, int mode)
6580
6581 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
6582 determines whether text will be drawn with a background colour or
6583 not.
6584 """
6585 return _gdi_.PseudoDC_SetBackgroundMode(*args, **kwargs)
6586
6587 def SetPalette(*args, **kwargs):
6588 """
6589 SetPalette(self, Palette palette)
6590
6591 If this is a window DC or memory DC, assigns the given palette to the
6592 window or bitmap associated with the DC. If the argument is
6593 ``wx.NullPalette``, the current palette is selected out of the device
6594 context, and the original palette restored.
6595 """
6596 return _gdi_.PseudoDC_SetPalette(*args, **kwargs)
6597
6598 def SetTextForeground(*args, **kwargs):
6599 """
6600 SetTextForeground(self, Colour colour)
6601
6602 Sets the current text foreground colour for the DC.
6603 """
6604 return _gdi_.PseudoDC_SetTextForeground(*args, **kwargs)
6605
6606 def SetTextBackground(*args, **kwargs):
6607 """
6608 SetTextBackground(self, Colour colour)
6609
6610 Sets the current text background colour for the DC.
6611 """
6612 return _gdi_.PseudoDC_SetTextBackground(*args, **kwargs)
6613
6614 def SetLogicalFunction(*args, **kwargs):
6615 """
6616 SetLogicalFunction(self, int function)
6617
6618 Sets the current logical function for the device context. This
1d5ee749
RD
6619 determines how a source pixel (from a pen or brush colour, combines
6620 with a destination pixel in the current device context.
27e45892
RD
6621
6622 The possible values and their meaning in terms of source and
6623 destination pixel values are as follows:
6624
6625 ================ ==========================
6626 wx.AND src AND dst
6627 wx.AND_INVERT (NOT src) AND dst
6628 wx.AND_REVERSE src AND (NOT dst)
6629 wx.CLEAR 0
6630 wx.COPY src
6631 wx.EQUIV (NOT src) XOR dst
6632 wx.INVERT NOT dst
6633 wx.NAND (NOT src) OR (NOT dst)
6634 wx.NOR (NOT src) AND (NOT dst)
6635 wx.NO_OP dst
6636 wx.OR src OR dst
6637 wx.OR_INVERT (NOT src) OR dst
6638 wx.OR_REVERSE src OR (NOT dst)
6639 wx.SET 1
6640 wx.SRC_INVERT NOT src
6641 wx.XOR src XOR dst
6642 ================ ==========================
6643
6644 The default is wx.COPY, which simply draws with the current
6645 colour. The others combine the current colour and the background using
6646 a logical operation. wx.INVERT is commonly used for drawing rubber
6647 bands or moving outlines, since drawing twice reverts to the original
6648 colour.
6649
6650 """
6651 return _gdi_.PseudoDC_SetLogicalFunction(*args, **kwargs)
6652
33d6fd3b
RD
6653 IdBounds = property(GetIdBounds,SetIdBounds,doc="See `GetIdBounds` and `SetIdBounds`")
6654 Len = property(GetLen,doc="See `GetLen`")
27e45892
RD
6655_gdi_.PseudoDC_swigregister(PseudoDC)
6656
d55e5bfc 6657
32fe5131 6658