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