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