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