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