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