]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/gtk/_gdi.py
Applied patch [ 1378183 ] Mac: wxNotebook::HitTest off by one
[wxWidgets.git] / wxPython / src / gtk / _gdi.py
CommitLineData
70551f47 1# This file was created automatically by SWIG.
d14a1e28 2# Don't modify this file, modify the SWIG interface instead.
70551f47 3
54f9ee45 4import _gdi_
a323d3bd 5
093d3ff1
RD
6def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
7 if (name == "this"):
8 if isinstance(value, class_type):
9 self.__dict__[name] = value.this
10 if hasattr(value,"thisown"): self.__dict__["thisown"] = value.thisown
11 del value.thisown
12 return
13 method = class_type.__swig_setmethods__.get(name,None)
14 if method: return method(self,value)
15 if (not static) or hasattr(self,name) or (name == "thisown"):
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):
24 method = class_type.__swig_getmethods__.get(name,None)
25 if method: return method(self)
26 raise AttributeError,name
27
28import types
29try:
30 _object = types.ObjectType
31 _newclass = 1
32except AttributeError:
33 class _object : pass
34 _newclass = 0
35del types
36
37
38def _swig_setattr_nondynamic_method(set):
39 def set_attr(self,name,value):
40 if hasattr(self,name) or (name in ("this", "thisown")):
41 set(self,name,value)
42 else:
43 raise AttributeError("You cannot add attributes to %s" % self)
44 return set_attr
45
46
54f9ee45
RD
47import _core
48wx = _core
d14a1e28
RD
49#---------------------------------------------------------------------------
50
54f9ee45 51class GDIObject(_core.Object):
093d3ff1 52 """Proxy of C++ GDIObject class"""
e811c8ce
RD
53 def __repr__(self):
54 return "<%s.%s; proxy of C++ wxGDIObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 55 def __init__(self, *args, **kwargs):
a95a7133 56 """__init__(self) -> GDIObject"""
54f9ee45 57 newobj = _gdi_.new_GDIObject(*args, **kwargs)
d14a1e28 58 self.this = newobj.this
9df61a29 59 self.thisown = 1
d14a1e28 60 del newobj.thisown
54f9ee45 61 def __del__(self, destroy=_gdi_.delete_GDIObject):
a95a7133 62 """__del__(self)"""
d14a1e28
RD
63 try:
64 if self.thisown: destroy(self)
65 except: pass
e811c8ce
RD
66
67 def GetVisible(*args, **kwargs):
a95a7133 68 """GetVisible(self) -> bool"""
54f9ee45 69 return _gdi_.GDIObject_GetVisible(*args, **kwargs)
e811c8ce
RD
70
71 def SetVisible(*args, **kwargs):
a95a7133 72 """SetVisible(self, bool visible)"""
54f9ee45 73 return _gdi_.GDIObject_SetVisible(*args, **kwargs)
e811c8ce
RD
74
75 def IsNull(*args, **kwargs):
a95a7133 76 """IsNull(self) -> bool"""
54f9ee45 77 return _gdi_.GDIObject_IsNull(*args, **kwargs)
e811c8ce 78
9df61a29 79
d14a1e28
RD
80class GDIObjectPtr(GDIObject):
81 def __init__(self, this):
82 self.this = this
83 if not hasattr(self,"thisown"): self.thisown = 0
84 self.__class__ = GDIObject
54f9ee45 85_gdi_.GDIObject_swigregister(GDIObjectPtr)
9df61a29 86
d14a1e28
RD
87#---------------------------------------------------------------------------
88
54f9ee45 89class Colour(_core.Object):
b88bce5f 90 """
41e2b43e
RD
91 A colour is an object representing a combination of Red, Green, and
92 Blue (RGB) intensity values, and is used to determine drawing colours,
93 window colours, etc. Valid RGB values are in the range 0 to 255.
b88bce5f 94
41e2b43e
RD
95 In wxPython there are typemaps that will automatically convert from a
96 colour name, or from a '#RRGGBB' colour hex value string to a
97 wx.Colour object when calling C++ methods that expect a wxColour.
98 This means that the following are all equivallent::
b88bce5f
RD
99
100 win.SetBackgroundColour(wxColour(0,0,255))
b2df227b
RD
101 win.SetBackgroundColour('BLUE')
102 win.SetBackgroundColour('#0000FF')
b88bce5f 103
41e2b43e
RD
104 Additional colour names and their coresponding values can be added
105 using `wx.ColourDatabase`. Various system colours (as set in the
106 user's system preferences) can be retrieved with
107 `wx.SystemSettings.GetColour`.
108
b88bce5f 109 """
e811c8ce
RD
110 def __repr__(self):
111 return "<%s.%s; proxy of C++ wxColour instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 112 def __init__(self, *args, **kwargs):
b88bce5f 113 """
41e2b43e 114 __init__(self, byte red=0, byte green=0, byte blue=0) -> Colour
b88bce5f
RD
115
116 Constructs a colour from red, green and blue values.
41e2b43e
RD
117
118 :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
119
b88bce5f 120 """
54f9ee45 121 newobj = _gdi_.new_Colour(*args, **kwargs)
d14a1e28
RD
122 self.this = newobj.this
123 self.thisown = 1
124 del newobj.thisown
54f9ee45 125 def __del__(self, destroy=_gdi_.delete_Colour):
a95a7133 126 """__del__(self)"""
d14a1e28
RD
127 try:
128 if self.thisown: destroy(self)
129 except: pass
e811c8ce
RD
130
131 def Red(*args, **kwargs):
b88bce5f 132 """
41e2b43e 133 Red(self) -> byte
b88bce5f
RD
134
135 Returns the red intensity.
136 """
54f9ee45 137 return _gdi_.Colour_Red(*args, **kwargs)
e811c8ce
RD
138
139 def Green(*args, **kwargs):
b88bce5f 140 """
41e2b43e 141 Green(self) -> byte
b88bce5f
RD
142
143 Returns the green intensity.
144 """
54f9ee45 145 return _gdi_.Colour_Green(*args, **kwargs)
e811c8ce
RD
146
147 def Blue(*args, **kwargs):
b88bce5f 148 """
41e2b43e 149 Blue(self) -> byte
b88bce5f
RD
150
151 Returns the blue intensity.
152 """
54f9ee45 153 return _gdi_.Colour_Blue(*args, **kwargs)
e811c8ce
RD
154
155 def Ok(*args, **kwargs):
b88bce5f 156 """
a95a7133 157 Ok(self) -> bool
b88bce5f
RD
158
159 Returns True if the colour object is valid (the colour has been
160 initialised with RGB values).
161 """
54f9ee45 162 return _gdi_.Colour_Ok(*args, **kwargs)
e811c8ce
RD
163
164 def Set(*args, **kwargs):
b88bce5f 165 """
41e2b43e 166 Set(self, byte red, byte green, byte blue)
b88bce5f
RD
167
168 Sets the RGB intensity values.
169 """
54f9ee45 170 return _gdi_.Colour_Set(*args, **kwargs)
e811c8ce 171
c9c7117a 172 def SetRGB(*args, **kwargs):
b88bce5f 173 """
a95a7133 174 SetRGB(self, unsigned long colRGB)
b88bce5f
RD
175
176 Sets the RGB intensity values from a packed RGB value.
177 """
54f9ee45 178 return _gdi_.Colour_SetRGB(*args, **kwargs)
e811c8ce 179
b88bce5f
RD
180 def SetFromName(*args, **kwargs):
181 """
a95a7133 182 SetFromName(self, String colourName)
b88bce5f 183
41e2b43e
RD
184 Sets the RGB intensity values using a colour name listed in
185 ``wx.TheColourDatabase``.
b88bce5f 186 """
54f9ee45 187 return _gdi_.Colour_SetFromName(*args, **kwargs)
b88bce5f
RD
188
189 def GetPixel(*args, **kwargs):
190 """
a95a7133 191 GetPixel(self) -> long
b88bce5f
RD
192
193 Returns a pixel value which is platform-dependent. On Windows, a
41e2b43e
RD
194 COLORREF is returned. On X, an allocated pixel value is returned. -1
195 is returned if the pixel is invalid (on X, unallocated).
b88bce5f 196 """
54f9ee45 197 return _gdi_.Colour_GetPixel(*args, **kwargs)
b88bce5f 198
e811c8ce 199 def __eq__(*args, **kwargs):
b88bce5f 200 """
a95a7133 201 __eq__(self, Colour colour) -> bool
b88bce5f
RD
202
203 Compare colours for equality
204 """
54f9ee45 205 return _gdi_.Colour___eq__(*args, **kwargs)
e811c8ce
RD
206
207 def __ne__(*args, **kwargs):
b88bce5f 208 """
a95a7133 209 __ne__(self, Colour colour) -> bool
e811c8ce 210
b88bce5f
RD
211 Compare colours for inequality
212 """
54f9ee45 213 return _gdi_.Colour___ne__(*args, **kwargs)
c9c7117a 214
e811c8ce 215 def Get(*args, **kwargs):
b88bce5f
RD
216 """
217 Get() -> (r, g, b)
218
219 Returns the RGB intensity values as a tuple.
220 """
54f9ee45 221 return _gdi_.Colour_Get(*args, **kwargs)
e811c8ce 222
b88bce5f
RD
223 def GetRGB(*args, **kwargs):
224 """
a95a7133 225 GetRGB(self) -> unsigned long
b88bce5f
RD
226
227 Return the colour as a packed RGB value
228 """
54f9ee45 229 return _gdi_.Colour_GetRGB(*args, **kwargs)
b88bce5f 230
41e2b43e
RD
231 asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
232 def __str__(self): return str(self.Get())
233 def __repr__(self): return 'wx.Colour' + str(self.Get())
d14a1e28 234 def __nonzero__(self): return self.Ok()
74e96f3d
RD
235 __safe_for_unpickling__ = True
236 def __reduce__(self): return (Colour, self.Get())
9df61a29
RD
237
238
d14a1e28
RD
239class ColourPtr(Colour):
240 def __init__(self, this):
70551f47 241 self.this = this
d14a1e28
RD
242 if not hasattr(self,"thisown"): self.thisown = 0
243 self.__class__ = Colour
54f9ee45 244_gdi_.Colour_swigregister(ColourPtr)
70551f47 245
d14a1e28 246def NamedColour(*args, **kwargs):
b88bce5f
RD
247 """
248 NamedColour(String colorName) -> Colour
249
41e2b43e
RD
250 Constructs a colour object using a colour name listed in
251 ``wx.TheColourDatabase``.
b88bce5f 252 """
54f9ee45 253 val = _gdi_.new_NamedColour(*args, **kwargs)
d14a1e28
RD
254 val.thisown = 1
255 return val
70551f47 256
d14a1e28 257def ColourRGB(*args, **kwargs):
b88bce5f
RD
258 """
259 ColourRGB(unsigned long colRGB) -> Colour
260
261 Constructs a colour from a packed RGB value.
262 """
54f9ee45 263 val = _gdi_.new_ColourRGB(*args, **kwargs)
d14a1e28
RD
264 val.thisown = 1
265 return val
70551f47 266
994141e6
RD
267Color = Colour
268NamedColor = NamedColour
269ColorRGB = ColourRGB
270
d14a1e28 271class Palette(GDIObject):
093d3ff1 272 """Proxy of C++ Palette class"""
e811c8ce
RD
273 def __repr__(self):
274 return "<%s.%s; proxy of C++ wxPalette instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 275 def __init__(self, *args, **kwargs):
a95a7133 276 """__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette"""
54f9ee45 277 newobj = _gdi_.new_Palette(*args, **kwargs)
d14a1e28
RD
278 self.this = newobj.this
279 self.thisown = 1
280 del newobj.thisown
54f9ee45 281 def __del__(self, destroy=_gdi_.delete_Palette):
a95a7133 282 """__del__(self)"""
d14a1e28
RD
283 try:
284 if self.thisown: destroy(self)
285 except: pass
e811c8ce
RD
286
287 def GetPixel(*args, **kwargs):
a95a7133 288 """GetPixel(self, byte red, byte green, byte blue) -> int"""
54f9ee45 289 return _gdi_.Palette_GetPixel(*args, **kwargs)
e811c8ce
RD
290
291 def GetRGB(*args, **kwargs):
d3b6e4ff 292 """GetRGB(self, int pixel) -> (R,G,B)"""
54f9ee45 293 return _gdi_.Palette_GetRGB(*args, **kwargs)
e811c8ce 294
5cbf236d
RD
295 def GetColoursCount(*args, **kwargs):
296 """GetColoursCount(self) -> int"""
297 return _gdi_.Palette_GetColoursCount(*args, **kwargs)
298
e811c8ce 299 def Ok(*args, **kwargs):
a95a7133 300 """Ok(self) -> bool"""
54f9ee45 301 return _gdi_.Palette_Ok(*args, **kwargs)
e811c8ce 302
322913ce 303 def __nonzero__(self): return self.Ok()
70551f47 304
d14a1e28
RD
305class PalettePtr(Palette):
306 def __init__(self, this):
70551f47 307 self.this = this
d14a1e28
RD
308 if not hasattr(self,"thisown"): self.thisown = 0
309 self.__class__ = Palette
54f9ee45 310_gdi_.Palette_swigregister(PalettePtr)
d14a1e28
RD
311
312#---------------------------------------------------------------------------
313
314class Pen(GDIObject):
093d3ff1 315 """Proxy of C++ Pen class"""
e811c8ce
RD
316 def __repr__(self):
317 return "<%s.%s; proxy of C++ wxPen instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 318 def __init__(self, *args, **kwargs):
a95a7133 319 """__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen"""
54f9ee45 320 newobj = _gdi_.new_Pen(*args, **kwargs)
d14a1e28
RD
321 self.this = newobj.this
322 self.thisown = 1
323 del newobj.thisown
54f9ee45 324 def __del__(self, destroy=_gdi_.delete_Pen):
a95a7133 325 """__del__(self)"""
d14a1e28
RD
326 try:
327 if self.thisown: destroy(self)
328 except: pass
e811c8ce
RD
329
330 def GetCap(*args, **kwargs):
a95a7133 331 """GetCap(self) -> int"""
54f9ee45 332 return _gdi_.Pen_GetCap(*args, **kwargs)
e811c8ce
RD
333
334 def GetColour(*args, **kwargs):
a95a7133 335 """GetColour(self) -> Colour"""
54f9ee45 336 return _gdi_.Pen_GetColour(*args, **kwargs)
e811c8ce
RD
337
338 def GetJoin(*args, **kwargs):
a95a7133 339 """GetJoin(self) -> int"""
54f9ee45 340 return _gdi_.Pen_GetJoin(*args, **kwargs)
e811c8ce
RD
341
342 def GetStyle(*args, **kwargs):
a95a7133 343 """GetStyle(self) -> int"""
54f9ee45 344 return _gdi_.Pen_GetStyle(*args, **kwargs)
e811c8ce
RD
345
346 def GetWidth(*args, **kwargs):
a95a7133 347 """GetWidth(self) -> int"""
54f9ee45 348 return _gdi_.Pen_GetWidth(*args, **kwargs)
e811c8ce
RD
349
350 def Ok(*args, **kwargs):
a95a7133 351 """Ok(self) -> bool"""
54f9ee45 352 return _gdi_.Pen_Ok(*args, **kwargs)
e811c8ce
RD
353
354 def SetCap(*args, **kwargs):
a95a7133 355 """SetCap(self, int cap_style)"""
54f9ee45 356 return _gdi_.Pen_SetCap(*args, **kwargs)
e811c8ce
RD
357
358 def SetColour(*args, **kwargs):
a95a7133 359 """SetColour(self, Colour colour)"""
54f9ee45 360 return _gdi_.Pen_SetColour(*args, **kwargs)
e811c8ce
RD
361
362 def SetJoin(*args, **kwargs):
a95a7133 363 """SetJoin(self, int join_style)"""
54f9ee45 364 return _gdi_.Pen_SetJoin(*args, **kwargs)
e811c8ce
RD
365
366 def SetStyle(*args, **kwargs):
a95a7133 367 """SetStyle(self, int style)"""
54f9ee45 368 return _gdi_.Pen_SetStyle(*args, **kwargs)
e811c8ce
RD
369
370 def SetWidth(*args, **kwargs):
a95a7133 371 """SetWidth(self, int width)"""
54f9ee45 372 return _gdi_.Pen_SetWidth(*args, **kwargs)
e811c8ce
RD
373
374 def SetDashes(*args, **kwargs):
093d3ff1 375 """SetDashes(self, int dashes)"""
54f9ee45 376 return _gdi_.Pen_SetDashes(*args, **kwargs)
e811c8ce
RD
377
378 def GetDashes(*args, **kwargs):
a95a7133 379 """GetDashes(self) -> PyObject"""
54f9ee45 380 return _gdi_.Pen_GetDashes(*args, **kwargs)
e811c8ce 381
66c033b4
RD
382 def _SetDashes(*args, **kwargs):
383 """_SetDashes(self, PyObject _self, PyObject pyDashes)"""
384 return _gdi_.Pen__SetDashes(*args, **kwargs)
385
386 def SetDashes(self, dashes):
387 """
388 Associate a list of dash lengths with the Pen.
389 """
390 self._SetDashes(self, dashes)
391
392 def GetDashCount(*args, **kwargs):
393 """GetDashCount(self) -> int"""
394 return _gdi_.Pen_GetDashCount(*args, **kwargs)
395
3adfb63b 396 def __eq__(*args, **kwargs):
a95a7133 397 """__eq__(self, Pen other) -> bool"""
54f9ee45 398 return _gdi_.Pen___eq__(*args, **kwargs)
3adfb63b 399
22faec7d 400 def __ne__(*args, **kwargs):
a95a7133 401 """__ne__(self, Pen other) -> bool"""
54f9ee45 402 return _gdi_.Pen___ne__(*args, **kwargs)
22faec7d 403
d14a1e28 404 def __nonzero__(self): return self.Ok()
d14a1e28
RD
405
406class PenPtr(Pen):
407 def __init__(self, this):
408 self.this = this
409 if not hasattr(self,"thisown"): self.thisown = 0
410 self.__class__ = Pen
54f9ee45 411_gdi_.Pen_swigregister(PenPtr)
d14a1e28 412
66c033b4 413#---------------------------------------------------------------------------
e811c8ce 414
66c033b4
RD
415class Brush(GDIObject):
416 """
417 A brush is a drawing tool for filling in areas. It is used for
418 painting the background of rectangles, ellipses, etc. when drawing on
419 a `wx.DC`. It has a colour and a style.
0df68c9f 420 """
e811c8ce
RD
421 def __repr__(self):
422 return "<%s.%s; proxy of C++ wxBrush instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 423 def __init__(self, *args, **kwargs):
0df68c9f 424 """
a95a7133 425 __init__(self, Colour colour, int style=SOLID) -> Brush
1e0c8722 426
41e2b43e 427 Constructs a brush from a `wx.Colour` object and a style.
0df68c9f 428 """
54f9ee45 429 newobj = _gdi_.new_Brush(*args, **kwargs)
d14a1e28
RD
430 self.this = newobj.this
431 self.thisown = 1
432 del newobj.thisown
54f9ee45 433 def __del__(self, destroy=_gdi_.delete_Brush):
a95a7133 434 """__del__(self)"""
d14a1e28
RD
435 try:
436 if self.thisown: destroy(self)
437 except: pass
e811c8ce
RD
438
439 def SetColour(*args, **kwargs):
66c033b4
RD
440 """
441 SetColour(self, Colour col)
442
443 Set the brush's `wx.Colour`.
444 """
54f9ee45 445 return _gdi_.Brush_SetColour(*args, **kwargs)
e811c8ce
RD
446
447 def SetStyle(*args, **kwargs):
66c033b4
RD
448 """
449 SetStyle(self, int style)
450
451 Sets the style of the brush. See `__init__` for a listing of styles.
452 """
54f9ee45 453 return _gdi_.Brush_SetStyle(*args, **kwargs)
e811c8ce
RD
454
455 def SetStipple(*args, **kwargs):
66c033b4
RD
456 """
457 SetStipple(self, Bitmap stipple)
458
459 Sets the stipple `wx.Bitmap`.
460 """
54f9ee45 461 return _gdi_.Brush_SetStipple(*args, **kwargs)
e811c8ce
RD
462
463 def GetColour(*args, **kwargs):
66c033b4
RD
464 """
465 GetColour(self) -> Colour
466
467 Returns the `wx.Colour` of the brush.
468 """
54f9ee45 469 return _gdi_.Brush_GetColour(*args, **kwargs)
e811c8ce
RD
470
471 def GetStyle(*args, **kwargs):
66c033b4
RD
472 """
473 GetStyle(self) -> int
474
475 Returns the style of the brush. See `__init__` for a listing of
476 styles.
477 """
54f9ee45 478 return _gdi_.Brush_GetStyle(*args, **kwargs)
e811c8ce
RD
479
480 def GetStipple(*args, **kwargs):
66c033b4
RD
481 """
482 GetStipple(self) -> Bitmap
483
484 Returns the stiple `wx.Bitmap` of the brush. If the brush does not
485 have a wx.STIPPLE style, then the return value may be non-None but an
486 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
487 """
54f9ee45 488 return _gdi_.Brush_GetStipple(*args, **kwargs)
e811c8ce 489
f78cc896
RD
490 def IsHatch(*args, **kwargs):
491 """
492 IsHatch(self) -> bool
493
494 Is the current style a hatch type?
495 """
496 return _gdi_.Brush_IsHatch(*args, **kwargs)
497
e811c8ce 498 def Ok(*args, **kwargs):
66c033b4
RD
499 """
500 Ok(self) -> bool
501
502 Returns True if the brush is initialised and valid.
503 """
54f9ee45 504 return _gdi_.Brush_Ok(*args, **kwargs)
e811c8ce 505
d14a1e28 506 def __nonzero__(self): return self.Ok()
70551f47 507
d14a1e28
RD
508class BrushPtr(Brush):
509 def __init__(self, this):
70551f47 510 self.this = this
d14a1e28
RD
511 if not hasattr(self,"thisown"): self.thisown = 0
512 self.__class__ = Brush
54f9ee45 513_gdi_.Brush_swigregister(BrushPtr)
d14a1e28 514
d04418a7
RD
515def BrushFromBitmap(*args, **kwargs):
516 """
517 BrushFromBitmap(Bitmap stippleBitmap) -> Brush
518
519 Constructs a stippled brush using a bitmap.
520 """
521 val = _gdi_.new_BrushFromBitmap(*args, **kwargs)
522 val.thisown = 1
523 return val
524
d14a1e28 525class Bitmap(GDIObject):
66c033b4
RD
526 """
527 The wx.Bitmap class encapsulates the concept of a platform-dependent
528 bitmap. It can be either monochrome or colour, and either loaded from
529 a file or created dynamically. A bitmap can be selected into a memory
530 device context (instance of `wx.MemoryDC`). This enables the bitmap to
531 be copied to a window or memory device context using `wx.DC.Blit`, or
532 to be used as a drawing surface.
66c033b4 533 """
e811c8ce
RD
534 def __repr__(self):
535 return "<%s.%s; proxy of C++ wxBitmap instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 536 def __init__(self, *args, **kwargs):
0df68c9f 537 """
a95a7133 538 __init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap
1e0c8722 539
0df68c9f
RD
540 Loads a bitmap from a file.
541 """
54f9ee45 542 newobj = _gdi_.new_Bitmap(*args, **kwargs)
d14a1e28 543 self.this = newobj.this
8bf5d46e 544 self.thisown = 1
d14a1e28 545 del newobj.thisown
54f9ee45 546 def __del__(self, destroy=_gdi_.delete_Bitmap):
a95a7133 547 """__del__(self)"""
d14a1e28
RD
548 try:
549 if self.thisown: destroy(self)
550 except: pass
e811c8ce
RD
551
552 def Ok(*args, **kwargs):
a95a7133 553 """Ok(self) -> bool"""
54f9ee45 554 return _gdi_.Bitmap_Ok(*args, **kwargs)
e811c8ce
RD
555
556 def GetWidth(*args, **kwargs):
0df68c9f 557 """
a95a7133 558 GetWidth(self) -> int
1e0c8722 559
0df68c9f
RD
560 Gets the width of the bitmap in pixels.
561 """
54f9ee45 562 return _gdi_.Bitmap_GetWidth(*args, **kwargs)
e811c8ce
RD
563
564 def GetHeight(*args, **kwargs):
0df68c9f 565 """
a95a7133 566 GetHeight(self) -> int
1e0c8722 567
0df68c9f
RD
568 Gets the height of the bitmap in pixels.
569 """
54f9ee45 570 return _gdi_.Bitmap_GetHeight(*args, **kwargs)
e811c8ce
RD
571
572 def GetDepth(*args, **kwargs):
0df68c9f 573 """
a95a7133 574 GetDepth(self) -> int
1e0c8722 575
0df68c9f
RD
576 Gets the colour depth of the bitmap. A value of 1 indicates a
577 monochrome bitmap.
578 """
54f9ee45 579 return _gdi_.Bitmap_GetDepth(*args, **kwargs)
e811c8ce 580
b2df227b
RD
581 def GetSize(*args, **kwargs):
582 """
a95a7133 583 GetSize(self) -> Size
b2df227b
RD
584
585 Get the size of the bitmap.
586 """
54f9ee45 587 return _gdi_.Bitmap_GetSize(*args, **kwargs)
b2df227b 588
e811c8ce 589 def ConvertToImage(*args, **kwargs):
0df68c9f 590 """
a95a7133 591 ConvertToImage(self) -> Image
1e0c8722 592
66c033b4
RD
593 Creates a platform-independent image from a platform-dependent
594 bitmap. This preserves mask information so that bitmaps and images can
595 be converted back and forth without loss in that respect.
0df68c9f 596 """
54f9ee45 597 return _gdi_.Bitmap_ConvertToImage(*args, **kwargs)
e811c8ce
RD
598
599 def GetMask(*args, **kwargs):
0df68c9f 600 """
a95a7133 601 GetMask(self) -> Mask
1e0c8722 602
66c033b4
RD
603 Gets the associated mask (if any) which may have been loaded from a
604 file or explpicitly set for the bitmap.
605
606 :see: `SetMask`, `wx.Mask`
607
0df68c9f 608 """
54f9ee45 609 return _gdi_.Bitmap_GetMask(*args, **kwargs)
e811c8ce
RD
610
611 def SetMask(*args, **kwargs):
0df68c9f 612 """
a95a7133 613 SetMask(self, Mask mask)
1e0c8722 614
0df68c9f 615 Sets the mask for this bitmap.
66c033b4
RD
616
617 :see: `GetMask`, `wx.Mask`
618
0df68c9f 619 """
54f9ee45 620 return _gdi_.Bitmap_SetMask(*args, **kwargs)
e811c8ce
RD
621
622 def SetMaskColour(*args, **kwargs):
0df68c9f 623 """
a95a7133 624 SetMaskColour(self, Colour colour)
1e0c8722 625
0df68c9f
RD
626 Create a Mask based on a specified colour in the Bitmap.
627 """
54f9ee45 628 return _gdi_.Bitmap_SetMaskColour(*args, **kwargs)
e811c8ce
RD
629
630 def GetSubBitmap(*args, **kwargs):
0df68c9f 631 """
a95a7133 632 GetSubBitmap(self, Rect rect) -> Bitmap
1e0c8722 633
66c033b4
RD
634 Returns a sub-bitmap of the current one as long as the rect belongs
635 entirely to the bitmap. This function preserves bit depth and mask
636 information.
0df68c9f 637 """
54f9ee45 638 return _gdi_.Bitmap_GetSubBitmap(*args, **kwargs)
e811c8ce
RD
639
640 def SaveFile(*args, **kwargs):
0df68c9f 641 """
66c033b4 642 SaveFile(self, String name, int type, Palette palette=None) -> bool
1e0c8722 643
66c033b4
RD
644 Saves a bitmap in the named file. See `__init__` for a description of
645 the ``type`` parameter.
0df68c9f 646 """
54f9ee45 647 return _gdi_.Bitmap_SaveFile(*args, **kwargs)
e811c8ce
RD
648
649 def LoadFile(*args, **kwargs):
0df68c9f 650 """
a95a7133 651 LoadFile(self, String name, int type) -> bool
1e0c8722 652
66c033b4
RD
653 Loads a bitmap from a file. See `__init__` for a description of the
654 ``type`` parameter.
0df68c9f 655 """
54f9ee45 656 return _gdi_.Bitmap_LoadFile(*args, **kwargs)
e811c8ce 657
d3b6e4ff
RD
658 def GetPalette(*args, **kwargs):
659 """GetPalette(self) -> Palette"""
660 return _gdi_.Bitmap_GetPalette(*args, **kwargs)
661
e811c8ce 662 def CopyFromIcon(*args, **kwargs):
a95a7133 663 """CopyFromIcon(self, Icon icon) -> bool"""
54f9ee45 664 return _gdi_.Bitmap_CopyFromIcon(*args, **kwargs)
e811c8ce
RD
665
666 def SetHeight(*args, **kwargs):
0df68c9f 667 """
a95a7133 668 SetHeight(self, int height)
1e0c8722 669
66c033b4 670 Set the height property (does not affect the existing bitmap data).
0df68c9f 671 """
54f9ee45 672 return _gdi_.Bitmap_SetHeight(*args, **kwargs)
e811c8ce
RD
673
674 def SetWidth(*args, **kwargs):
0df68c9f 675 """
a95a7133 676 SetWidth(self, int width)
1e0c8722 677
66c033b4 678 Set the width property (does not affect the existing bitmap data).
0df68c9f 679 """
54f9ee45 680 return _gdi_.Bitmap_SetWidth(*args, **kwargs)
e811c8ce
RD
681
682 def SetDepth(*args, **kwargs):
0df68c9f 683 """
a95a7133 684 SetDepth(self, int depth)
1e0c8722 685
66c033b4 686 Set the depth property (does not affect the existing bitmap data).
0df68c9f 687 """
54f9ee45 688 return _gdi_.Bitmap_SetDepth(*args, **kwargs)
e811c8ce 689
b2df227b
RD
690 def SetSize(*args, **kwargs):
691 """
a95a7133 692 SetSize(self, Size size)
b2df227b 693
66c033b4 694 Set the bitmap size (does not affect the existing bitmap data).
b2df227b 695 """
54f9ee45 696 return _gdi_.Bitmap_SetSize(*args, **kwargs)
b2df227b 697
d14a1e28 698 def __nonzero__(self): return self.Ok()
4276dc52 699 def __eq__(*args, **kwargs):
a95a7133 700 """__eq__(self, Bitmap other) -> bool"""
54f9ee45 701 return _gdi_.Bitmap___eq__(*args, **kwargs)
4276dc52
RD
702
703 def __ne__(*args, **kwargs):
a95a7133 704 """__ne__(self, Bitmap other) -> bool"""
54f9ee45 705 return _gdi_.Bitmap___ne__(*args, **kwargs)
4276dc52 706
70551f47 707
d14a1e28
RD
708class BitmapPtr(Bitmap):
709 def __init__(self, this):
710 self.this = this
711 if not hasattr(self,"thisown"): self.thisown = 0
712 self.__class__ = Bitmap
54f9ee45 713_gdi_.Bitmap_swigregister(BitmapPtr)
70551f47 714
66c033b4
RD
715def EmptyBitmap(*args, **kwargs):
716 """
717 EmptyBitmap(int width, int height, int depth=-1) -> Bitmap
718
719 Creates a new bitmap of the given size. A depth of -1 indicates the
720 depth of the current screen or visual. Some platforms only support 1
721 for monochrome and -1 for the current colour setting.
722 """
723 val = _gdi_.new_EmptyBitmap(*args, **kwargs)
724 val.thisown = 1
725 return val
726
d14a1e28 727def BitmapFromIcon(*args, **kwargs):
0df68c9f
RD
728 """
729 BitmapFromIcon(Icon icon) -> Bitmap
1e0c8722 730
66c033b4 731 Create a new bitmap from a `wx.Icon` object.
0df68c9f 732 """
54f9ee45 733 val = _gdi_.new_BitmapFromIcon(*args, **kwargs)
d14a1e28
RD
734 val.thisown = 1
735 return val
70551f47 736
d14a1e28 737def BitmapFromImage(*args, **kwargs):
0df68c9f
RD
738 """
739 BitmapFromImage(Image image, int depth=-1) -> Bitmap
740
66c033b4
RD
741 Creates bitmap object from a `wx.Image`. This has to be done to
742 actually display a `wx.Image` as you cannot draw an image directly on
743 a window. The resulting bitmap will use the provided colour depth (or
744 that of the current screen colour depth if depth is -1) which entails
745 that a colour reduction may have to take place.
0df68c9f 746 """
54f9ee45 747 val = _gdi_.new_BitmapFromImage(*args, **kwargs)
d14a1e28
RD
748 val.thisown = 1
749 return val
3ef86e32 750
d14a1e28 751def BitmapFromXPMData(*args, **kwargs):
0df68c9f
RD
752 """
753 BitmapFromXPMData(PyObject listOfStrings) -> Bitmap
1e0c8722 754
0df68c9f
RD
755 Construct a Bitmap from a list of strings formatted as XPM data.
756 """
54f9ee45 757 val = _gdi_.new_BitmapFromXPMData(*args, **kwargs)
d14a1e28
RD
758 val.thisown = 1
759 return val
3ef86e32 760
d14a1e28 761def BitmapFromBits(*args, **kwargs):
0df68c9f
RD
762 """
763 BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap
764
66c033b4
RD
765 Creates a bitmap from an array of bits. You should only use this
766 function for monochrome bitmaps (depth 1) in portable programs: in
767 this case the bits parameter should contain an XBM image. For other
768 bit depths, the behaviour is platform dependent.
0df68c9f 769 """
54f9ee45 770 val = _gdi_.new_BitmapFromBits(*args, **kwargs)
d14a1e28
RD
771 val.thisown = 1
772 return val
3ef86e32 773
66c033b4 774class Mask(_core.Object):
b2df227b 775 """
66c033b4
RD
776 This class encapsulates a monochrome mask bitmap, where the masked
777 area is black and the unmasked area is white. When associated with a
778 bitmap and drawn in a device context, the unmasked area of the bitmap
779 will be drawn, and the masked area will not be drawn.
b2df227b 780
66c033b4
RD
781 A mask may be associated with a `wx.Bitmap`. It is used in
782 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
783 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
784 mask.
0df68c9f 785 """
e811c8ce
RD
786 def __repr__(self):
787 return "<%s.%s; proxy of C++ wxMask instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 788 def __init__(self, *args, **kwargs):
0df68c9f 789 """
a95a7133 790 __init__(self, Bitmap bitmap, Colour colour=NullColour) -> Mask
1e0c8722 791
66c033b4
RD
792 Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
793 that indicates the transparent portions of the mask. In other words,
794 the pixels in ``bitmap`` that match ``colour`` will be the transparent
795 portions of the mask. If no ``colour`` or an invalid ``colour`` is
796 passed then BLACK is used.
797
798 :see: `wx.Bitmap`, `wx.Colour`
0df68c9f 799 """
54f9ee45 800 newobj = _gdi_.new_Mask(*args, **kwargs)
d14a1e28
RD
801 self.this = newobj.this
802 self.thisown = 1
803 del newobj.thisown
3ef86e32 804
d14a1e28
RD
805class MaskPtr(Mask):
806 def __init__(self, this):
70551f47 807 self.this = this
d14a1e28
RD
808 if not hasattr(self,"thisown"): self.thisown = 0
809 self.__class__ = Mask
54f9ee45 810_gdi_.Mask_swigregister(MaskPtr)
d14a1e28 811
66c033b4 812MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
d14a1e28 813class Icon(GDIObject):
093d3ff1 814 """Proxy of C++ Icon class"""
e811c8ce
RD
815 def __repr__(self):
816 return "<%s.%s; proxy of C++ wxIcon instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 817 def __init__(self, *args, **kwargs):
a95a7133 818 """__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon"""
54f9ee45 819 newobj = _gdi_.new_Icon(*args, **kwargs)
d14a1e28 820 self.this = newobj.this
1893b029 821 self.thisown = 1
d14a1e28 822 del newobj.thisown
54f9ee45 823 def __del__(self, destroy=_gdi_.delete_Icon):
a95a7133 824 """__del__(self)"""
d14a1e28
RD
825 try:
826 if self.thisown: destroy(self)
827 except: pass
e811c8ce
RD
828
829 def LoadFile(*args, **kwargs):
a95a7133 830 """LoadFile(self, String name, int type) -> bool"""
54f9ee45 831 return _gdi_.Icon_LoadFile(*args, **kwargs)
e811c8ce
RD
832
833 def Ok(*args, **kwargs):
a95a7133 834 """Ok(self) -> bool"""
54f9ee45 835 return _gdi_.Icon_Ok(*args, **kwargs)
e811c8ce
RD
836
837 def GetWidth(*args, **kwargs):
a95a7133 838 """GetWidth(self) -> int"""
54f9ee45 839 return _gdi_.Icon_GetWidth(*args, **kwargs)
e811c8ce
RD
840
841 def GetHeight(*args, **kwargs):
a95a7133 842 """GetHeight(self) -> int"""
54f9ee45 843 return _gdi_.Icon_GetHeight(*args, **kwargs)
e811c8ce
RD
844
845 def GetDepth(*args, **kwargs):
a95a7133 846 """GetDepth(self) -> int"""
54f9ee45 847 return _gdi_.Icon_GetDepth(*args, **kwargs)
e811c8ce
RD
848
849 def SetWidth(*args, **kwargs):
a95a7133 850 """SetWidth(self, int w)"""
54f9ee45 851 return _gdi_.Icon_SetWidth(*args, **kwargs)
e811c8ce
RD
852
853 def SetHeight(*args, **kwargs):
a95a7133 854 """SetHeight(self, int h)"""
54f9ee45 855 return _gdi_.Icon_SetHeight(*args, **kwargs)
e811c8ce
RD
856
857 def SetDepth(*args, **kwargs):
a95a7133 858 """SetDepth(self, int d)"""
54f9ee45 859 return _gdi_.Icon_SetDepth(*args, **kwargs)
e811c8ce
RD
860
861 def CopyFromBitmap(*args, **kwargs):
a95a7133 862 """CopyFromBitmap(self, Bitmap bmp)"""
54f9ee45 863 return _gdi_.Icon_CopyFromBitmap(*args, **kwargs)
e811c8ce 864
d14a1e28 865 def __nonzero__(self): return self.Ok()
059a841c 866
d14a1e28
RD
867class IconPtr(Icon):
868 def __init__(self, this):
869 self.this = this
870 if not hasattr(self,"thisown"): self.thisown = 0
871 self.__class__ = Icon
54f9ee45 872_gdi_.Icon_swigregister(IconPtr)
059a841c 873
d14a1e28 874def EmptyIcon(*args, **kwargs):
e811c8ce 875 """EmptyIcon() -> Icon"""
54f9ee45 876 val = _gdi_.new_EmptyIcon(*args, **kwargs)
d14a1e28
RD
877 val.thisown = 1
878 return val
059a841c 879
d14a1e28 880def IconFromLocation(*args, **kwargs):
e811c8ce 881 """IconFromLocation(IconLocation loc) -> Icon"""
54f9ee45 882 val = _gdi_.new_IconFromLocation(*args, **kwargs)
a323d3bd
RD
883 val.thisown = 1
884 return val
059a841c 885
d14a1e28 886def IconFromBitmap(*args, **kwargs):
e811c8ce 887 """IconFromBitmap(Bitmap bmp) -> Icon"""
54f9ee45 888 val = _gdi_.new_IconFromBitmap(*args, **kwargs)
a323d3bd
RD
889 val.thisown = 1
890 return val
059a841c 891
d14a1e28 892def IconFromXPMData(*args, **kwargs):
e811c8ce 893 """IconFromXPMData(PyObject listOfStrings) -> Icon"""
54f9ee45 894 val = _gdi_.new_IconFromXPMData(*args, **kwargs)
d14a1e28
RD
895 val.thisown = 1
896 return val
059a841c 897
d14a1e28 898class IconLocation(object):
093d3ff1 899 """Proxy of C++ IconLocation class"""
e811c8ce
RD
900 def __repr__(self):
901 return "<%s.%s; proxy of C++ wxIconLocation instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 902 def __init__(self, *args, **kwargs):
a95a7133 903 """__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation"""
54f9ee45 904 newobj = _gdi_.new_IconLocation(*args, **kwargs)
d14a1e28
RD
905 self.this = newobj.this
906 self.thisown = 1
907 del newobj.thisown
54f9ee45 908 def __del__(self, destroy=_gdi_.delete_IconLocation):
a95a7133 909 """__del__(self)"""
d14a1e28
RD
910 try:
911 if self.thisown: destroy(self)
912 except: pass
e811c8ce
RD
913
914 def IsOk(*args, **kwargs):
a95a7133 915 """IsOk(self) -> bool"""
54f9ee45 916 return _gdi_.IconLocation_IsOk(*args, **kwargs)
e811c8ce 917
d14a1e28 918 def __nonzero__(self): return self.Ok()
e811c8ce 919 def SetFileName(*args, **kwargs):
a95a7133 920 """SetFileName(self, String filename)"""
54f9ee45 921 return _gdi_.IconLocation_SetFileName(*args, **kwargs)
e811c8ce
RD
922
923 def GetFileName(*args, **kwargs):
a95a7133 924 """GetFileName(self) -> String"""
54f9ee45 925 return _gdi_.IconLocation_GetFileName(*args, **kwargs)
e811c8ce
RD
926
927 def SetIndex(*args, **kwargs):
a95a7133 928 """SetIndex(self, int num)"""
54f9ee45 929 return _gdi_.IconLocation_SetIndex(*args, **kwargs)
e811c8ce
RD
930
931 def GetIndex(*args, **kwargs):
a95a7133 932 """GetIndex(self) -> int"""
54f9ee45 933 return _gdi_.IconLocation_GetIndex(*args, **kwargs)
e811c8ce 934
d14a1e28
RD
935
936class IconLocationPtr(IconLocation):
937 def __init__(self, this):
938 self.this = this
939 if not hasattr(self,"thisown"): self.thisown = 0
940 self.__class__ = IconLocation
54f9ee45 941_gdi_.IconLocation_swigregister(IconLocationPtr)
d14a1e28
RD
942
943class IconBundle(object):
093d3ff1 944 """Proxy of C++ IconBundle class"""
e811c8ce
RD
945 def __repr__(self):
946 return "<%s.%s; proxy of C++ wxIconBundle instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 947 def __init__(self, *args, **kwargs):
a95a7133 948 """__init__(self) -> IconBundle"""
54f9ee45 949 newobj = _gdi_.new_IconBundle(*args, **kwargs)
d14a1e28 950 self.this = newobj.this
1fded56b 951 self.thisown = 1
d14a1e28 952 del newobj.thisown
54f9ee45 953 def __del__(self, destroy=_gdi_.delete_IconBundle):
a95a7133 954 """__del__(self)"""
d14a1e28
RD
955 try:
956 if self.thisown: destroy(self)
957 except: pass
e811c8ce
RD
958
959 def AddIcon(*args, **kwargs):
a95a7133 960 """AddIcon(self, Icon icon)"""
54f9ee45 961 return _gdi_.IconBundle_AddIcon(*args, **kwargs)
e811c8ce
RD
962
963 def AddIconFromFile(*args, **kwargs):
a95a7133 964 """AddIconFromFile(self, String file, long type)"""
54f9ee45 965 return _gdi_.IconBundle_AddIconFromFile(*args, **kwargs)
e811c8ce
RD
966
967 def GetIcon(*args, **kwargs):
a95a7133 968 """GetIcon(self, Size size) -> Icon"""
54f9ee45 969 return _gdi_.IconBundle_GetIcon(*args, **kwargs)
e811c8ce 970
5e40f9dd 971
d14a1e28
RD
972class IconBundlePtr(IconBundle):
973 def __init__(self, this):
974 self.this = this
975 if not hasattr(self,"thisown"): self.thisown = 0
976 self.__class__ = IconBundle
54f9ee45 977_gdi_.IconBundle_swigregister(IconBundlePtr)
5e40f9dd 978
d14a1e28 979def IconBundleFromFile(*args, **kwargs):
196addbf 980 """IconBundleFromFile(String file, long type) -> IconBundle"""
54f9ee45 981 val = _gdi_.new_IconBundleFromFile(*args, **kwargs)
d14a1e28
RD
982 val.thisown = 1
983 return val
5e40f9dd 984
d14a1e28 985def IconBundleFromIcon(*args, **kwargs):
e811c8ce 986 """IconBundleFromIcon(Icon icon) -> IconBundle"""
54f9ee45 987 val = _gdi_.new_IconBundleFromIcon(*args, **kwargs)
d14a1e28
RD
988 val.thisown = 1
989 return val
5e40f9dd 990
d14a1e28 991class Cursor(GDIObject):
15afbcd0 992 """
41e2b43e
RD
993 A cursor is a small bitmap usually used for denoting where the mouse
994 pointer is, with a picture that might indicate the interpretation of a
995 mouse click.
15afbcd0
RD
996
997 A single cursor object may be used in many windows (any subwindow
41e2b43e
RD
998 type). The wxWindows convention is to set the cursor for a window, as
999 in X, rather than to set it globally as in MS Windows, although a
1000 global `wx.SetCursor` function is also available for use on MS Windows.
1001
15afbcd0 1002 """
e811c8ce
RD
1003 def __repr__(self):
1004 return "<%s.%s; proxy of C++ wxCursor instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1005 def __init__(self, *args, **kwargs):
15afbcd0 1006 """
a95a7133 1007 __init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor
15afbcd0
RD
1008
1009 Construct a Cursor from a file. Specify the type of file using
7557b9b5 1010 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a .cur
41e2b43e 1011 file.
15afbcd0 1012 """
54f9ee45 1013 newobj = _gdi_.new_Cursor(*args, **kwargs)
d14a1e28
RD
1014 self.this = newobj.this
1015 self.thisown = 1
1016 del newobj.thisown
54f9ee45 1017 def __del__(self, destroy=_gdi_.delete_Cursor):
a95a7133 1018 """__del__(self)"""
d14a1e28
RD
1019 try:
1020 if self.thisown: destroy(self)
1021 except: pass
e811c8ce
RD
1022
1023 def Ok(*args, **kwargs):
a95a7133 1024 """Ok(self) -> bool"""
54f9ee45 1025 return _gdi_.Cursor_Ok(*args, **kwargs)
e811c8ce 1026
d14a1e28 1027 def __nonzero__(self): return self.Ok()
b67a9327 1028
d14a1e28
RD
1029class CursorPtr(Cursor):
1030 def __init__(self, this):
1031 self.this = this
1032 if not hasattr(self,"thisown"): self.thisown = 0
1033 self.__class__ = Cursor
54f9ee45 1034_gdi_.Cursor_swigregister(CursorPtr)
70551f47 1035
d14a1e28 1036def StockCursor(*args, **kwargs):
15afbcd0
RD
1037 """
1038 StockCursor(int id) -> Cursor
1039
41e2b43e 1040 Create a cursor using one of the stock cursors. Note that not all
7557b9b5 1041 stock cursors are available on all platforms.
15afbcd0 1042 """
54f9ee45 1043 val = _gdi_.new_StockCursor(*args, **kwargs)
d14a1e28
RD
1044 val.thisown = 1
1045 return val
70551f47 1046
d14a1e28 1047def CursorFromImage(*args, **kwargs):
0df68c9f 1048 """
15afbcd0
RD
1049 CursorFromImage(Image image) -> Cursor
1050
7557b9b5 1051 Constructs a cursor from a `wx.Image`. The mask (if any) will be used
53aa7709 1052 for setting the transparent portions of the cursor.
0df68c9f 1053 """
54f9ee45 1054 val = _gdi_.new_CursorFromImage(*args, **kwargs)
d14a1e28
RD
1055 val.thisown = 1
1056 return val
70551f47 1057
d14a1e28
RD
1058#---------------------------------------------------------------------------
1059
54f9ee45
RD
1060OutRegion = _gdi_.OutRegion
1061PartRegion = _gdi_.PartRegion
1062InRegion = _gdi_.InRegion
d14a1e28 1063class Region(GDIObject):
093d3ff1 1064 """Proxy of C++ Region class"""
e811c8ce
RD
1065 def __repr__(self):
1066 return "<%s.%s; proxy of C++ wxRegion instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1067 def __init__(self, *args, **kwargs):
a95a7133 1068 """__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region"""
54f9ee45 1069 newobj = _gdi_.new_Region(*args, **kwargs)
d14a1e28 1070 self.this = newobj.this
2f4811fc 1071 self.thisown = 1
d14a1e28 1072 del newobj.thisown
54f9ee45 1073 def __del__(self, destroy=_gdi_.delete_Region):
a95a7133 1074 """__del__(self)"""
d14a1e28
RD
1075 try:
1076 if self.thisown: destroy(self)
1077 except: pass
e811c8ce
RD
1078
1079 def Clear(*args, **kwargs):
a95a7133 1080 """Clear(self)"""
54f9ee45 1081 return _gdi_.Region_Clear(*args, **kwargs)
e811c8ce
RD
1082
1083 def Offset(*args, **kwargs):
a95a7133 1084 """Offset(self, int x, int y) -> bool"""
54f9ee45 1085 return _gdi_.Region_Offset(*args, **kwargs)
e811c8ce
RD
1086
1087 def Contains(*args, **kwargs):
a95a7133 1088 """Contains(self, int x, int y) -> int"""
54f9ee45 1089 return _gdi_.Region_Contains(*args, **kwargs)
e811c8ce
RD
1090
1091 def ContainsPoint(*args, **kwargs):
a95a7133 1092 """ContainsPoint(self, Point pt) -> int"""
54f9ee45 1093 return _gdi_.Region_ContainsPoint(*args, **kwargs)
e811c8ce
RD
1094
1095 def ContainsRect(*args, **kwargs):
a95a7133 1096 """ContainsRect(self, Rect rect) -> int"""
54f9ee45 1097 return _gdi_.Region_ContainsRect(*args, **kwargs)
e811c8ce
RD
1098
1099 def ContainsRectDim(*args, **kwargs):
a95a7133 1100 """ContainsRectDim(self, int x, int y, int w, int h) -> int"""
54f9ee45 1101 return _gdi_.Region_ContainsRectDim(*args, **kwargs)
e811c8ce
RD
1102
1103 def GetBox(*args, **kwargs):
a95a7133 1104 """GetBox(self) -> Rect"""
54f9ee45 1105 return _gdi_.Region_GetBox(*args, **kwargs)
e811c8ce
RD
1106
1107 def Intersect(*args, **kwargs):
a95a7133 1108 """Intersect(self, int x, int y, int width, int height) -> bool"""
54f9ee45 1109 return _gdi_.Region_Intersect(*args, **kwargs)
e811c8ce
RD
1110
1111 def IntersectRect(*args, **kwargs):
a95a7133 1112 """IntersectRect(self, Rect rect) -> bool"""
54f9ee45 1113 return _gdi_.Region_IntersectRect(*args, **kwargs)
e811c8ce
RD
1114
1115 def IntersectRegion(*args, **kwargs):
a95a7133 1116 """IntersectRegion(self, Region region) -> bool"""
54f9ee45 1117 return _gdi_.Region_IntersectRegion(*args, **kwargs)
e811c8ce
RD
1118
1119 def IsEmpty(*args, **kwargs):
a95a7133 1120 """IsEmpty(self) -> bool"""
54f9ee45 1121 return _gdi_.Region_IsEmpty(*args, **kwargs)
e811c8ce
RD
1122
1123 def Union(*args, **kwargs):
a95a7133 1124 """Union(self, int x, int y, int width, int height) -> bool"""
54f9ee45 1125 return _gdi_.Region_Union(*args, **kwargs)
e811c8ce
RD
1126
1127 def UnionRect(*args, **kwargs):
a95a7133 1128 """UnionRect(self, Rect rect) -> bool"""
54f9ee45 1129 return _gdi_.Region_UnionRect(*args, **kwargs)
e811c8ce
RD
1130
1131 def UnionRegion(*args, **kwargs):
a95a7133 1132 """UnionRegion(self, Region region) -> bool"""
54f9ee45 1133 return _gdi_.Region_UnionRegion(*args, **kwargs)
e811c8ce
RD
1134
1135 def Subtract(*args, **kwargs):
a95a7133 1136 """Subtract(self, int x, int y, int width, int height) -> bool"""
54f9ee45 1137 return _gdi_.Region_Subtract(*args, **kwargs)
e811c8ce
RD
1138
1139 def SubtractRect(*args, **kwargs):
a95a7133 1140 """SubtractRect(self, Rect rect) -> bool"""
54f9ee45 1141 return _gdi_.Region_SubtractRect(*args, **kwargs)
e811c8ce
RD
1142
1143 def SubtractRegion(*args, **kwargs):
a95a7133 1144 """SubtractRegion(self, Region region) -> bool"""
54f9ee45 1145 return _gdi_.Region_SubtractRegion(*args, **kwargs)
e811c8ce
RD
1146
1147 def Xor(*args, **kwargs):
a95a7133 1148 """Xor(self, int x, int y, int width, int height) -> bool"""
54f9ee45 1149 return _gdi_.Region_Xor(*args, **kwargs)
e811c8ce
RD
1150
1151 def XorRect(*args, **kwargs):
a95a7133 1152 """XorRect(self, Rect rect) -> bool"""
54f9ee45 1153 return _gdi_.Region_XorRect(*args, **kwargs)
e811c8ce
RD
1154
1155 def XorRegion(*args, **kwargs):
a95a7133 1156 """XorRegion(self, Region region) -> bool"""
54f9ee45 1157 return _gdi_.Region_XorRegion(*args, **kwargs)
e811c8ce
RD
1158
1159 def ConvertToBitmap(*args, **kwargs):
a95a7133 1160 """ConvertToBitmap(self) -> Bitmap"""
54f9ee45 1161 return _gdi_.Region_ConvertToBitmap(*args, **kwargs)
e811c8ce
RD
1162
1163 def UnionBitmap(*args, **kwargs):
e6ffcedd 1164 """UnionBitmap(self, Bitmap bmp) -> bool"""
54f9ee45 1165 return _gdi_.Region_UnionBitmap(*args, **kwargs)
e811c8ce 1166
e6ffcedd
RD
1167 def UnionBitmapColour(*args, **kwargs):
1168 """UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool"""
1169 return _gdi_.Region_UnionBitmapColour(*args, **kwargs)
1170
5e40f9dd 1171
d14a1e28
RD
1172class RegionPtr(Region):
1173 def __init__(self, this):
1174 self.this = this
1175 if not hasattr(self,"thisown"): self.thisown = 0
1176 self.__class__ = Region
54f9ee45 1177_gdi_.Region_swigregister(RegionPtr)
5e40f9dd 1178
d14a1e28 1179def RegionFromBitmap(*args, **kwargs):
e6ffcedd 1180 """RegionFromBitmap(Bitmap bmp) -> Region"""
54f9ee45 1181 val = _gdi_.new_RegionFromBitmap(*args, **kwargs)
d14a1e28
RD
1182 val.thisown = 1
1183 return val
5e40f9dd 1184
e6ffcedd
RD
1185def RegionFromBitmapColour(*args, **kwargs):
1186 """RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region"""
1187 val = _gdi_.new_RegionFromBitmapColour(*args, **kwargs)
1188 val.thisown = 1
1189 return val
1190
d14a1e28 1191def RegionFromPoints(*args, **kwargs):
093d3ff1 1192 """RegionFromPoints(int points, int fillStyle=WINDING_RULE) -> Region"""
54f9ee45 1193 val = _gdi_.new_RegionFromPoints(*args, **kwargs)
d14a1e28
RD
1194 val.thisown = 1
1195 return val
5e40f9dd 1196
54f9ee45 1197class RegionIterator(_core.Object):
093d3ff1 1198 """Proxy of C++ RegionIterator class"""
e811c8ce
RD
1199 def __repr__(self):
1200 return "<%s.%s; proxy of C++ wxRegionIterator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1201 def __init__(self, *args, **kwargs):
a95a7133 1202 """__init__(self, Region region) -> RegionIterator"""
54f9ee45 1203 newobj = _gdi_.new_RegionIterator(*args, **kwargs)
d14a1e28
RD
1204 self.this = newobj.this
1205 self.thisown = 1
1206 del newobj.thisown
54f9ee45 1207 def __del__(self, destroy=_gdi_.delete_RegionIterator):
a95a7133 1208 """__del__(self)"""
d14a1e28
RD
1209 try:
1210 if self.thisown: destroy(self)
1211 except: pass
e811c8ce
RD
1212
1213 def GetX(*args, **kwargs):
a95a7133 1214 """GetX(self) -> int"""
54f9ee45 1215 return _gdi_.RegionIterator_GetX(*args, **kwargs)
e811c8ce
RD
1216
1217 def GetY(*args, **kwargs):
a95a7133 1218 """GetY(self) -> int"""
54f9ee45 1219 return _gdi_.RegionIterator_GetY(*args, **kwargs)
e811c8ce
RD
1220
1221 def GetW(*args, **kwargs):
a95a7133 1222 """GetW(self) -> int"""
54f9ee45 1223 return _gdi_.RegionIterator_GetW(*args, **kwargs)
e811c8ce
RD
1224
1225 def GetWidth(*args, **kwargs):
a95a7133 1226 """GetWidth(self) -> int"""
54f9ee45 1227 return _gdi_.RegionIterator_GetWidth(*args, **kwargs)
e811c8ce
RD
1228
1229 def GetH(*args, **kwargs):
a95a7133 1230 """GetH(self) -> int"""
54f9ee45 1231 return _gdi_.RegionIterator_GetH(*args, **kwargs)
e811c8ce
RD
1232
1233 def GetHeight(*args, **kwargs):
a95a7133 1234 """GetHeight(self) -> int"""
54f9ee45 1235 return _gdi_.RegionIterator_GetHeight(*args, **kwargs)
e811c8ce
RD
1236
1237 def GetRect(*args, **kwargs):
a95a7133 1238 """GetRect(self) -> Rect"""
54f9ee45 1239 return _gdi_.RegionIterator_GetRect(*args, **kwargs)
e811c8ce
RD
1240
1241 def HaveRects(*args, **kwargs):
a95a7133 1242 """HaveRects(self) -> bool"""
54f9ee45 1243 return _gdi_.RegionIterator_HaveRects(*args, **kwargs)
e811c8ce
RD
1244
1245 def Reset(*args, **kwargs):
a95a7133 1246 """Reset(self)"""
54f9ee45 1247 return _gdi_.RegionIterator_Reset(*args, **kwargs)
e811c8ce
RD
1248
1249 def Next(*args, **kwargs):
a95a7133 1250 """Next(self)"""
54f9ee45 1251 return _gdi_.RegionIterator_Next(*args, **kwargs)
e811c8ce
RD
1252
1253 def __nonzero__(*args, **kwargs):
a95a7133 1254 """__nonzero__(self) -> bool"""
54f9ee45 1255 return _gdi_.RegionIterator___nonzero__(*args, **kwargs)
e811c8ce 1256
d14a1e28
RD
1257
1258class RegionIteratorPtr(RegionIterator):
1259 def __init__(self, this):
70551f47 1260 self.this = this
d14a1e28
RD
1261 if not hasattr(self,"thisown"): self.thisown = 0
1262 self.__class__ = RegionIterator
54f9ee45 1263_gdi_.RegionIterator_swigregister(RegionIteratorPtr)
d14a1e28
RD
1264
1265#---------------------------------------------------------------------------
1266
54f9ee45
RD
1267FONTFAMILY_DEFAULT = _gdi_.FONTFAMILY_DEFAULT
1268FONTFAMILY_DECORATIVE = _gdi_.FONTFAMILY_DECORATIVE
1269FONTFAMILY_ROMAN = _gdi_.FONTFAMILY_ROMAN
1270FONTFAMILY_SCRIPT = _gdi_.FONTFAMILY_SCRIPT
1271FONTFAMILY_SWISS = _gdi_.FONTFAMILY_SWISS
1272FONTFAMILY_MODERN = _gdi_.FONTFAMILY_MODERN
1273FONTFAMILY_TELETYPE = _gdi_.FONTFAMILY_TELETYPE
1274FONTFAMILY_MAX = _gdi_.FONTFAMILY_MAX
1275FONTFAMILY_UNKNOWN = _gdi_.FONTFAMILY_UNKNOWN
1276FONTSTYLE_NORMAL = _gdi_.FONTSTYLE_NORMAL
1277FONTSTYLE_ITALIC = _gdi_.FONTSTYLE_ITALIC
1278FONTSTYLE_SLANT = _gdi_.FONTSTYLE_SLANT
1279FONTSTYLE_MAX = _gdi_.FONTSTYLE_MAX
1280FONTWEIGHT_NORMAL = _gdi_.FONTWEIGHT_NORMAL
1281FONTWEIGHT_LIGHT = _gdi_.FONTWEIGHT_LIGHT
1282FONTWEIGHT_BOLD = _gdi_.FONTWEIGHT_BOLD
1283FONTWEIGHT_MAX = _gdi_.FONTWEIGHT_MAX
1284FONTFLAG_DEFAULT = _gdi_.FONTFLAG_DEFAULT
1285FONTFLAG_ITALIC = _gdi_.FONTFLAG_ITALIC
1286FONTFLAG_SLANT = _gdi_.FONTFLAG_SLANT
1287FONTFLAG_LIGHT = _gdi_.FONTFLAG_LIGHT
1288FONTFLAG_BOLD = _gdi_.FONTFLAG_BOLD
1289FONTFLAG_ANTIALIASED = _gdi_.FONTFLAG_ANTIALIASED
1290FONTFLAG_NOT_ANTIALIASED = _gdi_.FONTFLAG_NOT_ANTIALIASED
1291FONTFLAG_UNDERLINED = _gdi_.FONTFLAG_UNDERLINED
1292FONTFLAG_STRIKETHROUGH = _gdi_.FONTFLAG_STRIKETHROUGH
1293FONTFLAG_MASK = _gdi_.FONTFLAG_MASK
1294FONTENCODING_SYSTEM = _gdi_.FONTENCODING_SYSTEM
1295FONTENCODING_DEFAULT = _gdi_.FONTENCODING_DEFAULT
1296FONTENCODING_ISO8859_1 = _gdi_.FONTENCODING_ISO8859_1
1297FONTENCODING_ISO8859_2 = _gdi_.FONTENCODING_ISO8859_2
1298FONTENCODING_ISO8859_3 = _gdi_.FONTENCODING_ISO8859_3
1299FONTENCODING_ISO8859_4 = _gdi_.FONTENCODING_ISO8859_4
1300FONTENCODING_ISO8859_5 = _gdi_.FONTENCODING_ISO8859_5
1301FONTENCODING_ISO8859_6 = _gdi_.FONTENCODING_ISO8859_6
1302FONTENCODING_ISO8859_7 = _gdi_.FONTENCODING_ISO8859_7
1303FONTENCODING_ISO8859_8 = _gdi_.FONTENCODING_ISO8859_8
1304FONTENCODING_ISO8859_9 = _gdi_.FONTENCODING_ISO8859_9
1305FONTENCODING_ISO8859_10 = _gdi_.FONTENCODING_ISO8859_10
1306FONTENCODING_ISO8859_11 = _gdi_.FONTENCODING_ISO8859_11
1307FONTENCODING_ISO8859_12 = _gdi_.FONTENCODING_ISO8859_12
1308FONTENCODING_ISO8859_13 = _gdi_.FONTENCODING_ISO8859_13
1309FONTENCODING_ISO8859_14 = _gdi_.FONTENCODING_ISO8859_14
1310FONTENCODING_ISO8859_15 = _gdi_.FONTENCODING_ISO8859_15
1311FONTENCODING_ISO8859_MAX = _gdi_.FONTENCODING_ISO8859_MAX
1312FONTENCODING_KOI8 = _gdi_.FONTENCODING_KOI8
1313FONTENCODING_KOI8_U = _gdi_.FONTENCODING_KOI8_U
1314FONTENCODING_ALTERNATIVE = _gdi_.FONTENCODING_ALTERNATIVE
1315FONTENCODING_BULGARIAN = _gdi_.FONTENCODING_BULGARIAN
1316FONTENCODING_CP437 = _gdi_.FONTENCODING_CP437
1317FONTENCODING_CP850 = _gdi_.FONTENCODING_CP850
1318FONTENCODING_CP852 = _gdi_.FONTENCODING_CP852
1319FONTENCODING_CP855 = _gdi_.FONTENCODING_CP855
1320FONTENCODING_CP866 = _gdi_.FONTENCODING_CP866
1321FONTENCODING_CP874 = _gdi_.FONTENCODING_CP874
1322FONTENCODING_CP932 = _gdi_.FONTENCODING_CP932
1323FONTENCODING_CP936 = _gdi_.FONTENCODING_CP936
1324FONTENCODING_CP949 = _gdi_.FONTENCODING_CP949
1325FONTENCODING_CP950 = _gdi_.FONTENCODING_CP950
1326FONTENCODING_CP1250 = _gdi_.FONTENCODING_CP1250
1327FONTENCODING_CP1251 = _gdi_.FONTENCODING_CP1251
1328FONTENCODING_CP1252 = _gdi_.FONTENCODING_CP1252
1329FONTENCODING_CP1253 = _gdi_.FONTENCODING_CP1253
1330FONTENCODING_CP1254 = _gdi_.FONTENCODING_CP1254
1331FONTENCODING_CP1255 = _gdi_.FONTENCODING_CP1255
1332FONTENCODING_CP1256 = _gdi_.FONTENCODING_CP1256
1333FONTENCODING_CP1257 = _gdi_.FONTENCODING_CP1257
1334FONTENCODING_CP12_MAX = _gdi_.FONTENCODING_CP12_MAX
1335FONTENCODING_UTF7 = _gdi_.FONTENCODING_UTF7
1336FONTENCODING_UTF8 = _gdi_.FONTENCODING_UTF8
1337FONTENCODING_EUC_JP = _gdi_.FONTENCODING_EUC_JP
1338FONTENCODING_UTF16BE = _gdi_.FONTENCODING_UTF16BE
1339FONTENCODING_UTF16LE = _gdi_.FONTENCODING_UTF16LE
1340FONTENCODING_UTF32BE = _gdi_.FONTENCODING_UTF32BE
1341FONTENCODING_UTF32LE = _gdi_.FONTENCODING_UTF32LE
1342FONTENCODING_MACROMAN = _gdi_.FONTENCODING_MACROMAN
1343FONTENCODING_MACJAPANESE = _gdi_.FONTENCODING_MACJAPANESE
1344FONTENCODING_MACCHINESETRAD = _gdi_.FONTENCODING_MACCHINESETRAD
1345FONTENCODING_MACKOREAN = _gdi_.FONTENCODING_MACKOREAN
1346FONTENCODING_MACARABIC = _gdi_.FONTENCODING_MACARABIC
1347FONTENCODING_MACHEBREW = _gdi_.FONTENCODING_MACHEBREW
1348FONTENCODING_MACGREEK = _gdi_.FONTENCODING_MACGREEK
1349FONTENCODING_MACCYRILLIC = _gdi_.FONTENCODING_MACCYRILLIC
1350FONTENCODING_MACDEVANAGARI = _gdi_.FONTENCODING_MACDEVANAGARI
1351FONTENCODING_MACGURMUKHI = _gdi_.FONTENCODING_MACGURMUKHI
1352FONTENCODING_MACGUJARATI = _gdi_.FONTENCODING_MACGUJARATI
1353FONTENCODING_MACORIYA = _gdi_.FONTENCODING_MACORIYA
1354FONTENCODING_MACBENGALI = _gdi_.FONTENCODING_MACBENGALI
1355FONTENCODING_MACTAMIL = _gdi_.FONTENCODING_MACTAMIL
1356FONTENCODING_MACTELUGU = _gdi_.FONTENCODING_MACTELUGU
1357FONTENCODING_MACKANNADA = _gdi_.FONTENCODING_MACKANNADA
1358FONTENCODING_MACMALAJALAM = _gdi_.FONTENCODING_MACMALAJALAM
1359FONTENCODING_MACSINHALESE = _gdi_.FONTENCODING_MACSINHALESE
1360FONTENCODING_MACBURMESE = _gdi_.FONTENCODING_MACBURMESE
1361FONTENCODING_MACKHMER = _gdi_.FONTENCODING_MACKHMER
1362FONTENCODING_MACTHAI = _gdi_.FONTENCODING_MACTHAI
1363FONTENCODING_MACLAOTIAN = _gdi_.FONTENCODING_MACLAOTIAN
1364FONTENCODING_MACGEORGIAN = _gdi_.FONTENCODING_MACGEORGIAN
1365FONTENCODING_MACARMENIAN = _gdi_.FONTENCODING_MACARMENIAN
1366FONTENCODING_MACCHINESESIMP = _gdi_.FONTENCODING_MACCHINESESIMP
1367FONTENCODING_MACTIBETAN = _gdi_.FONTENCODING_MACTIBETAN
1368FONTENCODING_MACMONGOLIAN = _gdi_.FONTENCODING_MACMONGOLIAN
1369FONTENCODING_MACETHIOPIC = _gdi_.FONTENCODING_MACETHIOPIC
1370FONTENCODING_MACCENTRALEUR = _gdi_.FONTENCODING_MACCENTRALEUR
1371FONTENCODING_MACVIATNAMESE = _gdi_.FONTENCODING_MACVIATNAMESE
1372FONTENCODING_MACARABICEXT = _gdi_.FONTENCODING_MACARABICEXT
1373FONTENCODING_MACSYMBOL = _gdi_.FONTENCODING_MACSYMBOL
1374FONTENCODING_MACDINGBATS = _gdi_.FONTENCODING_MACDINGBATS
1375FONTENCODING_MACTURKISH = _gdi_.FONTENCODING_MACTURKISH
1376FONTENCODING_MACCROATIAN = _gdi_.FONTENCODING_MACCROATIAN
1377FONTENCODING_MACICELANDIC = _gdi_.FONTENCODING_MACICELANDIC
1378FONTENCODING_MACROMANIAN = _gdi_.FONTENCODING_MACROMANIAN
1379FONTENCODING_MACCELTIC = _gdi_.FONTENCODING_MACCELTIC
1380FONTENCODING_MACGAELIC = _gdi_.FONTENCODING_MACGAELIC
1381FONTENCODING_MACKEYBOARD = _gdi_.FONTENCODING_MACKEYBOARD
1382FONTENCODING_MACMIN = _gdi_.FONTENCODING_MACMIN
1383FONTENCODING_MACMAX = _gdi_.FONTENCODING_MACMAX
1384FONTENCODING_MAX = _gdi_.FONTENCODING_MAX
1385FONTENCODING_UTF16 = _gdi_.FONTENCODING_UTF16
1386FONTENCODING_UTF32 = _gdi_.FONTENCODING_UTF32
1387FONTENCODING_UNICODE = _gdi_.FONTENCODING_UNICODE
1388FONTENCODING_GB2312 = _gdi_.FONTENCODING_GB2312
1389FONTENCODING_BIG5 = _gdi_.FONTENCODING_BIG5
1390FONTENCODING_SHIFT_JIS = _gdi_.FONTENCODING_SHIFT_JIS
d14a1e28
RD
1391#---------------------------------------------------------------------------
1392
1393class NativeFontInfo(object):
093d3ff1 1394 """Proxy of C++ NativeFontInfo class"""
e811c8ce
RD
1395 def __repr__(self):
1396 return "<%s.%s; proxy of C++ wxNativeFontInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1397 def __init__(self, *args, **kwargs):
a95a7133 1398 """__init__(self) -> NativeFontInfo"""
54f9ee45 1399 newobj = _gdi_.new_NativeFontInfo(*args, **kwargs)
d14a1e28
RD
1400 self.this = newobj.this
1401 self.thisown = 1
1402 del newobj.thisown
54f9ee45 1403 def __del__(self, destroy=_gdi_.delete_NativeFontInfo):
a95a7133 1404 """__del__(self)"""
d14a1e28
RD
1405 try:
1406 if self.thisown: destroy(self)
1407 except: pass
e811c8ce
RD
1408
1409 def Init(*args, **kwargs):
a95a7133 1410 """Init(self)"""
54f9ee45 1411 return _gdi_.NativeFontInfo_Init(*args, **kwargs)
e811c8ce
RD
1412
1413 def InitFromFont(*args, **kwargs):
a95a7133 1414 """InitFromFont(self, Font font)"""
54f9ee45 1415 return _gdi_.NativeFontInfo_InitFromFont(*args, **kwargs)
e811c8ce
RD
1416
1417 def GetPointSize(*args, **kwargs):
a95a7133 1418 """GetPointSize(self) -> int"""
54f9ee45 1419 return _gdi_.NativeFontInfo_GetPointSize(*args, **kwargs)
e811c8ce
RD
1420
1421 def GetStyle(*args, **kwargs):
a95a7133 1422 """GetStyle(self) -> int"""
54f9ee45 1423 return _gdi_.NativeFontInfo_GetStyle(*args, **kwargs)
e811c8ce
RD
1424
1425 def GetWeight(*args, **kwargs):
a95a7133 1426 """GetWeight(self) -> int"""
54f9ee45 1427 return _gdi_.NativeFontInfo_GetWeight(*args, **kwargs)
e811c8ce
RD
1428
1429 def GetUnderlined(*args, **kwargs):
a95a7133 1430 """GetUnderlined(self) -> bool"""
54f9ee45 1431 return _gdi_.NativeFontInfo_GetUnderlined(*args, **kwargs)
e811c8ce
RD
1432
1433 def GetFaceName(*args, **kwargs):
a95a7133 1434 """GetFaceName(self) -> String"""
54f9ee45 1435 return _gdi_.NativeFontInfo_GetFaceName(*args, **kwargs)
e811c8ce
RD
1436
1437 def GetFamily(*args, **kwargs):
a95a7133 1438 """GetFamily(self) -> int"""
54f9ee45 1439 return _gdi_.NativeFontInfo_GetFamily(*args, **kwargs)
e811c8ce
RD
1440
1441 def GetEncoding(*args, **kwargs):
a95a7133 1442 """GetEncoding(self) -> int"""
54f9ee45 1443 return _gdi_.NativeFontInfo_GetEncoding(*args, **kwargs)
e811c8ce
RD
1444
1445 def SetPointSize(*args, **kwargs):
a95a7133 1446 """SetPointSize(self, int pointsize)"""
54f9ee45 1447 return _gdi_.NativeFontInfo_SetPointSize(*args, **kwargs)
e811c8ce
RD
1448
1449 def SetStyle(*args, **kwargs):
a95a7133 1450 """SetStyle(self, int style)"""
54f9ee45 1451 return _gdi_.NativeFontInfo_SetStyle(*args, **kwargs)
e811c8ce
RD
1452
1453 def SetWeight(*args, **kwargs):
a95a7133 1454 """SetWeight(self, int weight)"""
54f9ee45 1455 return _gdi_.NativeFontInfo_SetWeight(*args, **kwargs)
e811c8ce
RD
1456
1457 def SetUnderlined(*args, **kwargs):
a95a7133 1458 """SetUnderlined(self, bool underlined)"""
54f9ee45 1459 return _gdi_.NativeFontInfo_SetUnderlined(*args, **kwargs)
e811c8ce
RD
1460
1461 def SetFaceName(*args, **kwargs):
a95a7133 1462 """SetFaceName(self, String facename)"""
54f9ee45 1463 return _gdi_.NativeFontInfo_SetFaceName(*args, **kwargs)
e811c8ce
RD
1464
1465 def SetFamily(*args, **kwargs):
a95a7133 1466 """SetFamily(self, int family)"""
54f9ee45 1467 return _gdi_.NativeFontInfo_SetFamily(*args, **kwargs)
e811c8ce
RD
1468
1469 def SetEncoding(*args, **kwargs):
a95a7133 1470 """SetEncoding(self, int encoding)"""
54f9ee45 1471 return _gdi_.NativeFontInfo_SetEncoding(*args, **kwargs)
e811c8ce
RD
1472
1473 def FromString(*args, **kwargs):
a95a7133 1474 """FromString(self, String s) -> bool"""
54f9ee45 1475 return _gdi_.NativeFontInfo_FromString(*args, **kwargs)
e811c8ce
RD
1476
1477 def ToString(*args, **kwargs):
a95a7133 1478 """ToString(self) -> String"""
54f9ee45 1479 return _gdi_.NativeFontInfo_ToString(*args, **kwargs)
e811c8ce
RD
1480
1481 def __str__(*args, **kwargs):
a95a7133 1482 """__str__(self) -> String"""
54f9ee45 1483 return _gdi_.NativeFontInfo___str__(*args, **kwargs)
e811c8ce
RD
1484
1485 def FromUserString(*args, **kwargs):
a95a7133 1486 """FromUserString(self, String s) -> bool"""
54f9ee45 1487 return _gdi_.NativeFontInfo_FromUserString(*args, **kwargs)
e811c8ce
RD
1488
1489 def ToUserString(*args, **kwargs):
a95a7133 1490 """ToUserString(self) -> String"""
54f9ee45 1491 return _gdi_.NativeFontInfo_ToUserString(*args, **kwargs)
e811c8ce 1492
d14a1e28
RD
1493
1494class NativeFontInfoPtr(NativeFontInfo):
1495 def __init__(self, this):
1496 self.this = this
1497 if not hasattr(self,"thisown"): self.thisown = 0
1498 self.__class__ = NativeFontInfo
54f9ee45 1499_gdi_.NativeFontInfo_swigregister(NativeFontInfoPtr)
d14a1e28
RD
1500
1501class NativeEncodingInfo(object):
093d3ff1 1502 """Proxy of C++ NativeEncodingInfo class"""
e811c8ce
RD
1503 def __repr__(self):
1504 return "<%s.%s; proxy of C++ wxNativeEncodingInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
1505 facename = property(_gdi_.NativeEncodingInfo_facename_get, _gdi_.NativeEncodingInfo_facename_set)
1506 encoding = property(_gdi_.NativeEncodingInfo_encoding_get, _gdi_.NativeEncodingInfo_encoding_set)
d14a1e28 1507 def __init__(self, *args, **kwargs):
a95a7133 1508 """__init__(self) -> NativeEncodingInfo"""
54f9ee45 1509 newobj = _gdi_.new_NativeEncodingInfo(*args, **kwargs)
d14a1e28 1510 self.this = newobj.this
70551f47 1511 self.thisown = 1
d14a1e28 1512 del newobj.thisown
54f9ee45 1513 def __del__(self, destroy=_gdi_.delete_NativeEncodingInfo):
a95a7133 1514 """__del__(self)"""
d14a1e28
RD
1515 try:
1516 if self.thisown: destroy(self)
1517 except: pass
e811c8ce
RD
1518
1519 def FromString(*args, **kwargs):
a95a7133 1520 """FromString(self, String s) -> bool"""
54f9ee45 1521 return _gdi_.NativeEncodingInfo_FromString(*args, **kwargs)
e811c8ce
RD
1522
1523 def ToString(*args, **kwargs):
a95a7133 1524 """ToString(self) -> String"""
54f9ee45 1525 return _gdi_.NativeEncodingInfo_ToString(*args, **kwargs)
e811c8ce 1526
70551f47 1527
d14a1e28
RD
1528class NativeEncodingInfoPtr(NativeEncodingInfo):
1529 def __init__(self, this):
1530 self.this = this
1531 if not hasattr(self,"thisown"): self.thisown = 0
1532 self.__class__ = NativeEncodingInfo
54f9ee45 1533_gdi_.NativeEncodingInfo_swigregister(NativeEncodingInfoPtr)
70551f47
RD
1534
1535
e811c8ce 1536def GetNativeFontEncoding(*args, **kwargs):
196addbf 1537 """GetNativeFontEncoding(int encoding) -> NativeEncodingInfo"""
54f9ee45 1538 return _gdi_.GetNativeFontEncoding(*args, **kwargs)
70551f47 1539
e811c8ce
RD
1540def TestFontEncoding(*args, **kwargs):
1541 """TestFontEncoding(NativeEncodingInfo info) -> bool"""
54f9ee45 1542 return _gdi_.TestFontEncoding(*args, **kwargs)
d14a1e28
RD
1543#---------------------------------------------------------------------------
1544
1545class FontMapper(object):
093d3ff1 1546 """Proxy of C++ FontMapper class"""
e811c8ce
RD
1547 def __repr__(self):
1548 return "<%s.%s; proxy of C++ wxFontMapper instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1549 def __init__(self, *args, **kwargs):
a95a7133 1550 """__init__(self) -> FontMapper"""
54f9ee45 1551 newobj = _gdi_.new_FontMapper(*args, **kwargs)
d14a1e28 1552 self.this = newobj.this
65191ae8 1553 self.thisown = 1
d14a1e28 1554 del newobj.thisown
54f9ee45 1555 def __del__(self, destroy=_gdi_.delete_FontMapper):
a95a7133 1556 """__del__(self)"""
d14a1e28
RD
1557 try:
1558 if self.thisown: destroy(self)
1559 except: pass
e811c8ce
RD
1560
1561 def Get(*args, **kwargs):
66c033b4 1562 """Get() -> FontMapper"""
54f9ee45 1563 return _gdi_.FontMapper_Get(*args, **kwargs)
e811c8ce
RD
1564
1565 Get = staticmethod(Get)
1566 def Set(*args, **kwargs):
66c033b4 1567 """Set(FontMapper mapper) -> FontMapper"""
54f9ee45 1568 return _gdi_.FontMapper_Set(*args, **kwargs)
e811c8ce
RD
1569
1570 Set = staticmethod(Set)
1571 def CharsetToEncoding(*args, **kwargs):
a95a7133 1572 """CharsetToEncoding(self, String charset, bool interactive=True) -> int"""
54f9ee45 1573 return _gdi_.FontMapper_CharsetToEncoding(*args, **kwargs)
e811c8ce
RD
1574
1575 def GetSupportedEncodingsCount(*args, **kwargs):
66c033b4 1576 """GetSupportedEncodingsCount() -> size_t"""
54f9ee45 1577 return _gdi_.FontMapper_GetSupportedEncodingsCount(*args, **kwargs)
e811c8ce
RD
1578
1579 GetSupportedEncodingsCount = staticmethod(GetSupportedEncodingsCount)
1580 def GetEncoding(*args, **kwargs):
66c033b4 1581 """GetEncoding(size_t n) -> int"""
54f9ee45 1582 return _gdi_.FontMapper_GetEncoding(*args, **kwargs)
e811c8ce
RD
1583
1584 GetEncoding = staticmethod(GetEncoding)
1585 def GetEncodingName(*args, **kwargs):
66c033b4 1586 """GetEncodingName(int encoding) -> String"""
54f9ee45 1587 return _gdi_.FontMapper_GetEncodingName(*args, **kwargs)
e811c8ce
RD
1588
1589 GetEncodingName = staticmethod(GetEncodingName)
1590 def GetEncodingDescription(*args, **kwargs):
66c033b4 1591 """GetEncodingDescription(int encoding) -> String"""
54f9ee45 1592 return _gdi_.FontMapper_GetEncodingDescription(*args, **kwargs)
e811c8ce
RD
1593
1594 GetEncodingDescription = staticmethod(GetEncodingDescription)
b2df227b 1595 def GetEncodingFromName(*args, **kwargs):
66c033b4 1596 """GetEncodingFromName(String name) -> int"""
54f9ee45 1597 return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs)
b2df227b
RD
1598
1599 GetEncodingFromName = staticmethod(GetEncodingFromName)
e811c8ce 1600 def SetConfigPath(*args, **kwargs):
a95a7133 1601 """SetConfigPath(self, String prefix)"""
54f9ee45 1602 return _gdi_.FontMapper_SetConfigPath(*args, **kwargs)
e811c8ce
RD
1603
1604 def GetDefaultConfigPath(*args, **kwargs):
66c033b4 1605 """GetDefaultConfigPath() -> String"""
54f9ee45 1606 return _gdi_.FontMapper_GetDefaultConfigPath(*args, **kwargs)
e811c8ce
RD
1607
1608 GetDefaultConfigPath = staticmethod(GetDefaultConfigPath)
1609 def GetAltForEncoding(*args, **kwargs):
a95a7133 1610 """GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject"""
54f9ee45 1611 return _gdi_.FontMapper_GetAltForEncoding(*args, **kwargs)
e811c8ce
RD
1612
1613 def IsEncodingAvailable(*args, **kwargs):
a95a7133 1614 """IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool"""
54f9ee45 1615 return _gdi_.FontMapper_IsEncodingAvailable(*args, **kwargs)
e811c8ce
RD
1616
1617 def SetDialogParent(*args, **kwargs):
a95a7133 1618 """SetDialogParent(self, Window parent)"""
54f9ee45 1619 return _gdi_.FontMapper_SetDialogParent(*args, **kwargs)
e811c8ce
RD
1620
1621 def SetDialogTitle(*args, **kwargs):
a95a7133 1622 """SetDialogTitle(self, String title)"""
54f9ee45 1623 return _gdi_.FontMapper_SetDialogTitle(*args, **kwargs)
e811c8ce 1624
65191ae8 1625
d14a1e28
RD
1626class FontMapperPtr(FontMapper):
1627 def __init__(self, this):
1628 self.this = this
1629 if not hasattr(self,"thisown"): self.thisown = 0
1630 self.__class__ = FontMapper
54f9ee45 1631_gdi_.FontMapper_swigregister(FontMapperPtr)
65191ae8 1632
e811c8ce
RD
1633def FontMapper_Get(*args, **kwargs):
1634 """FontMapper_Get() -> FontMapper"""
54f9ee45 1635 return _gdi_.FontMapper_Get(*args, **kwargs)
65191ae8 1636
e811c8ce
RD
1637def FontMapper_Set(*args, **kwargs):
1638 """FontMapper_Set(FontMapper mapper) -> FontMapper"""
54f9ee45 1639 return _gdi_.FontMapper_Set(*args, **kwargs)
65191ae8 1640
e811c8ce
RD
1641def FontMapper_GetSupportedEncodingsCount(*args, **kwargs):
1642 """FontMapper_GetSupportedEncodingsCount() -> size_t"""
54f9ee45 1643 return _gdi_.FontMapper_GetSupportedEncodingsCount(*args, **kwargs)
d14a1e28 1644
e811c8ce 1645def FontMapper_GetEncoding(*args, **kwargs):
196addbf 1646 """FontMapper_GetEncoding(size_t n) -> int"""
54f9ee45 1647 return _gdi_.FontMapper_GetEncoding(*args, **kwargs)
d14a1e28 1648
e811c8ce 1649def FontMapper_GetEncodingName(*args, **kwargs):
196addbf 1650 """FontMapper_GetEncodingName(int encoding) -> String"""
54f9ee45 1651 return _gdi_.FontMapper_GetEncodingName(*args, **kwargs)
d14a1e28 1652
e811c8ce 1653def FontMapper_GetEncodingDescription(*args, **kwargs):
196addbf 1654 """FontMapper_GetEncodingDescription(int encoding) -> String"""
54f9ee45 1655 return _gdi_.FontMapper_GetEncodingDescription(*args, **kwargs)
d14a1e28 1656
b2df227b
RD
1657def FontMapper_GetEncodingFromName(*args, **kwargs):
1658 """FontMapper_GetEncodingFromName(String name) -> int"""
54f9ee45 1659 return _gdi_.FontMapper_GetEncodingFromName(*args, **kwargs)
b2df227b 1660
e811c8ce 1661def FontMapper_GetDefaultConfigPath(*args, **kwargs):
196addbf 1662 """FontMapper_GetDefaultConfigPath() -> String"""
54f9ee45 1663 return _gdi_.FontMapper_GetDefaultConfigPath(*args, **kwargs)
d14a1e28
RD
1664
1665#---------------------------------------------------------------------------
1666
1667class Font(GDIObject):
a97cefba
RD
1668 """
1669 A font is an object which determines the appearance of text. Fonts are
1670 used for drawing text to a device context, and setting the appearance
1671 of a window's text.
1672
1673 You can retrieve the current system font settings with `wx.SystemSettings`.
1674 """
e811c8ce
RD
1675 def __repr__(self):
1676 return "<%s.%s; proxy of C++ wxFont instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 1677 def __init__(self, *args, **kwargs):
0df68c9f 1678 """
a95a7133 1679 __init__(self, int pointSize, int family, int style, int weight, bool underline=False,
196addbf
RD
1680 String face=EmptyString,
1681 int encoding=FONTENCODING_DEFAULT) -> Font
a97cefba
RD
1682
1683 Creates a font object with the specified attributes.
1684
1685 :param pointSize: The size of the font in points.
1686
1687 :param family: Font family. A generic way of referring to fonts
1688 without specifying actual facename. It can be One of
1689 the ``wx.FONTFAMILY_xxx`` constants.
1690
1691 :param style: One of the ``wx.FONTSTYLE_xxx`` constants.
1692
1693 :param weight: Font weight, sometimes also referred to as font
1694 boldness. One of the ``wx.FONTWEIGHT_xxx`` constants.
1695
1696 :param underline: The value can be ``True`` or ``False`` and
1697 indicates whether the font will include an underline. This
1698 may not be supported on all platforms.
1699
1700 :param face: An optional string specifying the actual typeface to
1701 be used. If it is an empty string, a default typeface will be
1702 chosen based on the family.
1703
1704 :param encoding: An encoding which may be one of the
1705 ``wx.FONTENCODING_xxx`` constants. If the specified encoding isn't
1706 available, no font is created.
1707
1708 :see: `wx.FFont`, `wx.FontFromPixelSize`, `wx.FFontFromPixelSize`,
1709 `wx.FontFromNativeInfoString`, `wx.FontFromNativeInfo`
1710
0df68c9f 1711 """
db3e571a 1712 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
54f9ee45 1713 newobj = _gdi_.new_Font(*args, **kwargs)
d14a1e28
RD
1714 self.this = newobj.this
1715 self.thisown = 1
1716 del newobj.thisown
54f9ee45 1717 def __del__(self, destroy=_gdi_.delete_Font):
a95a7133 1718 """__del__(self)"""
d14a1e28
RD
1719 try:
1720 if self.thisown: destroy(self)
1721 except: pass
e811c8ce
RD
1722
1723 def Ok(*args, **kwargs):
a97cefba
RD
1724 """
1725 Ok(self) -> bool
1726
1727 Returns ``True`` if this font was successfully created.
1728 """
54f9ee45 1729 return _gdi_.Font_Ok(*args, **kwargs)
e811c8ce 1730
d14a1e28 1731 def __nonzero__(self): return self.Ok()
e811c8ce 1732 def __eq__(*args, **kwargs):
a95a7133 1733 """__eq__(self, Font other) -> bool"""
54f9ee45 1734 return _gdi_.Font___eq__(*args, **kwargs)
e811c8ce
RD
1735
1736 def __ne__(*args, **kwargs):
a95a7133 1737 """__ne__(self, Font other) -> bool"""
54f9ee45 1738 return _gdi_.Font___ne__(*args, **kwargs)
e811c8ce
RD
1739
1740 def GetPointSize(*args, **kwargs):
a97cefba
RD
1741 """
1742 GetPointSize(self) -> int
1743
1744 Gets the point size.
1745 """
54f9ee45 1746 return _gdi_.Font_GetPointSize(*args, **kwargs)
e811c8ce 1747
b6294124 1748 def GetPixelSize(*args, **kwargs):
a97cefba
RD
1749 """
1750 GetPixelSize(self) -> Size
1751
1752 Returns the size in pixels if the font was constructed with a pixel
1753 size.
1754 """
b6294124
RD
1755 return _gdi_.Font_GetPixelSize(*args, **kwargs)
1756
1757 def IsUsingSizeInPixels(*args, **kwargs):
a97cefba
RD
1758 """
1759 IsUsingSizeInPixels(self) -> bool
1760
1761 Returns ``True`` if the font is using a pixelSize.
1762 """
b6294124
RD
1763 return _gdi_.Font_IsUsingSizeInPixels(*args, **kwargs)
1764
e811c8ce 1765 def GetFamily(*args, **kwargs):
a97cefba
RD
1766 """
1767 GetFamily(self) -> int
1768
1769 Gets the font family.
1770 """
54f9ee45 1771 return _gdi_.Font_GetFamily(*args, **kwargs)
e811c8ce
RD
1772
1773 def GetStyle(*args, **kwargs):
a97cefba
RD
1774 """
1775 GetStyle(self) -> int
1776
1777 Gets the font style.
1778 """
54f9ee45 1779 return _gdi_.Font_GetStyle(*args, **kwargs)
e811c8ce
RD
1780
1781 def GetWeight(*args, **kwargs):
a97cefba
RD
1782 """
1783 GetWeight(self) -> int
1784
1785 Gets the font weight.
1786 """
54f9ee45 1787 return _gdi_.Font_GetWeight(*args, **kwargs)
e811c8ce
RD
1788
1789 def GetUnderlined(*args, **kwargs):
a97cefba
RD
1790 """
1791 GetUnderlined(self) -> bool
1792
1793 Returns ``True`` if the font is underlined, ``False`` otherwise.
1794 """
54f9ee45 1795 return _gdi_.Font_GetUnderlined(*args, **kwargs)
e811c8ce
RD
1796
1797 def GetFaceName(*args, **kwargs):
a97cefba
RD
1798 """
1799 GetFaceName(self) -> String
1800
1801 Returns the typeface name associated with the font, or the empty
1802 string if there is no typeface information.
1803 """
54f9ee45 1804 return _gdi_.Font_GetFaceName(*args, **kwargs)
e811c8ce
RD
1805
1806 def GetEncoding(*args, **kwargs):
a97cefba
RD
1807 """
1808 GetEncoding(self) -> int
1809
1810 Get the font's encoding.
1811 """
54f9ee45 1812 return _gdi_.Font_GetEncoding(*args, **kwargs)
e811c8ce
RD
1813
1814 def GetNativeFontInfo(*args, **kwargs):
a97cefba
RD
1815 """
1816 GetNativeFontInfo(self) -> NativeFontInfo
1817
1818 Constructs a `wx.NativeFontInfo` object from this font.
1819 """
54f9ee45 1820 return _gdi_.Font_GetNativeFontInfo(*args, **kwargs)
e811c8ce
RD
1821
1822 def IsFixedWidth(*args, **kwargs):
a97cefba
RD
1823 """
1824 IsFixedWidth(self) -> bool
1825
1826 Returns true if the font is a fixed width (or monospaced) font, false
1827 if it is a proportional one or font is invalid.
1828 """
54f9ee45 1829 return _gdi_.Font_IsFixedWidth(*args, **kwargs)
e811c8ce
RD
1830
1831 def GetNativeFontInfoDesc(*args, **kwargs):
a97cefba
RD
1832 """
1833 GetNativeFontInfoDesc(self) -> String
1834
1835 Returns the platform-dependent string completely describing this font
1836 or an empty string if the font isn't valid.
1837 """
54f9ee45 1838 return _gdi_.Font_GetNativeFontInfoDesc(*args, **kwargs)
e811c8ce
RD
1839
1840 def GetNativeFontInfoUserDesc(*args, **kwargs):
a97cefba
RD
1841 """
1842 GetNativeFontInfoUserDesc(self) -> String
1843
1844 Returns a human readable version of `GetNativeFontInfoDesc`.
1845 """
54f9ee45 1846 return _gdi_.Font_GetNativeFontInfoUserDesc(*args, **kwargs)
e811c8ce
RD
1847
1848 def SetPointSize(*args, **kwargs):
a97cefba
RD
1849 """
1850 SetPointSize(self, int pointSize)
1851
1852 Sets the point size.
1853 """
54f9ee45 1854 return _gdi_.Font_SetPointSize(*args, **kwargs)
e811c8ce 1855
b6294124 1856 def SetPixelSize(*args, **kwargs):
a97cefba
RD
1857 """
1858 SetPixelSize(self, Size pixelSize)
1859
1860 Sets the size in pixels rather than points. If there is platform API
1861 support for this then it is used, otherwise a font with the closest
1862 size is found using a binary search.
1863 """
b6294124
RD
1864 return _gdi_.Font_SetPixelSize(*args, **kwargs)
1865
e811c8ce 1866 def SetFamily(*args, **kwargs):
a97cefba
RD
1867 """
1868 SetFamily(self, int family)
1869
1870 Sets the font family.
1871 """
54f9ee45 1872 return _gdi_.Font_SetFamily(*args, **kwargs)
e811c8ce
RD
1873
1874 def SetStyle(*args, **kwargs):
a97cefba
RD
1875 """
1876 SetStyle(self, int style)
1877
1878 Sets the font style.
1879 """
54f9ee45 1880 return _gdi_.Font_SetStyle(*args, **kwargs)
e811c8ce
RD
1881
1882 def SetWeight(*args, **kwargs):
a97cefba
RD
1883 """
1884 SetWeight(self, int weight)
1885
1886 Sets the font weight.
1887 """
54f9ee45 1888 return _gdi_.Font_SetWeight(*args, **kwargs)
e811c8ce
RD
1889
1890 def SetFaceName(*args, **kwargs):
a97cefba
RD
1891 """
1892 SetFaceName(self, String faceName)
1893
1894 Sets the facename for the font. The facename, which should be a valid
1895 font installed on the end-user's system.
1896
1897 To avoid portability problems, don't rely on a specific face, but
1898 specify the font family instead or as well. A suitable font will be
1899 found on the end-user's system. If both the family and the facename
1900 are specified, wxWidgets will first search for the specific face, and
1901 then for a font belonging to the same family.
1902 """
54f9ee45 1903 return _gdi_.Font_SetFaceName(*args, **kwargs)
e811c8ce
RD
1904
1905 def SetUnderlined(*args, **kwargs):
a97cefba
RD
1906 """
1907 SetUnderlined(self, bool underlined)
1908
1909 Sets underlining.
1910 """
54f9ee45 1911 return _gdi_.Font_SetUnderlined(*args, **kwargs)
e811c8ce
RD
1912
1913 def SetEncoding(*args, **kwargs):
a97cefba
RD
1914 """
1915 SetEncoding(self, int encoding)
1916
1917 Set the font encoding.
1918 """
54f9ee45 1919 return _gdi_.Font_SetEncoding(*args, **kwargs)
e811c8ce
RD
1920
1921 def SetNativeFontInfo(*args, **kwargs):
a97cefba
RD
1922 """
1923 SetNativeFontInfo(self, NativeFontInfo info)
1924
1925 Set the font's attributes from a `wx.NativeFontInfo` object.
1926 """
54f9ee45 1927 return _gdi_.Font_SetNativeFontInfo(*args, **kwargs)
e811c8ce
RD
1928
1929 def SetNativeFontInfoFromString(*args, **kwargs):
a97cefba
RD
1930 """
1931 SetNativeFontInfoFromString(self, String info)
1932
1933 Set the font's attributes from string representation of a
1934 `wx.NativeFontInfo` object.
1935 """
54f9ee45 1936 return _gdi_.Font_SetNativeFontInfoFromString(*args, **kwargs)
e811c8ce
RD
1937
1938 def SetNativeFontInfoUserDesc(*args, **kwargs):
a97cefba
RD
1939 """
1940 SetNativeFontInfoUserDesc(self, String info)
1941
1942 Set the font's attributes from a string formerly returned from
1943 `GetNativeFontInfoDesc`.
1944 """
54f9ee45 1945 return _gdi_.Font_SetNativeFontInfoUserDesc(*args, **kwargs)
e811c8ce
RD
1946
1947 def GetFamilyString(*args, **kwargs):
a97cefba
RD
1948 """
1949 GetFamilyString(self) -> String
1950
1951 Returns a string representation of the font family.
1952 """
54f9ee45 1953 return _gdi_.Font_GetFamilyString(*args, **kwargs)
e811c8ce
RD
1954
1955 def GetStyleString(*args, **kwargs):
a97cefba
RD
1956 """
1957 GetStyleString(self) -> String
1958
1959 Returns a string representation of the font style.
1960 """
54f9ee45 1961 return _gdi_.Font_GetStyleString(*args, **kwargs)
e811c8ce
RD
1962
1963 def GetWeightString(*args, **kwargs):
a97cefba
RD
1964 """
1965 GetWeightString(self) -> String
1966
1967 Return a string representation of the font weight.
1968 """
54f9ee45 1969 return _gdi_.Font_GetWeightString(*args, **kwargs)
e811c8ce
RD
1970
1971 def SetNoAntiAliasing(*args, **kwargs):
a95a7133 1972 """SetNoAntiAliasing(self, bool no=True)"""
54f9ee45 1973 return _gdi_.Font_SetNoAntiAliasing(*args, **kwargs)
e811c8ce
RD
1974
1975 def GetNoAntiAliasing(*args, **kwargs):
a95a7133 1976 """GetNoAntiAliasing(self) -> bool"""
54f9ee45 1977 return _gdi_.Font_GetNoAntiAliasing(*args, **kwargs)
e811c8ce
RD
1978
1979 def GetDefaultEncoding(*args, **kwargs):
a97cefba
RD
1980 """
1981 GetDefaultEncoding() -> int
1982
1983 Returns the encoding used for all fonts created with an encoding of
1984 ``wx.FONTENCODING_DEFAULT``.
1985 """
54f9ee45 1986 return _gdi_.Font_GetDefaultEncoding(*args, **kwargs)
e811c8ce
RD
1987
1988 GetDefaultEncoding = staticmethod(GetDefaultEncoding)
1989 def SetDefaultEncoding(*args, **kwargs):
a97cefba
RD
1990 """
1991 SetDefaultEncoding(int encoding)
1992
1993 Sets the default font encoding.
1994 """
54f9ee45 1995 return _gdi_.Font_SetDefaultEncoding(*args, **kwargs)
e811c8ce
RD
1996
1997 SetDefaultEncoding = staticmethod(SetDefaultEncoding)
d14a1e28
RD
1998
1999class FontPtr(Font):
2000 def __init__(self, this):
5e40f9dd 2001 self.this = this
d14a1e28
RD
2002 if not hasattr(self,"thisown"): self.thisown = 0
2003 self.__class__ = Font
54f9ee45 2004_gdi_.Font_swigregister(FontPtr)
5e40f9dd 2005
d14a1e28 2006def FontFromNativeInfo(*args, **kwargs):
a97cefba
RD
2007 """
2008 FontFromNativeInfo(NativeFontInfo info) -> Font
2009
2010 Construct a `wx.Font` from a `wx.NativeFontInfo` object.
2011 """
db3e571a 2012 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
54f9ee45 2013 val = _gdi_.new_FontFromNativeInfo(*args, **kwargs)
d14a1e28
RD
2014 val.thisown = 1
2015 return val
5e40f9dd 2016
d14a1e28 2017def FontFromNativeInfoString(*args, **kwargs):
a97cefba
RD
2018 """
2019 FontFromNativeInfoString(String info) -> Font
2020
2021 Construct a `wx.Font` from the string representation of a
2022 `wx.NativeFontInfo` object.
2023 """
db3e571a 2024 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
54f9ee45 2025 val = _gdi_.new_FontFromNativeInfoString(*args, **kwargs)
d14a1e28
RD
2026 val.thisown = 1
2027 return val
5e40f9dd 2028
73c8ef6a 2029def FFont(*args, **kwargs):
0df68c9f 2030 """
73c8ef6a 2031 FFont(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
196addbf 2032 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
a97cefba
RD
2033
2034 A bit of a simpler way to create a `wx.Font` using flags instead of
2035 individual attribute settings. The value of flags can be a
2036 combination of the following:
2037
2038 ============================ ==
2039 wx.FONTFLAG_DEFAULT
2040 wx.FONTFLAG_ITALIC
2041 wx.FONTFLAG_SLANT
2042 wx.FONTFLAG_LIGHT
2043 wx.FONTFLAG_BOLD
2044 wx.FONTFLAG_ANTIALIASED
2045 wx.FONTFLAG_NOT_ANTIALIASED
2046 wx.FONTFLAG_UNDERLINED
2047 wx.FONTFLAG_STRIKETHROUGH
2048 ============================ ==
2049
2050 :see: `wx.Font.__init__`
0df68c9f 2051 """
db3e571a 2052 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
73c8ef6a 2053 val = _gdi_.new_FFont(*args, **kwargs)
d14a1e28
RD
2054 val.thisown = 1
2055 return val
5e40f9dd 2056
b6294124
RD
2057def FontFromPixelSize(*args, **kwargs):
2058 """
2059 FontFromPixelSize(Size pixelSize, int family, int style, int weight,
2060 bool underlined=False, String face=wxEmptyString,
2061 int encoding=FONTENCODING_DEFAULT) -> Font
a97cefba
RD
2062
2063 Creates a font using a size in pixels rather than points. If there is
2064 platform API support for this then it is used, otherwise a font with
2065 the closest size is found using a binary search.
2066
2067 :see: `wx.Font.__init__`
b6294124
RD
2068 """
2069 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2070 val = _gdi_.new_FontFromPixelSize(*args, **kwargs)
2071 val.thisown = 1
2072 return val
2073
73c8ef6a
RD
2074def FFontFromPixelSize(*args, **kwargs):
2075 """
2076 FFontFromPixelSize(Size pixelSize, int family, int flags=FONTFLAG_DEFAULT,
2077 String face=wxEmptyString, int encoding=FONTENCODING_DEFAULT) -> Font
a97cefba
RD
2078
2079 Creates a font using a size in pixels rather than points. If there is
2080 platform API support for this then it is used, otherwise a font with
2081 the closest size is found using a binary search.
2082
2083 :see: `wx.Font.__init__`, `wx.FFont`
73c8ef6a
RD
2084 """
2085 if kwargs.has_key('faceName'): kwargs['face'] = kwargs['faceName'];del kwargs['faceName']
2086 val = _gdi_.new_FFontFromPixelSize(*args, **kwargs)
2087 val.thisown = 1
2088 return val
2089
e811c8ce 2090def Font_GetDefaultEncoding(*args, **kwargs):
a97cefba
RD
2091 """
2092 Font_GetDefaultEncoding() -> int
2093
2094 Returns the encoding used for all fonts created with an encoding of
2095 ``wx.FONTENCODING_DEFAULT``.
2096 """
54f9ee45 2097 return _gdi_.Font_GetDefaultEncoding(*args, **kwargs)
70551f47 2098
e811c8ce 2099def Font_SetDefaultEncoding(*args, **kwargs):
a97cefba
RD
2100 """
2101 Font_SetDefaultEncoding(int encoding)
2102
2103 Sets the default font encoding.
2104 """
54f9ee45 2105 return _gdi_.Font_SetDefaultEncoding(*args, **kwargs)
70551f47 2106
a97cefba 2107Font2 = wx._deprecated(FFont, "Use `wx.FFont` instead.")
d14a1e28 2108#---------------------------------------------------------------------------
70551f47 2109
d14a1e28 2110class FontEnumerator(object):
093d3ff1 2111 """Proxy of C++ FontEnumerator class"""
e811c8ce
RD
2112 def __repr__(self):
2113 return "<%s.%s; proxy of C++ wxPyFontEnumerator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
2114 def __init__(self, *args, **kwargs):
a95a7133 2115 """__init__(self) -> FontEnumerator"""
54f9ee45 2116 newobj = _gdi_.new_FontEnumerator(*args, **kwargs)
d14a1e28
RD
2117 self.this = newobj.this
2118 self.thisown = 1
2119 del newobj.thisown
2120 self._setCallbackInfo(self, FontEnumerator, 0)
e811c8ce 2121
54f9ee45 2122 def __del__(self, destroy=_gdi_.delete_FontEnumerator):
a95a7133 2123 """__del__(self)"""
d14a1e28
RD
2124 try:
2125 if self.thisown: destroy(self)
2126 except: pass
e811c8ce
RD
2127
2128 def _setCallbackInfo(*args, **kwargs):
a95a7133 2129 """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
54f9ee45 2130 return _gdi_.FontEnumerator__setCallbackInfo(*args, **kwargs)
e811c8ce
RD
2131
2132 def EnumerateFacenames(*args, **kwargs):
a95a7133 2133 """EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool"""
54f9ee45 2134 return _gdi_.FontEnumerator_EnumerateFacenames(*args, **kwargs)
e811c8ce
RD
2135
2136 def EnumerateEncodings(*args, **kwargs):
a95a7133 2137 """EnumerateEncodings(self, String facename=EmptyString) -> bool"""
54f9ee45 2138 return _gdi_.FontEnumerator_EnumerateEncodings(*args, **kwargs)
e811c8ce
RD
2139
2140 def GetEncodings(*args, **kwargs):
a95a7133 2141 """GetEncodings(self) -> PyObject"""
54f9ee45 2142 return _gdi_.FontEnumerator_GetEncodings(*args, **kwargs)
e811c8ce
RD
2143
2144 def GetFacenames(*args, **kwargs):
a95a7133 2145 """GetFacenames(self) -> PyObject"""
54f9ee45 2146 return _gdi_.FontEnumerator_GetFacenames(*args, **kwargs)
e811c8ce 2147
70551f47 2148
d14a1e28
RD
2149class FontEnumeratorPtr(FontEnumerator):
2150 def __init__(self, this):
5e40f9dd 2151 self.this = this
d14a1e28
RD
2152 if not hasattr(self,"thisown"): self.thisown = 0
2153 self.__class__ = FontEnumerator
54f9ee45 2154_gdi_.FontEnumerator_swigregister(FontEnumeratorPtr)
d14a1e28
RD
2155
2156#---------------------------------------------------------------------------
2157
54f9ee45
RD
2158LANGUAGE_DEFAULT = _gdi_.LANGUAGE_DEFAULT
2159LANGUAGE_UNKNOWN = _gdi_.LANGUAGE_UNKNOWN
2160LANGUAGE_ABKHAZIAN = _gdi_.LANGUAGE_ABKHAZIAN
2161LANGUAGE_AFAR = _gdi_.LANGUAGE_AFAR
2162LANGUAGE_AFRIKAANS = _gdi_.LANGUAGE_AFRIKAANS
2163LANGUAGE_ALBANIAN = _gdi_.LANGUAGE_ALBANIAN
2164LANGUAGE_AMHARIC = _gdi_.LANGUAGE_AMHARIC
2165LANGUAGE_ARABIC = _gdi_.LANGUAGE_ARABIC
2166LANGUAGE_ARABIC_ALGERIA = _gdi_.LANGUAGE_ARABIC_ALGERIA
2167LANGUAGE_ARABIC_BAHRAIN = _gdi_.LANGUAGE_ARABIC_BAHRAIN
2168LANGUAGE_ARABIC_EGYPT = _gdi_.LANGUAGE_ARABIC_EGYPT
2169LANGUAGE_ARABIC_IRAQ = _gdi_.LANGUAGE_ARABIC_IRAQ
2170LANGUAGE_ARABIC_JORDAN = _gdi_.LANGUAGE_ARABIC_JORDAN
2171LANGUAGE_ARABIC_KUWAIT = _gdi_.LANGUAGE_ARABIC_KUWAIT
2172LANGUAGE_ARABIC_LEBANON = _gdi_.LANGUAGE_ARABIC_LEBANON
2173LANGUAGE_ARABIC_LIBYA = _gdi_.LANGUAGE_ARABIC_LIBYA
2174LANGUAGE_ARABIC_MOROCCO = _gdi_.LANGUAGE_ARABIC_MOROCCO
2175LANGUAGE_ARABIC_OMAN = _gdi_.LANGUAGE_ARABIC_OMAN
2176LANGUAGE_ARABIC_QATAR = _gdi_.LANGUAGE_ARABIC_QATAR
2177LANGUAGE_ARABIC_SAUDI_ARABIA = _gdi_.LANGUAGE_ARABIC_SAUDI_ARABIA
2178LANGUAGE_ARABIC_SUDAN = _gdi_.LANGUAGE_ARABIC_SUDAN
2179LANGUAGE_ARABIC_SYRIA = _gdi_.LANGUAGE_ARABIC_SYRIA
2180LANGUAGE_ARABIC_TUNISIA = _gdi_.LANGUAGE_ARABIC_TUNISIA
2181LANGUAGE_ARABIC_UAE = _gdi_.LANGUAGE_ARABIC_UAE
2182LANGUAGE_ARABIC_YEMEN = _gdi_.LANGUAGE_ARABIC_YEMEN
2183LANGUAGE_ARMENIAN = _gdi_.LANGUAGE_ARMENIAN
2184LANGUAGE_ASSAMESE = _gdi_.LANGUAGE_ASSAMESE
2185LANGUAGE_AYMARA = _gdi_.LANGUAGE_AYMARA
2186LANGUAGE_AZERI = _gdi_.LANGUAGE_AZERI
2187LANGUAGE_AZERI_CYRILLIC = _gdi_.LANGUAGE_AZERI_CYRILLIC
2188LANGUAGE_AZERI_LATIN = _gdi_.LANGUAGE_AZERI_LATIN
2189LANGUAGE_BASHKIR = _gdi_.LANGUAGE_BASHKIR
2190LANGUAGE_BASQUE = _gdi_.LANGUAGE_BASQUE
2191LANGUAGE_BELARUSIAN = _gdi_.LANGUAGE_BELARUSIAN
2192LANGUAGE_BENGALI = _gdi_.LANGUAGE_BENGALI
2193LANGUAGE_BHUTANI = _gdi_.LANGUAGE_BHUTANI
2194LANGUAGE_BIHARI = _gdi_.LANGUAGE_BIHARI
2195LANGUAGE_BISLAMA = _gdi_.LANGUAGE_BISLAMA
2196LANGUAGE_BRETON = _gdi_.LANGUAGE_BRETON
2197LANGUAGE_BULGARIAN = _gdi_.LANGUAGE_BULGARIAN
2198LANGUAGE_BURMESE = _gdi_.LANGUAGE_BURMESE
2199LANGUAGE_CAMBODIAN = _gdi_.LANGUAGE_CAMBODIAN
2200LANGUAGE_CATALAN = _gdi_.LANGUAGE_CATALAN
2201LANGUAGE_CHINESE = _gdi_.LANGUAGE_CHINESE
2202LANGUAGE_CHINESE_SIMPLIFIED = _gdi_.LANGUAGE_CHINESE_SIMPLIFIED
2203LANGUAGE_CHINESE_TRADITIONAL = _gdi_.LANGUAGE_CHINESE_TRADITIONAL
2204LANGUAGE_CHINESE_HONGKONG = _gdi_.LANGUAGE_CHINESE_HONGKONG
2205LANGUAGE_CHINESE_MACAU = _gdi_.LANGUAGE_CHINESE_MACAU
2206LANGUAGE_CHINESE_SINGAPORE = _gdi_.LANGUAGE_CHINESE_SINGAPORE
2207LANGUAGE_CHINESE_TAIWAN = _gdi_.LANGUAGE_CHINESE_TAIWAN
2208LANGUAGE_CORSICAN = _gdi_.LANGUAGE_CORSICAN
2209LANGUAGE_CROATIAN = _gdi_.LANGUAGE_CROATIAN
2210LANGUAGE_CZECH = _gdi_.LANGUAGE_CZECH
2211LANGUAGE_DANISH = _gdi_.LANGUAGE_DANISH
2212LANGUAGE_DUTCH = _gdi_.LANGUAGE_DUTCH
2213LANGUAGE_DUTCH_BELGIAN = _gdi_.LANGUAGE_DUTCH_BELGIAN
2214LANGUAGE_ENGLISH = _gdi_.LANGUAGE_ENGLISH
2215LANGUAGE_ENGLISH_UK = _gdi_.LANGUAGE_ENGLISH_UK
2216LANGUAGE_ENGLISH_US = _gdi_.LANGUAGE_ENGLISH_US
2217LANGUAGE_ENGLISH_AUSTRALIA = _gdi_.LANGUAGE_ENGLISH_AUSTRALIA
2218LANGUAGE_ENGLISH_BELIZE = _gdi_.LANGUAGE_ENGLISH_BELIZE
2219LANGUAGE_ENGLISH_BOTSWANA = _gdi_.LANGUAGE_ENGLISH_BOTSWANA
2220LANGUAGE_ENGLISH_CANADA = _gdi_.LANGUAGE_ENGLISH_CANADA
2221LANGUAGE_ENGLISH_CARIBBEAN = _gdi_.LANGUAGE_ENGLISH_CARIBBEAN
2222LANGUAGE_ENGLISH_DENMARK = _gdi_.LANGUAGE_ENGLISH_DENMARK
2223LANGUAGE_ENGLISH_EIRE = _gdi_.LANGUAGE_ENGLISH_EIRE
2224LANGUAGE_ENGLISH_JAMAICA = _gdi_.LANGUAGE_ENGLISH_JAMAICA
2225LANGUAGE_ENGLISH_NEW_ZEALAND = _gdi_.LANGUAGE_ENGLISH_NEW_ZEALAND
2226LANGUAGE_ENGLISH_PHILIPPINES = _gdi_.LANGUAGE_ENGLISH_PHILIPPINES
2227LANGUAGE_ENGLISH_SOUTH_AFRICA = _gdi_.LANGUAGE_ENGLISH_SOUTH_AFRICA
2228LANGUAGE_ENGLISH_TRINIDAD = _gdi_.LANGUAGE_ENGLISH_TRINIDAD
2229LANGUAGE_ENGLISH_ZIMBABWE = _gdi_.LANGUAGE_ENGLISH_ZIMBABWE
2230LANGUAGE_ESPERANTO = _gdi_.LANGUAGE_ESPERANTO
2231LANGUAGE_ESTONIAN = _gdi_.LANGUAGE_ESTONIAN
2232LANGUAGE_FAEROESE = _gdi_.LANGUAGE_FAEROESE
2233LANGUAGE_FARSI = _gdi_.LANGUAGE_FARSI
2234LANGUAGE_FIJI = _gdi_.LANGUAGE_FIJI
2235LANGUAGE_FINNISH = _gdi_.LANGUAGE_FINNISH
2236LANGUAGE_FRENCH = _gdi_.LANGUAGE_FRENCH
2237LANGUAGE_FRENCH_BELGIAN = _gdi_.LANGUAGE_FRENCH_BELGIAN
2238LANGUAGE_FRENCH_CANADIAN = _gdi_.LANGUAGE_FRENCH_CANADIAN
2239LANGUAGE_FRENCH_LUXEMBOURG = _gdi_.LANGUAGE_FRENCH_LUXEMBOURG
2240LANGUAGE_FRENCH_MONACO = _gdi_.LANGUAGE_FRENCH_MONACO
2241LANGUAGE_FRENCH_SWISS = _gdi_.LANGUAGE_FRENCH_SWISS
2242LANGUAGE_FRISIAN = _gdi_.LANGUAGE_FRISIAN
2243LANGUAGE_GALICIAN = _gdi_.LANGUAGE_GALICIAN
2244LANGUAGE_GEORGIAN = _gdi_.LANGUAGE_GEORGIAN
2245LANGUAGE_GERMAN = _gdi_.LANGUAGE_GERMAN
2246LANGUAGE_GERMAN_AUSTRIAN = _gdi_.LANGUAGE_GERMAN_AUSTRIAN
2247LANGUAGE_GERMAN_BELGIUM = _gdi_.LANGUAGE_GERMAN_BELGIUM
2248LANGUAGE_GERMAN_LIECHTENSTEIN = _gdi_.LANGUAGE_GERMAN_LIECHTENSTEIN
2249LANGUAGE_GERMAN_LUXEMBOURG = _gdi_.LANGUAGE_GERMAN_LUXEMBOURG
2250LANGUAGE_GERMAN_SWISS = _gdi_.LANGUAGE_GERMAN_SWISS
2251LANGUAGE_GREEK = _gdi_.LANGUAGE_GREEK
2252LANGUAGE_GREENLANDIC = _gdi_.LANGUAGE_GREENLANDIC
2253LANGUAGE_GUARANI = _gdi_.LANGUAGE_GUARANI
2254LANGUAGE_GUJARATI = _gdi_.LANGUAGE_GUJARATI
2255LANGUAGE_HAUSA = _gdi_.LANGUAGE_HAUSA
2256LANGUAGE_HEBREW = _gdi_.LANGUAGE_HEBREW
2257LANGUAGE_HINDI = _gdi_.LANGUAGE_HINDI
2258LANGUAGE_HUNGARIAN = _gdi_.LANGUAGE_HUNGARIAN
2259LANGUAGE_ICELANDIC = _gdi_.LANGUAGE_ICELANDIC
2260LANGUAGE_INDONESIAN = _gdi_.LANGUAGE_INDONESIAN
2261LANGUAGE_INTERLINGUA = _gdi_.LANGUAGE_INTERLINGUA
2262LANGUAGE_INTERLINGUE = _gdi_.LANGUAGE_INTERLINGUE
2263LANGUAGE_INUKTITUT = _gdi_.LANGUAGE_INUKTITUT
2264LANGUAGE_INUPIAK = _gdi_.LANGUAGE_INUPIAK
2265LANGUAGE_IRISH = _gdi_.LANGUAGE_IRISH
2266LANGUAGE_ITALIAN = _gdi_.LANGUAGE_ITALIAN
2267LANGUAGE_ITALIAN_SWISS = _gdi_.LANGUAGE_ITALIAN_SWISS
2268LANGUAGE_JAPANESE = _gdi_.LANGUAGE_JAPANESE
2269LANGUAGE_JAVANESE = _gdi_.LANGUAGE_JAVANESE
2270LANGUAGE_KANNADA = _gdi_.LANGUAGE_KANNADA
2271LANGUAGE_KASHMIRI = _gdi_.LANGUAGE_KASHMIRI
2272LANGUAGE_KASHMIRI_INDIA = _gdi_.LANGUAGE_KASHMIRI_INDIA
2273LANGUAGE_KAZAKH = _gdi_.LANGUAGE_KAZAKH
2274LANGUAGE_KERNEWEK = _gdi_.LANGUAGE_KERNEWEK
2275LANGUAGE_KINYARWANDA = _gdi_.LANGUAGE_KINYARWANDA
2276LANGUAGE_KIRGHIZ = _gdi_.LANGUAGE_KIRGHIZ
2277LANGUAGE_KIRUNDI = _gdi_.LANGUAGE_KIRUNDI
2278LANGUAGE_KONKANI = _gdi_.LANGUAGE_KONKANI
2279LANGUAGE_KOREAN = _gdi_.LANGUAGE_KOREAN
2280LANGUAGE_KURDISH = _gdi_.LANGUAGE_KURDISH
2281LANGUAGE_LAOTHIAN = _gdi_.LANGUAGE_LAOTHIAN
2282LANGUAGE_LATIN = _gdi_.LANGUAGE_LATIN
2283LANGUAGE_LATVIAN = _gdi_.LANGUAGE_LATVIAN
2284LANGUAGE_LINGALA = _gdi_.LANGUAGE_LINGALA
2285LANGUAGE_LITHUANIAN = _gdi_.LANGUAGE_LITHUANIAN
2286LANGUAGE_MACEDONIAN = _gdi_.LANGUAGE_MACEDONIAN
2287LANGUAGE_MALAGASY = _gdi_.LANGUAGE_MALAGASY
2288LANGUAGE_MALAY = _gdi_.LANGUAGE_MALAY
2289LANGUAGE_MALAYALAM = _gdi_.LANGUAGE_MALAYALAM
2290LANGUAGE_MALAY_BRUNEI_DARUSSALAM = _gdi_.LANGUAGE_MALAY_BRUNEI_DARUSSALAM
2291LANGUAGE_MALAY_MALAYSIA = _gdi_.LANGUAGE_MALAY_MALAYSIA
2292LANGUAGE_MALTESE = _gdi_.LANGUAGE_MALTESE
2293LANGUAGE_MANIPURI = _gdi_.LANGUAGE_MANIPURI
2294LANGUAGE_MAORI = _gdi_.LANGUAGE_MAORI
2295LANGUAGE_MARATHI = _gdi_.LANGUAGE_MARATHI
2296LANGUAGE_MOLDAVIAN = _gdi_.LANGUAGE_MOLDAVIAN
2297LANGUAGE_MONGOLIAN = _gdi_.LANGUAGE_MONGOLIAN
2298LANGUAGE_NAURU = _gdi_.LANGUAGE_NAURU
2299LANGUAGE_NEPALI = _gdi_.LANGUAGE_NEPALI
2300LANGUAGE_NEPALI_INDIA = _gdi_.LANGUAGE_NEPALI_INDIA
2301LANGUAGE_NORWEGIAN_BOKMAL = _gdi_.LANGUAGE_NORWEGIAN_BOKMAL
2302LANGUAGE_NORWEGIAN_NYNORSK = _gdi_.LANGUAGE_NORWEGIAN_NYNORSK
2303LANGUAGE_OCCITAN = _gdi_.LANGUAGE_OCCITAN
2304LANGUAGE_ORIYA = _gdi_.LANGUAGE_ORIYA
2305LANGUAGE_OROMO = _gdi_.LANGUAGE_OROMO
2306LANGUAGE_PASHTO = _gdi_.LANGUAGE_PASHTO
2307LANGUAGE_POLISH = _gdi_.LANGUAGE_POLISH
2308LANGUAGE_PORTUGUESE = _gdi_.LANGUAGE_PORTUGUESE
2309LANGUAGE_PORTUGUESE_BRAZILIAN = _gdi_.LANGUAGE_PORTUGUESE_BRAZILIAN
2310LANGUAGE_PUNJABI = _gdi_.LANGUAGE_PUNJABI
2311LANGUAGE_QUECHUA = _gdi_.LANGUAGE_QUECHUA
2312LANGUAGE_RHAETO_ROMANCE = _gdi_.LANGUAGE_RHAETO_ROMANCE
2313LANGUAGE_ROMANIAN = _gdi_.LANGUAGE_ROMANIAN
2314LANGUAGE_RUSSIAN = _gdi_.LANGUAGE_RUSSIAN
2315LANGUAGE_RUSSIAN_UKRAINE = _gdi_.LANGUAGE_RUSSIAN_UKRAINE
2316LANGUAGE_SAMOAN = _gdi_.LANGUAGE_SAMOAN
2317LANGUAGE_SANGHO = _gdi_.LANGUAGE_SANGHO
2318LANGUAGE_SANSKRIT = _gdi_.LANGUAGE_SANSKRIT
2319LANGUAGE_SCOTS_GAELIC = _gdi_.LANGUAGE_SCOTS_GAELIC
2320LANGUAGE_SERBIAN = _gdi_.LANGUAGE_SERBIAN
2321LANGUAGE_SERBIAN_CYRILLIC = _gdi_.LANGUAGE_SERBIAN_CYRILLIC
2322LANGUAGE_SERBIAN_LATIN = _gdi_.LANGUAGE_SERBIAN_LATIN
2323LANGUAGE_SERBO_CROATIAN = _gdi_.LANGUAGE_SERBO_CROATIAN
2324LANGUAGE_SESOTHO = _gdi_.LANGUAGE_SESOTHO
2325LANGUAGE_SETSWANA = _gdi_.LANGUAGE_SETSWANA
2326LANGUAGE_SHONA = _gdi_.LANGUAGE_SHONA
2327LANGUAGE_SINDHI = _gdi_.LANGUAGE_SINDHI
2328LANGUAGE_SINHALESE = _gdi_.LANGUAGE_SINHALESE
2329LANGUAGE_SISWATI = _gdi_.LANGUAGE_SISWATI
2330LANGUAGE_SLOVAK = _gdi_.LANGUAGE_SLOVAK
2331LANGUAGE_SLOVENIAN = _gdi_.LANGUAGE_SLOVENIAN
2332LANGUAGE_SOMALI = _gdi_.LANGUAGE_SOMALI
2333LANGUAGE_SPANISH = _gdi_.LANGUAGE_SPANISH
2334LANGUAGE_SPANISH_ARGENTINA = _gdi_.LANGUAGE_SPANISH_ARGENTINA
2335LANGUAGE_SPANISH_BOLIVIA = _gdi_.LANGUAGE_SPANISH_BOLIVIA
2336LANGUAGE_SPANISH_CHILE = _gdi_.LANGUAGE_SPANISH_CHILE
2337LANGUAGE_SPANISH_COLOMBIA = _gdi_.LANGUAGE_SPANISH_COLOMBIA
2338LANGUAGE_SPANISH_COSTA_RICA = _gdi_.LANGUAGE_SPANISH_COSTA_RICA
2339LANGUAGE_SPANISH_DOMINICAN_REPUBLIC = _gdi_.LANGUAGE_SPANISH_DOMINICAN_REPUBLIC
2340LANGUAGE_SPANISH_ECUADOR = _gdi_.LANGUAGE_SPANISH_ECUADOR
2341LANGUAGE_SPANISH_EL_SALVADOR = _gdi_.LANGUAGE_SPANISH_EL_SALVADOR
2342LANGUAGE_SPANISH_GUATEMALA = _gdi_.LANGUAGE_SPANISH_GUATEMALA
2343LANGUAGE_SPANISH_HONDURAS = _gdi_.LANGUAGE_SPANISH_HONDURAS
2344LANGUAGE_SPANISH_MEXICAN = _gdi_.LANGUAGE_SPANISH_MEXICAN
2345LANGUAGE_SPANISH_MODERN = _gdi_.LANGUAGE_SPANISH_MODERN
2346LANGUAGE_SPANISH_NICARAGUA = _gdi_.LANGUAGE_SPANISH_NICARAGUA
2347LANGUAGE_SPANISH_PANAMA = _gdi_.LANGUAGE_SPANISH_PANAMA
2348LANGUAGE_SPANISH_PARAGUAY = _gdi_.LANGUAGE_SPANISH_PARAGUAY
2349LANGUAGE_SPANISH_PERU = _gdi_.LANGUAGE_SPANISH_PERU
2350LANGUAGE_SPANISH_PUERTO_RICO = _gdi_.LANGUAGE_SPANISH_PUERTO_RICO
2351LANGUAGE_SPANISH_URUGUAY = _gdi_.LANGUAGE_SPANISH_URUGUAY
2352LANGUAGE_SPANISH_US = _gdi_.LANGUAGE_SPANISH_US
2353LANGUAGE_SPANISH_VENEZUELA = _gdi_.LANGUAGE_SPANISH_VENEZUELA
2354LANGUAGE_SUNDANESE = _gdi_.LANGUAGE_SUNDANESE
2355LANGUAGE_SWAHILI = _gdi_.LANGUAGE_SWAHILI
2356LANGUAGE_SWEDISH = _gdi_.LANGUAGE_SWEDISH
2357LANGUAGE_SWEDISH_FINLAND = _gdi_.LANGUAGE_SWEDISH_FINLAND
2358LANGUAGE_TAGALOG = _gdi_.LANGUAGE_TAGALOG
2359LANGUAGE_TAJIK = _gdi_.LANGUAGE_TAJIK
2360LANGUAGE_TAMIL = _gdi_.LANGUAGE_TAMIL
2361LANGUAGE_TATAR = _gdi_.LANGUAGE_TATAR
2362LANGUAGE_TELUGU = _gdi_.LANGUAGE_TELUGU
2363LANGUAGE_THAI = _gdi_.LANGUAGE_THAI
2364LANGUAGE_TIBETAN = _gdi_.LANGUAGE_TIBETAN
2365LANGUAGE_TIGRINYA = _gdi_.LANGUAGE_TIGRINYA
2366LANGUAGE_TONGA = _gdi_.LANGUAGE_TONGA
2367LANGUAGE_TSONGA = _gdi_.LANGUAGE_TSONGA
2368LANGUAGE_TURKISH = _gdi_.LANGUAGE_TURKISH
2369LANGUAGE_TURKMEN = _gdi_.LANGUAGE_TURKMEN
2370LANGUAGE_TWI = _gdi_.LANGUAGE_TWI
2371LANGUAGE_UIGHUR = _gdi_.LANGUAGE_UIGHUR
2372LANGUAGE_UKRAINIAN = _gdi_.LANGUAGE_UKRAINIAN
2373LANGUAGE_URDU = _gdi_.LANGUAGE_URDU
2374LANGUAGE_URDU_INDIA = _gdi_.LANGUAGE_URDU_INDIA
2375LANGUAGE_URDU_PAKISTAN = _gdi_.LANGUAGE_URDU_PAKISTAN
2376LANGUAGE_UZBEK = _gdi_.LANGUAGE_UZBEK
2377LANGUAGE_UZBEK_CYRILLIC = _gdi_.LANGUAGE_UZBEK_CYRILLIC
2378LANGUAGE_UZBEK_LATIN = _gdi_.LANGUAGE_UZBEK_LATIN
2379LANGUAGE_VIETNAMESE = _gdi_.LANGUAGE_VIETNAMESE
2380LANGUAGE_VOLAPUK = _gdi_.LANGUAGE_VOLAPUK
2381LANGUAGE_WELSH = _gdi_.LANGUAGE_WELSH
2382LANGUAGE_WOLOF = _gdi_.LANGUAGE_WOLOF
2383LANGUAGE_XHOSA = _gdi_.LANGUAGE_XHOSA
2384LANGUAGE_YIDDISH = _gdi_.LANGUAGE_YIDDISH
2385LANGUAGE_YORUBA = _gdi_.LANGUAGE_YORUBA
2386LANGUAGE_ZHUANG = _gdi_.LANGUAGE_ZHUANG
2387LANGUAGE_ZULU = _gdi_.LANGUAGE_ZULU
2388LANGUAGE_USER_DEFINED = _gdi_.LANGUAGE_USER_DEFINED
d14a1e28 2389class LanguageInfo(object):
093d3ff1 2390 """Proxy of C++ LanguageInfo class"""
d14a1e28 2391 def __init__(self): raise RuntimeError, "No constructor defined"
5e40f9dd 2392 def __repr__(self):
d14a1e28 2393 return "<%s.%s; proxy of C++ wxLanguageInfo instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45
RD
2394 Language = property(_gdi_.LanguageInfo_Language_get, _gdi_.LanguageInfo_Language_set)
2395 CanonicalName = property(_gdi_.LanguageInfo_CanonicalName_get, _gdi_.LanguageInfo_CanonicalName_set)
2396 Description = property(_gdi_.LanguageInfo_Description_get, _gdi_.LanguageInfo_Description_set)
d14a1e28
RD
2397
2398class LanguageInfoPtr(LanguageInfo):
2399 def __init__(self, this):
5e40f9dd 2400 self.this = this
d14a1e28
RD
2401 if not hasattr(self,"thisown"): self.thisown = 0
2402 self.__class__ = LanguageInfo
54f9ee45
RD
2403_gdi_.LanguageInfo_swigregister(LanguageInfoPtr)
2404
2405LOCALE_CAT_NUMBER = _gdi_.LOCALE_CAT_NUMBER
2406LOCALE_CAT_DATE = _gdi_.LOCALE_CAT_DATE
2407LOCALE_CAT_MONEY = _gdi_.LOCALE_CAT_MONEY
2408LOCALE_CAT_MAX = _gdi_.LOCALE_CAT_MAX
2409LOCALE_THOUSANDS_SEP = _gdi_.LOCALE_THOUSANDS_SEP
2410LOCALE_DECIMAL_POINT = _gdi_.LOCALE_DECIMAL_POINT
2411LOCALE_LOAD_DEFAULT = _gdi_.LOCALE_LOAD_DEFAULT
2412LOCALE_CONV_ENCODING = _gdi_.LOCALE_CONV_ENCODING
d14a1e28 2413class Locale(object):
093d3ff1 2414 """Proxy of C++ Locale class"""
e811c8ce
RD
2415 def __repr__(self):
2416 return "<%s.%s; proxy of C++ wxLocale instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2417 def __init__(self, *args, **kwargs):
41e2b43e 2418 """__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale"""
54f9ee45 2419 newobj = _gdi_.new_Locale(*args, **kwargs)
d14a1e28
RD
2420 self.this = newobj.this
2421 self.thisown = 1
2422 del newobj.thisown
54f9ee45 2423 def __del__(self, destroy=_gdi_.delete_Locale):
a95a7133 2424 """__del__(self)"""
d14a1e28
RD
2425 try:
2426 if self.thisown: destroy(self)
2427 except: pass
e811c8ce
RD
2428
2429 def Init1(*args, **kwargs):
0df68c9f 2430 """
a95a7133 2431 Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
196addbf 2432 bool bLoadDefault=True,
0df68c9f
RD
2433 bool bConvertEncoding=False) -> bool
2434 """
54f9ee45 2435 return _gdi_.Locale_Init1(*args, **kwargs)
e811c8ce
RD
2436
2437 def Init2(*args, **kwargs):
a95a7133 2438 """Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool"""
54f9ee45 2439 return _gdi_.Locale_Init2(*args, **kwargs)
e811c8ce 2440
d14a1e28
RD
2441 def Init(self, *_args, **_kwargs):
2442 if type(_args[0]) in [type(''), type(u'')]:
2443 val = self.Init1(*_args, **_kwargs)
2444 else:
2445 val = self.Init2(*_args, **_kwargs)
2446 return val
2447
e811c8ce 2448 def GetSystemLanguage(*args, **kwargs):
66c033b4 2449 """GetSystemLanguage() -> int"""
54f9ee45 2450 return _gdi_.Locale_GetSystemLanguage(*args, **kwargs)
e811c8ce
RD
2451
2452 GetSystemLanguage = staticmethod(GetSystemLanguage)
2453 def GetSystemEncoding(*args, **kwargs):
66c033b4 2454 """GetSystemEncoding() -> int"""
54f9ee45 2455 return _gdi_.Locale_GetSystemEncoding(*args, **kwargs)
e811c8ce
RD
2456
2457 GetSystemEncoding = staticmethod(GetSystemEncoding)
2458 def GetSystemEncodingName(*args, **kwargs):
66c033b4 2459 """GetSystemEncodingName() -> String"""
54f9ee45 2460 return _gdi_.Locale_GetSystemEncodingName(*args, **kwargs)
e811c8ce
RD
2461
2462 GetSystemEncodingName = staticmethod(GetSystemEncodingName)
2463 def IsOk(*args, **kwargs):
a95a7133 2464 """IsOk(self) -> bool"""
54f9ee45 2465 return _gdi_.Locale_IsOk(*args, **kwargs)
e811c8ce 2466
d14a1e28 2467 def __nonzero__(self): return self.IsOk()
e811c8ce 2468 def GetLocale(*args, **kwargs):
a95a7133 2469 """GetLocale(self) -> String"""
54f9ee45 2470 return _gdi_.Locale_GetLocale(*args, **kwargs)
e811c8ce
RD
2471
2472 def GetLanguage(*args, **kwargs):
a95a7133 2473 """GetLanguage(self) -> int"""
54f9ee45 2474 return _gdi_.Locale_GetLanguage(*args, **kwargs)
e811c8ce
RD
2475
2476 def GetSysName(*args, **kwargs):
a95a7133 2477 """GetSysName(self) -> String"""
54f9ee45 2478 return _gdi_.Locale_GetSysName(*args, **kwargs)
e811c8ce
RD
2479
2480 def GetCanonicalName(*args, **kwargs):
a95a7133 2481 """GetCanonicalName(self) -> String"""
54f9ee45 2482 return _gdi_.Locale_GetCanonicalName(*args, **kwargs)
e811c8ce
RD
2483
2484 def AddCatalogLookupPathPrefix(*args, **kwargs):
66c033b4 2485 """AddCatalogLookupPathPrefix(String prefix)"""
54f9ee45 2486 return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs)
e811c8ce
RD
2487
2488 AddCatalogLookupPathPrefix = staticmethod(AddCatalogLookupPathPrefix)
2489 def AddCatalog(*args, **kwargs):
a95a7133 2490 """AddCatalog(self, String szDomain) -> bool"""
54f9ee45 2491 return _gdi_.Locale_AddCatalog(*args, **kwargs)
e811c8ce
RD
2492
2493 def IsLoaded(*args, **kwargs):
a95a7133 2494 """IsLoaded(self, String szDomain) -> bool"""
54f9ee45 2495 return _gdi_.Locale_IsLoaded(*args, **kwargs)
e811c8ce
RD
2496
2497 def GetLanguageInfo(*args, **kwargs):
66c033b4 2498 """GetLanguageInfo(int lang) -> LanguageInfo"""
54f9ee45 2499 return _gdi_.Locale_GetLanguageInfo(*args, **kwargs)
e811c8ce
RD
2500
2501 GetLanguageInfo = staticmethod(GetLanguageInfo)
2502 def GetLanguageName(*args, **kwargs):
66c033b4 2503 """GetLanguageName(int lang) -> String"""
54f9ee45 2504 return _gdi_.Locale_GetLanguageName(*args, **kwargs)
e811c8ce
RD
2505
2506 GetLanguageName = staticmethod(GetLanguageName)
2507 def FindLanguageInfo(*args, **kwargs):
66c033b4 2508 """FindLanguageInfo(String locale) -> LanguageInfo"""
54f9ee45 2509 return _gdi_.Locale_FindLanguageInfo(*args, **kwargs)
e811c8ce
RD
2510
2511 FindLanguageInfo = staticmethod(FindLanguageInfo)
2512 def AddLanguage(*args, **kwargs):
66c033b4 2513 """AddLanguage(LanguageInfo info)"""
54f9ee45 2514 return _gdi_.Locale_AddLanguage(*args, **kwargs)
e811c8ce
RD
2515
2516 AddLanguage = staticmethod(AddLanguage)
2517 def GetString(*args, **kwargs):
a95a7133 2518 """GetString(self, String szOrigString, String szDomain=EmptyString) -> String"""
54f9ee45 2519 return _gdi_.Locale_GetString(*args, **kwargs)
e811c8ce
RD
2520
2521 def GetName(*args, **kwargs):
a95a7133 2522 """GetName(self) -> String"""
54f9ee45 2523 return _gdi_.Locale_GetName(*args, **kwargs)
e811c8ce 2524
5e40f9dd 2525
d14a1e28
RD
2526class LocalePtr(Locale):
2527 def __init__(self, this):
2528 self.this = this
2529 if not hasattr(self,"thisown"): self.thisown = 0
2530 self.__class__ = Locale
54f9ee45 2531_gdi_.Locale_swigregister(LocalePtr)
5e40f9dd 2532
e811c8ce
RD
2533def Locale_GetSystemLanguage(*args, **kwargs):
2534 """Locale_GetSystemLanguage() -> int"""
54f9ee45 2535 return _gdi_.Locale_GetSystemLanguage(*args, **kwargs)
5e40f9dd 2536
e811c8ce 2537def Locale_GetSystemEncoding(*args, **kwargs):
196addbf 2538 """Locale_GetSystemEncoding() -> int"""
54f9ee45 2539 return _gdi_.Locale_GetSystemEncoding(*args, **kwargs)
5e40f9dd 2540
e811c8ce 2541def Locale_GetSystemEncodingName(*args, **kwargs):
196addbf 2542 """Locale_GetSystemEncodingName() -> String"""
54f9ee45 2543 return _gdi_.Locale_GetSystemEncodingName(*args, **kwargs)
d14a1e28 2544
e811c8ce 2545def Locale_AddCatalogLookupPathPrefix(*args, **kwargs):
196addbf 2546 """Locale_AddCatalogLookupPathPrefix(String prefix)"""
54f9ee45 2547 return _gdi_.Locale_AddCatalogLookupPathPrefix(*args, **kwargs)
d14a1e28 2548
e811c8ce
RD
2549def Locale_GetLanguageInfo(*args, **kwargs):
2550 """Locale_GetLanguageInfo(int lang) -> LanguageInfo"""
54f9ee45 2551 return _gdi_.Locale_GetLanguageInfo(*args, **kwargs)
d14a1e28 2552
e811c8ce 2553def Locale_GetLanguageName(*args, **kwargs):
196addbf 2554 """Locale_GetLanguageName(int lang) -> String"""
54f9ee45 2555 return _gdi_.Locale_GetLanguageName(*args, **kwargs)
d14a1e28 2556
e811c8ce 2557def Locale_FindLanguageInfo(*args, **kwargs):
196addbf 2558 """Locale_FindLanguageInfo(String locale) -> LanguageInfo"""
54f9ee45 2559 return _gdi_.Locale_FindLanguageInfo(*args, **kwargs)
d14a1e28 2560
e811c8ce
RD
2561def Locale_AddLanguage(*args, **kwargs):
2562 """Locale_AddLanguage(LanguageInfo info)"""
54f9ee45 2563 return _gdi_.Locale_AddLanguage(*args, **kwargs)
d14a1e28
RD
2564
2565
e811c8ce
RD
2566def GetLocale(*args, **kwargs):
2567 """GetLocale() -> Locale"""
54f9ee45 2568 return _gdi_.GetLocale(*args, **kwargs)
d14a1e28
RD
2569#---------------------------------------------------------------------------
2570
54f9ee45
RD
2571CONVERT_STRICT = _gdi_.CONVERT_STRICT
2572CONVERT_SUBSTITUTE = _gdi_.CONVERT_SUBSTITUTE
2573PLATFORM_CURRENT = _gdi_.PLATFORM_CURRENT
2574PLATFORM_UNIX = _gdi_.PLATFORM_UNIX
2575PLATFORM_WINDOWS = _gdi_.PLATFORM_WINDOWS
2576PLATFORM_OS2 = _gdi_.PLATFORM_OS2
2577PLATFORM_MAC = _gdi_.PLATFORM_MAC
2578class EncodingConverter(_core.Object):
093d3ff1 2579 """Proxy of C++ EncodingConverter class"""
e811c8ce
RD
2580 def __repr__(self):
2581 return "<%s.%s; proxy of C++ wxEncodingConverter instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 2582 def __init__(self, *args, **kwargs):
a95a7133 2583 """__init__(self) -> EncodingConverter"""
54f9ee45 2584 newobj = _gdi_.new_EncodingConverter(*args, **kwargs)
d14a1e28
RD
2585 self.this = newobj.this
2586 self.thisown = 1
2587 del newobj.thisown
54f9ee45 2588 def __del__(self, destroy=_gdi_.delete_EncodingConverter):
a95a7133 2589 """__del__(self)"""
d14a1e28
RD
2590 try:
2591 if self.thisown: destroy(self)
2592 except: pass
e811c8ce
RD
2593
2594 def Init(*args, **kwargs):
a95a7133 2595 """Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool"""
54f9ee45 2596 return _gdi_.EncodingConverter_Init(*args, **kwargs)
e811c8ce
RD
2597
2598 def Convert(*args, **kwargs):
a95a7133 2599 """Convert(self, String input) -> String"""
54f9ee45 2600 return _gdi_.EncodingConverter_Convert(*args, **kwargs)
e811c8ce
RD
2601
2602 def GetPlatformEquivalents(*args, **kwargs):
66c033b4 2603 """GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
54f9ee45 2604 return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs)
e811c8ce
RD
2605
2606 GetPlatformEquivalents = staticmethod(GetPlatformEquivalents)
2607 def GetAllEquivalents(*args, **kwargs):
66c033b4 2608 """GetAllEquivalents(int enc) -> wxFontEncodingArray"""
54f9ee45 2609 return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs)
e811c8ce
RD
2610
2611 GetAllEquivalents = staticmethod(GetAllEquivalents)
2612 def CanConvert(*args, **kwargs):
66c033b4 2613 """CanConvert(int encIn, int encOut) -> bool"""
54f9ee45 2614 return _gdi_.EncodingConverter_CanConvert(*args, **kwargs)
e811c8ce
RD
2615
2616 CanConvert = staticmethod(CanConvert)
d14a1e28 2617 def __nonzero__(self): return self.IsOk()
d14a1e28
RD
2618
2619class EncodingConverterPtr(EncodingConverter):
2620 def __init__(self, this):
2621 self.this = this
2622 if not hasattr(self,"thisown"): self.thisown = 0
2623 self.__class__ = EncodingConverter
54f9ee45 2624_gdi_.EncodingConverter_swigregister(EncodingConverterPtr)
d14a1e28 2625
e811c8ce 2626def GetTranslation(*args):
0df68c9f 2627 """
3adfb63b
RD
2628 GetTranslation(String str) -> String
2629 GetTranslation(String str, String strPlural, size_t n) -> String
0df68c9f 2630 """
54f9ee45 2631 return _gdi_.GetTranslation(*args)
d14a1e28 2632
e811c8ce 2633def EncodingConverter_GetPlatformEquivalents(*args, **kwargs):
196addbf 2634 """EncodingConverter_GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray"""
54f9ee45 2635 return _gdi_.EncodingConverter_GetPlatformEquivalents(*args, **kwargs)
d14a1e28 2636
e811c8ce 2637def EncodingConverter_GetAllEquivalents(*args, **kwargs):
196addbf 2638 """EncodingConverter_GetAllEquivalents(int enc) -> wxFontEncodingArray"""
54f9ee45 2639 return _gdi_.EncodingConverter_GetAllEquivalents(*args, **kwargs)
d14a1e28 2640
e811c8ce 2641def EncodingConverter_CanConvert(*args, **kwargs):
196addbf 2642 """EncodingConverter_CanConvert(int encIn, int encOut) -> bool"""
54f9ee45 2643 return _gdi_.EncodingConverter_CanConvert(*args, **kwargs)
d14a1e28
RD
2644
2645#----------------------------------------------------------------------------
89c876de 2646# On MSW add the directory where the wxWidgets catalogs were installed
d14a1e28
RD
2647# to the default catalog path.
2648if wx.Platform == "__WXMSW__":
2649 import os
8fb0e70a
RD
2650 _localedir = os.path.join(os.path.split(__file__)[0], "locale")
2651 Locale.AddCatalogLookupPathPrefix(_localedir)
d14a1e28
RD
2652 del os
2653
2654#----------------------------------------------------------------------------
2655
2656#---------------------------------------------------------------------------
2657
54f9ee45 2658class DC(_core.Object):
f5b96ee1
RD
2659 """
2660 A wx.DC is a device context onto which graphics and text can be
2661 drawn. It is intended to represent a number of output devices in a
2662 generic way, so a window can have a device context associated with it,
2663 and a printer also has a device context. In this way, the same piece
2664 of code may write to a number of different devices, if the device
2665 context is used as a parameter.
2666
2667 Derived types of wxDC have documentation for specific features only,
2668 so refer to this section for most device context information.
2669
2670 The wx.DC class is abstract and can not be instantiated, you must use
2671 one of the derived classes instead. Which one will depend on the
2672 situation in which it is used.
2673 """
e811c8ce
RD
2674 def __init__(self): raise RuntimeError, "No constructor defined"
2675 def __repr__(self):
2676 return "<%s.%s; proxy of C++ wxDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
54f9ee45 2677 def __del__(self, destroy=_gdi_.delete_DC):
a95a7133 2678 """__del__(self)"""
d14a1e28
RD
2679 try:
2680 if self.thisown: destroy(self)
2681 except: pass
e811c8ce
RD
2682
2683 def BeginDrawing(*args, **kwargs):
f5b96ee1
RD
2684 """
2685 BeginDrawing(self)
2686
2687 Allows for optimization of drawing code on platforms that need it. On
2688 other platforms this is just an empty function and is harmless. To
2689 take advantage of this postential optimization simply enclose each
2690 group of calls to the drawing primitives within calls to
2691 `BeginDrawing` and `EndDrawing`.
2692 """
54f9ee45 2693 return _gdi_.DC_BeginDrawing(*args, **kwargs)
e811c8ce
RD
2694
2695 def EndDrawing(*args, **kwargs):
f5b96ee1
RD
2696 """
2697 EndDrawing(self)
2698
2699 Ends the group of drawing primitives started with `BeginDrawing`, and
2700 invokes whatever optimization is available for this DC type on the
2701 current platform.
2702 """
54f9ee45 2703 return _gdi_.DC_EndDrawing(*args, **kwargs)
e811c8ce 2704
e811c8ce 2705 def FloodFill(*args, **kwargs):
f5b96ee1
RD
2706 """
2707 FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool
2708
2709 Flood fills the device context starting from the given point, using
2710 the current brush colour, and using a style:
2711
2712 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2713 the given colour is encountered.
2714
2715 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2716 colour.
2717
2718 Returns False if the operation failed.
2719
2720 Note: The present implementation for non-Windows platforms may fail to
2721 find colour borders if the pixels do not match the colour
2722 exactly. However the function will still return true.
2723 """
54f9ee45 2724 return _gdi_.DC_FloodFill(*args, **kwargs)
e811c8ce 2725
03e37cd5 2726 def FloodFillPoint(*args, **kwargs):
f5b96ee1
RD
2727 """
2728 FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool
2729
2730 Flood fills the device context starting from the given point, using
2731 the current brush colour, and using a style:
2732
2733 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
2734 the given colour is encountered.
2735
2736 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
2737 colour.
2738
2739 Returns False if the operation failed.
2740
2741 Note: The present implementation for non-Windows platforms may fail to
2742 find colour borders if the pixels do not match the colour
2743 exactly. However the function will still return true.
2744 """
03e37cd5 2745 return _gdi_.DC_FloodFillPoint(*args, **kwargs)
e811c8ce
RD
2746
2747 def GetPixel(*args, **kwargs):
f5b96ee1
RD
2748 """
2749 GetPixel(self, int x, int y) -> Colour
2750
2751 Gets the colour at the specified location on the DC.
2752 """
54f9ee45 2753 return _gdi_.DC_GetPixel(*args, **kwargs)
e811c8ce 2754
03e37cd5
RD
2755 def GetPixelPoint(*args, **kwargs):
2756 """GetPixelPoint(self, Point pt) -> Colour"""
2757 return _gdi_.DC_GetPixelPoint(*args, **kwargs)
e811c8ce
RD
2758
2759 def DrawLine(*args, **kwargs):
f5b96ee1
RD
2760 """
2761 DrawLine(self, int x1, int y1, int x2, int y2)
2762
2763 Draws a line from the first point to the second. The current pen is
2764 used for drawing the line. Note that the second point is *not* part of
2765 the line and is not drawn by this function (this is consistent with
2766 the behaviour of many other toolkits).
2767 """
54f9ee45 2768 return _gdi_.DC_DrawLine(*args, **kwargs)
e811c8ce 2769
03e37cd5 2770 def DrawLinePoint(*args, **kwargs):
f5b96ee1
RD
2771 """
2772 DrawLinePoint(self, Point pt1, Point pt2)
2773
2774 Draws a line from the first point to the second. The current pen is
2775 used for drawing the line. Note that the second point is *not* part of
2776 the line and is not drawn by this function (this is consistent with
2777 the behaviour of many other toolkits).
2778 """
03e37cd5 2779 return _gdi_.DC_DrawLinePoint(*args, **kwargs)
e811c8ce
RD
2780
2781 def CrossHair(*args, **kwargs):
f5b96ee1
RD
2782 """
2783 CrossHair(self, int x, int y)
2784
2785 Displays a cross hair using the current pen. This is a vertical and
2786 horizontal line the height and width of the window, centred on the
2787 given point.
2788 """
54f9ee45 2789 return _gdi_.DC_CrossHair(*args, **kwargs)
e811c8ce 2790
03e37cd5 2791 def CrossHairPoint(*args, **kwargs):
f5b96ee1
RD
2792 """
2793 CrossHairPoint(self, Point pt)
2794
2795 Displays a cross hair using the current pen. This is a vertical and
2796 horizontal line the height and width of the window, centred on the
2797 given point.
2798 """
03e37cd5 2799 return _gdi_.DC_CrossHairPoint(*args, **kwargs)
e811c8ce
RD
2800
2801 def DrawArc(*args, **kwargs):
f5b96ee1
RD
2802 """
2803 DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
2804
2805 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2806 the first point to the second. The current pen is used for the outline
2807 and the current brush for filling the shape.
2808
2809 The arc is drawn in an anticlockwise direction from the start point to
2810 the end point.
2811 """
54f9ee45 2812 return _gdi_.DC_DrawArc(*args, **kwargs)
e811c8ce 2813
03e37cd5 2814 def DrawArcPoint(*args, **kwargs):
f5b96ee1
RD
2815 """
2816 DrawArcPoint(self, Point pt1, Point pt2, Point center)
2817
2818 Draws an arc of a circle, centred on the *center* point (xc, yc), from
2819 the first point to the second. The current pen is used for the outline
2820 and the current brush for filling the shape.
2821
2822 The arc is drawn in an anticlockwise direction from the start point to
2823 the end point.
2824 """
03e37cd5 2825 return _gdi_.DC_DrawArcPoint(*args, **kwargs)
e811c8ce
RD
2826
2827 def DrawCheckMark(*args, **kwargs):
f5b96ee1
RD
2828 """
2829 DrawCheckMark(self, int x, int y, int width, int height)
2830
2831 Draws a check mark inside the given rectangle.
2832 """
54f9ee45 2833 return _gdi_.DC_DrawCheckMark(*args, **kwargs)
e811c8ce 2834
03e37cd5 2835 def DrawCheckMarkRect(*args, **kwargs):
f5b96ee1
RD
2836 """
2837 DrawCheckMarkRect(self, Rect rect)
2838
2839 Draws a check mark inside the given rectangle.
2840 """
03e37cd5 2841 return _gdi_.DC_DrawCheckMarkRect(*args, **kwargs)
e811c8ce
RD
2842
2843 def DrawEllipticArc(*args, **kwargs):
f5b96ee1
RD
2844 """
2845 DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
2846
2847 Draws an arc of an ellipse, with the given rectangle defining the
2848 bounds of the ellipse. The current pen is used for drawing the arc and
2849 the current brush is used for drawing the pie.
2850
2851 The *start* and *end* parameters specify the start and end of the arc
2852 relative to the three-o'clock position from the center of the
2853 rectangle. Angles are specified in degrees (360 is a complete
2854 circle). Positive values mean counter-clockwise motion. If start is
2855 equal to end, a complete ellipse will be drawn.
2856 """
54f9ee45 2857 return _gdi_.DC_DrawEllipticArc(*args, **kwargs)
e811c8ce 2858
03e37cd5 2859 def DrawEllipticArcPointSize(*args, **kwargs):
f5b96ee1
RD
2860 """
2861 DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
2862
2863 Draws an arc of an ellipse, with the given rectangle defining the
2864 bounds of the ellipse. The current pen is used for drawing the arc and
2865 the current brush is used for drawing the pie.
2866
2867 The *start* and *end* parameters specify the start and end of the arc
2868 relative to the three-o'clock position from the center of the
2869 rectangle. Angles are specified in degrees (360 is a complete
2870 circle). Positive values mean counter-clockwise motion. If start is
2871 equal to end, a complete ellipse will be drawn.
2872 """
03e37cd5 2873 return _gdi_.DC_DrawEllipticArcPointSize(*args, **kwargs)
e811c8ce
RD
2874
2875 def DrawPoint(*args, **kwargs):
f5b96ee1
RD
2876 """
2877 DrawPoint(self, int x, int y)
2878
2879 Draws a point using the current pen.
2880 """
54f9ee45 2881 return _gdi_.DC_DrawPoint(*args, **kwargs)
e811c8ce 2882
03e37cd5 2883 def DrawPointPoint(*args, **kwargs):
f5b96ee1
RD
2884 """
2885 DrawPointPoint(self, Point pt)
2886
2887 Draws a point using the current pen.
2888 """
03e37cd5 2889 return _gdi_.DC_DrawPointPoint(*args, **kwargs)
e811c8ce
RD
2890
2891 def DrawRectangle(*args, **kwargs):
f5b96ee1
RD
2892 """
2893 DrawRectangle(self, int x, int y, int width, int height)
2894
2895 Draws a rectangle with the given top left corner, and with the given
2896 size. The current pen is used for the outline and the current brush
2897 for filling the shape.
2898 """
54f9ee45 2899 return _gdi_.DC_DrawRectangle(*args, **kwargs)
e811c8ce
RD
2900
2901 def DrawRectangleRect(*args, **kwargs):
f5b96ee1
RD
2902 """
2903 DrawRectangleRect(self, Rect rect)
2904
2905 Draws a rectangle with the given top left corner, and with the given
2906 size. The current pen is used for the outline and the current brush
2907 for filling the shape.
2908 """
54f9ee45 2909 return _gdi_.DC_DrawRectangleRect(*args, **kwargs)
e811c8ce 2910
03e37cd5 2911 def DrawRectanglePointSize(*args, **kwargs):
f5b96ee1
RD
2912 """
2913 DrawRectanglePointSize(self, Point pt, Size sz)
2914
2915 Draws a rectangle with the given top left corner, and with the given
2916 size. The current pen is used for the outline and the current brush
2917 for filling the shape.
2918 """
03e37cd5 2919 return _gdi_.DC_DrawRectanglePointSize(*args, **kwargs)
e811c8ce
RD
2920
2921 def DrawRoundedRectangle(*args, **kwargs):
f5b96ee1
RD
2922 """
2923 DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
2924
2925 Draws a rectangle with the given top left corner, and with the given
2926 size. The corners are quarter-circles using the given radius. The
2927 current pen is used for the outline and the current brush for filling
2928 the shape.
2929
2930 If radius is positive, the value is assumed to be the radius of the
2931 rounded corner. If radius is negative, the absolute value is assumed
2932 to be the proportion of the smallest dimension of the rectangle. This
2933 means that the corner can be a sensible size relative to the size of
2934 the rectangle, and also avoids the strange effects X produces when the
2935 corners are too big for the rectangle.
2936 """
54f9ee45 2937 return _gdi_.DC_DrawRoundedRectangle(*args, **kwargs)
e811c8ce
RD
2938
2939 def DrawRoundedRectangleRect(*args, **kwargs):
f5b96ee1
RD
2940 """
2941 DrawRoundedRectangleRect(self, Rect r, double radius)
2942
2943 Draws a rectangle with the given top left corner, and with the given
2944 size. The corners are quarter-circles using the given radius. The
2945 current pen is used for the outline and the current brush for filling
2946 the shape.
2947
2948 If radius is positive, the value is assumed to be the radius of the
2949 rounded corner. If radius is negative, the absolute value is assumed
2950 to be the proportion of the smallest dimension of the rectangle. This
2951 means that the corner can be a sensible size relative to the size of
2952 the rectangle, and also avoids the strange effects X produces when the
2953 corners are too big for the rectangle.
2954 """
54f9ee45 2955 return _gdi_.DC_DrawRoundedRectangleRect(*args, **kwargs)
e811c8ce 2956
03e37cd5 2957 def DrawRoundedRectanglePointSize(*args, **kwargs):
f5b96ee1
RD
2958 """
2959 DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
2960
2961 Draws a rectangle with the given top left corner, and with the given
2962 size. The corners are quarter-circles using the given radius. The
2963 current pen is used for the outline and the current brush for filling
2964 the shape.
2965
2966 If radius is positive, the value is assumed to be the radius of the
2967 rounded corner. If radius is negative, the absolute value is assumed
2968 to be the proportion of the smallest dimension of the rectangle. This
2969 means that the corner can be a sensible size relative to the size of
2970 the rectangle, and also avoids the strange effects X produces when the
2971 corners are too big for the rectangle.
2972 """
03e37cd5 2973 return _gdi_.DC_DrawRoundedRectanglePointSize(*args, **kwargs)
e811c8ce
RD
2974
2975 def DrawCircle(*args, **kwargs):
f5b96ee1
RD
2976 """
2977 DrawCircle(self, int x, int y, int radius)
2978
2979 Draws a circle with the given center point and radius. The current
2980 pen is used for the outline and the current brush for filling the
2981 shape.
2982 """
54f9ee45 2983 return _gdi_.DC_DrawCircle(*args, **kwargs)
e811c8ce 2984
03e37cd5 2985 def DrawCirclePoint(*args, **kwargs):
f5b96ee1
RD
2986 """
2987 DrawCirclePoint(self, Point pt, int radius)
2988
2989 Draws a circle with the given center point and radius. The current
2990 pen is used for the outline and the current brush for filling the
2991 shape.
2992 """
03e37cd5 2993 return _gdi_.DC_DrawCirclePoint(*args, **kwargs)
e811c8ce
RD
2994
2995 def DrawEllipse(*args, **kwargs):
f5b96ee1
RD
2996 """
2997 DrawEllipse(self, int x, int y, int width, int height)
2998
2999 Draws an ellipse contained in the specified rectangle. The current pen
3000 is used for the outline and the current brush for filling the shape.
3001 """
54f9ee45 3002 return _gdi_.DC_DrawEllipse(*args, **kwargs)
e811c8ce
RD
3003
3004 def DrawEllipseRect(*args, **kwargs):
f5b96ee1
RD
3005 """
3006 DrawEllipseRect(self, Rect rect)
3007
3008 Draws an ellipse contained in the specified rectangle. The current pen
3009 is used for the outline and the current brush for filling the shape.
3010 """
54f9ee45 3011 return _gdi_.DC_DrawEllipseRect(*args, **kwargs)
e811c8ce 3012
03e37cd5 3013 def DrawEllipsePointSize(*args, **kwargs):
f5b96ee1
RD
3014 """
3015 DrawEllipsePointSize(self, Point pt, Size sz)
3016
3017 Draws an ellipse contained in the specified rectangle. The current pen
3018 is used for the outline and the current brush for filling the shape.
3019 """
03e37cd5 3020 return _gdi_.DC_DrawEllipsePointSize(*args, **kwargs)
e811c8ce
RD
3021
3022 def DrawIcon(*args, **kwargs):
f5b96ee1
RD
3023 """
3024 DrawIcon(self, Icon icon, int x, int y)
3025
3026 Draw an icon on the display (does nothing if the device context is
3027 PostScript). This can be the simplest way of drawing bitmaps on a
3028 window.
3029 """
54f9ee45 3030 return _gdi_.DC_DrawIcon(*args, **kwargs)
e811c8ce 3031
03e37cd5 3032 def DrawIconPoint(*args, **kwargs):
f5b96ee1
RD
3033 """
3034 DrawIconPoint(self, Icon icon, Point pt)
3035
3036 Draw an icon on the display (does nothing if the device context is
3037 PostScript). This can be the simplest way of drawing bitmaps on a
3038 window.
3039 """
03e37cd5 3040 return _gdi_.DC_DrawIconPoint(*args, **kwargs)
e811c8ce
RD
3041
3042 def DrawBitmap(*args, **kwargs):
f5b96ee1
RD
3043 """
3044 DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
3045
3046 Draw a bitmap on the device context at the specified point. If
3047 *transparent* is true and the bitmap has a transparency mask, (or
3048 alpha channel on the platforms that support it) then the bitmap will
3049 be drawn transparently.
3050 """
54f9ee45 3051 return _gdi_.DC_DrawBitmap(*args, **kwargs)
e811c8ce 3052
03e37cd5 3053 def DrawBitmapPoint(*args, **kwargs):
f5b96ee1
RD
3054 """
3055 DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
3056
3057 Draw a bitmap on the device context at the specified point. If
3058 *transparent* is true and the bitmap has a transparency mask, (or
3059 alpha channel on the platforms that support it) then the bitmap will
3060 be drawn transparently.
3061 """
03e37cd5 3062 return _gdi_.DC_DrawBitmapPoint(*args, **kwargs)
e811c8ce
RD
3063
3064 def DrawText(*args, **kwargs):
f5b96ee1
RD
3065 """
3066 DrawText(self, String text, int x, int y)
3067
3068 Draws a text string at the specified point, using the current text
3069 font, and the current text foreground and background colours.
3070
3071 The coordinates refer to the top-left corner of the rectangle bounding
3072 the string. See `GetTextExtent` for how to get the dimensions of a
3073 text string, which can be used to position the text more precisely.
3074
3075 **NOTE**: under wxGTK the current logical function is used by this
3076 function but it is ignored by wxMSW. Thus, you should avoid using
3077 logical functions with this function in portable programs.
3078 """
54f9ee45 3079 return _gdi_.DC_DrawText(*args, **kwargs)
e811c8ce 3080
03e37cd5 3081 def DrawTextPoint(*args, **kwargs):
f5b96ee1
RD
3082 """
3083 DrawTextPoint(self, String text, Point pt)
3084
3085 Draws a text string at the specified point, using the current text
3086 font, and the current text foreground and background colours.
3087
3088 The coordinates refer to the top-left corner of the rectangle bounding
3089 the string. See `GetTextExtent` for how to get the dimensions of a
3090 text string, which can be used to position the text more precisely.
3091
3092 **NOTE**: under wxGTK the current logical function is used by this
3093 function but it is ignored by wxMSW. Thus, you should avoid using
3094 logical functions with this function in portable programs.
3095 """
03e37cd5 3096 return _gdi_.DC_DrawTextPoint(*args, **kwargs)
e811c8ce
RD
3097
3098 def DrawRotatedText(*args, **kwargs):
f5b96ee1
RD
3099 """
3100 DrawRotatedText(self, String text, int x, int y, double angle)
3101
3102 Draws the text rotated by *angle* degrees, if supported by the platform.
3103
3104 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3105 function. In particular, a font different from ``wx.NORMAL_FONT``
3106 should be used as the it is not normally a TrueType
3107 font. ``wx.SWISS_FONT`` is an example of a font which is.
3108 """
54f9ee45 3109 return _gdi_.DC_DrawRotatedText(*args, **kwargs)
e811c8ce 3110
03e37cd5 3111 def DrawRotatedTextPoint(*args, **kwargs):
f5b96ee1
RD
3112 """
3113 DrawRotatedTextPoint(self, String text, Point pt, double angle)
3114
3115 Draws the text rotated by *angle* degrees, if supported by the platform.
3116
3117 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
3118 function. In particular, a font different from ``wx.NORMAL_FONT``
3119 should be used as the it is not normally a TrueType
3120 font. ``wx.SWISS_FONT`` is an example of a font which is.
3121 """
03e37cd5
RD
3122 return _gdi_.DC_DrawRotatedTextPoint(*args, **kwargs)
3123
3124 def Blit(*args, **kwargs):
0df68c9f 3125 """
03e37cd5 3126 Blit(self, int xdest, int ydest, int width, int height, DC source,
0df68c9f
RD
3127 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
3128 int xsrcMask=-1, int ysrcMask=-1) -> bool
f5b96ee1
RD
3129
3130 Copy from a source DC to this DC. Parameters specify the destination
3131 coordinates, size of area to copy, source DC, source coordinates,
3132 logical function, whether to use a bitmap mask, and mask source
3133 position.
0df68c9f 3134 """
03e37cd5 3135 return _gdi_.DC_Blit(*args, **kwargs)
e811c8ce 3136
03e37cd5 3137 def BlitPointSize(*args, **kwargs):
0df68c9f 3138 """
03e37cd5 3139 BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
0df68c9f 3140 bool useMask=False, Point srcPtMask=DefaultPosition) -> bool
f5b96ee1
RD
3141
3142 Copy from a source DC to this DC. Parameters specify the destination
3143 coordinates, size of area to copy, source DC, source coordinates,
3144 logical function, whether to use a bitmap mask, and mask source
3145 position.
0df68c9f 3146 """
03e37cd5
RD
3147 return _gdi_.DC_BlitPointSize(*args, **kwargs)
3148
3149 def SetClippingRegion(*args, **kwargs):
f5b96ee1
RD
3150 """
3151 SetClippingRegion(self, int x, int y, int width, int height)
3152
3153 Sets the clipping region for this device context to the intersection
3154 of the given region described by the parameters of this method and the
3155 previously set clipping region. You should call `DestroyClippingRegion`
3156 if you want to set the clipping region exactly to the region
3157 specified.
3158
3159 The clipping region is an area to which drawing is
3160 restricted. Possible uses for the clipping region are for clipping
3161 text or for speeding up window redraws when only a known area of the
3162 screen is damaged.
3163 """
03e37cd5
RD
3164 return _gdi_.DC_SetClippingRegion(*args, **kwargs)
3165
3166 def SetClippingRegionPointSize(*args, **kwargs):
f5b96ee1
RD
3167 """
3168 SetClippingRegionPointSize(self, Point pt, Size sz)
3169
3170 Sets the clipping region for this device context to the intersection
3171 of the given region described by the parameters of this method and the
3172 previously set clipping region. You should call `DestroyClippingRegion`
3173 if you want to set the clipping region exactly to the region
3174 specified.
3175
3176 The clipping region is an area to which drawing is
3177 restricted. Possible uses for the clipping region are for clipping
3178 text or for speeding up window redraws when only a known area of the
3179 screen is damaged.
3180 """
03e37cd5
RD
3181 return _gdi_.DC_SetClippingRegionPointSize(*args, **kwargs)
3182
3183 def SetClippingRegionAsRegion(*args, **kwargs):
f5b96ee1
RD
3184 """
3185 SetClippingRegionAsRegion(self, Region region)
3186
3187 Sets the clipping region for this device context to the intersection
3188 of the given region described by the parameters of this method and the
3189 previously set clipping region. You should call `DestroyClippingRegion`
3190 if you want to set the clipping region exactly to the region
3191 specified.
3192
3193 The clipping region is an area to which drawing is
3194 restricted. Possible uses for the clipping region are for clipping
3195 text or for speeding up window redraws when only a known area of the
3196 screen is damaged.
3197 """
03e37cd5
RD
3198 return _gdi_.DC_SetClippingRegionAsRegion(*args, **kwargs)
3199
3200 def SetClippingRect(*args, **kwargs):
f5b96ee1
RD
3201 """
3202 SetClippingRect(self, Rect rect)
3203
3204 Sets the clipping region for this device context to the intersection
3205 of the given region described by the parameters of this method and the
3206 previously set clipping region. You should call `DestroyClippingRegion`
3207 if you want to set the clipping region exactly to the region
3208 specified.
3209
3210 The clipping region is an area to which drawing is
3211 restricted. Possible uses for the clipping region are for clipping
3212 text or for speeding up window redraws when only a known area of the
3213 screen is damaged.
3214 """
03e37cd5 3215 return _gdi_.DC_SetClippingRect(*args, **kwargs)
e811c8ce
RD
3216
3217 def DrawLines(*args, **kwargs):
f5b96ee1
RD
3218 """
3219 DrawLines(self, List points, int xoffset=0, int yoffset=0)
3220
3221 Draws lines using a sequence of `wx.Point` objects, adding the
3222 optional offset coordinate. The current pen is used for drawing the
3223 lines.
3224 """
54f9ee45 3225 return _gdi_.DC_DrawLines(*args, **kwargs)
e811c8ce
RD
3226
3227 def DrawPolygon(*args, **kwargs):
0df68c9f 3228 """
f5b96ee1 3229 DrawPolygon(self, List points, int xoffset=0, int yoffset=0,
0df68c9f 3230 int fillStyle=ODDEVEN_RULE)
f5b96ee1
RD
3231
3232 Draws a filled polygon using a sequence of `wx.Point` objects, adding
3233 the optional offset coordinate. The last argument specifies the fill
3234 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
3235
3236 The current pen is used for drawing the outline, and the current brush
3237 for filling the shape. Using a transparent brush suppresses
3238 filling. Note that wxWidgets automatically closes the first and last
3239 points.
0df68c9f 3240 """
54f9ee45 3241 return _gdi_.DC_DrawPolygon(*args, **kwargs)
e811c8ce
RD
3242
3243 def DrawLabel(*args, **kwargs):
0df68c9f 3244 """
a95a7133 3245 DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
0df68c9f 3246 int indexAccel=-1)
f5b96ee1
RD
3247
3248 Draw *text* within the specified rectangle, abiding by the alignment
3249 flags. Will additionally emphasize the character at *indexAccel* if
3250 it is not -1.
0df68c9f 3251 """
54f9ee45 3252 return _gdi_.DC_DrawLabel(*args, **kwargs)
e811c8ce
RD
3253
3254 def DrawImageLabel(*args, **kwargs):
0df68c9f 3255 """
a95a7133 3256 DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
0df68c9f 3257 int indexAccel=-1) -> Rect
f5b96ee1
RD
3258
3259 Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
3260 drawing it) within the specified rectangle, abiding by the alignment
3261 flags. Will additionally emphasize the character at *indexAccel* if
3262 it is not -1. Returns the bounding rectangle.
0df68c9f 3263 """
54f9ee45 3264 return _gdi_.DC_DrawImageLabel(*args, **kwargs)
e811c8ce
RD
3265
3266 def DrawSpline(*args, **kwargs):
f5b96ee1
RD
3267 """
3268 DrawSpline(self, List points)
3269
3270 Draws a spline between all given control points, (a list of `wx.Point`
3271 objects) using the current pen. The spline is drawn using a series of
3272 lines, using an algorithm taken from the X drawing program 'XFIG'.
3273 """
54f9ee45 3274 return _gdi_.DC_DrawSpline(*args, **kwargs)
e811c8ce
RD
3275
3276 def Clear(*args, **kwargs):
f5b96ee1
RD
3277 """
3278 Clear(self)
3279
3280 Clears the device context using the current background brush.
3281 """
54f9ee45 3282 return _gdi_.DC_Clear(*args, **kwargs)
e811c8ce
RD
3283
3284 def StartDoc(*args, **kwargs):
f5b96ee1
RD
3285 """
3286 StartDoc(self, String message) -> bool
3287
3288 Starts a document (only relevant when outputting to a
3289 printer). *Message* is a message to show whilst printing.
3290 """
54f9ee45 3291 return _gdi_.DC_StartDoc(*args, **kwargs)
e811c8ce
RD
3292
3293 def EndDoc(*args, **kwargs):
f5b96ee1
RD
3294 """
3295 EndDoc(self)
3296
3297 Ends a document (only relevant when outputting to a printer).
3298 """
54f9ee45 3299 return _gdi_.DC_EndDoc(*args, **kwargs)
e811c8ce
RD
3300
3301 def StartPage(*args, **kwargs):
f5b96ee1
RD
3302 """
3303 StartPage(self)
3304
3305 Starts a document page (only relevant when outputting to a printer).
3306 """
54f9ee45 3307 return _gdi_.DC_StartPage(*args, **kwargs)
e811c8ce
RD
3308
3309 def EndPage(*args, **kwargs):
f5b96ee1
RD
3310 """
3311 EndPage(self)
3312
3313 Ends a document page (only relevant when outputting to a printer).
3314 """
54f9ee45 3315 return _gdi_.DC_EndPage(*args, **kwargs)
e811c8ce
RD
3316
3317 def SetFont(*args, **kwargs):
f5b96ee1
RD
3318 """
3319 SetFont(self, Font font)
3320
3321 Sets the current font for the DC. It must be a valid font, in
3322 particular you should not pass ``wx.NullFont`` to this method.
3323 """
54f9ee45 3324 return _gdi_.DC_SetFont(*args, **kwargs)
e811c8ce
RD
3325
3326 def SetPen(*args, **kwargs):
f5b96ee1
RD
3327 """
3328 SetPen(self, Pen pen)
3329
3330 Sets the current pen for the DC.
3331
3332 If the argument is ``wx.NullPen``, the current pen is selected out of the
3333 device context, and the original pen restored.
3334 """
54f9ee45 3335 return _gdi_.DC_SetPen(*args, **kwargs)
e811c8ce
RD
3336
3337 def SetBrush(*args, **kwargs):
f5b96ee1
RD
3338 """
3339 SetBrush(self, Brush brush)
3340
3341 Sets the current brush for the DC.
3342
3343 If the argument is ``wx.NullBrush``, the current brush is selected out
3344 of the device context, and the original brush restored, allowing the
3345 current brush to be destroyed safely.
3346 """
54f9ee45 3347 return _gdi_.DC_SetBrush(*args, **kwargs)
e811c8ce
RD
3348
3349 def SetBackground(*args, **kwargs):
f5b96ee1
RD
3350 """
3351 SetBackground(self, Brush brush)
3352
3353 Sets the current background brush for the DC.
3354 """
54f9ee45 3355 return _gdi_.DC_SetBackground(*args, **kwargs)
e811c8ce
RD
3356
3357 def SetBackgroundMode(*args, **kwargs):
f5b96ee1
RD
3358 """
3359 SetBackgroundMode(self, int mode)
3360
3361 *mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
3362 determines whether text will be drawn with a background colour or
3363 not.
3364 """
54f9ee45 3365 return _gdi_.DC_SetBackgroundMode(*args, **kwargs)
e811c8ce
RD
3366
3367 def SetPalette(*args, **kwargs):
f5b96ee1
RD
3368 """
3369 SetPalette(self, Palette palette)
3370
3371 If this is a window DC or memory DC, assigns the given palette to the
3372 window or bitmap associated with the DC. If the argument is
3373 ``wx.NullPalette``, the current palette is selected out of the device
3374 context, and the original palette restored.
3375 """
54f9ee45 3376 return _gdi_.DC_SetPalette(*args, **kwargs)
e811c8ce 3377
e811c8ce 3378 def DestroyClippingRegion(*args, **kwargs):
f5b96ee1
RD
3379 """
3380 DestroyClippingRegion(self)
3381
3382 Destroys the current clipping region so that none of the DC is
3383 clipped.
3384 """
54f9ee45 3385 return _gdi_.DC_DestroyClippingRegion(*args, **kwargs)
e811c8ce
RD
3386
3387 def GetClippingBox(*args, **kwargs):
f5b96ee1
RD
3388 """
3389 GetClippingBox() -> (x, y, width, height)
3390
3391 Gets the rectangle surrounding the current clipping region.
3392 """
54f9ee45 3393 return _gdi_.DC_GetClippingBox(*args, **kwargs)
e811c8ce
RD
3394
3395 def GetClippingRect(*args, **kwargs):
f5b96ee1
RD
3396 """
3397 GetClippingRect(self) -> Rect
3398
3399 Gets the rectangle surrounding the current clipping region.
3400 """
54f9ee45 3401 return _gdi_.DC_GetClippingRect(*args, **kwargs)
e811c8ce
RD
3402
3403 def GetCharHeight(*args, **kwargs):
f5b96ee1
RD
3404 """
3405 GetCharHeight(self) -> int
3406
3407 Gets the character height of the currently set font.
3408 """
54f9ee45 3409 return _gdi_.DC_GetCharHeight(*args, **kwargs)
e811c8ce
RD
3410
3411 def GetCharWidth(*args, **kwargs):
f5b96ee1
RD
3412 """
3413 GetCharWidth(self) -> int
3414
3415 Gets the average character width of the currently set font.
3416 """
54f9ee45 3417 return _gdi_.DC_GetCharWidth(*args, **kwargs)
e811c8ce
RD
3418
3419 def GetTextExtent(*args, **kwargs):
fd2dc343
RD
3420 """
3421 GetTextExtent(wxString string) -> (width, height)
3422
3423 Get the width and height of the text using the current font. Only
3424 works for single line strings.
3425 """
54f9ee45 3426 return _gdi_.DC_GetTextExtent(*args, **kwargs)
e811c8ce
RD
3427
3428 def GetFullTextExtent(*args, **kwargs):
0df68c9f
RD
3429 """
3430 GetFullTextExtent(wxString string, Font font=None) ->
3431 (width, height, descent, externalLeading)
322913ce 3432
41e2b43e
RD
3433 Get the width, height, decent and leading of the text using the
3434 current or specified font. Only works for single line strings.
0df68c9f 3435 """
54f9ee45 3436 return _gdi_.DC_GetFullTextExtent(*args, **kwargs)
e811c8ce
RD
3437
3438 def GetMultiLineTextExtent(*args, **kwargs):
0df68c9f
RD
3439 """
3440 GetMultiLineTextExtent(wxString string, Font font=None) ->
3441 (width, height, descent, externalLeading)
fd2dc343
RD
3442
3443 Get the width, height, decent and leading of the text using the
3444 current or specified font. Works for single as well as multi-line
3445 strings.
0df68c9f 3446 """
54f9ee45 3447 return _gdi_.DC_GetMultiLineTextExtent(*args, **kwargs)
e811c8ce 3448
db914595 3449 def GetPartialTextExtents(*args, **kwargs):
f5b96ee1
RD
3450 """
3451 GetPartialTextExtents(self, text) -> [widths]
3452
3453 Returns a list of integers such that each value is the distance in
3454 pixels from the begining of text to the coresponding character of
3455 *text*. The generic version simply builds a running total of the widths
3456 of each character using GetTextExtent, however if the various
3457 platforms have a native API function that is faster or more accurate
43e8916f 3458 than the generic implementation then it will be used instead.
f5b96ee1 3459 """
54f9ee45 3460 return _gdi_.DC_GetPartialTextExtents(*args, **kwargs)
db914595 3461
e811c8ce 3462 def GetSize(*args, **kwargs):
0df68c9f 3463 """
a95a7133 3464 GetSize(self) -> Size
322913ce 3465
f5b96ee1
RD
3466 This gets the horizontal and vertical resolution in device units. It
3467 can be used to scale graphics to fit the page. For example, if *maxX*
3468 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3469 used in your application, the following code will scale the graphic to
3470 fit on the printer page::
3471
3472 w, h = dc.GetSize()
3473 scaleX = maxX*1.0 / w
3474 scaleY = maxY*1.0 / h
3475 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3476
0df68c9f 3477 """
54f9ee45 3478 return _gdi_.DC_GetSize(*args, **kwargs)
e811c8ce 3479
322913ce 3480 def GetSizeTuple(*args, **kwargs):
0df68c9f
RD
3481 """
3482 GetSizeTuple() -> (width, height)
322913ce 3483
f5b96ee1
RD
3484 This gets the horizontal and vertical resolution in device units. It
3485 can be used to scale graphics to fit the page. For example, if *maxX*
3486 and *maxY* represent the maximum horizontal and vertical 'pixel' values
3487 used in your application, the following code will scale the graphic to
3488 fit on the printer page::
3489
3490 w, h = dc.GetSize()
3491 scaleX = maxX*1.0 / w
3492 scaleY = maxY*1.0 / h
3493 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
3494
0df68c9f 3495 """
54f9ee45 3496 return _gdi_.DC_GetSizeTuple(*args, **kwargs)
e811c8ce
RD
3497
3498 def GetSizeMM(*args, **kwargs):
0df68c9f 3499 """
a95a7133 3500 GetSizeMM(self) -> Size
322913ce 3501
0df68c9f
RD
3502 Get the DC size in milimeters.
3503 """
54f9ee45 3504 return _gdi_.DC_GetSizeMM(*args, **kwargs)
e811c8ce 3505
322913ce 3506 def GetSizeMMTuple(*args, **kwargs):
0df68c9f
RD
3507 """
3508 GetSizeMMTuple() -> (width, height)
322913ce 3509
0df68c9f
RD
3510 Get the DC size in milimeters.
3511 """
54f9ee45 3512 return _gdi_.DC_GetSizeMMTuple(*args, **kwargs)
322913ce 3513
e811c8ce 3514 def DeviceToLogicalX(*args, **kwargs):
f5b96ee1
RD
3515 """
3516 DeviceToLogicalX(self, int x) -> int
3517
3518 Convert device X coordinate to logical coordinate, using the current
3519 mapping mode.
3520 """
54f9ee45 3521 return _gdi_.DC_DeviceToLogicalX(*args, **kwargs)
e811c8ce
RD
3522
3523 def DeviceToLogicalY(*args, **kwargs):
f5b96ee1
RD
3524 """
3525 DeviceToLogicalY(self, int y) -> int
3526
3527 Converts device Y coordinate to logical coordinate, using the current
3528 mapping mode.
3529 """
54f9ee45 3530 return _gdi_.DC_DeviceToLogicalY(*args, **kwargs)
e811c8ce
RD
3531
3532 def DeviceToLogicalXRel(*args, **kwargs):
f5b96ee1
RD
3533 """
3534 DeviceToLogicalXRel(self, int x) -> int
3535
3536 Convert device X coordinate to relative logical coordinate, using the
3537 current mapping mode but ignoring the x axis orientation. Use this
3538 function for converting a width, for example.
3539 """
54f9ee45 3540 return _gdi_.DC_DeviceToLogicalXRel(*args, **kwargs)
e811c8ce
RD
3541
3542 def DeviceToLogicalYRel(*args, **kwargs):
f5b96ee1
RD
3543 """
3544 DeviceToLogicalYRel(self, int y) -> int
3545
3546 Convert device Y coordinate to relative logical coordinate, using the
3547 current mapping mode but ignoring the y axis orientation. Use this
3548 function for converting a height, for example.
3549 """
54f9ee45 3550 return _gdi_.DC_DeviceToLogicalYRel(*args, **kwargs)
e811c8ce
RD
3551
3552 def LogicalToDeviceX(*args, **kwargs):
f5b96ee1
RD
3553 """
3554 LogicalToDeviceX(self, int x) -> int
3555
3556 Converts logical X coordinate to device coordinate, using the current
3557 mapping mode.
3558 """
54f9ee45 3559 return _gdi_.DC_LogicalToDeviceX(*args, **kwargs)
e811c8ce
RD
3560
3561 def LogicalToDeviceY(*args, **kwargs):
f5b96ee1
RD
3562 """
3563 LogicalToDeviceY(self, int y) -> int
3564
3565 Converts logical Y coordinate to device coordinate, using the current
3566 mapping mode.
3567 """
54f9ee45 3568 return _gdi_.DC_LogicalToDeviceY(*args, **kwargs)
e811c8ce
RD
3569
3570 def LogicalToDeviceXRel(*args, **kwargs):
f5b96ee1
RD
3571 """
3572 LogicalToDeviceXRel(self, int x) -> int
3573
3574 Converts logical X coordinate to relative device coordinate, using the
3575 current mapping mode but ignoring the x axis orientation. Use this for
3576 converting a width, for example.
3577 """
54f9ee45 3578 return _gdi_.DC_LogicalToDeviceXRel(*args, **kwargs)
e811c8ce
RD
3579
3580 def LogicalToDeviceYRel(*args, **kwargs):
f5b96ee1
RD
3581 """
3582 LogicalToDeviceYRel(self, int y) -> int
3583
3584 Converts logical Y coordinate to relative device coordinate, using the
3585 current mapping mode but ignoring the y axis orientation. Use this for
3586 converting a height, for example.
3587 """
54f9ee45 3588 return _gdi_.DC_LogicalToDeviceYRel(*args, **kwargs)
e811c8ce
RD
3589
3590 def CanDrawBitmap(*args, **kwargs):
a95a7133 3591 """CanDrawBitmap(self) -> bool"""
54f9ee45 3592 return _gdi_.DC_CanDrawBitmap(*args, **kwargs)
e811c8ce
RD
3593
3594 def CanGetTextExtent(*args, **kwargs):
a95a7133 3595 """CanGetTextExtent(self) -> bool"""
54f9ee45 3596 return _gdi_.DC_CanGetTextExtent(*args, **kwargs)
e811c8ce
RD
3597
3598 def GetDepth(*args, **kwargs):
f5b96ee1
RD
3599 """
3600 GetDepth(self) -> int
3601
3602 Returns the colour depth of the DC.
3603 """
54f9ee45 3604 return _gdi_.DC_GetDepth(*args, **kwargs)
e811c8ce
RD
3605
3606 def GetPPI(*args, **kwargs):
f5b96ee1
RD
3607 """
3608 GetPPI(self) -> Size
3609
3610 Resolution in Pixels per inch
3611 """
54f9ee45 3612 return _gdi_.DC_GetPPI(*args, **kwargs)
e811c8ce
RD
3613
3614 def Ok(*args, **kwargs):
f5b96ee1
RD
3615 """
3616 Ok(self) -> bool
3617
3618 Returns true if the DC is ok to use.
3619 """
54f9ee45 3620 return _gdi_.DC_Ok(*args, **kwargs)
e811c8ce
RD
3621
3622 def GetBackgroundMode(*args, **kwargs):
f5b96ee1
RD
3623 """
3624 GetBackgroundMode(self) -> int
3625
3626 Returns the current background mode, either ``wx.SOLID`` or
3627 ``wx.TRANSPARENT``.
3628 """
54f9ee45 3629 return _gdi_.DC_GetBackgroundMode(*args, **kwargs)
e811c8ce
RD
3630
3631 def GetBackground(*args, **kwargs):
f5b96ee1
RD
3632 """
3633 GetBackground(self) -> Brush
3634
3635 Gets the brush used for painting the background.
3636 """
54f9ee45 3637 return _gdi_.DC_GetBackground(*args, **kwargs)
e811c8ce
RD
3638
3639 def GetBrush(*args, **kwargs):
f5b96ee1
RD
3640 """
3641 GetBrush(self) -> Brush
3642
3643 Gets the current brush
3644 """
54f9ee45 3645 return _gdi_.DC_GetBrush(*args, **kwargs)
e811c8ce
RD
3646
3647 def GetFont(*args, **kwargs):
f5b96ee1
RD
3648 """
3649 GetFont(self) -> Font
3650
3651 Gets the current font
3652 """
54f9ee45 3653 return _gdi_.DC_GetFont(*args, **kwargs)
e811c8ce
RD
3654
3655 def GetPen(*args, **kwargs):
f5b96ee1
RD
3656 """
3657 GetPen(self) -> Pen
3658
3659 Gets the current pen
3660 """
54f9ee45 3661 return _gdi_.DC_GetPen(*args, **kwargs)
e811c8ce
RD
3662
3663 def GetTextBackground(*args, **kwargs):
f5b96ee1
RD
3664 """
3665 GetTextBackground(self) -> Colour
3666
3667 Gets the current text background colour
3668 """
54f9ee45 3669 return _gdi_.DC_GetTextBackground(*args, **kwargs)
e811c8ce
RD
3670
3671 def GetTextForeground(*args, **kwargs):
f5b96ee1
RD
3672 """
3673 GetTextForeground(self) -> Colour
3674
3675 Gets the current text foreground colour
3676 """
54f9ee45 3677 return _gdi_.DC_GetTextForeground(*args, **kwargs)
e811c8ce
RD
3678
3679 def SetTextForeground(*args, **kwargs):
f5b96ee1
RD
3680 """
3681 SetTextForeground(self, Colour colour)
3682
3683 Sets the current text foreground colour for the DC.
3684 """
54f9ee45 3685 return _gdi_.DC_SetTextForeground(*args, **kwargs)
e811c8ce
RD
3686
3687 def SetTextBackground(*args, **kwargs):
f5b96ee1
RD
3688 """
3689 SetTextBackground(self, Colour colour)
3690
3691 Sets the current text background colour for the DC.
3692 """
54f9ee45 3693 return _gdi_.DC_SetTextBackground(*args, **kwargs)
e811c8ce
RD
3694
3695 def GetMapMode(*args, **kwargs):
f5b96ee1
RD
3696 """
3697 GetMapMode(self) -> int
3698
3699 Gets the current *mapping mode* for the device context
3700 """
54f9ee45 3701 return _gdi_.DC_GetMapMode(*args, **kwargs)
e811c8ce
RD
3702
3703 def SetMapMode(*args, **kwargs):
f5b96ee1
RD
3704 """
3705 SetMapMode(self, int mode)
3706
3707 The *mapping mode* of the device context defines the unit of
3708 measurement used to convert logical units to device units. The
3709 mapping mode can be one of the following:
3710
3711 ================ =============================================
3712 wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440
3713 of an inch.
3714 wx.MM_POINTS Each logical unit is a point, or 1/72 of an inch.
3715 wx.MM_METRIC Each logical unit is 1 mm.
3716 wx.MM_LOMETRIC Each logical unit is 1/10 of a mm.
3717 wx.MM_TEXT Each logical unit is 1 pixel.
3718 ================ =============================================
3719
3720 """
54f9ee45 3721 return _gdi_.DC_SetMapMode(*args, **kwargs)
e811c8ce
RD
3722
3723 def GetUserScale(*args, **kwargs):
f5b96ee1
RD
3724 """
3725 GetUserScale(self) -> (xScale, yScale)
3726
3727 Gets the current user scale factor (set by `SetUserScale`).
3728 """
54f9ee45 3729 return _gdi_.DC_GetUserScale(*args, **kwargs)
e811c8ce
RD
3730
3731 def SetUserScale(*args, **kwargs):
f5b96ee1
RD
3732 """
3733 SetUserScale(self, double x, double y)
3734
3735 Sets the user scaling factor, useful for applications which require
3736 'zooming'.
3737 """
54f9ee45 3738 return _gdi_.DC_SetUserScale(*args, **kwargs)
e811c8ce
RD
3739
3740 def GetLogicalScale(*args, **kwargs):
322913ce 3741 """GetLogicalScale() -> (xScale, yScale)"""
54f9ee45 3742 return _gdi_.DC_GetLogicalScale(*args, **kwargs)
e811c8ce
RD
3743
3744 def SetLogicalScale(*args, **kwargs):
a95a7133 3745 """SetLogicalScale(self, double x, double y)"""
54f9ee45 3746 return _gdi_.DC_SetLogicalScale(*args, **kwargs)
e811c8ce 3747
e811c8ce 3748 def GetLogicalOrigin(*args, **kwargs):
a95a7133 3749 """GetLogicalOrigin(self) -> Point"""
54f9ee45 3750 return _gdi_.DC_GetLogicalOrigin(*args, **kwargs)
e811c8ce 3751
322913ce
RD
3752 def GetLogicalOriginTuple(*args, **kwargs):
3753 """GetLogicalOriginTuple() -> (x,y)"""
54f9ee45 3754 return _gdi_.DC_GetLogicalOriginTuple(*args, **kwargs)
322913ce 3755
e811c8ce 3756 def SetLogicalOrigin(*args, **kwargs):
a95a7133 3757 """SetLogicalOrigin(self, int x, int y)"""
54f9ee45 3758 return _gdi_.DC_SetLogicalOrigin(*args, **kwargs)
e811c8ce 3759
03e37cd5
RD
3760 def SetLogicalOriginPoint(*args, **kwargs):
3761 """SetLogicalOriginPoint(self, Point point)"""
3762 return _gdi_.DC_SetLogicalOriginPoint(*args, **kwargs)
3763
e811c8ce 3764 def GetDeviceOrigin(*args, **kwargs):
a95a7133 3765 """GetDeviceOrigin(self) -> Point"""
54f9ee45 3766 return _gdi_.DC_GetDeviceOrigin(*args, **kwargs)
e811c8ce 3767
322913ce
RD
3768 def GetDeviceOriginTuple(*args, **kwargs):
3769 """GetDeviceOriginTuple() -> (x,y)"""
54f9ee45 3770 return _gdi_.DC_GetDeviceOriginTuple(*args, **kwargs)
322913ce 3771
e811c8ce 3772 def SetDeviceOrigin(*args, **kwargs):
a95a7133 3773 """SetDeviceOrigin(self, int x, int y)"""
54f9ee45 3774 return _gdi_.DC_SetDeviceOrigin(*args, **kwargs)
e811c8ce 3775
03e37cd5
RD
3776 def SetDeviceOriginPoint(*args, **kwargs):
3777 """SetDeviceOriginPoint(self, Point point)"""
3778 return _gdi_.DC_SetDeviceOriginPoint(*args, **kwargs)
3779
e811c8ce 3780 def SetAxisOrientation(*args, **kwargs):
f5b96ee1
RD
3781 """
3782 SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
3783
3784 Sets the x and y axis orientation (i.e., the direction from lowest to
3785 highest values on the axis). The default orientation is the natural
3786 orientation, e.g. x axis from left to right and y axis from bottom up.
3787 """
54f9ee45 3788 return _gdi_.DC_SetAxisOrientation(*args, **kwargs)
e811c8ce
RD
3789
3790 def GetLogicalFunction(*args, **kwargs):
f5b96ee1
RD
3791 """
3792 GetLogicalFunction(self) -> int
3793
3794 Gets the current logical function (set by `SetLogicalFunction`).
3795 """
54f9ee45 3796 return _gdi_.DC_GetLogicalFunction(*args, **kwargs)
e811c8ce
RD
3797
3798 def SetLogicalFunction(*args, **kwargs):
f5b96ee1
RD
3799 """
3800 SetLogicalFunction(self, int function)
3801
3802 Sets the current logical function for the device context. This
3803 determines how a source pixel (from a pen or brush colour, or source
3804 device context if using `Blit`) combines with a destination pixel in
3805 the current device context.
3806
3807 The possible values and their meaning in terms of source and
3808 destination pixel values are as follows:
3809
3810 ================ ==========================
3811 wx.AND src AND dst
3812 wx.AND_INVERT (NOT src) AND dst
3813 wx.AND_REVERSE src AND (NOT dst)
3814 wx.CLEAR 0
3815 wx.COPY src
3816 wx.EQUIV (NOT src) XOR dst
3817 wx.INVERT NOT dst
3818 wx.NAND (NOT src) OR (NOT dst)
3819 wx.NOR (NOT src) AND (NOT dst)
3820 wx.NO_OP dst
3821 wx.OR src OR dst
3822 wx.OR_INVERT (NOT src) OR dst
3823 wx.OR_REVERSE src OR (NOT dst)
3824 wx.SET 1
3825 wx.SRC_INVERT NOT src
3826 wx.XOR src XOR dst
3827 ================ ==========================
3828
3829 The default is wx.COPY, which simply draws with the current
3830 colour. The others combine the current colour and the background using
3831 a logical operation. wx.INVERT is commonly used for drawing rubber
3832 bands or moving outlines, since drawing twice reverts to the original
3833 colour.
3834
3835 """
54f9ee45 3836 return _gdi_.DC_SetLogicalFunction(*args, **kwargs)
e811c8ce 3837
5cbf236d 3838 def ComputeScaleAndOrigin(*args, **kwargs):
f5b96ee1 3839 """
5cbf236d 3840 ComputeScaleAndOrigin(self)
f5b96ee1 3841
5cbf236d
RD
3842 Performs all necessary computations for given platform and context
3843 type after each change of scale and origin parameters. Usually called
3844 automatically internally after such changes.
f5b96ee1 3845
f5b96ee1 3846 """
5cbf236d 3847 return _gdi_.DC_ComputeScaleAndOrigin(*args, **kwargs)
e811c8ce 3848
5cbf236d
RD
3849 def SetOptimization(self, optimize):
3850 pass
3851 def GetOptimization(self):
3852 return False
f5b96ee1 3853
5cbf236d
RD
3854 SetOptimization = wx._deprecated(SetOptimization)
3855 GetOptimization = wx._deprecated(GetOptimization)
e811c8ce
RD
3856
3857 def CalcBoundingBox(*args, **kwargs):
f5b96ee1
RD
3858 """
3859 CalcBoundingBox(self, int x, int y)
3860
3861 Adds the specified point to the bounding box which can be retrieved
3862 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3863 """
54f9ee45 3864 return _gdi_.DC_CalcBoundingBox(*args, **kwargs)
e811c8ce 3865
03e37cd5 3866 def CalcBoundingBoxPoint(*args, **kwargs):
f5b96ee1
RD
3867 """
3868 CalcBoundingBoxPoint(self, Point point)
3869
3870 Adds the specified point to the bounding box which can be retrieved
3871 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
3872 """
03e37cd5
RD
3873 return _gdi_.DC_CalcBoundingBoxPoint(*args, **kwargs)
3874
e811c8ce 3875 def ResetBoundingBox(*args, **kwargs):
f5b96ee1
RD
3876 """
3877 ResetBoundingBox(self)
3878
3879 Resets the bounding box: after a call to this function, the bounding
3880 box doesn't contain anything.
3881 """
54f9ee45 3882 return _gdi_.DC_ResetBoundingBox(*args, **kwargs)
e811c8ce
RD
3883
3884 def MinX(*args, **kwargs):
f5b96ee1
RD
3885 """
3886 MinX(self) -> int
3887
3888 Gets the minimum horizontal extent used in drawing commands so far.
3889 """
54f9ee45 3890 return _gdi_.DC_MinX(*args, **kwargs)
e811c8ce
RD
3891
3892 def MaxX(*args, **kwargs):
f5b96ee1
RD
3893 """
3894 MaxX(self) -> int
3895
3896 Gets the maximum horizontal extent used in drawing commands so far.
3897 """
54f9ee45 3898 return _gdi_.DC_MaxX(*args, **kwargs)
e811c8ce
RD
3899
3900 def MinY(*args, **kwargs):
f5b96ee1
RD
3901 """
3902 MinY(self) -> int
3903
3904 Gets the minimum vertical extent used in drawing commands so far.
3905 """
54f9ee45 3906 return _gdi_.DC_MinY(*args, **kwargs)
e811c8ce
RD
3907
3908 def MaxY(*args, **kwargs):
f5b96ee1
RD
3909 """
3910 MaxY(self) -> int
3911
3912 Gets the maximum vertical extent used in drawing commands so far.
3913 """
54f9ee45 3914 return _gdi_.DC_MaxY(*args, **kwargs)
e811c8ce
RD
3915
3916 def GetBoundingBox(*args, **kwargs):
f5b96ee1
RD
3917 """
3918 GetBoundingBox() -> (x1,y1, x2,y2)
3919
3920 Returns the min and max points used in drawing commands so far.
3921 """
54f9ee45 3922 return _gdi_.DC_GetBoundingBox(*args, **kwargs)
e811c8ce 3923
d14a1e28 3924 def __nonzero__(self): return self.Ok()
e811c8ce 3925 def _DrawPointList(*args, **kwargs):
a95a7133 3926 """_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
54f9ee45 3927 return _gdi_.DC__DrawPointList(*args, **kwargs)
e811c8ce
RD
3928
3929 def _DrawLineList(*args, **kwargs):
a95a7133 3930 """_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
54f9ee45 3931 return _gdi_.DC__DrawLineList(*args, **kwargs)
e811c8ce
RD
3932
3933 def _DrawRectangleList(*args, **kwargs):
a95a7133 3934 """_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
54f9ee45 3935 return _gdi_.DC__DrawRectangleList(*args, **kwargs)
e811c8ce
RD
3936
3937 def _DrawEllipseList(*args, **kwargs):
a95a7133 3938 """_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
54f9ee45 3939 return _gdi_.DC__DrawEllipseList(*args, **kwargs)
e811c8ce
RD
3940
3941 def _DrawPolygonList(*args, **kwargs):
a95a7133 3942 """_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject"""
54f9ee45 3943 return _gdi_.DC__DrawPolygonList(*args, **kwargs)
e811c8ce
RD
3944
3945 def _DrawTextList(*args, **kwargs):
0df68c9f 3946 """
a95a7133 3947 _DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
0df68c9f
RD
3948 PyObject backgroundList) -> PyObject
3949 """
54f9ee45 3950 return _gdi_.DC__DrawTextList(*args, **kwargs)
e811c8ce 3951
3bcd5e1c 3952 def DrawPointList(self, points, pens=None):
f5b96ee1
RD
3953 """
3954 Draw a list of points as quickly as possible.
3955
3956 :param points: A sequence of 2-element sequences representing
3957 each point to draw, (x,y).
3958 :param pens: If None, then the current pen is used. If a
3959 single pen then it will be used for all points. If
3960 a list of pens then there should be one for each point
3961 in points.
3962 """
3bcd5e1c
RD
3963 if pens is None:
3964 pens = []
d14a1e28 3965 elif isinstance(pens, wx.Pen):
3bcd5e1c
RD
3966 pens = [pens]
3967 elif len(pens) != len(points):
3968 raise ValueError('points and pens must have same length')
b67a9327
RD
3969 return self._DrawPointList(points, pens, [])
3970
3bcd5e1c
RD
3971
3972 def DrawLineList(self, lines, pens=None):
f5b96ee1
RD
3973 """
3974 Draw a list of lines as quickly as possible.
3975
3976 :param lines: A sequence of 4-element sequences representing
3977 each line to draw, (x1,y1, x2,y2).
3978 :param pens: If None, then the current pen is used. If a
3979 single pen then it will be used for all lines. If
3980 a list of pens then there should be one for each line
3981 in lines.
3982 """
3bcd5e1c
RD
3983 if pens is None:
3984 pens = []
d14a1e28 3985 elif isinstance(pens, wx.Pen):
3bcd5e1c
RD
3986 pens = [pens]
3987 elif len(pens) != len(lines):
3988 raise ValueError('lines and pens must have same length')
b67a9327
RD
3989 return self._DrawLineList(lines, pens, [])
3990
3991
3992 def DrawRectangleList(self, rectangles, pens=None, brushes=None):
f5b96ee1
RD
3993 """
3994 Draw a list of rectangles as quickly as possible.
3995
3996 :param rectangles: A sequence of 4-element sequences representing
3997 each rectangle to draw, (x,y, w,h).
3998 :param pens: If None, then the current pen is used. If a
3999 single pen then it will be used for all rectangles.
4000 If a list of pens then there should be one for each
4001 rectangle in rectangles.
4002 :param brushes: A brush or brushes to be used to fill the rectagles,
4003 with similar semantics as the pens parameter.
4004 """
b67a9327
RD
4005 if pens is None:
4006 pens = []
d14a1e28 4007 elif isinstance(pens, wx.Pen):
b67a9327
RD
4008 pens = [pens]
4009 elif len(pens) != len(rectangles):
4010 raise ValueError('rectangles and pens must have same length')
4011 if brushes is None:
4012 brushes = []
d14a1e28 4013 elif isinstance(brushes, wx.Brush):
b67a9327
RD
4014 brushes = [brushes]
4015 elif len(brushes) != len(rectangles):
4016 raise ValueError('rectangles and brushes must have same length')
4017 return self._DrawRectangleList(rectangles, pens, brushes)
4018
4019
4020 def DrawEllipseList(self, ellipses, pens=None, brushes=None):
f5b96ee1
RD
4021 """
4022 Draw a list of ellipses as quickly as possible.
4023
4024 :param ellipses: A sequence of 4-element sequences representing
4025 each ellipse to draw, (x,y, w,h).
4026 :param pens: If None, then the current pen is used. If a
4027 single pen then it will be used for all ellipses.
4028 If a list of pens then there should be one for each
4029 ellipse in ellipses.
4030 :param brushes: A brush or brushes to be used to fill the ellipses,
4031 with similar semantics as the pens parameter.
4032 """
b67a9327
RD
4033 if pens is None:
4034 pens = []
d14a1e28 4035 elif isinstance(pens, wx.Pen):
b67a9327
RD
4036 pens = [pens]
4037 elif len(pens) != len(ellipses):
4038 raise ValueError('ellipses and pens must have same length')
4039 if brushes is None:
4040 brushes = []
d14a1e28 4041 elif isinstance(brushes, wx.Brush):
b67a9327
RD
4042 brushes = [brushes]
4043 elif len(brushes) != len(ellipses):
4044 raise ValueError('ellipses and brushes must have same length')
4045 return self._DrawEllipseList(ellipses, pens, brushes)
4046
4047
4048 def DrawPolygonList(self, polygons, pens=None, brushes=None):
f5b96ee1
RD
4049 """
4050 Draw a list of polygons, each of which is a list of points.
4051
4052 :param polygons: A sequence of sequences of sequences.
4053 [[(x1,y1),(x2,y2),(x3,y3)...],
4054 [(x1,y1),(x2,y2),(x3,y3)...]]
4055
4056 :param pens: If None, then the current pen is used. If a
4057 single pen then it will be used for all polygons.
4058 If a list of pens then there should be one for each
4059 polygon.
4060 :param brushes: A brush or brushes to be used to fill the polygons,
4061 with similar semantics as the pens parameter.
4062 """
b67a9327
RD
4063 if pens is None:
4064 pens = []
d14a1e28 4065 elif isinstance(pens, wx.Pen):
b67a9327
RD
4066 pens = [pens]
4067 elif len(pens) != len(polygons):
4068 raise ValueError('polygons and pens must have same length')
4069 if brushes is None:
4070 brushes = []
d14a1e28 4071 elif isinstance(brushes, wx.Brush):
b67a9327
RD
4072 brushes = [brushes]
4073 elif len(brushes) != len(polygons):
4074 raise ValueError('polygons and brushes must have same length')
4075 return self._DrawPolygonList(polygons, pens, brushes)
4076
4077
f5b96ee1
RD
4078 def DrawTextList(self, textList, coords, foregrounds = None, backgrounds = None):
4079 """
4080 Draw a list of strings using a list of coordinants for positioning each string.
4081
4082 :param textList: A list of strings
4083 :param coords: A list of (x,y) positions
4084 :param foregrounds: A list of `wx.Colour` objects to use for the
4085 foregrounds of the strings.
4086 :param backgrounds: A list of `wx.Colour` objects to use for the
4087 backgrounds of the strings.
4088
4089 NOTE: Make sure you set Background mode to wx.Solid (DC.SetBackgroundMode)
4090 If you want backgrounds to do anything.
4091 """
b67a9327
RD
4092 if type(textList) == type(''):
4093 textList = [textList]
4094 elif len(textList) != len(coords):
4095 raise ValueError('textlist and coords must have same length')
4096 if foregrounds is None:
4097 foregrounds = []
fd3f2efe 4098 elif isinstance(foregrounds, wx.Colour):
b67a9327
RD
4099 foregrounds = [foregrounds]
4100 elif len(foregrounds) != len(coords):
4101 raise ValueError('foregrounds and coords must have same length')
4102 if backgrounds is None:
4103 backgrounds = []
fd3f2efe 4104 elif isinstance(backgrounds, wx.Colour):
b67a9327
RD
4105 backgrounds = [backgrounds]
4106 elif len(backgrounds) != len(coords):
4107 raise ValueError('backgrounds and coords must have same length')
4108 return self._DrawTextList(textList, coords, foregrounds, backgrounds)
3bcd5e1c 4109
70551f47 4110
d14a1e28
RD
4111class DCPtr(DC):
4112 def __init__(self, this):
4113 self.this = this
4114 if not hasattr(self,"thisown"): self.thisown = 0
4115 self.__class__ = DC
54f9ee45 4116_gdi_.DC_swigregister(DCPtr)
70551f47 4117
d14a1e28 4118#---------------------------------------------------------------------------
70551f47 4119
d14a1e28 4120class MemoryDC(DC):
f5b96ee1
RD
4121 """
4122 A memory device context provides a means to draw graphics onto a
4123 bitmap. A bitmap must be selected into the new memory DC before it may
4124 be used for anything. Typical usage is as follows::
4125
4126 dc = wx.MemoryDC()
4127 dc.SelectObject(bitmap)
4128 # draw on the dc usign any of the Draw methods
4129 dc.SelectObject(wx.NullBitmap)
4130 # the bitmap now contains wahtever was drawn upon it
4131
4132 Note that the memory DC *must* be deleted (or the bitmap selected out
4133 of it) before a bitmap can be reselected into another memory DC.
4134
4135 """
e811c8ce
RD
4136 def __repr__(self):
4137 return "<%s.%s; proxy of C++ wxMemoryDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4138 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4139 """
4140 __init__(self) -> MemoryDC
4141
4142 Constructs a new memory device context.
4143
4144 Use the Ok member to test whether the constructor was successful in
4145 creating a usable device context. Don't forget to select a bitmap into
4146 the DC before drawing on it.
4147 """
54f9ee45 4148 newobj = _gdi_.new_MemoryDC(*args, **kwargs)
d14a1e28 4149 self.this = newobj.this
70551f47 4150 self.thisown = 1
d14a1e28 4151 del newobj.thisown
e811c8ce 4152 def SelectObject(*args, **kwargs):
f5b96ee1
RD
4153 """
4154 SelectObject(self, Bitmap bitmap)
4155
4156 Selects the bitmap into the device context, to use as the memory
4157 bitmap. Selecting the bitmap into a memory DC allows you to draw into
4158 the DC, and therefore the bitmap, and also to use Blit to copy the
4159 bitmap to a window.
4160
4161 If the argument is wx.NullBitmap (or some other uninitialised
4162 `wx.Bitmap`) the current bitmap is selected out of the device context,
4163 and the original bitmap restored, allowing the current bitmap to be
4164 destroyed safely.
4165 """
54f9ee45 4166 return _gdi_.MemoryDC_SelectObject(*args, **kwargs)
e811c8ce 4167
70551f47 4168
d14a1e28
RD
4169class MemoryDCPtr(MemoryDC):
4170 def __init__(self, this):
4171 self.this = this
4172 if not hasattr(self,"thisown"): self.thisown = 0
4173 self.__class__ = MemoryDC
54f9ee45 4174_gdi_.MemoryDC_swigregister(MemoryDCPtr)
70551f47 4175
d14a1e28 4176def MemoryDCFromDC(*args, **kwargs):
f5b96ee1
RD
4177 """
4178 MemoryDCFromDC(DC oldDC) -> MemoryDC
4179
4180 Creates a DC that is compatible with the oldDC.
4181 """
54f9ee45 4182 val = _gdi_.new_MemoryDCFromDC(*args, **kwargs)
d14a1e28
RD
4183 val.thisown = 1
4184 return val
70551f47 4185
d14a1e28 4186#---------------------------------------------------------------------------
70551f47 4187
e2950dbb
RD
4188BUFFER_VIRTUAL_AREA = _gdi_.BUFFER_VIRTUAL_AREA
4189BUFFER_CLIENT_AREA = _gdi_.BUFFER_CLIENT_AREA
d14a1e28 4190class BufferedDC(MemoryDC):
f5b96ee1
RD
4191 """
4192 This simple class provides a simple way to avoid flicker: when drawing
4193 on it, everything is in fact first drawn on an in-memory buffer (a
4194 `wx.Bitmap`) and then copied to the screen only once, when this object
4195 is destroyed.
4196
4197 It can be used in the same way as any other device
4198 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
4199 want to use it in your EVT_PAINT handler, you should look at
4200 `wx.BufferedPaintDC`.
4201
4202 """
e811c8ce
RD
4203 def __repr__(self):
4204 return "<%s.%s; proxy of C++ wxBufferedDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
3adfb63b
RD
4205 def __init__(self, *args):
4206 """
8f4d7c19 4207 __init__(self, DC dc, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedDC
e2950dbb 4208 __init__(self, DC dc, Size area, int style=BUFFER_CLIENT_AREA) -> BufferedDC
f5b96ee1
RD
4209
4210 Constructs a buffered DC.
3adfb63b 4211 """
54f9ee45 4212 newobj = _gdi_.new_BufferedDC(*args)
d14a1e28 4213 self.this = newobj.this
a884bee5 4214 self.thisown = 1
d14a1e28 4215 del newobj.thisown
f5b96ee1 4216 self.__dc = args[0] # save a ref so the other dc will not be deleted before self
e811c8ce 4217
54f9ee45 4218 def __del__(self, destroy=_gdi_.delete_BufferedDC):
f5b96ee1
RD
4219 """
4220 __del__(self)
4221
4222 Copies everything drawn on the DC so far to the underlying DC
4223 associated with this object, if any.
4224 """
e498079e
RD
4225 try:
4226 if self.thisown: destroy(self)
4227 except: pass
4228
e811c8ce 4229 def UnMask(*args, **kwargs):
f5b96ee1
RD
4230 """
4231 UnMask(self)
4232
4233 Blits the buffer to the dc, and detaches the dc from the buffer (so it
4234 can be effectively used once only). This is usually only called in
4235 the destructor.
4236 """
54f9ee45 4237 return _gdi_.BufferedDC_UnMask(*args, **kwargs)
e811c8ce 4238
a884bee5 4239
d14a1e28
RD
4240class BufferedDCPtr(BufferedDC):
4241 def __init__(self, this):
4242 self.this = this
4243 if not hasattr(self,"thisown"): self.thisown = 0
4244 self.__class__ = BufferedDC
54f9ee45 4245_gdi_.BufferedDC_swigregister(BufferedDCPtr)
a884bee5 4246
d14a1e28 4247class BufferedPaintDC(BufferedDC):
f5b96ee1
RD
4248 """
4249 This is a subclass of `wx.BufferedDC` which can be used inside of an
4250 EVT_PAINT event handler. Just create an object of this class instead
4251 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
4252 flicker. The only thing to watch out for is that if you are using this
4253 class together with `wx.ScrolledWindow`, you probably do **not** want
4254 to call `wx.Window.PrepareDC` on it as it already does this internally
4255 for the real underlying `wx.PaintDC`.
4256
4257 If your window is already fully buffered in a `wx.Bitmap` then your
4258 EVT_PAINT handler can be as simple as just creating a
4259 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
4260 automatically when it is destroyed. For example::
4261
4262 def OnPaint(self, event):
4263 dc = wx.BufferedPaintDC(self, self.buffer)
4264
4265
4266
e2950dbb
RD
4267
4268
f5b96ee1 4269 """
e811c8ce
RD
4270 def __repr__(self):
4271 return "<%s.%s; proxy of C++ wxBufferedPaintDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e498079e 4272 def __init__(self, *args, **kwargs):
f5b96ee1 4273 """
e2950dbb 4274 __init__(self, Window window, Bitmap buffer=NullBitmap, int style=BUFFER_CLIENT_AREA) -> BufferedPaintDC
f5b96ee1
RD
4275
4276 Create a buffered paint DC. As with `wx.BufferedDC`, you may either
4277 provide the bitmap to be used for buffering or let this object create
4278 one internally (in the latter case, the size of the client part of the
4279 window is automatically used).
4280
4281
4282 """
54f9ee45 4283 newobj = _gdi_.new_BufferedPaintDC(*args, **kwargs)
d14a1e28 4284 self.this = newobj.this
a884bee5 4285 self.thisown = 1
d14a1e28 4286 del newobj.thisown
a884bee5 4287
d14a1e28
RD
4288class BufferedPaintDCPtr(BufferedPaintDC):
4289 def __init__(self, this):
4290 self.this = this
4291 if not hasattr(self,"thisown"): self.thisown = 0
4292 self.__class__ = BufferedPaintDC
54f9ee45 4293_gdi_.BufferedPaintDC_swigregister(BufferedPaintDCPtr)
a884bee5 4294
d14a1e28 4295#---------------------------------------------------------------------------
a884bee5 4296
d14a1e28 4297class ScreenDC(DC):
f5b96ee1
RD
4298 """
4299 A wxScreenDC can be used to paint anywhere on the screen. This should
4300 normally be constructed as a temporary stack object; don't store a
4301 wxScreenDC object.
4302
4303 """
e811c8ce
RD
4304 def __repr__(self):
4305 return "<%s.%s; proxy of C++ wxScreenDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4306 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4307 """
4308 __init__(self) -> ScreenDC
4309
4310 A wxScreenDC can be used to paint anywhere on the screen. This should
4311 normally be constructed as a temporary stack object; don't store a
4312 wxScreenDC object.
4313
4314 """
54f9ee45 4315 newobj = _gdi_.new_ScreenDC(*args, **kwargs)
d14a1e28 4316 self.this = newobj.this
70551f47 4317 self.thisown = 1
d14a1e28 4318 del newobj.thisown
e811c8ce 4319 def StartDrawingOnTopWin(*args, **kwargs):
f5b96ee1
RD
4320 """
4321 StartDrawingOnTopWin(self, Window window) -> bool
4322
4323 Specify that the area of the screen to be drawn upon coincides with
4324 the given window.
4325
4326 :see: `EndDrawingOnTop`
4327 """
54f9ee45 4328 return _gdi_.ScreenDC_StartDrawingOnTopWin(*args, **kwargs)
e811c8ce
RD
4329
4330 def StartDrawingOnTop(*args, **kwargs):
f5b96ee1
RD
4331 """
4332 StartDrawingOnTop(self, Rect rect=None) -> bool
4333
4334 Specify that the area is the given rectangle, or the whole screen if
4335 ``None`` is passed.
4336
4337 :see: `EndDrawingOnTop`
4338 """
54f9ee45 4339 return _gdi_.ScreenDC_StartDrawingOnTop(*args, **kwargs)
e811c8ce
RD
4340
4341 def EndDrawingOnTop(*args, **kwargs):
f5b96ee1
RD
4342 """
4343 EndDrawingOnTop(self) -> bool
4344
4345 Use this in conjunction with `StartDrawingOnTop` or
4346 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
4347 top of existing windows. Without this, some window systems (such as X)
4348 only allow drawing to take place underneath other windows.
4349
4350 You might use this pair of functions when implementing a drag feature,
4351 for example as in the `wx.SplitterWindow` implementation.
4352
4353 These functions are probably obsolete since the X implementations
4354 allow drawing directly on the screen now. However, the fact that this
4355 function allows the screen to be refreshed afterwards may be useful
4356 to some applications.
4357 """
54f9ee45 4358 return _gdi_.ScreenDC_EndDrawingOnTop(*args, **kwargs)
e811c8ce 4359
70551f47 4360
d14a1e28
RD
4361class ScreenDCPtr(ScreenDC):
4362 def __init__(self, this):
4363 self.this = this
4364 if not hasattr(self,"thisown"): self.thisown = 0
4365 self.__class__ = ScreenDC
54f9ee45 4366_gdi_.ScreenDC_swigregister(ScreenDCPtr)
70551f47 4367
d14a1e28 4368#---------------------------------------------------------------------------
70551f47 4369
d14a1e28 4370class ClientDC(DC):
f5b96ee1
RD
4371 """
4372 A wx.ClientDC must be constructed if an application wishes to paint on
4373 the client area of a window from outside an EVT_PAINT event. This should
4374 normally be constructed as a temporary stack object; don't store a
4375 wx.ClientDC object long term.
4376
4377 To draw on a window from within an EVT_PAINT handler, construct a
4378 `wx.PaintDC` object.
4379
4380 To draw on the whole window including decorations, construct a
4381 `wx.WindowDC` object (Windows only).
4382
4383 """
e811c8ce
RD
4384 def __repr__(self):
4385 return "<%s.%s; proxy of C++ wxClientDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4386 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4387 """
4388 __init__(self, Window win) -> ClientDC
4389
4390 Constructor. Pass the window on which you wish to paint.
4391 """
54f9ee45 4392 newobj = _gdi_.new_ClientDC(*args, **kwargs)
d14a1e28 4393 self.this = newobj.this
70551f47 4394 self.thisown = 1
d14a1e28 4395 del newobj.thisown
70551f47 4396
d14a1e28
RD
4397class ClientDCPtr(ClientDC):
4398 def __init__(self, this):
4399 self.this = this
4400 if not hasattr(self,"thisown"): self.thisown = 0
4401 self.__class__ = ClientDC
54f9ee45 4402_gdi_.ClientDC_swigregister(ClientDCPtr)
70551f47 4403
d14a1e28 4404#---------------------------------------------------------------------------
70551f47 4405
d14a1e28 4406class PaintDC(DC):
f5b96ee1
RD
4407 """
4408 A wx.PaintDC must be constructed if an application wishes to paint on
4409 the client area of a window from within an EVT_PAINT event
4410 handler. This should normally be constructed as a temporary stack
4411 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
4412 handler, you **must** create a wx.PaintDC object within it even if you
4413 don't actually use it.
4414
4415 Using wx.PaintDC within EVT_PAINT handlers is important because it
4416 automatically sets the clipping area to the damaged area of the
4417 window. Attempts to draw outside this area do not appear.
4418
4419 To draw on a window from outside EVT_PAINT handlers, construct a
4420 `wx.ClientDC` object.
4421
4422 """
e811c8ce
RD
4423 def __repr__(self):
4424 return "<%s.%s; proxy of C++ wxPaintDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4425 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4426 """
4427 __init__(self, Window win) -> PaintDC
4428
4429 Constructor. Pass the window on which you wish to paint.
4430 """
54f9ee45 4431 newobj = _gdi_.new_PaintDC(*args, **kwargs)
d14a1e28 4432 self.this = newobj.this
70551f47 4433 self.thisown = 1
d14a1e28 4434 del newobj.thisown
70551f47 4435
d14a1e28
RD
4436class PaintDCPtr(PaintDC):
4437 def __init__(self, this):
4438 self.this = this
4439 if not hasattr(self,"thisown"): self.thisown = 0
4440 self.__class__ = PaintDC
54f9ee45 4441_gdi_.PaintDC_swigregister(PaintDCPtr)
70551f47 4442
d14a1e28 4443#---------------------------------------------------------------------------
70551f47 4444
d14a1e28 4445class WindowDC(DC):
f5b96ee1
RD
4446 """
4447 A wx.WindowDC must be constructed if an application wishes to paint on
4448 the whole area of a window (client and decorations). This should
4449 normally be constructed as a temporary stack object; don't store a
4450 wx.WindowDC object.
4451 """
e811c8ce
RD
4452 def __repr__(self):
4453 return "<%s.%s; proxy of C++ wxWindowDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4454 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4455 """
4456 __init__(self, Window win) -> WindowDC
4457
4458 Constructor. Pass the window on which you wish to paint.
4459 """
54f9ee45 4460 newobj = _gdi_.new_WindowDC(*args, **kwargs)
d14a1e28 4461 self.this = newobj.this
c95e68d8 4462 self.thisown = 1
d14a1e28 4463 del newobj.thisown
c95e68d8 4464
d14a1e28
RD
4465class WindowDCPtr(WindowDC):
4466 def __init__(self, this):
4467 self.this = this
4468 if not hasattr(self,"thisown"): self.thisown = 0
4469 self.__class__ = WindowDC
54f9ee45 4470_gdi_.WindowDC_swigregister(WindowDCPtr)
c95e68d8 4471
d14a1e28 4472#---------------------------------------------------------------------------
c95e68d8 4473
d14a1e28 4474class MirrorDC(DC):
f5b96ee1
RD
4475 """
4476 wx.MirrorDC is a simple wrapper class which is always associated with a
4477 real `wx.DC` object and either forwards all of its operations to it
4478 without changes (no mirroring takes place) or exchanges x and y
4479 coordinates which makes it possible to reuse the same code to draw a
4480 figure and its mirror -- i.e. reflection related to the diagonal line
4481 x == y.
4482 """
e811c8ce
RD
4483 def __repr__(self):
4484 return "<%s.%s; proxy of C++ wxMirrorDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4485 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4486 """
4487 __init__(self, DC dc, bool mirror) -> MirrorDC
4488
4489 Creates a mirrored DC associated with the real *dc*. Everything drawn
4490 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
4491 *mirror* is True.
4492 """
54f9ee45 4493 newobj = _gdi_.new_MirrorDC(*args, **kwargs)
d14a1e28 4494 self.this = newobj.this
3ef86e32 4495 self.thisown = 1
d14a1e28 4496 del newobj.thisown
3ef86e32 4497
d14a1e28
RD
4498class MirrorDCPtr(MirrorDC):
4499 def __init__(self, this):
4500 self.this = this
4501 if not hasattr(self,"thisown"): self.thisown = 0
4502 self.__class__ = MirrorDC
54f9ee45 4503_gdi_.MirrorDC_swigregister(MirrorDCPtr)
3ef86e32 4504
d14a1e28 4505#---------------------------------------------------------------------------
3ef86e32 4506
d14a1e28 4507class PostScriptDC(DC):
f5b96ee1 4508 """This is a `wx.DC` that can write to PostScript files on any platform."""
e811c8ce
RD
4509 def __repr__(self):
4510 return "<%s.%s; proxy of C++ wxPostScriptDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4511 def __init__(self, *args, **kwargs):
f5b96ee1
RD
4512 """
4513 __init__(self, wxPrintData printData) -> PostScriptDC
4514
4515 Constructs a PostScript printer device context from a `wx.PrintData`
4516 object.
4517 """
54f9ee45 4518 newobj = _gdi_.new_PostScriptDC(*args, **kwargs)
d14a1e28
RD
4519 self.this = newobj.this
4520 self.thisown = 1
4521 del newobj.thisown
e811c8ce 4522 def GetPrintData(*args, **kwargs):
a95a7133 4523 """GetPrintData(self) -> wxPrintData"""
54f9ee45 4524 return _gdi_.PostScriptDC_GetPrintData(*args, **kwargs)
e811c8ce
RD
4525
4526 def SetPrintData(*args, **kwargs):
a95a7133 4527 """SetPrintData(self, wxPrintData data)"""
54f9ee45 4528 return _gdi_.PostScriptDC_SetPrintData(*args, **kwargs)
e811c8ce
RD
4529
4530 def SetResolution(*args, **kwargs):
f5b96ee1
RD
4531 """
4532 SetResolution(int ppi)
4533
4534 Set resolution (in pixels per inch) that will be used in PostScript
4535 output. Default is 720ppi.
4536 """
54f9ee45 4537 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
e811c8ce
RD
4538
4539 SetResolution = staticmethod(SetResolution)
4540 def GetResolution(*args, **kwargs):
f5b96ee1
RD
4541 """
4542 GetResolution() -> int
4543
4544 Return resolution used in PostScript output.
4545 """
54f9ee45 4546 return _gdi_.PostScriptDC_GetResolution(*args, **kwargs)
e811c8ce
RD
4547
4548 GetResolution = staticmethod(GetResolution)
3ef86e32 4549
d14a1e28
RD
4550class PostScriptDCPtr(PostScriptDC):
4551 def __init__(self, this):
105e45b9 4552 self.this = this
d14a1e28
RD
4553 if not hasattr(self,"thisown"): self.thisown = 0
4554 self.__class__ = PostScriptDC
54f9ee45 4555_gdi_.PostScriptDC_swigregister(PostScriptDCPtr)
105e45b9 4556
e811c8ce 4557def PostScriptDC_SetResolution(*args, **kwargs):
f5b96ee1
RD
4558 """
4559 PostScriptDC_SetResolution(int ppi)
4560
4561 Set resolution (in pixels per inch) that will be used in PostScript
4562 output. Default is 720ppi.
4563 """
54f9ee45 4564 return _gdi_.PostScriptDC_SetResolution(*args, **kwargs)
105e45b9 4565
e811c8ce 4566def PostScriptDC_GetResolution(*args, **kwargs):
f5b96ee1
RD
4567 """
4568 PostScriptDC_GetResolution() -> int
4569
4570 Return resolution used in PostScript output.
4571 """
54f9ee45 4572 return _gdi_.PostScriptDC_GetResolution(*args, **kwargs)
105e45b9 4573
d14a1e28 4574#---------------------------------------------------------------------------
105e45b9 4575
54f9ee45 4576class MetaFile(_core.Object):
093d3ff1 4577 """Proxy of C++ MetaFile class"""
e811c8ce
RD
4578 def __repr__(self):
4579 return "<%s.%s; proxy of C++ wxMetaFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4580 def __init__(self, *args, **kwargs):
a95a7133 4581 """__init__(self, String filename=EmptyString) -> MetaFile"""
54f9ee45 4582 newobj = _gdi_.new_MetaFile(*args, **kwargs)
d14a1e28 4583 self.this = newobj.this
21f8d7ea 4584 self.thisown = 1
d14a1e28 4585 del newobj.thisown
21f8d7ea 4586
d14a1e28
RD
4587class MetaFilePtr(MetaFile):
4588 def __init__(self, this):
9df61a29 4589 self.this = this
d14a1e28
RD
4590 if not hasattr(self,"thisown"): self.thisown = 0
4591 self.__class__ = MetaFile
54f9ee45 4592_gdi_.MetaFile_swigregister(MetaFilePtr)
d14a1e28
RD
4593
4594class MetaFileDC(DC):
093d3ff1 4595 """Proxy of C++ MetaFileDC class"""
e811c8ce
RD
4596 def __repr__(self):
4597 return "<%s.%s; proxy of C++ wxMetaFileDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4598 def __init__(self, *args, **kwargs):
0df68c9f 4599 """
a95a7133 4600 __init__(self, String filename=EmptyString, int width=0, int height=0,
196addbf 4601 String description=EmptyString) -> MetaFileDC
0df68c9f 4602 """
54f9ee45 4603 newobj = _gdi_.new_MetaFileDC(*args, **kwargs)
d14a1e28 4604 self.this = newobj.this
9df61a29 4605 self.thisown = 1
d14a1e28 4606 del newobj.thisown
9df61a29 4607
d14a1e28
RD
4608class MetaFileDCPtr(MetaFileDC):
4609 def __init__(self, this):
9df61a29 4610 self.this = this
d14a1e28
RD
4611 if not hasattr(self,"thisown"): self.thisown = 0
4612 self.__class__ = MetaFileDC
54f9ee45 4613_gdi_.MetaFileDC_swigregister(MetaFileDCPtr)
d14a1e28
RD
4614
4615class PrinterDC(DC):
093d3ff1 4616 """Proxy of C++ PrinterDC class"""
e811c8ce
RD
4617 def __repr__(self):
4618 return "<%s.%s; proxy of C++ wxPrinterDC instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4619 def __init__(self, *args, **kwargs):
a95a7133 4620 """__init__(self, wxPrintData printData) -> PrinterDC"""
54f9ee45 4621 newobj = _gdi_.new_PrinterDC(*args, **kwargs)
d14a1e28 4622 self.this = newobj.this
9df61a29 4623 self.thisown = 1
d14a1e28 4624 del newobj.thisown
9df61a29 4625
d14a1e28
RD
4626class PrinterDCPtr(PrinterDC):
4627 def __init__(self, this):
4628 self.this = this
4629 if not hasattr(self,"thisown"): self.thisown = 0
4630 self.__class__ = PrinterDC
54f9ee45 4631_gdi_.PrinterDC_swigregister(PrinterDCPtr)
d14a1e28
RD
4632
4633#---------------------------------------------------------------------------
4634
54f9ee45
RD
4635IMAGELIST_DRAW_NORMAL = _gdi_.IMAGELIST_DRAW_NORMAL
4636IMAGELIST_DRAW_TRANSPARENT = _gdi_.IMAGELIST_DRAW_TRANSPARENT
4637IMAGELIST_DRAW_SELECTED = _gdi_.IMAGELIST_DRAW_SELECTED
4638IMAGELIST_DRAW_FOCUSED = _gdi_.IMAGELIST_DRAW_FOCUSED
4639IMAGE_LIST_NORMAL = _gdi_.IMAGE_LIST_NORMAL
4640IMAGE_LIST_SMALL = _gdi_.IMAGE_LIST_SMALL
4641IMAGE_LIST_STATE = _gdi_.IMAGE_LIST_STATE
4642class ImageList(_core.Object):
093d3ff1 4643 """Proxy of C++ ImageList class"""
e811c8ce
RD
4644 def __repr__(self):
4645 return "<%s.%s; proxy of C++ wxImageList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4646 def __init__(self, *args, **kwargs):
a95a7133 4647 """__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList"""
54f9ee45 4648 newobj = _gdi_.new_ImageList(*args, **kwargs)
d14a1e28
RD
4649 self.this = newobj.this
4650 self.thisown = 1
4651 del newobj.thisown
54f9ee45 4652 def __del__(self, destroy=_gdi_.delete_ImageList):
a95a7133 4653 """__del__(self)"""
d14a1e28
RD
4654 try:
4655 if self.thisown: destroy(self)
4656 except: pass
e811c8ce
RD
4657
4658 def Add(*args, **kwargs):
a95a7133 4659 """Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int"""
54f9ee45 4660 return _gdi_.ImageList_Add(*args, **kwargs)
e811c8ce
RD
4661
4662 def AddWithColourMask(*args, **kwargs):
a95a7133 4663 """AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int"""
54f9ee45 4664 return _gdi_.ImageList_AddWithColourMask(*args, **kwargs)
e811c8ce
RD
4665
4666 def AddIcon(*args, **kwargs):
a95a7133 4667 """AddIcon(self, Icon icon) -> int"""
54f9ee45 4668 return _gdi_.ImageList_AddIcon(*args, **kwargs)
e811c8ce 4669
b9d6a5f3
RD
4670 def GetBitmap(*args, **kwargs):
4671 """GetBitmap(self, int index) -> Bitmap"""
4672 return _gdi_.ImageList_GetBitmap(*args, **kwargs)
4673
4674 def GetIcon(*args, **kwargs):
4675 """GetIcon(self, int index) -> Icon"""
4676 return _gdi_.ImageList_GetIcon(*args, **kwargs)
4677
e811c8ce 4678 def Replace(*args, **kwargs):
a95a7133 4679 """Replace(self, int index, Bitmap bitmap) -> bool"""
54f9ee45 4680 return _gdi_.ImageList_Replace(*args, **kwargs)
e811c8ce
RD
4681
4682 def Draw(*args, **kwargs):
0df68c9f 4683 """
a95a7133 4684 Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
0df68c9f
RD
4685 bool solidBackground=False) -> bool
4686 """
54f9ee45 4687 return _gdi_.ImageList_Draw(*args, **kwargs)
e811c8ce
RD
4688
4689 def GetImageCount(*args, **kwargs):
a95a7133 4690 """GetImageCount(self) -> int"""
54f9ee45 4691 return _gdi_.ImageList_GetImageCount(*args, **kwargs)
e811c8ce
RD
4692
4693 def Remove(*args, **kwargs):
a95a7133 4694 """Remove(self, int index) -> bool"""
54f9ee45 4695 return _gdi_.ImageList_Remove(*args, **kwargs)
e811c8ce
RD
4696
4697 def RemoveAll(*args, **kwargs):
a95a7133 4698 """RemoveAll(self) -> bool"""
54f9ee45 4699 return _gdi_.ImageList_RemoveAll(*args, **kwargs)
e811c8ce
RD
4700
4701 def GetSize(*args, **kwargs):
322913ce 4702 """GetSize() -> (width,height)"""
54f9ee45 4703 return _gdi_.ImageList_GetSize(*args, **kwargs)
e811c8ce 4704
9df61a29 4705
d14a1e28
RD
4706class ImageListPtr(ImageList):
4707 def __init__(self, this):
4708 self.this = this
4709 if not hasattr(self,"thisown"): self.thisown = 0
4710 self.__class__ = ImageList
54f9ee45 4711_gdi_.ImageList_swigregister(ImageListPtr)
d14a1e28
RD
4712
4713#---------------------------------------------------------------------------
4714
54f9ee45 4715class PenList(_core.Object):
093d3ff1 4716 """Proxy of C++ PenList class"""
d14a1e28
RD
4717 def __init__(self): raise RuntimeError, "No constructor defined"
4718 def __repr__(self):
4719 return "<%s.%s; proxy of C++ wxPenList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 4720 def AddPen(*args, **kwargs):
a95a7133 4721 """AddPen(self, Pen pen)"""
54f9ee45 4722 return _gdi_.PenList_AddPen(*args, **kwargs)
e811c8ce
RD
4723
4724 def FindOrCreatePen(*args, **kwargs):
a95a7133 4725 """FindOrCreatePen(self, Colour colour, int width, int style) -> Pen"""
54f9ee45 4726 return _gdi_.PenList_FindOrCreatePen(*args, **kwargs)
e811c8ce
RD
4727
4728 def RemovePen(*args, **kwargs):
a95a7133 4729 """RemovePen(self, Pen pen)"""
54f9ee45 4730 return _gdi_.PenList_RemovePen(*args, **kwargs)
e811c8ce
RD
4731
4732 def GetCount(*args, **kwargs):
a95a7133 4733 """GetCount(self) -> int"""
54f9ee45 4734 return _gdi_.PenList_GetCount(*args, **kwargs)
e811c8ce 4735
9df61a29 4736
d14a1e28
RD
4737class PenListPtr(PenList):
4738 def __init__(self, this):
4739 self.this = this
4740 if not hasattr(self,"thisown"): self.thisown = 0
4741 self.__class__ = PenList
54f9ee45
RD
4742_gdi_.PenList_swigregister(PenListPtr)
4743cvar = _gdi_.cvar
994141e6
RD
4744NORMAL_FONT = cvar.NORMAL_FONT
4745SMALL_FONT = cvar.SMALL_FONT
4746ITALIC_FONT = cvar.ITALIC_FONT
4747SWISS_FONT = cvar.SWISS_FONT
4748RED_PEN = cvar.RED_PEN
4749CYAN_PEN = cvar.CYAN_PEN
4750GREEN_PEN = cvar.GREEN_PEN
4751BLACK_PEN = cvar.BLACK_PEN
4752WHITE_PEN = cvar.WHITE_PEN
4753TRANSPARENT_PEN = cvar.TRANSPARENT_PEN
4754BLACK_DASHED_PEN = cvar.BLACK_DASHED_PEN
4755GREY_PEN = cvar.GREY_PEN
4756MEDIUM_GREY_PEN = cvar.MEDIUM_GREY_PEN
4757LIGHT_GREY_PEN = cvar.LIGHT_GREY_PEN
4758BLUE_BRUSH = cvar.BLUE_BRUSH
4759GREEN_BRUSH = cvar.GREEN_BRUSH
4760WHITE_BRUSH = cvar.WHITE_BRUSH
4761BLACK_BRUSH = cvar.BLACK_BRUSH
4762TRANSPARENT_BRUSH = cvar.TRANSPARENT_BRUSH
4763CYAN_BRUSH = cvar.CYAN_BRUSH
4764RED_BRUSH = cvar.RED_BRUSH
4765GREY_BRUSH = cvar.GREY_BRUSH
4766MEDIUM_GREY_BRUSH = cvar.MEDIUM_GREY_BRUSH
4767LIGHT_GREY_BRUSH = cvar.LIGHT_GREY_BRUSH
4768BLACK = cvar.BLACK
4769WHITE = cvar.WHITE
4770RED = cvar.RED
4771BLUE = cvar.BLUE
4772GREEN = cvar.GREEN
4773CYAN = cvar.CYAN
4774LIGHT_GREY = cvar.LIGHT_GREY
4775STANDARD_CURSOR = cvar.STANDARD_CURSOR
4776HOURGLASS_CURSOR = cvar.HOURGLASS_CURSOR
4777CROSS_CURSOR = cvar.CROSS_CURSOR
4778NullBitmap = cvar.NullBitmap
4779NullIcon = cvar.NullIcon
4780NullCursor = cvar.NullCursor
4781NullPen = cvar.NullPen
4782NullBrush = cvar.NullBrush
4783NullPalette = cvar.NullPalette
4784NullFont = cvar.NullFont
4785NullColour = cvar.NullColour
d14a1e28 4786
54f9ee45 4787class BrushList(_core.Object):
093d3ff1 4788 """Proxy of C++ BrushList class"""
d14a1e28
RD
4789 def __init__(self): raise RuntimeError, "No constructor defined"
4790 def __repr__(self):
4791 return "<%s.%s; proxy of C++ wxBrushList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 4792 def AddBrush(*args, **kwargs):
a95a7133 4793 """AddBrush(self, Brush brush)"""
54f9ee45 4794 return _gdi_.BrushList_AddBrush(*args, **kwargs)
e811c8ce
RD
4795
4796 def FindOrCreateBrush(*args, **kwargs):
61d07ac7 4797 """FindOrCreateBrush(self, Colour colour, int style=SOLID) -> Brush"""
54f9ee45 4798 return _gdi_.BrushList_FindOrCreateBrush(*args, **kwargs)
e811c8ce
RD
4799
4800 def RemoveBrush(*args, **kwargs):
a95a7133 4801 """RemoveBrush(self, Brush brush)"""
54f9ee45 4802 return _gdi_.BrushList_RemoveBrush(*args, **kwargs)
e811c8ce
RD
4803
4804 def GetCount(*args, **kwargs):
a95a7133 4805 """GetCount(self) -> int"""
54f9ee45 4806 return _gdi_.BrushList_GetCount(*args, **kwargs)
e811c8ce 4807
9df61a29 4808
d14a1e28
RD
4809class BrushListPtr(BrushList):
4810 def __init__(self, this):
4811 self.this = this
4812 if not hasattr(self,"thisown"): self.thisown = 0
4813 self.__class__ = BrushList
54f9ee45 4814_gdi_.BrushList_swigregister(BrushListPtr)
d14a1e28 4815
54f9ee45 4816class ColourDatabase(_core.Object):
093d3ff1 4817 """Proxy of C++ ColourDatabase class"""
e811c8ce
RD
4818 def __repr__(self):
4819 return "<%s.%s; proxy of C++ wxColourDatabase instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4820 def __init__(self, *args, **kwargs):
a95a7133 4821 """__init__(self) -> ColourDatabase"""
54f9ee45 4822 newobj = _gdi_.new_ColourDatabase(*args, **kwargs)
d14a1e28
RD
4823 self.this = newobj.this
4824 self.thisown = 1
4825 del newobj.thisown
54f9ee45 4826 def __del__(self, destroy=_gdi_.delete_ColourDatabase):
a95a7133 4827 """__del__(self)"""
d14a1e28
RD
4828 try:
4829 if self.thisown: destroy(self)
4830 except: pass
e811c8ce
RD
4831
4832 def Find(*args, **kwargs):
a95a7133 4833 """Find(self, String name) -> Colour"""
54f9ee45 4834 return _gdi_.ColourDatabase_Find(*args, **kwargs)
e811c8ce
RD
4835
4836 def FindName(*args, **kwargs):
a95a7133 4837 """FindName(self, Colour colour) -> String"""
54f9ee45 4838 return _gdi_.ColourDatabase_FindName(*args, **kwargs)
e811c8ce 4839
d14a1e28 4840 FindColour = Find
e811c8ce 4841 def AddColour(*args, **kwargs):
a95a7133 4842 """AddColour(self, String name, Colour colour)"""
54f9ee45 4843 return _gdi_.ColourDatabase_AddColour(*args, **kwargs)
e811c8ce
RD
4844
4845 def Append(*args, **kwargs):
a95a7133 4846 """Append(self, String name, int red, int green, int blue)"""
54f9ee45 4847 return _gdi_.ColourDatabase_Append(*args, **kwargs)
e811c8ce 4848
70551f47 4849
d14a1e28
RD
4850class ColourDatabasePtr(ColourDatabase):
4851 def __init__(self, this):
4852 self.this = this
4853 if not hasattr(self,"thisown"): self.thisown = 0
4854 self.__class__ = ColourDatabase
54f9ee45 4855_gdi_.ColourDatabase_swigregister(ColourDatabasePtr)
d14a1e28 4856
54f9ee45 4857class FontList(_core.Object):
093d3ff1 4858 """Proxy of C++ FontList class"""
d14a1e28
RD
4859 def __init__(self): raise RuntimeError, "No constructor defined"
4860 def __repr__(self):
4861 return "<%s.%s; proxy of C++ wxFontList instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
e811c8ce 4862 def AddFont(*args, **kwargs):
a95a7133 4863 """AddFont(self, Font font)"""
54f9ee45 4864 return _gdi_.FontList_AddFont(*args, **kwargs)
e811c8ce
RD
4865
4866 def FindOrCreateFont(*args, **kwargs):
0df68c9f 4867 """
a95a7133 4868 FindOrCreateFont(self, int point_size, int family, int style, int weight,
196addbf
RD
4869 bool underline=False, String facename=EmptyString,
4870 int encoding=FONTENCODING_DEFAULT) -> Font
0df68c9f 4871 """
54f9ee45 4872 return _gdi_.FontList_FindOrCreateFont(*args, **kwargs)
e811c8ce
RD
4873
4874 def RemoveFont(*args, **kwargs):
a95a7133 4875 """RemoveFont(self, Font font)"""
54f9ee45 4876 return _gdi_.FontList_RemoveFont(*args, **kwargs)
e811c8ce
RD
4877
4878 def GetCount(*args, **kwargs):
a95a7133 4879 """GetCount(self) -> int"""
54f9ee45 4880 return _gdi_.FontList_GetCount(*args, **kwargs)
e811c8ce 4881
70551f47 4882
d14a1e28
RD
4883class FontListPtr(FontList):
4884 def __init__(self, this):
4885 self.this = this
4886 if not hasattr(self,"thisown"): self.thisown = 0
4887 self.__class__ = FontList
54f9ee45 4888_gdi_.FontList_swigregister(FontListPtr)
70551f47 4889
d14a1e28 4890#---------------------------------------------------------------------------
fbcadfca 4891
994141e6 4892NullColor = NullColour
d14a1e28 4893#---------------------------------------------------------------------------
fbcadfca 4894
54f9ee45 4895class Effects(_core.Object):
093d3ff1 4896 """Proxy of C++ Effects class"""
e811c8ce
RD
4897 def __repr__(self):
4898 return "<%s.%s; proxy of C++ wxEffects instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
d14a1e28 4899 def __init__(self, *args, **kwargs):
a95a7133 4900 """__init__(self) -> Effects"""
54f9ee45 4901 newobj = _gdi_.new_Effects(*args, **kwargs)
d14a1e28
RD
4902 self.this = newobj.this
4903 self.thisown = 1
4904 del newobj.thisown
e811c8ce 4905 def GetHighlightColour(*args, **kwargs):
a95a7133 4906 """GetHighlightColour(self) -> Colour"""
54f9ee45 4907 return _gdi_.Effects_GetHighlightColour(*args, **kwargs)
e811c8ce
RD
4908
4909 def GetLightShadow(*args, **kwargs):
a95a7133 4910 """GetLightShadow(self) -> Colour"""
54f9ee45 4911 return _gdi_.Effects_GetLightShadow(*args, **kwargs)
e811c8ce
RD
4912
4913 def GetFaceColour(*args, **kwargs):
a95a7133 4914 """GetFaceColour(self) -> Colour"""
54f9ee45 4915 return _gdi_.Effects_GetFaceColour(*args, **kwargs)
e811c8ce
RD
4916
4917 def GetMediumShadow(*args, **kwargs):
a95a7133 4918 """GetMediumShadow(self) -> Colour"""
54f9ee45 4919 return _gdi_.Effects_GetMediumShadow(*args, **kwargs)
e811c8ce
RD
4920
4921 def GetDarkShadow(*args, **kwargs):
a95a7133 4922 """GetDarkShadow(self) -> Colour"""
54f9ee45 4923 return _gdi_.Effects_GetDarkShadow(*args, **kwargs)
e811c8ce
RD
4924
4925 def SetHighlightColour(*args, **kwargs):
a95a7133 4926 """SetHighlightColour(self, Colour c)"""
54f9ee45 4927 return _gdi_.Effects_SetHighlightColour(*args, **kwargs)
e811c8ce
RD
4928
4929 def SetLightShadow(*args, **kwargs):
a95a7133 4930 """SetLightShadow(self, Colour c)"""
54f9ee45 4931 return _gdi_.Effects_SetLightShadow(*args, **kwargs)
e811c8ce
RD
4932
4933 def SetFaceColour(*args, **kwargs):
a95a7133 4934 """SetFaceColour(self, Colour c)"""
54f9ee45 4935 return _gdi_.Effects_SetFaceColour(*args, **kwargs)
e811c8ce
RD
4936
4937 def SetMediumShadow(*args, **kwargs):
a95a7133 4938 """SetMediumShadow(self, Colour c)"""
54f9ee45 4939 return _gdi_.Effects_SetMediumShadow(*args, **kwargs)
e811c8ce
RD
4940
4941 def SetDarkShadow(*args, **kwargs):
a95a7133 4942 """SetDarkShadow(self, Colour c)"""
54f9ee45 4943 return _gdi_.Effects_SetDarkShadow(*args, **kwargs)
e811c8ce
RD
4944
4945 def Set(*args, **kwargs):
0df68c9f 4946 """
a95a7133 4947 Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
0df68c9f
RD
4948 Colour mediumShadow, Colour darkShadow)
4949 """
54f9ee45 4950 return _gdi_.Effects_Set(*args, **kwargs)
e811c8ce
RD
4951
4952 def DrawSunkenEdge(*args, **kwargs):
a95a7133 4953 """DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)"""
54f9ee45 4954 return _gdi_.Effects_DrawSunkenEdge(*args, **kwargs)
4be61064 4955
e811c8ce 4956 def TileBitmap(*args, **kwargs):
a95a7133 4957 """TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool"""
54f9ee45 4958 return _gdi_.Effects_TileBitmap(*args, **kwargs)
e811c8ce
RD
4959
4960
4961class EffectsPtr(Effects):
d14a1e28
RD
4962 def __init__(self, this):
4963 self.this = this
4964 if not hasattr(self,"thisown"): self.thisown = 0
e811c8ce 4965 self.__class__ = Effects
54f9ee45 4966_gdi_.Effects_swigregister(EffectsPtr)
d14a1e28
RD
4967TheFontList = cvar.TheFontList
4968ThePenList = cvar.ThePenList
4969TheBrushList = cvar.TheBrushList
4970TheColourDatabase = cvar.TheColourDatabase
4971
8d38bd1d
RD
4972#---------------------------------------------------------------------------
4973
4974CONTROL_DISABLED = _gdi_.CONTROL_DISABLED
4975CONTROL_FOCUSED = _gdi_.CONTROL_FOCUSED
4976CONTROL_PRESSED = _gdi_.CONTROL_PRESSED
4977CONTROL_ISDEFAULT = _gdi_.CONTROL_ISDEFAULT
4978CONTROL_ISSUBMENU = _gdi_.CONTROL_ISSUBMENU
4979CONTROL_EXPANDED = _gdi_.CONTROL_EXPANDED
4980CONTROL_CURRENT = _gdi_.CONTROL_CURRENT
4981CONTROL_SELECTED = _gdi_.CONTROL_SELECTED
4982CONTROL_CHECKED = _gdi_.CONTROL_CHECKED
4983CONTROL_CHECKABLE = _gdi_.CONTROL_CHECKABLE
4984CONTROL_UNDETERMINED = _gdi_.CONTROL_UNDETERMINED
4985CONTROL_FLAGS_MASK = _gdi_.CONTROL_FLAGS_MASK
4986CONTROL_DIRTY = _gdi_.CONTROL_DIRTY
4987class SplitterRenderParams(object):
4988 """
4989 This is just a simple struct used as a return value of
4990 `wx.RendererNative.GetSplitterParams` and contains some platform
4991 specific metrics about splitters.
4992
4993 * widthSash: the width of the splitter sash.
4994 * border: the width of the border of the splitter window.
4995 * isHotSensitive: ``True`` if the splitter changes its
4996 appearance when the mouse is over it.
4997
4998
4999 """
5000 def __repr__(self):
5001 return "<%s.%s; proxy of C++ wxSplitterRenderParams instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5002 def __init__(self, *args, **kwargs):
5003 """
5004 __init__(self, int widthSash_, int border_, bool isSens_) -> SplitterRenderParams
5005
5006 This is just a simple struct used as a return value of
5007 `wx.RendererNative.GetSplitterParams` and contains some platform
5008 specific metrics about splitters.
5009
5010 * widthSash: the width of the splitter sash.
5011 * border: the width of the border of the splitter window.
5012 * isHotSensitive: ``True`` if the splitter changes its
5013 appearance when the mouse is over it.
5014
5015
5016 """
5017 newobj = _gdi_.new_SplitterRenderParams(*args, **kwargs)
5018 self.this = newobj.this
5019 self.thisown = 1
5020 del newobj.thisown
5021 def __del__(self, destroy=_gdi_.delete_SplitterRenderParams):
5022 """__del__(self)"""
5023 try:
5024 if self.thisown: destroy(self)
5025 except: pass
5026
5027 widthSash = property(_gdi_.SplitterRenderParams_widthSash_get)
5028 border = property(_gdi_.SplitterRenderParams_border_get)
5029 isHotSensitive = property(_gdi_.SplitterRenderParams_isHotSensitive_get)
5030
5031class SplitterRenderParamsPtr(SplitterRenderParams):
5032 def __init__(self, this):
5033 self.this = this
5034 if not hasattr(self,"thisown"): self.thisown = 0
5035 self.__class__ = SplitterRenderParams
5036_gdi_.SplitterRenderParams_swigregister(SplitterRenderParamsPtr)
5037
5038class RendererVersion(object):
5039 """
5040 This simple struct represents the `wx.RendererNative` interface
5041 version and is only used as the return value of
5042 `wx.RendererNative.GetVersion`.
5043 """
5044 def __repr__(self):
5045 return "<%s.%s; proxy of C++ wxRendererVersion instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5046 def __init__(self, *args, **kwargs):
5047 """
5048 __init__(self, int version_, int age_) -> RendererVersion
5049
5050 This simple struct represents the `wx.RendererNative` interface
5051 version and is only used as the return value of
5052 `wx.RendererNative.GetVersion`.
5053 """
5054 newobj = _gdi_.new_RendererVersion(*args, **kwargs)
5055 self.this = newobj.this
5056 self.thisown = 1
5057 del newobj.thisown
5058 def __del__(self, destroy=_gdi_.delete_RendererVersion):
5059 """__del__(self)"""
5060 try:
5061 if self.thisown: destroy(self)
5062 except: pass
5063
5064 Current_Version = _gdi_.RendererVersion_Current_Version
5065 Current_Age = _gdi_.RendererVersion_Current_Age
5066 def IsCompatible(*args, **kwargs):
5067 """IsCompatible(RendererVersion ver) -> bool"""
5068 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5069
5070 IsCompatible = staticmethod(IsCompatible)
5071 version = property(_gdi_.RendererVersion_version_get)
5072 age = property(_gdi_.RendererVersion_age_get)
5073
5074class RendererVersionPtr(RendererVersion):
5075 def __init__(self, this):
5076 self.this = this
5077 if not hasattr(self,"thisown"): self.thisown = 0
5078 self.__class__ = RendererVersion
5079_gdi_.RendererVersion_swigregister(RendererVersionPtr)
5080
5081def RendererVersion_IsCompatible(*args, **kwargs):
5082 """RendererVersion_IsCompatible(RendererVersion ver) -> bool"""
5083 return _gdi_.RendererVersion_IsCompatible(*args, **kwargs)
5084
5085class RendererNative(object):
5086 """
5087 One of the design principles of wxWidgets is to use the native widgets
5088 on every platform in order to be as close to the native look and feel
5089 on every platform. However there are still cases when some generic
5090 widgets are needed for various reasons, but it can sometimes take a
5091 lot of messy work to make them conform to the native LnF.
5092
5093 The wx.RendererNative class is a collection of functions that have
5094 platform-specific implementations for drawing certain parts of
5095 genereic controls in ways that are as close to the native look as
5096 possible.
5097
5098 """
5099 def __init__(self): raise RuntimeError, "No constructor defined"
5100 def __repr__(self):
5101 return "<%s.%s; proxy of C++ wxRendererNative instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
5102 def DrawHeaderButton(*args, **kwargs):
5103 """
5104 DrawHeaderButton(self, Window win, DC dc, Rect rect, int flags=0)
5105
5106 Draw the header control button (such as whar is used by `wx.ListCtrl`
5107 in report mode.)
5108 """
5109 return _gdi_.RendererNative_DrawHeaderButton(*args, **kwargs)
5110
5111 def DrawTreeItemButton(*args, **kwargs):
5112 """
5113 DrawTreeItemButton(self, Window win, DC dc, Rect rect, int flags=0)
5114
5115 Draw the expanded/collapsed icon for a tree control item.
5116 """
5117 return _gdi_.RendererNative_DrawTreeItemButton(*args, **kwargs)
5118
5119 def DrawSplitterBorder(*args, **kwargs):
5120 """
5121 DrawSplitterBorder(self, Window win, DC dc, Rect rect, int flags=0)
5122
5123 Draw the border for a sash window: this border must be such that the
5124 sash drawn by `DrawSplitterSash` blends into it well.
5125 """
5126 return _gdi_.RendererNative_DrawSplitterBorder(*args, **kwargs)
5127
5128 def DrawSplitterSash(*args, **kwargs):
5129 """
5130 DrawSplitterSash(self, Window win, DC dc, Size size, int position, int orient,
5131 int flags=0)
5132
5133 Draw a sash. The orient parameter defines whether the sash should be
5134 vertical or horizontal and how the position should be interpreted.
5135 """
5136 return _gdi_.RendererNative_DrawSplitterSash(*args, **kwargs)
5137
5138 def DrawComboBoxDropButton(*args, **kwargs):
5139 """
5140 DrawComboBoxDropButton(self, Window win, DC dc, Rect rect, int flags=0)
5141
5142 Draw a button like the one used by `wx.ComboBox` to show a drop down
5143 window. The usual appearance is a downwards pointing arrow.
5144
5145 The ``flags`` parameter may have the ``wx.CONTROL_PRESSED`` or
5146 ``wx.CONTROL_CURRENT`` bits set.
5147 """
5148 return _gdi_.RendererNative_DrawComboBoxDropButton(*args, **kwargs)
5149
5150 def DrawDropArrow(*args, **kwargs):
5151 """
5152 DrawDropArrow(self, Window win, DC dc, Rect rect, int flags=0)
5153
5154 Draw a drop down arrow that is suitable for use outside a combo
5155 box. Arrow will have a transparent background.
5156
5157 ``rect`` is not entirely filled by the arrow. Instead, you should use
5158 bounding rectangle of a drop down button which arrow matches the size
5159 you need. ``flags`` may have the ``wx.CONTROL_PRESSED`` or
5160 ``wx.CONTROL_CURRENT`` bit set.
5161 """
5162 return _gdi_.RendererNative_DrawDropArrow(*args, **kwargs)
5163
5164 def GetSplitterParams(*args, **kwargs):
5165 """
5166 GetSplitterParams(self, Window win) -> SplitterRenderParams
5167
5168 Get the splitter parameters, see `wx.SplitterRenderParams`.
5169 """
5170 return _gdi_.RendererNative_GetSplitterParams(*args, **kwargs)
5171
5172 def Get(*args, **kwargs):
5173 """
5174 Get() -> RendererNative
5175
5176 Return the currently used renderer
5177 """
5178 return _gdi_.RendererNative_Get(*args, **kwargs)
5179
5180 Get = staticmethod(Get)
5181 def GetGeneric(*args, **kwargs):
5182 """
5183 GetGeneric() -> RendererNative
5184
5185 Return the generic implementation of the renderer. Under some
5186 platforms, this is the default renderer implementation, others have
5187 platform-specific default renderer which can be retrieved by calling
5188 `GetDefault`.
5189 """
5190 return _gdi_.RendererNative_GetGeneric(*args, **kwargs)
5191
5192 GetGeneric = staticmethod(GetGeneric)
5193 def GetDefault(*args, **kwargs):
5194 """
5195 GetDefault() -> RendererNative
5196
5197 Return the default (native) implementation for this platform -- this
5198 is also the one used by default but this may be changed by calling `Set`
5199 in which case the return value of this method may be different from
5200 the return value of `Get`.
5201 """
5202 return _gdi_.RendererNative_GetDefault(*args, **kwargs)
5203
5204 GetDefault = staticmethod(GetDefault)
5205 def Set(*args, **kwargs):
5206 """
5207 Set(RendererNative renderer) -> RendererNative
5208
5209 Set the renderer to use, passing None reverts to using the default
5210 renderer. Returns the previous renderer used with Set or None.
5211 """
5212 return _gdi_.RendererNative_Set(*args, **kwargs)
5213
5214 Set = staticmethod(Set)
5215 def GetVersion(*args, **kwargs):
5216 """
5217 GetVersion(self) -> RendererVersion
5218
5219 Returns the version of the renderer. Will be used for ensuring
5220 compatibility of dynamically loaded renderers.
5221 """
5222 return _gdi_.RendererNative_GetVersion(*args, **kwargs)
5223
5224
5225class RendererNativePtr(RendererNative):
5226 def __init__(self, this):
5227 self.this = this
5228 if not hasattr(self,"thisown"): self.thisown = 0
5229 self.__class__ = RendererNative
5230_gdi_.RendererNative_swigregister(RendererNativePtr)
5231
5232def RendererNative_Get(*args, **kwargs):
5233 """
5234 RendererNative_Get() -> RendererNative
5235
5236 Return the currently used renderer
5237 """
5238 return _gdi_.RendererNative_Get(*args, **kwargs)
5239
5240def RendererNative_GetGeneric(*args, **kwargs):
5241 """
5242 RendererNative_GetGeneric() -> RendererNative
5243
5244 Return the generic implementation of the renderer. Under some
5245 platforms, this is the default renderer implementation, others have
5246 platform-specific default renderer which can be retrieved by calling
5247 `GetDefault`.
5248 """
5249 return _gdi_.RendererNative_GetGeneric(*args, **kwargs)
5250
5251def RendererNative_GetDefault(*args, **kwargs):
5252 """
5253 RendererNative_GetDefault() -> RendererNative
5254
5255 Return the default (native) implementation for this platform -- this
5256 is also the one used by default but this may be changed by calling `Set`
5257 in which case the return value of this method may be different from
5258 the return value of `Get`.
5259 """
5260 return _gdi_.RendererNative_GetDefault(*args, **kwargs)
5261
5262def RendererNative_Set(*args, **kwargs):
5263 """
5264 RendererNative_Set(RendererNative renderer) -> RendererNative
5265
5266 Set the renderer to use, passing None reverts to using the default
5267 renderer. Returns the previous renderer used with Set or None.
5268 """
5269 return _gdi_.RendererNative_Set(*args, **kwargs)
5270
70551f47 5271