5 #// Give a reference to the dictionary of this module to the C++ extension
7 _core_._wxPySetDictionary(vars())
9 #// A little trick to make 'wx' be a reference to this module so wx.Names can
12 wx = _sys.modules[__name__]
16 #----------------------------------------------------------------------------
18 def _deprecated(callable, msg=None):
20 Create a wrapper function that will raise a DeprecationWarning
21 before calling the callable.
24 msg = "%s is deprecated" % callable
25 def deprecatedWrapper(*args, **kwargs):
27 warnings.warn(msg, DeprecationWarning, stacklevel=
2)
28 return callable(*args, **kwargs)
29 deprecatedWrapper.__doc__ = msg
30 return deprecatedWrapper
33 #----------------------------------------------------------------------------
36 #---------------------------------------------------------------------------
38 <class name=
"Object" oldname=
"wxObject" module=
"_core">
39 <docstring>The base class for most wx objects, although in wxPython not
40 much functionality is needed nor exposed.
</docstring>
41 <method name=
"GetClassName" type=
"String" overloaded=
"no">
42 <autodoc>GetClassName(self) -
> String
</autodoc>
43 <docstring>Returns the class name of the C++ class using wxRTTI.
</docstring>
45 <method name=
"Destroy" type=
"" overloaded=
"no">
46 <autodoc>Destroy(self)
</autodoc>
47 <docstring>Deletes the C++ object this Python object is a proxy for.
</docstring>
51 #---------------------------------------------------------------------------
54 #---------------------------------------------------------------------------
56 <class name=
"Size" oldname=
"wxSize" module=
"_core">
57 <docstring>wx.Size is a useful data structure used to represent the size of
58 something. It simply contians integer width and height proprtites.
59 In most places in wxPython where a wx.Size is expected a
60 (width,height) tuple can be used instead.
</docstring>
61 <constructor name=
"Size" overloaded=
"no">
62 <autodoc>__init__(self, int w=
0, int h=
0) -
> Size
</autodoc>
63 <docstring>Creates a size object.
</docstring>
65 <param name=
"w" type=
"int" default=
"0"/>
66 <param name=
"h" type=
"int" default=
"0"/>
69 <destructor name=
"~wxSize" overloaded=
"no">
70 <autodoc>__del__(self)
</autodoc>
72 <property name=
"width" type=
"int" readonly=
"no"/>
73 <property name=
"height" type=
"int" readonly=
"no"/>
74 <method name=
"__eq__" type=
"bool" overloaded=
"no">
75 <autodoc>__eq__(self, Size sz) -
> bool
</autodoc>
76 <docstring>Test for equality of wx.Size objects.
</docstring>
78 <param name=
"sz" type=
"Size" default=
""/>
81 <method name=
"__ne__" type=
"bool" overloaded=
"no">
82 <autodoc>__ne__(self, Size sz) -
> bool
</autodoc>
83 <docstring>Test for inequality.
</docstring>
85 <param name=
"sz" type=
"Size" default=
""/>
88 <method name=
"__add__" type=
"Size" overloaded=
"no">
89 <autodoc>__add__(self, Size sz) -
> Size
</autodoc>
90 <docstring>Add sz's proprties to this and return the result.
</docstring>
92 <param name=
"sz" type=
"Size" default=
""/>
95 <method name=
"__sub__" type=
"Size" overloaded=
"no">
96 <autodoc>__sub__(self, Size sz) -
> Size
</autodoc>
97 <docstring>Subtract sz's properties from this and return the result.
</docstring>
99 <param name=
"sz" type=
"Size" default=
""/>
102 <method name=
"IncTo" type=
"" overloaded=
"no">
103 <autodoc>IncTo(self, Size sz)
</autodoc>
104 <docstring>Increments this object so that both of its dimensions are not less
105 than the corresponding dimensions of the size.
</docstring>
107 <param name=
"sz" type=
"Size" default=
""/>
110 <method name=
"DecTo" type=
"" overloaded=
"no">
111 <autodoc>DecTo(self, Size sz)
</autodoc>
112 <docstring>Decrements this object so that both of its dimensions are not greater
113 than the corresponding dimensions of the size.
</docstring>
115 <param name=
"sz" type=
"Size" default=
""/>
118 <method name=
"Set" type=
"" overloaded=
"no">
119 <autodoc>Set(self, int w, int h)
</autodoc>
120 <docstring>Set both width and height.
</docstring>
122 <param name=
"w" type=
"int" default=
""/>
123 <param name=
"h" type=
"int" default=
""/>
126 <method name=
"SetWidth" type=
"" overloaded=
"no">
127 <autodoc>SetWidth(self, int w)
</autodoc>
129 <param name=
"w" type=
"int" default=
""/>
132 <method name=
"SetHeight" type=
"" overloaded=
"no">
133 <autodoc>SetHeight(self, int h)
</autodoc>
135 <param name=
"h" type=
"int" default=
""/>
138 <method name=
"GetWidth" type=
"int" overloaded=
"no">
139 <autodoc>GetWidth(self) -
> int
</autodoc>
141 <method name=
"GetHeight" type=
"int" overloaded=
"no">
142 <autodoc>GetHeight(self) -
> int
</autodoc>
144 <method name=
"IsFullySpecified" type=
"bool" overloaded=
"no">
145 <autodoc>IsFullySpecified(self) -
> bool
</autodoc>
146 <docstring>Returns True if both components of the size are non-default values.
</docstring>
148 <method name=
"SetDefaults" type=
"" overloaded=
"no">
149 <autodoc>SetDefaults(self, Size size)
</autodoc>
150 <docstring>Combine this size with the other one replacing the default components
151 of this object (i.e. equal to -
1) with those of the other.
</docstring>
153 <param name=
"size" type=
"Size" default=
""/>
156 <method name=
"Get" type=
"PyObject" overloaded=
"no">
157 <autodoc>Get() -
> (width,height)
</autodoc>
158 <docstring>Returns the width and height properties as a tuple.
</docstring>
162 #---------------------------------------------------------------------------
164 <class name=
"RealPoint" oldname=
"wxRealPoint" module=
"_core">
165 <docstring>A data structure for representing a point or position with floating
166 point x and y properties. In wxPython most places that expect a
167 wx.RealPoint can also accept a (x,y) tuple.
</docstring>
168 <constructor name=
"RealPoint" overloaded=
"no">
169 <autodoc>__init__(self, double x=
0.0, double y=
0.0) -
> RealPoint
</autodoc>
170 <docstring>Create a wx.RealPoint object
</docstring>
172 <param name=
"x" type=
"double" default=
"0.0"/>
173 <param name=
"y" type=
"double" default=
"0.0"/>
176 <destructor name=
"~wxRealPoint" overloaded=
"no">
177 <autodoc>__del__(self)
</autodoc>
179 <property name=
"x" type=
"double" readonly=
"no"/>
180 <property name=
"y" type=
"double" readonly=
"no"/>
181 <method name=
"__eq__" type=
"bool" overloaded=
"no">
182 <autodoc>__eq__(self, RealPoint pt) -
> bool
</autodoc>
183 <docstring>Test for equality of wx.RealPoint objects.
</docstring>
185 <param name=
"pt" type=
"RealPoint" default=
""/>
188 <method name=
"__ne__" type=
"bool" overloaded=
"no">
189 <autodoc>__ne__(self, RealPoint pt) -
> bool
</autodoc>
190 <docstring>Test for inequality of wx.RealPoint objects.
</docstring>
192 <param name=
"pt" type=
"RealPoint" default=
""/>
195 <method name=
"__add__" type=
"RealPoint" overloaded=
"no">
196 <autodoc>__add__(self, RealPoint pt) -
> RealPoint
</autodoc>
197 <docstring>Add pt's proprties to this and return the result.
</docstring>
199 <param name=
"pt" type=
"RealPoint" default=
""/>
202 <method name=
"__sub__" type=
"RealPoint" overloaded=
"no">
203 <autodoc>__sub__(self, RealPoint pt) -
> RealPoint
</autodoc>
204 <docstring>Subtract pt's proprties from this and return the result
</docstring>
206 <param name=
"pt" type=
"RealPoint" default=
""/>
209 <method name=
"Set" type=
"" overloaded=
"no">
210 <autodoc>Set(self, double x, double y)
</autodoc>
211 <docstring>Set both the x and y properties
</docstring>
213 <param name=
"x" type=
"double" default=
""/>
214 <param name=
"y" type=
"double" default=
""/>
217 <method name=
"Get" type=
"PyObject" overloaded=
"no">
218 <autodoc>Get() -
> (x,y)
</autodoc>
219 <docstring>Return the x and y properties as a tuple.
</docstring>
223 #---------------------------------------------------------------------------
225 <class name=
"Point" oldname=
"wxPoint" module=
"_core">
226 <docstring>A data structure for representing a point or position with integer x
227 and y properties. Most places in wxPython that expect a wx.Point can
228 also accept a (x,y) tuple.
</docstring>
229 <constructor name=
"Point" overloaded=
"no">
230 <autodoc>__init__(self, int x=
0, int y=
0) -
> Point
</autodoc>
231 <docstring>Create a wx.Point object
</docstring>
233 <param name=
"x" type=
"int" default=
"0"/>
234 <param name=
"y" type=
"int" default=
"0"/>
237 <destructor name=
"~wxPoint" overloaded=
"no">
238 <autodoc>__del__(self)
</autodoc>
240 <property name=
"x" type=
"int" readonly=
"no"/>
241 <property name=
"y" type=
"int" readonly=
"no"/>
242 <method name=
"__eq__" type=
"bool" overloaded=
"no">
243 <autodoc>__eq__(self, Point pt) -
> bool
</autodoc>
244 <docstring>Test for equality of wx.Point objects.
</docstring>
246 <param name=
"pt" type=
"Point" default=
""/>
249 <method name=
"__ne__" type=
"bool" overloaded=
"no">
250 <autodoc>__ne__(self, Point pt) -
> bool
</autodoc>
251 <docstring>Test for inequality of wx.Point objects.
</docstring>
253 <param name=
"pt" type=
"Point" default=
""/>
256 <method name=
"__add__" type=
"Point" overloaded=
"no">
257 <autodoc>__add__(self, Point pt) -
> Point
</autodoc>
258 <docstring>Add pt's proprties to this and return the result.
</docstring>
260 <param name=
"pt" type=
"Point" default=
""/>
263 <method name=
"__sub__" type=
"Point" overloaded=
"no">
264 <autodoc>__sub__(self, Point pt) -
> Point
</autodoc>
265 <docstring>Subtract pt's proprties from this and return the result
</docstring>
267 <param name=
"pt" type=
"Point" default=
""/>
270 <method name=
"__iadd__" type=
"Point" overloaded=
"no">
271 <autodoc>__iadd__(self, Point pt) -
> Point
</autodoc>
272 <docstring>Add pt to this object.
</docstring>
274 <param name=
"pt" type=
"Point" default=
""/>
277 <method name=
"__isub__" type=
"Point" overloaded=
"no">
278 <autodoc>__isub__(self, Point pt) -
> Point
</autodoc>
279 <docstring>Subtract pt from this object.
</docstring>
281 <param name=
"pt" type=
"Point" default=
""/>
284 <method name=
"Set" type=
"" overloaded=
"no">
285 <autodoc>Set(self, long x, long y)
</autodoc>
286 <docstring>Set both the x and y properties
</docstring>
288 <param name=
"x" type=
"long" default=
""/>
289 <param name=
"y" type=
"long" default=
""/>
292 <method name=
"Get" type=
"PyObject" overloaded=
"no">
293 <autodoc>Get() -
> (x,y)
</autodoc>
294 <docstring>Return the x and y properties as a tuple.
</docstring>
298 #---------------------------------------------------------------------------
300 <class name=
"Rect" oldname=
"wxRect" module=
"_core">
301 <docstring>A class for representing and manipulating rectangles. It has x, y,
302 width and height properties. In wxPython most palces that expect a
303 wx.Rect can also accept a (x,y,width,height) tuple.
</docstring>
304 <constructor name=
"Rect" overloaded=
"no">
305 <autodoc>__init__(self, int x=
0, int y=
0, int width=
0, int height=
0) -
> Rect
</autodoc>
306 <docstring>Create a new Rect object.
</docstring>
308 <param name=
"x" type=
"int" default=
"0"/>
309 <param name=
"y" type=
"int" default=
"0"/>
310 <param name=
"width" type=
"int" default=
"0"/>
311 <param name=
"height" type=
"int" default=
"0"/>
314 <constructor name=
"RectPP" overloaded=
"no">
315 <autodoc>RectPP(Point topLeft, Point bottomRight) -
> Rect
</autodoc>
316 <docstring>Create a new Rect object from Points representing two corners.
</docstring>
318 <param name=
"topLeft" type=
"Point" default=
""/>
319 <param name=
"bottomRight" type=
"Point" default=
""/>
322 <constructor name=
"RectPS" overloaded=
"no">
323 <autodoc>RectPS(Point pos, Size size) -
> Rect
</autodoc>
324 <docstring>Create a new Rect from a position and size.
</docstring>
326 <param name=
"pos" type=
"Point" default=
""/>
327 <param name=
"size" type=
"Size" default=
""/>
330 <destructor name=
"~wxRect" overloaded=
"no">
331 <autodoc>__del__(self)
</autodoc>
333 <method name=
"GetX" type=
"int" overloaded=
"no">
334 <autodoc>GetX(self) -
> int
</autodoc>
336 <method name=
"SetX" type=
"" overloaded=
"no">
337 <autodoc>SetX(self, int x)
</autodoc>
339 <param name=
"x" type=
"int" default=
""/>
342 <method name=
"GetY" type=
"int" overloaded=
"no">
343 <autodoc>GetY(self) -
> int
</autodoc>
345 <method name=
"SetY" type=
"" overloaded=
"no">
346 <autodoc>SetY(self, int y)
</autodoc>
348 <param name=
"y" type=
"int" default=
""/>
351 <method name=
"GetWidth" type=
"int" overloaded=
"no">
352 <autodoc>GetWidth(self) -
> int
</autodoc>
354 <method name=
"SetWidth" type=
"" overloaded=
"no">
355 <autodoc>SetWidth(self, int w)
</autodoc>
357 <param name=
"w" type=
"int" default=
""/>
360 <method name=
"GetHeight" type=
"int" overloaded=
"no">
361 <autodoc>GetHeight(self) -
> int
</autodoc>
363 <method name=
"SetHeight" type=
"" overloaded=
"no">
364 <autodoc>SetHeight(self, int h)
</autodoc>
366 <param name=
"h" type=
"int" default=
""/>
369 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
370 <autodoc>GetPosition(self) -
> Point
</autodoc>
372 <method name=
"SetPosition" type=
"" overloaded=
"no">
373 <autodoc>SetPosition(self, Point p)
</autodoc>
375 <param name=
"p" type=
"Point" default=
""/>
378 <method name=
"GetSize" type=
"Size" overloaded=
"no">
379 <autodoc>GetSize(self) -
> Size
</autodoc>
381 <method name=
"SetSize" type=
"" overloaded=
"no">
382 <autodoc>SetSize(self, Size s)
</autodoc>
384 <param name=
"s" type=
"Size" default=
""/>
387 <method name=
"GetTopLeft" type=
"Point" overloaded=
"no">
388 <autodoc>GetTopLeft(self) -
> Point
</autodoc>
390 <method name=
"SetTopLeft" type=
"" overloaded=
"no">
391 <autodoc>SetTopLeft(self, Point p)
</autodoc>
393 <param name=
"p" type=
"Point" default=
""/>
396 <method name=
"GetBottomRight" type=
"Point" overloaded=
"no">
397 <autodoc>GetBottomRight(self) -
> Point
</autodoc>
399 <method name=
"SetBottomRight" type=
"" overloaded=
"no">
400 <autodoc>SetBottomRight(self, Point p)
</autodoc>
402 <param name=
"p" type=
"Point" default=
""/>
405 <method name=
"GetLeft" type=
"int" overloaded=
"no">
406 <autodoc>GetLeft(self) -
> int
</autodoc>
408 <method name=
"GetTop" type=
"int" overloaded=
"no">
409 <autodoc>GetTop(self) -
> int
</autodoc>
411 <method name=
"GetBottom" type=
"int" overloaded=
"no">
412 <autodoc>GetBottom(self) -
> int
</autodoc>
414 <method name=
"GetRight" type=
"int" overloaded=
"no">
415 <autodoc>GetRight(self) -
> int
</autodoc>
417 <method name=
"SetLeft" type=
"" overloaded=
"no">
418 <autodoc>SetLeft(self, int left)
</autodoc>
420 <param name=
"left" type=
"int" default=
""/>
423 <method name=
"SetRight" type=
"" overloaded=
"no">
424 <autodoc>SetRight(self, int right)
</autodoc>
426 <param name=
"right" type=
"int" default=
""/>
429 <method name=
"SetTop" type=
"" overloaded=
"no">
430 <autodoc>SetTop(self, int top)
</autodoc>
432 <param name=
"top" type=
"int" default=
""/>
435 <method name=
"SetBottom" type=
"" overloaded=
"no">
436 <autodoc>SetBottom(self, int bottom)
</autodoc>
438 <param name=
"bottom" type=
"int" default=
""/>
441 <method name=
"Inflate" type=
"Rect" overloaded=
"no">
442 <autodoc>Inflate(self, int dx, int dy) -
> Rect
</autodoc>
443 <docstring>Increase the rectangle size by dx in x direction and dy in y
444 direction. Both or one of) parameters may be negative to decrease the
445 rectangle size.
</docstring>
447 <param name=
"dx" type=
"int" default=
""/>
448 <param name=
"dy" type=
"int" default=
""/>
451 <method name=
"Deflate" type=
"Rect" overloaded=
"no">
452 <autodoc>Deflate(self, int dx, int dy) -
> Rect
</autodoc>
453 <docstring>Decrease the rectangle size by dx in x direction and dy in y
454 direction. Both or one of) parameters may be negative to increase the
455 rectngle size. This method is the opposite of Inflate.
</docstring>
457 <param name=
"dx" type=
"int" default=
""/>
458 <param name=
"dy" type=
"int" default=
""/>
461 <method name=
"OffsetXY" type=
"" overloaded=
"no">
462 <autodoc>OffsetXY(self, int dx, int dy)
</autodoc>
463 <docstring>Moves the rectangle by the specified offset. If dx is positive, the
464 rectangle is moved to the right, if dy is positive, it is moved to the
465 bottom, otherwise it is moved to the left or top respectively.
</docstring>
467 <param name=
"dx" type=
"int" default=
""/>
468 <param name=
"dy" type=
"int" default=
""/>
471 <method name=
"Offset" type=
"" overloaded=
"no">
472 <autodoc>Offset(self, Point pt)
</autodoc>
473 <docstring>Same as OffsetXY but uses dx,dy from Point
</docstring>
475 <param name=
"pt" type=
"Point" default=
""/>
478 <method name=
"Intersect" type=
"Rect" overloaded=
"no">
479 <autodoc>Intersect(self, Rect rect) -
> Rect
</autodoc>
480 <docstring>Return the intersectsion of this rectangle and rect.
</docstring>
482 <param name=
"rect" type=
"Rect" default=
""/>
485 <method name=
"__add__" type=
"Rect" overloaded=
"no">
486 <autodoc>__add__(self, Rect rect) -
> Rect
</autodoc>
487 <docstring>Add the properties of rect to this rectangle and return the result.
</docstring>
489 <param name=
"rect" type=
"Rect" default=
""/>
492 <method name=
"__iadd__" type=
"Rect" overloaded=
"no">
493 <autodoc>__iadd__(self, Rect rect) -
> Rect
</autodoc>
494 <docstring>Add the properties of rect to this rectangle, updating this rectangle.
</docstring>
496 <param name=
"rect" type=
"Rect" default=
""/>
499 <method name=
"__eq__" type=
"bool" overloaded=
"no">
500 <autodoc>__eq__(self, Rect rect) -
> bool
</autodoc>
501 <docstring>Test for equality.
</docstring>
503 <param name=
"rect" type=
"Rect" default=
""/>
506 <method name=
"__ne__" type=
"bool" overloaded=
"no">
507 <autodoc>__ne__(self, Rect rect) -
> bool
</autodoc>
508 <docstring>Test for inequality.
</docstring>
510 <param name=
"rect" type=
"Rect" default=
""/>
513 <method name=
"InsideXY" type=
"bool" overloaded=
"no">
514 <autodoc>InsideXY(self, int x, int y) -
> bool
</autodoc>
515 <docstring>Return True if the point is (not strcitly) inside the rect.
</docstring>
517 <param name=
"x" type=
"int" default=
""/>
518 <param name=
"y" type=
"int" default=
""/>
521 <method name=
"Inside" type=
"bool" overloaded=
"no">
522 <autodoc>Inside(self, Point pt) -
> bool
</autodoc>
523 <docstring>Return True if the point is (not strcitly) inside the rect.
</docstring>
525 <param name=
"pt" type=
"Point" default=
""/>
528 <method name=
"Intersects" type=
"bool" overloaded=
"no">
529 <autodoc>Intersects(self, Rect rect) -
> bool
</autodoc>
530 <docstring>Returns True if the rectangles have a non empty intersection.
</docstring>
532 <param name=
"rect" type=
"Rect" default=
""/>
535 <property name=
"x" type=
"int" readonly=
"no"/>
536 <property name=
"y" type=
"int" readonly=
"no"/>
537 <property name=
"width" type=
"int" readonly=
"no"/>
538 <property name=
"height" type=
"int" readonly=
"no"/>
539 <method name=
"Set" type=
"" overloaded=
"no">
540 <autodoc>Set(self, int x=
0, int y=
0, int width=
0, int height=
0)
</autodoc>
541 <docstring>Set all rectangle properties.
</docstring>
543 <param name=
"x" type=
"int" default=
"0"/>
544 <param name=
"y" type=
"int" default=
"0"/>
545 <param name=
"width" type=
"int" default=
"0"/>
546 <param name=
"height" type=
"int" default=
"0"/>
549 <method name=
"Get" type=
"PyObject" overloaded=
"no">
550 <autodoc>Get() -
> (x,y,width,height)
</autodoc>
551 <docstring>Return the rectangle properties as a tuple.
</docstring>
554 <method name=
"IntersectRect" oldname=
"wxIntersectRect" type=
"PyObject" overloaded=
"no">
555 <autodoc>IntersectRect(Rect r1, Rect r2) -
> Rect
</autodoc>
556 <docstring>Calculate and return the intersection of r1 and r2.
</docstring>
558 <param name=
"r1" type=
"Rect" default=
""/>
559 <param name=
"r2" type=
"Rect" default=
""/>
563 #---------------------------------------------------------------------------
565 <class name=
"Point2D" oldname=
"wxPoint2D" module=
"_core">
566 <docstring>wx.Point2Ds represent a point or a vector in a
2d coordinate system
567 with floating point values.
</docstring>
568 <constructor name=
"Point2D" overloaded=
"no">
569 <autodoc>__init__(self, double x=
0.0, double y=
0.0) -
> Point2D
</autodoc>
570 <docstring>Create a w.Point2D object.
</docstring>
572 <param name=
"x" type=
"double" default=
"0.0"/>
573 <param name=
"y" type=
"double" default=
"0.0"/>
576 <constructor name=
"Point2DCopy" overloaded=
"no">
577 <autodoc>Point2DCopy(Point2D pt) -
> Point2D
</autodoc>
578 <docstring>Create a w.Point2D object.
</docstring>
580 <param name=
"pt" type=
"Point2D" default=
""/>
583 <constructor name=
"Point2DFromPoint" overloaded=
"no">
584 <autodoc>Point2DFromPoint(Point pt) -
> Point2D
</autodoc>
585 <docstring>Create a w.Point2D object.
</docstring>
587 <param name=
"pt" type=
"Point" default=
""/>
590 <method name=
"GetFloor" type=
"" overloaded=
"no">
591 <autodoc>GetFloor() -
> (x,y)
</autodoc>
592 <docstring>Convert to integer
</docstring>
594 <param name=
"OUTPUT" type=
"int" default=
""/>
595 <param name=
"OUTPUT" type=
"int" default=
""/>
598 <method name=
"GetRounded" type=
"" overloaded=
"no">
599 <autodoc>GetRounded() -
> (x,y)
</autodoc>
600 <docstring>Convert to integer
</docstring>
602 <param name=
"OUTPUT" type=
"int" default=
""/>
603 <param name=
"OUTPUT" type=
"int" default=
""/>
606 <method name=
"GetVectorLength" type=
"double" overloaded=
"no">
607 <autodoc>GetVectorLength(self) -
> double
</autodoc>
609 <method name=
"GetVectorAngle" type=
"double" overloaded=
"no">
610 <autodoc>GetVectorAngle(self) -
> double
</autodoc>
612 <method name=
"SetVectorLength" type=
"" overloaded=
"no">
613 <autodoc>SetVectorLength(self, double length)
</autodoc>
615 <param name=
"length" type=
"double" default=
""/>
618 <method name=
"SetVectorAngle" type=
"" overloaded=
"no">
619 <autodoc>SetVectorAngle(self, double degrees)
</autodoc>
621 <param name=
"degrees" type=
"double" default=
""/>
624 <method name=
"GetDistance" type=
"double" overloaded=
"no">
625 <autodoc>GetDistance(self, Point2D pt) -
> double
</autodoc>
627 <param name=
"pt" type=
"Point2D" default=
""/>
630 <method name=
"GetDistanceSquare" type=
"double" overloaded=
"no">
631 <autodoc>GetDistanceSquare(self, Point2D pt) -
> double
</autodoc>
633 <param name=
"pt" type=
"Point2D" default=
""/>
636 <method name=
"GetDotProduct" type=
"double" overloaded=
"no">
637 <autodoc>GetDotProduct(self, Point2D vec) -
> double
</autodoc>
639 <param name=
"vec" type=
"Point2D" default=
""/>
642 <method name=
"GetCrossProduct" type=
"double" overloaded=
"no">
643 <autodoc>GetCrossProduct(self, Point2D vec) -
> double
</autodoc>
645 <param name=
"vec" type=
"Point2D" default=
""/>
648 <method name=
"__neg__" type=
"Point2D" overloaded=
"no">
649 <autodoc>__neg__(self) -
> Point2D
</autodoc>
650 <docstring>the reflection of this point
</docstring>
652 <method name=
"__iadd__" type=
"Point2D" overloaded=
"no">
653 <autodoc>__iadd__(self, Point2D pt) -
> Point2D
</autodoc>
655 <param name=
"pt" type=
"Point2D" default=
""/>
658 <method name=
"__isub__" type=
"Point2D" overloaded=
"no">
659 <autodoc>__isub__(self, Point2D pt) -
> Point2D
</autodoc>
661 <param name=
"pt" type=
"Point2D" default=
""/>
664 <method name=
"__imul__" type=
"Point2D" overloaded=
"no">
665 <autodoc>__imul__(self, Point2D pt) -
> Point2D
</autodoc>
667 <param name=
"pt" type=
"Point2D" default=
""/>
670 <method name=
"__idiv__" type=
"Point2D" overloaded=
"no">
671 <autodoc>__idiv__(self, Point2D pt) -
> Point2D
</autodoc>
673 <param name=
"pt" type=
"Point2D" default=
""/>
676 <method name=
"__eq__" type=
"bool" overloaded=
"no">
677 <autodoc>__eq__(self, Point2D pt) -
> bool
</autodoc>
678 <docstring>Test for equality
</docstring>
680 <param name=
"pt" type=
"Point2D" default=
""/>
683 <method name=
"__ne__" type=
"bool" overloaded=
"no">
684 <autodoc>__ne__(self, Point2D pt) -
> bool
</autodoc>
685 <docstring>Test for inequality
</docstring>
687 <param name=
"pt" type=
"Point2D" default=
""/>
690 <property name=
"x" type=
"double" readonly=
"no"/>
691 <property name=
"y" type=
"double" readonly=
"no"/>
692 <method name=
"Set" type=
"" overloaded=
"no">
693 <autodoc>Set(self, double x=
0, double y=
0)
</autodoc>
695 <param name=
"x" type=
"double" default=
"0"/>
696 <param name=
"y" type=
"double" default=
"0"/>
699 <method name=
"Get" type=
"PyObject" overloaded=
"no">
700 <autodoc>Get() -
> (x,y)
</autodoc>
701 <docstring>Return x and y properties as a tuple.
</docstring>
705 #---------------------------------------------------------------------------
707 <class name=
"InputStream" oldname=
"wxPyInputStream" module=
"_core">
708 <constructor name=
"wxPyInputStream" overloaded=
"no">
709 <autodoc>__init__(self, PyObject p) -
> InputStream
</autodoc>
711 <param name=
"p" type=
"PyObject" default=
""/>
714 <method name=
"close" type=
"" overloaded=
"no">
715 <autodoc>close(self)
</autodoc>
717 <method name=
"flush" type=
"" overloaded=
"no">
718 <autodoc>flush(self)
</autodoc>
720 <method name=
"eof" type=
"bool" overloaded=
"no">
721 <autodoc>eof(self) -
> bool
</autodoc>
723 <method name=
"read" type=
"PyObject" overloaded=
"no">
724 <autodoc>read(self, int size=-
1) -
> PyObject
</autodoc>
726 <param name=
"size" type=
"int" default=
"-1"/>
729 <method name=
"readline" type=
"PyObject" overloaded=
"no">
730 <autodoc>readline(self, int size=-
1) -
> PyObject
</autodoc>
732 <param name=
"size" type=
"int" default=
"-1"/>
735 <method name=
"readlines" type=
"PyObject" overloaded=
"no">
736 <autodoc>readlines(self, int sizehint=-
1) -
> PyObject
</autodoc>
738 <param name=
"sizehint" type=
"int" default=
"-1"/>
741 <method name=
"seek" type=
"" overloaded=
"no">
742 <autodoc>seek(self, int offset, int whence=
0)
</autodoc>
744 <param name=
"offset" type=
"int" default=
""/>
745 <param name=
"whence" type=
"int" default=
"0"/>
748 <method name=
"tell" type=
"int" overloaded=
"no">
749 <autodoc>tell(self) -
> int
</autodoc>
751 <method name=
"Peek" type=
"char" overloaded=
"no">
752 <autodoc>Peek(self) -
> char
</autodoc>
754 <method name=
"GetC" type=
"char" overloaded=
"no">
755 <autodoc>GetC(self) -
> char
</autodoc>
757 <method name=
"LastRead" type=
"size_t" overloaded=
"no">
758 <autodoc>LastRead(self) -
> size_t
</autodoc>
760 <method name=
"CanRead" type=
"bool" overloaded=
"no">
761 <autodoc>CanRead(self) -
> bool
</autodoc>
763 <method name=
"Eof" type=
"bool" overloaded=
"no">
764 <autodoc>Eof(self) -
> bool
</autodoc>
766 <method name=
"Ungetch" type=
"bool" overloaded=
"no">
767 <autodoc>Ungetch(self, char c) -
> bool
</autodoc>
769 <param name=
"c" type=
"char" default=
""/>
772 <method name=
"SeekI" type=
"long" overloaded=
"no">
773 <autodoc>SeekI(self, long pos, int mode=FromStart) -
> long
</autodoc>
775 <param name=
"pos" type=
"long" default=
""/>
776 <param name=
"mode" type=
"wxSeekMode" default=
"wxFromStart"/>
779 <method name=
"TellI" type=
"long" overloaded=
"no">
780 <autodoc>TellI(self) -
> long
</autodoc>
783 <class name=
"OutputStream" oldname=
"wxOutputStream" module=
"_core">
784 <method name=
"write" type=
"" overloaded=
"no">
785 <autodoc>write(self, PyObject obj)
</autodoc>
787 <param name=
"obj" type=
"PyObject" default=
""/>
792 #---------------------------------------------------------------------------
794 <class name=
"FSFile" oldname=
"wxFSFile" module=
"_core">
795 <baseclass name=
"Object"/>
796 <constructor name=
"FSFile" overloaded=
"no">
797 <autodoc>__init__(self, InputStream stream, String loc, String mimetype, String anchor,
798 DateTime modif) -
> FSFile
</autodoc>
800 <param name=
"stream" type=
"wxInputStream" default=
""/>
801 <param name=
"loc" type=
"String" default=
""/>
802 <param name=
"mimetype" type=
"String" default=
""/>
803 <param name=
"anchor" type=
"String" default=
""/>
804 <param name=
"modif" type=
"wxDateTime" default=
""/>
807 <destructor name=
"~wxFSFile" overloaded=
"no">
808 <autodoc>__del__(self)
</autodoc>
810 <method name=
"GetStream" type=
"wxInputStream" overloaded=
"no">
811 <autodoc>GetStream(self) -
> InputStream
</autodoc>
813 <method name=
"GetMimeType" type=
"String" overloaded=
"no">
814 <autodoc>GetMimeType(self) -
> String
</autodoc>
816 <method name=
"GetLocation" type=
"String" overloaded=
"no">
817 <autodoc>GetLocation(self) -
> String
</autodoc>
819 <method name=
"GetAnchor" type=
"String" overloaded=
"no">
820 <autodoc>GetAnchor(self) -
> String
</autodoc>
822 <method name=
"GetModificationTime" type=
"wxDateTime" overloaded=
"no">
823 <autodoc>GetModificationTime(self) -
> DateTime
</autodoc>
826 <class name=
"CPPFileSystemHandler" oldname=
"wxFileSystemHandler" module=
"_core"/>
827 <class name=
"FileSystemHandler" oldname=
"wxPyFileSystemHandler" module=
"_core">
828 <baseclass name=
"CPPFileSystemHandler"/>
829 <constructor name=
"wxPyFileSystemHandler" overloaded=
"no">
830 <autodoc>__init__(self) -
> FileSystemHandler
</autodoc>
832 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
833 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
835 <param name=
"self" type=
"PyObject" default=
""/>
836 <param name=
"_class" type=
"PyObject" default=
""/>
839 <method name=
"CanOpen" type=
"bool" overloaded=
"no">
840 <autodoc>CanOpen(self, String location) -
> bool
</autodoc>
842 <param name=
"location" type=
"String" default=
""/>
845 <method name=
"OpenFile" type=
"FSFile" overloaded=
"no">
846 <autodoc>OpenFile(self, FileSystem fs, String location) -
> FSFile
</autodoc>
848 <param name=
"fs" type=
"wxFileSystem" default=
""/>
849 <param name=
"location" type=
"String" default=
""/>
852 <method name=
"FindFirst" type=
"String" overloaded=
"no">
853 <autodoc>FindFirst(self, String spec, int flags=
0) -
> String
</autodoc>
855 <param name=
"spec" type=
"String" default=
""/>
856 <param name=
"flags" type=
"int" default=
"0"/>
859 <method name=
"FindNext" type=
"String" overloaded=
"no">
860 <autodoc>FindNext(self) -
> String
</autodoc>
862 <method name=
"GetProtocol" type=
"String" overloaded=
"no">
863 <autodoc>GetProtocol(self, String location) -
> String
</autodoc>
865 <param name=
"location" type=
"String" default=
""/>
868 <method name=
"GetLeftLocation" type=
"String" overloaded=
"no">
869 <autodoc>GetLeftLocation(self, String location) -
> String
</autodoc>
871 <param name=
"location" type=
"String" default=
""/>
874 <method name=
"GetAnchor" type=
"String" overloaded=
"no">
875 <autodoc>GetAnchor(self, String location) -
> String
</autodoc>
877 <param name=
"location" type=
"String" default=
""/>
880 <method name=
"GetRightLocation" type=
"String" overloaded=
"no">
881 <autodoc>GetRightLocation(self, String location) -
> String
</autodoc>
883 <param name=
"location" type=
"String" default=
""/>
886 <method name=
"GetMimeTypeFromExt" type=
"String" overloaded=
"no">
887 <autodoc>GetMimeTypeFromExt(self, String location) -
> String
</autodoc>
889 <param name=
"location" type=
"String" default=
""/>
893 <class name=
"FileSystem" oldname=
"wxFileSystem" module=
"_core">
894 <baseclass name=
"Object"/>
895 <constructor name=
"FileSystem" overloaded=
"no">
896 <autodoc>__init__(self) -
> FileSystem
</autodoc>
898 <destructor name=
"~wxFileSystem" overloaded=
"no">
899 <autodoc>__del__(self)
</autodoc>
901 <method name=
"ChangePathTo" type=
"" overloaded=
"no">
902 <autodoc>ChangePathTo(self, String location, bool is_dir=False)
</autodoc>
904 <param name=
"location" type=
"String" default=
""/>
905 <param name=
"is_dir" type=
"bool" default=
"False"/>
908 <method name=
"GetPath" type=
"String" overloaded=
"no">
909 <autodoc>GetPath(self) -
> String
</autodoc>
911 <method name=
"OpenFile" type=
"FSFile" overloaded=
"no">
912 <autodoc>OpenFile(self, String location) -
> FSFile
</autodoc>
914 <param name=
"location" type=
"String" default=
""/>
917 <method name=
"FindFirst" type=
"String" overloaded=
"no">
918 <autodoc>FindFirst(self, String spec, int flags=
0) -
> String
</autodoc>
920 <param name=
"spec" type=
"String" default=
""/>
921 <param name=
"flags" type=
"int" default=
"0"/>
924 <method name=
"FindNext" type=
"String" overloaded=
"no">
925 <autodoc>FindNext(self) -
> String
</autodoc>
927 <staticmethod name=
"AddHandler" type=
"" overloaded=
"no">
928 <autodoc>AddHandler(CPPFileSystemHandler handler)
</autodoc>
930 <param name=
"handler" type=
"CPPFileSystemHandler" default=
""/>
933 <staticmethod name=
"CleanUpHandlers" type=
"" overloaded=
"no">
934 <autodoc>CleanUpHandlers()
</autodoc>
936 <staticmethod name=
"FileNameToURL" type=
"String" overloaded=
"no">
937 <autodoc>FileNameToURL(String filename) -
> String
</autodoc>
939 <param name=
"filename" type=
"String" default=
""/>
943 <method name=
"FileSystem_URLToFileName" oldname=
"wxFileSystem_URLToFileName" type=
"String" overloaded=
"no">
944 <autodoc>FileSystem_URLToFileName(String url) -
> String
</autodoc>
946 <param name=
"url" type=
"String" default=
""/>
949 <class name=
"InternetFSHandler" oldname=
"wxInternetFSHandler" module=
"_core">
950 <baseclass name=
"CPPFileSystemHandler"/>
951 <constructor name=
"InternetFSHandler" overloaded=
"no">
952 <autodoc>__init__(self) -
> InternetFSHandler
</autodoc>
954 <method name=
"CanOpen" type=
"bool" overloaded=
"no">
955 <autodoc>CanOpen(self, String location) -
> bool
</autodoc>
957 <param name=
"location" type=
"String" default=
""/>
960 <method name=
"OpenFile" type=
"FSFile" overloaded=
"no">
961 <autodoc>OpenFile(self, FileSystem fs, String location) -
> FSFile
</autodoc>
963 <param name=
"fs" type=
"FileSystem" default=
""/>
964 <param name=
"location" type=
"String" default=
""/>
968 <class name=
"ZipFSHandler" oldname=
"wxZipFSHandler" module=
"_core">
969 <baseclass name=
"CPPFileSystemHandler"/>
970 <constructor name=
"ZipFSHandler" overloaded=
"no">
971 <autodoc>__init__(self) -
> ZipFSHandler
</autodoc>
973 <method name=
"CanOpen" type=
"bool" overloaded=
"no">
974 <autodoc>CanOpen(self, String location) -
> bool
</autodoc>
976 <param name=
"location" type=
"String" default=
""/>
979 <method name=
"OpenFile" type=
"FSFile" overloaded=
"no">
980 <autodoc>OpenFile(self, FileSystem fs, String location) -
> FSFile
</autodoc>
982 <param name=
"fs" type=
"FileSystem" default=
""/>
983 <param name=
"location" type=
"String" default=
""/>
986 <method name=
"FindFirst" type=
"String" overloaded=
"no">
987 <autodoc>FindFirst(self, String spec, int flags=
0) -
> String
</autodoc>
989 <param name=
"spec" type=
"String" default=
""/>
990 <param name=
"flags" type=
"int" default=
"0"/>
993 <method name=
"FindNext" type=
"String" overloaded=
"no">
994 <autodoc>FindNext(self) -
> String
</autodoc>
997 <method name=
"__wxMemoryFSHandler_AddFile_wxImage" oldname=
"__wxMemoryFSHandler_AddFile_wxImage" type=
"" overloaded=
"no">
998 <autodoc>__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)
</autodoc>
1000 <param name=
"filename" type=
"String" default=
""/>
1001 <param name=
"image" type=
"wxImage" default=
""/>
1002 <param name=
"type" type=
"long" default=
""/>
1005 <method name=
"__wxMemoryFSHandler_AddFile_wxBitmap" oldname=
"__wxMemoryFSHandler_AddFile_wxBitmap" type=
"" overloaded=
"no">
1006 <autodoc>__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)
</autodoc>
1008 <param name=
"filename" type=
"String" default=
""/>
1009 <param name=
"bitmap" type=
"wxBitmap" default=
""/>
1010 <param name=
"type" type=
"long" default=
""/>
1013 <method name=
"__wxMemoryFSHandler_AddFile_Data" oldname=
"__wxMemoryFSHandler_AddFile_Data" type=
"" overloaded=
"no">
1014 <autodoc>__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)
</autodoc>
1016 <param name=
"filename" type=
"String" default=
""/>
1017 <param name=
"data" type=
"PyObject" default=
""/>
1021 def MemoryFSHandler_AddFile(filename, a, b=''):
1022 if isinstance(a, wx.Image):
1023 __wxMemoryFSHandler_AddFile_wxImage(filename, a, b)
1024 elif isinstance(a, wx.Bitmap):
1025 __wxMemoryFSHandler_AddFile_wxBitmap(filename, a, b)
1026 elif type(a) == str:
1027 __wxMemoryFSHandler_AddFile_Data(filename, a)
1028 else: raise TypeError, 'wx.Image, wx.Bitmap or string expected'
1030 <class name=
"MemoryFSHandler" oldname=
"wxMemoryFSHandler" module=
"_core">
1031 <baseclass name=
"CPPFileSystemHandler"/>
1032 <constructor name=
"MemoryFSHandler" overloaded=
"no">
1033 <autodoc>__init__(self) -
> MemoryFSHandler
</autodoc>
1035 <staticmethod name=
"RemoveFile" type=
"" overloaded=
"no">
1036 <autodoc>RemoveFile(String filename)
</autodoc>
1038 <param name=
"filename" type=
"String" default=
""/>
1041 <method name=
"CanOpen" type=
"bool" overloaded=
"no">
1042 <autodoc>CanOpen(self, String location) -
> bool
</autodoc>
1044 <param name=
"location" type=
"String" default=
""/>
1047 <method name=
"OpenFile" type=
"FSFile" overloaded=
"no">
1048 <autodoc>OpenFile(self, FileSystem fs, String location) -
> FSFile
</autodoc>
1050 <param name=
"fs" type=
"FileSystem" default=
""/>
1051 <param name=
"location" type=
"String" default=
""/>
1054 <method name=
"FindFirst" type=
"String" overloaded=
"no">
1055 <autodoc>FindFirst(self, String spec, int flags=
0) -
> String
</autodoc>
1057 <param name=
"spec" type=
"String" default=
""/>
1058 <param name=
"flags" type=
"int" default=
"0"/>
1061 <method name=
"FindNext" type=
"String" overloaded=
"no">
1062 <autodoc>FindNext(self) -
> String
</autodoc>
1066 #---------------------------------------------------------------------------
1068 <class name=
"ImageHandler" oldname=
"wxImageHandler" module=
"_core">
1069 <baseclass name=
"Object"/>
1070 <method name=
"GetName" type=
"String" overloaded=
"no">
1071 <autodoc>GetName(self) -
> String
</autodoc>
1073 <method name=
"GetExtension" type=
"String" overloaded=
"no">
1074 <autodoc>GetExtension(self) -
> String
</autodoc>
1076 <method name=
"GetType" type=
"long" overloaded=
"no">
1077 <autodoc>GetType(self) -
> long
</autodoc>
1079 <method name=
"GetMimeType" type=
"String" overloaded=
"no">
1080 <autodoc>GetMimeType(self) -
> String
</autodoc>
1082 <method name=
"CanRead" type=
"bool" overloaded=
"no">
1083 <autodoc>CanRead(self, String name) -
> bool
</autodoc>
1085 <param name=
"name" type=
"String" default=
""/>
1088 <method name=
"SetName" type=
"" overloaded=
"no">
1089 <autodoc>SetName(self, String name)
</autodoc>
1091 <param name=
"name" type=
"String" default=
""/>
1094 <method name=
"SetExtension" type=
"" overloaded=
"no">
1095 <autodoc>SetExtension(self, String extension)
</autodoc>
1097 <param name=
"extension" type=
"String" default=
""/>
1100 <method name=
"SetType" type=
"" overloaded=
"no">
1101 <autodoc>SetType(self, long type)
</autodoc>
1103 <param name=
"type" type=
"long" default=
""/>
1106 <method name=
"SetMimeType" type=
"" overloaded=
"no">
1107 <autodoc>SetMimeType(self, String mimetype)
</autodoc>
1109 <param name=
"mimetype" type=
"String" default=
""/>
1113 <class name=
"ImageHistogram" oldname=
"wxImageHistogram" module=
"_core">
1114 <constructor name=
"ImageHistogram" overloaded=
"no">
1115 <autodoc>__init__(self) -
> ImageHistogram
</autodoc>
1117 <staticmethod name=
"MakeKey" type=
"unsigned long" overloaded=
"no">
1118 <autodoc>MakeKey(unsigned char r, unsigned char g, unsigned char b) -
> unsigned long
</autodoc>
1119 <docstring>Get the key in the histogram for the given RGB values
</docstring>
1121 <param name=
"r" type=
"unsigned char" default=
""/>
1122 <param name=
"g" type=
"unsigned char" default=
""/>
1123 <param name=
"b" type=
"unsigned char" default=
""/>
1126 <method name=
"FindFirstUnusedColour" type=
"bool" overloaded=
"no">
1127 <autodoc>FindFirstUnusedColour(int startR=
1, int startG=
0, int startB=
0) -
> (success, r, g, b)
</autodoc>
1128 <docstring>Find first colour that is not used in the image and has higher RGB
1129 values than startR, startG, startB. Returns a tuple consisting of a
1130 success flag and rgb values.
</docstring>
1132 <param name=
"OUTPUT" type=
"unsigned char" default=
""/>
1133 <param name=
"OUTPUT" type=
"unsigned char" default=
""/>
1134 <param name=
"OUTPUT" type=
"unsigned char" default=
""/>
1135 <param name=
"startR" type=
"unsigned char" default=
"1"/>
1136 <param name=
"startG" type=
"unsigned char" default=
"0"/>
1137 <param name=
"startB" type=
"unsigned char" default=
"0"/>
1141 <class name=
"Image" oldname=
"wxImage" module=
"_core">
1142 <baseclass name=
"Object"/>
1143 <constructor name=
"Image" overloaded=
"no">
1144 <autodoc>__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-
1) -
> Image
</autodoc>
1146 <param name=
"name" type=
"String" default=
""/>
1147 <param name=
"type" type=
"long" default=
"wxBITMAP_TYPE_ANY"/>
1148 <param name=
"index" type=
"int" default=
"-1"/>
1151 <constructor name=
"ImageFromMime" overloaded=
"no">
1152 <autodoc>ImageFromMime(String name, String mimetype, int index=-
1) -
> Image
</autodoc>
1154 <param name=
"name" type=
"String" default=
""/>
1155 <param name=
"mimetype" type=
"String" default=
""/>
1156 <param name=
"index" type=
"int" default=
"-1"/>
1159 <constructor name=
"ImageFromStream" overloaded=
"no">
1160 <autodoc>ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-
1) -
> Image
</autodoc>
1162 <param name=
"stream" type=
"wxInputStream" default=
""/>
1163 <param name=
"type" type=
"long" default=
"wxBITMAP_TYPE_ANY"/>
1164 <param name=
"index" type=
"int" default=
"-1"/>
1167 <constructor name=
"ImageFromStreamMime" overloaded=
"no">
1168 <autodoc>ImageFromStreamMime(InputStream stream, String mimetype, int index=-
1) -
> Image
</autodoc>
1170 <param name=
"stream" type=
"wxInputStream" default=
""/>
1171 <param name=
"mimetype" type=
"String" default=
""/>
1172 <param name=
"index" type=
"int" default=
"-1"/>
1175 <constructor name=
"EmptyImage" overloaded=
"no">
1176 <autodoc>EmptyImage(int width=
0, int height=
0, bool clear=True) -
> Image
</autodoc>
1178 <param name=
"width" type=
"int" default=
"0"/>
1179 <param name=
"height" type=
"int" default=
"0"/>
1180 <param name=
"clear" type=
"bool" default=
"True"/>
1183 <constructor name=
"ImageFromBitmap" overloaded=
"no">
1184 <autodoc>ImageFromBitmap(Bitmap bitmap) -
> Image
</autodoc>
1186 <param name=
"bitmap" type=
"wxBitmap" default=
""/>
1189 <constructor name=
"ImageFromData" overloaded=
"no">
1190 <autodoc>ImageFromData(int width, int height, unsigned char data) -
> Image
</autodoc>
1192 <param name=
"width" type=
"int" default=
""/>
1193 <param name=
"height" type=
"int" default=
""/>
1194 <param name=
"data" type=
"unsigned char" default=
""/>
1197 <destructor name=
"~wxImage" overloaded=
"no">
1198 <autodoc>__del__(self)
</autodoc>
1200 <method name=
"Create" type=
"" overloaded=
"no">
1201 <autodoc>Create(self, int width, int height)
</autodoc>
1203 <param name=
"width" type=
"int" default=
""/>
1204 <param name=
"height" type=
"int" default=
""/>
1207 <method name=
"Destroy" type=
"" overloaded=
"no">
1208 <autodoc>Destroy(self)
</autodoc>
1209 <docstring>Deletes the C++ object this Python object is a proxy for.
</docstring>
1211 <method name=
"Scale" type=
"Image" overloaded=
"no">
1212 <autodoc>Scale(self, int width, int height) -
> Image
</autodoc>
1214 <param name=
"width" type=
"int" default=
""/>
1215 <param name=
"height" type=
"int" default=
""/>
1218 <method name=
"ShrinkBy" type=
"Image" overloaded=
"no">
1219 <autodoc>ShrinkBy(self, int xFactor, int yFactor) -
> Image
</autodoc>
1221 <param name=
"xFactor" type=
"int" default=
""/>
1222 <param name=
"yFactor" type=
"int" default=
""/>
1225 <method name=
"Rescale" type=
"Image" overloaded=
"no">
1226 <autodoc>Rescale(self, int width, int height) -
> Image
</autodoc>
1228 <param name=
"width" type=
"int" default=
""/>
1229 <param name=
"height" type=
"int" default=
""/>
1232 <method name=
"SetRGB" type=
"" overloaded=
"no">
1233 <autodoc>SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)
</autodoc>
1235 <param name=
"x" type=
"int" default=
""/>
1236 <param name=
"y" type=
"int" default=
""/>
1237 <param name=
"r" type=
"unsigned char" default=
""/>
1238 <param name=
"g" type=
"unsigned char" default=
""/>
1239 <param name=
"b" type=
"unsigned char" default=
""/>
1242 <method name=
"GetRed" type=
"unsigned char" overloaded=
"no">
1243 <autodoc>GetRed(self, int x, int y) -
> unsigned char
</autodoc>
1245 <param name=
"x" type=
"int" default=
""/>
1246 <param name=
"y" type=
"int" default=
""/>
1249 <method name=
"GetGreen" type=
"unsigned char" overloaded=
"no">
1250 <autodoc>GetGreen(self, int x, int y) -
> unsigned char
</autodoc>
1252 <param name=
"x" type=
"int" default=
""/>
1253 <param name=
"y" type=
"int" default=
""/>
1256 <method name=
"GetBlue" type=
"unsigned char" overloaded=
"no">
1257 <autodoc>GetBlue(self, int x, int y) -
> unsigned char
</autodoc>
1259 <param name=
"x" type=
"int" default=
""/>
1260 <param name=
"y" type=
"int" default=
""/>
1263 <method name=
"SetAlpha" type=
"" overloaded=
"no">
1264 <autodoc>SetAlpha(self, int x, int y, unsigned char alpha)
</autodoc>
1266 <param name=
"x" type=
"int" default=
""/>
1267 <param name=
"y" type=
"int" default=
""/>
1268 <param name=
"alpha" type=
"unsigned char" default=
""/>
1271 <method name=
"GetAlpha" type=
"unsigned char" overloaded=
"no">
1272 <autodoc>GetAlpha(self, int x, int y) -
> unsigned char
</autodoc>
1274 <param name=
"x" type=
"int" default=
""/>
1275 <param name=
"y" type=
"int" default=
""/>
1278 <method name=
"HasAlpha" type=
"bool" overloaded=
"no">
1279 <autodoc>HasAlpha(self) -
> bool
</autodoc>
1281 <method name=
"FindFirstUnusedColour" type=
"bool" overloaded=
"no">
1282 <autodoc>FindFirstUnusedColour(int startR=
1, int startG=
0, int startB=
0) -
> (success, r, g, b)
</autodoc>
1283 <docstring>Find first colour that is not used in the image and has higher RGB
1284 values than startR, startG, startB. Returns a tuple consisting of a
1285 success flag and rgb values.
</docstring>
1287 <param name=
"OUTPUT" type=
"byte" default=
""/>
1288 <param name=
"OUTPUT" type=
"byte" default=
""/>
1289 <param name=
"OUTPUT" type=
"byte" default=
""/>
1290 <param name=
"startR" type=
"byte" default=
"0"/>
1291 <param name=
"startG" type=
"byte" default=
"0"/>
1292 <param name=
"startB" type=
"byte" default=
"0"/>
1295 <method name=
"SetMaskFromImage" type=
"bool" overloaded=
"no">
1296 <autodoc>SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -
> bool
</autodoc>
1298 <param name=
"mask" type=
"Image" default=
""/>
1299 <param name=
"mr" type=
"byte" default=
""/>
1300 <param name=
"mg" type=
"byte" default=
""/>
1301 <param name=
"mb" type=
"byte" default=
""/>
1304 <staticmethod name=
"CanRead" type=
"bool" overloaded=
"no">
1305 <autodoc>CanRead(String name) -
> bool
</autodoc>
1307 <param name=
"name" type=
"String" default=
""/>
1310 <staticmethod name=
"GetImageCount" type=
"int" overloaded=
"no">
1311 <autodoc>GetImageCount(String name, long type=BITMAP_TYPE_ANY) -
> int
</autodoc>
1313 <param name=
"name" type=
"String" default=
""/>
1314 <param name=
"type" type=
"long" default=
"wxBITMAP_TYPE_ANY"/>
1317 <method name=
"LoadFile" type=
"bool" overloaded=
"no">
1318 <autodoc>LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-
1) -
> bool
</autodoc>
1320 <param name=
"name" type=
"String" default=
""/>
1321 <param name=
"type" type=
"long" default=
"wxBITMAP_TYPE_ANY"/>
1322 <param name=
"index" type=
"int" default=
"-1"/>
1325 <method name=
"LoadMimeFile" type=
"bool" overloaded=
"no">
1326 <autodoc>LoadMimeFile(self, String name, String mimetype, int index=-
1) -
> bool
</autodoc>
1328 <param name=
"name" type=
"String" default=
""/>
1329 <param name=
"mimetype" type=
"String" default=
""/>
1330 <param name=
"index" type=
"int" default=
"-1"/>
1333 <method name=
"SaveFile" type=
"bool" overloaded=
"no">
1334 <autodoc>SaveFile(self, String name, int type) -
> bool
</autodoc>
1336 <param name=
"name" type=
"String" default=
""/>
1337 <param name=
"type" type=
"int" default=
""/>
1340 <method name=
"SaveMimeFile" type=
"bool" overloaded=
"no">
1341 <autodoc>SaveMimeFile(self, String name, String mimetype) -
> bool
</autodoc>
1343 <param name=
"name" type=
"String" default=
""/>
1344 <param name=
"mimetype" type=
"String" default=
""/>
1347 <staticmethod name=
"CanReadStream" type=
"bool" overloaded=
"no">
1348 <autodoc>CanReadStream(InputStream stream) -
> bool
</autodoc>
1350 <param name=
"stream" type=
"wxInputStream" default=
""/>
1353 <method name=
"LoadStream" type=
"bool" overloaded=
"no">
1354 <autodoc>LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-
1) -
> bool
</autodoc>
1356 <param name=
"stream" type=
"wxInputStream" default=
""/>
1357 <param name=
"type" type=
"long" default=
"wxBITMAP_TYPE_ANY"/>
1358 <param name=
"index" type=
"int" default=
"-1"/>
1361 <method name=
"LoadMimeStream" type=
"bool" overloaded=
"no">
1362 <autodoc>LoadMimeStream(self, InputStream stream, String mimetype, int index=-
1) -
> bool
</autodoc>
1364 <param name=
"stream" type=
"wxInputStream" default=
""/>
1365 <param name=
"mimetype" type=
"String" default=
""/>
1366 <param name=
"index" type=
"int" default=
"-1"/>
1369 <method name=
"Ok" type=
"bool" overloaded=
"no">
1370 <autodoc>Ok(self) -
> bool
</autodoc>
1372 <method name=
"GetWidth" type=
"int" overloaded=
"no">
1373 <autodoc>GetWidth(self) -
> int
</autodoc>
1375 <method name=
"GetHeight" type=
"int" overloaded=
"no">
1376 <autodoc>GetHeight(self) -
> int
</autodoc>
1378 <method name=
"GetSize" type=
"Size" overloaded=
"no">
1379 <autodoc>GetSize(self) -
> Size
</autodoc>
1381 <method name=
"GetSubImage" type=
"Image" overloaded=
"no">
1382 <autodoc>GetSubImage(self, Rect rect) -
> Image
</autodoc>
1384 <param name=
"rect" type=
"Rect" default=
""/>
1387 <method name=
"Copy" type=
"Image" overloaded=
"no">
1388 <autodoc>Copy(self) -
> Image
</autodoc>
1390 <method name=
"Paste" type=
"" overloaded=
"no">
1391 <autodoc>Paste(self, Image image, int x, int y)
</autodoc>
1393 <param name=
"image" type=
"Image" default=
""/>
1394 <param name=
"x" type=
"int" default=
""/>
1395 <param name=
"y" type=
"int" default=
""/>
1398 <method name=
"GetData" type=
"PyObject" overloaded=
"no">
1399 <autodoc>GetData(self) -
> PyObject
</autodoc>
1401 <method name=
"SetData" type=
"" overloaded=
"no">
1402 <autodoc>SetData(self, PyObject data)
</autodoc>
1404 <param name=
"data" type=
"PyObject" default=
""/>
1407 <method name=
"GetDataBuffer" type=
"PyObject" overloaded=
"no">
1408 <autodoc>GetDataBuffer(self) -
> PyObject
</autodoc>
1410 <method name=
"SetDataBuffer" type=
"" overloaded=
"no">
1411 <autodoc>SetDataBuffer(self, PyObject data)
</autodoc>
1413 <param name=
"data" type=
"PyObject" default=
""/>
1416 <method name=
"GetAlphaData" type=
"PyObject" overloaded=
"no">
1417 <autodoc>GetAlphaData(self) -
> PyObject
</autodoc>
1419 <method name=
"SetAlphaData" type=
"" overloaded=
"no">
1420 <autodoc>SetAlphaData(self, PyObject data)
</autodoc>
1422 <param name=
"data" type=
"PyObject" default=
""/>
1425 <method name=
"GetAlphaBuffer" type=
"PyObject" overloaded=
"no">
1426 <autodoc>GetAlphaBuffer(self) -
> PyObject
</autodoc>
1428 <method name=
"SetAlphaBuffer" type=
"" overloaded=
"no">
1429 <autodoc>SetAlphaBuffer(self, PyObject data)
</autodoc>
1431 <param name=
"data" type=
"PyObject" default=
""/>
1434 <method name=
"SetMaskColour" type=
"" overloaded=
"no">
1435 <autodoc>SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)
</autodoc>
1437 <param name=
"r" type=
"unsigned char" default=
""/>
1438 <param name=
"g" type=
"unsigned char" default=
""/>
1439 <param name=
"b" type=
"unsigned char" default=
""/>
1442 <method name=
"GetMaskRed" type=
"unsigned char" overloaded=
"no">
1443 <autodoc>GetMaskRed(self) -
> unsigned char
</autodoc>
1445 <method name=
"GetMaskGreen" type=
"unsigned char" overloaded=
"no">
1446 <autodoc>GetMaskGreen(self) -
> unsigned char
</autodoc>
1448 <method name=
"GetMaskBlue" type=
"unsigned char" overloaded=
"no">
1449 <autodoc>GetMaskBlue(self) -
> unsigned char
</autodoc>
1451 <method name=
"SetMask" type=
"" overloaded=
"no">
1452 <autodoc>SetMask(self, bool mask=True)
</autodoc>
1454 <param name=
"mask" type=
"bool" default=
"True"/>
1457 <method name=
"HasMask" type=
"bool" overloaded=
"no">
1458 <autodoc>HasMask(self) -
> bool
</autodoc>
1460 <method name=
"Rotate" type=
"Image" overloaded=
"no">
1461 <autodoc>Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
1462 Point offset_after_rotation=None) -
> Image
</autodoc>
1464 <param name=
"angle" type=
"double" default=
""/>
1465 <param name=
"centre_of_rotation" type=
"Point" default=
""/>
1466 <param name=
"interpolating" type=
"bool" default=
"True"/>
1467 <param name=
"offset_after_rotation" type=
"Point" default=
"NULL"/>
1470 <method name=
"Rotate90" type=
"Image" overloaded=
"no">
1471 <autodoc>Rotate90(self, bool clockwise=True) -
> Image
</autodoc>
1473 <param name=
"clockwise" type=
"bool" default=
"True"/>
1476 <method name=
"Mirror" type=
"Image" overloaded=
"no">
1477 <autodoc>Mirror(self, bool horizontally=True) -
> Image
</autodoc>
1479 <param name=
"horizontally" type=
"bool" default=
"True"/>
1482 <method name=
"Replace" type=
"" overloaded=
"no">
1483 <autodoc>Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
1484 unsigned char r2, unsigned char g2, unsigned char b2)
</autodoc>
1486 <param name=
"r1" type=
"unsigned char" default=
""/>
1487 <param name=
"g1" type=
"unsigned char" default=
""/>
1488 <param name=
"b1" type=
"unsigned char" default=
""/>
1489 <param name=
"r2" type=
"unsigned char" default=
""/>
1490 <param name=
"g2" type=
"unsigned char" default=
""/>
1491 <param name=
"b2" type=
"unsigned char" default=
""/>
1494 <method name=
"ConvertToMono" type=
"Image" overloaded=
"no">
1495 <autodoc>ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -
> Image
</autodoc>
1497 <param name=
"r" type=
"unsigned char" default=
""/>
1498 <param name=
"g" type=
"unsigned char" default=
""/>
1499 <param name=
"b" type=
"unsigned char" default=
""/>
1502 <method name=
"SetOption" type=
"" overloaded=
"no">
1503 <autodoc>SetOption(self, String name, String value)
</autodoc>
1505 <param name=
"name" type=
"String" default=
""/>
1506 <param name=
"value" type=
"String" default=
""/>
1509 <method name=
"SetOptionInt" type=
"" overloaded=
"no">
1510 <autodoc>SetOptionInt(self, String name, int value)
</autodoc>
1512 <param name=
"name" type=
"String" default=
""/>
1513 <param name=
"value" type=
"int" default=
""/>
1516 <method name=
"GetOption" type=
"String" overloaded=
"no">
1517 <autodoc>GetOption(self, String name) -
> String
</autodoc>
1519 <param name=
"name" type=
"String" default=
""/>
1522 <method name=
"GetOptionInt" type=
"int" overloaded=
"no">
1523 <autodoc>GetOptionInt(self, String name) -
> int
</autodoc>
1525 <param name=
"name" type=
"String" default=
""/>
1528 <method name=
"HasOption" type=
"bool" overloaded=
"no">
1529 <autodoc>HasOption(self, String name) -
> bool
</autodoc>
1531 <param name=
"name" type=
"String" default=
""/>
1534 <method name=
"CountColours" type=
"unsigned long" overloaded=
"no">
1535 <autodoc>CountColours(self, unsigned long stopafter=(unsigned long) -
1) -
> unsigned long
</autodoc>
1537 <param name=
"stopafter" type=
"unsigned long" default=
"(unsigned long) -1"/>
1540 <method name=
"ComputeHistogram" type=
"unsigned long" overloaded=
"no">
1541 <autodoc>ComputeHistogram(self, ImageHistogram h) -
> unsigned long
</autodoc>
1543 <param name=
"h" type=
"ImageHistogram" default=
""/>
1546 <staticmethod name=
"AddHandler" type=
"" overloaded=
"no">
1547 <autodoc>AddHandler(ImageHandler handler)
</autodoc>
1549 <param name=
"handler" type=
"ImageHandler" default=
""/>
1552 <staticmethod name=
"InsertHandler" type=
"" overloaded=
"no">
1553 <autodoc>InsertHandler(ImageHandler handler)
</autodoc>
1555 <param name=
"handler" type=
"ImageHandler" default=
""/>
1558 <staticmethod name=
"RemoveHandler" type=
"bool" overloaded=
"no">
1559 <autodoc>RemoveHandler(String name) -
> bool
</autodoc>
1561 <param name=
"name" type=
"String" default=
""/>
1564 <staticmethod name=
"GetImageExtWildcard" type=
"String" overloaded=
"no">
1565 <autodoc>GetImageExtWildcard() -
> String
</autodoc>
1567 <method name=
"ConvertToBitmap" type=
"wxBitmap" overloaded=
"no">
1568 <autodoc>ConvertToBitmap(self) -
> Bitmap
</autodoc>
1570 <method name=
"ConvertToMonoBitmap" type=
"wxBitmap" overloaded=
"no">
1571 <autodoc>ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -
> Bitmap
</autodoc>
1573 <param name=
"red" type=
"unsigned char" default=
""/>
1574 <param name=
"green" type=
"unsigned char" default=
""/>
1575 <param name=
"blue" type=
"unsigned char" default=
""/>
1580 def InitAllImageHandlers():
1582 The former functionality of InitAllImageHanders is now done internal to
1583 the _core_ extension module and so this function has become a simple NOP.
1587 <class name=
"BMPHandler" oldname=
"wxBMPHandler" module=
"_core">
1588 <baseclass name=
"ImageHandler"/>
1589 <constructor name=
"BMPHandler" overloaded=
"no">
1590 <autodoc>__init__(self) -
> BMPHandler
</autodoc>
1593 <class name=
"ICOHandler" oldname=
"wxICOHandler" module=
"_core">
1594 <baseclass name=
"BMPHandler"/>
1595 <constructor name=
"ICOHandler" overloaded=
"no">
1596 <autodoc>__init__(self) -
> ICOHandler
</autodoc>
1599 <class name=
"CURHandler" oldname=
"wxCURHandler" module=
"_core">
1600 <baseclass name=
"ICOHandler"/>
1601 <constructor name=
"CURHandler" overloaded=
"no">
1602 <autodoc>__init__(self) -
> CURHandler
</autodoc>
1605 <class name=
"ANIHandler" oldname=
"wxANIHandler" module=
"_core">
1606 <baseclass name=
"CURHandler"/>
1607 <constructor name=
"ANIHandler" overloaded=
"no">
1608 <autodoc>__init__(self) -
> ANIHandler
</autodoc>
1611 <class name=
"PNGHandler" oldname=
"wxPNGHandler" module=
"_core">
1612 <baseclass name=
"ImageHandler"/>
1613 <constructor name=
"PNGHandler" overloaded=
"no">
1614 <autodoc>__init__(self) -
> PNGHandler
</autodoc>
1617 <class name=
"GIFHandler" oldname=
"wxGIFHandler" module=
"_core">
1618 <baseclass name=
"ImageHandler"/>
1619 <constructor name=
"GIFHandler" overloaded=
"no">
1620 <autodoc>__init__(self) -
> GIFHandler
</autodoc>
1623 <class name=
"PCXHandler" oldname=
"wxPCXHandler" module=
"_core">
1624 <baseclass name=
"ImageHandler"/>
1625 <constructor name=
"PCXHandler" overloaded=
"no">
1626 <autodoc>__init__(self) -
> PCXHandler
</autodoc>
1629 <class name=
"JPEGHandler" oldname=
"wxJPEGHandler" module=
"_core">
1630 <baseclass name=
"ImageHandler"/>
1631 <constructor name=
"JPEGHandler" overloaded=
"no">
1632 <autodoc>__init__(self) -
> JPEGHandler
</autodoc>
1635 <class name=
"PNMHandler" oldname=
"wxPNMHandler" module=
"_core">
1636 <baseclass name=
"ImageHandler"/>
1637 <constructor name=
"PNMHandler" overloaded=
"no">
1638 <autodoc>__init__(self) -
> PNMHandler
</autodoc>
1641 <class name=
"XPMHandler" oldname=
"wxXPMHandler" module=
"_core">
1642 <baseclass name=
"ImageHandler"/>
1643 <constructor name=
"XPMHandler" overloaded=
"no">
1644 <autodoc>__init__(self) -
> XPMHandler
</autodoc>
1647 <class name=
"TIFFHandler" oldname=
"wxTIFFHandler" module=
"_core">
1648 <baseclass name=
"ImageHandler"/>
1649 <constructor name=
"TIFFHandler" overloaded=
"no">
1650 <autodoc>__init__(self) -
> TIFFHandler
</autodoc>
1653 <class name=
"Quantize" oldname=
"wxQuantize" module=
"_core">
1654 <docstring>Performs quantization, or colour reduction, on a wxImage.
</docstring>
1655 <staticmethod name=
"Quantize" type=
"bool" overloaded=
"no">
1656 <autodoc>Quantize(Image src, Image dest, int desiredNoColours=
236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -
> bool
</autodoc>
1657 <docstring>Reduce the colours in the source image and put the result into the
1658 destination image, setting the palette in the destination if
1659 needed. Both images may be the same, to overwrite the source image.
1660 :todo: Create a version that returns the wx.Palette used.
</docstring>
1662 <param name=
"src" type=
"Image" default=
""/>
1663 <param name=
"dest" type=
"Image" default=
""/>
1664 <param name=
"desiredNoColours" type=
"int" default=
"236"/>
1665 <param name=
"flags" type=
"int" default=
"wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE"/>
1670 #---------------------------------------------------------------------------
1672 <class name=
"EvtHandler" oldname=
"wxEvtHandler" module=
"_core">
1673 <baseclass name=
"Object"/>
1674 <constructor name=
"EvtHandler" overloaded=
"no">
1675 <autodoc>__init__(self) -
> EvtHandler
</autodoc>
1677 <method name=
"GetNextHandler" type=
"EvtHandler" overloaded=
"no">
1678 <autodoc>GetNextHandler(self) -
> EvtHandler
</autodoc>
1680 <method name=
"GetPreviousHandler" type=
"EvtHandler" overloaded=
"no">
1681 <autodoc>GetPreviousHandler(self) -
> EvtHandler
</autodoc>
1683 <method name=
"SetNextHandler" type=
"" overloaded=
"no">
1684 <autodoc>SetNextHandler(self, EvtHandler handler)
</autodoc>
1686 <param name=
"handler" type=
"EvtHandler" default=
""/>
1689 <method name=
"SetPreviousHandler" type=
"" overloaded=
"no">
1690 <autodoc>SetPreviousHandler(self, EvtHandler handler)
</autodoc>
1692 <param name=
"handler" type=
"EvtHandler" default=
""/>
1695 <method name=
"GetEvtHandlerEnabled" type=
"bool" overloaded=
"no">
1696 <autodoc>GetEvtHandlerEnabled(self) -
> bool
</autodoc>
1698 <method name=
"SetEvtHandlerEnabled" type=
"" overloaded=
"no">
1699 <autodoc>SetEvtHandlerEnabled(self, bool enabled)
</autodoc>
1701 <param name=
"enabled" type=
"bool" default=
""/>
1704 <method name=
"ProcessEvent" type=
"bool" overloaded=
"no">
1705 <autodoc>ProcessEvent(self, Event event) -
> bool
</autodoc>
1707 <param name=
"event" type=
"wxEvent" default=
""/>
1710 <method name=
"AddPendingEvent" type=
"" overloaded=
"no">
1711 <autodoc>AddPendingEvent(self, Event event)
</autodoc>
1713 <param name=
"event" type=
"wxEvent" default=
""/>
1716 <method name=
"ProcessPendingEvents" type=
"" overloaded=
"no">
1717 <autodoc>ProcessPendingEvents(self)
</autodoc>
1719 <method name=
"Connect" type=
"" overloaded=
"no">
1720 <autodoc>Connect(self, int id, int lastId, int eventType, PyObject func)
</autodoc>
1722 <param name=
"id" type=
"int" default=
""/>
1723 <param name=
"lastId" type=
"int" default=
""/>
1724 <param name=
"eventType" type=
"int" default=
""/>
1725 <param name=
"func" type=
"PyObject" default=
""/>
1728 <method name=
"Disconnect" type=
"bool" overloaded=
"no">
1729 <autodoc>Disconnect(self, int id, int lastId=-
1, wxEventType eventType=wxEVT_NULL) -
> bool
</autodoc>
1731 <param name=
"id" type=
"int" default=
""/>
1732 <param name=
"lastId" type=
"int" default=
"-1"/>
1733 <param name=
"eventType" type=
"wxEventType" default=
"wxEVT_NULL"/>
1736 <method name=
"_setOORInfo" type=
"" overloaded=
"no">
1737 <autodoc>_setOORInfo(self, PyObject _self)
</autodoc>
1739 <param name=
"_self" type=
"PyObject" default=
""/>
1745 #---------------------------------------------------------------------------
1747 class PyEventBinder(object):
1749 Instances of this class are used to bind specific events to event
1752 def __init__(self, evtType, expectedIDs=
0):
1753 if expectedIDs not in [
0,
1,
2]:
1754 raise ValueError, "Invalid number of expectedIDs"
1755 self.expectedIDs = expectedIDs
1757 if type(evtType) == list or type(evtType) == tuple:
1758 self.evtType = evtType
1760 self.evtType = [evtType]
1763 def Bind(self, target, id1, id2, function):
1764 """Bind this set of event types to target."""
1765 for et in self.evtType:
1766 target.Connect(id1, id2, et, function)
1769 def Unbind(self, target, id1, id2):
1770 """Remove an event binding."""
1772 for et in self.evtType:
1773 success += target.Disconnect(id1, id2, et)
1777 def __call__(self, *args):
1779 For backwards compatibility with the old EVT_* functions.
1780 Should be called with either (window, func), (window, ID,
1781 func) or (window, ID1, ID2, func) parameters depending on the
1784 assert len(args) ==
2 + self.expectedIDs
1788 if self.expectedIDs ==
0:
1790 elif self.expectedIDs ==
1:
1793 elif self.expectedIDs ==
2:
1798 raise ValueError, "Unexpected number of IDs"
1800 self.Bind(target, id1, id2, func)
1803 # These two are square pegs that don't fit the PyEventBinder hole...
1804 def EVT_COMMAND(win, id, cmd, func):
1805 win.Connect(id, -
1, cmd, func)
1806 def EVT_COMMAND_RANGE(win, id1, id2, cmd, func):
1807 win.Connect(id1, id2, cmd, func)
1810 #---------------------------------------------------------------------------
1813 #---------------------------------------------------------------------------
1815 <method name=
"NewEventType" oldname=
"wxNewEventType" type=
"wxEventType" overloaded=
"no">
1816 <autodoc>NewEventType() -
> wxEventType
</autodoc>
1820 # Create some event binders
1821 EVT_SIZE = wx.PyEventBinder( wxEVT_SIZE )
1822 EVT_SIZING = wx.PyEventBinder( wxEVT_SIZING )
1823 EVT_MOVE = wx.PyEventBinder( wxEVT_MOVE )
1824 EVT_MOVING = wx.PyEventBinder( wxEVT_MOVING )
1825 EVT_CLOSE = wx.PyEventBinder( wxEVT_CLOSE_WINDOW )
1826 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
1827 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
1828 EVT_PAINT = wx.PyEventBinder( wxEVT_PAINT )
1829 EVT_NC_PAINT = wx.PyEventBinder( wxEVT_NC_PAINT )
1830 EVT_ERASE_BACKGROUND = wx.PyEventBinder( wxEVT_ERASE_BACKGROUND )
1831 EVT_CHAR = wx.PyEventBinder( wxEVT_CHAR )
1832 EVT_KEY_DOWN = wx.PyEventBinder( wxEVT_KEY_DOWN )
1833 EVT_KEY_UP = wx.PyEventBinder( wxEVT_KEY_UP )
1834 EVT_HOTKEY = wx.PyEventBinder( wxEVT_HOTKEY,
1)
1835 EVT_CHAR_HOOK = wx.PyEventBinder( wxEVT_CHAR_HOOK )
1836 EVT_MENU_OPEN = wx.PyEventBinder( wxEVT_MENU_OPEN )
1837 EVT_MENU_CLOSE = wx.PyEventBinder( wxEVT_MENU_CLOSE )
1838 EVT_MENU_HIGHLIGHT = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT,
1)
1839 EVT_MENU_HIGHLIGHT_ALL = wx.PyEventBinder( wxEVT_MENU_HIGHLIGHT )
1840 EVT_SET_FOCUS = wx.PyEventBinder( wxEVT_SET_FOCUS )
1841 EVT_KILL_FOCUS = wx.PyEventBinder( wxEVT_KILL_FOCUS )
1842 EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
1843 EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
1844 EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
1845 EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
1846 EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
1847 EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
1848 EVT_INIT_DIALOG = wx.PyEventBinder( wxEVT_INIT_DIALOG )
1849 EVT_SYS_COLOUR_CHANGED = wx.PyEventBinder( wxEVT_SYS_COLOUR_CHANGED )
1850 EVT_DISPLAY_CHANGED = wx.PyEventBinder( wxEVT_DISPLAY_CHANGED )
1851 EVT_SHOW = wx.PyEventBinder( wxEVT_SHOW )
1852 EVT_MAXIMIZE = wx.PyEventBinder( wxEVT_MAXIMIZE )
1853 EVT_ICONIZE = wx.PyEventBinder( wxEVT_ICONIZE )
1854 EVT_NAVIGATION_KEY = wx.PyEventBinder( wxEVT_NAVIGATION_KEY )
1855 EVT_PALETTE_CHANGED = wx.PyEventBinder( wxEVT_PALETTE_CHANGED )
1856 EVT_QUERY_NEW_PALETTE = wx.PyEventBinder( wxEVT_QUERY_NEW_PALETTE )
1857 EVT_WINDOW_CREATE = wx.PyEventBinder( wxEVT_CREATE )
1858 EVT_WINDOW_DESTROY = wx.PyEventBinder( wxEVT_DESTROY )
1859 EVT_SET_CURSOR = wx.PyEventBinder( wxEVT_SET_CURSOR )
1860 EVT_MOUSE_CAPTURE_CHANGED = wx.PyEventBinder( wxEVT_MOUSE_CAPTURE_CHANGED )
1862 EVT_LEFT_DOWN = wx.PyEventBinder( wxEVT_LEFT_DOWN )
1863 EVT_LEFT_UP = wx.PyEventBinder( wxEVT_LEFT_UP )
1864 EVT_MIDDLE_DOWN = wx.PyEventBinder( wxEVT_MIDDLE_DOWN )
1865 EVT_MIDDLE_UP = wx.PyEventBinder( wxEVT_MIDDLE_UP )
1866 EVT_RIGHT_DOWN = wx.PyEventBinder( wxEVT_RIGHT_DOWN )
1867 EVT_RIGHT_UP = wx.PyEventBinder( wxEVT_RIGHT_UP )
1868 EVT_MOTION = wx.PyEventBinder( wxEVT_MOTION )
1869 EVT_LEFT_DCLICK = wx.PyEventBinder( wxEVT_LEFT_DCLICK )
1870 EVT_MIDDLE_DCLICK = wx.PyEventBinder( wxEVT_MIDDLE_DCLICK )
1871 EVT_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_RIGHT_DCLICK )
1872 EVT_LEAVE_WINDOW = wx.PyEventBinder( wxEVT_LEAVE_WINDOW )
1873 EVT_ENTER_WINDOW = wx.PyEventBinder( wxEVT_ENTER_WINDOW )
1874 EVT_MOUSEWHEEL = wx.PyEventBinder( wxEVT_MOUSEWHEEL )
1876 EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN,
1884 wxEVT_MIDDLE_DCLICK,
1892 # Scrolling from wxWindow (sent to wxScrolledWindow)
1893 EVT_SCROLLWIN = wx.PyEventBinder([ wxEVT_SCROLLWIN_TOP,
1894 wxEVT_SCROLLWIN_BOTTOM,
1895 wxEVT_SCROLLWIN_LINEUP,
1896 wxEVT_SCROLLWIN_LINEDOWN,
1897 wxEVT_SCROLLWIN_PAGEUP,
1898 wxEVT_SCROLLWIN_PAGEDOWN,
1899 wxEVT_SCROLLWIN_THUMBTRACK,
1900 wxEVT_SCROLLWIN_THUMBRELEASE,
1903 EVT_SCROLLWIN_TOP = wx.PyEventBinder( wxEVT_SCROLLWIN_TOP )
1904 EVT_SCROLLWIN_BOTTOM = wx.PyEventBinder( wxEVT_SCROLLWIN_BOTTOM )
1905 EVT_SCROLLWIN_LINEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEUP )
1906 EVT_SCROLLWIN_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_LINEDOWN )
1907 EVT_SCROLLWIN_PAGEUP = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEUP )
1908 EVT_SCROLLWIN_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLLWIN_PAGEDOWN )
1909 EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
1910 EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
1912 # Scrolling from wxSlider and wxScrollBar
1913 EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
1914 wxEVT_SCROLL_BOTTOM,
1915 wxEVT_SCROLL_LINEUP,
1916 wxEVT_SCROLL_LINEDOWN,
1917 wxEVT_SCROLL_PAGEUP,
1918 wxEVT_SCROLL_PAGEDOWN,
1919 wxEVT_SCROLL_THUMBTRACK,
1920 wxEVT_SCROLL_THUMBRELEASE,
1921 wxEVT_SCROLL_ENDSCROLL,
1924 EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
1925 EVT_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM )
1926 EVT_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP )
1927 EVT_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN )
1928 EVT_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP )
1929 EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
1930 EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
1931 EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
1932 EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
1934 # Scrolling from wxSlider and wxScrollBar, with an id
1935 EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
1936 wxEVT_SCROLL_BOTTOM,
1937 wxEVT_SCROLL_LINEUP,
1938 wxEVT_SCROLL_LINEDOWN,
1939 wxEVT_SCROLL_PAGEUP,
1940 wxEVT_SCROLL_PAGEDOWN,
1941 wxEVT_SCROLL_THUMBTRACK,
1942 wxEVT_SCROLL_THUMBRELEASE,
1943 wxEVT_SCROLL_ENDSCROLL,
1946 EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP,
1)
1947 EVT_COMMAND_SCROLL_BOTTOM = wx.PyEventBinder( wxEVT_SCROLL_BOTTOM,
1)
1948 EVT_COMMAND_SCROLL_LINEUP = wx.PyEventBinder( wxEVT_SCROLL_LINEUP,
1)
1949 EVT_COMMAND_SCROLL_LINEDOWN = wx.PyEventBinder( wxEVT_SCROLL_LINEDOWN,
1)
1950 EVT_COMMAND_SCROLL_PAGEUP = wx.PyEventBinder( wxEVT_SCROLL_PAGEUP,
1)
1951 EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN,
1)
1952 EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK,
1)
1953 EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE,
1)
1954 EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL,
1)
1956 EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED,
1)
1957 EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED,
1)
1958 EVT_CHOICE = wx.PyEventBinder( wxEVT_COMMAND_CHOICE_SELECTED,
1)
1959 EVT_LISTBOX = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_SELECTED,
1)
1960 EVT_LISTBOX_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LISTBOX_DOUBLECLICKED,
1)
1961 EVT_MENU = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED,
1)
1962 EVT_MENU_RANGE = wx.PyEventBinder( wxEVT_COMMAND_MENU_SELECTED,
2)
1963 EVT_SLIDER = wx.PyEventBinder( wxEVT_COMMAND_SLIDER_UPDATED,
1)
1964 EVT_RADIOBOX = wx.PyEventBinder( wxEVT_COMMAND_RADIOBOX_SELECTED,
1)
1965 EVT_RADIOBUTTON = wx.PyEventBinder( wxEVT_COMMAND_RADIOBUTTON_SELECTED,
1)
1967 EVT_SCROLLBAR = wx.PyEventBinder( wxEVT_COMMAND_SCROLLBAR_UPDATED,
1)
1968 EVT_VLBOX = wx.PyEventBinder( wxEVT_COMMAND_VLBOX_SELECTED,
1)
1969 EVT_COMBOBOX = wx.PyEventBinder( wxEVT_COMMAND_COMBOBOX_SELECTED,
1)
1970 EVT_TOOL = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED,
1)
1971 EVT_TOOL_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_CLICKED,
2)
1972 EVT_TOOL_RCLICKED = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED,
1)
1973 EVT_TOOL_RCLICKED_RANGE = wx.PyEventBinder( wxEVT_COMMAND_TOOL_RCLICKED,
2)
1974 EVT_TOOL_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TOOL_ENTER,
1)
1975 EVT_CHECKLISTBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKLISTBOX_TOGGLED,
1)
1978 EVT_COMMAND_LEFT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_CLICK,
1)
1979 EVT_COMMAND_LEFT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_LEFT_DCLICK,
1)
1980 EVT_COMMAND_RIGHT_CLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_CLICK,
1)
1981 EVT_COMMAND_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_COMMAND_RIGHT_DCLICK,
1)
1982 EVT_COMMAND_SET_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_SET_FOCUS,
1)
1983 EVT_COMMAND_KILL_FOCUS = wx.PyEventBinder( wxEVT_COMMAND_KILL_FOCUS,
1)
1984 EVT_COMMAND_ENTER = wx.PyEventBinder( wxEVT_COMMAND_ENTER,
1)
1986 EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE )
1988 EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI,
1)
1989 EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI,
2)
1991 EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU )
1996 #---------------------------------------------------------------------------
1998 <class name=
"Event" oldname=
"wxEvent" module=
"_core">
1999 <baseclass name=
"Object"/>
2000 <destructor name=
"~wxEvent" overloaded=
"no">
2001 <autodoc>__del__(self)
</autodoc>
2003 <method name=
"SetEventType" type=
"" overloaded=
"no">
2004 <autodoc>SetEventType(self, wxEventType typ)
</autodoc>
2006 <param name=
"typ" type=
"wxEventType" default=
""/>
2009 <method name=
"GetEventType" type=
"wxEventType" overloaded=
"no">
2010 <autodoc>GetEventType(self) -
> wxEventType
</autodoc>
2012 <method name=
"GetEventObject" type=
"Object" overloaded=
"no">
2013 <autodoc>GetEventObject(self) -
> Object
</autodoc>
2015 <method name=
"SetEventObject" type=
"" overloaded=
"no">
2016 <autodoc>SetEventObject(self, Object obj)
</autodoc>
2018 <param name=
"obj" type=
"Object" default=
""/>
2021 <method name=
"GetTimestamp" type=
"long" overloaded=
"no">
2022 <autodoc>GetTimestamp(self) -
> long
</autodoc>
2024 <method name=
"SetTimestamp" type=
"" overloaded=
"no">
2025 <autodoc>SetTimestamp(self, long ts=
0)
</autodoc>
2027 <param name=
"ts" type=
"long" default=
"0"/>
2030 <method name=
"GetId" type=
"int" overloaded=
"no">
2031 <autodoc>GetId(self) -
> int
</autodoc>
2033 <method name=
"SetId" type=
"" overloaded=
"no">
2034 <autodoc>SetId(self, int Id)
</autodoc>
2036 <param name=
"Id" type=
"int" default=
""/>
2039 <method name=
"IsCommandEvent" type=
"bool" overloaded=
"no">
2040 <autodoc>IsCommandEvent(self) -
> bool
</autodoc>
2042 <method name=
"Skip" type=
"" overloaded=
"no">
2043 <autodoc>Skip(self, bool skip=True)
</autodoc>
2045 <param name=
"skip" type=
"bool" default=
"True"/>
2048 <method name=
"GetSkipped" type=
"bool" overloaded=
"no">
2049 <autodoc>GetSkipped(self) -
> bool
</autodoc>
2051 <method name=
"ShouldPropagate" type=
"bool" overloaded=
"no">
2052 <autodoc>ShouldPropagate(self) -
> bool
</autodoc>
2054 <method name=
"StopPropagation" type=
"int" overloaded=
"no">
2055 <autodoc>StopPropagation(self) -
> int
</autodoc>
2057 <method name=
"ResumePropagation" type=
"" overloaded=
"no">
2058 <autodoc>ResumePropagation(self, int propagationLevel)
</autodoc>
2060 <param name=
"propagationLevel" type=
"int" default=
""/>
2063 <method name=
"Clone" type=
"Event" overloaded=
"no">
2064 <autodoc>Clone(self) -
> Event
</autodoc>
2068 #---------------------------------------------------------------------------
2070 <class name=
"PropagationDisabler" oldname=
"wxPropagationDisabler" module=
"_core">
2071 <constructor name=
"PropagationDisabler" overloaded=
"no">
2072 <autodoc>__init__(self, Event event) -
> PropagationDisabler
</autodoc>
2074 <param name=
"event" type=
"Event" default=
""/>
2077 <destructor name=
"~wxPropagationDisabler" overloaded=
"no">
2078 <autodoc>__del__(self)
</autodoc>
2081 <class name=
"PropagateOnce" oldname=
"wxPropagateOnce" module=
"_core">
2082 <constructor name=
"PropagateOnce" overloaded=
"no">
2083 <autodoc>__init__(self, Event event) -
> PropagateOnce
</autodoc>
2085 <param name=
"event" type=
"Event" default=
""/>
2088 <destructor name=
"~wxPropagateOnce" overloaded=
"no">
2089 <autodoc>__del__(self)
</autodoc>
2093 #---------------------------------------------------------------------------
2095 <class name=
"CommandEvent" oldname=
"wxCommandEvent" module=
"_core">
2096 <baseclass name=
"Event"/>
2097 <constructor name=
"CommandEvent" overloaded=
"no">
2098 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=
0) -
> CommandEvent
</autodoc>
2100 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
2101 <param name=
"winid" type=
"int" default=
"0"/>
2104 <method name=
"GetSelection" type=
"int" overloaded=
"no">
2105 <autodoc>GetSelection(self) -
> int
</autodoc>
2107 <method name=
"SetString" type=
"" overloaded=
"no">
2108 <autodoc>SetString(self, String s)
</autodoc>
2110 <param name=
"s" type=
"String" default=
""/>
2113 <method name=
"GetString" type=
"String" overloaded=
"no">
2114 <autodoc>GetString(self) -
> String
</autodoc>
2116 <method name=
"IsChecked" type=
"bool" overloaded=
"no">
2117 <autodoc>IsChecked(self) -
> bool
</autodoc>
2119 <method name=
"IsSelection" type=
"bool" overloaded=
"no">
2120 <autodoc>IsSelection(self) -
> bool
</autodoc>
2122 <method name=
"SetExtraLong" type=
"" overloaded=
"no">
2123 <autodoc>SetExtraLong(self, long extraLong)
</autodoc>
2125 <param name=
"extraLong" type=
"long" default=
""/>
2128 <method name=
"GetExtraLong" type=
"long" overloaded=
"no">
2129 <autodoc>GetExtraLong(self) -
> long
</autodoc>
2131 <method name=
"SetInt" type=
"" overloaded=
"no">
2132 <autodoc>SetInt(self, int i)
</autodoc>
2134 <param name=
"i" type=
"int" default=
""/>
2137 <method name=
"GetInt" type=
"long" overloaded=
"no">
2138 <autodoc>GetInt(self) -
> long
</autodoc>
2140 <method name=
"Clone" type=
"Event" overloaded=
"no">
2141 <autodoc>Clone(self) -
> Event
</autodoc>
2145 #---------------------------------------------------------------------------
2147 <class name=
"NotifyEvent" oldname=
"wxNotifyEvent" module=
"_core">
2148 <baseclass name=
"CommandEvent"/>
2149 <constructor name=
"NotifyEvent" overloaded=
"no">
2150 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=
0) -
> NotifyEvent
</autodoc>
2152 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
2153 <param name=
"winid" type=
"int" default=
"0"/>
2156 <method name=
"Veto" type=
"" overloaded=
"no">
2157 <autodoc>Veto(self)
</autodoc>
2159 <method name=
"Allow" type=
"" overloaded=
"no">
2160 <autodoc>Allow(self)
</autodoc>
2162 <method name=
"IsAllowed" type=
"bool" overloaded=
"no">
2163 <autodoc>IsAllowed(self) -
> bool
</autodoc>
2167 #---------------------------------------------------------------------------
2169 <class name=
"ScrollEvent" oldname=
"wxScrollEvent" module=
"_core">
2170 <baseclass name=
"CommandEvent"/>
2171 <constructor name=
"ScrollEvent" overloaded=
"no">
2172 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=
0, int pos=
0,
2173 int orient=
0) -
> ScrollEvent
</autodoc>
2175 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
2176 <param name=
"winid" type=
"int" default=
"0"/>
2177 <param name=
"pos" type=
"int" default=
"0"/>
2178 <param name=
"orient" type=
"int" default=
"0"/>
2181 <method name=
"GetOrientation" type=
"int" overloaded=
"no">
2182 <autodoc>GetOrientation(self) -
> int
</autodoc>
2184 <method name=
"GetPosition" type=
"int" overloaded=
"no">
2185 <autodoc>GetPosition(self) -
> int
</autodoc>
2187 <method name=
"SetOrientation" type=
"" overloaded=
"no">
2188 <autodoc>SetOrientation(self, int orient)
</autodoc>
2190 <param name=
"orient" type=
"int" default=
""/>
2193 <method name=
"SetPosition" type=
"" overloaded=
"no">
2194 <autodoc>SetPosition(self, int pos)
</autodoc>
2196 <param name=
"pos" type=
"int" default=
""/>
2201 #---------------------------------------------------------------------------
2203 <class name=
"ScrollWinEvent" oldname=
"wxScrollWinEvent" module=
"_core">
2204 <baseclass name=
"Event"/>
2205 <constructor name=
"ScrollWinEvent" overloaded=
"no">
2206 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int pos=
0, int orient=
0) -
> ScrollWinEvent
</autodoc>
2208 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
2209 <param name=
"pos" type=
"int" default=
"0"/>
2210 <param name=
"orient" type=
"int" default=
"0"/>
2213 <method name=
"GetOrientation" type=
"int" overloaded=
"no">
2214 <autodoc>GetOrientation(self) -
> int
</autodoc>
2216 <method name=
"GetPosition" type=
"int" overloaded=
"no">
2217 <autodoc>GetPosition(self) -
> int
</autodoc>
2219 <method name=
"SetOrientation" type=
"" overloaded=
"no">
2220 <autodoc>SetOrientation(self, int orient)
</autodoc>
2222 <param name=
"orient" type=
"int" default=
""/>
2225 <method name=
"SetPosition" type=
"" overloaded=
"no">
2226 <autodoc>SetPosition(self, int pos)
</autodoc>
2228 <param name=
"pos" type=
"int" default=
""/>
2233 #---------------------------------------------------------------------------
2235 <class name=
"MouseEvent" oldname=
"wxMouseEvent" module=
"_core">
2236 <baseclass name=
"Event"/>
2237 <constructor name=
"MouseEvent" overloaded=
"no">
2238 <autodoc>__init__(self, wxEventType mouseType=wxEVT_NULL) -
> MouseEvent
</autodoc>
2240 <param name=
"mouseType" type=
"wxEventType" default=
"wxEVT_NULL"/>
2243 <method name=
"IsButton" type=
"bool" overloaded=
"no">
2244 <autodoc>IsButton(self) -
> bool
</autodoc>
2246 <method name=
"ButtonDown" type=
"bool" overloaded=
"no">
2247 <autodoc>ButtonDown(self, int but=MOUSE_BTN_ANY) -
> bool
</autodoc>
2249 <param name=
"but" type=
"int" default=
"wxMOUSE_BTN_ANY"/>
2252 <method name=
"ButtonDClick" type=
"bool" overloaded=
"no">
2253 <autodoc>ButtonDClick(self, int but=MOUSE_BTN_ANY) -
> bool
</autodoc>
2255 <param name=
"but" type=
"int" default=
"wxMOUSE_BTN_ANY"/>
2258 <method name=
"ButtonUp" type=
"bool" overloaded=
"no">
2259 <autodoc>ButtonUp(self, int but=MOUSE_BTN_ANY) -
> bool
</autodoc>
2261 <param name=
"but" type=
"int" default=
"wxMOUSE_BTN_ANY"/>
2264 <method name=
"Button" type=
"bool" overloaded=
"no">
2265 <autodoc>Button(self, int but) -
> bool
</autodoc>
2267 <param name=
"but" type=
"int" default=
""/>
2270 <method name=
"ButtonIsDown" type=
"bool" overloaded=
"no">
2271 <autodoc>ButtonIsDown(self, int but) -
> bool
</autodoc>
2273 <param name=
"but" type=
"int" default=
""/>
2276 <method name=
"GetButton" type=
"int" overloaded=
"no">
2277 <autodoc>GetButton(self) -
> int
</autodoc>
2279 <method name=
"ControlDown" type=
"bool" overloaded=
"no">
2280 <autodoc>ControlDown(self) -
> bool
</autodoc>
2282 <method name=
"MetaDown" type=
"bool" overloaded=
"no">
2283 <autodoc>MetaDown(self) -
> bool
</autodoc>
2285 <method name=
"AltDown" type=
"bool" overloaded=
"no">
2286 <autodoc>AltDown(self) -
> bool
</autodoc>
2288 <method name=
"ShiftDown" type=
"bool" overloaded=
"no">
2289 <autodoc>ShiftDown(self) -
> bool
</autodoc>
2291 <method name=
"CmdDown" type=
"bool" overloaded=
"no">
2292 <autodoc>CmdDown(self) -
> bool
</autodoc>
2293 <docstring>"Cmd" is a pseudo key which is the same as Control for PC and Unix
2294 platforms but the special
"Apple" (a.k.a as
"Command") key on
2295 Macs: it makes often sense to use it instead of, say, `ControlDown`
2296 because Cmd key is used for the same thing under Mac as Ctrl
2297 elsewhere. The Ctrl still exists, it's just not used for this
2298 purpose. So for non-Mac platforms this is the same as `ControlDown`
2299 and Macs this is the same as `MetaDown`.
</docstring>
2301 <method name=
"LeftDown" type=
"bool" overloaded=
"no">
2302 <autodoc>LeftDown(self) -
> bool
</autodoc>
2304 <method name=
"MiddleDown" type=
"bool" overloaded=
"no">
2305 <autodoc>MiddleDown(self) -
> bool
</autodoc>
2307 <method name=
"RightDown" type=
"bool" overloaded=
"no">
2308 <autodoc>RightDown(self) -
> bool
</autodoc>
2310 <method name=
"LeftUp" type=
"bool" overloaded=
"no">
2311 <autodoc>LeftUp(self) -
> bool
</autodoc>
2313 <method name=
"MiddleUp" type=
"bool" overloaded=
"no">
2314 <autodoc>MiddleUp(self) -
> bool
</autodoc>
2316 <method name=
"RightUp" type=
"bool" overloaded=
"no">
2317 <autodoc>RightUp(self) -
> bool
</autodoc>
2319 <method name=
"LeftDClick" type=
"bool" overloaded=
"no">
2320 <autodoc>LeftDClick(self) -
> bool
</autodoc>
2322 <method name=
"MiddleDClick" type=
"bool" overloaded=
"no">
2323 <autodoc>MiddleDClick(self) -
> bool
</autodoc>
2325 <method name=
"RightDClick" type=
"bool" overloaded=
"no">
2326 <autodoc>RightDClick(self) -
> bool
</autodoc>
2328 <method name=
"LeftIsDown" type=
"bool" overloaded=
"no">
2329 <autodoc>LeftIsDown(self) -
> bool
</autodoc>
2331 <method name=
"MiddleIsDown" type=
"bool" overloaded=
"no">
2332 <autodoc>MiddleIsDown(self) -
> bool
</autodoc>
2334 <method name=
"RightIsDown" type=
"bool" overloaded=
"no">
2335 <autodoc>RightIsDown(self) -
> bool
</autodoc>
2337 <method name=
"Dragging" type=
"bool" overloaded=
"no">
2338 <autodoc>Dragging(self) -
> bool
</autodoc>
2340 <method name=
"Moving" type=
"bool" overloaded=
"no">
2341 <autodoc>Moving(self) -
> bool
</autodoc>
2343 <method name=
"Entering" type=
"bool" overloaded=
"no">
2344 <autodoc>Entering(self) -
> bool
</autodoc>
2346 <method name=
"Leaving" type=
"bool" overloaded=
"no">
2347 <autodoc>Leaving(self) -
> bool
</autodoc>
2349 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
2350 <autodoc>GetPosition(self) -
> Point
</autodoc>
2351 <docstring>Returns the position of the mouse in window coordinates when the event
2352 happened.
</docstring>
2354 <method name=
"GetPositionTuple" type=
"" overloaded=
"no">
2355 <autodoc>GetPositionTuple() -
> (x,y)
</autodoc>
2356 <docstring>Returns the position of the mouse in window coordinates when the event
2357 happened.
</docstring>
2359 <param name=
"OUTPUT" type=
"long" default=
""/>
2360 <param name=
"OUTPUT" type=
"long" default=
""/>
2363 <method name=
"GetLogicalPosition" type=
"Point" overloaded=
"no">
2364 <autodoc>GetLogicalPosition(self, DC dc) -
> Point
</autodoc>
2366 <param name=
"dc" type=
"wxDC" default=
""/>
2369 <method name=
"GetX" type=
"int" overloaded=
"no">
2370 <autodoc>GetX(self) -
> int
</autodoc>
2372 <method name=
"GetY" type=
"int" overloaded=
"no">
2373 <autodoc>GetY(self) -
> int
</autodoc>
2375 <method name=
"GetWheelRotation" type=
"int" overloaded=
"no">
2376 <autodoc>GetWheelRotation(self) -
> int
</autodoc>
2378 <method name=
"GetWheelDelta" type=
"int" overloaded=
"no">
2379 <autodoc>GetWheelDelta(self) -
> int
</autodoc>
2381 <method name=
"GetLinesPerAction" type=
"int" overloaded=
"no">
2382 <autodoc>GetLinesPerAction(self) -
> int
</autodoc>
2384 <method name=
"IsPageScroll" type=
"bool" overloaded=
"no">
2385 <autodoc>IsPageScroll(self) -
> bool
</autodoc>
2387 <property name=
"m_x" type=
"int" readonly=
"no"/>
2388 <property name=
"m_y" type=
"int" readonly=
"no"/>
2389 <property name=
"m_leftDown" type=
"bool" readonly=
"no"/>
2390 <property name=
"m_middleDown" type=
"bool" readonly=
"no"/>
2391 <property name=
"m_rightDown" type=
"bool" readonly=
"no"/>
2392 <property name=
"m_controlDown" type=
"bool" readonly=
"no"/>
2393 <property name=
"m_shiftDown" type=
"bool" readonly=
"no"/>
2394 <property name=
"m_altDown" type=
"bool" readonly=
"no"/>
2395 <property name=
"m_metaDown" type=
"bool" readonly=
"no"/>
2396 <property name=
"m_wheelRotation" type=
"int" readonly=
"no"/>
2397 <property name=
"m_wheelDelta" type=
"int" readonly=
"no"/>
2398 <property name=
"m_linesPerAction" type=
"int" readonly=
"no"/>
2401 #---------------------------------------------------------------------------
2403 <class name=
"SetCursorEvent" oldname=
"wxSetCursorEvent" module=
"_core">
2404 <baseclass name=
"Event"/>
2405 <constructor name=
"SetCursorEvent" overloaded=
"no">
2406 <autodoc>__init__(self, int x=
0, int y=
0) -
> SetCursorEvent
</autodoc>
2408 <param name=
"x" type=
"int" default=
"0"/>
2409 <param name=
"y" type=
"int" default=
"0"/>
2412 <method name=
"GetX" type=
"int" overloaded=
"no">
2413 <autodoc>GetX(self) -
> int
</autodoc>
2415 <method name=
"GetY" type=
"int" overloaded=
"no">
2416 <autodoc>GetY(self) -
> int
</autodoc>
2418 <method name=
"SetCursor" type=
"" overloaded=
"no">
2419 <autodoc>SetCursor(self, Cursor cursor)
</autodoc>
2421 <param name=
"cursor" type=
"wxCursor" default=
""/>
2424 <method name=
"GetCursor" type=
"wxCursor" overloaded=
"no">
2425 <autodoc>GetCursor(self) -
> Cursor
</autodoc>
2427 <method name=
"HasCursor" type=
"bool" overloaded=
"no">
2428 <autodoc>HasCursor(self) -
> bool
</autodoc>
2432 #---------------------------------------------------------------------------
2434 <class name=
"KeyEvent" oldname=
"wxKeyEvent" module=
"_core">
2435 <baseclass name=
"Event"/>
2436 <constructor name=
"KeyEvent" overloaded=
"no">
2437 <autodoc>__init__(self, wxEventType keyType=wxEVT_NULL) -
> KeyEvent
</autodoc>
2439 <param name=
"keyType" type=
"wxEventType" default=
"wxEVT_NULL"/>
2442 <method name=
"ControlDown" type=
"bool" overloaded=
"no">
2443 <autodoc>ControlDown(self) -
> bool
</autodoc>
2445 <method name=
"MetaDown" type=
"bool" overloaded=
"no">
2446 <autodoc>MetaDown(self) -
> bool
</autodoc>
2448 <method name=
"AltDown" type=
"bool" overloaded=
"no">
2449 <autodoc>AltDown(self) -
> bool
</autodoc>
2451 <method name=
"ShiftDown" type=
"bool" overloaded=
"no">
2452 <autodoc>ShiftDown(self) -
> bool
</autodoc>
2454 <method name=
"CmdDown" type=
"bool" overloaded=
"no">
2455 <autodoc>CmdDown(self) -
> bool
</autodoc>
2456 <docstring>"Cmd" is a pseudo key which is the same as Control for PC and Unix
2457 platforms but the special
"Apple" (a.k.a as
"Command") key on
2458 Macs: it makes often sense to use it instead of, say, `ControlDown`
2459 because Cmd key is used for the same thing under Mac as Ctrl
2460 elsewhere. The Ctrl still exists, it's just not used for this
2461 purpose. So for non-Mac platforms this is the same as `ControlDown`
2462 and Macs this is the same as `MetaDown`.
</docstring>
2464 <method name=
"HasModifiers" type=
"bool" overloaded=
"no">
2465 <autodoc>HasModifiers(self) -
> bool
</autodoc>
2467 <method name=
"GetKeyCode" type=
"int" overloaded=
"no">
2468 <autodoc>GetKeyCode(self) -
> int
</autodoc>
2470 <method name=
"GetUnicodeKey" type=
"int" overloaded=
"no">
2471 <autodoc>GetUnicodeKey(self) -
> int
</autodoc>
2473 <method name=
"GetRawKeyCode" type=
"unsigned int" overloaded=
"no">
2474 <autodoc>GetRawKeyCode(self) -
> unsigned int
</autodoc>
2476 <method name=
"GetRawKeyFlags" type=
"unsigned int" overloaded=
"no">
2477 <autodoc>GetRawKeyFlags(self) -
> unsigned int
</autodoc>
2479 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
2480 <autodoc>GetPosition(self) -
> Point
</autodoc>
2481 <docstring>Find the position of the event.
</docstring>
2483 <method name=
"GetPositionTuple" type=
"" overloaded=
"no">
2484 <autodoc>GetPositionTuple() -
> (x,y)
</autodoc>
2485 <docstring>Find the position of the event.
</docstring>
2487 <param name=
"OUTPUT" type=
"long" default=
""/>
2488 <param name=
"OUTPUT" type=
"long" default=
""/>
2491 <method name=
"GetX" type=
"int" overloaded=
"no">
2492 <autodoc>GetX(self) -
> int
</autodoc>
2494 <method name=
"GetY" type=
"int" overloaded=
"no">
2495 <autodoc>GetY(self) -
> int
</autodoc>
2497 <property name=
"m_x" type=
"int" readonly=
"no"/>
2498 <property name=
"m_y" type=
"int" readonly=
"no"/>
2499 <property name=
"m_keyCode" type=
"long" readonly=
"no"/>
2500 <property name=
"m_controlDown" type=
"bool" readonly=
"no"/>
2501 <property name=
"m_shiftDown" type=
"bool" readonly=
"no"/>
2502 <property name=
"m_altDown" type=
"bool" readonly=
"no"/>
2503 <property name=
"m_metaDown" type=
"bool" readonly=
"no"/>
2504 <property name=
"m_scanCode" type=
"bool" readonly=
"no"/>
2505 <property name=
"m_rawCode" type=
"unsigned int" readonly=
"no"/>
2506 <property name=
"m_rawFlags" type=
"unsigned int" readonly=
"no"/>
2509 #---------------------------------------------------------------------------
2511 <class name=
"SizeEvent" oldname=
"wxSizeEvent" module=
"_core">
2512 <baseclass name=
"Event"/>
2513 <constructor name=
"SizeEvent" overloaded=
"no">
2514 <autodoc>__init__(self, Size sz=DefaultSize, int winid=
0) -
> SizeEvent
</autodoc>
2516 <param name=
"sz" type=
"Size" default=
"wxDefaultSize"/>
2517 <param name=
"winid" type=
"int" default=
"0"/>
2520 <method name=
"GetSize" type=
"Size" overloaded=
"no">
2521 <autodoc>GetSize(self) -
> Size
</autodoc>
2523 <method name=
"GetRect" type=
"Rect" overloaded=
"no">
2524 <autodoc>GetRect(self) -
> Rect
</autodoc>
2526 <method name=
"SetRect" type=
"" overloaded=
"no">
2527 <autodoc>SetRect(self, Rect rect)
</autodoc>
2529 <param name=
"rect" type=
"Rect" default=
""/>
2532 <method name=
"SetSize" type=
"" overloaded=
"no">
2533 <autodoc>SetSize(self, Size size)
</autodoc>
2535 <param name=
"size" type=
"Size" default=
""/>
2538 <property name=
"m_size" type=
"Size" readonly=
"no"/>
2539 <property name=
"m_rect" type=
"Rect" readonly=
"no"/>
2542 #---------------------------------------------------------------------------
2544 <class name=
"MoveEvent" oldname=
"wxMoveEvent" module=
"_core">
2545 <baseclass name=
"Event"/>
2546 <constructor name=
"MoveEvent" overloaded=
"no">
2547 <autodoc>__init__(self, Point pos=DefaultPosition, int winid=
0) -
> MoveEvent
</autodoc>
2549 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
2550 <param name=
"winid" type=
"int" default=
"0"/>
2553 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
2554 <autodoc>GetPosition(self) -
> Point
</autodoc>
2556 <method name=
"GetRect" type=
"Rect" overloaded=
"no">
2557 <autodoc>GetRect(self) -
> Rect
</autodoc>
2559 <method name=
"SetRect" type=
"" overloaded=
"no">
2560 <autodoc>SetRect(self, Rect rect)
</autodoc>
2562 <param name=
"rect" type=
"Rect" default=
""/>
2565 <method name=
"SetPosition" type=
"" overloaded=
"no">
2566 <autodoc>SetPosition(self, Point pos)
</autodoc>
2568 <param name=
"pos" type=
"Point" default=
""/>
2571 <property name=
"m_pos" type=
"Point" readonly=
"no"/>
2572 <property name=
"m_rect" type=
"Rect" readonly=
"no"/>
2575 #---------------------------------------------------------------------------
2577 <class name=
"PaintEvent" oldname=
"wxPaintEvent" module=
"_core">
2578 <baseclass name=
"Event"/>
2579 <constructor name=
"PaintEvent" overloaded=
"no">
2580 <autodoc>__init__(self, int Id=
0) -
> PaintEvent
</autodoc>
2582 <param name=
"Id" type=
"int" default=
"0"/>
2586 <class name=
"NcPaintEvent" oldname=
"wxNcPaintEvent" module=
"_core">
2587 <baseclass name=
"Event"/>
2588 <constructor name=
"NcPaintEvent" overloaded=
"no">
2589 <autodoc>__init__(self, int winid=
0) -
> NcPaintEvent
</autodoc>
2591 <param name=
"winid" type=
"int" default=
"0"/>
2596 #---------------------------------------------------------------------------
2598 <class name=
"EraseEvent" oldname=
"wxEraseEvent" module=
"_core">
2599 <baseclass name=
"Event"/>
2600 <constructor name=
"EraseEvent" overloaded=
"no">
2601 <autodoc>__init__(self, int Id=
0, DC dc=(wxDC *) NULL) -
> EraseEvent
</autodoc>
2603 <param name=
"Id" type=
"int" default=
"0"/>
2604 <param name=
"dc" type=
"wxDC" default=
"(wxDC *) NULL"/>
2607 <method name=
"GetDC" type=
"wxDC" overloaded=
"no">
2608 <autodoc>GetDC(self) -
> DC
</autodoc>
2612 #---------------------------------------------------------------------------
2614 <class name=
"FocusEvent" oldname=
"wxFocusEvent" module=
"_core">
2615 <baseclass name=
"Event"/>
2616 <constructor name=
"FocusEvent" overloaded=
"no">
2617 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=
0) -
> FocusEvent
</autodoc>
2619 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
2620 <param name=
"winid" type=
"int" default=
"0"/>
2623 <method name=
"GetWindow" type=
"wxWindow" overloaded=
"no">
2624 <autodoc>GetWindow(self) -
> Window
</autodoc>
2626 <method name=
"SetWindow" type=
"" overloaded=
"no">
2627 <autodoc>SetWindow(self, Window win)
</autodoc>
2629 <param name=
"win" type=
"wxWindow" default=
""/>
2634 #---------------------------------------------------------------------------
2636 <class name=
"ChildFocusEvent" oldname=
"wxChildFocusEvent" module=
"_core">
2637 <baseclass name=
"CommandEvent"/>
2638 <constructor name=
"ChildFocusEvent" overloaded=
"no">
2639 <autodoc>__init__(self, Window win=None) -
> ChildFocusEvent
</autodoc>
2641 <param name=
"win" type=
"wxWindow" default=
"NULL"/>
2644 <method name=
"GetWindow" type=
"wxWindow" overloaded=
"no">
2645 <autodoc>GetWindow(self) -
> Window
</autodoc>
2649 #---------------------------------------------------------------------------
2651 <class name=
"ActivateEvent" oldname=
"wxActivateEvent" module=
"_core">
2652 <baseclass name=
"Event"/>
2653 <constructor name=
"ActivateEvent" overloaded=
"no">
2654 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=
0) -
> ActivateEvent
</autodoc>
2656 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
2657 <param name=
"active" type=
"bool" default=
"True"/>
2658 <param name=
"Id" type=
"int" default=
"0"/>
2661 <method name=
"GetActive" type=
"bool" overloaded=
"no">
2662 <autodoc>GetActive(self) -
> bool
</autodoc>
2666 #---------------------------------------------------------------------------
2668 <class name=
"InitDialogEvent" oldname=
"wxInitDialogEvent" module=
"_core">
2669 <baseclass name=
"Event"/>
2670 <constructor name=
"InitDialogEvent" overloaded=
"no">
2671 <autodoc>__init__(self, int Id=
0) -
> InitDialogEvent
</autodoc>
2673 <param name=
"Id" type=
"int" default=
"0"/>
2678 #---------------------------------------------------------------------------
2680 <class name=
"MenuEvent" oldname=
"wxMenuEvent" module=
"_core">
2681 <baseclass name=
"Event"/>
2682 <constructor name=
"MenuEvent" overloaded=
"no">
2683 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=
0, Menu menu=None) -
> MenuEvent
</autodoc>
2685 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
2686 <param name=
"winid" type=
"int" default=
"0"/>
2687 <param name=
"menu" type=
"wxMenu" default=
"NULL"/>
2690 <method name=
"GetMenuId" type=
"int" overloaded=
"no">
2691 <autodoc>GetMenuId(self) -
> int
</autodoc>
2693 <method name=
"IsPopup" type=
"bool" overloaded=
"no">
2694 <autodoc>IsPopup(self) -
> bool
</autodoc>
2696 <method name=
"GetMenu" type=
"wxMenu" overloaded=
"no">
2697 <autodoc>GetMenu(self) -
> Menu
</autodoc>
2701 #---------------------------------------------------------------------------
2703 <class name=
"CloseEvent" oldname=
"wxCloseEvent" module=
"_core">
2704 <baseclass name=
"Event"/>
2705 <constructor name=
"CloseEvent" overloaded=
"no">
2706 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=
0) -
> CloseEvent
</autodoc>
2708 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
2709 <param name=
"winid" type=
"int" default=
"0"/>
2712 <method name=
"SetLoggingOff" type=
"" overloaded=
"no">
2713 <autodoc>SetLoggingOff(self, bool logOff)
</autodoc>
2715 <param name=
"logOff" type=
"bool" default=
""/>
2718 <method name=
"GetLoggingOff" type=
"bool" overloaded=
"no">
2719 <autodoc>GetLoggingOff(self) -
> bool
</autodoc>
2721 <method name=
"Veto" type=
"" overloaded=
"no">
2722 <autodoc>Veto(self, bool veto=True)
</autodoc>
2724 <param name=
"veto" type=
"bool" default=
"True"/>
2727 <method name=
"SetCanVeto" type=
"" overloaded=
"no">
2728 <autodoc>SetCanVeto(self, bool canVeto)
</autodoc>
2730 <param name=
"canVeto" type=
"bool" default=
""/>
2733 <method name=
"CanVeto" type=
"bool" overloaded=
"no">
2734 <autodoc>CanVeto(self) -
> bool
</autodoc>
2736 <method name=
"GetVeto" type=
"bool" overloaded=
"no">
2737 <autodoc>GetVeto(self) -
> bool
</autodoc>
2741 #---------------------------------------------------------------------------
2743 <class name=
"ShowEvent" oldname=
"wxShowEvent" module=
"_core">
2744 <baseclass name=
"Event"/>
2745 <constructor name=
"ShowEvent" overloaded=
"no">
2746 <autodoc>__init__(self, int winid=
0, bool show=False) -
> ShowEvent
</autodoc>
2748 <param name=
"winid" type=
"int" default=
"0"/>
2749 <param name=
"show" type=
"bool" default=
"False"/>
2752 <method name=
"SetShow" type=
"" overloaded=
"no">
2753 <autodoc>SetShow(self, bool show)
</autodoc>
2755 <param name=
"show" type=
"bool" default=
""/>
2758 <method name=
"GetShow" type=
"bool" overloaded=
"no">
2759 <autodoc>GetShow(self) -
> bool
</autodoc>
2763 #---------------------------------------------------------------------------
2765 <class name=
"IconizeEvent" oldname=
"wxIconizeEvent" module=
"_core">
2766 <baseclass name=
"Event"/>
2767 <constructor name=
"IconizeEvent" overloaded=
"no">
2768 <autodoc>__init__(self, int id=
0, bool iconized=True) -
> IconizeEvent
</autodoc>
2770 <param name=
"id" type=
"int" default=
"0"/>
2771 <param name=
"iconized" type=
"bool" default=
"True"/>
2774 <method name=
"Iconized" type=
"bool" overloaded=
"no">
2775 <autodoc>Iconized(self) -
> bool
</autodoc>
2779 #---------------------------------------------------------------------------
2781 <class name=
"MaximizeEvent" oldname=
"wxMaximizeEvent" module=
"_core">
2782 <baseclass name=
"Event"/>
2783 <constructor name=
"MaximizeEvent" overloaded=
"no">
2784 <autodoc>__init__(self, int id=
0) -
> MaximizeEvent
</autodoc>
2786 <param name=
"id" type=
"int" default=
"0"/>
2791 #---------------------------------------------------------------------------
2793 <class name=
"DropFilesEvent" oldname=
"wxDropFilesEvent" module=
"_core">
2794 <baseclass name=
"Event"/>
2795 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
2796 <autodoc>GetPosition(self) -
> Point
</autodoc>
2798 <method name=
"GetNumberOfFiles" type=
"int" overloaded=
"no">
2799 <autodoc>GetNumberOfFiles(self) -
> int
</autodoc>
2801 <method name=
"GetFiles" type=
"PyObject" overloaded=
"no">
2802 <autodoc>GetFiles(self) -
> PyObject
</autodoc>
2806 #---------------------------------------------------------------------------
2808 <class name=
"UpdateUIEvent" oldname=
"wxUpdateUIEvent" module=
"_core">
2809 <baseclass name=
"CommandEvent"/>
2810 <constructor name=
"UpdateUIEvent" overloaded=
"no">
2811 <autodoc>__init__(self, int commandId=
0) -
> UpdateUIEvent
</autodoc>
2813 <param name=
"commandId" type=
"int" default=
"0"/>
2816 <method name=
"GetChecked" type=
"bool" overloaded=
"no">
2817 <autodoc>GetChecked(self) -
> bool
</autodoc>
2819 <method name=
"GetEnabled" type=
"bool" overloaded=
"no">
2820 <autodoc>GetEnabled(self) -
> bool
</autodoc>
2822 <method name=
"GetText" type=
"String" overloaded=
"no">
2823 <autodoc>GetText(self) -
> String
</autodoc>
2825 <method name=
"GetSetText" type=
"bool" overloaded=
"no">
2826 <autodoc>GetSetText(self) -
> bool
</autodoc>
2828 <method name=
"GetSetChecked" type=
"bool" overloaded=
"no">
2829 <autodoc>GetSetChecked(self) -
> bool
</autodoc>
2831 <method name=
"GetSetEnabled" type=
"bool" overloaded=
"no">
2832 <autodoc>GetSetEnabled(self) -
> bool
</autodoc>
2834 <method name=
"Check" type=
"" overloaded=
"no">
2835 <autodoc>Check(self, bool check)
</autodoc>
2837 <param name=
"check" type=
"bool" default=
""/>
2840 <method name=
"Enable" type=
"" overloaded=
"no">
2841 <autodoc>Enable(self, bool enable)
</autodoc>
2843 <param name=
"enable" type=
"bool" default=
""/>
2846 <method name=
"SetText" type=
"" overloaded=
"no">
2847 <autodoc>SetText(self, String text)
</autodoc>
2849 <param name=
"text" type=
"String" default=
""/>
2852 <staticmethod name=
"SetUpdateInterval" type=
"" overloaded=
"no">
2853 <autodoc>SetUpdateInterval(long updateInterval)
</autodoc>
2855 <param name=
"updateInterval" type=
"long" default=
""/>
2858 <staticmethod name=
"GetUpdateInterval" type=
"long" overloaded=
"no">
2859 <autodoc>GetUpdateInterval() -
> long
</autodoc>
2861 <staticmethod name=
"CanUpdate" type=
"bool" overloaded=
"no">
2862 <autodoc>CanUpdate(Window win) -
> bool
</autodoc>
2864 <param name=
"win" type=
"wxWindow" default=
""/>
2867 <staticmethod name=
"ResetUpdateTime" type=
"" overloaded=
"no">
2868 <autodoc>ResetUpdateTime()
</autodoc>
2870 <staticmethod name=
"SetMode" type=
"" overloaded=
"no">
2871 <autodoc>SetMode(int mode)
</autodoc>
2873 <param name=
"mode" type=
"wxUpdateUIMode" default=
""/>
2876 <staticmethod name=
"GetMode" type=
"wxUpdateUIMode" overloaded=
"no">
2877 <autodoc>GetMode() -
> int
</autodoc>
2881 #---------------------------------------------------------------------------
2883 <class name=
"SysColourChangedEvent" oldname=
"wxSysColourChangedEvent" module=
"_core">
2884 <baseclass name=
"Event"/>
2885 <constructor name=
"SysColourChangedEvent" overloaded=
"no">
2886 <autodoc>__init__(self) -
> SysColourChangedEvent
</autodoc>
2890 #---------------------------------------------------------------------------
2892 <class name=
"MouseCaptureChangedEvent" oldname=
"wxMouseCaptureChangedEvent" module=
"_core">
2893 <baseclass name=
"Event"/>
2894 <constructor name=
"MouseCaptureChangedEvent" overloaded=
"no">
2895 <autodoc>__init__(self, int winid=
0, Window gainedCapture=None) -
> MouseCaptureChangedEvent
</autodoc>
2897 <param name=
"winid" type=
"int" default=
"0"/>
2898 <param name=
"gainedCapture" type=
"wxWindow" default=
"NULL"/>
2901 <method name=
"GetCapturedWindow" type=
"wxWindow" overloaded=
"no">
2902 <autodoc>GetCapturedWindow(self) -
> Window
</autodoc>
2906 #---------------------------------------------------------------------------
2908 <class name=
"DisplayChangedEvent" oldname=
"wxDisplayChangedEvent" module=
"_core">
2909 <baseclass name=
"Event"/>
2910 <constructor name=
"DisplayChangedEvent" overloaded=
"no">
2911 <autodoc>__init__(self) -
> DisplayChangedEvent
</autodoc>
2915 #---------------------------------------------------------------------------
2917 <class name=
"PaletteChangedEvent" oldname=
"wxPaletteChangedEvent" module=
"_core">
2918 <baseclass name=
"Event"/>
2919 <constructor name=
"PaletteChangedEvent" overloaded=
"no">
2920 <autodoc>__init__(self, int id=
0) -
> PaletteChangedEvent
</autodoc>
2922 <param name=
"id" type=
"int" default=
"0"/>
2925 <method name=
"SetChangedWindow" type=
"" overloaded=
"no">
2926 <autodoc>SetChangedWindow(self, Window win)
</autodoc>
2928 <param name=
"win" type=
"wxWindow" default=
""/>
2931 <method name=
"GetChangedWindow" type=
"wxWindow" overloaded=
"no">
2932 <autodoc>GetChangedWindow(self) -
> Window
</autodoc>
2936 #---------------------------------------------------------------------------
2938 <class name=
"QueryNewPaletteEvent" oldname=
"wxQueryNewPaletteEvent" module=
"_core">
2939 <baseclass name=
"Event"/>
2940 <constructor name=
"QueryNewPaletteEvent" overloaded=
"no">
2941 <autodoc>__init__(self, int winid=
0) -
> QueryNewPaletteEvent
</autodoc>
2943 <param name=
"winid" type=
"int" default=
"0"/>
2946 <method name=
"SetPaletteRealized" type=
"" overloaded=
"no">
2947 <autodoc>SetPaletteRealized(self, bool realized)
</autodoc>
2949 <param name=
"realized" type=
"bool" default=
""/>
2952 <method name=
"GetPaletteRealized" type=
"bool" overloaded=
"no">
2953 <autodoc>GetPaletteRealized(self) -
> bool
</autodoc>
2957 #---------------------------------------------------------------------------
2959 <class name=
"NavigationKeyEvent" oldname=
"wxNavigationKeyEvent" module=
"_core">
2960 <baseclass name=
"Event"/>
2961 <constructor name=
"NavigationKeyEvent" overloaded=
"no">
2962 <autodoc>__init__(self) -
> NavigationKeyEvent
</autodoc>
2964 <method name=
"GetDirection" type=
"bool" overloaded=
"no">
2965 <autodoc>GetDirection(self) -
> bool
</autodoc>
2967 <method name=
"SetDirection" type=
"" overloaded=
"no">
2968 <autodoc>SetDirection(self, bool forward)
</autodoc>
2970 <param name=
"forward" type=
"bool" default=
""/>
2973 <method name=
"IsWindowChange" type=
"bool" overloaded=
"no">
2974 <autodoc>IsWindowChange(self) -
> bool
</autodoc>
2976 <method name=
"SetWindowChange" type=
"" overloaded=
"no">
2977 <autodoc>SetWindowChange(self, bool ischange)
</autodoc>
2979 <param name=
"ischange" type=
"bool" default=
""/>
2982 <method name=
"SetFlags" type=
"" overloaded=
"no">
2983 <autodoc>SetFlags(self, long flags)
</autodoc>
2985 <param name=
"flags" type=
"long" default=
""/>
2988 <method name=
"GetCurrentFocus" type=
"wxWindow" overloaded=
"no">
2989 <autodoc>GetCurrentFocus(self) -
> Window
</autodoc>
2991 <method name=
"SetCurrentFocus" type=
"" overloaded=
"no">
2992 <autodoc>SetCurrentFocus(self, Window win)
</autodoc>
2994 <param name=
"win" type=
"wxWindow" default=
""/>
2999 #---------------------------------------------------------------------------
3001 <class name=
"WindowCreateEvent" oldname=
"wxWindowCreateEvent" module=
"_core">
3002 <baseclass name=
"CommandEvent"/>
3003 <constructor name=
"WindowCreateEvent" overloaded=
"no">
3004 <autodoc>__init__(self, Window win=None) -
> WindowCreateEvent
</autodoc>
3006 <param name=
"win" type=
"wxWindow" default=
"NULL"/>
3009 <method name=
"GetWindow" type=
"wxWindow" overloaded=
"no">
3010 <autodoc>GetWindow(self) -
> Window
</autodoc>
3013 <class name=
"WindowDestroyEvent" oldname=
"wxWindowDestroyEvent" module=
"_core">
3014 <baseclass name=
"CommandEvent"/>
3015 <constructor name=
"WindowDestroyEvent" overloaded=
"no">
3016 <autodoc>__init__(self, Window win=None) -
> WindowDestroyEvent
</autodoc>
3018 <param name=
"win" type=
"wxWindow" default=
"NULL"/>
3021 <method name=
"GetWindow" type=
"wxWindow" overloaded=
"no">
3022 <autodoc>GetWindow(self) -
> Window
</autodoc>
3026 #---------------------------------------------------------------------------
3028 <class name=
"ContextMenuEvent" oldname=
"wxContextMenuEvent" module=
"_core">
3029 <baseclass name=
"CommandEvent"/>
3030 <constructor name=
"ContextMenuEvent" overloaded=
"no">
3031 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=
0, Point pt=DefaultPosition) -
> ContextMenuEvent
</autodoc>
3033 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
3034 <param name=
"winid" type=
"int" default=
"0"/>
3035 <param name=
"pt" type=
"Point" default=
"wxDefaultPosition"/>
3038 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
3039 <autodoc>GetPosition(self) -
> Point
</autodoc>
3041 <method name=
"SetPosition" type=
"" overloaded=
"no">
3042 <autodoc>SetPosition(self, Point pos)
</autodoc>
3044 <param name=
"pos" type=
"Point" default=
""/>
3049 #---------------------------------------------------------------------------
3051 <class name=
"IdleEvent" oldname=
"wxIdleEvent" module=
"_core">
3052 <baseclass name=
"Event"/>
3053 <constructor name=
"IdleEvent" overloaded=
"no">
3054 <autodoc>__init__(self) -
> IdleEvent
</autodoc>
3056 <method name=
"RequestMore" type=
"" overloaded=
"no">
3057 <autodoc>RequestMore(self, bool needMore=True)
</autodoc>
3059 <param name=
"needMore" type=
"bool" default=
"True"/>
3062 <method name=
"MoreRequested" type=
"bool" overloaded=
"no">
3063 <autodoc>MoreRequested(self) -
> bool
</autodoc>
3065 <staticmethod name=
"SetMode" type=
"" overloaded=
"no">
3066 <autodoc>SetMode(int mode)
</autodoc>
3068 <param name=
"mode" type=
"wxIdleMode" default=
""/>
3071 <staticmethod name=
"GetMode" type=
"wxIdleMode" overloaded=
"no">
3072 <autodoc>GetMode() -
> int
</autodoc>
3074 <staticmethod name=
"CanSend" type=
"bool" overloaded=
"no">
3075 <autodoc>CanSend(Window win) -
> bool
</autodoc>
3077 <param name=
"win" type=
"wxWindow" default=
""/>
3082 #---------------------------------------------------------------------------
3084 <class name=
"PyEvent" oldname=
"wxPyEvent" module=
"_core">
3085 <baseclass name=
"Event"/>
3086 <constructor name=
"PyEvent" overloaded=
"no">
3087 <autodoc>__init__(self, int winid=
0, wxEventType commandType=wxEVT_NULL) -
> PyEvent
</autodoc>
3089 <param name=
"winid" type=
"int" default=
"0"/>
3090 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
3093 <destructor name=
"~wxPyEvent" overloaded=
"no">
3094 <autodoc>__del__(self)
</autodoc>
3096 <method name=
"SetSelf" type=
"" overloaded=
"no">
3097 <autodoc>SetSelf(self, PyObject self)
</autodoc>
3099 <param name=
"self" type=
"PyObject" default=
""/>
3102 <method name=
"GetSelf" type=
"PyObject" overloaded=
"no">
3103 <autodoc>GetSelf(self) -
> PyObject
</autodoc>
3106 <class name=
"PyCommandEvent" oldname=
"wxPyCommandEvent" module=
"_core">
3107 <baseclass name=
"CommandEvent"/>
3108 <constructor name=
"PyCommandEvent" overloaded=
"no">
3109 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=
0) -
> PyCommandEvent
</autodoc>
3111 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
3112 <param name=
"id" type=
"int" default=
"0"/>
3115 <destructor name=
"~wxPyCommandEvent" overloaded=
"no">
3116 <autodoc>__del__(self)
</autodoc>
3118 <method name=
"SetSelf" type=
"" overloaded=
"no">
3119 <autodoc>SetSelf(self, PyObject self)
</autodoc>
3121 <param name=
"self" type=
"PyObject" default=
""/>
3124 <method name=
"GetSelf" type=
"PyObject" overloaded=
"no">
3125 <autodoc>GetSelf(self) -
> PyObject
</autodoc>
3129 #---------------------------------------------------------------------------
3131 <class name=
"PyApp" oldname=
"wxPyApp" module=
"_core">
3132 <docstring>The ``wx.PyApp`` class is an *implementation detail*, please use the
3133 `wx.App` class (or some other derived class) instead.
</docstring>
3134 <baseclass name=
"EvtHandler"/>
3135 <constructor name=
"PyApp" overloaded=
"no">
3136 <autodoc>__init__(self) -
> PyApp
</autodoc>
3137 <docstring>Create a new application object, starting the bootstrap process.
</docstring>
3139 <destructor name=
"~wxPyApp" overloaded=
"no">
3140 <autodoc>__del__(self)
</autodoc>
3142 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
3143 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
3145 <param name=
"self" type=
"PyObject" default=
""/>
3146 <param name=
"_class" type=
"PyObject" default=
""/>
3149 <method name=
"GetAppName" type=
"String" overloaded=
"no">
3150 <autodoc>GetAppName(self) -
> String
</autodoc>
3151 <docstring>Get the application name.
</docstring>
3153 <method name=
"SetAppName" type=
"" overloaded=
"no">
3154 <autodoc>SetAppName(self, String name)
</autodoc>
3155 <docstring>Set the application name. This value may be used automatically by
3156 `wx.Config` and such.
</docstring>
3158 <param name=
"name" type=
"String" default=
""/>
3161 <method name=
"GetClassName" type=
"String" overloaded=
"no">
3162 <autodoc>GetClassName(self) -
> String
</autodoc>
3163 <docstring>Get the application's class name.
</docstring>
3165 <method name=
"SetClassName" type=
"" overloaded=
"no">
3166 <autodoc>SetClassName(self, String name)
</autodoc>
3167 <docstring>Set the application's class name. This value may be used for
3168 X-resources if applicable for the platform
</docstring>
3170 <param name=
"name" type=
"String" default=
""/>
3173 <method name=
"GetVendorName" type=
"String" overloaded=
"no">
3174 <autodoc>GetVendorName(self) -
> String
</autodoc>
3175 <docstring>Get the application's vendor name.
</docstring>
3177 <method name=
"SetVendorName" type=
"" overloaded=
"no">
3178 <autodoc>SetVendorName(self, String name)
</autodoc>
3179 <docstring>Set the application's vendor name. This value may be used
3180 automatically by `wx.Config` and such.
</docstring>
3182 <param name=
"name" type=
"String" default=
""/>
3185 <method name=
"GetTraits" type=
"wxAppTraits" overloaded=
"no">
3186 <autodoc>GetTraits(self) -
> wxAppTraits
</autodoc>
3187 <docstring>Return (and create if necessary) the app traits object to which we
3188 delegate for everything which either should be configurable by the
3189 user (then he can change the default behaviour simply by overriding
3190 CreateTraits() and returning his own traits object) or which is
3191 GUI/console dependent as then wx.AppTraits allows us to abstract the
3192 differences behind the common facade.
3194 :todo: Add support for overriding CreateAppTraits in wxPython.
</docstring>
3196 <method name=
"ProcessPendingEvents" type=
"" overloaded=
"no">
3197 <autodoc>ProcessPendingEvents(self)
</autodoc>
3198 <docstring>Process all events in the Pending Events list -- it is necessary to
3199 call this function to process posted events. This normally happens
3200 during each event loop iteration.
</docstring>
3202 <method name=
"Yield" type=
"bool" overloaded=
"no">
3203 <autodoc>Yield(self, bool onlyIfNeeded=False) -
> bool
</autodoc>
3204 <docstring>Process all currently pending events right now, instead of waiting
3205 until return to the event loop. It is an error to call ``Yield``
3206 recursively unless the value of ``onlyIfNeeded`` is True.
3208 :warning: This function is dangerous as it can lead to unexpected
3209 reentrancies (i.e. when called from an event handler it may
3210 result in calling the same event handler again), use with
3211 extreme care or, better, don't use at all!
3213 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
3216 <param name=
"onlyIfNeeded" type=
"bool" default=
"False"/>
3219 <method name=
"WakeUpIdle" type=
"" overloaded=
"no">
3220 <autodoc>WakeUpIdle(self)
</autodoc>
3221 <docstring>Make sure that idle events are sent again.
3222 :see: `wx.WakeUpIdle`
</docstring>
3224 <method name=
"MainLoop" type=
"int" overloaded=
"no">
3225 <autodoc>MainLoop(self) -
> int
</autodoc>
3226 <docstring>Execute the main GUI loop, the function doesn't normally return until
3227 all top level windows have been closed and destroyed.
</docstring>
3229 <method name=
"Exit" type=
"" overloaded=
"no">
3230 <autodoc>Exit(self)
</autodoc>
3231 <docstring>Exit the main loop thus terminating the application.
3232 :see: `wx.Exit`
</docstring>
3234 <method name=
"ExitMainLoop" type=
"" overloaded=
"no">
3235 <autodoc>ExitMainLoop(self)
</autodoc>
3236 <docstring>Exit the main GUI loop during the next iteration of the main
3237 loop, (i.e. it does not stop the program immediately!)
</docstring>
3239 <method name=
"Pending" type=
"bool" overloaded=
"no">
3240 <autodoc>Pending(self) -
> bool
</autodoc>
3241 <docstring>Returns True if there are unprocessed events in the event queue.
</docstring>
3243 <method name=
"Dispatch" type=
"bool" overloaded=
"no">
3244 <autodoc>Dispatch(self) -
> bool
</autodoc>
3245 <docstring>Process the first event in the event queue (blocks until an event
3246 appears if there are none currently)
</docstring>
3248 <method name=
"ProcessIdle" type=
"bool" overloaded=
"no">
3249 <autodoc>ProcessIdle(self) -
> bool
</autodoc>
3250 <docstring>Called from the MainLoop when the application becomes idle (there are
3251 no pending events) and sends a `wx.IdleEvent` to all interested
3252 parties. Returns True if more idle events are needed, False if not.
</docstring>
3254 <method name=
"SendIdleEvents" type=
"bool" overloaded=
"no">
3255 <autodoc>SendIdleEvents(self, Window win, IdleEvent event) -
> bool
</autodoc>
3256 <docstring>Send idle event to window and all subwindows. Returns True if more
3257 idle time is requested.
</docstring>
3259 <param name=
"win" type=
"wxWindow" default=
""/>
3260 <param name=
"event" type=
"IdleEvent" default=
""/>
3263 <method name=
"IsActive" type=
"bool" overloaded=
"no">
3264 <autodoc>IsActive(self) -
> bool
</autodoc>
3265 <docstring>Return True if our app has focus.
</docstring>
3267 <method name=
"SetTopWindow" type=
"" overloaded=
"no">
3268 <autodoc>SetTopWindow(self, Window win)
</autodoc>
3269 <docstring>Set the *main* top level window
</docstring>
3271 <param name=
"win" type=
"wxWindow" default=
""/>
3274 <method name=
"GetTopWindow" type=
"wxWindow" overloaded=
"no">
3275 <autodoc>GetTopWindow(self) -
> Window
</autodoc>
3276 <docstring>Return the *main* top level window (if it hadn't been set previously
3277 with SetTopWindow(), will return just some top level window and, if
3278 there not any, will return None)
</docstring>
3280 <method name=
"SetExitOnFrameDelete" type=
"" overloaded=
"no">
3281 <autodoc>SetExitOnFrameDelete(self, bool flag)
</autodoc>
3282 <docstring>Control the exit behaviour: by default, the program will exit the main
3283 loop (and so, usually, terminate) when the last top-level program
3284 window is deleted. Beware that if you disable this behaviour (with
3285 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
3286 explicitly from somewhere.
</docstring>
3288 <param name=
"flag" type=
"bool" default=
""/>
3291 <method name=
"GetExitOnFrameDelete" type=
"bool" overloaded=
"no">
3292 <autodoc>GetExitOnFrameDelete(self) -
> bool
</autodoc>
3293 <docstring>Get the current exit behaviour setting.
</docstring>
3295 <method name=
"SetUseBestVisual" type=
"" overloaded=
"no">
3296 <autodoc>SetUseBestVisual(self, bool flag)
</autodoc>
3297 <docstring>Set whether the app should try to use the best available visual on
3298 systems where more than one is available, (Sun, SGI, XFree86
4, etc.)
</docstring>
3300 <param name=
"flag" type=
"bool" default=
""/>
3303 <method name=
"GetUseBestVisual" type=
"bool" overloaded=
"no">
3304 <autodoc>GetUseBestVisual(self) -
> bool
</autodoc>
3305 <docstring>Get current UseBestVisual setting.
</docstring>
3307 <method name=
"SetPrintMode" type=
"" overloaded=
"no">
3308 <autodoc>SetPrintMode(self, int mode)
</autodoc>
3310 <param name=
"mode" type=
"int" default=
""/>
3313 <method name=
"GetPrintMode" type=
"int" overloaded=
"no">
3314 <autodoc>GetPrintMode(self) -
> int
</autodoc>
3316 <method name=
"SetAssertMode" type=
"" overloaded=
"no">
3317 <autodoc>SetAssertMode(self, int mode)
</autodoc>
3318 <docstring>Set the OnAssert behaviour for debug and hybrid builds.The following flags may be or'd together:
3320 ========================= =======================================
3321 wx.PYAPP_ASSERT_SUPPRESS Don't do anything
3322 wx.PYAPP_ASSERT_EXCEPTION Turn it into a Python exception if possible
3324 wx.PYAPP_ASSERT_DIALOG Display a message dialog
3325 wx.PYAPP_ASSERT_LOG Write the assertion info to the wx.Log
3326 ========================= =======================================
3330 <param name=
"mode" type=
"int" default=
""/>
3333 <method name=
"GetAssertMode" type=
"int" overloaded=
"no">
3334 <autodoc>GetAssertMode(self) -
> int
</autodoc>
3335 <docstring>Get the current OnAssert behaviour setting.
</docstring>
3337 <staticmethod name=
"GetMacSupportPCMenuShortcuts" type=
"bool" overloaded=
"no">
3338 <autodoc>GetMacSupportPCMenuShortcuts() -
> bool
</autodoc>
3340 <staticmethod name=
"GetMacAboutMenuItemId" type=
"long" overloaded=
"no">
3341 <autodoc>GetMacAboutMenuItemId() -
> long
</autodoc>
3343 <staticmethod name=
"GetMacPreferencesMenuItemId" type=
"long" overloaded=
"no">
3344 <autodoc>GetMacPreferencesMenuItemId() -
> long
</autodoc>
3346 <staticmethod name=
"GetMacExitMenuItemId" type=
"long" overloaded=
"no">
3347 <autodoc>GetMacExitMenuItemId() -
> long
</autodoc>
3349 <staticmethod name=
"GetMacHelpMenuTitleName" type=
"String" overloaded=
"no">
3350 <autodoc>GetMacHelpMenuTitleName() -
> String
</autodoc>
3352 <staticmethod name=
"SetMacSupportPCMenuShortcuts" type=
"" overloaded=
"no">
3353 <autodoc>SetMacSupportPCMenuShortcuts(bool val)
</autodoc>
3355 <param name=
"val" type=
"bool" default=
""/>
3358 <staticmethod name=
"SetMacAboutMenuItemId" type=
"" overloaded=
"no">
3359 <autodoc>SetMacAboutMenuItemId(long val)
</autodoc>
3361 <param name=
"val" type=
"long" default=
""/>
3364 <staticmethod name=
"SetMacPreferencesMenuItemId" type=
"" overloaded=
"no">
3365 <autodoc>SetMacPreferencesMenuItemId(long val)
</autodoc>
3367 <param name=
"val" type=
"long" default=
""/>
3370 <staticmethod name=
"SetMacExitMenuItemId" type=
"" overloaded=
"no">
3371 <autodoc>SetMacExitMenuItemId(long val)
</autodoc>
3373 <param name=
"val" type=
"long" default=
""/>
3376 <staticmethod name=
"SetMacHelpMenuTitleName" type=
"" overloaded=
"no">
3377 <autodoc>SetMacHelpMenuTitleName(String val)
</autodoc>
3379 <param name=
"val" type=
"String" default=
""/>
3382 <method name=
"_BootstrapApp" type=
"" overloaded=
"no">
3383 <autodoc>_BootstrapApp(self)
</autodoc>
3384 <docstring>For internal use only
</docstring>
3386 <staticmethod name=
"GetComCtl32Version" type=
"int" overloaded=
"no">
3387 <autodoc>GetComCtl32Version() -
> int
</autodoc>
3388 <docstring>Returns
400,
470,
471, etc. for comctl32.dll
4.00,
4.70,
4.71 or
0 if
3389 it wasn't found at all. Raises an exception on non-Windows platforms.
</docstring>
3393 #---------------------------------------------------------------------------
3395 <method name=
"Exit" oldname=
"wxExit" type=
"" overloaded=
"no">
3396 <autodoc>Exit()
</autodoc>
3397 <docstring>Force an exit of the application. Convenience for wx.GetApp().Exit()
</docstring>
3399 <method name=
"Yield" oldname=
"wxYield" type=
"bool" overloaded=
"no">
3400 <autodoc>Yield() -
> bool
</autodoc>
3401 <docstring>Yield to other apps/messages. Convenience for wx.GetApp().Yield()
</docstring>
3403 <method name=
"YieldIfNeeded" oldname=
"wxYieldIfNeeded" type=
"bool" overloaded=
"no">
3404 <autodoc>YieldIfNeeded() -
> bool
</autodoc>
3405 <docstring>Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
</docstring>
3407 <method name=
"SafeYield" oldname=
"wxSafeYield" type=
"bool" overloaded=
"no">
3408 <autodoc>SafeYield(Window win=None, bool onlyIfNeeded=False) -
> bool
</autodoc>
3409 <docstring>This function is similar to `wx.Yield`, except that it disables the
3410 user input to all program windows before calling `wx.Yield` and
3411 re-enables it again afterwards. If ``win`` is not None, this window
3412 will remain enabled, allowing the implementation of some limited user
3415 :Returns: the result of the call to `wx.Yield`.
</docstring>
3417 <param name=
"win" type=
"wxWindow" default=
"NULL"/>
3418 <param name=
"onlyIfNeeded" type=
"bool" default=
"False"/>
3421 <method name=
"WakeUpIdle" oldname=
"wxWakeUpIdle" type=
"" overloaded=
"no">
3422 <autodoc>WakeUpIdle()
</autodoc>
3423 <docstring>Cause the message queue to become empty again, so idle events will be
3426 <method name=
"PostEvent" oldname=
"wxPostEvent" type=
"" overloaded=
"no">
3427 <autodoc>PostEvent(EvtHandler dest, Event event)
</autodoc>
3428 <docstring>Send an event to a window or other wx.EvtHandler to be processed
3431 <param name=
"dest" type=
"EvtHandler" default=
""/>
3432 <param name=
"event" type=
"Event" default=
""/>
3435 <method name=
"App_CleanUp" oldname=
"wxApp_CleanUp" type=
"" overloaded=
"no">
3436 <autodoc>App_CleanUp()
</autodoc>
3437 <docstring>For internal use only, it is used to cleanup after wxWidgets when
3438 Python shuts down.
</docstring>
3440 <method name=
"GetApp" oldname=
"wxPyGetApp" type=
"PyApp" overloaded=
"no">
3441 <autodoc>GetApp() -
> PyApp
</autodoc>
3442 <docstring>Return a reference to the current wx.App object.
</docstring>
3445 #----------------------------------------------------------------------
3447 class PyOnDemandOutputWindow:
3449 A class that can be used for redirecting Python's stdout and
3450 stderr streams. It will do nothing until something is wrriten to
3451 the stream at which point it will create a Frame with a text area
3452 and write the text there.
3454 def __init__(self, title = "wxPython: stdout/stderr"):
3457 self.pos = wx.DefaultPosition
3458 self.size = (
450,
300)
3461 def SetParent(self, parent):
3462 """Set the window to be used as the popup Frame's parent."""
3463 self.parent = parent
3466 def CreateOutputWindow(self, st):
3467 self.frame = wx.Frame(self.parent, -
1, self.title, self.pos, self.size,
3468 style=wx.DEFAULT_FRAME_STYLE)
3469 self.text = wx.TextCtrl(self.frame, -
1, "",
3470 style=wx.TE_MULTILINE|wx.TE_READONLY)
3471 self.text.AppendText(st)
3472 self.frame.Show(True)
3473 EVT_CLOSE(self.frame, self.OnCloseWindow)
3476 def OnCloseWindow(self, event):
3477 if self.frame is not None:
3478 self.frame.Destroy()
3483 # These methods provide the file-like output behaviour.
3484 def write(self, text):
3486 Create the output window if needed and write the string to it.
3487 If not called in the context of the gui thread then uses
3488 CallAfter to do the work there.
3490 if self.frame is None:
3491 if not wx.Thread_IsMain():
3492 wx.CallAfter(self.CreateOutputWindow, text)
3494 self.CreateOutputWindow(text)
3496 if not wx.Thread_IsMain():
3497 wx.CallAfter(self.text.AppendText, text)
3499 self.text.AppendText(text)
3503 if self.frame is not None:
3504 wx.CallAfter(self.frame.Close)
3512 #----------------------------------------------------------------------
3514 _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__')
3516 class App(wx.PyApp):
3518 The ``wx.App`` class represents the application and is used to:
3520 * bootstrap the wxPython system and initialize the underlying
3522 * set and get application-wide properties
3523 * implement the windowing system main message or event loop,
3524 and to dispatch events to window instances
3527 Every application must have a ``wx.App`` instance, and all
3528 creation of UI objects should be delayed until after the
3529 ``wx.App`` object has been created in order to ensure that the gui
3530 platform and wxWidgets have been fully initialized.
3532 Normally you would derive from this class and implement an
3533 ``OnInit`` method that creates a frame and then calls
3534 ``self.SetTopWindow(frame)``.
3536 :see: `wx.PySimpleApp` for a simpler app class that can be used
3540 outputWindowClass = PyOnDemandOutputWindow
3542 def __init__(self, redirect=_defRedirect, filename=None,
3543 useBestVisual=False, clearSigInt=True):
3545 Construct a ``wx.App`` object.
3547 :param redirect: Should ``sys.stdout`` and ``sys.stderr`` be
3548 redirected? Defaults to True on Windows and Mac, False
3549 otherwise. If `filename` is None then output will be
3550 redirected to a window that pops up as needed. (You can
3551 control what kind of window is created for the output by
3552 resetting the class variable ``outputWindowClass`` to a
3553 class of your choosing.)
3555 :param filename: The name of a file to redirect output to, if
3558 :param useBestVisual: Should the app try to use the best
3559 available visual provided by the system (only relevant on
3560 systems that have more than one visual.) This parameter
3561 must be used instead of calling `SetUseBestVisual` later
3562 on because it must be set before the underlying GUI
3563 toolkit is initialized.
3565 :param clearSigInt: Should SIGINT be cleared? This allows the
3566 app to terminate upon a Ctrl-C in the console like other
3569 :note: You should override OnInit to do applicaition
3570 initialization to ensure that the system, toolkit and
3571 wxWidgets are fully initialized.
3573 wx.PyApp.__init__(self)
3575 if wx.Platform == "__WXMAC__":
3578 if not MacOS.WMAvailable():
3580 This program needs access to the screen. Please run with 'pythonw',
3581 not 'python', and only when you are logged in on the main display of
3589 # This has to be done before OnInit
3590 self.SetUseBestVisual(useBestVisual)
3592 # Set the default handler for SIGINT. This fixes a problem
3593 # where if Ctrl-C is pressed in the console that started this
3594 # app then it will not appear to do anything, (not even send
3595 # KeyboardInterrupt???) but will later segfault on exit. By
3596 # setting the default handler then the app will exit, as
3597 # expected (depending on platform.)
3601 signal.signal(signal.SIGINT, signal.SIG_DFL)
3605 # Save and redirect the stdio to a window?
3606 self.stdioWin = None
3607 self.saveStdio = (_sys.stdout, _sys.stderr)
3609 self.RedirectStdio(filename)
3611 # This finishes the initialization of wxWindows and then calls
3612 # the OnInit that should be present in the derived class
3613 self._BootstrapApp()
3618 self.RestoreStdio() # Just in case the MainLoop was overridden
3623 def SetTopWindow(self, frame):
3624 """Set the \\"main\\" top level window"""
3626 self.stdioWin.SetParent(frame)
3627 wx.PyApp.SetTopWindow(self, frame)
3631 """Execute the main GUI event loop"""
3632 wx.PyApp.MainLoop(self)
3636 def RedirectStdio(self, filename=None):
3637 """Redirect sys.stdout and sys.stderr to a file or a popup window."""
3639 _sys.stdout = _sys.stderr = open(filename, 'a')
3641 self.stdioWin = self.outputWindowClass()
3642 _sys.stdout = _sys.stderr = self.stdioWin
3645 def RestoreStdio(self):
3646 _sys.stdout, _sys.stderr = self.saveStdio
3649 def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
3651 Set the title, position and/or size of the output window if
3652 the stdio has been redirected. This should be called before
3653 any output would cause the output window to be created.
3656 if title is not None:
3657 self.stdioWin.title = title
3659 self.stdioWin.pos = pos
3660 if size is not None:
3661 self.stdioWin.size = size
3666 # change from wx.PyApp_XX to wx.App_XX
3667 App_GetMacSupportPCMenuShortcuts = _core_.PyApp_GetMacSupportPCMenuShortcuts
3668 App_GetMacAboutMenuItemId = _core_.PyApp_GetMacAboutMenuItemId
3669 App_GetMacPreferencesMenuItemId = _core_.PyApp_GetMacPreferencesMenuItemId
3670 App_GetMacExitMenuItemId = _core_.PyApp_GetMacExitMenuItemId
3671 App_GetMacHelpMenuTitleName = _core_.PyApp_GetMacHelpMenuTitleName
3672 App_SetMacSupportPCMenuShortcuts = _core_.PyApp_SetMacSupportPCMenuShortcuts
3673 App_SetMacAboutMenuItemId = _core_.PyApp_SetMacAboutMenuItemId
3674 App_SetMacPreferencesMenuItemId = _core_.PyApp_SetMacPreferencesMenuItemId
3675 App_SetMacExitMenuItemId = _core_.PyApp_SetMacExitMenuItemId
3676 App_SetMacHelpMenuTitleName = _core_.PyApp_SetMacHelpMenuTitleName
3677 App_GetComCtl32Version = _core_.PyApp_GetComCtl32Version
3679 #----------------------------------------------------------------------------
3681 class PySimpleApp(wx.App):
3683 A simple application class. You can just create one of these and
3684 then then make your top level windows later, and not have to worry
3685 about OnInit. For example::
3687 app = wx.PySimpleApp()
3688 frame = wx.Frame(None, title='Hello World')
3695 def __init__(self, redirect=False, filename=None,
3696 useBestVisual=False, clearSigInt=True):
3698 :see: `wx.App.__init__`
3700 wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt)
3707 # Is anybody using this one?
3708 class PyWidgetTester(wx.App):
3709 def __init__(self, size = (
250,
100)):
3711 wx.App.__init__(self,
0)
3714 self.frame = wx.Frame(None, -
1, "Widget Tester", pos=(
0,
0), size=self.size)
3715 self.SetTopWindow(self.frame)
3718 def SetWidget(self, widgetClass, *args, **kwargs):
3719 w = widgetClass(self.frame, *args, **kwargs)
3720 self.frame.Show(True)
3722 #----------------------------------------------------------------------------
3723 # DO NOT hold any other references to this object. This is how we
3724 # know when to cleanup system resources that wxWidgets is holding. When
3725 # the sys module is unloaded, the refcount on sys.__wxPythonCleanup
3726 # goes to zero and it calls the wx.App_CleanUp function.
3728 class __wxPyCleanup:
3730 self.cleanup = _core_.App_CleanUp
3734 _sys.__wxPythonCleanup = __wxPyCleanup()
3736 ## # another possible solution, but it gets called too early...
3738 ## atexit.register(_core_.wxApp_CleanUp)
3741 #----------------------------------------------------------------------------
3744 #---------------------------------------------------------------------------
3746 <class name=
"AcceleratorEntry" oldname=
"wxAcceleratorEntry" module=
"_core">
3747 <docstring>A class used to define items in an `wx.AcceleratorTable`. wxPython
3748 programs can choose to use wx.AcceleratorEntry objects, but using a
3749 list of
3-tuple of integers (flags, keyCode, cmdID) usually works just
3750 as well. See `__init__` for of the tuple values.
3752 :see: `wx.AcceleratorTable`
</docstring>
3753 <constructor name=
"AcceleratorEntry" overloaded=
"no">
3754 <autodoc>__init__(self, int flags=
0, int keyCode=
0, int cmdID=
0) -
> AcceleratorEntry
</autodoc>
3755 <docstring>Construct a wx.AcceleratorEntry.
3756 :param flags: A bitmask of wx.ACCEL_ALT, wx.ACCEL_SHIFT,
3757 wx.ACCEL_CTRL or wx.ACCEL_NORMAL used to specify
3758 which modifier keys are held down.
3759 :param keyCode: The keycode to be detected
3760 :param cmdID: The menu or control command ID to use for the
3764 <param name=
"flags" type=
"int" default=
"0"/>
3765 <param name=
"keyCode" type=
"int" default=
"0"/>
3766 <param name=
"cmdID" type=
"int" default=
"0"/>
3769 <destructor name=
"~wxAcceleratorEntry" overloaded=
"no">
3770 <autodoc>__del__(self)
</autodoc>
3772 <method name=
"Set" type=
"" overloaded=
"no">
3773 <autodoc>Set(self, int flags, int keyCode, int cmd)
</autodoc>
3774 <docstring>(Re)set the attributes of a wx.AcceleratorEntry.
3775 :see `__init__`
</docstring>
3777 <param name=
"flags" type=
"int" default=
""/>
3778 <param name=
"keyCode" type=
"int" default=
""/>
3779 <param name=
"cmd" type=
"int" default=
""/>
3782 <method name=
"GetFlags" type=
"int" overloaded=
"no">
3783 <autodoc>GetFlags(self) -
> int
</autodoc>
3784 <docstring>Get the AcceleratorEntry's flags.
</docstring>
3786 <method name=
"GetKeyCode" type=
"int" overloaded=
"no">
3787 <autodoc>GetKeyCode(self) -
> int
</autodoc>
3788 <docstring>Get the AcceleratorEntry's keycode.
</docstring>
3790 <method name=
"GetCommand" type=
"int" overloaded=
"no">
3791 <autodoc>GetCommand(self) -
> int
</autodoc>
3792 <docstring>Get the AcceleratorEntry's command ID.
</docstring>
3795 <class name=
"AcceleratorTable" oldname=
"wxAcceleratorTable" module=
"_core">
3796 <docstring>An accelerator table allows the application to specify a table of
3797 keyboard shortcuts for menus or other commands. On Windows, menu or
3798 button commands are supported; on GTK, only menu commands are
3801 The object ``wx.NullAcceleratorTable`` is defined to be a table with
3802 no data, and is the initial accelerator table for a window.
3804 An accelerator takes precedence over normal processing and can be a
3805 convenient way to program some event handling. For example, you can
3806 use an accelerator table to make a hotkey generate an event no matter
3807 which window within a frame has the focus.
3811 aTable = wx.AcceleratorTable([(wx.ACCEL_ALT, ord('X'), exitID),
3812 (wx.ACCEL_CTRL, ord('H'), helpID),
3813 (wx.ACCEL_CTRL, ord('F'), findID),
3814 (wx.ACCEL_NORMAL, wx.WXK_F3, findnextID)
3816 self.SetAcceleratorTable(aTable)
3819 :see: `wx.AcceleratorEntry`, `wx.Window.SetAcceleratorTable`
3821 <baseclass name=
"Object"/>
3822 <constructor name=
"AcceleratorTable" overloaded=
"no">
3823 <autodoc>__init__(entries) -
> AcceleratorTable
</autodoc>
3824 <docstring>Construct an AcceleratorTable from a list of `wx.AcceleratorEntry`
3825 items or or of
3-tuples (flags, keyCode, cmdID)
3827 :see: `wx.AcceleratorEntry`
</docstring>
3829 <param name=
"n" type=
"int" default=
""/>
3830 <param name=
"entries" type=
"AcceleratorEntry" default=
""/>
3833 <destructor name=
"~wxAcceleratorTable" overloaded=
"no">
3834 <autodoc>__del__(self)
</autodoc>
3836 <method name=
"Ok" type=
"bool" overloaded=
"no">
3837 <autodoc>Ok(self) -
> bool
</autodoc>
3840 <method name=
"GetAccelFromString" oldname=
"wxGetAccelFromString" type=
"AcceleratorEntry" overloaded=
"no">
3841 <autodoc>GetAccelFromString(String label) -
> AcceleratorEntry
</autodoc>
3843 <param name=
"label" type=
"String" default=
""/>
3847 #---------------------------------------------------------------------------
3849 <class name=
"VisualAttributes" oldname=
"wxVisualAttributes" module=
"_core">
3850 <docstring>struct containing all the visual attributes of a control
</docstring>
3851 <constructor name=
"VisualAttributes" overloaded=
"no">
3852 <autodoc>__init__(self) -
> VisualAttributes
</autodoc>
3853 <docstring>struct containing all the visual attributes of a control
</docstring>
3855 <destructor name=
"~wxVisualAttributes" overloaded=
"no">
3856 <autodoc>__del__(self)
</autodoc>
3858 <property name=
"font" type=
"wxFont" readonly=
"no"/>
3859 <property name=
"colFg" type=
"wxColour" readonly=
"no"/>
3860 <property name=
"colBg" type=
"wxColour" readonly=
"no"/>
3862 <class name=
"Window" oldname=
"wxWindow" module=
"_core">
3863 <docstring>wx.Window is the base class for all windows and represents any visible
3864 object on the screen. All controls, top level windows and so on are
3865 wx.Windows. Sizers and device contexts are not however, as they don't
3866 appear on screen themselves.
3870 ============================= =====================================
3871 wx.SIMPLE_BORDER Displays a thin border around the window.
3873 wx.DOUBLE_BORDER Displays a double border. Windows and Mac only.
3875 wx.SUNKEN_BORDER Displays a sunken border.
3877 wx.RAISED_BORDER Displays a raised border.
3879 wx.STATIC_BORDER Displays a border suitable for a static
3880 control. Windows only.
3882 wx.NO_BORDER Displays no border, overriding the default
3883 border style for the window.
3885 wx.TRANSPARENT_WINDOW The window is transparent, that is, it
3886 will not receive paint events. Windows only.
3888 wx.TAB_TRAVERSAL Use this to enable tab traversal for
3891 wx.WANTS_CHARS Use this to indicate that the window
3892 wants to get all char/key events for
3893 all keys - even for keys like TAB or
3894 ENTER which are usually used for
3895 dialog navigation and which wouldn't
3896 be generated without this style. If
3897 you need to use this style in order to
3898 get the arrows or etc., but would
3899 still like to have normal keyboard
3900 navigation take place, you should
3901 create and send a wxNavigationKeyEvent
3902 in response to the key events for Tab
3905 wx.NO_FULL_REPAINT_ON_RESIZE Disables repainting the window
3906 completely when its size is changed.
3907 You will have to repaint the new
3908 window area manually if you use this
3909 style. As of version
2.5.1 this
3910 style is on by default. Use
3911 wx.FULL_REPAINT_ON_RESIZE to
3914 wx.VSCROLL Use this style to enable a vertical scrollbar.
3916 wx.HSCROLL Use this style to enable a horizontal scrollbar.
3918 wx.ALWAYS_SHOW_SB If a window has scrollbars, disable them
3919 instead of hiding them when they are
3920 not needed (i.e. when the size of the
3921 window is big enough to not require
3922 the scrollbars to navigate it). This
3923 style is currently only implemented
3924 for wxMSW and wxUniversal and does
3925 nothing on the other platforms.
3927 wx.CLIP_CHILDREN Use this style to eliminate flicker caused by
3928 the background being repainted, then
3929 children being painted over
3932 wx.FULL_REPAINT_ON_RESIZE Use this style to force a complete
3933 redraw of the window whenever it is
3934 resized instead of redrawing just the
3935 part of the window affected by
3936 resizing. Note that this was the
3937 behaviour by default before
2.5.1
3938 release and that if you experience
3939 redraw problems with the code which
3940 previously used to work you may want
3942 ============================= =====================================
3947 ============================= =====================================
3948 wx.WS_EX_VALIDATE_RECURSIVELY By default,
3949 Validate/TransferDataTo/FromWindow()
3950 only work on direct children of
3951 the window (compatible
3952 behaviour). Set this flag to make
3953 them recursively descend into all
3956 wx.WS_EX_BLOCK_EVENTS wx.CommandEvents and the objects of the
3957 derived classes are forwarded to
3958 the parent window and so on
3959 recursively by default. Using this
3960 flag for the given window allows
3961 to block this propagation at this
3962 window, i.e. prevent the events
3963 from being propagated further
3964 upwards. Dialogs have this flag on
3967 wx.WS_EX_TRANSIENT Don't use this window as an implicit parent for
3968 the other windows: this must be
3969 used with transient windows as
3970 otherwise there is the risk of
3971 creating a dialog/frame with this
3972 window as a parent which would
3973 lead to a crash if the parent is
3974 destroyed before the child.
3976 wx.WS_EX_PROCESS_IDLE This window should always process idle
3977 events, even if the mode set by
3978 wx.IdleEvent.SetMode is
3979 wx.IDLE_PROCESS_SPECIFIED.
3981 wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
3982 update events, even if the mode
3983 set by wxUpdateUIEvent::SetMode is
3984 wxUPDATE_UI_PROCESS_SPECIFIED.
3985 ============================= =====================================
3988 <baseclass name=
"EvtHandler"/>
3989 <constructor name=
"Window" overloaded=
"no">
3990 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
3991 Size size=DefaultSize, long style=
0, String name=PanelNameStr) -
> Window
</autodoc>
3992 <docstring>Construct and show a generic Window.
</docstring>
3994 <param name=
"parent" type=
"Window" default=
""/>
3995 <param name=
"id" type=
"int" default=
"-1"/>
3996 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
3997 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
3998 <param name=
"style" type=
"long" default=
"0"/>
3999 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
4002 <constructor name=
"PreWindow" overloaded=
"no">
4003 <autodoc>PreWindow() -
> Window
</autodoc>
4004 <docstring>Precreate a Window for
2-phase creation.
</docstring>
4006 <method name=
"Create" type=
"bool" overloaded=
"no">
4007 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
4008 Size size=DefaultSize, long style=
0, String name=PanelNameStr) -
> bool
</autodoc>
4009 <docstring>Create the GUI part of the Window for
2-phase creation mode.
</docstring>
4011 <param name=
"parent" type=
"Window" default=
""/>
4012 <param name=
"id" type=
"int" default=
"-1"/>
4013 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
4014 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
4015 <param name=
"style" type=
"long" default=
"0"/>
4016 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
4019 <method name=
"Close" type=
"bool" overloaded=
"no">
4020 <autodoc>Close(self, bool force=False) -
> bool
</autodoc>
4021 <docstring>This function simply generates a EVT_CLOSE event whose handler usually
4022 tries to close the window. It doesn't close the window itself,
4023 however. If force is False (the default) then the window's close
4024 handler will be allowed to veto the destruction of the window.
4025 Usually Close is only used with the top level windows (wx.Frame and
4026 wx.Dialog classes) as the others are not supposed to have any special
4029 The close handler should check whether the window is being deleted
4030 forcibly, using wx.CloseEvent.GetForce, in which case it should
4031 destroy the window using wx.Window.Destroy.
4033 Note that calling Close does not guarantee that the window will be
4034 destroyed; but it provides a way to simulate a manual close of a
4035 window, which may or may not be implemented by destroying the
4036 window. The default EVT_CLOSE handler for wx.Dialog does not
4037 necessarily delete the dialog, since it will simply simulate an
4038 wxID_CANCEL event which is handled by the appropriate button event
4039 handler and may do anything at all.
4041 To guarantee that the window will be destroyed, call wx.Window.Destroy
4042 instead.
</docstring>
4044 <param name=
"force" type=
"bool" default=
"False"/>
4047 <method name=
"Destroy" type=
"bool" overloaded=
"no">
4048 <autodoc>Destroy(self) -
> bool
</autodoc>
4049 <docstring>Destroys the window safely. Frames and dialogs are not destroyed
4050 immediately when this function is called -- they are added to a list
4051 of windows to be deleted on idle time, when all the window's events
4052 have been processed. This prevents problems with events being sent to
4053 non-existent windows.
4055 Returns True if the window has either been successfully deleted, or it
4056 has been added to the list of windows pending real deletion.
</docstring>
4058 <method name=
"DestroyChildren" type=
"bool" overloaded=
"no">
4059 <autodoc>DestroyChildren(self) -
> bool
</autodoc>
4060 <docstring>Destroys all children of a window. Called automatically by the
4061 destructor.
</docstring>
4063 <method name=
"IsBeingDeleted" type=
"bool" overloaded=
"no">
4064 <autodoc>IsBeingDeleted(self) -
> bool
</autodoc>
4065 <docstring>Is the window in the process of being deleted?
</docstring>
4067 <method name=
"SetTitle" type=
"" overloaded=
"no">
4068 <autodoc>SetTitle(self, String title)
</autodoc>
4069 <docstring>Sets the window's title. Applicable only to frames and dialogs.
</docstring>
4071 <param name=
"title" type=
"String" default=
""/>
4074 <method name=
"GetTitle" type=
"String" overloaded=
"no">
4075 <autodoc>GetTitle(self) -
> String
</autodoc>
4076 <docstring>Gets the window's title. Applicable only to frames and dialogs.
</docstring>
4078 <method name=
"SetLabel" type=
"" overloaded=
"no">
4079 <autodoc>SetLabel(self, String label)
</autodoc>
4080 <docstring>Set the text which the window shows in its label if applicable.
</docstring>
4082 <param name=
"label" type=
"String" default=
""/>
4085 <method name=
"GetLabel" type=
"String" overloaded=
"no">
4086 <autodoc>GetLabel(self) -
> String
</autodoc>
4087 <docstring>Generic way of getting a label from any window, for identification
4088 purposes. The interpretation of this function differs from class to
4089 class. For frames and dialogs, the value returned is the title. For
4090 buttons or static text controls, it is the button text. This function
4091 can be useful for meta-programs such as testing tools or special-needs
4092 access programs)which need to identify windows by name.
</docstring>
4094 <method name=
"SetName" type=
"" overloaded=
"no">
4095 <autodoc>SetName(self, String name)
</autodoc>
4096 <docstring>Sets the window's name. The window name is used for ressource setting
4097 in X, it is not the same as the window title/label
</docstring>
4099 <param name=
"name" type=
"String" default=
""/>
4102 <method name=
"GetName" type=
"String" overloaded=
"no">
4103 <autodoc>GetName(self) -
> String
</autodoc>
4104 <docstring>Returns the windows name. This name is not guaranteed to be unique;
4105 it is up to the programmer to supply an appropriate name in the window
4106 constructor or via wx.Window.SetName.
</docstring>
4108 <method name=
"SetWindowVariant" type=
"" overloaded=
"no">
4109 <autodoc>SetWindowVariant(self, int variant)
</autodoc>
4110 <docstring>Sets the variant of the window/font size to use for this window, if
4111 the platform supports variants, for example, wxMac.
4114 ======================== =======================================
4115 wx.WINDOW_VARIANT_NORMAL Normal size
4116 wx.WINDOW_VARIANT_SMALL Smaller size (about
25 % smaller than normal)
4117 wx.WINDOW_VARIANT_MINI Mini size (about
33 % smaller than normal)
4118 wx.WINDOW_VARIANT_LARGE Large size (about
25 % larger than normal)
4119 ======================== =======================================
4122 <param name=
"variant" type=
"wxWindowVariant" default=
""/>
4125 <method name=
"GetWindowVariant" type=
"wxWindowVariant" overloaded=
"no">
4126 <autodoc>GetWindowVariant(self) -
> int
</autodoc>
4128 <method name=
"SetId" type=
"" overloaded=
"no">
4129 <autodoc>SetId(self, int winid)
</autodoc>
4130 <docstring>Sets the identifier of the window. Each window has an integer
4131 identifier. If the application has not provided one, an identifier
4132 will be generated. Normally, the identifier should be provided on
4133 creation and should not be modified subsequently.
</docstring>
4135 <param name=
"winid" type=
"int" default=
""/>
4138 <method name=
"GetId" type=
"int" overloaded=
"no">
4139 <autodoc>GetId(self) -
> int
</autodoc>
4140 <docstring>Returns the identifier of the window. Each window has an integer
4141 identifier. If the application has not provided one (or the default Id
4142 -
1 is used) then an unique identifier with a negative value will be
4143 generated.
</docstring>
4145 <staticmethod name=
"NewControlId" type=
"int" overloaded=
"no">
4146 <autodoc>NewControlId() -
> int
</autodoc>
4147 <docstring>Generate a control id for the controls which were not given one.
</docstring>
4149 <staticmethod name=
"NextControlId" type=
"int" overloaded=
"no">
4150 <autodoc>NextControlId(int winid) -
> int
</autodoc>
4151 <docstring>Get the id of the control following the one with the given
4152 autogenerated) id
</docstring>
4154 <param name=
"winid" type=
"int" default=
""/>
4157 <staticmethod name=
"PrevControlId" type=
"int" overloaded=
"no">
4158 <autodoc>PrevControlId(int winid) -
> int
</autodoc>
4159 <docstring>Get the id of the control preceding the one with the given
4160 autogenerated) id
</docstring>
4162 <param name=
"winid" type=
"int" default=
""/>
4165 <method name=
"SetSize" type=
"" overloaded=
"no">
4166 <autodoc>SetSize(self, Size size)
</autodoc>
4167 <docstring>Sets the size of the window in pixels.
</docstring>
4169 <param name=
"size" type=
"Size" default=
""/>
4172 <method name=
"SetDimensions" type=
"" overloaded=
"no">
4173 <autodoc>SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
</autodoc>
4174 <docstring>Sets the position and size of the window in pixels. The sizeFlags
4175 parameter indicates the interpretation of the other params if they are
4176 -
1. wx.SIZE_AUTO*: a -
1 indicates that a class-specific default
4177 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
4178 used if -
1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
4179 dimensions of -
1 and less to be interpreted as real dimensions, not
4180 default values.
</docstring>
4182 <param name=
"x" type=
"int" default=
""/>
4183 <param name=
"y" type=
"int" default=
""/>
4184 <param name=
"width" type=
"int" default=
""/>
4185 <param name=
"height" type=
"int" default=
""/>
4186 <param name=
"sizeFlags" type=
"int" default=
"wxSIZE_AUTO"/>
4189 <method name=
"SetRect" type=
"" overloaded=
"no">
4190 <autodoc>SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
</autodoc>
4191 <docstring>Sets the position and size of the window in pixels using a wx.Rect.
</docstring>
4193 <param name=
"rect" type=
"Rect" default=
""/>
4194 <param name=
"sizeFlags" type=
"int" default=
"wxSIZE_AUTO"/>
4197 <method name=
"SetSizeWH" type=
"" overloaded=
"no">
4198 <autodoc>SetSizeWH(self, int width, int height)
</autodoc>
4199 <docstring>Sets the size of the window in pixels.
</docstring>
4201 <param name=
"width" type=
"int" default=
""/>
4202 <param name=
"height" type=
"int" default=
""/>
4205 <method name=
"Move" type=
"" overloaded=
"no">
4206 <autodoc>Move(self, Point pt, int flags=SIZE_USE_EXISTING)
</autodoc>
4207 <docstring>Moves the window to the given position.
</docstring>
4209 <param name=
"pt" type=
"Point" default=
""/>
4210 <param name=
"flags" type=
"int" default=
"wxSIZE_USE_EXISTING"/>
4213 <method name=
"MoveXY" type=
"" overloaded=
"no">
4214 <autodoc>MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
</autodoc>
4215 <docstring>Moves the window to the given position.
</docstring>
4217 <param name=
"x" type=
"int" default=
""/>
4218 <param name=
"y" type=
"int" default=
""/>
4219 <param name=
"flags" type=
"int" default=
"wxSIZE_USE_EXISTING"/>
4222 <method name=
"SetBestFittingSize" type=
"" overloaded=
"no">
4223 <autodoc>SetBestFittingSize(self, Size size=DefaultSize)
</autodoc>
4224 <docstring>A 'Smart' SetSize that will fill in default size components with the
4225 window's *best size* values. Also set's the minsize for use with sizers.
</docstring>
4227 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
4230 <method name=
"Raise" type=
"" overloaded=
"no">
4231 <autodoc>Raise(self)
</autodoc>
4232 <docstring>Raises the window to the top of the window hierarchy if it is a
4233 managed window (dialog or frame).
</docstring>
4235 <method name=
"Lower" type=
"" overloaded=
"no">
4236 <autodoc>Lower(self)
</autodoc>
4237 <docstring>Lowers the window to the bottom of the window hierarchy if it is a
4238 managed window (dialog or frame).
</docstring>
4240 <method name=
"SetClientSize" type=
"" overloaded=
"no">
4241 <autodoc>SetClientSize(self, Size size)
</autodoc>
4242 <docstring>This sets the size of the window client area in pixels. Using this
4243 function to size a window tends to be more device-independent than
4244 wx.Window.SetSize, since the application need not worry about what
4245 dimensions the border or title bar have when trying to fit the window
4246 around panel items, for example.
</docstring>
4248 <param name=
"size" type=
"Size" default=
""/>
4251 <method name=
"SetClientSizeWH" type=
"" overloaded=
"no">
4252 <autodoc>SetClientSizeWH(self, int width, int height)
</autodoc>
4253 <docstring>This sets the size of the window client area in pixels. Using this
4254 function to size a window tends to be more device-independent than
4255 wx.Window.SetSize, since the application need not worry about what
4256 dimensions the border or title bar have when trying to fit the window
4257 around panel items, for example.
</docstring>
4259 <param name=
"width" type=
"int" default=
""/>
4260 <param name=
"height" type=
"int" default=
""/>
4263 <method name=
"SetClientRect" type=
"" overloaded=
"no">
4264 <autodoc>SetClientRect(self, Rect rect)
</autodoc>
4265 <docstring>This sets the size of the window client area in pixels. Using this
4266 function to size a window tends to be more device-independent than
4267 wx.Window.SetSize, since the application need not worry about what
4268 dimensions the border or title bar have when trying to fit the window
4269 around panel items, for example.
</docstring>
4271 <param name=
"rect" type=
"Rect" default=
""/>
4274 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
4275 <autodoc>GetPosition(self) -
> Point
</autodoc>
4276 <docstring>Get the window's position.
</docstring>
4278 <method name=
"GetPositionTuple" type=
"" overloaded=
"no">
4279 <autodoc>GetPositionTuple() -
> (x,y)
</autodoc>
4280 <docstring>Get the window's position.
</docstring>
4282 <param name=
"OUTPUT" type=
"int" default=
""/>
4283 <param name=
"OUTPUT" type=
"int" default=
""/>
4286 <method name=
"GetSize" type=
"Size" overloaded=
"no">
4287 <autodoc>GetSize(self) -
> Size
</autodoc>
4288 <docstring>Get the window size.
</docstring>
4290 <method name=
"GetSizeTuple" type=
"" overloaded=
"no">
4291 <autodoc>GetSizeTuple() -
> (width, height)
</autodoc>
4292 <docstring>Get the window size.
</docstring>
4294 <param name=
"OUTPUT" type=
"int" default=
""/>
4295 <param name=
"OUTPUT" type=
"int" default=
""/>
4298 <method name=
"GetRect" type=
"Rect" overloaded=
"no">
4299 <autodoc>GetRect(self) -
> Rect
</autodoc>
4300 <docstring>Returns the size and position of the window as a wx.Rect object.
</docstring>
4302 <method name=
"GetClientSize" type=
"Size" overloaded=
"no">
4303 <autodoc>GetClientSize(self) -
> Size
</autodoc>
4304 <docstring>This gets the size of the window's 'client area' in pixels. The client
4305 area is the area which may be drawn on by the programmer, excluding
4306 title bar, border, scrollbars, etc.
</docstring>
4308 <method name=
"GetClientSizeTuple" type=
"" overloaded=
"no">
4309 <autodoc>GetClientSizeTuple() -
> (width, height)
</autodoc>
4310 <docstring>This gets the size of the window's 'client area' in pixels. The client
4311 area is the area which may be drawn on by the programmer, excluding
4312 title bar, border, scrollbars, etc.
</docstring>
4314 <param name=
"OUTPUT" type=
"int" default=
""/>
4315 <param name=
"OUTPUT" type=
"int" default=
""/>
4318 <method name=
"GetClientAreaOrigin" type=
"Point" overloaded=
"no">
4319 <autodoc>GetClientAreaOrigin(self) -
> Point
</autodoc>
4320 <docstring>Get the origin of the client area of the window relative to the
4321 window's top left corner (the client area may be shifted because of
4322 the borders, scrollbars, other decorations...)
</docstring>
4324 <method name=
"GetClientRect" type=
"Rect" overloaded=
"no">
4325 <autodoc>GetClientRect(self) -
> Rect
</autodoc>
4326 <docstring>Get the client area position and size as a `wx.Rect` object.
</docstring>
4328 <method name=
"GetBestSize" type=
"Size" overloaded=
"no">
4329 <autodoc>GetBestSize(self) -
> Size
</autodoc>
4330 <docstring>This function returns the best acceptable minimal size for the
4331 window, if applicable. For example, for a static text control, it will
4332 be the minimal size such that the control label is not truncated. For
4333 windows containing subwindows (suzh aswx.Panel), the size returned by
4334 this function will be the same as the size the window would have had
4335 after calling Fit.
</docstring>
4337 <method name=
"GetBestSizeTuple" type=
"" overloaded=
"no">
4338 <autodoc>GetBestSizeTuple() -
> (width, height)
</autodoc>
4339 <docstring>This function returns the best acceptable minimal size for the
4340 window, if applicable. For example, for a static text control, it will
4341 be the minimal size such that the control label is not truncated. For
4342 windows containing subwindows (suzh aswx.Panel), the size returned by
4343 this function will be the same as the size the window would have had
4344 after calling Fit.
</docstring>
4346 <param name=
"OUTPUT" type=
"int" default=
""/>
4347 <param name=
"OUTPUT" type=
"int" default=
""/>
4350 <method name=
"InvalidateBestSize" type=
"" overloaded=
"no">
4351 <autodoc>InvalidateBestSize(self)
</autodoc>
4352 <docstring>Reset the cached best size value so it will be recalculated the next
4353 time it is needed.
</docstring>
4355 <method name=
"GetBestFittingSize" type=
"Size" overloaded=
"no">
4356 <autodoc>GetBestFittingSize(self) -
> Size
</autodoc>
4357 <docstring>This function will merge the window's best size into the window's
4358 minimum size, giving priority to the min size components, and returns
4362 <method name=
"GetAdjustedBestSize" type=
"Size" overloaded=
"no">
4363 <autodoc>GetAdjustedBestSize(self) -
> Size
</autodoc>
4364 <docstring>This method is similar to GetBestSize, except in one
4365 thing. GetBestSize should return the minimum untruncated size of the
4366 window, while this method will return the largest of BestSize and any
4367 user specified minimum size. ie. it is the minimum size the window
4368 should currently be drawn at, not the minimal size it can possibly
4369 tolerate.
</docstring>
4371 <method name=
"Center" type=
"" overloaded=
"no">
4372 <autodoc>Center(self, int direction=BOTH)
</autodoc>
4373 <docstring>Centers the window. The parameter specifies the direction for
4374 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
4375 also include wx.CENTER_ON_SCREEN flag if you want to center the window
4376 on the entire screen and not on its parent window. If it is a
4377 top-level window and has no parent then it will always be centered
4378 relative to the screen.
</docstring>
4380 <param name=
"direction" type=
"int" default=
"wxBOTH"/>
4383 <method name=
"CenterOnScreen" type=
"" overloaded=
"no">
4384 <autodoc>CenterOnScreen(self, int dir=BOTH)
</autodoc>
4385 <docstring>Center on screen (only works for top level windows)
</docstring>
4387 <param name=
"dir" type=
"int" default=
"wxBOTH"/>
4390 <method name=
"CenterOnParent" type=
"" overloaded=
"no">
4391 <autodoc>CenterOnParent(self, int dir=BOTH)
</autodoc>
4392 <docstring>Center with respect to the the parent window
</docstring>
4394 <param name=
"dir" type=
"int" default=
"wxBOTH"/>
4397 <method name=
"Fit" type=
"" overloaded=
"no">
4398 <autodoc>Fit(self)
</autodoc>
4399 <docstring>Sizes the window so that it fits around its subwindows. This function
4400 won't do anything if there are no subwindows and will only really work
4401 correctly if sizers are used for the subwindows layout. Also, if the
4402 window has exactly one subwindow it is better (faster and the result
4403 is more precise as Fit adds some margin to account for fuzziness of
4404 its calculations) to call window.SetClientSize(child.GetSize())
4405 instead of calling Fit.
</docstring>
4407 <method name=
"FitInside" type=
"" overloaded=
"no">
4408 <autodoc>FitInside(self)
</autodoc>
4409 <docstring>Similar to Fit, but sizes the interior (virtual) size of a
4410 window. Mainly useful with scrolled windows to reset scrollbars after
4411 sizing changes that do not trigger a size event, and/or scrolled
4412 windows without an interior sizer. This function similarly won't do
4413 anything if there are no subwindows.
</docstring>
4415 <method name=
"SetSizeHints" type=
"" overloaded=
"no">
4416 <autodoc>SetSizeHints(self, int minW, int minH, int maxW=-
1, int maxH=-
1, int incW=-
1,
4417 int incH=-
1)
</autodoc>
4418 <docstring>Allows specification of minimum and maximum window sizes, and window
4419 size increments. If a pair of values is not set (or set to -
1), the
4420 default values will be used. If this function is called, the user
4421 will not be able to size the window outside the given bounds (if it is
4422 a top-level window.) Sizers will also inspect the minimum window size
4423 and will use that value if set when calculating layout.
4425 The resizing increments are only significant under Motif or Xt.
4427 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
4430 <param name=
"minW" type=
"int" default=
""/>
4431 <param name=
"minH" type=
"int" default=
""/>
4432 <param name=
"maxW" type=
"int" default=
"-1"/>
4433 <param name=
"maxH" type=
"int" default=
"-1"/>
4434 <param name=
"incW" type=
"int" default=
"-1"/>
4435 <param name=
"incH" type=
"int" default=
"-1"/>
4438 <method name=
"SetSizeHintsSz" type=
"" overloaded=
"no">
4439 <autodoc>SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
</autodoc>
4440 <docstring>Allows specification of minimum and maximum window sizes, and window
4441 size increments. If a pair of values is not set (or set to -
1), the
4442 default values will be used. If this function is called, the user
4443 will not be able to size the window outside the given bounds (if it is
4444 a top-level window.) Sizers will also inspect the minimum window size
4445 and will use that value if set when calculating layout.
4447 The resizing increments are only significant under Motif or Xt.
4449 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
4452 <param name=
"minSize" type=
"Size" default=
""/>
4453 <param name=
"maxSize" type=
"Size" default=
"wxDefaultSize"/>
4454 <param name=
"incSize" type=
"Size" default=
"wxDefaultSize"/>
4457 <method name=
"SetVirtualSizeHints" type=
"" overloaded=
"no">
4458 <autodoc>SetVirtualSizeHints(self, int minW, int minH, int maxW=-
1, int maxH=-
1)
</autodoc>
4459 <docstring>Allows specification of minimum and maximum virtual window sizes. If a
4460 pair of values is not set (or set to -
1), the default values will be
4461 used. If this function is called, the user will not be able to size
4462 the virtual area of the window outside the given bounds.
</docstring>
4464 <param name=
"minW" type=
"int" default=
""/>
4465 <param name=
"minH" type=
"int" default=
""/>
4466 <param name=
"maxW" type=
"int" default=
"-1"/>
4467 <param name=
"maxH" type=
"int" default=
"-1"/>
4470 <method name=
"SetVirtualSizeHintsSz" type=
"" overloaded=
"no">
4471 <autodoc>SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
</autodoc>
4472 <docstring>Allows specification of minimum and maximum virtual window sizes. If a
4473 pair of values is not set (or set to -
1), the default values will be
4474 used. If this function is called, the user will not be able to size
4475 the virtual area of the window outside the given bounds.
</docstring>
4477 <param name=
"minSize" type=
"Size" default=
""/>
4478 <param name=
"maxSize" type=
"Size" default=
"wxDefaultSize"/>
4481 <method name=
"GetMaxSize" type=
"Size" overloaded=
"no">
4482 <autodoc>GetMaxSize(self) -
> Size
</autodoc>
4484 <method name=
"GetMinSize" type=
"Size" overloaded=
"no">
4485 <autodoc>GetMinSize(self) -
> Size
</autodoc>
4487 <method name=
"SetMinSize" type=
"" overloaded=
"no">
4488 <autodoc>SetMinSize(self, Size minSize)
</autodoc>
4489 <docstring>A more convenient method than `SetSizeHints` for setting just the
4490 min size.
</docstring>
4492 <param name=
"minSize" type=
"Size" default=
""/>
4495 <method name=
"SetMaxSize" type=
"" overloaded=
"no">
4496 <autodoc>SetMaxSize(self, Size maxSize)
</autodoc>
4497 <docstring>A more convenient method than `SetSizeHints` for setting just the
4498 max size.
</docstring>
4500 <param name=
"maxSize" type=
"Size" default=
""/>
4503 <method name=
"GetMinWidth" type=
"int" overloaded=
"no">
4504 <autodoc>GetMinWidth(self) -
> int
</autodoc>
4506 <method name=
"GetMinHeight" type=
"int" overloaded=
"no">
4507 <autodoc>GetMinHeight(self) -
> int
</autodoc>
4509 <method name=
"GetMaxWidth" type=
"int" overloaded=
"no">
4510 <autodoc>GetMaxWidth(self) -
> int
</autodoc>
4512 <method name=
"GetMaxHeight" type=
"int" overloaded=
"no">
4513 <autodoc>GetMaxHeight(self) -
> int
</autodoc>
4515 <method name=
"SetVirtualSize" type=
"" overloaded=
"no">
4516 <autodoc>SetVirtualSize(self, Size size)
</autodoc>
4517 <docstring>Set the the virtual size of a window in pixels. For most windows this
4518 is just the client area of the window, but for some like scrolled
4519 windows it is more or less independent of the screen window size.
</docstring>
4521 <param name=
"size" type=
"Size" default=
""/>
4524 <method name=
"SetVirtualSizeWH" type=
"" overloaded=
"no">
4525 <autodoc>SetVirtualSizeWH(self, int w, int h)
</autodoc>
4526 <docstring>Set the the virtual size of a window in pixels. For most windows this
4527 is just the client area of the window, but for some like scrolled
4528 windows it is more or less independent of the screen window size.
</docstring>
4530 <param name=
"w" type=
"int" default=
""/>
4531 <param name=
"h" type=
"int" default=
""/>
4534 <method name=
"GetVirtualSize" type=
"Size" overloaded=
"no">
4535 <autodoc>GetVirtualSize(self) -
> Size
</autodoc>
4536 <docstring>Get the the virtual size of the window in pixels. For most windows
4537 this is just the client area of the window, but for some like scrolled
4538 windows it is more or less independent of the screen window size.
</docstring>
4540 <method name=
"GetVirtualSizeTuple" type=
"" overloaded=
"no">
4541 <autodoc>GetVirtualSizeTuple() -
> (width, height)
</autodoc>
4542 <docstring>Get the the virtual size of the window in pixels. For most windows
4543 this is just the client area of the window, but for some like scrolled
4544 windows it is more or less independent of the screen window size.
</docstring>
4546 <param name=
"OUTPUT" type=
"int" default=
""/>
4547 <param name=
"OUTPUT" type=
"int" default=
""/>
4550 <method name=
"GetBestVirtualSize" type=
"Size" overloaded=
"no">
4551 <autodoc>GetBestVirtualSize(self) -
> Size
</autodoc>
4552 <docstring>Return the largest of ClientSize and BestSize (as determined by a
4553 sizer, interior children, or other means)
</docstring>
4555 <method name=
"Show" type=
"bool" overloaded=
"no">
4556 <autodoc>Show(self, bool show=True) -
> bool
</autodoc>
4557 <docstring>Shows or hides the window. You may need to call Raise for a top level
4558 window if you want to bring it to top, although this is not needed if
4559 Show is called immediately after the frame creation. Returns True if
4560 the window has been shown or hidden or False if nothing was done
4561 because it already was in the requested state.
</docstring>
4563 <param name=
"show" type=
"bool" default=
"True"/>
4566 <method name=
"Hide" type=
"bool" overloaded=
"no">
4567 <autodoc>Hide(self) -
> bool
</autodoc>
4568 <docstring>Equivalent to calling Show(False).
</docstring>
4570 <method name=
"Enable" type=
"bool" overloaded=
"no">
4571 <autodoc>Enable(self, bool enable=True) -
> bool
</autodoc>
4572 <docstring>Enable or disable the window for user input. Note that when a parent
4573 window is disabled, all of its children are disabled as well and they
4574 are reenabled again when the parent is. Returns true if the window
4575 has been enabled or disabled, false if nothing was done, i.e. if the
4576 window had already been in the specified state.
</docstring>
4578 <param name=
"enable" type=
"bool" default=
"True"/>
4581 <method name=
"Disable" type=
"bool" overloaded=
"no">
4582 <autodoc>Disable(self) -
> bool
</autodoc>
4583 <docstring>Disables the window, same as Enable(false).
</docstring>
4585 <method name=
"IsShown" type=
"bool" overloaded=
"no">
4586 <autodoc>IsShown(self) -
> bool
</autodoc>
4587 <docstring>Returns true if the window is shown, false if it has been hidden.
</docstring>
4589 <method name=
"IsEnabled" type=
"bool" overloaded=
"no">
4590 <autodoc>IsEnabled(self) -
> bool
</autodoc>
4591 <docstring>Returns true if the window is enabled for input, false otherwise.
</docstring>
4593 <method name=
"SetWindowStyleFlag" type=
"" overloaded=
"no">
4594 <autodoc>SetWindowStyleFlag(self, long style)
</autodoc>
4595 <docstring>Sets the style of the window. Please note that some styles cannot be
4596 changed after the window creation and that Refresh() might need to be
4597 called after changing the others for the change to take place
4598 immediately.
</docstring>
4600 <param name=
"style" type=
"long" default=
""/>
4603 <method name=
"GetWindowStyleFlag" type=
"long" overloaded=
"no">
4604 <autodoc>GetWindowStyleFlag(self) -
> long
</autodoc>
4605 <docstring>Gets the window style that was passed to the constructor or Create
4608 <method name=
"HasFlag" type=
"bool" overloaded=
"no">
4609 <autodoc>HasFlag(self, int flag) -
> bool
</autodoc>
4610 <docstring>Test if the given style is set for this window.
</docstring>
4612 <param name=
"flag" type=
"int" default=
""/>
4615 <method name=
"IsRetained" type=
"bool" overloaded=
"no">
4616 <autodoc>IsRetained(self) -
> bool
</autodoc>
4617 <docstring>Returns true if the window is retained, false otherwise. Retained
4618 windows are only available on X platforms.
</docstring>
4620 <method name=
"SetExtraStyle" type=
"" overloaded=
"no">
4621 <autodoc>SetExtraStyle(self, long exStyle)
</autodoc>
4622 <docstring>Sets the extra style bits for the window. Extra styles are the less
4623 often used style bits which can't be set with the constructor or with
4624 SetWindowStyleFlag()
</docstring>
4626 <param name=
"exStyle" type=
"long" default=
""/>
4629 <method name=
"GetExtraStyle" type=
"long" overloaded=
"no">
4630 <autodoc>GetExtraStyle(self) -
> long
</autodoc>
4631 <docstring>Returns the extra style bits for the window.
</docstring>
4633 <method name=
"MakeModal" type=
"" overloaded=
"no">
4634 <autodoc>MakeModal(self, bool modal=True)
</autodoc>
4635 <docstring>Disables all other windows in the application so that the user can
4636 only interact with this window. Passing False will reverse this
4639 <param name=
"modal" type=
"bool" default=
"True"/>
4642 <method name=
"SetThemeEnabled" type=
"" overloaded=
"no">
4643 <autodoc>SetThemeEnabled(self, bool enableTheme)
</autodoc>
4644 <docstring>This function tells a window if it should use the system's "theme"
4645 code to draw the windows' background instead if its own background
4646 drawing code. This will only have an effect on platforms that support
4647 the notion of themes in user defined windows. One such platform is
4648 GTK+ where windows can have (very colourful) backgrounds defined by a
4649 user's selected theme.
4651 Dialogs, notebook pages and the status bar have this flag set to true
4652 by default so that the default look and feel is simulated best.
</docstring>
4654 <param name=
"enableTheme" type=
"bool" default=
""/>
4657 <method name=
"GetThemeEnabled" type=
"bool" overloaded=
"no">
4658 <autodoc>GetThemeEnabled(self) -
> bool
</autodoc>
4659 <docstring>Return the themeEnabled flag.
</docstring>
4661 <method name=
"SetFocus" type=
"" overloaded=
"no">
4662 <autodoc>SetFocus(self)
</autodoc>
4663 <docstring>Set's the focus to this window, allowing it to receive keyboard input.
</docstring>
4665 <method name=
"SetFocusFromKbd" type=
"" overloaded=
"no">
4666 <autodoc>SetFocusFromKbd(self)
</autodoc>
4667 <docstring>Set focus to this window as the result of a keyboard action. Normally
4668 only called internally.
</docstring>
4670 <staticmethod name=
"FindFocus" type=
"Window" overloaded=
"no">
4671 <autodoc>FindFocus() -
> Window
</autodoc>
4672 <docstring>Returns the window or control that currently has the keyboard focus,
4673 or None.
</docstring>
4675 <method name=
"AcceptsFocus" type=
"bool" overloaded=
"no">
4676 <autodoc>AcceptsFocus(self) -
> bool
</autodoc>
4677 <docstring>Can this window have focus?
</docstring>
4679 <method name=
"AcceptsFocusFromKeyboard" type=
"bool" overloaded=
"no">
4680 <autodoc>AcceptsFocusFromKeyboard(self) -
> bool
</autodoc>
4681 <docstring>Can this window be given focus by keyboard navigation? if not, the
4682 only way to give it focus (provided it accepts it at all) is to click
4685 <method name=
"GetDefaultItem" type=
"Window" overloaded=
"no">
4686 <autodoc>GetDefaultItem(self) -
> Window
</autodoc>
4687 <docstring>Get the default child of this parent, i.e. the one which is activated
4688 by pressing
<Enter
> such as the OK button on a wx.Dialog.
</docstring>
4690 <method name=
"SetDefaultItem" type=
"Window" overloaded=
"no">
4691 <autodoc>SetDefaultItem(self, Window child) -
> Window
</autodoc>
4692 <docstring>Set this child as default, return the old default.
</docstring>
4694 <param name=
"child" type=
"Window" default=
""/>
4697 <method name=
"SetTmpDefaultItem" type=
"" overloaded=
"no">
4698 <autodoc>SetTmpDefaultItem(self, Window win)
</autodoc>
4699 <docstring>Set this child as temporary default
</docstring>
4701 <param name=
"win" type=
"Window" default=
""/>
4704 <method name=
"Navigate" type=
"bool" overloaded=
"no">
4705 <autodoc>Navigate(self, int flags=NavigationKeyEvent.IsForward) -
> bool
</autodoc>
4706 <docstring>Does keyboard navigation from this window to another, by sending a
4707 `wx.NavigationKeyEvent`.
4709 :param flags: A combination of the ``IsForward`` or ``IsBackward``
4710 and the ``WinChange`` values in the `wx.NavigationKeyEvent`
4711 class, which determine if the navigation should be in forward
4712 or reverse order, and if it should be able to cross parent
4713 window boundaries, such as between notebook pages or MDI child
4714 frames. Typically the status of the Shift key (for forward or
4715 backward) or the Control key (for WinChange) would be used to
4716 determine how to set the flags.
4718 One situation in which you may wish to call this method is from a text
4719 control custom keypress handler to do the default navigation behaviour
4720 for the tab key, since the standard default behaviour for a multiline
4721 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
4722 not navigate to the next control.
</docstring>
4724 <param name=
"flags" type=
"int" default=
"wxNavigationKeyEvent::IsForward"/>
4727 <method name=
"MoveAfterInTabOrder" type=
"" overloaded=
"no">
4728 <autodoc>MoveAfterInTabOrder(self, Window win)
</autodoc>
4729 <docstring>Moves this window in the tab navigation order after the specified
4730 sibling window. This means that when the user presses the TAB key on
4731 that other window, the focus switches to this window.
4733 The default tab order is the same as creation order. This function
4734 and `MoveBeforeInTabOrder` allow to change it after creating all the
4738 <param name=
"win" type=
"Window" default=
""/>
4741 <method name=
"MoveBeforeInTabOrder" type=
"" overloaded=
"no">
4742 <autodoc>MoveBeforeInTabOrder(self, Window win)
</autodoc>
4743 <docstring>Same as `MoveAfterInTabOrder` except that it inserts this window just
4744 before win instead of putting it right after it.
</docstring>
4746 <param name=
"win" type=
"Window" default=
""/>
4749 <method name=
"GetChildren" type=
"PyObject" overloaded=
"no">
4750 <autodoc>GetChildren(self) -
> PyObject
</autodoc>
4751 <docstring>Returns a list of the window's children. NOTE: Currently this is a
4752 copy of the child window list maintained by the window, so the return
4753 value of this function is only valid as long as the window's children
4754 do not change.
</docstring>
4756 <method name=
"GetParent" type=
"Window" overloaded=
"no">
4757 <autodoc>GetParent(self) -
> Window
</autodoc>
4758 <docstring>Returns the parent window of this window, or None if there isn't one.
</docstring>
4760 <method name=
"GetGrandParent" type=
"Window" overloaded=
"no">
4761 <autodoc>GetGrandParent(self) -
> Window
</autodoc>
4762 <docstring>Returns the parent of the parent of this window, or None if there
4763 isn't one.
</docstring>
4765 <method name=
"IsTopLevel" type=
"bool" overloaded=
"no">
4766 <autodoc>IsTopLevel(self) -
> bool
</autodoc>
4767 <docstring>Returns true if the given window is a top-level one. Currently all
4768 frames and dialogs are always considered to be top-level windows (even
4769 if they have a parent window).
</docstring>
4771 <method name=
"Reparent" type=
"bool" overloaded=
"no">
4772 <autodoc>Reparent(self, Window newParent) -
> bool
</autodoc>
4773 <docstring>Reparents the window, i.e the window will be removed from its current
4774 parent window (e.g. a non-standard toolbar in a wxFrame) and then
4775 re-inserted into another. Available on Windows and GTK. Returns True
4776 if the parent was changed, False otherwise (error or newParent ==
4777 oldParent)
</docstring>
4779 <param name=
"newParent" type=
"Window" default=
""/>
4782 <method name=
"AddChild" type=
"" overloaded=
"no">
4783 <autodoc>AddChild(self, Window child)
</autodoc>
4784 <docstring>Adds a child window. This is called automatically by window creation
4785 functions so should not be required by the application programmer.
</docstring>
4787 <param name=
"child" type=
"Window" default=
""/>
4790 <method name=
"RemoveChild" type=
"" overloaded=
"no">
4791 <autodoc>RemoveChild(self, Window child)
</autodoc>
4792 <docstring>Removes a child window. This is called automatically by window
4793 deletion functions so should not be required by the application
4794 programmer.
</docstring>
4796 <param name=
"child" type=
"Window" default=
""/>
4799 <method name=
"FindWindowById" type=
"Window" overloaded=
"no">
4800 <autodoc>FindWindowById(self, long winid) -
> Window
</autodoc>
4801 <docstring>Find a chld of this window by window ID
</docstring>
4803 <param name=
"winid" type=
"long" default=
""/>
4806 <method name=
"FindWindowByName" type=
"Window" overloaded=
"no">
4807 <autodoc>FindWindowByName(self, String name) -
> Window
</autodoc>
4808 <docstring>Find a child of this window by name
</docstring>
4810 <param name=
"name" type=
"String" default=
""/>
4813 <method name=
"GetEventHandler" type=
"EvtHandler" overloaded=
"no">
4814 <autodoc>GetEventHandler(self) -
> EvtHandler
</autodoc>
4815 <docstring>Returns the event handler for this window. By default, the window is
4816 its own event handler.
</docstring>
4818 <method name=
"SetEventHandler" type=
"" overloaded=
"no">
4819 <autodoc>SetEventHandler(self, EvtHandler handler)
</autodoc>
4820 <docstring>Sets the event handler for this window. An event handler is an object
4821 that is capable of processing the events sent to a window. By default,
4822 the window is its own event handler, but an application may wish to
4823 substitute another, for example to allow central implementation of
4824 event-handling for a variety of different window classes.
4826 It is usually better to use `wx.Window.PushEventHandler` since this sets
4827 up a chain of event handlers, where an event not handled by one event
4828 handler is handed to the next one in the chain.
</docstring>
4830 <param name=
"handler" type=
"EvtHandler" default=
""/>
4833 <method name=
"PushEventHandler" type=
"" overloaded=
"no">
4834 <autodoc>PushEventHandler(self, EvtHandler handler)
</autodoc>
4835 <docstring>Pushes this event handler onto the event handler stack for the window.
4836 An event handler is an object that is capable of processing the events
4837 sent to a window. By default, the window is its own event handler, but
4838 an application may wish to substitute another, for example to allow
4839 central implementation of event-handling for a variety of different
4842 wx.Window.PushEventHandler allows an application to set up a chain of
4843 event handlers, where an event not handled by one event handler is
4844 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
4845 remove the event handler.
</docstring>
4847 <param name=
"handler" type=
"EvtHandler" default=
""/>
4850 <method name=
"PopEventHandler" type=
"EvtHandler" overloaded=
"no">
4851 <autodoc>PopEventHandler(self, bool deleteHandler=False) -
> EvtHandler
</autodoc>
4852 <docstring>Removes and returns the top-most event handler on the event handler
4853 stack. If deleteHandler is True then the wx.EvtHandler object will be
4854 destroyed after it is popped.
</docstring>
4856 <param name=
"deleteHandler" type=
"bool" default=
"False"/>
4859 <method name=
"RemoveEventHandler" type=
"bool" overloaded=
"no">
4860 <autodoc>RemoveEventHandler(self, EvtHandler handler) -
> bool
</autodoc>
4861 <docstring>Find the given handler in the event handler chain and remove (but not
4862 delete) it from the event handler chain, return True if it was found
4863 and False otherwise (this also results in an assert failure so this
4864 function should only be called when the handler is supposed to be
4867 <param name=
"handler" type=
"EvtHandler" default=
""/>
4870 <method name=
"SetValidator" type=
"" overloaded=
"no">
4871 <autodoc>SetValidator(self, Validator validator)
</autodoc>
4872 <docstring>Deletes the current validator (if any) and sets the window validator,
4873 having called wx.Validator.Clone to create a new validator of this
4876 <param name=
"validator" type=
"wxValidator" default=
""/>
4879 <method name=
"GetValidator" type=
"wxValidator" overloaded=
"no">
4880 <autodoc>GetValidator(self) -
> Validator
</autodoc>
4881 <docstring>Returns a pointer to the current validator for the window, or None if
4882 there is none.
</docstring>
4884 <method name=
"Validate" type=
"bool" overloaded=
"no">
4885 <autodoc>Validate(self) -
> bool
</autodoc>
4886 <docstring>Validates the current values of the child controls using their
4887 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
4888 style flag set, the method will also call Validate() of all child
4889 windows. Returns false if any of the validations failed.
</docstring>
4891 <method name=
"TransferDataToWindow" type=
"bool" overloaded=
"no">
4892 <autodoc>TransferDataToWindow(self) -
> bool
</autodoc>
4893 <docstring>Transfers values to child controls from data areas specified by their
4894 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
4895 style flag set, the method will also call TransferDataToWindow() of
4896 all child windows.
</docstring>
4898 <method name=
"TransferDataFromWindow" type=
"bool" overloaded=
"no">
4899 <autodoc>TransferDataFromWindow(self) -
> bool
</autodoc>
4900 <docstring>Transfers values from child controls to data areas specified by their
4901 validators. Returns false if a transfer failed. If the window has
4902 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
4903 also call TransferDataFromWindow() of all child windows.
</docstring>
4905 <method name=
"InitDialog" type=
"" overloaded=
"no">
4906 <autodoc>InitDialog(self)
</autodoc>
4907 <docstring>Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
4908 to the dialog via validators.
</docstring>
4910 <method name=
"SetAcceleratorTable" type=
"" overloaded=
"no">
4911 <autodoc>SetAcceleratorTable(self, AcceleratorTable accel)
</autodoc>
4912 <docstring>Sets the accelerator table for this window.
</docstring>
4914 <param name=
"accel" type=
"AcceleratorTable" default=
""/>
4917 <method name=
"GetAcceleratorTable" type=
"AcceleratorTable" overloaded=
"no">
4918 <autodoc>GetAcceleratorTable(self) -
> AcceleratorTable
</autodoc>
4919 <docstring>Gets the accelerator table for this window.
</docstring>
4921 <method name=
"RegisterHotKey" type=
"bool" overloaded=
"no">
4922 <autodoc>RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -
> bool
</autodoc>
4923 <docstring>Registers a system wide hotkey. Every time the user presses the hotkey
4924 registered here, this window will receive a hotkey event. It will
4925 receive the event even if the application is in the background and
4926 does not have the input focus because the user is working with some
4927 other application. To bind an event handler function to this hotkey
4928 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
4929 hotkey was registered successfully.
</docstring>
4931 <param name=
"hotkeyId" type=
"int" default=
""/>
4932 <param name=
"modifiers" type=
"int" default=
""/>
4933 <param name=
"keycode" type=
"int" default=
""/>
4936 <method name=
"UnregisterHotKey" type=
"bool" overloaded=
"no">
4937 <autodoc>UnregisterHotKey(self, int hotkeyId) -
> bool
</autodoc>
4938 <docstring>Unregisters a system wide hotkey.
</docstring>
4940 <param name=
"hotkeyId" type=
"int" default=
""/>
4943 <method name=
"ConvertDialogPointToPixels" type=
"Point" overloaded=
"no">
4944 <autodoc>ConvertDialogPointToPixels(self, Point pt) -
> Point
</autodoc>
4945 <docstring>Converts a point or size from dialog units to pixels. Dialog units
4946 are used for maintaining a dialog's proportions even if the font
4947 changes. For the x dimension, the dialog units are multiplied by the
4948 average character width and then divided by
4. For the y dimension,
4949 the dialog units are multiplied by the average character height and
4950 then divided by
8.
</docstring>
4952 <param name=
"pt" type=
"Point" default=
""/>
4955 <method name=
"ConvertDialogSizeToPixels" type=
"Size" overloaded=
"no">
4956 <autodoc>ConvertDialogSizeToPixels(self, Size sz) -
> Size
</autodoc>
4957 <docstring>Converts a point or size from dialog units to pixels. Dialog units
4958 are used for maintaining a dialog's proportions even if the font
4959 changes. For the x dimension, the dialog units are multiplied by the
4960 average character width and then divided by
4. For the y dimension,
4961 the dialog units are multiplied by the average character height and
4962 then divided by
8.
</docstring>
4964 <param name=
"sz" type=
"Size" default=
""/>
4967 <method name=
"DLG_PNT" type=
"Point" overloaded=
"no">
4968 <autodoc>DLG_PNT(self, Point pt) -
> Point
</autodoc>
4969 <docstring>Converts a point or size from dialog units to pixels. Dialog units
4970 are used for maintaining a dialog's proportions even if the font
4971 changes. For the x dimension, the dialog units are multiplied by the
4972 average character width and then divided by
4. For the y dimension,
4973 the dialog units are multiplied by the average character height and
4974 then divided by
8.
</docstring>
4976 <param name=
"pt" type=
"Point" default=
""/>
4979 <method name=
"DLG_SZE" type=
"Size" overloaded=
"no">
4980 <autodoc>DLG_SZE(self, Size sz) -
> Size
</autodoc>
4981 <docstring>Converts a point or size from dialog units to pixels. Dialog units
4982 are used for maintaining a dialog's proportions even if the font
4983 changes. For the x dimension, the dialog units are multiplied by the
4984 average character width and then divided by
4. For the y dimension,
4985 the dialog units are multiplied by the average character height and
4986 then divided by
8.
</docstring>
4988 <param name=
"sz" type=
"Size" default=
""/>
4991 <method name=
"ConvertPixelPointToDialog" type=
"Point" overloaded=
"no">
4992 <autodoc>ConvertPixelPointToDialog(self, Point pt) -
> Point
</autodoc>
4994 <param name=
"pt" type=
"Point" default=
""/>
4997 <method name=
"ConvertPixelSizeToDialog" type=
"Size" overloaded=
"no">
4998 <autodoc>ConvertPixelSizeToDialog(self, Size sz) -
> Size
</autodoc>
5000 <param name=
"sz" type=
"Size" default=
""/>
5003 <method name=
"WarpPointer" type=
"" overloaded=
"no">
5004 <autodoc>WarpPointer(self, int x, int y)
</autodoc>
5005 <docstring>Moves the pointer to the given position on the window.
5007 NOTE: This function is not supported under Mac because Apple Human
5008 Interface Guidelines forbid moving the mouse cursor programmatically.
</docstring>
5010 <param name=
"x" type=
"int" default=
""/>
5011 <param name=
"y" type=
"int" default=
""/>
5014 <method name=
"CaptureMouse" type=
"" overloaded=
"no">
5015 <autodoc>CaptureMouse(self)
</autodoc>
5016 <docstring>Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
5017 release the capture.
5019 Note that wxWindows maintains the stack of windows having captured the
5020 mouse and when the mouse is released the capture returns to the window
5021 which had had captured it previously and it is only really released if
5022 there were no previous window. In particular, this means that you must
5023 release the mouse as many times as you capture it.
</docstring>
5025 <method name=
"ReleaseMouse" type=
"" overloaded=
"no">
5026 <autodoc>ReleaseMouse(self)
</autodoc>
5027 <docstring>Releases mouse input captured with wx.Window.CaptureMouse.
</docstring>
5029 <staticmethod name=
"GetCapture" type=
"Window" overloaded=
"no">
5030 <autodoc>GetCapture() -
> Window
</autodoc>
5031 <docstring>Returns the window which currently captures the mouse or None
</docstring>
5033 <method name=
"HasCapture" type=
"bool" overloaded=
"no">
5034 <autodoc>HasCapture(self) -
> bool
</autodoc>
5035 <docstring>Returns true if this window has the current mouse capture.
</docstring>
5037 <method name=
"Refresh" type=
"" overloaded=
"no">
5038 <autodoc>Refresh(self, bool eraseBackground=True, Rect rect=None)
</autodoc>
5039 <docstring>Mark the specified rectangle (or the whole window) as "dirty" so it
5040 will be repainted. Causes an EVT_PAINT event to be generated and sent
5041 to the window.
</docstring>
5043 <param name=
"eraseBackground" type=
"bool" default=
"True"/>
5044 <param name=
"rect" type=
"Rect" default=
"NULL"/>
5047 <method name=
"RefreshRect" type=
"" overloaded=
"no">
5048 <autodoc>RefreshRect(self, Rect rect)
</autodoc>
5049 <docstring>Redraws the contents of the given rectangle: the area inside it will
5050 be repainted. This is the same as Refresh but has a nicer syntax.
</docstring>
5052 <param name=
"rect" type=
"Rect" default=
""/>
5055 <method name=
"Update" type=
"" overloaded=
"no">
5056 <autodoc>Update(self)
</autodoc>
5057 <docstring>Calling this method immediately repaints the invalidated area of the
5058 window instead of waiting for the EVT_PAINT event to happen, (normally
5059 this would usually only happen when the flow of control returns to the
5060 event loop.) Notice that this function doesn't refresh the window and
5061 does nothing if the window has been already repainted. Use Refresh
5062 first if you want to immediately redraw the window (or some portion of
5063 it) unconditionally.
</docstring>
5065 <method name=
"ClearBackground" type=
"" overloaded=
"no">
5066 <autodoc>ClearBackground(self)
</autodoc>
5067 <docstring>Clears the window by filling it with the current background
5068 colour. Does not cause an erase background event to be generated.
</docstring>
5070 <method name=
"Freeze" type=
"" overloaded=
"no">
5071 <autodoc>Freeze(self)
</autodoc>
5072 <docstring>Freezes the window or, in other words, prevents any updates from
5073 taking place on screen, the window is not redrawn at all. Thaw must be
5074 called to reenable window redrawing. Calls to Freeze/Thaw may be
5075 nested, with the actual Thaw being delayed until all the nesting has
5078 This method is useful for visual appearance optimization (for example,
5079 it is a good idea to use it before inserting large amount of text into
5080 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
5081 for all controls so it is mostly just a hint to wxWindows and not a
5082 mandatory directive.
</docstring>
5084 <method name=
"Thaw" type=
"" overloaded=
"no">
5085 <autodoc>Thaw(self)
</autodoc>
5086 <docstring>Reenables window updating after a previous call to Freeze. Calls to
5087 Freeze/Thaw may be nested, so Thaw must be called the same number of
5088 times that Freeze was before the window will be updated.
</docstring>
5090 <method name=
"PrepareDC" type=
"" overloaded=
"no">
5091 <autodoc>PrepareDC(self, DC dc)
</autodoc>
5092 <docstring>Call this function to prepare the device context for drawing a
5093 scrolled image. It sets the device origin according to the current
5094 scroll position.
</docstring>
5096 <param name=
"dc" type=
"wxDC" default=
""/>
5099 <method name=
"GetUpdateRegion" type=
"wxRegion" overloaded=
"no">
5100 <autodoc>GetUpdateRegion(self) -
> Region
</autodoc>
5101 <docstring>Returns the region specifying which parts of the window have been
5102 damaged. Should only be called within an EVT_PAINT handler.
</docstring>
5104 <method name=
"GetUpdateClientRect" type=
"Rect" overloaded=
"no">
5105 <autodoc>GetUpdateClientRect(self) -
> Rect
</autodoc>
5106 <docstring>Get the update rectangle region bounding box in client coords.
</docstring>
5108 <method name=
"IsExposed" type=
"bool" overloaded=
"no">
5109 <autodoc>IsExposed(self, int x, int y, int w=
1, int h=
1) -
> bool
</autodoc>
5110 <docstring>Returns true if the given point or rectangle area has been exposed
5111 since the last repaint. Call this in an paint event handler to
5112 optimize redrawing by only redrawing those areas, which have been
5113 exposed.
</docstring>
5115 <param name=
"x" type=
"int" default=
""/>
5116 <param name=
"y" type=
"int" default=
""/>
5117 <param name=
"w" type=
"int" default=
"1"/>
5118 <param name=
"h" type=
"int" default=
"1"/>
5121 <method name=
"IsExposedPoint" type=
"bool" overloaded=
"no">
5122 <autodoc>IsExposedPoint(self, Point pt) -
> bool
</autodoc>
5123 <docstring>Returns true if the given point or rectangle area has been exposed
5124 since the last repaint. Call this in an paint event handler to
5125 optimize redrawing by only redrawing those areas, which have been
5126 exposed.
</docstring>
5128 <param name=
"pt" type=
"Point" default=
""/>
5131 <method name=
"IsExposedRect" type=
"bool" overloaded=
"no">
5132 <autodoc>IsExposedRect(self, Rect rect) -
> bool
</autodoc>
5133 <docstring>Returns true if the given point or rectangle area has been exposed
5134 since the last repaint. Call this in an paint event handler to
5135 optimize redrawing by only redrawing those areas, which have been
5136 exposed.
</docstring>
5138 <param name=
"rect" type=
"Rect" default=
""/>
5141 <method name=
"GetDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
5142 <autodoc>GetDefaultAttributes(self) -
> VisualAttributes
</autodoc>
5143 <docstring>Get the default attributes for an instance of this class. This is
5144 useful if you want to use the same font or colour in your own control
5145 as in a standard control -- which is a much better idea than hard
5146 coding specific colours or fonts which might look completely out of
5147 place on the user's system, especially if it uses themes.
</docstring>
5149 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
5150 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
5151 <docstring>Get the default attributes for this class. This is useful if you want
5152 to use the same font or colour in your own control as in a standard
5153 control -- which is a much better idea than hard coding specific
5154 colours or fonts which might look completely out of place on the
5155 user's system, especially if it uses themes.
5157 The variant parameter is only relevant under Mac currently and is
5158 ignore under other platforms. Under Mac, it will change the size of
5159 the returned font. See `wx.Window.SetWindowVariant` for more about
5162 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
5165 <method name=
"SetBackgroundColour" type=
"bool" overloaded=
"no">
5166 <autodoc>SetBackgroundColour(self, Colour colour) -
> bool
</autodoc>
5167 <docstring>Sets the background colour of the window. Returns True if the colour
5168 was changed. The background colour is usually painted by the default
5169 EVT_ERASE_BACKGROUND event handler function under Windows and
5170 automatically under GTK. Using `wx.NullColour` will reset the window
5171 to the default background colour.
5173 Note that setting the background colour may not cause an immediate
5174 refresh, so you may wish to call `ClearBackground` or `Refresh` after
5175 calling this function.
5177 Using this function will disable attempts to use themes for this
5178 window, if the system supports them. Use with care since usually the
5179 themes represent the appearance chosen by the user to be used for all
5180 applications on the system.
</docstring>
5182 <param name=
"colour" type=
"wxColour" default=
""/>
5185 <method name=
"SetOwnBackgroundColour" type=
"" overloaded=
"no">
5186 <autodoc>SetOwnBackgroundColour(self, Colour colour)
</autodoc>
5188 <param name=
"colour" type=
"wxColour" default=
""/>
5191 <method name=
"SetForegroundColour" type=
"bool" overloaded=
"no">
5192 <autodoc>SetForegroundColour(self, Colour colour) -
> bool
</autodoc>
5193 <docstring>Sets the foreground colour of the window. Returns True is the colour
5194 was changed. The interpretation of foreground colour is dependent on
5195 the window class; it may be the text colour or other colour, or it may
5196 not be used at all.
</docstring>
5198 <param name=
"colour" type=
"wxColour" default=
""/>
5201 <method name=
"SetOwnForegroundColour" type=
"" overloaded=
"no">
5202 <autodoc>SetOwnForegroundColour(self, Colour colour)
</autodoc>
5204 <param name=
"colour" type=
"wxColour" default=
""/>
5207 <method name=
"GetBackgroundColour" type=
"wxColour" overloaded=
"no">
5208 <autodoc>GetBackgroundColour(self) -
> Colour
</autodoc>
5209 <docstring>Returns the background colour of the window.
</docstring>
5211 <method name=
"GetForegroundColour" type=
"wxColour" overloaded=
"no">
5212 <autodoc>GetForegroundColour(self) -
> Colour
</autodoc>
5213 <docstring>Returns the foreground colour of the window. The interpretation of
5214 foreground colour is dependent on the window class; it may be the text
5215 colour or other colour, or it may not be used at all.
</docstring>
5217 <method name=
"SetCursor" type=
"bool" overloaded=
"no">
5218 <autodoc>SetCursor(self, Cursor cursor) -
> bool
</autodoc>
5219 <docstring>Sets the window's cursor. Notice that the window cursor also sets it
5220 for the children of the window implicitly.
5222 The cursor may be wx.NullCursor in which case the window cursor will
5223 be reset back to default.
</docstring>
5225 <param name=
"cursor" type=
"wxCursor" default=
""/>
5228 <method name=
"GetCursor" type=
"wxCursor" overloaded=
"no">
5229 <autodoc>GetCursor(self) -
> Cursor
</autodoc>
5230 <docstring>Return the cursor associated with this window.
</docstring>
5232 <method name=
"SetFont" type=
"bool" overloaded=
"no">
5233 <autodoc>SetFont(self, Font font) -
> bool
</autodoc>
5234 <docstring>Sets the font for this window.
</docstring>
5236 <param name=
"font" type=
"wxFont" default=
""/>
5239 <method name=
"SetOwnFont" type=
"" overloaded=
"no">
5240 <autodoc>SetOwnFont(self, Font font)
</autodoc>
5242 <param name=
"font" type=
"wxFont" default=
""/>
5245 <method name=
"GetFont" type=
"wxFont" overloaded=
"no">
5246 <autodoc>GetFont(self) -
> Font
</autodoc>
5247 <docstring>Returns the default font used for this window.
</docstring>
5249 <method name=
"SetCaret" type=
"" overloaded=
"no">
5250 <autodoc>SetCaret(self, Caret caret)
</autodoc>
5251 <docstring>Sets the caret associated with the window.
</docstring>
5253 <param name=
"caret" type=
"wxCaret" default=
""/>
5256 <method name=
"GetCaret" type=
"wxCaret" overloaded=
"no">
5257 <autodoc>GetCaret(self) -
> Caret
</autodoc>
5258 <docstring>Returns the caret associated with the window.
</docstring>
5260 <method name=
"GetCharHeight" type=
"int" overloaded=
"no">
5261 <autodoc>GetCharHeight(self) -
> int
</autodoc>
5262 <docstring>Get the (average) character size for the current font.
</docstring>
5264 <method name=
"GetCharWidth" type=
"int" overloaded=
"no">
5265 <autodoc>GetCharWidth(self) -
> int
</autodoc>
5266 <docstring>Get the (average) character size for the current font.
</docstring>
5268 <method name=
"GetTextExtent" type=
"" overloaded=
"no">
5269 <autodoc>GetTextExtent(String string) -
> (width, height)
</autodoc>
5270 <docstring>Get the width and height of the text using the current font.
</docstring>
5272 <param name=
"string" type=
"String" default=
""/>
5273 <param name=
"OUTPUT" type=
"int" default=
""/>
5274 <param name=
"OUTPUT" type=
"int" default=
""/>
5277 <method name=
"GetFullTextExtent" type=
"" overloaded=
"no">
5278 <autodoc>GetFullTextExtent(String string, Font font=None) -
>
5279 (width, height, descent, externalLeading)
</autodoc>
5280 <docstring>Get the width, height, decent and leading of the text using the
5281 current or specified font.
</docstring>
5283 <param name=
"string" type=
"String" default=
""/>
5284 <param name=
"OUTPUT" type=
"int" default=
""/>
5285 <param name=
"OUTPUT" type=
"int" default=
""/>
5286 <param name=
"OUTPUT" type=
"int" default=
""/>
5287 <param name=
"OUTPUT" type=
"int" default=
""/>
5288 <param name=
"font" type=
"wxFont" default=
"NULL"/>
5291 <method name=
"ClientToScreenXY" type=
"" overloaded=
"no">
5292 <autodoc>ClientToScreenXY(int x, int y) -
> (x,y)
</autodoc>
5293 <docstring>Converts to screen coordinates from coordinates relative to this window.
</docstring>
5295 <param name=
"x" type=
"int" default=
""/>
5296 <param name=
"y" type=
"int" default=
""/>
5299 <method name=
"ScreenToClientXY" type=
"" overloaded=
"no">
5300 <autodoc>ScreenToClientXY(int x, int y) -
> (x,y)
</autodoc>
5301 <docstring>Converts from screen to client window coordinates.
</docstring>
5303 <param name=
"x" type=
"int" default=
""/>
5304 <param name=
"y" type=
"int" default=
""/>
5307 <method name=
"ClientToScreen" type=
"Point" overloaded=
"no">
5308 <autodoc>ClientToScreen(self, Point pt) -
> Point
</autodoc>
5309 <docstring>Converts to screen coordinates from coordinates relative to this window.
</docstring>
5311 <param name=
"pt" type=
"Point" default=
""/>
5314 <method name=
"ScreenToClient" type=
"Point" overloaded=
"no">
5315 <autodoc>ScreenToClient(self, Point pt) -
> Point
</autodoc>
5316 <docstring>Converts from screen to client window coordinates.
</docstring>
5318 <param name=
"pt" type=
"Point" default=
""/>
5321 <method name=
"HitTestXY" type=
"wxHitTest" overloaded=
"no">
5322 <autodoc>HitTestXY(self, int x, int y) -
> int
</autodoc>
5323 <docstring>Test where the given (in client coords) point lies
</docstring>
5325 <param name=
"x" type=
"int" default=
""/>
5326 <param name=
"y" type=
"int" default=
""/>
5329 <method name=
"HitTest" type=
"wxHitTest" overloaded=
"no">
5330 <autodoc>HitTest(self, Point pt) -
> int
</autodoc>
5331 <docstring>Test where the given (in client coords) point lies
</docstring>
5333 <param name=
"pt" type=
"Point" default=
""/>
5336 <method name=
"GetBorder" type=
"wxBorder" overloaded=
"yes">
5337 <docstring>Get the window border style from the given flags: this is different
5338 from simply doing flags
& wxBORDER_MASK because it uses
5339 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
5343 <param name=
"flags" type=
"long" default=
""/>
5346 <method name=
"GetBorder" type=
"wxBorder" overloaded=
"yes">
5347 <autodoc>GetBorder(self, long flags) -
> int
5348 GetBorder(self) -
> int
</autodoc>
5349 <docstring>Get border for the flags of this window
</docstring>
5351 <method name=
"UpdateWindowUI" type=
"" overloaded=
"no">
5352 <autodoc>UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
</autodoc>
5353 <docstring>This function sends EVT_UPDATE_UI events to the window. The particular
5354 implementation depends on the window; for example a wx.ToolBar will
5355 send an update UI event for each toolbar button, and a wx.Frame will
5356 send an update UI event for each menubar menu item. You can call this
5357 function from your application to ensure that your UI is up-to-date at
5358 a particular point in time (as far as your EVT_UPDATE_UI handlers are
5359 concerned). This may be necessary if you have called
5360 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
5361 limit the overhead that wxWindows incurs by sending update UI events
5363 The flags should be a bitlist of one or more of the following values:
5365 ===================== ==============================
5366 wx.UPDATE_UI_NONE No particular value
5367 wx.UPDATE_UI_RECURSE Call the function for descendants
5368 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
5369 ===================== ==============================
5371 If you are calling this function from an OnIdle function, make sure
5372 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
5373 to only update the UI elements that need to be updated in idle
5374 time. Some windows update their elements only when necessary, for
5375 example when a menu is about to be shown. The following is an example
5376 of how to call UpdateWindowUI from an idle function::
5378 def OnIdle(self, evt):
5379 if wx.UpdateUIEvent.CanUpdate(self):
5380 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
5383 <param name=
"flags" type=
"long" default=
"wxUPDATE_UI_NONE"/>
5386 <method name=
"PopupMenuXY" type=
"bool" overloaded=
"no">
5387 <autodoc>PopupMenuXY(self, Menu menu, int x=-
1, int y=-
1) -
> bool
</autodoc>
5388 <docstring>Pops up the given menu at the specified coordinates, relative to this window,
5389 and returns control when the user has dismissed the menu. If a menu item is
5390 selected, the corresponding menu event is generated and will be processed as
5391 usual. If the default position is given then the current position of the
5392 mouse cursor will be used.
</docstring>
5394 <param name=
"menu" type=
"wxMenu" default=
""/>
5395 <param name=
"x" type=
"int" default=
"-1"/>
5396 <param name=
"y" type=
"int" default=
"-1"/>
5399 <method name=
"PopupMenu" type=
"bool" overloaded=
"no">
5400 <autodoc>PopupMenu(self, Menu menu, Point pos=DefaultPosition) -
> bool
</autodoc>
5401 <docstring>Pops up the given menu at the specified coordinates, relative to this window,
5402 and returns control when the user has dismissed the menu. If a menu item is
5403 selected, the corresponding menu event is generated and will be processed as
5404 usual. If the default position is given then the current position of the
5405 mouse cursor will be used.
</docstring>
5407 <param name=
"menu" type=
"wxMenu" default=
""/>
5408 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
5411 <method name=
"GetHandle" type=
"long" overloaded=
"no">
5412 <autodoc>GetHandle(self) -
> long
</autodoc>
5413 <docstring>Returns the platform-specific handle (as a long integer) of the
5414 physical window. Currently on wxMac it returns the handle of the
5415 toplevel parent of the window.
</docstring>
5417 <method name=
"HasScrollbar" type=
"bool" overloaded=
"no">
5418 <autodoc>HasScrollbar(self, int orient) -
> bool
</autodoc>
5419 <docstring>Does the window have the scrollbar for this orientation?
</docstring>
5421 <param name=
"orient" type=
"int" default=
""/>
5424 <method name=
"SetScrollbar" type=
"" overloaded=
"no">
5425 <autodoc>SetScrollbar(self, int orientation, int position, int thumbSize, int range,
5426 bool refresh=True)
</autodoc>
5427 <docstring>Sets the scrollbar properties of a built-in scrollbar.
5428 :param orientation: Determines the scrollbar whose page size is to
5429 be set. May be wx.HORIZONTAL or wx.VERTICAL.
5431 :param position: The position of the scrollbar in scroll units.
5433 :param thumbSize: The size of the thumb, or visible portion of the
5434 scrollbar, in scroll units.
5436 :param range: The maximum position of the scrollbar.
5438 :param refresh: True to redraw the scrollbar, false otherwise.
5441 <param name=
"orientation" type=
"int" default=
""/>
5442 <param name=
"position" type=
"int" default=
""/>
5443 <param name=
"thumbSize" type=
"int" default=
""/>
5444 <param name=
"range" type=
"int" default=
""/>
5445 <param name=
"refresh" type=
"bool" default=
"True"/>
5448 <method name=
"SetScrollPos" type=
"" overloaded=
"no">
5449 <autodoc>SetScrollPos(self, int orientation, int pos, bool refresh=True)
</autodoc>
5450 <docstring>Sets the position of one of the built-in scrollbars.
</docstring>
5452 <param name=
"orientation" type=
"int" default=
""/>
5453 <param name=
"pos" type=
"int" default=
""/>
5454 <param name=
"refresh" type=
"bool" default=
"True"/>
5457 <method name=
"GetScrollPos" type=
"int" overloaded=
"no">
5458 <autodoc>GetScrollPos(self, int orientation) -
> int
</autodoc>
5459 <docstring>Returns the built-in scrollbar position.
</docstring>
5461 <param name=
"orientation" type=
"int" default=
""/>
5464 <method name=
"GetScrollThumb" type=
"int" overloaded=
"no">
5465 <autodoc>GetScrollThumb(self, int orientation) -
> int
</autodoc>
5466 <docstring>Returns the built-in scrollbar thumb size.
</docstring>
5468 <param name=
"orientation" type=
"int" default=
""/>
5471 <method name=
"GetScrollRange" type=
"int" overloaded=
"no">
5472 <autodoc>GetScrollRange(self, int orientation) -
> int
</autodoc>
5473 <docstring>Returns the built-in scrollbar range.
</docstring>
5475 <param name=
"orientation" type=
"int" default=
""/>
5478 <method name=
"ScrollWindow" type=
"" overloaded=
"no">
5479 <autodoc>ScrollWindow(self, int dx, int dy, Rect rect=None)
</autodoc>
5480 <docstring>Physically scrolls the pixels in the window and move child windows
5481 accordingly. Use this function to optimise your scrolling
5482 implementations, to minimise the area that must be redrawn. Note that
5483 it is rarely required to call this function from a user program.
5484 :param dx: Amount to scroll horizontally.
5486 :param dy: Amount to scroll vertically.
5488 :param rect: Rectangle to invalidate. If this is None, the whole
5489 window is invalidated. If you pass a rectangle corresponding
5490 to the area of the window exposed by the scroll, your
5491 painting handler can optimize painting by checking for the
5492 invalidated region.
</docstring>
5494 <param name=
"dx" type=
"int" default=
""/>
5495 <param name=
"dy" type=
"int" default=
""/>
5496 <param name=
"rect" type=
"Rect" default=
"NULL"/>
5499 <method name=
"ScrollLines" type=
"bool" overloaded=
"no">
5500 <autodoc>ScrollLines(self, int lines) -
> bool
</autodoc>
5501 <docstring>If the platform and window class supports it, scrolls the window by
5502 the given number of lines down, if lines is positive, or up if lines
5503 is negative. Returns True if the window was scrolled, False if it was
5504 already on top/bottom and nothing was done.
</docstring>
5506 <param name=
"lines" type=
"int" default=
""/>
5509 <method name=
"ScrollPages" type=
"bool" overloaded=
"no">
5510 <autodoc>ScrollPages(self, int pages) -
> bool
</autodoc>
5511 <docstring>If the platform and window class supports it, scrolls the window by
5512 the given number of pages down, if pages is positive, or up if pages
5513 is negative. Returns True if the window was scrolled, False if it was
5514 already on top/bottom and nothing was done.
</docstring>
5516 <param name=
"pages" type=
"int" default=
""/>
5519 <method name=
"LineUp" type=
"bool" overloaded=
"no">
5520 <autodoc>LineUp(self) -
> bool
</autodoc>
5521 <docstring>This is just a wrapper for ScrollLines(-
1).
</docstring>
5523 <method name=
"LineDown" type=
"bool" overloaded=
"no">
5524 <autodoc>LineDown(self) -
> bool
</autodoc>
5525 <docstring>This is just a wrapper for ScrollLines(
1).
</docstring>
5527 <method name=
"PageUp" type=
"bool" overloaded=
"no">
5528 <autodoc>PageUp(self) -
> bool
</autodoc>
5529 <docstring>This is just a wrapper for ScrollPages(-
1).
</docstring>
5531 <method name=
"PageDown" type=
"bool" overloaded=
"no">
5532 <autodoc>PageDown(self) -
> bool
</autodoc>
5533 <docstring>This is just a wrapper for ScrollPages(
1).
</docstring>
5535 <method name=
"SetHelpText" type=
"" overloaded=
"no">
5536 <autodoc>SetHelpText(self, String text)
</autodoc>
5537 <docstring>Sets the help text to be used as context-sensitive help for this
5538 window. Note that the text is actually stored by the current
5539 wxHelpProvider implementation, and not in the window object itself.
</docstring>
5541 <param name=
"text" type=
"String" default=
""/>
5544 <method name=
"SetHelpTextForId" type=
"" overloaded=
"no">
5545 <autodoc>SetHelpTextForId(self, String text)
</autodoc>
5546 <docstring>Associate this help text with all windows with the same id as this
5549 <param name=
"text" type=
"String" default=
""/>
5552 <method name=
"GetHelpText" type=
"String" overloaded=
"no">
5553 <autodoc>GetHelpText(self) -
> String
</autodoc>
5554 <docstring>Gets the help text to be used as context-sensitive help for this
5555 window. Note that the text is actually stored by the current
5556 wxHelpProvider implementation, and not in the window object itself.
</docstring>
5558 <method name=
"SetToolTipString" type=
"" overloaded=
"no">
5559 <autodoc>SetToolTipString(self, String tip)
</autodoc>
5560 <docstring>Attach a tooltip to the window.
</docstring>
5562 <param name=
"tip" type=
"String" default=
""/>
5565 <method name=
"SetToolTip" type=
"" overloaded=
"no">
5566 <autodoc>SetToolTip(self, ToolTip tip)
</autodoc>
5567 <docstring>Attach a tooltip to the window.
</docstring>
5569 <param name=
"tip" type=
"wxToolTip" default=
""/>
5572 <method name=
"GetToolTip" type=
"wxToolTip" overloaded=
"no">
5573 <autodoc>GetToolTip(self) -
> ToolTip
</autodoc>
5574 <docstring>get the associated tooltip or None if none
</docstring>
5576 <method name=
"SetDropTarget" type=
"" overloaded=
"no">
5577 <autodoc>SetDropTarget(self, DropTarget dropTarget)
</autodoc>
5578 <docstring>Associates a drop target with this window. If the window already has
5579 a drop target, it is deleted.
</docstring>
5581 <param name=
"dropTarget" type=
"wxPyDropTarget" default=
""/>
5584 <method name=
"GetDropTarget" type=
"wxPyDropTarget" overloaded=
"no">
5585 <autodoc>GetDropTarget(self) -
> DropTarget
</autodoc>
5586 <docstring>Returns the associated drop target, which may be None.
</docstring>
5588 <method name=
"SetConstraints" type=
"" overloaded=
"no">
5589 <autodoc>SetConstraints(self, LayoutConstraints constraints)
</autodoc>
5590 <docstring>Sets the window to have the given layout constraints. If an existing
5591 layout constraints object is already owned by the window, it will be
5592 deleted. Pass None to disassociate and delete the window's current
5595 You must call SetAutoLayout to tell a window to use the constraints
5596 automatically in its default EVT_SIZE handler; otherwise, you must
5597 handle EVT_SIZE yourself and call Layout() explicitly. When setting
5598 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
5601 <param name=
"constraints" type=
"wxLayoutConstraints" default=
""/>
5604 <method name=
"GetConstraints" type=
"wxLayoutConstraints" overloaded=
"no">
5605 <autodoc>GetConstraints(self) -
> LayoutConstraints
</autodoc>
5606 <docstring>Returns a pointer to the window's layout constraints, or None if there
5607 are none.
</docstring>
5609 <method name=
"SetAutoLayout" type=
"" overloaded=
"no">
5610 <autodoc>SetAutoLayout(self, bool autoLayout)
</autodoc>
5611 <docstring>Determines whether the Layout function will be called automatically
5612 when the window is resized. It is called implicitly by SetSizer but
5613 if you use SetConstraints you should call it manually or otherwise the
5614 window layout won't be correctly updated when its size changes.
</docstring>
5616 <param name=
"autoLayout" type=
"bool" default=
""/>
5619 <method name=
"GetAutoLayout" type=
"bool" overloaded=
"no">
5620 <autodoc>GetAutoLayout(self) -
> bool
</autodoc>
5621 <docstring>Returns the current autoLayout setting
</docstring>
5623 <method name=
"Layout" type=
"bool" overloaded=
"no">
5624 <autodoc>Layout(self) -
> bool
</autodoc>
5625 <docstring>Invokes the constraint-based layout algorithm or the sizer-based
5626 algorithm for this window. See SetAutoLayout: when auto layout is on,
5627 this function gets called automatically by the default EVT_SIZE
5628 handler when the window is resized.
</docstring>
5630 <method name=
"SetSizer" type=
"" overloaded=
"no">
5631 <autodoc>SetSizer(self, Sizer sizer, bool deleteOld=True)
</autodoc>
5632 <docstring>Sets the window to have the given layout sizer. The window will then
5633 own the object, and will take care of its deletion. If an existing
5634 layout sizer object is already owned by the window, it will be deleted
5635 if the deleteOld parameter is true. Note that this function will also
5636 call SetAutoLayout implicitly with a True parameter if the sizer is
5637 non-NoneL and False otherwise.
</docstring>
5639 <param name=
"sizer" type=
"wxSizer" default=
""/>
5640 <param name=
"deleteOld" type=
"bool" default=
"True"/>
5643 <method name=
"SetSizerAndFit" type=
"" overloaded=
"no">
5644 <autodoc>SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
</autodoc>
5645 <docstring>The same as SetSizer, except it also sets the size hints for the
5646 window based on the sizer's minimum size.
</docstring>
5648 <param name=
"sizer" type=
"wxSizer" default=
""/>
5649 <param name=
"deleteOld" type=
"bool" default=
"True"/>
5652 <method name=
"GetSizer" type=
"wxSizer" overloaded=
"no">
5653 <autodoc>GetSizer(self) -
> Sizer
</autodoc>
5654 <docstring>Return the sizer associated with the window by a previous call to
5655 SetSizer or None if there isn't one.
</docstring>
5657 <method name=
"SetContainingSizer" type=
"" overloaded=
"no">
5658 <autodoc>SetContainingSizer(self, Sizer sizer)
</autodoc>
5659 <docstring>This normally does not need to be called by application code. It is
5660 called internally when a window is added to a sizer, and is used so
5661 the window can remove itself from the sizer when it is destroyed.
</docstring>
5663 <param name=
"sizer" type=
"wxSizer" default=
""/>
5666 <method name=
"GetContainingSizer" type=
"wxSizer" overloaded=
"no">
5667 <autodoc>GetContainingSizer(self) -
> Sizer
</autodoc>
5668 <docstring>Return the sizer that this window is a member of, if any, otherwise None.
</docstring>
5670 <method name=
"InheritAttributes" type=
"" overloaded=
"no">
5671 <autodoc>InheritAttributes(self)
</autodoc>
5672 <docstring>This function is (or should be, in case of custom controls) called
5673 during window creation to intelligently set up the window visual
5674 attributes, that is the font and the foreground and background
5677 By 'intelligently' the following is meant: by default, all windows use
5678 their own default attributes. However if some of the parent's
5679 attributes are explicitly changed (that is, using SetFont and not
5680 SetOwnFont) and if the corresponding attribute hadn't been
5681 explicitly set for this window itself, then this window takes the same
5682 value as used by the parent. In addition, if the window overrides
5683 ShouldInheritColours to return false, the colours will not be changed
5684 no matter what and only the font might.
5686 This rather complicated logic is necessary in order to accomodate the
5687 different usage scenarius. The most common one is when all default
5688 attributes are used and in this case, nothing should be inherited as
5689 in modern GUIs different controls use different fonts (and colours)
5690 than their siblings so they can't inherit the same value from the
5691 parent. However it was also deemed desirable to allow to simply change
5692 the attributes of all children at once by just changing the font or
5693 colour of their common parent, hence in this case we do inherit the
5697 <method name=
"ShouldInheritColours" type=
"bool" overloaded=
"no">
5698 <autodoc>ShouldInheritColours(self) -
> bool
</autodoc>
5699 <docstring>Return true from here to allow the colours of this window to be
5700 changed by InheritAttributes, returning false forbids inheriting them
5701 from the parent window.
5703 The base class version returns false, but this method is overridden in
5704 wxControl where it returns true.
</docstring>
5708 def DLG_PNT(win, point_or_x, y=None):
5710 Convenience function for converting a Point or (x,y) in
5711 dialog units to pixel units.
5714 return win.ConvertDialogPointToPixels(point_or_x)
5716 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
5718 def DLG_SZE(win, size_width, height=None):
5720 Convenience function for converting a Size or (w,h) in
5721 dialog units to pixel units.
5724 return win.ConvertDialogSizeToPixels(size_width)
5726 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
5728 <method name=
"FindWindowById" oldname=
"wxFindWindowById" type=
"Window" overloaded=
"no">
5729 <autodoc>FindWindowById(long id, Window parent=None) -
> Window
</autodoc>
5730 <docstring>Find the first window in the application with the given id. If parent
5731 is None, the search will start from all top-level frames and dialog
5732 boxes; if non-None, the search will be limited to the given window
5733 hierarchy. The search is recursive in both cases.
</docstring>
5735 <param name=
"id" type=
"long" default=
""/>
5736 <param name=
"parent" type=
"Window" default=
"NULL"/>
5739 <method name=
"FindWindowByName" oldname=
"wxFindWindowByName" type=
"Window" overloaded=
"no">
5740 <autodoc>FindWindowByName(String name, Window parent=None) -
> Window
</autodoc>
5741 <docstring>Find a window by its name (as given in a window constructor or Create
5742 function call). If parent is None, the search will start from all
5743 top-level frames and dialog boxes; if non-None, the search will be
5744 limited to the given window hierarchy. The search is recursive in both
5747 If no window with such name is found, wx.FindWindowByLabel is called.
</docstring>
5749 <param name=
"name" type=
"String" default=
""/>
5750 <param name=
"parent" type=
"Window" default=
"NULL"/>
5753 <method name=
"FindWindowByLabel" oldname=
"wxFindWindowByLabel" type=
"Window" overloaded=
"no">
5754 <autodoc>FindWindowByLabel(String label, Window parent=None) -
> Window
</autodoc>
5755 <docstring>Find a window by its label. Depending on the type of window, the label
5756 may be a window title or panel item label. If parent is None, the
5757 search will start from all top-level frames and dialog boxes; if
5758 non-None, the search will be limited to the given window
5759 hierarchy. The search is recursive in both cases.
</docstring>
5761 <param name=
"label" type=
"String" default=
""/>
5762 <param name=
"parent" type=
"Window" default=
"NULL"/>
5765 <method name=
"Window_FromHWND" oldname=
"wxWindow_FromHWND" type=
"Window" overloaded=
"no">
5766 <autodoc>Window_FromHWND(Window parent, unsigned long _hWnd) -
> Window
</autodoc>
5768 <param name=
"parent" type=
"Window" default=
""/>
5769 <param name=
"_hWnd" type=
"unsigned long" default=
""/>
5773 #---------------------------------------------------------------------------
5775 <class name=
"Validator" oldname=
"wxValidator" module=
"_core">
5776 <baseclass name=
"EvtHandler"/>
5777 <constructor name=
"Validator" overloaded=
"no">
5778 <autodoc>__init__(self) -
> Validator
</autodoc>
5780 <method name=
"Clone" type=
"Validator" overloaded=
"no">
5781 <autodoc>Clone(self) -
> Validator
</autodoc>
5783 <method name=
"Validate" type=
"bool" overloaded=
"no">
5784 <autodoc>Validate(self, Window parent) -
> bool
</autodoc>
5786 <param name=
"parent" type=
"Window" default=
""/>
5789 <method name=
"TransferToWindow" type=
"bool" overloaded=
"no">
5790 <autodoc>TransferToWindow(self) -
> bool
</autodoc>
5792 <method name=
"TransferFromWindow" type=
"bool" overloaded=
"no">
5793 <autodoc>TransferFromWindow(self) -
> bool
</autodoc>
5795 <method name=
"GetWindow" type=
"Window" overloaded=
"no">
5796 <autodoc>GetWindow(self) -
> Window
</autodoc>
5798 <method name=
"SetWindow" type=
"" overloaded=
"no">
5799 <autodoc>SetWindow(self, Window window)
</autodoc>
5801 <param name=
"window" type=
"Window" default=
""/>
5804 <staticmethod name=
"IsSilent" type=
"bool" overloaded=
"no">
5805 <autodoc>IsSilent() -
> bool
</autodoc>
5807 <staticmethod name=
"SetBellOnError" type=
"" overloaded=
"no">
5808 <autodoc>SetBellOnError(int doIt=True)
</autodoc>
5810 <param name=
"doIt" type=
"int" default=
"True"/>
5814 <class name=
"PyValidator" oldname=
"wxPyValidator" module=
"_core">
5815 <baseclass name=
"Validator"/>
5816 <constructor name=
"PyValidator" overloaded=
"no">
5817 <autodoc>__init__(self) -
> PyValidator
</autodoc>
5819 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
5820 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)
</autodoc>
5822 <param name=
"self" type=
"PyObject" default=
""/>
5823 <param name=
"_class" type=
"PyObject" default=
""/>
5824 <param name=
"incref" type=
"int" default=
"True"/>
5829 #---------------------------------------------------------------------------
5831 <class name=
"Menu" oldname=
"wxMenu" module=
"_core">
5832 <baseclass name=
"EvtHandler"/>
5833 <constructor name=
"Menu" overloaded=
"no">
5834 <autodoc>__init__(self, String title=EmptyString, long style=
0) -
> Menu
</autodoc>
5836 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
5837 <param name=
"style" type=
"long" default=
"0"/>
5840 <method name=
"Append" type=
"wxMenuItem" overloaded=
"no">
5841 <autodoc>Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -
> MenuItem
</autodoc>
5843 <param name=
"id" type=
"int" default=
""/>
5844 <param name=
"text" type=
"String" default=
""/>
5845 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5846 <param name=
"kind" type=
"wxItemKind" default=
"wxITEM_NORMAL"/>
5849 <method name=
"AppendSeparator" type=
"wxMenuItem" overloaded=
"no">
5850 <autodoc>AppendSeparator(self) -
> MenuItem
</autodoc>
5852 <method name=
"AppendCheckItem" type=
"wxMenuItem" overloaded=
"no">
5853 <autodoc>AppendCheckItem(self, int id, String text, String help=EmptyString) -
> MenuItem
</autodoc>
5855 <param name=
"id" type=
"int" default=
""/>
5856 <param name=
"text" type=
"String" default=
""/>
5857 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5860 <method name=
"AppendRadioItem" type=
"wxMenuItem" overloaded=
"no">
5861 <autodoc>AppendRadioItem(self, int id, String text, String help=EmptyString) -
> MenuItem
</autodoc>
5863 <param name=
"id" type=
"int" default=
""/>
5864 <param name=
"text" type=
"String" default=
""/>
5865 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5868 <method name=
"AppendMenu" type=
"wxMenuItem" overloaded=
"no">
5869 <autodoc>AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -
> MenuItem
</autodoc>
5871 <param name=
"id" type=
"int" default=
""/>
5872 <param name=
"text" type=
"String" default=
""/>
5873 <param name=
"submenu" type=
"Menu" default=
""/>
5874 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5877 <method name=
"AppendItem" type=
"wxMenuItem" overloaded=
"no">
5878 <autodoc>AppendItem(self, MenuItem item) -
> MenuItem
</autodoc>
5880 <param name=
"item" type=
"wxMenuItem" default=
""/>
5883 <method name=
"Break" type=
"" overloaded=
"no">
5884 <autodoc>Break(self)
</autodoc>
5886 <method name=
"InsertItem" type=
"wxMenuItem" overloaded=
"no">
5887 <autodoc>InsertItem(self, size_t pos, MenuItem item) -
> MenuItem
</autodoc>
5889 <param name=
"pos" type=
"size_t" default=
""/>
5890 <param name=
"item" type=
"wxMenuItem" default=
""/>
5893 <method name=
"Insert" type=
"wxMenuItem" overloaded=
"no">
5894 <autodoc>Insert(self, size_t pos, int id, String text, String help=EmptyString,
5895 int kind=ITEM_NORMAL) -
> MenuItem
</autodoc>
5897 <param name=
"pos" type=
"size_t" default=
""/>
5898 <param name=
"id" type=
"int" default=
""/>
5899 <param name=
"text" type=
"String" default=
""/>
5900 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5901 <param name=
"kind" type=
"wxItemKind" default=
"wxITEM_NORMAL"/>
5904 <method name=
"InsertSeparator" type=
"wxMenuItem" overloaded=
"no">
5905 <autodoc>InsertSeparator(self, size_t pos) -
> MenuItem
</autodoc>
5907 <param name=
"pos" type=
"size_t" default=
""/>
5910 <method name=
"InsertCheckItem" type=
"wxMenuItem" overloaded=
"no">
5911 <autodoc>InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -
> MenuItem
</autodoc>
5913 <param name=
"pos" type=
"size_t" default=
""/>
5914 <param name=
"id" type=
"int" default=
""/>
5915 <param name=
"text" type=
"String" default=
""/>
5916 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5919 <method name=
"InsertRadioItem" type=
"wxMenuItem" overloaded=
"no">
5920 <autodoc>InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -
> MenuItem
</autodoc>
5922 <param name=
"pos" type=
"size_t" default=
""/>
5923 <param name=
"id" type=
"int" default=
""/>
5924 <param name=
"text" type=
"String" default=
""/>
5925 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5928 <method name=
"InsertMenu" type=
"wxMenuItem" overloaded=
"no">
5929 <autodoc>InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -
> MenuItem
</autodoc>
5931 <param name=
"pos" type=
"size_t" default=
""/>
5932 <param name=
"id" type=
"int" default=
""/>
5933 <param name=
"text" type=
"String" default=
""/>
5934 <param name=
"submenu" type=
"Menu" default=
""/>
5935 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5938 <method name=
"PrependItem" type=
"wxMenuItem" overloaded=
"no">
5939 <autodoc>PrependItem(self, MenuItem item) -
> MenuItem
</autodoc>
5941 <param name=
"item" type=
"wxMenuItem" default=
""/>
5944 <method name=
"Prepend" type=
"wxMenuItem" overloaded=
"no">
5945 <autodoc>Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -
> MenuItem
</autodoc>
5947 <param name=
"id" type=
"int" default=
""/>
5948 <param name=
"text" type=
"String" default=
""/>
5949 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5950 <param name=
"kind" type=
"wxItemKind" default=
"wxITEM_NORMAL"/>
5953 <method name=
"PrependSeparator" type=
"wxMenuItem" overloaded=
"no">
5954 <autodoc>PrependSeparator(self) -
> MenuItem
</autodoc>
5956 <method name=
"PrependCheckItem" type=
"wxMenuItem" overloaded=
"no">
5957 <autodoc>PrependCheckItem(self, int id, String text, String help=EmptyString) -
> MenuItem
</autodoc>
5959 <param name=
"id" type=
"int" default=
""/>
5960 <param name=
"text" type=
"String" default=
""/>
5961 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5964 <method name=
"PrependRadioItem" type=
"wxMenuItem" overloaded=
"no">
5965 <autodoc>PrependRadioItem(self, int id, String text, String help=EmptyString) -
> MenuItem
</autodoc>
5967 <param name=
"id" type=
"int" default=
""/>
5968 <param name=
"text" type=
"String" default=
""/>
5969 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5972 <method name=
"PrependMenu" type=
"wxMenuItem" overloaded=
"no">
5973 <autodoc>PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -
> MenuItem
</autodoc>
5975 <param name=
"id" type=
"int" default=
""/>
5976 <param name=
"text" type=
"String" default=
""/>
5977 <param name=
"submenu" type=
"Menu" default=
""/>
5978 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
5981 <method name=
"Remove" type=
"wxMenuItem" overloaded=
"no">
5982 <autodoc>Remove(self, int id) -
> MenuItem
</autodoc>
5984 <param name=
"id" type=
"int" default=
""/>
5987 <method name=
"RemoveItem" type=
"wxMenuItem" overloaded=
"no">
5988 <autodoc>RemoveItem(self, MenuItem item) -
> MenuItem
</autodoc>
5990 <param name=
"item" type=
"wxMenuItem" default=
""/>
5993 <method name=
"Delete" type=
"bool" overloaded=
"no">
5994 <autodoc>Delete(self, int id) -
> bool
</autodoc>
5996 <param name=
"id" type=
"int" default=
""/>
5999 <method name=
"DeleteItem" type=
"bool" overloaded=
"no">
6000 <autodoc>DeleteItem(self, MenuItem item) -
> bool
</autodoc>
6002 <param name=
"item" type=
"wxMenuItem" default=
""/>
6005 <method name=
"Destroy" type=
"" overloaded=
"no">
6006 <autodoc>Destroy(self)
</autodoc>
6007 <docstring>Deletes the C++ object this Python object is a proxy for.
</docstring>
6009 <method name=
"DestroyId" type=
"bool" overloaded=
"no">
6010 <autodoc>DestroyId(self, int id) -
> bool
</autodoc>
6011 <docstring>Deletes the C++ object this Python object is a proxy for.
</docstring>
6013 <param name=
"id" type=
"int" default=
""/>
6016 <method name=
"DestroyItem" type=
"bool" overloaded=
"no">
6017 <autodoc>DestroyItem(self, MenuItem item) -
> bool
</autodoc>
6018 <docstring>Deletes the C++ object this Python object is a proxy for.
</docstring>
6020 <param name=
"item" type=
"wxMenuItem" default=
""/>
6023 <method name=
"GetMenuItemCount" type=
"size_t" overloaded=
"no">
6024 <autodoc>GetMenuItemCount(self) -
> size_t
</autodoc>
6026 <method name=
"GetMenuItems" type=
"PyObject" overloaded=
"no">
6027 <autodoc>GetMenuItems(self) -
> PyObject
</autodoc>
6029 <method name=
"FindItem" type=
"int" overloaded=
"no">
6030 <autodoc>FindItem(self, String item) -
> int
</autodoc>
6032 <param name=
"item" type=
"String" default=
""/>
6035 <method name=
"FindItemById" type=
"wxMenuItem" overloaded=
"no">
6036 <autodoc>FindItemById(self, int id) -
> MenuItem
</autodoc>
6038 <param name=
"id" type=
"int" default=
""/>
6041 <method name=
"FindItemByPosition" type=
"wxMenuItem" overloaded=
"no">
6042 <autodoc>FindItemByPosition(self, size_t position) -
> MenuItem
</autodoc>
6044 <param name=
"position" type=
"size_t" default=
""/>
6047 <method name=
"Enable" type=
"" overloaded=
"no">
6048 <autodoc>Enable(self, int id, bool enable)
</autodoc>
6050 <param name=
"id" type=
"int" default=
""/>
6051 <param name=
"enable" type=
"bool" default=
""/>
6054 <method name=
"IsEnabled" type=
"bool" overloaded=
"no">
6055 <autodoc>IsEnabled(self, int id) -
> bool
</autodoc>
6057 <param name=
"id" type=
"int" default=
""/>
6060 <method name=
"Check" type=
"" overloaded=
"no">
6061 <autodoc>Check(self, int id, bool check)
</autodoc>
6063 <param name=
"id" type=
"int" default=
""/>
6064 <param name=
"check" type=
"bool" default=
""/>
6067 <method name=
"IsChecked" type=
"bool" overloaded=
"no">
6068 <autodoc>IsChecked(self, int id) -
> bool
</autodoc>
6070 <param name=
"id" type=
"int" default=
""/>
6073 <method name=
"SetLabel" type=
"" overloaded=
"no">
6074 <autodoc>SetLabel(self, int id, String label)
</autodoc>
6076 <param name=
"id" type=
"int" default=
""/>
6077 <param name=
"label" type=
"String" default=
""/>
6080 <method name=
"GetLabel" type=
"String" overloaded=
"no">
6081 <autodoc>GetLabel(self, int id) -
> String
</autodoc>
6083 <param name=
"id" type=
"int" default=
""/>
6086 <method name=
"SetHelpString" type=
"" overloaded=
"no">
6087 <autodoc>SetHelpString(self, int id, String helpString)
</autodoc>
6089 <param name=
"id" type=
"int" default=
""/>
6090 <param name=
"helpString" type=
"String" default=
""/>
6093 <method name=
"GetHelpString" type=
"String" overloaded=
"no">
6094 <autodoc>GetHelpString(self, int id) -
> String
</autodoc>
6096 <param name=
"id" type=
"int" default=
""/>
6099 <method name=
"SetTitle" type=
"" overloaded=
"no">
6100 <autodoc>SetTitle(self, String title)
</autodoc>
6102 <param name=
"title" type=
"String" default=
""/>
6105 <method name=
"GetTitle" type=
"String" overloaded=
"no">
6106 <autodoc>GetTitle(self) -
> String
</autodoc>
6108 <method name=
"SetEventHandler" type=
"" overloaded=
"no">
6109 <autodoc>SetEventHandler(self, EvtHandler handler)
</autodoc>
6111 <param name=
"handler" type=
"EvtHandler" default=
""/>
6114 <method name=
"GetEventHandler" type=
"EvtHandler" overloaded=
"no">
6115 <autodoc>GetEventHandler(self) -
> EvtHandler
</autodoc>
6117 <method name=
"SetInvokingWindow" type=
"" overloaded=
"no">
6118 <autodoc>SetInvokingWindow(self, Window win)
</autodoc>
6120 <param name=
"win" type=
"Window" default=
""/>
6123 <method name=
"GetInvokingWindow" type=
"Window" overloaded=
"no">
6124 <autodoc>GetInvokingWindow(self) -
> Window
</autodoc>
6126 <method name=
"GetStyle" type=
"long" overloaded=
"no">
6127 <autodoc>GetStyle(self) -
> long
</autodoc>
6129 <method name=
"UpdateUI" type=
"" overloaded=
"no">
6130 <autodoc>UpdateUI(self, EvtHandler source=None)
</autodoc>
6132 <param name=
"source" type=
"EvtHandler" default=
"NULL"/>
6135 <method name=
"GetMenuBar" type=
"wxMenuBar" overloaded=
"no">
6136 <autodoc>GetMenuBar(self) -
> MenuBar
</autodoc>
6138 <method name=
"Attach" type=
"" overloaded=
"no">
6139 <autodoc>Attach(self, wxMenuBarBase menubar)
</autodoc>
6141 <param name=
"menubar" type=
"wxMenuBarBase" default=
""/>
6144 <method name=
"Detach" type=
"" overloaded=
"no">
6145 <autodoc>Detach(self)
</autodoc>
6147 <method name=
"IsAttached" type=
"bool" overloaded=
"no">
6148 <autodoc>IsAttached(self) -
> bool
</autodoc>
6150 <method name=
"SetParent" type=
"" overloaded=
"no">
6151 <autodoc>SetParent(self, Menu parent)
</autodoc>
6153 <param name=
"parent" type=
"Menu" default=
""/>
6156 <method name=
"GetParent" type=
"Menu" overloaded=
"no">
6157 <autodoc>GetParent(self) -
> Menu
</autodoc>
6161 #---------------------------------------------------------------------------
6163 <class name=
"MenuBar" oldname=
"wxMenuBar" module=
"_core">
6164 <baseclass name=
"Window"/>
6165 <constructor name=
"MenuBar" overloaded=
"no">
6166 <autodoc>__init__(self, long style=
0) -
> MenuBar
</autodoc>
6168 <param name=
"style" type=
"long" default=
"0"/>
6171 <method name=
"Append" type=
"bool" overloaded=
"no">
6172 <autodoc>Append(self, Menu menu, String title) -
> bool
</autodoc>
6174 <param name=
"menu" type=
"Menu" default=
""/>
6175 <param name=
"title" type=
"String" default=
""/>
6178 <method name=
"Insert" type=
"bool" overloaded=
"no">
6179 <autodoc>Insert(self, size_t pos, Menu menu, String title) -
> bool
</autodoc>
6181 <param name=
"pos" type=
"size_t" default=
""/>
6182 <param name=
"menu" type=
"Menu" default=
""/>
6183 <param name=
"title" type=
"String" default=
""/>
6186 <method name=
"GetMenuCount" type=
"size_t" overloaded=
"no">
6187 <autodoc>GetMenuCount(self) -
> size_t
</autodoc>
6189 <method name=
"GetMenu" type=
"Menu" overloaded=
"no">
6190 <autodoc>GetMenu(self, size_t pos) -
> Menu
</autodoc>
6192 <param name=
"pos" type=
"size_t" default=
""/>
6195 <method name=
"Replace" type=
"Menu" overloaded=
"no">
6196 <autodoc>Replace(self, size_t pos, Menu menu, String title) -
> Menu
</autodoc>
6198 <param name=
"pos" type=
"size_t" default=
""/>
6199 <param name=
"menu" type=
"Menu" default=
""/>
6200 <param name=
"title" type=
"String" default=
""/>
6203 <method name=
"Remove" type=
"Menu" overloaded=
"no">
6204 <autodoc>Remove(self, size_t pos) -
> Menu
</autodoc>
6206 <param name=
"pos" type=
"size_t" default=
""/>
6209 <method name=
"EnableTop" type=
"" overloaded=
"no">
6210 <autodoc>EnableTop(self, size_t pos, bool enable)
</autodoc>
6212 <param name=
"pos" type=
"size_t" default=
""/>
6213 <param name=
"enable" type=
"bool" default=
""/>
6216 <method name=
"IsEnabledTop" type=
"bool" overloaded=
"no">
6217 <autodoc>IsEnabledTop(self, size_t pos) -
> bool
</autodoc>
6219 <param name=
"pos" type=
"size_t" default=
""/>
6222 <method name=
"SetLabelTop" type=
"" overloaded=
"no">
6223 <autodoc>SetLabelTop(self, size_t pos, String label)
</autodoc>
6225 <param name=
"pos" type=
"size_t" default=
""/>
6226 <param name=
"label" type=
"String" default=
""/>
6229 <method name=
"GetLabelTop" type=
"String" overloaded=
"no">
6230 <autodoc>GetLabelTop(self, size_t pos) -
> String
</autodoc>
6232 <param name=
"pos" type=
"size_t" default=
""/>
6235 <method name=
"FindMenuItem" type=
"int" overloaded=
"no">
6236 <autodoc>FindMenuItem(self, String menu, String item) -
> int
</autodoc>
6238 <param name=
"menu" type=
"String" default=
""/>
6239 <param name=
"item" type=
"String" default=
""/>
6242 <method name=
"FindItemById" type=
"wxMenuItem" overloaded=
"no">
6243 <autodoc>FindItemById(self, int id) -
> MenuItem
</autodoc>
6245 <param name=
"id" type=
"int" default=
""/>
6248 <method name=
"FindMenu" type=
"int" overloaded=
"no">
6249 <autodoc>FindMenu(self, String title) -
> int
</autodoc>
6251 <param name=
"title" type=
"String" default=
""/>
6254 <method name=
"Enable" type=
"" overloaded=
"no">
6255 <autodoc>Enable(self, int id, bool enable)
</autodoc>
6257 <param name=
"id" type=
"int" default=
""/>
6258 <param name=
"enable" type=
"bool" default=
""/>
6261 <method name=
"Check" type=
"" overloaded=
"no">
6262 <autodoc>Check(self, int id, bool check)
</autodoc>
6264 <param name=
"id" type=
"int" default=
""/>
6265 <param name=
"check" type=
"bool" default=
""/>
6268 <method name=
"IsChecked" type=
"bool" overloaded=
"no">
6269 <autodoc>IsChecked(self, int id) -
> bool
</autodoc>
6271 <param name=
"id" type=
"int" default=
""/>
6274 <method name=
"IsEnabled" type=
"bool" overloaded=
"no">
6275 <autodoc>IsEnabled(self, int id) -
> bool
</autodoc>
6277 <param name=
"id" type=
"int" default=
""/>
6280 <method name=
"SetLabel" type=
"" overloaded=
"no">
6281 <autodoc>SetLabel(self, int id, String label)
</autodoc>
6283 <param name=
"id" type=
"int" default=
""/>
6284 <param name=
"label" type=
"String" default=
""/>
6287 <method name=
"GetLabel" type=
"String" overloaded=
"no">
6288 <autodoc>GetLabel(self, int id) -
> String
</autodoc>
6290 <param name=
"id" type=
"int" default=
""/>
6293 <method name=
"SetHelpString" type=
"" overloaded=
"no">
6294 <autodoc>SetHelpString(self, int id, String helpString)
</autodoc>
6296 <param name=
"id" type=
"int" default=
""/>
6297 <param name=
"helpString" type=
"String" default=
""/>
6300 <method name=
"GetHelpString" type=
"String" overloaded=
"no">
6301 <autodoc>GetHelpString(self, int id) -
> String
</autodoc>
6303 <param name=
"id" type=
"int" default=
""/>
6306 <method name=
"GetFrame" type=
"wxFrame" overloaded=
"no">
6307 <autodoc>GetFrame(self) -
> wxFrame
</autodoc>
6309 <method name=
"IsAttached" type=
"bool" overloaded=
"no">
6310 <autodoc>IsAttached(self) -
> bool
</autodoc>
6312 <method name=
"Attach" type=
"" overloaded=
"no">
6313 <autodoc>Attach(self, wxFrame frame)
</autodoc>
6315 <param name=
"frame" type=
"wxFrame" default=
""/>
6318 <method name=
"Detach" type=
"" overloaded=
"no">
6319 <autodoc>Detach(self)
</autodoc>
6323 #---------------------------------------------------------------------------
6325 <class name=
"MenuItem" oldname=
"wxMenuItem" module=
"_core">
6326 <baseclass name=
"Object"/>
6327 <constructor name=
"MenuItem" overloaded=
"no">
6328 <autodoc>__init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
6329 String help=EmptyString, int kind=ITEM_NORMAL,
6330 Menu subMenu=None) -
> MenuItem
</autodoc>
6332 <param name=
"parentMenu" type=
"Menu" default=
"NULL"/>
6333 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
6334 <param name=
"text" type=
"String" default=
"wxPyEmptyString"/>
6335 <param name=
"help" type=
"String" default=
"wxPyEmptyString"/>
6336 <param name=
"kind" type=
"wxItemKind" default=
"wxITEM_NORMAL"/>
6337 <param name=
"subMenu" type=
"Menu" default=
"NULL"/>
6340 <method name=
"GetMenu" type=
"Menu" overloaded=
"no">
6341 <autodoc>GetMenu(self) -
> Menu
</autodoc>
6343 <method name=
"SetMenu" type=
"" overloaded=
"no">
6344 <autodoc>SetMenu(self, Menu menu)
</autodoc>
6346 <param name=
"menu" type=
"Menu" default=
""/>
6349 <method name=
"SetId" type=
"" overloaded=
"no">
6350 <autodoc>SetId(self, int id)
</autodoc>
6352 <param name=
"id" type=
"int" default=
""/>
6355 <method name=
"GetId" type=
"int" overloaded=
"no">
6356 <autodoc>GetId(self) -
> int
</autodoc>
6358 <method name=
"IsSeparator" type=
"bool" overloaded=
"no">
6359 <autodoc>IsSeparator(self) -
> bool
</autodoc>
6361 <method name=
"SetText" type=
"" overloaded=
"no">
6362 <autodoc>SetText(self, String str)
</autodoc>
6364 <param name=
"str" type=
"String" default=
""/>
6367 <method name=
"GetLabel" type=
"String" overloaded=
"no">
6368 <autodoc>GetLabel(self) -
> String
</autodoc>
6370 <method name=
"GetText" type=
"String" overloaded=
"no">
6371 <autodoc>GetText(self) -
> String
</autodoc>
6373 <staticmethod name=
"GetLabelFromText" type=
"String" overloaded=
"no">
6374 <autodoc>GetLabelFromText(String text) -
> String
</autodoc>
6376 <param name=
"text" type=
"String" default=
""/>
6379 <method name=
"GetKind" type=
"wxItemKind" overloaded=
"no">
6380 <autodoc>GetKind(self) -
> int
</autodoc>
6382 <method name=
"SetKind" type=
"" overloaded=
"no">
6383 <autodoc>SetKind(self, int kind)
</autodoc>
6385 <param name=
"kind" type=
"wxItemKind" default=
""/>
6388 <method name=
"SetCheckable" type=
"" overloaded=
"no">
6389 <autodoc>SetCheckable(self, bool checkable)
</autodoc>
6391 <param name=
"checkable" type=
"bool" default=
""/>
6394 <method name=
"IsCheckable" type=
"bool" overloaded=
"no">
6395 <autodoc>IsCheckable(self) -
> bool
</autodoc>
6397 <method name=
"IsSubMenu" type=
"bool" overloaded=
"no">
6398 <autodoc>IsSubMenu(self) -
> bool
</autodoc>
6400 <method name=
"SetSubMenu" type=
"" overloaded=
"no">
6401 <autodoc>SetSubMenu(self, Menu menu)
</autodoc>
6403 <param name=
"menu" type=
"Menu" default=
""/>
6406 <method name=
"GetSubMenu" type=
"Menu" overloaded=
"no">
6407 <autodoc>GetSubMenu(self) -
> Menu
</autodoc>
6409 <method name=
"Enable" type=
"" overloaded=
"no">
6410 <autodoc>Enable(self, bool enable=True)
</autodoc>
6412 <param name=
"enable" type=
"bool" default=
"True"/>
6415 <method name=
"IsEnabled" type=
"bool" overloaded=
"no">
6416 <autodoc>IsEnabled(self) -
> bool
</autodoc>
6418 <method name=
"Check" type=
"" overloaded=
"no">
6419 <autodoc>Check(self, bool check=True)
</autodoc>
6421 <param name=
"check" type=
"bool" default=
"True"/>
6424 <method name=
"IsChecked" type=
"bool" overloaded=
"no">
6425 <autodoc>IsChecked(self) -
> bool
</autodoc>
6427 <method name=
"Toggle" type=
"" overloaded=
"no">
6428 <autodoc>Toggle(self)
</autodoc>
6430 <method name=
"SetHelp" type=
"" overloaded=
"no">
6431 <autodoc>SetHelp(self, String str)
</autodoc>
6433 <param name=
"str" type=
"String" default=
""/>
6436 <method name=
"GetHelp" type=
"String" overloaded=
"no">
6437 <autodoc>GetHelp(self) -
> String
</autodoc>
6439 <method name=
"GetAccel" type=
"AcceleratorEntry" overloaded=
"no">
6440 <autodoc>GetAccel(self) -
> AcceleratorEntry
</autodoc>
6442 <method name=
"SetAccel" type=
"" overloaded=
"no">
6443 <autodoc>SetAccel(self, AcceleratorEntry accel)
</autodoc>
6445 <param name=
"accel" type=
"AcceleratorEntry" default=
""/>
6448 <staticmethod name=
"GetDefaultMarginWidth" type=
"int" overloaded=
"no">
6449 <autodoc>GetDefaultMarginWidth() -
> int
</autodoc>
6451 <method name=
"SetBitmap" type=
"" overloaded=
"no">
6452 <autodoc>SetBitmap(self, Bitmap bitmap)
</autodoc>
6454 <param name=
"bitmap" type=
"wxBitmap" default=
""/>
6457 <method name=
"GetBitmap" type=
"wxBitmap" overloaded=
"no">
6458 <autodoc>GetBitmap(self) -
> Bitmap
</autodoc>
6462 #---------------------------------------------------------------------------
6464 <class name=
"Control" oldname=
"wxControl" module=
"_core">
6465 <docstring>This is the base class for a control or 'widget'.
6467 A control is generally a small window which processes user input
6468 and/or displays one or more item of data.
</docstring>
6469 <baseclass name=
"Window"/>
6470 <constructor name=
"Control" overloaded=
"no">
6471 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
6472 Size size=DefaultSize, long style=
0, Validator validator=DefaultValidator,
6473 String name=ControlNameStr) -
> Control
</autodoc>
6474 <docstring>Create a Control. Normally you should only call this from a subclass'
6475 __init__ as a plain old wx.Control is not very useful.
</docstring>
6477 <param name=
"parent" type=
"Window" default=
""/>
6478 <param name=
"id" type=
"int" default=
"-1"/>
6479 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
6480 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
6481 <param name=
"style" type=
"long" default=
"0"/>
6482 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
6483 <param name=
"name" type=
"String" default=
"wxPyControlNameStr"/>
6486 <constructor name=
"PreControl" overloaded=
"no">
6487 <autodoc>PreControl() -
> Control
</autodoc>
6488 <docstring>Precreate a Control control for
2-phase creation
</docstring>
6490 <method name=
"Create" type=
"bool" overloaded=
"no">
6491 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
6492 Size size=DefaultSize, long style=
0, Validator validator=DefaultValidator,
6493 String name=ControlNameStr) -
> bool
</autodoc>
6494 <docstring>Do the
2nd phase and create the GUI control.
</docstring>
6496 <param name=
"parent" type=
"Window" default=
""/>
6497 <param name=
"id" type=
"int" default=
"-1"/>
6498 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
6499 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
6500 <param name=
"style" type=
"long" default=
"0"/>
6501 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
6502 <param name=
"name" type=
"String" default=
"wxPyControlNameStr"/>
6505 <method name=
"Command" type=
"" overloaded=
"no">
6506 <autodoc>Command(self, CommandEvent event)
</autodoc>
6507 <docstring>Simulates the effect of the user issuing a command to the item.
6509 :see: `wx.CommandEvent`
6512 <param name=
"event" type=
"CommandEvent" default=
""/>
6515 <method name=
"GetLabel" type=
"String" overloaded=
"no">
6516 <autodoc>GetLabel(self) -
> String
</autodoc>
6517 <docstring>Return a control's text.
</docstring>
6519 <method name=
"SetLabel" type=
"" overloaded=
"no">
6520 <autodoc>SetLabel(self, String label)
</autodoc>
6521 <docstring>Sets the item's text.
</docstring>
6523 <param name=
"label" type=
"String" default=
""/>
6526 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
6527 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
6528 <docstring>Get the default attributes for this class. This is useful if you want
6529 to use the same font or colour in your own control as in a standard
6530 control -- which is a much better idea than hard coding specific
6531 colours or fonts which might look completely out of place on the
6532 user's system, especially if it uses themes.
6534 The variant parameter is only relevant under Mac currently and is
6535 ignore under other platforms. Under Mac, it will change the size of
6536 the returned font. See `wx.Window.SetWindowVariant` for more about
6539 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
6544 #---------------------------------------------------------------------------
6546 <class name=
"ItemContainer" oldname=
"wxItemContainer" module=
"_core">
6547 <docstring>wx.ItemContainer defines an interface which is implemented by all
6548 controls which have string subitems, each of which may be selected,
6549 such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
6550 `wx.ComboBox` which implements an extended interface deriving from
6553 It defines the methods for accessing the control's items and although
6554 each of the derived classes implements them differently, they still
6555 all conform to the same interface.
6557 The items in a wx.ItemContainer have (non empty) string labels and,
6558 optionally, client data associated with them.
6560 <method name=
"Append" type=
"int" overloaded=
"no">
6561 <autodoc>Append(self, String item, PyObject clientData=None) -
> int
</autodoc>
6562 <docstring>Adds the item to the control, associating the given data with the item
6563 if not None. The return value is the index of the newly added item
6564 which may be different from the last one if the control is sorted (e.g.
6565 has wx.LB_SORT or wx.CB_SORT style).
</docstring>
6567 <param name=
"item" type=
"String" default=
""/>
6568 <param name=
"clientData" type=
"PyObject" default=
"NULL"/>
6571 <method name=
"AppendItems" type=
"" overloaded=
"no">
6572 <autodoc>AppendItems(self, List strings)
</autodoc>
6573 <docstring>Apend several items at once to the control. Notice that calling this
6574 method may be much faster than appending the items one by one if you
6575 need to add a lot of items.
</docstring>
6577 <param name=
"strings" type=
"wxArrayString" default=
""/>
6580 <method name=
"Insert" type=
"int" overloaded=
"no">
6581 <autodoc>Insert(self, String item, int pos, PyObject clientData=None) -
> int
</autodoc>
6582 <docstring>Insert an item into the control before the item at the ``pos`` index,
6583 optionally associating some data object with the item.
</docstring>
6585 <param name=
"item" type=
"String" default=
""/>
6586 <param name=
"pos" type=
"int" default=
""/>
6587 <param name=
"clientData" type=
"PyObject" default=
"NULL"/>
6590 <method name=
"Clear" type=
"" overloaded=
"no">
6591 <autodoc>Clear(self)
</autodoc>
6592 <docstring>Removes all items from the control.
</docstring>
6594 <method name=
"Delete" type=
"" overloaded=
"no">
6595 <autodoc>Delete(self, int n)
</autodoc>
6596 <docstring>Deletes the item at the zero-based index 'n' from the control. Note
6597 that it is an error (signalled by a `wx.PyAssertionError` exception if
6598 enabled) to remove an item with the index negative or greater or equal
6599 than the number of items in the control.
</docstring>
6601 <param name=
"n" type=
"int" default=
""/>
6604 <method name=
"GetCount" type=
"int" overloaded=
"no">
6605 <autodoc>GetCount(self) -
> int
</autodoc>
6606 <docstring>Returns the number of items in the control.
</docstring>
6608 <method name=
"IsEmpty" type=
"bool" overloaded=
"no">
6609 <autodoc>IsEmpty(self) -
> bool
</autodoc>
6610 <docstring>Returns True if the control is empty or False if it has some items.
</docstring>
6612 <method name=
"GetString" type=
"String" overloaded=
"no">
6613 <autodoc>GetString(self, int n) -
> String
</autodoc>
6614 <docstring>Returns the label of the item with the given index.
</docstring>
6616 <param name=
"n" type=
"int" default=
""/>
6619 <method name=
"GetStrings" type=
"wxArrayString" overloaded=
"no">
6620 <autodoc>GetStrings(self) -
> wxArrayString
</autodoc>
6622 <method name=
"SetString" type=
"" overloaded=
"no">
6623 <autodoc>SetString(self, int n, String s)
</autodoc>
6624 <docstring>Sets the label for the given item.
</docstring>
6626 <param name=
"n" type=
"int" default=
""/>
6627 <param name=
"s" type=
"String" default=
""/>
6630 <method name=
"FindString" type=
"int" overloaded=
"no">
6631 <autodoc>FindString(self, String s) -
> int
</autodoc>
6632 <docstring>Finds an item whose label matches the given string. Returns the
6633 zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not
6636 <param name=
"s" type=
"String" default=
""/>
6639 <method name=
"Select" type=
"" overloaded=
"no">
6640 <autodoc>Select(self, int n)
</autodoc>
6641 <docstring>Sets the item at index 'n' to be the selected item.
</docstring>
6643 <param name=
"n" type=
"int" default=
""/>
6646 <method name=
"GetSelection" type=
"int" overloaded=
"no">
6647 <autodoc>GetSelection(self) -
> int
</autodoc>
6648 <docstring>Returns the index of the selected item or ``wx.NOT_FOUND`` if no item
6649 is selected.
</docstring>
6651 <method name=
"GetStringSelection" type=
"String" overloaded=
"no">
6652 <autodoc>GetStringSelection(self) -
> String
</autodoc>
6653 <docstring>Returns the label of the selected item or an empty string if no item
6654 is selected.
</docstring>
6656 <method name=
"GetClientData" type=
"PyObject" overloaded=
"no">
6657 <autodoc>GetClientData(self, int n) -
> PyObject
</autodoc>
6658 <docstring>Returns the client data associated with the given item, (if any.)
</docstring>
6660 <param name=
"n" type=
"int" default=
""/>
6663 <method name=
"SetClientData" type=
"" overloaded=
"no">
6664 <autodoc>SetClientData(self, int n, PyObject clientData)
</autodoc>
6665 <docstring>Associate the given client data with the item at position n.
</docstring>
6667 <param name=
"n" type=
"int" default=
""/>
6668 <param name=
"clientData" type=
"PyObject" default=
""/>
6673 #---------------------------------------------------------------------------
6675 <class name=
"ControlWithItems" oldname=
"wxControlWithItems" module=
"_core">
6676 <docstring>wx.ControlWithItems combines the ``wx.ItemContainer`` class with the
6677 wx.Control class, and is used for the base class of various controls
6678 that have items.
</docstring>
6679 <baseclass name=
"Control"/>
6680 <baseclass name=
"ItemContainer"/>
6683 #---------------------------------------------------------------------------
6685 <class name=
"SizerItem" oldname=
"wxSizerItem" module=
"_core">
6686 <docstring>The wx.SizerItem class is used to track the position, size and other
6687 attributes of each item managed by a `wx.Sizer`. In normal usage user
6688 code should never need to deal directly with a wx.SizerItem, but
6689 custom classes derived from `wx.PySizer` will probably need to use the
6690 collection of wx.SizerItems held by wx.Sizer when calculating layout.
6692 :see: `wx.Sizer`, `wx.GBSizerItem`
</docstring>
6693 <baseclass name=
"Object"/>
6694 <constructor name=
"SizerItem" overloaded=
"no">
6695 <autodoc>__init__(self) -
> SizerItem
</autodoc>
6696 <docstring>Constructs an empty wx.SizerItem. Either a window, sizer or spacer
6697 size will need to be set before this item can be used in a Sizer.
6699 You will probably never need to create a wx.SizerItem directly as they
6700 are created automatically when the sizer's Add, Insert or Prepend
6703 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
</docstring>
6705 <constructor name=
"SizerItemWindow" overloaded=
"no">
6706 <autodoc>SizerItemWindow(Window window, int proportion, int flag, int border,
6707 PyObject userData=None) -
> SizerItem
</autodoc>
6708 <docstring>Constructs a `wx.SizerItem` for tracking a window.
</docstring>
6710 <param name=
"window" type=
"Window" default=
""/>
6711 <param name=
"proportion" type=
"int" default=
""/>
6712 <param name=
"flag" type=
"int" default=
""/>
6713 <param name=
"border" type=
"int" default=
""/>
6714 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
6717 <constructor name=
"SizerItemSpacer" overloaded=
"no">
6718 <autodoc>SizerItemSpacer(int width, int height, int proportion, int flag, int border,
6719 PyObject userData=None) -
> SizerItem
</autodoc>
6720 <docstring>Constructs a `wx.SizerItem` for tracking a spacer.
</docstring>
6722 <param name=
"width" type=
"int" default=
""/>
6723 <param name=
"height" type=
"int" default=
""/>
6724 <param name=
"proportion" type=
"int" default=
""/>
6725 <param name=
"flag" type=
"int" default=
""/>
6726 <param name=
"border" type=
"int" default=
""/>
6727 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
6730 <constructor name=
"SizerItemSizer" overloaded=
"no">
6731 <autodoc>SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
6732 PyObject userData=None) -
> SizerItem
</autodoc>
6733 <docstring>Constructs a `wx.SizerItem` for tracking a subsizer
</docstring>
6735 <param name=
"sizer" type=
"wxSizer" default=
""/>
6736 <param name=
"proportion" type=
"int" default=
""/>
6737 <param name=
"flag" type=
"int" default=
""/>
6738 <param name=
"border" type=
"int" default=
""/>
6739 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
6742 <method name=
"DeleteWindows" type=
"" overloaded=
"no">
6743 <autodoc>DeleteWindows(self)
</autodoc>
6744 <docstring>Destroy the window or the windows in a subsizer, depending on the type
6745 of item.
</docstring>
6747 <method name=
"DetachSizer" type=
"" overloaded=
"no">
6748 <autodoc>DetachSizer(self)
</autodoc>
6749 <docstring>Enable deleting the SizerItem without destroying the contained sizer.
</docstring>
6751 <method name=
"GetSize" type=
"Size" overloaded=
"no">
6752 <autodoc>GetSize(self) -
> Size
</autodoc>
6753 <docstring>Get the current size of the item, as set in the last Layout.
</docstring>
6755 <method name=
"CalcMin" type=
"Size" overloaded=
"no">
6756 <autodoc>CalcMin(self) -
> Size
</autodoc>
6757 <docstring>Calculates the minimum desired size for the item, including any space
6758 needed by borders.
</docstring>
6760 <method name=
"SetDimension" type=
"" overloaded=
"no">
6761 <autodoc>SetDimension(self, Point pos, Size size)
</autodoc>
6762 <docstring>Set the position and size of the space allocated for this item by the
6763 sizer, and adjust the position and size of the item (window or
6764 subsizer) to be within that space taking alignment and borders into
6765 account.
</docstring>
6767 <param name=
"pos" type=
"Point" default=
""/>
6768 <param name=
"size" type=
"Size" default=
""/>
6771 <method name=
"GetMinSize" type=
"Size" overloaded=
"no">
6772 <autodoc>GetMinSize(self) -
> Size
</autodoc>
6773 <docstring>Get the minimum size needed for the item.
</docstring>
6775 <method name=
"GetMinSizeWithBorder" type=
"Size" overloaded=
"no">
6776 <autodoc>GetMinSizeWithBorder(self) -
> Size
</autodoc>
6777 <docstring>Get the minimum size needed for the item with space for the borders
6778 added, if needed.
</docstring>
6780 <method name=
"SetInitSize" type=
"" overloaded=
"no">
6781 <autodoc>SetInitSize(self, int x, int y)
</autodoc>
6783 <param name=
"x" type=
"int" default=
""/>
6784 <param name=
"y" type=
"int" default=
""/>
6787 <method name=
"SetRatioWH" type=
"" overloaded=
"no">
6788 <autodoc>SetRatioWH(self, int width, int height)
</autodoc>
6789 <docstring>Set the ratio item attribute.
</docstring>
6791 <param name=
"width" type=
"int" default=
""/>
6792 <param name=
"height" type=
"int" default=
""/>
6795 <method name=
"SetRatioSize" type=
"" overloaded=
"no">
6796 <autodoc>SetRatioSize(self, Size size)
</autodoc>
6797 <docstring>Set the ratio item attribute.
</docstring>
6799 <param name=
"size" type=
"Size" default=
""/>
6802 <method name=
"SetRatio" type=
"" overloaded=
"no">
6803 <autodoc>SetRatio(self, float ratio)
</autodoc>
6804 <docstring>Set the ratio item attribute.
</docstring>
6806 <param name=
"ratio" type=
"float" default=
""/>
6809 <method name=
"GetRatio" type=
"float" overloaded=
"no">
6810 <autodoc>GetRatio(self) -
> float
</autodoc>
6811 <docstring>Set the ratio item attribute.
</docstring>
6813 <method name=
"IsWindow" type=
"bool" overloaded=
"no">
6814 <autodoc>IsWindow(self) -
> bool
</autodoc>
6815 <docstring>Is this sizer item a window?
</docstring>
6817 <method name=
"IsSizer" type=
"bool" overloaded=
"no">
6818 <autodoc>IsSizer(self) -
> bool
</autodoc>
6819 <docstring>Is this sizer item a subsizer?
</docstring>
6821 <method name=
"IsSpacer" type=
"bool" overloaded=
"no">
6822 <autodoc>IsSpacer(self) -
> bool
</autodoc>
6823 <docstring>Is this sizer item a spacer?
</docstring>
6825 <method name=
"SetProportion" type=
"" overloaded=
"no">
6826 <autodoc>SetProportion(self, int proportion)
</autodoc>
6827 <docstring>Set the proportion value for this item.
</docstring>
6829 <param name=
"proportion" type=
"int" default=
""/>
6832 <method name=
"GetProportion" type=
"int" overloaded=
"no">
6833 <autodoc>GetProportion(self) -
> int
</autodoc>
6834 <docstring>Get the proportion value for this item.
</docstring>
6836 <method name=
"SetFlag" type=
"" overloaded=
"no">
6837 <autodoc>SetFlag(self, int flag)
</autodoc>
6838 <docstring>Set the flag value for this item.
</docstring>
6840 <param name=
"flag" type=
"int" default=
""/>
6843 <method name=
"GetFlag" type=
"int" overloaded=
"no">
6844 <autodoc>GetFlag(self) -
> int
</autodoc>
6845 <docstring>Get the flag value for this item.
</docstring>
6847 <method name=
"SetBorder" type=
"" overloaded=
"no">
6848 <autodoc>SetBorder(self, int border)
</autodoc>
6849 <docstring>Set the border value for this item.
</docstring>
6851 <param name=
"border" type=
"int" default=
""/>
6854 <method name=
"GetBorder" type=
"int" overloaded=
"no">
6855 <autodoc>GetBorder(self) -
> int
</autodoc>
6856 <docstring>Get the border value for this item.
</docstring>
6858 <method name=
"GetWindow" type=
"Window" overloaded=
"no">
6859 <autodoc>GetWindow(self) -
> Window
</autodoc>
6860 <docstring>Get the window (if any) that is managed by this sizer item.
</docstring>
6862 <method name=
"SetWindow" type=
"" overloaded=
"no">
6863 <autodoc>SetWindow(self, Window window)
</autodoc>
6864 <docstring>Set the window to be managed by this sizer item.
</docstring>
6866 <param name=
"window" type=
"Window" default=
""/>
6869 <method name=
"GetSizer" type=
"wxSizer" overloaded=
"no">
6870 <autodoc>GetSizer(self) -
> Sizer
</autodoc>
6871 <docstring>Get the subsizer (if any) that is managed by this sizer item.
</docstring>
6873 <method name=
"SetSizer" type=
"" overloaded=
"no">
6874 <autodoc>SetSizer(self, Sizer sizer)
</autodoc>
6875 <docstring>Set the subsizer to be managed by this sizer item.
</docstring>
6877 <param name=
"sizer" type=
"wxSizer" default=
""/>
6880 <method name=
"GetSpacer" type=
"Size" overloaded=
"no">
6881 <autodoc>GetSpacer(self) -
> Size
</autodoc>
6882 <docstring>Get the size of the spacer managed by this sizer item.
</docstring>
6884 <method name=
"SetSpacer" type=
"" overloaded=
"no">
6885 <autodoc>SetSpacer(self, Size size)
</autodoc>
6886 <docstring>Set the size of the spacer to be managed by this sizer item.
</docstring>
6888 <param name=
"size" type=
"Size" default=
""/>
6891 <method name=
"Show" type=
"" overloaded=
"no">
6892 <autodoc>Show(self, bool show)
</autodoc>
6893 <docstring>Set the show item attribute, which sizers use to determine if the item
6894 is to be made part of the layout or not. If the item is tracking a
6895 window then it is shown or hidden as needed.
</docstring>
6897 <param name=
"show" type=
"bool" default=
""/>
6900 <method name=
"IsShown" type=
"bool" overloaded=
"no">
6901 <autodoc>IsShown(self) -
> bool
</autodoc>
6902 <docstring>Is the item to be shown in the layout?
</docstring>
6904 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
6905 <autodoc>GetPosition(self) -
> Point
</autodoc>
6906 <docstring>Returns the current position of the item, as set in the last Layout.
</docstring>
6908 <method name=
"GetUserData" type=
"PyObject" overloaded=
"no">
6909 <autodoc>GetUserData(self) -
> PyObject
</autodoc>
6910 <docstring>Returns the userData associated with this sizer item, or None if there
6911 isn't any.
</docstring>
6914 <class name=
"Sizer" oldname=
"wxSizer" module=
"_core">
6915 <docstring>wx.Sizer is the abstract base class used for laying out subwindows in
6916 a window. You cannot use wx.Sizer directly; instead, you will have to
6917 use one of the sizer classes derived from it such as `wx.BoxSizer`,
6918 `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
6919 and `wx.GridBagSizer`.
6921 The concept implemented by sizers in wxWidgets is closely related to
6922 layout tools in other GUI toolkits, such as Java's AWT, the GTK
6923 toolkit or the Qt toolkit. It is based upon the idea of the individual
6924 subwindows reporting their minimal required size and their ability to
6925 get stretched if the size of the parent window has changed. This will
6926 most often mean that the programmer does not set the original size of
6927 a dialog in the beginning, rather the dialog will assigned a sizer and
6928 this sizer will be queried about the recommended size. The sizer in
6929 turn will query its children, which can be normal windows or contorls,
6930 empty space or other sizers, so that a hierarchy of sizers can be
6931 constructed. Note that wxSizer does not derive from wxWindow and thus
6932 do not interfere with tab ordering and requires very little resources
6933 compared to a real window on screen.
6935 What makes sizers so well fitted for use in wxWidgets is the fact that
6936 every control reports its own minimal size and the algorithm can
6937 handle differences in font sizes or different window (dialog item)
6938 sizes on different platforms without problems. If for example the
6939 standard font as well as the overall design of Mac widgets requires
6940 more space than on Windows, then the initial size of a dialog using a
6941 sizer will automatically be bigger on Mac than on Windows.
6943 :note: If you wish to create a custom sizer class in wxPython you
6944 should derive the class from `wx.PySizer` in order to get
6945 Python-aware capabilities for the various virtual methods.
6947 :see: `wx.SizerItem`
6949 :todo: More dscriptive text here along with some pictures...
6952 <baseclass name=
"Object"/>
6953 <method name=
"_setOORInfo" type=
"" overloaded=
"no">
6954 <autodoc>_setOORInfo(self, PyObject _self)
</autodoc>
6956 <param name=
"_self" type=
"PyObject" default=
""/>
6959 <method name=
"Add" type=
"" overloaded=
"no">
6960 <autodoc>Add(self, item, int proportion=
0, int flag=
0, int border=
0,
6961 PyObject userData=None)
</autodoc>
6962 <docstring>Appends a child item to the sizer.
6964 :param item: The item can be one of three kinds of objects:
6966 - **window**: A `wx.Window` to be managed by the sizer. Its
6967 minimal size (either set explicitly by the user or
6968 calculated internally when constructed with wx.DefaultSize)
6969 is interpreted as the minimal size to use when laying out
6970 item in the sizer. This is particularly useful in
6971 connection with `wx.Window.SetSizeHints`.
6973 - **sizer**: The (child-)sizer to be added to the sizer. This
6974 allows placing a child sizer in a sizer and thus to create
6975 hierarchies of sizers (typically a vertical box as the top
6976 sizer and several horizontal boxes on the level beneath).
6978 - **size**: A `wx.Size` or a
2-element sequence of integers
6979 that represents the width and height of a spacer to be added
6980 to the sizer. Adding spacers to sizers gives more
6981 flexibility in the design of dialogs; imagine for example a
6982 horizontal box with two buttons at the bottom of a dialog:
6983 you might want to insert a space between the two buttons and
6984 make that space stretchable using the *proportion* value and
6985 the result will be that the left button will be aligned with
6986 the left side of the dialog and the right button with the
6987 right side - the space in between will shrink and grow with
6990 :param proportion: Although the meaning of this parameter is
6991 undefined in wx.Sizer, it is used in `wx.BoxSizer` to indicate
6992 if a child of a sizer can change its size in the main
6993 orientation of the wx.BoxSizer - where
0 stands for not
6994 changeable and a value of more than zero is interpreted
6995 relative (a proportion of the total) to the value of other
6996 children of the same wx.BoxSizer. For example, you might have
6997 a horizontal wx.BoxSizer with three children, two of which are
6998 supposed to change their size with the sizer. Then the two
6999 stretchable windows should each be given *proportion* value of
7000 1 to make them grow and shrink equally with the sizer's
7001 horizontal dimension. But if one of them had a *proportion*
7002 value of
2 then it would get a double share of the space
7003 available after the fixed size items are positioned.
7005 :param flag: This parameter can be used to set a number of flags
7006 which can be combined using the binary OR operator ``|``. Two
7007 main behaviours are defined using these flags. One is the
7008 border around a window: the *border* parameter determines the
7009 border width whereas the flags given here determine which
7010 side(s) of the item that the border will be added. The other
7011 flags determine how the sizer item behaves when the space
7012 allotted to the sizer changes, and is somewhat dependent on
7013 the specific kind of sizer used.
7015 +----------------------------+------------------------------------------+
7016 |- wx.TOP |These flags are used to specify |
7017 |- wx.BOTTOM |which side(s) of the sizer item that |
7018 |- wx.LEFT |the *border* width will apply to. |
7022 +----------------------------+------------------------------------------+
7023 |- wx.EXAPAND |The item will be expanded to fill |
7024 | |the space allotted to the item. |
7025 +----------------------------+------------------------------------------+
7026 |- wx.SHAPED |The item will be expanded as much as |
7027 | |possible while also maintaining its |
7029 +----------------------------+------------------------------------------+
7030 |- wx.FIXED_MINSIZE |Normally wx.Sizers will use |
7031 | |`wx.Window.GetMinSize` or |
7032 | |`wx.Window.GetBestSize` to determine what |
7033 | |the minimal size of window items should |
7034 | |be, and will use that size to calculate |
7035 | |the layout. This allows layouts to adjust |
7036 | |when an item changes and it's best size |
7037 | |becomes different. If you would rather |
7038 | |have a window item stay the size it |
7039 | |started with then use wx.FIXED_MINSIZE. |
7040 +----------------------------+------------------------------------------+
7041 |- wx.ALIGN_CENTER |The wx.ALIGN flags allow you to specify |
7042 |- wx.ALIGN_LEFT |the alignment of the item within the space|
7043 |- wx.ALIGN_RIGHT |allotted to it by the sizer, ajusted for |
7044 |- wx.ALIGN_TOP |the border if any. |
7045 |- wx.ALIGN_BOTTOM | |
7046 |- wx.ALIGN_CENTER_VERTICAL | |
7047 |- wx.ALIGN_CENTER_HORIZONTAL| |
7048 +----------------------------+------------------------------------------+
7051 :param border: Determines the border width, if the *flag*
7052 parameter is set to include any border flag.
7054 :param userData: Allows an extra object to be attached to the
7055 sizer item, for use in derived classes when sizing information
7056 is more complex than the *proportion* and *flag* will allow for.
7059 <param name=
"item" type=
"PyObject" default=
""/>
7060 <param name=
"proportion" type=
"int" default=
"0"/>
7061 <param name=
"flag" type=
"int" default=
"0"/>
7062 <param name=
"border" type=
"int" default=
"0"/>
7063 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
7066 <method name=
"Insert" type=
"" overloaded=
"no">
7067 <autodoc>Insert(self, int before, item, int proportion=
0, int flag=
0, int border=
0,
7068 PyObject userData=None)
</autodoc>
7069 <docstring>Inserts a new item into the list of items managed by this sizer before
7070 the item at index *before*. See `Add` for a description of the parameters.
</docstring>
7072 <param name=
"before" type=
"int" default=
""/>
7073 <param name=
"item" type=
"PyObject" default=
""/>
7074 <param name=
"proportion" type=
"int" default=
"0"/>
7075 <param name=
"flag" type=
"int" default=
"0"/>
7076 <param name=
"border" type=
"int" default=
"0"/>
7077 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
7080 <method name=
"Prepend" type=
"" overloaded=
"no">
7081 <autodoc>Prepend(self, item, int proportion=
0, int flag=
0, int border=
0,
7082 PyObject userData=None)
</autodoc>
7083 <docstring>Adds a new item to the begining of the list of sizer items managed by
7084 this sizer. See `Add` for a description of the parameters.
</docstring>
7086 <param name=
"item" type=
"PyObject" default=
""/>
7087 <param name=
"proportion" type=
"int" default=
"0"/>
7088 <param name=
"flag" type=
"int" default=
"0"/>
7089 <param name=
"border" type=
"int" default=
"0"/>
7090 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
7093 <method name=
"Remove" type=
"bool" overloaded=
"no">
7094 <autodoc>Remove(self, item) -
> bool
</autodoc>
7095 <docstring>Removes an item from the sizer and destroys it. This method does not
7096 cause any layout or resizing to take place, call `Layout` to update
7097 the layout on screen after removing a child from the sizer. The
7098 *item* parameter can be either a window, a sizer, or the zero-based
7099 index of an item to remove. Returns True if the child item was found
7102 :note: For historical reasons calling this method with a `wx.Window`
7103 parameter is depreacted, as it will not be able to destroy the
7104 window since it is owned by its parent. You should use `Detach`
7108 <param name=
"item" type=
"PyObject" default=
""/>
7111 <method name=
"Detach" type=
"bool" overloaded=
"no">
7112 <autodoc>Detach(self, item) -
> bool
</autodoc>
7113 <docstring>Detaches an item from the sizer without destroying it. This method
7114 does not cause any layout or resizing to take place, call `Layout` to
7115 do so. The *item* parameter can be either a window, a sizer, or the
7116 zero-based index of the item to be detached. Returns True if the child item
7117 was found and detached.
</docstring>
7119 <param name=
"item" type=
"PyObject" default=
""/>
7122 <method name=
"_SetItemMinSize" type=
"" overloaded=
"no">
7123 <autodoc>_SetItemMinSize(self, PyObject item, Size size)
</autodoc>
7125 <param name=
"item" type=
"PyObject" default=
""/>
7126 <param name=
"size" type=
"Size" default=
""/>
7129 <method name=
"AddItem" type=
"" overloaded=
"no">
7130 <autodoc>AddItem(self, SizerItem item)
</autodoc>
7131 <docstring>Adds a `wx.SizerItem` to the sizer.
</docstring>
7133 <param name=
"item" type=
"SizerItem" default=
""/>
7136 <method name=
"InsertItem" type=
"" overloaded=
"no">
7137 <autodoc>InsertItem(self, int index, SizerItem item)
</autodoc>
7138 <docstring>Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
</docstring>
7140 <param name=
"index" type=
"size_t" default=
""/>
7141 <param name=
"item" type=
"SizerItem" default=
""/>
7144 <method name=
"PrependItem" type=
"" overloaded=
"no">
7145 <autodoc>PrependItem(self, SizerItem item)
</autodoc>
7146 <docstring>Prepends a `wx.SizerItem` to the sizer.
</docstring>
7148 <param name=
"item" type=
"SizerItem" default=
""/>
7151 <method name=
"SetDimension" type=
"" overloaded=
"no">
7152 <autodoc>SetDimension(self, int x, int y, int width, int height)
</autodoc>
7153 <docstring>Call this to force the sizer to take the given dimension and thus
7154 force the items owned by the sizer to resize themselves according to
7155 the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
7156 methods.
</docstring>
7158 <param name=
"x" type=
"int" default=
""/>
7159 <param name=
"y" type=
"int" default=
""/>
7160 <param name=
"width" type=
"int" default=
""/>
7161 <param name=
"height" type=
"int" default=
""/>
7164 <method name=
"SetMinSize" type=
"" overloaded=
"no">
7165 <autodoc>SetMinSize(self, Size size)
</autodoc>
7166 <docstring>Call this to give the sizer a minimal size. Normally, the sizer will
7167 calculate its minimal size based purely on how much space its children
7168 need. After calling this method `GetMinSize` will return either the
7169 minimal size as requested by its children or the minimal size set
7170 here, depending on which is bigger.
</docstring>
7172 <param name=
"size" type=
"Size" default=
""/>
7175 <method name=
"GetSize" type=
"Size" overloaded=
"no">
7176 <autodoc>GetSize(self) -
> Size
</autodoc>
7177 <docstring>Returns the current size of the space managed by the sizer.
</docstring>
7179 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
7180 <autodoc>GetPosition(self) -
> Point
</autodoc>
7181 <docstring>Returns the current position of the sizer's managed space.
</docstring>
7183 <method name=
"GetMinSize" type=
"Size" overloaded=
"no">
7184 <autodoc>GetMinSize(self) -
> Size
</autodoc>
7185 <docstring>Returns the minimal size of the sizer. This is either the combined
7186 minimal size of all the children and their borders or the minimal size
7187 set by SetMinSize, depending on which is bigger.
</docstring>
7189 <method name=
"RecalcSizes" type=
"" overloaded=
"no">
7190 <autodoc>RecalcSizes(self)
</autodoc>
7191 <docstring>Using the sizes calculated by `CalcMin` reposition and resize all the
7192 items managed by this sizer. You should not need to call this directly as
7193 it is called by `Layout`.
</docstring>
7195 <method name=
"CalcMin" type=
"Size" overloaded=
"no">
7196 <autodoc>CalcMin(self) -
> Size
</autodoc>
7197 <docstring>This method is where the sizer will do the actual calculation of its
7198 children's minimal sizes. You should not need to call this directly as
7199 it is called by `Layout`.
</docstring>
7201 <method name=
"Layout" type=
"" overloaded=
"no">
7202 <autodoc>Layout(self)
</autodoc>
7203 <docstring>This method will force the recalculation and layout of the items
7204 controlled by the sizer using the current space allocated to the
7205 sizer. Normally this is called automatically from the owning window's
7206 EVT_SIZE handler, but it is also useful to call it from user code when
7207 one of the items in a sizer change size, or items are added or
7208 removed.
</docstring>
7210 <method name=
"Fit" type=
"Size" overloaded=
"no">
7211 <autodoc>Fit(self, Window window) -
> Size
</autodoc>
7212 <docstring>Tell the sizer to resize the *window* to match the sizer's minimal
7213 size. This is commonly done in the constructor of the window itself in
7214 order to set its initial size to match the needs of the children as
7215 determined by the sizer. Returns the new size.
7217 For a top level window this is the total window size, not the client size.
</docstring>
7219 <param name=
"window" type=
"Window" default=
""/>
7222 <method name=
"FitInside" type=
"" overloaded=
"no">
7223 <autodoc>FitInside(self, Window window)
</autodoc>
7224 <docstring>Tell the sizer to resize the *virtual size* of the *window* to match the
7225 sizer's minimal size. This will not alter the on screen size of the
7226 window, but may cause the addition/removal/alteration of scrollbars
7227 required to view the virtual area in windows which manage it.
7229 :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
7232 <param name=
"window" type=
"Window" default=
""/>
7235 <method name=
"SetSizeHints" type=
"" overloaded=
"no">
7236 <autodoc>SetSizeHints(self, Window window)
</autodoc>
7237 <docstring>Tell the sizer to set (and `Fit`) the minimal size of the *window* to
7238 match the sizer's minimal size. This is commonly done in the
7239 constructor of the window itself if the window is resizable (as are
7240 many dialogs under Unix and frames on probably all platforms) in order
7241 to prevent the window from being sized smaller than the minimal size
7242 required by the sizer.
</docstring>
7244 <param name=
"window" type=
"Window" default=
""/>
7247 <method name=
"SetVirtualSizeHints" type=
"" overloaded=
"no">
7248 <autodoc>SetVirtualSizeHints(self, Window window)
</autodoc>
7249 <docstring>Tell the sizer to set the minimal size of the window virtual area to
7250 match the sizer's minimal size. For windows with managed scrollbars
7251 this will set them appropriately.
7253 :see: `wx.ScrolledWindow.SetScrollbars`
7256 <param name=
"window" type=
"Window" default=
""/>
7259 <method name=
"Clear" type=
"" overloaded=
"no">
7260 <autodoc>Clear(self, bool deleteWindows=False)
</autodoc>
7261 <docstring>Clear all items from the sizer, optionally destroying the window items
7262 as well.
</docstring>
7264 <param name=
"deleteWindows" type=
"bool" default=
"False"/>
7267 <method name=
"DeleteWindows" type=
"" overloaded=
"no">
7268 <autodoc>DeleteWindows(self)
</autodoc>
7269 <docstring>Destroy all windows managed by the sizer.
</docstring>
7271 <method name=
"GetChildren" type=
"PyObject" overloaded=
"no">
7272 <autodoc>GetChildren(sefl) -
> list
</autodoc>
7273 <docstring>Returns a list of all the `wx.SizerItem` objects managed by the sizer.
</docstring>
7275 <method name=
"Show" type=
"" overloaded=
"no">
7276 <autodoc>Show(self, item, bool show=True)
</autodoc>
7277 <docstring>Shows or hides an item managed by the sizer. To make a sizer item
7278 disappear or reappear, use Show followed by `Layout`. The *item*
7279 parameter can be either a window, a sizer, or the zero-based index of
7280 the item.
</docstring>
7282 <param name=
"item" type=
"PyObject" default=
""/>
7283 <param name=
"show" type=
"bool" default=
"True"/>
7286 <method name=
"IsShown" type=
"bool" overloaded=
"no">
7287 <autodoc>IsShown(self, item)
</autodoc>
7288 <docstring>Determines if the item is currently shown. sizer. To make a sizer
7289 item disappear or reappear, use Show followed by `Layout`. The *item*
7290 parameter can be either a window, a sizer, or the zero-based index of
7291 the item.
</docstring>
7293 <param name=
"item" type=
"PyObject" default=
""/>
7296 <method name=
"ShowItems" type=
"" overloaded=
"no">
7297 <autodoc>ShowItems(self, bool show)
</autodoc>
7298 <docstring>Recursively call `wx.Window.Show` on all sizer items.
</docstring>
7300 <param name=
"show" type=
"bool" default=
""/>
7304 <class name=
"PySizer" oldname=
"wxPySizer" module=
"_core">
7305 <docstring>wx.PySizer is a special version of `wx.Sizer` that has been
7306 instrumented to allow the C++ virtual methods to be overloaded in
7307 Python derived classes. You would derive from this class if you are
7308 wanting to implement a custom sizer in Python code. Simply implement
7309 `CalcMin` and `RecalcSizes` in the derived class and you're all set.
7312 class MySizer(wx.PySizer):
7314 wx.PySizer.__init__(self)
7317 for item in self.GetChildren():
7318 # calculate the total minimum width and height needed
7319 # by all items in the sizer according to this sizer's
7322 return wx.Size(width, height)
7324 def RecalcSizes(self):
7325 # find the space allotted to this sizer
7326 pos = self.GetPosition()
7327 size = self.GetSize()
7328 for item in self.GetChildren():
7329 # Recalculate (if necessary) the position and size of
7330 # each item and then call item.SetDimension to do the
7331 # actual positioning and sizing of the items within the
7332 # space alloted to this sizer.
7334 item.SetDimension(itemPos, itemSize)
7337 When `Layout` is called it first calls `CalcMin` followed by
7338 `RecalcSizes` so you can optimize a bit by saving the results of
7339 `CalcMin` and resuing them in `RecalcSizes`.
7341 :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
7344 <baseclass name=
"Sizer"/>
7345 <constructor name=
"PySizer" overloaded=
"no">
7346 <autodoc>__init__(self) -
> PySizer
</autodoc>
7347 <docstring>Creates a wx.PySizer. Must be called from the __init__ in the derived
7350 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
7351 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
7353 <param name=
"self" type=
"PyObject" default=
""/>
7354 <param name=
"_class" type=
"PyObject" default=
""/>
7359 #---------------------------------------------------------------------------
7361 <class name=
"BoxSizer" oldname=
"wxBoxSizer" module=
"_core">
7362 <docstring>The basic idea behind a box sizer is that windows will most often be
7363 laid out in rather simple basic geometry, typically in a row or a
7364 column or nested hierarchies of either. A wx.BoxSizer will lay out
7365 its items in a simple row or column, depending on the orientation
7366 parameter passed to the constructor.
7368 It is the unique feature of a box sizer, that it can grow in both
7369 directions (height and width) but can distribute its growth in the
7370 main direction (horizontal for a row) *unevenly* among its children.
7371 This is determined by the proportion parameter give to items when they
7372 are added to the sizer. It is interpreted as a weight factor, i.e. it
7373 can be zero, indicating that the window may not be resized at all, or
7374 above zero. If several windows have a value above zero, the value is
7375 interpreted relative to the sum of all weight factors of the sizer, so
7376 when adding two windows with a value of
1, they will both get resized
7377 equally and each will receive half of the available space after the
7378 fixed size items have been sized. If the items have unequal
7379 proportion settings then they will receive a coresondingly unequal
7380 allotment of the free space.
7382 :see: `wx.StaticBoxSizer`
7384 <baseclass name=
"Sizer"/>
7385 <constructor name=
"BoxSizer" overloaded=
"no">
7386 <autodoc>__init__(self, int orient=HORIZONTAL) -
> BoxSizer
</autodoc>
7387 <docstring>Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
7388 or ``wx.HORIZONTAL`` for creating either a column sizer or a row
7391 <param name=
"orient" type=
"int" default=
"wxHORIZONTAL"/>
7394 <method name=
"GetOrientation" type=
"int" overloaded=
"no">
7395 <autodoc>GetOrientation(self) -
> int
</autodoc>
7396 <docstring>Returns the current orientation of the sizer.
</docstring>
7398 <method name=
"SetOrientation" type=
"" overloaded=
"no">
7399 <autodoc>SetOrientation(self, int orient)
</autodoc>
7400 <docstring>Resets the orientation of the sizer.
</docstring>
7402 <param name=
"orient" type=
"int" default=
""/>
7407 #---------------------------------------------------------------------------
7409 <class name=
"StaticBoxSizer" oldname=
"wxStaticBoxSizer" module=
"_core">
7410 <docstring>wx.StaticBoxSizer derives from and functions identically to the
7411 `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
7412 manages. Note that this static box must be created separately and
7413 passed to the sizer constructor.
</docstring>
7414 <baseclass name=
"BoxSizer"/>
7415 <constructor name=
"StaticBoxSizer" overloaded=
"no">
7416 <autodoc>__init__(self, StaticBox box, int orient=HORIZONTAL) -
> StaticBoxSizer
</autodoc>
7417 <docstring>Constructor. It takes an associated static box and the orientation
7418 *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
7419 ``wx.HORIZONTAL``.
</docstring>
7421 <param name=
"box" type=
"wxStaticBox" default=
""/>
7422 <param name=
"orient" type=
"int" default=
"wxHORIZONTAL"/>
7425 <method name=
"GetStaticBox" type=
"wxStaticBox" overloaded=
"no">
7426 <autodoc>GetStaticBox(self) -
> StaticBox
</autodoc>
7427 <docstring>Returns the static box associated with this sizer.
</docstring>
7431 #---------------------------------------------------------------------------
7433 <class name=
"GridSizer" oldname=
"wxGridSizer" module=
"_core">
7434 <docstring>A grid sizer is a sizer which lays out its children in a
7435 two-dimensional table with all cells having the same size. In other
7436 words, the width of each cell within the grid is the width of the
7437 widest item added to the sizer and the height of each grid cell is the
7438 height of the tallest item. An optional vertical and/or horizontal
7439 gap between items can also be specified (in pixels.)
7441 Items are placed in the cells of the grid in the order they are added,
7442 in row-major order. In other words, the first row is filled first,
7443 then the second, and so on until all items have been added. (If
7444 neccessary, additional rows will be added as items are added.) If you
7445 need to have greater control over the cells that items are placed in
7446 then use the `wx.GridBagSizer`.
7448 <baseclass name=
"Sizer"/>
7449 <constructor name=
"GridSizer" overloaded=
"no">
7450 <autodoc>__init__(self, int rows=
1, int cols=
0, int vgap=
0, int hgap=
0) -
> GridSizer
</autodoc>
7451 <docstring>Constructor for a wx.GridSizer. *rows* and *cols* determine the number
7452 of columns and rows in the sizer - if either of the parameters is
7453 zero, it will be calculated to from the total number of children in
7454 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
7455 define extra space between all children.
</docstring>
7457 <param name=
"rows" type=
"int" default=
"1"/>
7458 <param name=
"cols" type=
"int" default=
"0"/>
7459 <param name=
"vgap" type=
"int" default=
"0"/>
7460 <param name=
"hgap" type=
"int" default=
"0"/>
7463 <method name=
"SetCols" type=
"" overloaded=
"no">
7464 <autodoc>SetCols(self, int cols)
</autodoc>
7465 <docstring>Sets the number of columns in the sizer.
</docstring>
7467 <param name=
"cols" type=
"int" default=
""/>
7470 <method name=
"SetRows" type=
"" overloaded=
"no">
7471 <autodoc>SetRows(self, int rows)
</autodoc>
7472 <docstring>Sets the number of rows in the sizer.
</docstring>
7474 <param name=
"rows" type=
"int" default=
""/>
7477 <method name=
"SetVGap" type=
"" overloaded=
"no">
7478 <autodoc>SetVGap(self, int gap)
</autodoc>
7479 <docstring>Sets the vertical gap (in pixels) between the cells in the sizer.
</docstring>
7481 <param name=
"gap" type=
"int" default=
""/>
7484 <method name=
"SetHGap" type=
"" overloaded=
"no">
7485 <autodoc>SetHGap(self, int gap)
</autodoc>
7486 <docstring>Sets the horizontal gap (in pixels) between cells in the sizer
</docstring>
7488 <param name=
"gap" type=
"int" default=
""/>
7491 <method name=
"GetCols" type=
"int" overloaded=
"no">
7492 <autodoc>GetCols(self) -
> int
</autodoc>
7493 <docstring>Returns the number of columns in the sizer.
</docstring>
7495 <method name=
"GetRows" type=
"int" overloaded=
"no">
7496 <autodoc>GetRows(self) -
> int
</autodoc>
7497 <docstring>Returns the number of rows in the sizer.
</docstring>
7499 <method name=
"GetVGap" type=
"int" overloaded=
"no">
7500 <autodoc>GetVGap(self) -
> int
</autodoc>
7501 <docstring>Returns the vertical gap (in pixels) between the cells in the sizer.
</docstring>
7503 <method name=
"GetHGap" type=
"int" overloaded=
"no">
7504 <autodoc>GetHGap(self) -
> int
</autodoc>
7505 <docstring>Returns the horizontal gap (in pixels) between cells in the sizer.
</docstring>
7509 #---------------------------------------------------------------------------
7511 <class name=
"FlexGridSizer" oldname=
"wxFlexGridSizer" module=
"_core">
7512 <docstring>A flex grid sizer is a sizer which lays out its children in a
7513 two-dimensional table with all table cells in one row having the same
7514 height and all cells in one column having the same width, but all
7515 rows or all columns are not necessarily the same height or width as in
7518 wx.FlexGridSizer can also size items equally in one direction but
7519 unequally ("flexibly") in the other. If the sizer is only flexible
7520 in one direction (this can be changed using `SetFlexibleDirection`), it
7521 needs to be decided how the sizer should grow in the other ("non
7522 flexible") direction in order to fill the available space. The
7523 `SetNonFlexibleGrowMode` method serves this purpose.
7526 <baseclass name=
"GridSizer"/>
7527 <constructor name=
"FlexGridSizer" overloaded=
"no">
7528 <autodoc>__init__(self, int rows=
1, int cols=
0, int vgap=
0, int hgap=
0) -
> FlexGridSizer
</autodoc>
7529 <docstring>Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
7530 number of columns and rows in the sizer - if either of the parameters
7531 is zero, it will be calculated to from the total number of children in
7532 the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
7533 define extra space between all children.
</docstring>
7535 <param name=
"rows" type=
"int" default=
"1"/>
7536 <param name=
"cols" type=
"int" default=
"0"/>
7537 <param name=
"vgap" type=
"int" default=
"0"/>
7538 <param name=
"hgap" type=
"int" default=
"0"/>
7541 <method name=
"AddGrowableRow" type=
"" overloaded=
"no">
7542 <autodoc>AddGrowableRow(self, size_t idx, int proportion=
0)
</autodoc>
7543 <docstring>Specifies that row *idx* (starting from zero) should be grown if there
7544 is extra space available to the sizer.
7546 The *proportion* parameter has the same meaning as the stretch factor
7547 for the box sizers except that if all proportions are
0, then all
7548 columns are resized equally (instead of not being resized at all).
</docstring>
7550 <param name=
"idx" type=
"size_t" default=
""/>
7551 <param name=
"proportion" type=
"int" default=
"0"/>
7554 <method name=
"RemoveGrowableRow" type=
"" overloaded=
"no">
7555 <autodoc>RemoveGrowableRow(self, size_t idx)
</autodoc>
7556 <docstring>Specifies that row *idx* is no longer growable.
</docstring>
7558 <param name=
"idx" type=
"size_t" default=
""/>
7561 <method name=
"AddGrowableCol" type=
"" overloaded=
"no">
7562 <autodoc>AddGrowableCol(self, size_t idx, int proportion=
0)
</autodoc>
7563 <docstring>Specifies that column *idx* (starting from zero) should be grown if
7564 there is extra space available to the sizer.
7566 The *proportion* parameter has the same meaning as the stretch factor
7567 for the box sizers except that if all proportions are
0, then all
7568 columns are resized equally (instead of not being resized at all).
</docstring>
7570 <param name=
"idx" type=
"size_t" default=
""/>
7571 <param name=
"proportion" type=
"int" default=
"0"/>
7574 <method name=
"RemoveGrowableCol" type=
"" overloaded=
"no">
7575 <autodoc>RemoveGrowableCol(self, size_t idx)
</autodoc>
7576 <docstring>Specifies that column *idx* is no longer growable.
</docstring>
7578 <param name=
"idx" type=
"size_t" default=
""/>
7581 <method name=
"SetFlexibleDirection" type=
"" overloaded=
"no">
7582 <autodoc>SetFlexibleDirection(self, int direction)
</autodoc>
7583 <docstring>Specifies whether the sizer should flexibly resize its columns, rows,
7584 or both. Argument *direction* can be one of the following values. Any
7585 other value is ignored.
7587 ============== =======================================
7588 wx.VERTICAL Rows are flexibly sized.
7589 wx.HORIZONTAL Columns are flexibly sized.
7590 wx.BOTH Both rows and columns are flexibly sized
7591 (this is the default value).
7592 ============== =======================================
7594 Note that this method does not trigger relayout.
7597 <param name=
"direction" type=
"int" default=
""/>
7600 <method name=
"GetFlexibleDirection" type=
"int" overloaded=
"no">
7601 <autodoc>GetFlexibleDirection(self) -
> int
</autodoc>
7602 <docstring>Returns a value that specifies whether the sizer
7603 flexibly resizes its columns, rows, or both (default).
7605 :see: `SetFlexibleDirection`
</docstring>
7607 <method name=
"SetNonFlexibleGrowMode" type=
"" overloaded=
"no">
7608 <autodoc>SetNonFlexibleGrowMode(self, int mode)
</autodoc>
7609 <docstring>Specifies how the sizer should grow in the non-flexible direction if
7610 there is one (so `SetFlexibleDirection` must have been called
7611 previously). Argument *mode* can be one of the following values:
7613 ========================== =================================================
7614 wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
7615 wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
7616 `AddGrowableCol` and `AddGrowableRow`. In this
7617 case equal sizing applies to minimum sizes of
7618 columns or rows (this is the default value).
7619 wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
7620 the non flexible direction, whether they are
7621 growable or not in the flexbile direction.
7622 ========================== =================================================
7624 Note that this method does not trigger relayout.
7628 <param name=
"mode" type=
"wxFlexSizerGrowMode" default=
""/>
7631 <method name=
"GetNonFlexibleGrowMode" type=
"wxFlexSizerGrowMode" overloaded=
"no">
7632 <autodoc>GetNonFlexibleGrowMode(self) -
> int
</autodoc>
7633 <docstring>Returns the value that specifies how the sizer grows in the
7634 non-flexible direction if there is one.
7636 :see: `SetNonFlexibleGrowMode`
</docstring>
7638 <method name=
"GetRowHeights" type=
"wxArrayInt" overloaded=
"no">
7639 <autodoc>GetRowHeights(self) -
> list
</autodoc>
7640 <docstring>Returns a list of integers representing the heights of each of the
7641 rows in the sizer.
</docstring>
7643 <method name=
"GetColWidths" type=
"wxArrayInt" overloaded=
"no">
7644 <autodoc>GetColWidths(self) -
> list
</autodoc>
7645 <docstring>Returns a list of integers representing the widths of each of the
7646 columns in the sizer.
</docstring>
7650 #---------------------------------------------------------------------------
7652 <class name=
"GBPosition" oldname=
"wxGBPosition" module=
"_core">
7653 <docstring>This class represents the position of an item in a virtual grid of
7654 rows and columns managed by a `wx.GridBagSizer`. wxPython has
7655 typemaps that will automatically convert from a
2-element sequence of
7656 integers to a wx.GBPosition, so you can use the more pythonic
7657 representation of the position nearly transparently in Python code.
</docstring>
7658 <constructor name=
"GBPosition" overloaded=
"no">
7659 <autodoc>__init__(self, int row=
0, int col=
0) -
> GBPosition
</autodoc>
7660 <docstring>This class represents the position of an item in a virtual grid of
7661 rows and columns managed by a `wx.GridBagSizer`. wxPython has
7662 typemaps that will automatically convert from a
2-element sequence of
7663 integers to a wx.GBPosition, so you can use the more pythonic
7664 representation of the position nearly transparently in Python code.
</docstring>
7666 <param name=
"row" type=
"int" default=
"0"/>
7667 <param name=
"col" type=
"int" default=
"0"/>
7670 <method name=
"GetRow" type=
"int" overloaded=
"no">
7671 <autodoc>GetRow(self) -
> int
</autodoc>
7673 <method name=
"GetCol" type=
"int" overloaded=
"no">
7674 <autodoc>GetCol(self) -
> int
</autodoc>
7676 <method name=
"SetRow" type=
"" overloaded=
"no">
7677 <autodoc>SetRow(self, int row)
</autodoc>
7679 <param name=
"row" type=
"int" default=
""/>
7682 <method name=
"SetCol" type=
"" overloaded=
"no">
7683 <autodoc>SetCol(self, int col)
</autodoc>
7685 <param name=
"col" type=
"int" default=
""/>
7688 <method name=
"__eq__" type=
"bool" overloaded=
"no">
7689 <autodoc>__eq__(self, GBPosition other) -
> bool
</autodoc>
7691 <param name=
"other" type=
"GBPosition" default=
""/>
7694 <method name=
"__ne__" type=
"bool" overloaded=
"no">
7695 <autodoc>__ne__(self, GBPosition other) -
> bool
</autodoc>
7697 <param name=
"other" type=
"GBPosition" default=
""/>
7700 <method name=
"Set" type=
"" overloaded=
"no">
7701 <autodoc>Set(self, int row=
0, int col=
0)
</autodoc>
7703 <param name=
"row" type=
"int" default=
"0"/>
7704 <param name=
"col" type=
"int" default=
"0"/>
7707 <method name=
"Get" type=
"PyObject" overloaded=
"no">
7708 <autodoc>Get(self) -
> PyObject
</autodoc>
7711 <class name=
"GBSpan" oldname=
"wxGBSpan" module=
"_core">
7712 <docstring>This class is used to hold the row and column spanning attributes of
7713 items in a `wx.GridBagSizer`. wxPython has typemaps that will
7714 automatically convert from a
2-element sequence of integers to a
7715 wx.GBSpan, so you can use the more pythonic representation of the span
7716 nearly transparently in Python code.
7718 <constructor name=
"GBSpan" overloaded=
"no">
7719 <autodoc>__init__(self, int rowspan=
1, int colspan=
1) -
> GBSpan
</autodoc>
7720 <docstring>Construct a new wxGBSpan, optionally setting the rowspan and
7721 colspan. The default is (
1,
1). (Meaning that the item occupies one
7722 cell in each direction.
</docstring>
7724 <param name=
"rowspan" type=
"int" default=
"1"/>
7725 <param name=
"colspan" type=
"int" default=
"1"/>
7728 <method name=
"GetRowspan" type=
"int" overloaded=
"no">
7729 <autodoc>GetRowspan(self) -
> int
</autodoc>
7731 <method name=
"GetColspan" type=
"int" overloaded=
"no">
7732 <autodoc>GetColspan(self) -
> int
</autodoc>
7734 <method name=
"SetRowspan" type=
"" overloaded=
"no">
7735 <autodoc>SetRowspan(self, int rowspan)
</autodoc>
7737 <param name=
"rowspan" type=
"int" default=
""/>
7740 <method name=
"SetColspan" type=
"" overloaded=
"no">
7741 <autodoc>SetColspan(self, int colspan)
</autodoc>
7743 <param name=
"colspan" type=
"int" default=
""/>
7746 <method name=
"__eq__" type=
"bool" overloaded=
"no">
7747 <autodoc>__eq__(self, GBSpan other) -
> bool
</autodoc>
7749 <param name=
"other" type=
"GBSpan" default=
""/>
7752 <method name=
"__ne__" type=
"bool" overloaded=
"no">
7753 <autodoc>__ne__(self, GBSpan other) -
> bool
</autodoc>
7755 <param name=
"other" type=
"GBSpan" default=
""/>
7758 <method name=
"Set" type=
"" overloaded=
"no">
7759 <autodoc>Set(self, int rowspan=
1, int colspan=
1)
</autodoc>
7761 <param name=
"rowspan" type=
"int" default=
"1"/>
7762 <param name=
"colspan" type=
"int" default=
"1"/>
7765 <method name=
"Get" type=
"PyObject" overloaded=
"no">
7766 <autodoc>Get(self) -
> PyObject
</autodoc>
7769 <class name=
"GBSizerItem" oldname=
"wxGBSizerItem" module=
"_core">
7770 <docstring>The wx.GBSizerItem class is used to track the additional data about
7771 items in a `wx.GridBagSizer` such as the item's position in the grid
7772 and how many rows or columns it spans.
7774 <baseclass name=
"SizerItem"/>
7775 <constructor name=
"GBSizerItem" overloaded=
"no">
7776 <autodoc>__init__(self) -
> GBSizerItem
</autodoc>
7777 <docstring>Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
7778 size will need to be set, as well as a position and span before this
7779 item can be used in a Sizer.
7781 You will probably never need to create a wx.GBSizerItem directly as they
7782 are created automatically when the sizer's Add method is called.
</docstring>
7784 <constructor name=
"GBSizerItemWindow" overloaded=
"no">
7785 <autodoc>GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
7786 int border, PyObject userData=None) -
> GBSizerItem
</autodoc>
7787 <docstring>Construct a `wx.GBSizerItem` for a window.
</docstring>
7789 <param name=
"window" type=
"Window" default=
""/>
7790 <param name=
"pos" type=
"GBPosition" default=
""/>
7791 <param name=
"span" type=
"GBSpan" default=
""/>
7792 <param name=
"flag" type=
"int" default=
""/>
7793 <param name=
"border" type=
"int" default=
""/>
7794 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
7797 <constructor name=
"GBSizerItemSizer" overloaded=
"no">
7798 <autodoc>GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
7799 int border, PyObject userData=None) -
> GBSizerItem
</autodoc>
7800 <docstring>Construct a `wx.GBSizerItem` for a sizer
</docstring>
7802 <param name=
"sizer" type=
"Sizer" default=
""/>
7803 <param name=
"pos" type=
"GBPosition" default=
""/>
7804 <param name=
"span" type=
"GBSpan" default=
""/>
7805 <param name=
"flag" type=
"int" default=
""/>
7806 <param name=
"border" type=
"int" default=
""/>
7807 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
7810 <constructor name=
"GBSizerItemSpacer" overloaded=
"no">
7811 <autodoc>GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
7812 int flag, int border, PyObject userData=None) -
> GBSizerItem
</autodoc>
7813 <docstring>Construct a `wx.GBSizerItem` for a spacer.
</docstring>
7815 <param name=
"width" type=
"int" default=
""/>
7816 <param name=
"height" type=
"int" default=
""/>
7817 <param name=
"pos" type=
"GBPosition" default=
""/>
7818 <param name=
"span" type=
"GBSpan" default=
""/>
7819 <param name=
"flag" type=
"int" default=
""/>
7820 <param name=
"border" type=
"int" default=
""/>
7821 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
7824 <method name=
"GetPos" type=
"GBPosition" overloaded=
"no">
7825 <autodoc>GetPos(self) -
> GBPosition
</autodoc>
7826 <docstring>Get the grid position of the item
</docstring>
7828 <method name=
"GetSpan" type=
"GBSpan" overloaded=
"no">
7829 <autodoc>GetSpan(self) -
> GBSpan
</autodoc>
7830 <docstring>Get the row and column spanning of the item
</docstring>
7832 <method name=
"SetPos" type=
"bool" overloaded=
"no">
7833 <autodoc>SetPos(self, GBPosition pos) -
> bool
</autodoc>
7834 <docstring>If the item is already a member of a sizer then first ensure that
7835 there is no other item that would intersect with this one at the new
7836 position, then set the new position. Returns True if the change is
7837 successful and after the next Layout() the item will be moved.
</docstring>
7839 <param name=
"pos" type=
"GBPosition" default=
""/>
7842 <method name=
"SetSpan" type=
"bool" overloaded=
"no">
7843 <autodoc>SetSpan(self, GBSpan span) -
> bool
</autodoc>
7844 <docstring>If the item is already a member of a sizer then first ensure that
7845 there is no other item that would intersect with this one with its new
7846 spanning size, then set the new spanning. Returns True if the change
7847 is successful and after the next Layout() the item will be resized.
7850 <param name=
"span" type=
"GBSpan" default=
""/>
7853 <method name=
"Intersects" type=
"bool" overloaded=
"no">
7854 <autodoc>Intersects(self, GBSizerItem other) -
> bool
</autodoc>
7855 <docstring>Returns True if this item and the other item instersect.
</docstring>
7857 <param name=
"other" type=
"GBSizerItem" default=
""/>
7860 <method name=
"IntersectsPos" type=
"bool" overloaded=
"no">
7861 <autodoc>IntersectsPos(self, GBPosition pos, GBSpan span) -
> bool
</autodoc>
7862 <docstring>Returns True if the given pos/span would intersect with this item.
</docstring>
7864 <param name=
"pos" type=
"GBPosition" default=
""/>
7865 <param name=
"span" type=
"GBSpan" default=
""/>
7868 <method name=
"GetEndPos" type=
"GBPosition" overloaded=
"no">
7869 <autodoc>GetEndPos(self) -
> GBPosition
</autodoc>
7870 <docstring>Get the row and column of the endpoint of this item.
</docstring>
7872 <method name=
"GetGBSizer" type=
"wxGridBagSizer" overloaded=
"no">
7873 <autodoc>GetGBSizer(self) -
> GridBagSizer
</autodoc>
7874 <docstring>Get the sizer this item is a member of.
</docstring>
7876 <method name=
"SetGBSizer" type=
"" overloaded=
"no">
7877 <autodoc>SetGBSizer(self, GridBagSizer sizer)
</autodoc>
7878 <docstring>Set the sizer this item is a member of.
</docstring>
7880 <param name=
"sizer" type=
"wxGridBagSizer" default=
""/>
7884 <class name=
"GridBagSizer" oldname=
"wxGridBagSizer" module=
"_core">
7885 <docstring>A `wx.Sizer` that can lay out items in a virtual grid like a
7886 `wx.FlexGridSizer` but in this case explicit positioning of the items
7887 is allowed using `wx.GBPosition`, and items can optionally span more
7888 than one row and/or column using `wx.GBSpan`. The total size of the
7889 virtual grid is determined by the largest row and column that items are
7890 positioned at, adjusted for spanning.
7892 <baseclass name=
"FlexGridSizer"/>
7893 <constructor name=
"GridBagSizer" overloaded=
"no">
7894 <autodoc>__init__(self, int vgap=
0, int hgap=
0) -
> GridBagSizer
</autodoc>
7895 <docstring>Constructor, with optional parameters to specify the gap between the
7896 rows and columns.
</docstring>
7898 <param name=
"vgap" type=
"int" default=
"0"/>
7899 <param name=
"hgap" type=
"int" default=
"0"/>
7902 <method name=
"Add" type=
"bool" overloaded=
"no">
7903 <autodoc>Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=
0,
7904 int border=
0, userData=None)
</autodoc>
7905 <docstring>Adds an item to the sizer at the grid cell *pos*, optionally spanning
7906 more than one row or column as specified with *span*. The remaining
7907 args behave similarly to `wx.Sizer.Add`.
7909 Returns True if the item was successfully placed at the given cell
7910 position, False if something was already there.
7913 <param name=
"item" type=
"PyObject" default=
""/>
7914 <param name=
"pos" type=
"GBPosition" default=
""/>
7915 <param name=
"span" type=
"GBSpan" default=
"wxDefaultSpan"/>
7916 <param name=
"flag" type=
"int" default=
"0"/>
7917 <param name=
"border" type=
"int" default=
"0"/>
7918 <param name=
"userData" type=
"PyObject" default=
"NULL"/>
7921 <method name=
"AddItem" type=
"bool" overloaded=
"no">
7922 <autodoc>Add(self, GBSizerItem item) -
> bool
</autodoc>
7923 <docstring>Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
7924 the item was successfully placed at its given cell position, False if
7925 something was already there.
</docstring>
7927 <param name=
"item" type=
"GBSizerItem" default=
""/>
7930 <method name=
"GetEmptyCellSize" type=
"Size" overloaded=
"no">
7931 <autodoc>GetEmptyCellSize(self) -
> Size
</autodoc>
7932 <docstring>Get the size used for cells in the grid with no item.
</docstring>
7934 <method name=
"SetEmptyCellSize" type=
"" overloaded=
"no">
7935 <autodoc>SetEmptyCellSize(self, Size sz)
</autodoc>
7936 <docstring>Set the size used for cells in the grid with no item.
</docstring>
7938 <param name=
"sz" type=
"Size" default=
""/>
7941 <method name=
"GetItemPosition" type=
"GBPosition" overloaded=
"yes">
7942 <docstring>GetItemPosition(self, item) -
> GBPosition
7944 Get the grid position of the specified *item* where *item* is either a
7945 window or subsizer that is a member of this sizer, or a zero-based
7946 index of an item.
</docstring>
7948 <param name=
"window" type=
"Window" default=
""/>
7951 <method name=
"GetItemPosition" type=
"GBPosition" overloaded=
"yes">
7952 <docstring>GetItemPosition(self, item) -
> GBPosition
7954 Get the grid position of the specified *item* where *item* is either a
7955 window or subsizer that is a member of this sizer, or a zero-based
7956 index of an item.
</docstring>
7958 <param name=
"sizer" type=
"Sizer" default=
""/>
7961 <method name=
"GetItemPosition" type=
"GBPosition" overloaded=
"yes">
7962 <docstring>GetItemPosition(self, item) -
> GBPosition
7964 Get the grid position of the specified *item* where *item* is either a
7965 window or subsizer that is a member of this sizer, or a zero-based
7966 index of an item.
</docstring>
7968 <param name=
"index" type=
"size_t" default=
""/>
7971 <method name=
"SetItemPosition" type=
"bool" overloaded=
"yes">
7972 <docstring>SetItemPosition(self, item, GBPosition pos) -
> bool
7974 Set the grid position of the specified *item* where *item* is either a
7975 window or subsizer that is a member of this sizer, or a zero-based
7976 index of an item. Returns True on success. If the move is not
7977 allowed (because an item is already there) then False is returned.
7980 <param name=
"window" type=
"Window" default=
""/>
7981 <param name=
"pos" type=
"GBPosition" default=
""/>
7984 <method name=
"SetItemPosition" type=
"bool" overloaded=
"yes">
7985 <docstring>SetItemPosition(self, item, GBPosition pos) -
> bool
7987 Set the grid position of the specified *item* where *item* is either a
7988 window or subsizer that is a member of this sizer, or a zero-based
7989 index of an item. Returns True on success. If the move is not
7990 allowed (because an item is already there) then False is returned.
7993 <param name=
"sizer" type=
"Sizer" default=
""/>
7994 <param name=
"pos" type=
"GBPosition" default=
""/>
7997 <method name=
"SetItemPosition" type=
"bool" overloaded=
"yes">
7998 <docstring>SetItemPosition(self, item, GBPosition pos) -
> bool
8000 Set the grid position of the specified *item* where *item* is either a
8001 window or subsizer that is a member of this sizer, or a zero-based
8002 index of an item. Returns True on success. If the move is not
8003 allowed (because an item is already there) then False is returned.
8006 <param name=
"index" type=
"size_t" default=
""/>
8007 <param name=
"pos" type=
"GBPosition" default=
""/>
8010 <method name=
"GetItemSpan" type=
"GBSpan" overloaded=
"yes">
8011 <docstring>GetItemSpan(self, item) -
> GBSpan
8013 Get the row/col spanning of the specified *item* where *item* is
8014 either a window or subsizer that is a member of this sizer, or a
8015 zero-based index of an item.
</docstring>
8017 <param name=
"window" type=
"Window" default=
""/>
8020 <method name=
"GetItemSpan" type=
"GBSpan" overloaded=
"yes">
8021 <docstring>GetItemSpan(self, item) -
> GBSpan
8023 Get the row/col spanning of the specified *item* where *item* is
8024 either a window or subsizer that is a member of this sizer, or a
8025 zero-based index of an item.
</docstring>
8027 <param name=
"sizer" type=
"Sizer" default=
""/>
8030 <method name=
"GetItemSpan" type=
"GBSpan" overloaded=
"yes">
8031 <docstring>GetItemSpan(self, item) -
> GBSpan
8033 Get the row/col spanning of the specified *item* where *item* is
8034 either a window or subsizer that is a member of this sizer, or a
8035 zero-based index of an item.
</docstring>
8037 <param name=
"index" type=
"size_t" default=
""/>
8040 <method name=
"SetItemSpan" type=
"bool" overloaded=
"yes">
8041 <docstring>SetItemSpan(self, item, GBSpan span) -
> bool
8043 Set the row/col spanning of the specified *item* where *item* is
8044 either a window or subsizer that is a member of this sizer, or a
8045 zero-based index of an item. Returns True on success. If the move is
8046 not allowed (because an item is already there) then False is returned.
</docstring>
8048 <param name=
"window" type=
"Window" default=
""/>
8049 <param name=
"span" type=
"GBSpan" default=
""/>
8052 <method name=
"SetItemSpan" type=
"bool" overloaded=
"yes">
8053 <docstring>SetItemSpan(self, item, GBSpan span) -
> bool
8055 Set the row/col spanning of the specified *item* where *item* is
8056 either a window or subsizer that is a member of this sizer, or a
8057 zero-based index of an item. Returns True on success. If the move is
8058 not allowed (because an item is already there) then False is returned.
</docstring>
8060 <param name=
"sizer" type=
"Sizer" default=
""/>
8061 <param name=
"span" type=
"GBSpan" default=
""/>
8064 <method name=
"SetItemSpan" type=
"bool" overloaded=
"yes">
8065 <docstring>SetItemSpan(self, item, GBSpan span) -
> bool
8067 Set the row/col spanning of the specified *item* where *item* is
8068 either a window or subsizer that is a member of this sizer, or a
8069 zero-based index of an item. Returns True on success. If the move is
8070 not allowed (because an item is already there) then False is returned.
</docstring>
8072 <param name=
"index" type=
"size_t" default=
""/>
8073 <param name=
"span" type=
"GBSpan" default=
""/>
8076 <method name=
"FindItem" type=
"GBSizerItem" overloaded=
"yes">
8077 <docstring>FindItem(self, item) -
> GBSizerItem
8079 Find the sizer item for the given window or subsizer, returns None if
8080 not found. (non-recursive)
</docstring>
8082 <param name=
"window" type=
"Window" default=
""/>
8085 <method name=
"FindItem" type=
"GBSizerItem" overloaded=
"yes">
8086 <docstring>FindItem(self, item) -
> GBSizerItem
8088 Find the sizer item for the given window or subsizer, returns None if
8089 not found. (non-recursive)
</docstring>
8091 <param name=
"sizer" type=
"Sizer" default=
""/>
8094 <method name=
"FindItemAtPosition" type=
"GBSizerItem" overloaded=
"no">
8095 <autodoc>FindItemAtPosition(self, GBPosition pos) -
> GBSizerItem
</autodoc>
8096 <docstring>Return the sizer item for the given grid cell, or None if there is no
8097 item at that position. (non-recursive)
</docstring>
8099 <param name=
"pos" type=
"GBPosition" default=
""/>
8102 <method name=
"FindItemAtPoint" type=
"GBSizerItem" overloaded=
"no">
8103 <autodoc>FindItemAtPoint(self, Point pt) -
> GBSizerItem
</autodoc>
8104 <docstring>Return the sizer item located at the point given in *pt*, or None if
8105 there is no item at that point. The (x,y) coordinates in pt correspond
8106 to the client coordinates of the window using the sizer for
8107 layout. (non-recursive)
</docstring>
8109 <param name=
"pt" type=
"Point" default=
""/>
8112 <method name=
"CheckForIntersection" type=
"bool" overloaded=
"no">
8113 <autodoc>CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -
> bool
</autodoc>
8114 <docstring>Look at all items and see if any intersect (or would overlap) the
8115 given *item*. Returns True if so, False if there would be no overlap.
8116 If an *excludeItem* is given then it will not be checked for
8117 intersection, for example it may be the item we are checking the
8121 <param name=
"item" type=
"GBSizerItem" default=
""/>
8122 <param name=
"excludeItem" type=
"GBSizerItem" default=
"NULL"/>
8125 <method name=
"CheckForIntersectionPos" type=
"bool" overloaded=
"no">
8126 <autodoc>CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -
> bool
</autodoc>
8127 <docstring>Look at all items and see if any intersect (or would overlap) the
8128 given position and span. Returns True if so, False if there would be
8129 no overlap. If an *excludeItem* is given then it will not be checked
8130 for intersection, for example it may be the item we are checking the
8131 position of.
</docstring>
8133 <param name=
"pos" type=
"GBPosition" default=
""/>
8134 <param name=
"span" type=
"GBSpan" default=
""/>
8135 <param name=
"excludeItem" type=
"GBSizerItem" default=
"NULL"/>
8140 #---------------------------------------------------------------------------
8142 <class name=
"IndividualLayoutConstraint" oldname=
"wxIndividualLayoutConstraint" module=
"_core">
8143 <docstring>Objects of this class are stored in the `wx.LayoutConstraints` class as
8144 one of eight possible constraints that a window can be involved in.
8145 You will never need to create an instance of
8146 wx.IndividualLayoutConstraint, rather you should create a
8147 `wx.LayoutConstraints` instance and use the individual contstraints
8150 Constraints are initially set to have the relationship
8151 wx.Unconstrained, which means that their values should be calculated
8152 by looking at known constraints.
8154 The Edge specifies the type of edge or dimension of a window.
8158 ================== ==============================================
8159 wx.Left The left edge.
8160 wx.Top The top edge.
8161 wx.Right The right edge.
8162 wx.Bottom The bottom edge.
8163 wx.CentreX The x-coordinate of the centre of the window.
8164 wx.CentreY The y-coordinate of the centre of the window.
8165 ================== ==============================================
8168 The Relationship specifies the relationship that this edge or
8169 dimension has with another specified edge or dimension. Normally, the
8170 user doesn't use these directly because functions such as Below and
8171 RightOf are a convenience for using the more general Set function.
8175 ================== ==============================================
8176 wx.Unconstrained The edge or dimension is unconstrained
8177 (the default for edges.)
8178 wx.AsIs The edge or dimension is to be taken from the current
8179 window position or size (the default for dimensions.)
8180 wx.Above The edge should be above another edge.
8181 wx.Below The edge should be below another edge.
8182 wx.LeftOf The edge should be to the left of another edge.
8183 wx.RightOf The edge should be to the right of another edge.
8184 wx.SameAs The edge or dimension should be the same as another edge
8186 wx.PercentOf The edge or dimension should be a percentage of another
8188 wx.Absolute The edge or dimension should be a given absolute value.
8189 ================== ==============================================
8191 :see: `wx.LayoutConstraints`, `wx.Window.SetConstraints`
8193 <baseclass name=
"Object"/>
8194 <method name=
"Set" type=
"" overloaded=
"no">
8195 <autodoc>Set(self, int rel, Window otherW, int otherE, int val=
0, int marg=wxLAYOUT_DEFAULT_MARGIN)
</autodoc>
8196 <docstring>Sets the properties of the constraint. Normally called by one of the
8197 convenience functions such as Above, RightOf, SameAs.
</docstring>
8199 <param name=
"rel" type=
"wxRelationship" default=
""/>
8200 <param name=
"otherW" type=
"Window" default=
""/>
8201 <param name=
"otherE" type=
"wxEdge" default=
""/>
8202 <param name=
"val" type=
"int" default=
"0"/>
8203 <param name=
"marg" type=
"int" default=
"wxLAYOUT_DEFAULT_MARGIN"/>
8206 <method name=
"LeftOf" type=
"" overloaded=
"no">
8207 <autodoc>LeftOf(self, Window sibling, int marg=
0)
</autodoc>
8208 <docstring>Constrains this edge to be to the left of the given window, with an
8209 optional margin. Implicitly, this is relative to the left edge of the
8210 other window.
</docstring>
8212 <param name=
"sibling" type=
"Window" default=
""/>
8213 <param name=
"marg" type=
"int" default=
"0"/>
8216 <method name=
"RightOf" type=
"" overloaded=
"no">
8217 <autodoc>RightOf(self, Window sibling, int marg=
0)
</autodoc>
8218 <docstring>Constrains this edge to be to the right of the given window, with an
8219 optional margin. Implicitly, this is relative to the right edge of the
8220 other window.
</docstring>
8222 <param name=
"sibling" type=
"Window" default=
""/>
8223 <param name=
"marg" type=
"int" default=
"0"/>
8226 <method name=
"Above" type=
"" overloaded=
"no">
8227 <autodoc>Above(self, Window sibling, int marg=
0)
</autodoc>
8228 <docstring>Constrains this edge to be above the given window, with an optional
8229 margin. Implicitly, this is relative to the top edge of the other
8232 <param name=
"sibling" type=
"Window" default=
""/>
8233 <param name=
"marg" type=
"int" default=
"0"/>
8236 <method name=
"Below" type=
"" overloaded=
"no">
8237 <autodoc>Below(self, Window sibling, int marg=
0)
</autodoc>
8238 <docstring>Constrains this edge to be below the given window, with an optional
8239 margin. Implicitly, this is relative to the bottom edge of the other
8242 <param name=
"sibling" type=
"Window" default=
""/>
8243 <param name=
"marg" type=
"int" default=
"0"/>
8246 <method name=
"SameAs" type=
"" overloaded=
"no">
8247 <autodoc>SameAs(self, Window otherW, int edge, int marg=
0)
</autodoc>
8248 <docstring>Constrains this edge or dimension to be to the same as the edge of the
8249 given window, with an optional margin.
</docstring>
8251 <param name=
"otherW" type=
"Window" default=
""/>
8252 <param name=
"edge" type=
"wxEdge" default=
""/>
8253 <param name=
"marg" type=
"int" default=
"0"/>
8256 <method name=
"PercentOf" type=
"" overloaded=
"no">
8257 <autodoc>PercentOf(self, Window otherW, int wh, int per)
</autodoc>
8258 <docstring>Constrains this edge or dimension to be to a percentage of the given
8259 window, with an optional margin.
</docstring>
8261 <param name=
"otherW" type=
"Window" default=
""/>
8262 <param name=
"wh" type=
"wxEdge" default=
""/>
8263 <param name=
"per" type=
"int" default=
""/>
8266 <method name=
"Absolute" type=
"" overloaded=
"no">
8267 <autodoc>Absolute(self, int val)
</autodoc>
8268 <docstring>Constrains this edge or dimension to be the given absolute value.
</docstring>
8270 <param name=
"val" type=
"int" default=
""/>
8273 <method name=
"Unconstrained" type=
"" overloaded=
"no">
8274 <autodoc>Unconstrained(self)
</autodoc>
8275 <docstring>Sets this edge or dimension to be unconstrained, that is, dependent on
8276 other edges and dimensions from which this value can be deduced.
</docstring>
8278 <method name=
"AsIs" type=
"" overloaded=
"no">
8279 <autodoc>AsIs(self)
</autodoc>
8280 <docstring>Sets this edge or constraint to be whatever the window's value is at
8281 the moment. If either of the width and height constraints are *as is*,
8282 the window will not be resized, but moved instead. This is important
8283 when considering panel items which are intended to have a default
8284 size, such as a button, which may take its size from the size of the
8285 button label.
</docstring>
8287 <method name=
"GetOtherWindow" type=
"Window" overloaded=
"no">
8288 <autodoc>GetOtherWindow(self) -
> Window
</autodoc>
8290 <method name=
"GetMyEdge" type=
"wxEdge" overloaded=
"no">
8291 <autodoc>GetMyEdge(self) -
> int
</autodoc>
8293 <method name=
"SetEdge" type=
"" overloaded=
"no">
8294 <autodoc>SetEdge(self, int which)
</autodoc>
8296 <param name=
"which" type=
"wxEdge" default=
""/>
8299 <method name=
"SetValue" type=
"" overloaded=
"no">
8300 <autodoc>SetValue(self, int v)
</autodoc>
8302 <param name=
"v" type=
"int" default=
""/>
8305 <method name=
"GetMargin" type=
"int" overloaded=
"no">
8306 <autodoc>GetMargin(self) -
> int
</autodoc>
8308 <method name=
"SetMargin" type=
"" overloaded=
"no">
8309 <autodoc>SetMargin(self, int m)
</autodoc>
8311 <param name=
"m" type=
"int" default=
""/>
8314 <method name=
"GetValue" type=
"int" overloaded=
"no">
8315 <autodoc>GetValue(self) -
> int
</autodoc>
8317 <method name=
"GetPercent" type=
"int" overloaded=
"no">
8318 <autodoc>GetPercent(self) -
> int
</autodoc>
8320 <method name=
"GetOtherEdge" type=
"int" overloaded=
"no">
8321 <autodoc>GetOtherEdge(self) -
> int
</autodoc>
8323 <method name=
"GetDone" type=
"bool" overloaded=
"no">
8324 <autodoc>GetDone(self) -
> bool
</autodoc>
8326 <method name=
"SetDone" type=
"" overloaded=
"no">
8327 <autodoc>SetDone(self, bool d)
</autodoc>
8329 <param name=
"d" type=
"bool" default=
""/>
8332 <method name=
"GetRelationship" type=
"wxRelationship" overloaded=
"no">
8333 <autodoc>GetRelationship(self) -
> int
</autodoc>
8335 <method name=
"SetRelationship" type=
"" overloaded=
"no">
8336 <autodoc>SetRelationship(self, int r)
</autodoc>
8338 <param name=
"r" type=
"wxRelationship" default=
""/>
8341 <method name=
"ResetIfWin" type=
"bool" overloaded=
"no">
8342 <autodoc>ResetIfWin(self, Window otherW) -
> bool
</autodoc>
8343 <docstring>Reset constraint if it mentions otherWin
</docstring>
8345 <param name=
"otherW" type=
"Window" default=
""/>
8348 <method name=
"SatisfyConstraint" type=
"bool" overloaded=
"no">
8349 <autodoc>SatisfyConstraint(self, LayoutConstraints constraints, Window win) -
> bool
</autodoc>
8350 <docstring>Try to satisfy constraint
</docstring>
8352 <param name=
"constraints" type=
"wxLayoutConstraints" default=
""/>
8353 <param name=
"win" type=
"Window" default=
""/>
8356 <method name=
"GetEdge" type=
"int" overloaded=
"no">
8357 <autodoc>GetEdge(self, int which, Window thisWin, Window other) -
> int
</autodoc>
8358 <docstring>Get the value of this edge or dimension, or if this
8359 is not determinable, -
1.
</docstring>
8361 <param name=
"which" type=
"wxEdge" default=
""/>
8362 <param name=
"thisWin" type=
"Window" default=
""/>
8363 <param name=
"other" type=
"Window" default=
""/>
8367 <class name=
"LayoutConstraints" oldname=
"wxLayoutConstraints" module=
"_core">
8368 <docstring>**Note:** constraints are now deprecated and you should use sizers
8371 Objects of this class can be associated with a window to define its
8372 layout constraints, with respect to siblings or its parent.
8374 The class consists of the following eight constraints of class
8375 wx.IndividualLayoutConstraint, some or all of which should be accessed
8376 directly to set the appropriate constraints.
8378 * left: represents the left hand edge of the window
8379 * right: represents the right hand edge of the window
8380 * top: represents the top edge of the window
8381 * bottom: represents the bottom edge of the window
8382 * width: represents the width of the window
8383 * height: represents the height of the window
8384 * centreX: represents the horizontal centre point of the window
8385 * centreY: represents the vertical centre point of the window
8387 Most constraints are initially set to have the relationship
8388 wxUnconstrained, which means that their values should be calculated by
8389 looking at known constraints. The exceptions are width and height,
8390 which are set to wxAsIs to ensure that if the user does not specify a
8391 constraint, the existing width and height will be used, to be
8392 compatible with panel items which often have take a default size. If
8393 the constraint is ``wx.AsIs``, the dimension will not be changed.
8395 :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
8397 <baseclass name=
"Object"/>
8398 <constructor name=
"LayoutConstraints" overloaded=
"no">
8399 <autodoc>__init__(self) -
> LayoutConstraints
</autodoc>
8401 <property name=
"left" type=
"IndividualLayoutConstraint" readonly=
"yes"/>
8402 <property name=
"top" type=
"IndividualLayoutConstraint" readonly=
"yes"/>
8403 <property name=
"right" type=
"IndividualLayoutConstraint" readonly=
"yes"/>
8404 <property name=
"bottom" type=
"IndividualLayoutConstraint" readonly=
"yes"/>
8405 <property name=
"width" type=
"IndividualLayoutConstraint" readonly=
"yes"/>
8406 <property name=
"height" type=
"IndividualLayoutConstraint" readonly=
"yes"/>
8407 <property name=
"centreX" type=
"IndividualLayoutConstraint" readonly=
"yes"/>
8408 <property name=
"centreY" type=
"IndividualLayoutConstraint" readonly=
"yes"/>
8409 <method name=
"SatisfyConstraints" type=
"bool" overloaded=
"no">
8410 <autodoc>SatisfyConstraints(Window win) -
> (areSatisfied, noChanges)
</autodoc>
8412 <param name=
"win" type=
"Window" default=
""/>
8413 <param name=
"OUTPUT" type=
"int" default=
""/>
8416 <method name=
"AreSatisfied" type=
"bool" overloaded=
"no">
8417 <autodoc>AreSatisfied(self) -
> bool
</autodoc>
8420 <pythoncode>#----------------------------------------------------------------------------
8422 # Use Python's bool constants if available, make some if not
8426 __builtins__.True =
1==
1
8427 __builtins__.False =
1==
0
8428 def bool(value): return not not value
8429 __builtins__.bool = bool
8433 # workarounds for bad wxRTTI names
8434 __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge'
8435 __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider'
8436 __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar'
8439 #----------------------------------------------------------------------------
8440 # Load version numbers from __version__... Ensure that major and minor
8441 # versions are the same for both wxPython and wxWindows.
8443 from __version__ import *
8444 __version__ = VERSION_STRING
8446 assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
8447 assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
8448 if RELEASE_VERSION != _core_.RELEASE_VERSION:
8450 warnings.warn("wxPython/wxWindows release number mismatch")
8452 #----------------------------------------------------------------------------
8454 class PyDeadObjectError(AttributeError):
8457 class _wxPyDeadObject(object):
8459 Instances of wx objects that are OOR capable will have their __class__
8460 changed to this class when the C++ object is deleted. This should help
8461 prevent crashes due to referencing a bogus C++ pointer.
8463 reprStr = "wxPython wrapper for DELETED %s object! (The C++ object no longer exists.)"
8464 attrStr = "The C++ part of the %s object has been deleted, attribute access no longer allowed."
8467 if not hasattr(self, "_name"):
8468 self._name = "[unknown]"
8469 return self.reprStr % self._name
8471 def __getattr__(self, *args):
8472 if not hasattr(self, "_name"):
8473 self._name = "[unknown]"
8474 raise PyDeadObjectError(self.attrStr % self._name)
8476 def __nonzero__(self):
8481 class PyUnbornObjectError(AttributeError):
8484 class _wxPyUnbornObject(object):
8486 Some stock objects are created when the wx._core module is
8487 imported, but their C++ instance is not created until the wx.App
8488 object is created and initialized. These object instances will
8489 temporarily have their __class__ changed to this class so an
8490 exception will be raised if they are used before the C++ instance
8494 reprStr = "wxPython wrapper for UNBORN object! (The C++ object is not initialized yet.)"
8495 attrStr = "The C++ part of this object has not been initialized, attribute access not allowed."
8498 #if not hasattr(self, "_name"):
8499 # self._name = "[unknown]"
8500 return self.reprStr #% self._name
8502 def __getattr__(self, *args):
8503 #if not hasattr(self, "_name"):
8504 # self._name = "[unknown]"
8505 raise PyUnbornObjectError(self.attrStr) # % self._name )
8507 def __nonzero__(self):
8511 #----------------------------------------------------------------------------
8512 _wxPyCallAfterId = None
8514 def CallAfter(callable, *args, **kw):
8516 Call the specified function after the current and pending event
8517 handlers have been completed. This is also good for making GUI
8518 method calls from non-GUI threads. Any extra positional or
8519 keyword args are passed on to the callable when it is called.
8521 :see: `wx.FutureCall`
8524 assert app is not None, 'No wx.App created yet'
8526 global _wxPyCallAfterId
8527 if _wxPyCallAfterId is None:
8528 _wxPyCallAfterId = wx.NewEventType()
8529 app.Connect(-
1, -
1, _wxPyCallAfterId,
8530 lambda event: event.callable(*event.args, **event.kw) )
8532 evt.SetEventType(_wxPyCallAfterId)
8533 evt.callable = callable
8536 wx.PostEvent(app, evt)
8539 #----------------------------------------------------------------------------
8544 A convenience class for wx.Timer, that calls the given callable
8545 object once after the given amount of milliseconds, passing any
8546 positional or keyword args. The return value of the callable is
8547 availbale after it has been run with the `GetResult` method.
8549 If you don't need to get the return value or restart the timer
8550 then there is no need to hold a reference to this object. It will
8551 hold a reference to itself while the timer is running (the timer
8552 has a reference to self.Notify) but the cycle will be broken when
8553 the timer completes, automatically cleaning up the wx.FutureCall
8556 :see: `wx.CallAfter`
8558 def __init__(self, millis, callable, *args, **kwargs):
8559 self.millis = millis
8560 self.callable = callable
8561 self.SetArgs(*args, **kwargs)
8563 self.running = False
8573 def Start(self, millis=None, *args, **kwargs):
8578 if millis is not None:
8579 self.millis = millis
8581 self.SetArgs(*args, **kwargs)
8583 self.timer = wx.PyTimer(self.Notify)
8584 self.timer.Start(self.millis, wx.TIMER_ONE_SHOT)
8591 Stop and destroy the timer.
8593 if self.timer is not None:
8598 def GetInterval(self):
8599 if self.timer is not None:
8600 return self.timer.GetInterval()
8605 def IsRunning(self):
8606 return self.timer is not None and self.timer.IsRunning()
8609 def SetArgs(self, *args, **kwargs):
8611 (Re)set the args passed to the callable object. This is
8612 useful in conjunction with Restart if you want to schedule a
8613 new call to the same callable object but with different
8617 self.kwargs = kwargs
8623 def GetResult(self):
8628 The timer has expired so call the callable.
8630 if self.callable and getattr(self.callable, 'im_self', True):
8632 self.running = False
8633 self.result = self.callable(*self.args, **self.kwargs)
8635 if not self.running:
8636 # if it wasn't restarted, then cleanup
8637 wx.CallAfter(self.Stop)
8641 #----------------------------------------------------------------------------
8642 # Control which items in this module should be documented by epydoc.
8643 # We allow only classes and functions, which will help reduce the size
8644 # of the docs by filtering out the zillions of constants, EVT objects,
8645 # and etc that don't make much sense by themselves, but are instead
8646 # documented (or will be) as part of the classes/functions/methods
8647 # where they should be used.
8651 A filter for epydoc that only allows non-Ptr classes and
8652 fucntions, in order to reduce the clutter in the API docs.
8654 def __init__(self, globals):
8655 self._globals = globals
8657 def __call__(self, name):
8659 obj = self._globals.get(name, None)
8660 if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
8662 if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
8666 #----------------------------------------------------------------------------
8667 #----------------------------------------------------------------------------
8669 # Import other modules in this package that should show up in the
8670 # "core" wx namespace
8672 from _windows import *
8673 from _controls import *
8677 # Fixup the stock objects since they can't be used yet. (They will be
8678 # restored in wx.PyApp.OnInit.)
8679 _core_._wxPyFixStockObjects()
8681 #----------------------------------------------------------------------------
8682 #----------------------------------------------------------------------------
8685 <module name=
"_gdi">
8686 <import name=
"_core"/>
8687 <pythoncode> wx = _core
</pythoncode>
8689 #---------------------------------------------------------------------------
8691 <class name=
"GDIObject" oldname=
"wxGDIObject" module=
"_gdi">
8692 <baseclass name=
"Object"/>
8693 <constructor name=
"GDIObject" overloaded=
"no">
8694 <autodoc>__init__(self) -
> GDIObject
</autodoc>
8696 <destructor name=
"~wxGDIObject" overloaded=
"no">
8697 <autodoc>__del__(self)
</autodoc>
8699 <method name=
"GetVisible" type=
"bool" overloaded=
"no">
8700 <autodoc>GetVisible(self) -
> bool
</autodoc>
8702 <method name=
"SetVisible" type=
"" overloaded=
"no">
8703 <autodoc>SetVisible(self, bool visible)
</autodoc>
8705 <param name=
"visible" type=
"bool" default=
""/>
8708 <method name=
"IsNull" type=
"bool" overloaded=
"no">
8709 <autodoc>IsNull(self) -
> bool
</autodoc>
8713 #---------------------------------------------------------------------------
8715 <class name=
"Colour" oldname=
"wxColour" module=
"_gdi">
8716 <docstring>A colour is an object representing a combination of Red, Green, and
8717 Blue (RGB) intensity values, and is used to determine drawing colours,
8718 window colours, etc. Valid RGB values are in the range
0 to
255.
8720 In wxPython there are typemaps that will automatically convert from a
8721 colour name, or from a '#RRGGBB' colour hex value string to a
8722 wx.Colour object when calling C++ methods that expect a wxColour.
8723 This means that the following are all equivallent::
8725 win.SetBackgroundColour(wxColour(
0,
0,
255))
8726 win.SetBackgroundColour('BLUE')
8727 win.SetBackgroundColour('#
0000FF')
8729 Additional colour names and their coresponding values can be added
8730 using `wx.ColourDatabase`. Various system colours (as set in the
8731 user's system preferences) can be retrieved with
8732 `wx.SystemSettings.GetColour`.
8734 <baseclass name=
"Object"/>
8735 <constructor name=
"Colour" overloaded=
"no">
8736 <autodoc>__init__(self, byte red=
0, byte green=
0, byte blue=
0) -
> Colour
</autodoc>
8737 <docstring>Constructs a colour from red, green and blue values.
8739 :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
8742 <param name=
"red" type=
"byte" default=
"0"/>
8743 <param name=
"green" type=
"byte" default=
"0"/>
8744 <param name=
"blue" type=
"byte" default=
"0"/>
8747 <constructor name=
"NamedColour" overloaded=
"no">
8748 <autodoc>NamedColour(String colorName) -
> Colour
</autodoc>
8749 <docstring>Constructs a colour object using a colour name listed in
8750 ``wx.TheColourDatabase``.
</docstring>
8752 <param name=
"colorName" type=
"String" default=
""/>
8755 <constructor name=
"ColourRGB" overloaded=
"no">
8756 <autodoc>ColourRGB(unsigned long colRGB) -
> Colour
</autodoc>
8757 <docstring>Constructs a colour from a packed RGB value.
</docstring>
8759 <param name=
"colRGB" type=
"unsigned long" default=
""/>
8762 <destructor name=
"~wxColour" overloaded=
"no">
8763 <autodoc>__del__(self)
</autodoc>
8765 <method name=
"Red" type=
"byte" overloaded=
"no">
8766 <autodoc>Red(self) -
> byte
</autodoc>
8767 <docstring>Returns the red intensity.
</docstring>
8769 <method name=
"Green" type=
"byte" overloaded=
"no">
8770 <autodoc>Green(self) -
> byte
</autodoc>
8771 <docstring>Returns the green intensity.
</docstring>
8773 <method name=
"Blue" type=
"byte" overloaded=
"no">
8774 <autodoc>Blue(self) -
> byte
</autodoc>
8775 <docstring>Returns the blue intensity.
</docstring>
8777 <method name=
"Ok" type=
"bool" overloaded=
"no">
8778 <autodoc>Ok(self) -
> bool
</autodoc>
8779 <docstring>Returns True if the colour object is valid (the colour has been
8780 initialised with RGB values).
</docstring>
8782 <method name=
"Set" type=
"" overloaded=
"no">
8783 <autodoc>Set(self, byte red, byte green, byte blue)
</autodoc>
8784 <docstring>Sets the RGB intensity values.
</docstring>
8786 <param name=
"red" type=
"byte" default=
""/>
8787 <param name=
"green" type=
"byte" default=
""/>
8788 <param name=
"blue" type=
"byte" default=
""/>
8791 <method name=
"SetRGB" type=
"" overloaded=
"no">
8792 <autodoc>SetRGB(self, unsigned long colRGB)
</autodoc>
8793 <docstring>Sets the RGB intensity values from a packed RGB value.
</docstring>
8795 <param name=
"colRGB" type=
"unsigned long" default=
""/>
8798 <method name=
"SetFromName" type=
"" overloaded=
"no">
8799 <autodoc>SetFromName(self, String colourName)
</autodoc>
8800 <docstring>Sets the RGB intensity values using a colour name listed in
8801 ``wx.TheColourDatabase``.
</docstring>
8803 <param name=
"colourName" type=
"String" default=
""/>
8806 <method name=
"GetPixel" type=
"long" overloaded=
"no">
8807 <autodoc>GetPixel(self) -
> long
</autodoc>
8808 <docstring>Returns a pixel value which is platform-dependent. On Windows, a
8809 COLORREF is returned. On X, an allocated pixel value is returned. -
1
8810 is returned if the pixel is invalid (on X, unallocated).
</docstring>
8812 <method name=
"__eq__" type=
"bool" overloaded=
"no">
8813 <autodoc>__eq__(self, Colour colour) -
> bool
</autodoc>
8814 <docstring>Compare colours for equality
</docstring>
8816 <param name=
"colour" type=
"Colour" default=
""/>
8819 <method name=
"__ne__" type=
"bool" overloaded=
"no">
8820 <autodoc>__ne__(self, Colour colour) -
> bool
</autodoc>
8821 <docstring>Compare colours for inequality
</docstring>
8823 <param name=
"colour" type=
"Colour" default=
""/>
8826 <method name=
"Get" type=
"PyObject" overloaded=
"no">
8827 <autodoc>Get() -
> (r, g, b)
</autodoc>
8828 <docstring>Returns the RGB intensity values as a tuple.
</docstring>
8830 <method name=
"GetRGB" type=
"unsigned long" overloaded=
"no">
8831 <autodoc>GetRGB(self) -
> unsigned long
</autodoc>
8832 <docstring>Return the colour as a packed RGB value
</docstring>
8837 NamedColor = NamedColour
8838 ColorRGB = ColourRGB
8840 <class name=
"Palette" oldname=
"wxPalette" module=
"_gdi">
8841 <baseclass name=
"GDIObject"/>
8842 <constructor name=
"Palette" overloaded=
"no">
8843 <autodoc>__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -
> Palette
</autodoc>
8845 <param name=
"n" type=
"int" default=
""/>
8846 <param name=
"red" type=
"unsigned char" default=
""/>
8847 <param name=
"green" type=
"unsigned char" default=
""/>
8848 <param name=
"blue" type=
"unsigned char" default=
""/>
8851 <destructor name=
"~wxPalette" overloaded=
"no">
8852 <autodoc>__del__(self)
</autodoc>
8854 <method name=
"GetPixel" type=
"int" overloaded=
"no">
8855 <autodoc>GetPixel(self, byte red, byte green, byte blue) -
> int
</autodoc>
8857 <param name=
"red" type=
"byte" default=
""/>
8858 <param name=
"green" type=
"byte" default=
""/>
8859 <param name=
"blue" type=
"byte" default=
""/>
8862 <method name=
"GetRGB" type=
"bool" overloaded=
"no">
8863 <autodoc>GetRGB(int pixel) -
> (R,G,B)
</autodoc>
8865 <param name=
"pixel" type=
"int" default=
""/>
8866 <param name=
"OUTPUT" type=
"byte" default=
""/>
8867 <param name=
"OUTPUT" type=
"byte" default=
""/>
8868 <param name=
"OUTPUT" type=
"byte" default=
""/>
8871 <method name=
"Ok" type=
"bool" overloaded=
"no">
8872 <autodoc>Ok(self) -
> bool
</autodoc>
8876 #---------------------------------------------------------------------------
8878 <class name=
"Pen" oldname=
"wxPen" module=
"_gdi">
8879 <baseclass name=
"GDIObject"/>
8880 <constructor name=
"Pen" overloaded=
"no">
8881 <autodoc>__init__(self, Colour colour, int width=
1, int style=SOLID) -
> Pen
</autodoc>
8883 <param name=
"colour" type=
"Colour" default=
""/>
8884 <param name=
"width" type=
"int" default=
"1"/>
8885 <param name=
"style" type=
"int" default=
"wxSOLID"/>
8888 <destructor name=
"~wxPen" overloaded=
"no">
8889 <autodoc>__del__(self)
</autodoc>
8891 <method name=
"GetCap" type=
"int" overloaded=
"no">
8892 <autodoc>GetCap(self) -
> int
</autodoc>
8894 <method name=
"GetColour" type=
"Colour" overloaded=
"no">
8895 <autodoc>GetColour(self) -
> Colour
</autodoc>
8897 <method name=
"GetJoin" type=
"int" overloaded=
"no">
8898 <autodoc>GetJoin(self) -
> int
</autodoc>
8900 <method name=
"GetStyle" type=
"int" overloaded=
"no">
8901 <autodoc>GetStyle(self) -
> int
</autodoc>
8903 <method name=
"GetWidth" type=
"int" overloaded=
"no">
8904 <autodoc>GetWidth(self) -
> int
</autodoc>
8906 <method name=
"Ok" type=
"bool" overloaded=
"no">
8907 <autodoc>Ok(self) -
> bool
</autodoc>
8909 <method name=
"SetCap" type=
"" overloaded=
"no">
8910 <autodoc>SetCap(self, int cap_style)
</autodoc>
8912 <param name=
"cap_style" type=
"int" default=
""/>
8915 <method name=
"SetColour" type=
"" overloaded=
"no">
8916 <autodoc>SetColour(self, Colour colour)
</autodoc>
8918 <param name=
"colour" type=
"Colour" default=
""/>
8921 <method name=
"SetJoin" type=
"" overloaded=
"no">
8922 <autodoc>SetJoin(self, int join_style)
</autodoc>
8924 <param name=
"join_style" type=
"int" default=
""/>
8927 <method name=
"SetStyle" type=
"" overloaded=
"no">
8928 <autodoc>SetStyle(self, int style)
</autodoc>
8930 <param name=
"style" type=
"int" default=
""/>
8933 <method name=
"SetWidth" type=
"" overloaded=
"no">
8934 <autodoc>SetWidth(self, int width)
</autodoc>
8936 <param name=
"width" type=
"int" default=
""/>
8939 <method name=
"SetDashes" type=
"" overloaded=
"no">
8940 <autodoc>SetDashes(self, int dashes, wxDash dashes_array)
</autodoc>
8942 <param name=
"dashes" type=
"int" default=
""/>
8943 <param name=
"dashes_array" type=
"wxDash" default=
""/>
8946 <method name=
"GetDashes" type=
"PyObject" overloaded=
"no">
8947 <autodoc>GetDashes(self) -
> PyObject
</autodoc>
8949 <method name=
"_SetDashes" type=
"" overloaded=
"no">
8950 <autodoc>_SetDashes(self, PyObject _self, PyObject pyDashes)
</autodoc>
8952 <param name=
"_self" type=
"PyObject" default=
""/>
8953 <param name=
"pyDashes" type=
"PyObject" default=
""/>
8956 <method name=
"GetDashCount" type=
"int" overloaded=
"no">
8957 <autodoc>GetDashCount(self) -
> int
</autodoc>
8959 <method name=
"__eq__" type=
"bool" overloaded=
"no">
8960 <autodoc>__eq__(self, Pen other) -
> bool
</autodoc>
8962 <param name=
"other" type=
"Pen" default=
""/>
8965 <method name=
"__ne__" type=
"bool" overloaded=
"no">
8966 <autodoc>__ne__(self, Pen other) -
> bool
</autodoc>
8968 <param name=
"other" type=
"Pen" default=
""/>
8973 #---------------------------------------------------------------------------
8975 <class name=
"Brush" oldname=
"wxBrush" module=
"_gdi">
8976 <docstring>A brush is a drawing tool for filling in areas. It is used for
8977 painting the background of rectangles, ellipses, etc. when drawing on
8978 a `wx.DC`. It has a colour and a style.
8980 :warning: Do not create instances of wx.Brush before the `wx.App`
8981 object has been created because, depending on the platform,
8982 required internal data structures may not have been initialized
8983 yet. Instead create your brushes in the app's OnInit or as they
8984 are needed for drawing.
8986 :note: On monochrome displays all brushes are white, unless the colour
8989 :see: `wx.BrushList`, `wx.DC`, `wx.DC.SetBrush`
8991 <baseclass name=
"GDIObject"/>
8992 <constructor name=
"Brush" overloaded=
"no">
8993 <autodoc>__init__(self, Colour colour, int style=SOLID) -
> Brush
</autodoc>
8994 <docstring>Constructs a brush from a `wx.Colour` object and a style.The style parameter may be one of the following:
8996 =================== =============================
8998 =================== =============================
8999 wx.TRANSPARENT Transparent (no fill).
9001 wx.STIPPLE Uses a bitmap as a stipple.
9002 wx.BDIAGONAL_HATCH Backward diagonal hatch.
9003 wx.CROSSDIAG_HATCH Cross-diagonal hatch.
9004 wx.FDIAGONAL_HATCH Forward diagonal hatch.
9005 wx.CROSS_HATCH Cross hatch.
9006 wx.HORIZONTAL_HATCH Horizontal hatch.
9007 wx.VERTICAL_HATCH Vertical hatch.
9008 =================== =============================
9012 <param name=
"colour" type=
"Colour" default=
""/>
9013 <param name=
"style" type=
"int" default=
"wxSOLID"/>
9016 <destructor name=
"~wxBrush" overloaded=
"no">
9017 <autodoc>__del__(self)
</autodoc>
9019 <method name=
"SetColour" type=
"" overloaded=
"no">
9020 <autodoc>SetColour(self, Colour col)
</autodoc>
9021 <docstring>Set the brush's `wx.Colour`.
</docstring>
9023 <param name=
"col" type=
"Colour" default=
""/>
9026 <method name=
"SetStyle" type=
"" overloaded=
"no">
9027 <autodoc>SetStyle(self, int style)
</autodoc>
9028 <docstring>Sets the style of the brush. See `__init__` for a listing of styles.
</docstring>
9030 <param name=
"style" type=
"int" default=
""/>
9033 <method name=
"SetStipple" type=
"" overloaded=
"no">
9034 <autodoc>SetStipple(self, Bitmap stipple)
</autodoc>
9035 <docstring>Sets the stipple `wx.Bitmap`.
</docstring>
9037 <param name=
"stipple" type=
"wxBitmap" default=
""/>
9040 <method name=
"GetColour" type=
"Colour" overloaded=
"no">
9041 <autodoc>GetColour(self) -
> Colour
</autodoc>
9042 <docstring>Returns the `wx.Colour` of the brush.
</docstring>
9044 <method name=
"GetStyle" type=
"int" overloaded=
"no">
9045 <autodoc>GetStyle(self) -
> int
</autodoc>
9046 <docstring>Returns the style of the brush. See `__init__` for a listing of
9049 <method name=
"GetStipple" type=
"wxBitmap" overloaded=
"no">
9050 <autodoc>GetStipple(self) -
> Bitmap
</autodoc>
9051 <docstring>Returns the stiple `wx.Bitmap` of the brush. If the brush does not
9052 have a wx.STIPPLE style, then the return value may be non-None but an
9053 uninitialised bitmap (`wx.Bitmap.Ok` returns False).
</docstring>
9055 <method name=
"Ok" type=
"bool" overloaded=
"no">
9056 <autodoc>Ok(self) -
> bool
</autodoc>
9057 <docstring>Returns True if the brush is initialised and valid.
</docstring>
9060 <class name=
"Bitmap" oldname=
"wxBitmap" module=
"_gdi">
9061 <docstring>The wx.Bitmap class encapsulates the concept of a platform-dependent
9062 bitmap. It can be either monochrome or colour, and either loaded from
9063 a file or created dynamically. A bitmap can be selected into a memory
9064 device context (instance of `wx.MemoryDC`). This enables the bitmap to
9065 be copied to a window or memory device context using `wx.DC.Blit`, or
9066 to be used as a drawing surface.
9068 The BMP and XMP image file formats are supported on all platforms by
9069 wx.Bitmap. Other formats are automatically loaded by `wx.Image` and
9070 converted to a wx.Bitmap, so any image file format supported by
9071 `wx.Image` can be used.
9073 :todo: Add wrappers and support for raw bitmap data access. Can this
9074 be be put into Python without losing the speed benefits of the
9075 teplates and iterators in rawbmp.h?
9077 :todo: Find a way to do very efficient PIL Image
<--
> wx.Bitmap
9080 <baseclass name=
"GDIObject"/>
9081 <constructor name=
"Bitmap" overloaded=
"no">
9082 <autodoc>__init__(self, String name, int type=BITMAP_TYPE_ANY) -
> Bitmap
</autodoc>
9083 <docstring>Loads a bitmap from a file.
9084 :param name: Name of the file to load the bitmap from.
9085 :param type: The type of image to expect. Can be one of the following
9086 constants (assuming that the neccessary `wx.Image` handlers are
9089 * wx.BITMAP_TYPE_ANY
9090 * wx.BITMAP_TYPE_BMP
9091 * wx.BITMAP_TYPE_ICO
9092 * wx.BITMAP_TYPE_CUR
9093 * wx.BITMAP_TYPE_XBM
9094 * wx.BITMAP_TYPE_XPM
9095 * wx.BITMAP_TYPE_TIF
9096 * wx.BITMAP_TYPE_GIF
9097 * wx.BITMAP_TYPE_PNG
9098 * wx.BITMAP_TYPE_JPEG
9099 * wx.BITMAP_TYPE_PNM
9100 * wx.BITMAP_TYPE_PCX
9101 * wx.BITMAP_TYPE_PICT
9102 * wx.BITMAP_TYPE_ICON
9103 * wx.BITMAP_TYPE_ANI
9104 * wx.BITMAP_TYPE_IFF
9106 :see: Alternate constructors `wx.EmptyBitmap`, `wx.BitmapFromIcon`,
9107 `wx.BitmapFromImage`, `wx.BitmapFromXPMData`,
9111 <param name=
"name" type=
"String" default=
""/>
9112 <param name=
"type" type=
"wxBitmapType" default=
"wxBITMAP_TYPE_ANY"/>
9115 <constructor name=
"EmptyBitmap" overloaded=
"no">
9116 <autodoc>EmptyBitmap(int width, int height, int depth=-
1) -
> Bitmap
</autodoc>
9117 <docstring>Creates a new bitmap of the given size. A depth of -
1 indicates the
9118 depth of the current screen or visual. Some platforms only support
1
9119 for monochrome and -
1 for the current colour setting.
</docstring>
9121 <param name=
"width" type=
"int" default=
""/>
9122 <param name=
"height" type=
"int" default=
""/>
9123 <param name=
"depth" type=
"int" default=
"-1"/>
9126 <constructor name=
"BitmapFromIcon" overloaded=
"no">
9127 <autodoc>BitmapFromIcon(Icon icon) -
> Bitmap
</autodoc>
9128 <docstring>Create a new bitmap from a `wx.Icon` object.
</docstring>
9130 <param name=
"icon" type=
"wxIcon" default=
""/>
9133 <constructor name=
"BitmapFromImage" overloaded=
"no">
9134 <autodoc>BitmapFromImage(Image image, int depth=-
1) -
> Bitmap
</autodoc>
9135 <docstring>Creates bitmap object from a `wx.Image`. This has to be done to
9136 actually display a `wx.Image` as you cannot draw an image directly on
9137 a window. The resulting bitmap will use the provided colour depth (or
9138 that of the current screen colour depth if depth is -
1) which entails
9139 that a colour reduction may have to take place.
</docstring>
9141 <param name=
"image" type=
"Image" default=
""/>
9142 <param name=
"depth" type=
"int" default=
"-1"/>
9145 <constructor name=
"BitmapFromXPMData" overloaded=
"no">
9146 <autodoc>BitmapFromXPMData(PyObject listOfStrings) -
> Bitmap
</autodoc>
9147 <docstring>Construct a Bitmap from a list of strings formatted as XPM data.
</docstring>
9149 <param name=
"listOfStrings" type=
"PyObject" default=
""/>
9152 <constructor name=
"BitmapFromBits" overloaded=
"no">
9153 <autodoc>BitmapFromBits(PyObject bits, int width, int height, int depth=
1) -
> Bitmap
</autodoc>
9154 <docstring>Creates a bitmap from an array of bits. You should only use this
9155 function for monochrome bitmaps (depth
1) in portable programs: in
9156 this case the bits parameter should contain an XBM image. For other
9157 bit depths, the behaviour is platform dependent.
</docstring>
9159 <param name=
"bits" type=
"PyObject" default=
""/>
9160 <param name=
"width" type=
"int" default=
""/>
9161 <param name=
"height" type=
"int" default=
""/>
9162 <param name=
"depth" type=
"int" default=
"1"/>
9165 <destructor name=
"~wxBitmap" overloaded=
"no">
9166 <autodoc>__del__(self)
</autodoc>
9168 <method name=
"Ok" type=
"bool" overloaded=
"no">
9169 <autodoc>Ok(self) -
> bool
</autodoc>
9171 <method name=
"GetWidth" type=
"int" overloaded=
"no">
9172 <autodoc>GetWidth(self) -
> int
</autodoc>
9173 <docstring>Gets the width of the bitmap in pixels.
</docstring>
9175 <method name=
"GetHeight" type=
"int" overloaded=
"no">
9176 <autodoc>GetHeight(self) -
> int
</autodoc>
9177 <docstring>Gets the height of the bitmap in pixels.
</docstring>
9179 <method name=
"GetDepth" type=
"int" overloaded=
"no">
9180 <autodoc>GetDepth(self) -
> int
</autodoc>
9181 <docstring>Gets the colour depth of the bitmap. A value of
1 indicates a
9182 monochrome bitmap.
</docstring>
9184 <method name=
"GetSize" type=
"Size" overloaded=
"no">
9185 <autodoc>GetSize(self) -
> Size
</autodoc>
9186 <docstring>Get the size of the bitmap.
</docstring>
9188 <method name=
"ConvertToImage" type=
"Image" overloaded=
"no">
9189 <autodoc>ConvertToImage(self) -
> Image
</autodoc>
9190 <docstring>Creates a platform-independent image from a platform-dependent
9191 bitmap. This preserves mask information so that bitmaps and images can
9192 be converted back and forth without loss in that respect.
</docstring>
9194 <method name=
"GetMask" type=
"wxMask" overloaded=
"no">
9195 <autodoc>GetMask(self) -
> Mask
</autodoc>
9196 <docstring>Gets the associated mask (if any) which may have been loaded from a
9197 file or explpicitly set for the bitmap.
9199 :see: `SetMask`, `wx.Mask`
9202 <method name=
"SetMask" type=
"" overloaded=
"no">
9203 <autodoc>SetMask(self, Mask mask)
</autodoc>
9204 <docstring>Sets the mask for this bitmap.
9206 :see: `GetMask`, `wx.Mask`
9209 <param name=
"mask" type=
"wxMask" default=
""/>
9212 <method name=
"SetMaskColour" type=
"" overloaded=
"no">
9213 <autodoc>SetMaskColour(self, Colour colour)
</autodoc>
9214 <docstring>Create a Mask based on a specified colour in the Bitmap.
</docstring>
9216 <param name=
"colour" type=
"Colour" default=
""/>
9219 <method name=
"GetSubBitmap" type=
"Bitmap" overloaded=
"no">
9220 <autodoc>GetSubBitmap(self, Rect rect) -
> Bitmap
</autodoc>
9221 <docstring>Returns a sub-bitmap of the current one as long as the rect belongs
9222 entirely to the bitmap. This function preserves bit depth and mask
9223 information.
</docstring>
9225 <param name=
"rect" type=
"Rect" default=
""/>
9228 <method name=
"SaveFile" type=
"bool" overloaded=
"no">
9229 <autodoc>SaveFile(self, String name, int type, Palette palette=None) -
> bool
</autodoc>
9230 <docstring>Saves a bitmap in the named file. See `__init__` for a description of
9231 the ``type`` parameter.
</docstring>
9233 <param name=
"name" type=
"String" default=
""/>
9234 <param name=
"type" type=
"wxBitmapType" default=
""/>
9235 <param name=
"palette" type=
"Palette" default=
"NULL"/>
9238 <method name=
"LoadFile" type=
"bool" overloaded=
"no">
9239 <autodoc>LoadFile(self, String name, int type) -
> bool
</autodoc>
9240 <docstring>Loads a bitmap from a file. See `__init__` for a description of the
9241 ``type`` parameter.
</docstring>
9243 <param name=
"name" type=
"String" default=
""/>
9244 <param name=
"type" type=
"wxBitmapType" default=
""/>
9247 <method name=
"CopyFromIcon" type=
"bool" overloaded=
"no">
9248 <autodoc>CopyFromIcon(self, Icon icon) -
> bool
</autodoc>
9250 <param name=
"icon" type=
"wxIcon" default=
""/>
9253 <method name=
"SetHeight" type=
"" overloaded=
"no">
9254 <autodoc>SetHeight(self, int height)
</autodoc>
9255 <docstring>Set the height property (does not affect the existing bitmap data).
</docstring>
9257 <param name=
"height" type=
"int" default=
""/>
9260 <method name=
"SetWidth" type=
"" overloaded=
"no">
9261 <autodoc>SetWidth(self, int width)
</autodoc>
9262 <docstring>Set the width property (does not affect the existing bitmap data).
</docstring>
9264 <param name=
"width" type=
"int" default=
""/>
9267 <method name=
"SetDepth" type=
"" overloaded=
"no">
9268 <autodoc>SetDepth(self, int depth)
</autodoc>
9269 <docstring>Set the depth property (does not affect the existing bitmap data).
</docstring>
9271 <param name=
"depth" type=
"int" default=
""/>
9274 <method name=
"SetSize" type=
"" overloaded=
"no">
9275 <autodoc>SetSize(self, Size size)
</autodoc>
9276 <docstring>Set the bitmap size (does not affect the existing bitmap data).
</docstring>
9278 <param name=
"size" type=
"Size" default=
""/>
9281 <method name=
"__eq__" type=
"bool" overloaded=
"no">
9282 <autodoc>__eq__(self, Bitmap other) -
> bool
</autodoc>
9284 <param name=
"other" type=
"Bitmap" default=
""/>
9287 <method name=
"__ne__" type=
"bool" overloaded=
"no">
9288 <autodoc>__ne__(self, Bitmap other) -
> bool
</autodoc>
9290 <param name=
"other" type=
"Bitmap" default=
""/>
9294 <class name=
"Mask" oldname=
"wxMask" module=
"_gdi">
9295 <docstring>This class encapsulates a monochrome mask bitmap, where the masked
9296 area is black and the unmasked area is white. When associated with a
9297 bitmap and drawn in a device context, the unmasked area of the bitmap
9298 will be drawn, and the masked area will not be drawn.
9300 A mask may be associated with a `wx.Bitmap`. It is used in
9301 `wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
9302 `wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
9304 <baseclass name=
"Object"/>
9305 <constructor name=
"Mask" overloaded=
"no">
9306 <autodoc>__init__(self, Bitmap bitmap, Colour colour=NullColour) -
> Mask
</autodoc>
9307 <docstring>Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
9308 that indicates the transparent portions of the mask. In other words,
9309 the pixels in ``bitmap`` that match ``colour`` will be the transparent
9310 portions of the mask. If no ``colour`` or an invalid ``colour`` is
9311 passed then BLACK is used.
9313 :see: `wx.Bitmap`, `wx.Colour`
</docstring>
9315 <param name=
"bitmap" type=
"Bitmap" default=
""/>
9316 <param name=
"colour" type=
"Colour" default=
"wxNullColour"/>
9320 <pythoncode> MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.")
</pythoncode>
9321 <class name=
"Icon" oldname=
"wxIcon" module=
"_gdi">
9322 <baseclass name=
"GDIObject"/>
9323 <constructor name=
"Icon" overloaded=
"no">
9324 <autodoc>__init__(self, String name, int type, int desiredWidth=-
1, int desiredHeight=-
1) -
> Icon
</autodoc>
9326 <param name=
"name" type=
"String" default=
""/>
9327 <param name=
"type" type=
"wxBitmapType" default=
""/>
9328 <param name=
"desiredWidth" type=
"int" default=
"-1"/>
9329 <param name=
"desiredHeight" type=
"int" default=
"-1"/>
9332 <constructor name=
"EmptyIcon" overloaded=
"no">
9333 <autodoc>EmptyIcon() -
> Icon
</autodoc>
9335 <constructor name=
"IconFromLocation" overloaded=
"no">
9336 <autodoc>IconFromLocation(IconLocation loc) -
> Icon
</autodoc>
9338 <param name=
"loc" type=
"wxIconLocation" default=
""/>
9341 <constructor name=
"IconFromBitmap" overloaded=
"no">
9342 <autodoc>IconFromBitmap(Bitmap bmp) -
> Icon
</autodoc>
9344 <param name=
"bmp" type=
"Bitmap" default=
""/>
9347 <constructor name=
"IconFromXPMData" overloaded=
"no">
9348 <autodoc>IconFromXPMData(PyObject listOfStrings) -
> Icon
</autodoc>
9350 <param name=
"listOfStrings" type=
"PyObject" default=
""/>
9353 <destructor name=
"~wxIcon" overloaded=
"no">
9354 <autodoc>__del__(self)
</autodoc>
9356 <method name=
"LoadFile" type=
"bool" overloaded=
"no">
9357 <autodoc>LoadFile(self, String name, int type) -
> bool
</autodoc>
9359 <param name=
"name" type=
"String" default=
""/>
9360 <param name=
"type" type=
"wxBitmapType" default=
""/>
9363 <method name=
"Ok" type=
"bool" overloaded=
"no">
9364 <autodoc>Ok(self) -
> bool
</autodoc>
9366 <method name=
"GetWidth" type=
"int" overloaded=
"no">
9367 <autodoc>GetWidth(self) -
> int
</autodoc>
9369 <method name=
"GetHeight" type=
"int" overloaded=
"no">
9370 <autodoc>GetHeight(self) -
> int
</autodoc>
9372 <method name=
"GetDepth" type=
"int" overloaded=
"no">
9373 <autodoc>GetDepth(self) -
> int
</autodoc>
9375 <method name=
"SetWidth" type=
"" overloaded=
"no">
9376 <autodoc>SetWidth(self, int w)
</autodoc>
9378 <param name=
"w" type=
"int" default=
""/>
9381 <method name=
"SetHeight" type=
"" overloaded=
"no">
9382 <autodoc>SetHeight(self, int h)
</autodoc>
9384 <param name=
"h" type=
"int" default=
""/>
9387 <method name=
"SetDepth" type=
"" overloaded=
"no">
9388 <autodoc>SetDepth(self, int d)
</autodoc>
9390 <param name=
"d" type=
"int" default=
""/>
9393 <method name=
"CopyFromBitmap" type=
"" overloaded=
"no">
9394 <autodoc>CopyFromBitmap(self, Bitmap bmp)
</autodoc>
9396 <param name=
"bmp" type=
"Bitmap" default=
""/>
9400 <class name=
"IconLocation" oldname=
"wxIconLocation" module=
"_gdi">
9401 <constructor name=
"IconLocation" overloaded=
"no">
9402 <autodoc>__init__(self, String filename=
&wxPyEmptyString, int num=
0) -
> IconLocation
</autodoc>
9404 <param name=
"filename" type=
"String" default=
"&wxPyEmptyString"/>
9405 <param name=
"num" type=
"int" default=
"0"/>
9408 <destructor name=
"~wxIconLocation" overloaded=
"no">
9409 <autodoc>__del__(self)
</autodoc>
9411 <method name=
"IsOk" type=
"bool" overloaded=
"no">
9412 <autodoc>IsOk(self) -
> bool
</autodoc>
9414 <method name=
"SetFileName" type=
"" overloaded=
"no">
9415 <autodoc>SetFileName(self, String filename)
</autodoc>
9417 <param name=
"filename" type=
"String" default=
""/>
9420 <method name=
"GetFileName" type=
"String" overloaded=
"no">
9421 <autodoc>GetFileName(self) -
> String
</autodoc>
9423 <method name=
"SetIndex" type=
"" overloaded=
"no">
9424 <autodoc>SetIndex(self, int num)
</autodoc>
9426 <param name=
"num" type=
"int" default=
""/>
9429 <method name=
"GetIndex" type=
"int" overloaded=
"no">
9430 <autodoc>GetIndex(self) -
> int
</autodoc>
9433 <class name=
"IconBundle" oldname=
"wxIconBundle" module=
"_gdi">
9434 <constructor name=
"IconBundle" overloaded=
"no">
9435 <autodoc>__init__(self) -
> IconBundle
</autodoc>
9437 <constructor name=
"IconBundleFromFile" overloaded=
"no">
9438 <autodoc>IconBundleFromFile(String file, long type) -
> IconBundle
</autodoc>
9440 <param name=
"file" type=
"String" default=
""/>
9441 <param name=
"type" type=
"long" default=
""/>
9444 <constructor name=
"IconBundleFromIcon" overloaded=
"no">
9445 <autodoc>IconBundleFromIcon(Icon icon) -
> IconBundle
</autodoc>
9447 <param name=
"icon" type=
"Icon" default=
""/>
9450 <destructor name=
"~wxIconBundle" overloaded=
"no">
9451 <autodoc>__del__(self)
</autodoc>
9453 <method name=
"AddIcon" type=
"" overloaded=
"no">
9454 <autodoc>AddIcon(self, Icon icon)
</autodoc>
9456 <param name=
"icon" type=
"Icon" default=
""/>
9459 <method name=
"AddIconFromFile" type=
"" overloaded=
"no">
9460 <autodoc>AddIconFromFile(self, String file, long type)
</autodoc>
9462 <param name=
"file" type=
"String" default=
""/>
9463 <param name=
"type" type=
"long" default=
""/>
9466 <method name=
"GetIcon" type=
"Icon" overloaded=
"no">
9467 <autodoc>GetIcon(self, Size size) -
> Icon
</autodoc>
9469 <param name=
"size" type=
"Size" default=
""/>
9473 <class name=
"Cursor" oldname=
"wxCursor" module=
"_gdi">
9474 <docstring>A cursor is a small bitmap usually used for denoting where the mouse
9475 pointer is, with a picture that might indicate the interpretation of a
9478 A single cursor object may be used in many windows (any subwindow
9479 type). The wxWindows convention is to set the cursor for a window, as
9480 in X, rather than to set it globally as in MS Windows, although a
9481 global `wx.SetCursor` function is also available for use on MS Windows.
9486 ======================== ======================================
9487 wx.CURSOR_ARROW A standard arrow cursor.
9488 wx.CURSOR_RIGHT_ARROW A standard arrow cursor pointing to the right.
9489 wx.CURSOR_BLANK Transparent cursor.
9490 wx.CURSOR_BULLSEYE Bullseye cursor.
9491 wx.CURSOR_CHAR Rectangular character cursor.
9492 wx.CURSOR_CROSS A cross cursor.
9493 wx.CURSOR_HAND A hand cursor.
9494 wx.CURSOR_IBEAM An I-beam cursor (vertical line).
9495 wx.CURSOR_LEFT_BUTTON Represents a mouse with the left button depressed.
9496 wx.CURSOR_MAGNIFIER A magnifier icon.
9497 wx.CURSOR_MIDDLE_BUTTON Represents a mouse with the middle button depressed.
9498 wx.CURSOR_NO_ENTRY A no-entry sign cursor.
9499 wx.CURSOR_PAINT_BRUSH A paintbrush cursor.
9500 wx.CURSOR_PENCIL A pencil cursor.
9501 wx.CURSOR_POINT_LEFT A cursor that points left.
9502 wx.CURSOR_POINT_RIGHT A cursor that points right.
9503 wx.CURSOR_QUESTION_ARROW An arrow and question mark.
9504 wx.CURSOR_RIGHT_BUTTON Represents a mouse with the right button depressed.
9505 wx.CURSOR_SIZENESW A sizing cursor pointing NE-SW.
9506 wx.CURSOR_SIZENS A sizing cursor pointing N-S.
9507 wx.CURSOR_SIZENWSE A sizing cursor pointing NW-SE.
9508 wx.CURSOR_SIZEWE A sizing cursor pointing W-E.
9509 wx.CURSOR_SIZING A general sizing cursor.
9510 wx.CURSOR_SPRAYCAN A spraycan cursor.
9511 wx.CURSOR_WAIT A wait cursor.
9512 wx.CURSOR_WATCH A watch cursor.
9513 wx.CURSOR_ARROWWAIT A cursor with both an arrow and an hourglass, (windows.)
9514 ======================== ======================================
9517 <baseclass name=
"GDIObject"/>
9518 <constructor name=
"Cursor" overloaded=
"no">
9519 <autodoc>__init__(self, String cursorName, long type, int hotSpotX=
0, int hotSpotY=
0) -
> Cursor
</autodoc>
9520 <docstring>Construct a Cursor from a file. Specify the type of file using
9521 wx.BITAMP_TYPE* constants, and specify the hotspot if not using a cur
9524 This constructor is not available on wxGTK, use ``wx.StockCursor``,
9525 ``wx.CursorFromImage``, or ``wx.CursorFromBits`` instead.
</docstring>
9527 <param name=
"cursorName" type=
"String" default=
""/>
9528 <param name=
"type" type=
"long" default=
""/>
9529 <param name=
"hotSpotX" type=
"int" default=
"0"/>
9530 <param name=
"hotSpotY" type=
"int" default=
"0"/>
9533 <constructor name=
"StockCursor" overloaded=
"no">
9534 <autodoc>StockCursor(int id) -
> Cursor
</autodoc>
9535 <docstring>Create a cursor using one of the stock cursors. Note that not all
9536 cursors are available on all platforms.
</docstring>
9538 <param name=
"id" type=
"int" default=
""/>
9541 <constructor name=
"CursorFromImage" overloaded=
"no">
9542 <autodoc>CursorFromImage(Image image) -
> Cursor
</autodoc>
9543 <docstring>Constructs a cursor from a wxImage. The cursor is monochrome, colors
9544 with the RGB elements all greater than
127 will be foreground, colors
9545 less than this background. The mask (if any) will be used as
9547 In MSW the foreground will be white and the background
9548 black. The cursor is resized to
32x32.
9550 In GTK, the two most frequent colors will be used for foreground and
9551 background. The cursor will be displayed at the size of the image.
9553 On MacOS the cursor is resized to
16x16 and currently only shown as
9554 black/white (mask respected).
</docstring>
9556 <param name=
"image" type=
"Image" default=
""/>
9559 <destructor name=
"~wxCursor" overloaded=
"no">
9560 <autodoc>__del__(self)
</autodoc>
9562 <method name=
"Ok" type=
"bool" overloaded=
"no">
9563 <autodoc>Ok(self) -
> bool
</autodoc>
9567 #---------------------------------------------------------------------------
9569 <class name=
"Region" oldname=
"wxRegion" module=
"_gdi">
9570 <baseclass name=
"GDIObject"/>
9571 <constructor name=
"Region" overloaded=
"no">
9572 <autodoc>__init__(self, int x=
0, int y=
0, int width=
0, int height=
0) -
> Region
</autodoc>
9574 <param name=
"x" type=
"int" default=
"0"/>
9575 <param name=
"y" type=
"int" default=
"0"/>
9576 <param name=
"width" type=
"int" default=
"0"/>
9577 <param name=
"height" type=
"int" default=
"0"/>
9580 <constructor name=
"RegionFromBitmap" overloaded=
"no">
9581 <autodoc>RegionFromBitmap(Bitmap bmp) -
> Region
</autodoc>
9583 <param name=
"bmp" type=
"Bitmap" default=
""/>
9586 <constructor name=
"RegionFromBitmapColour" overloaded=
"no">
9587 <autodoc>RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=
0) -
> Region
</autodoc>
9589 <param name=
"bmp" type=
"Bitmap" default=
""/>
9590 <param name=
"transColour" type=
"Colour" default=
""/>
9591 <param name=
"tolerance" type=
"int" default=
"0"/>
9594 <constructor name=
"RegionFromPoints" overloaded=
"no">
9595 <autodoc>RegionFromPoints(int points, Point points_array, int fillStyle=WINDING_RULE) -
> Region
</autodoc>
9597 <param name=
"points" type=
"int" default=
""/>
9598 <param name=
"points_array" type=
"Point" default=
""/>
9599 <param name=
"fillStyle" type=
"int" default=
"wxWINDING_RULE"/>
9602 <destructor name=
"~wxRegion" overloaded=
"no">
9603 <autodoc>__del__(self)
</autodoc>
9605 <method name=
"Clear" type=
"" overloaded=
"no">
9606 <autodoc>Clear(self)
</autodoc>
9608 <method name=
"Offset" type=
"bool" overloaded=
"no">
9609 <autodoc>Offset(self, int x, int y) -
> bool
</autodoc>
9611 <param name=
"x" type=
"int" default=
""/>
9612 <param name=
"y" type=
"int" default=
""/>
9615 <method name=
"Contains" type=
"wxRegionContain" overloaded=
"no">
9616 <autodoc>Contains(self, int x, int y) -
> int
</autodoc>
9618 <param name=
"x" type=
"int" default=
""/>
9619 <param name=
"y" type=
"int" default=
""/>
9622 <method name=
"ContainsPoint" type=
"wxRegionContain" overloaded=
"no">
9623 <autodoc>ContainsPoint(self, Point pt) -
> int
</autodoc>
9625 <param name=
"pt" type=
"Point" default=
""/>
9628 <method name=
"ContainsRect" type=
"wxRegionContain" overloaded=
"no">
9629 <autodoc>ContainsRect(self, Rect rect) -
> int
</autodoc>
9631 <param name=
"rect" type=
"Rect" default=
""/>
9634 <method name=
"ContainsRectDim" type=
"wxRegionContain" overloaded=
"no">
9635 <autodoc>ContainsRectDim(self, int x, int y, int w, int h) -
> int
</autodoc>
9637 <param name=
"x" type=
"int" default=
""/>
9638 <param name=
"y" type=
"int" default=
""/>
9639 <param name=
"w" type=
"int" default=
""/>
9640 <param name=
"h" type=
"int" default=
""/>
9643 <method name=
"GetBox" type=
"Rect" overloaded=
"no">
9644 <autodoc>GetBox(self) -
> Rect
</autodoc>
9646 <method name=
"Intersect" type=
"bool" overloaded=
"no">
9647 <autodoc>Intersect(self, int x, int y, int width, int height) -
> bool
</autodoc>
9649 <param name=
"x" type=
"int" default=
""/>
9650 <param name=
"y" type=
"int" default=
""/>
9651 <param name=
"width" type=
"int" default=
""/>
9652 <param name=
"height" type=
"int" default=
""/>
9655 <method name=
"IntersectRect" type=
"bool" overloaded=
"no">
9656 <autodoc>IntersectRect(self, Rect rect) -
> bool
</autodoc>
9658 <param name=
"rect" type=
"Rect" default=
""/>
9661 <method name=
"IntersectRegion" type=
"bool" overloaded=
"no">
9662 <autodoc>IntersectRegion(self, Region region) -
> bool
</autodoc>
9664 <param name=
"region" type=
"Region" default=
""/>
9667 <method name=
"IsEmpty" type=
"bool" overloaded=
"no">
9668 <autodoc>IsEmpty(self) -
> bool
</autodoc>
9670 <method name=
"Union" type=
"bool" overloaded=
"no">
9671 <autodoc>Union(self, int x, int y, int width, int height) -
> bool
</autodoc>
9673 <param name=
"x" type=
"int" default=
""/>
9674 <param name=
"y" type=
"int" default=
""/>
9675 <param name=
"width" type=
"int" default=
""/>
9676 <param name=
"height" type=
"int" default=
""/>
9679 <method name=
"UnionRect" type=
"bool" overloaded=
"no">
9680 <autodoc>UnionRect(self, Rect rect) -
> bool
</autodoc>
9682 <param name=
"rect" type=
"Rect" default=
""/>
9685 <method name=
"UnionRegion" type=
"bool" overloaded=
"no">
9686 <autodoc>UnionRegion(self, Region region) -
> bool
</autodoc>
9688 <param name=
"region" type=
"Region" default=
""/>
9691 <method name=
"Subtract" type=
"bool" overloaded=
"no">
9692 <autodoc>Subtract(self, int x, int y, int width, int height) -
> bool
</autodoc>
9694 <param name=
"x" type=
"int" default=
""/>
9695 <param name=
"y" type=
"int" default=
""/>
9696 <param name=
"width" type=
"int" default=
""/>
9697 <param name=
"height" type=
"int" default=
""/>
9700 <method name=
"SubtractRect" type=
"bool" overloaded=
"no">
9701 <autodoc>SubtractRect(self, Rect rect) -
> bool
</autodoc>
9703 <param name=
"rect" type=
"Rect" default=
""/>
9706 <method name=
"SubtractRegion" type=
"bool" overloaded=
"no">
9707 <autodoc>SubtractRegion(self, Region region) -
> bool
</autodoc>
9709 <param name=
"region" type=
"Region" default=
""/>
9712 <method name=
"Xor" type=
"bool" overloaded=
"no">
9713 <autodoc>Xor(self, int x, int y, int width, int height) -
> bool
</autodoc>
9715 <param name=
"x" type=
"int" default=
""/>
9716 <param name=
"y" type=
"int" default=
""/>
9717 <param name=
"width" type=
"int" default=
""/>
9718 <param name=
"height" type=
"int" default=
""/>
9721 <method name=
"XorRect" type=
"bool" overloaded=
"no">
9722 <autodoc>XorRect(self, Rect rect) -
> bool
</autodoc>
9724 <param name=
"rect" type=
"Rect" default=
""/>
9727 <method name=
"XorRegion" type=
"bool" overloaded=
"no">
9728 <autodoc>XorRegion(self, Region region) -
> bool
</autodoc>
9730 <param name=
"region" type=
"Region" default=
""/>
9733 <method name=
"ConvertToBitmap" type=
"Bitmap" overloaded=
"no">
9734 <autodoc>ConvertToBitmap(self) -
> Bitmap
</autodoc>
9736 <method name=
"UnionBitmap" type=
"bool" overloaded=
"no">
9737 <autodoc>UnionBitmap(self, Bitmap bmp) -
> bool
</autodoc>
9739 <param name=
"bmp" type=
"Bitmap" default=
""/>
9742 <method name=
"UnionBitmapColour" type=
"bool" overloaded=
"no">
9743 <autodoc>UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=
0) -
> bool
</autodoc>
9745 <param name=
"bmp" type=
"Bitmap" default=
""/>
9746 <param name=
"transColour" type=
"Colour" default=
""/>
9747 <param name=
"tolerance" type=
"int" default=
"0"/>
9751 <class name=
"RegionIterator" oldname=
"wxRegionIterator" module=
"_gdi">
9752 <baseclass name=
"Object"/>
9753 <constructor name=
"RegionIterator" overloaded=
"no">
9754 <autodoc>__init__(self, Region region) -
> RegionIterator
</autodoc>
9756 <param name=
"region" type=
"Region" default=
""/>
9759 <destructor name=
"~wxRegionIterator" overloaded=
"no">
9760 <autodoc>__del__(self)
</autodoc>
9762 <method name=
"GetX" type=
"int" overloaded=
"no">
9763 <autodoc>GetX(self) -
> int
</autodoc>
9765 <method name=
"GetY" type=
"int" overloaded=
"no">
9766 <autodoc>GetY(self) -
> int
</autodoc>
9768 <method name=
"GetW" type=
"int" overloaded=
"no">
9769 <autodoc>GetW(self) -
> int
</autodoc>
9771 <method name=
"GetWidth" type=
"int" overloaded=
"no">
9772 <autodoc>GetWidth(self) -
> int
</autodoc>
9774 <method name=
"GetH" type=
"int" overloaded=
"no">
9775 <autodoc>GetH(self) -
> int
</autodoc>
9777 <method name=
"GetHeight" type=
"int" overloaded=
"no">
9778 <autodoc>GetHeight(self) -
> int
</autodoc>
9780 <method name=
"GetRect" type=
"Rect" overloaded=
"no">
9781 <autodoc>GetRect(self) -
> Rect
</autodoc>
9783 <method name=
"HaveRects" type=
"bool" overloaded=
"no">
9784 <autodoc>HaveRects(self) -
> bool
</autodoc>
9786 <method name=
"Reset" type=
"" overloaded=
"no">
9787 <autodoc>Reset(self)
</autodoc>
9789 <method name=
"Next" type=
"" overloaded=
"no">
9790 <autodoc>Next(self)
</autodoc>
9792 <method name=
"__nonzero__" type=
"bool" overloaded=
"no">
9793 <autodoc>__nonzero__(self) -
> bool
</autodoc>
9797 #---------------------------------------------------------------------------
9800 #---------------------------------------------------------------------------
9802 <class name=
"NativeFontInfo" oldname=
"wxNativeFontInfo" module=
"_gdi">
9803 <constructor name=
"NativeFontInfo" overloaded=
"no">
9804 <autodoc>__init__(self) -
> NativeFontInfo
</autodoc>
9806 <destructor name=
"~wxNativeFontInfo" overloaded=
"no">
9807 <autodoc>__del__(self)
</autodoc>
9809 <method name=
"Init" type=
"" overloaded=
"no">
9810 <autodoc>Init(self)
</autodoc>
9812 <method name=
"InitFromFont" type=
"" overloaded=
"no">
9813 <autodoc>InitFromFont(self, Font font)
</autodoc>
9815 <param name=
"font" type=
"wxFont" default=
""/>
9818 <method name=
"GetPointSize" type=
"int" overloaded=
"no">
9819 <autodoc>GetPointSize(self) -
> int
</autodoc>
9821 <method name=
"GetStyle" type=
"wxFontStyle" overloaded=
"no">
9822 <autodoc>GetStyle(self) -
> int
</autodoc>
9824 <method name=
"GetWeight" type=
"wxFontWeight" overloaded=
"no">
9825 <autodoc>GetWeight(self) -
> int
</autodoc>
9827 <method name=
"GetUnderlined" type=
"bool" overloaded=
"no">
9828 <autodoc>GetUnderlined(self) -
> bool
</autodoc>
9830 <method name=
"GetFaceName" type=
"String" overloaded=
"no">
9831 <autodoc>GetFaceName(self) -
> String
</autodoc>
9833 <method name=
"GetFamily" type=
"wxFontFamily" overloaded=
"no">
9834 <autodoc>GetFamily(self) -
> int
</autodoc>
9836 <method name=
"GetEncoding" type=
"wxFontEncoding" overloaded=
"no">
9837 <autodoc>GetEncoding(self) -
> int
</autodoc>
9839 <method name=
"SetPointSize" type=
"" overloaded=
"no">
9840 <autodoc>SetPointSize(self, int pointsize)
</autodoc>
9842 <param name=
"pointsize" type=
"int" default=
""/>
9845 <method name=
"SetStyle" type=
"" overloaded=
"no">
9846 <autodoc>SetStyle(self, int style)
</autodoc>
9848 <param name=
"style" type=
"wxFontStyle" default=
""/>
9851 <method name=
"SetWeight" type=
"" overloaded=
"no">
9852 <autodoc>SetWeight(self, int weight)
</autodoc>
9854 <param name=
"weight" type=
"wxFontWeight" default=
""/>
9857 <method name=
"SetUnderlined" type=
"" overloaded=
"no">
9858 <autodoc>SetUnderlined(self, bool underlined)
</autodoc>
9860 <param name=
"underlined" type=
"bool" default=
""/>
9863 <method name=
"SetFaceName" type=
"" overloaded=
"no">
9864 <autodoc>SetFaceName(self, String facename)
</autodoc>
9866 <param name=
"facename" type=
"String" default=
""/>
9869 <method name=
"SetFamily" type=
"" overloaded=
"no">
9870 <autodoc>SetFamily(self, int family)
</autodoc>
9872 <param name=
"family" type=
"wxFontFamily" default=
""/>
9875 <method name=
"SetEncoding" type=
"" overloaded=
"no">
9876 <autodoc>SetEncoding(self, int encoding)
</autodoc>
9878 <param name=
"encoding" type=
"wxFontEncoding" default=
""/>
9881 <method name=
"FromString" type=
"bool" overloaded=
"no">
9882 <autodoc>FromString(self, String s) -
> bool
</autodoc>
9884 <param name=
"s" type=
"String" default=
""/>
9887 <method name=
"ToString" type=
"String" overloaded=
"no">
9888 <autodoc>ToString(self) -
> String
</autodoc>
9890 <method name=
"__str__" type=
"String" overloaded=
"no">
9891 <autodoc>__str__(self) -
> String
</autodoc>
9893 <method name=
"FromUserString" type=
"bool" overloaded=
"no">
9894 <autodoc>FromUserString(self, String s) -
> bool
</autodoc>
9896 <param name=
"s" type=
"String" default=
""/>
9899 <method name=
"ToUserString" type=
"String" overloaded=
"no">
9900 <autodoc>ToUserString(self) -
> String
</autodoc>
9903 <class name=
"NativeEncodingInfo" oldname=
"wxNativeEncodingInfo" module=
"_gdi">
9904 <constructor name=
"NativeEncodingInfo" overloaded=
"no">
9905 <autodoc>__init__(self) -
> NativeEncodingInfo
</autodoc>
9907 <destructor name=
"~wxNativeEncodingInfo" overloaded=
"no">
9908 <autodoc>__del__(self)
</autodoc>
9910 <property name=
"facename" type=
"String" readonly=
"no"/>
9911 <property name=
"encoding" type=
"wxFontEncoding" readonly=
"no"/>
9912 <method name=
"FromString" type=
"bool" overloaded=
"no">
9913 <autodoc>FromString(self, String s) -
> bool
</autodoc>
9915 <param name=
"s" type=
"String" default=
""/>
9918 <method name=
"ToString" type=
"String" overloaded=
"no">
9919 <autodoc>ToString(self) -
> String
</autodoc>
9922 <method name=
"GetNativeFontEncoding" oldname=
"wxGetNativeFontEncoding" type=
"NativeEncodingInfo" overloaded=
"no">
9923 <autodoc>GetNativeFontEncoding(int encoding) -
> NativeEncodingInfo
</autodoc>
9925 <param name=
"encoding" type=
"wxFontEncoding" default=
""/>
9928 <method name=
"TestFontEncoding" oldname=
"wxTestFontEncoding" type=
"bool" overloaded=
"no">
9929 <autodoc>TestFontEncoding(NativeEncodingInfo info) -
> bool
</autodoc>
9931 <param name=
"info" type=
"NativeEncodingInfo" default=
""/>
9935 #---------------------------------------------------------------------------
9937 <class name=
"FontMapper" oldname=
"wxFontMapper" module=
"_gdi">
9938 <constructor name=
"FontMapper" overloaded=
"no">
9939 <autodoc>__init__(self) -
> FontMapper
</autodoc>
9941 <destructor name=
"~wxFontMapper" overloaded=
"no">
9942 <autodoc>__del__(self)
</autodoc>
9944 <staticmethod name=
"Get" type=
"FontMapper" overloaded=
"no">
9945 <autodoc>Get() -
> FontMapper
</autodoc>
9947 <staticmethod name=
"Set" type=
"FontMapper" overloaded=
"no">
9948 <autodoc>Set(FontMapper mapper) -
> FontMapper
</autodoc>
9950 <param name=
"mapper" type=
"FontMapper" default=
""/>
9953 <method name=
"CharsetToEncoding" type=
"wxFontEncoding" overloaded=
"no">
9954 <autodoc>CharsetToEncoding(self, String charset, bool interactive=True) -
> int
</autodoc>
9956 <param name=
"charset" type=
"String" default=
""/>
9957 <param name=
"interactive" type=
"bool" default=
"True"/>
9960 <staticmethod name=
"GetSupportedEncodingsCount" type=
"size_t" overloaded=
"no">
9961 <autodoc>GetSupportedEncodingsCount() -
> size_t
</autodoc>
9963 <staticmethod name=
"GetEncoding" type=
"wxFontEncoding" overloaded=
"no">
9964 <autodoc>GetEncoding(size_t n) -
> int
</autodoc>
9966 <param name=
"n" type=
"size_t" default=
""/>
9969 <staticmethod name=
"GetEncodingName" type=
"String" overloaded=
"no">
9970 <autodoc>GetEncodingName(int encoding) -
> String
</autodoc>
9972 <param name=
"encoding" type=
"wxFontEncoding" default=
""/>
9975 <staticmethod name=
"GetEncodingDescription" type=
"String" overloaded=
"no">
9976 <autodoc>GetEncodingDescription(int encoding) -
> String
</autodoc>
9978 <param name=
"encoding" type=
"wxFontEncoding" default=
""/>
9981 <staticmethod name=
"GetEncodingFromName" type=
"wxFontEncoding" overloaded=
"no">
9982 <autodoc>GetEncodingFromName(String name) -
> int
</autodoc>
9984 <param name=
"name" type=
"String" default=
""/>
9987 <method name=
"SetConfig" type=
"" overloaded=
"no">
9988 <autodoc>SetConfig(self, ConfigBase config)
</autodoc>
9990 <param name=
"config" type=
"wxConfigBase" default=
""/>
9993 <method name=
"SetConfigPath" type=
"" overloaded=
"no">
9994 <autodoc>SetConfigPath(self, String prefix)
</autodoc>
9996 <param name=
"prefix" type=
"String" default=
""/>
9999 <staticmethod name=
"GetDefaultConfigPath" type=
"String" overloaded=
"no">
10000 <autodoc>GetDefaultConfigPath() -
> String
</autodoc>
10002 <method name=
"GetAltForEncoding" type=
"PyObject" overloaded=
"no">
10003 <autodoc>GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -
> PyObject
</autodoc>
10005 <param name=
"encoding" type=
"wxFontEncoding" default=
""/>
10006 <param name=
"facename" type=
"String" default=
"wxPyEmptyString"/>
10007 <param name=
"interactive" type=
"bool" default=
"True"/>
10010 <method name=
"IsEncodingAvailable" type=
"bool" overloaded=
"no">
10011 <autodoc>IsEncodingAvailable(self, int encoding, String facename=EmptyString) -
> bool
</autodoc>
10013 <param name=
"encoding" type=
"wxFontEncoding" default=
""/>
10014 <param name=
"facename" type=
"String" default=
"wxPyEmptyString"/>
10017 <method name=
"SetDialogParent" type=
"" overloaded=
"no">
10018 <autodoc>SetDialogParent(self, Window parent)
</autodoc>
10020 <param name=
"parent" type=
"Window" default=
""/>
10023 <method name=
"SetDialogTitle" type=
"" overloaded=
"no">
10024 <autodoc>SetDialogTitle(self, String title)
</autodoc>
10026 <param name=
"title" type=
"String" default=
""/>
10031 #---------------------------------------------------------------------------
10033 <class name=
"Font" oldname=
"wxFont" module=
"_gdi">
10034 <baseclass name=
"GDIObject"/>
10035 <constructor name=
"Font" overloaded=
"no">
10036 <autodoc>__init__(self, int pointSize, int family, int style, int weight, bool underline=False,
10037 String face=EmptyString,
10038 int encoding=FONTENCODING_DEFAULT) -
> Font
</autodoc>
10040 <param name=
"pointSize" type=
"int" default=
""/>
10041 <param name=
"family" type=
"int" default=
""/>
10042 <param name=
"style" type=
"int" default=
""/>
10043 <param name=
"weight" type=
"int" default=
""/>
10044 <param name=
"underline" type=
"bool" default=
"False"/>
10045 <param name=
"face" type=
"String" default=
"wxPyEmptyString"/>
10046 <param name=
"encoding" type=
"wxFontEncoding" default=
"wxFONTENCODING_DEFAULT"/>
10049 <constructor name=
"FontFromNativeInfo" overloaded=
"no">
10050 <autodoc>FontFromNativeInfo(NativeFontInfo info) -
> Font
</autodoc>
10052 <param name=
"info" type=
"NativeFontInfo" default=
""/>
10055 <constructor name=
"FontFromNativeInfoString" overloaded=
"no">
10056 <autodoc>FontFromNativeInfoString(String info) -
> Font
</autodoc>
10058 <param name=
"info" type=
"String" default=
""/>
10061 <constructor name=
"Font2" overloaded=
"no">
10062 <autodoc>Font2(int pointSize, int family, int flags=FONTFLAG_DEFAULT,
10063 String face=EmptyString, int encoding=FONTENCODING_DEFAULT) -
> Font
</autodoc>
10065 <param name=
"pointSize" type=
"int" default=
""/>
10066 <param name=
"family" type=
"wxFontFamily" default=
""/>
10067 <param name=
"flags" type=
"int" default=
"wxFONTFLAG_DEFAULT"/>
10068 <param name=
"face" type=
"String" default=
"wxPyEmptyString"/>
10069 <param name=
"encoding" type=
"wxFontEncoding" default=
"wxFONTENCODING_DEFAULT"/>
10072 <destructor name=
"~wxFont" overloaded=
"no">
10073 <autodoc>__del__(self)
</autodoc>
10075 <method name=
"Ok" type=
"bool" overloaded=
"no">
10076 <autodoc>Ok(self) -
> bool
</autodoc>
10078 <method name=
"__eq__" type=
"bool" overloaded=
"no">
10079 <autodoc>__eq__(self, Font other) -
> bool
</autodoc>
10081 <param name=
"other" type=
"Font" default=
""/>
10084 <method name=
"__ne__" type=
"bool" overloaded=
"no">
10085 <autodoc>__ne__(self, Font other) -
> bool
</autodoc>
10087 <param name=
"other" type=
"Font" default=
""/>
10090 <method name=
"GetPointSize" type=
"int" overloaded=
"no">
10091 <autodoc>GetPointSize(self) -
> int
</autodoc>
10093 <method name=
"GetFamily" type=
"int" overloaded=
"no">
10094 <autodoc>GetFamily(self) -
> int
</autodoc>
10096 <method name=
"GetStyle" type=
"int" overloaded=
"no">
10097 <autodoc>GetStyle(self) -
> int
</autodoc>
10099 <method name=
"GetWeight" type=
"int" overloaded=
"no">
10100 <autodoc>GetWeight(self) -
> int
</autodoc>
10102 <method name=
"GetUnderlined" type=
"bool" overloaded=
"no">
10103 <autodoc>GetUnderlined(self) -
> bool
</autodoc>
10105 <method name=
"GetFaceName" type=
"String" overloaded=
"no">
10106 <autodoc>GetFaceName(self) -
> String
</autodoc>
10108 <method name=
"GetEncoding" type=
"wxFontEncoding" overloaded=
"no">
10109 <autodoc>GetEncoding(self) -
> int
</autodoc>
10111 <method name=
"GetNativeFontInfo" type=
"NativeFontInfo" overloaded=
"no">
10112 <autodoc>GetNativeFontInfo(self) -
> NativeFontInfo
</autodoc>
10114 <method name=
"IsFixedWidth" type=
"bool" overloaded=
"no">
10115 <autodoc>IsFixedWidth(self) -
> bool
</autodoc>
10117 <method name=
"GetNativeFontInfoDesc" type=
"String" overloaded=
"no">
10118 <autodoc>GetNativeFontInfoDesc(self) -
> String
</autodoc>
10120 <method name=
"GetNativeFontInfoUserDesc" type=
"String" overloaded=
"no">
10121 <autodoc>GetNativeFontInfoUserDesc(self) -
> String
</autodoc>
10123 <method name=
"SetPointSize" type=
"" overloaded=
"no">
10124 <autodoc>SetPointSize(self, int pointSize)
</autodoc>
10126 <param name=
"pointSize" type=
"int" default=
""/>
10129 <method name=
"SetFamily" type=
"" overloaded=
"no">
10130 <autodoc>SetFamily(self, int family)
</autodoc>
10132 <param name=
"family" type=
"int" default=
""/>
10135 <method name=
"SetStyle" type=
"" overloaded=
"no">
10136 <autodoc>SetStyle(self, int style)
</autodoc>
10138 <param name=
"style" type=
"int" default=
""/>
10141 <method name=
"SetWeight" type=
"" overloaded=
"no">
10142 <autodoc>SetWeight(self, int weight)
</autodoc>
10144 <param name=
"weight" type=
"int" default=
""/>
10147 <method name=
"SetFaceName" type=
"" overloaded=
"no">
10148 <autodoc>SetFaceName(self, String faceName)
</autodoc>
10150 <param name=
"faceName" type=
"String" default=
""/>
10153 <method name=
"SetUnderlined" type=
"" overloaded=
"no">
10154 <autodoc>SetUnderlined(self, bool underlined)
</autodoc>
10156 <param name=
"underlined" type=
"bool" default=
""/>
10159 <method name=
"SetEncoding" type=
"" overloaded=
"no">
10160 <autodoc>SetEncoding(self, int encoding)
</autodoc>
10162 <param name=
"encoding" type=
"wxFontEncoding" default=
""/>
10165 <method name=
"SetNativeFontInfo" type=
"" overloaded=
"no">
10166 <autodoc>SetNativeFontInfo(self, NativeFontInfo info)
</autodoc>
10168 <param name=
"info" type=
"NativeFontInfo" default=
""/>
10171 <method name=
"SetNativeFontInfoFromString" type=
"" overloaded=
"no">
10172 <autodoc>SetNativeFontInfoFromString(self, String info)
</autodoc>
10174 <param name=
"info" type=
"String" default=
""/>
10177 <method name=
"SetNativeFontInfoUserDesc" type=
"" overloaded=
"no">
10178 <autodoc>SetNativeFontInfoUserDesc(self, String info)
</autodoc>
10180 <param name=
"info" type=
"String" default=
""/>
10183 <method name=
"GetFamilyString" type=
"String" overloaded=
"no">
10184 <autodoc>GetFamilyString(self) -
> String
</autodoc>
10186 <method name=
"GetStyleString" type=
"String" overloaded=
"no">
10187 <autodoc>GetStyleString(self) -
> String
</autodoc>
10189 <method name=
"GetWeightString" type=
"String" overloaded=
"no">
10190 <autodoc>GetWeightString(self) -
> String
</autodoc>
10192 <method name=
"SetNoAntiAliasing" type=
"" overloaded=
"no">
10193 <autodoc>SetNoAntiAliasing(self, bool no=True)
</autodoc>
10195 <param name=
"no" type=
"bool" default=
"True"/>
10198 <method name=
"GetNoAntiAliasing" type=
"bool" overloaded=
"no">
10199 <autodoc>GetNoAntiAliasing(self) -
> bool
</autodoc>
10201 <staticmethod name=
"GetDefaultEncoding" type=
"wxFontEncoding" overloaded=
"no">
10202 <autodoc>GetDefaultEncoding() -
> int
</autodoc>
10204 <staticmethod name=
"SetDefaultEncoding" type=
"" overloaded=
"no">
10205 <autodoc>SetDefaultEncoding(int encoding)
</autodoc>
10207 <param name=
"encoding" type=
"wxFontEncoding" default=
""/>
10212 #---------------------------------------------------------------------------
10214 <class name=
"FontEnumerator" oldname=
"wxPyFontEnumerator" module=
"_gdi">
10215 <constructor name=
"wxPyFontEnumerator" overloaded=
"no">
10216 <autodoc>__init__(self) -
> FontEnumerator
</autodoc>
10218 <destructor name=
"~wxPyFontEnumerator" overloaded=
"no">
10219 <autodoc>__del__(self)
</autodoc>
10221 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
10222 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)
</autodoc>
10224 <param name=
"self" type=
"PyObject" default=
""/>
10225 <param name=
"_class" type=
"PyObject" default=
""/>
10226 <param name=
"incref" type=
"bool" default=
""/>
10229 <method name=
"EnumerateFacenames" type=
"bool" overloaded=
"no">
10230 <autodoc>EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -
> bool
</autodoc>
10232 <param name=
"encoding" type=
"wxFontEncoding" default=
"wxFONTENCODING_SYSTEM"/>
10233 <param name=
"fixedWidthOnly" type=
"bool" default=
"False"/>
10236 <method name=
"EnumerateEncodings" type=
"bool" overloaded=
"no">
10237 <autodoc>EnumerateEncodings(self, String facename=EmptyString) -
> bool
</autodoc>
10239 <param name=
"facename" type=
"String" default=
"wxPyEmptyString"/>
10242 <method name=
"GetEncodings" type=
"PyObject" overloaded=
"no">
10243 <autodoc>GetEncodings(self) -
> PyObject
</autodoc>
10245 <method name=
"GetFacenames" type=
"PyObject" overloaded=
"no">
10246 <autodoc>GetFacenames(self) -
> PyObject
</autodoc>
10250 #---------------------------------------------------------------------------
10252 <class name=
"LanguageInfo" oldname=
"wxLanguageInfo" module=
"_gdi">
10253 <property name=
"Language" type=
"int" readonly=
"no"/>
10254 <property name=
"CanonicalName" type=
"String" readonly=
"no"/>
10255 <property name=
"Description" type=
"String" readonly=
"no"/>
10257 <class name=
"Locale" oldname=
"wxLocale" module=
"_gdi">
10258 <constructor name=
"Locale" overloaded=
"no">
10259 <autodoc>__init__(self, int language=-
1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -
> Locale
</autodoc>
10261 <param name=
"language" type=
"int" default=
"-1"/>
10262 <param name=
"flags" type=
"int" default=
"wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING"/>
10265 <destructor name=
"~wxLocale" overloaded=
"no">
10266 <autodoc>__del__(self)
</autodoc>
10268 <method name=
"Init1" type=
"bool" overloaded=
"no">
10269 <autodoc>Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString,
10270 bool bLoadDefault=True,
10271 bool bConvertEncoding=False) -
> bool
</autodoc>
10273 <param name=
"szName" type=
"String" default=
""/>
10274 <param name=
"szShort" type=
"String" default=
"wxPyEmptyString"/>
10275 <param name=
"szLocale" type=
"String" default=
"wxPyEmptyString"/>
10276 <param name=
"bLoadDefault" type=
"bool" default=
"True"/>
10277 <param name=
"bConvertEncoding" type=
"bool" default=
"False"/>
10280 <method name=
"Init2" type=
"bool" overloaded=
"no">
10281 <autodoc>Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -
> bool
</autodoc>
10283 <param name=
"language" type=
"int" default=
"wxLANGUAGE_DEFAULT"/>
10284 <param name=
"flags" type=
"int" default=
"wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING"/>
10287 <staticmethod name=
"GetSystemLanguage" type=
"int" overloaded=
"no">
10288 <autodoc>GetSystemLanguage() -
> int
</autodoc>
10290 <staticmethod name=
"GetSystemEncoding" type=
"wxFontEncoding" overloaded=
"no">
10291 <autodoc>GetSystemEncoding() -
> int
</autodoc>
10293 <staticmethod name=
"GetSystemEncodingName" type=
"String" overloaded=
"no">
10294 <autodoc>GetSystemEncodingName() -
> String
</autodoc>
10296 <method name=
"IsOk" type=
"bool" overloaded=
"no">
10297 <autodoc>IsOk(self) -
> bool
</autodoc>
10299 <method name=
"GetLocale" type=
"String" overloaded=
"no">
10300 <autodoc>GetLocale(self) -
> String
</autodoc>
10302 <method name=
"GetLanguage" type=
"int" overloaded=
"no">
10303 <autodoc>GetLanguage(self) -
> int
</autodoc>
10305 <method name=
"GetSysName" type=
"String" overloaded=
"no">
10306 <autodoc>GetSysName(self) -
> String
</autodoc>
10308 <method name=
"GetCanonicalName" type=
"String" overloaded=
"no">
10309 <autodoc>GetCanonicalName(self) -
> String
</autodoc>
10311 <staticmethod name=
"AddCatalogLookupPathPrefix" type=
"" overloaded=
"no">
10312 <autodoc>AddCatalogLookupPathPrefix(String prefix)
</autodoc>
10314 <param name=
"prefix" type=
"String" default=
""/>
10317 <method name=
"AddCatalog" type=
"bool" overloaded=
"no">
10318 <autodoc>AddCatalog(self, String szDomain) -
> bool
</autodoc>
10320 <param name=
"szDomain" type=
"String" default=
""/>
10323 <method name=
"IsLoaded" type=
"bool" overloaded=
"no">
10324 <autodoc>IsLoaded(self, String szDomain) -
> bool
</autodoc>
10326 <param name=
"szDomain" type=
"String" default=
""/>
10329 <staticmethod name=
"GetLanguageInfo" type=
"LanguageInfo" overloaded=
"no">
10330 <autodoc>GetLanguageInfo(int lang) -
> LanguageInfo
</autodoc>
10332 <param name=
"lang" type=
"int" default=
""/>
10335 <staticmethod name=
"GetLanguageName" type=
"String" overloaded=
"no">
10336 <autodoc>GetLanguageName(int lang) -
> String
</autodoc>
10338 <param name=
"lang" type=
"int" default=
""/>
10341 <staticmethod name=
"FindLanguageInfo" type=
"LanguageInfo" overloaded=
"no">
10342 <autodoc>FindLanguageInfo(String locale) -
> LanguageInfo
</autodoc>
10344 <param name=
"locale" type=
"String" default=
""/>
10347 <staticmethod name=
"AddLanguage" type=
"" overloaded=
"no">
10348 <autodoc>AddLanguage(LanguageInfo info)
</autodoc>
10350 <param name=
"info" type=
"LanguageInfo" default=
""/>
10353 <method name=
"GetString" type=
"String" overloaded=
"no">
10354 <autodoc>GetString(self, String szOrigString, String szDomain=EmptyString) -
> String
</autodoc>
10356 <param name=
"szOrigString" type=
"String" default=
""/>
10357 <param name=
"szDomain" type=
"String" default=
"wxPyEmptyString"/>
10360 <method name=
"GetName" type=
"String" overloaded=
"no">
10361 <autodoc>GetName(self) -
> String
</autodoc>
10364 <method name=
"GetLocale" oldname=
"wxGetLocale" type=
"Locale" overloaded=
"no">
10365 <autodoc>GetLocale() -
> Locale
</autodoc>
10367 <method name=
"GetTranslation" oldname=
"wxGetTranslation" type=
"String" overloaded=
"yes">
10369 <param name=
"str" type=
"String" default=
""/>
10372 <method name=
"GetTranslation" oldname=
"wxGetTranslation" type=
"String" overloaded=
"yes">
10373 <autodoc>GetTranslation(String str) -
> String
10374 GetTranslation(String str, String strPlural, size_t n) -
> String
</autodoc>
10376 <param name=
"str" type=
"String" default=
""/>
10377 <param name=
"strPlural" type=
"String" default=
""/>
10378 <param name=
"n" type=
"size_t" default=
""/>
10382 #---------------------------------------------------------------------------
10384 <class name=
"EncodingConverter" oldname=
"wxEncodingConverter" module=
"_gdi">
10385 <baseclass name=
"Object"/>
10386 <constructor name=
"EncodingConverter" overloaded=
"no">
10387 <autodoc>__init__(self) -
> EncodingConverter
</autodoc>
10389 <destructor name=
"~wxEncodingConverter" overloaded=
"no">
10390 <autodoc>__del__(self)
</autodoc>
10392 <method name=
"Init" type=
"bool" overloaded=
"no">
10393 <autodoc>Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -
> bool
</autodoc>
10395 <param name=
"input_enc" type=
"wxFontEncoding" default=
""/>
10396 <param name=
"output_enc" type=
"wxFontEncoding" default=
""/>
10397 <param name=
"method" type=
"int" default=
"wxCONVERT_STRICT"/>
10400 <method name=
"Convert" type=
"String" overloaded=
"no">
10401 <autodoc>Convert(self, String input) -
> String
</autodoc>
10403 <param name=
"input" type=
"String" default=
""/>
10406 <staticmethod name=
"GetPlatformEquivalents" type=
"wxFontEncodingArray" overloaded=
"no">
10407 <autodoc>GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -
> wxFontEncodingArray
</autodoc>
10409 <param name=
"enc" type=
"wxFontEncoding" default=
""/>
10410 <param name=
"platform" type=
"int" default=
"wxPLATFORM_CURRENT"/>
10413 <staticmethod name=
"GetAllEquivalents" type=
"wxFontEncodingArray" overloaded=
"no">
10414 <autodoc>GetAllEquivalents(int enc) -
> wxFontEncodingArray
</autodoc>
10416 <param name=
"enc" type=
"wxFontEncoding" default=
""/>
10419 <staticmethod name=
"CanConvert" type=
"bool" overloaded=
"no">
10420 <autodoc>CanConvert(int encIn, int encOut) -
> bool
</autodoc>
10422 <param name=
"encIn" type=
"wxFontEncoding" default=
""/>
10423 <param name=
"encOut" type=
"wxFontEncoding" default=
""/>
10427 <pythoncode>#----------------------------------------------------------------------------
10428 # On MSW add the directory where the wxWidgets catalogs were installed
10429 # to the default catalog path.
10430 if wx.Platform == "__WXMSW__":
10432 localedir = os.path.join(os.path.split(__file__)[
0], "locale")
10433 Locale_AddCatalogLookupPathPrefix(localedir)
10436 #----------------------------------------------------------------------------
10439 #---------------------------------------------------------------------------
10441 <class name=
"DC" oldname=
"wxDC" module=
"_gdi">
10442 <docstring>A wx.DC is a device context onto which graphics and text can be
10443 drawn. It is intended to represent a number of output devices in a
10444 generic way, so a window can have a device context associated with it,
10445 and a printer also has a device context. In this way, the same piece
10446 of code may write to a number of different devices, if the device
10447 context is used as a parameter.
10449 Derived types of wxDC have documentation for specific features only,
10450 so refer to this section for most device context information.
10452 The wx.DC class is abstract and can not be instantiated, you must use
10453 one of the derived classes instead. Which one will depend on the
10454 situation in which it is used.
</docstring>
10455 <baseclass name=
"Object"/>
10456 <destructor name=
"~wxDC" overloaded=
"no">
10457 <autodoc>__del__(self)
</autodoc>
10459 <method name=
"BeginDrawing" type=
"" overloaded=
"no">
10460 <autodoc>BeginDrawing(self)
</autodoc>
10461 <docstring>Allows for optimization of drawing code on platforms that need it. On
10462 other platforms this is just an empty function and is harmless. To
10463 take advantage of this postential optimization simply enclose each
10464 group of calls to the drawing primitives within calls to
10465 `BeginDrawing` and `EndDrawing`.
</docstring>
10467 <method name=
"EndDrawing" type=
"" overloaded=
"no">
10468 <autodoc>EndDrawing(self)
</autodoc>
10469 <docstring>Ends the group of drawing primitives started with `BeginDrawing`, and
10470 invokes whatever optimization is available for this DC type on the
10471 current platform.
</docstring>
10473 <method name=
"FloodFill" type=
"bool" overloaded=
"no">
10474 <autodoc>FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -
> bool
</autodoc>
10475 <docstring>Flood fills the device context starting from the given point, using
10476 the current brush colour, and using a style:
10478 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
10479 the given colour is encountered.
10481 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
10484 Returns False if the operation failed.
10486 Note: The present implementation for non-Windows platforms may fail to
10487 find colour borders if the pixels do not match the colour
10488 exactly. However the function will still return true.
</docstring>
10490 <param name=
"x" type=
"int" default=
""/>
10491 <param name=
"y" type=
"int" default=
""/>
10492 <param name=
"col" type=
"Colour" default=
""/>
10493 <param name=
"style" type=
"int" default=
"wxFLOOD_SURFACE"/>
10496 <method name=
"FloodFillPoint" type=
"bool" overloaded=
"no">
10497 <autodoc>FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -
> bool
</autodoc>
10498 <docstring>Flood fills the device context starting from the given point, using
10499 the current brush colour, and using a style:
10501 - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than
10502 the given colour is encountered.
10504 - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given
10507 Returns False if the operation failed.
10509 Note: The present implementation for non-Windows platforms may fail to
10510 find colour borders if the pixels do not match the colour
10511 exactly. However the function will still return true.
</docstring>
10513 <param name=
"pt" type=
"Point" default=
""/>
10514 <param name=
"col" type=
"Colour" default=
""/>
10515 <param name=
"style" type=
"int" default=
"wxFLOOD_SURFACE"/>
10518 <method name=
"GetPixel" type=
"Colour" overloaded=
"no">
10519 <autodoc>GetPixel(self, int x, int y) -
> Colour
</autodoc>
10520 <docstring>Gets the colour at the specified location on the DC.
</docstring>
10522 <param name=
"x" type=
"int" default=
""/>
10523 <param name=
"y" type=
"int" default=
""/>
10526 <method name=
"GetPixelPoint" type=
"Colour" overloaded=
"no">
10527 <autodoc>GetPixelPoint(self, Point pt) -
> Colour
</autodoc>
10529 <param name=
"pt" type=
"Point" default=
""/>
10532 <method name=
"DrawLine" type=
"" overloaded=
"no">
10533 <autodoc>DrawLine(self, int x1, int y1, int x2, int y2)
</autodoc>
10534 <docstring>Draws a line from the first point to the second. The current pen is
10535 used for drawing the line. Note that the second point is *not* part of
10536 the line and is not drawn by this function (this is consistent with
10537 the behaviour of many other toolkits).
</docstring>
10539 <param name=
"x1" type=
"int" default=
""/>
10540 <param name=
"y1" type=
"int" default=
""/>
10541 <param name=
"x2" type=
"int" default=
""/>
10542 <param name=
"y2" type=
"int" default=
""/>
10545 <method name=
"DrawLinePoint" type=
"" overloaded=
"no">
10546 <autodoc>DrawLinePoint(self, Point pt1, Point pt2)
</autodoc>
10547 <docstring>Draws a line from the first point to the second. The current pen is
10548 used for drawing the line. Note that the second point is *not* part of
10549 the line and is not drawn by this function (this is consistent with
10550 the behaviour of many other toolkits).
</docstring>
10552 <param name=
"pt1" type=
"Point" default=
""/>
10553 <param name=
"pt2" type=
"Point" default=
""/>
10556 <method name=
"CrossHair" type=
"" overloaded=
"no">
10557 <autodoc>CrossHair(self, int x, int y)
</autodoc>
10558 <docstring>Displays a cross hair using the current pen. This is a vertical and
10559 horizontal line the height and width of the window, centred on the
10560 given point.
</docstring>
10562 <param name=
"x" type=
"int" default=
""/>
10563 <param name=
"y" type=
"int" default=
""/>
10566 <method name=
"CrossHairPoint" type=
"" overloaded=
"no">
10567 <autodoc>CrossHairPoint(self, Point pt)
</autodoc>
10568 <docstring>Displays a cross hair using the current pen. This is a vertical and
10569 horizontal line the height and width of the window, centred on the
10570 given point.
</docstring>
10572 <param name=
"pt" type=
"Point" default=
""/>
10575 <method name=
"DrawArc" type=
"" overloaded=
"no">
10576 <autodoc>DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)
</autodoc>
10577 <docstring>Draws an arc of a circle, centred on the *center* point (xc, yc), from
10578 the first point to the second. The current pen is used for the outline
10579 and the current brush for filling the shape.
10581 The arc is drawn in an anticlockwise direction from the start point to
10582 the end point.
</docstring>
10584 <param name=
"x1" type=
"int" default=
""/>
10585 <param name=
"y1" type=
"int" default=
""/>
10586 <param name=
"x2" type=
"int" default=
""/>
10587 <param name=
"y2" type=
"int" default=
""/>
10588 <param name=
"xc" type=
"int" default=
""/>
10589 <param name=
"yc" type=
"int" default=
""/>
10592 <method name=
"DrawArcPoint" type=
"" overloaded=
"no">
10593 <autodoc>DrawArcPoint(self, Point pt1, Point pt2, Point center)
</autodoc>
10594 <docstring>Draws an arc of a circle, centred on the *center* point (xc, yc), from
10595 the first point to the second. The current pen is used for the outline
10596 and the current brush for filling the shape.
10598 The arc is drawn in an anticlockwise direction from the start point to
10599 the end point.
</docstring>
10601 <param name=
"pt1" type=
"Point" default=
""/>
10602 <param name=
"pt2" type=
"Point" default=
""/>
10603 <param name=
"center" type=
"Point" default=
""/>
10606 <method name=
"DrawCheckMark" type=
"" overloaded=
"no">
10607 <autodoc>DrawCheckMark(self, int x, int y, int width, int height)
</autodoc>
10608 <docstring>Draws a check mark inside the given rectangle.
</docstring>
10610 <param name=
"x" type=
"int" default=
""/>
10611 <param name=
"y" type=
"int" default=
""/>
10612 <param name=
"width" type=
"int" default=
""/>
10613 <param name=
"height" type=
"int" default=
""/>
10616 <method name=
"DrawCheckMarkRect" type=
"" overloaded=
"no">
10617 <autodoc>DrawCheckMarkRect(self, Rect rect)
</autodoc>
10618 <docstring>Draws a check mark inside the given rectangle.
</docstring>
10620 <param name=
"rect" type=
"Rect" default=
""/>
10623 <method name=
"DrawEllipticArc" type=
"" overloaded=
"no">
10624 <autodoc>DrawEllipticArc(self, int x, int y, int w, int h, double start, double end)
</autodoc>
10625 <docstring>Draws an arc of an ellipse, with the given rectangle defining the
10626 bounds of the ellipse. The current pen is used for drawing the arc and
10627 the current brush is used for drawing the pie.
10629 The *start* and *end* parameters specify the start and end of the arc
10630 relative to the three-o'clock position from the center of the
10631 rectangle. Angles are specified in degrees (
360 is a complete
10632 circle). Positive values mean counter-clockwise motion. If start is
10633 equal to end, a complete ellipse will be drawn.
</docstring>
10635 <param name=
"x" type=
"int" default=
""/>
10636 <param name=
"y" type=
"int" default=
""/>
10637 <param name=
"w" type=
"int" default=
""/>
10638 <param name=
"h" type=
"int" default=
""/>
10639 <param name=
"start" type=
"double" default=
""/>
10640 <param name=
"end" type=
"double" default=
""/>
10643 <method name=
"DrawEllipticArcPointSize" type=
"" overloaded=
"no">
10644 <autodoc>DrawEllipticArcPointSize(self, Point pt, Size sz, double start, double end)
</autodoc>
10645 <docstring>Draws an arc of an ellipse, with the given rectangle defining the
10646 bounds of the ellipse. The current pen is used for drawing the arc and
10647 the current brush is used for drawing the pie.
10649 The *start* and *end* parameters specify the start and end of the arc
10650 relative to the three-o'clock position from the center of the
10651 rectangle. Angles are specified in degrees (
360 is a complete
10652 circle). Positive values mean counter-clockwise motion. If start is
10653 equal to end, a complete ellipse will be drawn.
</docstring>
10655 <param name=
"pt" type=
"Point" default=
""/>
10656 <param name=
"sz" type=
"Size" default=
""/>
10657 <param name=
"start" type=
"double" default=
""/>
10658 <param name=
"end" type=
"double" default=
""/>
10661 <method name=
"DrawPoint" type=
"" overloaded=
"no">
10662 <autodoc>DrawPoint(self, int x, int y)
</autodoc>
10663 <docstring>Draws a point using the current pen.
</docstring>
10665 <param name=
"x" type=
"int" default=
""/>
10666 <param name=
"y" type=
"int" default=
""/>
10669 <method name=
"DrawPointPoint" type=
"" overloaded=
"no">
10670 <autodoc>DrawPointPoint(self, Point pt)
</autodoc>
10671 <docstring>Draws a point using the current pen.
</docstring>
10673 <param name=
"pt" type=
"Point" default=
""/>
10676 <method name=
"DrawRectangle" type=
"" overloaded=
"no">
10677 <autodoc>DrawRectangle(self, int x, int y, int width, int height)
</autodoc>
10678 <docstring>Draws a rectangle with the given top left corner, and with the given
10679 size. The current pen is used for the outline and the current brush
10680 for filling the shape.
</docstring>
10682 <param name=
"x" type=
"int" default=
""/>
10683 <param name=
"y" type=
"int" default=
""/>
10684 <param name=
"width" type=
"int" default=
""/>
10685 <param name=
"height" type=
"int" default=
""/>
10688 <method name=
"DrawRectangleRect" type=
"" overloaded=
"no">
10689 <autodoc>DrawRectangleRect(self, Rect rect)
</autodoc>
10690 <docstring>Draws a rectangle with the given top left corner, and with the given
10691 size. The current pen is used for the outline and the current brush
10692 for filling the shape.
</docstring>
10694 <param name=
"rect" type=
"Rect" default=
""/>
10697 <method name=
"DrawRectanglePointSize" type=
"" overloaded=
"no">
10698 <autodoc>DrawRectanglePointSize(self, Point pt, Size sz)
</autodoc>
10699 <docstring>Draws a rectangle with the given top left corner, and with the given
10700 size. The current pen is used for the outline and the current brush
10701 for filling the shape.
</docstring>
10703 <param name=
"pt" type=
"Point" default=
""/>
10704 <param name=
"sz" type=
"Size" default=
""/>
10707 <method name=
"DrawRoundedRectangle" type=
"" overloaded=
"no">
10708 <autodoc>DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)
</autodoc>
10709 <docstring>Draws a rectangle with the given top left corner, and with the given
10710 size. The corners are quarter-circles using the given radius. The
10711 current pen is used for the outline and the current brush for filling
10714 If radius is positive, the value is assumed to be the radius of the
10715 rounded corner. If radius is negative, the absolute value is assumed
10716 to be the proportion of the smallest dimension of the rectangle. This
10717 means that the corner can be a sensible size relative to the size of
10718 the rectangle, and also avoids the strange effects X produces when the
10719 corners are too big for the rectangle.
</docstring>
10721 <param name=
"x" type=
"int" default=
""/>
10722 <param name=
"y" type=
"int" default=
""/>
10723 <param name=
"width" type=
"int" default=
""/>
10724 <param name=
"height" type=
"int" default=
""/>
10725 <param name=
"radius" type=
"double" default=
""/>
10728 <method name=
"DrawRoundedRectangleRect" type=
"" overloaded=
"no">
10729 <autodoc>DrawRoundedRectangleRect(self, Rect r, double radius)
</autodoc>
10730 <docstring>Draws a rectangle with the given top left corner, and with the given
10731 size. The corners are quarter-circles using the given radius. The
10732 current pen is used for the outline and the current brush for filling
10735 If radius is positive, the value is assumed to be the radius of the
10736 rounded corner. If radius is negative, the absolute value is assumed
10737 to be the proportion of the smallest dimension of the rectangle. This
10738 means that the corner can be a sensible size relative to the size of
10739 the rectangle, and also avoids the strange effects X produces when the
10740 corners are too big for the rectangle.
</docstring>
10742 <param name=
"r" type=
"Rect" default=
""/>
10743 <param name=
"radius" type=
"double" default=
""/>
10746 <method name=
"DrawRoundedRectanglePointSize" type=
"" overloaded=
"no">
10747 <autodoc>DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)
</autodoc>
10748 <docstring>Draws a rectangle with the given top left corner, and with the given
10749 size. The corners are quarter-circles using the given radius. The
10750 current pen is used for the outline and the current brush for filling
10753 If radius is positive, the value is assumed to be the radius of the
10754 rounded corner. If radius is negative, the absolute value is assumed
10755 to be the proportion of the smallest dimension of the rectangle. This
10756 means that the corner can be a sensible size relative to the size of
10757 the rectangle, and also avoids the strange effects X produces when the
10758 corners are too big for the rectangle.
</docstring>
10760 <param name=
"pt" type=
"Point" default=
""/>
10761 <param name=
"sz" type=
"Size" default=
""/>
10762 <param name=
"radius" type=
"double" default=
""/>
10765 <method name=
"DrawCircle" type=
"" overloaded=
"no">
10766 <autodoc>DrawCircle(self, int x, int y, int radius)
</autodoc>
10767 <docstring>Draws a circle with the given center point and radius. The current
10768 pen is used for the outline and the current brush for filling the
10771 :see: `DrawEllipse`
</docstring>
10773 <param name=
"x" type=
"int" default=
""/>
10774 <param name=
"y" type=
"int" default=
""/>
10775 <param name=
"radius" type=
"int" default=
""/>
10778 <method name=
"DrawCirclePoint" type=
"" overloaded=
"no">
10779 <autodoc>DrawCirclePoint(self, Point pt, int radius)
</autodoc>
10780 <docstring>Draws a circle with the given center point and radius. The current
10781 pen is used for the outline and the current brush for filling the
10784 :see: `DrawEllipse`
</docstring>
10786 <param name=
"pt" type=
"Point" default=
""/>
10787 <param name=
"radius" type=
"int" default=
""/>
10790 <method name=
"DrawEllipse" type=
"" overloaded=
"no">
10791 <autodoc>DrawEllipse(self, int x, int y, int width, int height)
</autodoc>
10792 <docstring>Draws an ellipse contained in the specified rectangle. The current pen
10793 is used for the outline and the current brush for filling the shape.
10795 :see: `DrawCircle`
</docstring>
10797 <param name=
"x" type=
"int" default=
""/>
10798 <param name=
"y" type=
"int" default=
""/>
10799 <param name=
"width" type=
"int" default=
""/>
10800 <param name=
"height" type=
"int" default=
""/>
10803 <method name=
"DrawEllipseRect" type=
"" overloaded=
"no">
10804 <autodoc>DrawEllipseRect(self, Rect rect)
</autodoc>
10805 <docstring>Draws an ellipse contained in the specified rectangle. The current pen
10806 is used for the outline and the current brush for filling the shape.
10808 :see: `DrawCircle`
</docstring>
10810 <param name=
"rect" type=
"Rect" default=
""/>
10813 <method name=
"DrawEllipsePointSize" type=
"" overloaded=
"no">
10814 <autodoc>DrawEllipsePointSize(self, Point pt, Size sz)
</autodoc>
10815 <docstring>Draws an ellipse contained in the specified rectangle. The current pen
10816 is used for the outline and the current brush for filling the shape.
10818 :see: `DrawCircle`
</docstring>
10820 <param name=
"pt" type=
"Point" default=
""/>
10821 <param name=
"sz" type=
"Size" default=
""/>
10824 <method name=
"DrawIcon" type=
"" overloaded=
"no">
10825 <autodoc>DrawIcon(self, Icon icon, int x, int y)
</autodoc>
10826 <docstring>Draw an icon on the display (does nothing if the device context is
10827 PostScript). This can be the simplest way of drawing bitmaps on a
10828 window.
</docstring>
10830 <param name=
"icon" type=
"Icon" default=
""/>
10831 <param name=
"x" type=
"int" default=
""/>
10832 <param name=
"y" type=
"int" default=
""/>
10835 <method name=
"DrawIconPoint" type=
"" overloaded=
"no">
10836 <autodoc>DrawIconPoint(self, Icon icon, Point pt)
</autodoc>
10837 <docstring>Draw an icon on the display (does nothing if the device context is
10838 PostScript). This can be the simplest way of drawing bitmaps on a
10839 window.
</docstring>
10841 <param name=
"icon" type=
"Icon" default=
""/>
10842 <param name=
"pt" type=
"Point" default=
""/>
10845 <method name=
"DrawBitmap" type=
"" overloaded=
"no">
10846 <autodoc>DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)
</autodoc>
10847 <docstring>Draw a bitmap on the device context at the specified point. If
10848 *transparent* is true and the bitmap has a transparency mask, (or
10849 alpha channel on the platforms that support it) then the bitmap will
10850 be drawn transparently.
10852 When drawing a mono-bitmap, the current text foreground colour will be
10853 used to draw the foreground of the bitmap (all bits set to
1), and the
10854 current text background colour to draw the background (all bits set to
10857 :see: `SetTextForeground`, `SetTextBackground` and `wx.MemoryDC`
</docstring>
10859 <param name=
"bmp" type=
"Bitmap" default=
""/>
10860 <param name=
"x" type=
"int" default=
""/>
10861 <param name=
"y" type=
"int" default=
""/>
10862 <param name=
"useMask" type=
"bool" default=
"False"/>
10865 <method name=
"DrawBitmapPoint" type=
"" overloaded=
"no">
10866 <autodoc>DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)
</autodoc>
10867 <docstring>Draw a bitmap on the device context at the specified point. If
10868 *transparent* is true and the bitmap has a transparency mask, (or
10869 alpha channel on the platforms that support it) then the bitmap will
10870 be drawn transparently.
10872 When drawing a mono-bitmap, the current text foreground colour will be
10873 used to draw the foreground of the bitmap (all bits set to
1), and the
10874 current text background colour to draw the background (all bits set to
10877 :see: `SetTextForeground`, `SetTextBackground` and `wx.MemoryDC`
</docstring>
10879 <param name=
"bmp" type=
"Bitmap" default=
""/>
10880 <param name=
"pt" type=
"Point" default=
""/>
10881 <param name=
"useMask" type=
"bool" default=
"False"/>
10884 <method name=
"DrawText" type=
"" overloaded=
"no">
10885 <autodoc>DrawText(self, String text, int x, int y)
</autodoc>
10886 <docstring>Draws a text string at the specified point, using the current text
10887 font, and the current text foreground and background colours.
10889 The coordinates refer to the top-left corner of the rectangle bounding
10890 the string. See `GetTextExtent` for how to get the dimensions of a
10891 text string, which can be used to position the text more precisely.
10893 **NOTE**: under wxGTK the current logical function is used by this
10894 function but it is ignored by wxMSW. Thus, you should avoid using
10895 logical functions with this function in portable programs.
10897 :see: `DrawRotatedText`
</docstring>
10899 <param name=
"text" type=
"String" default=
""/>
10900 <param name=
"x" type=
"int" default=
""/>
10901 <param name=
"y" type=
"int" default=
""/>
10904 <method name=
"DrawTextPoint" type=
"" overloaded=
"no">
10905 <autodoc>DrawTextPoint(self, String text, Point pt)
</autodoc>
10906 <docstring>Draws a text string at the specified point, using the current text
10907 font, and the current text foreground and background colours.
10909 The coordinates refer to the top-left corner of the rectangle bounding
10910 the string. See `GetTextExtent` for how to get the dimensions of a
10911 text string, which can be used to position the text more precisely.
10913 **NOTE**: under wxGTK the current logical function is used by this
10914 function but it is ignored by wxMSW. Thus, you should avoid using
10915 logical functions with this function in portable programs.
10917 :see: `DrawRotatedText`
</docstring>
10919 <param name=
"text" type=
"String" default=
""/>
10920 <param name=
"pt" type=
"Point" default=
""/>
10923 <method name=
"DrawRotatedText" type=
"" overloaded=
"no">
10924 <autodoc>DrawRotatedText(self, String text, int x, int y, double angle)
</autodoc>
10925 <docstring>Draws the text rotated by *angle* degrees, if supported by the platform.
10927 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
10928 function. In particular, a font different from ``wx.NORMAL_FONT``
10929 should be used as the it is not normally a TrueType
10930 font. ``wx.SWISS_FONT`` is an example of a font which is.
10932 :see: `DrawText`
</docstring>
10934 <param name=
"text" type=
"String" default=
""/>
10935 <param name=
"x" type=
"int" default=
""/>
10936 <param name=
"y" type=
"int" default=
""/>
10937 <param name=
"angle" type=
"double" default=
""/>
10940 <method name=
"DrawRotatedTextPoint" type=
"" overloaded=
"no">
10941 <autodoc>DrawRotatedTextPoint(self, String text, Point pt, double angle)
</autodoc>
10942 <docstring>Draws the text rotated by *angle* degrees, if supported by the platform.
10944 **NOTE**: Under Win9x only TrueType fonts can be drawn by this
10945 function. In particular, a font different from ``wx.NORMAL_FONT``
10946 should be used as the it is not normally a TrueType
10947 font. ``wx.SWISS_FONT`` is an example of a font which is.
10949 :see: `DrawText`
</docstring>
10951 <param name=
"text" type=
"String" default=
""/>
10952 <param name=
"pt" type=
"Point" default=
""/>
10953 <param name=
"angle" type=
"double" default=
""/>
10956 <method name=
"Blit" type=
"bool" overloaded=
"no">
10957 <autodoc>Blit(self, int xdest, int ydest, int width, int height, DC source,
10958 int xsrc, int ysrc, int rop=COPY, bool useMask=False,
10959 int xsrcMask=-
1, int ysrcMask=-
1) -
> bool
</autodoc>
10960 <docstring>Copy from a source DC to this DC. Parameters specify the destination
10961 coordinates, size of area to copy, source DC, source coordinates,
10962 logical function, whether to use a bitmap mask, and mask source
10965 :param xdest: Destination device context x position.
10966 :param ydest: Destination device context y position.
10967 :param width: Width of source area to be copied.
10968 :param height: Height of source area to be copied.
10969 :param source: Source device context.
10970 :param xsrc: Source device context x position.
10971 :param ysrc: Source device context y position.
10972 :param rop: Logical function to use: see `SetLogicalFunction`.
10973 :param useMask: If true, Blit does a transparent blit using the mask
10974 that is associated with the bitmap selected into the
10975 source device context.
10976 :param xsrcMask: Source x position on the mask. If both xsrcMask and
10977 ysrcMask are -
1, xsrc and ysrc will be assumed for
10978 the mask source position.
10979 :param ysrcMask: Source y position on the mask.
10982 <param name=
"xdest" type=
"int" default=
""/>
10983 <param name=
"ydest" type=
"int" default=
""/>
10984 <param name=
"width" type=
"int" default=
""/>
10985 <param name=
"height" type=
"int" default=
""/>
10986 <param name=
"source" type=
"DC" default=
""/>
10987 <param name=
"xsrc" type=
"int" default=
""/>
10988 <param name=
"ysrc" type=
"int" default=
""/>
10989 <param name=
"rop" type=
"int" default=
"wxCOPY"/>
10990 <param name=
"useMask" type=
"bool" default=
"False"/>
10991 <param name=
"xsrcMask" type=
"int" default=
"-1"/>
10992 <param name=
"ysrcMask" type=
"int" default=
"-1"/>
10995 <method name=
"BlitPointSize" type=
"bool" overloaded=
"no">
10996 <autodoc>BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY,
10997 bool useMask=False, Point srcPtMask=DefaultPosition) -
> bool
</autodoc>
10998 <docstring>Copy from a source DC to this DC. Parameters specify the destination
10999 coordinates, size of area to copy, source DC, source coordinates,
11000 logical function, whether to use a bitmap mask, and mask source
11003 :param destPt: Destination device context position.
11004 :param sz: Size of source area to be copied.
11005 :param source: Source device context.
11006 :param srcPt: Source device context position.
11007 :param rop: Logical function to use: see `SetLogicalFunction`.
11008 :param useMask: If true, Blit does a transparent blit using the mask
11009 that is associated with the bitmap selected into the
11010 source device context.
11011 :param srcPtMask: Source position on the mask.
11014 <param name=
"destPt" type=
"Point" default=
""/>
11015 <param name=
"sz" type=
"Size" default=
""/>
11016 <param name=
"source" type=
"DC" default=
""/>
11017 <param name=
"srcPt" type=
"Point" default=
""/>
11018 <param name=
"rop" type=
"int" default=
"wxCOPY"/>
11019 <param name=
"useMask" type=
"bool" default=
"False"/>
11020 <param name=
"srcPtMask" type=
"Point" default=
"wxDefaultPosition"/>
11023 <method name=
"SetClippingRegion" type=
"" overloaded=
"no">
11024 <autodoc>SetClippingRegion(self, int x, int y, int width, int height)
</autodoc>
11025 <docstring>Sets the clipping region for this device context to the intersection
11026 of the given region described by the parameters of this method and the
11027 previously set clipping region. You should call `DestroyClippingRegion`
11028 if you want to set the clipping region exactly to the region
11031 The clipping region is an area to which drawing is
11032 restricted. Possible uses for the clipping region are for clipping
11033 text or for speeding up window redraws when only a known area of the
11036 :see: `DestroyClippingRegion`, `wx.Region`
</docstring>
11038 <param name=
"x" type=
"int" default=
""/>
11039 <param name=
"y" type=
"int" default=
""/>
11040 <param name=
"width" type=
"int" default=
""/>
11041 <param name=
"height" type=
"int" default=
""/>
11044 <method name=
"SetClippingRegionPointSize" type=
"" overloaded=
"no">
11045 <autodoc>SetClippingRegionPointSize(self, Point pt, Size sz)
</autodoc>
11046 <docstring>Sets the clipping region for this device context to the intersection
11047 of the given region described by the parameters of this method and the
11048 previously set clipping region. You should call `DestroyClippingRegion`
11049 if you want to set the clipping region exactly to the region
11052 The clipping region is an area to which drawing is
11053 restricted. Possible uses for the clipping region are for clipping
11054 text or for speeding up window redraws when only a known area of the
11057 :see: `DestroyClippingRegion`, `wx.Region`
</docstring>
11059 <param name=
"pt" type=
"Point" default=
""/>
11060 <param name=
"sz" type=
"Size" default=
""/>
11063 <method name=
"SetClippingRegionAsRegion" type=
"" overloaded=
"no">
11064 <autodoc>SetClippingRegionAsRegion(self, Region region)
</autodoc>
11065 <docstring>Sets the clipping region for this device context to the intersection
11066 of the given region described by the parameters of this method and the
11067 previously set clipping region. You should call `DestroyClippingRegion`
11068 if you want to set the clipping region exactly to the region
11071 The clipping region is an area to which drawing is
11072 restricted. Possible uses for the clipping region are for clipping
11073 text or for speeding up window redraws when only a known area of the
11076 :see: `DestroyClippingRegion`, `wx.Region`
</docstring>
11078 <param name=
"region" type=
"Region" default=
""/>
11081 <method name=
"SetClippingRect" type=
"" overloaded=
"no">
11082 <autodoc>SetClippingRect(self, Rect rect)
</autodoc>
11083 <docstring>Sets the clipping region for this device context to the intersection
11084 of the given region described by the parameters of this method and the
11085 previously set clipping region. You should call `DestroyClippingRegion`
11086 if you want to set the clipping region exactly to the region
11089 The clipping region is an area to which drawing is
11090 restricted. Possible uses for the clipping region are for clipping
11091 text or for speeding up window redraws when only a known area of the
11094 :see: `DestroyClippingRegion`, `wx.Region`
</docstring>
11096 <param name=
"rect" type=
"Rect" default=
""/>
11099 <method name=
"DrawLines" type=
"" overloaded=
"no">
11100 <autodoc>DrawLines(self, List points, int xoffset=
0, int yoffset=
0)
</autodoc>
11101 <docstring>Draws lines using a sequence of `wx.Point` objects, adding the
11102 optional offset coordinate. The current pen is used for drawing the
11105 <param name=
"points" type=
"int" default=
""/>
11106 <param name=
"points_array" type=
"Point" default=
""/>
11107 <param name=
"xoffset" type=
"int" default=
"0"/>
11108 <param name=
"yoffset" type=
"int" default=
"0"/>
11111 <method name=
"DrawPolygon" type=
"" overloaded=
"no">
11112 <autodoc>DrawPolygon(self, List points, int xoffset=
0, int yoffset=
0,
11113 int fillStyle=ODDEVEN_RULE)
</autodoc>
11114 <docstring>Draws a filled polygon using a sequence of `wx.Point` objects, adding
11115 the optional offset coordinate. The last argument specifies the fill
11116 rule: ``wx.ODDEVEN_RULE`` (the default) or ``wx.WINDING_RULE``.
11118 The current pen is used for drawing the outline, and the current brush
11119 for filling the shape. Using a transparent brush suppresses
11120 filling. Note that wxWidgets automatically closes the first and last
11121 points.
</docstring>
11123 <param name=
"points" type=
"int" default=
""/>
11124 <param name=
"points_array" type=
"Point" default=
""/>
11125 <param name=
"xoffset" type=
"int" default=
"0"/>
11126 <param name=
"yoffset" type=
"int" default=
"0"/>
11127 <param name=
"fillStyle" type=
"int" default=
"wxODDEVEN_RULE"/>
11130 <method name=
"DrawLabel" type=
"" overloaded=
"no">
11131 <autodoc>DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
11132 int indexAccel=-
1)
</autodoc>
11133 <docstring>Draw *text* within the specified rectangle, abiding by the alignment
11134 flags. Will additionally emphasize the character at *indexAccel* if
11137 :see: `DrawImageLabel`
</docstring>
11139 <param name=
"text" type=
"String" default=
""/>
11140 <param name=
"rect" type=
"Rect" default=
""/>
11141 <param name=
"alignment" type=
"int" default=
"wxALIGN_LEFT|wxALIGN_TOP"/>
11142 <param name=
"indexAccel" type=
"int" default=
"-1"/>
11145 <method name=
"DrawImageLabel" type=
"Rect" overloaded=
"no">
11146 <autodoc>DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP,
11147 int indexAccel=-
1) -
> Rect
</autodoc>
11148 <docstring>Draw *text* and an image (which may be ``wx.NullBitmap`` to skip
11149 drawing it) within the specified rectangle, abiding by the alignment
11150 flags. Will additionally emphasize the character at *indexAccel* if
11151 it is not -
1. Returns the bounding rectangle.
</docstring>
11153 <param name=
"text" type=
"String" default=
""/>
11154 <param name=
"image" type=
"Bitmap" default=
""/>
11155 <param name=
"rect" type=
"Rect" default=
""/>
11156 <param name=
"alignment" type=
"int" default=
"wxALIGN_LEFT|wxALIGN_TOP"/>
11157 <param name=
"indexAccel" type=
"int" default=
"-1"/>
11160 <method name=
"DrawSpline" type=
"" overloaded=
"no">
11161 <autodoc>DrawSpline(self, List points)
</autodoc>
11162 <docstring>Draws a spline between all given control points, (a list of `wx.Point`
11163 objects) using the current pen. The spline is drawn using a series of
11164 lines, using an algorithm taken from the X drawing program 'XFIG'.
</docstring>
11166 <param name=
"points" type=
"int" default=
""/>
11167 <param name=
"points_array" type=
"Point" default=
""/>
11170 <method name=
"Clear" type=
"" overloaded=
"no">
11171 <autodoc>Clear(self)
</autodoc>
11172 <docstring>Clears the device context using the current background brush.
</docstring>
11174 <method name=
"StartDoc" type=
"bool" overloaded=
"no">
11175 <autodoc>StartDoc(self, String message) -
> bool
</autodoc>
11176 <docstring>Starts a document (only relevant when outputting to a
11177 printer). *Message* is a message to show whilst printing.
</docstring>
11179 <param name=
"message" type=
"String" default=
""/>
11182 <method name=
"EndDoc" type=
"" overloaded=
"no">
11183 <autodoc>EndDoc(self)
</autodoc>
11184 <docstring>Ends a document (only relevant when outputting to a printer).
</docstring>
11186 <method name=
"StartPage" type=
"" overloaded=
"no">
11187 <autodoc>StartPage(self)
</autodoc>
11188 <docstring>Starts a document page (only relevant when outputting to a printer).
</docstring>
11190 <method name=
"EndPage" type=
"" overloaded=
"no">
11191 <autodoc>EndPage(self)
</autodoc>
11192 <docstring>Ends a document page (only relevant when outputting to a printer).
</docstring>
11194 <method name=
"SetFont" type=
"" overloaded=
"no">
11195 <autodoc>SetFont(self, Font font)
</autodoc>
11196 <docstring>Sets the current font for the DC. It must be a valid font, in
11197 particular you should not pass ``wx.NullFont`` to this method.
11199 :see: `wx.Font`
</docstring>
11201 <param name=
"font" type=
"Font" default=
""/>
11204 <method name=
"SetPen" type=
"" overloaded=
"no">
11205 <autodoc>SetPen(self, Pen pen)
</autodoc>
11206 <docstring>Sets the current pen for the DC.
11208 If the argument is ``wx.NullPen``, the current pen is selected out of the
11209 device context, and the original pen restored.
11211 :see: `wx.Pen`
</docstring>
11213 <param name=
"pen" type=
"Pen" default=
""/>
11216 <method name=
"SetBrush" type=
"" overloaded=
"no">
11217 <autodoc>SetBrush(self, Brush brush)
</autodoc>
11218 <docstring>Sets the current brush for the DC.
11220 If the argument is ``wx.NullBrush``, the current brush is selected out
11221 of the device context, and the original brush restored, allowing the
11222 current brush to be destroyed safely.
11224 :see: `wx.Brush`
</docstring>
11226 <param name=
"brush" type=
"Brush" default=
""/>
11229 <method name=
"SetBackground" type=
"" overloaded=
"no">
11230 <autodoc>SetBackground(self, Brush brush)
</autodoc>
11231 <docstring>Sets the current background brush for the DC.
</docstring>
11233 <param name=
"brush" type=
"Brush" default=
""/>
11236 <method name=
"SetBackgroundMode" type=
"" overloaded=
"no">
11237 <autodoc>SetBackgroundMode(self, int mode)
</autodoc>
11238 <docstring>*mode* may be one of ``wx.SOLID`` and ``wx.TRANSPARENT``. This setting
11239 determines whether text will be drawn with a background colour or
11242 <param name=
"mode" type=
"int" default=
""/>
11245 <method name=
"SetPalette" type=
"" overloaded=
"no">
11246 <autodoc>SetPalette(self, Palette palette)
</autodoc>
11247 <docstring>If this is a window DC or memory DC, assigns the given palette to the
11248 window or bitmap associated with the DC. If the argument is
11249 ``wx.NullPalette``, the current palette is selected out of the device
11250 context, and the original palette restored.
11252 :see: `wx.Palette`
</docstring>
11254 <param name=
"palette" type=
"Palette" default=
""/>
11257 <method name=
"DestroyClippingRegion" type=
"" overloaded=
"no">
11258 <autodoc>DestroyClippingRegion(self)
</autodoc>
11259 <docstring>Destroys the current clipping region so that none of the DC is
11262 :see: `SetClippingRegion`
</docstring>
11264 <method name=
"GetClippingBox" type=
"" overloaded=
"no">
11265 <autodoc>GetClippingBox() -
> (x, y, width, height)
</autodoc>
11266 <docstring>Gets the rectangle surrounding the current clipping region.
</docstring>
11268 <param name=
"OUTPUT" type=
"int" default=
""/>
11269 <param name=
"OUTPUT" type=
"int" default=
""/>
11270 <param name=
"OUTPUT" type=
"int" default=
""/>
11271 <param name=
"OUTPUT" type=
"int" default=
""/>
11274 <method name=
"GetClippingRect" type=
"Rect" overloaded=
"no">
11275 <autodoc>GetClippingRect(self) -
> Rect
</autodoc>
11276 <docstring>Gets the rectangle surrounding the current clipping region.
</docstring>
11278 <method name=
"GetCharHeight" type=
"int" overloaded=
"no">
11279 <autodoc>GetCharHeight(self) -
> int
</autodoc>
11280 <docstring>Gets the character height of the currently set font.
</docstring>
11282 <method name=
"GetCharWidth" type=
"int" overloaded=
"no">
11283 <autodoc>GetCharWidth(self) -
> int
</autodoc>
11284 <docstring>Gets the average character width of the currently set font.
</docstring>
11286 <method name=
"GetTextExtent" type=
"" overloaded=
"no">
11287 <autodoc>GetTextExtent(wxString string) -
> (width, height)
</autodoc>
11288 <docstring>Get the width and height of the text using the current font. Only
11289 works for single line strings.
</docstring>
11291 <param name=
"string" type=
"String" default=
""/>
11292 <param name=
"OUTPUT" type=
"int" default=
""/>
11293 <param name=
"OUTPUT" type=
"int" default=
""/>
11296 <method name=
"GetFullTextExtent" type=
"" overloaded=
"no">
11297 <autodoc>GetFullTextExtent(wxString string, Font font=None) -
>
11298 (width, height, descent, externalLeading)
</autodoc>
11299 <docstring>Get the width, height, decent and leading of the text using the
11300 current or specified font. Only works for single line strings.
</docstring>
11302 <param name=
"string" type=
"String" default=
""/>
11303 <param name=
"OUTPUT" type=
"int" default=
""/>
11304 <param name=
"OUTPUT" type=
"int" default=
""/>
11305 <param name=
"OUTPUT" type=
"int" default=
""/>
11306 <param name=
"OUTPUT" type=
"int" default=
""/>
11307 <param name=
"font" type=
"Font" default=
"NULL"/>
11310 <method name=
"GetMultiLineTextExtent" type=
"" overloaded=
"no">
11311 <autodoc>GetMultiLineTextExtent(wxString string, Font font=None) -
>
11312 (width, height, descent, externalLeading)
</autodoc>
11313 <docstring>Get the width, height, decent and leading of the text using the
11314 current or specified font. Works for single as well as multi-line
11315 strings.
</docstring>
11317 <param name=
"text" type=
"String" default=
""/>
11318 <param name=
"OUTPUT" type=
"int" default=
""/>
11319 <param name=
"OUTPUT" type=
"int" default=
""/>
11320 <param name=
"OUTPUT" type=
"int" default=
""/>
11321 <param name=
"font" type=
"Font" default=
"NULL"/>
11324 <method name=
"GetPartialTextExtents" type=
"wxArrayInt" overloaded=
"no">
11325 <autodoc>GetPartialTextExtents(self, text) -
> [widths]
</autodoc>
11326 <docstring>Returns a list of integers such that each value is the distance in
11327 pixels from the begining of text to the coresponding character of
11328 *text*. The generic version simply builds a running total of the widths
11329 of each character using GetTextExtent, however if the various
11330 platforms have a native API function that is faster or more accurate
11331 than the generic implementaiton then it will be used instead.
</docstring>
11333 <param name=
"text" type=
"String" default=
""/>
11336 <method name=
"GetSize" type=
"Size" overloaded=
"no">
11337 <autodoc>GetSize(self) -
> Size
</autodoc>
11338 <docstring>This gets the horizontal and vertical resolution in device units. It
11339 can be used to scale graphics to fit the page. For example, if *maxX*
11340 and *maxY* represent the maximum horizontal and vertical 'pixel' values
11341 used in your application, the following code will scale the graphic to
11342 fit on the printer page::
11344 w, h = dc.GetSize()
11345 scaleX = maxX*
1.0 / w
11346 scaleY = maxY*
1.0 / h
11347 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
11350 <method name=
"GetSizeTuple" type=
"" overloaded=
"no">
11351 <autodoc>GetSizeTuple() -
> (width, height)
</autodoc>
11352 <docstring>This gets the horizontal and vertical resolution in device units. It
11353 can be used to scale graphics to fit the page. For example, if *maxX*
11354 and *maxY* represent the maximum horizontal and vertical 'pixel' values
11355 used in your application, the following code will scale the graphic to
11356 fit on the printer page::
11358 w, h = dc.GetSize()
11359 scaleX = maxX*
1.0 / w
11360 scaleY = maxY*
1.0 / h
11361 dc.SetUserScale(min(scaleX,scaleY),min(scaleX,scaleY))
11364 <param name=
"OUTPUT" type=
"int" default=
""/>
11365 <param name=
"OUTPUT" type=
"int" default=
""/>
11368 <method name=
"GetSizeMM" type=
"Size" overloaded=
"no">
11369 <autodoc>GetSizeMM(self) -
> Size
</autodoc>
11370 <docstring>Get the DC size in milimeters.
</docstring>
11372 <method name=
"GetSizeMMTuple" type=
"" overloaded=
"no">
11373 <autodoc>GetSizeMMTuple() -
> (width, height)
</autodoc>
11374 <docstring>Get the DC size in milimeters.
</docstring>
11376 <param name=
"OUTPUT" type=
"int" default=
""/>
11377 <param name=
"OUTPUT" type=
"int" default=
""/>
11380 <method name=
"DeviceToLogicalX" type=
"int" overloaded=
"no">
11381 <autodoc>DeviceToLogicalX(self, int x) -
> int
</autodoc>
11382 <docstring>Convert device X coordinate to logical coordinate, using the current
11383 mapping mode.
</docstring>
11385 <param name=
"x" type=
"int" default=
""/>
11388 <method name=
"DeviceToLogicalY" type=
"int" overloaded=
"no">
11389 <autodoc>DeviceToLogicalY(self, int y) -
> int
</autodoc>
11390 <docstring>Converts device Y coordinate to logical coordinate, using the current
11391 mapping mode.
</docstring>
11393 <param name=
"y" type=
"int" default=
""/>
11396 <method name=
"DeviceToLogicalXRel" type=
"int" overloaded=
"no">
11397 <autodoc>DeviceToLogicalXRel(self, int x) -
> int
</autodoc>
11398 <docstring>Convert device X coordinate to relative logical coordinate, using the
11399 current mapping mode but ignoring the x axis orientation. Use this
11400 function for converting a width, for example.
</docstring>
11402 <param name=
"x" type=
"int" default=
""/>
11405 <method name=
"DeviceToLogicalYRel" type=
"int" overloaded=
"no">
11406 <autodoc>DeviceToLogicalYRel(self, int y) -
> int
</autodoc>
11407 <docstring>Convert device Y coordinate to relative logical coordinate, using the
11408 current mapping mode but ignoring the y axis orientation. Use this
11409 function for converting a height, for example.
</docstring>
11411 <param name=
"y" type=
"int" default=
""/>
11414 <method name=
"LogicalToDeviceX" type=
"int" overloaded=
"no">
11415 <autodoc>LogicalToDeviceX(self, int x) -
> int
</autodoc>
11416 <docstring>Converts logical X coordinate to device coordinate, using the current
11417 mapping mode.
</docstring>
11419 <param name=
"x" type=
"int" default=
""/>
11422 <method name=
"LogicalToDeviceY" type=
"int" overloaded=
"no">
11423 <autodoc>LogicalToDeviceY(self, int y) -
> int
</autodoc>
11424 <docstring>Converts logical Y coordinate to device coordinate, using the current
11425 mapping mode.
</docstring>
11427 <param name=
"y" type=
"int" default=
""/>
11430 <method name=
"LogicalToDeviceXRel" type=
"int" overloaded=
"no">
11431 <autodoc>LogicalToDeviceXRel(self, int x) -
> int
</autodoc>
11432 <docstring>Converts logical X coordinate to relative device coordinate, using the
11433 current mapping mode but ignoring the x axis orientation. Use this for
11434 converting a width, for example.
</docstring>
11436 <param name=
"x" type=
"int" default=
""/>
11439 <method name=
"LogicalToDeviceYRel" type=
"int" overloaded=
"no">
11440 <autodoc>LogicalToDeviceYRel(self, int y) -
> int
</autodoc>
11441 <docstring>Converts logical Y coordinate to relative device coordinate, using the
11442 current mapping mode but ignoring the y axis orientation. Use this for
11443 converting a height, for example.
</docstring>
11445 <param name=
"y" type=
"int" default=
""/>
11448 <method name=
"CanDrawBitmap" type=
"bool" overloaded=
"no">
11449 <autodoc>CanDrawBitmap(self) -
> bool
</autodoc>
11451 <method name=
"CanGetTextExtent" type=
"bool" overloaded=
"no">
11452 <autodoc>CanGetTextExtent(self) -
> bool
</autodoc>
11454 <method name=
"GetDepth" type=
"int" overloaded=
"no">
11455 <autodoc>GetDepth(self) -
> int
</autodoc>
11456 <docstring>Returns the colour depth of the DC.
</docstring>
11458 <method name=
"GetPPI" type=
"Size" overloaded=
"no">
11459 <autodoc>GetPPI(self) -
> Size
</autodoc>
11460 <docstring>Resolution in Pixels per inch
</docstring>
11462 <method name=
"Ok" type=
"bool" overloaded=
"no">
11463 <autodoc>Ok(self) -
> bool
</autodoc>
11464 <docstring>Returns true if the DC is ok to use.
</docstring>
11466 <method name=
"GetBackgroundMode" type=
"int" overloaded=
"no">
11467 <autodoc>GetBackgroundMode(self) -
> int
</autodoc>
11468 <docstring>Returns the current background mode, either ``wx.SOLID`` or
11469 ``wx.TRANSPARENT``.
11471 :see: `SetBackgroundMode`
</docstring>
11473 <method name=
"GetBackground" type=
"Brush" overloaded=
"no">
11474 <autodoc>GetBackground(self) -
> Brush
</autodoc>
11475 <docstring>Gets the brush used for painting the background.
11477 :see: `SetBackground`
</docstring>
11479 <method name=
"GetBrush" type=
"Brush" overloaded=
"no">
11480 <autodoc>GetBrush(self) -
> Brush
</autodoc>
11481 <docstring>Gets the current brush
</docstring>
11483 <method name=
"GetFont" type=
"Font" overloaded=
"no">
11484 <autodoc>GetFont(self) -
> Font
</autodoc>
11485 <docstring>Gets the current font
</docstring>
11487 <method name=
"GetPen" type=
"Pen" overloaded=
"no">
11488 <autodoc>GetPen(self) -
> Pen
</autodoc>
11489 <docstring>Gets the current pen
</docstring>
11491 <method name=
"GetTextBackground" type=
"Colour" overloaded=
"no">
11492 <autodoc>GetTextBackground(self) -
> Colour
</autodoc>
11493 <docstring>Gets the current text background colour
</docstring>
11495 <method name=
"GetTextForeground" type=
"Colour" overloaded=
"no">
11496 <autodoc>GetTextForeground(self) -
> Colour
</autodoc>
11497 <docstring>Gets the current text foreground colour
</docstring>
11499 <method name=
"SetTextForeground" type=
"" overloaded=
"no">
11500 <autodoc>SetTextForeground(self, Colour colour)
</autodoc>
11501 <docstring>Sets the current text foreground colour for the DC.
</docstring>
11503 <param name=
"colour" type=
"Colour" default=
""/>
11506 <method name=
"SetTextBackground" type=
"" overloaded=
"no">
11507 <autodoc>SetTextBackground(self, Colour colour)
</autodoc>
11508 <docstring>Sets the current text background colour for the DC.
</docstring>
11510 <param name=
"colour" type=
"Colour" default=
""/>
11513 <method name=
"GetMapMode" type=
"int" overloaded=
"no">
11514 <autodoc>GetMapMode(self) -
> int
</autodoc>
11515 <docstring>Gets the current *mapping mode* for the device context
</docstring>
11517 <method name=
"SetMapMode" type=
"" overloaded=
"no">
11518 <autodoc>SetMapMode(self, int mode)
</autodoc>
11519 <docstring>The *mapping mode* of the device context defines the unit of
11520 measurement used to convert logical units to device units. The
11521 mapping mode can be one of the following:
11523 ================ =============================================
11524 wx.MM_TWIPS Each logical unit is
1/
20 of a point, or
1/
1440
11526 wx.MM_POINTS Each logical unit is a point, or
1/
72 of an inch.
11527 wx.MM_METRIC Each logical unit is
1 mm.
11528 wx.MM_LOMETRIC Each logical unit is
1/
10 of a mm.
11529 wx.MM_TEXT Each logical unit is
1 pixel.
11530 ================ =============================================
11532 Note that in X, text drawing isn't handled consistently with the
11533 mapping mode; a font is always specified in point size. However,
11534 setting the user scale (see `SetUserScale`) scales the text
11535 appropriately. In Windows, scalable TrueType fonts are always used; in
11536 X, results depend on availability of fonts, but usually a reasonable
11539 The coordinate origin is always at the top left of the screen/printer.
11541 Drawing to a Windows printer device context uses the current mapping
11542 mode, but mapping mode is currently ignored for PostScript output.
11545 <param name=
"mode" type=
"int" default=
""/>
11548 <method name=
"GetUserScale" type=
"" overloaded=
"no">
11549 <autodoc>GetUserScale(self) -
> (xScale, yScale)
</autodoc>
11550 <docstring>Gets the current user scale factor (set by `SetUserScale`).
</docstring>
11552 <param name=
"OUTPUT" type=
"double" default=
""/>
11553 <param name=
"OUTPUT" type=
"double" default=
""/>
11556 <method name=
"SetUserScale" type=
"" overloaded=
"no">
11557 <autodoc>SetUserScale(self, double x, double y)
</autodoc>
11558 <docstring>Sets the user scaling factor, useful for applications which require
11559 'zooming'.
</docstring>
11561 <param name=
"x" type=
"double" default=
""/>
11562 <param name=
"y" type=
"double" default=
""/>
11565 <method name=
"GetLogicalScale" type=
"" overloaded=
"no">
11566 <autodoc>GetLogicalScale() -
> (xScale, yScale)
</autodoc>
11568 <param name=
"OUTPUT" type=
"double" default=
""/>
11569 <param name=
"OUTPUT" type=
"double" default=
""/>
11572 <method name=
"SetLogicalScale" type=
"" overloaded=
"no">
11573 <autodoc>SetLogicalScale(self, double x, double y)
</autodoc>
11575 <param name=
"x" type=
"double" default=
""/>
11576 <param name=
"y" type=
"double" default=
""/>
11579 <method name=
"GetLogicalOrigin" type=
"Point" overloaded=
"no">
11580 <autodoc>GetLogicalOrigin(self) -
> Point
</autodoc>
11582 <method name=
"GetLogicalOriginTuple" type=
"" overloaded=
"no">
11583 <autodoc>GetLogicalOriginTuple() -
> (x,y)
</autodoc>
11585 <param name=
"OUTPUT" type=
"int" default=
""/>
11586 <param name=
"OUTPUT" type=
"int" default=
""/>
11589 <method name=
"SetLogicalOrigin" type=
"" overloaded=
"no">
11590 <autodoc>SetLogicalOrigin(self, int x, int y)
</autodoc>
11592 <param name=
"x" type=
"int" default=
""/>
11593 <param name=
"y" type=
"int" default=
""/>
11596 <method name=
"SetLogicalOriginPoint" type=
"" overloaded=
"no">
11597 <autodoc>SetLogicalOriginPoint(self, Point point)
</autodoc>
11599 <param name=
"point" type=
"Point" default=
""/>
11602 <method name=
"GetDeviceOrigin" type=
"Point" overloaded=
"no">
11603 <autodoc>GetDeviceOrigin(self) -
> Point
</autodoc>
11605 <method name=
"GetDeviceOriginTuple" type=
"" overloaded=
"no">
11606 <autodoc>GetDeviceOriginTuple() -
> (x,y)
</autodoc>
11608 <param name=
"OUTPUT" type=
"int" default=
""/>
11609 <param name=
"OUTPUT" type=
"int" default=
""/>
11612 <method name=
"SetDeviceOrigin" type=
"" overloaded=
"no">
11613 <autodoc>SetDeviceOrigin(self, int x, int y)
</autodoc>
11615 <param name=
"x" type=
"int" default=
""/>
11616 <param name=
"y" type=
"int" default=
""/>
11619 <method name=
"SetDeviceOriginPoint" type=
"" overloaded=
"no">
11620 <autodoc>SetDeviceOriginPoint(self, Point point)
</autodoc>
11622 <param name=
"point" type=
"Point" default=
""/>
11625 <method name=
"SetAxisOrientation" type=
"" overloaded=
"no">
11626 <autodoc>SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)
</autodoc>
11627 <docstring>Sets the x and y axis orientation (i.e., the direction from lowest to
11628 highest values on the axis). The default orientation is the natural
11629 orientation, e.g. x axis from left to right and y axis from bottom up.
</docstring>
11631 <param name=
"xLeftRight" type=
"bool" default=
""/>
11632 <param name=
"yBottomUp" type=
"bool" default=
""/>
11635 <method name=
"GetLogicalFunction" type=
"int" overloaded=
"no">
11636 <autodoc>GetLogicalFunction(self) -
> int
</autodoc>
11637 <docstring>Gets the current logical function (set by `SetLogicalFunction`).
</docstring>
11639 <method name=
"SetLogicalFunction" type=
"" overloaded=
"no">
11640 <autodoc>SetLogicalFunction(self, int function)
</autodoc>
11641 <docstring>Sets the current logical function for the device context. This
11642 determines how a source pixel (from a pen or brush colour, or source
11643 device context if using `Blit`) combines with a destination pixel in
11644 the current device context.
11646 The possible values and their meaning in terms of source and
11647 destination pixel values are as follows:
11649 ================ ==========================
11651 wx.AND_INVERT (NOT src) AND dst
11652 wx.AND_REVERSE src AND (NOT dst)
11655 wx.EQUIV (NOT src) XOR dst
11657 wx.NAND (NOT src) OR (NOT dst)
11658 wx.NOR (NOT src) AND (NOT dst)
11661 wx.OR_INVERT (NOT src) OR dst
11662 wx.OR_REVERSE src OR (NOT dst)
11664 wx.SRC_INVERT NOT src
11666 ================ ==========================
11668 The default is wx.COPY, which simply draws with the current
11669 colour. The others combine the current colour and the background using
11670 a logical operation. wx.INVERT is commonly used for drawing rubber
11671 bands or moving outlines, since drawing twice reverts to the original
11675 <param name=
"function" type=
"int" default=
""/>
11678 <method name=
"SetOptimization" type=
"" overloaded=
"no">
11679 <autodoc>SetOptimization(self, bool optimize)
</autodoc>
11680 <docstring>If *optimize* is true this function sets optimization mode on. This
11681 currently means that under X, the device context will not try to set a
11682 pen or brush property if it is known to be set already. This approach
11683 can fall down if non-wxWidgets code is using the same device context
11684 or window, for example when the window is a panel on which the
11685 windowing system draws panel items. The wxWidgets device context
11686 'memory' will now be out of step with reality.
11688 Setting optimization off, drawing, then setting it back on again, is a
11689 trick that must occasionally be employed.
</docstring>
11691 <param name=
"optimize" type=
"bool" default=
""/>
11694 <method name=
"GetOptimization" type=
"bool" overloaded=
"no">
11695 <autodoc>GetOptimization(self) -
> bool
</autodoc>
11696 <docstring>Returns true if device context optimization is on. See
11697 `SetOptimization` for .
</docstring>
11699 <method name=
"CalcBoundingBox" type=
"" overloaded=
"no">
11700 <autodoc>CalcBoundingBox(self, int x, int y)
</autodoc>
11701 <docstring>Adds the specified point to the bounding box which can be retrieved
11702 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
</docstring>
11704 <param name=
"x" type=
"int" default=
""/>
11705 <param name=
"y" type=
"int" default=
""/>
11708 <method name=
"CalcBoundingBoxPoint" type=
"" overloaded=
"no">
11709 <autodoc>CalcBoundingBoxPoint(self, Point point)
</autodoc>
11710 <docstring>Adds the specified point to the bounding box which can be retrieved
11711 with `MinX`, `MaxX` and `MinY`, `MaxY` or `GetBoundingBox` functions.
</docstring>
11713 <param name=
"point" type=
"Point" default=
""/>
11716 <method name=
"ResetBoundingBox" type=
"" overloaded=
"no">
11717 <autodoc>ResetBoundingBox(self)
</autodoc>
11718 <docstring>Resets the bounding box: after a call to this function, the bounding
11719 box doesn't contain anything.
</docstring>
11721 <method name=
"MinX" type=
"int" overloaded=
"no">
11722 <autodoc>MinX(self) -
> int
</autodoc>
11723 <docstring>Gets the minimum horizontal extent used in drawing commands so far.
</docstring>
11725 <method name=
"MaxX" type=
"int" overloaded=
"no">
11726 <autodoc>MaxX(self) -
> int
</autodoc>
11727 <docstring>Gets the maximum horizontal extent used in drawing commands so far.
</docstring>
11729 <method name=
"MinY" type=
"int" overloaded=
"no">
11730 <autodoc>MinY(self) -
> int
</autodoc>
11731 <docstring>Gets the minimum vertical extent used in drawing commands so far.
</docstring>
11733 <method name=
"MaxY" type=
"int" overloaded=
"no">
11734 <autodoc>MaxY(self) -
> int
</autodoc>
11735 <docstring>Gets the maximum vertical extent used in drawing commands so far.
</docstring>
11737 <method name=
"GetBoundingBox" type=
"" overloaded=
"no">
11738 <autodoc>GetBoundingBox() -
> (x1,y1, x2,y2)
</autodoc>
11739 <docstring>Returns the min and max points used in drawing commands so far.
</docstring>
11741 <param name=
"OUTPUT" type=
"int" default=
""/>
11742 <param name=
"OUTPUT" type=
"int" default=
""/>
11743 <param name=
"OUTPUT" type=
"int" default=
""/>
11744 <param name=
"OUTPUT" type=
"int" default=
""/>
11747 <method name=
"_DrawPointList" type=
"PyObject" overloaded=
"no">
11748 <autodoc>_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -
> PyObject
</autodoc>
11750 <param name=
"pyCoords" type=
"PyObject" default=
""/>
11751 <param name=
"pyPens" type=
"PyObject" default=
""/>
11752 <param name=
"pyBrushes" type=
"PyObject" default=
""/>
11755 <method name=
"_DrawLineList" type=
"PyObject" overloaded=
"no">
11756 <autodoc>_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -
> PyObject
</autodoc>
11758 <param name=
"pyCoords" type=
"PyObject" default=
""/>
11759 <param name=
"pyPens" type=
"PyObject" default=
""/>
11760 <param name=
"pyBrushes" type=
"PyObject" default=
""/>
11763 <method name=
"_DrawRectangleList" type=
"PyObject" overloaded=
"no">
11764 <autodoc>_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -
> PyObject
</autodoc>
11766 <param name=
"pyCoords" type=
"PyObject" default=
""/>
11767 <param name=
"pyPens" type=
"PyObject" default=
""/>
11768 <param name=
"pyBrushes" type=
"PyObject" default=
""/>
11771 <method name=
"_DrawEllipseList" type=
"PyObject" overloaded=
"no">
11772 <autodoc>_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -
> PyObject
</autodoc>
11774 <param name=
"pyCoords" type=
"PyObject" default=
""/>
11775 <param name=
"pyPens" type=
"PyObject" default=
""/>
11776 <param name=
"pyBrushes" type=
"PyObject" default=
""/>
11779 <method name=
"_DrawPolygonList" type=
"PyObject" overloaded=
"no">
11780 <autodoc>_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -
> PyObject
</autodoc>
11782 <param name=
"pyCoords" type=
"PyObject" default=
""/>
11783 <param name=
"pyPens" type=
"PyObject" default=
""/>
11784 <param name=
"pyBrushes" type=
"PyObject" default=
""/>
11787 <method name=
"_DrawTextList" type=
"PyObject" overloaded=
"no">
11788 <autodoc>_DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList,
11789 PyObject backgroundList) -
> PyObject
</autodoc>
11791 <param name=
"textList" type=
"PyObject" default=
""/>
11792 <param name=
"pyPoints" type=
"PyObject" default=
""/>
11793 <param name=
"foregroundList" type=
"PyObject" default=
""/>
11794 <param name=
"backgroundList" type=
"PyObject" default=
""/>
11799 #---------------------------------------------------------------------------
11801 <class name=
"MemoryDC" oldname=
"wxMemoryDC" module=
"_gdi">
11802 <docstring>A memory device context provides a means to draw graphics onto a
11803 bitmap. A bitmap must be selected into the new memory DC before it may
11804 be used for anything. Typical usage is as follows::
11807 dc.SelectObject(bitmap)
11808 # draw on the dc usign any of the Draw methods
11809 dc.SelectObject(wx.NullBitmap)
11810 # the bitmap now contains wahtever was drawn upon it
11812 Note that the memory DC *must* be deleted (or the bitmap selected out
11813 of it) before a bitmap can be reselected into another memory DC.
11815 <baseclass name=
"DC"/>
11816 <constructor name=
"MemoryDC" overloaded=
"no">
11817 <autodoc>__init__(self) -
> MemoryDC
</autodoc>
11818 <docstring>Constructs a new memory device context.
11820 Use the Ok member to test whether the constructor was successful in
11821 creating a usable device context. Don't forget to select a bitmap into
11822 the DC before drawing on it.
11824 :see: `MemoryDCFromDC`
</docstring>
11826 <constructor name=
"MemoryDCFromDC" overloaded=
"no">
11827 <autodoc>MemoryDCFromDC(DC oldDC) -
> MemoryDC
</autodoc>
11828 <docstring>Creates a DC that is compatible with the oldDC.
</docstring>
11830 <param name=
"oldDC" type=
"DC" default=
""/>
11833 <method name=
"SelectObject" type=
"" overloaded=
"no">
11834 <autodoc>SelectObject(self, Bitmap bitmap)
</autodoc>
11835 <docstring>Selects the bitmap into the device context, to use as the memory
11836 bitmap. Selecting the bitmap into a memory DC allows you to draw into
11837 the DC, and therefore the bitmap, and also to use Blit to copy the
11838 bitmap to a window.
11840 If the argument is wx.NullBitmap (or some other uninitialised
11841 `wx.Bitmap`) the current bitmap is selected out of the device context,
11842 and the original bitmap restored, allowing the current bitmap to be
11843 destroyed safely.
</docstring>
11845 <param name=
"bitmap" type=
"Bitmap" default=
""/>
11850 #---------------------------------------------------------------------------
11852 <class name=
"BufferedDC" oldname=
"wxBufferedDC" module=
"_gdi">
11853 <docstring>This simple class provides a simple way to avoid flicker: when drawing
11854 on it, everything is in fact first drawn on an in-memory buffer (a
11855 `wx.Bitmap`) and then copied to the screen only once, when this object
11858 It can be used in the same way as any other device
11859 context. wx.BufferedDC itself typically replaces `wx.ClientDC`, if you
11860 want to use it in your EVT_PAINT handler, you should look at
11861 `wx.BufferedPaintDC`.
11863 <baseclass name=
"MemoryDC"/>
11864 <constructor name=
"BufferedDC" overloaded=
"yes">
11865 <docstring>Constructs a buffered DC.
11867 :param dc: The underlying DC: everything drawn to this object will
11868 be flushed to this DC when this object is destroyed. You may
11869 pass ``None`` in order to just initialize the buffer, and not
11872 :param buffer: If a `wx.Size` object is passed as the
2nd arg then
11873 it is the size of the bitmap that will be created internally
11874 and used for an implicit buffer. If the
2nd arg is a
11875 `wx.Bitmap` then it is the explicit buffer that will be
11876 used. Using an explicit buffer is the most efficient solution
11877 as the bitmap doesn't have to be recreated each time but it
11878 also requires more memory as the bitmap is never freed. The
11879 bitmap should have appropriate size, anything drawn outside of
11880 its bounds is clipped.
11883 <param name=
"dc" type=
"DC" default=
""/>
11884 <param name=
"buffer" type=
"Bitmap" default=
""/>
11887 <constructor name=
"BufferedDC" overloaded=
"yes">
11888 <autodoc>__init__(self, DC dc, Bitmap buffer) -
> BufferedDC
11889 __init__(self, DC dc, Size area) -
> BufferedDC
</autodoc>
11890 <docstring>Constructs a buffered DC.
11892 :param dc: The underlying DC: everything drawn to this object will
11893 be flushed to this DC when this object is destroyed. You may
11894 pass ``None`` in order to just initialize the buffer, and not
11897 :param buffer: If a `wx.Size` object is passed as the
2nd arg then
11898 it is the size of the bitmap that will be created internally
11899 and used for an implicit buffer. If the
2nd arg is a
11900 `wx.Bitmap` then it is the explicit buffer that will be
11901 used. Using an explicit buffer is the most efficient solution
11902 as the bitmap doesn't have to be recreated each time but it
11903 also requires more memory as the bitmap is never freed. The
11904 bitmap should have appropriate size, anything drawn outside of
11905 its bounds is clipped.
11908 <param name=
"dc" type=
"DC" default=
""/>
11909 <param name=
"area" type=
"Size" default=
""/>
11912 <destructor name=
"~wxBufferedDC" overloaded=
"no">
11913 <autodoc>__del__(self)
</autodoc>
11914 <docstring>Copies everything drawn on the DC so far to the underlying DC
11915 associated with this object, if any.
</docstring>
11917 <method name=
"UnMask" type=
"" overloaded=
"no">
11918 <autodoc>UnMask(self)
</autodoc>
11919 <docstring>Blits the buffer to the dc, and detaches the dc from the buffer (so it
11920 can be effectively used once only). This is usually only called in
11921 the destructor.
</docstring>
11924 <class name=
"BufferedPaintDC" oldname=
"wxBufferedPaintDC" module=
"_gdi">
11925 <docstring>This is a subclass of `wx.BufferedDC` which can be used inside of an
11926 EVT_PAINT event handler. Just create an object of this class instead
11927 of `wx.PaintDC` and that's all you have to do to (mostly) avoid
11928 flicker. The only thing to watch out for is that if you are using this
11929 class together with `wx.ScrolledWindow`, you probably do **not** want
11930 to call `wx.Window.PrepareDC` on it as it already does this internally
11931 for the real underlying `wx.PaintDC`.
11933 If your window is already fully buffered in a `wx.Bitmap` then your
11934 EVT_PAINT handler can be as simple as just creating a
11935 ``wx.BufferedPaintDC`` as it will `Blit` the buffer to the window
11936 automatically when it is destroyed. For example::
11938 def OnPaint(self, event):
11939 dc = wx.BufferedPaintDC(self, self.buffer)
11943 <baseclass name=
"BufferedDC"/>
11944 <constructor name=
"BufferedPaintDC" overloaded=
"no">
11945 <autodoc>__init__(self, Window window, Bitmap buffer=NullBitmap) -
> BufferedPaintDC
</autodoc>
11946 <docstring>Create a buffered paint DC. As with `wx.BufferedDC`, you may either
11947 provide the bitmap to be used for buffering or let this object create
11948 one internally (in the latter case, the size of the client part of the
11949 window is automatically used).
11953 <param name=
"window" type=
"Window" default=
""/>
11954 <param name=
"buffer" type=
"Bitmap" default=
"wxNullBitmap"/>
11959 #---------------------------------------------------------------------------
11961 <class name=
"ScreenDC" oldname=
"wxScreenDC" module=
"_gdi">
11962 <docstring>A wxScreenDC can be used to paint anywhere on the screen. This should
11963 normally be constructed as a temporary stack object; don't store a
11966 <baseclass name=
"DC"/>
11967 <constructor name=
"ScreenDC" overloaded=
"no">
11968 <autodoc>__init__(self) -
> ScreenDC
</autodoc>
11969 <docstring>A wxScreenDC can be used to paint anywhere on the screen. This should
11970 normally be constructed as a temporary stack object; don't store a
11974 <method name=
"StartDrawingOnTopWin" type=
"bool" overloaded=
"no">
11975 <autodoc>StartDrawingOnTopWin(self, Window window) -
> bool
</autodoc>
11976 <docstring>Specify that the area of the screen to be drawn upon coincides with
11979 :see: `EndDrawingOnTop`
</docstring>
11981 <param name=
"window" type=
"Window" default=
""/>
11984 <method name=
"StartDrawingOnTop" type=
"bool" overloaded=
"no">
11985 <autodoc>StartDrawingOnTop(self, Rect rect=None) -
> bool
</autodoc>
11986 <docstring>Specify that the area is the given rectangle, or the whole screen if
11987 ``None`` is passed.
11989 :see: `EndDrawingOnTop`
</docstring>
11991 <param name=
"rect" type=
"Rect" default=
"NULL"/>
11994 <method name=
"EndDrawingOnTop" type=
"bool" overloaded=
"no">
11995 <autodoc>EndDrawingOnTop(self) -
> bool
</autodoc>
11996 <docstring>Use this in conjunction with `StartDrawingOnTop` or
11997 `StartDrawingOnTopWin` to ensure that drawing to the screen occurs on
11998 top of existing windows. Without this, some window systems (such as X)
11999 only allow drawing to take place underneath other windows.
12001 You might use this pair of functions when implementing a drag feature,
12002 for example as in the `wx.SplitterWindow` implementation.
12004 These functions are probably obsolete since the X implementations
12005 allow drawing directly on the screen now. However, the fact that this
12006 function allows the screen to be refreshed afterwards may be useful
12007 to some applications.
</docstring>
12011 #---------------------------------------------------------------------------
12013 <class name=
"ClientDC" oldname=
"wxClientDC" module=
"_gdi">
12014 <docstring>A wx.ClientDC must be constructed if an application wishes to paint on
12015 the client area of a window from outside an EVT_PAINT event. This should
12016 normally be constructed as a temporary stack object; don't store a
12017 wx.ClientDC object long term.
12019 To draw on a window from within an EVT_PAINT handler, construct a
12020 `wx.PaintDC` object.
12022 To draw on the whole window including decorations, construct a
12023 `wx.WindowDC` object (Windows only).
12025 <baseclass name=
"DC"/>
12026 <constructor name=
"ClientDC" overloaded=
"no">
12027 <autodoc>__init__(self, Window win) -
> ClientDC
</autodoc>
12028 <docstring>Constructor. Pass the window on which you wish to paint.
</docstring>
12030 <param name=
"win" type=
"Window" default=
""/>
12035 #---------------------------------------------------------------------------
12037 <class name=
"PaintDC" oldname=
"wxPaintDC" module=
"_gdi">
12038 <docstring>A wx.PaintDC must be constructed if an application wishes to paint on
12039 the client area of a window from within an EVT_PAINT event
12040 handler. This should normally be constructed as a temporary stack
12041 object; don't store a wx.PaintDC object. If you have an EVT_PAINT
12042 handler, you **must** create a wx.PaintDC object within it even if you
12043 don't actually use it.
12045 Using wx.PaintDC within EVT_PAINT handlers is important because it
12046 automatically sets the clipping area to the damaged area of the
12047 window. Attempts to draw outside this area do not appear.
12049 To draw on a window from outside EVT_PAINT handlers, construct a
12050 `wx.ClientDC` object.
12052 <baseclass name=
"DC"/>
12053 <constructor name=
"PaintDC" overloaded=
"no">
12054 <autodoc>__init__(self, Window win) -
> PaintDC
</autodoc>
12055 <docstring>Constructor. Pass the window on which you wish to paint.
</docstring>
12057 <param name=
"win" type=
"Window" default=
""/>
12062 #---------------------------------------------------------------------------
12064 <class name=
"WindowDC" oldname=
"wxWindowDC" module=
"_gdi">
12065 <docstring>A wx.WindowDC must be constructed if an application wishes to paint on
12066 the whole area of a window (client and decorations). This should
12067 normally be constructed as a temporary stack object; don't store a
12068 wx.WindowDC object.
</docstring>
12069 <baseclass name=
"DC"/>
12070 <constructor name=
"WindowDC" overloaded=
"no">
12071 <autodoc>__init__(self, Window win) -
> WindowDC
</autodoc>
12072 <docstring>Constructor. Pass the window on which you wish to paint.
</docstring>
12074 <param name=
"win" type=
"Window" default=
""/>
12079 #---------------------------------------------------------------------------
12081 <class name=
"MirrorDC" oldname=
"wxMirrorDC" module=
"_gdi">
12082 <docstring>wx.MirrorDC is a simple wrapper class which is always associated with a
12083 real `wx.DC` object and either forwards all of its operations to it
12084 without changes (no mirroring takes place) or exchanges x and y
12085 coordinates which makes it possible to reuse the same code to draw a
12086 figure and its mirror -- i.e. reflection related to the diagonal line
12087 x == y.
</docstring>
12088 <baseclass name=
"DC"/>
12089 <constructor name=
"MirrorDC" overloaded=
"no">
12090 <autodoc>__init__(self, DC dc, bool mirror) -
> MirrorDC
</autodoc>
12091 <docstring>Creates a mirrored DC associated with the real *dc*. Everything drawn
12092 on the wx.MirrorDC will appear on the *dc*, and will be mirrored if
12093 *mirror* is True.
</docstring>
12095 <param name=
"dc" type=
"DC" default=
""/>
12096 <param name=
"mirror" type=
"bool" default=
""/>
12101 #---------------------------------------------------------------------------
12103 <class name=
"PostScriptDC" oldname=
"wxPostScriptDC" module=
"_gdi">
12104 <docstring>This is a `wx.DC` that can write to PostScript files on any platform.
</docstring>
12105 <baseclass name=
"DC"/>
12106 <constructor name=
"PostScriptDC" overloaded=
"no">
12107 <autodoc>__init__(self, wxPrintData printData) -
> PostScriptDC
</autodoc>
12108 <docstring>Constructs a PostScript printer device context from a `wx.PrintData`
12109 object.
</docstring>
12111 <param name=
"printData" type=
"wxPrintData" default=
""/>
12114 <method name=
"GetPrintData" type=
"wxPrintData" overloaded=
"no">
12115 <autodoc>GetPrintData(self) -
> wxPrintData
</autodoc>
12117 <method name=
"SetPrintData" type=
"" overloaded=
"no">
12118 <autodoc>SetPrintData(self, wxPrintData data)
</autodoc>
12120 <param name=
"data" type=
"wxPrintData" default=
""/>
12123 <staticmethod name=
"SetResolution" type=
"" overloaded=
"no">
12124 <autodoc>SetResolution(int ppi)
</autodoc>
12125 <docstring>Set resolution (in pixels per inch) that will be used in PostScript
12126 output. Default is
720ppi.
</docstring>
12128 <param name=
"ppi" type=
"int" default=
""/>
12131 <staticmethod name=
"GetResolution" type=
"int" overloaded=
"no">
12132 <autodoc>GetResolution() -
> int
</autodoc>
12133 <docstring>Return resolution used in PostScript output.
</docstring>
12137 #---------------------------------------------------------------------------
12139 <class name=
"MetaFile" oldname=
"wxMetaFile" module=
"_gdi">
12140 <baseclass name=
"Object"/>
12141 <constructor name=
"MetaFile" overloaded=
"no">
12142 <autodoc>__init__(self, String filename=EmptyString) -
> MetaFile
</autodoc>
12144 <param name=
"filename" type=
"String" default=
"wxPyEmptyString"/>
12148 <class name=
"MetaFileDC" oldname=
"wxMetaFileDC" module=
"_gdi">
12149 <baseclass name=
"DC"/>
12150 <constructor name=
"MetaFileDC" overloaded=
"no">
12151 <autodoc>__init__(self, String filename=EmptyString, int width=
0, int height=
0,
12152 String description=EmptyString) -
> MetaFileDC
</autodoc>
12154 <param name=
"filename" type=
"String" default=
"wxPyEmptyString"/>
12155 <param name=
"width" type=
"int" default=
"0"/>
12156 <param name=
"height" type=
"int" default=
"0"/>
12157 <param name=
"description" type=
"String" default=
"wxPyEmptyString"/>
12161 <class name=
"PrinterDC" oldname=
"wxPrinterDC" module=
"_gdi">
12162 <baseclass name=
"DC"/>
12163 <constructor name=
"PrinterDC" overloaded=
"no">
12164 <autodoc>__init__(self, wxPrintData printData) -
> PrinterDC
</autodoc>
12166 <param name=
"printData" type=
"wxPrintData" default=
""/>
12171 #---------------------------------------------------------------------------
12173 <class name=
"ImageList" oldname=
"wxImageList" module=
"_gdi">
12174 <baseclass name=
"Object"/>
12175 <constructor name=
"ImageList" overloaded=
"no">
12176 <autodoc>__init__(self, int width, int height, int mask=True, int initialCount=
1) -
> ImageList
</autodoc>
12178 <param name=
"width" type=
"int" default=
""/>
12179 <param name=
"height" type=
"int" default=
""/>
12180 <param name=
"mask" type=
"int" default=
"True"/>
12181 <param name=
"initialCount" type=
"int" default=
"1"/>
12184 <destructor name=
"~wxImageList" overloaded=
"no">
12185 <autodoc>__del__(self)
</autodoc>
12187 <method name=
"Add" type=
"int" overloaded=
"no">
12188 <autodoc>Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -
> int
</autodoc>
12190 <param name=
"bitmap" type=
"Bitmap" default=
""/>
12191 <param name=
"mask" type=
"Bitmap" default=
"wxNullBitmap"/>
12194 <method name=
"AddWithColourMask" type=
"int" overloaded=
"no">
12195 <autodoc>AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -
> int
</autodoc>
12197 <param name=
"bitmap" type=
"Bitmap" default=
""/>
12198 <param name=
"maskColour" type=
"Colour" default=
""/>
12201 <method name=
"AddIcon" type=
"int" overloaded=
"no">
12202 <autodoc>AddIcon(self, Icon icon) -
> int
</autodoc>
12204 <param name=
"icon" type=
"Icon" default=
""/>
12207 <method name=
"Replace" type=
"bool" overloaded=
"no">
12208 <autodoc>Replace(self, int index, Bitmap bitmap) -
> bool
</autodoc>
12210 <param name=
"index" type=
"int" default=
""/>
12211 <param name=
"bitmap" type=
"Bitmap" default=
""/>
12214 <method name=
"Draw" type=
"bool" overloaded=
"no">
12215 <autodoc>Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL,
12216 bool solidBackground=False) -
> bool
</autodoc>
12218 <param name=
"index" type=
"int" default=
""/>
12219 <param name=
"dc" type=
"DC" default=
""/>
12220 <param name=
"x" type=
"int" default=
""/>
12221 <param name=
"x" type=
"int" default=
""/>
12222 <param name=
"flags" type=
"int" default=
"wxIMAGELIST_DRAW_NORMAL"/>
12223 <param name=
"solidBackground" type=
"bool" default=
"False"/>
12226 <method name=
"GetImageCount" type=
"int" overloaded=
"no">
12227 <autodoc>GetImageCount(self) -
> int
</autodoc>
12229 <method name=
"Remove" type=
"bool" overloaded=
"no">
12230 <autodoc>Remove(self, int index) -
> bool
</autodoc>
12232 <param name=
"index" type=
"int" default=
""/>
12235 <method name=
"RemoveAll" type=
"bool" overloaded=
"no">
12236 <autodoc>RemoveAll(self) -
> bool
</autodoc>
12238 <method name=
"GetSize" type=
"" overloaded=
"no">
12239 <autodoc>GetSize() -
> (width,height)
</autodoc>
12241 <param name=
"index" type=
"int" default=
""/>
12242 <param name=
"OUTPUT" type=
"int" default=
""/>
12243 <param name=
"OUTPUT" type=
"int" default=
""/>
12248 #---------------------------------------------------------------------------
12250 <class name=
"PenList" oldname=
"wxPenList" module=
"_gdi">
12251 <baseclass name=
"Object"/>
12252 <method name=
"AddPen" type=
"" overloaded=
"no">
12253 <autodoc>AddPen(self, Pen pen)
</autodoc>
12255 <param name=
"pen" type=
"Pen" default=
""/>
12258 <method name=
"FindOrCreatePen" type=
"Pen" overloaded=
"no">
12259 <autodoc>FindOrCreatePen(self, Colour colour, int width, int style) -
> Pen
</autodoc>
12261 <param name=
"colour" type=
"Colour" default=
""/>
12262 <param name=
"width" type=
"int" default=
""/>
12263 <param name=
"style" type=
"int" default=
""/>
12266 <method name=
"RemovePen" type=
"" overloaded=
"no">
12267 <autodoc>RemovePen(self, Pen pen)
</autodoc>
12269 <param name=
"pen" type=
"Pen" default=
""/>
12272 <method name=
"GetCount" type=
"int" overloaded=
"no">
12273 <autodoc>GetCount(self) -
> int
</autodoc>
12276 <class name=
"BrushList" oldname=
"wxBrushList" module=
"_gdi">
12277 <baseclass name=
"Object"/>
12278 <method name=
"AddBrush" type=
"" overloaded=
"no">
12279 <autodoc>AddBrush(self, Brush brush)
</autodoc>
12281 <param name=
"brush" type=
"Brush" default=
""/>
12284 <method name=
"FindOrCreateBrush" type=
"Brush" overloaded=
"no">
12285 <autodoc>FindOrCreateBrush(self, Colour colour, int style) -
> Brush
</autodoc>
12287 <param name=
"colour" type=
"Colour" default=
""/>
12288 <param name=
"style" type=
"int" default=
""/>
12291 <method name=
"RemoveBrush" type=
"" overloaded=
"no">
12292 <autodoc>RemoveBrush(self, Brush brush)
</autodoc>
12294 <param name=
"brush" type=
"Brush" default=
""/>
12297 <method name=
"GetCount" type=
"int" overloaded=
"no">
12298 <autodoc>GetCount(self) -
> int
</autodoc>
12301 <class name=
"ColourDatabase" oldname=
"wxColourDatabase" module=
"_gdi">
12302 <baseclass name=
"Object"/>
12303 <constructor name=
"ColourDatabase" overloaded=
"no">
12304 <autodoc>__init__(self) -
> ColourDatabase
</autodoc>
12306 <destructor name=
"~wxColourDatabase" overloaded=
"no">
12307 <autodoc>__del__(self)
</autodoc>
12309 <method name=
"Find" type=
"Colour" overloaded=
"no">
12310 <autodoc>Find(self, String name) -
> Colour
</autodoc>
12312 <param name=
"name" type=
"String" default=
""/>
12315 <method name=
"FindName" type=
"String" overloaded=
"no">
12316 <autodoc>FindName(self, Colour colour) -
> String
</autodoc>
12318 <param name=
"colour" type=
"Colour" default=
""/>
12321 <method name=
"AddColour" type=
"" overloaded=
"no">
12322 <autodoc>AddColour(self, String name, Colour colour)
</autodoc>
12324 <param name=
"name" type=
"String" default=
""/>
12325 <param name=
"colour" type=
"Colour" default=
""/>
12328 <method name=
"Append" type=
"" overloaded=
"no">
12329 <autodoc>Append(self, String name, int red, int green, int blue)
</autodoc>
12331 <param name=
"name" type=
"String" default=
""/>
12332 <param name=
"red" type=
"int" default=
""/>
12333 <param name=
"green" type=
"int" default=
""/>
12334 <param name=
"blue" type=
"int" default=
""/>
12338 <class name=
"FontList" oldname=
"wxFontList" module=
"_gdi">
12339 <baseclass name=
"Object"/>
12340 <method name=
"AddFont" type=
"" overloaded=
"no">
12341 <autodoc>AddFont(self, Font font)
</autodoc>
12343 <param name=
"font" type=
"Font" default=
""/>
12346 <method name=
"FindOrCreateFont" type=
"Font" overloaded=
"no">
12347 <autodoc>FindOrCreateFont(self, int point_size, int family, int style, int weight,
12348 bool underline=False, String facename=EmptyString,
12349 int encoding=FONTENCODING_DEFAULT) -
> Font
</autodoc>
12351 <param name=
"point_size" type=
"int" default=
""/>
12352 <param name=
"family" type=
"int" default=
""/>
12353 <param name=
"style" type=
"int" default=
""/>
12354 <param name=
"weight" type=
"int" default=
""/>
12355 <param name=
"underline" type=
"bool" default=
"False"/>
12356 <param name=
"facename" type=
"String" default=
"wxPyEmptyString"/>
12357 <param name=
"encoding" type=
"wxFontEncoding" default=
"wxFONTENCODING_DEFAULT"/>
12360 <method name=
"RemoveFont" type=
"" overloaded=
"no">
12361 <autodoc>RemoveFont(self, Font font)
</autodoc>
12363 <param name=
"font" type=
"Font" default=
""/>
12366 <method name=
"GetCount" type=
"int" overloaded=
"no">
12367 <autodoc>GetCount(self) -
> int
</autodoc>
12371 #---------------------------------------------------------------------------
12373 <pythoncode> NullColor = NullColour
</pythoncode>
12375 #---------------------------------------------------------------------------
12377 <class name=
"Effects" oldname=
"wxEffects" module=
"_gdi">
12378 <baseclass name=
"Object"/>
12379 <constructor name=
"Effects" overloaded=
"no">
12380 <autodoc>__init__(self) -
> Effects
</autodoc>
12382 <method name=
"GetHighlightColour" type=
"Colour" overloaded=
"no">
12383 <autodoc>GetHighlightColour(self) -
> Colour
</autodoc>
12385 <method name=
"GetLightShadow" type=
"Colour" overloaded=
"no">
12386 <autodoc>GetLightShadow(self) -
> Colour
</autodoc>
12388 <method name=
"GetFaceColour" type=
"Colour" overloaded=
"no">
12389 <autodoc>GetFaceColour(self) -
> Colour
</autodoc>
12391 <method name=
"GetMediumShadow" type=
"Colour" overloaded=
"no">
12392 <autodoc>GetMediumShadow(self) -
> Colour
</autodoc>
12394 <method name=
"GetDarkShadow" type=
"Colour" overloaded=
"no">
12395 <autodoc>GetDarkShadow(self) -
> Colour
</autodoc>
12397 <method name=
"SetHighlightColour" type=
"" overloaded=
"no">
12398 <autodoc>SetHighlightColour(self, Colour c)
</autodoc>
12400 <param name=
"c" type=
"Colour" default=
""/>
12403 <method name=
"SetLightShadow" type=
"" overloaded=
"no">
12404 <autodoc>SetLightShadow(self, Colour c)
</autodoc>
12406 <param name=
"c" type=
"Colour" default=
""/>
12409 <method name=
"SetFaceColour" type=
"" overloaded=
"no">
12410 <autodoc>SetFaceColour(self, Colour c)
</autodoc>
12412 <param name=
"c" type=
"Colour" default=
""/>
12415 <method name=
"SetMediumShadow" type=
"" overloaded=
"no">
12416 <autodoc>SetMediumShadow(self, Colour c)
</autodoc>
12418 <param name=
"c" type=
"Colour" default=
""/>
12421 <method name=
"SetDarkShadow" type=
"" overloaded=
"no">
12422 <autodoc>SetDarkShadow(self, Colour c)
</autodoc>
12424 <param name=
"c" type=
"Colour" default=
""/>
12427 <method name=
"Set" type=
"" overloaded=
"no">
12428 <autodoc>Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour,
12429 Colour mediumShadow, Colour darkShadow)
</autodoc>
12431 <param name=
"highlightColour" type=
"Colour" default=
""/>
12432 <param name=
"lightShadow" type=
"Colour" default=
""/>
12433 <param name=
"faceColour" type=
"Colour" default=
""/>
12434 <param name=
"mediumShadow" type=
"Colour" default=
""/>
12435 <param name=
"darkShadow" type=
"Colour" default=
""/>
12438 <method name=
"DrawSunkenEdge" type=
"" overloaded=
"no">
12439 <autodoc>DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=
1)
</autodoc>
12441 <param name=
"dc" type=
"DC" default=
""/>
12442 <param name=
"rect" type=
"Rect" default=
""/>
12443 <param name=
"borderSize" type=
"int" default=
"1"/>
12446 <method name=
"TileBitmap" type=
"bool" overloaded=
"no">
12447 <autodoc>TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -
> bool
</autodoc>
12449 <param name=
"rect" type=
"Rect" default=
""/>
12450 <param name=
"dc" type=
"DC" default=
""/>
12451 <param name=
"bitmap" type=
"Bitmap" default=
""/>
12456 <module name=
"_windows">
12457 <import name=
"_core"/>
12458 <pythoncode> wx = _core
</pythoncode>
12460 #---------------------------------------------------------------------------
12462 <class name=
"Panel" oldname=
"wxPanel" module=
"_windows">
12463 <baseclass name=
"Window"/>
12464 <constructor name=
"Panel" overloaded=
"no">
12465 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
12466 Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER,
12467 String name=PanelNameStr) -
> Panel
</autodoc>
12469 <param name=
"parent" type=
"Window" default=
""/>
12470 <param name=
"id" type=
"int" default=
"-1"/>
12471 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
12472 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
12473 <param name=
"style" type=
"long" default=
"wxTAB_TRAVERSAL|wxNO_BORDER"/>
12474 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
12477 <constructor name=
"PrePanel" overloaded=
"no">
12478 <autodoc>PrePanel() -
> Panel
</autodoc>
12480 <method name=
"Create" type=
"bool" overloaded=
"no">
12481 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
12482 Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER,
12483 String name=PanelNameStr) -
> bool
</autodoc>
12485 <param name=
"parent" type=
"Window" default=
""/>
12486 <param name=
"id" type=
"int" default=
"-1"/>
12487 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
12488 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
12489 <param name=
"style" type=
"long" default=
"wxTAB_TRAVERSAL|wxNO_BORDER"/>
12490 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
12493 <method name=
"InitDialog" type=
"" overloaded=
"no">
12494 <autodoc>InitDialog(self)
</autodoc>
12495 <docstring>Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
12496 to the dialog via validators.
</docstring>
12498 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
12499 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
12500 <docstring>Get the default attributes for this class. This is useful if you want
12501 to use the same font or colour in your own control as in a standard
12502 control -- which is a much better idea than hard coding specific
12503 colours or fonts which might look completely out of place on the
12504 user's system, especially if it uses themes.
12506 The variant parameter is only relevant under Mac currently and is
12507 ignore under other platforms. Under Mac, it will change the size of
12508 the returned font. See `wx.Window.SetWindowVariant` for more about
12511 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
12516 #---------------------------------------------------------------------------
12518 <class name=
"ScrolledWindow" oldname=
"wxScrolledWindow" module=
"_windows">
12519 <baseclass name=
"Panel"/>
12520 <constructor name=
"ScrolledWindow" overloaded=
"no">
12521 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
12522 Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL,
12523 String name=PanelNameStr) -
> ScrolledWindow
</autodoc>
12525 <param name=
"parent" type=
"Window" default=
""/>
12526 <param name=
"id" type=
"int" default=
"-1"/>
12527 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
12528 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
12529 <param name=
"style" type=
"long" default=
"wxHSCROLL|wxVSCROLL"/>
12530 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
12533 <constructor name=
"PreScrolledWindow" overloaded=
"no">
12534 <autodoc>PreScrolledWindow() -
> ScrolledWindow
</autodoc>
12536 <method name=
"Create" type=
"bool" overloaded=
"no">
12537 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
12538 Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL,
12539 String name=PanelNameStr) -
> bool
</autodoc>
12541 <param name=
"parent" type=
"Window" default=
""/>
12542 <param name=
"id" type=
"int" default=
"-1"/>
12543 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
12544 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
12545 <param name=
"style" type=
"long" default=
"wxHSCROLL|wxVSCROLL"/>
12546 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
12549 <method name=
"SetScrollbars" type=
"" overloaded=
"no">
12550 <autodoc>SetScrollbars(self, int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX,
12551 int noUnitsY, int xPos=
0, int yPos=
0, bool noRefresh=False)
</autodoc>
12553 <param name=
"pixelsPerUnitX" type=
"int" default=
""/>
12554 <param name=
"pixelsPerUnitY" type=
"int" default=
""/>
12555 <param name=
"noUnitsX" type=
"int" default=
""/>
12556 <param name=
"noUnitsY" type=
"int" default=
""/>
12557 <param name=
"xPos" type=
"int" default=
"0"/>
12558 <param name=
"yPos" type=
"int" default=
"0"/>
12559 <param name=
"noRefresh" type=
"bool" default=
"False"/>
12562 <method name=
"Scroll" type=
"" overloaded=
"no">
12563 <autodoc>Scroll(self, int x, int y)
</autodoc>
12565 <param name=
"x" type=
"int" default=
""/>
12566 <param name=
"y" type=
"int" default=
""/>
12569 <method name=
"GetScrollPageSize" type=
"int" overloaded=
"no">
12570 <autodoc>GetScrollPageSize(self, int orient) -
> int
</autodoc>
12572 <param name=
"orient" type=
"int" default=
""/>
12575 <method name=
"SetScrollPageSize" type=
"" overloaded=
"no">
12576 <autodoc>SetScrollPageSize(self, int orient, int pageSize)
</autodoc>
12578 <param name=
"orient" type=
"int" default=
""/>
12579 <param name=
"pageSize" type=
"int" default=
""/>
12582 <method name=
"SetScrollRate" type=
"" overloaded=
"no">
12583 <autodoc>SetScrollRate(self, int xstep, int ystep)
</autodoc>
12585 <param name=
"xstep" type=
"int" default=
""/>
12586 <param name=
"ystep" type=
"int" default=
""/>
12589 <method name=
"GetScrollPixelsPerUnit" type=
"" overloaded=
"no">
12590 <autodoc>GetScrollPixelsPerUnit() -
> (xUnit, yUnit)
</autodoc>
12591 <docstring>Get the size of one logical unit in physical units.
</docstring>
12593 <param name=
"OUTPUT" type=
"int" default=
""/>
12594 <param name=
"OUTPUT" type=
"int" default=
""/>
12597 <method name=
"EnableScrolling" type=
"" overloaded=
"no">
12598 <autodoc>EnableScrolling(self, bool x_scrolling, bool y_scrolling)
</autodoc>
12600 <param name=
"x_scrolling" type=
"bool" default=
""/>
12601 <param name=
"y_scrolling" type=
"bool" default=
""/>
12604 <method name=
"GetViewStart" type=
"" overloaded=
"no">
12605 <autodoc>GetViewStart() -
> (x,y)
</autodoc>
12606 <docstring>Get the view start
</docstring>
12608 <param name=
"OUTPUT" type=
"int" default=
""/>
12609 <param name=
"OUTPUT" type=
"int" default=
""/>
12612 <method name=
"SetScale" type=
"" overloaded=
"no">
12613 <autodoc>SetScale(self, double xs, double ys)
</autodoc>
12615 <param name=
"xs" type=
"double" default=
""/>
12616 <param name=
"ys" type=
"double" default=
""/>
12619 <method name=
"GetScaleX" type=
"double" overloaded=
"no">
12620 <autodoc>GetScaleX(self) -
> double
</autodoc>
12622 <method name=
"GetScaleY" type=
"double" overloaded=
"no">
12623 <autodoc>GetScaleY(self) -
> double
</autodoc>
12625 <method name=
"CalcScrolledPosition" type=
"Point" overloaded=
"yes">
12626 <docstring>Translate between scrolled and unscrolled coordinates.
</docstring>
12628 <param name=
"pt" type=
"Point" default=
""/>
12631 <method name=
"CalcScrolledPosition" type=
"" overloaded=
"yes">
12632 <autodoc>CalcScrolledPosition(self, Point pt) -
> Point
12633 CalcScrolledPosition(int x, int y) -
> (sx, sy)
</autodoc>
12634 <docstring>Translate between scrolled and unscrolled coordinates.
</docstring>
12636 <param name=
"x" type=
"int" default=
""/>
12637 <param name=
"y" type=
"int" default=
""/>
12638 <param name=
"OUTPUT" type=
"int" default=
""/>
12639 <param name=
"OUTPUT" type=
"int" default=
""/>
12642 <method name=
"CalcUnscrolledPosition" type=
"Point" overloaded=
"yes">
12643 <docstring>Translate between scrolled and unscrolled coordinates.
</docstring>
12645 <param name=
"pt" type=
"Point" default=
""/>
12648 <method name=
"CalcUnscrolledPosition" type=
"" overloaded=
"yes">
12649 <autodoc>CalcUnscrolledPosition(self, Point pt) -
> Point
12650 CalcUnscrolledPosition(int x, int y) -
> (ux, uy)
</autodoc>
12651 <docstring>Translate between scrolled and unscrolled coordinates.
</docstring>
12653 <param name=
"x" type=
"int" default=
""/>
12654 <param name=
"y" type=
"int" default=
""/>
12655 <param name=
"OUTPUT" type=
"int" default=
""/>
12656 <param name=
"OUTPUT" type=
"int" default=
""/>
12659 <method name=
"AdjustScrollbars" type=
"" overloaded=
"no">
12660 <autodoc>AdjustScrollbars(self)
</autodoc>
12662 <method name=
"CalcScrollInc" type=
"int" overloaded=
"no">
12663 <autodoc>CalcScrollInc(self, ScrollWinEvent event) -
> int
</autodoc>
12665 <param name=
"event" type=
"ScrollWinEvent" default=
""/>
12668 <method name=
"SetTargetWindow" type=
"" overloaded=
"no">
12669 <autodoc>SetTargetWindow(self, Window target)
</autodoc>
12671 <param name=
"target" type=
"Window" default=
""/>
12674 <method name=
"GetTargetWindow" type=
"Window" overloaded=
"no">
12675 <autodoc>GetTargetWindow(self) -
> Window
</autodoc>
12677 <method name=
"DoPrepareDC" type=
"" overloaded=
"no">
12678 <autodoc>DoPrepareDC(self, DC dc)
</autodoc>
12679 <docstring>Normally what is called by `PrepareDC`.
</docstring>
12681 <param name=
"dc" type=
"DC" default=
""/>
12684 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
12685 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
12686 <docstring>Get the default attributes for this class. This is useful if you want
12687 to use the same font or colour in your own control as in a standard
12688 control -- which is a much better idea than hard coding specific
12689 colours or fonts which might look completely out of place on the
12690 user's system, especially if it uses themes.
12692 The variant parameter is only relevant under Mac currently and is
12693 ignore under other platforms. Under Mac, it will change the size of
12694 the returned font. See `wx.Window.SetWindowVariant` for more about
12697 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
12702 #---------------------------------------------------------------------------
12704 <class name=
"TopLevelWindow" oldname=
"wxTopLevelWindow" module=
"_windows">
12705 <baseclass name=
"Window"/>
12706 <method name=
"Maximize" type=
"" overloaded=
"no">
12707 <autodoc>Maximize(self, bool maximize=True)
</autodoc>
12709 <param name=
"maximize" type=
"bool" default=
"True"/>
12712 <method name=
"Restore" type=
"" overloaded=
"no">
12713 <autodoc>Restore(self)
</autodoc>
12715 <method name=
"Iconize" type=
"" overloaded=
"no">
12716 <autodoc>Iconize(self, bool iconize=True)
</autodoc>
12718 <param name=
"iconize" type=
"bool" default=
"True"/>
12721 <method name=
"IsMaximized" type=
"bool" overloaded=
"no">
12722 <autodoc>IsMaximized(self) -
> bool
</autodoc>
12724 <method name=
"IsIconized" type=
"bool" overloaded=
"no">
12725 <autodoc>IsIconized(self) -
> bool
</autodoc>
12727 <method name=
"GetIcon" type=
"Icon" overloaded=
"no">
12728 <autodoc>GetIcon(self) -
> Icon
</autodoc>
12730 <method name=
"SetIcon" type=
"" overloaded=
"no">
12731 <autodoc>SetIcon(self, Icon icon)
</autodoc>
12733 <param name=
"icon" type=
"Icon" default=
""/>
12736 <method name=
"SetIcons" type=
"" overloaded=
"no">
12737 <autodoc>SetIcons(self, wxIconBundle icons)
</autodoc>
12739 <param name=
"icons" type=
"IconBundle" default=
""/>
12742 <method name=
"ShowFullScreen" type=
"bool" overloaded=
"no">
12743 <autodoc>ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -
> bool
</autodoc>
12745 <param name=
"show" type=
"bool" default=
""/>
12746 <param name=
"style" type=
"long" default=
"wxFULLSCREEN_ALL"/>
12749 <method name=
"IsFullScreen" type=
"bool" overloaded=
"no">
12750 <autodoc>IsFullScreen(self) -
> bool
</autodoc>
12752 <method name=
"SetTitle" type=
"" overloaded=
"no">
12753 <autodoc>SetTitle(self, String title)
</autodoc>
12754 <docstring>Sets the window's title. Applicable only to frames and dialogs.
</docstring>
12756 <param name=
"title" type=
"String" default=
""/>
12759 <method name=
"GetTitle" type=
"String" overloaded=
"no">
12760 <autodoc>GetTitle(self) -
> String
</autodoc>
12761 <docstring>Gets the window's title. Applicable only to frames and dialogs.
</docstring>
12763 <method name=
"SetShape" type=
"bool" overloaded=
"no">
12764 <autodoc>SetShape(self, Region region) -
> bool
</autodoc>
12766 <param name=
"region" type=
"Region" default=
""/>
12771 #---------------------------------------------------------------------------
12773 <class name=
"Frame" oldname=
"wxFrame" module=
"_windows">
12774 <baseclass name=
"TopLevelWindow"/>
12775 <constructor name=
"Frame" overloaded=
"no">
12776 <autodoc>__init__(self, Window parent, int id=-
1, String title=EmptyString,
12777 Point pos=DefaultPosition, Size size=DefaultSize,
12778 long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -
> Frame
</autodoc>
12780 <param name=
"parent" type=
"Window" default=
""/>
12781 <param name=
"id" type=
"int" default=
"-1"/>
12782 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
12783 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
12784 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
12785 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE"/>
12786 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
12789 <constructor name=
"PreFrame" overloaded=
"no">
12790 <autodoc>PreFrame() -
> Frame
</autodoc>
12792 <method name=
"Create" type=
"bool" overloaded=
"no">
12793 <autodoc>Create(self, Window parent, int id=-
1, String title=EmptyString,
12794 Point pos=DefaultPosition, Size size=DefaultSize,
12795 long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -
> bool
</autodoc>
12797 <param name=
"parent" type=
"Window" default=
""/>
12798 <param name=
"id" type=
"int" default=
"-1"/>
12799 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
12800 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
12801 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
12802 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE"/>
12803 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
12806 <method name=
"GetClientAreaOrigin" type=
"Point" overloaded=
"no">
12807 <autodoc>GetClientAreaOrigin(self) -
> Point
</autodoc>
12808 <docstring>Get the origin of the client area of the window relative to the
12809 window's top left corner (the client area may be shifted because of
12810 the borders, scrollbars, other decorations...)
</docstring>
12812 <method name=
"SendSizeEvent" type=
"" overloaded=
"no">
12813 <autodoc>SendSizeEvent(self)
</autodoc>
12815 <method name=
"SetMenuBar" type=
"" overloaded=
"no">
12816 <autodoc>SetMenuBar(self, MenuBar menubar)
</autodoc>
12818 <param name=
"menubar" type=
"MenuBar" default=
""/>
12821 <method name=
"GetMenuBar" type=
"MenuBar" overloaded=
"no">
12822 <autodoc>GetMenuBar(self) -
> MenuBar
</autodoc>
12824 <method name=
"ProcessCommand" type=
"bool" overloaded=
"no">
12825 <autodoc>ProcessCommand(self, int winid) -
> bool
</autodoc>
12827 <param name=
"winid" type=
"int" default=
""/>
12830 <method name=
"CreateStatusBar" type=
"wxStatusBar" overloaded=
"no">
12831 <autodoc>CreateStatusBar(self, int number=
1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
12832 int winid=
0, String name=StatusLineNameStr) -
> StatusBar
</autodoc>
12834 <param name=
"number" type=
"int" default=
"1"/>
12835 <param name=
"style" type=
"long" default=
"wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE"/>
12836 <param name=
"winid" type=
"int" default=
"0"/>
12837 <param name=
"name" type=
"String" default=
"wxPyStatusLineNameStr"/>
12840 <method name=
"GetStatusBar" type=
"wxStatusBar" overloaded=
"no">
12841 <autodoc>GetStatusBar(self) -
> StatusBar
</autodoc>
12843 <method name=
"SetStatusBar" type=
"" overloaded=
"no">
12844 <autodoc>SetStatusBar(self, StatusBar statBar)
</autodoc>
12846 <param name=
"statBar" type=
"wxStatusBar" default=
""/>
12849 <method name=
"SetStatusText" type=
"" overloaded=
"no">
12850 <autodoc>SetStatusText(self, String text, int number=
0)
</autodoc>
12852 <param name=
"text" type=
"String" default=
""/>
12853 <param name=
"number" type=
"int" default=
"0"/>
12856 <method name=
"SetStatusWidths" type=
"" overloaded=
"no">
12857 <autodoc>SetStatusWidths(self, int widths, int widths_field)
</autodoc>
12859 <param name=
"widths" type=
"int" default=
""/>
12860 <param name=
"widths_field" type=
"int" default=
""/>
12863 <method name=
"PushStatusText" type=
"" overloaded=
"no">
12864 <autodoc>PushStatusText(self, String text, int number=
0)
</autodoc>
12866 <param name=
"text" type=
"String" default=
""/>
12867 <param name=
"number" type=
"int" default=
"0"/>
12870 <method name=
"PopStatusText" type=
"" overloaded=
"no">
12871 <autodoc>PopStatusText(self, int number=
0)
</autodoc>
12873 <param name=
"number" type=
"int" default=
"0"/>
12876 <method name=
"SetStatusBarPane" type=
"" overloaded=
"no">
12877 <autodoc>SetStatusBarPane(self, int n)
</autodoc>
12879 <param name=
"n" type=
"int" default=
""/>
12882 <method name=
"GetStatusBarPane" type=
"int" overloaded=
"no">
12883 <autodoc>GetStatusBarPane(self) -
> int
</autodoc>
12885 <method name=
"CreateToolBar" type=
"wxToolBar" overloaded=
"no">
12886 <autodoc>CreateToolBar(self, long style=-
1, int winid=-
1, String name=ToolBarNameStr) -
> wxToolBar
</autodoc>
12888 <param name=
"style" type=
"long" default=
"-1"/>
12889 <param name=
"winid" type=
"int" default=
"-1"/>
12890 <param name=
"name" type=
"String" default=
"wxPyToolBarNameStr"/>
12893 <method name=
"GetToolBar" type=
"wxToolBar" overloaded=
"no">
12894 <autodoc>GetToolBar(self) -
> wxToolBar
</autodoc>
12896 <method name=
"SetToolBar" type=
"" overloaded=
"no">
12897 <autodoc>SetToolBar(self, wxToolBar toolbar)
</autodoc>
12899 <param name=
"toolbar" type=
"wxToolBar" default=
""/>
12902 <method name=
"DoGiveHelp" type=
"" overloaded=
"no">
12903 <autodoc>DoGiveHelp(self, String text, bool show)
</autodoc>
12905 <param name=
"text" type=
"String" default=
""/>
12906 <param name=
"show" type=
"bool" default=
""/>
12909 <method name=
"DoMenuUpdates" type=
"" overloaded=
"no">
12910 <autodoc>DoMenuUpdates(self, Menu menu=None)
</autodoc>
12912 <param name=
"menu" type=
"Menu" default=
"NULL"/>
12915 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
12916 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
12917 <docstring>Get the default attributes for this class. This is useful if you want
12918 to use the same font or colour in your own control as in a standard
12919 control -- which is a much better idea than hard coding specific
12920 colours or fonts which might look completely out of place on the
12921 user's system, especially if it uses themes.
12923 The variant parameter is only relevant under Mac currently and is
12924 ignore under other platforms. Under Mac, it will change the size of
12925 the returned font. See `wx.Window.SetWindowVariant` for more about
12928 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
12933 #---------------------------------------------------------------------------
12935 <class name=
"Dialog" oldname=
"wxDialog" module=
"_windows">
12936 <baseclass name=
"TopLevelWindow"/>
12937 <constructor name=
"Dialog" overloaded=
"no">
12938 <autodoc>__init__(self, Window parent, int id=-
1, String title=EmptyString,
12939 Point pos=DefaultPosition, Size size=DefaultSize,
12940 long style=DEFAULT_DIALOG_STYLE, String name=DialogNameStr) -
> Dialog
</autodoc>
12942 <param name=
"parent" type=
"Window" default=
""/>
12943 <param name=
"id" type=
"int" default=
"-1"/>
12944 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
12945 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
12946 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
12947 <param name=
"style" type=
"long" default=
"wxDEFAULT_DIALOG_STYLE"/>
12948 <param name=
"name" type=
"String" default=
"wxPyDialogNameStr"/>
12951 <constructor name=
"PreDialog" overloaded=
"no">
12952 <autodoc>PreDialog() -
> Dialog
</autodoc>
12954 <method name=
"Create" type=
"bool" overloaded=
"no">
12955 <autodoc>Create(self, Window parent, int id=-
1, String title=EmptyString,
12956 Point pos=DefaultPosition, Size size=DefaultSize,
12957 long style=DEFAULT_DIALOG_STYLE, String name=DialogNameStr) -
> bool
</autodoc>
12959 <param name=
"parent" type=
"Window" default=
""/>
12960 <param name=
"id" type=
"int" default=
"-1"/>
12961 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
12962 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
12963 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
12964 <param name=
"style" type=
"long" default=
"wxDEFAULT_DIALOG_STYLE"/>
12965 <param name=
"name" type=
"String" default=
"wxPyDialogNameStr"/>
12968 <method name=
"SetReturnCode" type=
"" overloaded=
"no">
12969 <autodoc>SetReturnCode(self, int returnCode)
</autodoc>
12971 <param name=
"returnCode" type=
"int" default=
""/>
12974 <method name=
"GetReturnCode" type=
"int" overloaded=
"no">
12975 <autodoc>GetReturnCode(self) -
> int
</autodoc>
12977 <method name=
"CreateTextSizer" type=
"Sizer" overloaded=
"no">
12978 <autodoc>CreateTextSizer(self, String message) -
> Sizer
</autodoc>
12980 <param name=
"message" type=
"String" default=
""/>
12983 <method name=
"CreateButtonSizer" type=
"Sizer" overloaded=
"no">
12984 <autodoc>CreateButtonSizer(self, long flags) -
> Sizer
</autodoc>
12986 <param name=
"flags" type=
"long" default=
""/>
12989 <method name=
"IsModal" type=
"bool" overloaded=
"no">
12990 <autodoc>IsModal(self) -
> bool
</autodoc>
12992 <method name=
"ShowModal" type=
"int" overloaded=
"no">
12993 <autodoc>ShowModal(self) -
> int
</autodoc>
12995 <method name=
"EndModal" type=
"" overloaded=
"no">
12996 <autodoc>EndModal(self, int retCode)
</autodoc>
12998 <param name=
"retCode" type=
"int" default=
""/>
13001 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
13002 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
13003 <docstring>Get the default attributes for this class. This is useful if you want
13004 to use the same font or colour in your own control as in a standard
13005 control -- which is a much better idea than hard coding specific
13006 colours or fonts which might look completely out of place on the
13007 user's system, especially if it uses themes.
13009 The variant parameter is only relevant under Mac currently and is
13010 ignore under other platforms. Under Mac, it will change the size of
13011 the returned font. See `wx.Window.SetWindowVariant` for more about
13014 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
13019 #---------------------------------------------------------------------------
13021 <class name=
"MiniFrame" oldname=
"wxMiniFrame" module=
"_windows">
13022 <baseclass name=
"Frame"/>
13023 <constructor name=
"MiniFrame" overloaded=
"no">
13024 <autodoc>__init__(self, Window parent, int id=-
1, String title=EmptyString,
13025 Point pos=DefaultPosition, Size size=DefaultSize,
13026 long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -
> MiniFrame
</autodoc>
13028 <param name=
"parent" type=
"Window" default=
""/>
13029 <param name=
"id" type=
"int" default=
"-1"/>
13030 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
13031 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13032 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13033 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE"/>
13034 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
13037 <constructor name=
"PreMiniFrame" overloaded=
"no">
13038 <autodoc>PreMiniFrame() -
> MiniFrame
</autodoc>
13040 <method name=
"Create" type=
"bool" overloaded=
"no">
13041 <autodoc>Create(self, Window parent, int id=-
1, String title=EmptyString,
13042 Point pos=DefaultPosition, Size size=DefaultSize,
13043 long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -
> bool
</autodoc>
13045 <param name=
"parent" type=
"Window" default=
""/>
13046 <param name=
"id" type=
"int" default=
"-1"/>
13047 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
13048 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13049 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13050 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE"/>
13051 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
13056 #---------------------------------------------------------------------------
13058 <class name=
"SplashScreenWindow" oldname=
"wxSplashScreenWindow" module=
"_windows">
13059 <baseclass name=
"Window"/>
13060 <constructor name=
"SplashScreenWindow" overloaded=
"no">
13061 <autodoc>__init__(self, Bitmap bitmap, Window parent, int id, Point pos=DefaultPosition,
13062 Size size=DefaultSize, long style=NO_BORDER) -
> SplashScreenWindow
</autodoc>
13064 <param name=
"bitmap" type=
"Bitmap" default=
""/>
13065 <param name=
"parent" type=
"Window" default=
""/>
13066 <param name=
"id" type=
"int" default=
""/>
13067 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13068 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13069 <param name=
"style" type=
"long" default=
"wxNO_BORDER"/>
13072 <method name=
"SetBitmap" type=
"" overloaded=
"no">
13073 <autodoc>SetBitmap(self, Bitmap bitmap)
</autodoc>
13075 <param name=
"bitmap" type=
"Bitmap" default=
""/>
13078 <method name=
"GetBitmap" type=
"Bitmap" overloaded=
"no">
13079 <autodoc>GetBitmap(self) -
> Bitmap
</autodoc>
13082 <class name=
"SplashScreen" oldname=
"wxSplashScreen" module=
"_windows">
13083 <baseclass name=
"Frame"/>
13084 <constructor name=
"SplashScreen" overloaded=
"no">
13085 <autodoc>__init__(self, Bitmap bitmap, long splashStyle, int milliseconds,
13086 Window parent, int id=-
1, Point pos=DefaultPosition,
13087 Size size=DefaultSize, long style=wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP) -
> SplashScreen
</autodoc>
13089 <param name=
"bitmap" type=
"Bitmap" default=
""/>
13090 <param name=
"splashStyle" type=
"long" default=
""/>
13091 <param name=
"milliseconds" type=
"int" default=
""/>
13092 <param name=
"parent" type=
"Window" default=
""/>
13093 <param name=
"id" type=
"int" default=
"-1"/>
13094 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13095 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13096 <param name=
"style" type=
"long" default=
"wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP"/>
13099 <method name=
"GetSplashStyle" type=
"long" overloaded=
"no">
13100 <autodoc>GetSplashStyle(self) -
> long
</autodoc>
13102 <method name=
"GetSplashWindow" type=
"SplashScreenWindow" overloaded=
"no">
13103 <autodoc>GetSplashWindow(self) -
> SplashScreenWindow
</autodoc>
13105 <method name=
"GetTimeout" type=
"int" overloaded=
"no">
13106 <autodoc>GetTimeout(self) -
> int
</autodoc>
13110 #---------------------------------------------------------------------------
13112 <class name=
"StatusBar" oldname=
"wxStatusBar" module=
"_windows">
13113 <baseclass name=
"Window"/>
13114 <constructor name=
"StatusBar" overloaded=
"no">
13115 <autodoc>__init__(self, Window parent, int id=-
1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
13116 String name=StatusLineNameStr) -
> StatusBar
</autodoc>
13118 <param name=
"parent" type=
"Window" default=
""/>
13119 <param name=
"id" type=
"int" default=
"-1"/>
13120 <param name=
"style" type=
"long" default=
"wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE"/>
13121 <param name=
"name" type=
"String" default=
"wxPyStatusLineNameStr"/>
13124 <constructor name=
"PreStatusBar" overloaded=
"no">
13125 <autodoc>PreStatusBar() -
> StatusBar
</autodoc>
13127 <method name=
"Create" type=
"bool" overloaded=
"no">
13128 <autodoc>Create(self, Window parent, int id=-
1, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -
> bool
</autodoc>
13130 <param name=
"parent" type=
"Window" default=
""/>
13131 <param name=
"id" type=
"int" default=
"-1"/>
13132 <param name=
"style" type=
"long" default=
"wxST_SIZEGRIP"/>
13133 <param name=
"name" type=
"String" default=
"wxPyStatusLineNameStr"/>
13136 <method name=
"SetFieldsCount" type=
"" overloaded=
"no">
13137 <autodoc>SetFieldsCount(self, int number=
1)
</autodoc>
13139 <param name=
"number" type=
"int" default=
"1"/>
13142 <method name=
"GetFieldsCount" type=
"int" overloaded=
"no">
13143 <autodoc>GetFieldsCount(self) -
> int
</autodoc>
13145 <method name=
"SetStatusText" type=
"" overloaded=
"no">
13146 <autodoc>SetStatusText(self, String text, int number=
0)
</autodoc>
13148 <param name=
"text" type=
"String" default=
""/>
13149 <param name=
"number" type=
"int" default=
"0"/>
13152 <method name=
"GetStatusText" type=
"String" overloaded=
"no">
13153 <autodoc>GetStatusText(self, int number=
0) -
> String
</autodoc>
13155 <param name=
"number" type=
"int" default=
"0"/>
13158 <method name=
"PushStatusText" type=
"" overloaded=
"no">
13159 <autodoc>PushStatusText(self, String text, int number=
0)
</autodoc>
13161 <param name=
"text" type=
"String" default=
""/>
13162 <param name=
"number" type=
"int" default=
"0"/>
13165 <method name=
"PopStatusText" type=
"" overloaded=
"no">
13166 <autodoc>PopStatusText(self, int number=
0)
</autodoc>
13168 <param name=
"number" type=
"int" default=
"0"/>
13171 <method name=
"SetStatusWidths" type=
"" overloaded=
"no">
13172 <autodoc>SetStatusWidths(self, int widths, int widths_field)
</autodoc>
13174 <param name=
"widths" type=
"int" default=
""/>
13175 <param name=
"widths_field" type=
"int" default=
""/>
13178 <method name=
"SetStatusStyles" type=
"" overloaded=
"no">
13179 <autodoc>SetStatusStyles(self, int styles, int styles_field)
</autodoc>
13181 <param name=
"styles" type=
"int" default=
""/>
13182 <param name=
"styles_field" type=
"int" default=
""/>
13185 <method name=
"GetFieldRect" type=
"Rect" overloaded=
"no">
13186 <autodoc>GetFieldRect(self, int i) -
> Rect
</autodoc>
13188 <param name=
"i" type=
"int" default=
""/>
13191 <method name=
"SetMinHeight" type=
"" overloaded=
"no">
13192 <autodoc>SetMinHeight(self, int height)
</autodoc>
13194 <param name=
"height" type=
"int" default=
""/>
13197 <method name=
"GetBorderX" type=
"int" overloaded=
"no">
13198 <autodoc>GetBorderX(self) -
> int
</autodoc>
13200 <method name=
"GetBorderY" type=
"int" overloaded=
"no">
13201 <autodoc>GetBorderY(self) -
> int
</autodoc>
13203 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
13204 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
13205 <docstring>Get the default attributes for this class. This is useful if you want
13206 to use the same font or colour in your own control as in a standard
13207 control -- which is a much better idea than hard coding specific
13208 colours or fonts which might look completely out of place on the
13209 user's system, especially if it uses themes.
13211 The variant parameter is only relevant under Mac currently and is
13212 ignore under other platforms. Under Mac, it will change the size of
13213 the returned font. See `wx.Window.SetWindowVariant` for more about
13216 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
13221 #---------------------------------------------------------------------------
13223 <class name=
"SplitterWindow" oldname=
"wxSplitterWindow" module=
"_windows">
13224 <docstring>wx.SplitterWindow manages up to two subwindows or panes, with an
13225 optional vertical or horizontal split which can be used with the mouse
13226 or programmatically.
13230 ==================== ======================================
13231 wx.SP_3D Draws a
3D effect border and sash.
13232 wx.SP_3DSASH Draws a
3D effect sash.
13233 wx.SP_3DBORDER Synonym for wxSP_BORDER.
13234 wx.SP_BORDER Draws a standard border.
13235 wx.SP_NOBORDER No border (default).
13236 wx.SP_NO_XP_THEME Under Windows XP, switches off the
13237 attempt to draw the splitter
13238 using Windows XP theming, so the
13239 borders and sash will take on the
13241 wx.SP_PERMIT_UNSPLIT Always allow to unsplit, even with
13242 the minimum pane size other than zero.
13243 wx.SP_LIVE_UPDATE Don't draw XOR line but resize the
13244 child windows immediately.
13245 ==================== ======================================
13249 ============================== =======================================
13250 EVT_SPLITTER_SASH_POS_CHANGING The sash position is in the
13251 process of being changed. May be
13252 used to modify the position of
13253 the tracking bar to properly
13254 reflect the position that would
13255 be set if the drag were to be
13256 completed at this point.
13258 EVT_SPLITTER_SASH_POS_CHANGED
13259 The sash position was
13260 changed. May be used to modify
13261 the sash position before it is
13262 set, or to prevent the change
13265 EVT_SPLITTER_UNSPLIT The splitter has been just unsplit.
13267 EVT_SPLITTER_DCLICK The sash was double clicked. The
13268 default behaviour is to unsplit
13269 the window when this happens
13270 (unless the minimum pane size has
13271 been set to a value greater than
13273 ============================== =======================================
13276 <baseclass name=
"Window"/>
13277 <constructor name=
"SplitterWindow" overloaded=
"no">
13278 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
13279 Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -
> SplitterWindow
</autodoc>
13280 <docstring>Constructor. Creates and shows a SplitterWindow.
</docstring>
13282 <param name=
"parent" type=
"Window" default=
""/>
13283 <param name=
"id" type=
"int" default=
"-1"/>
13284 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13285 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13286 <param name=
"style" type=
"long" default=
"wxSP_3D"/>
13287 <param name=
"name" type=
"String" default=
"wxPySplitterNameStr"/>
13290 <constructor name=
"PreSplitterWindow" overloaded=
"no">
13291 <autodoc>PreSplitterWindow() -
> SplitterWindow
</autodoc>
13292 <docstring>Precreate a SplitterWindow for
2-phase creation.
</docstring>
13294 <method name=
"Create" type=
"bool" overloaded=
"no">
13295 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
13296 Size size=DefaultSize, long style=SP_3D, String name=SplitterNameStr) -
> bool
</autodoc>
13297 <docstring>Create the GUI part of the SplitterWindow for the
2-phase create.
</docstring>
13299 <param name=
"parent" type=
"Window" default=
""/>
13300 <param name=
"id" type=
"int" default=
"-1"/>
13301 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13302 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13303 <param name=
"style" type=
"long" default=
"wxSP_3D"/>
13304 <param name=
"name" type=
"String" default=
"wxPySplitterNameStr"/>
13307 <method name=
"GetWindow1" type=
"Window" overloaded=
"no">
13308 <autodoc>GetWindow1(self) -
> Window
</autodoc>
13309 <docstring>Gets the only or left/top pane.
</docstring>
13311 <method name=
"GetWindow2" type=
"Window" overloaded=
"no">
13312 <autodoc>GetWindow2(self) -
> Window
</autodoc>
13313 <docstring>Gets the right/bottom pane.
</docstring>
13315 <method name=
"SetSplitMode" type=
"" overloaded=
"no">
13316 <autodoc>SetSplitMode(self, int mode)
</autodoc>
13317 <docstring>Sets the split mode. The mode can be wx.SPLIT_VERTICAL or
13318 wx.SPLIT_HORIZONTAL. This only sets the internal variable; does not
13319 update the display.
</docstring>
13321 <param name=
"mode" type=
"int" default=
""/>
13324 <method name=
"GetSplitMode" type=
"wxSplitMode" overloaded=
"no">
13325 <autodoc>GetSplitMode(self) -
> int
</autodoc>
13326 <docstring>Gets the split mode
</docstring>
13328 <method name=
"Initialize" type=
"" overloaded=
"no">
13329 <autodoc>Initialize(self, Window window)
</autodoc>
13330 <docstring>Initializes the splitter window to have one pane. This should be
13331 called if you wish to initially view only a single pane in the
13332 splitter window.
</docstring>
13334 <param name=
"window" type=
"Window" default=
""/>
13337 <method name=
"SplitVertically" type=
"bool" overloaded=
"no">
13338 <autodoc>SplitVertically(self, Window window1, Window window2, int sashPosition=
0) -
> bool
</autodoc>
13339 <docstring>Initializes the left and right panes of the splitter window.
13340 :param window1: The left pane.
13341 :param window2: The right pane.
13342 :param sashPosition: The initial position of the sash. If this
13343 value is positive, it specifies the size of the left
13344 pane. If it is negative, it is absolute value gives
13345 the size of the right pane. Finally, specify
0
13346 (default) to choose the default position (half of
13347 the total window width).
13349 Returns True if successful, False otherwise (the window was already
13352 SplitVertically should be called if you wish to initially view two
13353 panes. It can also be called at any subsequent time, but the
13354 application should check that the window is not currently split using
13358 <param name=
"window1" type=
"Window" default=
""/>
13359 <param name=
"window2" type=
"Window" default=
""/>
13360 <param name=
"sashPosition" type=
"int" default=
"0"/>
13363 <method name=
"SplitHorizontally" type=
"bool" overloaded=
"no">
13364 <autodoc>SplitHorizontally(self, Window window1, Window window2, int sashPosition=
0) -
> bool
</autodoc>
13365 <docstring>Initializes the top and bottom panes of the splitter window.
13366 :param window1: The top pane.
13367 :param window2: The bottom pane.
13368 :param sashPosition: The initial position of the sash. If this
13369 value is positive, it specifies the size of the
13370 upper pane. If it is negative, it is absolute value
13371 gives the size of the lower pane. Finally, specify
0
13372 (default) to choose the default position (half of
13373 the total window height).
13375 Returns True if successful, False otherwise (the window was already
13378 SplitHorizontally should be called if you wish to initially view two
13379 panes. It can also be called at any subsequent time, but the
13380 application should check that the window is not currently split using
13384 <param name=
"window1" type=
"Window" default=
""/>
13385 <param name=
"window2" type=
"Window" default=
""/>
13386 <param name=
"sashPosition" type=
"int" default=
"0"/>
13389 <method name=
"Unsplit" type=
"bool" overloaded=
"no">
13390 <autodoc>Unsplit(self, Window toRemove=None) -
> bool
</autodoc>
13391 <docstring>Unsplits the window. Pass the pane to remove, or None to remove the
13392 right or bottom pane. Returns True if successful, False otherwise (the
13393 window was not split).
13395 This function will not actually delete the pane being
13396 removed; it sends EVT_SPLITTER_UNSPLIT which can be handled
13397 for the desired behaviour. By default, the pane being
13398 removed is only hidden.
</docstring>
13400 <param name=
"toRemove" type=
"Window" default=
"NULL"/>
13403 <method name=
"ReplaceWindow" type=
"bool" overloaded=
"no">
13404 <autodoc>ReplaceWindow(self, Window winOld, Window winNew) -
> bool
</autodoc>
13405 <docstring>This function replaces one of the windows managed by the
13406 SplitterWindow with another one. It is in general better to use it
13407 instead of calling Unsplit() and then resplitting the window back
13408 because it will provoke much less flicker. It is valid to call this
13409 function whether the splitter has two windows or only one.
13411 Both parameters should be non-None and winOld must specify one of the
13412 windows managed by the splitter. If the parameters are incorrect or
13413 the window couldn't be replaced, False is returned. Otherwise the
13414 function will return True, but please notice that it will not Destroy
13415 the replaced window and you may wish to do it yourself.
</docstring>
13417 <param name=
"winOld" type=
"Window" default=
""/>
13418 <param name=
"winNew" type=
"Window" default=
""/>
13421 <method name=
"UpdateSize" type=
"" overloaded=
"no">
13422 <autodoc>UpdateSize(self)
</autodoc>
13423 <docstring>Causes any pending sizing of the sash and child panes to take place
13426 Such resizing normally takes place in idle time, in order to wait for
13427 layout to be completed. However, this can cause unacceptable flicker
13428 as the panes are resized after the window has been shown. To work
13429 around this, you can perform window layout (for example by sending a
13430 size event to the parent window), and then call this function, before
13431 showing the top-level window.
</docstring>
13433 <method name=
"IsSplit" type=
"bool" overloaded=
"no">
13434 <autodoc>IsSplit(self) -
> bool
</autodoc>
13435 <docstring>Is the window split?
</docstring>
13437 <method name=
"SetSashSize" type=
"" overloaded=
"no">
13438 <autodoc>SetSashSize(self, int width)
</autodoc>
13439 <docstring>Sets the sash size
</docstring>
13441 <param name=
"width" type=
"int" default=
""/>
13444 <method name=
"SetBorderSize" type=
"" overloaded=
"no">
13445 <autodoc>SetBorderSize(self, int width)
</autodoc>
13446 <docstring>Sets the border size
</docstring>
13448 <param name=
"width" type=
"int" default=
""/>
13451 <method name=
"GetSashSize" type=
"int" overloaded=
"no">
13452 <autodoc>GetSashSize(self) -
> int
</autodoc>
13453 <docstring>Gets the sash size
</docstring>
13455 <method name=
"GetBorderSize" type=
"int" overloaded=
"no">
13456 <autodoc>GetBorderSize(self) -
> int
</autodoc>
13457 <docstring>Gets the border size
</docstring>
13459 <method name=
"SetSashPosition" type=
"" overloaded=
"no">
13460 <autodoc>SetSashPosition(self, int position, bool redraw=True)
</autodoc>
13461 <docstring>Sets the sash position, in pixels. If redraw is Ttrue then the panes
13462 are resized and the sash and border are redrawn.
</docstring>
13464 <param name=
"position" type=
"int" default=
""/>
13465 <param name=
"redraw" type=
"bool" default=
"True"/>
13468 <method name=
"GetSashPosition" type=
"int" overloaded=
"no">
13469 <autodoc>GetSashPosition(self) -
> int
</autodoc>
13470 <docstring>Returns the surrent sash position.
</docstring>
13472 <method name=
"SetMinimumPaneSize" type=
"" overloaded=
"no">
13473 <autodoc>SetMinimumPaneSize(self, int min)
</autodoc>
13474 <docstring>Sets the minimum pane size in pixels.
13476 The default minimum pane size is zero, which means that either pane
13477 can be reduced to zero by dragging the sash, thus removing one of the
13478 panes. To prevent this behaviour (and veto out-of-range sash
13479 dragging), set a minimum size, for example
20 pixels. If the
13480 wx.SP_PERMIT_UNSPLIT style is used when a splitter window is created,
13481 the window may be unsplit even if minimum size is non-zero.
</docstring>
13483 <param name=
"min" type=
"int" default=
""/>
13486 <method name=
"GetMinimumPaneSize" type=
"int" overloaded=
"no">
13487 <autodoc>GetMinimumPaneSize(self) -
> int
</autodoc>
13488 <docstring>Gets the minimum pane size in pixels.
</docstring>
13490 <method name=
"SashHitTest" type=
"bool" overloaded=
"no">
13491 <autodoc>SashHitTest(self, int x, int y, int tolerance=
5) -
> bool
</autodoc>
13492 <docstring>Tests for x, y over the sash
</docstring>
13494 <param name=
"x" type=
"int" default=
""/>
13495 <param name=
"y" type=
"int" default=
""/>
13496 <param name=
"tolerance" type=
"int" default=
"5"/>
13499 <method name=
"SizeWindows" type=
"" overloaded=
"no">
13500 <autodoc>SizeWindows(self)
</autodoc>
13501 <docstring>Resizes subwindows
</docstring>
13503 <method name=
"SetNeedUpdating" type=
"" overloaded=
"no">
13504 <autodoc>SetNeedUpdating(self, bool needUpdating)
</autodoc>
13506 <param name=
"needUpdating" type=
"bool" default=
""/>
13509 <method name=
"GetNeedUpdating" type=
"bool" overloaded=
"no">
13510 <autodoc>GetNeedUpdating(self) -
> bool
</autodoc>
13512 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
13513 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
13514 <docstring>Get the default attributes for this class. This is useful if you want
13515 to use the same font or colour in your own control as in a standard
13516 control -- which is a much better idea than hard coding specific
13517 colours or fonts which might look completely out of place on the
13518 user's system, especially if it uses themes.
13520 The variant parameter is only relevant under Mac currently and is
13521 ignore under other platforms. Under Mac, it will change the size of
13522 the returned font. See `wx.Window.SetWindowVariant` for more about
13525 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
13529 <class name=
"SplitterEvent" oldname=
"wxSplitterEvent" module=
"_windows">
13530 <docstring>This class represents the events generated by a splitter control.
</docstring>
13531 <baseclass name=
"NotifyEvent"/>
13532 <constructor name=
"SplitterEvent" overloaded=
"no">
13533 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -
> SplitterEvent
</autodoc>
13534 <docstring>This class represents the events generated by a splitter control.
</docstring>
13536 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
13537 <param name=
"splitter" type=
"SplitterWindow" default=
"(wxSplitterWindow *) NULL"/>
13540 <method name=
"SetSashPosition" type=
"" overloaded=
"no">
13541 <autodoc>SetSashPosition(self, int pos)
</autodoc>
13542 <docstring>This funciton is only meaningful during EVT_SPLITTER_SASH_POS_CHANGING
13543 and EVT_SPLITTER_SASH_POS_CHANGED events. In the case of _CHANGED
13544 events, sets the the new sash position. In the case of _CHANGING
13545 events, sets the new tracking bar position so visual feedback during
13546 dragging will represent that change that will actually take place. Set
13547 to -
1 from the event handler code to prevent repositioning.
</docstring>
13549 <param name=
"pos" type=
"int" default=
""/>
13552 <method name=
"GetSashPosition" type=
"int" overloaded=
"no">
13553 <autodoc>GetSashPosition(self) -
> int
</autodoc>
13554 <docstring>Returns the new sash position while in EVT_SPLITTER_SASH_POS_CHANGING
13555 and EVT_SPLITTER_SASH_POS_CHANGED events.
</docstring>
13557 <method name=
"GetWindowBeingRemoved" type=
"Window" overloaded=
"no">
13558 <autodoc>GetWindowBeingRemoved(self) -
> Window
</autodoc>
13559 <docstring>Returns a pointer to the window being removed when a splitter window
13560 is unsplit.
</docstring>
13562 <method name=
"GetX" type=
"int" overloaded=
"no">
13563 <autodoc>GetX(self) -
> int
</autodoc>
13564 <docstring>Returns the x coordinate of the double-click point in a
13565 EVT_SPLITTER_DCLICK event.
</docstring>
13567 <method name=
"GetY" type=
"int" overloaded=
"no">
13568 <autodoc>GetY(self) -
> int
</autodoc>
13569 <docstring>Returns the y coordinate of the double-click point in a
13570 EVT_SPLITTER_DCLICK event.
</docstring>
13574 EVT_SPLITTER_SASH_POS_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED,
1 )
13575 EVT_SPLITTER_SASH_POS_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING,
1 )
13576 EVT_SPLITTER_DOUBLECLICKED = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_DOUBLECLICKED,
1 )
13577 EVT_SPLITTER_UNSPLIT = wx.PyEventBinder( wxEVT_COMMAND_SPLITTER_UNSPLIT,
1 )
13578 EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED
13581 #---------------------------------------------------------------------------
13583 <class name=
"SashWindow" oldname=
"wxSashWindow" module=
"_windows">
13584 <baseclass name=
"Window"/>
13585 <constructor name=
"SashWindow" overloaded=
"no">
13586 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
13587 Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D,
13588 String name=SashNameStr) -
> SashWindow
</autodoc>
13590 <param name=
"parent" type=
"Window" default=
""/>
13591 <param name=
"id" type=
"int" default=
"-1"/>
13592 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13593 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13594 <param name=
"style" type=
"long" default=
"wxCLIP_CHILDREN|wxSW_3D"/>
13595 <param name=
"name" type=
"String" default=
"wxPySashNameStr"/>
13598 <constructor name=
"PreSashWindow" overloaded=
"no">
13599 <autodoc>PreSashWindow() -
> SashWindow
</autodoc>
13601 <method name=
"Create" type=
"bool" overloaded=
"no">
13602 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
13603 Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D,
13604 String name=SashNameStr) -
> bool
</autodoc>
13606 <param name=
"parent" type=
"Window" default=
""/>
13607 <param name=
"id" type=
"int" default=
"-1"/>
13608 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13609 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13610 <param name=
"style" type=
"long" default=
"wxCLIP_CHILDREN|wxSW_3D"/>
13611 <param name=
"name" type=
"String" default=
"wxPySashNameStr"/>
13614 <method name=
"SetSashVisible" type=
"" overloaded=
"no">
13615 <autodoc>SetSashVisible(self, int edge, bool sash)
</autodoc>
13617 <param name=
"edge" type=
"wxSashEdgePosition" default=
""/>
13618 <param name=
"sash" type=
"bool" default=
""/>
13621 <method name=
"GetSashVisible" type=
"bool" overloaded=
"no">
13622 <autodoc>GetSashVisible(self, int edge) -
> bool
</autodoc>
13624 <param name=
"edge" type=
"wxSashEdgePosition" default=
""/>
13627 <method name=
"SetSashBorder" type=
"" overloaded=
"no">
13628 <autodoc>SetSashBorder(self, int edge, bool border)
</autodoc>
13630 <param name=
"edge" type=
"wxSashEdgePosition" default=
""/>
13631 <param name=
"border" type=
"bool" default=
""/>
13634 <method name=
"HasBorder" type=
"bool" overloaded=
"no">
13635 <autodoc>HasBorder(self, int edge) -
> bool
</autodoc>
13637 <param name=
"edge" type=
"wxSashEdgePosition" default=
""/>
13640 <method name=
"GetEdgeMargin" type=
"int" overloaded=
"no">
13641 <autodoc>GetEdgeMargin(self, int edge) -
> int
</autodoc>
13643 <param name=
"edge" type=
"wxSashEdgePosition" default=
""/>
13646 <method name=
"SetDefaultBorderSize" type=
"" overloaded=
"no">
13647 <autodoc>SetDefaultBorderSize(self, int width)
</autodoc>
13649 <param name=
"width" type=
"int" default=
""/>
13652 <method name=
"GetDefaultBorderSize" type=
"int" overloaded=
"no">
13653 <autodoc>GetDefaultBorderSize(self) -
> int
</autodoc>
13655 <method name=
"SetExtraBorderSize" type=
"" overloaded=
"no">
13656 <autodoc>SetExtraBorderSize(self, int width)
</autodoc>
13658 <param name=
"width" type=
"int" default=
""/>
13661 <method name=
"GetExtraBorderSize" type=
"int" overloaded=
"no">
13662 <autodoc>GetExtraBorderSize(self) -
> int
</autodoc>
13664 <method name=
"SetMinimumSizeX" type=
"" overloaded=
"no">
13665 <autodoc>SetMinimumSizeX(self, int min)
</autodoc>
13667 <param name=
"min" type=
"int" default=
""/>
13670 <method name=
"SetMinimumSizeY" type=
"" overloaded=
"no">
13671 <autodoc>SetMinimumSizeY(self, int min)
</autodoc>
13673 <param name=
"min" type=
"int" default=
""/>
13676 <method name=
"GetMinimumSizeX" type=
"int" overloaded=
"no">
13677 <autodoc>GetMinimumSizeX(self) -
> int
</autodoc>
13679 <method name=
"GetMinimumSizeY" type=
"int" overloaded=
"no">
13680 <autodoc>GetMinimumSizeY(self) -
> int
</autodoc>
13682 <method name=
"SetMaximumSizeX" type=
"" overloaded=
"no">
13683 <autodoc>SetMaximumSizeX(self, int max)
</autodoc>
13685 <param name=
"max" type=
"int" default=
""/>
13688 <method name=
"SetMaximumSizeY" type=
"" overloaded=
"no">
13689 <autodoc>SetMaximumSizeY(self, int max)
</autodoc>
13691 <param name=
"max" type=
"int" default=
""/>
13694 <method name=
"GetMaximumSizeX" type=
"int" overloaded=
"no">
13695 <autodoc>GetMaximumSizeX(self) -
> int
</autodoc>
13697 <method name=
"GetMaximumSizeY" type=
"int" overloaded=
"no">
13698 <autodoc>GetMaximumSizeY(self) -
> int
</autodoc>
13700 <method name=
"SashHitTest" type=
"wxSashEdgePosition" overloaded=
"no">
13701 <autodoc>SashHitTest(self, int x, int y, int tolerance=
2) -
> int
</autodoc>
13703 <param name=
"x" type=
"int" default=
""/>
13704 <param name=
"y" type=
"int" default=
""/>
13705 <param name=
"tolerance" type=
"int" default=
"2"/>
13708 <method name=
"SizeWindows" type=
"" overloaded=
"no">
13709 <autodoc>SizeWindows(self)
</autodoc>
13712 <class name=
"SashEvent" oldname=
"wxSashEvent" module=
"_windows">
13713 <baseclass name=
"CommandEvent"/>
13714 <constructor name=
"SashEvent" overloaded=
"no">
13715 <autodoc>__init__(self, int id=
0, int edge=SASH_NONE) -
> SashEvent
</autodoc>
13717 <param name=
"id" type=
"int" default=
"0"/>
13718 <param name=
"edge" type=
"wxSashEdgePosition" default=
"wxSASH_NONE"/>
13721 <method name=
"SetEdge" type=
"" overloaded=
"no">
13722 <autodoc>SetEdge(self, int edge)
</autodoc>
13724 <param name=
"edge" type=
"wxSashEdgePosition" default=
""/>
13727 <method name=
"GetEdge" type=
"wxSashEdgePosition" overloaded=
"no">
13728 <autodoc>GetEdge(self) -
> int
</autodoc>
13730 <method name=
"SetDragRect" type=
"" overloaded=
"no">
13731 <autodoc>SetDragRect(self, Rect rect)
</autodoc>
13733 <param name=
"rect" type=
"Rect" default=
""/>
13736 <method name=
"GetDragRect" type=
"Rect" overloaded=
"no">
13737 <autodoc>GetDragRect(self) -
> Rect
</autodoc>
13739 <method name=
"SetDragStatus" type=
"" overloaded=
"no">
13740 <autodoc>SetDragStatus(self, int status)
</autodoc>
13742 <param name=
"status" type=
"wxSashDragStatus" default=
""/>
13745 <method name=
"GetDragStatus" type=
"wxSashDragStatus" overloaded=
"no">
13746 <autodoc>GetDragStatus(self) -
> int
</autodoc>
13750 EVT_SASH_DRAGGED = wx.PyEventBinder( wxEVT_SASH_DRAGGED,
1 )
13751 EVT_SASH_DRAGGED_RANGE = wx.PyEventBinder( wxEVT_SASH_DRAGGED,
2 )
13754 #---------------------------------------------------------------------------
13756 <class name=
"QueryLayoutInfoEvent" oldname=
"wxQueryLayoutInfoEvent" module=
"_windows">
13757 <baseclass name=
"Event"/>
13758 <constructor name=
"QueryLayoutInfoEvent" overloaded=
"no">
13759 <autodoc>__init__(self, int id=
0) -
> QueryLayoutInfoEvent
</autodoc>
13761 <param name=
"id" type=
"int" default=
"0"/>
13764 <method name=
"SetRequestedLength" type=
"" overloaded=
"no">
13765 <autodoc>SetRequestedLength(self, int length)
</autodoc>
13767 <param name=
"length" type=
"int" default=
""/>
13770 <method name=
"GetRequestedLength" type=
"int" overloaded=
"no">
13771 <autodoc>GetRequestedLength(self) -
> int
</autodoc>
13773 <method name=
"SetFlags" type=
"" overloaded=
"no">
13774 <autodoc>SetFlags(self, int flags)
</autodoc>
13776 <param name=
"flags" type=
"int" default=
""/>
13779 <method name=
"GetFlags" type=
"int" overloaded=
"no">
13780 <autodoc>GetFlags(self) -
> int
</autodoc>
13782 <method name=
"SetSize" type=
"" overloaded=
"no">
13783 <autodoc>SetSize(self, Size size)
</autodoc>
13785 <param name=
"size" type=
"Size" default=
""/>
13788 <method name=
"GetSize" type=
"Size" overloaded=
"no">
13789 <autodoc>GetSize(self) -
> Size
</autodoc>
13791 <method name=
"SetOrientation" type=
"" overloaded=
"no">
13792 <autodoc>SetOrientation(self, int orient)
</autodoc>
13794 <param name=
"orient" type=
"wxLayoutOrientation" default=
""/>
13797 <method name=
"GetOrientation" type=
"wxLayoutOrientation" overloaded=
"no">
13798 <autodoc>GetOrientation(self) -
> int
</autodoc>
13800 <method name=
"SetAlignment" type=
"" overloaded=
"no">
13801 <autodoc>SetAlignment(self, int align)
</autodoc>
13803 <param name=
"align" type=
"wxLayoutAlignment" default=
""/>
13806 <method name=
"GetAlignment" type=
"wxLayoutAlignment" overloaded=
"no">
13807 <autodoc>GetAlignment(self) -
> int
</autodoc>
13810 <class name=
"CalculateLayoutEvent" oldname=
"wxCalculateLayoutEvent" module=
"_windows">
13811 <baseclass name=
"Event"/>
13812 <constructor name=
"CalculateLayoutEvent" overloaded=
"no">
13813 <autodoc>__init__(self, int id=
0) -
> CalculateLayoutEvent
</autodoc>
13815 <param name=
"id" type=
"int" default=
"0"/>
13818 <method name=
"SetFlags" type=
"" overloaded=
"no">
13819 <autodoc>SetFlags(self, int flags)
</autodoc>
13821 <param name=
"flags" type=
"int" default=
""/>
13824 <method name=
"GetFlags" type=
"int" overloaded=
"no">
13825 <autodoc>GetFlags(self) -
> int
</autodoc>
13827 <method name=
"SetRect" type=
"" overloaded=
"no">
13828 <autodoc>SetRect(self, Rect rect)
</autodoc>
13830 <param name=
"rect" type=
"Rect" default=
""/>
13833 <method name=
"GetRect" type=
"Rect" overloaded=
"no">
13834 <autodoc>GetRect(self) -
> Rect
</autodoc>
13838 EVT_QUERY_LAYOUT_INFO = wx.PyEventBinder( wxEVT_QUERY_LAYOUT_INFO )
13839 EVT_CALCULATE_LAYOUT = wx.PyEventBinder( wxEVT_CALCULATE_LAYOUT )
13841 <class name=
"SashLayoutWindow" oldname=
"wxSashLayoutWindow" module=
"_windows">
13842 <baseclass name=
"SashWindow"/>
13843 <constructor name=
"SashLayoutWindow" overloaded=
"no">
13844 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
13845 Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D,
13846 String name=SashLayoutNameStr) -
> SashLayoutWindow
</autodoc>
13848 <param name=
"parent" type=
"Window" default=
""/>
13849 <param name=
"id" type=
"int" default=
"-1"/>
13850 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13851 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13852 <param name=
"style" type=
"long" default=
"wxCLIP_CHILDREN|wxSW_3D"/>
13853 <param name=
"name" type=
"String" default=
"wxPySashLayoutNameStr"/>
13856 <constructor name=
"PreSashLayoutWindow" overloaded=
"no">
13857 <autodoc>PreSashLayoutWindow() -
> SashLayoutWindow
</autodoc>
13859 <method name=
"Create" type=
"bool" overloaded=
"no">
13860 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
13861 Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D,
13862 String name=SashLayoutNameStr) -
> bool
</autodoc>
13864 <param name=
"parent" type=
"Window" default=
""/>
13865 <param name=
"id" type=
"int" default=
"-1"/>
13866 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
13867 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
13868 <param name=
"style" type=
"long" default=
"wxCLIP_CHILDREN|wxSW_3D"/>
13869 <param name=
"name" type=
"String" default=
"wxPySashLayoutNameStr"/>
13872 <method name=
"GetAlignment" type=
"wxLayoutAlignment" overloaded=
"no">
13873 <autodoc>GetAlignment(self) -
> int
</autodoc>
13875 <method name=
"GetOrientation" type=
"wxLayoutOrientation" overloaded=
"no">
13876 <autodoc>GetOrientation(self) -
> int
</autodoc>
13878 <method name=
"SetAlignment" type=
"" overloaded=
"no">
13879 <autodoc>SetAlignment(self, int alignment)
</autodoc>
13881 <param name=
"alignment" type=
"wxLayoutAlignment" default=
""/>
13884 <method name=
"SetDefaultSize" type=
"" overloaded=
"no">
13885 <autodoc>SetDefaultSize(self, Size size)
</autodoc>
13887 <param name=
"size" type=
"Size" default=
""/>
13890 <method name=
"SetOrientation" type=
"" overloaded=
"no">
13891 <autodoc>SetOrientation(self, int orientation)
</autodoc>
13893 <param name=
"orientation" type=
"wxLayoutOrientation" default=
""/>
13897 <class name=
"LayoutAlgorithm" oldname=
"wxLayoutAlgorithm" module=
"_windows">
13898 <baseclass name=
"Object"/>
13899 <constructor name=
"LayoutAlgorithm" overloaded=
"no">
13900 <autodoc>__init__(self) -
> LayoutAlgorithm
</autodoc>
13902 <destructor name=
"~wxLayoutAlgorithm" overloaded=
"no">
13903 <autodoc>__del__(self)
</autodoc>
13905 <method name=
"LayoutMDIFrame" type=
"bool" overloaded=
"no">
13906 <autodoc>LayoutMDIFrame(self, MDIParentFrame frame, Rect rect=None) -
> bool
</autodoc>
13908 <param name=
"frame" type=
"wxMDIParentFrame" default=
""/>
13909 <param name=
"rect" type=
"Rect" default=
"NULL"/>
13912 <method name=
"LayoutFrame" type=
"bool" overloaded=
"no">
13913 <autodoc>LayoutFrame(self, Frame frame, Window mainWindow=None) -
> bool
</autodoc>
13915 <param name=
"frame" type=
"Frame" default=
""/>
13916 <param name=
"mainWindow" type=
"Window" default=
"NULL"/>
13919 <method name=
"LayoutWindow" type=
"bool" overloaded=
"no">
13920 <autodoc>LayoutWindow(self, Window parent, Window mainWindow=None) -
> bool
</autodoc>
13922 <param name=
"parent" type=
"Window" default=
""/>
13923 <param name=
"mainWindow" type=
"Window" default=
"NULL"/>
13928 #---------------------------------------------------------------------------
13930 <class name=
"PopupWindow" oldname=
"wxPopupWindow" module=
"_windows">
13931 <baseclass name=
"Window"/>
13932 <constructor name=
"PopupWindow" overloaded=
"no">
13933 <autodoc>__init__(self, Window parent, int flags=BORDER_NONE) -
> PopupWindow
</autodoc>
13935 <param name=
"parent" type=
"Window" default=
""/>
13936 <param name=
"flags" type=
"int" default=
"wxBORDER_NONE"/>
13939 <constructor name=
"PrePopupWindow" overloaded=
"no">
13940 <autodoc>PrePopupWindow() -
> PopupWindow
</autodoc>
13942 <method name=
"Create" type=
"bool" overloaded=
"no">
13943 <autodoc>Create(self, Window parent, int flags=BORDER_NONE) -
> bool
</autodoc>
13945 <param name=
"parent" type=
"Window" default=
""/>
13946 <param name=
"flags" type=
"int" default=
"wxBORDER_NONE"/>
13949 <method name=
"Position" type=
"" overloaded=
"no">
13950 <autodoc>Position(self, Point ptOrigin, Size size)
</autodoc>
13952 <param name=
"ptOrigin" type=
"Point" default=
""/>
13953 <param name=
"size" type=
"Size" default=
""/>
13958 #---------------------------------------------------------------------------
13960 <class name=
"PopupTransientWindow" oldname=
"wxPyPopupTransientWindow" module=
"_windows">
13961 <baseclass name=
"PopupWindow"/>
13962 <constructor name=
"wxPyPopupTransientWindow" overloaded=
"no">
13963 <autodoc>__init__(self, Window parent, int style=BORDER_NONE) -
> PopupTransientWindow
</autodoc>
13965 <param name=
"parent" type=
"Window" default=
""/>
13966 <param name=
"style" type=
"int" default=
"wxBORDER_NONE"/>
13969 <constructor name=
"PrePopupTransientWindow" overloaded=
"no">
13970 <autodoc>PrePopupTransientWindow() -
> PopupTransientWindow
</autodoc>
13972 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
13973 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
13975 <param name=
"self" type=
"PyObject" default=
""/>
13976 <param name=
"_class" type=
"PyObject" default=
""/>
13979 <method name=
"Popup" type=
"" overloaded=
"no">
13980 <autodoc>Popup(self, Window focus=None)
</autodoc>
13982 <param name=
"focus" type=
"Window" default=
"NULL"/>
13985 <method name=
"Dismiss" type=
"" overloaded=
"no">
13986 <autodoc>Dismiss(self)
</autodoc>
13990 #---------------------------------------------------------------------------
13992 <class name=
"TipWindow" oldname=
"wxTipWindow" module=
"_windows">
13993 <baseclass name=
"PopupTransientWindow"/>
13994 <constructor name=
"TipWindow" overloaded=
"no">
13995 <autodoc>__init__(self, Window parent, String text, int maxLength=
100, Rect rectBound=None) -
> TipWindow
</autodoc>
13997 <param name=
"parent" type=
"Window" default=
""/>
13998 <param name=
"text" type=
"String" default=
""/>
13999 <param name=
"maxLength" type=
"int" default=
"100"/>
14000 <param name=
"rectBound" type=
"Rect" default=
"NULL"/>
14003 <method name=
"SetBoundingRect" type=
"" overloaded=
"no">
14004 <autodoc>SetBoundingRect(self, Rect rectBound)
</autodoc>
14006 <param name=
"rectBound" type=
"Rect" default=
""/>
14009 <method name=
"Close" type=
"" overloaded=
"no">
14010 <autodoc>Close(self)
</autodoc>
14014 #---------------------------------------------------------------------------
14016 <class name=
"VScrolledWindow" oldname=
"wxPyVScrolledWindow" module=
"_windows">
14017 <baseclass name=
"Panel"/>
14018 <constructor name=
"wxPyVScrolledWindow" overloaded=
"no">
14019 <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
14020 Size size=DefaultSize, long style=
0, String name=PanelNameStr) -
> VScrolledWindow
</autodoc>
14022 <param name=
"parent" type=
"Window" default=
""/>
14023 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
14024 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14025 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
14026 <param name=
"style" type=
"long" default=
"0"/>
14027 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
14030 <constructor name=
"PreVScrolledWindow" overloaded=
"no">
14031 <autodoc>PreVScrolledWindow() -
> VScrolledWindow
</autodoc>
14033 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
14034 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
14036 <param name=
"self" type=
"PyObject" default=
""/>
14037 <param name=
"_class" type=
"PyObject" default=
""/>
14040 <method name=
"Create" type=
"bool" overloaded=
"no">
14041 <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
14042 Size size=DefaultSize, long style=
0, String name=PanelNameStr) -
> bool
</autodoc>
14044 <param name=
"parent" type=
"Window" default=
""/>
14045 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
14046 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14047 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
14048 <param name=
"style" type=
"long" default=
"0"/>
14049 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
14052 <method name=
"SetLineCount" type=
"" overloaded=
"no">
14053 <autodoc>SetLineCount(self, size_t count)
</autodoc>
14055 <param name=
"count" type=
"size_t" default=
""/>
14058 <method name=
"ScrollToLine" type=
"bool" overloaded=
"no">
14059 <autodoc>ScrollToLine(self, size_t line) -
> bool
</autodoc>
14061 <param name=
"line" type=
"size_t" default=
""/>
14064 <method name=
"ScrollLines" type=
"bool" overloaded=
"no">
14065 <autodoc>ScrollLines(self, int lines) -
> bool
</autodoc>
14067 <param name=
"lines" type=
"int" default=
""/>
14070 <method name=
"ScrollPages" type=
"bool" overloaded=
"no">
14071 <autodoc>ScrollPages(self, int pages) -
> bool
</autodoc>
14072 <docstring>If the platform and window class supports it, scrolls the window by
14073 the given number of pages down, if pages is positive, or up if pages
14074 is negative. Returns True if the window was scrolled, False if it was
14075 already on top/bottom and nothing was done.
</docstring>
14077 <param name=
"pages" type=
"int" default=
""/>
14080 <method name=
"RefreshLine" type=
"" overloaded=
"no">
14081 <autodoc>RefreshLine(self, size_t line)
</autodoc>
14083 <param name=
"line" type=
"size_t" default=
""/>
14086 <method name=
"RefreshLines" type=
"" overloaded=
"no">
14087 <autodoc>RefreshLines(self, size_t from, size_t to)
</autodoc>
14089 <param name=
"from" type=
"size_t" default=
""/>
14090 <param name=
"to" type=
"size_t" default=
""/>
14093 <method name=
"HitTestXY" type=
"int" overloaded=
"no">
14094 <autodoc>HitTestXY(self, int x, int y) -
> int
</autodoc>
14095 <docstring>Test where the given (in client coords) point lies
</docstring>
14097 <param name=
"x" type=
"int" default=
""/>
14098 <param name=
"y" type=
"int" default=
""/>
14101 <method name=
"HitTest" type=
"int" overloaded=
"no">
14102 <autodoc>HitTest(self, Point pt) -
> int
</autodoc>
14103 <docstring>Test where the given (in client coords) point lies
</docstring>
14105 <param name=
"pt" type=
"Point" default=
""/>
14108 <method name=
"RefreshAll" type=
"" overloaded=
"no">
14109 <autodoc>RefreshAll(self)
</autodoc>
14111 <method name=
"GetLineCount" type=
"size_t" overloaded=
"no">
14112 <autodoc>GetLineCount(self) -
> size_t
</autodoc>
14114 <method name=
"GetFirstVisibleLine" type=
"size_t" overloaded=
"no">
14115 <autodoc>GetFirstVisibleLine(self) -
> size_t
</autodoc>
14117 <method name=
"GetLastVisibleLine" type=
"size_t" overloaded=
"no">
14118 <autodoc>GetLastVisibleLine(self) -
> size_t
</autodoc>
14120 <method name=
"IsVisible" type=
"bool" overloaded=
"no">
14121 <autodoc>IsVisible(self, size_t line) -
> bool
</autodoc>
14123 <param name=
"line" type=
"size_t" default=
""/>
14127 <class name=
"VListBox" oldname=
"wxPyVListBox" module=
"_windows">
14128 <baseclass name=
"VScrolledWindow"/>
14129 <constructor name=
"wxPyVListBox" overloaded=
"no">
14130 <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
14131 Size size=DefaultSize, long style=
0, String name=VListBoxNameStr) -
> VListBox
</autodoc>
14133 <param name=
"parent" type=
"Window" default=
""/>
14134 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
14135 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14136 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
14137 <param name=
"style" type=
"long" default=
"0"/>
14138 <param name=
"name" type=
"String" default=
"wxPyVListBoxNameStr"/>
14141 <constructor name=
"PreVListBox" overloaded=
"no">
14142 <autodoc>PreVListBox() -
> VListBox
</autodoc>
14144 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
14145 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
14147 <param name=
"self" type=
"PyObject" default=
""/>
14148 <param name=
"_class" type=
"PyObject" default=
""/>
14151 <method name=
"Create" type=
"bool" overloaded=
"no">
14152 <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
14153 Size size=DefaultSize, long style=
0, String name=VListBoxNameStr) -
> bool
</autodoc>
14155 <param name=
"parent" type=
"Window" default=
""/>
14156 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
14157 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14158 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
14159 <param name=
"style" type=
"long" default=
"0"/>
14160 <param name=
"name" type=
"String" default=
"wxPyVListBoxNameStr"/>
14163 <method name=
"GetItemCount" type=
"size_t" overloaded=
"no">
14164 <autodoc>GetItemCount(self) -
> size_t
</autodoc>
14166 <method name=
"HasMultipleSelection" type=
"bool" overloaded=
"no">
14167 <autodoc>HasMultipleSelection(self) -
> bool
</autodoc>
14169 <method name=
"GetSelection" type=
"int" overloaded=
"no">
14170 <autodoc>GetSelection(self) -
> int
</autodoc>
14172 <method name=
"IsCurrent" type=
"bool" overloaded=
"no">
14173 <autodoc>IsCurrent(self, size_t item) -
> bool
</autodoc>
14175 <param name=
"item" type=
"size_t" default=
""/>
14178 <method name=
"IsSelected" type=
"bool" overloaded=
"no">
14179 <autodoc>IsSelected(self, size_t item) -
> bool
</autodoc>
14181 <param name=
"item" type=
"size_t" default=
""/>
14184 <method name=
"GetSelectedCount" type=
"size_t" overloaded=
"no">
14185 <autodoc>GetSelectedCount(self) -
> size_t
</autodoc>
14187 <method name=
"GetFirstSelected" type=
"PyObject" overloaded=
"no">
14188 <autodoc>GetFirstSelected(self) -
> PyObject
</autodoc>
14190 <method name=
"GetNextSelected" type=
"PyObject" overloaded=
"no">
14191 <autodoc>GetNextSelected(self, unsigned long cookie) -
> PyObject
</autodoc>
14193 <param name=
"cookie" type=
"unsigned long" default=
""/>
14196 <method name=
"GetMargins" type=
"Point" overloaded=
"no">
14197 <autodoc>GetMargins(self) -
> Point
</autodoc>
14199 <method name=
"GetSelectionBackground" type=
"Colour" overloaded=
"no">
14200 <autodoc>GetSelectionBackground(self) -
> Colour
</autodoc>
14202 <method name=
"SetItemCount" type=
"" overloaded=
"no">
14203 <autodoc>SetItemCount(self, size_t count)
</autodoc>
14205 <param name=
"count" type=
"size_t" default=
""/>
14208 <method name=
"Clear" type=
"" overloaded=
"no">
14209 <autodoc>Clear(self)
</autodoc>
14211 <method name=
"SetSelection" type=
"" overloaded=
"no">
14212 <autodoc>SetSelection(self, int selection)
</autodoc>
14214 <param name=
"selection" type=
"int" default=
""/>
14217 <method name=
"Select" type=
"bool" overloaded=
"no">
14218 <autodoc>Select(self, size_t item, bool select=True) -
> bool
</autodoc>
14220 <param name=
"item" type=
"size_t" default=
""/>
14221 <param name=
"select" type=
"bool" default=
"True"/>
14224 <method name=
"SelectRange" type=
"bool" overloaded=
"no">
14225 <autodoc>SelectRange(self, size_t from, size_t to) -
> bool
</autodoc>
14227 <param name=
"from" type=
"size_t" default=
""/>
14228 <param name=
"to" type=
"size_t" default=
""/>
14231 <method name=
"Toggle" type=
"" overloaded=
"no">
14232 <autodoc>Toggle(self, size_t item)
</autodoc>
14234 <param name=
"item" type=
"size_t" default=
""/>
14237 <method name=
"SelectAll" type=
"bool" overloaded=
"no">
14238 <autodoc>SelectAll(self) -
> bool
</autodoc>
14240 <method name=
"DeselectAll" type=
"bool" overloaded=
"no">
14241 <autodoc>DeselectAll(self) -
> bool
</autodoc>
14243 <method name=
"SetMargins" type=
"" overloaded=
"no">
14244 <autodoc>SetMargins(self, Point pt)
</autodoc>
14246 <param name=
"pt" type=
"Point" default=
""/>
14249 <method name=
"SetMarginsXY" type=
"" overloaded=
"no">
14250 <autodoc>SetMarginsXY(self, int x, int y)
</autodoc>
14252 <param name=
"x" type=
"int" default=
""/>
14253 <param name=
"y" type=
"int" default=
""/>
14256 <method name=
"SetSelectionBackground" type=
"" overloaded=
"no">
14257 <autodoc>SetSelectionBackground(self, Colour col)
</autodoc>
14259 <param name=
"col" type=
"Colour" default=
""/>
14263 <class name=
"HtmlListBox" oldname=
"wxPyHtmlListBox" module=
"_windows">
14264 <baseclass name=
"VListBox"/>
14265 <constructor name=
"wxPyHtmlListBox" overloaded=
"no">
14266 <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
14267 Size size=DefaultSize, long style=
0, String name=VListBoxNameStr) -
> HtmlListBox
</autodoc>
14269 <param name=
"parent" type=
"Window" default=
""/>
14270 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
14271 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14272 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
14273 <param name=
"style" type=
"long" default=
"0"/>
14274 <param name=
"name" type=
"String" default=
"wxPyVListBoxNameStr"/>
14277 <constructor name=
"PreHtmlListBox" overloaded=
"no">
14278 <autodoc>PreHtmlListBox() -
> HtmlListBox
</autodoc>
14280 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
14281 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
14283 <param name=
"self" type=
"PyObject" default=
""/>
14284 <param name=
"_class" type=
"PyObject" default=
""/>
14287 <method name=
"Create" type=
"bool" overloaded=
"no">
14288 <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
14289 Size size=DefaultSize, long style=
0, String name=VListBoxNameStr) -
> bool
</autodoc>
14291 <param name=
"parent" type=
"Window" default=
""/>
14292 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
14293 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14294 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
14295 <param name=
"style" type=
"long" default=
"0"/>
14296 <param name=
"name" type=
"String" default=
"wxPyVListBoxNameStr"/>
14299 <method name=
"RefreshAll" type=
"" overloaded=
"no">
14300 <autodoc>RefreshAll(self)
</autodoc>
14302 <method name=
"SetItemCount" type=
"" overloaded=
"no">
14303 <autodoc>SetItemCount(self, size_t count)
</autodoc>
14305 <param name=
"count" type=
"size_t" default=
""/>
14308 <method name=
"GetFileSystem" type=
"FileSystem" overloaded=
"no">
14309 <autodoc>GetFileSystem(self) -
> FileSystem
</autodoc>
14313 #---------------------------------------------------------------------------
14315 <class name=
"TaskBarIcon" oldname=
"wxTaskBarIcon" module=
"_windows">
14316 <baseclass name=
"EvtHandler"/>
14317 <constructor name=
"TaskBarIcon" overloaded=
"no">
14318 <autodoc>__init__(self) -
> TaskBarIcon
</autodoc>
14320 <destructor name=
"~wxTaskBarIcon" overloaded=
"no">
14321 <autodoc>__del__(self)
</autodoc>
14323 <method name=
"Destroy" type=
"" overloaded=
"no">
14324 <autodoc>Destroy(self)
</autodoc>
14325 <docstring>Deletes the C++ object this Python object is a proxy for.
</docstring>
14327 <method name=
"IsOk" type=
"bool" overloaded=
"no">
14328 <autodoc>IsOk(self) -
> bool
</autodoc>
14330 <method name=
"IsIconInstalled" type=
"bool" overloaded=
"no">
14331 <autodoc>IsIconInstalled(self) -
> bool
</autodoc>
14333 <method name=
"SetIcon" type=
"bool" overloaded=
"no">
14334 <autodoc>SetIcon(self, Icon icon, String tooltip=EmptyString) -
> bool
</autodoc>
14336 <param name=
"icon" type=
"Icon" default=
""/>
14337 <param name=
"tooltip" type=
"String" default=
"wxPyEmptyString"/>
14340 <method name=
"RemoveIcon" type=
"bool" overloaded=
"no">
14341 <autodoc>RemoveIcon(self) -
> bool
</autodoc>
14343 <method name=
"PopupMenu" type=
"bool" overloaded=
"no">
14344 <autodoc>PopupMenu(self, Menu menu) -
> bool
</autodoc>
14346 <param name=
"menu" type=
"Menu" default=
""/>
14350 <class name=
"TaskBarIconEvent" oldname=
"wxTaskBarIconEvent" module=
"_windows">
14351 <baseclass name=
"Event"/>
14352 <constructor name=
"TaskBarIconEvent" overloaded=
"no">
14353 <autodoc>__init__(self, wxEventType evtType, TaskBarIcon tbIcon) -
> TaskBarIconEvent
</autodoc>
14355 <param name=
"evtType" type=
"wxEventType" default=
""/>
14356 <param name=
"tbIcon" type=
"TaskBarIcon" default=
""/>
14361 EVT_TASKBAR_MOVE = wx.PyEventBinder ( wxEVT_TASKBAR_MOVE )
14362 EVT_TASKBAR_LEFT_DOWN = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_DOWN )
14363 EVT_TASKBAR_LEFT_UP = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_UP )
14364 EVT_TASKBAR_RIGHT_DOWN = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DOWN )
14365 EVT_TASKBAR_RIGHT_UP = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_UP )
14366 EVT_TASKBAR_LEFT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_LEFT_DCLICK )
14367 EVT_TASKBAR_RIGHT_DCLICK = wx.PyEventBinder ( wxEVT_TASKBAR_RIGHT_DCLICK )
14370 #---------------------------------------------------------------------------
14372 <class name=
"ColourData" oldname=
"wxColourData" module=
"_windows">
14373 <docstring>This class holds a variety of information related to the colour
14374 chooser dialog, used to transfer settings and results to and from the
14375 `wx.ColourDialog`.
</docstring>
14376 <baseclass name=
"Object"/>
14377 <constructor name=
"ColourData" overloaded=
"no">
14378 <autodoc>__init__(self) -
> ColourData
</autodoc>
14379 <docstring>Constructor, sets default values.
</docstring>
14381 <destructor name=
"~wxColourData" overloaded=
"no">
14382 <autodoc>__del__(self)
</autodoc>
14384 <method name=
"GetChooseFull" type=
"bool" overloaded=
"no">
14385 <autodoc>GetChooseFull(self) -
> bool
</autodoc>
14386 <docstring>Under Windows, determines whether the Windows colour dialog will
14387 display the full dialog with custom colour selection controls. Has no
14388 meaning under other platforms. The default value is true.
</docstring>
14390 <method name=
"GetColour" type=
"Colour" overloaded=
"no">
14391 <autodoc>GetColour(self) -
> Colour
</autodoc>
14392 <docstring>Gets the colour (pre)selected by the dialog.
</docstring>
14394 <method name=
"GetCustomColour" type=
"Colour" overloaded=
"no">
14395 <autodoc>GetCustomColour(self, int i) -
> Colour
</autodoc>
14396 <docstring>Gets the i'th custom colour associated with the colour dialog. i
14397 should be an integer between
0 and
15. The default custom colours are
14398 all invalid colours.
</docstring>
14400 <param name=
"i" type=
"int" default=
""/>
14403 <method name=
"SetChooseFull" type=
"" overloaded=
"no">
14404 <autodoc>SetChooseFull(self, int flag)
</autodoc>
14405 <docstring>Under Windows, tells the Windows colour dialog to display the full
14406 dialog with custom colour selection controls. Under other platforms,
14407 has no effect. The default value is true.
</docstring>
14409 <param name=
"flag" type=
"int" default=
""/>
14412 <method name=
"SetColour" type=
"" overloaded=
"no">
14413 <autodoc>SetColour(self, Colour colour)
</autodoc>
14414 <docstring>Sets the default colour for the colour dialog. The default colour is
14417 <param name=
"colour" type=
"Colour" default=
""/>
14420 <method name=
"SetCustomColour" type=
"" overloaded=
"no">
14421 <autodoc>SetCustomColour(self, int i, Colour colour)
</autodoc>
14422 <docstring>Sets the i'th custom colour for the colour dialog. i should be an
14423 integer between
0 and
15. The default custom colours are all invalid colours.
</docstring>
14425 <param name=
"i" type=
"int" default=
""/>
14426 <param name=
"colour" type=
"Colour" default=
""/>
14430 <class name=
"ColourDialog" oldname=
"wxColourDialog" module=
"_windows">
14431 <docstring>This class represents the colour chooser dialog.
</docstring>
14432 <baseclass name=
"Dialog"/>
14433 <constructor name=
"ColourDialog" overloaded=
"no">
14434 <autodoc>__init__(self, Window parent, ColourData data=None) -
> ColourDialog
</autodoc>
14435 <docstring>Constructor. Pass a parent window, and optionally a `wx.ColourData`,
14436 which will be copied to the colour dialog's internal ColourData
14437 instance.
</docstring>
14439 <param name=
"parent" type=
"Window" default=
""/>
14440 <param name=
"data" type=
"ColourData" default=
"NULL"/>
14443 <method name=
"GetColourData" type=
"ColourData" overloaded=
"no">
14444 <autodoc>GetColourData(self) -
> ColourData
</autodoc>
14445 <docstring>Returns a reference to the `wx.ColourData` used by the dialog.
</docstring>
14448 <class name=
"DirDialog" oldname=
"wxDirDialog" module=
"_windows">
14449 <docstring>wx.DirDialog allows the user to select a directory by browising the
14454 ==================== ==========================================
14455 wx.DD_NEW_DIR_BUTTON Add 'Create new directory' button and allow
14456 directory names to be editable. On Windows
14457 the new directory button is only available
14458 with recent versions of the common dialogs.
14459 ==================== ==========================================
14461 <baseclass name=
"Dialog"/>
14462 <constructor name=
"DirDialog" overloaded=
"no">
14463 <autodoc>__init__(self, Window parent, String message=DirSelectorPromptStr,
14464 String defaultPath=EmptyString, long style=
0,
14465 Point pos=DefaultPosition, Size size=DefaultSize,
14466 String name=DirDialogNameStr) -
> DirDialog
</autodoc>
14467 <docstring>Constructor. Use ShowModal method to show the dialog.
</docstring>
14469 <param name=
"parent" type=
"Window" default=
""/>
14470 <param name=
"message" type=
"String" default=
"wxPyDirSelectorPromptStr"/>
14471 <param name=
"defaultPath" type=
"String" default=
"wxPyEmptyString"/>
14472 <param name=
"style" type=
"long" default=
"0"/>
14473 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14474 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
14475 <param name=
"name" type=
"String" default=
"wxPyDirDialogNameStr"/>
14478 <method name=
"GetPath" type=
"String" overloaded=
"no">
14479 <autodoc>GetPath(self) -
> String
</autodoc>
14480 <docstring>Returns the default or user-selected path.
</docstring>
14482 <method name=
"GetMessage" type=
"String" overloaded=
"no">
14483 <autodoc>GetMessage(self) -
> String
</autodoc>
14484 <docstring>Returns the message that will be displayed on the dialog.
</docstring>
14486 <method name=
"GetStyle" type=
"long" overloaded=
"no">
14487 <autodoc>GetStyle(self) -
> long
</autodoc>
14488 <docstring>Returns the dialog style.
</docstring>
14490 <method name=
"SetMessage" type=
"" overloaded=
"no">
14491 <autodoc>SetMessage(self, String message)
</autodoc>
14492 <docstring>Sets the message that will be displayed on the dialog.
</docstring>
14494 <param name=
"message" type=
"String" default=
""/>
14497 <method name=
"SetPath" type=
"" overloaded=
"no">
14498 <autodoc>SetPath(self, String path)
</autodoc>
14499 <docstring>Sets the default path.
</docstring>
14501 <param name=
"path" type=
"String" default=
""/>
14505 <class name=
"FileDialog" oldname=
"wxFileDialog" module=
"_windows">
14506 <docstring>wx.FileDialog allows the user to select one or more files from the
14509 In Windows, this is the common file selector dialog. On X based
14510 platforms a generic alternative is used. The path and filename are
14511 distinct elements of a full file pathname. If path is "", the
14512 current directory will be used. If filename is "", no default
14513 filename will be supplied. The wildcard determines what files are
14514 displayed in the file selector, and file extension supplies a type
14515 extension for the required filename.
14517 Both the X and Windows versions implement a wildcard filter. Typing a
14518 filename containing wildcards (\\*, ?) in the filename text item, and
14519 clicking on Ok, will result in only those files matching the pattern
14520 being displayed. The wildcard may be a specification for multiple
14521 types of file with a description for each, such as::
14523 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
14528 =================== ==========================================
14529 wx.OPEN This is an open dialog.
14531 wx.SAVE This is a save dialog.
14533 wx.HIDE_READONLY For open dialog only: hide the checkbox
14534 allowing to open the file in read-only mode.
14536 wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation
14537 if a file will be overwritten.
14539 wx.MULTIPLE For open dialog only: allows selecting multiple
14542 wx.CHANGE_DIR Change the current working directory to the
14543 directory where the file(s) chosen by the user
14545 =================== ==========================================
14547 <baseclass name=
"Dialog"/>
14548 <constructor name=
"FileDialog" overloaded=
"no">
14549 <autodoc>__init__(self, Window parent, String message=FileSelectorPromptStr,
14550 String defaultDir=EmptyString, String defaultFile=EmptyString,
14551 String wildcard=FileSelectorDefaultWildcardStr,
14552 long style=
0, Point pos=DefaultPosition) -
> FileDialog
</autodoc>
14553 <docstring>Constructor. Use ShowModal method to show the dialog.
</docstring>
14555 <param name=
"parent" type=
"Window" default=
""/>
14556 <param name=
"message" type=
"String" default=
"wxPyFileSelectorPromptStr"/>
14557 <param name=
"defaultDir" type=
"String" default=
"wxPyEmptyString"/>
14558 <param name=
"defaultFile" type=
"String" default=
"wxPyEmptyString"/>
14559 <param name=
"wildcard" type=
"String" default=
"wxPyFileSelectorDefaultWildcardStr"/>
14560 <param name=
"style" type=
"long" default=
"0"/>
14561 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14564 <method name=
"SetMessage" type=
"" overloaded=
"no">
14565 <autodoc>SetMessage(self, String message)
</autodoc>
14566 <docstring>Sets the message that will be displayed on the dialog.
</docstring>
14568 <param name=
"message" type=
"String" default=
""/>
14571 <method name=
"SetPath" type=
"" overloaded=
"no">
14572 <autodoc>SetPath(self, String path)
</autodoc>
14573 <docstring>Sets the path (the combined directory and filename that will be
14574 returned when the dialog is dismissed).
</docstring>
14576 <param name=
"path" type=
"String" default=
""/>
14579 <method name=
"SetDirectory" type=
"" overloaded=
"no">
14580 <autodoc>SetDirectory(self, String dir)
</autodoc>
14581 <docstring>Sets the default directory.
</docstring>
14583 <param name=
"dir" type=
"String" default=
""/>
14586 <method name=
"SetFilename" type=
"" overloaded=
"no">
14587 <autodoc>SetFilename(self, String name)
</autodoc>
14588 <docstring>Sets the default filename.
</docstring>
14590 <param name=
"name" type=
"String" default=
""/>
14593 <method name=
"SetWildcard" type=
"" overloaded=
"no">
14594 <autodoc>SetWildcard(self, String wildCard)
</autodoc>
14595 <docstring>Sets the wildcard, which can contain multiple file types, for
14598 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
14601 <param name=
"wildCard" type=
"String" default=
""/>
14604 <method name=
"SetStyle" type=
"" overloaded=
"no">
14605 <autodoc>SetStyle(self, long style)
</autodoc>
14606 <docstring>Sets the dialog style.
</docstring>
14608 <param name=
"style" type=
"long" default=
""/>
14611 <method name=
"SetFilterIndex" type=
"" overloaded=
"no">
14612 <autodoc>SetFilterIndex(self, int filterIndex)
</autodoc>
14613 <docstring>Sets the default filter index, starting from zero.
</docstring>
14615 <param name=
"filterIndex" type=
"int" default=
""/>
14618 <method name=
"GetMessage" type=
"String" overloaded=
"no">
14619 <autodoc>GetMessage(self) -
> String
</autodoc>
14620 <docstring>Returns the message that will be displayed on the dialog.
</docstring>
14622 <method name=
"GetPath" type=
"String" overloaded=
"no">
14623 <autodoc>GetPath(self) -
> String
</autodoc>
14624 <docstring>Returns the full path (directory and filename) of the selected file.
</docstring>
14626 <method name=
"GetDirectory" type=
"String" overloaded=
"no">
14627 <autodoc>GetDirectory(self) -
> String
</autodoc>
14628 <docstring>Returns the default directory.
</docstring>
14630 <method name=
"GetFilename" type=
"String" overloaded=
"no">
14631 <autodoc>GetFilename(self) -
> String
</autodoc>
14632 <docstring>Returns the default filename.
</docstring>
14634 <method name=
"GetWildcard" type=
"String" overloaded=
"no">
14635 <autodoc>GetWildcard(self) -
> String
</autodoc>
14636 <docstring>Returns the file dialog wildcard.
</docstring>
14638 <method name=
"GetStyle" type=
"long" overloaded=
"no">
14639 <autodoc>GetStyle(self) -
> long
</autodoc>
14640 <docstring>Returns the dialog style.
</docstring>
14642 <method name=
"GetFilterIndex" type=
"int" overloaded=
"no">
14643 <autodoc>GetFilterIndex(self) -
> int
</autodoc>
14644 <docstring>Returns the index into the list of filters supplied, optionally, in
14645 the wildcard parameter. Before the dialog is shown, this is the index
14646 which will be used when the dialog is first displayed. After the
14647 dialog is shown, this is the index selected by the user.
</docstring>
14649 <method name=
"GetFilenames" type=
"PyObject" overloaded=
"no">
14650 <autodoc>GetFilenames(self) -
> PyObject
</autodoc>
14651 <docstring>Returns a list of filenames chosen in the dialog. This function
14652 should only be used with the dialogs which have wx.MULTIPLE style, use
14653 GetFilename for the others.
</docstring>
14655 <method name=
"GetPaths" type=
"PyObject" overloaded=
"no">
14656 <autodoc>GetPaths(self) -
> PyObject
</autodoc>
14657 <docstring>Fills the array paths with the full paths of the files chosen. This
14658 function should only be used with the dialogs which have wx.MULTIPLE
14659 style, use GetPath for the others.
</docstring>
14662 <class name=
"MultiChoiceDialog" oldname=
"wxMultiChoiceDialog" module=
"_windows">
14663 <docstring>A simple dialog with a multi selection listbox.
</docstring>
14664 <baseclass name=
"Dialog"/>
14665 <constructor name=
"MultiChoiceDialog" overloaded=
"no">
14666 <autodoc>__init__(Window parent, String message, String caption,
14667 List choices=[], long style=CHOICEDLG_STYLE,
14668 Point pos=DefaultPosition) -
> MultiChoiceDialog
</autodoc>
14669 <docstring>Constructor. Use ShowModal method to show the dialog.
</docstring>
14671 <param name=
"parent" type=
"Window" default=
""/>
14672 <param name=
"message" type=
"String" default=
""/>
14673 <param name=
"caption" type=
"String" default=
""/>
14674 <param name=
"choices" type=
"int" default=
"0"/>
14675 <param name=
"choices_array" type=
"String" default=
"NULL"/>
14676 <param name=
"style" type=
"long" default=
"wxCHOICEDLG_STYLE"/>
14677 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14680 <method name=
"SetSelections" type=
"" overloaded=
"no">
14681 <autodoc>SetSelections(List selections)
</autodoc>
14682 <docstring>Specify the items in the list that should be selected, using a list of
14683 integers.
</docstring>
14685 <param name=
"selections" type=
"wxArrayInt" default=
""/>
14688 <method name=
"GetSelections" type=
"PyObject" overloaded=
"no">
14689 <autodoc>GetSelections() -
> [selections]
</autodoc>
14690 <docstring>Returns a list of integers representing the items that are selected.
</docstring>
14693 <class name=
"SingleChoiceDialog" oldname=
"wxSingleChoiceDialog" module=
"_windows">
14694 <docstring>A simple dialog with a single selection listbox.
</docstring>
14695 <baseclass name=
"Dialog"/>
14696 <constructor name=
"SingleChoiceDialog" overloaded=
"no">
14697 <autodoc>__init__(Window parent, String message, String caption,
14698 List choices=[], long style=CHOICEDLG_STYLE,
14699 Point pos=DefaultPosition) -
> SingleChoiceDialog
</autodoc>
14700 <docstring>Constructor. Use ShowModal method to show the dialog.
</docstring>
14702 <param name=
"parent" type=
"Window" default=
""/>
14703 <param name=
"message" type=
"String" default=
""/>
14704 <param name=
"caption" type=
"String" default=
""/>
14705 <param name=
"choices" type=
"int" default=
""/>
14706 <param name=
"choices_array" type=
"String" default=
""/>
14707 <param name=
"style" type=
"long" default=
"wxCHOICEDLG_STYLE"/>
14708 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14711 <method name=
"GetSelection" type=
"int" overloaded=
"no">
14712 <autodoc>GetSelection(self) -
> int
</autodoc>
14713 <docstring>Get the index of teh currently selected item.
</docstring>
14715 <method name=
"GetStringSelection" type=
"String" overloaded=
"no">
14716 <autodoc>GetStringSelection(self) -
> String
</autodoc>
14717 <docstring>Returns the string value of the currently selected item
</docstring>
14719 <method name=
"SetSelection" type=
"" overloaded=
"no">
14720 <autodoc>SetSelection(self, int sel)
</autodoc>
14721 <docstring>Set the current selected item to sel
</docstring>
14723 <param name=
"sel" type=
"int" default=
""/>
14727 <class name=
"TextEntryDialog" oldname=
"wxTextEntryDialog" module=
"_windows">
14728 <docstring>A dialog with text control, [ok] and [cancel] buttons
</docstring>
14729 <baseclass name=
"Dialog"/>
14730 <constructor name=
"TextEntryDialog" overloaded=
"no">
14731 <autodoc>__init__(self, Window parent, String message, String caption=GetTextFromUserPromptStr,
14732 String defaultValue=EmptyString,
14733 long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -
> TextEntryDialog
</autodoc>
14734 <docstring>Constructor. Use ShowModal method to show the dialog.
</docstring>
14736 <param name=
"parent" type=
"Window" default=
""/>
14737 <param name=
"message" type=
"String" default=
""/>
14738 <param name=
"caption" type=
"String" default=
"wxPyGetTextFromUserPromptStr"/>
14739 <param name=
"defaultValue" type=
"String" default=
"wxPyEmptyString"/>
14740 <param name=
"style" type=
"long" default=
"wxOK|wxCANCEL|wxCENTRE"/>
14741 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14744 <method name=
"GetValue" type=
"String" overloaded=
"no">
14745 <autodoc>GetValue(self) -
> String
</autodoc>
14746 <docstring>Returns the text that the user has entered if the user has pressed OK,
14747 or the original value if the user has pressed Cancel.
</docstring>
14749 <method name=
"SetValue" type=
"" overloaded=
"no">
14750 <autodoc>SetValue(self, String value)
</autodoc>
14751 <docstring>Sets the default text value.
</docstring>
14753 <param name=
"value" type=
"String" default=
""/>
14757 <class name=
"FontData" oldname=
"wxFontData" module=
"_windows">
14758 <docstring>This class holds a variety of information related to font dialogs and
14759 is used to transfer settings to and results from a `wx.FontDialog`.
</docstring>
14760 <baseclass name=
"Object"/>
14761 <constructor name=
"FontData" overloaded=
"no">
14762 <autodoc>__init__(self) -
> FontData
</autodoc>
14763 <docstring>This class holds a variety of information related to font dialogs and
14764 is used to transfer settings to and results from a `wx.FontDialog`.
</docstring>
14766 <destructor name=
"~wxFontData" overloaded=
"no">
14767 <autodoc>__del__(self)
</autodoc>
14769 <method name=
"EnableEffects" type=
"" overloaded=
"no">
14770 <autodoc>EnableEffects(self, bool enable)
</autodoc>
14771 <docstring>Enables or disables 'effects' under MS Windows only. This refers to
14772 the controls for manipulating colour, strikeout and underline
14773 properties. The default value is true.
</docstring>
14775 <param name=
"enable" type=
"bool" default=
""/>
14778 <method name=
"GetAllowSymbols" type=
"bool" overloaded=
"no">
14779 <autodoc>GetAllowSymbols(self) -
> bool
</autodoc>
14780 <docstring>Under MS Windows, returns a flag determining whether symbol fonts can
14781 be selected. Has no effect on other platforms. The default value is
14784 <method name=
"GetColour" type=
"Colour" overloaded=
"no">
14785 <autodoc>GetColour(self) -
> Colour
</autodoc>
14786 <docstring>Gets the colour associated with the font dialog. The default value is
14789 <method name=
"GetChosenFont" type=
"Font" overloaded=
"no">
14790 <autodoc>GetChosenFont(self) -
> Font
</autodoc>
14791 <docstring>Gets the font chosen by the user.
</docstring>
14793 <method name=
"GetEnableEffects" type=
"bool" overloaded=
"no">
14794 <autodoc>GetEnableEffects(self) -
> bool
</autodoc>
14795 <docstring>Determines whether 'effects' are enabled under Windows.
</docstring>
14797 <method name=
"GetInitialFont" type=
"Font" overloaded=
"no">
14798 <autodoc>GetInitialFont(self) -
> Font
</autodoc>
14799 <docstring>Gets the font that will be initially used by the font dialog. This
14800 should have previously been set by the application.
</docstring>
14802 <method name=
"GetShowHelp" type=
"bool" overloaded=
"no">
14803 <autodoc>GetShowHelp(self) -
> bool
</autodoc>
14804 <docstring>Returns true if the Help button will be shown (Windows only). The
14805 default value is false.
</docstring>
14807 <method name=
"SetAllowSymbols" type=
"" overloaded=
"no">
14808 <autodoc>SetAllowSymbols(self, bool allowSymbols)
</autodoc>
14809 <docstring>Under MS Windows, determines whether symbol fonts can be selected. Has
14810 no effect on other platforms. The default value is true.
</docstring>
14812 <param name=
"allowSymbols" type=
"bool" default=
""/>
14815 <method name=
"SetChosenFont" type=
"" overloaded=
"no">
14816 <autodoc>SetChosenFont(self, Font font)
</autodoc>
14817 <docstring>Sets the font that will be returned to the user (normally for internal
14818 use only).
</docstring>
14820 <param name=
"font" type=
"Font" default=
""/>
14823 <method name=
"SetColour" type=
"" overloaded=
"no">
14824 <autodoc>SetColour(self, Colour colour)
</autodoc>
14825 <docstring>Sets the colour that will be used for the font foreground colour. The
14826 default colour is black.
</docstring>
14828 <param name=
"colour" type=
"Colour" default=
""/>
14831 <method name=
"SetInitialFont" type=
"" overloaded=
"no">
14832 <autodoc>SetInitialFont(self, Font font)
</autodoc>
14833 <docstring>Sets the font that will be initially used by the font dialog.
</docstring>
14835 <param name=
"font" type=
"Font" default=
""/>
14838 <method name=
"SetRange" type=
"" overloaded=
"no">
14839 <autodoc>SetRange(self, int min, int max)
</autodoc>
14840 <docstring>Sets the valid range for the font point size (Windows only). The
14841 default is
0,
0 (unrestricted range).
</docstring>
14843 <param name=
"min" type=
"int" default=
""/>
14844 <param name=
"max" type=
"int" default=
""/>
14847 <method name=
"SetShowHelp" type=
"" overloaded=
"no">
14848 <autodoc>SetShowHelp(self, bool showHelp)
</autodoc>
14849 <docstring>Determines whether the Help button will be displayed in the font
14850 dialog (Windows only). The default value is false.
</docstring>
14852 <param name=
"showHelp" type=
"bool" default=
""/>
14856 <class name=
"FontDialog" oldname=
"wxFontDialog" module=
"_windows">
14857 <docstring>wx.FontDialog allows the user to select a system font and its attributes.
14859 :see: `wx.FontData`
14861 <baseclass name=
"Dialog"/>
14862 <constructor name=
"FontDialog" overloaded=
"no">
14863 <autodoc>__init__(self, Window parent, FontData data) -
> FontDialog
</autodoc>
14864 <docstring>Constructor. Pass a parent window and the `wx.FontData` object to be
14865 used to initialize the dialog controls. Call `ShowModal` to display
14866 the dialog. If ShowModal returns ``wx.ID_OK`` then you can fetch the
14867 results with via the `wx.FontData` returned by `GetFontData`.
</docstring>
14869 <param name=
"parent" type=
"Window" default=
""/>
14870 <param name=
"data" type=
"FontData" default=
""/>
14873 <method name=
"GetFontData" type=
"FontData" overloaded=
"no">
14874 <autodoc>GetFontData(self) -
> FontData
</autodoc>
14875 <docstring>Returns a reference to the internal `wx.FontData` used by the
14876 wx.FontDialog.
</docstring>
14879 <class name=
"MessageDialog" oldname=
"wxMessageDialog" module=
"_windows">
14880 <docstring>This class provides a simple dialog that shows a single or multi-line
14881 message, with a choice of OK, Yes, No and/or Cancel buttons.
14885 =================== =============================================
14886 wx.OK Show an OK button.
14887 wx.CANCEL Show a Cancel button.
14888 wx.YES_NO Show Yes and No buttons.
14889 wx.YES_DEFAULT Used with wxYES_NO, makes Yes button the
14890 default - which is the default behaviour.
14891 wx.NO_DEFAULT Used with wxYES_NO, makes No button the default.
14892 wx.ICON_EXCLAMATION Shows an exclamation mark icon.
14893 wx.ICON_HAND Shows an error icon.
14894 wx.ICON_ERROR Shows an error icon - the same as wxICON_HAND.
14895 wx.ICON_QUESTION Shows a question mark icon.
14896 wx.ICON_INFORMATION Shows an information (i) icon.
14897 wx.STAY_ON_TOP The message box stays on top of all other
14898 window, even those of the other applications
14900 =================== =============================================
14902 <baseclass name=
"Dialog"/>
14903 <constructor name=
"MessageDialog" overloaded=
"no">
14904 <autodoc>__init__(self, Window parent, String message, String caption=MessageBoxCaptionStr,
14905 long style=wxOK|wxCANCEL|wxCENTRE,
14906 Point pos=DefaultPosition) -
> MessageDialog
</autodoc>
14907 <docstring>Constructor, use `ShowModal` to display the dialog.
</docstring>
14909 <param name=
"parent" type=
"Window" default=
""/>
14910 <param name=
"message" type=
"String" default=
""/>
14911 <param name=
"caption" type=
"String" default=
"wxPyMessageBoxCaptionStr"/>
14912 <param name=
"style" type=
"long" default=
"wxOK|wxCANCEL|wxCENTRE"/>
14913 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
14917 <class name=
"ProgressDialog" oldname=
"wxProgressDialog" module=
"_windows">
14918 <docstring>A dialog that shows a short message and a progress bar. Optionally, it
14919 can display an ABORT button.
14923 ==================== =============================================
14924 wx.PD_APP_MODAL Make the progress dialog modal. If this flag is
14925 not given, it is only "locally" modal -
14926 that is the input to the parent window is
14927 disabled, but not to the other ones.
14929 wx.PD_AUTO_HIDE Causes the progress dialog to disappear from
14930 screen as soon as the maximum value of the
14931 progress meter has been reached.
14933 wx.PD_CAN_ABORT This flag tells the dialog that it should have
14934 a "Cancel" button which the user may press. If
14935 this happens, the next call to Update() will
14938 wx.PD_ELAPSED_TIME This flag tells the dialog that it should show
14939 elapsed time (since creating the dialog).
14941 wx.PD_ESTIMATED_TIME This flag tells the dialog that it should show
14944 wx.PD_REMAINING_TIME This flag tells the dialog that it should show
14946 ==================== =============================================
14948 <baseclass name=
"Frame"/>
14949 <constructor name=
"ProgressDialog" overloaded=
"no">
14950 <autodoc>__init__(self, String title, String message, int maximum=
100, Window parent=None,
14951 int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL) -
> ProgressDialog
</autodoc>
14952 <docstring>Constructor. Creates the dialog, displays it and disables user input
14953 for other windows, or, if wx.PD_APP_MODAL flag is not given, for its
14954 parent window only.
</docstring>
14956 <param name=
"title" type=
"String" default=
""/>
14957 <param name=
"message" type=
"String" default=
""/>
14958 <param name=
"maximum" type=
"int" default=
"100"/>
14959 <param name=
"parent" type=
"Window" default=
"NULL"/>
14960 <param name=
"style" type=
"int" default=
"wxPD_AUTO_HIDE|wxPD_APP_MODAL"/>
14963 <method name=
"Update" type=
"bool" overloaded=
"no">
14964 <autodoc>Update(self, int value, String newmsg=EmptyString) -
> bool
</autodoc>
14965 <docstring>Updates the dialog, setting the progress bar to the new value and, if
14966 given changes the message above it. The value given should be less
14967 than or equal to the maximum value given to the constructor and the
14968 dialog is closed if it is equal to the maximum. Returns true unless
14969 the Cancel button has been pressed.
14971 If false is returned, the application can either immediately destroy
14972 the dialog or ask the user for the confirmation and if the abort is
14973 not confirmed the dialog may be resumed with Resume function.
</docstring>
14975 <param name=
"value" type=
"int" default=
""/>
14976 <param name=
"newmsg" type=
"String" default=
"wxPyEmptyString"/>
14979 <method name=
"Resume" type=
"" overloaded=
"no">
14980 <autodoc>Resume(self)
</autodoc>
14981 <docstring>Can be used to continue with the dialog, after the user had chosen to
14986 EVT_FIND = wx.PyEventBinder( wxEVT_COMMAND_FIND,
1 )
14987 EVT_FIND_NEXT = wx.PyEventBinder( wxEVT_COMMAND_FIND_NEXT,
1 )
14988 EVT_FIND_REPLACE = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE,
1 )
14989 EVT_FIND_REPLACE_ALL = wx.PyEventBinder( wxEVT_COMMAND_FIND_REPLACE_ALL,
1 )
14990 EVT_FIND_CLOSE = wx.PyEventBinder( wxEVT_COMMAND_FIND_CLOSE,
1 )
14992 # For backwards compatibility. Should they be removed?
14993 EVT_COMMAND_FIND = EVT_FIND
14994 EVT_COMMAND_FIND_NEXT = EVT_FIND_NEXT
14995 EVT_COMMAND_FIND_REPLACE = EVT_FIND_REPLACE
14996 EVT_COMMAND_FIND_REPLACE_ALL = EVT_FIND_REPLACE_ALL
14997 EVT_COMMAND_FIND_CLOSE = EVT_FIND_CLOSE
14999 <class name=
"FindDialogEvent" oldname=
"wxFindDialogEvent" module=
"_windows">
15000 <docstring>Events for the FindReplaceDialog
</docstring>
15001 <baseclass name=
"CommandEvent"/>
15002 <constructor name=
"FindDialogEvent" overloaded=
"no">
15003 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=
0) -
> FindDialogEvent
</autodoc>
15004 <docstring>Events for the FindReplaceDialog
</docstring>
15006 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
15007 <param name=
"id" type=
"int" default=
"0"/>
15010 <method name=
"GetFlags" type=
"int" overloaded=
"no">
15011 <autodoc>GetFlags(self) -
> int
</autodoc>
15012 <docstring>Get the currently selected flags: this is the combination of
15013 wx.FR_DOWN, wx.FR_WHOLEWORD and wx.FR_MATCHCASE flags.
</docstring>
15015 <method name=
"GetFindString" type=
"String" overloaded=
"no">
15016 <autodoc>GetFindString(self) -
> String
</autodoc>
15017 <docstring>Return the string to find (never empty).
</docstring>
15019 <method name=
"GetReplaceString" type=
"String" overloaded=
"no">
15020 <autodoc>GetReplaceString(self) -
> String
</autodoc>
15021 <docstring>Return the string to replace the search string with (only for replace
15022 and replace all events).
</docstring>
15024 <method name=
"GetDialog" type=
"wxFindReplaceDialog" overloaded=
"no">
15025 <autodoc>GetDialog(self) -
> FindReplaceDialog
</autodoc>
15026 <docstring>Return the pointer to the dialog which generated this event.
</docstring>
15028 <method name=
"SetFlags" type=
"" overloaded=
"no">
15029 <autodoc>SetFlags(self, int flags)
</autodoc>
15031 <param name=
"flags" type=
"int" default=
""/>
15034 <method name=
"SetFindString" type=
"" overloaded=
"no">
15035 <autodoc>SetFindString(self, String str)
</autodoc>
15037 <param name=
"str" type=
"String" default=
""/>
15040 <method name=
"SetReplaceString" type=
"" overloaded=
"no">
15041 <autodoc>SetReplaceString(self, String str)
</autodoc>
15043 <param name=
"str" type=
"String" default=
""/>
15047 <class name=
"FindReplaceData" oldname=
"wxFindReplaceData" module=
"_windows">
15048 <docstring>wx.FindReplaceData holds the data for wx.FindReplaceDialog. It is used
15049 to initialize the dialog with the default values and will keep the
15050 last values from the dialog when it is closed. It is also updated each
15051 time a `wx.FindDialogEvent` is generated so instead of using the
15052 `wx.FindDialogEvent` methods you can also directly query this object.
15054 Note that all SetXXX() methods may only be called before showing the
15055 dialog and calling them has no effect later.
15059 ================ ===============================================
15060 wx.FR_DOWN Downward search/replace selected (otherwise,
15063 wx.FR_WHOLEWORD Whole word search/replace selected
15065 wx.FR_MATCHCASE Case sensitive search/replace selected
15066 (otherwise, case insensitive)
15067 ================ ===============================================
15069 <baseclass name=
"Object"/>
15070 <constructor name=
"FindReplaceData" overloaded=
"no">
15071 <autodoc>__init__(self, int flags=
0) -
> FindReplaceData
</autodoc>
15072 <docstring>Constuctor initializes the flags to default value (
0).
</docstring>
15074 <param name=
"flags" type=
"int" default=
"0"/>
15077 <destructor name=
"~wxFindReplaceData" overloaded=
"no">
15078 <autodoc>__del__(self)
</autodoc>
15080 <method name=
"GetFindString" type=
"String" overloaded=
"no">
15081 <autodoc>GetFindString(self) -
> String
</autodoc>
15082 <docstring>Get the string to find.
</docstring>
15084 <method name=
"GetReplaceString" type=
"String" overloaded=
"no">
15085 <autodoc>GetReplaceString(self) -
> String
</autodoc>
15086 <docstring>Get the replacement string.
</docstring>
15088 <method name=
"GetFlags" type=
"int" overloaded=
"no">
15089 <autodoc>GetFlags(self) -
> int
</autodoc>
15090 <docstring>Get the combination of flag values.
</docstring>
15092 <method name=
"SetFlags" type=
"" overloaded=
"no">
15093 <autodoc>SetFlags(self, int flags)
</autodoc>
15094 <docstring>Set the flags to use to initialize the controls of the dialog.
</docstring>
15096 <param name=
"flags" type=
"int" default=
""/>
15099 <method name=
"SetFindString" type=
"" overloaded=
"no">
15100 <autodoc>SetFindString(self, String str)
</autodoc>
15101 <docstring>Set the string to find (used as initial value by the dialog).
</docstring>
15103 <param name=
"str" type=
"String" default=
""/>
15106 <method name=
"SetReplaceString" type=
"" overloaded=
"no">
15107 <autodoc>SetReplaceString(self, String str)
</autodoc>
15108 <docstring>Set the replacement string (used as initial value by the dialog).
</docstring>
15110 <param name=
"str" type=
"String" default=
""/>
15114 <class name=
"FindReplaceDialog" oldname=
"wxFindReplaceDialog" module=
"_windows">
15115 <docstring>wx.FindReplaceDialog is a standard modeless dialog which is used to
15116 allow the user to search for some text (and possibly replace it with
15117 something else). The actual searching is supposed to be done in the
15118 owner window which is the parent of this dialog. Note that it means
15119 that unlike for the other standard dialogs this one must have a parent
15120 window. Also note that there is no way to use this dialog in a modal
15121 way; it is always, by design and implementation, modeless.
15127 ===================== =========================================
15128 wx.FR_REPLACEDIALOG replace dialog (otherwise find dialog)
15130 wx.FR_NOUPDOWN don't allow changing the search direction
15132 wx.FR_NOMATCHCASE don't allow case sensitive searching
15134 wx.FR_NOWHOLEWORD don't allow whole word searching
15135 ===================== =========================================
15137 <baseclass name=
"Dialog"/>
15138 <constructor name=
"FindReplaceDialog" overloaded=
"no">
15139 <autodoc>__init__(self, Window parent, FindReplaceData data, String title,
15140 int style=
0) -
> FindReplaceDialog
</autodoc>
15141 <docstring>Create a FindReplaceDialog. The parent and data parameters must be
15142 non-None. Use Show to display the dialog.
</docstring>
15144 <param name=
"parent" type=
"Window" default=
""/>
15145 <param name=
"data" type=
"FindReplaceData" default=
""/>
15146 <param name=
"title" type=
"String" default=
""/>
15147 <param name=
"style" type=
"int" default=
"0"/>
15150 <constructor name=
"PreFindReplaceDialog" overloaded=
"no">
15151 <autodoc>PreFindReplaceDialog() -
> FindReplaceDialog
</autodoc>
15152 <docstring>Precreate a FindReplaceDialog for
2-phase creation
</docstring>
15154 <method name=
"Create" type=
"bool" overloaded=
"no">
15155 <autodoc>Create(self, Window parent, FindReplaceData data, String title,
15156 int style=
0) -
> bool
</autodoc>
15157 <docstring>Create the dialog, for
2-phase create.
</docstring>
15159 <param name=
"parent" type=
"Window" default=
""/>
15160 <param name=
"data" type=
"FindReplaceData" default=
""/>
15161 <param name=
"title" type=
"String" default=
""/>
15162 <param name=
"style" type=
"int" default=
"0"/>
15165 <method name=
"GetData" type=
"FindReplaceData" overloaded=
"no">
15166 <autodoc>GetData(self) -
> FindReplaceData
</autodoc>
15167 <docstring>Get the FindReplaceData object used by this dialog.
</docstring>
15169 <method name=
"SetData" type=
"" overloaded=
"no">
15170 <autodoc>SetData(self, FindReplaceData data)
</autodoc>
15171 <docstring>Set the FindReplaceData object used by this dialog.
</docstring>
15173 <param name=
"data" type=
"FindReplaceData" default=
""/>
15178 #---------------------------------------------------------------------------
15180 <class name=
"MDIParentFrame" oldname=
"wxMDIParentFrame" module=
"_windows">
15181 <baseclass name=
"Frame"/>
15182 <constructor name=
"MDIParentFrame" overloaded=
"no">
15183 <autodoc>__init__(self, Window parent, int id=-
1, String title=EmptyString,
15184 Point pos=DefaultPosition, Size size=DefaultSize,
15185 long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL,
15186 String name=FrameNameStr) -
> MDIParentFrame
</autodoc>
15188 <param name=
"parent" type=
"Window" default=
""/>
15189 <param name=
"id" type=
"int" default=
"-1"/>
15190 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
15191 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
15192 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
15193 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL"/>
15194 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
15197 <constructor name=
"PreMDIParentFrame" overloaded=
"no">
15198 <autodoc>PreMDIParentFrame() -
> MDIParentFrame
</autodoc>
15200 <method name=
"Create" type=
"bool" overloaded=
"no">
15201 <autodoc>Create(self, Window parent, int id=-
1, String title=EmptyString,
15202 Point pos=DefaultPosition, Size size=DefaultSize,
15203 long style=wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL,
15204 String name=FrameNameStr) -
> bool
</autodoc>
15206 <param name=
"parent" type=
"Window" default=
""/>
15207 <param name=
"id" type=
"int" default=
"-1"/>
15208 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
15209 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
15210 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
15211 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE|wxVSCROLL|wxHSCROLL"/>
15212 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
15215 <method name=
"ActivateNext" type=
"" overloaded=
"no">
15216 <autodoc>ActivateNext(self)
</autodoc>
15218 <method name=
"ActivatePrevious" type=
"" overloaded=
"no">
15219 <autodoc>ActivatePrevious(self)
</autodoc>
15221 <method name=
"ArrangeIcons" type=
"" overloaded=
"no">
15222 <autodoc>ArrangeIcons(self)
</autodoc>
15224 <method name=
"Cascade" type=
"" overloaded=
"no">
15225 <autodoc>Cascade(self)
</autodoc>
15227 <method name=
"GetActiveChild" type=
"wxMDIChildFrame" overloaded=
"no">
15228 <autodoc>GetActiveChild(self) -
> MDIChildFrame
</autodoc>
15230 <method name=
"GetClientWindow" type=
"wxMDIClientWindow" overloaded=
"no">
15231 <autodoc>GetClientWindow(self) -
> MDIClientWindow
</autodoc>
15233 <method name=
"GetToolBar" type=
"Window" overloaded=
"no">
15234 <autodoc>GetToolBar(self) -
> Window
</autodoc>
15236 <method name=
"Tile" type=
"" overloaded=
"no">
15237 <autodoc>Tile(self)
</autodoc>
15240 <class name=
"MDIChildFrame" oldname=
"wxMDIChildFrame" module=
"_windows">
15241 <baseclass name=
"Frame"/>
15242 <constructor name=
"MDIChildFrame" overloaded=
"no">
15243 <autodoc>__init__(self, MDIParentFrame parent, int id=-
1, String title=EmptyString,
15244 Point pos=DefaultPosition, Size size=DefaultSize,
15245 long style=DEFAULT_FRAME_STYLE,
15246 String name=FrameNameStr) -
> MDIChildFrame
</autodoc>
15248 <param name=
"parent" type=
"MDIParentFrame" default=
""/>
15249 <param name=
"id" type=
"int" default=
"-1"/>
15250 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
15251 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
15252 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
15253 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE"/>
15254 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
15257 <constructor name=
"PreMDIChildFrame" overloaded=
"no">
15258 <autodoc>PreMDIChildFrame() -
> MDIChildFrame
</autodoc>
15260 <method name=
"Create" type=
"bool" overloaded=
"no">
15261 <autodoc>Create(self, MDIParentFrame parent, int id=-
1, String title=EmptyString,
15262 Point pos=DefaultPosition, Size size=DefaultSize,
15263 long style=DEFAULT_FRAME_STYLE,
15264 String name=FrameNameStr) -
> bool
</autodoc>
15266 <param name=
"parent" type=
"MDIParentFrame" default=
""/>
15267 <param name=
"id" type=
"int" default=
"-1"/>
15268 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
15269 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
15270 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
15271 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE"/>
15272 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
15275 <method name=
"Activate" type=
"" overloaded=
"no">
15276 <autodoc>Activate(self)
</autodoc>
15278 <method name=
"Maximize" type=
"" overloaded=
"no">
15279 <autodoc>Maximize(self, bool maximize)
</autodoc>
15281 <param name=
"maximize" type=
"bool" default=
""/>
15284 <method name=
"Restore" type=
"" overloaded=
"no">
15285 <autodoc>Restore(self)
</autodoc>
15288 <class name=
"MDIClientWindow" oldname=
"wxMDIClientWindow" module=
"_windows">
15289 <baseclass name=
"Window"/>
15290 <constructor name=
"MDIClientWindow" overloaded=
"no">
15291 <autodoc>__init__(self, MDIParentFrame parent, long style=
0) -
> MDIClientWindow
</autodoc>
15293 <param name=
"parent" type=
"MDIParentFrame" default=
""/>
15294 <param name=
"style" type=
"long" default=
"0"/>
15297 <constructor name=
"PreMDIClientWindow" overloaded=
"no">
15298 <autodoc>PreMDIClientWindow() -
> MDIClientWindow
</autodoc>
15300 <method name=
"Create" type=
"bool" overloaded=
"no">
15301 <autodoc>Create(self, MDIParentFrame parent, long style=
0) -
> bool
</autodoc>
15303 <param name=
"parent" type=
"MDIParentFrame" default=
""/>
15304 <param name=
"style" type=
"long" default=
"0"/>
15309 #---------------------------------------------------------------------------
15311 <class name=
"PyWindow" oldname=
"wxPyWindow" module=
"_windows">
15312 <baseclass name=
"Window"/>
15313 <constructor name=
"PyWindow" overloaded=
"no">
15314 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
15315 Size size=DefaultSize, long style=
0, String name=PanelNameStr) -
> PyWindow
</autodoc>
15317 <param name=
"parent" type=
"Window" default=
""/>
15318 <param name=
"id" type=
"int" default=
"-1"/>
15319 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
15320 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
15321 <param name=
"style" type=
"long" default=
"0"/>
15322 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
15325 <constructor name=
"PrePyWindow" overloaded=
"no">
15326 <autodoc>PrePyWindow() -
> PyWindow
</autodoc>
15328 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
15329 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
15331 <param name=
"self" type=
"PyObject" default=
""/>
15332 <param name=
"_class" type=
"PyObject" default=
""/>
15335 <method name=
"SetBestSize" type=
"" overloaded=
"no">
15336 <autodoc>SetBestSize(self, Size size)
</autodoc>
15338 <param name=
"size" type=
"Size" default=
""/>
15341 <method name=
"base_DoMoveWindow" type=
"" overloaded=
"no">
15342 <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)
</autodoc>
15344 <param name=
"x" type=
"int" default=
""/>
15345 <param name=
"y" type=
"int" default=
""/>
15346 <param name=
"width" type=
"int" default=
""/>
15347 <param name=
"height" type=
"int" default=
""/>
15350 <method name=
"base_DoSetSize" type=
"" overloaded=
"no">
15351 <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
</autodoc>
15353 <param name=
"x" type=
"int" default=
""/>
15354 <param name=
"y" type=
"int" default=
""/>
15355 <param name=
"width" type=
"int" default=
""/>
15356 <param name=
"height" type=
"int" default=
""/>
15357 <param name=
"sizeFlags" type=
"int" default=
"wxSIZE_AUTO"/>
15360 <method name=
"base_DoSetClientSize" type=
"" overloaded=
"no">
15361 <autodoc>base_DoSetClientSize(self, int width, int height)
</autodoc>
15363 <param name=
"width" type=
"int" default=
""/>
15364 <param name=
"height" type=
"int" default=
""/>
15367 <method name=
"base_DoSetVirtualSize" type=
"" overloaded=
"no">
15368 <autodoc>base_DoSetVirtualSize(self, int x, int y)
</autodoc>
15370 <param name=
"x" type=
"int" default=
""/>
15371 <param name=
"y" type=
"int" default=
""/>
15374 <method name=
"base_DoGetSize" type=
"" overloaded=
"no">
15375 <autodoc>base_DoGetSize() -
> (width, height)
</autodoc>
15377 <param name=
"OUTPUT" type=
"int" default=
""/>
15378 <param name=
"OUTPUT" type=
"int" default=
""/>
15381 <method name=
"base_DoGetClientSize" type=
"" overloaded=
"no">
15382 <autodoc>base_DoGetClientSize() -
> (width, height)
</autodoc>
15384 <param name=
"OUTPUT" type=
"int" default=
""/>
15385 <param name=
"OUTPUT" type=
"int" default=
""/>
15388 <method name=
"base_DoGetPosition" type=
"" overloaded=
"no">
15389 <autodoc>base_DoGetPosition() -
> (x,y)
</autodoc>
15391 <param name=
"OUTPUT" type=
"int" default=
""/>
15392 <param name=
"OUTPUT" type=
"int" default=
""/>
15395 <method name=
"base_DoGetVirtualSize" type=
"Size" overloaded=
"no">
15396 <autodoc>base_DoGetVirtualSize(self) -
> Size
</autodoc>
15398 <method name=
"base_DoGetBestSize" type=
"Size" overloaded=
"no">
15399 <autodoc>base_DoGetBestSize(self) -
> Size
</autodoc>
15401 <method name=
"base_InitDialog" type=
"" overloaded=
"no">
15402 <autodoc>base_InitDialog(self)
</autodoc>
15404 <method name=
"base_TransferDataToWindow" type=
"bool" overloaded=
"no">
15405 <autodoc>base_TransferDataToWindow(self) -
> bool
</autodoc>
15407 <method name=
"base_TransferDataFromWindow" type=
"bool" overloaded=
"no">
15408 <autodoc>base_TransferDataFromWindow(self) -
> bool
</autodoc>
15410 <method name=
"base_Validate" type=
"bool" overloaded=
"no">
15411 <autodoc>base_Validate(self) -
> bool
</autodoc>
15413 <method name=
"base_AcceptsFocus" type=
"bool" overloaded=
"no">
15414 <autodoc>base_AcceptsFocus(self) -
> bool
</autodoc>
15416 <method name=
"base_AcceptsFocusFromKeyboard" type=
"bool" overloaded=
"no">
15417 <autodoc>base_AcceptsFocusFromKeyboard(self) -
> bool
</autodoc>
15419 <method name=
"base_GetMaxSize" type=
"Size" overloaded=
"no">
15420 <autodoc>base_GetMaxSize(self) -
> Size
</autodoc>
15422 <method name=
"base_AddChild" type=
"" overloaded=
"no">
15423 <autodoc>base_AddChild(self, Window child)
</autodoc>
15425 <param name=
"child" type=
"Window" default=
""/>
15428 <method name=
"base_RemoveChild" type=
"" overloaded=
"no">
15429 <autodoc>base_RemoveChild(self, Window child)
</autodoc>
15431 <param name=
"child" type=
"Window" default=
""/>
15434 <method name=
"base_ShouldInheritColours" type=
"bool" overloaded=
"no">
15435 <autodoc>base_ShouldInheritColours(self) -
> bool
</autodoc>
15437 <method name=
"base_ApplyParentThemeBackground" type=
"" overloaded=
"no">
15438 <autodoc>base_ApplyParentThemeBackground(self, Colour c)
</autodoc>
15440 <param name=
"c" type=
"Colour" default=
""/>
15443 <method name=
"base_GetDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
15444 <autodoc>base_GetDefaultAttributes(self) -
> VisualAttributes
</autodoc>
15447 <class name=
"PyPanel" oldname=
"wxPyPanel" module=
"_windows">
15448 <baseclass name=
"Panel"/>
15449 <constructor name=
"PyPanel" overloaded=
"no">
15450 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
15451 Size size=DefaultSize, long style=
0, String name=PanelNameStr) -
> PyPanel
</autodoc>
15453 <param name=
"parent" type=
"Window" default=
""/>
15454 <param name=
"id" type=
"int" default=
"-1"/>
15455 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
15456 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
15457 <param name=
"style" type=
"long" default=
"0"/>
15458 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
15461 <constructor name=
"PrePyPanel" overloaded=
"no">
15462 <autodoc>PrePyPanel() -
> PyPanel
</autodoc>
15464 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
15465 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
15467 <param name=
"self" type=
"PyObject" default=
""/>
15468 <param name=
"_class" type=
"PyObject" default=
""/>
15471 <method name=
"SetBestSize" type=
"" overloaded=
"no">
15472 <autodoc>SetBestSize(self, Size size)
</autodoc>
15474 <param name=
"size" type=
"Size" default=
""/>
15477 <method name=
"base_DoMoveWindow" type=
"" overloaded=
"no">
15478 <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)
</autodoc>
15480 <param name=
"x" type=
"int" default=
""/>
15481 <param name=
"y" type=
"int" default=
""/>
15482 <param name=
"width" type=
"int" default=
""/>
15483 <param name=
"height" type=
"int" default=
""/>
15486 <method name=
"base_DoSetSize" type=
"" overloaded=
"no">
15487 <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
</autodoc>
15489 <param name=
"x" type=
"int" default=
""/>
15490 <param name=
"y" type=
"int" default=
""/>
15491 <param name=
"width" type=
"int" default=
""/>
15492 <param name=
"height" type=
"int" default=
""/>
15493 <param name=
"sizeFlags" type=
"int" default=
"wxSIZE_AUTO"/>
15496 <method name=
"base_DoSetClientSize" type=
"" overloaded=
"no">
15497 <autodoc>base_DoSetClientSize(self, int width, int height)
</autodoc>
15499 <param name=
"width" type=
"int" default=
""/>
15500 <param name=
"height" type=
"int" default=
""/>
15503 <method name=
"base_DoSetVirtualSize" type=
"" overloaded=
"no">
15504 <autodoc>base_DoSetVirtualSize(self, int x, int y)
</autodoc>
15506 <param name=
"x" type=
"int" default=
""/>
15507 <param name=
"y" type=
"int" default=
""/>
15510 <method name=
"base_DoGetSize" type=
"" overloaded=
"no">
15511 <autodoc>base_DoGetSize() -
> (width, height)
</autodoc>
15513 <param name=
"OUTPUT" type=
"int" default=
""/>
15514 <param name=
"OUTPUT" type=
"int" default=
""/>
15517 <method name=
"base_DoGetClientSize" type=
"" overloaded=
"no">
15518 <autodoc>base_DoGetClientSize() -
> (width, height)
</autodoc>
15520 <param name=
"OUTPUT" type=
"int" default=
""/>
15521 <param name=
"OUTPUT" type=
"int" default=
""/>
15524 <method name=
"base_DoGetPosition" type=
"" overloaded=
"no">
15525 <autodoc>base_DoGetPosition() -
> (x,y)
</autodoc>
15527 <param name=
"OUTPUT" type=
"int" default=
""/>
15528 <param name=
"OUTPUT" type=
"int" default=
""/>
15531 <method name=
"base_DoGetVirtualSize" type=
"Size" overloaded=
"no">
15532 <autodoc>base_DoGetVirtualSize(self) -
> Size
</autodoc>
15534 <method name=
"base_DoGetBestSize" type=
"Size" overloaded=
"no">
15535 <autodoc>base_DoGetBestSize(self) -
> Size
</autodoc>
15537 <method name=
"base_InitDialog" type=
"" overloaded=
"no">
15538 <autodoc>base_InitDialog(self)
</autodoc>
15540 <method name=
"base_TransferDataToWindow" type=
"bool" overloaded=
"no">
15541 <autodoc>base_TransferDataToWindow(self) -
> bool
</autodoc>
15543 <method name=
"base_TransferDataFromWindow" type=
"bool" overloaded=
"no">
15544 <autodoc>base_TransferDataFromWindow(self) -
> bool
</autodoc>
15546 <method name=
"base_Validate" type=
"bool" overloaded=
"no">
15547 <autodoc>base_Validate(self) -
> bool
</autodoc>
15549 <method name=
"base_AcceptsFocus" type=
"bool" overloaded=
"no">
15550 <autodoc>base_AcceptsFocus(self) -
> bool
</autodoc>
15552 <method name=
"base_AcceptsFocusFromKeyboard" type=
"bool" overloaded=
"no">
15553 <autodoc>base_AcceptsFocusFromKeyboard(self) -
> bool
</autodoc>
15555 <method name=
"base_GetMaxSize" type=
"Size" overloaded=
"no">
15556 <autodoc>base_GetMaxSize(self) -
> Size
</autodoc>
15558 <method name=
"base_AddChild" type=
"" overloaded=
"no">
15559 <autodoc>base_AddChild(self, Window child)
</autodoc>
15561 <param name=
"child" type=
"Window" default=
""/>
15564 <method name=
"base_RemoveChild" type=
"" overloaded=
"no">
15565 <autodoc>base_RemoveChild(self, Window child)
</autodoc>
15567 <param name=
"child" type=
"Window" default=
""/>
15570 <method name=
"base_ShouldInheritColours" type=
"bool" overloaded=
"no">
15571 <autodoc>base_ShouldInheritColours(self) -
> bool
</autodoc>
15573 <method name=
"base_ApplyParentThemeBackground" type=
"" overloaded=
"no">
15574 <autodoc>base_ApplyParentThemeBackground(self, Colour c)
</autodoc>
15576 <param name=
"c" type=
"Colour" default=
""/>
15579 <method name=
"base_GetDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
15580 <autodoc>base_GetDefaultAttributes(self) -
> VisualAttributes
</autodoc>
15583 <class name=
"PyScrolledWindow" oldname=
"wxPyScrolledWindow" module=
"_windows">
15584 <baseclass name=
"ScrolledWindow"/>
15585 <constructor name=
"PyScrolledWindow" overloaded=
"no">
15586 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
15587 Size size=DefaultSize, long style=
0, String name=PanelNameStr) -
> PyScrolledWindow
</autodoc>
15589 <param name=
"parent" type=
"Window" default=
""/>
15590 <param name=
"id" type=
"int" default=
"-1"/>
15591 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
15592 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
15593 <param name=
"style" type=
"long" default=
"0"/>
15594 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
15597 <constructor name=
"PrePyScrolledWindow" overloaded=
"no">
15598 <autodoc>PrePyScrolledWindow() -
> PyScrolledWindow
</autodoc>
15600 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
15601 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
15603 <param name=
"self" type=
"PyObject" default=
""/>
15604 <param name=
"_class" type=
"PyObject" default=
""/>
15607 <method name=
"SetBestSize" type=
"" overloaded=
"no">
15608 <autodoc>SetBestSize(self, Size size)
</autodoc>
15610 <param name=
"size" type=
"Size" default=
""/>
15613 <method name=
"base_DoMoveWindow" type=
"" overloaded=
"no">
15614 <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)
</autodoc>
15616 <param name=
"x" type=
"int" default=
""/>
15617 <param name=
"y" type=
"int" default=
""/>
15618 <param name=
"width" type=
"int" default=
""/>
15619 <param name=
"height" type=
"int" default=
""/>
15622 <method name=
"base_DoSetSize" type=
"" overloaded=
"no">
15623 <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
</autodoc>
15625 <param name=
"x" type=
"int" default=
""/>
15626 <param name=
"y" type=
"int" default=
""/>
15627 <param name=
"width" type=
"int" default=
""/>
15628 <param name=
"height" type=
"int" default=
""/>
15629 <param name=
"sizeFlags" type=
"int" default=
"wxSIZE_AUTO"/>
15632 <method name=
"base_DoSetClientSize" type=
"" overloaded=
"no">
15633 <autodoc>base_DoSetClientSize(self, int width, int height)
</autodoc>
15635 <param name=
"width" type=
"int" default=
""/>
15636 <param name=
"height" type=
"int" default=
""/>
15639 <method name=
"base_DoSetVirtualSize" type=
"" overloaded=
"no">
15640 <autodoc>base_DoSetVirtualSize(self, int x, int y)
</autodoc>
15642 <param name=
"x" type=
"int" default=
""/>
15643 <param name=
"y" type=
"int" default=
""/>
15646 <method name=
"base_DoGetSize" type=
"" overloaded=
"no">
15647 <autodoc>base_DoGetSize() -
> (width, height)
</autodoc>
15649 <param name=
"OUTPUT" type=
"int" default=
""/>
15650 <param name=
"OUTPUT" type=
"int" default=
""/>
15653 <method name=
"base_DoGetClientSize" type=
"" overloaded=
"no">
15654 <autodoc>base_DoGetClientSize() -
> (width, height)
</autodoc>
15656 <param name=
"OUTPUT" type=
"int" default=
""/>
15657 <param name=
"OUTPUT" type=
"int" default=
""/>
15660 <method name=
"base_DoGetPosition" type=
"" overloaded=
"no">
15661 <autodoc>base_DoGetPosition() -
> (x,y)
</autodoc>
15663 <param name=
"OUTPUT" type=
"int" default=
""/>
15664 <param name=
"OUTPUT" type=
"int" default=
""/>
15667 <method name=
"base_DoGetVirtualSize" type=
"Size" overloaded=
"no">
15668 <autodoc>base_DoGetVirtualSize(self) -
> Size
</autodoc>
15670 <method name=
"base_DoGetBestSize" type=
"Size" overloaded=
"no">
15671 <autodoc>base_DoGetBestSize(self) -
> Size
</autodoc>
15673 <method name=
"base_InitDialog" type=
"" overloaded=
"no">
15674 <autodoc>base_InitDialog(self)
</autodoc>
15676 <method name=
"base_TransferDataToWindow" type=
"bool" overloaded=
"no">
15677 <autodoc>base_TransferDataToWindow(self) -
> bool
</autodoc>
15679 <method name=
"base_TransferDataFromWindow" type=
"bool" overloaded=
"no">
15680 <autodoc>base_TransferDataFromWindow(self) -
> bool
</autodoc>
15682 <method name=
"base_Validate" type=
"bool" overloaded=
"no">
15683 <autodoc>base_Validate(self) -
> bool
</autodoc>
15685 <method name=
"base_AcceptsFocus" type=
"bool" overloaded=
"no">
15686 <autodoc>base_AcceptsFocus(self) -
> bool
</autodoc>
15688 <method name=
"base_AcceptsFocusFromKeyboard" type=
"bool" overloaded=
"no">
15689 <autodoc>base_AcceptsFocusFromKeyboard(self) -
> bool
</autodoc>
15691 <method name=
"base_GetMaxSize" type=
"Size" overloaded=
"no">
15692 <autodoc>base_GetMaxSize(self) -
> Size
</autodoc>
15694 <method name=
"base_AddChild" type=
"" overloaded=
"no">
15695 <autodoc>base_AddChild(self, Window child)
</autodoc>
15697 <param name=
"child" type=
"Window" default=
""/>
15700 <method name=
"base_RemoveChild" type=
"" overloaded=
"no">
15701 <autodoc>base_RemoveChild(self, Window child)
</autodoc>
15703 <param name=
"child" type=
"Window" default=
""/>
15706 <method name=
"base_ShouldInheritColours" type=
"bool" overloaded=
"no">
15707 <autodoc>base_ShouldInheritColours(self) -
> bool
</autodoc>
15709 <method name=
"base_ApplyParentThemeBackground" type=
"" overloaded=
"no">
15710 <autodoc>base_ApplyParentThemeBackground(self, Colour c)
</autodoc>
15712 <param name=
"c" type=
"Colour" default=
""/>
15715 <method name=
"base_GetDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
15716 <autodoc>base_GetDefaultAttributes(self) -
> VisualAttributes
</autodoc>
15720 #---------------------------------------------------------------------------
15722 <class name=
"PrintData" oldname=
"wxPrintData" module=
"_windows">
15723 <baseclass name=
"Object"/>
15724 <constructor name=
"PrintData" overloaded=
"yes"/>
15725 <constructor name=
"PrintData" overloaded=
"yes">
15726 <autodoc>__init__(self) -
> PrintData
15727 __init__(self, PrintData data) -
> PrintData
</autodoc>
15729 <param name=
"data" type=
"PrintData" default=
""/>
15732 <destructor name=
"~wxPrintData" overloaded=
"no">
15733 <autodoc>__del__(self)
</autodoc>
15735 <method name=
"GetNoCopies" type=
"int" overloaded=
"no">
15736 <autodoc>GetNoCopies(self) -
> int
</autodoc>
15738 <method name=
"GetCollate" type=
"bool" overloaded=
"no">
15739 <autodoc>GetCollate(self) -
> bool
</autodoc>
15741 <method name=
"GetOrientation" type=
"int" overloaded=
"no">
15742 <autodoc>GetOrientation(self) -
> int
</autodoc>
15744 <method name=
"Ok" type=
"bool" overloaded=
"no">
15745 <autodoc>Ok(self) -
> bool
</autodoc>
15747 <method name=
"GetPrinterName" type=
"String" overloaded=
"no">
15748 <autodoc>GetPrinterName(self) -
> String
</autodoc>
15750 <method name=
"GetColour" type=
"bool" overloaded=
"no">
15751 <autodoc>GetColour(self) -
> bool
</autodoc>
15753 <method name=
"GetDuplex" type=
"wxDuplexMode" overloaded=
"no">
15754 <autodoc>GetDuplex(self) -
> int
</autodoc>
15756 <method name=
"GetPaperId" type=
"wxPaperSize" overloaded=
"no">
15757 <autodoc>GetPaperId(self) -
> int
</autodoc>
15759 <method name=
"GetPaperSize" type=
"Size" overloaded=
"no">
15760 <autodoc>GetPaperSize(self) -
> Size
</autodoc>
15762 <method name=
"GetQuality" type=
"int" overloaded=
"no">
15763 <autodoc>GetQuality(self) -
> int
</autodoc>
15765 <method name=
"SetNoCopies" type=
"" overloaded=
"no">
15766 <autodoc>SetNoCopies(self, int v)
</autodoc>
15768 <param name=
"v" type=
"int" default=
""/>
15771 <method name=
"SetCollate" type=
"" overloaded=
"no">
15772 <autodoc>SetCollate(self, bool flag)
</autodoc>
15774 <param name=
"flag" type=
"bool" default=
""/>
15777 <method name=
"SetOrientation" type=
"" overloaded=
"no">
15778 <autodoc>SetOrientation(self, int orient)
</autodoc>
15780 <param name=
"orient" type=
"int" default=
""/>
15783 <method name=
"SetPrinterName" type=
"" overloaded=
"no">
15784 <autodoc>SetPrinterName(self, String name)
</autodoc>
15786 <param name=
"name" type=
"String" default=
""/>
15789 <method name=
"SetColour" type=
"" overloaded=
"no">
15790 <autodoc>SetColour(self, bool colour)
</autodoc>
15792 <param name=
"colour" type=
"bool" default=
""/>
15795 <method name=
"SetDuplex" type=
"" overloaded=
"no">
15796 <autodoc>SetDuplex(self, int duplex)
</autodoc>
15798 <param name=
"duplex" type=
"wxDuplexMode" default=
""/>
15801 <method name=
"SetPaperId" type=
"" overloaded=
"no">
15802 <autodoc>SetPaperId(self, int sizeId)
</autodoc>
15804 <param name=
"sizeId" type=
"wxPaperSize" default=
""/>
15807 <method name=
"SetPaperSize" type=
"" overloaded=
"no">
15808 <autodoc>SetPaperSize(self, Size sz)
</autodoc>
15810 <param name=
"sz" type=
"Size" default=
""/>
15813 <method name=
"SetQuality" type=
"" overloaded=
"no">
15814 <autodoc>SetQuality(self, int quality)
</autodoc>
15816 <param name=
"quality" type=
"int" default=
""/>
15819 <method name=
"GetPrinterCommand" type=
"String" overloaded=
"no">
15820 <autodoc>GetPrinterCommand(self) -
> String
</autodoc>
15822 <method name=
"GetPrinterOptions" type=
"String" overloaded=
"no">
15823 <autodoc>GetPrinterOptions(self) -
> String
</autodoc>
15825 <method name=
"GetPreviewCommand" type=
"String" overloaded=
"no">
15826 <autodoc>GetPreviewCommand(self) -
> String
</autodoc>
15828 <method name=
"GetFilename" type=
"String" overloaded=
"no">
15829 <autodoc>GetFilename(self) -
> String
</autodoc>
15831 <method name=
"GetFontMetricPath" type=
"String" overloaded=
"no">
15832 <autodoc>GetFontMetricPath(self) -
> String
</autodoc>
15834 <method name=
"GetPrinterScaleX" type=
"double" overloaded=
"no">
15835 <autodoc>GetPrinterScaleX(self) -
> double
</autodoc>
15837 <method name=
"GetPrinterScaleY" type=
"double" overloaded=
"no">
15838 <autodoc>GetPrinterScaleY(self) -
> double
</autodoc>
15840 <method name=
"GetPrinterTranslateX" type=
"long" overloaded=
"no">
15841 <autodoc>GetPrinterTranslateX(self) -
> long
</autodoc>
15843 <method name=
"GetPrinterTranslateY" type=
"long" overloaded=
"no">
15844 <autodoc>GetPrinterTranslateY(self) -
> long
</autodoc>
15846 <method name=
"GetPrintMode" type=
"wxPrintMode" overloaded=
"no">
15847 <autodoc>GetPrintMode(self) -
> int
</autodoc>
15849 <method name=
"SetPrinterCommand" type=
"" overloaded=
"no">
15850 <autodoc>SetPrinterCommand(self, String command)
</autodoc>
15852 <param name=
"command" type=
"String" default=
""/>
15855 <method name=
"SetPrinterOptions" type=
"" overloaded=
"no">
15856 <autodoc>SetPrinterOptions(self, String options)
</autodoc>
15858 <param name=
"options" type=
"String" default=
""/>
15861 <method name=
"SetPreviewCommand" type=
"" overloaded=
"no">
15862 <autodoc>SetPreviewCommand(self, String command)
</autodoc>
15864 <param name=
"command" type=
"String" default=
""/>
15867 <method name=
"SetFilename" type=
"" overloaded=
"no">
15868 <autodoc>SetFilename(self, String filename)
</autodoc>
15870 <param name=
"filename" type=
"String" default=
""/>
15873 <method name=
"SetFontMetricPath" type=
"" overloaded=
"no">
15874 <autodoc>SetFontMetricPath(self, String path)
</autodoc>
15876 <param name=
"path" type=
"String" default=
""/>
15879 <method name=
"SetPrinterScaleX" type=
"" overloaded=
"no">
15880 <autodoc>SetPrinterScaleX(self, double x)
</autodoc>
15882 <param name=
"x" type=
"double" default=
""/>
15885 <method name=
"SetPrinterScaleY" type=
"" overloaded=
"no">
15886 <autodoc>SetPrinterScaleY(self, double y)
</autodoc>
15888 <param name=
"y" type=
"double" default=
""/>
15891 <method name=
"SetPrinterScaling" type=
"" overloaded=
"no">
15892 <autodoc>SetPrinterScaling(self, double x, double y)
</autodoc>
15894 <param name=
"x" type=
"double" default=
""/>
15895 <param name=
"y" type=
"double" default=
""/>
15898 <method name=
"SetPrinterTranslateX" type=
"" overloaded=
"no">
15899 <autodoc>SetPrinterTranslateX(self, long x)
</autodoc>
15901 <param name=
"x" type=
"long" default=
""/>
15904 <method name=
"SetPrinterTranslateY" type=
"" overloaded=
"no">
15905 <autodoc>SetPrinterTranslateY(self, long y)
</autodoc>
15907 <param name=
"y" type=
"long" default=
""/>
15910 <method name=
"SetPrinterTranslation" type=
"" overloaded=
"no">
15911 <autodoc>SetPrinterTranslation(self, long x, long y)
</autodoc>
15913 <param name=
"x" type=
"long" default=
""/>
15914 <param name=
"y" type=
"long" default=
""/>
15917 <method name=
"SetPrintMode" type=
"" overloaded=
"no">
15918 <autodoc>SetPrintMode(self, int printMode)
</autodoc>
15920 <param name=
"printMode" type=
"wxPrintMode" default=
""/>
15923 <method name=
"GetOutputStream" type=
"OutputStream" overloaded=
"no">
15924 <autodoc>GetOutputStream(self) -
> OutputStream
</autodoc>
15926 <method name=
"SetOutputStream" type=
"" overloaded=
"no">
15927 <autodoc>SetOutputStream(self, OutputStream outputstream)
</autodoc>
15929 <param name=
"outputstream" type=
"OutputStream" default=
""/>
15933 <class name=
"PageSetupDialogData" oldname=
"wxPageSetupDialogData" module=
"_windows">
15934 <baseclass name=
"Object"/>
15935 <constructor name=
"PageSetupDialogData" overloaded=
"yes"/>
15936 <constructor name=
"PageSetupDialogData" overloaded=
"yes">
15937 <autodoc>__init__(self) -
> PageSetupDialogData
15938 __init__(self, PageSetupDialogData data) -
> PageSetupDialogData
</autodoc>
15940 <param name=
"data" type=
"PageSetupDialogData" default=
""/>
15943 <destructor name=
"~wxPageSetupDialogData" overloaded=
"no">
15944 <autodoc>__del__(self)
</autodoc>
15946 <method name=
"EnableHelp" type=
"" overloaded=
"no">
15947 <autodoc>EnableHelp(self, bool flag)
</autodoc>
15949 <param name=
"flag" type=
"bool" default=
""/>
15952 <method name=
"EnableMargins" type=
"" overloaded=
"no">
15953 <autodoc>EnableMargins(self, bool flag)
</autodoc>
15955 <param name=
"flag" type=
"bool" default=
""/>
15958 <method name=
"EnableOrientation" type=
"" overloaded=
"no">
15959 <autodoc>EnableOrientation(self, bool flag)
</autodoc>
15961 <param name=
"flag" type=
"bool" default=
""/>
15964 <method name=
"EnablePaper" type=
"" overloaded=
"no">
15965 <autodoc>EnablePaper(self, bool flag)
</autodoc>
15967 <param name=
"flag" type=
"bool" default=
""/>
15970 <method name=
"EnablePrinter" type=
"" overloaded=
"no">
15971 <autodoc>EnablePrinter(self, bool flag)
</autodoc>
15973 <param name=
"flag" type=
"bool" default=
""/>
15976 <method name=
"GetDefaultMinMargins" type=
"bool" overloaded=
"no">
15977 <autodoc>GetDefaultMinMargins(self) -
> bool
</autodoc>
15979 <method name=
"GetEnableMargins" type=
"bool" overloaded=
"no">
15980 <autodoc>GetEnableMargins(self) -
> bool
</autodoc>
15982 <method name=
"GetEnableOrientation" type=
"bool" overloaded=
"no">
15983 <autodoc>GetEnableOrientation(self) -
> bool
</autodoc>
15985 <method name=
"GetEnablePaper" type=
"bool" overloaded=
"no">
15986 <autodoc>GetEnablePaper(self) -
> bool
</autodoc>
15988 <method name=
"GetEnablePrinter" type=
"bool" overloaded=
"no">
15989 <autodoc>GetEnablePrinter(self) -
> bool
</autodoc>
15991 <method name=
"GetEnableHelp" type=
"bool" overloaded=
"no">
15992 <autodoc>GetEnableHelp(self) -
> bool
</autodoc>
15994 <method name=
"GetDefaultInfo" type=
"bool" overloaded=
"no">
15995 <autodoc>GetDefaultInfo(self) -
> bool
</autodoc>
15997 <method name=
"GetMarginTopLeft" type=
"Point" overloaded=
"no">
15998 <autodoc>GetMarginTopLeft(self) -
> Point
</autodoc>
16000 <method name=
"GetMarginBottomRight" type=
"Point" overloaded=
"no">
16001 <autodoc>GetMarginBottomRight(self) -
> Point
</autodoc>
16003 <method name=
"GetMinMarginTopLeft" type=
"Point" overloaded=
"no">
16004 <autodoc>GetMinMarginTopLeft(self) -
> Point
</autodoc>
16006 <method name=
"GetMinMarginBottomRight" type=
"Point" overloaded=
"no">
16007 <autodoc>GetMinMarginBottomRight(self) -
> Point
</autodoc>
16009 <method name=
"GetPaperId" type=
"wxPaperSize" overloaded=
"no">
16010 <autodoc>GetPaperId(self) -
> int
</autodoc>
16012 <method name=
"GetPaperSize" type=
"Size" overloaded=
"no">
16013 <autodoc>GetPaperSize(self) -
> Size
</autodoc>
16015 <method name=
"GetPrintData" type=
"PrintData" overloaded=
"no">
16016 <autodoc>GetPrintData(self) -
> PrintData
</autodoc>
16018 <method name=
"Ok" type=
"bool" overloaded=
"no">
16019 <autodoc>Ok(self) -
> bool
</autodoc>
16021 <method name=
"SetDefaultInfo" type=
"" overloaded=
"no">
16022 <autodoc>SetDefaultInfo(self, bool flag)
</autodoc>
16024 <param name=
"flag" type=
"bool" default=
""/>
16027 <method name=
"SetDefaultMinMargins" type=
"" overloaded=
"no">
16028 <autodoc>SetDefaultMinMargins(self, bool flag)
</autodoc>
16030 <param name=
"flag" type=
"bool" default=
""/>
16033 <method name=
"SetMarginTopLeft" type=
"" overloaded=
"no">
16034 <autodoc>SetMarginTopLeft(self, Point pt)
</autodoc>
16036 <param name=
"pt" type=
"Point" default=
""/>
16039 <method name=
"SetMarginBottomRight" type=
"" overloaded=
"no">
16040 <autodoc>SetMarginBottomRight(self, Point pt)
</autodoc>
16042 <param name=
"pt" type=
"Point" default=
""/>
16045 <method name=
"SetMinMarginTopLeft" type=
"" overloaded=
"no">
16046 <autodoc>SetMinMarginTopLeft(self, Point pt)
</autodoc>
16048 <param name=
"pt" type=
"Point" default=
""/>
16051 <method name=
"SetMinMarginBottomRight" type=
"" overloaded=
"no">
16052 <autodoc>SetMinMarginBottomRight(self, Point pt)
</autodoc>
16054 <param name=
"pt" type=
"Point" default=
""/>
16057 <method name=
"SetPaperId" type=
"" overloaded=
"no">
16058 <autodoc>SetPaperId(self, int id)
</autodoc>
16060 <param name=
"id" type=
"wxPaperSize" default=
""/>
16063 <method name=
"SetPaperSize" type=
"" overloaded=
"no">
16064 <autodoc>SetPaperSize(self, Size size)
</autodoc>
16066 <param name=
"size" type=
"Size" default=
""/>
16069 <method name=
"SetPrintData" type=
"" overloaded=
"no">
16070 <autodoc>SetPrintData(self, PrintData printData)
</autodoc>
16072 <param name=
"printData" type=
"PrintData" default=
""/>
16076 <class name=
"PageSetupDialog" oldname=
"wxPageSetupDialog" module=
"_windows">
16077 <baseclass name=
"Dialog"/>
16078 <constructor name=
"PageSetupDialog" overloaded=
"no">
16079 <autodoc>__init__(self, Window parent, PageSetupDialogData data=None) -
> PageSetupDialog
</autodoc>
16081 <param name=
"parent" type=
"Window" default=
""/>
16082 <param name=
"data" type=
"PageSetupDialogData" default=
"NULL"/>
16085 <method name=
"GetPageSetupData" type=
"PageSetupDialogData" overloaded=
"no">
16086 <autodoc>GetPageSetupData(self) -
> PageSetupDialogData
</autodoc>
16088 <method name=
"ShowModal" type=
"int" overloaded=
"no">
16089 <autodoc>ShowModal(self) -
> int
</autodoc>
16092 <class name=
"PrintDialogData" oldname=
"wxPrintDialogData" module=
"_windows">
16093 <baseclass name=
"Object"/>
16094 <constructor name=
"PrintDialogData" overloaded=
"yes"/>
16095 <constructor name=
"PrintDialogData" overloaded=
"yes">
16096 <autodoc>__init__(self) -
> PrintDialogData
16097 __init__(self, PrintData printData) -
> PrintDialogData
</autodoc>
16099 <param name=
"printData" type=
"PrintData" default=
""/>
16102 <destructor name=
"~wxPrintDialogData" overloaded=
"no">
16103 <autodoc>__del__(self)
</autodoc>
16105 <method name=
"GetFromPage" type=
"int" overloaded=
"no">
16106 <autodoc>GetFromPage(self) -
> int
</autodoc>
16108 <method name=
"GetToPage" type=
"int" overloaded=
"no">
16109 <autodoc>GetToPage(self) -
> int
</autodoc>
16111 <method name=
"GetMinPage" type=
"int" overloaded=
"no">
16112 <autodoc>GetMinPage(self) -
> int
</autodoc>
16114 <method name=
"GetMaxPage" type=
"int" overloaded=
"no">
16115 <autodoc>GetMaxPage(self) -
> int
</autodoc>
16117 <method name=
"GetNoCopies" type=
"int" overloaded=
"no">
16118 <autodoc>GetNoCopies(self) -
> int
</autodoc>
16120 <method name=
"GetAllPages" type=
"bool" overloaded=
"no">
16121 <autodoc>GetAllPages(self) -
> bool
</autodoc>
16123 <method name=
"GetSelection" type=
"bool" overloaded=
"no">
16124 <autodoc>GetSelection(self) -
> bool
</autodoc>
16126 <method name=
"GetCollate" type=
"bool" overloaded=
"no">
16127 <autodoc>GetCollate(self) -
> bool
</autodoc>
16129 <method name=
"GetPrintToFile" type=
"bool" overloaded=
"no">
16130 <autodoc>GetPrintToFile(self) -
> bool
</autodoc>
16132 <method name=
"GetSetupDialog" type=
"bool" overloaded=
"no">
16133 <autodoc>GetSetupDialog(self) -
> bool
</autodoc>
16135 <method name=
"SetFromPage" type=
"" overloaded=
"no">
16136 <autodoc>SetFromPage(self, int v)
</autodoc>
16138 <param name=
"v" type=
"int" default=
""/>
16141 <method name=
"SetToPage" type=
"" overloaded=
"no">
16142 <autodoc>SetToPage(self, int v)
</autodoc>
16144 <param name=
"v" type=
"int" default=
""/>
16147 <method name=
"SetMinPage" type=
"" overloaded=
"no">
16148 <autodoc>SetMinPage(self, int v)
</autodoc>
16150 <param name=
"v" type=
"int" default=
""/>
16153 <method name=
"SetMaxPage" type=
"" overloaded=
"no">
16154 <autodoc>SetMaxPage(self, int v)
</autodoc>
16156 <param name=
"v" type=
"int" default=
""/>
16159 <method name=
"SetNoCopies" type=
"" overloaded=
"no">
16160 <autodoc>SetNoCopies(self, int v)
</autodoc>
16162 <param name=
"v" type=
"int" default=
""/>
16165 <method name=
"SetAllPages" type=
"" overloaded=
"no">
16166 <autodoc>SetAllPages(self, bool flag)
</autodoc>
16168 <param name=
"flag" type=
"bool" default=
""/>
16171 <method name=
"SetSelection" type=
"" overloaded=
"no">
16172 <autodoc>SetSelection(self, bool flag)
</autodoc>
16174 <param name=
"flag" type=
"bool" default=
""/>
16177 <method name=
"SetCollate" type=
"" overloaded=
"no">
16178 <autodoc>SetCollate(self, bool flag)
</autodoc>
16180 <param name=
"flag" type=
"bool" default=
""/>
16183 <method name=
"SetPrintToFile" type=
"" overloaded=
"no">
16184 <autodoc>SetPrintToFile(self, bool flag)
</autodoc>
16186 <param name=
"flag" type=
"bool" default=
""/>
16189 <method name=
"SetSetupDialog" type=
"" overloaded=
"no">
16190 <autodoc>SetSetupDialog(self, bool flag)
</autodoc>
16192 <param name=
"flag" type=
"bool" default=
""/>
16195 <method name=
"EnablePrintToFile" type=
"" overloaded=
"no">
16196 <autodoc>EnablePrintToFile(self, bool flag)
</autodoc>
16198 <param name=
"flag" type=
"bool" default=
""/>
16201 <method name=
"EnableSelection" type=
"" overloaded=
"no">
16202 <autodoc>EnableSelection(self, bool flag)
</autodoc>
16204 <param name=
"flag" type=
"bool" default=
""/>
16207 <method name=
"EnablePageNumbers" type=
"" overloaded=
"no">
16208 <autodoc>EnablePageNumbers(self, bool flag)
</autodoc>
16210 <param name=
"flag" type=
"bool" default=
""/>
16213 <method name=
"EnableHelp" type=
"" overloaded=
"no">
16214 <autodoc>EnableHelp(self, bool flag)
</autodoc>
16216 <param name=
"flag" type=
"bool" default=
""/>
16219 <method name=
"GetEnablePrintToFile" type=
"bool" overloaded=
"no">
16220 <autodoc>GetEnablePrintToFile(self) -
> bool
</autodoc>
16222 <method name=
"GetEnableSelection" type=
"bool" overloaded=
"no">
16223 <autodoc>GetEnableSelection(self) -
> bool
</autodoc>
16225 <method name=
"GetEnablePageNumbers" type=
"bool" overloaded=
"no">
16226 <autodoc>GetEnablePageNumbers(self) -
> bool
</autodoc>
16228 <method name=
"GetEnableHelp" type=
"bool" overloaded=
"no">
16229 <autodoc>GetEnableHelp(self) -
> bool
</autodoc>
16231 <method name=
"Ok" type=
"bool" overloaded=
"no">
16232 <autodoc>Ok(self) -
> bool
</autodoc>
16234 <method name=
"GetPrintData" type=
"PrintData" overloaded=
"no">
16235 <autodoc>GetPrintData(self) -
> PrintData
</autodoc>
16237 <method name=
"SetPrintData" type=
"" overloaded=
"no">
16238 <autodoc>SetPrintData(self, PrintData printData)
</autodoc>
16240 <param name=
"printData" type=
"PrintData" default=
""/>
16244 <class name=
"PrintDialog" oldname=
"wxPrintDialog" module=
"_windows">
16245 <baseclass name=
"Dialog"/>
16246 <constructor name=
"PrintDialog" overloaded=
"no">
16247 <autodoc>__init__(self, Window parent, PrintDialogData data=None) -
> PrintDialog
</autodoc>
16249 <param name=
"parent" type=
"Window" default=
""/>
16250 <param name=
"data" type=
"PrintDialogData" default=
"NULL"/>
16253 <method name=
"GetPrintDialogData" type=
"PrintDialogData" overloaded=
"no">
16254 <autodoc>GetPrintDialogData(self) -
> PrintDialogData
</autodoc>
16256 <method name=
"GetPrintDC" type=
"DC" overloaded=
"no">
16257 <autodoc>GetPrintDC(self) -
> DC
</autodoc>
16259 <method name=
"ShowModal" type=
"int" overloaded=
"no">
16260 <autodoc>ShowModal(self) -
> int
</autodoc>
16263 <class name=
"Printer" oldname=
"wxPrinter" module=
"_windows">
16264 <baseclass name=
"Object"/>
16265 <constructor name=
"Printer" overloaded=
"no">
16266 <autodoc>__init__(self, PrintDialogData data=None) -
> Printer
</autodoc>
16268 <param name=
"data" type=
"PrintDialogData" default=
"NULL"/>
16271 <destructor name=
"~wxPrinter" overloaded=
"no">
16272 <autodoc>__del__(self)
</autodoc>
16274 <method name=
"CreateAbortWindow" type=
"" overloaded=
"no">
16275 <autodoc>CreateAbortWindow(self, Window parent, Printout printout)
</autodoc>
16277 <param name=
"parent" type=
"Window" default=
""/>
16278 <param name=
"printout" type=
"wxPyPrintout" default=
""/>
16281 <method name=
"GetPrintDialogData" type=
"PrintDialogData" overloaded=
"no">
16282 <autodoc>GetPrintDialogData(self) -
> PrintDialogData
</autodoc>
16284 <method name=
"Print" type=
"bool" overloaded=
"no">
16285 <autodoc>Print(self, Window parent, Printout printout, int prompt=True) -
> bool
</autodoc>
16287 <param name=
"parent" type=
"Window" default=
""/>
16288 <param name=
"printout" type=
"wxPyPrintout" default=
""/>
16289 <param name=
"prompt" type=
"int" default=
"True"/>
16292 <method name=
"PrintDialog" type=
"DC" overloaded=
"no">
16293 <autodoc>PrintDialog(self, Window parent) -
> DC
</autodoc>
16295 <param name=
"parent" type=
"Window" default=
""/>
16298 <method name=
"ReportError" type=
"" overloaded=
"no">
16299 <autodoc>ReportError(self, Window parent, Printout printout, String message)
</autodoc>
16301 <param name=
"parent" type=
"Window" default=
""/>
16302 <param name=
"printout" type=
"wxPyPrintout" default=
""/>
16303 <param name=
"message" type=
"String" default=
""/>
16306 <method name=
"Setup" type=
"bool" overloaded=
"no">
16307 <autodoc>Setup(self, Window parent) -
> bool
</autodoc>
16309 <param name=
"parent" type=
"Window" default=
""/>
16312 <method name=
"GetAbort" type=
"bool" overloaded=
"no">
16313 <autodoc>GetAbort(self) -
> bool
</autodoc>
16315 <staticmethod name=
"GetLastError" type=
"wxPrinterError" overloaded=
"no">
16316 <autodoc>GetLastError() -
> int
</autodoc>
16319 <class name=
"Printout" oldname=
"wxPyPrintout" module=
"_windows">
16320 <baseclass name=
"Object"/>
16321 <constructor name=
"wxPyPrintout" overloaded=
"no">
16322 <autodoc>__init__(self, String title=PrintoutTitleStr) -
> Printout
</autodoc>
16324 <param name=
"title" type=
"String" default=
"wxPyPrintoutTitleStr"/>
16327 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
16328 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
16330 <param name=
"self" type=
"PyObject" default=
""/>
16331 <param name=
"_class" type=
"PyObject" default=
""/>
16334 <method name=
"GetTitle" type=
"String" overloaded=
"no">
16335 <autodoc>GetTitle(self) -
> String
</autodoc>
16337 <method name=
"GetDC" type=
"DC" overloaded=
"no">
16338 <autodoc>GetDC(self) -
> DC
</autodoc>
16340 <method name=
"SetDC" type=
"" overloaded=
"no">
16341 <autodoc>SetDC(self, DC dc)
</autodoc>
16343 <param name=
"dc" type=
"DC" default=
""/>
16346 <method name=
"SetPageSizePixels" type=
"" overloaded=
"no">
16347 <autodoc>SetPageSizePixels(self, int w, int h)
</autodoc>
16349 <param name=
"w" type=
"int" default=
""/>
16350 <param name=
"h" type=
"int" default=
""/>
16353 <method name=
"GetPageSizePixels" type=
"" overloaded=
"no">
16354 <autodoc>GetPageSizePixels() -
> (w, h)
</autodoc>
16356 <param name=
"OUTPUT" type=
"int" default=
""/>
16357 <param name=
"OUTPUT" type=
"int" default=
""/>
16360 <method name=
"SetPageSizeMM" type=
"" overloaded=
"no">
16361 <autodoc>SetPageSizeMM(self, int w, int h)
</autodoc>
16363 <param name=
"w" type=
"int" default=
""/>
16364 <param name=
"h" type=
"int" default=
""/>
16367 <method name=
"GetPageSizeMM" type=
"" overloaded=
"no">
16368 <autodoc>GetPageSizeMM() -
> (w, h)
</autodoc>
16370 <param name=
"OUTPUT" type=
"int" default=
""/>
16371 <param name=
"OUTPUT" type=
"int" default=
""/>
16374 <method name=
"SetPPIScreen" type=
"" overloaded=
"no">
16375 <autodoc>SetPPIScreen(self, int x, int y)
</autodoc>
16377 <param name=
"x" type=
"int" default=
""/>
16378 <param name=
"y" type=
"int" default=
""/>
16381 <method name=
"GetPPIScreen" type=
"" overloaded=
"no">
16382 <autodoc>GetPPIScreen() -
> (x,y)
</autodoc>
16384 <param name=
"OUTPUT" type=
"int" default=
""/>
16385 <param name=
"OUTPUT" type=
"int" default=
""/>
16388 <method name=
"SetPPIPrinter" type=
"" overloaded=
"no">
16389 <autodoc>SetPPIPrinter(self, int x, int y)
</autodoc>
16391 <param name=
"x" type=
"int" default=
""/>
16392 <param name=
"y" type=
"int" default=
""/>
16395 <method name=
"GetPPIPrinter" type=
"" overloaded=
"no">
16396 <autodoc>GetPPIPrinter() -
> (x,y)
</autodoc>
16398 <param name=
"OUTPUT" type=
"int" default=
""/>
16399 <param name=
"OUTPUT" type=
"int" default=
""/>
16402 <method name=
"IsPreview" type=
"bool" overloaded=
"no">
16403 <autodoc>IsPreview(self) -
> bool
</autodoc>
16405 <method name=
"SetIsPreview" type=
"" overloaded=
"no">
16406 <autodoc>SetIsPreview(self, bool p)
</autodoc>
16408 <param name=
"p" type=
"bool" default=
""/>
16411 <method name=
"base_OnBeginDocument" type=
"bool" overloaded=
"no">
16412 <autodoc>base_OnBeginDocument(self, int startPage, int endPage) -
> bool
</autodoc>
16414 <param name=
"startPage" type=
"int" default=
""/>
16415 <param name=
"endPage" type=
"int" default=
""/>
16418 <method name=
"base_OnEndDocument" type=
"" overloaded=
"no">
16419 <autodoc>base_OnEndDocument(self)
</autodoc>
16421 <method name=
"base_OnBeginPrinting" type=
"" overloaded=
"no">
16422 <autodoc>base_OnBeginPrinting(self)
</autodoc>
16424 <method name=
"base_OnEndPrinting" type=
"" overloaded=
"no">
16425 <autodoc>base_OnEndPrinting(self)
</autodoc>
16427 <method name=
"base_OnPreparePrinting" type=
"" overloaded=
"no">
16428 <autodoc>base_OnPreparePrinting(self)
</autodoc>
16430 <method name=
"base_HasPage" type=
"bool" overloaded=
"no">
16431 <autodoc>base_HasPage(self, int page) -
> bool
</autodoc>
16433 <param name=
"page" type=
"int" default=
""/>
16436 <method name=
"base_GetPageInfo" type=
"" overloaded=
"no">
16437 <autodoc>base_GetPageInfo() -
> (minPage, maxPage, pageFrom, pageTo)
</autodoc>
16439 <param name=
"OUTPUT" type=
"int" default=
""/>
16440 <param name=
"OUTPUT" type=
"int" default=
""/>
16441 <param name=
"OUTPUT" type=
"int" default=
""/>
16442 <param name=
"OUTPUT" type=
"int" default=
""/>
16446 <class name=
"PreviewCanvas" oldname=
"wxPreviewCanvas" module=
"_windows">
16447 <baseclass name=
"ScrolledWindow"/>
16448 <constructor name=
"PreviewCanvas" overloaded=
"no">
16449 <autodoc>__init__(self, PrintPreview preview, Window parent, Point pos=DefaultPosition,
16450 Size size=DefaultSize, long style=
0,
16451 String name=PreviewCanvasNameStr) -
> PreviewCanvas
</autodoc>
16453 <param name=
"preview" type=
"wxPrintPreview" default=
""/>
16454 <param name=
"parent" type=
"Window" default=
""/>
16455 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16456 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16457 <param name=
"style" type=
"long" default=
"0"/>
16458 <param name=
"name" type=
"String" default=
"wxPyPreviewCanvasNameStr"/>
16462 <class name=
"PreviewFrame" oldname=
"wxPreviewFrame" module=
"_windows">
16463 <baseclass name=
"Frame"/>
16464 <constructor name=
"PreviewFrame" overloaded=
"no">
16465 <autodoc>__init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition,
16466 Size size=DefaultSize,
16467 long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -
> PreviewFrame
</autodoc>
16469 <param name=
"preview" type=
"wxPrintPreview" default=
""/>
16470 <param name=
"parent" type=
"Frame" default=
""/>
16471 <param name=
"title" type=
"String" default=
""/>
16472 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16473 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16474 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE"/>
16475 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
16478 <method name=
"Initialize" type=
"" overloaded=
"no">
16479 <autodoc>Initialize(self)
</autodoc>
16481 <method name=
"CreateControlBar" type=
"" overloaded=
"no">
16482 <autodoc>CreateControlBar(self)
</autodoc>
16484 <method name=
"CreateCanvas" type=
"" overloaded=
"no">
16485 <autodoc>CreateCanvas(self)
</autodoc>
16487 <method name=
"GetControlBar" type=
"wxPreviewControlBar" overloaded=
"no">
16488 <autodoc>GetControlBar(self) -
> PreviewControlBar
</autodoc>
16491 <class name=
"PreviewControlBar" oldname=
"wxPreviewControlBar" module=
"_windows">
16492 <baseclass name=
"Panel"/>
16493 <constructor name=
"PreviewControlBar" overloaded=
"no">
16494 <autodoc>__init__(self, PrintPreview preview, long buttons, Window parent,
16495 Point pos=DefaultPosition, Size size=DefaultSize,
16496 long style=TAB_TRAVERSAL, String name=PanelNameStr) -
> PreviewControlBar
</autodoc>
16498 <param name=
"preview" type=
"wxPrintPreview" default=
""/>
16499 <param name=
"buttons" type=
"long" default=
""/>
16500 <param name=
"parent" type=
"Window" default=
""/>
16501 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16502 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16503 <param name=
"style" type=
"long" default=
"wxTAB_TRAVERSAL"/>
16504 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
16507 <method name=
"GetZoomControl" type=
"int" overloaded=
"no">
16508 <autodoc>GetZoomControl(self) -
> int
</autodoc>
16510 <method name=
"SetZoomControl" type=
"" overloaded=
"no">
16511 <autodoc>SetZoomControl(self, int zoom)
</autodoc>
16513 <param name=
"zoom" type=
"int" default=
""/>
16516 <method name=
"GetPrintPreview" type=
"wxPrintPreview" overloaded=
"no">
16517 <autodoc>GetPrintPreview(self) -
> PrintPreview
</autodoc>
16519 <method name=
"OnNext" type=
"" overloaded=
"no">
16520 <autodoc>OnNext(self)
</autodoc>
16522 <method name=
"OnPrevious" type=
"" overloaded=
"no">
16523 <autodoc>OnPrevious(self)
</autodoc>
16525 <method name=
"OnFirst" type=
"" overloaded=
"no">
16526 <autodoc>OnFirst(self)
</autodoc>
16528 <method name=
"OnLast" type=
"" overloaded=
"no">
16529 <autodoc>OnLast(self)
</autodoc>
16531 <method name=
"OnGoto" type=
"" overloaded=
"no">
16532 <autodoc>OnGoto(self)
</autodoc>
16535 <class name=
"PrintPreview" oldname=
"wxPrintPreview" module=
"_windows">
16536 <baseclass name=
"Object"/>
16537 <constructor name=
"PrintPreview" overloaded=
"yes">
16539 <param name=
"printout" type=
"Printout" default=
""/>
16540 <param name=
"printoutForPrinting" type=
"Printout" default=
""/>
16541 <param name=
"data" type=
"PrintDialogData" default=
"NULL"/>
16544 <constructor name=
"PrintPreview" overloaded=
"yes">
16545 <autodoc>__init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -
> PrintPreview
16546 __init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -
> PrintPreview
</autodoc>
16548 <param name=
"printout" type=
"Printout" default=
""/>
16549 <param name=
"printoutForPrinting" type=
"Printout" default=
""/>
16550 <param name=
"data" type=
"PrintData" default=
""/>
16553 <method name=
"SetCurrentPage" type=
"bool" overloaded=
"no">
16554 <autodoc>SetCurrentPage(self, int pageNum) -
> bool
</autodoc>
16556 <param name=
"pageNum" type=
"int" default=
""/>
16559 <method name=
"GetCurrentPage" type=
"int" overloaded=
"no">
16560 <autodoc>GetCurrentPage(self) -
> int
</autodoc>
16562 <method name=
"SetPrintout" type=
"" overloaded=
"no">
16563 <autodoc>SetPrintout(self, Printout printout)
</autodoc>
16565 <param name=
"printout" type=
"Printout" default=
""/>
16568 <method name=
"GetPrintout" type=
"Printout" overloaded=
"no">
16569 <autodoc>GetPrintout(self) -
> Printout
</autodoc>
16571 <method name=
"GetPrintoutForPrinting" type=
"Printout" overloaded=
"no">
16572 <autodoc>GetPrintoutForPrinting(self) -
> Printout
</autodoc>
16574 <method name=
"SetFrame" type=
"" overloaded=
"no">
16575 <autodoc>SetFrame(self, Frame frame)
</autodoc>
16577 <param name=
"frame" type=
"Frame" default=
""/>
16580 <method name=
"SetCanvas" type=
"" overloaded=
"no">
16581 <autodoc>SetCanvas(self, PreviewCanvas canvas)
</autodoc>
16583 <param name=
"canvas" type=
"PreviewCanvas" default=
""/>
16586 <method name=
"GetFrame" type=
"Frame" overloaded=
"no">
16587 <autodoc>GetFrame(self) -
> Frame
</autodoc>
16589 <method name=
"GetCanvas" type=
"PreviewCanvas" overloaded=
"no">
16590 <autodoc>GetCanvas(self) -
> PreviewCanvas
</autodoc>
16592 <method name=
"PaintPage" type=
"bool" overloaded=
"no">
16593 <autodoc>PaintPage(self, PreviewCanvas canvas, DC dc) -
> bool
</autodoc>
16595 <param name=
"canvas" type=
"PreviewCanvas" default=
""/>
16596 <param name=
"dc" type=
"DC" default=
""/>
16599 <method name=
"DrawBlankPage" type=
"bool" overloaded=
"no">
16600 <autodoc>DrawBlankPage(self, PreviewCanvas canvas, DC dc) -
> bool
</autodoc>
16602 <param name=
"canvas" type=
"PreviewCanvas" default=
""/>
16603 <param name=
"dc" type=
"DC" default=
""/>
16606 <method name=
"RenderPage" type=
"bool" overloaded=
"no">
16607 <autodoc>RenderPage(self, int pageNum) -
> bool
</autodoc>
16609 <param name=
"pageNum" type=
"int" default=
""/>
16612 <method name=
"AdjustScrollbars" type=
"" overloaded=
"no">
16613 <autodoc>AdjustScrollbars(self, PreviewCanvas canvas)
</autodoc>
16615 <param name=
"canvas" type=
"PreviewCanvas" default=
""/>
16618 <method name=
"GetPrintDialogData" type=
"PrintDialogData" overloaded=
"no">
16619 <autodoc>GetPrintDialogData(self) -
> PrintDialogData
</autodoc>
16621 <method name=
"SetZoom" type=
"" overloaded=
"no">
16622 <autodoc>SetZoom(self, int percent)
</autodoc>
16624 <param name=
"percent" type=
"int" default=
""/>
16627 <method name=
"GetZoom" type=
"int" overloaded=
"no">
16628 <autodoc>GetZoom(self) -
> int
</autodoc>
16630 <method name=
"GetMaxPage" type=
"int" overloaded=
"no">
16631 <autodoc>GetMaxPage(self) -
> int
</autodoc>
16633 <method name=
"GetMinPage" type=
"int" overloaded=
"no">
16634 <autodoc>GetMinPage(self) -
> int
</autodoc>
16636 <method name=
"Ok" type=
"bool" overloaded=
"no">
16637 <autodoc>Ok(self) -
> bool
</autodoc>
16639 <method name=
"SetOk" type=
"" overloaded=
"no">
16640 <autodoc>SetOk(self, bool ok)
</autodoc>
16642 <param name=
"ok" type=
"bool" default=
""/>
16645 <method name=
"Print" type=
"bool" overloaded=
"no">
16646 <autodoc>Print(self, bool interactive) -
> bool
</autodoc>
16648 <param name=
"interactive" type=
"bool" default=
""/>
16651 <method name=
"DetermineScaling" type=
"" overloaded=
"no">
16652 <autodoc>DetermineScaling(self)
</autodoc>
16655 <class name=
"PyPrintPreview" oldname=
"wxPyPrintPreview" module=
"_windows">
16656 <baseclass name=
"PrintPreview"/>
16657 <constructor name=
"PyPrintPreview" overloaded=
"yes">
16659 <param name=
"printout" type=
"Printout" default=
""/>
16660 <param name=
"printoutForPrinting" type=
"Printout" default=
""/>
16661 <param name=
"data" type=
"PrintDialogData" default=
"NULL"/>
16664 <constructor name=
"PyPrintPreview" overloaded=
"yes">
16665 <autodoc>__init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -
> PyPrintPreview
16666 __init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -
> PyPrintPreview
</autodoc>
16668 <param name=
"printout" type=
"Printout" default=
""/>
16669 <param name=
"printoutForPrinting" type=
"Printout" default=
""/>
16670 <param name=
"data" type=
"PrintData" default=
""/>
16673 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
16674 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
16676 <param name=
"self" type=
"PyObject" default=
""/>
16677 <param name=
"_class" type=
"PyObject" default=
""/>
16680 <method name=
"base_SetCurrentPage" type=
"bool" overloaded=
"no">
16681 <autodoc>base_SetCurrentPage(self, int pageNum) -
> bool
</autodoc>
16683 <param name=
"pageNum" type=
"int" default=
""/>
16686 <method name=
"base_PaintPage" type=
"bool" overloaded=
"no">
16687 <autodoc>base_PaintPage(self, PreviewCanvas canvas, DC dc) -
> bool
</autodoc>
16689 <param name=
"canvas" type=
"PreviewCanvas" default=
""/>
16690 <param name=
"dc" type=
"DC" default=
""/>
16693 <method name=
"base_DrawBlankPage" type=
"bool" overloaded=
"no">
16694 <autodoc>base_DrawBlankPage(self, PreviewCanvas canvas, DC dc) -
> bool
</autodoc>
16696 <param name=
"canvas" type=
"PreviewCanvas" default=
""/>
16697 <param name=
"dc" type=
"DC" default=
""/>
16700 <method name=
"base_RenderPage" type=
"bool" overloaded=
"no">
16701 <autodoc>base_RenderPage(self, int pageNum) -
> bool
</autodoc>
16703 <param name=
"pageNum" type=
"int" default=
""/>
16706 <method name=
"base_SetZoom" type=
"" overloaded=
"no">
16707 <autodoc>base_SetZoom(self, int percent)
</autodoc>
16709 <param name=
"percent" type=
"int" default=
""/>
16712 <method name=
"base_Print" type=
"bool" overloaded=
"no">
16713 <autodoc>base_Print(self, bool interactive) -
> bool
</autodoc>
16715 <param name=
"interactive" type=
"bool" default=
""/>
16718 <method name=
"base_DetermineScaling" type=
"" overloaded=
"no">
16719 <autodoc>base_DetermineScaling(self)
</autodoc>
16722 <class name=
"PyPreviewFrame" oldname=
"wxPyPreviewFrame" module=
"_windows">
16723 <baseclass name=
"PreviewFrame"/>
16724 <constructor name=
"PyPreviewFrame" overloaded=
"no">
16725 <autodoc>__init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition,
16726 Size size=DefaultSize,
16727 long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -
> PyPreviewFrame
</autodoc>
16729 <param name=
"preview" type=
"PrintPreview" default=
""/>
16730 <param name=
"parent" type=
"Frame" default=
""/>
16731 <param name=
"title" type=
"String" default=
""/>
16732 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16733 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16734 <param name=
"style" type=
"long" default=
"wxDEFAULT_FRAME_STYLE"/>
16735 <param name=
"name" type=
"String" default=
"wxPyFrameNameStr"/>
16738 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
16739 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
16741 <param name=
"self" type=
"PyObject" default=
""/>
16742 <param name=
"_class" type=
"PyObject" default=
""/>
16745 <method name=
"SetPreviewCanvas" type=
"" overloaded=
"no">
16746 <autodoc>SetPreviewCanvas(self, PreviewCanvas canvas)
</autodoc>
16748 <param name=
"canvas" type=
"PreviewCanvas" default=
""/>
16751 <method name=
"SetControlBar" type=
"" overloaded=
"no">
16752 <autodoc>SetControlBar(self, PreviewControlBar bar)
</autodoc>
16754 <param name=
"bar" type=
"PreviewControlBar" default=
""/>
16757 <method name=
"base_Initialize" type=
"" overloaded=
"no">
16758 <autodoc>base_Initialize(self)
</autodoc>
16760 <method name=
"base_CreateCanvas" type=
"" overloaded=
"no">
16761 <autodoc>base_CreateCanvas(self)
</autodoc>
16763 <method name=
"base_CreateControlBar" type=
"" overloaded=
"no">
16764 <autodoc>base_CreateControlBar(self)
</autodoc>
16767 <class name=
"PyPreviewControlBar" oldname=
"wxPyPreviewControlBar" module=
"_windows">
16768 <baseclass name=
"PreviewControlBar"/>
16769 <constructor name=
"PyPreviewControlBar" overloaded=
"no">
16770 <autodoc>__init__(self, PrintPreview preview, long buttons, Window parent,
16771 Point pos=DefaultPosition, Size size=DefaultSize,
16772 long style=
0, String name=PanelNameStr) -
> PyPreviewControlBar
</autodoc>
16774 <param name=
"preview" type=
"PrintPreview" default=
""/>
16775 <param name=
"buttons" type=
"long" default=
""/>
16776 <param name=
"parent" type=
"Window" default=
""/>
16777 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16778 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16779 <param name=
"style" type=
"long" default=
"0"/>
16780 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
16783 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
16784 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
16786 <param name=
"self" type=
"PyObject" default=
""/>
16787 <param name=
"_class" type=
"PyObject" default=
""/>
16790 <method name=
"SetPrintPreview" type=
"" overloaded=
"no">
16791 <autodoc>SetPrintPreview(self, PrintPreview preview)
</autodoc>
16793 <param name=
"preview" type=
"PrintPreview" default=
""/>
16796 <method name=
"base_CreateButtons" type=
"" overloaded=
"no">
16797 <autodoc>base_CreateButtons(self)
</autodoc>
16799 <method name=
"base_SetZoomControl" type=
"" overloaded=
"no">
16800 <autodoc>base_SetZoomControl(self, int zoom)
</autodoc>
16802 <param name=
"zoom" type=
"int" default=
""/>
16807 <module name=
"_controls">
16808 <import name=
"_core"/>
16809 <pythoncode> wx = _core
</pythoncode>
16811 #---------------------------------------------------------------------------
16813 <class name=
"Button" oldname=
"wxButton" module=
"_controls">
16814 <docstring>A button is a control that contains a text string, and is one of the most
16815 common elements of a GUI. It may be placed on a dialog box or panel, or
16816 indeed almost any other window.
16820 ============== ==========================================
16821 wx.BU_LEFT Left-justifies the label. WIN32 only.
16822 wx.BU_TOP Aligns the label to the top of the button.
16824 wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only.
16825 wx.BU_BOTTOM Aligns the label to the bottom of the button.
16827 wx.BU_EXACTFIT Creates the button as small as possible
16828 instead of making it of the standard size
16829 (which is the default behaviour.)
16830 ============== ==========================================
16834 ============ ==========================================
16835 EVT_BUTTON Sent when the button is clicked.
16836 ============ ==========================================
16838 :see: `wx.BitmapButton`
16840 <baseclass name=
"Control"/>
16841 <constructor name=
"Button" overloaded=
"no">
16842 <autodoc>__init__(self, Window parent, int id=-
1, String label=EmptyString,
16843 Point pos=DefaultPosition, Size size=DefaultSize,
16844 long style=
0, Validator validator=DefaultValidator,
16845 String name=ButtonNameStr) -
> Button
</autodoc>
16846 <docstring>Create and show a button.
</docstring>
16848 <param name=
"parent" type=
"Window" default=
""/>
16849 <param name=
"id" type=
"int" default=
"-1"/>
16850 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
16851 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16852 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16853 <param name=
"style" type=
"long" default=
"0"/>
16854 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
16855 <param name=
"name" type=
"String" default=
"wxPyButtonNameStr"/>
16858 <constructor name=
"PreButton" overloaded=
"no">
16859 <autodoc>PreButton() -
> Button
</autodoc>
16860 <docstring>Precreate a Button for
2-phase creation.
</docstring>
16862 <method name=
"Create" type=
"bool" overloaded=
"no">
16863 <autodoc>Create(self, Window parent, int id=-
1, String label=EmptyString,
16864 Point pos=DefaultPosition, Size size=DefaultSize,
16865 long style=
0, Validator validator=DefaultValidator,
16866 String name=ButtonNameStr) -
> bool
</autodoc>
16867 <docstring>Acutally create the GUI Button for
2-phase creation.
</docstring>
16869 <param name=
"parent" type=
"Window" default=
""/>
16870 <param name=
"id" type=
"int" default=
"-1"/>
16871 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
16872 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16873 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16874 <param name=
"style" type=
"long" default=
"0"/>
16875 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
16876 <param name=
"name" type=
"String" default=
"wxPyButtonNameStr"/>
16879 <method name=
"SetDefault" type=
"" overloaded=
"no">
16880 <autodoc>SetDefault(self)
</autodoc>
16881 <docstring>This sets the button to be the default item for the panel or dialog box.
</docstring>
16883 <staticmethod name=
"GetDefaultSize" type=
"Size" overloaded=
"no">
16884 <autodoc>GetDefaultSize() -
> Size
</autodoc>
16885 <docstring>Returns the default button size for this platform.
</docstring>
16887 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
16888 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
16889 <docstring>Get the default attributes for this class. This is useful if you want
16890 to use the same font or colour in your own control as in a standard
16891 control -- which is a much better idea than hard coding specific
16892 colours or fonts which might look completely out of place on the
16893 user's system, especially if it uses themes.
16895 The variant parameter is only relevant under Mac currently and is
16896 ignore under other platforms. Under Mac, it will change the size of
16897 the returned font. See `wx.Window.SetWindowVariant` for more about
16900 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
16904 <class name=
"BitmapButton" oldname=
"wxBitmapButton" module=
"_controls">
16905 <docstring>A Button that contains a bitmap. A bitmap button can be supplied with a
16906 single bitmap, and wxWidgets will draw all button states using this bitmap. If
16907 the application needs more control, additional bitmaps for the selected state,
16908 unpressed focused state, and greyed-out state may be supplied.
16912 ============== =============================================
16913 wx.BU_AUTODRAW If this is specified, the button will be drawn
16914 automatically using the label bitmap only,
16915 providing a
3D-look border. If this style is
16916 not specified, the button will be drawn
16917 without borders and using all provided
16918 bitmaps. WIN32 only.
16919 wx.BU_LEFT Left-justifies the label. WIN32 only.
16920 wx.BU_TOP Aligns the label to the top of the button. WIN32
16922 wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only.
16923 wx.BU_BOTTOM Aligns the label to the bottom of the
16924 button. WIN32 only.
16925 wx.BU_EXACTFIT Creates the button as small as possible
16926 instead of making it of the standard size
16927 (which is the default behaviour.)
16928 ============== =============================================
16932 =========== ==================================
16933 EVT_BUTTON Sent when the button is clicked.
16934 =========== ==================================
16936 :see: `wx.Button`, `wx.Bitmap`
16938 <baseclass name=
"Button"/>
16939 <constructor name=
"BitmapButton" overloaded=
"no">
16940 <autodoc>__init__(self, Window parent, int id=-
1, Bitmap bitmap=wxNullBitmap,
16941 Point pos=DefaultPosition, Size size=DefaultSize,
16942 long style=BU_AUTODRAW, Validator validator=DefaultValidator,
16943 String name=ButtonNameStr) -
> BitmapButton
</autodoc>
16944 <docstring>Create and show a button with a bitmap for the label.
</docstring>
16946 <param name=
"parent" type=
"Window" default=
""/>
16947 <param name=
"id" type=
"int" default=
"-1"/>
16948 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
16949 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16950 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16951 <param name=
"style" type=
"long" default=
"wxBU_AUTODRAW"/>
16952 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
16953 <param name=
"name" type=
"String" default=
"wxPyButtonNameStr"/>
16956 <constructor name=
"PreBitmapButton" overloaded=
"no">
16957 <autodoc>PreBitmapButton() -
> BitmapButton
</autodoc>
16958 <docstring>Precreate a BitmapButton for
2-phase creation.
</docstring>
16960 <method name=
"Create" type=
"bool" overloaded=
"no">
16961 <autodoc>Create(self, Window parent, int id=-
1, Bitmap bitmap=wxNullBitmap,
16962 Point pos=DefaultPosition, Size size=DefaultSize,
16963 long style=BU_AUTODRAW, Validator validator=DefaultValidator,
16964 String name=ButtonNameStr) -
> bool
</autodoc>
16965 <docstring>Acutally create the GUI BitmapButton for
2-phase creation.
</docstring>
16967 <param name=
"parent" type=
"Window" default=
""/>
16968 <param name=
"id" type=
"int" default=
"-1"/>
16969 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
16970 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
16971 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
16972 <param name=
"style" type=
"long" default=
"wxBU_AUTODRAW"/>
16973 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
16974 <param name=
"name" type=
"String" default=
"wxPyButtonNameStr"/>
16977 <method name=
"GetBitmapLabel" type=
"Bitmap" overloaded=
"no">
16978 <autodoc>GetBitmapLabel(self) -
> Bitmap
</autodoc>
16979 <docstring>Returns the label bitmap (the one passed to the constructor).
</docstring>
16981 <method name=
"GetBitmapDisabled" type=
"Bitmap" overloaded=
"no">
16982 <autodoc>GetBitmapDisabled(self) -
> Bitmap
</autodoc>
16983 <docstring>Returns the bitmap for the disabled state.
</docstring>
16985 <method name=
"GetBitmapFocus" type=
"Bitmap" overloaded=
"no">
16986 <autodoc>GetBitmapFocus(self) -
> Bitmap
</autodoc>
16987 <docstring>Returns the bitmap for the focused state.
</docstring>
16989 <method name=
"GetBitmapSelected" type=
"Bitmap" overloaded=
"no">
16990 <autodoc>GetBitmapSelected(self) -
> Bitmap
</autodoc>
16991 <docstring>Returns the bitmap for the selected state.
</docstring>
16993 <method name=
"SetBitmapDisabled" type=
"" overloaded=
"no">
16994 <autodoc>SetBitmapDisabled(self, Bitmap bitmap)
</autodoc>
16995 <docstring>Sets the bitmap for the disabled button appearance.
</docstring>
16997 <param name=
"bitmap" type=
"Bitmap" default=
""/>
17000 <method name=
"SetBitmapFocus" type=
"" overloaded=
"no">
17001 <autodoc>SetBitmapFocus(self, Bitmap bitmap)
</autodoc>
17002 <docstring>Sets the bitmap for the button appearance when it has the keyboard focus.
</docstring>
17004 <param name=
"bitmap" type=
"Bitmap" default=
""/>
17007 <method name=
"SetBitmapSelected" type=
"" overloaded=
"no">
17008 <autodoc>SetBitmapSelected(self, Bitmap bitmap)
</autodoc>
17009 <docstring>Sets the bitmap for the selected (depressed) button appearance.
</docstring>
17011 <param name=
"bitmap" type=
"Bitmap" default=
""/>
17014 <method name=
"SetBitmapLabel" type=
"" overloaded=
"no">
17015 <autodoc>SetBitmapLabel(self, Bitmap bitmap)
</autodoc>
17016 <docstring>Sets the bitmap label for the button. This is the bitmap used for the
17017 unselected state, and for all other states if no other bitmaps are provided.
</docstring>
17019 <param name=
"bitmap" type=
"Bitmap" default=
""/>
17022 <method name=
"SetMargins" type=
"" overloaded=
"no">
17023 <autodoc>SetMargins(self, int x, int y)
</autodoc>
17025 <param name=
"x" type=
"int" default=
""/>
17026 <param name=
"y" type=
"int" default=
""/>
17029 <method name=
"GetMarginX" type=
"int" overloaded=
"no">
17030 <autodoc>GetMarginX(self) -
> int
</autodoc>
17032 <method name=
"GetMarginY" type=
"int" overloaded=
"no">
17033 <autodoc>GetMarginY(self) -
> int
</autodoc>
17037 #---------------------------------------------------------------------------
17039 <class name=
"CheckBox" oldname=
"wxCheckBox" module=
"_controls">
17040 <docstring>A checkbox is a labelled box which by default is either on (the
17041 checkmark is visible) or off (no checkmark). Optionally (When the
17042 wx.CHK_3STATE style flag is set) it can have a third state, called the
17043 mixed or undetermined state. Often this is used as a "Does Not
17048 ================================= ===============================
17049 wx.CHK_2STATE Create a
2-state checkbox.
17050 This is the default.
17051 wx.CHK_3STATE Create a
3-state checkbox.
17052 wx.CHK_ALLOW_3RD_STATE_FOR_USER By default a user can't set a
17053 3-state checkbox to the
17054 third state. It can only be
17055 done from code. Using this
17056 flags allows the user to set
17057 the checkbox to the third
17059 wx.ALIGN_RIGHT Makes the
17060 text appear on the left of
17062 ================================= ===============================
17066 =============================== ===============================
17067 EVT_CHECKBOX Sent when checkbox is clicked.
17068 =============================== ===============================
17070 <baseclass name=
"Control"/>
17071 <constructor name=
"CheckBox" overloaded=
"no">
17072 <autodoc>__init__(self, Window parent, int id=-
1, String label=EmptyString,
17073 Point pos=DefaultPosition, Size size=DefaultSize,
17074 long style=
0, Validator validator=DefaultValidator,
17075 String name=CheckBoxNameStr) -
> CheckBox
</autodoc>
17076 <docstring>Creates and shows a CheckBox control
</docstring>
17078 <param name=
"parent" type=
"Window" default=
""/>
17079 <param name=
"id" type=
"int" default=
"-1"/>
17080 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
17081 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17082 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17083 <param name=
"style" type=
"long" default=
"0"/>
17084 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17085 <param name=
"name" type=
"String" default=
"wxPyCheckBoxNameStr"/>
17088 <constructor name=
"PreCheckBox" overloaded=
"no">
17089 <autodoc>PreCheckBox() -
> CheckBox
</autodoc>
17090 <docstring>Precreate a CheckBox for
2-phase creation.
</docstring>
17092 <method name=
"Create" type=
"bool" overloaded=
"no">
17093 <autodoc>Create(self, Window parent, int id=-
1, String label=EmptyString,
17094 Point pos=DefaultPosition, Size size=DefaultSize,
17095 long style=
0, Validator validator=DefaultValidator,
17096 String name=CheckBoxNameStr) -
> bool
</autodoc>
17097 <docstring>Actually create the GUI CheckBox for
2-phase creation.
</docstring>
17099 <param name=
"parent" type=
"Window" default=
""/>
17100 <param name=
"id" type=
"int" default=
"-1"/>
17101 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
17102 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17103 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17104 <param name=
"style" type=
"long" default=
"0"/>
17105 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17106 <param name=
"name" type=
"String" default=
"wxPyCheckBoxNameStr"/>
17109 <method name=
"GetValue" type=
"bool" overloaded=
"no">
17110 <autodoc>GetValue(self) -
> bool
</autodoc>
17111 <docstring>Gets the state of a
2-state CheckBox. Returns True if it is checked,
17112 False otherwise.
</docstring>
17114 <method name=
"IsChecked" type=
"bool" overloaded=
"no">
17115 <autodoc>IsChecked(self) -
> bool
</autodoc>
17116 <docstring>Similar to GetValue, but raises an exception if it is not a
2-state
17117 CheckBox.
</docstring>
17119 <method name=
"SetValue" type=
"" overloaded=
"no">
17120 <autodoc>SetValue(self, bool state)
</autodoc>
17121 <docstring>Set the state of a
2-state CheckBox. Pass True for checked, False for
17122 unchecked.
</docstring>
17124 <param name=
"state" type=
"bool" default=
""/>
17127 <method name=
"Get3StateValue" type=
"wxCheckBoxState" overloaded=
"no">
17128 <autodoc>Get3StateValue(self) -
> int
</autodoc>
17129 <docstring>Returns wx.CHK_UNCHECKED when the CheckBox is unchecked,
17130 wx.CHK_CHECKED when it is checked and wx.CHK_UNDETERMINED when it's in
17131 the undetermined state. Raises an exceptiion when the function is
17132 used with a
2-state CheckBox.
</docstring>
17134 <method name=
"Set3StateValue" type=
"" overloaded=
"no">
17135 <autodoc>Set3StateValue(self, int state)
</autodoc>
17136 <docstring>Sets the CheckBox to the given state. The state parameter can be one
17137 of the following: wx.CHK_UNCHECKED (Check is off), wx.CHK_CHECKED (the
17138 Check is on) or wx.CHK_UNDETERMINED (Check is mixed). Raises an
17139 exception when the CheckBox is a
2-state checkbox and setting the
17140 state to wx.CHK_UNDETERMINED.
</docstring>
17142 <param name=
"state" type=
"wxCheckBoxState" default=
""/>
17145 <method name=
"Is3State" type=
"bool" overloaded=
"no">
17146 <autodoc>Is3State(self) -
> bool
</autodoc>
17147 <docstring>Returns whether or not the CheckBox is a
3-state CheckBox.
</docstring>
17149 <method name=
"Is3rdStateAllowedForUser" type=
"bool" overloaded=
"no">
17150 <autodoc>Is3rdStateAllowedForUser(self) -
> bool
</autodoc>
17151 <docstring>Returns whether or not the user can set the CheckBox to the third
17154 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17155 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17156 <docstring>Get the default attributes for this class. This is useful if you want
17157 to use the same font or colour in your own control as in a standard
17158 control -- which is a much better idea than hard coding specific
17159 colours or fonts which might look completely out of place on the
17160 user's system, especially if it uses themes.
17162 The variant parameter is only relevant under Mac currently and is
17163 ignore under other platforms. Under Mac, it will change the size of
17164 the returned font. See `wx.Window.SetWindowVariant` for more about
17167 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17172 #---------------------------------------------------------------------------
17174 <class name=
"Choice" oldname=
"wxChoice" module=
"_controls">
17175 <docstring>A Choice control is used to select one of a list of strings.
17176 Unlike a `wx.ListBox`, only the selection is visible until the
17177 user pulls down the menu of choices.
17181 ================ ==========================================
17182 EVT_CHOICE Sent when an item in the list is selected.
17183 ================ ==========================================
17185 <baseclass name=
"ControlWithItems"/>
17186 <constructor name=
"Choice" overloaded=
"no">
17187 <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
17188 List choices=[], long style=
0, Validator validator=DefaultValidator,
17189 String name=ChoiceNameStr) -
> Choice
</autodoc>
17190 <docstring>Create and show a Choice control
</docstring>
17192 <param name=
"parent" type=
"Window" default=
""/>
17193 <param name=
"id" type=
"int" default=
"-1"/>
17194 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17195 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17196 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
17197 <param name=
"style" type=
"long" default=
"0"/>
17198 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17199 <param name=
"name" type=
"String" default=
"wxPyChoiceNameStr"/>
17202 <constructor name=
"PreChoice" overloaded=
"no">
17203 <autodoc>PreChoice() -
> Choice
</autodoc>
17204 <docstring>Precreate a Choice control for
2-phase creation.
</docstring>
17206 <method name=
"Create" type=
"bool" overloaded=
"no">
17207 <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
17208 List choices=[], long style=
0, Validator validator=DefaultValidator,
17209 String name=ChoiceNameStr) -
> bool
</autodoc>
17210 <docstring>Actually create the GUI Choice control for
2-phase creation
</docstring>
17212 <param name=
"parent" type=
"Window" default=
""/>
17213 <param name=
"id" type=
"int" default=
"-1"/>
17214 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17215 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17216 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
17217 <param name=
"style" type=
"long" default=
"0"/>
17218 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17219 <param name=
"name" type=
"String" default=
"wxPyChoiceNameStr"/>
17222 <method name=
"SetSelection" type=
"" overloaded=
"no">
17223 <autodoc>SetSelection(self, int n)
</autodoc>
17224 <docstring>Select the n'th item (zero based) in the list.
</docstring>
17226 <param name=
"n" type=
"int" default=
""/>
17229 <method name=
"SetStringSelection" type=
"bool" overloaded=
"no">
17230 <autodoc>SetStringSelection(self, String string) -
> bool
</autodoc>
17231 <docstring>Select the item with the specifed string
</docstring>
17233 <param name=
"string" type=
"String" default=
""/>
17236 <method name=
"SetString" type=
"" overloaded=
"no">
17237 <autodoc>SetString(self, int n, String string)
</autodoc>
17238 <docstring>Set the label for the n'th item (zero based) in the list.
</docstring>
17240 <param name=
"n" type=
"int" default=
""/>
17241 <param name=
"string" type=
"String" default=
""/>
17244 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17245 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17246 <docstring>Get the default attributes for this class. This is useful if you want
17247 to use the same font or colour in your own control as in a standard
17248 control -- which is a much better idea than hard coding specific
17249 colours or fonts which might look completely out of place on the
17250 user's system, especially if it uses themes.
17252 The variant parameter is only relevant under Mac currently and is
17253 ignore under other platforms. Under Mac, it will change the size of
17254 the returned font. See `wx.Window.SetWindowVariant` for more about
17257 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17262 #---------------------------------------------------------------------------
17264 <class name=
"ComboBox" oldname=
"wxComboBox" module=
"_controls">
17265 <docstring>A combobox is like a combination of an edit control and a
17266 listbox. It can be displayed as static list with editable or
17267 read-only text field; or a drop-down list with text field.
17269 A combobox permits a single selection only. Combobox items are
17270 numbered from zero.
17274 ================ ===============================================
17275 wx.CB_SIMPLE Creates a combobox with a permanently
17276 displayed list. Windows only.
17278 wx.CB_DROPDOWN Creates a combobox with a drop-down list.
17280 wx.CB_READONLY Same as wxCB_DROPDOWN but only the strings
17281 specified as the combobox choices can be
17282 selected, it is impossible to select
17283 (even from a program) a string which is
17284 not in the choices list.
17286 wx.CB_SORT Sorts the entries in the list alphabetically.
17287 ================ ===============================================
17291 ================ ===============================================
17292 EVT_COMBOBOX Sent when an item on the list is selected.
17293 EVT_TEXT Sent when the combobox text changes.
17294 ================ ===============================================
17296 <baseclass name=
"Control"/>
17297 <baseclass name=
"ItemContainer"/>
17298 <constructor name=
"ComboBox" overloaded=
"no">
17299 <autodoc>__init__(Window parent, int id, String value=EmptyString,
17300 Point pos=DefaultPosition, Size size=DefaultSize,
17301 List choices=[], long style=
0, Validator validator=DefaultValidator,
17302 String name=ComboBoxNameStr) -
> ComboBox
</autodoc>
17303 <docstring>Constructor, creates and shows a ComboBox control.
</docstring>
17305 <param name=
"parent" type=
"Window" default=
""/>
17306 <param name=
"id" type=
"int" default=
"-1"/>
17307 <param name=
"value" type=
"String" default=
"wxPyEmptyString"/>
17308 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17309 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17310 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
17311 <param name=
"style" type=
"long" default=
"0"/>
17312 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17313 <param name=
"name" type=
"String" default=
"wxPyComboBoxNameStr"/>
17316 <constructor name=
"PreComboBox" overloaded=
"no">
17317 <autodoc>PreComboBox() -
> ComboBox
</autodoc>
17318 <docstring>Precreate a ComboBox control for
2-phase creation.
</docstring>
17320 <method name=
"Create" type=
"bool" overloaded=
"no">
17321 <autodoc>Create(Window parent, int id, String value=EmptyString,
17322 Point pos=DefaultPosition, Size size=DefaultSize,
17323 List choices=[], long style=
0, Validator validator=DefaultValidator,
17324 String name=ChoiceNameStr) -
> bool
</autodoc>
17325 <docstring>Actually create the GUI wxComboBox control for
2-phase creation
</docstring>
17327 <param name=
"parent" type=
"Window" default=
""/>
17328 <param name=
"id" type=
"int" default=
"-1"/>
17329 <param name=
"value" type=
"String" default=
"wxPyEmptyString"/>
17330 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17331 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17332 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
17333 <param name=
"style" type=
"long" default=
"0"/>
17334 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17335 <param name=
"name" type=
"String" default=
"wxPyChoiceNameStr"/>
17338 <method name=
"GetValue" type=
"String" overloaded=
"no">
17339 <autodoc>GetValue(self) -
> String
</autodoc>
17340 <docstring>Returns the current value in the combobox text field.
</docstring>
17342 <method name=
"SetValue" type=
"" overloaded=
"no">
17343 <autodoc>SetValue(self, String value)
</autodoc>
17345 <param name=
"value" type=
"String" default=
""/>
17348 <method name=
"Copy" type=
"" overloaded=
"no">
17349 <autodoc>Copy(self)
</autodoc>
17350 <docstring>Copies the selected text to the clipboard.
</docstring>
17352 <method name=
"Cut" type=
"" overloaded=
"no">
17353 <autodoc>Cut(self)
</autodoc>
17354 <docstring>Copies the selected text to the clipboard and removes the selection.
</docstring>
17356 <method name=
"Paste" type=
"" overloaded=
"no">
17357 <autodoc>Paste(self)
</autodoc>
17358 <docstring>Pastes text from the clipboard to the text field.
</docstring>
17360 <method name=
"SetInsertionPoint" type=
"" overloaded=
"no">
17361 <autodoc>SetInsertionPoint(self, long pos)
</autodoc>
17362 <docstring>Sets the insertion point in the combobox text field.
</docstring>
17364 <param name=
"pos" type=
"long" default=
""/>
17367 <method name=
"GetInsertionPoint" type=
"long" overloaded=
"no">
17368 <autodoc>GetInsertionPoint(self) -
> long
</autodoc>
17369 <docstring>Returns the insertion point for the combobox's text field.
</docstring>
17371 <method name=
"GetLastPosition" type=
"long" overloaded=
"no">
17372 <autodoc>GetLastPosition(self) -
> long
</autodoc>
17373 <docstring>Returns the last position in the combobox text field.
</docstring>
17375 <method name=
"Replace" type=
"" overloaded=
"no">
17376 <autodoc>Replace(self, long from, long to, String value)
</autodoc>
17377 <docstring>Replaces the text between two positions with the given text, in the
17378 combobox text field.
</docstring>
17380 <param name=
"from" type=
"long" default=
""/>
17381 <param name=
"to" type=
"long" default=
""/>
17382 <param name=
"value" type=
"String" default=
""/>
17385 <method name=
"SetSelection" type=
"" overloaded=
"no">
17386 <autodoc>SetSelection(self, int n)
</autodoc>
17387 <docstring>Sets the item at index 'n' to be the selected item.
</docstring>
17389 <param name=
"n" type=
"int" default=
""/>
17392 <method name=
"SetMark" type=
"" overloaded=
"no">
17393 <autodoc>SetMark(self, long from, long to)
</autodoc>
17394 <docstring>Selects the text between the two positions in the combobox text field.
</docstring>
17396 <param name=
"from" type=
"long" default=
""/>
17397 <param name=
"to" type=
"long" default=
""/>
17400 <method name=
"SetStringSelection" type=
"bool" overloaded=
"no">
17401 <autodoc>SetStringSelection(self, String string) -
> bool
</autodoc>
17402 <docstring>Select the item with the specifed string
</docstring>
17404 <param name=
"string" type=
"String" default=
""/>
17407 <method name=
"SetString" type=
"" overloaded=
"no">
17408 <autodoc>SetString(self, int n, String string)
</autodoc>
17409 <docstring>Set the label for the n'th item (zero based) in the list.
</docstring>
17411 <param name=
"n" type=
"int" default=
""/>
17412 <param name=
"string" type=
"String" default=
""/>
17415 <method name=
"SetEditable" type=
"" overloaded=
"no">
17416 <autodoc>SetEditable(self, bool editable)
</autodoc>
17418 <param name=
"editable" type=
"bool" default=
""/>
17421 <method name=
"SetInsertionPointEnd" type=
"" overloaded=
"no">
17422 <autodoc>SetInsertionPointEnd(self)
</autodoc>
17423 <docstring>Sets the insertion point at the end of the combobox text field.
</docstring>
17425 <method name=
"Remove" type=
"" overloaded=
"no">
17426 <autodoc>Remove(self, long from, long to)
</autodoc>
17427 <docstring>Removes the text between the two positions in the combobox text field.
</docstring>
17429 <param name=
"from" type=
"long" default=
""/>
17430 <param name=
"to" type=
"long" default=
""/>
17433 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17434 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17435 <docstring>Get the default attributes for this class. This is useful if you want
17436 to use the same font or colour in your own control as in a standard
17437 control -- which is a much better idea than hard coding specific
17438 colours or fonts which might look completely out of place on the
17439 user's system, especially if it uses themes.
17441 The variant parameter is only relevant under Mac currently and is
17442 ignore under other platforms. Under Mac, it will change the size of
17443 the returned font. See `wx.Window.SetWindowVariant` for more about
17446 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17451 #---------------------------------------------------------------------------
17453 <class name=
"Gauge" oldname=
"wxGauge" module=
"_controls">
17454 <baseclass name=
"Control"/>
17455 <constructor name=
"Gauge" overloaded=
"no">
17456 <autodoc>__init__(self, Window parent, int id=-
1, int range=
100, Point pos=DefaultPosition,
17457 Size size=DefaultSize, long style=GA_HORIZONTAL,
17458 Validator validator=DefaultValidator,
17459 String name=GaugeNameStr) -
> Gauge
</autodoc>
17461 <param name=
"parent" type=
"Window" default=
""/>
17462 <param name=
"id" type=
"int" default=
"-1"/>
17463 <param name=
"range" type=
"int" default=
"100"/>
17464 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17465 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17466 <param name=
"style" type=
"long" default=
"wxGA_HORIZONTAL"/>
17467 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17468 <param name=
"name" type=
"String" default=
"wxPyGaugeNameStr"/>
17471 <constructor name=
"PreGauge" overloaded=
"no">
17472 <autodoc>PreGauge() -
> Gauge
</autodoc>
17474 <method name=
"Create" type=
"bool" overloaded=
"no">
17475 <autodoc>Create(self, Window parent, int id=-
1, int range=
100, Point pos=DefaultPosition,
17476 Size size=DefaultSize, long style=GA_HORIZONTAL,
17477 Validator validator=DefaultValidator,
17478 String name=GaugeNameStr) -
> bool
</autodoc>
17480 <param name=
"parent" type=
"Window" default=
""/>
17481 <param name=
"id" type=
"int" default=
"-1"/>
17482 <param name=
"range" type=
"int" default=
"100"/>
17483 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17484 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17485 <param name=
"style" type=
"long" default=
"wxGA_HORIZONTAL"/>
17486 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17487 <param name=
"name" type=
"String" default=
"wxPyGaugeNameStr"/>
17490 <method name=
"SetRange" type=
"" overloaded=
"no">
17491 <autodoc>SetRange(self, int range)
</autodoc>
17493 <param name=
"range" type=
"int" default=
""/>
17496 <method name=
"GetRange" type=
"int" overloaded=
"no">
17497 <autodoc>GetRange(self) -
> int
</autodoc>
17499 <method name=
"SetValue" type=
"" overloaded=
"no">
17500 <autodoc>SetValue(self, int pos)
</autodoc>
17502 <param name=
"pos" type=
"int" default=
""/>
17505 <method name=
"GetValue" type=
"int" overloaded=
"no">
17506 <autodoc>GetValue(self) -
> int
</autodoc>
17508 <method name=
"IsVertical" type=
"bool" overloaded=
"no">
17509 <autodoc>IsVertical(self) -
> bool
</autodoc>
17511 <method name=
"SetShadowWidth" type=
"" overloaded=
"no">
17512 <autodoc>SetShadowWidth(self, int w)
</autodoc>
17514 <param name=
"w" type=
"int" default=
""/>
17517 <method name=
"GetShadowWidth" type=
"int" overloaded=
"no">
17518 <autodoc>GetShadowWidth(self) -
> int
</autodoc>
17520 <method name=
"SetBezelFace" type=
"" overloaded=
"no">
17521 <autodoc>SetBezelFace(self, int w)
</autodoc>
17523 <param name=
"w" type=
"int" default=
""/>
17526 <method name=
"GetBezelFace" type=
"int" overloaded=
"no">
17527 <autodoc>GetBezelFace(self) -
> int
</autodoc>
17529 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17530 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17531 <docstring>Get the default attributes for this class. This is useful if you want
17532 to use the same font or colour in your own control as in a standard
17533 control -- which is a much better idea than hard coding specific
17534 colours or fonts which might look completely out of place on the
17535 user's system, especially if it uses themes.
17537 The variant parameter is only relevant under Mac currently and is
17538 ignore under other platforms. Under Mac, it will change the size of
17539 the returned font. See `wx.Window.SetWindowVariant` for more about
17542 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17547 #---------------------------------------------------------------------------
17549 <class name=
"StaticBox" oldname=
"wxStaticBox" module=
"_controls">
17550 <baseclass name=
"Control"/>
17551 <constructor name=
"StaticBox" overloaded=
"no">
17552 <autodoc>__init__(self, Window parent, int id=-
1, String label=EmptyString,
17553 Point pos=DefaultPosition, Size size=DefaultSize,
17554 long style=
0, String name=StaticBoxNameStr) -
> StaticBox
</autodoc>
17556 <param name=
"parent" type=
"Window" default=
""/>
17557 <param name=
"id" type=
"int" default=
"-1"/>
17558 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
17559 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17560 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17561 <param name=
"style" type=
"long" default=
"0"/>
17562 <param name=
"name" type=
"String" default=
"wxPyStaticBoxNameStr"/>
17565 <constructor name=
"PreStaticBox" overloaded=
"no">
17566 <autodoc>PreStaticBox() -
> StaticBox
</autodoc>
17568 <method name=
"Create" type=
"bool" overloaded=
"no">
17569 <autodoc>Create(self, Window parent, int id=-
1, String label=EmptyString,
17570 Point pos=DefaultPosition, Size size=DefaultSize,
17571 long style=
0, String name=StaticBoxNameStr) -
> bool
</autodoc>
17573 <param name=
"parent" type=
"Window" default=
""/>
17574 <param name=
"id" type=
"int" default=
"-1"/>
17575 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
17576 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17577 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17578 <param name=
"style" type=
"long" default=
"0"/>
17579 <param name=
"name" type=
"String" default=
"wxPyStaticBoxNameStr"/>
17582 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17583 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17584 <docstring>Get the default attributes for this class. This is useful if you want
17585 to use the same font or colour in your own control as in a standard
17586 control -- which is a much better idea than hard coding specific
17587 colours or fonts which might look completely out of place on the
17588 user's system, especially if it uses themes.
17590 The variant parameter is only relevant under Mac currently and is
17591 ignore under other platforms. Under Mac, it will change the size of
17592 the returned font. See `wx.Window.SetWindowVariant` for more about
17595 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17600 #---------------------------------------------------------------------------
17602 <class name=
"StaticLine" oldname=
"wxStaticLine" module=
"_controls">
17603 <baseclass name=
"Control"/>
17604 <constructor name=
"StaticLine" overloaded=
"no">
17605 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
17606 Size size=DefaultSize, long style=LI_HORIZONTAL,
17607 String name=StaticTextNameStr) -
> StaticLine
</autodoc>
17609 <param name=
"parent" type=
"Window" default=
""/>
17610 <param name=
"id" type=
"int" default=
"-1"/>
17611 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17612 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17613 <param name=
"style" type=
"long" default=
"wxLI_HORIZONTAL"/>
17614 <param name=
"name" type=
"String" default=
"wxPyStaticTextNameStr"/>
17617 <constructor name=
"PreStaticLine" overloaded=
"no">
17618 <autodoc>PreStaticLine() -
> StaticLine
</autodoc>
17620 <method name=
"Create" type=
"bool" overloaded=
"no">
17621 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
17622 Size size=DefaultSize, long style=LI_HORIZONTAL,
17623 String name=StaticTextNameStr) -
> bool
</autodoc>
17625 <param name=
"parent" type=
"Window" default=
""/>
17626 <param name=
"id" type=
"int" default=
"-1"/>
17627 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17628 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17629 <param name=
"style" type=
"long" default=
"wxLI_HORIZONTAL"/>
17630 <param name=
"name" type=
"String" default=
"wxPyStaticTextNameStr"/>
17633 <method name=
"IsVertical" type=
"bool" overloaded=
"no">
17634 <autodoc>IsVertical(self) -
> bool
</autodoc>
17636 <staticmethod name=
"GetDefaultSize" type=
"int" overloaded=
"no">
17637 <autodoc>GetDefaultSize() -
> int
</autodoc>
17639 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17640 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17641 <docstring>Get the default attributes for this class. This is useful if you want
17642 to use the same font or colour in your own control as in a standard
17643 control -- which is a much better idea than hard coding specific
17644 colours or fonts which might look completely out of place on the
17645 user's system, especially if it uses themes.
17647 The variant parameter is only relevant under Mac currently and is
17648 ignore under other platforms. Under Mac, it will change the size of
17649 the returned font. See `wx.Window.SetWindowVariant` for more about
17652 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17657 #---------------------------------------------------------------------------
17659 <class name=
"StaticText" oldname=
"wxStaticText" module=
"_controls">
17660 <baseclass name=
"Control"/>
17661 <constructor name=
"StaticText" overloaded=
"no">
17662 <autodoc>__init__(self, Window parent, int id=-
1, String label=EmptyString,
17663 Point pos=DefaultPosition, Size size=DefaultSize,
17664 long style=
0, String name=StaticTextNameStr) -
> StaticText
</autodoc>
17666 <param name=
"parent" type=
"Window" default=
""/>
17667 <param name=
"id" type=
"int" default=
"-1"/>
17668 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
17669 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17670 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17671 <param name=
"style" type=
"long" default=
"0"/>
17672 <param name=
"name" type=
"String" default=
"wxPyStaticTextNameStr"/>
17675 <constructor name=
"PreStaticText" overloaded=
"no">
17676 <autodoc>PreStaticText() -
> StaticText
</autodoc>
17678 <method name=
"Create" type=
"bool" overloaded=
"no">
17679 <autodoc>Create(self, Window parent, int id=-
1, String label=EmptyString,
17680 Point pos=DefaultPosition, Size size=DefaultSize,
17681 long style=
0, String name=StaticTextNameStr) -
> bool
</autodoc>
17683 <param name=
"parent" type=
"Window" default=
""/>
17684 <param name=
"id" type=
"int" default=
"-1"/>
17685 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
17686 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17687 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17688 <param name=
"style" type=
"long" default=
"0"/>
17689 <param name=
"name" type=
"String" default=
"wxPyStaticTextNameStr"/>
17692 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17693 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17694 <docstring>Get the default attributes for this class. This is useful if you want
17695 to use the same font or colour in your own control as in a standard
17696 control -- which is a much better idea than hard coding specific
17697 colours or fonts which might look completely out of place on the
17698 user's system, especially if it uses themes.
17700 The variant parameter is only relevant under Mac currently and is
17701 ignore under other platforms. Under Mac, it will change the size of
17702 the returned font. See `wx.Window.SetWindowVariant` for more about
17705 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17710 #---------------------------------------------------------------------------
17712 <class name=
"StaticBitmap" oldname=
"wxStaticBitmap" module=
"_controls">
17713 <baseclass name=
"Control"/>
17714 <constructor name=
"StaticBitmap" overloaded=
"no">
17715 <autodoc>__init__(self, Window parent, int id=-
1, Bitmap bitmap=wxNullBitmap,
17716 Point pos=DefaultPosition, Size size=DefaultSize,
17717 long style=
0, String name=StaticBitmapNameStr) -
> StaticBitmap
</autodoc>
17719 <param name=
"parent" type=
"Window" default=
""/>
17720 <param name=
"id" type=
"int" default=
"-1"/>
17721 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
17722 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17723 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17724 <param name=
"style" type=
"long" default=
"0"/>
17725 <param name=
"name" type=
"String" default=
"wxPyStaticBitmapNameStr"/>
17728 <constructor name=
"PreStaticBitmap" overloaded=
"no">
17729 <autodoc>PreStaticBitmap() -
> StaticBitmap
</autodoc>
17731 <method name=
"Create" type=
"bool" overloaded=
"no">
17732 <autodoc>Create(self, Window parent, int id=-
1, Bitmap bitmap=wxNullBitmap,
17733 Point pos=DefaultPosition, Size size=DefaultSize,
17734 long style=
0, String name=StaticBitmapNameStr) -
> bool
</autodoc>
17736 <param name=
"parent" type=
"Window" default=
""/>
17737 <param name=
"id" type=
"int" default=
"-1"/>
17738 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
17739 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17740 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17741 <param name=
"style" type=
"long" default=
"0"/>
17742 <param name=
"name" type=
"String" default=
"wxPyStaticBitmapNameStr"/>
17745 <method name=
"GetBitmap" type=
"Bitmap" overloaded=
"no">
17746 <autodoc>GetBitmap(self) -
> Bitmap
</autodoc>
17748 <method name=
"SetBitmap" type=
"" overloaded=
"no">
17749 <autodoc>SetBitmap(self, Bitmap bitmap)
</autodoc>
17751 <param name=
"bitmap" type=
"Bitmap" default=
""/>
17754 <method name=
"SetIcon" type=
"" overloaded=
"no">
17755 <autodoc>SetIcon(self, Icon icon)
</autodoc>
17757 <param name=
"icon" type=
"Icon" default=
""/>
17760 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17761 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17762 <docstring>Get the default attributes for this class. This is useful if you want
17763 to use the same font or colour in your own control as in a standard
17764 control -- which is a much better idea than hard coding specific
17765 colours or fonts which might look completely out of place on the
17766 user's system, especially if it uses themes.
17768 The variant parameter is only relevant under Mac currently and is
17769 ignore under other platforms. Under Mac, it will change the size of
17770 the returned font. See `wx.Window.SetWindowVariant` for more about
17773 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17778 #---------------------------------------------------------------------------
17780 <class name=
"ListBox" oldname=
"wxListBox" module=
"_controls">
17781 <baseclass name=
"ControlWithItems"/>
17782 <constructor name=
"ListBox" overloaded=
"no">
17783 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
17784 Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
17785 long style=
0, Validator validator=DefaultValidator,
17786 String name=ListBoxNameStr) -
> ListBox
</autodoc>
17788 <param name=
"parent" type=
"Window" default=
""/>
17789 <param name=
"id" type=
"int" default=
"-1"/>
17790 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17791 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17792 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
17793 <param name=
"style" type=
"long" default=
"0"/>
17794 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17795 <param name=
"name" type=
"String" default=
"wxPyListBoxNameStr"/>
17798 <constructor name=
"PreListBox" overloaded=
"no">
17799 <autodoc>PreListBox() -
> ListBox
</autodoc>
17801 <method name=
"Create" type=
"bool" overloaded=
"no">
17802 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
17803 Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
17804 long style=
0, Validator validator=DefaultValidator,
17805 String name=ListBoxNameStr) -
> bool
</autodoc>
17807 <param name=
"parent" type=
"Window" default=
""/>
17808 <param name=
"id" type=
"int" default=
"-1"/>
17809 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17810 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17811 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
17812 <param name=
"style" type=
"long" default=
"0"/>
17813 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17814 <param name=
"name" type=
"String" default=
"wxPyListBoxNameStr"/>
17817 <method name=
"Insert" type=
"" overloaded=
"no">
17818 <autodoc>Insert(self, String item, int pos, PyObject clientData=None)
</autodoc>
17819 <docstring>Insert an item into the control before the item at the ``pos`` index,
17820 optionally associating some data object with the item.
</docstring>
17822 <param name=
"item" type=
"String" default=
""/>
17823 <param name=
"pos" type=
"int" default=
""/>
17824 <param name=
"clientData" type=
"PyObject" default=
"NULL"/>
17827 <method name=
"InsertItems" type=
"" overloaded=
"no">
17828 <autodoc>InsertItems(self, wxArrayString items, int pos)
</autodoc>
17830 <param name=
"items" type=
"wxArrayString" default=
""/>
17831 <param name=
"pos" type=
"int" default=
""/>
17834 <method name=
"Set" type=
"" overloaded=
"no">
17835 <autodoc>Set(self, wxArrayString items)
</autodoc>
17837 <param name=
"items" type=
"wxArrayString" default=
""/>
17840 <method name=
"IsSelected" type=
"bool" overloaded=
"no">
17841 <autodoc>IsSelected(self, int n) -
> bool
</autodoc>
17843 <param name=
"n" type=
"int" default=
""/>
17846 <method name=
"SetSelection" type=
"" overloaded=
"no">
17847 <autodoc>SetSelection(self, int n, bool select=True)
</autodoc>
17849 <param name=
"n" type=
"int" default=
""/>
17850 <param name=
"select" type=
"bool" default=
"True"/>
17853 <method name=
"Select" type=
"" overloaded=
"no">
17854 <autodoc>Select(self, int n)
</autodoc>
17855 <docstring>Sets the item at index 'n' to be the selected item.
</docstring>
17857 <param name=
"n" type=
"int" default=
""/>
17860 <method name=
"Deselect" type=
"" overloaded=
"no">
17861 <autodoc>Deselect(self, int n)
</autodoc>
17863 <param name=
"n" type=
"int" default=
""/>
17866 <method name=
"DeselectAll" type=
"" overloaded=
"no">
17867 <autodoc>DeselectAll(self, int itemToLeaveSelected=-
1)
</autodoc>
17869 <param name=
"itemToLeaveSelected" type=
"int" default=
"-1"/>
17872 <method name=
"SetStringSelection" type=
"bool" overloaded=
"no">
17873 <autodoc>SetStringSelection(self, String s, bool select=True) -
> bool
</autodoc>
17875 <param name=
"s" type=
"String" default=
""/>
17876 <param name=
"select" type=
"bool" default=
"True"/>
17879 <method name=
"GetSelections" type=
"PyObject" overloaded=
"no">
17880 <autodoc>GetSelections(self) -
> PyObject
</autodoc>
17882 <method name=
"SetFirstItem" type=
"" overloaded=
"no">
17883 <autodoc>SetFirstItem(self, int n)
</autodoc>
17885 <param name=
"n" type=
"int" default=
""/>
17888 <method name=
"SetFirstItemStr" type=
"" overloaded=
"no">
17889 <autodoc>SetFirstItemStr(self, String s)
</autodoc>
17891 <param name=
"s" type=
"String" default=
""/>
17894 <method name=
"EnsureVisible" type=
"" overloaded=
"no">
17895 <autodoc>EnsureVisible(self, int n)
</autodoc>
17897 <param name=
"n" type=
"int" default=
""/>
17900 <method name=
"AppendAndEnsureVisible" type=
"" overloaded=
"no">
17901 <autodoc>AppendAndEnsureVisible(self, String s)
</autodoc>
17903 <param name=
"s" type=
"String" default=
""/>
17906 <method name=
"IsSorted" type=
"bool" overloaded=
"no">
17907 <autodoc>IsSorted(self) -
> bool
</autodoc>
17909 <method name=
"SetItemForegroundColour" type=
"" overloaded=
"no">
17910 <autodoc>SetItemForegroundColour(self, int item, Colour c)
</autodoc>
17912 <param name=
"item" type=
"int" default=
""/>
17913 <param name=
"c" type=
"Colour" default=
""/>
17916 <method name=
"SetItemBackgroundColour" type=
"" overloaded=
"no">
17917 <autodoc>SetItemBackgroundColour(self, int item, Colour c)
</autodoc>
17919 <param name=
"item" type=
"int" default=
""/>
17920 <param name=
"c" type=
"Colour" default=
""/>
17923 <method name=
"SetItemFont" type=
"" overloaded=
"no">
17924 <autodoc>SetItemFont(self, int item, Font f)
</autodoc>
17926 <param name=
"item" type=
"int" default=
""/>
17927 <param name=
"f" type=
"Font" default=
""/>
17930 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
17931 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
17932 <docstring>Get the default attributes for this class. This is useful if you want
17933 to use the same font or colour in your own control as in a standard
17934 control -- which is a much better idea than hard coding specific
17935 colours or fonts which might look completely out of place on the
17936 user's system, especially if it uses themes.
17938 The variant parameter is only relevant under Mac currently and is
17939 ignore under other platforms. Under Mac, it will change the size of
17940 the returned font. See `wx.Window.SetWindowVariant` for more about
17943 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
17948 #---------------------------------------------------------------------------
17950 <class name=
"CheckListBox" oldname=
"wxCheckListBox" module=
"_controls">
17951 <baseclass name=
"ListBox"/>
17952 <constructor name=
"CheckListBox" overloaded=
"no">
17953 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
17954 Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
17955 long style=
0, Validator validator=DefaultValidator,
17956 String name=ListBoxNameStr) -
> CheckListBox
</autodoc>
17958 <param name=
"parent" type=
"Window" default=
""/>
17959 <param name=
"id" type=
"int" default=
"-1"/>
17960 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17961 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17962 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
17963 <param name=
"style" type=
"long" default=
"0"/>
17964 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17965 <param name=
"name" type=
"String" default=
"wxPyListBoxNameStr"/>
17968 <constructor name=
"PreCheckListBox" overloaded=
"no">
17969 <autodoc>PreCheckListBox() -
> CheckListBox
</autodoc>
17971 <method name=
"Create" type=
"bool" overloaded=
"no">
17972 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
17973 Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray,
17974 long style=
0, Validator validator=DefaultValidator,
17975 String name=ListBoxNameStr) -
> bool
</autodoc>
17977 <param name=
"parent" type=
"Window" default=
""/>
17978 <param name=
"id" type=
"int" default=
"-1"/>
17979 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
17980 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
17981 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
17982 <param name=
"style" type=
"long" default=
"0"/>
17983 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
17984 <param name=
"name" type=
"String" default=
"wxPyListBoxNameStr"/>
17987 <method name=
"IsChecked" type=
"bool" overloaded=
"no">
17988 <autodoc>IsChecked(self, int index) -
> bool
</autodoc>
17990 <param name=
"index" type=
"int" default=
""/>
17993 <method name=
"Check" type=
"" overloaded=
"no">
17994 <autodoc>Check(self, int index, int check=True)
</autodoc>
17996 <param name=
"index" type=
"int" default=
""/>
17997 <param name=
"check" type=
"int" default=
"True"/>
18000 <method name=
"GetItemHeight" type=
"int" overloaded=
"no">
18001 <autodoc>GetItemHeight(self) -
> int
</autodoc>
18003 <method name=
"HitTest" type=
"int" overloaded=
"no">
18004 <autodoc>HitTest(self, Point pt) -
> int
</autodoc>
18005 <docstring>Test where the given (in client coords) point lies
</docstring>
18007 <param name=
"pt" type=
"Point" default=
""/>
18010 <method name=
"HitTestXY" type=
"int" overloaded=
"no">
18011 <autodoc>HitTestXY(self, int x, int y) -
> int
</autodoc>
18012 <docstring>Test where the given (in client coords) point lies
</docstring>
18014 <param name=
"x" type=
"int" default=
""/>
18015 <param name=
"y" type=
"int" default=
""/>
18020 #---------------------------------------------------------------------------
18022 <class name=
"TextAttr" oldname=
"wxTextAttr" module=
"_controls">
18023 <constructor name=
"TextAttr" overloaded=
"no">
18024 <autodoc>__init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour,
18025 Font font=wxNullFont, int alignment=TEXT_ALIGNMENT_DEFAULT) -
> TextAttr
</autodoc>
18027 <param name=
"colText" type=
"Colour" default=
"wxNullColour"/>
18028 <param name=
"colBack" type=
"Colour" default=
"wxNullColour"/>
18029 <param name=
"font" type=
"Font" default=
"wxNullFont"/>
18030 <param name=
"alignment" type=
"wxTextAttrAlignment" default=
"wxTEXT_ALIGNMENT_DEFAULT"/>
18033 <destructor name=
"~wxTextAttr" overloaded=
"no">
18034 <autodoc>__del__(self)
</autodoc>
18036 <method name=
"Init" type=
"" overloaded=
"no">
18037 <autodoc>Init(self)
</autodoc>
18039 <method name=
"SetTextColour" type=
"" overloaded=
"no">
18040 <autodoc>SetTextColour(self, Colour colText)
</autodoc>
18042 <param name=
"colText" type=
"Colour" default=
""/>
18045 <method name=
"SetBackgroundColour" type=
"" overloaded=
"no">
18046 <autodoc>SetBackgroundColour(self, Colour colBack)
</autodoc>
18048 <param name=
"colBack" type=
"Colour" default=
""/>
18051 <method name=
"SetFont" type=
"" overloaded=
"no">
18052 <autodoc>SetFont(self, Font font, long flags=TEXT_ATTR_FONT)
</autodoc>
18054 <param name=
"font" type=
"Font" default=
""/>
18055 <param name=
"flags" type=
"long" default=
"wxTEXT_ATTR_FONT"/>
18058 <method name=
"SetAlignment" type=
"" overloaded=
"no">
18059 <autodoc>SetAlignment(self, int alignment)
</autodoc>
18061 <param name=
"alignment" type=
"wxTextAttrAlignment" default=
""/>
18064 <method name=
"SetTabs" type=
"" overloaded=
"no">
18065 <autodoc>SetTabs(self, wxArrayInt tabs)
</autodoc>
18067 <param name=
"tabs" type=
"wxArrayInt" default=
""/>
18070 <method name=
"SetLeftIndent" type=
"" overloaded=
"no">
18071 <autodoc>SetLeftIndent(self, int indent, int subIndent=
0)
</autodoc>
18073 <param name=
"indent" type=
"int" default=
""/>
18074 <param name=
"subIndent" type=
"int" default=
"0"/>
18077 <method name=
"SetRightIndent" type=
"" overloaded=
"no">
18078 <autodoc>SetRightIndent(self, int indent)
</autodoc>
18080 <param name=
"indent" type=
"int" default=
""/>
18083 <method name=
"SetFlags" type=
"" overloaded=
"no">
18084 <autodoc>SetFlags(self, long flags)
</autodoc>
18086 <param name=
"flags" type=
"long" default=
""/>
18089 <method name=
"HasTextColour" type=
"bool" overloaded=
"no">
18090 <autodoc>HasTextColour(self) -
> bool
</autodoc>
18092 <method name=
"HasBackgroundColour" type=
"bool" overloaded=
"no">
18093 <autodoc>HasBackgroundColour(self) -
> bool
</autodoc>
18095 <method name=
"HasFont" type=
"bool" overloaded=
"no">
18096 <autodoc>HasFont(self) -
> bool
</autodoc>
18098 <method name=
"HasAlignment" type=
"bool" overloaded=
"no">
18099 <autodoc>HasAlignment(self) -
> bool
</autodoc>
18101 <method name=
"HasTabs" type=
"bool" overloaded=
"no">
18102 <autodoc>HasTabs(self) -
> bool
</autodoc>
18104 <method name=
"HasLeftIndent" type=
"bool" overloaded=
"no">
18105 <autodoc>HasLeftIndent(self) -
> bool
</autodoc>
18107 <method name=
"HasRightIndent" type=
"bool" overloaded=
"no">
18108 <autodoc>HasRightIndent(self) -
> bool
</autodoc>
18110 <method name=
"HasFlag" type=
"bool" overloaded=
"no">
18111 <autodoc>HasFlag(self, long flag) -
> bool
</autodoc>
18113 <param name=
"flag" type=
"long" default=
""/>
18116 <method name=
"GetTextColour" type=
"Colour" overloaded=
"no">
18117 <autodoc>GetTextColour(self) -
> Colour
</autodoc>
18119 <method name=
"GetBackgroundColour" type=
"Colour" overloaded=
"no">
18120 <autodoc>GetBackgroundColour(self) -
> Colour
</autodoc>
18122 <method name=
"GetFont" type=
"Font" overloaded=
"no">
18123 <autodoc>GetFont(self) -
> Font
</autodoc>
18125 <method name=
"GetAlignment" type=
"wxTextAttrAlignment" overloaded=
"no">
18126 <autodoc>GetAlignment(self) -
> int
</autodoc>
18128 <method name=
"GetTabs" type=
"wxArrayInt" overloaded=
"no">
18129 <autodoc>GetTabs(self) -
> wxArrayInt
</autodoc>
18131 <method name=
"GetLeftIndent" type=
"long" overloaded=
"no">
18132 <autodoc>GetLeftIndent(self) -
> long
</autodoc>
18134 <method name=
"GetLeftSubIndent" type=
"long" overloaded=
"no">
18135 <autodoc>GetLeftSubIndent(self) -
> long
</autodoc>
18137 <method name=
"GetRightIndent" type=
"long" overloaded=
"no">
18138 <autodoc>GetRightIndent(self) -
> long
</autodoc>
18140 <method name=
"GetFlags" type=
"long" overloaded=
"no">
18141 <autodoc>GetFlags(self) -
> long
</autodoc>
18143 <method name=
"IsDefault" type=
"bool" overloaded=
"no">
18144 <autodoc>IsDefault(self) -
> bool
</autodoc>
18146 <staticmethod name=
"Combine" type=
"TextAttr" overloaded=
"no">
18147 <autodoc>Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -
> TextAttr
</autodoc>
18149 <param name=
"attr" type=
"TextAttr" default=
""/>
18150 <param name=
"attrDef" type=
"TextAttr" default=
""/>
18151 <param name=
"text" type=
"wxTextCtrl" default=
""/>
18155 <class name=
"TextCtrl" oldname=
"wxTextCtrl" module=
"_controls">
18156 <baseclass name=
"Control"/>
18157 <constructor name=
"TextCtrl" overloaded=
"no">
18158 <autodoc>__init__(self, Window parent, int id=-
1, String value=EmptyString,
18159 Point pos=DefaultPosition, Size size=DefaultSize,
18160 long style=
0, Validator validator=DefaultValidator,
18161 String name=TextCtrlNameStr) -
> TextCtrl
</autodoc>
18163 <param name=
"parent" type=
"Window" default=
""/>
18164 <param name=
"id" type=
"int" default=
"-1"/>
18165 <param name=
"value" type=
"String" default=
"wxPyEmptyString"/>
18166 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18167 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18168 <param name=
"style" type=
"long" default=
"0"/>
18169 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
18170 <param name=
"name" type=
"String" default=
"wxPyTextCtrlNameStr"/>
18173 <constructor name=
"PreTextCtrl" overloaded=
"no">
18174 <autodoc>PreTextCtrl() -
> TextCtrl
</autodoc>
18176 <method name=
"Create" type=
"bool" overloaded=
"no">
18177 <autodoc>Create(self, Window parent, int id=-
1, String value=EmptyString,
18178 Point pos=DefaultPosition, Size size=DefaultSize,
18179 long style=
0, Validator validator=DefaultValidator,
18180 String name=TextCtrlNameStr) -
> bool
</autodoc>
18182 <param name=
"parent" type=
"Window" default=
""/>
18183 <param name=
"id" type=
"int" default=
"-1"/>
18184 <param name=
"value" type=
"String" default=
"wxPyEmptyString"/>
18185 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18186 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18187 <param name=
"style" type=
"long" default=
"0"/>
18188 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
18189 <param name=
"name" type=
"String" default=
"wxPyTextCtrlNameStr"/>
18192 <method name=
"GetValue" type=
"String" overloaded=
"no">
18193 <autodoc>GetValue(self) -
> String
</autodoc>
18195 <method name=
"SetValue" type=
"" overloaded=
"no">
18196 <autodoc>SetValue(self, String value)
</autodoc>
18198 <param name=
"value" type=
"String" default=
""/>
18201 <method name=
"GetRange" type=
"String" overloaded=
"no">
18202 <autodoc>GetRange(self, long from, long to) -
> String
</autodoc>
18204 <param name=
"from" type=
"long" default=
""/>
18205 <param name=
"to" type=
"long" default=
""/>
18208 <method name=
"GetLineLength" type=
"int" overloaded=
"no">
18209 <autodoc>GetLineLength(self, long lineNo) -
> int
</autodoc>
18211 <param name=
"lineNo" type=
"long" default=
""/>
18214 <method name=
"GetLineText" type=
"String" overloaded=
"no">
18215 <autodoc>GetLineText(self, long lineNo) -
> String
</autodoc>
18217 <param name=
"lineNo" type=
"long" default=
""/>
18220 <method name=
"GetNumberOfLines" type=
"int" overloaded=
"no">
18221 <autodoc>GetNumberOfLines(self) -
> int
</autodoc>
18223 <method name=
"IsModified" type=
"bool" overloaded=
"no">
18224 <autodoc>IsModified(self) -
> bool
</autodoc>
18226 <method name=
"IsEditable" type=
"bool" overloaded=
"no">
18227 <autodoc>IsEditable(self) -
> bool
</autodoc>
18229 <method name=
"IsSingleLine" type=
"bool" overloaded=
"no">
18230 <autodoc>IsSingleLine(self) -
> bool
</autodoc>
18232 <method name=
"IsMultiLine" type=
"bool" overloaded=
"no">
18233 <autodoc>IsMultiLine(self) -
> bool
</autodoc>
18235 <method name=
"GetSelection" type=
"" overloaded=
"no">
18236 <autodoc>GetSelection() -
> (from, to)
</autodoc>
18237 <docstring>If the return values from and to are the same, there is no selection.
</docstring>
18239 <param name=
"OUTPUT" type=
"long" default=
""/>
18240 <param name=
"OUTPUT" type=
"long" default=
""/>
18243 <method name=
"GetStringSelection" type=
"String" overloaded=
"no">
18244 <autodoc>GetStringSelection(self) -
> String
</autodoc>
18246 <method name=
"Clear" type=
"" overloaded=
"no">
18247 <autodoc>Clear(self)
</autodoc>
18249 <method name=
"Replace" type=
"" overloaded=
"no">
18250 <autodoc>Replace(self, long from, long to, String value)
</autodoc>
18252 <param name=
"from" type=
"long" default=
""/>
18253 <param name=
"to" type=
"long" default=
""/>
18254 <param name=
"value" type=
"String" default=
""/>
18257 <method name=
"Remove" type=
"" overloaded=
"no">
18258 <autodoc>Remove(self, long from, long to)
</autodoc>
18260 <param name=
"from" type=
"long" default=
""/>
18261 <param name=
"to" type=
"long" default=
""/>
18264 <method name=
"LoadFile" type=
"bool" overloaded=
"no">
18265 <autodoc>LoadFile(self, String file) -
> bool
</autodoc>
18267 <param name=
"file" type=
"String" default=
""/>
18270 <method name=
"SaveFile" type=
"bool" overloaded=
"no">
18271 <autodoc>SaveFile(self, String file=EmptyString) -
> bool
</autodoc>
18273 <param name=
"file" type=
"String" default=
"wxPyEmptyString"/>
18276 <method name=
"MarkDirty" type=
"" overloaded=
"no">
18277 <autodoc>MarkDirty(self)
</autodoc>
18279 <method name=
"DiscardEdits" type=
"" overloaded=
"no">
18280 <autodoc>DiscardEdits(self)
</autodoc>
18282 <method name=
"SetMaxLength" type=
"" overloaded=
"no">
18283 <autodoc>SetMaxLength(self, unsigned long len)
</autodoc>
18285 <param name=
"len" type=
"unsigned long" default=
""/>
18288 <method name=
"WriteText" type=
"" overloaded=
"no">
18289 <autodoc>WriteText(self, String text)
</autodoc>
18291 <param name=
"text" type=
"String" default=
""/>
18294 <method name=
"AppendText" type=
"" overloaded=
"no">
18295 <autodoc>AppendText(self, String text)
</autodoc>
18297 <param name=
"text" type=
"String" default=
""/>
18300 <method name=
"EmulateKeyPress" type=
"bool" overloaded=
"no">
18301 <autodoc>EmulateKeyPress(self, KeyEvent event) -
> bool
</autodoc>
18303 <param name=
"event" type=
"KeyEvent" default=
""/>
18306 <method name=
"SetStyle" type=
"bool" overloaded=
"no">
18307 <autodoc>SetStyle(self, long start, long end, TextAttr style) -
> bool
</autodoc>
18309 <param name=
"start" type=
"long" default=
""/>
18310 <param name=
"end" type=
"long" default=
""/>
18311 <param name=
"style" type=
"TextAttr" default=
""/>
18314 <method name=
"GetStyle" type=
"bool" overloaded=
"no">
18315 <autodoc>GetStyle(self, long position, TextAttr style) -
> bool
</autodoc>
18317 <param name=
"position" type=
"long" default=
""/>
18318 <param name=
"style" type=
"TextAttr" default=
""/>
18321 <method name=
"SetDefaultStyle" type=
"bool" overloaded=
"no">
18322 <autodoc>SetDefaultStyle(self, TextAttr style) -
> bool
</autodoc>
18324 <param name=
"style" type=
"TextAttr" default=
""/>
18327 <method name=
"GetDefaultStyle" type=
"TextAttr" overloaded=
"no">
18328 <autodoc>GetDefaultStyle(self) -
> TextAttr
</autodoc>
18330 <method name=
"XYToPosition" type=
"long" overloaded=
"no">
18331 <autodoc>XYToPosition(self, long x, long y) -
> long
</autodoc>
18333 <param name=
"x" type=
"long" default=
""/>
18334 <param name=
"y" type=
"long" default=
""/>
18337 <method name=
"PositionToXY" type=
"" overloaded=
"no">
18338 <autodoc>PositionToXY(long pos) -
> (x, y)
</autodoc>
18340 <param name=
"pos" type=
"long" default=
""/>
18341 <param name=
"OUTPUT" type=
"long" default=
""/>
18342 <param name=
"OUTPUT" type=
"long" default=
""/>
18345 <method name=
"ShowPosition" type=
"" overloaded=
"no">
18346 <autodoc>ShowPosition(self, long pos)
</autodoc>
18348 <param name=
"pos" type=
"long" default=
""/>
18351 <method name=
"HitTest" type=
"wxTextCtrlHitTestResult" overloaded=
"no">
18352 <autodoc>HitTest(Point pt) -
> (result, row, col)
</autodoc>
18353 <docstring>Find the row, col coresponding to the character at the point given in
18354 pixels. NB: pt is in device coords but is not adjusted for the client
18355 area origin nor scrolling.
</docstring>
18357 <param name=
"pt" type=
"Point" default=
""/>
18358 <param name=
"OUTPUT" type=
"long" default=
""/>
18359 <param name=
"OUTPUT" type=
"long" default=
""/>
18362 <method name=
"HitTestPos" type=
"wxTextCtrlHitTestResult" overloaded=
"no">
18363 <autodoc>HitTestPos(Point pt) -
> (result, position)
</autodoc>
18364 <docstring>Find the character position in the text coresponding to the point
18365 given in pixels. NB: pt is in device coords but is not adjusted for
18366 the client area origin nor scrolling.
</docstring>
18368 <param name=
"pt" type=
"Point" default=
""/>
18369 <param name=
"OUTPUT" type=
"long" default=
""/>
18372 <method name=
"Copy" type=
"" overloaded=
"no">
18373 <autodoc>Copy(self)
</autodoc>
18375 <method name=
"Cut" type=
"" overloaded=
"no">
18376 <autodoc>Cut(self)
</autodoc>
18378 <method name=
"Paste" type=
"" overloaded=
"no">
18379 <autodoc>Paste(self)
</autodoc>
18381 <method name=
"CanCopy" type=
"bool" overloaded=
"no">
18382 <autodoc>CanCopy(self) -
> bool
</autodoc>
18384 <method name=
"CanCut" type=
"bool" overloaded=
"no">
18385 <autodoc>CanCut(self) -
> bool
</autodoc>
18387 <method name=
"CanPaste" type=
"bool" overloaded=
"no">
18388 <autodoc>CanPaste(self) -
> bool
</autodoc>
18390 <method name=
"Undo" type=
"" overloaded=
"no">
18391 <autodoc>Undo(self)
</autodoc>
18393 <method name=
"Redo" type=
"" overloaded=
"no">
18394 <autodoc>Redo(self)
</autodoc>
18396 <method name=
"CanUndo" type=
"bool" overloaded=
"no">
18397 <autodoc>CanUndo(self) -
> bool
</autodoc>
18399 <method name=
"CanRedo" type=
"bool" overloaded=
"no">
18400 <autodoc>CanRedo(self) -
> bool
</autodoc>
18402 <method name=
"SetInsertionPoint" type=
"" overloaded=
"no">
18403 <autodoc>SetInsertionPoint(self, long pos)
</autodoc>
18405 <param name=
"pos" type=
"long" default=
""/>
18408 <method name=
"SetInsertionPointEnd" type=
"" overloaded=
"no">
18409 <autodoc>SetInsertionPointEnd(self)
</autodoc>
18411 <method name=
"GetInsertionPoint" type=
"long" overloaded=
"no">
18412 <autodoc>GetInsertionPoint(self) -
> long
</autodoc>
18414 <method name=
"GetLastPosition" type=
"long" overloaded=
"no">
18415 <autodoc>GetLastPosition(self) -
> long
</autodoc>
18417 <method name=
"SetSelection" type=
"" overloaded=
"no">
18418 <autodoc>SetSelection(self, long from, long to)
</autodoc>
18420 <param name=
"from" type=
"long" default=
""/>
18421 <param name=
"to" type=
"long" default=
""/>
18424 <method name=
"SelectAll" type=
"" overloaded=
"no">
18425 <autodoc>SelectAll(self)
</autodoc>
18427 <method name=
"SetEditable" type=
"" overloaded=
"no">
18428 <autodoc>SetEditable(self, bool editable)
</autodoc>
18430 <param name=
"editable" type=
"bool" default=
""/>
18433 <method name=
"write" type=
"" overloaded=
"no">
18434 <autodoc>write(self, String text)
</autodoc>
18436 <param name=
"text" type=
"String" default=
""/>
18439 <method name=
"GetString" type=
"String" overloaded=
"no">
18440 <autodoc>GetString(self, long from, long to) -
> String
</autodoc>
18442 <param name=
"from" type=
"long" default=
""/>
18443 <param name=
"to" type=
"long" default=
""/>
18446 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
18447 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
18448 <docstring>Get the default attributes for this class. This is useful if you want
18449 to use the same font or colour in your own control as in a standard
18450 control -- which is a much better idea than hard coding specific
18451 colours or fonts which might look completely out of place on the
18452 user's system, especially if it uses themes.
18454 The variant parameter is only relevant under Mac currently and is
18455 ignore under other platforms. Under Mac, it will change the size of
18456 the returned font. See `wx.Window.SetWindowVariant` for more about
18459 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
18463 <class name=
"TextUrlEvent" oldname=
"wxTextUrlEvent" module=
"_controls">
18464 <baseclass name=
"CommandEvent"/>
18465 <constructor name=
"TextUrlEvent" overloaded=
"no">
18466 <autodoc>__init__(self, int winid, MouseEvent evtMouse, long start, long end) -
> TextUrlEvent
</autodoc>
18468 <param name=
"winid" type=
"int" default=
""/>
18469 <param name=
"evtMouse" type=
"MouseEvent" default=
""/>
18470 <param name=
"start" type=
"long" default=
""/>
18471 <param name=
"end" type=
"long" default=
""/>
18474 <method name=
"GetMouseEvent" type=
"MouseEvent" overloaded=
"no">
18475 <autodoc>GetMouseEvent(self) -
> MouseEvent
</autodoc>
18477 <method name=
"GetURLStart" type=
"long" overloaded=
"no">
18478 <autodoc>GetURLStart(self) -
> long
</autodoc>
18480 <method name=
"GetURLEnd" type=
"long" overloaded=
"no">
18481 <autodoc>GetURLEnd(self) -
> long
</autodoc>
18485 EVT_TEXT = wx.PyEventBinder( wxEVT_COMMAND_TEXT_UPDATED,
1)
18486 EVT_TEXT_ENTER = wx.PyEventBinder( wxEVT_COMMAND_TEXT_ENTER,
1)
18487 EVT_TEXT_URL = wx.PyEventBinder( wxEVT_COMMAND_TEXT_URL,
1)
18488 EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN,
1)
18491 #---------------------------------------------------------------------------
18493 <class name=
"ScrollBar" oldname=
"wxScrollBar" module=
"_controls">
18494 <baseclass name=
"Control"/>
18495 <constructor name=
"ScrollBar" overloaded=
"no">
18496 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
18497 Size size=DefaultSize, long style=SB_HORIZONTAL,
18498 Validator validator=DefaultValidator, String name=ScrollBarNameStr) -
> ScrollBar
</autodoc>
18500 <param name=
"parent" type=
"Window" default=
""/>
18501 <param name=
"id" type=
"int" default=
"-1"/>
18502 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18503 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18504 <param name=
"style" type=
"long" default=
"wxSB_HORIZONTAL"/>
18505 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
18506 <param name=
"name" type=
"String" default=
"wxPyScrollBarNameStr"/>
18509 <constructor name=
"PreScrollBar" overloaded=
"no">
18510 <autodoc>PreScrollBar() -
> ScrollBar
</autodoc>
18512 <method name=
"Create" type=
"bool" overloaded=
"no">
18513 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
18514 Size size=DefaultSize, long style=SB_HORIZONTAL,
18515 Validator validator=DefaultValidator, String name=ScrollBarNameStr) -
> bool
</autodoc>
18516 <docstring>Do the
2nd phase and create the GUI control.
</docstring>
18518 <param name=
"parent" type=
"Window" default=
""/>
18519 <param name=
"id" type=
"int" default=
"-1"/>
18520 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18521 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18522 <param name=
"style" type=
"long" default=
"wxSB_HORIZONTAL"/>
18523 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
18524 <param name=
"name" type=
"String" default=
"wxPyScrollBarNameStr"/>
18527 <method name=
"GetThumbPosition" type=
"int" overloaded=
"no">
18528 <autodoc>GetThumbPosition(self) -
> int
</autodoc>
18530 <method name=
"GetThumbSize" type=
"int" overloaded=
"no">
18531 <autodoc>GetThumbSize(self) -
> int
</autodoc>
18533 <method name=
"GetPageSize" type=
"int" overloaded=
"no">
18534 <autodoc>GetPageSize(self) -
> int
</autodoc>
18536 <method name=
"GetRange" type=
"int" overloaded=
"no">
18537 <autodoc>GetRange(self) -
> int
</autodoc>
18539 <method name=
"IsVertical" type=
"bool" overloaded=
"no">
18540 <autodoc>IsVertical(self) -
> bool
</autodoc>
18542 <method name=
"SetThumbPosition" type=
"" overloaded=
"no">
18543 <autodoc>SetThumbPosition(self, int viewStart)
</autodoc>
18545 <param name=
"viewStart" type=
"int" default=
""/>
18548 <method name=
"SetScrollbar" type=
"" overloaded=
"no">
18549 <autodoc>SetScrollbar(self, int position, int thumbSize, int range, int pageSize,
18550 bool refresh=True)
</autodoc>
18551 <docstring>Sets the scrollbar properties of a built-in scrollbar.
18552 :param orientation: Determines the scrollbar whose page size is to
18553 be set. May be wx.HORIZONTAL or wx.VERTICAL.
18555 :param position: The position of the scrollbar in scroll units.
18557 :param thumbSize: The size of the thumb, or visible portion of the
18558 scrollbar, in scroll units.
18560 :param range: The maximum position of the scrollbar.
18562 :param refresh: True to redraw the scrollbar, false otherwise.
18565 <param name=
"position" type=
"int" default=
""/>
18566 <param name=
"thumbSize" type=
"int" default=
""/>
18567 <param name=
"range" type=
"int" default=
""/>
18568 <param name=
"pageSize" type=
"int" default=
""/>
18569 <param name=
"refresh" type=
"bool" default=
"True"/>
18572 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
18573 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
18574 <docstring>Get the default attributes for this class. This is useful if you want
18575 to use the same font or colour in your own control as in a standard
18576 control -- which is a much better idea than hard coding specific
18577 colours or fonts which might look completely out of place on the
18578 user's system, especially if it uses themes.
18580 The variant parameter is only relevant under Mac currently and is
18581 ignore under other platforms. Under Mac, it will change the size of
18582 the returned font. See `wx.Window.SetWindowVariant` for more about
18585 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
18590 #---------------------------------------------------------------------------
18592 <class name=
"SpinButton" oldname=
"wxSpinButton" module=
"_controls">
18593 <baseclass name=
"Control"/>
18594 <constructor name=
"SpinButton" overloaded=
"no">
18595 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
18596 Size size=DefaultSize, long style=SP_HORIZONTAL,
18597 String name=SPIN_BUTTON_NAME) -
> SpinButton
</autodoc>
18599 <param name=
"parent" type=
"Window" default=
""/>
18600 <param name=
"id" type=
"int" default=
"-1"/>
18601 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18602 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18603 <param name=
"style" type=
"long" default=
"wxSP_HORIZONTAL"/>
18604 <param name=
"name" type=
"String" default=
"wxPySPIN_BUTTON_NAME"/>
18607 <constructor name=
"PreSpinButton" overloaded=
"no">
18608 <autodoc>PreSpinButton() -
> SpinButton
</autodoc>
18610 <method name=
"Create" type=
"bool" overloaded=
"no">
18611 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
18612 Size size=DefaultSize, long style=SP_HORIZONTAL,
18613 String name=SPIN_BUTTON_NAME) -
> bool
</autodoc>
18615 <param name=
"parent" type=
"Window" default=
""/>
18616 <param name=
"id" type=
"int" default=
"-1"/>
18617 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18618 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18619 <param name=
"style" type=
"long" default=
"wxSP_HORIZONTAL"/>
18620 <param name=
"name" type=
"String" default=
"wxPySPIN_BUTTON_NAME"/>
18623 <method name=
"GetValue" type=
"int" overloaded=
"no">
18624 <autodoc>GetValue(self) -
> int
</autodoc>
18626 <method name=
"GetMin" type=
"int" overloaded=
"no">
18627 <autodoc>GetMin(self) -
> int
</autodoc>
18629 <method name=
"GetMax" type=
"int" overloaded=
"no">
18630 <autodoc>GetMax(self) -
> int
</autodoc>
18632 <method name=
"SetValue" type=
"" overloaded=
"no">
18633 <autodoc>SetValue(self, int val)
</autodoc>
18635 <param name=
"val" type=
"int" default=
""/>
18638 <method name=
"SetMin" type=
"" overloaded=
"no">
18639 <autodoc>SetMin(self, int minVal)
</autodoc>
18641 <param name=
"minVal" type=
"int" default=
""/>
18644 <method name=
"SetMax" type=
"" overloaded=
"no">
18645 <autodoc>SetMax(self, int maxVal)
</autodoc>
18647 <param name=
"maxVal" type=
"int" default=
""/>
18650 <method name=
"SetRange" type=
"" overloaded=
"no">
18651 <autodoc>SetRange(self, int minVal, int maxVal)
</autodoc>
18653 <param name=
"minVal" type=
"int" default=
""/>
18654 <param name=
"maxVal" type=
"int" default=
""/>
18657 <method name=
"IsVertical" type=
"bool" overloaded=
"no">
18658 <autodoc>IsVertical(self) -
> bool
</autodoc>
18660 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
18661 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
18662 <docstring>Get the default attributes for this class. This is useful if you want
18663 to use the same font or colour in your own control as in a standard
18664 control -- which is a much better idea than hard coding specific
18665 colours or fonts which might look completely out of place on the
18666 user's system, especially if it uses themes.
18668 The variant parameter is only relevant under Mac currently and is
18669 ignore under other platforms. Under Mac, it will change the size of
18670 the returned font. See `wx.Window.SetWindowVariant` for more about
18673 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
18677 <class name=
"SpinCtrl" oldname=
"wxSpinCtrl" module=
"_controls">
18678 <baseclass name=
"Control"/>
18679 <constructor name=
"SpinCtrl" overloaded=
"no">
18680 <autodoc>__init__(self, Window parent, int id=-
1, String value=EmptyString,
18681 Point pos=DefaultPosition, Size size=DefaultSize,
18682 long style=SP_ARROW_KEYS, int min=
0, int max=
100,
18683 int initial=
0, String name=SpinCtrlNameStr) -
> SpinCtrl
</autodoc>
18685 <param name=
"parent" type=
"Window" default=
""/>
18686 <param name=
"id" type=
"int" default=
"-1"/>
18687 <param name=
"value" type=
"String" default=
"wxPyEmptyString"/>
18688 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18689 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18690 <param name=
"style" type=
"long" default=
"wxSP_ARROW_KEYS"/>
18691 <param name=
"min" type=
"int" default=
"0"/>
18692 <param name=
"max" type=
"int" default=
"100"/>
18693 <param name=
"initial" type=
"int" default=
"0"/>
18694 <param name=
"name" type=
"String" default=
"wxPySpinCtrlNameStr"/>
18697 <constructor name=
"PreSpinCtrl" overloaded=
"no">
18698 <autodoc>PreSpinCtrl() -
> SpinCtrl
</autodoc>
18700 <method name=
"Create" type=
"bool" overloaded=
"no">
18701 <autodoc>Create(self, Window parent, int id=-
1, String value=EmptyString,
18702 Point pos=DefaultPosition, Size size=DefaultSize,
18703 long style=SP_ARROW_KEYS, int min=
0, int max=
100,
18704 int initial=
0, String name=SpinCtrlNameStr) -
> bool
</autodoc>
18706 <param name=
"parent" type=
"Window" default=
""/>
18707 <param name=
"id" type=
"int" default=
"-1"/>
18708 <param name=
"value" type=
"String" default=
"wxPyEmptyString"/>
18709 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18710 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18711 <param name=
"style" type=
"long" default=
"wxSP_ARROW_KEYS"/>
18712 <param name=
"min" type=
"int" default=
"0"/>
18713 <param name=
"max" type=
"int" default=
"100"/>
18714 <param name=
"initial" type=
"int" default=
"0"/>
18715 <param name=
"name" type=
"String" default=
"wxPySpinCtrlNameStr"/>
18718 <method name=
"GetValue" type=
"int" overloaded=
"no">
18719 <autodoc>GetValue(self) -
> int
</autodoc>
18721 <method name=
"SetValue" type=
"" overloaded=
"no">
18722 <autodoc>SetValue(self, int value)
</autodoc>
18724 <param name=
"value" type=
"int" default=
""/>
18727 <method name=
"SetValueString" type=
"" overloaded=
"no">
18728 <autodoc>SetValueString(self, String text)
</autodoc>
18730 <param name=
"text" type=
"String" default=
""/>
18733 <method name=
"SetRange" type=
"" overloaded=
"no">
18734 <autodoc>SetRange(self, int minVal, int maxVal)
</autodoc>
18736 <param name=
"minVal" type=
"int" default=
""/>
18737 <param name=
"maxVal" type=
"int" default=
""/>
18740 <method name=
"GetMin" type=
"int" overloaded=
"no">
18741 <autodoc>GetMin(self) -
> int
</autodoc>
18743 <method name=
"GetMax" type=
"int" overloaded=
"no">
18744 <autodoc>GetMax(self) -
> int
</autodoc>
18746 <method name=
"SetSelection" type=
"" overloaded=
"no">
18747 <autodoc>SetSelection(self, long from, long to)
</autodoc>
18749 <param name=
"from" type=
"long" default=
""/>
18750 <param name=
"to" type=
"long" default=
""/>
18753 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
18754 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
18755 <docstring>Get the default attributes for this class. This is useful if you want
18756 to use the same font or colour in your own control as in a standard
18757 control -- which is a much better idea than hard coding specific
18758 colours or fonts which might look completely out of place on the
18759 user's system, especially if it uses themes.
18761 The variant parameter is only relevant under Mac currently and is
18762 ignore under other platforms. Under Mac, it will change the size of
18763 the returned font. See `wx.Window.SetWindowVariant` for more about
18766 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
18770 <class name=
"SpinEvent" oldname=
"wxSpinEvent" module=
"_controls">
18771 <baseclass name=
"NotifyEvent"/>
18772 <constructor name=
"SpinEvent" overloaded=
"no">
18773 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=
0) -
> SpinEvent
</autodoc>
18775 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
18776 <param name=
"winid" type=
"int" default=
"0"/>
18779 <method name=
"GetPosition" type=
"int" overloaded=
"no">
18780 <autodoc>GetPosition(self) -
> int
</autodoc>
18782 <method name=
"SetPosition" type=
"" overloaded=
"no">
18783 <autodoc>SetPosition(self, int pos)
</autodoc>
18785 <param name=
"pos" type=
"int" default=
""/>
18790 EVT_SPIN_UP = wx.PyEventBinder( wx.wxEVT_SCROLL_LINEUP,
1)
18791 EVT_SPIN_DOWN = wx.PyEventBinder( wx.wxEVT_SCROLL_LINEDOWN,
1)
18792 EVT_SPIN = wx.PyEventBinder( wx.wxEVT_SCROLL_THUMBTRACK,
1)
18793 EVT_SPINCTRL = wx.PyEventBinder( wxEVT_COMMAND_SPINCTRL_UPDATED,
1)
18796 #---------------------------------------------------------------------------
18798 <class name=
"RadioBox" oldname=
"wxRadioBox" module=
"_controls">
18799 <baseclass name=
"Control"/>
18800 <constructor name=
"RadioBox" overloaded=
"no">
18801 <autodoc>__init__(self, Window parent, int id=-
1, String label=EmptyString,
18802 Point pos=DefaultPosition, Size size=DefaultSize,
18803 wxArrayString choices=wxPyEmptyStringArray,
18804 int majorDimension=
0, long style=RA_HORIZONTAL,
18805 Validator validator=DefaultValidator,
18806 String name=RadioBoxNameStr) -
> RadioBox
</autodoc>
18808 <param name=
"parent" type=
"Window" default=
""/>
18809 <param name=
"id" type=
"int" default=
"-1"/>
18810 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
18811 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18812 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18813 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
18814 <param name=
"majorDimension" type=
"int" default=
"0"/>
18815 <param name=
"style" type=
"long" default=
"wxRA_HORIZONTAL"/>
18816 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
18817 <param name=
"name" type=
"String" default=
"wxPyRadioBoxNameStr"/>
18820 <constructor name=
"PreRadioBox" overloaded=
"no">
18821 <autodoc>PreRadioBox() -
> RadioBox
</autodoc>
18823 <method name=
"Create" type=
"bool" overloaded=
"no">
18824 <autodoc>Create(self, Window parent, int id=-
1, String label=EmptyString,
18825 Point pos=DefaultPosition, Size size=DefaultSize,
18826 wxArrayString choices=wxPyEmptyStringArray,
18827 int majorDimension=
0, long style=RA_HORIZONTAL,
18828 Validator validator=DefaultValidator,
18829 String name=RadioBoxNameStr) -
> bool
</autodoc>
18831 <param name=
"parent" type=
"Window" default=
""/>
18832 <param name=
"id" type=
"int" default=
"-1"/>
18833 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
18834 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18835 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18836 <param name=
"choices" type=
"wxArrayString" default=
"wxPyEmptyStringArray"/>
18837 <param name=
"majorDimension" type=
"int" default=
"0"/>
18838 <param name=
"style" type=
"long" default=
"wxRA_HORIZONTAL"/>
18839 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
18840 <param name=
"name" type=
"String" default=
"wxPyRadioBoxNameStr"/>
18843 <method name=
"SetSelection" type=
"" overloaded=
"no">
18844 <autodoc>SetSelection(self, int n)
</autodoc>
18846 <param name=
"n" type=
"int" default=
""/>
18849 <method name=
"GetSelection" type=
"int" overloaded=
"no">
18850 <autodoc>GetSelection(self) -
> int
</autodoc>
18852 <method name=
"GetStringSelection" type=
"String" overloaded=
"no">
18853 <autodoc>GetStringSelection(self) -
> String
</autodoc>
18855 <method name=
"SetStringSelection" type=
"bool" overloaded=
"no">
18856 <autodoc>SetStringSelection(self, String s) -
> bool
</autodoc>
18858 <param name=
"s" type=
"String" default=
""/>
18861 <method name=
"GetCount" type=
"int" overloaded=
"no">
18862 <autodoc>GetCount(self) -
> int
</autodoc>
18864 <method name=
"FindString" type=
"int" overloaded=
"no">
18865 <autodoc>FindString(self, String s) -
> int
</autodoc>
18867 <param name=
"s" type=
"String" default=
""/>
18870 <method name=
"GetString" type=
"String" overloaded=
"no">
18871 <autodoc>GetString(self, int n) -
> String
</autodoc>
18873 <param name=
"n" type=
"int" default=
""/>
18876 <method name=
"SetString" type=
"" overloaded=
"no">
18877 <autodoc>SetString(self, int n, String label)
</autodoc>
18879 <param name=
"n" type=
"int" default=
""/>
18880 <param name=
"label" type=
"String" default=
""/>
18883 <method name=
"EnableItem" type=
"" overloaded=
"no">
18884 <autodoc>EnableItem(self, int n, bool enable=True)
</autodoc>
18886 <param name=
"n" type=
"int" default=
""/>
18887 <param name=
"enable" type=
"bool" default=
"True"/>
18890 <method name=
"ShowItem" type=
"" overloaded=
"no">
18891 <autodoc>ShowItem(self, int n, bool show=True)
</autodoc>
18893 <param name=
"n" type=
"int" default=
""/>
18894 <param name=
"show" type=
"bool" default=
"True"/>
18897 <method name=
"GetColumnCount" type=
"int" overloaded=
"no">
18898 <autodoc>GetColumnCount(self) -
> int
</autodoc>
18900 <method name=
"GetRowCount" type=
"int" overloaded=
"no">
18901 <autodoc>GetRowCount(self) -
> int
</autodoc>
18903 <method name=
"GetNextItem" type=
"int" overloaded=
"no">
18904 <autodoc>GetNextItem(self, int item, int dir, long style) -
> int
</autodoc>
18906 <param name=
"item" type=
"int" default=
""/>
18907 <param name=
"dir" type=
"wxDirection" default=
""/>
18908 <param name=
"style" type=
"long" default=
""/>
18911 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
18912 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
18913 <docstring>Get the default attributes for this class. This is useful if you want
18914 to use the same font or colour in your own control as in a standard
18915 control -- which is a much better idea than hard coding specific
18916 colours or fonts which might look completely out of place on the
18917 user's system, especially if it uses themes.
18919 The variant parameter is only relevant under Mac currently and is
18920 ignore under other platforms. Under Mac, it will change the size of
18921 the returned font. See `wx.Window.SetWindowVariant` for more about
18924 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
18929 #---------------------------------------------------------------------------
18931 <class name=
"RadioButton" oldname=
"wxRadioButton" module=
"_controls">
18932 <baseclass name=
"Control"/>
18933 <constructor name=
"RadioButton" overloaded=
"no">
18934 <autodoc>__init__(self, Window parent, int id=-
1, String label=EmptyString,
18935 Point pos=DefaultPosition, Size size=DefaultSize,
18936 long style=
0, Validator validator=DefaultValidator,
18937 String name=RadioButtonNameStr) -
> RadioButton
</autodoc>
18939 <param name=
"parent" type=
"Window" default=
""/>
18940 <param name=
"id" type=
"int" default=
"-1"/>
18941 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
18942 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18943 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18944 <param name=
"style" type=
"long" default=
"0"/>
18945 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
18946 <param name=
"name" type=
"String" default=
"wxPyRadioButtonNameStr"/>
18949 <constructor name=
"PreRadioButton" overloaded=
"no">
18950 <autodoc>PreRadioButton() -
> RadioButton
</autodoc>
18952 <method name=
"Create" type=
"bool" overloaded=
"no">
18953 <autodoc>Create(self, Window parent, int id=-
1, String label=EmptyString,
18954 Point pos=DefaultPosition, Size size=DefaultSize,
18955 long style=
0, Validator validator=DefaultValidator,
18956 String name=RadioButtonNameStr) -
> bool
</autodoc>
18958 <param name=
"parent" type=
"Window" default=
""/>
18959 <param name=
"id" type=
"int" default=
"-1"/>
18960 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
18961 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
18962 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
18963 <param name=
"style" type=
"long" default=
"0"/>
18964 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
18965 <param name=
"name" type=
"String" default=
"wxPyRadioButtonNameStr"/>
18968 <method name=
"GetValue" type=
"bool" overloaded=
"no">
18969 <autodoc>GetValue(self) -
> bool
</autodoc>
18971 <method name=
"SetValue" type=
"" overloaded=
"no">
18972 <autodoc>SetValue(self, bool value)
</autodoc>
18974 <param name=
"value" type=
"bool" default=
""/>
18977 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
18978 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
18979 <docstring>Get the default attributes for this class. This is useful if you want
18980 to use the same font or colour in your own control as in a standard
18981 control -- which is a much better idea than hard coding specific
18982 colours or fonts which might look completely out of place on the
18983 user's system, especially if it uses themes.
18985 The variant parameter is only relevant under Mac currently and is
18986 ignore under other platforms. Under Mac, it will change the size of
18987 the returned font. See `wx.Window.SetWindowVariant` for more about
18990 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
18995 #---------------------------------------------------------------------------
18997 <class name=
"Slider" oldname=
"wxSlider" module=
"_controls">
18998 <baseclass name=
"Control"/>
18999 <constructor name=
"Slider" overloaded=
"no">
19000 <autodoc>__init__(self, Window parent, int id=-
1, int value=
0, int minValue=
0,
19001 int maxValue=
100, Point pos=DefaultPosition,
19002 Size size=DefaultSize, long style=SL_HORIZONTAL,
19003 Validator validator=DefaultValidator,
19004 String name=SliderNameStr) -
> Slider
</autodoc>
19006 <param name=
"parent" type=
"Window" default=
""/>
19007 <param name=
"id" type=
"int" default=
"-1"/>
19008 <param name=
"value" type=
"int" default=
"0"/>
19009 <param name=
"minValue" type=
"int" default=
"0"/>
19010 <param name=
"maxValue" type=
"int" default=
"100"/>
19011 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
19012 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
19013 <param name=
"style" type=
"long" default=
"wxSL_HORIZONTAL"/>
19014 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
19015 <param name=
"name" type=
"String" default=
"wxPySliderNameStr"/>
19018 <constructor name=
"PreSlider" overloaded=
"no">
19019 <autodoc>PreSlider() -
> Slider
</autodoc>
19021 <method name=
"Create" type=
"bool" overloaded=
"no">
19022 <autodoc>Create(self, Window parent, int id=-
1, int value=
0, int minValue=
0,
19023 int maxValue=
100, Point pos=DefaultPosition,
19024 Size size=DefaultSize, long style=SL_HORIZONTAL,
19025 Validator validator=DefaultValidator,
19026 String name=SliderNameStr) -
> bool
</autodoc>
19028 <param name=
"parent" type=
"Window" default=
""/>
19029 <param name=
"id" type=
"int" default=
"-1"/>
19030 <param name=
"value" type=
"int" default=
"0"/>
19031 <param name=
"minValue" type=
"int" default=
"0"/>
19032 <param name=
"maxValue" type=
"int" default=
"100"/>
19033 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
19034 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
19035 <param name=
"style" type=
"long" default=
"wxSL_HORIZONTAL"/>
19036 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
19037 <param name=
"name" type=
"String" default=
"wxPySliderNameStr"/>
19040 <method name=
"GetValue" type=
"int" overloaded=
"no">
19041 <autodoc>GetValue(self) -
> int
</autodoc>
19043 <method name=
"SetValue" type=
"" overloaded=
"no">
19044 <autodoc>SetValue(self, int value)
</autodoc>
19046 <param name=
"value" type=
"int" default=
""/>
19049 <method name=
"SetRange" type=
"" overloaded=
"no">
19050 <autodoc>SetRange(self, int minValue, int maxValue)
</autodoc>
19052 <param name=
"minValue" type=
"int" default=
""/>
19053 <param name=
"maxValue" type=
"int" default=
""/>
19056 <method name=
"GetMin" type=
"int" overloaded=
"no">
19057 <autodoc>GetMin(self) -
> int
</autodoc>
19059 <method name=
"GetMax" type=
"int" overloaded=
"no">
19060 <autodoc>GetMax(self) -
> int
</autodoc>
19062 <method name=
"SetMin" type=
"" overloaded=
"no">
19063 <autodoc>SetMin(self, int minValue)
</autodoc>
19065 <param name=
"minValue" type=
"int" default=
""/>
19068 <method name=
"SetMax" type=
"" overloaded=
"no">
19069 <autodoc>SetMax(self, int maxValue)
</autodoc>
19071 <param name=
"maxValue" type=
"int" default=
""/>
19074 <method name=
"SetLineSize" type=
"" overloaded=
"no">
19075 <autodoc>SetLineSize(self, int lineSize)
</autodoc>
19077 <param name=
"lineSize" type=
"int" default=
""/>
19080 <method name=
"SetPageSize" type=
"" overloaded=
"no">
19081 <autodoc>SetPageSize(self, int pageSize)
</autodoc>
19083 <param name=
"pageSize" type=
"int" default=
""/>
19086 <method name=
"GetLineSize" type=
"int" overloaded=
"no">
19087 <autodoc>GetLineSize(self) -
> int
</autodoc>
19089 <method name=
"GetPageSize" type=
"int" overloaded=
"no">
19090 <autodoc>GetPageSize(self) -
> int
</autodoc>
19092 <method name=
"SetThumbLength" type=
"" overloaded=
"no">
19093 <autodoc>SetThumbLength(self, int lenPixels)
</autodoc>
19095 <param name=
"lenPixels" type=
"int" default=
""/>
19098 <method name=
"GetThumbLength" type=
"int" overloaded=
"no">
19099 <autodoc>GetThumbLength(self) -
> int
</autodoc>
19101 <method name=
"SetTickFreq" type=
"" overloaded=
"no">
19102 <autodoc>SetTickFreq(self, int n, int pos=
1)
</autodoc>
19104 <param name=
"n" type=
"int" default=
""/>
19105 <param name=
"pos" type=
"int" default=
"1"/>
19108 <method name=
"GetTickFreq" type=
"int" overloaded=
"no">
19109 <autodoc>GetTickFreq(self) -
> int
</autodoc>
19111 <method name=
"ClearTicks" type=
"" overloaded=
"no">
19112 <autodoc>ClearTicks(self)
</autodoc>
19114 <method name=
"SetTick" type=
"" overloaded=
"no">
19115 <autodoc>SetTick(self, int tickPos)
</autodoc>
19117 <param name=
"tickPos" type=
"int" default=
""/>
19120 <method name=
"ClearSel" type=
"" overloaded=
"no">
19121 <autodoc>ClearSel(self)
</autodoc>
19123 <method name=
"GetSelEnd" type=
"int" overloaded=
"no">
19124 <autodoc>GetSelEnd(self) -
> int
</autodoc>
19126 <method name=
"GetSelStart" type=
"int" overloaded=
"no">
19127 <autodoc>GetSelStart(self) -
> int
</autodoc>
19129 <method name=
"SetSelection" type=
"" overloaded=
"no">
19130 <autodoc>SetSelection(self, int min, int max)
</autodoc>
19132 <param name=
"min" type=
"int" default=
""/>
19133 <param name=
"max" type=
"int" default=
""/>
19136 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
19137 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
19138 <docstring>Get the default attributes for this class. This is useful if you want
19139 to use the same font or colour in your own control as in a standard
19140 control -- which is a much better idea than hard coding specific
19141 colours or fonts which might look completely out of place on the
19142 user's system, especially if it uses themes.
19144 The variant parameter is only relevant under Mac currently and is
19145 ignore under other platforms. Under Mac, it will change the size of
19146 the returned font. See `wx.Window.SetWindowVariant` for more about
19149 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
19154 #---------------------------------------------------------------------------
19157 EVT_TOGGLEBUTTON = wx.PyEventBinder( wxEVT_COMMAND_TOGGLEBUTTON_CLICKED,
1)
19159 <class name=
"ToggleButton" oldname=
"wxToggleButton" module=
"_controls">
19160 <baseclass name=
"Control"/>
19161 <constructor name=
"ToggleButton" overloaded=
"no">
19162 <autodoc>__init__(self, Window parent, int id=-
1, String label=EmptyString,
19163 Point pos=DefaultPosition, Size size=DefaultSize,
19164 long style=
0, Validator validator=DefaultValidator,
19165 String name=ToggleButtonNameStr) -
> ToggleButton
</autodoc>
19167 <param name=
"parent" type=
"Window" default=
""/>
19168 <param name=
"id" type=
"int" default=
"-1"/>
19169 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
19170 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
19171 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
19172 <param name=
"style" type=
"long" default=
"0"/>
19173 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
19174 <param name=
"name" type=
"String" default=
"wxPyToggleButtonNameStr"/>
19177 <constructor name=
"PreToggleButton" overloaded=
"no">
19178 <autodoc>PreToggleButton() -
> ToggleButton
</autodoc>
19180 <method name=
"Create" type=
"bool" overloaded=
"no">
19181 <autodoc>Create(self, Window parent, int id=-
1, String label=EmptyString,
19182 Point pos=DefaultPosition, Size size=DefaultSize,
19183 long style=
0, Validator validator=DefaultValidator,
19184 String name=ToggleButtonNameStr) -
> bool
</autodoc>
19186 <param name=
"parent" type=
"Window" default=
""/>
19187 <param name=
"id" type=
"int" default=
"-1"/>
19188 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
19189 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
19190 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
19191 <param name=
"style" type=
"long" default=
"0"/>
19192 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
19193 <param name=
"name" type=
"String" default=
"wxPyToggleButtonNameStr"/>
19196 <method name=
"SetValue" type=
"" overloaded=
"no">
19197 <autodoc>SetValue(self, bool value)
</autodoc>
19199 <param name=
"value" type=
"bool" default=
""/>
19202 <method name=
"GetValue" type=
"bool" overloaded=
"no">
19203 <autodoc>GetValue(self) -
> bool
</autodoc>
19205 <method name=
"SetLabel" type=
"" overloaded=
"no">
19206 <autodoc>SetLabel(self, String label)
</autodoc>
19207 <docstring>Sets the item's text.
</docstring>
19209 <param name=
"label" type=
"String" default=
""/>
19212 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
19213 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
19214 <docstring>Get the default attributes for this class. This is useful if you want
19215 to use the same font or colour in your own control as in a standard
19216 control -- which is a much better idea than hard coding specific
19217 colours or fonts which might look completely out of place on the
19218 user's system, especially if it uses themes.
19220 The variant parameter is only relevant under Mac currently and is
19221 ignore under other platforms. Under Mac, it will change the size of
19222 the returned font. See `wx.Window.SetWindowVariant` for more about
19225 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
19230 #---------------------------------------------------------------------------
19232 <class name=
"BookCtrl" oldname=
"wxBookCtrl" module=
"_controls">
19233 <baseclass name=
"Control"/>
19234 <method name=
"GetPageCount" type=
"size_t" overloaded=
"no">
19235 <autodoc>GetPageCount(self) -
> size_t
</autodoc>
19237 <method name=
"GetPage" type=
"Window" overloaded=
"no">
19238 <autodoc>GetPage(self, size_t n) -
> Window
</autodoc>
19240 <param name=
"n" type=
"size_t" default=
""/>
19243 <method name=
"GetSelection" type=
"int" overloaded=
"no">
19244 <autodoc>GetSelection(self) -
> int
</autodoc>
19246 <method name=
"SetPageText" type=
"bool" overloaded=
"no">
19247 <autodoc>SetPageText(self, size_t n, String strText) -
> bool
</autodoc>
19249 <param name=
"n" type=
"size_t" default=
""/>
19250 <param name=
"strText" type=
"String" default=
""/>
19253 <method name=
"GetPageText" type=
"String" overloaded=
"no">
19254 <autodoc>GetPageText(self, size_t n) -
> String
</autodoc>
19256 <param name=
"n" type=
"size_t" default=
""/>
19259 <method name=
"SetImageList" type=
"" overloaded=
"no">
19260 <autodoc>SetImageList(self, ImageList imageList)
</autodoc>
19262 <param name=
"imageList" type=
"ImageList" default=
""/>
19265 <method name=
"AssignImageList" type=
"" overloaded=
"no">
19266 <autodoc>AssignImageList(self, ImageList imageList)
</autodoc>
19268 <param name=
"imageList" type=
"ImageList" default=
""/>
19271 <method name=
"GetImageList" type=
"ImageList" overloaded=
"no">
19272 <autodoc>GetImageList(self) -
> ImageList
</autodoc>
19274 <method name=
"GetPageImage" type=
"int" overloaded=
"no">
19275 <autodoc>GetPageImage(self, size_t n) -
> int
</autodoc>
19277 <param name=
"n" type=
"size_t" default=
""/>
19280 <method name=
"SetPageImage" type=
"bool" overloaded=
"no">
19281 <autodoc>SetPageImage(self, size_t n, int imageId) -
> bool
</autodoc>
19283 <param name=
"n" type=
"size_t" default=
""/>
19284 <param name=
"imageId" type=
"int" default=
""/>
19287 <method name=
"SetPageSize" type=
"" overloaded=
"no">
19288 <autodoc>SetPageSize(self, Size size)
</autodoc>
19290 <param name=
"size" type=
"Size" default=
""/>
19293 <method name=
"CalcSizeFromPage" type=
"Size" overloaded=
"no">
19294 <autodoc>CalcSizeFromPage(self, Size sizePage) -
> Size
</autodoc>
19296 <param name=
"sizePage" type=
"Size" default=
""/>
19299 <method name=
"DeletePage" type=
"bool" overloaded=
"no">
19300 <autodoc>DeletePage(self, size_t n) -
> bool
</autodoc>
19302 <param name=
"n" type=
"size_t" default=
""/>
19305 <method name=
"RemovePage" type=
"bool" overloaded=
"no">
19306 <autodoc>RemovePage(self, size_t n) -
> bool
</autodoc>
19308 <param name=
"n" type=
"size_t" default=
""/>
19311 <method name=
"DeleteAllPages" type=
"bool" overloaded=
"no">
19312 <autodoc>DeleteAllPages(self) -
> bool
</autodoc>
19314 <method name=
"AddPage" type=
"bool" overloaded=
"no">
19315 <autodoc>AddPage(self, Window page, String text, bool select=False, int imageId=-
1) -
> bool
</autodoc>
19317 <param name=
"page" type=
"Window" default=
""/>
19318 <param name=
"text" type=
"String" default=
""/>
19319 <param name=
"select" type=
"bool" default=
"False"/>
19320 <param name=
"imageId" type=
"int" default=
"-1"/>
19323 <method name=
"InsertPage" type=
"bool" overloaded=
"no">
19324 <autodoc>InsertPage(self, size_t n, Window page, String text, bool select=False,
19325 int imageId=-
1) -
> bool
</autodoc>
19327 <param name=
"n" type=
"size_t" default=
""/>
19328 <param name=
"page" type=
"Window" default=
""/>
19329 <param name=
"text" type=
"String" default=
""/>
19330 <param name=
"select" type=
"bool" default=
"False"/>
19331 <param name=
"imageId" type=
"int" default=
"-1"/>
19334 <method name=
"SetSelection" type=
"int" overloaded=
"no">
19335 <autodoc>SetSelection(self, size_t n) -
> int
</autodoc>
19337 <param name=
"n" type=
"size_t" default=
""/>
19340 <method name=
"AdvanceSelection" type=
"" overloaded=
"no">
19341 <autodoc>AdvanceSelection(self, bool forward=True)
</autodoc>
19343 <param name=
"forward" type=
"bool" default=
"True"/>
19346 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
19347 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
19348 <docstring>Get the default attributes for this class. This is useful if you want
19349 to use the same font or colour in your own control as in a standard
19350 control -- which is a much better idea than hard coding specific
19351 colours or fonts which might look completely out of place on the
19352 user's system, especially if it uses themes.
19354 The variant parameter is only relevant under Mac currently and is
19355 ignore under other platforms. Under Mac, it will change the size of
19356 the returned font. See `wx.Window.SetWindowVariant` for more about
19359 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
19363 <class name=
"BookCtrlEvent" oldname=
"wxBookCtrlEvent" module=
"_controls">
19364 <baseclass name=
"NotifyEvent"/>
19365 <constructor name=
"BookCtrlEvent" overloaded=
"no">
19366 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=
0, int nSel=-
1,
19367 int nOldSel=-
1) -
> BookCtrlEvent
</autodoc>
19369 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
19370 <param name=
"id" type=
"int" default=
"0"/>
19371 <param name=
"nSel" type=
"int" default=
"-1"/>
19372 <param name=
"nOldSel" type=
"int" default=
"-1"/>
19375 <method name=
"GetSelection" type=
"int" overloaded=
"no">
19376 <autodoc>GetSelection(self) -
> int
</autodoc>
19378 <method name=
"SetSelection" type=
"" overloaded=
"no">
19379 <autodoc>SetSelection(self, int nSel)
</autodoc>
19381 <param name=
"nSel" type=
"int" default=
""/>
19384 <method name=
"GetOldSelection" type=
"int" overloaded=
"no">
19385 <autodoc>GetOldSelection(self) -
> int
</autodoc>
19387 <method name=
"SetOldSelection" type=
"" overloaded=
"no">
19388 <autodoc>SetOldSelection(self, int nOldSel)
</autodoc>
19390 <param name=
"nOldSel" type=
"int" default=
""/>
19395 #---------------------------------------------------------------------------
19397 <class name=
"Notebook" oldname=
"wxNotebook" module=
"_controls">
19398 <baseclass name=
"BookCtrl"/>
19399 <constructor name=
"Notebook" overloaded=
"no">
19400 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
19401 Size size=DefaultSize, long style=
0, String name=NOTEBOOK_NAME) -
> Notebook
</autodoc>
19403 <param name=
"parent" type=
"Window" default=
""/>
19404 <param name=
"id" type=
"int" default=
"-1"/>
19405 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
19406 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
19407 <param name=
"style" type=
"long" default=
"0"/>
19408 <param name=
"name" type=
"String" default=
"wxPyNOTEBOOK_NAME"/>
19411 <constructor name=
"PreNotebook" overloaded=
"no">
19412 <autodoc>PreNotebook() -
> Notebook
</autodoc>
19414 <method name=
"Create" type=
"bool" overloaded=
"no">
19415 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
19416 Size size=DefaultSize, long style=
0, String name=NOTEBOOK_NAME) -
> bool
</autodoc>
19418 <param name=
"parent" type=
"Window" default=
""/>
19419 <param name=
"id" type=
"int" default=
"-1"/>
19420 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
19421 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
19422 <param name=
"style" type=
"long" default=
"0"/>
19423 <param name=
"name" type=
"String" default=
"wxPyNOTEBOOK_NAME"/>
19426 <method name=
"GetRowCount" type=
"int" overloaded=
"no">
19427 <autodoc>GetRowCount(self) -
> int
</autodoc>
19429 <method name=
"SetPadding" type=
"" overloaded=
"no">
19430 <autodoc>SetPadding(self, Size padding)
</autodoc>
19432 <param name=
"padding" type=
"Size" default=
""/>
19435 <method name=
"SetTabSize" type=
"" overloaded=
"no">
19436 <autodoc>SetTabSize(self, Size sz)
</autodoc>
19438 <param name=
"sz" type=
"Size" default=
""/>
19441 <method name=
"HitTest" type=
"int" overloaded=
"no">
19442 <autodoc>HitTest(Point pt) -
> (tab, where)
</autodoc>
19443 <docstring>Returns the tab which is hit, and flags indicating where using
19444 wx.NB_HITTEST flags.
</docstring>
19446 <param name=
"pt" type=
"Point" default=
""/>
19447 <param name=
"OUTPUT" type=
"long" default=
""/>
19450 <method name=
"CalcSizeFromPage" type=
"Size" overloaded=
"no">
19451 <autodoc>CalcSizeFromPage(self, Size sizePage) -
> Size
</autodoc>
19453 <param name=
"sizePage" type=
"Size" default=
""/>
19456 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
19457 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
19458 <docstring>Get the default attributes for this class. This is useful if you want
19459 to use the same font or colour in your own control as in a standard
19460 control -- which is a much better idea than hard coding specific
19461 colours or fonts which might look completely out of place on the
19462 user's system, especially if it uses themes.
19464 The variant parameter is only relevant under Mac currently and is
19465 ignore under other platforms. Under Mac, it will change the size of
19466 the returned font. See `wx.Window.SetWindowVariant` for more about
19469 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
19473 <class name=
"NotebookEvent" oldname=
"wxNotebookEvent" module=
"_controls">
19474 <baseclass name=
"BookCtrlEvent"/>
19475 <constructor name=
"NotebookEvent" overloaded=
"no">
19476 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=
0, int nSel=-
1,
19477 int nOldSel=-
1) -
> NotebookEvent
</autodoc>
19479 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
19480 <param name=
"id" type=
"int" default=
"0"/>
19481 <param name=
"nSel" type=
"int" default=
"-1"/>
19482 <param name=
"nOldSel" type=
"int" default=
"-1"/>
19487 # wxNotebook events
19488 EVT_NOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,
1 )
19489 EVT_NOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,
1 )
19492 #----------------------------------------------------------------------------
19494 class NotebookPage(wx.Panel):
19496 There is an old (and apparently unsolvable) bug when placing a
19497 window with a nonstandard background colour in a wxNotebook on
19498 wxGTK, as the notbooks's background colour would always be used
19499 when the window is refreshed. The solution is to place a panel in
19500 the notbook and the coloured window on the panel, sized to cover
19501 the panel. This simple class does that for you, just put an
19502 instance of this in the notebook and make your regular window a
19503 child of this one and it will handle the resize for you.
19505 def __init__(self, parent, id=-
1,
19506 pos=wx.DefaultPosition, size=wx.DefaultSize,
19507 style=wx.TAB_TRAVERSAL,
name="panel"):
19508 wx.Panel.__init__(self, parent, id, pos, size, style, name)
19510 EVT_SIZE(self, self.OnSize)
19512 def OnSize(self, evt):
19513 if self.child is None:
19514 children = self.GetChildren()
19516 self.child = children[
0]
19518 self.child.SetPosition((
0,
0))
19519 self.child.SetSize(self.GetSize())
19523 #---------------------------------------------------------------------------
19525 <class name=
"Listbook" oldname=
"wxListbook" module=
"_controls">
19526 <baseclass name=
"BookCtrl"/>
19527 <constructor name=
"Listbook" overloaded=
"no">
19528 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
19529 Size size=DefaultSize, long style=
0, String name=EmptyString) -
> Listbook
</autodoc>
19531 <param name=
"parent" type=
"Window" default=
""/>
19532 <param name=
"id" type=
"int" default=
"-1"/>
19533 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
19534 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
19535 <param name=
"style" type=
"long" default=
"0"/>
19536 <param name=
"name" type=
"String" default=
"wxPyEmptyString"/>
19539 <constructor name=
"PreListbook" overloaded=
"no">
19540 <autodoc>PreListbook() -
> Listbook
</autodoc>
19542 <method name=
"Create" type=
"bool" overloaded=
"no">
19543 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
19544 Size size=DefaultSize, long style=
0, String name=EmptyString) -
> bool
</autodoc>
19546 <param name=
"parent" type=
"Window" default=
""/>
19547 <param name=
"id" type=
"int" default=
"-1"/>
19548 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
19549 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
19550 <param name=
"style" type=
"long" default=
"0"/>
19551 <param name=
"name" type=
"String" default=
"wxPyEmptyString"/>
19554 <method name=
"IsVertical" type=
"bool" overloaded=
"no">
19555 <autodoc>IsVertical(self) -
> bool
</autodoc>
19558 <class name=
"ListbookEvent" oldname=
"wxListbookEvent" module=
"_controls">
19559 <baseclass name=
"BookCtrlEvent"/>
19560 <constructor name=
"ListbookEvent" overloaded=
"no">
19561 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=
0, int nSel=-
1,
19562 int nOldSel=-
1) -
> ListbookEvent
</autodoc>
19564 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
19565 <param name=
"id" type=
"int" default=
"0"/>
19566 <param name=
"nSel" type=
"int" default=
"-1"/>
19567 <param name=
"nOldSel" type=
"int" default=
"-1"/>
19572 EVT_LISTBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED,
1 )
19573 EVT_LISTBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING,
1 )
19576 #---------------------------------------------------------------------------
19578 <class name=
"BookCtrlSizer" oldname=
"wxBookCtrlSizer" module=
"_controls">
19579 <baseclass name=
"Sizer"/>
19580 <constructor name=
"BookCtrlSizer" overloaded=
"no">
19581 <autodoc>__init__(self, BookCtrl nb) -
> BookCtrlSizer
</autodoc>
19583 <param name=
"nb" type=
"BookCtrl" default=
""/>
19586 <method name=
"RecalcSizes" type=
"" overloaded=
"no">
19587 <autodoc>RecalcSizes(self)
</autodoc>
19588 <docstring>Using the sizes calculated by `CalcMin` reposition and resize all the
19589 items managed by this sizer. You should not need to call this directly as
19590 it is called by `Layout`.
</docstring>
19592 <method name=
"CalcMin" type=
"Size" overloaded=
"no">
19593 <autodoc>CalcMin(self) -
> Size
</autodoc>
19594 <docstring>This method is where the sizer will do the actual calculation of its
19595 children's minimal sizes. You should not need to call this directly as
19596 it is called by `Layout`.
</docstring>
19598 <method name=
"GetControl" type=
"BookCtrl" overloaded=
"no">
19599 <autodoc>GetControl(self) -
> BookCtrl
</autodoc>
19602 <class name=
"NotebookSizer" oldname=
"wxNotebookSizer" module=
"_controls">
19603 <baseclass name=
"Sizer"/>
19604 <constructor name=
"NotebookSizer" overloaded=
"no">
19605 <autodoc>__init__(self, Notebook nb) -
> NotebookSizer
</autodoc>
19607 <param name=
"nb" type=
"Notebook" default=
""/>
19610 <method name=
"RecalcSizes" type=
"" overloaded=
"no">
19611 <autodoc>RecalcSizes(self)
</autodoc>
19612 <docstring>Using the sizes calculated by `CalcMin` reposition and resize all the
19613 items managed by this sizer. You should not need to call this directly as
19614 it is called by `Layout`.
</docstring>
19616 <method name=
"CalcMin" type=
"Size" overloaded=
"no">
19617 <autodoc>CalcMin(self) -
> Size
</autodoc>
19618 <docstring>This method is where the sizer will do the actual calculation of its
19619 children's minimal sizes. You should not need to call this directly as
19620 it is called by `Layout`.
</docstring>
19622 <method name=
"GetNotebook" type=
"Notebook" overloaded=
"no">
19623 <autodoc>GetNotebook(self) -
> Notebook
</autodoc>
19627 #---------------------------------------------------------------------------
19629 <class name=
"ToolBarToolBase" oldname=
"wxToolBarToolBase" module=
"_controls">
19630 <baseclass name=
"Object"/>
19631 <method name=
"GetId" type=
"int" overloaded=
"no">
19632 <autodoc>GetId(self) -
> int
</autodoc>
19634 <method name=
"GetControl" type=
"Control" overloaded=
"no">
19635 <autodoc>GetControl(self) -
> Control
</autodoc>
19637 <method name=
"GetToolBar" type=
"wxToolBarBase" overloaded=
"no">
19638 <autodoc>GetToolBar(self) -
> ToolBarBase
</autodoc>
19640 <method name=
"IsButton" type=
"int" overloaded=
"no">
19641 <autodoc>IsButton(self) -
> int
</autodoc>
19643 <method name=
"IsControl" type=
"int" overloaded=
"no">
19644 <autodoc>IsControl(self) -
> int
</autodoc>
19646 <method name=
"IsSeparator" type=
"int" overloaded=
"no">
19647 <autodoc>IsSeparator(self) -
> int
</autodoc>
19649 <method name=
"GetStyle" type=
"int" overloaded=
"no">
19650 <autodoc>GetStyle(self) -
> int
</autodoc>
19652 <method name=
"GetKind" type=
"wxItemKind" overloaded=
"no">
19653 <autodoc>GetKind(self) -
> int
</autodoc>
19655 <method name=
"IsEnabled" type=
"bool" overloaded=
"no">
19656 <autodoc>IsEnabled(self) -
> bool
</autodoc>
19658 <method name=
"IsToggled" type=
"bool" overloaded=
"no">
19659 <autodoc>IsToggled(self) -
> bool
</autodoc>
19661 <method name=
"CanBeToggled" type=
"bool" overloaded=
"no">
19662 <autodoc>CanBeToggled(self) -
> bool
</autodoc>
19664 <method name=
"GetNormalBitmap" type=
"Bitmap" overloaded=
"no">
19665 <autodoc>GetNormalBitmap(self) -
> Bitmap
</autodoc>
19667 <method name=
"GetDisabledBitmap" type=
"Bitmap" overloaded=
"no">
19668 <autodoc>GetDisabledBitmap(self) -
> Bitmap
</autodoc>
19670 <method name=
"GetBitmap" type=
"Bitmap" overloaded=
"no">
19671 <autodoc>GetBitmap(self) -
> Bitmap
</autodoc>
19673 <method name=
"GetLabel" type=
"String" overloaded=
"no">
19674 <autodoc>GetLabel(self) -
> String
</autodoc>
19676 <method name=
"GetShortHelp" type=
"String" overloaded=
"no">
19677 <autodoc>GetShortHelp(self) -
> String
</autodoc>
19679 <method name=
"GetLongHelp" type=
"String" overloaded=
"no">
19680 <autodoc>GetLongHelp(self) -
> String
</autodoc>
19682 <method name=
"Enable" type=
"bool" overloaded=
"no">
19683 <autodoc>Enable(self, bool enable) -
> bool
</autodoc>
19685 <param name=
"enable" type=
"bool" default=
""/>
19688 <method name=
"Toggle" type=
"" overloaded=
"no">
19689 <autodoc>Toggle(self)
</autodoc>
19691 <method name=
"SetToggle" type=
"bool" overloaded=
"no">
19692 <autodoc>SetToggle(self, bool toggle) -
> bool
</autodoc>
19694 <param name=
"toggle" type=
"bool" default=
""/>
19697 <method name=
"SetShortHelp" type=
"bool" overloaded=
"no">
19698 <autodoc>SetShortHelp(self, String help) -
> bool
</autodoc>
19700 <param name=
"help" type=
"String" default=
""/>
19703 <method name=
"SetLongHelp" type=
"bool" overloaded=
"no">
19704 <autodoc>SetLongHelp(self, String help) -
> bool
</autodoc>
19706 <param name=
"help" type=
"String" default=
""/>
19709 <method name=
"SetNormalBitmap" type=
"" overloaded=
"no">
19710 <autodoc>SetNormalBitmap(self, Bitmap bmp)
</autodoc>
19712 <param name=
"bmp" type=
"Bitmap" default=
""/>
19715 <method name=
"SetDisabledBitmap" type=
"" overloaded=
"no">
19716 <autodoc>SetDisabledBitmap(self, Bitmap bmp)
</autodoc>
19718 <param name=
"bmp" type=
"Bitmap" default=
""/>
19721 <method name=
"SetLabel" type=
"" overloaded=
"no">
19722 <autodoc>SetLabel(self, String label)
</autodoc>
19724 <param name=
"label" type=
"String" default=
""/>
19727 <method name=
"Detach" type=
"" overloaded=
"no">
19728 <autodoc>Detach(self)
</autodoc>
19730 <method name=
"Attach" type=
"" overloaded=
"no">
19731 <autodoc>Attach(self, ToolBarBase tbar)
</autodoc>
19733 <param name=
"tbar" type=
"wxToolBarBase" default=
""/>
19736 <method name=
"GetClientData" type=
"PyObject" overloaded=
"no">
19737 <autodoc>GetClientData(self) -
> PyObject
</autodoc>
19739 <method name=
"SetClientData" type=
"" overloaded=
"no">
19740 <autodoc>SetClientData(self, PyObject clientData)
</autodoc>
19742 <param name=
"clientData" type=
"PyObject" default=
""/>
19746 <class name=
"ToolBarBase" oldname=
"wxToolBarBase" module=
"_controls">
19747 <baseclass name=
"Control"/>
19748 <method name=
"DoAddTool" type=
"ToolBarToolBase" overloaded=
"no">
19749 <autodoc>DoAddTool(self, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap,
19750 int kind=ITEM_NORMAL, String shortHelp=EmptyString,
19751 String longHelp=EmptyString,
19752 PyObject clientData=None) -
> ToolBarToolBase
</autodoc>
19754 <param name=
"id" type=
"int" default=
""/>
19755 <param name=
"label" type=
"String" default=
""/>
19756 <param name=
"bitmap" type=
"Bitmap" default=
""/>
19757 <param name=
"bmpDisabled" type=
"Bitmap" default=
"wxNullBitmap"/>
19758 <param name=
"kind" type=
"wxItemKind" default=
"wxITEM_NORMAL"/>
19759 <param name=
"shortHelp" type=
"String" default=
"wxPyEmptyString"/>
19760 <param name=
"longHelp" type=
"String" default=
"wxPyEmptyString"/>
19761 <param name=
"clientData" type=
"PyObject" default=
"NULL"/>
19764 <method name=
"DoInsertTool" type=
"ToolBarToolBase" overloaded=
"no">
19765 <autodoc>DoInsertTool(self, size_t pos, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap,
19766 int kind=ITEM_NORMAL,
19767 String shortHelp=EmptyString, String longHelp=EmptyString,
19768 PyObject clientData=None) -
> ToolBarToolBase
</autodoc>
19770 <param name=
"pos" type=
"size_t" default=
""/>
19771 <param name=
"id" type=
"int" default=
""/>
19772 <param name=
"label" type=
"String" default=
""/>
19773 <param name=
"bitmap" type=
"Bitmap" default=
""/>
19774 <param name=
"bmpDisabled" type=
"Bitmap" default=
"wxNullBitmap"/>
19775 <param name=
"kind" type=
"wxItemKind" default=
"wxITEM_NORMAL"/>
19776 <param name=
"shortHelp" type=
"String" default=
"wxPyEmptyString"/>
19777 <param name=
"longHelp" type=
"String" default=
"wxPyEmptyString"/>
19778 <param name=
"clientData" type=
"PyObject" default=
"NULL"/>
19781 <method name=
"AddToolItem" type=
"ToolBarToolBase" overloaded=
"no">
19782 <autodoc>AddToolItem(self, ToolBarToolBase tool) -
> ToolBarToolBase
</autodoc>
19784 <param name=
"tool" type=
"ToolBarToolBase" default=
""/>
19787 <method name=
"InsertToolItem" type=
"ToolBarToolBase" overloaded=
"no">
19788 <autodoc>InsertToolItem(self, size_t pos, ToolBarToolBase tool) -
> ToolBarToolBase
</autodoc>
19790 <param name=
"pos" type=
"size_t" default=
""/>
19791 <param name=
"tool" type=
"ToolBarToolBase" default=
""/>
19794 <method name=
"AddControl" type=
"ToolBarToolBase" overloaded=
"no">
19795 <autodoc>AddControl(self, Control control) -
> ToolBarToolBase
</autodoc>
19797 <param name=
"control" type=
"Control" default=
""/>
19800 <method name=
"InsertControl" type=
"ToolBarToolBase" overloaded=
"no">
19801 <autodoc>InsertControl(self, size_t pos, Control control) -
> ToolBarToolBase
</autodoc>
19803 <param name=
"pos" type=
"size_t" default=
""/>
19804 <param name=
"control" type=
"Control" default=
""/>
19807 <method name=
"FindControl" type=
"Control" overloaded=
"no">
19808 <autodoc>FindControl(self, int id) -
> Control
</autodoc>
19810 <param name=
"id" type=
"int" default=
""/>
19813 <method name=
"AddSeparator" type=
"ToolBarToolBase" overloaded=
"no">
19814 <autodoc>AddSeparator(self) -
> ToolBarToolBase
</autodoc>
19816 <method name=
"InsertSeparator" type=
"ToolBarToolBase" overloaded=
"no">
19817 <autodoc>InsertSeparator(self, size_t pos) -
> ToolBarToolBase
</autodoc>
19819 <param name=
"pos" type=
"size_t" default=
""/>
19822 <method name=
"RemoveTool" type=
"ToolBarToolBase" overloaded=
"no">
19823 <autodoc>RemoveTool(self, int id) -
> ToolBarToolBase
</autodoc>
19825 <param name=
"id" type=
"int" default=
""/>
19828 <method name=
"DeleteToolByPos" type=
"bool" overloaded=
"no">
19829 <autodoc>DeleteToolByPos(self, size_t pos) -
> bool
</autodoc>
19831 <param name=
"pos" type=
"size_t" default=
""/>
19834 <method name=
"DeleteTool" type=
"bool" overloaded=
"no">
19835 <autodoc>DeleteTool(self, int id) -
> bool
</autodoc>
19837 <param name=
"id" type=
"int" default=
""/>
19840 <method name=
"ClearTools" type=
"" overloaded=
"no">
19841 <autodoc>ClearTools(self)
</autodoc>
19843 <method name=
"Realize" type=
"bool" overloaded=
"no">
19844 <autodoc>Realize(self) -
> bool
</autodoc>
19846 <method name=
"EnableTool" type=
"" overloaded=
"no">
19847 <autodoc>EnableTool(self, int id, bool enable)
</autodoc>
19849 <param name=
"id" type=
"int" default=
""/>
19850 <param name=
"enable" type=
"bool" default=
""/>
19853 <method name=
"ToggleTool" type=
"" overloaded=
"no">
19854 <autodoc>ToggleTool(self, int id, bool toggle)
</autodoc>
19856 <param name=
"id" type=
"int" default=
""/>
19857 <param name=
"toggle" type=
"bool" default=
""/>
19860 <method name=
"SetToggle" type=
"" overloaded=
"no">
19861 <autodoc>SetToggle(self, int id, bool toggle)
</autodoc>
19863 <param name=
"id" type=
"int" default=
""/>
19864 <param name=
"toggle" type=
"bool" default=
""/>
19867 <method name=
"GetToolClientData" type=
"PyObject" overloaded=
"no">
19868 <autodoc>GetToolClientData(self, int id) -
> PyObject
</autodoc>
19870 <param name=
"id" type=
"int" default=
""/>
19873 <method name=
"SetToolClientData" type=
"" overloaded=
"no">
19874 <autodoc>SetToolClientData(self, int id, PyObject clientData)
</autodoc>
19876 <param name=
"id" type=
"int" default=
""/>
19877 <param name=
"clientData" type=
"PyObject" default=
""/>
19880 <method name=
"GetToolPos" type=
"int" overloaded=
"no">
19881 <autodoc>GetToolPos(self, int id) -
> int
</autodoc>
19883 <param name=
"id" type=
"int" default=
""/>
19886 <method name=
"GetToolState" type=
"bool" overloaded=
"no">
19887 <autodoc>GetToolState(self, int id) -
> bool
</autodoc>
19889 <param name=
"id" type=
"int" default=
""/>
19892 <method name=
"GetToolEnabled" type=
"bool" overloaded=
"no">
19893 <autodoc>GetToolEnabled(self, int id) -
> bool
</autodoc>
19895 <param name=
"id" type=
"int" default=
""/>
19898 <method name=
"SetToolShortHelp" type=
"" overloaded=
"no">
19899 <autodoc>SetToolShortHelp(self, int id, String helpString)
</autodoc>
19901 <param name=
"id" type=
"int" default=
""/>
19902 <param name=
"helpString" type=
"String" default=
""/>
19905 <method name=
"GetToolShortHelp" type=
"String" overloaded=
"no">
19906 <autodoc>GetToolShortHelp(self, int id) -
> String
</autodoc>
19908 <param name=
"id" type=
"int" default=
""/>
19911 <method name=
"SetToolLongHelp" type=
"" overloaded=
"no">
19912 <autodoc>SetToolLongHelp(self, int id, String helpString)
</autodoc>
19914 <param name=
"id" type=
"int" default=
""/>
19915 <param name=
"helpString" type=
"String" default=
""/>
19918 <method name=
"GetToolLongHelp" type=
"String" overloaded=
"no">
19919 <autodoc>GetToolLongHelp(self, int id) -
> String
</autodoc>
19921 <param name=
"id" type=
"int" default=
""/>
19924 <method name=
"SetMarginsXY" type=
"" overloaded=
"no">
19925 <autodoc>SetMarginsXY(self, int x, int y)
</autodoc>
19927 <param name=
"x" type=
"int" default=
""/>
19928 <param name=
"y" type=
"int" default=
""/>
19931 <method name=
"SetMargins" type=
"" overloaded=
"no">
19932 <autodoc>SetMargins(self, Size size)
</autodoc>
19934 <param name=
"size" type=
"Size" default=
""/>
19937 <method name=
"SetToolPacking" type=
"" overloaded=
"no">
19938 <autodoc>SetToolPacking(self, int packing)
</autodoc>
19940 <param name=
"packing" type=
"int" default=
""/>
19943 <method name=
"SetToolSeparation" type=
"" overloaded=
"no">
19944 <autodoc>SetToolSeparation(self, int separation)
</autodoc>
19946 <param name=
"separation" type=
"int" default=
""/>
19949 <method name=
"GetToolMargins" type=
"Size" overloaded=
"no">
19950 <autodoc>GetToolMargins(self) -
> Size
</autodoc>
19952 <method name=
"GetMargins" type=
"Size" overloaded=
"no">
19953 <autodoc>GetMargins(self) -
> Size
</autodoc>
19955 <method name=
"GetToolPacking" type=
"int" overloaded=
"no">
19956 <autodoc>GetToolPacking(self) -
> int
</autodoc>
19958 <method name=
"GetToolSeparation" type=
"int" overloaded=
"no">
19959 <autodoc>GetToolSeparation(self) -
> int
</autodoc>
19961 <method name=
"SetRows" type=
"" overloaded=
"no">
19962 <autodoc>SetRows(self, int nRows)
</autodoc>
19964 <param name=
"nRows" type=
"int" default=
""/>
19967 <method name=
"SetMaxRowsCols" type=
"" overloaded=
"no">
19968 <autodoc>SetMaxRowsCols(self, int rows, int cols)
</autodoc>
19970 <param name=
"rows" type=
"int" default=
""/>
19971 <param name=
"cols" type=
"int" default=
""/>
19974 <method name=
"GetMaxRows" type=
"int" overloaded=
"no">
19975 <autodoc>GetMaxRows(self) -
> int
</autodoc>
19977 <method name=
"GetMaxCols" type=
"int" overloaded=
"no">
19978 <autodoc>GetMaxCols(self) -
> int
</autodoc>
19980 <method name=
"SetToolBitmapSize" type=
"" overloaded=
"no">
19981 <autodoc>SetToolBitmapSize(self, Size size)
</autodoc>
19983 <param name=
"size" type=
"Size" default=
""/>
19986 <method name=
"GetToolBitmapSize" type=
"Size" overloaded=
"no">
19987 <autodoc>GetToolBitmapSize(self) -
> Size
</autodoc>
19989 <method name=
"GetToolSize" type=
"Size" overloaded=
"no">
19990 <autodoc>GetToolSize(self) -
> Size
</autodoc>
19992 <method name=
"FindToolForPosition" type=
"ToolBarToolBase" overloaded=
"no">
19993 <autodoc>FindToolForPosition(self, int x, int y) -
> ToolBarToolBase
</autodoc>
19995 <param name=
"x" type=
"int" default=
""/>
19996 <param name=
"y" type=
"int" default=
""/>
19999 <method name=
"FindById" type=
"ToolBarToolBase" overloaded=
"no">
20000 <autodoc>FindById(self, int toolid) -
> ToolBarToolBase
</autodoc>
20002 <param name=
"toolid" type=
"int" default=
""/>
20005 <method name=
"IsVertical" type=
"bool" overloaded=
"no">
20006 <autodoc>IsVertical(self) -
> bool
</autodoc>
20009 <class name=
"ToolBar" oldname=
"wxToolBar" module=
"_controls">
20010 <baseclass name=
"ToolBarBase"/>
20011 <constructor name=
"ToolBar" overloaded=
"no">
20012 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
20013 Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL,
20014 String name=wxPyToolBarNameStr) -
> ToolBar
</autodoc>
20016 <param name=
"parent" type=
"Window" default=
""/>
20017 <param name=
"id" type=
"int" default=
"-1"/>
20018 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
20019 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
20020 <param name=
"style" type=
"long" default=
"wxNO_BORDER|wxTB_HORIZONTAL"/>
20021 <param name=
"name" type=
"String" default=
"wxPyToolBarNameStr"/>
20024 <constructor name=
"PreToolBar" overloaded=
"no">
20025 <autodoc>PreToolBar() -
> ToolBar
</autodoc>
20027 <method name=
"Create" type=
"bool" overloaded=
"no">
20028 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
20029 Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL,
20030 String name=wxPyToolBarNameStr) -
> bool
</autodoc>
20032 <param name=
"parent" type=
"Window" default=
""/>
20033 <param name=
"id" type=
"int" default=
"-1"/>
20034 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
20035 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
20036 <param name=
"style" type=
"long" default=
"wxNO_BORDER|wxTB_HORIZONTAL"/>
20037 <param name=
"name" type=
"String" default=
"wxPyToolBarNameStr"/>
20040 <method name=
"FindToolForPosition" type=
"ToolBarToolBase" overloaded=
"no">
20041 <autodoc>FindToolForPosition(self, int x, int y) -
> ToolBarToolBase
</autodoc>
20043 <param name=
"x" type=
"int" default=
""/>
20044 <param name=
"y" type=
"int" default=
""/>
20047 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
20048 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
20049 <docstring>Get the default attributes for this class. This is useful if you want
20050 to use the same font or colour in your own control as in a standard
20051 control -- which is a much better idea than hard coding specific
20052 colours or fonts which might look completely out of place on the
20053 user's system, especially if it uses themes.
20055 The variant parameter is only relevant under Mac currently and is
20056 ignore under other platforms. Under Mac, it will change the size of
20057 the returned font. See `wx.Window.SetWindowVariant` for more about
20060 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
20065 #---------------------------------------------------------------------------
20068 #---------------------------------------------------------------------------
20070 <class name=
"ListItemAttr" oldname=
"wxListItemAttr" module=
"_controls">
20071 <constructor name=
"ListItemAttr" overloaded=
"no">
20072 <autodoc>__init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour,
20073 Font font=wxNullFont) -
> ListItemAttr
</autodoc>
20075 <param name=
"colText" type=
"Colour" default=
"wxNullColour"/>
20076 <param name=
"colBack" type=
"Colour" default=
"wxNullColour"/>
20077 <param name=
"font" type=
"Font" default=
"wxNullFont"/>
20080 <method name=
"SetTextColour" type=
"" overloaded=
"no">
20081 <autodoc>SetTextColour(self, Colour colText)
</autodoc>
20083 <param name=
"colText" type=
"Colour" default=
""/>
20086 <method name=
"SetBackgroundColour" type=
"" overloaded=
"no">
20087 <autodoc>SetBackgroundColour(self, Colour colBack)
</autodoc>
20089 <param name=
"colBack" type=
"Colour" default=
""/>
20092 <method name=
"SetFont" type=
"" overloaded=
"no">
20093 <autodoc>SetFont(self, Font font)
</autodoc>
20095 <param name=
"font" type=
"Font" default=
""/>
20098 <method name=
"HasTextColour" type=
"bool" overloaded=
"no">
20099 <autodoc>HasTextColour(self) -
> bool
</autodoc>
20101 <method name=
"HasBackgroundColour" type=
"bool" overloaded=
"no">
20102 <autodoc>HasBackgroundColour(self) -
> bool
</autodoc>
20104 <method name=
"HasFont" type=
"bool" overloaded=
"no">
20105 <autodoc>HasFont(self) -
> bool
</autodoc>
20107 <method name=
"GetTextColour" type=
"Colour" overloaded=
"no">
20108 <autodoc>GetTextColour(self) -
> Colour
</autodoc>
20110 <method name=
"GetBackgroundColour" type=
"Colour" overloaded=
"no">
20111 <autodoc>GetBackgroundColour(self) -
> Colour
</autodoc>
20113 <method name=
"GetFont" type=
"Font" overloaded=
"no">
20114 <autodoc>GetFont(self) -
> Font
</autodoc>
20116 <method name=
"Destroy" type=
"" overloaded=
"no">
20117 <autodoc>Destroy(self)
</autodoc>
20121 #---------------------------------------------------------------------------
20123 <class name=
"ListItem" oldname=
"wxListItem" module=
"_controls">
20124 <baseclass name=
"Object"/>
20125 <constructor name=
"ListItem" overloaded=
"no">
20126 <autodoc>__init__(self) -
> ListItem
</autodoc>
20128 <destructor name=
"~wxListItem" overloaded=
"no">
20129 <autodoc>__del__(self)
</autodoc>
20131 <method name=
"Clear" type=
"" overloaded=
"no">
20132 <autodoc>Clear(self)
</autodoc>
20134 <method name=
"ClearAttributes" type=
"" overloaded=
"no">
20135 <autodoc>ClearAttributes(self)
</autodoc>
20137 <method name=
"SetMask" type=
"" overloaded=
"no">
20138 <autodoc>SetMask(self, long mask)
</autodoc>
20140 <param name=
"mask" type=
"long" default=
""/>
20143 <method name=
"SetId" type=
"" overloaded=
"no">
20144 <autodoc>SetId(self, long id)
</autodoc>
20146 <param name=
"id" type=
"long" default=
""/>
20149 <method name=
"SetColumn" type=
"" overloaded=
"no">
20150 <autodoc>SetColumn(self, int col)
</autodoc>
20152 <param name=
"col" type=
"int" default=
""/>
20155 <method name=
"SetState" type=
"" overloaded=
"no">
20156 <autodoc>SetState(self, long state)
</autodoc>
20158 <param name=
"state" type=
"long" default=
""/>
20161 <method name=
"SetStateMask" type=
"" overloaded=
"no">
20162 <autodoc>SetStateMask(self, long stateMask)
</autodoc>
20164 <param name=
"stateMask" type=
"long" default=
""/>
20167 <method name=
"SetText" type=
"" overloaded=
"no">
20168 <autodoc>SetText(self, String text)
</autodoc>
20170 <param name=
"text" type=
"String" default=
""/>
20173 <method name=
"SetImage" type=
"" overloaded=
"no">
20174 <autodoc>SetImage(self, int image)
</autodoc>
20176 <param name=
"image" type=
"int" default=
""/>
20179 <method name=
"SetData" type=
"" overloaded=
"no">
20180 <autodoc>SetData(self, long data)
</autodoc>
20182 <param name=
"data" type=
"long" default=
""/>
20185 <method name=
"SetWidth" type=
"" overloaded=
"no">
20186 <autodoc>SetWidth(self, int width)
</autodoc>
20188 <param name=
"width" type=
"int" default=
""/>
20191 <method name=
"SetAlign" type=
"" overloaded=
"no">
20192 <autodoc>SetAlign(self, int align)
</autodoc>
20194 <param name=
"align" type=
"wxListColumnFormat" default=
""/>
20197 <method name=
"SetTextColour" type=
"" overloaded=
"no">
20198 <autodoc>SetTextColour(self, Colour colText)
</autodoc>
20200 <param name=
"colText" type=
"Colour" default=
""/>
20203 <method name=
"SetBackgroundColour" type=
"" overloaded=
"no">
20204 <autodoc>SetBackgroundColour(self, Colour colBack)
</autodoc>
20206 <param name=
"colBack" type=
"Colour" default=
""/>
20209 <method name=
"SetFont" type=
"" overloaded=
"no">
20210 <autodoc>SetFont(self, Font font)
</autodoc>
20212 <param name=
"font" type=
"Font" default=
""/>
20215 <method name=
"GetMask" type=
"long" overloaded=
"no">
20216 <autodoc>GetMask(self) -
> long
</autodoc>
20218 <method name=
"GetId" type=
"long" overloaded=
"no">
20219 <autodoc>GetId(self) -
> long
</autodoc>
20221 <method name=
"GetColumn" type=
"int" overloaded=
"no">
20222 <autodoc>GetColumn(self) -
> int
</autodoc>
20224 <method name=
"GetState" type=
"long" overloaded=
"no">
20225 <autodoc>GetState(self) -
> long
</autodoc>
20227 <method name=
"GetText" type=
"String" overloaded=
"no">
20228 <autodoc>GetText(self) -
> String
</autodoc>
20230 <method name=
"GetImage" type=
"int" overloaded=
"no">
20231 <autodoc>GetImage(self) -
> int
</autodoc>
20233 <method name=
"GetData" type=
"long" overloaded=
"no">
20234 <autodoc>GetData(self) -
> long
</autodoc>
20236 <method name=
"GetWidth" type=
"int" overloaded=
"no">
20237 <autodoc>GetWidth(self) -
> int
</autodoc>
20239 <method name=
"GetAlign" type=
"wxListColumnFormat" overloaded=
"no">
20240 <autodoc>GetAlign(self) -
> int
</autodoc>
20242 <method name=
"GetAttributes" type=
"ListItemAttr" overloaded=
"no">
20243 <autodoc>GetAttributes(self) -
> ListItemAttr
</autodoc>
20245 <method name=
"HasAttributes" type=
"bool" overloaded=
"no">
20246 <autodoc>HasAttributes(self) -
> bool
</autodoc>
20248 <method name=
"GetTextColour" type=
"Colour" overloaded=
"no">
20249 <autodoc>GetTextColour(self) -
> Colour
</autodoc>
20251 <method name=
"GetBackgroundColour" type=
"Colour" overloaded=
"no">
20252 <autodoc>GetBackgroundColour(self) -
> Colour
</autodoc>
20254 <method name=
"GetFont" type=
"Font" overloaded=
"no">
20255 <autodoc>GetFont(self) -
> Font
</autodoc>
20257 <property name=
"m_mask" type=
"long" readonly=
"no"/>
20258 <property name=
"m_itemId" type=
"long" readonly=
"no"/>
20259 <property name=
"m_col" type=
"int" readonly=
"no"/>
20260 <property name=
"m_state" type=
"long" readonly=
"no"/>
20261 <property name=
"m_stateMask" type=
"long" readonly=
"no"/>
20262 <property name=
"m_text" type=
"String" readonly=
"no"/>
20263 <property name=
"m_image" type=
"int" readonly=
"no"/>
20264 <property name=
"m_data" type=
"long" readonly=
"no"/>
20265 <property name=
"m_format" type=
"int" readonly=
"no"/>
20266 <property name=
"m_width" type=
"int" readonly=
"no"/>
20269 #---------------------------------------------------------------------------
20271 <class name=
"ListEvent" oldname=
"wxListEvent" module=
"_controls">
20272 <baseclass name=
"NotifyEvent"/>
20273 <constructor name=
"ListEvent" overloaded=
"no">
20274 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=
0) -
> ListEvent
</autodoc>
20276 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
20277 <param name=
"id" type=
"int" default=
"0"/>
20280 <property name=
"m_code" type=
"int" readonly=
"no"/>
20281 <property name=
"m_oldItemIndex" type=
"long" readonly=
"no"/>
20282 <property name=
"m_itemIndex" type=
"long" readonly=
"no"/>
20283 <property name=
"m_col" type=
"int" readonly=
"no"/>
20284 <property name=
"m_pointDrag" type=
"Point" readonly=
"no"/>
20285 <property name=
"m_item" type=
"ListItem" readonly=
"yes"/>
20286 <method name=
"GetKeyCode" type=
"int" overloaded=
"no">
20287 <autodoc>GetKeyCode(self) -
> int
</autodoc>
20289 <method name=
"GetIndex" type=
"long" overloaded=
"no">
20290 <autodoc>GetIndex(self) -
> long
</autodoc>
20292 <method name=
"GetColumn" type=
"int" overloaded=
"no">
20293 <autodoc>GetColumn(self) -
> int
</autodoc>
20295 <method name=
"GetPoint" type=
"Point" overloaded=
"no">
20296 <autodoc>GetPoint(self) -
> Point
</autodoc>
20298 <method name=
"GetLabel" type=
"String" overloaded=
"no">
20299 <autodoc>GetLabel(self) -
> String
</autodoc>
20301 <method name=
"GetText" type=
"String" overloaded=
"no">
20302 <autodoc>GetText(self) -
> String
</autodoc>
20304 <method name=
"GetImage" type=
"int" overloaded=
"no">
20305 <autodoc>GetImage(self) -
> int
</autodoc>
20307 <method name=
"GetData" type=
"long" overloaded=
"no">
20308 <autodoc>GetData(self) -
> long
</autodoc>
20310 <method name=
"GetMask" type=
"long" overloaded=
"no">
20311 <autodoc>GetMask(self) -
> long
</autodoc>
20313 <method name=
"GetItem" type=
"ListItem" overloaded=
"no">
20314 <autodoc>GetItem(self) -
> ListItem
</autodoc>
20316 <method name=
"GetCacheFrom" type=
"long" overloaded=
"no">
20317 <autodoc>GetCacheFrom(self) -
> long
</autodoc>
20319 <method name=
"GetCacheTo" type=
"long" overloaded=
"no">
20320 <autodoc>GetCacheTo(self) -
> long
</autodoc>
20322 <method name=
"IsEditCancelled" type=
"bool" overloaded=
"no">
20323 <autodoc>IsEditCancelled(self) -
> bool
</autodoc>
20325 <method name=
"SetEditCanceled" type=
"" overloaded=
"no">
20326 <autodoc>SetEditCanceled(self, bool editCancelled)
</autodoc>
20328 <param name=
"editCancelled" type=
"bool" default=
""/>
20334 EVT_LIST_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_DRAG ,
1)
20335 EVT_LIST_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_RDRAG ,
1)
20336 EVT_LIST_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT ,
1)
20337 EVT_LIST_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_LIST_END_LABEL_EDIT ,
1)
20338 EVT_LIST_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ITEM ,
1)
20339 EVT_LIST_DELETE_ALL_ITEMS = wx.PyEventBinder(wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS ,
1)
20340 EVT_LIST_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_LIST_GET_INFO ,
1)
20341 EVT_LIST_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_LIST_SET_INFO ,
1)
20342 EVT_LIST_ITEM_SELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_SELECTED ,
1)
20343 EVT_LIST_ITEM_DESELECTED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_DESELECTED ,
1)
20344 EVT_LIST_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_LIST_KEY_DOWN ,
1)
20345 EVT_LIST_INSERT_ITEM = wx.PyEventBinder(wxEVT_COMMAND_LIST_INSERT_ITEM ,
1)
20346 EVT_LIST_COL_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_CLICK ,
1)
20347 EVT_LIST_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK ,
1)
20348 EVT_LIST_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK,
1)
20349 EVT_LIST_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_ACTIVATED ,
1)
20350 EVT_LIST_CACHE_HINT = wx.PyEventBinder(wxEVT_COMMAND_LIST_CACHE_HINT ,
1)
20351 EVT_LIST_COL_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_RIGHT_CLICK ,
1)
20352 EVT_LIST_COL_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG ,
1)
20353 EVT_LIST_COL_DRAGGING = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_DRAGGING ,
1)
20354 EVT_LIST_COL_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_LIST_COL_END_DRAG ,
1)
20355 EVT_LIST_ITEM_FOCUSED = wx.PyEventBinder(wxEVT_COMMAND_LIST_ITEM_FOCUSED ,
1)
20358 #---------------------------------------------------------------------------
20360 <class name=
"ListCtrl" oldname=
"wxPyListCtrl" module=
"_controls">
20361 <baseclass name=
"Control"/>
20362 <constructor name=
"wxPyListCtrl" overloaded=
"no">
20363 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
20364 Size size=DefaultSize, long style=LC_ICON,
20365 Validator validator=DefaultValidator, String name=ListCtrlNameStr) -
> ListCtrl
</autodoc>
20367 <param name=
"parent" type=
"Window" default=
""/>
20368 <param name=
"id" type=
"int" default=
"-1"/>
20369 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
20370 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
20371 <param name=
"style" type=
"long" default=
"wxLC_ICON"/>
20372 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
20373 <param name=
"name" type=
"String" default=
"wxPyListCtrlNameStr"/>
20376 <constructor name=
"PreListCtrl" overloaded=
"no">
20377 <autodoc>PreListCtrl() -
> ListCtrl
</autodoc>
20379 <method name=
"Create" type=
"bool" overloaded=
"no">
20380 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
20381 Size size=DefaultSize, long style=LC_ICON,
20382 Validator validator=DefaultValidator, String name=ListCtrlNameStr) -
> bool
</autodoc>
20383 <docstring>Do the
2nd phase and create the GUI control.
</docstring>
20385 <param name=
"parent" type=
"Window" default=
""/>
20386 <param name=
"id" type=
"int" default=
"-1"/>
20387 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
20388 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
20389 <param name=
"style" type=
"long" default=
"wxLC_ICON"/>
20390 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
20391 <param name=
"name" type=
"String" default=
"wxPyListCtrlNameStr"/>
20394 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
20395 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
20397 <param name=
"self" type=
"PyObject" default=
""/>
20398 <param name=
"_class" type=
"PyObject" default=
""/>
20401 <method name=
"SetForegroundColour" type=
"bool" overloaded=
"no">
20402 <autodoc>SetForegroundColour(self, Colour col) -
> bool
</autodoc>
20404 <param name=
"col" type=
"Colour" default=
""/>
20407 <method name=
"SetBackgroundColour" type=
"bool" overloaded=
"no">
20408 <autodoc>SetBackgroundColour(self, Colour col) -
> bool
</autodoc>
20410 <param name=
"col" type=
"Colour" default=
""/>
20413 <method name=
"GetColumn" type=
"ListItem" overloaded=
"no">
20414 <autodoc>GetColumn(self, int col) -
> ListItem
</autodoc>
20416 <param name=
"col" type=
"int" default=
""/>
20419 <method name=
"SetColumn" type=
"bool" overloaded=
"no">
20420 <autodoc>SetColumn(self, int col, ListItem item) -
> bool
</autodoc>
20422 <param name=
"col" type=
"int" default=
""/>
20423 <param name=
"item" type=
"ListItem" default=
""/>
20426 <method name=
"GetColumnWidth" type=
"int" overloaded=
"no">
20427 <autodoc>GetColumnWidth(self, int col) -
> int
</autodoc>
20429 <param name=
"col" type=
"int" default=
""/>
20432 <method name=
"SetColumnWidth" type=
"bool" overloaded=
"no">
20433 <autodoc>SetColumnWidth(self, int col, int width) -
> bool
</autodoc>
20435 <param name=
"col" type=
"int" default=
""/>
20436 <param name=
"width" type=
"int" default=
""/>
20439 <method name=
"GetCountPerPage" type=
"int" overloaded=
"no">
20440 <autodoc>GetCountPerPage(self) -
> int
</autodoc>
20442 <method name=
"GetViewRect" type=
"Rect" overloaded=
"no">
20443 <autodoc>GetViewRect(self) -
> Rect
</autodoc>
20445 <method name=
"GetItem" type=
"ListItem" overloaded=
"no">
20446 <autodoc>GetItem(self, long itemId, int col=
0) -
> ListItem
</autodoc>
20448 <param name=
"itemId" type=
"long" default=
""/>
20449 <param name=
"col" type=
"int" default=
"0"/>
20452 <method name=
"SetItem" type=
"bool" overloaded=
"no">
20453 <autodoc>SetItem(self, ListItem info) -
> bool
</autodoc>
20455 <param name=
"info" type=
"ListItem" default=
""/>
20458 <method name=
"SetStringItem" type=
"long" overloaded=
"no">
20459 <autodoc>SetStringItem(self, long index, int col, String label, int imageId=-
1) -
> long
</autodoc>
20461 <param name=
"index" type=
"long" default=
""/>
20462 <param name=
"col" type=
"int" default=
""/>
20463 <param name=
"label" type=
"String" default=
""/>
20464 <param name=
"imageId" type=
"int" default=
"-1"/>
20467 <method name=
"GetItemState" type=
"int" overloaded=
"no">
20468 <autodoc>GetItemState(self, long item, long stateMask) -
> int
</autodoc>
20470 <param name=
"item" type=
"long" default=
""/>
20471 <param name=
"stateMask" type=
"long" default=
""/>
20474 <method name=
"SetItemState" type=
"bool" overloaded=
"no">
20475 <autodoc>SetItemState(self, long item, long state, long stateMask) -
> bool
</autodoc>
20477 <param name=
"item" type=
"long" default=
""/>
20478 <param name=
"state" type=
"long" default=
""/>
20479 <param name=
"stateMask" type=
"long" default=
""/>
20482 <method name=
"SetItemImage" type=
"bool" overloaded=
"no">
20483 <autodoc>SetItemImage(self, long item, int image, int selImage) -
> bool
</autodoc>
20485 <param name=
"item" type=
"long" default=
""/>
20486 <param name=
"image" type=
"int" default=
""/>
20487 <param name=
"selImage" type=
"int" default=
""/>
20490 <method name=
"GetItemText" type=
"String" overloaded=
"no">
20491 <autodoc>GetItemText(self, long item) -
> String
</autodoc>
20493 <param name=
"item" type=
"long" default=
""/>
20496 <method name=
"SetItemText" type=
"" overloaded=
"no">
20497 <autodoc>SetItemText(self, long item, String str)
</autodoc>
20499 <param name=
"item" type=
"long" default=
""/>
20500 <param name=
"str" type=
"String" default=
""/>
20503 <method name=
"GetItemData" type=
"long" overloaded=
"no">
20504 <autodoc>GetItemData(self, long item) -
> long
</autodoc>
20506 <param name=
"item" type=
"long" default=
""/>
20509 <method name=
"SetItemData" type=
"bool" overloaded=
"no">
20510 <autodoc>SetItemData(self, long item, long data) -
> bool
</autodoc>
20512 <param name=
"item" type=
"long" default=
""/>
20513 <param name=
"data" type=
"long" default=
""/>
20516 <method name=
"GetItemPosition" type=
"Point" overloaded=
"no">
20517 <autodoc>GetItemPosition(self, long item) -
> Point
</autodoc>
20519 <param name=
"item" type=
"long" default=
""/>
20522 <method name=
"GetItemRect" type=
"Rect" overloaded=
"no">
20523 <autodoc>GetItemRect(self, long item, int code=LIST_RECT_BOUNDS) -
> Rect
</autodoc>
20525 <param name=
"item" type=
"long" default=
""/>
20526 <param name=
"code" type=
"int" default=
"wxLIST_RECT_BOUNDS"/>
20529 <method name=
"SetItemPosition" type=
"bool" overloaded=
"no">
20530 <autodoc>SetItemPosition(self, long item, Point pos) -
> bool
</autodoc>
20532 <param name=
"item" type=
"long" default=
""/>
20533 <param name=
"pos" type=
"Point" default=
""/>
20536 <method name=
"GetItemCount" type=
"int" overloaded=
"no">
20537 <autodoc>GetItemCount(self) -
> int
</autodoc>
20539 <method name=
"GetColumnCount" type=
"int" overloaded=
"no">
20540 <autodoc>GetColumnCount(self) -
> int
</autodoc>
20542 <method name=
"GetItemSpacing" type=
"Size" overloaded=
"no">
20543 <autodoc>GetItemSpacing(self) -
> Size
</autodoc>
20545 <method name=
"SetItemSpacing" type=
"" overloaded=
"no">
20546 <autodoc>SetItemSpacing(self, int spacing, bool isSmall=False)
</autodoc>
20548 <param name=
"spacing" type=
"int" default=
""/>
20549 <param name=
"isSmall" type=
"bool" default=
"False"/>
20552 <method name=
"GetSelectedItemCount" type=
"int" overloaded=
"no">
20553 <autodoc>GetSelectedItemCount(self) -
> int
</autodoc>
20555 <method name=
"GetTextColour" type=
"Colour" overloaded=
"no">
20556 <autodoc>GetTextColour(self) -
> Colour
</autodoc>
20558 <method name=
"SetTextColour" type=
"" overloaded=
"no">
20559 <autodoc>SetTextColour(self, Colour col)
</autodoc>
20561 <param name=
"col" type=
"Colour" default=
""/>
20564 <method name=
"GetTopItem" type=
"long" overloaded=
"no">
20565 <autodoc>GetTopItem(self) -
> long
</autodoc>
20567 <method name=
"SetSingleStyle" type=
"" overloaded=
"no">
20568 <autodoc>SetSingleStyle(self, long style, bool add=True)
</autodoc>
20570 <param name=
"style" type=
"long" default=
""/>
20571 <param name=
"add" type=
"bool" default=
"True"/>
20574 <method name=
"SetWindowStyleFlag" type=
"" overloaded=
"no">
20575 <autodoc>SetWindowStyleFlag(self, long style)
</autodoc>
20576 <docstring>Sets the style of the window. Please note that some styles cannot be
20577 changed after the window creation and that Refresh() might need to be
20578 called after changing the others for the change to take place
20579 immediately.
</docstring>
20581 <param name=
"style" type=
"long" default=
""/>
20584 <method name=
"GetNextItem" type=
"long" overloaded=
"no">
20585 <autodoc>GetNextItem(self, long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -
> long
</autodoc>
20587 <param name=
"item" type=
"long" default=
""/>
20588 <param name=
"geometry" type=
"int" default=
"wxLIST_NEXT_ALL"/>
20589 <param name=
"state" type=
"int" default=
"wxLIST_STATE_DONTCARE"/>
20592 <method name=
"GetImageList" type=
"ImageList" overloaded=
"no">
20593 <autodoc>GetImageList(self, int which) -
> ImageList
</autodoc>
20595 <param name=
"which" type=
"int" default=
""/>
20598 <method name=
"SetImageList" type=
"" overloaded=
"no">
20599 <autodoc>SetImageList(self, ImageList imageList, int which)
</autodoc>
20601 <param name=
"imageList" type=
"ImageList" default=
""/>
20602 <param name=
"which" type=
"int" default=
""/>
20605 <method name=
"AssignImageList" type=
"" overloaded=
"no">
20606 <autodoc>AssignImageList(self, ImageList imageList, int which)
</autodoc>
20608 <param name=
"imageList" type=
"ImageList" default=
""/>
20609 <param name=
"which" type=
"int" default=
""/>
20612 <method name=
"InReportView" type=
"bool" overloaded=
"no">
20613 <autodoc>InReportView(self) -
> bool
</autodoc>
20615 <method name=
"IsVirtual" type=
"bool" overloaded=
"no">
20616 <autodoc>IsVirtual(self) -
> bool
</autodoc>
20618 <method name=
"RefreshItem" type=
"" overloaded=
"no">
20619 <autodoc>RefreshItem(self, long item)
</autodoc>
20621 <param name=
"item" type=
"long" default=
""/>
20624 <method name=
"RefreshItems" type=
"" overloaded=
"no">
20625 <autodoc>RefreshItems(self, long itemFrom, long itemTo)
</autodoc>
20627 <param name=
"itemFrom" type=
"long" default=
""/>
20628 <param name=
"itemTo" type=
"long" default=
""/>
20631 <method name=
"Arrange" type=
"bool" overloaded=
"no">
20632 <autodoc>Arrange(self, int flag=LIST_ALIGN_DEFAULT) -
> bool
</autodoc>
20634 <param name=
"flag" type=
"int" default=
"wxLIST_ALIGN_DEFAULT"/>
20637 <method name=
"DeleteItem" type=
"bool" overloaded=
"no">
20638 <autodoc>DeleteItem(self, long item) -
> bool
</autodoc>
20640 <param name=
"item" type=
"long" default=
""/>
20643 <method name=
"DeleteAllItems" type=
"bool" overloaded=
"no">
20644 <autodoc>DeleteAllItems(self) -
> bool
</autodoc>
20646 <method name=
"DeleteColumn" type=
"bool" overloaded=
"no">
20647 <autodoc>DeleteColumn(self, int col) -
> bool
</autodoc>
20649 <param name=
"col" type=
"int" default=
""/>
20652 <method name=
"DeleteAllColumns" type=
"bool" overloaded=
"no">
20653 <autodoc>DeleteAllColumns(self) -
> bool
</autodoc>
20655 <method name=
"ClearAll" type=
"" overloaded=
"no">
20656 <autodoc>ClearAll(self)
</autodoc>
20658 <method name=
"EditLabel" type=
"" overloaded=
"no">
20659 <autodoc>EditLabel(self, long item)
</autodoc>
20661 <param name=
"item" type=
"long" default=
""/>
20664 <method name=
"EnsureVisible" type=
"bool" overloaded=
"no">
20665 <autodoc>EnsureVisible(self, long item) -
> bool
</autodoc>
20667 <param name=
"item" type=
"long" default=
""/>
20670 <method name=
"FindItem" type=
"long" overloaded=
"no">
20671 <autodoc>FindItem(self, long start, String str, bool partial=False) -
> long
</autodoc>
20673 <param name=
"start" type=
"long" default=
""/>
20674 <param name=
"str" type=
"String" default=
""/>
20675 <param name=
"partial" type=
"bool" default=
"False"/>
20678 <method name=
"FindItemData" type=
"long" overloaded=
"no">
20679 <autodoc>FindItemData(self, long start, long data) -
> long
</autodoc>
20681 <param name=
"start" type=
"long" default=
""/>
20682 <param name=
"data" type=
"long" default=
""/>
20685 <method name=
"FindItemAtPos" type=
"long" overloaded=
"no">
20686 <autodoc>FindItemAtPos(self, long start, Point pt, int direction) -
> long
</autodoc>
20688 <param name=
"start" type=
"long" default=
""/>
20689 <param name=
"pt" type=
"Point" default=
""/>
20690 <param name=
"direction" type=
"int" default=
""/>
20693 <method name=
"HitTest" type=
"long" overloaded=
"no">
20694 <autodoc>HitTest(Point point) -
> (item, where)
</autodoc>
20695 <docstring>Determines which item (if any) is at the specified point, giving
20696 in the second return value (see wxLIST_HITTEST_... flags.)
</docstring>
20698 <param name=
"point" type=
"Point" default=
""/>
20699 <param name=
"OUTPUT" type=
"int" default=
""/>
20702 <method name=
"InsertItem" type=
"long" overloaded=
"no">
20703 <autodoc>InsertItem(self, ListItem info) -
> long
</autodoc>
20705 <param name=
"info" type=
"ListItem" default=
""/>
20708 <method name=
"InsertStringItem" type=
"long" overloaded=
"no">
20709 <autodoc>InsertStringItem(self, long index, String label) -
> long
</autodoc>
20711 <param name=
"index" type=
"long" default=
""/>
20712 <param name=
"label" type=
"String" default=
""/>
20715 <method name=
"InsertImageItem" type=
"long" overloaded=
"no">
20716 <autodoc>InsertImageItem(self, long index, int imageIndex) -
> long
</autodoc>
20718 <param name=
"index" type=
"long" default=
""/>
20719 <param name=
"imageIndex" type=
"int" default=
""/>
20722 <method name=
"InsertImageStringItem" type=
"long" overloaded=
"no">
20723 <autodoc>InsertImageStringItem(self, long index, String label, int imageIndex) -
> long
</autodoc>
20725 <param name=
"index" type=
"long" default=
""/>
20726 <param name=
"label" type=
"String" default=
""/>
20727 <param name=
"imageIndex" type=
"int" default=
""/>
20730 <method name=
"InsertColumnInfo" type=
"long" overloaded=
"no">
20731 <autodoc>InsertColumnInfo(self, long col, ListItem info) -
> long
</autodoc>
20733 <param name=
"col" type=
"long" default=
""/>
20734 <param name=
"info" type=
"ListItem" default=
""/>
20737 <method name=
"InsertColumn" type=
"long" overloaded=
"no">
20738 <autodoc>InsertColumn(self, long col, String heading, int format=LIST_FORMAT_LEFT,
20739 int width=-
1) -
> long
</autodoc>
20741 <param name=
"col" type=
"long" default=
""/>
20742 <param name=
"heading" type=
"String" default=
""/>
20743 <param name=
"format" type=
"int" default=
"wxLIST_FORMAT_LEFT"/>
20744 <param name=
"width" type=
"int" default=
"-1"/>
20747 <method name=
"SetItemCount" type=
"" overloaded=
"no">
20748 <autodoc>SetItemCount(self, long count)
</autodoc>
20750 <param name=
"count" type=
"long" default=
""/>
20753 <method name=
"ScrollList" type=
"bool" overloaded=
"no">
20754 <autodoc>ScrollList(self, int dx, int dy) -
> bool
</autodoc>
20756 <param name=
"dx" type=
"int" default=
""/>
20757 <param name=
"dy" type=
"int" default=
""/>
20760 <method name=
"SetItemTextColour" type=
"" overloaded=
"no">
20761 <autodoc>SetItemTextColour(self, long item, Colour col)
</autodoc>
20763 <param name=
"item" type=
"long" default=
""/>
20764 <param name=
"col" type=
"Colour" default=
""/>
20767 <method name=
"GetItemTextColour" type=
"Colour" overloaded=
"no">
20768 <autodoc>GetItemTextColour(self, long item) -
> Colour
</autodoc>
20770 <param name=
"item" type=
"long" default=
""/>
20773 <method name=
"SetItemBackgroundColour" type=
"" overloaded=
"no">
20774 <autodoc>SetItemBackgroundColour(self, long item, Colour col)
</autodoc>
20776 <param name=
"item" type=
"long" default=
""/>
20777 <param name=
"col" type=
"Colour" default=
""/>
20780 <method name=
"GetItemBackgroundColour" type=
"Colour" overloaded=
"no">
20781 <autodoc>GetItemBackgroundColour(self, long item) -
> Colour
</autodoc>
20783 <param name=
"item" type=
"long" default=
""/>
20786 <method name=
"SortItems" type=
"bool" overloaded=
"no">
20787 <autodoc>SortItems(self, PyObject func) -
> bool
</autodoc>
20789 <param name=
"func" type=
"PyObject" default=
""/>
20792 <method name=
"GetMainWindow" type=
"Window" overloaded=
"no">
20793 <autodoc>GetMainWindow(self) -
> Window
</autodoc>
20795 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
20796 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
20797 <docstring>Get the default attributes for this class. This is useful if you want
20798 to use the same font or colour in your own control as in a standard
20799 control -- which is a much better idea than hard coding specific
20800 colours or fonts which might look completely out of place on the
20801 user's system, especially if it uses themes.
20803 The variant parameter is only relevant under Mac currently and is
20804 ignore under other platforms. Under Mac, it will change the size of
20805 the returned font. See `wx.Window.SetWindowVariant` for more about
20808 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
20813 #---------------------------------------------------------------------------
20815 <class name=
"ListView" oldname=
"wxListView" module=
"_controls">
20816 <baseclass name=
"ListCtrl"/>
20817 <constructor name=
"ListView" overloaded=
"no">
20818 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
20819 Size size=DefaultSize, long style=LC_REPORT,
20820 Validator validator=DefaultValidator, String name=ListCtrlNameStr) -
> ListView
</autodoc>
20822 <param name=
"parent" type=
"Window" default=
""/>
20823 <param name=
"id" type=
"int" default=
"-1"/>
20824 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
20825 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
20826 <param name=
"style" type=
"long" default=
"wxLC_REPORT"/>
20827 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
20828 <param name=
"name" type=
"String" default=
"wxPyListCtrlNameStr"/>
20831 <constructor name=
"PreListView" overloaded=
"no">
20832 <autodoc>PreListView() -
> ListView
</autodoc>
20834 <method name=
"Create" type=
"bool" overloaded=
"no">
20835 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
20836 Size size=DefaultSize, long style=LC_REPORT,
20837 Validator validator=DefaultValidator, String name=ListCtrlNameStr) -
> bool
</autodoc>
20838 <docstring>Do the
2nd phase and create the GUI control.
</docstring>
20840 <param name=
"parent" type=
"Window" default=
""/>
20841 <param name=
"id" type=
"int" default=
"-1"/>
20842 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
20843 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
20844 <param name=
"style" type=
"long" default=
"wxLC_REPORT"/>
20845 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
20846 <param name=
"name" type=
"String" default=
"wxPyListCtrlNameStr"/>
20849 <method name=
"Select" type=
"" overloaded=
"no">
20850 <autodoc>Select(self, long n, bool on=True)
</autodoc>
20852 <param name=
"n" type=
"long" default=
""/>
20853 <param name=
"on" type=
"bool" default=
"True"/>
20856 <method name=
"Focus" type=
"" overloaded=
"no">
20857 <autodoc>Focus(self, long index)
</autodoc>
20859 <param name=
"index" type=
"long" default=
""/>
20862 <method name=
"GetFocusedItem" type=
"long" overloaded=
"no">
20863 <autodoc>GetFocusedItem(self) -
> long
</autodoc>
20865 <method name=
"GetNextSelected" type=
"long" overloaded=
"no">
20866 <autodoc>GetNextSelected(self, long item) -
> long
</autodoc>
20868 <param name=
"item" type=
"long" default=
""/>
20871 <method name=
"GetFirstSelected" type=
"long" overloaded=
"no">
20872 <autodoc>GetFirstSelected(self) -
> long
</autodoc>
20874 <method name=
"IsSelected" type=
"bool" overloaded=
"no">
20875 <autodoc>IsSelected(self, long index) -
> bool
</autodoc>
20877 <param name=
"index" type=
"long" default=
""/>
20880 <method name=
"SetColumnImage" type=
"" overloaded=
"no">
20881 <autodoc>SetColumnImage(self, int col, int image)
</autodoc>
20883 <param name=
"col" type=
"int" default=
""/>
20884 <param name=
"image" type=
"int" default=
""/>
20887 <method name=
"ClearColumnImage" type=
"" overloaded=
"no">
20888 <autodoc>ClearColumnImage(self, int col)
</autodoc>
20890 <param name=
"col" type=
"int" default=
""/>
20895 #---------------------------------------------------------------------------
20898 #---------------------------------------------------------------------------
20900 <class name=
"TreeItemId" oldname=
"wxTreeItemId" module=
"_controls">
20901 <constructor name=
"TreeItemId" overloaded=
"no">
20902 <autodoc>__init__(self) -
> TreeItemId
</autodoc>
20904 <destructor name=
"~wxTreeItemId" overloaded=
"no">
20905 <autodoc>__del__(self)
</autodoc>
20907 <method name=
"IsOk" type=
"bool" overloaded=
"no">
20908 <autodoc>IsOk(self) -
> bool
</autodoc>
20910 <method name=
"__eq__" type=
"bool" overloaded=
"no">
20911 <autodoc>__eq__(self, TreeItemId other) -
> bool
</autodoc>
20913 <param name=
"other" type=
"TreeItemId" default=
""/>
20916 <method name=
"__ne__" type=
"bool" overloaded=
"no">
20917 <autodoc>__ne__(self, TreeItemId other) -
> bool
</autodoc>
20919 <param name=
"other" type=
"TreeItemId" default=
""/>
20922 <property name=
"m_pItem" type=
"" readonly=
"no"/>
20924 <class name=
"TreeItemData" oldname=
"wxPyTreeItemData" module=
"_controls">
20925 <constructor name=
"wxPyTreeItemData" overloaded=
"no">
20926 <autodoc>__init__(self, PyObject obj=None) -
> TreeItemData
</autodoc>
20928 <param name=
"obj" type=
"PyObject" default=
"NULL"/>
20931 <method name=
"GetData" type=
"PyObject" overloaded=
"no">
20932 <autodoc>GetData(self) -
> PyObject
</autodoc>
20934 <method name=
"SetData" type=
"" overloaded=
"no">
20935 <autodoc>SetData(self, PyObject obj)
</autodoc>
20937 <param name=
"obj" type=
"PyObject" default=
""/>
20940 <method name=
"GetId" type=
"TreeItemId" overloaded=
"no">
20941 <autodoc>GetId(self) -
> TreeItemId
</autodoc>
20943 <method name=
"SetId" type=
"" overloaded=
"no">
20944 <autodoc>SetId(self, TreeItemId id)
</autodoc>
20946 <param name=
"id" type=
"TreeItemId" default=
""/>
20949 <method name=
"Destroy" type=
"" overloaded=
"no">
20950 <autodoc>Destroy(self)
</autodoc>
20954 #---------------------------------------------------------------------------
20958 EVT_TREE_BEGIN_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG ,
1)
20959 EVT_TREE_BEGIN_RDRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG ,
1)
20960 EVT_TREE_BEGIN_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT ,
1)
20961 EVT_TREE_END_LABEL_EDIT = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_LABEL_EDIT ,
1)
20962 EVT_TREE_DELETE_ITEM = wx.PyEventBinder(wxEVT_COMMAND_TREE_DELETE_ITEM ,
1)
20963 EVT_TREE_GET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_GET_INFO ,
1)
20964 EVT_TREE_SET_INFO = wx.PyEventBinder(wxEVT_COMMAND_TREE_SET_INFO ,
1)
20965 EVT_TREE_ITEM_EXPANDED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDED ,
1)
20966 EVT_TREE_ITEM_EXPANDING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_EXPANDING ,
1)
20967 EVT_TREE_ITEM_COLLAPSED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSED ,
1)
20968 EVT_TREE_ITEM_COLLAPSING = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_COLLAPSING ,
1)
20969 EVT_TREE_SEL_CHANGED = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGED ,
1)
20970 EVT_TREE_SEL_CHANGING = wx.PyEventBinder(wxEVT_COMMAND_TREE_SEL_CHANGING ,
1)
20971 EVT_TREE_KEY_DOWN = wx.PyEventBinder(wxEVT_COMMAND_TREE_KEY_DOWN ,
1)
20972 EVT_TREE_ITEM_ACTIVATED = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_ACTIVATED ,
1)
20973 EVT_TREE_ITEM_RIGHT_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_RIGHT_CLICK ,
1)
20974 EVT_TREE_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLICK,
1)
20975 EVT_TREE_END_DRAG = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG ,
1)
20976 EVT_TREE_STATE_IMAGE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK,
1)
20977 EVT_TREE_ITEM_GETTOOLTIP = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP,
1)
20979 <class name=
"TreeEvent" oldname=
"wxTreeEvent" module=
"_controls">
20980 <baseclass name=
"NotifyEvent"/>
20981 <constructor name=
"TreeEvent" overloaded=
"no">
20982 <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=
0) -
> TreeEvent
</autodoc>
20984 <param name=
"commandType" type=
"wxEventType" default=
"wxEVT_NULL"/>
20985 <param name=
"id" type=
"int" default=
"0"/>
20988 <method name=
"GetItem" type=
"TreeItemId" overloaded=
"no">
20989 <autodoc>GetItem(self) -
> TreeItemId
</autodoc>
20991 <method name=
"SetItem" type=
"" overloaded=
"no">
20992 <autodoc>SetItem(self, TreeItemId item)
</autodoc>
20994 <param name=
"item" type=
"TreeItemId" default=
""/>
20997 <method name=
"GetOldItem" type=
"TreeItemId" overloaded=
"no">
20998 <autodoc>GetOldItem(self) -
> TreeItemId
</autodoc>
21000 <method name=
"SetOldItem" type=
"" overloaded=
"no">
21001 <autodoc>SetOldItem(self, TreeItemId item)
</autodoc>
21003 <param name=
"item" type=
"TreeItemId" default=
""/>
21006 <method name=
"GetPoint" type=
"Point" overloaded=
"no">
21007 <autodoc>GetPoint(self) -
> Point
</autodoc>
21009 <method name=
"SetPoint" type=
"" overloaded=
"no">
21010 <autodoc>SetPoint(self, Point pt)
</autodoc>
21012 <param name=
"pt" type=
"Point" default=
""/>
21015 <method name=
"GetKeyEvent" type=
"KeyEvent" overloaded=
"no">
21016 <autodoc>GetKeyEvent(self) -
> KeyEvent
</autodoc>
21018 <method name=
"GetKeyCode" type=
"int" overloaded=
"no">
21019 <autodoc>GetKeyCode(self) -
> int
</autodoc>
21021 <method name=
"SetKeyEvent" type=
"" overloaded=
"no">
21022 <autodoc>SetKeyEvent(self, KeyEvent evt)
</autodoc>
21024 <param name=
"evt" type=
"KeyEvent" default=
""/>
21027 <method name=
"GetLabel" type=
"String" overloaded=
"no">
21028 <autodoc>GetLabel(self) -
> String
</autodoc>
21030 <method name=
"SetLabel" type=
"" overloaded=
"no">
21031 <autodoc>SetLabel(self, String label)
</autodoc>
21033 <param name=
"label" type=
"String" default=
""/>
21036 <method name=
"IsEditCancelled" type=
"bool" overloaded=
"no">
21037 <autodoc>IsEditCancelled(self) -
> bool
</autodoc>
21039 <method name=
"SetEditCanceled" type=
"" overloaded=
"no">
21040 <autodoc>SetEditCanceled(self, bool editCancelled)
</autodoc>
21042 <param name=
"editCancelled" type=
"bool" default=
""/>
21045 <method name=
"SetToolTip" type=
"" overloaded=
"no">
21046 <autodoc>SetToolTip(self, String toolTip)
</autodoc>
21048 <param name=
"toolTip" type=
"String" default=
""/>
21053 #---------------------------------------------------------------------------
21055 <class name=
"TreeCtrl" oldname=
"wxPyTreeCtrl" module=
"_controls">
21056 <baseclass name=
"Control"/>
21057 <constructor name=
"wxPyTreeCtrl" overloaded=
"no">
21058 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
21059 Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
21060 Validator validator=DefaultValidator,
21061 String name=TreeCtrlNameStr) -
> TreeCtrl
</autodoc>
21063 <param name=
"parent" type=
"Window" default=
""/>
21064 <param name=
"id" type=
"int" default=
"-1"/>
21065 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
21066 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
21067 <param name=
"style" type=
"long" default=
"wxTR_DEFAULT_STYLE"/>
21068 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
21069 <param name=
"name" type=
"String" default=
"wxPyTreeCtrlNameStr"/>
21072 <constructor name=
"PreTreeCtrl" overloaded=
"no">
21073 <autodoc>PreTreeCtrl() -
> TreeCtrl
</autodoc>
21075 <method name=
"Create" type=
"bool" overloaded=
"no">
21076 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
21077 Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
21078 Validator validator=DefaultValidator,
21079 String name=TreeCtrlNameStr) -
> bool
</autodoc>
21080 <docstring>Do the
2nd phase and create the GUI control.
</docstring>
21082 <param name=
"parent" type=
"Window" default=
""/>
21083 <param name=
"id" type=
"int" default=
"-1"/>
21084 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
21085 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
21086 <param name=
"style" type=
"long" default=
"wxTR_DEFAULT_STYLE"/>
21087 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
21088 <param name=
"name" type=
"String" default=
"wxPyTreeCtrlNameStr"/>
21091 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
21092 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
21094 <param name=
"self" type=
"PyObject" default=
""/>
21095 <param name=
"_class" type=
"PyObject" default=
""/>
21098 <method name=
"GetCount" type=
"size_t" overloaded=
"no">
21099 <autodoc>GetCount(self) -
> size_t
</autodoc>
21101 <method name=
"GetIndent" type=
"unsigned int" overloaded=
"no">
21102 <autodoc>GetIndent(self) -
> unsigned int
</autodoc>
21104 <method name=
"SetIndent" type=
"" overloaded=
"no">
21105 <autodoc>SetIndent(self, unsigned int indent)
</autodoc>
21107 <param name=
"indent" type=
"unsigned int" default=
""/>
21110 <method name=
"GetSpacing" type=
"unsigned int" overloaded=
"no">
21111 <autodoc>GetSpacing(self) -
> unsigned int
</autodoc>
21113 <method name=
"SetSpacing" type=
"" overloaded=
"no">
21114 <autodoc>SetSpacing(self, unsigned int spacing)
</autodoc>
21116 <param name=
"spacing" type=
"unsigned int" default=
""/>
21119 <method name=
"GetImageList" type=
"ImageList" overloaded=
"no">
21120 <autodoc>GetImageList(self) -
> ImageList
</autodoc>
21122 <method name=
"GetStateImageList" type=
"ImageList" overloaded=
"no">
21123 <autodoc>GetStateImageList(self) -
> ImageList
</autodoc>
21125 <method name=
"SetImageList" type=
"" overloaded=
"no">
21126 <autodoc>SetImageList(self, ImageList imageList)
</autodoc>
21128 <param name=
"imageList" type=
"ImageList" default=
""/>
21131 <method name=
"SetStateImageList" type=
"" overloaded=
"no">
21132 <autodoc>SetStateImageList(self, ImageList imageList)
</autodoc>
21134 <param name=
"imageList" type=
"ImageList" default=
""/>
21137 <method name=
"AssignImageList" type=
"" overloaded=
"no">
21138 <autodoc>AssignImageList(self, ImageList imageList)
</autodoc>
21140 <param name=
"imageList" type=
"ImageList" default=
""/>
21143 <method name=
"AssignStateImageList" type=
"" overloaded=
"no">
21144 <autodoc>AssignStateImageList(self, ImageList imageList)
</autodoc>
21146 <param name=
"imageList" type=
"ImageList" default=
""/>
21149 <method name=
"GetItemText" type=
"String" overloaded=
"no">
21150 <autodoc>GetItemText(self, TreeItemId item) -
> String
</autodoc>
21152 <param name=
"item" type=
"TreeItemId" default=
""/>
21155 <method name=
"GetItemImage" type=
"int" overloaded=
"no">
21156 <autodoc>GetItemImage(self, TreeItemId item, int which=TreeItemIcon_Normal) -
> int
</autodoc>
21158 <param name=
"item" type=
"TreeItemId" default=
""/>
21159 <param name=
"which" type=
"wxTreeItemIcon" default=
"wxTreeItemIcon_Normal"/>
21162 <method name=
"GetItemData" type=
"TreeItemData" overloaded=
"no">
21163 <autodoc>GetItemData(self, TreeItemId item) -
> TreeItemData
</autodoc>
21165 <param name=
"item" type=
"TreeItemId" default=
""/>
21168 <method name=
"GetItemPyData" type=
"PyObject" overloaded=
"no">
21169 <autodoc>GetItemPyData(self, TreeItemId item) -
> PyObject
</autodoc>
21171 <param name=
"item" type=
"TreeItemId" default=
""/>
21174 <method name=
"GetItemTextColour" type=
"Colour" overloaded=
"no">
21175 <autodoc>GetItemTextColour(self, TreeItemId item) -
> Colour
</autodoc>
21177 <param name=
"item" type=
"TreeItemId" default=
""/>
21180 <method name=
"GetItemBackgroundColour" type=
"Colour" overloaded=
"no">
21181 <autodoc>GetItemBackgroundColour(self, TreeItemId item) -
> Colour
</autodoc>
21183 <param name=
"item" type=
"TreeItemId" default=
""/>
21186 <method name=
"GetItemFont" type=
"Font" overloaded=
"no">
21187 <autodoc>GetItemFont(self, TreeItemId item) -
> Font
</autodoc>
21189 <param name=
"item" type=
"TreeItemId" default=
""/>
21192 <method name=
"SetItemText" type=
"" overloaded=
"no">
21193 <autodoc>SetItemText(self, TreeItemId item, String text)
</autodoc>
21195 <param name=
"item" type=
"TreeItemId" default=
""/>
21196 <param name=
"text" type=
"String" default=
""/>
21199 <method name=
"SetItemImage" type=
"" overloaded=
"no">
21200 <autodoc>SetItemImage(self, TreeItemId item, int image, int which=TreeItemIcon_Normal)
</autodoc>
21202 <param name=
"item" type=
"TreeItemId" default=
""/>
21203 <param name=
"image" type=
"int" default=
""/>
21204 <param name=
"which" type=
"wxTreeItemIcon" default=
"wxTreeItemIcon_Normal"/>
21207 <method name=
"SetItemData" type=
"" overloaded=
"no">
21208 <autodoc>SetItemData(self, TreeItemId item, TreeItemData data)
</autodoc>
21210 <param name=
"item" type=
"TreeItemId" default=
""/>
21211 <param name=
"data" type=
"TreeItemData" default=
""/>
21214 <method name=
"SetItemPyData" type=
"" overloaded=
"no">
21215 <autodoc>SetItemPyData(self, TreeItemId item, PyObject obj)
</autodoc>
21217 <param name=
"item" type=
"TreeItemId" default=
""/>
21218 <param name=
"obj" type=
"PyObject" default=
""/>
21221 <method name=
"SetItemHasChildren" type=
"" overloaded=
"no">
21222 <autodoc>SetItemHasChildren(self, TreeItemId item, bool has=True)
</autodoc>
21224 <param name=
"item" type=
"TreeItemId" default=
""/>
21225 <param name=
"has" type=
"bool" default=
"True"/>
21228 <method name=
"SetItemBold" type=
"" overloaded=
"no">
21229 <autodoc>SetItemBold(self, TreeItemId item, bool bold=True)
</autodoc>
21231 <param name=
"item" type=
"TreeItemId" default=
""/>
21232 <param name=
"bold" type=
"bool" default=
"True"/>
21235 <method name=
"SetItemTextColour" type=
"" overloaded=
"no">
21236 <autodoc>SetItemTextColour(self, TreeItemId item, Colour col)
</autodoc>
21238 <param name=
"item" type=
"TreeItemId" default=
""/>
21239 <param name=
"col" type=
"Colour" default=
""/>
21242 <method name=
"SetItemBackgroundColour" type=
"" overloaded=
"no">
21243 <autodoc>SetItemBackgroundColour(self, TreeItemId item, Colour col)
</autodoc>
21245 <param name=
"item" type=
"TreeItemId" default=
""/>
21246 <param name=
"col" type=
"Colour" default=
""/>
21249 <method name=
"SetItemFont" type=
"" overloaded=
"no">
21250 <autodoc>SetItemFont(self, TreeItemId item, Font font)
</autodoc>
21252 <param name=
"item" type=
"TreeItemId" default=
""/>
21253 <param name=
"font" type=
"Font" default=
""/>
21256 <method name=
"IsVisible" type=
"bool" overloaded=
"no">
21257 <autodoc>IsVisible(self, TreeItemId item) -
> bool
</autodoc>
21259 <param name=
"item" type=
"TreeItemId" default=
""/>
21262 <method name=
"ItemHasChildren" type=
"bool" overloaded=
"no">
21263 <autodoc>ItemHasChildren(self, TreeItemId item) -
> bool
</autodoc>
21265 <param name=
"item" type=
"TreeItemId" default=
""/>
21268 <method name=
"IsExpanded" type=
"bool" overloaded=
"no">
21269 <autodoc>IsExpanded(self, TreeItemId item) -
> bool
</autodoc>
21271 <param name=
"item" type=
"TreeItemId" default=
""/>
21274 <method name=
"IsSelected" type=
"bool" overloaded=
"no">
21275 <autodoc>IsSelected(self, TreeItemId item) -
> bool
</autodoc>
21277 <param name=
"item" type=
"TreeItemId" default=
""/>
21280 <method name=
"IsBold" type=
"bool" overloaded=
"no">
21281 <autodoc>IsBold(self, TreeItemId item) -
> bool
</autodoc>
21283 <param name=
"item" type=
"TreeItemId" default=
""/>
21286 <method name=
"GetChildrenCount" type=
"size_t" overloaded=
"no">
21287 <autodoc>GetChildrenCount(self, TreeItemId item, bool recursively=True) -
> size_t
</autodoc>
21289 <param name=
"item" type=
"TreeItemId" default=
""/>
21290 <param name=
"recursively" type=
"bool" default=
"True"/>
21293 <method name=
"GetRootItem" type=
"TreeItemId" overloaded=
"no">
21294 <autodoc>GetRootItem(self) -
> TreeItemId
</autodoc>
21296 <method name=
"GetSelection" type=
"TreeItemId" overloaded=
"no">
21297 <autodoc>GetSelection(self) -
> TreeItemId
</autodoc>
21299 <method name=
"GetSelections" type=
"PyObject" overloaded=
"no">
21300 <autodoc>GetSelections(self) -
> PyObject
</autodoc>
21302 <method name=
"GetItemParent" type=
"TreeItemId" overloaded=
"no">
21303 <autodoc>GetItemParent(self, TreeItemId item) -
> TreeItemId
</autodoc>
21305 <param name=
"item" type=
"TreeItemId" default=
""/>
21308 <method name=
"GetFirstChild" type=
"PyObject" overloaded=
"no">
21309 <autodoc>GetFirstChild(self, TreeItemId item) -
> PyObject
</autodoc>
21311 <param name=
"item" type=
"TreeItemId" default=
""/>
21314 <method name=
"GetNextChild" type=
"PyObject" overloaded=
"no">
21315 <autodoc>GetNextChild(self, TreeItemId item, void cookie) -
> PyObject
</autodoc>
21317 <param name=
"item" type=
"TreeItemId" default=
""/>
21318 <param name=
"cookie" type=
"" default=
""/>
21321 <method name=
"GetLastChild" type=
"TreeItemId" overloaded=
"no">
21322 <autodoc>GetLastChild(self, TreeItemId item) -
> TreeItemId
</autodoc>
21324 <param name=
"item" type=
"TreeItemId" default=
""/>
21327 <method name=
"GetNextSibling" type=
"TreeItemId" overloaded=
"no">
21328 <autodoc>GetNextSibling(self, TreeItemId item) -
> TreeItemId
</autodoc>
21330 <param name=
"item" type=
"TreeItemId" default=
""/>
21333 <method name=
"GetPrevSibling" type=
"TreeItemId" overloaded=
"no">
21334 <autodoc>GetPrevSibling(self, TreeItemId item) -
> TreeItemId
</autodoc>
21336 <param name=
"item" type=
"TreeItemId" default=
""/>
21339 <method name=
"GetFirstVisibleItem" type=
"TreeItemId" overloaded=
"no">
21340 <autodoc>GetFirstVisibleItem(self) -
> TreeItemId
</autodoc>
21342 <method name=
"GetNextVisible" type=
"TreeItemId" overloaded=
"no">
21343 <autodoc>GetNextVisible(self, TreeItemId item) -
> TreeItemId
</autodoc>
21345 <param name=
"item" type=
"TreeItemId" default=
""/>
21348 <method name=
"GetPrevVisible" type=
"TreeItemId" overloaded=
"no">
21349 <autodoc>GetPrevVisible(self, TreeItemId item) -
> TreeItemId
</autodoc>
21351 <param name=
"item" type=
"TreeItemId" default=
""/>
21354 <method name=
"AddRoot" type=
"TreeItemId" overloaded=
"no">
21355 <autodoc>AddRoot(self, String text, int image=-
1, int selectedImage=-
1, TreeItemData data=None) -
> TreeItemId
</autodoc>
21357 <param name=
"text" type=
"String" default=
""/>
21358 <param name=
"image" type=
"int" default=
"-1"/>
21359 <param name=
"selectedImage" type=
"int" default=
"-1"/>
21360 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
21363 <method name=
"PrependItem" type=
"TreeItemId" overloaded=
"no">
21364 <autodoc>PrependItem(self, TreeItemId parent, String text, int image=-
1, int selectedImage=-
1,
21365 TreeItemData data=None) -
> TreeItemId
</autodoc>
21367 <param name=
"parent" type=
"TreeItemId" default=
""/>
21368 <param name=
"text" type=
"String" default=
""/>
21369 <param name=
"image" type=
"int" default=
"-1"/>
21370 <param name=
"selectedImage" type=
"int" default=
"-1"/>
21371 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
21374 <method name=
"InsertItem" type=
"TreeItemId" overloaded=
"no">
21375 <autodoc>InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text,
21376 int image=-
1, int selectedImage=-
1, TreeItemData data=None) -
> TreeItemId
</autodoc>
21378 <param name=
"parent" type=
"TreeItemId" default=
""/>
21379 <param name=
"idPrevious" type=
"TreeItemId" default=
""/>
21380 <param name=
"text" type=
"String" default=
""/>
21381 <param name=
"image" type=
"int" default=
"-1"/>
21382 <param name=
"selectedImage" type=
"int" default=
"-1"/>
21383 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
21386 <method name=
"InsertItemBefore" type=
"TreeItemId" overloaded=
"no">
21387 <autodoc>InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-
1,
21388 int selectedImage=-
1, TreeItemData data=None) -
> TreeItemId
</autodoc>
21390 <param name=
"parent" type=
"TreeItemId" default=
""/>
21391 <param name=
"index" type=
"size_t" default=
""/>
21392 <param name=
"text" type=
"String" default=
""/>
21393 <param name=
"image" type=
"int" default=
"-1"/>
21394 <param name=
"selectedImage" type=
"int" default=
"-1"/>
21395 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
21398 <method name=
"AppendItem" type=
"TreeItemId" overloaded=
"no">
21399 <autodoc>AppendItem(self, TreeItemId parent, String text, int image=-
1, int selectedImage=-
1,
21400 TreeItemData data=None) -
> TreeItemId
</autodoc>
21402 <param name=
"parent" type=
"TreeItemId" default=
""/>
21403 <param name=
"text" type=
"String" default=
""/>
21404 <param name=
"image" type=
"int" default=
"-1"/>
21405 <param name=
"selectedImage" type=
"int" default=
"-1"/>
21406 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
21409 <method name=
"Delete" type=
"" overloaded=
"no">
21410 <autodoc>Delete(self, TreeItemId item)
</autodoc>
21412 <param name=
"item" type=
"TreeItemId" default=
""/>
21415 <method name=
"DeleteChildren" type=
"" overloaded=
"no">
21416 <autodoc>DeleteChildren(self, TreeItemId item)
</autodoc>
21418 <param name=
"item" type=
"TreeItemId" default=
""/>
21421 <method name=
"DeleteAllItems" type=
"" overloaded=
"no">
21422 <autodoc>DeleteAllItems(self)
</autodoc>
21424 <method name=
"Expand" type=
"" overloaded=
"no">
21425 <autodoc>Expand(self, TreeItemId item)
</autodoc>
21427 <param name=
"item" type=
"TreeItemId" default=
""/>
21430 <method name=
"Collapse" type=
"" overloaded=
"no">
21431 <autodoc>Collapse(self, TreeItemId item)
</autodoc>
21433 <param name=
"item" type=
"TreeItemId" default=
""/>
21436 <method name=
"CollapseAndReset" type=
"" overloaded=
"no">
21437 <autodoc>CollapseAndReset(self, TreeItemId item)
</autodoc>
21439 <param name=
"item" type=
"TreeItemId" default=
""/>
21442 <method name=
"Toggle" type=
"" overloaded=
"no">
21443 <autodoc>Toggle(self, TreeItemId item)
</autodoc>
21445 <param name=
"item" type=
"TreeItemId" default=
""/>
21448 <method name=
"Unselect" type=
"" overloaded=
"no">
21449 <autodoc>Unselect(self)
</autodoc>
21451 <method name=
"UnselectItem" type=
"" overloaded=
"no">
21452 <autodoc>UnselectItem(self, TreeItemId item)
</autodoc>
21454 <param name=
"item" type=
"TreeItemId" default=
""/>
21457 <method name=
"UnselectAll" type=
"" overloaded=
"no">
21458 <autodoc>UnselectAll(self)
</autodoc>
21460 <method name=
"SelectItem" type=
"" overloaded=
"no">
21461 <autodoc>SelectItem(self, TreeItemId item, bool select=True)
</autodoc>
21463 <param name=
"item" type=
"TreeItemId" default=
""/>
21464 <param name=
"select" type=
"bool" default=
"True"/>
21467 <method name=
"ToggleItemSelection" type=
"" overloaded=
"no">
21468 <autodoc>ToggleItemSelection(self, TreeItemId item)
</autodoc>
21470 <param name=
"item" type=
"TreeItemId" default=
""/>
21473 <method name=
"EnsureVisible" type=
"" overloaded=
"no">
21474 <autodoc>EnsureVisible(self, TreeItemId item)
</autodoc>
21476 <param name=
"item" type=
"TreeItemId" default=
""/>
21479 <method name=
"ScrollTo" type=
"" overloaded=
"no">
21480 <autodoc>ScrollTo(self, TreeItemId item)
</autodoc>
21482 <param name=
"item" type=
"TreeItemId" default=
""/>
21485 <method name=
"EditLabel" type=
"" overloaded=
"no">
21486 <autodoc>EditLabel(self, TreeItemId item)
</autodoc>
21488 <param name=
"item" type=
"TreeItemId" default=
""/>
21491 <method name=
"GetEditControl" type=
"TextCtrl" overloaded=
"no">
21492 <autodoc>GetEditControl(self) -
> TextCtrl
</autodoc>
21494 <method name=
"SortChildren" type=
"" overloaded=
"no">
21495 <autodoc>SortChildren(self, TreeItemId item)
</autodoc>
21497 <param name=
"item" type=
"TreeItemId" default=
""/>
21500 <method name=
"HitTest" type=
"TreeItemId" overloaded=
"no">
21501 <autodoc>HitTest(Point point) -
> (item, where)
</autodoc>
21502 <docstring>Determine which item (if any) belongs the given point. The coordinates
21503 specified are relative to the client area of tree ctrl and the where return
21504 value is set to a bitmask of wxTREE_HITTEST_xxx constants.
21507 <param name=
"point" type=
"Point" default=
""/>
21508 <param name=
"OUTPUT" type=
"int" default=
""/>
21511 <method name=
"GetBoundingRect" type=
"PyObject" overloaded=
"no">
21512 <autodoc>GetBoundingRect(self, TreeItemId item, bool textOnly=False) -
> PyObject
</autodoc>
21514 <param name=
"item" type=
"TreeItemId" default=
""/>
21515 <param name=
"textOnly" type=
"bool" default=
"False"/>
21518 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
21519 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
21520 <docstring>Get the default attributes for this class. This is useful if you want
21521 to use the same font or colour in your own control as in a standard
21522 control -- which is a much better idea than hard coding specific
21523 colours or fonts which might look completely out of place on the
21524 user's system, especially if it uses themes.
21526 The variant parameter is only relevant under Mac currently and is
21527 ignore under other platforms. Under Mac, it will change the size of
21528 the returned font. See `wx.Window.SetWindowVariant` for more about
21531 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
21536 #---------------------------------------------------------------------------
21538 <class name=
"GenericDirCtrl" oldname=
"wxGenericDirCtrl" module=
"_controls">
21539 <baseclass name=
"Control"/>
21540 <constructor name=
"GenericDirCtrl" overloaded=
"no">
21541 <autodoc>__init__(self, Window parent, int id=-
1, String dir=DirDialogDefaultFolderStr,
21542 Point pos=DefaultPosition, Size size=DefaultSize,
21543 long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
21544 String filter=EmptyString,
21545 int defaultFilter=
0, String name=TreeCtrlNameStr) -
> GenericDirCtrl
</autodoc>
21547 <param name=
"parent" type=
"Window" default=
""/>
21548 <param name=
"id" type=
"int" default=
"-1"/>
21549 <param name=
"dir" type=
"String" default=
"wxPyDirDialogDefaultFolderStr"/>
21550 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
21551 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
21552 <param name=
"style" type=
"long" default=
"wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER"/>
21553 <param name=
"filter" type=
"String" default=
"wxPyEmptyString"/>
21554 <param name=
"defaultFilter" type=
"int" default=
"0"/>
21555 <param name=
"name" type=
"String" default=
"wxPyTreeCtrlNameStr"/>
21558 <constructor name=
"PreGenericDirCtrl" overloaded=
"no">
21559 <autodoc>PreGenericDirCtrl() -
> GenericDirCtrl
</autodoc>
21561 <method name=
"Create" type=
"bool" overloaded=
"no">
21562 <autodoc>Create(self, Window parent, int id=-
1, String dir=DirDialogDefaultFolderStr,
21563 Point pos=DefaultPosition, Size size=DefaultSize,
21564 long style=wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
21565 String filter=EmptyString,
21566 int defaultFilter=
0, String name=TreeCtrlNameStr) -
> bool
</autodoc>
21568 <param name=
"parent" type=
"Window" default=
""/>
21569 <param name=
"id" type=
"int" default=
"-1"/>
21570 <param name=
"dir" type=
"String" default=
"wxPyDirDialogDefaultFolderStr"/>
21571 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
21572 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
21573 <param name=
"style" type=
"long" default=
"wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER"/>
21574 <param name=
"filter" type=
"String" default=
"wxPyEmptyString"/>
21575 <param name=
"defaultFilter" type=
"int" default=
"0"/>
21576 <param name=
"name" type=
"String" default=
"wxPyTreeCtrlNameStr"/>
21579 <method name=
"ExpandPath" type=
"bool" overloaded=
"no">
21580 <autodoc>ExpandPath(self, String path) -
> bool
</autodoc>
21582 <param name=
"path" type=
"String" default=
""/>
21585 <method name=
"GetDefaultPath" type=
"String" overloaded=
"no">
21586 <autodoc>GetDefaultPath(self) -
> String
</autodoc>
21588 <method name=
"SetDefaultPath" type=
"" overloaded=
"no">
21589 <autodoc>SetDefaultPath(self, String path)
</autodoc>
21591 <param name=
"path" type=
"String" default=
""/>
21594 <method name=
"GetPath" type=
"String" overloaded=
"no">
21595 <autodoc>GetPath(self) -
> String
</autodoc>
21597 <method name=
"GetFilePath" type=
"String" overloaded=
"no">
21598 <autodoc>GetFilePath(self) -
> String
</autodoc>
21600 <method name=
"SetPath" type=
"" overloaded=
"no">
21601 <autodoc>SetPath(self, String path)
</autodoc>
21603 <param name=
"path" type=
"String" default=
""/>
21606 <method name=
"ShowHidden" type=
"" overloaded=
"no">
21607 <autodoc>ShowHidden(self, bool show)
</autodoc>
21609 <param name=
"show" type=
"bool" default=
""/>
21612 <method name=
"GetShowHidden" type=
"bool" overloaded=
"no">
21613 <autodoc>GetShowHidden(self) -
> bool
</autodoc>
21615 <method name=
"GetFilter" type=
"String" overloaded=
"no">
21616 <autodoc>GetFilter(self) -
> String
</autodoc>
21618 <method name=
"SetFilter" type=
"" overloaded=
"no">
21619 <autodoc>SetFilter(self, String filter)
</autodoc>
21621 <param name=
"filter" type=
"String" default=
""/>
21624 <method name=
"GetFilterIndex" type=
"int" overloaded=
"no">
21625 <autodoc>GetFilterIndex(self) -
> int
</autodoc>
21627 <method name=
"SetFilterIndex" type=
"" overloaded=
"no">
21628 <autodoc>SetFilterIndex(self, int n)
</autodoc>
21630 <param name=
"n" type=
"int" default=
""/>
21633 <method name=
"GetRootId" type=
"TreeItemId" overloaded=
"no">
21634 <autodoc>GetRootId(self) -
> TreeItemId
</autodoc>
21636 <method name=
"GetTreeCtrl" type=
"TreeCtrl" overloaded=
"no">
21637 <autodoc>GetTreeCtrl(self) -
> TreeCtrl
</autodoc>
21639 <method name=
"GetFilterListCtrl" type=
"wxDirFilterListCtrl" overloaded=
"no">
21640 <autodoc>GetFilterListCtrl(self) -
> DirFilterListCtrl
</autodoc>
21642 <method name=
"FindChild" type=
"TreeItemId" overloaded=
"no">
21643 <autodoc>FindChild(wxTreeItemId parentId, wxString path) -
> (item, done)
</autodoc>
21644 <docstring>Find the child that matches the first part of 'path'. E.g. if a child
21645 path is "/usr" and 'path' is "/usr/include" then the child for
21646 /usr is returned. If the path string has been used (we're at the
21647 leaf), done is set to True.
21650 <param name=
"parentId" type=
"TreeItemId" default=
""/>
21651 <param name=
"path" type=
"String" default=
""/>
21652 <param name=
"OUTPUT" type=
"bool" default=
""/>
21655 <method name=
"DoResize" type=
"" overloaded=
"no">
21656 <autodoc>DoResize(self)
</autodoc>
21658 <method name=
"ReCreateTree" type=
"" overloaded=
"no">
21659 <autodoc>ReCreateTree(self)
</autodoc>
21662 <class name=
"DirFilterListCtrl" oldname=
"wxDirFilterListCtrl" module=
"_controls">
21663 <baseclass name=
"Choice"/>
21664 <constructor name=
"DirFilterListCtrl" overloaded=
"no">
21665 <autodoc>__init__(self, GenericDirCtrl parent, int id=-
1, Point pos=DefaultPosition,
21666 Size size=DefaultSize, long style=
0) -
> DirFilterListCtrl
</autodoc>
21668 <param name=
"parent" type=
"GenericDirCtrl" default=
""/>
21669 <param name=
"id" type=
"int" default=
"-1"/>
21670 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
21671 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
21672 <param name=
"style" type=
"long" default=
"0"/>
21675 <constructor name=
"PreDirFilterListCtrl" overloaded=
"no">
21676 <autodoc>PreDirFilterListCtrl() -
> DirFilterListCtrl
</autodoc>
21678 <method name=
"Create" type=
"bool" overloaded=
"no">
21679 <autodoc>Create(self, GenericDirCtrl parent, int id=-
1, Point pos=DefaultPosition,
21680 Size size=DefaultSize, long style=
0) -
> bool
</autodoc>
21682 <param name=
"parent" type=
"GenericDirCtrl" default=
""/>
21683 <param name=
"id" type=
"int" default=
"-1"/>
21684 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
21685 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
21686 <param name=
"style" type=
"long" default=
"0"/>
21689 <method name=
"FillFilterList" type=
"" overloaded=
"no">
21690 <autodoc>FillFilterList(self, String filter, int defaultFilter)
</autodoc>
21692 <param name=
"filter" type=
"String" default=
""/>
21693 <param name=
"defaultFilter" type=
"int" default=
""/>
21698 #---------------------------------------------------------------------------
21700 <class name=
"PyControl" oldname=
"wxPyControl" module=
"_controls">
21701 <baseclass name=
"Control"/>
21702 <constructor name=
"PyControl" overloaded=
"no">
21703 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
21704 Size size=DefaultSize, long style=
0, Validator validator=DefaultValidator,
21705 String name=ControlNameStr) -
> PyControl
</autodoc>
21707 <param name=
"parent" type=
"Window" default=
""/>
21708 <param name=
"id" type=
"int" default=
"-1"/>
21709 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
21710 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
21711 <param name=
"style" type=
"long" default=
"0"/>
21712 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
21713 <param name=
"name" type=
"String" default=
"wxPyControlNameStr"/>
21716 <constructor name=
"PrePyControl" overloaded=
"no">
21717 <autodoc>PrePyControl() -
> PyControl
</autodoc>
21719 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
21720 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
21722 <param name=
"self" type=
"PyObject" default=
""/>
21723 <param name=
"_class" type=
"PyObject" default=
""/>
21726 <method name=
"SetBestSize" type=
"" overloaded=
"no">
21727 <autodoc>SetBestSize(self, Size size)
</autodoc>
21729 <param name=
"size" type=
"Size" default=
""/>
21732 <method name=
"base_DoMoveWindow" type=
"" overloaded=
"no">
21733 <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)
</autodoc>
21735 <param name=
"x" type=
"int" default=
""/>
21736 <param name=
"y" type=
"int" default=
""/>
21737 <param name=
"width" type=
"int" default=
""/>
21738 <param name=
"height" type=
"int" default=
""/>
21741 <method name=
"base_DoSetSize" type=
"" overloaded=
"no">
21742 <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
</autodoc>
21744 <param name=
"x" type=
"int" default=
""/>
21745 <param name=
"y" type=
"int" default=
""/>
21746 <param name=
"width" type=
"int" default=
""/>
21747 <param name=
"height" type=
"int" default=
""/>
21748 <param name=
"sizeFlags" type=
"int" default=
"wxSIZE_AUTO"/>
21751 <method name=
"base_DoSetClientSize" type=
"" overloaded=
"no">
21752 <autodoc>base_DoSetClientSize(self, int width, int height)
</autodoc>
21754 <param name=
"width" type=
"int" default=
""/>
21755 <param name=
"height" type=
"int" default=
""/>
21758 <method name=
"base_DoSetVirtualSize" type=
"" overloaded=
"no">
21759 <autodoc>base_DoSetVirtualSize(self, int x, int y)
</autodoc>
21761 <param name=
"x" type=
"int" default=
""/>
21762 <param name=
"y" type=
"int" default=
""/>
21765 <method name=
"base_DoGetSize" type=
"" overloaded=
"no">
21766 <autodoc>base_DoGetSize() -
> (width, height)
</autodoc>
21768 <param name=
"OUTPUT" type=
"int" default=
""/>
21769 <param name=
"OUTPUT" type=
"int" default=
""/>
21772 <method name=
"base_DoGetClientSize" type=
"" overloaded=
"no">
21773 <autodoc>base_DoGetClientSize() -
> (width, height)
</autodoc>
21775 <param name=
"OUTPUT" type=
"int" default=
""/>
21776 <param name=
"OUTPUT" type=
"int" default=
""/>
21779 <method name=
"base_DoGetPosition" type=
"" overloaded=
"no">
21780 <autodoc>base_DoGetPosition() -
> (x,y)
</autodoc>
21782 <param name=
"OUTPUT" type=
"int" default=
""/>
21783 <param name=
"OUTPUT" type=
"int" default=
""/>
21786 <method name=
"base_DoGetVirtualSize" type=
"Size" overloaded=
"no">
21787 <autodoc>base_DoGetVirtualSize(self) -
> Size
</autodoc>
21789 <method name=
"base_DoGetBestSize" type=
"Size" overloaded=
"no">
21790 <autodoc>base_DoGetBestSize(self) -
> Size
</autodoc>
21792 <method name=
"base_InitDialog" type=
"" overloaded=
"no">
21793 <autodoc>base_InitDialog(self)
</autodoc>
21795 <method name=
"base_TransferDataToWindow" type=
"bool" overloaded=
"no">
21796 <autodoc>base_TransferDataToWindow(self) -
> bool
</autodoc>
21798 <method name=
"base_TransferDataFromWindow" type=
"bool" overloaded=
"no">
21799 <autodoc>base_TransferDataFromWindow(self) -
> bool
</autodoc>
21801 <method name=
"base_Validate" type=
"bool" overloaded=
"no">
21802 <autodoc>base_Validate(self) -
> bool
</autodoc>
21804 <method name=
"base_AcceptsFocus" type=
"bool" overloaded=
"no">
21805 <autodoc>base_AcceptsFocus(self) -
> bool
</autodoc>
21807 <method name=
"base_AcceptsFocusFromKeyboard" type=
"bool" overloaded=
"no">
21808 <autodoc>base_AcceptsFocusFromKeyboard(self) -
> bool
</autodoc>
21810 <method name=
"base_GetMaxSize" type=
"Size" overloaded=
"no">
21811 <autodoc>base_GetMaxSize(self) -
> Size
</autodoc>
21813 <method name=
"base_AddChild" type=
"" overloaded=
"no">
21814 <autodoc>base_AddChild(self, Window child)
</autodoc>
21816 <param name=
"child" type=
"Window" default=
""/>
21819 <method name=
"base_RemoveChild" type=
"" overloaded=
"no">
21820 <autodoc>base_RemoveChild(self, Window child)
</autodoc>
21822 <param name=
"child" type=
"Window" default=
""/>
21825 <method name=
"base_ShouldInheritColours" type=
"bool" overloaded=
"no">
21826 <autodoc>base_ShouldInheritColours(self) -
> bool
</autodoc>
21828 <method name=
"base_ApplyParentThemeBackground" type=
"" overloaded=
"no">
21829 <autodoc>base_ApplyParentThemeBackground(self, Colour c)
</autodoc>
21831 <param name=
"c" type=
"Colour" default=
""/>
21834 <method name=
"base_GetDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
21835 <autodoc>base_GetDefaultAttributes(self) -
> VisualAttributes
</autodoc>
21839 #---------------------------------------------------------------------------
21842 EVT_HELP = wx.PyEventBinder( wxEVT_HELP,
1)
21843 EVT_HELP_RANGE = wx.PyEventBinder( wxEVT_HELP,
2)
21844 EVT_DETAILED_HELP = wx.PyEventBinder( wxEVT_DETAILED_HELP,
1)
21845 EVT_DETAILED_HELP_RANGE = wx.PyEventBinder( wxEVT_DETAILED_HELP,
2)
21847 <class name=
"HelpEvent" oldname=
"wxHelpEvent" module=
"_controls">
21848 <docstring>A help event is sent when the user has requested context-sensitive
21849 help. This can either be caused by the application requesting
21850 context-sensitive help mode via wx.ContextHelp, or (on MS Windows) by
21851 the system generating a WM_HELP message when the user pressed F1 or
21852 clicked on the query button in a dialog caption.
21854 A help event is sent to the window that the user clicked on, and is
21855 propagated up the window hierarchy until the event is processed or
21856 there are no more event handlers. The application should call
21857 event.GetId to check the identity of the clicked-on window, and then
21858 either show some suitable help or call event.Skip if the identifier is
21859 unrecognised. Calling Skip is important because it allows wxWindows to
21860 generate further events for ancestors of the clicked-on
21861 window. Otherwise it would be impossible to show help for container
21862 windows, since processing would stop after the first window found.
21866 ============== =========================================
21867 EVT_HELP Sent when the user has requested context-
21869 EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs
21870 ============== =========================================
21872 :see: `wx.ContextHelp`, `wx.ContextHelpButton`
21874 <baseclass name=
"CommandEvent"/>
21875 <constructor name=
"HelpEvent" overloaded=
"no">
21876 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=
0, Point pt=DefaultPosition) -
> HelpEvent
</autodoc>
21878 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
21879 <param name=
"winid" type=
"int" default=
"0"/>
21880 <param name=
"pt" type=
"Point" default=
"wxDefaultPosition"/>
21883 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
21884 <autodoc>GetPosition(self) -
> Point
</autodoc>
21885 <docstring>Returns the left-click position of the mouse, in screen
21886 coordinates. This allows the application to position the help
21887 appropriately.
</docstring>
21889 <method name=
"SetPosition" type=
"" overloaded=
"no">
21890 <autodoc>SetPosition(self, Point pos)
</autodoc>
21891 <docstring>Sets the left-click position of the mouse, in screen coordinates.
</docstring>
21893 <param name=
"pos" type=
"Point" default=
""/>
21896 <method name=
"GetLink" type=
"String" overloaded=
"no">
21897 <autodoc>GetLink(self) -
> String
</autodoc>
21898 <docstring>Get an optional link to further help
</docstring>
21900 <method name=
"SetLink" type=
"" overloaded=
"no">
21901 <autodoc>SetLink(self, String link)
</autodoc>
21902 <docstring>Set an optional link to further help
</docstring>
21904 <param name=
"link" type=
"String" default=
""/>
21907 <method name=
"GetTarget" type=
"String" overloaded=
"no">
21908 <autodoc>GetTarget(self) -
> String
</autodoc>
21909 <docstring>Get an optional target to display help in. E.g. a window specification
</docstring>
21911 <method name=
"SetTarget" type=
"" overloaded=
"no">
21912 <autodoc>SetTarget(self, String target)
</autodoc>
21913 <docstring>Set an optional target to display help in. E.g. a window specification
</docstring>
21915 <param name=
"target" type=
"String" default=
""/>
21919 <class name=
"ContextHelp" oldname=
"wxContextHelp" module=
"_controls">
21920 <docstring>This class changes the cursor to a query and puts the application into
21921 a 'context-sensitive help mode'. When the user left-clicks on a window
21922 within the specified window, a ``EVT_HELP`` event is sent to that
21923 control, and the application may respond to it by popping up some
21926 There are a couple of ways to invoke this behaviour implicitly:
21928 * Use the wx.DIALOG_EX_CONTEXTHELP extended style for a dialog
21929 (Windows only). This will put a question mark in the titlebar,
21930 and Windows will put the application into context-sensitive help
21931 mode automatically, with further programming.
21933 * Create a `wx.ContextHelpButton`, whose predefined behaviour is
21934 to create a context help object. Normally you will write your
21935 application so that this button is only added to a dialog for
21936 non-Windows platforms (use ``wx.DIALOG_EX_CONTEXTHELP`` on
21939 :see: `wx.ContextHelpButton`
21941 <baseclass name=
"Object"/>
21942 <constructor name=
"ContextHelp" overloaded=
"no">
21943 <autodoc>__init__(self, Window window=None, bool doNow=True) -
> ContextHelp
</autodoc>
21944 <docstring>Constructs a context help object, calling BeginContextHelp if doNow is
21945 true (the default).
21947 If window is None, the top window is used.
</docstring>
21949 <param name=
"window" type=
"Window" default=
"NULL"/>
21950 <param name=
"doNow" type=
"bool" default=
"True"/>
21953 <destructor name=
"~wxContextHelp" overloaded=
"no">
21954 <autodoc>__del__(self)
</autodoc>
21956 <method name=
"BeginContextHelp" type=
"bool" overloaded=
"no">
21957 <autodoc>BeginContextHelp(self, Window window=None) -
> bool
</autodoc>
21958 <docstring>Puts the application into context-sensitive help mode. window is the
21959 window which will be used to catch events; if NULL, the top window
21962 Returns true if the application was successfully put into
21963 context-sensitive help mode. This function only returns when the event
21964 loop has finished.
</docstring>
21966 <param name=
"window" type=
"Window" default=
"NULL"/>
21969 <method name=
"EndContextHelp" type=
"bool" overloaded=
"no">
21970 <autodoc>EndContextHelp(self) -
> bool
</autodoc>
21971 <docstring>Ends context-sensitive help mode. Not normally called by the
21972 application.
</docstring>
21975 <class name=
"ContextHelpButton" oldname=
"wxContextHelpButton" module=
"_controls">
21976 <docstring>Instances of this class may be used to add a question mark button that
21977 when pressed, puts the application into context-help mode. It does
21978 this by creating a wx.ContextHelp object which itself generates a
21979 ``EVT_HELP`` event when the user clicks on a window.
21981 On Windows, you may add a question-mark icon to a dialog by use of the
21982 ``wx.DIALOG_EX_CONTEXTHELP`` extra style, but on other platforms you
21983 will have to add a button explicitly, usually next to OK, Cancel or
21986 :see: `wx.ContextHelp`, `wx.ContextHelpButton`
21988 <baseclass name=
"BitmapButton"/>
21989 <constructor name=
"ContextHelpButton" overloaded=
"no">
21990 <autodoc>__init__(self, Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition,
21991 Size size=DefaultSize, long style=BU_AUTODRAW) -
> ContextHelpButton
</autodoc>
21992 <docstring>Constructor, creating and showing a context help button.
</docstring>
21994 <param name=
"parent" type=
"Window" default=
""/>
21995 <param name=
"id" type=
"int" default=
"wxID_CONTEXT_HELP"/>
21996 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
21997 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
21998 <param name=
"style" type=
"long" default=
"wxBU_AUTODRAW"/>
22002 <class name=
"HelpProvider" oldname=
"wxHelpProvider" module=
"_controls">
22003 <docstring>wx.HelpProvider is an abstract class used by a program
22004 implementing context-sensitive help to show the help text for the
22007 The current help provider must be explicitly set by the
22008 application using wx.HelpProvider.Set().
</docstring>
22009 <staticmethod name=
"Set" type=
"HelpProvider" overloaded=
"no">
22010 <autodoc>Set(HelpProvider helpProvider) -
> HelpProvider
</autodoc>
22011 <docstring>Sset the current, application-wide help provider. Returns the previous
22012 one. Unlike some other classes, the help provider is not created on
22013 demand. This must be explicitly done by the application.
</docstring>
22015 <param name=
"helpProvider" type=
"HelpProvider" default=
""/>
22018 <staticmethod name=
"Get" type=
"HelpProvider" overloaded=
"no">
22019 <autodoc>Get() -
> HelpProvider
</autodoc>
22020 <docstring>Return the current application-wide help provider.
</docstring>
22022 <method name=
"GetHelp" type=
"String" overloaded=
"no">
22023 <autodoc>GetHelp(self, Window window) -
> String
</autodoc>
22024 <docstring>Gets the help string for this window. Its interpretation is dependent
22025 on the help provider except that empty string always means that no
22026 help is associated with the window.
</docstring>
22028 <param name=
"window" type=
"Window" default=
""/>
22031 <method name=
"ShowHelp" type=
"bool" overloaded=
"no">
22032 <autodoc>ShowHelp(self, Window window) -
> bool
</autodoc>
22033 <docstring>Shows help for the given window. Uses GetHelp internally if
22034 applicable. Returns True if it was done, or False if no help was
22035 available for this window.
</docstring>
22037 <param name=
"window" type=
"Window" default=
""/>
22040 <method name=
"AddHelp" type=
"" overloaded=
"no">
22041 <autodoc>AddHelp(self, Window window, String text)
</autodoc>
22042 <docstring>Associates the text with the given window.
</docstring>
22044 <param name=
"window" type=
"Window" default=
""/>
22045 <param name=
"text" type=
"String" default=
""/>
22048 <method name=
"AddHelpById" type=
"" overloaded=
"no">
22049 <autodoc>AddHelpById(self, int id, String text)
</autodoc>
22050 <docstring>This version associates the given text with all windows with this
22051 id. May be used to set the same help string for all Cancel buttons in
22052 the application, for example.
</docstring>
22054 <param name=
"id" type=
"int" default=
""/>
22055 <param name=
"text" type=
"String" default=
""/>
22058 <method name=
"RemoveHelp" type=
"" overloaded=
"no">
22059 <autodoc>RemoveHelp(self, Window window)
</autodoc>
22060 <docstring>Removes the association between the window pointer and the help
22061 text. This is called by the wx.Window destructor. Without this, the
22062 table of help strings will fill up and when window pointers are
22063 reused, the wrong help string will be found.
</docstring>
22065 <param name=
"window" type=
"Window" default=
""/>
22068 <method name=
"Destroy" type=
"" overloaded=
"no">
22069 <autodoc>Destroy(self)
</autodoc>
22072 <class name=
"SimpleHelpProvider" oldname=
"wxSimpleHelpProvider" module=
"_controls">
22073 <docstring>wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
22074 supports only plain text help strings, and shows the string associated
22075 with the control (if any) in a tooltip.
</docstring>
22076 <baseclass name=
"HelpProvider"/>
22077 <constructor name=
"SimpleHelpProvider" overloaded=
"no">
22078 <autodoc>__init__(self) -
> SimpleHelpProvider
</autodoc>
22079 <docstring>wx.SimpleHelpProvider is an implementation of `wx.HelpProvider` which
22080 supports only plain text help strings, and shows the string associated
22081 with the control (if any) in a tooltip.
</docstring>
22085 #---------------------------------------------------------------------------
22087 <class name=
"DragImage" oldname=
"wxGenericDragImage" module=
"_controls">
22088 <baseclass name=
"Object"/>
22089 <constructor name=
"wxGenericDragImage" overloaded=
"no">
22090 <autodoc>__init__(self, Bitmap image, Cursor cursor=wxNullCursor) -
> DragImage
</autodoc>
22092 <param name=
"image" type=
"Bitmap" default=
""/>
22093 <param name=
"cursor" type=
"Cursor" default=
"wxNullCursor"/>
22096 <constructor name=
"DragIcon" overloaded=
"no">
22097 <autodoc>DragIcon(Icon image, Cursor cursor=wxNullCursor) -
> DragImage
</autodoc>
22099 <param name=
"image" type=
"Icon" default=
""/>
22100 <param name=
"cursor" type=
"Cursor" default=
"wxNullCursor"/>
22103 <constructor name=
"DragString" overloaded=
"no">
22104 <autodoc>DragString(String str, Cursor cursor=wxNullCursor) -
> DragImage
</autodoc>
22106 <param name=
"str" type=
"String" default=
""/>
22107 <param name=
"cursor" type=
"Cursor" default=
"wxNullCursor"/>
22110 <constructor name=
"DragTreeItem" overloaded=
"no">
22111 <autodoc>DragTreeItem(TreeCtrl treeCtrl, TreeItemId id) -
> DragImage
</autodoc>
22113 <param name=
"treeCtrl" type=
"TreeCtrl" default=
""/>
22114 <param name=
"id" type=
"TreeItemId" default=
""/>
22117 <constructor name=
"DragListItem" overloaded=
"no">
22118 <autodoc>DragListItem(ListCtrl listCtrl, long id) -
> DragImage
</autodoc>
22120 <param name=
"listCtrl" type=
"ListCtrl" default=
""/>
22121 <param name=
"id" type=
"long" default=
""/>
22124 <destructor name=
"~wxGenericDragImage" overloaded=
"no">
22125 <autodoc>__del__(self)
</autodoc>
22127 <method name=
"SetBackingBitmap" type=
"" overloaded=
"no">
22128 <autodoc>SetBackingBitmap(self, Bitmap bitmap)
</autodoc>
22130 <param name=
"bitmap" type=
"Bitmap" default=
""/>
22133 <method name=
"BeginDrag" type=
"bool" overloaded=
"no">
22134 <autodoc>BeginDrag(self, Point hotspot, Window window, bool fullScreen=False,
22135 Rect rect=None) -
> bool
</autodoc>
22137 <param name=
"hotspot" type=
"Point" default=
""/>
22138 <param name=
"window" type=
"Window" default=
""/>
22139 <param name=
"fullScreen" type=
"bool" default=
"False"/>
22140 <param name=
"rect" type=
"Rect" default=
"NULL"/>
22143 <method name=
"BeginDragBounded" type=
"bool" overloaded=
"no">
22144 <autodoc>BeginDragBounded(self, Point hotspot, Window window, Window boundingWindow) -
> bool
</autodoc>
22146 <param name=
"hotspot" type=
"Point" default=
""/>
22147 <param name=
"window" type=
"Window" default=
""/>
22148 <param name=
"boundingWindow" type=
"Window" default=
""/>
22151 <method name=
"EndDrag" type=
"bool" overloaded=
"no">
22152 <autodoc>EndDrag(self) -
> bool
</autodoc>
22154 <method name=
"Move" type=
"bool" overloaded=
"no">
22155 <autodoc>Move(self, Point pt) -
> bool
</autodoc>
22157 <param name=
"pt" type=
"Point" default=
""/>
22160 <method name=
"Show" type=
"bool" overloaded=
"no">
22161 <autodoc>Show(self) -
> bool
</autodoc>
22163 <method name=
"Hide" type=
"bool" overloaded=
"no">
22164 <autodoc>Hide(self) -
> bool
</autodoc>
22166 <method name=
"GetImageRect" type=
"Rect" overloaded=
"no">
22167 <autodoc>GetImageRect(self, Point pos) -
> Rect
</autodoc>
22169 <param name=
"pos" type=
"Point" default=
""/>
22172 <method name=
"DoDrawImage" type=
"bool" overloaded=
"no">
22173 <autodoc>DoDrawImage(self, DC dc, Point pos) -
> bool
</autodoc>
22175 <param name=
"dc" type=
"DC" default=
""/>
22176 <param name=
"pos" type=
"Point" default=
""/>
22179 <method name=
"UpdateBackingFromWindow" type=
"bool" overloaded=
"no">
22180 <autodoc>UpdateBackingFromWindow(self, DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -
> bool
</autodoc>
22182 <param name=
"windowDC" type=
"DC" default=
""/>
22183 <param name=
"destDC" type=
"MemoryDC" default=
""/>
22184 <param name=
"sourceRect" type=
"Rect" default=
""/>
22185 <param name=
"destRect" type=
"Rect" default=
""/>
22188 <method name=
"RedrawImage" type=
"bool" overloaded=
"no">
22189 <autodoc>RedrawImage(self, Point oldPos, Point newPos, bool eraseOld, bool drawNew) -
> bool
</autodoc>
22191 <param name=
"oldPos" type=
"Point" default=
""/>
22192 <param name=
"newPos" type=
"Point" default=
""/>
22193 <param name=
"eraseOld" type=
"bool" default=
""/>
22194 <param name=
"drawNew" type=
"bool" default=
""/>
22199 <module name=
"_misc">
22200 <import name=
"_core"/>
22201 <pythoncode> wx = _core
</pythoncode>
22203 #---------------------------------------------------------------------------
22205 <class name=
"SystemSettings" oldname=
"wxSystemSettings" module=
"_misc">
22206 <staticmethod name=
"GetColour" type=
"Colour" overloaded=
"no">
22207 <autodoc>GetColour(int index) -
> Colour
</autodoc>
22209 <param name=
"index" type=
"wxSystemColour" default=
""/>
22212 <staticmethod name=
"GetFont" type=
"Font" overloaded=
"no">
22213 <autodoc>GetFont(int index) -
> Font
</autodoc>
22215 <param name=
"index" type=
"wxSystemFont" default=
""/>
22218 <staticmethod name=
"GetMetric" type=
"int" overloaded=
"no">
22219 <autodoc>GetMetric(int index) -
> int
</autodoc>
22221 <param name=
"index" type=
"wxSystemMetric" default=
""/>
22224 <staticmethod name=
"HasFeature" type=
"bool" overloaded=
"no">
22225 <autodoc>HasFeature(int index) -
> bool
</autodoc>
22227 <param name=
"index" type=
"wxSystemFeature" default=
""/>
22230 <staticmethod name=
"GetScreenType" type=
"wxSystemScreenType" overloaded=
"no">
22231 <autodoc>GetScreenType() -
> int
</autodoc>
22233 <staticmethod name=
"SetScreenType" type=
"" overloaded=
"no">
22234 <autodoc>SetScreenType(int screen)
</autodoc>
22236 <param name=
"screen" type=
"wxSystemScreenType" default=
""/>
22240 <class name=
"SystemOptions" oldname=
"wxSystemOptions" module=
"_misc">
22241 <baseclass name=
"Object"/>
22242 <constructor name=
"SystemOptions" overloaded=
"no">
22243 <autodoc>__init__(self) -
> SystemOptions
</autodoc>
22245 <staticmethod name=
"SetOption" type=
"" overloaded=
"no">
22246 <autodoc>SetOption(String name, String value)
</autodoc>
22248 <param name=
"name" type=
"String" default=
""/>
22249 <param name=
"value" type=
"String" default=
""/>
22252 <staticmethod name=
"SetOptionInt" type=
"" overloaded=
"no">
22253 <autodoc>SetOptionInt(String name, int value)
</autodoc>
22255 <param name=
"name" type=
"String" default=
""/>
22256 <param name=
"value" type=
"int" default=
""/>
22259 <staticmethod name=
"GetOption" type=
"String" overloaded=
"no">
22260 <autodoc>GetOption(String name) -
> String
</autodoc>
22262 <param name=
"name" type=
"String" default=
""/>
22265 <staticmethod name=
"GetOptionInt" type=
"int" overloaded=
"no">
22266 <autodoc>GetOptionInt(String name) -
> int
</autodoc>
22268 <param name=
"name" type=
"String" default=
""/>
22271 <staticmethod name=
"HasOption" type=
"bool" overloaded=
"no">
22272 <autodoc>HasOption(String name) -
> bool
</autodoc>
22274 <param name=
"name" type=
"String" default=
""/>
22279 #---------------------------------------------------------------------------
22281 <method name=
"NewId" oldname=
"wxNewId" type=
"long" overloaded=
"no">
22282 <autodoc>NewId() -
> long
</autodoc>
22284 <method name=
"RegisterId" oldname=
"wxRegisterId" type=
"" overloaded=
"no">
22285 <autodoc>RegisterId(long id)
</autodoc>
22287 <param name=
"id" type=
"long" default=
""/>
22290 <method name=
"GetCurrentId" oldname=
"wxGetCurrentId" type=
"long" overloaded=
"no">
22291 <autodoc>GetCurrentId() -
> long
</autodoc>
22293 <method name=
"Bell" oldname=
"wxBell" type=
"" overloaded=
"no">
22294 <autodoc>Bell()
</autodoc>
22296 <method name=
"EndBusyCursor" oldname=
"wxEndBusyCursor" type=
"" overloaded=
"no">
22297 <autodoc>EndBusyCursor()
</autodoc>
22299 <method name=
"GetElapsedTime" oldname=
"wxGetElapsedTime" type=
"long" overloaded=
"no">
22300 <autodoc>GetElapsedTime(bool resetTimer=True) -
> long
</autodoc>
22302 <param name=
"resetTimer" type=
"bool" default=
"True"/>
22305 <method name=
"GetMousePosition" oldname=
"wxGetMousePosition" type=
"" overloaded=
"no">
22306 <autodoc>GetMousePosition() -
> (x,y)
</autodoc>
22308 <param name=
"OUTPUT" type=
"int" default=
""/>
22309 <param name=
"OUTPUT" type=
"int" default=
""/>
22312 <method name=
"IsBusy" oldname=
"wxIsBusy" type=
"bool" overloaded=
"no">
22313 <autodoc>IsBusy() -
> bool
</autodoc>
22315 <method name=
"Now" oldname=
"wxNow" type=
"String" overloaded=
"no">
22316 <autodoc>Now() -
> String
</autodoc>
22318 <method name=
"Shell" oldname=
"wxShell" type=
"bool" overloaded=
"no">
22319 <autodoc>Shell(String command=EmptyString) -
> bool
</autodoc>
22321 <param name=
"command" type=
"String" default=
"wxPyEmptyString"/>
22324 <method name=
"StartTimer" oldname=
"wxStartTimer" type=
"" overloaded=
"no">
22325 <autodoc>StartTimer()
</autodoc>
22327 <method name=
"GetOsVersion" oldname=
"wxGetOsVersion" type=
"int" overloaded=
"no">
22328 <autodoc>GetOsVersion() -
> (platform, major, minor)
</autodoc>
22330 <param name=
"OUTPUT" type=
"int" default=
""/>
22331 <param name=
"OUTPUT" type=
"int" default=
""/>
22334 <method name=
"GetOsDescription" oldname=
"wxGetOsDescription" type=
"String" overloaded=
"no">
22335 <autodoc>GetOsDescription() -
> String
</autodoc>
22337 <method name=
"GetFreeMemory" oldname=
"wxGetFreeMemory" type=
"long" overloaded=
"no">
22338 <autodoc>GetFreeMemory() -
> long
</autodoc>
22340 <method name=
"Shutdown" oldname=
"wxShutdown" type=
"bool" overloaded=
"no">
22341 <autodoc>Shutdown(int wFlags) -
> bool
</autodoc>
22343 <param name=
"wFlags" type=
"wxShutdownFlags" default=
""/>
22346 <method name=
"Sleep" oldname=
"wxSleep" type=
"" overloaded=
"no">
22347 <autodoc>Sleep(int secs)
</autodoc>
22349 <param name=
"secs" type=
"int" default=
""/>
22352 <method name=
"MilliSleep" oldname=
"wxMilliSleep" type=
"" overloaded=
"no">
22353 <autodoc>MilliSleep(unsigned long milliseconds)
</autodoc>
22355 <param name=
"milliseconds" type=
"unsigned long" default=
""/>
22358 <method name=
"MicroSleep" oldname=
"wxMicroSleep" type=
"" overloaded=
"no">
22359 <autodoc>MicroSleep(unsigned long microseconds)
</autodoc>
22361 <param name=
"microseconds" type=
"unsigned long" default=
""/>
22364 <pythoncode> Usleep = MilliSleep
</pythoncode>
22365 <method name=
"EnableTopLevelWindows" oldname=
"wxEnableTopLevelWindows" type=
"" overloaded=
"no">
22366 <autodoc>EnableTopLevelWindows(bool enable)
</autodoc>
22368 <param name=
"enable" type=
"bool" default=
""/>
22371 <method name=
"StripMenuCodes" oldname=
"wxStripMenuCodes" type=
"String" overloaded=
"no">
22372 <autodoc>StripMenuCodes(String in) -
> String
</autodoc>
22374 <param name=
"in" type=
"String" default=
""/>
22377 <method name=
"GetEmailAddress" oldname=
"wxGetEmailAddress" type=
"String" overloaded=
"no">
22378 <autodoc>GetEmailAddress() -
> String
</autodoc>
22380 <method name=
"GetHostName" oldname=
"wxGetHostName" type=
"String" overloaded=
"no">
22381 <autodoc>GetHostName() -
> String
</autodoc>
22383 <method name=
"GetFullHostName" oldname=
"wxGetFullHostName" type=
"String" overloaded=
"no">
22384 <autodoc>GetFullHostName() -
> String
</autodoc>
22386 <method name=
"GetUserId" oldname=
"wxGetUserId" type=
"String" overloaded=
"no">
22387 <autodoc>GetUserId() -
> String
</autodoc>
22389 <method name=
"GetUserName" oldname=
"wxGetUserName" type=
"String" overloaded=
"no">
22390 <autodoc>GetUserName() -
> String
</autodoc>
22392 <method name=
"GetHomeDir" oldname=
"wxGetHomeDir" type=
"String" overloaded=
"no">
22393 <autodoc>GetHomeDir() -
> String
</autodoc>
22395 <method name=
"GetUserHome" oldname=
"wxGetUserHome" type=
"String" overloaded=
"no">
22396 <autodoc>GetUserHome(String user=EmptyString) -
> String
</autodoc>
22398 <param name=
"user" type=
"String" default=
"wxPyEmptyString"/>
22401 <method name=
"GetProcessId" oldname=
"wxGetProcessId" type=
"unsigned long" overloaded=
"no">
22402 <autodoc>GetProcessId() -
> unsigned long
</autodoc>
22404 <method name=
"Trap" oldname=
"wxTrap" type=
"" overloaded=
"no">
22405 <autodoc>Trap()
</autodoc>
22407 <method name=
"FileSelector" oldname=
"wxFileSelector" type=
"String" overloaded=
"no">
22408 <autodoc>FileSelector(String message=FileSelectorPromptStr, String default_path=EmptyString,
22409 String default_filename=EmptyString,
22410 String default_extension=EmptyString,
22411 String wildcard=FileSelectorDefaultWildcardStr,
22412 int flags=
0, Window parent=None, int x=-
1,
22413 int y=-
1) -
> String
</autodoc>
22415 <param name=
"message" type=
"String" default=
"wxPyFileSelectorPromptStr"/>
22416 <param name=
"default_path" type=
"String" default=
"wxPyEmptyString"/>
22417 <param name=
"default_filename" type=
"String" default=
"wxPyEmptyString"/>
22418 <param name=
"default_extension" type=
"String" default=
"wxPyEmptyString"/>
22419 <param name=
"wildcard" type=
"String" default=
"wxPyFileSelectorDefaultWildcardStr"/>
22420 <param name=
"flags" type=
"int" default=
"0"/>
22421 <param name=
"parent" type=
"Window" default=
"NULL"/>
22422 <param name=
"x" type=
"int" default=
"-1"/>
22423 <param name=
"y" type=
"int" default=
"-1"/>
22426 <method name=
"LoadFileSelector" oldname=
"wxLoadFileSelector" type=
"String" overloaded=
"no">
22427 <autodoc>LoadFileSelector(String what, String extension, String default_name=EmptyString,
22428 Window parent=None) -
> String
</autodoc>
22430 <param name=
"what" type=
"String" default=
""/>
22431 <param name=
"extension" type=
"String" default=
""/>
22432 <param name=
"default_name" type=
"String" default=
"wxPyEmptyString"/>
22433 <param name=
"parent" type=
"Window" default=
"NULL"/>
22436 <method name=
"SaveFileSelector" oldname=
"wxSaveFileSelector" type=
"String" overloaded=
"no">
22437 <autodoc>SaveFileSelector(String what, String extension, String default_name=EmptyString,
22438 Window parent=None) -
> String
</autodoc>
22440 <param name=
"what" type=
"String" default=
""/>
22441 <param name=
"extension" type=
"String" default=
""/>
22442 <param name=
"default_name" type=
"String" default=
"wxPyEmptyString"/>
22443 <param name=
"parent" type=
"Window" default=
"NULL"/>
22446 <method name=
"DirSelector" oldname=
"wxDirSelector" type=
"String" overloaded=
"no">
22447 <autodoc>DirSelector(String message=DirSelectorPromptStr, String defaultPath=EmptyString,
22448 long style=DD_DEFAULT_STYLE,
22449 Point pos=DefaultPosition, Window parent=None) -
> String
</autodoc>
22451 <param name=
"message" type=
"String" default=
"wxPyDirSelectorPromptStr"/>
22452 <param name=
"defaultPath" type=
"String" default=
"wxPyEmptyString"/>
22453 <param name=
"style" type=
"long" default=
"wxDD_DEFAULT_STYLE"/>
22454 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
22455 <param name=
"parent" type=
"Window" default=
"NULL"/>
22458 <method name=
"GetTextFromUser" oldname=
"wxGetTextFromUser" type=
"String" overloaded=
"no">
22459 <autodoc>GetTextFromUser(String message, String caption=EmptyString, String default_value=EmptyString,
22460 Window parent=None,
22461 int x=-
1, int y=-
1, bool centre=True) -
> String
</autodoc>
22463 <param name=
"message" type=
"String" default=
""/>
22464 <param name=
"caption" type=
"String" default=
"wxPyEmptyString"/>
22465 <param name=
"default_value" type=
"String" default=
"wxPyEmptyString"/>
22466 <param name=
"parent" type=
"Window" default=
"NULL"/>
22467 <param name=
"x" type=
"int" default=
"-1"/>
22468 <param name=
"y" type=
"int" default=
"-1"/>
22469 <param name=
"centre" type=
"bool" default=
"True"/>
22472 <method name=
"GetPasswordFromUser" oldname=
"wxGetPasswordFromUser" type=
"String" overloaded=
"no">
22473 <autodoc>GetPasswordFromUser(String message, String caption=EmptyString, String default_value=EmptyString,
22474 Window parent=None) -
> String
</autodoc>
22476 <param name=
"message" type=
"String" default=
""/>
22477 <param name=
"caption" type=
"String" default=
"wxPyEmptyString"/>
22478 <param name=
"default_value" type=
"String" default=
"wxPyEmptyString"/>
22479 <param name=
"parent" type=
"Window" default=
"NULL"/>
22482 <method name=
"GetSingleChoice" oldname=
"wxGetSingleChoice" type=
"String" overloaded=
"no">
22483 <autodoc>GetSingleChoice(String message, String caption, int choices, String choices_array,
22484 Window parent=None, int x=-
1,
22485 int y=-
1, bool centre=True, int width=
150, int height=
200) -
> String
</autodoc>
22487 <param name=
"message" type=
"String" default=
""/>
22488 <param name=
"caption" type=
"String" default=
""/>
22489 <param name=
"choices" type=
"int" default=
""/>
22490 <param name=
"choices_array" type=
"String" default=
""/>
22491 <param name=
"parent" type=
"Window" default=
"NULL"/>
22492 <param name=
"x" type=
"int" default=
"-1"/>
22493 <param name=
"y" type=
"int" default=
"-1"/>
22494 <param name=
"centre" type=
"bool" default=
"True"/>
22495 <param name=
"width" type=
"int" default=
"150"/>
22496 <param name=
"height" type=
"int" default=
"200"/>
22499 <method name=
"GetSingleChoiceIndex" oldname=
"wxGetSingleChoiceIndex" type=
"int" overloaded=
"no">
22500 <autodoc>GetSingleChoiceIndex(String message, String caption, int choices, String choices_array,
22501 Window parent=None, int x=-
1,
22502 int y=-
1, bool centre=True, int width=
150, int height=
200) -
> int
</autodoc>
22504 <param name=
"message" type=
"String" default=
""/>
22505 <param name=
"caption" type=
"String" default=
""/>
22506 <param name=
"choices" type=
"int" default=
""/>
22507 <param name=
"choices_array" type=
"String" default=
""/>
22508 <param name=
"parent" type=
"Window" default=
"NULL"/>
22509 <param name=
"x" type=
"int" default=
"-1"/>
22510 <param name=
"y" type=
"int" default=
"-1"/>
22511 <param name=
"centre" type=
"bool" default=
"True"/>
22512 <param name=
"width" type=
"int" default=
"150"/>
22513 <param name=
"height" type=
"int" default=
"200"/>
22516 <method name=
"MessageBox" oldname=
"wxMessageBox" type=
"int" overloaded=
"no">
22517 <autodoc>MessageBox(String message, String caption=EmptyString, int style=wxOK|wxCENTRE,
22518 Window parent=None, int x=-
1,
22519 int y=-
1) -
> int
</autodoc>
22521 <param name=
"message" type=
"String" default=
""/>
22522 <param name=
"caption" type=
"String" default=
"wxPyEmptyString"/>
22523 <param name=
"style" type=
"int" default=
"wxOK|wxCENTRE"/>
22524 <param name=
"parent" type=
"Window" default=
"NULL"/>
22525 <param name=
"x" type=
"int" default=
"-1"/>
22526 <param name=
"y" type=
"int" default=
"-1"/>
22529 <method name=
"GetNumberFromUser" oldname=
"wxGetNumberFromUser" type=
"long" overloaded=
"no">
22530 <autodoc>GetNumberFromUser(String message, String prompt, String caption, long value,
22531 long min=
0, long max=
100, Window parent=None,
22532 Point pos=DefaultPosition) -
> long
</autodoc>
22534 <param name=
"message" type=
"String" default=
""/>
22535 <param name=
"prompt" type=
"String" default=
""/>
22536 <param name=
"caption" type=
"String" default=
""/>
22537 <param name=
"value" type=
"long" default=
""/>
22538 <param name=
"min" type=
"long" default=
"0"/>
22539 <param name=
"max" type=
"long" default=
"100"/>
22540 <param name=
"parent" type=
"Window" default=
"NULL"/>
22541 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
22544 <method name=
"ColourDisplay" oldname=
"wxColourDisplay" type=
"bool" overloaded=
"no">
22545 <autodoc>ColourDisplay() -
> bool
</autodoc>
22547 <method name=
"DisplayDepth" oldname=
"wxDisplayDepth" type=
"int" overloaded=
"no">
22548 <autodoc>DisplayDepth() -
> int
</autodoc>
22550 <method name=
"GetDisplayDepth" oldname=
"wxGetDisplayDepth" type=
"int" overloaded=
"no">
22551 <autodoc>GetDisplayDepth() -
> int
</autodoc>
22553 <method name=
"DisplaySize" oldname=
"wxDisplaySize" type=
"" overloaded=
"no">
22554 <autodoc>DisplaySize() -
> (width, height)
</autodoc>
22556 <param name=
"OUTPUT" type=
"int" default=
""/>
22557 <param name=
"OUTPUT" type=
"int" default=
""/>
22560 <method name=
"GetDisplaySize" oldname=
"wxGetDisplaySize" type=
"Size" overloaded=
"no">
22561 <autodoc>GetDisplaySize() -
> Size
</autodoc>
22563 <method name=
"DisplaySizeMM" oldname=
"wxDisplaySizeMM" type=
"" overloaded=
"no">
22564 <autodoc>DisplaySizeMM() -
> (width, height)
</autodoc>
22566 <param name=
"OUTPUT" type=
"int" default=
""/>
22567 <param name=
"OUTPUT" type=
"int" default=
""/>
22570 <method name=
"GetDisplaySizeMM" oldname=
"wxGetDisplaySizeMM" type=
"Size" overloaded=
"no">
22571 <autodoc>GetDisplaySizeMM() -
> Size
</autodoc>
22573 <method name=
"ClientDisplayRect" oldname=
"wxClientDisplayRect" type=
"" overloaded=
"no">
22574 <autodoc>ClientDisplayRect() -
> (x, y, width, height)
</autodoc>
22576 <param name=
"OUTPUT" type=
"int" default=
""/>
22577 <param name=
"OUTPUT" type=
"int" default=
""/>
22578 <param name=
"OUTPUT" type=
"int" default=
""/>
22579 <param name=
"OUTPUT" type=
"int" default=
""/>
22582 <method name=
"GetClientDisplayRect" oldname=
"wxGetClientDisplayRect" type=
"Rect" overloaded=
"no">
22583 <autodoc>GetClientDisplayRect() -
> Rect
</autodoc>
22585 <method name=
"SetCursor" oldname=
"wxSetCursor" type=
"" overloaded=
"no">
22586 <autodoc>SetCursor(Cursor cursor)
</autodoc>
22588 <param name=
"cursor" type=
"Cursor" default=
""/>
22591 <method name=
"BeginBusyCursor" oldname=
"wxBeginBusyCursor" type=
"" overloaded=
"no">
22592 <autodoc>BeginBusyCursor(Cursor cursor=wxHOURGLASS_CURSOR)
</autodoc>
22594 <param name=
"cursor" type=
"Cursor" default=
"wxHOURGLASS_CURSOR"/>
22597 <method name=
"GetActiveWindow" oldname=
"wxGetActiveWindow" type=
"Window" overloaded=
"no">
22598 <autodoc>GetActiveWindow() -
> Window
</autodoc>
22600 <method name=
"GenericFindWindowAtPoint" oldname=
"wxGenericFindWindowAtPoint" type=
"Window" overloaded=
"no">
22601 <autodoc>GenericFindWindowAtPoint(Point pt) -
> Window
</autodoc>
22603 <param name=
"pt" type=
"Point" default=
""/>
22606 <method name=
"FindWindowAtPoint" oldname=
"wxFindWindowAtPoint" type=
"Window" overloaded=
"no">
22607 <autodoc>FindWindowAtPoint(Point pt) -
> Window
</autodoc>
22609 <param name=
"pt" type=
"Point" default=
""/>
22612 <method name=
"GetTopLevelParent" oldname=
"wxGetTopLevelParent" type=
"Window" overloaded=
"no">
22613 <autodoc>GetTopLevelParent(Window win) -
> Window
</autodoc>
22615 <param name=
"win" type=
"Window" default=
""/>
22618 <method name=
"GetKeyState" oldname=
"wxGetKeyState" type=
"bool" overloaded=
"no">
22619 <autodoc>GetKeyState(int key) -
> bool
</autodoc>
22620 <docstring>Get the state of a key (true if pressed or toggled on, false if not.)
22621 This is generally most useful getting the state of the modifier or
22622 toggle keys. On some platforms those may be the only keys that work.
22625 <param name=
"key" type=
"wxKeyCode" default=
""/>
22628 <method name=
"WakeUpMainThread" oldname=
"wxWakeUpMainThread" type=
"" overloaded=
"no">
22629 <autodoc>WakeUpMainThread()
</autodoc>
22631 <method name=
"MutexGuiEnter" oldname=
"wxMutexGuiEnter" type=
"" overloaded=
"no">
22632 <autodoc>MutexGuiEnter()
</autodoc>
22634 <method name=
"MutexGuiLeave" oldname=
"wxMutexGuiLeave" type=
"" overloaded=
"no">
22635 <autodoc>MutexGuiLeave()
</autodoc>
22637 <class name=
"MutexGuiLocker" oldname=
"wxMutexGuiLocker" module=
"_misc">
22638 <constructor name=
"MutexGuiLocker" overloaded=
"no">
22639 <autodoc>__init__(self) -
> MutexGuiLocker
</autodoc>
22641 <destructor name=
"~wxMutexGuiLocker" overloaded=
"no">
22642 <autodoc>__del__(self)
</autodoc>
22645 <method name=
"Thread_IsMain" oldname=
"wxThread_IsMain" type=
"bool" overloaded=
"no">
22646 <autodoc>Thread_IsMain() -
> bool
</autodoc>
22649 #---------------------------------------------------------------------------
22651 <class name=
"ToolTip" oldname=
"wxToolTip" module=
"_misc">
22652 <baseclass name=
"Object"/>
22653 <constructor name=
"ToolTip" overloaded=
"no">
22654 <autodoc>__init__(self, String tip) -
> ToolTip
</autodoc>
22656 <param name=
"tip" type=
"String" default=
""/>
22659 <method name=
"SetTip" type=
"" overloaded=
"no">
22660 <autodoc>SetTip(self, String tip)
</autodoc>
22662 <param name=
"tip" type=
"String" default=
""/>
22665 <method name=
"GetTip" type=
"String" overloaded=
"no">
22666 <autodoc>GetTip(self) -
> String
</autodoc>
22668 <method name=
"GetWindow" type=
"Window" overloaded=
"no">
22669 <autodoc>GetWindow(self) -
> Window
</autodoc>
22671 <staticmethod name=
"Enable" type=
"" overloaded=
"no">
22672 <autodoc>Enable(bool flag)
</autodoc>
22674 <param name=
"flag" type=
"bool" default=
""/>
22677 <staticmethod name=
"SetDelay" type=
"" overloaded=
"no">
22678 <autodoc>SetDelay(long milliseconds)
</autodoc>
22680 <param name=
"milliseconds" type=
"long" default=
""/>
22684 <class name=
"Caret" oldname=
"wxCaret" module=
"_misc">
22685 <constructor name=
"Caret" overloaded=
"no">
22686 <autodoc>__init__(self, Window window, Size size) -
> Caret
</autodoc>
22688 <param name=
"window" type=
"Window" default=
""/>
22689 <param name=
"size" type=
"Size" default=
""/>
22692 <destructor name=
"~wxCaret" overloaded=
"no">
22693 <autodoc>__del__(self)
</autodoc>
22695 <method name=
"IsOk" type=
"bool" overloaded=
"no">
22696 <autodoc>IsOk(self) -
> bool
</autodoc>
22698 <method name=
"IsVisible" type=
"bool" overloaded=
"no">
22699 <autodoc>IsVisible(self) -
> bool
</autodoc>
22701 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
22702 <autodoc>GetPosition(self) -
> Point
</autodoc>
22704 <method name=
"GetPositionTuple" type=
"" overloaded=
"no">
22705 <autodoc>GetPositionTuple() -
> (x,y)
</autodoc>
22707 <param name=
"OUTPUT" type=
"int" default=
""/>
22708 <param name=
"OUTPUT" type=
"int" default=
""/>
22711 <method name=
"GetSize" type=
"Size" overloaded=
"no">
22712 <autodoc>GetSize(self) -
> Size
</autodoc>
22714 <method name=
"GetSizeTuple" type=
"" overloaded=
"no">
22715 <autodoc>GetSizeTuple() -
> (width, height)
</autodoc>
22717 <param name=
"OUTPUT" type=
"int" default=
""/>
22718 <param name=
"OUTPUT" type=
"int" default=
""/>
22721 <method name=
"GetWindow" type=
"Window" overloaded=
"no">
22722 <autodoc>GetWindow(self) -
> Window
</autodoc>
22724 <method name=
"MoveXY" type=
"" overloaded=
"no">
22725 <autodoc>MoveXY(self, int x, int y)
</autodoc>
22727 <param name=
"x" type=
"int" default=
""/>
22728 <param name=
"y" type=
"int" default=
""/>
22731 <method name=
"Move" type=
"" overloaded=
"no">
22732 <autodoc>Move(self, Point pt)
</autodoc>
22734 <param name=
"pt" type=
"Point" default=
""/>
22737 <method name=
"SetSizeWH" type=
"" overloaded=
"no">
22738 <autodoc>SetSizeWH(self, int width, int height)
</autodoc>
22740 <param name=
"width" type=
"int" default=
""/>
22741 <param name=
"height" type=
"int" default=
""/>
22744 <method name=
"SetSize" type=
"" overloaded=
"no">
22745 <autodoc>SetSize(self, Size size)
</autodoc>
22747 <param name=
"size" type=
"Size" default=
""/>
22750 <method name=
"Show" type=
"" overloaded=
"no">
22751 <autodoc>Show(self, int show=True)
</autodoc>
22753 <param name=
"show" type=
"int" default=
"True"/>
22756 <method name=
"Hide" type=
"" overloaded=
"no">
22757 <autodoc>Hide(self)
</autodoc>
22760 <method name=
"Caret_GetBlinkTime" oldname=
"wxCaret_GetBlinkTime" type=
"int" overloaded=
"no">
22761 <autodoc>Caret_GetBlinkTime() -
> int
</autodoc>
22763 <method name=
"Caret_SetBlinkTime" oldname=
"wxCaret_SetBlinkTime" type=
"" overloaded=
"no">
22764 <autodoc>Caret_SetBlinkTime(int milliseconds)
</autodoc>
22766 <param name=
"milliseconds" type=
"int" default=
""/>
22769 <class name=
"BusyCursor" oldname=
"wxBusyCursor" module=
"_misc">
22770 <constructor name=
"BusyCursor" overloaded=
"no">
22771 <autodoc>__init__(self, Cursor cursor=wxHOURGLASS_CURSOR) -
> BusyCursor
</autodoc>
22773 <param name=
"cursor" type=
"Cursor" default=
"wxHOURGLASS_CURSOR"/>
22776 <destructor name=
"~wxBusyCursor" overloaded=
"no">
22777 <autodoc>__del__(self)
</autodoc>
22780 <class name=
"WindowDisabler" oldname=
"wxWindowDisabler" module=
"_misc">
22781 <constructor name=
"WindowDisabler" overloaded=
"no">
22782 <autodoc>__init__(self, Window winToSkip=None) -
> WindowDisabler
</autodoc>
22784 <param name=
"winToSkip" type=
"Window" default=
"NULL"/>
22787 <destructor name=
"~wxWindowDisabler" overloaded=
"no">
22788 <autodoc>__del__(self)
</autodoc>
22791 <class name=
"BusyInfo" oldname=
"wxBusyInfo" module=
"_misc">
22792 <baseclass name=
"Object"/>
22793 <constructor name=
"BusyInfo" overloaded=
"no">
22794 <autodoc>__init__(self, String message) -
> BusyInfo
</autodoc>
22796 <param name=
"message" type=
"String" default=
""/>
22799 <destructor name=
"~wxBusyInfo" overloaded=
"no">
22800 <autodoc>__del__(self)
</autodoc>
22803 <class name=
"StopWatch" oldname=
"wxStopWatch" module=
"_misc">
22804 <constructor name=
"StopWatch" overloaded=
"no">
22805 <autodoc>__init__(self) -
> StopWatch
</autodoc>
22807 <method name=
"Start" type=
"" overloaded=
"no">
22808 <autodoc>Start(self, long t0=
0)
</autodoc>
22810 <param name=
"t0" type=
"long" default=
"0"/>
22813 <method name=
"Pause" type=
"" overloaded=
"no">
22814 <autodoc>Pause(self)
</autodoc>
22816 <method name=
"Resume" type=
"" overloaded=
"no">
22817 <autodoc>Resume(self)
</autodoc>
22819 <method name=
"Time" type=
"long" overloaded=
"no">
22820 <autodoc>Time(self) -
> long
</autodoc>
22823 <class name=
"FileHistory" oldname=
"wxFileHistory" module=
"_misc">
22824 <baseclass name=
"Object"/>
22825 <constructor name=
"FileHistory" overloaded=
"no">
22826 <autodoc>__init__(self, int maxFiles=
9) -
> FileHistory
</autodoc>
22828 <param name=
"maxFiles" type=
"int" default=
"9"/>
22831 <destructor name=
"~wxFileHistory" overloaded=
"no">
22832 <autodoc>__del__(self)
</autodoc>
22834 <method name=
"AddFileToHistory" type=
"" overloaded=
"no">
22835 <autodoc>AddFileToHistory(self, String file)
</autodoc>
22837 <param name=
"file" type=
"String" default=
""/>
22840 <method name=
"RemoveFileFromHistory" type=
"" overloaded=
"no">
22841 <autodoc>RemoveFileFromHistory(self, int i)
</autodoc>
22843 <param name=
"i" type=
"int" default=
""/>
22846 <method name=
"GetMaxFiles" type=
"int" overloaded=
"no">
22847 <autodoc>GetMaxFiles(self) -
> int
</autodoc>
22849 <method name=
"UseMenu" type=
"" overloaded=
"no">
22850 <autodoc>UseMenu(self, Menu menu)
</autodoc>
22852 <param name=
"menu" type=
"Menu" default=
""/>
22855 <method name=
"RemoveMenu" type=
"" overloaded=
"no">
22856 <autodoc>RemoveMenu(self, Menu menu)
</autodoc>
22858 <param name=
"menu" type=
"Menu" default=
""/>
22861 <method name=
"Load" type=
"" overloaded=
"no">
22862 <autodoc>Load(self, ConfigBase config)
</autodoc>
22864 <param name=
"config" type=
"wxConfigBase" default=
""/>
22867 <method name=
"Save" type=
"" overloaded=
"no">
22868 <autodoc>Save(self, ConfigBase config)
</autodoc>
22870 <param name=
"config" type=
"wxConfigBase" default=
""/>
22873 <method name=
"AddFilesToMenu" type=
"" overloaded=
"no">
22874 <autodoc>AddFilesToMenu(self)
</autodoc>
22876 <method name=
"AddFilesToThisMenu" type=
"" overloaded=
"no">
22877 <autodoc>AddFilesToThisMenu(self, Menu menu)
</autodoc>
22879 <param name=
"menu" type=
"Menu" default=
""/>
22882 <method name=
"GetHistoryFile" type=
"String" overloaded=
"no">
22883 <autodoc>GetHistoryFile(self, int i) -
> String
</autodoc>
22885 <param name=
"i" type=
"int" default=
""/>
22888 <method name=
"GetCount" type=
"int" overloaded=
"no">
22889 <autodoc>GetCount(self) -
> int
</autodoc>
22892 <class name=
"SingleInstanceChecker" oldname=
"wxSingleInstanceChecker" module=
"_misc">
22893 <constructor name=
"SingleInstanceChecker" overloaded=
"no">
22894 <autodoc>__init__(self, String name, String path=EmptyString) -
> SingleInstanceChecker
</autodoc>
22896 <param name=
"name" type=
"String" default=
""/>
22897 <param name=
"path" type=
"String" default=
"wxPyEmptyString"/>
22900 <constructor name=
"PreSingleInstanceChecker" overloaded=
"no">
22901 <autodoc>PreSingleInstanceChecker() -
> SingleInstanceChecker
</autodoc>
22903 <destructor name=
"~wxSingleInstanceChecker" overloaded=
"no">
22904 <autodoc>__del__(self)
</autodoc>
22906 <method name=
"Create" type=
"bool" overloaded=
"no">
22907 <autodoc>Create(self, String name, String path=EmptyString) -
> bool
</autodoc>
22909 <param name=
"name" type=
"String" default=
""/>
22910 <param name=
"path" type=
"String" default=
"wxPyEmptyString"/>
22913 <method name=
"IsAnotherRunning" type=
"bool" overloaded=
"no">
22914 <autodoc>IsAnotherRunning(self) -
> bool
</autodoc>
22917 <method name=
"DrawWindowOnDC" oldname=
"wxDrawWindowOnDC" type=
"" overloaded=
"no">
22918 <autodoc>DrawWindowOnDC(Window window, DC dc, int method)
</autodoc>
22920 <param name=
"window" type=
"Window" default=
""/>
22921 <param name=
"dc" type=
"DC" default=
""/>
22922 <param name=
"method" type=
"int" default=
""/>
22926 #---------------------------------------------------------------------------
22928 <class name=
"TipProvider" oldname=
"wxTipProvider" module=
"_misc">
22929 <destructor name=
"~wxTipProvider" overloaded=
"no">
22930 <autodoc>__del__(self)
</autodoc>
22932 <method name=
"GetTip" type=
"String" overloaded=
"no">
22933 <autodoc>GetTip(self) -
> String
</autodoc>
22935 <method name=
"GetCurrentTip" type=
"size_t" overloaded=
"no">
22936 <autodoc>GetCurrentTip(self) -
> size_t
</autodoc>
22938 <method name=
"PreprocessTip" type=
"String" overloaded=
"no">
22939 <autodoc>PreprocessTip(self, String tip) -
> String
</autodoc>
22941 <param name=
"tip" type=
"String" default=
""/>
22945 <class name=
"PyTipProvider" oldname=
"wxPyTipProvider" module=
"_misc">
22946 <baseclass name=
"TipProvider"/>
22947 <constructor name=
"PyTipProvider" overloaded=
"no">
22948 <autodoc>__init__(self, size_t currentTip) -
> PyTipProvider
</autodoc>
22950 <param name=
"currentTip" type=
"size_t" default=
""/>
22953 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
22954 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
22956 <param name=
"self" type=
"PyObject" default=
""/>
22957 <param name=
"_class" type=
"PyObject" default=
""/>
22961 <method name=
"ShowTip" oldname=
"wxShowTip" type=
"bool" overloaded=
"no">
22962 <autodoc>ShowTip(Window parent, TipProvider tipProvider, bool showAtStartup=True) -
> bool
</autodoc>
22964 <param name=
"parent" type=
"Window" default=
""/>
22965 <param name=
"tipProvider" type=
"TipProvider" default=
""/>
22966 <param name=
"showAtStartup" type=
"bool" default=
"True"/>
22969 <method name=
"CreateFileTipProvider" oldname=
"wxCreateFileTipProvider" type=
"TipProvider" overloaded=
"no">
22970 <autodoc>CreateFileTipProvider(String filename, size_t currentTip) -
> TipProvider
</autodoc>
22972 <param name=
"filename" type=
"String" default=
""/>
22973 <param name=
"currentTip" type=
"size_t" default=
""/>
22977 #---------------------------------------------------------------------------
22979 <class name=
"Timer" oldname=
"wxPyTimer" module=
"_misc">
22980 <baseclass name=
"EvtHandler"/>
22981 <constructor name=
"wxPyTimer" overloaded=
"no">
22982 <autodoc>__init__(self, EvtHandler owner=None, int id=-
1) -
> Timer
</autodoc>
22984 <param name=
"owner" type=
"EvtHandler" default=
"NULL"/>
22985 <param name=
"id" type=
"int" default=
"-1"/>
22988 <destructor name=
"~wxPyTimer" overloaded=
"no">
22989 <autodoc>__del__(self)
</autodoc>
22991 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
22992 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref=
1)
</autodoc>
22994 <param name=
"self" type=
"PyObject" default=
""/>
22995 <param name=
"_class" type=
"PyObject" default=
""/>
22996 <param name=
"incref" type=
"int" default=
"1"/>
22999 <method name=
"SetOwner" type=
"" overloaded=
"no">
23000 <autodoc>SetOwner(self, EvtHandler owner, int id=-
1)
</autodoc>
23002 <param name=
"owner" type=
"EvtHandler" default=
""/>
23003 <param name=
"id" type=
"int" default=
"-1"/>
23006 <method name=
"GetOwner" type=
"EvtHandler" overloaded=
"no">
23007 <autodoc>GetOwner(self) -
> EvtHandler
</autodoc>
23009 <method name=
"Start" type=
"bool" overloaded=
"no">
23010 <autodoc>Start(self, int milliseconds=-
1, bool oneShot=False) -
> bool
</autodoc>
23012 <param name=
"milliseconds" type=
"int" default=
"-1"/>
23013 <param name=
"oneShot" type=
"bool" default=
"False"/>
23016 <method name=
"Stop" type=
"" overloaded=
"no">
23017 <autodoc>Stop(self)
</autodoc>
23019 <method name=
"IsRunning" type=
"bool" overloaded=
"no">
23020 <autodoc>IsRunning(self) -
> bool
</autodoc>
23022 <method name=
"GetInterval" type=
"int" overloaded=
"no">
23023 <autodoc>GetInterval(self) -
> int
</autodoc>
23025 <method name=
"IsOneShot" type=
"bool" overloaded=
"no">
23026 <autodoc>IsOneShot(self) -
> bool
</autodoc>
23028 <method name=
"GetId" type=
"int" overloaded=
"no">
23029 <autodoc>GetId(self) -
> int
</autodoc>
23033 # For backwards compatibility with
2.4
23034 class PyTimer(Timer):
23035 def __init__(self, notify):
23036 Timer.__init__(self)
23037 self.notify = notify
23044 EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER,
1 )
23047 <class name=
"TimerEvent" oldname=
"wxTimerEvent" module=
"_misc">
23048 <baseclass name=
"Event"/>
23049 <constructor name=
"TimerEvent" overloaded=
"no">
23050 <autodoc>__init__(self, int timerid=
0, int interval=
0) -
> TimerEvent
</autodoc>
23052 <param name=
"timerid" type=
"int" default=
"0"/>
23053 <param name=
"interval" type=
"int" default=
"0"/>
23056 <method name=
"GetInterval" type=
"int" overloaded=
"no">
23057 <autodoc>GetInterval(self) -
> int
</autodoc>
23060 <class name=
"TimerRunner" oldname=
"wxTimerRunner" module=
"_misc">
23061 <constructor name=
"TimerRunner" overloaded=
"yes">
23063 <param name=
"timer" type=
"wxTimer" default=
""/>
23066 <constructor name=
"TimerRunner" overloaded=
"yes">
23067 <autodoc>__init__(self, wxTimer timer) -
> TimerRunner
23068 __init__(self, wxTimer timer, int milli, bool oneShot=False) -
> TimerRunner
</autodoc>
23070 <param name=
"timer" type=
"wxTimer" default=
""/>
23071 <param name=
"milli" type=
"int" default=
""/>
23072 <param name=
"oneShot" type=
"bool" default=
"False"/>
23075 <destructor name=
"~wxTimerRunner" overloaded=
"no">
23076 <autodoc>__del__(self)
</autodoc>
23078 <method name=
"Start" type=
"" overloaded=
"no">
23079 <autodoc>Start(self, int milli, bool oneShot=False)
</autodoc>
23081 <param name=
"milli" type=
"int" default=
""/>
23082 <param name=
"oneShot" type=
"bool" default=
"False"/>
23087 #---------------------------------------------------------------------------
23089 <class name=
"Log" oldname=
"wxLog" module=
"_misc">
23090 <constructor name=
"Log" overloaded=
"no">
23091 <autodoc>__init__(self) -
> Log
</autodoc>
23093 <staticmethod name=
"IsEnabled" type=
"bool" overloaded=
"no">
23094 <autodoc>IsEnabled() -
> bool
</autodoc>
23096 <staticmethod name=
"EnableLogging" type=
"bool" overloaded=
"no">
23097 <autodoc>EnableLogging(bool doIt=True) -
> bool
</autodoc>
23099 <param name=
"doIt" type=
"bool" default=
"True"/>
23102 <staticmethod name=
"OnLog" type=
"" overloaded=
"no">
23103 <autodoc>OnLog(wxLogLevel level, wxChar szString, time_t t)
</autodoc>
23105 <param name=
"level" type=
"wxLogLevel" default=
""/>
23106 <param name=
"szString" type=
"wxChar" default=
""/>
23107 <param name=
"t" type=
"time_t" default=
""/>
23110 <method name=
"Flush" type=
"" overloaded=
"no">
23111 <autodoc>Flush(self)
</autodoc>
23113 <staticmethod name=
"FlushActive" type=
"" overloaded=
"no">
23114 <autodoc>FlushActive()
</autodoc>
23116 <staticmethod name=
"GetActiveTarget" type=
"Log" overloaded=
"no">
23117 <autodoc>GetActiveTarget() -
> Log
</autodoc>
23119 <staticmethod name=
"SetActiveTarget" type=
"Log" overloaded=
"no">
23120 <autodoc>SetActiveTarget(Log pLogger) -
> Log
</autodoc>
23122 <param name=
"pLogger" type=
"Log" default=
""/>
23125 <staticmethod name=
"Suspend" type=
"" overloaded=
"no">
23126 <autodoc>Suspend()
</autodoc>
23128 <staticmethod name=
"Resume" type=
"" overloaded=
"no">
23129 <autodoc>Resume()
</autodoc>
23131 <staticmethod name=
"SetVerbose" type=
"" overloaded=
"no">
23132 <autodoc>SetVerbose(bool bVerbose=True)
</autodoc>
23134 <param name=
"bVerbose" type=
"bool" default=
"True"/>
23137 <staticmethod name=
"SetLogLevel" type=
"" overloaded=
"no">
23138 <autodoc>SetLogLevel(wxLogLevel logLevel)
</autodoc>
23140 <param name=
"logLevel" type=
"wxLogLevel" default=
""/>
23143 <staticmethod name=
"DontCreateOnDemand" type=
"" overloaded=
"no">
23144 <autodoc>DontCreateOnDemand()
</autodoc>
23146 <staticmethod name=
"SetTraceMask" type=
"" overloaded=
"no">
23147 <autodoc>SetTraceMask(wxTraceMask ulMask)
</autodoc>
23149 <param name=
"ulMask" type=
"wxTraceMask" default=
""/>
23152 <staticmethod name=
"AddTraceMask" type=
"" overloaded=
"no">
23153 <autodoc>AddTraceMask(String str)
</autodoc>
23155 <param name=
"str" type=
"String" default=
""/>
23158 <staticmethod name=
"RemoveTraceMask" type=
"" overloaded=
"no">
23159 <autodoc>RemoveTraceMask(String str)
</autodoc>
23161 <param name=
"str" type=
"String" default=
""/>
23164 <staticmethod name=
"ClearTraceMasks" type=
"" overloaded=
"no">
23165 <autodoc>ClearTraceMasks()
</autodoc>
23167 <staticmethod name=
"GetTraceMasks" type=
"wxArrayString" overloaded=
"no">
23168 <autodoc>GetTraceMasks() -
> wxArrayString
</autodoc>
23170 <staticmethod name=
"SetTimestamp" type=
"" overloaded=
"no">
23171 <autodoc>SetTimestamp(wxChar ts)
</autodoc>
23173 <param name=
"ts" type=
"wxChar" default=
""/>
23176 <staticmethod name=
"GetVerbose" type=
"bool" overloaded=
"no">
23177 <autodoc>GetVerbose() -
> bool
</autodoc>
23179 <staticmethod name=
"GetTraceMask" type=
"wxTraceMask" overloaded=
"no">
23180 <autodoc>GetTraceMask() -
> wxTraceMask
</autodoc>
23182 <staticmethod name=
"IsAllowedTraceMask" type=
"bool" overloaded=
"no">
23183 <autodoc>IsAllowedTraceMask(wxChar mask) -
> bool
</autodoc>
23185 <param name=
"mask" type=
"wxChar" default=
""/>
23188 <staticmethod name=
"GetLogLevel" type=
"wxLogLevel" overloaded=
"no">
23189 <autodoc>GetLogLevel() -
> wxLogLevel
</autodoc>
23191 <staticmethod name=
"GetTimestamp" type=
"wxChar" overloaded=
"no">
23192 <autodoc>GetTimestamp() -
> wxChar
</autodoc>
23194 <staticmethod name=
"TimeStamp" type=
"String" overloaded=
"no">
23195 <autodoc>TimeStamp() -
> String
</autodoc>
23197 <method name=
"Destroy" type=
"" overloaded=
"no">
23198 <autodoc>Destroy(self)
</autodoc>
23201 <class name=
"LogStderr" oldname=
"wxLogStderr" module=
"_misc">
23202 <baseclass name=
"Log"/>
23203 <constructor name=
"LogStderr" overloaded=
"no">
23204 <autodoc>__init__(self) -
> LogStderr
</autodoc>
23207 <class name=
"LogTextCtrl" oldname=
"wxLogTextCtrl" module=
"_misc">
23208 <baseclass name=
"Log"/>
23209 <constructor name=
"LogTextCtrl" overloaded=
"no">
23210 <autodoc>__init__(self, wxTextCtrl pTextCtrl) -
> LogTextCtrl
</autodoc>
23212 <param name=
"pTextCtrl" type=
"TextCtrl" default=
""/>
23216 <class name=
"LogGui" oldname=
"wxLogGui" module=
"_misc">
23217 <baseclass name=
"Log"/>
23218 <constructor name=
"LogGui" overloaded=
"no">
23219 <autodoc>__init__(self) -
> LogGui
</autodoc>
23222 <class name=
"LogWindow" oldname=
"wxLogWindow" module=
"_misc">
23223 <baseclass name=
"Log"/>
23224 <constructor name=
"LogWindow" overloaded=
"no">
23225 <autodoc>__init__(self, wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -
> LogWindow
</autodoc>
23227 <param name=
"pParent" type=
"Frame" default=
""/>
23228 <param name=
"szTitle" type=
"String" default=
""/>
23229 <param name=
"bShow" type=
"bool" default=
"True"/>
23230 <param name=
"bPassToOld" type=
"bool" default=
"True"/>
23233 <method name=
"Show" type=
"" overloaded=
"no">
23234 <autodoc>Show(self, bool bShow=True)
</autodoc>
23236 <param name=
"bShow" type=
"bool" default=
"True"/>
23239 <method name=
"GetFrame" type=
"Frame" overloaded=
"no">
23240 <autodoc>GetFrame(self) -
> wxFrame
</autodoc>
23242 <method name=
"GetOldLog" type=
"Log" overloaded=
"no">
23243 <autodoc>GetOldLog(self) -
> Log
</autodoc>
23245 <method name=
"IsPassingMessages" type=
"bool" overloaded=
"no">
23246 <autodoc>IsPassingMessages(self) -
> bool
</autodoc>
23248 <method name=
"PassMessages" type=
"" overloaded=
"no">
23249 <autodoc>PassMessages(self, bool bDoPass)
</autodoc>
23251 <param name=
"bDoPass" type=
"bool" default=
""/>
23255 <class name=
"LogChain" oldname=
"wxLogChain" module=
"_misc">
23256 <baseclass name=
"Log"/>
23257 <constructor name=
"LogChain" overloaded=
"no">
23258 <autodoc>__init__(self, Log logger) -
> LogChain
</autodoc>
23260 <param name=
"logger" type=
"Log" default=
""/>
23263 <method name=
"SetLog" type=
"" overloaded=
"no">
23264 <autodoc>SetLog(self, Log logger)
</autodoc>
23266 <param name=
"logger" type=
"Log" default=
""/>
23269 <method name=
"PassMessages" type=
"" overloaded=
"no">
23270 <autodoc>PassMessages(self, bool bDoPass)
</autodoc>
23272 <param name=
"bDoPass" type=
"bool" default=
""/>
23275 <method name=
"IsPassingMessages" type=
"bool" overloaded=
"no">
23276 <autodoc>IsPassingMessages(self) -
> bool
</autodoc>
23278 <method name=
"GetOldLog" type=
"Log" overloaded=
"no">
23279 <autodoc>GetOldLog(self) -
> Log
</autodoc>
23282 <method name=
"SysErrorCode" oldname=
"wxSysErrorCode" type=
"unsigned long" overloaded=
"no">
23283 <autodoc>SysErrorCode() -
> unsigned long
</autodoc>
23285 <method name=
"SysErrorMsg" oldname=
"wxSysErrorMsg" type=
"String" overloaded=
"no">
23286 <autodoc>SysErrorMsg(unsigned long nErrCode=
0) -
> String
</autodoc>
23288 <param name=
"nErrCode" type=
"unsigned long" default=
"0"/>
23291 <method name=
"LogFatalError" oldname=
"wxLogFatalError" type=
"" overloaded=
"no">
23292 <autodoc>LogFatalError(String msg)
</autodoc>
23294 <param name=
"msg" type=
"String" default=
""/>
23297 <method name=
"LogError" oldname=
"wxLogError" type=
"" overloaded=
"no">
23298 <autodoc>LogError(String msg)
</autodoc>
23300 <param name=
"msg" type=
"String" default=
""/>
23303 <method name=
"LogWarning" oldname=
"wxLogWarning" type=
"" overloaded=
"no">
23304 <autodoc>LogWarning(String msg)
</autodoc>
23306 <param name=
"msg" type=
"String" default=
""/>
23309 <method name=
"LogMessage" oldname=
"wxLogMessage" type=
"" overloaded=
"no">
23310 <autodoc>LogMessage(String msg)
</autodoc>
23312 <param name=
"msg" type=
"String" default=
""/>
23315 <method name=
"LogInfo" oldname=
"wxLogInfo" type=
"" overloaded=
"no">
23316 <autodoc>LogInfo(String msg)
</autodoc>
23318 <param name=
"msg" type=
"String" default=
""/>
23321 <method name=
"LogDebug" oldname=
"wxLogDebug" type=
"" overloaded=
"no">
23322 <autodoc>LogDebug(String msg)
</autodoc>
23324 <param name=
"msg" type=
"String" default=
""/>
23327 <method name=
"LogVerbose" oldname=
"wxLogVerbose" type=
"" overloaded=
"no">
23328 <autodoc>LogVerbose(String msg)
</autodoc>
23330 <param name=
"msg" type=
"String" default=
""/>
23333 <method name=
"LogStatus" oldname=
"wxLogStatus" type=
"" overloaded=
"no">
23334 <autodoc>LogStatus(String msg)
</autodoc>
23336 <param name=
"msg" type=
"String" default=
""/>
23339 <method name=
"LogStatusFrame" oldname=
"wxLogStatus" type=
"" overloaded=
"no">
23340 <autodoc>LogStatusFrame(wxFrame pFrame, String msg)
</autodoc>
23342 <param name=
"pFrame" type=
"Frame" default=
""/>
23343 <param name=
"msg" type=
"String" default=
""/>
23346 <method name=
"LogSysError" oldname=
"wxLogSysError" type=
"" overloaded=
"no">
23347 <autodoc>LogSysError(String msg)
</autodoc>
23349 <param name=
"msg" type=
"String" default=
""/>
23352 <method name=
"LogTrace" oldname=
"wxLogTrace" type=
"" overloaded=
"yes">
23354 <param name=
"mask" type=
"unsigned long" default=
""/>
23355 <param name=
"msg" type=
"String" default=
""/>
23358 <method name=
"LogTrace" oldname=
"wxLogTrace" type=
"" overloaded=
"yes">
23359 <autodoc>LogTrace(unsigned long mask, String msg)
23360 LogTrace(String mask, String msg)
</autodoc>
23362 <param name=
"mask" type=
"String" default=
""/>
23363 <param name=
"msg" type=
"String" default=
""/>
23366 <method name=
"LogGeneric" oldname=
"wxLogGeneric" type=
"" overloaded=
"no">
23367 <autodoc>LogGeneric(unsigned long level, String msg)
</autodoc>
23369 <param name=
"level" type=
"unsigned long" default=
""/>
23370 <param name=
"msg" type=
"String" default=
""/>
23373 <method name=
"SafeShowMessage" oldname=
"wxSafeShowMessage" type=
"" overloaded=
"no">
23374 <autodoc>SafeShowMessage(String title, String text)
</autodoc>
23376 <param name=
"title" type=
"String" default=
""/>
23377 <param name=
"text" type=
"String" default=
""/>
23380 <class name=
"LogNull" oldname=
"wxLogNull" module=
"_misc">
23381 <constructor name=
"LogNull" overloaded=
"no">
23382 <autodoc>__init__(self) -
> LogNull
</autodoc>
23384 <destructor name=
"~wxLogNull" overloaded=
"no">
23385 <autodoc>__del__(self)
</autodoc>
23388 <class name=
"PyLog" oldname=
"wxPyLog" module=
"_misc">
23389 <baseclass name=
"Log"/>
23390 <constructor name=
"PyLog" overloaded=
"no">
23391 <autodoc>__init__(self) -
> PyLog
</autodoc>
23393 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
23394 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
23396 <param name=
"self" type=
"PyObject" default=
""/>
23397 <param name=
"_class" type=
"PyObject" default=
""/>
23402 #---------------------------------------------------------------------------
23404 <class name=
"Process" oldname=
"wxPyProcess" module=
"_misc">
23405 <baseclass name=
"EvtHandler"/>
23406 <constructor name=
"wxPyProcess" overloaded=
"no">
23407 <autodoc>__init__(self, EvtHandler parent=None, int id=-
1) -
> Process
</autodoc>
23409 <param name=
"parent" type=
"EvtHandler" default=
"NULL"/>
23410 <param name=
"id" type=
"int" default=
"-1"/>
23413 <staticmethod name=
"Kill" type=
"wxKillError" overloaded=
"no">
23414 <autodoc>Kill(int pid, int sig=SIGTERM) -
> int
</autodoc>
23416 <param name=
"pid" type=
"int" default=
""/>
23417 <param name=
"sig" type=
"wxSignal" default=
"wxSIGTERM"/>
23420 <staticmethod name=
"Exists" type=
"bool" overloaded=
"no">
23421 <autodoc>Exists(int pid) -
> bool
</autodoc>
23423 <param name=
"pid" type=
"int" default=
""/>
23426 <staticmethod name=
"Open" type=
"Process" overloaded=
"no">
23427 <autodoc>Open(String cmd, int flags=EXEC_ASYNC) -
> Process
</autodoc>
23429 <param name=
"cmd" type=
"String" default=
""/>
23430 <param name=
"flags" type=
"int" default=
"wxEXEC_ASYNC"/>
23433 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
23434 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
23436 <param name=
"self" type=
"PyObject" default=
""/>
23437 <param name=
"_class" type=
"PyObject" default=
""/>
23440 <method name=
"base_OnTerminate" type=
"" overloaded=
"no">
23441 <autodoc>base_OnTerminate(self, int pid, int status)
</autodoc>
23443 <param name=
"pid" type=
"int" default=
""/>
23444 <param name=
"status" type=
"int" default=
""/>
23447 <method name=
"Redirect" type=
"" overloaded=
"no">
23448 <autodoc>Redirect(self)
</autodoc>
23450 <method name=
"IsRedirected" type=
"bool" overloaded=
"no">
23451 <autodoc>IsRedirected(self) -
> bool
</autodoc>
23453 <method name=
"Detach" type=
"" overloaded=
"no">
23454 <autodoc>Detach(self)
</autodoc>
23456 <method name=
"GetInputStream" type=
"wxInputStream" overloaded=
"no">
23457 <autodoc>GetInputStream(self) -
> InputStream
</autodoc>
23459 <method name=
"GetErrorStream" type=
"wxInputStream" overloaded=
"no">
23460 <autodoc>GetErrorStream(self) -
> InputStream
</autodoc>
23462 <method name=
"GetOutputStream" type=
"OutputStream" overloaded=
"no">
23463 <autodoc>GetOutputStream(self) -
> OutputStream
</autodoc>
23465 <method name=
"CloseOutput" type=
"" overloaded=
"no">
23466 <autodoc>CloseOutput(self)
</autodoc>
23468 <method name=
"IsInputOpened" type=
"bool" overloaded=
"no">
23469 <autodoc>IsInputOpened(self) -
> bool
</autodoc>
23471 <method name=
"IsInputAvailable" type=
"bool" overloaded=
"no">
23472 <autodoc>IsInputAvailable(self) -
> bool
</autodoc>
23474 <method name=
"IsErrorAvailable" type=
"bool" overloaded=
"no">
23475 <autodoc>IsErrorAvailable(self) -
> bool
</autodoc>
23478 <class name=
"ProcessEvent" oldname=
"wxProcessEvent" module=
"_misc">
23479 <baseclass name=
"Event"/>
23480 <constructor name=
"ProcessEvent" overloaded=
"no">
23481 <autodoc>__init__(self, int id=
0, int pid=
0, int exitcode=
0) -
> ProcessEvent
</autodoc>
23483 <param name=
"id" type=
"int" default=
"0"/>
23484 <param name=
"pid" type=
"int" default=
"0"/>
23485 <param name=
"exitcode" type=
"int" default=
"0"/>
23488 <method name=
"GetPid" type=
"int" overloaded=
"no">
23489 <autodoc>GetPid(self) -
> int
</autodoc>
23491 <method name=
"GetExitCode" type=
"int" overloaded=
"no">
23492 <autodoc>GetExitCode(self) -
> int
</autodoc>
23494 <property name=
"m_pid" type=
"int" readonly=
"no"/>
23495 <property name=
"m_exitcode" type=
"int" readonly=
"no"/>
23498 EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS,
1 )
23500 <method name=
"Execute" oldname=
"wxExecute" type=
"long" overloaded=
"no">
23501 <autodoc>Execute(String command, int flags=EXEC_ASYNC, Process process=None) -
> long
</autodoc>
23503 <param name=
"command" type=
"String" default=
""/>
23504 <param name=
"flags" type=
"int" default=
"wxEXEC_ASYNC"/>
23505 <param name=
"process" type=
"Process" default=
"NULL"/>
23509 #---------------------------------------------------------------------------
23511 <class name=
"Joystick" oldname=
"wxJoystick" module=
"_misc">
23512 <constructor name=
"Joystick" overloaded=
"no">
23513 <autodoc>__init__(self, int joystick=JOYSTICK1) -
> Joystick
</autodoc>
23515 <param name=
"joystick" type=
"int" default=
"wxJOYSTICK1"/>
23518 <destructor name=
"~wxJoystick" overloaded=
"no">
23519 <autodoc>__del__(self)
</autodoc>
23521 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
23522 <autodoc>GetPosition(self) -
> Point
</autodoc>
23524 <method name=
"GetZPosition" type=
"int" overloaded=
"no">
23525 <autodoc>GetZPosition(self) -
> int
</autodoc>
23527 <method name=
"GetButtonState" type=
"int" overloaded=
"no">
23528 <autodoc>GetButtonState(self) -
> int
</autodoc>
23530 <method name=
"GetPOVPosition" type=
"int" overloaded=
"no">
23531 <autodoc>GetPOVPosition(self) -
> int
</autodoc>
23533 <method name=
"GetPOVCTSPosition" type=
"int" overloaded=
"no">
23534 <autodoc>GetPOVCTSPosition(self) -
> int
</autodoc>
23536 <method name=
"GetRudderPosition" type=
"int" overloaded=
"no">
23537 <autodoc>GetRudderPosition(self) -
> int
</autodoc>
23539 <method name=
"GetUPosition" type=
"int" overloaded=
"no">
23540 <autodoc>GetUPosition(self) -
> int
</autodoc>
23542 <method name=
"GetVPosition" type=
"int" overloaded=
"no">
23543 <autodoc>GetVPosition(self) -
> int
</autodoc>
23545 <method name=
"GetMovementThreshold" type=
"int" overloaded=
"no">
23546 <autodoc>GetMovementThreshold(self) -
> int
</autodoc>
23548 <method name=
"SetMovementThreshold" type=
"" overloaded=
"no">
23549 <autodoc>SetMovementThreshold(self, int threshold)
</autodoc>
23551 <param name=
"threshold" type=
"int" default=
""/>
23554 <method name=
"IsOk" type=
"bool" overloaded=
"no">
23555 <autodoc>IsOk(self) -
> bool
</autodoc>
23557 <method name=
"GetNumberJoysticks" type=
"int" overloaded=
"no">
23558 <autodoc>GetNumberJoysticks(self) -
> int
</autodoc>
23560 <method name=
"GetManufacturerId" type=
"int" overloaded=
"no">
23561 <autodoc>GetManufacturerId(self) -
> int
</autodoc>
23563 <method name=
"GetProductId" type=
"int" overloaded=
"no">
23564 <autodoc>GetProductId(self) -
> int
</autodoc>
23566 <method name=
"GetProductName" type=
"String" overloaded=
"no">
23567 <autodoc>GetProductName(self) -
> String
</autodoc>
23569 <method name=
"GetXMin" type=
"int" overloaded=
"no">
23570 <autodoc>GetXMin(self) -
> int
</autodoc>
23572 <method name=
"GetYMin" type=
"int" overloaded=
"no">
23573 <autodoc>GetYMin(self) -
> int
</autodoc>
23575 <method name=
"GetZMin" type=
"int" overloaded=
"no">
23576 <autodoc>GetZMin(self) -
> int
</autodoc>
23578 <method name=
"GetXMax" type=
"int" overloaded=
"no">
23579 <autodoc>GetXMax(self) -
> int
</autodoc>
23581 <method name=
"GetYMax" type=
"int" overloaded=
"no">
23582 <autodoc>GetYMax(self) -
> int
</autodoc>
23584 <method name=
"GetZMax" type=
"int" overloaded=
"no">
23585 <autodoc>GetZMax(self) -
> int
</autodoc>
23587 <method name=
"GetNumberButtons" type=
"int" overloaded=
"no">
23588 <autodoc>GetNumberButtons(self) -
> int
</autodoc>
23590 <method name=
"GetNumberAxes" type=
"int" overloaded=
"no">
23591 <autodoc>GetNumberAxes(self) -
> int
</autodoc>
23593 <method name=
"GetMaxButtons" type=
"int" overloaded=
"no">
23594 <autodoc>GetMaxButtons(self) -
> int
</autodoc>
23596 <method name=
"GetMaxAxes" type=
"int" overloaded=
"no">
23597 <autodoc>GetMaxAxes(self) -
> int
</autodoc>
23599 <method name=
"GetPollingMin" type=
"int" overloaded=
"no">
23600 <autodoc>GetPollingMin(self) -
> int
</autodoc>
23602 <method name=
"GetPollingMax" type=
"int" overloaded=
"no">
23603 <autodoc>GetPollingMax(self) -
> int
</autodoc>
23605 <method name=
"GetRudderMin" type=
"int" overloaded=
"no">
23606 <autodoc>GetRudderMin(self) -
> int
</autodoc>
23608 <method name=
"GetRudderMax" type=
"int" overloaded=
"no">
23609 <autodoc>GetRudderMax(self) -
> int
</autodoc>
23611 <method name=
"GetUMin" type=
"int" overloaded=
"no">
23612 <autodoc>GetUMin(self) -
> int
</autodoc>
23614 <method name=
"GetUMax" type=
"int" overloaded=
"no">
23615 <autodoc>GetUMax(self) -
> int
</autodoc>
23617 <method name=
"GetVMin" type=
"int" overloaded=
"no">
23618 <autodoc>GetVMin(self) -
> int
</autodoc>
23620 <method name=
"GetVMax" type=
"int" overloaded=
"no">
23621 <autodoc>GetVMax(self) -
> int
</autodoc>
23623 <method name=
"HasRudder" type=
"bool" overloaded=
"no">
23624 <autodoc>HasRudder(self) -
> bool
</autodoc>
23626 <method name=
"HasZ" type=
"bool" overloaded=
"no">
23627 <autodoc>HasZ(self) -
> bool
</autodoc>
23629 <method name=
"HasU" type=
"bool" overloaded=
"no">
23630 <autodoc>HasU(self) -
> bool
</autodoc>
23632 <method name=
"HasV" type=
"bool" overloaded=
"no">
23633 <autodoc>HasV(self) -
> bool
</autodoc>
23635 <method name=
"HasPOV" type=
"bool" overloaded=
"no">
23636 <autodoc>HasPOV(self) -
> bool
</autodoc>
23638 <method name=
"HasPOV4Dir" type=
"bool" overloaded=
"no">
23639 <autodoc>HasPOV4Dir(self) -
> bool
</autodoc>
23641 <method name=
"HasPOVCTS" type=
"bool" overloaded=
"no">
23642 <autodoc>HasPOVCTS(self) -
> bool
</autodoc>
23644 <method name=
"SetCapture" type=
"bool" overloaded=
"no">
23645 <autodoc>SetCapture(self, Window win, int pollingFreq=
0) -
> bool
</autodoc>
23647 <param name=
"win" type=
"Window" default=
""/>
23648 <param name=
"pollingFreq" type=
"int" default=
"0"/>
23651 <method name=
"ReleaseCapture" type=
"bool" overloaded=
"no">
23652 <autodoc>ReleaseCapture(self) -
> bool
</autodoc>
23655 <class name=
"JoystickEvent" oldname=
"wxJoystickEvent" module=
"_misc">
23656 <baseclass name=
"Event"/>
23657 <constructor name=
"JoystickEvent" overloaded=
"no">
23658 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int state=
0, int joystick=JOYSTICK1,
23659 int change=
0) -
> JoystickEvent
</autodoc>
23661 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
23662 <param name=
"state" type=
"int" default=
"0"/>
23663 <param name=
"joystick" type=
"int" default=
"wxJOYSTICK1"/>
23664 <param name=
"change" type=
"int" default=
"0"/>
23667 <property name=
"m_pos" type=
"Point" readonly=
"no"/>
23668 <property name=
"m_zPosition" type=
"int" readonly=
"no"/>
23669 <property name=
"m_buttonChange" type=
"int" readonly=
"no"/>
23670 <property name=
"m_buttonState" type=
"int" readonly=
"no"/>
23671 <property name=
"m_joyStick" type=
"int" readonly=
"no"/>
23672 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
23673 <autodoc>GetPosition(self) -
> Point
</autodoc>
23675 <method name=
"GetZPosition" type=
"int" overloaded=
"no">
23676 <autodoc>GetZPosition(self) -
> int
</autodoc>
23678 <method name=
"GetButtonState" type=
"int" overloaded=
"no">
23679 <autodoc>GetButtonState(self) -
> int
</autodoc>
23681 <method name=
"GetButtonChange" type=
"int" overloaded=
"no">
23682 <autodoc>GetButtonChange(self) -
> int
</autodoc>
23684 <method name=
"GetJoystick" type=
"int" overloaded=
"no">
23685 <autodoc>GetJoystick(self) -
> int
</autodoc>
23687 <method name=
"SetJoystick" type=
"" overloaded=
"no">
23688 <autodoc>SetJoystick(self, int stick)
</autodoc>
23690 <param name=
"stick" type=
"int" default=
""/>
23693 <method name=
"SetButtonState" type=
"" overloaded=
"no">
23694 <autodoc>SetButtonState(self, int state)
</autodoc>
23696 <param name=
"state" type=
"int" default=
""/>
23699 <method name=
"SetButtonChange" type=
"" overloaded=
"no">
23700 <autodoc>SetButtonChange(self, int change)
</autodoc>
23702 <param name=
"change" type=
"int" default=
""/>
23705 <method name=
"SetPosition" type=
"" overloaded=
"no">
23706 <autodoc>SetPosition(self, Point pos)
</autodoc>
23708 <param name=
"pos" type=
"Point" default=
""/>
23711 <method name=
"SetZPosition" type=
"" overloaded=
"no">
23712 <autodoc>SetZPosition(self, int zPos)
</autodoc>
23714 <param name=
"zPos" type=
"int" default=
""/>
23717 <method name=
"IsButton" type=
"bool" overloaded=
"no">
23718 <autodoc>IsButton(self) -
> bool
</autodoc>
23720 <method name=
"IsMove" type=
"bool" overloaded=
"no">
23721 <autodoc>IsMove(self) -
> bool
</autodoc>
23723 <method name=
"IsZMove" type=
"bool" overloaded=
"no">
23724 <autodoc>IsZMove(self) -
> bool
</autodoc>
23726 <method name=
"ButtonDown" type=
"bool" overloaded=
"no">
23727 <autodoc>ButtonDown(self, int but=JOY_BUTTON_ANY) -
> bool
</autodoc>
23729 <param name=
"but" type=
"int" default=
"wxJOY_BUTTON_ANY"/>
23732 <method name=
"ButtonUp" type=
"bool" overloaded=
"no">
23733 <autodoc>ButtonUp(self, int but=JOY_BUTTON_ANY) -
> bool
</autodoc>
23735 <param name=
"but" type=
"int" default=
"wxJOY_BUTTON_ANY"/>
23738 <method name=
"ButtonIsDown" type=
"bool" overloaded=
"no">
23739 <autodoc>ButtonIsDown(self, int but=JOY_BUTTON_ANY) -
> bool
</autodoc>
23741 <param name=
"but" type=
"int" default=
"wxJOY_BUTTON_ANY"/>
23746 EVT_JOY_BUTTON_DOWN = wx.PyEventBinder( wxEVT_JOY_BUTTON_DOWN )
23747 EVT_JOY_BUTTON_UP = wx.PyEventBinder( wxEVT_JOY_BUTTON_UP )
23748 EVT_JOY_MOVE = wx.PyEventBinder( wxEVT_JOY_MOVE )
23749 EVT_JOY_ZMOVE = wx.PyEventBinder( wxEVT_JOY_ZMOVE )
23751 EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN,
23752 wxEVT_JOY_BUTTON_UP,
23759 #---------------------------------------------------------------------------
23761 <class name=
"Sound" oldname=
"wxSound" module=
"_misc">
23762 <constructor name=
"Sound" overloaded=
"no">
23763 <autodoc>__init__(self, String fileName=EmptyString) -
> Sound
</autodoc>
23765 <param name=
"fileName" type=
"String" default=
"wxPyEmptyString"/>
23768 <constructor name=
"SoundFromData" overloaded=
"no">
23769 <autodoc>SoundFromData(PyObject data) -
> Sound
</autodoc>
23771 <param name=
"data" type=
"PyObject" default=
""/>
23774 <destructor name=
"~wxSound" overloaded=
"no">
23775 <autodoc>__del__(self)
</autodoc>
23777 <method name=
"Create" type=
"bool" overloaded=
"no">
23778 <autodoc>Create(self, String fileName) -
> bool
</autodoc>
23780 <param name=
"fileName" type=
"String" default=
""/>
23783 <method name=
"CreateFromData" type=
"bool" overloaded=
"no">
23784 <autodoc>CreateFromData(self, PyObject data) -
> bool
</autodoc>
23786 <param name=
"data" type=
"PyObject" default=
""/>
23789 <method name=
"IsOk" type=
"bool" overloaded=
"no">
23790 <autodoc>IsOk(self) -
> bool
</autodoc>
23792 <method name=
"Play" type=
"bool" overloaded=
"no">
23793 <autodoc>Play(self, unsigned int flags=SOUND_ASYNC) -
> bool
</autodoc>
23795 <param name=
"flags" type=
"unsigned int" default=
"wxSOUND_ASYNC"/>
23798 <staticmethod name=
"PlaySound" type=
"bool" overloaded=
"no">
23799 <autodoc>PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -
> bool
</autodoc>
23801 <param name=
"filename" type=
"String" default=
""/>
23802 <param name=
"flags" type=
"unsigned int" default=
"wxSOUND_ASYNC"/>
23805 <staticmethod name=
"Stop" type=
"" overloaded=
"no">
23806 <autodoc>Stop()
</autodoc>
23810 #---------------------------------------------------------------------------
23812 <class name=
"FileTypeInfo" oldname=
"wxFileTypeInfo" module=
"_misc">
23813 <constructor name=
"FileTypeInfo" overloaded=
"no">
23814 <autodoc>__init__(self, String mimeType, String openCmd, String printCmd, String desc) -
> FileTypeInfo
</autodoc>
23816 <param name=
"mimeType" type=
"String" default=
""/>
23817 <param name=
"openCmd" type=
"String" default=
""/>
23818 <param name=
"printCmd" type=
"String" default=
""/>
23819 <param name=
"desc" type=
"String" default=
""/>
23822 <constructor name=
"FileTypeInfoSequence" overloaded=
"no">
23823 <autodoc>FileTypeInfoSequence(wxArrayString sArray) -
> FileTypeInfo
</autodoc>
23825 <param name=
"sArray" type=
"wxArrayString" default=
""/>
23828 <constructor name=
"NullFileTypeInfo" overloaded=
"no">
23829 <autodoc>NullFileTypeInfo() -
> FileTypeInfo
</autodoc>
23831 <method name=
"IsValid" type=
"bool" overloaded=
"no">
23832 <autodoc>IsValid(self) -
> bool
</autodoc>
23834 <method name=
"SetIcon" type=
"" overloaded=
"no">
23835 <autodoc>SetIcon(self, String iconFile, int iconIndex=
0)
</autodoc>
23837 <param name=
"iconFile" type=
"String" default=
""/>
23838 <param name=
"iconIndex" type=
"int" default=
"0"/>
23841 <method name=
"SetShortDesc" type=
"" overloaded=
"no">
23842 <autodoc>SetShortDesc(self, String shortDesc)
</autodoc>
23844 <param name=
"shortDesc" type=
"String" default=
""/>
23847 <method name=
"GetMimeType" type=
"String" overloaded=
"no">
23848 <autodoc>GetMimeType(self) -
> String
</autodoc>
23850 <method name=
"GetOpenCommand" type=
"String" overloaded=
"no">
23851 <autodoc>GetOpenCommand(self) -
> String
</autodoc>
23853 <method name=
"GetPrintCommand" type=
"String" overloaded=
"no">
23854 <autodoc>GetPrintCommand(self) -
> String
</autodoc>
23856 <method name=
"GetShortDesc" type=
"String" overloaded=
"no">
23857 <autodoc>GetShortDesc(self) -
> String
</autodoc>
23859 <method name=
"GetDescription" type=
"String" overloaded=
"no">
23860 <autodoc>GetDescription(self) -
> String
</autodoc>
23862 <method name=
"GetExtensions" type=
"wxArrayString" overloaded=
"no">
23863 <autodoc>GetExtensions(self) -
> wxArrayString
</autodoc>
23865 <method name=
"GetExtensionsCount" type=
"int" overloaded=
"no">
23866 <autodoc>GetExtensionsCount(self) -
> int
</autodoc>
23868 <method name=
"GetIconFile" type=
"String" overloaded=
"no">
23869 <autodoc>GetIconFile(self) -
> String
</autodoc>
23871 <method name=
"GetIconIndex" type=
"int" overloaded=
"no">
23872 <autodoc>GetIconIndex(self) -
> int
</autodoc>
23875 <class name=
"FileType" oldname=
"wxFileType" module=
"_misc">
23876 <constructor name=
"FileType" overloaded=
"no">
23877 <autodoc>__init__(self, FileTypeInfo ftInfo) -
> FileType
</autodoc>
23879 <param name=
"ftInfo" type=
"FileTypeInfo" default=
""/>
23882 <destructor name=
"~wxFileType" overloaded=
"no">
23883 <autodoc>__del__(self)
</autodoc>
23885 <method name=
"GetMimeType" type=
"PyObject" overloaded=
"no">
23886 <autodoc>GetMimeType(self) -
> PyObject
</autodoc>
23888 <method name=
"GetMimeTypes" type=
"PyObject" overloaded=
"no">
23889 <autodoc>GetMimeTypes(self) -
> PyObject
</autodoc>
23891 <method name=
"GetExtensions" type=
"PyObject" overloaded=
"no">
23892 <autodoc>GetExtensions(self) -
> PyObject
</autodoc>
23894 <method name=
"GetIcon" type=
"Icon" overloaded=
"no">
23895 <autodoc>GetIcon(self) -
> Icon
</autodoc>
23897 <method name=
"GetIconInfo" type=
"PyObject" overloaded=
"no">
23898 <autodoc>GetIconInfo(self) -
> PyObject
</autodoc>
23900 <method name=
"GetDescription" type=
"PyObject" overloaded=
"no">
23901 <autodoc>GetDescription(self) -
> PyObject
</autodoc>
23903 <method name=
"GetOpenCommand" type=
"PyObject" overloaded=
"no">
23904 <autodoc>GetOpenCommand(self, String filename, String mimetype=EmptyString) -
> PyObject
</autodoc>
23906 <param name=
"filename" type=
"String" default=
""/>
23907 <param name=
"mimetype" type=
"String" default=
"wxPyEmptyString"/>
23910 <method name=
"GetPrintCommand" type=
"PyObject" overloaded=
"no">
23911 <autodoc>GetPrintCommand(self, String filename, String mimetype=EmptyString) -
> PyObject
</autodoc>
23913 <param name=
"filename" type=
"String" default=
""/>
23914 <param name=
"mimetype" type=
"String" default=
"wxPyEmptyString"/>
23917 <method name=
"GetAllCommands" type=
"PyObject" overloaded=
"no">
23918 <autodoc>GetAllCommands(self, String filename, String mimetype=EmptyString) -
> PyObject
</autodoc>
23920 <param name=
"filename" type=
"String" default=
""/>
23921 <param name=
"mimetype" type=
"String" default=
"wxPyEmptyString"/>
23924 <method name=
"SetCommand" type=
"bool" overloaded=
"no">
23925 <autodoc>SetCommand(self, String cmd, String verb, bool overwriteprompt=True) -
> bool
</autodoc>
23927 <param name=
"cmd" type=
"String" default=
""/>
23928 <param name=
"verb" type=
"String" default=
""/>
23929 <param name=
"overwriteprompt" type=
"bool" default=
"True"/>
23932 <method name=
"SetDefaultIcon" type=
"bool" overloaded=
"no">
23933 <autodoc>SetDefaultIcon(self, String cmd=EmptyString, int index=
0) -
> bool
</autodoc>
23935 <param name=
"cmd" type=
"String" default=
"wxPyEmptyString"/>
23936 <param name=
"index" type=
"int" default=
"0"/>
23939 <method name=
"Unassociate" type=
"bool" overloaded=
"no">
23940 <autodoc>Unassociate(self) -
> bool
</autodoc>
23942 <staticmethod name=
"ExpandCommand" type=
"String" overloaded=
"no">
23943 <autodoc>ExpandCommand(String command, String filename, String mimetype=EmptyString) -
> String
</autodoc>
23945 <param name=
"command" type=
"String" default=
""/>
23946 <param name=
"filename" type=
"String" default=
""/>
23947 <param name=
"mimetype" type=
"String" default=
"wxPyEmptyString"/>
23951 <class name=
"MimeTypesManager" oldname=
"wxMimeTypesManager" module=
"_misc">
23952 <constructor name=
"MimeTypesManager" overloaded=
"no">
23953 <autodoc>__init__(self) -
> MimeTypesManager
</autodoc>
23955 <destructor name=
"~wxMimeTypesManager" overloaded=
"no">
23956 <autodoc>__del__(self)
</autodoc>
23958 <staticmethod name=
"IsOfType" type=
"bool" overloaded=
"no">
23959 <autodoc>IsOfType(String mimeType, String wildcard) -
> bool
</autodoc>
23961 <param name=
"mimeType" type=
"String" default=
""/>
23962 <param name=
"wildcard" type=
"String" default=
""/>
23965 <method name=
"Initialize" type=
"" overloaded=
"no">
23966 <autodoc>Initialize(self, int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString)
</autodoc>
23968 <param name=
"mailcapStyle" type=
"int" default=
"wxMAILCAP_ALL"/>
23969 <param name=
"extraDir" type=
"String" default=
"wxPyEmptyString"/>
23972 <method name=
"ClearData" type=
"" overloaded=
"no">
23973 <autodoc>ClearData(self)
</autodoc>
23975 <method name=
"GetFileTypeFromExtension" type=
"FileType" overloaded=
"no">
23976 <autodoc>GetFileTypeFromExtension(self, String ext) -
> FileType
</autodoc>
23978 <param name=
"ext" type=
"String" default=
""/>
23981 <method name=
"GetFileTypeFromMimeType" type=
"FileType" overloaded=
"no">
23982 <autodoc>GetFileTypeFromMimeType(self, String mimeType) -
> FileType
</autodoc>
23984 <param name=
"mimeType" type=
"String" default=
""/>
23987 <method name=
"ReadMailcap" type=
"bool" overloaded=
"no">
23988 <autodoc>ReadMailcap(self, String filename, bool fallback=False) -
> bool
</autodoc>
23990 <param name=
"filename" type=
"String" default=
""/>
23991 <param name=
"fallback" type=
"bool" default=
"False"/>
23994 <method name=
"ReadMimeTypes" type=
"bool" overloaded=
"no">
23995 <autodoc>ReadMimeTypes(self, String filename) -
> bool
</autodoc>
23997 <param name=
"filename" type=
"String" default=
""/>
24000 <method name=
"EnumAllFileTypes" type=
"PyObject" overloaded=
"no">
24001 <autodoc>EnumAllFileTypes(self) -
> PyObject
</autodoc>
24003 <method name=
"AddFallback" type=
"" overloaded=
"no">
24004 <autodoc>AddFallback(self, FileTypeInfo ft)
</autodoc>
24006 <param name=
"ft" type=
"FileTypeInfo" default=
""/>
24009 <method name=
"Associate" type=
"FileType" overloaded=
"no">
24010 <autodoc>Associate(self, FileTypeInfo ftInfo) -
> FileType
</autodoc>
24012 <param name=
"ftInfo" type=
"FileTypeInfo" default=
""/>
24015 <method name=
"Unassociate" type=
"bool" overloaded=
"no">
24016 <autodoc>Unassociate(self, FileType ft) -
> bool
</autodoc>
24018 <param name=
"ft" type=
"FileType" default=
""/>
24023 #---------------------------------------------------------------------------
24025 <class name=
"ArtProvider" oldname=
"wxPyArtProvider" module=
"_misc">
24026 <docstring>The wx.ArtProvider class is used to customize the look of wxWidgets
24027 application. When wxWidgets needs to display an icon or a bitmap (e.g.
24028 in the standard file dialog), it does not use hard-coded resource but
24029 asks wx.ArtProvider for it instead. This way the users can plug in
24030 their own wx.ArtProvider class and easily replace standard art with
24031 his/her own version. It is easy thing to do: all that is needed is
24032 to derive a class from wx.ArtProvider, override it's CreateBitmap
24033 method and register the provider with wx.ArtProvider.PushProvider::
24035 class MyArtProvider(wx.ArtProvider):
24036 def __init__(self):
24037 wx.ArtProvider.__init__(self)
24039 def CreateBitmap(self, artid, client, size):
24044 Identifying art resources
24045 -------------------------
24047 Every bitmap is known to wx.ArtProvider under an unique ID that is
24048 used when requesting a resource from it. The IDs can have one of these
24051 * wx.ART_ADD_BOOKMARK
24052 * wx.ART_DEL_BOOKMARK
24053 * wx.ART_HELP_SIDE_PANEL
24054 * wx.ART_HELP_SETTINGS
24056 * wx.ART_HELP_FOLDER
24059 * wx.ART_GO_FORWARD
24062 * wx.ART_GO_TO_PARENT
24068 * wx.ART_REPORT_VIEW
24073 * wx.ART_EXECUTABLE_FILE
24074 * wx.ART_NORMAL_FILE
24076 * wx.ART_CROSS_MARK
24080 * wx.ART_INFORMATION
24081 * wx.ART_MISSING_IMAGE
24087 The Client is the entity that calls wx.ArtProvider's `GetBitmap` or
24088 `GetIcon` function. Client IDs server as a hint to wx.ArtProvider
24089 that is supposed to help it to choose the best looking bitmap. For
24090 example it is often desirable to use slightly different icons in menus
24091 and toolbars even though they represent the same action (e.g.
24092 wx.ART_FILE_OPEN). Remember that this is really only a hint for
24093 wx.ArtProvider -- it is common that `wx.ArtProvider.GetBitmap` returns
24094 identical bitmap for different client values!
24098 * wx.ART_FRAME_ICON
24099 * wx.ART_CMN_DIALOG
24100 * wx.ART_HELP_BROWSER
24101 * wx.ART_MESSAGE_BOX
24102 * wx.ART_OTHER (used for all requests that don't fit into any
24103 of the categories above)
24105 <constructor name=
"wxPyArtProvider" overloaded=
"no">
24106 <autodoc>__init__(self) -
> ArtProvider
</autodoc>
24107 <docstring>The wx.ArtProvider class is used to customize the look of wxWidgets
24108 application. When wxWidgets needs to display an icon or a bitmap (e.g.
24109 in the standard file dialog), it does not use hard-coded resource but
24110 asks wx.ArtProvider for it instead. This way the users can plug in
24111 their own wx.ArtProvider class and easily replace standard art with
24112 his/her own version. It is easy thing to do: all that is needed is
24113 to derive a class from wx.ArtProvider, override it's CreateBitmap
24114 method and register the provider with wx.ArtProvider.PushProvider::
24116 class MyArtProvider(wx.ArtProvider):
24117 def __init__(self):
24118 wx.ArtProvider.__init__(self)
24120 def CreateBitmap(self, artid, client, size):
24125 Identifying art resources
24126 -------------------------
24128 Every bitmap is known to wx.ArtProvider under an unique ID that is
24129 used when requesting a resource from it. The IDs can have one of these
24132 * wx.ART_ADD_BOOKMARK
24133 * wx.ART_DEL_BOOKMARK
24134 * wx.ART_HELP_SIDE_PANEL
24135 * wx.ART_HELP_SETTINGS
24137 * wx.ART_HELP_FOLDER
24140 * wx.ART_GO_FORWARD
24143 * wx.ART_GO_TO_PARENT
24149 * wx.ART_REPORT_VIEW
24154 * wx.ART_EXECUTABLE_FILE
24155 * wx.ART_NORMAL_FILE
24157 * wx.ART_CROSS_MARK
24161 * wx.ART_INFORMATION
24162 * wx.ART_MISSING_IMAGE
24168 The Client is the entity that calls wx.ArtProvider's `GetBitmap` or
24169 `GetIcon` function. Client IDs server as a hint to wx.ArtProvider
24170 that is supposed to help it to choose the best looking bitmap. For
24171 example it is often desirable to use slightly different icons in menus
24172 and toolbars even though they represent the same action (e.g.
24173 wx.ART_FILE_OPEN). Remember that this is really only a hint for
24174 wx.ArtProvider -- it is common that `wx.ArtProvider.GetBitmap` returns
24175 identical bitmap for different client values!
24179 * wx.ART_FRAME_ICON
24180 * wx.ART_CMN_DIALOG
24181 * wx.ART_HELP_BROWSER
24182 * wx.ART_MESSAGE_BOX
24183 * wx.ART_OTHER (used for all requests that don't fit into any
24184 of the categories above)
24187 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
24188 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
24190 <param name=
"self" type=
"PyObject" default=
""/>
24191 <param name=
"_class" type=
"PyObject" default=
""/>
24194 <staticmethod name=
"PushProvider" type=
"" overloaded=
"no">
24195 <autodoc>PushProvider(ArtProvider provider)
</autodoc>
24196 <docstring>Add new provider to the top of providers stack.
</docstring>
24198 <param name=
"provider" type=
"ArtProvider" default=
""/>
24201 <staticmethod name=
"PopProvider" type=
"bool" overloaded=
"no">
24202 <autodoc>PopProvider() -
> bool
</autodoc>
24203 <docstring>Remove latest added provider and delete it.
</docstring>
24205 <staticmethod name=
"RemoveProvider" type=
"bool" overloaded=
"no">
24206 <autodoc>RemoveProvider(ArtProvider provider) -
> bool
</autodoc>
24207 <docstring>Remove provider. The provider must have been added previously! The
24208 provider is _not_ deleted.
</docstring>
24210 <param name=
"provider" type=
"ArtProvider" default=
""/>
24213 <staticmethod name=
"GetBitmap" type=
"Bitmap" overloaded=
"no">
24214 <autodoc>GetBitmap(String id, String client=ART_OTHER, Size size=DefaultSize) -
> Bitmap
</autodoc>
24215 <docstring>Query the providers for bitmap with given ID and return it. Return
24216 wx.NullBitmap if no provider provides it.
</docstring>
24218 <param name=
"id" type=
"String" default=
""/>
24219 <param name=
"client" type=
"String" default=
"wxPyART_OTHER"/>
24220 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
24223 <staticmethod name=
"GetIcon" type=
"Icon" overloaded=
"no">
24224 <autodoc>GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -
> Icon
</autodoc>
24225 <docstring>Query the providers for icon with given ID and return it. Return
24226 wx.NullIcon if no provider provides it.
</docstring>
24228 <param name=
"id" type=
"String" default=
""/>
24229 <param name=
"client" type=
"String" default=
"wxPyART_OTHER"/>
24230 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
24233 <method name=
"Destroy" type=
"" overloaded=
"no">
24234 <autodoc>Destroy(self)
</autodoc>
24238 #---------------------------------------------------------------------------
24240 <class name=
"ConfigBase" oldname=
"wxConfigBase" module=
"_misc">
24241 <docstring>wx.ConfigBase class defines the basic interface of all config
24242 classes. It can not be used by itself (it is an abstract base class)
24243 and you will always use one of its derivations: wx.Config or
24246 wx.ConfigBase organizes the items in a tree-like structure, modeled
24247 after the Unix/Dos filesystem. There are groups that act like
24248 directories and entries, key/value pairs that act like files. There
24249 is always one current group given by the current path. As in the file
24250 system case, to specify a key in the config class you must use a path
24251 to it. Config classes also support the notion of the current group,
24252 which makes it possible to use relative paths.
24254 Keys are pairs "key_name = value" where value may be of string,
24255 integer floating point or boolean, you can not store binary data
24256 without first encoding it as a string. For performance reasons items
24257 should be kept small, no more than a couple kilobytes.
24259 <destructor name=
"~wxConfigBase" overloaded=
"no">
24260 <autodoc>__del__(self)
</autodoc>
24262 <staticmethod name=
"Set" type=
"ConfigBase" overloaded=
"no">
24263 <autodoc>Set(ConfigBase config) -
> ConfigBase
</autodoc>
24264 <docstring>Sets the global config object (the one returned by Get) and returns a
24265 reference to the previous global config object.
</docstring>
24267 <param name=
"config" type=
"ConfigBase" default=
""/>
24270 <staticmethod name=
"Get" type=
"ConfigBase" overloaded=
"no">
24271 <autodoc>Get(bool createOnDemand=True) -
> ConfigBase
</autodoc>
24272 <docstring>Returns the current global config object, creating one if neccessary.
</docstring>
24274 <param name=
"createOnDemand" type=
"bool" default=
"True"/>
24277 <staticmethod name=
"Create" type=
"ConfigBase" overloaded=
"no">
24278 <autodoc>Create() -
> ConfigBase
</autodoc>
24279 <docstring>Create and return a new global config object. This function will
24280 create the "best" implementation of wx.Config available for the
24281 current platform.
</docstring>
24283 <staticmethod name=
"DontCreateOnDemand" type=
"" overloaded=
"no">
24284 <autodoc>DontCreateOnDemand()
</autodoc>
24285 <docstring>Should Get() try to create a new log object if there isn't a current
24288 <method name=
"SetPath" type=
"" overloaded=
"no">
24289 <autodoc>SetPath(self, String path)
</autodoc>
24290 <docstring>Set current path: if the first character is '/', it's the absolute
24291 path, otherwise it's a relative path. '..' is supported. If the
24292 strPath doesn't exist it is created.
</docstring>
24294 <param name=
"path" type=
"String" default=
""/>
24297 <method name=
"GetPath" type=
"String" overloaded=
"no">
24298 <autodoc>GetPath(self) -
> String
</autodoc>
24299 <docstring>Retrieve the current path (always as absolute path)
</docstring>
24301 <method name=
"GetFirstGroup" type=
"PyObject" overloaded=
"no">
24302 <autodoc>GetFirstGroup() -
> (more, value, index)
</autodoc>
24303 <docstring>Allows enumerating the subgroups in a config object. Returns a tuple
24304 containing a flag indicating there are more items, the name of the
24305 current item, and an index to pass to GetNextGroup to fetch the next
24308 <method name=
"GetNextGroup" type=
"PyObject" overloaded=
"no">
24309 <autodoc>GetNextGroup(long index) -
> (more, value, index)
</autodoc>
24310 <docstring>Allows enumerating the subgroups in a config object. Returns a tuple
24311 containing a flag indicating there are more items, the name of the
24312 current item, and an index to pass to GetNextGroup to fetch the next
24315 <param name=
"index" type=
"long" default=
""/>
24318 <method name=
"GetFirstEntry" type=
"PyObject" overloaded=
"no">
24319 <autodoc>GetFirstEntry() -
> (more, value, index)
</autodoc>
24320 <docstring>Allows enumerating the entries in the current group in a config
24321 object. Returns a tuple containing a flag indicating there are more
24322 items, the name of the current item, and an index to pass to
24323 GetNextGroup to fetch the next item.
</docstring>
24325 <method name=
"GetNextEntry" type=
"PyObject" overloaded=
"no">
24326 <autodoc>GetNextEntry(long index) -
> (more, value, index)
</autodoc>
24327 <docstring>Allows enumerating the entries in the current group in a config
24328 object. Returns a tuple containing a flag indicating there are more
24329 items, the name of the current item, and an index to pass to
24330 GetNextGroup to fetch the next item.
</docstring>
24332 <param name=
"index" type=
"long" default=
""/>
24335 <method name=
"GetNumberOfEntries" type=
"size_t" overloaded=
"no">
24336 <autodoc>GetNumberOfEntries(self, bool recursive=False) -
> size_t
</autodoc>
24337 <docstring>Get the number of entries in the current group, with or without its
24338 subgroups.
</docstring>
24340 <param name=
"recursive" type=
"bool" default=
"False"/>
24343 <method name=
"GetNumberOfGroups" type=
"size_t" overloaded=
"no">
24344 <autodoc>GetNumberOfGroups(self, bool recursive=False) -
> size_t
</autodoc>
24345 <docstring>Get the number of subgroups in the current group, with or without its
24346 subgroups.
</docstring>
24348 <param name=
"recursive" type=
"bool" default=
"False"/>
24351 <method name=
"HasGroup" type=
"bool" overloaded=
"no">
24352 <autodoc>HasGroup(self, String name) -
> bool
</autodoc>
24353 <docstring>Returns True if the group by this name exists
</docstring>
24355 <param name=
"name" type=
"String" default=
""/>
24358 <method name=
"HasEntry" type=
"bool" overloaded=
"no">
24359 <autodoc>HasEntry(self, String name) -
> bool
</autodoc>
24360 <docstring>Returns True if the entry by this name exists
</docstring>
24362 <param name=
"name" type=
"String" default=
""/>
24365 <method name=
"Exists" type=
"bool" overloaded=
"no">
24366 <autodoc>Exists(self, String name) -
> bool
</autodoc>
24367 <docstring>Returns True if either a group or an entry with a given name exists
</docstring>
24369 <param name=
"name" type=
"String" default=
""/>
24372 <method name=
"GetEntryType" type=
"wxConfigBase::EntryType" overloaded=
"no">
24373 <autodoc>GetEntryType(self, String name) -
> int
</autodoc>
24374 <docstring>Get the type of the entry. Returns one of the wx.Config.Type_XXX values.
</docstring>
24376 <param name=
"name" type=
"String" default=
""/>
24379 <method name=
"Read" type=
"String" overloaded=
"no">
24380 <autodoc>Read(self, String key, String defaultVal=EmptyString) -
> String
</autodoc>
24381 <docstring>Returns the value of key if it exists, defaultVal otherwise.
</docstring>
24383 <param name=
"key" type=
"String" default=
""/>
24384 <param name=
"defaultVal" type=
"String" default=
"wxPyEmptyString"/>
24387 <method name=
"ReadInt" type=
"long" overloaded=
"no">
24388 <autodoc>ReadInt(self, String key, long defaultVal=
0) -
> long
</autodoc>
24389 <docstring>Returns the value of key if it exists, defaultVal otherwise.
</docstring>
24391 <param name=
"key" type=
"String" default=
""/>
24392 <param name=
"defaultVal" type=
"long" default=
"0"/>
24395 <method name=
"ReadFloat" type=
"double" overloaded=
"no">
24396 <autodoc>ReadFloat(self, String key, double defaultVal=
0.0) -
> double
</autodoc>
24397 <docstring>Returns the value of key if it exists, defaultVal otherwise.
</docstring>
24399 <param name=
"key" type=
"String" default=
""/>
24400 <param name=
"defaultVal" type=
"double" default=
"0.0"/>
24403 <method name=
"ReadBool" type=
"bool" overloaded=
"no">
24404 <autodoc>ReadBool(self, String key, bool defaultVal=False) -
> bool
</autodoc>
24405 <docstring>Returns the value of key if it exists, defaultVal otherwise.
</docstring>
24407 <param name=
"key" type=
"String" default=
""/>
24408 <param name=
"defaultVal" type=
"bool" default=
"False"/>
24411 <method name=
"Write" type=
"bool" overloaded=
"no">
24412 <autodoc>Write(self, String key, String value) -
> bool
</autodoc>
24413 <docstring>write the value (return True on success)
</docstring>
24415 <param name=
"key" type=
"String" default=
""/>
24416 <param name=
"value" type=
"String" default=
""/>
24419 <method name=
"WriteInt" type=
"bool" overloaded=
"no">
24420 <autodoc>WriteInt(self, String key, long value) -
> bool
</autodoc>
24421 <docstring>write the value (return True on success)
</docstring>
24423 <param name=
"key" type=
"String" default=
""/>
24424 <param name=
"value" type=
"long" default=
""/>
24427 <method name=
"WriteFloat" type=
"bool" overloaded=
"no">
24428 <autodoc>WriteFloat(self, String key, double value) -
> bool
</autodoc>
24429 <docstring>write the value (return True on success)
</docstring>
24431 <param name=
"key" type=
"String" default=
""/>
24432 <param name=
"value" type=
"double" default=
""/>
24435 <method name=
"WriteBool" type=
"bool" overloaded=
"no">
24436 <autodoc>WriteBool(self, String key, bool value) -
> bool
</autodoc>
24437 <docstring>write the value (return True on success)
</docstring>
24439 <param name=
"key" type=
"String" default=
""/>
24440 <param name=
"value" type=
"bool" default=
""/>
24443 <method name=
"Flush" type=
"bool" overloaded=
"no">
24444 <autodoc>Flush(self, bool currentOnly=False) -
> bool
</autodoc>
24445 <docstring>permanently writes all changes
</docstring>
24447 <param name=
"currentOnly" type=
"bool" default=
"False"/>
24450 <method name=
"RenameEntry" type=
"bool" overloaded=
"no">
24451 <autodoc>RenameEntry(self, String oldName, String newName) -
> bool
</autodoc>
24452 <docstring>Rename an entry. Returns False on failure (probably because the new
24453 name is already taken by an existing entry)
</docstring>
24455 <param name=
"oldName" type=
"String" default=
""/>
24456 <param name=
"newName" type=
"String" default=
""/>
24459 <method name=
"RenameGroup" type=
"bool" overloaded=
"no">
24460 <autodoc>RenameGroup(self, String oldName, String newName) -
> bool
</autodoc>
24461 <docstring>Rename a group. Returns False on failure (probably because the new
24462 name is already taken by an existing entry)
</docstring>
24464 <param name=
"oldName" type=
"String" default=
""/>
24465 <param name=
"newName" type=
"String" default=
""/>
24468 <method name=
"DeleteEntry" type=
"bool" overloaded=
"no">
24469 <autodoc>DeleteEntry(self, String key, bool deleteGroupIfEmpty=True) -
> bool
</autodoc>
24470 <docstring>Deletes the specified entry and the group it belongs to if it was the
24471 last key in it and the second parameter is True
</docstring>
24473 <param name=
"key" type=
"String" default=
""/>
24474 <param name=
"deleteGroupIfEmpty" type=
"bool" default=
"True"/>
24477 <method name=
"DeleteGroup" type=
"bool" overloaded=
"no">
24478 <autodoc>DeleteGroup(self, String key) -
> bool
</autodoc>
24479 <docstring>Delete the group (with all subgroups)
</docstring>
24481 <param name=
"key" type=
"String" default=
""/>
24484 <method name=
"DeleteAll" type=
"bool" overloaded=
"no">
24485 <autodoc>DeleteAll(self) -
> bool
</autodoc>
24486 <docstring>Delete the whole underlying object (disk file, registry key, ...)
24487 primarly intended for use by deinstallation routine.
</docstring>
24489 <method name=
"SetExpandEnvVars" type=
"" overloaded=
"no">
24490 <autodoc>SetExpandEnvVars(self, bool doIt=True)
</autodoc>
24491 <docstring>We can automatically expand environment variables in the config
24492 entries this option is on by default, you can turn it on/off at any
24495 <param name=
"doIt" type=
"bool" default=
"True"/>
24498 <method name=
"IsExpandingEnvVars" type=
"bool" overloaded=
"no">
24499 <autodoc>IsExpandingEnvVars(self) -
> bool
</autodoc>
24500 <docstring>Are we currently expanding environment variables?
</docstring>
24502 <method name=
"SetRecordDefaults" type=
"" overloaded=
"no">
24503 <autodoc>SetRecordDefaults(self, bool doIt=True)
</autodoc>
24504 <docstring>Set whether the config objec should record default values.
</docstring>
24506 <param name=
"doIt" type=
"bool" default=
"True"/>
24509 <method name=
"IsRecordingDefaults" type=
"bool" overloaded=
"no">
24510 <autodoc>IsRecordingDefaults(self) -
> bool
</autodoc>
24511 <docstring>Are we currently recording default values?
</docstring>
24513 <method name=
"ExpandEnvVars" type=
"String" overloaded=
"no">
24514 <autodoc>ExpandEnvVars(self, String str) -
> String
</autodoc>
24515 <docstring>Expand any environment variables in str and return the result
</docstring>
24517 <param name=
"str" type=
"String" default=
""/>
24520 <method name=
"GetAppName" type=
"String" overloaded=
"no">
24521 <autodoc>GetAppName(self) -
> String
</autodoc>
24523 <method name=
"GetVendorName" type=
"String" overloaded=
"no">
24524 <autodoc>GetVendorName(self) -
> String
</autodoc>
24526 <method name=
"SetAppName" type=
"" overloaded=
"no">
24527 <autodoc>SetAppName(self, String appName)
</autodoc>
24529 <param name=
"appName" type=
"String" default=
""/>
24532 <method name=
"SetVendorName" type=
"" overloaded=
"no">
24533 <autodoc>SetVendorName(self, String vendorName)
</autodoc>
24535 <param name=
"vendorName" type=
"String" default=
""/>
24538 <method name=
"SetStyle" type=
"" overloaded=
"no">
24539 <autodoc>SetStyle(self, long style)
</autodoc>
24541 <param name=
"style" type=
"long" default=
""/>
24544 <method name=
"GetStyle" type=
"long" overloaded=
"no">
24545 <autodoc>GetStyle(self) -
> long
</autodoc>
24548 <class name=
"Config" oldname=
"wxConfig" module=
"_misc">
24549 <docstring>This ConfigBase-derived class will use the registry on Windows,
24550 and will be a wx.FileConfig on other platforms.
</docstring>
24551 <baseclass name=
"ConfigBase"/>
24552 <constructor name=
"Config" overloaded=
"no">
24553 <autodoc>__init__(self, String appName=EmptyString, String vendorName=EmptyString,
24554 String localFilename=EmptyString, String globalFilename=EmptyString,
24555 long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -
> Config
</autodoc>
24557 <param name=
"appName" type=
"String" default=
"wxPyEmptyString"/>
24558 <param name=
"vendorName" type=
"String" default=
"wxPyEmptyString"/>
24559 <param name=
"localFilename" type=
"String" default=
"wxPyEmptyString"/>
24560 <param name=
"globalFilename" type=
"String" default=
"wxPyEmptyString"/>
24561 <param name=
"style" type=
"long" default=
"wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE"/>
24564 <destructor name=
"~wxConfig" overloaded=
"no">
24565 <autodoc>__del__(self)
</autodoc>
24568 <class name=
"FileConfig" oldname=
"wxFileConfig" module=
"_misc">
24569 <docstring>This config class will use a file for storage on all platforms.
</docstring>
24570 <baseclass name=
"ConfigBase"/>
24571 <constructor name=
"FileConfig" overloaded=
"no">
24572 <autodoc>__init__(self, String appName=EmptyString, String vendorName=EmptyString,
24573 String localFilename=EmptyString, String globalFilename=EmptyString,
24574 long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -
> FileConfig
</autodoc>
24576 <param name=
"appName" type=
"String" default=
"wxPyEmptyString"/>
24577 <param name=
"vendorName" type=
"String" default=
"wxPyEmptyString"/>
24578 <param name=
"localFilename" type=
"String" default=
"wxPyEmptyString"/>
24579 <param name=
"globalFilename" type=
"String" default=
"wxPyEmptyString"/>
24580 <param name=
"style" type=
"long" default=
"wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE"/>
24583 <destructor name=
"~wxFileConfig" overloaded=
"no">
24584 <autodoc>__del__(self)
</autodoc>
24587 <class name=
"ConfigPathChanger" oldname=
"wxConfigPathChanger" module=
"_misc">
24588 <docstring>A handy little class which changes current path to the path of given
24589 entry and restores it in the destructoir: so if you declare a local
24590 variable of this type, you work in the entry directory and the path is
24591 automatically restored when the function returns.
</docstring>
24592 <constructor name=
"ConfigPathChanger" overloaded=
"no">
24593 <autodoc>__init__(self, ConfigBase config, String entry) -
> ConfigPathChanger
</autodoc>
24595 <param name=
"config" type=
"ConfigBase" default=
""/>
24596 <param name=
"entry" type=
"String" default=
""/>
24599 <destructor name=
"~wxConfigPathChanger" overloaded=
"no">
24600 <autodoc>__del__(self)
</autodoc>
24602 <method name=
"Name" type=
"String" overloaded=
"no">
24603 <autodoc>Name(self) -
> String
</autodoc>
24604 <docstring>Get the key name
</docstring>
24607 <method name=
"ExpandEnvVars" oldname=
"wxExpandEnvVars" type=
"String" overloaded=
"no">
24608 <autodoc>ExpandEnvVars(String sz) -
> String
</autodoc>
24609 <docstring>Replace environment variables ($SOMETHING) with their values. The
24610 format is $VARNAME or ${VARNAME} where VARNAME contains alphanumeric
24611 characters and '_' only. '$' must be escaped ('\\$') in order to be
24612 taken literally.
</docstring>
24614 <param name=
"sz" type=
"String" default=
""/>
24618 #---------------------------------------------------------------------------
24620 <class name=
"DateTime" oldname=
"wxDateTime" module=
"_misc">
24621 <constructor name=
"DateTime" overloaded=
"no">
24622 <autodoc>__init__(self) -
> DateTime
</autodoc>
24624 <constructor name=
"DateTimeFromTimeT" overloaded=
"no">
24625 <autodoc>DateTimeFromTimeT(time_t timet) -
> DateTime
</autodoc>
24627 <param name=
"timet" type=
"time_t" default=
""/>
24630 <constructor name=
"DateTimeFromJDN" overloaded=
"no">
24631 <autodoc>DateTimeFromJDN(double jdn) -
> DateTime
</autodoc>
24633 <param name=
"jdn" type=
"double" default=
""/>
24636 <constructor name=
"DateTimeFromHMS" overloaded=
"no">
24637 <autodoc>DateTimeFromHMS(int hour, int minute=
0, int second=
0, int millisec=
0) -
> DateTime
</autodoc>
24639 <param name=
"hour" type=
"int" default=
""/>
24640 <param name=
"minute" type=
"int" default=
"0"/>
24641 <param name=
"second" type=
"int" default=
"0"/>
24642 <param name=
"millisec" type=
"int" default=
"0"/>
24645 <constructor name=
"DateTimeFromDMY" overloaded=
"no">
24646 <autodoc>DateTimeFromDMY(int day, int month=Inv_Month, int year=Inv_Year, int hour=
0,
24647 int minute=
0, int second=
0, int millisec=
0) -
> DateTime
</autodoc>
24649 <param name=
"day" type=
"int" default=
""/>
24650 <param name=
"month" type=
"wxDateTime::Month" default=
"wxDateTime::Inv_Month"/>
24651 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24652 <param name=
"hour" type=
"int" default=
"0"/>
24653 <param name=
"minute" type=
"int" default=
"0"/>
24654 <param name=
"second" type=
"int" default=
"0"/>
24655 <param name=
"millisec" type=
"int" default=
"0"/>
24658 <destructor name=
"~wxDateTime" overloaded=
"no">
24659 <autodoc>__del__(self)
</autodoc>
24661 <staticmethod name=
"SetCountry" type=
"" overloaded=
"no">
24662 <autodoc>SetCountry(int country)
</autodoc>
24664 <param name=
"country" type=
"wxDateTime::Country" default=
""/>
24667 <staticmethod name=
"GetCountry" type=
"wxDateTime::Country" overloaded=
"no">
24668 <autodoc>GetCountry() -
> int
</autodoc>
24670 <staticmethod name=
"IsWestEuropeanCountry" type=
"bool" overloaded=
"no">
24671 <autodoc>IsWestEuropeanCountry(int country=Country_Default) -
> bool
</autodoc>
24673 <param name=
"country" type=
"wxDateTime::Country" default=
"wxDateTime::Country_Default"/>
24676 <staticmethod name=
"GetCurrentYear" type=
"int" overloaded=
"no">
24677 <autodoc>GetCurrentYear(int cal=Gregorian) -
> int
</autodoc>
24679 <param name=
"cal" type=
"wxDateTime::Calendar" default=
"wxDateTime::Gregorian"/>
24682 <staticmethod name=
"ConvertYearToBC" type=
"int" overloaded=
"no">
24683 <autodoc>ConvertYearToBC(int year) -
> int
</autodoc>
24685 <param name=
"year" type=
"int" default=
""/>
24688 <staticmethod name=
"GetCurrentMonth" type=
"wxDateTime::Month" overloaded=
"no">
24689 <autodoc>GetCurrentMonth(int cal=Gregorian) -
> int
</autodoc>
24691 <param name=
"cal" type=
"wxDateTime::Calendar" default=
"wxDateTime::Gregorian"/>
24694 <staticmethod name=
"IsLeapYear" type=
"bool" overloaded=
"no">
24695 <autodoc>IsLeapYear(int year=Inv_Year, int cal=Gregorian) -
> bool
</autodoc>
24697 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24698 <param name=
"cal" type=
"wxDateTime::Calendar" default=
"wxDateTime::Gregorian"/>
24701 <staticmethod name=
"GetCentury" type=
"int" overloaded=
"no">
24702 <autodoc>GetCentury(int year=Inv_Year) -
> int
</autodoc>
24704 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24707 <staticmethod name=
"GetNumberOfDaysinYear" type=
"int" overloaded=
"no">
24708 <autodoc>GetNumberOfDaysinYear(int year, int cal=Gregorian) -
> int
</autodoc>
24710 <param name=
"year" type=
"int" default=
""/>
24711 <param name=
"cal" type=
"wxDateTime::Calendar" default=
"wxDateTime::Gregorian"/>
24714 <staticmethod name=
"GetNumberOfDaysInMonth" type=
"int" overloaded=
"no">
24715 <autodoc>GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -
> int
</autodoc>
24717 <param name=
"month" type=
"wxDateTime::Month" default=
""/>
24718 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24719 <param name=
"cal" type=
"wxDateTime::Calendar" default=
"wxDateTime::Gregorian"/>
24722 <staticmethod name=
"GetMonthName" type=
"String" overloaded=
"no">
24723 <autodoc>GetMonthName(int month, int flags=Name_Full) -
> String
</autodoc>
24725 <param name=
"month" type=
"wxDateTime::Month" default=
""/>
24726 <param name=
"flags" type=
"wxDateTime::NameFlags" default=
"wxDateTime::Name_Full"/>
24729 <staticmethod name=
"GetWeekDayName" type=
"String" overloaded=
"no">
24730 <autodoc>GetWeekDayName(int weekday, int flags=Name_Full) -
> String
</autodoc>
24732 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24733 <param name=
"flags" type=
"wxDateTime::NameFlags" default=
"wxDateTime::Name_Full"/>
24736 <staticmethod name=
"GetAmPmStrings" type=
"" overloaded=
"no">
24737 <autodoc>GetAmPmStrings() -
> (am, pm)
</autodoc>
24738 <docstring>Get the AM and PM strings in the current locale (may be empty)
</docstring>
24740 <param name=
"OUTPUT" type=
"String" default=
""/>
24741 <param name=
"OUTPUT" type=
"String" default=
""/>
24744 <staticmethod name=
"IsDSTApplicable" type=
"bool" overloaded=
"no">
24745 <autodoc>IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -
> bool
</autodoc>
24747 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24748 <param name=
"country" type=
"wxDateTime::Country" default=
"wxDateTime::Country_Default"/>
24751 <staticmethod name=
"GetBeginDST" type=
"DateTime" overloaded=
"no">
24752 <autodoc>GetBeginDST(int year=Inv_Year, int country=Country_Default) -
> DateTime
</autodoc>
24754 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24755 <param name=
"country" type=
"wxDateTime::Country" default=
"wxDateTime::Country_Default"/>
24758 <staticmethod name=
"GetEndDST" type=
"DateTime" overloaded=
"no">
24759 <autodoc>GetEndDST(int year=Inv_Year, int country=Country_Default) -
> DateTime
</autodoc>
24761 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24762 <param name=
"country" type=
"wxDateTime::Country" default=
"wxDateTime::Country_Default"/>
24765 <staticmethod name=
"Now" type=
"DateTime" overloaded=
"no">
24766 <autodoc>Now() -
> DateTime
</autodoc>
24768 <staticmethod name=
"UNow" type=
"DateTime" overloaded=
"no">
24769 <autodoc>UNow() -
> DateTime
</autodoc>
24771 <staticmethod name=
"Today" type=
"DateTime" overloaded=
"no">
24772 <autodoc>Today() -
> DateTime
</autodoc>
24774 <method name=
"SetToCurrent" type=
"DateTime" overloaded=
"no">
24775 <autodoc>SetToCurrent(self) -
> DateTime
</autodoc>
24777 <method name=
"SetTimeT" type=
"DateTime" overloaded=
"no">
24778 <autodoc>SetTimeT(self, time_t timet) -
> DateTime
</autodoc>
24780 <param name=
"timet" type=
"time_t" default=
""/>
24783 <method name=
"SetJDN" type=
"DateTime" overloaded=
"no">
24784 <autodoc>SetJDN(self, double jdn) -
> DateTime
</autodoc>
24786 <param name=
"jdn" type=
"double" default=
""/>
24789 <method name=
"SetHMS" type=
"DateTime" overloaded=
"no">
24790 <autodoc>SetHMS(self, int hour, int minute=
0, int second=
0, int millisec=
0) -
> DateTime
</autodoc>
24792 <param name=
"hour" type=
"int" default=
""/>
24793 <param name=
"minute" type=
"int" default=
"0"/>
24794 <param name=
"second" type=
"int" default=
"0"/>
24795 <param name=
"millisec" type=
"int" default=
"0"/>
24798 <method name=
"Set" type=
"DateTime" overloaded=
"no">
24799 <autodoc>Set(self, int day, int month=Inv_Month, int year=Inv_Year, int hour=
0,
24800 int minute=
0, int second=
0, int millisec=
0) -
> DateTime
</autodoc>
24802 <param name=
"day" type=
"int" default=
""/>
24803 <param name=
"month" type=
"wxDateTime::Month" default=
"wxDateTime::Inv_Month"/>
24804 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24805 <param name=
"hour" type=
"int" default=
"0"/>
24806 <param name=
"minute" type=
"int" default=
"0"/>
24807 <param name=
"second" type=
"int" default=
"0"/>
24808 <param name=
"millisec" type=
"int" default=
"0"/>
24811 <method name=
"ResetTime" type=
"DateTime" overloaded=
"no">
24812 <autodoc>ResetTime(self) -
> DateTime
</autodoc>
24814 <method name=
"SetYear" type=
"DateTime" overloaded=
"no">
24815 <autodoc>SetYear(self, int year) -
> DateTime
</autodoc>
24817 <param name=
"year" type=
"int" default=
""/>
24820 <method name=
"SetMonth" type=
"DateTime" overloaded=
"no">
24821 <autodoc>SetMonth(self, int month) -
> DateTime
</autodoc>
24823 <param name=
"month" type=
"wxDateTime::Month" default=
""/>
24826 <method name=
"SetDay" type=
"DateTime" overloaded=
"no">
24827 <autodoc>SetDay(self, int day) -
> DateTime
</autodoc>
24829 <param name=
"day" type=
"int" default=
""/>
24832 <method name=
"SetHour" type=
"DateTime" overloaded=
"no">
24833 <autodoc>SetHour(self, int hour) -
> DateTime
</autodoc>
24835 <param name=
"hour" type=
"int" default=
""/>
24838 <method name=
"SetMinute" type=
"DateTime" overloaded=
"no">
24839 <autodoc>SetMinute(self, int minute) -
> DateTime
</autodoc>
24841 <param name=
"minute" type=
"int" default=
""/>
24844 <method name=
"SetSecond" type=
"DateTime" overloaded=
"no">
24845 <autodoc>SetSecond(self, int second) -
> DateTime
</autodoc>
24847 <param name=
"second" type=
"int" default=
""/>
24850 <method name=
"SetMillisecond" type=
"DateTime" overloaded=
"no">
24851 <autodoc>SetMillisecond(self, int millisecond) -
> DateTime
</autodoc>
24853 <param name=
"millisecond" type=
"int" default=
""/>
24856 <method name=
"SetToWeekDayInSameWeek" type=
"DateTime" overloaded=
"no">
24857 <autodoc>SetToWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -
> DateTime
</autodoc>
24859 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24860 <param name=
"flags" type=
"wxDateTime::WeekFlags" default=
"wxDateTime::Monday_First"/>
24863 <method name=
"GetWeekDayInSameWeek" type=
"DateTime" overloaded=
"no">
24864 <autodoc>GetWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -
> DateTime
</autodoc>
24866 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24867 <param name=
"flags" type=
"wxDateTime::WeekFlags" default=
"wxDateTime::Monday_First"/>
24870 <method name=
"SetToNextWeekDay" type=
"DateTime" overloaded=
"no">
24871 <autodoc>SetToNextWeekDay(self, int weekday) -
> DateTime
</autodoc>
24873 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24876 <method name=
"GetNextWeekDay" type=
"DateTime" overloaded=
"no">
24877 <autodoc>GetNextWeekDay(self, int weekday) -
> DateTime
</autodoc>
24879 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24882 <method name=
"SetToPrevWeekDay" type=
"DateTime" overloaded=
"no">
24883 <autodoc>SetToPrevWeekDay(self, int weekday) -
> DateTime
</autodoc>
24885 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24888 <method name=
"GetPrevWeekDay" type=
"DateTime" overloaded=
"no">
24889 <autodoc>GetPrevWeekDay(self, int weekday) -
> DateTime
</autodoc>
24891 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24894 <method name=
"SetToWeekDay" type=
"bool" overloaded=
"no">
24895 <autodoc>SetToWeekDay(self, int weekday, int n=
1, int month=Inv_Month, int year=Inv_Year) -
> bool
</autodoc>
24897 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24898 <param name=
"n" type=
"int" default=
"1"/>
24899 <param name=
"month" type=
"wxDateTime::Month" default=
"wxDateTime::Inv_Month"/>
24900 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24903 <method name=
"SetToLastWeekDay" type=
"bool" overloaded=
"no">
24904 <autodoc>SetToLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -
> bool
</autodoc>
24906 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24907 <param name=
"month" type=
"wxDateTime::Month" default=
"wxDateTime::Inv_Month"/>
24908 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24911 <method name=
"GetLastWeekDay" type=
"DateTime" overloaded=
"no">
24912 <autodoc>GetLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -
> DateTime
</autodoc>
24914 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
""/>
24915 <param name=
"month" type=
"wxDateTime::Month" default=
"wxDateTime::Inv_Month"/>
24916 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24919 <method name=
"SetToTheWeek" type=
"bool" overloaded=
"no">
24920 <autodoc>SetToTheWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -
> bool
</autodoc>
24922 <param name=
"numWeek" type=
"int" default=
""/>
24923 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
"wxDateTime::Mon"/>
24924 <param name=
"flags" type=
"wxDateTime::WeekFlags" default=
"wxDateTime::Monday_First"/>
24927 <method name=
"GetWeek" type=
"DateTime" overloaded=
"no">
24928 <autodoc>GetWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -
> DateTime
</autodoc>
24930 <param name=
"numWeek" type=
"int" default=
""/>
24931 <param name=
"weekday" type=
"wxDateTime::WeekDay" default=
"wxDateTime::Mon"/>
24932 <param name=
"flags" type=
"wxDateTime::WeekFlags" default=
"wxDateTime::Monday_First"/>
24935 <method name=
"SetToLastMonthDay" type=
"DateTime" overloaded=
"no">
24936 <autodoc>SetToLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -
> DateTime
</autodoc>
24938 <param name=
"month" type=
"wxDateTime::Month" default=
"wxDateTime::Inv_Month"/>
24939 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24942 <method name=
"GetLastMonthDay" type=
"DateTime" overloaded=
"no">
24943 <autodoc>GetLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -
> DateTime
</autodoc>
24945 <param name=
"month" type=
"wxDateTime::Month" default=
"wxDateTime::Inv_Month"/>
24946 <param name=
"year" type=
"int" default=
"wxDateTime::Inv_Year"/>
24949 <method name=
"SetToYearDay" type=
"DateTime" overloaded=
"no">
24950 <autodoc>SetToYearDay(self, int yday) -
> DateTime
</autodoc>
24952 <param name=
"yday" type=
"int" default=
""/>
24955 <method name=
"GetYearDay" type=
"DateTime" overloaded=
"no">
24956 <autodoc>GetYearDay(self, int yday) -
> DateTime
</autodoc>
24958 <param name=
"yday" type=
"int" default=
""/>
24961 <method name=
"GetJulianDayNumber" type=
"double" overloaded=
"no">
24962 <autodoc>GetJulianDayNumber(self) -
> double
</autodoc>
24964 <method name=
"GetJDN" type=
"double" overloaded=
"no">
24965 <autodoc>GetJDN(self) -
> double
</autodoc>
24967 <method name=
"GetModifiedJulianDayNumber" type=
"double" overloaded=
"no">
24968 <autodoc>GetModifiedJulianDayNumber(self) -
> double
</autodoc>
24970 <method name=
"GetMJD" type=
"double" overloaded=
"no">
24971 <autodoc>GetMJD(self) -
> double
</autodoc>
24973 <method name=
"GetRataDie" type=
"double" overloaded=
"no">
24974 <autodoc>GetRataDie(self) -
> double
</autodoc>
24976 <method name=
"ToTimezone" type=
"DateTime" overloaded=
"no">
24977 <autodoc>ToTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -
> DateTime
</autodoc>
24979 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
""/>
24980 <param name=
"noDST" type=
"bool" default=
"False"/>
24983 <method name=
"MakeTimezone" type=
"DateTime" overloaded=
"no">
24984 <autodoc>MakeTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -
> DateTime
</autodoc>
24986 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
""/>
24987 <param name=
"noDST" type=
"bool" default=
"False"/>
24990 <method name=
"ToGMT" type=
"DateTime" overloaded=
"no">
24991 <autodoc>ToGMT(self, bool noDST=False) -
> DateTime
</autodoc>
24993 <param name=
"noDST" type=
"bool" default=
"False"/>
24996 <method name=
"MakeGMT" type=
"DateTime" overloaded=
"no">
24997 <autodoc>MakeGMT(self, bool noDST=False) -
> DateTime
</autodoc>
24999 <param name=
"noDST" type=
"bool" default=
"False"/>
25002 <method name=
"IsDST" type=
"int" overloaded=
"no">
25003 <autodoc>IsDST(self, int country=Country_Default) -
> int
</autodoc>
25005 <param name=
"country" type=
"wxDateTime::Country" default=
"wxDateTime::Country_Default"/>
25008 <method name=
"IsValid" type=
"bool" overloaded=
"no">
25009 <autodoc>IsValid(self) -
> bool
</autodoc>
25011 <method name=
"GetTicks" type=
"time_t" overloaded=
"no">
25012 <autodoc>GetTicks(self) -
> time_t
</autodoc>
25014 <method name=
"GetYear" type=
"int" overloaded=
"no">
25015 <autodoc>GetYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25017 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25020 <method name=
"GetMonth" type=
"wxDateTime::Month" overloaded=
"no">
25021 <autodoc>GetMonth(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25023 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25026 <method name=
"GetDay" type=
"int" overloaded=
"no">
25027 <autodoc>GetDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25029 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25032 <method name=
"GetWeekDay" type=
"wxDateTime::WeekDay" overloaded=
"no">
25033 <autodoc>GetWeekDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25035 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25038 <method name=
"GetHour" type=
"int" overloaded=
"no">
25039 <autodoc>GetHour(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25041 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25044 <method name=
"GetMinute" type=
"int" overloaded=
"no">
25045 <autodoc>GetMinute(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25047 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25050 <method name=
"GetSecond" type=
"int" overloaded=
"no">
25051 <autodoc>GetSecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25053 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25056 <method name=
"GetMillisecond" type=
"int" overloaded=
"no">
25057 <autodoc>GetMillisecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25059 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25062 <method name=
"GetDayOfYear" type=
"int" overloaded=
"no">
25063 <autodoc>GetDayOfYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25065 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25068 <method name=
"GetWeekOfYear" type=
"int" overloaded=
"no">
25069 <autodoc>GetWeekOfYear(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25071 <param name=
"flags" type=
"wxDateTime::WeekFlags" default=
"wxDateTime::Monday_First"/>
25072 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25075 <method name=
"GetWeekOfMonth" type=
"int" overloaded=
"no">
25076 <autodoc>GetWeekOfMonth(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -
> int
</autodoc>
25078 <param name=
"flags" type=
"wxDateTime::WeekFlags" default=
"wxDateTime::Monday_First"/>
25079 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25082 <method name=
"IsWorkDay" type=
"bool" overloaded=
"no">
25083 <autodoc>IsWorkDay(self, int country=Country_Default) -
> bool
</autodoc>
25085 <param name=
"country" type=
"wxDateTime::Country" default=
"wxDateTime::Country_Default"/>
25088 <method name=
"IsEqualTo" type=
"bool" overloaded=
"no">
25089 <autodoc>IsEqualTo(self, DateTime datetime) -
> bool
</autodoc>
25091 <param name=
"datetime" type=
"DateTime" default=
""/>
25094 <method name=
"IsEarlierThan" type=
"bool" overloaded=
"no">
25095 <autodoc>IsEarlierThan(self, DateTime datetime) -
> bool
</autodoc>
25097 <param name=
"datetime" type=
"DateTime" default=
""/>
25100 <method name=
"IsLaterThan" type=
"bool" overloaded=
"no">
25101 <autodoc>IsLaterThan(self, DateTime datetime) -
> bool
</autodoc>
25103 <param name=
"datetime" type=
"DateTime" default=
""/>
25106 <method name=
"IsStrictlyBetween" type=
"bool" overloaded=
"no">
25107 <autodoc>IsStrictlyBetween(self, DateTime t1, DateTime t2) -
> bool
</autodoc>
25109 <param name=
"t1" type=
"DateTime" default=
""/>
25110 <param name=
"t2" type=
"DateTime" default=
""/>
25113 <method name=
"IsBetween" type=
"bool" overloaded=
"no">
25114 <autodoc>IsBetween(self, DateTime t1, DateTime t2) -
> bool
</autodoc>
25116 <param name=
"t1" type=
"DateTime" default=
""/>
25117 <param name=
"t2" type=
"DateTime" default=
""/>
25120 <method name=
"IsSameDate" type=
"bool" overloaded=
"no">
25121 <autodoc>IsSameDate(self, DateTime dt) -
> bool
</autodoc>
25123 <param name=
"dt" type=
"DateTime" default=
""/>
25126 <method name=
"IsSameTime" type=
"bool" overloaded=
"no">
25127 <autodoc>IsSameTime(self, DateTime dt) -
> bool
</autodoc>
25129 <param name=
"dt" type=
"DateTime" default=
""/>
25132 <method name=
"IsEqualUpTo" type=
"bool" overloaded=
"no">
25133 <autodoc>IsEqualUpTo(self, DateTime dt, TimeSpan ts) -
> bool
</autodoc>
25135 <param name=
"dt" type=
"DateTime" default=
""/>
25136 <param name=
"ts" type=
"wxTimeSpan" default=
""/>
25139 <method name=
"AddTS" type=
"DateTime" overloaded=
"no">
25140 <autodoc>AddTS(self, TimeSpan diff) -
> DateTime
</autodoc>
25142 <param name=
"diff" type=
"wxTimeSpan" default=
""/>
25145 <method name=
"AddDS" type=
"DateTime" overloaded=
"no">
25146 <autodoc>AddDS(self, DateSpan diff) -
> DateTime
</autodoc>
25148 <param name=
"diff" type=
"wxDateSpan" default=
""/>
25151 <method name=
"SubtractTS" type=
"DateTime" overloaded=
"no">
25152 <autodoc>SubtractTS(self, TimeSpan diff) -
> DateTime
</autodoc>
25154 <param name=
"diff" type=
"wxTimeSpan" default=
""/>
25157 <method name=
"SubtractDS" type=
"DateTime" overloaded=
"no">
25158 <autodoc>SubtractDS(self, DateSpan diff) -
> DateTime
</autodoc>
25160 <param name=
"diff" type=
"wxDateSpan" default=
""/>
25163 <method name=
"Subtract" type=
"wxTimeSpan" overloaded=
"no">
25164 <autodoc>Subtract(self, DateTime dt) -
> TimeSpan
</autodoc>
25166 <param name=
"dt" type=
"DateTime" default=
""/>
25169 <method name=
"__iadd__" type=
"DateTime" overloaded=
"yes">
25171 <param name=
"diff" type=
"wxTimeSpan" default=
""/>
25174 <method name=
"__iadd__" type=
"DateTime" overloaded=
"yes">
25175 <autodoc>__iadd__(self, TimeSpan diff) -
> DateTime
25176 __iadd__(self, DateSpan diff) -
> DateTime
</autodoc>
25178 <param name=
"diff" type=
"wxDateSpan" default=
""/>
25181 <method name=
"__isub__" type=
"DateTime" overloaded=
"yes">
25183 <param name=
"diff" type=
"wxTimeSpan" default=
""/>
25186 <method name=
"__isub__" type=
"DateTime" overloaded=
"yes">
25187 <autodoc>__isub__(self, TimeSpan diff) -
> DateTime
25188 __isub__(self, DateSpan diff) -
> DateTime
</autodoc>
25190 <param name=
"diff" type=
"wxDateSpan" default=
""/>
25193 <method name=
"__add__" type=
"DateTime" overloaded=
"yes">
25195 <param name=
"other" type=
"wxTimeSpan" default=
""/>
25198 <method name=
"__add__" type=
"DateTime" overloaded=
"yes">
25199 <autodoc>__add__(self, TimeSpan other) -
> DateTime
25200 __add__(self, DateSpan other) -
> DateTime
</autodoc>
25202 <param name=
"other" type=
"wxDateSpan" default=
""/>
25205 <method name=
"__sub__" type=
"wxTimeSpan" overloaded=
"yes">
25207 <param name=
"other" type=
"DateTime" default=
""/>
25210 <method name=
"__sub__" type=
"DateTime" overloaded=
"yes">
25212 <param name=
"other" type=
"wxTimeSpan" default=
""/>
25215 <method name=
"__sub__" type=
"DateTime" overloaded=
"yes">
25216 <autodoc>__sub__(self, DateTime other) -
> TimeSpan
25217 __sub__(self, TimeSpan other) -
> DateTime
25218 __sub__(self, DateSpan other) -
> DateTime
</autodoc>
25220 <param name=
"other" type=
"wxDateSpan" default=
""/>
25223 <method name=
"__lt__" type=
"bool" overloaded=
"no">
25224 <autodoc>__lt__(self, DateTime other) -
> bool
</autodoc>
25226 <param name=
"other" type=
"DateTime" default=
""/>
25229 <method name=
"__le__" type=
"bool" overloaded=
"no">
25230 <autodoc>__le__(self, DateTime other) -
> bool
</autodoc>
25232 <param name=
"other" type=
"DateTime" default=
""/>
25235 <method name=
"__gt__" type=
"bool" overloaded=
"no">
25236 <autodoc>__gt__(self, DateTime other) -
> bool
</autodoc>
25238 <param name=
"other" type=
"DateTime" default=
""/>
25241 <method name=
"__ge__" type=
"bool" overloaded=
"no">
25242 <autodoc>__ge__(self, DateTime other) -
> bool
</autodoc>
25244 <param name=
"other" type=
"DateTime" default=
""/>
25247 <method name=
"__eq__" type=
"bool" overloaded=
"no">
25248 <autodoc>__eq__(self, DateTime other) -
> bool
</autodoc>
25250 <param name=
"other" type=
"DateTime" default=
""/>
25253 <method name=
"__ne__" type=
"bool" overloaded=
"no">
25254 <autodoc>__ne__(self, DateTime other) -
> bool
</autodoc>
25256 <param name=
"other" type=
"DateTime" default=
""/>
25259 <method name=
"ParseRfc822Date" type=
"int" overloaded=
"no">
25260 <autodoc>ParseRfc822Date(self, String date) -
> int
</autodoc>
25262 <param name=
"date" type=
"String" default=
""/>
25265 <method name=
"ParseFormat" type=
"int" overloaded=
"no">
25266 <autodoc>ParseFormat(self, String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -
> int
</autodoc>
25268 <param name=
"date" type=
"String" default=
""/>
25269 <param name=
"format" type=
"String" default=
"wxPyDateFormatStr"/>
25270 <param name=
"dateDef" type=
"DateTime" default=
"wxDefaultDateTime"/>
25273 <method name=
"ParseDateTime" type=
"int" overloaded=
"no">
25274 <autodoc>ParseDateTime(self, String datetime) -
> int
</autodoc>
25276 <param name=
"datetime" type=
"String" default=
""/>
25279 <method name=
"ParseDate" type=
"int" overloaded=
"no">
25280 <autodoc>ParseDate(self, String date) -
> int
</autodoc>
25282 <param name=
"date" type=
"String" default=
""/>
25285 <method name=
"ParseTime" type=
"int" overloaded=
"no">
25286 <autodoc>ParseTime(self, String time) -
> int
</autodoc>
25288 <param name=
"time" type=
"String" default=
""/>
25291 <method name=
"Format" type=
"String" overloaded=
"no">
25292 <autodoc>Format(self, String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -
> String
</autodoc>
25294 <param name=
"format" type=
"String" default=
"wxPyDateFormatStr"/>
25295 <param name=
"tz" type=
"wxDateTime::TimeZone" default=
"LOCAL_TZ"/>
25298 <method name=
"FormatDate" type=
"String" overloaded=
"no">
25299 <autodoc>FormatDate(self) -
> String
</autodoc>
25301 <method name=
"FormatTime" type=
"String" overloaded=
"no">
25302 <autodoc>FormatTime(self) -
> String
</autodoc>
25304 <method name=
"FormatISODate" type=
"String" overloaded=
"no">
25305 <autodoc>FormatISODate(self) -
> String
</autodoc>
25307 <method name=
"FormatISOTime" type=
"String" overloaded=
"no">
25308 <autodoc>FormatISOTime(self) -
> String
</autodoc>
25311 <class name=
"TimeSpan" oldname=
"wxTimeSpan" module=
"_misc">
25312 <constructor name=
"TimeSpan" overloaded=
"no">
25313 <autodoc>__init__(self, long hours=
0, long minutes=
0, long seconds=
0, long milliseconds=
0) -
> TimeSpan
</autodoc>
25315 <param name=
"hours" type=
"long" default=
"0"/>
25316 <param name=
"minutes" type=
"long" default=
"0"/>
25317 <param name=
"seconds" type=
"long" default=
"0"/>
25318 <param name=
"milliseconds" type=
"long" default=
"0"/>
25321 <destructor name=
"~wxTimeSpan" overloaded=
"no">
25322 <autodoc>__del__(self)
</autodoc>
25324 <staticmethod name=
"Seconds" type=
"TimeSpan" overloaded=
"no">
25325 <autodoc>Seconds(long sec) -
> TimeSpan
</autodoc>
25327 <param name=
"sec" type=
"long" default=
""/>
25330 <staticmethod name=
"Second" type=
"TimeSpan" overloaded=
"no">
25331 <autodoc>Second() -
> TimeSpan
</autodoc>
25333 <staticmethod name=
"Minutes" type=
"TimeSpan" overloaded=
"no">
25334 <autodoc>Minutes(long min) -
> TimeSpan
</autodoc>
25336 <param name=
"min" type=
"long" default=
""/>
25339 <staticmethod name=
"Minute" type=
"TimeSpan" overloaded=
"no">
25340 <autodoc>Minute() -
> TimeSpan
</autodoc>
25342 <staticmethod name=
"Hours" type=
"TimeSpan" overloaded=
"no">
25343 <autodoc>Hours(long hours) -
> TimeSpan
</autodoc>
25345 <param name=
"hours" type=
"long" default=
""/>
25348 <staticmethod name=
"Hour" type=
"TimeSpan" overloaded=
"no">
25349 <autodoc>Hour() -
> TimeSpan
</autodoc>
25351 <staticmethod name=
"Days" type=
"TimeSpan" overloaded=
"no">
25352 <autodoc>Days(long days) -
> TimeSpan
</autodoc>
25354 <param name=
"days" type=
"long" default=
""/>
25357 <staticmethod name=
"Day" type=
"TimeSpan" overloaded=
"no">
25358 <autodoc>Day() -
> TimeSpan
</autodoc>
25360 <staticmethod name=
"Weeks" type=
"TimeSpan" overloaded=
"no">
25361 <autodoc>Weeks(long days) -
> TimeSpan
</autodoc>
25363 <param name=
"days" type=
"long" default=
""/>
25366 <staticmethod name=
"Week" type=
"TimeSpan" overloaded=
"no">
25367 <autodoc>Week() -
> TimeSpan
</autodoc>
25369 <method name=
"Add" type=
"TimeSpan" overloaded=
"no">
25370 <autodoc>Add(self, TimeSpan diff) -
> TimeSpan
</autodoc>
25372 <param name=
"diff" type=
"TimeSpan" default=
""/>
25375 <method name=
"Subtract" type=
"TimeSpan" overloaded=
"no">
25376 <autodoc>Subtract(self, TimeSpan diff) -
> TimeSpan
</autodoc>
25378 <param name=
"diff" type=
"TimeSpan" default=
""/>
25381 <method name=
"Multiply" type=
"TimeSpan" overloaded=
"no">
25382 <autodoc>Multiply(self, int n) -
> TimeSpan
</autodoc>
25384 <param name=
"n" type=
"int" default=
""/>
25387 <method name=
"Neg" type=
"TimeSpan" overloaded=
"no">
25388 <autodoc>Neg(self) -
> TimeSpan
</autodoc>
25390 <method name=
"Abs" type=
"TimeSpan" overloaded=
"no">
25391 <autodoc>Abs(self) -
> TimeSpan
</autodoc>
25393 <method name=
"__iadd__" type=
"TimeSpan" overloaded=
"no">
25394 <autodoc>__iadd__(self, TimeSpan diff) -
> TimeSpan
</autodoc>
25396 <param name=
"diff" type=
"TimeSpan" default=
""/>
25399 <method name=
"__isub__" type=
"TimeSpan" overloaded=
"no">
25400 <autodoc>__isub__(self, TimeSpan diff) -
> TimeSpan
</autodoc>
25402 <param name=
"diff" type=
"TimeSpan" default=
""/>
25405 <method name=
"__imul__" type=
"TimeSpan" overloaded=
"no">
25406 <autodoc>__imul__(self, int n) -
> TimeSpan
</autodoc>
25408 <param name=
"n" type=
"int" default=
""/>
25411 <method name=
"__neg__" type=
"TimeSpan" overloaded=
"no">
25412 <autodoc>__neg__(self) -
> TimeSpan
</autodoc>
25414 <method name=
"__add__" type=
"TimeSpan" overloaded=
"no">
25415 <autodoc>__add__(self, TimeSpan other) -
> TimeSpan
</autodoc>
25417 <param name=
"other" type=
"TimeSpan" default=
""/>
25420 <method name=
"__sub__" type=
"TimeSpan" overloaded=
"no">
25421 <autodoc>__sub__(self, TimeSpan other) -
> TimeSpan
</autodoc>
25423 <param name=
"other" type=
"TimeSpan" default=
""/>
25426 <method name=
"__mul__" type=
"TimeSpan" overloaded=
"no">
25427 <autodoc>__mul__(self, int n) -
> TimeSpan
</autodoc>
25429 <param name=
"n" type=
"int" default=
""/>
25432 <method name=
"__rmul__" type=
"TimeSpan" overloaded=
"no">
25433 <autodoc>__rmul__(self, int n) -
> TimeSpan
</autodoc>
25435 <param name=
"n" type=
"int" default=
""/>
25438 <method name=
"__lt__" type=
"bool" overloaded=
"no">
25439 <autodoc>__lt__(self, TimeSpan other) -
> bool
</autodoc>
25441 <param name=
"other" type=
"TimeSpan" default=
""/>
25444 <method name=
"__le__" type=
"bool" overloaded=
"no">
25445 <autodoc>__le__(self, TimeSpan other) -
> bool
</autodoc>
25447 <param name=
"other" type=
"TimeSpan" default=
""/>
25450 <method name=
"__gt__" type=
"bool" overloaded=
"no">
25451 <autodoc>__gt__(self, TimeSpan other) -
> bool
</autodoc>
25453 <param name=
"other" type=
"TimeSpan" default=
""/>
25456 <method name=
"__ge__" type=
"bool" overloaded=
"no">
25457 <autodoc>__ge__(self, TimeSpan other) -
> bool
</autodoc>
25459 <param name=
"other" type=
"TimeSpan" default=
""/>
25462 <method name=
"__eq__" type=
"bool" overloaded=
"no">
25463 <autodoc>__eq__(self, TimeSpan other) -
> bool
</autodoc>
25465 <param name=
"other" type=
"TimeSpan" default=
""/>
25468 <method name=
"__ne__" type=
"bool" overloaded=
"no">
25469 <autodoc>__ne__(self, TimeSpan other) -
> bool
</autodoc>
25471 <param name=
"other" type=
"TimeSpan" default=
""/>
25474 <method name=
"IsNull" type=
"bool" overloaded=
"no">
25475 <autodoc>IsNull(self) -
> bool
</autodoc>
25477 <method name=
"IsPositive" type=
"bool" overloaded=
"no">
25478 <autodoc>IsPositive(self) -
> bool
</autodoc>
25480 <method name=
"IsNegative" type=
"bool" overloaded=
"no">
25481 <autodoc>IsNegative(self) -
> bool
</autodoc>
25483 <method name=
"IsEqualTo" type=
"bool" overloaded=
"no">
25484 <autodoc>IsEqualTo(self, TimeSpan ts) -
> bool
</autodoc>
25486 <param name=
"ts" type=
"TimeSpan" default=
""/>
25489 <method name=
"IsLongerThan" type=
"bool" overloaded=
"no">
25490 <autodoc>IsLongerThan(self, TimeSpan ts) -
> bool
</autodoc>
25492 <param name=
"ts" type=
"TimeSpan" default=
""/>
25495 <method name=
"IsShorterThan" type=
"bool" overloaded=
"no">
25496 <autodoc>IsShorterThan(self, TimeSpan t) -
> bool
</autodoc>
25498 <param name=
"t" type=
"TimeSpan" default=
""/>
25501 <method name=
"GetWeeks" type=
"int" overloaded=
"no">
25502 <autodoc>GetWeeks(self) -
> int
</autodoc>
25504 <method name=
"GetDays" type=
"int" overloaded=
"no">
25505 <autodoc>GetDays(self) -
> int
</autodoc>
25507 <method name=
"GetHours" type=
"int" overloaded=
"no">
25508 <autodoc>GetHours(self) -
> int
</autodoc>
25510 <method name=
"GetMinutes" type=
"int" overloaded=
"no">
25511 <autodoc>GetMinutes(self) -
> int
</autodoc>
25513 <method name=
"GetSeconds" type=
"wxLongLong" overloaded=
"no">
25514 <autodoc>GetSeconds(self) -
> wxLongLong
</autodoc>
25516 <method name=
"GetMilliseconds" type=
"wxLongLong" overloaded=
"no">
25517 <autodoc>GetMilliseconds(self) -
> wxLongLong
</autodoc>
25519 <method name=
"Format" type=
"String" overloaded=
"no">
25520 <autodoc>Format(self, String format=TimeSpanFormatStr) -
> String
</autodoc>
25522 <param name=
"format" type=
"String" default=
"wxPyTimeSpanFormatStr"/>
25526 <class name=
"DateSpan" oldname=
"wxDateSpan" module=
"_misc">
25527 <constructor name=
"DateSpan" overloaded=
"no">
25528 <autodoc>__init__(self, int years=
0, int months=
0, int weeks=
0, int days=
0) -
> DateSpan
</autodoc>
25530 <param name=
"years" type=
"int" default=
"0"/>
25531 <param name=
"months" type=
"int" default=
"0"/>
25532 <param name=
"weeks" type=
"int" default=
"0"/>
25533 <param name=
"days" type=
"int" default=
"0"/>
25536 <destructor name=
"~wxDateSpan" overloaded=
"no">
25537 <autodoc>__del__(self)
</autodoc>
25539 <staticmethod name=
"Days" type=
"DateSpan" overloaded=
"no">
25540 <autodoc>Days(int days) -
> DateSpan
</autodoc>
25542 <param name=
"days" type=
"int" default=
""/>
25545 <staticmethod name=
"Day" type=
"DateSpan" overloaded=
"no">
25546 <autodoc>Day() -
> DateSpan
</autodoc>
25548 <staticmethod name=
"Weeks" type=
"DateSpan" overloaded=
"no">
25549 <autodoc>Weeks(int weeks) -
> DateSpan
</autodoc>
25551 <param name=
"weeks" type=
"int" default=
""/>
25554 <staticmethod name=
"Week" type=
"DateSpan" overloaded=
"no">
25555 <autodoc>Week() -
> DateSpan
</autodoc>
25557 <staticmethod name=
"Months" type=
"DateSpan" overloaded=
"no">
25558 <autodoc>Months(int mon) -
> DateSpan
</autodoc>
25560 <param name=
"mon" type=
"int" default=
""/>
25563 <staticmethod name=
"Month" type=
"DateSpan" overloaded=
"no">
25564 <autodoc>Month() -
> DateSpan
</autodoc>
25566 <staticmethod name=
"Years" type=
"DateSpan" overloaded=
"no">
25567 <autodoc>Years(int years) -
> DateSpan
</autodoc>
25569 <param name=
"years" type=
"int" default=
""/>
25572 <staticmethod name=
"Year" type=
"DateSpan" overloaded=
"no">
25573 <autodoc>Year() -
> DateSpan
</autodoc>
25575 <method name=
"SetYears" type=
"DateSpan" overloaded=
"no">
25576 <autodoc>SetYears(self, int n) -
> DateSpan
</autodoc>
25578 <param name=
"n" type=
"int" default=
""/>
25581 <method name=
"SetMonths" type=
"DateSpan" overloaded=
"no">
25582 <autodoc>SetMonths(self, int n) -
> DateSpan
</autodoc>
25584 <param name=
"n" type=
"int" default=
""/>
25587 <method name=
"SetWeeks" type=
"DateSpan" overloaded=
"no">
25588 <autodoc>SetWeeks(self, int n) -
> DateSpan
</autodoc>
25590 <param name=
"n" type=
"int" default=
""/>
25593 <method name=
"SetDays" type=
"DateSpan" overloaded=
"no">
25594 <autodoc>SetDays(self, int n) -
> DateSpan
</autodoc>
25596 <param name=
"n" type=
"int" default=
""/>
25599 <method name=
"GetYears" type=
"int" overloaded=
"no">
25600 <autodoc>GetYears(self) -
> int
</autodoc>
25602 <method name=
"GetMonths" type=
"int" overloaded=
"no">
25603 <autodoc>GetMonths(self) -
> int
</autodoc>
25605 <method name=
"GetWeeks" type=
"int" overloaded=
"no">
25606 <autodoc>GetWeeks(self) -
> int
</autodoc>
25608 <method name=
"GetDays" type=
"int" overloaded=
"no">
25609 <autodoc>GetDays(self) -
> int
</autodoc>
25611 <method name=
"GetTotalDays" type=
"int" overloaded=
"no">
25612 <autodoc>GetTotalDays(self) -
> int
</autodoc>
25614 <method name=
"Add" type=
"DateSpan" overloaded=
"no">
25615 <autodoc>Add(self, DateSpan other) -
> DateSpan
</autodoc>
25617 <param name=
"other" type=
"DateSpan" default=
""/>
25620 <method name=
"Subtract" type=
"DateSpan" overloaded=
"no">
25621 <autodoc>Subtract(self, DateSpan other) -
> DateSpan
</autodoc>
25623 <param name=
"other" type=
"DateSpan" default=
""/>
25626 <method name=
"Neg" type=
"DateSpan" overloaded=
"no">
25627 <autodoc>Neg(self) -
> DateSpan
</autodoc>
25629 <method name=
"Multiply" type=
"DateSpan" overloaded=
"no">
25630 <autodoc>Multiply(self, int factor) -
> DateSpan
</autodoc>
25632 <param name=
"factor" type=
"int" default=
""/>
25635 <method name=
"__iadd__" type=
"DateSpan" overloaded=
"no">
25636 <autodoc>__iadd__(self, DateSpan other) -
> DateSpan
</autodoc>
25638 <param name=
"other" type=
"DateSpan" default=
""/>
25641 <method name=
"__isub__" type=
"DateSpan" overloaded=
"no">
25642 <autodoc>__isub__(self, DateSpan other) -
> DateSpan
</autodoc>
25644 <param name=
"other" type=
"DateSpan" default=
""/>
25647 <method name=
"__neg__" type=
"DateSpan" overloaded=
"no">
25648 <autodoc>__neg__(self) -
> DateSpan
</autodoc>
25650 <method name=
"__imul__" type=
"DateSpan" overloaded=
"no">
25651 <autodoc>__imul__(self, int factor) -
> DateSpan
</autodoc>
25653 <param name=
"factor" type=
"int" default=
""/>
25656 <method name=
"__add__" type=
"DateSpan" overloaded=
"no">
25657 <autodoc>__add__(self, DateSpan other) -
> DateSpan
</autodoc>
25659 <param name=
"other" type=
"DateSpan" default=
""/>
25662 <method name=
"__sub__" type=
"DateSpan" overloaded=
"no">
25663 <autodoc>__sub__(self, DateSpan other) -
> DateSpan
</autodoc>
25665 <param name=
"other" type=
"DateSpan" default=
""/>
25668 <method name=
"__mul__" type=
"DateSpan" overloaded=
"no">
25669 <autodoc>__mul__(self, int n) -
> DateSpan
</autodoc>
25671 <param name=
"n" type=
"int" default=
""/>
25674 <method name=
"__rmul__" type=
"DateSpan" overloaded=
"no">
25675 <autodoc>__rmul__(self, int n) -
> DateSpan
</autodoc>
25677 <param name=
"n" type=
"int" default=
""/>
25680 <method name=
"__eq__" type=
"bool" overloaded=
"no">
25681 <autodoc>__eq__(self, DateSpan other) -
> bool
</autodoc>
25683 <param name=
"other" type=
"DateSpan" default=
""/>
25686 <method name=
"__ne__" type=
"bool" overloaded=
"no">
25687 <autodoc>__ne__(self, DateSpan other) -
> bool
</autodoc>
25689 <param name=
"other" type=
"DateSpan" default=
""/>
25693 <method name=
"GetLocalTime" oldname=
"wxGetLocalTime" type=
"long" overloaded=
"no">
25694 <autodoc>GetLocalTime() -
> long
</autodoc>
25696 <method name=
"GetUTCTime" oldname=
"wxGetUTCTime" type=
"long" overloaded=
"no">
25697 <autodoc>GetUTCTime() -
> long
</autodoc>
25699 <method name=
"GetCurrentTime" oldname=
"wxGetCurrentTime" type=
"long" overloaded=
"no">
25700 <autodoc>GetCurrentTime() -
> long
</autodoc>
25702 <method name=
"GetLocalTimeMillis" oldname=
"wxGetLocalTimeMillis" type=
"wxLongLong" overloaded=
"no">
25703 <autodoc>GetLocalTimeMillis() -
> wxLongLong
</autodoc>
25706 #---------------------------------------------------------------------------
25708 <class name=
"DataFormat" oldname=
"wxDataFormat" module=
"_misc">
25709 <docstring>A wx.DataFormat is an encapsulation of a platform-specific format
25710 handle which is used by the system for the clipboard and drag and drop
25711 operations. The applications are usually only interested in, for
25712 example, pasting data from the clipboard only if the data is in a
25713 format the program understands. A data format is is used to uniquely
25714 identify this format.
25715 On the system level, a data format is usually just a number, (which
25716 may be the CLIPFORMAT under Windows or Atom under X11, for example.)
25718 The standard format IDs are:
25720 ================ =====================================
25721 wx.DF_INVALID An invalid format
25722 wx.DF_TEXT Text format
25723 wx.DF_BITMAP A bitmap (wx.Bitmap)
25724 wx.DF_METAFILE A metafile (wx.Metafile, Windows only)
25725 wx.DF_FILENAME A list of filenames
25726 wx.DF_HTML An HTML string. This is only valid on
25727 Windows and non-unicode builds
25728 ================ =====================================
25730 Aside the standard formats, the application may also use custom
25731 formats which are identified by their names (strings) and not numeric
25732 identifiers. Although internally custom format must be created (or
25733 registered) first, you shouldn't care about it because it is done
25734 automatically the first time the wxDataFormat object corresponding to
25735 a given format name is created.
25738 <constructor name=
"DataFormat" overloaded=
"no">
25739 <autodoc>__init__(self, int type) -
> DataFormat
</autodoc>
25740 <docstring>Constructs a data format object for one of the standard data formats
25741 or an empty data object (use SetType or SetId later in this case)
</docstring>
25743 <param name=
"type" type=
"wxDataFormatId" default=
""/>
25746 <constructor name=
"CustomDataFormat" overloaded=
"no">
25747 <autodoc>CustomDataFormat(String format) -
> DataFormat
</autodoc>
25748 <docstring>Constructs a data format object for a custom format identified by its
25751 <param name=
"format" type=
"String" default=
""/>
25754 <destructor name=
"~wxDataFormat" overloaded=
"no">
25755 <autodoc>__del__(self)
</autodoc>
25757 <method name=
"__eq__" type=
"bool" overloaded=
"yes">
25759 <param name=
"format" type=
"wxDataFormatId" default=
""/>
25762 <method name=
"__ne__" type=
"bool" overloaded=
"yes">
25764 <param name=
"format" type=
"wxDataFormatId" default=
""/>
25767 <method name=
"__eq__" type=
"bool" overloaded=
"yes">
25768 <autodoc>__eq__(self, int format) -
> bool
25769 __eq__(self, DataFormat format) -
> bool
</autodoc>
25771 <param name=
"format" type=
"DataFormat" default=
""/>
25774 <method name=
"__ne__" type=
"bool" overloaded=
"yes">
25775 <autodoc>__ne__(self, int format) -
> bool
25776 __ne__(self, DataFormat format) -
> bool
</autodoc>
25778 <param name=
"format" type=
"DataFormat" default=
""/>
25781 <method name=
"SetType" type=
"" overloaded=
"no">
25782 <autodoc>SetType(self, int format)
</autodoc>
25783 <docstring>Sets the format to the given value, which should be one of wx.DF_XXX
25784 constants.
</docstring>
25786 <param name=
"format" type=
"wxDataFormatId" default=
""/>
25789 <method name=
"GetType" type=
"wxDataFormatId" overloaded=
"no">
25790 <autodoc>GetType(self) -
> int
</autodoc>
25791 <docstring>Returns the platform-specific number identifying the format.
</docstring>
25793 <method name=
"GetId" type=
"String" overloaded=
"no">
25794 <autodoc>GetId(self) -
> String
</autodoc>
25795 <docstring>Returns the name of a custom format (this function will fail for a
25796 standard format).
</docstring>
25798 <method name=
"SetId" type=
"" overloaded=
"no">
25799 <autodoc>SetId(self, String format)
</autodoc>
25800 <docstring>Sets the format to be the custom format identified by the given name.
</docstring>
25802 <param name=
"format" type=
"String" default=
""/>
25806 <class name=
"DataObject" oldname=
"wxDataObject" module=
"_misc">
25807 <docstring>A wx.DataObject represents data that can be copied to or from the
25808 clipboard, or dragged and dropped. The important thing about
25809 wx.DataObject is that this is a 'smart' piece of data unlike usual
25810 'dumb' data containers such as memory buffers or files. Being 'smart'
25811 here means that the data object itself should know what data formats
25812 it supports and how to render itself in each of supported formats.
25814 **NOTE**: This class is an abstract base class and can not be used
25815 directly from Python. If you need a custom type of data object then
25816 you should instead derive from `wx.PyDataObjectSimple` or use
25817 `wx.CustomDataObject`.
25819 Not surprisingly, being 'smart' comes at a price of added
25820 complexity. This is reasonable for the situations when you really need
25821 to support multiple formats, but may be annoying if you only want to
25822 do something simple like cut and paste text.
25824 To provide a solution for both cases, wxWidgets has two predefined
25825 classes which derive from wx.DataObject: `wx.DataObjectSimple` and
25826 `wx.DataObjectComposite`. `wx.DataObjectSimple` is the simplest
25827 wx.DataObject possible and only holds data in a single format (such as
25828 text or bitmap) and `wx.DataObjectComposite` is the simplest way to
25829 implement a wx.DataObject which supports multiple simultaneous formats
25830 because it achievs this by simply holding several
25831 `wx.DataObjectSimple` objects.
25833 Please note that the easiest way to use drag and drop and the
25834 clipboard with multiple formats is by using `wx.DataObjectComposite`,
25835 but it is not the most efficient one as each `wx.DataObjectSimple`
25836 would contain the whole data in its respective formats. Now imagine
25837 that you want to paste
200 pages of text in your proprietary format,
25838 as well as Word, RTF, HTML, Unicode and plain text to the clipboard
25839 and even today's computers are in trouble. For this case, you will
25840 have to derive from wx.DataObject directly and make it enumerate its
25841 formats and provide the data in the requested format on
25842 demand. (**TODO**: This is currently not possible from Python. Make
25845 Note that the platform transfer mechanisms for the clipboard and drag
25846 and drop, do not copy any data out of the source application until
25847 another application actually requests the data. This is in contrast to
25848 the 'feel' offered to the user of a program who would normally think
25849 that the data resides in the clipboard after having pressed 'Copy' -
25850 in reality it is only declared to be available.
25852 <destructor name=
"~wxDataObject" overloaded=
"no">
25853 <autodoc>__del__(self)
</autodoc>
25855 <method name=
"GetPreferredFormat" type=
"DataFormat" overloaded=
"no">
25856 <autodoc>GetPreferredFormat(self, int dir=Get) -
> DataFormat
</autodoc>
25857 <docstring>Returns the preferred format for either rendering the data (if dir is
25858 Get, its default value) or for setting it. Usually this will be the
25859 native format of the wx.DataObject.
</docstring>
25861 <param name=
"dir" type=
"wxDataObject::Direction" default=
"wxDataObject::Get"/>
25864 <method name=
"GetFormatCount" type=
"size_t" overloaded=
"no">
25865 <autodoc>GetFormatCount(self, int dir=Get) -
> size_t
</autodoc>
25866 <docstring>Returns the number of available formats for rendering or setting the
25869 <param name=
"dir" type=
"wxDataObject::Direction" default=
"wxDataObject::Get"/>
25872 <method name=
"IsSupported" type=
"bool" overloaded=
"no">
25873 <autodoc>IsSupported(self, DataFormat format, int dir=Get) -
> bool
</autodoc>
25874 <docstring>Returns True if this format is supported.
</docstring>
25876 <param name=
"format" type=
"DataFormat" default=
""/>
25877 <param name=
"dir" type=
"wxDataObject::Direction" default=
"wxDataObject::Get"/>
25880 <method name=
"GetDataSize" type=
"size_t" overloaded=
"no">
25881 <autodoc>GetDataSize(self, DataFormat format) -
> size_t
</autodoc>
25882 <docstring>Get the (total) size of data for the given format
</docstring>
25884 <param name=
"format" type=
"DataFormat" default=
""/>
25887 <method name=
"GetAllFormats" type=
"PyObject" overloaded=
"no">
25888 <autodoc>GetAllFormats(self, int dir=Get) -
> [formats]
</autodoc>
25889 <docstring>Returns a list of all the wx.DataFormats that this dataobject supports
25890 in the given direction.
</docstring>
25892 <param name=
"dir" type=
"wxDataObject::Direction" default=
"wxDataObject::Get"/>
25895 <method name=
"GetDataHere" type=
"PyObject" overloaded=
"no">
25896 <autodoc>GetDataHere(self, DataFormat format) -
> String
</autodoc>
25897 <docstring>Get the data bytes in the specified format, returns None on failure.
25899 :todo: This should use the python buffer interface isntead...
</docstring>
25901 <param name=
"format" type=
"DataFormat" default=
""/>
25904 <method name=
"SetData" type=
"bool" overloaded=
"no">
25905 <autodoc>SetData(self, DataFormat format, String data) -
> bool
</autodoc>
25906 <docstring>Set the data in the specified format from the bytes in the the data string.
25908 :todo: This should use the python buffer interface isntead...
</docstring>
25910 <param name=
"format" type=
"DataFormat" default=
""/>
25911 <param name=
"data" type=
"PyObject" default=
""/>
25915 <class name=
"DataObjectSimple" oldname=
"wxDataObjectSimple" module=
"_misc">
25916 <docstring>wx.DataObjectSimple is a `wx.DataObject` which only supports one
25917 format. This is the simplest possible `wx.DataObject` implementation.
25919 This is still an "abstract base class" meaning that you can't use it
25920 directly. You either need to use one of the predefined base classes,
25921 or derive your own class from `wx.PyDataObjectSimple`.
25923 <baseclass name=
"DataObject"/>
25924 <constructor name=
"DataObjectSimple" overloaded=
"no">
25925 <autodoc>__init__(self, DataFormat format=FormatInvalid) -
> DataObjectSimple
</autodoc>
25926 <docstring>Constructor accepts the supported format (none by default) which may
25927 also be set later with `SetFormat`.
</docstring>
25929 <param name=
"format" type=
"DataFormat" default=
"wxFormatInvalid"/>
25932 <method name=
"GetFormat" type=
"DataFormat" overloaded=
"no">
25933 <autodoc>GetFormat(self) -
> DataFormat
</autodoc>
25934 <docstring>Returns the (one and only one) format supported by this object. It is
25935 assumed that the format is supported in both directions.
</docstring>
25937 <method name=
"SetFormat" type=
"" overloaded=
"no">
25938 <autodoc>SetFormat(self, DataFormat format)
</autodoc>
25939 <docstring>Sets the supported format.
</docstring>
25941 <param name=
"format" type=
"DataFormat" default=
""/>
25944 <method name=
"GetDataSize" type=
"size_t" overloaded=
"no">
25945 <autodoc>GetDataSize(self) -
> size_t
</autodoc>
25946 <docstring>Get the size of our data.
</docstring>
25948 <method name=
"GetDataHere" type=
"PyObject" overloaded=
"no">
25949 <autodoc>GetDataHere(self) -
> String
</autodoc>
25950 <docstring>Returns the data bytes from the data object as a string, returns None
25951 on failure. Must be implemented in the derived class if the object
25952 supports rendering its data.
</docstring>
25954 <method name=
"SetData" type=
"bool" overloaded=
"no">
25955 <autodoc>SetData(self, String data) -
> bool
</autodoc>
25956 <docstring>Copy the data value to the data object. Must be implemented in the
25957 derived class if the object supports setting its data.
25960 <param name=
"data" type=
"PyObject" default=
""/>
25964 <class name=
"PyDataObjectSimple" oldname=
"wxPyDataObjectSimple" module=
"_misc">
25965 <docstring>wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
25966 Python-aware and knows how to reflect calls to its C++ virtual methods
25967 to methods in the Python derived class. You should derive from this
25968 class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
25969 need to create your own simple single-format type of `wx.DataObject`.
25971 Here is a simple example::
25973 class MyDataObject(wx.PyDataObjectSimple):
25974 def __init__(self):
25975 wx.PyDataObjectSimple.__init__(
25976 self, wx.CustomDataFormat('MyDOFormat'))
25979 def GetDataSize(self):
25980 return len(self.data)
25981 def GetDataHere(self):
25982 return self.data # returns a string
25983 def SetData(self, data):
25987 Note that there is already a `wx.CustomDataObject` class that behaves
25988 very similarly to this example. The value of creating your own
25989 derived class like this is to be able to do additional things when the
25990 data is requested or given via the clipboard or drag and drop
25991 operation, such as generate the data value or decode it into needed
25994 <baseclass name=
"DataObjectSimple"/>
25995 <constructor name=
"PyDataObjectSimple" overloaded=
"no">
25996 <autodoc>__init__(self, DataFormat format=FormatInvalid) -
> PyDataObjectSimple
</autodoc>
25997 <docstring>wx.PyDataObjectSimple is a version of `wx.DataObjectSimple` that is
25998 Python-aware and knows how to reflect calls to its C++ virtual methods
25999 to methods in the Python derived class. You should derive from this
26000 class and overload `GetDataSize`, `GetDataHere` and `SetData` when you
26001 need to create your own simple single-format type of `wx.DataObject`.
26003 Here is a simple example::
26005 class MyDataObject(wx.PyDataObjectSimple):
26006 def __init__(self):
26007 wx.PyDataObjectSimple.__init__(
26008 self, wx.CustomDataFormat('MyDOFormat'))
26011 def GetDataSize(self):
26012 return len(self.data)
26013 def GetDataHere(self):
26014 return self.data # returns a string
26015 def SetData(self, data):
26019 Note that there is already a `wx.CustomDataObject` class that behaves
26020 very similarly to this example. The value of creating your own
26021 derived class like this is to be able to do additional things when the
26022 data is requested or given via the clipboard or drag and drop
26023 operation, such as generate the data value or decode it into needed
26027 <param name=
"format" type=
"DataFormat" default=
"wxFormatInvalid"/>
26030 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
26031 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
26033 <param name=
"self" type=
"PyObject" default=
""/>
26034 <param name=
"_class" type=
"PyObject" default=
""/>
26038 <class name=
"DataObjectComposite" oldname=
"wxDataObjectComposite" module=
"_misc">
26039 <docstring>wx.DataObjectComposite is the simplest `wx.DataObject` derivation
26040 which may be sued to support multiple formats. It contains several
26041 'wx.DataObjectSimple` objects and supports any format supported by at
26042 least one of them. Only one of these data objects is *preferred* (the
26043 first one if not explicitly changed by using the second parameter of
26044 `Add`) and its format determines the preferred format of the composite
26045 data object as well.
26047 See `wx.DataObject` documentation for the reasons why you might prefer
26048 to use wx.DataObject directly instead of wx.DataObjectComposite for
26049 efficiency reasons.
26051 <baseclass name=
"DataObject"/>
26052 <constructor name=
"DataObjectComposite" overloaded=
"no">
26053 <autodoc>__init__(self) -
> DataObjectComposite
</autodoc>
26054 <docstring>wx.DataObjectComposite is the simplest `wx.DataObject` derivation
26055 which may be sued to support multiple formats. It contains several
26056 'wx.DataObjectSimple` objects and supports any format supported by at
26057 least one of them. Only one of these data objects is *preferred* (the
26058 first one if not explicitly changed by using the second parameter of
26059 `Add`) and its format determines the preferred format of the composite
26060 data object as well.
26062 See `wx.DataObject` documentation for the reasons why you might prefer
26063 to use wx.DataObject directly instead of wx.DataObjectComposite for
26064 efficiency reasons.
26067 <method name=
"Add" type=
"" overloaded=
"no">
26068 <autodoc>Add(self, DataObjectSimple dataObject, bool preferred=False)
</autodoc>
26069 <docstring>Adds the dataObject to the list of supported objects and it becomes
26070 the preferred object if preferred is True.
</docstring>
26072 <param name=
"dataObject" type=
"DataObjectSimple" default=
""/>
26073 <param name=
"preferred" type=
"bool" default=
"False"/>
26077 <class name=
"TextDataObject" oldname=
"wxTextDataObject" module=
"_misc">
26078 <docstring>wx.TextDataObject is a specialization of `wx.DataObject` for text
26079 data. It can be used without change to paste data into the `wx.Clipboard`
26080 or a `wx.DropSource`.
26082 Alternativly, you may wish to derive a new class from the
26083 `wx.PyTextDataObject` class for providing text on-demand in order to
26084 minimize memory consumption when offering data in several formats,
26085 such as plain text and RTF, because by default the text is stored in a
26086 string in this class, but it might as well be generated on demand when
26087 requested. For this, `GetTextLength` and `GetText` will have to be
26088 overridden.
</docstring>
26089 <baseclass name=
"DataObjectSimple"/>
26090 <constructor name=
"TextDataObject" overloaded=
"no">
26091 <autodoc>__init__(self, String text=EmptyString) -
> TextDataObject
</autodoc>
26092 <docstring>Constructor, may be used to initialise the text (otherwise `SetText`
26093 should be used later).
</docstring>
26095 <param name=
"text" type=
"String" default=
"wxPyEmptyString"/>
26098 <method name=
"GetTextLength" type=
"size_t" overloaded=
"no">
26099 <autodoc>GetTextLength(self) -
> size_t
</autodoc>
26100 <docstring>Returns the data size. By default, returns the size of the text data
26101 set in the constructor or using `SetText`. This can be overridden (via
26102 `wx.PyTextDataObject`) to provide text size data on-demand. It is
26103 recommended to return the text length plus
1 for a trailing zero, but
26104 this is not strictly required.
</docstring>
26106 <method name=
"GetText" type=
"String" overloaded=
"no">
26107 <autodoc>GetText(self) -
> String
</autodoc>
26108 <docstring>Returns the text associated with the data object.
</docstring>
26110 <method name=
"SetText" type=
"" overloaded=
"no">
26111 <autodoc>SetText(self, String text)
</autodoc>
26112 <docstring>Sets the text associated with the data object. This method is called
26113 when the data object receives the data and, by default, copies the
26114 text into the member variable. If you want to process the text on the
26115 fly you may wish to override this function (via
26116 `wx.PyTextDataObject`.)
</docstring>
26118 <param name=
"text" type=
"String" default=
""/>
26122 <class name=
"PyTextDataObject" oldname=
"wxPyTextDataObject" module=
"_misc">
26123 <docstring>wx.PyTextDataObject is a version of `wx.TextDataObject` that is
26124 Python-aware and knows how to reflect calls to its C++ virtual methods
26125 to methods in the Python derived class. You should derive from this
26126 class and overload `GetTextLength`, `GetText`, and `SetText` when you
26127 want to be able to provide text on demand instead of preloading it
26128 into the data object.
</docstring>
26129 <baseclass name=
"TextDataObject"/>
26130 <constructor name=
"PyTextDataObject" overloaded=
"no">
26131 <autodoc>__init__(self, String text=EmptyString) -
> PyTextDataObject
</autodoc>
26132 <docstring>wx.PyTextDataObject is a version of `wx.TextDataObject` that is
26133 Python-aware and knows how to reflect calls to its C++ virtual methods
26134 to methods in the Python derived class. You should derive from this
26135 class and overload `GetTextLength`, `GetText`, and `SetText` when you
26136 want to be able to provide text on demand instead of preloading it
26137 into the data object.
</docstring>
26139 <param name=
"text" type=
"String" default=
"wxPyEmptyString"/>
26142 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
26143 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
26145 <param name=
"self" type=
"PyObject" default=
""/>
26146 <param name=
"_class" type=
"PyObject" default=
""/>
26150 <class name=
"BitmapDataObject" oldname=
"wxBitmapDataObject" module=
"_misc">
26151 <docstring>wx.BitmapDataObject is a specialization of wxDataObject for bitmap
26152 data. It can be used without change to paste data into the `wx.Clipboard`
26153 or a `wx.DropSource`.
26155 :see: `wx.PyBitmapDataObject` if you wish to override `GetBitmap` to increase efficiency.
</docstring>
26156 <baseclass name=
"DataObjectSimple"/>
26157 <constructor name=
"BitmapDataObject" overloaded=
"no">
26158 <autodoc>__init__(self, Bitmap bitmap=wxNullBitmap) -
> BitmapDataObject
</autodoc>
26159 <docstring>Constructor, optionally passing a bitmap (otherwise use `SetBitmap`
26160 later).
</docstring>
26162 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
26165 <method name=
"GetBitmap" type=
"Bitmap" overloaded=
"no">
26166 <autodoc>GetBitmap(self) -
> Bitmap
</autodoc>
26167 <docstring>Returns the bitmap associated with the data object. You may wish to
26168 override this method (by deriving from `wx.PyBitmapDataObject`) when
26169 offering data on-demand, but this is not required by wxWidgets'
26170 internals. Use this method to get data in bitmap form from the
26171 `wx.Clipboard`.
</docstring>
26173 <method name=
"SetBitmap" type=
"" overloaded=
"no">
26174 <autodoc>SetBitmap(self, Bitmap bitmap)
</autodoc>
26175 <docstring>Sets the bitmap associated with the data object. This method is called
26176 when the data object receives data. Usually there will be no reason to
26177 override this function.
</docstring>
26179 <param name=
"bitmap" type=
"Bitmap" default=
""/>
26183 <class name=
"PyBitmapDataObject" oldname=
"wxPyBitmapDataObject" module=
"_misc">
26184 <docstring>wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
26185 Python-aware and knows how to reflect calls to its C++ virtual methods
26186 to methods in the Python derived class. To be able to provide bitmap
26187 data on demand derive from this class and overload `GetBitmap`.
</docstring>
26188 <baseclass name=
"BitmapDataObject"/>
26189 <constructor name=
"PyBitmapDataObject" overloaded=
"no">
26190 <autodoc>__init__(self, Bitmap bitmap=wxNullBitmap) -
> PyBitmapDataObject
</autodoc>
26191 <docstring>wx.PyBitmapDataObject is a version of `wx.BitmapDataObject` that is
26192 Python-aware and knows how to reflect calls to its C++ virtual methods
26193 to methods in the Python derived class. To be able to provide bitmap
26194 data on demand derive from this class and overload `GetBitmap`.
</docstring>
26196 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
26199 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
26200 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
26202 <param name=
"self" type=
"PyObject" default=
""/>
26203 <param name=
"_class" type=
"PyObject" default=
""/>
26207 <class name=
"FileDataObject" oldname=
"wxFileDataObject" module=
"_misc">
26208 <docstring>wx.FileDataObject is a specialization of `wx.DataObjectSimple` for
26209 file names. The program works with it just as if it were a list of
26210 absolute file names, but internally it uses the same format as
26211 Explorer and other compatible programs under Windows or GNOME/KDE
26212 filemanager under Unix which makes it possible to receive files from
26213 them using this class.
26215 :Warning: Under all non-Windows platforms this class is currently
26216 "input-only", i.e. you can receive the files from another
26217 application, but copying (or dragging) file(s) from a wxWidgets
26218 application is not currently supported.
26220 <baseclass name=
"DataObjectSimple"/>
26221 <constructor name=
"FileDataObject" overloaded=
"no">
26222 <autodoc>__init__(self) -
> FileDataObject
</autodoc>
26224 <method name=
"GetFilenames" type=
"wxArrayString" overloaded=
"no">
26225 <autodoc>GetFilenames(self) -
> [names]
</autodoc>
26226 <docstring>Returns a list of file names.
</docstring>
26228 <method name=
"AddFile" type=
"" overloaded=
"no">
26229 <autodoc>AddFile(self, String filename)
</autodoc>
26230 <docstring>Adds a file to the list of files represented by this data object.
</docstring>
26232 <param name=
"filename" type=
"String" default=
""/>
26236 <class name=
"CustomDataObject" oldname=
"wxCustomDataObject" module=
"_misc">
26237 <docstring>wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
26238 some application-specific data in arbitrary format. Python strings
26239 are used for getting and setting data, but any picklable object can
26240 easily be transfered via strings. A copy of the data is stored in the
26241 data object.
</docstring>
26242 <baseclass name=
"DataObjectSimple"/>
26243 <constructor name=
"CustomDataObject" overloaded=
"no">
26244 <autodoc>__init__(self, DataFormat format=FormatInvalid) -
> CustomDataObject
</autodoc>
26245 <docstring>wx.CustomDataObject is a specialization of `wx.DataObjectSimple` for
26246 some application-specific data in arbitrary format. Python strings
26247 are used for getting and setting data, but any picklable object can
26248 easily be transfered via strings. A copy of the data is stored in the
26249 data object.
</docstring>
26251 <param name=
"format" type=
"DataFormat" default=
"wxFormatInvalid"/>
26254 <method name=
"SetData" type=
"bool" overloaded=
"no">
26255 <autodoc>SetData(self, String data) -
> bool
</autodoc>
26256 <docstring>Copy the data value to the data object.
</docstring>
26258 <param name=
"data" type=
"PyObject" default=
""/>
26261 <method name=
"GetSize" type=
"size_t" overloaded=
"no">
26262 <autodoc>GetSize(self) -
> size_t
</autodoc>
26263 <docstring>Get the size of the data.
</docstring>
26265 <method name=
"GetData" type=
"PyObject" overloaded=
"no">
26266 <autodoc>GetData(self) -
> String
</autodoc>
26267 <docstring>Returns the data bytes from the data object as a string.
</docstring>
26270 <class name=
"URLDataObject" oldname=
"wxURLDataObject" module=
"_misc">
26271 <docstring>This data object holds a URL in a format that is compatible with some
26272 browsers such that it is able to be dragged to or from them.
</docstring>
26273 <baseclass name=
"DataObjectComposite"/>
26274 <constructor name=
"URLDataObject" overloaded=
"no">
26275 <autodoc>__init__(self) -
> URLDataObject
</autodoc>
26276 <docstring>This data object holds a URL in a format that is compatible with some
26277 browsers such that it is able to be dragged to or from them.
</docstring>
26279 <method name=
"GetURL" type=
"String" overloaded=
"no">
26280 <autodoc>GetURL(self) -
> String
</autodoc>
26281 <docstring>Returns a string containing the current URL.
</docstring>
26283 <method name=
"SetURL" type=
"" overloaded=
"no">
26284 <autodoc>SetURL(self, String url)
</autodoc>
26285 <docstring>Set the URL.
</docstring>
26287 <param name=
"url" type=
"String" default=
""/>
26291 <class name=
"MetafileDataObject" oldname=
"wxMetafileDataObject" module=
"_misc">
26292 <baseclass name=
"DataObjectSimple"/>
26293 <constructor name=
"MetafileDataObject" overloaded=
"no">
26294 <autodoc>__init__(self) -
> MetafileDataObject
</autodoc>
26298 #---------------------------------------------------------------------------
26300 <method name=
"IsDragResultOk" oldname=
"wxIsDragResultOk" type=
"bool" overloaded=
"no">
26301 <autodoc>IsDragResultOk(int res) -
> bool
</autodoc>
26303 <param name=
"res" type=
"wxDragResult" default=
""/>
26306 <class name=
"DropSource" oldname=
"wxPyDropSource" module=
"_misc">
26307 <constructor name=
"wxPyDropSource" overloaded=
"no">
26308 <autodoc>__init__(self, Window win, Icon copy=wxNullIcon, Icon move=wxNullIcon,
26309 Icon none=wxNullIcon) -
> DropSource
</autodoc>
26311 <param name=
"win" type=
"Window" default=
""/>
26312 <param name=
"copy" type=
"Icon" default=
"wxNullIcon"/>
26313 <param name=
"move" type=
"Icon" default=
"wxNullIcon"/>
26314 <param name=
"none" type=
"Icon" default=
"wxNullIcon"/>
26317 <destructor name=
"~wxPyDropSource" overloaded=
"no">
26318 <autodoc>__del__(self)
</autodoc>
26320 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
26321 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref)
</autodoc>
26323 <param name=
"self" type=
"PyObject" default=
""/>
26324 <param name=
"_class" type=
"PyObject" default=
""/>
26325 <param name=
"incref" type=
"int" default=
""/>
26328 <method name=
"SetData" type=
"" overloaded=
"no">
26329 <autodoc>SetData(self, DataObject data)
</autodoc>
26331 <param name=
"data" type=
"DataObject" default=
""/>
26334 <method name=
"GetDataObject" type=
"DataObject" overloaded=
"no">
26335 <autodoc>GetDataObject(self) -
> DataObject
</autodoc>
26337 <method name=
"SetCursor" type=
"" overloaded=
"no">
26338 <autodoc>SetCursor(self, int res, Cursor cursor)
</autodoc>
26340 <param name=
"res" type=
"wxDragResult" default=
""/>
26341 <param name=
"cursor" type=
"Cursor" default=
""/>
26344 <method name=
"DoDragDrop" type=
"wxDragResult" overloaded=
"no">
26345 <autodoc>DoDragDrop(self, int flags=Drag_CopyOnly) -
> int
</autodoc>
26347 <param name=
"flags" type=
"int" default=
"wxDrag_CopyOnly"/>
26350 <method name=
"base_GiveFeedback" type=
"bool" overloaded=
"no">
26351 <autodoc>base_GiveFeedback(self, int effect) -
> bool
</autodoc>
26353 <param name=
"effect" type=
"wxDragResult" default=
""/>
26357 <class name=
"DropTarget" oldname=
"wxPyDropTarget" module=
"_misc">
26358 <constructor name=
"DropTarget" overloaded=
"no">
26359 <autodoc>__init__(self, DataObject dataObject=None) -
> DropTarget
</autodoc>
26361 <param name=
"dataObject" type=
"DataObject" default=
"NULL"/>
26364 <destructor name=
"~wxPyDropTarget" overloaded=
"no">
26365 <autodoc>__del__(self)
</autodoc>
26367 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
26368 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
26370 <param name=
"self" type=
"PyObject" default=
""/>
26371 <param name=
"_class" type=
"PyObject" default=
""/>
26374 <method name=
"GetDataObject" type=
"DataObject" overloaded=
"no">
26375 <autodoc>GetDataObject(self) -
> DataObject
</autodoc>
26377 <method name=
"SetDataObject" type=
"" overloaded=
"no">
26378 <autodoc>SetDataObject(self, DataObject dataObject)
</autodoc>
26380 <param name=
"dataObject" type=
"DataObject" default=
""/>
26383 <method name=
"base_OnEnter" type=
"wxDragResult" overloaded=
"no">
26384 <autodoc>base_OnEnter(self, int x, int y, int def) -
> int
</autodoc>
26386 <param name=
"x" type=
"int" default=
""/>
26387 <param name=
"y" type=
"int" default=
""/>
26388 <param name=
"def" type=
"wxDragResult" default=
""/>
26391 <method name=
"base_OnDragOver" type=
"wxDragResult" overloaded=
"no">
26392 <autodoc>base_OnDragOver(self, int x, int y, int def) -
> int
</autodoc>
26394 <param name=
"x" type=
"int" default=
""/>
26395 <param name=
"y" type=
"int" default=
""/>
26396 <param name=
"def" type=
"wxDragResult" default=
""/>
26399 <method name=
"base_OnLeave" type=
"" overloaded=
"no">
26400 <autodoc>base_OnLeave(self)
</autodoc>
26402 <method name=
"base_OnDrop" type=
"bool" overloaded=
"no">
26403 <autodoc>base_OnDrop(self, int x, int y) -
> bool
</autodoc>
26405 <param name=
"x" type=
"int" default=
""/>
26406 <param name=
"y" type=
"int" default=
""/>
26409 <method name=
"GetData" type=
"bool" overloaded=
"no">
26410 <autodoc>GetData(self) -
> bool
</autodoc>
26413 <pythoncode> PyDropTarget = DropTarget
</pythoncode>
26414 <class name=
"TextDropTarget" oldname=
"wxPyTextDropTarget" module=
"_misc">
26415 <baseclass name=
"DropTarget"/>
26416 <constructor name=
"wxPyTextDropTarget" overloaded=
"no">
26417 <autodoc>__init__(self) -
> TextDropTarget
</autodoc>
26419 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
26420 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
26422 <param name=
"self" type=
"PyObject" default=
""/>
26423 <param name=
"_class" type=
"PyObject" default=
""/>
26426 <method name=
"base_OnEnter" type=
"wxDragResult" overloaded=
"no">
26427 <autodoc>base_OnEnter(self, int x, int y, int def) -
> int
</autodoc>
26429 <param name=
"x" type=
"int" default=
""/>
26430 <param name=
"y" type=
"int" default=
""/>
26431 <param name=
"def" type=
"wxDragResult" default=
""/>
26434 <method name=
"base_OnDragOver" type=
"wxDragResult" overloaded=
"no">
26435 <autodoc>base_OnDragOver(self, int x, int y, int def) -
> int
</autodoc>
26437 <param name=
"x" type=
"int" default=
""/>
26438 <param name=
"y" type=
"int" default=
""/>
26439 <param name=
"def" type=
"wxDragResult" default=
""/>
26442 <method name=
"base_OnLeave" type=
"" overloaded=
"no">
26443 <autodoc>base_OnLeave(self)
</autodoc>
26445 <method name=
"base_OnDrop" type=
"bool" overloaded=
"no">
26446 <autodoc>base_OnDrop(self, int x, int y) -
> bool
</autodoc>
26448 <param name=
"x" type=
"int" default=
""/>
26449 <param name=
"y" type=
"int" default=
""/>
26452 <method name=
"base_OnData" type=
"wxDragResult" overloaded=
"no">
26453 <autodoc>base_OnData(self, int x, int y, int def) -
> int
</autodoc>
26455 <param name=
"x" type=
"int" default=
""/>
26456 <param name=
"y" type=
"int" default=
""/>
26457 <param name=
"def" type=
"wxDragResult" default=
""/>
26461 <class name=
"FileDropTarget" oldname=
"wxPyFileDropTarget" module=
"_misc">
26462 <baseclass name=
"DropTarget"/>
26463 <constructor name=
"wxPyFileDropTarget" overloaded=
"no">
26464 <autodoc>__init__(self) -
> FileDropTarget
</autodoc>
26466 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
26467 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
26469 <param name=
"self" type=
"PyObject" default=
""/>
26470 <param name=
"_class" type=
"PyObject" default=
""/>
26473 <method name=
"base_OnEnter" type=
"wxDragResult" overloaded=
"no">
26474 <autodoc>base_OnEnter(self, int x, int y, int def) -
> int
</autodoc>
26476 <param name=
"x" type=
"int" default=
""/>
26477 <param name=
"y" type=
"int" default=
""/>
26478 <param name=
"def" type=
"wxDragResult" default=
""/>
26481 <method name=
"base_OnDragOver" type=
"wxDragResult" overloaded=
"no">
26482 <autodoc>base_OnDragOver(self, int x, int y, int def) -
> int
</autodoc>
26484 <param name=
"x" type=
"int" default=
""/>
26485 <param name=
"y" type=
"int" default=
""/>
26486 <param name=
"def" type=
"wxDragResult" default=
""/>
26489 <method name=
"base_OnLeave" type=
"" overloaded=
"no">
26490 <autodoc>base_OnLeave(self)
</autodoc>
26492 <method name=
"base_OnDrop" type=
"bool" overloaded=
"no">
26493 <autodoc>base_OnDrop(self, int x, int y) -
> bool
</autodoc>
26495 <param name=
"x" type=
"int" default=
""/>
26496 <param name=
"y" type=
"int" default=
""/>
26499 <method name=
"base_OnData" type=
"wxDragResult" overloaded=
"no">
26500 <autodoc>base_OnData(self, int x, int y, int def) -
> int
</autodoc>
26502 <param name=
"x" type=
"int" default=
""/>
26503 <param name=
"y" type=
"int" default=
""/>
26504 <param name=
"def" type=
"wxDragResult" default=
""/>
26509 #---------------------------------------------------------------------------
26511 <class name=
"Clipboard" oldname=
"wxClipboard" module=
"_misc">
26512 <docstring>wx.Clipboard represents the system clipboard and provides methods to
26513 copy data to it or paste data from it. Normally, you should only use
26514 ``wx.TheClipboard`` which is a reference to a global wx.Clipboard
26517 Call ``wx.TheClipboard``'s `Open` method to get ownership of the
26518 clipboard. If this operation returns True, you now own the
26519 clipboard. Call `SetData` to put data on the clipboard, or `GetData`
26520 to retrieve data from the clipboard. Call `Close` to close the
26521 clipboard and relinquish ownership. You should keep the clipboard open
26524 :see: `wx.DataObject`
26526 <baseclass name=
"Object"/>
26527 <constructor name=
"Clipboard" overloaded=
"no">
26528 <autodoc>__init__(self) -
> Clipboard
</autodoc>
26530 <destructor name=
"~wxClipboard" overloaded=
"no">
26531 <autodoc>__del__(self)
</autodoc>
26533 <method name=
"Open" type=
"bool" overloaded=
"no">
26534 <autodoc>Open(self) -
> bool
</autodoc>
26535 <docstring>Call this function to open the clipboard before calling SetData and
26536 GetData. Call Close when you have finished with the clipboard. You
26537 should keep the clipboard open for only a very short time. Returns
26538 True on success.
</docstring>
26540 <method name=
"Close" type=
"" overloaded=
"no">
26541 <autodoc>Close(self)
</autodoc>
26542 <docstring>Closes the clipboard.
</docstring>
26544 <method name=
"IsOpened" type=
"bool" overloaded=
"no">
26545 <autodoc>IsOpened(self) -
> bool
</autodoc>
26546 <docstring>Query whether the clipboard is opened
</docstring>
26548 <method name=
"AddData" type=
"bool" overloaded=
"no">
26549 <autodoc>AddData(self, DataObject data) -
> bool
</autodoc>
26550 <docstring>Call this function to add the data object to the clipboard. You may
26551 call this function repeatedly after having cleared the clipboard.
26552 After this function has been called, the clipboard owns the data, so
26553 do not delete the data explicitly.
26555 :see: `wx.DataObject`
</docstring>
26557 <param name=
"data" type=
"DataObject" default=
""/>
26560 <method name=
"SetData" type=
"bool" overloaded=
"no">
26561 <autodoc>SetData(self, DataObject data) -
> bool
</autodoc>
26562 <docstring>Set the clipboard data, this is the same as `Clear` followed by
26565 :see: `wx.DataObject`
</docstring>
26567 <param name=
"data" type=
"DataObject" default=
""/>
26570 <method name=
"IsSupported" type=
"bool" overloaded=
"no">
26571 <autodoc>IsSupported(self, DataFormat format) -
> bool
</autodoc>
26572 <docstring>Returns True if the given format is available in the data object(s) on
26573 the clipboard.
</docstring>
26575 <param name=
"format" type=
"DataFormat" default=
""/>
26578 <method name=
"GetData" type=
"bool" overloaded=
"no">
26579 <autodoc>GetData(self, DataObject data) -
> bool
</autodoc>
26580 <docstring>Call this function to fill data with data on the clipboard, if
26581 available in the required format. Returns true on success.
</docstring>
26583 <param name=
"data" type=
"DataObject" default=
""/>
26586 <method name=
"Clear" type=
"" overloaded=
"no">
26587 <autodoc>Clear(self)
</autodoc>
26588 <docstring>Clears data from the clipboard object and also the system's clipboard
26589 if possible.
</docstring>
26591 <method name=
"Flush" type=
"bool" overloaded=
"no">
26592 <autodoc>Flush(self) -
> bool
</autodoc>
26593 <docstring>Flushes the clipboard: this means that the data which is currently on
26594 clipboard will stay available even after the application exits,
26595 possibly eating memory, otherwise the clipboard will be emptied on
26596 exit. Returns False if the operation is unsuccesful for any reason.
</docstring>
26598 <method name=
"UsePrimarySelection" type=
"" overloaded=
"no">
26599 <autodoc>UsePrimarySelection(self, bool primary=True)
</autodoc>
26600 <docstring>On platforms supporting it (the X11 based platforms), selects the
26601 so called PRIMARY SELECTION as the clipboard as opposed to the
26602 normal clipboard, if primary is True.
</docstring>
26604 <param name=
"primary" type=
"bool" default=
"True"/>
26607 <staticmethod name=
"Get" type=
"Clipboard" overloaded=
"no">
26608 <autodoc>Get() -
> Clipboard
</autodoc>
26609 <docstring>Returns global instance (wxTheClipboard) of the object.
</docstring>
26613 class _wxPyDelayedInitWrapper(object):
26614 def __init__(self, initfunc, *args, **kwargs):
26615 self._initfunc = initfunc
26617 self._kwargs = kwargs
26618 self._instance = None
26619 def _checkInstance(self):
26620 if self._instance is None:
26621 self._instance = self._initfunc(*self._args, **self._kwargs)
26622 def __getattr__(self, name):
26623 self._checkInstance()
26624 return getattr(self._instance, name)
26625 def __repr__(self):
26626 self._checkInstance()
26627 return repr(self._instance)
26628 TheClipboard = _wxPyDelayedInitWrapper(Clipboard.Get)
26630 <class name=
"ClipboardLocker" oldname=
"wxClipboardLocker" module=
"_misc">
26631 <docstring>A helpful class for opening the clipboard and automatically
26632 closing it when the locker is destroyed.
</docstring>
26633 <constructor name=
"ClipboardLocker" overloaded=
"no">
26634 <autodoc>__init__(self, Clipboard clipboard=None) -
> ClipboardLocker
</autodoc>
26635 <docstring>A helpful class for opening the clipboard and automatically
26636 closing it when the locker is destroyed.
</docstring>
26638 <param name=
"clipboard" type=
"Clipboard" default=
"NULL"/>
26641 <destructor name=
"~wxClipboardLocker" overloaded=
"no">
26642 <autodoc>__del__(self)
</autodoc>
26644 <method name=
"__nonzero__" type=
"bool" overloaded=
"no">
26645 <autodoc>__nonzero__(self) -
> bool
</autodoc>
26646 <docstring>A ClipboardLocker instance evaluates to True if the clipboard was
26647 successfully opened.
</docstring>
26651 #---------------------------------------------------------------------------
26653 <class name=
"VideoMode" oldname=
"wxVideoMode" module=
"_misc">
26654 <docstring>A simple struct containing video mode parameters for a display
</docstring>
26655 <constructor name=
"VideoMode" overloaded=
"no">
26656 <autodoc>__init__(self, int width=
0, int height=
0, int depth=
0, int freq=
0) -
> VideoMode
</autodoc>
26657 <docstring>A simple struct containing video mode parameters for a display
</docstring>
26659 <param name=
"width" type=
"int" default=
"0"/>
26660 <param name=
"height" type=
"int" default=
"0"/>
26661 <param name=
"depth" type=
"int" default=
"0"/>
26662 <param name=
"freq" type=
"int" default=
"0"/>
26665 <destructor name=
"~wxVideoMode" overloaded=
"no">
26666 <autodoc>__del__(self)
</autodoc>
26668 <method name=
"Matches" type=
"bool" overloaded=
"no">
26669 <autodoc>Matches(self, VideoMode other) -
> bool
</autodoc>
26670 <docstring>Returns true if this mode matches the other one in the sense that all
26671 non zero fields of the other mode have the same value in this
26672 one (except for refresh which is allowed to have a greater value)
</docstring>
26674 <param name=
"other" type=
"VideoMode" default=
""/>
26677 <method name=
"GetWidth" type=
"int" overloaded=
"no">
26678 <autodoc>GetWidth(self) -
> int
</autodoc>
26679 <docstring>Returns the screen width in pixels (e.g.
640*
480),
0 means unspecified
</docstring>
26681 <method name=
"GetHeight" type=
"int" overloaded=
"no">
26682 <autodoc>GetHeight(self) -
> int
</autodoc>
26683 <docstring>Returns the screen width in pixels (e.g.
640*
480),
0 means
26684 unspecified
</docstring>
26686 <method name=
"GetDepth" type=
"int" overloaded=
"no">
26687 <autodoc>GetDepth(self) -
> int
</autodoc>
26688 <docstring>Returns the screen's bits per pixel (e.g.
32),
1 is monochrome and
0
26689 means unspecified/known
</docstring>
26691 <method name=
"IsOk" type=
"bool" overloaded=
"no">
26692 <autodoc>IsOk(self) -
> bool
</autodoc>
26693 <docstring>returns true if the object has been initialized
</docstring>
26695 <method name=
"__eq__" type=
"bool" overloaded=
"no">
26696 <autodoc>__eq__(self, VideoMode other) -
> bool
</autodoc>
26698 <param name=
"other" type=
"VideoMode" default=
""/>
26701 <method name=
"__ne__" type=
"bool" overloaded=
"no">
26702 <autodoc>__ne__(self, VideoMode other) -
> bool
</autodoc>
26704 <param name=
"other" type=
"VideoMode" default=
""/>
26707 <property name=
"w" type=
"int" readonly=
"no"/>
26708 <property name=
"h" type=
"int" readonly=
"no"/>
26709 <property name=
"bpp" type=
"int" readonly=
"no"/>
26710 <property name=
"refresh" type=
"int" readonly=
"no"/>
26712 <class name=
"Display" oldname=
"wxDisplay" module=
"_misc">
26713 <docstring>Represents a display/monitor attached to the system
</docstring>
26714 <constructor name=
"Display" overloaded=
"no">
26715 <autodoc>__init__(self, size_t index=
0) -
> Display
</autodoc>
26716 <docstring>Set up a Display instance with the specified display. The displays
26717 are numbered from
0 to GetCount() -
1,
0 is always the primary display
26718 and the only one which is always supported
</docstring>
26720 <param name=
"index" type=
"size_t" default=
"0"/>
26723 <destructor name=
"~wxDisplay" overloaded=
"no">
26724 <autodoc>__del__(self)
</autodoc>
26726 <staticmethod name=
"GetCount" type=
"size_t" overloaded=
"no">
26727 <autodoc>GetCount() -
> size_t
</autodoc>
26728 <docstring>Return the number of available displays.
</docstring>
26730 <staticmethod name=
"GetFromPoint" type=
"int" overloaded=
"no">
26731 <autodoc>GetFromPoint(Point pt) -
> int
</autodoc>
26732 <docstring>Find the display where the given point lies, return wx.NOT_FOUND if it
26733 doesn't belong to any display
</docstring>
26735 <param name=
"pt" type=
"Point" default=
""/>
26738 <staticmethod name=
"GetFromWindow" type=
"int" overloaded=
"no">
26739 <autodoc>GetFromWindow(Window window) -
> int
</autodoc>
26740 <docstring>Find the display where the given window lies, return wx.NOT_FOUND if
26741 it is not shown at all.
</docstring>
26743 <param name=
"window" type=
"Window" default=
""/>
26746 <method name=
"IsOk" type=
"bool" overloaded=
"no">
26747 <autodoc>IsOk(self) -
> bool
</autodoc>
26748 <docstring>Return true if the object was initialized successfully
</docstring>
26750 <method name=
"GetGeometry" type=
"Rect" overloaded=
"no">
26751 <autodoc>GetGeometry(self) -
> Rect
</autodoc>
26752 <docstring>Returns the bounding rectangle of the display whose index was passed
26753 to the constructor.
</docstring>
26755 <method name=
"GetName" type=
"String" overloaded=
"no">
26756 <autodoc>GetName(self) -
> String
</autodoc>
26757 <docstring>Returns the display's name. A name is not available on all platforms.
</docstring>
26759 <method name=
"IsPrimary" type=
"bool" overloaded=
"no">
26760 <autodoc>IsPrimary(self) -
> bool
</autodoc>
26761 <docstring>Returns true if the display is the primary display. The primary
26762 display is the one whose index is
0.
</docstring>
26764 <method name=
"GetModes" type=
"PyObject" overloaded=
"no">
26765 <autodoc>GetModes(VideoMode mode=DefaultVideoMode) -
> [videoMode...]
</autodoc>
26766 <docstring>Enumerate all video modes supported by this display matching the given
26767 one (in the sense of VideoMode.Match()).
26769 As any mode matches the default value of the argument and there is
26770 always at least one video mode supported by display, the returned
26771 array is only empty for the default value of the argument if this
26772 function is not supported at all on this platform.
</docstring>
26774 <param name=
"mode" type=
"VideoMode" default=
"wxDefaultVideoMode"/>
26777 <method name=
"GetCurrentMode" type=
"VideoMode" overloaded=
"no">
26778 <autodoc>GetCurrentMode(self) -
> VideoMode
</autodoc>
26779 <docstring>Get the current video mode.
</docstring>
26781 <method name=
"ChangeMode" type=
"bool" overloaded=
"no">
26782 <autodoc>ChangeMode(self, VideoMode mode=DefaultVideoMode) -
> bool
</autodoc>
26783 <docstring>Changes the video mode of this display to the mode specified in the
26786 If wx.DefaultVideoMode is passed in as the mode parameter, the defined
26787 behaviour is that wx.Display will reset the video mode to the default
26788 mode used by the display. On Windows, the behavior is normal.
26789 However, there are differences on other platforms. On Unix variations
26790 using X11 extensions it should behave as defined, but some
26791 irregularities may occur.
26793 On wxMac passing in wx.DefaultVideoMode as the mode parameter does
26794 nothing. This happens because Carbon no longer has access to
26795 DMUseScreenPrefs, an undocumented function that changed the video mode
26796 to the system default by using the system's 'scrn' resource.
26798 Returns True if succeeded, False otherwise
</docstring>
26800 <param name=
"mode" type=
"VideoMode" default=
"wxDefaultVideoMode"/>
26803 <method name=
"ResetMode" type=
"" overloaded=
"no">
26804 <autodoc>ResetMode(self)
</autodoc>
26805 <docstring>Restore the default video mode (just a more readable synonym)
</docstring>
26809 <module name=
"calendar">
26810 <import name=
"_misc"/>
26811 <pythoncode> wx = _core
</pythoncode>
26812 <pythoncode> __docfilter__ = wx.__DocFilter(globals())
</pythoncode>
26813 <class name=
"CalendarDateAttr" oldname=
"wxCalendarDateAttr" module=
"calendar">
26814 <docstring>A set of customization attributes for a calendar date, which can be
26815 used to control the look of the Calendar object.
</docstring>
26816 <constructor name=
"CalendarDateAttr" overloaded=
"no">
26817 <autodoc>__init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour,
26818 Colour colBorder=wxNullColour, Font font=wxNullFont,
26819 int border=CAL_BORDER_NONE) -
> CalendarDateAttr
</autodoc>
26820 <docstring>Create a CalendarDateAttr.
</docstring>
26822 <param name=
"colText" type=
"Colour" default=
"wxNullColour"/>
26823 <param name=
"colBack" type=
"Colour" default=
"wxNullColour"/>
26824 <param name=
"colBorder" type=
"Colour" default=
"wxNullColour"/>
26825 <param name=
"font" type=
"Font" default=
"wxNullFont"/>
26826 <param name=
"border" type=
"wxCalendarDateBorder" default=
"wxCAL_BORDER_NONE"/>
26829 <method name=
"SetTextColour" type=
"" overloaded=
"no">
26830 <autodoc>SetTextColour(self, Colour colText)
</autodoc>
26832 <param name=
"colText" type=
"Colour" default=
""/>
26835 <method name=
"SetBackgroundColour" type=
"" overloaded=
"no">
26836 <autodoc>SetBackgroundColour(self, Colour colBack)
</autodoc>
26838 <param name=
"colBack" type=
"Colour" default=
""/>
26841 <method name=
"SetBorderColour" type=
"" overloaded=
"no">
26842 <autodoc>SetBorderColour(self, Colour col)
</autodoc>
26844 <param name=
"col" type=
"Colour" default=
""/>
26847 <method name=
"SetFont" type=
"" overloaded=
"no">
26848 <autodoc>SetFont(self, Font font)
</autodoc>
26850 <param name=
"font" type=
"Font" default=
""/>
26853 <method name=
"SetBorder" type=
"" overloaded=
"no">
26854 <autodoc>SetBorder(self, int border)
</autodoc>
26856 <param name=
"border" type=
"wxCalendarDateBorder" default=
""/>
26859 <method name=
"SetHoliday" type=
"" overloaded=
"no">
26860 <autodoc>SetHoliday(self, bool holiday)
</autodoc>
26862 <param name=
"holiday" type=
"bool" default=
""/>
26865 <method name=
"HasTextColour" type=
"bool" overloaded=
"no">
26866 <autodoc>HasTextColour(self) -
> bool
</autodoc>
26868 <method name=
"HasBackgroundColour" type=
"bool" overloaded=
"no">
26869 <autodoc>HasBackgroundColour(self) -
> bool
</autodoc>
26871 <method name=
"HasBorderColour" type=
"bool" overloaded=
"no">
26872 <autodoc>HasBorderColour(self) -
> bool
</autodoc>
26874 <method name=
"HasFont" type=
"bool" overloaded=
"no">
26875 <autodoc>HasFont(self) -
> bool
</autodoc>
26877 <method name=
"HasBorder" type=
"bool" overloaded=
"no">
26878 <autodoc>HasBorder(self) -
> bool
</autodoc>
26880 <method name=
"IsHoliday" type=
"bool" overloaded=
"no">
26881 <autodoc>IsHoliday(self) -
> bool
</autodoc>
26883 <method name=
"GetTextColour" type=
"Colour" overloaded=
"no">
26884 <autodoc>GetTextColour(self) -
> Colour
</autodoc>
26886 <method name=
"GetBackgroundColour" type=
"Colour" overloaded=
"no">
26887 <autodoc>GetBackgroundColour(self) -
> Colour
</autodoc>
26889 <method name=
"GetBorderColour" type=
"Colour" overloaded=
"no">
26890 <autodoc>GetBorderColour(self) -
> Colour
</autodoc>
26892 <method name=
"GetFont" type=
"Font" overloaded=
"no">
26893 <autodoc>GetFont(self) -
> Font
</autodoc>
26895 <method name=
"GetBorder" type=
"wxCalendarDateBorder" overloaded=
"no">
26896 <autodoc>GetBorder(self) -
> int
</autodoc>
26899 <class name=
"CalendarEvent" oldname=
"wxCalendarEvent" module=
"calendar">
26900 <baseclass name=
"CommandEvent"/>
26901 <constructor name=
"CalendarEvent" overloaded=
"no">
26902 <autodoc>__init__(self, CalendarCtrl cal, wxEventType type) -
> CalendarEvent
</autodoc>
26904 <param name=
"cal" type=
"wxCalendarCtrl" default=
""/>
26905 <param name=
"type" type=
"wxEventType" default=
""/>
26908 <method name=
"GetDate" type=
"DateTime" overloaded=
"no">
26909 <autodoc>GetDate(self) -
> DateTime
</autodoc>
26911 <method name=
"SetDate" type=
"" overloaded=
"no">
26912 <autodoc>SetDate(self, DateTime date)
</autodoc>
26914 <param name=
"date" type=
"DateTime" default=
""/>
26917 <method name=
"SetWeekDay" type=
"" overloaded=
"no">
26918 <autodoc>SetWeekDay(self, int wd)
</autodoc>
26920 <param name=
"wd" type=
"wxDateTime::WeekDay" default=
""/>
26923 <method name=
"GetWeekDay" type=
"wxDateTime::WeekDay" overloaded=
"no">
26924 <autodoc>GetWeekDay(self) -
> int
</autodoc>
26928 EVT_CALENDAR = wx.PyEventBinder( wxEVT_CALENDAR_DOUBLECLICKED,
1)
26929 EVT_CALENDAR_SEL_CHANGED = wx.PyEventBinder( wxEVT_CALENDAR_SEL_CHANGED,
1)
26930 EVT_CALENDAR_DAY = wx.PyEventBinder( wxEVT_CALENDAR_DAY_CHANGED,
1)
26931 EVT_CALENDAR_MONTH = wx.PyEventBinder( wxEVT_CALENDAR_MONTH_CHANGED,
1)
26932 EVT_CALENDAR_YEAR = wx.PyEventBinder( wxEVT_CALENDAR_YEAR_CHANGED,
1)
26933 EVT_CALENDAR_WEEKDAY_CLICKED = wx.PyEventBinder( wxEVT_CALENDAR_WEEKDAY_CLICKED,
1)
26935 <class name=
"CalendarCtrl" oldname=
"wxCalendarCtrl" module=
"calendar">
26936 <docstring>The calendar control allows the user to pick a date interactively.
26938 The CalendarCtrl displays a window containing several parts: the
26939 control to pick the month and the year at the top (either or both of
26940 them may be disabled) and a month area below them which shows all the
26941 days in the month. The user can move the current selection using the
26942 keyboard and select the date (generating EVT_CALENDAR event) by
26943 pressing
<Return
> or double clicking it.
26945 It has advanced possibilities for the customization of its
26946 display. All global settings (such as colours and fonts used) can, of
26947 course, be changed. But also, the display style for each day in the
26948 month can be set independently using CalendarDateAttr class.
26950 An item without custom attributes is drawn with the default colours
26951 and font and without border, but setting custom attributes with
26952 SetAttr allows to modify its appearance. Just create a custom
26953 attribute object and set it for the day you want to be displayed
26954 specially A day may be marked as being a holiday, (even if it is not
26955 recognized as one by wx.DateTime) by using the SetHoliday method.
26957 As the attributes are specified for each day, they may change when the
26958 month is changed, so you will often want to update them in an
26959 EVT_CALENDAR_MONTH event handler.
26963 ============================== ============================
26964 CAL_SUNDAY_FIRST Show Sunday as the first day
26966 CAL_MONDAY_FIRST Show Monday as the first day
26968 CAL_SHOW_HOLIDAYS Highlight holidays in the
26970 CAL_NO_YEAR_CHANGE Disable the year changing
26971 CAL_NO_MONTH_CHANGE Disable the month (and,
26972 implicitly, the year) changing
26973 CAL_SHOW_SURROUNDING_WEEKS Show the neighbouring weeks in
26974 the previous and next months
26975 CAL_SEQUENTIAL_MONTH_SELECTION Use alternative, more compact,
26976 style for the month and year
26977 selection controls.
26978 ============================== ============================
26980 The default calendar style is CAL_SHOW_HOLIDAYS.
26984 ============================= ==============================
26985 EVT_CALENDAR A day was double clicked in the
26987 EVT_CALENDAR_SEL_CHANGED The selected date changed.
26988 EVT_CALENDAR_DAY The selected day changed.
26989 EVT_CALENDAR_MONTH The selected month changed.
26990 EVT_CALENDAR_YEAR The selected year changed.
26991 EVT_CALENDAR_WEEKDAY_CLICKED User clicked on the week day
26993 ============================= ==============================
26995 Note that changing the selected date will result in one of
26996 EVT_CALENDAR_DAY, MONTH or YEAR events and an EVT_CALENDAR_SEL_CHANGED
27000 <baseclass name=
"Control"/>
27001 <constructor name=
"CalendarCtrl" overloaded=
"no">
27002 <autodoc>__init__(self, Window parent, int id=-
1, DateTime date=DefaultDateTime,
27003 Point pos=DefaultPosition, Size size=DefaultSize,
27004 long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS,
27005 String name=CalendarNameStr) -
> CalendarCtrl
</autodoc>
27006 <docstring>Create and show a calendar control.
</docstring>
27008 <param name=
"parent" type=
"Window" default=
""/>
27009 <param name=
"id" type=
"int" default=
"-1"/>
27010 <param name=
"date" type=
"DateTime" default=
"wxDefaultDateTime"/>
27011 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
27012 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
27013 <param name=
"style" type=
"long" default=
"wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS"/>
27014 <param name=
"name" type=
"String" default=
"wxPyCalendarNameStr"/>
27017 <constructor name=
"PreCalendarCtrl" overloaded=
"no">
27018 <autodoc>PreCalendarCtrl() -
> CalendarCtrl
</autodoc>
27019 <docstring>Precreate a CalendarCtrl for
2-phase creation.
</docstring>
27021 <method name=
"Create" type=
"bool" overloaded=
"no">
27022 <autodoc>Create(self, Window parent, int id, DateTime date=DefaultDateTime,
27023 Point pos=DefaultPosition, Size size=DefaultSize,
27024 long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS,
27025 String name=CalendarNameStr) -
> bool
</autodoc>
27026 <docstring>Acutally create the GUI portion of the CalendarCtrl for
2-phase
27027 creation.
</docstring>
27029 <param name=
"parent" type=
"Window" default=
""/>
27030 <param name=
"id" type=
"int" default=
""/>
27031 <param name=
"date" type=
"DateTime" default=
"wxDefaultDateTime"/>
27032 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
27033 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
27034 <param name=
"style" type=
"long" default=
"wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS"/>
27035 <param name=
"name" type=
"String" default=
"wxPyCalendarNameStr"/>
27038 <method name=
"SetDate" type=
"" overloaded=
"no">
27039 <autodoc>SetDate(self, DateTime date)
</autodoc>
27040 <docstring>Sets the current date.
</docstring>
27042 <param name=
"date" type=
"DateTime" default=
""/>
27045 <method name=
"GetDate" type=
"DateTime" overloaded=
"no">
27046 <autodoc>GetDate(self) -
> DateTime
</autodoc>
27047 <docstring>Gets the currently selected date.
</docstring>
27049 <method name=
"SetLowerDateLimit" type=
"bool" overloaded=
"no">
27050 <autodoc>SetLowerDateLimit(self, DateTime date=DefaultDateTime) -
> bool
</autodoc>
27051 <docstring>set the range in which selection can occur
</docstring>
27053 <param name=
"date" type=
"DateTime" default=
"wxDefaultDateTime"/>
27056 <method name=
"SetUpperDateLimit" type=
"bool" overloaded=
"no">
27057 <autodoc>SetUpperDateLimit(self, DateTime date=DefaultDateTime) -
> bool
</autodoc>
27058 <docstring>set the range in which selection can occur
</docstring>
27060 <param name=
"date" type=
"DateTime" default=
"wxDefaultDateTime"/>
27063 <method name=
"GetLowerDateLimit" type=
"DateTime" overloaded=
"no">
27064 <autodoc>GetLowerDateLimit(self) -
> DateTime
</autodoc>
27065 <docstring>get the range in which selection can occur
</docstring>
27067 <method name=
"GetUpperDateLimit" type=
"DateTime" overloaded=
"no">
27068 <autodoc>GetUpperDateLimit(self) -
> DateTime
</autodoc>
27069 <docstring>get the range in which selection can occur
</docstring>
27071 <method name=
"SetDateRange" type=
"bool" overloaded=
"no">
27072 <autodoc>SetDateRange(self, DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -
> bool
</autodoc>
27073 <docstring>set the range in which selection can occur
</docstring>
27075 <param name=
"lowerdate" type=
"DateTime" default=
"wxDefaultDateTime"/>
27076 <param name=
"upperdate" type=
"DateTime" default=
"wxDefaultDateTime"/>
27079 <method name=
"EnableYearChange" type=
"" overloaded=
"no">
27080 <autodoc>EnableYearChange(self, bool enable=True)
</autodoc>
27081 <docstring>This function should be used instead of changing CAL_NO_YEAR_CHANGE
27082 style bit directly. It allows or disallows the user to change the year
27083 interactively.
</docstring>
27085 <param name=
"enable" type=
"bool" default=
"True"/>
27088 <method name=
"EnableMonthChange" type=
"" overloaded=
"no">
27089 <autodoc>EnableMonthChange(self, bool enable=True)
</autodoc>
27090 <docstring>This function should be used instead of changing CAL_NO_MONTH_CHANGE
27091 style bit. It allows or disallows the user to change the month
27092 interactively. Note that if the month can not be changed, the year can
27093 not be changed either.
</docstring>
27095 <param name=
"enable" type=
"bool" default=
"True"/>
27098 <method name=
"EnableHolidayDisplay" type=
"" overloaded=
"no">
27099 <autodoc>EnableHolidayDisplay(self, bool display=True)
</autodoc>
27100 <docstring>This function should be used instead of changing CAL_SHOW_HOLIDAYS
27101 style bit directly. It enables or disables the special highlighting of
27102 the holidays.
</docstring>
27104 <param name=
"display" type=
"bool" default=
"True"/>
27107 <method name=
"SetHeaderColours" type=
"" overloaded=
"no">
27108 <autodoc>SetHeaderColours(self, Colour colFg, Colour colBg)
</autodoc>
27109 <docstring>Header colours are used for painting the weekdays at the top.
</docstring>
27111 <param name=
"colFg" type=
"Colour" default=
""/>
27112 <param name=
"colBg" type=
"Colour" default=
""/>
27115 <method name=
"GetHeaderColourFg" type=
"Colour" overloaded=
"no">
27116 <autodoc>GetHeaderColourFg(self) -
> Colour
</autodoc>
27117 <docstring>Header colours are used for painting the weekdays at the top.
</docstring>
27119 <method name=
"GetHeaderColourBg" type=
"Colour" overloaded=
"no">
27120 <autodoc>GetHeaderColourBg(self) -
> Colour
</autodoc>
27121 <docstring>Header colours are used for painting the weekdays at the top.
</docstring>
27123 <method name=
"SetHighlightColours" type=
"" overloaded=
"no">
27124 <autodoc>SetHighlightColours(self, Colour colFg, Colour colBg)
</autodoc>
27125 <docstring>Highlight colour is used for the currently selected date.
</docstring>
27127 <param name=
"colFg" type=
"Colour" default=
""/>
27128 <param name=
"colBg" type=
"Colour" default=
""/>
27131 <method name=
"GetHighlightColourFg" type=
"Colour" overloaded=
"no">
27132 <autodoc>GetHighlightColourFg(self) -
> Colour
</autodoc>
27133 <docstring>Highlight colour is used for the currently selected date.
</docstring>
27135 <method name=
"GetHighlightColourBg" type=
"Colour" overloaded=
"no">
27136 <autodoc>GetHighlightColourBg(self) -
> Colour
</autodoc>
27137 <docstring>Highlight colour is used for the currently selected date.
</docstring>
27139 <method name=
"SetHolidayColours" type=
"" overloaded=
"no">
27140 <autodoc>SetHolidayColours(self, Colour colFg, Colour colBg)
</autodoc>
27141 <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
27144 <param name=
"colFg" type=
"Colour" default=
""/>
27145 <param name=
"colBg" type=
"Colour" default=
""/>
27148 <method name=
"GetHolidayColourFg" type=
"Colour" overloaded=
"no">
27149 <autodoc>GetHolidayColourFg(self) -
> Colour
</autodoc>
27150 <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
27153 <method name=
"GetHolidayColourBg" type=
"Colour" overloaded=
"no">
27154 <autodoc>GetHolidayColourBg(self) -
> Colour
</autodoc>
27155 <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is
27158 <method name=
"GetAttr" type=
"CalendarDateAttr" overloaded=
"no">
27159 <autodoc>GetAttr(self, size_t day) -
> CalendarDateAttr
</autodoc>
27160 <docstring>Returns the attribute for the given date (should be in the range
27161 1..
.31). The returned value may be None
</docstring>
27163 <param name=
"day" type=
"size_t" default=
""/>
27166 <method name=
"SetAttr" type=
"" overloaded=
"no">
27167 <autodoc>SetAttr(self, size_t day, CalendarDateAttr attr)
</autodoc>
27168 <docstring>Associates the attribute with the specified date (in the range
27169 1..
.31). If the attribute passed is None, the items attribute is
27170 cleared.
</docstring>
27172 <param name=
"day" type=
"size_t" default=
""/>
27173 <param name=
"attr" type=
"CalendarDateAttr" default=
""/>
27176 <method name=
"SetHoliday" type=
"" overloaded=
"no">
27177 <autodoc>SetHoliday(self, size_t day)
</autodoc>
27178 <docstring>Marks the specified day as being a holiday in the current month.
</docstring>
27180 <param name=
"day" type=
"size_t" default=
""/>
27183 <method name=
"ResetAttr" type=
"" overloaded=
"no">
27184 <autodoc>ResetAttr(self, size_t day)
</autodoc>
27185 <docstring>Clears any attributes associated with the given day (in the range
27186 1..
.31).
</docstring>
27188 <param name=
"day" type=
"size_t" default=
""/>
27191 <method name=
"HitTest" type=
"PyObject" overloaded=
"no">
27192 <autodoc>HitTest(Point pos) -
> (result, date, weekday)
</autodoc>
27193 <docstring>Returns
3-tuple with information about the given position on the
27194 calendar control. The first value of the tuple is a result code and
27195 determines the validity of the remaining two values.
27196 The result codes are:
27198 =================== ============================================
27199 CAL_HITTEST_NOWHERE hit outside of anything
27200 CAL_HITTEST_HEADER hit on the header, weekday is valid
27201 CAL_HITTEST_DAY hit on a day in the calendar, date is set.
27202 =================== ============================================
27205 <param name=
"pos" type=
"Point" default=
""/>
27208 <method name=
"GetMonthControl" type=
"Control" overloaded=
"no">
27209 <autodoc>GetMonthControl(self) -
> Control
</autodoc>
27210 <docstring>Get the currently shown control for month.
</docstring>
27212 <method name=
"GetYearControl" type=
"Control" overloaded=
"no">
27213 <autodoc>GetYearControl(self) -
> Control
</autodoc>
27214 <docstring>Get the currently shown control for year.
</docstring>
27216 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
27217 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
27218 <docstring>Get the default attributes for this class. This is useful if you want
27219 to use the same font or colour in your own control as in a standard
27220 control -- which is a much better idea than hard coding specific
27221 colours or fonts which might look completely out of place on the
27222 user's system, especially if it uses themes.
27224 The variant parameter is only relevant under Mac currently and is
27225 ignore under other platforms. Under Mac, it will change the size of
27226 the returned font. See `wx.Window.SetWindowVariant` for more about
27229 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
27234 <module name=
"grid">
27235 <import name=
"_windows"/>
27236 <pythoncode> wx = _core
</pythoncode>
27237 <pythoncode> __docfilter__ = wx.__DocFilter(globals())
</pythoncode>
27238 <class name=
"GridCellRenderer" oldname=
"wxGridCellRenderer" module=
"grid">
27239 <method name=
"_setOORInfo" type=
"" overloaded=
"no">
27240 <autodoc>_setOORInfo(self, PyObject _self)
</autodoc>
27242 <param name=
"_self" type=
"PyObject" default=
""/>
27245 <method name=
"SetParameters" type=
"" overloaded=
"no">
27246 <autodoc>SetParameters(self, String params)
</autodoc>
27248 <param name=
"params" type=
"String" default=
""/>
27251 <method name=
"IncRef" type=
"" overloaded=
"no">
27252 <autodoc>IncRef(self)
</autodoc>
27254 <method name=
"DecRef" type=
"" overloaded=
"no">
27255 <autodoc>DecRef(self)
</autodoc>
27257 <method name=
"Draw" type=
"" overloaded=
"no">
27258 <autodoc>Draw(self, Grid grid, GridCellAttr attr, DC dc, Rect rect, int row,
27259 int col, bool isSelected)
</autodoc>
27261 <param name=
"grid" type=
"wxGrid" default=
""/>
27262 <param name=
"attr" type=
"wxGridCellAttr" default=
""/>
27263 <param name=
"dc" type=
"DC" default=
""/>
27264 <param name=
"rect" type=
"Rect" default=
""/>
27265 <param name=
"row" type=
"int" default=
""/>
27266 <param name=
"col" type=
"int" default=
""/>
27267 <param name=
"isSelected" type=
"bool" default=
""/>
27270 <method name=
"GetBestSize" type=
"Size" overloaded=
"no">
27271 <autodoc>GetBestSize(self, Grid grid, GridCellAttr attr, DC dc, int row, int col) -
> Size
</autodoc>
27273 <param name=
"grid" type=
"wxGrid" default=
""/>
27274 <param name=
"attr" type=
"wxGridCellAttr" default=
""/>
27275 <param name=
"dc" type=
"DC" default=
""/>
27276 <param name=
"row" type=
"int" default=
""/>
27277 <param name=
"col" type=
"int" default=
""/>
27280 <method name=
"Clone" type=
"GridCellRenderer" overloaded=
"no">
27281 <autodoc>Clone(self) -
> GridCellRenderer
</autodoc>
27284 <class name=
"PyGridCellRenderer" oldname=
"wxPyGridCellRenderer" module=
"grid">
27285 <baseclass name=
"GridCellRenderer"/>
27286 <constructor name=
"PyGridCellRenderer" overloaded=
"no">
27287 <autodoc>__init__(self) -
> PyGridCellRenderer
</autodoc>
27289 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
27290 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
27292 <param name=
"self" type=
"PyObject" default=
""/>
27293 <param name=
"_class" type=
"PyObject" default=
""/>
27296 <method name=
"base_SetParameters" type=
"" overloaded=
"no">
27297 <autodoc>base_SetParameters(self, String params)
</autodoc>
27299 <param name=
"params" type=
"String" default=
""/>
27303 <class name=
"GridCellStringRenderer" oldname=
"wxGridCellStringRenderer" module=
"grid">
27304 <baseclass name=
"GridCellRenderer"/>
27305 <constructor name=
"GridCellStringRenderer" overloaded=
"no">
27306 <autodoc>__init__(self) -
> GridCellStringRenderer
</autodoc>
27309 <class name=
"GridCellNumberRenderer" oldname=
"wxGridCellNumberRenderer" module=
"grid">
27310 <baseclass name=
"GridCellStringRenderer"/>
27311 <constructor name=
"GridCellNumberRenderer" overloaded=
"no">
27312 <autodoc>__init__(self) -
> GridCellNumberRenderer
</autodoc>
27315 <class name=
"GridCellFloatRenderer" oldname=
"wxGridCellFloatRenderer" module=
"grid">
27316 <baseclass name=
"GridCellStringRenderer"/>
27317 <constructor name=
"GridCellFloatRenderer" overloaded=
"no">
27318 <autodoc>__init__(self, int width=-
1, int precision=-
1) -
> GridCellFloatRenderer
</autodoc>
27320 <param name=
"width" type=
"int" default=
"-1"/>
27321 <param name=
"precision" type=
"int" default=
"-1"/>
27324 <method name=
"GetWidth" type=
"int" overloaded=
"no">
27325 <autodoc>GetWidth(self) -
> int
</autodoc>
27327 <method name=
"SetWidth" type=
"" overloaded=
"no">
27328 <autodoc>SetWidth(self, int width)
</autodoc>
27330 <param name=
"width" type=
"int" default=
""/>
27333 <method name=
"GetPrecision" type=
"int" overloaded=
"no">
27334 <autodoc>GetPrecision(self) -
> int
</autodoc>
27336 <method name=
"SetPrecision" type=
"" overloaded=
"no">
27337 <autodoc>SetPrecision(self, int precision)
</autodoc>
27339 <param name=
"precision" type=
"int" default=
""/>
27343 <class name=
"GridCellBoolRenderer" oldname=
"wxGridCellBoolRenderer" module=
"grid">
27344 <baseclass name=
"GridCellRenderer"/>
27345 <constructor name=
"GridCellBoolRenderer" overloaded=
"no">
27346 <autodoc>__init__(self) -
> GridCellBoolRenderer
</autodoc>
27349 <class name=
"GridCellDateTimeRenderer" oldname=
"wxGridCellDateTimeRenderer" module=
"grid">
27350 <baseclass name=
"GridCellStringRenderer"/>
27351 <constructor name=
"GridCellDateTimeRenderer" overloaded=
"no">
27352 <autodoc>__init__(self, String outformat=DateTimeFormatStr, String informat=DateTimeFormatStr) -
> GridCellDateTimeRenderer
</autodoc>
27354 <param name=
"outformat" type=
"String" default=
"wxPyDateTimeFormatStr"/>
27355 <param name=
"informat" type=
"String" default=
"wxPyDateTimeFormatStr"/>
27359 <class name=
"GridCellEnumRenderer" oldname=
"wxGridCellEnumRenderer" module=
"grid">
27360 <baseclass name=
"GridCellStringRenderer"/>
27361 <constructor name=
"GridCellEnumRenderer" overloaded=
"no">
27362 <autodoc>__init__(self, String choices=EmptyString) -
> GridCellEnumRenderer
</autodoc>
27364 <param name=
"choices" type=
"String" default=
"wxPyEmptyString"/>
27368 <class name=
"GridCellAutoWrapStringRenderer" oldname=
"wxGridCellAutoWrapStringRenderer" module=
"grid">
27369 <baseclass name=
"GridCellStringRenderer"/>
27370 <constructor name=
"GridCellAutoWrapStringRenderer" overloaded=
"no">
27371 <autodoc>__init__(self) -
> GridCellAutoWrapStringRenderer
</autodoc>
27374 <class name=
"GridCellEditor" oldname=
"wxGridCellEditor" module=
"grid">
27375 <method name=
"_setOORInfo" type=
"" overloaded=
"no">
27376 <autodoc>_setOORInfo(self, PyObject _self)
</autodoc>
27378 <param name=
"_self" type=
"PyObject" default=
""/>
27381 <method name=
"IsCreated" type=
"bool" overloaded=
"no">
27382 <autodoc>IsCreated(self) -
> bool
</autodoc>
27384 <method name=
"GetControl" type=
"Control" overloaded=
"no">
27385 <autodoc>GetControl(self) -
> Control
</autodoc>
27387 <method name=
"SetControl" type=
"" overloaded=
"no">
27388 <autodoc>SetControl(self, Control control)
</autodoc>
27390 <param name=
"control" type=
"Control" default=
""/>
27393 <method name=
"GetCellAttr" type=
"wxGridCellAttr" overloaded=
"no">
27394 <autodoc>GetCellAttr(self) -
> GridCellAttr
</autodoc>
27396 <method name=
"SetCellAttr" type=
"" overloaded=
"no">
27397 <autodoc>SetCellAttr(self, GridCellAttr attr)
</autodoc>
27399 <param name=
"attr" type=
"wxGridCellAttr" default=
""/>
27402 <method name=
"SetParameters" type=
"" overloaded=
"no">
27403 <autodoc>SetParameters(self, String params)
</autodoc>
27405 <param name=
"params" type=
"String" default=
""/>
27408 <method name=
"IncRef" type=
"" overloaded=
"no">
27409 <autodoc>IncRef(self)
</autodoc>
27411 <method name=
"DecRef" type=
"" overloaded=
"no">
27412 <autodoc>DecRef(self)
</autodoc>
27414 <method name=
"Create" type=
"" overloaded=
"no">
27415 <autodoc>Create(self, Window parent, int id, EvtHandler evtHandler)
</autodoc>
27417 <param name=
"parent" type=
"Window" default=
""/>
27418 <param name=
"id" type=
"int" default=
""/>
27419 <param name=
"evtHandler" type=
"EvtHandler" default=
""/>
27422 <method name=
"BeginEdit" type=
"" overloaded=
"no">
27423 <autodoc>BeginEdit(self, int row, int col, Grid grid)
</autodoc>
27425 <param name=
"row" type=
"int" default=
""/>
27426 <param name=
"col" type=
"int" default=
""/>
27427 <param name=
"grid" type=
"wxGrid" default=
""/>
27430 <method name=
"EndEdit" type=
"bool" overloaded=
"no">
27431 <autodoc>EndEdit(self, int row, int col, Grid grid) -
> bool
</autodoc>
27433 <param name=
"row" type=
"int" default=
""/>
27434 <param name=
"col" type=
"int" default=
""/>
27435 <param name=
"grid" type=
"wxGrid" default=
""/>
27438 <method name=
"Reset" type=
"" overloaded=
"no">
27439 <autodoc>Reset(self)
</autodoc>
27441 <method name=
"Clone" type=
"GridCellEditor" overloaded=
"no">
27442 <autodoc>Clone(self) -
> GridCellEditor
</autodoc>
27444 <method name=
"SetSize" type=
"" overloaded=
"no">
27445 <autodoc>SetSize(self, Rect rect)
</autodoc>
27447 <param name=
"rect" type=
"Rect" default=
""/>
27450 <method name=
"Show" type=
"" overloaded=
"no">
27451 <autodoc>Show(self, bool show, GridCellAttr attr=None)
</autodoc>
27453 <param name=
"show" type=
"bool" default=
""/>
27454 <param name=
"attr" type=
"wxGridCellAttr" default=
"NULL"/>
27457 <method name=
"PaintBackground" type=
"" overloaded=
"no">
27458 <autodoc>PaintBackground(self, Rect rectCell, GridCellAttr attr)
</autodoc>
27460 <param name=
"rectCell" type=
"Rect" default=
""/>
27461 <param name=
"attr" type=
"wxGridCellAttr" default=
""/>
27464 <method name=
"IsAcceptedKey" type=
"bool" overloaded=
"no">
27465 <autodoc>IsAcceptedKey(self, KeyEvent event) -
> bool
</autodoc>
27467 <param name=
"event" type=
"KeyEvent" default=
""/>
27470 <method name=
"StartingKey" type=
"" overloaded=
"no">
27471 <autodoc>StartingKey(self, KeyEvent event)
</autodoc>
27473 <param name=
"event" type=
"KeyEvent" default=
""/>
27476 <method name=
"StartingClick" type=
"" overloaded=
"no">
27477 <autodoc>StartingClick(self)
</autodoc>
27479 <method name=
"HandleReturn" type=
"" overloaded=
"no">
27480 <autodoc>HandleReturn(self, KeyEvent event)
</autodoc>
27482 <param name=
"event" type=
"KeyEvent" default=
""/>
27485 <method name=
"Destroy" type=
"" overloaded=
"no">
27486 <autodoc>Destroy(self)
</autodoc>
27489 <class name=
"PyGridCellEditor" oldname=
"wxPyGridCellEditor" module=
"grid">
27490 <baseclass name=
"GridCellEditor"/>
27491 <constructor name=
"PyGridCellEditor" overloaded=
"no">
27492 <autodoc>__init__(self) -
> PyGridCellEditor
</autodoc>
27494 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
27495 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
27497 <param name=
"self" type=
"PyObject" default=
""/>
27498 <param name=
"_class" type=
"PyObject" default=
""/>
27501 <method name=
"base_SetSize" type=
"" overloaded=
"no">
27502 <autodoc>base_SetSize(self, Rect rect)
</autodoc>
27504 <param name=
"rect" type=
"Rect" default=
""/>
27507 <method name=
"base_Show" type=
"" overloaded=
"no">
27508 <autodoc>base_Show(self, bool show, GridCellAttr attr=None)
</autodoc>
27510 <param name=
"show" type=
"bool" default=
""/>
27511 <param name=
"attr" type=
"wxGridCellAttr" default=
"NULL"/>
27514 <method name=
"base_PaintBackground" type=
"" overloaded=
"no">
27515 <autodoc>base_PaintBackground(self, Rect rectCell, GridCellAttr attr)
</autodoc>
27517 <param name=
"rectCell" type=
"Rect" default=
""/>
27518 <param name=
"attr" type=
"wxGridCellAttr" default=
""/>
27521 <method name=
"base_IsAcceptedKey" type=
"bool" overloaded=
"no">
27522 <autodoc>base_IsAcceptedKey(self, KeyEvent event) -
> bool
</autodoc>
27524 <param name=
"event" type=
"KeyEvent" default=
""/>
27527 <method name=
"base_StartingKey" type=
"" overloaded=
"no">
27528 <autodoc>base_StartingKey(self, KeyEvent event)
</autodoc>
27530 <param name=
"event" type=
"KeyEvent" default=
""/>
27533 <method name=
"base_StartingClick" type=
"" overloaded=
"no">
27534 <autodoc>base_StartingClick(self)
</autodoc>
27536 <method name=
"base_HandleReturn" type=
"" overloaded=
"no">
27537 <autodoc>base_HandleReturn(self, KeyEvent event)
</autodoc>
27539 <param name=
"event" type=
"KeyEvent" default=
""/>
27542 <method name=
"base_Destroy" type=
"" overloaded=
"no">
27543 <autodoc>base_Destroy(self)
</autodoc>
27545 <method name=
"base_SetParameters" type=
"" overloaded=
"no">
27546 <autodoc>base_SetParameters(self, String params)
</autodoc>
27548 <param name=
"params" type=
"String" default=
""/>
27552 <class name=
"GridCellTextEditor" oldname=
"wxGridCellTextEditor" module=
"grid">
27553 <baseclass name=
"GridCellEditor"/>
27554 <constructor name=
"GridCellTextEditor" overloaded=
"no">
27555 <autodoc>__init__(self) -
> GridCellTextEditor
</autodoc>
27557 <method name=
"GetValue" type=
"String" overloaded=
"no">
27558 <autodoc>GetValue(self) -
> String
</autodoc>
27561 <class name=
"GridCellNumberEditor" oldname=
"wxGridCellNumberEditor" module=
"grid">
27562 <baseclass name=
"GridCellTextEditor"/>
27563 <constructor name=
"GridCellNumberEditor" overloaded=
"no">
27564 <autodoc>__init__(self, int min=-
1, int max=-
1) -
> GridCellNumberEditor
</autodoc>
27566 <param name=
"min" type=
"int" default=
"-1"/>
27567 <param name=
"max" type=
"int" default=
"-1"/>
27570 <method name=
"GetValue" type=
"String" overloaded=
"no">
27571 <autodoc>GetValue(self) -
> String
</autodoc>
27574 <class name=
"GridCellFloatEditor" oldname=
"wxGridCellFloatEditor" module=
"grid">
27575 <baseclass name=
"GridCellTextEditor"/>
27576 <constructor name=
"GridCellFloatEditor" overloaded=
"no">
27577 <autodoc>__init__(self, int width=-
1, int precision=-
1) -
> GridCellFloatEditor
</autodoc>
27579 <param name=
"width" type=
"int" default=
"-1"/>
27580 <param name=
"precision" type=
"int" default=
"-1"/>
27583 <method name=
"GetValue" type=
"String" overloaded=
"no">
27584 <autodoc>GetValue(self) -
> String
</autodoc>
27587 <class name=
"GridCellBoolEditor" oldname=
"wxGridCellBoolEditor" module=
"grid">
27588 <baseclass name=
"GridCellEditor"/>
27589 <constructor name=
"GridCellBoolEditor" overloaded=
"no">
27590 <autodoc>__init__(self) -
> GridCellBoolEditor
</autodoc>
27592 <method name=
"GetValue" type=
"String" overloaded=
"no">
27593 <autodoc>GetValue(self) -
> String
</autodoc>
27596 <class name=
"GridCellChoiceEditor" oldname=
"wxGridCellChoiceEditor" module=
"grid">
27597 <baseclass name=
"GridCellEditor"/>
27598 <constructor name=
"GridCellChoiceEditor" overloaded=
"no">
27599 <autodoc>__init__(self, int choices=
0, String choices_array=None, bool allowOthers=False) -
> GridCellChoiceEditor
</autodoc>
27601 <param name=
"choices" type=
"int" default=
"0"/>
27602 <param name=
"choices_array" type=
"String" default=
"NULL"/>
27603 <param name=
"allowOthers" type=
"bool" default=
"False"/>
27606 <method name=
"GetValue" type=
"String" overloaded=
"no">
27607 <autodoc>GetValue(self) -
> String
</autodoc>
27610 <class name=
"GridCellEnumEditor" oldname=
"wxGridCellEnumEditor" module=
"grid">
27611 <baseclass name=
"GridCellChoiceEditor"/>
27612 <constructor name=
"GridCellEnumEditor" overloaded=
"no">
27613 <autodoc>__init__(self, String choices=EmptyString) -
> GridCellEnumEditor
</autodoc>
27615 <param name=
"choices" type=
"String" default=
"wxPyEmptyString"/>
27618 <method name=
"GetValue" type=
"String" overloaded=
"no">
27619 <autodoc>GetValue(self) -
> String
</autodoc>
27622 <class name=
"GridCellAutoWrapStringEditor" oldname=
"wxGridCellAutoWrapStringEditor" module=
"grid">
27623 <baseclass name=
"GridCellTextEditor"/>
27624 <constructor name=
"GridCellAutoWrapStringEditor" overloaded=
"no">
27625 <autodoc>__init__(self) -
> GridCellAutoWrapStringEditor
</autodoc>
27627 <method name=
"GetValue" type=
"String" overloaded=
"no">
27628 <autodoc>GetValue(self) -
> String
</autodoc>
27631 <class name=
"GridCellAttr" oldname=
"wxGridCellAttr" module=
"grid">
27632 <constructor name=
"GridCellAttr" overloaded=
"no">
27633 <autodoc>__init__(self, GridCellAttr attrDefault=None) -
> GridCellAttr
</autodoc>
27635 <param name=
"attrDefault" type=
"GridCellAttr" default=
"NULL"/>
27638 <method name=
"_setOORInfo" type=
"" overloaded=
"no">
27639 <autodoc>_setOORInfo(self, PyObject _self)
</autodoc>
27641 <param name=
"_self" type=
"PyObject" default=
""/>
27644 <method name=
"Clone" type=
"GridCellAttr" overloaded=
"no">
27645 <autodoc>Clone(self) -
> GridCellAttr
</autodoc>
27647 <method name=
"MergeWith" type=
"" overloaded=
"no">
27648 <autodoc>MergeWith(self, GridCellAttr mergefrom)
</autodoc>
27650 <param name=
"mergefrom" type=
"GridCellAttr" default=
""/>
27653 <method name=
"IncRef" type=
"" overloaded=
"no">
27654 <autodoc>IncRef(self)
</autodoc>
27656 <method name=
"DecRef" type=
"" overloaded=
"no">
27657 <autodoc>DecRef(self)
</autodoc>
27659 <method name=
"SetTextColour" type=
"" overloaded=
"no">
27660 <autodoc>SetTextColour(self, Colour colText)
</autodoc>
27662 <param name=
"colText" type=
"Colour" default=
""/>
27665 <method name=
"SetBackgroundColour" type=
"" overloaded=
"no">
27666 <autodoc>SetBackgroundColour(self, Colour colBack)
</autodoc>
27668 <param name=
"colBack" type=
"Colour" default=
""/>
27671 <method name=
"SetFont" type=
"" overloaded=
"no">
27672 <autodoc>SetFont(self, Font font)
</autodoc>
27674 <param name=
"font" type=
"Font" default=
""/>
27677 <method name=
"SetAlignment" type=
"" overloaded=
"no">
27678 <autodoc>SetAlignment(self, int hAlign, int vAlign)
</autodoc>
27680 <param name=
"hAlign" type=
"int" default=
""/>
27681 <param name=
"vAlign" type=
"int" default=
""/>
27684 <method name=
"SetSize" type=
"" overloaded=
"no">
27685 <autodoc>SetSize(self, int num_rows, int num_cols)
</autodoc>
27687 <param name=
"num_rows" type=
"int" default=
""/>
27688 <param name=
"num_cols" type=
"int" default=
""/>
27691 <method name=
"SetOverflow" type=
"" overloaded=
"no">
27692 <autodoc>SetOverflow(self, bool allow=True)
</autodoc>
27694 <param name=
"allow" type=
"bool" default=
"True"/>
27697 <method name=
"SetReadOnly" type=
"" overloaded=
"no">
27698 <autodoc>SetReadOnly(self, bool isReadOnly=True)
</autodoc>
27700 <param name=
"isReadOnly" type=
"bool" default=
"True"/>
27703 <method name=
"SetRenderer" type=
"" overloaded=
"no">
27704 <autodoc>SetRenderer(self, GridCellRenderer renderer)
</autodoc>
27706 <param name=
"renderer" type=
"GridCellRenderer" default=
""/>
27709 <method name=
"SetEditor" type=
"" overloaded=
"no">
27710 <autodoc>SetEditor(self, GridCellEditor editor)
</autodoc>
27712 <param name=
"editor" type=
"GridCellEditor" default=
""/>
27715 <method name=
"SetKind" type=
"" overloaded=
"no">
27716 <autodoc>SetKind(self, int kind)
</autodoc>
27718 <param name=
"kind" type=
"wxGridCellAttr::wxAttrKind" default=
""/>
27721 <method name=
"HasTextColour" type=
"bool" overloaded=
"no">
27722 <autodoc>HasTextColour(self) -
> bool
</autodoc>
27724 <method name=
"HasBackgroundColour" type=
"bool" overloaded=
"no">
27725 <autodoc>HasBackgroundColour(self) -
> bool
</autodoc>
27727 <method name=
"HasFont" type=
"bool" overloaded=
"no">
27728 <autodoc>HasFont(self) -
> bool
</autodoc>
27730 <method name=
"HasAlignment" type=
"bool" overloaded=
"no">
27731 <autodoc>HasAlignment(self) -
> bool
</autodoc>
27733 <method name=
"HasRenderer" type=
"bool" overloaded=
"no">
27734 <autodoc>HasRenderer(self) -
> bool
</autodoc>
27736 <method name=
"HasEditor" type=
"bool" overloaded=
"no">
27737 <autodoc>HasEditor(self) -
> bool
</autodoc>
27739 <method name=
"HasReadWriteMode" type=
"bool" overloaded=
"no">
27740 <autodoc>HasReadWriteMode(self) -
> bool
</autodoc>
27742 <method name=
"HasOverflowMode" type=
"bool" overloaded=
"no">
27743 <autodoc>HasOverflowMode(self) -
> bool
</autodoc>
27745 <method name=
"GetTextColour" type=
"Colour" overloaded=
"no">
27746 <autodoc>GetTextColour(self) -
> Colour
</autodoc>
27748 <method name=
"GetBackgroundColour" type=
"Colour" overloaded=
"no">
27749 <autodoc>GetBackgroundColour(self) -
> Colour
</autodoc>
27751 <method name=
"GetFont" type=
"Font" overloaded=
"no">
27752 <autodoc>GetFont(self) -
> Font
</autodoc>
27754 <method name=
"GetAlignment" type=
"" overloaded=
"no">
27755 <autodoc>GetAlignment() -
> (hAlign, vAlign)
</autodoc>
27757 <param name=
"OUTPUT" type=
"int" default=
""/>
27758 <param name=
"OUTPUT" type=
"int" default=
""/>
27761 <method name=
"GetSize" type=
"" overloaded=
"no">
27762 <autodoc>GetSize() -
> (num_rows, num_cols)
</autodoc>
27764 <param name=
"OUTPUT" type=
"int" default=
""/>
27765 <param name=
"OUTPUT" type=
"int" default=
""/>
27768 <method name=
"GetOverflow" type=
"bool" overloaded=
"no">
27769 <autodoc>GetOverflow(self) -
> bool
</autodoc>
27771 <method name=
"GetRenderer" type=
"GridCellRenderer" overloaded=
"no">
27772 <autodoc>GetRenderer(self, Grid grid, int row, int col) -
> GridCellRenderer
</autodoc>
27774 <param name=
"grid" type=
"wxGrid" default=
""/>
27775 <param name=
"row" type=
"int" default=
""/>
27776 <param name=
"col" type=
"int" default=
""/>
27779 <method name=
"GetEditor" type=
"GridCellEditor" overloaded=
"no">
27780 <autodoc>GetEditor(self, Grid grid, int row, int col) -
> GridCellEditor
</autodoc>
27782 <param name=
"grid" type=
"wxGrid" default=
""/>
27783 <param name=
"row" type=
"int" default=
""/>
27784 <param name=
"col" type=
"int" default=
""/>
27787 <method name=
"IsReadOnly" type=
"bool" overloaded=
"no">
27788 <autodoc>IsReadOnly(self) -
> bool
</autodoc>
27790 <method name=
"GetKind" type=
"wxGridCellAttr::wxAttrKind" overloaded=
"no">
27791 <autodoc>GetKind(self) -
> int
</autodoc>
27793 <method name=
"SetDefAttr" type=
"" overloaded=
"no">
27794 <autodoc>SetDefAttr(self, GridCellAttr defAttr)
</autodoc>
27796 <param name=
"defAttr" type=
"GridCellAttr" default=
""/>
27800 <class name=
"GridCellAttrProvider" oldname=
"wxGridCellAttrProvider" module=
"grid">
27801 <constructor name=
"GridCellAttrProvider" overloaded=
"no">
27802 <autodoc>__init__(self) -
> GridCellAttrProvider
</autodoc>
27804 <method name=
"_setOORInfo" type=
"" overloaded=
"no">
27805 <autodoc>_setOORInfo(self, PyObject _self)
</autodoc>
27807 <param name=
"_self" type=
"PyObject" default=
""/>
27810 <method name=
"GetAttr" type=
"GridCellAttr" overloaded=
"no">
27811 <autodoc>GetAttr(self, int row, int col, int kind) -
> GridCellAttr
</autodoc>
27813 <param name=
"row" type=
"int" default=
""/>
27814 <param name=
"col" type=
"int" default=
""/>
27815 <param name=
"kind" type=
"wxGridCellAttr::wxAttrKind" default=
""/>
27818 <method name=
"SetAttr" type=
"" overloaded=
"no">
27819 <autodoc>SetAttr(self, GridCellAttr attr, int row, int col)
</autodoc>
27821 <param name=
"attr" type=
"GridCellAttr" default=
""/>
27822 <param name=
"row" type=
"int" default=
""/>
27823 <param name=
"col" type=
"int" default=
""/>
27826 <method name=
"SetRowAttr" type=
"" overloaded=
"no">
27827 <autodoc>SetRowAttr(self, GridCellAttr attr, int row)
</autodoc>
27829 <param name=
"attr" type=
"GridCellAttr" default=
""/>
27830 <param name=
"row" type=
"int" default=
""/>
27833 <method name=
"SetColAttr" type=
"" overloaded=
"no">
27834 <autodoc>SetColAttr(self, GridCellAttr attr, int col)
</autodoc>
27836 <param name=
"attr" type=
"GridCellAttr" default=
""/>
27837 <param name=
"col" type=
"int" default=
""/>
27840 <method name=
"UpdateAttrRows" type=
"" overloaded=
"no">
27841 <autodoc>UpdateAttrRows(self, size_t pos, int numRows)
</autodoc>
27843 <param name=
"pos" type=
"size_t" default=
""/>
27844 <param name=
"numRows" type=
"int" default=
""/>
27847 <method name=
"UpdateAttrCols" type=
"" overloaded=
"no">
27848 <autodoc>UpdateAttrCols(self, size_t pos, int numCols)
</autodoc>
27850 <param name=
"pos" type=
"size_t" default=
""/>
27851 <param name=
"numCols" type=
"int" default=
""/>
27855 <class name=
"PyGridCellAttrProvider" oldname=
"wxPyGridCellAttrProvider" module=
"grid">
27856 <baseclass name=
"GridCellAttrProvider"/>
27857 <constructor name=
"PyGridCellAttrProvider" overloaded=
"no">
27858 <autodoc>__init__(self) -
> PyGridCellAttrProvider
</autodoc>
27860 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
27861 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
27863 <param name=
"self" type=
"PyObject" default=
""/>
27864 <param name=
"_class" type=
"PyObject" default=
""/>
27867 <method name=
"base_GetAttr" type=
"GridCellAttr" overloaded=
"no">
27868 <autodoc>base_GetAttr(self, int row, int col, int kind) -
> GridCellAttr
</autodoc>
27870 <param name=
"row" type=
"int" default=
""/>
27871 <param name=
"col" type=
"int" default=
""/>
27872 <param name=
"kind" type=
"wxGridCellAttr::wxAttrKind" default=
""/>
27875 <method name=
"base_SetAttr" type=
"" overloaded=
"no">
27876 <autodoc>base_SetAttr(self, GridCellAttr attr, int row, int col)
</autodoc>
27878 <param name=
"attr" type=
"GridCellAttr" default=
""/>
27879 <param name=
"row" type=
"int" default=
""/>
27880 <param name=
"col" type=
"int" default=
""/>
27883 <method name=
"base_SetRowAttr" type=
"" overloaded=
"no">
27884 <autodoc>base_SetRowAttr(self, GridCellAttr attr, int row)
</autodoc>
27886 <param name=
"attr" type=
"GridCellAttr" default=
""/>
27887 <param name=
"row" type=
"int" default=
""/>
27890 <method name=
"base_SetColAttr" type=
"" overloaded=
"no">
27891 <autodoc>base_SetColAttr(self, GridCellAttr attr, int col)
</autodoc>
27893 <param name=
"attr" type=
"GridCellAttr" default=
""/>
27894 <param name=
"col" type=
"int" default=
""/>
27898 <class name=
"GridTableBase" oldname=
"wxGridTableBase" module=
"grid">
27899 <baseclass name=
"Object"/>
27900 <method name=
"_setOORInfo" type=
"" overloaded=
"no">
27901 <autodoc>_setOORInfo(self, PyObject _self)
</autodoc>
27903 <param name=
"_self" type=
"PyObject" default=
""/>
27906 <method name=
"SetAttrProvider" type=
"" overloaded=
"no">
27907 <autodoc>SetAttrProvider(self, GridCellAttrProvider attrProvider)
</autodoc>
27909 <param name=
"attrProvider" type=
"GridCellAttrProvider" default=
""/>
27912 <method name=
"GetAttrProvider" type=
"GridCellAttrProvider" overloaded=
"no">
27913 <autodoc>GetAttrProvider(self) -
> GridCellAttrProvider
</autodoc>
27915 <method name=
"SetView" type=
"" overloaded=
"no">
27916 <autodoc>SetView(self, Grid grid)
</autodoc>
27918 <param name=
"grid" type=
"wxGrid" default=
""/>
27921 <method name=
"GetView" type=
"wxGrid" overloaded=
"no">
27922 <autodoc>GetView(self) -
> Grid
</autodoc>
27924 <method name=
"GetNumberRows" type=
"int" overloaded=
"no">
27925 <autodoc>GetNumberRows(self) -
> int
</autodoc>
27927 <method name=
"GetNumberCols" type=
"int" overloaded=
"no">
27928 <autodoc>GetNumberCols(self) -
> int
</autodoc>
27930 <method name=
"IsEmptyCell" type=
"bool" overloaded=
"no">
27931 <autodoc>IsEmptyCell(self, int row, int col) -
> bool
</autodoc>
27933 <param name=
"row" type=
"int" default=
""/>
27934 <param name=
"col" type=
"int" default=
""/>
27937 <method name=
"GetValue" type=
"String" overloaded=
"no">
27938 <autodoc>GetValue(self, int row, int col) -
> String
</autodoc>
27940 <param name=
"row" type=
"int" default=
""/>
27941 <param name=
"col" type=
"int" default=
""/>
27944 <method name=
"SetValue" type=
"" overloaded=
"no">
27945 <autodoc>SetValue(self, int row, int col, String value)
</autodoc>
27947 <param name=
"row" type=
"int" default=
""/>
27948 <param name=
"col" type=
"int" default=
""/>
27949 <param name=
"value" type=
"String" default=
""/>
27952 <method name=
"GetTypeName" type=
"String" overloaded=
"no">
27953 <autodoc>GetTypeName(self, int row, int col) -
> String
</autodoc>
27955 <param name=
"row" type=
"int" default=
""/>
27956 <param name=
"col" type=
"int" default=
""/>
27959 <method name=
"CanGetValueAs" type=
"bool" overloaded=
"no">
27960 <autodoc>CanGetValueAs(self, int row, int col, String typeName) -
> bool
</autodoc>
27962 <param name=
"row" type=
"int" default=
""/>
27963 <param name=
"col" type=
"int" default=
""/>
27964 <param name=
"typeName" type=
"String" default=
""/>
27967 <method name=
"CanSetValueAs" type=
"bool" overloaded=
"no">
27968 <autodoc>CanSetValueAs(self, int row, int col, String typeName) -
> bool
</autodoc>
27970 <param name=
"row" type=
"int" default=
""/>
27971 <param name=
"col" type=
"int" default=
""/>
27972 <param name=
"typeName" type=
"String" default=
""/>
27975 <method name=
"GetValueAsLong" type=
"long" overloaded=
"no">
27976 <autodoc>GetValueAsLong(self, int row, int col) -
> long
</autodoc>
27978 <param name=
"row" type=
"int" default=
""/>
27979 <param name=
"col" type=
"int" default=
""/>
27982 <method name=
"GetValueAsDouble" type=
"double" overloaded=
"no">
27983 <autodoc>GetValueAsDouble(self, int row, int col) -
> double
</autodoc>
27985 <param name=
"row" type=
"int" default=
""/>
27986 <param name=
"col" type=
"int" default=
""/>
27989 <method name=
"GetValueAsBool" type=
"bool" overloaded=
"no">
27990 <autodoc>GetValueAsBool(self, int row, int col) -
> bool
</autodoc>
27992 <param name=
"row" type=
"int" default=
""/>
27993 <param name=
"col" type=
"int" default=
""/>
27996 <method name=
"SetValueAsLong" type=
"" overloaded=
"no">
27997 <autodoc>SetValueAsLong(self, int row, int col, long value)
</autodoc>
27999 <param name=
"row" type=
"int" default=
""/>
28000 <param name=
"col" type=
"int" default=
""/>
28001 <param name=
"value" type=
"long" default=
""/>
28004 <method name=
"SetValueAsDouble" type=
"" overloaded=
"no">
28005 <autodoc>SetValueAsDouble(self, int row, int col, double value)
</autodoc>
28007 <param name=
"row" type=
"int" default=
""/>
28008 <param name=
"col" type=
"int" default=
""/>
28009 <param name=
"value" type=
"double" default=
""/>
28012 <method name=
"SetValueAsBool" type=
"" overloaded=
"no">
28013 <autodoc>SetValueAsBool(self, int row, int col, bool value)
</autodoc>
28015 <param name=
"row" type=
"int" default=
""/>
28016 <param name=
"col" type=
"int" default=
""/>
28017 <param name=
"value" type=
"bool" default=
""/>
28020 <method name=
"Clear" type=
"" overloaded=
"no">
28021 <autodoc>Clear(self)
</autodoc>
28023 <method name=
"InsertRows" type=
"bool" overloaded=
"no">
28024 <autodoc>InsertRows(self, size_t pos=
0, size_t numRows=
1) -
> bool
</autodoc>
28026 <param name=
"pos" type=
"size_t" default=
"0"/>
28027 <param name=
"numRows" type=
"size_t" default=
"1"/>
28030 <method name=
"AppendRows" type=
"bool" overloaded=
"no">
28031 <autodoc>AppendRows(self, size_t numRows=
1) -
> bool
</autodoc>
28033 <param name=
"numRows" type=
"size_t" default=
"1"/>
28036 <method name=
"DeleteRows" type=
"bool" overloaded=
"no">
28037 <autodoc>DeleteRows(self, size_t pos=
0, size_t numRows=
1) -
> bool
</autodoc>
28039 <param name=
"pos" type=
"size_t" default=
"0"/>
28040 <param name=
"numRows" type=
"size_t" default=
"1"/>
28043 <method name=
"InsertCols" type=
"bool" overloaded=
"no">
28044 <autodoc>InsertCols(self, size_t pos=
0, size_t numCols=
1) -
> bool
</autodoc>
28046 <param name=
"pos" type=
"size_t" default=
"0"/>
28047 <param name=
"numCols" type=
"size_t" default=
"1"/>
28050 <method name=
"AppendCols" type=
"bool" overloaded=
"no">
28051 <autodoc>AppendCols(self, size_t numCols=
1) -
> bool
</autodoc>
28053 <param name=
"numCols" type=
"size_t" default=
"1"/>
28056 <method name=
"DeleteCols" type=
"bool" overloaded=
"no">
28057 <autodoc>DeleteCols(self, size_t pos=
0, size_t numCols=
1) -
> bool
</autodoc>
28059 <param name=
"pos" type=
"size_t" default=
"0"/>
28060 <param name=
"numCols" type=
"size_t" default=
"1"/>
28063 <method name=
"GetRowLabelValue" type=
"String" overloaded=
"no">
28064 <autodoc>GetRowLabelValue(self, int row) -
> String
</autodoc>
28066 <param name=
"row" type=
"int" default=
""/>
28069 <method name=
"GetColLabelValue" type=
"String" overloaded=
"no">
28070 <autodoc>GetColLabelValue(self, int col) -
> String
</autodoc>
28072 <param name=
"col" type=
"int" default=
""/>
28075 <method name=
"SetRowLabelValue" type=
"" overloaded=
"no">
28076 <autodoc>SetRowLabelValue(self, int row, String value)
</autodoc>
28078 <param name=
"row" type=
"int" default=
""/>
28079 <param name=
"value" type=
"String" default=
""/>
28082 <method name=
"SetColLabelValue" type=
"" overloaded=
"no">
28083 <autodoc>SetColLabelValue(self, int col, String value)
</autodoc>
28085 <param name=
"col" type=
"int" default=
""/>
28086 <param name=
"value" type=
"String" default=
""/>
28089 <method name=
"CanHaveAttributes" type=
"bool" overloaded=
"no">
28090 <autodoc>CanHaveAttributes(self) -
> bool
</autodoc>
28092 <method name=
"GetAttr" type=
"GridCellAttr" overloaded=
"no">
28093 <autodoc>GetAttr(self, int row, int col, int kind) -
> GridCellAttr
</autodoc>
28095 <param name=
"row" type=
"int" default=
""/>
28096 <param name=
"col" type=
"int" default=
""/>
28097 <param name=
"kind" type=
"wxGridCellAttr::wxAttrKind" default=
""/>
28100 <method name=
"SetAttr" type=
"" overloaded=
"no">
28101 <autodoc>SetAttr(self, GridCellAttr attr, int row, int col)
</autodoc>
28103 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28104 <param name=
"row" type=
"int" default=
""/>
28105 <param name=
"col" type=
"int" default=
""/>
28108 <method name=
"SetRowAttr" type=
"" overloaded=
"no">
28109 <autodoc>SetRowAttr(self, GridCellAttr attr, int row)
</autodoc>
28111 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28112 <param name=
"row" type=
"int" default=
""/>
28115 <method name=
"SetColAttr" type=
"" overloaded=
"no">
28116 <autodoc>SetColAttr(self, GridCellAttr attr, int col)
</autodoc>
28118 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28119 <param name=
"col" type=
"int" default=
""/>
28123 <class name=
"PyGridTableBase" oldname=
"wxPyGridTableBase" module=
"grid">
28124 <baseclass name=
"GridTableBase"/>
28125 <constructor name=
"PyGridTableBase" overloaded=
"no">
28126 <autodoc>__init__(self) -
> PyGridTableBase
</autodoc>
28128 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
28129 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
28131 <param name=
"self" type=
"PyObject" default=
""/>
28132 <param name=
"_class" type=
"PyObject" default=
""/>
28135 <method name=
"Destroy" type=
"" overloaded=
"no">
28136 <autodoc>Destroy(self)
</autodoc>
28137 <docstring>Deletes the C++ object this Python object is a proxy for.
</docstring>
28139 <method name=
"base_GetTypeName" type=
"String" overloaded=
"no">
28140 <autodoc>base_GetTypeName(self, int row, int col) -
> String
</autodoc>
28142 <param name=
"row" type=
"int" default=
""/>
28143 <param name=
"col" type=
"int" default=
""/>
28146 <method name=
"base_CanGetValueAs" type=
"bool" overloaded=
"no">
28147 <autodoc>base_CanGetValueAs(self, int row, int col, String typeName) -
> bool
</autodoc>
28149 <param name=
"row" type=
"int" default=
""/>
28150 <param name=
"col" type=
"int" default=
""/>
28151 <param name=
"typeName" type=
"String" default=
""/>
28154 <method name=
"base_CanSetValueAs" type=
"bool" overloaded=
"no">
28155 <autodoc>base_CanSetValueAs(self, int row, int col, String typeName) -
> bool
</autodoc>
28157 <param name=
"row" type=
"int" default=
""/>
28158 <param name=
"col" type=
"int" default=
""/>
28159 <param name=
"typeName" type=
"String" default=
""/>
28162 <method name=
"base_Clear" type=
"" overloaded=
"no">
28163 <autodoc>base_Clear(self)
</autodoc>
28165 <method name=
"base_InsertRows" type=
"bool" overloaded=
"no">
28166 <autodoc>base_InsertRows(self, size_t pos=
0, size_t numRows=
1) -
> bool
</autodoc>
28168 <param name=
"pos" type=
"size_t" default=
"0"/>
28169 <param name=
"numRows" type=
"size_t" default=
"1"/>
28172 <method name=
"base_AppendRows" type=
"bool" overloaded=
"no">
28173 <autodoc>base_AppendRows(self, size_t numRows=
1) -
> bool
</autodoc>
28175 <param name=
"numRows" type=
"size_t" default=
"1"/>
28178 <method name=
"base_DeleteRows" type=
"bool" overloaded=
"no">
28179 <autodoc>base_DeleteRows(self, size_t pos=
0, size_t numRows=
1) -
> bool
</autodoc>
28181 <param name=
"pos" type=
"size_t" default=
"0"/>
28182 <param name=
"numRows" type=
"size_t" default=
"1"/>
28185 <method name=
"base_InsertCols" type=
"bool" overloaded=
"no">
28186 <autodoc>base_InsertCols(self, size_t pos=
0, size_t numCols=
1) -
> bool
</autodoc>
28188 <param name=
"pos" type=
"size_t" default=
"0"/>
28189 <param name=
"numCols" type=
"size_t" default=
"1"/>
28192 <method name=
"base_AppendCols" type=
"bool" overloaded=
"no">
28193 <autodoc>base_AppendCols(self, size_t numCols=
1) -
> bool
</autodoc>
28195 <param name=
"numCols" type=
"size_t" default=
"1"/>
28198 <method name=
"base_DeleteCols" type=
"bool" overloaded=
"no">
28199 <autodoc>base_DeleteCols(self, size_t pos=
0, size_t numCols=
1) -
> bool
</autodoc>
28201 <param name=
"pos" type=
"size_t" default=
"0"/>
28202 <param name=
"numCols" type=
"size_t" default=
"1"/>
28205 <method name=
"base_GetRowLabelValue" type=
"String" overloaded=
"no">
28206 <autodoc>base_GetRowLabelValue(self, int row) -
> String
</autodoc>
28208 <param name=
"row" type=
"int" default=
""/>
28211 <method name=
"base_GetColLabelValue" type=
"String" overloaded=
"no">
28212 <autodoc>base_GetColLabelValue(self, int col) -
> String
</autodoc>
28214 <param name=
"col" type=
"int" default=
""/>
28217 <method name=
"base_SetRowLabelValue" type=
"" overloaded=
"no">
28218 <autodoc>base_SetRowLabelValue(self, int row, String value)
</autodoc>
28220 <param name=
"row" type=
"int" default=
""/>
28221 <param name=
"value" type=
"String" default=
""/>
28224 <method name=
"base_SetColLabelValue" type=
"" overloaded=
"no">
28225 <autodoc>base_SetColLabelValue(self, int col, String value)
</autodoc>
28227 <param name=
"col" type=
"int" default=
""/>
28228 <param name=
"value" type=
"String" default=
""/>
28231 <method name=
"base_CanHaveAttributes" type=
"bool" overloaded=
"no">
28232 <autodoc>base_CanHaveAttributes(self) -
> bool
</autodoc>
28234 <method name=
"base_GetAttr" type=
"GridCellAttr" overloaded=
"no">
28235 <autodoc>base_GetAttr(self, int row, int col, int kind) -
> GridCellAttr
</autodoc>
28237 <param name=
"row" type=
"int" default=
""/>
28238 <param name=
"col" type=
"int" default=
""/>
28239 <param name=
"kind" type=
"wxGridCellAttr::wxAttrKind" default=
""/>
28242 <method name=
"base_SetAttr" type=
"" overloaded=
"no">
28243 <autodoc>base_SetAttr(self, GridCellAttr attr, int row, int col)
</autodoc>
28245 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28246 <param name=
"row" type=
"int" default=
""/>
28247 <param name=
"col" type=
"int" default=
""/>
28250 <method name=
"base_SetRowAttr" type=
"" overloaded=
"no">
28251 <autodoc>base_SetRowAttr(self, GridCellAttr attr, int row)
</autodoc>
28253 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28254 <param name=
"row" type=
"int" default=
""/>
28257 <method name=
"base_SetColAttr" type=
"" overloaded=
"no">
28258 <autodoc>base_SetColAttr(self, GridCellAttr attr, int col)
</autodoc>
28260 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28261 <param name=
"col" type=
"int" default=
""/>
28265 <class name=
"GridStringTable" oldname=
"wxGridStringTable" module=
"grid">
28266 <baseclass name=
"GridTableBase"/>
28267 <constructor name=
"GridStringTable" overloaded=
"no">
28268 <autodoc>__init__(self, int numRows=
0, int numCols=
0) -
> GridStringTable
</autodoc>
28270 <param name=
"numRows" type=
"int" default=
"0"/>
28271 <param name=
"numCols" type=
"int" default=
"0"/>
28275 <class name=
"GridTableMessage" oldname=
"wxGridTableMessage" module=
"grid">
28276 <constructor name=
"GridTableMessage" overloaded=
"no">
28277 <autodoc>__init__(self, GridTableBase table, int id, int comInt1=-
1, int comInt2=-
1) -
> GridTableMessage
</autodoc>
28279 <param name=
"table" type=
"GridTableBase" default=
""/>
28280 <param name=
"id" type=
"int" default=
""/>
28281 <param name=
"comInt1" type=
"int" default=
"-1"/>
28282 <param name=
"comInt2" type=
"int" default=
"-1"/>
28285 <destructor name=
"~wxGridTableMessage" overloaded=
"no">
28286 <autodoc>__del__(self)
</autodoc>
28288 <method name=
"SetTableObject" type=
"" overloaded=
"no">
28289 <autodoc>SetTableObject(self, GridTableBase table)
</autodoc>
28291 <param name=
"table" type=
"GridTableBase" default=
""/>
28294 <method name=
"GetTableObject" type=
"GridTableBase" overloaded=
"no">
28295 <autodoc>GetTableObject(self) -
> GridTableBase
</autodoc>
28297 <method name=
"SetId" type=
"" overloaded=
"no">
28298 <autodoc>SetId(self, int id)
</autodoc>
28300 <param name=
"id" type=
"int" default=
""/>
28303 <method name=
"GetId" type=
"int" overloaded=
"no">
28304 <autodoc>GetId(self) -
> int
</autodoc>
28306 <method name=
"SetCommandInt" type=
"" overloaded=
"no">
28307 <autodoc>SetCommandInt(self, int comInt1)
</autodoc>
28309 <param name=
"comInt1" type=
"int" default=
""/>
28312 <method name=
"GetCommandInt" type=
"int" overloaded=
"no">
28313 <autodoc>GetCommandInt(self) -
> int
</autodoc>
28315 <method name=
"SetCommandInt2" type=
"" overloaded=
"no">
28316 <autodoc>SetCommandInt2(self, int comInt2)
</autodoc>
28318 <param name=
"comInt2" type=
"int" default=
""/>
28321 <method name=
"GetCommandInt2" type=
"int" overloaded=
"no">
28322 <autodoc>GetCommandInt2(self) -
> int
</autodoc>
28325 <class name=
"GridCellCoords" oldname=
"wxGridCellCoords" module=
"grid">
28326 <constructor name=
"GridCellCoords" overloaded=
"no">
28327 <autodoc>__init__(self, int r=-
1, int c=-
1) -
> GridCellCoords
</autodoc>
28329 <param name=
"r" type=
"int" default=
"-1"/>
28330 <param name=
"c" type=
"int" default=
"-1"/>
28333 <destructor name=
"~wxGridCellCoords" overloaded=
"no">
28334 <autodoc>__del__(self)
</autodoc>
28336 <method name=
"GetRow" type=
"int" overloaded=
"no">
28337 <autodoc>GetRow(self) -
> int
</autodoc>
28339 <method name=
"SetRow" type=
"" overloaded=
"no">
28340 <autodoc>SetRow(self, int n)
</autodoc>
28342 <param name=
"n" type=
"int" default=
""/>
28345 <method name=
"GetCol" type=
"int" overloaded=
"no">
28346 <autodoc>GetCol(self) -
> int
</autodoc>
28348 <method name=
"SetCol" type=
"" overloaded=
"no">
28349 <autodoc>SetCol(self, int n)
</autodoc>
28351 <param name=
"n" type=
"int" default=
""/>
28354 <method name=
"Set" type=
"" overloaded=
"no">
28355 <autodoc>Set(self, int row, int col)
</autodoc>
28357 <param name=
"row" type=
"int" default=
""/>
28358 <param name=
"col" type=
"int" default=
""/>
28361 <method name=
"__eq__" type=
"bool" overloaded=
"no">
28362 <autodoc>__eq__(self, GridCellCoords other) -
> bool
</autodoc>
28364 <param name=
"other" type=
"GridCellCoords" default=
""/>
28367 <method name=
"__ne__" type=
"bool" overloaded=
"no">
28368 <autodoc>__ne__(self, GridCellCoords other) -
> bool
</autodoc>
28370 <param name=
"other" type=
"GridCellCoords" default=
""/>
28373 <method name=
"Get" type=
"PyObject" overloaded=
"no">
28374 <autodoc>Get(self) -
> PyObject
</autodoc>
28377 <class name=
"Grid" oldname=
"wxGrid" module=
"grid">
28378 <baseclass name=
"ScrolledWindow"/>
28379 <constructor name=
"Grid" overloaded=
"no">
28380 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
28381 Size size=DefaultSize, long style=WANTS_CHARS,
28382 String name=PanelNameStr) -
> Grid
</autodoc>
28384 <param name=
"parent" type=
"Window" default=
""/>
28385 <param name=
"id" type=
"int" default=
"-1"/>
28386 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
28387 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
28388 <param name=
"style" type=
"long" default=
"wxWANTS_CHARS"/>
28389 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
28392 <constructor name=
"PreGrid" overloaded=
"no">
28393 <autodoc>PreGrid() -
> Grid
</autodoc>
28395 <method name=
"Create" type=
"bool" overloaded=
"no">
28396 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
28397 Size size=DefaultSize, long style=WANTS_CHARS,
28398 String name=PanelNameStr) -
> bool
</autodoc>
28400 <param name=
"parent" type=
"Window" default=
""/>
28401 <param name=
"id" type=
"int" default=
"-1"/>
28402 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
28403 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
28404 <param name=
"style" type=
"long" default=
"wxWANTS_CHARS"/>
28405 <param name=
"name" type=
"String" default=
"wxPyPanelNameStr"/>
28408 <method name=
"CreateGrid" type=
"bool" overloaded=
"no">
28409 <autodoc>CreateGrid(self, int numRows, int numCols, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -
> bool
</autodoc>
28411 <param name=
"numRows" type=
"int" default=
""/>
28412 <param name=
"numCols" type=
"int" default=
""/>
28413 <param name=
"selmode" type=
"WXGRIDSELECTIONMODES" default=
"wxGrid::wxGridSelectCells"/>
28416 <method name=
"SetSelectionMode" type=
"" overloaded=
"no">
28417 <autodoc>SetSelectionMode(self, WXGRIDSELECTIONMODES selmode)
</autodoc>
28419 <param name=
"selmode" type=
"WXGRIDSELECTIONMODES" default=
""/>
28422 <method name=
"GetSelectionMode" type=
"WXGRIDSELECTIONMODES" overloaded=
"no">
28423 <autodoc>GetSelectionMode(self) -
> WXGRIDSELECTIONMODES
</autodoc>
28425 <method name=
"GetNumberRows" type=
"int" overloaded=
"no">
28426 <autodoc>GetNumberRows(self) -
> int
</autodoc>
28428 <method name=
"GetNumberCols" type=
"int" overloaded=
"no">
28429 <autodoc>GetNumberCols(self) -
> int
</autodoc>
28431 <method name=
"ProcessTableMessage" type=
"bool" overloaded=
"no">
28432 <autodoc>ProcessTableMessage(self, GridTableMessage ??) -
> bool
</autodoc>
28434 <param name=
"" type=
"GridTableMessage" default=
""/>
28437 <method name=
"GetTable" type=
"GridTableBase" overloaded=
"no">
28438 <autodoc>GetTable(self) -
> GridTableBase
</autodoc>
28440 <method name=
"SetTable" type=
"bool" overloaded=
"no">
28441 <autodoc>SetTable(self, GridTableBase table, bool takeOwnership=False, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -
> bool
</autodoc>
28443 <param name=
"table" type=
"GridTableBase" default=
""/>
28444 <param name=
"takeOwnership" type=
"bool" default=
"False"/>
28445 <param name=
"selmode" type=
"WXGRIDSELECTIONMODES" default=
"wxGrid::wxGridSelectCells"/>
28448 <method name=
"ClearGrid" type=
"" overloaded=
"no">
28449 <autodoc>ClearGrid(self)
</autodoc>
28451 <method name=
"InsertRows" type=
"bool" overloaded=
"no">
28452 <autodoc>InsertRows(self, int pos=
0, int numRows=
1, bool updateLabels=True) -
> bool
</autodoc>
28454 <param name=
"pos" type=
"int" default=
"0"/>
28455 <param name=
"numRows" type=
"int" default=
"1"/>
28456 <param name=
"updateLabels" type=
"bool" default=
"True"/>
28459 <method name=
"AppendRows" type=
"bool" overloaded=
"no">
28460 <autodoc>AppendRows(self, int numRows=
1, bool updateLabels=True) -
> bool
</autodoc>
28462 <param name=
"numRows" type=
"int" default=
"1"/>
28463 <param name=
"updateLabels" type=
"bool" default=
"True"/>
28466 <method name=
"DeleteRows" type=
"bool" overloaded=
"no">
28467 <autodoc>DeleteRows(self, int pos=
0, int numRows=
1, bool updateLabels=True) -
> bool
</autodoc>
28469 <param name=
"pos" type=
"int" default=
"0"/>
28470 <param name=
"numRows" type=
"int" default=
"1"/>
28471 <param name=
"updateLabels" type=
"bool" default=
"True"/>
28474 <method name=
"InsertCols" type=
"bool" overloaded=
"no">
28475 <autodoc>InsertCols(self, int pos=
0, int numCols=
1, bool updateLabels=True) -
> bool
</autodoc>
28477 <param name=
"pos" type=
"int" default=
"0"/>
28478 <param name=
"numCols" type=
"int" default=
"1"/>
28479 <param name=
"updateLabels" type=
"bool" default=
"True"/>
28482 <method name=
"AppendCols" type=
"bool" overloaded=
"no">
28483 <autodoc>AppendCols(self, int numCols=
1, bool updateLabels=True) -
> bool
</autodoc>
28485 <param name=
"numCols" type=
"int" default=
"1"/>
28486 <param name=
"updateLabels" type=
"bool" default=
"True"/>
28489 <method name=
"DeleteCols" type=
"bool" overloaded=
"no">
28490 <autodoc>DeleteCols(self, int pos=
0, int numCols=
1, bool updateLabels=True) -
> bool
</autodoc>
28492 <param name=
"pos" type=
"int" default=
"0"/>
28493 <param name=
"numCols" type=
"int" default=
"1"/>
28494 <param name=
"updateLabels" type=
"bool" default=
"True"/>
28497 <method name=
"DrawCellHighlight" type=
"" overloaded=
"no">
28498 <autodoc>DrawCellHighlight(self, DC dc, GridCellAttr attr)
</autodoc>
28500 <param name=
"dc" type=
"DC" default=
""/>
28501 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28504 <method name=
"DrawTextRectangle" type=
"" overloaded=
"no">
28505 <autodoc>DrawTextRectangle(self, DC dc, String ??, Rect ??, int horizontalAlignment=LEFT,
28506 int verticalAlignment=TOP, int textOrientation=HORIZONTAL)
</autodoc>
28508 <param name=
"dc" type=
"DC" default=
""/>
28509 <param name=
"" type=
"String" default=
""/>
28510 <param name=
"" type=
"Rect" default=
""/>
28511 <param name=
"horizontalAlignment" type=
"int" default=
"wxLEFT"/>
28512 <param name=
"verticalAlignment" type=
"int" default=
"wxTOP"/>
28513 <param name=
"textOrientation" type=
"int" default=
"wxHORIZONTAL"/>
28516 <method name=
"GetTextBoxSize" type=
"" overloaded=
"no">
28517 <autodoc>GetTextBoxSize(DC dc, list lines) -
> (width, height)
</autodoc>
28519 <param name=
"dc" type=
"DC" default=
""/>
28520 <param name=
"lines" type=
"wxArrayString" default=
""/>
28521 <param name=
"OUTPUT" type=
"long" default=
""/>
28522 <param name=
"OUTPUT" type=
"long" default=
""/>
28525 <method name=
"BeginBatch" type=
"" overloaded=
"no">
28526 <autodoc>BeginBatch(self)
</autodoc>
28528 <method name=
"EndBatch" type=
"" overloaded=
"no">
28529 <autodoc>EndBatch(self)
</autodoc>
28531 <method name=
"GetBatchCount" type=
"int" overloaded=
"no">
28532 <autodoc>GetBatchCount(self) -
> int
</autodoc>
28534 <method name=
"ForceRefresh" type=
"" overloaded=
"no">
28535 <autodoc>ForceRefresh(self)
</autodoc>
28537 <method name=
"IsEditable" type=
"bool" overloaded=
"no">
28538 <autodoc>IsEditable(self) -
> bool
</autodoc>
28540 <method name=
"EnableEditing" type=
"" overloaded=
"no">
28541 <autodoc>EnableEditing(self, bool edit)
</autodoc>
28543 <param name=
"edit" type=
"bool" default=
""/>
28546 <method name=
"EnableCellEditControl" type=
"" overloaded=
"no">
28547 <autodoc>EnableCellEditControl(self, bool enable=True)
</autodoc>
28549 <param name=
"enable" type=
"bool" default=
"True"/>
28552 <method name=
"DisableCellEditControl" type=
"" overloaded=
"no">
28553 <autodoc>DisableCellEditControl(self)
</autodoc>
28555 <method name=
"CanEnableCellControl" type=
"bool" overloaded=
"no">
28556 <autodoc>CanEnableCellControl(self) -
> bool
</autodoc>
28558 <method name=
"IsCellEditControlEnabled" type=
"bool" overloaded=
"no">
28559 <autodoc>IsCellEditControlEnabled(self) -
> bool
</autodoc>
28561 <method name=
"IsCellEditControlShown" type=
"bool" overloaded=
"no">
28562 <autodoc>IsCellEditControlShown(self) -
> bool
</autodoc>
28564 <method name=
"IsCurrentCellReadOnly" type=
"bool" overloaded=
"no">
28565 <autodoc>IsCurrentCellReadOnly(self) -
> bool
</autodoc>
28567 <method name=
"ShowCellEditControl" type=
"" overloaded=
"no">
28568 <autodoc>ShowCellEditControl(self)
</autodoc>
28570 <method name=
"HideCellEditControl" type=
"" overloaded=
"no">
28571 <autodoc>HideCellEditControl(self)
</autodoc>
28573 <method name=
"SaveEditControlValue" type=
"" overloaded=
"no">
28574 <autodoc>SaveEditControlValue(self)
</autodoc>
28576 <method name=
"XYToCell" type=
"GridCellCoords" overloaded=
"no">
28577 <autodoc>XYToCell(self, int x, int y) -
> GridCellCoords
</autodoc>
28579 <param name=
"x" type=
"int" default=
""/>
28580 <param name=
"y" type=
"int" default=
""/>
28583 <method name=
"YToRow" type=
"int" overloaded=
"no">
28584 <autodoc>YToRow(self, int y) -
> int
</autodoc>
28586 <param name=
"y" type=
"int" default=
""/>
28589 <method name=
"XToCol" type=
"int" overloaded=
"no">
28590 <autodoc>XToCol(self, int x) -
> int
</autodoc>
28592 <param name=
"x" type=
"int" default=
""/>
28595 <method name=
"YToEdgeOfRow" type=
"int" overloaded=
"no">
28596 <autodoc>YToEdgeOfRow(self, int y) -
> int
</autodoc>
28598 <param name=
"y" type=
"int" default=
""/>
28601 <method name=
"XToEdgeOfCol" type=
"int" overloaded=
"no">
28602 <autodoc>XToEdgeOfCol(self, int x) -
> int
</autodoc>
28604 <param name=
"x" type=
"int" default=
""/>
28607 <method name=
"CellToRect" type=
"Rect" overloaded=
"no">
28608 <autodoc>CellToRect(self, int row, int col) -
> Rect
</autodoc>
28610 <param name=
"row" type=
"int" default=
""/>
28611 <param name=
"col" type=
"int" default=
""/>
28614 <method name=
"GetGridCursorRow" type=
"int" overloaded=
"no">
28615 <autodoc>GetGridCursorRow(self) -
> int
</autodoc>
28617 <method name=
"GetGridCursorCol" type=
"int" overloaded=
"no">
28618 <autodoc>GetGridCursorCol(self) -
> int
</autodoc>
28620 <method name=
"IsVisible" type=
"bool" overloaded=
"no">
28621 <autodoc>IsVisible(self, int row, int col, bool wholeCellVisible=True) -
> bool
</autodoc>
28623 <param name=
"row" type=
"int" default=
""/>
28624 <param name=
"col" type=
"int" default=
""/>
28625 <param name=
"wholeCellVisible" type=
"bool" default=
"True"/>
28628 <method name=
"MakeCellVisible" type=
"" overloaded=
"no">
28629 <autodoc>MakeCellVisible(self, int row, int col)
</autodoc>
28631 <param name=
"row" type=
"int" default=
""/>
28632 <param name=
"col" type=
"int" default=
""/>
28635 <method name=
"SetGridCursor" type=
"" overloaded=
"no">
28636 <autodoc>SetGridCursor(self, int row, int col)
</autodoc>
28638 <param name=
"row" type=
"int" default=
""/>
28639 <param name=
"col" type=
"int" default=
""/>
28642 <method name=
"MoveCursorUp" type=
"bool" overloaded=
"no">
28643 <autodoc>MoveCursorUp(self, bool expandSelection) -
> bool
</autodoc>
28645 <param name=
"expandSelection" type=
"bool" default=
""/>
28648 <method name=
"MoveCursorDown" type=
"bool" overloaded=
"no">
28649 <autodoc>MoveCursorDown(self, bool expandSelection) -
> bool
</autodoc>
28651 <param name=
"expandSelection" type=
"bool" default=
""/>
28654 <method name=
"MoveCursorLeft" type=
"bool" overloaded=
"no">
28655 <autodoc>MoveCursorLeft(self, bool expandSelection) -
> bool
</autodoc>
28657 <param name=
"expandSelection" type=
"bool" default=
""/>
28660 <method name=
"MoveCursorRight" type=
"bool" overloaded=
"no">
28661 <autodoc>MoveCursorRight(self, bool expandSelection) -
> bool
</autodoc>
28663 <param name=
"expandSelection" type=
"bool" default=
""/>
28666 <method name=
"MovePageDown" type=
"bool" overloaded=
"no">
28667 <autodoc>MovePageDown(self) -
> bool
</autodoc>
28669 <method name=
"MovePageUp" type=
"bool" overloaded=
"no">
28670 <autodoc>MovePageUp(self) -
> bool
</autodoc>
28672 <method name=
"MoveCursorUpBlock" type=
"bool" overloaded=
"no">
28673 <autodoc>MoveCursorUpBlock(self, bool expandSelection) -
> bool
</autodoc>
28675 <param name=
"expandSelection" type=
"bool" default=
""/>
28678 <method name=
"MoveCursorDownBlock" type=
"bool" overloaded=
"no">
28679 <autodoc>MoveCursorDownBlock(self, bool expandSelection) -
> bool
</autodoc>
28681 <param name=
"expandSelection" type=
"bool" default=
""/>
28684 <method name=
"MoveCursorLeftBlock" type=
"bool" overloaded=
"no">
28685 <autodoc>MoveCursorLeftBlock(self, bool expandSelection) -
> bool
</autodoc>
28687 <param name=
"expandSelection" type=
"bool" default=
""/>
28690 <method name=
"MoveCursorRightBlock" type=
"bool" overloaded=
"no">
28691 <autodoc>MoveCursorRightBlock(self, bool expandSelection) -
> bool
</autodoc>
28693 <param name=
"expandSelection" type=
"bool" default=
""/>
28696 <method name=
"GetDefaultRowLabelSize" type=
"int" overloaded=
"no">
28697 <autodoc>GetDefaultRowLabelSize(self) -
> int
</autodoc>
28699 <method name=
"GetRowLabelSize" type=
"int" overloaded=
"no">
28700 <autodoc>GetRowLabelSize(self) -
> int
</autodoc>
28702 <method name=
"GetDefaultColLabelSize" type=
"int" overloaded=
"no">
28703 <autodoc>GetDefaultColLabelSize(self) -
> int
</autodoc>
28705 <method name=
"GetColLabelSize" type=
"int" overloaded=
"no">
28706 <autodoc>GetColLabelSize(self) -
> int
</autodoc>
28708 <method name=
"GetLabelBackgroundColour" type=
"Colour" overloaded=
"no">
28709 <autodoc>GetLabelBackgroundColour(self) -
> Colour
</autodoc>
28711 <method name=
"GetLabelTextColour" type=
"Colour" overloaded=
"no">
28712 <autodoc>GetLabelTextColour(self) -
> Colour
</autodoc>
28714 <method name=
"GetLabelFont" type=
"Font" overloaded=
"no">
28715 <autodoc>GetLabelFont(self) -
> Font
</autodoc>
28717 <method name=
"GetRowLabelAlignment" type=
"" overloaded=
"no">
28718 <autodoc>GetRowLabelAlignment() -
> (horiz, vert)
</autodoc>
28720 <param name=
"OUTPUT" type=
"int" default=
""/>
28721 <param name=
"OUTPUT" type=
"int" default=
""/>
28724 <method name=
"GetColLabelAlignment" type=
"" overloaded=
"no">
28725 <autodoc>GetColLabelAlignment() -
> (horiz, vert)
</autodoc>
28727 <param name=
"OUTPUT" type=
"int" default=
""/>
28728 <param name=
"OUTPUT" type=
"int" default=
""/>
28731 <method name=
"GetColLabelTextOrientation" type=
"int" overloaded=
"no">
28732 <autodoc>GetColLabelTextOrientation(self) -
> int
</autodoc>
28734 <method name=
"GetRowLabelValue" type=
"String" overloaded=
"no">
28735 <autodoc>GetRowLabelValue(self, int row) -
> String
</autodoc>
28737 <param name=
"row" type=
"int" default=
""/>
28740 <method name=
"GetColLabelValue" type=
"String" overloaded=
"no">
28741 <autodoc>GetColLabelValue(self, int col) -
> String
</autodoc>
28743 <param name=
"col" type=
"int" default=
""/>
28746 <method name=
"GetGridLineColour" type=
"Colour" overloaded=
"no">
28747 <autodoc>GetGridLineColour(self) -
> Colour
</autodoc>
28749 <method name=
"GetCellHighlightColour" type=
"Colour" overloaded=
"no">
28750 <autodoc>GetCellHighlightColour(self) -
> Colour
</autodoc>
28752 <method name=
"GetCellHighlightPenWidth" type=
"int" overloaded=
"no">
28753 <autodoc>GetCellHighlightPenWidth(self) -
> int
</autodoc>
28755 <method name=
"GetCellHighlightROPenWidth" type=
"int" overloaded=
"no">
28756 <autodoc>GetCellHighlightROPenWidth(self) -
> int
</autodoc>
28758 <method name=
"SetRowLabelSize" type=
"" overloaded=
"no">
28759 <autodoc>SetRowLabelSize(self, int width)
</autodoc>
28761 <param name=
"width" type=
"int" default=
""/>
28764 <method name=
"SetColLabelSize" type=
"" overloaded=
"no">
28765 <autodoc>SetColLabelSize(self, int height)
</autodoc>
28767 <param name=
"height" type=
"int" default=
""/>
28770 <method name=
"SetLabelBackgroundColour" type=
"" overloaded=
"no">
28771 <autodoc>SetLabelBackgroundColour(self, Colour ??)
</autodoc>
28773 <param name=
"" type=
"Colour" default=
""/>
28776 <method name=
"SetLabelTextColour" type=
"" overloaded=
"no">
28777 <autodoc>SetLabelTextColour(self, Colour ??)
</autodoc>
28779 <param name=
"" type=
"Colour" default=
""/>
28782 <method name=
"SetLabelFont" type=
"" overloaded=
"no">
28783 <autodoc>SetLabelFont(self, Font ??)
</autodoc>
28785 <param name=
"" type=
"Font" default=
""/>
28788 <method name=
"SetRowLabelAlignment" type=
"" overloaded=
"no">
28789 <autodoc>SetRowLabelAlignment(self, int horiz, int vert)
</autodoc>
28791 <param name=
"horiz" type=
"int" default=
""/>
28792 <param name=
"vert" type=
"int" default=
""/>
28795 <method name=
"SetColLabelAlignment" type=
"" overloaded=
"no">
28796 <autodoc>SetColLabelAlignment(self, int horiz, int vert)
</autodoc>
28798 <param name=
"horiz" type=
"int" default=
""/>
28799 <param name=
"vert" type=
"int" default=
""/>
28802 <method name=
"SetColLabelTextOrientation" type=
"" overloaded=
"no">
28803 <autodoc>SetColLabelTextOrientation(self, int textOrientation)
</autodoc>
28805 <param name=
"textOrientation" type=
"int" default=
""/>
28808 <method name=
"SetRowLabelValue" type=
"" overloaded=
"no">
28809 <autodoc>SetRowLabelValue(self, int row, String ??)
</autodoc>
28811 <param name=
"row" type=
"int" default=
""/>
28812 <param name=
"" type=
"String" default=
""/>
28815 <method name=
"SetColLabelValue" type=
"" overloaded=
"no">
28816 <autodoc>SetColLabelValue(self, int col, String ??)
</autodoc>
28818 <param name=
"col" type=
"int" default=
""/>
28819 <param name=
"" type=
"String" default=
""/>
28822 <method name=
"SetGridLineColour" type=
"" overloaded=
"no">
28823 <autodoc>SetGridLineColour(self, Colour ??)
</autodoc>
28825 <param name=
"" type=
"Colour" default=
""/>
28828 <method name=
"SetCellHighlightColour" type=
"" overloaded=
"no">
28829 <autodoc>SetCellHighlightColour(self, Colour ??)
</autodoc>
28831 <param name=
"" type=
"Colour" default=
""/>
28834 <method name=
"SetCellHighlightPenWidth" type=
"" overloaded=
"no">
28835 <autodoc>SetCellHighlightPenWidth(self, int width)
</autodoc>
28837 <param name=
"width" type=
"int" default=
""/>
28840 <method name=
"SetCellHighlightROPenWidth" type=
"" overloaded=
"no">
28841 <autodoc>SetCellHighlightROPenWidth(self, int width)
</autodoc>
28843 <param name=
"width" type=
"int" default=
""/>
28846 <method name=
"EnableDragRowSize" type=
"" overloaded=
"no">
28847 <autodoc>EnableDragRowSize(self, bool enable=True)
</autodoc>
28849 <param name=
"enable" type=
"bool" default=
"True"/>
28852 <method name=
"DisableDragRowSize" type=
"" overloaded=
"no">
28853 <autodoc>DisableDragRowSize(self)
</autodoc>
28855 <method name=
"CanDragRowSize" type=
"bool" overloaded=
"no">
28856 <autodoc>CanDragRowSize(self) -
> bool
</autodoc>
28858 <method name=
"EnableDragColSize" type=
"" overloaded=
"no">
28859 <autodoc>EnableDragColSize(self, bool enable=True)
</autodoc>
28861 <param name=
"enable" type=
"bool" default=
"True"/>
28864 <method name=
"DisableDragColSize" type=
"" overloaded=
"no">
28865 <autodoc>DisableDragColSize(self)
</autodoc>
28867 <method name=
"CanDragColSize" type=
"bool" overloaded=
"no">
28868 <autodoc>CanDragColSize(self) -
> bool
</autodoc>
28870 <method name=
"EnableDragGridSize" type=
"" overloaded=
"no">
28871 <autodoc>EnableDragGridSize(self, bool enable=True)
</autodoc>
28873 <param name=
"enable" type=
"bool" default=
"True"/>
28876 <method name=
"DisableDragGridSize" type=
"" overloaded=
"no">
28877 <autodoc>DisableDragGridSize(self)
</autodoc>
28879 <method name=
"CanDragGridSize" type=
"bool" overloaded=
"no">
28880 <autodoc>CanDragGridSize(self) -
> bool
</autodoc>
28882 <method name=
"SetAttr" type=
"" overloaded=
"no">
28883 <autodoc>SetAttr(self, int row, int col, GridCellAttr attr)
</autodoc>
28885 <param name=
"row" type=
"int" default=
""/>
28886 <param name=
"col" type=
"int" default=
""/>
28887 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28890 <method name=
"SetRowAttr" type=
"" overloaded=
"no">
28891 <autodoc>SetRowAttr(self, int row, GridCellAttr attr)
</autodoc>
28893 <param name=
"row" type=
"int" default=
""/>
28894 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28897 <method name=
"SetColAttr" type=
"" overloaded=
"no">
28898 <autodoc>SetColAttr(self, int col, GridCellAttr attr)
</autodoc>
28900 <param name=
"col" type=
"int" default=
""/>
28901 <param name=
"attr" type=
"GridCellAttr" default=
""/>
28904 <method name=
"SetColFormatBool" type=
"" overloaded=
"no">
28905 <autodoc>SetColFormatBool(self, int col)
</autodoc>
28907 <param name=
"col" type=
"int" default=
""/>
28910 <method name=
"SetColFormatNumber" type=
"" overloaded=
"no">
28911 <autodoc>SetColFormatNumber(self, int col)
</autodoc>
28913 <param name=
"col" type=
"int" default=
""/>
28916 <method name=
"SetColFormatFloat" type=
"" overloaded=
"no">
28917 <autodoc>SetColFormatFloat(self, int col, int width=-
1, int precision=-
1)
</autodoc>
28919 <param name=
"col" type=
"int" default=
""/>
28920 <param name=
"width" type=
"int" default=
"-1"/>
28921 <param name=
"precision" type=
"int" default=
"-1"/>
28924 <method name=
"SetColFormatCustom" type=
"" overloaded=
"no">
28925 <autodoc>SetColFormatCustom(self, int col, String typeName)
</autodoc>
28927 <param name=
"col" type=
"int" default=
""/>
28928 <param name=
"typeName" type=
"String" default=
""/>
28931 <method name=
"EnableGridLines" type=
"" overloaded=
"no">
28932 <autodoc>EnableGridLines(self, bool enable=True)
</autodoc>
28934 <param name=
"enable" type=
"bool" default=
"True"/>
28937 <method name=
"GridLinesEnabled" type=
"bool" overloaded=
"no">
28938 <autodoc>GridLinesEnabled(self) -
> bool
</autodoc>
28940 <method name=
"GetDefaultRowSize" type=
"int" overloaded=
"no">
28941 <autodoc>GetDefaultRowSize(self) -
> int
</autodoc>
28943 <method name=
"GetRowSize" type=
"int" overloaded=
"no">
28944 <autodoc>GetRowSize(self, int row) -
> int
</autodoc>
28946 <param name=
"row" type=
"int" default=
""/>
28949 <method name=
"GetDefaultColSize" type=
"int" overloaded=
"no">
28950 <autodoc>GetDefaultColSize(self) -
> int
</autodoc>
28952 <method name=
"GetColSize" type=
"int" overloaded=
"no">
28953 <autodoc>GetColSize(self, int col) -
> int
</autodoc>
28955 <param name=
"col" type=
"int" default=
""/>
28958 <method name=
"GetDefaultCellBackgroundColour" type=
"Colour" overloaded=
"no">
28959 <autodoc>GetDefaultCellBackgroundColour(self) -
> Colour
</autodoc>
28961 <method name=
"GetCellBackgroundColour" type=
"Colour" overloaded=
"no">
28962 <autodoc>GetCellBackgroundColour(self, int row, int col) -
> Colour
</autodoc>
28964 <param name=
"row" type=
"int" default=
""/>
28965 <param name=
"col" type=
"int" default=
""/>
28968 <method name=
"GetDefaultCellTextColour" type=
"Colour" overloaded=
"no">
28969 <autodoc>GetDefaultCellTextColour(self) -
> Colour
</autodoc>
28971 <method name=
"GetCellTextColour" type=
"Colour" overloaded=
"no">
28972 <autodoc>GetCellTextColour(self, int row, int col) -
> Colour
</autodoc>
28974 <param name=
"row" type=
"int" default=
""/>
28975 <param name=
"col" type=
"int" default=
""/>
28978 <method name=
"GetDefaultCellFont" type=
"Font" overloaded=
"no">
28979 <autodoc>GetDefaultCellFont(self) -
> Font
</autodoc>
28981 <method name=
"GetCellFont" type=
"Font" overloaded=
"no">
28982 <autodoc>GetCellFont(self, int row, int col) -
> Font
</autodoc>
28984 <param name=
"row" type=
"int" default=
""/>
28985 <param name=
"col" type=
"int" default=
""/>
28988 <method name=
"GetDefaultCellAlignment" type=
"" overloaded=
"no">
28989 <autodoc>GetDefaultCellAlignment() -
> (horiz, vert)
</autodoc>
28991 <param name=
"OUTPUT" type=
"int" default=
""/>
28992 <param name=
"OUTPUT" type=
"int" default=
""/>
28995 <method name=
"GetCellAlignment" type=
"" overloaded=
"no">
28996 <autodoc>GetCellAlignment() -
> (horiz, vert)
</autodoc>
28998 <param name=
"row" type=
"int" default=
""/>
28999 <param name=
"col" type=
"int" default=
""/>
29000 <param name=
"OUTPUT" type=
"int" default=
""/>
29001 <param name=
"OUTPUT" type=
"int" default=
""/>
29004 <method name=
"GetDefaultCellOverflow" type=
"bool" overloaded=
"no">
29005 <autodoc>GetDefaultCellOverflow(self) -
> bool
</autodoc>
29007 <method name=
"GetCellOverflow" type=
"bool" overloaded=
"no">
29008 <autodoc>GetCellOverflow(self, int row, int col) -
> bool
</autodoc>
29010 <param name=
"row" type=
"int" default=
""/>
29011 <param name=
"col" type=
"int" default=
""/>
29014 <method name=
"GetCellSize" type=
"" overloaded=
"no">
29015 <autodoc>GetCellSize(int row, int col) -
> (num_rows, num_cols)
</autodoc>
29017 <param name=
"row" type=
"int" default=
""/>
29018 <param name=
"col" type=
"int" default=
""/>
29019 <param name=
"OUTPUT" type=
"int" default=
""/>
29020 <param name=
"OUTPUT" type=
"int" default=
""/>
29023 <method name=
"SetDefaultRowSize" type=
"" overloaded=
"no">
29024 <autodoc>SetDefaultRowSize(self, int height, bool resizeExistingRows=False)
</autodoc>
29026 <param name=
"height" type=
"int" default=
""/>
29027 <param name=
"resizeExistingRows" type=
"bool" default=
"False"/>
29030 <method name=
"SetRowSize" type=
"" overloaded=
"no">
29031 <autodoc>SetRowSize(self, int row, int height)
</autodoc>
29033 <param name=
"row" type=
"int" default=
""/>
29034 <param name=
"height" type=
"int" default=
""/>
29037 <method name=
"SetDefaultColSize" type=
"" overloaded=
"no">
29038 <autodoc>SetDefaultColSize(self, int width, bool resizeExistingCols=False)
</autodoc>
29040 <param name=
"width" type=
"int" default=
""/>
29041 <param name=
"resizeExistingCols" type=
"bool" default=
"False"/>
29044 <method name=
"SetColSize" type=
"" overloaded=
"no">
29045 <autodoc>SetColSize(self, int col, int width)
</autodoc>
29047 <param name=
"col" type=
"int" default=
""/>
29048 <param name=
"width" type=
"int" default=
""/>
29051 <method name=
"AutoSizeColumn" type=
"" overloaded=
"no">
29052 <autodoc>AutoSizeColumn(self, int col, bool setAsMin=True)
</autodoc>
29054 <param name=
"col" type=
"int" default=
""/>
29055 <param name=
"setAsMin" type=
"bool" default=
"True"/>
29058 <method name=
"AutoSizeRow" type=
"" overloaded=
"no">
29059 <autodoc>AutoSizeRow(self, int row, bool setAsMin=True)
</autodoc>
29061 <param name=
"row" type=
"int" default=
""/>
29062 <param name=
"setAsMin" type=
"bool" default=
"True"/>
29065 <method name=
"AutoSizeColumns" type=
"" overloaded=
"no">
29066 <autodoc>AutoSizeColumns(self, bool setAsMin=True)
</autodoc>
29068 <param name=
"setAsMin" type=
"bool" default=
"True"/>
29071 <method name=
"AutoSizeRows" type=
"" overloaded=
"no">
29072 <autodoc>AutoSizeRows(self, bool setAsMin=True)
</autodoc>
29074 <param name=
"setAsMin" type=
"bool" default=
"True"/>
29077 <method name=
"AutoSize" type=
"" overloaded=
"no">
29078 <autodoc>AutoSize(self)
</autodoc>
29080 <method name=
"AutoSizeRowLabelSize" type=
"" overloaded=
"no">
29081 <autodoc>AutoSizeRowLabelSize(self, int row)
</autodoc>
29083 <param name=
"row" type=
"int" default=
""/>
29086 <method name=
"AutoSizeColLabelSize" type=
"" overloaded=
"no">
29087 <autodoc>AutoSizeColLabelSize(self, int col)
</autodoc>
29089 <param name=
"col" type=
"int" default=
""/>
29092 <method name=
"SetColMinimalWidth" type=
"" overloaded=
"no">
29093 <autodoc>SetColMinimalWidth(self, int col, int width)
</autodoc>
29095 <param name=
"col" type=
"int" default=
""/>
29096 <param name=
"width" type=
"int" default=
""/>
29099 <method name=
"SetRowMinimalHeight" type=
"" overloaded=
"no">
29100 <autodoc>SetRowMinimalHeight(self, int row, int width)
</autodoc>
29102 <param name=
"row" type=
"int" default=
""/>
29103 <param name=
"width" type=
"int" default=
""/>
29106 <method name=
"SetColMinimalAcceptableWidth" type=
"" overloaded=
"no">
29107 <autodoc>SetColMinimalAcceptableWidth(self, int width)
</autodoc>
29109 <param name=
"width" type=
"int" default=
""/>
29112 <method name=
"SetRowMinimalAcceptableHeight" type=
"" overloaded=
"no">
29113 <autodoc>SetRowMinimalAcceptableHeight(self, int width)
</autodoc>
29115 <param name=
"width" type=
"int" default=
""/>
29118 <method name=
"GetColMinimalAcceptableWidth" type=
"int" overloaded=
"no">
29119 <autodoc>GetColMinimalAcceptableWidth(self) -
> int
</autodoc>
29121 <method name=
"GetRowMinimalAcceptableHeight" type=
"int" overloaded=
"no">
29122 <autodoc>GetRowMinimalAcceptableHeight(self) -
> int
</autodoc>
29124 <method name=
"SetDefaultCellBackgroundColour" type=
"" overloaded=
"no">
29125 <autodoc>SetDefaultCellBackgroundColour(self, Colour ??)
</autodoc>
29127 <param name=
"" type=
"Colour" default=
""/>
29130 <method name=
"SetCellBackgroundColour" type=
"" overloaded=
"no">
29131 <autodoc>SetCellBackgroundColour(self, int row, int col, Colour ??)
</autodoc>
29133 <param name=
"row" type=
"int" default=
""/>
29134 <param name=
"col" type=
"int" default=
""/>
29135 <param name=
"" type=
"Colour" default=
""/>
29138 <method name=
"SetDefaultCellTextColour" type=
"" overloaded=
"no">
29139 <autodoc>SetDefaultCellTextColour(self, Colour ??)
</autodoc>
29141 <param name=
"" type=
"Colour" default=
""/>
29144 <method name=
"SetCellTextColour" type=
"" overloaded=
"no">
29145 <autodoc>SetCellTextColour(self, int row, int col, Colour ??)
</autodoc>
29147 <param name=
"row" type=
"int" default=
""/>
29148 <param name=
"col" type=
"int" default=
""/>
29149 <param name=
"" type=
"Colour" default=
""/>
29152 <method name=
"SetDefaultCellFont" type=
"" overloaded=
"no">
29153 <autodoc>SetDefaultCellFont(self, Font ??)
</autodoc>
29155 <param name=
"" type=
"Font" default=
""/>
29158 <method name=
"SetCellFont" type=
"" overloaded=
"no">
29159 <autodoc>SetCellFont(self, int row, int col, Font ??)
</autodoc>
29161 <param name=
"row" type=
"int" default=
""/>
29162 <param name=
"col" type=
"int" default=
""/>
29163 <param name=
"" type=
"Font" default=
""/>
29166 <method name=
"SetDefaultCellAlignment" type=
"" overloaded=
"no">
29167 <autodoc>SetDefaultCellAlignment(self, int horiz, int vert)
</autodoc>
29169 <param name=
"horiz" type=
"int" default=
""/>
29170 <param name=
"vert" type=
"int" default=
""/>
29173 <method name=
"SetCellAlignment" type=
"" overloaded=
"no">
29174 <autodoc>SetCellAlignment(self, int row, int col, int horiz, int vert)
</autodoc>
29176 <param name=
"row" type=
"int" default=
""/>
29177 <param name=
"col" type=
"int" default=
""/>
29178 <param name=
"horiz" type=
"int" default=
""/>
29179 <param name=
"vert" type=
"int" default=
""/>
29182 <method name=
"SetDefaultCellOverflow" type=
"" overloaded=
"no">
29183 <autodoc>SetDefaultCellOverflow(self, bool allow)
</autodoc>
29185 <param name=
"allow" type=
"bool" default=
""/>
29188 <method name=
"SetCellOverflow" type=
"" overloaded=
"no">
29189 <autodoc>SetCellOverflow(self, int row, int col, bool allow)
</autodoc>
29191 <param name=
"row" type=
"int" default=
""/>
29192 <param name=
"col" type=
"int" default=
""/>
29193 <param name=
"allow" type=
"bool" default=
""/>
29196 <method name=
"SetCellSize" type=
"" overloaded=
"no">
29197 <autodoc>SetCellSize(self, int row, int col, int num_rows, int num_cols)
</autodoc>
29199 <param name=
"row" type=
"int" default=
""/>
29200 <param name=
"col" type=
"int" default=
""/>
29201 <param name=
"num_rows" type=
"int" default=
""/>
29202 <param name=
"num_cols" type=
"int" default=
""/>
29205 <method name=
"SetDefaultRenderer" type=
"" overloaded=
"no">
29206 <autodoc>SetDefaultRenderer(self, GridCellRenderer renderer)
</autodoc>
29208 <param name=
"renderer" type=
"GridCellRenderer" default=
""/>
29211 <method name=
"SetCellRenderer" type=
"" overloaded=
"no">
29212 <autodoc>SetCellRenderer(self, int row, int col, GridCellRenderer renderer)
</autodoc>
29214 <param name=
"row" type=
"int" default=
""/>
29215 <param name=
"col" type=
"int" default=
""/>
29216 <param name=
"renderer" type=
"GridCellRenderer" default=
""/>
29219 <method name=
"GetDefaultRenderer" type=
"GridCellRenderer" overloaded=
"no">
29220 <autodoc>GetDefaultRenderer(self) -
> GridCellRenderer
</autodoc>
29222 <method name=
"GetCellRenderer" type=
"GridCellRenderer" overloaded=
"no">
29223 <autodoc>GetCellRenderer(self, int row, int col) -
> GridCellRenderer
</autodoc>
29225 <param name=
"row" type=
"int" default=
""/>
29226 <param name=
"col" type=
"int" default=
""/>
29229 <method name=
"SetDefaultEditor" type=
"" overloaded=
"no">
29230 <autodoc>SetDefaultEditor(self, GridCellEditor editor)
</autodoc>
29232 <param name=
"editor" type=
"GridCellEditor" default=
""/>
29235 <method name=
"SetCellEditor" type=
"" overloaded=
"no">
29236 <autodoc>SetCellEditor(self, int row, int col, GridCellEditor editor)
</autodoc>
29238 <param name=
"row" type=
"int" default=
""/>
29239 <param name=
"col" type=
"int" default=
""/>
29240 <param name=
"editor" type=
"GridCellEditor" default=
""/>
29243 <method name=
"GetDefaultEditor" type=
"GridCellEditor" overloaded=
"no">
29244 <autodoc>GetDefaultEditor(self) -
> GridCellEditor
</autodoc>
29246 <method name=
"GetCellEditor" type=
"GridCellEditor" overloaded=
"no">
29247 <autodoc>GetCellEditor(self, int row, int col) -
> GridCellEditor
</autodoc>
29249 <param name=
"row" type=
"int" default=
""/>
29250 <param name=
"col" type=
"int" default=
""/>
29253 <method name=
"GetCellValue" type=
"String" overloaded=
"no">
29254 <autodoc>GetCellValue(self, int row, int col) -
> String
</autodoc>
29256 <param name=
"row" type=
"int" default=
""/>
29257 <param name=
"col" type=
"int" default=
""/>
29260 <method name=
"SetCellValue" type=
"" overloaded=
"no">
29261 <autodoc>SetCellValue(self, int row, int col, String s)
</autodoc>
29263 <param name=
"row" type=
"int" default=
""/>
29264 <param name=
"col" type=
"int" default=
""/>
29265 <param name=
"s" type=
"String" default=
""/>
29268 <method name=
"IsReadOnly" type=
"bool" overloaded=
"no">
29269 <autodoc>IsReadOnly(self, int row, int col) -
> bool
</autodoc>
29271 <param name=
"row" type=
"int" default=
""/>
29272 <param name=
"col" type=
"int" default=
""/>
29275 <method name=
"SetReadOnly" type=
"" overloaded=
"no">
29276 <autodoc>SetReadOnly(self, int row, int col, bool isReadOnly=True)
</autodoc>
29278 <param name=
"row" type=
"int" default=
""/>
29279 <param name=
"col" type=
"int" default=
""/>
29280 <param name=
"isReadOnly" type=
"bool" default=
"True"/>
29283 <method name=
"SelectRow" type=
"" overloaded=
"no">
29284 <autodoc>SelectRow(self, int row, bool addToSelected=False)
</autodoc>
29286 <param name=
"row" type=
"int" default=
""/>
29287 <param name=
"addToSelected" type=
"bool" default=
"False"/>
29290 <method name=
"SelectCol" type=
"" overloaded=
"no">
29291 <autodoc>SelectCol(self, int col, bool addToSelected=False)
</autodoc>
29293 <param name=
"col" type=
"int" default=
""/>
29294 <param name=
"addToSelected" type=
"bool" default=
"False"/>
29297 <method name=
"SelectBlock" type=
"" overloaded=
"no">
29298 <autodoc>SelectBlock(self, int topRow, int leftCol, int bottomRow, int rightCol,
29299 bool addToSelected=False)
</autodoc>
29301 <param name=
"topRow" type=
"int" default=
""/>
29302 <param name=
"leftCol" type=
"int" default=
""/>
29303 <param name=
"bottomRow" type=
"int" default=
""/>
29304 <param name=
"rightCol" type=
"int" default=
""/>
29305 <param name=
"addToSelected" type=
"bool" default=
"False"/>
29308 <method name=
"SelectAll" type=
"" overloaded=
"no">
29309 <autodoc>SelectAll(self)
</autodoc>
29311 <method name=
"IsSelection" type=
"bool" overloaded=
"no">
29312 <autodoc>IsSelection(self) -
> bool
</autodoc>
29314 <method name=
"ClearSelection" type=
"" overloaded=
"no">
29315 <autodoc>ClearSelection(self)
</autodoc>
29317 <method name=
"IsInSelection" type=
"bool" overloaded=
"no">
29318 <autodoc>IsInSelection(self, int row, int col) -
> bool
</autodoc>
29320 <param name=
"row" type=
"int" default=
""/>
29321 <param name=
"col" type=
"int" default=
""/>
29324 <method name=
"GetSelectedCells" type=
"wxGridCellCoordsArray" overloaded=
"no">
29325 <autodoc>GetSelectedCells(self) -
> wxGridCellCoordsArray
</autodoc>
29327 <method name=
"GetSelectionBlockTopLeft" type=
"wxGridCellCoordsArray" overloaded=
"no">
29328 <autodoc>GetSelectionBlockTopLeft(self) -
> wxGridCellCoordsArray
</autodoc>
29330 <method name=
"GetSelectionBlockBottomRight" type=
"wxGridCellCoordsArray" overloaded=
"no">
29331 <autodoc>GetSelectionBlockBottomRight(self) -
> wxGridCellCoordsArray
</autodoc>
29333 <method name=
"GetSelectedRows" type=
"wxArrayInt" overloaded=
"no">
29334 <autodoc>GetSelectedRows(self) -
> wxArrayInt
</autodoc>
29336 <method name=
"GetSelectedCols" type=
"wxArrayInt" overloaded=
"no">
29337 <autodoc>GetSelectedCols(self) -
> wxArrayInt
</autodoc>
29339 <method name=
"DeselectRow" type=
"" overloaded=
"no">
29340 <autodoc>DeselectRow(self, int row)
</autodoc>
29342 <param name=
"row" type=
"int" default=
""/>
29345 <method name=
"DeselectCol" type=
"" overloaded=
"no">
29346 <autodoc>DeselectCol(self, int col)
</autodoc>
29348 <param name=
"col" type=
"int" default=
""/>
29351 <method name=
"DeselectCell" type=
"" overloaded=
"no">
29352 <autodoc>DeselectCell(self, int row, int col)
</autodoc>
29354 <param name=
"row" type=
"int" default=
""/>
29355 <param name=
"col" type=
"int" default=
""/>
29358 <method name=
"BlockToDeviceRect" type=
"Rect" overloaded=
"no">
29359 <autodoc>BlockToDeviceRect(self, GridCellCoords topLeft, GridCellCoords bottomRight) -
> Rect
</autodoc>
29361 <param name=
"topLeft" type=
"GridCellCoords" default=
""/>
29362 <param name=
"bottomRight" type=
"GridCellCoords" default=
""/>
29365 <method name=
"GetSelectionBackground" type=
"Colour" overloaded=
"no">
29366 <autodoc>GetSelectionBackground(self) -
> Colour
</autodoc>
29368 <method name=
"GetSelectionForeground" type=
"Colour" overloaded=
"no">
29369 <autodoc>GetSelectionForeground(self) -
> Colour
</autodoc>
29371 <method name=
"SetSelectionBackground" type=
"" overloaded=
"no">
29372 <autodoc>SetSelectionBackground(self, Colour c)
</autodoc>
29374 <param name=
"c" type=
"Colour" default=
""/>
29377 <method name=
"SetSelectionForeground" type=
"" overloaded=
"no">
29378 <autodoc>SetSelectionForeground(self, Colour c)
</autodoc>
29380 <param name=
"c" type=
"Colour" default=
""/>
29383 <method name=
"RegisterDataType" type=
"" overloaded=
"no">
29384 <autodoc>RegisterDataType(self, String typeName, GridCellRenderer renderer, GridCellEditor editor)
</autodoc>
29386 <param name=
"typeName" type=
"String" default=
""/>
29387 <param name=
"renderer" type=
"GridCellRenderer" default=
""/>
29388 <param name=
"editor" type=
"GridCellEditor" default=
""/>
29391 <method name=
"GetDefaultEditorForCell" type=
"GridCellEditor" overloaded=
"no">
29392 <autodoc>GetDefaultEditorForCell(self, int row, int col) -
> GridCellEditor
</autodoc>
29394 <param name=
"row" type=
"int" default=
""/>
29395 <param name=
"col" type=
"int" default=
""/>
29398 <method name=
"GetDefaultRendererForCell" type=
"GridCellRenderer" overloaded=
"no">
29399 <autodoc>GetDefaultRendererForCell(self, int row, int col) -
> GridCellRenderer
</autodoc>
29401 <param name=
"row" type=
"int" default=
""/>
29402 <param name=
"col" type=
"int" default=
""/>
29405 <method name=
"GetDefaultEditorForType" type=
"GridCellEditor" overloaded=
"no">
29406 <autodoc>GetDefaultEditorForType(self, String typeName) -
> GridCellEditor
</autodoc>
29408 <param name=
"typeName" type=
"String" default=
""/>
29411 <method name=
"GetDefaultRendererForType" type=
"GridCellRenderer" overloaded=
"no">
29412 <autodoc>GetDefaultRendererForType(self, String typeName) -
> GridCellRenderer
</autodoc>
29414 <param name=
"typeName" type=
"String" default=
""/>
29417 <method name=
"SetMargins" type=
"" overloaded=
"no">
29418 <autodoc>SetMargins(self, int extraWidth, int extraHeight)
</autodoc>
29420 <param name=
"extraWidth" type=
"int" default=
""/>
29421 <param name=
"extraHeight" type=
"int" default=
""/>
29424 <method name=
"GetGridWindow" type=
"Window" overloaded=
"no">
29425 <autodoc>GetGridWindow(self) -
> Window
</autodoc>
29427 <method name=
"GetGridRowLabelWindow" type=
"Window" overloaded=
"no">
29428 <autodoc>GetGridRowLabelWindow(self) -
> Window
</autodoc>
29430 <method name=
"GetGridColLabelWindow" type=
"Window" overloaded=
"no">
29431 <autodoc>GetGridColLabelWindow(self) -
> Window
</autodoc>
29433 <method name=
"GetGridCornerLabelWindow" type=
"Window" overloaded=
"no">
29434 <autodoc>GetGridCornerLabelWindow(self) -
> Window
</autodoc>
29436 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
29437 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
29438 <docstring>Get the default attributes for this class. This is useful if you want
29439 to use the same font or colour in your own control as in a standard
29440 control -- which is a much better idea than hard coding specific
29441 colours or fonts which might look completely out of place on the
29442 user's system, especially if it uses themes.
29444 The variant parameter is only relevant under Mac currently and is
29445 ignore under other platforms. Under Mac, it will change the size of
29446 the returned font. See `wx.Window.SetWindowVariant` for more about
29449 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
29453 <class name=
"GridEvent" oldname=
"wxGridEvent" module=
"grid">
29454 <baseclass name=
"NotifyEvent"/>
29455 <constructor name=
"GridEvent" overloaded=
"no">
29456 <autodoc>__init__(self, int id, wxEventType type, Grid obj, int row=-
1, int col=-
1,
29457 int x=-
1, int y=-
1, bool sel=True, bool control=False,
29458 bool shift=False, bool alt=False,
29459 bool meta=False) -
> GridEvent
</autodoc>
29461 <param name=
"id" type=
"int" default=
""/>
29462 <param name=
"type" type=
"wxEventType" default=
""/>
29463 <param name=
"obj" type=
"Grid" default=
""/>
29464 <param name=
"row" type=
"int" default=
"-1"/>
29465 <param name=
"col" type=
"int" default=
"-1"/>
29466 <param name=
"x" type=
"int" default=
"-1"/>
29467 <param name=
"y" type=
"int" default=
"-1"/>
29468 <param name=
"sel" type=
"bool" default=
"True"/>
29469 <param name=
"control" type=
"bool" default=
"False"/>
29470 <param name=
"shift" type=
"bool" default=
"False"/>
29471 <param name=
"alt" type=
"bool" default=
"False"/>
29472 <param name=
"meta" type=
"bool" default=
"False"/>
29475 <method name=
"GetRow" type=
"int" overloaded=
"no">
29476 <autodoc>GetRow(self) -
> int
</autodoc>
29478 <method name=
"GetCol" type=
"int" overloaded=
"no">
29479 <autodoc>GetCol(self) -
> int
</autodoc>
29481 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
29482 <autodoc>GetPosition(self) -
> Point
</autodoc>
29484 <method name=
"Selecting" type=
"bool" overloaded=
"no">
29485 <autodoc>Selecting(self) -
> bool
</autodoc>
29487 <method name=
"ControlDown" type=
"bool" overloaded=
"no">
29488 <autodoc>ControlDown(self) -
> bool
</autodoc>
29490 <method name=
"MetaDown" type=
"bool" overloaded=
"no">
29491 <autodoc>MetaDown(self) -
> bool
</autodoc>
29493 <method name=
"ShiftDown" type=
"bool" overloaded=
"no">
29494 <autodoc>ShiftDown(self) -
> bool
</autodoc>
29496 <method name=
"AltDown" type=
"bool" overloaded=
"no">
29497 <autodoc>AltDown(self) -
> bool
</autodoc>
29500 <class name=
"GridSizeEvent" oldname=
"wxGridSizeEvent" module=
"grid">
29501 <baseclass name=
"NotifyEvent"/>
29502 <constructor name=
"GridSizeEvent" overloaded=
"no">
29503 <autodoc>__init__(self, int id, wxEventType type, Grid obj, int rowOrCol=-
1,
29504 int x=-
1, int y=-
1, bool control=False, bool shift=False,
29505 bool alt=False, bool meta=False) -
> GridSizeEvent
</autodoc>
29507 <param name=
"id" type=
"int" default=
""/>
29508 <param name=
"type" type=
"wxEventType" default=
""/>
29509 <param name=
"obj" type=
"Grid" default=
""/>
29510 <param name=
"rowOrCol" type=
"int" default=
"-1"/>
29511 <param name=
"x" type=
"int" default=
"-1"/>
29512 <param name=
"y" type=
"int" default=
"-1"/>
29513 <param name=
"control" type=
"bool" default=
"False"/>
29514 <param name=
"shift" type=
"bool" default=
"False"/>
29515 <param name=
"alt" type=
"bool" default=
"False"/>
29516 <param name=
"meta" type=
"bool" default=
"False"/>
29519 <method name=
"GetRowOrCol" type=
"int" overloaded=
"no">
29520 <autodoc>GetRowOrCol(self) -
> int
</autodoc>
29522 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
29523 <autodoc>GetPosition(self) -
> Point
</autodoc>
29525 <method name=
"ControlDown" type=
"bool" overloaded=
"no">
29526 <autodoc>ControlDown(self) -
> bool
</autodoc>
29528 <method name=
"MetaDown" type=
"bool" overloaded=
"no">
29529 <autodoc>MetaDown(self) -
> bool
</autodoc>
29531 <method name=
"ShiftDown" type=
"bool" overloaded=
"no">
29532 <autodoc>ShiftDown(self) -
> bool
</autodoc>
29534 <method name=
"AltDown" type=
"bool" overloaded=
"no">
29535 <autodoc>AltDown(self) -
> bool
</autodoc>
29538 <class name=
"GridRangeSelectEvent" oldname=
"wxGridRangeSelectEvent" module=
"grid">
29539 <baseclass name=
"NotifyEvent"/>
29540 <constructor name=
"GridRangeSelectEvent" overloaded=
"no">
29541 <autodoc>__init__(self, int id, wxEventType type, Grid obj, GridCellCoords topLeft,
29542 GridCellCoords bottomRight, bool sel=True,
29543 bool control=False, bool shift=False,
29544 bool alt=False, bool meta=False) -
> GridRangeSelectEvent
</autodoc>
29546 <param name=
"id" type=
"int" default=
""/>
29547 <param name=
"type" type=
"wxEventType" default=
""/>
29548 <param name=
"obj" type=
"Grid" default=
""/>
29549 <param name=
"topLeft" type=
"GridCellCoords" default=
""/>
29550 <param name=
"bottomRight" type=
"GridCellCoords" default=
""/>
29551 <param name=
"sel" type=
"bool" default=
"True"/>
29552 <param name=
"control" type=
"bool" default=
"False"/>
29553 <param name=
"shift" type=
"bool" default=
"False"/>
29554 <param name=
"alt" type=
"bool" default=
"False"/>
29555 <param name=
"meta" type=
"bool" default=
"False"/>
29558 <method name=
"GetTopLeftCoords" type=
"GridCellCoords" overloaded=
"no">
29559 <autodoc>GetTopLeftCoords(self) -
> GridCellCoords
</autodoc>
29561 <method name=
"GetBottomRightCoords" type=
"GridCellCoords" overloaded=
"no">
29562 <autodoc>GetBottomRightCoords(self) -
> GridCellCoords
</autodoc>
29564 <method name=
"GetTopRow" type=
"int" overloaded=
"no">
29565 <autodoc>GetTopRow(self) -
> int
</autodoc>
29567 <method name=
"GetBottomRow" type=
"int" overloaded=
"no">
29568 <autodoc>GetBottomRow(self) -
> int
</autodoc>
29570 <method name=
"GetLeftCol" type=
"int" overloaded=
"no">
29571 <autodoc>GetLeftCol(self) -
> int
</autodoc>
29573 <method name=
"GetRightCol" type=
"int" overloaded=
"no">
29574 <autodoc>GetRightCol(self) -
> int
</autodoc>
29576 <method name=
"Selecting" type=
"bool" overloaded=
"no">
29577 <autodoc>Selecting(self) -
> bool
</autodoc>
29579 <method name=
"ControlDown" type=
"bool" overloaded=
"no">
29580 <autodoc>ControlDown(self) -
> bool
</autodoc>
29582 <method name=
"MetaDown" type=
"bool" overloaded=
"no">
29583 <autodoc>MetaDown(self) -
> bool
</autodoc>
29585 <method name=
"ShiftDown" type=
"bool" overloaded=
"no">
29586 <autodoc>ShiftDown(self) -
> bool
</autodoc>
29588 <method name=
"AltDown" type=
"bool" overloaded=
"no">
29589 <autodoc>AltDown(self) -
> bool
</autodoc>
29592 <class name=
"GridEditorCreatedEvent" oldname=
"wxGridEditorCreatedEvent" module=
"grid">
29593 <baseclass name=
"CommandEvent"/>
29594 <constructor name=
"GridEditorCreatedEvent" overloaded=
"no">
29595 <autodoc>__init__(self, int id, wxEventType type, Object obj, int row, int col,
29596 Control ctrl) -
> GridEditorCreatedEvent
</autodoc>
29598 <param name=
"id" type=
"int" default=
""/>
29599 <param name=
"type" type=
"wxEventType" default=
""/>
29600 <param name=
"obj" type=
"Object" default=
""/>
29601 <param name=
"row" type=
"int" default=
""/>
29602 <param name=
"col" type=
"int" default=
""/>
29603 <param name=
"ctrl" type=
"Control" default=
""/>
29606 <method name=
"GetRow" type=
"int" overloaded=
"no">
29607 <autodoc>GetRow(self) -
> int
</autodoc>
29609 <method name=
"GetCol" type=
"int" overloaded=
"no">
29610 <autodoc>GetCol(self) -
> int
</autodoc>
29612 <method name=
"GetControl" type=
"Control" overloaded=
"no">
29613 <autodoc>GetControl(self) -
> Control
</autodoc>
29615 <method name=
"SetRow" type=
"" overloaded=
"no">
29616 <autodoc>SetRow(self, int row)
</autodoc>
29618 <param name=
"row" type=
"int" default=
""/>
29621 <method name=
"SetCol" type=
"" overloaded=
"no">
29622 <autodoc>SetCol(self, int col)
</autodoc>
29624 <param name=
"col" type=
"int" default=
""/>
29627 <method name=
"SetControl" type=
"" overloaded=
"no">
29628 <autodoc>SetControl(self, Control ctrl)
</autodoc>
29630 <param name=
"ctrl" type=
"Control" default=
""/>
29635 EVT_GRID_CELL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_CLICK )
29636 EVT_GRID_CELL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_CLICK )
29637 EVT_GRID_CELL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_DCLICK )
29638 EVT_GRID_CELL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_DCLICK )
29639 EVT_GRID_LABEL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_CLICK )
29640 EVT_GRID_LABEL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_CLICK )
29641 EVT_GRID_LABEL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_DCLICK )
29642 EVT_GRID_LABEL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_DCLICK )
29643 EVT_GRID_ROW_SIZE = wx.PyEventBinder( wxEVT_GRID_ROW_SIZE )
29644 EVT_GRID_COL_SIZE = wx.PyEventBinder( wxEVT_GRID_COL_SIZE )
29645 EVT_GRID_RANGE_SELECT = wx.PyEventBinder( wxEVT_GRID_RANGE_SELECT )
29646 EVT_GRID_CELL_CHANGE = wx.PyEventBinder( wxEVT_GRID_CELL_CHANGE )
29647 EVT_GRID_SELECT_CELL = wx.PyEventBinder( wxEVT_GRID_SELECT_CELL )
29648 EVT_GRID_EDITOR_SHOWN = wx.PyEventBinder( wxEVT_GRID_EDITOR_SHOWN )
29649 EVT_GRID_EDITOR_HIDDEN = wx.PyEventBinder( wxEVT_GRID_EDITOR_HIDDEN )
29650 EVT_GRID_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED )
29653 # The same as above but with the ability to specify an identifier
29654 EVT_GRID_CMD_CELL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_CLICK,
1 )
29655 EVT_GRID_CMD_CELL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_CLICK,
1 )
29656 EVT_GRID_CMD_CELL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_LEFT_DCLICK,
1 )
29657 EVT_GRID_CMD_CELL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_CELL_RIGHT_DCLICK,
1 )
29658 EVT_GRID_CMD_LABEL_LEFT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_CLICK,
1 )
29659 EVT_GRID_CMD_LABEL_RIGHT_CLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_CLICK,
1 )
29660 EVT_GRID_CMD_LABEL_LEFT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_LEFT_DCLICK,
1 )
29661 EVT_GRID_CMD_LABEL_RIGHT_DCLICK = wx.PyEventBinder( wxEVT_GRID_LABEL_RIGHT_DCLICK,
1 )
29662 EVT_GRID_CMD_ROW_SIZE = wx.PyEventBinder( wxEVT_GRID_ROW_SIZE,
1 )
29663 EVT_GRID_CMD_COL_SIZE = wx.PyEventBinder( wxEVT_GRID_COL_SIZE,
1 )
29664 EVT_GRID_CMD_RANGE_SELECT = wx.PyEventBinder( wxEVT_GRID_RANGE_SELECT,
1 )
29665 EVT_GRID_CMD_CELL_CHANGE = wx.PyEventBinder( wxEVT_GRID_CELL_CHANGE,
1 )
29666 EVT_GRID_CMD_SELECT_CELL = wx.PyEventBinder( wxEVT_GRID_SELECT_CELL,
1 )
29667 EVT_GRID_CMD_EDITOR_SHOWN = wx.PyEventBinder( wxEVT_GRID_EDITOR_SHOWN,
1 )
29668 EVT_GRID_CMD_EDITOR_HIDDEN = wx.PyEventBinder( wxEVT_GRID_EDITOR_HIDDEN,
1 )
29669 EVT_GRID_CMD_EDITOR_CREATED = wx.PyEventBinder( wxEVT_GRID_EDITOR_CREATED,
1 )
29672 <module name=
"html">
29673 <import name=
"_windows"/>
29674 <pythoncode> wx = _core
</pythoncode>
29675 <pythoncode> __docfilter__ = wx.__DocFilter(globals())
</pythoncode>
29677 #---------------------------------------------------------------------------
29679 <class name=
"HtmlLinkInfo" oldname=
"wxHtmlLinkInfo" module=
"html">
29680 <baseclass name=
"Object"/>
29681 <constructor name=
"HtmlLinkInfo" overloaded=
"no">
29682 <autodoc>__init__(self, String href, String target=EmptyString) -
> HtmlLinkInfo
</autodoc>
29684 <param name=
"href" type=
"String" default=
""/>
29685 <param name=
"target" type=
"String" default=
"wxPyEmptyString"/>
29688 <method name=
"GetHref" type=
"String" overloaded=
"no">
29689 <autodoc>GetHref(self) -
> String
</autodoc>
29691 <method name=
"GetTarget" type=
"String" overloaded=
"no">
29692 <autodoc>GetTarget(self) -
> String
</autodoc>
29694 <method name=
"GetEvent" type=
"MouseEvent" overloaded=
"no">
29695 <autodoc>GetEvent(self) -
> MouseEvent
</autodoc>
29697 <method name=
"GetHtmlCell" type=
"wxHtmlCell" overloaded=
"no">
29698 <autodoc>GetHtmlCell(self) -
> HtmlCell
</autodoc>
29700 <method name=
"SetEvent" type=
"" overloaded=
"no">
29701 <autodoc>SetEvent(self, MouseEvent e)
</autodoc>
29703 <param name=
"e" type=
"MouseEvent" default=
""/>
29706 <method name=
"SetHtmlCell" type=
"" overloaded=
"no">
29707 <autodoc>SetHtmlCell(self, HtmlCell e)
</autodoc>
29709 <param name=
"e" type=
"wxHtmlCell" default=
""/>
29713 <class name=
"HtmlTag" oldname=
"wxHtmlTag" module=
"html">
29714 <baseclass name=
"Object"/>
29715 <method name=
"GetName" type=
"String" overloaded=
"no">
29716 <autodoc>GetName(self) -
> String
</autodoc>
29718 <method name=
"HasParam" type=
"bool" overloaded=
"no">
29719 <autodoc>HasParam(self, String par) -
> bool
</autodoc>
29721 <param name=
"par" type=
"String" default=
""/>
29724 <method name=
"GetParam" type=
"String" overloaded=
"no">
29725 <autodoc>GetParam(self, String par, int with_commas=False) -
> String
</autodoc>
29727 <param name=
"par" type=
"String" default=
""/>
29728 <param name=
"with_commas" type=
"int" default=
"False"/>
29731 <method name=
"GetAllParams" type=
"String" overloaded=
"no">
29732 <autodoc>GetAllParams(self) -
> String
</autodoc>
29734 <method name=
"HasEnding" type=
"bool" overloaded=
"no">
29735 <autodoc>HasEnding(self) -
> bool
</autodoc>
29737 <method name=
"GetBeginPos" type=
"int" overloaded=
"no">
29738 <autodoc>GetBeginPos(self) -
> int
</autodoc>
29740 <method name=
"GetEndPos1" type=
"int" overloaded=
"no">
29741 <autodoc>GetEndPos1(self) -
> int
</autodoc>
29743 <method name=
"GetEndPos2" type=
"int" overloaded=
"no">
29744 <autodoc>GetEndPos2(self) -
> int
</autodoc>
29747 <class name=
"HtmlParser" oldname=
"wxHtmlParser" module=
"html">
29748 <baseclass name=
"Object"/>
29749 <method name=
"SetFS" type=
"" overloaded=
"no">
29750 <autodoc>SetFS(self, FileSystem fs)
</autodoc>
29752 <param name=
"fs" type=
"FileSystem" default=
""/>
29755 <method name=
"GetFS" type=
"FileSystem" overloaded=
"no">
29756 <autodoc>GetFS(self) -
> FileSystem
</autodoc>
29758 <method name=
"Parse" type=
"Object" overloaded=
"no">
29759 <autodoc>Parse(self, String source) -
> Object
</autodoc>
29761 <param name=
"source" type=
"String" default=
""/>
29764 <method name=
"InitParser" type=
"" overloaded=
"no">
29765 <autodoc>InitParser(self, String source)
</autodoc>
29767 <param name=
"source" type=
"String" default=
""/>
29770 <method name=
"DoneParser" type=
"" overloaded=
"no">
29771 <autodoc>DoneParser(self)
</autodoc>
29773 <method name=
"DoParsing" type=
"" overloaded=
"no">
29774 <autodoc>DoParsing(self, int begin_pos, int end_pos)
</autodoc>
29776 <param name=
"begin_pos" type=
"int" default=
""/>
29777 <param name=
"end_pos" type=
"int" default=
""/>
29780 <method name=
"StopParsing" type=
"" overloaded=
"no">
29781 <autodoc>StopParsing(self)
</autodoc>
29783 <method name=
"AddTagHandler" type=
"" overloaded=
"no">
29784 <autodoc>AddTagHandler(self, HtmlTagHandler handler)
</autodoc>
29786 <param name=
"handler" type=
"wxHtmlTagHandler" default=
""/>
29789 <method name=
"GetSource" type=
"String" overloaded=
"no">
29790 <autodoc>GetSource(self) -
> String
</autodoc>
29792 <method name=
"PushTagHandler" type=
"" overloaded=
"no">
29793 <autodoc>PushTagHandler(self, HtmlTagHandler handler, String tags)
</autodoc>
29795 <param name=
"handler" type=
"wxHtmlTagHandler" default=
""/>
29796 <param name=
"tags" type=
"String" default=
""/>
29799 <method name=
"PopTagHandler" type=
"" overloaded=
"no">
29800 <autodoc>PopTagHandler(self)
</autodoc>
29803 <class name=
"HtmlWinParser" oldname=
"wxHtmlWinParser" module=
"html">
29804 <baseclass name=
"HtmlParser"/>
29805 <constructor name=
"HtmlWinParser" overloaded=
"no">
29806 <autodoc>__init__(self, HtmlWindow wnd=None) -
> HtmlWinParser
</autodoc>
29808 <param name=
"wnd" type=
"wxPyHtmlWindow" default=
"NULL"/>
29811 <method name=
"SetDC" type=
"" overloaded=
"no">
29812 <autodoc>SetDC(self, DC dc)
</autodoc>
29814 <param name=
"dc" type=
"DC" default=
""/>
29817 <method name=
"GetDC" type=
"DC" overloaded=
"no">
29818 <autodoc>GetDC(self) -
> DC
</autodoc>
29820 <method name=
"GetCharHeight" type=
"int" overloaded=
"no">
29821 <autodoc>GetCharHeight(self) -
> int
</autodoc>
29823 <method name=
"GetCharWidth" type=
"int" overloaded=
"no">
29824 <autodoc>GetCharWidth(self) -
> int
</autodoc>
29826 <method name=
"GetWindow" type=
"wxPyHtmlWindow" overloaded=
"no">
29827 <autodoc>GetWindow(self) -
> HtmlWindow
</autodoc>
29829 <method name=
"SetFonts" type=
"" overloaded=
"no">
29830 <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)
</autodoc>
29832 <param name=
"normal_face" type=
"String" default=
""/>
29833 <param name=
"fixed_face" type=
"String" default=
""/>
29834 <param name=
"sizes" type=
"PyObject" default=
"NULL"/>
29837 <method name=
"NormalizeFontSizes" type=
"" overloaded=
"no">
29838 <autodoc>NormalizeFontSizes(self, int size=-
1)
</autodoc>
29840 <param name=
"size" type=
"int" default=
"-1"/>
29843 <method name=
"GetContainer" type=
"wxHtmlContainerCell" overloaded=
"no">
29844 <autodoc>GetContainer(self) -
> HtmlContainerCell
</autodoc>
29846 <method name=
"OpenContainer" type=
"wxHtmlContainerCell" overloaded=
"no">
29847 <autodoc>OpenContainer(self) -
> HtmlContainerCell
</autodoc>
29849 <method name=
"SetContainer" type=
"wxHtmlContainerCell" overloaded=
"no">
29850 <autodoc>SetContainer(self, HtmlContainerCell c) -
> HtmlContainerCell
</autodoc>
29852 <param name=
"c" type=
"wxHtmlContainerCell" default=
""/>
29855 <method name=
"CloseContainer" type=
"wxHtmlContainerCell" overloaded=
"no">
29856 <autodoc>CloseContainer(self) -
> HtmlContainerCell
</autodoc>
29858 <method name=
"GetFontSize" type=
"int" overloaded=
"no">
29859 <autodoc>GetFontSize(self) -
> int
</autodoc>
29861 <method name=
"SetFontSize" type=
"" overloaded=
"no">
29862 <autodoc>SetFontSize(self, int s)
</autodoc>
29864 <param name=
"s" type=
"int" default=
""/>
29867 <method name=
"GetFontBold" type=
"int" overloaded=
"no">
29868 <autodoc>GetFontBold(self) -
> int
</autodoc>
29870 <method name=
"SetFontBold" type=
"" overloaded=
"no">
29871 <autodoc>SetFontBold(self, int x)
</autodoc>
29873 <param name=
"x" type=
"int" default=
""/>
29876 <method name=
"GetFontItalic" type=
"int" overloaded=
"no">
29877 <autodoc>GetFontItalic(self) -
> int
</autodoc>
29879 <method name=
"SetFontItalic" type=
"" overloaded=
"no">
29880 <autodoc>SetFontItalic(self, int x)
</autodoc>
29882 <param name=
"x" type=
"int" default=
""/>
29885 <method name=
"GetFontUnderlined" type=
"int" overloaded=
"no">
29886 <autodoc>GetFontUnderlined(self) -
> int
</autodoc>
29888 <method name=
"SetFontUnderlined" type=
"" overloaded=
"no">
29889 <autodoc>SetFontUnderlined(self, int x)
</autodoc>
29891 <param name=
"x" type=
"int" default=
""/>
29894 <method name=
"GetFontFixed" type=
"int" overloaded=
"no">
29895 <autodoc>GetFontFixed(self) -
> int
</autodoc>
29897 <method name=
"SetFontFixed" type=
"" overloaded=
"no">
29898 <autodoc>SetFontFixed(self, int x)
</autodoc>
29900 <param name=
"x" type=
"int" default=
""/>
29903 <method name=
"GetAlign" type=
"int" overloaded=
"no">
29904 <autodoc>GetAlign(self) -
> int
</autodoc>
29906 <method name=
"SetAlign" type=
"" overloaded=
"no">
29907 <autodoc>SetAlign(self, int a)
</autodoc>
29909 <param name=
"a" type=
"int" default=
""/>
29912 <method name=
"GetLinkColor" type=
"Colour" overloaded=
"no">
29913 <autodoc>GetLinkColor(self) -
> Colour
</autodoc>
29915 <method name=
"SetLinkColor" type=
"" overloaded=
"no">
29916 <autodoc>SetLinkColor(self, Colour clr)
</autodoc>
29918 <param name=
"clr" type=
"Colour" default=
""/>
29921 <method name=
"GetActualColor" type=
"Colour" overloaded=
"no">
29922 <autodoc>GetActualColor(self) -
> Colour
</autodoc>
29924 <method name=
"SetActualColor" type=
"" overloaded=
"no">
29925 <autodoc>SetActualColor(self, Colour clr)
</autodoc>
29927 <param name=
"clr" type=
"Colour" default=
""/>
29930 <method name=
"SetLink" type=
"" overloaded=
"no">
29931 <autodoc>SetLink(self, String link)
</autodoc>
29933 <param name=
"link" type=
"String" default=
""/>
29936 <method name=
"CreateCurrentFont" type=
"Font" overloaded=
"no">
29937 <autodoc>CreateCurrentFont(self) -
> Font
</autodoc>
29939 <method name=
"GetLink" type=
"HtmlLinkInfo" overloaded=
"no">
29940 <autodoc>GetLink(self) -
> HtmlLinkInfo
</autodoc>
29943 <class name=
"HtmlTagHandler" oldname=
"wxPyHtmlTagHandler" module=
"html">
29944 <baseclass name=
"Object"/>
29945 <constructor name=
"wxPyHtmlTagHandler" overloaded=
"no">
29946 <autodoc>__init__(self) -
> HtmlTagHandler
</autodoc>
29948 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
29949 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
29951 <param name=
"self" type=
"PyObject" default=
""/>
29952 <param name=
"_class" type=
"PyObject" default=
""/>
29955 <method name=
"SetParser" type=
"" overloaded=
"no">
29956 <autodoc>SetParser(self, HtmlParser parser)
</autodoc>
29958 <param name=
"parser" type=
"HtmlParser" default=
""/>
29961 <method name=
"GetParser" type=
"HtmlParser" overloaded=
"no">
29962 <autodoc>GetParser(self) -
> HtmlParser
</autodoc>
29964 <method name=
"ParseInner" type=
"" overloaded=
"no">
29965 <autodoc>ParseInner(self, HtmlTag tag)
</autodoc>
29967 <param name=
"tag" type=
"HtmlTag" default=
""/>
29971 <class name=
"HtmlWinTagHandler" oldname=
"wxPyHtmlWinTagHandler" module=
"html">
29972 <baseclass name=
"HtmlTagHandler"/>
29973 <constructor name=
"wxPyHtmlWinTagHandler" overloaded=
"no">
29974 <autodoc>__init__(self) -
> HtmlWinTagHandler
</autodoc>
29976 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
29977 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
29979 <param name=
"self" type=
"PyObject" default=
""/>
29980 <param name=
"_class" type=
"PyObject" default=
""/>
29983 <method name=
"SetParser" type=
"" overloaded=
"no">
29984 <autodoc>SetParser(self, HtmlParser parser)
</autodoc>
29986 <param name=
"parser" type=
"HtmlParser" default=
""/>
29989 <method name=
"GetParser" type=
"HtmlWinParser" overloaded=
"no">
29990 <autodoc>GetParser(self) -
> HtmlWinParser
</autodoc>
29992 <method name=
"ParseInner" type=
"" overloaded=
"no">
29993 <autodoc>ParseInner(self, HtmlTag tag)
</autodoc>
29995 <param name=
"tag" type=
"HtmlTag" default=
""/>
29999 <method name=
"HtmlWinParser_AddTagHandler" oldname=
"wxHtmlWinParser_AddTagHandler" type=
"" overloaded=
"no">
30000 <autodoc>HtmlWinParser_AddTagHandler(PyObject tagHandlerClass)
</autodoc>
30002 <param name=
"tagHandlerClass" type=
"PyObject" default=
""/>
30006 #---------------------------------------------------------------------------
30008 <class name=
"HtmlSelection" oldname=
"wxHtmlSelection" module=
"html">
30009 <constructor name=
"HtmlSelection" overloaded=
"no">
30010 <autodoc>__init__(self) -
> HtmlSelection
</autodoc>
30012 <destructor name=
"~wxHtmlSelection" overloaded=
"no">
30013 <autodoc>__del__(self)
</autodoc>
30015 <method name=
"Set" type=
"" overloaded=
"no">
30016 <autodoc>Set(self, Point fromPos, HtmlCell fromCell, Point toPos, HtmlCell toCell)
</autodoc>
30018 <param name=
"fromPos" type=
"Point" default=
""/>
30019 <param name=
"fromCell" type=
"wxHtmlCell" default=
""/>
30020 <param name=
"toPos" type=
"Point" default=
""/>
30021 <param name=
"toCell" type=
"wxHtmlCell" default=
""/>
30024 <method name=
"SetCells" type=
"" overloaded=
"no">
30025 <autodoc>SetCells(self, HtmlCell fromCell, HtmlCell toCell)
</autodoc>
30027 <param name=
"fromCell" type=
"wxHtmlCell" default=
""/>
30028 <param name=
"toCell" type=
"wxHtmlCell" default=
""/>
30031 <method name=
"GetFromCell" type=
"wxHtmlCell" overloaded=
"no">
30032 <autodoc>GetFromCell(self) -
> HtmlCell
</autodoc>
30034 <method name=
"GetToCell" type=
"wxHtmlCell" overloaded=
"no">
30035 <autodoc>GetToCell(self) -
> HtmlCell
</autodoc>
30037 <method name=
"GetFromPos" type=
"Point" overloaded=
"no">
30038 <autodoc>GetFromPos(self) -
> Point
</autodoc>
30040 <method name=
"GetToPos" type=
"Point" overloaded=
"no">
30041 <autodoc>GetToPos(self) -
> Point
</autodoc>
30043 <method name=
"GetFromPrivPos" type=
"Point" overloaded=
"no">
30044 <autodoc>GetFromPrivPos(self) -
> Point
</autodoc>
30046 <method name=
"GetToPrivPos" type=
"Point" overloaded=
"no">
30047 <autodoc>GetToPrivPos(self) -
> Point
</autodoc>
30049 <method name=
"SetFromPrivPos" type=
"" overloaded=
"no">
30050 <autodoc>SetFromPrivPos(self, Point pos)
</autodoc>
30052 <param name=
"pos" type=
"Point" default=
""/>
30055 <method name=
"SetToPrivPos" type=
"" overloaded=
"no">
30056 <autodoc>SetToPrivPos(self, Point pos)
</autodoc>
30058 <param name=
"pos" type=
"Point" default=
""/>
30061 <method name=
"ClearPrivPos" type=
"" overloaded=
"no">
30062 <autodoc>ClearPrivPos(self)
</autodoc>
30064 <method name=
"IsEmpty" type=
"bool" overloaded=
"no">
30065 <autodoc>IsEmpty(self) -
> bool
</autodoc>
30068 <class name=
"HtmlRenderingState" oldname=
"wxHtmlRenderingState" module=
"html">
30069 <constructor name=
"HtmlRenderingState" overloaded=
"no">
30070 <autodoc>__init__(self) -
> HtmlRenderingState
</autodoc>
30072 <destructor name=
"~wxHtmlRenderingState" overloaded=
"no">
30073 <autodoc>__del__(self)
</autodoc>
30075 <method name=
"SetSelectionState" type=
"" overloaded=
"no">
30076 <autodoc>SetSelectionState(self, int s)
</autodoc>
30078 <param name=
"s" type=
"wxHtmlSelectionState" default=
""/>
30081 <method name=
"GetSelectionState" type=
"wxHtmlSelectionState" overloaded=
"no">
30082 <autodoc>GetSelectionState(self) -
> int
</autodoc>
30084 <method name=
"SetFgColour" type=
"" overloaded=
"no">
30085 <autodoc>SetFgColour(self, Colour c)
</autodoc>
30087 <param name=
"c" type=
"Colour" default=
""/>
30090 <method name=
"GetFgColour" type=
"Colour" overloaded=
"no">
30091 <autodoc>GetFgColour(self) -
> Colour
</autodoc>
30093 <method name=
"SetBgColour" type=
"" overloaded=
"no">
30094 <autodoc>SetBgColour(self, Colour c)
</autodoc>
30096 <param name=
"c" type=
"Colour" default=
""/>
30099 <method name=
"GetBgColour" type=
"Colour" overloaded=
"no">
30100 <autodoc>GetBgColour(self) -
> Colour
</autodoc>
30103 <class name=
"HtmlRenderingStyle" oldname=
"wxHtmlRenderingStyle" module=
"html">
30104 <method name=
"GetSelectedTextColour" type=
"Colour" overloaded=
"no">
30105 <autodoc>GetSelectedTextColour(self, Colour clr) -
> Colour
</autodoc>
30107 <param name=
"clr" type=
"Colour" default=
""/>
30110 <method name=
"GetSelectedTextBgColour" type=
"Colour" overloaded=
"no">
30111 <autodoc>GetSelectedTextBgColour(self, Colour clr) -
> Colour
</autodoc>
30113 <param name=
"clr" type=
"Colour" default=
""/>
30117 <class name=
"DefaultHtmlRenderingStyle" oldname=
"wxDefaultHtmlRenderingStyle" module=
"html">
30118 <baseclass name=
"HtmlRenderingStyle"/>
30119 <method name=
"GetSelectedTextColour" type=
"Colour" overloaded=
"no">
30120 <autodoc>GetSelectedTextColour(self, Colour clr) -
> Colour
</autodoc>
30122 <param name=
"clr" type=
"Colour" default=
""/>
30125 <method name=
"GetSelectedTextBgColour" type=
"Colour" overloaded=
"no">
30126 <autodoc>GetSelectedTextBgColour(self, Colour clr) -
> Colour
</autodoc>
30128 <param name=
"clr" type=
"Colour" default=
""/>
30132 <class name=
"HtmlRenderingInfo" oldname=
"wxHtmlRenderingInfo" module=
"html">
30133 <constructor name=
"HtmlRenderingInfo" overloaded=
"no">
30134 <autodoc>__init__(self) -
> HtmlRenderingInfo
</autodoc>
30136 <destructor name=
"~wxHtmlRenderingInfo" overloaded=
"no">
30137 <autodoc>__del__(self)
</autodoc>
30139 <method name=
"SetSelection" type=
"" overloaded=
"no">
30140 <autodoc>SetSelection(self, HtmlSelection s)
</autodoc>
30142 <param name=
"s" type=
"HtmlSelection" default=
""/>
30145 <method name=
"GetSelection" type=
"HtmlSelection" overloaded=
"no">
30146 <autodoc>GetSelection(self) -
> HtmlSelection
</autodoc>
30148 <method name=
"SetStyle" type=
"" overloaded=
"no">
30149 <autodoc>SetStyle(self, HtmlRenderingStyle style)
</autodoc>
30151 <param name=
"style" type=
"HtmlRenderingStyle" default=
""/>
30154 <method name=
"GetStyle" type=
"HtmlRenderingStyle" overloaded=
"no">
30155 <autodoc>GetStyle(self) -
> HtmlRenderingStyle
</autodoc>
30157 <method name=
"GetState" type=
"HtmlRenderingState" overloaded=
"no">
30158 <autodoc>GetState(self) -
> HtmlRenderingState
</autodoc>
30162 #---------------------------------------------------------------------------
30164 <class name=
"HtmlCell" oldname=
"wxHtmlCell" module=
"html">
30165 <baseclass name=
"Object"/>
30166 <constructor name=
"HtmlCell" overloaded=
"no">
30167 <autodoc>__init__(self) -
> HtmlCell
</autodoc>
30169 <method name=
"GetPosX" type=
"int" overloaded=
"no">
30170 <autodoc>GetPosX(self) -
> int
</autodoc>
30172 <method name=
"GetPosY" type=
"int" overloaded=
"no">
30173 <autodoc>GetPosY(self) -
> int
</autodoc>
30175 <method name=
"GetWidth" type=
"int" overloaded=
"no">
30176 <autodoc>GetWidth(self) -
> int
</autodoc>
30178 <method name=
"GetHeight" type=
"int" overloaded=
"no">
30179 <autodoc>GetHeight(self) -
> int
</autodoc>
30181 <method name=
"GetDescent" type=
"int" overloaded=
"no">
30182 <autodoc>GetDescent(self) -
> int
</autodoc>
30184 <method name=
"GetMaxTotalWidth" type=
"int" overloaded=
"no">
30185 <autodoc>GetMaxTotalWidth(self) -
> int
</autodoc>
30187 <method name=
"GetId" type=
"String" overloaded=
"no">
30188 <autodoc>GetId(self) -
> String
</autodoc>
30190 <method name=
"SetId" type=
"" overloaded=
"no">
30191 <autodoc>SetId(self, String id)
</autodoc>
30193 <param name=
"id" type=
"String" default=
""/>
30196 <method name=
"GetLink" type=
"HtmlLinkInfo" overloaded=
"no">
30197 <autodoc>GetLink(self, int x=
0, int y=
0) -
> HtmlLinkInfo
</autodoc>
30199 <param name=
"x" type=
"int" default=
"0"/>
30200 <param name=
"y" type=
"int" default=
"0"/>
30203 <method name=
"GetNext" type=
"HtmlCell" overloaded=
"no">
30204 <autodoc>GetNext(self) -
> HtmlCell
</autodoc>
30206 <method name=
"GetParent" type=
"wxHtmlContainerCell" overloaded=
"no">
30207 <autodoc>GetParent(self) -
> HtmlContainerCell
</autodoc>
30209 <method name=
"GetFirstChild" type=
"HtmlCell" overloaded=
"no">
30210 <autodoc>GetFirstChild(self) -
> HtmlCell
</autodoc>
30212 <method name=
"GetCursor" type=
"Cursor" overloaded=
"no">
30213 <autodoc>GetCursor(self) -
> Cursor
</autodoc>
30215 <method name=
"IsFormattingCell" type=
"bool" overloaded=
"no">
30216 <autodoc>IsFormattingCell(self) -
> bool
</autodoc>
30218 <method name=
"SetLink" type=
"" overloaded=
"no">
30219 <autodoc>SetLink(self, HtmlLinkInfo link)
</autodoc>
30221 <param name=
"link" type=
"HtmlLinkInfo" default=
""/>
30224 <method name=
"SetNext" type=
"" overloaded=
"no">
30225 <autodoc>SetNext(self, HtmlCell cell)
</autodoc>
30227 <param name=
"cell" type=
"HtmlCell" default=
""/>
30230 <method name=
"SetParent" type=
"" overloaded=
"no">
30231 <autodoc>SetParent(self, HtmlContainerCell p)
</autodoc>
30233 <param name=
"p" type=
"wxHtmlContainerCell" default=
""/>
30236 <method name=
"SetPos" type=
"" overloaded=
"no">
30237 <autodoc>SetPos(self, int x, int y)
</autodoc>
30239 <param name=
"x" type=
"int" default=
""/>
30240 <param name=
"y" type=
"int" default=
""/>
30243 <method name=
"Layout" type=
"" overloaded=
"no">
30244 <autodoc>Layout(self, int w)
</autodoc>
30246 <param name=
"w" type=
"int" default=
""/>
30249 <method name=
"Draw" type=
"" overloaded=
"no">
30250 <autodoc>Draw(self, DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info)
</autodoc>
30252 <param name=
"dc" type=
"DC" default=
""/>
30253 <param name=
"x" type=
"int" default=
""/>
30254 <param name=
"y" type=
"int" default=
""/>
30255 <param name=
"view_y1" type=
"int" default=
""/>
30256 <param name=
"view_y2" type=
"int" default=
""/>
30257 <param name=
"info" type=
"HtmlRenderingInfo" default=
""/>
30260 <method name=
"DrawInvisible" type=
"" overloaded=
"no">
30261 <autodoc>DrawInvisible(self, DC dc, int x, int y, HtmlRenderingInfo info)
</autodoc>
30263 <param name=
"dc" type=
"DC" default=
""/>
30264 <param name=
"x" type=
"int" default=
""/>
30265 <param name=
"y" type=
"int" default=
""/>
30266 <param name=
"info" type=
"HtmlRenderingInfo" default=
""/>
30269 <method name=
"Find" type=
"HtmlCell" overloaded=
"no">
30270 <autodoc>Find(self, int condition, void param) -
> HtmlCell
</autodoc>
30272 <param name=
"condition" type=
"int" default=
""/>
30273 <param name=
"param" type=
"" default=
""/>
30276 <method name=
"AdjustPagebreak" type=
"bool" overloaded=
"no">
30277 <autodoc>AdjustPagebreak(self, int INOUT) -
> bool
</autodoc>
30279 <param name=
"INOUT" type=
"int" default=
""/>
30282 <method name=
"SetCanLiveOnPagebreak" type=
"" overloaded=
"no">
30283 <autodoc>SetCanLiveOnPagebreak(self, bool can)
</autodoc>
30285 <param name=
"can" type=
"bool" default=
""/>
30288 <method name=
"IsLinebreakAllowed" type=
"bool" overloaded=
"no">
30289 <autodoc>IsLinebreakAllowed(self) -
> bool
</autodoc>
30291 <method name=
"IsTerminalCell" type=
"bool" overloaded=
"no">
30292 <autodoc>IsTerminalCell(self) -
> bool
</autodoc>
30294 <method name=
"FindCellByPos" type=
"HtmlCell" overloaded=
"no">
30295 <autodoc>FindCellByPos(self, int x, int y, unsigned int flags=HTML_FIND_EXACT) -
> HtmlCell
</autodoc>
30297 <param name=
"x" type=
"int" default=
""/>
30298 <param name=
"y" type=
"int" default=
""/>
30299 <param name=
"flags" type=
"unsigned int" default=
"wxHTML_FIND_EXACT"/>
30302 <method name=
"GetAbsPos" type=
"Point" overloaded=
"no">
30303 <autodoc>GetAbsPos(self) -
> Point
</autodoc>
30305 <method name=
"GetFirstTerminal" type=
"HtmlCell" overloaded=
"no">
30306 <autodoc>GetFirstTerminal(self) -
> HtmlCell
</autodoc>
30308 <method name=
"GetLastTerminal" type=
"HtmlCell" overloaded=
"no">
30309 <autodoc>GetLastTerminal(self) -
> HtmlCell
</autodoc>
30311 <method name=
"GetDepth" type=
"unsigned int" overloaded=
"no">
30312 <autodoc>GetDepth(self) -
> unsigned int
</autodoc>
30314 <method name=
"IsBefore" type=
"bool" overloaded=
"no">
30315 <autodoc>IsBefore(self, HtmlCell cell) -
> bool
</autodoc>
30317 <param name=
"cell" type=
"HtmlCell" default=
""/>
30320 <method name=
"ConvertToText" type=
"String" overloaded=
"no">
30321 <autodoc>ConvertToText(self, HtmlSelection sel) -
> String
</autodoc>
30323 <param name=
"sel" type=
"HtmlSelection" default=
""/>
30327 <class name=
"HtmlWordCell" oldname=
"wxHtmlWordCell" module=
"html">
30328 <baseclass name=
"HtmlCell"/>
30329 <constructor name=
"HtmlWordCell" overloaded=
"no">
30330 <autodoc>__init__(self, String word, DC dc) -
> HtmlWordCell
</autodoc>
30332 <param name=
"word" type=
"String" default=
""/>
30333 <param name=
"dc" type=
"DC" default=
""/>
30337 <class name=
"HtmlContainerCell" oldname=
"wxHtmlContainerCell" module=
"html">
30338 <baseclass name=
"HtmlCell"/>
30339 <constructor name=
"HtmlContainerCell" overloaded=
"no">
30340 <autodoc>__init__(self, HtmlContainerCell parent) -
> HtmlContainerCell
</autodoc>
30342 <param name=
"parent" type=
"HtmlContainerCell" default=
""/>
30345 <method name=
"InsertCell" type=
"" overloaded=
"no">
30346 <autodoc>InsertCell(self, HtmlCell cell)
</autodoc>
30348 <param name=
"cell" type=
"HtmlCell" default=
""/>
30351 <method name=
"SetAlignHor" type=
"" overloaded=
"no">
30352 <autodoc>SetAlignHor(self, int al)
</autodoc>
30354 <param name=
"al" type=
"int" default=
""/>
30357 <method name=
"GetAlignHor" type=
"int" overloaded=
"no">
30358 <autodoc>GetAlignHor(self) -
> int
</autodoc>
30360 <method name=
"SetAlignVer" type=
"" overloaded=
"no">
30361 <autodoc>SetAlignVer(self, int al)
</autodoc>
30363 <param name=
"al" type=
"int" default=
""/>
30366 <method name=
"GetAlignVer" type=
"int" overloaded=
"no">
30367 <autodoc>GetAlignVer(self) -
> int
</autodoc>
30369 <method name=
"SetIndent" type=
"" overloaded=
"no">
30370 <autodoc>SetIndent(self, int i, int what, int units=HTML_UNITS_PIXELS)
</autodoc>
30372 <param name=
"i" type=
"int" default=
""/>
30373 <param name=
"what" type=
"int" default=
""/>
30374 <param name=
"units" type=
"int" default=
"wxHTML_UNITS_PIXELS"/>
30377 <method name=
"GetIndent" type=
"int" overloaded=
"no">
30378 <autodoc>GetIndent(self, int ind) -
> int
</autodoc>
30380 <param name=
"ind" type=
"int" default=
""/>
30383 <method name=
"GetIndentUnits" type=
"int" overloaded=
"no">
30384 <autodoc>GetIndentUnits(self, int ind) -
> int
</autodoc>
30386 <param name=
"ind" type=
"int" default=
""/>
30389 <method name=
"SetAlign" type=
"" overloaded=
"no">
30390 <autodoc>SetAlign(self, HtmlTag tag)
</autodoc>
30392 <param name=
"tag" type=
"HtmlTag" default=
""/>
30395 <method name=
"SetWidthFloat" type=
"" overloaded=
"no">
30396 <autodoc>SetWidthFloat(self, int w, int units)
</autodoc>
30398 <param name=
"w" type=
"int" default=
""/>
30399 <param name=
"units" type=
"int" default=
""/>
30402 <method name=
"SetWidthFloatFromTag" type=
"" overloaded=
"no">
30403 <autodoc>SetWidthFloatFromTag(self, HtmlTag tag)
</autodoc>
30405 <param name=
"tag" type=
"HtmlTag" default=
""/>
30408 <method name=
"SetMinHeight" type=
"" overloaded=
"no">
30409 <autodoc>SetMinHeight(self, int h, int align=HTML_ALIGN_TOP)
</autodoc>
30411 <param name=
"h" type=
"int" default=
""/>
30412 <param name=
"align" type=
"int" default=
"wxHTML_ALIGN_TOP"/>
30415 <method name=
"SetBackgroundColour" type=
"" overloaded=
"no">
30416 <autodoc>SetBackgroundColour(self, Colour clr)
</autodoc>
30418 <param name=
"clr" type=
"Colour" default=
""/>
30421 <method name=
"GetBackgroundColour" type=
"Colour" overloaded=
"no">
30422 <autodoc>GetBackgroundColour(self) -
> Colour
</autodoc>
30424 <method name=
"SetBorder" type=
"" overloaded=
"no">
30425 <autodoc>SetBorder(self, Colour clr1, Colour clr2)
</autodoc>
30427 <param name=
"clr1" type=
"Colour" default=
""/>
30428 <param name=
"clr2" type=
"Colour" default=
""/>
30431 <method name=
"GetFirstChild" type=
"HtmlCell" overloaded=
"no">
30432 <autodoc>GetFirstChild(self) -
> HtmlCell
</autodoc>
30435 <class name=
"HtmlColourCell" oldname=
"wxHtmlColourCell" module=
"html">
30436 <baseclass name=
"HtmlCell"/>
30437 <constructor name=
"HtmlColourCell" overloaded=
"no">
30438 <autodoc>__init__(self, Colour clr, int flags=HTML_CLR_FOREGROUND) -
> HtmlColourCell
</autodoc>
30440 <param name=
"clr" type=
"Colour" default=
""/>
30441 <param name=
"flags" type=
"int" default=
"wxHTML_CLR_FOREGROUND"/>
30445 <class name=
"HtmlFontCell" oldname=
"wxHtmlFontCell" module=
"html">
30446 <baseclass name=
"HtmlCell"/>
30447 <constructor name=
"HtmlFontCell" overloaded=
"no">
30448 <autodoc>__init__(self, Font font) -
> HtmlFontCell
</autodoc>
30450 <param name=
"font" type=
"Font" default=
""/>
30454 <class name=
"HtmlWidgetCell" oldname=
"wxHtmlWidgetCell" module=
"html">
30455 <baseclass name=
"HtmlCell"/>
30456 <constructor name=
"HtmlWidgetCell" overloaded=
"no">
30457 <autodoc>__init__(self, Window wnd, int w=
0) -
> HtmlWidgetCell
</autodoc>
30459 <param name=
"wnd" type=
"Window" default=
""/>
30460 <param name=
"w" type=
"int" default=
"0"/>
30465 #---------------------------------------------------------------------------
30467 <class name=
"HtmlFilter" oldname=
"wxPyHtmlFilter" module=
"html">
30468 <baseclass name=
"Object"/>
30469 <constructor name=
"wxPyHtmlFilter" overloaded=
"no">
30470 <autodoc>__init__(self) -
> HtmlFilter
</autodoc>
30472 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
30473 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
30475 <param name=
"self" type=
"PyObject" default=
""/>
30476 <param name=
"_class" type=
"PyObject" default=
""/>
30481 #---------------------------------------------------------------------------
30483 <class name=
"HtmlWindow" oldname=
"wxPyHtmlWindow" module=
"html">
30484 <baseclass name=
"ScrolledWindow"/>
30485 <constructor name=
"wxPyHtmlWindow" overloaded=
"no">
30486 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
30487 Size size=DefaultSize, int style=HW_DEFAULT_STYLE,
30488 String name=HtmlWindowNameStr) -
> HtmlWindow
</autodoc>
30490 <param name=
"parent" type=
"Window" default=
""/>
30491 <param name=
"id" type=
"int" default=
"-1"/>
30492 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
30493 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
30494 <param name=
"style" type=
"int" default=
"wxHW_DEFAULT_STYLE"/>
30495 <param name=
"name" type=
"String" default=
"wxPyHtmlWindowNameStr"/>
30498 <constructor name=
"PreHtmlWindow" overloaded=
"no">
30499 <autodoc>PreHtmlWindow() -
> HtmlWindow
</autodoc>
30501 <method name=
"Create" type=
"bool" overloaded=
"no">
30502 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
30503 Size size=DefaultSize, int style=HW_SCROLLBAR_AUTO,
30504 String name=HtmlWindowNameStr) -
> bool
</autodoc>
30506 <param name=
"parent" type=
"Window" default=
""/>
30507 <param name=
"id" type=
"int" default=
"-1"/>
30508 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
30509 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
30510 <param name=
"style" type=
"int" default=
"wxHW_SCROLLBAR_AUTO"/>
30511 <param name=
"name" type=
"String" default=
"wxPyHtmlWindowNameStr"/>
30514 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
30515 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
30517 <param name=
"self" type=
"PyObject" default=
""/>
30518 <param name=
"_class" type=
"PyObject" default=
""/>
30521 <method name=
"SetPage" type=
"bool" overloaded=
"no">
30522 <autodoc>SetPage(self, String source) -
> bool
</autodoc>
30524 <param name=
"source" type=
"String" default=
""/>
30527 <method name=
"LoadPage" type=
"bool" overloaded=
"no">
30528 <autodoc>LoadPage(self, String location) -
> bool
</autodoc>
30530 <param name=
"location" type=
"String" default=
""/>
30533 <method name=
"LoadFile" type=
"bool" overloaded=
"no">
30534 <autodoc>LoadFile(self, String filename) -
> bool
</autodoc>
30536 <param name=
"filename" type=
"String" default=
""/>
30539 <method name=
"AppendToPage" type=
"bool" overloaded=
"no">
30540 <autodoc>AppendToPage(self, String source) -
> bool
</autodoc>
30542 <param name=
"source" type=
"String" default=
""/>
30545 <method name=
"GetOpenedPage" type=
"String" overloaded=
"no">
30546 <autodoc>GetOpenedPage(self) -
> String
</autodoc>
30548 <method name=
"GetOpenedAnchor" type=
"String" overloaded=
"no">
30549 <autodoc>GetOpenedAnchor(self) -
> String
</autodoc>
30551 <method name=
"GetOpenedPageTitle" type=
"String" overloaded=
"no">
30552 <autodoc>GetOpenedPageTitle(self) -
> String
</autodoc>
30554 <method name=
"SetRelatedFrame" type=
"" overloaded=
"no">
30555 <autodoc>SetRelatedFrame(self, Frame frame, String format)
</autodoc>
30557 <param name=
"frame" type=
"Frame" default=
""/>
30558 <param name=
"format" type=
"String" default=
""/>
30561 <method name=
"GetRelatedFrame" type=
"Frame" overloaded=
"no">
30562 <autodoc>GetRelatedFrame(self) -
> Frame
</autodoc>
30564 <method name=
"SetRelatedStatusBar" type=
"" overloaded=
"no">
30565 <autodoc>SetRelatedStatusBar(self, int bar)
</autodoc>
30567 <param name=
"bar" type=
"int" default=
""/>
30570 <method name=
"SetFonts" type=
"" overloaded=
"no">
30571 <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)
</autodoc>
30573 <param name=
"normal_face" type=
"String" default=
""/>
30574 <param name=
"fixed_face" type=
"String" default=
""/>
30575 <param name=
"sizes" type=
"PyObject" default=
"NULL"/>
30578 <method name=
"NormalizeFontSizes" type=
"" overloaded=
"no">
30579 <autodoc>NormalizeFontSizes(self, int size=-
1)
</autodoc>
30581 <param name=
"size" type=
"int" default=
"-1"/>
30584 <method name=
"SetTitle" type=
"" overloaded=
"no">
30585 <autodoc>SetTitle(self, String title)
</autodoc>
30587 <param name=
"title" type=
"String" default=
""/>
30590 <method name=
"SetBorders" type=
"" overloaded=
"no">
30591 <autodoc>SetBorders(self, int b)
</autodoc>
30593 <param name=
"b" type=
"int" default=
""/>
30596 <method name=
"ReadCustomization" type=
"" overloaded=
"no">
30597 <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)
</autodoc>
30599 <param name=
"cfg" type=
"ConfigBase" default=
""/>
30600 <param name=
"path" type=
"String" default=
"wxPyEmptyString"/>
30603 <method name=
"WriteCustomization" type=
"" overloaded=
"no">
30604 <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)
</autodoc>
30606 <param name=
"cfg" type=
"ConfigBase" default=
""/>
30607 <param name=
"path" type=
"String" default=
"wxPyEmptyString"/>
30610 <method name=
"HistoryBack" type=
"bool" overloaded=
"no">
30611 <autodoc>HistoryBack(self) -
> bool
</autodoc>
30613 <method name=
"HistoryForward" type=
"bool" overloaded=
"no">
30614 <autodoc>HistoryForward(self) -
> bool
</autodoc>
30616 <method name=
"HistoryCanBack" type=
"bool" overloaded=
"no">
30617 <autodoc>HistoryCanBack(self) -
> bool
</autodoc>
30619 <method name=
"HistoryCanForward" type=
"bool" overloaded=
"no">
30620 <autodoc>HistoryCanForward(self) -
> bool
</autodoc>
30622 <method name=
"HistoryClear" type=
"" overloaded=
"no">
30623 <autodoc>HistoryClear(self)
</autodoc>
30625 <method name=
"GetInternalRepresentation" type=
"HtmlContainerCell" overloaded=
"no">
30626 <autodoc>GetInternalRepresentation(self) -
> HtmlContainerCell
</autodoc>
30628 <method name=
"GetParser" type=
"HtmlWinParser" overloaded=
"no">
30629 <autodoc>GetParser(self) -
> HtmlWinParser
</autodoc>
30631 <method name=
"ScrollToAnchor" type=
"bool" overloaded=
"no">
30632 <autodoc>ScrollToAnchor(self, String anchor) -
> bool
</autodoc>
30634 <param name=
"anchor" type=
"String" default=
""/>
30637 <method name=
"HasAnchor" type=
"bool" overloaded=
"no">
30638 <autodoc>HasAnchor(self, String anchor) -
> bool
</autodoc>
30640 <param name=
"anchor" type=
"String" default=
""/>
30643 <staticmethod name=
"AddFilter" type=
"" overloaded=
"no">
30644 <autodoc>AddFilter(HtmlFilter filter)
</autodoc>
30646 <param name=
"filter" type=
"HtmlFilter" default=
""/>
30649 <method name=
"SelectWord" type=
"" overloaded=
"no">
30650 <autodoc>SelectWord(self, Point pos)
</autodoc>
30652 <param name=
"pos" type=
"Point" default=
""/>
30655 <method name=
"SelectLine" type=
"" overloaded=
"no">
30656 <autodoc>SelectLine(self, Point pos)
</autodoc>
30658 <param name=
"pos" type=
"Point" default=
""/>
30661 <method name=
"SelectAll" type=
"" overloaded=
"no">
30662 <autodoc>SelectAll(self)
</autodoc>
30664 <method name=
"SelectionToText" type=
"String" overloaded=
"no">
30665 <autodoc>SelectionToText(self) -
> String
</autodoc>
30667 <method name=
"ToText" type=
"String" overloaded=
"no">
30668 <autodoc>ToText(self) -
> String
</autodoc>
30670 <method name=
"base_OnLinkClicked" type=
"" overloaded=
"no">
30671 <autodoc>base_OnLinkClicked(self, HtmlLinkInfo link)
</autodoc>
30673 <param name=
"link" type=
"HtmlLinkInfo" default=
""/>
30676 <method name=
"base_OnSetTitle" type=
"" overloaded=
"no">
30677 <autodoc>base_OnSetTitle(self, String title)
</autodoc>
30679 <param name=
"title" type=
"String" default=
""/>
30682 <method name=
"base_OnCellMouseHover" type=
"" overloaded=
"no">
30683 <autodoc>base_OnCellMouseHover(self, HtmlCell cell, int x, int y)
</autodoc>
30685 <param name=
"cell" type=
"HtmlCell" default=
""/>
30686 <param name=
"x" type=
"int" default=
""/>
30687 <param name=
"y" type=
"int" default=
""/>
30690 <method name=
"base_OnCellClicked" type=
"" overloaded=
"no">
30691 <autodoc>base_OnCellClicked(self, HtmlCell cell, int x, int y, MouseEvent event)
</autodoc>
30693 <param name=
"cell" type=
"HtmlCell" default=
""/>
30694 <param name=
"x" type=
"int" default=
""/>
30695 <param name=
"y" type=
"int" default=
""/>
30696 <param name=
"event" type=
"MouseEvent" default=
""/>
30699 <staticmethod name=
"GetClassDefaultAttributes" type=
"VisualAttributes" overloaded=
"no">
30700 <autodoc>GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -
> VisualAttributes
</autodoc>
30701 <docstring>Get the default attributes for this class. This is useful if you want
30702 to use the same font or colour in your own control as in a standard
30703 control -- which is a much better idea than hard coding specific
30704 colours or fonts which might look completely out of place on the
30705 user's system, especially if it uses themes.
30707 The variant parameter is only relevant under Mac currently and is
30708 ignore under other platforms. Under Mac, it will change the size of
30709 the returned font. See `wx.Window.SetWindowVariant` for more about
30712 <param name=
"variant" type=
"wxWindowVariant" default=
"wxWINDOW_VARIANT_NORMAL"/>
30717 #---------------------------------------------------------------------------
30719 <class name=
"HtmlDCRenderer" oldname=
"wxHtmlDCRenderer" module=
"html">
30720 <baseclass name=
"Object"/>
30721 <constructor name=
"HtmlDCRenderer" overloaded=
"no">
30722 <autodoc>__init__(self) -
> HtmlDCRenderer
</autodoc>
30724 <destructor name=
"~wxHtmlDCRenderer" overloaded=
"no">
30725 <autodoc>__del__(self)
</autodoc>
30727 <method name=
"SetDC" type=
"" overloaded=
"no">
30728 <autodoc>SetDC(self, DC dc, int maxwidth)
</autodoc>
30730 <param name=
"dc" type=
"DC" default=
""/>
30731 <param name=
"maxwidth" type=
"int" default=
""/>
30734 <method name=
"SetSize" type=
"" overloaded=
"no">
30735 <autodoc>SetSize(self, int width, int height)
</autodoc>
30737 <param name=
"width" type=
"int" default=
""/>
30738 <param name=
"height" type=
"int" default=
""/>
30741 <method name=
"SetHtmlText" type=
"" overloaded=
"no">
30742 <autodoc>SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True)
</autodoc>
30744 <param name=
"html" type=
"String" default=
""/>
30745 <param name=
"basepath" type=
"String" default=
"wxPyEmptyString"/>
30746 <param name=
"isdir" type=
"bool" default=
"True"/>
30749 <method name=
"SetFonts" type=
"" overloaded=
"no">
30750 <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)
</autodoc>
30752 <param name=
"normal_face" type=
"String" default=
""/>
30753 <param name=
"fixed_face" type=
"String" default=
""/>
30754 <param name=
"sizes" type=
"PyObject" default=
"NULL"/>
30757 <method name=
"NormalizeFontSizes" type=
"" overloaded=
"no">
30758 <autodoc>NormalizeFontSizes(self, int size=-
1)
</autodoc>
30760 <param name=
"size" type=
"int" default=
"-1"/>
30763 <method name=
"Render" type=
"int" overloaded=
"no">
30764 <autodoc>Render(self, int x, int y, int from=
0, int dont_render=False, int to=INT_MAX,
30765 int choices=None, int LCOUNT=
0) -
> int
</autodoc>
30767 <param name=
"x" type=
"int" default=
""/>
30768 <param name=
"y" type=
"int" default=
""/>
30769 <param name=
"from" type=
"int" default=
"0"/>
30770 <param name=
"dont_render" type=
"int" default=
"False"/>
30771 <param name=
"to" type=
"int" default=
"INT_MAX"/>
30772 <param name=
"choices" type=
"int" default=
"NULL"/>
30773 <param name=
"LCOUNT" type=
"int" default=
"0"/>
30776 <method name=
"GetTotalHeight" type=
"int" overloaded=
"no">
30777 <autodoc>GetTotalHeight(self) -
> int
</autodoc>
30780 <class name=
"HtmlPrintout" oldname=
"wxHtmlPrintout" module=
"html">
30781 <baseclass name=
"Printout"/>
30782 <constructor name=
"HtmlPrintout" overloaded=
"no">
30783 <autodoc>__init__(self, String title=HtmlPrintoutTitleStr) -
> HtmlPrintout
</autodoc>
30785 <param name=
"title" type=
"String" default=
"wxPyHtmlPrintoutTitleStr"/>
30788 <method name=
"SetHtmlText" type=
"" overloaded=
"no">
30789 <autodoc>SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True)
</autodoc>
30791 <param name=
"html" type=
"String" default=
""/>
30792 <param name=
"basepath" type=
"String" default=
"wxPyEmptyString"/>
30793 <param name=
"isdir" type=
"bool" default=
"True"/>
30796 <method name=
"SetHtmlFile" type=
"" overloaded=
"no">
30797 <autodoc>SetHtmlFile(self, String htmlfile)
</autodoc>
30799 <param name=
"htmlfile" type=
"String" default=
""/>
30802 <method name=
"SetHeader" type=
"" overloaded=
"no">
30803 <autodoc>SetHeader(self, String header, int pg=PAGE_ALL)
</autodoc>
30805 <param name=
"header" type=
"String" default=
""/>
30806 <param name=
"pg" type=
"int" default=
"wxPAGE_ALL"/>
30809 <method name=
"SetFooter" type=
"" overloaded=
"no">
30810 <autodoc>SetFooter(self, String footer, int pg=PAGE_ALL)
</autodoc>
30812 <param name=
"footer" type=
"String" default=
""/>
30813 <param name=
"pg" type=
"int" default=
"wxPAGE_ALL"/>
30816 <method name=
"SetFonts" type=
"" overloaded=
"no">
30817 <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)
</autodoc>
30819 <param name=
"normal_face" type=
"String" default=
""/>
30820 <param name=
"fixed_face" type=
"String" default=
""/>
30821 <param name=
"sizes" type=
"PyObject" default=
"NULL"/>
30824 <method name=
"NormalizeFontSizes" type=
"" overloaded=
"no">
30825 <autodoc>NormalizeFontSizes(self, int size=-
1)
</autodoc>
30827 <param name=
"size" type=
"int" default=
"-1"/>
30830 <method name=
"SetMargins" type=
"" overloaded=
"no">
30831 <autodoc>SetMargins(self, float top=
25.2, float bottom=
25.2, float left=
25.2,
30832 float right=
25.2, float spaces=
5)
</autodoc>
30834 <param name=
"top" type=
"float" default=
"25.2"/>
30835 <param name=
"bottom" type=
"float" default=
"25.2"/>
30836 <param name=
"left" type=
"float" default=
"25.2"/>
30837 <param name=
"right" type=
"float" default=
"25.2"/>
30838 <param name=
"spaces" type=
"float" default=
"5"/>
30841 <staticmethod name=
"AddFilter" type=
"" overloaded=
"no">
30842 <autodoc>AddFilter(wxHtmlFilter filter)
</autodoc>
30844 <param name=
"filter" type=
"wxHtmlFilter" default=
""/>
30847 <staticmethod name=
"CleanUpStatics" type=
"" overloaded=
"no">
30848 <autodoc>CleanUpStatics()
</autodoc>
30851 <class name=
"HtmlEasyPrinting" oldname=
"wxHtmlEasyPrinting" module=
"html">
30852 <baseclass name=
"Object"/>
30853 <constructor name=
"HtmlEasyPrinting" overloaded=
"no">
30854 <autodoc>__init__(self, String name=HtmlPrintingTitleStr, Window parentWindow=None) -
> HtmlEasyPrinting
</autodoc>
30856 <param name=
"name" type=
"String" default=
"wxPyHtmlPrintingTitleStr"/>
30857 <param name=
"parentWindow" type=
"Window" default=
"NULL"/>
30860 <destructor name=
"~wxHtmlEasyPrinting" overloaded=
"no">
30861 <autodoc>__del__(self)
</autodoc>
30863 <method name=
"PreviewFile" type=
"" overloaded=
"no">
30864 <autodoc>PreviewFile(self, String htmlfile)
</autodoc>
30866 <param name=
"htmlfile" type=
"String" default=
""/>
30869 <method name=
"PreviewText" type=
"" overloaded=
"no">
30870 <autodoc>PreviewText(self, String htmltext, String basepath=EmptyString)
</autodoc>
30872 <param name=
"htmltext" type=
"String" default=
""/>
30873 <param name=
"basepath" type=
"String" default=
"wxPyEmptyString"/>
30876 <method name=
"PrintFile" type=
"" overloaded=
"no">
30877 <autodoc>PrintFile(self, String htmlfile)
</autodoc>
30879 <param name=
"htmlfile" type=
"String" default=
""/>
30882 <method name=
"PrintText" type=
"" overloaded=
"no">
30883 <autodoc>PrintText(self, String htmltext, String basepath=EmptyString)
</autodoc>
30885 <param name=
"htmltext" type=
"String" default=
""/>
30886 <param name=
"basepath" type=
"String" default=
"wxPyEmptyString"/>
30889 <method name=
"PrinterSetup" type=
"" overloaded=
"no">
30890 <autodoc>PrinterSetup(self)
</autodoc>
30892 <method name=
"PageSetup" type=
"" overloaded=
"no">
30893 <autodoc>PageSetup(self)
</autodoc>
30895 <method name=
"SetHeader" type=
"" overloaded=
"no">
30896 <autodoc>SetHeader(self, String header, int pg=PAGE_ALL)
</autodoc>
30898 <param name=
"header" type=
"String" default=
""/>
30899 <param name=
"pg" type=
"int" default=
"wxPAGE_ALL"/>
30902 <method name=
"SetFooter" type=
"" overloaded=
"no">
30903 <autodoc>SetFooter(self, String footer, int pg=PAGE_ALL)
</autodoc>
30905 <param name=
"footer" type=
"String" default=
""/>
30906 <param name=
"pg" type=
"int" default=
"wxPAGE_ALL"/>
30909 <method name=
"SetFonts" type=
"" overloaded=
"no">
30910 <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)
</autodoc>
30912 <param name=
"normal_face" type=
"String" default=
""/>
30913 <param name=
"fixed_face" type=
"String" default=
""/>
30914 <param name=
"sizes" type=
"PyObject" default=
"NULL"/>
30917 <method name=
"NormalizeFontSizes" type=
"" overloaded=
"no">
30918 <autodoc>NormalizeFontSizes(self, int size=-
1)
</autodoc>
30920 <param name=
"size" type=
"int" default=
"-1"/>
30923 <method name=
"GetPrintData" type=
"PrintData" overloaded=
"no">
30924 <autodoc>GetPrintData(self) -
> PrintData
</autodoc>
30926 <method name=
"GetPageSetupData" type=
"PageSetupDialogData" overloaded=
"no">
30927 <autodoc>GetPageSetupData(self) -
> PageSetupDialogData
</autodoc>
30931 #---------------------------------------------------------------------------
30933 <class name=
"HtmlBookRecord" oldname=
"wxHtmlBookRecord" module=
"html">
30934 <constructor name=
"HtmlBookRecord" overloaded=
"no">
30935 <autodoc>__init__(self, String bookfile, String basepath, String title, String start) -
> HtmlBookRecord
</autodoc>
30937 <param name=
"bookfile" type=
"String" default=
""/>
30938 <param name=
"basepath" type=
"String" default=
""/>
30939 <param name=
"title" type=
"String" default=
""/>
30940 <param name=
"start" type=
"String" default=
""/>
30943 <method name=
"GetBookFile" type=
"String" overloaded=
"no">
30944 <autodoc>GetBookFile(self) -
> String
</autodoc>
30946 <method name=
"GetTitle" type=
"String" overloaded=
"no">
30947 <autodoc>GetTitle(self) -
> String
</autodoc>
30949 <method name=
"GetStart" type=
"String" overloaded=
"no">
30950 <autodoc>GetStart(self) -
> String
</autodoc>
30952 <method name=
"GetBasePath" type=
"String" overloaded=
"no">
30953 <autodoc>GetBasePath(self) -
> String
</autodoc>
30955 <method name=
"SetContentsRange" type=
"" overloaded=
"no">
30956 <autodoc>SetContentsRange(self, int start, int end)
</autodoc>
30958 <param name=
"start" type=
"int" default=
""/>
30959 <param name=
"end" type=
"int" default=
""/>
30962 <method name=
"GetContentsStart" type=
"int" overloaded=
"no">
30963 <autodoc>GetContentsStart(self) -
> int
</autodoc>
30965 <method name=
"GetContentsEnd" type=
"int" overloaded=
"no">
30966 <autodoc>GetContentsEnd(self) -
> int
</autodoc>
30968 <method name=
"SetTitle" type=
"" overloaded=
"no">
30969 <autodoc>SetTitle(self, String title)
</autodoc>
30971 <param name=
"title" type=
"String" default=
""/>
30974 <method name=
"SetBasePath" type=
"" overloaded=
"no">
30975 <autodoc>SetBasePath(self, String path)
</autodoc>
30977 <param name=
"path" type=
"String" default=
""/>
30980 <method name=
"SetStart" type=
"" overloaded=
"no">
30981 <autodoc>SetStart(self, String start)
</autodoc>
30983 <param name=
"start" type=
"String" default=
""/>
30986 <method name=
"GetFullPath" type=
"String" overloaded=
"no">
30987 <autodoc>GetFullPath(self, String page) -
> String
</autodoc>
30989 <param name=
"page" type=
"String" default=
""/>
30993 <class name=
"HtmlContentsItem" oldname=
"wxHtmlContentsItem" module=
"html">
30994 <method name=
"GetLevel" type=
"int" overloaded=
"no">
30995 <autodoc>GetLevel(self) -
> int
</autodoc>
30997 <method name=
"GetID" type=
"int" overloaded=
"no">
30998 <autodoc>GetID(self) -
> int
</autodoc>
31000 <method name=
"GetName" type=
"String" overloaded=
"no">
31001 <autodoc>GetName(self) -
> String
</autodoc>
31003 <method name=
"GetPage" type=
"String" overloaded=
"no">
31004 <autodoc>GetPage(self) -
> String
</autodoc>
31006 <method name=
"GetBook" type=
"HtmlBookRecord" overloaded=
"no">
31007 <autodoc>GetBook(self) -
> HtmlBookRecord
</autodoc>
31010 <class name=
"HtmlSearchStatus" oldname=
"wxHtmlSearchStatus" module=
"html">
31011 <method name=
"Search" type=
"bool" overloaded=
"no">
31012 <autodoc>Search(self) -
> bool
</autodoc>
31014 <method name=
"IsActive" type=
"bool" overloaded=
"no">
31015 <autodoc>IsActive(self) -
> bool
</autodoc>
31017 <method name=
"GetCurIndex" type=
"int" overloaded=
"no">
31018 <autodoc>GetCurIndex(self) -
> int
</autodoc>
31020 <method name=
"GetMaxIndex" type=
"int" overloaded=
"no">
31021 <autodoc>GetMaxIndex(self) -
> int
</autodoc>
31023 <method name=
"GetName" type=
"String" overloaded=
"no">
31024 <autodoc>GetName(self) -
> String
</autodoc>
31026 <method name=
"GetContentsItem" type=
"HtmlContentsItem" overloaded=
"no">
31027 <autodoc>GetContentsItem(self) -
> HtmlContentsItem
</autodoc>
31030 <class name=
"HtmlHelpData" oldname=
"wxHtmlHelpData" module=
"html">
31031 <constructor name=
"HtmlHelpData" overloaded=
"no">
31032 <autodoc>__init__(self) -
> HtmlHelpData
</autodoc>
31034 <destructor name=
"~wxHtmlHelpData" overloaded=
"no">
31035 <autodoc>__del__(self)
</autodoc>
31037 <method name=
"SetTempDir" type=
"" overloaded=
"no">
31038 <autodoc>SetTempDir(self, String path)
</autodoc>
31040 <param name=
"path" type=
"String" default=
""/>
31043 <method name=
"AddBook" type=
"bool" overloaded=
"no">
31044 <autodoc>AddBook(self, String book) -
> bool
</autodoc>
31046 <param name=
"book" type=
"String" default=
""/>
31049 <method name=
"FindPageByName" type=
"String" overloaded=
"no">
31050 <autodoc>FindPageByName(self, String page) -
> String
</autodoc>
31052 <param name=
"page" type=
"String" default=
""/>
31055 <method name=
"FindPageById" type=
"String" overloaded=
"no">
31056 <autodoc>FindPageById(self, int id) -
> String
</autodoc>
31058 <param name=
"id" type=
"int" default=
""/>
31061 <method name=
"GetBookRecArray" type=
"wxHtmlBookRecArray" overloaded=
"no">
31062 <autodoc>GetBookRecArray(self) -
> wxHtmlBookRecArray
</autodoc>
31064 <method name=
"GetContents" type=
"HtmlContentsItem" overloaded=
"no">
31065 <autodoc>GetContents(self) -
> HtmlContentsItem
</autodoc>
31067 <method name=
"GetContentsCnt" type=
"int" overloaded=
"no">
31068 <autodoc>GetContentsCnt(self) -
> int
</autodoc>
31070 <method name=
"GetIndex" type=
"HtmlContentsItem" overloaded=
"no">
31071 <autodoc>GetIndex(self) -
> HtmlContentsItem
</autodoc>
31073 <method name=
"GetIndexCnt" type=
"int" overloaded=
"no">
31074 <autodoc>GetIndexCnt(self) -
> int
</autodoc>
31077 <class name=
"HtmlHelpFrame" oldname=
"wxHtmlHelpFrame" module=
"html">
31078 <baseclass name=
"Frame"/>
31079 <constructor name=
"HtmlHelpFrame" overloaded=
"no">
31080 <autodoc>__init__(self, Window parent, int ??, String title=EmptyString, int style=HF_DEFAULTSTYLE,
31081 HtmlHelpData data=None) -
> HtmlHelpFrame
</autodoc>
31083 <param name=
"parent" type=
"Window" default=
""/>
31084 <param name=
"" type=
"int" default=
""/>
31085 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
31086 <param name=
"style" type=
"int" default=
"wxHF_DEFAULTSTYLE"/>
31087 <param name=
"data" type=
"HtmlHelpData" default=
"NULL"/>
31090 <method name=
"GetData" type=
"HtmlHelpData" overloaded=
"no">
31091 <autodoc>GetData(self) -
> HtmlHelpData
</autodoc>
31093 <method name=
"SetTitleFormat" type=
"" overloaded=
"no">
31094 <autodoc>SetTitleFormat(self, String format)
</autodoc>
31096 <param name=
"format" type=
"String" default=
""/>
31099 <method name=
"Display" type=
"" overloaded=
"no">
31100 <autodoc>Display(self, String x)
</autodoc>
31102 <param name=
"x" type=
"String" default=
""/>
31105 <method name=
"DisplayID" type=
"" overloaded=
"no">
31106 <autodoc>DisplayID(self, int id)
</autodoc>
31108 <param name=
"id" type=
"int" default=
""/>
31111 <method name=
"DisplayContents" type=
"" overloaded=
"no">
31112 <autodoc>DisplayContents(self)
</autodoc>
31114 <method name=
"DisplayIndex" type=
"" overloaded=
"no">
31115 <autodoc>DisplayIndex(self)
</autodoc>
31117 <method name=
"KeywordSearch" type=
"bool" overloaded=
"no">
31118 <autodoc>KeywordSearch(self, String keyword) -
> bool
</autodoc>
31120 <param name=
"keyword" type=
"String" default=
""/>
31123 <method name=
"UseConfig" type=
"" overloaded=
"no">
31124 <autodoc>UseConfig(self, ConfigBase config, String rootpath=EmptyString)
</autodoc>
31126 <param name=
"config" type=
"ConfigBase" default=
""/>
31127 <param name=
"rootpath" type=
"String" default=
"wxPyEmptyString"/>
31130 <method name=
"ReadCustomization" type=
"" overloaded=
"no">
31131 <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)
</autodoc>
31133 <param name=
"cfg" type=
"ConfigBase" default=
""/>
31134 <param name=
"path" type=
"String" default=
"wxPyEmptyString"/>
31137 <method name=
"WriteCustomization" type=
"" overloaded=
"no">
31138 <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)
</autodoc>
31140 <param name=
"cfg" type=
"ConfigBase" default=
""/>
31141 <param name=
"path" type=
"String" default=
"wxPyEmptyString"/>
31145 <class name=
"HtmlHelpController" oldname=
"wxHtmlHelpController" module=
"html">
31146 <baseclass name=
"EvtHandler"/>
31147 <constructor name=
"HtmlHelpController" overloaded=
"no">
31148 <autodoc>__init__(self, int style=HF_DEFAULTSTYLE) -
> HtmlHelpController
</autodoc>
31150 <param name=
"style" type=
"int" default=
"wxHF_DEFAULTSTYLE"/>
31153 <destructor name=
"~wxHtmlHelpController" overloaded=
"no">
31154 <autodoc>__del__(self)
</autodoc>
31156 <method name=
"SetTitleFormat" type=
"" overloaded=
"no">
31157 <autodoc>SetTitleFormat(self, String format)
</autodoc>
31159 <param name=
"format" type=
"String" default=
""/>
31162 <method name=
"SetTempDir" type=
"" overloaded=
"no">
31163 <autodoc>SetTempDir(self, String path)
</autodoc>
31165 <param name=
"path" type=
"String" default=
""/>
31168 <method name=
"AddBook" type=
"bool" overloaded=
"no">
31169 <autodoc>AddBook(self, String book, int show_wait_msg=False) -
> bool
</autodoc>
31171 <param name=
"book" type=
"String" default=
""/>
31172 <param name=
"show_wait_msg" type=
"int" default=
"False"/>
31175 <method name=
"Display" type=
"" overloaded=
"no">
31176 <autodoc>Display(self, String x)
</autodoc>
31178 <param name=
"x" type=
"String" default=
""/>
31181 <method name=
"DisplayID" type=
"" overloaded=
"no">
31182 <autodoc>DisplayID(self, int id)
</autodoc>
31184 <param name=
"id" type=
"int" default=
""/>
31187 <method name=
"DisplayContents" type=
"" overloaded=
"no">
31188 <autodoc>DisplayContents(self)
</autodoc>
31190 <method name=
"DisplayIndex" type=
"" overloaded=
"no">
31191 <autodoc>DisplayIndex(self)
</autodoc>
31193 <method name=
"KeywordSearch" type=
"bool" overloaded=
"no">
31194 <autodoc>KeywordSearch(self, String keyword) -
> bool
</autodoc>
31196 <param name=
"keyword" type=
"String" default=
""/>
31199 <method name=
"UseConfig" type=
"" overloaded=
"no">
31200 <autodoc>UseConfig(self, ConfigBase config, String rootpath=EmptyString)
</autodoc>
31202 <param name=
"config" type=
"ConfigBase" default=
""/>
31203 <param name=
"rootpath" type=
"String" default=
"wxPyEmptyString"/>
31206 <method name=
"ReadCustomization" type=
"" overloaded=
"no">
31207 <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)
</autodoc>
31209 <param name=
"cfg" type=
"ConfigBase" default=
""/>
31210 <param name=
"path" type=
"String" default=
"wxPyEmptyString"/>
31213 <method name=
"WriteCustomization" type=
"" overloaded=
"no">
31214 <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)
</autodoc>
31216 <param name=
"cfg" type=
"ConfigBase" default=
""/>
31217 <param name=
"path" type=
"String" default=
"wxPyEmptyString"/>
31220 <method name=
"GetFrame" type=
"HtmlHelpFrame" overloaded=
"no">
31221 <autodoc>GetFrame(self) -
> HtmlHelpFrame
</autodoc>
31225 <module name=
"wizard">
31226 <import name=
"_windows"/>
31227 <pythoncode> wx = _core
</pythoncode>
31228 <pythoncode> __docfilter__ = wx.__DocFilter(globals())
</pythoncode>
31230 EVT_WIZARD_PAGE_CHANGED = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGED,
1)
31231 EVT_WIZARD_PAGE_CHANGING = wx.PyEventBinder( wxEVT_WIZARD_PAGE_CHANGING,
1)
31232 EVT_WIZARD_CANCEL = wx.PyEventBinder( wxEVT_WIZARD_CANCEL,
1)
31233 EVT_WIZARD_HELP = wx.PyEventBinder( wxEVT_WIZARD_HELP,
1)
31234 EVT_WIZARD_FINISHED = wx.PyEventBinder( wxEVT_WIZARD_FINISHED,
1)
31236 <class name=
"WizardEvent" oldname=
"wxWizardEvent" module=
"wizard">
31237 <baseclass name=
"NotifyEvent"/>
31238 <constructor name=
"WizardEvent" overloaded=
"no">
31239 <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int id=-
1, bool direction=True,
31240 WizardPage page=None) -
> WizardEvent
</autodoc>
31242 <param name=
"type" type=
"wxEventType" default=
"wxEVT_NULL"/>
31243 <param name=
"id" type=
"int" default=
"-1"/>
31244 <param name=
"direction" type=
"bool" default=
"True"/>
31245 <param name=
"page" type=
"wxWizardPage" default=
"NULL"/>
31248 <method name=
"GetDirection" type=
"bool" overloaded=
"no">
31249 <autodoc>GetDirection(self) -
> bool
</autodoc>
31251 <method name=
"GetPage" type=
"wxWizardPage" overloaded=
"no">
31252 <autodoc>GetPage(self) -
> WizardPage
</autodoc>
31255 <class name=
"WizardPage" oldname=
"wxWizardPage" module=
"wizard">
31256 <baseclass name=
"Panel"/>
31257 <method name=
"Create" type=
"bool" overloaded=
"no">
31258 <autodoc>Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -
> bool
</autodoc>
31260 <param name=
"parent" type=
"wxWizard" default=
""/>
31261 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
31262 <param name=
"resource" type=
"String" default=
"wxPyEmptyString"/>
31265 <method name=
"GetPrev" type=
"WizardPage" overloaded=
"no">
31266 <autodoc>GetPrev(self) -
> WizardPage
</autodoc>
31268 <method name=
"GetNext" type=
"WizardPage" overloaded=
"no">
31269 <autodoc>GetNext(self) -
> WizardPage
</autodoc>
31271 <method name=
"GetBitmap" type=
"Bitmap" overloaded=
"no">
31272 <autodoc>GetBitmap(self) -
> Bitmap
</autodoc>
31275 <class name=
"PyWizardPage" oldname=
"wxPyWizardPage" module=
"wizard">
31276 <baseclass name=
"WizardPage"/>
31277 <constructor name=
"PyWizardPage" overloaded=
"no">
31278 <autodoc>__init__(self, Wizard parent, Bitmap bitmap=
&wxNullBitmap, String resource=
&wxPyEmptyString) -
> PyWizardPage
</autodoc>
31280 <param name=
"parent" type=
"wxWizard" default=
""/>
31281 <param name=
"bitmap" type=
"Bitmap" default=
"&wxNullBitmap"/>
31282 <param name=
"resource" type=
"String" default=
"&wxPyEmptyString"/>
31285 <constructor name=
"PrePyWizardPage" overloaded=
"no">
31286 <autodoc>PrePyWizardPage() -
> PyWizardPage
</autodoc>
31288 <method name=
"Create" type=
"bool" overloaded=
"no">
31289 <autodoc>Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -
> bool
</autodoc>
31291 <param name=
"parent" type=
"wxWizard" default=
""/>
31292 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
31293 <param name=
"resource" type=
"String" default=
"wxPyEmptyString"/>
31296 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
31297 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
31299 <param name=
"self" type=
"PyObject" default=
""/>
31300 <param name=
"_class" type=
"PyObject" default=
""/>
31303 <method name=
"base_DoMoveWindow" type=
"" overloaded=
"no">
31304 <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)
</autodoc>
31306 <param name=
"x" type=
"int" default=
""/>
31307 <param name=
"y" type=
"int" default=
""/>
31308 <param name=
"width" type=
"int" default=
""/>
31309 <param name=
"height" type=
"int" default=
""/>
31312 <method name=
"base_DoSetSize" type=
"" overloaded=
"no">
31313 <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)
</autodoc>
31315 <param name=
"x" type=
"int" default=
""/>
31316 <param name=
"y" type=
"int" default=
""/>
31317 <param name=
"width" type=
"int" default=
""/>
31318 <param name=
"height" type=
"int" default=
""/>
31319 <param name=
"sizeFlags" type=
"int" default=
"wxSIZE_AUTO"/>
31322 <method name=
"base_DoSetClientSize" type=
"" overloaded=
"no">
31323 <autodoc>base_DoSetClientSize(self, int width, int height)
</autodoc>
31325 <param name=
"width" type=
"int" default=
""/>
31326 <param name=
"height" type=
"int" default=
""/>
31329 <method name=
"base_DoSetVirtualSize" type=
"" overloaded=
"no">
31330 <autodoc>base_DoSetVirtualSize(self, int x, int y)
</autodoc>
31332 <param name=
"x" type=
"int" default=
""/>
31333 <param name=
"y" type=
"int" default=
""/>
31336 <method name=
"base_DoGetSize" type=
"" overloaded=
"no">
31337 <autodoc>base_DoGetSize() -
> (width, height)
</autodoc>
31339 <param name=
"OUTPUT" type=
"int" default=
""/>
31340 <param name=
"OUTPUT" type=
"int" default=
""/>
31343 <method name=
"base_DoGetClientSize" type=
"" overloaded=
"no">
31344 <autodoc>base_DoGetClientSize() -
> (width, height)
</autodoc>
31346 <param name=
"OUTPUT" type=
"int" default=
""/>
31347 <param name=
"OUTPUT" type=
"int" default=
""/>
31350 <method name=
"base_DoGetPosition" type=
"" overloaded=
"no">
31351 <autodoc>base_DoGetPosition() -
> (x,y)
</autodoc>
31353 <param name=
"OUTPUT" type=
"int" default=
""/>
31354 <param name=
"OUTPUT" type=
"int" default=
""/>
31357 <method name=
"base_DoGetVirtualSize" type=
"Size" overloaded=
"no">
31358 <autodoc>base_DoGetVirtualSize(self) -
> Size
</autodoc>
31360 <method name=
"base_DoGetBestSize" type=
"Size" overloaded=
"no">
31361 <autodoc>base_DoGetBestSize(self) -
> Size
</autodoc>
31363 <method name=
"base_InitDialog" type=
"" overloaded=
"no">
31364 <autodoc>base_InitDialog(self)
</autodoc>
31366 <method name=
"base_TransferDataToWindow" type=
"bool" overloaded=
"no">
31367 <autodoc>base_TransferDataToWindow(self) -
> bool
</autodoc>
31369 <method name=
"base_TransferDataFromWindow" type=
"bool" overloaded=
"no">
31370 <autodoc>base_TransferDataFromWindow(self) -
> bool
</autodoc>
31372 <method name=
"base_Validate" type=
"bool" overloaded=
"no">
31373 <autodoc>base_Validate(self) -
> bool
</autodoc>
31375 <method name=
"base_AcceptsFocus" type=
"bool" overloaded=
"no">
31376 <autodoc>base_AcceptsFocus(self) -
> bool
</autodoc>
31378 <method name=
"base_AcceptsFocusFromKeyboard" type=
"bool" overloaded=
"no">
31379 <autodoc>base_AcceptsFocusFromKeyboard(self) -
> bool
</autodoc>
31381 <method name=
"base_GetMaxSize" type=
"Size" overloaded=
"no">
31382 <autodoc>base_GetMaxSize(self) -
> Size
</autodoc>
31384 <method name=
"base_AddChild" type=
"" overloaded=
"no">
31385 <autodoc>base_AddChild(self, Window child)
</autodoc>
31387 <param name=
"child" type=
"Window" default=
""/>
31390 <method name=
"base_RemoveChild" type=
"" overloaded=
"no">
31391 <autodoc>base_RemoveChild(self, Window child)
</autodoc>
31393 <param name=
"child" type=
"Window" default=
""/>
31397 <class name=
"WizardPageSimple" oldname=
"wxWizardPageSimple" module=
"wizard">
31398 <baseclass name=
"WizardPage"/>
31399 <constructor name=
"WizardPageSimple" overloaded=
"no">
31400 <autodoc>__init__(self, Wizard parent, WizardPage prev=None, WizardPage next=None,
31401 Bitmap bitmap=wxNullBitmap, wxChar resource=None) -
> WizardPageSimple
</autodoc>
31403 <param name=
"parent" type=
"wxWizard" default=
""/>
31404 <param name=
"prev" type=
"WizardPage" default=
"NULL"/>
31405 <param name=
"next" type=
"WizardPage" default=
"NULL"/>
31406 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
31407 <param name=
"resource" type=
"wxChar" default=
"NULL"/>
31410 <constructor name=
"PreWizardPageSimple" overloaded=
"no">
31411 <autodoc>PreWizardPageSimple() -
> WizardPageSimple
</autodoc>
31413 <method name=
"Create" type=
"bool" overloaded=
"no">
31414 <autodoc>Create(self, Wizard parent=None, WizardPage prev=None, WizardPage next=None,
31415 Bitmap bitmap=wxNullBitmap, wxChar resource=None) -
> bool
</autodoc>
31417 <param name=
"parent" type=
"wxWizard" default=
"NULL"/>
31418 <param name=
"prev" type=
"WizardPage" default=
"NULL"/>
31419 <param name=
"next" type=
"WizardPage" default=
"NULL"/>
31420 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
31421 <param name=
"resource" type=
"wxChar" default=
"NULL"/>
31424 <method name=
"SetPrev" type=
"" overloaded=
"no">
31425 <autodoc>SetPrev(self, WizardPage prev)
</autodoc>
31427 <param name=
"prev" type=
"WizardPage" default=
""/>
31430 <method name=
"SetNext" type=
"" overloaded=
"no">
31431 <autodoc>SetNext(self, WizardPage next)
</autodoc>
31433 <param name=
"next" type=
"WizardPage" default=
""/>
31436 <staticmethod name=
"Chain" type=
"" overloaded=
"no">
31437 <autodoc>Chain(WizardPageSimple first, WizardPageSimple second)
</autodoc>
31439 <param name=
"first" type=
"WizardPageSimple" default=
""/>
31440 <param name=
"second" type=
"WizardPageSimple" default=
""/>
31444 <class name=
"Wizard" oldname=
"wxWizard" module=
"wizard">
31445 <baseclass name=
"Dialog"/>
31446 <constructor name=
"Wizard" overloaded=
"no">
31447 <autodoc>__init__(self, Window parent, int id=-
1, String title=EmptyString,
31448 Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition,
31449 long style=DEFAULT_DIALOG_STYLE) -
> Wizard
</autodoc>
31451 <param name=
"parent" type=
"Window" default=
""/>
31452 <param name=
"id" type=
"int" default=
"-1"/>
31453 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
31454 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
31455 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
31456 <param name=
"style" type=
"long" default=
"wxDEFAULT_DIALOG_STYLE"/>
31459 <constructor name=
"PreWizard" overloaded=
"no">
31460 <autodoc>PreWizard() -
> Wizard
</autodoc>
31462 <method name=
"Create" type=
"bool" overloaded=
"no">
31463 <autodoc>Create(self, Window parent, int id=-
1, String title=EmptyString,
31464 Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition) -
> bool
</autodoc>
31466 <param name=
"parent" type=
"Window" default=
""/>
31467 <param name=
"id" type=
"int" default=
"-1"/>
31468 <param name=
"title" type=
"String" default=
"wxPyEmptyString"/>
31469 <param name=
"bitmap" type=
"Bitmap" default=
"wxNullBitmap"/>
31470 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
31473 <method name=
"Init" type=
"" overloaded=
"no">
31474 <autodoc>Init(self)
</autodoc>
31476 <method name=
"RunWizard" type=
"bool" overloaded=
"no">
31477 <autodoc>RunWizard(self, WizardPage firstPage) -
> bool
</autodoc>
31479 <param name=
"firstPage" type=
"WizardPage" default=
""/>
31482 <method name=
"GetCurrentPage" type=
"WizardPage" overloaded=
"no">
31483 <autodoc>GetCurrentPage(self) -
> WizardPage
</autodoc>
31485 <method name=
"SetPageSize" type=
"" overloaded=
"no">
31486 <autodoc>SetPageSize(self, Size size)
</autodoc>
31488 <param name=
"size" type=
"Size" default=
""/>
31491 <method name=
"GetPageSize" type=
"Size" overloaded=
"no">
31492 <autodoc>GetPageSize(self) -
> Size
</autodoc>
31494 <method name=
"FitToPage" type=
"" overloaded=
"no">
31495 <autodoc>FitToPage(self, WizardPage firstPage)
</autodoc>
31497 <param name=
"firstPage" type=
"WizardPage" default=
""/>
31500 <method name=
"GetPageAreaSizer" type=
"Sizer" overloaded=
"no">
31501 <autodoc>GetPageAreaSizer(self) -
> Sizer
</autodoc>
31503 <method name=
"SetBorder" type=
"" overloaded=
"no">
31504 <autodoc>SetBorder(self, int border)
</autodoc>
31506 <param name=
"border" type=
"int" default=
""/>
31509 <method name=
"IsRunning" type=
"bool" overloaded=
"no">
31510 <autodoc>IsRunning(self) -
> bool
</autodoc>
31512 <method name=
"ShowPage" type=
"bool" overloaded=
"no">
31513 <autodoc>ShowPage(self, WizardPage page, bool goingForward=True) -
> bool
</autodoc>
31515 <param name=
"page" type=
"WizardPage" default=
""/>
31516 <param name=
"goingForward" type=
"bool" default=
"True"/>
31519 <method name=
"HasNextPage" type=
"bool" overloaded=
"no">
31520 <autodoc>HasNextPage(self, WizardPage page) -
> bool
</autodoc>
31522 <param name=
"page" type=
"WizardPage" default=
""/>
31525 <method name=
"HasPrevPage" type=
"bool" overloaded=
"no">
31526 <autodoc>HasPrevPage(self, WizardPage page) -
> bool
</autodoc>
31528 <param name=
"page" type=
"WizardPage" default=
""/>
31533 <module name=
"glcanvas">
31534 <import name=
"_core"/>
31535 <pythoncode> wx = _core
</pythoncode>
31536 <pythoncode> __docfilter__ = wx.__DocFilter(globals())
</pythoncode>
31537 <class name=
"GLContext" oldname=
"wxGLContext" module=
"glcanvas">
31538 <baseclass name=
"Object"/>
31539 <constructor name=
"GLContext" overloaded=
"no">
31540 <autodoc>__init__(self, bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette,
31541 GLContext other=None) -
> GLContext
</autodoc>
31543 <param name=
"isRGB" type=
"bool" default=
""/>
31544 <param name=
"win" type=
"wxGLCanvas" default=
""/>
31545 <param name=
"palette" type=
"Palette" default=
"wxNullPalette"/>
31546 <param name=
"other" type=
"GLContext" default=
"NULL"/>
31549 <destructor name=
"~wxGLContext" overloaded=
"no">
31550 <autodoc>__del__(self)
</autodoc>
31552 <method name=
"SetCurrent" type=
"" overloaded=
"no">
31553 <autodoc>SetCurrent(self)
</autodoc>
31555 <method name=
"SetColour" type=
"" overloaded=
"no">
31556 <autodoc>SetColour(self, String colour)
</autodoc>
31558 <param name=
"colour" type=
"String" default=
""/>
31561 <method name=
"SwapBuffers" type=
"" overloaded=
"no">
31562 <autodoc>SwapBuffers(self)
</autodoc>
31564 <method name=
"SetupPixelFormat" type=
"" overloaded=
"no">
31565 <autodoc>SetupPixelFormat(self)
</autodoc>
31567 <method name=
"SetupPalette" type=
"" overloaded=
"no">
31568 <autodoc>SetupPalette(self, wxPalette palette)
</autodoc>
31570 <param name=
"palette" type=
"Palette" default=
""/>
31573 <method name=
"CreateDefaultPalette" type=
"Palette" overloaded=
"no">
31574 <autodoc>CreateDefaultPalette(self) -
> wxPalette
</autodoc>
31576 <method name=
"GetPalette" type=
"Palette" overloaded=
"no">
31577 <autodoc>GetPalette(self) -
> wxPalette
</autodoc>
31579 <method name=
"GetWindow" type=
"Window" overloaded=
"no">
31580 <autodoc>GetWindow(self) -
> Window
</autodoc>
31583 <class name=
"GLCanvas" oldname=
"wxGLCanvas" module=
"glcanvas">
31584 <baseclass name=
"Window"/>
31585 <constructor name=
"GLCanvas" overloaded=
"no">
31586 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
31587 Size size=DefaultSize, long style=
0, String name=GLCanvasNameStr,
31588 int attribList=None, wxPalette palette=wxNullPalette) -
> GLCanvas
</autodoc>
31590 <param name=
"parent" type=
"Window" default=
""/>
31591 <param name=
"id" type=
"int" default=
"-1"/>
31592 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
31593 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
31594 <param name=
"style" type=
"long" default=
"0"/>
31595 <param name=
"name" type=
"String" default=
"wxPyGLCanvasNameStr"/>
31596 <param name=
"attribList" type=
"int" default=
"NULL"/>
31597 <param name=
"palette" type=
"Palette" default=
"wxNullPalette"/>
31600 <constructor name=
"GLCanvasWithContext" overloaded=
"no">
31601 <autodoc>GLCanvasWithContext(Window parent, GLContext shared=None, int id=-
1, Point pos=DefaultPosition,
31602 Size size=DefaultSize,
31603 long style=
0, String name=GLCanvasNameStr,
31604 int attribList=None, wxPalette palette=wxNullPalette) -
> GLCanvas
</autodoc>
31606 <param name=
"parent" type=
"Window" default=
""/>
31607 <param name=
"shared" type=
"GLContext" default=
"NULL"/>
31608 <param name=
"id" type=
"int" default=
"-1"/>
31609 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
31610 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
31611 <param name=
"style" type=
"long" default=
"0"/>
31612 <param name=
"name" type=
"String" default=
"wxPyGLCanvasNameStr"/>
31613 <param name=
"attribList" type=
"int" default=
"NULL"/>
31614 <param name=
"palette" type=
"Palette" default=
"wxNullPalette"/>
31617 <method name=
"SetCurrent" type=
"" overloaded=
"no">
31618 <autodoc>SetCurrent(self)
</autodoc>
31620 <method name=
"SetColour" type=
"" overloaded=
"no">
31621 <autodoc>SetColour(self, String colour)
</autodoc>
31623 <param name=
"colour" type=
"String" default=
""/>
31626 <method name=
"SwapBuffers" type=
"" overloaded=
"no">
31627 <autodoc>SwapBuffers(self)
</autodoc>
31629 <method name=
"GetContext" type=
"GLContext" overloaded=
"no">
31630 <autodoc>GetContext(self) -
> GLContext
</autodoc>
31634 <module name=
"ogl">
31635 <import name=
"_windows"/>
31636 <pythoncode> wx = _core
</pythoncode>
31637 <pythoncode> __docfilter__ = wx.__DocFilter(globals())
</pythoncode>
31640 warnings.warn("This module is deprecated. Please use the wx.lib.ogl package instead.",
31641 DeprecationWarning, stacklevel=
2)
31644 #---------------------------------------------------------------------------
31646 <class name=
"ShapeRegion" oldname=
"wxShapeRegion" module=
"ogl">
31647 <baseclass name=
"Object"/>
31648 <constructor name=
"ShapeRegion" overloaded=
"no">
31649 <autodoc>__init__(self) -
> ShapeRegion
</autodoc>
31651 <method name=
"SetText" type=
"" overloaded=
"no">
31652 <autodoc>SetText(self, String s)
</autodoc>
31654 <param name=
"s" type=
"String" default=
""/>
31657 <method name=
"SetFont" type=
"" overloaded=
"no">
31658 <autodoc>SetFont(self, Font f)
</autodoc>
31660 <param name=
"f" type=
"Font" default=
""/>
31663 <method name=
"SetMinSize" type=
"" overloaded=
"no">
31664 <autodoc>SetMinSize(self, double w, double h)
</autodoc>
31666 <param name=
"w" type=
"double" default=
""/>
31667 <param name=
"h" type=
"double" default=
""/>
31670 <method name=
"SetSize" type=
"" overloaded=
"no">
31671 <autodoc>SetSize(self, double w, double h)
</autodoc>
31673 <param name=
"w" type=
"double" default=
""/>
31674 <param name=
"h" type=
"double" default=
""/>
31677 <method name=
"SetPosition" type=
"" overloaded=
"no">
31678 <autodoc>SetPosition(self, double x, double y)
</autodoc>
31680 <param name=
"x" type=
"double" default=
""/>
31681 <param name=
"y" type=
"double" default=
""/>
31684 <method name=
"SetProportions" type=
"" overloaded=
"no">
31685 <autodoc>SetProportions(self, double x, double y)
</autodoc>
31687 <param name=
"x" type=
"double" default=
""/>
31688 <param name=
"y" type=
"double" default=
""/>
31691 <method name=
"SetFormatMode" type=
"" overloaded=
"no">
31692 <autodoc>SetFormatMode(self, int mode)
</autodoc>
31694 <param name=
"mode" type=
"int" default=
""/>
31697 <method name=
"SetName" type=
"" overloaded=
"no">
31698 <autodoc>SetName(self, String s)
</autodoc>
31700 <param name=
"s" type=
"String" default=
""/>
31703 <method name=
"SetColour" type=
"" overloaded=
"no">
31704 <autodoc>SetColour(self, String col)
</autodoc>
31706 <param name=
"col" type=
"String" default=
""/>
31709 <method name=
"GetText" type=
"String" overloaded=
"no">
31710 <autodoc>GetText(self) -
> String
</autodoc>
31712 <method name=
"GetFont" type=
"Font" overloaded=
"no">
31713 <autodoc>GetFont(self) -
> Font
</autodoc>
31715 <method name=
"GetMinSize" type=
"" overloaded=
"no">
31716 <autodoc>GetMinSize(self, double OUTPUT, double OUTPUT)
</autodoc>
31718 <param name=
"OUTPUT" type=
"double" default=
""/>
31719 <param name=
"OUTPUT" type=
"double" default=
""/>
31722 <method name=
"GetProportion" type=
"" overloaded=
"no">
31723 <autodoc>GetProportion(self, double OUTPUT, double OUTPUT)
</autodoc>
31725 <param name=
"OUTPUT" type=
"double" default=
""/>
31726 <param name=
"OUTPUT" type=
"double" default=
""/>
31729 <method name=
"GetSize" type=
"" overloaded=
"no">
31730 <autodoc>GetSize(self, double OUTPUT, double OUTPUT)
</autodoc>
31732 <param name=
"OUTPUT" type=
"double" default=
""/>
31733 <param name=
"OUTPUT" type=
"double" default=
""/>
31736 <method name=
"GetPosition" type=
"" overloaded=
"no">
31737 <autodoc>GetPosition(self, double OUTPUT, double OUTPUT)
</autodoc>
31739 <param name=
"OUTPUT" type=
"double" default=
""/>
31740 <param name=
"OUTPUT" type=
"double" default=
""/>
31743 <method name=
"GetFormatMode" type=
"int" overloaded=
"no">
31744 <autodoc>GetFormatMode(self) -
> int
</autodoc>
31746 <method name=
"GetName" type=
"String" overloaded=
"no">
31747 <autodoc>GetName(self) -
> String
</autodoc>
31749 <method name=
"GetColour" type=
"String" overloaded=
"no">
31750 <autodoc>GetColour(self) -
> String
</autodoc>
31752 <method name=
"GetActualColourObject" type=
"Colour" overloaded=
"no">
31753 <autodoc>GetActualColourObject(self) -
> Colour
</autodoc>
31755 <method name=
"GetFormattedText" type=
"wxList" overloaded=
"no">
31756 <autodoc>GetFormattedText(self) -
> wxList
</autodoc>
31758 <method name=
"GetPenColour" type=
"String" overloaded=
"no">
31759 <autodoc>GetPenColour(self) -
> String
</autodoc>
31761 <method name=
"GetPenStyle" type=
"int" overloaded=
"no">
31762 <autodoc>GetPenStyle(self) -
> int
</autodoc>
31764 <method name=
"SetPenStyle" type=
"" overloaded=
"no">
31765 <autodoc>SetPenStyle(self, int style)
</autodoc>
31767 <param name=
"style" type=
"int" default=
""/>
31770 <method name=
"SetPenColour" type=
"" overloaded=
"no">
31771 <autodoc>SetPenColour(self, String col)
</autodoc>
31773 <param name=
"col" type=
"String" default=
""/>
31776 <method name=
"GetActualPen" type=
"Pen" overloaded=
"no">
31777 <autodoc>GetActualPen(self) -
> wxPen
</autodoc>
31779 <method name=
"GetWidth" type=
"double" overloaded=
"no">
31780 <autodoc>GetWidth(self) -
> double
</autodoc>
31782 <method name=
"GetHeight" type=
"double" overloaded=
"no">
31783 <autodoc>GetHeight(self) -
> double
</autodoc>
31785 <method name=
"ClearText" type=
"" overloaded=
"no">
31786 <autodoc>ClearText(self)
</autodoc>
31789 <class name=
"AttachmentPoint" oldname=
"wxAttachmentPoint" module=
"ogl">
31790 <baseclass name=
"Object"/>
31791 <constructor name=
"AttachmentPoint" overloaded=
"no">
31792 <autodoc>__init__(self, int id=
0, double x=
0.0, double y=
0.0) -
> AttachmentPoint
</autodoc>
31794 <param name=
"id" type=
"int" default=
"0"/>
31795 <param name=
"x" type=
"double" default=
"0.0"/>
31796 <param name=
"y" type=
"double" default=
"0.0"/>
31799 <property name=
"m_id" type=
"int" readonly=
"no"/>
31800 <property name=
"m_x" type=
"double" readonly=
"no"/>
31801 <property name=
"m_y" type=
"double" readonly=
"no"/>
31803 <class name=
"PyShapeEvtHandler" oldname=
"wxPyShapeEvtHandler" module=
"ogl">
31804 <baseclass name=
"Object"/>
31805 <constructor name=
"PyShapeEvtHandler" overloaded=
"no">
31806 <autodoc>__init__(self, PyShapeEvtHandler prev=None, PyShape shape=None) -
> PyShapeEvtHandler
</autodoc>
31808 <param name=
"prev" type=
"PyShapeEvtHandler" default=
"NULL"/>
31809 <param name=
"shape" type=
"wxPyShape" default=
"NULL"/>
31812 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
31813 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
31815 <param name=
"self" type=
"PyObject" default=
""/>
31816 <param name=
"_class" type=
"PyObject" default=
""/>
31819 <method name=
"_setOORInfo" type=
"" overloaded=
"no">
31820 <autodoc>_setOORInfo(self, PyObject _self)
</autodoc>
31822 <param name=
"_self" type=
"PyObject" default=
""/>
31825 <method name=
"SetShape" type=
"" overloaded=
"no">
31826 <autodoc>SetShape(self, PyShape sh)
</autodoc>
31828 <param name=
"sh" type=
"wxPyShape" default=
""/>
31831 <method name=
"GetShape" type=
"wxPyShape" overloaded=
"no">
31832 <autodoc>GetShape(self) -
> PyShape
</autodoc>
31834 <method name=
"SetPreviousHandler" type=
"" overloaded=
"no">
31835 <autodoc>SetPreviousHandler(self, PyShapeEvtHandler handler)
</autodoc>
31837 <param name=
"handler" type=
"PyShapeEvtHandler" default=
""/>
31840 <method name=
"GetPreviousHandler" type=
"PyShapeEvtHandler" overloaded=
"no">
31841 <autodoc>GetPreviousHandler(self) -
> PyShapeEvtHandler
</autodoc>
31843 <method name=
"CreateNewCopy" type=
"PyShapeEvtHandler" overloaded=
"no">
31844 <autodoc>CreateNewCopy(self) -
> PyShapeEvtHandler
</autodoc>
31846 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
31847 <autodoc>base_OnDelete(self)
</autodoc>
31849 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
31850 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
31852 <param name=
"dc" type=
"DC" default=
""/>
31855 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
31856 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
31858 <param name=
"dc" type=
"DC" default=
""/>
31861 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
31862 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=False)
</autodoc>
31864 <param name=
"dc" type=
"DC" default=
""/>
31865 <param name=
"erase" type=
"bool" default=
"False"/>
31868 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
31869 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
31871 <param name=
"dc" type=
"DC" default=
""/>
31874 <method name=
"base_OnErase" type=
"" overloaded=
"no">
31875 <autodoc>base_OnErase(self, DC dc)
</autodoc>
31877 <param name=
"dc" type=
"DC" default=
""/>
31880 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
31881 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
31883 <param name=
"dc" type=
"DC" default=
""/>
31886 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
31887 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
31889 <param name=
"dc" type=
"DC" default=
""/>
31892 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
31893 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
31895 <param name=
"x" type=
"double" default=
""/>
31896 <param name=
"y" type=
"double" default=
""/>
31897 <param name=
"keys" type=
"int" default=
"0"/>
31898 <param name=
"attachment" type=
"int" default=
"0"/>
31901 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
31902 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
31904 <param name=
"x" type=
"double" default=
""/>
31905 <param name=
"y" type=
"double" default=
""/>
31906 <param name=
"keys" type=
"int" default=
"0"/>
31907 <param name=
"attachment" type=
"int" default=
"0"/>
31910 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
31911 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
31913 <param name=
"x" type=
"double" default=
""/>
31914 <param name=
"y" type=
"double" default=
""/>
31915 <param name=
"keys" type=
"int" default=
"0"/>
31916 <param name=
"attachment" type=
"int" default=
"0"/>
31919 <method name=
"base_OnSize" type=
"" overloaded=
"no">
31920 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
31922 <param name=
"x" type=
"double" default=
""/>
31923 <param name=
"y" type=
"double" default=
""/>
31926 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
31927 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
31928 bool display=True) -
> bool
</autodoc>
31930 <param name=
"dc" type=
"DC" default=
""/>
31931 <param name=
"x" type=
"double" default=
""/>
31932 <param name=
"y" type=
"double" default=
""/>
31933 <param name=
"old_x" type=
"double" default=
""/>
31934 <param name=
"old_y" type=
"double" default=
""/>
31935 <param name=
"display" type=
"bool" default=
"True"/>
31938 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
31939 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
31940 bool display=True)
</autodoc>
31942 <param name=
"dc" type=
"DC" default=
""/>
31943 <param name=
"x" type=
"double" default=
""/>
31944 <param name=
"y" type=
"double" default=
""/>
31945 <param name=
"old_x" type=
"double" default=
""/>
31946 <param name=
"old_y" type=
"double" default=
""/>
31947 <param name=
"display" type=
"bool" default=
"True"/>
31950 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
31951 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
31953 <param name=
"draw" type=
"bool" default=
""/>
31954 <param name=
"x" type=
"double" default=
""/>
31955 <param name=
"y" type=
"double" default=
""/>
31956 <param name=
"keys" type=
"int" default=
"0"/>
31957 <param name=
"attachment" type=
"int" default=
"0"/>
31960 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
31961 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
31963 <param name=
"x" type=
"double" default=
""/>
31964 <param name=
"y" type=
"double" default=
""/>
31965 <param name=
"keys" type=
"int" default=
"0"/>
31966 <param name=
"attachment" type=
"int" default=
"0"/>
31969 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
31970 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
31972 <param name=
"x" type=
"double" default=
""/>
31973 <param name=
"y" type=
"double" default=
""/>
31974 <param name=
"keys" type=
"int" default=
"0"/>
31975 <param name=
"attachment" type=
"int" default=
"0"/>
31978 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
31979 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
31981 <param name=
"draw" type=
"bool" default=
""/>
31982 <param name=
"x" type=
"double" default=
""/>
31983 <param name=
"y" type=
"double" default=
""/>
31984 <param name=
"keys" type=
"int" default=
"0"/>
31985 <param name=
"attachment" type=
"int" default=
"0"/>
31988 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
31989 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
31991 <param name=
"x" type=
"double" default=
""/>
31992 <param name=
"y" type=
"double" default=
""/>
31993 <param name=
"keys" type=
"int" default=
"0"/>
31994 <param name=
"attachment" type=
"int" default=
"0"/>
31997 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
31998 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32000 <param name=
"x" type=
"double" default=
""/>
32001 <param name=
"y" type=
"double" default=
""/>
32002 <param name=
"keys" type=
"int" default=
"0"/>
32003 <param name=
"attachment" type=
"int" default=
"0"/>
32006 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
32007 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
32009 <param name=
"dc" type=
"DC" default=
""/>
32010 <param name=
"x" type=
"double" default=
""/>
32011 <param name=
"y" type=
"double" default=
""/>
32012 <param name=
"w" type=
"double" default=
""/>
32013 <param name=
"h" type=
"double" default=
""/>
32016 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
32017 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
32019 <param name=
"dc" type=
"DC" default=
""/>
32022 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
32023 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
32025 <param name=
"dc" type=
"DC" default=
""/>
32028 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
32029 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
32031 <param name=
"dc" type=
"DC" default=
""/>
32032 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
32035 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
32036 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
32037 int attachment=
0)
</autodoc>
32039 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
32040 <param name=
"draw" type=
"bool" default=
""/>
32041 <param name=
"x" type=
"double" default=
""/>
32042 <param name=
"y" type=
"double" default=
""/>
32043 <param name=
"keys" type=
"int" default=
"0"/>
32044 <param name=
"attachment" type=
"int" default=
"0"/>
32047 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
32048 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
32049 int attachment=
0)
</autodoc>
32051 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
32052 <param name=
"x" type=
"double" default=
""/>
32053 <param name=
"y" type=
"double" default=
""/>
32054 <param name=
"keys" type=
"int" default=
"0"/>
32055 <param name=
"attachment" type=
"int" default=
"0"/>
32058 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
32059 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
32060 int attachment=
0)
</autodoc>
32062 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
32063 <param name=
"x" type=
"double" default=
""/>
32064 <param name=
"y" type=
"double" default=
""/>
32065 <param name=
"keys" type=
"int" default=
"0"/>
32066 <param name=
"attachment" type=
"int" default=
"0"/>
32069 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
32070 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
32072 <param name=
"w" type=
"double" default=
""/>
32073 <param name=
"h" type=
"double" default=
""/>
32076 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
32077 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
32079 <param name=
"w" type=
"double" default=
""/>
32080 <param name=
"h" type=
"double" default=
""/>
32084 <class name=
"PyShape" oldname=
"wxPyShape" module=
"ogl">
32085 <baseclass name=
"PyShapeEvtHandler"/>
32086 <constructor name=
"PyShape" overloaded=
"no">
32087 <autodoc>__init__(self, PyShapeCanvas can=None) -
> PyShape
</autodoc>
32089 <param name=
"can" type=
"wxPyShapeCanvas" default=
"NULL"/>
32092 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
32093 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
32095 <param name=
"self" type=
"PyObject" default=
""/>
32096 <param name=
"_class" type=
"PyObject" default=
""/>
32099 <method name=
"GetBoundingBoxMax" type=
"" overloaded=
"no">
32100 <autodoc>GetBoundingBoxMax(self, double OUTPUT, double OUTPUT)
</autodoc>
32102 <param name=
"OUTPUT" type=
"double" default=
""/>
32103 <param name=
"OUTPUT" type=
"double" default=
""/>
32106 <method name=
"GetBoundingBoxMin" type=
"" overloaded=
"no">
32107 <autodoc>GetBoundingBoxMin(self, double OUTPUT, double OUTPUT)
</autodoc>
32109 <param name=
"OUTPUT" type=
"double" default=
""/>
32110 <param name=
"OUTPUT" type=
"double" default=
""/>
32113 <method name=
"GetPerimeterPoint" type=
"bool" overloaded=
"no">
32114 <autodoc>GetPerimeterPoint(self, double x1, double y1, double x2, double y2, double OUTPUT,
32115 double OUTPUT) -
> bool
</autodoc>
32117 <param name=
"x1" type=
"double" default=
""/>
32118 <param name=
"y1" type=
"double" default=
""/>
32119 <param name=
"x2" type=
"double" default=
""/>
32120 <param name=
"y2" type=
"double" default=
""/>
32121 <param name=
"OUTPUT" type=
"double" default=
""/>
32122 <param name=
"OUTPUT" type=
"double" default=
""/>
32125 <method name=
"GetCanvas" type=
"wxPyShapeCanvas" overloaded=
"no">
32126 <autodoc>GetCanvas(self) -
> PyShapeCanvas
</autodoc>
32128 <method name=
"SetCanvas" type=
"" overloaded=
"no">
32129 <autodoc>SetCanvas(self, PyShapeCanvas the_canvas)
</autodoc>
32131 <param name=
"the_canvas" type=
"wxPyShapeCanvas" default=
""/>
32134 <method name=
"AddToCanvas" type=
"" overloaded=
"no">
32135 <autodoc>AddToCanvas(self, PyShapeCanvas the_canvas, PyShape addAfter=None)
</autodoc>
32137 <param name=
"the_canvas" type=
"wxPyShapeCanvas" default=
""/>
32138 <param name=
"addAfter" type=
"PyShape" default=
"NULL"/>
32141 <method name=
"InsertInCanvas" type=
"" overloaded=
"no">
32142 <autodoc>InsertInCanvas(self, PyShapeCanvas the_canvas)
</autodoc>
32144 <param name=
"the_canvas" type=
"wxPyShapeCanvas" default=
""/>
32147 <method name=
"RemoveFromCanvas" type=
"" overloaded=
"no">
32148 <autodoc>RemoveFromCanvas(self, PyShapeCanvas the_canvas)
</autodoc>
32150 <param name=
"the_canvas" type=
"wxPyShapeCanvas" default=
""/>
32153 <method name=
"GetX" type=
"double" overloaded=
"no">
32154 <autodoc>GetX(self) -
> double
</autodoc>
32156 <method name=
"GetY" type=
"double" overloaded=
"no">
32157 <autodoc>GetY(self) -
> double
</autodoc>
32159 <method name=
"SetX" type=
"" overloaded=
"no">
32160 <autodoc>SetX(self, double x)
</autodoc>
32162 <param name=
"x" type=
"double" default=
""/>
32165 <method name=
"SetY" type=
"" overloaded=
"no">
32166 <autodoc>SetY(self, double y)
</autodoc>
32168 <param name=
"y" type=
"double" default=
""/>
32171 <method name=
"GetParent" type=
"PyShape" overloaded=
"no">
32172 <autodoc>GetParent(self) -
> PyShape
</autodoc>
32174 <method name=
"SetParent" type=
"" overloaded=
"no">
32175 <autodoc>SetParent(self, PyShape p)
</autodoc>
32177 <param name=
"p" type=
"PyShape" default=
""/>
32180 <method name=
"GetTopAncestor" type=
"PyShape" overloaded=
"no">
32181 <autodoc>GetTopAncestor(self) -
> PyShape
</autodoc>
32183 <method name=
"GetChildren" type=
"PyObject" overloaded=
"no">
32184 <autodoc>GetChildren(self) -
> PyObject
</autodoc>
32186 <method name=
"Unlink" type=
"" overloaded=
"no">
32187 <autodoc>Unlink(self)
</autodoc>
32189 <method name=
"SetDrawHandles" type=
"" overloaded=
"no">
32190 <autodoc>SetDrawHandles(self, bool drawH)
</autodoc>
32192 <param name=
"drawH" type=
"bool" default=
""/>
32195 <method name=
"GetDrawHandles" type=
"bool" overloaded=
"no">
32196 <autodoc>GetDrawHandles(self) -
> bool
</autodoc>
32198 <method name=
"MakeControlPoints" type=
"" overloaded=
"no">
32199 <autodoc>MakeControlPoints(self)
</autodoc>
32201 <method name=
"DeleteControlPoints" type=
"" overloaded=
"no">
32202 <autodoc>DeleteControlPoints(self, DC dc=None)
</autodoc>
32204 <param name=
"dc" type=
"DC" default=
"NULL"/>
32207 <method name=
"ResetControlPoints" type=
"" overloaded=
"no">
32208 <autodoc>ResetControlPoints(self)
</autodoc>
32210 <method name=
"GetEventHandler" type=
"PyShapeEvtHandler" overloaded=
"no">
32211 <autodoc>GetEventHandler(self) -
> PyShapeEvtHandler
</autodoc>
32213 <method name=
"SetEventHandler" type=
"" overloaded=
"no">
32214 <autodoc>SetEventHandler(self, PyShapeEvtHandler handler)
</autodoc>
32216 <param name=
"handler" type=
"PyShapeEvtHandler" default=
""/>
32219 <method name=
"MakeMandatoryControlPoints" type=
"" overloaded=
"no">
32220 <autodoc>MakeMandatoryControlPoints(self)
</autodoc>
32222 <method name=
"ResetMandatoryControlPoints" type=
"" overloaded=
"no">
32223 <autodoc>ResetMandatoryControlPoints(self)
</autodoc>
32225 <method name=
"Recompute" type=
"bool" overloaded=
"no">
32226 <autodoc>Recompute(self) -
> bool
</autodoc>
32228 <method name=
"CalculateSize" type=
"" overloaded=
"no">
32229 <autodoc>CalculateSize(self)
</autodoc>
32231 <method name=
"Select" type=
"" overloaded=
"no">
32232 <autodoc>Select(self, bool select=True, DC dc=None)
</autodoc>
32234 <param name=
"select" type=
"bool" default=
"True"/>
32235 <param name=
"dc" type=
"DC" default=
"NULL"/>
32238 <method name=
"SetHighlight" type=
"" overloaded=
"no">
32239 <autodoc>SetHighlight(self, bool hi=True, bool recurse=False)
</autodoc>
32241 <param name=
"hi" type=
"bool" default=
"True"/>
32242 <param name=
"recurse" type=
"bool" default=
"False"/>
32245 <method name=
"IsHighlighted" type=
"bool" overloaded=
"no">
32246 <autodoc>IsHighlighted(self) -
> bool
</autodoc>
32248 <method name=
"Selected" type=
"bool" overloaded=
"no">
32249 <autodoc>Selected(self) -
> bool
</autodoc>
32251 <method name=
"AncestorSelected" type=
"bool" overloaded=
"no">
32252 <autodoc>AncestorSelected(self) -
> bool
</autodoc>
32254 <method name=
"SetSensitivityFilter" type=
"" overloaded=
"no">
32255 <autodoc>SetSensitivityFilter(self, int sens=OP_ALL, bool recursive=False)
</autodoc>
32257 <param name=
"sens" type=
"int" default=
"OP_ALL"/>
32258 <param name=
"recursive" type=
"bool" default=
"False"/>
32261 <method name=
"GetSensitivityFilter" type=
"int" overloaded=
"no">
32262 <autodoc>GetSensitivityFilter(self) -
> int
</autodoc>
32264 <method name=
"SetDraggable" type=
"" overloaded=
"no">
32265 <autodoc>SetDraggable(self, bool drag, bool recursive=False)
</autodoc>
32267 <param name=
"drag" type=
"bool" default=
""/>
32268 <param name=
"recursive" type=
"bool" default=
"False"/>
32271 <method name=
"SetFixedSize" type=
"" overloaded=
"no">
32272 <autodoc>SetFixedSize(self, bool x, bool y)
</autodoc>
32274 <param name=
"x" type=
"bool" default=
""/>
32275 <param name=
"y" type=
"bool" default=
""/>
32278 <method name=
"GetFixedSize" type=
"" overloaded=
"no">
32279 <autodoc>GetFixedSize(self, bool OUTPUT, bool OUTPUT)
</autodoc>
32281 <param name=
"OUTPUT" type=
"bool" default=
""/>
32282 <param name=
"OUTPUT" type=
"bool" default=
""/>
32285 <method name=
"GetFixedWidth" type=
"bool" overloaded=
"no">
32286 <autodoc>GetFixedWidth(self) -
> bool
</autodoc>
32288 <method name=
"GetFixedHeight" type=
"bool" overloaded=
"no">
32289 <autodoc>GetFixedHeight(self) -
> bool
</autodoc>
32291 <method name=
"SetSpaceAttachments" type=
"" overloaded=
"no">
32292 <autodoc>SetSpaceAttachments(self, bool sp)
</autodoc>
32294 <param name=
"sp" type=
"bool" default=
""/>
32297 <method name=
"GetSpaceAttachments" type=
"bool" overloaded=
"no">
32298 <autodoc>GetSpaceAttachments(self) -
> bool
</autodoc>
32300 <method name=
"SetShadowMode" type=
"" overloaded=
"no">
32301 <autodoc>SetShadowMode(self, int mode, bool redraw=False)
</autodoc>
32303 <param name=
"mode" type=
"int" default=
""/>
32304 <param name=
"redraw" type=
"bool" default=
"False"/>
32307 <method name=
"GetShadowMode" type=
"int" overloaded=
"no">
32308 <autodoc>GetShadowMode(self) -
> int
</autodoc>
32310 <method name=
"HitTest" type=
"bool" overloaded=
"no">
32311 <autodoc>HitTest(self, double x, double y, int OUTPUT, double OUTPUT) -
> bool
</autodoc>
32313 <param name=
"x" type=
"double" default=
""/>
32314 <param name=
"y" type=
"double" default=
""/>
32315 <param name=
"OUTPUT" type=
"int" default=
""/>
32316 <param name=
"OUTPUT" type=
"double" default=
""/>
32319 <method name=
"SetCentreResize" type=
"" overloaded=
"no">
32320 <autodoc>SetCentreResize(self, bool cr)
</autodoc>
32322 <param name=
"cr" type=
"bool" default=
""/>
32325 <method name=
"GetCentreResize" type=
"bool" overloaded=
"no">
32326 <autodoc>GetCentreResize(self) -
> bool
</autodoc>
32328 <method name=
"SetMaintainAspectRatio" type=
"" overloaded=
"no">
32329 <autodoc>SetMaintainAspectRatio(self, bool ar)
</autodoc>
32331 <param name=
"ar" type=
"bool" default=
""/>
32334 <method name=
"GetMaintainAspectRatio" type=
"bool" overloaded=
"no">
32335 <autodoc>GetMaintainAspectRatio(self) -
> bool
</autodoc>
32337 <method name=
"GetLines" type=
"PyObject" overloaded=
"no">
32338 <autodoc>GetLines(self) -
> PyObject
</autodoc>
32340 <method name=
"SetDisableLabel" type=
"" overloaded=
"no">
32341 <autodoc>SetDisableLabel(self, bool flag)
</autodoc>
32343 <param name=
"flag" type=
"bool" default=
""/>
32346 <method name=
"GetDisableLabel" type=
"bool" overloaded=
"no">
32347 <autodoc>GetDisableLabel(self) -
> bool
</autodoc>
32349 <method name=
"SetAttachmentMode" type=
"" overloaded=
"no">
32350 <autodoc>SetAttachmentMode(self, int mode)
</autodoc>
32352 <param name=
"mode" type=
"int" default=
""/>
32355 <method name=
"GetAttachmentMode" type=
"int" overloaded=
"no">
32356 <autodoc>GetAttachmentMode(self) -
> int
</autodoc>
32358 <method name=
"SetId" type=
"" overloaded=
"no">
32359 <autodoc>SetId(self, long i)
</autodoc>
32361 <param name=
"i" type=
"long" default=
""/>
32364 <method name=
"GetId" type=
"long" overloaded=
"no">
32365 <autodoc>GetId(self) -
> long
</autodoc>
32367 <method name=
"SetPen" type=
"" overloaded=
"no">
32368 <autodoc>SetPen(self, wxPen pen)
</autodoc>
32370 <param name=
"pen" type=
"Pen" default=
""/>
32373 <method name=
"SetBrush" type=
"" overloaded=
"no">
32374 <autodoc>SetBrush(self, wxBrush brush)
</autodoc>
32376 <param name=
"brush" type=
"Brush" default=
""/>
32379 <method name=
"Show" type=
"" overloaded=
"no">
32380 <autodoc>Show(self, bool show)
</autodoc>
32382 <param name=
"show" type=
"bool" default=
""/>
32385 <method name=
"IsShown" type=
"bool" overloaded=
"no">
32386 <autodoc>IsShown(self) -
> bool
</autodoc>
32388 <method name=
"Move" type=
"" overloaded=
"no">
32389 <autodoc>Move(self, DC dc, double x1, double y1, bool display=True)
</autodoc>
32391 <param name=
"dc" type=
"DC" default=
""/>
32392 <param name=
"x1" type=
"double" default=
""/>
32393 <param name=
"y1" type=
"double" default=
""/>
32394 <param name=
"display" type=
"bool" default=
"True"/>
32397 <method name=
"Erase" type=
"" overloaded=
"no">
32398 <autodoc>Erase(self, DC dc)
</autodoc>
32400 <param name=
"dc" type=
"DC" default=
""/>
32403 <method name=
"EraseContents" type=
"" overloaded=
"no">
32404 <autodoc>EraseContents(self, DC dc)
</autodoc>
32406 <param name=
"dc" type=
"DC" default=
""/>
32409 <method name=
"Draw" type=
"" overloaded=
"no">
32410 <autodoc>Draw(self, DC dc)
</autodoc>
32412 <param name=
"dc" type=
"DC" default=
""/>
32415 <method name=
"Flash" type=
"" overloaded=
"no">
32416 <autodoc>Flash(self)
</autodoc>
32418 <method name=
"MoveLinks" type=
"" overloaded=
"no">
32419 <autodoc>MoveLinks(self, DC dc)
</autodoc>
32421 <param name=
"dc" type=
"DC" default=
""/>
32424 <method name=
"DrawContents" type=
"" overloaded=
"no">
32425 <autodoc>DrawContents(self, DC dc)
</autodoc>
32427 <param name=
"dc" type=
"DC" default=
""/>
32430 <method name=
"SetSize" type=
"" overloaded=
"no">
32431 <autodoc>SetSize(self, double x, double y, bool recursive=True)
</autodoc>
32433 <param name=
"x" type=
"double" default=
""/>
32434 <param name=
"y" type=
"double" default=
""/>
32435 <param name=
"recursive" type=
"bool" default=
"True"/>
32438 <method name=
"SetAttachmentSize" type=
"" overloaded=
"no">
32439 <autodoc>SetAttachmentSize(self, double x, double y)
</autodoc>
32441 <param name=
"x" type=
"double" default=
""/>
32442 <param name=
"y" type=
"double" default=
""/>
32445 <method name=
"Attach" type=
"" overloaded=
"no">
32446 <autodoc>Attach(self, PyShapeCanvas can)
</autodoc>
32448 <param name=
"can" type=
"wxPyShapeCanvas" default=
""/>
32451 <method name=
"Detach" type=
"" overloaded=
"no">
32452 <autodoc>Detach(self)
</autodoc>
32454 <method name=
"Constrain" type=
"bool" overloaded=
"no">
32455 <autodoc>Constrain(self) -
> bool
</autodoc>
32457 <method name=
"AddLine" type=
"" overloaded=
"no">
32458 <autodoc>AddLine(self, PyLineShape line, PyShape other, int attachFrom=
0,
32459 int attachTo=
0, int positionFrom=-
1, int positionTo=-
1)
</autodoc>
32461 <param name=
"line" type=
"wxPyLineShape" default=
""/>
32462 <param name=
"other" type=
"PyShape" default=
""/>
32463 <param name=
"attachFrom" type=
"int" default=
"0"/>
32464 <param name=
"attachTo" type=
"int" default=
"0"/>
32465 <param name=
"positionFrom" type=
"int" default=
"-1"/>
32466 <param name=
"positionTo" type=
"int" default=
"-1"/>
32469 <method name=
"GetLinePosition" type=
"int" overloaded=
"no">
32470 <autodoc>GetLinePosition(self, PyLineShape line) -
> int
</autodoc>
32472 <param name=
"line" type=
"wxPyLineShape" default=
""/>
32475 <method name=
"AddText" type=
"" overloaded=
"no">
32476 <autodoc>AddText(self, String string)
</autodoc>
32478 <param name=
"string" type=
"String" default=
""/>
32481 <method name=
"GetPen" type=
"Pen" overloaded=
"no">
32482 <autodoc>GetPen(self) -
> wxPen
</autodoc>
32484 <method name=
"GetBrush" type=
"Brush" overloaded=
"no">
32485 <autodoc>GetBrush(self) -
> wxBrush
</autodoc>
32487 <method name=
"SetDefaultRegionSize" type=
"" overloaded=
"no">
32488 <autodoc>SetDefaultRegionSize(self)
</autodoc>
32490 <method name=
"FormatText" type=
"" overloaded=
"no">
32491 <autodoc>FormatText(self, DC dc, String s, int regionId=
0)
</autodoc>
32493 <param name=
"dc" type=
"DC" default=
""/>
32494 <param name=
"s" type=
"String" default=
""/>
32495 <param name=
"regionId" type=
"int" default=
"0"/>
32498 <method name=
"SetFormatMode" type=
"" overloaded=
"no">
32499 <autodoc>SetFormatMode(self, int mode, int regionId=
0)
</autodoc>
32501 <param name=
"mode" type=
"int" default=
""/>
32502 <param name=
"regionId" type=
"int" default=
"0"/>
32505 <method name=
"GetFormatMode" type=
"int" overloaded=
"no">
32506 <autodoc>GetFormatMode(self, int regionId=
0) -
> int
</autodoc>
32508 <param name=
"regionId" type=
"int" default=
"0"/>
32511 <method name=
"SetFont" type=
"" overloaded=
"no">
32512 <autodoc>SetFont(self, Font font, int regionId=
0)
</autodoc>
32514 <param name=
"font" type=
"Font" default=
""/>
32515 <param name=
"regionId" type=
"int" default=
"0"/>
32518 <method name=
"GetFont" type=
"Font" overloaded=
"no">
32519 <autodoc>GetFont(self, int regionId=
0) -
> Font
</autodoc>
32521 <param name=
"regionId" type=
"int" default=
"0"/>
32524 <method name=
"SetTextColour" type=
"" overloaded=
"no">
32525 <autodoc>SetTextColour(self, String colour, int regionId=
0)
</autodoc>
32527 <param name=
"colour" type=
"String" default=
""/>
32528 <param name=
"regionId" type=
"int" default=
"0"/>
32531 <method name=
"GetTextColour" type=
"String" overloaded=
"no">
32532 <autodoc>GetTextColour(self, int regionId=
0) -
> String
</autodoc>
32534 <param name=
"regionId" type=
"int" default=
"0"/>
32537 <method name=
"GetNumberOfTextRegions" type=
"int" overloaded=
"no">
32538 <autodoc>GetNumberOfTextRegions(self) -
> int
</autodoc>
32540 <method name=
"SetRegionName" type=
"" overloaded=
"no">
32541 <autodoc>SetRegionName(self, String name, int regionId=
0)
</autodoc>
32543 <param name=
"name" type=
"String" default=
""/>
32544 <param name=
"regionId" type=
"int" default=
"0"/>
32547 <method name=
"GetRegionName" type=
"String" overloaded=
"no">
32548 <autodoc>GetRegionName(self, int regionId) -
> String
</autodoc>
32550 <param name=
"regionId" type=
"int" default=
""/>
32553 <method name=
"GetRegionId" type=
"int" overloaded=
"no">
32554 <autodoc>GetRegionId(self, String name) -
> int
</autodoc>
32556 <param name=
"name" type=
"String" default=
""/>
32559 <method name=
"NameRegions" type=
"" overloaded=
"no">
32560 <autodoc>NameRegions(self, String parentName=EmptyString)
</autodoc>
32562 <param name=
"parentName" type=
"String" default=
"wxPyEmptyString"/>
32565 <method name=
"GetRegions" type=
"PyObject" overloaded=
"no">
32566 <autodoc>GetRegions(self) -
> PyObject
</autodoc>
32568 <method name=
"AddRegion" type=
"" overloaded=
"no">
32569 <autodoc>AddRegion(self, ShapeRegion region)
</autodoc>
32571 <param name=
"region" type=
"ShapeRegion" default=
""/>
32574 <method name=
"ClearRegions" type=
"" overloaded=
"no">
32575 <autodoc>ClearRegions(self)
</autodoc>
32577 <method name=
"AssignNewIds" type=
"" overloaded=
"no">
32578 <autodoc>AssignNewIds(self)
</autodoc>
32580 <method name=
"FindRegion" type=
"PyShape" overloaded=
"no">
32581 <autodoc>FindRegion(self, String regionName, int OUTPUT) -
> PyShape
</autodoc>
32583 <param name=
"regionName" type=
"String" default=
""/>
32584 <param name=
"OUTPUT" type=
"int" default=
""/>
32587 <method name=
"FindRegionNames" type=
"" overloaded=
"no">
32588 <autodoc>FindRegionNames(self, wxStringList list)
</autodoc>
32590 <param name=
"list" type=
"wxStringList" default=
""/>
32593 <method name=
"ClearText" type=
"" overloaded=
"no">
32594 <autodoc>ClearText(self, int regionId=
0)
</autodoc>
32596 <param name=
"regionId" type=
"int" default=
"0"/>
32599 <method name=
"RemoveLine" type=
"" overloaded=
"no">
32600 <autodoc>RemoveLine(self, PyLineShape line)
</autodoc>
32602 <param name=
"line" type=
"wxPyLineShape" default=
""/>
32605 <method name=
"GetAttachmentPosition" type=
"bool" overloaded=
"no">
32606 <autodoc>GetAttachmentPosition(self, int attachment, double OUTPUT, double OUTPUT, int nth=
0,
32607 int no_arcs=
1, PyLineShape line=None) -
> bool
</autodoc>
32609 <param name=
"attachment" type=
"int" default=
""/>
32610 <param name=
"OUTPUT" type=
"double" default=
""/>
32611 <param name=
"OUTPUT" type=
"double" default=
""/>
32612 <param name=
"nth" type=
"int" default=
"0"/>
32613 <param name=
"no_arcs" type=
"int" default=
"1"/>
32614 <param name=
"line" type=
"wxPyLineShape" default=
"NULL"/>
32617 <method name=
"GetNumberOfAttachments" type=
"int" overloaded=
"no">
32618 <autodoc>GetNumberOfAttachments(self) -
> int
</autodoc>
32620 <method name=
"AttachmentIsValid" type=
"bool" overloaded=
"no">
32621 <autodoc>AttachmentIsValid(self, int attachment) -
> bool
</autodoc>
32623 <param name=
"attachment" type=
"int" default=
""/>
32626 <method name=
"GetAttachments" type=
"PyObject" overloaded=
"no">
32627 <autodoc>GetAttachments(self) -
> PyObject
</autodoc>
32629 <method name=
"GetAttachmentPositionEdge" type=
"bool" overloaded=
"no">
32630 <autodoc>GetAttachmentPositionEdge(self, int attachment, double OUTPUT, double OUTPUT, int nth=
0,
32631 int no_arcs=
1, PyLineShape line=None) -
> bool
</autodoc>
32633 <param name=
"attachment" type=
"int" default=
""/>
32634 <param name=
"OUTPUT" type=
"double" default=
""/>
32635 <param name=
"OUTPUT" type=
"double" default=
""/>
32636 <param name=
"nth" type=
"int" default=
"0"/>
32637 <param name=
"no_arcs" type=
"int" default=
"1"/>
32638 <param name=
"line" type=
"wxPyLineShape" default=
"NULL"/>
32641 <method name=
"CalcSimpleAttachment" type=
"RealPoint" overloaded=
"no">
32642 <autodoc>CalcSimpleAttachment(self, RealPoint pt1, RealPoint pt2, int nth, int noArcs,
32643 PyLineShape line) -
> RealPoint
</autodoc>
32645 <param name=
"pt1" type=
"RealPoint" default=
""/>
32646 <param name=
"pt2" type=
"RealPoint" default=
""/>
32647 <param name=
"nth" type=
"int" default=
""/>
32648 <param name=
"noArcs" type=
"int" default=
""/>
32649 <param name=
"line" type=
"wxPyLineShape" default=
""/>
32652 <method name=
"AttachmentSortTest" type=
"bool" overloaded=
"no">
32653 <autodoc>AttachmentSortTest(self, int attachmentPoint, RealPoint pt1, RealPoint pt2) -
> bool
</autodoc>
32655 <param name=
"attachmentPoint" type=
"int" default=
""/>
32656 <param name=
"pt1" type=
"RealPoint" default=
""/>
32657 <param name=
"pt2" type=
"RealPoint" default=
""/>
32660 <method name=
"EraseLinks" type=
"" overloaded=
"no">
32661 <autodoc>EraseLinks(self, DC dc, int attachment=-
1, bool recurse=False)
</autodoc>
32663 <param name=
"dc" type=
"DC" default=
""/>
32664 <param name=
"attachment" type=
"int" default=
"-1"/>
32665 <param name=
"recurse" type=
"bool" default=
"False"/>
32668 <method name=
"DrawLinks" type=
"" overloaded=
"no">
32669 <autodoc>DrawLinks(self, DC dc, int attachment=-
1, bool recurse=False)
</autodoc>
32671 <param name=
"dc" type=
"DC" default=
""/>
32672 <param name=
"attachment" type=
"int" default=
"-1"/>
32673 <param name=
"recurse" type=
"bool" default=
"False"/>
32676 <method name=
"MoveLineToNewAttachment" type=
"bool" overloaded=
"no">
32677 <autodoc>MoveLineToNewAttachment(self, DC dc, PyLineShape to_move, double x, double y) -
> bool
</autodoc>
32679 <param name=
"dc" type=
"DC" default=
""/>
32680 <param name=
"to_move" type=
"wxPyLineShape" default=
""/>
32681 <param name=
"x" type=
"double" default=
""/>
32682 <param name=
"y" type=
"double" default=
""/>
32685 <method name=
"ApplyAttachmentOrdering" type=
"" overloaded=
"no">
32686 <autodoc>ApplyAttachmentOrdering(self, PyObject linesToSort)
</autodoc>
32688 <param name=
"linesToSort" type=
"PyObject" default=
""/>
32691 <method name=
"GetBranchingAttachmentRoot" type=
"RealPoint" overloaded=
"no">
32692 <autodoc>GetBranchingAttachmentRoot(self, int attachment) -
> RealPoint
</autodoc>
32694 <param name=
"attachment" type=
"int" default=
""/>
32697 <method name=
"GetBranchingAttachmentInfo" type=
"bool" overloaded=
"no">
32698 <autodoc>GetBranchingAttachmentInfo(self, int attachment, RealPoint root, RealPoint neck, RealPoint shoulder1,
32699 RealPoint shoulder2) -
> bool
</autodoc>
32701 <param name=
"attachment" type=
"int" default=
""/>
32702 <param name=
"root" type=
"RealPoint" default=
""/>
32703 <param name=
"neck" type=
"RealPoint" default=
""/>
32704 <param name=
"shoulder1" type=
"RealPoint" default=
""/>
32705 <param name=
"shoulder2" type=
"RealPoint" default=
""/>
32708 <method name=
"GetBranchingAttachmentPoint" type=
"bool" overloaded=
"no">
32709 <autodoc>GetBranchingAttachmentPoint(self, int attachment, int n, RealPoint attachmentPoint, RealPoint stemPoint) -
> bool
</autodoc>
32711 <param name=
"attachment" type=
"int" default=
""/>
32712 <param name=
"n" type=
"int" default=
""/>
32713 <param name=
"attachmentPoint" type=
"RealPoint" default=
""/>
32714 <param name=
"stemPoint" type=
"RealPoint" default=
""/>
32717 <method name=
"GetAttachmentLineCount" type=
"int" overloaded=
"no">
32718 <autodoc>GetAttachmentLineCount(self, int attachment) -
> int
</autodoc>
32720 <param name=
"attachment" type=
"int" default=
""/>
32723 <method name=
"SetBranchNeckLength" type=
"" overloaded=
"no">
32724 <autodoc>SetBranchNeckLength(self, int len)
</autodoc>
32726 <param name=
"len" type=
"int" default=
""/>
32729 <method name=
"GetBranchNeckLength" type=
"int" overloaded=
"no">
32730 <autodoc>GetBranchNeckLength(self) -
> int
</autodoc>
32732 <method name=
"SetBranchStemLength" type=
"" overloaded=
"no">
32733 <autodoc>SetBranchStemLength(self, int len)
</autodoc>
32735 <param name=
"len" type=
"int" default=
""/>
32738 <method name=
"GetBranchStemLength" type=
"int" overloaded=
"no">
32739 <autodoc>GetBranchStemLength(self) -
> int
</autodoc>
32741 <method name=
"SetBranchSpacing" type=
"" overloaded=
"no">
32742 <autodoc>SetBranchSpacing(self, int len)
</autodoc>
32744 <param name=
"len" type=
"int" default=
""/>
32747 <method name=
"GetBranchSpacing" type=
"int" overloaded=
"no">
32748 <autodoc>GetBranchSpacing(self) -
> int
</autodoc>
32750 <method name=
"SetBranchStyle" type=
"" overloaded=
"no">
32751 <autodoc>SetBranchStyle(self, long style)
</autodoc>
32753 <param name=
"style" type=
"long" default=
""/>
32756 <method name=
"GetBranchStyle" type=
"long" overloaded=
"no">
32757 <autodoc>GetBranchStyle(self) -
> long
</autodoc>
32759 <method name=
"PhysicalToLogicalAttachment" type=
"int" overloaded=
"no">
32760 <autodoc>PhysicalToLogicalAttachment(self, int physicalAttachment) -
> int
</autodoc>
32762 <param name=
"physicalAttachment" type=
"int" default=
""/>
32765 <method name=
"LogicalToPhysicalAttachment" type=
"int" overloaded=
"no">
32766 <autodoc>LogicalToPhysicalAttachment(self, int logicalAttachment) -
> int
</autodoc>
32768 <param name=
"logicalAttachment" type=
"int" default=
""/>
32771 <method name=
"Draggable" type=
"bool" overloaded=
"no">
32772 <autodoc>Draggable(self) -
> bool
</autodoc>
32774 <method name=
"HasDescendant" type=
"bool" overloaded=
"no">
32775 <autodoc>HasDescendant(self, PyShape image) -
> bool
</autodoc>
32777 <param name=
"image" type=
"PyShape" default=
""/>
32780 <method name=
"CreateNewCopy" type=
"PyShape" overloaded=
"no">
32781 <autodoc>CreateNewCopy(self, bool resetMapping=True, bool recompute=True) -
> PyShape
</autodoc>
32783 <param name=
"resetMapping" type=
"bool" default=
"True"/>
32784 <param name=
"recompute" type=
"bool" default=
"True"/>
32787 <method name=
"Copy" type=
"" overloaded=
"no">
32788 <autodoc>Copy(self, PyShape copy)
</autodoc>
32790 <param name=
"copy" type=
"PyShape" default=
""/>
32793 <method name=
"CopyWithHandler" type=
"" overloaded=
"no">
32794 <autodoc>CopyWithHandler(self, PyShape copy)
</autodoc>
32796 <param name=
"copy" type=
"PyShape" default=
""/>
32799 <method name=
"Rotate" type=
"" overloaded=
"no">
32800 <autodoc>Rotate(self, double x, double y, double theta)
</autodoc>
32802 <param name=
"x" type=
"double" default=
""/>
32803 <param name=
"y" type=
"double" default=
""/>
32804 <param name=
"theta" type=
"double" default=
""/>
32807 <method name=
"GetRotation" type=
"double" overloaded=
"no">
32808 <autodoc>GetRotation(self) -
> double
</autodoc>
32810 <method name=
"SetRotation" type=
"" overloaded=
"no">
32811 <autodoc>SetRotation(self, double rotation)
</autodoc>
32813 <param name=
"rotation" type=
"double" default=
""/>
32816 <method name=
"ClearAttachments" type=
"" overloaded=
"no">
32817 <autodoc>ClearAttachments(self)
</autodoc>
32819 <method name=
"Recentre" type=
"" overloaded=
"no">
32820 <autodoc>Recentre(self, DC dc)
</autodoc>
32822 <param name=
"dc" type=
"DC" default=
""/>
32825 <method name=
"ClearPointList" type=
"" overloaded=
"no">
32826 <autodoc>ClearPointList(self, wxList list)
</autodoc>
32828 <param name=
"list" type=
"wxList" default=
""/>
32831 <method name=
"GetBackgroundPen" type=
"Pen" overloaded=
"no">
32832 <autodoc>GetBackgroundPen(self) -
> wxPen
</autodoc>
32834 <method name=
"GetBackgroundBrush" type=
"Brush" overloaded=
"no">
32835 <autodoc>GetBackgroundBrush(self) -
> wxBrush
</autodoc>
32837 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
32838 <autodoc>base_OnDelete(self)
</autodoc>
32840 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
32841 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
32843 <param name=
"dc" type=
"DC" default=
""/>
32846 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
32847 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
32849 <param name=
"dc" type=
"DC" default=
""/>
32852 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
32853 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=False)
</autodoc>
32855 <param name=
"dc" type=
"DC" default=
""/>
32856 <param name=
"erase" type=
"bool" default=
"False"/>
32859 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
32860 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
32862 <param name=
"dc" type=
"DC" default=
""/>
32865 <method name=
"base_OnErase" type=
"" overloaded=
"no">
32866 <autodoc>base_OnErase(self, DC dc)
</autodoc>
32868 <param name=
"dc" type=
"DC" default=
""/>
32871 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
32872 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
32874 <param name=
"dc" type=
"DC" default=
""/>
32877 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
32878 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
32880 <param name=
"dc" type=
"DC" default=
""/>
32883 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
32884 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32886 <param name=
"x" type=
"double" default=
""/>
32887 <param name=
"y" type=
"double" default=
""/>
32888 <param name=
"keys" type=
"int" default=
"0"/>
32889 <param name=
"attachment" type=
"int" default=
"0"/>
32892 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
32893 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32895 <param name=
"x" type=
"double" default=
""/>
32896 <param name=
"y" type=
"double" default=
""/>
32897 <param name=
"keys" type=
"int" default=
"0"/>
32898 <param name=
"attachment" type=
"int" default=
"0"/>
32901 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
32902 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32904 <param name=
"x" type=
"double" default=
""/>
32905 <param name=
"y" type=
"double" default=
""/>
32906 <param name=
"keys" type=
"int" default=
"0"/>
32907 <param name=
"attachment" type=
"int" default=
"0"/>
32910 <method name=
"base_OnSize" type=
"" overloaded=
"no">
32911 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
32913 <param name=
"x" type=
"double" default=
""/>
32914 <param name=
"y" type=
"double" default=
""/>
32917 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
32918 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
32919 bool display=True) -
> bool
</autodoc>
32921 <param name=
"dc" type=
"DC" default=
""/>
32922 <param name=
"x" type=
"double" default=
""/>
32923 <param name=
"y" type=
"double" default=
""/>
32924 <param name=
"old_x" type=
"double" default=
""/>
32925 <param name=
"old_y" type=
"double" default=
""/>
32926 <param name=
"display" type=
"bool" default=
"True"/>
32929 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
32930 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
32931 bool display=True)
</autodoc>
32933 <param name=
"dc" type=
"DC" default=
""/>
32934 <param name=
"x" type=
"double" default=
""/>
32935 <param name=
"y" type=
"double" default=
""/>
32936 <param name=
"old_x" type=
"double" default=
""/>
32937 <param name=
"old_y" type=
"double" default=
""/>
32938 <param name=
"display" type=
"bool" default=
"True"/>
32941 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
32942 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32944 <param name=
"draw" type=
"bool" default=
""/>
32945 <param name=
"x" type=
"double" default=
""/>
32946 <param name=
"y" type=
"double" default=
""/>
32947 <param name=
"keys" type=
"int" default=
"0"/>
32948 <param name=
"attachment" type=
"int" default=
"0"/>
32951 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
32952 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32954 <param name=
"x" type=
"double" default=
""/>
32955 <param name=
"y" type=
"double" default=
""/>
32956 <param name=
"keys" type=
"int" default=
"0"/>
32957 <param name=
"attachment" type=
"int" default=
"0"/>
32960 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
32961 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32963 <param name=
"x" type=
"double" default=
""/>
32964 <param name=
"y" type=
"double" default=
""/>
32965 <param name=
"keys" type=
"int" default=
"0"/>
32966 <param name=
"attachment" type=
"int" default=
"0"/>
32969 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
32970 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32972 <param name=
"draw" type=
"bool" default=
""/>
32973 <param name=
"x" type=
"double" default=
""/>
32974 <param name=
"y" type=
"double" default=
""/>
32975 <param name=
"keys" type=
"int" default=
"0"/>
32976 <param name=
"attachment" type=
"int" default=
"0"/>
32979 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
32980 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32982 <param name=
"x" type=
"double" default=
""/>
32983 <param name=
"y" type=
"double" default=
""/>
32984 <param name=
"keys" type=
"int" default=
"0"/>
32985 <param name=
"attachment" type=
"int" default=
"0"/>
32988 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
32989 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
32991 <param name=
"x" type=
"double" default=
""/>
32992 <param name=
"y" type=
"double" default=
""/>
32993 <param name=
"keys" type=
"int" default=
"0"/>
32994 <param name=
"attachment" type=
"int" default=
"0"/>
32997 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
32998 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
33000 <param name=
"dc" type=
"DC" default=
""/>
33001 <param name=
"x" type=
"double" default=
""/>
33002 <param name=
"y" type=
"double" default=
""/>
33003 <param name=
"w" type=
"double" default=
""/>
33004 <param name=
"h" type=
"double" default=
""/>
33007 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
33008 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
33010 <param name=
"dc" type=
"DC" default=
""/>
33013 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
33014 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
33016 <param name=
"dc" type=
"DC" default=
""/>
33019 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
33020 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
33022 <param name=
"dc" type=
"DC" default=
""/>
33023 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
33026 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
33027 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
33028 int attachment=
0)
</autodoc>
33030 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
33031 <param name=
"draw" type=
"bool" default=
""/>
33032 <param name=
"x" type=
"double" default=
""/>
33033 <param name=
"y" type=
"double" default=
""/>
33034 <param name=
"keys" type=
"int" default=
"0"/>
33035 <param name=
"attachment" type=
"int" default=
"0"/>
33038 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
33039 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
33040 int attachment=
0)
</autodoc>
33042 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
33043 <param name=
"x" type=
"double" default=
""/>
33044 <param name=
"y" type=
"double" default=
""/>
33045 <param name=
"keys" type=
"int" default=
"0"/>
33046 <param name=
"attachment" type=
"int" default=
"0"/>
33049 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
33050 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
33051 int attachment=
0)
</autodoc>
33053 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
33054 <param name=
"x" type=
"double" default=
""/>
33055 <param name=
"y" type=
"double" default=
""/>
33056 <param name=
"keys" type=
"int" default=
"0"/>
33057 <param name=
"attachment" type=
"int" default=
"0"/>
33060 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
33061 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
33063 <param name=
"w" type=
"double" default=
""/>
33064 <param name=
"h" type=
"double" default=
""/>
33067 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
33068 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
33070 <param name=
"w" type=
"double" default=
""/>
33071 <param name=
"h" type=
"double" default=
""/>
33075 <class name=
"PseudoMetaFile" oldname=
"wxPseudoMetaFile" module=
"ogl">
33076 <baseclass name=
"Object"/>
33077 <constructor name=
"PseudoMetaFile" overloaded=
"no">
33078 <autodoc>__init__(self) -
> PseudoMetaFile
</autodoc>
33080 <destructor name=
"~wxPseudoMetaFile" overloaded=
"no">
33081 <autodoc>__del__(self)
</autodoc>
33083 <method name=
"Draw" type=
"" overloaded=
"no">
33084 <autodoc>Draw(self, DC dc, double xoffset, double yoffset)
</autodoc>
33086 <param name=
"dc" type=
"DC" default=
""/>
33087 <param name=
"xoffset" type=
"double" default=
""/>
33088 <param name=
"yoffset" type=
"double" default=
""/>
33091 <method name=
"Clear" type=
"" overloaded=
"no">
33092 <autodoc>Clear(self)
</autodoc>
33094 <method name=
"Copy" type=
"" overloaded=
"no">
33095 <autodoc>Copy(self, PseudoMetaFile copy)
</autodoc>
33097 <param name=
"copy" type=
"PseudoMetaFile" default=
""/>
33100 <method name=
"Scale" type=
"" overloaded=
"no">
33101 <autodoc>Scale(self, double sx, double sy)
</autodoc>
33103 <param name=
"sx" type=
"double" default=
""/>
33104 <param name=
"sy" type=
"double" default=
""/>
33107 <method name=
"ScaleTo" type=
"" overloaded=
"no">
33108 <autodoc>ScaleTo(self, double w, double h)
</autodoc>
33110 <param name=
"w" type=
"double" default=
""/>
33111 <param name=
"h" type=
"double" default=
""/>
33114 <method name=
"Translate" type=
"" overloaded=
"no">
33115 <autodoc>Translate(self, double x, double y)
</autodoc>
33117 <param name=
"x" type=
"double" default=
""/>
33118 <param name=
"y" type=
"double" default=
""/>
33121 <method name=
"Rotate" type=
"" overloaded=
"no">
33122 <autodoc>Rotate(self, double x, double y, double theta)
</autodoc>
33124 <param name=
"x" type=
"double" default=
""/>
33125 <param name=
"y" type=
"double" default=
""/>
33126 <param name=
"theta" type=
"double" default=
""/>
33129 <method name=
"LoadFromMetaFile" type=
"bool" overloaded=
"no">
33130 <autodoc>LoadFromMetaFile(self, String filename, double width, double height) -
> bool
</autodoc>
33132 <param name=
"filename" type=
"String" default=
""/>
33133 <param name=
"width" type=
"double" default=
""/>
33134 <param name=
"height" type=
"double" default=
""/>
33137 <method name=
"GetBounds" type=
"" overloaded=
"no">
33138 <autodoc>GetBounds(self, double minX, double minY, double maxX, double maxY)
</autodoc>
33140 <param name=
"minX" type=
"double" default=
""/>
33141 <param name=
"minY" type=
"double" default=
""/>
33142 <param name=
"maxX" type=
"double" default=
""/>
33143 <param name=
"maxY" type=
"double" default=
""/>
33146 <method name=
"CalculateSize" type=
"" overloaded=
"no">
33147 <autodoc>CalculateSize(self, PyDrawnShape shape)
</autodoc>
33149 <param name=
"shape" type=
"wxPyDrawnShape" default=
""/>
33152 <method name=
"SetRotateable" type=
"" overloaded=
"no">
33153 <autodoc>SetRotateable(self, bool rot)
</autodoc>
33155 <param name=
"rot" type=
"bool" default=
""/>
33158 <method name=
"GetRotateable" type=
"bool" overloaded=
"no">
33159 <autodoc>GetRotateable(self) -
> bool
</autodoc>
33161 <method name=
"SetSize" type=
"" overloaded=
"no">
33162 <autodoc>SetSize(self, double w, double h)
</autodoc>
33164 <param name=
"w" type=
"double" default=
""/>
33165 <param name=
"h" type=
"double" default=
""/>
33168 <method name=
"SetFillBrush" type=
"" overloaded=
"no">
33169 <autodoc>SetFillBrush(self, wxBrush brush)
</autodoc>
33171 <param name=
"brush" type=
"Brush" default=
""/>
33174 <method name=
"GetFillBrush" type=
"Brush" overloaded=
"no">
33175 <autodoc>GetFillBrush(self) -
> wxBrush
</autodoc>
33177 <method name=
"SetOutlinePen" type=
"" overloaded=
"no">
33178 <autodoc>SetOutlinePen(self, wxPen pen)
</autodoc>
33180 <param name=
"pen" type=
"Pen" default=
""/>
33183 <method name=
"GetOutlinePen" type=
"Pen" overloaded=
"no">
33184 <autodoc>GetOutlinePen(self) -
> wxPen
</autodoc>
33186 <method name=
"SetOutlineOp" type=
"" overloaded=
"no">
33187 <autodoc>SetOutlineOp(self, int op)
</autodoc>
33189 <param name=
"op" type=
"int" default=
""/>
33192 <method name=
"GetOutlineOp" type=
"int" overloaded=
"no">
33193 <autodoc>GetOutlineOp(self) -
> int
</autodoc>
33195 <method name=
"IsValid" type=
"bool" overloaded=
"no">
33196 <autodoc>IsValid(self) -
> bool
</autodoc>
33198 <method name=
"DrawLine" type=
"" overloaded=
"no">
33199 <autodoc>DrawLine(self, Point pt1, Point pt2)
</autodoc>
33201 <param name=
"pt1" type=
"Point" default=
""/>
33202 <param name=
"pt2" type=
"Point" default=
""/>
33205 <method name=
"DrawRectangle" type=
"" overloaded=
"no">
33206 <autodoc>DrawRectangle(self, Rect rect)
</autodoc>
33208 <param name=
"rect" type=
"Rect" default=
""/>
33211 <method name=
"DrawRoundedRectangle" type=
"" overloaded=
"no">
33212 <autodoc>DrawRoundedRectangle(self, Rect rect, double radius)
</autodoc>
33214 <param name=
"rect" type=
"Rect" default=
""/>
33215 <param name=
"radius" type=
"double" default=
""/>
33218 <method name=
"DrawArc" type=
"" overloaded=
"no">
33219 <autodoc>DrawArc(self, Point centrePt, Point startPt, Point endPt)
</autodoc>
33221 <param name=
"centrePt" type=
"Point" default=
""/>
33222 <param name=
"startPt" type=
"Point" default=
""/>
33223 <param name=
"endPt" type=
"Point" default=
""/>
33226 <method name=
"DrawEllipticArc" type=
"" overloaded=
"no">
33227 <autodoc>DrawEllipticArc(self, Rect rect, double startAngle, double endAngle)
</autodoc>
33229 <param name=
"rect" type=
"Rect" default=
""/>
33230 <param name=
"startAngle" type=
"double" default=
""/>
33231 <param name=
"endAngle" type=
"double" default=
""/>
33234 <method name=
"DrawEllipse" type=
"" overloaded=
"no">
33235 <autodoc>DrawEllipse(self, Rect rect)
</autodoc>
33237 <param name=
"rect" type=
"Rect" default=
""/>
33240 <method name=
"DrawPoint" type=
"" overloaded=
"no">
33241 <autodoc>DrawPoint(self, Point pt)
</autodoc>
33243 <param name=
"pt" type=
"Point" default=
""/>
33246 <method name=
"DrawText" type=
"" overloaded=
"no">
33247 <autodoc>DrawText(self, String text, Point pt)
</autodoc>
33249 <param name=
"text" type=
"String" default=
""/>
33250 <param name=
"pt" type=
"Point" default=
""/>
33253 <method name=
"DrawLines" type=
"" overloaded=
"no">
33254 <autodoc>DrawLines(self, int points, Point points_array)
</autodoc>
33256 <param name=
"points" type=
"int" default=
""/>
33257 <param name=
"points_array" type=
"Point" default=
""/>
33260 <method name=
"DrawPolygon" type=
"" overloaded=
"no">
33261 <autodoc>DrawPolygon(self, int points, Point points_array, int flags=
0)
</autodoc>
33263 <param name=
"points" type=
"int" default=
""/>
33264 <param name=
"points_array" type=
"Point" default=
""/>
33265 <param name=
"flags" type=
"int" default=
"0"/>
33268 <method name=
"DrawSpline" type=
"" overloaded=
"no">
33269 <autodoc>DrawSpline(self, int points, Point points_array)
</autodoc>
33271 <param name=
"points" type=
"int" default=
""/>
33272 <param name=
"points_array" type=
"Point" default=
""/>
33275 <method name=
"SetClippingRect" type=
"" overloaded=
"no">
33276 <autodoc>SetClippingRect(self, Rect rect)
</autodoc>
33278 <param name=
"rect" type=
"Rect" default=
""/>
33281 <method name=
"DestroyClippingRect" type=
"" overloaded=
"no">
33282 <autodoc>DestroyClippingRect(self)
</autodoc>
33284 <method name=
"SetPen" type=
"" overloaded=
"no">
33285 <autodoc>SetPen(self, wxPen pen, bool isOutline=FALSE)
</autodoc>
33287 <param name=
"pen" type=
"Pen" default=
""/>
33288 <param name=
"isOutline" type=
"bool" default=
"FALSE"/>
33291 <method name=
"SetBrush" type=
"" overloaded=
"no">
33292 <autodoc>SetBrush(self, wxBrush brush, bool isFill=FALSE)
</autodoc>
33294 <param name=
"brush" type=
"Brush" default=
""/>
33295 <param name=
"isFill" type=
"bool" default=
"FALSE"/>
33298 <method name=
"SetFont" type=
"" overloaded=
"no">
33299 <autodoc>SetFont(self, Font font)
</autodoc>
33301 <param name=
"font" type=
"Font" default=
""/>
33304 <method name=
"SetTextColour" type=
"" overloaded=
"no">
33305 <autodoc>SetTextColour(self, Colour colour)
</autodoc>
33307 <param name=
"colour" type=
"Colour" default=
""/>
33310 <method name=
"SetBackgroundColour" type=
"" overloaded=
"no">
33311 <autodoc>SetBackgroundColour(self, Colour colour)
</autodoc>
33313 <param name=
"colour" type=
"Colour" default=
""/>
33316 <method name=
"SetBackgroundMode" type=
"" overloaded=
"no">
33317 <autodoc>SetBackgroundMode(self, int mode)
</autodoc>
33319 <param name=
"mode" type=
"int" default=
""/>
33323 <class name=
"PyRectangleShape" oldname=
"wxPyRectangleShape" module=
"ogl">
33324 <baseclass name=
"PyShape"/>
33325 <constructor name=
"PyRectangleShape" overloaded=
"no">
33326 <autodoc>__init__(self, double width=
0.0, double height=
0.0) -
> PyRectangleShape
</autodoc>
33328 <param name=
"width" type=
"double" default=
"0.0"/>
33329 <param name=
"height" type=
"double" default=
"0.0"/>
33332 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
33333 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
33335 <param name=
"self" type=
"PyObject" default=
""/>
33336 <param name=
"_class" type=
"PyObject" default=
""/>
33339 <method name=
"SetCornerRadius" type=
"" overloaded=
"no">
33340 <autodoc>SetCornerRadius(self, double radius)
</autodoc>
33342 <param name=
"radius" type=
"double" default=
""/>
33345 <method name=
"GetCornerRadius" type=
"double" overloaded=
"no">
33346 <autodoc>GetCornerRadius(self) -
> double
</autodoc>
33348 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
33349 <autodoc>base_OnDelete(self)
</autodoc>
33351 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
33352 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
33354 <param name=
"dc" type=
"DC" default=
""/>
33357 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
33358 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
33360 <param name=
"dc" type=
"DC" default=
""/>
33363 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
33364 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
33366 <param name=
"dc" type=
"DC" default=
""/>
33367 <param name=
"erase" type=
"bool" default=
"FALSE"/>
33370 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
33371 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
33373 <param name=
"dc" type=
"DC" default=
""/>
33376 <method name=
"base_OnErase" type=
"" overloaded=
"no">
33377 <autodoc>base_OnErase(self, DC dc)
</autodoc>
33379 <param name=
"dc" type=
"DC" default=
""/>
33382 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
33383 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
33385 <param name=
"dc" type=
"DC" default=
""/>
33388 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
33389 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
33391 <param name=
"dc" type=
"DC" default=
""/>
33394 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
33395 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33397 <param name=
"x" type=
"double" default=
""/>
33398 <param name=
"y" type=
"double" default=
""/>
33399 <param name=
"keys" type=
"int" default=
"0"/>
33400 <param name=
"attachment" type=
"int" default=
"0"/>
33403 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
33404 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33406 <param name=
"x" type=
"double" default=
""/>
33407 <param name=
"y" type=
"double" default=
""/>
33408 <param name=
"keys" type=
"int" default=
"0"/>
33409 <param name=
"attachment" type=
"int" default=
"0"/>
33412 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
33413 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33415 <param name=
"x" type=
"double" default=
""/>
33416 <param name=
"y" type=
"double" default=
""/>
33417 <param name=
"keys" type=
"int" default=
"0"/>
33418 <param name=
"attachment" type=
"int" default=
"0"/>
33421 <method name=
"base_OnSize" type=
"" overloaded=
"no">
33422 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
33424 <param name=
"x" type=
"double" default=
""/>
33425 <param name=
"y" type=
"double" default=
""/>
33428 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
33429 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
33430 bool display=True) -
> bool
</autodoc>
33432 <param name=
"dc" type=
"DC" default=
""/>
33433 <param name=
"x" type=
"double" default=
""/>
33434 <param name=
"y" type=
"double" default=
""/>
33435 <param name=
"old_x" type=
"double" default=
""/>
33436 <param name=
"old_y" type=
"double" default=
""/>
33437 <param name=
"display" type=
"bool" default=
"True"/>
33440 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
33441 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
33442 bool display=True)
</autodoc>
33444 <param name=
"dc" type=
"DC" default=
""/>
33445 <param name=
"x" type=
"double" default=
""/>
33446 <param name=
"y" type=
"double" default=
""/>
33447 <param name=
"old_x" type=
"double" default=
""/>
33448 <param name=
"old_y" type=
"double" default=
""/>
33449 <param name=
"display" type=
"bool" default=
"True"/>
33452 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
33453 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33455 <param name=
"draw" type=
"bool" default=
""/>
33456 <param name=
"x" type=
"double" default=
""/>
33457 <param name=
"y" type=
"double" default=
""/>
33458 <param name=
"keys" type=
"int" default=
"0"/>
33459 <param name=
"attachment" type=
"int" default=
"0"/>
33462 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
33463 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33465 <param name=
"x" type=
"double" default=
""/>
33466 <param name=
"y" type=
"double" default=
""/>
33467 <param name=
"keys" type=
"int" default=
"0"/>
33468 <param name=
"attachment" type=
"int" default=
"0"/>
33471 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
33472 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33474 <param name=
"x" type=
"double" default=
""/>
33475 <param name=
"y" type=
"double" default=
""/>
33476 <param name=
"keys" type=
"int" default=
"0"/>
33477 <param name=
"attachment" type=
"int" default=
"0"/>
33480 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
33481 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33483 <param name=
"draw" type=
"bool" default=
""/>
33484 <param name=
"x" type=
"double" default=
""/>
33485 <param name=
"y" type=
"double" default=
""/>
33486 <param name=
"keys" type=
"int" default=
"0"/>
33487 <param name=
"attachment" type=
"int" default=
"0"/>
33490 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
33491 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33493 <param name=
"x" type=
"double" default=
""/>
33494 <param name=
"y" type=
"double" default=
""/>
33495 <param name=
"keys" type=
"int" default=
"0"/>
33496 <param name=
"attachment" type=
"int" default=
"0"/>
33499 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
33500 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33502 <param name=
"x" type=
"double" default=
""/>
33503 <param name=
"y" type=
"double" default=
""/>
33504 <param name=
"keys" type=
"int" default=
"0"/>
33505 <param name=
"attachment" type=
"int" default=
"0"/>
33508 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
33509 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
33511 <param name=
"dc" type=
"DC" default=
""/>
33512 <param name=
"x" type=
"double" default=
""/>
33513 <param name=
"y" type=
"double" default=
""/>
33514 <param name=
"w" type=
"double" default=
""/>
33515 <param name=
"h" type=
"double" default=
""/>
33518 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
33519 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
33521 <param name=
"dc" type=
"DC" default=
""/>
33524 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
33525 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
33527 <param name=
"dc" type=
"DC" default=
""/>
33530 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
33531 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
33533 <param name=
"dc" type=
"DC" default=
""/>
33534 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
33537 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
33538 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
33539 int attachment=
0)
</autodoc>
33541 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
33542 <param name=
"draw" type=
"bool" default=
""/>
33543 <param name=
"x" type=
"double" default=
""/>
33544 <param name=
"y" type=
"double" default=
""/>
33545 <param name=
"keys" type=
"int" default=
"0"/>
33546 <param name=
"attachment" type=
"int" default=
"0"/>
33549 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
33550 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
33551 int attachment=
0)
</autodoc>
33553 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
33554 <param name=
"x" type=
"double" default=
""/>
33555 <param name=
"y" type=
"double" default=
""/>
33556 <param name=
"keys" type=
"int" default=
"0"/>
33557 <param name=
"attachment" type=
"int" default=
"0"/>
33560 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
33561 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
33562 int attachment=
0)
</autodoc>
33564 <param name=
"pt" type=
"wxPyControlPoint" default=
""/>
33565 <param name=
"x" type=
"double" default=
""/>
33566 <param name=
"y" type=
"double" default=
""/>
33567 <param name=
"keys" type=
"int" default=
"0"/>
33568 <param name=
"attachment" type=
"int" default=
"0"/>
33571 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
33572 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
33574 <param name=
"w" type=
"double" default=
""/>
33575 <param name=
"h" type=
"double" default=
""/>
33578 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
33579 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
33581 <param name=
"w" type=
"double" default=
""/>
33582 <param name=
"h" type=
"double" default=
""/>
33586 <class name=
"PyControlPoint" oldname=
"wxPyControlPoint" module=
"ogl">
33587 <baseclass name=
"PyRectangleShape"/>
33588 <constructor name=
"PyControlPoint" overloaded=
"no">
33589 <autodoc>__init__(self, PyShapeCanvas the_canvas=None, PyShape object=None,
33590 double size=
0.0, double the_xoffset=
0.0, double the_yoffset=
0.0,
33591 int the_type=
0) -
> PyControlPoint
</autodoc>
33593 <param name=
"the_canvas" type=
"wxPyShapeCanvas" default=
"NULL"/>
33594 <param name=
"object" type=
"PyShape" default=
"NULL"/>
33595 <param name=
"size" type=
"double" default=
"0.0"/>
33596 <param name=
"the_xoffset" type=
"double" default=
"0.0"/>
33597 <param name=
"the_yoffset" type=
"double" default=
"0.0"/>
33598 <param name=
"the_type" type=
"int" default=
"0"/>
33601 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
33602 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
33604 <param name=
"self" type=
"PyObject" default=
""/>
33605 <param name=
"_class" type=
"PyObject" default=
""/>
33608 <method name=
"SetCornerRadius" type=
"" overloaded=
"no">
33609 <autodoc>SetCornerRadius(self, double radius)
</autodoc>
33611 <param name=
"radius" type=
"double" default=
""/>
33614 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
33615 <autodoc>base_OnDelete(self)
</autodoc>
33617 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
33618 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
33620 <param name=
"dc" type=
"DC" default=
""/>
33623 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
33624 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
33626 <param name=
"dc" type=
"DC" default=
""/>
33629 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
33630 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
33632 <param name=
"dc" type=
"DC" default=
""/>
33633 <param name=
"erase" type=
"bool" default=
"FALSE"/>
33636 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
33637 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
33639 <param name=
"dc" type=
"DC" default=
""/>
33642 <method name=
"base_OnErase" type=
"" overloaded=
"no">
33643 <autodoc>base_OnErase(self, DC dc)
</autodoc>
33645 <param name=
"dc" type=
"DC" default=
""/>
33648 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
33649 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
33651 <param name=
"dc" type=
"DC" default=
""/>
33654 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
33655 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
33657 <param name=
"dc" type=
"DC" default=
""/>
33660 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
33661 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33663 <param name=
"x" type=
"double" default=
""/>
33664 <param name=
"y" type=
"double" default=
""/>
33665 <param name=
"keys" type=
"int" default=
"0"/>
33666 <param name=
"attachment" type=
"int" default=
"0"/>
33669 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
33670 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33672 <param name=
"x" type=
"double" default=
""/>
33673 <param name=
"y" type=
"double" default=
""/>
33674 <param name=
"keys" type=
"int" default=
"0"/>
33675 <param name=
"attachment" type=
"int" default=
"0"/>
33678 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
33679 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33681 <param name=
"x" type=
"double" default=
""/>
33682 <param name=
"y" type=
"double" default=
""/>
33683 <param name=
"keys" type=
"int" default=
"0"/>
33684 <param name=
"attachment" type=
"int" default=
"0"/>
33687 <method name=
"base_OnSize" type=
"" overloaded=
"no">
33688 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
33690 <param name=
"x" type=
"double" default=
""/>
33691 <param name=
"y" type=
"double" default=
""/>
33694 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
33695 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
33696 bool display=True) -
> bool
</autodoc>
33698 <param name=
"dc" type=
"DC" default=
""/>
33699 <param name=
"x" type=
"double" default=
""/>
33700 <param name=
"y" type=
"double" default=
""/>
33701 <param name=
"old_x" type=
"double" default=
""/>
33702 <param name=
"old_y" type=
"double" default=
""/>
33703 <param name=
"display" type=
"bool" default=
"True"/>
33706 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
33707 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
33708 bool display=True)
</autodoc>
33710 <param name=
"dc" type=
"DC" default=
""/>
33711 <param name=
"x" type=
"double" default=
""/>
33712 <param name=
"y" type=
"double" default=
""/>
33713 <param name=
"old_x" type=
"double" default=
""/>
33714 <param name=
"old_y" type=
"double" default=
""/>
33715 <param name=
"display" type=
"bool" default=
"True"/>
33718 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
33719 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33721 <param name=
"draw" type=
"bool" default=
""/>
33722 <param name=
"x" type=
"double" default=
""/>
33723 <param name=
"y" type=
"double" default=
""/>
33724 <param name=
"keys" type=
"int" default=
"0"/>
33725 <param name=
"attachment" type=
"int" default=
"0"/>
33728 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
33729 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33731 <param name=
"x" type=
"double" default=
""/>
33732 <param name=
"y" type=
"double" default=
""/>
33733 <param name=
"keys" type=
"int" default=
"0"/>
33734 <param name=
"attachment" type=
"int" default=
"0"/>
33737 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
33738 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33740 <param name=
"x" type=
"double" default=
""/>
33741 <param name=
"y" type=
"double" default=
""/>
33742 <param name=
"keys" type=
"int" default=
"0"/>
33743 <param name=
"attachment" type=
"int" default=
"0"/>
33746 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
33747 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33749 <param name=
"draw" type=
"bool" default=
""/>
33750 <param name=
"x" type=
"double" default=
""/>
33751 <param name=
"y" type=
"double" default=
""/>
33752 <param name=
"keys" type=
"int" default=
"0"/>
33753 <param name=
"attachment" type=
"int" default=
"0"/>
33756 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
33757 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33759 <param name=
"x" type=
"double" default=
""/>
33760 <param name=
"y" type=
"double" default=
""/>
33761 <param name=
"keys" type=
"int" default=
"0"/>
33762 <param name=
"attachment" type=
"int" default=
"0"/>
33765 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
33766 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33768 <param name=
"x" type=
"double" default=
""/>
33769 <param name=
"y" type=
"double" default=
""/>
33770 <param name=
"keys" type=
"int" default=
"0"/>
33771 <param name=
"attachment" type=
"int" default=
"0"/>
33774 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
33775 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
33777 <param name=
"dc" type=
"DC" default=
""/>
33778 <param name=
"x" type=
"double" default=
""/>
33779 <param name=
"y" type=
"double" default=
""/>
33780 <param name=
"w" type=
"double" default=
""/>
33781 <param name=
"h" type=
"double" default=
""/>
33784 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
33785 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
33787 <param name=
"dc" type=
"DC" default=
""/>
33790 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
33791 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
33793 <param name=
"dc" type=
"DC" default=
""/>
33796 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
33797 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
33799 <param name=
"dc" type=
"DC" default=
""/>
33800 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
33803 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
33804 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
33805 int attachment=
0)
</autodoc>
33807 <param name=
"pt" type=
"PyControlPoint" default=
""/>
33808 <param name=
"draw" type=
"bool" default=
""/>
33809 <param name=
"x" type=
"double" default=
""/>
33810 <param name=
"y" type=
"double" default=
""/>
33811 <param name=
"keys" type=
"int" default=
"0"/>
33812 <param name=
"attachment" type=
"int" default=
"0"/>
33815 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
33816 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
33817 int attachment=
0)
</autodoc>
33819 <param name=
"pt" type=
"PyControlPoint" default=
""/>
33820 <param name=
"x" type=
"double" default=
""/>
33821 <param name=
"y" type=
"double" default=
""/>
33822 <param name=
"keys" type=
"int" default=
"0"/>
33823 <param name=
"attachment" type=
"int" default=
"0"/>
33826 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
33827 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
33828 int attachment=
0)
</autodoc>
33830 <param name=
"pt" type=
"PyControlPoint" default=
""/>
33831 <param name=
"x" type=
"double" default=
""/>
33832 <param name=
"y" type=
"double" default=
""/>
33833 <param name=
"keys" type=
"int" default=
"0"/>
33834 <param name=
"attachment" type=
"int" default=
"0"/>
33837 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
33838 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
33840 <param name=
"w" type=
"double" default=
""/>
33841 <param name=
"h" type=
"double" default=
""/>
33844 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
33845 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
33847 <param name=
"w" type=
"double" default=
""/>
33848 <param name=
"h" type=
"double" default=
""/>
33852 <class name=
"PyBitmapShape" oldname=
"wxPyBitmapShape" module=
"ogl">
33853 <baseclass name=
"PyRectangleShape"/>
33854 <constructor name=
"PyBitmapShape" overloaded=
"no">
33855 <autodoc>__init__(self) -
> PyBitmapShape
</autodoc>
33857 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
33858 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
33860 <param name=
"self" type=
"PyObject" default=
""/>
33861 <param name=
"_class" type=
"PyObject" default=
""/>
33864 <method name=
"GetBitmap" type=
"Bitmap" overloaded=
"no">
33865 <autodoc>GetBitmap(self) -
> Bitmap
</autodoc>
33867 <method name=
"GetFilename" type=
"String" overloaded=
"no">
33868 <autodoc>GetFilename(self) -
> String
</autodoc>
33870 <method name=
"SetBitmap" type=
"" overloaded=
"no">
33871 <autodoc>SetBitmap(self, Bitmap bitmap)
</autodoc>
33873 <param name=
"bitmap" type=
"Bitmap" default=
""/>
33876 <method name=
"SetFilename" type=
"" overloaded=
"no">
33877 <autodoc>SetFilename(self, String filename)
</autodoc>
33879 <param name=
"filename" type=
"String" default=
""/>
33882 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
33883 <autodoc>base_OnDelete(self)
</autodoc>
33885 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
33886 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
33888 <param name=
"dc" type=
"DC" default=
""/>
33891 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
33892 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
33894 <param name=
"dc" type=
"DC" default=
""/>
33897 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
33898 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
33900 <param name=
"dc" type=
"DC" default=
""/>
33901 <param name=
"erase" type=
"bool" default=
"FALSE"/>
33904 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
33905 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
33907 <param name=
"dc" type=
"DC" default=
""/>
33910 <method name=
"base_OnErase" type=
"" overloaded=
"no">
33911 <autodoc>base_OnErase(self, DC dc)
</autodoc>
33913 <param name=
"dc" type=
"DC" default=
""/>
33916 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
33917 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
33919 <param name=
"dc" type=
"DC" default=
""/>
33922 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
33923 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
33925 <param name=
"dc" type=
"DC" default=
""/>
33928 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
33929 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33931 <param name=
"x" type=
"double" default=
""/>
33932 <param name=
"y" type=
"double" default=
""/>
33933 <param name=
"keys" type=
"int" default=
"0"/>
33934 <param name=
"attachment" type=
"int" default=
"0"/>
33937 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
33938 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33940 <param name=
"x" type=
"double" default=
""/>
33941 <param name=
"y" type=
"double" default=
""/>
33942 <param name=
"keys" type=
"int" default=
"0"/>
33943 <param name=
"attachment" type=
"int" default=
"0"/>
33946 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
33947 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33949 <param name=
"x" type=
"double" default=
""/>
33950 <param name=
"y" type=
"double" default=
""/>
33951 <param name=
"keys" type=
"int" default=
"0"/>
33952 <param name=
"attachment" type=
"int" default=
"0"/>
33955 <method name=
"base_OnSize" type=
"" overloaded=
"no">
33956 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
33958 <param name=
"x" type=
"double" default=
""/>
33959 <param name=
"y" type=
"double" default=
""/>
33962 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
33963 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
33964 bool display=True) -
> bool
</autodoc>
33966 <param name=
"dc" type=
"DC" default=
""/>
33967 <param name=
"x" type=
"double" default=
""/>
33968 <param name=
"y" type=
"double" default=
""/>
33969 <param name=
"old_x" type=
"double" default=
""/>
33970 <param name=
"old_y" type=
"double" default=
""/>
33971 <param name=
"display" type=
"bool" default=
"True"/>
33974 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
33975 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
33976 bool display=True)
</autodoc>
33978 <param name=
"dc" type=
"DC" default=
""/>
33979 <param name=
"x" type=
"double" default=
""/>
33980 <param name=
"y" type=
"double" default=
""/>
33981 <param name=
"old_x" type=
"double" default=
""/>
33982 <param name=
"old_y" type=
"double" default=
""/>
33983 <param name=
"display" type=
"bool" default=
"True"/>
33986 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
33987 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33989 <param name=
"draw" type=
"bool" default=
""/>
33990 <param name=
"x" type=
"double" default=
""/>
33991 <param name=
"y" type=
"double" default=
""/>
33992 <param name=
"keys" type=
"int" default=
"0"/>
33993 <param name=
"attachment" type=
"int" default=
"0"/>
33996 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
33997 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
33999 <param name=
"x" type=
"double" default=
""/>
34000 <param name=
"y" type=
"double" default=
""/>
34001 <param name=
"keys" type=
"int" default=
"0"/>
34002 <param name=
"attachment" type=
"int" default=
"0"/>
34005 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
34006 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34008 <param name=
"x" type=
"double" default=
""/>
34009 <param name=
"y" type=
"double" default=
""/>
34010 <param name=
"keys" type=
"int" default=
"0"/>
34011 <param name=
"attachment" type=
"int" default=
"0"/>
34014 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
34015 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34017 <param name=
"draw" type=
"bool" default=
""/>
34018 <param name=
"x" type=
"double" default=
""/>
34019 <param name=
"y" type=
"double" default=
""/>
34020 <param name=
"keys" type=
"int" default=
"0"/>
34021 <param name=
"attachment" type=
"int" default=
"0"/>
34024 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
34025 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34027 <param name=
"x" type=
"double" default=
""/>
34028 <param name=
"y" type=
"double" default=
""/>
34029 <param name=
"keys" type=
"int" default=
"0"/>
34030 <param name=
"attachment" type=
"int" default=
"0"/>
34033 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
34034 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34036 <param name=
"x" type=
"double" default=
""/>
34037 <param name=
"y" type=
"double" default=
""/>
34038 <param name=
"keys" type=
"int" default=
"0"/>
34039 <param name=
"attachment" type=
"int" default=
"0"/>
34042 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
34043 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
34045 <param name=
"dc" type=
"DC" default=
""/>
34046 <param name=
"x" type=
"double" default=
""/>
34047 <param name=
"y" type=
"double" default=
""/>
34048 <param name=
"w" type=
"double" default=
""/>
34049 <param name=
"h" type=
"double" default=
""/>
34052 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
34053 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
34055 <param name=
"dc" type=
"DC" default=
""/>
34058 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
34059 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
34061 <param name=
"dc" type=
"DC" default=
""/>
34064 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
34065 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
34067 <param name=
"dc" type=
"DC" default=
""/>
34068 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
34071 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
34072 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
34073 int attachment=
0)
</autodoc>
34075 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34076 <param name=
"draw" type=
"bool" default=
""/>
34077 <param name=
"x" type=
"double" default=
""/>
34078 <param name=
"y" type=
"double" default=
""/>
34079 <param name=
"keys" type=
"int" default=
"0"/>
34080 <param name=
"attachment" type=
"int" default=
"0"/>
34083 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
34084 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
34085 int attachment=
0)
</autodoc>
34087 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34088 <param name=
"x" type=
"double" default=
""/>
34089 <param name=
"y" type=
"double" default=
""/>
34090 <param name=
"keys" type=
"int" default=
"0"/>
34091 <param name=
"attachment" type=
"int" default=
"0"/>
34094 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
34095 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
34096 int attachment=
0)
</autodoc>
34098 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34099 <param name=
"x" type=
"double" default=
""/>
34100 <param name=
"y" type=
"double" default=
""/>
34101 <param name=
"keys" type=
"int" default=
"0"/>
34102 <param name=
"attachment" type=
"int" default=
"0"/>
34105 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
34106 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
34108 <param name=
"w" type=
"double" default=
""/>
34109 <param name=
"h" type=
"double" default=
""/>
34112 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
34113 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
34115 <param name=
"w" type=
"double" default=
""/>
34116 <param name=
"h" type=
"double" default=
""/>
34120 <class name=
"PyDrawnShape" oldname=
"wxPyDrawnShape" module=
"ogl">
34121 <baseclass name=
"PyRectangleShape"/>
34122 <constructor name=
"PyDrawnShape" overloaded=
"no">
34123 <autodoc>__init__(self) -
> PyDrawnShape
</autodoc>
34125 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
34126 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
34128 <param name=
"self" type=
"PyObject" default=
""/>
34129 <param name=
"_class" type=
"PyObject" default=
""/>
34132 <method name=
"CalculateSize" type=
"" overloaded=
"no">
34133 <autodoc>CalculateSize(self)
</autodoc>
34135 <method name=
"DestroyClippingRect" type=
"" overloaded=
"no">
34136 <autodoc>DestroyClippingRect(self)
</autodoc>
34138 <method name=
"DrawArc" type=
"" overloaded=
"no">
34139 <autodoc>DrawArc(self, Point centrePoint, Point startPoint, Point endPoint)
</autodoc>
34141 <param name=
"centrePoint" type=
"Point" default=
""/>
34142 <param name=
"startPoint" type=
"Point" default=
""/>
34143 <param name=
"endPoint" type=
"Point" default=
""/>
34146 <method name=
"DrawAtAngle" type=
"" overloaded=
"no">
34147 <autodoc>DrawAtAngle(self, int angle)
</autodoc>
34149 <param name=
"angle" type=
"int" default=
""/>
34152 <method name=
"DrawEllipticArc" type=
"" overloaded=
"no">
34153 <autodoc>DrawEllipticArc(self, Rect rect, double startAngle, double endAngle)
</autodoc>
34155 <param name=
"rect" type=
"Rect" default=
""/>
34156 <param name=
"startAngle" type=
"double" default=
""/>
34157 <param name=
"endAngle" type=
"double" default=
""/>
34160 <method name=
"DrawLine" type=
"" overloaded=
"no">
34161 <autodoc>DrawLine(self, Point point1, Point point2)
</autodoc>
34163 <param name=
"point1" type=
"Point" default=
""/>
34164 <param name=
"point2" type=
"Point" default=
""/>
34167 <method name=
"DrawLines" type=
"" overloaded=
"no">
34168 <autodoc>DrawLines(self, int points, Point points_array)
</autodoc>
34170 <param name=
"points" type=
"int" default=
""/>
34171 <param name=
"points_array" type=
"Point" default=
""/>
34174 <method name=
"DrawPoint" type=
"" overloaded=
"no">
34175 <autodoc>DrawPoint(self, Point point)
</autodoc>
34177 <param name=
"point" type=
"Point" default=
""/>
34180 <method name=
"DrawPolygon" type=
"" overloaded=
"no">
34181 <autodoc>DrawPolygon(self, int points, Point points_array, int flags=
0)
</autodoc>
34183 <param name=
"points" type=
"int" default=
""/>
34184 <param name=
"points_array" type=
"Point" default=
""/>
34185 <param name=
"flags" type=
"int" default=
"0"/>
34188 <method name=
"DrawRectangle" type=
"" overloaded=
"no">
34189 <autodoc>DrawRectangle(self, Rect rect)
</autodoc>
34191 <param name=
"rect" type=
"Rect" default=
""/>
34194 <method name=
"DrawRoundedRectangle" type=
"" overloaded=
"no">
34195 <autodoc>DrawRoundedRectangle(self, Rect rect, double radius)
</autodoc>
34197 <param name=
"rect" type=
"Rect" default=
""/>
34198 <param name=
"radius" type=
"double" default=
""/>
34201 <method name=
"DrawSpline" type=
"" overloaded=
"no">
34202 <autodoc>DrawSpline(self, int points, Point points_array)
</autodoc>
34204 <param name=
"points" type=
"int" default=
""/>
34205 <param name=
"points_array" type=
"Point" default=
""/>
34208 <method name=
"DrawText" type=
"" overloaded=
"no">
34209 <autodoc>DrawText(self, String text, Point point)
</autodoc>
34211 <param name=
"text" type=
"String" default=
""/>
34212 <param name=
"point" type=
"Point" default=
""/>
34215 <method name=
"GetAngle" type=
"int" overloaded=
"no">
34216 <autodoc>GetAngle(self) -
> int
</autodoc>
34218 <method name=
"GetMetaFile" type=
"PseudoMetaFile" overloaded=
"no">
34219 <autodoc>GetMetaFile(self) -
> PseudoMetaFile
</autodoc>
34221 <method name=
"GetRotation" type=
"double" overloaded=
"no">
34222 <autodoc>GetRotation(self) -
> double
</autodoc>
34224 <method name=
"LoadFromMetaFile" type=
"bool" overloaded=
"no">
34225 <autodoc>LoadFromMetaFile(self, String filename) -
> bool
</autodoc>
34227 <param name=
"filename" type=
"String" default=
""/>
34230 <method name=
"Rotate" type=
"" overloaded=
"no">
34231 <autodoc>Rotate(self, double x, double y, double theta)
</autodoc>
34233 <param name=
"x" type=
"double" default=
""/>
34234 <param name=
"y" type=
"double" default=
""/>
34235 <param name=
"theta" type=
"double" default=
""/>
34238 <method name=
"SetClippingRect" type=
"" overloaded=
"no">
34239 <autodoc>SetClippingRect(self, Rect rect)
</autodoc>
34241 <param name=
"rect" type=
"Rect" default=
""/>
34244 <method name=
"SetDrawnBackgroundColour" type=
"" overloaded=
"no">
34245 <autodoc>SetDrawnBackgroundColour(self, Colour colour)
</autodoc>
34247 <param name=
"colour" type=
"Colour" default=
""/>
34250 <method name=
"SetDrawnBackgroundMode" type=
"" overloaded=
"no">
34251 <autodoc>SetDrawnBackgroundMode(self, int mode)
</autodoc>
34253 <param name=
"mode" type=
"int" default=
""/>
34256 <method name=
"SetDrawnBrush" type=
"" overloaded=
"no">
34257 <autodoc>SetDrawnBrush(self, wxBrush pen, bool isOutline=FALSE)
</autodoc>
34259 <param name=
"pen" type=
"Brush" default=
""/>
34260 <param name=
"isOutline" type=
"bool" default=
"FALSE"/>
34263 <method name=
"SetDrawnFont" type=
"" overloaded=
"no">
34264 <autodoc>SetDrawnFont(self, Font font)
</autodoc>
34266 <param name=
"font" type=
"Font" default=
""/>
34269 <method name=
"SetDrawnPen" type=
"" overloaded=
"no">
34270 <autodoc>SetDrawnPen(self, wxPen pen, bool isOutline=FALSE)
</autodoc>
34272 <param name=
"pen" type=
"Pen" default=
""/>
34273 <param name=
"isOutline" type=
"bool" default=
"FALSE"/>
34276 <method name=
"SetDrawnTextColour" type=
"" overloaded=
"no">
34277 <autodoc>SetDrawnTextColour(self, Colour colour)
</autodoc>
34279 <param name=
"colour" type=
"Colour" default=
""/>
34282 <method name=
"Scale" type=
"" overloaded=
"no">
34283 <autodoc>Scale(self, double sx, double sy)
</autodoc>
34285 <param name=
"sx" type=
"double" default=
""/>
34286 <param name=
"sy" type=
"double" default=
""/>
34289 <method name=
"SetSaveToFile" type=
"" overloaded=
"no">
34290 <autodoc>SetSaveToFile(self, bool save)
</autodoc>
34292 <param name=
"save" type=
"bool" default=
""/>
34295 <method name=
"Translate" type=
"" overloaded=
"no">
34296 <autodoc>Translate(self, double x, double y)
</autodoc>
34298 <param name=
"x" type=
"double" default=
""/>
34299 <param name=
"y" type=
"double" default=
""/>
34302 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
34303 <autodoc>base_OnDelete(self)
</autodoc>
34305 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
34306 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
34308 <param name=
"dc" type=
"DC" default=
""/>
34311 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
34312 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
34314 <param name=
"dc" type=
"DC" default=
""/>
34317 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
34318 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
34320 <param name=
"dc" type=
"DC" default=
""/>
34321 <param name=
"erase" type=
"bool" default=
"FALSE"/>
34324 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
34325 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
34327 <param name=
"dc" type=
"DC" default=
""/>
34330 <method name=
"base_OnErase" type=
"" overloaded=
"no">
34331 <autodoc>base_OnErase(self, DC dc)
</autodoc>
34333 <param name=
"dc" type=
"DC" default=
""/>
34336 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
34337 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
34339 <param name=
"dc" type=
"DC" default=
""/>
34342 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
34343 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
34345 <param name=
"dc" type=
"DC" default=
""/>
34348 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
34349 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34351 <param name=
"x" type=
"double" default=
""/>
34352 <param name=
"y" type=
"double" default=
""/>
34353 <param name=
"keys" type=
"int" default=
"0"/>
34354 <param name=
"attachment" type=
"int" default=
"0"/>
34357 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
34358 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34360 <param name=
"x" type=
"double" default=
""/>
34361 <param name=
"y" type=
"double" default=
""/>
34362 <param name=
"keys" type=
"int" default=
"0"/>
34363 <param name=
"attachment" type=
"int" default=
"0"/>
34366 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
34367 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34369 <param name=
"x" type=
"double" default=
""/>
34370 <param name=
"y" type=
"double" default=
""/>
34371 <param name=
"keys" type=
"int" default=
"0"/>
34372 <param name=
"attachment" type=
"int" default=
"0"/>
34375 <method name=
"base_OnSize" type=
"" overloaded=
"no">
34376 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
34378 <param name=
"x" type=
"double" default=
""/>
34379 <param name=
"y" type=
"double" default=
""/>
34382 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
34383 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
34384 bool display=True) -
> bool
</autodoc>
34386 <param name=
"dc" type=
"DC" default=
""/>
34387 <param name=
"x" type=
"double" default=
""/>
34388 <param name=
"y" type=
"double" default=
""/>
34389 <param name=
"old_x" type=
"double" default=
""/>
34390 <param name=
"old_y" type=
"double" default=
""/>
34391 <param name=
"display" type=
"bool" default=
"True"/>
34394 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
34395 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
34396 bool display=True)
</autodoc>
34398 <param name=
"dc" type=
"DC" default=
""/>
34399 <param name=
"x" type=
"double" default=
""/>
34400 <param name=
"y" type=
"double" default=
""/>
34401 <param name=
"old_x" type=
"double" default=
""/>
34402 <param name=
"old_y" type=
"double" default=
""/>
34403 <param name=
"display" type=
"bool" default=
"True"/>
34406 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
34407 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34409 <param name=
"draw" type=
"bool" default=
""/>
34410 <param name=
"x" type=
"double" default=
""/>
34411 <param name=
"y" type=
"double" default=
""/>
34412 <param name=
"keys" type=
"int" default=
"0"/>
34413 <param name=
"attachment" type=
"int" default=
"0"/>
34416 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
34417 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34419 <param name=
"x" type=
"double" default=
""/>
34420 <param name=
"y" type=
"double" default=
""/>
34421 <param name=
"keys" type=
"int" default=
"0"/>
34422 <param name=
"attachment" type=
"int" default=
"0"/>
34425 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
34426 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34428 <param name=
"x" type=
"double" default=
""/>
34429 <param name=
"y" type=
"double" default=
""/>
34430 <param name=
"keys" type=
"int" default=
"0"/>
34431 <param name=
"attachment" type=
"int" default=
"0"/>
34434 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
34435 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34437 <param name=
"draw" type=
"bool" default=
""/>
34438 <param name=
"x" type=
"double" default=
""/>
34439 <param name=
"y" type=
"double" default=
""/>
34440 <param name=
"keys" type=
"int" default=
"0"/>
34441 <param name=
"attachment" type=
"int" default=
"0"/>
34444 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
34445 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34447 <param name=
"x" type=
"double" default=
""/>
34448 <param name=
"y" type=
"double" default=
""/>
34449 <param name=
"keys" type=
"int" default=
"0"/>
34450 <param name=
"attachment" type=
"int" default=
"0"/>
34453 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
34454 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34456 <param name=
"x" type=
"double" default=
""/>
34457 <param name=
"y" type=
"double" default=
""/>
34458 <param name=
"keys" type=
"int" default=
"0"/>
34459 <param name=
"attachment" type=
"int" default=
"0"/>
34462 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
34463 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
34465 <param name=
"dc" type=
"DC" default=
""/>
34466 <param name=
"x" type=
"double" default=
""/>
34467 <param name=
"y" type=
"double" default=
""/>
34468 <param name=
"w" type=
"double" default=
""/>
34469 <param name=
"h" type=
"double" default=
""/>
34472 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
34473 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
34475 <param name=
"dc" type=
"DC" default=
""/>
34478 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
34479 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
34481 <param name=
"dc" type=
"DC" default=
""/>
34484 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
34485 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
34487 <param name=
"dc" type=
"DC" default=
""/>
34488 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
34491 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
34492 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
34493 int attachment=
0)
</autodoc>
34495 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34496 <param name=
"draw" type=
"bool" default=
""/>
34497 <param name=
"x" type=
"double" default=
""/>
34498 <param name=
"y" type=
"double" default=
""/>
34499 <param name=
"keys" type=
"int" default=
"0"/>
34500 <param name=
"attachment" type=
"int" default=
"0"/>
34503 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
34504 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
34505 int attachment=
0)
</autodoc>
34507 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34508 <param name=
"x" type=
"double" default=
""/>
34509 <param name=
"y" type=
"double" default=
""/>
34510 <param name=
"keys" type=
"int" default=
"0"/>
34511 <param name=
"attachment" type=
"int" default=
"0"/>
34514 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
34515 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
34516 int attachment=
0)
</autodoc>
34518 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34519 <param name=
"x" type=
"double" default=
""/>
34520 <param name=
"y" type=
"double" default=
""/>
34521 <param name=
"keys" type=
"int" default=
"0"/>
34522 <param name=
"attachment" type=
"int" default=
"0"/>
34525 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
34526 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
34528 <param name=
"w" type=
"double" default=
""/>
34529 <param name=
"h" type=
"double" default=
""/>
34532 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
34533 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
34535 <param name=
"w" type=
"double" default=
""/>
34536 <param name=
"h" type=
"double" default=
""/>
34540 <class name=
"OGLConstraint" oldname=
"wxOGLConstraint" module=
"ogl">
34541 <baseclass name=
"Object"/>
34542 <constructor name=
"OGLConstraint" overloaded=
"no">
34543 <autodoc>__init__(self, int type, PyShape constraining, PyObject constrained) -
> OGLConstraint
</autodoc>
34545 <param name=
"type" type=
"int" default=
""/>
34546 <param name=
"constraining" type=
"PyShape" default=
""/>
34547 <param name=
"constrained" type=
"PyObject" default=
""/>
34550 <method name=
"Evaluate" type=
"bool" overloaded=
"no">
34551 <autodoc>Evaluate(self) -
> bool
</autodoc>
34553 <method name=
"SetSpacing" type=
"" overloaded=
"no">
34554 <autodoc>SetSpacing(self, double x, double y)
</autodoc>
34556 <param name=
"x" type=
"double" default=
""/>
34557 <param name=
"y" type=
"double" default=
""/>
34560 <method name=
"Equals" type=
"bool" overloaded=
"no">
34561 <autodoc>Equals(self, double a, double b) -
> bool
</autodoc>
34563 <param name=
"a" type=
"double" default=
""/>
34564 <param name=
"b" type=
"double" default=
""/>
34568 <class name=
"PyCompositeShape" oldname=
"wxPyCompositeShape" module=
"ogl">
34569 <baseclass name=
"PyRectangleShape"/>
34570 <constructor name=
"PyCompositeShape" overloaded=
"no">
34571 <autodoc>__init__(self) -
> PyCompositeShape
</autodoc>
34573 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
34574 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
34576 <param name=
"self" type=
"PyObject" default=
""/>
34577 <param name=
"_class" type=
"PyObject" default=
""/>
34580 <method name=
"AddChild" type=
"" overloaded=
"no">
34581 <autodoc>AddChild(self, PyShape child, PyShape addAfter=None)
</autodoc>
34583 <param name=
"child" type=
"PyShape" default=
""/>
34584 <param name=
"addAfter" type=
"PyShape" default=
"NULL"/>
34587 <method name=
"AddConstraint" type=
"OGLConstraint" overloaded=
"no">
34588 <autodoc>AddConstraint(self, OGLConstraint constraint) -
> OGLConstraint
</autodoc>
34590 <param name=
"constraint" type=
"OGLConstraint" default=
""/>
34593 <method name=
"AddConstrainedShapes" type=
"OGLConstraint" overloaded=
"no">
34594 <autodoc>AddConstrainedShapes(self, int type, PyShape constraining, PyObject constrained) -
> OGLConstraint
</autodoc>
34596 <param name=
"type" type=
"int" default=
""/>
34597 <param name=
"constraining" type=
"PyShape" default=
""/>
34598 <param name=
"constrained" type=
"PyObject" default=
""/>
34601 <method name=
"AddSimpleConstraint" type=
"OGLConstraint" overloaded=
"no">
34602 <autodoc>AddSimpleConstraint(self, int type, PyShape constraining, PyShape constrained) -
> OGLConstraint
</autodoc>
34604 <param name=
"type" type=
"int" default=
""/>
34605 <param name=
"constraining" type=
"PyShape" default=
""/>
34606 <param name=
"constrained" type=
"PyShape" default=
""/>
34609 <method name=
"CalculateSize" type=
"" overloaded=
"no">
34610 <autodoc>CalculateSize(self)
</autodoc>
34612 <method name=
"ContainsDivision" type=
"bool" overloaded=
"no">
34613 <autodoc>ContainsDivision(self, PyDivisionShape division) -
> bool
</autodoc>
34615 <param name=
"division" type=
"wxPyDivisionShape" default=
""/>
34618 <method name=
"DeleteConstraint" type=
"" overloaded=
"no">
34619 <autodoc>DeleteConstraint(self, OGLConstraint constraint)
</autodoc>
34621 <param name=
"constraint" type=
"OGLConstraint" default=
""/>
34624 <method name=
"DeleteConstraintsInvolvingChild" type=
"" overloaded=
"no">
34625 <autodoc>DeleteConstraintsInvolvingChild(self, PyShape child)
</autodoc>
34627 <param name=
"child" type=
"PyShape" default=
""/>
34630 <method name=
"FindContainerImage" type=
"PyShape" overloaded=
"no">
34631 <autodoc>FindContainerImage(self) -
> PyShape
</autodoc>
34633 <method name=
"GetConstraints" type=
"PyObject" overloaded=
"no">
34634 <autodoc>GetConstraints(self) -
> PyObject
</autodoc>
34636 <method name=
"GetDivisions" type=
"PyObject" overloaded=
"no">
34637 <autodoc>GetDivisions(self) -
> PyObject
</autodoc>
34639 <method name=
"MakeContainer" type=
"" overloaded=
"no">
34640 <autodoc>MakeContainer(self)
</autodoc>
34642 <method name=
"Recompute" type=
"bool" overloaded=
"no">
34643 <autodoc>Recompute(self) -
> bool
</autodoc>
34645 <method name=
"RemoveChild" type=
"" overloaded=
"no">
34646 <autodoc>RemoveChild(self, PyShape child)
</autodoc>
34648 <param name=
"child" type=
"PyShape" default=
""/>
34651 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
34652 <autodoc>base_OnDelete(self)
</autodoc>
34654 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
34655 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
34657 <param name=
"dc" type=
"DC" default=
""/>
34660 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
34661 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
34663 <param name=
"dc" type=
"DC" default=
""/>
34666 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
34667 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
34669 <param name=
"dc" type=
"DC" default=
""/>
34670 <param name=
"erase" type=
"bool" default=
"FALSE"/>
34673 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
34674 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
34676 <param name=
"dc" type=
"DC" default=
""/>
34679 <method name=
"base_OnErase" type=
"" overloaded=
"no">
34680 <autodoc>base_OnErase(self, DC dc)
</autodoc>
34682 <param name=
"dc" type=
"DC" default=
""/>
34685 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
34686 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
34688 <param name=
"dc" type=
"DC" default=
""/>
34691 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
34692 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
34694 <param name=
"dc" type=
"DC" default=
""/>
34697 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
34698 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34700 <param name=
"x" type=
"double" default=
""/>
34701 <param name=
"y" type=
"double" default=
""/>
34702 <param name=
"keys" type=
"int" default=
"0"/>
34703 <param name=
"attachment" type=
"int" default=
"0"/>
34706 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
34707 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34709 <param name=
"x" type=
"double" default=
""/>
34710 <param name=
"y" type=
"double" default=
""/>
34711 <param name=
"keys" type=
"int" default=
"0"/>
34712 <param name=
"attachment" type=
"int" default=
"0"/>
34715 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
34716 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34718 <param name=
"x" type=
"double" default=
""/>
34719 <param name=
"y" type=
"double" default=
""/>
34720 <param name=
"keys" type=
"int" default=
"0"/>
34721 <param name=
"attachment" type=
"int" default=
"0"/>
34724 <method name=
"base_OnSize" type=
"" overloaded=
"no">
34725 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
34727 <param name=
"x" type=
"double" default=
""/>
34728 <param name=
"y" type=
"double" default=
""/>
34731 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
34732 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
34733 bool display=True) -
> bool
</autodoc>
34735 <param name=
"dc" type=
"DC" default=
""/>
34736 <param name=
"x" type=
"double" default=
""/>
34737 <param name=
"y" type=
"double" default=
""/>
34738 <param name=
"old_x" type=
"double" default=
""/>
34739 <param name=
"old_y" type=
"double" default=
""/>
34740 <param name=
"display" type=
"bool" default=
"True"/>
34743 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
34744 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
34745 bool display=True)
</autodoc>
34747 <param name=
"dc" type=
"DC" default=
""/>
34748 <param name=
"x" type=
"double" default=
""/>
34749 <param name=
"y" type=
"double" default=
""/>
34750 <param name=
"old_x" type=
"double" default=
""/>
34751 <param name=
"old_y" type=
"double" default=
""/>
34752 <param name=
"display" type=
"bool" default=
"True"/>
34755 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
34756 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34758 <param name=
"draw" type=
"bool" default=
""/>
34759 <param name=
"x" type=
"double" default=
""/>
34760 <param name=
"y" type=
"double" default=
""/>
34761 <param name=
"keys" type=
"int" default=
"0"/>
34762 <param name=
"attachment" type=
"int" default=
"0"/>
34765 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
34766 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34768 <param name=
"x" type=
"double" default=
""/>
34769 <param name=
"y" type=
"double" default=
""/>
34770 <param name=
"keys" type=
"int" default=
"0"/>
34771 <param name=
"attachment" type=
"int" default=
"0"/>
34774 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
34775 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34777 <param name=
"x" type=
"double" default=
""/>
34778 <param name=
"y" type=
"double" default=
""/>
34779 <param name=
"keys" type=
"int" default=
"0"/>
34780 <param name=
"attachment" type=
"int" default=
"0"/>
34783 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
34784 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34786 <param name=
"draw" type=
"bool" default=
""/>
34787 <param name=
"x" type=
"double" default=
""/>
34788 <param name=
"y" type=
"double" default=
""/>
34789 <param name=
"keys" type=
"int" default=
"0"/>
34790 <param name=
"attachment" type=
"int" default=
"0"/>
34793 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
34794 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34796 <param name=
"x" type=
"double" default=
""/>
34797 <param name=
"y" type=
"double" default=
""/>
34798 <param name=
"keys" type=
"int" default=
"0"/>
34799 <param name=
"attachment" type=
"int" default=
"0"/>
34802 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
34803 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34805 <param name=
"x" type=
"double" default=
""/>
34806 <param name=
"y" type=
"double" default=
""/>
34807 <param name=
"keys" type=
"int" default=
"0"/>
34808 <param name=
"attachment" type=
"int" default=
"0"/>
34811 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
34812 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
34814 <param name=
"dc" type=
"DC" default=
""/>
34815 <param name=
"x" type=
"double" default=
""/>
34816 <param name=
"y" type=
"double" default=
""/>
34817 <param name=
"w" type=
"double" default=
""/>
34818 <param name=
"h" type=
"double" default=
""/>
34821 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
34822 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
34824 <param name=
"dc" type=
"DC" default=
""/>
34827 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
34828 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
34830 <param name=
"dc" type=
"DC" default=
""/>
34833 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
34834 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
34836 <param name=
"dc" type=
"DC" default=
""/>
34837 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
34840 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
34841 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
34842 int attachment=
0)
</autodoc>
34844 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34845 <param name=
"draw" type=
"bool" default=
""/>
34846 <param name=
"x" type=
"double" default=
""/>
34847 <param name=
"y" type=
"double" default=
""/>
34848 <param name=
"keys" type=
"int" default=
"0"/>
34849 <param name=
"attachment" type=
"int" default=
"0"/>
34852 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
34853 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
34854 int attachment=
0)
</autodoc>
34856 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34857 <param name=
"x" type=
"double" default=
""/>
34858 <param name=
"y" type=
"double" default=
""/>
34859 <param name=
"keys" type=
"int" default=
"0"/>
34860 <param name=
"attachment" type=
"int" default=
"0"/>
34863 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
34864 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
34865 int attachment=
0)
</autodoc>
34867 <param name=
"pt" type=
"PyControlPoint" default=
""/>
34868 <param name=
"x" type=
"double" default=
""/>
34869 <param name=
"y" type=
"double" default=
""/>
34870 <param name=
"keys" type=
"int" default=
"0"/>
34871 <param name=
"attachment" type=
"int" default=
"0"/>
34874 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
34875 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
34877 <param name=
"w" type=
"double" default=
""/>
34878 <param name=
"h" type=
"double" default=
""/>
34881 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
34882 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
34884 <param name=
"w" type=
"double" default=
""/>
34885 <param name=
"h" type=
"double" default=
""/>
34889 <class name=
"PyDividedShape" oldname=
"wxPyDividedShape" module=
"ogl">
34890 <baseclass name=
"PyRectangleShape"/>
34891 <constructor name=
"PyDividedShape" overloaded=
"no">
34892 <autodoc>__init__(self, double width=
0.0, double height=
0.0) -
> PyDividedShape
</autodoc>
34894 <param name=
"width" type=
"double" default=
"0.0"/>
34895 <param name=
"height" type=
"double" default=
"0.0"/>
34898 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
34899 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
34901 <param name=
"self" type=
"PyObject" default=
""/>
34902 <param name=
"_class" type=
"PyObject" default=
""/>
34905 <method name=
"EditRegions" type=
"" overloaded=
"no">
34906 <autodoc>EditRegions(self)
</autodoc>
34908 <method name=
"SetRegionSizes" type=
"" overloaded=
"no">
34909 <autodoc>SetRegionSizes(self)
</autodoc>
34911 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
34912 <autodoc>base_OnDelete(self)
</autodoc>
34914 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
34915 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
34917 <param name=
"dc" type=
"DC" default=
""/>
34920 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
34921 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
34923 <param name=
"dc" type=
"DC" default=
""/>
34926 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
34927 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
34929 <param name=
"dc" type=
"DC" default=
""/>
34930 <param name=
"erase" type=
"bool" default=
"FALSE"/>
34933 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
34934 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
34936 <param name=
"dc" type=
"DC" default=
""/>
34939 <method name=
"base_OnErase" type=
"" overloaded=
"no">
34940 <autodoc>base_OnErase(self, DC dc)
</autodoc>
34942 <param name=
"dc" type=
"DC" default=
""/>
34945 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
34946 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
34948 <param name=
"dc" type=
"DC" default=
""/>
34951 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
34952 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
34954 <param name=
"dc" type=
"DC" default=
""/>
34957 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
34958 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34960 <param name=
"x" type=
"double" default=
""/>
34961 <param name=
"y" type=
"double" default=
""/>
34962 <param name=
"keys" type=
"int" default=
"0"/>
34963 <param name=
"attachment" type=
"int" default=
"0"/>
34966 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
34967 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34969 <param name=
"x" type=
"double" default=
""/>
34970 <param name=
"y" type=
"double" default=
""/>
34971 <param name=
"keys" type=
"int" default=
"0"/>
34972 <param name=
"attachment" type=
"int" default=
"0"/>
34975 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
34976 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
34978 <param name=
"x" type=
"double" default=
""/>
34979 <param name=
"y" type=
"double" default=
""/>
34980 <param name=
"keys" type=
"int" default=
"0"/>
34981 <param name=
"attachment" type=
"int" default=
"0"/>
34984 <method name=
"base_OnSize" type=
"" overloaded=
"no">
34985 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
34987 <param name=
"x" type=
"double" default=
""/>
34988 <param name=
"y" type=
"double" default=
""/>
34991 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
34992 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
34993 bool display=True) -
> bool
</autodoc>
34995 <param name=
"dc" type=
"DC" default=
""/>
34996 <param name=
"x" type=
"double" default=
""/>
34997 <param name=
"y" type=
"double" default=
""/>
34998 <param name=
"old_x" type=
"double" default=
""/>
34999 <param name=
"old_y" type=
"double" default=
""/>
35000 <param name=
"display" type=
"bool" default=
"True"/>
35003 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
35004 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
35005 bool display=True)
</autodoc>
35007 <param name=
"dc" type=
"DC" default=
""/>
35008 <param name=
"x" type=
"double" default=
""/>
35009 <param name=
"y" type=
"double" default=
""/>
35010 <param name=
"old_x" type=
"double" default=
""/>
35011 <param name=
"old_y" type=
"double" default=
""/>
35012 <param name=
"display" type=
"bool" default=
"True"/>
35015 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
35016 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35018 <param name=
"draw" type=
"bool" default=
""/>
35019 <param name=
"x" type=
"double" default=
""/>
35020 <param name=
"y" type=
"double" default=
""/>
35021 <param name=
"keys" type=
"int" default=
"0"/>
35022 <param name=
"attachment" type=
"int" default=
"0"/>
35025 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
35026 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35028 <param name=
"x" type=
"double" default=
""/>
35029 <param name=
"y" type=
"double" default=
""/>
35030 <param name=
"keys" type=
"int" default=
"0"/>
35031 <param name=
"attachment" type=
"int" default=
"0"/>
35034 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
35035 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35037 <param name=
"x" type=
"double" default=
""/>
35038 <param name=
"y" type=
"double" default=
""/>
35039 <param name=
"keys" type=
"int" default=
"0"/>
35040 <param name=
"attachment" type=
"int" default=
"0"/>
35043 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
35044 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35046 <param name=
"draw" type=
"bool" default=
""/>
35047 <param name=
"x" type=
"double" default=
""/>
35048 <param name=
"y" type=
"double" default=
""/>
35049 <param name=
"keys" type=
"int" default=
"0"/>
35050 <param name=
"attachment" type=
"int" default=
"0"/>
35053 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
35054 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35056 <param name=
"x" type=
"double" default=
""/>
35057 <param name=
"y" type=
"double" default=
""/>
35058 <param name=
"keys" type=
"int" default=
"0"/>
35059 <param name=
"attachment" type=
"int" default=
"0"/>
35062 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
35063 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35065 <param name=
"x" type=
"double" default=
""/>
35066 <param name=
"y" type=
"double" default=
""/>
35067 <param name=
"keys" type=
"int" default=
"0"/>
35068 <param name=
"attachment" type=
"int" default=
"0"/>
35071 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
35072 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
35074 <param name=
"dc" type=
"DC" default=
""/>
35075 <param name=
"x" type=
"double" default=
""/>
35076 <param name=
"y" type=
"double" default=
""/>
35077 <param name=
"w" type=
"double" default=
""/>
35078 <param name=
"h" type=
"double" default=
""/>
35081 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
35082 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
35084 <param name=
"dc" type=
"DC" default=
""/>
35087 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
35088 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
35090 <param name=
"dc" type=
"DC" default=
""/>
35093 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
35094 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
35096 <param name=
"dc" type=
"DC" default=
""/>
35097 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
35100 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
35101 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
35102 int attachment=
0)
</autodoc>
35104 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35105 <param name=
"draw" type=
"bool" default=
""/>
35106 <param name=
"x" type=
"double" default=
""/>
35107 <param name=
"y" type=
"double" default=
""/>
35108 <param name=
"keys" type=
"int" default=
"0"/>
35109 <param name=
"attachment" type=
"int" default=
"0"/>
35112 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
35113 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
35114 int attachment=
0)
</autodoc>
35116 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35117 <param name=
"x" type=
"double" default=
""/>
35118 <param name=
"y" type=
"double" default=
""/>
35119 <param name=
"keys" type=
"int" default=
"0"/>
35120 <param name=
"attachment" type=
"int" default=
"0"/>
35123 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
35124 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
35125 int attachment=
0)
</autodoc>
35127 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35128 <param name=
"x" type=
"double" default=
""/>
35129 <param name=
"y" type=
"double" default=
""/>
35130 <param name=
"keys" type=
"int" default=
"0"/>
35131 <param name=
"attachment" type=
"int" default=
"0"/>
35134 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
35135 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
35137 <param name=
"w" type=
"double" default=
""/>
35138 <param name=
"h" type=
"double" default=
""/>
35141 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
35142 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
35144 <param name=
"w" type=
"double" default=
""/>
35145 <param name=
"h" type=
"double" default=
""/>
35149 <class name=
"PyDivisionShape" oldname=
"wxPyDivisionShape" module=
"ogl">
35150 <baseclass name=
"PyCompositeShape"/>
35151 <constructor name=
"PyDivisionShape" overloaded=
"no">
35152 <autodoc>__init__(self) -
> PyDivisionShape
</autodoc>
35154 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
35155 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
35157 <param name=
"self" type=
"PyObject" default=
""/>
35158 <param name=
"_class" type=
"PyObject" default=
""/>
35161 <method name=
"AdjustBottom" type=
"" overloaded=
"no">
35162 <autodoc>AdjustBottom(self, double bottom, bool test)
</autodoc>
35164 <param name=
"bottom" type=
"double" default=
""/>
35165 <param name=
"test" type=
"bool" default=
""/>
35168 <method name=
"AdjustLeft" type=
"" overloaded=
"no">
35169 <autodoc>AdjustLeft(self, double left, bool test)
</autodoc>
35171 <param name=
"left" type=
"double" default=
""/>
35172 <param name=
"test" type=
"bool" default=
""/>
35175 <method name=
"AdjustRight" type=
"" overloaded=
"no">
35176 <autodoc>AdjustRight(self, double right, bool test)
</autodoc>
35178 <param name=
"right" type=
"double" default=
""/>
35179 <param name=
"test" type=
"bool" default=
""/>
35182 <method name=
"AdjustTop" type=
"" overloaded=
"no">
35183 <autodoc>AdjustTop(self, double top, bool test)
</autodoc>
35185 <param name=
"top" type=
"double" default=
""/>
35186 <param name=
"test" type=
"bool" default=
""/>
35189 <method name=
"Divide" type=
"" overloaded=
"no">
35190 <autodoc>Divide(self, int direction)
</autodoc>
35192 <param name=
"direction" type=
"int" default=
""/>
35195 <method name=
"EditEdge" type=
"" overloaded=
"no">
35196 <autodoc>EditEdge(self, int side)
</autodoc>
35198 <param name=
"side" type=
"int" default=
""/>
35201 <method name=
"GetBottomSide" type=
"PyDivisionShape" overloaded=
"no">
35202 <autodoc>GetBottomSide(self) -
> PyDivisionShape
</autodoc>
35204 <method name=
"GetHandleSide" type=
"int" overloaded=
"no">
35205 <autodoc>GetHandleSide(self) -
> int
</autodoc>
35207 <method name=
"GetLeftSide" type=
"PyDivisionShape" overloaded=
"no">
35208 <autodoc>GetLeftSide(self) -
> PyDivisionShape
</autodoc>
35210 <method name=
"GetLeftSideColour" type=
"String" overloaded=
"no">
35211 <autodoc>GetLeftSideColour(self) -
> String
</autodoc>
35213 <method name=
"GetLeftSidePen" type=
"Pen" overloaded=
"no">
35214 <autodoc>GetLeftSidePen(self) -
> wxPen
</autodoc>
35216 <method name=
"GetRightSide" type=
"PyDivisionShape" overloaded=
"no">
35217 <autodoc>GetRightSide(self) -
> PyDivisionShape
</autodoc>
35219 <method name=
"GetTopSide" type=
"PyDivisionShape" overloaded=
"no">
35220 <autodoc>GetTopSide(self) -
> PyDivisionShape
</autodoc>
35222 <method name=
"GetTopSidePen" type=
"Pen" overloaded=
"no">
35223 <autodoc>GetTopSidePen(self) -
> wxPen
</autodoc>
35225 <method name=
"ResizeAdjoining" type=
"" overloaded=
"no">
35226 <autodoc>ResizeAdjoining(self, int side, double newPos, bool test)
</autodoc>
35228 <param name=
"side" type=
"int" default=
""/>
35229 <param name=
"newPos" type=
"double" default=
""/>
35230 <param name=
"test" type=
"bool" default=
""/>
35233 <method name=
"PopupMenu" type=
"" overloaded=
"no">
35234 <autodoc>PopupMenu(self, double x, double y)
</autodoc>
35236 <param name=
"x" type=
"double" default=
""/>
35237 <param name=
"y" type=
"double" default=
""/>
35240 <method name=
"SetBottomSide" type=
"" overloaded=
"no">
35241 <autodoc>SetBottomSide(self, PyDivisionShape shape)
</autodoc>
35243 <param name=
"shape" type=
"PyDivisionShape" default=
""/>
35246 <method name=
"SetHandleSide" type=
"" overloaded=
"no">
35247 <autodoc>SetHandleSide(self, int side)
</autodoc>
35249 <param name=
"side" type=
"int" default=
""/>
35252 <method name=
"SetLeftSide" type=
"" overloaded=
"no">
35253 <autodoc>SetLeftSide(self, PyDivisionShape shape)
</autodoc>
35255 <param name=
"shape" type=
"PyDivisionShape" default=
""/>
35258 <method name=
"SetLeftSideColour" type=
"" overloaded=
"no">
35259 <autodoc>SetLeftSideColour(self, String colour)
</autodoc>
35261 <param name=
"colour" type=
"String" default=
""/>
35264 <method name=
"SetLeftSidePen" type=
"" overloaded=
"no">
35265 <autodoc>SetLeftSidePen(self, wxPen pen)
</autodoc>
35267 <param name=
"pen" type=
"Pen" default=
""/>
35270 <method name=
"SetRightSide" type=
"" overloaded=
"no">
35271 <autodoc>SetRightSide(self, PyDivisionShape shape)
</autodoc>
35273 <param name=
"shape" type=
"PyDivisionShape" default=
""/>
35276 <method name=
"SetTopSide" type=
"" overloaded=
"no">
35277 <autodoc>SetTopSide(self, PyDivisionShape shape)
</autodoc>
35279 <param name=
"shape" type=
"PyDivisionShape" default=
""/>
35282 <method name=
"SetTopSideColour" type=
"" overloaded=
"no">
35283 <autodoc>SetTopSideColour(self, String colour)
</autodoc>
35285 <param name=
"colour" type=
"String" default=
""/>
35288 <method name=
"SetTopSidePen" type=
"" overloaded=
"no">
35289 <autodoc>SetTopSidePen(self, wxPen pen)
</autodoc>
35291 <param name=
"pen" type=
"Pen" default=
""/>
35294 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
35295 <autodoc>base_OnDelete(self)
</autodoc>
35297 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
35298 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
35300 <param name=
"dc" type=
"DC" default=
""/>
35303 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
35304 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
35306 <param name=
"dc" type=
"DC" default=
""/>
35309 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
35310 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
35312 <param name=
"dc" type=
"DC" default=
""/>
35313 <param name=
"erase" type=
"bool" default=
"FALSE"/>
35316 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
35317 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
35319 <param name=
"dc" type=
"DC" default=
""/>
35322 <method name=
"base_OnErase" type=
"" overloaded=
"no">
35323 <autodoc>base_OnErase(self, DC dc)
</autodoc>
35325 <param name=
"dc" type=
"DC" default=
""/>
35328 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
35329 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
35331 <param name=
"dc" type=
"DC" default=
""/>
35334 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
35335 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
35337 <param name=
"dc" type=
"DC" default=
""/>
35340 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
35341 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35343 <param name=
"x" type=
"double" default=
""/>
35344 <param name=
"y" type=
"double" default=
""/>
35345 <param name=
"keys" type=
"int" default=
"0"/>
35346 <param name=
"attachment" type=
"int" default=
"0"/>
35349 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
35350 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35352 <param name=
"x" type=
"double" default=
""/>
35353 <param name=
"y" type=
"double" default=
""/>
35354 <param name=
"keys" type=
"int" default=
"0"/>
35355 <param name=
"attachment" type=
"int" default=
"0"/>
35358 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
35359 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35361 <param name=
"x" type=
"double" default=
""/>
35362 <param name=
"y" type=
"double" default=
""/>
35363 <param name=
"keys" type=
"int" default=
"0"/>
35364 <param name=
"attachment" type=
"int" default=
"0"/>
35367 <method name=
"base_OnSize" type=
"" overloaded=
"no">
35368 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
35370 <param name=
"x" type=
"double" default=
""/>
35371 <param name=
"y" type=
"double" default=
""/>
35374 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
35375 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
35376 bool display=True) -
> bool
</autodoc>
35378 <param name=
"dc" type=
"DC" default=
""/>
35379 <param name=
"x" type=
"double" default=
""/>
35380 <param name=
"y" type=
"double" default=
""/>
35381 <param name=
"old_x" type=
"double" default=
""/>
35382 <param name=
"old_y" type=
"double" default=
""/>
35383 <param name=
"display" type=
"bool" default=
"True"/>
35386 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
35387 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
35388 bool display=True)
</autodoc>
35390 <param name=
"dc" type=
"DC" default=
""/>
35391 <param name=
"x" type=
"double" default=
""/>
35392 <param name=
"y" type=
"double" default=
""/>
35393 <param name=
"old_x" type=
"double" default=
""/>
35394 <param name=
"old_y" type=
"double" default=
""/>
35395 <param name=
"display" type=
"bool" default=
"True"/>
35398 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
35399 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35401 <param name=
"draw" type=
"bool" default=
""/>
35402 <param name=
"x" type=
"double" default=
""/>
35403 <param name=
"y" type=
"double" default=
""/>
35404 <param name=
"keys" type=
"int" default=
"0"/>
35405 <param name=
"attachment" type=
"int" default=
"0"/>
35408 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
35409 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35411 <param name=
"x" type=
"double" default=
""/>
35412 <param name=
"y" type=
"double" default=
""/>
35413 <param name=
"keys" type=
"int" default=
"0"/>
35414 <param name=
"attachment" type=
"int" default=
"0"/>
35417 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
35418 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35420 <param name=
"x" type=
"double" default=
""/>
35421 <param name=
"y" type=
"double" default=
""/>
35422 <param name=
"keys" type=
"int" default=
"0"/>
35423 <param name=
"attachment" type=
"int" default=
"0"/>
35426 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
35427 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35429 <param name=
"draw" type=
"bool" default=
""/>
35430 <param name=
"x" type=
"double" default=
""/>
35431 <param name=
"y" type=
"double" default=
""/>
35432 <param name=
"keys" type=
"int" default=
"0"/>
35433 <param name=
"attachment" type=
"int" default=
"0"/>
35436 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
35437 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35439 <param name=
"x" type=
"double" default=
""/>
35440 <param name=
"y" type=
"double" default=
""/>
35441 <param name=
"keys" type=
"int" default=
"0"/>
35442 <param name=
"attachment" type=
"int" default=
"0"/>
35445 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
35446 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35448 <param name=
"x" type=
"double" default=
""/>
35449 <param name=
"y" type=
"double" default=
""/>
35450 <param name=
"keys" type=
"int" default=
"0"/>
35451 <param name=
"attachment" type=
"int" default=
"0"/>
35454 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
35455 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
35457 <param name=
"dc" type=
"DC" default=
""/>
35458 <param name=
"x" type=
"double" default=
""/>
35459 <param name=
"y" type=
"double" default=
""/>
35460 <param name=
"w" type=
"double" default=
""/>
35461 <param name=
"h" type=
"double" default=
""/>
35464 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
35465 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
35467 <param name=
"dc" type=
"DC" default=
""/>
35470 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
35471 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
35473 <param name=
"dc" type=
"DC" default=
""/>
35476 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
35477 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
35479 <param name=
"dc" type=
"DC" default=
""/>
35480 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
35483 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
35484 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
35485 int attachment=
0)
</autodoc>
35487 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35488 <param name=
"draw" type=
"bool" default=
""/>
35489 <param name=
"x" type=
"double" default=
""/>
35490 <param name=
"y" type=
"double" default=
""/>
35491 <param name=
"keys" type=
"int" default=
"0"/>
35492 <param name=
"attachment" type=
"int" default=
"0"/>
35495 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
35496 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
35497 int attachment=
0)
</autodoc>
35499 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35500 <param name=
"x" type=
"double" default=
""/>
35501 <param name=
"y" type=
"double" default=
""/>
35502 <param name=
"keys" type=
"int" default=
"0"/>
35503 <param name=
"attachment" type=
"int" default=
"0"/>
35506 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
35507 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
35508 int attachment=
0)
</autodoc>
35510 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35511 <param name=
"x" type=
"double" default=
""/>
35512 <param name=
"y" type=
"double" default=
""/>
35513 <param name=
"keys" type=
"int" default=
"0"/>
35514 <param name=
"attachment" type=
"int" default=
"0"/>
35517 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
35518 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
35520 <param name=
"w" type=
"double" default=
""/>
35521 <param name=
"h" type=
"double" default=
""/>
35524 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
35525 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
35527 <param name=
"w" type=
"double" default=
""/>
35528 <param name=
"h" type=
"double" default=
""/>
35532 <class name=
"PyEllipseShape" oldname=
"wxPyEllipseShape" module=
"ogl">
35533 <baseclass name=
"PyShape"/>
35534 <constructor name=
"PyEllipseShape" overloaded=
"no">
35535 <autodoc>__init__(self, double width=
0.0, double height=
0.0) -
> PyEllipseShape
</autodoc>
35537 <param name=
"width" type=
"double" default=
"0.0"/>
35538 <param name=
"height" type=
"double" default=
"0.0"/>
35541 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
35542 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
35544 <param name=
"self" type=
"PyObject" default=
""/>
35545 <param name=
"_class" type=
"PyObject" default=
""/>
35548 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
35549 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
35551 <param name=
"dc" type=
"DC" default=
""/>
35554 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
35555 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
35557 <param name=
"dc" type=
"DC" default=
""/>
35560 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
35561 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
35563 <param name=
"dc" type=
"DC" default=
""/>
35564 <param name=
"erase" type=
"bool" default=
"FALSE"/>
35567 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
35568 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
35570 <param name=
"dc" type=
"DC" default=
""/>
35573 <method name=
"base_OnErase" type=
"" overloaded=
"no">
35574 <autodoc>base_OnErase(self, DC dc)
</autodoc>
35576 <param name=
"dc" type=
"DC" default=
""/>
35579 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
35580 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
35582 <param name=
"dc" type=
"DC" default=
""/>
35585 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
35586 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
35588 <param name=
"dc" type=
"DC" default=
""/>
35591 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
35592 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35594 <param name=
"x" type=
"double" default=
""/>
35595 <param name=
"y" type=
"double" default=
""/>
35596 <param name=
"keys" type=
"int" default=
"0"/>
35597 <param name=
"attachment" type=
"int" default=
"0"/>
35600 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
35601 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35603 <param name=
"x" type=
"double" default=
""/>
35604 <param name=
"y" type=
"double" default=
""/>
35605 <param name=
"keys" type=
"int" default=
"0"/>
35606 <param name=
"attachment" type=
"int" default=
"0"/>
35609 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
35610 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35612 <param name=
"x" type=
"double" default=
""/>
35613 <param name=
"y" type=
"double" default=
""/>
35614 <param name=
"keys" type=
"int" default=
"0"/>
35615 <param name=
"attachment" type=
"int" default=
"0"/>
35618 <method name=
"base_OnSize" type=
"" overloaded=
"no">
35619 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
35621 <param name=
"x" type=
"double" default=
""/>
35622 <param name=
"y" type=
"double" default=
""/>
35625 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
35626 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
35627 bool display=True) -
> bool
</autodoc>
35629 <param name=
"dc" type=
"DC" default=
""/>
35630 <param name=
"x" type=
"double" default=
""/>
35631 <param name=
"y" type=
"double" default=
""/>
35632 <param name=
"old_x" type=
"double" default=
""/>
35633 <param name=
"old_y" type=
"double" default=
""/>
35634 <param name=
"display" type=
"bool" default=
"True"/>
35637 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
35638 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
35639 bool display=True)
</autodoc>
35641 <param name=
"dc" type=
"DC" default=
""/>
35642 <param name=
"x" type=
"double" default=
""/>
35643 <param name=
"y" type=
"double" default=
""/>
35644 <param name=
"old_x" type=
"double" default=
""/>
35645 <param name=
"old_y" type=
"double" default=
""/>
35646 <param name=
"display" type=
"bool" default=
"True"/>
35649 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
35650 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35652 <param name=
"draw" type=
"bool" default=
""/>
35653 <param name=
"x" type=
"double" default=
""/>
35654 <param name=
"y" type=
"double" default=
""/>
35655 <param name=
"keys" type=
"int" default=
"0"/>
35656 <param name=
"attachment" type=
"int" default=
"0"/>
35659 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
35660 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35662 <param name=
"x" type=
"double" default=
""/>
35663 <param name=
"y" type=
"double" default=
""/>
35664 <param name=
"keys" type=
"int" default=
"0"/>
35665 <param name=
"attachment" type=
"int" default=
"0"/>
35668 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
35669 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35671 <param name=
"x" type=
"double" default=
""/>
35672 <param name=
"y" type=
"double" default=
""/>
35673 <param name=
"keys" type=
"int" default=
"0"/>
35674 <param name=
"attachment" type=
"int" default=
"0"/>
35677 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
35678 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35680 <param name=
"draw" type=
"bool" default=
""/>
35681 <param name=
"x" type=
"double" default=
""/>
35682 <param name=
"y" type=
"double" default=
""/>
35683 <param name=
"keys" type=
"int" default=
"0"/>
35684 <param name=
"attachment" type=
"int" default=
"0"/>
35687 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
35688 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35690 <param name=
"x" type=
"double" default=
""/>
35691 <param name=
"y" type=
"double" default=
""/>
35692 <param name=
"keys" type=
"int" default=
"0"/>
35693 <param name=
"attachment" type=
"int" default=
"0"/>
35696 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
35697 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35699 <param name=
"x" type=
"double" default=
""/>
35700 <param name=
"y" type=
"double" default=
""/>
35701 <param name=
"keys" type=
"int" default=
"0"/>
35702 <param name=
"attachment" type=
"int" default=
"0"/>
35705 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
35706 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
35708 <param name=
"dc" type=
"DC" default=
""/>
35709 <param name=
"x" type=
"double" default=
""/>
35710 <param name=
"y" type=
"double" default=
""/>
35711 <param name=
"w" type=
"double" default=
""/>
35712 <param name=
"h" type=
"double" default=
""/>
35715 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
35716 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
35718 <param name=
"dc" type=
"DC" default=
""/>
35721 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
35722 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
35724 <param name=
"dc" type=
"DC" default=
""/>
35727 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
35728 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
35730 <param name=
"dc" type=
"DC" default=
""/>
35731 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
35734 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
35735 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
35736 int attachment=
0)
</autodoc>
35738 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35739 <param name=
"draw" type=
"bool" default=
""/>
35740 <param name=
"x" type=
"double" default=
""/>
35741 <param name=
"y" type=
"double" default=
""/>
35742 <param name=
"keys" type=
"int" default=
"0"/>
35743 <param name=
"attachment" type=
"int" default=
"0"/>
35746 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
35747 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
35748 int attachment=
0)
</autodoc>
35750 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35751 <param name=
"x" type=
"double" default=
""/>
35752 <param name=
"y" type=
"double" default=
""/>
35753 <param name=
"keys" type=
"int" default=
"0"/>
35754 <param name=
"attachment" type=
"int" default=
"0"/>
35757 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
35758 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
35759 int attachment=
0)
</autodoc>
35761 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35762 <param name=
"x" type=
"double" default=
""/>
35763 <param name=
"y" type=
"double" default=
""/>
35764 <param name=
"keys" type=
"int" default=
"0"/>
35765 <param name=
"attachment" type=
"int" default=
"0"/>
35768 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
35769 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
35771 <param name=
"w" type=
"double" default=
""/>
35772 <param name=
"h" type=
"double" default=
""/>
35775 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
35776 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
35778 <param name=
"w" type=
"double" default=
""/>
35779 <param name=
"h" type=
"double" default=
""/>
35783 <class name=
"PyCircleShape" oldname=
"wxPyCircleShape" module=
"ogl">
35784 <baseclass name=
"PyEllipseShape"/>
35785 <constructor name=
"PyCircleShape" overloaded=
"no">
35786 <autodoc>__init__(self, double width=
0.0) -
> PyCircleShape
</autodoc>
35788 <param name=
"width" type=
"double" default=
"0.0"/>
35791 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
35792 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
35794 <param name=
"self" type=
"PyObject" default=
""/>
35795 <param name=
"_class" type=
"PyObject" default=
""/>
35798 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
35799 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
35801 <param name=
"dc" type=
"DC" default=
""/>
35804 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
35805 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
35807 <param name=
"dc" type=
"DC" default=
""/>
35810 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
35811 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
35813 <param name=
"dc" type=
"DC" default=
""/>
35814 <param name=
"erase" type=
"bool" default=
"FALSE"/>
35817 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
35818 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
35820 <param name=
"dc" type=
"DC" default=
""/>
35823 <method name=
"base_OnErase" type=
"" overloaded=
"no">
35824 <autodoc>base_OnErase(self, DC dc)
</autodoc>
35826 <param name=
"dc" type=
"DC" default=
""/>
35829 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
35830 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
35832 <param name=
"dc" type=
"DC" default=
""/>
35835 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
35836 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
35838 <param name=
"dc" type=
"DC" default=
""/>
35841 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
35842 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35844 <param name=
"x" type=
"double" default=
""/>
35845 <param name=
"y" type=
"double" default=
""/>
35846 <param name=
"keys" type=
"int" default=
"0"/>
35847 <param name=
"attachment" type=
"int" default=
"0"/>
35850 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
35851 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35853 <param name=
"x" type=
"double" default=
""/>
35854 <param name=
"y" type=
"double" default=
""/>
35855 <param name=
"keys" type=
"int" default=
"0"/>
35856 <param name=
"attachment" type=
"int" default=
"0"/>
35859 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
35860 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35862 <param name=
"x" type=
"double" default=
""/>
35863 <param name=
"y" type=
"double" default=
""/>
35864 <param name=
"keys" type=
"int" default=
"0"/>
35865 <param name=
"attachment" type=
"int" default=
"0"/>
35868 <method name=
"base_OnSize" type=
"" overloaded=
"no">
35869 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
35871 <param name=
"x" type=
"double" default=
""/>
35872 <param name=
"y" type=
"double" default=
""/>
35875 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
35876 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
35877 bool display=True) -
> bool
</autodoc>
35879 <param name=
"dc" type=
"DC" default=
""/>
35880 <param name=
"x" type=
"double" default=
""/>
35881 <param name=
"y" type=
"double" default=
""/>
35882 <param name=
"old_x" type=
"double" default=
""/>
35883 <param name=
"old_y" type=
"double" default=
""/>
35884 <param name=
"display" type=
"bool" default=
"True"/>
35887 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
35888 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
35889 bool display=True)
</autodoc>
35891 <param name=
"dc" type=
"DC" default=
""/>
35892 <param name=
"x" type=
"double" default=
""/>
35893 <param name=
"y" type=
"double" default=
""/>
35894 <param name=
"old_x" type=
"double" default=
""/>
35895 <param name=
"old_y" type=
"double" default=
""/>
35896 <param name=
"display" type=
"bool" default=
"True"/>
35899 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
35900 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35902 <param name=
"draw" type=
"bool" default=
""/>
35903 <param name=
"x" type=
"double" default=
""/>
35904 <param name=
"y" type=
"double" default=
""/>
35905 <param name=
"keys" type=
"int" default=
"0"/>
35906 <param name=
"attachment" type=
"int" default=
"0"/>
35909 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
35910 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35912 <param name=
"x" type=
"double" default=
""/>
35913 <param name=
"y" type=
"double" default=
""/>
35914 <param name=
"keys" type=
"int" default=
"0"/>
35915 <param name=
"attachment" type=
"int" default=
"0"/>
35918 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
35919 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35921 <param name=
"x" type=
"double" default=
""/>
35922 <param name=
"y" type=
"double" default=
""/>
35923 <param name=
"keys" type=
"int" default=
"0"/>
35924 <param name=
"attachment" type=
"int" default=
"0"/>
35927 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
35928 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35930 <param name=
"draw" type=
"bool" default=
""/>
35931 <param name=
"x" type=
"double" default=
""/>
35932 <param name=
"y" type=
"double" default=
""/>
35933 <param name=
"keys" type=
"int" default=
"0"/>
35934 <param name=
"attachment" type=
"int" default=
"0"/>
35937 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
35938 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35940 <param name=
"x" type=
"double" default=
""/>
35941 <param name=
"y" type=
"double" default=
""/>
35942 <param name=
"keys" type=
"int" default=
"0"/>
35943 <param name=
"attachment" type=
"int" default=
"0"/>
35946 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
35947 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
35949 <param name=
"x" type=
"double" default=
""/>
35950 <param name=
"y" type=
"double" default=
""/>
35951 <param name=
"keys" type=
"int" default=
"0"/>
35952 <param name=
"attachment" type=
"int" default=
"0"/>
35955 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
35956 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
35958 <param name=
"dc" type=
"DC" default=
""/>
35959 <param name=
"x" type=
"double" default=
""/>
35960 <param name=
"y" type=
"double" default=
""/>
35961 <param name=
"w" type=
"double" default=
""/>
35962 <param name=
"h" type=
"double" default=
""/>
35965 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
35966 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
35968 <param name=
"dc" type=
"DC" default=
""/>
35971 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
35972 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
35974 <param name=
"dc" type=
"DC" default=
""/>
35977 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
35978 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
35980 <param name=
"dc" type=
"DC" default=
""/>
35981 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
35984 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
35985 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
35986 int attachment=
0)
</autodoc>
35988 <param name=
"pt" type=
"PyControlPoint" default=
""/>
35989 <param name=
"draw" type=
"bool" default=
""/>
35990 <param name=
"x" type=
"double" default=
""/>
35991 <param name=
"y" type=
"double" default=
""/>
35992 <param name=
"keys" type=
"int" default=
"0"/>
35993 <param name=
"attachment" type=
"int" default=
"0"/>
35996 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
35997 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
35998 int attachment=
0)
</autodoc>
36000 <param name=
"pt" type=
"PyControlPoint" default=
""/>
36001 <param name=
"x" type=
"double" default=
""/>
36002 <param name=
"y" type=
"double" default=
""/>
36003 <param name=
"keys" type=
"int" default=
"0"/>
36004 <param name=
"attachment" type=
"int" default=
"0"/>
36007 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
36008 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
36009 int attachment=
0)
</autodoc>
36011 <param name=
"pt" type=
"PyControlPoint" default=
""/>
36012 <param name=
"x" type=
"double" default=
""/>
36013 <param name=
"y" type=
"double" default=
""/>
36014 <param name=
"keys" type=
"int" default=
"0"/>
36015 <param name=
"attachment" type=
"int" default=
"0"/>
36018 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
36019 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
36021 <param name=
"w" type=
"double" default=
""/>
36022 <param name=
"h" type=
"double" default=
""/>
36025 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
36026 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
36028 <param name=
"w" type=
"double" default=
""/>
36029 <param name=
"h" type=
"double" default=
""/>
36033 <class name=
"ArrowHead" oldname=
"wxArrowHead" module=
"ogl">
36034 <baseclass name=
"Object"/>
36035 <constructor name=
"ArrowHead" overloaded=
"no">
36036 <autodoc>__init__(self, int type=
0, int end=
0, double size=
0.0, double dist=
0.0,
36037 String name=EmptyString, PseudoMetaFile mf=None,
36038 long arrowId=-
1) -
> ArrowHead
</autodoc>
36040 <param name=
"type" type=
"int" default=
"0"/>
36041 <param name=
"end" type=
"int" default=
"0"/>
36042 <param name=
"size" type=
"double" default=
"0.0"/>
36043 <param name=
"dist" type=
"double" default=
"0.0"/>
36044 <param name=
"name" type=
"String" default=
"wxPyEmptyString"/>
36045 <param name=
"mf" type=
"PseudoMetaFile" default=
"NULL"/>
36046 <param name=
"arrowId" type=
"long" default=
"-1"/>
36049 <destructor name=
"~wxArrowHead" overloaded=
"no">
36050 <autodoc>__del__(self)
</autodoc>
36052 <method name=
"_GetType" type=
"int" overloaded=
"no">
36053 <autodoc>_GetType(self) -
> int
</autodoc>
36055 <method name=
"GetPosition" type=
"int" overloaded=
"no">
36056 <autodoc>GetPosition(self) -
> int
</autodoc>
36058 <method name=
"SetPosition" type=
"" overloaded=
"no">
36059 <autodoc>SetPosition(self, int pos)
</autodoc>
36061 <param name=
"pos" type=
"int" default=
""/>
36064 <method name=
"GetXOffset" type=
"double" overloaded=
"no">
36065 <autodoc>GetXOffset(self) -
> double
</autodoc>
36067 <method name=
"GetYOffset" type=
"double" overloaded=
"no">
36068 <autodoc>GetYOffset(self) -
> double
</autodoc>
36070 <method name=
"GetSpacing" type=
"double" overloaded=
"no">
36071 <autodoc>GetSpacing(self) -
> double
</autodoc>
36073 <method name=
"GetSize" type=
"double" overloaded=
"no">
36074 <autodoc>GetSize(self) -
> double
</autodoc>
36076 <method name=
"GetName" type=
"String" overloaded=
"no">
36077 <autodoc>GetName(self) -
> String
</autodoc>
36079 <method name=
"SetXOffset" type=
"" overloaded=
"no">
36080 <autodoc>SetXOffset(self, double x)
</autodoc>
36082 <param name=
"x" type=
"double" default=
""/>
36085 <method name=
"SetYOffset" type=
"" overloaded=
"no">
36086 <autodoc>SetYOffset(self, double y)
</autodoc>
36088 <param name=
"y" type=
"double" default=
""/>
36091 <method name=
"GetMetaFile" type=
"PseudoMetaFile" overloaded=
"no">
36092 <autodoc>GetMetaFile(self) -
> PseudoMetaFile
</autodoc>
36094 <method name=
"GetId" type=
"long" overloaded=
"no">
36095 <autodoc>GetId(self) -
> long
</autodoc>
36097 <method name=
"GetArrowEnd" type=
"int" overloaded=
"no">
36098 <autodoc>GetArrowEnd(self) -
> int
</autodoc>
36100 <method name=
"GetArrowSize" type=
"double" overloaded=
"no">
36101 <autodoc>GetArrowSize(self) -
> double
</autodoc>
36103 <method name=
"SetSize" type=
"" overloaded=
"no">
36104 <autodoc>SetSize(self, double size)
</autodoc>
36106 <param name=
"size" type=
"double" default=
""/>
36109 <method name=
"SetSpacing" type=
"" overloaded=
"no">
36110 <autodoc>SetSpacing(self, double sp)
</autodoc>
36112 <param name=
"sp" type=
"double" default=
""/>
36116 <class name=
"PyLineShape" oldname=
"wxPyLineShape" module=
"ogl">
36117 <baseclass name=
"PyShape"/>
36118 <constructor name=
"PyLineShape" overloaded=
"no">
36119 <autodoc>__init__(self) -
> PyLineShape
</autodoc>
36121 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
36122 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
36124 <param name=
"self" type=
"PyObject" default=
""/>
36125 <param name=
"_class" type=
"PyObject" default=
""/>
36128 <method name=
"AddArrow" type=
"" overloaded=
"no">
36129 <autodoc>AddArrow(self, int type, int end=ARROW_POSITION_END, double arrowSize=
10.0,
36130 double xOffset=
0.0, String name=EmptyString,
36131 PseudoMetaFile mf=None, long arrowId=-
1)
</autodoc>
36133 <param name=
"type" type=
"int" default=
""/>
36134 <param name=
"end" type=
"int" default=
"ARROW_POSITION_END"/>
36135 <param name=
"arrowSize" type=
"double" default=
"10.0"/>
36136 <param name=
"xOffset" type=
"double" default=
"0.0"/>
36137 <param name=
"name" type=
"String" default=
"wxPyEmptyString"/>
36138 <param name=
"mf" type=
"PseudoMetaFile" default=
"NULL"/>
36139 <param name=
"arrowId" type=
"long" default=
"-1"/>
36142 <method name=
"AddArrowOrdered" type=
"" overloaded=
"no">
36143 <autodoc>AddArrowOrdered(self, ArrowHead arrow, PyObject referenceList, int end)
</autodoc>
36145 <param name=
"arrow" type=
"ArrowHead" default=
""/>
36146 <param name=
"referenceList" type=
"PyObject" default=
""/>
36147 <param name=
"end" type=
"int" default=
""/>
36150 <method name=
"ClearArrow" type=
"bool" overloaded=
"no">
36151 <autodoc>ClearArrow(self, String name) -
> bool
</autodoc>
36153 <param name=
"name" type=
"String" default=
""/>
36156 <method name=
"ClearArrowsAtPosition" type=
"" overloaded=
"no">
36157 <autodoc>ClearArrowsAtPosition(self, int position=-
1)
</autodoc>
36159 <param name=
"position" type=
"int" default=
"-1"/>
36162 <method name=
"DrawArrow" type=
"" overloaded=
"no">
36163 <autodoc>DrawArrow(self, DC dc, ArrowHead arrow, double xOffset, bool proportionalOffset)
</autodoc>
36165 <param name=
"dc" type=
"DC" default=
""/>
36166 <param name=
"arrow" type=
"ArrowHead" default=
""/>
36167 <param name=
"xOffset" type=
"double" default=
""/>
36168 <param name=
"proportionalOffset" type=
"bool" default=
""/>
36171 <method name=
"DeleteArrowHeadId" type=
"bool" overloaded=
"no">
36172 <autodoc>DeleteArrowHeadId(self, long arrowId) -
> bool
</autodoc>
36174 <param name=
"arrowId" type=
"long" default=
""/>
36177 <method name=
"DeleteArrowHead" type=
"bool" overloaded=
"no">
36178 <autodoc>DeleteArrowHead(self, int position, String name) -
> bool
</autodoc>
36180 <param name=
"position" type=
"int" default=
""/>
36181 <param name=
"name" type=
"String" default=
""/>
36184 <method name=
"DeleteLineControlPoint" type=
"bool" overloaded=
"no">
36185 <autodoc>DeleteLineControlPoint(self) -
> bool
</autodoc>
36187 <method name=
"DrawArrows" type=
"" overloaded=
"no">
36188 <autodoc>DrawArrows(self, DC dc)
</autodoc>
36190 <param name=
"dc" type=
"DC" default=
""/>
36193 <method name=
"DrawRegion" type=
"" overloaded=
"no">
36194 <autodoc>DrawRegion(self, DC dc, ShapeRegion region, double x, double y)
</autodoc>
36196 <param name=
"dc" type=
"DC" default=
""/>
36197 <param name=
"region" type=
"ShapeRegion" default=
""/>
36198 <param name=
"x" type=
"double" default=
""/>
36199 <param name=
"y" type=
"double" default=
""/>
36202 <method name=
"EraseRegion" type=
"" overloaded=
"no">
36203 <autodoc>EraseRegion(self, DC dc, ShapeRegion region, double x, double y)
</autodoc>
36205 <param name=
"dc" type=
"DC" default=
""/>
36206 <param name=
"region" type=
"ShapeRegion" default=
""/>
36207 <param name=
"x" type=
"double" default=
""/>
36208 <param name=
"y" type=
"double" default=
""/>
36211 <method name=
"FindArrowHeadId" type=
"ArrowHead" overloaded=
"no">
36212 <autodoc>FindArrowHeadId(self, long arrowId) -
> ArrowHead
</autodoc>
36214 <param name=
"arrowId" type=
"long" default=
""/>
36217 <method name=
"FindArrowHead" type=
"ArrowHead" overloaded=
"no">
36218 <autodoc>FindArrowHead(self, int position, String name) -
> ArrowHead
</autodoc>
36220 <param name=
"position" type=
"int" default=
""/>
36221 <param name=
"name" type=
"String" default=
""/>
36224 <method name=
"FindLineEndPoints" type=
"" overloaded=
"no">
36225 <autodoc>FindLineEndPoints(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT)
</autodoc>
36227 <param name=
"OUTPUT" type=
"double" default=
""/>
36228 <param name=
"OUTPUT" type=
"double" default=
""/>
36229 <param name=
"OUTPUT" type=
"double" default=
""/>
36230 <param name=
"OUTPUT" type=
"double" default=
""/>
36233 <method name=
"FindLinePosition" type=
"int" overloaded=
"no">
36234 <autodoc>FindLinePosition(self, double x, double y) -
> int
</autodoc>
36236 <param name=
"x" type=
"double" default=
""/>
36237 <param name=
"y" type=
"double" default=
""/>
36240 <method name=
"FindMinimumWidth" type=
"double" overloaded=
"no">
36241 <autodoc>FindMinimumWidth(self) -
> double
</autodoc>
36243 <method name=
"FindNth" type=
"" overloaded=
"no">
36244 <autodoc>FindNth(self, PyShape image, int OUTPUT, int OUTPUT, bool incoming)
</autodoc>
36246 <param name=
"image" type=
"PyShape" default=
""/>
36247 <param name=
"OUTPUT" type=
"int" default=
""/>
36248 <param name=
"OUTPUT" type=
"int" default=
""/>
36249 <param name=
"incoming" type=
"bool" default=
""/>
36252 <method name=
"GetAttachmentFrom" type=
"int" overloaded=
"no">
36253 <autodoc>GetAttachmentFrom(self) -
> int
</autodoc>
36255 <method name=
"GetAttachmentTo" type=
"int" overloaded=
"no">
36256 <autodoc>GetAttachmentTo(self) -
> int
</autodoc>
36258 <method name=
"GetEnds" type=
"" overloaded=
"no">
36259 <autodoc>GetEnds(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT)
</autodoc>
36261 <param name=
"OUTPUT" type=
"double" default=
""/>
36262 <param name=
"OUTPUT" type=
"double" default=
""/>
36263 <param name=
"OUTPUT" type=
"double" default=
""/>
36264 <param name=
"OUTPUT" type=
"double" default=
""/>
36267 <method name=
"GetFrom" type=
"PyShape" overloaded=
"no">
36268 <autodoc>GetFrom(self) -
> PyShape
</autodoc>
36270 <method name=
"GetLabelPosition" type=
"" overloaded=
"no">
36271 <autodoc>GetLabelPosition(self, int position, double OUTPUT, double OUTPUT)
</autodoc>
36273 <param name=
"position" type=
"int" default=
""/>
36274 <param name=
"OUTPUT" type=
"double" default=
""/>
36275 <param name=
"OUTPUT" type=
"double" default=
""/>
36278 <method name=
"GetNextControlPoint" type=
"RealPoint" overloaded=
"no">
36279 <autodoc>GetNextControlPoint(self, PyShape shape) -
> RealPoint
</autodoc>
36281 <param name=
"shape" type=
"PyShape" default=
""/>
36284 <method name=
"GetTo" type=
"PyShape" overloaded=
"no">
36285 <autodoc>GetTo(self) -
> PyShape
</autodoc>
36287 <method name=
"Initialise" type=
"" overloaded=
"no">
36288 <autodoc>Initialise(self)
</autodoc>
36290 <method name=
"InsertLineControlPoint" type=
"" overloaded=
"no">
36291 <autodoc>InsertLineControlPoint(self, DC dc)
</autodoc>
36293 <param name=
"dc" type=
"DC" default=
""/>
36296 <method name=
"IsEnd" type=
"bool" overloaded=
"no">
36297 <autodoc>IsEnd(self, PyShape shape) -
> bool
</autodoc>
36299 <param name=
"shape" type=
"PyShape" default=
""/>
36302 <method name=
"IsSpline" type=
"bool" overloaded=
"no">
36303 <autodoc>IsSpline(self) -
> bool
</autodoc>
36305 <method name=
"MakeLineControlPoints" type=
"" overloaded=
"no">
36306 <autodoc>MakeLineControlPoints(self, int n)
</autodoc>
36308 <param name=
"n" type=
"int" default=
""/>
36311 <method name=
"GetLineControlPoints" type=
"PyObject" overloaded=
"no">
36312 <autodoc>GetLineControlPoints(self) -
> PyObject
</autodoc>
36314 <method name=
"SetLineControlPoints" type=
"" overloaded=
"no">
36315 <autodoc>SetLineControlPoints(self, PyObject list)
</autodoc>
36317 <param name=
"list" type=
"PyObject" default=
""/>
36320 <method name=
"SetAttachmentFrom" type=
"" overloaded=
"no">
36321 <autodoc>SetAttachmentFrom(self, int fromAttach)
</autodoc>
36323 <param name=
"fromAttach" type=
"int" default=
""/>
36326 <method name=
"SetAttachments" type=
"" overloaded=
"no">
36327 <autodoc>SetAttachments(self, int fromAttach, int toAttach)
</autodoc>
36329 <param name=
"fromAttach" type=
"int" default=
""/>
36330 <param name=
"toAttach" type=
"int" default=
""/>
36333 <method name=
"SetAttachmentTo" type=
"" overloaded=
"no">
36334 <autodoc>SetAttachmentTo(self, int toAttach)
</autodoc>
36336 <param name=
"toAttach" type=
"int" default=
""/>
36339 <method name=
"SetEnds" type=
"" overloaded=
"no">
36340 <autodoc>SetEnds(self, double x1, double y1, double x2, double y2)
</autodoc>
36342 <param name=
"x1" type=
"double" default=
""/>
36343 <param name=
"y1" type=
"double" default=
""/>
36344 <param name=
"x2" type=
"double" default=
""/>
36345 <param name=
"y2" type=
"double" default=
""/>
36348 <method name=
"SetFrom" type=
"" overloaded=
"no">
36349 <autodoc>SetFrom(self, PyShape object)
</autodoc>
36351 <param name=
"object" type=
"PyShape" default=
""/>
36354 <method name=
"SetIgnoreOffsets" type=
"" overloaded=
"no">
36355 <autodoc>SetIgnoreOffsets(self, bool ignore)
</autodoc>
36357 <param name=
"ignore" type=
"bool" default=
""/>
36360 <method name=
"SetSpline" type=
"" overloaded=
"no">
36361 <autodoc>SetSpline(self, bool spline)
</autodoc>
36363 <param name=
"spline" type=
"bool" default=
""/>
36366 <method name=
"SetTo" type=
"" overloaded=
"no">
36367 <autodoc>SetTo(self, PyShape object)
</autodoc>
36369 <param name=
"object" type=
"PyShape" default=
""/>
36372 <method name=
"Straighten" type=
"" overloaded=
"no">
36373 <autodoc>Straighten(self, DC dc=None)
</autodoc>
36375 <param name=
"dc" type=
"DC" default=
"NULL"/>
36378 <method name=
"Unlink" type=
"" overloaded=
"no">
36379 <autodoc>Unlink(self)
</autodoc>
36381 <method name=
"SetAlignmentOrientation" type=
"" overloaded=
"no">
36382 <autodoc>SetAlignmentOrientation(self, bool isEnd, bool isHoriz)
</autodoc>
36384 <param name=
"isEnd" type=
"bool" default=
""/>
36385 <param name=
"isHoriz" type=
"bool" default=
""/>
36388 <method name=
"SetAlignmentType" type=
"" overloaded=
"no">
36389 <autodoc>SetAlignmentType(self, bool isEnd, int alignType)
</autodoc>
36391 <param name=
"isEnd" type=
"bool" default=
""/>
36392 <param name=
"alignType" type=
"int" default=
""/>
36395 <method name=
"GetAlignmentOrientation" type=
"bool" overloaded=
"no">
36396 <autodoc>GetAlignmentOrientation(self, bool isEnd) -
> bool
</autodoc>
36398 <param name=
"isEnd" type=
"bool" default=
""/>
36401 <method name=
"GetAlignmentType" type=
"int" overloaded=
"no">
36402 <autodoc>GetAlignmentType(self, bool isEnd) -
> int
</autodoc>
36404 <param name=
"isEnd" type=
"bool" default=
""/>
36407 <method name=
"GetAlignmentStart" type=
"int" overloaded=
"no">
36408 <autodoc>GetAlignmentStart(self) -
> int
</autodoc>
36410 <method name=
"GetAlignmentEnd" type=
"int" overloaded=
"no">
36411 <autodoc>GetAlignmentEnd(self) -
> int
</autodoc>
36413 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
36414 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
36416 <param name=
"dc" type=
"DC" default=
""/>
36419 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
36420 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
36422 <param name=
"dc" type=
"DC" default=
""/>
36425 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
36426 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
36428 <param name=
"dc" type=
"DC" default=
""/>
36429 <param name=
"erase" type=
"bool" default=
"FALSE"/>
36432 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
36433 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
36435 <param name=
"dc" type=
"DC" default=
""/>
36438 <method name=
"base_OnErase" type=
"" overloaded=
"no">
36439 <autodoc>base_OnErase(self, DC dc)
</autodoc>
36441 <param name=
"dc" type=
"DC" default=
""/>
36444 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
36445 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
36447 <param name=
"dc" type=
"DC" default=
""/>
36450 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
36451 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
36453 <param name=
"dc" type=
"DC" default=
""/>
36456 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
36457 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36459 <param name=
"x" type=
"double" default=
""/>
36460 <param name=
"y" type=
"double" default=
""/>
36461 <param name=
"keys" type=
"int" default=
"0"/>
36462 <param name=
"attachment" type=
"int" default=
"0"/>
36465 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
36466 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36468 <param name=
"x" type=
"double" default=
""/>
36469 <param name=
"y" type=
"double" default=
""/>
36470 <param name=
"keys" type=
"int" default=
"0"/>
36471 <param name=
"attachment" type=
"int" default=
"0"/>
36474 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
36475 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36477 <param name=
"x" type=
"double" default=
""/>
36478 <param name=
"y" type=
"double" default=
""/>
36479 <param name=
"keys" type=
"int" default=
"0"/>
36480 <param name=
"attachment" type=
"int" default=
"0"/>
36483 <method name=
"base_OnSize" type=
"" overloaded=
"no">
36484 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
36486 <param name=
"x" type=
"double" default=
""/>
36487 <param name=
"y" type=
"double" default=
""/>
36490 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
36491 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
36492 bool display=True) -
> bool
</autodoc>
36494 <param name=
"dc" type=
"DC" default=
""/>
36495 <param name=
"x" type=
"double" default=
""/>
36496 <param name=
"y" type=
"double" default=
""/>
36497 <param name=
"old_x" type=
"double" default=
""/>
36498 <param name=
"old_y" type=
"double" default=
""/>
36499 <param name=
"display" type=
"bool" default=
"True"/>
36502 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
36503 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
36504 bool display=True)
</autodoc>
36506 <param name=
"dc" type=
"DC" default=
""/>
36507 <param name=
"x" type=
"double" default=
""/>
36508 <param name=
"y" type=
"double" default=
""/>
36509 <param name=
"old_x" type=
"double" default=
""/>
36510 <param name=
"old_y" type=
"double" default=
""/>
36511 <param name=
"display" type=
"bool" default=
"True"/>
36514 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
36515 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36517 <param name=
"draw" type=
"bool" default=
""/>
36518 <param name=
"x" type=
"double" default=
""/>
36519 <param name=
"y" type=
"double" default=
""/>
36520 <param name=
"keys" type=
"int" default=
"0"/>
36521 <param name=
"attachment" type=
"int" default=
"0"/>
36524 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
36525 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36527 <param name=
"x" type=
"double" default=
""/>
36528 <param name=
"y" type=
"double" default=
""/>
36529 <param name=
"keys" type=
"int" default=
"0"/>
36530 <param name=
"attachment" type=
"int" default=
"0"/>
36533 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
36534 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36536 <param name=
"x" type=
"double" default=
""/>
36537 <param name=
"y" type=
"double" default=
""/>
36538 <param name=
"keys" type=
"int" default=
"0"/>
36539 <param name=
"attachment" type=
"int" default=
"0"/>
36542 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
36543 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36545 <param name=
"draw" type=
"bool" default=
""/>
36546 <param name=
"x" type=
"double" default=
""/>
36547 <param name=
"y" type=
"double" default=
""/>
36548 <param name=
"keys" type=
"int" default=
"0"/>
36549 <param name=
"attachment" type=
"int" default=
"0"/>
36552 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
36553 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36555 <param name=
"x" type=
"double" default=
""/>
36556 <param name=
"y" type=
"double" default=
""/>
36557 <param name=
"keys" type=
"int" default=
"0"/>
36558 <param name=
"attachment" type=
"int" default=
"0"/>
36561 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
36562 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36564 <param name=
"x" type=
"double" default=
""/>
36565 <param name=
"y" type=
"double" default=
""/>
36566 <param name=
"keys" type=
"int" default=
"0"/>
36567 <param name=
"attachment" type=
"int" default=
"0"/>
36570 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
36571 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
36573 <param name=
"dc" type=
"DC" default=
""/>
36574 <param name=
"x" type=
"double" default=
""/>
36575 <param name=
"y" type=
"double" default=
""/>
36576 <param name=
"w" type=
"double" default=
""/>
36577 <param name=
"h" type=
"double" default=
""/>
36580 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
36581 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
36583 <param name=
"dc" type=
"DC" default=
""/>
36586 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
36587 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
36589 <param name=
"dc" type=
"DC" default=
""/>
36592 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
36593 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
36595 <param name=
"dc" type=
"DC" default=
""/>
36596 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
36599 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
36600 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
36601 int attachment=
0)
</autodoc>
36603 <param name=
"pt" type=
"PyControlPoint" default=
""/>
36604 <param name=
"draw" type=
"bool" default=
""/>
36605 <param name=
"x" type=
"double" default=
""/>
36606 <param name=
"y" type=
"double" default=
""/>
36607 <param name=
"keys" type=
"int" default=
"0"/>
36608 <param name=
"attachment" type=
"int" default=
"0"/>
36611 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
36612 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
36613 int attachment=
0)
</autodoc>
36615 <param name=
"pt" type=
"PyControlPoint" default=
""/>
36616 <param name=
"x" type=
"double" default=
""/>
36617 <param name=
"y" type=
"double" default=
""/>
36618 <param name=
"keys" type=
"int" default=
"0"/>
36619 <param name=
"attachment" type=
"int" default=
"0"/>
36622 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
36623 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
36624 int attachment=
0)
</autodoc>
36626 <param name=
"pt" type=
"PyControlPoint" default=
""/>
36627 <param name=
"x" type=
"double" default=
""/>
36628 <param name=
"y" type=
"double" default=
""/>
36629 <param name=
"keys" type=
"int" default=
"0"/>
36630 <param name=
"attachment" type=
"int" default=
"0"/>
36633 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
36634 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
36636 <param name=
"w" type=
"double" default=
""/>
36637 <param name=
"h" type=
"double" default=
""/>
36640 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
36641 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
36643 <param name=
"w" type=
"double" default=
""/>
36644 <param name=
"h" type=
"double" default=
""/>
36648 <class name=
"PyPolygonShape" oldname=
"wxPyPolygonShape" module=
"ogl">
36649 <baseclass name=
"PyShape"/>
36650 <constructor name=
"PyPolygonShape" overloaded=
"no">
36651 <autodoc>__init__(self) -
> PyPolygonShape
</autodoc>
36653 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
36654 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
36656 <param name=
"self" type=
"PyObject" default=
""/>
36657 <param name=
"_class" type=
"PyObject" default=
""/>
36660 <method name=
"Create" type=
"PyObject" overloaded=
"no">
36661 <autodoc>Create(self, PyObject points) -
> PyObject
</autodoc>
36663 <param name=
"points" type=
"PyObject" default=
""/>
36666 <method name=
"AddPolygonPoint" type=
"" overloaded=
"no">
36667 <autodoc>AddPolygonPoint(self, int pos=
0)
</autodoc>
36669 <param name=
"pos" type=
"int" default=
"0"/>
36672 <method name=
"CalculatePolygonCentre" type=
"" overloaded=
"no">
36673 <autodoc>CalculatePolygonCentre(self)
</autodoc>
36675 <method name=
"DeletePolygonPoint" type=
"" overloaded=
"no">
36676 <autodoc>DeletePolygonPoint(self, int pos=
0)
</autodoc>
36678 <param name=
"pos" type=
"int" default=
"0"/>
36681 <method name=
"GetPoints" type=
"PyObject" overloaded=
"no">
36682 <autodoc>GetPoints(self) -
> PyObject
</autodoc>
36684 <method name=
"GetOriginalPoints" type=
"PyObject" overloaded=
"no">
36685 <autodoc>GetOriginalPoints(self) -
> PyObject
</autodoc>
36687 <method name=
"GetOriginalWidth" type=
"double" overloaded=
"no">
36688 <autodoc>GetOriginalWidth(self) -
> double
</autodoc>
36690 <method name=
"GetOriginalHeight" type=
"double" overloaded=
"no">
36691 <autodoc>GetOriginalHeight(self) -
> double
</autodoc>
36693 <method name=
"SetOriginalWidth" type=
"" overloaded=
"no">
36694 <autodoc>SetOriginalWidth(self, double w)
</autodoc>
36696 <param name=
"w" type=
"double" default=
""/>
36699 <method name=
"SetOriginalHeight" type=
"" overloaded=
"no">
36700 <autodoc>SetOriginalHeight(self, double h)
</autodoc>
36702 <param name=
"h" type=
"double" default=
""/>
36705 <method name=
"UpdateOriginalPoints" type=
"" overloaded=
"no">
36706 <autodoc>UpdateOriginalPoints(self)
</autodoc>
36708 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
36709 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
36711 <param name=
"dc" type=
"DC" default=
""/>
36714 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
36715 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
36717 <param name=
"dc" type=
"DC" default=
""/>
36720 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
36721 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
36723 <param name=
"dc" type=
"DC" default=
""/>
36724 <param name=
"erase" type=
"bool" default=
"FALSE"/>
36727 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
36728 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
36730 <param name=
"dc" type=
"DC" default=
""/>
36733 <method name=
"base_OnErase" type=
"" overloaded=
"no">
36734 <autodoc>base_OnErase(self, DC dc)
</autodoc>
36736 <param name=
"dc" type=
"DC" default=
""/>
36739 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
36740 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
36742 <param name=
"dc" type=
"DC" default=
""/>
36745 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
36746 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
36748 <param name=
"dc" type=
"DC" default=
""/>
36751 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
36752 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36754 <param name=
"x" type=
"double" default=
""/>
36755 <param name=
"y" type=
"double" default=
""/>
36756 <param name=
"keys" type=
"int" default=
"0"/>
36757 <param name=
"attachment" type=
"int" default=
"0"/>
36760 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
36761 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36763 <param name=
"x" type=
"double" default=
""/>
36764 <param name=
"y" type=
"double" default=
""/>
36765 <param name=
"keys" type=
"int" default=
"0"/>
36766 <param name=
"attachment" type=
"int" default=
"0"/>
36769 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
36770 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36772 <param name=
"x" type=
"double" default=
""/>
36773 <param name=
"y" type=
"double" default=
""/>
36774 <param name=
"keys" type=
"int" default=
"0"/>
36775 <param name=
"attachment" type=
"int" default=
"0"/>
36778 <method name=
"base_OnSize" type=
"" overloaded=
"no">
36779 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
36781 <param name=
"x" type=
"double" default=
""/>
36782 <param name=
"y" type=
"double" default=
""/>
36785 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
36786 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
36787 bool display=True) -
> bool
</autodoc>
36789 <param name=
"dc" type=
"DC" default=
""/>
36790 <param name=
"x" type=
"double" default=
""/>
36791 <param name=
"y" type=
"double" default=
""/>
36792 <param name=
"old_x" type=
"double" default=
""/>
36793 <param name=
"old_y" type=
"double" default=
""/>
36794 <param name=
"display" type=
"bool" default=
"True"/>
36797 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
36798 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
36799 bool display=True)
</autodoc>
36801 <param name=
"dc" type=
"DC" default=
""/>
36802 <param name=
"x" type=
"double" default=
""/>
36803 <param name=
"y" type=
"double" default=
""/>
36804 <param name=
"old_x" type=
"double" default=
""/>
36805 <param name=
"old_y" type=
"double" default=
""/>
36806 <param name=
"display" type=
"bool" default=
"True"/>
36809 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
36810 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36812 <param name=
"draw" type=
"bool" default=
""/>
36813 <param name=
"x" type=
"double" default=
""/>
36814 <param name=
"y" type=
"double" default=
""/>
36815 <param name=
"keys" type=
"int" default=
"0"/>
36816 <param name=
"attachment" type=
"int" default=
"0"/>
36819 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
36820 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36822 <param name=
"x" type=
"double" default=
""/>
36823 <param name=
"y" type=
"double" default=
""/>
36824 <param name=
"keys" type=
"int" default=
"0"/>
36825 <param name=
"attachment" type=
"int" default=
"0"/>
36828 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
36829 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36831 <param name=
"x" type=
"double" default=
""/>
36832 <param name=
"y" type=
"double" default=
""/>
36833 <param name=
"keys" type=
"int" default=
"0"/>
36834 <param name=
"attachment" type=
"int" default=
"0"/>
36837 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
36838 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36840 <param name=
"draw" type=
"bool" default=
""/>
36841 <param name=
"x" type=
"double" default=
""/>
36842 <param name=
"y" type=
"double" default=
""/>
36843 <param name=
"keys" type=
"int" default=
"0"/>
36844 <param name=
"attachment" type=
"int" default=
"0"/>
36847 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
36848 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36850 <param name=
"x" type=
"double" default=
""/>
36851 <param name=
"y" type=
"double" default=
""/>
36852 <param name=
"keys" type=
"int" default=
"0"/>
36853 <param name=
"attachment" type=
"int" default=
"0"/>
36856 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
36857 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
36859 <param name=
"x" type=
"double" default=
""/>
36860 <param name=
"y" type=
"double" default=
""/>
36861 <param name=
"keys" type=
"int" default=
"0"/>
36862 <param name=
"attachment" type=
"int" default=
"0"/>
36865 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
36866 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
36868 <param name=
"dc" type=
"DC" default=
""/>
36869 <param name=
"x" type=
"double" default=
""/>
36870 <param name=
"y" type=
"double" default=
""/>
36871 <param name=
"w" type=
"double" default=
""/>
36872 <param name=
"h" type=
"double" default=
""/>
36875 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
36876 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
36878 <param name=
"dc" type=
"DC" default=
""/>
36881 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
36882 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
36884 <param name=
"dc" type=
"DC" default=
""/>
36887 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
36888 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
36890 <param name=
"dc" type=
"DC" default=
""/>
36891 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
36894 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
36895 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
36896 int attachment=
0)
</autodoc>
36898 <param name=
"pt" type=
"PyControlPoint" default=
""/>
36899 <param name=
"draw" type=
"bool" default=
""/>
36900 <param name=
"x" type=
"double" default=
""/>
36901 <param name=
"y" type=
"double" default=
""/>
36902 <param name=
"keys" type=
"int" default=
"0"/>
36903 <param name=
"attachment" type=
"int" default=
"0"/>
36906 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
36907 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
36908 int attachment=
0)
</autodoc>
36910 <param name=
"pt" type=
"PyControlPoint" default=
""/>
36911 <param name=
"x" type=
"double" default=
""/>
36912 <param name=
"y" type=
"double" default=
""/>
36913 <param name=
"keys" type=
"int" default=
"0"/>
36914 <param name=
"attachment" type=
"int" default=
"0"/>
36917 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
36918 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
36919 int attachment=
0)
</autodoc>
36921 <param name=
"pt" type=
"PyControlPoint" default=
""/>
36922 <param name=
"x" type=
"double" default=
""/>
36923 <param name=
"y" type=
"double" default=
""/>
36924 <param name=
"keys" type=
"int" default=
"0"/>
36925 <param name=
"attachment" type=
"int" default=
"0"/>
36928 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
36929 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
36931 <param name=
"w" type=
"double" default=
""/>
36932 <param name=
"h" type=
"double" default=
""/>
36935 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
36936 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
36938 <param name=
"w" type=
"double" default=
""/>
36939 <param name=
"h" type=
"double" default=
""/>
36943 <class name=
"PyTextShape" oldname=
"wxPyTextShape" module=
"ogl">
36944 <baseclass name=
"PyRectangleShape"/>
36945 <constructor name=
"PyTextShape" overloaded=
"no">
36946 <autodoc>__init__(self, double width=
0.0, double height=
0.0) -
> PyTextShape
</autodoc>
36948 <param name=
"width" type=
"double" default=
"0.0"/>
36949 <param name=
"height" type=
"double" default=
"0.0"/>
36952 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
36953 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
36955 <param name=
"self" type=
"PyObject" default=
""/>
36956 <param name=
"_class" type=
"PyObject" default=
""/>
36959 <method name=
"base_OnDelete" type=
"" overloaded=
"no">
36960 <autodoc>base_OnDelete(self)
</autodoc>
36962 <method name=
"base_OnDraw" type=
"" overloaded=
"no">
36963 <autodoc>base_OnDraw(self, DC dc)
</autodoc>
36965 <param name=
"dc" type=
"DC" default=
""/>
36968 <method name=
"base_OnDrawContents" type=
"" overloaded=
"no">
36969 <autodoc>base_OnDrawContents(self, DC dc)
</autodoc>
36971 <param name=
"dc" type=
"DC" default=
""/>
36974 <method name=
"base_OnDrawBranches" type=
"" overloaded=
"no">
36975 <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)
</autodoc>
36977 <param name=
"dc" type=
"DC" default=
""/>
36978 <param name=
"erase" type=
"bool" default=
"FALSE"/>
36981 <method name=
"base_OnMoveLinks" type=
"" overloaded=
"no">
36982 <autodoc>base_OnMoveLinks(self, DC dc)
</autodoc>
36984 <param name=
"dc" type=
"DC" default=
""/>
36987 <method name=
"base_OnErase" type=
"" overloaded=
"no">
36988 <autodoc>base_OnErase(self, DC dc)
</autodoc>
36990 <param name=
"dc" type=
"DC" default=
""/>
36993 <method name=
"base_OnEraseContents" type=
"" overloaded=
"no">
36994 <autodoc>base_OnEraseContents(self, DC dc)
</autodoc>
36996 <param name=
"dc" type=
"DC" default=
""/>
36999 <method name=
"base_OnHighlight" type=
"" overloaded=
"no">
37000 <autodoc>base_OnHighlight(self, DC dc)
</autodoc>
37002 <param name=
"dc" type=
"DC" default=
""/>
37005 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
37006 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37008 <param name=
"x" type=
"double" default=
""/>
37009 <param name=
"y" type=
"double" default=
""/>
37010 <param name=
"keys" type=
"int" default=
"0"/>
37011 <param name=
"attachment" type=
"int" default=
"0"/>
37014 <method name=
"base_OnLeftDoubleClick" type=
"" overloaded=
"no">
37015 <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37017 <param name=
"x" type=
"double" default=
""/>
37018 <param name=
"y" type=
"double" default=
""/>
37019 <param name=
"keys" type=
"int" default=
"0"/>
37020 <param name=
"attachment" type=
"int" default=
"0"/>
37023 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
37024 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37026 <param name=
"x" type=
"double" default=
""/>
37027 <param name=
"y" type=
"double" default=
""/>
37028 <param name=
"keys" type=
"int" default=
"0"/>
37029 <param name=
"attachment" type=
"int" default=
"0"/>
37032 <method name=
"base_OnSize" type=
"" overloaded=
"no">
37033 <autodoc>base_OnSize(self, double x, double y)
</autodoc>
37035 <param name=
"x" type=
"double" default=
""/>
37036 <param name=
"y" type=
"double" default=
""/>
37039 <method name=
"base_OnMovePre" type=
"bool" overloaded=
"no">
37040 <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y,
37041 bool display=True) -
> bool
</autodoc>
37043 <param name=
"dc" type=
"DC" default=
""/>
37044 <param name=
"x" type=
"double" default=
""/>
37045 <param name=
"y" type=
"double" default=
""/>
37046 <param name=
"old_x" type=
"double" default=
""/>
37047 <param name=
"old_y" type=
"double" default=
""/>
37048 <param name=
"display" type=
"bool" default=
"True"/>
37051 <method name=
"base_OnMovePost" type=
"" overloaded=
"no">
37052 <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y,
37053 bool display=True)
</autodoc>
37055 <param name=
"dc" type=
"DC" default=
""/>
37056 <param name=
"x" type=
"double" default=
""/>
37057 <param name=
"y" type=
"double" default=
""/>
37058 <param name=
"old_x" type=
"double" default=
""/>
37059 <param name=
"old_y" type=
"double" default=
""/>
37060 <param name=
"display" type=
"bool" default=
"True"/>
37063 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
37064 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37066 <param name=
"draw" type=
"bool" default=
""/>
37067 <param name=
"x" type=
"double" default=
""/>
37068 <param name=
"y" type=
"double" default=
""/>
37069 <param name=
"keys" type=
"int" default=
"0"/>
37070 <param name=
"attachment" type=
"int" default=
"0"/>
37073 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
37074 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37076 <param name=
"x" type=
"double" default=
""/>
37077 <param name=
"y" type=
"double" default=
""/>
37078 <param name=
"keys" type=
"int" default=
"0"/>
37079 <param name=
"attachment" type=
"int" default=
"0"/>
37082 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
37083 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37085 <param name=
"x" type=
"double" default=
""/>
37086 <param name=
"y" type=
"double" default=
""/>
37087 <param name=
"keys" type=
"int" default=
"0"/>
37088 <param name=
"attachment" type=
"int" default=
"0"/>
37091 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
37092 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37094 <param name=
"draw" type=
"bool" default=
""/>
37095 <param name=
"x" type=
"double" default=
""/>
37096 <param name=
"y" type=
"double" default=
""/>
37097 <param name=
"keys" type=
"int" default=
"0"/>
37098 <param name=
"attachment" type=
"int" default=
"0"/>
37101 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
37102 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37104 <param name=
"x" type=
"double" default=
""/>
37105 <param name=
"y" type=
"double" default=
""/>
37106 <param name=
"keys" type=
"int" default=
"0"/>
37107 <param name=
"attachment" type=
"int" default=
"0"/>
37110 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
37111 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0, int attachment=
0)
</autodoc>
37113 <param name=
"x" type=
"double" default=
""/>
37114 <param name=
"y" type=
"double" default=
""/>
37115 <param name=
"keys" type=
"int" default=
"0"/>
37116 <param name=
"attachment" type=
"int" default=
"0"/>
37119 <method name=
"base_OnDrawOutline" type=
"" overloaded=
"no">
37120 <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)
</autodoc>
37122 <param name=
"dc" type=
"DC" default=
""/>
37123 <param name=
"x" type=
"double" default=
""/>
37124 <param name=
"y" type=
"double" default=
""/>
37125 <param name=
"w" type=
"double" default=
""/>
37126 <param name=
"h" type=
"double" default=
""/>
37129 <method name=
"base_OnDrawControlPoints" type=
"" overloaded=
"no">
37130 <autodoc>base_OnDrawControlPoints(self, DC dc)
</autodoc>
37132 <param name=
"dc" type=
"DC" default=
""/>
37135 <method name=
"base_OnEraseControlPoints" type=
"" overloaded=
"no">
37136 <autodoc>base_OnEraseControlPoints(self, DC dc)
</autodoc>
37138 <param name=
"dc" type=
"DC" default=
""/>
37141 <method name=
"base_OnMoveLink" type=
"" overloaded=
"no">
37142 <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)
</autodoc>
37144 <param name=
"dc" type=
"DC" default=
""/>
37145 <param name=
"moveControlPoints" type=
"bool" default=
"True"/>
37148 <method name=
"base_OnSizingDragLeft" type=
"" overloaded=
"no">
37149 <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=
0,
37150 int attachment=
0)
</autodoc>
37152 <param name=
"pt" type=
"PyControlPoint" default=
""/>
37153 <param name=
"draw" type=
"bool" default=
""/>
37154 <param name=
"x" type=
"double" default=
""/>
37155 <param name=
"y" type=
"double" default=
""/>
37156 <param name=
"keys" type=
"int" default=
"0"/>
37157 <param name=
"attachment" type=
"int" default=
"0"/>
37160 <method name=
"base_OnSizingBeginDragLeft" type=
"" overloaded=
"no">
37161 <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
37162 int attachment=
0)
</autodoc>
37164 <param name=
"pt" type=
"PyControlPoint" default=
""/>
37165 <param name=
"x" type=
"double" default=
""/>
37166 <param name=
"y" type=
"double" default=
""/>
37167 <param name=
"keys" type=
"int" default=
"0"/>
37168 <param name=
"attachment" type=
"int" default=
"0"/>
37171 <method name=
"base_OnSizingEndDragLeft" type=
"" overloaded=
"no">
37172 <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=
0,
37173 int attachment=
0)
</autodoc>
37175 <param name=
"pt" type=
"PyControlPoint" default=
""/>
37176 <param name=
"x" type=
"double" default=
""/>
37177 <param name=
"y" type=
"double" default=
""/>
37178 <param name=
"keys" type=
"int" default=
"0"/>
37179 <param name=
"attachment" type=
"int" default=
"0"/>
37182 <method name=
"base_OnBeginSize" type=
"" overloaded=
"no">
37183 <autodoc>base_OnBeginSize(self, double w, double h)
</autodoc>
37185 <param name=
"w" type=
"double" default=
""/>
37186 <param name=
"h" type=
"double" default=
""/>
37189 <method name=
"base_OnEndSize" type=
"" overloaded=
"no">
37190 <autodoc>base_OnEndSize(self, double w, double h)
</autodoc>
37192 <param name=
"w" type=
"double" default=
""/>
37193 <param name=
"h" type=
"double" default=
""/>
37197 <class name=
"Diagram" oldname=
"wxDiagram" module=
"ogl">
37198 <baseclass name=
"Object"/>
37199 <constructor name=
"Diagram" overloaded=
"no">
37200 <autodoc>__init__(self) -
> Diagram
</autodoc>
37202 <method name=
"AddShape" type=
"" overloaded=
"no">
37203 <autodoc>AddShape(self, PyShape shape, PyShape addAfter=None)
</autodoc>
37205 <param name=
"shape" type=
"PyShape" default=
""/>
37206 <param name=
"addAfter" type=
"PyShape" default=
"NULL"/>
37209 <method name=
"Clear" type=
"" overloaded=
"no">
37210 <autodoc>Clear(self, DC dc)
</autodoc>
37212 <param name=
"dc" type=
"DC" default=
""/>
37215 <method name=
"DeleteAllShapes" type=
"" overloaded=
"no">
37216 <autodoc>DeleteAllShapes(self)
</autodoc>
37218 <method name=
"DrawOutline" type=
"" overloaded=
"no">
37219 <autodoc>DrawOutline(self, DC dc, double x1, double y1, double x2, double y2)
</autodoc>
37221 <param name=
"dc" type=
"DC" default=
""/>
37222 <param name=
"x1" type=
"double" default=
""/>
37223 <param name=
"y1" type=
"double" default=
""/>
37224 <param name=
"x2" type=
"double" default=
""/>
37225 <param name=
"y2" type=
"double" default=
""/>
37228 <method name=
"FindShape" type=
"PyShape" overloaded=
"no">
37229 <autodoc>FindShape(self, long id) -
> PyShape
</autodoc>
37231 <param name=
"id" type=
"long" default=
""/>
37234 <method name=
"GetCanvas" type=
"wxPyShapeCanvas" overloaded=
"no">
37235 <autodoc>GetCanvas(self) -
> PyShapeCanvas
</autodoc>
37237 <method name=
"GetCount" type=
"int" overloaded=
"no">
37238 <autodoc>GetCount(self) -
> int
</autodoc>
37240 <method name=
"GetGridSpacing" type=
"double" overloaded=
"no">
37241 <autodoc>GetGridSpacing(self) -
> double
</autodoc>
37243 <method name=
"GetMouseTolerance" type=
"int" overloaded=
"no">
37244 <autodoc>GetMouseTolerance(self) -
> int
</autodoc>
37246 <method name=
"GetShapeList" type=
"PyObject" overloaded=
"no">
37247 <autodoc>GetShapeList(self) -
> PyObject
</autodoc>
37249 <method name=
"GetQuickEditMode" type=
"bool" overloaded=
"no">
37250 <autodoc>GetQuickEditMode(self) -
> bool
</autodoc>
37252 <method name=
"GetSnapToGrid" type=
"bool" overloaded=
"no">
37253 <autodoc>GetSnapToGrid(self) -
> bool
</autodoc>
37255 <method name=
"InsertShape" type=
"" overloaded=
"no">
37256 <autodoc>InsertShape(self, PyShape shape)
</autodoc>
37258 <param name=
"shape" type=
"PyShape" default=
""/>
37261 <method name=
"RecentreAll" type=
"" overloaded=
"no">
37262 <autodoc>RecentreAll(self, DC dc)
</autodoc>
37264 <param name=
"dc" type=
"DC" default=
""/>
37267 <method name=
"Redraw" type=
"" overloaded=
"no">
37268 <autodoc>Redraw(self, DC dc)
</autodoc>
37270 <param name=
"dc" type=
"DC" default=
""/>
37273 <method name=
"RemoveAllShapes" type=
"" overloaded=
"no">
37274 <autodoc>RemoveAllShapes(self)
</autodoc>
37276 <method name=
"RemoveShape" type=
"" overloaded=
"no">
37277 <autodoc>RemoveShape(self, PyShape shape)
</autodoc>
37279 <param name=
"shape" type=
"PyShape" default=
""/>
37282 <method name=
"SetCanvas" type=
"" overloaded=
"no">
37283 <autodoc>SetCanvas(self, PyShapeCanvas canvas)
</autodoc>
37285 <param name=
"canvas" type=
"wxPyShapeCanvas" default=
""/>
37288 <method name=
"SetGridSpacing" type=
"" overloaded=
"no">
37289 <autodoc>SetGridSpacing(self, double spacing)
</autodoc>
37291 <param name=
"spacing" type=
"double" default=
""/>
37294 <method name=
"SetMouseTolerance" type=
"" overloaded=
"no">
37295 <autodoc>SetMouseTolerance(self, int tolerance)
</autodoc>
37297 <param name=
"tolerance" type=
"int" default=
""/>
37300 <method name=
"SetQuickEditMode" type=
"" overloaded=
"no">
37301 <autodoc>SetQuickEditMode(self, bool mode)
</autodoc>
37303 <param name=
"mode" type=
"bool" default=
""/>
37306 <method name=
"SetSnapToGrid" type=
"" overloaded=
"no">
37307 <autodoc>SetSnapToGrid(self, bool snap)
</autodoc>
37309 <param name=
"snap" type=
"bool" default=
""/>
37312 <method name=
"ShowAll" type=
"" overloaded=
"no">
37313 <autodoc>ShowAll(self, bool show)
</autodoc>
37315 <param name=
"show" type=
"bool" default=
""/>
37318 <method name=
"Snap" type=
"" overloaded=
"no">
37319 <autodoc>Snap(self, double INOUT, double INOUT)
</autodoc>
37321 <param name=
"INOUT" type=
"double" default=
""/>
37322 <param name=
"INOUT" type=
"double" default=
""/>
37326 <class name=
"PyShapeCanvas" oldname=
"wxPyShapeCanvas" module=
"ogl">
37327 <baseclass name=
"ScrolledWindow"/>
37328 <constructor name=
"PyShapeCanvas" overloaded=
"no">
37329 <autodoc>__init__(self, Window parent=None, int id=-
1, Point pos=DefaultPosition,
37330 Size size=DefaultSize, long style=BORDER,
37331 String name=wxPyShapeCanvasNameStr) -
> PyShapeCanvas
</autodoc>
37333 <param name=
"parent" type=
"Window" default=
"NULL"/>
37334 <param name=
"id" type=
"int" default=
"-1"/>
37335 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
37336 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
37337 <param name=
"style" type=
"long" default=
"wxBORDER"/>
37338 <param name=
"name" type=
"String" default=
"wxPyShapeCanvasNameStr"/>
37341 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
37342 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
37344 <param name=
"self" type=
"PyObject" default=
""/>
37345 <param name=
"_class" type=
"PyObject" default=
""/>
37348 <method name=
"AddShape" type=
"" overloaded=
"no">
37349 <autodoc>AddShape(self, PyShape shape, PyShape addAfter=None)
</autodoc>
37351 <param name=
"shape" type=
"PyShape" default=
""/>
37352 <param name=
"addAfter" type=
"PyShape" default=
"NULL"/>
37355 <method name=
"FindShape" type=
"PyShape" overloaded=
"no">
37356 <autodoc>FindShape(self, double x1, double y, int OUTPUT, wxClassInfo info=None,
37357 PyShape notImage=None) -
> PyShape
</autodoc>
37359 <param name=
"x1" type=
"double" default=
""/>
37360 <param name=
"y" type=
"double" default=
""/>
37361 <param name=
"OUTPUT" type=
"int" default=
""/>
37362 <param name=
"info" type=
"wxClassInfo" default=
"NULL"/>
37363 <param name=
"notImage" type=
"PyShape" default=
"NULL"/>
37366 <method name=
"FindFirstSensitiveShape" type=
"PyShape" overloaded=
"no">
37367 <autodoc>FindFirstSensitiveShape(self, double x1, double y, int OUTPUT, int op) -
> PyShape
</autodoc>
37369 <param name=
"x1" type=
"double" default=
""/>
37370 <param name=
"y" type=
"double" default=
""/>
37371 <param name=
"OUTPUT" type=
"int" default=
""/>
37372 <param name=
"op" type=
"int" default=
""/>
37375 <method name=
"GetDiagram" type=
"Diagram" overloaded=
"no">
37376 <autodoc>GetDiagram(self) -
> Diagram
</autodoc>
37378 <method name=
"GetQuickEditMode" type=
"bool" overloaded=
"no">
37379 <autodoc>GetQuickEditMode(self) -
> bool
</autodoc>
37381 <method name=
"InsertShape" type=
"" overloaded=
"no">
37382 <autodoc>InsertShape(self, PyShape shape)
</autodoc>
37384 <param name=
"shape" type=
"PyShape" default=
""/>
37387 <method name=
"base_OnBeginDragLeft" type=
"" overloaded=
"no">
37388 <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=
0)
</autodoc>
37390 <param name=
"x" type=
"double" default=
""/>
37391 <param name=
"y" type=
"double" default=
""/>
37392 <param name=
"keys" type=
"int" default=
"0"/>
37395 <method name=
"base_OnBeginDragRight" type=
"" overloaded=
"no">
37396 <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=
0)
</autodoc>
37398 <param name=
"x" type=
"double" default=
""/>
37399 <param name=
"y" type=
"double" default=
""/>
37400 <param name=
"keys" type=
"int" default=
"0"/>
37403 <method name=
"base_OnEndDragLeft" type=
"" overloaded=
"no">
37404 <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=
0)
</autodoc>
37406 <param name=
"x" type=
"double" default=
""/>
37407 <param name=
"y" type=
"double" default=
""/>
37408 <param name=
"keys" type=
"int" default=
"0"/>
37411 <method name=
"base_OnEndDragRight" type=
"" overloaded=
"no">
37412 <autodoc>base_OnEndDragRight(self, double x, double y, int keys=
0)
</autodoc>
37414 <param name=
"x" type=
"double" default=
""/>
37415 <param name=
"y" type=
"double" default=
""/>
37416 <param name=
"keys" type=
"int" default=
"0"/>
37419 <method name=
"base_OnDragLeft" type=
"" overloaded=
"no">
37420 <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=
0)
</autodoc>
37422 <param name=
"draw" type=
"bool" default=
""/>
37423 <param name=
"x" type=
"double" default=
""/>
37424 <param name=
"y" type=
"double" default=
""/>
37425 <param name=
"keys" type=
"int" default=
"0"/>
37428 <method name=
"base_OnDragRight" type=
"" overloaded=
"no">
37429 <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=
0)
</autodoc>
37431 <param name=
"draw" type=
"bool" default=
""/>
37432 <param name=
"x" type=
"double" default=
""/>
37433 <param name=
"y" type=
"double" default=
""/>
37434 <param name=
"keys" type=
"int" default=
"0"/>
37437 <method name=
"base_OnLeftClick" type=
"" overloaded=
"no">
37438 <autodoc>base_OnLeftClick(self, double x, double y, int keys=
0)
</autodoc>
37440 <param name=
"x" type=
"double" default=
""/>
37441 <param name=
"y" type=
"double" default=
""/>
37442 <param name=
"keys" type=
"int" default=
"0"/>
37445 <method name=
"base_OnRightClick" type=
"" overloaded=
"no">
37446 <autodoc>base_OnRightClick(self, double x, double y, int keys=
0)
</autodoc>
37448 <param name=
"x" type=
"double" default=
""/>
37449 <param name=
"y" type=
"double" default=
""/>
37450 <param name=
"keys" type=
"int" default=
"0"/>
37453 <method name=
"Redraw" type=
"" overloaded=
"no">
37454 <autodoc>Redraw(self, DC dc)
</autodoc>
37456 <param name=
"dc" type=
"DC" default=
""/>
37459 <method name=
"RemoveShape" type=
"" overloaded=
"no">
37460 <autodoc>RemoveShape(self, PyShape shape)
</autodoc>
37462 <param name=
"shape" type=
"PyShape" default=
""/>
37465 <method name=
"SetDiagram" type=
"" overloaded=
"no">
37466 <autodoc>SetDiagram(self, Diagram diagram)
</autodoc>
37468 <param name=
"diagram" type=
"Diagram" default=
""/>
37471 <method name=
"Snap" type=
"" overloaded=
"no">
37472 <autodoc>Snap(self, double INOUT, double INOUT)
</autodoc>
37474 <param name=
"INOUT" type=
"double" default=
""/>
37475 <param name=
"INOUT" type=
"double" default=
""/>
37481 ShapeCanvas = PyShapeCanvas
37482 ShapeEvtHandler = PyShapeEvtHandler
37484 RectangleShape = PyRectangleShape
37485 BitmapShape = PyBitmapShape
37486 DrawnShape = PyDrawnShape
37487 CompositeShape = PyCompositeShape
37488 DividedShape = PyDividedShape
37489 DivisionShape = PyDivisionShape
37490 EllipseShape = PyEllipseShape
37491 CircleShape = PyCircleShape
37492 LineShape = PyLineShape
37493 PolygonShape = PyPolygonShape
37494 TextShape = PyTextShape
37495 ControlPoint = PyControlPoint
37497 <method name=
"OGLInitialize" oldname=
"wxOGLInitialize" type=
"" overloaded=
"no">
37498 <autodoc>OGLInitialize()
</autodoc>
37500 <method name=
"OGLCleanUp" oldname=
"wxOGLCleanUp" type=
"" overloaded=
"no">
37501 <autodoc>OGLCleanUp()
</autodoc>
37504 <module name=
"stc">
37505 <import name=
"_core"/>
37506 <import name=
"_misc"/>
37507 <pythoncode> wx = _core
</pythoncode>
37508 <pythoncode> __docfilter__ = wx.__DocFilter(globals())
</pythoncode>
37509 <class name=
"StyledTextCtrl" oldname=
"wxStyledTextCtrl" module=
"stc">
37510 <baseclass name=
"Control"/>
37511 <constructor name=
"StyledTextCtrl" overloaded=
"no">
37512 <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
37513 Size size=DefaultSize, long style=
0, String name=STCNameStr) -
> StyledTextCtrl
</autodoc>
37515 <param name=
"parent" type=
"Window" default=
""/>
37516 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
37517 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
37518 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
37519 <param name=
"style" type=
"long" default=
"0"/>
37520 <param name=
"name" type=
"String" default=
"wxPySTCNameStr"/>
37523 <constructor name=
"PreStyledTextCtrl" overloaded=
"no">
37524 <autodoc>PreStyledTextCtrl() -
> StyledTextCtrl
</autodoc>
37526 <method name=
"Create" type=
"" overloaded=
"no">
37527 <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition,
37528 Size size=DefaultSize, long style=
0, String name=wxSTCNameStr)
</autodoc>
37530 <param name=
"parent" type=
"Window" default=
""/>
37531 <param name=
"id" type=
"int" default=
"wxID_ANY"/>
37532 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
37533 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
37534 <param name=
"style" type=
"long" default=
"0"/>
37535 <param name=
"name" type=
"String" default=
"wxSTCNameStr"/>
37538 <method name=
"AddText" type=
"" overloaded=
"no">
37539 <autodoc>AddText(self, String text)
</autodoc>
37541 <param name=
"text" type=
"String" default=
""/>
37544 <method name=
"AddStyledText" type=
"" overloaded=
"no">
37545 <autodoc>AddStyledText(self, wxMemoryBuffer data)
</autodoc>
37547 <param name=
"data" type=
"wxMemoryBuffer" default=
""/>
37550 <method name=
"InsertText" type=
"" overloaded=
"no">
37551 <autodoc>InsertText(self, int pos, String text)
</autodoc>
37553 <param name=
"pos" type=
"int" default=
""/>
37554 <param name=
"text" type=
"String" default=
""/>
37557 <method name=
"ClearAll" type=
"" overloaded=
"no">
37558 <autodoc>ClearAll(self)
</autodoc>
37560 <method name=
"ClearDocumentStyle" type=
"" overloaded=
"no">
37561 <autodoc>ClearDocumentStyle(self)
</autodoc>
37563 <method name=
"GetLength" type=
"int" overloaded=
"no">
37564 <autodoc>GetLength(self) -
> int
</autodoc>
37566 <method name=
"GetCharAt" type=
"int" overloaded=
"no">
37567 <autodoc>GetCharAt(self, int pos) -
> int
</autodoc>
37569 <param name=
"pos" type=
"int" default=
""/>
37572 <method name=
"GetCurrentPos" type=
"int" overloaded=
"no">
37573 <autodoc>GetCurrentPos(self) -
> int
</autodoc>
37575 <method name=
"GetAnchor" type=
"int" overloaded=
"no">
37576 <autodoc>GetAnchor(self) -
> int
</autodoc>
37578 <method name=
"GetStyleAt" type=
"int" overloaded=
"no">
37579 <autodoc>GetStyleAt(self, int pos) -
> int
</autodoc>
37581 <param name=
"pos" type=
"int" default=
""/>
37584 <method name=
"Redo" type=
"" overloaded=
"no">
37585 <autodoc>Redo(self)
</autodoc>
37587 <method name=
"SetUndoCollection" type=
"" overloaded=
"no">
37588 <autodoc>SetUndoCollection(self, bool collectUndo)
</autodoc>
37590 <param name=
"collectUndo" type=
"bool" default=
""/>
37593 <method name=
"SelectAll" type=
"" overloaded=
"no">
37594 <autodoc>SelectAll(self)
</autodoc>
37596 <method name=
"SetSavePoint" type=
"" overloaded=
"no">
37597 <autodoc>SetSavePoint(self)
</autodoc>
37599 <method name=
"GetStyledText" type=
"wxMemoryBuffer" overloaded=
"no">
37600 <autodoc>GetStyledText(self, int startPos, int endPos) -
> wxMemoryBuffer
</autodoc>
37602 <param name=
"startPos" type=
"int" default=
""/>
37603 <param name=
"endPos" type=
"int" default=
""/>
37606 <method name=
"CanRedo" type=
"bool" overloaded=
"no">
37607 <autodoc>CanRedo(self) -
> bool
</autodoc>
37609 <method name=
"MarkerLineFromHandle" type=
"int" overloaded=
"no">
37610 <autodoc>MarkerLineFromHandle(self, int handle) -
> int
</autodoc>
37612 <param name=
"handle" type=
"int" default=
""/>
37615 <method name=
"MarkerDeleteHandle" type=
"" overloaded=
"no">
37616 <autodoc>MarkerDeleteHandle(self, int handle)
</autodoc>
37618 <param name=
"handle" type=
"int" default=
""/>
37621 <method name=
"GetUndoCollection" type=
"bool" overloaded=
"no">
37622 <autodoc>GetUndoCollection(self) -
> bool
</autodoc>
37624 <method name=
"GetViewWhiteSpace" type=
"int" overloaded=
"no">
37625 <autodoc>GetViewWhiteSpace(self) -
> int
</autodoc>
37627 <method name=
"SetViewWhiteSpace" type=
"" overloaded=
"no">
37628 <autodoc>SetViewWhiteSpace(self, int viewWS)
</autodoc>
37630 <param name=
"viewWS" type=
"int" default=
""/>
37633 <method name=
"PositionFromPoint" type=
"int" overloaded=
"no">
37634 <autodoc>PositionFromPoint(self, Point pt) -
> int
</autodoc>
37636 <param name=
"pt" type=
"Point" default=
""/>
37639 <method name=
"PositionFromPointClose" type=
"int" overloaded=
"no">
37640 <autodoc>PositionFromPointClose(self, int x, int y) -
> int
</autodoc>
37642 <param name=
"x" type=
"int" default=
""/>
37643 <param name=
"y" type=
"int" default=
""/>
37646 <method name=
"GotoLine" type=
"" overloaded=
"no">
37647 <autodoc>GotoLine(self, int line)
</autodoc>
37649 <param name=
"line" type=
"int" default=
""/>
37652 <method name=
"GotoPos" type=
"" overloaded=
"no">
37653 <autodoc>GotoPos(self, int pos)
</autodoc>
37655 <param name=
"pos" type=
"int" default=
""/>
37658 <method name=
"SetAnchor" type=
"" overloaded=
"no">
37659 <autodoc>SetAnchor(self, int posAnchor)
</autodoc>
37661 <param name=
"posAnchor" type=
"int" default=
""/>
37664 <method name=
"GetCurLine" type=
"String" overloaded=
"no">
37665 <autodoc>GetCurLine(self, int OUTPUT) -
> String
</autodoc>
37667 <param name=
"OUTPUT" type=
"int" default=
""/>
37670 <method name=
"GetEndStyled" type=
"int" overloaded=
"no">
37671 <autodoc>GetEndStyled(self) -
> int
</autodoc>
37673 <method name=
"ConvertEOLs" type=
"" overloaded=
"no">
37674 <autodoc>ConvertEOLs(self, int eolMode)
</autodoc>
37676 <param name=
"eolMode" type=
"int" default=
""/>
37679 <method name=
"GetEOLMode" type=
"int" overloaded=
"no">
37680 <autodoc>GetEOLMode(self) -
> int
</autodoc>
37682 <method name=
"SetEOLMode" type=
"" overloaded=
"no">
37683 <autodoc>SetEOLMode(self, int eolMode)
</autodoc>
37685 <param name=
"eolMode" type=
"int" default=
""/>
37688 <method name=
"StartStyling" type=
"" overloaded=
"no">
37689 <autodoc>StartStyling(self, int pos, int mask)
</autodoc>
37691 <param name=
"pos" type=
"int" default=
""/>
37692 <param name=
"mask" type=
"int" default=
""/>
37695 <method name=
"SetStyling" type=
"" overloaded=
"no">
37696 <autodoc>SetStyling(self, int length, int style)
</autodoc>
37698 <param name=
"length" type=
"int" default=
""/>
37699 <param name=
"style" type=
"int" default=
""/>
37702 <method name=
"GetBufferedDraw" type=
"bool" overloaded=
"no">
37703 <autodoc>GetBufferedDraw(self) -
> bool
</autodoc>
37705 <method name=
"SetBufferedDraw" type=
"" overloaded=
"no">
37706 <autodoc>SetBufferedDraw(self, bool buffered)
</autodoc>
37708 <param name=
"buffered" type=
"bool" default=
""/>
37711 <method name=
"SetTabWidth" type=
"" overloaded=
"no">
37712 <autodoc>SetTabWidth(self, int tabWidth)
</autodoc>
37714 <param name=
"tabWidth" type=
"int" default=
""/>
37717 <method name=
"GetTabWidth" type=
"int" overloaded=
"no">
37718 <autodoc>GetTabWidth(self) -
> int
</autodoc>
37720 <method name=
"SetCodePage" type=
"" overloaded=
"no">
37721 <autodoc>SetCodePage(self, int codePage)
</autodoc>
37723 <param name=
"codePage" type=
"int" default=
""/>
37726 <method name=
"MarkerDefine" type=
"" overloaded=
"no">
37727 <autodoc>MarkerDefine(self, int markerNumber, int markerSymbol, Colour foreground=wxNullColour,
37728 Colour background=wxNullColour)
</autodoc>
37730 <param name=
"markerNumber" type=
"int" default=
""/>
37731 <param name=
"markerSymbol" type=
"int" default=
""/>
37732 <param name=
"foreground" type=
"Colour" default=
"wxNullColour"/>
37733 <param name=
"background" type=
"Colour" default=
"wxNullColour"/>
37736 <method name=
"MarkerSetForeground" type=
"" overloaded=
"no">
37737 <autodoc>MarkerSetForeground(self, int markerNumber, Colour fore)
</autodoc>
37739 <param name=
"markerNumber" type=
"int" default=
""/>
37740 <param name=
"fore" type=
"Colour" default=
""/>
37743 <method name=
"MarkerSetBackground" type=
"" overloaded=
"no">
37744 <autodoc>MarkerSetBackground(self, int markerNumber, Colour back)
</autodoc>
37746 <param name=
"markerNumber" type=
"int" default=
""/>
37747 <param name=
"back" type=
"Colour" default=
""/>
37750 <method name=
"MarkerAdd" type=
"int" overloaded=
"no">
37751 <autodoc>MarkerAdd(self, int line, int markerNumber) -
> int
</autodoc>
37753 <param name=
"line" type=
"int" default=
""/>
37754 <param name=
"markerNumber" type=
"int" default=
""/>
37757 <method name=
"MarkerDelete" type=
"" overloaded=
"no">
37758 <autodoc>MarkerDelete(self, int line, int markerNumber)
</autodoc>
37760 <param name=
"line" type=
"int" default=
""/>
37761 <param name=
"markerNumber" type=
"int" default=
""/>
37764 <method name=
"MarkerDeleteAll" type=
"" overloaded=
"no">
37765 <autodoc>MarkerDeleteAll(self, int markerNumber)
</autodoc>
37767 <param name=
"markerNumber" type=
"int" default=
""/>
37770 <method name=
"MarkerGet" type=
"int" overloaded=
"no">
37771 <autodoc>MarkerGet(self, int line) -
> int
</autodoc>
37773 <param name=
"line" type=
"int" default=
""/>
37776 <method name=
"MarkerNext" type=
"int" overloaded=
"no">
37777 <autodoc>MarkerNext(self, int lineStart, int markerMask) -
> int
</autodoc>
37779 <param name=
"lineStart" type=
"int" default=
""/>
37780 <param name=
"markerMask" type=
"int" default=
""/>
37783 <method name=
"MarkerPrevious" type=
"int" overloaded=
"no">
37784 <autodoc>MarkerPrevious(self, int lineStart, int markerMask) -
> int
</autodoc>
37786 <param name=
"lineStart" type=
"int" default=
""/>
37787 <param name=
"markerMask" type=
"int" default=
""/>
37790 <method name=
"MarkerDefineBitmap" type=
"" overloaded=
"no">
37791 <autodoc>MarkerDefineBitmap(self, int markerNumber, Bitmap bmp)
</autodoc>
37793 <param name=
"markerNumber" type=
"int" default=
""/>
37794 <param name=
"bmp" type=
"Bitmap" default=
""/>
37797 <method name=
"SetMarginType" type=
"" overloaded=
"no">
37798 <autodoc>SetMarginType(self, int margin, int marginType)
</autodoc>
37800 <param name=
"margin" type=
"int" default=
""/>
37801 <param name=
"marginType" type=
"int" default=
""/>
37804 <method name=
"GetMarginType" type=
"int" overloaded=
"no">
37805 <autodoc>GetMarginType(self, int margin) -
> int
</autodoc>
37807 <param name=
"margin" type=
"int" default=
""/>
37810 <method name=
"SetMarginWidth" type=
"" overloaded=
"no">
37811 <autodoc>SetMarginWidth(self, int margin, int pixelWidth)
</autodoc>
37813 <param name=
"margin" type=
"int" default=
""/>
37814 <param name=
"pixelWidth" type=
"int" default=
""/>
37817 <method name=
"GetMarginWidth" type=
"int" overloaded=
"no">
37818 <autodoc>GetMarginWidth(self, int margin) -
> int
</autodoc>
37820 <param name=
"margin" type=
"int" default=
""/>
37823 <method name=
"SetMarginMask" type=
"" overloaded=
"no">
37824 <autodoc>SetMarginMask(self, int margin, int mask)
</autodoc>
37826 <param name=
"margin" type=
"int" default=
""/>
37827 <param name=
"mask" type=
"int" default=
""/>
37830 <method name=
"GetMarginMask" type=
"int" overloaded=
"no">
37831 <autodoc>GetMarginMask(self, int margin) -
> int
</autodoc>
37833 <param name=
"margin" type=
"int" default=
""/>
37836 <method name=
"SetMarginSensitive" type=
"" overloaded=
"no">
37837 <autodoc>SetMarginSensitive(self, int margin, bool sensitive)
</autodoc>
37839 <param name=
"margin" type=
"int" default=
""/>
37840 <param name=
"sensitive" type=
"bool" default=
""/>
37843 <method name=
"GetMarginSensitive" type=
"bool" overloaded=
"no">
37844 <autodoc>GetMarginSensitive(self, int margin) -
> bool
</autodoc>
37846 <param name=
"margin" type=
"int" default=
""/>
37849 <method name=
"StyleClearAll" type=
"" overloaded=
"no">
37850 <autodoc>StyleClearAll(self)
</autodoc>
37852 <method name=
"StyleSetForeground" type=
"" overloaded=
"no">
37853 <autodoc>StyleSetForeground(self, int style, Colour fore)
</autodoc>
37855 <param name=
"style" type=
"int" default=
""/>
37856 <param name=
"fore" type=
"Colour" default=
""/>
37859 <method name=
"StyleSetBackground" type=
"" overloaded=
"no">
37860 <autodoc>StyleSetBackground(self, int style, Colour back)
</autodoc>
37862 <param name=
"style" type=
"int" default=
""/>
37863 <param name=
"back" type=
"Colour" default=
""/>
37866 <method name=
"StyleSetBold" type=
"" overloaded=
"no">
37867 <autodoc>StyleSetBold(self, int style, bool bold)
</autodoc>
37869 <param name=
"style" type=
"int" default=
""/>
37870 <param name=
"bold" type=
"bool" default=
""/>
37873 <method name=
"StyleSetItalic" type=
"" overloaded=
"no">
37874 <autodoc>StyleSetItalic(self, int style, bool italic)
</autodoc>
37876 <param name=
"style" type=
"int" default=
""/>
37877 <param name=
"italic" type=
"bool" default=
""/>
37880 <method name=
"StyleSetSize" type=
"" overloaded=
"no">
37881 <autodoc>StyleSetSize(self, int style, int sizePoints)
</autodoc>
37883 <param name=
"style" type=
"int" default=
""/>
37884 <param name=
"sizePoints" type=
"int" default=
""/>
37887 <method name=
"StyleSetFaceName" type=
"" overloaded=
"no">
37888 <autodoc>StyleSetFaceName(self, int style, String fontName)
</autodoc>
37890 <param name=
"style" type=
"int" default=
""/>
37891 <param name=
"fontName" type=
"String" default=
""/>
37894 <method name=
"StyleSetEOLFilled" type=
"" overloaded=
"no">
37895 <autodoc>StyleSetEOLFilled(self, int style, bool filled)
</autodoc>
37897 <param name=
"style" type=
"int" default=
""/>
37898 <param name=
"filled" type=
"bool" default=
""/>
37901 <method name=
"StyleResetDefault" type=
"" overloaded=
"no">
37902 <autodoc>StyleResetDefault(self)
</autodoc>
37904 <method name=
"StyleSetUnderline" type=
"" overloaded=
"no">
37905 <autodoc>StyleSetUnderline(self, int style, bool underline)
</autodoc>
37907 <param name=
"style" type=
"int" default=
""/>
37908 <param name=
"underline" type=
"bool" default=
""/>
37911 <method name=
"StyleSetCase" type=
"" overloaded=
"no">
37912 <autodoc>StyleSetCase(self, int style, int caseForce)
</autodoc>
37914 <param name=
"style" type=
"int" default=
""/>
37915 <param name=
"caseForce" type=
"int" default=
""/>
37918 <method name=
"StyleSetCharacterSet" type=
"" overloaded=
"no">
37919 <autodoc>StyleSetCharacterSet(self, int style, int characterSet)
</autodoc>
37921 <param name=
"style" type=
"int" default=
""/>
37922 <param name=
"characterSet" type=
"int" default=
""/>
37925 <method name=
"StyleSetHotSpot" type=
"" overloaded=
"no">
37926 <autodoc>StyleSetHotSpot(self, int style, bool hotspot)
</autodoc>
37928 <param name=
"style" type=
"int" default=
""/>
37929 <param name=
"hotspot" type=
"bool" default=
""/>
37932 <method name=
"SetSelForeground" type=
"" overloaded=
"no">
37933 <autodoc>SetSelForeground(self, bool useSetting, Colour fore)
</autodoc>
37935 <param name=
"useSetting" type=
"bool" default=
""/>
37936 <param name=
"fore" type=
"Colour" default=
""/>
37939 <method name=
"SetSelBackground" type=
"" overloaded=
"no">
37940 <autodoc>SetSelBackground(self, bool useSetting, Colour back)
</autodoc>
37942 <param name=
"useSetting" type=
"bool" default=
""/>
37943 <param name=
"back" type=
"Colour" default=
""/>
37946 <method name=
"SetCaretForeground" type=
"" overloaded=
"no">
37947 <autodoc>SetCaretForeground(self, Colour fore)
</autodoc>
37949 <param name=
"fore" type=
"Colour" default=
""/>
37952 <method name=
"CmdKeyAssign" type=
"" overloaded=
"no">
37953 <autodoc>CmdKeyAssign(self, int key, int modifiers, int cmd)
</autodoc>
37955 <param name=
"key" type=
"int" default=
""/>
37956 <param name=
"modifiers" type=
"int" default=
""/>
37957 <param name=
"cmd" type=
"int" default=
""/>
37960 <method name=
"CmdKeyClear" type=
"" overloaded=
"no">
37961 <autodoc>CmdKeyClear(self, int key, int modifiers)
</autodoc>
37963 <param name=
"key" type=
"int" default=
""/>
37964 <param name=
"modifiers" type=
"int" default=
""/>
37967 <method name=
"CmdKeyClearAll" type=
"" overloaded=
"no">
37968 <autodoc>CmdKeyClearAll(self)
</autodoc>
37970 <method name=
"SetStyleBytes" type=
"" overloaded=
"no">
37971 <autodoc>SetStyleBytes(self, int length, char styleBytes)
</autodoc>
37973 <param name=
"length" type=
"int" default=
""/>
37974 <param name=
"styleBytes" type=
"char" default=
""/>
37977 <method name=
"StyleSetVisible" type=
"" overloaded=
"no">
37978 <autodoc>StyleSetVisible(self, int style, bool visible)
</autodoc>
37980 <param name=
"style" type=
"int" default=
""/>
37981 <param name=
"visible" type=
"bool" default=
""/>
37984 <method name=
"GetCaretPeriod" type=
"int" overloaded=
"no">
37985 <autodoc>GetCaretPeriod(self) -
> int
</autodoc>
37987 <method name=
"SetCaretPeriod" type=
"" overloaded=
"no">
37988 <autodoc>SetCaretPeriod(self, int periodMilliseconds)
</autodoc>
37990 <param name=
"periodMilliseconds" type=
"int" default=
""/>
37993 <method name=
"SetWordChars" type=
"" overloaded=
"no">
37994 <autodoc>SetWordChars(self, String characters)
</autodoc>
37996 <param name=
"characters" type=
"String" default=
""/>
37999 <method name=
"BeginUndoAction" type=
"" overloaded=
"no">
38000 <autodoc>BeginUndoAction(self)
</autodoc>
38002 <method name=
"EndUndoAction" type=
"" overloaded=
"no">
38003 <autodoc>EndUndoAction(self)
</autodoc>
38005 <method name=
"IndicatorSetStyle" type=
"" overloaded=
"no">
38006 <autodoc>IndicatorSetStyle(self, int indic, int style)
</autodoc>
38008 <param name=
"indic" type=
"int" default=
""/>
38009 <param name=
"style" type=
"int" default=
""/>
38012 <method name=
"IndicatorGetStyle" type=
"int" overloaded=
"no">
38013 <autodoc>IndicatorGetStyle(self, int indic) -
> int
</autodoc>
38015 <param name=
"indic" type=
"int" default=
""/>
38018 <method name=
"IndicatorSetForeground" type=
"" overloaded=
"no">
38019 <autodoc>IndicatorSetForeground(self, int indic, Colour fore)
</autodoc>
38021 <param name=
"indic" type=
"int" default=
""/>
38022 <param name=
"fore" type=
"Colour" default=
""/>
38025 <method name=
"IndicatorGetForeground" type=
"Colour" overloaded=
"no">
38026 <autodoc>IndicatorGetForeground(self, int indic) -
> Colour
</autodoc>
38028 <param name=
"indic" type=
"int" default=
""/>
38031 <method name=
"SetWhitespaceForeground" type=
"" overloaded=
"no">
38032 <autodoc>SetWhitespaceForeground(self, bool useSetting, Colour fore)
</autodoc>
38034 <param name=
"useSetting" type=
"bool" default=
""/>
38035 <param name=
"fore" type=
"Colour" default=
""/>
38038 <method name=
"SetWhitespaceBackground" type=
"" overloaded=
"no">
38039 <autodoc>SetWhitespaceBackground(self, bool useSetting, Colour back)
</autodoc>
38041 <param name=
"useSetting" type=
"bool" default=
""/>
38042 <param name=
"back" type=
"Colour" default=
""/>
38045 <method name=
"SetStyleBits" type=
"" overloaded=
"no">
38046 <autodoc>SetStyleBits(self, int bits)
</autodoc>
38048 <param name=
"bits" type=
"int" default=
""/>
38051 <method name=
"GetStyleBits" type=
"int" overloaded=
"no">
38052 <autodoc>GetStyleBits(self) -
> int
</autodoc>
38054 <method name=
"SetLineState" type=
"" overloaded=
"no">
38055 <autodoc>SetLineState(self, int line, int state)
</autodoc>
38057 <param name=
"line" type=
"int" default=
""/>
38058 <param name=
"state" type=
"int" default=
""/>
38061 <method name=
"GetLineState" type=
"int" overloaded=
"no">
38062 <autodoc>GetLineState(self, int line) -
> int
</autodoc>
38064 <param name=
"line" type=
"int" default=
""/>
38067 <method name=
"GetMaxLineState" type=
"int" overloaded=
"no">
38068 <autodoc>GetMaxLineState(self) -
> int
</autodoc>
38070 <method name=
"GetCaretLineVisible" type=
"bool" overloaded=
"no">
38071 <autodoc>GetCaretLineVisible(self) -
> bool
</autodoc>
38073 <method name=
"SetCaretLineVisible" type=
"" overloaded=
"no">
38074 <autodoc>SetCaretLineVisible(self, bool show)
</autodoc>
38076 <param name=
"show" type=
"bool" default=
""/>
38079 <method name=
"GetCaretLineBack" type=
"Colour" overloaded=
"no">
38080 <autodoc>GetCaretLineBack(self) -
> Colour
</autodoc>
38082 <method name=
"SetCaretLineBack" type=
"" overloaded=
"no">
38083 <autodoc>SetCaretLineBack(self, Colour back)
</autodoc>
38085 <param name=
"back" type=
"Colour" default=
""/>
38088 <method name=
"StyleSetChangeable" type=
"" overloaded=
"no">
38089 <autodoc>StyleSetChangeable(self, int style, bool changeable)
</autodoc>
38091 <param name=
"style" type=
"int" default=
""/>
38092 <param name=
"changeable" type=
"bool" default=
""/>
38095 <method name=
"AutoCompShow" type=
"" overloaded=
"no">
38096 <autodoc>AutoCompShow(self, int lenEntered, String itemList)
</autodoc>
38098 <param name=
"lenEntered" type=
"int" default=
""/>
38099 <param name=
"itemList" type=
"String" default=
""/>
38102 <method name=
"AutoCompCancel" type=
"" overloaded=
"no">
38103 <autodoc>AutoCompCancel(self)
</autodoc>
38105 <method name=
"AutoCompActive" type=
"bool" overloaded=
"no">
38106 <autodoc>AutoCompActive(self) -
> bool
</autodoc>
38108 <method name=
"AutoCompPosStart" type=
"int" overloaded=
"no">
38109 <autodoc>AutoCompPosStart(self) -
> int
</autodoc>
38111 <method name=
"AutoCompComplete" type=
"" overloaded=
"no">
38112 <autodoc>AutoCompComplete(self)
</autodoc>
38114 <method name=
"AutoCompStops" type=
"" overloaded=
"no">
38115 <autodoc>AutoCompStops(self, String characterSet)
</autodoc>
38117 <param name=
"characterSet" type=
"String" default=
""/>
38120 <method name=
"AutoCompSetSeparator" type=
"" overloaded=
"no">
38121 <autodoc>AutoCompSetSeparator(self, int separatorCharacter)
</autodoc>
38123 <param name=
"separatorCharacter" type=
"int" default=
""/>
38126 <method name=
"AutoCompGetSeparator" type=
"int" overloaded=
"no">
38127 <autodoc>AutoCompGetSeparator(self) -
> int
</autodoc>
38129 <method name=
"AutoCompSelect" type=
"" overloaded=
"no">
38130 <autodoc>AutoCompSelect(self, String text)
</autodoc>
38132 <param name=
"text" type=
"String" default=
""/>
38135 <method name=
"AutoCompSetCancelAtStart" type=
"" overloaded=
"no">
38136 <autodoc>AutoCompSetCancelAtStart(self, bool cancel)
</autodoc>
38138 <param name=
"cancel" type=
"bool" default=
""/>
38141 <method name=
"AutoCompGetCancelAtStart" type=
"bool" overloaded=
"no">
38142 <autodoc>AutoCompGetCancelAtStart(self) -
> bool
</autodoc>
38144 <method name=
"AutoCompSetFillUps" type=
"" overloaded=
"no">
38145 <autodoc>AutoCompSetFillUps(self, String characterSet)
</autodoc>
38147 <param name=
"characterSet" type=
"String" default=
""/>
38150 <method name=
"AutoCompSetChooseSingle" type=
"" overloaded=
"no">
38151 <autodoc>AutoCompSetChooseSingle(self, bool chooseSingle)
</autodoc>
38153 <param name=
"chooseSingle" type=
"bool" default=
""/>
38156 <method name=
"AutoCompGetChooseSingle" type=
"bool" overloaded=
"no">
38157 <autodoc>AutoCompGetChooseSingle(self) -
> bool
</autodoc>
38159 <method name=
"AutoCompSetIgnoreCase" type=
"" overloaded=
"no">
38160 <autodoc>AutoCompSetIgnoreCase(self, bool ignoreCase)
</autodoc>
38162 <param name=
"ignoreCase" type=
"bool" default=
""/>
38165 <method name=
"AutoCompGetIgnoreCase" type=
"bool" overloaded=
"no">
38166 <autodoc>AutoCompGetIgnoreCase(self) -
> bool
</autodoc>
38168 <method name=
"UserListShow" type=
"" overloaded=
"no">
38169 <autodoc>UserListShow(self, int listType, String itemList)
</autodoc>
38171 <param name=
"listType" type=
"int" default=
""/>
38172 <param name=
"itemList" type=
"String" default=
""/>
38175 <method name=
"AutoCompSetAutoHide" type=
"" overloaded=
"no">
38176 <autodoc>AutoCompSetAutoHide(self, bool autoHide)
</autodoc>
38178 <param name=
"autoHide" type=
"bool" default=
""/>
38181 <method name=
"AutoCompGetAutoHide" type=
"bool" overloaded=
"no">
38182 <autodoc>AutoCompGetAutoHide(self) -
> bool
</autodoc>
38184 <method name=
"AutoCompSetDropRestOfWord" type=
"" overloaded=
"no">
38185 <autodoc>AutoCompSetDropRestOfWord(self, bool dropRestOfWord)
</autodoc>
38187 <param name=
"dropRestOfWord" type=
"bool" default=
""/>
38190 <method name=
"AutoCompGetDropRestOfWord" type=
"bool" overloaded=
"no">
38191 <autodoc>AutoCompGetDropRestOfWord(self) -
> bool
</autodoc>
38193 <method name=
"RegisterImage" type=
"" overloaded=
"no">
38194 <autodoc>RegisterImage(self, int type, Bitmap bmp)
</autodoc>
38196 <param name=
"type" type=
"int" default=
""/>
38197 <param name=
"bmp" type=
"Bitmap" default=
""/>
38200 <method name=
"ClearRegisteredImages" type=
"" overloaded=
"no">
38201 <autodoc>ClearRegisteredImages(self)
</autodoc>
38203 <method name=
"AutoCompGetTypeSeparator" type=
"int" overloaded=
"no">
38204 <autodoc>AutoCompGetTypeSeparator(self) -
> int
</autodoc>
38206 <method name=
"AutoCompSetTypeSeparator" type=
"" overloaded=
"no">
38207 <autodoc>AutoCompSetTypeSeparator(self, int separatorCharacter)
</autodoc>
38209 <param name=
"separatorCharacter" type=
"int" default=
""/>
38212 <method name=
"SetIndent" type=
"" overloaded=
"no">
38213 <autodoc>SetIndent(self, int indentSize)
</autodoc>
38215 <param name=
"indentSize" type=
"int" default=
""/>
38218 <method name=
"GetIndent" type=
"int" overloaded=
"no">
38219 <autodoc>GetIndent(self) -
> int
</autodoc>
38221 <method name=
"SetUseTabs" type=
"" overloaded=
"no">
38222 <autodoc>SetUseTabs(self, bool useTabs)
</autodoc>
38224 <param name=
"useTabs" type=
"bool" default=
""/>
38227 <method name=
"GetUseTabs" type=
"bool" overloaded=
"no">
38228 <autodoc>GetUseTabs(self) -
> bool
</autodoc>
38230 <method name=
"SetLineIndentation" type=
"" overloaded=
"no">
38231 <autodoc>SetLineIndentation(self, int line, int indentSize)
</autodoc>
38233 <param name=
"line" type=
"int" default=
""/>
38234 <param name=
"indentSize" type=
"int" default=
""/>
38237 <method name=
"GetLineIndentation" type=
"int" overloaded=
"no">
38238 <autodoc>GetLineIndentation(self, int line) -
> int
</autodoc>
38240 <param name=
"line" type=
"int" default=
""/>
38243 <method name=
"GetLineIndentPosition" type=
"int" overloaded=
"no">
38244 <autodoc>GetLineIndentPosition(self, int line) -
> int
</autodoc>
38246 <param name=
"line" type=
"int" default=
""/>
38249 <method name=
"GetColumn" type=
"int" overloaded=
"no">
38250 <autodoc>GetColumn(self, int pos) -
> int
</autodoc>
38252 <param name=
"pos" type=
"int" default=
""/>
38255 <method name=
"SetUseHorizontalScrollBar" type=
"" overloaded=
"no">
38256 <autodoc>SetUseHorizontalScrollBar(self, bool show)
</autodoc>
38258 <param name=
"show" type=
"bool" default=
""/>
38261 <method name=
"GetUseHorizontalScrollBar" type=
"bool" overloaded=
"no">
38262 <autodoc>GetUseHorizontalScrollBar(self) -
> bool
</autodoc>
38264 <method name=
"SetIndentationGuides" type=
"" overloaded=
"no">
38265 <autodoc>SetIndentationGuides(self, bool show)
</autodoc>
38267 <param name=
"show" type=
"bool" default=
""/>
38270 <method name=
"GetIndentationGuides" type=
"bool" overloaded=
"no">
38271 <autodoc>GetIndentationGuides(self) -
> bool
</autodoc>
38273 <method name=
"SetHighlightGuide" type=
"" overloaded=
"no">
38274 <autodoc>SetHighlightGuide(self, int column)
</autodoc>
38276 <param name=
"column" type=
"int" default=
""/>
38279 <method name=
"GetHighlightGuide" type=
"int" overloaded=
"no">
38280 <autodoc>GetHighlightGuide(self) -
> int
</autodoc>
38282 <method name=
"GetLineEndPosition" type=
"int" overloaded=
"no">
38283 <autodoc>GetLineEndPosition(self, int line) -
> int
</autodoc>
38285 <param name=
"line" type=
"int" default=
""/>
38288 <method name=
"GetCodePage" type=
"int" overloaded=
"no">
38289 <autodoc>GetCodePage(self) -
> int
</autodoc>
38291 <method name=
"GetCaretForeground" type=
"Colour" overloaded=
"no">
38292 <autodoc>GetCaretForeground(self) -
> Colour
</autodoc>
38294 <method name=
"GetReadOnly" type=
"bool" overloaded=
"no">
38295 <autodoc>GetReadOnly(self) -
> bool
</autodoc>
38297 <method name=
"SetCurrentPos" type=
"" overloaded=
"no">
38298 <autodoc>SetCurrentPos(self, int pos)
</autodoc>
38300 <param name=
"pos" type=
"int" default=
""/>
38303 <method name=
"SetSelectionStart" type=
"" overloaded=
"no">
38304 <autodoc>SetSelectionStart(self, int pos)
</autodoc>
38306 <param name=
"pos" type=
"int" default=
""/>
38309 <method name=
"GetSelectionStart" type=
"int" overloaded=
"no">
38310 <autodoc>GetSelectionStart(self) -
> int
</autodoc>
38312 <method name=
"SetSelectionEnd" type=
"" overloaded=
"no">
38313 <autodoc>SetSelectionEnd(self, int pos)
</autodoc>
38315 <param name=
"pos" type=
"int" default=
""/>
38318 <method name=
"GetSelectionEnd" type=
"int" overloaded=
"no">
38319 <autodoc>GetSelectionEnd(self) -
> int
</autodoc>
38321 <method name=
"SetPrintMagnification" type=
"" overloaded=
"no">
38322 <autodoc>SetPrintMagnification(self, int magnification)
</autodoc>
38324 <param name=
"magnification" type=
"int" default=
""/>
38327 <method name=
"GetPrintMagnification" type=
"int" overloaded=
"no">
38328 <autodoc>GetPrintMagnification(self) -
> int
</autodoc>
38330 <method name=
"SetPrintColourMode" type=
"" overloaded=
"no">
38331 <autodoc>SetPrintColourMode(self, int mode)
</autodoc>
38333 <param name=
"mode" type=
"int" default=
""/>
38336 <method name=
"GetPrintColourMode" type=
"int" overloaded=
"no">
38337 <autodoc>GetPrintColourMode(self) -
> int
</autodoc>
38339 <method name=
"FindText" type=
"int" overloaded=
"no">
38340 <autodoc>FindText(self, int minPos, int maxPos, String text, int flags=
0) -
> int
</autodoc>
38342 <param name=
"minPos" type=
"int" default=
""/>
38343 <param name=
"maxPos" type=
"int" default=
""/>
38344 <param name=
"text" type=
"String" default=
""/>
38345 <param name=
"flags" type=
"int" default=
"0"/>
38348 <method name=
"FormatRange" type=
"int" overloaded=
"no">
38349 <autodoc>FormatRange(self, bool doDraw, int startPos, int endPos, DC draw, DC target,
38350 Rect renderRect, Rect pageRect) -
> int
</autodoc>
38352 <param name=
"doDraw" type=
"bool" default=
""/>
38353 <param name=
"startPos" type=
"int" default=
""/>
38354 <param name=
"endPos" type=
"int" default=
""/>
38355 <param name=
"draw" type=
"DC" default=
""/>
38356 <param name=
"target" type=
"DC" default=
""/>
38357 <param name=
"renderRect" type=
"Rect" default=
""/>
38358 <param name=
"pageRect" type=
"Rect" default=
""/>
38361 <method name=
"GetFirstVisibleLine" type=
"int" overloaded=
"no">
38362 <autodoc>GetFirstVisibleLine(self) -
> int
</autodoc>
38364 <method name=
"GetLine" type=
"String" overloaded=
"no">
38365 <autodoc>GetLine(self, int line) -
> String
</autodoc>
38367 <param name=
"line" type=
"int" default=
""/>
38370 <method name=
"GetLineCount" type=
"int" overloaded=
"no">
38371 <autodoc>GetLineCount(self) -
> int
</autodoc>
38373 <method name=
"SetMarginLeft" type=
"" overloaded=
"no">
38374 <autodoc>SetMarginLeft(self, int pixelWidth)
</autodoc>
38376 <param name=
"pixelWidth" type=
"int" default=
""/>
38379 <method name=
"GetMarginLeft" type=
"int" overloaded=
"no">
38380 <autodoc>GetMarginLeft(self) -
> int
</autodoc>
38382 <method name=
"SetMarginRight" type=
"" overloaded=
"no">
38383 <autodoc>SetMarginRight(self, int pixelWidth)
</autodoc>
38385 <param name=
"pixelWidth" type=
"int" default=
""/>
38388 <method name=
"GetMarginRight" type=
"int" overloaded=
"no">
38389 <autodoc>GetMarginRight(self) -
> int
</autodoc>
38391 <method name=
"GetModify" type=
"bool" overloaded=
"no">
38392 <autodoc>GetModify(self) -
> bool
</autodoc>
38394 <method name=
"SetSelection" type=
"" overloaded=
"no">
38395 <autodoc>SetSelection(self, int start, int end)
</autodoc>
38397 <param name=
"start" type=
"int" default=
""/>
38398 <param name=
"end" type=
"int" default=
""/>
38401 <method name=
"GetSelectedText" type=
"String" overloaded=
"no">
38402 <autodoc>GetSelectedText(self) -
> String
</autodoc>
38404 <method name=
"GetTextRange" type=
"String" overloaded=
"no">
38405 <autodoc>GetTextRange(self, int startPos, int endPos) -
> String
</autodoc>
38407 <param name=
"startPos" type=
"int" default=
""/>
38408 <param name=
"endPos" type=
"int" default=
""/>
38411 <method name=
"HideSelection" type=
"" overloaded=
"no">
38412 <autodoc>HideSelection(self, bool normal)
</autodoc>
38414 <param name=
"normal" type=
"bool" default=
""/>
38417 <method name=
"LineFromPosition" type=
"int" overloaded=
"no">
38418 <autodoc>LineFromPosition(self, int pos) -
> int
</autodoc>
38420 <param name=
"pos" type=
"int" default=
""/>
38423 <method name=
"PositionFromLine" type=
"int" overloaded=
"no">
38424 <autodoc>PositionFromLine(self, int line) -
> int
</autodoc>
38426 <param name=
"line" type=
"int" default=
""/>
38429 <method name=
"LineScroll" type=
"" overloaded=
"no">
38430 <autodoc>LineScroll(self, int columns, int lines)
</autodoc>
38432 <param name=
"columns" type=
"int" default=
""/>
38433 <param name=
"lines" type=
"int" default=
""/>
38436 <method name=
"EnsureCaretVisible" type=
"" overloaded=
"no">
38437 <autodoc>EnsureCaretVisible(self)
</autodoc>
38439 <method name=
"ReplaceSelection" type=
"" overloaded=
"no">
38440 <autodoc>ReplaceSelection(self, String text)
</autodoc>
38442 <param name=
"text" type=
"String" default=
""/>
38445 <method name=
"SetReadOnly" type=
"" overloaded=
"no">
38446 <autodoc>SetReadOnly(self, bool readOnly)
</autodoc>
38448 <param name=
"readOnly" type=
"bool" default=
""/>
38451 <method name=
"CanPaste" type=
"bool" overloaded=
"no">
38452 <autodoc>CanPaste(self) -
> bool
</autodoc>
38454 <method name=
"CanUndo" type=
"bool" overloaded=
"no">
38455 <autodoc>CanUndo(self) -
> bool
</autodoc>
38457 <method name=
"EmptyUndoBuffer" type=
"" overloaded=
"no">
38458 <autodoc>EmptyUndoBuffer(self)
</autodoc>
38460 <method name=
"Undo" type=
"" overloaded=
"no">
38461 <autodoc>Undo(self)
</autodoc>
38463 <method name=
"Cut" type=
"" overloaded=
"no">
38464 <autodoc>Cut(self)
</autodoc>
38466 <method name=
"Copy" type=
"" overloaded=
"no">
38467 <autodoc>Copy(self)
</autodoc>
38469 <method name=
"Paste" type=
"" overloaded=
"no">
38470 <autodoc>Paste(self)
</autodoc>
38472 <method name=
"Clear" type=
"" overloaded=
"no">
38473 <autodoc>Clear(self)
</autodoc>
38475 <method name=
"SetText" type=
"" overloaded=
"no">
38476 <autodoc>SetText(self, String text)
</autodoc>
38478 <param name=
"text" type=
"String" default=
""/>
38481 <method name=
"GetText" type=
"String" overloaded=
"no">
38482 <autodoc>GetText(self) -
> String
</autodoc>
38484 <method name=
"GetTextLength" type=
"int" overloaded=
"no">
38485 <autodoc>GetTextLength(self) -
> int
</autodoc>
38487 <method name=
"SetOvertype" type=
"" overloaded=
"no">
38488 <autodoc>SetOvertype(self, bool overtype)
</autodoc>
38490 <param name=
"overtype" type=
"bool" default=
""/>
38493 <method name=
"GetOvertype" type=
"bool" overloaded=
"no">
38494 <autodoc>GetOvertype(self) -
> bool
</autodoc>
38496 <method name=
"SetCaretWidth" type=
"" overloaded=
"no">
38497 <autodoc>SetCaretWidth(self, int pixelWidth)
</autodoc>
38499 <param name=
"pixelWidth" type=
"int" default=
""/>
38502 <method name=
"GetCaretWidth" type=
"int" overloaded=
"no">
38503 <autodoc>GetCaretWidth(self) -
> int
</autodoc>
38505 <method name=
"SetTargetStart" type=
"" overloaded=
"no">
38506 <autodoc>SetTargetStart(self, int pos)
</autodoc>
38508 <param name=
"pos" type=
"int" default=
""/>
38511 <method name=
"GetTargetStart" type=
"int" overloaded=
"no">
38512 <autodoc>GetTargetStart(self) -
> int
</autodoc>
38514 <method name=
"SetTargetEnd" type=
"" overloaded=
"no">
38515 <autodoc>SetTargetEnd(self, int pos)
</autodoc>
38517 <param name=
"pos" type=
"int" default=
""/>
38520 <method name=
"GetTargetEnd" type=
"int" overloaded=
"no">
38521 <autodoc>GetTargetEnd(self) -
> int
</autodoc>
38523 <method name=
"ReplaceTarget" type=
"int" overloaded=
"no">
38524 <autodoc>ReplaceTarget(self, String text) -
> int
</autodoc>
38526 <param name=
"text" type=
"String" default=
""/>
38529 <method name=
"ReplaceTargetRE" type=
"int" overloaded=
"no">
38530 <autodoc>ReplaceTargetRE(self, String text) -
> int
</autodoc>
38532 <param name=
"text" type=
"String" default=
""/>
38535 <method name=
"SearchInTarget" type=
"int" overloaded=
"no">
38536 <autodoc>SearchInTarget(self, String text) -
> int
</autodoc>
38538 <param name=
"text" type=
"String" default=
""/>
38541 <method name=
"SetSearchFlags" type=
"" overloaded=
"no">
38542 <autodoc>SetSearchFlags(self, int flags)
</autodoc>
38544 <param name=
"flags" type=
"int" default=
""/>
38547 <method name=
"GetSearchFlags" type=
"int" overloaded=
"no">
38548 <autodoc>GetSearchFlags(self) -
> int
</autodoc>
38550 <method name=
"CallTipShow" type=
"" overloaded=
"no">
38551 <autodoc>CallTipShow(self, int pos, String definition)
</autodoc>
38553 <param name=
"pos" type=
"int" default=
""/>
38554 <param name=
"definition" type=
"String" default=
""/>
38557 <method name=
"CallTipCancel" type=
"" overloaded=
"no">
38558 <autodoc>CallTipCancel(self)
</autodoc>
38560 <method name=
"CallTipActive" type=
"bool" overloaded=
"no">
38561 <autodoc>CallTipActive(self) -
> bool
</autodoc>
38563 <method name=
"CallTipPosAtStart" type=
"int" overloaded=
"no">
38564 <autodoc>CallTipPosAtStart(self) -
> int
</autodoc>
38566 <method name=
"CallTipSetHighlight" type=
"" overloaded=
"no">
38567 <autodoc>CallTipSetHighlight(self, int start, int end)
</autodoc>
38569 <param name=
"start" type=
"int" default=
""/>
38570 <param name=
"end" type=
"int" default=
""/>
38573 <method name=
"CallTipSetBackground" type=
"" overloaded=
"no">
38574 <autodoc>CallTipSetBackground(self, Colour back)
</autodoc>
38576 <param name=
"back" type=
"Colour" default=
""/>
38579 <method name=
"CallTipSetForeground" type=
"" overloaded=
"no">
38580 <autodoc>CallTipSetForeground(self, Colour fore)
</autodoc>
38582 <param name=
"fore" type=
"Colour" default=
""/>
38585 <method name=
"CallTipSetForegroundHighlight" type=
"" overloaded=
"no">
38586 <autodoc>CallTipSetForegroundHighlight(self, Colour fore)
</autodoc>
38588 <param name=
"fore" type=
"Colour" default=
""/>
38591 <method name=
"VisibleFromDocLine" type=
"int" overloaded=
"no">
38592 <autodoc>VisibleFromDocLine(self, int line) -
> int
</autodoc>
38594 <param name=
"line" type=
"int" default=
""/>
38597 <method name=
"DocLineFromVisible" type=
"int" overloaded=
"no">
38598 <autodoc>DocLineFromVisible(self, int lineDisplay) -
> int
</autodoc>
38600 <param name=
"lineDisplay" type=
"int" default=
""/>
38603 <method name=
"SetFoldLevel" type=
"" overloaded=
"no">
38604 <autodoc>SetFoldLevel(self, int line, int level)
</autodoc>
38606 <param name=
"line" type=
"int" default=
""/>
38607 <param name=
"level" type=
"int" default=
""/>
38610 <method name=
"GetFoldLevel" type=
"int" overloaded=
"no">
38611 <autodoc>GetFoldLevel(self, int line) -
> int
</autodoc>
38613 <param name=
"line" type=
"int" default=
""/>
38616 <method name=
"GetLastChild" type=
"int" overloaded=
"no">
38617 <autodoc>GetLastChild(self, int line, int level) -
> int
</autodoc>
38619 <param name=
"line" type=
"int" default=
""/>
38620 <param name=
"level" type=
"int" default=
""/>
38623 <method name=
"GetFoldParent" type=
"int" overloaded=
"no">
38624 <autodoc>GetFoldParent(self, int line) -
> int
</autodoc>
38626 <param name=
"line" type=
"int" default=
""/>
38629 <method name=
"ShowLines" type=
"" overloaded=
"no">
38630 <autodoc>ShowLines(self, int lineStart, int lineEnd)
</autodoc>
38632 <param name=
"lineStart" type=
"int" default=
""/>
38633 <param name=
"lineEnd" type=
"int" default=
""/>
38636 <method name=
"HideLines" type=
"" overloaded=
"no">
38637 <autodoc>HideLines(self, int lineStart, int lineEnd)
</autodoc>
38639 <param name=
"lineStart" type=
"int" default=
""/>
38640 <param name=
"lineEnd" type=
"int" default=
""/>
38643 <method name=
"GetLineVisible" type=
"bool" overloaded=
"no">
38644 <autodoc>GetLineVisible(self, int line) -
> bool
</autodoc>
38646 <param name=
"line" type=
"int" default=
""/>
38649 <method name=
"SetFoldExpanded" type=
"" overloaded=
"no">
38650 <autodoc>SetFoldExpanded(self, int line, bool expanded)
</autodoc>
38652 <param name=
"line" type=
"int" default=
""/>
38653 <param name=
"expanded" type=
"bool" default=
""/>
38656 <method name=
"GetFoldExpanded" type=
"bool" overloaded=
"no">
38657 <autodoc>GetFoldExpanded(self, int line) -
> bool
</autodoc>
38659 <param name=
"line" type=
"int" default=
""/>
38662 <method name=
"ToggleFold" type=
"" overloaded=
"no">
38663 <autodoc>ToggleFold(self, int line)
</autodoc>
38665 <param name=
"line" type=
"int" default=
""/>
38668 <method name=
"EnsureVisible" type=
"" overloaded=
"no">
38669 <autodoc>EnsureVisible(self, int line)
</autodoc>
38671 <param name=
"line" type=
"int" default=
""/>
38674 <method name=
"SetFoldFlags" type=
"" overloaded=
"no">
38675 <autodoc>SetFoldFlags(self, int flags)
</autodoc>
38677 <param name=
"flags" type=
"int" default=
""/>
38680 <method name=
"EnsureVisibleEnforcePolicy" type=
"" overloaded=
"no">
38681 <autodoc>EnsureVisibleEnforcePolicy(self, int line)
</autodoc>
38683 <param name=
"line" type=
"int" default=
""/>
38686 <method name=
"SetTabIndents" type=
"" overloaded=
"no">
38687 <autodoc>SetTabIndents(self, bool tabIndents)
</autodoc>
38689 <param name=
"tabIndents" type=
"bool" default=
""/>
38692 <method name=
"GetTabIndents" type=
"bool" overloaded=
"no">
38693 <autodoc>GetTabIndents(self) -
> bool
</autodoc>
38695 <method name=
"SetBackSpaceUnIndents" type=
"" overloaded=
"no">
38696 <autodoc>SetBackSpaceUnIndents(self, bool bsUnIndents)
</autodoc>
38698 <param name=
"bsUnIndents" type=
"bool" default=
""/>
38701 <method name=
"GetBackSpaceUnIndents" type=
"bool" overloaded=
"no">
38702 <autodoc>GetBackSpaceUnIndents(self) -
> bool
</autodoc>
38704 <method name=
"SetMouseDwellTime" type=
"" overloaded=
"no">
38705 <autodoc>SetMouseDwellTime(self, int periodMilliseconds)
</autodoc>
38707 <param name=
"periodMilliseconds" type=
"int" default=
""/>
38710 <method name=
"GetMouseDwellTime" type=
"int" overloaded=
"no">
38711 <autodoc>GetMouseDwellTime(self) -
> int
</autodoc>
38713 <method name=
"WordStartPosition" type=
"int" overloaded=
"no">
38714 <autodoc>WordStartPosition(self, int pos, bool onlyWordCharacters) -
> int
</autodoc>
38716 <param name=
"pos" type=
"int" default=
""/>
38717 <param name=
"onlyWordCharacters" type=
"bool" default=
""/>
38720 <method name=
"WordEndPosition" type=
"int" overloaded=
"no">
38721 <autodoc>WordEndPosition(self, int pos, bool onlyWordCharacters) -
> int
</autodoc>
38723 <param name=
"pos" type=
"int" default=
""/>
38724 <param name=
"onlyWordCharacters" type=
"bool" default=
""/>
38727 <method name=
"SetWrapMode" type=
"" overloaded=
"no">
38728 <autodoc>SetWrapMode(self, int mode)
</autodoc>
38730 <param name=
"mode" type=
"int" default=
""/>
38733 <method name=
"GetWrapMode" type=
"int" overloaded=
"no">
38734 <autodoc>GetWrapMode(self) -
> int
</autodoc>
38736 <method name=
"SetLayoutCache" type=
"" overloaded=
"no">
38737 <autodoc>SetLayoutCache(self, int mode)
</autodoc>
38739 <param name=
"mode" type=
"int" default=
""/>
38742 <method name=
"GetLayoutCache" type=
"int" overloaded=
"no">
38743 <autodoc>GetLayoutCache(self) -
> int
</autodoc>
38745 <method name=
"SetScrollWidth" type=
"" overloaded=
"no">
38746 <autodoc>SetScrollWidth(self, int pixelWidth)
</autodoc>
38748 <param name=
"pixelWidth" type=
"int" default=
""/>
38751 <method name=
"GetScrollWidth" type=
"int" overloaded=
"no">
38752 <autodoc>GetScrollWidth(self) -
> int
</autodoc>
38754 <method name=
"TextWidth" type=
"int" overloaded=
"no">
38755 <autodoc>TextWidth(self, int style, String text) -
> int
</autodoc>
38757 <param name=
"style" type=
"int" default=
""/>
38758 <param name=
"text" type=
"String" default=
""/>
38761 <method name=
"SetEndAtLastLine" type=
"" overloaded=
"no">
38762 <autodoc>SetEndAtLastLine(self, bool endAtLastLine)
</autodoc>
38764 <param name=
"endAtLastLine" type=
"bool" default=
""/>
38767 <method name=
"GetEndAtLastLine" type=
"int" overloaded=
"no">
38768 <autodoc>GetEndAtLastLine(self) -
> int
</autodoc>
38770 <method name=
"TextHeight" type=
"int" overloaded=
"no">
38771 <autodoc>TextHeight(self, int line) -
> int
</autodoc>
38773 <param name=
"line" type=
"int" default=
""/>
38776 <method name=
"SetUseVerticalScrollBar" type=
"" overloaded=
"no">
38777 <autodoc>SetUseVerticalScrollBar(self, bool show)
</autodoc>
38779 <param name=
"show" type=
"bool" default=
""/>
38782 <method name=
"GetUseVerticalScrollBar" type=
"bool" overloaded=
"no">
38783 <autodoc>GetUseVerticalScrollBar(self) -
> bool
</autodoc>
38785 <method name=
"AppendText" type=
"" overloaded=
"no">
38786 <autodoc>AppendText(self, int length, String text)
</autodoc>
38788 <param name=
"length" type=
"int" default=
""/>
38789 <param name=
"text" type=
"String" default=
""/>
38792 <method name=
"GetTwoPhaseDraw" type=
"bool" overloaded=
"no">
38793 <autodoc>GetTwoPhaseDraw(self) -
> bool
</autodoc>
38795 <method name=
"SetTwoPhaseDraw" type=
"" overloaded=
"no">
38796 <autodoc>SetTwoPhaseDraw(self, bool twoPhase)
</autodoc>
38798 <param name=
"twoPhase" type=
"bool" default=
""/>
38801 <method name=
"TargetFromSelection" type=
"" overloaded=
"no">
38802 <autodoc>TargetFromSelection(self)
</autodoc>
38804 <method name=
"LinesJoin" type=
"" overloaded=
"no">
38805 <autodoc>LinesJoin(self)
</autodoc>
38807 <method name=
"LinesSplit" type=
"" overloaded=
"no">
38808 <autodoc>LinesSplit(self, int pixelWidth)
</autodoc>
38810 <param name=
"pixelWidth" type=
"int" default=
""/>
38813 <method name=
"SetFoldMarginColour" type=
"" overloaded=
"no">
38814 <autodoc>SetFoldMarginColour(self, bool useSetting, Colour back)
</autodoc>
38816 <param name=
"useSetting" type=
"bool" default=
""/>
38817 <param name=
"back" type=
"Colour" default=
""/>
38820 <method name=
"SetFoldMarginHiColour" type=
"" overloaded=
"no">
38821 <autodoc>SetFoldMarginHiColour(self, bool useSetting, Colour fore)
</autodoc>
38823 <param name=
"useSetting" type=
"bool" default=
""/>
38824 <param name=
"fore" type=
"Colour" default=
""/>
38827 <method name=
"LineDown" type=
"" overloaded=
"no">
38828 <autodoc>LineDown(self)
</autodoc>
38829 <docstring>This is just a wrapper for ScrollLines(
1).
</docstring>
38831 <method name=
"LineDownExtend" type=
"" overloaded=
"no">
38832 <autodoc>LineDownExtend(self)
</autodoc>
38834 <method name=
"LineUp" type=
"" overloaded=
"no">
38835 <autodoc>LineUp(self)
</autodoc>
38836 <docstring>This is just a wrapper for ScrollLines(-
1).
</docstring>
38838 <method name=
"LineUpExtend" type=
"" overloaded=
"no">
38839 <autodoc>LineUpExtend(self)
</autodoc>
38841 <method name=
"CharLeft" type=
"" overloaded=
"no">
38842 <autodoc>CharLeft(self)
</autodoc>
38844 <method name=
"CharLeftExtend" type=
"" overloaded=
"no">
38845 <autodoc>CharLeftExtend(self)
</autodoc>
38847 <method name=
"CharRight" type=
"" overloaded=
"no">
38848 <autodoc>CharRight(self)
</autodoc>
38850 <method name=
"CharRightExtend" type=
"" overloaded=
"no">
38851 <autodoc>CharRightExtend(self)
</autodoc>
38853 <method name=
"WordLeft" type=
"" overloaded=
"no">
38854 <autodoc>WordLeft(self)
</autodoc>
38856 <method name=
"WordLeftExtend" type=
"" overloaded=
"no">
38857 <autodoc>WordLeftExtend(self)
</autodoc>
38859 <method name=
"WordRight" type=
"" overloaded=
"no">
38860 <autodoc>WordRight(self)
</autodoc>
38862 <method name=
"WordRightExtend" type=
"" overloaded=
"no">
38863 <autodoc>WordRightExtend(self)
</autodoc>
38865 <method name=
"Home" type=
"" overloaded=
"no">
38866 <autodoc>Home(self)
</autodoc>
38868 <method name=
"HomeExtend" type=
"" overloaded=
"no">
38869 <autodoc>HomeExtend(self)
</autodoc>
38871 <method name=
"LineEnd" type=
"" overloaded=
"no">
38872 <autodoc>LineEnd(self)
</autodoc>
38874 <method name=
"LineEndExtend" type=
"" overloaded=
"no">
38875 <autodoc>LineEndExtend(self)
</autodoc>
38877 <method name=
"DocumentStart" type=
"" overloaded=
"no">
38878 <autodoc>DocumentStart(self)
</autodoc>
38880 <method name=
"DocumentStartExtend" type=
"" overloaded=
"no">
38881 <autodoc>DocumentStartExtend(self)
</autodoc>
38883 <method name=
"DocumentEnd" type=
"" overloaded=
"no">
38884 <autodoc>DocumentEnd(self)
</autodoc>
38886 <method name=
"DocumentEndExtend" type=
"" overloaded=
"no">
38887 <autodoc>DocumentEndExtend(self)
</autodoc>
38889 <method name=
"PageUp" type=
"" overloaded=
"no">
38890 <autodoc>PageUp(self)
</autodoc>
38891 <docstring>This is just a wrapper for ScrollPages(-
1).
</docstring>
38893 <method name=
"PageUpExtend" type=
"" overloaded=
"no">
38894 <autodoc>PageUpExtend(self)
</autodoc>
38896 <method name=
"PageDown" type=
"" overloaded=
"no">
38897 <autodoc>PageDown(self)
</autodoc>
38898 <docstring>This is just a wrapper for ScrollPages(
1).
</docstring>
38900 <method name=
"PageDownExtend" type=
"" overloaded=
"no">
38901 <autodoc>PageDownExtend(self)
</autodoc>
38903 <method name=
"EditToggleOvertype" type=
"" overloaded=
"no">
38904 <autodoc>EditToggleOvertype(self)
</autodoc>
38906 <method name=
"Cancel" type=
"" overloaded=
"no">
38907 <autodoc>Cancel(self)
</autodoc>
38909 <method name=
"DeleteBack" type=
"" overloaded=
"no">
38910 <autodoc>DeleteBack(self)
</autodoc>
38912 <method name=
"Tab" type=
"" overloaded=
"no">
38913 <autodoc>Tab(self)
</autodoc>
38915 <method name=
"BackTab" type=
"" overloaded=
"no">
38916 <autodoc>BackTab(self)
</autodoc>
38918 <method name=
"NewLine" type=
"" overloaded=
"no">
38919 <autodoc>NewLine(self)
</autodoc>
38921 <method name=
"FormFeed" type=
"" overloaded=
"no">
38922 <autodoc>FormFeed(self)
</autodoc>
38924 <method name=
"VCHome" type=
"" overloaded=
"no">
38925 <autodoc>VCHome(self)
</autodoc>
38927 <method name=
"VCHomeExtend" type=
"" overloaded=
"no">
38928 <autodoc>VCHomeExtend(self)
</autodoc>
38930 <method name=
"ZoomIn" type=
"" overloaded=
"no">
38931 <autodoc>ZoomIn(self)
</autodoc>
38933 <method name=
"ZoomOut" type=
"" overloaded=
"no">
38934 <autodoc>ZoomOut(self)
</autodoc>
38936 <method name=
"DelWordLeft" type=
"" overloaded=
"no">
38937 <autodoc>DelWordLeft(self)
</autodoc>
38939 <method name=
"DelWordRight" type=
"" overloaded=
"no">
38940 <autodoc>DelWordRight(self)
</autodoc>
38942 <method name=
"LineCut" type=
"" overloaded=
"no">
38943 <autodoc>LineCut(self)
</autodoc>
38945 <method name=
"LineDelete" type=
"" overloaded=
"no">
38946 <autodoc>LineDelete(self)
</autodoc>
38948 <method name=
"LineTranspose" type=
"" overloaded=
"no">
38949 <autodoc>LineTranspose(self)
</autodoc>
38951 <method name=
"LineDuplicate" type=
"" overloaded=
"no">
38952 <autodoc>LineDuplicate(self)
</autodoc>
38954 <method name=
"LowerCase" type=
"" overloaded=
"no">
38955 <autodoc>LowerCase(self)
</autodoc>
38957 <method name=
"UpperCase" type=
"" overloaded=
"no">
38958 <autodoc>UpperCase(self)
</autodoc>
38960 <method name=
"LineScrollDown" type=
"" overloaded=
"no">
38961 <autodoc>LineScrollDown(self)
</autodoc>
38963 <method name=
"LineScrollUp" type=
"" overloaded=
"no">
38964 <autodoc>LineScrollUp(self)
</autodoc>
38966 <method name=
"DeleteBackNotLine" type=
"" overloaded=
"no">
38967 <autodoc>DeleteBackNotLine(self)
</autodoc>
38969 <method name=
"HomeDisplay" type=
"" overloaded=
"no">
38970 <autodoc>HomeDisplay(self)
</autodoc>
38972 <method name=
"HomeDisplayExtend" type=
"" overloaded=
"no">
38973 <autodoc>HomeDisplayExtend(self)
</autodoc>
38975 <method name=
"LineEndDisplay" type=
"" overloaded=
"no">
38976 <autodoc>LineEndDisplay(self)
</autodoc>
38978 <method name=
"LineEndDisplayExtend" type=
"" overloaded=
"no">
38979 <autodoc>LineEndDisplayExtend(self)
</autodoc>
38981 <method name=
"HomeWrap" type=
"" overloaded=
"no">
38982 <autodoc>HomeWrap(self)
</autodoc>
38984 <method name=
"HomeWrapExtend" type=
"" overloaded=
"no">
38985 <autodoc>HomeWrapExtend(self)
</autodoc>
38987 <method name=
"LineEndWrap" type=
"" overloaded=
"no">
38988 <autodoc>LineEndWrap(self)
</autodoc>
38990 <method name=
"LineEndWrapExtend" type=
"" overloaded=
"no">
38991 <autodoc>LineEndWrapExtend(self)
</autodoc>
38993 <method name=
"VCHomeWrap" type=
"" overloaded=
"no">
38994 <autodoc>VCHomeWrap(self)
</autodoc>
38996 <method name=
"VCHomeWrapExtend" type=
"" overloaded=
"no">
38997 <autodoc>VCHomeWrapExtend(self)
</autodoc>
38999 <method name=
"LineCopy" type=
"" overloaded=
"no">
39000 <autodoc>LineCopy(self)
</autodoc>
39002 <method name=
"MoveCaretInsideView" type=
"" overloaded=
"no">
39003 <autodoc>MoveCaretInsideView(self)
</autodoc>
39005 <method name=
"LineLength" type=
"int" overloaded=
"no">
39006 <autodoc>LineLength(self, int line) -
> int
</autodoc>
39008 <param name=
"line" type=
"int" default=
""/>
39011 <method name=
"BraceHighlight" type=
"" overloaded=
"no">
39012 <autodoc>BraceHighlight(self, int pos1, int pos2)
</autodoc>
39014 <param name=
"pos1" type=
"int" default=
""/>
39015 <param name=
"pos2" type=
"int" default=
""/>
39018 <method name=
"BraceBadLight" type=
"" overloaded=
"no">
39019 <autodoc>BraceBadLight(self, int pos)
</autodoc>
39021 <param name=
"pos" type=
"int" default=
""/>
39024 <method name=
"BraceMatch" type=
"int" overloaded=
"no">
39025 <autodoc>BraceMatch(self, int pos) -
> int
</autodoc>
39027 <param name=
"pos" type=
"int" default=
""/>
39030 <method name=
"GetViewEOL" type=
"bool" overloaded=
"no">
39031 <autodoc>GetViewEOL(self) -
> bool
</autodoc>
39033 <method name=
"SetViewEOL" type=
"" overloaded=
"no">
39034 <autodoc>SetViewEOL(self, bool visible)
</autodoc>
39036 <param name=
"visible" type=
"bool" default=
""/>
39039 <method name=
"GetDocPointer" type=
"" overloaded=
"no">
39040 <autodoc>GetDocPointer(self) -
> void
</autodoc>
39042 <method name=
"SetDocPointer" type=
"" overloaded=
"no">
39043 <autodoc>SetDocPointer(self, void docPointer)
</autodoc>
39045 <param name=
"docPointer" type=
"" default=
""/>
39048 <method name=
"SetModEventMask" type=
"" overloaded=
"no">
39049 <autodoc>SetModEventMask(self, int mask)
</autodoc>
39051 <param name=
"mask" type=
"int" default=
""/>
39054 <method name=
"GetEdgeColumn" type=
"int" overloaded=
"no">
39055 <autodoc>GetEdgeColumn(self) -
> int
</autodoc>
39057 <method name=
"SetEdgeColumn" type=
"" overloaded=
"no">
39058 <autodoc>SetEdgeColumn(self, int column)
</autodoc>
39060 <param name=
"column" type=
"int" default=
""/>
39063 <method name=
"GetEdgeMode" type=
"int" overloaded=
"no">
39064 <autodoc>GetEdgeMode(self) -
> int
</autodoc>
39066 <method name=
"SetEdgeMode" type=
"" overloaded=
"no">
39067 <autodoc>SetEdgeMode(self, int mode)
</autodoc>
39069 <param name=
"mode" type=
"int" default=
""/>
39072 <method name=
"GetEdgeColour" type=
"Colour" overloaded=
"no">
39073 <autodoc>GetEdgeColour(self) -
> Colour
</autodoc>
39075 <method name=
"SetEdgeColour" type=
"" overloaded=
"no">
39076 <autodoc>SetEdgeColour(self, Colour edgeColour)
</autodoc>
39078 <param name=
"edgeColour" type=
"Colour" default=
""/>
39081 <method name=
"SearchAnchor" type=
"" overloaded=
"no">
39082 <autodoc>SearchAnchor(self)
</autodoc>
39084 <method name=
"SearchNext" type=
"int" overloaded=
"no">
39085 <autodoc>SearchNext(self, int flags, String text) -
> int
</autodoc>
39087 <param name=
"flags" type=
"int" default=
""/>
39088 <param name=
"text" type=
"String" default=
""/>
39091 <method name=
"SearchPrev" type=
"int" overloaded=
"no">
39092 <autodoc>SearchPrev(self, int flags, String text) -
> int
</autodoc>
39094 <param name=
"flags" type=
"int" default=
""/>
39095 <param name=
"text" type=
"String" default=
""/>
39098 <method name=
"LinesOnScreen" type=
"int" overloaded=
"no">
39099 <autodoc>LinesOnScreen(self) -
> int
</autodoc>
39101 <method name=
"UsePopUp" type=
"" overloaded=
"no">
39102 <autodoc>UsePopUp(self, bool allowPopUp)
</autodoc>
39104 <param name=
"allowPopUp" type=
"bool" default=
""/>
39107 <method name=
"SelectionIsRectangle" type=
"bool" overloaded=
"no">
39108 <autodoc>SelectionIsRectangle(self) -
> bool
</autodoc>
39110 <method name=
"SetZoom" type=
"" overloaded=
"no">
39111 <autodoc>SetZoom(self, int zoom)
</autodoc>
39113 <param name=
"zoom" type=
"int" default=
""/>
39116 <method name=
"GetZoom" type=
"int" overloaded=
"no">
39117 <autodoc>GetZoom(self) -
> int
</autodoc>
39119 <method name=
"CreateDocument" type=
"" overloaded=
"no">
39120 <autodoc>CreateDocument(self) -
> void
</autodoc>
39122 <method name=
"AddRefDocument" type=
"" overloaded=
"no">
39123 <autodoc>AddRefDocument(self, void docPointer)
</autodoc>
39125 <param name=
"docPointer" type=
"" default=
""/>
39128 <method name=
"ReleaseDocument" type=
"" overloaded=
"no">
39129 <autodoc>ReleaseDocument(self, void docPointer)
</autodoc>
39131 <param name=
"docPointer" type=
"" default=
""/>
39134 <method name=
"GetModEventMask" type=
"int" overloaded=
"no">
39135 <autodoc>GetModEventMask(self) -
> int
</autodoc>
39137 <method name=
"SetSTCFocus" type=
"" overloaded=
"no">
39138 <autodoc>SetSTCFocus(self, bool focus)
</autodoc>
39140 <param name=
"focus" type=
"bool" default=
""/>
39143 <method name=
"GetSTCFocus" type=
"bool" overloaded=
"no">
39144 <autodoc>GetSTCFocus(self) -
> bool
</autodoc>
39146 <method name=
"SetStatus" type=
"" overloaded=
"no">
39147 <autodoc>SetStatus(self, int statusCode)
</autodoc>
39149 <param name=
"statusCode" type=
"int" default=
""/>
39152 <method name=
"GetStatus" type=
"int" overloaded=
"no">
39153 <autodoc>GetStatus(self) -
> int
</autodoc>
39155 <method name=
"SetMouseDownCaptures" type=
"" overloaded=
"no">
39156 <autodoc>SetMouseDownCaptures(self, bool captures)
</autodoc>
39158 <param name=
"captures" type=
"bool" default=
""/>
39161 <method name=
"GetMouseDownCaptures" type=
"bool" overloaded=
"no">
39162 <autodoc>GetMouseDownCaptures(self) -
> bool
</autodoc>
39164 <method name=
"SetSTCCursor" type=
"" overloaded=
"no">
39165 <autodoc>SetSTCCursor(self, int cursorType)
</autodoc>
39167 <param name=
"cursorType" type=
"int" default=
""/>
39170 <method name=
"GetSTCCursor" type=
"int" overloaded=
"no">
39171 <autodoc>GetSTCCursor(self) -
> int
</autodoc>
39173 <method name=
"SetControlCharSymbol" type=
"" overloaded=
"no">
39174 <autodoc>SetControlCharSymbol(self, int symbol)
</autodoc>
39176 <param name=
"symbol" type=
"int" default=
""/>
39179 <method name=
"GetControlCharSymbol" type=
"int" overloaded=
"no">
39180 <autodoc>GetControlCharSymbol(self) -
> int
</autodoc>
39182 <method name=
"WordPartLeft" type=
"" overloaded=
"no">
39183 <autodoc>WordPartLeft(self)
</autodoc>
39185 <method name=
"WordPartLeftExtend" type=
"" overloaded=
"no">
39186 <autodoc>WordPartLeftExtend(self)
</autodoc>
39188 <method name=
"WordPartRight" type=
"" overloaded=
"no">
39189 <autodoc>WordPartRight(self)
</autodoc>
39191 <method name=
"WordPartRightExtend" type=
"" overloaded=
"no">
39192 <autodoc>WordPartRightExtend(self)
</autodoc>
39194 <method name=
"SetVisiblePolicy" type=
"" overloaded=
"no">
39195 <autodoc>SetVisiblePolicy(self, int visiblePolicy, int visibleSlop)
</autodoc>
39197 <param name=
"visiblePolicy" type=
"int" default=
""/>
39198 <param name=
"visibleSlop" type=
"int" default=
""/>
39201 <method name=
"DelLineLeft" type=
"" overloaded=
"no">
39202 <autodoc>DelLineLeft(self)
</autodoc>
39204 <method name=
"DelLineRight" type=
"" overloaded=
"no">
39205 <autodoc>DelLineRight(self)
</autodoc>
39207 <method name=
"SetXOffset" type=
"" overloaded=
"no">
39208 <autodoc>SetXOffset(self, int newOffset)
</autodoc>
39210 <param name=
"newOffset" type=
"int" default=
""/>
39213 <method name=
"GetXOffset" type=
"int" overloaded=
"no">
39214 <autodoc>GetXOffset(self) -
> int
</autodoc>
39216 <method name=
"ChooseCaretX" type=
"" overloaded=
"no">
39217 <autodoc>ChooseCaretX(self)
</autodoc>
39219 <method name=
"SetXCaretPolicy" type=
"" overloaded=
"no">
39220 <autodoc>SetXCaretPolicy(self, int caretPolicy, int caretSlop)
</autodoc>
39222 <param name=
"caretPolicy" type=
"int" default=
""/>
39223 <param name=
"caretSlop" type=
"int" default=
""/>
39226 <method name=
"SetYCaretPolicy" type=
"" overloaded=
"no">
39227 <autodoc>SetYCaretPolicy(self, int caretPolicy, int caretSlop)
</autodoc>
39229 <param name=
"caretPolicy" type=
"int" default=
""/>
39230 <param name=
"caretSlop" type=
"int" default=
""/>
39233 <method name=
"SetPrintWrapMode" type=
"" overloaded=
"no">
39234 <autodoc>SetPrintWrapMode(self, int mode)
</autodoc>
39236 <param name=
"mode" type=
"int" default=
""/>
39239 <method name=
"GetPrintWrapMode" type=
"int" overloaded=
"no">
39240 <autodoc>GetPrintWrapMode(self) -
> int
</autodoc>
39242 <method name=
"SetHotspotActiveForeground" type=
"" overloaded=
"no">
39243 <autodoc>SetHotspotActiveForeground(self, bool useSetting, Colour fore)
</autodoc>
39245 <param name=
"useSetting" type=
"bool" default=
""/>
39246 <param name=
"fore" type=
"Colour" default=
""/>
39249 <method name=
"SetHotspotActiveBackground" type=
"" overloaded=
"no">
39250 <autodoc>SetHotspotActiveBackground(self, bool useSetting, Colour back)
</autodoc>
39252 <param name=
"useSetting" type=
"bool" default=
""/>
39253 <param name=
"back" type=
"Colour" default=
""/>
39256 <method name=
"SetHotspotActiveUnderline" type=
"" overloaded=
"no">
39257 <autodoc>SetHotspotActiveUnderline(self, bool underline)
</autodoc>
39259 <param name=
"underline" type=
"bool" default=
""/>
39262 <method name=
"SetHotspotSingleLine" type=
"" overloaded=
"no">
39263 <autodoc>SetHotspotSingleLine(self, bool singleLine)
</autodoc>
39265 <param name=
"singleLine" type=
"bool" default=
""/>
39268 <method name=
"ParaDown" type=
"" overloaded=
"no">
39269 <autodoc>ParaDown(self)
</autodoc>
39271 <method name=
"ParaDownExtend" type=
"" overloaded=
"no">
39272 <autodoc>ParaDownExtend(self)
</autodoc>
39274 <method name=
"ParaUp" type=
"" overloaded=
"no">
39275 <autodoc>ParaUp(self)
</autodoc>
39277 <method name=
"ParaUpExtend" type=
"" overloaded=
"no">
39278 <autodoc>ParaUpExtend(self)
</autodoc>
39280 <method name=
"PositionBefore" type=
"int" overloaded=
"no">
39281 <autodoc>PositionBefore(self, int pos) -
> int
</autodoc>
39283 <param name=
"pos" type=
"int" default=
""/>
39286 <method name=
"PositionAfter" type=
"int" overloaded=
"no">
39287 <autodoc>PositionAfter(self, int pos) -
> int
</autodoc>
39289 <param name=
"pos" type=
"int" default=
""/>
39292 <method name=
"CopyRange" type=
"" overloaded=
"no">
39293 <autodoc>CopyRange(self, int start, int end)
</autodoc>
39295 <param name=
"start" type=
"int" default=
""/>
39296 <param name=
"end" type=
"int" default=
""/>
39299 <method name=
"CopyText" type=
"" overloaded=
"no">
39300 <autodoc>CopyText(self, int length, String text)
</autodoc>
39302 <param name=
"length" type=
"int" default=
""/>
39303 <param name=
"text" type=
"String" default=
""/>
39306 <method name=
"SetSelectionMode" type=
"" overloaded=
"no">
39307 <autodoc>SetSelectionMode(self, int mode)
</autodoc>
39309 <param name=
"mode" type=
"int" default=
""/>
39312 <method name=
"GetSelectionMode" type=
"int" overloaded=
"no">
39313 <autodoc>GetSelectionMode(self) -
> int
</autodoc>
39315 <method name=
"GetLineSelStartPosition" type=
"int" overloaded=
"no">
39316 <autodoc>GetLineSelStartPosition(self, int line) -
> int
</autodoc>
39318 <param name=
"line" type=
"int" default=
""/>
39321 <method name=
"GetLineSelEndPosition" type=
"int" overloaded=
"no">
39322 <autodoc>GetLineSelEndPosition(self, int line) -
> int
</autodoc>
39324 <param name=
"line" type=
"int" default=
""/>
39327 <method name=
"LineDownRectExtend" type=
"" overloaded=
"no">
39328 <autodoc>LineDownRectExtend(self)
</autodoc>
39330 <method name=
"LineUpRectExtend" type=
"" overloaded=
"no">
39331 <autodoc>LineUpRectExtend(self)
</autodoc>
39333 <method name=
"CharLeftRectExtend" type=
"" overloaded=
"no">
39334 <autodoc>CharLeftRectExtend(self)
</autodoc>
39336 <method name=
"CharRightRectExtend" type=
"" overloaded=
"no">
39337 <autodoc>CharRightRectExtend(self)
</autodoc>
39339 <method name=
"HomeRectExtend" type=
"" overloaded=
"no">
39340 <autodoc>HomeRectExtend(self)
</autodoc>
39342 <method name=
"VCHomeRectExtend" type=
"" overloaded=
"no">
39343 <autodoc>VCHomeRectExtend(self)
</autodoc>
39345 <method name=
"LineEndRectExtend" type=
"" overloaded=
"no">
39346 <autodoc>LineEndRectExtend(self)
</autodoc>
39348 <method name=
"PageUpRectExtend" type=
"" overloaded=
"no">
39349 <autodoc>PageUpRectExtend(self)
</autodoc>
39351 <method name=
"PageDownRectExtend" type=
"" overloaded=
"no">
39352 <autodoc>PageDownRectExtend(self)
</autodoc>
39354 <method name=
"StutteredPageUp" type=
"" overloaded=
"no">
39355 <autodoc>StutteredPageUp(self)
</autodoc>
39357 <method name=
"StutteredPageUpExtend" type=
"" overloaded=
"no">
39358 <autodoc>StutteredPageUpExtend(self)
</autodoc>
39360 <method name=
"StutteredPageDown" type=
"" overloaded=
"no">
39361 <autodoc>StutteredPageDown(self)
</autodoc>
39363 <method name=
"StutteredPageDownExtend" type=
"" overloaded=
"no">
39364 <autodoc>StutteredPageDownExtend(self)
</autodoc>
39366 <method name=
"WordLeftEnd" type=
"" overloaded=
"no">
39367 <autodoc>WordLeftEnd(self)
</autodoc>
39369 <method name=
"WordLeftEndExtend" type=
"" overloaded=
"no">
39370 <autodoc>WordLeftEndExtend(self)
</autodoc>
39372 <method name=
"WordRightEnd" type=
"" overloaded=
"no">
39373 <autodoc>WordRightEnd(self)
</autodoc>
39375 <method name=
"WordRightEndExtend" type=
"" overloaded=
"no">
39376 <autodoc>WordRightEndExtend(self)
</autodoc>
39378 <method name=
"SetWhitespaceChars" type=
"" overloaded=
"no">
39379 <autodoc>SetWhitespaceChars(self, String characters)
</autodoc>
39381 <param name=
"characters" type=
"String" default=
""/>
39384 <method name=
"SetCharsDefault" type=
"" overloaded=
"no">
39385 <autodoc>SetCharsDefault(self)
</autodoc>
39387 <method name=
"AutoCompGetCurrent" type=
"int" overloaded=
"no">
39388 <autodoc>AutoCompGetCurrent(self) -
> int
</autodoc>
39390 <method name=
"StartRecord" type=
"" overloaded=
"no">
39391 <autodoc>StartRecord(self)
</autodoc>
39393 <method name=
"StopRecord" type=
"" overloaded=
"no">
39394 <autodoc>StopRecord(self)
</autodoc>
39396 <method name=
"SetLexer" type=
"" overloaded=
"no">
39397 <autodoc>SetLexer(self, int lexer)
</autodoc>
39399 <param name=
"lexer" type=
"int" default=
""/>
39402 <method name=
"GetLexer" type=
"int" overloaded=
"no">
39403 <autodoc>GetLexer(self) -
> int
</autodoc>
39405 <method name=
"Colourise" type=
"" overloaded=
"no">
39406 <autodoc>Colourise(self, int start, int end)
</autodoc>
39408 <param name=
"start" type=
"int" default=
""/>
39409 <param name=
"end" type=
"int" default=
""/>
39412 <method name=
"SetProperty" type=
"" overloaded=
"no">
39413 <autodoc>SetProperty(self, String key, String value)
</autodoc>
39415 <param name=
"key" type=
"String" default=
""/>
39416 <param name=
"value" type=
"String" default=
""/>
39419 <method name=
"SetKeyWords" type=
"" overloaded=
"no">
39420 <autodoc>SetKeyWords(self, int keywordSet, String keyWords)
</autodoc>
39422 <param name=
"keywordSet" type=
"int" default=
""/>
39423 <param name=
"keyWords" type=
"String" default=
""/>
39426 <method name=
"SetLexerLanguage" type=
"" overloaded=
"no">
39427 <autodoc>SetLexerLanguage(self, String language)
</autodoc>
39429 <param name=
"language" type=
"String" default=
""/>
39432 <method name=
"GetCurrentLine" type=
"int" overloaded=
"no">
39433 <autodoc>GetCurrentLine(self) -
> int
</autodoc>
39435 <method name=
"StyleSetSpec" type=
"" overloaded=
"no">
39436 <autodoc>StyleSetSpec(self, int styleNum, String spec)
</autodoc>
39438 <param name=
"styleNum" type=
"int" default=
""/>
39439 <param name=
"spec" type=
"String" default=
""/>
39442 <method name=
"StyleSetFont" type=
"" overloaded=
"no">
39443 <autodoc>StyleSetFont(self, int styleNum, Font font)
</autodoc>
39445 <param name=
"styleNum" type=
"int" default=
""/>
39446 <param name=
"font" type=
"Font" default=
""/>
39449 <method name=
"StyleSetFontAttr" type=
"" overloaded=
"no">
39450 <autodoc>StyleSetFontAttr(self, int styleNum, int size, String faceName, bool bold,
39451 bool italic, bool underline)
</autodoc>
39453 <param name=
"styleNum" type=
"int" default=
""/>
39454 <param name=
"size" type=
"int" default=
""/>
39455 <param name=
"faceName" type=
"String" default=
""/>
39456 <param name=
"bold" type=
"bool" default=
""/>
39457 <param name=
"italic" type=
"bool" default=
""/>
39458 <param name=
"underline" type=
"bool" default=
""/>
39461 <method name=
"CmdKeyExecute" type=
"" overloaded=
"no">
39462 <autodoc>CmdKeyExecute(self, int cmd)
</autodoc>
39464 <param name=
"cmd" type=
"int" default=
""/>
39467 <method name=
"SetMargins" type=
"" overloaded=
"no">
39468 <autodoc>SetMargins(self, int left, int right)
</autodoc>
39470 <param name=
"left" type=
"int" default=
""/>
39471 <param name=
"right" type=
"int" default=
""/>
39474 <method name=
"GetSelection" type=
"" overloaded=
"no">
39475 <autodoc>GetSelection(self, int OUTPUT, int OUTPUT)
</autodoc>
39477 <param name=
"OUTPUT" type=
"int" default=
""/>
39478 <param name=
"OUTPUT" type=
"int" default=
""/>
39481 <method name=
"PointFromPosition" type=
"Point" overloaded=
"no">
39482 <autodoc>PointFromPosition(self, int pos) -
> Point
</autodoc>
39484 <param name=
"pos" type=
"int" default=
""/>
39487 <method name=
"ScrollToLine" type=
"" overloaded=
"no">
39488 <autodoc>ScrollToLine(self, int line)
</autodoc>
39490 <param name=
"line" type=
"int" default=
""/>
39493 <method name=
"ScrollToColumn" type=
"" overloaded=
"no">
39494 <autodoc>ScrollToColumn(self, int column)
</autodoc>
39496 <param name=
"column" type=
"int" default=
""/>
39499 <method name=
"SendMsg" type=
"long" overloaded=
"no">
39500 <autodoc>SendMsg(self, int msg, long wp=
0, long lp=
0) -
> long
</autodoc>
39502 <param name=
"msg" type=
"int" default=
""/>
39503 <param name=
"wp" type=
"long" default=
"0"/>
39504 <param name=
"lp" type=
"long" default=
"0"/>
39507 <method name=
"SetVScrollBar" type=
"" overloaded=
"no">
39508 <autodoc>SetVScrollBar(self, wxScrollBar bar)
</autodoc>
39510 <param name=
"bar" type=
"ScrollBar" default=
""/>
39513 <method name=
"SetHScrollBar" type=
"" overloaded=
"no">
39514 <autodoc>SetHScrollBar(self, wxScrollBar bar)
</autodoc>
39516 <param name=
"bar" type=
"ScrollBar" default=
""/>
39519 <method name=
"GetLastKeydownProcessed" type=
"bool" overloaded=
"no">
39520 <autodoc>GetLastKeydownProcessed(self) -
> bool
</autodoc>
39522 <method name=
"SetLastKeydownProcessed" type=
"" overloaded=
"no">
39523 <autodoc>SetLastKeydownProcessed(self, bool val)
</autodoc>
39525 <param name=
"val" type=
"bool" default=
""/>
39528 <method name=
"SaveFile" type=
"bool" overloaded=
"no">
39529 <autodoc>SaveFile(self, String filename) -
> bool
</autodoc>
39531 <param name=
"filename" type=
"String" default=
""/>
39534 <method name=
"LoadFile" type=
"bool" overloaded=
"no">
39535 <autodoc>LoadFile(self, String filename) -
> bool
</autodoc>
39537 <param name=
"filename" type=
"String" default=
""/>
39540 <method name=
"DoDragOver" type=
"wxDragResult" overloaded=
"no">
39541 <autodoc>DoDragOver(self, int x, int y, int def) -
> int
</autodoc>
39543 <param name=
"x" type=
"int" default=
""/>
39544 <param name=
"y" type=
"int" default=
""/>
39545 <param name=
"def" type=
"wxDragResult" default=
""/>
39548 <method name=
"DoDropText" type=
"bool" overloaded=
"no">
39549 <autodoc>DoDropText(self, long x, long y, String data) -
> bool
</autodoc>
39551 <param name=
"x" type=
"long" default=
""/>
39552 <param name=
"y" type=
"long" default=
""/>
39553 <param name=
"data" type=
"String" default=
""/>
39556 <method name=
"SetUseAntiAliasing" type=
"" overloaded=
"no">
39557 <autodoc>SetUseAntiAliasing(self, bool useAA)
</autodoc>
39559 <param name=
"useAA" type=
"bool" default=
""/>
39562 <method name=
"GetUseAntiAliasing" type=
"bool" overloaded=
"no">
39563 <autodoc>GetUseAntiAliasing(self) -
> bool
</autodoc>
39566 <class name=
"StyledTextEvent" oldname=
"wxStyledTextEvent" module=
"stc">
39567 <baseclass name=
"CommandEvent"/>
39568 <constructor name=
"StyledTextEvent" overloaded=
"no">
39569 <autodoc>__init__(self, wxEventType commandType=
0, int id=
0) -
> StyledTextEvent
</autodoc>
39571 <param name=
"commandType" type=
"wxEventType" default=
"0"/>
39572 <param name=
"id" type=
"int" default=
"0"/>
39575 <destructor name=
"~wxStyledTextEvent" overloaded=
"no">
39576 <autodoc>__del__(self)
</autodoc>
39578 <method name=
"SetPosition" type=
"" overloaded=
"no">
39579 <autodoc>SetPosition(self, int pos)
</autodoc>
39581 <param name=
"pos" type=
"int" default=
""/>
39584 <method name=
"SetKey" type=
"" overloaded=
"no">
39585 <autodoc>SetKey(self, int k)
</autodoc>
39587 <param name=
"k" type=
"int" default=
""/>
39590 <method name=
"SetModifiers" type=
"" overloaded=
"no">
39591 <autodoc>SetModifiers(self, int m)
</autodoc>
39593 <param name=
"m" type=
"int" default=
""/>
39596 <method name=
"SetModificationType" type=
"" overloaded=
"no">
39597 <autodoc>SetModificationType(self, int t)
</autodoc>
39599 <param name=
"t" type=
"int" default=
""/>
39602 <method name=
"SetText" type=
"" overloaded=
"no">
39603 <autodoc>SetText(self, String t)
</autodoc>
39605 <param name=
"t" type=
"String" default=
""/>
39608 <method name=
"SetLength" type=
"" overloaded=
"no">
39609 <autodoc>SetLength(self, int len)
</autodoc>
39611 <param name=
"len" type=
"int" default=
""/>
39614 <method name=
"SetLinesAdded" type=
"" overloaded=
"no">
39615 <autodoc>SetLinesAdded(self, int num)
</autodoc>
39617 <param name=
"num" type=
"int" default=
""/>
39620 <method name=
"SetLine" type=
"" overloaded=
"no">
39621 <autodoc>SetLine(self, int val)
</autodoc>
39623 <param name=
"val" type=
"int" default=
""/>
39626 <method name=
"SetFoldLevelNow" type=
"" overloaded=
"no">
39627 <autodoc>SetFoldLevelNow(self, int val)
</autodoc>
39629 <param name=
"val" type=
"int" default=
""/>
39632 <method name=
"SetFoldLevelPrev" type=
"" overloaded=
"no">
39633 <autodoc>SetFoldLevelPrev(self, int val)
</autodoc>
39635 <param name=
"val" type=
"int" default=
""/>
39638 <method name=
"SetMargin" type=
"" overloaded=
"no">
39639 <autodoc>SetMargin(self, int val)
</autodoc>
39641 <param name=
"val" type=
"int" default=
""/>
39644 <method name=
"SetMessage" type=
"" overloaded=
"no">
39645 <autodoc>SetMessage(self, int val)
</autodoc>
39647 <param name=
"val" type=
"int" default=
""/>
39650 <method name=
"SetWParam" type=
"" overloaded=
"no">
39651 <autodoc>SetWParam(self, int val)
</autodoc>
39653 <param name=
"val" type=
"int" default=
""/>
39656 <method name=
"SetLParam" type=
"" overloaded=
"no">
39657 <autodoc>SetLParam(self, int val)
</autodoc>
39659 <param name=
"val" type=
"int" default=
""/>
39662 <method name=
"SetListType" type=
"" overloaded=
"no">
39663 <autodoc>SetListType(self, int val)
</autodoc>
39665 <param name=
"val" type=
"int" default=
""/>
39668 <method name=
"SetX" type=
"" overloaded=
"no">
39669 <autodoc>SetX(self, int val)
</autodoc>
39671 <param name=
"val" type=
"int" default=
""/>
39674 <method name=
"SetY" type=
"" overloaded=
"no">
39675 <autodoc>SetY(self, int val)
</autodoc>
39677 <param name=
"val" type=
"int" default=
""/>
39680 <method name=
"SetDragText" type=
"" overloaded=
"no">
39681 <autodoc>SetDragText(self, String val)
</autodoc>
39683 <param name=
"val" type=
"String" default=
""/>
39686 <method name=
"SetDragAllowMove" type=
"" overloaded=
"no">
39687 <autodoc>SetDragAllowMove(self, bool val)
</autodoc>
39689 <param name=
"val" type=
"bool" default=
""/>
39692 <method name=
"SetDragResult" type=
"" overloaded=
"no">
39693 <autodoc>SetDragResult(self, int val)
</autodoc>
39695 <param name=
"val" type=
"wxDragResult" default=
""/>
39698 <method name=
"GetPosition" type=
"int" overloaded=
"no">
39699 <autodoc>GetPosition(self) -
> int
</autodoc>
39701 <method name=
"GetKey" type=
"int" overloaded=
"no">
39702 <autodoc>GetKey(self) -
> int
</autodoc>
39704 <method name=
"GetModifiers" type=
"int" overloaded=
"no">
39705 <autodoc>GetModifiers(self) -
> int
</autodoc>
39707 <method name=
"GetModificationType" type=
"int" overloaded=
"no">
39708 <autodoc>GetModificationType(self) -
> int
</autodoc>
39710 <method name=
"GetText" type=
"String" overloaded=
"no">
39711 <autodoc>GetText(self) -
> String
</autodoc>
39713 <method name=
"GetLength" type=
"int" overloaded=
"no">
39714 <autodoc>GetLength(self) -
> int
</autodoc>
39716 <method name=
"GetLinesAdded" type=
"int" overloaded=
"no">
39717 <autodoc>GetLinesAdded(self) -
> int
</autodoc>
39719 <method name=
"GetLine" type=
"int" overloaded=
"no">
39720 <autodoc>GetLine(self) -
> int
</autodoc>
39722 <method name=
"GetFoldLevelNow" type=
"int" overloaded=
"no">
39723 <autodoc>GetFoldLevelNow(self) -
> int
</autodoc>
39725 <method name=
"GetFoldLevelPrev" type=
"int" overloaded=
"no">
39726 <autodoc>GetFoldLevelPrev(self) -
> int
</autodoc>
39728 <method name=
"GetMargin" type=
"int" overloaded=
"no">
39729 <autodoc>GetMargin(self) -
> int
</autodoc>
39731 <method name=
"GetMessage" type=
"int" overloaded=
"no">
39732 <autodoc>GetMessage(self) -
> int
</autodoc>
39734 <method name=
"GetWParam" type=
"int" overloaded=
"no">
39735 <autodoc>GetWParam(self) -
> int
</autodoc>
39737 <method name=
"GetLParam" type=
"int" overloaded=
"no">
39738 <autodoc>GetLParam(self) -
> int
</autodoc>
39740 <method name=
"GetListType" type=
"int" overloaded=
"no">
39741 <autodoc>GetListType(self) -
> int
</autodoc>
39743 <method name=
"GetX" type=
"int" overloaded=
"no">
39744 <autodoc>GetX(self) -
> int
</autodoc>
39746 <method name=
"GetY" type=
"int" overloaded=
"no">
39747 <autodoc>GetY(self) -
> int
</autodoc>
39749 <method name=
"GetDragText" type=
"String" overloaded=
"no">
39750 <autodoc>GetDragText(self) -
> String
</autodoc>
39752 <method name=
"GetDragAllowMove" type=
"bool" overloaded=
"no">
39753 <autodoc>GetDragAllowMove(self) -
> bool
</autodoc>
39755 <method name=
"GetDragResult" type=
"wxDragResult" overloaded=
"no">
39756 <autodoc>GetDragResult(self) -
> int
</autodoc>
39758 <method name=
"GetShift" type=
"bool" overloaded=
"no">
39759 <autodoc>GetShift(self) -
> bool
</autodoc>
39761 <method name=
"GetControl" type=
"bool" overloaded=
"no">
39762 <autodoc>GetControl(self) -
> bool
</autodoc>
39764 <method name=
"GetAlt" type=
"bool" overloaded=
"no">
39765 <autodoc>GetAlt(self) -
> bool
</autodoc>
39767 <method name=
"Clone" type=
"Event" overloaded=
"no">
39768 <autodoc>Clone(self) -
> Event
</autodoc>
39772 EVT_STC_CHANGE = wx.PyEventBinder( wxEVT_STC_CHANGE,
1 )
39773 EVT_STC_STYLENEEDED = wx.PyEventBinder( wxEVT_STC_STYLENEEDED,
1 )
39774 EVT_STC_CHARADDED = wx.PyEventBinder( wxEVT_STC_CHARADDED,
1 )
39775 EVT_STC_SAVEPOINTREACHED = wx.PyEventBinder( wxEVT_STC_SAVEPOINTREACHED,
1 )
39776 EVT_STC_SAVEPOINTLEFT = wx.PyEventBinder( wxEVT_STC_SAVEPOINTLEFT,
1 )
39777 EVT_STC_ROMODIFYATTEMPT = wx.PyEventBinder( wxEVT_STC_ROMODIFYATTEMPT,
1 )
39778 EVT_STC_KEY = wx.PyEventBinder( wxEVT_STC_KEY,
1 )
39779 EVT_STC_DOUBLECLICK = wx.PyEventBinder( wxEVT_STC_DOUBLECLICK,
1 )
39780 EVT_STC_UPDATEUI = wx.PyEventBinder( wxEVT_STC_UPDATEUI,
1 )
39781 EVT_STC_MODIFIED = wx.PyEventBinder( wxEVT_STC_MODIFIED,
1 )
39782 EVT_STC_MACRORECORD = wx.PyEventBinder( wxEVT_STC_MACRORECORD,
1 )
39783 EVT_STC_MARGINCLICK = wx.PyEventBinder( wxEVT_STC_MARGINCLICK,
1 )
39784 EVT_STC_NEEDSHOWN = wx.PyEventBinder( wxEVT_STC_NEEDSHOWN,
1 )
39785 EVT_STC_PAINTED = wx.PyEventBinder( wxEVT_STC_PAINTED,
1 )
39786 EVT_STC_USERLISTSELECTION = wx.PyEventBinder( wxEVT_STC_USERLISTSELECTION,
1 )
39787 EVT_STC_URIDROPPED = wx.PyEventBinder( wxEVT_STC_URIDROPPED,
1 )
39788 EVT_STC_DWELLSTART = wx.PyEventBinder( wxEVT_STC_DWELLSTART,
1 )
39789 EVT_STC_DWELLEND = wx.PyEventBinder( wxEVT_STC_DWELLEND,
1 )
39790 EVT_STC_START_DRAG = wx.PyEventBinder( wxEVT_STC_START_DRAG,
1 )
39791 EVT_STC_DRAG_OVER = wx.PyEventBinder( wxEVT_STC_DRAG_OVER,
1 )
39792 EVT_STC_DO_DROP = wx.PyEventBinder( wxEVT_STC_DO_DROP,
1 )
39793 EVT_STC_ZOOM = wx.PyEventBinder( wxEVT_STC_ZOOM,
1 )
39794 EVT_STC_HOTSPOT_CLICK = wx.PyEventBinder( wxEVT_STC_HOTSPOT_CLICK,
1 )
39795 EVT_STC_HOTSPOT_DCLICK = wx.PyEventBinder( wxEVT_STC_HOTSPOT_DCLICK,
1 )
39796 EVT_STC_CALLTIP_CLICK = wx.PyEventBinder( wxEVT_STC_CALLTIP_CLICK,
1 )
39799 <module name=
"xrc">
39800 <import name=
"_core"/>
39801 <pythoncode> wx = _core
</pythoncode>
39802 <pythoncode> __docfilter__ = wx.__DocFilter(globals())
</pythoncode>
39804 #---------------------------------------------------------------------------
39806 <class name=
"XmlResource" oldname=
"wxXmlResource" module=
"xrc">
39807 <baseclass name=
"Object"/>
39808 <constructor name=
"XmlResource" overloaded=
"no">
39809 <autodoc>__init__(self, String filemask, int flags=XRC_USE_LOCALE) -
> XmlResource
</autodoc>
39811 <param name=
"filemask" type=
"String" default=
""/>
39812 <param name=
"flags" type=
"int" default=
"wxXRC_USE_LOCALE"/>
39815 <constructor name=
"EmptyXmlResource" overloaded=
"no">
39816 <autodoc>EmptyXmlResource(int flags=XRC_USE_LOCALE) -
> XmlResource
</autodoc>
39818 <param name=
"flags" type=
"int" default=
"wxXRC_USE_LOCALE"/>
39821 <destructor name=
"~wxXmlResource" overloaded=
"no">
39822 <autodoc>__del__(self)
</autodoc>
39824 <method name=
"Load" type=
"bool" overloaded=
"no">
39825 <autodoc>Load(self, String filemask) -
> bool
</autodoc>
39827 <param name=
"filemask" type=
"String" default=
""/>
39830 <method name=
"LoadFromString" type=
"bool" overloaded=
"no">
39831 <autodoc>LoadFromString(self, String data) -
> bool
</autodoc>
39833 <param name=
"data" type=
"String" default=
""/>
39836 <method name=
"InitAllHandlers" type=
"" overloaded=
"no">
39837 <autodoc>InitAllHandlers(self)
</autodoc>
39839 <method name=
"AddHandler" type=
"" overloaded=
"no">
39840 <autodoc>AddHandler(self, XmlResourceHandler handler)
</autodoc>
39842 <param name=
"handler" type=
"wxPyXmlResourceHandler" default=
""/>
39845 <method name=
"InsertHandler" type=
"" overloaded=
"no">
39846 <autodoc>InsertHandler(self, XmlResourceHandler handler)
</autodoc>
39848 <param name=
"handler" type=
"wxPyXmlResourceHandler" default=
""/>
39851 <method name=
"ClearHandlers" type=
"" overloaded=
"no">
39852 <autodoc>ClearHandlers(self)
</autodoc>
39854 <staticmethod name=
"AddSubclassFactory" type=
"" overloaded=
"no">
39855 <autodoc>AddSubclassFactory(XmlSubclassFactory factory)
</autodoc>
39857 <param name=
"factory" type=
"wxPyXmlSubclassFactory" default=
""/>
39860 <method name=
"LoadMenu" type=
"Menu" overloaded=
"no">
39861 <autodoc>LoadMenu(self, String name) -
> Menu
</autodoc>
39863 <param name=
"name" type=
"String" default=
""/>
39866 <method name=
"LoadMenuBar" type=
"MenuBar" overloaded=
"no">
39867 <autodoc>LoadMenuBar(self, String name) -
> MenuBar
</autodoc>
39869 <param name=
"name" type=
"String" default=
""/>
39872 <method name=
"LoadMenuBarOnFrame" type=
"MenuBar" overloaded=
"no">
39873 <autodoc>LoadMenuBarOnFrame(self, Window parent, String name) -
> MenuBar
</autodoc>
39875 <param name=
"parent" type=
"Window" default=
""/>
39876 <param name=
"name" type=
"String" default=
""/>
39879 <method name=
"LoadToolBar" type=
"ToolBar" overloaded=
"no">
39880 <autodoc>LoadToolBar(self, Window parent, String name) -
> wxToolBar
</autodoc>
39882 <param name=
"parent" type=
"Window" default=
""/>
39883 <param name=
"name" type=
"String" default=
""/>
39886 <method name=
"LoadDialog" type=
"Dialog" overloaded=
"no">
39887 <autodoc>LoadDialog(self, Window parent, String name) -
> wxDialog
</autodoc>
39889 <param name=
"parent" type=
"Window" default=
""/>
39890 <param name=
"name" type=
"String" default=
""/>
39893 <method name=
"LoadOnDialog" type=
"bool" overloaded=
"no">
39894 <autodoc>LoadOnDialog(self, wxDialog dlg, Window parent, String name) -
> bool
</autodoc>
39896 <param name=
"dlg" type=
"Dialog" default=
""/>
39897 <param name=
"parent" type=
"Window" default=
""/>
39898 <param name=
"name" type=
"String" default=
""/>
39901 <method name=
"LoadPanel" type=
"Panel" overloaded=
"no">
39902 <autodoc>LoadPanel(self, Window parent, String name) -
> wxPanel
</autodoc>
39904 <param name=
"parent" type=
"Window" default=
""/>
39905 <param name=
"name" type=
"String" default=
""/>
39908 <method name=
"LoadOnPanel" type=
"bool" overloaded=
"no">
39909 <autodoc>LoadOnPanel(self, wxPanel panel, Window parent, String name) -
> bool
</autodoc>
39911 <param name=
"panel" type=
"Panel" default=
""/>
39912 <param name=
"parent" type=
"Window" default=
""/>
39913 <param name=
"name" type=
"String" default=
""/>
39916 <method name=
"LoadFrame" type=
"Frame" overloaded=
"no">
39917 <autodoc>LoadFrame(self, Window parent, String name) -
> wxFrame
</autodoc>
39919 <param name=
"parent" type=
"Window" default=
""/>
39920 <param name=
"name" type=
"String" default=
""/>
39923 <method name=
"LoadOnFrame" type=
"bool" overloaded=
"no">
39924 <autodoc>LoadOnFrame(self, wxFrame frame, Window parent, String name) -
> bool
</autodoc>
39926 <param name=
"frame" type=
"Frame" default=
""/>
39927 <param name=
"parent" type=
"Window" default=
""/>
39928 <param name=
"name" type=
"String" default=
""/>
39931 <method name=
"LoadObject" type=
"Object" overloaded=
"no">
39932 <autodoc>LoadObject(self, Window parent, String name, String classname) -
> Object
</autodoc>
39934 <param name=
"parent" type=
"Window" default=
""/>
39935 <param name=
"name" type=
"String" default=
""/>
39936 <param name=
"classname" type=
"String" default=
""/>
39939 <method name=
"LoadOnObject" type=
"bool" overloaded=
"no">
39940 <autodoc>LoadOnObject(self, Object instance, Window parent, String name, String classname) -
> bool
</autodoc>
39942 <param name=
"instance" type=
"Object" default=
""/>
39943 <param name=
"parent" type=
"Window" default=
""/>
39944 <param name=
"name" type=
"String" default=
""/>
39945 <param name=
"classname" type=
"String" default=
""/>
39948 <method name=
"LoadBitmap" type=
"Bitmap" overloaded=
"no">
39949 <autodoc>LoadBitmap(self, String name) -
> Bitmap
</autodoc>
39951 <param name=
"name" type=
"String" default=
""/>
39954 <method name=
"LoadIcon" type=
"Icon" overloaded=
"no">
39955 <autodoc>LoadIcon(self, String name) -
> Icon
</autodoc>
39957 <param name=
"name" type=
"String" default=
""/>
39960 <method name=
"AttachUnknownControl" type=
"bool" overloaded=
"no">
39961 <autodoc>AttachUnknownControl(self, String name, Window control, Window parent=None) -
> bool
</autodoc>
39963 <param name=
"name" type=
"String" default=
""/>
39964 <param name=
"control" type=
"Window" default=
""/>
39965 <param name=
"parent" type=
"Window" default=
"NULL"/>
39968 <staticmethod name=
"GetXRCID" type=
"int" overloaded=
"no">
39969 <autodoc>GetXRCID(String str_id) -
> int
</autodoc>
39971 <param name=
"str_id" type=
"String" default=
""/>
39974 <method name=
"GetVersion" type=
"long" overloaded=
"no">
39975 <autodoc>GetVersion(self) -
> long
</autodoc>
39977 <method name=
"CompareVersion" type=
"int" overloaded=
"no">
39978 <autodoc>CompareVersion(self, int major, int minor, int release, int revision) -
> int
</autodoc>
39980 <param name=
"major" type=
"int" default=
""/>
39981 <param name=
"minor" type=
"int" default=
""/>
39982 <param name=
"release" type=
"int" default=
""/>
39983 <param name=
"revision" type=
"int" default=
""/>
39986 <staticmethod name=
"Get" type=
"XmlResource" overloaded=
"no">
39987 <autodoc>Get() -
> XmlResource
</autodoc>
39989 <staticmethod name=
"Set" type=
"XmlResource" overloaded=
"no">
39990 <autodoc>Set(XmlResource res) -
> XmlResource
</autodoc>
39992 <param name=
"res" type=
"XmlResource" default=
""/>
39995 <method name=
"GetFlags" type=
"int" overloaded=
"no">
39996 <autodoc>GetFlags(self) -
> int
</autodoc>
39998 <method name=
"SetFlags" type=
"" overloaded=
"no">
39999 <autodoc>SetFlags(self, int flags)
</autodoc>
40001 <param name=
"flags" type=
"int" default=
""/>
40007 return XmlResource_GetXRCID(str_id)
40009 def XRCCTRL(window, str_id, *ignoreargs):
40010 return window.FindWindowById(XRCID(str_id))
40013 #---------------------------------------------------------------------------
40015 <class name=
"XmlSubclassFactory" oldname=
"wxPyXmlSubclassFactory" module=
"xrc">
40016 <constructor name=
"wxPyXmlSubclassFactory" overloaded=
"no">
40017 <autodoc>__init__(self) -
> XmlSubclassFactory
</autodoc>
40019 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
40020 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
40022 <param name=
"self" type=
"PyObject" default=
""/>
40023 <param name=
"_class" type=
"PyObject" default=
""/>
40028 #---------------------------------------------------------------------------
40030 <class name=
"XmlProperty" oldname=
"wxXmlProperty" module=
"xrc">
40031 <constructor name=
"XmlProperty" overloaded=
"no">
40032 <autodoc>__init__(self, String name=EmptyString, String value=EmptyString,
40033 XmlProperty next=None) -
> XmlProperty
</autodoc>
40035 <param name=
"name" type=
"String" default=
"wxPyEmptyString"/>
40036 <param name=
"value" type=
"String" default=
"wxPyEmptyString"/>
40037 <param name=
"next" type=
"XmlProperty" default=
"NULL"/>
40040 <method name=
"GetName" type=
"String" overloaded=
"no">
40041 <autodoc>GetName(self) -
> String
</autodoc>
40043 <method name=
"GetValue" type=
"String" overloaded=
"no">
40044 <autodoc>GetValue(self) -
> String
</autodoc>
40046 <method name=
"GetNext" type=
"XmlProperty" overloaded=
"no">
40047 <autodoc>GetNext(self) -
> XmlProperty
</autodoc>
40049 <method name=
"SetName" type=
"" overloaded=
"no">
40050 <autodoc>SetName(self, String name)
</autodoc>
40052 <param name=
"name" type=
"String" default=
""/>
40055 <method name=
"SetValue" type=
"" overloaded=
"no">
40056 <autodoc>SetValue(self, String value)
</autodoc>
40058 <param name=
"value" type=
"String" default=
""/>
40061 <method name=
"SetNext" type=
"" overloaded=
"no">
40062 <autodoc>SetNext(self, XmlProperty next)
</autodoc>
40064 <param name=
"next" type=
"XmlProperty" default=
""/>
40068 <class name=
"XmlNode" oldname=
"wxXmlNode" module=
"xrc">
40069 <constructor name=
"XmlNode" overloaded=
"no">
40070 <autodoc>__init__(self, XmlNode parent=None, int type=
0, String name=EmptyString,
40071 String content=EmptyString, XmlProperty props=None,
40072 XmlNode next=None) -
> XmlNode
</autodoc>
40074 <param name=
"parent" type=
"XmlNode" default=
"NULL"/>
40075 <param name=
"type" type=
"wxXmlNodeType" default=
"0"/>
40076 <param name=
"name" type=
"String" default=
"wxPyEmptyString"/>
40077 <param name=
"content" type=
"String" default=
"wxPyEmptyString"/>
40078 <param name=
"props" type=
"XmlProperty" default=
"NULL"/>
40079 <param name=
"next" type=
"XmlNode" default=
"NULL"/>
40082 <constructor name=
"XmlNodeEasy" overloaded=
"no">
40083 <autodoc>XmlNodeEasy(int type, String name, String content=EmptyString) -
> XmlNode
</autodoc>
40085 <param name=
"type" type=
"wxXmlNodeType" default=
""/>
40086 <param name=
"name" type=
"String" default=
""/>
40087 <param name=
"content" type=
"String" default=
"wxPyEmptyString"/>
40090 <destructor name=
"~wxXmlNode" overloaded=
"no">
40091 <autodoc>__del__(self)
</autodoc>
40093 <method name=
"AddChild" type=
"" overloaded=
"no">
40094 <autodoc>AddChild(self, XmlNode child)
</autodoc>
40096 <param name=
"child" type=
"XmlNode" default=
""/>
40099 <method name=
"InsertChild" type=
"" overloaded=
"no">
40100 <autodoc>InsertChild(self, XmlNode child, XmlNode before_node)
</autodoc>
40102 <param name=
"child" type=
"XmlNode" default=
""/>
40103 <param name=
"before_node" type=
"XmlNode" default=
""/>
40106 <method name=
"RemoveChild" type=
"bool" overloaded=
"no">
40107 <autodoc>RemoveChild(self, XmlNode child) -
> bool
</autodoc>
40109 <param name=
"child" type=
"XmlNode" default=
""/>
40112 <method name=
"AddProperty" type=
"" overloaded=
"no">
40113 <autodoc>AddProperty(self, XmlProperty prop)
</autodoc>
40115 <param name=
"prop" type=
"XmlProperty" default=
""/>
40118 <method name=
"AddPropertyName" type=
"" overloaded=
"no">
40119 <autodoc>AddPropertyName(self, String name, String value)
</autodoc>
40121 <param name=
"name" type=
"String" default=
""/>
40122 <param name=
"value" type=
"String" default=
""/>
40125 <method name=
"DeleteProperty" type=
"bool" overloaded=
"no">
40126 <autodoc>DeleteProperty(self, String name) -
> bool
</autodoc>
40128 <param name=
"name" type=
"String" default=
""/>
40131 <method name=
"GetType" type=
"wxXmlNodeType" overloaded=
"no">
40132 <autodoc>GetType(self) -
> int
</autodoc>
40134 <method name=
"GetName" type=
"String" overloaded=
"no">
40135 <autodoc>GetName(self) -
> String
</autodoc>
40137 <method name=
"GetContent" type=
"String" overloaded=
"no">
40138 <autodoc>GetContent(self) -
> String
</autodoc>
40140 <method name=
"GetParent" type=
"XmlNode" overloaded=
"no">
40141 <autodoc>GetParent(self) -
> XmlNode
</autodoc>
40143 <method name=
"GetNext" type=
"XmlNode" overloaded=
"no">
40144 <autodoc>GetNext(self) -
> XmlNode
</autodoc>
40146 <method name=
"GetChildren" type=
"XmlNode" overloaded=
"no">
40147 <autodoc>GetChildren(self) -
> XmlNode
</autodoc>
40149 <method name=
"GetProperties" type=
"XmlProperty" overloaded=
"no">
40150 <autodoc>GetProperties(self) -
> XmlProperty
</autodoc>
40152 <method name=
"GetPropVal" type=
"String" overloaded=
"no">
40153 <autodoc>GetPropVal(self, String propName, String defaultVal) -
> String
</autodoc>
40155 <param name=
"propName" type=
"String" default=
""/>
40156 <param name=
"defaultVal" type=
"String" default=
""/>
40159 <method name=
"HasProp" type=
"bool" overloaded=
"no">
40160 <autodoc>HasProp(self, String propName) -
> bool
</autodoc>
40162 <param name=
"propName" type=
"String" default=
""/>
40165 <method name=
"SetType" type=
"" overloaded=
"no">
40166 <autodoc>SetType(self, int type)
</autodoc>
40168 <param name=
"type" type=
"wxXmlNodeType" default=
""/>
40171 <method name=
"SetName" type=
"" overloaded=
"no">
40172 <autodoc>SetName(self, String name)
</autodoc>
40174 <param name=
"name" type=
"String" default=
""/>
40177 <method name=
"SetContent" type=
"" overloaded=
"no">
40178 <autodoc>SetContent(self, String con)
</autodoc>
40180 <param name=
"con" type=
"String" default=
""/>
40183 <method name=
"SetParent" type=
"" overloaded=
"no">
40184 <autodoc>SetParent(self, XmlNode parent)
</autodoc>
40186 <param name=
"parent" type=
"XmlNode" default=
""/>
40189 <method name=
"SetNext" type=
"" overloaded=
"no">
40190 <autodoc>SetNext(self, XmlNode next)
</autodoc>
40192 <param name=
"next" type=
"XmlNode" default=
""/>
40195 <method name=
"SetChildren" type=
"" overloaded=
"no">
40196 <autodoc>SetChildren(self, XmlNode child)
</autodoc>
40198 <param name=
"child" type=
"XmlNode" default=
""/>
40201 <method name=
"SetProperties" type=
"" overloaded=
"no">
40202 <autodoc>SetProperties(self, XmlProperty prop)
</autodoc>
40204 <param name=
"prop" type=
"XmlProperty" default=
""/>
40208 <class name=
"XmlDocument" oldname=
"wxXmlDocument" module=
"xrc">
40209 <baseclass name=
"Object"/>
40210 <constructor name=
"XmlDocument" overloaded=
"no">
40211 <autodoc>__init__(self, String filename, String encoding=UTF8String) -
> XmlDocument
</autodoc>
40213 <param name=
"filename" type=
"String" default=
""/>
40214 <param name=
"encoding" type=
"String" default=
"wxPyUTF8String"/>
40217 <constructor name=
"XmlDocumentFromStream" overloaded=
"no">
40218 <autodoc>XmlDocumentFromStream(InputStream stream, String encoding=UTF8String) -
> XmlDocument
</autodoc>
40220 <param name=
"stream" type=
"wxInputStream" default=
""/>
40221 <param name=
"encoding" type=
"String" default=
"wxPyUTF8String"/>
40224 <constructor name=
"EmptyXmlDocument" overloaded=
"no">
40225 <autodoc>EmptyXmlDocument() -
> XmlDocument
</autodoc>
40227 <destructor name=
"~wxXmlDocument" overloaded=
"no">
40228 <autodoc>__del__(self)
</autodoc>
40230 <method name=
"Load" type=
"bool" overloaded=
"no">
40231 <autodoc>Load(self, String filename, String encoding=UTF8String) -
> bool
</autodoc>
40233 <param name=
"filename" type=
"String" default=
""/>
40234 <param name=
"encoding" type=
"String" default=
"wxPyUTF8String"/>
40237 <method name=
"LoadFromStream" type=
"bool" overloaded=
"no">
40238 <autodoc>LoadFromStream(self, InputStream stream, String encoding=UTF8String) -
> bool
</autodoc>
40240 <param name=
"stream" type=
"wxInputStream" default=
""/>
40241 <param name=
"encoding" type=
"String" default=
"wxPyUTF8String"/>
40244 <method name=
"Save" type=
"bool" overloaded=
"no">
40245 <autodoc>Save(self, String filename) -
> bool
</autodoc>
40247 <param name=
"filename" type=
"String" default=
""/>
40250 <method name=
"SaveToStream" type=
"bool" overloaded=
"no">
40251 <autodoc>SaveToStream(self, OutputStream stream) -
> bool
</autodoc>
40253 <param name=
"stream" type=
"OutputStream" default=
""/>
40256 <method name=
"IsOk" type=
"bool" overloaded=
"no">
40257 <autodoc>IsOk(self) -
> bool
</autodoc>
40259 <method name=
"GetRoot" type=
"XmlNode" overloaded=
"no">
40260 <autodoc>GetRoot(self) -
> XmlNode
</autodoc>
40262 <method name=
"GetVersion" type=
"String" overloaded=
"no">
40263 <autodoc>GetVersion(self) -
> String
</autodoc>
40265 <method name=
"GetFileEncoding" type=
"String" overloaded=
"no">
40266 <autodoc>GetFileEncoding(self) -
> String
</autodoc>
40268 <method name=
"SetRoot" type=
"" overloaded=
"no">
40269 <autodoc>SetRoot(self, XmlNode node)
</autodoc>
40271 <param name=
"node" type=
"XmlNode" default=
""/>
40274 <method name=
"SetVersion" type=
"" overloaded=
"no">
40275 <autodoc>SetVersion(self, String version)
</autodoc>
40277 <param name=
"version" type=
"String" default=
""/>
40280 <method name=
"SetFileEncoding" type=
"" overloaded=
"no">
40281 <autodoc>SetFileEncoding(self, String encoding)
</autodoc>
40283 <param name=
"encoding" type=
"String" default=
""/>
40288 #---------------------------------------------------------------------------
40290 <class name=
"XmlResourceHandler" oldname=
"wxPyXmlResourceHandler" module=
"xrc">
40291 <baseclass name=
"Object"/>
40292 <constructor name=
"wxPyXmlResourceHandler" overloaded=
"no">
40293 <autodoc>__init__(self) -
> XmlResourceHandler
</autodoc>
40295 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
40296 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
40298 <param name=
"self" type=
"PyObject" default=
""/>
40299 <param name=
"_class" type=
"PyObject" default=
""/>
40302 <method name=
"CreateResource" type=
"Object" overloaded=
"no">
40303 <autodoc>CreateResource(self, XmlNode node, Object parent, Object instance) -
> Object
</autodoc>
40305 <param name=
"node" type=
"XmlNode" default=
""/>
40306 <param name=
"parent" type=
"Object" default=
""/>
40307 <param name=
"instance" type=
"Object" default=
""/>
40310 <method name=
"SetParentResource" type=
"" overloaded=
"no">
40311 <autodoc>SetParentResource(self, XmlResource res)
</autodoc>
40313 <param name=
"res" type=
"XmlResource" default=
""/>
40316 <method name=
"GetResource" type=
"XmlResource" overloaded=
"no">
40317 <autodoc>GetResource(self) -
> XmlResource
</autodoc>
40319 <method name=
"GetNode" type=
"XmlNode" overloaded=
"no">
40320 <autodoc>GetNode(self) -
> XmlNode
</autodoc>
40322 <method name=
"GetClass" type=
"String" overloaded=
"no">
40323 <autodoc>GetClass(self) -
> String
</autodoc>
40325 <method name=
"GetParent" type=
"Object" overloaded=
"no">
40326 <autodoc>GetParent(self) -
> Object
</autodoc>
40328 <method name=
"GetInstance" type=
"Object" overloaded=
"no">
40329 <autodoc>GetInstance(self) -
> Object
</autodoc>
40331 <method name=
"GetParentAsWindow" type=
"Window" overloaded=
"no">
40332 <autodoc>GetParentAsWindow(self) -
> Window
</autodoc>
40334 <method name=
"GetInstanceAsWindow" type=
"Window" overloaded=
"no">
40335 <autodoc>GetInstanceAsWindow(self) -
> Window
</autodoc>
40337 <method name=
"IsOfClass" type=
"bool" overloaded=
"no">
40338 <autodoc>IsOfClass(self, XmlNode node, String classname) -
> bool
</autodoc>
40340 <param name=
"node" type=
"XmlNode" default=
""/>
40341 <param name=
"classname" type=
"String" default=
""/>
40344 <method name=
"GetNodeContent" type=
"String" overloaded=
"no">
40345 <autodoc>GetNodeContent(self, XmlNode node) -
> String
</autodoc>
40347 <param name=
"node" type=
"XmlNode" default=
""/>
40350 <method name=
"HasParam" type=
"bool" overloaded=
"no">
40351 <autodoc>HasParam(self, String param) -
> bool
</autodoc>
40353 <param name=
"param" type=
"String" default=
""/>
40356 <method name=
"GetParamNode" type=
"XmlNode" overloaded=
"no">
40357 <autodoc>GetParamNode(self, String param) -
> XmlNode
</autodoc>
40359 <param name=
"param" type=
"String" default=
""/>
40362 <method name=
"GetParamValue" type=
"String" overloaded=
"no">
40363 <autodoc>GetParamValue(self, String param) -
> String
</autodoc>
40365 <param name=
"param" type=
"String" default=
""/>
40368 <method name=
"AddStyle" type=
"" overloaded=
"no">
40369 <autodoc>AddStyle(self, String name, int value)
</autodoc>
40371 <param name=
"name" type=
"String" default=
""/>
40372 <param name=
"value" type=
"int" default=
""/>
40375 <method name=
"AddWindowStyles" type=
"" overloaded=
"no">
40376 <autodoc>AddWindowStyles(self)
</autodoc>
40378 <method name=
"GetStyle" type=
"int" overloaded=
"no">
40379 <autodoc>GetStyle(self, String param=StyleString, int defaults=
0) -
> int
</autodoc>
40381 <param name=
"param" type=
"String" default=
"wxPyStyleString"/>
40382 <param name=
"defaults" type=
"int" default=
"0"/>
40385 <method name=
"GetText" type=
"String" overloaded=
"no">
40386 <autodoc>GetText(self, String param, bool translate=True) -
> String
</autodoc>
40388 <param name=
"param" type=
"String" default=
""/>
40389 <param name=
"translate" type=
"bool" default=
"True"/>
40392 <method name=
"GetID" type=
"int" overloaded=
"no">
40393 <autodoc>GetID(self) -
> int
</autodoc>
40395 <method name=
"GetName" type=
"String" overloaded=
"no">
40396 <autodoc>GetName(self) -
> String
</autodoc>
40398 <method name=
"GetBool" type=
"bool" overloaded=
"no">
40399 <autodoc>GetBool(self, String param, bool defaultv=False) -
> bool
</autodoc>
40401 <param name=
"param" type=
"String" default=
""/>
40402 <param name=
"defaultv" type=
"bool" default=
"False"/>
40405 <method name=
"GetLong" type=
"long" overloaded=
"no">
40406 <autodoc>GetLong(self, String param, long defaultv=
0) -
> long
</autodoc>
40408 <param name=
"param" type=
"String" default=
""/>
40409 <param name=
"defaultv" type=
"long" default=
"0"/>
40412 <method name=
"GetColour" type=
"Colour" overloaded=
"no">
40413 <autodoc>GetColour(self, String param) -
> Colour
</autodoc>
40415 <param name=
"param" type=
"String" default=
""/>
40418 <method name=
"GetSize" type=
"Size" overloaded=
"no">
40419 <autodoc>GetSize(self, String param=SizeString) -
> Size
</autodoc>
40421 <param name=
"param" type=
"String" default=
"wxPySizeString"/>
40424 <method name=
"GetPosition" type=
"Point" overloaded=
"no">
40425 <autodoc>GetPosition(self, String param=PosString) -
> Point
</autodoc>
40427 <param name=
"param" type=
"String" default=
"wxPyPosString"/>
40430 <method name=
"GetDimension" type=
"int" overloaded=
"no">
40431 <autodoc>GetDimension(self, String param, int defaultv=
0) -
> int
</autodoc>
40433 <param name=
"param" type=
"String" default=
""/>
40434 <param name=
"defaultv" type=
"int" default=
"0"/>
40437 <method name=
"GetBitmap" type=
"Bitmap" overloaded=
"no">
40438 <autodoc>GetBitmap(self, String param=BitmapString, wxArtClient defaultArtClient=wxART_OTHER,
40439 Size size=DefaultSize) -
> Bitmap
</autodoc>
40441 <param name=
"param" type=
"String" default=
"wxPyBitmapString"/>
40442 <param name=
"defaultArtClient" type=
"wxArtClient" default=
"wxART_OTHER"/>
40443 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40446 <method name=
"GetIcon" type=
"Icon" overloaded=
"no">
40447 <autodoc>GetIcon(self, String param=IconString, wxArtClient defaultArtClient=wxART_OTHER,
40448 Size size=DefaultSize) -
> Icon
</autodoc>
40450 <param name=
"param" type=
"String" default=
"wxPyIconString"/>
40451 <param name=
"defaultArtClient" type=
"wxArtClient" default=
"wxART_OTHER"/>
40452 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40455 <method name=
"GetFont" type=
"Font" overloaded=
"no">
40456 <autodoc>GetFont(self, String param=FontString) -
> Font
</autodoc>
40458 <param name=
"param" type=
"String" default=
"wxPyFontString"/>
40461 <method name=
"SetupWindow" type=
"" overloaded=
"no">
40462 <autodoc>SetupWindow(self, Window wnd)
</autodoc>
40464 <param name=
"wnd" type=
"Window" default=
""/>
40467 <method name=
"CreateChildren" type=
"" overloaded=
"no">
40468 <autodoc>CreateChildren(self, Object parent, bool this_hnd_only=False)
</autodoc>
40470 <param name=
"parent" type=
"Object" default=
""/>
40471 <param name=
"this_hnd_only" type=
"bool" default=
"False"/>
40474 <method name=
"CreateChildrenPrivately" type=
"" overloaded=
"no">
40475 <autodoc>CreateChildrenPrivately(self, Object parent, XmlNode rootnode=None)
</autodoc>
40477 <param name=
"parent" type=
"Object" default=
""/>
40478 <param name=
"rootnode" type=
"XmlNode" default=
"NULL"/>
40481 <method name=
"CreateResFromNode" type=
"Object" overloaded=
"no">
40482 <autodoc>CreateResFromNode(self, XmlNode node, Object parent, Object instance=None) -
> Object
</autodoc>
40484 <param name=
"node" type=
"XmlNode" default=
""/>
40485 <param name=
"parent" type=
"Object" default=
""/>
40486 <param name=
"instance" type=
"Object" default=
"NULL"/>
40489 <method name=
"GetCurFileSystem" type=
"FileSystem" overloaded=
"no">
40490 <autodoc>GetCurFileSystem(self) -
> FileSystem
</autodoc>
40493 <pythoncode>#----------------------------------------------------------------------------
40494 # The global was removed in favor of static accessor functions. This is for
40495 # backwards compatibility:
40497 TheXmlResource = XmlResource_Get()
40500 #----------------------------------------------------------------------------
40501 # Create a factory for handling the subclass property of the object tag.
40504 def _my_import(name):
40505 mod = __import__(name)
40506 components = name.split('.')
40507 for comp in components[
1:]:
40508 mod = getattr(mod, comp)
40512 class XmlSubclassFactory_Python(XmlSubclassFactory):
40513 def __init__(self):
40514 XmlSubclassFactory.__init__(self)
40516 def Create(self, className):
40517 assert className.find('.') != -
1, "Module name must be specified!"
40518 mname = className[:className.rfind('.')]
40519 cname = className[className.rfind('.')+
1:]
40520 module = _my_import(mname)
40521 klass = getattr(module, cname)
40526 XmlResource_AddSubclassFactory(XmlSubclassFactory_Python())
40528 #----------------------------------------------------------------------------
40531 <module name=
"gizmos">
40532 <import name=
"_windows"/>
40533 <import name=
"_controls"/>
40534 <pythoncode> import wx
</pythoncode>
40535 <pythoncode> __docfilter__ = wx._core.__DocFilter(globals())
</pythoncode>
40536 <class name=
"DynamicSashSplitEvent" oldname=
"wxDynamicSashSplitEvent" module=
"gizmos">
40537 <baseclass name=
"CommandEvent"/>
40538 <constructor name=
"DynamicSashSplitEvent" overloaded=
"no">
40539 <autodoc>__init__(self, Object target) -
> DynamicSashSplitEvent
</autodoc>
40541 <param name=
"target" type=
"Object" default=
""/>
40545 <class name=
"DynamicSashUnifyEvent" oldname=
"wxDynamicSashUnifyEvent" module=
"gizmos">
40546 <baseclass name=
"CommandEvent"/>
40547 <constructor name=
"DynamicSashUnifyEvent" overloaded=
"no">
40548 <autodoc>__init__(self, Object target) -
> DynamicSashUnifyEvent
</autodoc>
40550 <param name=
"target" type=
"Object" default=
""/>
40554 <class name=
"DynamicSashWindow" oldname=
"wxDynamicSashWindow" module=
"gizmos">
40555 <baseclass name=
"Window"/>
40556 <constructor name=
"DynamicSashWindow" overloaded=
"no">
40557 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40558 Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER,
40559 String name=DynamicSashNameStr) -
> DynamicSashWindow
</autodoc>
40561 <param name=
"parent" type=
"Window" default=
""/>
40562 <param name=
"id" type=
"int" default=
"-1"/>
40563 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40564 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40565 <param name=
"style" type=
"long" default=
"wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER"/>
40566 <param name=
"name" type=
"String" default=
"wxPyDynamicSashNameStr"/>
40569 <constructor name=
"PreDynamicSashWindow" overloaded=
"no">
40570 <autodoc>PreDynamicSashWindow() -
> DynamicSashWindow
</autodoc>
40572 <method name=
"Create" type=
"bool" overloaded=
"no">
40573 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40574 Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER,
40575 String name=DynamicSashNameStr) -
> bool
</autodoc>
40577 <param name=
"parent" type=
"Window" default=
""/>
40578 <param name=
"id" type=
"int" default=
"-1"/>
40579 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40580 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40581 <param name=
"style" type=
"long" default=
"wxCLIP_CHILDREN|wxDS_MANAGE_SCROLLBARS|wxDS_DRAG_CORNER"/>
40582 <param name=
"name" type=
"String" default=
"wxPyDynamicSashNameStr"/>
40585 <method name=
"GetHScrollBar" type=
"ScrollBar" overloaded=
"no">
40586 <autodoc>GetHScrollBar(self, Window child) -
> ScrollBar
</autodoc>
40588 <param name=
"child" type=
"Window" default=
""/>
40591 <method name=
"GetVScrollBar" type=
"ScrollBar" overloaded=
"no">
40592 <autodoc>GetVScrollBar(self, Window child) -
> ScrollBar
</autodoc>
40594 <param name=
"child" type=
"Window" default=
""/>
40599 EVT_DYNAMIC_SASH_SPLIT = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_SPLIT,
1 )
40600 EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY,
1 )
40602 <class name=
"EditableListBox" oldname=
"wxEditableListBox" module=
"gizmos">
40603 <baseclass name=
"Panel"/>
40604 <constructor name=
"EditableListBox" overloaded=
"no">
40605 <autodoc>__init__(self, Window parent, int id=-
1, String label=EmptyString,
40606 Point pos=DefaultPosition, Size size=DefaultSize,
40607 long style=wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE,
40608 String name=EditableListBoxNameStr) -
> EditableListBox
</autodoc>
40610 <param name=
"parent" type=
"Window" default=
""/>
40611 <param name=
"id" type=
"int" default=
"-1"/>
40612 <param name=
"label" type=
"String" default=
"wxPyEmptyString"/>
40613 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40614 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40615 <param name=
"style" type=
"long" default=
"wxEL_ALLOW_NEW|wxEL_ALLOW_EDIT|wxEL_ALLOW_DELETE"/>
40616 <param name=
"name" type=
"String" default=
"wxPyEditableListBoxNameStr"/>
40619 <method name=
"SetStrings" type=
"" overloaded=
"no">
40620 <autodoc>SetStrings(self, wxArrayString strings)
</autodoc>
40622 <param name=
"strings" type=
"wxArrayString" default=
""/>
40625 <method name=
"GetStrings" type=
"PyObject" overloaded=
"no">
40626 <autodoc>GetStrings(self) -
> PyObject
</autodoc>
40628 <method name=
"GetListCtrl" type=
"wxListCtrl" overloaded=
"no">
40629 <autodoc>GetListCtrl(self) -
> wxListCtrl
</autodoc>
40631 <method name=
"GetDelButton" type=
"BitmapButton" overloaded=
"no">
40632 <autodoc>GetDelButton(self) -
> BitmapButton
</autodoc>
40634 <method name=
"GetNewButton" type=
"BitmapButton" overloaded=
"no">
40635 <autodoc>GetNewButton(self) -
> BitmapButton
</autodoc>
40637 <method name=
"GetUpButton" type=
"BitmapButton" overloaded=
"no">
40638 <autodoc>GetUpButton(self) -
> BitmapButton
</autodoc>
40640 <method name=
"GetDownButton" type=
"BitmapButton" overloaded=
"no">
40641 <autodoc>GetDownButton(self) -
> BitmapButton
</autodoc>
40643 <method name=
"GetEditButton" type=
"BitmapButton" overloaded=
"no">
40644 <autodoc>GetEditButton(self) -
> BitmapButton
</autodoc>
40647 <class name=
"RemotelyScrolledTreeCtrl" oldname=
"wxRemotelyScrolledTreeCtrl" module=
"gizmos">
40648 <baseclass name=
"TreeCtrl"/>
40649 <constructor name=
"RemotelyScrolledTreeCtrl" overloaded=
"no">
40650 <autodoc>__init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
40651 long style=TR_HAS_BUTTONS) -
> RemotelyScrolledTreeCtrl
</autodoc>
40653 <param name=
"parent" type=
"Window" default=
""/>
40654 <param name=
"id" type=
"int" default=
""/>
40655 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40656 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40657 <param name=
"style" type=
"long" default=
"wxTR_HAS_BUTTONS"/>
40660 <method name=
"HideVScrollbar" type=
"" overloaded=
"no">
40661 <autodoc>HideVScrollbar(self)
</autodoc>
40663 <method name=
"AdjustRemoteScrollbars" type=
"" overloaded=
"no">
40664 <autodoc>AdjustRemoteScrollbars(self)
</autodoc>
40666 <method name=
"GetScrolledWindow" type=
"ScrolledWindow" overloaded=
"no">
40667 <autodoc>GetScrolledWindow(self) -
> ScrolledWindow
</autodoc>
40669 <method name=
"ScrollToLine" type=
"" overloaded=
"no">
40670 <autodoc>ScrollToLine(self, int posHoriz, int posVert)
</autodoc>
40672 <param name=
"posHoriz" type=
"int" default=
""/>
40673 <param name=
"posVert" type=
"int" default=
""/>
40676 <method name=
"SetCompanionWindow" type=
"" overloaded=
"no">
40677 <autodoc>SetCompanionWindow(self, Window companion)
</autodoc>
40679 <param name=
"companion" type=
"Window" default=
""/>
40682 <method name=
"GetCompanionWindow" type=
"Window" overloaded=
"no">
40683 <autodoc>GetCompanionWindow(self) -
> Window
</autodoc>
40686 <class name=
"TreeCompanionWindow" oldname=
"wxPyTreeCompanionWindow" module=
"gizmos">
40687 <baseclass name=
"Window"/>
40688 <constructor name=
"wxPyTreeCompanionWindow" overloaded=
"no">
40689 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40690 Size size=DefaultSize, long style=
0) -
> TreeCompanionWindow
</autodoc>
40692 <param name=
"parent" type=
"Window" default=
""/>
40693 <param name=
"id" type=
"int" default=
"-1"/>
40694 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40695 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40696 <param name=
"style" type=
"long" default=
"0"/>
40699 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
40700 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
40702 <param name=
"self" type=
"PyObject" default=
""/>
40703 <param name=
"_class" type=
"PyObject" default=
""/>
40706 <method name=
"GetTreeCtrl" type=
"RemotelyScrolledTreeCtrl" overloaded=
"no">
40707 <autodoc>GetTreeCtrl(self) -
> RemotelyScrolledTreeCtrl
</autodoc>
40709 <method name=
"SetTreeCtrl" type=
"" overloaded=
"no">
40710 <autodoc>SetTreeCtrl(self, RemotelyScrolledTreeCtrl treeCtrl)
</autodoc>
40712 <param name=
"treeCtrl" type=
"RemotelyScrolledTreeCtrl" default=
""/>
40716 <class name=
"ThinSplitterWindow" oldname=
"wxThinSplitterWindow" module=
"gizmos">
40717 <baseclass name=
"SplitterWindow"/>
40718 <constructor name=
"ThinSplitterWindow" overloaded=
"no">
40719 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40720 Size size=DefaultSize, long style=wxSP_3D|wxCLIP_CHILDREN) -
> ThinSplitterWindow
</autodoc>
40722 <param name=
"parent" type=
"Window" default=
""/>
40723 <param name=
"id" type=
"int" default=
"-1"/>
40724 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40725 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40726 <param name=
"style" type=
"long" default=
"wxSP_3D|wxCLIP_CHILDREN"/>
40730 <class name=
"SplitterScrolledWindow" oldname=
"wxSplitterScrolledWindow" module=
"gizmos">
40731 <baseclass name=
"ScrolledWindow"/>
40732 <constructor name=
"SplitterScrolledWindow" overloaded=
"no">
40733 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40734 Size size=DefaultSize, long style=
0) -
> SplitterScrolledWindow
</autodoc>
40736 <param name=
"parent" type=
"Window" default=
""/>
40737 <param name=
"id" type=
"int" default=
"-1"/>
40738 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40739 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40740 <param name=
"style" type=
"long" default=
"0"/>
40744 <class name=
"LEDNumberCtrl" oldname=
"wxLEDNumberCtrl" module=
"gizmos">
40745 <baseclass name=
"Control"/>
40746 <constructor name=
"LEDNumberCtrl" overloaded=
"no">
40747 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40748 Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -
> LEDNumberCtrl
</autodoc>
40750 <param name=
"parent" type=
"Window" default=
""/>
40751 <param name=
"id" type=
"int" default=
"-1"/>
40752 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40753 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40754 <param name=
"style" type=
"long" default=
"wxLED_ALIGN_LEFT|wxLED_DRAW_FADED"/>
40757 <constructor name=
"PreLEDNumberCtrl" overloaded=
"no">
40758 <autodoc>PreLEDNumberCtrl() -
> LEDNumberCtrl
</autodoc>
40760 <method name=
"Create" type=
"bool" overloaded=
"no">
40761 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40762 Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -
> bool
</autodoc>
40764 <param name=
"parent" type=
"Window" default=
""/>
40765 <param name=
"id" type=
"int" default=
"-1"/>
40766 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40767 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40768 <param name=
"style" type=
"long" default=
"wxLED_ALIGN_LEFT|wxLED_DRAW_FADED"/>
40771 <method name=
"GetAlignment" type=
"wxLEDValueAlign" overloaded=
"no">
40772 <autodoc>GetAlignment(self) -
> int
</autodoc>
40774 <method name=
"GetDrawFaded" type=
"bool" overloaded=
"no">
40775 <autodoc>GetDrawFaded(self) -
> bool
</autodoc>
40777 <method name=
"GetValue" type=
"String" overloaded=
"no">
40778 <autodoc>GetValue(self) -
> String
</autodoc>
40780 <method name=
"SetAlignment" type=
"" overloaded=
"no">
40781 <autodoc>SetAlignment(self, int Alignment, bool Redraw=true)
</autodoc>
40783 <param name=
"Alignment" type=
"wxLEDValueAlign" default=
""/>
40784 <param name=
"Redraw" type=
"bool" default=
"true"/>
40787 <method name=
"SetDrawFaded" type=
"" overloaded=
"no">
40788 <autodoc>SetDrawFaded(self, bool DrawFaded, bool Redraw=true)
</autodoc>
40790 <param name=
"DrawFaded" type=
"bool" default=
""/>
40791 <param name=
"Redraw" type=
"bool" default=
"true"/>
40794 <method name=
"SetValue" type=
"" overloaded=
"no">
40795 <autodoc>SetValue(self, String Value, bool Redraw=true)
</autodoc>
40797 <param name=
"Value" type=
"String" default=
""/>
40798 <param name=
"Redraw" type=
"bool" default=
"true"/>
40802 <pythoncode> wx.TR_DONT_ADJUST_MAC = TR_DONT_ADJUST_MAC
</pythoncode>
40803 <class name=
"TreeListColumnInfo" oldname=
"wxTreeListColumnInfo" module=
"gizmos">
40804 <baseclass name=
"Object"/>
40805 <constructor name=
"TreeListColumnInfo" overloaded=
"no">
40806 <autodoc>__init__(self, String text=EmptyString, int image=-
1, size_t width=
100,
40807 bool shown=True, int alignment=TL_ALIGN_LEFT) -
> TreeListColumnInfo
</autodoc>
40809 <param name=
"text" type=
"String" default=
"wxPyEmptyString"/>
40810 <param name=
"image" type=
"int" default=
"-1"/>
40811 <param name=
"width" type=
"size_t" default=
"100"/>
40812 <param name=
"shown" type=
"bool" default=
"True"/>
40813 <param name=
"alignment" type=
"wxTreeListColumnAlign" default=
"wxTL_ALIGN_LEFT"/>
40816 <method name=
"GetShown" type=
"bool" overloaded=
"no">
40817 <autodoc>GetShown(self) -
> bool
</autodoc>
40819 <method name=
"GetAlignment" type=
"wxTreeListColumnAlign" overloaded=
"no">
40820 <autodoc>GetAlignment(self) -
> int
</autodoc>
40822 <method name=
"GetText" type=
"String" overloaded=
"no">
40823 <autodoc>GetText(self) -
> String
</autodoc>
40825 <method name=
"GetImage" type=
"int" overloaded=
"no">
40826 <autodoc>GetImage(self) -
> int
</autodoc>
40828 <method name=
"GetSelectedImage" type=
"int" overloaded=
"no">
40829 <autodoc>GetSelectedImage(self) -
> int
</autodoc>
40831 <method name=
"GetWidth" type=
"size_t" overloaded=
"no">
40832 <autodoc>GetWidth(self) -
> size_t
</autodoc>
40834 <method name=
"SetShown" type=
"" overloaded=
"no">
40835 <autodoc>SetShown(self, bool shown)
</autodoc>
40837 <param name=
"shown" type=
"bool" default=
""/>
40840 <method name=
"SetAlignment" type=
"" overloaded=
"no">
40841 <autodoc>SetAlignment(self, int alignment)
</autodoc>
40843 <param name=
"alignment" type=
"wxTreeListColumnAlign" default=
""/>
40846 <method name=
"SetText" type=
"" overloaded=
"no">
40847 <autodoc>SetText(self, String text)
</autodoc>
40849 <param name=
"text" type=
"String" default=
""/>
40852 <method name=
"SetImage" type=
"" overloaded=
"no">
40853 <autodoc>SetImage(self, int image)
</autodoc>
40855 <param name=
"image" type=
"int" default=
""/>
40858 <method name=
"SetSelectedImage" type=
"" overloaded=
"no">
40859 <autodoc>SetSelectedImage(self, int image)
</autodoc>
40861 <param name=
"image" type=
"int" default=
""/>
40864 <method name=
"SetWidth" type=
"" overloaded=
"no">
40865 <autodoc>SetWidth(self, size_t with)
</autodoc>
40867 <param name=
"with" type=
"size_t" default=
""/>
40871 <class name=
"TreeListCtrl" oldname=
"wxPyTreeListCtrl" module=
"gizmos">
40872 <baseclass name=
"Control"/>
40873 <constructor name=
"wxPyTreeListCtrl" overloaded=
"no">
40874 <autodoc>__init__(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40875 Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
40876 Validator validator=DefaultValidator,
40877 String name=TreeListCtrlNameStr) -
> TreeListCtrl
</autodoc>
40879 <param name=
"parent" type=
"Window" default=
""/>
40880 <param name=
"id" type=
"int" default=
"-1"/>
40881 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40882 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40883 <param name=
"style" type=
"long" default=
"wxTR_DEFAULT_STYLE"/>
40884 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
40885 <param name=
"name" type=
"String" default=
"wxPyTreeListCtrlNameStr"/>
40888 <constructor name=
"PreTreeListCtrl" overloaded=
"no">
40889 <autodoc>PreTreeListCtrl() -
> TreeListCtrl
</autodoc>
40891 <method name=
"Create" type=
"bool" overloaded=
"no">
40892 <autodoc>Create(self, Window parent, int id=-
1, Point pos=DefaultPosition,
40893 Size size=DefaultSize, long style=TR_DEFAULT_STYLE,
40894 Validator validator=DefaultValidator,
40895 String name=TreeListCtrlNameStr) -
> bool
</autodoc>
40896 <docstring>Do the
2nd phase and create the GUI control.
</docstring>
40898 <param name=
"parent" type=
"Window" default=
""/>
40899 <param name=
"id" type=
"int" default=
"-1"/>
40900 <param name=
"pos" type=
"Point" default=
"wxDefaultPosition"/>
40901 <param name=
"size" type=
"Size" default=
"wxDefaultSize"/>
40902 <param name=
"style" type=
"long" default=
"wxTR_DEFAULT_STYLE"/>
40903 <param name=
"validator" type=
"Validator" default=
"wxDefaultValidator"/>
40904 <param name=
"name" type=
"String" default=
"wxPyTreeListCtrlNameStr"/>
40907 <method name=
"_setCallbackInfo" type=
"" overloaded=
"no">
40908 <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)
</autodoc>
40910 <param name=
"self" type=
"PyObject" default=
""/>
40911 <param name=
"_class" type=
"PyObject" default=
""/>
40914 <method name=
"GetCount" type=
"size_t" overloaded=
"no">
40915 <autodoc>GetCount(self) -
> size_t
</autodoc>
40917 <method name=
"GetIndent" type=
"unsigned int" overloaded=
"no">
40918 <autodoc>GetIndent(self) -
> unsigned int
</autodoc>
40920 <method name=
"SetIndent" type=
"" overloaded=
"no">
40921 <autodoc>SetIndent(self, unsigned int indent)
</autodoc>
40923 <param name=
"indent" type=
"unsigned int" default=
""/>
40926 <method name=
"GetLineSpacing" type=
"unsigned int" overloaded=
"no">
40927 <autodoc>GetLineSpacing(self) -
> unsigned int
</autodoc>
40929 <method name=
"SetLineSpacing" type=
"" overloaded=
"no">
40930 <autodoc>SetLineSpacing(self, unsigned int spacing)
</autodoc>
40932 <param name=
"spacing" type=
"unsigned int" default=
""/>
40935 <method name=
"GetImageList" type=
"ImageList" overloaded=
"no">
40936 <autodoc>GetImageList(self) -
> ImageList
</autodoc>
40938 <method name=
"GetStateImageList" type=
"ImageList" overloaded=
"no">
40939 <autodoc>GetStateImageList(self) -
> ImageList
</autodoc>
40941 <method name=
"GetButtonsImageList" type=
"ImageList" overloaded=
"no">
40942 <autodoc>GetButtonsImageList(self) -
> ImageList
</autodoc>
40944 <method name=
"SetImageList" type=
"" overloaded=
"no">
40945 <autodoc>SetImageList(self, ImageList imageList)
</autodoc>
40947 <param name=
"imageList" type=
"ImageList" default=
""/>
40950 <method name=
"SetStateImageList" type=
"" overloaded=
"no">
40951 <autodoc>SetStateImageList(self, ImageList imageList)
</autodoc>
40953 <param name=
"imageList" type=
"ImageList" default=
""/>
40956 <method name=
"SetButtonsImageList" type=
"" overloaded=
"no">
40957 <autodoc>SetButtonsImageList(self, ImageList imageList)
</autodoc>
40959 <param name=
"imageList" type=
"ImageList" default=
""/>
40962 <method name=
"AssignImageList" type=
"" overloaded=
"no">
40963 <autodoc>AssignImageList(self, ImageList imageList)
</autodoc>
40965 <param name=
"imageList" type=
"ImageList" default=
""/>
40968 <method name=
"AssignStateImageList" type=
"" overloaded=
"no">
40969 <autodoc>AssignStateImageList(self, ImageList imageList)
</autodoc>
40971 <param name=
"imageList" type=
"ImageList" default=
""/>
40974 <method name=
"AssignButtonsImageList" type=
"" overloaded=
"no">
40975 <autodoc>AssignButtonsImageList(self, ImageList imageList)
</autodoc>
40977 <param name=
"imageList" type=
"ImageList" default=
""/>
40980 <method name=
"AddColumn" type=
"" overloaded=
"no">
40981 <autodoc>AddColumn(self, String text)
</autodoc>
40983 <param name=
"text" type=
"String" default=
""/>
40986 <method name=
"AddColumnInfo" type=
"" overloaded=
"no">
40987 <autodoc>AddColumnInfo(self, TreeListColumnInfo col)
</autodoc>
40989 <param name=
"col" type=
"TreeListColumnInfo" default=
""/>
40992 <method name=
"InsertColumn" type=
"" overloaded=
"no">
40993 <autodoc>InsertColumn(self, size_t before, String text)
</autodoc>
40995 <param name=
"before" type=
"size_t" default=
""/>
40996 <param name=
"text" type=
"String" default=
""/>
40999 <method name=
"InsertColumnInfo" type=
"" overloaded=
"no">
41000 <autodoc>InsertColumnInfo(self, size_t before, TreeListColumnInfo col)
</autodoc>
41002 <param name=
"before" type=
"size_t" default=
""/>
41003 <param name=
"col" type=
"TreeListColumnInfo" default=
""/>
41006 <method name=
"RemoveColumn" type=
"" overloaded=
"no">
41007 <autodoc>RemoveColumn(self, size_t column)
</autodoc>
41009 <param name=
"column" type=
"size_t" default=
""/>
41012 <method name=
"GetColumnCount" type=
"size_t" overloaded=
"no">
41013 <autodoc>GetColumnCount(self) -
> size_t
</autodoc>
41015 <method name=
"SetColumnWidth" type=
"" overloaded=
"no">
41016 <autodoc>SetColumnWidth(self, size_t column, size_t width)
</autodoc>
41018 <param name=
"column" type=
"size_t" default=
""/>
41019 <param name=
"width" type=
"size_t" default=
""/>
41022 <method name=
"GetColumnWidth" type=
"int" overloaded=
"no">
41023 <autodoc>GetColumnWidth(self, size_t column) -
> int
</autodoc>
41025 <param name=
"column" type=
"size_t" default=
""/>
41028 <method name=
"SetMainColumn" type=
"" overloaded=
"no">
41029 <autodoc>SetMainColumn(self, size_t column)
</autodoc>
41031 <param name=
"column" type=
"size_t" default=
""/>
41034 <method name=
"GetMainColumn" type=
"size_t" overloaded=
"no">
41035 <autodoc>GetMainColumn(self) -
> size_t
</autodoc>
41037 <method name=
"SetColumnText" type=
"" overloaded=
"no">
41038 <autodoc>SetColumnText(self, size_t column, String text)
</autodoc>
41040 <param name=
"column" type=
"size_t" default=
""/>
41041 <param name=
"text" type=
"String" default=
""/>
41044 <method name=
"GetColumnText" type=
"String" overloaded=
"no">
41045 <autodoc>GetColumnText(self, size_t column) -
> String
</autodoc>
41047 <param name=
"column" type=
"size_t" default=
""/>
41050 <method name=
"SetColumn" type=
"" overloaded=
"no">
41051 <autodoc>SetColumn(self, size_t column, TreeListColumnInfo info)
</autodoc>
41053 <param name=
"column" type=
"size_t" default=
""/>
41054 <param name=
"info" type=
"TreeListColumnInfo" default=
""/>
41057 <method name=
"GetColumn" type=
"TreeListColumnInfo" overloaded=
"no">
41058 <autodoc>GetColumn(self, size_t column) -
> TreeListColumnInfo
</autodoc>
41060 <param name=
"column" type=
"size_t" default=
""/>
41063 <method name=
"SetColumnAlignment" type=
"" overloaded=
"no">
41064 <autodoc>SetColumnAlignment(self, size_t column, int align)
</autodoc>
41066 <param name=
"column" type=
"size_t" default=
""/>
41067 <param name=
"align" type=
"wxTreeListColumnAlign" default=
""/>
41070 <method name=
"GetColumnAlignment" type=
"wxTreeListColumnAlign" overloaded=
"no">
41071 <autodoc>GetColumnAlignment(self, size_t column) -
> int
</autodoc>
41073 <param name=
"column" type=
"size_t" default=
""/>
41076 <method name=
"SetColumnImage" type=
"" overloaded=
"no">
41077 <autodoc>SetColumnImage(self, size_t column, int image)
</autodoc>
41079 <param name=
"column" type=
"size_t" default=
""/>
41080 <param name=
"image" type=
"int" default=
""/>
41083 <method name=
"GetColumnImage" type=
"int" overloaded=
"no">
41084 <autodoc>GetColumnImage(self, size_t column) -
> int
</autodoc>
41086 <param name=
"column" type=
"size_t" default=
""/>
41089 <method name=
"ShowColumn" type=
"" overloaded=
"no">
41090 <autodoc>ShowColumn(self, size_t column, bool shown)
</autodoc>
41092 <param name=
"column" type=
"size_t" default=
""/>
41093 <param name=
"shown" type=
"bool" default=
""/>
41096 <method name=
"IsColumnShown" type=
"bool" overloaded=
"no">
41097 <autodoc>IsColumnShown(self, size_t column) -
> bool
</autodoc>
41099 <param name=
"column" type=
"size_t" default=
""/>
41102 <method name=
"GetItemText" type=
"String" overloaded=
"no">
41103 <autodoc>GetItemText(self, TreeItemId item, int column=-
1) -
> String
</autodoc>
41105 <param name=
"item" type=
"TreeItemId" default=
""/>
41106 <param name=
"column" type=
"int" default=
"-1"/>
41109 <method name=
"GetItemImage" type=
"int" overloaded=
"no">
41110 <autodoc>GetItemImage(self, TreeItemId item, int column=-
1, int which=TreeItemIcon_Normal) -
> int
</autodoc>
41112 <param name=
"item" type=
"TreeItemId" default=
""/>
41113 <param name=
"column" type=
"int" default=
"-1"/>
41114 <param name=
"which" type=
"wxTreeItemIcon" default=
"wxTreeItemIcon_Normal"/>
41117 <method name=
"SetItemText" type=
"" overloaded=
"no">
41118 <autodoc>SetItemText(self, TreeItemId item, String text, int column=-
1)
</autodoc>
41120 <param name=
"item" type=
"TreeItemId" default=
""/>
41121 <param name=
"text" type=
"String" default=
""/>
41122 <param name=
"column" type=
"int" default=
"-1"/>
41125 <method name=
"SetItemImage" type=
"" overloaded=
"no">
41126 <autodoc>SetItemImage(self, TreeItemId item, int image, int column=-
1, int which=TreeItemIcon_Normal)
</autodoc>
41128 <param name=
"item" type=
"TreeItemId" default=
""/>
41129 <param name=
"image" type=
"int" default=
""/>
41130 <param name=
"column" type=
"int" default=
"-1"/>
41131 <param name=
"which" type=
"wxTreeItemIcon" default=
"wxTreeItemIcon_Normal"/>
41134 <method name=
"GetItemData" type=
"TreeItemData" overloaded=
"no">
41135 <autodoc>GetItemData(self, TreeItemId item) -
> TreeItemData
</autodoc>
41137 <param name=
"item" type=
"TreeItemId" default=
""/>
41140 <method name=
"SetItemData" type=
"" overloaded=
"no">
41141 <autodoc>SetItemData(self, TreeItemId item, TreeItemData data)
</autodoc>
41143 <param name=
"item" type=
"TreeItemId" default=
""/>
41144 <param name=
"data" type=
"TreeItemData" default=
""/>
41147 <method name=
"GetItemPyData" type=
"PyObject" overloaded=
"no">
41148 <autodoc>GetItemPyData(self, TreeItemId item) -
> PyObject
</autodoc>
41150 <param name=
"item" type=
"TreeItemId" default=
""/>
41153 <method name=
"SetItemPyData" type=
"" overloaded=
"no">
41154 <autodoc>SetItemPyData(self, TreeItemId item, PyObject obj)
</autodoc>
41156 <param name=
"item" type=
"TreeItemId" default=
""/>
41157 <param name=
"obj" type=
"PyObject" default=
""/>
41160 <method name=
"SetItemHasChildren" type=
"" overloaded=
"no">
41161 <autodoc>SetItemHasChildren(self, TreeItemId item, bool has=True)
</autodoc>
41163 <param name=
"item" type=
"TreeItemId" default=
""/>
41164 <param name=
"has" type=
"bool" default=
"True"/>
41167 <method name=
"SetItemBold" type=
"" overloaded=
"no">
41168 <autodoc>SetItemBold(self, TreeItemId item, bool bold=True)
</autodoc>
41170 <param name=
"item" type=
"TreeItemId" default=
""/>
41171 <param name=
"bold" type=
"bool" default=
"True"/>
41174 <method name=
"SetItemTextColour" type=
"" overloaded=
"no">
41175 <autodoc>SetItemTextColour(self, TreeItemId item, Colour colour)
</autodoc>
41177 <param name=
"item" type=
"TreeItemId" default=
""/>
41178 <param name=
"colour" type=
"Colour" default=
""/>
41181 <method name=
"SetItemBackgroundColour" type=
"" overloaded=
"no">
41182 <autodoc>SetItemBackgroundColour(self, TreeItemId item, Colour colour)
</autodoc>
41184 <param name=
"item" type=
"TreeItemId" default=
""/>
41185 <param name=
"colour" type=
"Colour" default=
""/>
41188 <method name=
"SetItemFont" type=
"" overloaded=
"no">
41189 <autodoc>SetItemFont(self, TreeItemId item, Font font)
</autodoc>
41191 <param name=
"item" type=
"TreeItemId" default=
""/>
41192 <param name=
"font" type=
"Font" default=
""/>
41195 <method name=
"GetItemBold" type=
"bool" overloaded=
"no">
41196 <autodoc>GetItemBold(self, TreeItemId item) -
> bool
</autodoc>
41198 <param name=
"item" type=
"TreeItemId" default=
""/>
41201 <method name=
"GetItemTextColour" type=
"Colour" overloaded=
"no">
41202 <autodoc>GetItemTextColour(self, TreeItemId item) -
> Colour
</autodoc>
41204 <param name=
"item" type=
"TreeItemId" default=
""/>
41207 <method name=
"GetItemBackgroundColour" type=
"Colour" overloaded=
"no">
41208 <autodoc>GetItemBackgroundColour(self, TreeItemId item) -
> Colour
</autodoc>
41210 <param name=
"item" type=
"TreeItemId" default=
""/>
41213 <method name=
"GetItemFont" type=
"Font" overloaded=
"no">
41214 <autodoc>GetItemFont(self, TreeItemId item) -
> Font
</autodoc>
41216 <param name=
"item" type=
"TreeItemId" default=
""/>
41219 <method name=
"IsVisible" type=
"bool" overloaded=
"no">
41220 <autodoc>IsVisible(self, TreeItemId item) -
> bool
</autodoc>
41222 <param name=
"item" type=
"TreeItemId" default=
""/>
41225 <method name=
"ItemHasChildren" type=
"bool" overloaded=
"no">
41226 <autodoc>ItemHasChildren(self, TreeItemId item) -
> bool
</autodoc>
41228 <param name=
"item" type=
"TreeItemId" default=
""/>
41231 <method name=
"IsExpanded" type=
"bool" overloaded=
"no">
41232 <autodoc>IsExpanded(self, TreeItemId item) -
> bool
</autodoc>
41234 <param name=
"item" type=
"TreeItemId" default=
""/>
41237 <method name=
"IsSelected" type=
"bool" overloaded=
"no">
41238 <autodoc>IsSelected(self, TreeItemId item) -
> bool
</autodoc>
41240 <param name=
"item" type=
"TreeItemId" default=
""/>
41243 <method name=
"IsBold" type=
"bool" overloaded=
"no">
41244 <autodoc>IsBold(self, TreeItemId item) -
> bool
</autodoc>
41246 <param name=
"item" type=
"TreeItemId" default=
""/>
41249 <method name=
"GetChildrenCount" type=
"size_t" overloaded=
"no">
41250 <autodoc>GetChildrenCount(self, TreeItemId item, bool recursively=True) -
> size_t
</autodoc>
41252 <param name=
"item" type=
"TreeItemId" default=
""/>
41253 <param name=
"recursively" type=
"bool" default=
"True"/>
41256 <method name=
"GetRootItem" type=
"TreeItemId" overloaded=
"no">
41257 <autodoc>GetRootItem(self) -
> TreeItemId
</autodoc>
41259 <method name=
"GetSelection" type=
"TreeItemId" overloaded=
"no">
41260 <autodoc>GetSelection(self) -
> TreeItemId
</autodoc>
41262 <method name=
"GetSelections" type=
"PyObject" overloaded=
"no">
41263 <autodoc>GetSelections(self) -
> PyObject
</autodoc>
41265 <method name=
"GetItemParent" type=
"TreeItemId" overloaded=
"no">
41266 <autodoc>GetItemParent(self, TreeItemId item) -
> TreeItemId
</autodoc>
41268 <param name=
"item" type=
"TreeItemId" default=
""/>
41271 <method name=
"GetFirstChild" type=
"PyObject" overloaded=
"no">
41272 <autodoc>GetFirstChild(self, TreeItemId item) -
> PyObject
</autodoc>
41274 <param name=
"item" type=
"TreeItemId" default=
""/>
41277 <method name=
"GetNextChild" type=
"PyObject" overloaded=
"no">
41278 <autodoc>GetNextChild(self, TreeItemId item, void cookie) -
> PyObject
</autodoc>
41280 <param name=
"item" type=
"TreeItemId" default=
""/>
41281 <param name=
"cookie" type=
"" default=
""/>
41284 <method name=
"GetLastChild" type=
"TreeItemId" overloaded=
"no">
41285 <autodoc>GetLastChild(self, TreeItemId item) -
> TreeItemId
</autodoc>
41287 <param name=
"item" type=
"TreeItemId" default=
""/>
41290 <method name=
"GetNextSibling" type=
"TreeItemId" overloaded=
"no">
41291 <autodoc>GetNextSibling(self, TreeItemId item) -
> TreeItemId
</autodoc>
41293 <param name=
"item" type=
"TreeItemId" default=
""/>
41296 <method name=
"GetPrevSibling" type=
"TreeItemId" overloaded=
"no">
41297 <autodoc>GetPrevSibling(self, TreeItemId item) -
> TreeItemId
</autodoc>
41299 <param name=
"item" type=
"TreeItemId" default=
""/>
41302 <method name=
"GetFirstVisibleItem" type=
"TreeItemId" overloaded=
"no">
41303 <autodoc>GetFirstVisibleItem(self) -
> TreeItemId
</autodoc>
41305 <method name=
"GetNextVisible" type=
"TreeItemId" overloaded=
"no">
41306 <autodoc>GetNextVisible(self, TreeItemId item) -
> TreeItemId
</autodoc>
41308 <param name=
"item" type=
"TreeItemId" default=
""/>
41311 <method name=
"GetPrevVisible" type=
"TreeItemId" overloaded=
"no">
41312 <autodoc>GetPrevVisible(self, TreeItemId item) -
> TreeItemId
</autodoc>
41314 <param name=
"item" type=
"TreeItemId" default=
""/>
41317 <method name=
"GetNext" type=
"TreeItemId" overloaded=
"no">
41318 <autodoc>GetNext(self, TreeItemId item) -
> TreeItemId
</autodoc>
41320 <param name=
"item" type=
"TreeItemId" default=
""/>
41323 <method name=
"AddRoot" type=
"TreeItemId" overloaded=
"no">
41324 <autodoc>AddRoot(self, String text, int image=-
1, int selectedImage=-
1, TreeItemData data=None) -
> TreeItemId
</autodoc>
41326 <param name=
"text" type=
"String" default=
""/>
41327 <param name=
"image" type=
"int" default=
"-1"/>
41328 <param name=
"selectedImage" type=
"int" default=
"-1"/>
41329 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
41332 <method name=
"PrependItem" type=
"TreeItemId" overloaded=
"no">
41333 <autodoc>PrependItem(self, TreeItemId parent, String text, int image=-
1, int selectedImage=-
1,
41334 TreeItemData data=None) -
> TreeItemId
</autodoc>
41336 <param name=
"parent" type=
"TreeItemId" default=
""/>
41337 <param name=
"text" type=
"String" default=
""/>
41338 <param name=
"image" type=
"int" default=
"-1"/>
41339 <param name=
"selectedImage" type=
"int" default=
"-1"/>
41340 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
41343 <method name=
"InsertItem" type=
"TreeItemId" overloaded=
"no">
41344 <autodoc>InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text,
41345 int image=-
1, int selectedImage=-
1, TreeItemData data=None) -
> TreeItemId
</autodoc>
41347 <param name=
"parent" type=
"TreeItemId" default=
""/>
41348 <param name=
"idPrevious" type=
"TreeItemId" default=
""/>
41349 <param name=
"text" type=
"String" default=
""/>
41350 <param name=
"image" type=
"int" default=
"-1"/>
41351 <param name=
"selectedImage" type=
"int" default=
"-1"/>
41352 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
41355 <method name=
"InsertItemBefore" type=
"TreeItemId" overloaded=
"no">
41356 <autodoc>InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-
1,
41357 int selectedImage=-
1, TreeItemData data=None) -
> TreeItemId
</autodoc>
41359 <param name=
"parent" type=
"TreeItemId" default=
""/>
41360 <param name=
"index" type=
"size_t" default=
""/>
41361 <param name=
"text" type=
"String" default=
""/>
41362 <param name=
"image" type=
"int" default=
"-1"/>
41363 <param name=
"selectedImage" type=
"int" default=
"-1"/>
41364 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
41367 <method name=
"AppendItem" type=
"TreeItemId" overloaded=
"no">
41368 <autodoc>AppendItem(self, TreeItemId parent, String text, int image=-
1, int selectedImage=-
1,
41369 TreeItemData data=None) -
> TreeItemId
</autodoc>
41371 <param name=
"parent" type=
"TreeItemId" default=
""/>
41372 <param name=
"text" type=
"String" default=
""/>
41373 <param name=
"image" type=
"int" default=
"-1"/>
41374 <param name=
"selectedImage" type=
"int" default=
"-1"/>
41375 <param name=
"data" type=
"TreeItemData" default=
"NULL"/>
41378 <method name=
"Delete" type=
"" overloaded=
"no">
41379 <autodoc>Delete(self, TreeItemId item)
</autodoc>
41381 <param name=
"item" type=
"TreeItemId" default=
""/>
41384 <method name=
"DeleteChildren" type=
"" overloaded=
"no">
41385 <autodoc>DeleteChildren(self, TreeItemId item)
</autodoc>
41387 <param name=
"item" type=
"TreeItemId" default=
""/>
41390 <method name=
"DeleteAllItems" type=
"" overloaded=
"no">
41391 <autodoc>DeleteAllItems(self)
</autodoc>
41393 <method name=
"Expand" type=
"" overloaded=
"no">
41394 <autodoc>Expand(self, TreeItemId item)
</autodoc>
41396 <param name=
"item" type=
"TreeItemId" default=
""/>
41399 <method name=
"ExpandAll" type=
"" overloaded=
"no">
41400 <autodoc>ExpandAll(self, TreeItemId item)
</autodoc>
41402 <param name=
"item" type=
"TreeItemId" default=
""/>
41405 <method name=
"Collapse" type=
"" overloaded=
"no">
41406 <autodoc>Collapse(self, TreeItemId item)
</autodoc>
41408 <param name=
"item" type=
"TreeItemId" default=
""/>
41411 <method name=
"CollapseAndReset" type=
"" overloaded=
"no">
41412 <autodoc>CollapseAndReset(self, TreeItemId item)
</autodoc>
41414 <param name=
"item" type=
"TreeItemId" default=
""/>
41417 <method name=
"Toggle" type=
"" overloaded=
"no">
41418 <autodoc>Toggle(self, TreeItemId item)
</autodoc>
41420 <param name=
"item" type=
"TreeItemId" default=
""/>
41423 <method name=
"Unselect" type=
"" overloaded=
"no">
41424 <autodoc>Unselect(self)
</autodoc>
41426 <method name=
"UnselectAll" type=
"" overloaded=
"no">
41427 <autodoc>UnselectAll(self)
</autodoc>
41429 <method name=
"SelectItem" type=
"" overloaded=
"no">
41430 <autodoc>SelectItem(self, TreeItemId item, bool unselect_others=True, bool extended_select=False)
</autodoc>
41432 <param name=
"item" type=
"TreeItemId" default=
""/>
41433 <param name=
"unselect_others" type=
"bool" default=
"True"/>
41434 <param name=
"extended_select" type=
"bool" default=
"False"/>
41437 <method name=
"SelectAll" type=
"" overloaded=
"no">
41438 <autodoc>SelectAll(self, bool extended_select=False)
</autodoc>
41440 <param name=
"extended_select" type=
"bool" default=
"False"/>
41443 <method name=
"EnsureVisible" type=
"" overloaded=
"no">
41444 <autodoc>EnsureVisible(self, TreeItemId item)
</autodoc>
41446 <param name=
"item" type=
"TreeItemId" default=
""/>
41449 <method name=
"ScrollTo" type=
"" overloaded=
"no">
41450 <autodoc>ScrollTo(self, TreeItemId item)
</autodoc>
41452 <param name=
"item" type=
"TreeItemId" default=
""/>
41455 <method name=
"HitTest" type=
"TreeItemId" overloaded=
"no">
41456 <autodoc>HitTest(self, Point point, int OUTPUT, int OUTPUT) -
> TreeItemId
</autodoc>
41458 <param name=
"point" type=
"Point" default=
""/>
41459 <param name=
"OUTPUT" type=
"int" default=
""/>
41460 <param name=
"OUTPUT" type=
"int" default=
""/>
41463 <method name=
"GetBoundingRect" type=
"PyObject" overloaded=
"no">
41464 <autodoc>GetBoundingRect(self, TreeItemId item, bool textOnly=False) -
> PyObject
</autodoc>
41466 <param name=
"item" type=
"TreeItemId" default=
""/>
41467 <param name=
"textOnly" type=
"bool" default=
"False"/>
41470 <method name=
"EditLabel" type=
"" overloaded=
"no">
41471 <autodoc>EditLabel(self, TreeItemId item)
</autodoc>
41473 <param name=
"item" type=
"TreeItemId" default=
""/>
41476 <method name=
"Edit" type=
"" overloaded=
"no">
41477 <autodoc>Edit(self, TreeItemId item)
</autodoc>
41479 <param name=
"item" type=
"TreeItemId" default=
""/>
41482 <method name=
"SortChildren" type=
"" overloaded=
"no">
41483 <autodoc>SortChildren(self, TreeItemId item)
</autodoc>
41485 <param name=
"item" type=
"TreeItemId" default=
""/>
41488 <method name=
"FindItem" type=
"TreeItemId" overloaded=
"no">
41489 <autodoc>FindItem(self, TreeItemId item, String str, int flags=
0) -
> TreeItemId
</autodoc>
41491 <param name=
"item" type=
"TreeItemId" default=
""/>
41492 <param name=
"str" type=
"String" default=
""/>
41493 <param name=
"flags" type=
"int" default=
"0"/>
41496 <method name=
"GetHeaderWindow" type=
"Window" overloaded=
"no">
41497 <autodoc>GetHeaderWindow(self) -
> Window
</autodoc>
41499 <method name=
"GetMainWindow" type=
"ScrolledWindow" overloaded=
"no">
41500 <autodoc>GetMainWindow(self) -
> ScrolledWindow
</autodoc>
41504 </wxPython-metadata>