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