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