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