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