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