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