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