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