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