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