]>
Commit | Line | Data |
---|---|---|
f32fc4bc | 1 | <?xml version="1.0"?> |
0f43fbdf | 2 | <wxPython-metadata> |
781d2982 | 3 | <module name="_core"> |
f32fc4bc | 4 | <pythoncode> |
0f43fbdf RD |
5 | #// Give a reference to the dictionary of this module to the C++ extension |
6 | #// code. | |
781d2982 | 7 | _core_._wxPySetDictionary(vars()) |
0f43fbdf RD |
8 | |
9 | #// A little trick to make 'wx' be a reference to this module so wx.Names can | |
10 | #// be used here. | |
11 | import sys as _sys | |
12 | wx = _sys.modules[__name__] | |
781d2982 RD |
13 | |
14 | </pythoncode> | |
15 | <pythoncode> | |
16 | #---------------------------------------------------------------------------- | |
17 | ||
18 | def _deprecated(callable, msg=None): | |
19 | """ | |
20 | Create a wrapper function that will raise a DeprecationWarning | |
21 | before calling the callable. | |
22 | """ | |
23 | if msg is None: | |
24 | msg = "%s is deprecated" % callable | |
25 | def deprecatedWrapper(*args, **kwargs): | |
26 | import warnings | |
27 | warnings.warn(msg, DeprecationWarning, stacklevel=2) | |
28 | return callable(*args, **kwargs) | |
29 | deprecatedWrapper.__doc__ = msg | |
30 | return deprecatedWrapper | |
31 | ||
32 | ||
33 | #---------------------------------------------------------------------------- | |
0f43fbdf | 34 | </pythoncode> |
f32fc4bc | 35 | <pythoncode> |
0f43fbdf RD |
36 | #--------------------------------------------------------------------------- |
37 | </pythoncode> | |
781d2982 | 38 | <class name="Object" oldname="wxObject" module="_core"> |
f32fc4bc | 39 | <docstring>The base class for most wx objects, although in wxPython not |
0f43fbdf | 40 | much functionality is needed nor exposed.</docstring> |
f32fc4bc | 41 | <method name="GetClassName" type="String" overloaded="no"> |
781d2982 RD |
42 | <autodoc>GetClassName(self) -> String</autodoc> |
43 | <docstring>Returns the class name of the C++ class using wxRTTI.</docstring> | |
f32fc4bc RD |
44 | </method> |
45 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 46 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
47 | <docstring>Deletes the C++ object this Python object is a proxy for.</docstring> |
48 | </method> | |
49 | </class> | |
50 | <pythoncode> | |
0f43fbdf RD |
51 | #--------------------------------------------------------------------------- |
52 | </pythoncode> | |
f32fc4bc | 53 | <pythoncode> |
0f43fbdf RD |
54 | #--------------------------------------------------------------------------- |
55 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc | 61 | <constructor name="Size" overloaded="no"> |
781d2982 | 62 | <autodoc>__init__(self, int w=0, int h=0) -> Size</autodoc> |
f32fc4bc RD |
63 | <docstring>Creates a size object.</docstring> |
64 | <paramlist> | |
65 | <param name="w" type="int" default="0"/> | |
66 | <param name="h" type="int" default="0"/> | |
67 | </paramlist> | |
68 | </constructor> | |
69 | <destructor name="~wxSize" overloaded="no"> | |
781d2982 | 70 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
71 | </destructor> |
72 | <property name="width" type="int" readonly="no"/> | |
73 | <property name="height" type="int" readonly="no"/> | |
74 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 75 | <autodoc>__eq__(self, Size sz) -> bool</autodoc> |
f32fc4bc RD |
76 | <docstring>Test for equality of wx.Size objects.</docstring> |
77 | <paramlist> | |
78 | <param name="sz" type="Size" default=""/> | |
79 | </paramlist> | |
80 | </method> | |
81 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 82 | <autodoc>__ne__(self, Size sz) -> bool</autodoc> |
f32fc4bc RD |
83 | <docstring>Test for inequality.</docstring> |
84 | <paramlist> | |
85 | <param name="sz" type="Size" default=""/> | |
86 | </paramlist> | |
87 | </method> | |
88 | <method name="__add__" type="Size" overloaded="no"> | |
781d2982 | 89 | <autodoc>__add__(self, Size sz) -> Size</autodoc> |
f32fc4bc RD |
90 | <docstring>Add sz's proprties to this and return the result.</docstring> |
91 | <paramlist> | |
92 | <param name="sz" type="Size" default=""/> | |
93 | </paramlist> | |
94 | </method> | |
95 | <method name="__sub__" type="Size" overloaded="no"> | |
781d2982 | 96 | <autodoc>__sub__(self, Size sz) -> Size</autodoc> |
f32fc4bc RD |
97 | <docstring>Subtract sz's properties from this and return the result.</docstring> |
98 | <paramlist> | |
99 | <param name="sz" type="Size" default=""/> | |
100 | </paramlist> | |
101 | </method> | |
102 | <method name="IncTo" type="" overloaded="no"> | |
781d2982 | 103 | <autodoc>IncTo(self, Size sz)</autodoc> |
f32fc4bc | 104 | <docstring>Increments this object so that both of its dimensions are not less |
0f43fbdf | 105 | than the corresponding dimensions of the size.</docstring> |
f32fc4bc RD |
106 | <paramlist> |
107 | <param name="sz" type="Size" default=""/> | |
108 | </paramlist> | |
109 | </method> | |
110 | <method name="DecTo" type="" overloaded="no"> | |
781d2982 | 111 | <autodoc>DecTo(self, Size sz)</autodoc> |
f32fc4bc | 112 | <docstring>Decrements this object so that both of its dimensions are not greater |
0f43fbdf | 113 | than the corresponding dimensions of the size.</docstring> |
f32fc4bc RD |
114 | <paramlist> |
115 | <param name="sz" type="Size" default=""/> | |
116 | </paramlist> | |
117 | </method> | |
118 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 119 | <autodoc>Set(self, int w, int h)</autodoc> |
f32fc4bc RD |
120 | <docstring>Set both width and height.</docstring> |
121 | <paramlist> | |
122 | <param name="w" type="int" default=""/> | |
123 | <param name="h" type="int" default=""/> | |
124 | </paramlist> | |
125 | </method> | |
126 | <method name="SetWidth" type="" overloaded="no"> | |
781d2982 | 127 | <autodoc>SetWidth(self, int w)</autodoc> |
f32fc4bc RD |
128 | <paramlist> |
129 | <param name="w" type="int" default=""/> | |
130 | </paramlist> | |
131 | </method> | |
132 | <method name="SetHeight" type="" overloaded="no"> | |
781d2982 | 133 | <autodoc>SetHeight(self, int h)</autodoc> |
f32fc4bc RD |
134 | <paramlist> |
135 | <param name="h" type="int" default=""/> | |
136 | </paramlist> | |
137 | </method> | |
138 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 139 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
140 | </method> |
141 | <method name="GetHeight" type="int" overloaded="no"> | |
781d2982 RD |
142 | <autodoc>GetHeight(self) -> int</autodoc> |
143 | </method> | |
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> | |
147 | </method> | |
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> | |
152 | <paramlist> | |
153 | <param name="size" type="Size" default=""/> | |
154 | </paramlist> | |
f32fc4bc RD |
155 | </method> |
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> | |
159 | </method> | |
160 | </class> | |
0dd25e81 | 161 | <pythoncode> |
0f43fbdf RD |
162 | #--------------------------------------------------------------------------- |
163 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc | 168 | <constructor name="RealPoint" overloaded="no"> |
781d2982 | 169 | <autodoc>__init__(self, double x=0.0, double y=0.0) -> RealPoint</autodoc> |
f32fc4bc RD |
170 | <docstring>Create a wx.RealPoint object</docstring> |
171 | <paramlist> | |
172 | <param name="x" type="double" default="0.0"/> | |
173 | <param name="y" type="double" default="0.0"/> | |
174 | </paramlist> | |
175 | </constructor> | |
176 | <destructor name="~wxRealPoint" overloaded="no"> | |
781d2982 | 177 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
178 | </destructor> |
179 | <property name="x" type="double" readonly="no"/> | |
180 | <property name="y" type="double" readonly="no"/> | |
181 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 182 | <autodoc>__eq__(self, RealPoint pt) -> bool</autodoc> |
f32fc4bc RD |
183 | <docstring>Test for equality of wx.RealPoint objects.</docstring> |
184 | <paramlist> | |
185 | <param name="pt" type="RealPoint" default=""/> | |
186 | </paramlist> | |
187 | </method> | |
188 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 189 | <autodoc>__ne__(self, RealPoint pt) -> bool</autodoc> |
f32fc4bc RD |
190 | <docstring>Test for inequality of wx.RealPoint objects.</docstring> |
191 | <paramlist> | |
192 | <param name="pt" type="RealPoint" default=""/> | |
193 | </paramlist> | |
194 | </method> | |
195 | <method name="__add__" type="RealPoint" overloaded="no"> | |
781d2982 | 196 | <autodoc>__add__(self, RealPoint pt) -> RealPoint</autodoc> |
f32fc4bc RD |
197 | <docstring>Add pt's proprties to this and return the result.</docstring> |
198 | <paramlist> | |
199 | <param name="pt" type="RealPoint" default=""/> | |
200 | </paramlist> | |
201 | </method> | |
202 | <method name="__sub__" type="RealPoint" overloaded="no"> | |
781d2982 | 203 | <autodoc>__sub__(self, RealPoint pt) -> RealPoint</autodoc> |
f32fc4bc RD |
204 | <docstring>Subtract pt's proprties from this and return the result</docstring> |
205 | <paramlist> | |
206 | <param name="pt" type="RealPoint" default=""/> | |
207 | </paramlist> | |
208 | </method> | |
209 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 210 | <autodoc>Set(self, double x, double y)</autodoc> |
f32fc4bc RD |
211 | <docstring>Set both the x and y properties</docstring> |
212 | <paramlist> | |
213 | <param name="x" type="double" default=""/> | |
214 | <param name="y" type="double" default=""/> | |
215 | </paramlist> | |
216 | </method> | |
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> | |
220 | </method> | |
221 | </class> | |
0dd25e81 | 222 | <pythoncode> |
0f43fbdf RD |
223 | #--------------------------------------------------------------------------- |
224 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc | 229 | <constructor name="Point" overloaded="no"> |
781d2982 | 230 | <autodoc>__init__(self, int x=0, int y=0) -> Point</autodoc> |
f32fc4bc RD |
231 | <docstring>Create a wx.Point object</docstring> |
232 | <paramlist> | |
233 | <param name="x" type="int" default="0"/> | |
234 | <param name="y" type="int" default="0"/> | |
235 | </paramlist> | |
236 | </constructor> | |
237 | <destructor name="~wxPoint" overloaded="no"> | |
781d2982 | 238 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
239 | </destructor> |
240 | <property name="x" type="int" readonly="no"/> | |
241 | <property name="y" type="int" readonly="no"/> | |
242 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 243 | <autodoc>__eq__(self, Point pt) -> bool</autodoc> |
f32fc4bc RD |
244 | <docstring>Test for equality of wx.Point objects.</docstring> |
245 | <paramlist> | |
246 | <param name="pt" type="Point" default=""/> | |
247 | </paramlist> | |
248 | </method> | |
249 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 250 | <autodoc>__ne__(self, Point pt) -> bool</autodoc> |
f32fc4bc RD |
251 | <docstring>Test for inequality of wx.Point objects.</docstring> |
252 | <paramlist> | |
253 | <param name="pt" type="Point" default=""/> | |
254 | </paramlist> | |
255 | </method> | |
256 | <method name="__add__" type="Point" overloaded="no"> | |
781d2982 | 257 | <autodoc>__add__(self, Point pt) -> Point</autodoc> |
f32fc4bc RD |
258 | <docstring>Add pt's proprties to this and return the result.</docstring> |
259 | <paramlist> | |
260 | <param name="pt" type="Point" default=""/> | |
261 | </paramlist> | |
262 | </method> | |
263 | <method name="__sub__" type="Point" overloaded="no"> | |
781d2982 | 264 | <autodoc>__sub__(self, Point pt) -> Point</autodoc> |
f32fc4bc RD |
265 | <docstring>Subtract pt's proprties from this and return the result</docstring> |
266 | <paramlist> | |
267 | <param name="pt" type="Point" default=""/> | |
268 | </paramlist> | |
269 | </method> | |
270 | <method name="__iadd__" type="Point" overloaded="no"> | |
781d2982 | 271 | <autodoc>__iadd__(self, Point pt) -> Point</autodoc> |
f32fc4bc RD |
272 | <docstring>Add pt to this object.</docstring> |
273 | <paramlist> | |
274 | <param name="pt" type="Point" default=""/> | |
275 | </paramlist> | |
276 | </method> | |
277 | <method name="__isub__" type="Point" overloaded="no"> | |
781d2982 | 278 | <autodoc>__isub__(self, Point pt) -> Point</autodoc> |
f32fc4bc RD |
279 | <docstring>Subtract pt from this object.</docstring> |
280 | <paramlist> | |
281 | <param name="pt" type="Point" default=""/> | |
282 | </paramlist> | |
283 | </method> | |
284 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 285 | <autodoc>Set(self, long x, long y)</autodoc> |
f32fc4bc RD |
286 | <docstring>Set both the x and y properties</docstring> |
287 | <paramlist> | |
288 | <param name="x" type="long" default=""/> | |
289 | <param name="y" type="long" default=""/> | |
290 | </paramlist> | |
291 | </method> | |
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> | |
295 | </method> | |
296 | </class> | |
0dd25e81 | 297 | <pythoncode> |
0f43fbdf RD |
298 | #--------------------------------------------------------------------------- |
299 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc | 304 | <constructor name="Rect" overloaded="no"> |
781d2982 | 305 | <autodoc>__init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect</autodoc> |
f32fc4bc RD |
306 | <docstring>Create a new Rect object.</docstring> |
307 | <paramlist> | |
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"/> | |
312 | </paramlist> | |
313 | </constructor> | |
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> | |
317 | <paramlist> | |
318 | <param name="topLeft" type="Point" default=""/> | |
319 | <param name="bottomRight" type="Point" default=""/> | |
320 | </paramlist> | |
321 | </constructor> | |
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> | |
325 | <paramlist> | |
326 | <param name="pos" type="Point" default=""/> | |
327 | <param name="size" type="Size" default=""/> | |
328 | </paramlist> | |
329 | </constructor> | |
330 | <destructor name="~wxRect" overloaded="no"> | |
781d2982 | 331 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
332 | </destructor> |
333 | <method name="GetX" type="int" overloaded="no"> | |
781d2982 | 334 | <autodoc>GetX(self) -> int</autodoc> |
f32fc4bc RD |
335 | </method> |
336 | <method name="SetX" type="" overloaded="no"> | |
781d2982 | 337 | <autodoc>SetX(self, int x)</autodoc> |
f32fc4bc RD |
338 | <paramlist> |
339 | <param name="x" type="int" default=""/> | |
340 | </paramlist> | |
341 | </method> | |
342 | <method name="GetY" type="int" overloaded="no"> | |
781d2982 | 343 | <autodoc>GetY(self) -> int</autodoc> |
f32fc4bc RD |
344 | </method> |
345 | <method name="SetY" type="" overloaded="no"> | |
781d2982 | 346 | <autodoc>SetY(self, int y)</autodoc> |
f32fc4bc RD |
347 | <paramlist> |
348 | <param name="y" type="int" default=""/> | |
349 | </paramlist> | |
350 | </method> | |
351 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 352 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
353 | </method> |
354 | <method name="SetWidth" type="" overloaded="no"> | |
781d2982 | 355 | <autodoc>SetWidth(self, int w)</autodoc> |
f32fc4bc RD |
356 | <paramlist> |
357 | <param name="w" type="int" default=""/> | |
358 | </paramlist> | |
359 | </method> | |
360 | <method name="GetHeight" type="int" overloaded="no"> | |
781d2982 | 361 | <autodoc>GetHeight(self) -> int</autodoc> |
f32fc4bc RD |
362 | </method> |
363 | <method name="SetHeight" type="" overloaded="no"> | |
781d2982 | 364 | <autodoc>SetHeight(self, int h)</autodoc> |
f32fc4bc RD |
365 | <paramlist> |
366 | <param name="h" type="int" default=""/> | |
367 | </paramlist> | |
368 | </method> | |
369 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 370 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
371 | </method> |
372 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 373 | <autodoc>SetPosition(self, Point p)</autodoc> |
f32fc4bc RD |
374 | <paramlist> |
375 | <param name="p" type="Point" default=""/> | |
376 | </paramlist> | |
377 | </method> | |
378 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 | 379 | <autodoc>GetSize(self) -> Size</autodoc> |
f32fc4bc RD |
380 | </method> |
381 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 382 | <autodoc>SetSize(self, Size s)</autodoc> |
f32fc4bc RD |
383 | <paramlist> |
384 | <param name="s" type="Size" default=""/> | |
385 | </paramlist> | |
386 | </method> | |
387 | <method name="GetTopLeft" type="Point" overloaded="no"> | |
781d2982 | 388 | <autodoc>GetTopLeft(self) -> Point</autodoc> |
f32fc4bc RD |
389 | </method> |
390 | <method name="SetTopLeft" type="" overloaded="no"> | |
781d2982 | 391 | <autodoc>SetTopLeft(self, Point p)</autodoc> |
f32fc4bc RD |
392 | <paramlist> |
393 | <param name="p" type="Point" default=""/> | |
394 | </paramlist> | |
395 | </method> | |
396 | <method name="GetBottomRight" type="Point" overloaded="no"> | |
781d2982 | 397 | <autodoc>GetBottomRight(self) -> Point</autodoc> |
f32fc4bc RD |
398 | </method> |
399 | <method name="SetBottomRight" type="" overloaded="no"> | |
781d2982 | 400 | <autodoc>SetBottomRight(self, Point p)</autodoc> |
f32fc4bc RD |
401 | <paramlist> |
402 | <param name="p" type="Point" default=""/> | |
403 | </paramlist> | |
404 | </method> | |
405 | <method name="GetLeft" type="int" overloaded="no"> | |
781d2982 | 406 | <autodoc>GetLeft(self) -> int</autodoc> |
f32fc4bc RD |
407 | </method> |
408 | <method name="GetTop" type="int" overloaded="no"> | |
781d2982 | 409 | <autodoc>GetTop(self) -> int</autodoc> |
f32fc4bc RD |
410 | </method> |
411 | <method name="GetBottom" type="int" overloaded="no"> | |
781d2982 | 412 | <autodoc>GetBottom(self) -> int</autodoc> |
f32fc4bc RD |
413 | </method> |
414 | <method name="GetRight" type="int" overloaded="no"> | |
781d2982 | 415 | <autodoc>GetRight(self) -> int</autodoc> |
f32fc4bc RD |
416 | </method> |
417 | <method name="SetLeft" type="" overloaded="no"> | |
781d2982 | 418 | <autodoc>SetLeft(self, int left)</autodoc> |
f32fc4bc RD |
419 | <paramlist> |
420 | <param name="left" type="int" default=""/> | |
421 | </paramlist> | |
422 | </method> | |
423 | <method name="SetRight" type="" overloaded="no"> | |
781d2982 | 424 | <autodoc>SetRight(self, int right)</autodoc> |
f32fc4bc RD |
425 | <paramlist> |
426 | <param name="right" type="int" default=""/> | |
427 | </paramlist> | |
428 | </method> | |
429 | <method name="SetTop" type="" overloaded="no"> | |
781d2982 | 430 | <autodoc>SetTop(self, int top)</autodoc> |
f32fc4bc RD |
431 | <paramlist> |
432 | <param name="top" type="int" default=""/> | |
433 | </paramlist> | |
434 | </method> | |
435 | <method name="SetBottom" type="" overloaded="no"> | |
781d2982 | 436 | <autodoc>SetBottom(self, int bottom)</autodoc> |
f32fc4bc RD |
437 | <paramlist> |
438 | <param name="bottom" type="int" default=""/> | |
439 | </paramlist> | |
440 | </method> | |
441 | <method name="Inflate" type="Rect" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
446 | <paramlist> |
447 | <param name="dx" type="int" default=""/> | |
448 | <param name="dy" type="int" default=""/> | |
449 | </paramlist> | |
450 | </method> | |
451 | <method name="Deflate" type="Rect" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
456 | <paramlist> |
457 | <param name="dx" type="int" default=""/> | |
458 | <param name="dy" type="int" default=""/> | |
459 | </paramlist> | |
460 | </method> | |
461 | <method name="OffsetXY" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
466 | <paramlist> |
467 | <param name="dx" type="int" default=""/> | |
468 | <param name="dy" type="int" default=""/> | |
469 | </paramlist> | |
470 | </method> | |
471 | <method name="Offset" type="" overloaded="no"> | |
781d2982 | 472 | <autodoc>Offset(self, Point pt)</autodoc> |
f32fc4bc RD |
473 | <docstring>Same as OffsetXY but uses dx,dy from Point</docstring> |
474 | <paramlist> | |
475 | <param name="pt" type="Point" default=""/> | |
476 | </paramlist> | |
477 | </method> | |
478 | <method name="Intersect" type="Rect" overloaded="no"> | |
781d2982 | 479 | <autodoc>Intersect(self, Rect rect) -> Rect</autodoc> |
f32fc4bc RD |
480 | <docstring>Return the intersectsion of this rectangle and rect.</docstring> |
481 | <paramlist> | |
482 | <param name="rect" type="Rect" default=""/> | |
483 | </paramlist> | |
484 | </method> | |
485 | <method name="__add__" type="Rect" overloaded="no"> | |
781d2982 | 486 | <autodoc>__add__(self, Rect rect) -> Rect</autodoc> |
f32fc4bc RD |
487 | <docstring>Add the properties of rect to this rectangle and return the result.</docstring> |
488 | <paramlist> | |
489 | <param name="rect" type="Rect" default=""/> | |
490 | </paramlist> | |
491 | </method> | |
492 | <method name="__iadd__" type="Rect" overloaded="no"> | |
781d2982 | 493 | <autodoc>__iadd__(self, Rect rect) -> Rect</autodoc> |
f32fc4bc RD |
494 | <docstring>Add the properties of rect to this rectangle, updating this rectangle.</docstring> |
495 | <paramlist> | |
496 | <param name="rect" type="Rect" default=""/> | |
497 | </paramlist> | |
498 | </method> | |
499 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 500 | <autodoc>__eq__(self, Rect rect) -> bool</autodoc> |
f32fc4bc RD |
501 | <docstring>Test for equality.</docstring> |
502 | <paramlist> | |
503 | <param name="rect" type="Rect" default=""/> | |
504 | </paramlist> | |
505 | </method> | |
506 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 507 | <autodoc>__ne__(self, Rect rect) -> bool</autodoc> |
f32fc4bc RD |
508 | <docstring>Test for inequality.</docstring> |
509 | <paramlist> | |
510 | <param name="rect" type="Rect" default=""/> | |
511 | </paramlist> | |
512 | </method> | |
513 | <method name="InsideXY" type="bool" overloaded="no"> | |
781d2982 | 514 | <autodoc>InsideXY(self, int x, int y) -> bool</autodoc> |
f32fc4bc RD |
515 | <docstring>Return True if the point is (not strcitly) inside the rect.</docstring> |
516 | <paramlist> | |
517 | <param name="x" type="int" default=""/> | |
518 | <param name="y" type="int" default=""/> | |
519 | </paramlist> | |
520 | </method> | |
521 | <method name="Inside" type="bool" overloaded="no"> | |
781d2982 | 522 | <autodoc>Inside(self, Point pt) -> bool</autodoc> |
f32fc4bc RD |
523 | <docstring>Return True if the point is (not strcitly) inside the rect.</docstring> |
524 | <paramlist> | |
525 | <param name="pt" type="Point" default=""/> | |
526 | </paramlist> | |
527 | </method> | |
528 | <method name="Intersects" type="bool" overloaded="no"> | |
781d2982 | 529 | <autodoc>Intersects(self, Rect rect) -> bool</autodoc> |
f32fc4bc RD |
530 | <docstring>Returns True if the rectangles have a non empty intersection.</docstring> |
531 | <paramlist> | |
532 | <param name="rect" type="Rect" default=""/> | |
533 | </paramlist> | |
534 | </method> | |
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"> | |
781d2982 | 540 | <autodoc>Set(self, int x=0, int y=0, int width=0, int height=0)</autodoc> |
f32fc4bc RD |
541 | <docstring>Set all rectangle properties.</docstring> |
542 | <paramlist> | |
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"/> | |
547 | </paramlist> | |
548 | </method> | |
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> | |
552 | </method> | |
553 | </class> | |
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> | |
557 | <paramlist> | |
558 | <param name="r1" type="Rect" default=""/> | |
559 | <param name="r2" type="Rect" default=""/> | |
856bf319 RD |
560 | </paramlist> |
561 | </method> | |
0dd25e81 | 562 | <pythoncode> |
0f43fbdf RD |
563 | #--------------------------------------------------------------------------- |
564 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc | 568 | <constructor name="Point2D" overloaded="no"> |
781d2982 | 569 | <autodoc>__init__(self, double x=0.0, double y=0.0) -> Point2D</autodoc> |
f32fc4bc RD |
570 | <docstring>Create a w.Point2D object.</docstring> |
571 | <paramlist> | |
572 | <param name="x" type="double" default="0.0"/> | |
573 | <param name="y" type="double" default="0.0"/> | |
574 | </paramlist> | |
575 | </constructor> | |
576 | <constructor name="Point2DCopy" overloaded="no"> | |
577 | <autodoc>Point2DCopy(Point2D pt) -> Point2D</autodoc> | |
578 | <docstring>Create a w.Point2D object.</docstring> | |
579 | <paramlist> | |
580 | <param name="pt" type="Point2D" default=""/> | |
581 | </paramlist> | |
582 | </constructor> | |
583 | <constructor name="Point2DFromPoint" overloaded="no"> | |
584 | <autodoc>Point2DFromPoint(Point pt) -> Point2D</autodoc> | |
585 | <docstring>Create a w.Point2D object.</docstring> | |
586 | <paramlist> | |
587 | <param name="pt" type="Point" default=""/> | |
588 | </paramlist> | |
589 | </constructor> | |
590 | <method name="GetFloor" type="" overloaded="no"> | |
591 | <autodoc>GetFloor() -> (x,y)</autodoc> | |
ce6878e6 | 592 | <docstring>Convert to integer</docstring> |
f32fc4bc RD |
593 | <paramlist> |
594 | <param name="OUTPUT" type="int" default=""/> | |
595 | <param name="OUTPUT" type="int" default=""/> | |
596 | </paramlist> | |
597 | </method> | |
598 | <method name="GetRounded" type="" overloaded="no"> | |
599 | <autodoc>GetRounded() -> (x,y)</autodoc> | |
ce6878e6 | 600 | <docstring>Convert to integer</docstring> |
f32fc4bc RD |
601 | <paramlist> |
602 | <param name="OUTPUT" type="int" default=""/> | |
603 | <param name="OUTPUT" type="int" default=""/> | |
604 | </paramlist> | |
605 | </method> | |
606 | <method name="GetVectorLength" type="double" overloaded="no"> | |
781d2982 | 607 | <autodoc>GetVectorLength(self) -> double</autodoc> |
f32fc4bc RD |
608 | </method> |
609 | <method name="GetVectorAngle" type="double" overloaded="no"> | |
781d2982 | 610 | <autodoc>GetVectorAngle(self) -> double</autodoc> |
f32fc4bc RD |
611 | </method> |
612 | <method name="SetVectorLength" type="" overloaded="no"> | |
781d2982 | 613 | <autodoc>SetVectorLength(self, double length)</autodoc> |
f32fc4bc RD |
614 | <paramlist> |
615 | <param name="length" type="double" default=""/> | |
616 | </paramlist> | |
617 | </method> | |
618 | <method name="SetVectorAngle" type="" overloaded="no"> | |
781d2982 | 619 | <autodoc>SetVectorAngle(self, double degrees)</autodoc> |
f32fc4bc RD |
620 | <paramlist> |
621 | <param name="degrees" type="double" default=""/> | |
622 | </paramlist> | |
623 | </method> | |
624 | <method name="GetDistance" type="double" overloaded="no"> | |
781d2982 | 625 | <autodoc>GetDistance(self, Point2D pt) -> double</autodoc> |
f32fc4bc RD |
626 | <paramlist> |
627 | <param name="pt" type="Point2D" default=""/> | |
628 | </paramlist> | |
629 | </method> | |
630 | <method name="GetDistanceSquare" type="double" overloaded="no"> | |
781d2982 | 631 | <autodoc>GetDistanceSquare(self, Point2D pt) -> double</autodoc> |
f32fc4bc RD |
632 | <paramlist> |
633 | <param name="pt" type="Point2D" default=""/> | |
634 | </paramlist> | |
635 | </method> | |
636 | <method name="GetDotProduct" type="double" overloaded="no"> | |
781d2982 | 637 | <autodoc>GetDotProduct(self, Point2D vec) -> double</autodoc> |
f32fc4bc RD |
638 | <paramlist> |
639 | <param name="vec" type="Point2D" default=""/> | |
640 | </paramlist> | |
641 | </method> | |
642 | <method name="GetCrossProduct" type="double" overloaded="no"> | |
781d2982 | 643 | <autodoc>GetCrossProduct(self, Point2D vec) -> double</autodoc> |
f32fc4bc RD |
644 | <paramlist> |
645 | <param name="vec" type="Point2D" default=""/> | |
646 | </paramlist> | |
647 | </method> | |
648 | <method name="__neg__" type="Point2D" overloaded="no"> | |
781d2982 | 649 | <autodoc>__neg__(self) -> Point2D</autodoc> |
f32fc4bc RD |
650 | <docstring>the reflection of this point</docstring> |
651 | </method> | |
652 | <method name="__iadd__" type="Point2D" overloaded="no"> | |
781d2982 | 653 | <autodoc>__iadd__(self, Point2D pt) -> Point2D</autodoc> |
f32fc4bc RD |
654 | <paramlist> |
655 | <param name="pt" type="Point2D" default=""/> | |
656 | </paramlist> | |
657 | </method> | |
658 | <method name="__isub__" type="Point2D" overloaded="no"> | |
781d2982 | 659 | <autodoc>__isub__(self, Point2D pt) -> Point2D</autodoc> |
f32fc4bc RD |
660 | <paramlist> |
661 | <param name="pt" type="Point2D" default=""/> | |
662 | </paramlist> | |
663 | </method> | |
664 | <method name="__imul__" type="Point2D" overloaded="no"> | |
781d2982 | 665 | <autodoc>__imul__(self, Point2D pt) -> Point2D</autodoc> |
f32fc4bc RD |
666 | <paramlist> |
667 | <param name="pt" type="Point2D" default=""/> | |
668 | </paramlist> | |
669 | </method> | |
670 | <method name="__idiv__" type="Point2D" overloaded="no"> | |
781d2982 | 671 | <autodoc>__idiv__(self, Point2D pt) -> Point2D</autodoc> |
f32fc4bc RD |
672 | <paramlist> |
673 | <param name="pt" type="Point2D" default=""/> | |
674 | </paramlist> | |
675 | </method> | |
676 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 677 | <autodoc>__eq__(self, Point2D pt) -> bool</autodoc> |
f32fc4bc RD |
678 | <docstring>Test for equality</docstring> |
679 | <paramlist> | |
680 | <param name="pt" type="Point2D" default=""/> | |
681 | </paramlist> | |
682 | </method> | |
683 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 684 | <autodoc>__ne__(self, Point2D pt) -> bool</autodoc> |
f32fc4bc RD |
685 | <docstring>Test for inequality</docstring> |
686 | <paramlist> | |
687 | <param name="pt" type="Point2D" default=""/> | |
688 | </paramlist> | |
689 | </method> | |
690 | <property name="x" type="double" readonly="no"/> | |
691 | <property name="y" type="double" readonly="no"/> | |
692 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 693 | <autodoc>Set(self, double x=0, double y=0)</autodoc> |
f32fc4bc RD |
694 | <paramlist> |
695 | <param name="x" type="double" default="0"/> | |
696 | <param name="y" type="double" default="0"/> | |
697 | </paramlist> | |
698 | </method> | |
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> | |
702 | </method> | |
703 | </class> | |
0dd25e81 | 704 | <pythoncode> |
f32fc4bc RD |
705 | #--------------------------------------------------------------------------- |
706 | </pythoncode> | |
781d2982 | 707 | <class name="InputStream" oldname="wxPyInputStream" module="_core"> |
f32fc4bc | 708 | <constructor name="wxPyInputStream" overloaded="no"> |
781d2982 | 709 | <autodoc>__init__(self, PyObject p) -> InputStream</autodoc> |
f32fc4bc RD |
710 | <paramlist> |
711 | <param name="p" type="PyObject" default=""/> | |
712 | </paramlist> | |
713 | </constructor> | |
714 | <method name="close" type="" overloaded="no"> | |
781d2982 | 715 | <autodoc>close(self)</autodoc> |
f32fc4bc RD |
716 | </method> |
717 | <method name="flush" type="" overloaded="no"> | |
781d2982 | 718 | <autodoc>flush(self)</autodoc> |
f32fc4bc RD |
719 | </method> |
720 | <method name="eof" type="bool" overloaded="no"> | |
781d2982 | 721 | <autodoc>eof(self) -> bool</autodoc> |
f32fc4bc RD |
722 | </method> |
723 | <method name="read" type="PyObject" overloaded="no"> | |
781d2982 | 724 | <autodoc>read(self, int size=-1) -> PyObject</autodoc> |
f32fc4bc RD |
725 | <paramlist> |
726 | <param name="size" type="int" default="-1"/> | |
727 | </paramlist> | |
728 | </method> | |
729 | <method name="readline" type="PyObject" overloaded="no"> | |
781d2982 | 730 | <autodoc>readline(self, int size=-1) -> PyObject</autodoc> |
f32fc4bc RD |
731 | <paramlist> |
732 | <param name="size" type="int" default="-1"/> | |
733 | </paramlist> | |
734 | </method> | |
735 | <method name="readlines" type="PyObject" overloaded="no"> | |
781d2982 | 736 | <autodoc>readlines(self, int sizehint=-1) -> PyObject</autodoc> |
f32fc4bc RD |
737 | <paramlist> |
738 | <param name="sizehint" type="int" default="-1"/> | |
739 | </paramlist> | |
740 | </method> | |
741 | <method name="seek" type="" overloaded="no"> | |
781d2982 | 742 | <autodoc>seek(self, int offset, int whence=0)</autodoc> |
f32fc4bc RD |
743 | <paramlist> |
744 | <param name="offset" type="int" default=""/> | |
745 | <param name="whence" type="int" default="0"/> | |
746 | </paramlist> | |
747 | </method> | |
748 | <method name="tell" type="int" overloaded="no"> | |
781d2982 | 749 | <autodoc>tell(self) -> int</autodoc> |
f32fc4bc RD |
750 | </method> |
751 | <method name="Peek" type="char" overloaded="no"> | |
781d2982 | 752 | <autodoc>Peek(self) -> char</autodoc> |
f32fc4bc RD |
753 | </method> |
754 | <method name="GetC" type="char" overloaded="no"> | |
781d2982 | 755 | <autodoc>GetC(self) -> char</autodoc> |
f32fc4bc RD |
756 | </method> |
757 | <method name="LastRead" type="size_t" overloaded="no"> | |
781d2982 | 758 | <autodoc>LastRead(self) -> size_t</autodoc> |
f32fc4bc RD |
759 | </method> |
760 | <method name="CanRead" type="bool" overloaded="no"> | |
781d2982 | 761 | <autodoc>CanRead(self) -> bool</autodoc> |
f32fc4bc RD |
762 | </method> |
763 | <method name="Eof" type="bool" overloaded="no"> | |
781d2982 | 764 | <autodoc>Eof(self) -> bool</autodoc> |
f32fc4bc RD |
765 | </method> |
766 | <method name="Ungetch" type="bool" overloaded="no"> | |
781d2982 | 767 | <autodoc>Ungetch(self, char c) -> bool</autodoc> |
f32fc4bc RD |
768 | <paramlist> |
769 | <param name="c" type="char" default=""/> | |
770 | </paramlist> | |
771 | </method> | |
772 | <method name="SeekI" type="long" overloaded="no"> | |
781d2982 | 773 | <autodoc>SeekI(self, long pos, int mode=FromStart) -> long</autodoc> |
f32fc4bc RD |
774 | <paramlist> |
775 | <param name="pos" type="long" default=""/> | |
776 | <param name="mode" type="wxSeekMode" default="wxFromStart"/> | |
777 | </paramlist> | |
778 | </method> | |
779 | <method name="TellI" type="long" overloaded="no"> | |
781d2982 | 780 | <autodoc>TellI(self) -> long</autodoc> |
f32fc4bc RD |
781 | </method> |
782 | </class> | |
781d2982 | 783 | <class name="OutputStream" oldname="wxOutputStream" module="_core"> |
f32fc4bc | 784 | <method name="write" type="" overloaded="no"> |
781d2982 | 785 | <autodoc>write(self, PyObject obj)</autodoc> |
f32fc4bc RD |
786 | <paramlist> |
787 | <param name="obj" type="PyObject" default=""/> | |
788 | </paramlist> | |
789 | </method> | |
790 | </class> | |
0dd25e81 | 791 | <pythoncode> |
0f43fbdf RD |
792 | #--------------------------------------------------------------------------- |
793 | </pythoncode> | |
781d2982 | 794 | <class name="FSFile" oldname="wxFSFile" module="_core"> |
f32fc4bc RD |
795 | <baseclass name="Object"/> |
796 | <constructor name="FSFile" overloaded="no"> | |
781d2982 | 797 | <autodoc>__init__(self, InputStream stream, String loc, String mimetype, String anchor, |
f32fc4bc RD |
798 | DateTime modif) -> FSFile</autodoc> |
799 | <paramlist> | |
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=""/> | |
805 | </paramlist> | |
806 | </constructor> | |
807 | <destructor name="~wxFSFile" overloaded="no"> | |
781d2982 | 808 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
809 | </destructor> |
810 | <method name="GetStream" type="wxInputStream" overloaded="no"> | |
781d2982 | 811 | <autodoc>GetStream(self) -> InputStream</autodoc> |
f32fc4bc RD |
812 | </method> |
813 | <method name="GetMimeType" type="String" overloaded="no"> | |
781d2982 | 814 | <autodoc>GetMimeType(self) -> String</autodoc> |
f32fc4bc RD |
815 | </method> |
816 | <method name="GetLocation" type="String" overloaded="no"> | |
781d2982 | 817 | <autodoc>GetLocation(self) -> String</autodoc> |
f32fc4bc RD |
818 | </method> |
819 | <method name="GetAnchor" type="String" overloaded="no"> | |
781d2982 | 820 | <autodoc>GetAnchor(self) -> String</autodoc> |
f32fc4bc RD |
821 | </method> |
822 | <method name="GetModificationTime" type="wxDateTime" overloaded="no"> | |
781d2982 | 823 | <autodoc>GetModificationTime(self) -> DateTime</autodoc> |
f32fc4bc RD |
824 | </method> |
825 | </class> | |
781d2982 RD |
826 | <class name="CPPFileSystemHandler" oldname="wxFileSystemHandler" module="_core"/> |
827 | <class name="FileSystemHandler" oldname="wxPyFileSystemHandler" module="_core"> | |
f32fc4bc RD |
828 | <baseclass name="CPPFileSystemHandler"/> |
829 | <constructor name="wxPyFileSystemHandler" overloaded="no"> | |
781d2982 | 830 | <autodoc>__init__(self) -> FileSystemHandler</autodoc> |
f32fc4bc RD |
831 | </constructor> |
832 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 833 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
834 | <paramlist> |
835 | <param name="self" type="PyObject" default=""/> | |
836 | <param name="_class" type="PyObject" default=""/> | |
837 | </paramlist> | |
838 | </method> | |
839 | <method name="CanOpen" type="bool" overloaded="no"> | |
781d2982 | 840 | <autodoc>CanOpen(self, String location) -> bool</autodoc> |
f32fc4bc RD |
841 | <paramlist> |
842 | <param name="location" type="String" default=""/> | |
843 | </paramlist> | |
844 | </method> | |
845 | <method name="OpenFile" type="FSFile" overloaded="no"> | |
781d2982 | 846 | <autodoc>OpenFile(self, FileSystem fs, String location) -> FSFile</autodoc> |
f32fc4bc RD |
847 | <paramlist> |
848 | <param name="fs" type="wxFileSystem" default=""/> | |
849 | <param name="location" type="String" default=""/> | |
850 | </paramlist> | |
851 | </method> | |
852 | <method name="FindFirst" type="String" overloaded="no"> | |
781d2982 | 853 | <autodoc>FindFirst(self, String spec, int flags=0) -> String</autodoc> |
f32fc4bc RD |
854 | <paramlist> |
855 | <param name="spec" type="String" default=""/> | |
856 | <param name="flags" type="int" default="0"/> | |
857 | </paramlist> | |
858 | </method> | |
859 | <method name="FindNext" type="String" overloaded="no"> | |
781d2982 | 860 | <autodoc>FindNext(self) -> String</autodoc> |
f32fc4bc RD |
861 | </method> |
862 | <method name="GetProtocol" type="String" overloaded="no"> | |
781d2982 | 863 | <autodoc>GetProtocol(self, String location) -> String</autodoc> |
f32fc4bc RD |
864 | <paramlist> |
865 | <param name="location" type="String" default=""/> | |
866 | </paramlist> | |
867 | </method> | |
868 | <method name="GetLeftLocation" type="String" overloaded="no"> | |
781d2982 | 869 | <autodoc>GetLeftLocation(self, String location) -> String</autodoc> |
f32fc4bc RD |
870 | <paramlist> |
871 | <param name="location" type="String" default=""/> | |
872 | </paramlist> | |
873 | </method> | |
874 | <method name="GetAnchor" type="String" overloaded="no"> | |
781d2982 | 875 | <autodoc>GetAnchor(self, String location) -> String</autodoc> |
f32fc4bc RD |
876 | <paramlist> |
877 | <param name="location" type="String" default=""/> | |
878 | </paramlist> | |
879 | </method> | |
880 | <method name="GetRightLocation" type="String" overloaded="no"> | |
781d2982 | 881 | <autodoc>GetRightLocation(self, String location) -> String</autodoc> |
f32fc4bc RD |
882 | <paramlist> |
883 | <param name="location" type="String" default=""/> | |
884 | </paramlist> | |
885 | </method> | |
886 | <method name="GetMimeTypeFromExt" type="String" overloaded="no"> | |
781d2982 | 887 | <autodoc>GetMimeTypeFromExt(self, String location) -> String</autodoc> |
f32fc4bc RD |
888 | <paramlist> |
889 | <param name="location" type="String" default=""/> | |
890 | </paramlist> | |
891 | </method> | |
892 | </class> | |
781d2982 | 893 | <class name="FileSystem" oldname="wxFileSystem" module="_core"> |
f32fc4bc RD |
894 | <baseclass name="Object"/> |
895 | <constructor name="FileSystem" overloaded="no"> | |
781d2982 | 896 | <autodoc>__init__(self) -> FileSystem</autodoc> |
f32fc4bc RD |
897 | </constructor> |
898 | <destructor name="~wxFileSystem" overloaded="no"> | |
781d2982 | 899 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
900 | </destructor> |
901 | <method name="ChangePathTo" type="" overloaded="no"> | |
781d2982 | 902 | <autodoc>ChangePathTo(self, String location, bool is_dir=False)</autodoc> |
f32fc4bc RD |
903 | <paramlist> |
904 | <param name="location" type="String" default=""/> | |
905 | <param name="is_dir" type="bool" default="False"/> | |
906 | </paramlist> | |
907 | </method> | |
908 | <method name="GetPath" type="String" overloaded="no"> | |
781d2982 | 909 | <autodoc>GetPath(self) -> String</autodoc> |
f32fc4bc RD |
910 | </method> |
911 | <method name="OpenFile" type="FSFile" overloaded="no"> | |
781d2982 | 912 | <autodoc>OpenFile(self, String location) -> FSFile</autodoc> |
f32fc4bc RD |
913 | <paramlist> |
914 | <param name="location" type="String" default=""/> | |
915 | </paramlist> | |
916 | </method> | |
917 | <method name="FindFirst" type="String" overloaded="no"> | |
781d2982 | 918 | <autodoc>FindFirst(self, String spec, int flags=0) -> String</autodoc> |
f32fc4bc RD |
919 | <paramlist> |
920 | <param name="spec" type="String" default=""/> | |
921 | <param name="flags" type="int" default="0"/> | |
922 | </paramlist> | |
923 | </method> | |
924 | <method name="FindNext" type="String" overloaded="no"> | |
781d2982 | 925 | <autodoc>FindNext(self) -> String</autodoc> |
f32fc4bc RD |
926 | </method> |
927 | <staticmethod name="AddHandler" type="" overloaded="no"> | |
928 | <autodoc>AddHandler(CPPFileSystemHandler handler)</autodoc> | |
929 | <paramlist> | |
930 | <param name="handler" type="CPPFileSystemHandler" default=""/> | |
931 | </paramlist> | |
932 | </staticmethod> | |
933 | <staticmethod name="CleanUpHandlers" type="" overloaded="no"> | |
934 | <autodoc>CleanUpHandlers()</autodoc> | |
935 | </staticmethod> | |
936 | <staticmethod name="FileNameToURL" type="String" overloaded="no"> | |
937 | <autodoc>FileNameToURL(String filename) -> String</autodoc> | |
938 | <paramlist> | |
939 | <param name="filename" type="String" default=""/> | |
940 | </paramlist> | |
941 | </staticmethod> | |
942 | </class> | |
943 | <method name="FileSystem_URLToFileName" oldname="wxFileSystem_URLToFileName" type="String" overloaded="no"> | |
944 | <autodoc>FileSystem_URLToFileName(String url) -> String</autodoc> | |
945 | <paramlist> | |
946 | <param name="url" type="String" default=""/> | |
947 | </paramlist> | |
948 | </method> | |
781d2982 | 949 | <class name="InternetFSHandler" oldname="wxInternetFSHandler" module="_core"> |
f32fc4bc RD |
950 | <baseclass name="CPPFileSystemHandler"/> |
951 | <constructor name="InternetFSHandler" overloaded="no"> | |
781d2982 | 952 | <autodoc>__init__(self) -> InternetFSHandler</autodoc> |
f32fc4bc RD |
953 | </constructor> |
954 | <method name="CanOpen" type="bool" overloaded="no"> | |
781d2982 | 955 | <autodoc>CanOpen(self, String location) -> bool</autodoc> |
f32fc4bc RD |
956 | <paramlist> |
957 | <param name="location" type="String" default=""/> | |
958 | </paramlist> | |
959 | </method> | |
960 | <method name="OpenFile" type="FSFile" overloaded="no"> | |
781d2982 | 961 | <autodoc>OpenFile(self, FileSystem fs, String location) -> FSFile</autodoc> |
f32fc4bc RD |
962 | <paramlist> |
963 | <param name="fs" type="FileSystem" default=""/> | |
964 | <param name="location" type="String" default=""/> | |
965 | </paramlist> | |
966 | </method> | |
967 | </class> | |
781d2982 | 968 | <class name="ZipFSHandler" oldname="wxZipFSHandler" module="_core"> |
f32fc4bc RD |
969 | <baseclass name="CPPFileSystemHandler"/> |
970 | <constructor name="ZipFSHandler" overloaded="no"> | |
781d2982 | 971 | <autodoc>__init__(self) -> ZipFSHandler</autodoc> |
f32fc4bc RD |
972 | </constructor> |
973 | <method name="CanOpen" type="bool" overloaded="no"> | |
781d2982 | 974 | <autodoc>CanOpen(self, String location) -> bool</autodoc> |
f32fc4bc RD |
975 | <paramlist> |
976 | <param name="location" type="String" default=""/> | |
977 | </paramlist> | |
978 | </method> | |
979 | <method name="OpenFile" type="FSFile" overloaded="no"> | |
781d2982 | 980 | <autodoc>OpenFile(self, FileSystem fs, String location) -> FSFile</autodoc> |
f32fc4bc RD |
981 | <paramlist> |
982 | <param name="fs" type="FileSystem" default=""/> | |
983 | <param name="location" type="String" default=""/> | |
984 | </paramlist> | |
985 | </method> | |
986 | <method name="FindFirst" type="String" overloaded="no"> | |
781d2982 | 987 | <autodoc>FindFirst(self, String spec, int flags=0) -> String</autodoc> |
f32fc4bc RD |
988 | <paramlist> |
989 | <param name="spec" type="String" default=""/> | |
990 | <param name="flags" type="int" default="0"/> | |
991 | </paramlist> | |
992 | </method> | |
993 | <method name="FindNext" type="String" overloaded="no"> | |
781d2982 | 994 | <autodoc>FindNext(self) -> String</autodoc> |
f32fc4bc RD |
995 | </method> |
996 | </class> | |
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> | |
999 | <paramlist> | |
1000 | <param name="filename" type="String" default=""/> | |
1001 | <param name="image" type="wxImage" default=""/> | |
1002 | <param name="type" type="long" default=""/> | |
856bf319 RD |
1003 | </paramlist> |
1004 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 1007 | <paramlist> |
f32fc4bc RD |
1008 | <param name="filename" type="String" default=""/> |
1009 | <param name="bitmap" type="wxBitmap" default=""/> | |
1010 | <param name="type" type="long" default=""/> | |
856bf319 RD |
1011 | </paramlist> |
1012 | </method> | |
f32fc4bc RD |
1013 | <method name="__wxMemoryFSHandler_AddFile_Data" oldname="__wxMemoryFSHandler_AddFile_Data" type="" overloaded="no"> |
1014 | <autodoc>__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)</autodoc> | |
856bf319 | 1015 | <paramlist> |
f32fc4bc RD |
1016 | <param name="filename" type="String" default=""/> |
1017 | <param name="data" type="PyObject" default=""/> | |
856bf319 RD |
1018 | </paramlist> |
1019 | </method> | |
f32fc4bc | 1020 | <pythoncode> |
856bf319 RD |
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' | |
1029 | </pythoncode> | |
781d2982 | 1030 | <class name="MemoryFSHandler" oldname="wxMemoryFSHandler" module="_core"> |
f32fc4bc RD |
1031 | <baseclass name="CPPFileSystemHandler"/> |
1032 | <constructor name="MemoryFSHandler" overloaded="no"> | |
781d2982 | 1033 | <autodoc>__init__(self) -> MemoryFSHandler</autodoc> |
f32fc4bc RD |
1034 | </constructor> |
1035 | <staticmethod name="RemoveFile" type="" overloaded="no"> | |
1036 | <autodoc>RemoveFile(String filename)</autodoc> | |
1037 | <paramlist> | |
1038 | <param name="filename" type="String" default=""/> | |
1039 | </paramlist> | |
1040 | </staticmethod> | |
1041 | <method name="CanOpen" type="bool" overloaded="no"> | |
781d2982 | 1042 | <autodoc>CanOpen(self, String location) -> bool</autodoc> |
f32fc4bc RD |
1043 | <paramlist> |
1044 | <param name="location" type="String" default=""/> | |
1045 | </paramlist> | |
1046 | </method> | |
1047 | <method name="OpenFile" type="FSFile" overloaded="no"> | |
781d2982 | 1048 | <autodoc>OpenFile(self, FileSystem fs, String location) -> FSFile</autodoc> |
f32fc4bc RD |
1049 | <paramlist> |
1050 | <param name="fs" type="FileSystem" default=""/> | |
1051 | <param name="location" type="String" default=""/> | |
1052 | </paramlist> | |
1053 | </method> | |
1054 | <method name="FindFirst" type="String" overloaded="no"> | |
781d2982 | 1055 | <autodoc>FindFirst(self, String spec, int flags=0) -> String</autodoc> |
f32fc4bc RD |
1056 | <paramlist> |
1057 | <param name="spec" type="String" default=""/> | |
1058 | <param name="flags" type="int" default="0"/> | |
1059 | </paramlist> | |
1060 | </method> | |
1061 | <method name="FindNext" type="String" overloaded="no"> | |
781d2982 | 1062 | <autodoc>FindNext(self) -> String</autodoc> |
f32fc4bc RD |
1063 | </method> |
1064 | </class> | |
1065 | <pythoncode> | |
0f43fbdf RD |
1066 | #--------------------------------------------------------------------------- |
1067 | </pythoncode> | |
781d2982 | 1068 | <class name="ImageHandler" oldname="wxImageHandler" module="_core"> |
f32fc4bc RD |
1069 | <baseclass name="Object"/> |
1070 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 1071 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
1072 | </method> |
1073 | <method name="GetExtension" type="String" overloaded="no"> | |
781d2982 | 1074 | <autodoc>GetExtension(self) -> String</autodoc> |
f32fc4bc RD |
1075 | </method> |
1076 | <method name="GetType" type="long" overloaded="no"> | |
781d2982 | 1077 | <autodoc>GetType(self) -> long</autodoc> |
f32fc4bc RD |
1078 | </method> |
1079 | <method name="GetMimeType" type="String" overloaded="no"> | |
781d2982 | 1080 | <autodoc>GetMimeType(self) -> String</autodoc> |
f32fc4bc RD |
1081 | </method> |
1082 | <method name="CanRead" type="bool" overloaded="no"> | |
781d2982 | 1083 | <autodoc>CanRead(self, String name) -> bool</autodoc> |
f32fc4bc RD |
1084 | <paramlist> |
1085 | <param name="name" type="String" default=""/> | |
1086 | </paramlist> | |
1087 | </method> | |
1088 | <method name="SetName" type="" overloaded="no"> | |
781d2982 | 1089 | <autodoc>SetName(self, String name)</autodoc> |
f32fc4bc RD |
1090 | <paramlist> |
1091 | <param name="name" type="String" default=""/> | |
1092 | </paramlist> | |
1093 | </method> | |
1094 | <method name="SetExtension" type="" overloaded="no"> | |
781d2982 | 1095 | <autodoc>SetExtension(self, String extension)</autodoc> |
f32fc4bc RD |
1096 | <paramlist> |
1097 | <param name="extension" type="String" default=""/> | |
1098 | </paramlist> | |
1099 | </method> | |
1100 | <method name="SetType" type="" overloaded="no"> | |
781d2982 | 1101 | <autodoc>SetType(self, long type)</autodoc> |
f32fc4bc RD |
1102 | <paramlist> |
1103 | <param name="type" type="long" default=""/> | |
1104 | </paramlist> | |
1105 | </method> | |
1106 | <method name="SetMimeType" type="" overloaded="no"> | |
781d2982 | 1107 | <autodoc>SetMimeType(self, String mimetype)</autodoc> |
f32fc4bc RD |
1108 | <paramlist> |
1109 | <param name="mimetype" type="String" default=""/> | |
1110 | </paramlist> | |
1111 | </method> | |
1112 | </class> | |
781d2982 | 1113 | <class name="ImageHistogram" oldname="wxImageHistogram" module="_core"> |
f32fc4bc | 1114 | <constructor name="ImageHistogram" overloaded="no"> |
781d2982 | 1115 | <autodoc>__init__(self) -> ImageHistogram</autodoc> |
f32fc4bc RD |
1116 | </constructor> |
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> | |
1120 | <paramlist> | |
1121 | <param name="r" type="unsigned char" default=""/> | |
1122 | <param name="g" type="unsigned char" default=""/> | |
1123 | <param name="b" type="unsigned char" default=""/> | |
1124 | </paramlist> | |
1125 | </staticmethod> | |
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> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
1131 | <paramlist> |
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"/> | |
1138 | </paramlist> | |
1139 | </method> | |
1140 | </class> | |
781d2982 | 1141 | <class name="Image" oldname="wxImage" module="_core"> |
f32fc4bc RD |
1142 | <baseclass name="Object"/> |
1143 | <constructor name="Image" overloaded="no"> | |
781d2982 | 1144 | <autodoc>__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image</autodoc> |
f32fc4bc RD |
1145 | <paramlist> |
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"/> | |
1149 | </paramlist> | |
1150 | </constructor> | |
1151 | <constructor name="ImageFromMime" overloaded="no"> | |
1152 | <autodoc>ImageFromMime(String name, String mimetype, int index=-1) -> Image</autodoc> | |
1153 | <paramlist> | |
1154 | <param name="name" type="String" default=""/> | |
1155 | <param name="mimetype" type="String" default=""/> | |
1156 | <param name="index" type="int" default="-1"/> | |
1157 | </paramlist> | |
1158 | </constructor> | |
1159 | <constructor name="ImageFromStream" overloaded="no"> | |
1160 | <autodoc>ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image</autodoc> | |
1161 | <paramlist> | |
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"/> | |
1165 | </paramlist> | |
1166 | </constructor> | |
1167 | <constructor name="ImageFromStreamMime" overloaded="no"> | |
1168 | <autodoc>ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image</autodoc> | |
1169 | <paramlist> | |
1170 | <param name="stream" type="wxInputStream" default=""/> | |
1171 | <param name="mimetype" type="String" default=""/> | |
1172 | <param name="index" type="int" default="-1"/> | |
1173 | </paramlist> | |
1174 | </constructor> | |
1175 | <constructor name="EmptyImage" overloaded="no"> | |
1176 | <autodoc>EmptyImage(int width=0, int height=0, bool clear=True) -> Image</autodoc> | |
1177 | <paramlist> | |
1178 | <param name="width" type="int" default="0"/> | |
1179 | <param name="height" type="int" default="0"/> | |
1180 | <param name="clear" type="bool" default="True"/> | |
1181 | </paramlist> | |
1182 | </constructor> | |
1183 | <constructor name="ImageFromBitmap" overloaded="no"> | |
1184 | <autodoc>ImageFromBitmap(Bitmap bitmap) -> Image</autodoc> | |
1185 | <paramlist> | |
1186 | <param name="bitmap" type="wxBitmap" default=""/> | |
1187 | </paramlist> | |
1188 | </constructor> | |
1189 | <constructor name="ImageFromData" overloaded="no"> | |
1190 | <autodoc>ImageFromData(int width, int height, unsigned char data) -> Image</autodoc> | |
1191 | <paramlist> | |
1192 | <param name="width" type="int" default=""/> | |
1193 | <param name="height" type="int" default=""/> | |
1194 | <param name="data" type="unsigned char" default=""/> | |
1195 | </paramlist> | |
1196 | </constructor> | |
1197 | <destructor name="~wxImage" overloaded="no"> | |
781d2982 | 1198 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
1199 | </destructor> |
1200 | <method name="Create" type="" overloaded="no"> | |
781d2982 | 1201 | <autodoc>Create(self, int width, int height)</autodoc> |
f32fc4bc RD |
1202 | <paramlist> |
1203 | <param name="width" type="int" default=""/> | |
1204 | <param name="height" type="int" default=""/> | |
1205 | </paramlist> | |
1206 | </method> | |
1207 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 1208 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
1209 | <docstring>Deletes the C++ object this Python object is a proxy for.</docstring> |
1210 | </method> | |
1211 | <method name="Scale" type="Image" overloaded="no"> | |
781d2982 | 1212 | <autodoc>Scale(self, int width, int height) -> Image</autodoc> |
f32fc4bc RD |
1213 | <paramlist> |
1214 | <param name="width" type="int" default=""/> | |
1215 | <param name="height" type="int" default=""/> | |
1216 | </paramlist> | |
1217 | </method> | |
1218 | <method name="ShrinkBy" type="Image" overloaded="no"> | |
781d2982 | 1219 | <autodoc>ShrinkBy(self, int xFactor, int yFactor) -> Image</autodoc> |
f32fc4bc RD |
1220 | <paramlist> |
1221 | <param name="xFactor" type="int" default=""/> | |
1222 | <param name="yFactor" type="int" default=""/> | |
1223 | </paramlist> | |
1224 | </method> | |
1225 | <method name="Rescale" type="Image" overloaded="no"> | |
781d2982 | 1226 | <autodoc>Rescale(self, int width, int height) -> Image</autodoc> |
f32fc4bc RD |
1227 | <paramlist> |
1228 | <param name="width" type="int" default=""/> | |
1229 | <param name="height" type="int" default=""/> | |
1230 | </paramlist> | |
1231 | </method> | |
1232 | <method name="SetRGB" type="" overloaded="no"> | |
781d2982 | 1233 | <autodoc>SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)</autodoc> |
f32fc4bc RD |
1234 | <paramlist> |
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=""/> | |
1240 | </paramlist> | |
1241 | </method> | |
1242 | <method name="GetRed" type="unsigned char" overloaded="no"> | |
781d2982 | 1243 | <autodoc>GetRed(self, int x, int y) -> unsigned char</autodoc> |
f32fc4bc RD |
1244 | <paramlist> |
1245 | <param name="x" type="int" default=""/> | |
1246 | <param name="y" type="int" default=""/> | |
1247 | </paramlist> | |
1248 | </method> | |
1249 | <method name="GetGreen" type="unsigned char" overloaded="no"> | |
781d2982 | 1250 | <autodoc>GetGreen(self, int x, int y) -> unsigned char</autodoc> |
f32fc4bc RD |
1251 | <paramlist> |
1252 | <param name="x" type="int" default=""/> | |
1253 | <param name="y" type="int" default=""/> | |
1254 | </paramlist> | |
1255 | </method> | |
1256 | <method name="GetBlue" type="unsigned char" overloaded="no"> | |
781d2982 | 1257 | <autodoc>GetBlue(self, int x, int y) -> unsigned char</autodoc> |
f32fc4bc RD |
1258 | <paramlist> |
1259 | <param name="x" type="int" default=""/> | |
1260 | <param name="y" type="int" default=""/> | |
1261 | </paramlist> | |
1262 | </method> | |
1263 | <method name="SetAlpha" type="" overloaded="no"> | |
781d2982 | 1264 | <autodoc>SetAlpha(self, int x, int y, unsigned char alpha)</autodoc> |
f32fc4bc RD |
1265 | <paramlist> |
1266 | <param name="x" type="int" default=""/> | |
1267 | <param name="y" type="int" default=""/> | |
1268 | <param name="alpha" type="unsigned char" default=""/> | |
1269 | </paramlist> | |
1270 | </method> | |
1271 | <method name="GetAlpha" type="unsigned char" overloaded="no"> | |
781d2982 | 1272 | <autodoc>GetAlpha(self, int x, int y) -> unsigned char</autodoc> |
f32fc4bc RD |
1273 | <paramlist> |
1274 | <param name="x" type="int" default=""/> | |
1275 | <param name="y" type="int" default=""/> | |
1276 | </paramlist> | |
1277 | </method> | |
1278 | <method name="HasAlpha" type="bool" overloaded="no"> | |
781d2982 | 1279 | <autodoc>HasAlpha(self) -> bool</autodoc> |
f32fc4bc RD |
1280 | </method> |
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> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
1286 | <paramlist> |
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"/> | |
1293 | </paramlist> | |
1294 | </method> | |
1295 | <method name="SetMaskFromImage" type="bool" overloaded="no"> | |
781d2982 | 1296 | <autodoc>SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool</autodoc> |
f32fc4bc RD |
1297 | <paramlist> |
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=""/> | |
1302 | </paramlist> | |
1303 | </method> | |
1304 | <staticmethod name="CanRead" type="bool" overloaded="no"> | |
1305 | <autodoc>CanRead(String name) -> bool</autodoc> | |
1306 | <paramlist> | |
1307 | <param name="name" type="String" default=""/> | |
1308 | </paramlist> | |
1309 | </staticmethod> | |
1310 | <staticmethod name="GetImageCount" type="int" overloaded="no"> | |
1311 | <autodoc>GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int</autodoc> | |
1312 | <paramlist> | |
1313 | <param name="name" type="String" default=""/> | |
1314 | <param name="type" type="long" default="wxBITMAP_TYPE_ANY"/> | |
1315 | </paramlist> | |
1316 | </staticmethod> | |
1317 | <method name="LoadFile" type="bool" overloaded="no"> | |
781d2982 | 1318 | <autodoc>LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool</autodoc> |
f32fc4bc RD |
1319 | <paramlist> |
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"/> | |
1323 | </paramlist> | |
1324 | </method> | |
1325 | <method name="LoadMimeFile" type="bool" overloaded="no"> | |
781d2982 | 1326 | <autodoc>LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool</autodoc> |
f32fc4bc RD |
1327 | <paramlist> |
1328 | <param name="name" type="String" default=""/> | |
1329 | <param name="mimetype" type="String" default=""/> | |
1330 | <param name="index" type="int" default="-1"/> | |
1331 | </paramlist> | |
1332 | </method> | |
1333 | <method name="SaveFile" type="bool" overloaded="no"> | |
781d2982 | 1334 | <autodoc>SaveFile(self, String name, int type) -> bool</autodoc> |
f32fc4bc RD |
1335 | <paramlist> |
1336 | <param name="name" type="String" default=""/> | |
1337 | <param name="type" type="int" default=""/> | |
1338 | </paramlist> | |
1339 | </method> | |
1340 | <method name="SaveMimeFile" type="bool" overloaded="no"> | |
781d2982 | 1341 | <autodoc>SaveMimeFile(self, String name, String mimetype) -> bool</autodoc> |
f32fc4bc RD |
1342 | <paramlist> |
1343 | <param name="name" type="String" default=""/> | |
1344 | <param name="mimetype" type="String" default=""/> | |
1345 | </paramlist> | |
1346 | </method> | |
1347 | <staticmethod name="CanReadStream" type="bool" overloaded="no"> | |
1348 | <autodoc>CanReadStream(InputStream stream) -> bool</autodoc> | |
1349 | <paramlist> | |
1350 | <param name="stream" type="wxInputStream" default=""/> | |
1351 | </paramlist> | |
1352 | </staticmethod> | |
1353 | <method name="LoadStream" type="bool" overloaded="no"> | |
781d2982 | 1354 | <autodoc>LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool</autodoc> |
f32fc4bc RD |
1355 | <paramlist> |
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"/> | |
1359 | </paramlist> | |
1360 | </method> | |
1361 | <method name="LoadMimeStream" type="bool" overloaded="no"> | |
781d2982 | 1362 | <autodoc>LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool</autodoc> |
f32fc4bc RD |
1363 | <paramlist> |
1364 | <param name="stream" type="wxInputStream" default=""/> | |
1365 | <param name="mimetype" type="String" default=""/> | |
1366 | <param name="index" type="int" default="-1"/> | |
1367 | </paramlist> | |
1368 | </method> | |
1369 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 1370 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
1371 | </method> |
1372 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 1373 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
1374 | </method> |
1375 | <method name="GetHeight" type="int" overloaded="no"> | |
781d2982 RD |
1376 | <autodoc>GetHeight(self) -> int</autodoc> |
1377 | </method> | |
1378 | <method name="GetSize" type="Size" overloaded="no"> | |
1379 | <autodoc>GetSize(self) -> Size</autodoc> | |
f32fc4bc RD |
1380 | </method> |
1381 | <method name="GetSubImage" type="Image" overloaded="no"> | |
781d2982 | 1382 | <autodoc>GetSubImage(self, Rect rect) -> Image</autodoc> |
f32fc4bc RD |
1383 | <paramlist> |
1384 | <param name="rect" type="Rect" default=""/> | |
1385 | </paramlist> | |
1386 | </method> | |
1387 | <method name="Copy" type="Image" overloaded="no"> | |
781d2982 | 1388 | <autodoc>Copy(self) -> Image</autodoc> |
f32fc4bc RD |
1389 | </method> |
1390 | <method name="Paste" type="" overloaded="no"> | |
781d2982 | 1391 | <autodoc>Paste(self, Image image, int x, int y)</autodoc> |
f32fc4bc RD |
1392 | <paramlist> |
1393 | <param name="image" type="Image" default=""/> | |
1394 | <param name="x" type="int" default=""/> | |
1395 | <param name="y" type="int" default=""/> | |
1396 | </paramlist> | |
1397 | </method> | |
1398 | <method name="GetData" type="PyObject" overloaded="no"> | |
781d2982 | 1399 | <autodoc>GetData(self) -> PyObject</autodoc> |
f32fc4bc RD |
1400 | </method> |
1401 | <method name="SetData" type="" overloaded="no"> | |
781d2982 | 1402 | <autodoc>SetData(self, PyObject data)</autodoc> |
f32fc4bc RD |
1403 | <paramlist> |
1404 | <param name="data" type="PyObject" default=""/> | |
1405 | </paramlist> | |
1406 | </method> | |
1407 | <method name="GetDataBuffer" type="PyObject" overloaded="no"> | |
781d2982 | 1408 | <autodoc>GetDataBuffer(self) -> PyObject</autodoc> |
f32fc4bc RD |
1409 | </method> |
1410 | <method name="SetDataBuffer" type="" overloaded="no"> | |
781d2982 | 1411 | <autodoc>SetDataBuffer(self, PyObject data)</autodoc> |
f32fc4bc RD |
1412 | <paramlist> |
1413 | <param name="data" type="PyObject" default=""/> | |
1414 | </paramlist> | |
1415 | </method> | |
1416 | <method name="GetAlphaData" type="PyObject" overloaded="no"> | |
781d2982 | 1417 | <autodoc>GetAlphaData(self) -> PyObject</autodoc> |
f32fc4bc RD |
1418 | </method> |
1419 | <method name="SetAlphaData" type="" overloaded="no"> | |
781d2982 | 1420 | <autodoc>SetAlphaData(self, PyObject data)</autodoc> |
f32fc4bc RD |
1421 | <paramlist> |
1422 | <param name="data" type="PyObject" default=""/> | |
1423 | </paramlist> | |
1424 | </method> | |
1425 | <method name="GetAlphaBuffer" type="PyObject" overloaded="no"> | |
781d2982 | 1426 | <autodoc>GetAlphaBuffer(self) -> PyObject</autodoc> |
f32fc4bc RD |
1427 | </method> |
1428 | <method name="SetAlphaBuffer" type="" overloaded="no"> | |
781d2982 | 1429 | <autodoc>SetAlphaBuffer(self, PyObject data)</autodoc> |
f32fc4bc RD |
1430 | <paramlist> |
1431 | <param name="data" type="PyObject" default=""/> | |
1432 | </paramlist> | |
1433 | </method> | |
1434 | <method name="SetMaskColour" type="" overloaded="no"> | |
781d2982 | 1435 | <autodoc>SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)</autodoc> |
f32fc4bc RD |
1436 | <paramlist> |
1437 | <param name="r" type="unsigned char" default=""/> | |
1438 | <param name="g" type="unsigned char" default=""/> | |
1439 | <param name="b" type="unsigned char" default=""/> | |
1440 | </paramlist> | |
1441 | </method> | |
1442 | <method name="GetMaskRed" type="unsigned char" overloaded="no"> | |
781d2982 | 1443 | <autodoc>GetMaskRed(self) -> unsigned char</autodoc> |
f32fc4bc RD |
1444 | </method> |
1445 | <method name="GetMaskGreen" type="unsigned char" overloaded="no"> | |
781d2982 | 1446 | <autodoc>GetMaskGreen(self) -> unsigned char</autodoc> |
f32fc4bc RD |
1447 | </method> |
1448 | <method name="GetMaskBlue" type="unsigned char" overloaded="no"> | |
781d2982 | 1449 | <autodoc>GetMaskBlue(self) -> unsigned char</autodoc> |
f32fc4bc RD |
1450 | </method> |
1451 | <method name="SetMask" type="" overloaded="no"> | |
781d2982 | 1452 | <autodoc>SetMask(self, bool mask=True)</autodoc> |
f32fc4bc RD |
1453 | <paramlist> |
1454 | <param name="mask" type="bool" default="True"/> | |
1455 | </paramlist> | |
1456 | </method> | |
1457 | <method name="HasMask" type="bool" overloaded="no"> | |
781d2982 | 1458 | <autodoc>HasMask(self) -> bool</autodoc> |
f32fc4bc RD |
1459 | </method> |
1460 | <method name="Rotate" type="Image" overloaded="no"> | |
781d2982 | 1461 | <autodoc>Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True, |
856bf319 | 1462 | Point offset_after_rotation=None) -> Image</autodoc> |
f32fc4bc RD |
1463 | <paramlist> |
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"/> | |
1468 | </paramlist> | |
1469 | </method> | |
1470 | <method name="Rotate90" type="Image" overloaded="no"> | |
781d2982 | 1471 | <autodoc>Rotate90(self, bool clockwise=True) -> Image</autodoc> |
f32fc4bc RD |
1472 | <paramlist> |
1473 | <param name="clockwise" type="bool" default="True"/> | |
1474 | </paramlist> | |
1475 | </method> | |
1476 | <method name="Mirror" type="Image" overloaded="no"> | |
781d2982 | 1477 | <autodoc>Mirror(self, bool horizontally=True) -> Image</autodoc> |
f32fc4bc RD |
1478 | <paramlist> |
1479 | <param name="horizontally" type="bool" default="True"/> | |
1480 | </paramlist> | |
1481 | </method> | |
1482 | <method name="Replace" type="" overloaded="no"> | |
781d2982 | 1483 | <autodoc>Replace(self, unsigned char r1, unsigned char g1, unsigned char b1, |
856bf319 | 1484 | unsigned char r2, unsigned char g2, unsigned char b2)</autodoc> |
f32fc4bc RD |
1485 | <paramlist> |
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=""/> | |
1492 | </paramlist> | |
1493 | </method> | |
1494 | <method name="ConvertToMono" type="Image" overloaded="no"> | |
781d2982 | 1495 | <autodoc>ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image</autodoc> |
f32fc4bc RD |
1496 | <paramlist> |
1497 | <param name="r" type="unsigned char" default=""/> | |
1498 | <param name="g" type="unsigned char" default=""/> | |
1499 | <param name="b" type="unsigned char" default=""/> | |
1500 | </paramlist> | |
1501 | </method> | |
1502 | <method name="SetOption" type="" overloaded="no"> | |
781d2982 | 1503 | <autodoc>SetOption(self, String name, String value)</autodoc> |
f32fc4bc RD |
1504 | <paramlist> |
1505 | <param name="name" type="String" default=""/> | |
1506 | <param name="value" type="String" default=""/> | |
1507 | </paramlist> | |
1508 | </method> | |
1509 | <method name="SetOptionInt" type="" overloaded="no"> | |
781d2982 | 1510 | <autodoc>SetOptionInt(self, String name, int value)</autodoc> |
f32fc4bc RD |
1511 | <paramlist> |
1512 | <param name="name" type="String" default=""/> | |
1513 | <param name="value" type="int" default=""/> | |
1514 | </paramlist> | |
1515 | </method> | |
1516 | <method name="GetOption" type="String" overloaded="no"> | |
781d2982 | 1517 | <autodoc>GetOption(self, String name) -> String</autodoc> |
f32fc4bc RD |
1518 | <paramlist> |
1519 | <param name="name" type="String" default=""/> | |
1520 | </paramlist> | |
1521 | </method> | |
1522 | <method name="GetOptionInt" type="int" overloaded="no"> | |
781d2982 | 1523 | <autodoc>GetOptionInt(self, String name) -> int</autodoc> |
f32fc4bc RD |
1524 | <paramlist> |
1525 | <param name="name" type="String" default=""/> | |
1526 | </paramlist> | |
1527 | </method> | |
1528 | <method name="HasOption" type="bool" overloaded="no"> | |
781d2982 | 1529 | <autodoc>HasOption(self, String name) -> bool</autodoc> |
f32fc4bc RD |
1530 | <paramlist> |
1531 | <param name="name" type="String" default=""/> | |
1532 | </paramlist> | |
1533 | </method> | |
1534 | <method name="CountColours" type="unsigned long" overloaded="no"> | |
781d2982 | 1535 | <autodoc>CountColours(self, unsigned long stopafter=(unsigned long) -1) -> unsigned long</autodoc> |
f32fc4bc RD |
1536 | <paramlist> |
1537 | <param name="stopafter" type="unsigned long" default="(unsigned long) -1"/> | |
1538 | </paramlist> | |
1539 | </method> | |
1540 | <method name="ComputeHistogram" type="unsigned long" overloaded="no"> | |
781d2982 | 1541 | <autodoc>ComputeHistogram(self, ImageHistogram h) -> unsigned long</autodoc> |
f32fc4bc RD |
1542 | <paramlist> |
1543 | <param name="h" type="ImageHistogram" default=""/> | |
1544 | </paramlist> | |
1545 | </method> | |
1546 | <staticmethod name="AddHandler" type="" overloaded="no"> | |
1547 | <autodoc>AddHandler(ImageHandler handler)</autodoc> | |
1548 | <paramlist> | |
1549 | <param name="handler" type="ImageHandler" default=""/> | |
1550 | </paramlist> | |
1551 | </staticmethod> | |
1552 | <staticmethod name="InsertHandler" type="" overloaded="no"> | |
1553 | <autodoc>InsertHandler(ImageHandler handler)</autodoc> | |
1554 | <paramlist> | |
1555 | <param name="handler" type="ImageHandler" default=""/> | |
1556 | </paramlist> | |
1557 | </staticmethod> | |
1558 | <staticmethod name="RemoveHandler" type="bool" overloaded="no"> | |
1559 | <autodoc>RemoveHandler(String name) -> bool</autodoc> | |
1560 | <paramlist> | |
1561 | <param name="name" type="String" default=""/> | |
1562 | </paramlist> | |
1563 | </staticmethod> | |
1564 | <staticmethod name="GetImageExtWildcard" type="String" overloaded="no"> | |
1565 | <autodoc>GetImageExtWildcard() -> String</autodoc> | |
1566 | </staticmethod> | |
1567 | <method name="ConvertToBitmap" type="wxBitmap" overloaded="no"> | |
781d2982 | 1568 | <autodoc>ConvertToBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
1569 | </method> |
1570 | <method name="ConvertToMonoBitmap" type="wxBitmap" overloaded="no"> | |
781d2982 | 1571 | <autodoc>ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap</autodoc> |
f32fc4bc RD |
1572 | <paramlist> |
1573 | <param name="red" type="unsigned char" default=""/> | |
1574 | <param name="green" type="unsigned char" default=""/> | |
1575 | <param name="blue" type="unsigned char" default=""/> | |
1576 | </paramlist> | |
1577 | </method> | |
1578 | </class> | |
781d2982 RD |
1579 | <pythoncode> |
1580 | def InitAllImageHandlers(): | |
1581 | """ | |
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. | |
1584 | """ | |
1585 | pass | |
1586 | </pythoncode> | |
1587 | <class name="BMPHandler" oldname="wxBMPHandler" module="_core"> | |
f32fc4bc RD |
1588 | <baseclass name="ImageHandler"/> |
1589 | <constructor name="BMPHandler" overloaded="no"> | |
781d2982 | 1590 | <autodoc>__init__(self) -> BMPHandler</autodoc> |
f32fc4bc RD |
1591 | </constructor> |
1592 | </class> | |
781d2982 | 1593 | <class name="ICOHandler" oldname="wxICOHandler" module="_core"> |
f32fc4bc RD |
1594 | <baseclass name="BMPHandler"/> |
1595 | <constructor name="ICOHandler" overloaded="no"> | |
781d2982 | 1596 | <autodoc>__init__(self) -> ICOHandler</autodoc> |
f32fc4bc RD |
1597 | </constructor> |
1598 | </class> | |
781d2982 | 1599 | <class name="CURHandler" oldname="wxCURHandler" module="_core"> |
f32fc4bc RD |
1600 | <baseclass name="ICOHandler"/> |
1601 | <constructor name="CURHandler" overloaded="no"> | |
781d2982 | 1602 | <autodoc>__init__(self) -> CURHandler</autodoc> |
f32fc4bc RD |
1603 | </constructor> |
1604 | </class> | |
781d2982 | 1605 | <class name="ANIHandler" oldname="wxANIHandler" module="_core"> |
f32fc4bc RD |
1606 | <baseclass name="CURHandler"/> |
1607 | <constructor name="ANIHandler" overloaded="no"> | |
781d2982 | 1608 | <autodoc>__init__(self) -> ANIHandler</autodoc> |
f32fc4bc RD |
1609 | </constructor> |
1610 | </class> | |
781d2982 | 1611 | <class name="PNGHandler" oldname="wxPNGHandler" module="_core"> |
f32fc4bc RD |
1612 | <baseclass name="ImageHandler"/> |
1613 | <constructor name="PNGHandler" overloaded="no"> | |
781d2982 | 1614 | <autodoc>__init__(self) -> PNGHandler</autodoc> |
f32fc4bc RD |
1615 | </constructor> |
1616 | </class> | |
781d2982 | 1617 | <class name="GIFHandler" oldname="wxGIFHandler" module="_core"> |
f32fc4bc RD |
1618 | <baseclass name="ImageHandler"/> |
1619 | <constructor name="GIFHandler" overloaded="no"> | |
781d2982 | 1620 | <autodoc>__init__(self) -> GIFHandler</autodoc> |
f32fc4bc RD |
1621 | </constructor> |
1622 | </class> | |
781d2982 | 1623 | <class name="PCXHandler" oldname="wxPCXHandler" module="_core"> |
f32fc4bc RD |
1624 | <baseclass name="ImageHandler"/> |
1625 | <constructor name="PCXHandler" overloaded="no"> | |
781d2982 | 1626 | <autodoc>__init__(self) -> PCXHandler</autodoc> |
f32fc4bc RD |
1627 | </constructor> |
1628 | </class> | |
781d2982 | 1629 | <class name="JPEGHandler" oldname="wxJPEGHandler" module="_core"> |
f32fc4bc RD |
1630 | <baseclass name="ImageHandler"/> |
1631 | <constructor name="JPEGHandler" overloaded="no"> | |
781d2982 | 1632 | <autodoc>__init__(self) -> JPEGHandler</autodoc> |
f32fc4bc RD |
1633 | </constructor> |
1634 | </class> | |
781d2982 | 1635 | <class name="PNMHandler" oldname="wxPNMHandler" module="_core"> |
f32fc4bc RD |
1636 | <baseclass name="ImageHandler"/> |
1637 | <constructor name="PNMHandler" overloaded="no"> | |
781d2982 | 1638 | <autodoc>__init__(self) -> PNMHandler</autodoc> |
f32fc4bc RD |
1639 | </constructor> |
1640 | </class> | |
781d2982 | 1641 | <class name="XPMHandler" oldname="wxXPMHandler" module="_core"> |
f32fc4bc RD |
1642 | <baseclass name="ImageHandler"/> |
1643 | <constructor name="XPMHandler" overloaded="no"> | |
781d2982 | 1644 | <autodoc>__init__(self) -> XPMHandler</autodoc> |
f32fc4bc RD |
1645 | </constructor> |
1646 | </class> | |
781d2982 | 1647 | <class name="TIFFHandler" oldname="wxTIFFHandler" module="_core"> |
f32fc4bc RD |
1648 | <baseclass name="ImageHandler"/> |
1649 | <constructor name="TIFFHandler" overloaded="no"> | |
781d2982 | 1650 | <autodoc>__init__(self) -> TIFFHandler</autodoc> |
f32fc4bc RD |
1651 | </constructor> |
1652 | </class> | |
ce6878e6 RD |
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> | |
1661 | <paramlist> | |
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"/> | |
1666 | </paramlist> | |
1667 | </staticmethod> | |
1668 | </class> | |
f32fc4bc | 1669 | <pythoncode> |
856bf319 RD |
1670 | #--------------------------------------------------------------------------- |
1671 | </pythoncode> | |
781d2982 | 1672 | <class name="EvtHandler" oldname="wxEvtHandler" module="_core"> |
f32fc4bc RD |
1673 | <baseclass name="Object"/> |
1674 | <constructor name="EvtHandler" overloaded="no"> | |
781d2982 | 1675 | <autodoc>__init__(self) -> EvtHandler</autodoc> |
f32fc4bc RD |
1676 | </constructor> |
1677 | <method name="GetNextHandler" type="EvtHandler" overloaded="no"> | |
781d2982 | 1678 | <autodoc>GetNextHandler(self) -> EvtHandler</autodoc> |
f32fc4bc RD |
1679 | </method> |
1680 | <method name="GetPreviousHandler" type="EvtHandler" overloaded="no"> | |
781d2982 | 1681 | <autodoc>GetPreviousHandler(self) -> EvtHandler</autodoc> |
f32fc4bc RD |
1682 | </method> |
1683 | <method name="SetNextHandler" type="" overloaded="no"> | |
781d2982 | 1684 | <autodoc>SetNextHandler(self, EvtHandler handler)</autodoc> |
f32fc4bc RD |
1685 | <paramlist> |
1686 | <param name="handler" type="EvtHandler" default=""/> | |
1687 | </paramlist> | |
1688 | </method> | |
1689 | <method name="SetPreviousHandler" type="" overloaded="no"> | |
781d2982 | 1690 | <autodoc>SetPreviousHandler(self, EvtHandler handler)</autodoc> |
f32fc4bc RD |
1691 | <paramlist> |
1692 | <param name="handler" type="EvtHandler" default=""/> | |
1693 | </paramlist> | |
1694 | </method> | |
1695 | <method name="GetEvtHandlerEnabled" type="bool" overloaded="no"> | |
781d2982 | 1696 | <autodoc>GetEvtHandlerEnabled(self) -> bool</autodoc> |
f32fc4bc RD |
1697 | </method> |
1698 | <method name="SetEvtHandlerEnabled" type="" overloaded="no"> | |
781d2982 | 1699 | <autodoc>SetEvtHandlerEnabled(self, bool enabled)</autodoc> |
f32fc4bc RD |
1700 | <paramlist> |
1701 | <param name="enabled" type="bool" default=""/> | |
1702 | </paramlist> | |
1703 | </method> | |
1704 | <method name="ProcessEvent" type="bool" overloaded="no"> | |
781d2982 | 1705 | <autodoc>ProcessEvent(self, Event event) -> bool</autodoc> |
f32fc4bc RD |
1706 | <paramlist> |
1707 | <param name="event" type="wxEvent" default=""/> | |
1708 | </paramlist> | |
1709 | </method> | |
1710 | <method name="AddPendingEvent" type="" overloaded="no"> | |
781d2982 | 1711 | <autodoc>AddPendingEvent(self, Event event)</autodoc> |
f32fc4bc RD |
1712 | <paramlist> |
1713 | <param name="event" type="wxEvent" default=""/> | |
1714 | </paramlist> | |
1715 | </method> | |
1716 | <method name="ProcessPendingEvents" type="" overloaded="no"> | |
781d2982 | 1717 | <autodoc>ProcessPendingEvents(self)</autodoc> |
f32fc4bc RD |
1718 | </method> |
1719 | <method name="Connect" type="" overloaded="no"> | |
781d2982 | 1720 | <autodoc>Connect(self, int id, int lastId, int eventType, PyObject func)</autodoc> |
f32fc4bc RD |
1721 | <paramlist> |
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=""/> | |
1726 | </paramlist> | |
1727 | </method> | |
1728 | <method name="Disconnect" type="bool" overloaded="no"> | |
781d2982 | 1729 | <autodoc>Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool</autodoc> |
f32fc4bc RD |
1730 | <paramlist> |
1731 | <param name="id" type="int" default=""/> | |
1732 | <param name="lastId" type="int" default="-1"/> | |
1733 | <param name="eventType" type="wxEventType" default="wxEVT_NULL"/> | |
1734 | </paramlist> | |
1735 | </method> | |
1736 | <method name="_setOORInfo" type="" overloaded="no"> | |
781d2982 | 1737 | <autodoc>_setOORInfo(self, PyObject _self)</autodoc> |
f32fc4bc RD |
1738 | <paramlist> |
1739 | <param name="_self" type="PyObject" default=""/> | |
1740 | </paramlist> | |
1741 | </method> | |
1742 | </class> | |
856bf319 | 1743 | <pythoncode> |
856bf319 RD |
1744 | |
1745 | #--------------------------------------------------------------------------- | |
1746 | ||
1747 | class PyEventBinder(object): | |
1748 | """ | |
1749 | Instances of this class are used to bind specific events to event | |
1750 | handlers. | |
1751 | """ | |
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 | |
1756 | ||
1757 | if type(evtType) == list or type(evtType) == tuple: | |
1758 | self.evtType = evtType | |
1759 | else: | |
1760 | self.evtType = [evtType] | |
1761 | ||
1762 | ||
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) | |
1767 | ||
781d2982 RD |
1768 | |
1769 | def Unbind(self, target, id1, id2): | |
1770 | """Remove an event binding.""" | |
1771 | success = 0 | |
1772 | for et in self.evtType: | |
1773 | success += target.Disconnect(id1, id2, et) | |
1774 | return success != 0 | |
1775 | ||
856bf319 RD |
1776 | |
1777 | def __call__(self, *args): | |
1778 | """ | |
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 | |
1782 | type of the event. | |
1783 | """ | |
1784 | assert len(args) == 2 + self.expectedIDs | |
1785 | id1 = wx.ID_ANY | |
1786 | id2 = wx.ID_ANY | |
1787 | target = args[0] | |
1788 | if self.expectedIDs == 0: | |
1789 | func = args[1] | |
1790 | elif self.expectedIDs == 1: | |
1791 | id1 = args[1] | |
1792 | func = args[2] | |
1793 | elif self.expectedIDs == 2: | |
1794 | id1 = args[1] | |
1795 | id2 = args[2] | |
1796 | func = args[3] | |
1797 | else: | |
1798 | raise ValueError, "Unexpected number of IDs" | |
1799 | ||
1800 | self.Bind(target, id1, id2, func) | |
1801 | ||
1802 | ||
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) | |
1808 | ||
1809 | ||
1810 | #--------------------------------------------------------------------------- | |
1811 | </pythoncode> | |
f32fc4bc | 1812 | <pythoncode> |
856bf319 RD |
1813 | #--------------------------------------------------------------------------- |
1814 | </pythoncode> | |
f32fc4bc RD |
1815 | <method name="NewEventType" oldname="wxNewEventType" type="wxEventType" overloaded="no"> |
1816 | <autodoc>NewEventType() -> wxEventType</autodoc> | |
1817 | </method> | |
1818 | <pythoncode> | |
856bf319 RD |
1819 | # |
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 ) | |
1861 | ||
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 ) | |
1875 | ||
1876 | EVT_MOUSE_EVENTS = wx.PyEventBinder([ wxEVT_LEFT_DOWN, | |
1877 | wxEVT_LEFT_UP, | |
1878 | wxEVT_MIDDLE_DOWN, | |
1879 | wxEVT_MIDDLE_UP, | |
1880 | wxEVT_RIGHT_DOWN, | |
1881 | wxEVT_RIGHT_UP, | |
1882 | wxEVT_MOTION, | |
1883 | wxEVT_LEFT_DCLICK, | |
1884 | wxEVT_MIDDLE_DCLICK, | |
1885 | wxEVT_RIGHT_DCLICK, | |
1886 | wxEVT_ENTER_WINDOW, | |
1887 | wxEVT_LEAVE_WINDOW, | |
1888 | wxEVT_MOUSEWHEEL | |
1889 | ]) | |
1890 | ||
1891 | ||
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, | |
1901 | ]) | |
1902 | ||
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 ) | |
1911 | ||
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, | |
1922 | ]) | |
1923 | ||
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 ) | |
0f43fbdf RD |
1932 | EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL ) |
1933 | ||
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, | |
1944 | ], 1) | |
1945 | ||
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) | |
1955 | ||
0f43fbdf RD |
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) | |
1966 | ||
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) | |
1976 | ||
1977 | ||
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) | |
1985 | ||
1986 | EVT_IDLE = wx.PyEventBinder( wxEVT_IDLE ) | |
1987 | ||
1988 | EVT_UPDATE_UI = wx.PyEventBinder( wxEVT_UPDATE_UI, 1) | |
1989 | EVT_UPDATE_UI_RANGE = wx.PyEventBinder( wxEVT_UPDATE_UI, 2) | |
1990 | ||
1991 | EVT_CONTEXT_MENU = wx.PyEventBinder( wxEVT_CONTEXT_MENU ) | |
1992 | ||
1993 | ||
1994 | </pythoncode> | |
f32fc4bc | 1995 | <pythoncode> |
0f43fbdf RD |
1996 | #--------------------------------------------------------------------------- |
1997 | </pythoncode> | |
781d2982 | 1998 | <class name="Event" oldname="wxEvent" module="_core"> |
f32fc4bc RD |
1999 | <baseclass name="Object"/> |
2000 | <destructor name="~wxEvent" overloaded="no"> | |
781d2982 | 2001 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
2002 | </destructor> |
2003 | <method name="SetEventType" type="" overloaded="no"> | |
781d2982 | 2004 | <autodoc>SetEventType(self, wxEventType typ)</autodoc> |
f32fc4bc RD |
2005 | <paramlist> |
2006 | <param name="typ" type="wxEventType" default=""/> | |
2007 | </paramlist> | |
2008 | </method> | |
2009 | <method name="GetEventType" type="wxEventType" overloaded="no"> | |
781d2982 | 2010 | <autodoc>GetEventType(self) -> wxEventType</autodoc> |
f32fc4bc RD |
2011 | </method> |
2012 | <method name="GetEventObject" type="Object" overloaded="no"> | |
781d2982 | 2013 | <autodoc>GetEventObject(self) -> Object</autodoc> |
f32fc4bc RD |
2014 | </method> |
2015 | <method name="SetEventObject" type="" overloaded="no"> | |
781d2982 | 2016 | <autodoc>SetEventObject(self, Object obj)</autodoc> |
f32fc4bc RD |
2017 | <paramlist> |
2018 | <param name="obj" type="Object" default=""/> | |
2019 | </paramlist> | |
2020 | </method> | |
2021 | <method name="GetTimestamp" type="long" overloaded="no"> | |
781d2982 | 2022 | <autodoc>GetTimestamp(self) -> long</autodoc> |
f32fc4bc RD |
2023 | </method> |
2024 | <method name="SetTimestamp" type="" overloaded="no"> | |
781d2982 | 2025 | <autodoc>SetTimestamp(self, long ts=0)</autodoc> |
f32fc4bc RD |
2026 | <paramlist> |
2027 | <param name="ts" type="long" default="0"/> | |
2028 | </paramlist> | |
2029 | </method> | |
2030 | <method name="GetId" type="int" overloaded="no"> | |
781d2982 | 2031 | <autodoc>GetId(self) -> int</autodoc> |
f32fc4bc RD |
2032 | </method> |
2033 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 2034 | <autodoc>SetId(self, int Id)</autodoc> |
f32fc4bc RD |
2035 | <paramlist> |
2036 | <param name="Id" type="int" default=""/> | |
2037 | </paramlist> | |
2038 | </method> | |
2039 | <method name="IsCommandEvent" type="bool" overloaded="no"> | |
781d2982 | 2040 | <autodoc>IsCommandEvent(self) -> bool</autodoc> |
f32fc4bc RD |
2041 | </method> |
2042 | <method name="Skip" type="" overloaded="no"> | |
781d2982 | 2043 | <autodoc>Skip(self, bool skip=True)</autodoc> |
f32fc4bc RD |
2044 | <paramlist> |
2045 | <param name="skip" type="bool" default="True"/> | |
2046 | </paramlist> | |
2047 | </method> | |
2048 | <method name="GetSkipped" type="bool" overloaded="no"> | |
781d2982 | 2049 | <autodoc>GetSkipped(self) -> bool</autodoc> |
f32fc4bc RD |
2050 | </method> |
2051 | <method name="ShouldPropagate" type="bool" overloaded="no"> | |
781d2982 | 2052 | <autodoc>ShouldPropagate(self) -> bool</autodoc> |
f32fc4bc RD |
2053 | </method> |
2054 | <method name="StopPropagation" type="int" overloaded="no"> | |
781d2982 | 2055 | <autodoc>StopPropagation(self) -> int</autodoc> |
f32fc4bc RD |
2056 | </method> |
2057 | <method name="ResumePropagation" type="" overloaded="no"> | |
781d2982 | 2058 | <autodoc>ResumePropagation(self, int propagationLevel)</autodoc> |
f32fc4bc RD |
2059 | <paramlist> |
2060 | <param name="propagationLevel" type="int" default=""/> | |
2061 | </paramlist> | |
2062 | </method> | |
2063 | <method name="Clone" type="Event" overloaded="no"> | |
781d2982 | 2064 | <autodoc>Clone(self) -> Event</autodoc> |
f32fc4bc RD |
2065 | </method> |
2066 | </class> | |
2067 | <pythoncode> | |
0f43fbdf RD |
2068 | #--------------------------------------------------------------------------- |
2069 | </pythoncode> | |
781d2982 | 2070 | <class name="PropagationDisabler" oldname="wxPropagationDisabler" module="_core"> |
f32fc4bc | 2071 | <constructor name="PropagationDisabler" overloaded="no"> |
781d2982 | 2072 | <autodoc>__init__(self, Event event) -> PropagationDisabler</autodoc> |
f32fc4bc RD |
2073 | <paramlist> |
2074 | <param name="event" type="Event" default=""/> | |
2075 | </paramlist> | |
2076 | </constructor> | |
2077 | <destructor name="~wxPropagationDisabler" overloaded="no"> | |
781d2982 | 2078 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
2079 | </destructor> |
2080 | </class> | |
781d2982 | 2081 | <class name="PropagateOnce" oldname="wxPropagateOnce" module="_core"> |
f32fc4bc | 2082 | <constructor name="PropagateOnce" overloaded="no"> |
781d2982 | 2083 | <autodoc>__init__(self, Event event) -> PropagateOnce</autodoc> |
f32fc4bc RD |
2084 | <paramlist> |
2085 | <param name="event" type="Event" default=""/> | |
2086 | </paramlist> | |
2087 | </constructor> | |
2088 | <destructor name="~wxPropagateOnce" overloaded="no"> | |
781d2982 | 2089 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
2090 | </destructor> |
2091 | </class> | |
2092 | <pythoncode> | |
0f43fbdf RD |
2093 | #--------------------------------------------------------------------------- |
2094 | </pythoncode> | |
781d2982 | 2095 | <class name="CommandEvent" oldname="wxCommandEvent" module="_core"> |
f32fc4bc RD |
2096 | <baseclass name="Event"/> |
2097 | <constructor name="CommandEvent" overloaded="no"> | |
781d2982 | 2098 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent</autodoc> |
f32fc4bc RD |
2099 | <paramlist> |
2100 | <param name="commandType" type="wxEventType" default="wxEVT_NULL"/> | |
2101 | <param name="winid" type="int" default="0"/> | |
2102 | </paramlist> | |
2103 | </constructor> | |
2104 | <method name="GetSelection" type="int" overloaded="no"> | |
781d2982 | 2105 | <autodoc>GetSelection(self) -> int</autodoc> |
f32fc4bc RD |
2106 | </method> |
2107 | <method name="SetString" type="" overloaded="no"> | |
781d2982 | 2108 | <autodoc>SetString(self, String s)</autodoc> |
f32fc4bc RD |
2109 | <paramlist> |
2110 | <param name="s" type="String" default=""/> | |
2111 | </paramlist> | |
2112 | </method> | |
2113 | <method name="GetString" type="String" overloaded="no"> | |
781d2982 | 2114 | <autodoc>GetString(self) -> String</autodoc> |
f32fc4bc RD |
2115 | </method> |
2116 | <method name="IsChecked" type="bool" overloaded="no"> | |
781d2982 | 2117 | <autodoc>IsChecked(self) -> bool</autodoc> |
f32fc4bc RD |
2118 | </method> |
2119 | <method name="IsSelection" type="bool" overloaded="no"> | |
781d2982 | 2120 | <autodoc>IsSelection(self) -> bool</autodoc> |
f32fc4bc RD |
2121 | </method> |
2122 | <method name="SetExtraLong" type="" overloaded="no"> | |
781d2982 | 2123 | <autodoc>SetExtraLong(self, long extraLong)</autodoc> |
f32fc4bc RD |
2124 | <paramlist> |
2125 | <param name="extraLong" type="long" default=""/> | |
2126 | </paramlist> | |
2127 | </method> | |
2128 | <method name="GetExtraLong" type="long" overloaded="no"> | |
781d2982 | 2129 | <autodoc>GetExtraLong(self) -> long</autodoc> |
f32fc4bc RD |
2130 | </method> |
2131 | <method name="SetInt" type="" overloaded="no"> | |
781d2982 | 2132 | <autodoc>SetInt(self, int i)</autodoc> |
f32fc4bc RD |
2133 | <paramlist> |
2134 | <param name="i" type="int" default=""/> | |
2135 | </paramlist> | |
2136 | </method> | |
2137 | <method name="GetInt" type="long" overloaded="no"> | |
781d2982 | 2138 | <autodoc>GetInt(self) -> long</autodoc> |
f32fc4bc RD |
2139 | </method> |
2140 | <method name="Clone" type="Event" overloaded="no"> | |
781d2982 | 2141 | <autodoc>Clone(self) -> Event</autodoc> |
f32fc4bc RD |
2142 | </method> |
2143 | </class> | |
2144 | <pythoncode> | |
0f43fbdf RD |
2145 | #--------------------------------------------------------------------------- |
2146 | </pythoncode> | |
781d2982 | 2147 | <class name="NotifyEvent" oldname="wxNotifyEvent" module="_core"> |
f32fc4bc RD |
2148 | <baseclass name="CommandEvent"/> |
2149 | <constructor name="NotifyEvent" overloaded="no"> | |
781d2982 | 2150 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent</autodoc> |
f32fc4bc RD |
2151 | <paramlist> |
2152 | <param name="commandType" type="wxEventType" default="wxEVT_NULL"/> | |
2153 | <param name="winid" type="int" default="0"/> | |
2154 | </paramlist> | |
2155 | </constructor> | |
2156 | <method name="Veto" type="" overloaded="no"> | |
781d2982 | 2157 | <autodoc>Veto(self)</autodoc> |
f32fc4bc RD |
2158 | </method> |
2159 | <method name="Allow" type="" overloaded="no"> | |
781d2982 | 2160 | <autodoc>Allow(self)</autodoc> |
f32fc4bc RD |
2161 | </method> |
2162 | <method name="IsAllowed" type="bool" overloaded="no"> | |
781d2982 | 2163 | <autodoc>IsAllowed(self) -> bool</autodoc> |
f32fc4bc RD |
2164 | </method> |
2165 | </class> | |
2166 | <pythoncode> | |
0f43fbdf RD |
2167 | #--------------------------------------------------------------------------- |
2168 | </pythoncode> | |
781d2982 | 2169 | <class name="ScrollEvent" oldname="wxScrollEvent" module="_core"> |
f32fc4bc RD |
2170 | <baseclass name="CommandEvent"/> |
2171 | <constructor name="ScrollEvent" overloaded="no"> | |
781d2982 | 2172 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0, |
0f43fbdf | 2173 | int orient=0) -> ScrollEvent</autodoc> |
f32fc4bc RD |
2174 | <paramlist> |
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"/> | |
2179 | </paramlist> | |
2180 | </constructor> | |
2181 | <method name="GetOrientation" type="int" overloaded="no"> | |
781d2982 | 2182 | <autodoc>GetOrientation(self) -> int</autodoc> |
f32fc4bc RD |
2183 | </method> |
2184 | <method name="GetPosition" type="int" overloaded="no"> | |
781d2982 | 2185 | <autodoc>GetPosition(self) -> int</autodoc> |
f32fc4bc RD |
2186 | </method> |
2187 | <method name="SetOrientation" type="" overloaded="no"> | |
781d2982 | 2188 | <autodoc>SetOrientation(self, int orient)</autodoc> |
f32fc4bc RD |
2189 | <paramlist> |
2190 | <param name="orient" type="int" default=""/> | |
2191 | </paramlist> | |
2192 | </method> | |
2193 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 2194 | <autodoc>SetPosition(self, int pos)</autodoc> |
f32fc4bc RD |
2195 | <paramlist> |
2196 | <param name="pos" type="int" default=""/> | |
2197 | </paramlist> | |
2198 | </method> | |
2199 | </class> | |
2200 | <pythoncode> | |
0f43fbdf RD |
2201 | #--------------------------------------------------------------------------- |
2202 | </pythoncode> | |
781d2982 | 2203 | <class name="ScrollWinEvent" oldname="wxScrollWinEvent" module="_core"> |
f32fc4bc RD |
2204 | <baseclass name="Event"/> |
2205 | <constructor name="ScrollWinEvent" overloaded="no"> | |
781d2982 | 2206 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent</autodoc> |
f32fc4bc RD |
2207 | <paramlist> |
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"/> | |
2211 | </paramlist> | |
2212 | </constructor> | |
2213 | <method name="GetOrientation" type="int" overloaded="no"> | |
781d2982 | 2214 | <autodoc>GetOrientation(self) -> int</autodoc> |
f32fc4bc RD |
2215 | </method> |
2216 | <method name="GetPosition" type="int" overloaded="no"> | |
781d2982 | 2217 | <autodoc>GetPosition(self) -> int</autodoc> |
f32fc4bc RD |
2218 | </method> |
2219 | <method name="SetOrientation" type="" overloaded="no"> | |
781d2982 | 2220 | <autodoc>SetOrientation(self, int orient)</autodoc> |
f32fc4bc RD |
2221 | <paramlist> |
2222 | <param name="orient" type="int" default=""/> | |
2223 | </paramlist> | |
2224 | </method> | |
2225 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 2226 | <autodoc>SetPosition(self, int pos)</autodoc> |
f32fc4bc RD |
2227 | <paramlist> |
2228 | <param name="pos" type="int" default=""/> | |
2229 | </paramlist> | |
2230 | </method> | |
2231 | </class> | |
2232 | <pythoncode> | |
0f43fbdf RD |
2233 | #--------------------------------------------------------------------------- |
2234 | </pythoncode> | |
781d2982 | 2235 | <class name="MouseEvent" oldname="wxMouseEvent" module="_core"> |
f32fc4bc RD |
2236 | <baseclass name="Event"/> |
2237 | <constructor name="MouseEvent" overloaded="no"> | |
781d2982 | 2238 | <autodoc>__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent</autodoc> |
f32fc4bc RD |
2239 | <paramlist> |
2240 | <param name="mouseType" type="wxEventType" default="wxEVT_NULL"/> | |
2241 | </paramlist> | |
2242 | </constructor> | |
2243 | <method name="IsButton" type="bool" overloaded="no"> | |
781d2982 | 2244 | <autodoc>IsButton(self) -> bool</autodoc> |
f32fc4bc RD |
2245 | </method> |
2246 | <method name="ButtonDown" type="bool" overloaded="no"> | |
781d2982 | 2247 | <autodoc>ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool</autodoc> |
f32fc4bc RD |
2248 | <paramlist> |
2249 | <param name="but" type="int" default="wxMOUSE_BTN_ANY"/> | |
2250 | </paramlist> | |
2251 | </method> | |
2252 | <method name="ButtonDClick" type="bool" overloaded="no"> | |
781d2982 | 2253 | <autodoc>ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool</autodoc> |
f32fc4bc RD |
2254 | <paramlist> |
2255 | <param name="but" type="int" default="wxMOUSE_BTN_ANY"/> | |
2256 | </paramlist> | |
2257 | </method> | |
2258 | <method name="ButtonUp" type="bool" overloaded="no"> | |
781d2982 | 2259 | <autodoc>ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool</autodoc> |
f32fc4bc RD |
2260 | <paramlist> |
2261 | <param name="but" type="int" default="wxMOUSE_BTN_ANY"/> | |
2262 | </paramlist> | |
2263 | </method> | |
2264 | <method name="Button" type="bool" overloaded="no"> | |
781d2982 | 2265 | <autodoc>Button(self, int but) -> bool</autodoc> |
f32fc4bc RD |
2266 | <paramlist> |
2267 | <param name="but" type="int" default=""/> | |
2268 | </paramlist> | |
2269 | </method> | |
2270 | <method name="ButtonIsDown" type="bool" overloaded="no"> | |
781d2982 | 2271 | <autodoc>ButtonIsDown(self, int but) -> bool</autodoc> |
f32fc4bc RD |
2272 | <paramlist> |
2273 | <param name="but" type="int" default=""/> | |
2274 | </paramlist> | |
2275 | </method> | |
2276 | <method name="GetButton" type="int" overloaded="no"> | |
781d2982 | 2277 | <autodoc>GetButton(self) -> int</autodoc> |
f32fc4bc RD |
2278 | </method> |
2279 | <method name="ControlDown" type="bool" overloaded="no"> | |
781d2982 | 2280 | <autodoc>ControlDown(self) -> bool</autodoc> |
f32fc4bc RD |
2281 | </method> |
2282 | <method name="MetaDown" type="bool" overloaded="no"> | |
781d2982 | 2283 | <autodoc>MetaDown(self) -> bool</autodoc> |
f32fc4bc RD |
2284 | </method> |
2285 | <method name="AltDown" type="bool" overloaded="no"> | |
781d2982 | 2286 | <autodoc>AltDown(self) -> bool</autodoc> |
f32fc4bc RD |
2287 | </method> |
2288 | <method name="ShiftDown" type="bool" overloaded="no"> | |
781d2982 | 2289 | <autodoc>ShiftDown(self) -> bool</autodoc> |
f32fc4bc | 2290 | </method> |
ce6878e6 RD |
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> | |
2300 | </method> | |
f32fc4bc | 2301 | <method name="LeftDown" type="bool" overloaded="no"> |
781d2982 | 2302 | <autodoc>LeftDown(self) -> bool</autodoc> |
f32fc4bc RD |
2303 | </method> |
2304 | <method name="MiddleDown" type="bool" overloaded="no"> | |
781d2982 | 2305 | <autodoc>MiddleDown(self) -> bool</autodoc> |
f32fc4bc RD |
2306 | </method> |
2307 | <method name="RightDown" type="bool" overloaded="no"> | |
781d2982 | 2308 | <autodoc>RightDown(self) -> bool</autodoc> |
f32fc4bc RD |
2309 | </method> |
2310 | <method name="LeftUp" type="bool" overloaded="no"> | |
781d2982 | 2311 | <autodoc>LeftUp(self) -> bool</autodoc> |
f32fc4bc RD |
2312 | </method> |
2313 | <method name="MiddleUp" type="bool" overloaded="no"> | |
781d2982 | 2314 | <autodoc>MiddleUp(self) -> bool</autodoc> |
f32fc4bc RD |
2315 | </method> |
2316 | <method name="RightUp" type="bool" overloaded="no"> | |
781d2982 | 2317 | <autodoc>RightUp(self) -> bool</autodoc> |
f32fc4bc RD |
2318 | </method> |
2319 | <method name="LeftDClick" type="bool" overloaded="no"> | |
781d2982 | 2320 | <autodoc>LeftDClick(self) -> bool</autodoc> |
f32fc4bc RD |
2321 | </method> |
2322 | <method name="MiddleDClick" type="bool" overloaded="no"> | |
781d2982 | 2323 | <autodoc>MiddleDClick(self) -> bool</autodoc> |
f32fc4bc RD |
2324 | </method> |
2325 | <method name="RightDClick" type="bool" overloaded="no"> | |
781d2982 | 2326 | <autodoc>RightDClick(self) -> bool</autodoc> |
f32fc4bc RD |
2327 | </method> |
2328 | <method name="LeftIsDown" type="bool" overloaded="no"> | |
781d2982 | 2329 | <autodoc>LeftIsDown(self) -> bool</autodoc> |
f32fc4bc RD |
2330 | </method> |
2331 | <method name="MiddleIsDown" type="bool" overloaded="no"> | |
781d2982 | 2332 | <autodoc>MiddleIsDown(self) -> bool</autodoc> |
f32fc4bc RD |
2333 | </method> |
2334 | <method name="RightIsDown" type="bool" overloaded="no"> | |
781d2982 | 2335 | <autodoc>RightIsDown(self) -> bool</autodoc> |
f32fc4bc RD |
2336 | </method> |
2337 | <method name="Dragging" type="bool" overloaded="no"> | |
781d2982 | 2338 | <autodoc>Dragging(self) -> bool</autodoc> |
f32fc4bc RD |
2339 | </method> |
2340 | <method name="Moving" type="bool" overloaded="no"> | |
781d2982 | 2341 | <autodoc>Moving(self) -> bool</autodoc> |
f32fc4bc RD |
2342 | </method> |
2343 | <method name="Entering" type="bool" overloaded="no"> | |
781d2982 | 2344 | <autodoc>Entering(self) -> bool</autodoc> |
f32fc4bc RD |
2345 | </method> |
2346 | <method name="Leaving" type="bool" overloaded="no"> | |
781d2982 | 2347 | <autodoc>Leaving(self) -> bool</autodoc> |
f32fc4bc RD |
2348 | </method> |
2349 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 RD |
2350 | <autodoc>GetPosition(self) -> Point</autodoc> |
2351 | <docstring>Returns the position of the mouse in window coordinates when the event | |
2352 | happened.</docstring> | |
f32fc4bc RD |
2353 | </method> |
2354 | <method name="GetPositionTuple" type="" overloaded="no"> | |
2355 | <autodoc>GetPositionTuple() -> (x,y)</autodoc> | |
781d2982 RD |
2356 | <docstring>Returns the position of the mouse in window coordinates when the event |
2357 | happened.</docstring> | |
f32fc4bc RD |
2358 | <paramlist> |
2359 | <param name="OUTPUT" type="long" default=""/> | |
2360 | <param name="OUTPUT" type="long" default=""/> | |
2361 | </paramlist> | |
2362 | </method> | |
2363 | <method name="GetLogicalPosition" type="Point" overloaded="no"> | |
781d2982 | 2364 | <autodoc>GetLogicalPosition(self, DC dc) -> Point</autodoc> |
f32fc4bc RD |
2365 | <paramlist> |
2366 | <param name="dc" type="wxDC" default=""/> | |
2367 | </paramlist> | |
2368 | </method> | |
2369 | <method name="GetX" type="int" overloaded="no"> | |
781d2982 | 2370 | <autodoc>GetX(self) -> int</autodoc> |
f32fc4bc RD |
2371 | </method> |
2372 | <method name="GetY" type="int" overloaded="no"> | |
781d2982 | 2373 | <autodoc>GetY(self) -> int</autodoc> |
f32fc4bc RD |
2374 | </method> |
2375 | <method name="GetWheelRotation" type="int" overloaded="no"> | |
781d2982 | 2376 | <autodoc>GetWheelRotation(self) -> int</autodoc> |
f32fc4bc RD |
2377 | </method> |
2378 | <method name="GetWheelDelta" type="int" overloaded="no"> | |
781d2982 | 2379 | <autodoc>GetWheelDelta(self) -> int</autodoc> |
f32fc4bc RD |
2380 | </method> |
2381 | <method name="GetLinesPerAction" type="int" overloaded="no"> | |
781d2982 | 2382 | <autodoc>GetLinesPerAction(self) -> int</autodoc> |
f32fc4bc RD |
2383 | </method> |
2384 | <method name="IsPageScroll" type="bool" overloaded="no"> | |
781d2982 | 2385 | <autodoc>IsPageScroll(self) -> bool</autodoc> |
f32fc4bc RD |
2386 | </method> |
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"/> | |
2399 | </class> | |
2400 | <pythoncode> | |
0f43fbdf RD |
2401 | #--------------------------------------------------------------------------- |
2402 | </pythoncode> | |
781d2982 | 2403 | <class name="SetCursorEvent" oldname="wxSetCursorEvent" module="_core"> |
f32fc4bc RD |
2404 | <baseclass name="Event"/> |
2405 | <constructor name="SetCursorEvent" overloaded="no"> | |
781d2982 | 2406 | <autodoc>__init__(self, int x=0, int y=0) -> SetCursorEvent</autodoc> |
f32fc4bc RD |
2407 | <paramlist> |
2408 | <param name="x" type="int" default="0"/> | |
2409 | <param name="y" type="int" default="0"/> | |
2410 | </paramlist> | |
2411 | </constructor> | |
2412 | <method name="GetX" type="int" overloaded="no"> | |
781d2982 | 2413 | <autodoc>GetX(self) -> int</autodoc> |
f32fc4bc RD |
2414 | </method> |
2415 | <method name="GetY" type="int" overloaded="no"> | |
781d2982 | 2416 | <autodoc>GetY(self) -> int</autodoc> |
f32fc4bc RD |
2417 | </method> |
2418 | <method name="SetCursor" type="" overloaded="no"> | |
781d2982 | 2419 | <autodoc>SetCursor(self, Cursor cursor)</autodoc> |
f32fc4bc RD |
2420 | <paramlist> |
2421 | <param name="cursor" type="wxCursor" default=""/> | |
2422 | </paramlist> | |
2423 | </method> | |
2424 | <method name="GetCursor" type="wxCursor" overloaded="no"> | |
781d2982 | 2425 | <autodoc>GetCursor(self) -> Cursor</autodoc> |
f32fc4bc RD |
2426 | </method> |
2427 | <method name="HasCursor" type="bool" overloaded="no"> | |
781d2982 | 2428 | <autodoc>HasCursor(self) -> bool</autodoc> |
f32fc4bc RD |
2429 | </method> |
2430 | </class> | |
2431 | <pythoncode> | |
0f43fbdf RD |
2432 | #--------------------------------------------------------------------------- |
2433 | </pythoncode> | |
781d2982 | 2434 | <class name="KeyEvent" oldname="wxKeyEvent" module="_core"> |
f32fc4bc RD |
2435 | <baseclass name="Event"/> |
2436 | <constructor name="KeyEvent" overloaded="no"> | |
781d2982 | 2437 | <autodoc>__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent</autodoc> |
f32fc4bc RD |
2438 | <paramlist> |
2439 | <param name="keyType" type="wxEventType" default="wxEVT_NULL"/> | |
2440 | </paramlist> | |
2441 | </constructor> | |
2442 | <method name="ControlDown" type="bool" overloaded="no"> | |
781d2982 | 2443 | <autodoc>ControlDown(self) -> bool</autodoc> |
f32fc4bc RD |
2444 | </method> |
2445 | <method name="MetaDown" type="bool" overloaded="no"> | |
781d2982 | 2446 | <autodoc>MetaDown(self) -> bool</autodoc> |
f32fc4bc RD |
2447 | </method> |
2448 | <method name="AltDown" type="bool" overloaded="no"> | |
781d2982 | 2449 | <autodoc>AltDown(self) -> bool</autodoc> |
f32fc4bc RD |
2450 | </method> |
2451 | <method name="ShiftDown" type="bool" overloaded="no"> | |
781d2982 | 2452 | <autodoc>ShiftDown(self) -> bool</autodoc> |
f32fc4bc | 2453 | </method> |
ce6878e6 RD |
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> | |
2463 | </method> | |
f32fc4bc | 2464 | <method name="HasModifiers" type="bool" overloaded="no"> |
781d2982 | 2465 | <autodoc>HasModifiers(self) -> bool</autodoc> |
f32fc4bc RD |
2466 | </method> |
2467 | <method name="GetKeyCode" type="int" overloaded="no"> | |
781d2982 | 2468 | <autodoc>GetKeyCode(self) -> int</autodoc> |
f32fc4bc | 2469 | </method> |
ce6878e6 RD |
2470 | <method name="GetUnicodeKey" type="int" overloaded="no"> |
2471 | <autodoc>GetUnicodeKey(self) -> int</autodoc> | |
f32fc4bc RD |
2472 | </method> |
2473 | <method name="GetRawKeyCode" type="unsigned int" overloaded="no"> | |
781d2982 | 2474 | <autodoc>GetRawKeyCode(self) -> unsigned int</autodoc> |
f32fc4bc RD |
2475 | </method> |
2476 | <method name="GetRawKeyFlags" type="unsigned int" overloaded="no"> | |
781d2982 | 2477 | <autodoc>GetRawKeyFlags(self) -> unsigned int</autodoc> |
f32fc4bc RD |
2478 | </method> |
2479 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 2480 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
2481 | <docstring>Find the position of the event.</docstring> |
2482 | </method> | |
2483 | <method name="GetPositionTuple" type="" overloaded="no"> | |
2484 | <autodoc>GetPositionTuple() -> (x,y)</autodoc> | |
2485 | <docstring>Find the position of the event.</docstring> | |
2486 | <paramlist> | |
2487 | <param name="OUTPUT" type="long" default=""/> | |
2488 | <param name="OUTPUT" type="long" default=""/> | |
2489 | </paramlist> | |
2490 | </method> | |
2491 | <method name="GetX" type="int" overloaded="no"> | |
781d2982 | 2492 | <autodoc>GetX(self) -> int</autodoc> |
f32fc4bc RD |
2493 | </method> |
2494 | <method name="GetY" type="int" overloaded="no"> | |
781d2982 | 2495 | <autodoc>GetY(self) -> int</autodoc> |
f32fc4bc RD |
2496 | </method> |
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"/> | |
2507 | </class> | |
2508 | <pythoncode> | |
0f43fbdf RD |
2509 | #--------------------------------------------------------------------------- |
2510 | </pythoncode> | |
781d2982 | 2511 | <class name="SizeEvent" oldname="wxSizeEvent" module="_core"> |
f32fc4bc RD |
2512 | <baseclass name="Event"/> |
2513 | <constructor name="SizeEvent" overloaded="no"> | |
781d2982 | 2514 | <autodoc>__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent</autodoc> |
f32fc4bc RD |
2515 | <paramlist> |
2516 | <param name="sz" type="Size" default="wxDefaultSize"/> | |
2517 | <param name="winid" type="int" default="0"/> | |
2518 | </paramlist> | |
2519 | </constructor> | |
2520 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 | 2521 | <autodoc>GetSize(self) -> Size</autodoc> |
f32fc4bc RD |
2522 | </method> |
2523 | <method name="GetRect" type="Rect" overloaded="no"> | |
781d2982 | 2524 | <autodoc>GetRect(self) -> Rect</autodoc> |
f32fc4bc RD |
2525 | </method> |
2526 | <method name="SetRect" type="" overloaded="no"> | |
781d2982 | 2527 | <autodoc>SetRect(self, Rect rect)</autodoc> |
f32fc4bc RD |
2528 | <paramlist> |
2529 | <param name="rect" type="Rect" default=""/> | |
2530 | </paramlist> | |
2531 | </method> | |
2532 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 2533 | <autodoc>SetSize(self, Size size)</autodoc> |
f32fc4bc RD |
2534 | <paramlist> |
2535 | <param name="size" type="Size" default=""/> | |
2536 | </paramlist> | |
2537 | </method> | |
2538 | <property name="m_size" type="Size" readonly="no"/> | |
2539 | <property name="m_rect" type="Rect" readonly="no"/> | |
2540 | </class> | |
2541 | <pythoncode> | |
0f43fbdf RD |
2542 | #--------------------------------------------------------------------------- |
2543 | </pythoncode> | |
781d2982 | 2544 | <class name="MoveEvent" oldname="wxMoveEvent" module="_core"> |
f32fc4bc RD |
2545 | <baseclass name="Event"/> |
2546 | <constructor name="MoveEvent" overloaded="no"> | |
781d2982 | 2547 | <autodoc>__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent</autodoc> |
f32fc4bc RD |
2548 | <paramlist> |
2549 | <param name="pos" type="Point" default="wxDefaultPosition"/> | |
2550 | <param name="winid" type="int" default="0"/> | |
2551 | </paramlist> | |
2552 | </constructor> | |
2553 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 2554 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
2555 | </method> |
2556 | <method name="GetRect" type="Rect" overloaded="no"> | |
781d2982 | 2557 | <autodoc>GetRect(self) -> Rect</autodoc> |
f32fc4bc RD |
2558 | </method> |
2559 | <method name="SetRect" type="" overloaded="no"> | |
781d2982 | 2560 | <autodoc>SetRect(self, Rect rect)</autodoc> |
f32fc4bc RD |
2561 | <paramlist> |
2562 | <param name="rect" type="Rect" default=""/> | |
2563 | </paramlist> | |
2564 | </method> | |
2565 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 2566 | <autodoc>SetPosition(self, Point pos)</autodoc> |
f32fc4bc RD |
2567 | <paramlist> |
2568 | <param name="pos" type="Point" default=""/> | |
2569 | </paramlist> | |
2570 | </method> | |
2571 | <property name="m_pos" type="Point" readonly="no"/> | |
2572 | <property name="m_rect" type="Rect" readonly="no"/> | |
2573 | </class> | |
2574 | <pythoncode> | |
0f43fbdf RD |
2575 | #--------------------------------------------------------------------------- |
2576 | </pythoncode> | |
781d2982 | 2577 | <class name="PaintEvent" oldname="wxPaintEvent" module="_core"> |
f32fc4bc RD |
2578 | <baseclass name="Event"/> |
2579 | <constructor name="PaintEvent" overloaded="no"> | |
781d2982 | 2580 | <autodoc>__init__(self, int Id=0) -> PaintEvent</autodoc> |
f32fc4bc RD |
2581 | <paramlist> |
2582 | <param name="Id" type="int" default="0"/> | |
2583 | </paramlist> | |
2584 | </constructor> | |
2585 | </class> | |
781d2982 | 2586 | <class name="NcPaintEvent" oldname="wxNcPaintEvent" module="_core"> |
f32fc4bc RD |
2587 | <baseclass name="Event"/> |
2588 | <constructor name="NcPaintEvent" overloaded="no"> | |
781d2982 | 2589 | <autodoc>__init__(self, int winid=0) -> NcPaintEvent</autodoc> |
f32fc4bc RD |
2590 | <paramlist> |
2591 | <param name="winid" type="int" default="0"/> | |
2592 | </paramlist> | |
2593 | </constructor> | |
2594 | </class> | |
2595 | <pythoncode> | |
0f43fbdf RD |
2596 | #--------------------------------------------------------------------------- |
2597 | </pythoncode> | |
781d2982 | 2598 | <class name="EraseEvent" oldname="wxEraseEvent" module="_core"> |
f32fc4bc RD |
2599 | <baseclass name="Event"/> |
2600 | <constructor name="EraseEvent" overloaded="no"> | |
781d2982 | 2601 | <autodoc>__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent</autodoc> |
f32fc4bc RD |
2602 | <paramlist> |
2603 | <param name="Id" type="int" default="0"/> | |
2604 | <param name="dc" type="wxDC" default="(wxDC *) NULL"/> | |
2605 | </paramlist> | |
2606 | </constructor> | |
2607 | <method name="GetDC" type="wxDC" overloaded="no"> | |
781d2982 | 2608 | <autodoc>GetDC(self) -> DC</autodoc> |
f32fc4bc RD |
2609 | </method> |
2610 | </class> | |
2611 | <pythoncode> | |
0f43fbdf RD |
2612 | #--------------------------------------------------------------------------- |
2613 | </pythoncode> | |
781d2982 | 2614 | <class name="FocusEvent" oldname="wxFocusEvent" module="_core"> |
f32fc4bc RD |
2615 | <baseclass name="Event"/> |
2616 | <constructor name="FocusEvent" overloaded="no"> | |
781d2982 | 2617 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent</autodoc> |
f32fc4bc RD |
2618 | <paramlist> |
2619 | <param name="type" type="wxEventType" default="wxEVT_NULL"/> | |
2620 | <param name="winid" type="int" default="0"/> | |
2621 | </paramlist> | |
2622 | </constructor> | |
2623 | <method name="GetWindow" type="wxWindow" overloaded="no"> | |
781d2982 | 2624 | <autodoc>GetWindow(self) -> Window</autodoc> |
f32fc4bc RD |
2625 | </method> |
2626 | <method name="SetWindow" type="" overloaded="no"> | |
781d2982 | 2627 | <autodoc>SetWindow(self, Window win)</autodoc> |
f32fc4bc RD |
2628 | <paramlist> |
2629 | <param name="win" type="wxWindow" default=""/> | |
2630 | </paramlist> | |
2631 | </method> | |
2632 | </class> | |
2633 | <pythoncode> | |
0f43fbdf RD |
2634 | #--------------------------------------------------------------------------- |
2635 | </pythoncode> | |
781d2982 | 2636 | <class name="ChildFocusEvent" oldname="wxChildFocusEvent" module="_core"> |
f32fc4bc RD |
2637 | <baseclass name="CommandEvent"/> |
2638 | <constructor name="ChildFocusEvent" overloaded="no"> | |
781d2982 | 2639 | <autodoc>__init__(self, Window win=None) -> ChildFocusEvent</autodoc> |
f32fc4bc RD |
2640 | <paramlist> |
2641 | <param name="win" type="wxWindow" default="NULL"/> | |
2642 | </paramlist> | |
2643 | </constructor> | |
2644 | <method name="GetWindow" type="wxWindow" overloaded="no"> | |
781d2982 | 2645 | <autodoc>GetWindow(self) -> Window</autodoc> |
f32fc4bc RD |
2646 | </method> |
2647 | </class> | |
2648 | <pythoncode> | |
0f43fbdf RD |
2649 | #--------------------------------------------------------------------------- |
2650 | </pythoncode> | |
781d2982 | 2651 | <class name="ActivateEvent" oldname="wxActivateEvent" module="_core"> |
f32fc4bc RD |
2652 | <baseclass name="Event"/> |
2653 | <constructor name="ActivateEvent" overloaded="no"> | |
781d2982 | 2654 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent</autodoc> |
f32fc4bc RD |
2655 | <paramlist> |
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"/> | |
2659 | </paramlist> | |
2660 | </constructor> | |
2661 | <method name="GetActive" type="bool" overloaded="no"> | |
781d2982 | 2662 | <autodoc>GetActive(self) -> bool</autodoc> |
f32fc4bc RD |
2663 | </method> |
2664 | </class> | |
2665 | <pythoncode> | |
0f43fbdf RD |
2666 | #--------------------------------------------------------------------------- |
2667 | </pythoncode> | |
781d2982 | 2668 | <class name="InitDialogEvent" oldname="wxInitDialogEvent" module="_core"> |
f32fc4bc RD |
2669 | <baseclass name="Event"/> |
2670 | <constructor name="InitDialogEvent" overloaded="no"> | |
781d2982 | 2671 | <autodoc>__init__(self, int Id=0) -> InitDialogEvent</autodoc> |
f32fc4bc RD |
2672 | <paramlist> |
2673 | <param name="Id" type="int" default="0"/> | |
2674 | </paramlist> | |
2675 | </constructor> | |
2676 | </class> | |
2677 | <pythoncode> | |
0f43fbdf RD |
2678 | #--------------------------------------------------------------------------- |
2679 | </pythoncode> | |
781d2982 | 2680 | <class name="MenuEvent" oldname="wxMenuEvent" module="_core"> |
f32fc4bc RD |
2681 | <baseclass name="Event"/> |
2682 | <constructor name="MenuEvent" overloaded="no"> | |
781d2982 | 2683 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent</autodoc> |
f32fc4bc RD |
2684 | <paramlist> |
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"/> | |
2688 | </paramlist> | |
2689 | </constructor> | |
2690 | <method name="GetMenuId" type="int" overloaded="no"> | |
781d2982 | 2691 | <autodoc>GetMenuId(self) -> int</autodoc> |
f32fc4bc RD |
2692 | </method> |
2693 | <method name="IsPopup" type="bool" overloaded="no"> | |
781d2982 | 2694 | <autodoc>IsPopup(self) -> bool</autodoc> |
f32fc4bc RD |
2695 | </method> |
2696 | <method name="GetMenu" type="wxMenu" overloaded="no"> | |
781d2982 | 2697 | <autodoc>GetMenu(self) -> Menu</autodoc> |
f32fc4bc RD |
2698 | </method> |
2699 | </class> | |
2700 | <pythoncode> | |
0f43fbdf RD |
2701 | #--------------------------------------------------------------------------- |
2702 | </pythoncode> | |
781d2982 | 2703 | <class name="CloseEvent" oldname="wxCloseEvent" module="_core"> |
f32fc4bc RD |
2704 | <baseclass name="Event"/> |
2705 | <constructor name="CloseEvent" overloaded="no"> | |
781d2982 | 2706 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent</autodoc> |
f32fc4bc RD |
2707 | <paramlist> |
2708 | <param name="type" type="wxEventType" default="wxEVT_NULL"/> | |
2709 | <param name="winid" type="int" default="0"/> | |
2710 | </paramlist> | |
2711 | </constructor> | |
2712 | <method name="SetLoggingOff" type="" overloaded="no"> | |
781d2982 | 2713 | <autodoc>SetLoggingOff(self, bool logOff)</autodoc> |
f32fc4bc RD |
2714 | <paramlist> |
2715 | <param name="logOff" type="bool" default=""/> | |
2716 | </paramlist> | |
2717 | </method> | |
2718 | <method name="GetLoggingOff" type="bool" overloaded="no"> | |
781d2982 | 2719 | <autodoc>GetLoggingOff(self) -> bool</autodoc> |
f32fc4bc RD |
2720 | </method> |
2721 | <method name="Veto" type="" overloaded="no"> | |
781d2982 | 2722 | <autodoc>Veto(self, bool veto=True)</autodoc> |
f32fc4bc RD |
2723 | <paramlist> |
2724 | <param name="veto" type="bool" default="True"/> | |
2725 | </paramlist> | |
2726 | </method> | |
2727 | <method name="SetCanVeto" type="" overloaded="no"> | |
781d2982 | 2728 | <autodoc>SetCanVeto(self, bool canVeto)</autodoc> |
f32fc4bc RD |
2729 | <paramlist> |
2730 | <param name="canVeto" type="bool" default=""/> | |
2731 | </paramlist> | |
2732 | </method> | |
2733 | <method name="CanVeto" type="bool" overloaded="no"> | |
781d2982 | 2734 | <autodoc>CanVeto(self) -> bool</autodoc> |
f32fc4bc RD |
2735 | </method> |
2736 | <method name="GetVeto" type="bool" overloaded="no"> | |
781d2982 | 2737 | <autodoc>GetVeto(self) -> bool</autodoc> |
f32fc4bc RD |
2738 | </method> |
2739 | </class> | |
2740 | <pythoncode> | |
0f43fbdf RD |
2741 | #--------------------------------------------------------------------------- |
2742 | </pythoncode> | |
781d2982 | 2743 | <class name="ShowEvent" oldname="wxShowEvent" module="_core"> |
f32fc4bc RD |
2744 | <baseclass name="Event"/> |
2745 | <constructor name="ShowEvent" overloaded="no"> | |
781d2982 | 2746 | <autodoc>__init__(self, int winid=0, bool show=False) -> ShowEvent</autodoc> |
f32fc4bc RD |
2747 | <paramlist> |
2748 | <param name="winid" type="int" default="0"/> | |
2749 | <param name="show" type="bool" default="False"/> | |
2750 | </paramlist> | |
2751 | </constructor> | |
2752 | <method name="SetShow" type="" overloaded="no"> | |
781d2982 | 2753 | <autodoc>SetShow(self, bool show)</autodoc> |
f32fc4bc RD |
2754 | <paramlist> |
2755 | <param name="show" type="bool" default=""/> | |
2756 | </paramlist> | |
2757 | </method> | |
2758 | <method name="GetShow" type="bool" overloaded="no"> | |
781d2982 | 2759 | <autodoc>GetShow(self) -> bool</autodoc> |
f32fc4bc RD |
2760 | </method> |
2761 | </class> | |
2762 | <pythoncode> | |
0f43fbdf RD |
2763 | #--------------------------------------------------------------------------- |
2764 | </pythoncode> | |
781d2982 | 2765 | <class name="IconizeEvent" oldname="wxIconizeEvent" module="_core"> |
f32fc4bc RD |
2766 | <baseclass name="Event"/> |
2767 | <constructor name="IconizeEvent" overloaded="no"> | |
781d2982 | 2768 | <autodoc>__init__(self, int id=0, bool iconized=True) -> IconizeEvent</autodoc> |
f32fc4bc RD |
2769 | <paramlist> |
2770 | <param name="id" type="int" default="0"/> | |
2771 | <param name="iconized" type="bool" default="True"/> | |
2772 | </paramlist> | |
2773 | </constructor> | |
2774 | <method name="Iconized" type="bool" overloaded="no"> | |
781d2982 | 2775 | <autodoc>Iconized(self) -> bool</autodoc> |
f32fc4bc RD |
2776 | </method> |
2777 | </class> | |
2778 | <pythoncode> | |
0f43fbdf RD |
2779 | #--------------------------------------------------------------------------- |
2780 | </pythoncode> | |
781d2982 | 2781 | <class name="MaximizeEvent" oldname="wxMaximizeEvent" module="_core"> |
f32fc4bc RD |
2782 | <baseclass name="Event"/> |
2783 | <constructor name="MaximizeEvent" overloaded="no"> | |
781d2982 | 2784 | <autodoc>__init__(self, int id=0) -> MaximizeEvent</autodoc> |
f32fc4bc RD |
2785 | <paramlist> |
2786 | <param name="id" type="int" default="0"/> | |
2787 | </paramlist> | |
2788 | </constructor> | |
2789 | </class> | |
2790 | <pythoncode> | |
0f43fbdf RD |
2791 | #--------------------------------------------------------------------------- |
2792 | </pythoncode> | |
781d2982 | 2793 | <class name="DropFilesEvent" oldname="wxDropFilesEvent" module="_core"> |
f32fc4bc RD |
2794 | <baseclass name="Event"/> |
2795 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 2796 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
2797 | </method> |
2798 | <method name="GetNumberOfFiles" type="int" overloaded="no"> | |
781d2982 | 2799 | <autodoc>GetNumberOfFiles(self) -> int</autodoc> |
f32fc4bc RD |
2800 | </method> |
2801 | <method name="GetFiles" type="PyObject" overloaded="no"> | |
781d2982 | 2802 | <autodoc>GetFiles(self) -> PyObject</autodoc> |
f32fc4bc RD |
2803 | </method> |
2804 | </class> | |
2805 | <pythoncode> | |
0f43fbdf RD |
2806 | #--------------------------------------------------------------------------- |
2807 | </pythoncode> | |
781d2982 | 2808 | <class name="UpdateUIEvent" oldname="wxUpdateUIEvent" module="_core"> |
f32fc4bc RD |
2809 | <baseclass name="CommandEvent"/> |
2810 | <constructor name="UpdateUIEvent" overloaded="no"> | |
781d2982 | 2811 | <autodoc>__init__(self, int commandId=0) -> UpdateUIEvent</autodoc> |
f32fc4bc RD |
2812 | <paramlist> |
2813 | <param name="commandId" type="int" default="0"/> | |
2814 | </paramlist> | |
2815 | </constructor> | |
2816 | <method name="GetChecked" type="bool" overloaded="no"> | |
781d2982 | 2817 | <autodoc>GetChecked(self) -> bool</autodoc> |
f32fc4bc RD |
2818 | </method> |
2819 | <method name="GetEnabled" type="bool" overloaded="no"> | |
781d2982 | 2820 | <autodoc>GetEnabled(self) -> bool</autodoc> |
f32fc4bc RD |
2821 | </method> |
2822 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 2823 | <autodoc>GetText(self) -> String</autodoc> |
f32fc4bc RD |
2824 | </method> |
2825 | <method name="GetSetText" type="bool" overloaded="no"> | |
781d2982 | 2826 | <autodoc>GetSetText(self) -> bool</autodoc> |
f32fc4bc RD |
2827 | </method> |
2828 | <method name="GetSetChecked" type="bool" overloaded="no"> | |
781d2982 | 2829 | <autodoc>GetSetChecked(self) -> bool</autodoc> |
f32fc4bc RD |
2830 | </method> |
2831 | <method name="GetSetEnabled" type="bool" overloaded="no"> | |
781d2982 | 2832 | <autodoc>GetSetEnabled(self) -> bool</autodoc> |
f32fc4bc RD |
2833 | </method> |
2834 | <method name="Check" type="" overloaded="no"> | |
781d2982 | 2835 | <autodoc>Check(self, bool check)</autodoc> |
f32fc4bc RD |
2836 | <paramlist> |
2837 | <param name="check" type="bool" default=""/> | |
2838 | </paramlist> | |
2839 | </method> | |
2840 | <method name="Enable" type="" overloaded="no"> | |
781d2982 | 2841 | <autodoc>Enable(self, bool enable)</autodoc> |
f32fc4bc RD |
2842 | <paramlist> |
2843 | <param name="enable" type="bool" default=""/> | |
2844 | </paramlist> | |
2845 | </method> | |
2846 | <method name="SetText" type="" overloaded="no"> | |
781d2982 | 2847 | <autodoc>SetText(self, String text)</autodoc> |
f32fc4bc RD |
2848 | <paramlist> |
2849 | <param name="text" type="String" default=""/> | |
2850 | </paramlist> | |
2851 | </method> | |
2852 | <staticmethod name="SetUpdateInterval" type="" overloaded="no"> | |
2853 | <autodoc>SetUpdateInterval(long updateInterval)</autodoc> | |
2854 | <paramlist> | |
2855 | <param name="updateInterval" type="long" default=""/> | |
2856 | </paramlist> | |
2857 | </staticmethod> | |
2858 | <staticmethod name="GetUpdateInterval" type="long" overloaded="no"> | |
2859 | <autodoc>GetUpdateInterval() -> long</autodoc> | |
2860 | </staticmethod> | |
2861 | <staticmethod name="CanUpdate" type="bool" overloaded="no"> | |
2862 | <autodoc>CanUpdate(Window win) -> bool</autodoc> | |
2863 | <paramlist> | |
2864 | <param name="win" type="wxWindow" default=""/> | |
2865 | </paramlist> | |
2866 | </staticmethod> | |
2867 | <staticmethod name="ResetUpdateTime" type="" overloaded="no"> | |
2868 | <autodoc>ResetUpdateTime()</autodoc> | |
2869 | </staticmethod> | |
2870 | <staticmethod name="SetMode" type="" overloaded="no"> | |
2871 | <autodoc>SetMode(int mode)</autodoc> | |
2872 | <paramlist> | |
2873 | <param name="mode" type="wxUpdateUIMode" default=""/> | |
2874 | </paramlist> | |
2875 | </staticmethod> | |
2876 | <staticmethod name="GetMode" type="wxUpdateUIMode" overloaded="no"> | |
2877 | <autodoc>GetMode() -> int</autodoc> | |
2878 | </staticmethod> | |
2879 | </class> | |
2880 | <pythoncode> | |
0f43fbdf RD |
2881 | #--------------------------------------------------------------------------- |
2882 | </pythoncode> | |
781d2982 | 2883 | <class name="SysColourChangedEvent" oldname="wxSysColourChangedEvent" module="_core"> |
f32fc4bc RD |
2884 | <baseclass name="Event"/> |
2885 | <constructor name="SysColourChangedEvent" overloaded="no"> | |
781d2982 | 2886 | <autodoc>__init__(self) -> SysColourChangedEvent</autodoc> |
f32fc4bc RD |
2887 | </constructor> |
2888 | </class> | |
2889 | <pythoncode> | |
0f43fbdf RD |
2890 | #--------------------------------------------------------------------------- |
2891 | </pythoncode> | |
781d2982 | 2892 | <class name="MouseCaptureChangedEvent" oldname="wxMouseCaptureChangedEvent" module="_core"> |
f32fc4bc RD |
2893 | <baseclass name="Event"/> |
2894 | <constructor name="MouseCaptureChangedEvent" overloaded="no"> | |
781d2982 | 2895 | <autodoc>__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent</autodoc> |
f32fc4bc RD |
2896 | <paramlist> |
2897 | <param name="winid" type="int" default="0"/> | |
2898 | <param name="gainedCapture" type="wxWindow" default="NULL"/> | |
2899 | </paramlist> | |
2900 | </constructor> | |
2901 | <method name="GetCapturedWindow" type="wxWindow" overloaded="no"> | |
781d2982 | 2902 | <autodoc>GetCapturedWindow(self) -> Window</autodoc> |
f32fc4bc RD |
2903 | </method> |
2904 | </class> | |
2905 | <pythoncode> | |
0f43fbdf RD |
2906 | #--------------------------------------------------------------------------- |
2907 | </pythoncode> | |
781d2982 | 2908 | <class name="DisplayChangedEvent" oldname="wxDisplayChangedEvent" module="_core"> |
f32fc4bc RD |
2909 | <baseclass name="Event"/> |
2910 | <constructor name="DisplayChangedEvent" overloaded="no"> | |
781d2982 | 2911 | <autodoc>__init__(self) -> DisplayChangedEvent</autodoc> |
f32fc4bc RD |
2912 | </constructor> |
2913 | </class> | |
2914 | <pythoncode> | |
0f43fbdf RD |
2915 | #--------------------------------------------------------------------------- |
2916 | </pythoncode> | |
781d2982 | 2917 | <class name="PaletteChangedEvent" oldname="wxPaletteChangedEvent" module="_core"> |
f32fc4bc RD |
2918 | <baseclass name="Event"/> |
2919 | <constructor name="PaletteChangedEvent" overloaded="no"> | |
781d2982 | 2920 | <autodoc>__init__(self, int id=0) -> PaletteChangedEvent</autodoc> |
f32fc4bc RD |
2921 | <paramlist> |
2922 | <param name="id" type="int" default="0"/> | |
2923 | </paramlist> | |
2924 | </constructor> | |
2925 | <method name="SetChangedWindow" type="" overloaded="no"> | |
781d2982 | 2926 | <autodoc>SetChangedWindow(self, Window win)</autodoc> |
f32fc4bc RD |
2927 | <paramlist> |
2928 | <param name="win" type="wxWindow" default=""/> | |
2929 | </paramlist> | |
2930 | </method> | |
2931 | <method name="GetChangedWindow" type="wxWindow" overloaded="no"> | |
781d2982 | 2932 | <autodoc>GetChangedWindow(self) -> Window</autodoc> |
f32fc4bc RD |
2933 | </method> |
2934 | </class> | |
2935 | <pythoncode> | |
0f43fbdf RD |
2936 | #--------------------------------------------------------------------------- |
2937 | </pythoncode> | |
781d2982 | 2938 | <class name="QueryNewPaletteEvent" oldname="wxQueryNewPaletteEvent" module="_core"> |
f32fc4bc RD |
2939 | <baseclass name="Event"/> |
2940 | <constructor name="QueryNewPaletteEvent" overloaded="no"> | |
781d2982 | 2941 | <autodoc>__init__(self, int winid=0) -> QueryNewPaletteEvent</autodoc> |
f32fc4bc RD |
2942 | <paramlist> |
2943 | <param name="winid" type="int" default="0"/> | |
2944 | </paramlist> | |
2945 | </constructor> | |
2946 | <method name="SetPaletteRealized" type="" overloaded="no"> | |
781d2982 | 2947 | <autodoc>SetPaletteRealized(self, bool realized)</autodoc> |
f32fc4bc RD |
2948 | <paramlist> |
2949 | <param name="realized" type="bool" default=""/> | |
2950 | </paramlist> | |
2951 | </method> | |
2952 | <method name="GetPaletteRealized" type="bool" overloaded="no"> | |
781d2982 | 2953 | <autodoc>GetPaletteRealized(self) -> bool</autodoc> |
f32fc4bc RD |
2954 | </method> |
2955 | </class> | |
2956 | <pythoncode> | |
0f43fbdf RD |
2957 | #--------------------------------------------------------------------------- |
2958 | </pythoncode> | |
781d2982 | 2959 | <class name="NavigationKeyEvent" oldname="wxNavigationKeyEvent" module="_core"> |
f32fc4bc RD |
2960 | <baseclass name="Event"/> |
2961 | <constructor name="NavigationKeyEvent" overloaded="no"> | |
781d2982 | 2962 | <autodoc>__init__(self) -> NavigationKeyEvent</autodoc> |
f32fc4bc RD |
2963 | </constructor> |
2964 | <method name="GetDirection" type="bool" overloaded="no"> | |
781d2982 | 2965 | <autodoc>GetDirection(self) -> bool</autodoc> |
f32fc4bc RD |
2966 | </method> |
2967 | <method name="SetDirection" type="" overloaded="no"> | |
ce6878e6 | 2968 | <autodoc>SetDirection(self, bool forward)</autodoc> |
f32fc4bc | 2969 | <paramlist> |
ce6878e6 | 2970 | <param name="forward" type="bool" default=""/> |
f32fc4bc RD |
2971 | </paramlist> |
2972 | </method> | |
2973 | <method name="IsWindowChange" type="bool" overloaded="no"> | |
781d2982 | 2974 | <autodoc>IsWindowChange(self) -> bool</autodoc> |
f32fc4bc RD |
2975 | </method> |
2976 | <method name="SetWindowChange" type="" overloaded="no"> | |
ce6878e6 RD |
2977 | <autodoc>SetWindowChange(self, bool ischange)</autodoc> |
2978 | <paramlist> | |
2979 | <param name="ischange" type="bool" default=""/> | |
2980 | </paramlist> | |
2981 | </method> | |
2982 | <method name="SetFlags" type="" overloaded="no"> | |
2983 | <autodoc>SetFlags(self, long flags)</autodoc> | |
f32fc4bc | 2984 | <paramlist> |
ce6878e6 | 2985 | <param name="flags" type="long" default=""/> |
f32fc4bc RD |
2986 | </paramlist> |
2987 | </method> | |
2988 | <method name="GetCurrentFocus" type="wxWindow" overloaded="no"> | |
781d2982 | 2989 | <autodoc>GetCurrentFocus(self) -> Window</autodoc> |
f32fc4bc RD |
2990 | </method> |
2991 | <method name="SetCurrentFocus" type="" overloaded="no"> | |
781d2982 | 2992 | <autodoc>SetCurrentFocus(self, Window win)</autodoc> |
f32fc4bc RD |
2993 | <paramlist> |
2994 | <param name="win" type="wxWindow" default=""/> | |
2995 | </paramlist> | |
2996 | </method> | |
2997 | </class> | |
2998 | <pythoncode> | |
0f43fbdf RD |
2999 | #--------------------------------------------------------------------------- |
3000 | </pythoncode> | |
781d2982 | 3001 | <class name="WindowCreateEvent" oldname="wxWindowCreateEvent" module="_core"> |
f32fc4bc RD |
3002 | <baseclass name="CommandEvent"/> |
3003 | <constructor name="WindowCreateEvent" overloaded="no"> | |
781d2982 | 3004 | <autodoc>__init__(self, Window win=None) -> WindowCreateEvent</autodoc> |
f32fc4bc RD |
3005 | <paramlist> |
3006 | <param name="win" type="wxWindow" default="NULL"/> | |
3007 | </paramlist> | |
3008 | </constructor> | |
3009 | <method name="GetWindow" type="wxWindow" overloaded="no"> | |
781d2982 | 3010 | <autodoc>GetWindow(self) -> Window</autodoc> |
f32fc4bc RD |
3011 | </method> |
3012 | </class> | |
781d2982 | 3013 | <class name="WindowDestroyEvent" oldname="wxWindowDestroyEvent" module="_core"> |
f32fc4bc RD |
3014 | <baseclass name="CommandEvent"/> |
3015 | <constructor name="WindowDestroyEvent" overloaded="no"> | |
781d2982 | 3016 | <autodoc>__init__(self, Window win=None) -> WindowDestroyEvent</autodoc> |
f32fc4bc RD |
3017 | <paramlist> |
3018 | <param name="win" type="wxWindow" default="NULL"/> | |
3019 | </paramlist> | |
3020 | </constructor> | |
3021 | <method name="GetWindow" type="wxWindow" overloaded="no"> | |
781d2982 | 3022 | <autodoc>GetWindow(self) -> Window</autodoc> |
f32fc4bc RD |
3023 | </method> |
3024 | </class> | |
3025 | <pythoncode> | |
0f43fbdf RD |
3026 | #--------------------------------------------------------------------------- |
3027 | </pythoncode> | |
781d2982 | 3028 | <class name="ContextMenuEvent" oldname="wxContextMenuEvent" module="_core"> |
f32fc4bc RD |
3029 | <baseclass name="CommandEvent"/> |
3030 | <constructor name="ContextMenuEvent" overloaded="no"> | |
781d2982 | 3031 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent</autodoc> |
f32fc4bc RD |
3032 | <paramlist> |
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"/> | |
3036 | </paramlist> | |
3037 | </constructor> | |
3038 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 3039 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
3040 | </method> |
3041 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 3042 | <autodoc>SetPosition(self, Point pos)</autodoc> |
f32fc4bc RD |
3043 | <paramlist> |
3044 | <param name="pos" type="Point" default=""/> | |
3045 | </paramlist> | |
3046 | </method> | |
3047 | </class> | |
3048 | <pythoncode> | |
856bf319 RD |
3049 | #--------------------------------------------------------------------------- |
3050 | </pythoncode> | |
781d2982 | 3051 | <class name="IdleEvent" oldname="wxIdleEvent" module="_core"> |
f32fc4bc RD |
3052 | <baseclass name="Event"/> |
3053 | <constructor name="IdleEvent" overloaded="no"> | |
781d2982 | 3054 | <autodoc>__init__(self) -> IdleEvent</autodoc> |
f32fc4bc RD |
3055 | </constructor> |
3056 | <method name="RequestMore" type="" overloaded="no"> | |
781d2982 | 3057 | <autodoc>RequestMore(self, bool needMore=True)</autodoc> |
f32fc4bc RD |
3058 | <paramlist> |
3059 | <param name="needMore" type="bool" default="True"/> | |
3060 | </paramlist> | |
3061 | </method> | |
3062 | <method name="MoreRequested" type="bool" overloaded="no"> | |
781d2982 | 3063 | <autodoc>MoreRequested(self) -> bool</autodoc> |
f32fc4bc RD |
3064 | </method> |
3065 | <staticmethod name="SetMode" type="" overloaded="no"> | |
3066 | <autodoc>SetMode(int mode)</autodoc> | |
3067 | <paramlist> | |
3068 | <param name="mode" type="wxIdleMode" default=""/> | |
3069 | </paramlist> | |
3070 | </staticmethod> | |
3071 | <staticmethod name="GetMode" type="wxIdleMode" overloaded="no"> | |
3072 | <autodoc>GetMode() -> int</autodoc> | |
3073 | </staticmethod> | |
3074 | <staticmethod name="CanSend" type="bool" overloaded="no"> | |
3075 | <autodoc>CanSend(Window win) -> bool</autodoc> | |
3076 | <paramlist> | |
3077 | <param name="win" type="wxWindow" default=""/> | |
3078 | </paramlist> | |
3079 | </staticmethod> | |
3080 | </class> | |
3081 | <pythoncode> | |
856bf319 RD |
3082 | #--------------------------------------------------------------------------- |
3083 | </pythoncode> | |
781d2982 | 3084 | <class name="PyEvent" oldname="wxPyEvent" module="_core"> |
f32fc4bc RD |
3085 | <baseclass name="Event"/> |
3086 | <constructor name="PyEvent" overloaded="no"> | |
781d2982 | 3087 | <autodoc>__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent</autodoc> |
f32fc4bc RD |
3088 | <paramlist> |
3089 | <param name="winid" type="int" default="0"/> | |
3090 | <param name="commandType" type="wxEventType" default="wxEVT_NULL"/> | |
3091 | </paramlist> | |
3092 | </constructor> | |
3093 | <destructor name="~wxPyEvent" overloaded="no"> | |
781d2982 | 3094 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
3095 | </destructor> |
3096 | <method name="SetSelf" type="" overloaded="no"> | |
781d2982 | 3097 | <autodoc>SetSelf(self, PyObject self)</autodoc> |
f32fc4bc RD |
3098 | <paramlist> |
3099 | <param name="self" type="PyObject" default=""/> | |
3100 | </paramlist> | |
3101 | </method> | |
3102 | <method name="GetSelf" type="PyObject" overloaded="no"> | |
781d2982 | 3103 | <autodoc>GetSelf(self) -> PyObject</autodoc> |
f32fc4bc RD |
3104 | </method> |
3105 | </class> | |
781d2982 | 3106 | <class name="PyCommandEvent" oldname="wxPyCommandEvent" module="_core"> |
f32fc4bc RD |
3107 | <baseclass name="CommandEvent"/> |
3108 | <constructor name="PyCommandEvent" overloaded="no"> | |
781d2982 | 3109 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent</autodoc> |
f32fc4bc RD |
3110 | <paramlist> |
3111 | <param name="commandType" type="wxEventType" default="wxEVT_NULL"/> | |
3112 | <param name="id" type="int" default="0"/> | |
3113 | </paramlist> | |
3114 | </constructor> | |
3115 | <destructor name="~wxPyCommandEvent" overloaded="no"> | |
781d2982 | 3116 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
3117 | </destructor> |
3118 | <method name="SetSelf" type="" overloaded="no"> | |
781d2982 | 3119 | <autodoc>SetSelf(self, PyObject self)</autodoc> |
f32fc4bc RD |
3120 | <paramlist> |
3121 | <param name="self" type="PyObject" default=""/> | |
3122 | </paramlist> | |
3123 | </method> | |
3124 | <method name="GetSelf" type="PyObject" overloaded="no"> | |
781d2982 | 3125 | <autodoc>GetSelf(self) -> PyObject</autodoc> |
f32fc4bc RD |
3126 | </method> |
3127 | </class> | |
3128 | <pythoncode> | |
856bf319 RD |
3129 | #--------------------------------------------------------------------------- |
3130 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3134 | <baseclass name="EvtHandler"/> |
3135 | <constructor name="PyApp" overloaded="no"> | |
781d2982 | 3136 | <autodoc>__init__(self) -> PyApp</autodoc> |
f32fc4bc RD |
3137 | <docstring>Create a new application object, starting the bootstrap process.</docstring> |
3138 | </constructor> | |
3139 | <destructor name="~wxPyApp" overloaded="no"> | |
781d2982 | 3140 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
3141 | </destructor> |
3142 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 3143 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
3144 | <paramlist> |
3145 | <param name="self" type="PyObject" default=""/> | |
3146 | <param name="_class" type="PyObject" default=""/> | |
3147 | </paramlist> | |
3148 | </method> | |
3149 | <method name="GetAppName" type="String" overloaded="no"> | |
781d2982 | 3150 | <autodoc>GetAppName(self) -> String</autodoc> |
f32fc4bc RD |
3151 | <docstring>Get the application name.</docstring> |
3152 | </method> | |
3153 | <method name="SetAppName" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3157 | <paramlist> |
3158 | <param name="name" type="String" default=""/> | |
3159 | </paramlist> | |
3160 | </method> | |
3161 | <method name="GetClassName" type="String" overloaded="no"> | |
781d2982 | 3162 | <autodoc>GetClassName(self) -> String</autodoc> |
f32fc4bc RD |
3163 | <docstring>Get the application's class name.</docstring> |
3164 | </method> | |
3165 | <method name="SetClassName" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3169 | <paramlist> |
3170 | <param name="name" type="String" default=""/> | |
3171 | </paramlist> | |
3172 | </method> | |
3173 | <method name="GetVendorName" type="String" overloaded="no"> | |
781d2982 | 3174 | <autodoc>GetVendorName(self) -> String</autodoc> |
f32fc4bc RD |
3175 | <docstring>Get the application's vendor name.</docstring> |
3176 | </method> | |
3177 | <method name="SetVendorName" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3181 | <paramlist> |
3182 | <param name="name" type="String" default=""/> | |
3183 | </paramlist> | |
3184 | </method> | |
3185 | <method name="GetTraits" type="wxAppTraits" overloaded="no"> | |
781d2982 RD |
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. | |
3193 | ||
3194 | :todo: Add support for overriding CreateAppTraits in wxPython.</docstring> | |
f32fc4bc RD |
3195 | </method> |
3196 | <method name="ProcessPendingEvents" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3201 | </method> |
3202 | <method name="Yield" type="bool" overloaded="no"> | |
781d2982 RD |
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. | |
3207 | ||
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! | |
3212 | ||
3213 | :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield` | |
0f43fbdf | 3214 | </docstring> |
f32fc4bc RD |
3215 | <paramlist> |
3216 | <param name="onlyIfNeeded" type="bool" default="False"/> | |
3217 | </paramlist> | |
3218 | </method> | |
3219 | <method name="WakeUpIdle" type="" overloaded="no"> | |
781d2982 RD |
3220 | <autodoc>WakeUpIdle(self)</autodoc> |
3221 | <docstring>Make sure that idle events are sent again. | |
3222 | :see: `wx.WakeUpIdle`</docstring> | |
f32fc4bc RD |
3223 | </method> |
3224 | <method name="MainLoop" type="int" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3228 | </method> |
3229 | <method name="Exit" type="" overloaded="no"> | |
781d2982 RD |
3230 | <autodoc>Exit(self)</autodoc> |
3231 | <docstring>Exit the main loop thus terminating the application. | |
3232 | :see: `wx.Exit`</docstring> | |
f32fc4bc RD |
3233 | </method> |
3234 | <method name="ExitMainLoop" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3238 | </method> |
3239 | <method name="Pending" type="bool" overloaded="no"> | |
781d2982 | 3240 | <autodoc>Pending(self) -> bool</autodoc> |
f32fc4bc RD |
3241 | <docstring>Returns True if there are unprocessed events in the event queue.</docstring> |
3242 | </method> | |
3243 | <method name="Dispatch" type="bool" overloaded="no"> | |
781d2982 | 3244 | <autodoc>Dispatch(self) -> bool</autodoc> |
f32fc4bc | 3245 | <docstring>Process the first event in the event queue (blocks until an event |
0f43fbdf | 3246 | appears if there are none currently)</docstring> |
f32fc4bc RD |
3247 | </method> |
3248 | <method name="ProcessIdle" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3253 | </method> |
3254 | <method name="SendIdleEvents" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3258 | <paramlist> |
3259 | <param name="win" type="wxWindow" default=""/> | |
3260 | <param name="event" type="IdleEvent" default=""/> | |
3261 | </paramlist> | |
3262 | </method> | |
3263 | <method name="IsActive" type="bool" overloaded="no"> | |
781d2982 | 3264 | <autodoc>IsActive(self) -> bool</autodoc> |
f32fc4bc RD |
3265 | <docstring>Return True if our app has focus.</docstring> |
3266 | </method> | |
3267 | <method name="SetTopWindow" type="" overloaded="no"> | |
781d2982 RD |
3268 | <autodoc>SetTopWindow(self, Window win)</autodoc> |
3269 | <docstring>Set the *main* top level window</docstring> | |
f32fc4bc RD |
3270 | <paramlist> |
3271 | <param name="win" type="wxWindow" default=""/> | |
3272 | </paramlist> | |
3273 | </method> | |
3274 | <method name="GetTopWindow" type="wxWindow" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3279 | </method> |
3280 | <method name="SetExitOnFrameDelete" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3287 | <paramlist> |
3288 | <param name="flag" type="bool" default=""/> | |
3289 | </paramlist> | |
3290 | </method> | |
3291 | <method name="GetExitOnFrameDelete" type="bool" overloaded="no"> | |
781d2982 | 3292 | <autodoc>GetExitOnFrameDelete(self) -> bool</autodoc> |
f32fc4bc RD |
3293 | <docstring>Get the current exit behaviour setting.</docstring> |
3294 | </method> | |
3295 | <method name="SetUseBestVisual" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3299 | <paramlist> |
3300 | <param name="flag" type="bool" default=""/> | |
3301 | </paramlist> | |
3302 | </method> | |
3303 | <method name="GetUseBestVisual" type="bool" overloaded="no"> | |
781d2982 | 3304 | <autodoc>GetUseBestVisual(self) -> bool</autodoc> |
f32fc4bc RD |
3305 | <docstring>Get current UseBestVisual setting.</docstring> |
3306 | </method> | |
3307 | <method name="SetPrintMode" type="" overloaded="no"> | |
781d2982 | 3308 | <autodoc>SetPrintMode(self, int mode)</autodoc> |
f32fc4bc RD |
3309 | <paramlist> |
3310 | <param name="mode" type="int" default=""/> | |
3311 | </paramlist> | |
3312 | </method> | |
3313 | <method name="GetPrintMode" type="int" overloaded="no"> | |
781d2982 | 3314 | <autodoc>GetPrintMode(self) -> int</autodoc> |
f32fc4bc RD |
3315 | </method> |
3316 | <method name="SetAssertMode" type="" overloaded="no"> | |
781d2982 | 3317 | <autodoc>SetAssertMode(self, int mode)</autodoc> |
ce6878e6 RD |
3318 | <docstring>Set the OnAssert behaviour for debug and hybrid builds.The following flags may be or'd together: |
3319 | ||
3320 | ========================= ======================================= | |
3321 | wx.PYAPP_ASSERT_SUPPRESS Don't do anything | |
3322 | wx.PYAPP_ASSERT_EXCEPTION Turn it into a Python exception if possible | |
3323 | (default) | |
3324 | wx.PYAPP_ASSERT_DIALOG Display a message dialog | |
3325 | wx.PYAPP_ASSERT_LOG Write the assertion info to the wx.Log | |
3326 | ========================= ======================================= | |
3327 | ||
3328 | </docstring> | |
f32fc4bc RD |
3329 | <paramlist> |
3330 | <param name="mode" type="int" default=""/> | |
3331 | </paramlist> | |
3332 | </method> | |
3333 | <method name="GetAssertMode" type="int" overloaded="no"> | |
781d2982 | 3334 | <autodoc>GetAssertMode(self) -> int</autodoc> |
f32fc4bc RD |
3335 | <docstring>Get the current OnAssert behaviour setting.</docstring> |
3336 | </method> | |
3337 | <staticmethod name="GetMacSupportPCMenuShortcuts" type="bool" overloaded="no"> | |
3338 | <autodoc>GetMacSupportPCMenuShortcuts() -> bool</autodoc> | |
3339 | </staticmethod> | |
3340 | <staticmethod name="GetMacAboutMenuItemId" type="long" overloaded="no"> | |
3341 | <autodoc>GetMacAboutMenuItemId() -> long</autodoc> | |
3342 | </staticmethod> | |
3343 | <staticmethod name="GetMacPreferencesMenuItemId" type="long" overloaded="no"> | |
3344 | <autodoc>GetMacPreferencesMenuItemId() -> long</autodoc> | |
3345 | </staticmethod> | |
3346 | <staticmethod name="GetMacExitMenuItemId" type="long" overloaded="no"> | |
3347 | <autodoc>GetMacExitMenuItemId() -> long</autodoc> | |
3348 | </staticmethod> | |
3349 | <staticmethod name="GetMacHelpMenuTitleName" type="String" overloaded="no"> | |
3350 | <autodoc>GetMacHelpMenuTitleName() -> String</autodoc> | |
3351 | </staticmethod> | |
3352 | <staticmethod name="SetMacSupportPCMenuShortcuts" type="" overloaded="no"> | |
3353 | <autodoc>SetMacSupportPCMenuShortcuts(bool val)</autodoc> | |
3354 | <paramlist> | |
3355 | <param name="val" type="bool" default=""/> | |
3356 | </paramlist> | |
3357 | </staticmethod> | |
3358 | <staticmethod name="SetMacAboutMenuItemId" type="" overloaded="no"> | |
3359 | <autodoc>SetMacAboutMenuItemId(long val)</autodoc> | |
3360 | <paramlist> | |
3361 | <param name="val" type="long" default=""/> | |
3362 | </paramlist> | |
3363 | </staticmethod> | |
3364 | <staticmethod name="SetMacPreferencesMenuItemId" type="" overloaded="no"> | |
3365 | <autodoc>SetMacPreferencesMenuItemId(long val)</autodoc> | |
3366 | <paramlist> | |
3367 | <param name="val" type="long" default=""/> | |
3368 | </paramlist> | |
3369 | </staticmethod> | |
3370 | <staticmethod name="SetMacExitMenuItemId" type="" overloaded="no"> | |
3371 | <autodoc>SetMacExitMenuItemId(long val)</autodoc> | |
3372 | <paramlist> | |
3373 | <param name="val" type="long" default=""/> | |
3374 | </paramlist> | |
3375 | </staticmethod> | |
3376 | <staticmethod name="SetMacHelpMenuTitleName" type="" overloaded="no"> | |
3377 | <autodoc>SetMacHelpMenuTitleName(String val)</autodoc> | |
3378 | <paramlist> | |
3379 | <param name="val" type="String" default=""/> | |
3380 | </paramlist> | |
3381 | </staticmethod> | |
3382 | <method name="_BootstrapApp" type="" overloaded="no"> | |
781d2982 | 3383 | <autodoc>_BootstrapApp(self)</autodoc> |
f32fc4bc RD |
3384 | <docstring>For internal use only</docstring> |
3385 | </method> | |
3386 | <staticmethod name="GetComCtl32Version" type="int" overloaded="no"> | |
3387 | <autodoc>GetComCtl32Version() -> int</autodoc> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3390 | </staticmethod> |
3391 | </class> | |
3392 | <pythoncode> | |
856bf319 RD |
3393 | #--------------------------------------------------------------------------- |
3394 | </pythoncode> | |
f32fc4bc RD |
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> | |
3398 | </method> | |
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> | |
3402 | </method> | |
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> | |
3406 | </method> | |
3407 | <method name="SafeYield" oldname="wxSafeYield" type="bool" overloaded="no"> | |
3408 | <autodoc>SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool</autodoc> | |
781d2982 RD |
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 | |
3413 | interaction. | |
0f43fbdf | 3414 | |
781d2982 | 3415 | :Returns: the result of the call to `wx.Yield`.</docstring> |
f32fc4bc RD |
3416 | <paramlist> |
3417 | <param name="win" type="wxWindow" default="NULL"/> | |
3418 | <param name="onlyIfNeeded" type="bool" default="False"/> | |
3419 | </paramlist> | |
3420 | </method> | |
3421 | <method name="WakeUpIdle" oldname="wxWakeUpIdle" type="" overloaded="no"> | |
3422 | <autodoc>WakeUpIdle()</autodoc> | |
781d2982 RD |
3423 | <docstring>Cause the message queue to become empty again, so idle events will be |
3424 | sent.</docstring> | |
f32fc4bc RD |
3425 | </method> |
3426 | <method name="PostEvent" oldname="wxPostEvent" type="" overloaded="no"> | |
3427 | <autodoc>PostEvent(EvtHandler dest, Event event)</autodoc> | |
781d2982 RD |
3428 | <docstring>Send an event to a window or other wx.EvtHandler to be processed |
3429 | later.</docstring> | |
f32fc4bc RD |
3430 | <paramlist> |
3431 | <param name="dest" type="EvtHandler" default=""/> | |
3432 | <param name="event" type="Event" default=""/> | |
3433 | </paramlist> | |
3434 | </method> | |
3435 | <method name="App_CleanUp" oldname="wxApp_CleanUp" type="" overloaded="no"> | |
3436 | <autodoc>App_CleanUp()</autodoc> | |
781d2982 RD |
3437 | <docstring>For internal use only, it is used to cleanup after wxWidgets when |
3438 | Python shuts down.</docstring> | |
f32fc4bc | 3439 | </method> |
781d2982 | 3440 | <method name="GetApp" oldname="wxPyGetApp" type="PyApp" overloaded="no"> |
f32fc4bc RD |
3441 | <autodoc>GetApp() -> PyApp</autodoc> |
3442 | <docstring>Return a reference to the current wx.App object.</docstring> | |
3443 | </method> | |
3444 | <pythoncode> | |
0f43fbdf RD |
3445 | #---------------------------------------------------------------------- |
3446 | ||
3447 | class PyOnDemandOutputWindow: | |
3448 | """ | |
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. | |
3453 | """ | |
3454 | def __init__(self, title = "wxPython: stdout/stderr"): | |
3455 | self.frame = None | |
3456 | self.title = title | |
ce6878e6 RD |
3457 | self.pos = wx.DefaultPosition |
3458 | self.size = (450, 300) | |
0f43fbdf RD |
3459 | self.parent = None |
3460 | ||
3461 | def SetParent(self, parent): | |
3462 | """Set the window to be used as the popup Frame's parent.""" | |
3463 | self.parent = parent | |
3464 | ||
3465 | ||
3466 | def CreateOutputWindow(self, st): | |
ce6878e6 RD |
3467 | self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size, |
3468 | style=wx.DEFAULT_FRAME_STYLE) | |
0f43fbdf | 3469 | self.text = wx.TextCtrl(self.frame, -1, "", |
ce6878e6 | 3470 | style=wx.TE_MULTILINE|wx.TE_READONLY) |
cff531b1 | 3471 | self.text.AppendText(st) |
0f43fbdf RD |
3472 | self.frame.Show(True) |
3473 | EVT_CLOSE(self.frame, self.OnCloseWindow) | |
3474 | ||
3475 | ||
b39e211b RD |
3476 | def OnCloseWindow(self, event): |
3477 | if self.frame is not None: | |
3478 | self.frame.Destroy() | |
3479 | self.frame = None | |
3480 | self.text = None | |
3481 | ||
3482 | ||
0f43fbdf RD |
3483 | # These methods provide the file-like output behaviour. |
3484 | def write(self, text): | |
3485 | """ | |
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. | |
3489 | """ | |
3490 | if self.frame is None: | |
3491 | if not wx.Thread_IsMain(): | |
3492 | wx.CallAfter(self.CreateOutputWindow, text) | |
3493 | else: | |
3494 | self.CreateOutputWindow(text) | |
3495 | else: | |
3496 | if not wx.Thread_IsMain(): | |
3497 | wx.CallAfter(self.text.AppendText, text) | |
3498 | else: | |
3499 | self.text.AppendText(text) | |
3500 | ||
3501 | ||
3502 | def close(self): | |
3503 | if self.frame is not None: | |
3504 | wx.CallAfter(self.frame.Close) | |
3505 | ||
3506 | ||
ce6878e6 RD |
3507 | def flush(self): |
3508 | pass | |
3509 | ||
3510 | ||
0f43fbdf RD |
3511 | |
3512 | #---------------------------------------------------------------------- | |
3513 | ||
3514 | _defRedirect = (wx.Platform == '__WXMSW__' or wx.Platform == '__WXMAC__') | |
3515 | ||
3516 | class App(wx.PyApp): | |
3517 | """ | |
781d2982 RD |
3518 | The ``wx.App`` class represents the application and is used to: |
3519 | ||
3520 | * bootstrap the wxPython system and initialize the underlying | |
3521 | gui toolkit | |
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 | |
3525 | * etc. | |
3526 | ||
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. | |
3531 | ||
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)``. | |
3535 | ||
3536 | :see: `wx.PySimpleApp` for a simpler app class that can be used | |
3537 | directly. | |
0f43fbdf | 3538 | """ |
781d2982 | 3539 | |
0f43fbdf RD |
3540 | outputWindowClass = PyOnDemandOutputWindow |
3541 | ||
781d2982 RD |
3542 | def __init__(self, redirect=_defRedirect, filename=None, |
3543 | useBestVisual=False, clearSigInt=True): | |
3544 | """ | |
3545 | Construct a ``wx.App`` object. | |
3546 | ||
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.) | |
3554 | ||
3555 | :param filename: The name of a file to redirect output to, if | |
3556 | redirect is True. | |
3557 | ||
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. | |
3564 | ||
3565 | :param clearSigInt: Should SIGINT be cleared? This allows the | |
3566 | app to terminate upon a Ctrl-C in the console like other | |
3567 | GUI apps will. | |
3568 | ||
3569 | :note: You should override OnInit to do applicaition | |
3570 | initialization to ensure that the system, toolkit and | |
3571 | wxWidgets are fully initialized. | |
3572 | """ | |
0f43fbdf RD |
3573 | wx.PyApp.__init__(self) |
3574 | ||
3575 | if wx.Platform == "__WXMAC__": | |
3576 | try: | |
3577 | import MacOS | |
3578 | if not MacOS.WMAvailable(): | |
3579 | print """\\ | |
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 | |
3582 | your Mac.""" | |
3583 | _sys.exit(1) | |
781d2982 RD |
3584 | except SystemExit: |
3585 | raise | |
0f43fbdf RD |
3586 | except: |
3587 | pass | |
3588 | ||
3589 | # This has to be done before OnInit | |
3590 | self.SetUseBestVisual(useBestVisual) | |
3591 | ||
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.) | |
781d2982 RD |
3598 | if clearSigInt: |
3599 | try: | |
3600 | import signal | |
3601 | signal.signal(signal.SIGINT, signal.SIG_DFL) | |
3602 | except: | |
3603 | pass | |
0f43fbdf RD |
3604 | |
3605 | # Save and redirect the stdio to a window? | |
3606 | self.stdioWin = None | |
3607 | self.saveStdio = (_sys.stdout, _sys.stderr) | |
3608 | if redirect: | |
3609 | self.RedirectStdio(filename) | |
3610 | ||
3611 | # This finishes the initialization of wxWindows and then calls | |
3612 | # the OnInit that should be present in the derived class | |
3613 | self._BootstrapApp() | |
3614 | ||
3615 | ||
3616 | def __del__(self): | |
3617 | try: | |
3618 | self.RestoreStdio() # Just in case the MainLoop was overridden | |
3619 | except: | |
3620 | pass | |
3621 | ||
3622 | ||
3623 | def SetTopWindow(self, frame): | |
3624 | """Set the \\"main\\" top level window""" | |
3625 | if self.stdioWin: | |
3626 | self.stdioWin.SetParent(frame) | |
3627 | wx.PyApp.SetTopWindow(self, frame) | |
3628 | ||
3629 | ||
3630 | def MainLoop(self): | |
3631 | """Execute the main GUI event loop""" | |
3632 | wx.PyApp.MainLoop(self) | |
3633 | self.RestoreStdio() | |
3634 | ||
3635 | ||
b39e211b | 3636 | def RedirectStdio(self, filename=None): |
0f43fbdf RD |
3637 | """Redirect sys.stdout and sys.stderr to a file or a popup window.""" |
3638 | if filename: | |
3639 | _sys.stdout = _sys.stderr = open(filename, 'a') | |
3640 | else: | |
3641 | self.stdioWin = self.outputWindowClass() | |
3642 | _sys.stdout = _sys.stderr = self.stdioWin | |
3643 | ||
3644 | ||
3645 | def RestoreStdio(self): | |
3646 | _sys.stdout, _sys.stderr = self.saveStdio | |
3647 | ||
3648 | ||
ce6878e6 RD |
3649 | def SetOutputWindowAttributes(self, title=None, pos=None, size=None): |
3650 | """ | |
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. | |
3654 | """ | |
3655 | if self.stdioWin: | |
3656 | if title is not None: | |
3657 | self.stdioWin.title = title | |
3658 | if pos is not None: | |
3659 | self.stdioWin.pos = pos | |
3660 | if size is not None: | |
3661 | self.stdioWin.size = size | |
3662 | ||
3663 | ||
3664 | ||
0f43fbdf | 3665 | |
781d2982 RD |
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 | |
0f43fbdf RD |
3678 | |
3679 | #---------------------------------------------------------------------------- | |
3680 | ||
3681 | class PySimpleApp(wx.App): | |
3682 | """ | |
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 | |
781d2982 RD |
3685 | about OnInit. For example:: |
3686 | ||
3687 | app = wx.PySimpleApp() | |
3688 | frame = wx.Frame(None, title='Hello World') | |
3689 | frame.Show() | |
3690 | app.MainLoop() | |
3691 | ||
3692 | :see: `wx.App` | |
3693 | """ | |
0f43fbdf | 3694 | |
781d2982 RD |
3695 | def __init__(self, redirect=False, filename=None, |
3696 | useBestVisual=False, clearSigInt=True): | |
3697 | """ | |
3698 | :see: `wx.App.__init__` | |
3699 | """ | |
3700 | wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt) | |
0f43fbdf RD |
3701 | |
3702 | def OnInit(self): | |
0f43fbdf RD |
3703 | return True |
3704 | ||
3705 | ||
781d2982 | 3706 | |
0f43fbdf RD |
3707 | # Is anybody using this one? |
3708 | class PyWidgetTester(wx.App): | |
3709 | def __init__(self, size = (250, 100)): | |
3710 | self.size = size | |
3711 | wx.App.__init__(self, 0) | |
3712 | ||
3713 | def OnInit(self): | |
3714 | self.frame = wx.Frame(None, -1, "Widget Tester", pos=(0,0), size=self.size) | |
3715 | self.SetTopWindow(self.frame) | |
3716 | return True | |
3717 | ||
781d2982 RD |
3718 | def SetWidget(self, widgetClass, *args, **kwargs): |
3719 | w = widgetClass(self.frame, *args, **kwargs) | |
0f43fbdf RD |
3720 | self.frame.Show(True) |
3721 | ||
3722 | #---------------------------------------------------------------------------- | |
3723 | # DO NOT hold any other references to this object. This is how we | |
781d2982 | 3724 | # know when to cleanup system resources that wxWidgets is holding. When |
0f43fbdf | 3725 | # the sys module is unloaded, the refcount on sys.__wxPythonCleanup |
781d2982 | 3726 | # goes to zero and it calls the wx.App_CleanUp function. |
0f43fbdf RD |
3727 | |
3728 | class __wxPyCleanup: | |
3729 | def __init__(self): | |
781d2982 | 3730 | self.cleanup = _core_.App_CleanUp |
0f43fbdf RD |
3731 | def __del__(self): |
3732 | self.cleanup() | |
3733 | ||
3734 | _sys.__wxPythonCleanup = __wxPyCleanup() | |
3735 | ||
3736 | ## # another possible solution, but it gets called too early... | |
781d2982 RD |
3737 | ## import atexit |
3738 | ## atexit.register(_core_.wxApp_CleanUp) | |
0f43fbdf RD |
3739 | |
3740 | ||
3741 | #---------------------------------------------------------------------------- | |
3742 | </pythoncode> | |
f32fc4bc | 3743 | <pythoncode> |
0f43fbdf RD |
3744 | #--------------------------------------------------------------------------- |
3745 | </pythoncode> | |
781d2982 RD |
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. | |
3751 | ||
3752 | :see: `wx.AcceleratorTable`</docstring> | |
f32fc4bc | 3753 | <constructor name="AcceleratorEntry" overloaded="no"> |
781d2982 | 3754 | <autodoc>__init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry</autodoc> |
ce6878e6 RD |
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 | |
3761 | accellerator event. | |
3762 | </docstring> | |
f32fc4bc RD |
3763 | <paramlist> |
3764 | <param name="flags" type="int" default="0"/> | |
3765 | <param name="keyCode" type="int" default="0"/> | |
781d2982 | 3766 | <param name="cmdID" type="int" default="0"/> |
f32fc4bc RD |
3767 | </paramlist> |
3768 | </constructor> | |
3769 | <destructor name="~wxAcceleratorEntry" overloaded="no"> | |
781d2982 | 3770 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
3771 | </destructor> |
3772 | <method name="Set" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
3776 | <paramlist> |
3777 | <param name="flags" type="int" default=""/> | |
3778 | <param name="keyCode" type="int" default=""/> | |
3779 | <param name="cmd" type="int" default=""/> | |
f32fc4bc RD |
3780 | </paramlist> |
3781 | </method> | |
f32fc4bc | 3782 | <method name="GetFlags" type="int" overloaded="no"> |
781d2982 RD |
3783 | <autodoc>GetFlags(self) -> int</autodoc> |
3784 | <docstring>Get the AcceleratorEntry's flags.</docstring> | |
f32fc4bc RD |
3785 | </method> |
3786 | <method name="GetKeyCode" type="int" overloaded="no"> | |
781d2982 RD |
3787 | <autodoc>GetKeyCode(self) -> int</autodoc> |
3788 | <docstring>Get the AcceleratorEntry's keycode.</docstring> | |
f32fc4bc RD |
3789 | </method> |
3790 | <method name="GetCommand" type="int" overloaded="no"> | |
781d2982 RD |
3791 | <autodoc>GetCommand(self) -> int</autodoc> |
3792 | <docstring>Get the AcceleratorEntry's command ID.</docstring> | |
f32fc4bc RD |
3793 | </method> |
3794 | </class> | |
781d2982 RD |
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 | |
ce6878e6 RD |
3799 | supported. |
3800 | ||
3801 | The object ``wx.NullAcceleratorTable`` is defined to be a table with | |
3802 | no data, and is the initial accelerator table for a window. | |
3803 | ||
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. | |
3808 | ||
3809 | Foe example:: | |
3810 | ||
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) | |
3815 | ]) | |
3816 | self.SetAcceleratorTable(aTable) | |
3817 | ||
3818 | ||
3819 | :see: `wx.AcceleratorEntry`, `wx.Window.SetAcceleratorTable` | |
3820 | </docstring> | |
f32fc4bc RD |
3821 | <baseclass name="Object"/> |
3822 | <constructor name="AcceleratorTable" overloaded="no"> | |
3823 | <autodoc>__init__(entries) -> AcceleratorTable</autodoc> | |
781d2982 RD |
3824 | <docstring>Construct an AcceleratorTable from a list of `wx.AcceleratorEntry` |
3825 | items or or of 3-tuples (flags, keyCode, cmdID) | |
3826 | ||
3827 | :see: `wx.AcceleratorEntry`</docstring> | |
f32fc4bc RD |
3828 | <paramlist> |
3829 | <param name="n" type="int" default=""/> | |
3830 | <param name="entries" type="AcceleratorEntry" default=""/> | |
3831 | </paramlist> | |
3832 | </constructor> | |
3833 | <destructor name="~wxAcceleratorTable" overloaded="no"> | |
781d2982 | 3834 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
3835 | </destructor> |
3836 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 3837 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
3838 | </method> |
3839 | </class> | |
3840 | <method name="GetAccelFromString" oldname="wxGetAccelFromString" type="AcceleratorEntry" overloaded="no"> | |
3841 | <autodoc>GetAccelFromString(String label) -> AcceleratorEntry</autodoc> | |
3842 | <paramlist> | |
3843 | <param name="label" type="String" default=""/> | |
0f43fbdf | 3844 | </paramlist> |
0f43fbdf | 3845 | </method> |
f32fc4bc | 3846 | <pythoncode> |
0f43fbdf RD |
3847 | #--------------------------------------------------------------------------- |
3848 | </pythoncode> | |
781d2982 RD |
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> | |
3854 | </constructor> | |
3855 | <destructor name="~wxVisualAttributes" overloaded="no"> | |
3856 | <autodoc>__del__(self)</autodoc> | |
3857 | </destructor> | |
3858 | <property name="font" type="wxFont" readonly="no"/> | |
3859 | <property name="colFg" type="wxColour" readonly="no"/> | |
3860 | <property name="colBg" type="wxColour" readonly="no"/> | |
3861 | </class> | |
3862 | <class name="Window" oldname="wxWindow" module="_core"> | |
3863 | <docstring>wx.Window is the base class for all windows and represents any visible | |
c2dda882 RD |
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. | |
ce6878e6 RD |
3867 | |
3868 | Styles | |
3869 | ------- | |
3870 | ============================= ===================================== | |
3871 | wx.SIMPLE_BORDER Displays a thin border around the window. | |
3872 | ||
3873 | wx.DOUBLE_BORDER Displays a double border. Windows and Mac only. | |
3874 | ||
3875 | wx.SUNKEN_BORDER Displays a sunken border. | |
3876 | ||
3877 | wx.RAISED_BORDER Displays a raised border. | |
3878 | ||
3879 | wx.STATIC_BORDER Displays a border suitable for a static | |
3880 | control. Windows only. | |
3881 | ||
3882 | wx.NO_BORDER Displays no border, overriding the default | |
3883 | border style for the window. | |
3884 | ||
3885 | wx.TRANSPARENT_WINDOW The window is transparent, that is, it | |
3886 | will not receive paint events. Windows only. | |
3887 | ||
3888 | wx.TAB_TRAVERSAL Use this to enable tab traversal for | |
3889 | non-dialog windows. | |
3890 | ||
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 | |
3903 | and Shift-Tab. | |
3904 | ||
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 | |
3912 | deactivate it. | |
3913 | ||
3914 | wx.VSCROLL Use this style to enable a vertical scrollbar. | |
3915 | ||
3916 | wx.HSCROLL Use this style to enable a horizontal scrollbar. | |
3917 | ||
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. | |
3926 | ||
3927 | wx.CLIP_CHILDREN Use this style to eliminate flicker caused by | |
3928 | the background being repainted, then | |
3929 | children being painted over | |
3930 | them. Windows only. | |
3931 | ||
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 | |
3941 | to try this. | |
3942 | ============================= ===================================== | |
3943 | ||
3944 | ||
3945 | Extra Styles | |
3946 | ------------ | |
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 | |
3954 | subwindows. | |
3955 | ||
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 | |
3965 | by default. | |
3966 | ||
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. | |
3975 | ||
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. | |
3980 | ||
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 | ============================= ===================================== | |
3986 | ||
c2dda882 | 3987 | </docstring> |
f32fc4bc RD |
3988 | <baseclass name="EvtHandler"/> |
3989 | <constructor name="Window" overloaded="no"> | |
781d2982 RD |
3990 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
3991 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window</autodoc> | |
c2dda882 | 3992 | <docstring>Construct and show a generic Window.</docstring> |
f32fc4bc RD |
3993 | <paramlist> |
3994 | <param name="parent" type="Window" default=""/> | |
781d2982 | 3995 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
4000 | </paramlist> | |
4001 | </constructor> | |
4002 | <constructor name="PreWindow" overloaded="no"> | |
4003 | <autodoc>PreWindow() -> Window</autodoc> | |
c2dda882 | 4004 | <docstring>Precreate a Window for 2-phase creation.</docstring> |
f32fc4bc RD |
4005 | </constructor> |
4006 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
4007 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
4008 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool</autodoc> | |
c2dda882 | 4009 | <docstring>Create the GUI part of the Window for 2-phase creation mode.</docstring> |
f32fc4bc RD |
4010 | <paramlist> |
4011 | <param name="parent" type="Window" default=""/> | |
781d2982 | 4012 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
4017 | </paramlist> | |
4018 | </method> | |
4019 | <method name="Close" type="bool" overloaded="no"> | |
781d2982 | 4020 | <autodoc>Close(self, bool force=False) -> bool</autodoc> |
c2dda882 RD |
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 | |
ce6878e6 RD |
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 | |
4027 | EVT_CLOSE logic. | |
4028 | ||
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. | |
4032 | ||
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. | |
4040 | ||
4041 | To guarantee that the window will be destroyed, call wx.Window.Destroy | |
4042 | instead.</docstring> | |
f32fc4bc RD |
4043 | <paramlist> |
4044 | <param name="force" type="bool" default="False"/> | |
4045 | </paramlist> | |
4046 | </method> | |
4047 | <method name="Destroy" type="bool" overloaded="no"> | |
781d2982 | 4048 | <autodoc>Destroy(self) -> bool</autodoc> |
c2dda882 RD |
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. | |
4054 | ||
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> | |
f32fc4bc RD |
4057 | </method> |
4058 | <method name="DestroyChildren" type="bool" overloaded="no"> | |
781d2982 RD |
4059 | <autodoc>DestroyChildren(self) -> bool</autodoc> |
4060 | <docstring>Destroys all children of a window. Called automatically by the | |
4061 | destructor.</docstring> | |
f32fc4bc RD |
4062 | </method> |
4063 | <method name="IsBeingDeleted" type="bool" overloaded="no"> | |
781d2982 | 4064 | <autodoc>IsBeingDeleted(self) -> bool</autodoc> |
c2dda882 | 4065 | <docstring>Is the window in the process of being deleted?</docstring> |
f32fc4bc RD |
4066 | </method> |
4067 | <method name="SetTitle" type="" overloaded="no"> | |
781d2982 | 4068 | <autodoc>SetTitle(self, String title)</autodoc> |
c2dda882 | 4069 | <docstring>Sets the window's title. Applicable only to frames and dialogs.</docstring> |
f32fc4bc RD |
4070 | <paramlist> |
4071 | <param name="title" type="String" default=""/> | |
4072 | </paramlist> | |
4073 | </method> | |
4074 | <method name="GetTitle" type="String" overloaded="no"> | |
781d2982 | 4075 | <autodoc>GetTitle(self) -> String</autodoc> |
c2dda882 | 4076 | <docstring>Gets the window's title. Applicable only to frames and dialogs.</docstring> |
f32fc4bc RD |
4077 | </method> |
4078 | <method name="SetLabel" type="" overloaded="no"> | |
781d2982 | 4079 | <autodoc>SetLabel(self, String label)</autodoc> |
c2dda882 | 4080 | <docstring>Set the text which the window shows in its label if applicable.</docstring> |
f32fc4bc RD |
4081 | <paramlist> |
4082 | <param name="label" type="String" default=""/> | |
4083 | </paramlist> | |
4084 | </method> | |
4085 | <method name="GetLabel" type="String" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
4093 | </method> |
4094 | <method name="SetName" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
4098 | <paramlist> |
4099 | <param name="name" type="String" default=""/> | |
4100 | </paramlist> | |
4101 | </method> | |
4102 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 RD |
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> | |
b39e211b RD |
4107 | </method> |
4108 | <method name="SetWindowVariant" type="" overloaded="no"> | |
781d2982 RD |
4109 | <autodoc>SetWindowVariant(self, int variant)</autodoc> |
4110 | <docstring>Sets the variant of the window/font size to use for this window, if | |
ce6878e6 RD |
4111 | the platform supports variants, for example, wxMac. |
4112 | Variant values are: | |
4113 | ||
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 | ======================== ======================================= | |
4120 | </docstring> | |
b39e211b RD |
4121 | <paramlist> |
4122 | <param name="variant" type="wxWindowVariant" default=""/> | |
4123 | </paramlist> | |
4124 | </method> | |
4125 | <method name="GetWindowVariant" type="wxWindowVariant" overloaded="no"> | |
781d2982 | 4126 | <autodoc>GetWindowVariant(self) -> int</autodoc> |
f32fc4bc RD |
4127 | </method> |
4128 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 4129 | <autodoc>SetId(self, int winid)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4134 | <paramlist> |
4135 | <param name="winid" type="int" default=""/> | |
4136 | </paramlist> | |
4137 | </method> | |
4138 | <method name="GetId" type="int" overloaded="no"> | |
781d2982 | 4139 | <autodoc>GetId(self) -> int</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4144 | </method> |
4145 | <staticmethod name="NewControlId" type="int" overloaded="no"> | |
4146 | <autodoc>NewControlId() -> int</autodoc> | |
c2dda882 | 4147 | <docstring>Generate a control id for the controls which were not given one.</docstring> |
f32fc4bc RD |
4148 | </staticmethod> |
4149 | <staticmethod name="NextControlId" type="int" overloaded="no"> | |
4150 | <autodoc>NextControlId(int winid) -> int</autodoc> | |
c2dda882 | 4151 | <docstring>Get the id of the control following the one with the given |
781d2982 | 4152 | autogenerated) id</docstring> |
f32fc4bc RD |
4153 | <paramlist> |
4154 | <param name="winid" type="int" default=""/> | |
4155 | </paramlist> | |
4156 | </staticmethod> | |
4157 | <staticmethod name="PrevControlId" type="int" overloaded="no"> | |
4158 | <autodoc>PrevControlId(int winid) -> int</autodoc> | |
c2dda882 | 4159 | <docstring>Get the id of the control preceding the one with the given |
781d2982 | 4160 | autogenerated) id</docstring> |
f32fc4bc RD |
4161 | <paramlist> |
4162 | <param name="winid" type="int" default=""/> | |
4163 | </paramlist> | |
4164 | </staticmethod> | |
4165 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 4166 | <autodoc>SetSize(self, Size size)</autodoc> |
c2dda882 | 4167 | <docstring>Sets the size of the window in pixels.</docstring> |
f32fc4bc RD |
4168 | <paramlist> |
4169 | <param name="size" type="Size" default=""/> | |
4170 | </paramlist> | |
4171 | </method> | |
4172 | <method name="SetDimensions" type="" overloaded="no"> | |
781d2982 | 4173 | <autodoc>SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4181 | <paramlist> |
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"/> | |
4187 | </paramlist> | |
4188 | </method> | |
4189 | <method name="SetRect" type="" overloaded="no"> | |
781d2982 | 4190 | <autodoc>SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)</autodoc> |
c2dda882 | 4191 | <docstring>Sets the position and size of the window in pixels using a wx.Rect.</docstring> |
f32fc4bc RD |
4192 | <paramlist> |
4193 | <param name="rect" type="Rect" default=""/> | |
4194 | <param name="sizeFlags" type="int" default="wxSIZE_AUTO"/> | |
4195 | </paramlist> | |
4196 | </method> | |
4197 | <method name="SetSizeWH" type="" overloaded="no"> | |
781d2982 | 4198 | <autodoc>SetSizeWH(self, int width, int height)</autodoc> |
c2dda882 | 4199 | <docstring>Sets the size of the window in pixels.</docstring> |
f32fc4bc RD |
4200 | <paramlist> |
4201 | <param name="width" type="int" default=""/> | |
4202 | <param name="height" type="int" default=""/> | |
4203 | </paramlist> | |
4204 | </method> | |
4205 | <method name="Move" type="" overloaded="no"> | |
781d2982 | 4206 | <autodoc>Move(self, Point pt, int flags=SIZE_USE_EXISTING)</autodoc> |
c2dda882 | 4207 | <docstring>Moves the window to the given position.</docstring> |
f32fc4bc RD |
4208 | <paramlist> |
4209 | <param name="pt" type="Point" default=""/> | |
4210 | <param name="flags" type="int" default="wxSIZE_USE_EXISTING"/> | |
4211 | </paramlist> | |
4212 | </method> | |
4213 | <method name="MoveXY" type="" overloaded="no"> | |
781d2982 | 4214 | <autodoc>MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)</autodoc> |
c2dda882 | 4215 | <docstring>Moves the window to the given position.</docstring> |
f32fc4bc RD |
4216 | <paramlist> |
4217 | <param name="x" type="int" default=""/> | |
4218 | <param name="y" type="int" default=""/> | |
4219 | <param name="flags" type="int" default="wxSIZE_USE_EXISTING"/> | |
4220 | </paramlist> | |
4221 | </method> | |
ce6878e6 RD |
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> | |
4226 | <paramlist> | |
4227 | <param name="size" type="Size" default="wxDefaultSize"/> | |
4228 | </paramlist> | |
4229 | </method> | |
f32fc4bc | 4230 | <method name="Raise" type="" overloaded="no"> |
781d2982 | 4231 | <autodoc>Raise(self)</autodoc> |
c2dda882 RD |
4232 | <docstring>Raises the window to the top of the window hierarchy if it is a |
4233 | managed window (dialog or frame).</docstring> | |
f32fc4bc RD |
4234 | </method> |
4235 | <method name="Lower" type="" overloaded="no"> | |
781d2982 | 4236 | <autodoc>Lower(self)</autodoc> |
c2dda882 RD |
4237 | <docstring>Lowers the window to the bottom of the window hierarchy if it is a |
4238 | managed window (dialog or frame).</docstring> | |
f32fc4bc RD |
4239 | </method> |
4240 | <method name="SetClientSize" type="" overloaded="no"> | |
781d2982 | 4241 | <autodoc>SetClientSize(self, Size size)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4247 | <paramlist> |
4248 | <param name="size" type="Size" default=""/> | |
4249 | </paramlist> | |
4250 | </method> | |
4251 | <method name="SetClientSizeWH" type="" overloaded="no"> | |
781d2982 | 4252 | <autodoc>SetClientSizeWH(self, int width, int height)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4258 | <paramlist> |
4259 | <param name="width" type="int" default=""/> | |
4260 | <param name="height" type="int" default=""/> | |
4261 | </paramlist> | |
4262 | </method> | |
4263 | <method name="SetClientRect" type="" overloaded="no"> | |
781d2982 | 4264 | <autodoc>SetClientRect(self, Rect rect)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4270 | <paramlist> |
4271 | <param name="rect" type="Rect" default=""/> | |
4272 | </paramlist> | |
4273 | </method> | |
4274 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 4275 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
4276 | <docstring>Get the window's position.</docstring> |
4277 | </method> | |
4278 | <method name="GetPositionTuple" type="" overloaded="no"> | |
4279 | <autodoc>GetPositionTuple() -> (x,y)</autodoc> | |
4280 | <docstring>Get the window's position.</docstring> | |
4281 | <paramlist> | |
4282 | <param name="OUTPUT" type="int" default=""/> | |
4283 | <param name="OUTPUT" type="int" default=""/> | |
4284 | </paramlist> | |
4285 | </method> | |
4286 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 | 4287 | <autodoc>GetSize(self) -> Size</autodoc> |
f32fc4bc RD |
4288 | <docstring>Get the window size.</docstring> |
4289 | </method> | |
4290 | <method name="GetSizeTuple" type="" overloaded="no"> | |
4291 | <autodoc>GetSizeTuple() -> (width, height)</autodoc> | |
4292 | <docstring>Get the window size.</docstring> | |
4293 | <paramlist> | |
4294 | <param name="OUTPUT" type="int" default=""/> | |
4295 | <param name="OUTPUT" type="int" default=""/> | |
4296 | </paramlist> | |
4297 | </method> | |
4298 | <method name="GetRect" type="Rect" overloaded="no"> | |
781d2982 | 4299 | <autodoc>GetRect(self) -> Rect</autodoc> |
c2dda882 | 4300 | <docstring>Returns the size and position of the window as a wx.Rect object.</docstring> |
f32fc4bc RD |
4301 | </method> |
4302 | <method name="GetClientSize" type="Size" overloaded="no"> | |
781d2982 | 4303 | <autodoc>GetClientSize(self) -> Size</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4307 | </method> |
4308 | <method name="GetClientSizeTuple" type="" overloaded="no"> | |
4309 | <autodoc>GetClientSizeTuple() -> (width, height)</autodoc> | |
c2dda882 RD |
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> | |
f32fc4bc RD |
4313 | <paramlist> |
4314 | <param name="OUTPUT" type="int" default=""/> | |
4315 | <param name="OUTPUT" type="int" default=""/> | |
4316 | </paramlist> | |
4317 | </method> | |
4318 | <method name="GetClientAreaOrigin" type="Point" overloaded="no"> | |
781d2982 | 4319 | <autodoc>GetClientAreaOrigin(self) -> Point</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4323 | </method> |
4324 | <method name="GetClientRect" type="Rect" overloaded="no"> | |
781d2982 RD |
4325 | <autodoc>GetClientRect(self) -> Rect</autodoc> |
4326 | <docstring>Get the client area position and size as a `wx.Rect` object.</docstring> | |
f32fc4bc RD |
4327 | </method> |
4328 | <method name="GetBestSize" type="Size" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
4336 | </method> |
4337 | <method name="GetBestSizeTuple" type="" overloaded="no"> | |
4338 | <autodoc>GetBestSizeTuple() -> (width, height)</autodoc> | |
781d2982 RD |
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> | |
f32fc4bc RD |
4345 | <paramlist> |
4346 | <param name="OUTPUT" type="int" default=""/> | |
4347 | <param name="OUTPUT" type="int" default=""/> | |
4348 | </paramlist> | |
4349 | </method> | |
ce6878e6 RD |
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> | |
4354 | </method> | |
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 | |
4359 | the results. | |
4360 | </docstring> | |
4361 | </method> | |
f32fc4bc | 4362 | <method name="GetAdjustedBestSize" type="Size" overloaded="no"> |
781d2982 | 4363 | <autodoc>GetAdjustedBestSize(self) -> Size</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4370 | </method> |
4371 | <method name="Center" type="" overloaded="no"> | |
781d2982 | 4372 | <autodoc>Center(self, int direction=BOTH)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4379 | <paramlist> |
4380 | <param name="direction" type="int" default="wxBOTH"/> | |
4381 | </paramlist> | |
4382 | </method> | |
4383 | <method name="CenterOnScreen" type="" overloaded="no"> | |
781d2982 | 4384 | <autodoc>CenterOnScreen(self, int dir=BOTH)</autodoc> |
c2dda882 | 4385 | <docstring>Center on screen (only works for top level windows)</docstring> |
f32fc4bc RD |
4386 | <paramlist> |
4387 | <param name="dir" type="int" default="wxBOTH"/> | |
4388 | </paramlist> | |
4389 | </method> | |
4390 | <method name="CenterOnParent" type="" overloaded="no"> | |
781d2982 | 4391 | <autodoc>CenterOnParent(self, int dir=BOTH)</autodoc> |
c2dda882 | 4392 | <docstring>Center with respect to the the parent window</docstring> |
f32fc4bc RD |
4393 | <paramlist> |
4394 | <param name="dir" type="int" default="wxBOTH"/> | |
4395 | </paramlist> | |
4396 | </method> | |
4397 | <method name="Fit" type="" overloaded="no"> | |
781d2982 | 4398 | <autodoc>Fit(self)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4406 | </method> |
4407 | <method name="FitInside" type="" overloaded="no"> | |
781d2982 | 4408 | <autodoc>FitInside(self)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc | 4414 | </method> |
ce6878e6 RD |
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> | |
c2dda882 RD |
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 | |
ce6878e6 RD |
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. | |
4424 | ||
4425 | The resizing increments are only significant under Motif or Xt. | |
4426 | ||
4427 | :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize` | |
4428 | </docstring> | |
f32fc4bc RD |
4429 | <paramlist> |
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"/> | |
4436 | </paramlist> | |
4437 | </method> | |
ce6878e6 RD |
4438 | <method name="SetSizeHintsSz" type="" overloaded="no"> |
4439 | <autodoc>SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)</autodoc> | |
781d2982 RD |
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 | |
ce6878e6 RD |
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. | |
4446 | ||
4447 | The resizing increments are only significant under Motif or Xt. | |
4448 | ||
4449 | :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize` | |
4450 | </docstring> | |
781d2982 RD |
4451 | <paramlist> |
4452 | <param name="minSize" type="Size" default=""/> | |
4453 | <param name="maxSize" type="Size" default="wxDefaultSize"/> | |
4454 | <param name="incSize" type="Size" default="wxDefaultSize"/> | |
4455 | </paramlist> | |
4456 | </method> | |
ce6878e6 RD |
4457 | <method name="SetVirtualSizeHints" type="" overloaded="no"> |
4458 | <autodoc>SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)</autodoc> | |
c2dda882 RD |
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> | |
f32fc4bc RD |
4463 | <paramlist> |
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"/> | |
4468 | </paramlist> | |
4469 | </method> | |
ce6878e6 RD |
4470 | <method name="SetVirtualSizeHintsSz" type="" overloaded="no"> |
4471 | <autodoc>SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)</autodoc> | |
781d2982 RD |
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> | |
4476 | <paramlist> | |
4477 | <param name="minSize" type="Size" default=""/> | |
4478 | <param name="maxSize" type="Size" default="wxDefaultSize"/> | |
4479 | </paramlist> | |
4480 | </method> | |
ce6878e6 RD |
4481 | <method name="GetMaxSize" type="Size" overloaded="no"> |
4482 | <autodoc>GetMaxSize(self) -> Size</autodoc> | |
4483 | </method> | |
4484 | <method name="GetMinSize" type="Size" overloaded="no"> | |
4485 | <autodoc>GetMinSize(self) -> Size</autodoc> | |
4486 | </method> | |
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> | |
4491 | <paramlist> | |
4492 | <param name="minSize" type="Size" default=""/> | |
4493 | </paramlist> | |
4494 | </method> | |
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> | |
4499 | <paramlist> | |
4500 | <param name="maxSize" type="Size" default=""/> | |
4501 | </paramlist> | |
4502 | </method> | |
f32fc4bc | 4503 | <method name="GetMinWidth" type="int" overloaded="no"> |
781d2982 | 4504 | <autodoc>GetMinWidth(self) -> int</autodoc> |
f32fc4bc RD |
4505 | </method> |
4506 | <method name="GetMinHeight" type="int" overloaded="no"> | |
781d2982 | 4507 | <autodoc>GetMinHeight(self) -> int</autodoc> |
f32fc4bc RD |
4508 | </method> |
4509 | <method name="GetMaxWidth" type="int" overloaded="no"> | |
781d2982 | 4510 | <autodoc>GetMaxWidth(self) -> int</autodoc> |
f32fc4bc RD |
4511 | </method> |
4512 | <method name="GetMaxHeight" type="int" overloaded="no"> | |
781d2982 | 4513 | <autodoc>GetMaxHeight(self) -> int</autodoc> |
f32fc4bc | 4514 | </method> |
f32fc4bc | 4515 | <method name="SetVirtualSize" type="" overloaded="no"> |
781d2982 | 4516 | <autodoc>SetVirtualSize(self, Size size)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4520 | <paramlist> |
4521 | <param name="size" type="Size" default=""/> | |
4522 | </paramlist> | |
4523 | </method> | |
4524 | <method name="SetVirtualSizeWH" type="" overloaded="no"> | |
781d2982 | 4525 | <autodoc>SetVirtualSizeWH(self, int w, int h)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4529 | <paramlist> |
4530 | <param name="w" type="int" default=""/> | |
4531 | <param name="h" type="int" default=""/> | |
4532 | </paramlist> | |
4533 | </method> | |
4534 | <method name="GetVirtualSize" type="Size" overloaded="no"> | |
781d2982 | 4535 | <autodoc>GetVirtualSize(self) -> Size</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4539 | </method> |
4540 | <method name="GetVirtualSizeTuple" type="" overloaded="no"> | |
4541 | <autodoc>GetVirtualSizeTuple() -> (width, height)</autodoc> | |
c2dda882 RD |
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> | |
f32fc4bc RD |
4545 | <paramlist> |
4546 | <param name="OUTPUT" type="int" default=""/> | |
4547 | <param name="OUTPUT" type="int" default=""/> | |
4548 | </paramlist> | |
4549 | </method> | |
4550 | <method name="GetBestVirtualSize" type="Size" overloaded="no"> | |
781d2982 | 4551 | <autodoc>GetBestVirtualSize(self) -> Size</autodoc> |
c2dda882 RD |
4552 | <docstring>Return the largest of ClientSize and BestSize (as determined by a |
4553 | sizer, interior children, or other means)</docstring> | |
f32fc4bc RD |
4554 | </method> |
4555 | <method name="Show" type="bool" overloaded="no"> | |
781d2982 | 4556 | <autodoc>Show(self, bool show=True) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4562 | <paramlist> |
4563 | <param name="show" type="bool" default="True"/> | |
4564 | </paramlist> | |
4565 | </method> | |
4566 | <method name="Hide" type="bool" overloaded="no"> | |
781d2982 | 4567 | <autodoc>Hide(self) -> bool</autodoc> |
c2dda882 | 4568 | <docstring>Equivalent to calling Show(False).</docstring> |
f32fc4bc RD |
4569 | </method> |
4570 | <method name="Enable" type="bool" overloaded="no"> | |
781d2982 | 4571 | <autodoc>Enable(self, bool enable=True) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4577 | <paramlist> |
4578 | <param name="enable" type="bool" default="True"/> | |
4579 | </paramlist> | |
4580 | </method> | |
4581 | <method name="Disable" type="bool" overloaded="no"> | |
781d2982 | 4582 | <autodoc>Disable(self) -> bool</autodoc> |
c2dda882 | 4583 | <docstring>Disables the window, same as Enable(false).</docstring> |
f32fc4bc RD |
4584 | </method> |
4585 | <method name="IsShown" type="bool" overloaded="no"> | |
781d2982 | 4586 | <autodoc>IsShown(self) -> bool</autodoc> |
c2dda882 | 4587 | <docstring>Returns true if the window is shown, false if it has been hidden.</docstring> |
f32fc4bc RD |
4588 | </method> |
4589 | <method name="IsEnabled" type="bool" overloaded="no"> | |
781d2982 | 4590 | <autodoc>IsEnabled(self) -> bool</autodoc> |
c2dda882 | 4591 | <docstring>Returns true if the window is enabled for input, false otherwise.</docstring> |
f32fc4bc RD |
4592 | </method> |
4593 | <method name="SetWindowStyleFlag" type="" overloaded="no"> | |
781d2982 | 4594 | <autodoc>SetWindowStyleFlag(self, long style)</autodoc> |
c2dda882 | 4595 | <docstring>Sets the style of the window. Please note that some styles cannot be |
781d2982 RD |
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> | |
f32fc4bc RD |
4599 | <paramlist> |
4600 | <param name="style" type="long" default=""/> | |
4601 | </paramlist> | |
4602 | </method> | |
4603 | <method name="GetWindowStyleFlag" type="long" overloaded="no"> | |
781d2982 | 4604 | <autodoc>GetWindowStyleFlag(self) -> long</autodoc> |
c2dda882 RD |
4605 | <docstring>Gets the window style that was passed to the constructor or Create |
4606 | method.</docstring> | |
f32fc4bc RD |
4607 | </method> |
4608 | <method name="HasFlag" type="bool" overloaded="no"> | |
781d2982 | 4609 | <autodoc>HasFlag(self, int flag) -> bool</autodoc> |
c2dda882 | 4610 | <docstring>Test if the given style is set for this window.</docstring> |
f32fc4bc RD |
4611 | <paramlist> |
4612 | <param name="flag" type="int" default=""/> | |
4613 | </paramlist> | |
4614 | </method> | |
4615 | <method name="IsRetained" type="bool" overloaded="no"> | |
781d2982 | 4616 | <autodoc>IsRetained(self) -> bool</autodoc> |
c2dda882 RD |
4617 | <docstring>Returns true if the window is retained, false otherwise. Retained |
4618 | windows are only available on X platforms.</docstring> | |
f32fc4bc RD |
4619 | </method> |
4620 | <method name="SetExtraStyle" type="" overloaded="no"> | |
781d2982 | 4621 | <autodoc>SetExtraStyle(self, long exStyle)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4625 | <paramlist> |
4626 | <param name="exStyle" type="long" default=""/> | |
4627 | </paramlist> | |
4628 | </method> | |
4629 | <method name="GetExtraStyle" type="long" overloaded="no"> | |
781d2982 | 4630 | <autodoc>GetExtraStyle(self) -> long</autodoc> |
c2dda882 | 4631 | <docstring>Returns the extra style bits for the window.</docstring> |
f32fc4bc RD |
4632 | </method> |
4633 | <method name="MakeModal" type="" overloaded="no"> | |
781d2982 | 4634 | <autodoc>MakeModal(self, bool modal=True)</autodoc> |
c2dda882 RD |
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 | |
4637 | effect.</docstring> | |
f32fc4bc RD |
4638 | <paramlist> |
4639 | <param name="modal" type="bool" default="True"/> | |
4640 | </paramlist> | |
4641 | </method> | |
4642 | <method name="SetThemeEnabled" type="" overloaded="no"> | |
781d2982 | 4643 | <autodoc>SetThemeEnabled(self, bool enableTheme)</autodoc> |
c2dda882 RD |
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. | |
4650 | ||
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> | |
f32fc4bc RD |
4653 | <paramlist> |
4654 | <param name="enableTheme" type="bool" default=""/> | |
4655 | </paramlist> | |
4656 | </method> | |
4657 | <method name="GetThemeEnabled" type="bool" overloaded="no"> | |
781d2982 | 4658 | <autodoc>GetThemeEnabled(self) -> bool</autodoc> |
c2dda882 | 4659 | <docstring>Return the themeEnabled flag.</docstring> |
f32fc4bc RD |
4660 | </method> |
4661 | <method name="SetFocus" type="" overloaded="no"> | |
781d2982 | 4662 | <autodoc>SetFocus(self)</autodoc> |
c2dda882 | 4663 | <docstring>Set's the focus to this window, allowing it to receive keyboard input.</docstring> |
f32fc4bc RD |
4664 | </method> |
4665 | <method name="SetFocusFromKbd" type="" overloaded="no"> | |
781d2982 | 4666 | <autodoc>SetFocusFromKbd(self)</autodoc> |
c2dda882 RD |
4667 | <docstring>Set focus to this window as the result of a keyboard action. Normally |
4668 | only called internally.</docstring> | |
f32fc4bc RD |
4669 | </method> |
4670 | <staticmethod name="FindFocus" type="Window" overloaded="no"> | |
4671 | <autodoc>FindFocus() -> Window</autodoc> | |
c2dda882 RD |
4672 | <docstring>Returns the window or control that currently has the keyboard focus, |
4673 | or None.</docstring> | |
f32fc4bc RD |
4674 | </staticmethod> |
4675 | <method name="AcceptsFocus" type="bool" overloaded="no"> | |
781d2982 | 4676 | <autodoc>AcceptsFocus(self) -> bool</autodoc> |
c2dda882 | 4677 | <docstring>Can this window have focus?</docstring> |
f32fc4bc RD |
4678 | </method> |
4679 | <method name="AcceptsFocusFromKeyboard" type="bool" overloaded="no"> | |
781d2982 | 4680 | <autodoc>AcceptsFocusFromKeyboard(self) -> bool</autodoc> |
c2dda882 RD |
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 | |
4683 | it.</docstring> | |
f32fc4bc RD |
4684 | </method> |
4685 | <method name="GetDefaultItem" type="Window" overloaded="no"> | |
781d2982 | 4686 | <autodoc>GetDefaultItem(self) -> Window</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4689 | </method> |
4690 | <method name="SetDefaultItem" type="Window" overloaded="no"> | |
781d2982 | 4691 | <autodoc>SetDefaultItem(self, Window child) -> Window</autodoc> |
c2dda882 | 4692 | <docstring>Set this child as default, return the old default.</docstring> |
f32fc4bc RD |
4693 | <paramlist> |
4694 | <param name="child" type="Window" default=""/> | |
4695 | </paramlist> | |
4696 | </method> | |
4697 | <method name="SetTmpDefaultItem" type="" overloaded="no"> | |
781d2982 | 4698 | <autodoc>SetTmpDefaultItem(self, Window win)</autodoc> |
c2dda882 | 4699 | <docstring>Set this child as temporary default</docstring> |
f32fc4bc RD |
4700 | <paramlist> |
4701 | <param name="win" type="Window" default=""/> | |
4702 | </paramlist> | |
4703 | </method> | |
ce6878e6 RD |
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`. | |
4708 | ||
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. | |
4717 | ||
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> | |
4723 | <paramlist> | |
4724 | <param name="flags" type="int" default="wxNavigationKeyEvent::IsForward"/> | |
4725 | </paramlist> | |
4726 | </method> | |
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. | |
4732 | ||
4733 | The default tab order is the same as creation order. This function | |
4734 | and `MoveBeforeInTabOrder` allow to change it after creating all the | |
4735 | windows. | |
4736 | </docstring> | |
4737 | <paramlist> | |
4738 | <param name="win" type="Window" default=""/> | |
4739 | </paramlist> | |
4740 | </method> | |
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> | |
4745 | <paramlist> | |
4746 | <param name="win" type="Window" default=""/> | |
4747 | </paramlist> | |
4748 | </method> | |
f32fc4bc | 4749 | <method name="GetChildren" type="PyObject" overloaded="no"> |
781d2982 | 4750 | <autodoc>GetChildren(self) -> PyObject</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4755 | </method> |
4756 | <method name="GetParent" type="Window" overloaded="no"> | |
781d2982 | 4757 | <autodoc>GetParent(self) -> Window</autodoc> |
c2dda882 | 4758 | <docstring>Returns the parent window of this window, or None if there isn't one.</docstring> |
f32fc4bc RD |
4759 | </method> |
4760 | <method name="GetGrandParent" type="Window" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
4764 | </method> |
4765 | <method name="IsTopLevel" type="bool" overloaded="no"> | |
781d2982 | 4766 | <autodoc>IsTopLevel(self) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4770 | </method> |
4771 | <method name="Reparent" type="bool" overloaded="no"> | |
781d2982 | 4772 | <autodoc>Reparent(self, Window newParent) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4778 | <paramlist> |
4779 | <param name="newParent" type="Window" default=""/> | |
4780 | </paramlist> | |
4781 | </method> | |
4782 | <method name="AddChild" type="" overloaded="no"> | |
781d2982 | 4783 | <autodoc>AddChild(self, Window child)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4786 | <paramlist> |
4787 | <param name="child" type="Window" default=""/> | |
4788 | </paramlist> | |
4789 | </method> | |
4790 | <method name="RemoveChild" type="" overloaded="no"> | |
781d2982 | 4791 | <autodoc>RemoveChild(self, Window child)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4795 | <paramlist> |
4796 | <param name="child" type="Window" default=""/> | |
4797 | </paramlist> | |
4798 | </method> | |
4799 | <method name="FindWindowById" type="Window" overloaded="no"> | |
781d2982 | 4800 | <autodoc>FindWindowById(self, long winid) -> Window</autodoc> |
c2dda882 | 4801 | <docstring>Find a chld of this window by window ID</docstring> |
f32fc4bc RD |
4802 | <paramlist> |
4803 | <param name="winid" type="long" default=""/> | |
4804 | </paramlist> | |
4805 | </method> | |
4806 | <method name="FindWindowByName" type="Window" overloaded="no"> | |
781d2982 | 4807 | <autodoc>FindWindowByName(self, String name) -> Window</autodoc> |
c2dda882 | 4808 | <docstring>Find a child of this window by name</docstring> |
f32fc4bc RD |
4809 | <paramlist> |
4810 | <param name="name" type="String" default=""/> | |
4811 | </paramlist> | |
4812 | </method> | |
4813 | <method name="GetEventHandler" type="EvtHandler" overloaded="no"> | |
781d2982 | 4814 | <autodoc>GetEventHandler(self) -> EvtHandler</autodoc> |
c2dda882 RD |
4815 | <docstring>Returns the event handler for this window. By default, the window is |
4816 | its own event handler.</docstring> | |
f32fc4bc RD |
4817 | </method> |
4818 | <method name="SetEventHandler" type="" overloaded="no"> | |
781d2982 | 4819 | <autodoc>SetEventHandler(self, EvtHandler handler)</autodoc> |
c2dda882 RD |
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. | |
4825 | ||
781d2982 | 4826 | It is usually better to use `wx.Window.PushEventHandler` since this sets |
c2dda882 RD |
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> | |
f32fc4bc RD |
4829 | <paramlist> |
4830 | <param name="handler" type="EvtHandler" default=""/> | |
4831 | </paramlist> | |
4832 | </method> | |
4833 | <method name="PushEventHandler" type="" overloaded="no"> | |
781d2982 | 4834 | <autodoc>PushEventHandler(self, EvtHandler handler)</autodoc> |
c2dda882 RD |
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 | |
4840 | window classes. | |
4841 | ||
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 | |
781d2982 | 4844 | handed to the next one in the chain. Use `wx.Window.PopEventHandler` to |
c2dda882 | 4845 | remove the event handler.</docstring> |
f32fc4bc RD |
4846 | <paramlist> |
4847 | <param name="handler" type="EvtHandler" default=""/> | |
4848 | </paramlist> | |
4849 | </method> | |
4850 | <method name="PopEventHandler" type="EvtHandler" overloaded="no"> | |
781d2982 | 4851 | <autodoc>PopEventHandler(self, bool deleteHandler=False) -> EvtHandler</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4855 | <paramlist> |
4856 | <param name="deleteHandler" type="bool" default="False"/> | |
4857 | </paramlist> | |
4858 | </method> | |
4859 | <method name="RemoveEventHandler" type="bool" overloaded="no"> | |
781d2982 RD |
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 | |
4865 | there.)</docstring> | |
f32fc4bc RD |
4866 | <paramlist> |
4867 | <param name="handler" type="EvtHandler" default=""/> | |
4868 | </paramlist> | |
4869 | </method> | |
4870 | <method name="SetValidator" type="" overloaded="no"> | |
781d2982 | 4871 | <autodoc>SetValidator(self, Validator validator)</autodoc> |
c2dda882 RD |
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 | |
4874 | type.</docstring> | |
f32fc4bc RD |
4875 | <paramlist> |
4876 | <param name="validator" type="wxValidator" default=""/> | |
4877 | </paramlist> | |
4878 | </method> | |
4879 | <method name="GetValidator" type="wxValidator" overloaded="no"> | |
781d2982 | 4880 | <autodoc>GetValidator(self) -> Validator</autodoc> |
c2dda882 RD |
4881 | <docstring>Returns a pointer to the current validator for the window, or None if |
4882 | there is none.</docstring> | |
781d2982 RD |
4883 | </method> |
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> | |
4890 | </method> | |
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> | |
4897 | </method> | |
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> | |
4904 | </method> | |
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> | |
f32fc4bc RD |
4909 | </method> |
4910 | <method name="SetAcceleratorTable" type="" overloaded="no"> | |
781d2982 | 4911 | <autodoc>SetAcceleratorTable(self, AcceleratorTable accel)</autodoc> |
c2dda882 | 4912 | <docstring>Sets the accelerator table for this window.</docstring> |
f32fc4bc RD |
4913 | <paramlist> |
4914 | <param name="accel" type="AcceleratorTable" default=""/> | |
4915 | </paramlist> | |
4916 | </method> | |
4917 | <method name="GetAcceleratorTable" type="AcceleratorTable" overloaded="no"> | |
781d2982 | 4918 | <autodoc>GetAcceleratorTable(self) -> AcceleratorTable</autodoc> |
c2dda882 | 4919 | <docstring>Gets the accelerator table for this window.</docstring> |
f32fc4bc RD |
4920 | </method> |
4921 | <method name="RegisterHotKey" type="bool" overloaded="no"> | |
781d2982 | 4922 | <autodoc>RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4930 | <paramlist> |
4931 | <param name="hotkeyId" type="int" default=""/> | |
4932 | <param name="modifiers" type="int" default=""/> | |
4933 | <param name="keycode" type="int" default=""/> | |
4934 | </paramlist> | |
4935 | </method> | |
4936 | <method name="UnregisterHotKey" type="bool" overloaded="no"> | |
781d2982 | 4937 | <autodoc>UnregisterHotKey(self, int hotkeyId) -> bool</autodoc> |
c2dda882 | 4938 | <docstring>Unregisters a system wide hotkey.</docstring> |
f32fc4bc RD |
4939 | <paramlist> |
4940 | <param name="hotkeyId" type="int" default=""/> | |
4941 | </paramlist> | |
4942 | </method> | |
4943 | <method name="ConvertDialogPointToPixels" type="Point" overloaded="no"> | |
781d2982 | 4944 | <autodoc>ConvertDialogPointToPixels(self, Point pt) -> Point</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4951 | <paramlist> |
4952 | <param name="pt" type="Point" default=""/> | |
4953 | </paramlist> | |
4954 | </method> | |
4955 | <method name="ConvertDialogSizeToPixels" type="Size" overloaded="no"> | |
781d2982 | 4956 | <autodoc>ConvertDialogSizeToPixels(self, Size sz) -> Size</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4963 | <paramlist> |
4964 | <param name="sz" type="Size" default=""/> | |
4965 | </paramlist> | |
4966 | </method> | |
4967 | <method name="DLG_PNT" type="Point" overloaded="no"> | |
781d2982 | 4968 | <autodoc>DLG_PNT(self, Point pt) -> Point</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4975 | <paramlist> |
4976 | <param name="pt" type="Point" default=""/> | |
4977 | </paramlist> | |
4978 | </method> | |
4979 | <method name="DLG_SZE" type="Size" overloaded="no"> | |
781d2982 | 4980 | <autodoc>DLG_SZE(self, Size sz) -> Size</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
4987 | <paramlist> |
4988 | <param name="sz" type="Size" default=""/> | |
4989 | </paramlist> | |
4990 | </method> | |
4991 | <method name="ConvertPixelPointToDialog" type="Point" overloaded="no"> | |
781d2982 | 4992 | <autodoc>ConvertPixelPointToDialog(self, Point pt) -> Point</autodoc> |
f32fc4bc RD |
4993 | <paramlist> |
4994 | <param name="pt" type="Point" default=""/> | |
4995 | </paramlist> | |
4996 | </method> | |
4997 | <method name="ConvertPixelSizeToDialog" type="Size" overloaded="no"> | |
781d2982 | 4998 | <autodoc>ConvertPixelSizeToDialog(self, Size sz) -> Size</autodoc> |
f32fc4bc RD |
4999 | <paramlist> |
5000 | <param name="sz" type="Size" default=""/> | |
5001 | </paramlist> | |
5002 | </method> | |
5003 | <method name="WarpPointer" type="" overloaded="no"> | |
781d2982 | 5004 | <autodoc>WarpPointer(self, int x, int y)</autodoc> |
c2dda882 RD |
5005 | <docstring>Moves the pointer to the given position on the window. |
5006 | ||
5007 | NOTE: This function is not supported under Mac because Apple Human | |
5008 | Interface Guidelines forbid moving the mouse cursor programmatically.</docstring> | |
f32fc4bc RD |
5009 | <paramlist> |
5010 | <param name="x" type="int" default=""/> | |
5011 | <param name="y" type="int" default=""/> | |
5012 | </paramlist> | |
5013 | </method> | |
5014 | <method name="CaptureMouse" type="" overloaded="no"> | |
781d2982 | 5015 | <autodoc>CaptureMouse(self)</autodoc> |
c2dda882 RD |
5016 | <docstring>Directs all mouse input to this window. Call wx.Window.ReleaseMouse to |
5017 | release the capture. | |
5018 | ||
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> | |
f32fc4bc RD |
5024 | </method> |
5025 | <method name="ReleaseMouse" type="" overloaded="no"> | |
781d2982 | 5026 | <autodoc>ReleaseMouse(self)</autodoc> |
c2dda882 | 5027 | <docstring>Releases mouse input captured with wx.Window.CaptureMouse.</docstring> |
f32fc4bc RD |
5028 | </method> |
5029 | <staticmethod name="GetCapture" type="Window" overloaded="no"> | |
5030 | <autodoc>GetCapture() -> Window</autodoc> | |
c2dda882 | 5031 | <docstring>Returns the window which currently captures the mouse or None</docstring> |
f32fc4bc RD |
5032 | </staticmethod> |
5033 | <method name="HasCapture" type="bool" overloaded="no"> | |
781d2982 | 5034 | <autodoc>HasCapture(self) -> bool</autodoc> |
c2dda882 | 5035 | <docstring>Returns true if this window has the current mouse capture.</docstring> |
f32fc4bc RD |
5036 | </method> |
5037 | <method name="Refresh" type="" overloaded="no"> | |
781d2982 | 5038 | <autodoc>Refresh(self, bool eraseBackground=True, Rect rect=None)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5042 | <paramlist> |
5043 | <param name="eraseBackground" type="bool" default="True"/> | |
5044 | <param name="rect" type="Rect" default="NULL"/> | |
5045 | </paramlist> | |
5046 | </method> | |
5047 | <method name="RefreshRect" type="" overloaded="no"> | |
781d2982 | 5048 | <autodoc>RefreshRect(self, Rect rect)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5051 | <paramlist> |
5052 | <param name="rect" type="Rect" default=""/> | |
5053 | </paramlist> | |
5054 | </method> | |
5055 | <method name="Update" type="" overloaded="no"> | |
781d2982 | 5056 | <autodoc>Update(self)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5064 | </method> |
5065 | <method name="ClearBackground" type="" overloaded="no"> | |
781d2982 | 5066 | <autodoc>ClearBackground(self)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5069 | </method> |
5070 | <method name="Freeze" type="" overloaded="no"> | |
781d2982 RD |
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 | |
5076 | been undone. | |
c2dda882 RD |
5077 | |
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> | |
f32fc4bc RD |
5083 | </method> |
5084 | <method name="Thaw" type="" overloaded="no"> | |
781d2982 | 5085 | <autodoc>Thaw(self)</autodoc> |
b39e211b | 5086 | <docstring>Reenables window updating after a previous call to Freeze. Calls to |
781d2982 RD |
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> | |
f32fc4bc RD |
5089 | </method> |
5090 | <method name="PrepareDC" type="" overloaded="no"> | |
781d2982 | 5091 | <autodoc>PrepareDC(self, DC dc)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5095 | <paramlist> |
5096 | <param name="dc" type="wxDC" default=""/> | |
5097 | </paramlist> | |
5098 | </method> | |
5099 | <method name="GetUpdateRegion" type="wxRegion" overloaded="no"> | |
781d2982 | 5100 | <autodoc>GetUpdateRegion(self) -> Region</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5103 | </method> |
5104 | <method name="GetUpdateClientRect" type="Rect" overloaded="no"> | |
781d2982 | 5105 | <autodoc>GetUpdateClientRect(self) -> Rect</autodoc> |
c2dda882 | 5106 | <docstring>Get the update rectangle region bounding box in client coords.</docstring> |
f32fc4bc RD |
5107 | </method> |
5108 | <method name="IsExposed" type="bool" overloaded="no"> | |
781d2982 | 5109 | <autodoc>IsExposed(self, int x, int y, int w=1, int h=1) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5114 | <paramlist> |
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"/> | |
5119 | </paramlist> | |
5120 | </method> | |
5121 | <method name="IsExposedPoint" type="bool" overloaded="no"> | |
781d2982 | 5122 | <autodoc>IsExposedPoint(self, Point pt) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5127 | <paramlist> |
5128 | <param name="pt" type="Point" default=""/> | |
5129 | </paramlist> | |
5130 | </method> | |
b39e211b | 5131 | <method name="IsExposedRect" type="bool" overloaded="no"> |
781d2982 | 5132 | <autodoc>IsExposedRect(self, Rect rect) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5137 | <paramlist> |
5138 | <param name="rect" type="Rect" default=""/> | |
5139 | </paramlist> | |
5140 | </method> | |
781d2982 RD |
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> | |
5148 | </method> | |
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. | |
5156 | ||
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 | |
5160 | this.</docstring> | |
5161 | <paramlist> | |
5162 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
5163 | </paramlist> | |
5164 | </staticmethod> | |
f32fc4bc | 5165 | <method name="SetBackgroundColour" type="bool" overloaded="no"> |
781d2982 | 5166 | <autodoc>SetBackgroundColour(self, Colour colour) -> bool</autodoc> |
c2dda882 RD |
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 | |
ce6878e6 RD |
5170 | automatically under GTK. Using `wx.NullColour` will reset the window |
5171 | to the default background colour. | |
c2dda882 | 5172 | |
781d2982 | 5173 | Note that setting the background colour may not cause an immediate |
ce6878e6 | 5174 | refresh, so you may wish to call `ClearBackground` or `Refresh` after |
c2dda882 RD |
5175 | calling this function. |
5176 | ||
ce6878e6 RD |
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> | |
f32fc4bc RD |
5181 | <paramlist> |
5182 | <param name="colour" type="wxColour" default=""/> | |
5183 | </paramlist> | |
5184 | </method> | |
ce6878e6 RD |
5185 | <method name="SetOwnBackgroundColour" type="" overloaded="no"> |
5186 | <autodoc>SetOwnBackgroundColour(self, Colour colour)</autodoc> | |
781d2982 RD |
5187 | <paramlist> |
5188 | <param name="colour" type="wxColour" default=""/> | |
5189 | </paramlist> | |
5190 | </method> | |
f32fc4bc | 5191 | <method name="SetForegroundColour" type="bool" overloaded="no"> |
781d2982 | 5192 | <autodoc>SetForegroundColour(self, Colour colour) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5197 | <paramlist> |
5198 | <param name="colour" type="wxColour" default=""/> | |
5199 | </paramlist> | |
5200 | </method> | |
fa47d7a7 VS |
5201 | <method name="SetOwnForegroundColour" type="" overloaded="no"> |
5202 | <autodoc>SetOwnForegroundColour(self, Colour colour)</autodoc> | |
781d2982 RD |
5203 | <paramlist> |
5204 | <param name="colour" type="wxColour" default=""/> | |
5205 | </paramlist> | |
5206 | </method> | |
f32fc4bc | 5207 | <method name="GetBackgroundColour" type="wxColour" overloaded="no"> |
781d2982 | 5208 | <autodoc>GetBackgroundColour(self) -> Colour</autodoc> |
c2dda882 | 5209 | <docstring>Returns the background colour of the window.</docstring> |
f32fc4bc RD |
5210 | </method> |
5211 | <method name="GetForegroundColour" type="wxColour" overloaded="no"> | |
781d2982 | 5212 | <autodoc>GetForegroundColour(self) -> Colour</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5216 | </method> |
5217 | <method name="SetCursor" type="bool" overloaded="no"> | |
781d2982 | 5218 | <autodoc>SetCursor(self, Cursor cursor) -> bool</autodoc> |
c2dda882 RD |
5219 | <docstring>Sets the window's cursor. Notice that the window cursor also sets it |
5220 | for the children of the window implicitly. | |
5221 | ||
5222 | The cursor may be wx.NullCursor in which case the window cursor will | |
5223 | be reset back to default.</docstring> | |
f32fc4bc RD |
5224 | <paramlist> |
5225 | <param name="cursor" type="wxCursor" default=""/> | |
5226 | </paramlist> | |
5227 | </method> | |
5228 | <method name="GetCursor" type="wxCursor" overloaded="no"> | |
781d2982 | 5229 | <autodoc>GetCursor(self) -> Cursor</autodoc> |
c2dda882 | 5230 | <docstring>Return the cursor associated with this window.</docstring> |
f32fc4bc RD |
5231 | </method> |
5232 | <method name="SetFont" type="bool" overloaded="no"> | |
781d2982 | 5233 | <autodoc>SetFont(self, Font font) -> bool</autodoc> |
c2dda882 | 5234 | <docstring>Sets the font for this window.</docstring> |
f32fc4bc RD |
5235 | <paramlist> |
5236 | <param name="font" type="wxFont" default=""/> | |
5237 | </paramlist> | |
5238 | </method> | |
fa47d7a7 VS |
5239 | <method name="SetOwnFont" type="" overloaded="no"> |
5240 | <autodoc>SetOwnFont(self, Font font)</autodoc> | |
781d2982 RD |
5241 | <paramlist> |
5242 | <param name="font" type="wxFont" default=""/> | |
5243 | </paramlist> | |
5244 | </method> | |
f32fc4bc | 5245 | <method name="GetFont" type="wxFont" overloaded="no"> |
781d2982 | 5246 | <autodoc>GetFont(self) -> Font</autodoc> |
b39e211b | 5247 | <docstring>Returns the default font used for this window.</docstring> |
f32fc4bc RD |
5248 | </method> |
5249 | <method name="SetCaret" type="" overloaded="no"> | |
781d2982 | 5250 | <autodoc>SetCaret(self, Caret caret)</autodoc> |
c2dda882 | 5251 | <docstring>Sets the caret associated with the window.</docstring> |
f32fc4bc RD |
5252 | <paramlist> |
5253 | <param name="caret" type="wxCaret" default=""/> | |
5254 | </paramlist> | |
5255 | </method> | |
5256 | <method name="GetCaret" type="wxCaret" overloaded="no"> | |
781d2982 | 5257 | <autodoc>GetCaret(self) -> Caret</autodoc> |
c2dda882 | 5258 | <docstring>Returns the caret associated with the window.</docstring> |
f32fc4bc RD |
5259 | </method> |
5260 | <method name="GetCharHeight" type="int" overloaded="no"> | |
781d2982 | 5261 | <autodoc>GetCharHeight(self) -> int</autodoc> |
c2dda882 | 5262 | <docstring>Get the (average) character size for the current font.</docstring> |
f32fc4bc RD |
5263 | </method> |
5264 | <method name="GetCharWidth" type="int" overloaded="no"> | |
781d2982 | 5265 | <autodoc>GetCharWidth(self) -> int</autodoc> |
c2dda882 | 5266 | <docstring>Get the (average) character size for the current font.</docstring> |
f32fc4bc RD |
5267 | </method> |
5268 | <method name="GetTextExtent" type="" overloaded="no"> | |
5269 | <autodoc>GetTextExtent(String string) -> (width, height)</autodoc> | |
ce6878e6 | 5270 | <docstring>Get the width and height of the text using the current font.</docstring> |
f32fc4bc RD |
5271 | <paramlist> |
5272 | <param name="string" type="String" default=""/> | |
5273 | <param name="OUTPUT" type="int" default=""/> | |
5274 | <param name="OUTPUT" type="int" default=""/> | |
5275 | </paramlist> | |
5276 | </method> | |
5277 | <method name="GetFullTextExtent" type="" overloaded="no"> | |
5278 | <autodoc>GetFullTextExtent(String string, Font font=None) -> | |
5279 | (width, height, descent, externalLeading)</autodoc> | |
c2dda882 RD |
5280 | <docstring>Get the width, height, decent and leading of the text using the |
5281 | current or specified font.</docstring> | |
f32fc4bc RD |
5282 | <paramlist> |
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"/> | |
5289 | </paramlist> | |
5290 | </method> | |
5291 | <method name="ClientToScreenXY" type="" overloaded="no"> | |
c2dda882 RD |
5292 | <autodoc>ClientToScreenXY(int x, int y) -> (x,y)</autodoc> |
5293 | <docstring>Converts to screen coordinates from coordinates relative to this window.</docstring> | |
f32fc4bc RD |
5294 | <paramlist> |
5295 | <param name="x" type="int" default=""/> | |
5296 | <param name="y" type="int" default=""/> | |
5297 | </paramlist> | |
5298 | </method> | |
5299 | <method name="ScreenToClientXY" type="" overloaded="no"> | |
c2dda882 RD |
5300 | <autodoc>ScreenToClientXY(int x, int y) -> (x,y)</autodoc> |
5301 | <docstring>Converts from screen to client window coordinates.</docstring> | |
f32fc4bc RD |
5302 | <paramlist> |
5303 | <param name="x" type="int" default=""/> | |
5304 | <param name="y" type="int" default=""/> | |
5305 | </paramlist> | |
5306 | </method> | |
5307 | <method name="ClientToScreen" type="Point" overloaded="no"> | |
781d2982 | 5308 | <autodoc>ClientToScreen(self, Point pt) -> Point</autodoc> |
c2dda882 | 5309 | <docstring>Converts to screen coordinates from coordinates relative to this window.</docstring> |
f32fc4bc RD |
5310 | <paramlist> |
5311 | <param name="pt" type="Point" default=""/> | |
5312 | </paramlist> | |
5313 | </method> | |
5314 | <method name="ScreenToClient" type="Point" overloaded="no"> | |
781d2982 | 5315 | <autodoc>ScreenToClient(self, Point pt) -> Point</autodoc> |
c2dda882 | 5316 | <docstring>Converts from screen to client window coordinates.</docstring> |
f32fc4bc RD |
5317 | <paramlist> |
5318 | <param name="pt" type="Point" default=""/> | |
5319 | </paramlist> | |
5320 | </method> | |
5321 | <method name="HitTestXY" type="wxHitTest" overloaded="no"> | |
781d2982 | 5322 | <autodoc>HitTestXY(self, int x, int y) -> int</autodoc> |
c2dda882 | 5323 | <docstring>Test where the given (in client coords) point lies</docstring> |
f32fc4bc RD |
5324 | <paramlist> |
5325 | <param name="x" type="int" default=""/> | |
5326 | <param name="y" type="int" default=""/> | |
5327 | </paramlist> | |
5328 | </method> | |
5329 | <method name="HitTest" type="wxHitTest" overloaded="no"> | |
781d2982 | 5330 | <autodoc>HitTest(self, Point pt) -> int</autodoc> |
c2dda882 | 5331 | <docstring>Test where the given (in client coords) point lies</docstring> |
f32fc4bc RD |
5332 | <paramlist> |
5333 | <param name="pt" type="Point" default=""/> | |
5334 | </paramlist> | |
5335 | </method> | |
c2dda882 RD |
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 | |
5340 | reasonable. | |
5341 | </docstring> | |
f32fc4bc RD |
5342 | <paramlist> |
5343 | <param name="flags" type="long" default=""/> | |
5344 | </paramlist> | |
5345 | </method> | |
c2dda882 | 5346 | <method name="GetBorder" type="wxBorder" overloaded="yes"> |
781d2982 RD |
5347 | <autodoc>GetBorder(self, long flags) -> int |
5348 | GetBorder(self) -> int</autodoc> | |
c2dda882 | 5349 | <docstring>Get border for the flags of this window</docstring> |
f32fc4bc RD |
5350 | </method> |
5351 | <method name="UpdateWindowUI" type="" overloaded="no"> | |
781d2982 | 5352 | <autodoc>UpdateWindowUI(self, long flags=UPDATE_UI_NONE)</autodoc> |
c2dda882 RD |
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 | |
ce6878e6 RD |
5362 | in idle time. |
5363 | The flags should be a bitlist of one or more of the following values: | |
5364 | ||
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 | ===================== ============================== | |
5370 | ||
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:: | |
5377 | ||
5378 | def OnIdle(self, evt): | |
5379 | if wx.UpdateUIEvent.CanUpdate(self): | |
5380 | self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE); | |
5381 | </docstring> | |
f32fc4bc RD |
5382 | <paramlist> |
5383 | <param name="flags" type="long" default="wxUPDATE_UI_NONE"/> | |
5384 | </paramlist> | |
5385 | </method> | |
5386 | <method name="PopupMenuXY" type="bool" overloaded="no"> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
5393 | <paramlist> |
5394 | <param name="menu" type="wxMenu" default=""/> | |
ce6878e6 RD |
5395 | <param name="x" type="int" default="-1"/> |
5396 | <param name="y" type="int" default="-1"/> | |
f32fc4bc RD |
5397 | </paramlist> |
5398 | </method> | |
5399 | <method name="PopupMenu" type="bool" overloaded="no"> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
5406 | <paramlist> |
5407 | <param name="menu" type="wxMenu" default=""/> | |
ce6878e6 | 5408 | <param name="pos" type="Point" default="wxDefaultPosition"/> |
f32fc4bc RD |
5409 | </paramlist> |
5410 | </method> | |
5411 | <method name="GetHandle" type="long" overloaded="no"> | |
781d2982 | 5412 | <autodoc>GetHandle(self) -> long</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5416 | </method> |
5417 | <method name="HasScrollbar" type="bool" overloaded="no"> | |
781d2982 | 5418 | <autodoc>HasScrollbar(self, int orient) -> bool</autodoc> |
c2dda882 | 5419 | <docstring>Does the window have the scrollbar for this orientation?</docstring> |
f32fc4bc RD |
5420 | <paramlist> |
5421 | <param name="orient" type="int" default=""/> | |
5422 | </paramlist> | |
5423 | </method> | |
5424 | <method name="SetScrollbar" type="" overloaded="no"> | |
781d2982 | 5425 | <autodoc>SetScrollbar(self, int orientation, int position, int thumbSize, int range, |
c2dda882 | 5426 | bool refresh=True)</autodoc> |
ce6878e6 RD |
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. | |
5430 | ||
5431 | :param position: The position of the scrollbar in scroll units. | |
5432 | ||
5433 | :param thumbSize: The size of the thumb, or visible portion of the | |
5434 | scrollbar, in scroll units. | |
5435 | ||
5436 | :param range: The maximum position of the scrollbar. | |
5437 | ||
5438 | :param refresh: True to redraw the scrollbar, false otherwise. | |
5439 | </docstring> | |
f32fc4bc | 5440 | <paramlist> |
c2dda882 | 5441 | <param name="orientation" type="int" default=""/> |
781d2982 RD |
5442 | <param name="position" type="int" default=""/> |
5443 | <param name="thumbSize" type="int" default=""/> | |
f32fc4bc RD |
5444 | <param name="range" type="int" default=""/> |
5445 | <param name="refresh" type="bool" default="True"/> | |
5446 | </paramlist> | |
5447 | </method> | |
5448 | <method name="SetScrollPos" type="" overloaded="no"> | |
781d2982 | 5449 | <autodoc>SetScrollPos(self, int orientation, int pos, bool refresh=True)</autodoc> |
c2dda882 | 5450 | <docstring>Sets the position of one of the built-in scrollbars.</docstring> |
f32fc4bc | 5451 | <paramlist> |
c2dda882 | 5452 | <param name="orientation" type="int" default=""/> |
f32fc4bc RD |
5453 | <param name="pos" type="int" default=""/> |
5454 | <param name="refresh" type="bool" default="True"/> | |
5455 | </paramlist> | |
5456 | </method> | |
5457 | <method name="GetScrollPos" type="int" overloaded="no"> | |
781d2982 | 5458 | <autodoc>GetScrollPos(self, int orientation) -> int</autodoc> |
c2dda882 | 5459 | <docstring>Returns the built-in scrollbar position.</docstring> |
f32fc4bc | 5460 | <paramlist> |
c2dda882 | 5461 | <param name="orientation" type="int" default=""/> |
f32fc4bc RD |
5462 | </paramlist> |
5463 | </method> | |
5464 | <method name="GetScrollThumb" type="int" overloaded="no"> | |
781d2982 | 5465 | <autodoc>GetScrollThumb(self, int orientation) -> int</autodoc> |
c2dda882 | 5466 | <docstring>Returns the built-in scrollbar thumb size.</docstring> |
f32fc4bc | 5467 | <paramlist> |
c2dda882 | 5468 | <param name="orientation" type="int" default=""/> |
f32fc4bc RD |
5469 | </paramlist> |
5470 | </method> | |
5471 | <method name="GetScrollRange" type="int" overloaded="no"> | |
781d2982 | 5472 | <autodoc>GetScrollRange(self, int orientation) -> int</autodoc> |
c2dda882 | 5473 | <docstring>Returns the built-in scrollbar range.</docstring> |
f32fc4bc | 5474 | <paramlist> |
c2dda882 | 5475 | <param name="orientation" type="int" default=""/> |
f32fc4bc RD |
5476 | </paramlist> |
5477 | </method> | |
5478 | <method name="ScrollWindow" type="" overloaded="no"> | |
781d2982 | 5479 | <autodoc>ScrollWindow(self, int dx, int dy, Rect rect=None)</autodoc> |
c2dda882 RD |
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 | |
ce6878e6 RD |
5483 | it is rarely required to call this function from a user program. |
5484 | :param dx: Amount to scroll horizontally. | |
5485 | ||
5486 | :param dy: Amount to scroll vertically. | |
5487 | ||
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> | |
f32fc4bc RD |
5493 | <paramlist> |
5494 | <param name="dx" type="int" default=""/> | |
5495 | <param name="dy" type="int" default=""/> | |
5496 | <param name="rect" type="Rect" default="NULL"/> | |
5497 | </paramlist> | |
5498 | </method> | |
5499 | <method name="ScrollLines" type="bool" overloaded="no"> | |
781d2982 | 5500 | <autodoc>ScrollLines(self, int lines) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5505 | <paramlist> |
5506 | <param name="lines" type="int" default=""/> | |
5507 | </paramlist> | |
5508 | </method> | |
5509 | <method name="ScrollPages" type="bool" overloaded="no"> | |
781d2982 RD |
5510 | <autodoc>ScrollPages(self, int pages) -> bool</autodoc> |
5511 | <docstring>If the platform and window class supports it, scrolls the window by | |
c2dda882 RD |
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> | |
f32fc4bc RD |
5515 | <paramlist> |
5516 | <param name="pages" type="int" default=""/> | |
5517 | </paramlist> | |
5518 | </method> | |
5519 | <method name="LineUp" type="bool" overloaded="no"> | |
781d2982 | 5520 | <autodoc>LineUp(self) -> bool</autodoc> |
c2dda882 | 5521 | <docstring>This is just a wrapper for ScrollLines(-1).</docstring> |
f32fc4bc RD |
5522 | </method> |
5523 | <method name="LineDown" type="bool" overloaded="no"> | |
781d2982 | 5524 | <autodoc>LineDown(self) -> bool</autodoc> |
c2dda882 | 5525 | <docstring>This is just a wrapper for ScrollLines(1).</docstring> |
f32fc4bc RD |
5526 | </method> |
5527 | <method name="PageUp" type="bool" overloaded="no"> | |
781d2982 | 5528 | <autodoc>PageUp(self) -> bool</autodoc> |
c2dda882 | 5529 | <docstring>This is just a wrapper for ScrollPages(-1).</docstring> |
f32fc4bc RD |
5530 | </method> |
5531 | <method name="PageDown" type="bool" overloaded="no"> | |
781d2982 | 5532 | <autodoc>PageDown(self) -> bool</autodoc> |
c2dda882 | 5533 | <docstring>This is just a wrapper for ScrollPages(1).</docstring> |
f32fc4bc RD |
5534 | </method> |
5535 | <method name="SetHelpText" type="" overloaded="no"> | |
781d2982 | 5536 | <autodoc>SetHelpText(self, String text)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5540 | <paramlist> |
5541 | <param name="text" type="String" default=""/> | |
5542 | </paramlist> | |
5543 | </method> | |
5544 | <method name="SetHelpTextForId" type="" overloaded="no"> | |
781d2982 | 5545 | <autodoc>SetHelpTextForId(self, String text)</autodoc> |
c2dda882 RD |
5546 | <docstring>Associate this help text with all windows with the same id as this |
5547 | one.</docstring> | |
f32fc4bc RD |
5548 | <paramlist> |
5549 | <param name="text" type="String" default=""/> | |
5550 | </paramlist> | |
5551 | </method> | |
5552 | <method name="GetHelpText" type="String" overloaded="no"> | |
781d2982 | 5553 | <autodoc>GetHelpText(self) -> String</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5557 | </method> |
5558 | <method name="SetToolTipString" type="" overloaded="no"> | |
781d2982 | 5559 | <autodoc>SetToolTipString(self, String tip)</autodoc> |
c2dda882 | 5560 | <docstring>Attach a tooltip to the window.</docstring> |
f32fc4bc RD |
5561 | <paramlist> |
5562 | <param name="tip" type="String" default=""/> | |
5563 | </paramlist> | |
5564 | </method> | |
5565 | <method name="SetToolTip" type="" overloaded="no"> | |
781d2982 | 5566 | <autodoc>SetToolTip(self, ToolTip tip)</autodoc> |
c2dda882 | 5567 | <docstring>Attach a tooltip to the window.</docstring> |
f32fc4bc RD |
5568 | <paramlist> |
5569 | <param name="tip" type="wxToolTip" default=""/> | |
5570 | </paramlist> | |
5571 | </method> | |
5572 | <method name="GetToolTip" type="wxToolTip" overloaded="no"> | |
781d2982 | 5573 | <autodoc>GetToolTip(self) -> ToolTip</autodoc> |
c2dda882 | 5574 | <docstring>get the associated tooltip or None if none</docstring> |
f32fc4bc RD |
5575 | </method> |
5576 | <method name="SetDropTarget" type="" overloaded="no"> | |
781d2982 | 5577 | <autodoc>SetDropTarget(self, DropTarget dropTarget)</autodoc> |
c2dda882 RD |
5578 | <docstring>Associates a drop target with this window. If the window already has |
5579 | a drop target, it is deleted.</docstring> | |
f32fc4bc RD |
5580 | <paramlist> |
5581 | <param name="dropTarget" type="wxPyDropTarget" default=""/> | |
5582 | </paramlist> | |
5583 | </method> | |
5584 | <method name="GetDropTarget" type="wxPyDropTarget" overloaded="no"> | |
781d2982 | 5585 | <autodoc>GetDropTarget(self) -> DropTarget</autodoc> |
c2dda882 | 5586 | <docstring>Returns the associated drop target, which may be None.</docstring> |
f32fc4bc RD |
5587 | </method> |
5588 | <method name="SetConstraints" type="" overloaded="no"> | |
781d2982 | 5589 | <autodoc>SetConstraints(self, LayoutConstraints constraints)</autodoc> |
c2dda882 RD |
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 | |
5593 | constraints. | |
5594 | ||
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 | |
5599 | effect.</docstring> | |
f32fc4bc RD |
5600 | <paramlist> |
5601 | <param name="constraints" type="wxLayoutConstraints" default=""/> | |
5602 | </paramlist> | |
5603 | </method> | |
5604 | <method name="GetConstraints" type="wxLayoutConstraints" overloaded="no"> | |
781d2982 | 5605 | <autodoc>GetConstraints(self) -> LayoutConstraints</autodoc> |
c2dda882 RD |
5606 | <docstring>Returns a pointer to the window's layout constraints, or None if there |
5607 | are none.</docstring> | |
f32fc4bc RD |
5608 | </method> |
5609 | <method name="SetAutoLayout" type="" overloaded="no"> | |
781d2982 | 5610 | <autodoc>SetAutoLayout(self, bool autoLayout)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5615 | <paramlist> |
5616 | <param name="autoLayout" type="bool" default=""/> | |
5617 | </paramlist> | |
5618 | </method> | |
5619 | <method name="GetAutoLayout" type="bool" overloaded="no"> | |
781d2982 | 5620 | <autodoc>GetAutoLayout(self) -> bool</autodoc> |
c2dda882 | 5621 | <docstring>Returns the current autoLayout setting</docstring> |
f32fc4bc RD |
5622 | </method> |
5623 | <method name="Layout" type="bool" overloaded="no"> | |
781d2982 | 5624 | <autodoc>Layout(self) -> bool</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5629 | </method> |
5630 | <method name="SetSizer" type="" overloaded="no"> | |
781d2982 | 5631 | <autodoc>SetSizer(self, Sizer sizer, bool deleteOld=True)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5638 | <paramlist> |
5639 | <param name="sizer" type="wxSizer" default=""/> | |
5640 | <param name="deleteOld" type="bool" default="True"/> | |
5641 | </paramlist> | |
5642 | </method> | |
5643 | <method name="SetSizerAndFit" type="" overloaded="no"> | |
781d2982 | 5644 | <autodoc>SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5647 | <paramlist> |
5648 | <param name="sizer" type="wxSizer" default=""/> | |
5649 | <param name="deleteOld" type="bool" default="True"/> | |
5650 | </paramlist> | |
5651 | </method> | |
5652 | <method name="GetSizer" type="wxSizer" overloaded="no"> | |
781d2982 | 5653 | <autodoc>GetSizer(self) -> Sizer</autodoc> |
c2dda882 RD |
5654 | <docstring>Return the sizer associated with the window by a previous call to |
5655 | SetSizer or None if there isn't one.</docstring> | |
f32fc4bc RD |
5656 | </method> |
5657 | <method name="SetContainingSizer" type="" overloaded="no"> | |
781d2982 | 5658 | <autodoc>SetContainingSizer(self, Sizer sizer)</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
5662 | <paramlist> |
5663 | <param name="sizer" type="wxSizer" default=""/> | |
5664 | </paramlist> | |
5665 | </method> | |
5666 | <method name="GetContainingSizer" type="wxSizer" overloaded="no"> | |
781d2982 | 5667 | <autodoc>GetContainingSizer(self) -> Sizer</autodoc> |
c2dda882 | 5668 | <docstring>Return the sizer that this window is a member of, if any, otherwise None.</docstring> |
f32fc4bc | 5669 | </method> |
781d2982 RD |
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 | |
5675 | colours. | |
5676 | ||
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 | |
fa47d7a7 | 5680 | SetOwnFont) and if the corresponding attribute hadn't been |
781d2982 RD |
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. | |
5685 | ||
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 | |
5694 | parents attributes. | |
5695 | </docstring> | |
5696 | </method> | |
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. | |
5702 | ||
5703 | The base class version returns false, but this method is overridden in | |
5704 | wxControl where it returns true.</docstring> | |
5705 | </method> | |
f32fc4bc RD |
5706 | </class> |
5707 | <pythoncode> | |
5708 | def DLG_PNT(win, point_or_x, y=None): | |
c2dda882 RD |
5709 | """ |
5710 | Convenience function for converting a Point or (x,y) in | |
5711 | dialog units to pixel units. | |
5712 | """ | |
f32fc4bc RD |
5713 | if y is None: |
5714 | return win.ConvertDialogPointToPixels(point_or_x) | |
5715 | else: | |
5716 | return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y)) | |
5717 | ||
5718 | def DLG_SZE(win, size_width, height=None): | |
c2dda882 RD |
5719 | """ |
5720 | Convenience function for converting a Size or (w,h) in | |
5721 | dialog units to pixel units. | |
5722 | """ | |
f32fc4bc RD |
5723 | if height is None: |
5724 | return win.ConvertDialogSizeToPixels(size_width) | |
5725 | else: | |
5726 | return win.ConvertDialogSizeToPixels(wx.Size(size_width, height)) | |
5727 | </pythoncode> | |
5728 | <method name="FindWindowById" oldname="wxFindWindowById" type="Window" overloaded="no"> | |
5729 | <autodoc>FindWindowById(long id, Window parent=None) -> Window</autodoc> | |
c2dda882 RD |
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> | |
856bf319 | 5734 | <paramlist> |
f32fc4bc RD |
5735 | <param name="id" type="long" default=""/> |
5736 | <param name="parent" type="Window" default="NULL"/> | |
856bf319 RD |
5737 | </paramlist> |
5738 | </method> | |
f32fc4bc RD |
5739 | <method name="FindWindowByName" oldname="wxFindWindowByName" type="Window" overloaded="no"> |
5740 | <autodoc>FindWindowByName(String name, Window parent=None) -> Window</autodoc> | |
c2dda882 RD |
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 | |
5745 | cases. | |
5746 | ||
5747 | If no window with such name is found, wx.FindWindowByLabel is called.</docstring> | |
856bf319 | 5748 | <paramlist> |
f32fc4bc RD |
5749 | <param name="name" type="String" default=""/> |
5750 | <param name="parent" type="Window" default="NULL"/> | |
856bf319 RD |
5751 | </paramlist> |
5752 | </method> | |
f32fc4bc RD |
5753 | <method name="FindWindowByLabel" oldname="wxFindWindowByLabel" type="Window" overloaded="no"> |
5754 | <autodoc>FindWindowByLabel(String label, Window parent=None) -> Window</autodoc> | |
c2dda882 RD |
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> | |
856bf319 | 5760 | <paramlist> |
f32fc4bc RD |
5761 | <param name="label" type="String" default=""/> |
5762 | <param name="parent" type="Window" default="NULL"/> | |
856bf319 RD |
5763 | </paramlist> |
5764 | </method> | |
f32fc4bc | 5765 | <method name="Window_FromHWND" oldname="wxWindow_FromHWND" type="Window" overloaded="no"> |
b39e211b | 5766 | <autodoc>Window_FromHWND(Window parent, unsigned long _hWnd) -> Window</autodoc> |
856bf319 | 5767 | <paramlist> |
b39e211b RD |
5768 | <param name="parent" type="Window" default=""/> |
5769 | <param name="_hWnd" type="unsigned long" default=""/> | |
856bf319 RD |
5770 | </paramlist> |
5771 | </method> | |
856bf319 | 5772 | <pythoncode> |
856bf319 RD |
5773 | #--------------------------------------------------------------------------- |
5774 | </pythoncode> | |
781d2982 | 5775 | <class name="Validator" oldname="wxValidator" module="_core"> |
f32fc4bc RD |
5776 | <baseclass name="EvtHandler"/> |
5777 | <constructor name="Validator" overloaded="no"> | |
781d2982 | 5778 | <autodoc>__init__(self) -> Validator</autodoc> |
f32fc4bc RD |
5779 | </constructor> |
5780 | <method name="Clone" type="Validator" overloaded="no"> | |
781d2982 | 5781 | <autodoc>Clone(self) -> Validator</autodoc> |
f32fc4bc RD |
5782 | </method> |
5783 | <method name="Validate" type="bool" overloaded="no"> | |
781d2982 | 5784 | <autodoc>Validate(self, Window parent) -> bool</autodoc> |
f32fc4bc RD |
5785 | <paramlist> |
5786 | <param name="parent" type="Window" default=""/> | |
5787 | </paramlist> | |
5788 | </method> | |
5789 | <method name="TransferToWindow" type="bool" overloaded="no"> | |
781d2982 | 5790 | <autodoc>TransferToWindow(self) -> bool</autodoc> |
f32fc4bc RD |
5791 | </method> |
5792 | <method name="TransferFromWindow" type="bool" overloaded="no"> | |
781d2982 | 5793 | <autodoc>TransferFromWindow(self) -> bool</autodoc> |
f32fc4bc RD |
5794 | </method> |
5795 | <method name="GetWindow" type="Window" overloaded="no"> | |
781d2982 | 5796 | <autodoc>GetWindow(self) -> Window</autodoc> |
f32fc4bc RD |
5797 | </method> |
5798 | <method name="SetWindow" type="" overloaded="no"> | |
781d2982 | 5799 | <autodoc>SetWindow(self, Window window)</autodoc> |
f32fc4bc RD |
5800 | <paramlist> |
5801 | <param name="window" type="Window" default=""/> | |
5802 | </paramlist> | |
5803 | </method> | |
5804 | <staticmethod name="IsSilent" type="bool" overloaded="no"> | |
5805 | <autodoc>IsSilent() -> bool</autodoc> | |
5806 | </staticmethod> | |
5807 | <staticmethod name="SetBellOnError" type="" overloaded="no"> | |
5808 | <autodoc>SetBellOnError(int doIt=True)</autodoc> | |
5809 | <paramlist> | |
5810 | <param name="doIt" type="int" default="True"/> | |
5811 | </paramlist> | |
5812 | </staticmethod> | |
5813 | </class> | |
781d2982 | 5814 | <class name="PyValidator" oldname="wxPyValidator" module="_core"> |
f32fc4bc RD |
5815 | <baseclass name="Validator"/> |
5816 | <constructor name="PyValidator" overloaded="no"> | |
781d2982 | 5817 | <autodoc>__init__(self) -> PyValidator</autodoc> |
f32fc4bc RD |
5818 | </constructor> |
5819 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 5820 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)</autodoc> |
f32fc4bc RD |
5821 | <paramlist> |
5822 | <param name="self" type="PyObject" default=""/> | |
5823 | <param name="_class" type="PyObject" default=""/> | |
5824 | <param name="incref" type="int" default="True"/> | |
5825 | </paramlist> | |
5826 | </method> | |
5827 | </class> | |
5828 | <pythoncode> | |
856bf319 RD |
5829 | #--------------------------------------------------------------------------- |
5830 | </pythoncode> | |
781d2982 | 5831 | <class name="Menu" oldname="wxMenu" module="_core"> |
f32fc4bc RD |
5832 | <baseclass name="EvtHandler"/> |
5833 | <constructor name="Menu" overloaded="no"> | |
781d2982 | 5834 | <autodoc>__init__(self, String title=EmptyString, long style=0) -> Menu</autodoc> |
f32fc4bc RD |
5835 | <paramlist> |
5836 | <param name="title" type="String" default="wxPyEmptyString"/> | |
5837 | <param name="style" type="long" default="0"/> | |
5838 | </paramlist> | |
5839 | </constructor> | |
5840 | <method name="Append" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5841 | <autodoc>Append(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem</autodoc> |
f32fc4bc RD |
5842 | <paramlist> |
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"/> | |
5847 | </paramlist> | |
5848 | </method> | |
5849 | <method name="AppendSeparator" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5850 | <autodoc>AppendSeparator(self) -> MenuItem</autodoc> |
f32fc4bc RD |
5851 | </method> |
5852 | <method name="AppendCheckItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5853 | <autodoc>AppendCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5854 | <paramlist> |
5855 | <param name="id" type="int" default=""/> | |
5856 | <param name="text" type="String" default=""/> | |
5857 | <param name="help" type="String" default="wxPyEmptyString"/> | |
5858 | </paramlist> | |
5859 | </method> | |
5860 | <method name="AppendRadioItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5861 | <autodoc>AppendRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5862 | <paramlist> |
5863 | <param name="id" type="int" default=""/> | |
5864 | <param name="text" type="String" default=""/> | |
5865 | <param name="help" type="String" default="wxPyEmptyString"/> | |
5866 | </paramlist> | |
5867 | </method> | |
5868 | <method name="AppendMenu" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5869 | <autodoc>AppendMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5870 | <paramlist> |
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"/> | |
5875 | </paramlist> | |
5876 | </method> | |
5877 | <method name="AppendItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5878 | <autodoc>AppendItem(self, MenuItem item) -> MenuItem</autodoc> |
f32fc4bc RD |
5879 | <paramlist> |
5880 | <param name="item" type="wxMenuItem" default=""/> | |
5881 | </paramlist> | |
5882 | </method> | |
5883 | <method name="Break" type="" overloaded="no"> | |
781d2982 | 5884 | <autodoc>Break(self)</autodoc> |
f32fc4bc RD |
5885 | </method> |
5886 | <method name="InsertItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5887 | <autodoc>InsertItem(self, size_t pos, MenuItem item) -> MenuItem</autodoc> |
f32fc4bc RD |
5888 | <paramlist> |
5889 | <param name="pos" type="size_t" default=""/> | |
5890 | <param name="item" type="wxMenuItem" default=""/> | |
5891 | </paramlist> | |
5892 | </method> | |
5893 | <method name="Insert" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5894 | <autodoc>Insert(self, size_t pos, int id, String text, String help=EmptyString, |
856bf319 | 5895 | int kind=ITEM_NORMAL) -> MenuItem</autodoc> |
f32fc4bc RD |
5896 | <paramlist> |
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"/> | |
5902 | </paramlist> | |
5903 | </method> | |
5904 | <method name="InsertSeparator" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5905 | <autodoc>InsertSeparator(self, size_t pos) -> MenuItem</autodoc> |
f32fc4bc RD |
5906 | <paramlist> |
5907 | <param name="pos" type="size_t" default=""/> | |
5908 | </paramlist> | |
5909 | </method> | |
5910 | <method name="InsertCheckItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5911 | <autodoc>InsertCheckItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5912 | <paramlist> |
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"/> | |
5917 | </paramlist> | |
5918 | </method> | |
5919 | <method name="InsertRadioItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5920 | <autodoc>InsertRadioItem(self, size_t pos, int id, String text, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5921 | <paramlist> |
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"/> | |
5926 | </paramlist> | |
5927 | </method> | |
5928 | <method name="InsertMenu" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5929 | <autodoc>InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5930 | <paramlist> |
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"/> | |
5936 | </paramlist> | |
5937 | </method> | |
5938 | <method name="PrependItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5939 | <autodoc>PrependItem(self, MenuItem item) -> MenuItem</autodoc> |
f32fc4bc RD |
5940 | <paramlist> |
5941 | <param name="item" type="wxMenuItem" default=""/> | |
5942 | </paramlist> | |
5943 | </method> | |
5944 | <method name="Prepend" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5945 | <autodoc>Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem</autodoc> |
f32fc4bc RD |
5946 | <paramlist> |
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"/> | |
5951 | </paramlist> | |
5952 | </method> | |
5953 | <method name="PrependSeparator" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5954 | <autodoc>PrependSeparator(self) -> MenuItem</autodoc> |
f32fc4bc RD |
5955 | </method> |
5956 | <method name="PrependCheckItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5957 | <autodoc>PrependCheckItem(self, int id, String text, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5958 | <paramlist> |
5959 | <param name="id" type="int" default=""/> | |
5960 | <param name="text" type="String" default=""/> | |
5961 | <param name="help" type="String" default="wxPyEmptyString"/> | |
5962 | </paramlist> | |
5963 | </method> | |
5964 | <method name="PrependRadioItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5965 | <autodoc>PrependRadioItem(self, int id, String text, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5966 | <paramlist> |
5967 | <param name="id" type="int" default=""/> | |
5968 | <param name="text" type="String" default=""/> | |
5969 | <param name="help" type="String" default="wxPyEmptyString"/> | |
5970 | </paramlist> | |
5971 | </method> | |
5972 | <method name="PrependMenu" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5973 | <autodoc>PrependMenu(self, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem</autodoc> |
f32fc4bc RD |
5974 | <paramlist> |
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"/> | |
5979 | </paramlist> | |
5980 | </method> | |
5981 | <method name="Remove" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5982 | <autodoc>Remove(self, int id) -> MenuItem</autodoc> |
f32fc4bc RD |
5983 | <paramlist> |
5984 | <param name="id" type="int" default=""/> | |
5985 | </paramlist> | |
5986 | </method> | |
5987 | <method name="RemoveItem" type="wxMenuItem" overloaded="no"> | |
781d2982 | 5988 | <autodoc>RemoveItem(self, MenuItem item) -> MenuItem</autodoc> |
f32fc4bc RD |
5989 | <paramlist> |
5990 | <param name="item" type="wxMenuItem" default=""/> | |
5991 | </paramlist> | |
5992 | </method> | |
5993 | <method name="Delete" type="bool" overloaded="no"> | |
781d2982 | 5994 | <autodoc>Delete(self, int id) -> bool</autodoc> |
f32fc4bc RD |
5995 | <paramlist> |
5996 | <param name="id" type="int" default=""/> | |
5997 | </paramlist> | |
5998 | </method> | |
5999 | <method name="DeleteItem" type="bool" overloaded="no"> | |
781d2982 | 6000 | <autodoc>DeleteItem(self, MenuItem item) -> bool</autodoc> |
f32fc4bc RD |
6001 | <paramlist> |
6002 | <param name="item" type="wxMenuItem" default=""/> | |
6003 | </paramlist> | |
6004 | </method> | |
6005 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 6006 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
6007 | <docstring>Deletes the C++ object this Python object is a proxy for.</docstring> |
6008 | </method> | |
6009 | <method name="DestroyId" type="bool" overloaded="no"> | |
781d2982 | 6010 | <autodoc>DestroyId(self, int id) -> bool</autodoc> |
f32fc4bc RD |
6011 | <docstring>Deletes the C++ object this Python object is a proxy for.</docstring> |
6012 | <paramlist> | |
6013 | <param name="id" type="int" default=""/> | |
6014 | </paramlist> | |
6015 | </method> | |
6016 | <method name="DestroyItem" type="bool" overloaded="no"> | |
781d2982 | 6017 | <autodoc>DestroyItem(self, MenuItem item) -> bool</autodoc> |
f32fc4bc RD |
6018 | <docstring>Deletes the C++ object this Python object is a proxy for.</docstring> |
6019 | <paramlist> | |
6020 | <param name="item" type="wxMenuItem" default=""/> | |
6021 | </paramlist> | |
6022 | </method> | |
6023 | <method name="GetMenuItemCount" type="size_t" overloaded="no"> | |
781d2982 | 6024 | <autodoc>GetMenuItemCount(self) -> size_t</autodoc> |
f32fc4bc RD |
6025 | </method> |
6026 | <method name="GetMenuItems" type="PyObject" overloaded="no"> | |
781d2982 | 6027 | <autodoc>GetMenuItems(self) -> PyObject</autodoc> |
f32fc4bc RD |
6028 | </method> |
6029 | <method name="FindItem" type="int" overloaded="no"> | |
781d2982 | 6030 | <autodoc>FindItem(self, String item) -> int</autodoc> |
f32fc4bc RD |
6031 | <paramlist> |
6032 | <param name="item" type="String" default=""/> | |
6033 | </paramlist> | |
6034 | </method> | |
6035 | <method name="FindItemById" type="wxMenuItem" overloaded="no"> | |
781d2982 | 6036 | <autodoc>FindItemById(self, int id) -> MenuItem</autodoc> |
f32fc4bc RD |
6037 | <paramlist> |
6038 | <param name="id" type="int" default=""/> | |
6039 | </paramlist> | |
6040 | </method> | |
6041 | <method name="FindItemByPosition" type="wxMenuItem" overloaded="no"> | |
781d2982 | 6042 | <autodoc>FindItemByPosition(self, size_t position) -> MenuItem</autodoc> |
f32fc4bc RD |
6043 | <paramlist> |
6044 | <param name="position" type="size_t" default=""/> | |
6045 | </paramlist> | |
6046 | </method> | |
6047 | <method name="Enable" type="" overloaded="no"> | |
781d2982 | 6048 | <autodoc>Enable(self, int id, bool enable)</autodoc> |
f32fc4bc RD |
6049 | <paramlist> |
6050 | <param name="id" type="int" default=""/> | |
6051 | <param name="enable" type="bool" default=""/> | |
6052 | </paramlist> | |
6053 | </method> | |
6054 | <method name="IsEnabled" type="bool" overloaded="no"> | |
781d2982 | 6055 | <autodoc>IsEnabled(self, int id) -> bool</autodoc> |
f32fc4bc RD |
6056 | <paramlist> |
6057 | <param name="id" type="int" default=""/> | |
6058 | </paramlist> | |
6059 | </method> | |
6060 | <method name="Check" type="" overloaded="no"> | |
781d2982 | 6061 | <autodoc>Check(self, int id, bool check)</autodoc> |
f32fc4bc RD |
6062 | <paramlist> |
6063 | <param name="id" type="int" default=""/> | |
6064 | <param name="check" type="bool" default=""/> | |
6065 | </paramlist> | |
6066 | </method> | |
6067 | <method name="IsChecked" type="bool" overloaded="no"> | |
781d2982 | 6068 | <autodoc>IsChecked(self, int id) -> bool</autodoc> |
f32fc4bc RD |
6069 | <paramlist> |
6070 | <param name="id" type="int" default=""/> | |
6071 | </paramlist> | |
6072 | </method> | |
6073 | <method name="SetLabel" type="" overloaded="no"> | |
781d2982 | 6074 | <autodoc>SetLabel(self, int id, String label)</autodoc> |
f32fc4bc RD |
6075 | <paramlist> |
6076 | <param name="id" type="int" default=""/> | |
6077 | <param name="label" type="String" default=""/> | |
6078 | </paramlist> | |
6079 | </method> | |
6080 | <method name="GetLabel" type="String" overloaded="no"> | |
781d2982 | 6081 | <autodoc>GetLabel(self, int id) -> String</autodoc> |
f32fc4bc RD |
6082 | <paramlist> |
6083 | <param name="id" type="int" default=""/> | |
6084 | </paramlist> | |
6085 | </method> | |
6086 | <method name="SetHelpString" type="" overloaded="no"> | |
781d2982 | 6087 | <autodoc>SetHelpString(self, int id, String helpString)</autodoc> |
f32fc4bc RD |
6088 | <paramlist> |
6089 | <param name="id" type="int" default=""/> | |
6090 | <param name="helpString" type="String" default=""/> | |
6091 | </paramlist> | |
6092 | </method> | |
6093 | <method name="GetHelpString" type="String" overloaded="no"> | |
781d2982 | 6094 | <autodoc>GetHelpString(self, int id) -> String</autodoc> |
f32fc4bc RD |
6095 | <paramlist> |
6096 | <param name="id" type="int" default=""/> | |
6097 | </paramlist> | |
6098 | </method> | |
6099 | <method name="SetTitle" type="" overloaded="no"> | |
781d2982 | 6100 | <autodoc>SetTitle(self, String title)</autodoc> |
f32fc4bc RD |
6101 | <paramlist> |
6102 | <param name="title" type="String" default=""/> | |
6103 | </paramlist> | |
6104 | </method> | |
6105 | <method name="GetTitle" type="String" overloaded="no"> | |
781d2982 | 6106 | <autodoc>GetTitle(self) -> String</autodoc> |
f32fc4bc RD |
6107 | </method> |
6108 | <method name="SetEventHandler" type="" overloaded="no"> | |
781d2982 | 6109 | <autodoc>SetEventHandler(self, EvtHandler handler)</autodoc> |
f32fc4bc RD |
6110 | <paramlist> |
6111 | <param name="handler" type="EvtHandler" default=""/> | |
6112 | </paramlist> | |
6113 | </method> | |
6114 | <method name="GetEventHandler" type="EvtHandler" overloaded="no"> | |
781d2982 | 6115 | <autodoc>GetEventHandler(self) -> EvtHandler</autodoc> |
f32fc4bc RD |
6116 | </method> |
6117 | <method name="SetInvokingWindow" type="" overloaded="no"> | |
781d2982 | 6118 | <autodoc>SetInvokingWindow(self, Window win)</autodoc> |
f32fc4bc RD |
6119 | <paramlist> |
6120 | <param name="win" type="Window" default=""/> | |
6121 | </paramlist> | |
6122 | </method> | |
6123 | <method name="GetInvokingWindow" type="Window" overloaded="no"> | |
781d2982 | 6124 | <autodoc>GetInvokingWindow(self) -> Window</autodoc> |
f32fc4bc RD |
6125 | </method> |
6126 | <method name="GetStyle" type="long" overloaded="no"> | |
781d2982 | 6127 | <autodoc>GetStyle(self) -> long</autodoc> |
f32fc4bc RD |
6128 | </method> |
6129 | <method name="UpdateUI" type="" overloaded="no"> | |
781d2982 | 6130 | <autodoc>UpdateUI(self, EvtHandler source=None)</autodoc> |
f32fc4bc RD |
6131 | <paramlist> |
6132 | <param name="source" type="EvtHandler" default="NULL"/> | |
6133 | </paramlist> | |
6134 | </method> | |
6135 | <method name="GetMenuBar" type="wxMenuBar" overloaded="no"> | |
781d2982 | 6136 | <autodoc>GetMenuBar(self) -> MenuBar</autodoc> |
f32fc4bc RD |
6137 | </method> |
6138 | <method name="Attach" type="" overloaded="no"> | |
781d2982 | 6139 | <autodoc>Attach(self, wxMenuBarBase menubar)</autodoc> |
f32fc4bc RD |
6140 | <paramlist> |
6141 | <param name="menubar" type="wxMenuBarBase" default=""/> | |
6142 | </paramlist> | |
6143 | </method> | |
6144 | <method name="Detach" type="" overloaded="no"> | |
781d2982 | 6145 | <autodoc>Detach(self)</autodoc> |
f32fc4bc RD |
6146 | </method> |
6147 | <method name="IsAttached" type="bool" overloaded="no"> | |
781d2982 | 6148 | <autodoc>IsAttached(self) -> bool</autodoc> |
f32fc4bc RD |
6149 | </method> |
6150 | <method name="SetParent" type="" overloaded="no"> | |
781d2982 | 6151 | <autodoc>SetParent(self, Menu parent)</autodoc> |
f32fc4bc RD |
6152 | <paramlist> |
6153 | <param name="parent" type="Menu" default=""/> | |
6154 | </paramlist> | |
6155 | </method> | |
6156 | <method name="GetParent" type="Menu" overloaded="no"> | |
781d2982 | 6157 | <autodoc>GetParent(self) -> Menu</autodoc> |
f32fc4bc RD |
6158 | </method> |
6159 | </class> | |
6160 | <pythoncode> | |
856bf319 RD |
6161 | #--------------------------------------------------------------------------- |
6162 | </pythoncode> | |
781d2982 | 6163 | <class name="MenuBar" oldname="wxMenuBar" module="_core"> |
f32fc4bc RD |
6164 | <baseclass name="Window"/> |
6165 | <constructor name="MenuBar" overloaded="no"> | |
781d2982 | 6166 | <autodoc>__init__(self, long style=0) -> MenuBar</autodoc> |
f32fc4bc RD |
6167 | <paramlist> |
6168 | <param name="style" type="long" default="0"/> | |
6169 | </paramlist> | |
6170 | </constructor> | |
6171 | <method name="Append" type="bool" overloaded="no"> | |
781d2982 | 6172 | <autodoc>Append(self, Menu menu, String title) -> bool</autodoc> |
f32fc4bc RD |
6173 | <paramlist> |
6174 | <param name="menu" type="Menu" default=""/> | |
6175 | <param name="title" type="String" default=""/> | |
6176 | </paramlist> | |
6177 | </method> | |
6178 | <method name="Insert" type="bool" overloaded="no"> | |
781d2982 | 6179 | <autodoc>Insert(self, size_t pos, Menu menu, String title) -> bool</autodoc> |
f32fc4bc RD |
6180 | <paramlist> |
6181 | <param name="pos" type="size_t" default=""/> | |
6182 | <param name="menu" type="Menu" default=""/> | |
6183 | <param name="title" type="String" default=""/> | |
6184 | </paramlist> | |
6185 | </method> | |
6186 | <method name="GetMenuCount" type="size_t" overloaded="no"> | |
781d2982 | 6187 | <autodoc>GetMenuCount(self) -> size_t</autodoc> |
f32fc4bc RD |
6188 | </method> |
6189 | <method name="GetMenu" type="Menu" overloaded="no"> | |
781d2982 | 6190 | <autodoc>GetMenu(self, size_t pos) -> Menu</autodoc> |
f32fc4bc RD |
6191 | <paramlist> |
6192 | <param name="pos" type="size_t" default=""/> | |
6193 | </paramlist> | |
6194 | </method> | |
6195 | <method name="Replace" type="Menu" overloaded="no"> | |
781d2982 | 6196 | <autodoc>Replace(self, size_t pos, Menu menu, String title) -> Menu</autodoc> |
f32fc4bc RD |
6197 | <paramlist> |
6198 | <param name="pos" type="size_t" default=""/> | |
6199 | <param name="menu" type="Menu" default=""/> | |
6200 | <param name="title" type="String" default=""/> | |
6201 | </paramlist> | |
6202 | </method> | |
6203 | <method name="Remove" type="Menu" overloaded="no"> | |
781d2982 | 6204 | <autodoc>Remove(self, size_t pos) -> Menu</autodoc> |
f32fc4bc RD |
6205 | <paramlist> |
6206 | <param name="pos" type="size_t" default=""/> | |
6207 | </paramlist> | |
6208 | </method> | |
6209 | <method name="EnableTop" type="" overloaded="no"> | |
781d2982 | 6210 | <autodoc>EnableTop(self, size_t pos, bool enable)</autodoc> |
f32fc4bc RD |
6211 | <paramlist> |
6212 | <param name="pos" type="size_t" default=""/> | |
6213 | <param name="enable" type="bool" default=""/> | |
6214 | </paramlist> | |
6215 | </method> | |
6216 | <method name="IsEnabledTop" type="bool" overloaded="no"> | |
781d2982 | 6217 | <autodoc>IsEnabledTop(self, size_t pos) -> bool</autodoc> |
f32fc4bc RD |
6218 | <paramlist> |
6219 | <param name="pos" type="size_t" default=""/> | |
6220 | </paramlist> | |
6221 | </method> | |
6222 | <method name="SetLabelTop" type="" overloaded="no"> | |
781d2982 | 6223 | <autodoc>SetLabelTop(self, size_t pos, String label)</autodoc> |
f32fc4bc RD |
6224 | <paramlist> |
6225 | <param name="pos" type="size_t" default=""/> | |
6226 | <param name="label" type="String" default=""/> | |
6227 | </paramlist> | |
6228 | </method> | |
6229 | <method name="GetLabelTop" type="String" overloaded="no"> | |
781d2982 | 6230 | <autodoc>GetLabelTop(self, size_t pos) -> String</autodoc> |
f32fc4bc RD |
6231 | <paramlist> |
6232 | <param name="pos" type="size_t" default=""/> | |
6233 | </paramlist> | |
6234 | </method> | |
6235 | <method name="FindMenuItem" type="int" overloaded="no"> | |
781d2982 | 6236 | <autodoc>FindMenuItem(self, String menu, String item) -> int</autodoc> |
f32fc4bc RD |
6237 | <paramlist> |
6238 | <param name="menu" type="String" default=""/> | |
6239 | <param name="item" type="String" default=""/> | |
6240 | </paramlist> | |
6241 | </method> | |
6242 | <method name="FindItemById" type="wxMenuItem" overloaded="no"> | |
781d2982 | 6243 | <autodoc>FindItemById(self, int id) -> MenuItem</autodoc> |
f32fc4bc RD |
6244 | <paramlist> |
6245 | <param name="id" type="int" default=""/> | |
6246 | </paramlist> | |
6247 | </method> | |
6248 | <method name="FindMenu" type="int" overloaded="no"> | |
781d2982 | 6249 | <autodoc>FindMenu(self, String title) -> int</autodoc> |
f32fc4bc RD |
6250 | <paramlist> |
6251 | <param name="title" type="String" default=""/> | |
6252 | </paramlist> | |
6253 | </method> | |
6254 | <method name="Enable" type="" overloaded="no"> | |
781d2982 | 6255 | <autodoc>Enable(self, int id, bool enable)</autodoc> |
f32fc4bc RD |
6256 | <paramlist> |
6257 | <param name="id" type="int" default=""/> | |
6258 | <param name="enable" type="bool" default=""/> | |
6259 | </paramlist> | |
6260 | </method> | |
6261 | <method name="Check" type="" overloaded="no"> | |
781d2982 | 6262 | <autodoc>Check(self, int id, bool check)</autodoc> |
f32fc4bc RD |
6263 | <paramlist> |
6264 | <param name="id" type="int" default=""/> | |
6265 | <param name="check" type="bool" default=""/> | |
6266 | </paramlist> | |
6267 | </method> | |
6268 | <method name="IsChecked" type="bool" overloaded="no"> | |
781d2982 | 6269 | <autodoc>IsChecked(self, int id) -> bool</autodoc> |
f32fc4bc RD |
6270 | <paramlist> |
6271 | <param name="id" type="int" default=""/> | |
6272 | </paramlist> | |
6273 | </method> | |
6274 | <method name="IsEnabled" type="bool" overloaded="no"> | |
781d2982 | 6275 | <autodoc>IsEnabled(self, int id) -> bool</autodoc> |
f32fc4bc RD |
6276 | <paramlist> |
6277 | <param name="id" type="int" default=""/> | |
6278 | </paramlist> | |
6279 | </method> | |
6280 | <method name="SetLabel" type="" overloaded="no"> | |
781d2982 | 6281 | <autodoc>SetLabel(self, int id, String label)</autodoc> |
f32fc4bc RD |
6282 | <paramlist> |
6283 | <param name="id" type="int" default=""/> | |
6284 | <param name="label" type="String" default=""/> | |
6285 | </paramlist> | |
6286 | </method> | |
6287 | <method name="GetLabel" type="String" overloaded="no"> | |
781d2982 | 6288 | <autodoc>GetLabel(self, int id) -> String</autodoc> |
f32fc4bc RD |
6289 | <paramlist> |
6290 | <param name="id" type="int" default=""/> | |
6291 | </paramlist> | |
6292 | </method> | |
6293 | <method name="SetHelpString" type="" overloaded="no"> | |
781d2982 | 6294 | <autodoc>SetHelpString(self, int id, String helpString)</autodoc> |
f32fc4bc RD |
6295 | <paramlist> |
6296 | <param name="id" type="int" default=""/> | |
6297 | <param name="helpString" type="String" default=""/> | |
6298 | </paramlist> | |
6299 | </method> | |
6300 | <method name="GetHelpString" type="String" overloaded="no"> | |
781d2982 | 6301 | <autodoc>GetHelpString(self, int id) -> String</autodoc> |
f32fc4bc RD |
6302 | <paramlist> |
6303 | <param name="id" type="int" default=""/> | |
6304 | </paramlist> | |
6305 | </method> | |
6306 | <method name="GetFrame" type="wxFrame" overloaded="no"> | |
781d2982 | 6307 | <autodoc>GetFrame(self) -> wxFrame</autodoc> |
f32fc4bc RD |
6308 | </method> |
6309 | <method name="IsAttached" type="bool" overloaded="no"> | |
781d2982 | 6310 | <autodoc>IsAttached(self) -> bool</autodoc> |
f32fc4bc RD |
6311 | </method> |
6312 | <method name="Attach" type="" overloaded="no"> | |
781d2982 | 6313 | <autodoc>Attach(self, wxFrame frame)</autodoc> |
f32fc4bc RD |
6314 | <paramlist> |
6315 | <param name="frame" type="wxFrame" default=""/> | |
6316 | </paramlist> | |
6317 | </method> | |
6318 | <method name="Detach" type="" overloaded="no"> | |
781d2982 | 6319 | <autodoc>Detach(self)</autodoc> |
f32fc4bc RD |
6320 | </method> |
6321 | </class> | |
6322 | <pythoncode> | |
856bf319 RD |
6323 | #--------------------------------------------------------------------------- |
6324 | </pythoncode> | |
781d2982 | 6325 | <class name="MenuItem" oldname="wxMenuItem" module="_core"> |
f32fc4bc RD |
6326 | <baseclass name="Object"/> |
6327 | <constructor name="MenuItem" overloaded="no"> | |
781d2982 | 6328 | <autodoc>__init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString, |
856bf319 RD |
6329 | String help=EmptyString, int kind=ITEM_NORMAL, |
6330 | Menu subMenu=None) -> MenuItem</autodoc> | |
f32fc4bc RD |
6331 | <paramlist> |
6332 | <param name="parentMenu" type="Menu" default="NULL"/> | |
781d2982 | 6333 | <param name="id" type="int" default="wxID_ANY"/> |
f32fc4bc RD |
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"/> | |
6338 | </paramlist> | |
6339 | </constructor> | |
6340 | <method name="GetMenu" type="Menu" overloaded="no"> | |
781d2982 | 6341 | <autodoc>GetMenu(self) -> Menu</autodoc> |
f32fc4bc RD |
6342 | </method> |
6343 | <method name="SetMenu" type="" overloaded="no"> | |
781d2982 | 6344 | <autodoc>SetMenu(self, Menu menu)</autodoc> |
f32fc4bc RD |
6345 | <paramlist> |
6346 | <param name="menu" type="Menu" default=""/> | |
6347 | </paramlist> | |
6348 | </method> | |
6349 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 6350 | <autodoc>SetId(self, int id)</autodoc> |
f32fc4bc RD |
6351 | <paramlist> |
6352 | <param name="id" type="int" default=""/> | |
6353 | </paramlist> | |
6354 | </method> | |
6355 | <method name="GetId" type="int" overloaded="no"> | |
781d2982 | 6356 | <autodoc>GetId(self) -> int</autodoc> |
f32fc4bc RD |
6357 | </method> |
6358 | <method name="IsSeparator" type="bool" overloaded="no"> | |
781d2982 | 6359 | <autodoc>IsSeparator(self) -> bool</autodoc> |
f32fc4bc RD |
6360 | </method> |
6361 | <method name="SetText" type="" overloaded="no"> | |
781d2982 | 6362 | <autodoc>SetText(self, String str)</autodoc> |
f32fc4bc RD |
6363 | <paramlist> |
6364 | <param name="str" type="String" default=""/> | |
6365 | </paramlist> | |
6366 | </method> | |
6367 | <method name="GetLabel" type="String" overloaded="no"> | |
781d2982 | 6368 | <autodoc>GetLabel(self) -> String</autodoc> |
f32fc4bc RD |
6369 | </method> |
6370 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 6371 | <autodoc>GetText(self) -> String</autodoc> |
f32fc4bc RD |
6372 | </method> |
6373 | <staticmethod name="GetLabelFromText" type="String" overloaded="no"> | |
6374 | <autodoc>GetLabelFromText(String text) -> String</autodoc> | |
6375 | <paramlist> | |
6376 | <param name="text" type="String" default=""/> | |
6377 | </paramlist> | |
6378 | </staticmethod> | |
6379 | <method name="GetKind" type="wxItemKind" overloaded="no"> | |
781d2982 RD |
6380 | <autodoc>GetKind(self) -> int</autodoc> |
6381 | </method> | |
6382 | <method name="SetKind" type="" overloaded="no"> | |
6383 | <autodoc>SetKind(self, int kind)</autodoc> | |
6384 | <paramlist> | |
6385 | <param name="kind" type="wxItemKind" default=""/> | |
6386 | </paramlist> | |
f32fc4bc RD |
6387 | </method> |
6388 | <method name="SetCheckable" type="" overloaded="no"> | |
781d2982 | 6389 | <autodoc>SetCheckable(self, bool checkable)</autodoc> |
f32fc4bc RD |
6390 | <paramlist> |
6391 | <param name="checkable" type="bool" default=""/> | |
6392 | </paramlist> | |
6393 | </method> | |
6394 | <method name="IsCheckable" type="bool" overloaded="no"> | |
781d2982 | 6395 | <autodoc>IsCheckable(self) -> bool</autodoc> |
f32fc4bc RD |
6396 | </method> |
6397 | <method name="IsSubMenu" type="bool" overloaded="no"> | |
781d2982 | 6398 | <autodoc>IsSubMenu(self) -> bool</autodoc> |
f32fc4bc RD |
6399 | </method> |
6400 | <method name="SetSubMenu" type="" overloaded="no"> | |
781d2982 | 6401 | <autodoc>SetSubMenu(self, Menu menu)</autodoc> |
f32fc4bc RD |
6402 | <paramlist> |
6403 | <param name="menu" type="Menu" default=""/> | |
6404 | </paramlist> | |
6405 | </method> | |
6406 | <method name="GetSubMenu" type="Menu" overloaded="no"> | |
781d2982 | 6407 | <autodoc>GetSubMenu(self) -> Menu</autodoc> |
f32fc4bc RD |
6408 | </method> |
6409 | <method name="Enable" type="" overloaded="no"> | |
781d2982 | 6410 | <autodoc>Enable(self, bool enable=True)</autodoc> |
f32fc4bc RD |
6411 | <paramlist> |
6412 | <param name="enable" type="bool" default="True"/> | |
6413 | </paramlist> | |
6414 | </method> | |
6415 | <method name="IsEnabled" type="bool" overloaded="no"> | |
781d2982 | 6416 | <autodoc>IsEnabled(self) -> bool</autodoc> |
f32fc4bc RD |
6417 | </method> |
6418 | <method name="Check" type="" overloaded="no"> | |
781d2982 | 6419 | <autodoc>Check(self, bool check=True)</autodoc> |
f32fc4bc RD |
6420 | <paramlist> |
6421 | <param name="check" type="bool" default="True"/> | |
6422 | </paramlist> | |
6423 | </method> | |
6424 | <method name="IsChecked" type="bool" overloaded="no"> | |
781d2982 | 6425 | <autodoc>IsChecked(self) -> bool</autodoc> |
f32fc4bc RD |
6426 | </method> |
6427 | <method name="Toggle" type="" overloaded="no"> | |
781d2982 | 6428 | <autodoc>Toggle(self)</autodoc> |
f32fc4bc RD |
6429 | </method> |
6430 | <method name="SetHelp" type="" overloaded="no"> | |
781d2982 | 6431 | <autodoc>SetHelp(self, String str)</autodoc> |
f32fc4bc RD |
6432 | <paramlist> |
6433 | <param name="str" type="String" default=""/> | |
6434 | </paramlist> | |
6435 | </method> | |
6436 | <method name="GetHelp" type="String" overloaded="no"> | |
781d2982 | 6437 | <autodoc>GetHelp(self) -> String</autodoc> |
f32fc4bc RD |
6438 | </method> |
6439 | <method name="GetAccel" type="AcceleratorEntry" overloaded="no"> | |
781d2982 | 6440 | <autodoc>GetAccel(self) -> AcceleratorEntry</autodoc> |
f32fc4bc RD |
6441 | </method> |
6442 | <method name="SetAccel" type="" overloaded="no"> | |
781d2982 | 6443 | <autodoc>SetAccel(self, AcceleratorEntry accel)</autodoc> |
f32fc4bc RD |
6444 | <paramlist> |
6445 | <param name="accel" type="AcceleratorEntry" default=""/> | |
6446 | </paramlist> | |
6447 | </method> | |
6448 | <staticmethod name="GetDefaultMarginWidth" type="int" overloaded="no"> | |
6449 | <autodoc>GetDefaultMarginWidth() -> int</autodoc> | |
6450 | </staticmethod> | |
6451 | <method name="SetBitmap" type="" overloaded="no"> | |
781d2982 | 6452 | <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc> |
f32fc4bc RD |
6453 | <paramlist> |
6454 | <param name="bitmap" type="wxBitmap" default=""/> | |
6455 | </paramlist> | |
6456 | </method> | |
6457 | <method name="GetBitmap" type="wxBitmap" overloaded="no"> | |
781d2982 | 6458 | <autodoc>GetBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
6459 | </method> |
6460 | </class> | |
6461 | <pythoncode> | |
0f43fbdf RD |
6462 | #--------------------------------------------------------------------------- |
6463 | </pythoncode> | |
781d2982 | 6464 | <class name="Control" oldname="wxControl" module="_core"> |
c2dda882 RD |
6465 | <docstring>This is the base class for a control or 'widget'. |
6466 | ||
781d2982 RD |
6467 | A control is generally a small window which processes user input |
6468 | and/or displays one or more item of data.</docstring> | |
f32fc4bc RD |
6469 | <baseclass name="Window"/> |
6470 | <constructor name="Control" overloaded="no"> | |
781d2982 RD |
6471 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
6472 | Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, | |
0f43fbdf | 6473 | String name=ControlNameStr) -> Control</autodoc> |
781d2982 RD |
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> | |
f32fc4bc RD |
6476 | <paramlist> |
6477 | <param name="parent" type="Window" default=""/> | |
781d2982 | 6478 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
6484 | </paramlist> | |
6485 | </constructor> | |
6486 | <constructor name="PreControl" overloaded="no"> | |
6487 | <autodoc>PreControl() -> Control</autodoc> | |
c2dda882 | 6488 | <docstring>Precreate a Control control for 2-phase creation</docstring> |
f32fc4bc RD |
6489 | </constructor> |
6490 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
6491 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
6492 | Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, | |
0f43fbdf | 6493 | String name=ControlNameStr) -> bool</autodoc> |
c2dda882 | 6494 | <docstring>Do the 2nd phase and create the GUI control.</docstring> |
f32fc4bc RD |
6495 | <paramlist> |
6496 | <param name="parent" type="Window" default=""/> | |
781d2982 | 6497 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
6503 | </paramlist> | |
6504 | </method> | |
6505 | <method name="Command" type="" overloaded="no"> | |
781d2982 RD |
6506 | <autodoc>Command(self, CommandEvent event)</autodoc> |
6507 | <docstring>Simulates the effect of the user issuing a command to the item. | |
6508 | ||
6509 | :see: `wx.CommandEvent` | |
6510 | </docstring> | |
f32fc4bc RD |
6511 | <paramlist> |
6512 | <param name="event" type="CommandEvent" default=""/> | |
6513 | </paramlist> | |
6514 | </method> | |
6515 | <method name="GetLabel" type="String" overloaded="no"> | |
781d2982 | 6516 | <autodoc>GetLabel(self) -> String</autodoc> |
c2dda882 | 6517 | <docstring>Return a control's text.</docstring> |
f32fc4bc RD |
6518 | </method> |
6519 | <method name="SetLabel" type="" overloaded="no"> | |
781d2982 | 6520 | <autodoc>SetLabel(self, String label)</autodoc> |
c2dda882 | 6521 | <docstring>Sets the item's text.</docstring> |
f32fc4bc RD |
6522 | <paramlist> |
6523 | <param name="label" type="String" default=""/> | |
6524 | </paramlist> | |
6525 | </method> | |
781d2982 RD |
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. | |
6533 | ||
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 | |
6537 | this.</docstring> | |
6538 | <paramlist> | |
6539 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
6540 | </paramlist> | |
6541 | </staticmethod> | |
f32fc4bc RD |
6542 | </class> |
6543 | <pythoncode> | |
0f43fbdf RD |
6544 | #--------------------------------------------------------------------------- |
6545 | </pythoncode> | |
781d2982 | 6546 | <class name="ItemContainer" oldname="wxItemContainer" module="_core"> |
c2dda882 | 6547 | <docstring>wx.ItemContainer defines an interface which is implemented by all |
781d2982 RD |
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 | |
6551 | this one. | |
c2dda882 | 6552 | |
781d2982 RD |
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. | |
c2dda882 | 6556 | |
781d2982 RD |
6557 | The items in a wx.ItemContainer have (non empty) string labels and, |
6558 | optionally, client data associated with them. | |
c2dda882 | 6559 | </docstring> |
f32fc4bc | 6560 | <method name="Append" type="int" overloaded="no"> |
781d2982 RD |
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> | |
f32fc4bc RD |
6566 | <paramlist> |
6567 | <param name="item" type="String" default=""/> | |
6568 | <param name="clientData" type="PyObject" default="NULL"/> | |
6569 | </paramlist> | |
6570 | </method> | |
6571 | <method name="AppendItems" type="" overloaded="no"> | |
ce6878e6 | 6572 | <autodoc>AppendItems(self, List strings)</autodoc> |
781d2982 RD |
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> | |
f32fc4bc RD |
6576 | <paramlist> |
6577 | <param name="strings" type="wxArrayString" default=""/> | |
6578 | </paramlist> | |
6579 | </method> | |
6580 | <method name="Insert" type="int" overloaded="no"> | |
781d2982 RD |
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, | |
c2dda882 | 6583 | optionally associating some data object with the item.</docstring> |
f32fc4bc RD |
6584 | <paramlist> |
6585 | <param name="item" type="String" default=""/> | |
6586 | <param name="pos" type="int" default=""/> | |
6587 | <param name="clientData" type="PyObject" default="NULL"/> | |
6588 | </paramlist> | |
6589 | </method> | |
6590 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 6591 | <autodoc>Clear(self)</autodoc> |
c2dda882 | 6592 | <docstring>Removes all items from the control.</docstring> |
f32fc4bc RD |
6593 | </method> |
6594 | <method name="Delete" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
6600 | <paramlist> |
6601 | <param name="n" type="int" default=""/> | |
6602 | </paramlist> | |
6603 | </method> | |
6604 | <method name="GetCount" type="int" overloaded="no"> | |
781d2982 | 6605 | <autodoc>GetCount(self) -> int</autodoc> |
c2dda882 | 6606 | <docstring>Returns the number of items in the control.</docstring> |
f32fc4bc RD |
6607 | </method> |
6608 | <method name="IsEmpty" type="bool" overloaded="no"> | |
781d2982 | 6609 | <autodoc>IsEmpty(self) -> bool</autodoc> |
c2dda882 | 6610 | <docstring>Returns True if the control is empty or False if it has some items.</docstring> |
f32fc4bc RD |
6611 | </method> |
6612 | <method name="GetString" type="String" overloaded="no"> | |
781d2982 | 6613 | <autodoc>GetString(self, int n) -> String</autodoc> |
c2dda882 | 6614 | <docstring>Returns the label of the item with the given index.</docstring> |
f32fc4bc RD |
6615 | <paramlist> |
6616 | <param name="n" type="int" default=""/> | |
6617 | </paramlist> | |
6618 | </method> | |
6619 | <method name="GetStrings" type="wxArrayString" overloaded="no"> | |
781d2982 | 6620 | <autodoc>GetStrings(self) -> wxArrayString</autodoc> |
f32fc4bc RD |
6621 | </method> |
6622 | <method name="SetString" type="" overloaded="no"> | |
781d2982 | 6623 | <autodoc>SetString(self, int n, String s)</autodoc> |
c2dda882 | 6624 | <docstring>Sets the label for the given item.</docstring> |
f32fc4bc RD |
6625 | <paramlist> |
6626 | <param name="n" type="int" default=""/> | |
6627 | <param name="s" type="String" default=""/> | |
6628 | </paramlist> | |
6629 | </method> | |
6630 | <method name="FindString" type="int" overloaded="no"> | |
781d2982 | 6631 | <autodoc>FindString(self, String s) -> int</autodoc> |
c2dda882 | 6632 | <docstring>Finds an item whose label matches the given string. Returns the |
781d2982 RD |
6633 | zero-based position of the item, or ``wx.NOT_FOUND`` if the string was not |
6634 | found.</docstring> | |
f32fc4bc RD |
6635 | <paramlist> |
6636 | <param name="s" type="String" default=""/> | |
6637 | </paramlist> | |
6638 | </method> | |
6639 | <method name="Select" type="" overloaded="no"> | |
781d2982 | 6640 | <autodoc>Select(self, int n)</autodoc> |
c2dda882 | 6641 | <docstring>Sets the item at index 'n' to be the selected item.</docstring> |
f32fc4bc RD |
6642 | <paramlist> |
6643 | <param name="n" type="int" default=""/> | |
6644 | </paramlist> | |
6645 | </method> | |
6646 | <method name="GetSelection" type="int" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
6650 | </method> |
6651 | <method name="GetStringSelection" type="String" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
6655 | </method> |
6656 | <method name="GetClientData" type="PyObject" overloaded="no"> | |
781d2982 | 6657 | <autodoc>GetClientData(self, int n) -> PyObject</autodoc> |
c2dda882 | 6658 | <docstring>Returns the client data associated with the given item, (if any.)</docstring> |
f32fc4bc RD |
6659 | <paramlist> |
6660 | <param name="n" type="int" default=""/> | |
6661 | </paramlist> | |
6662 | </method> | |
6663 | <method name="SetClientData" type="" overloaded="no"> | |
781d2982 | 6664 | <autodoc>SetClientData(self, int n, PyObject clientData)</autodoc> |
c2dda882 | 6665 | <docstring>Associate the given client data with the item at position n.</docstring> |
f32fc4bc RD |
6666 | <paramlist> |
6667 | <param name="n" type="int" default=""/> | |
6668 | <param name="clientData" type="PyObject" default=""/> | |
6669 | </paramlist> | |
6670 | </method> | |
6671 | </class> | |
6672 | <pythoncode> | |
0f43fbdf RD |
6673 | #--------------------------------------------------------------------------- |
6674 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc RD |
6679 | <baseclass name="Control"/> |
6680 | <baseclass name="ItemContainer"/> | |
6681 | </class> | |
6682 | <pythoncode> | |
0f43fbdf RD |
6683 | #--------------------------------------------------------------------------- |
6684 | </pythoncode> | |
781d2982 RD |
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. | |
6691 | ||
6692 | :see: `wx.Sizer`, `wx.GBSizerItem`</docstring> | |
f32fc4bc RD |
6693 | <baseclass name="Object"/> |
6694 | <constructor name="SizerItem" overloaded="no"> | |
781d2982 RD |
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. | |
6698 | ||
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 | |
6701 | methods are called. | |
6702 | ||
6703 | :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`</docstring> | |
f32fc4bc | 6704 | </constructor> |
781d2982 RD |
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> | |
f32fc4bc | 6709 | <paramlist> |
781d2982 | 6710 | <param name="window" type="Window" default=""/> |
f32fc4bc RD |
6711 | <param name="proportion" type="int" default=""/> |
6712 | <param name="flag" type="int" default=""/> | |
6713 | <param name="border" type="int" default=""/> | |
781d2982 | 6714 | <param name="userData" type="PyObject" default="NULL"/> |
f32fc4bc RD |
6715 | </paramlist> |
6716 | </constructor> | |
781d2982 RD |
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> | |
f32fc4bc | 6721 | <paramlist> |
781d2982 RD |
6722 | <param name="width" type="int" default=""/> |
6723 | <param name="height" type="int" default=""/> | |
f32fc4bc RD |
6724 | <param name="proportion" type="int" default=""/> |
6725 | <param name="flag" type="int" default=""/> | |
6726 | <param name="border" type="int" default=""/> | |
781d2982 | 6727 | <param name="userData" type="PyObject" default="NULL"/> |
f32fc4bc RD |
6728 | </paramlist> |
6729 | </constructor> | |
6730 | <constructor name="SizerItemSizer" overloaded="no"> | |
6731 | <autodoc>SizerItemSizer(Sizer sizer, int proportion, int flag, int border, | |
781d2982 RD |
6732 | PyObject userData=None) -> SizerItem</autodoc> |
6733 | <docstring>Constructs a `wx.SizerItem` for tracking a subsizer</docstring> | |
f32fc4bc RD |
6734 | <paramlist> |
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=""/> | |
781d2982 | 6739 | <param name="userData" type="PyObject" default="NULL"/> |
f32fc4bc RD |
6740 | </paramlist> |
6741 | </constructor> | |
6742 | <method name="DeleteWindows" type="" overloaded="no"> | |
781d2982 RD |
6743 | <autodoc>DeleteWindows(self)</autodoc> |
6744 | <docstring>Destroy the window or the windows in a subsizer, depending on the type | |
6745 | of item.</docstring> | |
f32fc4bc RD |
6746 | </method> |
6747 | <method name="DetachSizer" type="" overloaded="no"> | |
781d2982 RD |
6748 | <autodoc>DetachSizer(self)</autodoc> |
6749 | <docstring>Enable deleting the SizerItem without destroying the contained sizer.</docstring> | |
f32fc4bc RD |
6750 | </method> |
6751 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 RD |
6752 | <autodoc>GetSize(self) -> Size</autodoc> |
6753 | <docstring>Get the current size of the item, as set in the last Layout.</docstring> | |
f32fc4bc RD |
6754 | </method> |
6755 | <method name="CalcMin" type="Size" overloaded="no"> | |
781d2982 RD |
6756 | <autodoc>CalcMin(self) -> Size</autodoc> |
6757 | <docstring>Calculates the minimum desired size for the item, including any space | |
6758 | needed by borders.</docstring> | |
f32fc4bc RD |
6759 | </method> |
6760 | <method name="SetDimension" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
6766 | <paramlist> |
6767 | <param name="pos" type="Point" default=""/> | |
6768 | <param name="size" type="Size" default=""/> | |
6769 | </paramlist> | |
6770 | </method> | |
6771 | <method name="GetMinSize" type="Size" overloaded="no"> | |
781d2982 RD |
6772 | <autodoc>GetMinSize(self) -> Size</autodoc> |
6773 | <docstring>Get the minimum size needed for the item.</docstring> | |
f32fc4bc | 6774 | </method> |
ce6878e6 RD |
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> | |
6779 | </method> | |
f32fc4bc | 6780 | <method name="SetInitSize" type="" overloaded="no"> |
781d2982 | 6781 | <autodoc>SetInitSize(self, int x, int y)</autodoc> |
f32fc4bc RD |
6782 | <paramlist> |
6783 | <param name="x" type="int" default=""/> | |
6784 | <param name="y" type="int" default=""/> | |
6785 | </paramlist> | |
6786 | </method> | |
6787 | <method name="SetRatioWH" type="" overloaded="no"> | |
781d2982 RD |
6788 | <autodoc>SetRatioWH(self, int width, int height)</autodoc> |
6789 | <docstring>Set the ratio item attribute.</docstring> | |
f32fc4bc RD |
6790 | <paramlist> |
6791 | <param name="width" type="int" default=""/> | |
6792 | <param name="height" type="int" default=""/> | |
6793 | </paramlist> | |
6794 | </method> | |
6795 | <method name="SetRatioSize" type="" overloaded="no"> | |
781d2982 RD |
6796 | <autodoc>SetRatioSize(self, Size size)</autodoc> |
6797 | <docstring>Set the ratio item attribute.</docstring> | |
f32fc4bc RD |
6798 | <paramlist> |
6799 | <param name="size" type="Size" default=""/> | |
6800 | </paramlist> | |
6801 | </method> | |
6802 | <method name="SetRatio" type="" overloaded="no"> | |
781d2982 RD |
6803 | <autodoc>SetRatio(self, float ratio)</autodoc> |
6804 | <docstring>Set the ratio item attribute.</docstring> | |
f32fc4bc RD |
6805 | <paramlist> |
6806 | <param name="ratio" type="float" default=""/> | |
6807 | </paramlist> | |
6808 | </method> | |
6809 | <method name="GetRatio" type="float" overloaded="no"> | |
781d2982 RD |
6810 | <autodoc>GetRatio(self) -> float</autodoc> |
6811 | <docstring>Set the ratio item attribute.</docstring> | |
f32fc4bc RD |
6812 | </method> |
6813 | <method name="IsWindow" type="bool" overloaded="no"> | |
781d2982 RD |
6814 | <autodoc>IsWindow(self) -> bool</autodoc> |
6815 | <docstring>Is this sizer item a window?</docstring> | |
f32fc4bc RD |
6816 | </method> |
6817 | <method name="IsSizer" type="bool" overloaded="no"> | |
781d2982 RD |
6818 | <autodoc>IsSizer(self) -> bool</autodoc> |
6819 | <docstring>Is this sizer item a subsizer?</docstring> | |
f32fc4bc RD |
6820 | </method> |
6821 | <method name="IsSpacer" type="bool" overloaded="no"> | |
781d2982 RD |
6822 | <autodoc>IsSpacer(self) -> bool</autodoc> |
6823 | <docstring>Is this sizer item a spacer?</docstring> | |
f32fc4bc RD |
6824 | </method> |
6825 | <method name="SetProportion" type="" overloaded="no"> | |
781d2982 RD |
6826 | <autodoc>SetProportion(self, int proportion)</autodoc> |
6827 | <docstring>Set the proportion value for this item.</docstring> | |
f32fc4bc RD |
6828 | <paramlist> |
6829 | <param name="proportion" type="int" default=""/> | |
6830 | </paramlist> | |
6831 | </method> | |
6832 | <method name="GetProportion" type="int" overloaded="no"> | |
781d2982 RD |
6833 | <autodoc>GetProportion(self) -> int</autodoc> |
6834 | <docstring>Get the proportion value for this item.</docstring> | |
f32fc4bc RD |
6835 | </method> |
6836 | <method name="SetFlag" type="" overloaded="no"> | |
781d2982 RD |
6837 | <autodoc>SetFlag(self, int flag)</autodoc> |
6838 | <docstring>Set the flag value for this item.</docstring> | |
f32fc4bc RD |
6839 | <paramlist> |
6840 | <param name="flag" type="int" default=""/> | |
6841 | </paramlist> | |
6842 | </method> | |
6843 | <method name="GetFlag" type="int" overloaded="no"> | |
781d2982 RD |
6844 | <autodoc>GetFlag(self) -> int</autodoc> |
6845 | <docstring>Get the flag value for this item.</docstring> | |
f32fc4bc RD |
6846 | </method> |
6847 | <method name="SetBorder" type="" overloaded="no"> | |
781d2982 RD |
6848 | <autodoc>SetBorder(self, int border)</autodoc> |
6849 | <docstring>Set the border value for this item.</docstring> | |
f32fc4bc RD |
6850 | <paramlist> |
6851 | <param name="border" type="int" default=""/> | |
6852 | </paramlist> | |
6853 | </method> | |
6854 | <method name="GetBorder" type="int" overloaded="no"> | |
781d2982 RD |
6855 | <autodoc>GetBorder(self) -> int</autodoc> |
6856 | <docstring>Get the border value for this item.</docstring> | |
f32fc4bc RD |
6857 | </method> |
6858 | <method name="GetWindow" type="Window" overloaded="no"> | |
781d2982 RD |
6859 | <autodoc>GetWindow(self) -> Window</autodoc> |
6860 | <docstring>Get the window (if any) that is managed by this sizer item.</docstring> | |
f32fc4bc RD |
6861 | </method> |
6862 | <method name="SetWindow" type="" overloaded="no"> | |
781d2982 RD |
6863 | <autodoc>SetWindow(self, Window window)</autodoc> |
6864 | <docstring>Set the window to be managed by this sizer item.</docstring> | |
f32fc4bc RD |
6865 | <paramlist> |
6866 | <param name="window" type="Window" default=""/> | |
6867 | </paramlist> | |
6868 | </method> | |
6869 | <method name="GetSizer" type="wxSizer" overloaded="no"> | |
781d2982 RD |
6870 | <autodoc>GetSizer(self) -> Sizer</autodoc> |
6871 | <docstring>Get the subsizer (if any) that is managed by this sizer item.</docstring> | |
f32fc4bc RD |
6872 | </method> |
6873 | <method name="SetSizer" type="" overloaded="no"> | |
781d2982 RD |
6874 | <autodoc>SetSizer(self, Sizer sizer)</autodoc> |
6875 | <docstring>Set the subsizer to be managed by this sizer item.</docstring> | |
f32fc4bc RD |
6876 | <paramlist> |
6877 | <param name="sizer" type="wxSizer" default=""/> | |
6878 | </paramlist> | |
6879 | </method> | |
6880 | <method name="GetSpacer" type="Size" overloaded="no"> | |
781d2982 RD |
6881 | <autodoc>GetSpacer(self) -> Size</autodoc> |
6882 | <docstring>Get the size of the spacer managed by this sizer item.</docstring> | |
f32fc4bc RD |
6883 | </method> |
6884 | <method name="SetSpacer" type="" overloaded="no"> | |
781d2982 RD |
6885 | <autodoc>SetSpacer(self, Size size)</autodoc> |
6886 | <docstring>Set the size of the spacer to be managed by this sizer item.</docstring> | |
f32fc4bc RD |
6887 | <paramlist> |
6888 | <param name="size" type="Size" default=""/> | |
6889 | </paramlist> | |
6890 | </method> | |
6891 | <method name="Show" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
6896 | <paramlist> |
6897 | <param name="show" type="bool" default=""/> | |
6898 | </paramlist> | |
6899 | </method> | |
6900 | <method name="IsShown" type="bool" overloaded="no"> | |
781d2982 RD |
6901 | <autodoc>IsShown(self) -> bool</autodoc> |
6902 | <docstring>Is the item to be shown in the layout?</docstring> | |
f32fc4bc RD |
6903 | </method> |
6904 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 RD |
6905 | <autodoc>GetPosition(self) -> Point</autodoc> |
6906 | <docstring>Returns the current position of the item, as set in the last Layout.</docstring> | |
f32fc4bc RD |
6907 | </method> |
6908 | <method name="GetUserData" type="PyObject" overloaded="no"> | |
781d2982 RD |
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> | |
6912 | </method> | |
6913 | </class> | |
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`. | |
6920 | ||
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. | |
6934 | ||
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 | |
ce6878e6 RD |
6941 | sizer will automatically be bigger on Mac than on Windows. |
6942 | ||
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. | |
6946 | ||
6947 | :see: `wx.SizerItem` | |
6948 | ||
6949 | :todo: More dscriptive text here along with some pictures... | |
6950 | ||
6951 | </docstring> | |
f32fc4bc RD |
6952 | <baseclass name="Object"/> |
6953 | <method name="_setOORInfo" type="" overloaded="no"> | |
781d2982 | 6954 | <autodoc>_setOORInfo(self, PyObject _self)</autodoc> |
f32fc4bc RD |
6955 | <paramlist> |
6956 | <param name="_self" type="PyObject" default=""/> | |
6957 | </paramlist> | |
6958 | </method> | |
6959 | <method name="Add" type="" overloaded="no"> | |
781d2982 | 6960 | <autodoc>Add(self, item, int proportion=0, int flag=0, int border=0, |
0f43fbdf | 6961 | PyObject userData=None)</autodoc> |
ce6878e6 RD |
6962 | <docstring>Appends a child item to the sizer. |
6963 | ||
6964 | :param item: The item can be one of three kinds of objects: | |
6965 | ||
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`. | |
6972 | ||
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). | |
6977 | ||
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 | |
6988 | the dialog. | |
6989 | ||
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. | |
7004 | ||
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. | |
7014 | ||
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. | | |
7019 | |- wx.RIGHT | | | |
7020 | |- wx.ALL | | | |
7021 | | | | | |
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 | | |
7028 | | |aspect ratio | | |
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 | +----------------------------+------------------------------------------+ | |
7049 | ||
7050 | ||
7051 | :param border: Determines the border width, if the *flag* | |
7052 | parameter is set to include any border flag. | |
7053 | ||
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. | |
7057 | </docstring> | |
f32fc4bc RD |
7058 | <paramlist> |
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"/> | |
7064 | </paramlist> | |
7065 | </method> | |
7066 | <method name="Insert" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7071 | <paramlist> |
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"/> | |
7078 | </paramlist> | |
7079 | </method> | |
7080 | <method name="Prepend" type="" overloaded="no"> | |
781d2982 | 7081 | <autodoc>Prepend(self, item, int proportion=0, int flag=0, int border=0, |
0f43fbdf | 7082 | PyObject userData=None)</autodoc> |
781d2982 RD |
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> | |
f32fc4bc RD |
7085 | <paramlist> |
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"/> | |
7091 | </paramlist> | |
7092 | </method> | |
7093 | <method name="Remove" type="bool" overloaded="no"> | |
781d2982 RD |
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 | |
ce6878e6 RD |
7100 | and removed. |
7101 | ||
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` | |
7105 | instead. | |
7106 | </docstring> | |
781d2982 RD |
7107 | <paramlist> |
7108 | <param name="item" type="PyObject" default=""/> | |
7109 | </paramlist> | |
7110 | </method> | |
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> | |
f32fc4bc RD |
7118 | <paramlist> |
7119 | <param name="item" type="PyObject" default=""/> | |
7120 | </paramlist> | |
7121 | </method> | |
7122 | <method name="_SetItemMinSize" type="" overloaded="no"> | |
781d2982 | 7123 | <autodoc>_SetItemMinSize(self, PyObject item, Size size)</autodoc> |
f32fc4bc RD |
7124 | <paramlist> |
7125 | <param name="item" type="PyObject" default=""/> | |
7126 | <param name="size" type="Size" default=""/> | |
7127 | </paramlist> | |
7128 | </method> | |
7129 | <method name="AddItem" type="" overloaded="no"> | |
781d2982 RD |
7130 | <autodoc>AddItem(self, SizerItem item)</autodoc> |
7131 | <docstring>Adds a `wx.SizerItem` to the sizer.</docstring> | |
f32fc4bc RD |
7132 | <paramlist> |
7133 | <param name="item" type="SizerItem" default=""/> | |
7134 | </paramlist> | |
7135 | </method> | |
7136 | <method name="InsertItem" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7139 | <paramlist> |
7140 | <param name="index" type="size_t" default=""/> | |
7141 | <param name="item" type="SizerItem" default=""/> | |
7142 | </paramlist> | |
7143 | </method> | |
7144 | <method name="PrependItem" type="" overloaded="no"> | |
781d2982 RD |
7145 | <autodoc>PrependItem(self, SizerItem item)</autodoc> |
7146 | <docstring>Prepends a `wx.SizerItem` to the sizer.</docstring> | |
f32fc4bc RD |
7147 | <paramlist> |
7148 | <param name="item" type="SizerItem" default=""/> | |
7149 | </paramlist> | |
7150 | </method> | |
7151 | <method name="SetDimension" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7157 | <paramlist> |
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=""/> | |
7162 | </paramlist> | |
7163 | </method> | |
7164 | <method name="SetMinSize" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7171 | <paramlist> |
7172 | <param name="size" type="Size" default=""/> | |
7173 | </paramlist> | |
7174 | </method> | |
7175 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 RD |
7176 | <autodoc>GetSize(self) -> Size</autodoc> |
7177 | <docstring>Returns the current size of the space managed by the sizer.</docstring> | |
f32fc4bc RD |
7178 | </method> |
7179 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 RD |
7180 | <autodoc>GetPosition(self) -> Point</autodoc> |
7181 | <docstring>Returns the current position of the sizer's managed space.</docstring> | |
f32fc4bc RD |
7182 | </method> |
7183 | <method name="GetMinSize" type="Size" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7188 | </method> |
7189 | <method name="RecalcSizes" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7194 | </method> |
7195 | <method name="CalcMin" type="Size" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7200 | </method> |
7201 | <method name="Layout" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7209 | </method> |
7210 | <method name="Fit" type="Size" overloaded="no"> | |
781d2982 RD |
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. | |
7216 | ||
7217 | For a top level window this is the total window size, not the client size.</docstring> | |
f32fc4bc RD |
7218 | <paramlist> |
7219 | <param name="window" type="Window" default=""/> | |
7220 | </paramlist> | |
7221 | </method> | |
7222 | <method name="FitInside" type="" overloaded="no"> | |
781d2982 RD |
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. | |
7228 | ||
7229 | :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints` | |
7230 | </docstring> | |
f32fc4bc RD |
7231 | <paramlist> |
7232 | <param name="window" type="Window" default=""/> | |
7233 | </paramlist> | |
7234 | </method> | |
7235 | <method name="SetSizeHints" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7243 | <paramlist> |
7244 | <param name="window" type="Window" default=""/> | |
7245 | </paramlist> | |
7246 | </method> | |
7247 | <method name="SetVirtualSizeHints" type="" overloaded="no"> | |
781d2982 RD |
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. | |
7252 | ||
7253 | :see: `wx.ScrolledWindow.SetScrollbars` | |
7254 | </docstring> | |
f32fc4bc RD |
7255 | <paramlist> |
7256 | <param name="window" type="Window" default=""/> | |
7257 | </paramlist> | |
7258 | </method> | |
7259 | <method name="Clear" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc | 7263 | <paramlist> |
781d2982 | 7264 | <param name="deleteWindows" type="bool" default="False"/> |
f32fc4bc RD |
7265 | </paramlist> |
7266 | </method> | |
7267 | <method name="DeleteWindows" type="" overloaded="no"> | |
781d2982 RD |
7268 | <autodoc>DeleteWindows(self)</autodoc> |
7269 | <docstring>Destroy all windows managed by the sizer.</docstring> | |
f32fc4bc RD |
7270 | </method> |
7271 | <method name="GetChildren" type="PyObject" overloaded="no"> | |
781d2982 RD |
7272 | <autodoc>GetChildren(sefl) -> list</autodoc> |
7273 | <docstring>Returns a list of all the `wx.SizerItem` objects managed by the sizer.</docstring> | |
f32fc4bc RD |
7274 | </method> |
7275 | <method name="Show" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7281 | <paramlist> |
7282 | <param name="item" type="PyObject" default=""/> | |
7283 | <param name="show" type="bool" default="True"/> | |
7284 | </paramlist> | |
7285 | </method> | |
f32fc4bc | 7286 | <method name="IsShown" type="bool" overloaded="no"> |
781d2982 RD |
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> | |
f32fc4bc RD |
7292 | <paramlist> |
7293 | <param name="item" type="PyObject" default=""/> | |
7294 | </paramlist> | |
7295 | </method> | |
7296 | <method name="ShowItems" type="" overloaded="no"> | |
781d2982 RD |
7297 | <autodoc>ShowItems(self, bool show)</autodoc> |
7298 | <docstring>Recursively call `wx.Window.Show` on all sizer items.</docstring> | |
f32fc4bc RD |
7299 | <paramlist> |
7300 | <param name="show" type="bool" default=""/> | |
7301 | </paramlist> | |
7302 | </method> | |
7303 | </class> | |
781d2982 RD |
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. | |
7310 | For example:: | |
7311 | ||
7312 | class MySizer(wx.PySizer): | |
7313 | def __init__(self): | |
7314 | wx.PySizer.__init__(self) | |
7315 | ||
7316 | def CalcMin(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 | |
7320 | # layout algorithm. | |
7321 | ... | |
7322 | return wx.Size(width, height) | |
7323 | ||
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. | |
7333 | ... | |
7334 | item.SetDimension(itemPos, itemSize) | |
7335 | ||
7336 | ||
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`. | |
7340 | ||
7341 | :see: `wx.SizerItem`, `wx.Sizer.GetChildren` | |
7342 | ||
7343 | </docstring> | |
f32fc4bc RD |
7344 | <baseclass name="Sizer"/> |
7345 | <constructor name="PySizer" overloaded="no"> | |
781d2982 RD |
7346 | <autodoc>__init__(self) -> PySizer</autodoc> |
7347 | <docstring>Creates a wx.PySizer. Must be called from the __init__ in the derived | |
7348 | class.</docstring> | |
f32fc4bc RD |
7349 | </constructor> |
7350 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 7351 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
7352 | <paramlist> |
7353 | <param name="self" type="PyObject" default=""/> | |
7354 | <param name="_class" type="PyObject" default=""/> | |
7355 | </paramlist> | |
7356 | </method> | |
7357 | </class> | |
0dd25e81 | 7358 | <pythoncode> |
0f43fbdf RD |
7359 | #--------------------------------------------------------------------------- |
7360 | </pythoncode> | |
781d2982 RD |
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 | |
ce6878e6 RD |
7366 | parameter passed to the constructor. |
7367 | ||
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. | |
7381 | ||
7382 | :see: `wx.StaticBoxSizer` | |
7383 | </docstring> | |
f32fc4bc RD |
7384 | <baseclass name="Sizer"/> |
7385 | <constructor name="BoxSizer" overloaded="no"> | |
781d2982 RD |
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 | |
7389 | sizer.</docstring> | |
f32fc4bc RD |
7390 | <paramlist> |
7391 | <param name="orient" type="int" default="wxHORIZONTAL"/> | |
7392 | </paramlist> | |
7393 | </constructor> | |
7394 | <method name="GetOrientation" type="int" overloaded="no"> | |
781d2982 RD |
7395 | <autodoc>GetOrientation(self) -> int</autodoc> |
7396 | <docstring>Returns the current orientation of the sizer.</docstring> | |
f32fc4bc RD |
7397 | </method> |
7398 | <method name="SetOrientation" type="" overloaded="no"> | |
781d2982 RD |
7399 | <autodoc>SetOrientation(self, int orient)</autodoc> |
7400 | <docstring>Resets the orientation of the sizer.</docstring> | |
f32fc4bc RD |
7401 | <paramlist> |
7402 | <param name="orient" type="int" default=""/> | |
7403 | </paramlist> | |
7404 | </method> | |
f32fc4bc RD |
7405 | </class> |
7406 | <pythoncode> | |
0f43fbdf RD |
7407 | #--------------------------------------------------------------------------- |
7408 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7414 | <baseclass name="BoxSizer"/> |
7415 | <constructor name="StaticBoxSizer" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7420 | <paramlist> |
7421 | <param name="box" type="wxStaticBox" default=""/> | |
7422 | <param name="orient" type="int" default="wxHORIZONTAL"/> | |
7423 | </paramlist> | |
7424 | </constructor> | |
7425 | <method name="GetStaticBox" type="wxStaticBox" overloaded="no"> | |
781d2982 RD |
7426 | <autodoc>GetStaticBox(self) -> StaticBox</autodoc> |
7427 | <docstring>Returns the static box associated with this sizer.</docstring> | |
f32fc4bc RD |
7428 | </method> |
7429 | </class> | |
7430 | <pythoncode> | |
0f43fbdf RD |
7431 | #--------------------------------------------------------------------------- |
7432 | </pythoncode> | |
781d2982 RD |
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.) | |
7440 | ||
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`. | |
7447 | </docstring> | |
f32fc4bc RD |
7448 | <baseclass name="Sizer"/> |
7449 | <constructor name="GridSizer" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7456 | <paramlist> |
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"/> | |
7461 | </paramlist> | |
7462 | </constructor> | |
f32fc4bc | 7463 | <method name="SetCols" type="" overloaded="no"> |
781d2982 RD |
7464 | <autodoc>SetCols(self, int cols)</autodoc> |
7465 | <docstring>Sets the number of columns in the sizer.</docstring> | |
f32fc4bc RD |
7466 | <paramlist> |
7467 | <param name="cols" type="int" default=""/> | |
7468 | </paramlist> | |
7469 | </method> | |
7470 | <method name="SetRows" type="" overloaded="no"> | |
781d2982 RD |
7471 | <autodoc>SetRows(self, int rows)</autodoc> |
7472 | <docstring>Sets the number of rows in the sizer.</docstring> | |
f32fc4bc RD |
7473 | <paramlist> |
7474 | <param name="rows" type="int" default=""/> | |
7475 | </paramlist> | |
7476 | </method> | |
7477 | <method name="SetVGap" type="" overloaded="no"> | |
781d2982 RD |
7478 | <autodoc>SetVGap(self, int gap)</autodoc> |
7479 | <docstring>Sets the vertical gap (in pixels) between the cells in the sizer.</docstring> | |
f32fc4bc RD |
7480 | <paramlist> |
7481 | <param name="gap" type="int" default=""/> | |
7482 | </paramlist> | |
7483 | </method> | |
7484 | <method name="SetHGap" type="" overloaded="no"> | |
781d2982 RD |
7485 | <autodoc>SetHGap(self, int gap)</autodoc> |
7486 | <docstring>Sets the horizontal gap (in pixels) between cells in the sizer</docstring> | |
f32fc4bc RD |
7487 | <paramlist> |
7488 | <param name="gap" type="int" default=""/> | |
7489 | </paramlist> | |
7490 | </method> | |
7491 | <method name="GetCols" type="int" overloaded="no"> | |
781d2982 RD |
7492 | <autodoc>GetCols(self) -> int</autodoc> |
7493 | <docstring>Returns the number of columns in the sizer.</docstring> | |
f32fc4bc RD |
7494 | </method> |
7495 | <method name="GetRows" type="int" overloaded="no"> | |
781d2982 RD |
7496 | <autodoc>GetRows(self) -> int</autodoc> |
7497 | <docstring>Returns the number of rows in the sizer.</docstring> | |
f32fc4bc RD |
7498 | </method> |
7499 | <method name="GetVGap" type="int" overloaded="no"> | |
781d2982 RD |
7500 | <autodoc>GetVGap(self) -> int</autodoc> |
7501 | <docstring>Returns the vertical gap (in pixels) between the cells in the sizer.</docstring> | |
f32fc4bc RD |
7502 | </method> |
7503 | <method name="GetHGap" type="int" overloaded="no"> | |
781d2982 RD |
7504 | <autodoc>GetHGap(self) -> int</autodoc> |
7505 | <docstring>Returns the horizontal gap (in pixels) between cells in the sizer.</docstring> | |
f32fc4bc RD |
7506 | </method> |
7507 | </class> | |
7508 | <pythoncode> | |
0f43fbdf RD |
7509 | #--------------------------------------------------------------------------- |
7510 | </pythoncode> | |
781d2982 RD |
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 | |
7516 | the `wx.GridSizer`. | |
7517 | ||
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. | |
7524 | ||
7525 | </docstring> | |
f32fc4bc RD |
7526 | <baseclass name="GridSizer"/> |
7527 | <constructor name="FlexGridSizer" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7534 | <paramlist> |
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"/> | |
7539 | </paramlist> | |
7540 | </constructor> | |
f32fc4bc | 7541 | <method name="AddGrowableRow" type="" overloaded="no"> |
781d2982 RD |
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. | |
7545 | ||
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> | |
f32fc4bc RD |
7549 | <paramlist> |
7550 | <param name="idx" type="size_t" default=""/> | |
7551 | <param name="proportion" type="int" default="0"/> | |
7552 | </paramlist> | |
7553 | </method> | |
7554 | <method name="RemoveGrowableRow" type="" overloaded="no"> | |
781d2982 RD |
7555 | <autodoc>RemoveGrowableRow(self, size_t idx)</autodoc> |
7556 | <docstring>Specifies that row *idx* is no longer growable.</docstring> | |
f32fc4bc RD |
7557 | <paramlist> |
7558 | <param name="idx" type="size_t" default=""/> | |
7559 | </paramlist> | |
7560 | </method> | |
7561 | <method name="AddGrowableCol" type="" overloaded="no"> | |
781d2982 RD |
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. | |
7565 | ||
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> | |
f32fc4bc RD |
7569 | <paramlist> |
7570 | <param name="idx" type="size_t" default=""/> | |
7571 | <param name="proportion" type="int" default="0"/> | |
7572 | </paramlist> | |
7573 | </method> | |
7574 | <method name="RemoveGrowableCol" type="" overloaded="no"> | |
781d2982 RD |
7575 | <autodoc>RemoveGrowableCol(self, size_t idx)</autodoc> |
7576 | <docstring>Specifies that column *idx* is no longer growable.</docstring> | |
f32fc4bc RD |
7577 | <paramlist> |
7578 | <param name="idx" type="size_t" default=""/> | |
7579 | </paramlist> | |
7580 | </method> | |
7581 | <method name="SetFlexibleDirection" type="" overloaded="no"> | |
781d2982 RD |
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. | |
7586 | ||
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 | ============== ======================================= | |
7593 | ||
7594 | Note that this method does not trigger relayout. | |
7595 | </docstring> | |
f32fc4bc RD |
7596 | <paramlist> |
7597 | <param name="direction" type="int" default=""/> | |
7598 | </paramlist> | |
7599 | </method> | |
7600 | <method name="GetFlexibleDirection" type="int" overloaded="no"> | |
781d2982 RD |
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). | |
7604 | ||
7605 | :see: `SetFlexibleDirection`</docstring> | |
f32fc4bc RD |
7606 | </method> |
7607 | <method name="SetNonFlexibleGrowMode" type="" overloaded="no"> | |
781d2982 RD |
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: | |
7612 | ||
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 | ========================== ================================================= | |
7623 | ||
7624 | Note that this method does not trigger relayout. | |
7625 | ||
7626 | </docstring> | |
f32fc4bc RD |
7627 | <paramlist> |
7628 | <param name="mode" type="wxFlexSizerGrowMode" default=""/> | |
7629 | </paramlist> | |
7630 | </method> | |
7631 | <method name="GetNonFlexibleGrowMode" type="wxFlexSizerGrowMode" overloaded="no"> | |
781d2982 RD |
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. | |
7635 | ||
7636 | :see: `SetNonFlexibleGrowMode`</docstring> | |
f32fc4bc RD |
7637 | </method> |
7638 | <method name="GetRowHeights" type="wxArrayInt" overloaded="no"> | |
781d2982 | 7639 | <autodoc>GetRowHeights(self) -> list</autodoc> |
ce6878e6 RD |
7640 | <docstring>Returns a list of integers representing the heights of each of the |
7641 | rows in the sizer.</docstring> | |
f32fc4bc RD |
7642 | </method> |
7643 | <method name="GetColWidths" type="wxArrayInt" overloaded="no"> | |
781d2982 | 7644 | <autodoc>GetColWidths(self) -> list</autodoc> |
ce6878e6 RD |
7645 | <docstring>Returns a list of integers representing the widths of each of the |
7646 | columns in the sizer.</docstring> | |
f32fc4bc RD |
7647 | </method> |
7648 | </class> | |
7649 | <pythoncode> | |
0f43fbdf RD |
7650 | #--------------------------------------------------------------------------- |
7651 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc | 7658 | <constructor name="GBPosition" overloaded="no"> |
781d2982 RD |
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> | |
f32fc4bc RD |
7665 | <paramlist> |
7666 | <param name="row" type="int" default="0"/> | |
7667 | <param name="col" type="int" default="0"/> | |
7668 | </paramlist> | |
7669 | </constructor> | |
7670 | <method name="GetRow" type="int" overloaded="no"> | |
781d2982 | 7671 | <autodoc>GetRow(self) -> int</autodoc> |
f32fc4bc RD |
7672 | </method> |
7673 | <method name="GetCol" type="int" overloaded="no"> | |
781d2982 | 7674 | <autodoc>GetCol(self) -> int</autodoc> |
f32fc4bc RD |
7675 | </method> |
7676 | <method name="SetRow" type="" overloaded="no"> | |
781d2982 | 7677 | <autodoc>SetRow(self, int row)</autodoc> |
f32fc4bc RD |
7678 | <paramlist> |
7679 | <param name="row" type="int" default=""/> | |
7680 | </paramlist> | |
7681 | </method> | |
7682 | <method name="SetCol" type="" overloaded="no"> | |
781d2982 | 7683 | <autodoc>SetCol(self, int col)</autodoc> |
f32fc4bc RD |
7684 | <paramlist> |
7685 | <param name="col" type="int" default=""/> | |
7686 | </paramlist> | |
7687 | </method> | |
7688 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 7689 | <autodoc>__eq__(self, GBPosition other) -> bool</autodoc> |
f32fc4bc | 7690 | <paramlist> |
c2dda882 | 7691 | <param name="other" type="GBPosition" default=""/> |
f32fc4bc RD |
7692 | </paramlist> |
7693 | </method> | |
7694 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 7695 | <autodoc>__ne__(self, GBPosition other) -> bool</autodoc> |
f32fc4bc | 7696 | <paramlist> |
c2dda882 | 7697 | <param name="other" type="GBPosition" default=""/> |
f32fc4bc RD |
7698 | </paramlist> |
7699 | </method> | |
7700 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 7701 | <autodoc>Set(self, int row=0, int col=0)</autodoc> |
f32fc4bc RD |
7702 | <paramlist> |
7703 | <param name="row" type="int" default="0"/> | |
7704 | <param name="col" type="int" default="0"/> | |
7705 | </paramlist> | |
7706 | </method> | |
7707 | <method name="Get" type="PyObject" overloaded="no"> | |
781d2982 | 7708 | <autodoc>Get(self) -> PyObject</autodoc> |
f32fc4bc RD |
7709 | </method> |
7710 | </class> | |
781d2982 RD |
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. | |
7717 | </docstring> | |
f32fc4bc | 7718 | <constructor name="GBSpan" overloaded="no"> |
781d2982 RD |
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> | |
f32fc4bc RD |
7723 | <paramlist> |
7724 | <param name="rowspan" type="int" default="1"/> | |
7725 | <param name="colspan" type="int" default="1"/> | |
7726 | </paramlist> | |
7727 | </constructor> | |
7728 | <method name="GetRowspan" type="int" overloaded="no"> | |
781d2982 | 7729 | <autodoc>GetRowspan(self) -> int</autodoc> |
f32fc4bc RD |
7730 | </method> |
7731 | <method name="GetColspan" type="int" overloaded="no"> | |
781d2982 | 7732 | <autodoc>GetColspan(self) -> int</autodoc> |
f32fc4bc RD |
7733 | </method> |
7734 | <method name="SetRowspan" type="" overloaded="no"> | |
781d2982 | 7735 | <autodoc>SetRowspan(self, int rowspan)</autodoc> |
f32fc4bc RD |
7736 | <paramlist> |
7737 | <param name="rowspan" type="int" default=""/> | |
7738 | </paramlist> | |
7739 | </method> | |
7740 | <method name="SetColspan" type="" overloaded="no"> | |
781d2982 | 7741 | <autodoc>SetColspan(self, int colspan)</autodoc> |
f32fc4bc RD |
7742 | <paramlist> |
7743 | <param name="colspan" type="int" default=""/> | |
7744 | </paramlist> | |
7745 | </method> | |
7746 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 7747 | <autodoc>__eq__(self, GBSpan other) -> bool</autodoc> |
f32fc4bc | 7748 | <paramlist> |
c2dda882 | 7749 | <param name="other" type="GBSpan" default=""/> |
f32fc4bc RD |
7750 | </paramlist> |
7751 | </method> | |
7752 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 7753 | <autodoc>__ne__(self, GBSpan other) -> bool</autodoc> |
f32fc4bc | 7754 | <paramlist> |
c2dda882 | 7755 | <param name="other" type="GBSpan" default=""/> |
f32fc4bc RD |
7756 | </paramlist> |
7757 | </method> | |
7758 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 7759 | <autodoc>Set(self, int rowspan=1, int colspan=1)</autodoc> |
f32fc4bc RD |
7760 | <paramlist> |
7761 | <param name="rowspan" type="int" default="1"/> | |
7762 | <param name="colspan" type="int" default="1"/> | |
7763 | </paramlist> | |
7764 | </method> | |
7765 | <method name="Get" type="PyObject" overloaded="no"> | |
781d2982 | 7766 | <autodoc>Get(self) -> PyObject</autodoc> |
f32fc4bc RD |
7767 | </method> |
7768 | </class> | |
781d2982 RD |
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. | |
7773 | </docstring> | |
f32fc4bc RD |
7774 | <baseclass name="SizerItem"/> |
7775 | <constructor name="GBSizerItem" overloaded="no"> | |
781d2982 RD |
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. | |
7780 | ||
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> | |
f32fc4bc RD |
7783 | </constructor> |
7784 | <constructor name="GBSizerItemWindow" overloaded="no"> | |
7785 | <autodoc>GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag, | |
781d2982 RD |
7786 | int border, PyObject userData=None) -> GBSizerItem</autodoc> |
7787 | <docstring>Construct a `wx.GBSizerItem` for a window.</docstring> | |
f32fc4bc RD |
7788 | <paramlist> |
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=""/> | |
781d2982 | 7794 | <param name="userData" type="PyObject" default="NULL"/> |
f32fc4bc RD |
7795 | </paramlist> |
7796 | </constructor> | |
7797 | <constructor name="GBSizerItemSizer" overloaded="no"> | |
7798 | <autodoc>GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag, | |
781d2982 RD |
7799 | int border, PyObject userData=None) -> GBSizerItem</autodoc> |
7800 | <docstring>Construct a `wx.GBSizerItem` for a sizer</docstring> | |
f32fc4bc RD |
7801 | <paramlist> |
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=""/> | |
781d2982 | 7807 | <param name="userData" type="PyObject" default="NULL"/> |
f32fc4bc RD |
7808 | </paramlist> |
7809 | </constructor> | |
7810 | <constructor name="GBSizerItemSpacer" overloaded="no"> | |
7811 | <autodoc>GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span, | |
781d2982 RD |
7812 | int flag, int border, PyObject userData=None) -> GBSizerItem</autodoc> |
7813 | <docstring>Construct a `wx.GBSizerItem` for a spacer.</docstring> | |
f32fc4bc RD |
7814 | <paramlist> |
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=""/> | |
781d2982 | 7821 | <param name="userData" type="PyObject" default="NULL"/> |
f32fc4bc RD |
7822 | </paramlist> |
7823 | </constructor> | |
7824 | <method name="GetPos" type="GBPosition" overloaded="no"> | |
781d2982 RD |
7825 | <autodoc>GetPos(self) -> GBPosition</autodoc> |
7826 | <docstring>Get the grid position of the item</docstring> | |
f32fc4bc RD |
7827 | </method> |
7828 | <method name="GetSpan" type="GBSpan" overloaded="no"> | |
781d2982 RD |
7829 | <autodoc>GetSpan(self) -> GBSpan</autodoc> |
7830 | <docstring>Get the row and column spanning of the item</docstring> | |
f32fc4bc RD |
7831 | </method> |
7832 | <method name="SetPos" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7838 | <paramlist> |
7839 | <param name="pos" type="GBPosition" default=""/> | |
7840 | </paramlist> | |
7841 | </method> | |
7842 | <method name="SetSpan" type="bool" overloaded="no"> | |
781d2982 RD |
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. | |
7848 | </docstring> | |
f32fc4bc RD |
7849 | <paramlist> |
7850 | <param name="span" type="GBSpan" default=""/> | |
7851 | </paramlist> | |
7852 | </method> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7856 | <paramlist> |
7857 | <param name="other" type="GBSizerItem" default=""/> | |
7858 | </paramlist> | |
7859 | </method> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7863 | <paramlist> |
7864 | <param name="pos" type="GBPosition" default=""/> | |
7865 | <param name="span" type="GBSpan" default=""/> | |
7866 | </paramlist> | |
7867 | </method> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7871 | </method> |
7872 | <method name="GetGBSizer" type="wxGridBagSizer" overloaded="no"> | |
781d2982 RD |
7873 | <autodoc>GetGBSizer(self) -> GridBagSizer</autodoc> |
7874 | <docstring>Get the sizer this item is a member of.</docstring> | |
f32fc4bc RD |
7875 | </method> |
7876 | <method name="SetGBSizer" type="" overloaded="no"> | |
781d2982 RD |
7877 | <autodoc>SetGBSizer(self, GridBagSizer sizer)</autodoc> |
7878 | <docstring>Set the sizer this item is a member of.</docstring> | |
f32fc4bc RD |
7879 | <paramlist> |
7880 | <param name="sizer" type="wxGridBagSizer" default=""/> | |
7881 | </paramlist> | |
7882 | </method> | |
7883 | </class> | |
781d2982 RD |
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. | |
7891 | </docstring> | |
f32fc4bc RD |
7892 | <baseclass name="FlexGridSizer"/> |
7893 | <constructor name="GridBagSizer" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7897 | <paramlist> |
7898 | <param name="vgap" type="int" default="0"/> | |
7899 | <param name="hgap" type="int" default="0"/> | |
7900 | </paramlist> | |
7901 | </constructor> | |
7902 | <method name="Add" type="bool" overloaded="no"> | |
781d2982 RD |
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`. | |
7908 | ||
7909 | Returns True if the item was successfully placed at the given cell | |
7910 | position, False if something was already there. | |
7911 | </docstring> | |
f32fc4bc RD |
7912 | <paramlist> |
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"/> | |
7919 | </paramlist> | |
7920 | </method> | |
7921 | <method name="AddItem" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
7926 | <paramlist> |
7927 | <param name="item" type="GBSizerItem" default=""/> | |
7928 | </paramlist> | |
7929 | </method> | |
7930 | <method name="GetEmptyCellSize" type="Size" overloaded="no"> | |
781d2982 RD |
7931 | <autodoc>GetEmptyCellSize(self) -> Size</autodoc> |
7932 | <docstring>Get the size used for cells in the grid with no item.</docstring> | |
f32fc4bc RD |
7933 | </method> |
7934 | <method name="SetEmptyCellSize" type="" overloaded="no"> | |
781d2982 RD |
7935 | <autodoc>SetEmptyCellSize(self, Size sz)</autodoc> |
7936 | <docstring>Set the size used for cells in the grid with no item.</docstring> | |
f32fc4bc RD |
7937 | <paramlist> |
7938 | <param name="sz" type="Size" default=""/> | |
7939 | </paramlist> | |
7940 | </method> | |
7941 | <method name="GetItemPosition" type="GBPosition" overloaded="yes"> | |
781d2982 RD |
7942 | <docstring>GetItemPosition(self, item) -> GBPosition |
7943 | ||
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> | |
f32fc4bc RD |
7947 | <paramlist> |
7948 | <param name="window" type="Window" default=""/> | |
7949 | </paramlist> | |
7950 | </method> | |
7951 | <method name="GetItemPosition" type="GBPosition" overloaded="yes"> | |
781d2982 RD |
7952 | <docstring>GetItemPosition(self, item) -> GBPosition |
7953 | ||
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> | |
f32fc4bc RD |
7957 | <paramlist> |
7958 | <param name="sizer" type="Sizer" default=""/> | |
7959 | </paramlist> | |
7960 | </method> | |
7961 | <method name="GetItemPosition" type="GBPosition" overloaded="yes"> | |
781d2982 RD |
7962 | <docstring>GetItemPosition(self, item) -> GBPosition |
7963 | ||
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> | |
f32fc4bc RD |
7967 | <paramlist> |
7968 | <param name="index" type="size_t" default=""/> | |
7969 | </paramlist> | |
7970 | </method> | |
7971 | <method name="SetItemPosition" type="bool" overloaded="yes"> | |
781d2982 RD |
7972 | <docstring>SetItemPosition(self, item, GBPosition pos) -> bool |
7973 | ||
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. | |
7978 | </docstring> | |
f32fc4bc RD |
7979 | <paramlist> |
7980 | <param name="window" type="Window" default=""/> | |
7981 | <param name="pos" type="GBPosition" default=""/> | |
7982 | </paramlist> | |
7983 | </method> | |
7984 | <method name="SetItemPosition" type="bool" overloaded="yes"> | |
781d2982 RD |
7985 | <docstring>SetItemPosition(self, item, GBPosition pos) -> bool |
7986 | ||
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. | |
7991 | </docstring> | |
f32fc4bc RD |
7992 | <paramlist> |
7993 | <param name="sizer" type="Sizer" default=""/> | |
7994 | <param name="pos" type="GBPosition" default=""/> | |
7995 | </paramlist> | |
7996 | </method> | |
7997 | <method name="SetItemPosition" type="bool" overloaded="yes"> | |
781d2982 RD |
7998 | <docstring>SetItemPosition(self, item, GBPosition pos) -> bool |
7999 | ||
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. | |
8004 | </docstring> | |
f32fc4bc RD |
8005 | <paramlist> |
8006 | <param name="index" type="size_t" default=""/> | |
8007 | <param name="pos" type="GBPosition" default=""/> | |
8008 | </paramlist> | |
8009 | </method> | |
8010 | <method name="GetItemSpan" type="GBSpan" overloaded="yes"> | |
781d2982 RD |
8011 | <docstring>GetItemSpan(self, item) -> GBSpan |
8012 | ||
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> | |
f32fc4bc RD |
8016 | <paramlist> |
8017 | <param name="window" type="Window" default=""/> | |
8018 | </paramlist> | |
8019 | </method> | |
8020 | <method name="GetItemSpan" type="GBSpan" overloaded="yes"> | |
781d2982 RD |
8021 | <docstring>GetItemSpan(self, item) -> GBSpan |
8022 | ||
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> | |
f32fc4bc RD |
8026 | <paramlist> |
8027 | <param name="sizer" type="Sizer" default=""/> | |
8028 | </paramlist> | |
8029 | </method> | |
8030 | <method name="GetItemSpan" type="GBSpan" overloaded="yes"> | |
781d2982 RD |
8031 | <docstring>GetItemSpan(self, item) -> GBSpan |
8032 | ||
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> | |
f32fc4bc RD |
8036 | <paramlist> |
8037 | <param name="index" type="size_t" default=""/> | |
8038 | </paramlist> | |
8039 | </method> | |
8040 | <method name="SetItemSpan" type="bool" overloaded="yes"> | |
781d2982 RD |
8041 | <docstring>SetItemSpan(self, item, GBSpan span) -> bool |
8042 | ||
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> | |
f32fc4bc RD |
8047 | <paramlist> |
8048 | <param name="window" type="Window" default=""/> | |
8049 | <param name="span" type="GBSpan" default=""/> | |
8050 | </paramlist> | |
8051 | </method> | |
8052 | <method name="SetItemSpan" type="bool" overloaded="yes"> | |
781d2982 RD |
8053 | <docstring>SetItemSpan(self, item, GBSpan span) -> bool |
8054 | ||
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> | |
f32fc4bc RD |
8059 | <paramlist> |
8060 | <param name="sizer" type="Sizer" default=""/> | |
8061 | <param name="span" type="GBSpan" default=""/> | |
8062 | </paramlist> | |
8063 | </method> | |
8064 | <method name="SetItemSpan" type="bool" overloaded="yes"> | |
781d2982 RD |
8065 | <docstring>SetItemSpan(self, item, GBSpan span) -> bool |
8066 | ||
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> | |
f32fc4bc RD |
8071 | <paramlist> |
8072 | <param name="index" type="size_t" default=""/> | |
8073 | <param name="span" type="GBSpan" default=""/> | |
8074 | </paramlist> | |
8075 | </method> | |
8076 | <method name="FindItem" type="GBSizerItem" overloaded="yes"> | |
781d2982 RD |
8077 | <docstring>FindItem(self, item) -> GBSizerItem |
8078 | ||
8079 | Find the sizer item for the given window or subsizer, returns None if | |
8080 | not found. (non-recursive)</docstring> | |
f32fc4bc RD |
8081 | <paramlist> |
8082 | <param name="window" type="Window" default=""/> | |
8083 | </paramlist> | |
8084 | </method> | |
8085 | <method name="FindItem" type="GBSizerItem" overloaded="yes"> | |
781d2982 RD |
8086 | <docstring>FindItem(self, item) -> GBSizerItem |
8087 | ||
8088 | Find the sizer item for the given window or subsizer, returns None if | |
8089 | not found. (non-recursive)</docstring> | |
f32fc4bc RD |
8090 | <paramlist> |
8091 | <param name="sizer" type="Sizer" default=""/> | |
8092 | </paramlist> | |
8093 | </method> | |
8094 | <method name="FindItemAtPosition" type="GBSizerItem" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8098 | <paramlist> |
8099 | <param name="pos" type="GBPosition" default=""/> | |
8100 | </paramlist> | |
8101 | </method> | |
8102 | <method name="FindItemAtPoint" type="GBSizerItem" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8108 | <paramlist> |
8109 | <param name="pt" type="Point" default=""/> | |
8110 | </paramlist> | |
8111 | </method> | |
781d2982 RD |
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 | |
8118 | position of. | |
8119 | </docstring> | |
f32fc4bc | 8120 | <paramlist> |
781d2982 RD |
8121 | <param name="item" type="GBSizerItem" default=""/> |
8122 | <param name="excludeItem" type="GBSizerItem" default="NULL"/> | |
f32fc4bc RD |
8123 | </paramlist> |
8124 | </method> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8132 | <paramlist> |
8133 | <param name="pos" type="GBPosition" default=""/> | |
8134 | <param name="span" type="GBSpan" default=""/> | |
8135 | <param name="excludeItem" type="GBSizerItem" default="NULL"/> | |
8136 | </paramlist> | |
8137 | </method> | |
8138 | </class> | |
8139 | <pythoncode> | |
0f43fbdf RD |
8140 | #--------------------------------------------------------------------------- |
8141 | </pythoncode> | |
781d2982 RD |
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 | |
ce6878e6 RD |
8148 | that it contains. |
8149 | ||
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. | |
8153 | ||
8154 | The Edge specifies the type of edge or dimension of a window. | |
8155 | ||
8156 | Edges | |
8157 | ------ | |
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 | ================== ============================================== | |
8166 | ||
8167 | ||
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. | |
8172 | ||
8173 | Relationships | |
8174 | ------------- | |
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 | |
8185 | or dimension. | |
8186 | wx.PercentOf The edge or dimension should be a percentage of another | |
8187 | edge or dimension. | |
8188 | wx.Absolute The edge or dimension should be a given absolute value. | |
8189 | ================== ============================================== | |
8190 | ||
8191 | :see: `wx.LayoutConstraints`, `wx.Window.SetConstraints` | |
8192 | </docstring> | |
f32fc4bc RD |
8193 | <baseclass name="Object"/> |
8194 | <method name="Set" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8198 | <paramlist> |
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"/> | |
8204 | </paramlist> | |
8205 | </method> | |
8206 | <method name="LeftOf" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8211 | <paramlist> |
8212 | <param name="sibling" type="Window" default=""/> | |
8213 | <param name="marg" type="int" default="0"/> | |
8214 | </paramlist> | |
8215 | </method> | |
8216 | <method name="RightOf" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8221 | <paramlist> |
8222 | <param name="sibling" type="Window" default=""/> | |
8223 | <param name="marg" type="int" default="0"/> | |
8224 | </paramlist> | |
8225 | </method> | |
8226 | <method name="Above" type="" overloaded="no"> | |
781d2982 RD |
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 | |
8230 | window.</docstring> | |
f32fc4bc RD |
8231 | <paramlist> |
8232 | <param name="sibling" type="Window" default=""/> | |
8233 | <param name="marg" type="int" default="0"/> | |
8234 | </paramlist> | |
8235 | </method> | |
8236 | <method name="Below" type="" overloaded="no"> | |
781d2982 RD |
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 | |
8240 | window.</docstring> | |
f32fc4bc RD |
8241 | <paramlist> |
8242 | <param name="sibling" type="Window" default=""/> | |
8243 | <param name="marg" type="int" default="0"/> | |
8244 | </paramlist> | |
8245 | </method> | |
8246 | <method name="SameAs" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8250 | <paramlist> |
8251 | <param name="otherW" type="Window" default=""/> | |
8252 | <param name="edge" type="wxEdge" default=""/> | |
8253 | <param name="marg" type="int" default="0"/> | |
8254 | </paramlist> | |
8255 | </method> | |
8256 | <method name="PercentOf" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8260 | <paramlist> |
8261 | <param name="otherW" type="Window" default=""/> | |
8262 | <param name="wh" type="wxEdge" default=""/> | |
8263 | <param name="per" type="int" default=""/> | |
8264 | </paramlist> | |
8265 | </method> | |
8266 | <method name="Absolute" type="" overloaded="no"> | |
781d2982 RD |
8267 | <autodoc>Absolute(self, int val)</autodoc> |
8268 | <docstring>Constrains this edge or dimension to be the given absolute value.</docstring> | |
f32fc4bc RD |
8269 | <paramlist> |
8270 | <param name="val" type="int" default=""/> | |
8271 | </paramlist> | |
8272 | </method> | |
8273 | <method name="Unconstrained" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8277 | </method> |
8278 | <method name="AsIs" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
8286 | </method> |
8287 | <method name="GetOtherWindow" type="Window" overloaded="no"> | |
781d2982 | 8288 | <autodoc>GetOtherWindow(self) -> Window</autodoc> |
f32fc4bc RD |
8289 | </method> |
8290 | <method name="GetMyEdge" type="wxEdge" overloaded="no"> | |
781d2982 | 8291 | <autodoc>GetMyEdge(self) -> int</autodoc> |
f32fc4bc RD |
8292 | </method> |
8293 | <method name="SetEdge" type="" overloaded="no"> | |
781d2982 | 8294 | <autodoc>SetEdge(self, int which)</autodoc> |
f32fc4bc RD |
8295 | <paramlist> |
8296 | <param name="which" type="wxEdge" default=""/> | |
8297 | </paramlist> | |
8298 | </method> | |
8299 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 8300 | <autodoc>SetValue(self, int v)</autodoc> |
f32fc4bc RD |
8301 | <paramlist> |
8302 | <param name="v" type="int" default=""/> | |
8303 | </paramlist> | |
8304 | </method> | |
8305 | <method name="GetMargin" type="int" overloaded="no"> | |
781d2982 | 8306 | <autodoc>GetMargin(self) -> int</autodoc> |
f32fc4bc RD |
8307 | </method> |
8308 | <method name="SetMargin" type="" overloaded="no"> | |
781d2982 | 8309 | <autodoc>SetMargin(self, int m)</autodoc> |
f32fc4bc RD |
8310 | <paramlist> |
8311 | <param name="m" type="int" default=""/> | |
8312 | </paramlist> | |
8313 | </method> | |
8314 | <method name="GetValue" type="int" overloaded="no"> | |
781d2982 | 8315 | <autodoc>GetValue(self) -> int</autodoc> |
f32fc4bc RD |
8316 | </method> |
8317 | <method name="GetPercent" type="int" overloaded="no"> | |
781d2982 | 8318 | <autodoc>GetPercent(self) -> int</autodoc> |
f32fc4bc RD |
8319 | </method> |
8320 | <method name="GetOtherEdge" type="int" overloaded="no"> | |
781d2982 | 8321 | <autodoc>GetOtherEdge(self) -> int</autodoc> |
f32fc4bc RD |
8322 | </method> |
8323 | <method name="GetDone" type="bool" overloaded="no"> | |
781d2982 | 8324 | <autodoc>GetDone(self) -> bool</autodoc> |
f32fc4bc RD |
8325 | </method> |
8326 | <method name="SetDone" type="" overloaded="no"> | |
781d2982 | 8327 | <autodoc>SetDone(self, bool d)</autodoc> |
f32fc4bc RD |
8328 | <paramlist> |
8329 | <param name="d" type="bool" default=""/> | |
8330 | </paramlist> | |
8331 | </method> | |
8332 | <method name="GetRelationship" type="wxRelationship" overloaded="no"> | |
781d2982 | 8333 | <autodoc>GetRelationship(self) -> int</autodoc> |
f32fc4bc RD |
8334 | </method> |
8335 | <method name="SetRelationship" type="" overloaded="no"> | |
781d2982 | 8336 | <autodoc>SetRelationship(self, int r)</autodoc> |
f32fc4bc RD |
8337 | <paramlist> |
8338 | <param name="r" type="wxRelationship" default=""/> | |
8339 | </paramlist> | |
8340 | </method> | |
8341 | <method name="ResetIfWin" type="bool" overloaded="no"> | |
781d2982 | 8342 | <autodoc>ResetIfWin(self, Window otherW) -> bool</autodoc> |
c2dda882 | 8343 | <docstring>Reset constraint if it mentions otherWin</docstring> |
f32fc4bc RD |
8344 | <paramlist> |
8345 | <param name="otherW" type="Window" default=""/> | |
8346 | </paramlist> | |
8347 | </method> | |
8348 | <method name="SatisfyConstraint" type="bool" overloaded="no"> | |
781d2982 | 8349 | <autodoc>SatisfyConstraint(self, LayoutConstraints constraints, Window win) -> bool</autodoc> |
c2dda882 | 8350 | <docstring>Try to satisfy constraint</docstring> |
f32fc4bc RD |
8351 | <paramlist> |
8352 | <param name="constraints" type="wxLayoutConstraints" default=""/> | |
8353 | <param name="win" type="Window" default=""/> | |
8354 | </paramlist> | |
8355 | </method> | |
8356 | <method name="GetEdge" type="int" overloaded="no"> | |
781d2982 | 8357 | <autodoc>GetEdge(self, int which, Window thisWin, Window other) -> int</autodoc> |
c2dda882 RD |
8358 | <docstring>Get the value of this edge or dimension, or if this |
8359 | is not determinable, -1.</docstring> | |
f32fc4bc RD |
8360 | <paramlist> |
8361 | <param name="which" type="wxEdge" default=""/> | |
8362 | <param name="thisWin" type="Window" default=""/> | |
8363 | <param name="other" type="Window" default=""/> | |
8364 | </paramlist> | |
8365 | </method> | |
8366 | </class> | |
781d2982 RD |
8367 | <class name="LayoutConstraints" oldname="wxLayoutConstraints" module="_core"> |
8368 | <docstring>**Note:** constraints are now deprecated and you should use sizers | |
8369 | instead. | |
c2dda882 | 8370 | |
781d2982 RD |
8371 | Objects of this class can be associated with a window to define its |
8372 | layout constraints, with respect to siblings or its parent. | |
c2dda882 RD |
8373 | |
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. | |
8377 | ||
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 | |
8386 | ||
781d2982 RD |
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. | |
8394 | ||
8395 | :see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints` | |
c2dda882 | 8396 | </docstring> |
f32fc4bc RD |
8397 | <baseclass name="Object"/> |
8398 | <constructor name="LayoutConstraints" overloaded="no"> | |
781d2982 | 8399 | <autodoc>__init__(self) -> LayoutConstraints</autodoc> |
f32fc4bc RD |
8400 | </constructor> |
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> | |
8411 | <paramlist> | |
8412 | <param name="win" type="Window" default=""/> | |
8413 | <param name="OUTPUT" type="int" default=""/> | |
8414 | </paramlist> | |
8415 | </method> | |
8416 | <method name="AreSatisfied" type="bool" overloaded="no"> | |
781d2982 | 8417 | <autodoc>AreSatisfied(self) -> bool</autodoc> |
f32fc4bc RD |
8418 | </method> |
8419 | </class> | |
8420 | <pythoncode>#---------------------------------------------------------------------------- | |
0f43fbdf RD |
8421 | |
8422 | # Use Python's bool constants if available, make some if not | |
8423 | try: | |
8424 | True | |
8425 | except NameError: | |
8426 | __builtins__.True = 1==1 | |
8427 | __builtins__.False = 1==0 | |
368d20e8 RD |
8428 | def bool(value): return not not value |
8429 | __builtins__.bool = bool | |
0f43fbdf RD |
8430 | |
8431 | ||
8432 | ||
8433 | # workarounds for bad wxRTTI names | |
8434 | __wxPyPtrTypeMap['wxGauge95'] = 'wxGauge' | |
8435 | __wxPyPtrTypeMap['wxSlider95'] = 'wxSlider' | |
8436 | __wxPyPtrTypeMap['wxStatusBar95'] = 'wxStatusBar' | |
8437 | ||
8438 | ||
8439 | #---------------------------------------------------------------------------- | |
8440 | # Load version numbers from __version__... Ensure that major and minor | |
8441 | # versions are the same for both wxPython and wxWindows. | |
8442 | ||
8443 | from __version__ import * | |
8444 | __version__ = VERSION_STRING | |
8445 | ||
781d2982 RD |
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: | |
0f43fbdf RD |
8449 | import warnings |
8450 | warnings.warn("wxPython/wxWindows release number mismatch") | |
8451 | ||
8452 | #---------------------------------------------------------------------------- | |
8453 | ||
8454 | class PyDeadObjectError(AttributeError): | |
8455 | pass | |
8456 | ||
8457 | class _wxPyDeadObject(object): | |
8458 | """ | |
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. | |
8462 | """ | |
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." | |
8465 | ||
8466 | def __repr__(self): | |
8467 | if not hasattr(self, "_name"): | |
8468 | self._name = "[unknown]" | |
8469 | return self.reprStr % self._name | |
8470 | ||
8471 | def __getattr__(self, *args): | |
8472 | if not hasattr(self, "_name"): | |
8473 | self._name = "[unknown]" | |
8474 | raise PyDeadObjectError(self.attrStr % self._name) | |
8475 | ||
8476 | def __nonzero__(self): | |
8477 | return 0 | |
8478 | ||
8479 | ||
8480 | ||
8481 | class PyUnbornObjectError(AttributeError): | |
8482 | pass | |
8483 | ||
8484 | class _wxPyUnbornObject(object): | |
8485 | """ | |
781d2982 | 8486 | Some stock objects are created when the wx._core module is |
0f43fbdf RD |
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 | |
8491 | is ready. | |
8492 | """ | |
8493 | ||
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." | |
8496 | ||
8497 | def __repr__(self): | |
8498 | #if not hasattr(self, "_name"): | |
8499 | # self._name = "[unknown]" | |
8500 | return self.reprStr #% self._name | |
8501 | ||
8502 | def __getattr__(self, *args): | |
8503 | #if not hasattr(self, "_name"): | |
8504 | # self._name = "[unknown]" | |
8505 | raise PyUnbornObjectError(self.attrStr) # % self._name ) | |
8506 | ||
8507 | def __nonzero__(self): | |
8508 | return 0 | |
8509 | ||
8510 | ||
8511 | #---------------------------------------------------------------------------- | |
8512 | _wxPyCallAfterId = None | |
8513 | ||
8514 | def CallAfter(callable, *args, **kw): | |
8515 | """ | |
8516 | Call the specified function after the current and pending event | |
8517 | handlers have been completed. This is also good for making GUI | |
781d2982 RD |
8518 | method calls from non-GUI threads. Any extra positional or |
8519 | keyword args are passed on to the callable when it is called. | |
8520 | ||
8521 | :see: `wx.FutureCall` | |
0f43fbdf RD |
8522 | """ |
8523 | app = wx.GetApp() | |
ce6878e6 | 8524 | assert app is not None, 'No wx.App created yet' |
0f43fbdf RD |
8525 | |
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) ) | |
8531 | evt = wx.PyEvent() | |
8532 | evt.SetEventType(_wxPyCallAfterId) | |
8533 | evt.callable = callable | |
8534 | evt.args = args | |
8535 | evt.kw = kw | |
8536 | wx.PostEvent(app, evt) | |
8537 | ||
8538 | ||
8539 | #---------------------------------------------------------------------------- | |
8540 | ||
8541 | ||
8542 | class FutureCall: | |
8543 | """ | |
b39e211b | 8544 | A convenience class for wx.Timer, that calls the given callable |
0f43fbdf RD |
8545 | object once after the given amount of milliseconds, passing any |
8546 | positional or keyword args. The return value of the callable is | |
781d2982 | 8547 | availbale after it has been run with the `GetResult` method. |
0f43fbdf RD |
8548 | |
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 | |
8554 | object. | |
781d2982 RD |
8555 | |
8556 | :see: `wx.CallAfter` | |
0f43fbdf RD |
8557 | """ |
8558 | def __init__(self, millis, callable, *args, **kwargs): | |
8559 | self.millis = millis | |
8560 | self.callable = callable | |
8561 | self.SetArgs(*args, **kwargs) | |
8562 | self.runCount = 0 | |
b39e211b | 8563 | self.running = False |
0f43fbdf RD |
8564 | self.hasRun = False |
8565 | self.result = None | |
8566 | self.timer = None | |
8567 | self.Start() | |
8568 | ||
8569 | def __del__(self): | |
8570 | self.Stop() | |
8571 | ||
8572 | ||
8573 | def Start(self, millis=None, *args, **kwargs): | |
8574 | """ | |
8575 | (Re)start the timer | |
8576 | """ | |
8577 | self.hasRun = False | |
8578 | if millis is not None: | |
8579 | self.millis = millis | |
8580 | if args or kwargs: | |
8581 | self.SetArgs(*args, **kwargs) | |
8582 | self.Stop() | |
8583 | self.timer = wx.PyTimer(self.Notify) | |
8584 | self.timer.Start(self.millis, wx.TIMER_ONE_SHOT) | |
b39e211b | 8585 | self.running = True |
0f43fbdf RD |
8586 | Restart = Start |
8587 | ||
8588 | ||
8589 | def Stop(self): | |
8590 | """ | |
8591 | Stop and destroy the timer. | |
8592 | """ | |
8593 | if self.timer is not None: | |
8594 | self.timer.Stop() | |
8595 | self.timer = None | |
8596 | ||
8597 | ||
8598 | def GetInterval(self): | |
8599 | if self.timer is not None: | |
8600 | return self.timer.GetInterval() | |
8601 | else: | |
8602 | return 0 | |
8603 | ||
8604 | ||
8605 | def IsRunning(self): | |
8606 | return self.timer is not None and self.timer.IsRunning() | |
8607 | ||
8608 | ||
8609 | def SetArgs(self, *args, **kwargs): | |
8610 | """ | |
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 | |
8614 | parameters. | |
8615 | """ | |
8616 | self.args = args | |
8617 | self.kwargs = kwargs | |
8618 | ||
8619 | ||
8620 | def HasRun(self): | |
8621 | return self.hasRun | |
8622 | ||
8623 | def GetResult(self): | |
8624 | return self.result | |
8625 | ||
8626 | def Notify(self): | |
8627 | """ | |
8628 | The timer has expired so call the callable. | |
8629 | """ | |
8630 | if self.callable and getattr(self.callable, 'im_self', True): | |
8631 | self.runCount += 1 | |
b39e211b | 8632 | self.running = False |
0f43fbdf RD |
8633 | self.result = self.callable(*self.args, **self.kwargs) |
8634 | self.hasRun = True | |
b39e211b RD |
8635 | if not self.running: |
8636 | # if it wasn't restarted, then cleanup | |
8637 | wx.CallAfter(self.Stop) | |
0f43fbdf RD |
8638 | |
8639 | ||
781d2982 RD |
8640 | |
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. | |
8648 | ||
8649 | class __DocFilter: | |
8650 | """ | |
8651 | A filter for epydoc that only allows non-Ptr classes and | |
8652 | fucntions, in order to reduce the clutter in the API docs. | |
8653 | """ | |
8654 | def __init__(self, globals): | |
8655 | self._globals = globals | |
8656 | ||
8657 | def __call__(self, name): | |
8658 | import types | |
8659 | obj = self._globals.get(name, None) | |
8660 | if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]: | |
8661 | return False | |
8662 | if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'): | |
8663 | return False | |
8664 | return True | |
8665 | ||
0f43fbdf RD |
8666 | #---------------------------------------------------------------------------- |
8667 | #---------------------------------------------------------------------------- | |
8668 | ||
8669 | # Import other modules in this package that should show up in the | |
8670 | # "core" wx namespace | |
781d2982 RD |
8671 | from _gdi import * |
8672 | from _windows import * | |
8673 | from _controls import * | |
8674 | from _misc import * | |
0f43fbdf RD |
8675 | |
8676 | ||
8677 | # Fixup the stock objects since they can't be used yet. (They will be | |
8678 | # restored in wx.PyApp.OnInit.) | |
781d2982 | 8679 | _core_._wxPyFixStockObjects() |
0f43fbdf RD |
8680 | |
8681 | #---------------------------------------------------------------------------- | |
8682 | #---------------------------------------------------------------------------- | |
8683 | </pythoncode> | |
f32fc4bc | 8684 | </module> |
781d2982 RD |
8685 | <module name="_gdi"> |
8686 | <import name="_core"/> | |
8687 | <pythoncode> wx = _core </pythoncode> | |
f32fc4bc | 8688 | <pythoncode> |
856bf319 RD |
8689 | #--------------------------------------------------------------------------- |
8690 | </pythoncode> | |
781d2982 | 8691 | <class name="GDIObject" oldname="wxGDIObject" module="_gdi"> |
f32fc4bc RD |
8692 | <baseclass name="Object"/> |
8693 | <constructor name="GDIObject" overloaded="no"> | |
781d2982 | 8694 | <autodoc>__init__(self) -> GDIObject</autodoc> |
f32fc4bc RD |
8695 | </constructor> |
8696 | <destructor name="~wxGDIObject" overloaded="no"> | |
781d2982 | 8697 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
8698 | </destructor> |
8699 | <method name="GetVisible" type="bool" overloaded="no"> | |
781d2982 | 8700 | <autodoc>GetVisible(self) -> bool</autodoc> |
f32fc4bc RD |
8701 | </method> |
8702 | <method name="SetVisible" type="" overloaded="no"> | |
781d2982 | 8703 | <autodoc>SetVisible(self, bool visible)</autodoc> |
f32fc4bc RD |
8704 | <paramlist> |
8705 | <param name="visible" type="bool" default=""/> | |
8706 | </paramlist> | |
8707 | </method> | |
8708 | <method name="IsNull" type="bool" overloaded="no"> | |
781d2982 | 8709 | <autodoc>IsNull(self) -> bool</autodoc> |
f32fc4bc RD |
8710 | </method> |
8711 | </class> | |
8712 | <pythoncode> | |
856bf319 RD |
8713 | #--------------------------------------------------------------------------- |
8714 | </pythoncode> | |
781d2982 RD |
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. | |
c2dda882 | 8719 | |
781d2982 RD |
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:: | |
c2dda882 RD |
8724 | |
8725 | win.SetBackgroundColour(wxColour(0,0,255)) | |
781d2982 RD |
8726 | win.SetBackgroundColour('BLUE') |
8727 | win.SetBackgroundColour('#0000FF') | |
c2dda882 | 8728 | |
781d2982 RD |
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`. | |
8733 | </docstring> | |
f32fc4bc RD |
8734 | <baseclass name="Object"/> |
8735 | <constructor name="Colour" overloaded="no"> | |
781d2982 RD |
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. | |
8738 | ||
8739 | :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`. | |
8740 | </docstring> | |
f32fc4bc | 8741 | <paramlist> |
781d2982 RD |
8742 | <param name="red" type="byte" default="0"/> |
8743 | <param name="green" type="byte" default="0"/> | |
8744 | <param name="blue" type="byte" default="0"/> | |
f32fc4bc RD |
8745 | </paramlist> |
8746 | </constructor> | |
8747 | <constructor name="NamedColour" overloaded="no"> | |
8748 | <autodoc>NamedColour(String colorName) -> Colour</autodoc> | |
781d2982 RD |
8749 | <docstring>Constructs a colour object using a colour name listed in |
8750 | ``wx.TheColourDatabase``.</docstring> | |
f32fc4bc RD |
8751 | <paramlist> |
8752 | <param name="colorName" type="String" default=""/> | |
8753 | </paramlist> | |
8754 | </constructor> | |
8755 | <constructor name="ColourRGB" overloaded="no"> | |
8756 | <autodoc>ColourRGB(unsigned long colRGB) -> Colour</autodoc> | |
c2dda882 | 8757 | <docstring>Constructs a colour from a packed RGB value.</docstring> |
f32fc4bc RD |
8758 | <paramlist> |
8759 | <param name="colRGB" type="unsigned long" default=""/> | |
8760 | </paramlist> | |
8761 | </constructor> | |
8762 | <destructor name="~wxColour" overloaded="no"> | |
781d2982 | 8763 | <autodoc>__del__(self)</autodoc> |
f32fc4bc | 8764 | </destructor> |
781d2982 RD |
8765 | <method name="Red" type="byte" overloaded="no"> |
8766 | <autodoc>Red(self) -> byte</autodoc> | |
c2dda882 | 8767 | <docstring>Returns the red intensity.</docstring> |
f32fc4bc | 8768 | </method> |
781d2982 RD |
8769 | <method name="Green" type="byte" overloaded="no"> |
8770 | <autodoc>Green(self) -> byte</autodoc> | |
c2dda882 | 8771 | <docstring>Returns the green intensity.</docstring> |
f32fc4bc | 8772 | </method> |
781d2982 RD |
8773 | <method name="Blue" type="byte" overloaded="no"> |
8774 | <autodoc>Blue(self) -> byte</autodoc> | |
c2dda882 | 8775 | <docstring>Returns the blue intensity.</docstring> |
f32fc4bc RD |
8776 | </method> |
8777 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 8778 | <autodoc>Ok(self) -> bool</autodoc> |
c2dda882 RD |
8779 | <docstring>Returns True if the colour object is valid (the colour has been |
8780 | initialised with RGB values).</docstring> | |
f32fc4bc RD |
8781 | </method> |
8782 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 8783 | <autodoc>Set(self, byte red, byte green, byte blue)</autodoc> |
c2dda882 | 8784 | <docstring>Sets the RGB intensity values.</docstring> |
f32fc4bc | 8785 | <paramlist> |
781d2982 RD |
8786 | <param name="red" type="byte" default=""/> |
8787 | <param name="green" type="byte" default=""/> | |
8788 | <param name="blue" type="byte" default=""/> | |
f32fc4bc RD |
8789 | </paramlist> |
8790 | </method> | |
8791 | <method name="SetRGB" type="" overloaded="no"> | |
781d2982 | 8792 | <autodoc>SetRGB(self, unsigned long colRGB)</autodoc> |
c2dda882 | 8793 | <docstring>Sets the RGB intensity values from a packed RGB value.</docstring> |
f32fc4bc RD |
8794 | <paramlist> |
8795 | <param name="colRGB" type="unsigned long" default=""/> | |
8796 | </paramlist> | |
8797 | </method> | |
c2dda882 | 8798 | <method name="SetFromName" type="" overloaded="no"> |
781d2982 RD |
8799 | <autodoc>SetFromName(self, String colourName)</autodoc> |
8800 | <docstring>Sets the RGB intensity values using a colour name listed in | |
8801 | ``wx.TheColourDatabase``.</docstring> | |
c2dda882 RD |
8802 | <paramlist> |
8803 | <param name="colourName" type="String" default=""/> | |
8804 | </paramlist> | |
8805 | </method> | |
8806 | <method name="GetPixel" type="long" overloaded="no"> | |
781d2982 | 8807 | <autodoc>GetPixel(self) -> long</autodoc> |
c2dda882 | 8808 | <docstring>Returns a pixel value which is platform-dependent. On Windows, a |
781d2982 RD |
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> | |
c2dda882 | 8811 | </method> |
f32fc4bc | 8812 | <method name="__eq__" type="bool" overloaded="no"> |
781d2982 | 8813 | <autodoc>__eq__(self, Colour colour) -> bool</autodoc> |
c2dda882 | 8814 | <docstring>Compare colours for equality</docstring> |
f32fc4bc RD |
8815 | <paramlist> |
8816 | <param name="colour" type="Colour" default=""/> | |
8817 | </paramlist> | |
8818 | </method> | |
8819 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 8820 | <autodoc>__ne__(self, Colour colour) -> bool</autodoc> |
c2dda882 | 8821 | <docstring>Compare colours for inequality</docstring> |
f32fc4bc RD |
8822 | <paramlist> |
8823 | <param name="colour" type="Colour" default=""/> | |
8824 | </paramlist> | |
8825 | </method> | |
f32fc4bc | 8826 | <method name="Get" type="PyObject" overloaded="no"> |
c2dda882 RD |
8827 | <autodoc>Get() -> (r, g, b)</autodoc> |
8828 | <docstring>Returns the RGB intensity values as a tuple.</docstring> | |
8829 | </method> | |
8830 | <method name="GetRGB" type="unsigned long" overloaded="no"> | |
781d2982 | 8831 | <autodoc>GetRGB(self) -> unsigned long</autodoc> |
c2dda882 | 8832 | <docstring>Return the colour as a packed RGB value</docstring> |
f32fc4bc RD |
8833 | </method> |
8834 | </class> | |
856bf319 | 8835 | <pythoncode> |
856bf319 RD |
8836 | Color = Colour |
8837 | NamedColor = NamedColour | |
8838 | ColorRGB = ColourRGB | |
8839 | </pythoncode> | |
781d2982 | 8840 | <class name="Palette" oldname="wxPalette" module="_gdi"> |
f32fc4bc RD |
8841 | <baseclass name="GDIObject"/> |
8842 | <constructor name="Palette" overloaded="no"> | |
781d2982 | 8843 | <autodoc>__init__(self, int n, unsigned char red, unsigned char green, unsigned char blue) -> Palette</autodoc> |
f32fc4bc RD |
8844 | <paramlist> |
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=""/> | |
8849 | </paramlist> | |
8850 | </constructor> | |
8851 | <destructor name="~wxPalette" overloaded="no"> | |
781d2982 | 8852 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
8853 | </destructor> |
8854 | <method name="GetPixel" type="int" overloaded="no"> | |
781d2982 | 8855 | <autodoc>GetPixel(self, byte red, byte green, byte blue) -> int</autodoc> |
f32fc4bc RD |
8856 | <paramlist> |
8857 | <param name="red" type="byte" default=""/> | |
8858 | <param name="green" type="byte" default=""/> | |
8859 | <param name="blue" type="byte" default=""/> | |
8860 | </paramlist> | |
8861 | </method> | |
8862 | <method name="GetRGB" type="bool" overloaded="no"> | |
8863 | <autodoc>GetRGB(int pixel) -> (R,G,B)</autodoc> | |
8864 | <paramlist> | |
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=""/> | |
8869 | </paramlist> | |
8870 | </method> | |
8871 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 8872 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
8873 | </method> |
8874 | </class> | |
8875 | <pythoncode> | |
856bf319 RD |
8876 | #--------------------------------------------------------------------------- |
8877 | </pythoncode> | |
781d2982 | 8878 | <class name="Pen" oldname="wxPen" module="_gdi"> |
f32fc4bc RD |
8879 | <baseclass name="GDIObject"/> |
8880 | <constructor name="Pen" overloaded="no"> | |
781d2982 | 8881 | <autodoc>__init__(self, Colour colour, int width=1, int style=SOLID) -> Pen</autodoc> |
f32fc4bc RD |
8882 | <paramlist> |
8883 | <param name="colour" type="Colour" default=""/> | |
8884 | <param name="width" type="int" default="1"/> | |
8885 | <param name="style" type="int" default="wxSOLID"/> | |
8886 | </paramlist> | |
8887 | </constructor> | |
8888 | <destructor name="~wxPen" overloaded="no"> | |
781d2982 | 8889 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
8890 | </destructor> |
8891 | <method name="GetCap" type="int" overloaded="no"> | |
781d2982 | 8892 | <autodoc>GetCap(self) -> int</autodoc> |
f32fc4bc RD |
8893 | </method> |
8894 | <method name="GetColour" type="Colour" overloaded="no"> | |
781d2982 | 8895 | <autodoc>GetColour(self) -> Colour</autodoc> |
f32fc4bc RD |
8896 | </method> |
8897 | <method name="GetJoin" type="int" overloaded="no"> | |
781d2982 | 8898 | <autodoc>GetJoin(self) -> int</autodoc> |
f32fc4bc RD |
8899 | </method> |
8900 | <method name="GetStyle" type="int" overloaded="no"> | |
781d2982 | 8901 | <autodoc>GetStyle(self) -> int</autodoc> |
f32fc4bc RD |
8902 | </method> |
8903 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 8904 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
8905 | </method> |
8906 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 8907 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
8908 | </method> |
8909 | <method name="SetCap" type="" overloaded="no"> | |
781d2982 | 8910 | <autodoc>SetCap(self, int cap_style)</autodoc> |
f32fc4bc RD |
8911 | <paramlist> |
8912 | <param name="cap_style" type="int" default=""/> | |
8913 | </paramlist> | |
8914 | </method> | |
8915 | <method name="SetColour" type="" overloaded="no"> | |
781d2982 | 8916 | <autodoc>SetColour(self, Colour colour)</autodoc> |
f32fc4bc RD |
8917 | <paramlist> |
8918 | <param name="colour" type="Colour" default=""/> | |
8919 | </paramlist> | |
8920 | </method> | |
8921 | <method name="SetJoin" type="" overloaded="no"> | |
781d2982 | 8922 | <autodoc>SetJoin(self, int join_style)</autodoc> |
f32fc4bc RD |
8923 | <paramlist> |
8924 | <param name="join_style" type="int" default=""/> | |
8925 | </paramlist> | |
8926 | </method> | |
8927 | <method name="SetStyle" type="" overloaded="no"> | |
781d2982 | 8928 | <autodoc>SetStyle(self, int style)</autodoc> |
f32fc4bc RD |
8929 | <paramlist> |
8930 | <param name="style" type="int" default=""/> | |
8931 | </paramlist> | |
8932 | </method> | |
8933 | <method name="SetWidth" type="" overloaded="no"> | |
781d2982 | 8934 | <autodoc>SetWidth(self, int width)</autodoc> |
f32fc4bc RD |
8935 | <paramlist> |
8936 | <param name="width" type="int" default=""/> | |
8937 | </paramlist> | |
8938 | </method> | |
8939 | <method name="SetDashes" type="" overloaded="no"> | |
781d2982 | 8940 | <autodoc>SetDashes(self, int dashes, wxDash dashes_array)</autodoc> |
f32fc4bc RD |
8941 | <paramlist> |
8942 | <param name="dashes" type="int" default=""/> | |
8943 | <param name="dashes_array" type="wxDash" default=""/> | |
8944 | </paramlist> | |
8945 | </method> | |
8946 | <method name="GetDashes" type="PyObject" overloaded="no"> | |
781d2982 | 8947 | <autodoc>GetDashes(self) -> PyObject</autodoc> |
c2dda882 | 8948 | </method> |
781d2982 RD |
8949 | <method name="_SetDashes" type="" overloaded="no"> |
8950 | <autodoc>_SetDashes(self, PyObject _self, PyObject pyDashes)</autodoc> | |
c2dda882 | 8951 | <paramlist> |
781d2982 RD |
8952 | <param name="_self" type="PyObject" default=""/> |
8953 | <param name="pyDashes" type="PyObject" default=""/> | |
f32fc4bc RD |
8954 | </paramlist> |
8955 | </method> | |
8956 | <method name="GetDashCount" type="int" overloaded="no"> | |
781d2982 | 8957 | <autodoc>GetDashCount(self) -> int</autodoc> |
f32fc4bc | 8958 | </method> |
781d2982 RD |
8959 | <method name="__eq__" type="bool" overloaded="no"> |
8960 | <autodoc>__eq__(self, Pen other) -> bool</autodoc> | |
f32fc4bc | 8961 | <paramlist> |
781d2982 | 8962 | <param name="other" type="Pen" default=""/> |
f32fc4bc | 8963 | </paramlist> |
781d2982 RD |
8964 | </method> |
8965 | <method name="__ne__" type="bool" overloaded="no"> | |
8966 | <autodoc>__ne__(self, Pen other) -> bool</autodoc> | |
f32fc4bc | 8967 | <paramlist> |
781d2982 | 8968 | <param name="other" type="Pen" default=""/> |
f32fc4bc RD |
8969 | </paramlist> |
8970 | </method> | |
8971 | </class> | |
f32fc4bc | 8972 | <pythoncode> |
856bf319 RD |
8973 | #--------------------------------------------------------------------------- |
8974 | </pythoncode> | |
781d2982 RD |
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 | |
ce6878e6 RD |
8978 | a `wx.DC`. It has a colour and a style. |
8979 | ||
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. | |
8985 | ||
8986 | :note: On monochrome displays all brushes are white, unless the colour | |
8987 | really is black. | |
8988 | ||
8989 | :see: `wx.BrushList`, `wx.DC`, `wx.DC.SetBrush` | |
8990 | </docstring> | |
f32fc4bc RD |
8991 | <baseclass name="GDIObject"/> |
8992 | <constructor name="Brush" overloaded="no"> | |
781d2982 | 8993 | <autodoc>__init__(self, Colour colour, int style=SOLID) -> Brush</autodoc> |
ce6878e6 RD |
8994 | <docstring>Constructs a brush from a `wx.Colour` object and a style.The style parameter may be one of the following: |
8995 | ||
8996 | =================== ============================= | |
8997 | Style Meaning | |
8998 | =================== ============================= | |
8999 | wx.TRANSPARENT Transparent (no fill). | |
9000 | wx.SOLID Solid. | |
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 | =================== ============================= | |
9009 | ||
9010 | </docstring> | |
f32fc4bc RD |
9011 | <paramlist> |
9012 | <param name="colour" type="Colour" default=""/> | |
9013 | <param name="style" type="int" default="wxSOLID"/> | |
9014 | </paramlist> | |
9015 | </constructor> | |
9016 | <destructor name="~wxBrush" overloaded="no"> | |
781d2982 | 9017 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9018 | </destructor> |
9019 | <method name="SetColour" type="" overloaded="no"> | |
781d2982 RD |
9020 | <autodoc>SetColour(self, Colour col)</autodoc> |
9021 | <docstring>Set the brush's `wx.Colour`.</docstring> | |
f32fc4bc RD |
9022 | <paramlist> |
9023 | <param name="col" type="Colour" default=""/> | |
9024 | </paramlist> | |
9025 | </method> | |
9026 | <method name="SetStyle" type="" overloaded="no"> | |
781d2982 RD |
9027 | <autodoc>SetStyle(self, int style)</autodoc> |
9028 | <docstring>Sets the style of the brush. See `__init__` for a listing of styles.</docstring> | |
f32fc4bc RD |
9029 | <paramlist> |
9030 | <param name="style" type="int" default=""/> | |
9031 | </paramlist> | |
9032 | </method> | |
9033 | <method name="SetStipple" type="" overloaded="no"> | |
781d2982 RD |
9034 | <autodoc>SetStipple(self, Bitmap stipple)</autodoc> |
9035 | <docstring>Sets the stipple `wx.Bitmap`.</docstring> | |
f32fc4bc RD |
9036 | <paramlist> |
9037 | <param name="stipple" type="wxBitmap" default=""/> | |
9038 | </paramlist> | |
9039 | </method> | |
9040 | <method name="GetColour" type="Colour" overloaded="no"> | |
781d2982 RD |
9041 | <autodoc>GetColour(self) -> Colour</autodoc> |
9042 | <docstring>Returns the `wx.Colour` of the brush.</docstring> | |
f32fc4bc RD |
9043 | </method> |
9044 | <method name="GetStyle" type="int" overloaded="no"> | |
781d2982 RD |
9045 | <autodoc>GetStyle(self) -> int</autodoc> |
9046 | <docstring>Returns the style of the brush. See `__init__` for a listing of | |
9047 | styles.</docstring> | |
f32fc4bc RD |
9048 | </method> |
9049 | <method name="GetStipple" type="wxBitmap" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
9054 | </method> |
9055 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 RD |
9056 | <autodoc>Ok(self) -> bool</autodoc> |
9057 | <docstring>Returns True if the brush is initialised and valid.</docstring> | |
f32fc4bc RD |
9058 | </method> |
9059 | </class> | |
781d2982 RD |
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 | |
ce6878e6 RD |
9066 | to be used as a drawing surface. |
9067 | ||
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. | |
9072 | ||
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? | |
9076 | ||
9077 | :todo: Find a way to do very efficient PIL Image <--> wx.Bitmap | |
9078 | converstions. | |
9079 | </docstring> | |
f32fc4bc RD |
9080 | <baseclass name="GDIObject"/> |
9081 | <constructor name="Bitmap" overloaded="no"> | |
781d2982 | 9082 | <autodoc>__init__(self, String name, int type=BITMAP_TYPE_ANY) -> Bitmap</autodoc> |
ce6878e6 RD |
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 | |
9087 | loaded): | |
9088 | ||
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 | |
9105 | ||
9106 | :see: Alternate constructors `wx.EmptyBitmap`, `wx.BitmapFromIcon`, | |
9107 | `wx.BitmapFromImage`, `wx.BitmapFromXPMData`, | |
9108 | `wx.BitmapFromBits` | |
9109 | </docstring> | |
f32fc4bc RD |
9110 | <paramlist> |
9111 | <param name="name" type="String" default=""/> | |
9112 | <param name="type" type="wxBitmapType" default="wxBITMAP_TYPE_ANY"/> | |
9113 | </paramlist> | |
9114 | </constructor> | |
9115 | <constructor name="EmptyBitmap" overloaded="no"> | |
9116 | <autodoc>EmptyBitmap(int width, int height, int depth=-1) -> Bitmap</autodoc> | |
781d2982 RD |
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> | |
f32fc4bc RD |
9120 | <paramlist> |
9121 | <param name="width" type="int" default=""/> | |
9122 | <param name="height" type="int" default=""/> | |
9123 | <param name="depth" type="int" default="-1"/> | |
9124 | </paramlist> | |
9125 | </constructor> | |
9126 | <constructor name="BitmapFromIcon" overloaded="no"> | |
9127 | <autodoc>BitmapFromIcon(Icon icon) -> Bitmap</autodoc> | |
781d2982 | 9128 | <docstring>Create a new bitmap from a `wx.Icon` object.</docstring> |
f32fc4bc RD |
9129 | <paramlist> |
9130 | <param name="icon" type="wxIcon" default=""/> | |
9131 | </paramlist> | |
9132 | </constructor> | |
9133 | <constructor name="BitmapFromImage" overloaded="no"> | |
9134 | <autodoc>BitmapFromImage(Image image, int depth=-1) -> Bitmap</autodoc> | |
781d2982 RD |
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> | |
f32fc4bc RD |
9140 | <paramlist> |
9141 | <param name="image" type="Image" default=""/> | |
9142 | <param name="depth" type="int" default="-1"/> | |
9143 | </paramlist> | |
9144 | </constructor> | |
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> | |
9148 | <paramlist> | |
9149 | <param name="listOfStrings" type="PyObject" default=""/> | |
9150 | </paramlist> | |
9151 | </constructor> | |
9152 | <constructor name="BitmapFromBits" overloaded="no"> | |
9153 | <autodoc>BitmapFromBits(PyObject bits, int width, int height, int depth=1) -> Bitmap</autodoc> | |
781d2982 RD |
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> | |
f32fc4bc RD |
9158 | <paramlist> |
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"/> | |
9163 | </paramlist> | |
9164 | </constructor> | |
9165 | <destructor name="~wxBitmap" overloaded="no"> | |
781d2982 | 9166 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9167 | </destructor> |
9168 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 9169 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
9170 | </method> |
9171 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 9172 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
9173 | <docstring>Gets the width of the bitmap in pixels.</docstring> |
9174 | </method> | |
9175 | <method name="GetHeight" type="int" overloaded="no"> | |
781d2982 | 9176 | <autodoc>GetHeight(self) -> int</autodoc> |
f32fc4bc RD |
9177 | <docstring>Gets the height of the bitmap in pixels.</docstring> |
9178 | </method> | |
9179 | <method name="GetDepth" type="int" overloaded="no"> | |
781d2982 | 9180 | <autodoc>GetDepth(self) -> int</autodoc> |
f32fc4bc | 9181 | <docstring>Gets the colour depth of the bitmap. A value of 1 indicates a |
856bf319 | 9182 | monochrome bitmap.</docstring> |
f32fc4bc | 9183 | </method> |
781d2982 RD |
9184 | <method name="GetSize" type="Size" overloaded="no"> |
9185 | <autodoc>GetSize(self) -> Size</autodoc> | |
9186 | <docstring>Get the size of the bitmap.</docstring> | |
9187 | </method> | |
f32fc4bc | 9188 | <method name="ConvertToImage" type="Image" overloaded="no"> |
781d2982 RD |
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> | |
f32fc4bc RD |
9193 | </method> |
9194 | <method name="GetMask" type="wxMask" overloaded="no"> | |
781d2982 RD |
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. | |
9198 | ||
9199 | :see: `SetMask`, `wx.Mask` | |
9200 | </docstring> | |
f32fc4bc RD |
9201 | </method> |
9202 | <method name="SetMask" type="" overloaded="no"> | |
781d2982 RD |
9203 | <autodoc>SetMask(self, Mask mask)</autodoc> |
9204 | <docstring>Sets the mask for this bitmap. | |
9205 | ||
9206 | :see: `GetMask`, `wx.Mask` | |
9207 | </docstring> | |
f32fc4bc RD |
9208 | <paramlist> |
9209 | <param name="mask" type="wxMask" default=""/> | |
9210 | </paramlist> | |
9211 | </method> | |
9212 | <method name="SetMaskColour" type="" overloaded="no"> | |
781d2982 | 9213 | <autodoc>SetMaskColour(self, Colour colour)</autodoc> |
f32fc4bc RD |
9214 | <docstring>Create a Mask based on a specified colour in the Bitmap.</docstring> |
9215 | <paramlist> | |
9216 | <param name="colour" type="Colour" default=""/> | |
9217 | </paramlist> | |
9218 | </method> | |
9219 | <method name="GetSubBitmap" type="Bitmap" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
9224 | <paramlist> |
9225 | <param name="rect" type="Rect" default=""/> | |
9226 | </paramlist> | |
9227 | </method> | |
9228 | <method name="SaveFile" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
9232 | <paramlist> |
9233 | <param name="name" type="String" default=""/> | |
9234 | <param name="type" type="wxBitmapType" default=""/> | |
781d2982 | 9235 | <param name="palette" type="Palette" default="NULL"/> |
f32fc4bc RD |
9236 | </paramlist> |
9237 | </method> | |
9238 | <method name="LoadFile" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
9242 | <paramlist> |
9243 | <param name="name" type="String" default=""/> | |
9244 | <param name="type" type="wxBitmapType" default=""/> | |
9245 | </paramlist> | |
9246 | </method> | |
9247 | <method name="CopyFromIcon" type="bool" overloaded="no"> | |
781d2982 | 9248 | <autodoc>CopyFromIcon(self, Icon icon) -> bool</autodoc> |
f32fc4bc RD |
9249 | <paramlist> |
9250 | <param name="icon" type="wxIcon" default=""/> | |
9251 | </paramlist> | |
9252 | </method> | |
9253 | <method name="SetHeight" type="" overloaded="no"> | |
781d2982 RD |
9254 | <autodoc>SetHeight(self, int height)</autodoc> |
9255 | <docstring>Set the height property (does not affect the existing bitmap data).</docstring> | |
f32fc4bc RD |
9256 | <paramlist> |
9257 | <param name="height" type="int" default=""/> | |
9258 | </paramlist> | |
9259 | </method> | |
9260 | <method name="SetWidth" type="" overloaded="no"> | |
781d2982 RD |
9261 | <autodoc>SetWidth(self, int width)</autodoc> |
9262 | <docstring>Set the width property (does not affect the existing bitmap data).</docstring> | |
f32fc4bc RD |
9263 | <paramlist> |
9264 | <param name="width" type="int" default=""/> | |
9265 | </paramlist> | |
9266 | </method> | |
9267 | <method name="SetDepth" type="" overloaded="no"> | |
781d2982 RD |
9268 | <autodoc>SetDepth(self, int depth)</autodoc> |
9269 | <docstring>Set the depth property (does not affect the existing bitmap data).</docstring> | |
f32fc4bc RD |
9270 | <paramlist> |
9271 | <param name="depth" type="int" default=""/> | |
9272 | </paramlist> | |
9273 | </method> | |
781d2982 RD |
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> | |
9277 | <paramlist> | |
9278 | <param name="size" type="Size" default=""/> | |
9279 | </paramlist> | |
9280 | </method> | |
b39e211b | 9281 | <method name="__eq__" type="bool" overloaded="no"> |
781d2982 | 9282 | <autodoc>__eq__(self, Bitmap other) -> bool</autodoc> |
b39e211b RD |
9283 | <paramlist> |
9284 | <param name="other" type="Bitmap" default=""/> | |
9285 | </paramlist> | |
9286 | </method> | |
9287 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 9288 | <autodoc>__ne__(self, Bitmap other) -> bool</autodoc> |
b39e211b RD |
9289 | <paramlist> |
9290 | <param name="other" type="Bitmap" default=""/> | |
9291 | </paramlist> | |
9292 | </method> | |
f32fc4bc | 9293 | </class> |
781d2982 RD |
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. | |
9299 | ||
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 | |
9303 | mask.</docstring> | |
f32fc4bc RD |
9304 | <baseclass name="Object"/> |
9305 | <constructor name="Mask" overloaded="no"> | |
781d2982 RD |
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. | |
9312 | ||
9313 | :see: `wx.Bitmap`, `wx.Colour`</docstring> | |
f32fc4bc RD |
9314 | <paramlist> |
9315 | <param name="bitmap" type="Bitmap" default=""/> | |
9316 | <param name="colour" type="Colour" default="wxNullColour"/> | |
9317 | </paramlist> | |
9318 | </constructor> | |
9319 | </class> | |
781d2982 RD |
9320 | <pythoncode> MaskColour = wx._deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.") </pythoncode> |
9321 | <class name="Icon" oldname="wxIcon" module="_gdi"> | |
f32fc4bc RD |
9322 | <baseclass name="GDIObject"/> |
9323 | <constructor name="Icon" overloaded="no"> | |
781d2982 | 9324 | <autodoc>__init__(self, String name, int type, int desiredWidth=-1, int desiredHeight=-1) -> Icon</autodoc> |
f32fc4bc RD |
9325 | <paramlist> |
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"/> | |
9330 | </paramlist> | |
9331 | </constructor> | |
9332 | <constructor name="EmptyIcon" overloaded="no"> | |
9333 | <autodoc>EmptyIcon() -> Icon</autodoc> | |
9334 | </constructor> | |
9335 | <constructor name="IconFromLocation" overloaded="no"> | |
9336 | <autodoc>IconFromLocation(IconLocation loc) -> Icon</autodoc> | |
9337 | <paramlist> | |
9338 | <param name="loc" type="wxIconLocation" default=""/> | |
9339 | </paramlist> | |
9340 | </constructor> | |
9341 | <constructor name="IconFromBitmap" overloaded="no"> | |
9342 | <autodoc>IconFromBitmap(Bitmap bmp) -> Icon</autodoc> | |
9343 | <paramlist> | |
9344 | <param name="bmp" type="Bitmap" default=""/> | |
9345 | </paramlist> | |
9346 | </constructor> | |
9347 | <constructor name="IconFromXPMData" overloaded="no"> | |
9348 | <autodoc>IconFromXPMData(PyObject listOfStrings) -> Icon</autodoc> | |
9349 | <paramlist> | |
9350 | <param name="listOfStrings" type="PyObject" default=""/> | |
9351 | </paramlist> | |
9352 | </constructor> | |
9353 | <destructor name="~wxIcon" overloaded="no"> | |
781d2982 | 9354 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9355 | </destructor> |
9356 | <method name="LoadFile" type="bool" overloaded="no"> | |
781d2982 | 9357 | <autodoc>LoadFile(self, String name, int type) -> bool</autodoc> |
f32fc4bc RD |
9358 | <paramlist> |
9359 | <param name="name" type="String" default=""/> | |
9360 | <param name="type" type="wxBitmapType" default=""/> | |
9361 | </paramlist> | |
9362 | </method> | |
9363 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 9364 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
9365 | </method> |
9366 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 9367 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
9368 | </method> |
9369 | <method name="GetHeight" type="int" overloaded="no"> | |
781d2982 | 9370 | <autodoc>GetHeight(self) -> int</autodoc> |
f32fc4bc RD |
9371 | </method> |
9372 | <method name="GetDepth" type="int" overloaded="no"> | |
781d2982 | 9373 | <autodoc>GetDepth(self) -> int</autodoc> |
f32fc4bc RD |
9374 | </method> |
9375 | <method name="SetWidth" type="" overloaded="no"> | |
781d2982 | 9376 | <autodoc>SetWidth(self, int w)</autodoc> |
f32fc4bc RD |
9377 | <paramlist> |
9378 | <param name="w" type="int" default=""/> | |
9379 | </paramlist> | |
9380 | </method> | |
9381 | <method name="SetHeight" type="" overloaded="no"> | |
781d2982 | 9382 | <autodoc>SetHeight(self, int h)</autodoc> |
f32fc4bc RD |
9383 | <paramlist> |
9384 | <param name="h" type="int" default=""/> | |
9385 | </paramlist> | |
9386 | </method> | |
9387 | <method name="SetDepth" type="" overloaded="no"> | |
781d2982 | 9388 | <autodoc>SetDepth(self, int d)</autodoc> |
f32fc4bc RD |
9389 | <paramlist> |
9390 | <param name="d" type="int" default=""/> | |
9391 | </paramlist> | |
9392 | </method> | |
9393 | <method name="CopyFromBitmap" type="" overloaded="no"> | |
781d2982 | 9394 | <autodoc>CopyFromBitmap(self, Bitmap bmp)</autodoc> |
f32fc4bc RD |
9395 | <paramlist> |
9396 | <param name="bmp" type="Bitmap" default=""/> | |
9397 | </paramlist> | |
9398 | </method> | |
9399 | </class> | |
781d2982 | 9400 | <class name="IconLocation" oldname="wxIconLocation" module="_gdi"> |
f32fc4bc | 9401 | <constructor name="IconLocation" overloaded="no"> |
781d2982 | 9402 | <autodoc>__init__(self, String filename=&wxPyEmptyString, int num=0) -> IconLocation</autodoc> |
f32fc4bc RD |
9403 | <paramlist> |
9404 | <param name="filename" type="String" default="&wxPyEmptyString"/> | |
9405 | <param name="num" type="int" default="0"/> | |
9406 | </paramlist> | |
9407 | </constructor> | |
9408 | <destructor name="~wxIconLocation" overloaded="no"> | |
781d2982 | 9409 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9410 | </destructor> |
9411 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 9412 | <autodoc>IsOk(self) -> bool</autodoc> |
f32fc4bc RD |
9413 | </method> |
9414 | <method name="SetFileName" type="" overloaded="no"> | |
781d2982 | 9415 | <autodoc>SetFileName(self, String filename)</autodoc> |
f32fc4bc RD |
9416 | <paramlist> |
9417 | <param name="filename" type="String" default=""/> | |
9418 | </paramlist> | |
9419 | </method> | |
9420 | <method name="GetFileName" type="String" overloaded="no"> | |
781d2982 | 9421 | <autodoc>GetFileName(self) -> String</autodoc> |
f32fc4bc RD |
9422 | </method> |
9423 | <method name="SetIndex" type="" overloaded="no"> | |
781d2982 | 9424 | <autodoc>SetIndex(self, int num)</autodoc> |
f32fc4bc RD |
9425 | <paramlist> |
9426 | <param name="num" type="int" default=""/> | |
9427 | </paramlist> | |
9428 | </method> | |
9429 | <method name="GetIndex" type="int" overloaded="no"> | |
781d2982 | 9430 | <autodoc>GetIndex(self) -> int</autodoc> |
f32fc4bc RD |
9431 | </method> |
9432 | </class> | |
781d2982 | 9433 | <class name="IconBundle" oldname="wxIconBundle" module="_gdi"> |
f32fc4bc | 9434 | <constructor name="IconBundle" overloaded="no"> |
781d2982 | 9435 | <autodoc>__init__(self) -> IconBundle</autodoc> |
f32fc4bc RD |
9436 | </constructor> |
9437 | <constructor name="IconBundleFromFile" overloaded="no"> | |
9438 | <autodoc>IconBundleFromFile(String file, long type) -> IconBundle</autodoc> | |
9439 | <paramlist> | |
9440 | <param name="file" type="String" default=""/> | |
9441 | <param name="type" type="long" default=""/> | |
9442 | </paramlist> | |
9443 | </constructor> | |
9444 | <constructor name="IconBundleFromIcon" overloaded="no"> | |
9445 | <autodoc>IconBundleFromIcon(Icon icon) -> IconBundle</autodoc> | |
9446 | <paramlist> | |
9447 | <param name="icon" type="Icon" default=""/> | |
9448 | </paramlist> | |
9449 | </constructor> | |
9450 | <destructor name="~wxIconBundle" overloaded="no"> | |
781d2982 | 9451 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9452 | </destructor> |
9453 | <method name="AddIcon" type="" overloaded="no"> | |
781d2982 | 9454 | <autodoc>AddIcon(self, Icon icon)</autodoc> |
f32fc4bc RD |
9455 | <paramlist> |
9456 | <param name="icon" type="Icon" default=""/> | |
9457 | </paramlist> | |
9458 | </method> | |
9459 | <method name="AddIconFromFile" type="" overloaded="no"> | |
781d2982 | 9460 | <autodoc>AddIconFromFile(self, String file, long type)</autodoc> |
f32fc4bc RD |
9461 | <paramlist> |
9462 | <param name="file" type="String" default=""/> | |
9463 | <param name="type" type="long" default=""/> | |
9464 | </paramlist> | |
9465 | </method> | |
9466 | <method name="GetIcon" type="Icon" overloaded="no"> | |
781d2982 | 9467 | <autodoc>GetIcon(self, Size size) -> Icon</autodoc> |
f32fc4bc RD |
9468 | <paramlist> |
9469 | <param name="size" type="Size" default=""/> | |
9470 | </paramlist> | |
9471 | </method> | |
9472 | </class> | |
781d2982 RD |
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 | |
9476 | mouse click. | |
c2dda882 RD |
9477 | |
9478 | A single cursor object may be used in many windows (any subwindow | |
781d2982 RD |
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. | |
ce6878e6 RD |
9482 | |
9483 | ||
9484 | Stock Cursor IDs | |
9485 | ----------------- | |
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 | ======================== ====================================== | |
9515 | ||
781d2982 | 9516 | </docstring> |
f32fc4bc RD |
9517 | <baseclass name="GDIObject"/> |
9518 | <constructor name="Cursor" overloaded="no"> | |
781d2982 | 9519 | <autodoc>__init__(self, String cursorName, long type, int hotSpotX=0, int hotSpotY=0) -> Cursor</autodoc> |
c2dda882 | 9520 | <docstring>Construct a Cursor from a file. Specify the type of file using |
781d2982 RD |
9521 | wx.BITAMP_TYPE* constants, and specify the hotspot if not using a cur |
9522 | file. | |
c2dda882 | 9523 | |
781d2982 RD |
9524 | This constructor is not available on wxGTK, use ``wx.StockCursor``, |
9525 | ``wx.CursorFromImage``, or ``wx.CursorFromBits`` instead.</docstring> | |
f32fc4bc RD |
9526 | <paramlist> |
9527 | <param name="cursorName" type="String" default=""/> | |
c2dda882 | 9528 | <param name="type" type="long" default=""/> |
f32fc4bc RD |
9529 | <param name="hotSpotX" type="int" default="0"/> |
9530 | <param name="hotSpotY" type="int" default="0"/> | |
9531 | </paramlist> | |
9532 | </constructor> | |
9533 | <constructor name="StockCursor" overloaded="no"> | |
9534 | <autodoc>StockCursor(int id) -> Cursor</autodoc> | |
781d2982 RD |
9535 | <docstring>Create a cursor using one of the stock cursors. Note that not all |
9536 | cursors are available on all platforms.</docstring> | |
f32fc4bc RD |
9537 | <paramlist> |
9538 | <param name="id" type="int" default=""/> | |
9539 | </paramlist> | |
9540 | </constructor> | |
9541 | <constructor name="CursorFromImage" overloaded="no"> | |
9542 | <autodoc>CursorFromImage(Image image) -> Cursor</autodoc> | |
781d2982 RD |
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 | |
ce6878e6 RD |
9546 | transparent. |
9547 | In MSW the foreground will be white and the background | |
9548 | black. The cursor is resized to 32x32. | |
9549 | ||
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. | |
9552 | ||
9553 | On MacOS the cursor is resized to 16x16 and currently only shown as | |
9554 | black/white (mask respected).</docstring> | |
f32fc4bc RD |
9555 | <paramlist> |
9556 | <param name="image" type="Image" default=""/> | |
9557 | </paramlist> | |
9558 | </constructor> | |
f32fc4bc | 9559 | <destructor name="~wxCursor" overloaded="no"> |
781d2982 | 9560 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9561 | </destructor> |
9562 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 9563 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
9564 | </method> |
9565 | </class> | |
9566 | <pythoncode> | |
9567 | #--------------------------------------------------------------------------- | |
9568 | </pythoncode> | |
781d2982 | 9569 | <class name="Region" oldname="wxRegion" module="_gdi"> |
f32fc4bc RD |
9570 | <baseclass name="GDIObject"/> |
9571 | <constructor name="Region" overloaded="no"> | |
781d2982 | 9572 | <autodoc>__init__(self, int x=0, int y=0, int width=0, int height=0) -> Region</autodoc> |
f32fc4bc RD |
9573 | <paramlist> |
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"/> | |
9578 | </paramlist> | |
9579 | </constructor> | |
9580 | <constructor name="RegionFromBitmap" overloaded="no"> | |
ce6878e6 RD |
9581 | <autodoc>RegionFromBitmap(Bitmap bmp) -> Region</autodoc> |
9582 | <paramlist> | |
9583 | <param name="bmp" type="Bitmap" default=""/> | |
9584 | </paramlist> | |
9585 | </constructor> | |
9586 | <constructor name="RegionFromBitmapColour" overloaded="no"> | |
9587 | <autodoc>RegionFromBitmapColour(Bitmap bmp, Colour transColour, int tolerance=0) -> Region</autodoc> | |
f32fc4bc RD |
9588 | <paramlist> |
9589 | <param name="bmp" type="Bitmap" default=""/> | |
ce6878e6 | 9590 | <param name="transColour" type="Colour" default=""/> |
f32fc4bc RD |
9591 | <param name="tolerance" type="int" default="0"/> |
9592 | </paramlist> | |
9593 | </constructor> | |
9594 | <constructor name="RegionFromPoints" overloaded="no"> | |
9595 | <autodoc>RegionFromPoints(int points, Point points_array, int fillStyle=WINDING_RULE) -> Region</autodoc> | |
9596 | <paramlist> | |
9597 | <param name="points" type="int" default=""/> | |
9598 | <param name="points_array" type="Point" default=""/> | |
9599 | <param name="fillStyle" type="int" default="wxWINDING_RULE"/> | |
9600 | </paramlist> | |
9601 | </constructor> | |
9602 | <destructor name="~wxRegion" overloaded="no"> | |
781d2982 | 9603 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9604 | </destructor> |
9605 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 9606 | <autodoc>Clear(self)</autodoc> |
f32fc4bc RD |
9607 | </method> |
9608 | <method name="Offset" type="bool" overloaded="no"> | |
781d2982 | 9609 | <autodoc>Offset(self, int x, int y) -> bool</autodoc> |
f32fc4bc RD |
9610 | <paramlist> |
9611 | <param name="x" type="int" default=""/> | |
9612 | <param name="y" type="int" default=""/> | |
9613 | </paramlist> | |
9614 | </method> | |
9615 | <method name="Contains" type="wxRegionContain" overloaded="no"> | |
781d2982 | 9616 | <autodoc>Contains(self, int x, int y) -> int</autodoc> |
f32fc4bc RD |
9617 | <paramlist> |
9618 | <param name="x" type="int" default=""/> | |
9619 | <param name="y" type="int" default=""/> | |
9620 | </paramlist> | |
9621 | </method> | |
9622 | <method name="ContainsPoint" type="wxRegionContain" overloaded="no"> | |
781d2982 | 9623 | <autodoc>ContainsPoint(self, Point pt) -> int</autodoc> |
f32fc4bc RD |
9624 | <paramlist> |
9625 | <param name="pt" type="Point" default=""/> | |
9626 | </paramlist> | |
9627 | </method> | |
9628 | <method name="ContainsRect" type="wxRegionContain" overloaded="no"> | |
781d2982 | 9629 | <autodoc>ContainsRect(self, Rect rect) -> int</autodoc> |
f32fc4bc RD |
9630 | <paramlist> |
9631 | <param name="rect" type="Rect" default=""/> | |
9632 | </paramlist> | |
9633 | </method> | |
9634 | <method name="ContainsRectDim" type="wxRegionContain" overloaded="no"> | |
781d2982 | 9635 | <autodoc>ContainsRectDim(self, int x, int y, int w, int h) -> int</autodoc> |
f32fc4bc RD |
9636 | <paramlist> |
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=""/> | |
9641 | </paramlist> | |
9642 | </method> | |
9643 | <method name="GetBox" type="Rect" overloaded="no"> | |
781d2982 | 9644 | <autodoc>GetBox(self) -> Rect</autodoc> |
f32fc4bc RD |
9645 | </method> |
9646 | <method name="Intersect" type="bool" overloaded="no"> | |
781d2982 | 9647 | <autodoc>Intersect(self, int x, int y, int width, int height) -> bool</autodoc> |
f32fc4bc RD |
9648 | <paramlist> |
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=""/> | |
9653 | </paramlist> | |
9654 | </method> | |
9655 | <method name="IntersectRect" type="bool" overloaded="no"> | |
781d2982 | 9656 | <autodoc>IntersectRect(self, Rect rect) -> bool</autodoc> |
f32fc4bc RD |
9657 | <paramlist> |
9658 | <param name="rect" type="Rect" default=""/> | |
9659 | </paramlist> | |
9660 | </method> | |
9661 | <method name="IntersectRegion" type="bool" overloaded="no"> | |
781d2982 | 9662 | <autodoc>IntersectRegion(self, Region region) -> bool</autodoc> |
f32fc4bc RD |
9663 | <paramlist> |
9664 | <param name="region" type="Region" default=""/> | |
9665 | </paramlist> | |
9666 | </method> | |
9667 | <method name="IsEmpty" type="bool" overloaded="no"> | |
781d2982 | 9668 | <autodoc>IsEmpty(self) -> bool</autodoc> |
f32fc4bc RD |
9669 | </method> |
9670 | <method name="Union" type="bool" overloaded="no"> | |
781d2982 | 9671 | <autodoc>Union(self, int x, int y, int width, int height) -> bool</autodoc> |
f32fc4bc RD |
9672 | <paramlist> |
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=""/> | |
9677 | </paramlist> | |
9678 | </method> | |
9679 | <method name="UnionRect" type="bool" overloaded="no"> | |
781d2982 | 9680 | <autodoc>UnionRect(self, Rect rect) -> bool</autodoc> |
f32fc4bc RD |
9681 | <paramlist> |
9682 | <param name="rect" type="Rect" default=""/> | |
9683 | </paramlist> | |
9684 | </method> | |
9685 | <method name="UnionRegion" type="bool" overloaded="no"> | |
781d2982 | 9686 | <autodoc>UnionRegion(self, Region region) -> bool</autodoc> |
f32fc4bc RD |
9687 | <paramlist> |
9688 | <param name="region" type="Region" default=""/> | |
9689 | </paramlist> | |
9690 | </method> | |
9691 | <method name="Subtract" type="bool" overloaded="no"> | |
781d2982 | 9692 | <autodoc>Subtract(self, int x, int y, int width, int height) -> bool</autodoc> |
f32fc4bc RD |
9693 | <paramlist> |
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=""/> | |
9698 | </paramlist> | |
9699 | </method> | |
9700 | <method name="SubtractRect" type="bool" overloaded="no"> | |
781d2982 | 9701 | <autodoc>SubtractRect(self, Rect rect) -> bool</autodoc> |
f32fc4bc RD |
9702 | <paramlist> |
9703 | <param name="rect" type="Rect" default=""/> | |
9704 | </paramlist> | |
9705 | </method> | |
9706 | <method name="SubtractRegion" type="bool" overloaded="no"> | |
781d2982 | 9707 | <autodoc>SubtractRegion(self, Region region) -> bool</autodoc> |
f32fc4bc RD |
9708 | <paramlist> |
9709 | <param name="region" type="Region" default=""/> | |
9710 | </paramlist> | |
9711 | </method> | |
9712 | <method name="Xor" type="bool" overloaded="no"> | |
781d2982 | 9713 | <autodoc>Xor(self, int x, int y, int width, int height) -> bool</autodoc> |
f32fc4bc RD |
9714 | <paramlist> |
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=""/> | |
9719 | </paramlist> | |
9720 | </method> | |
9721 | <method name="XorRect" type="bool" overloaded="no"> | |
781d2982 | 9722 | <autodoc>XorRect(self, Rect rect) -> bool</autodoc> |
f32fc4bc RD |
9723 | <paramlist> |
9724 | <param name="rect" type="Rect" default=""/> | |
9725 | </paramlist> | |
9726 | </method> | |
9727 | <method name="XorRegion" type="bool" overloaded="no"> | |
781d2982 | 9728 | <autodoc>XorRegion(self, Region region) -> bool</autodoc> |
f32fc4bc RD |
9729 | <paramlist> |
9730 | <param name="region" type="Region" default=""/> | |
9731 | </paramlist> | |
9732 | </method> | |
9733 | <method name="ConvertToBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 9734 | <autodoc>ConvertToBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
9735 | </method> |
9736 | <method name="UnionBitmap" type="bool" overloaded="no"> | |
ce6878e6 | 9737 | <autodoc>UnionBitmap(self, Bitmap bmp) -> bool</autodoc> |
f32fc4bc RD |
9738 | <paramlist> |
9739 | <param name="bmp" type="Bitmap" default=""/> | |
ce6878e6 RD |
9740 | </paramlist> |
9741 | </method> | |
9742 | <method name="UnionBitmapColour" type="bool" overloaded="no"> | |
9743 | <autodoc>UnionBitmapColour(self, Bitmap bmp, Colour transColour, int tolerance=0) -> bool</autodoc> | |
9744 | <paramlist> | |
9745 | <param name="bmp" type="Bitmap" default=""/> | |
9746 | <param name="transColour" type="Colour" default=""/> | |
f32fc4bc RD |
9747 | <param name="tolerance" type="int" default="0"/> |
9748 | </paramlist> | |
9749 | </method> | |
9750 | </class> | |
781d2982 | 9751 | <class name="RegionIterator" oldname="wxRegionIterator" module="_gdi"> |
f32fc4bc RD |
9752 | <baseclass name="Object"/> |
9753 | <constructor name="RegionIterator" overloaded="no"> | |
781d2982 | 9754 | <autodoc>__init__(self, Region region) -> RegionIterator</autodoc> |
f32fc4bc RD |
9755 | <paramlist> |
9756 | <param name="region" type="Region" default=""/> | |
9757 | </paramlist> | |
9758 | </constructor> | |
9759 | <destructor name="~wxRegionIterator" overloaded="no"> | |
781d2982 | 9760 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9761 | </destructor> |
9762 | <method name="GetX" type="int" overloaded="no"> | |
781d2982 | 9763 | <autodoc>GetX(self) -> int</autodoc> |
f32fc4bc RD |
9764 | </method> |
9765 | <method name="GetY" type="int" overloaded="no"> | |
781d2982 | 9766 | <autodoc>GetY(self) -> int</autodoc> |
f32fc4bc RD |
9767 | </method> |
9768 | <method name="GetW" type="int" overloaded="no"> | |
781d2982 | 9769 | <autodoc>GetW(self) -> int</autodoc> |
f32fc4bc RD |
9770 | </method> |
9771 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 9772 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
9773 | </method> |
9774 | <method name="GetH" type="int" overloaded="no"> | |
781d2982 | 9775 | <autodoc>GetH(self) -> int</autodoc> |
f32fc4bc RD |
9776 | </method> |
9777 | <method name="GetHeight" type="int" overloaded="no"> | |
781d2982 | 9778 | <autodoc>GetHeight(self) -> int</autodoc> |
f32fc4bc RD |
9779 | </method> |
9780 | <method name="GetRect" type="Rect" overloaded="no"> | |
781d2982 | 9781 | <autodoc>GetRect(self) -> Rect</autodoc> |
f32fc4bc RD |
9782 | </method> |
9783 | <method name="HaveRects" type="bool" overloaded="no"> | |
781d2982 | 9784 | <autodoc>HaveRects(self) -> bool</autodoc> |
f32fc4bc RD |
9785 | </method> |
9786 | <method name="Reset" type="" overloaded="no"> | |
781d2982 | 9787 | <autodoc>Reset(self)</autodoc> |
f32fc4bc RD |
9788 | </method> |
9789 | <method name="Next" type="" overloaded="no"> | |
781d2982 | 9790 | <autodoc>Next(self)</autodoc> |
f32fc4bc RD |
9791 | </method> |
9792 | <method name="__nonzero__" type="bool" overloaded="no"> | |
781d2982 | 9793 | <autodoc>__nonzero__(self) -> bool</autodoc> |
f32fc4bc RD |
9794 | </method> |
9795 | </class> | |
9796 | <pythoncode> | |
9797 | #--------------------------------------------------------------------------- | |
9798 | </pythoncode> | |
9799 | <pythoncode> | |
9800 | #--------------------------------------------------------------------------- | |
9801 | </pythoncode> | |
781d2982 | 9802 | <class name="NativeFontInfo" oldname="wxNativeFontInfo" module="_gdi"> |
f32fc4bc | 9803 | <constructor name="NativeFontInfo" overloaded="no"> |
781d2982 | 9804 | <autodoc>__init__(self) -> NativeFontInfo</autodoc> |
f32fc4bc RD |
9805 | </constructor> |
9806 | <destructor name="~wxNativeFontInfo" overloaded="no"> | |
781d2982 | 9807 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9808 | </destructor> |
9809 | <method name="Init" type="" overloaded="no"> | |
781d2982 | 9810 | <autodoc>Init(self)</autodoc> |
f32fc4bc RD |
9811 | </method> |
9812 | <method name="InitFromFont" type="" overloaded="no"> | |
781d2982 | 9813 | <autodoc>InitFromFont(self, Font font)</autodoc> |
f32fc4bc RD |
9814 | <paramlist> |
9815 | <param name="font" type="wxFont" default=""/> | |
9816 | </paramlist> | |
9817 | </method> | |
9818 | <method name="GetPointSize" type="int" overloaded="no"> | |
781d2982 | 9819 | <autodoc>GetPointSize(self) -> int</autodoc> |
f32fc4bc RD |
9820 | </method> |
9821 | <method name="GetStyle" type="wxFontStyle" overloaded="no"> | |
781d2982 | 9822 | <autodoc>GetStyle(self) -> int</autodoc> |
f32fc4bc RD |
9823 | </method> |
9824 | <method name="GetWeight" type="wxFontWeight" overloaded="no"> | |
781d2982 | 9825 | <autodoc>GetWeight(self) -> int</autodoc> |
f32fc4bc RD |
9826 | </method> |
9827 | <method name="GetUnderlined" type="bool" overloaded="no"> | |
781d2982 | 9828 | <autodoc>GetUnderlined(self) -> bool</autodoc> |
f32fc4bc RD |
9829 | </method> |
9830 | <method name="GetFaceName" type="String" overloaded="no"> | |
781d2982 | 9831 | <autodoc>GetFaceName(self) -> String</autodoc> |
f32fc4bc RD |
9832 | </method> |
9833 | <method name="GetFamily" type="wxFontFamily" overloaded="no"> | |
781d2982 | 9834 | <autodoc>GetFamily(self) -> int</autodoc> |
f32fc4bc RD |
9835 | </method> |
9836 | <method name="GetEncoding" type="wxFontEncoding" overloaded="no"> | |
781d2982 | 9837 | <autodoc>GetEncoding(self) -> int</autodoc> |
f32fc4bc RD |
9838 | </method> |
9839 | <method name="SetPointSize" type="" overloaded="no"> | |
781d2982 | 9840 | <autodoc>SetPointSize(self, int pointsize)</autodoc> |
f32fc4bc RD |
9841 | <paramlist> |
9842 | <param name="pointsize" type="int" default=""/> | |
9843 | </paramlist> | |
9844 | </method> | |
9845 | <method name="SetStyle" type="" overloaded="no"> | |
781d2982 | 9846 | <autodoc>SetStyle(self, int style)</autodoc> |
f32fc4bc RD |
9847 | <paramlist> |
9848 | <param name="style" type="wxFontStyle" default=""/> | |
9849 | </paramlist> | |
9850 | </method> | |
9851 | <method name="SetWeight" type="" overloaded="no"> | |
781d2982 | 9852 | <autodoc>SetWeight(self, int weight)</autodoc> |
f32fc4bc RD |
9853 | <paramlist> |
9854 | <param name="weight" type="wxFontWeight" default=""/> | |
9855 | </paramlist> | |
9856 | </method> | |
9857 | <method name="SetUnderlined" type="" overloaded="no"> | |
781d2982 | 9858 | <autodoc>SetUnderlined(self, bool underlined)</autodoc> |
f32fc4bc RD |
9859 | <paramlist> |
9860 | <param name="underlined" type="bool" default=""/> | |
9861 | </paramlist> | |
9862 | </method> | |
9863 | <method name="SetFaceName" type="" overloaded="no"> | |
781d2982 | 9864 | <autodoc>SetFaceName(self, String facename)</autodoc> |
f32fc4bc RD |
9865 | <paramlist> |
9866 | <param name="facename" type="String" default=""/> | |
9867 | </paramlist> | |
9868 | </method> | |
9869 | <method name="SetFamily" type="" overloaded="no"> | |
781d2982 | 9870 | <autodoc>SetFamily(self, int family)</autodoc> |
f32fc4bc RD |
9871 | <paramlist> |
9872 | <param name="family" type="wxFontFamily" default=""/> | |
9873 | </paramlist> | |
9874 | </method> | |
9875 | <method name="SetEncoding" type="" overloaded="no"> | |
781d2982 | 9876 | <autodoc>SetEncoding(self, int encoding)</autodoc> |
f32fc4bc RD |
9877 | <paramlist> |
9878 | <param name="encoding" type="wxFontEncoding" default=""/> | |
9879 | </paramlist> | |
9880 | </method> | |
9881 | <method name="FromString" type="bool" overloaded="no"> | |
781d2982 | 9882 | <autodoc>FromString(self, String s) -> bool</autodoc> |
f32fc4bc RD |
9883 | <paramlist> |
9884 | <param name="s" type="String" default=""/> | |
9885 | </paramlist> | |
9886 | </method> | |
9887 | <method name="ToString" type="String" overloaded="no"> | |
781d2982 | 9888 | <autodoc>ToString(self) -> String</autodoc> |
f32fc4bc RD |
9889 | </method> |
9890 | <method name="__str__" type="String" overloaded="no"> | |
781d2982 | 9891 | <autodoc>__str__(self) -> String</autodoc> |
f32fc4bc RD |
9892 | </method> |
9893 | <method name="FromUserString" type="bool" overloaded="no"> | |
781d2982 | 9894 | <autodoc>FromUserString(self, String s) -> bool</autodoc> |
f32fc4bc RD |
9895 | <paramlist> |
9896 | <param name="s" type="String" default=""/> | |
9897 | </paramlist> | |
9898 | </method> | |
9899 | <method name="ToUserString" type="String" overloaded="no"> | |
781d2982 | 9900 | <autodoc>ToUserString(self) -> String</autodoc> |
f32fc4bc RD |
9901 | </method> |
9902 | </class> | |
781d2982 | 9903 | <class name="NativeEncodingInfo" oldname="wxNativeEncodingInfo" module="_gdi"> |
f32fc4bc | 9904 | <constructor name="NativeEncodingInfo" overloaded="no"> |
781d2982 | 9905 | <autodoc>__init__(self) -> NativeEncodingInfo</autodoc> |
f32fc4bc RD |
9906 | </constructor> |
9907 | <destructor name="~wxNativeEncodingInfo" overloaded="no"> | |
781d2982 | 9908 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9909 | </destructor> |
9910 | <property name="facename" type="String" readonly="no"/> | |
9911 | <property name="encoding" type="wxFontEncoding" readonly="no"/> | |
9912 | <method name="FromString" type="bool" overloaded="no"> | |
781d2982 | 9913 | <autodoc>FromString(self, String s) -> bool</autodoc> |
f32fc4bc RD |
9914 | <paramlist> |
9915 | <param name="s" type="String" default=""/> | |
9916 | </paramlist> | |
9917 | </method> | |
9918 | <method name="ToString" type="String" overloaded="no"> | |
781d2982 | 9919 | <autodoc>ToString(self) -> String</autodoc> |
f32fc4bc RD |
9920 | </method> |
9921 | </class> | |
9922 | <method name="GetNativeFontEncoding" oldname="wxGetNativeFontEncoding" type="NativeEncodingInfo" overloaded="no"> | |
9923 | <autodoc>GetNativeFontEncoding(int encoding) -> NativeEncodingInfo</autodoc> | |
856bf319 | 9924 | <paramlist> |
f32fc4bc | 9925 | <param name="encoding" type="wxFontEncoding" default=""/> |
856bf319 RD |
9926 | </paramlist> |
9927 | </method> | |
f32fc4bc RD |
9928 | <method name="TestFontEncoding" oldname="wxTestFontEncoding" type="bool" overloaded="no"> |
9929 | <autodoc>TestFontEncoding(NativeEncodingInfo info) -> bool</autodoc> | |
856bf319 | 9930 | <paramlist> |
f32fc4bc | 9931 | <param name="info" type="NativeEncodingInfo" default=""/> |
856bf319 RD |
9932 | </paramlist> |
9933 | </method> | |
f32fc4bc RD |
9934 | <pythoncode> |
9935 | #--------------------------------------------------------------------------- | |
9936 | </pythoncode> | |
781d2982 | 9937 | <class name="FontMapper" oldname="wxFontMapper" module="_gdi"> |
f32fc4bc | 9938 | <constructor name="FontMapper" overloaded="no"> |
781d2982 | 9939 | <autodoc>__init__(self) -> FontMapper</autodoc> |
f32fc4bc RD |
9940 | </constructor> |
9941 | <destructor name="~wxFontMapper" overloaded="no"> | |
781d2982 | 9942 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
9943 | </destructor> |
9944 | <staticmethod name="Get" type="FontMapper" overloaded="no"> | |
9945 | <autodoc>Get() -> FontMapper</autodoc> | |
9946 | </staticmethod> | |
9947 | <staticmethod name="Set" type="FontMapper" overloaded="no"> | |
9948 | <autodoc>Set(FontMapper mapper) -> FontMapper</autodoc> | |
9949 | <paramlist> | |
9950 | <param name="mapper" type="FontMapper" default=""/> | |
9951 | </paramlist> | |
9952 | </staticmethod> | |
9953 | <method name="CharsetToEncoding" type="wxFontEncoding" overloaded="no"> | |
781d2982 | 9954 | <autodoc>CharsetToEncoding(self, String charset, bool interactive=True) -> int</autodoc> |
f32fc4bc RD |
9955 | <paramlist> |
9956 | <param name="charset" type="String" default=""/> | |
9957 | <param name="interactive" type="bool" default="True"/> | |
9958 | </paramlist> | |
9959 | </method> | |
9960 | <staticmethod name="GetSupportedEncodingsCount" type="size_t" overloaded="no"> | |
9961 | <autodoc>GetSupportedEncodingsCount() -> size_t</autodoc> | |
9962 | </staticmethod> | |
9963 | <staticmethod name="GetEncoding" type="wxFontEncoding" overloaded="no"> | |
9964 | <autodoc>GetEncoding(size_t n) -> int</autodoc> | |
9965 | <paramlist> | |
9966 | <param name="n" type="size_t" default=""/> | |
9967 | </paramlist> | |
9968 | </staticmethod> | |
9969 | <staticmethod name="GetEncodingName" type="String" overloaded="no"> | |
9970 | <autodoc>GetEncodingName(int encoding) -> String</autodoc> | |
9971 | <paramlist> | |
9972 | <param name="encoding" type="wxFontEncoding" default=""/> | |
9973 | </paramlist> | |
9974 | </staticmethod> | |
9975 | <staticmethod name="GetEncodingDescription" type="String" overloaded="no"> | |
9976 | <autodoc>GetEncodingDescription(int encoding) -> String</autodoc> | |
9977 | <paramlist> | |
9978 | <param name="encoding" type="wxFontEncoding" default=""/> | |
9979 | </paramlist> | |
9980 | </staticmethod> | |
781d2982 RD |
9981 | <staticmethod name="GetEncodingFromName" type="wxFontEncoding" overloaded="no"> |
9982 | <autodoc>GetEncodingFromName(String name) -> int</autodoc> | |
9983 | <paramlist> | |
9984 | <param name="name" type="String" default=""/> | |
9985 | </paramlist> | |
9986 | </staticmethod> | |
f32fc4bc | 9987 | <method name="SetConfig" type="" overloaded="no"> |
781d2982 | 9988 | <autodoc>SetConfig(self, ConfigBase config)</autodoc> |
f32fc4bc RD |
9989 | <paramlist> |
9990 | <param name="config" type="wxConfigBase" default=""/> | |
9991 | </paramlist> | |
9992 | </method> | |
9993 | <method name="SetConfigPath" type="" overloaded="no"> | |
781d2982 | 9994 | <autodoc>SetConfigPath(self, String prefix)</autodoc> |
f32fc4bc RD |
9995 | <paramlist> |
9996 | <param name="prefix" type="String" default=""/> | |
9997 | </paramlist> | |
9998 | </method> | |
9999 | <staticmethod name="GetDefaultConfigPath" type="String" overloaded="no"> | |
10000 | <autodoc>GetDefaultConfigPath() -> String</autodoc> | |
10001 | </staticmethod> | |
10002 | <method name="GetAltForEncoding" type="PyObject" overloaded="no"> | |
781d2982 | 10003 | <autodoc>GetAltForEncoding(self, int encoding, String facename=EmptyString, bool interactive=True) -> PyObject</autodoc> |
f32fc4bc RD |
10004 | <paramlist> |
10005 | <param name="encoding" type="wxFontEncoding" default=""/> | |
10006 | <param name="facename" type="String" default="wxPyEmptyString"/> | |
10007 | <param name="interactive" type="bool" default="True"/> | |
10008 | </paramlist> | |
10009 | </method> | |
10010 | <method name="IsEncodingAvailable" type="bool" overloaded="no"> | |
781d2982 | 10011 | <autodoc>IsEncodingAvailable(self, int encoding, String facename=EmptyString) -> bool</autodoc> |
f32fc4bc RD |
10012 | <paramlist> |
10013 | <param name="encoding" type="wxFontEncoding" default=""/> | |
10014 | <param name="facename" type="String" default="wxPyEmptyString"/> | |
10015 | </paramlist> | |
10016 | </method> | |
10017 | <method name="SetDialogParent" type="" overloaded="no"> | |
781d2982 | 10018 | <autodoc>SetDialogParent(self, Window parent)</autodoc> |
f32fc4bc RD |
10019 | <paramlist> |
10020 | <param name="parent" type="Window" default=""/> | |
10021 | </paramlist> | |
10022 | </method> | |
10023 | <method name="SetDialogTitle" type="" overloaded="no"> | |
781d2982 | 10024 | <autodoc>SetDialogTitle(self, String title)</autodoc> |
f32fc4bc RD |
10025 | <paramlist> |
10026 | <param name="title" type="String" default=""/> | |
10027 | </paramlist> | |
10028 | </method> | |
10029 | </class> | |
10030 | <pythoncode> | |
10031 | #--------------------------------------------------------------------------- | |
10032 | </pythoncode> | |
781d2982 | 10033 | <class name="Font" oldname="wxFont" module="_gdi"> |
f32fc4bc RD |
10034 | <baseclass name="GDIObject"/> |
10035 | <constructor name="Font" overloaded="no"> | |
781d2982 | 10036 | <autodoc>__init__(self, int pointSize, int family, int style, int weight, bool underline=False, |
f32fc4bc RD |
10037 | String face=EmptyString, |
10038 | int encoding=FONTENCODING_DEFAULT) -> Font</autodoc> | |
10039 | <paramlist> | |
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"/> | |
10047 | </paramlist> | |
10048 | </constructor> | |
10049 | <constructor name="FontFromNativeInfo" overloaded="no"> | |
10050 | <autodoc>FontFromNativeInfo(NativeFontInfo info) -> Font</autodoc> | |
10051 | <paramlist> | |
10052 | <param name="info" type="NativeFontInfo" default=""/> | |
10053 | </paramlist> | |
10054 | </constructor> | |
10055 | <constructor name="FontFromNativeInfoString" overloaded="no"> | |
10056 | <autodoc>FontFromNativeInfoString(String info) -> Font</autodoc> | |
10057 | <paramlist> | |
10058 | <param name="info" type="String" default=""/> | |
10059 | </paramlist> | |
10060 | </constructor> | |
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> | |
10064 | <paramlist> | |
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"/> | |
10070 | </paramlist> | |
10071 | </constructor> | |
10072 | <destructor name="~wxFont" overloaded="no"> | |
781d2982 | 10073 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
10074 | </destructor> |
10075 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 10076 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
10077 | </method> |
10078 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 10079 | <autodoc>__eq__(self, Font other) -> bool</autodoc> |
f32fc4bc | 10080 | <paramlist> |
c2dda882 | 10081 | <param name="other" type="Font" default=""/> |
f32fc4bc RD |
10082 | </paramlist> |
10083 | </method> | |
10084 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 10085 | <autodoc>__ne__(self, Font other) -> bool</autodoc> |
f32fc4bc | 10086 | <paramlist> |
c2dda882 | 10087 | <param name="other" type="Font" default=""/> |
f32fc4bc RD |
10088 | </paramlist> |
10089 | </method> | |
10090 | <method name="GetPointSize" type="int" overloaded="no"> | |
781d2982 | 10091 | <autodoc>GetPointSize(self) -> int</autodoc> |
f32fc4bc RD |
10092 | </method> |
10093 | <method name="GetFamily" type="int" overloaded="no"> | |
781d2982 | 10094 | <autodoc>GetFamily(self) -> int</autodoc> |
f32fc4bc RD |
10095 | </method> |
10096 | <method name="GetStyle" type="int" overloaded="no"> | |
781d2982 | 10097 | <autodoc>GetStyle(self) -> int</autodoc> |
f32fc4bc RD |
10098 | </method> |
10099 | <method name="GetWeight" type="int" overloaded="no"> | |
781d2982 | 10100 | <autodoc>GetWeight(self) -> int</autodoc> |
f32fc4bc RD |
10101 | </method> |
10102 | <method name="GetUnderlined" type="bool" overloaded="no"> | |
781d2982 | 10103 | <autodoc>GetUnderlined(self) -> bool</autodoc> |
f32fc4bc RD |
10104 | </method> |
10105 | <method name="GetFaceName" type="String" overloaded="no"> | |
781d2982 | 10106 | <autodoc>GetFaceName(self) -> String</autodoc> |
f32fc4bc RD |
10107 | </method> |
10108 | <method name="GetEncoding" type="wxFontEncoding" overloaded="no"> | |
781d2982 | 10109 | <autodoc>GetEncoding(self) -> int</autodoc> |
f32fc4bc RD |
10110 | </method> |
10111 | <method name="GetNativeFontInfo" type="NativeFontInfo" overloaded="no"> | |
781d2982 | 10112 | <autodoc>GetNativeFontInfo(self) -> NativeFontInfo</autodoc> |
f32fc4bc RD |
10113 | </method> |
10114 | <method name="IsFixedWidth" type="bool" overloaded="no"> | |
781d2982 | 10115 | <autodoc>IsFixedWidth(self) -> bool</autodoc> |
f32fc4bc RD |
10116 | </method> |
10117 | <method name="GetNativeFontInfoDesc" type="String" overloaded="no"> | |
781d2982 | 10118 | <autodoc>GetNativeFontInfoDesc(self) -> String</autodoc> |
f32fc4bc RD |
10119 | </method> |
10120 | <method name="GetNativeFontInfoUserDesc" type="String" overloaded="no"> | |
781d2982 | 10121 | <autodoc>GetNativeFontInfoUserDesc(self) -> String</autodoc> |
f32fc4bc RD |
10122 | </method> |
10123 | <method name="SetPointSize" type="" overloaded="no"> | |
781d2982 | 10124 | <autodoc>SetPointSize(self, int pointSize)</autodoc> |
f32fc4bc RD |
10125 | <paramlist> |
10126 | <param name="pointSize" type="int" default=""/> | |
10127 | </paramlist> | |
10128 | </method> | |
10129 | <method name="SetFamily" type="" overloaded="no"> | |
781d2982 | 10130 | <autodoc>SetFamily(self, int family)</autodoc> |
f32fc4bc RD |
10131 | <paramlist> |
10132 | <param name="family" type="int" default=""/> | |
10133 | </paramlist> | |
10134 | </method> | |
10135 | <method name="SetStyle" type="" overloaded="no"> | |
781d2982 | 10136 | <autodoc>SetStyle(self, int style)</autodoc> |
f32fc4bc RD |
10137 | <paramlist> |
10138 | <param name="style" type="int" default=""/> | |
10139 | </paramlist> | |
10140 | </method> | |
10141 | <method name="SetWeight" type="" overloaded="no"> | |
781d2982 | 10142 | <autodoc>SetWeight(self, int weight)</autodoc> |
f32fc4bc RD |
10143 | <paramlist> |
10144 | <param name="weight" type="int" default=""/> | |
10145 | </paramlist> | |
10146 | </method> | |
10147 | <method name="SetFaceName" type="" overloaded="no"> | |
781d2982 | 10148 | <autodoc>SetFaceName(self, String faceName)</autodoc> |
f32fc4bc RD |
10149 | <paramlist> |
10150 | <param name="faceName" type="String" default=""/> | |
10151 | </paramlist> | |
10152 | </method> | |
10153 | <method name="SetUnderlined" type="" overloaded="no"> | |
781d2982 | 10154 | <autodoc>SetUnderlined(self, bool underlined)</autodoc> |
f32fc4bc RD |
10155 | <paramlist> |
10156 | <param name="underlined" type="bool" default=""/> | |
10157 | </paramlist> | |
10158 | </method> | |
10159 | <method name="SetEncoding" type="" overloaded="no"> | |
781d2982 | 10160 | <autodoc>SetEncoding(self, int encoding)</autodoc> |
f32fc4bc RD |
10161 | <paramlist> |
10162 | <param name="encoding" type="wxFontEncoding" default=""/> | |
10163 | </paramlist> | |
10164 | </method> | |
10165 | <method name="SetNativeFontInfo" type="" overloaded="no"> | |
781d2982 | 10166 | <autodoc>SetNativeFontInfo(self, NativeFontInfo info)</autodoc> |
f32fc4bc RD |
10167 | <paramlist> |
10168 | <param name="info" type="NativeFontInfo" default=""/> | |
10169 | </paramlist> | |
10170 | </method> | |
10171 | <method name="SetNativeFontInfoFromString" type="" overloaded="no"> | |
781d2982 | 10172 | <autodoc>SetNativeFontInfoFromString(self, String info)</autodoc> |
f32fc4bc RD |
10173 | <paramlist> |
10174 | <param name="info" type="String" default=""/> | |
10175 | </paramlist> | |
10176 | </method> | |
10177 | <method name="SetNativeFontInfoUserDesc" type="" overloaded="no"> | |
781d2982 | 10178 | <autodoc>SetNativeFontInfoUserDesc(self, String info)</autodoc> |
f32fc4bc RD |
10179 | <paramlist> |
10180 | <param name="info" type="String" default=""/> | |
10181 | </paramlist> | |
10182 | </method> | |
10183 | <method name="GetFamilyString" type="String" overloaded="no"> | |
781d2982 | 10184 | <autodoc>GetFamilyString(self) -> String</autodoc> |
f32fc4bc RD |
10185 | </method> |
10186 | <method name="GetStyleString" type="String" overloaded="no"> | |
781d2982 | 10187 | <autodoc>GetStyleString(self) -> String</autodoc> |
f32fc4bc RD |
10188 | </method> |
10189 | <method name="GetWeightString" type="String" overloaded="no"> | |
781d2982 | 10190 | <autodoc>GetWeightString(self) -> String</autodoc> |
f32fc4bc RD |
10191 | </method> |
10192 | <method name="SetNoAntiAliasing" type="" overloaded="no"> | |
781d2982 | 10193 | <autodoc>SetNoAntiAliasing(self, bool no=True)</autodoc> |
f32fc4bc RD |
10194 | <paramlist> |
10195 | <param name="no" type="bool" default="True"/> | |
10196 | </paramlist> | |
10197 | </method> | |
10198 | <method name="GetNoAntiAliasing" type="bool" overloaded="no"> | |
781d2982 | 10199 | <autodoc>GetNoAntiAliasing(self) -> bool</autodoc> |
f32fc4bc RD |
10200 | </method> |
10201 | <staticmethod name="GetDefaultEncoding" type="wxFontEncoding" overloaded="no"> | |
10202 | <autodoc>GetDefaultEncoding() -> int</autodoc> | |
10203 | </staticmethod> | |
10204 | <staticmethod name="SetDefaultEncoding" type="" overloaded="no"> | |
10205 | <autodoc>SetDefaultEncoding(int encoding)</autodoc> | |
10206 | <paramlist> | |
10207 | <param name="encoding" type="wxFontEncoding" default=""/> | |
10208 | </paramlist> | |
10209 | </staticmethod> | |
10210 | </class> | |
10211 | <pythoncode> | |
10212 | #--------------------------------------------------------------------------- | |
10213 | </pythoncode> | |
781d2982 | 10214 | <class name="FontEnumerator" oldname="wxPyFontEnumerator" module="_gdi"> |
f32fc4bc | 10215 | <constructor name="wxPyFontEnumerator" overloaded="no"> |
781d2982 | 10216 | <autodoc>__init__(self) -> FontEnumerator</autodoc> |
f32fc4bc RD |
10217 | </constructor> |
10218 | <destructor name="~wxPyFontEnumerator" overloaded="no"> | |
781d2982 | 10219 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
10220 | </destructor> |
10221 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 10222 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)</autodoc> |
f32fc4bc RD |
10223 | <paramlist> |
10224 | <param name="self" type="PyObject" default=""/> | |
10225 | <param name="_class" type="PyObject" default=""/> | |
10226 | <param name="incref" type="bool" default=""/> | |
10227 | </paramlist> | |
10228 | </method> | |
10229 | <method name="EnumerateFacenames" type="bool" overloaded="no"> | |
781d2982 | 10230 | <autodoc>EnumerateFacenames(self, int encoding=FONTENCODING_SYSTEM, bool fixedWidthOnly=False) -> bool</autodoc> |
f32fc4bc RD |
10231 | <paramlist> |
10232 | <param name="encoding" type="wxFontEncoding" default="wxFONTENCODING_SYSTEM"/> | |
10233 | <param name="fixedWidthOnly" type="bool" default="False"/> | |
10234 | </paramlist> | |
10235 | </method> | |
10236 | <method name="EnumerateEncodings" type="bool" overloaded="no"> | |
781d2982 | 10237 | <autodoc>EnumerateEncodings(self, String facename=EmptyString) -> bool</autodoc> |
f32fc4bc RD |
10238 | <paramlist> |
10239 | <param name="facename" type="String" default="wxPyEmptyString"/> | |
10240 | </paramlist> | |
10241 | </method> | |
10242 | <method name="GetEncodings" type="PyObject" overloaded="no"> | |
781d2982 | 10243 | <autodoc>GetEncodings(self) -> PyObject</autodoc> |
f32fc4bc RD |
10244 | </method> |
10245 | <method name="GetFacenames" type="PyObject" overloaded="no"> | |
781d2982 | 10246 | <autodoc>GetFacenames(self) -> PyObject</autodoc> |
f32fc4bc RD |
10247 | </method> |
10248 | </class> | |
10249 | <pythoncode> | |
10250 | #--------------------------------------------------------------------------- | |
10251 | </pythoncode> | |
781d2982 | 10252 | <class name="LanguageInfo" oldname="wxLanguageInfo" module="_gdi"> |
f32fc4bc RD |
10253 | <property name="Language" type="int" readonly="no"/> |
10254 | <property name="CanonicalName" type="String" readonly="no"/> | |
10255 | <property name="Description" type="String" readonly="no"/> | |
10256 | </class> | |
781d2982 | 10257 | <class name="Locale" oldname="wxLocale" module="_gdi"> |
f32fc4bc | 10258 | <constructor name="Locale" overloaded="no"> |
781d2982 | 10259 | <autodoc>__init__(self, int language=-1, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> Locale</autodoc> |
f32fc4bc | 10260 | <paramlist> |
781d2982 | 10261 | <param name="language" type="int" default="-1"/> |
f32fc4bc RD |
10262 | <param name="flags" type="int" default="wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING"/> |
10263 | </paramlist> | |
10264 | </constructor> | |
10265 | <destructor name="~wxLocale" overloaded="no"> | |
781d2982 | 10266 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
10267 | </destructor> |
10268 | <method name="Init1" type="bool" overloaded="no"> | |
781d2982 | 10269 | <autodoc>Init1(self, String szName, String szShort=EmptyString, String szLocale=EmptyString, |
f32fc4bc RD |
10270 | bool bLoadDefault=True, |
10271 | bool bConvertEncoding=False) -> bool</autodoc> | |
10272 | <paramlist> | |
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"/> | |
10278 | </paramlist> | |
10279 | </method> | |
10280 | <method name="Init2" type="bool" overloaded="no"> | |
781d2982 | 10281 | <autodoc>Init2(self, int language=LANGUAGE_DEFAULT, int flags=wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING) -> bool</autodoc> |
f32fc4bc RD |
10282 | <paramlist> |
10283 | <param name="language" type="int" default="wxLANGUAGE_DEFAULT"/> | |
10284 | <param name="flags" type="int" default="wxLOCALE_LOAD_DEFAULT|wxLOCALE_CONV_ENCODING"/> | |
10285 | </paramlist> | |
10286 | </method> | |
10287 | <staticmethod name="GetSystemLanguage" type="int" overloaded="no"> | |
10288 | <autodoc>GetSystemLanguage() -> int</autodoc> | |
10289 | </staticmethod> | |
10290 | <staticmethod name="GetSystemEncoding" type="wxFontEncoding" overloaded="no"> | |
10291 | <autodoc>GetSystemEncoding() -> int</autodoc> | |
10292 | </staticmethod> | |
10293 | <staticmethod name="GetSystemEncodingName" type="String" overloaded="no"> | |
10294 | <autodoc>GetSystemEncodingName() -> String</autodoc> | |
10295 | </staticmethod> | |
10296 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 10297 | <autodoc>IsOk(self) -> bool</autodoc> |
f32fc4bc RD |
10298 | </method> |
10299 | <method name="GetLocale" type="String" overloaded="no"> | |
781d2982 | 10300 | <autodoc>GetLocale(self) -> String</autodoc> |
f32fc4bc RD |
10301 | </method> |
10302 | <method name="GetLanguage" type="int" overloaded="no"> | |
781d2982 | 10303 | <autodoc>GetLanguage(self) -> int</autodoc> |
f32fc4bc RD |
10304 | </method> |
10305 | <method name="GetSysName" type="String" overloaded="no"> | |
781d2982 | 10306 | <autodoc>GetSysName(self) -> String</autodoc> |
f32fc4bc RD |
10307 | </method> |
10308 | <method name="GetCanonicalName" type="String" overloaded="no"> | |
781d2982 | 10309 | <autodoc>GetCanonicalName(self) -> String</autodoc> |
f32fc4bc RD |
10310 | </method> |
10311 | <staticmethod name="AddCatalogLookupPathPrefix" type="" overloaded="no"> | |
10312 | <autodoc>AddCatalogLookupPathPrefix(String prefix)</autodoc> | |
10313 | <paramlist> | |
10314 | <param name="prefix" type="String" default=""/> | |
10315 | </paramlist> | |
10316 | </staticmethod> | |
10317 | <method name="AddCatalog" type="bool" overloaded="no"> | |
781d2982 | 10318 | <autodoc>AddCatalog(self, String szDomain) -> bool</autodoc> |
f32fc4bc RD |
10319 | <paramlist> |
10320 | <param name="szDomain" type="String" default=""/> | |
10321 | </paramlist> | |
10322 | </method> | |
10323 | <method name="IsLoaded" type="bool" overloaded="no"> | |
781d2982 | 10324 | <autodoc>IsLoaded(self, String szDomain) -> bool</autodoc> |
f32fc4bc RD |
10325 | <paramlist> |
10326 | <param name="szDomain" type="String" default=""/> | |
10327 | </paramlist> | |
10328 | </method> | |
10329 | <staticmethod name="GetLanguageInfo" type="LanguageInfo" overloaded="no"> | |
10330 | <autodoc>GetLanguageInfo(int lang) -> LanguageInfo</autodoc> | |
10331 | <paramlist> | |
10332 | <param name="lang" type="int" default=""/> | |
10333 | </paramlist> | |
10334 | </staticmethod> | |
10335 | <staticmethod name="GetLanguageName" type="String" overloaded="no"> | |
10336 | <autodoc>GetLanguageName(int lang) -> String</autodoc> | |
10337 | <paramlist> | |
10338 | <param name="lang" type="int" default=""/> | |
10339 | </paramlist> | |
10340 | </staticmethod> | |
10341 | <staticmethod name="FindLanguageInfo" type="LanguageInfo" overloaded="no"> | |
10342 | <autodoc>FindLanguageInfo(String locale) -> LanguageInfo</autodoc> | |
10343 | <paramlist> | |
10344 | <param name="locale" type="String" default=""/> | |
10345 | </paramlist> | |
10346 | </staticmethod> | |
10347 | <staticmethod name="AddLanguage" type="" overloaded="no"> | |
10348 | <autodoc>AddLanguage(LanguageInfo info)</autodoc> | |
10349 | <paramlist> | |
10350 | <param name="info" type="LanguageInfo" default=""/> | |
10351 | </paramlist> | |
10352 | </staticmethod> | |
10353 | <method name="GetString" type="String" overloaded="no"> | |
781d2982 | 10354 | <autodoc>GetString(self, String szOrigString, String szDomain=EmptyString) -> String</autodoc> |
f32fc4bc RD |
10355 | <paramlist> |
10356 | <param name="szOrigString" type="String" default=""/> | |
10357 | <param name="szDomain" type="String" default="wxPyEmptyString"/> | |
10358 | </paramlist> | |
10359 | </method> | |
10360 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 10361 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
10362 | </method> |
10363 | </class> | |
10364 | <method name="GetLocale" oldname="wxGetLocale" type="Locale" overloaded="no"> | |
10365 | <autodoc>GetLocale() -> Locale</autodoc> | |
10366 | </method> | |
10367 | <method name="GetTranslation" oldname="wxGetTranslation" type="String" overloaded="yes"> | |
10368 | <paramlist> | |
10369 | <param name="str" type="String" default=""/> | |
10370 | </paramlist> | |
10371 | </method> | |
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> | |
856bf319 | 10375 | <paramlist> |
f32fc4bc RD |
10376 | <param name="str" type="String" default=""/> |
10377 | <param name="strPlural" type="String" default=""/> | |
10378 | <param name="n" type="size_t" default=""/> | |
856bf319 RD |
10379 | </paramlist> |
10380 | </method> | |
f32fc4bc | 10381 | <pythoncode> |
856bf319 RD |
10382 | #--------------------------------------------------------------------------- |
10383 | </pythoncode> | |
781d2982 | 10384 | <class name="EncodingConverter" oldname="wxEncodingConverter" module="_gdi"> |
f32fc4bc RD |
10385 | <baseclass name="Object"/> |
10386 | <constructor name="EncodingConverter" overloaded="no"> | |
781d2982 | 10387 | <autodoc>__init__(self) -> EncodingConverter</autodoc> |
f32fc4bc RD |
10388 | </constructor> |
10389 | <destructor name="~wxEncodingConverter" overloaded="no"> | |
781d2982 | 10390 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
10391 | </destructor> |
10392 | <method name="Init" type="bool" overloaded="no"> | |
781d2982 | 10393 | <autodoc>Init(self, int input_enc, int output_enc, int method=CONVERT_STRICT) -> bool</autodoc> |
f32fc4bc RD |
10394 | <paramlist> |
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"/> | |
10398 | </paramlist> | |
10399 | </method> | |
10400 | <method name="Convert" type="String" overloaded="no"> | |
781d2982 | 10401 | <autodoc>Convert(self, String input) -> String</autodoc> |
f32fc4bc RD |
10402 | <paramlist> |
10403 | <param name="input" type="String" default=""/> | |
10404 | </paramlist> | |
10405 | </method> | |
10406 | <staticmethod name="GetPlatformEquivalents" type="wxFontEncodingArray" overloaded="no"> | |
10407 | <autodoc>GetPlatformEquivalents(int enc, int platform=PLATFORM_CURRENT) -> wxFontEncodingArray</autodoc> | |
10408 | <paramlist> | |
10409 | <param name="enc" type="wxFontEncoding" default=""/> | |
10410 | <param name="platform" type="int" default="wxPLATFORM_CURRENT"/> | |
10411 | </paramlist> | |
10412 | </staticmethod> | |
10413 | <staticmethod name="GetAllEquivalents" type="wxFontEncodingArray" overloaded="no"> | |
10414 | <autodoc>GetAllEquivalents(int enc) -> wxFontEncodingArray</autodoc> | |
10415 | <paramlist> | |
10416 | <param name="enc" type="wxFontEncoding" default=""/> | |
10417 | </paramlist> | |
10418 | </staticmethod> | |
10419 | <staticmethod name="CanConvert" type="bool" overloaded="no"> | |
10420 | <autodoc>CanConvert(int encIn, int encOut) -> bool</autodoc> | |
10421 | <paramlist> | |
10422 | <param name="encIn" type="wxFontEncoding" default=""/> | |
10423 | <param name="encOut" type="wxFontEncoding" default=""/> | |
10424 | </paramlist> | |
10425 | </staticmethod> | |
10426 | </class> | |
10427 | <pythoncode>#---------------------------------------------------------------------------- | |
781d2982 | 10428 | # On MSW add the directory where the wxWidgets catalogs were installed |
f32fc4bc RD |
10429 | # to the default catalog path. |
10430 | if wx.Platform == "__WXMSW__": | |
10431 | import os | |
10432 | localedir = os.path.join(os.path.split(__file__)[0], "locale") | |
10433 | Locale_AddCatalogLookupPathPrefix(localedir) | |
10434 | del os | |
10435 | ||
10436 | #---------------------------------------------------------------------------- | |
10437 | </pythoncode> | |
10438 | <pythoncode> | |
0f43fbdf RD |
10439 | #--------------------------------------------------------------------------- |
10440 | </pythoncode> | |
781d2982 | 10441 | <class name="DC" oldname="wxDC" module="_gdi"> |
ce6878e6 RD |
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. | |
10448 | ||
10449 | Derived types of wxDC have documentation for specific features only, | |
10450 | so refer to this section for most device context information. | |
10451 | ||
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> | |
f32fc4bc RD |
10455 | <baseclass name="Object"/> |
10456 | <destructor name="~wxDC" overloaded="no"> | |
781d2982 | 10457 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
10458 | </destructor> |
10459 | <method name="BeginDrawing" type="" overloaded="no"> | |
781d2982 | 10460 | <autodoc>BeginDrawing(self)</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
10466 | </method> |
10467 | <method name="EndDrawing" type="" overloaded="no"> | |
781d2982 | 10468 | <autodoc>EndDrawing(self)</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc | 10472 | </method> |
781d2982 RD |
10473 | <method name="FloodFill" type="bool" overloaded="no"> |
10474 | <autodoc>FloodFill(self, int x, int y, Colour col, int style=FLOOD_SURFACE) -> bool</autodoc> | |
ce6878e6 RD |
10475 | <docstring>Flood fills the device context starting from the given point, using |
10476 | the current brush colour, and using a style: | |
10477 | ||
10478 | - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than | |
10479 | the given colour is encountered. | |
10480 | ||
10481 | - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given | |
10482 | colour. | |
10483 | ||
10484 | Returns False if the operation failed. | |
10485 | ||
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> | |
f32fc4bc RD |
10489 | <paramlist> |
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"/> | |
10494 | </paramlist> | |
10495 | </method> | |
781d2982 RD |
10496 | <method name="FloodFillPoint" type="bool" overloaded="no"> |
10497 | <autodoc>FloodFillPoint(self, Point pt, Colour col, int style=FLOOD_SURFACE) -> bool</autodoc> | |
ce6878e6 RD |
10498 | <docstring>Flood fills the device context starting from the given point, using |
10499 | the current brush colour, and using a style: | |
10500 | ||
10501 | - **wxFLOOD_SURFACE**: the flooding occurs until a colour other than | |
10502 | the given colour is encountered. | |
10503 | ||
10504 | - **wxFLOOD_BORDER**: the area to be flooded is bounded by the given | |
10505 | colour. | |
10506 | ||
10507 | Returns False if the operation failed. | |
10508 | ||
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> | |
f32fc4bc RD |
10512 | <paramlist> |
10513 | <param name="pt" type="Point" default=""/> | |
10514 | <param name="col" type="Colour" default=""/> | |
10515 | <param name="style" type="int" default="wxFLOOD_SURFACE"/> | |
10516 | </paramlist> | |
10517 | </method> | |
781d2982 RD |
10518 | <method name="GetPixel" type="Colour" overloaded="no"> |
10519 | <autodoc>GetPixel(self, int x, int y) -> Colour</autodoc> | |
ce6878e6 | 10520 | <docstring>Gets the colour at the specified location on the DC.</docstring> |
f32fc4bc RD |
10521 | <paramlist> |
10522 | <param name="x" type="int" default=""/> | |
10523 | <param name="y" type="int" default=""/> | |
10524 | </paramlist> | |
10525 | </method> | |
781d2982 RD |
10526 | <method name="GetPixelPoint" type="Colour" overloaded="no"> |
10527 | <autodoc>GetPixelPoint(self, Point pt) -> Colour</autodoc> | |
f32fc4bc RD |
10528 | <paramlist> |
10529 | <param name="pt" type="Point" default=""/> | |
10530 | </paramlist> | |
10531 | </method> | |
781d2982 RD |
10532 | <method name="DrawLine" type="" overloaded="no"> |
10533 | <autodoc>DrawLine(self, int x1, int y1, int x2, int y2)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
10538 | <paramlist> |
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=""/> | |
10543 | </paramlist> | |
10544 | </method> | |
781d2982 RD |
10545 | <method name="DrawLinePoint" type="" overloaded="no"> |
10546 | <autodoc>DrawLinePoint(self, Point pt1, Point pt2)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
10551 | <paramlist> |
10552 | <param name="pt1" type="Point" default=""/> | |
10553 | <param name="pt2" type="Point" default=""/> | |
10554 | </paramlist> | |
10555 | </method> | |
781d2982 RD |
10556 | <method name="CrossHair" type="" overloaded="no"> |
10557 | <autodoc>CrossHair(self, int x, int y)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
10561 | <paramlist> |
10562 | <param name="x" type="int" default=""/> | |
10563 | <param name="y" type="int" default=""/> | |
10564 | </paramlist> | |
10565 | </method> | |
781d2982 RD |
10566 | <method name="CrossHairPoint" type="" overloaded="no"> |
10567 | <autodoc>CrossHairPoint(self, Point pt)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
10571 | <paramlist> |
10572 | <param name="pt" type="Point" default=""/> | |
10573 | </paramlist> | |
10574 | </method> | |
781d2982 RD |
10575 | <method name="DrawArc" type="" overloaded="no"> |
10576 | <autodoc>DrawArc(self, int x1, int y1, int x2, int y2, int xc, int yc)</autodoc> | |
ce6878e6 RD |
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. | |
10580 | ||
10581 | The arc is drawn in an anticlockwise direction from the start point to | |
10582 | the end point.</docstring> | |
f32fc4bc RD |
10583 | <paramlist> |
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=""/> | |
10590 | </paramlist> | |
10591 | </method> | |
781d2982 | 10592 | <method name="DrawArcPoint" type="" overloaded="no"> |
ce6878e6 RD |
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. | |
10597 | ||
10598 | The arc is drawn in an anticlockwise direction from the start point to | |
10599 | the end point.</docstring> | |
f32fc4bc RD |
10600 | <paramlist> |
10601 | <param name="pt1" type="Point" default=""/> | |
10602 | <param name="pt2" type="Point" default=""/> | |
ce6878e6 | 10603 | <param name="center" type="Point" default=""/> |
f32fc4bc RD |
10604 | </paramlist> |
10605 | </method> | |
781d2982 RD |
10606 | <method name="DrawCheckMark" type="" overloaded="no"> |
10607 | <autodoc>DrawCheckMark(self, int x, int y, int width, int height)</autodoc> | |
ce6878e6 | 10608 | <docstring>Draws a check mark inside the given rectangle.</docstring> |
f32fc4bc RD |
10609 | <paramlist> |
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=""/> | |
10614 | </paramlist> | |
10615 | </method> | |
781d2982 RD |
10616 | <method name="DrawCheckMarkRect" type="" overloaded="no"> |
10617 | <autodoc>DrawCheckMarkRect(self, Rect rect)</autodoc> | |
ce6878e6 | 10618 | <docstring>Draws a check mark inside the given rectangle.</docstring> |
f32fc4bc RD |
10619 | <paramlist> |
10620 | <param name="rect" type="Rect" default=""/> | |
10621 | </paramlist> | |
10622 | </method> | |
781d2982 | 10623 | <method name="DrawEllipticArc" type="" overloaded="no"> |
ce6878e6 RD |
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. | |
10628 | ||
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> | |
f32fc4bc RD |
10634 | <paramlist> |
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=""/> | |
ce6878e6 RD |
10639 | <param name="start" type="double" default=""/> |
10640 | <param name="end" type="double" default=""/> | |
f32fc4bc RD |
10641 | </paramlist> |
10642 | </method> | |
781d2982 | 10643 | <method name="DrawEllipticArcPointSize" type="" overloaded="no"> |
ce6878e6 RD |
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. | |
10648 | ||
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> | |
f32fc4bc RD |
10654 | <paramlist> |
10655 | <param name="pt" type="Point" default=""/> | |
10656 | <param name="sz" type="Size" default=""/> | |
ce6878e6 RD |
10657 | <param name="start" type="double" default=""/> |
10658 | <param name="end" type="double" default=""/> | |
f32fc4bc RD |
10659 | </paramlist> |
10660 | </method> | |
781d2982 RD |
10661 | <method name="DrawPoint" type="" overloaded="no"> |
10662 | <autodoc>DrawPoint(self, int x, int y)</autodoc> | |
ce6878e6 | 10663 | <docstring>Draws a point using the current pen.</docstring> |
f32fc4bc RD |
10664 | <paramlist> |
10665 | <param name="x" type="int" default=""/> | |
10666 | <param name="y" type="int" default=""/> | |
10667 | </paramlist> | |
10668 | </method> | |
781d2982 RD |
10669 | <method name="DrawPointPoint" type="" overloaded="no"> |
10670 | <autodoc>DrawPointPoint(self, Point pt)</autodoc> | |
ce6878e6 | 10671 | <docstring>Draws a point using the current pen.</docstring> |
f32fc4bc RD |
10672 | <paramlist> |
10673 | <param name="pt" type="Point" default=""/> | |
10674 | </paramlist> | |
10675 | </method> | |
781d2982 RD |
10676 | <method name="DrawRectangle" type="" overloaded="no"> |
10677 | <autodoc>DrawRectangle(self, int x, int y, int width, int height)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
10681 | <paramlist> |
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=""/> | |
10686 | </paramlist> | |
10687 | </method> | |
781d2982 RD |
10688 | <method name="DrawRectangleRect" type="" overloaded="no"> |
10689 | <autodoc>DrawRectangleRect(self, Rect rect)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc | 10693 | <paramlist> |
781d2982 | 10694 | <param name="rect" type="Rect" default=""/> |
f32fc4bc RD |
10695 | </paramlist> |
10696 | </method> | |
781d2982 RD |
10697 | <method name="DrawRectanglePointSize" type="" overloaded="no"> |
10698 | <autodoc>DrawRectanglePointSize(self, Point pt, Size sz)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc | 10702 | <paramlist> |
781d2982 RD |
10703 | <param name="pt" type="Point" default=""/> |
10704 | <param name="sz" type="Size" default=""/> | |
f32fc4bc RD |
10705 | </paramlist> |
10706 | </method> | |
781d2982 RD |
10707 | <method name="DrawRoundedRectangle" type="" overloaded="no"> |
10708 | <autodoc>DrawRoundedRectangle(self, int x, int y, int width, int height, double radius)</autodoc> | |
ce6878e6 RD |
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 | |
10712 | the shape. | |
10713 | ||
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> | |
f32fc4bc RD |
10720 | <paramlist> |
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=""/> | |
10726 | </paramlist> | |
10727 | </method> | |
781d2982 RD |
10728 | <method name="DrawRoundedRectangleRect" type="" overloaded="no"> |
10729 | <autodoc>DrawRoundedRectangleRect(self, Rect r, double radius)</autodoc> | |
ce6878e6 RD |
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 | |
10733 | the shape. | |
10734 | ||
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> | |
f32fc4bc | 10741 | <paramlist> |
781d2982 | 10742 | <param name="r" type="Rect" default=""/> |
f32fc4bc RD |
10743 | <param name="radius" type="double" default=""/> |
10744 | </paramlist> | |
10745 | </method> | |
781d2982 RD |
10746 | <method name="DrawRoundedRectanglePointSize" type="" overloaded="no"> |
10747 | <autodoc>DrawRoundedRectanglePointSize(self, Point pt, Size sz, double radius)</autodoc> | |
ce6878e6 RD |
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 | |
10751 | the shape. | |
10752 | ||
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> | |
f32fc4bc | 10759 | <paramlist> |
781d2982 RD |
10760 | <param name="pt" type="Point" default=""/> |
10761 | <param name="sz" type="Size" default=""/> | |
f32fc4bc RD |
10762 | <param name="radius" type="double" default=""/> |
10763 | </paramlist> | |
10764 | </method> | |
781d2982 RD |
10765 | <method name="DrawCircle" type="" overloaded="no"> |
10766 | <autodoc>DrawCircle(self, int x, int y, int radius)</autodoc> | |
ce6878e6 RD |
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 | |
10769 | shape. | |
10770 | ||
10771 | :see: `DrawEllipse`</docstring> | |
f32fc4bc RD |
10772 | <paramlist> |
10773 | <param name="x" type="int" default=""/> | |
10774 | <param name="y" type="int" default=""/> | |
10775 | <param name="radius" type="int" default=""/> | |
10776 | </paramlist> | |
10777 | </method> | |
781d2982 RD |
10778 | <method name="DrawCirclePoint" type="" overloaded="no"> |
10779 | <autodoc>DrawCirclePoint(self, Point pt, int radius)</autodoc> | |
ce6878e6 RD |
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 | |
10782 | shape. | |
10783 | ||
10784 | :see: `DrawEllipse`</docstring> | |
f32fc4bc RD |
10785 | <paramlist> |
10786 | <param name="pt" type="Point" default=""/> | |
10787 | <param name="radius" type="int" default=""/> | |
10788 | </paramlist> | |
10789 | </method> | |
781d2982 RD |
10790 | <method name="DrawEllipse" type="" overloaded="no"> |
10791 | <autodoc>DrawEllipse(self, int x, int y, int width, int height)</autodoc> | |
ce6878e6 RD |
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. | |
10794 | ||
10795 | :see: `DrawCircle`</docstring> | |
f32fc4bc RD |
10796 | <paramlist> |
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=""/> | |
10801 | </paramlist> | |
10802 | </method> | |
781d2982 RD |
10803 | <method name="DrawEllipseRect" type="" overloaded="no"> |
10804 | <autodoc>DrawEllipseRect(self, Rect rect)</autodoc> | |
ce6878e6 RD |
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. | |
10807 | ||
10808 | :see: `DrawCircle`</docstring> | |
f32fc4bc | 10809 | <paramlist> |
781d2982 | 10810 | <param name="rect" type="Rect" default=""/> |
f32fc4bc RD |
10811 | </paramlist> |
10812 | </method> | |
781d2982 RD |
10813 | <method name="DrawEllipsePointSize" type="" overloaded="no"> |
10814 | <autodoc>DrawEllipsePointSize(self, Point pt, Size sz)</autodoc> | |
ce6878e6 RD |
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. | |
10817 | ||
10818 | :see: `DrawCircle`</docstring> | |
f32fc4bc | 10819 | <paramlist> |
781d2982 RD |
10820 | <param name="pt" type="Point" default=""/> |
10821 | <param name="sz" type="Size" default=""/> | |
f32fc4bc RD |
10822 | </paramlist> |
10823 | </method> | |
781d2982 RD |
10824 | <method name="DrawIcon" type="" overloaded="no"> |
10825 | <autodoc>DrawIcon(self, Icon icon, int x, int y)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
10829 | <paramlist> |
10830 | <param name="icon" type="Icon" default=""/> | |
10831 | <param name="x" type="int" default=""/> | |
10832 | <param name="y" type="int" default=""/> | |
10833 | </paramlist> | |
10834 | </method> | |
781d2982 RD |
10835 | <method name="DrawIconPoint" type="" overloaded="no"> |
10836 | <autodoc>DrawIconPoint(self, Icon icon, Point pt)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
10840 | <paramlist> |
10841 | <param name="icon" type="Icon" default=""/> | |
10842 | <param name="pt" type="Point" default=""/> | |
10843 | </paramlist> | |
10844 | </method> | |
781d2982 RD |
10845 | <method name="DrawBitmap" type="" overloaded="no"> |
10846 | <autodoc>DrawBitmap(self, Bitmap bmp, int x, int y, bool useMask=False)</autodoc> | |
ce6878e6 RD |
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. | |
10851 | ||
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 | |
10855 | 0). | |
10856 | ||
10857 | :see: `SetTextForeground`, `SetTextBackground` and `wx.MemoryDC`</docstring> | |
f32fc4bc RD |
10858 | <paramlist> |
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"/> | |
10863 | </paramlist> | |
10864 | </method> | |
781d2982 RD |
10865 | <method name="DrawBitmapPoint" type="" overloaded="no"> |
10866 | <autodoc>DrawBitmapPoint(self, Bitmap bmp, Point pt, bool useMask=False)</autodoc> | |
ce6878e6 RD |
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. | |
10871 | ||
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 | |
10875 | 0). | |
10876 | ||
10877 | :see: `SetTextForeground`, `SetTextBackground` and `wx.MemoryDC`</docstring> | |
f32fc4bc RD |
10878 | <paramlist> |
10879 | <param name="bmp" type="Bitmap" default=""/> | |
10880 | <param name="pt" type="Point" default=""/> | |
10881 | <param name="useMask" type="bool" default="False"/> | |
10882 | </paramlist> | |
10883 | </method> | |
781d2982 RD |
10884 | <method name="DrawText" type="" overloaded="no"> |
10885 | <autodoc>DrawText(self, String text, int x, int y)</autodoc> | |
ce6878e6 RD |
10886 | <docstring>Draws a text string at the specified point, using the current text |
10887 | font, and the current text foreground and background colours. | |
10888 | ||
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. | |
10892 | ||
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. | |
10896 | ||
10897 | :see: `DrawRotatedText`</docstring> | |
f32fc4bc RD |
10898 | <paramlist> |
10899 | <param name="text" type="String" default=""/> | |
10900 | <param name="x" type="int" default=""/> | |
10901 | <param name="y" type="int" default=""/> | |
10902 | </paramlist> | |
10903 | </method> | |
781d2982 RD |
10904 | <method name="DrawTextPoint" type="" overloaded="no"> |
10905 | <autodoc>DrawTextPoint(self, String text, Point pt)</autodoc> | |
ce6878e6 RD |
10906 | <docstring>Draws a text string at the specified point, using the current text |
10907 | font, and the current text foreground and background colours. | |
10908 | ||
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. | |
10912 | ||
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. | |
10916 | ||
10917 | :see: `DrawRotatedText`</docstring> | |
f32fc4bc RD |
10918 | <paramlist> |
10919 | <param name="text" type="String" default=""/> | |
10920 | <param name="pt" type="Point" default=""/> | |
10921 | </paramlist> | |
10922 | </method> | |
781d2982 RD |
10923 | <method name="DrawRotatedText" type="" overloaded="no"> |
10924 | <autodoc>DrawRotatedText(self, String text, int x, int y, double angle)</autodoc> | |
ce6878e6 RD |
10925 | <docstring>Draws the text rotated by *angle* degrees, if supported by the platform. |
10926 | ||
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. | |
10931 | ||
10932 | :see: `DrawText`</docstring> | |
f32fc4bc RD |
10933 | <paramlist> |
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=""/> | |
10938 | </paramlist> | |
10939 | </method> | |
781d2982 RD |
10940 | <method name="DrawRotatedTextPoint" type="" overloaded="no"> |
10941 | <autodoc>DrawRotatedTextPoint(self, String text, Point pt, double angle)</autodoc> | |
ce6878e6 RD |
10942 | <docstring>Draws the text rotated by *angle* degrees, if supported by the platform. |
10943 | ||
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. | |
10948 | ||
10949 | :see: `DrawText`</docstring> | |
f32fc4bc RD |
10950 | <paramlist> |
10951 | <param name="text" type="String" default=""/> | |
10952 | <param name="pt" type="Point" default=""/> | |
10953 | <param name="angle" type="double" default=""/> | |
10954 | </paramlist> | |
10955 | </method> | |
781d2982 RD |
10956 | <method name="Blit" type="bool" overloaded="no"> |
10957 | <autodoc>Blit(self, int xdest, int ydest, int width, int height, DC source, | |
f32fc4bc RD |
10958 | int xsrc, int ysrc, int rop=COPY, bool useMask=False, |
10959 | int xsrcMask=-1, int ysrcMask=-1) -> bool</autodoc> | |
ce6878e6 RD |
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 | |
10963 | position. | |
10964 | ||
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. | |
10980 | </docstring> | |
f32fc4bc RD |
10981 | <paramlist> |
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"/> | |
10993 | </paramlist> | |
10994 | </method> | |
781d2982 RD |
10995 | <method name="BlitPointSize" type="bool" overloaded="no"> |
10996 | <autodoc>BlitPointSize(self, Point destPt, Size sz, DC source, Point srcPt, int rop=COPY, | |
f32fc4bc | 10997 | bool useMask=False, Point srcPtMask=DefaultPosition) -> bool</autodoc> |
ce6878e6 RD |
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 | |
11001 | position. | |
11002 | ||
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. | |
11012 | </docstring> | |
f32fc4bc RD |
11013 | <paramlist> |
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"/> | |
11021 | </paramlist> | |
11022 | </method> | |
781d2982 RD |
11023 | <method name="SetClippingRegion" type="" overloaded="no"> |
11024 | <autodoc>SetClippingRegion(self, int x, int y, int width, int height)</autodoc> | |
ce6878e6 RD |
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 | |
11029 | specified. | |
11030 | ||
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 | |
11034 | screen is damaged. | |
11035 | ||
11036 | :see: `DestroyClippingRegion`, `wx.Region`</docstring> | |
781d2982 RD |
11037 | <paramlist> |
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=""/> | |
11042 | </paramlist> | |
11043 | </method> | |
11044 | <method name="SetClippingRegionPointSize" type="" overloaded="no"> | |
11045 | <autodoc>SetClippingRegionPointSize(self, Point pt, Size sz)</autodoc> | |
ce6878e6 RD |
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 | |
11050 | specified. | |
11051 | ||
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 | |
11055 | screen is damaged. | |
11056 | ||
11057 | :see: `DestroyClippingRegion`, `wx.Region`</docstring> | |
781d2982 RD |
11058 | <paramlist> |
11059 | <param name="pt" type="Point" default=""/> | |
11060 | <param name="sz" type="Size" default=""/> | |
11061 | </paramlist> | |
11062 | </method> | |
11063 | <method name="SetClippingRegionAsRegion" type="" overloaded="no"> | |
11064 | <autodoc>SetClippingRegionAsRegion(self, Region region)</autodoc> | |
ce6878e6 RD |
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 | |
11069 | specified. | |
11070 | ||
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 | |
11074 | screen is damaged. | |
11075 | ||
11076 | :see: `DestroyClippingRegion`, `wx.Region`</docstring> | |
781d2982 RD |
11077 | <paramlist> |
11078 | <param name="region" type="Region" default=""/> | |
11079 | </paramlist> | |
11080 | </method> | |
11081 | <method name="SetClippingRect" type="" overloaded="no"> | |
11082 | <autodoc>SetClippingRect(self, Rect rect)</autodoc> | |
ce6878e6 RD |
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 | |
11087 | specified. | |
11088 | ||
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 | |
11092 | screen is damaged. | |
11093 | ||
11094 | :see: `DestroyClippingRegion`, `wx.Region`</docstring> | |
781d2982 RD |
11095 | <paramlist> |
11096 | <param name="rect" type="Rect" default=""/> | |
11097 | </paramlist> | |
11098 | </method> | |
f32fc4bc | 11099 | <method name="DrawLines" type="" overloaded="no"> |
ce6878e6 RD |
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 | |
11103 | lines.</docstring> | |
f32fc4bc RD |
11104 | <paramlist> |
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"/> | |
11109 | </paramlist> | |
11110 | </method> | |
11111 | <method name="DrawPolygon" type="" overloaded="no"> | |
ce6878e6 | 11112 | <autodoc>DrawPolygon(self, List points, int xoffset=0, int yoffset=0, |
f32fc4bc | 11113 | int fillStyle=ODDEVEN_RULE)</autodoc> |
ce6878e6 RD |
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``. | |
11117 | ||
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> | |
f32fc4bc RD |
11122 | <paramlist> |
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"/> | |
11128 | </paramlist> | |
11129 | </method> | |
11130 | <method name="DrawLabel" type="" overloaded="no"> | |
781d2982 | 11131 | <autodoc>DrawLabel(self, String text, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, |
f32fc4bc | 11132 | int indexAccel=-1)</autodoc> |
ce6878e6 RD |
11133 | <docstring>Draw *text* within the specified rectangle, abiding by the alignment |
11134 | flags. Will additionally emphasize the character at *indexAccel* if | |
11135 | it is not -1. | |
11136 | ||
11137 | :see: `DrawImageLabel`</docstring> | |
f32fc4bc RD |
11138 | <paramlist> |
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"/> | |
11143 | </paramlist> | |
11144 | </method> | |
11145 | <method name="DrawImageLabel" type="Rect" overloaded="no"> | |
781d2982 | 11146 | <autodoc>DrawImageLabel(self, String text, Bitmap image, Rect rect, int alignment=wxALIGN_LEFT|wxALIGN_TOP, |
f32fc4bc | 11147 | int indexAccel=-1) -> Rect</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11152 | <paramlist> |
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"/> | |
11158 | </paramlist> | |
11159 | </method> | |
11160 | <method name="DrawSpline" type="" overloaded="no"> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11165 | <paramlist> |
11166 | <param name="points" type="int" default=""/> | |
11167 | <param name="points_array" type="Point" default=""/> | |
11168 | </paramlist> | |
11169 | </method> | |
11170 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 11171 | <autodoc>Clear(self)</autodoc> |
ce6878e6 | 11172 | <docstring>Clears the device context using the current background brush.</docstring> |
f32fc4bc RD |
11173 | </method> |
11174 | <method name="StartDoc" type="bool" overloaded="no"> | |
781d2982 | 11175 | <autodoc>StartDoc(self, String message) -> bool</autodoc> |
ce6878e6 RD |
11176 | <docstring>Starts a document (only relevant when outputting to a |
11177 | printer). *Message* is a message to show whilst printing.</docstring> | |
f32fc4bc RD |
11178 | <paramlist> |
11179 | <param name="message" type="String" default=""/> | |
11180 | </paramlist> | |
11181 | </method> | |
11182 | <method name="EndDoc" type="" overloaded="no"> | |
781d2982 | 11183 | <autodoc>EndDoc(self)</autodoc> |
ce6878e6 | 11184 | <docstring>Ends a document (only relevant when outputting to a printer).</docstring> |
f32fc4bc RD |
11185 | </method> |
11186 | <method name="StartPage" type="" overloaded="no"> | |
781d2982 | 11187 | <autodoc>StartPage(self)</autodoc> |
ce6878e6 | 11188 | <docstring>Starts a document page (only relevant when outputting to a printer).</docstring> |
f32fc4bc RD |
11189 | </method> |
11190 | <method name="EndPage" type="" overloaded="no"> | |
781d2982 | 11191 | <autodoc>EndPage(self)</autodoc> |
ce6878e6 | 11192 | <docstring>Ends a document page (only relevant when outputting to a printer).</docstring> |
f32fc4bc RD |
11193 | </method> |
11194 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 11195 | <autodoc>SetFont(self, Font font)</autodoc> |
ce6878e6 RD |
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. | |
11198 | ||
11199 | :see: `wx.Font`</docstring> | |
f32fc4bc RD |
11200 | <paramlist> |
11201 | <param name="font" type="Font" default=""/> | |
11202 | </paramlist> | |
11203 | </method> | |
11204 | <method name="SetPen" type="" overloaded="no"> | |
781d2982 | 11205 | <autodoc>SetPen(self, Pen pen)</autodoc> |
ce6878e6 RD |
11206 | <docstring>Sets the current pen for the DC. |
11207 | ||
11208 | If the argument is ``wx.NullPen``, the current pen is selected out of the | |
11209 | device context, and the original pen restored. | |
11210 | ||
11211 | :see: `wx.Pen`</docstring> | |
f32fc4bc RD |
11212 | <paramlist> |
11213 | <param name="pen" type="Pen" default=""/> | |
11214 | </paramlist> | |
11215 | </method> | |
11216 | <method name="SetBrush" type="" overloaded="no"> | |
781d2982 | 11217 | <autodoc>SetBrush(self, Brush brush)</autodoc> |
ce6878e6 RD |
11218 | <docstring>Sets the current brush for the DC. |
11219 | ||
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. | |
11223 | ||
11224 | :see: `wx.Brush`</docstring> | |
f32fc4bc RD |
11225 | <paramlist> |
11226 | <param name="brush" type="Brush" default=""/> | |
11227 | </paramlist> | |
11228 | </method> | |
11229 | <method name="SetBackground" type="" overloaded="no"> | |
781d2982 | 11230 | <autodoc>SetBackground(self, Brush brush)</autodoc> |
ce6878e6 | 11231 | <docstring>Sets the current background brush for the DC.</docstring> |
f32fc4bc RD |
11232 | <paramlist> |
11233 | <param name="brush" type="Brush" default=""/> | |
11234 | </paramlist> | |
11235 | </method> | |
11236 | <method name="SetBackgroundMode" type="" overloaded="no"> | |
781d2982 | 11237 | <autodoc>SetBackgroundMode(self, int mode)</autodoc> |
ce6878e6 RD |
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 | |
11240 | not.</docstring> | |
f32fc4bc RD |
11241 | <paramlist> |
11242 | <param name="mode" type="int" default=""/> | |
11243 | </paramlist> | |
11244 | </method> | |
11245 | <method name="SetPalette" type="" overloaded="no"> | |
781d2982 | 11246 | <autodoc>SetPalette(self, Palette palette)</autodoc> |
ce6878e6 RD |
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. | |
11251 | ||
11252 | :see: `wx.Palette`</docstring> | |
f32fc4bc RD |
11253 | <paramlist> |
11254 | <param name="palette" type="Palette" default=""/> | |
11255 | </paramlist> | |
11256 | </method> | |
f32fc4bc | 11257 | <method name="DestroyClippingRegion" type="" overloaded="no"> |
781d2982 | 11258 | <autodoc>DestroyClippingRegion(self)</autodoc> |
ce6878e6 RD |
11259 | <docstring>Destroys the current clipping region so that none of the DC is |
11260 | clipped. | |
11261 | ||
11262 | :see: `SetClippingRegion`</docstring> | |
f32fc4bc RD |
11263 | </method> |
11264 | <method name="GetClippingBox" type="" overloaded="no"> | |
11265 | <autodoc>GetClippingBox() -> (x, y, width, height)</autodoc> | |
ce6878e6 | 11266 | <docstring>Gets the rectangle surrounding the current clipping region.</docstring> |
f32fc4bc RD |
11267 | <paramlist> |
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=""/> | |
11272 | </paramlist> | |
11273 | </method> | |
11274 | <method name="GetClippingRect" type="Rect" overloaded="no"> | |
781d2982 | 11275 | <autodoc>GetClippingRect(self) -> Rect</autodoc> |
ce6878e6 | 11276 | <docstring>Gets the rectangle surrounding the current clipping region.</docstring> |
f32fc4bc RD |
11277 | </method> |
11278 | <method name="GetCharHeight" type="int" overloaded="no"> | |
781d2982 | 11279 | <autodoc>GetCharHeight(self) -> int</autodoc> |
ce6878e6 | 11280 | <docstring>Gets the character height of the currently set font.</docstring> |
f32fc4bc RD |
11281 | </method> |
11282 | <method name="GetCharWidth" type="int" overloaded="no"> | |
781d2982 | 11283 | <autodoc>GetCharWidth(self) -> int</autodoc> |
ce6878e6 | 11284 | <docstring>Gets the average character width of the currently set font.</docstring> |
f32fc4bc RD |
11285 | </method> |
11286 | <method name="GetTextExtent" type="" overloaded="no"> | |
11287 | <autodoc>GetTextExtent(wxString string) -> (width, height)</autodoc> | |
ce6878e6 RD |
11288 | <docstring>Get the width and height of the text using the current font. Only |
11289 | works for single line strings.</docstring> | |
f32fc4bc RD |
11290 | <paramlist> |
11291 | <param name="string" type="String" default=""/> | |
11292 | <param name="OUTPUT" type="int" default=""/> | |
11293 | <param name="OUTPUT" type="int" default=""/> | |
11294 | </paramlist> | |
11295 | </method> | |
11296 | <method name="GetFullTextExtent" type="" overloaded="no"> | |
11297 | <autodoc>GetFullTextExtent(wxString string, Font font=None) -> | |
11298 | (width, height, descent, externalLeading)</autodoc> | |
781d2982 RD |
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> | |
f32fc4bc RD |
11301 | <paramlist> |
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"/> | |
11308 | </paramlist> | |
11309 | </method> | |
11310 | <method name="GetMultiLineTextExtent" type="" overloaded="no"> | |
11311 | <autodoc>GetMultiLineTextExtent(wxString string, Font font=None) -> | |
11312 | (width, height, descent, externalLeading)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11316 | <paramlist> |
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"/> | |
11322 | </paramlist> | |
11323 | </method> | |
11324 | <method name="GetPartialTextExtents" type="wxArrayInt" overloaded="no"> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11332 | <paramlist> |
11333 | <param name="text" type="String" default=""/> | |
11334 | </paramlist> | |
11335 | </method> | |
11336 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 | 11337 | <autodoc>GetSize(self) -> Size</autodoc> |
ce6878e6 RD |
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:: | |
11343 | ||
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)) | |
11348 | </docstring> | |
f32fc4bc RD |
11349 | </method> |
11350 | <method name="GetSizeTuple" type="" overloaded="no"> | |
11351 | <autodoc>GetSizeTuple() -> (width, height)</autodoc> | |
ce6878e6 RD |
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:: | |
11357 | ||
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)) | |
11362 | </docstring> | |
f32fc4bc RD |
11363 | <paramlist> |
11364 | <param name="OUTPUT" type="int" default=""/> | |
11365 | <param name="OUTPUT" type="int" default=""/> | |
11366 | </paramlist> | |
11367 | </method> | |
11368 | <method name="GetSizeMM" type="Size" overloaded="no"> | |
781d2982 | 11369 | <autodoc>GetSizeMM(self) -> Size</autodoc> |
f32fc4bc RD |
11370 | <docstring>Get the DC size in milimeters.</docstring> |
11371 | </method> | |
11372 | <method name="GetSizeMMTuple" type="" overloaded="no"> | |
11373 | <autodoc>GetSizeMMTuple() -> (width, height)</autodoc> | |
11374 | <docstring>Get the DC size in milimeters.</docstring> | |
11375 | <paramlist> | |
11376 | <param name="OUTPUT" type="int" default=""/> | |
11377 | <param name="OUTPUT" type="int" default=""/> | |
11378 | </paramlist> | |
11379 | </method> | |
11380 | <method name="DeviceToLogicalX" type="int" overloaded="no"> | |
781d2982 | 11381 | <autodoc>DeviceToLogicalX(self, int x) -> int</autodoc> |
ce6878e6 RD |
11382 | <docstring>Convert device X coordinate to logical coordinate, using the current |
11383 | mapping mode.</docstring> | |
f32fc4bc RD |
11384 | <paramlist> |
11385 | <param name="x" type="int" default=""/> | |
11386 | </paramlist> | |
11387 | </method> | |
11388 | <method name="DeviceToLogicalY" type="int" overloaded="no"> | |
781d2982 | 11389 | <autodoc>DeviceToLogicalY(self, int y) -> int</autodoc> |
ce6878e6 RD |
11390 | <docstring>Converts device Y coordinate to logical coordinate, using the current |
11391 | mapping mode.</docstring> | |
f32fc4bc RD |
11392 | <paramlist> |
11393 | <param name="y" type="int" default=""/> | |
11394 | </paramlist> | |
11395 | </method> | |
11396 | <method name="DeviceToLogicalXRel" type="int" overloaded="no"> | |
781d2982 | 11397 | <autodoc>DeviceToLogicalXRel(self, int x) -> int</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11401 | <paramlist> |
11402 | <param name="x" type="int" default=""/> | |
11403 | </paramlist> | |
11404 | </method> | |
11405 | <method name="DeviceToLogicalYRel" type="int" overloaded="no"> | |
781d2982 | 11406 | <autodoc>DeviceToLogicalYRel(self, int y) -> int</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11410 | <paramlist> |
11411 | <param name="y" type="int" default=""/> | |
11412 | </paramlist> | |
11413 | </method> | |
11414 | <method name="LogicalToDeviceX" type="int" overloaded="no"> | |
781d2982 | 11415 | <autodoc>LogicalToDeviceX(self, int x) -> int</autodoc> |
ce6878e6 RD |
11416 | <docstring>Converts logical X coordinate to device coordinate, using the current |
11417 | mapping mode.</docstring> | |
f32fc4bc RD |
11418 | <paramlist> |
11419 | <param name="x" type="int" default=""/> | |
11420 | </paramlist> | |
11421 | </method> | |
11422 | <method name="LogicalToDeviceY" type="int" overloaded="no"> | |
781d2982 | 11423 | <autodoc>LogicalToDeviceY(self, int y) -> int</autodoc> |
ce6878e6 RD |
11424 | <docstring>Converts logical Y coordinate to device coordinate, using the current |
11425 | mapping mode.</docstring> | |
f32fc4bc RD |
11426 | <paramlist> |
11427 | <param name="y" type="int" default=""/> | |
11428 | </paramlist> | |
11429 | </method> | |
11430 | <method name="LogicalToDeviceXRel" type="int" overloaded="no"> | |
781d2982 | 11431 | <autodoc>LogicalToDeviceXRel(self, int x) -> int</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11435 | <paramlist> |
11436 | <param name="x" type="int" default=""/> | |
11437 | </paramlist> | |
11438 | </method> | |
11439 | <method name="LogicalToDeviceYRel" type="int" overloaded="no"> | |
781d2982 | 11440 | <autodoc>LogicalToDeviceYRel(self, int y) -> int</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11444 | <paramlist> |
11445 | <param name="y" type="int" default=""/> | |
11446 | </paramlist> | |
11447 | </method> | |
11448 | <method name="CanDrawBitmap" type="bool" overloaded="no"> | |
781d2982 | 11449 | <autodoc>CanDrawBitmap(self) -> bool</autodoc> |
f32fc4bc RD |
11450 | </method> |
11451 | <method name="CanGetTextExtent" type="bool" overloaded="no"> | |
781d2982 | 11452 | <autodoc>CanGetTextExtent(self) -> bool</autodoc> |
f32fc4bc RD |
11453 | </method> |
11454 | <method name="GetDepth" type="int" overloaded="no"> | |
781d2982 | 11455 | <autodoc>GetDepth(self) -> int</autodoc> |
ce6878e6 | 11456 | <docstring>Returns the colour depth of the DC.</docstring> |
f32fc4bc RD |
11457 | </method> |
11458 | <method name="GetPPI" type="Size" overloaded="no"> | |
781d2982 | 11459 | <autodoc>GetPPI(self) -> Size</autodoc> |
ce6878e6 | 11460 | <docstring>Resolution in Pixels per inch</docstring> |
f32fc4bc RD |
11461 | </method> |
11462 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 11463 | <autodoc>Ok(self) -> bool</autodoc> |
ce6878e6 | 11464 | <docstring>Returns true if the DC is ok to use.</docstring> |
f32fc4bc RD |
11465 | </method> |
11466 | <method name="GetBackgroundMode" type="int" overloaded="no"> | |
781d2982 | 11467 | <autodoc>GetBackgroundMode(self) -> int</autodoc> |
ce6878e6 RD |
11468 | <docstring>Returns the current background mode, either ``wx.SOLID`` or |
11469 | ``wx.TRANSPARENT``. | |
11470 | ||
11471 | :see: `SetBackgroundMode`</docstring> | |
f32fc4bc RD |
11472 | </method> |
11473 | <method name="GetBackground" type="Brush" overloaded="no"> | |
781d2982 | 11474 | <autodoc>GetBackground(self) -> Brush</autodoc> |
ce6878e6 RD |
11475 | <docstring>Gets the brush used for painting the background. |
11476 | ||
11477 | :see: `SetBackground`</docstring> | |
f32fc4bc RD |
11478 | </method> |
11479 | <method name="GetBrush" type="Brush" overloaded="no"> | |
781d2982 | 11480 | <autodoc>GetBrush(self) -> Brush</autodoc> |
ce6878e6 | 11481 | <docstring>Gets the current brush</docstring> |
f32fc4bc RD |
11482 | </method> |
11483 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 11484 | <autodoc>GetFont(self) -> Font</autodoc> |
ce6878e6 | 11485 | <docstring>Gets the current font</docstring> |
f32fc4bc RD |
11486 | </method> |
11487 | <method name="GetPen" type="Pen" overloaded="no"> | |
781d2982 | 11488 | <autodoc>GetPen(self) -> Pen</autodoc> |
ce6878e6 | 11489 | <docstring>Gets the current pen</docstring> |
f32fc4bc RD |
11490 | </method> |
11491 | <method name="GetTextBackground" type="Colour" overloaded="no"> | |
781d2982 | 11492 | <autodoc>GetTextBackground(self) -> Colour</autodoc> |
ce6878e6 | 11493 | <docstring>Gets the current text background colour</docstring> |
f32fc4bc RD |
11494 | </method> |
11495 | <method name="GetTextForeground" type="Colour" overloaded="no"> | |
781d2982 | 11496 | <autodoc>GetTextForeground(self) -> Colour</autodoc> |
ce6878e6 | 11497 | <docstring>Gets the current text foreground colour</docstring> |
f32fc4bc RD |
11498 | </method> |
11499 | <method name="SetTextForeground" type="" overloaded="no"> | |
781d2982 | 11500 | <autodoc>SetTextForeground(self, Colour colour)</autodoc> |
ce6878e6 | 11501 | <docstring>Sets the current text foreground colour for the DC.</docstring> |
f32fc4bc RD |
11502 | <paramlist> |
11503 | <param name="colour" type="Colour" default=""/> | |
11504 | </paramlist> | |
11505 | </method> | |
11506 | <method name="SetTextBackground" type="" overloaded="no"> | |
781d2982 | 11507 | <autodoc>SetTextBackground(self, Colour colour)</autodoc> |
ce6878e6 | 11508 | <docstring>Sets the current text background colour for the DC.</docstring> |
f32fc4bc RD |
11509 | <paramlist> |
11510 | <param name="colour" type="Colour" default=""/> | |
11511 | </paramlist> | |
11512 | </method> | |
11513 | <method name="GetMapMode" type="int" overloaded="no"> | |
781d2982 | 11514 | <autodoc>GetMapMode(self) -> int</autodoc> |
ce6878e6 | 11515 | <docstring>Gets the current *mapping mode* for the device context </docstring> |
f32fc4bc RD |
11516 | </method> |
11517 | <method name="SetMapMode" type="" overloaded="no"> | |
781d2982 | 11518 | <autodoc>SetMapMode(self, int mode)</autodoc> |
ce6878e6 RD |
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: | |
11522 | ||
11523 | ================ ============================================= | |
11524 | wx.MM_TWIPS Each logical unit is 1/20 of a point, or 1/1440 | |
11525 | of an inch. | |
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 | ================ ============================================= | |
11531 | ||
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 | |
11537 | match is found. | |
11538 | ||
11539 | The coordinate origin is always at the top left of the screen/printer. | |
11540 | ||
11541 | Drawing to a Windows printer device context uses the current mapping | |
11542 | mode, but mapping mode is currently ignored for PostScript output. | |
11543 | </docstring> | |
f32fc4bc RD |
11544 | <paramlist> |
11545 | <param name="mode" type="int" default=""/> | |
11546 | </paramlist> | |
11547 | </method> | |
11548 | <method name="GetUserScale" type="" overloaded="no"> | |
ce6878e6 RD |
11549 | <autodoc>GetUserScale(self) -> (xScale, yScale)</autodoc> |
11550 | <docstring>Gets the current user scale factor (set by `SetUserScale`).</docstring> | |
f32fc4bc RD |
11551 | <paramlist> |
11552 | <param name="OUTPUT" type="double" default=""/> | |
11553 | <param name="OUTPUT" type="double" default=""/> | |
11554 | </paramlist> | |
11555 | </method> | |
11556 | <method name="SetUserScale" type="" overloaded="no"> | |
781d2982 | 11557 | <autodoc>SetUserScale(self, double x, double y)</autodoc> |
ce6878e6 RD |
11558 | <docstring>Sets the user scaling factor, useful for applications which require |
11559 | 'zooming'.</docstring> | |
f32fc4bc RD |
11560 | <paramlist> |
11561 | <param name="x" type="double" default=""/> | |
11562 | <param name="y" type="double" default=""/> | |
11563 | </paramlist> | |
11564 | </method> | |
11565 | <method name="GetLogicalScale" type="" overloaded="no"> | |
11566 | <autodoc>GetLogicalScale() -> (xScale, yScale)</autodoc> | |
11567 | <paramlist> | |
11568 | <param name="OUTPUT" type="double" default=""/> | |
11569 | <param name="OUTPUT" type="double" default=""/> | |
11570 | </paramlist> | |
11571 | </method> | |
11572 | <method name="SetLogicalScale" type="" overloaded="no"> | |
781d2982 | 11573 | <autodoc>SetLogicalScale(self, double x, double y)</autodoc> |
f32fc4bc RD |
11574 | <paramlist> |
11575 | <param name="x" type="double" default=""/> | |
11576 | <param name="y" type="double" default=""/> | |
11577 | </paramlist> | |
11578 | </method> | |
11579 | <method name="GetLogicalOrigin" type="Point" overloaded="no"> | |
781d2982 | 11580 | <autodoc>GetLogicalOrigin(self) -> Point</autodoc> |
f32fc4bc RD |
11581 | </method> |
11582 | <method name="GetLogicalOriginTuple" type="" overloaded="no"> | |
11583 | <autodoc>GetLogicalOriginTuple() -> (x,y)</autodoc> | |
11584 | <paramlist> | |
11585 | <param name="OUTPUT" type="int" default=""/> | |
11586 | <param name="OUTPUT" type="int" default=""/> | |
11587 | </paramlist> | |
11588 | </method> | |
11589 | <method name="SetLogicalOrigin" type="" overloaded="no"> | |
781d2982 | 11590 | <autodoc>SetLogicalOrigin(self, int x, int y)</autodoc> |
f32fc4bc RD |
11591 | <paramlist> |
11592 | <param name="x" type="int" default=""/> | |
11593 | <param name="y" type="int" default=""/> | |
11594 | </paramlist> | |
11595 | </method> | |
781d2982 RD |
11596 | <method name="SetLogicalOriginPoint" type="" overloaded="no"> |
11597 | <autodoc>SetLogicalOriginPoint(self, Point point)</autodoc> | |
11598 | <paramlist> | |
11599 | <param name="point" type="Point" default=""/> | |
11600 | </paramlist> | |
11601 | </method> | |
f32fc4bc | 11602 | <method name="GetDeviceOrigin" type="Point" overloaded="no"> |
781d2982 | 11603 | <autodoc>GetDeviceOrigin(self) -> Point</autodoc> |
f32fc4bc RD |
11604 | </method> |
11605 | <method name="GetDeviceOriginTuple" type="" overloaded="no"> | |
11606 | <autodoc>GetDeviceOriginTuple() -> (x,y)</autodoc> | |
11607 | <paramlist> | |
11608 | <param name="OUTPUT" type="int" default=""/> | |
11609 | <param name="OUTPUT" type="int" default=""/> | |
11610 | </paramlist> | |
11611 | </method> | |
11612 | <method name="SetDeviceOrigin" type="" overloaded="no"> | |
781d2982 | 11613 | <autodoc>SetDeviceOrigin(self, int x, int y)</autodoc> |
f32fc4bc RD |
11614 | <paramlist> |
11615 | <param name="x" type="int" default=""/> | |
11616 | <param name="y" type="int" default=""/> | |
11617 | </paramlist> | |
11618 | </method> | |
781d2982 RD |
11619 | <method name="SetDeviceOriginPoint" type="" overloaded="no"> |
11620 | <autodoc>SetDeviceOriginPoint(self, Point point)</autodoc> | |
11621 | <paramlist> | |
11622 | <param name="point" type="Point" default=""/> | |
11623 | </paramlist> | |
11624 | </method> | |
f32fc4bc | 11625 | <method name="SetAxisOrientation" type="" overloaded="no"> |
781d2982 | 11626 | <autodoc>SetAxisOrientation(self, bool xLeftRight, bool yBottomUp)</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11630 | <paramlist> |
11631 | <param name="xLeftRight" type="bool" default=""/> | |
11632 | <param name="yBottomUp" type="bool" default=""/> | |
11633 | </paramlist> | |
11634 | </method> | |
11635 | <method name="GetLogicalFunction" type="int" overloaded="no"> | |
781d2982 | 11636 | <autodoc>GetLogicalFunction(self) -> int</autodoc> |
ce6878e6 | 11637 | <docstring>Gets the current logical function (set by `SetLogicalFunction`).</docstring> |
f32fc4bc RD |
11638 | </method> |
11639 | <method name="SetLogicalFunction" type="" overloaded="no"> | |
781d2982 | 11640 | <autodoc>SetLogicalFunction(self, int function)</autodoc> |
ce6878e6 RD |
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. | |
11645 | ||
11646 | The possible values and their meaning in terms of source and | |
11647 | destination pixel values are as follows: | |
11648 | ||
11649 | ================ ========================== | |
11650 | wx.AND src AND dst | |
11651 | wx.AND_INVERT (NOT src) AND dst | |
11652 | wx.AND_REVERSE src AND (NOT dst) | |
11653 | wx.CLEAR 0 | |
11654 | wx.COPY src | |
11655 | wx.EQUIV (NOT src) XOR dst | |
11656 | wx.INVERT NOT dst | |
11657 | wx.NAND (NOT src) OR (NOT dst) | |
11658 | wx.NOR (NOT src) AND (NOT dst) | |
11659 | wx.NO_OP dst | |
11660 | wx.OR src OR dst | |
11661 | wx.OR_INVERT (NOT src) OR dst | |
11662 | wx.OR_REVERSE src OR (NOT dst) | |
11663 | wx.SET 1 | |
11664 | wx.SRC_INVERT NOT src | |
11665 | wx.XOR src XOR dst | |
11666 | ================ ========================== | |
11667 | ||
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 | |
11672 | colour. | |
11673 | </docstring> | |
f32fc4bc RD |
11674 | <paramlist> |
11675 | <param name="function" type="int" default=""/> | |
11676 | </paramlist> | |
11677 | </method> | |
11678 | <method name="SetOptimization" type="" overloaded="no"> | |
ce6878e6 RD |
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. | |
11687 | ||
11688 | Setting optimization off, drawing, then setting it back on again, is a | |
11689 | trick that must occasionally be employed.</docstring> | |
f32fc4bc | 11690 | <paramlist> |
ce6878e6 | 11691 | <param name="optimize" type="bool" default=""/> |
f32fc4bc RD |
11692 | </paramlist> |
11693 | </method> | |
11694 | <method name="GetOptimization" type="bool" overloaded="no"> | |
781d2982 | 11695 | <autodoc>GetOptimization(self) -> bool</autodoc> |
ce6878e6 RD |
11696 | <docstring>Returns true if device context optimization is on. See |
11697 | `SetOptimization` for .</docstring> | |
f32fc4bc RD |
11698 | </method> |
11699 | <method name="CalcBoundingBox" type="" overloaded="no"> | |
781d2982 | 11700 | <autodoc>CalcBoundingBox(self, int x, int y)</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11703 | <paramlist> |
11704 | <param name="x" type="int" default=""/> | |
11705 | <param name="y" type="int" default=""/> | |
11706 | </paramlist> | |
11707 | </method> | |
781d2982 RD |
11708 | <method name="CalcBoundingBoxPoint" type="" overloaded="no"> |
11709 | <autodoc>CalcBoundingBoxPoint(self, Point point)</autodoc> | |
ce6878e6 RD |
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> | |
781d2982 RD |
11712 | <paramlist> |
11713 | <param name="point" type="Point" default=""/> | |
11714 | </paramlist> | |
11715 | </method> | |
f32fc4bc | 11716 | <method name="ResetBoundingBox" type="" overloaded="no"> |
781d2982 | 11717 | <autodoc>ResetBoundingBox(self)</autodoc> |
ce6878e6 RD |
11718 | <docstring>Resets the bounding box: after a call to this function, the bounding |
11719 | box doesn't contain anything.</docstring> | |
f32fc4bc RD |
11720 | </method> |
11721 | <method name="MinX" type="int" overloaded="no"> | |
781d2982 | 11722 | <autodoc>MinX(self) -> int</autodoc> |
ce6878e6 | 11723 | <docstring>Gets the minimum horizontal extent used in drawing commands so far.</docstring> |
f32fc4bc RD |
11724 | </method> |
11725 | <method name="MaxX" type="int" overloaded="no"> | |
781d2982 | 11726 | <autodoc>MaxX(self) -> int</autodoc> |
ce6878e6 | 11727 | <docstring>Gets the maximum horizontal extent used in drawing commands so far.</docstring> |
f32fc4bc RD |
11728 | </method> |
11729 | <method name="MinY" type="int" overloaded="no"> | |
781d2982 | 11730 | <autodoc>MinY(self) -> int</autodoc> |
ce6878e6 | 11731 | <docstring>Gets the minimum vertical extent used in drawing commands so far.</docstring> |
f32fc4bc RD |
11732 | </method> |
11733 | <method name="MaxY" type="int" overloaded="no"> | |
781d2982 | 11734 | <autodoc>MaxY(self) -> int</autodoc> |
ce6878e6 | 11735 | <docstring>Gets the maximum vertical extent used in drawing commands so far.</docstring> |
f32fc4bc RD |
11736 | </method> |
11737 | <method name="GetBoundingBox" type="" overloaded="no"> | |
11738 | <autodoc>GetBoundingBox() -> (x1,y1, x2,y2)</autodoc> | |
ce6878e6 | 11739 | <docstring>Returns the min and max points used in drawing commands so far.</docstring> |
f32fc4bc RD |
11740 | <paramlist> |
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=""/> | |
11745 | </paramlist> | |
11746 | </method> | |
11747 | <method name="_DrawPointList" type="PyObject" overloaded="no"> | |
781d2982 | 11748 | <autodoc>_DrawPointList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc> |
f32fc4bc RD |
11749 | <paramlist> |
11750 | <param name="pyCoords" type="PyObject" default=""/> | |
11751 | <param name="pyPens" type="PyObject" default=""/> | |
11752 | <param name="pyBrushes" type="PyObject" default=""/> | |
11753 | </paramlist> | |
11754 | </method> | |
11755 | <method name="_DrawLineList" type="PyObject" overloaded="no"> | |
781d2982 | 11756 | <autodoc>_DrawLineList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc> |
f32fc4bc RD |
11757 | <paramlist> |
11758 | <param name="pyCoords" type="PyObject" default=""/> | |
11759 | <param name="pyPens" type="PyObject" default=""/> | |
11760 | <param name="pyBrushes" type="PyObject" default=""/> | |
11761 | </paramlist> | |
11762 | </method> | |
11763 | <method name="_DrawRectangleList" type="PyObject" overloaded="no"> | |
781d2982 | 11764 | <autodoc>_DrawRectangleList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc> |
f32fc4bc RD |
11765 | <paramlist> |
11766 | <param name="pyCoords" type="PyObject" default=""/> | |
11767 | <param name="pyPens" type="PyObject" default=""/> | |
11768 | <param name="pyBrushes" type="PyObject" default=""/> | |
11769 | </paramlist> | |
11770 | </method> | |
11771 | <method name="_DrawEllipseList" type="PyObject" overloaded="no"> | |
781d2982 | 11772 | <autodoc>_DrawEllipseList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc> |
f32fc4bc RD |
11773 | <paramlist> |
11774 | <param name="pyCoords" type="PyObject" default=""/> | |
11775 | <param name="pyPens" type="PyObject" default=""/> | |
11776 | <param name="pyBrushes" type="PyObject" default=""/> | |
11777 | </paramlist> | |
11778 | </method> | |
11779 | <method name="_DrawPolygonList" type="PyObject" overloaded="no"> | |
781d2982 | 11780 | <autodoc>_DrawPolygonList(self, PyObject pyCoords, PyObject pyPens, PyObject pyBrushes) -> PyObject</autodoc> |
f32fc4bc RD |
11781 | <paramlist> |
11782 | <param name="pyCoords" type="PyObject" default=""/> | |
11783 | <param name="pyPens" type="PyObject" default=""/> | |
11784 | <param name="pyBrushes" type="PyObject" default=""/> | |
11785 | </paramlist> | |
11786 | </method> | |
11787 | <method name="_DrawTextList" type="PyObject" overloaded="no"> | |
781d2982 | 11788 | <autodoc>_DrawTextList(self, PyObject textList, PyObject pyPoints, PyObject foregroundList, |
f32fc4bc RD |
11789 | PyObject backgroundList) -> PyObject</autodoc> |
11790 | <paramlist> | |
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=""/> | |
11795 | </paramlist> | |
11796 | </method> | |
11797 | </class> | |
11798 | <pythoncode> | |
0f43fbdf RD |
11799 | #--------------------------------------------------------------------------- |
11800 | </pythoncode> | |
781d2982 | 11801 | <class name="MemoryDC" oldname="wxMemoryDC" module="_gdi"> |
ce6878e6 RD |
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:: | |
11805 | ||
11806 | dc = wx.MemoryDC() | |
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 | |
11811 | ||
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. | |
11814 | </docstring> | |
f32fc4bc RD |
11815 | <baseclass name="DC"/> |
11816 | <constructor name="MemoryDC" overloaded="no"> | |
781d2982 | 11817 | <autodoc>__init__(self) -> MemoryDC</autodoc> |
ce6878e6 RD |
11818 | <docstring>Constructs a new memory device context. |
11819 | ||
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. | |
11823 | ||
11824 | :see: `MemoryDCFromDC`</docstring> | |
f32fc4bc RD |
11825 | </constructor> |
11826 | <constructor name="MemoryDCFromDC" overloaded="no"> | |
11827 | <autodoc>MemoryDCFromDC(DC oldDC) -> MemoryDC</autodoc> | |
ce6878e6 | 11828 | <docstring>Creates a DC that is compatible with the oldDC.</docstring> |
f32fc4bc RD |
11829 | <paramlist> |
11830 | <param name="oldDC" type="DC" default=""/> | |
11831 | </paramlist> | |
11832 | </constructor> | |
11833 | <method name="SelectObject" type="" overloaded="no"> | |
781d2982 | 11834 | <autodoc>SelectObject(self, Bitmap bitmap)</autodoc> |
ce6878e6 RD |
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. | |
11839 | ||
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> | |
f32fc4bc RD |
11844 | <paramlist> |
11845 | <param name="bitmap" type="Bitmap" default=""/> | |
11846 | </paramlist> | |
11847 | </method> | |
11848 | </class> | |
11849 | <pythoncode> | |
856bf319 RD |
11850 | #--------------------------------------------------------------------------- |
11851 | </pythoncode> | |
781d2982 | 11852 | <class name="BufferedDC" oldname="wxBufferedDC" module="_gdi"> |
ce6878e6 RD |
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 | |
11856 | is destroyed. | |
11857 | ||
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`. | |
11862 | </docstring> | |
f32fc4bc RD |
11863 | <baseclass name="MemoryDC"/> |
11864 | <constructor name="BufferedDC" overloaded="yes"> | |
ce6878e6 RD |
11865 | <docstring>Constructs a buffered DC. |
11866 | ||
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 | |
11870 | flush it. | |
11871 | ||
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. | |
11881 | </docstring> | |
f32fc4bc RD |
11882 | <paramlist> |
11883 | <param name="dc" type="DC" default=""/> | |
11884 | <param name="buffer" type="Bitmap" default=""/> | |
11885 | </paramlist> | |
11886 | </constructor> | |
11887 | <constructor name="BufferedDC" overloaded="yes"> | |
781d2982 RD |
11888 | <autodoc>__init__(self, DC dc, Bitmap buffer) -> BufferedDC |
11889 | __init__(self, DC dc, Size area) -> BufferedDC</autodoc> | |
ce6878e6 RD |
11890 | <docstring>Constructs a buffered DC. |
11891 | ||
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 | |
11895 | flush it. | |
11896 | ||
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. | |
11906 | </docstring> | |
f32fc4bc RD |
11907 | <paramlist> |
11908 | <param name="dc" type="DC" default=""/> | |
11909 | <param name="area" type="Size" default=""/> | |
f32fc4bc RD |
11910 | </paramlist> |
11911 | </constructor> | |
c2dda882 | 11912 | <destructor name="~wxBufferedDC" overloaded="no"> |
781d2982 | 11913 | <autodoc>__del__(self)</autodoc> |
ce6878e6 RD |
11914 | <docstring>Copies everything drawn on the DC so far to the underlying DC |
11915 | associated with this object, if any.</docstring> | |
c2dda882 | 11916 | </destructor> |
f32fc4bc | 11917 | <method name="UnMask" type="" overloaded="no"> |
781d2982 | 11918 | <autodoc>UnMask(self)</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
11922 | </method> |
11923 | </class> | |
781d2982 | 11924 | <class name="BufferedPaintDC" oldname="wxBufferedPaintDC" module="_gdi"> |
ce6878e6 RD |
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`. | |
11932 | ||
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:: | |
11937 | ||
11938 | def OnPaint(self, event): | |
11939 | dc = wx.BufferedPaintDC(self, self.buffer) | |
11940 | ||
11941 | ||
11942 | </docstring> | |
f32fc4bc | 11943 | <baseclass name="BufferedDC"/> |
c2dda882 | 11944 | <constructor name="BufferedPaintDC" overloaded="no"> |
781d2982 | 11945 | <autodoc>__init__(self, Window window, Bitmap buffer=NullBitmap) -> BufferedPaintDC</autodoc> |
ce6878e6 RD |
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). | |
11950 | ||
11951 | </docstring> | |
f32fc4bc RD |
11952 | <paramlist> |
11953 | <param name="window" type="Window" default=""/> | |
c2dda882 | 11954 | <param name="buffer" type="Bitmap" default="wxNullBitmap"/> |
f32fc4bc RD |
11955 | </paramlist> |
11956 | </constructor> | |
11957 | </class> | |
11958 | <pythoncode> | |
856bf319 RD |
11959 | #--------------------------------------------------------------------------- |
11960 | </pythoncode> | |
781d2982 | 11961 | <class name="ScreenDC" oldname="wxScreenDC" module="_gdi"> |
ce6878e6 RD |
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 | |
11964 | wxScreenDC object. | |
11965 | </docstring> | |
f32fc4bc RD |
11966 | <baseclass name="DC"/> |
11967 | <constructor name="ScreenDC" overloaded="no"> | |
781d2982 | 11968 | <autodoc>__init__(self) -> ScreenDC</autodoc> |
ce6878e6 RD |
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 | |
11971 | wxScreenDC object. | |
11972 | </docstring> | |
f32fc4bc RD |
11973 | </constructor> |
11974 | <method name="StartDrawingOnTopWin" type="bool" overloaded="no"> | |
781d2982 | 11975 | <autodoc>StartDrawingOnTopWin(self, Window window) -> bool</autodoc> |
ce6878e6 RD |
11976 | <docstring>Specify that the area of the screen to be drawn upon coincides with |
11977 | the given window. | |
11978 | ||
11979 | :see: `EndDrawingOnTop`</docstring> | |
f32fc4bc RD |
11980 | <paramlist> |
11981 | <param name="window" type="Window" default=""/> | |
11982 | </paramlist> | |
11983 | </method> | |
11984 | <method name="StartDrawingOnTop" type="bool" overloaded="no"> | |
781d2982 | 11985 | <autodoc>StartDrawingOnTop(self, Rect rect=None) -> bool</autodoc> |
ce6878e6 RD |
11986 | <docstring>Specify that the area is the given rectangle, or the whole screen if |
11987 | ``None`` is passed. | |
11988 | ||
11989 | :see: `EndDrawingOnTop`</docstring> | |
f32fc4bc RD |
11990 | <paramlist> |
11991 | <param name="rect" type="Rect" default="NULL"/> | |
11992 | </paramlist> | |
11993 | </method> | |
11994 | <method name="EndDrawingOnTop" type="bool" overloaded="no"> | |
781d2982 | 11995 | <autodoc>EndDrawingOnTop(self) -> bool</autodoc> |
ce6878e6 RD |
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. | |
12000 | ||
12001 | You might use this pair of functions when implementing a drag feature, | |
12002 | for example as in the `wx.SplitterWindow` implementation. | |
12003 | ||
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> | |
f32fc4bc RD |
12008 | </method> |
12009 | </class> | |
12010 | <pythoncode> | |
0f43fbdf RD |
12011 | #--------------------------------------------------------------------------- |
12012 | </pythoncode> | |
781d2982 | 12013 | <class name="ClientDC" oldname="wxClientDC" module="_gdi"> |
ce6878e6 RD |
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. | |
12018 | ||
12019 | To draw on a window from within an EVT_PAINT handler, construct a | |
12020 | `wx.PaintDC` object. | |
12021 | ||
12022 | To draw on the whole window including decorations, construct a | |
12023 | `wx.WindowDC` object (Windows only). | |
12024 | </docstring> | |
f32fc4bc RD |
12025 | <baseclass name="DC"/> |
12026 | <constructor name="ClientDC" overloaded="no"> | |
781d2982 | 12027 | <autodoc>__init__(self, Window win) -> ClientDC</autodoc> |
ce6878e6 | 12028 | <docstring>Constructor. Pass the window on which you wish to paint.</docstring> |
f32fc4bc RD |
12029 | <paramlist> |
12030 | <param name="win" type="Window" default=""/> | |
12031 | </paramlist> | |
12032 | </constructor> | |
12033 | </class> | |
12034 | <pythoncode> | |
0f43fbdf RD |
12035 | #--------------------------------------------------------------------------- |
12036 | </pythoncode> | |
781d2982 | 12037 | <class name="PaintDC" oldname="wxPaintDC" module="_gdi"> |
ce6878e6 RD |
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. | |
12044 | ||
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. | |
12048 | ||
12049 | To draw on a window from outside EVT_PAINT handlers, construct a | |
12050 | `wx.ClientDC` object. | |
12051 | </docstring> | |
f32fc4bc RD |
12052 | <baseclass name="DC"/> |
12053 | <constructor name="PaintDC" overloaded="no"> | |
781d2982 | 12054 | <autodoc>__init__(self, Window win) -> PaintDC</autodoc> |
ce6878e6 | 12055 | <docstring>Constructor. Pass the window on which you wish to paint.</docstring> |
f32fc4bc RD |
12056 | <paramlist> |
12057 | <param name="win" type="Window" default=""/> | |
12058 | </paramlist> | |
12059 | </constructor> | |
12060 | </class> | |
0dd25e81 | 12061 | <pythoncode> |
0f43fbdf RD |
12062 | #--------------------------------------------------------------------------- |
12063 | </pythoncode> | |
781d2982 | 12064 | <class name="WindowDC" oldname="wxWindowDC" module="_gdi"> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
12069 | <baseclass name="DC"/> |
12070 | <constructor name="WindowDC" overloaded="no"> | |
781d2982 | 12071 | <autodoc>__init__(self, Window win) -> WindowDC</autodoc> |
ce6878e6 | 12072 | <docstring>Constructor. Pass the window on which you wish to paint.</docstring> |
f32fc4bc RD |
12073 | <paramlist> |
12074 | <param name="win" type="Window" default=""/> | |
12075 | </paramlist> | |
12076 | </constructor> | |
12077 | </class> | |
12078 | <pythoncode> | |
12079 | #--------------------------------------------------------------------------- | |
0f43fbdf | 12080 | </pythoncode> |
781d2982 | 12081 | <class name="MirrorDC" oldname="wxMirrorDC" module="_gdi"> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
12088 | <baseclass name="DC"/> |
12089 | <constructor name="MirrorDC" overloaded="no"> | |
781d2982 | 12090 | <autodoc>__init__(self, DC dc, bool mirror) -> MirrorDC</autodoc> |
ce6878e6 RD |
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> | |
f32fc4bc RD |
12094 | <paramlist> |
12095 | <param name="dc" type="DC" default=""/> | |
12096 | <param name="mirror" type="bool" default=""/> | |
12097 | </paramlist> | |
12098 | </constructor> | |
12099 | </class> | |
12100 | <pythoncode> | |
0f43fbdf RD |
12101 | #--------------------------------------------------------------------------- |
12102 | </pythoncode> | |
781d2982 | 12103 | <class name="PostScriptDC" oldname="wxPostScriptDC" module="_gdi"> |
ce6878e6 | 12104 | <docstring>This is a `wx.DC` that can write to PostScript files on any platform.</docstring> |
f32fc4bc RD |
12105 | <baseclass name="DC"/> |
12106 | <constructor name="PostScriptDC" overloaded="no"> | |
781d2982 | 12107 | <autodoc>__init__(self, wxPrintData printData) -> PostScriptDC</autodoc> |
ce6878e6 RD |
12108 | <docstring>Constructs a PostScript printer device context from a `wx.PrintData` |
12109 | object.</docstring> | |
f32fc4bc RD |
12110 | <paramlist> |
12111 | <param name="printData" type="wxPrintData" default=""/> | |
12112 | </paramlist> | |
12113 | </constructor> | |
12114 | <method name="GetPrintData" type="wxPrintData" overloaded="no"> | |
781d2982 | 12115 | <autodoc>GetPrintData(self) -> wxPrintData</autodoc> |
f32fc4bc RD |
12116 | </method> |
12117 | <method name="SetPrintData" type="" overloaded="no"> | |
781d2982 | 12118 | <autodoc>SetPrintData(self, wxPrintData data)</autodoc> |
f32fc4bc RD |
12119 | <paramlist> |
12120 | <param name="data" type="wxPrintData" default=""/> | |
12121 | </paramlist> | |
12122 | </method> | |
12123 | <staticmethod name="SetResolution" type="" overloaded="no"> | |
12124 | <autodoc>SetResolution(int ppi)</autodoc> | |
ce6878e6 RD |
12125 | <docstring>Set resolution (in pixels per inch) that will be used in PostScript |
12126 | output. Default is 720ppi.</docstring> | |
f32fc4bc RD |
12127 | <paramlist> |
12128 | <param name="ppi" type="int" default=""/> | |
12129 | </paramlist> | |
12130 | </staticmethod> | |
12131 | <staticmethod name="GetResolution" type="int" overloaded="no"> | |
12132 | <autodoc>GetResolution() -> int</autodoc> | |
ce6878e6 | 12133 | <docstring>Return resolution used in PostScript output.</docstring> |
f32fc4bc RD |
12134 | </staticmethod> |
12135 | </class> | |
0dd25e81 | 12136 | <pythoncode> |
0f43fbdf RD |
12137 | #--------------------------------------------------------------------------- |
12138 | </pythoncode> | |
781d2982 | 12139 | <class name="MetaFile" oldname="wxMetaFile" module="_gdi"> |
f32fc4bc RD |
12140 | <baseclass name="Object"/> |
12141 | <constructor name="MetaFile" overloaded="no"> | |
781d2982 | 12142 | <autodoc>__init__(self, String filename=EmptyString) -> MetaFile</autodoc> |
f32fc4bc RD |
12143 | <paramlist> |
12144 | <param name="filename" type="String" default="wxPyEmptyString"/> | |
12145 | </paramlist> | |
12146 | </constructor> | |
12147 | </class> | |
781d2982 | 12148 | <class name="MetaFileDC" oldname="wxMetaFileDC" module="_gdi"> |
f32fc4bc RD |
12149 | <baseclass name="DC"/> |
12150 | <constructor name="MetaFileDC" overloaded="no"> | |
781d2982 | 12151 | <autodoc>__init__(self, String filename=EmptyString, int width=0, int height=0, |
0f43fbdf | 12152 | String description=EmptyString) -> MetaFileDC</autodoc> |
f32fc4bc RD |
12153 | <paramlist> |
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"/> | |
12158 | </paramlist> | |
12159 | </constructor> | |
12160 | </class> | |
781d2982 | 12161 | <class name="PrinterDC" oldname="wxPrinterDC" module="_gdi"> |
f32fc4bc RD |
12162 | <baseclass name="DC"/> |
12163 | <constructor name="PrinterDC" overloaded="no"> | |
781d2982 | 12164 | <autodoc>__init__(self, wxPrintData printData) -> PrinterDC</autodoc> |
f32fc4bc RD |
12165 | <paramlist> |
12166 | <param name="printData" type="wxPrintData" default=""/> | |
12167 | </paramlist> | |
12168 | </constructor> | |
12169 | </class> | |
12170 | <pythoncode> | |
856bf319 RD |
12171 | #--------------------------------------------------------------------------- |
12172 | </pythoncode> | |
781d2982 | 12173 | <class name="ImageList" oldname="wxImageList" module="_gdi"> |
f32fc4bc RD |
12174 | <baseclass name="Object"/> |
12175 | <constructor name="ImageList" overloaded="no"> | |
781d2982 | 12176 | <autodoc>__init__(self, int width, int height, int mask=True, int initialCount=1) -> ImageList</autodoc> |
f32fc4bc RD |
12177 | <paramlist> |
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"/> | |
12182 | </paramlist> | |
12183 | </constructor> | |
12184 | <destructor name="~wxImageList" overloaded="no"> | |
781d2982 | 12185 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
12186 | </destructor> |
12187 | <method name="Add" type="int" overloaded="no"> | |
781d2982 | 12188 | <autodoc>Add(self, Bitmap bitmap, Bitmap mask=NullBitmap) -> int</autodoc> |
f32fc4bc RD |
12189 | <paramlist> |
12190 | <param name="bitmap" type="Bitmap" default=""/> | |
12191 | <param name="mask" type="Bitmap" default="wxNullBitmap"/> | |
12192 | </paramlist> | |
12193 | </method> | |
12194 | <method name="AddWithColourMask" type="int" overloaded="no"> | |
781d2982 | 12195 | <autodoc>AddWithColourMask(self, Bitmap bitmap, Colour maskColour) -> int</autodoc> |
f32fc4bc RD |
12196 | <paramlist> |
12197 | <param name="bitmap" type="Bitmap" default=""/> | |
12198 | <param name="maskColour" type="Colour" default=""/> | |
12199 | </paramlist> | |
12200 | </method> | |
12201 | <method name="AddIcon" type="int" overloaded="no"> | |
781d2982 | 12202 | <autodoc>AddIcon(self, Icon icon) -> int</autodoc> |
f32fc4bc RD |
12203 | <paramlist> |
12204 | <param name="icon" type="Icon" default=""/> | |
12205 | </paramlist> | |
12206 | </method> | |
12207 | <method name="Replace" type="bool" overloaded="no"> | |
781d2982 | 12208 | <autodoc>Replace(self, int index, Bitmap bitmap) -> bool</autodoc> |
f32fc4bc RD |
12209 | <paramlist> |
12210 | <param name="index" type="int" default=""/> | |
12211 | <param name="bitmap" type="Bitmap" default=""/> | |
12212 | </paramlist> | |
12213 | </method> | |
12214 | <method name="Draw" type="bool" overloaded="no"> | |
781d2982 | 12215 | <autodoc>Draw(self, int index, DC dc, int x, int x, int flags=IMAGELIST_DRAW_NORMAL, |
856bf319 | 12216 | bool solidBackground=False) -> bool</autodoc> |
f32fc4bc RD |
12217 | <paramlist> |
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"/> | |
12224 | </paramlist> | |
12225 | </method> | |
12226 | <method name="GetImageCount" type="int" overloaded="no"> | |
781d2982 | 12227 | <autodoc>GetImageCount(self) -> int</autodoc> |
f32fc4bc RD |
12228 | </method> |
12229 | <method name="Remove" type="bool" overloaded="no"> | |
781d2982 | 12230 | <autodoc>Remove(self, int index) -> bool</autodoc> |
f32fc4bc RD |
12231 | <paramlist> |
12232 | <param name="index" type="int" default=""/> | |
12233 | </paramlist> | |
12234 | </method> | |
12235 | <method name="RemoveAll" type="bool" overloaded="no"> | |
781d2982 | 12236 | <autodoc>RemoveAll(self) -> bool</autodoc> |
f32fc4bc RD |
12237 | </method> |
12238 | <method name="GetSize" type="" overloaded="no"> | |
12239 | <autodoc>GetSize() -> (width,height)</autodoc> | |
12240 | <paramlist> | |
12241 | <param name="index" type="int" default=""/> | |
12242 | <param name="OUTPUT" type="int" default=""/> | |
12243 | <param name="OUTPUT" type="int" default=""/> | |
12244 | </paramlist> | |
12245 | </method> | |
12246 | </class> | |
12247 | <pythoncode> | |
856bf319 RD |
12248 | #--------------------------------------------------------------------------- |
12249 | </pythoncode> | |
781d2982 | 12250 | <class name="PenList" oldname="wxPenList" module="_gdi"> |
f32fc4bc RD |
12251 | <baseclass name="Object"/> |
12252 | <method name="AddPen" type="" overloaded="no"> | |
781d2982 | 12253 | <autodoc>AddPen(self, Pen pen)</autodoc> |
f32fc4bc RD |
12254 | <paramlist> |
12255 | <param name="pen" type="Pen" default=""/> | |
12256 | </paramlist> | |
12257 | </method> | |
12258 | <method name="FindOrCreatePen" type="Pen" overloaded="no"> | |
781d2982 | 12259 | <autodoc>FindOrCreatePen(self, Colour colour, int width, int style) -> Pen</autodoc> |
f32fc4bc RD |
12260 | <paramlist> |
12261 | <param name="colour" type="Colour" default=""/> | |
12262 | <param name="width" type="int" default=""/> | |
12263 | <param name="style" type="int" default=""/> | |
12264 | </paramlist> | |
12265 | </method> | |
12266 | <method name="RemovePen" type="" overloaded="no"> | |
781d2982 | 12267 | <autodoc>RemovePen(self, Pen pen)</autodoc> |
f32fc4bc RD |
12268 | <paramlist> |
12269 | <param name="pen" type="Pen" default=""/> | |
12270 | </paramlist> | |
12271 | </method> | |
12272 | <method name="GetCount" type="int" overloaded="no"> | |
781d2982 | 12273 | <autodoc>GetCount(self) -> int</autodoc> |
f32fc4bc RD |
12274 | </method> |
12275 | </class> | |
781d2982 | 12276 | <class name="BrushList" oldname="wxBrushList" module="_gdi"> |
f32fc4bc RD |
12277 | <baseclass name="Object"/> |
12278 | <method name="AddBrush" type="" overloaded="no"> | |
781d2982 | 12279 | <autodoc>AddBrush(self, Brush brush)</autodoc> |
f32fc4bc RD |
12280 | <paramlist> |
12281 | <param name="brush" type="Brush" default=""/> | |
12282 | </paramlist> | |
12283 | </method> | |
12284 | <method name="FindOrCreateBrush" type="Brush" overloaded="no"> | |
781d2982 | 12285 | <autodoc>FindOrCreateBrush(self, Colour colour, int style) -> Brush</autodoc> |
f32fc4bc RD |
12286 | <paramlist> |
12287 | <param name="colour" type="Colour" default=""/> | |
12288 | <param name="style" type="int" default=""/> | |
12289 | </paramlist> | |
12290 | </method> | |
12291 | <method name="RemoveBrush" type="" overloaded="no"> | |
781d2982 | 12292 | <autodoc>RemoveBrush(self, Brush brush)</autodoc> |
f32fc4bc RD |
12293 | <paramlist> |
12294 | <param name="brush" type="Brush" default=""/> | |
12295 | </paramlist> | |
12296 | </method> | |
12297 | <method name="GetCount" type="int" overloaded="no"> | |
781d2982 | 12298 | <autodoc>GetCount(self) -> int</autodoc> |
f32fc4bc RD |
12299 | </method> |
12300 | </class> | |
781d2982 | 12301 | <class name="ColourDatabase" oldname="wxColourDatabase" module="_gdi"> |
f32fc4bc RD |
12302 | <baseclass name="Object"/> |
12303 | <constructor name="ColourDatabase" overloaded="no"> | |
781d2982 | 12304 | <autodoc>__init__(self) -> ColourDatabase</autodoc> |
f32fc4bc RD |
12305 | </constructor> |
12306 | <destructor name="~wxColourDatabase" overloaded="no"> | |
781d2982 | 12307 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
12308 | </destructor> |
12309 | <method name="Find" type="Colour" overloaded="no"> | |
781d2982 | 12310 | <autodoc>Find(self, String name) -> Colour</autodoc> |
f32fc4bc RD |
12311 | <paramlist> |
12312 | <param name="name" type="String" default=""/> | |
12313 | </paramlist> | |
12314 | </method> | |
12315 | <method name="FindName" type="String" overloaded="no"> | |
781d2982 | 12316 | <autodoc>FindName(self, Colour colour) -> String</autodoc> |
f32fc4bc RD |
12317 | <paramlist> |
12318 | <param name="colour" type="Colour" default=""/> | |
12319 | </paramlist> | |
12320 | </method> | |
12321 | <method name="AddColour" type="" overloaded="no"> | |
781d2982 | 12322 | <autodoc>AddColour(self, String name, Colour colour)</autodoc> |
f32fc4bc RD |
12323 | <paramlist> |
12324 | <param name="name" type="String" default=""/> | |
12325 | <param name="colour" type="Colour" default=""/> | |
12326 | </paramlist> | |
12327 | </method> | |
12328 | <method name="Append" type="" overloaded="no"> | |
781d2982 | 12329 | <autodoc>Append(self, String name, int red, int green, int blue)</autodoc> |
f32fc4bc RD |
12330 | <paramlist> |
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=""/> | |
12335 | </paramlist> | |
12336 | </method> | |
12337 | </class> | |
781d2982 | 12338 | <class name="FontList" oldname="wxFontList" module="_gdi"> |
f32fc4bc RD |
12339 | <baseclass name="Object"/> |
12340 | <method name="AddFont" type="" overloaded="no"> | |
781d2982 | 12341 | <autodoc>AddFont(self, Font font)</autodoc> |
f32fc4bc RD |
12342 | <paramlist> |
12343 | <param name="font" type="Font" default=""/> | |
12344 | </paramlist> | |
12345 | </method> | |
12346 | <method name="FindOrCreateFont" type="Font" overloaded="no"> | |
781d2982 | 12347 | <autodoc>FindOrCreateFont(self, int point_size, int family, int style, int weight, |
856bf319 RD |
12348 | bool underline=False, String facename=EmptyString, |
12349 | int encoding=FONTENCODING_DEFAULT) -> Font</autodoc> | |
f32fc4bc RD |
12350 | <paramlist> |
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"/> | |
12358 | </paramlist> | |
12359 | </method> | |
12360 | <method name="RemoveFont" type="" overloaded="no"> | |
781d2982 | 12361 | <autodoc>RemoveFont(self, Font font)</autodoc> |
f32fc4bc RD |
12362 | <paramlist> |
12363 | <param name="font" type="Font" default=""/> | |
12364 | </paramlist> | |
12365 | </method> | |
12366 | <method name="GetCount" type="int" overloaded="no"> | |
781d2982 | 12367 | <autodoc>GetCount(self) -> int</autodoc> |
f32fc4bc RD |
12368 | </method> |
12369 | </class> | |
12370 | <pythoncode> | |
856bf319 RD |
12371 | #--------------------------------------------------------------------------- |
12372 | </pythoncode> | |
f32fc4bc RD |
12373 | <pythoncode> NullColor = NullColour </pythoncode> |
12374 | <pythoncode> | |
856bf319 RD |
12375 | #--------------------------------------------------------------------------- |
12376 | </pythoncode> | |
781d2982 | 12377 | <class name="Effects" oldname="wxEffects" module="_gdi"> |
f32fc4bc RD |
12378 | <baseclass name="Object"/> |
12379 | <constructor name="Effects" overloaded="no"> | |
781d2982 | 12380 | <autodoc>__init__(self) -> Effects</autodoc> |
f32fc4bc RD |
12381 | </constructor> |
12382 | <method name="GetHighlightColour" type="Colour" overloaded="no"> | |
781d2982 | 12383 | <autodoc>GetHighlightColour(self) -> Colour</autodoc> |
f32fc4bc RD |
12384 | </method> |
12385 | <method name="GetLightShadow" type="Colour" overloaded="no"> | |
781d2982 | 12386 | <autodoc>GetLightShadow(self) -> Colour</autodoc> |
f32fc4bc RD |
12387 | </method> |
12388 | <method name="GetFaceColour" type="Colour" overloaded="no"> | |
781d2982 | 12389 | <autodoc>GetFaceColour(self) -> Colour</autodoc> |
f32fc4bc RD |
12390 | </method> |
12391 | <method name="GetMediumShadow" type="Colour" overloaded="no"> | |
781d2982 | 12392 | <autodoc>GetMediumShadow(self) -> Colour</autodoc> |
f32fc4bc RD |
12393 | </method> |
12394 | <method name="GetDarkShadow" type="Colour" overloaded="no"> | |
781d2982 | 12395 | <autodoc>GetDarkShadow(self) -> Colour</autodoc> |
f32fc4bc RD |
12396 | </method> |
12397 | <method name="SetHighlightColour" type="" overloaded="no"> | |
781d2982 | 12398 | <autodoc>SetHighlightColour(self, Colour c)</autodoc> |
f32fc4bc RD |
12399 | <paramlist> |
12400 | <param name="c" type="Colour" default=""/> | |
12401 | </paramlist> | |
12402 | </method> | |
12403 | <method name="SetLightShadow" type="" overloaded="no"> | |
781d2982 | 12404 | <autodoc>SetLightShadow(self, Colour c)</autodoc> |
f32fc4bc RD |
12405 | <paramlist> |
12406 | <param name="c" type="Colour" default=""/> | |
12407 | </paramlist> | |
12408 | </method> | |
12409 | <method name="SetFaceColour" type="" overloaded="no"> | |
781d2982 | 12410 | <autodoc>SetFaceColour(self, Colour c)</autodoc> |
f32fc4bc RD |
12411 | <paramlist> |
12412 | <param name="c" type="Colour" default=""/> | |
12413 | </paramlist> | |
12414 | </method> | |
12415 | <method name="SetMediumShadow" type="" overloaded="no"> | |
781d2982 | 12416 | <autodoc>SetMediumShadow(self, Colour c)</autodoc> |
f32fc4bc RD |
12417 | <paramlist> |
12418 | <param name="c" type="Colour" default=""/> | |
12419 | </paramlist> | |
12420 | </method> | |
12421 | <method name="SetDarkShadow" type="" overloaded="no"> | |
781d2982 | 12422 | <autodoc>SetDarkShadow(self, Colour c)</autodoc> |
f32fc4bc RD |
12423 | <paramlist> |
12424 | <param name="c" type="Colour" default=""/> | |
12425 | </paramlist> | |
12426 | </method> | |
12427 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 12428 | <autodoc>Set(self, Colour highlightColour, Colour lightShadow, Colour faceColour, |
856bf319 | 12429 | Colour mediumShadow, Colour darkShadow)</autodoc> |
f32fc4bc RD |
12430 | <paramlist> |
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=""/> | |
12436 | </paramlist> | |
12437 | </method> | |
12438 | <method name="DrawSunkenEdge" type="" overloaded="no"> | |
781d2982 | 12439 | <autodoc>DrawSunkenEdge(self, DC dc, Rect rect, int borderSize=1)</autodoc> |
f32fc4bc RD |
12440 | <paramlist> |
12441 | <param name="dc" type="DC" default=""/> | |
12442 | <param name="rect" type="Rect" default=""/> | |
12443 | <param name="borderSize" type="int" default="1"/> | |
12444 | </paramlist> | |
12445 | </method> | |
12446 | <method name="TileBitmap" type="bool" overloaded="no"> | |
781d2982 | 12447 | <autodoc>TileBitmap(self, Rect rect, DC dc, Bitmap bitmap) -> bool</autodoc> |
f32fc4bc RD |
12448 | <paramlist> |
12449 | <param name="rect" type="Rect" default=""/> | |
12450 | <param name="dc" type="DC" default=""/> | |
12451 | <param name="bitmap" type="Bitmap" default=""/> | |
12452 | </paramlist> | |
12453 | </method> | |
12454 | </class> | |
12455 | </module> | |
781d2982 RD |
12456 | <module name="_windows"> |
12457 | <import name="_core"/> | |
12458 | <pythoncode> wx = _core </pythoncode> | |
f32fc4bc | 12459 | <pythoncode> |
856bf319 RD |
12460 | #--------------------------------------------------------------------------- |
12461 | </pythoncode> | |
781d2982 | 12462 | <class name="Panel" oldname="wxPanel" module="_windows"> |
f32fc4bc RD |
12463 | <baseclass name="Window"/> |
12464 | <constructor name="Panel" overloaded="no"> | |
781d2982 | 12465 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
856bf319 RD |
12466 | Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, |
12467 | String name=PanelNameStr) -> Panel</autodoc> | |
f32fc4bc RD |
12468 | <paramlist> |
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"/> | |
12475 | </paramlist> | |
12476 | </constructor> | |
12477 | <constructor name="PrePanel" overloaded="no"> | |
12478 | <autodoc>PrePanel() -> Panel</autodoc> | |
12479 | </constructor> | |
12480 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
12481 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
12482 | Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, | |
856bf319 | 12483 | String name=PanelNameStr) -> bool</autodoc> |
f32fc4bc RD |
12484 | <paramlist> |
12485 | <param name="parent" type="Window" default=""/> | |
781d2982 | 12486 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
12491 | </paramlist> | |
12492 | </method> | |
12493 | <method name="InitDialog" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc | 12497 | </method> |
781d2982 RD |
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. | |
12505 | ||
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 | |
12509 | this.</docstring> | |
12510 | <paramlist> | |
12511 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
12512 | </paramlist> | |
12513 | </staticmethod> | |
f32fc4bc RD |
12514 | </class> |
12515 | <pythoncode> | |
856bf319 RD |
12516 | #--------------------------------------------------------------------------- |
12517 | </pythoncode> | |
781d2982 | 12518 | <class name="ScrolledWindow" oldname="wxScrolledWindow" module="_windows"> |
f32fc4bc RD |
12519 | <baseclass name="Panel"/> |
12520 | <constructor name="ScrolledWindow" overloaded="no"> | |
781d2982 | 12521 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
856bf319 RD |
12522 | Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL, |
12523 | String name=PanelNameStr) -> ScrolledWindow</autodoc> | |
f32fc4bc RD |
12524 | <paramlist> |
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"/> | |
12531 | </paramlist> | |
12532 | </constructor> | |
12533 | <constructor name="PreScrolledWindow" overloaded="no"> | |
12534 | <autodoc>PreScrolledWindow() -> ScrolledWindow</autodoc> | |
12535 | </constructor> | |
12536 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 12537 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
856bf319 RD |
12538 | Size size=DefaultSize, long style=wxHSCROLL|wxVSCROLL, |
12539 | String name=PanelNameStr) -> bool</autodoc> | |
f32fc4bc RD |
12540 | <paramlist> |
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"/> | |
12547 | </paramlist> | |
12548 | </method> | |
12549 | <method name="SetScrollbars" type="" overloaded="no"> | |
781d2982 | 12550 | <autodoc>SetScrollbars(self, int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, |
856bf319 | 12551 | int noUnitsY, int xPos=0, int yPos=0, bool noRefresh=False)</autodoc> |
f32fc4bc RD |
12552 | <paramlist> |
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"/> | |
12560 | </paramlist> | |
12561 | </method> | |
12562 | <method name="Scroll" type="" overloaded="no"> | |
781d2982 | 12563 | <autodoc>Scroll(self, int x, int y)</autodoc> |
f32fc4bc RD |
12564 | <paramlist> |
12565 | <param name="x" type="int" default=""/> | |
12566 | <param name="y" type="int" default=""/> | |
12567 | </paramlist> | |
12568 | </method> | |
12569 | <method name="GetScrollPageSize" type="int" overloaded="no"> | |
781d2982 | 12570 | <autodoc>GetScrollPageSize(self, int orient) -> int</autodoc> |
f32fc4bc RD |
12571 | <paramlist> |
12572 | <param name="orient" type="int" default=""/> | |
12573 | </paramlist> | |
12574 | </method> | |
12575 | <method name="SetScrollPageSize" type="" overloaded="no"> | |
781d2982 | 12576 | <autodoc>SetScrollPageSize(self, int orient, int pageSize)</autodoc> |
f32fc4bc RD |
12577 | <paramlist> |
12578 | <param name="orient" type="int" default=""/> | |
12579 | <param name="pageSize" type="int" default=""/> | |
12580 | </paramlist> | |
12581 | </method> | |
12582 | <method name="SetScrollRate" type="" overloaded="no"> | |
781d2982 | 12583 | <autodoc>SetScrollRate(self, int xstep, int ystep)</autodoc> |
f32fc4bc RD |
12584 | <paramlist> |
12585 | <param name="xstep" type="int" default=""/> | |
12586 | <param name="ystep" type="int" default=""/> | |
12587 | </paramlist> | |
12588 | </method> | |
12589 | <method name="GetScrollPixelsPerUnit" type="" overloaded="no"> | |
12590 | <autodoc>GetScrollPixelsPerUnit() -> (xUnit, yUnit)</autodoc> | |
ce6878e6 | 12591 | <docstring>Get the size of one logical unit in physical units.</docstring> |
f32fc4bc RD |
12592 | <paramlist> |
12593 | <param name="OUTPUT" type="int" default=""/> | |
12594 | <param name="OUTPUT" type="int" default=""/> | |
12595 | </paramlist> | |
12596 | </method> | |
12597 | <method name="EnableScrolling" type="" overloaded="no"> | |
781d2982 | 12598 | <autodoc>EnableScrolling(self, bool x_scrolling, bool y_scrolling)</autodoc> |
f32fc4bc RD |
12599 | <paramlist> |
12600 | <param name="x_scrolling" type="bool" default=""/> | |
12601 | <param name="y_scrolling" type="bool" default=""/> | |
12602 | </paramlist> | |
12603 | </method> | |
12604 | <method name="GetViewStart" type="" overloaded="no"> | |
12605 | <autodoc>GetViewStart() -> (x,y)</autodoc> | |
ce6878e6 | 12606 | <docstring>Get the view start</docstring> |
f32fc4bc RD |
12607 | <paramlist> |
12608 | <param name="OUTPUT" type="int" default=""/> | |
12609 | <param name="OUTPUT" type="int" default=""/> | |
12610 | </paramlist> | |
12611 | </method> | |
12612 | <method name="SetScale" type="" overloaded="no"> | |
781d2982 | 12613 | <autodoc>SetScale(self, double xs, double ys)</autodoc> |
f32fc4bc RD |
12614 | <paramlist> |
12615 | <param name="xs" type="double" default=""/> | |
12616 | <param name="ys" type="double" default=""/> | |
12617 | </paramlist> | |
12618 | </method> | |
12619 | <method name="GetScaleX" type="double" overloaded="no"> | |
781d2982 | 12620 | <autodoc>GetScaleX(self) -> double</autodoc> |
f32fc4bc RD |
12621 | </method> |
12622 | <method name="GetScaleY" type="double" overloaded="no"> | |
781d2982 | 12623 | <autodoc>GetScaleY(self) -> double</autodoc> |
f32fc4bc RD |
12624 | </method> |
12625 | <method name="CalcScrolledPosition" type="Point" overloaded="yes"> | |
12626 | <docstring>Translate between scrolled and unscrolled coordinates.</docstring> | |
12627 | <paramlist> | |
12628 | <param name="pt" type="Point" default=""/> | |
12629 | </paramlist> | |
12630 | </method> | |
12631 | <method name="CalcScrolledPosition" type="" overloaded="yes"> | |
781d2982 | 12632 | <autodoc>CalcScrolledPosition(self, Point pt) -> Point |
856bf319 | 12633 | CalcScrolledPosition(int x, int y) -> (sx, sy)</autodoc> |
f32fc4bc RD |
12634 | <docstring>Translate between scrolled and unscrolled coordinates.</docstring> |
12635 | <paramlist> | |
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=""/> | |
12640 | </paramlist> | |
12641 | </method> | |
12642 | <method name="CalcUnscrolledPosition" type="Point" overloaded="yes"> | |
12643 | <docstring>Translate between scrolled and unscrolled coordinates.</docstring> | |
12644 | <paramlist> | |
12645 | <param name="pt" type="Point" default=""/> | |
12646 | </paramlist> | |
12647 | </method> | |
12648 | <method name="CalcUnscrolledPosition" type="" overloaded="yes"> | |
781d2982 | 12649 | <autodoc>CalcUnscrolledPosition(self, Point pt) -> Point |
856bf319 | 12650 | CalcUnscrolledPosition(int x, int y) -> (ux, uy)</autodoc> |
f32fc4bc RD |
12651 | <docstring>Translate between scrolled and unscrolled coordinates.</docstring> |
12652 | <paramlist> | |
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=""/> | |
12657 | </paramlist> | |
12658 | </method> | |
12659 | <method name="AdjustScrollbars" type="" overloaded="no"> | |
781d2982 | 12660 | <autodoc>AdjustScrollbars(self)</autodoc> |
f32fc4bc RD |
12661 | </method> |
12662 | <method name="CalcScrollInc" type="int" overloaded="no"> | |
781d2982 | 12663 | <autodoc>CalcScrollInc(self, ScrollWinEvent event) -> int</autodoc> |
f32fc4bc RD |
12664 | <paramlist> |
12665 | <param name="event" type="ScrollWinEvent" default=""/> | |
12666 | </paramlist> | |
12667 | </method> | |
12668 | <method name="SetTargetWindow" type="" overloaded="no"> | |
781d2982 | 12669 | <autodoc>SetTargetWindow(self, Window target)</autodoc> |
f32fc4bc RD |
12670 | <paramlist> |
12671 | <param name="target" type="Window" default=""/> | |
12672 | </paramlist> | |
12673 | </method> | |
12674 | <method name="GetTargetWindow" type="Window" overloaded="no"> | |
781d2982 | 12675 | <autodoc>GetTargetWindow(self) -> Window</autodoc> |
f32fc4bc | 12676 | </method> |
ce6878e6 RD |
12677 | <method name="DoPrepareDC" type="" overloaded="no"> |
12678 | <autodoc>DoPrepareDC(self, DC dc)</autodoc> | |
12679 | <docstring>Normally what is called by `PrepareDC`.</docstring> | |
12680 | <paramlist> | |
12681 | <param name="dc" type="DC" default=""/> | |
12682 | </paramlist> | |
12683 | </method> | |
781d2982 RD |
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. | |
12691 | ||
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 | |
12695 | this.</docstring> | |
12696 | <paramlist> | |
12697 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
12698 | </paramlist> | |
12699 | </staticmethod> | |
f32fc4bc RD |
12700 | </class> |
12701 | <pythoncode> | |
856bf319 RD |
12702 | #--------------------------------------------------------------------------- |
12703 | </pythoncode> | |
781d2982 | 12704 | <class name="TopLevelWindow" oldname="wxTopLevelWindow" module="_windows"> |
f32fc4bc RD |
12705 | <baseclass name="Window"/> |
12706 | <method name="Maximize" type="" overloaded="no"> | |
781d2982 | 12707 | <autodoc>Maximize(self, bool maximize=True)</autodoc> |
f32fc4bc RD |
12708 | <paramlist> |
12709 | <param name="maximize" type="bool" default="True"/> | |
12710 | </paramlist> | |
12711 | </method> | |
12712 | <method name="Restore" type="" overloaded="no"> | |
781d2982 | 12713 | <autodoc>Restore(self)</autodoc> |
f32fc4bc RD |
12714 | </method> |
12715 | <method name="Iconize" type="" overloaded="no"> | |
781d2982 | 12716 | <autodoc>Iconize(self, bool iconize=True)</autodoc> |
f32fc4bc RD |
12717 | <paramlist> |
12718 | <param name="iconize" type="bool" default="True"/> | |
12719 | </paramlist> | |
12720 | </method> | |
12721 | <method name="IsMaximized" type="bool" overloaded="no"> | |
781d2982 | 12722 | <autodoc>IsMaximized(self) -> bool</autodoc> |
f32fc4bc RD |
12723 | </method> |
12724 | <method name="IsIconized" type="bool" overloaded="no"> | |
781d2982 | 12725 | <autodoc>IsIconized(self) -> bool</autodoc> |
f32fc4bc RD |
12726 | </method> |
12727 | <method name="GetIcon" type="Icon" overloaded="no"> | |
781d2982 | 12728 | <autodoc>GetIcon(self) -> Icon</autodoc> |
f32fc4bc RD |
12729 | </method> |
12730 | <method name="SetIcon" type="" overloaded="no"> | |
781d2982 | 12731 | <autodoc>SetIcon(self, Icon icon)</autodoc> |
f32fc4bc RD |
12732 | <paramlist> |
12733 | <param name="icon" type="Icon" default=""/> | |
12734 | </paramlist> | |
12735 | </method> | |
12736 | <method name="SetIcons" type="" overloaded="no"> | |
781d2982 | 12737 | <autodoc>SetIcons(self, wxIconBundle icons)</autodoc> |
f32fc4bc RD |
12738 | <paramlist> |
12739 | <param name="icons" type="IconBundle" default=""/> | |
12740 | </paramlist> | |
12741 | </method> | |
12742 | <method name="ShowFullScreen" type="bool" overloaded="no"> | |
781d2982 | 12743 | <autodoc>ShowFullScreen(self, bool show, long style=FULLSCREEN_ALL) -> bool</autodoc> |
f32fc4bc RD |
12744 | <paramlist> |
12745 | <param name="show" type="bool" default=""/> | |
12746 | <param name="style" type="long" default="wxFULLSCREEN_ALL"/> | |
12747 | </paramlist> | |
12748 | </method> | |
12749 | <method name="IsFullScreen" type="bool" overloaded="no"> | |
781d2982 | 12750 | <autodoc>IsFullScreen(self) -> bool</autodoc> |
f32fc4bc RD |
12751 | </method> |
12752 | <method name="SetTitle" type="" overloaded="no"> | |
781d2982 | 12753 | <autodoc>SetTitle(self, String title)</autodoc> |
c2dda882 | 12754 | <docstring>Sets the window's title. Applicable only to frames and dialogs.</docstring> |
f32fc4bc RD |
12755 | <paramlist> |
12756 | <param name="title" type="String" default=""/> | |
12757 | </paramlist> | |
12758 | </method> | |
12759 | <method name="GetTitle" type="String" overloaded="no"> | |
781d2982 | 12760 | <autodoc>GetTitle(self) -> String</autodoc> |
c2dda882 | 12761 | <docstring>Gets the window's title. Applicable only to frames and dialogs.</docstring> |
f32fc4bc RD |
12762 | </method> |
12763 | <method name="SetShape" type="bool" overloaded="no"> | |
781d2982 | 12764 | <autodoc>SetShape(self, Region region) -> bool</autodoc> |
f32fc4bc RD |
12765 | <paramlist> |
12766 | <param name="region" type="Region" default=""/> | |
12767 | </paramlist> | |
12768 | </method> | |
12769 | </class> | |
12770 | <pythoncode> | |
856bf319 RD |
12771 | #--------------------------------------------------------------------------- |
12772 | </pythoncode> | |
781d2982 | 12773 | <class name="Frame" oldname="wxFrame" module="_windows"> |
f32fc4bc RD |
12774 | <baseclass name="TopLevelWindow"/> |
12775 | <constructor name="Frame" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
12779 | <paramlist> |
12780 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
12781 | <param name="id" type="int" default="-1"/> |
12782 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
12787 | </paramlist> | |
12788 | </constructor> | |
12789 | <constructor name="PreFrame" overloaded="no"> | |
12790 | <autodoc>PreFrame() -> Frame</autodoc> | |
12791 | </constructor> | |
12792 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
12796 | <paramlist> |
12797 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
12798 | <param name="id" type="int" default="-1"/> |
12799 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
12804 | </paramlist> | |
12805 | </method> | |
12806 | <method name="GetClientAreaOrigin" type="Point" overloaded="no"> | |
781d2982 | 12807 | <autodoc>GetClientAreaOrigin(self) -> Point</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
12811 | </method> |
12812 | <method name="SendSizeEvent" type="" overloaded="no"> | |
781d2982 | 12813 | <autodoc>SendSizeEvent(self)</autodoc> |
f32fc4bc RD |
12814 | </method> |
12815 | <method name="SetMenuBar" type="" overloaded="no"> | |
781d2982 | 12816 | <autodoc>SetMenuBar(self, MenuBar menubar)</autodoc> |
f32fc4bc RD |
12817 | <paramlist> |
12818 | <param name="menubar" type="MenuBar" default=""/> | |
12819 | </paramlist> | |
12820 | </method> | |
12821 | <method name="GetMenuBar" type="MenuBar" overloaded="no"> | |
781d2982 | 12822 | <autodoc>GetMenuBar(self) -> MenuBar</autodoc> |
f32fc4bc RD |
12823 | </method> |
12824 | <method name="ProcessCommand" type="bool" overloaded="no"> | |
781d2982 | 12825 | <autodoc>ProcessCommand(self, int winid) -> bool</autodoc> |
f32fc4bc RD |
12826 | <paramlist> |
12827 | <param name="winid" type="int" default=""/> | |
12828 | </paramlist> | |
12829 | </method> | |
12830 | <method name="CreateStatusBar" type="wxStatusBar" overloaded="no"> | |
781d2982 | 12831 | <autodoc>CreateStatusBar(self, int number=1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, |
b39e211b | 12832 | int winid=0, String name=StatusLineNameStr) -> StatusBar</autodoc> |
f32fc4bc RD |
12833 | <paramlist> |
12834 | <param name="number" type="int" default="1"/> | |
b39e211b | 12835 | <param name="style" type="long" default="wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE"/> |
f32fc4bc RD |
12836 | <param name="winid" type="int" default="0"/> |
12837 | <param name="name" type="String" default="wxPyStatusLineNameStr"/> | |
12838 | </paramlist> | |
12839 | </method> | |
12840 | <method name="GetStatusBar" type="wxStatusBar" overloaded="no"> | |
781d2982 | 12841 | <autodoc>GetStatusBar(self) -> StatusBar</autodoc> |
f32fc4bc RD |
12842 | </method> |
12843 | <method name="SetStatusBar" type="" overloaded="no"> | |
781d2982 | 12844 | <autodoc>SetStatusBar(self, StatusBar statBar)</autodoc> |
f32fc4bc RD |
12845 | <paramlist> |
12846 | <param name="statBar" type="wxStatusBar" default=""/> | |
12847 | </paramlist> | |
12848 | </method> | |
12849 | <method name="SetStatusText" type="" overloaded="no"> | |
781d2982 | 12850 | <autodoc>SetStatusText(self, String text, int number=0)</autodoc> |
f32fc4bc RD |
12851 | <paramlist> |
12852 | <param name="text" type="String" default=""/> | |
12853 | <param name="number" type="int" default="0"/> | |
12854 | </paramlist> | |
12855 | </method> | |
12856 | <method name="SetStatusWidths" type="" overloaded="no"> | |
781d2982 | 12857 | <autodoc>SetStatusWidths(self, int widths, int widths_field)</autodoc> |
f32fc4bc RD |
12858 | <paramlist> |
12859 | <param name="widths" type="int" default=""/> | |
12860 | <param name="widths_field" type="int" default=""/> | |
12861 | </paramlist> | |
12862 | </method> | |
12863 | <method name="PushStatusText" type="" overloaded="no"> | |
781d2982 | 12864 | <autodoc>PushStatusText(self, String text, int number=0)</autodoc> |
f32fc4bc RD |
12865 | <paramlist> |
12866 | <param name="text" type="String" default=""/> | |
12867 | <param name="number" type="int" default="0"/> | |
12868 | </paramlist> | |
12869 | </method> | |
12870 | <method name="PopStatusText" type="" overloaded="no"> | |
781d2982 | 12871 | <autodoc>PopStatusText(self, int number=0)</autodoc> |
f32fc4bc RD |
12872 | <paramlist> |
12873 | <param name="number" type="int" default="0"/> | |
12874 | </paramlist> | |
12875 | </method> | |
12876 | <method name="SetStatusBarPane" type="" overloaded="no"> | |
781d2982 | 12877 | <autodoc>SetStatusBarPane(self, int n)</autodoc> |
f32fc4bc RD |
12878 | <paramlist> |
12879 | <param name="n" type="int" default=""/> | |
12880 | </paramlist> | |
12881 | </method> | |
12882 | <method name="GetStatusBarPane" type="int" overloaded="no"> | |
781d2982 | 12883 | <autodoc>GetStatusBarPane(self) -> int</autodoc> |
f32fc4bc RD |
12884 | </method> |
12885 | <method name="CreateToolBar" type="wxToolBar" overloaded="no"> | |
781d2982 | 12886 | <autodoc>CreateToolBar(self, long style=-1, int winid=-1, String name=ToolBarNameStr) -> wxToolBar</autodoc> |
f32fc4bc RD |
12887 | <paramlist> |
12888 | <param name="style" type="long" default="-1"/> | |
12889 | <param name="winid" type="int" default="-1"/> | |
12890 | <param name="name" type="String" default="wxPyToolBarNameStr"/> | |
12891 | </paramlist> | |
12892 | </method> | |
12893 | <method name="GetToolBar" type="wxToolBar" overloaded="no"> | |
781d2982 | 12894 | <autodoc>GetToolBar(self) -> wxToolBar</autodoc> |
f32fc4bc RD |
12895 | </method> |
12896 | <method name="SetToolBar" type="" overloaded="no"> | |
781d2982 | 12897 | <autodoc>SetToolBar(self, wxToolBar toolbar)</autodoc> |
f32fc4bc RD |
12898 | <paramlist> |
12899 | <param name="toolbar" type="wxToolBar" default=""/> | |
12900 | </paramlist> | |
12901 | </method> | |
12902 | <method name="DoGiveHelp" type="" overloaded="no"> | |
781d2982 | 12903 | <autodoc>DoGiveHelp(self, String text, bool show)</autodoc> |
f32fc4bc RD |
12904 | <paramlist> |
12905 | <param name="text" type="String" default=""/> | |
12906 | <param name="show" type="bool" default=""/> | |
12907 | </paramlist> | |
12908 | </method> | |
12909 | <method name="DoMenuUpdates" type="" overloaded="no"> | |
781d2982 | 12910 | <autodoc>DoMenuUpdates(self, Menu menu=None)</autodoc> |
f32fc4bc RD |
12911 | <paramlist> |
12912 | <param name="menu" type="Menu" default="NULL"/> | |
12913 | </paramlist> | |
12914 | </method> | |
781d2982 RD |
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. | |
12922 | ||
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 | |
12926 | this.</docstring> | |
12927 | <paramlist> | |
12928 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
12929 | </paramlist> | |
12930 | </staticmethod> | |
f32fc4bc RD |
12931 | </class> |
12932 | <pythoncode> | |
856bf319 RD |
12933 | #--------------------------------------------------------------------------- |
12934 | </pythoncode> | |
781d2982 | 12935 | <class name="Dialog" oldname="wxDialog" module="_windows"> |
f32fc4bc RD |
12936 | <baseclass name="TopLevelWindow"/> |
12937 | <constructor name="Dialog" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
12941 | <paramlist> |
12942 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
12943 | <param name="id" type="int" default="-1"/> |
12944 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
12949 | </paramlist> | |
12950 | </constructor> | |
12951 | <constructor name="PreDialog" overloaded="no"> | |
12952 | <autodoc>PreDialog() -> Dialog</autodoc> | |
12953 | </constructor> | |
12954 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
12958 | <paramlist> |
12959 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
12960 | <param name="id" type="int" default="-1"/> |
12961 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
12966 | </paramlist> | |
12967 | </method> | |
12968 | <method name="SetReturnCode" type="" overloaded="no"> | |
781d2982 | 12969 | <autodoc>SetReturnCode(self, int returnCode)</autodoc> |
f32fc4bc RD |
12970 | <paramlist> |
12971 | <param name="returnCode" type="int" default=""/> | |
12972 | </paramlist> | |
12973 | </method> | |
12974 | <method name="GetReturnCode" type="int" overloaded="no"> | |
781d2982 | 12975 | <autodoc>GetReturnCode(self) -> int</autodoc> |
f32fc4bc RD |
12976 | </method> |
12977 | <method name="CreateTextSizer" type="Sizer" overloaded="no"> | |
781d2982 | 12978 | <autodoc>CreateTextSizer(self, String message) -> Sizer</autodoc> |
f32fc4bc RD |
12979 | <paramlist> |
12980 | <param name="message" type="String" default=""/> | |
12981 | </paramlist> | |
12982 | </method> | |
12983 | <method name="CreateButtonSizer" type="Sizer" overloaded="no"> | |
781d2982 | 12984 | <autodoc>CreateButtonSizer(self, long flags) -> Sizer</autodoc> |
f32fc4bc RD |
12985 | <paramlist> |
12986 | <param name="flags" type="long" default=""/> | |
12987 | </paramlist> | |
12988 | </method> | |
12989 | <method name="IsModal" type="bool" overloaded="no"> | |
781d2982 | 12990 | <autodoc>IsModal(self) -> bool</autodoc> |
f32fc4bc RD |
12991 | </method> |
12992 | <method name="ShowModal" type="int" overloaded="no"> | |
781d2982 | 12993 | <autodoc>ShowModal(self) -> int</autodoc> |
f32fc4bc RD |
12994 | </method> |
12995 | <method name="EndModal" type="" overloaded="no"> | |
781d2982 | 12996 | <autodoc>EndModal(self, int retCode)</autodoc> |
f32fc4bc RD |
12997 | <paramlist> |
12998 | <param name="retCode" type="int" default=""/> | |
12999 | </paramlist> | |
13000 | </method> | |
781d2982 RD |
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. | |
13008 | ||
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 | |
13012 | this.</docstring> | |
13013 | <paramlist> | |
13014 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
13015 | </paramlist> | |
13016 | </staticmethod> | |
f32fc4bc RD |
13017 | </class> |
13018 | <pythoncode> | |
856bf319 RD |
13019 | #--------------------------------------------------------------------------- |
13020 | </pythoncode> | |
781d2982 | 13021 | <class name="MiniFrame" oldname="wxMiniFrame" module="_windows"> |
f32fc4bc RD |
13022 | <baseclass name="Frame"/> |
13023 | <constructor name="MiniFrame" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
13027 | <paramlist> |
13028 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
13029 | <param name="id" type="int" default="-1"/> |
13030 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
13035 | </paramlist> | |
13036 | </constructor> | |
13037 | <constructor name="PreMiniFrame" overloaded="no"> | |
13038 | <autodoc>PreMiniFrame() -> MiniFrame</autodoc> | |
13039 | </constructor> | |
13040 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
13044 | <paramlist> |
13045 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
13046 | <param name="id" type="int" default="-1"/> |
13047 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
13052 | </paramlist> | |
13053 | </method> | |
13054 | </class> | |
13055 | <pythoncode> | |
856bf319 RD |
13056 | #--------------------------------------------------------------------------- |
13057 | </pythoncode> | |
781d2982 | 13058 | <class name="SplashScreenWindow" oldname="wxSplashScreenWindow" module="_windows"> |
f32fc4bc RD |
13059 | <baseclass name="Window"/> |
13060 | <constructor name="SplashScreenWindow" overloaded="no"> | |
781d2982 | 13061 | <autodoc>__init__(self, Bitmap bitmap, Window parent, int id, Point pos=DefaultPosition, |
856bf319 | 13062 | Size size=DefaultSize, long style=NO_BORDER) -> SplashScreenWindow</autodoc> |
f32fc4bc RD |
13063 | <paramlist> |
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"/> | |
13070 | </paramlist> | |
13071 | </constructor> | |
13072 | <method name="SetBitmap" type="" overloaded="no"> | |
781d2982 | 13073 | <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc> |
f32fc4bc RD |
13074 | <paramlist> |
13075 | <param name="bitmap" type="Bitmap" default=""/> | |
13076 | </paramlist> | |
13077 | </method> | |
13078 | <method name="GetBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 13079 | <autodoc>GetBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
13080 | </method> |
13081 | </class> | |
781d2982 | 13082 | <class name="SplashScreen" oldname="wxSplashScreen" module="_windows"> |
f32fc4bc RD |
13083 | <baseclass name="Frame"/> |
13084 | <constructor name="SplashScreen" overloaded="no"> | |
781d2982 RD |
13085 | <autodoc>__init__(self, Bitmap bitmap, long splashStyle, int milliseconds, |
13086 | Window parent, int id=-1, Point pos=DefaultPosition, | |
856bf319 | 13087 | Size size=DefaultSize, long style=wxSIMPLE_BORDER|wxFRAME_NO_TASKBAR|wxSTAY_ON_TOP) -> SplashScreen</autodoc> |
f32fc4bc RD |
13088 | <paramlist> |
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=""/> | |
781d2982 | 13093 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
13097 | </paramlist> | |
13098 | </constructor> | |
13099 | <method name="GetSplashStyle" type="long" overloaded="no"> | |
781d2982 | 13100 | <autodoc>GetSplashStyle(self) -> long</autodoc> |
f32fc4bc RD |
13101 | </method> |
13102 | <method name="GetSplashWindow" type="SplashScreenWindow" overloaded="no"> | |
781d2982 | 13103 | <autodoc>GetSplashWindow(self) -> SplashScreenWindow</autodoc> |
f32fc4bc RD |
13104 | </method> |
13105 | <method name="GetTimeout" type="int" overloaded="no"> | |
781d2982 | 13106 | <autodoc>GetTimeout(self) -> int</autodoc> |
f32fc4bc RD |
13107 | </method> |
13108 | </class> | |
13109 | <pythoncode> | |
856bf319 RD |
13110 | #--------------------------------------------------------------------------- |
13111 | </pythoncode> | |
781d2982 | 13112 | <class name="StatusBar" oldname="wxStatusBar" module="_windows"> |
f32fc4bc RD |
13113 | <baseclass name="Window"/> |
13114 | <constructor name="StatusBar" overloaded="no"> | |
781d2982 | 13115 | <autodoc>__init__(self, Window parent, int id=-1, long style=wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE, |
b39e211b | 13116 | String name=StatusLineNameStr) -> StatusBar</autodoc> |
f32fc4bc RD |
13117 | <paramlist> |
13118 | <param name="parent" type="Window" default=""/> | |
13119 | <param name="id" type="int" default="-1"/> | |
b39e211b | 13120 | <param name="style" type="long" default="wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE"/> |
f32fc4bc RD |
13121 | <param name="name" type="String" default="wxPyStatusLineNameStr"/> |
13122 | </paramlist> | |
13123 | </constructor> | |
13124 | <constructor name="PreStatusBar" overloaded="no"> | |
13125 | <autodoc>PreStatusBar() -> StatusBar</autodoc> | |
13126 | </constructor> | |
13127 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 13128 | <autodoc>Create(self, Window parent, int id=-1, long style=ST_SIZEGRIP, String name=StatusLineNameStr) -> bool</autodoc> |
f32fc4bc RD |
13129 | <paramlist> |
13130 | <param name="parent" type="Window" default=""/> | |
781d2982 | 13131 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
13132 | <param name="style" type="long" default="wxST_SIZEGRIP"/> |
13133 | <param name="name" type="String" default="wxPyStatusLineNameStr"/> | |
13134 | </paramlist> | |
13135 | </method> | |
13136 | <method name="SetFieldsCount" type="" overloaded="no"> | |
781d2982 | 13137 | <autodoc>SetFieldsCount(self, int number=1)</autodoc> |
f32fc4bc RD |
13138 | <paramlist> |
13139 | <param name="number" type="int" default="1"/> | |
13140 | </paramlist> | |
13141 | </method> | |
13142 | <method name="GetFieldsCount" type="int" overloaded="no"> | |
781d2982 | 13143 | <autodoc>GetFieldsCount(self) -> int</autodoc> |
f32fc4bc RD |
13144 | </method> |
13145 | <method name="SetStatusText" type="" overloaded="no"> | |
781d2982 | 13146 | <autodoc>SetStatusText(self, String text, int number=0)</autodoc> |
f32fc4bc RD |
13147 | <paramlist> |
13148 | <param name="text" type="String" default=""/> | |
13149 | <param name="number" type="int" default="0"/> | |
13150 | </paramlist> | |
13151 | </method> | |
13152 | <method name="GetStatusText" type="String" overloaded="no"> | |
781d2982 | 13153 | <autodoc>GetStatusText(self, int number=0) -> String</autodoc> |
f32fc4bc RD |
13154 | <paramlist> |
13155 | <param name="number" type="int" default="0"/> | |
13156 | </paramlist> | |
13157 | </method> | |
13158 | <method name="PushStatusText" type="" overloaded="no"> | |
781d2982 | 13159 | <autodoc>PushStatusText(self, String text, int number=0)</autodoc> |
f32fc4bc RD |
13160 | <paramlist> |
13161 | <param name="text" type="String" default=""/> | |
13162 | <param name="number" type="int" default="0"/> | |
13163 | </paramlist> | |
13164 | </method> | |
13165 | <method name="PopStatusText" type="" overloaded="no"> | |
781d2982 | 13166 | <autodoc>PopStatusText(self, int number=0)</autodoc> |
f32fc4bc RD |
13167 | <paramlist> |
13168 | <param name="number" type="int" default="0"/> | |
13169 | </paramlist> | |
13170 | </method> | |
13171 | <method name="SetStatusWidths" type="" overloaded="no"> | |
781d2982 | 13172 | <autodoc>SetStatusWidths(self, int widths, int widths_field)</autodoc> |
f32fc4bc RD |
13173 | <paramlist> |
13174 | <param name="widths" type="int" default=""/> | |
13175 | <param name="widths_field" type="int" default=""/> | |
13176 | </paramlist> | |
13177 | </method> | |
ce6878e6 RD |
13178 | <method name="SetStatusStyles" type="" overloaded="no"> |
13179 | <autodoc>SetStatusStyles(self, int styles, int styles_field)</autodoc> | |
13180 | <paramlist> | |
13181 | <param name="styles" type="int" default=""/> | |
13182 | <param name="styles_field" type="int" default=""/> | |
13183 | </paramlist> | |
13184 | </method> | |
f32fc4bc | 13185 | <method name="GetFieldRect" type="Rect" overloaded="no"> |
781d2982 | 13186 | <autodoc>GetFieldRect(self, int i) -> Rect</autodoc> |
f32fc4bc RD |
13187 | <paramlist> |
13188 | <param name="i" type="int" default=""/> | |
13189 | </paramlist> | |
13190 | </method> | |
13191 | <method name="SetMinHeight" type="" overloaded="no"> | |
781d2982 | 13192 | <autodoc>SetMinHeight(self, int height)</autodoc> |
f32fc4bc RD |
13193 | <paramlist> |
13194 | <param name="height" type="int" default=""/> | |
13195 | </paramlist> | |
13196 | </method> | |
13197 | <method name="GetBorderX" type="int" overloaded="no"> | |
781d2982 | 13198 | <autodoc>GetBorderX(self) -> int</autodoc> |
f32fc4bc RD |
13199 | </method> |
13200 | <method name="GetBorderY" type="int" overloaded="no"> | |
781d2982 | 13201 | <autodoc>GetBorderY(self) -> int</autodoc> |
f32fc4bc | 13202 | </method> |
781d2982 RD |
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. | |
13210 | ||
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 | |
13214 | this.</docstring> | |
13215 | <paramlist> | |
13216 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
13217 | </paramlist> | |
13218 | </staticmethod> | |
f32fc4bc RD |
13219 | </class> |
13220 | <pythoncode> | |
856bf319 RD |
13221 | #--------------------------------------------------------------------------- |
13222 | </pythoncode> | |
781d2982 RD |
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 | |
ce6878e6 RD |
13226 | or programmatically. |
13227 | ||
13228 | Styles | |
13229 | ------- | |
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 | |
13240 | pre-XP look. | |
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 | ==================== ====================================== | |
13246 | ||
13247 | Events | |
13248 | ------ | |
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. | |
13257 | ||
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 | |
13263 | from taking place. | |
13264 | ||
13265 | EVT_SPLITTER_UNSPLIT The splitter has been just unsplit. | |
13266 | ||
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 | |
13272 | zero.) | |
13273 | ============================== ======================================= | |
13274 | ||
13275 | </docstring> | |
f32fc4bc RD |
13276 | <baseclass name="Window"/> |
13277 | <constructor name="SplitterWindow" overloaded="no"> | |
781d2982 RD |
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> | |
368d20e8 | 13280 | <docstring>Constructor. Creates and shows a SplitterWindow.</docstring> |
f32fc4bc RD |
13281 | <paramlist> |
13282 | <param name="parent" type="Window" default=""/> | |
781d2982 | 13283 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
13288 | </paramlist> | |
13289 | </constructor> | |
13290 | <constructor name="PreSplitterWindow" overloaded="no"> | |
13291 | <autodoc>PreSplitterWindow() -> SplitterWindow</autodoc> | |
368d20e8 | 13292 | <docstring>Precreate a SplitterWindow for 2-phase creation.</docstring> |
f32fc4bc RD |
13293 | </constructor> |
13294 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
368d20e8 | 13297 | <docstring>Create the GUI part of the SplitterWindow for the 2-phase create.</docstring> |
f32fc4bc RD |
13298 | <paramlist> |
13299 | <param name="parent" type="Window" default=""/> | |
781d2982 | 13300 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
13305 | </paramlist> | |
13306 | </method> | |
13307 | <method name="GetWindow1" type="Window" overloaded="no"> | |
781d2982 | 13308 | <autodoc>GetWindow1(self) -> Window</autodoc> |
368d20e8 | 13309 | <docstring>Gets the only or left/top pane.</docstring> |
f32fc4bc RD |
13310 | </method> |
13311 | <method name="GetWindow2" type="Window" overloaded="no"> | |
781d2982 | 13312 | <autodoc>GetWindow2(self) -> Window</autodoc> |
368d20e8 | 13313 | <docstring>Gets the right/bottom pane.</docstring> |
f32fc4bc RD |
13314 | </method> |
13315 | <method name="SetSplitMode" type="" overloaded="no"> | |
781d2982 | 13316 | <autodoc>SetSplitMode(self, int mode)</autodoc> |
368d20e8 | 13317 | <docstring>Sets the split mode. The mode can be wx.SPLIT_VERTICAL or |
781d2982 RD |
13318 | wx.SPLIT_HORIZONTAL. This only sets the internal variable; does not |
13319 | update the display.</docstring> | |
f32fc4bc RD |
13320 | <paramlist> |
13321 | <param name="mode" type="int" default=""/> | |
13322 | </paramlist> | |
13323 | </method> | |
13324 | <method name="GetSplitMode" type="wxSplitMode" overloaded="no"> | |
781d2982 | 13325 | <autodoc>GetSplitMode(self) -> int</autodoc> |
368d20e8 | 13326 | <docstring>Gets the split mode</docstring> |
f32fc4bc RD |
13327 | </method> |
13328 | <method name="Initialize" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
13333 | <paramlist> |
13334 | <param name="window" type="Window" default=""/> | |
13335 | </paramlist> | |
13336 | </method> | |
13337 | <method name="SplitVertically" type="bool" overloaded="no"> | |
781d2982 | 13338 | <autodoc>SplitVertically(self, Window window1, Window window2, int sashPosition=0) -> bool</autodoc> |
ce6878e6 RD |
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). | |
13348 | ||
13349 | Returns True if successful, False otherwise (the window was already | |
13350 | split). | |
13351 | ||
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 | |
13355 | IsSplit. | |
13356 | </docstring> | |
f32fc4bc RD |
13357 | <paramlist> |
13358 | <param name="window1" type="Window" default=""/> | |
13359 | <param name="window2" type="Window" default=""/> | |
13360 | <param name="sashPosition" type="int" default="0"/> | |
13361 | </paramlist> | |
13362 | </method> | |
13363 | <method name="SplitHorizontally" type="bool" overloaded="no"> | |
781d2982 | 13364 | <autodoc>SplitHorizontally(self, Window window1, Window window2, int sashPosition=0) -> bool</autodoc> |
ce6878e6 RD |
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). | |
13374 | ||
13375 | Returns True if successful, False otherwise (the window was already | |
13376 | split). | |
13377 | ||
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 | |
13381 | IsSplit. | |
13382 | </docstring> | |
f32fc4bc RD |
13383 | <paramlist> |
13384 | <param name="window1" type="Window" default=""/> | |
13385 | <param name="window2" type="Window" default=""/> | |
13386 | <param name="sashPosition" type="int" default="0"/> | |
13387 | </paramlist> | |
13388 | </method> | |
13389 | <method name="Unsplit" type="bool" overloaded="no"> | |
781d2982 RD |
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). | |
368d20e8 RD |
13394 | |
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> | |
f32fc4bc RD |
13399 | <paramlist> |
13400 | <param name="toRemove" type="Window" default="NULL"/> | |
13401 | </paramlist> | |
13402 | </method> | |
13403 | <method name="ReplaceWindow" type="bool" overloaded="no"> | |
781d2982 | 13404 | <autodoc>ReplaceWindow(self, Window winOld, Window winNew) -> bool</autodoc> |
368d20e8 | 13405 | <docstring>This function replaces one of the windows managed by the |
781d2982 RD |
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. | |
13410 | ||
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> | |
f32fc4bc RD |
13416 | <paramlist> |
13417 | <param name="winOld" type="Window" default=""/> | |
13418 | <param name="winNew" type="Window" default=""/> | |
13419 | </paramlist> | |
13420 | </method> | |
368d20e8 | 13421 | <method name="UpdateSize" type="" overloaded="no"> |
781d2982 RD |
13422 | <autodoc>UpdateSize(self)</autodoc> |
13423 | <docstring>Causes any pending sizing of the sash and child panes to take place | |
13424 | immediately. | |
13425 | ||
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> | |
368d20e8 | 13432 | </method> |
f32fc4bc | 13433 | <method name="IsSplit" type="bool" overloaded="no"> |
781d2982 | 13434 | <autodoc>IsSplit(self) -> bool</autodoc> |
368d20e8 | 13435 | <docstring>Is the window split?</docstring> |
f32fc4bc RD |
13436 | </method> |
13437 | <method name="SetSashSize" type="" overloaded="no"> | |
781d2982 | 13438 | <autodoc>SetSashSize(self, int width)</autodoc> |
368d20e8 | 13439 | <docstring>Sets the sash size</docstring> |
f32fc4bc RD |
13440 | <paramlist> |
13441 | <param name="width" type="int" default=""/> | |
13442 | </paramlist> | |
13443 | </method> | |
13444 | <method name="SetBorderSize" type="" overloaded="no"> | |
781d2982 | 13445 | <autodoc>SetBorderSize(self, int width)</autodoc> |
368d20e8 | 13446 | <docstring>Sets the border size</docstring> |
f32fc4bc RD |
13447 | <paramlist> |
13448 | <param name="width" type="int" default=""/> | |
13449 | </paramlist> | |
13450 | </method> | |
13451 | <method name="GetSashSize" type="int" overloaded="no"> | |
781d2982 | 13452 | <autodoc>GetSashSize(self) -> int</autodoc> |
368d20e8 | 13453 | <docstring>Gets the sash size</docstring> |
f32fc4bc RD |
13454 | </method> |
13455 | <method name="GetBorderSize" type="int" overloaded="no"> | |
781d2982 | 13456 | <autodoc>GetBorderSize(self) -> int</autodoc> |
368d20e8 | 13457 | <docstring>Gets the border size</docstring> |
f32fc4bc RD |
13458 | </method> |
13459 | <method name="SetSashPosition" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
13463 | <paramlist> |
13464 | <param name="position" type="int" default=""/> | |
13465 | <param name="redraw" type="bool" default="True"/> | |
13466 | </paramlist> | |
13467 | </method> | |
13468 | <method name="GetSashPosition" type="int" overloaded="no"> | |
781d2982 | 13469 | <autodoc>GetSashPosition(self) -> int</autodoc> |
368d20e8 | 13470 | <docstring>Returns the surrent sash position.</docstring> |
f32fc4bc RD |
13471 | </method> |
13472 | <method name="SetMinimumPaneSize" type="" overloaded="no"> | |
781d2982 | 13473 | <autodoc>SetMinimumPaneSize(self, int min)</autodoc> |
368d20e8 RD |
13474 | <docstring>Sets the minimum pane size in pixels. |
13475 | ||
781d2982 RD |
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> | |
f32fc4bc RD |
13482 | <paramlist> |
13483 | <param name="min" type="int" default=""/> | |
13484 | </paramlist> | |
13485 | </method> | |
13486 | <method name="GetMinimumPaneSize" type="int" overloaded="no"> | |
781d2982 | 13487 | <autodoc>GetMinimumPaneSize(self) -> int</autodoc> |
368d20e8 | 13488 | <docstring>Gets the minimum pane size in pixels.</docstring> |
f32fc4bc RD |
13489 | </method> |
13490 | <method name="SashHitTest" type="bool" overloaded="no"> | |
781d2982 | 13491 | <autodoc>SashHitTest(self, int x, int y, int tolerance=5) -> bool</autodoc> |
368d20e8 | 13492 | <docstring>Tests for x, y over the sash</docstring> |
f32fc4bc RD |
13493 | <paramlist> |
13494 | <param name="x" type="int" default=""/> | |
13495 | <param name="y" type="int" default=""/> | |
13496 | <param name="tolerance" type="int" default="5"/> | |
13497 | </paramlist> | |
13498 | </method> | |
13499 | <method name="SizeWindows" type="" overloaded="no"> | |
781d2982 | 13500 | <autodoc>SizeWindows(self)</autodoc> |
368d20e8 | 13501 | <docstring>Resizes subwindows</docstring> |
f32fc4bc RD |
13502 | </method> |
13503 | <method name="SetNeedUpdating" type="" overloaded="no"> | |
781d2982 | 13504 | <autodoc>SetNeedUpdating(self, bool needUpdating)</autodoc> |
f32fc4bc RD |
13505 | <paramlist> |
13506 | <param name="needUpdating" type="bool" default=""/> | |
13507 | </paramlist> | |
13508 | </method> | |
13509 | <method name="GetNeedUpdating" type="bool" overloaded="no"> | |
781d2982 | 13510 | <autodoc>GetNeedUpdating(self) -> bool</autodoc> |
f32fc4bc | 13511 | </method> |
781d2982 RD |
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. | |
13519 | ||
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 | |
13523 | this.</docstring> | |
13524 | <paramlist> | |
13525 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
13526 | </paramlist> | |
13527 | </staticmethod> | |
f32fc4bc | 13528 | </class> |
781d2982 | 13529 | <class name="SplitterEvent" oldname="wxSplitterEvent" module="_windows"> |
368d20e8 | 13530 | <docstring>This class represents the events generated by a splitter control.</docstring> |
f32fc4bc RD |
13531 | <baseclass name="NotifyEvent"/> |
13532 | <constructor name="SplitterEvent" overloaded="no"> | |
781d2982 | 13533 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, SplitterWindow splitter=(wxSplitterWindow *) NULL) -> SplitterEvent</autodoc> |
368d20e8 | 13534 | <docstring>This class represents the events generated by a splitter control.</docstring> |
f32fc4bc RD |
13535 | <paramlist> |
13536 | <param name="type" type="wxEventType" default="wxEVT_NULL"/> | |
13537 | <param name="splitter" type="SplitterWindow" default="(wxSplitterWindow *) NULL"/> | |
13538 | </paramlist> | |
13539 | </constructor> | |
13540 | <method name="SetSashPosition" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
13548 | <paramlist> |
13549 | <param name="pos" type="int" default=""/> | |
13550 | </paramlist> | |
13551 | </method> | |
13552 | <method name="GetSashPosition" type="int" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
13556 | </method> |
13557 | <method name="GetWindowBeingRemoved" type="Window" overloaded="no"> | |
781d2982 RD |
13558 | <autodoc>GetWindowBeingRemoved(self) -> Window</autodoc> |
13559 | <docstring>Returns a pointer to the window being removed when a splitter window | |
13560 | is unsplit.</docstring> | |
f32fc4bc RD |
13561 | </method> |
13562 | <method name="GetX" type="int" overloaded="no"> | |
781d2982 | 13563 | <autodoc>GetX(self) -> int</autodoc> |
368d20e8 RD |
13564 | <docstring>Returns the x coordinate of the double-click point in a |
13565 | EVT_SPLITTER_DCLICK event.</docstring> | |
f32fc4bc RD |
13566 | </method> |
13567 | <method name="GetY" type="int" overloaded="no"> | |
781d2982 | 13568 | <autodoc>GetY(self) -> int</autodoc> |
368d20e8 RD |
13569 | <docstring>Returns the y coordinate of the double-click point in a |
13570 | EVT_SPLITTER_DCLICK event.</docstring> | |
f32fc4bc RD |
13571 | </method> |
13572 | </class> | |
13573 | <pythoncode> | |
856bf319 RD |
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 ) | |
368d20e8 | 13578 | EVT_SPLITTER_DCLICK = EVT_SPLITTER_DOUBLECLICKED |
856bf319 | 13579 | </pythoncode> |
f32fc4bc | 13580 | <pythoncode> |
856bf319 RD |
13581 | #--------------------------------------------------------------------------- |
13582 | </pythoncode> | |
781d2982 | 13583 | <class name="SashWindow" oldname="wxSashWindow" module="_windows"> |
f32fc4bc RD |
13584 | <baseclass name="Window"/> |
13585 | <constructor name="SashWindow" overloaded="no"> | |
781d2982 RD |
13586 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
13587 | Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, | |
856bf319 | 13588 | String name=SashNameStr) -> SashWindow</autodoc> |
f32fc4bc RD |
13589 | <paramlist> |
13590 | <param name="parent" type="Window" default=""/> | |
781d2982 | 13591 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
13596 | </paramlist> | |
13597 | </constructor> | |
13598 | <constructor name="PreSashWindow" overloaded="no"> | |
13599 | <autodoc>PreSashWindow() -> SashWindow</autodoc> | |
13600 | </constructor> | |
13601 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
13602 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
13603 | Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, | |
856bf319 | 13604 | String name=SashNameStr) -> bool</autodoc> |
f32fc4bc RD |
13605 | <paramlist> |
13606 | <param name="parent" type="Window" default=""/> | |
781d2982 | 13607 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
13612 | </paramlist> | |
13613 | </method> | |
13614 | <method name="SetSashVisible" type="" overloaded="no"> | |
781d2982 | 13615 | <autodoc>SetSashVisible(self, int edge, bool sash)</autodoc> |
f32fc4bc RD |
13616 | <paramlist> |
13617 | <param name="edge" type="wxSashEdgePosition" default=""/> | |
13618 | <param name="sash" type="bool" default=""/> | |
13619 | </paramlist> | |
13620 | </method> | |
13621 | <method name="GetSashVisible" type="bool" overloaded="no"> | |
781d2982 | 13622 | <autodoc>GetSashVisible(self, int edge) -> bool</autodoc> |
f32fc4bc RD |
13623 | <paramlist> |
13624 | <param name="edge" type="wxSashEdgePosition" default=""/> | |
13625 | </paramlist> | |
13626 | </method> | |
13627 | <method name="SetSashBorder" type="" overloaded="no"> | |
781d2982 | 13628 | <autodoc>SetSashBorder(self, int edge, bool border)</autodoc> |
f32fc4bc RD |
13629 | <paramlist> |
13630 | <param name="edge" type="wxSashEdgePosition" default=""/> | |
13631 | <param name="border" type="bool" default=""/> | |
13632 | </paramlist> | |
13633 | </method> | |
13634 | <method name="HasBorder" type="bool" overloaded="no"> | |
781d2982 | 13635 | <autodoc>HasBorder(self, int edge) -> bool</autodoc> |
f32fc4bc RD |
13636 | <paramlist> |
13637 | <param name="edge" type="wxSashEdgePosition" default=""/> | |
13638 | </paramlist> | |
13639 | </method> | |
13640 | <method name="GetEdgeMargin" type="int" overloaded="no"> | |
781d2982 | 13641 | <autodoc>GetEdgeMargin(self, int edge) -> int</autodoc> |
f32fc4bc RD |
13642 | <paramlist> |
13643 | <param name="edge" type="wxSashEdgePosition" default=""/> | |
13644 | </paramlist> | |
13645 | </method> | |
13646 | <method name="SetDefaultBorderSize" type="" overloaded="no"> | |
781d2982 | 13647 | <autodoc>SetDefaultBorderSize(self, int width)</autodoc> |
f32fc4bc RD |
13648 | <paramlist> |
13649 | <param name="width" type="int" default=""/> | |
13650 | </paramlist> | |
13651 | </method> | |
13652 | <method name="GetDefaultBorderSize" type="int" overloaded="no"> | |
781d2982 | 13653 | <autodoc>GetDefaultBorderSize(self) -> int</autodoc> |
f32fc4bc RD |
13654 | </method> |
13655 | <method name="SetExtraBorderSize" type="" overloaded="no"> | |
781d2982 | 13656 | <autodoc>SetExtraBorderSize(self, int width)</autodoc> |
f32fc4bc RD |
13657 | <paramlist> |
13658 | <param name="width" type="int" default=""/> | |
13659 | </paramlist> | |
13660 | </method> | |
13661 | <method name="GetExtraBorderSize" type="int" overloaded="no"> | |
781d2982 | 13662 | <autodoc>GetExtraBorderSize(self) -> int</autodoc> |
f32fc4bc RD |
13663 | </method> |
13664 | <method name="SetMinimumSizeX" type="" overloaded="no"> | |
781d2982 | 13665 | <autodoc>SetMinimumSizeX(self, int min)</autodoc> |
f32fc4bc RD |
13666 | <paramlist> |
13667 | <param name="min" type="int" default=""/> | |
13668 | </paramlist> | |
13669 | </method> | |
13670 | <method name="SetMinimumSizeY" type="" overloaded="no"> | |
781d2982 | 13671 | <autodoc>SetMinimumSizeY(self, int min)</autodoc> |
f32fc4bc RD |
13672 | <paramlist> |
13673 | <param name="min" type="int" default=""/> | |
13674 | </paramlist> | |
13675 | </method> | |
13676 | <method name="GetMinimumSizeX" type="int" overloaded="no"> | |
781d2982 | 13677 | <autodoc>GetMinimumSizeX(self) -> int</autodoc> |
f32fc4bc RD |
13678 | </method> |
13679 | <method name="GetMinimumSizeY" type="int" overloaded="no"> | |
781d2982 | 13680 | <autodoc>GetMinimumSizeY(self) -> int</autodoc> |
f32fc4bc RD |
13681 | </method> |
13682 | <method name="SetMaximumSizeX" type="" overloaded="no"> | |
781d2982 | 13683 | <autodoc>SetMaximumSizeX(self, int max)</autodoc> |
f32fc4bc RD |
13684 | <paramlist> |
13685 | <param name="max" type="int" default=""/> | |
13686 | </paramlist> | |
13687 | </method> | |
13688 | <method name="SetMaximumSizeY" type="" overloaded="no"> | |
781d2982 | 13689 | <autodoc>SetMaximumSizeY(self, int max)</autodoc> |
f32fc4bc RD |
13690 | <paramlist> |
13691 | <param name="max" type="int" default=""/> | |
13692 | </paramlist> | |
13693 | </method> | |
13694 | <method name="GetMaximumSizeX" type="int" overloaded="no"> | |
781d2982 | 13695 | <autodoc>GetMaximumSizeX(self) -> int</autodoc> |
f32fc4bc RD |
13696 | </method> |
13697 | <method name="GetMaximumSizeY" type="int" overloaded="no"> | |
781d2982 | 13698 | <autodoc>GetMaximumSizeY(self) -> int</autodoc> |
f32fc4bc RD |
13699 | </method> |
13700 | <method name="SashHitTest" type="wxSashEdgePosition" overloaded="no"> | |
781d2982 | 13701 | <autodoc>SashHitTest(self, int x, int y, int tolerance=2) -> int</autodoc> |
f32fc4bc RD |
13702 | <paramlist> |
13703 | <param name="x" type="int" default=""/> | |
13704 | <param name="y" type="int" default=""/> | |
13705 | <param name="tolerance" type="int" default="2"/> | |
13706 | </paramlist> | |
13707 | </method> | |
13708 | <method name="SizeWindows" type="" overloaded="no"> | |
781d2982 | 13709 | <autodoc>SizeWindows(self)</autodoc> |
f32fc4bc RD |
13710 | </method> |
13711 | </class> | |
781d2982 | 13712 | <class name="SashEvent" oldname="wxSashEvent" module="_windows"> |
f32fc4bc RD |
13713 | <baseclass name="CommandEvent"/> |
13714 | <constructor name="SashEvent" overloaded="no"> | |
781d2982 | 13715 | <autodoc>__init__(self, int id=0, int edge=SASH_NONE) -> SashEvent</autodoc> |
f32fc4bc RD |
13716 | <paramlist> |
13717 | <param name="id" type="int" default="0"/> | |
13718 | <param name="edge" type="wxSashEdgePosition" default="wxSASH_NONE"/> | |
13719 | </paramlist> | |
13720 | </constructor> | |
13721 | <method name="SetEdge" type="" overloaded="no"> | |
781d2982 | 13722 | <autodoc>SetEdge(self, int edge)</autodoc> |
f32fc4bc RD |
13723 | <paramlist> |
13724 | <param name="edge" type="wxSashEdgePosition" default=""/> | |
13725 | </paramlist> | |
13726 | </method> | |
13727 | <method name="GetEdge" type="wxSashEdgePosition" overloaded="no"> | |
781d2982 | 13728 | <autodoc>GetEdge(self) -> int</autodoc> |
f32fc4bc RD |
13729 | </method> |
13730 | <method name="SetDragRect" type="" overloaded="no"> | |
781d2982 | 13731 | <autodoc>SetDragRect(self, Rect rect)</autodoc> |
f32fc4bc RD |
13732 | <paramlist> |
13733 | <param name="rect" type="Rect" default=""/> | |
13734 | </paramlist> | |
13735 | </method> | |
13736 | <method name="GetDragRect" type="Rect" overloaded="no"> | |
781d2982 | 13737 | <autodoc>GetDragRect(self) -> Rect</autodoc> |
f32fc4bc RD |
13738 | </method> |
13739 | <method name="SetDragStatus" type="" overloaded="no"> | |
781d2982 | 13740 | <autodoc>SetDragStatus(self, int status)</autodoc> |
f32fc4bc RD |
13741 | <paramlist> |
13742 | <param name="status" type="wxSashDragStatus" default=""/> | |
13743 | </paramlist> | |
13744 | </method> | |
13745 | <method name="GetDragStatus" type="wxSashDragStatus" overloaded="no"> | |
781d2982 | 13746 | <autodoc>GetDragStatus(self) -> int</autodoc> |
f32fc4bc RD |
13747 | </method> |
13748 | </class> | |
13749 | <pythoncode> | |
856bf319 RD |
13750 | EVT_SASH_DRAGGED = wx.PyEventBinder( wxEVT_SASH_DRAGGED, 1 ) |
13751 | EVT_SASH_DRAGGED_RANGE = wx.PyEventBinder( wxEVT_SASH_DRAGGED, 2 ) | |
13752 | </pythoncode> | |
f32fc4bc | 13753 | <pythoncode> |
856bf319 RD |
13754 | #--------------------------------------------------------------------------- |
13755 | </pythoncode> | |
781d2982 | 13756 | <class name="QueryLayoutInfoEvent" oldname="wxQueryLayoutInfoEvent" module="_windows"> |
f32fc4bc RD |
13757 | <baseclass name="Event"/> |
13758 | <constructor name="QueryLayoutInfoEvent" overloaded="no"> | |
781d2982 | 13759 | <autodoc>__init__(self, int id=0) -> QueryLayoutInfoEvent</autodoc> |
f32fc4bc RD |
13760 | <paramlist> |
13761 | <param name="id" type="int" default="0"/> | |
13762 | </paramlist> | |
13763 | </constructor> | |
13764 | <method name="SetRequestedLength" type="" overloaded="no"> | |
781d2982 | 13765 | <autodoc>SetRequestedLength(self, int length)</autodoc> |
f32fc4bc RD |
13766 | <paramlist> |
13767 | <param name="length" type="int" default=""/> | |
13768 | </paramlist> | |
13769 | </method> | |
13770 | <method name="GetRequestedLength" type="int" overloaded="no"> | |
781d2982 | 13771 | <autodoc>GetRequestedLength(self) -> int</autodoc> |
f32fc4bc RD |
13772 | </method> |
13773 | <method name="SetFlags" type="" overloaded="no"> | |
781d2982 | 13774 | <autodoc>SetFlags(self, int flags)</autodoc> |
f32fc4bc RD |
13775 | <paramlist> |
13776 | <param name="flags" type="int" default=""/> | |
13777 | </paramlist> | |
13778 | </method> | |
13779 | <method name="GetFlags" type="int" overloaded="no"> | |
781d2982 | 13780 | <autodoc>GetFlags(self) -> int</autodoc> |
f32fc4bc RD |
13781 | </method> |
13782 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 13783 | <autodoc>SetSize(self, Size size)</autodoc> |
f32fc4bc RD |
13784 | <paramlist> |
13785 | <param name="size" type="Size" default=""/> | |
13786 | </paramlist> | |
13787 | </method> | |
13788 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 | 13789 | <autodoc>GetSize(self) -> Size</autodoc> |
f32fc4bc RD |
13790 | </method> |
13791 | <method name="SetOrientation" type="" overloaded="no"> | |
781d2982 | 13792 | <autodoc>SetOrientation(self, int orient)</autodoc> |
f32fc4bc RD |
13793 | <paramlist> |
13794 | <param name="orient" type="wxLayoutOrientation" default=""/> | |
13795 | </paramlist> | |
13796 | </method> | |
13797 | <method name="GetOrientation" type="wxLayoutOrientation" overloaded="no"> | |
781d2982 | 13798 | <autodoc>GetOrientation(self) -> int</autodoc> |
f32fc4bc RD |
13799 | </method> |
13800 | <method name="SetAlignment" type="" overloaded="no"> | |
781d2982 | 13801 | <autodoc>SetAlignment(self, int align)</autodoc> |
f32fc4bc RD |
13802 | <paramlist> |
13803 | <param name="align" type="wxLayoutAlignment" default=""/> | |
13804 | </paramlist> | |
13805 | </method> | |
13806 | <method name="GetAlignment" type="wxLayoutAlignment" overloaded="no"> | |
781d2982 | 13807 | <autodoc>GetAlignment(self) -> int</autodoc> |
f32fc4bc RD |
13808 | </method> |
13809 | </class> | |
781d2982 | 13810 | <class name="CalculateLayoutEvent" oldname="wxCalculateLayoutEvent" module="_windows"> |
f32fc4bc RD |
13811 | <baseclass name="Event"/> |
13812 | <constructor name="CalculateLayoutEvent" overloaded="no"> | |
781d2982 | 13813 | <autodoc>__init__(self, int id=0) -> CalculateLayoutEvent</autodoc> |
f32fc4bc RD |
13814 | <paramlist> |
13815 | <param name="id" type="int" default="0"/> | |
13816 | </paramlist> | |
13817 | </constructor> | |
13818 | <method name="SetFlags" type="" overloaded="no"> | |
781d2982 | 13819 | <autodoc>SetFlags(self, int flags)</autodoc> |
f32fc4bc RD |
13820 | <paramlist> |
13821 | <param name="flags" type="int" default=""/> | |
13822 | </paramlist> | |
13823 | </method> | |
13824 | <method name="GetFlags" type="int" overloaded="no"> | |
781d2982 | 13825 | <autodoc>GetFlags(self) -> int</autodoc> |
f32fc4bc RD |
13826 | </method> |
13827 | <method name="SetRect" type="" overloaded="no"> | |
781d2982 | 13828 | <autodoc>SetRect(self, Rect rect)</autodoc> |
f32fc4bc RD |
13829 | <paramlist> |
13830 | <param name="rect" type="Rect" default=""/> | |
13831 | </paramlist> | |
13832 | </method> | |
13833 | <method name="GetRect" type="Rect" overloaded="no"> | |
781d2982 | 13834 | <autodoc>GetRect(self) -> Rect</autodoc> |
f32fc4bc RD |
13835 | </method> |
13836 | </class> | |
13837 | <pythoncode> | |
856bf319 RD |
13838 | EVT_QUERY_LAYOUT_INFO = wx.PyEventBinder( wxEVT_QUERY_LAYOUT_INFO ) |
13839 | EVT_CALCULATE_LAYOUT = wx.PyEventBinder( wxEVT_CALCULATE_LAYOUT ) | |
13840 | </pythoncode> | |
781d2982 | 13841 | <class name="SashLayoutWindow" oldname="wxSashLayoutWindow" module="_windows"> |
f32fc4bc RD |
13842 | <baseclass name="SashWindow"/> |
13843 | <constructor name="SashLayoutWindow" overloaded="no"> | |
781d2982 RD |
13844 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
13845 | Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, | |
856bf319 | 13846 | String name=SashLayoutNameStr) -> SashLayoutWindow</autodoc> |
f32fc4bc RD |
13847 | <paramlist> |
13848 | <param name="parent" type="Window" default=""/> | |
781d2982 | 13849 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
13854 | </paramlist> | |
13855 | </constructor> | |
13856 | <constructor name="PreSashLayoutWindow" overloaded="no"> | |
13857 | <autodoc>PreSashLayoutWindow() -> SashLayoutWindow</autodoc> | |
13858 | </constructor> | |
13859 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
13860 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
13861 | Size size=DefaultSize, long style=wxCLIP_CHILDREN|wxSW_3D, | |
856bf319 | 13862 | String name=SashLayoutNameStr) -> bool</autodoc> |
f32fc4bc RD |
13863 | <paramlist> |
13864 | <param name="parent" type="Window" default=""/> | |
781d2982 | 13865 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
13870 | </paramlist> | |
13871 | </method> | |
13872 | <method name="GetAlignment" type="wxLayoutAlignment" overloaded="no"> | |
781d2982 | 13873 | <autodoc>GetAlignment(self) -> int</autodoc> |
f32fc4bc RD |
13874 | </method> |
13875 | <method name="GetOrientation" type="wxLayoutOrientation" overloaded="no"> | |
781d2982 | 13876 | <autodoc>GetOrientation(self) -> int</autodoc> |
f32fc4bc RD |
13877 | </method> |
13878 | <method name="SetAlignment" type="" overloaded="no"> | |
781d2982 | 13879 | <autodoc>SetAlignment(self, int alignment)</autodoc> |
f32fc4bc RD |
13880 | <paramlist> |
13881 | <param name="alignment" type="wxLayoutAlignment" default=""/> | |
13882 | </paramlist> | |
13883 | </method> | |
13884 | <method name="SetDefaultSize" type="" overloaded="no"> | |
781d2982 | 13885 | <autodoc>SetDefaultSize(self, Size size)</autodoc> |
f32fc4bc RD |
13886 | <paramlist> |
13887 | <param name="size" type="Size" default=""/> | |
13888 | </paramlist> | |
13889 | </method> | |
13890 | <method name="SetOrientation" type="" overloaded="no"> | |
781d2982 | 13891 | <autodoc>SetOrientation(self, int orientation)</autodoc> |
f32fc4bc RD |
13892 | <paramlist> |
13893 | <param name="orientation" type="wxLayoutOrientation" default=""/> | |
13894 | </paramlist> | |
13895 | </method> | |
13896 | </class> | |
781d2982 | 13897 | <class name="LayoutAlgorithm" oldname="wxLayoutAlgorithm" module="_windows"> |
f32fc4bc RD |
13898 | <baseclass name="Object"/> |
13899 | <constructor name="LayoutAlgorithm" overloaded="no"> | |
781d2982 | 13900 | <autodoc>__init__(self) -> LayoutAlgorithm</autodoc> |
f32fc4bc RD |
13901 | </constructor> |
13902 | <destructor name="~wxLayoutAlgorithm" overloaded="no"> | |
781d2982 | 13903 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
13904 | </destructor> |
13905 | <method name="LayoutMDIFrame" type="bool" overloaded="no"> | |
781d2982 | 13906 | <autodoc>LayoutMDIFrame(self, MDIParentFrame frame, Rect rect=None) -> bool</autodoc> |
f32fc4bc RD |
13907 | <paramlist> |
13908 | <param name="frame" type="wxMDIParentFrame" default=""/> | |
13909 | <param name="rect" type="Rect" default="NULL"/> | |
13910 | </paramlist> | |
13911 | </method> | |
13912 | <method name="LayoutFrame" type="bool" overloaded="no"> | |
781d2982 | 13913 | <autodoc>LayoutFrame(self, Frame frame, Window mainWindow=None) -> bool</autodoc> |
f32fc4bc RD |
13914 | <paramlist> |
13915 | <param name="frame" type="Frame" default=""/> | |
13916 | <param name="mainWindow" type="Window" default="NULL"/> | |
13917 | </paramlist> | |
13918 | </method> | |
13919 | <method name="LayoutWindow" type="bool" overloaded="no"> | |
781d2982 | 13920 | <autodoc>LayoutWindow(self, Window parent, Window mainWindow=None) -> bool</autodoc> |
f32fc4bc RD |
13921 | <paramlist> |
13922 | <param name="parent" type="Window" default=""/> | |
13923 | <param name="mainWindow" type="Window" default="NULL"/> | |
13924 | </paramlist> | |
13925 | </method> | |
13926 | </class> | |
13927 | <pythoncode> | |
856bf319 RD |
13928 | #--------------------------------------------------------------------------- |
13929 | </pythoncode> | |
781d2982 | 13930 | <class name="PopupWindow" oldname="wxPopupWindow" module="_windows"> |
f32fc4bc RD |
13931 | <baseclass name="Window"/> |
13932 | <constructor name="PopupWindow" overloaded="no"> | |
781d2982 | 13933 | <autodoc>__init__(self, Window parent, int flags=BORDER_NONE) -> PopupWindow</autodoc> |
f32fc4bc RD |
13934 | <paramlist> |
13935 | <param name="parent" type="Window" default=""/> | |
13936 | <param name="flags" type="int" default="wxBORDER_NONE"/> | |
13937 | </paramlist> | |
13938 | </constructor> | |
13939 | <constructor name="PrePopupWindow" overloaded="no"> | |
13940 | <autodoc>PrePopupWindow() -> PopupWindow</autodoc> | |
13941 | </constructor> | |
13942 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 13943 | <autodoc>Create(self, Window parent, int flags=BORDER_NONE) -> bool</autodoc> |
f32fc4bc RD |
13944 | <paramlist> |
13945 | <param name="parent" type="Window" default=""/> | |
13946 | <param name="flags" type="int" default="wxBORDER_NONE"/> | |
13947 | </paramlist> | |
13948 | </method> | |
13949 | <method name="Position" type="" overloaded="no"> | |
781d2982 | 13950 | <autodoc>Position(self, Point ptOrigin, Size size)</autodoc> |
f32fc4bc RD |
13951 | <paramlist> |
13952 | <param name="ptOrigin" type="Point" default=""/> | |
13953 | <param name="size" type="Size" default=""/> | |
13954 | </paramlist> | |
13955 | </method> | |
13956 | </class> | |
13957 | <pythoncode> | |
856bf319 RD |
13958 | #--------------------------------------------------------------------------- |
13959 | </pythoncode> | |
781d2982 | 13960 | <class name="PopupTransientWindow" oldname="wxPyPopupTransientWindow" module="_windows"> |
f32fc4bc RD |
13961 | <baseclass name="PopupWindow"/> |
13962 | <constructor name="wxPyPopupTransientWindow" overloaded="no"> | |
781d2982 | 13963 | <autodoc>__init__(self, Window parent, int style=BORDER_NONE) -> PopupTransientWindow</autodoc> |
f32fc4bc RD |
13964 | <paramlist> |
13965 | <param name="parent" type="Window" default=""/> | |
13966 | <param name="style" type="int" default="wxBORDER_NONE"/> | |
13967 | </paramlist> | |
13968 | </constructor> | |
13969 | <constructor name="PrePopupTransientWindow" overloaded="no"> | |
13970 | <autodoc>PrePopupTransientWindow() -> PopupTransientWindow</autodoc> | |
13971 | </constructor> | |
13972 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 13973 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
13974 | <paramlist> |
13975 | <param name="self" type="PyObject" default=""/> | |
13976 | <param name="_class" type="PyObject" default=""/> | |
13977 | </paramlist> | |
13978 | </method> | |
13979 | <method name="Popup" type="" overloaded="no"> | |
781d2982 | 13980 | <autodoc>Popup(self, Window focus=None)</autodoc> |
f32fc4bc RD |
13981 | <paramlist> |
13982 | <param name="focus" type="Window" default="NULL"/> | |
13983 | </paramlist> | |
13984 | </method> | |
13985 | <method name="Dismiss" type="" overloaded="no"> | |
781d2982 | 13986 | <autodoc>Dismiss(self)</autodoc> |
f32fc4bc RD |
13987 | </method> |
13988 | </class> | |
13989 | <pythoncode> | |
856bf319 RD |
13990 | #--------------------------------------------------------------------------- |
13991 | </pythoncode> | |
781d2982 | 13992 | <class name="TipWindow" oldname="wxTipWindow" module="_windows"> |
f32fc4bc RD |
13993 | <baseclass name="PopupTransientWindow"/> |
13994 | <constructor name="TipWindow" overloaded="no"> | |
781d2982 | 13995 | <autodoc>__init__(self, Window parent, String text, int maxLength=100, Rect rectBound=None) -> TipWindow</autodoc> |
f32fc4bc RD |
13996 | <paramlist> |
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"/> | |
14001 | </paramlist> | |
14002 | </constructor> | |
14003 | <method name="SetBoundingRect" type="" overloaded="no"> | |
781d2982 | 14004 | <autodoc>SetBoundingRect(self, Rect rectBound)</autodoc> |
f32fc4bc RD |
14005 | <paramlist> |
14006 | <param name="rectBound" type="Rect" default=""/> | |
14007 | </paramlist> | |
14008 | </method> | |
14009 | <method name="Close" type="" overloaded="no"> | |
781d2982 | 14010 | <autodoc>Close(self)</autodoc> |
f32fc4bc RD |
14011 | </method> |
14012 | </class> | |
14013 | <pythoncode> | |
856bf319 RD |
14014 | #--------------------------------------------------------------------------- |
14015 | </pythoncode> | |
781d2982 | 14016 | <class name="VScrolledWindow" oldname="wxPyVScrolledWindow" module="_windows"> |
f32fc4bc RD |
14017 | <baseclass name="Panel"/> |
14018 | <constructor name="wxPyVScrolledWindow" overloaded="no"> | |
781d2982 | 14019 | <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, |
856bf319 | 14020 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> VScrolledWindow</autodoc> |
f32fc4bc RD |
14021 | <paramlist> |
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"/> | |
14028 | </paramlist> | |
14029 | </constructor> | |
14030 | <constructor name="PreVScrolledWindow" overloaded="no"> | |
14031 | <autodoc>PreVScrolledWindow() -> VScrolledWindow</autodoc> | |
14032 | </constructor> | |
14033 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 14034 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
14035 | <paramlist> |
14036 | <param name="self" type="PyObject" default=""/> | |
14037 | <param name="_class" type="PyObject" default=""/> | |
14038 | </paramlist> | |
14039 | </method> | |
14040 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 14041 | <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, |
856bf319 | 14042 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> bool</autodoc> |
f32fc4bc RD |
14043 | <paramlist> |
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"/> | |
14050 | </paramlist> | |
14051 | </method> | |
14052 | <method name="SetLineCount" type="" overloaded="no"> | |
781d2982 | 14053 | <autodoc>SetLineCount(self, size_t count)</autodoc> |
f32fc4bc RD |
14054 | <paramlist> |
14055 | <param name="count" type="size_t" default=""/> | |
14056 | </paramlist> | |
14057 | </method> | |
14058 | <method name="ScrollToLine" type="bool" overloaded="no"> | |
781d2982 | 14059 | <autodoc>ScrollToLine(self, size_t line) -> bool</autodoc> |
f32fc4bc RD |
14060 | <paramlist> |
14061 | <param name="line" type="size_t" default=""/> | |
14062 | </paramlist> | |
14063 | </method> | |
14064 | <method name="ScrollLines" type="bool" overloaded="no"> | |
781d2982 | 14065 | <autodoc>ScrollLines(self, int lines) -> bool</autodoc> |
f32fc4bc RD |
14066 | <paramlist> |
14067 | <param name="lines" type="int" default=""/> | |
14068 | </paramlist> | |
14069 | </method> | |
14070 | <method name="ScrollPages" type="bool" overloaded="no"> | |
781d2982 RD |
14071 | <autodoc>ScrollPages(self, int pages) -> bool</autodoc> |
14072 | <docstring>If the platform and window class supports it, scrolls the window by | |
c2dda882 RD |
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> | |
f32fc4bc RD |
14076 | <paramlist> |
14077 | <param name="pages" type="int" default=""/> | |
14078 | </paramlist> | |
14079 | </method> | |
14080 | <method name="RefreshLine" type="" overloaded="no"> | |
781d2982 | 14081 | <autodoc>RefreshLine(self, size_t line)</autodoc> |
f32fc4bc RD |
14082 | <paramlist> |
14083 | <param name="line" type="size_t" default=""/> | |
14084 | </paramlist> | |
14085 | </method> | |
14086 | <method name="RefreshLines" type="" overloaded="no"> | |
781d2982 | 14087 | <autodoc>RefreshLines(self, size_t from, size_t to)</autodoc> |
f32fc4bc RD |
14088 | <paramlist> |
14089 | <param name="from" type="size_t" default=""/> | |
14090 | <param name="to" type="size_t" default=""/> | |
14091 | </paramlist> | |
14092 | </method> | |
ce6878e6 RD |
14093 | <method name="HitTestXY" type="int" overloaded="no"> |
14094 | <autodoc>HitTestXY(self, int x, int y) -> int</autodoc> | |
c2dda882 | 14095 | <docstring>Test where the given (in client coords) point lies</docstring> |
f32fc4bc RD |
14096 | <paramlist> |
14097 | <param name="x" type="int" default=""/> | |
14098 | <param name="y" type="int" default=""/> | |
14099 | </paramlist> | |
14100 | </method> | |
14101 | <method name="HitTest" type="int" overloaded="no"> | |
781d2982 | 14102 | <autodoc>HitTest(self, Point pt) -> int</autodoc> |
c2dda882 | 14103 | <docstring>Test where the given (in client coords) point lies</docstring> |
f32fc4bc RD |
14104 | <paramlist> |
14105 | <param name="pt" type="Point" default=""/> | |
14106 | </paramlist> | |
14107 | </method> | |
14108 | <method name="RefreshAll" type="" overloaded="no"> | |
781d2982 | 14109 | <autodoc>RefreshAll(self)</autodoc> |
f32fc4bc RD |
14110 | </method> |
14111 | <method name="GetLineCount" type="size_t" overloaded="no"> | |
781d2982 | 14112 | <autodoc>GetLineCount(self) -> size_t</autodoc> |
f32fc4bc RD |
14113 | </method> |
14114 | <method name="GetFirstVisibleLine" type="size_t" overloaded="no"> | |
781d2982 | 14115 | <autodoc>GetFirstVisibleLine(self) -> size_t</autodoc> |
f32fc4bc RD |
14116 | </method> |
14117 | <method name="GetLastVisibleLine" type="size_t" overloaded="no"> | |
781d2982 | 14118 | <autodoc>GetLastVisibleLine(self) -> size_t</autodoc> |
f32fc4bc RD |
14119 | </method> |
14120 | <method name="IsVisible" type="bool" overloaded="no"> | |
781d2982 | 14121 | <autodoc>IsVisible(self, size_t line) -> bool</autodoc> |
f32fc4bc RD |
14122 | <paramlist> |
14123 | <param name="line" type="size_t" default=""/> | |
14124 | </paramlist> | |
14125 | </method> | |
14126 | </class> | |
781d2982 | 14127 | <class name="VListBox" oldname="wxPyVListBox" module="_windows"> |
f32fc4bc RD |
14128 | <baseclass name="VScrolledWindow"/> |
14129 | <constructor name="wxPyVListBox" overloaded="no"> | |
781d2982 | 14130 | <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, |
856bf319 | 14131 | Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> VListBox</autodoc> |
f32fc4bc RD |
14132 | <paramlist> |
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"/> | |
14139 | </paramlist> | |
14140 | </constructor> | |
14141 | <constructor name="PreVListBox" overloaded="no"> | |
14142 | <autodoc>PreVListBox() -> VListBox</autodoc> | |
14143 | </constructor> | |
14144 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 14145 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
14146 | <paramlist> |
14147 | <param name="self" type="PyObject" default=""/> | |
14148 | <param name="_class" type="PyObject" default=""/> | |
14149 | </paramlist> | |
14150 | </method> | |
14151 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 14152 | <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, |
856bf319 | 14153 | Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool</autodoc> |
f32fc4bc RD |
14154 | <paramlist> |
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"/> | |
14161 | </paramlist> | |
14162 | </method> | |
14163 | <method name="GetItemCount" type="size_t" overloaded="no"> | |
781d2982 | 14164 | <autodoc>GetItemCount(self) -> size_t</autodoc> |
f32fc4bc RD |
14165 | </method> |
14166 | <method name="HasMultipleSelection" type="bool" overloaded="no"> | |
781d2982 | 14167 | <autodoc>HasMultipleSelection(self) -> bool</autodoc> |
f32fc4bc RD |
14168 | </method> |
14169 | <method name="GetSelection" type="int" overloaded="no"> | |
781d2982 | 14170 | <autodoc>GetSelection(self) -> int</autodoc> |
f32fc4bc RD |
14171 | </method> |
14172 | <method name="IsCurrent" type="bool" overloaded="no"> | |
781d2982 | 14173 | <autodoc>IsCurrent(self, size_t item) -> bool</autodoc> |
f32fc4bc RD |
14174 | <paramlist> |
14175 | <param name="item" type="size_t" default=""/> | |
14176 | </paramlist> | |
14177 | </method> | |
14178 | <method name="IsSelected" type="bool" overloaded="no"> | |
781d2982 | 14179 | <autodoc>IsSelected(self, size_t item) -> bool</autodoc> |
f32fc4bc RD |
14180 | <paramlist> |
14181 | <param name="item" type="size_t" default=""/> | |
14182 | </paramlist> | |
14183 | </method> | |
14184 | <method name="GetSelectedCount" type="size_t" overloaded="no"> | |
781d2982 | 14185 | <autodoc>GetSelectedCount(self) -> size_t</autodoc> |
f32fc4bc | 14186 | </method> |
781d2982 RD |
14187 | <method name="GetFirstSelected" type="PyObject" overloaded="no"> |
14188 | <autodoc>GetFirstSelected(self) -> PyObject</autodoc> | |
f32fc4bc | 14189 | </method> |
781d2982 RD |
14190 | <method name="GetNextSelected" type="PyObject" overloaded="no"> |
14191 | <autodoc>GetNextSelected(self, unsigned long cookie) -> PyObject</autodoc> | |
f32fc4bc RD |
14192 | <paramlist> |
14193 | <param name="cookie" type="unsigned long" default=""/> | |
14194 | </paramlist> | |
14195 | </method> | |
14196 | <method name="GetMargins" type="Point" overloaded="no"> | |
781d2982 | 14197 | <autodoc>GetMargins(self) -> Point</autodoc> |
f32fc4bc RD |
14198 | </method> |
14199 | <method name="GetSelectionBackground" type="Colour" overloaded="no"> | |
781d2982 | 14200 | <autodoc>GetSelectionBackground(self) -> Colour</autodoc> |
f32fc4bc RD |
14201 | </method> |
14202 | <method name="SetItemCount" type="" overloaded="no"> | |
781d2982 | 14203 | <autodoc>SetItemCount(self, size_t count)</autodoc> |
f32fc4bc RD |
14204 | <paramlist> |
14205 | <param name="count" type="size_t" default=""/> | |
14206 | </paramlist> | |
14207 | </method> | |
14208 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 14209 | <autodoc>Clear(self)</autodoc> |
f32fc4bc RD |
14210 | </method> |
14211 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 14212 | <autodoc>SetSelection(self, int selection)</autodoc> |
f32fc4bc RD |
14213 | <paramlist> |
14214 | <param name="selection" type="int" default=""/> | |
14215 | </paramlist> | |
14216 | </method> | |
14217 | <method name="Select" type="bool" overloaded="no"> | |
781d2982 | 14218 | <autodoc>Select(self, size_t item, bool select=True) -> bool</autodoc> |
f32fc4bc RD |
14219 | <paramlist> |
14220 | <param name="item" type="size_t" default=""/> | |
14221 | <param name="select" type="bool" default="True"/> | |
14222 | </paramlist> | |
14223 | </method> | |
14224 | <method name="SelectRange" type="bool" overloaded="no"> | |
781d2982 | 14225 | <autodoc>SelectRange(self, size_t from, size_t to) -> bool</autodoc> |
f32fc4bc RD |
14226 | <paramlist> |
14227 | <param name="from" type="size_t" default=""/> | |
14228 | <param name="to" type="size_t" default=""/> | |
14229 | </paramlist> | |
14230 | </method> | |
14231 | <method name="Toggle" type="" overloaded="no"> | |
781d2982 | 14232 | <autodoc>Toggle(self, size_t item)</autodoc> |
f32fc4bc RD |
14233 | <paramlist> |
14234 | <param name="item" type="size_t" default=""/> | |
14235 | </paramlist> | |
14236 | </method> | |
14237 | <method name="SelectAll" type="bool" overloaded="no"> | |
781d2982 | 14238 | <autodoc>SelectAll(self) -> bool</autodoc> |
f32fc4bc RD |
14239 | </method> |
14240 | <method name="DeselectAll" type="bool" overloaded="no"> | |
781d2982 | 14241 | <autodoc>DeselectAll(self) -> bool</autodoc> |
f32fc4bc RD |
14242 | </method> |
14243 | <method name="SetMargins" type="" overloaded="no"> | |
781d2982 | 14244 | <autodoc>SetMargins(self, Point pt)</autodoc> |
f32fc4bc RD |
14245 | <paramlist> |
14246 | <param name="pt" type="Point" default=""/> | |
14247 | </paramlist> | |
14248 | </method> | |
14249 | <method name="SetMarginsXY" type="" overloaded="no"> | |
781d2982 | 14250 | <autodoc>SetMarginsXY(self, int x, int y)</autodoc> |
f32fc4bc RD |
14251 | <paramlist> |
14252 | <param name="x" type="int" default=""/> | |
14253 | <param name="y" type="int" default=""/> | |
14254 | </paramlist> | |
14255 | </method> | |
14256 | <method name="SetSelectionBackground" type="" overloaded="no"> | |
781d2982 | 14257 | <autodoc>SetSelectionBackground(self, Colour col)</autodoc> |
f32fc4bc RD |
14258 | <paramlist> |
14259 | <param name="col" type="Colour" default=""/> | |
14260 | </paramlist> | |
14261 | </method> | |
14262 | </class> | |
781d2982 | 14263 | <class name="HtmlListBox" oldname="wxPyHtmlListBox" module="_windows"> |
f32fc4bc RD |
14264 | <baseclass name="VListBox"/> |
14265 | <constructor name="wxPyHtmlListBox" overloaded="no"> | |
781d2982 | 14266 | <autodoc>__init__(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, |
856bf319 | 14267 | Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> HtmlListBox</autodoc> |
f32fc4bc RD |
14268 | <paramlist> |
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"/> | |
14275 | </paramlist> | |
14276 | </constructor> | |
14277 | <constructor name="PreHtmlListBox" overloaded="no"> | |
14278 | <autodoc>PreHtmlListBox() -> HtmlListBox</autodoc> | |
14279 | </constructor> | |
14280 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 14281 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
14282 | <paramlist> |
14283 | <param name="self" type="PyObject" default=""/> | |
14284 | <param name="_class" type="PyObject" default=""/> | |
14285 | </paramlist> | |
14286 | </method> | |
14287 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 14288 | <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, |
856bf319 | 14289 | Size size=DefaultSize, long style=0, String name=VListBoxNameStr) -> bool</autodoc> |
f32fc4bc RD |
14290 | <paramlist> |
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"/> | |
14297 | </paramlist> | |
14298 | </method> | |
14299 | <method name="RefreshAll" type="" overloaded="no"> | |
781d2982 | 14300 | <autodoc>RefreshAll(self)</autodoc> |
f32fc4bc RD |
14301 | </method> |
14302 | <method name="SetItemCount" type="" overloaded="no"> | |
781d2982 | 14303 | <autodoc>SetItemCount(self, size_t count)</autodoc> |
f32fc4bc RD |
14304 | <paramlist> |
14305 | <param name="count" type="size_t" default=""/> | |
14306 | </paramlist> | |
14307 | </method> | |
781d2982 RD |
14308 | <method name="GetFileSystem" type="FileSystem" overloaded="no"> |
14309 | <autodoc>GetFileSystem(self) -> FileSystem</autodoc> | |
14310 | </method> | |
f32fc4bc RD |
14311 | </class> |
14312 | <pythoncode> | |
856bf319 RD |
14313 | #--------------------------------------------------------------------------- |
14314 | </pythoncode> | |
781d2982 | 14315 | <class name="TaskBarIcon" oldname="wxTaskBarIcon" module="_windows"> |
f32fc4bc RD |
14316 | <baseclass name="EvtHandler"/> |
14317 | <constructor name="TaskBarIcon" overloaded="no"> | |
781d2982 | 14318 | <autodoc>__init__(self) -> TaskBarIcon</autodoc> |
f32fc4bc RD |
14319 | </constructor> |
14320 | <destructor name="~wxTaskBarIcon" overloaded="no"> | |
781d2982 | 14321 | <autodoc>__del__(self)</autodoc> |
f32fc4bc | 14322 | </destructor> |
781d2982 RD |
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> | |
14326 | </method> | |
f32fc4bc | 14327 | <method name="IsOk" type="bool" overloaded="no"> |
781d2982 | 14328 | <autodoc>IsOk(self) -> bool</autodoc> |
f32fc4bc RD |
14329 | </method> |
14330 | <method name="IsIconInstalled" type="bool" overloaded="no"> | |
781d2982 | 14331 | <autodoc>IsIconInstalled(self) -> bool</autodoc> |
f32fc4bc RD |
14332 | </method> |
14333 | <method name="SetIcon" type="bool" overloaded="no"> | |
781d2982 | 14334 | <autodoc>SetIcon(self, Icon icon, String tooltip=EmptyString) -> bool</autodoc> |
f32fc4bc RD |
14335 | <paramlist> |
14336 | <param name="icon" type="Icon" default=""/> | |
14337 | <param name="tooltip" type="String" default="wxPyEmptyString"/> | |
14338 | </paramlist> | |
14339 | </method> | |
14340 | <method name="RemoveIcon" type="bool" overloaded="no"> | |
781d2982 | 14341 | <autodoc>RemoveIcon(self) -> bool</autodoc> |
f32fc4bc RD |
14342 | </method> |
14343 | <method name="PopupMenu" type="bool" overloaded="no"> | |
781d2982 | 14344 | <autodoc>PopupMenu(self, Menu menu) -> bool</autodoc> |
f32fc4bc RD |
14345 | <paramlist> |
14346 | <param name="menu" type="Menu" default=""/> | |
14347 | </paramlist> | |
14348 | </method> | |
14349 | </class> | |
781d2982 | 14350 | <class name="TaskBarIconEvent" oldname="wxTaskBarIconEvent" module="_windows"> |
f32fc4bc RD |
14351 | <baseclass name="Event"/> |
14352 | <constructor name="TaskBarIconEvent" overloaded="no"> | |
781d2982 | 14353 | <autodoc>__init__(self, wxEventType evtType, TaskBarIcon tbIcon) -> TaskBarIconEvent</autodoc> |
f32fc4bc RD |
14354 | <paramlist> |
14355 | <param name="evtType" type="wxEventType" default=""/> | |
14356 | <param name="tbIcon" type="TaskBarIcon" default=""/> | |
14357 | </paramlist> | |
14358 | </constructor> | |
14359 | </class> | |
14360 | <pythoncode> | |
856bf319 RD |
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 ) | |
14368 | </pythoncode> | |
f32fc4bc | 14369 | <pythoncode> |
856bf319 RD |
14370 | #--------------------------------------------------------------------------- |
14371 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14376 | <baseclass name="Object"/> |
14377 | <constructor name="ColourData" overloaded="no"> | |
781d2982 | 14378 | <autodoc>__init__(self) -> ColourData</autodoc> |
c2dda882 | 14379 | <docstring>Constructor, sets default values.</docstring> |
f32fc4bc RD |
14380 | </constructor> |
14381 | <destructor name="~wxColourData" overloaded="no"> | |
781d2982 | 14382 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
14383 | </destructor> |
14384 | <method name="GetChooseFull" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14389 | </method> |
14390 | <method name="GetColour" type="Colour" overloaded="no"> | |
781d2982 | 14391 | <autodoc>GetColour(self) -> Colour</autodoc> |
c2dda882 | 14392 | <docstring>Gets the colour (pre)selected by the dialog.</docstring> |
f32fc4bc RD |
14393 | </method> |
14394 | <method name="GetCustomColour" type="Colour" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14399 | <paramlist> |
14400 | <param name="i" type="int" default=""/> | |
14401 | </paramlist> | |
14402 | </method> | |
14403 | <method name="SetChooseFull" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14408 | <paramlist> |
14409 | <param name="flag" type="int" default=""/> | |
14410 | </paramlist> | |
14411 | </method> | |
14412 | <method name="SetColour" type="" overloaded="no"> | |
781d2982 RD |
14413 | <autodoc>SetColour(self, Colour colour)</autodoc> |
14414 | <docstring>Sets the default colour for the colour dialog. The default colour is | |
14415 | black.</docstring> | |
f32fc4bc RD |
14416 | <paramlist> |
14417 | <param name="colour" type="Colour" default=""/> | |
14418 | </paramlist> | |
14419 | </method> | |
14420 | <method name="SetCustomColour" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14424 | <paramlist> |
14425 | <param name="i" type="int" default=""/> | |
14426 | <param name="colour" type="Colour" default=""/> | |
14427 | </paramlist> | |
14428 | </method> | |
14429 | </class> | |
781d2982 | 14430 | <class name="ColourDialog" oldname="wxColourDialog" module="_windows"> |
c2dda882 | 14431 | <docstring>This class represents the colour chooser dialog.</docstring> |
f32fc4bc RD |
14432 | <baseclass name="Dialog"/> |
14433 | <constructor name="ColourDialog" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14438 | <paramlist> |
14439 | <param name="parent" type="Window" default=""/> | |
14440 | <param name="data" type="ColourData" default="NULL"/> | |
14441 | </paramlist> | |
14442 | </constructor> | |
14443 | <method name="GetColourData" type="ColourData" overloaded="no"> | |
781d2982 RD |
14444 | <autodoc>GetColourData(self) -> ColourData</autodoc> |
14445 | <docstring>Returns a reference to the `wx.ColourData` used by the dialog.</docstring> | |
14446 | </method> | |
14447 | </class> | |
14448 | <class name="DirDialog" oldname="wxDirDialog" module="_windows"> | |
14449 | <docstring>wx.DirDialog allows the user to select a directory by browising the | |
ce6878e6 RD |
14450 | file system. |
14451 | ||
14452 | Window Styles | |
14453 | -------------- | |
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 | ==================== ========================================== | |
14460 | </docstring> | |
f32fc4bc RD |
14461 | <baseclass name="Dialog"/> |
14462 | <constructor name="DirDialog" overloaded="no"> | |
781d2982 | 14463 | <autodoc>__init__(self, Window parent, String message=DirSelectorPromptStr, |
856bf319 RD |
14464 | String defaultPath=EmptyString, long style=0, |
14465 | Point pos=DefaultPosition, Size size=DefaultSize, | |
14466 | String name=DirDialogNameStr) -> DirDialog</autodoc> | |
c2dda882 | 14467 | <docstring>Constructor. Use ShowModal method to show the dialog.</docstring> |
f32fc4bc RD |
14468 | <paramlist> |
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"/> | |
14476 | </paramlist> | |
14477 | </constructor> | |
14478 | <method name="GetPath" type="String" overloaded="no"> | |
781d2982 | 14479 | <autodoc>GetPath(self) -> String</autodoc> |
c2dda882 | 14480 | <docstring>Returns the default or user-selected path.</docstring> |
f32fc4bc RD |
14481 | </method> |
14482 | <method name="GetMessage" type="String" overloaded="no"> | |
781d2982 | 14483 | <autodoc>GetMessage(self) -> String</autodoc> |
c2dda882 | 14484 | <docstring>Returns the message that will be displayed on the dialog.</docstring> |
f32fc4bc RD |
14485 | </method> |
14486 | <method name="GetStyle" type="long" overloaded="no"> | |
781d2982 | 14487 | <autodoc>GetStyle(self) -> long</autodoc> |
c2dda882 | 14488 | <docstring>Returns the dialog style.</docstring> |
f32fc4bc RD |
14489 | </method> |
14490 | <method name="SetMessage" type="" overloaded="no"> | |
781d2982 | 14491 | <autodoc>SetMessage(self, String message)</autodoc> |
c2dda882 | 14492 | <docstring>Sets the message that will be displayed on the dialog.</docstring> |
f32fc4bc RD |
14493 | <paramlist> |
14494 | <param name="message" type="String" default=""/> | |
14495 | </paramlist> | |
14496 | </method> | |
14497 | <method name="SetPath" type="" overloaded="no"> | |
781d2982 | 14498 | <autodoc>SetPath(self, String path)</autodoc> |
c2dda882 | 14499 | <docstring>Sets the default path.</docstring> |
f32fc4bc RD |
14500 | <paramlist> |
14501 | <param name="path" type="String" default=""/> | |
14502 | </paramlist> | |
14503 | </method> | |
f32fc4bc | 14504 | </class> |
781d2982 RD |
14505 | <class name="FileDialog" oldname="wxFileDialog" module="_windows"> |
14506 | <docstring>wx.FileDialog allows the user to select one or more files from the | |
ce6878e6 RD |
14507 | filesystem. |
14508 | ||
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. | |
14516 | ||
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:: | |
14522 | ||
14523 | "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" | |
14524 | ||
14525 | ||
14526 | Window Styles | |
14527 | -------------- | |
14528 | =================== ========================================== | |
14529 | wx.OPEN This is an open dialog. | |
14530 | ||
14531 | wx.SAVE This is a save dialog. | |
14532 | ||
14533 | wx.HIDE_READONLY For open dialog only: hide the checkbox | |
14534 | allowing to open the file in read-only mode. | |
14535 | ||
14536 | wx.OVERWRITE_PROMPT For save dialog only: prompt for a confirmation | |
14537 | if a file will be overwritten. | |
14538 | ||
14539 | wx.MULTIPLE For open dialog only: allows selecting multiple | |
14540 | files. | |
14541 | ||
14542 | wx.CHANGE_DIR Change the current working directory to the | |
14543 | directory where the file(s) chosen by the user | |
14544 | are. | |
14545 | =================== ========================================== | |
14546 | </docstring> | |
f32fc4bc RD |
14547 | <baseclass name="Dialog"/> |
14548 | <constructor name="FileDialog" overloaded="no"> | |
781d2982 | 14549 | <autodoc>__init__(self, Window parent, String message=FileSelectorPromptStr, |
856bf319 RD |
14550 | String defaultDir=EmptyString, String defaultFile=EmptyString, |
14551 | String wildcard=FileSelectorDefaultWildcardStr, | |
14552 | long style=0, Point pos=DefaultPosition) -> FileDialog</autodoc> | |
c2dda882 | 14553 | <docstring>Constructor. Use ShowModal method to show the dialog.</docstring> |
f32fc4bc RD |
14554 | <paramlist> |
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"/> | |
14562 | </paramlist> | |
14563 | </constructor> | |
14564 | <method name="SetMessage" type="" overloaded="no"> | |
781d2982 | 14565 | <autodoc>SetMessage(self, String message)</autodoc> |
c2dda882 | 14566 | <docstring>Sets the message that will be displayed on the dialog.</docstring> |
f32fc4bc RD |
14567 | <paramlist> |
14568 | <param name="message" type="String" default=""/> | |
14569 | </paramlist> | |
14570 | </method> | |
14571 | <method name="SetPath" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14575 | <paramlist> |
14576 | <param name="path" type="String" default=""/> | |
14577 | </paramlist> | |
14578 | </method> | |
14579 | <method name="SetDirectory" type="" overloaded="no"> | |
781d2982 | 14580 | <autodoc>SetDirectory(self, String dir)</autodoc> |
c2dda882 | 14581 | <docstring>Sets the default directory.</docstring> |
f32fc4bc RD |
14582 | <paramlist> |
14583 | <param name="dir" type="String" default=""/> | |
14584 | </paramlist> | |
14585 | </method> | |
14586 | <method name="SetFilename" type="" overloaded="no"> | |
781d2982 | 14587 | <autodoc>SetFilename(self, String name)</autodoc> |
c2dda882 | 14588 | <docstring>Sets the default filename.</docstring> |
f32fc4bc RD |
14589 | <paramlist> |
14590 | <param name="name" type="String" default=""/> | |
14591 | </paramlist> | |
14592 | </method> | |
14593 | <method name="SetWildcard" type="" overloaded="no"> | |
781d2982 RD |
14594 | <autodoc>SetWildcard(self, String wildCard)</autodoc> |
14595 | <docstring>Sets the wildcard, which can contain multiple file types, for | |
14596 | example:: | |
14597 | ||
14598 | "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" | |
14599 | </docstring> | |
f32fc4bc RD |
14600 | <paramlist> |
14601 | <param name="wildCard" type="String" default=""/> | |
14602 | </paramlist> | |
14603 | </method> | |
14604 | <method name="SetStyle" type="" overloaded="no"> | |
781d2982 | 14605 | <autodoc>SetStyle(self, long style)</autodoc> |
c2dda882 | 14606 | <docstring>Sets the dialog style.</docstring> |
f32fc4bc RD |
14607 | <paramlist> |
14608 | <param name="style" type="long" default=""/> | |
14609 | </paramlist> | |
14610 | </method> | |
14611 | <method name="SetFilterIndex" type="" overloaded="no"> | |
781d2982 | 14612 | <autodoc>SetFilterIndex(self, int filterIndex)</autodoc> |
c2dda882 | 14613 | <docstring>Sets the default filter index, starting from zero.</docstring> |
f32fc4bc RD |
14614 | <paramlist> |
14615 | <param name="filterIndex" type="int" default=""/> | |
14616 | </paramlist> | |
14617 | </method> | |
14618 | <method name="GetMessage" type="String" overloaded="no"> | |
781d2982 | 14619 | <autodoc>GetMessage(self) -> String</autodoc> |
c2dda882 | 14620 | <docstring>Returns the message that will be displayed on the dialog.</docstring> |
f32fc4bc RD |
14621 | </method> |
14622 | <method name="GetPath" type="String" overloaded="no"> | |
781d2982 | 14623 | <autodoc>GetPath(self) -> String</autodoc> |
c2dda882 | 14624 | <docstring>Returns the full path (directory and filename) of the selected file.</docstring> |
f32fc4bc RD |
14625 | </method> |
14626 | <method name="GetDirectory" type="String" overloaded="no"> | |
781d2982 | 14627 | <autodoc>GetDirectory(self) -> String</autodoc> |
c2dda882 | 14628 | <docstring>Returns the default directory.</docstring> |
f32fc4bc RD |
14629 | </method> |
14630 | <method name="GetFilename" type="String" overloaded="no"> | |
781d2982 | 14631 | <autodoc>GetFilename(self) -> String</autodoc> |
c2dda882 | 14632 | <docstring>Returns the default filename.</docstring> |
f32fc4bc RD |
14633 | </method> |
14634 | <method name="GetWildcard" type="String" overloaded="no"> | |
781d2982 | 14635 | <autodoc>GetWildcard(self) -> String</autodoc> |
c2dda882 | 14636 | <docstring>Returns the file dialog wildcard.</docstring> |
f32fc4bc RD |
14637 | </method> |
14638 | <method name="GetStyle" type="long" overloaded="no"> | |
781d2982 | 14639 | <autodoc>GetStyle(self) -> long</autodoc> |
c2dda882 | 14640 | <docstring>Returns the dialog style.</docstring> |
f32fc4bc RD |
14641 | </method> |
14642 | <method name="GetFilterIndex" type="int" overloaded="no"> | |
781d2982 | 14643 | <autodoc>GetFilterIndex(self) -> int</autodoc> |
c2dda882 RD |
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 | |
781d2982 RD |
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> | |
f32fc4bc RD |
14648 | </method> |
14649 | <method name="GetFilenames" type="PyObject" overloaded="no"> | |
781d2982 RD |
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 | |
c2dda882 | 14653 | GetFilename for the others.</docstring> |
f32fc4bc RD |
14654 | </method> |
14655 | <method name="GetPaths" type="PyObject" overloaded="no"> | |
781d2982 | 14656 | <autodoc>GetPaths(self) -> PyObject</autodoc> |
c2dda882 | 14657 | <docstring>Fills the array paths with the full paths of the files chosen. This |
781d2982 RD |
14658 | function should only be used with the dialogs which have wx.MULTIPLE |
14659 | style, use GetPath for the others.</docstring> | |
f32fc4bc RD |
14660 | </method> |
14661 | </class> | |
781d2982 | 14662 | <class name="MultiChoiceDialog" oldname="wxMultiChoiceDialog" module="_windows"> |
c2dda882 | 14663 | <docstring>A simple dialog with a multi selection listbox.</docstring> |
f32fc4bc RD |
14664 | <baseclass name="Dialog"/> |
14665 | <constructor name="MultiChoiceDialog" overloaded="no"> | |
c2dda882 RD |
14666 | <autodoc>__init__(Window parent, String message, String caption, |
14667 | List choices=[], long style=CHOICEDLG_STYLE, | |
856bf319 | 14668 | Point pos=DefaultPosition) -> MultiChoiceDialog</autodoc> |
c2dda882 | 14669 | <docstring>Constructor. Use ShowModal method to show the dialog.</docstring> |
f32fc4bc RD |
14670 | <paramlist> |
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"/> | |
781d2982 | 14675 | <param name="choices_array" type="String" default="NULL"/> |
f32fc4bc RD |
14676 | <param name="style" type="long" default="wxCHOICEDLG_STYLE"/> |
14677 | <param name="pos" type="Point" default="wxDefaultPosition"/> | |
14678 | </paramlist> | |
14679 | </constructor> | |
14680 | <method name="SetSelections" type="" overloaded="no"> | |
c2dda882 | 14681 | <autodoc>SetSelections(List selections)</autodoc> |
ce6878e6 RD |
14682 | <docstring>Specify the items in the list that should be selected, using a list of |
14683 | integers.</docstring> | |
f32fc4bc RD |
14684 | <paramlist> |
14685 | <param name="selections" type="wxArrayInt" default=""/> | |
14686 | </paramlist> | |
14687 | </method> | |
14688 | <method name="GetSelections" type="PyObject" overloaded="no"> | |
c2dda882 RD |
14689 | <autodoc>GetSelections() -> [selections]</autodoc> |
14690 | <docstring>Returns a list of integers representing the items that are selected.</docstring> | |
f32fc4bc RD |
14691 | </method> |
14692 | </class> | |
781d2982 | 14693 | <class name="SingleChoiceDialog" oldname="wxSingleChoiceDialog" module="_windows"> |
c2dda882 | 14694 | <docstring>A simple dialog with a single selection listbox.</docstring> |
f32fc4bc RD |
14695 | <baseclass name="Dialog"/> |
14696 | <constructor name="SingleChoiceDialog" overloaded="no"> | |
c2dda882 RD |
14697 | <autodoc>__init__(Window parent, String message, String caption, |
14698 | List choices=[], long style=CHOICEDLG_STYLE, | |
856bf319 | 14699 | Point pos=DefaultPosition) -> SingleChoiceDialog</autodoc> |
c2dda882 | 14700 | <docstring>Constructor. Use ShowModal method to show the dialog.</docstring> |
f32fc4bc RD |
14701 | <paramlist> |
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"/> | |
14709 | </paramlist> | |
14710 | </constructor> | |
14711 | <method name="GetSelection" type="int" overloaded="no"> | |
781d2982 | 14712 | <autodoc>GetSelection(self) -> int</autodoc> |
c2dda882 | 14713 | <docstring>Get the index of teh currently selected item.</docstring> |
f32fc4bc RD |
14714 | </method> |
14715 | <method name="GetStringSelection" type="String" overloaded="no"> | |
781d2982 | 14716 | <autodoc>GetStringSelection(self) -> String</autodoc> |
c2dda882 | 14717 | <docstring>Returns the string value of the currently selected item</docstring> |
f32fc4bc RD |
14718 | </method> |
14719 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 14720 | <autodoc>SetSelection(self, int sel)</autodoc> |
c2dda882 | 14721 | <docstring>Set the current selected item to sel</docstring> |
f32fc4bc RD |
14722 | <paramlist> |
14723 | <param name="sel" type="int" default=""/> | |
14724 | </paramlist> | |
14725 | </method> | |
f32fc4bc | 14726 | </class> |
781d2982 | 14727 | <class name="TextEntryDialog" oldname="wxTextEntryDialog" module="_windows"> |
c2dda882 | 14728 | <docstring>A dialog with text control, [ok] and [cancel] buttons</docstring> |
f32fc4bc RD |
14729 | <baseclass name="Dialog"/> |
14730 | <constructor name="TextEntryDialog" overloaded="no"> | |
781d2982 | 14731 | <autodoc>__init__(self, Window parent, String message, String caption=GetTextFromUserPromptStr, |
856bf319 RD |
14732 | String defaultValue=EmptyString, |
14733 | long style=wxOK|wxCANCEL|wxCENTRE, Point pos=DefaultPosition) -> TextEntryDialog</autodoc> | |
c2dda882 | 14734 | <docstring>Constructor. Use ShowModal method to show the dialog.</docstring> |
f32fc4bc RD |
14735 | <paramlist> |
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"/> | |
14742 | </paramlist> | |
14743 | </constructor> | |
14744 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 14745 | <autodoc>GetValue(self) -> String</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
14748 | </method> |
14749 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 14750 | <autodoc>SetValue(self, String value)</autodoc> |
c2dda882 | 14751 | <docstring>Sets the default text value.</docstring> |
f32fc4bc RD |
14752 | <paramlist> |
14753 | <param name="value" type="String" default=""/> | |
14754 | </paramlist> | |
14755 | </method> | |
f32fc4bc | 14756 | </class> |
781d2982 RD |
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> | |
f32fc4bc RD |
14760 | <baseclass name="Object"/> |
14761 | <constructor name="FontData" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14765 | </constructor> |
14766 | <destructor name="~wxFontData" overloaded="no"> | |
781d2982 | 14767 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
14768 | </destructor> |
14769 | <method name="EnableEffects" type="" overloaded="no"> | |
781d2982 RD |
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 | |
c2dda882 | 14773 | properties. The default value is true.</docstring> |
f32fc4bc RD |
14774 | <paramlist> |
14775 | <param name="enable" type="bool" default=""/> | |
14776 | </paramlist> | |
14777 | </method> | |
14778 | <method name="GetAllowSymbols" type="bool" overloaded="no"> | |
781d2982 RD |
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 | |
14782 | true.</docstring> | |
f32fc4bc RD |
14783 | </method> |
14784 | <method name="GetColour" type="Colour" overloaded="no"> | |
781d2982 RD |
14785 | <autodoc>GetColour(self) -> Colour</autodoc> |
14786 | <docstring>Gets the colour associated with the font dialog. The default value is | |
14787 | black.</docstring> | |
f32fc4bc RD |
14788 | </method> |
14789 | <method name="GetChosenFont" type="Font" overloaded="no"> | |
781d2982 | 14790 | <autodoc>GetChosenFont(self) -> Font</autodoc> |
c2dda882 | 14791 | <docstring>Gets the font chosen by the user.</docstring> |
f32fc4bc RD |
14792 | </method> |
14793 | <method name="GetEnableEffects" type="bool" overloaded="no"> | |
781d2982 | 14794 | <autodoc>GetEnableEffects(self) -> bool</autodoc> |
c2dda882 | 14795 | <docstring>Determines whether 'effects' are enabled under Windows.</docstring> |
f32fc4bc RD |
14796 | </method> |
14797 | <method name="GetInitialFont" type="Font" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14801 | </method> |
14802 | <method name="GetShowHelp" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14806 | </method> |
14807 | <method name="SetAllowSymbols" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14811 | <paramlist> |
14812 | <param name="allowSymbols" type="bool" default=""/> | |
14813 | </paramlist> | |
14814 | </method> | |
14815 | <method name="SetChosenFont" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14819 | <paramlist> |
14820 | <param name="font" type="Font" default=""/> | |
14821 | </paramlist> | |
14822 | </method> | |
14823 | <method name="SetColour" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14827 | <paramlist> |
14828 | <param name="colour" type="Colour" default=""/> | |
14829 | </paramlist> | |
14830 | </method> | |
14831 | <method name="SetInitialFont" type="" overloaded="no"> | |
781d2982 | 14832 | <autodoc>SetInitialFont(self, Font font)</autodoc> |
c2dda882 | 14833 | <docstring>Sets the font that will be initially used by the font dialog.</docstring> |
f32fc4bc RD |
14834 | <paramlist> |
14835 | <param name="font" type="Font" default=""/> | |
14836 | </paramlist> | |
14837 | </method> | |
14838 | <method name="SetRange" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14842 | <paramlist> |
14843 | <param name="min" type="int" default=""/> | |
14844 | <param name="max" type="int" default=""/> | |
14845 | </paramlist> | |
14846 | </method> | |
14847 | <method name="SetShowHelp" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14851 | <paramlist> |
14852 | <param name="showHelp" type="bool" default=""/> | |
14853 | </paramlist> | |
14854 | </method> | |
14855 | </class> | |
781d2982 RD |
14856 | <class name="FontDialog" oldname="wxFontDialog" module="_windows"> |
14857 | <docstring>wx.FontDialog allows the user to select a system font and its attributes. | |
14858 | ||
14859 | :see: `wx.FontData` | |
14860 | </docstring> | |
f32fc4bc RD |
14861 | <baseclass name="Dialog"/> |
14862 | <constructor name="FontDialog" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
14868 | <paramlist> |
14869 | <param name="parent" type="Window" default=""/> | |
14870 | <param name="data" type="FontData" default=""/> | |
14871 | </paramlist> | |
14872 | </constructor> | |
14873 | <method name="GetFontData" type="FontData" overloaded="no"> | |
781d2982 RD |
14874 | <autodoc>GetFontData(self) -> FontData</autodoc> |
14875 | <docstring>Returns a reference to the internal `wx.FontData` used by the | |
14876 | wx.FontDialog.</docstring> | |
f32fc4bc RD |
14877 | </method> |
14878 | </class> | |
781d2982 RD |
14879 | <class name="MessageDialog" oldname="wxMessageDialog" module="_windows"> |
14880 | <docstring>This class provides a simple dialog that shows a single or multi-line | |
ce6878e6 RD |
14881 | message, with a choice of OK, Yes, No and/or Cancel buttons. |
14882 | ||
14883 | Window Styles | |
14884 | -------------- | |
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 | |
14899 | (Windows only). | |
14900 | =================== ============================================= | |
14901 | </docstring> | |
f32fc4bc | 14902 | <baseclass name="Dialog"/> |
368d20e8 | 14903 | <constructor name="MessageDialog" overloaded="no"> |
781d2982 | 14904 | <autodoc>__init__(self, Window parent, String message, String caption=MessageBoxCaptionStr, |
368d20e8 RD |
14905 | long style=wxOK|wxCANCEL|wxCENTRE, |
14906 | Point pos=DefaultPosition) -> MessageDialog</autodoc> | |
781d2982 | 14907 | <docstring>Constructor, use `ShowModal` to display the dialog.</docstring> |
f32fc4bc RD |
14908 | <paramlist> |
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"/> | |
14914 | </paramlist> | |
14915 | </constructor> | |
f32fc4bc | 14916 | </class> |
781d2982 RD |
14917 | <class name="ProgressDialog" oldname="wxProgressDialog" module="_windows"> |
14918 | <docstring>A dialog that shows a short message and a progress bar. Optionally, it | |
ce6878e6 RD |
14919 | can display an ABORT button. |
14920 | ||
14921 | Window Styles | |
14922 | -------------- | |
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. | |
14928 | ||
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. | |
14932 | ||
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 | |
14936 | return false. | |
14937 | ||
14938 | wx.PD_ELAPSED_TIME This flag tells the dialog that it should show | |
14939 | elapsed time (since creating the dialog). | |
14940 | ||
14941 | wx.PD_ESTIMATED_TIME This flag tells the dialog that it should show | |
14942 | estimated time. | |
14943 | ||
14944 | wx.PD_REMAINING_TIME This flag tells the dialog that it should show | |
14945 | remaining time. | |
14946 | ==================== ============================================= | |
14947 | </docstring> | |
f32fc4bc RD |
14948 | <baseclass name="Frame"/> |
14949 | <constructor name="ProgressDialog" overloaded="no"> | |
781d2982 | 14950 | <autodoc>__init__(self, String title, String message, int maximum=100, Window parent=None, |
856bf319 | 14951 | int style=wxPD_AUTO_HIDE|wxPD_APP_MODAL) -> ProgressDialog</autodoc> |
781d2982 RD |
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> | |
f32fc4bc RD |
14955 | <paramlist> |
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"/> | |
14961 | </paramlist> | |
14962 | </constructor> | |
14963 | <method name="Update" type="bool" overloaded="no"> | |
781d2982 RD |
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 | |
ce6878e6 RD |
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. | |
c2dda882 | 14970 | |
781d2982 RD |
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> | |
f32fc4bc RD |
14974 | <paramlist> |
14975 | <param name="value" type="int" default=""/> | |
14976 | <param name="newmsg" type="String" default="wxPyEmptyString"/> | |
14977 | </paramlist> | |
14978 | </method> | |
14979 | <method name="Resume" type="" overloaded="no"> | |
781d2982 RD |
14980 | <autodoc>Resume(self)</autodoc> |
14981 | <docstring>Can be used to continue with the dialog, after the user had chosen to | |
14982 | abort.</docstring> | |
f32fc4bc RD |
14983 | </method> |
14984 | </class> | |
14985 | <pythoncode> | |
856bf319 RD |
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 ) | |
14991 | ||
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 | |
14998 | </pythoncode> | |
781d2982 | 14999 | <class name="FindDialogEvent" oldname="wxFindDialogEvent" module="_windows"> |
c2dda882 | 15000 | <docstring>Events for the FindReplaceDialog</docstring> |
f32fc4bc RD |
15001 | <baseclass name="CommandEvent"/> |
15002 | <constructor name="FindDialogEvent" overloaded="no"> | |
781d2982 | 15003 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> FindDialogEvent</autodoc> |
c2dda882 | 15004 | <docstring>Events for the FindReplaceDialog</docstring> |
f32fc4bc RD |
15005 | <paramlist> |
15006 | <param name="commandType" type="wxEventType" default="wxEVT_NULL"/> | |
15007 | <param name="id" type="int" default="0"/> | |
15008 | </paramlist> | |
15009 | </constructor> | |
15010 | <method name="GetFlags" type="int" overloaded="no"> | |
781d2982 | 15011 | <autodoc>GetFlags(self) -> int</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
15014 | </method> |
15015 | <method name="GetFindString" type="String" overloaded="no"> | |
781d2982 | 15016 | <autodoc>GetFindString(self) -> String</autodoc> |
c2dda882 | 15017 | <docstring>Return the string to find (never empty).</docstring> |
f32fc4bc RD |
15018 | </method> |
15019 | <method name="GetReplaceString" type="String" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
15023 | </method> |
15024 | <method name="GetDialog" type="wxFindReplaceDialog" overloaded="no"> | |
781d2982 | 15025 | <autodoc>GetDialog(self) -> FindReplaceDialog</autodoc> |
c2dda882 | 15026 | <docstring>Return the pointer to the dialog which generated this event.</docstring> |
f32fc4bc RD |
15027 | </method> |
15028 | <method name="SetFlags" type="" overloaded="no"> | |
781d2982 | 15029 | <autodoc>SetFlags(self, int flags)</autodoc> |
f32fc4bc RD |
15030 | <paramlist> |
15031 | <param name="flags" type="int" default=""/> | |
15032 | </paramlist> | |
15033 | </method> | |
15034 | <method name="SetFindString" type="" overloaded="no"> | |
781d2982 | 15035 | <autodoc>SetFindString(self, String str)</autodoc> |
f32fc4bc RD |
15036 | <paramlist> |
15037 | <param name="str" type="String" default=""/> | |
15038 | </paramlist> | |
15039 | </method> | |
15040 | <method name="SetReplaceString" type="" overloaded="no"> | |
781d2982 | 15041 | <autodoc>SetReplaceString(self, String str)</autodoc> |
f32fc4bc RD |
15042 | <paramlist> |
15043 | <param name="str" type="String" default=""/> | |
15044 | </paramlist> | |
15045 | </method> | |
15046 | </class> | |
781d2982 RD |
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. | |
c2dda882 | 15053 | |
781d2982 | 15054 | Note that all SetXXX() methods may only be called before showing the |
ce6878e6 RD |
15055 | dialog and calling them has no effect later. |
15056 | ||
15057 | Flags | |
15058 | ----- | |
15059 | ================ =============================================== | |
15060 | wx.FR_DOWN Downward search/replace selected (otherwise, | |
15061 | upwards) | |
15062 | ||
15063 | wx.FR_WHOLEWORD Whole word search/replace selected | |
15064 | ||
15065 | wx.FR_MATCHCASE Case sensitive search/replace selected | |
15066 | (otherwise, case insensitive) | |
15067 | ================ =============================================== | |
15068 | </docstring> | |
f32fc4bc RD |
15069 | <baseclass name="Object"/> |
15070 | <constructor name="FindReplaceData" overloaded="no"> | |
781d2982 | 15071 | <autodoc>__init__(self, int flags=0) -> FindReplaceData</autodoc> |
c2dda882 | 15072 | <docstring>Constuctor initializes the flags to default value (0).</docstring> |
f32fc4bc RD |
15073 | <paramlist> |
15074 | <param name="flags" type="int" default="0"/> | |
15075 | </paramlist> | |
15076 | </constructor> | |
15077 | <destructor name="~wxFindReplaceData" overloaded="no"> | |
781d2982 | 15078 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
15079 | </destructor> |
15080 | <method name="GetFindString" type="String" overloaded="no"> | |
781d2982 | 15081 | <autodoc>GetFindString(self) -> String</autodoc> |
c2dda882 | 15082 | <docstring>Get the string to find.</docstring> |
f32fc4bc RD |
15083 | </method> |
15084 | <method name="GetReplaceString" type="String" overloaded="no"> | |
781d2982 | 15085 | <autodoc>GetReplaceString(self) -> String</autodoc> |
c2dda882 | 15086 | <docstring>Get the replacement string.</docstring> |
f32fc4bc RD |
15087 | </method> |
15088 | <method name="GetFlags" type="int" overloaded="no"> | |
781d2982 | 15089 | <autodoc>GetFlags(self) -> int</autodoc> |
c2dda882 | 15090 | <docstring>Get the combination of flag values.</docstring> |
f32fc4bc RD |
15091 | </method> |
15092 | <method name="SetFlags" type="" overloaded="no"> | |
781d2982 | 15093 | <autodoc>SetFlags(self, int flags)</autodoc> |
c2dda882 | 15094 | <docstring>Set the flags to use to initialize the controls of the dialog.</docstring> |
f32fc4bc RD |
15095 | <paramlist> |
15096 | <param name="flags" type="int" default=""/> | |
15097 | </paramlist> | |
15098 | </method> | |
15099 | <method name="SetFindString" type="" overloaded="no"> | |
781d2982 | 15100 | <autodoc>SetFindString(self, String str)</autodoc> |
c2dda882 | 15101 | <docstring>Set the string to find (used as initial value by the dialog).</docstring> |
f32fc4bc RD |
15102 | <paramlist> |
15103 | <param name="str" type="String" default=""/> | |
15104 | </paramlist> | |
15105 | </method> | |
15106 | <method name="SetReplaceString" type="" overloaded="no"> | |
781d2982 | 15107 | <autodoc>SetReplaceString(self, String str)</autodoc> |
c2dda882 | 15108 | <docstring>Set the replacement string (used as initial value by the dialog).</docstring> |
f32fc4bc RD |
15109 | <paramlist> |
15110 | <param name="str" type="String" default=""/> | |
15111 | </paramlist> | |
15112 | </method> | |
15113 | </class> | |
781d2982 RD |
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 | |
ce6878e6 RD |
15121 | way; it is always, by design and implementation, modeless. |
15122 | ||
15123 | ||
15124 | Window Styles | |
15125 | ------------- | |
15126 | ||
15127 | ===================== ========================================= | |
15128 | wx.FR_REPLACEDIALOG replace dialog (otherwise find dialog) | |
15129 | ||
15130 | wx.FR_NOUPDOWN don't allow changing the search direction | |
15131 | ||
15132 | wx.FR_NOMATCHCASE don't allow case sensitive searching | |
15133 | ||
15134 | wx.FR_NOWHOLEWORD don't allow whole word searching | |
15135 | ===================== ========================================= | |
15136 | </docstring> | |
f32fc4bc RD |
15137 | <baseclass name="Dialog"/> |
15138 | <constructor name="FindReplaceDialog" overloaded="no"> | |
781d2982 | 15139 | <autodoc>__init__(self, Window parent, FindReplaceData data, String title, |
856bf319 | 15140 | int style=0) -> FindReplaceDialog</autodoc> |
c2dda882 RD |
15141 | <docstring>Create a FindReplaceDialog. The parent and data parameters must be |
15142 | non-None. Use Show to display the dialog.</docstring> | |
f32fc4bc RD |
15143 | <paramlist> |
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"/> | |
15148 | </paramlist> | |
15149 | </constructor> | |
15150 | <constructor name="PreFindReplaceDialog" overloaded="no"> | |
15151 | <autodoc>PreFindReplaceDialog() -> FindReplaceDialog</autodoc> | |
c2dda882 | 15152 | <docstring>Precreate a FindReplaceDialog for 2-phase creation</docstring> |
f32fc4bc RD |
15153 | </constructor> |
15154 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 15155 | <autodoc>Create(self, Window parent, FindReplaceData data, String title, |
856bf319 | 15156 | int style=0) -> bool</autodoc> |
c2dda882 | 15157 | <docstring>Create the dialog, for 2-phase create.</docstring> |
f32fc4bc RD |
15158 | <paramlist> |
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"/> | |
15163 | </paramlist> | |
15164 | </method> | |
15165 | <method name="GetData" type="FindReplaceData" overloaded="no"> | |
781d2982 | 15166 | <autodoc>GetData(self) -> FindReplaceData</autodoc> |
c2dda882 | 15167 | <docstring>Get the FindReplaceData object used by this dialog.</docstring> |
f32fc4bc RD |
15168 | </method> |
15169 | <method name="SetData" type="" overloaded="no"> | |
781d2982 | 15170 | <autodoc>SetData(self, FindReplaceData data)</autodoc> |
c2dda882 | 15171 | <docstring>Set the FindReplaceData object used by this dialog.</docstring> |
f32fc4bc RD |
15172 | <paramlist> |
15173 | <param name="data" type="FindReplaceData" default=""/> | |
15174 | </paramlist> | |
15175 | </method> | |
15176 | </class> | |
15177 | <pythoncode> | |
856bf319 RD |
15178 | #--------------------------------------------------------------------------- |
15179 | </pythoncode> | |
781d2982 | 15180 | <class name="MDIParentFrame" oldname="wxMDIParentFrame" module="_windows"> |
f32fc4bc RD |
15181 | <baseclass name="Frame"/> |
15182 | <constructor name="MDIParentFrame" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 15186 | String name=FrameNameStr) -> MDIParentFrame</autodoc> |
f32fc4bc RD |
15187 | <paramlist> |
15188 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
15189 | <param name="id" type="int" default="-1"/> |
15190 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
15195 | </paramlist> | |
15196 | </constructor> | |
15197 | <constructor name="PreMDIParentFrame" overloaded="no"> | |
15198 | <autodoc>PreMDIParentFrame() -> MDIParentFrame</autodoc> | |
15199 | </constructor> | |
15200 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 15204 | String name=FrameNameStr) -> bool</autodoc> |
f32fc4bc RD |
15205 | <paramlist> |
15206 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
15207 | <param name="id" type="int" default="-1"/> |
15208 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
15213 | </paramlist> | |
15214 | </method> | |
15215 | <method name="ActivateNext" type="" overloaded="no"> | |
781d2982 | 15216 | <autodoc>ActivateNext(self)</autodoc> |
f32fc4bc RD |
15217 | </method> |
15218 | <method name="ActivatePrevious" type="" overloaded="no"> | |
781d2982 | 15219 | <autodoc>ActivatePrevious(self)</autodoc> |
f32fc4bc RD |
15220 | </method> |
15221 | <method name="ArrangeIcons" type="" overloaded="no"> | |
781d2982 | 15222 | <autodoc>ArrangeIcons(self)</autodoc> |
f32fc4bc RD |
15223 | </method> |
15224 | <method name="Cascade" type="" overloaded="no"> | |
781d2982 | 15225 | <autodoc>Cascade(self)</autodoc> |
f32fc4bc RD |
15226 | </method> |
15227 | <method name="GetActiveChild" type="wxMDIChildFrame" overloaded="no"> | |
781d2982 | 15228 | <autodoc>GetActiveChild(self) -> MDIChildFrame</autodoc> |
f32fc4bc RD |
15229 | </method> |
15230 | <method name="GetClientWindow" type="wxMDIClientWindow" overloaded="no"> | |
781d2982 | 15231 | <autodoc>GetClientWindow(self) -> MDIClientWindow</autodoc> |
f32fc4bc RD |
15232 | </method> |
15233 | <method name="GetToolBar" type="Window" overloaded="no"> | |
781d2982 | 15234 | <autodoc>GetToolBar(self) -> Window</autodoc> |
f32fc4bc RD |
15235 | </method> |
15236 | <method name="Tile" type="" overloaded="no"> | |
781d2982 | 15237 | <autodoc>Tile(self)</autodoc> |
f32fc4bc RD |
15238 | </method> |
15239 | </class> | |
781d2982 | 15240 | <class name="MDIChildFrame" oldname="wxMDIChildFrame" module="_windows"> |
f32fc4bc RD |
15241 | <baseclass name="Frame"/> |
15242 | <constructor name="MDIChildFrame" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 15246 | String name=FrameNameStr) -> MDIChildFrame</autodoc> |
f32fc4bc RD |
15247 | <paramlist> |
15248 | <param name="parent" type="MDIParentFrame" default=""/> | |
781d2982 RD |
15249 | <param name="id" type="int" default="-1"/> |
15250 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
15255 | </paramlist> | |
15256 | </constructor> | |
15257 | <constructor name="PreMDIChildFrame" overloaded="no"> | |
15258 | <autodoc>PreMDIChildFrame() -> MDIChildFrame</autodoc> | |
15259 | </constructor> | |
15260 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 15264 | String name=FrameNameStr) -> bool</autodoc> |
f32fc4bc RD |
15265 | <paramlist> |
15266 | <param name="parent" type="MDIParentFrame" default=""/> | |
781d2982 RD |
15267 | <param name="id" type="int" default="-1"/> |
15268 | <param name="title" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
15273 | </paramlist> | |
15274 | </method> | |
15275 | <method name="Activate" type="" overloaded="no"> | |
781d2982 | 15276 | <autodoc>Activate(self)</autodoc> |
f32fc4bc RD |
15277 | </method> |
15278 | <method name="Maximize" type="" overloaded="no"> | |
781d2982 | 15279 | <autodoc>Maximize(self, bool maximize)</autodoc> |
f32fc4bc RD |
15280 | <paramlist> |
15281 | <param name="maximize" type="bool" default=""/> | |
15282 | </paramlist> | |
15283 | </method> | |
15284 | <method name="Restore" type="" overloaded="no"> | |
781d2982 | 15285 | <autodoc>Restore(self)</autodoc> |
f32fc4bc RD |
15286 | </method> |
15287 | </class> | |
781d2982 | 15288 | <class name="MDIClientWindow" oldname="wxMDIClientWindow" module="_windows"> |
f32fc4bc RD |
15289 | <baseclass name="Window"/> |
15290 | <constructor name="MDIClientWindow" overloaded="no"> | |
781d2982 | 15291 | <autodoc>__init__(self, MDIParentFrame parent, long style=0) -> MDIClientWindow</autodoc> |
f32fc4bc RD |
15292 | <paramlist> |
15293 | <param name="parent" type="MDIParentFrame" default=""/> | |
15294 | <param name="style" type="long" default="0"/> | |
15295 | </paramlist> | |
15296 | </constructor> | |
15297 | <constructor name="PreMDIClientWindow" overloaded="no"> | |
15298 | <autodoc>PreMDIClientWindow() -> MDIClientWindow</autodoc> | |
15299 | </constructor> | |
15300 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 15301 | <autodoc>Create(self, MDIParentFrame parent, long style=0) -> bool</autodoc> |
f32fc4bc RD |
15302 | <paramlist> |
15303 | <param name="parent" type="MDIParentFrame" default=""/> | |
15304 | <param name="style" type="long" default="0"/> | |
15305 | </paramlist> | |
15306 | </method> | |
15307 | </class> | |
15308 | <pythoncode> | |
856bf319 RD |
15309 | #--------------------------------------------------------------------------- |
15310 | </pythoncode> | |
781d2982 | 15311 | <class name="PyWindow" oldname="wxPyWindow" module="_windows"> |
f32fc4bc RD |
15312 | <baseclass name="Window"/> |
15313 | <constructor name="PyWindow" overloaded="no"> | |
781d2982 RD |
15314 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
15315 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyWindow</autodoc> | |
f32fc4bc RD |
15316 | <paramlist> |
15317 | <param name="parent" type="Window" default=""/> | |
781d2982 | 15318 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
15323 | </paramlist> | |
15324 | </constructor> | |
781d2982 RD |
15325 | <constructor name="PrePyWindow" overloaded="no"> |
15326 | <autodoc>PrePyWindow() -> PyWindow</autodoc> | |
15327 | </constructor> | |
f32fc4bc | 15328 | <method name="_setCallbackInfo" type="" overloaded="no"> |
781d2982 | 15329 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
15330 | <paramlist> |
15331 | <param name="self" type="PyObject" default=""/> | |
15332 | <param name="_class" type="PyObject" default=""/> | |
15333 | </paramlist> | |
15334 | </method> | |
781d2982 RD |
15335 | <method name="SetBestSize" type="" overloaded="no"> |
15336 | <autodoc>SetBestSize(self, Size size)</autodoc> | |
15337 | <paramlist> | |
15338 | <param name="size" type="Size" default=""/> | |
15339 | </paramlist> | |
15340 | </method> | |
f32fc4bc | 15341 | <method name="base_DoMoveWindow" type="" overloaded="no"> |
781d2982 | 15342 | <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc> |
f32fc4bc RD |
15343 | <paramlist> |
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=""/> | |
15348 | </paramlist> | |
15349 | </method> | |
15350 | <method name="base_DoSetSize" type="" overloaded="no"> | |
781d2982 | 15351 | <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc> |
f32fc4bc RD |
15352 | <paramlist> |
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"/> | |
15358 | </paramlist> | |
15359 | </method> | |
15360 | <method name="base_DoSetClientSize" type="" overloaded="no"> | |
781d2982 | 15361 | <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc> |
f32fc4bc RD |
15362 | <paramlist> |
15363 | <param name="width" type="int" default=""/> | |
15364 | <param name="height" type="int" default=""/> | |
15365 | </paramlist> | |
15366 | </method> | |
15367 | <method name="base_DoSetVirtualSize" type="" overloaded="no"> | |
781d2982 | 15368 | <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc> |
f32fc4bc RD |
15369 | <paramlist> |
15370 | <param name="x" type="int" default=""/> | |
15371 | <param name="y" type="int" default=""/> | |
15372 | </paramlist> | |
15373 | </method> | |
15374 | <method name="base_DoGetSize" type="" overloaded="no"> | |
15375 | <autodoc>base_DoGetSize() -> (width, height)</autodoc> | |
15376 | <paramlist> | |
15377 | <param name="OUTPUT" type="int" default=""/> | |
15378 | <param name="OUTPUT" type="int" default=""/> | |
15379 | </paramlist> | |
15380 | </method> | |
15381 | <method name="base_DoGetClientSize" type="" overloaded="no"> | |
15382 | <autodoc>base_DoGetClientSize() -> (width, height)</autodoc> | |
15383 | <paramlist> | |
15384 | <param name="OUTPUT" type="int" default=""/> | |
15385 | <param name="OUTPUT" type="int" default=""/> | |
15386 | </paramlist> | |
15387 | </method> | |
15388 | <method name="base_DoGetPosition" type="" overloaded="no"> | |
15389 | <autodoc>base_DoGetPosition() -> (x,y)</autodoc> | |
15390 | <paramlist> | |
15391 | <param name="OUTPUT" type="int" default=""/> | |
15392 | <param name="OUTPUT" type="int" default=""/> | |
15393 | </paramlist> | |
15394 | </method> | |
15395 | <method name="base_DoGetVirtualSize" type="Size" overloaded="no"> | |
781d2982 | 15396 | <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc> |
f32fc4bc RD |
15397 | </method> |
15398 | <method name="base_DoGetBestSize" type="Size" overloaded="no"> | |
781d2982 | 15399 | <autodoc>base_DoGetBestSize(self) -> Size</autodoc> |
f32fc4bc RD |
15400 | </method> |
15401 | <method name="base_InitDialog" type="" overloaded="no"> | |
781d2982 | 15402 | <autodoc>base_InitDialog(self)</autodoc> |
f32fc4bc RD |
15403 | </method> |
15404 | <method name="base_TransferDataToWindow" type="bool" overloaded="no"> | |
781d2982 | 15405 | <autodoc>base_TransferDataToWindow(self) -> bool</autodoc> |
f32fc4bc RD |
15406 | </method> |
15407 | <method name="base_TransferDataFromWindow" type="bool" overloaded="no"> | |
781d2982 | 15408 | <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc> |
f32fc4bc RD |
15409 | </method> |
15410 | <method name="base_Validate" type="bool" overloaded="no"> | |
781d2982 | 15411 | <autodoc>base_Validate(self) -> bool</autodoc> |
f32fc4bc RD |
15412 | </method> |
15413 | <method name="base_AcceptsFocus" type="bool" overloaded="no"> | |
781d2982 | 15414 | <autodoc>base_AcceptsFocus(self) -> bool</autodoc> |
f32fc4bc RD |
15415 | </method> |
15416 | <method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no"> | |
781d2982 | 15417 | <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc> |
f32fc4bc RD |
15418 | </method> |
15419 | <method name="base_GetMaxSize" type="Size" overloaded="no"> | |
781d2982 | 15420 | <autodoc>base_GetMaxSize(self) -> Size</autodoc> |
f32fc4bc RD |
15421 | </method> |
15422 | <method name="base_AddChild" type="" overloaded="no"> | |
781d2982 | 15423 | <autodoc>base_AddChild(self, Window child)</autodoc> |
f32fc4bc RD |
15424 | <paramlist> |
15425 | <param name="child" type="Window" default=""/> | |
15426 | </paramlist> | |
15427 | </method> | |
15428 | <method name="base_RemoveChild" type="" overloaded="no"> | |
781d2982 | 15429 | <autodoc>base_RemoveChild(self, Window child)</autodoc> |
f32fc4bc RD |
15430 | <paramlist> |
15431 | <param name="child" type="Window" default=""/> | |
15432 | </paramlist> | |
15433 | </method> | |
781d2982 RD |
15434 | <method name="base_ShouldInheritColours" type="bool" overloaded="no"> |
15435 | <autodoc>base_ShouldInheritColours(self) -> bool</autodoc> | |
15436 | </method> | |
15437 | <method name="base_ApplyParentThemeBackground" type="" overloaded="no"> | |
15438 | <autodoc>base_ApplyParentThemeBackground(self, Colour c)</autodoc> | |
15439 | <paramlist> | |
15440 | <param name="c" type="Colour" default=""/> | |
15441 | </paramlist> | |
15442 | </method> | |
15443 | <method name="base_GetDefaultAttributes" type="VisualAttributes" overloaded="no"> | |
15444 | <autodoc>base_GetDefaultAttributes(self) -> VisualAttributes</autodoc> | |
15445 | </method> | |
f32fc4bc | 15446 | </class> |
781d2982 | 15447 | <class name="PyPanel" oldname="wxPyPanel" module="_windows"> |
f32fc4bc RD |
15448 | <baseclass name="Panel"/> |
15449 | <constructor name="PyPanel" overloaded="no"> | |
781d2982 RD |
15450 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
15451 | Size size=DefaultSize, long style=0, String name=PanelNameStr) -> PyPanel</autodoc> | |
f32fc4bc RD |
15452 | <paramlist> |
15453 | <param name="parent" type="Window" default=""/> | |
781d2982 | 15454 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
15459 | </paramlist> | |
15460 | </constructor> | |
781d2982 RD |
15461 | <constructor name="PrePyPanel" overloaded="no"> |
15462 | <autodoc>PrePyPanel() -> PyPanel</autodoc> | |
15463 | </constructor> | |
f32fc4bc | 15464 | <method name="_setCallbackInfo" type="" overloaded="no"> |
781d2982 | 15465 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
15466 | <paramlist> |
15467 | <param name="self" type="PyObject" default=""/> | |
15468 | <param name="_class" type="PyObject" default=""/> | |
15469 | </paramlist> | |
15470 | </method> | |
781d2982 RD |
15471 | <method name="SetBestSize" type="" overloaded="no"> |
15472 | <autodoc>SetBestSize(self, Size size)</autodoc> | |
15473 | <paramlist> | |
15474 | <param name="size" type="Size" default=""/> | |
15475 | </paramlist> | |
15476 | </method> | |
f32fc4bc | 15477 | <method name="base_DoMoveWindow" type="" overloaded="no"> |
781d2982 | 15478 | <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc> |
f32fc4bc RD |
15479 | <paramlist> |
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=""/> | |
15484 | </paramlist> | |
15485 | </method> | |
15486 | <method name="base_DoSetSize" type="" overloaded="no"> | |
781d2982 | 15487 | <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc> |
f32fc4bc RD |
15488 | <paramlist> |
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"/> | |
15494 | </paramlist> | |
15495 | </method> | |
15496 | <method name="base_DoSetClientSize" type="" overloaded="no"> | |
781d2982 | 15497 | <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc> |
f32fc4bc RD |
15498 | <paramlist> |
15499 | <param name="width" type="int" default=""/> | |
15500 | <param name="height" type="int" default=""/> | |
15501 | </paramlist> | |
15502 | </method> | |
15503 | <method name="base_DoSetVirtualSize" type="" overloaded="no"> | |
781d2982 | 15504 | <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc> |
f32fc4bc RD |
15505 | <paramlist> |
15506 | <param name="x" type="int" default=""/> | |
15507 | <param name="y" type="int" default=""/> | |
15508 | </paramlist> | |
15509 | </method> | |
15510 | <method name="base_DoGetSize" type="" overloaded="no"> | |
15511 | <autodoc>base_DoGetSize() -> (width, height)</autodoc> | |
15512 | <paramlist> | |
15513 | <param name="OUTPUT" type="int" default=""/> | |
15514 | <param name="OUTPUT" type="int" default=""/> | |
15515 | </paramlist> | |
15516 | </method> | |
15517 | <method name="base_DoGetClientSize" type="" overloaded="no"> | |
15518 | <autodoc>base_DoGetClientSize() -> (width, height)</autodoc> | |
15519 | <paramlist> | |
15520 | <param name="OUTPUT" type="int" default=""/> | |
15521 | <param name="OUTPUT" type="int" default=""/> | |
15522 | </paramlist> | |
15523 | </method> | |
15524 | <method name="base_DoGetPosition" type="" overloaded="no"> | |
15525 | <autodoc>base_DoGetPosition() -> (x,y)</autodoc> | |
15526 | <paramlist> | |
15527 | <param name="OUTPUT" type="int" default=""/> | |
15528 | <param name="OUTPUT" type="int" default=""/> | |
15529 | </paramlist> | |
15530 | </method> | |
15531 | <method name="base_DoGetVirtualSize" type="Size" overloaded="no"> | |
781d2982 | 15532 | <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc> |
f32fc4bc RD |
15533 | </method> |
15534 | <method name="base_DoGetBestSize" type="Size" overloaded="no"> | |
781d2982 | 15535 | <autodoc>base_DoGetBestSize(self) -> Size</autodoc> |
f32fc4bc RD |
15536 | </method> |
15537 | <method name="base_InitDialog" type="" overloaded="no"> | |
781d2982 | 15538 | <autodoc>base_InitDialog(self)</autodoc> |
f32fc4bc RD |
15539 | </method> |
15540 | <method name="base_TransferDataToWindow" type="bool" overloaded="no"> | |
781d2982 | 15541 | <autodoc>base_TransferDataToWindow(self) -> bool</autodoc> |
f32fc4bc RD |
15542 | </method> |
15543 | <method name="base_TransferDataFromWindow" type="bool" overloaded="no"> | |
781d2982 | 15544 | <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc> |
f32fc4bc RD |
15545 | </method> |
15546 | <method name="base_Validate" type="bool" overloaded="no"> | |
781d2982 | 15547 | <autodoc>base_Validate(self) -> bool</autodoc> |
f32fc4bc RD |
15548 | </method> |
15549 | <method name="base_AcceptsFocus" type="bool" overloaded="no"> | |
781d2982 | 15550 | <autodoc>base_AcceptsFocus(self) -> bool</autodoc> |
f32fc4bc RD |
15551 | </method> |
15552 | <method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no"> | |
781d2982 | 15553 | <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc> |
f32fc4bc RD |
15554 | </method> |
15555 | <method name="base_GetMaxSize" type="Size" overloaded="no"> | |
781d2982 | 15556 | <autodoc>base_GetMaxSize(self) -> Size</autodoc> |
f32fc4bc RD |
15557 | </method> |
15558 | <method name="base_AddChild" type="" overloaded="no"> | |
781d2982 | 15559 | <autodoc>base_AddChild(self, Window child)</autodoc> |
f32fc4bc RD |
15560 | <paramlist> |
15561 | <param name="child" type="Window" default=""/> | |
15562 | </paramlist> | |
15563 | </method> | |
15564 | <method name="base_RemoveChild" type="" overloaded="no"> | |
781d2982 | 15565 | <autodoc>base_RemoveChild(self, Window child)</autodoc> |
f32fc4bc RD |
15566 | <paramlist> |
15567 | <param name="child" type="Window" default=""/> | |
15568 | </paramlist> | |
15569 | </method> | |
781d2982 RD |
15570 | <method name="base_ShouldInheritColours" type="bool" overloaded="no"> |
15571 | <autodoc>base_ShouldInheritColours(self) -> bool</autodoc> | |
15572 | </method> | |
15573 | <method name="base_ApplyParentThemeBackground" type="" overloaded="no"> | |
15574 | <autodoc>base_ApplyParentThemeBackground(self, Colour c)</autodoc> | |
15575 | <paramlist> | |
15576 | <param name="c" type="Colour" default=""/> | |
15577 | </paramlist> | |
15578 | </method> | |
15579 | <method name="base_GetDefaultAttributes" type="VisualAttributes" overloaded="no"> | |
15580 | <autodoc>base_GetDefaultAttributes(self) -> VisualAttributes</autodoc> | |
15581 | </method> | |
15582 | </class> | |
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> | |
15588 | <paramlist> | |
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"/> | |
15595 | </paramlist> | |
15596 | </constructor> | |
15597 | <constructor name="PrePyScrolledWindow" overloaded="no"> | |
15598 | <autodoc>PrePyScrolledWindow() -> PyScrolledWindow</autodoc> | |
15599 | </constructor> | |
15600 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
15601 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> | |
15602 | <paramlist> | |
15603 | <param name="self" type="PyObject" default=""/> | |
15604 | <param name="_class" type="PyObject" default=""/> | |
15605 | </paramlist> | |
15606 | </method> | |
15607 | <method name="SetBestSize" type="" overloaded="no"> | |
15608 | <autodoc>SetBestSize(self, Size size)</autodoc> | |
15609 | <paramlist> | |
15610 | <param name="size" type="Size" default=""/> | |
15611 | </paramlist> | |
15612 | </method> | |
15613 | <method name="base_DoMoveWindow" type="" overloaded="no"> | |
15614 | <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc> | |
15615 | <paramlist> | |
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=""/> | |
15620 | </paramlist> | |
15621 | </method> | |
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> | |
15624 | <paramlist> | |
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"/> | |
15630 | </paramlist> | |
15631 | </method> | |
15632 | <method name="base_DoSetClientSize" type="" overloaded="no"> | |
15633 | <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc> | |
15634 | <paramlist> | |
15635 | <param name="width" type="int" default=""/> | |
15636 | <param name="height" type="int" default=""/> | |
15637 | </paramlist> | |
15638 | </method> | |
15639 | <method name="base_DoSetVirtualSize" type="" overloaded="no"> | |
15640 | <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc> | |
15641 | <paramlist> | |
15642 | <param name="x" type="int" default=""/> | |
15643 | <param name="y" type="int" default=""/> | |
15644 | </paramlist> | |
15645 | </method> | |
15646 | <method name="base_DoGetSize" type="" overloaded="no"> | |
15647 | <autodoc>base_DoGetSize() -> (width, height)</autodoc> | |
15648 | <paramlist> | |
15649 | <param name="OUTPUT" type="int" default=""/> | |
15650 | <param name="OUTPUT" type="int" default=""/> | |
15651 | </paramlist> | |
15652 | </method> | |
15653 | <method name="base_DoGetClientSize" type="" overloaded="no"> | |
15654 | <autodoc>base_DoGetClientSize() -> (width, height)</autodoc> | |
15655 | <paramlist> | |
15656 | <param name="OUTPUT" type="int" default=""/> | |
15657 | <param name="OUTPUT" type="int" default=""/> | |
15658 | </paramlist> | |
15659 | </method> | |
15660 | <method name="base_DoGetPosition" type="" overloaded="no"> | |
15661 | <autodoc>base_DoGetPosition() -> (x,y)</autodoc> | |
15662 | <paramlist> | |
15663 | <param name="OUTPUT" type="int" default=""/> | |
15664 | <param name="OUTPUT" type="int" default=""/> | |
15665 | </paramlist> | |
15666 | </method> | |
15667 | <method name="base_DoGetVirtualSize" type="Size" overloaded="no"> | |
15668 | <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc> | |
15669 | </method> | |
15670 | <method name="base_DoGetBestSize" type="Size" overloaded="no"> | |
15671 | <autodoc>base_DoGetBestSize(self) -> Size</autodoc> | |
15672 | </method> | |
15673 | <method name="base_InitDialog" type="" overloaded="no"> | |
15674 | <autodoc>base_InitDialog(self)</autodoc> | |
15675 | </method> | |
15676 | <method name="base_TransferDataToWindow" type="bool" overloaded="no"> | |
15677 | <autodoc>base_TransferDataToWindow(self) -> bool</autodoc> | |
15678 | </method> | |
15679 | <method name="base_TransferDataFromWindow" type="bool" overloaded="no"> | |
15680 | <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc> | |
15681 | </method> | |
15682 | <method name="base_Validate" type="bool" overloaded="no"> | |
15683 | <autodoc>base_Validate(self) -> bool</autodoc> | |
15684 | </method> | |
15685 | <method name="base_AcceptsFocus" type="bool" overloaded="no"> | |
15686 | <autodoc>base_AcceptsFocus(self) -> bool</autodoc> | |
15687 | </method> | |
15688 | <method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no"> | |
15689 | <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc> | |
15690 | </method> | |
15691 | <method name="base_GetMaxSize" type="Size" overloaded="no"> | |
15692 | <autodoc>base_GetMaxSize(self) -> Size</autodoc> | |
15693 | </method> | |
15694 | <method name="base_AddChild" type="" overloaded="no"> | |
15695 | <autodoc>base_AddChild(self, Window child)</autodoc> | |
15696 | <paramlist> | |
15697 | <param name="child" type="Window" default=""/> | |
15698 | </paramlist> | |
15699 | </method> | |
15700 | <method name="base_RemoveChild" type="" overloaded="no"> | |
15701 | <autodoc>base_RemoveChild(self, Window child)</autodoc> | |
15702 | <paramlist> | |
15703 | <param name="child" type="Window" default=""/> | |
15704 | </paramlist> | |
15705 | </method> | |
15706 | <method name="base_ShouldInheritColours" type="bool" overloaded="no"> | |
15707 | <autodoc>base_ShouldInheritColours(self) -> bool</autodoc> | |
15708 | </method> | |
15709 | <method name="base_ApplyParentThemeBackground" type="" overloaded="no"> | |
15710 | <autodoc>base_ApplyParentThemeBackground(self, Colour c)</autodoc> | |
15711 | <paramlist> | |
15712 | <param name="c" type="Colour" default=""/> | |
15713 | </paramlist> | |
15714 | </method> | |
15715 | <method name="base_GetDefaultAttributes" type="VisualAttributes" overloaded="no"> | |
15716 | <autodoc>base_GetDefaultAttributes(self) -> VisualAttributes</autodoc> | |
15717 | </method> | |
f32fc4bc RD |
15718 | </class> |
15719 | <pythoncode> | |
856bf319 RD |
15720 | #--------------------------------------------------------------------------- |
15721 | </pythoncode> | |
781d2982 | 15722 | <class name="PrintData" oldname="wxPrintData" module="_windows"> |
f32fc4bc | 15723 | <baseclass name="Object"/> |
781d2982 RD |
15724 | <constructor name="PrintData" overloaded="yes"/> |
15725 | <constructor name="PrintData" overloaded="yes"> | |
15726 | <autodoc>__init__(self) -> PrintData | |
15727 | __init__(self, PrintData data) -> PrintData</autodoc> | |
15728 | <paramlist> | |
15729 | <param name="data" type="PrintData" default=""/> | |
15730 | </paramlist> | |
f32fc4bc RD |
15731 | </constructor> |
15732 | <destructor name="~wxPrintData" overloaded="no"> | |
781d2982 | 15733 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
15734 | </destructor> |
15735 | <method name="GetNoCopies" type="int" overloaded="no"> | |
781d2982 | 15736 | <autodoc>GetNoCopies(self) -> int</autodoc> |
f32fc4bc RD |
15737 | </method> |
15738 | <method name="GetCollate" type="bool" overloaded="no"> | |
781d2982 | 15739 | <autodoc>GetCollate(self) -> bool</autodoc> |
f32fc4bc RD |
15740 | </method> |
15741 | <method name="GetOrientation" type="int" overloaded="no"> | |
781d2982 | 15742 | <autodoc>GetOrientation(self) -> int</autodoc> |
f32fc4bc RD |
15743 | </method> |
15744 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 15745 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
15746 | </method> |
15747 | <method name="GetPrinterName" type="String" overloaded="no"> | |
781d2982 | 15748 | <autodoc>GetPrinterName(self) -> String</autodoc> |
f32fc4bc RD |
15749 | </method> |
15750 | <method name="GetColour" type="bool" overloaded="no"> | |
781d2982 | 15751 | <autodoc>GetColour(self) -> bool</autodoc> |
f32fc4bc RD |
15752 | </method> |
15753 | <method name="GetDuplex" type="wxDuplexMode" overloaded="no"> | |
781d2982 | 15754 | <autodoc>GetDuplex(self) -> int</autodoc> |
f32fc4bc RD |
15755 | </method> |
15756 | <method name="GetPaperId" type="wxPaperSize" overloaded="no"> | |
781d2982 | 15757 | <autodoc>GetPaperId(self) -> int</autodoc> |
f32fc4bc RD |
15758 | </method> |
15759 | <method name="GetPaperSize" type="Size" overloaded="no"> | |
781d2982 | 15760 | <autodoc>GetPaperSize(self) -> Size</autodoc> |
f32fc4bc RD |
15761 | </method> |
15762 | <method name="GetQuality" type="int" overloaded="no"> | |
781d2982 | 15763 | <autodoc>GetQuality(self) -> int</autodoc> |
f32fc4bc RD |
15764 | </method> |
15765 | <method name="SetNoCopies" type="" overloaded="no"> | |
781d2982 | 15766 | <autodoc>SetNoCopies(self, int v)</autodoc> |
f32fc4bc RD |
15767 | <paramlist> |
15768 | <param name="v" type="int" default=""/> | |
15769 | </paramlist> | |
15770 | </method> | |
15771 | <method name="SetCollate" type="" overloaded="no"> | |
781d2982 | 15772 | <autodoc>SetCollate(self, bool flag)</autodoc> |
f32fc4bc RD |
15773 | <paramlist> |
15774 | <param name="flag" type="bool" default=""/> | |
15775 | </paramlist> | |
15776 | </method> | |
15777 | <method name="SetOrientation" type="" overloaded="no"> | |
781d2982 | 15778 | <autodoc>SetOrientation(self, int orient)</autodoc> |
f32fc4bc RD |
15779 | <paramlist> |
15780 | <param name="orient" type="int" default=""/> | |
15781 | </paramlist> | |
15782 | </method> | |
15783 | <method name="SetPrinterName" type="" overloaded="no"> | |
781d2982 | 15784 | <autodoc>SetPrinterName(self, String name)</autodoc> |
f32fc4bc RD |
15785 | <paramlist> |
15786 | <param name="name" type="String" default=""/> | |
15787 | </paramlist> | |
15788 | </method> | |
15789 | <method name="SetColour" type="" overloaded="no"> | |
781d2982 | 15790 | <autodoc>SetColour(self, bool colour)</autodoc> |
f32fc4bc RD |
15791 | <paramlist> |
15792 | <param name="colour" type="bool" default=""/> | |
15793 | </paramlist> | |
15794 | </method> | |
15795 | <method name="SetDuplex" type="" overloaded="no"> | |
781d2982 | 15796 | <autodoc>SetDuplex(self, int duplex)</autodoc> |
f32fc4bc RD |
15797 | <paramlist> |
15798 | <param name="duplex" type="wxDuplexMode" default=""/> | |
15799 | </paramlist> | |
15800 | </method> | |
15801 | <method name="SetPaperId" type="" overloaded="no"> | |
781d2982 | 15802 | <autodoc>SetPaperId(self, int sizeId)</autodoc> |
f32fc4bc RD |
15803 | <paramlist> |
15804 | <param name="sizeId" type="wxPaperSize" default=""/> | |
15805 | </paramlist> | |
15806 | </method> | |
15807 | <method name="SetPaperSize" type="" overloaded="no"> | |
781d2982 | 15808 | <autodoc>SetPaperSize(self, Size sz)</autodoc> |
f32fc4bc RD |
15809 | <paramlist> |
15810 | <param name="sz" type="Size" default=""/> | |
15811 | </paramlist> | |
15812 | </method> | |
15813 | <method name="SetQuality" type="" overloaded="no"> | |
781d2982 | 15814 | <autodoc>SetQuality(self, int quality)</autodoc> |
f32fc4bc RD |
15815 | <paramlist> |
15816 | <param name="quality" type="int" default=""/> | |
15817 | </paramlist> | |
15818 | </method> | |
15819 | <method name="GetPrinterCommand" type="String" overloaded="no"> | |
781d2982 | 15820 | <autodoc>GetPrinterCommand(self) -> String</autodoc> |
f32fc4bc RD |
15821 | </method> |
15822 | <method name="GetPrinterOptions" type="String" overloaded="no"> | |
781d2982 | 15823 | <autodoc>GetPrinterOptions(self) -> String</autodoc> |
f32fc4bc RD |
15824 | </method> |
15825 | <method name="GetPreviewCommand" type="String" overloaded="no"> | |
781d2982 | 15826 | <autodoc>GetPreviewCommand(self) -> String</autodoc> |
f32fc4bc RD |
15827 | </method> |
15828 | <method name="GetFilename" type="String" overloaded="no"> | |
781d2982 | 15829 | <autodoc>GetFilename(self) -> String</autodoc> |
f32fc4bc RD |
15830 | </method> |
15831 | <method name="GetFontMetricPath" type="String" overloaded="no"> | |
781d2982 | 15832 | <autodoc>GetFontMetricPath(self) -> String</autodoc> |
f32fc4bc RD |
15833 | </method> |
15834 | <method name="GetPrinterScaleX" type="double" overloaded="no"> | |
781d2982 | 15835 | <autodoc>GetPrinterScaleX(self) -> double</autodoc> |
f32fc4bc RD |
15836 | </method> |
15837 | <method name="GetPrinterScaleY" type="double" overloaded="no"> | |
781d2982 | 15838 | <autodoc>GetPrinterScaleY(self) -> double</autodoc> |
f32fc4bc RD |
15839 | </method> |
15840 | <method name="GetPrinterTranslateX" type="long" overloaded="no"> | |
781d2982 | 15841 | <autodoc>GetPrinterTranslateX(self) -> long</autodoc> |
f32fc4bc RD |
15842 | </method> |
15843 | <method name="GetPrinterTranslateY" type="long" overloaded="no"> | |
781d2982 | 15844 | <autodoc>GetPrinterTranslateY(self) -> long</autodoc> |
f32fc4bc RD |
15845 | </method> |
15846 | <method name="GetPrintMode" type="wxPrintMode" overloaded="no"> | |
781d2982 | 15847 | <autodoc>GetPrintMode(self) -> int</autodoc> |
f32fc4bc RD |
15848 | </method> |
15849 | <method name="SetPrinterCommand" type="" overloaded="no"> | |
781d2982 | 15850 | <autodoc>SetPrinterCommand(self, String command)</autodoc> |
f32fc4bc RD |
15851 | <paramlist> |
15852 | <param name="command" type="String" default=""/> | |
15853 | </paramlist> | |
15854 | </method> | |
15855 | <method name="SetPrinterOptions" type="" overloaded="no"> | |
781d2982 | 15856 | <autodoc>SetPrinterOptions(self, String options)</autodoc> |
f32fc4bc RD |
15857 | <paramlist> |
15858 | <param name="options" type="String" default=""/> | |
15859 | </paramlist> | |
15860 | </method> | |
15861 | <method name="SetPreviewCommand" type="" overloaded="no"> | |
781d2982 | 15862 | <autodoc>SetPreviewCommand(self, String command)</autodoc> |
f32fc4bc RD |
15863 | <paramlist> |
15864 | <param name="command" type="String" default=""/> | |
15865 | </paramlist> | |
15866 | </method> | |
15867 | <method name="SetFilename" type="" overloaded="no"> | |
781d2982 | 15868 | <autodoc>SetFilename(self, String filename)</autodoc> |
f32fc4bc RD |
15869 | <paramlist> |
15870 | <param name="filename" type="String" default=""/> | |
15871 | </paramlist> | |
15872 | </method> | |
15873 | <method name="SetFontMetricPath" type="" overloaded="no"> | |
781d2982 | 15874 | <autodoc>SetFontMetricPath(self, String path)</autodoc> |
f32fc4bc RD |
15875 | <paramlist> |
15876 | <param name="path" type="String" default=""/> | |
15877 | </paramlist> | |
15878 | </method> | |
15879 | <method name="SetPrinterScaleX" type="" overloaded="no"> | |
781d2982 | 15880 | <autodoc>SetPrinterScaleX(self, double x)</autodoc> |
f32fc4bc RD |
15881 | <paramlist> |
15882 | <param name="x" type="double" default=""/> | |
15883 | </paramlist> | |
15884 | </method> | |
15885 | <method name="SetPrinterScaleY" type="" overloaded="no"> | |
781d2982 | 15886 | <autodoc>SetPrinterScaleY(self, double y)</autodoc> |
f32fc4bc RD |
15887 | <paramlist> |
15888 | <param name="y" type="double" default=""/> | |
15889 | </paramlist> | |
15890 | </method> | |
15891 | <method name="SetPrinterScaling" type="" overloaded="no"> | |
781d2982 | 15892 | <autodoc>SetPrinterScaling(self, double x, double y)</autodoc> |
f32fc4bc RD |
15893 | <paramlist> |
15894 | <param name="x" type="double" default=""/> | |
15895 | <param name="y" type="double" default=""/> | |
15896 | </paramlist> | |
15897 | </method> | |
15898 | <method name="SetPrinterTranslateX" type="" overloaded="no"> | |
781d2982 | 15899 | <autodoc>SetPrinterTranslateX(self, long x)</autodoc> |
f32fc4bc RD |
15900 | <paramlist> |
15901 | <param name="x" type="long" default=""/> | |
15902 | </paramlist> | |
15903 | </method> | |
15904 | <method name="SetPrinterTranslateY" type="" overloaded="no"> | |
781d2982 | 15905 | <autodoc>SetPrinterTranslateY(self, long y)</autodoc> |
f32fc4bc RD |
15906 | <paramlist> |
15907 | <param name="y" type="long" default=""/> | |
15908 | </paramlist> | |
15909 | </method> | |
15910 | <method name="SetPrinterTranslation" type="" overloaded="no"> | |
781d2982 | 15911 | <autodoc>SetPrinterTranslation(self, long x, long y)</autodoc> |
f32fc4bc RD |
15912 | <paramlist> |
15913 | <param name="x" type="long" default=""/> | |
15914 | <param name="y" type="long" default=""/> | |
15915 | </paramlist> | |
15916 | </method> | |
15917 | <method name="SetPrintMode" type="" overloaded="no"> | |
781d2982 | 15918 | <autodoc>SetPrintMode(self, int printMode)</autodoc> |
f32fc4bc RD |
15919 | <paramlist> |
15920 | <param name="printMode" type="wxPrintMode" default=""/> | |
15921 | </paramlist> | |
15922 | </method> | |
15923 | <method name="GetOutputStream" type="OutputStream" overloaded="no"> | |
781d2982 | 15924 | <autodoc>GetOutputStream(self) -> OutputStream</autodoc> |
f32fc4bc RD |
15925 | </method> |
15926 | <method name="SetOutputStream" type="" overloaded="no"> | |
781d2982 | 15927 | <autodoc>SetOutputStream(self, OutputStream outputstream)</autodoc> |
f32fc4bc RD |
15928 | <paramlist> |
15929 | <param name="outputstream" type="OutputStream" default=""/> | |
15930 | </paramlist> | |
15931 | </method> | |
15932 | </class> | |
781d2982 | 15933 | <class name="PageSetupDialogData" oldname="wxPageSetupDialogData" module="_windows"> |
f32fc4bc | 15934 | <baseclass name="Object"/> |
781d2982 RD |
15935 | <constructor name="PageSetupDialogData" overloaded="yes"/> |
15936 | <constructor name="PageSetupDialogData" overloaded="yes"> | |
15937 | <autodoc>__init__(self) -> PageSetupDialogData | |
15938 | __init__(self, PageSetupDialogData data) -> PageSetupDialogData</autodoc> | |
15939 | <paramlist> | |
15940 | <param name="data" type="PageSetupDialogData" default=""/> | |
15941 | </paramlist> | |
f32fc4bc RD |
15942 | </constructor> |
15943 | <destructor name="~wxPageSetupDialogData" overloaded="no"> | |
781d2982 | 15944 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
15945 | </destructor> |
15946 | <method name="EnableHelp" type="" overloaded="no"> | |
781d2982 | 15947 | <autodoc>EnableHelp(self, bool flag)</autodoc> |
f32fc4bc RD |
15948 | <paramlist> |
15949 | <param name="flag" type="bool" default=""/> | |
15950 | </paramlist> | |
15951 | </method> | |
15952 | <method name="EnableMargins" type="" overloaded="no"> | |
781d2982 | 15953 | <autodoc>EnableMargins(self, bool flag)</autodoc> |
f32fc4bc RD |
15954 | <paramlist> |
15955 | <param name="flag" type="bool" default=""/> | |
15956 | </paramlist> | |
15957 | </method> | |
15958 | <method name="EnableOrientation" type="" overloaded="no"> | |
781d2982 | 15959 | <autodoc>EnableOrientation(self, bool flag)</autodoc> |
f32fc4bc RD |
15960 | <paramlist> |
15961 | <param name="flag" type="bool" default=""/> | |
15962 | </paramlist> | |
15963 | </method> | |
15964 | <method name="EnablePaper" type="" overloaded="no"> | |
781d2982 | 15965 | <autodoc>EnablePaper(self, bool flag)</autodoc> |
f32fc4bc RD |
15966 | <paramlist> |
15967 | <param name="flag" type="bool" default=""/> | |
15968 | </paramlist> | |
15969 | </method> | |
15970 | <method name="EnablePrinter" type="" overloaded="no"> | |
781d2982 | 15971 | <autodoc>EnablePrinter(self, bool flag)</autodoc> |
f32fc4bc RD |
15972 | <paramlist> |
15973 | <param name="flag" type="bool" default=""/> | |
15974 | </paramlist> | |
15975 | </method> | |
15976 | <method name="GetDefaultMinMargins" type="bool" overloaded="no"> | |
781d2982 | 15977 | <autodoc>GetDefaultMinMargins(self) -> bool</autodoc> |
f32fc4bc RD |
15978 | </method> |
15979 | <method name="GetEnableMargins" type="bool" overloaded="no"> | |
781d2982 | 15980 | <autodoc>GetEnableMargins(self) -> bool</autodoc> |
f32fc4bc RD |
15981 | </method> |
15982 | <method name="GetEnableOrientation" type="bool" overloaded="no"> | |
781d2982 | 15983 | <autodoc>GetEnableOrientation(self) -> bool</autodoc> |
f32fc4bc RD |
15984 | </method> |
15985 | <method name="GetEnablePaper" type="bool" overloaded="no"> | |
781d2982 | 15986 | <autodoc>GetEnablePaper(self) -> bool</autodoc> |
f32fc4bc RD |
15987 | </method> |
15988 | <method name="GetEnablePrinter" type="bool" overloaded="no"> | |
781d2982 | 15989 | <autodoc>GetEnablePrinter(self) -> bool</autodoc> |
f32fc4bc RD |
15990 | </method> |
15991 | <method name="GetEnableHelp" type="bool" overloaded="no"> | |
781d2982 | 15992 | <autodoc>GetEnableHelp(self) -> bool</autodoc> |
f32fc4bc RD |
15993 | </method> |
15994 | <method name="GetDefaultInfo" type="bool" overloaded="no"> | |
781d2982 | 15995 | <autodoc>GetDefaultInfo(self) -> bool</autodoc> |
f32fc4bc RD |
15996 | </method> |
15997 | <method name="GetMarginTopLeft" type="Point" overloaded="no"> | |
781d2982 | 15998 | <autodoc>GetMarginTopLeft(self) -> Point</autodoc> |
f32fc4bc RD |
15999 | </method> |
16000 | <method name="GetMarginBottomRight" type="Point" overloaded="no"> | |
781d2982 | 16001 | <autodoc>GetMarginBottomRight(self) -> Point</autodoc> |
f32fc4bc RD |
16002 | </method> |
16003 | <method name="GetMinMarginTopLeft" type="Point" overloaded="no"> | |
781d2982 | 16004 | <autodoc>GetMinMarginTopLeft(self) -> Point</autodoc> |
f32fc4bc RD |
16005 | </method> |
16006 | <method name="GetMinMarginBottomRight" type="Point" overloaded="no"> | |
781d2982 | 16007 | <autodoc>GetMinMarginBottomRight(self) -> Point</autodoc> |
f32fc4bc RD |
16008 | </method> |
16009 | <method name="GetPaperId" type="wxPaperSize" overloaded="no"> | |
781d2982 | 16010 | <autodoc>GetPaperId(self) -> int</autodoc> |
f32fc4bc RD |
16011 | </method> |
16012 | <method name="GetPaperSize" type="Size" overloaded="no"> | |
781d2982 | 16013 | <autodoc>GetPaperSize(self) -> Size</autodoc> |
f32fc4bc RD |
16014 | </method> |
16015 | <method name="GetPrintData" type="PrintData" overloaded="no"> | |
781d2982 | 16016 | <autodoc>GetPrintData(self) -> PrintData</autodoc> |
f32fc4bc RD |
16017 | </method> |
16018 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 16019 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
16020 | </method> |
16021 | <method name="SetDefaultInfo" type="" overloaded="no"> | |
781d2982 | 16022 | <autodoc>SetDefaultInfo(self, bool flag)</autodoc> |
f32fc4bc RD |
16023 | <paramlist> |
16024 | <param name="flag" type="bool" default=""/> | |
16025 | </paramlist> | |
16026 | </method> | |
16027 | <method name="SetDefaultMinMargins" type="" overloaded="no"> | |
781d2982 | 16028 | <autodoc>SetDefaultMinMargins(self, bool flag)</autodoc> |
f32fc4bc RD |
16029 | <paramlist> |
16030 | <param name="flag" type="bool" default=""/> | |
16031 | </paramlist> | |
16032 | </method> | |
16033 | <method name="SetMarginTopLeft" type="" overloaded="no"> | |
781d2982 | 16034 | <autodoc>SetMarginTopLeft(self, Point pt)</autodoc> |
f32fc4bc RD |
16035 | <paramlist> |
16036 | <param name="pt" type="Point" default=""/> | |
16037 | </paramlist> | |
16038 | </method> | |
16039 | <method name="SetMarginBottomRight" type="" overloaded="no"> | |
781d2982 | 16040 | <autodoc>SetMarginBottomRight(self, Point pt)</autodoc> |
f32fc4bc RD |
16041 | <paramlist> |
16042 | <param name="pt" type="Point" default=""/> | |
16043 | </paramlist> | |
16044 | </method> | |
16045 | <method name="SetMinMarginTopLeft" type="" overloaded="no"> | |
781d2982 | 16046 | <autodoc>SetMinMarginTopLeft(self, Point pt)</autodoc> |
f32fc4bc RD |
16047 | <paramlist> |
16048 | <param name="pt" type="Point" default=""/> | |
16049 | </paramlist> | |
16050 | </method> | |
16051 | <method name="SetMinMarginBottomRight" type="" overloaded="no"> | |
781d2982 | 16052 | <autodoc>SetMinMarginBottomRight(self, Point pt)</autodoc> |
f32fc4bc RD |
16053 | <paramlist> |
16054 | <param name="pt" type="Point" default=""/> | |
16055 | </paramlist> | |
16056 | </method> | |
16057 | <method name="SetPaperId" type="" overloaded="no"> | |
781d2982 | 16058 | <autodoc>SetPaperId(self, int id)</autodoc> |
f32fc4bc RD |
16059 | <paramlist> |
16060 | <param name="id" type="wxPaperSize" default=""/> | |
16061 | </paramlist> | |
16062 | </method> | |
16063 | <method name="SetPaperSize" type="" overloaded="no"> | |
781d2982 | 16064 | <autodoc>SetPaperSize(self, Size size)</autodoc> |
f32fc4bc RD |
16065 | <paramlist> |
16066 | <param name="size" type="Size" default=""/> | |
16067 | </paramlist> | |
16068 | </method> | |
16069 | <method name="SetPrintData" type="" overloaded="no"> | |
781d2982 | 16070 | <autodoc>SetPrintData(self, PrintData printData)</autodoc> |
f32fc4bc RD |
16071 | <paramlist> |
16072 | <param name="printData" type="PrintData" default=""/> | |
16073 | </paramlist> | |
16074 | </method> | |
16075 | </class> | |
781d2982 | 16076 | <class name="PageSetupDialog" oldname="wxPageSetupDialog" module="_windows"> |
f32fc4bc RD |
16077 | <baseclass name="Dialog"/> |
16078 | <constructor name="PageSetupDialog" overloaded="no"> | |
781d2982 | 16079 | <autodoc>__init__(self, Window parent, PageSetupDialogData data=None) -> PageSetupDialog</autodoc> |
f32fc4bc RD |
16080 | <paramlist> |
16081 | <param name="parent" type="Window" default=""/> | |
16082 | <param name="data" type="PageSetupDialogData" default="NULL"/> | |
16083 | </paramlist> | |
16084 | </constructor> | |
16085 | <method name="GetPageSetupData" type="PageSetupDialogData" overloaded="no"> | |
781d2982 | 16086 | <autodoc>GetPageSetupData(self) -> PageSetupDialogData</autodoc> |
f32fc4bc RD |
16087 | </method> |
16088 | <method name="ShowModal" type="int" overloaded="no"> | |
781d2982 | 16089 | <autodoc>ShowModal(self) -> int</autodoc> |
f32fc4bc RD |
16090 | </method> |
16091 | </class> | |
781d2982 | 16092 | <class name="PrintDialogData" oldname="wxPrintDialogData" module="_windows"> |
f32fc4bc | 16093 | <baseclass name="Object"/> |
b39e211b RD |
16094 | <constructor name="PrintDialogData" overloaded="yes"/> |
16095 | <constructor name="PrintDialogData" overloaded="yes"> | |
781d2982 RD |
16096 | <autodoc>__init__(self) -> PrintDialogData |
16097 | __init__(self, PrintData printData) -> PrintDialogData</autodoc> | |
b39e211b RD |
16098 | <paramlist> |
16099 | <param name="printData" type="PrintData" default=""/> | |
16100 | </paramlist> | |
f32fc4bc RD |
16101 | </constructor> |
16102 | <destructor name="~wxPrintDialogData" overloaded="no"> | |
781d2982 | 16103 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
16104 | </destructor> |
16105 | <method name="GetFromPage" type="int" overloaded="no"> | |
781d2982 | 16106 | <autodoc>GetFromPage(self) -> int</autodoc> |
f32fc4bc RD |
16107 | </method> |
16108 | <method name="GetToPage" type="int" overloaded="no"> | |
781d2982 | 16109 | <autodoc>GetToPage(self) -> int</autodoc> |
f32fc4bc RD |
16110 | </method> |
16111 | <method name="GetMinPage" type="int" overloaded="no"> | |
781d2982 | 16112 | <autodoc>GetMinPage(self) -> int</autodoc> |
f32fc4bc RD |
16113 | </method> |
16114 | <method name="GetMaxPage" type="int" overloaded="no"> | |
781d2982 | 16115 | <autodoc>GetMaxPage(self) -> int</autodoc> |
f32fc4bc RD |
16116 | </method> |
16117 | <method name="GetNoCopies" type="int" overloaded="no"> | |
781d2982 | 16118 | <autodoc>GetNoCopies(self) -> int</autodoc> |
f32fc4bc RD |
16119 | </method> |
16120 | <method name="GetAllPages" type="bool" overloaded="no"> | |
781d2982 | 16121 | <autodoc>GetAllPages(self) -> bool</autodoc> |
f32fc4bc RD |
16122 | </method> |
16123 | <method name="GetSelection" type="bool" overloaded="no"> | |
781d2982 | 16124 | <autodoc>GetSelection(self) -> bool</autodoc> |
f32fc4bc RD |
16125 | </method> |
16126 | <method name="GetCollate" type="bool" overloaded="no"> | |
781d2982 | 16127 | <autodoc>GetCollate(self) -> bool</autodoc> |
f32fc4bc RD |
16128 | </method> |
16129 | <method name="GetPrintToFile" type="bool" overloaded="no"> | |
781d2982 | 16130 | <autodoc>GetPrintToFile(self) -> bool</autodoc> |
f32fc4bc RD |
16131 | </method> |
16132 | <method name="GetSetupDialog" type="bool" overloaded="no"> | |
781d2982 | 16133 | <autodoc>GetSetupDialog(self) -> bool</autodoc> |
f32fc4bc RD |
16134 | </method> |
16135 | <method name="SetFromPage" type="" overloaded="no"> | |
781d2982 | 16136 | <autodoc>SetFromPage(self, int v)</autodoc> |
f32fc4bc RD |
16137 | <paramlist> |
16138 | <param name="v" type="int" default=""/> | |
16139 | </paramlist> | |
16140 | </method> | |
16141 | <method name="SetToPage" type="" overloaded="no"> | |
781d2982 | 16142 | <autodoc>SetToPage(self, int v)</autodoc> |
f32fc4bc RD |
16143 | <paramlist> |
16144 | <param name="v" type="int" default=""/> | |
16145 | </paramlist> | |
16146 | </method> | |
16147 | <method name="SetMinPage" type="" overloaded="no"> | |
781d2982 | 16148 | <autodoc>SetMinPage(self, int v)</autodoc> |
f32fc4bc RD |
16149 | <paramlist> |
16150 | <param name="v" type="int" default=""/> | |
16151 | </paramlist> | |
16152 | </method> | |
16153 | <method name="SetMaxPage" type="" overloaded="no"> | |
781d2982 | 16154 | <autodoc>SetMaxPage(self, int v)</autodoc> |
f32fc4bc RD |
16155 | <paramlist> |
16156 | <param name="v" type="int" default=""/> | |
16157 | </paramlist> | |
16158 | </method> | |
16159 | <method name="SetNoCopies" type="" overloaded="no"> | |
781d2982 | 16160 | <autodoc>SetNoCopies(self, int v)</autodoc> |
f32fc4bc RD |
16161 | <paramlist> |
16162 | <param name="v" type="int" default=""/> | |
16163 | </paramlist> | |
16164 | </method> | |
16165 | <method name="SetAllPages" type="" overloaded="no"> | |
781d2982 | 16166 | <autodoc>SetAllPages(self, bool flag)</autodoc> |
f32fc4bc RD |
16167 | <paramlist> |
16168 | <param name="flag" type="bool" default=""/> | |
16169 | </paramlist> | |
16170 | </method> | |
16171 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 16172 | <autodoc>SetSelection(self, bool flag)</autodoc> |
f32fc4bc RD |
16173 | <paramlist> |
16174 | <param name="flag" type="bool" default=""/> | |
16175 | </paramlist> | |
16176 | </method> | |
16177 | <method name="SetCollate" type="" overloaded="no"> | |
781d2982 | 16178 | <autodoc>SetCollate(self, bool flag)</autodoc> |
f32fc4bc RD |
16179 | <paramlist> |
16180 | <param name="flag" type="bool" default=""/> | |
16181 | </paramlist> | |
16182 | </method> | |
16183 | <method name="SetPrintToFile" type="" overloaded="no"> | |
781d2982 | 16184 | <autodoc>SetPrintToFile(self, bool flag)</autodoc> |
f32fc4bc RD |
16185 | <paramlist> |
16186 | <param name="flag" type="bool" default=""/> | |
16187 | </paramlist> | |
16188 | </method> | |
16189 | <method name="SetSetupDialog" type="" overloaded="no"> | |
781d2982 | 16190 | <autodoc>SetSetupDialog(self, bool flag)</autodoc> |
f32fc4bc RD |
16191 | <paramlist> |
16192 | <param name="flag" type="bool" default=""/> | |
16193 | </paramlist> | |
16194 | </method> | |
16195 | <method name="EnablePrintToFile" type="" overloaded="no"> | |
781d2982 | 16196 | <autodoc>EnablePrintToFile(self, bool flag)</autodoc> |
f32fc4bc RD |
16197 | <paramlist> |
16198 | <param name="flag" type="bool" default=""/> | |
16199 | </paramlist> | |
16200 | </method> | |
16201 | <method name="EnableSelection" type="" overloaded="no"> | |
781d2982 | 16202 | <autodoc>EnableSelection(self, bool flag)</autodoc> |
f32fc4bc RD |
16203 | <paramlist> |
16204 | <param name="flag" type="bool" default=""/> | |
16205 | </paramlist> | |
16206 | </method> | |
16207 | <method name="EnablePageNumbers" type="" overloaded="no"> | |
781d2982 | 16208 | <autodoc>EnablePageNumbers(self, bool flag)</autodoc> |
f32fc4bc RD |
16209 | <paramlist> |
16210 | <param name="flag" type="bool" default=""/> | |
16211 | </paramlist> | |
16212 | </method> | |
16213 | <method name="EnableHelp" type="" overloaded="no"> | |
781d2982 | 16214 | <autodoc>EnableHelp(self, bool flag)</autodoc> |
f32fc4bc RD |
16215 | <paramlist> |
16216 | <param name="flag" type="bool" default=""/> | |
16217 | </paramlist> | |
16218 | </method> | |
16219 | <method name="GetEnablePrintToFile" type="bool" overloaded="no"> | |
781d2982 | 16220 | <autodoc>GetEnablePrintToFile(self) -> bool</autodoc> |
f32fc4bc RD |
16221 | </method> |
16222 | <method name="GetEnableSelection" type="bool" overloaded="no"> | |
781d2982 | 16223 | <autodoc>GetEnableSelection(self) -> bool</autodoc> |
f32fc4bc RD |
16224 | </method> |
16225 | <method name="GetEnablePageNumbers" type="bool" overloaded="no"> | |
781d2982 | 16226 | <autodoc>GetEnablePageNumbers(self) -> bool</autodoc> |
f32fc4bc RD |
16227 | </method> |
16228 | <method name="GetEnableHelp" type="bool" overloaded="no"> | |
781d2982 | 16229 | <autodoc>GetEnableHelp(self) -> bool</autodoc> |
f32fc4bc RD |
16230 | </method> |
16231 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 16232 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
16233 | </method> |
16234 | <method name="GetPrintData" type="PrintData" overloaded="no"> | |
781d2982 | 16235 | <autodoc>GetPrintData(self) -> PrintData</autodoc> |
f32fc4bc RD |
16236 | </method> |
16237 | <method name="SetPrintData" type="" overloaded="no"> | |
781d2982 | 16238 | <autodoc>SetPrintData(self, PrintData printData)</autodoc> |
f32fc4bc RD |
16239 | <paramlist> |
16240 | <param name="printData" type="PrintData" default=""/> | |
16241 | </paramlist> | |
16242 | </method> | |
16243 | </class> | |
781d2982 | 16244 | <class name="PrintDialog" oldname="wxPrintDialog" module="_windows"> |
f32fc4bc RD |
16245 | <baseclass name="Dialog"/> |
16246 | <constructor name="PrintDialog" overloaded="no"> | |
781d2982 | 16247 | <autodoc>__init__(self, Window parent, PrintDialogData data=None) -> PrintDialog</autodoc> |
f32fc4bc RD |
16248 | <paramlist> |
16249 | <param name="parent" type="Window" default=""/> | |
16250 | <param name="data" type="PrintDialogData" default="NULL"/> | |
16251 | </paramlist> | |
16252 | </constructor> | |
16253 | <method name="GetPrintDialogData" type="PrintDialogData" overloaded="no"> | |
781d2982 | 16254 | <autodoc>GetPrintDialogData(self) -> PrintDialogData</autodoc> |
f32fc4bc RD |
16255 | </method> |
16256 | <method name="GetPrintDC" type="DC" overloaded="no"> | |
781d2982 | 16257 | <autodoc>GetPrintDC(self) -> DC</autodoc> |
f32fc4bc RD |
16258 | </method> |
16259 | <method name="ShowModal" type="int" overloaded="no"> | |
781d2982 | 16260 | <autodoc>ShowModal(self) -> int</autodoc> |
f32fc4bc RD |
16261 | </method> |
16262 | </class> | |
781d2982 | 16263 | <class name="Printer" oldname="wxPrinter" module="_windows"> |
f32fc4bc RD |
16264 | <baseclass name="Object"/> |
16265 | <constructor name="Printer" overloaded="no"> | |
781d2982 | 16266 | <autodoc>__init__(self, PrintDialogData data=None) -> Printer</autodoc> |
f32fc4bc RD |
16267 | <paramlist> |
16268 | <param name="data" type="PrintDialogData" default="NULL"/> | |
16269 | </paramlist> | |
16270 | </constructor> | |
16271 | <destructor name="~wxPrinter" overloaded="no"> | |
781d2982 | 16272 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
16273 | </destructor> |
16274 | <method name="CreateAbortWindow" type="" overloaded="no"> | |
781d2982 | 16275 | <autodoc>CreateAbortWindow(self, Window parent, Printout printout)</autodoc> |
f32fc4bc RD |
16276 | <paramlist> |
16277 | <param name="parent" type="Window" default=""/> | |
16278 | <param name="printout" type="wxPyPrintout" default=""/> | |
16279 | </paramlist> | |
16280 | </method> | |
16281 | <method name="GetPrintDialogData" type="PrintDialogData" overloaded="no"> | |
781d2982 | 16282 | <autodoc>GetPrintDialogData(self) -> PrintDialogData</autodoc> |
f32fc4bc RD |
16283 | </method> |
16284 | <method name="Print" type="bool" overloaded="no"> | |
781d2982 | 16285 | <autodoc>Print(self, Window parent, Printout printout, int prompt=True) -> bool</autodoc> |
f32fc4bc RD |
16286 | <paramlist> |
16287 | <param name="parent" type="Window" default=""/> | |
16288 | <param name="printout" type="wxPyPrintout" default=""/> | |
16289 | <param name="prompt" type="int" default="True"/> | |
16290 | </paramlist> | |
16291 | </method> | |
16292 | <method name="PrintDialog" type="DC" overloaded="no"> | |
781d2982 | 16293 | <autodoc>PrintDialog(self, Window parent) -> DC</autodoc> |
f32fc4bc RD |
16294 | <paramlist> |
16295 | <param name="parent" type="Window" default=""/> | |
16296 | </paramlist> | |
16297 | </method> | |
16298 | <method name="ReportError" type="" overloaded="no"> | |
781d2982 | 16299 | <autodoc>ReportError(self, Window parent, Printout printout, String message)</autodoc> |
f32fc4bc RD |
16300 | <paramlist> |
16301 | <param name="parent" type="Window" default=""/> | |
16302 | <param name="printout" type="wxPyPrintout" default=""/> | |
16303 | <param name="message" type="String" default=""/> | |
16304 | </paramlist> | |
16305 | </method> | |
16306 | <method name="Setup" type="bool" overloaded="no"> | |
781d2982 | 16307 | <autodoc>Setup(self, Window parent) -> bool</autodoc> |
f32fc4bc RD |
16308 | <paramlist> |
16309 | <param name="parent" type="Window" default=""/> | |
16310 | </paramlist> | |
16311 | </method> | |
16312 | <method name="GetAbort" type="bool" overloaded="no"> | |
781d2982 | 16313 | <autodoc>GetAbort(self) -> bool</autodoc> |
f32fc4bc RD |
16314 | </method> |
16315 | <staticmethod name="GetLastError" type="wxPrinterError" overloaded="no"> | |
16316 | <autodoc>GetLastError() -> int</autodoc> | |
16317 | </staticmethod> | |
16318 | </class> | |
781d2982 | 16319 | <class name="Printout" oldname="wxPyPrintout" module="_windows"> |
f32fc4bc RD |
16320 | <baseclass name="Object"/> |
16321 | <constructor name="wxPyPrintout" overloaded="no"> | |
781d2982 | 16322 | <autodoc>__init__(self, String title=PrintoutTitleStr) -> Printout</autodoc> |
f32fc4bc RD |
16323 | <paramlist> |
16324 | <param name="title" type="String" default="wxPyPrintoutTitleStr"/> | |
16325 | </paramlist> | |
16326 | </constructor> | |
16327 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 16328 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
16329 | <paramlist> |
16330 | <param name="self" type="PyObject" default=""/> | |
16331 | <param name="_class" type="PyObject" default=""/> | |
16332 | </paramlist> | |
16333 | </method> | |
16334 | <method name="GetTitle" type="String" overloaded="no"> | |
781d2982 | 16335 | <autodoc>GetTitle(self) -> String</autodoc> |
f32fc4bc RD |
16336 | </method> |
16337 | <method name="GetDC" type="DC" overloaded="no"> | |
781d2982 | 16338 | <autodoc>GetDC(self) -> DC</autodoc> |
f32fc4bc RD |
16339 | </method> |
16340 | <method name="SetDC" type="" overloaded="no"> | |
781d2982 | 16341 | <autodoc>SetDC(self, DC dc)</autodoc> |
f32fc4bc RD |
16342 | <paramlist> |
16343 | <param name="dc" type="DC" default=""/> | |
16344 | </paramlist> | |
16345 | </method> | |
16346 | <method name="SetPageSizePixels" type="" overloaded="no"> | |
781d2982 | 16347 | <autodoc>SetPageSizePixels(self, int w, int h)</autodoc> |
f32fc4bc RD |
16348 | <paramlist> |
16349 | <param name="w" type="int" default=""/> | |
16350 | <param name="h" type="int" default=""/> | |
16351 | </paramlist> | |
16352 | </method> | |
16353 | <method name="GetPageSizePixels" type="" overloaded="no"> | |
16354 | <autodoc>GetPageSizePixels() -> (w, h)</autodoc> | |
16355 | <paramlist> | |
16356 | <param name="OUTPUT" type="int" default=""/> | |
16357 | <param name="OUTPUT" type="int" default=""/> | |
16358 | </paramlist> | |
16359 | </method> | |
16360 | <method name="SetPageSizeMM" type="" overloaded="no"> | |
781d2982 | 16361 | <autodoc>SetPageSizeMM(self, int w, int h)</autodoc> |
f32fc4bc RD |
16362 | <paramlist> |
16363 | <param name="w" type="int" default=""/> | |
16364 | <param name="h" type="int" default=""/> | |
16365 | </paramlist> | |
16366 | </method> | |
16367 | <method name="GetPageSizeMM" type="" overloaded="no"> | |
16368 | <autodoc>GetPageSizeMM() -> (w, h)</autodoc> | |
16369 | <paramlist> | |
16370 | <param name="OUTPUT" type="int" default=""/> | |
16371 | <param name="OUTPUT" type="int" default=""/> | |
16372 | </paramlist> | |
16373 | </method> | |
16374 | <method name="SetPPIScreen" type="" overloaded="no"> | |
781d2982 | 16375 | <autodoc>SetPPIScreen(self, int x, int y)</autodoc> |
f32fc4bc RD |
16376 | <paramlist> |
16377 | <param name="x" type="int" default=""/> | |
16378 | <param name="y" type="int" default=""/> | |
16379 | </paramlist> | |
16380 | </method> | |
16381 | <method name="GetPPIScreen" type="" overloaded="no"> | |
16382 | <autodoc>GetPPIScreen() -> (x,y)</autodoc> | |
16383 | <paramlist> | |
16384 | <param name="OUTPUT" type="int" default=""/> | |
16385 | <param name="OUTPUT" type="int" default=""/> | |
16386 | </paramlist> | |
16387 | </method> | |
16388 | <method name="SetPPIPrinter" type="" overloaded="no"> | |
781d2982 | 16389 | <autodoc>SetPPIPrinter(self, int x, int y)</autodoc> |
f32fc4bc RD |
16390 | <paramlist> |
16391 | <param name="x" type="int" default=""/> | |
16392 | <param name="y" type="int" default=""/> | |
16393 | </paramlist> | |
16394 | </method> | |
16395 | <method name="GetPPIPrinter" type="" overloaded="no"> | |
16396 | <autodoc>GetPPIPrinter() -> (x,y)</autodoc> | |
16397 | <paramlist> | |
16398 | <param name="OUTPUT" type="int" default=""/> | |
16399 | <param name="OUTPUT" type="int" default=""/> | |
16400 | </paramlist> | |
16401 | </method> | |
16402 | <method name="IsPreview" type="bool" overloaded="no"> | |
781d2982 | 16403 | <autodoc>IsPreview(self) -> bool</autodoc> |
f32fc4bc RD |
16404 | </method> |
16405 | <method name="SetIsPreview" type="" overloaded="no"> | |
781d2982 | 16406 | <autodoc>SetIsPreview(self, bool p)</autodoc> |
f32fc4bc RD |
16407 | <paramlist> |
16408 | <param name="p" type="bool" default=""/> | |
16409 | </paramlist> | |
16410 | </method> | |
16411 | <method name="base_OnBeginDocument" type="bool" overloaded="no"> | |
781d2982 | 16412 | <autodoc>base_OnBeginDocument(self, int startPage, int endPage) -> bool</autodoc> |
f32fc4bc RD |
16413 | <paramlist> |
16414 | <param name="startPage" type="int" default=""/> | |
16415 | <param name="endPage" type="int" default=""/> | |
16416 | </paramlist> | |
16417 | </method> | |
16418 | <method name="base_OnEndDocument" type="" overloaded="no"> | |
781d2982 | 16419 | <autodoc>base_OnEndDocument(self)</autodoc> |
f32fc4bc RD |
16420 | </method> |
16421 | <method name="base_OnBeginPrinting" type="" overloaded="no"> | |
781d2982 | 16422 | <autodoc>base_OnBeginPrinting(self)</autodoc> |
f32fc4bc RD |
16423 | </method> |
16424 | <method name="base_OnEndPrinting" type="" overloaded="no"> | |
781d2982 | 16425 | <autodoc>base_OnEndPrinting(self)</autodoc> |
f32fc4bc RD |
16426 | </method> |
16427 | <method name="base_OnPreparePrinting" type="" overloaded="no"> | |
781d2982 | 16428 | <autodoc>base_OnPreparePrinting(self)</autodoc> |
f32fc4bc RD |
16429 | </method> |
16430 | <method name="base_HasPage" type="bool" overloaded="no"> | |
781d2982 | 16431 | <autodoc>base_HasPage(self, int page) -> bool</autodoc> |
f32fc4bc RD |
16432 | <paramlist> |
16433 | <param name="page" type="int" default=""/> | |
16434 | </paramlist> | |
16435 | </method> | |
16436 | <method name="base_GetPageInfo" type="" overloaded="no"> | |
16437 | <autodoc>base_GetPageInfo() -> (minPage, maxPage, pageFrom, pageTo)</autodoc> | |
16438 | <paramlist> | |
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=""/> | |
16443 | </paramlist> | |
16444 | </method> | |
16445 | </class> | |
781d2982 | 16446 | <class name="PreviewCanvas" oldname="wxPreviewCanvas" module="_windows"> |
f32fc4bc RD |
16447 | <baseclass name="ScrolledWindow"/> |
16448 | <constructor name="PreviewCanvas" overloaded="no"> | |
781d2982 | 16449 | <autodoc>__init__(self, PrintPreview preview, Window parent, Point pos=DefaultPosition, |
856bf319 RD |
16450 | Size size=DefaultSize, long style=0, |
16451 | String name=PreviewCanvasNameStr) -> PreviewCanvas</autodoc> | |
f32fc4bc RD |
16452 | <paramlist> |
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"/> | |
16459 | </paramlist> | |
16460 | </constructor> | |
16461 | </class> | |
781d2982 | 16462 | <class name="PreviewFrame" oldname="wxPreviewFrame" module="_windows"> |
f32fc4bc RD |
16463 | <baseclass name="Frame"/> |
16464 | <constructor name="PreviewFrame" overloaded="no"> | |
781d2982 | 16465 | <autodoc>__init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, |
856bf319 RD |
16466 | Size size=DefaultSize, |
16467 | long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PreviewFrame</autodoc> | |
f32fc4bc RD |
16468 | <paramlist> |
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"/> | |
16476 | </paramlist> | |
16477 | </constructor> | |
16478 | <method name="Initialize" type="" overloaded="no"> | |
781d2982 | 16479 | <autodoc>Initialize(self)</autodoc> |
f32fc4bc RD |
16480 | </method> |
16481 | <method name="CreateControlBar" type="" overloaded="no"> | |
781d2982 | 16482 | <autodoc>CreateControlBar(self)</autodoc> |
f32fc4bc RD |
16483 | </method> |
16484 | <method name="CreateCanvas" type="" overloaded="no"> | |
781d2982 | 16485 | <autodoc>CreateCanvas(self)</autodoc> |
f32fc4bc RD |
16486 | </method> |
16487 | <method name="GetControlBar" type="wxPreviewControlBar" overloaded="no"> | |
781d2982 | 16488 | <autodoc>GetControlBar(self) -> PreviewControlBar</autodoc> |
f32fc4bc RD |
16489 | </method> |
16490 | </class> | |
781d2982 | 16491 | <class name="PreviewControlBar" oldname="wxPreviewControlBar" module="_windows"> |
f32fc4bc RD |
16492 | <baseclass name="Panel"/> |
16493 | <constructor name="PreviewControlBar" overloaded="no"> | |
781d2982 | 16494 | <autodoc>__init__(self, PrintPreview preview, long buttons, Window parent, |
856bf319 RD |
16495 | Point pos=DefaultPosition, Size size=DefaultSize, |
16496 | long style=TAB_TRAVERSAL, String name=PanelNameStr) -> PreviewControlBar</autodoc> | |
f32fc4bc RD |
16497 | <paramlist> |
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"/> | |
16505 | </paramlist> | |
16506 | </constructor> | |
16507 | <method name="GetZoomControl" type="int" overloaded="no"> | |
781d2982 | 16508 | <autodoc>GetZoomControl(self) -> int</autodoc> |
f32fc4bc RD |
16509 | </method> |
16510 | <method name="SetZoomControl" type="" overloaded="no"> | |
781d2982 | 16511 | <autodoc>SetZoomControl(self, int zoom)</autodoc> |
f32fc4bc RD |
16512 | <paramlist> |
16513 | <param name="zoom" type="int" default=""/> | |
16514 | </paramlist> | |
16515 | </method> | |
16516 | <method name="GetPrintPreview" type="wxPrintPreview" overloaded="no"> | |
781d2982 | 16517 | <autodoc>GetPrintPreview(self) -> PrintPreview</autodoc> |
f32fc4bc RD |
16518 | </method> |
16519 | <method name="OnNext" type="" overloaded="no"> | |
781d2982 | 16520 | <autodoc>OnNext(self)</autodoc> |
f32fc4bc RD |
16521 | </method> |
16522 | <method name="OnPrevious" type="" overloaded="no"> | |
781d2982 | 16523 | <autodoc>OnPrevious(self)</autodoc> |
f32fc4bc RD |
16524 | </method> |
16525 | <method name="OnFirst" type="" overloaded="no"> | |
781d2982 | 16526 | <autodoc>OnFirst(self)</autodoc> |
f32fc4bc RD |
16527 | </method> |
16528 | <method name="OnLast" type="" overloaded="no"> | |
781d2982 | 16529 | <autodoc>OnLast(self)</autodoc> |
f32fc4bc RD |
16530 | </method> |
16531 | <method name="OnGoto" type="" overloaded="no"> | |
781d2982 | 16532 | <autodoc>OnGoto(self)</autodoc> |
f32fc4bc RD |
16533 | </method> |
16534 | </class> | |
781d2982 | 16535 | <class name="PrintPreview" oldname="wxPrintPreview" module="_windows"> |
f32fc4bc | 16536 | <baseclass name="Object"/> |
b39e211b | 16537 | <constructor name="PrintPreview" overloaded="yes"> |
f32fc4bc RD |
16538 | <paramlist> |
16539 | <param name="printout" type="Printout" default=""/> | |
16540 | <param name="printoutForPrinting" type="Printout" default=""/> | |
b39e211b RD |
16541 | <param name="data" type="PrintDialogData" default="NULL"/> |
16542 | </paramlist> | |
16543 | </constructor> | |
16544 | <constructor name="PrintPreview" overloaded="yes"> | |
781d2982 RD |
16545 | <autodoc>__init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PrintPreview |
16546 | __init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -> PrintPreview</autodoc> | |
b39e211b RD |
16547 | <paramlist> |
16548 | <param name="printout" type="Printout" default=""/> | |
16549 | <param name="printoutForPrinting" type="Printout" default=""/> | |
16550 | <param name="data" type="PrintData" default=""/> | |
f32fc4bc RD |
16551 | </paramlist> |
16552 | </constructor> | |
16553 | <method name="SetCurrentPage" type="bool" overloaded="no"> | |
781d2982 | 16554 | <autodoc>SetCurrentPage(self, int pageNum) -> bool</autodoc> |
f32fc4bc RD |
16555 | <paramlist> |
16556 | <param name="pageNum" type="int" default=""/> | |
16557 | </paramlist> | |
16558 | </method> | |
16559 | <method name="GetCurrentPage" type="int" overloaded="no"> | |
781d2982 | 16560 | <autodoc>GetCurrentPage(self) -> int</autodoc> |
f32fc4bc RD |
16561 | </method> |
16562 | <method name="SetPrintout" type="" overloaded="no"> | |
781d2982 | 16563 | <autodoc>SetPrintout(self, Printout printout)</autodoc> |
f32fc4bc RD |
16564 | <paramlist> |
16565 | <param name="printout" type="Printout" default=""/> | |
16566 | </paramlist> | |
16567 | </method> | |
16568 | <method name="GetPrintout" type="Printout" overloaded="no"> | |
781d2982 | 16569 | <autodoc>GetPrintout(self) -> Printout</autodoc> |
f32fc4bc RD |
16570 | </method> |
16571 | <method name="GetPrintoutForPrinting" type="Printout" overloaded="no"> | |
781d2982 | 16572 | <autodoc>GetPrintoutForPrinting(self) -> Printout</autodoc> |
f32fc4bc RD |
16573 | </method> |
16574 | <method name="SetFrame" type="" overloaded="no"> | |
781d2982 | 16575 | <autodoc>SetFrame(self, Frame frame)</autodoc> |
f32fc4bc RD |
16576 | <paramlist> |
16577 | <param name="frame" type="Frame" default=""/> | |
16578 | </paramlist> | |
16579 | </method> | |
16580 | <method name="SetCanvas" type="" overloaded="no"> | |
781d2982 | 16581 | <autodoc>SetCanvas(self, PreviewCanvas canvas)</autodoc> |
f32fc4bc RD |
16582 | <paramlist> |
16583 | <param name="canvas" type="PreviewCanvas" default=""/> | |
16584 | </paramlist> | |
16585 | </method> | |
16586 | <method name="GetFrame" type="Frame" overloaded="no"> | |
781d2982 | 16587 | <autodoc>GetFrame(self) -> Frame</autodoc> |
f32fc4bc RD |
16588 | </method> |
16589 | <method name="GetCanvas" type="PreviewCanvas" overloaded="no"> | |
781d2982 | 16590 | <autodoc>GetCanvas(self) -> PreviewCanvas</autodoc> |
f32fc4bc RD |
16591 | </method> |
16592 | <method name="PaintPage" type="bool" overloaded="no"> | |
781d2982 | 16593 | <autodoc>PaintPage(self, PreviewCanvas canvas, DC dc) -> bool</autodoc> |
f32fc4bc RD |
16594 | <paramlist> |
16595 | <param name="canvas" type="PreviewCanvas" default=""/> | |
16596 | <param name="dc" type="DC" default=""/> | |
16597 | </paramlist> | |
16598 | </method> | |
16599 | <method name="DrawBlankPage" type="bool" overloaded="no"> | |
781d2982 | 16600 | <autodoc>DrawBlankPage(self, PreviewCanvas canvas, DC dc) -> bool</autodoc> |
f32fc4bc RD |
16601 | <paramlist> |
16602 | <param name="canvas" type="PreviewCanvas" default=""/> | |
16603 | <param name="dc" type="DC" default=""/> | |
16604 | </paramlist> | |
16605 | </method> | |
16606 | <method name="RenderPage" type="bool" overloaded="no"> | |
781d2982 | 16607 | <autodoc>RenderPage(self, int pageNum) -> bool</autodoc> |
f32fc4bc RD |
16608 | <paramlist> |
16609 | <param name="pageNum" type="int" default=""/> | |
16610 | </paramlist> | |
16611 | </method> | |
16612 | <method name="AdjustScrollbars" type="" overloaded="no"> | |
781d2982 | 16613 | <autodoc>AdjustScrollbars(self, PreviewCanvas canvas)</autodoc> |
f32fc4bc RD |
16614 | <paramlist> |
16615 | <param name="canvas" type="PreviewCanvas" default=""/> | |
16616 | </paramlist> | |
16617 | </method> | |
16618 | <method name="GetPrintDialogData" type="PrintDialogData" overloaded="no"> | |
781d2982 | 16619 | <autodoc>GetPrintDialogData(self) -> PrintDialogData</autodoc> |
f32fc4bc RD |
16620 | </method> |
16621 | <method name="SetZoom" type="" overloaded="no"> | |
781d2982 | 16622 | <autodoc>SetZoom(self, int percent)</autodoc> |
f32fc4bc RD |
16623 | <paramlist> |
16624 | <param name="percent" type="int" default=""/> | |
16625 | </paramlist> | |
16626 | </method> | |
16627 | <method name="GetZoom" type="int" overloaded="no"> | |
781d2982 | 16628 | <autodoc>GetZoom(self) -> int</autodoc> |
f32fc4bc RD |
16629 | </method> |
16630 | <method name="GetMaxPage" type="int" overloaded="no"> | |
781d2982 | 16631 | <autodoc>GetMaxPage(self) -> int</autodoc> |
f32fc4bc RD |
16632 | </method> |
16633 | <method name="GetMinPage" type="int" overloaded="no"> | |
781d2982 | 16634 | <autodoc>GetMinPage(self) -> int</autodoc> |
f32fc4bc RD |
16635 | </method> |
16636 | <method name="Ok" type="bool" overloaded="no"> | |
781d2982 | 16637 | <autodoc>Ok(self) -> bool</autodoc> |
f32fc4bc RD |
16638 | </method> |
16639 | <method name="SetOk" type="" overloaded="no"> | |
781d2982 | 16640 | <autodoc>SetOk(self, bool ok)</autodoc> |
f32fc4bc RD |
16641 | <paramlist> |
16642 | <param name="ok" type="bool" default=""/> | |
16643 | </paramlist> | |
16644 | </method> | |
16645 | <method name="Print" type="bool" overloaded="no"> | |
781d2982 | 16646 | <autodoc>Print(self, bool interactive) -> bool</autodoc> |
f32fc4bc RD |
16647 | <paramlist> |
16648 | <param name="interactive" type="bool" default=""/> | |
16649 | </paramlist> | |
16650 | </method> | |
16651 | <method name="DetermineScaling" type="" overloaded="no"> | |
781d2982 | 16652 | <autodoc>DetermineScaling(self)</autodoc> |
f32fc4bc RD |
16653 | </method> |
16654 | </class> | |
781d2982 | 16655 | <class name="PyPrintPreview" oldname="wxPyPrintPreview" module="_windows"> |
f32fc4bc | 16656 | <baseclass name="PrintPreview"/> |
b39e211b | 16657 | <constructor name="PyPrintPreview" overloaded="yes"> |
f32fc4bc RD |
16658 | <paramlist> |
16659 | <param name="printout" type="Printout" default=""/> | |
16660 | <param name="printoutForPrinting" type="Printout" default=""/> | |
b39e211b RD |
16661 | <param name="data" type="PrintDialogData" default="NULL"/> |
16662 | </paramlist> | |
16663 | </constructor> | |
16664 | <constructor name="PyPrintPreview" overloaded="yes"> | |
781d2982 RD |
16665 | <autodoc>__init__(self, Printout printout, Printout printoutForPrinting, PrintDialogData data=None) -> PyPrintPreview |
16666 | __init__(self, Printout printout, Printout printoutForPrinting, PrintData data) -> PyPrintPreview</autodoc> | |
b39e211b RD |
16667 | <paramlist> |
16668 | <param name="printout" type="Printout" default=""/> | |
16669 | <param name="printoutForPrinting" type="Printout" default=""/> | |
16670 | <param name="data" type="PrintData" default=""/> | |
f32fc4bc RD |
16671 | </paramlist> |
16672 | </constructor> | |
16673 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 16674 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
16675 | <paramlist> |
16676 | <param name="self" type="PyObject" default=""/> | |
16677 | <param name="_class" type="PyObject" default=""/> | |
16678 | </paramlist> | |
16679 | </method> | |
16680 | <method name="base_SetCurrentPage" type="bool" overloaded="no"> | |
781d2982 | 16681 | <autodoc>base_SetCurrentPage(self, int pageNum) -> bool</autodoc> |
f32fc4bc RD |
16682 | <paramlist> |
16683 | <param name="pageNum" type="int" default=""/> | |
16684 | </paramlist> | |
16685 | </method> | |
16686 | <method name="base_PaintPage" type="bool" overloaded="no"> | |
781d2982 | 16687 | <autodoc>base_PaintPage(self, PreviewCanvas canvas, DC dc) -> bool</autodoc> |
f32fc4bc RD |
16688 | <paramlist> |
16689 | <param name="canvas" type="PreviewCanvas" default=""/> | |
16690 | <param name="dc" type="DC" default=""/> | |
16691 | </paramlist> | |
16692 | </method> | |
16693 | <method name="base_DrawBlankPage" type="bool" overloaded="no"> | |
781d2982 | 16694 | <autodoc>base_DrawBlankPage(self, PreviewCanvas canvas, DC dc) -> bool</autodoc> |
f32fc4bc RD |
16695 | <paramlist> |
16696 | <param name="canvas" type="PreviewCanvas" default=""/> | |
16697 | <param name="dc" type="DC" default=""/> | |
16698 | </paramlist> | |
16699 | </method> | |
16700 | <method name="base_RenderPage" type="bool" overloaded="no"> | |
781d2982 | 16701 | <autodoc>base_RenderPage(self, int pageNum) -> bool</autodoc> |
f32fc4bc RD |
16702 | <paramlist> |
16703 | <param name="pageNum" type="int" default=""/> | |
16704 | </paramlist> | |
16705 | </method> | |
16706 | <method name="base_SetZoom" type="" overloaded="no"> | |
781d2982 | 16707 | <autodoc>base_SetZoom(self, int percent)</autodoc> |
f32fc4bc RD |
16708 | <paramlist> |
16709 | <param name="percent" type="int" default=""/> | |
16710 | </paramlist> | |
16711 | </method> | |
16712 | <method name="base_Print" type="bool" overloaded="no"> | |
781d2982 | 16713 | <autodoc>base_Print(self, bool interactive) -> bool</autodoc> |
f32fc4bc RD |
16714 | <paramlist> |
16715 | <param name="interactive" type="bool" default=""/> | |
16716 | </paramlist> | |
16717 | </method> | |
16718 | <method name="base_DetermineScaling" type="" overloaded="no"> | |
781d2982 | 16719 | <autodoc>base_DetermineScaling(self)</autodoc> |
f32fc4bc RD |
16720 | </method> |
16721 | </class> | |
781d2982 | 16722 | <class name="PyPreviewFrame" oldname="wxPyPreviewFrame" module="_windows"> |
f32fc4bc RD |
16723 | <baseclass name="PreviewFrame"/> |
16724 | <constructor name="PyPreviewFrame" overloaded="no"> | |
781d2982 | 16725 | <autodoc>__init__(self, PrintPreview preview, Frame parent, String title, Point pos=DefaultPosition, |
856bf319 RD |
16726 | Size size=DefaultSize, |
16727 | long style=DEFAULT_FRAME_STYLE, String name=FrameNameStr) -> PyPreviewFrame</autodoc> | |
f32fc4bc RD |
16728 | <paramlist> |
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"/> | |
16736 | </paramlist> | |
16737 | </constructor> | |
16738 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 16739 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
16740 | <paramlist> |
16741 | <param name="self" type="PyObject" default=""/> | |
16742 | <param name="_class" type="PyObject" default=""/> | |
16743 | </paramlist> | |
16744 | </method> | |
16745 | <method name="SetPreviewCanvas" type="" overloaded="no"> | |
781d2982 | 16746 | <autodoc>SetPreviewCanvas(self, PreviewCanvas canvas)</autodoc> |
f32fc4bc RD |
16747 | <paramlist> |
16748 | <param name="canvas" type="PreviewCanvas" default=""/> | |
16749 | </paramlist> | |
16750 | </method> | |
16751 | <method name="SetControlBar" type="" overloaded="no"> | |
781d2982 | 16752 | <autodoc>SetControlBar(self, PreviewControlBar bar)</autodoc> |
f32fc4bc RD |
16753 | <paramlist> |
16754 | <param name="bar" type="PreviewControlBar" default=""/> | |
16755 | </paramlist> | |
16756 | </method> | |
16757 | <method name="base_Initialize" type="" overloaded="no"> | |
781d2982 | 16758 | <autodoc>base_Initialize(self)</autodoc> |
f32fc4bc RD |
16759 | </method> |
16760 | <method name="base_CreateCanvas" type="" overloaded="no"> | |
781d2982 | 16761 | <autodoc>base_CreateCanvas(self)</autodoc> |
f32fc4bc RD |
16762 | </method> |
16763 | <method name="base_CreateControlBar" type="" overloaded="no"> | |
781d2982 | 16764 | <autodoc>base_CreateControlBar(self)</autodoc> |
f32fc4bc RD |
16765 | </method> |
16766 | </class> | |
781d2982 | 16767 | <class name="PyPreviewControlBar" oldname="wxPyPreviewControlBar" module="_windows"> |
f32fc4bc RD |
16768 | <baseclass name="PreviewControlBar"/> |
16769 | <constructor name="PyPreviewControlBar" overloaded="no"> | |
781d2982 | 16770 | <autodoc>__init__(self, PrintPreview preview, long buttons, Window parent, |
856bf319 RD |
16771 | Point pos=DefaultPosition, Size size=DefaultSize, |
16772 | long style=0, String name=PanelNameStr) -> PyPreviewControlBar</autodoc> | |
f32fc4bc RD |
16773 | <paramlist> |
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"/> | |
16781 | </paramlist> | |
16782 | </constructor> | |
16783 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 16784 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
16785 | <paramlist> |
16786 | <param name="self" type="PyObject" default=""/> | |
16787 | <param name="_class" type="PyObject" default=""/> | |
16788 | </paramlist> | |
16789 | </method> | |
16790 | <method name="SetPrintPreview" type="" overloaded="no"> | |
781d2982 | 16791 | <autodoc>SetPrintPreview(self, PrintPreview preview)</autodoc> |
f32fc4bc RD |
16792 | <paramlist> |
16793 | <param name="preview" type="PrintPreview" default=""/> | |
16794 | </paramlist> | |
16795 | </method> | |
16796 | <method name="base_CreateButtons" type="" overloaded="no"> | |
781d2982 | 16797 | <autodoc>base_CreateButtons(self)</autodoc> |
f32fc4bc RD |
16798 | </method> |
16799 | <method name="base_SetZoomControl" type="" overloaded="no"> | |
781d2982 | 16800 | <autodoc>base_SetZoomControl(self, int zoom)</autodoc> |
f32fc4bc RD |
16801 | <paramlist> |
16802 | <param name="zoom" type="int" default=""/> | |
16803 | </paramlist> | |
16804 | </method> | |
16805 | </class> | |
16806 | </module> | |
781d2982 RD |
16807 | <module name="_controls"> |
16808 | <import name="_core"/> | |
16809 | <pythoncode> wx = _core </pythoncode> | |
f32fc4bc | 16810 | <pythoncode> |
856bf319 RD |
16811 | #--------------------------------------------------------------------------- |
16812 | </pythoncode> | |
781d2982 | 16813 | <class name="Button" oldname="wxButton" module="_controls"> |
f32fc4bc | 16814 | <docstring>A button is a control that contains a text string, and is one of the most |
856bf319 | 16815 | common elements of a GUI. It may be placed on a dialog box or panel, or |
ce6878e6 RD |
16816 | indeed almost any other window. |
16817 | ||
16818 | Window Styles | |
16819 | ------------- | |
16820 | ============== ========================================== | |
16821 | wx.BU_LEFT Left-justifies the label. WIN32 only. | |
16822 | wx.BU_TOP Aligns the label to the top of the button. | |
16823 | WIN32 only. | |
16824 | wx.BU_RIGHT Right-justifies the bitmap label. WIN32 only. | |
16825 | wx.BU_BOTTOM Aligns the label to the bottom of the button. | |
16826 | WIN32 only. | |
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 | ============== ========================================== | |
16831 | ||
16832 | Events | |
16833 | ------ | |
16834 | ============ ========================================== | |
16835 | EVT_BUTTON Sent when the button is clicked. | |
16836 | ============ ========================================== | |
16837 | ||
16838 | :see: `wx.BitmapButton` | |
16839 | </docstring> | |
f32fc4bc RD |
16840 | <baseclass name="Control"/> |
16841 | <constructor name="Button" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
16846 | <docstring>Create and show a button.</docstring> |
16847 | <paramlist> | |
16848 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
16849 | <param name="id" type="int" default="-1"/> |
16850 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
16856 | </paramlist> | |
16857 | </constructor> | |
16858 | <constructor name="PreButton" overloaded="no"> | |
16859 | <autodoc>PreButton() -> Button</autodoc> | |
16860 | <docstring>Precreate a Button for 2-phase creation.</docstring> | |
16861 | </constructor> | |
16862 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
16867 | <docstring>Acutally create the GUI Button for 2-phase creation.</docstring> |
16868 | <paramlist> | |
16869 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
16870 | <param name="id" type="int" default="-1"/> |
16871 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
16877 | </paramlist> | |
16878 | </method> | |
16879 | <method name="SetDefault" type="" overloaded="no"> | |
781d2982 | 16880 | <autodoc>SetDefault(self)</autodoc> |
f32fc4bc RD |
16881 | <docstring>This sets the button to be the default item for the panel or dialog box.</docstring> |
16882 | </method> | |
16883 | <staticmethod name="GetDefaultSize" type="Size" overloaded="no"> | |
16884 | <autodoc>GetDefaultSize() -> Size</autodoc> | |
781d2982 RD |
16885 | <docstring>Returns the default button size for this platform.</docstring> |
16886 | </staticmethod> | |
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. | |
16894 | ||
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 | |
16898 | this.</docstring> | |
16899 | <paramlist> | |
16900 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
16901 | </paramlist> | |
f32fc4bc RD |
16902 | </staticmethod> |
16903 | </class> | |
781d2982 | 16904 | <class name="BitmapButton" oldname="wxBitmapButton" module="_controls"> |
f32fc4bc | 16905 | <docstring>A Button that contains a bitmap. A bitmap button can be supplied with a |
781d2982 | 16906 | single bitmap, and wxWidgets will draw all button states using this bitmap. If |
856bf319 | 16907 | the application needs more control, additional bitmaps for the selected state, |
ce6878e6 RD |
16908 | unpressed focused state, and greyed-out state may be supplied. |
16909 | ||
16910 | Window Styles | |
16911 | ------------- | |
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 | |
16921 | only. | |
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 | ============== ============================================= | |
16929 | ||
16930 | Events | |
16931 | ------ | |
16932 | =========== ================================== | |
16933 | EVT_BUTTON Sent when the button is clicked. | |
16934 | =========== ================================== | |
16935 | ||
16936 | :see: `wx.Button`, `wx.Bitmap` | |
16937 | </docstring> | |
f32fc4bc RD |
16938 | <baseclass name="Button"/> |
16939 | <constructor name="BitmapButton" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 16943 | String name=ButtonNameStr) -> BitmapButton</autodoc> |
f32fc4bc RD |
16944 | <docstring>Create and show a button with a bitmap for the label.</docstring> |
16945 | <paramlist> | |
16946 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
16947 | <param name="id" type="int" default="-1"/> |
16948 | <param name="bitmap" type="Bitmap" default="wxNullBitmap"/> | |
f32fc4bc RD |
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"/> | |
16954 | </paramlist> | |
16955 | </constructor> | |
16956 | <constructor name="PreBitmapButton" overloaded="no"> | |
16957 | <autodoc>PreBitmapButton() -> BitmapButton</autodoc> | |
16958 | <docstring>Precreate a BitmapButton for 2-phase creation.</docstring> | |
16959 | </constructor> | |
16960 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 16964 | String name=ButtonNameStr) -> bool</autodoc> |
f32fc4bc RD |
16965 | <docstring>Acutally create the GUI BitmapButton for 2-phase creation.</docstring> |
16966 | <paramlist> | |
16967 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
16968 | <param name="id" type="int" default="-1"/> |
16969 | <param name="bitmap" type="Bitmap" default="wxNullBitmap"/> | |
f32fc4bc RD |
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"/> | |
16975 | </paramlist> | |
16976 | </method> | |
16977 | <method name="GetBitmapLabel" type="Bitmap" overloaded="no"> | |
781d2982 | 16978 | <autodoc>GetBitmapLabel(self) -> Bitmap</autodoc> |
f32fc4bc RD |
16979 | <docstring>Returns the label bitmap (the one passed to the constructor).</docstring> |
16980 | </method> | |
16981 | <method name="GetBitmapDisabled" type="Bitmap" overloaded="no"> | |
781d2982 | 16982 | <autodoc>GetBitmapDisabled(self) -> Bitmap</autodoc> |
f32fc4bc RD |
16983 | <docstring>Returns the bitmap for the disabled state.</docstring> |
16984 | </method> | |
16985 | <method name="GetBitmapFocus" type="Bitmap" overloaded="no"> | |
781d2982 | 16986 | <autodoc>GetBitmapFocus(self) -> Bitmap</autodoc> |
f32fc4bc RD |
16987 | <docstring>Returns the bitmap for the focused state.</docstring> |
16988 | </method> | |
16989 | <method name="GetBitmapSelected" type="Bitmap" overloaded="no"> | |
781d2982 | 16990 | <autodoc>GetBitmapSelected(self) -> Bitmap</autodoc> |
f32fc4bc RD |
16991 | <docstring>Returns the bitmap for the selected state.</docstring> |
16992 | </method> | |
16993 | <method name="SetBitmapDisabled" type="" overloaded="no"> | |
781d2982 | 16994 | <autodoc>SetBitmapDisabled(self, Bitmap bitmap)</autodoc> |
f32fc4bc RD |
16995 | <docstring>Sets the bitmap for the disabled button appearance.</docstring> |
16996 | <paramlist> | |
16997 | <param name="bitmap" type="Bitmap" default=""/> | |
16998 | </paramlist> | |
16999 | </method> | |
17000 | <method name="SetBitmapFocus" type="" overloaded="no"> | |
781d2982 | 17001 | <autodoc>SetBitmapFocus(self, Bitmap bitmap)</autodoc> |
f32fc4bc RD |
17002 | <docstring>Sets the bitmap for the button appearance when it has the keyboard focus.</docstring> |
17003 | <paramlist> | |
17004 | <param name="bitmap" type="Bitmap" default=""/> | |
17005 | </paramlist> | |
17006 | </method> | |
17007 | <method name="SetBitmapSelected" type="" overloaded="no"> | |
781d2982 | 17008 | <autodoc>SetBitmapSelected(self, Bitmap bitmap)</autodoc> |
f32fc4bc RD |
17009 | <docstring>Sets the bitmap for the selected (depressed) button appearance.</docstring> |
17010 | <paramlist> | |
17011 | <param name="bitmap" type="Bitmap" default=""/> | |
17012 | </paramlist> | |
17013 | </method> | |
17014 | <method name="SetBitmapLabel" type="" overloaded="no"> | |
781d2982 | 17015 | <autodoc>SetBitmapLabel(self, Bitmap bitmap)</autodoc> |
f32fc4bc | 17016 | <docstring>Sets the bitmap label for the button. This is the bitmap used for the |
856bf319 | 17017 | unselected state, and for all other states if no other bitmaps are provided.</docstring> |
f32fc4bc RD |
17018 | <paramlist> |
17019 | <param name="bitmap" type="Bitmap" default=""/> | |
17020 | </paramlist> | |
17021 | </method> | |
17022 | <method name="SetMargins" type="" overloaded="no"> | |
781d2982 | 17023 | <autodoc>SetMargins(self, int x, int y)</autodoc> |
f32fc4bc RD |
17024 | <paramlist> |
17025 | <param name="x" type="int" default=""/> | |
17026 | <param name="y" type="int" default=""/> | |
17027 | </paramlist> | |
17028 | </method> | |
17029 | <method name="GetMarginX" type="int" overloaded="no"> | |
781d2982 | 17030 | <autodoc>GetMarginX(self) -> int</autodoc> |
f32fc4bc RD |
17031 | </method> |
17032 | <method name="GetMarginY" type="int" overloaded="no"> | |
781d2982 | 17033 | <autodoc>GetMarginY(self) -> int</autodoc> |
f32fc4bc RD |
17034 | </method> |
17035 | </class> | |
17036 | <pythoncode> | |
856bf319 RD |
17037 | #--------------------------------------------------------------------------- |
17038 | </pythoncode> | |
781d2982 RD |
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 | |
ce6878e6 RD |
17044 | Apply" state. |
17045 | ||
17046 | Window Styles | |
17047 | ------------- | |
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 | |
17058 | state by clicking. | |
17059 | wx.ALIGN_RIGHT Makes the | |
17060 | text appear on the left of | |
17061 | the checkbox. | |
17062 | ================================= =============================== | |
17063 | ||
17064 | Events | |
17065 | ------ | |
17066 | =============================== =============================== | |
17067 | EVT_CHECKBOX Sent when checkbox is clicked. | |
17068 | =============================== =============================== | |
17069 | </docstring> | |
f32fc4bc RD |
17070 | <baseclass name="Control"/> |
17071 | <constructor name="CheckBox" overloaded="no"> | |
781d2982 RD |
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> | |
c2dda882 | 17076 | <docstring>Creates and shows a CheckBox control</docstring> |
f32fc4bc RD |
17077 | <paramlist> |
17078 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17079 | <param name="id" type="int" default="-1"/> |
17080 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
17086 | </paramlist> | |
17087 | </constructor> | |
17088 | <constructor name="PreCheckBox" overloaded="no"> | |
17089 | <autodoc>PreCheckBox() -> CheckBox</autodoc> | |
c2dda882 | 17090 | <docstring>Precreate a CheckBox for 2-phase creation.</docstring> |
f32fc4bc RD |
17091 | </constructor> |
17092 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
c2dda882 | 17097 | <docstring>Actually create the GUI CheckBox for 2-phase creation.</docstring> |
f32fc4bc RD |
17098 | <paramlist> |
17099 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17100 | <param name="id" type="int" default="-1"/> |
17101 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
17107 | </paramlist> | |
17108 | </method> | |
17109 | <method name="GetValue" type="bool" overloaded="no"> | |
781d2982 | 17110 | <autodoc>GetValue(self) -> bool</autodoc> |
c2dda882 RD |
17111 | <docstring>Gets the state of a 2-state CheckBox. Returns True if it is checked, |
17112 | False otherwise.</docstring> | |
f32fc4bc RD |
17113 | </method> |
17114 | <method name="IsChecked" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17118 | </method> |
17119 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17123 | <paramlist> |
17124 | <param name="state" type="bool" default=""/> | |
17125 | </paramlist> | |
17126 | </method> | |
17127 | <method name="Get3StateValue" type="wxCheckBoxState" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17133 | </method> |
17134 | <method name="Set3StateValue" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17141 | <paramlist> |
17142 | <param name="state" type="wxCheckBoxState" default=""/> | |
17143 | </paramlist> | |
17144 | </method> | |
17145 | <method name="Is3State" type="bool" overloaded="no"> | |
781d2982 | 17146 | <autodoc>Is3State(self) -> bool</autodoc> |
c2dda882 | 17147 | <docstring>Returns whether or not the CheckBox is a 3-state CheckBox.</docstring> |
f32fc4bc RD |
17148 | </method> |
17149 | <method name="Is3rdStateAllowedForUser" type="bool" overloaded="no"> | |
781d2982 RD |
17150 | <autodoc>Is3rdStateAllowedForUser(self) -> bool</autodoc> |
17151 | <docstring>Returns whether or not the user can set the CheckBox to the third | |
17152 | state.</docstring> | |
f32fc4bc | 17153 | </method> |
781d2982 RD |
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. | |
17161 | ||
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 | |
17165 | this.</docstring> | |
17166 | <paramlist> | |
17167 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17168 | </paramlist> | |
17169 | </staticmethod> | |
f32fc4bc RD |
17170 | </class> |
17171 | <pythoncode> | |
856bf319 RD |
17172 | #--------------------------------------------------------------------------- |
17173 | </pythoncode> | |
781d2982 RD |
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 | |
ce6878e6 RD |
17177 | user pulls down the menu of choices. |
17178 | ||
17179 | Events | |
17180 | ------ | |
17181 | ================ ========================================== | |
17182 | EVT_CHOICE Sent when an item in the list is selected. | |
17183 | ================ ========================================== | |
17184 | </docstring> | |
f32fc4bc RD |
17185 | <baseclass name="ControlWithItems"/> |
17186 | <constructor name="Choice" overloaded="no"> | |
c2dda882 RD |
17187 | <autodoc>__init__(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, |
17188 | List choices=[], long style=0, Validator validator=DefaultValidator, | |
856bf319 | 17189 | String name=ChoiceNameStr) -> Choice</autodoc> |
c2dda882 | 17190 | <docstring>Create and show a Choice control</docstring> |
f32fc4bc RD |
17191 | <paramlist> |
17192 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17193 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17200 | </paramlist> | |
17201 | </constructor> | |
17202 | <constructor name="PreChoice" overloaded="no"> | |
17203 | <autodoc>PreChoice() -> Choice</autodoc> | |
c2dda882 | 17204 | <docstring>Precreate a Choice control for 2-phase creation.</docstring> |
f32fc4bc RD |
17205 | </constructor> |
17206 | <method name="Create" type="bool" overloaded="no"> | |
c2dda882 RD |
17207 | <autodoc>Create(Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, |
17208 | List choices=[], long style=0, Validator validator=DefaultValidator, | |
856bf319 | 17209 | String name=ChoiceNameStr) -> bool</autodoc> |
ce6878e6 | 17210 | <docstring>Actually create the GUI Choice control for 2-phase creation</docstring> |
f32fc4bc RD |
17211 | <paramlist> |
17212 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17213 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17220 | </paramlist> | |
17221 | </method> | |
f32fc4bc | 17222 | <method name="SetSelection" type="" overloaded="no"> |
781d2982 | 17223 | <autodoc>SetSelection(self, int n)</autodoc> |
c2dda882 | 17224 | <docstring>Select the n'th item (zero based) in the list.</docstring> |
f32fc4bc RD |
17225 | <paramlist> |
17226 | <param name="n" type="int" default=""/> | |
17227 | </paramlist> | |
17228 | </method> | |
781d2982 RD |
17229 | <method name="SetStringSelection" type="bool" overloaded="no"> |
17230 | <autodoc>SetStringSelection(self, String string) -> bool</autodoc> | |
c2dda882 | 17231 | <docstring>Select the item with the specifed string</docstring> |
f32fc4bc RD |
17232 | <paramlist> |
17233 | <param name="string" type="String" default=""/> | |
17234 | </paramlist> | |
17235 | </method> | |
17236 | <method name="SetString" type="" overloaded="no"> | |
781d2982 | 17237 | <autodoc>SetString(self, int n, String string)</autodoc> |
c2dda882 | 17238 | <docstring>Set the label for the n'th item (zero based) in the list.</docstring> |
f32fc4bc RD |
17239 | <paramlist> |
17240 | <param name="n" type="int" default=""/> | |
c2dda882 | 17241 | <param name="string" type="String" default=""/> |
f32fc4bc RD |
17242 | </paramlist> |
17243 | </method> | |
781d2982 RD |
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. | |
17251 | ||
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 | |
17255 | this.</docstring> | |
17256 | <paramlist> | |
17257 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17258 | </paramlist> | |
17259 | </staticmethod> | |
f32fc4bc RD |
17260 | </class> |
17261 | <pythoncode> | |
856bf319 RD |
17262 | #--------------------------------------------------------------------------- |
17263 | </pythoncode> | |
781d2982 RD |
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. | |
c2dda882 | 17268 | |
781d2982 | 17269 | A combobox permits a single selection only. Combobox items are |
ce6878e6 RD |
17270 | numbered from zero. |
17271 | ||
17272 | Styles | |
17273 | ------ | |
17274 | ================ =============================================== | |
17275 | wx.CB_SIMPLE Creates a combobox with a permanently | |
17276 | displayed list. Windows only. | |
17277 | ||
17278 | wx.CB_DROPDOWN Creates a combobox with a drop-down list. | |
17279 | ||
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. | |
17285 | ||
17286 | wx.CB_SORT Sorts the entries in the list alphabetically. | |
17287 | ================ =============================================== | |
17288 | ||
17289 | Events | |
17290 | ------- | |
17291 | ================ =============================================== | |
17292 | EVT_COMBOBOX Sent when an item on the list is selected. | |
17293 | EVT_TEXT Sent when the combobox text changes. | |
17294 | ================ =============================================== | |
17295 | </docstring> | |
f32fc4bc RD |
17296 | <baseclass name="Control"/> |
17297 | <baseclass name="ItemContainer"/> | |
17298 | <constructor name="ComboBox" overloaded="no"> | |
c2dda882 RD |
17299 | <autodoc>__init__(Window parent, int id, String value=EmptyString, |
17300 | Point pos=DefaultPosition, Size size=DefaultSize, | |
781d2982 RD |
17301 | List choices=[], long style=0, Validator validator=DefaultValidator, |
17302 | String name=ComboBoxNameStr) -> ComboBox</autodoc> | |
c2dda882 | 17303 | <docstring>Constructor, creates and shows a ComboBox control.</docstring> |
f32fc4bc RD |
17304 | <paramlist> |
17305 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17306 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17314 | </paramlist> | |
17315 | </constructor> | |
17316 | <constructor name="PreComboBox" overloaded="no"> | |
17317 | <autodoc>PreComboBox() -> ComboBox</autodoc> | |
c2dda882 | 17318 | <docstring>Precreate a ComboBox control for 2-phase creation.</docstring> |
f32fc4bc RD |
17319 | </constructor> |
17320 | <method name="Create" type="bool" overloaded="no"> | |
c2dda882 RD |
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> | |
ce6878e6 | 17325 | <docstring>Actually create the GUI wxComboBox control for 2-phase creation</docstring> |
f32fc4bc RD |
17326 | <paramlist> |
17327 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17328 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
c2dda882 | 17335 | <param name="name" type="String" default="wxPyChoiceNameStr"/> |
f32fc4bc RD |
17336 | </paramlist> |
17337 | </method> | |
17338 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 17339 | <autodoc>GetValue(self) -> String</autodoc> |
c2dda882 | 17340 | <docstring>Returns the current value in the combobox text field.</docstring> |
f32fc4bc RD |
17341 | </method> |
17342 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 17343 | <autodoc>SetValue(self, String value)</autodoc> |
f32fc4bc RD |
17344 | <paramlist> |
17345 | <param name="value" type="String" default=""/> | |
17346 | </paramlist> | |
17347 | </method> | |
17348 | <method name="Copy" type="" overloaded="no"> | |
781d2982 | 17349 | <autodoc>Copy(self)</autodoc> |
c2dda882 | 17350 | <docstring>Copies the selected text to the clipboard.</docstring> |
f32fc4bc RD |
17351 | </method> |
17352 | <method name="Cut" type="" overloaded="no"> | |
781d2982 | 17353 | <autodoc>Cut(self)</autodoc> |
c2dda882 | 17354 | <docstring>Copies the selected text to the clipboard and removes the selection.</docstring> |
f32fc4bc RD |
17355 | </method> |
17356 | <method name="Paste" type="" overloaded="no"> | |
781d2982 | 17357 | <autodoc>Paste(self)</autodoc> |
c2dda882 | 17358 | <docstring>Pastes text from the clipboard to the text field.</docstring> |
f32fc4bc RD |
17359 | </method> |
17360 | <method name="SetInsertionPoint" type="" overloaded="no"> | |
781d2982 | 17361 | <autodoc>SetInsertionPoint(self, long pos)</autodoc> |
c2dda882 | 17362 | <docstring>Sets the insertion point in the combobox text field.</docstring> |
f32fc4bc RD |
17363 | <paramlist> |
17364 | <param name="pos" type="long" default=""/> | |
17365 | </paramlist> | |
17366 | </method> | |
17367 | <method name="GetInsertionPoint" type="long" overloaded="no"> | |
781d2982 | 17368 | <autodoc>GetInsertionPoint(self) -> long</autodoc> |
c2dda882 | 17369 | <docstring>Returns the insertion point for the combobox's text field.</docstring> |
f32fc4bc RD |
17370 | </method> |
17371 | <method name="GetLastPosition" type="long" overloaded="no"> | |
781d2982 | 17372 | <autodoc>GetLastPosition(self) -> long</autodoc> |
c2dda882 | 17373 | <docstring>Returns the last position in the combobox text field.</docstring> |
f32fc4bc RD |
17374 | </method> |
17375 | <method name="Replace" type="" overloaded="no"> | |
781d2982 | 17376 | <autodoc>Replace(self, long from, long to, String value)</autodoc> |
c2dda882 RD |
17377 | <docstring>Replaces the text between two positions with the given text, in the |
17378 | combobox text field.</docstring> | |
f32fc4bc RD |
17379 | <paramlist> |
17380 | <param name="from" type="long" default=""/> | |
17381 | <param name="to" type="long" default=""/> | |
17382 | <param name="value" type="String" default=""/> | |
17383 | </paramlist> | |
17384 | </method> | |
17385 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 RD |
17386 | <autodoc>SetSelection(self, int n)</autodoc> |
17387 | <docstring>Sets the item at index 'n' to be the selected item.</docstring> | |
f32fc4bc RD |
17388 | <paramlist> |
17389 | <param name="n" type="int" default=""/> | |
17390 | </paramlist> | |
17391 | </method> | |
17392 | <method name="SetMark" type="" overloaded="no"> | |
781d2982 RD |
17393 | <autodoc>SetMark(self, long from, long to)</autodoc> |
17394 | <docstring>Selects the text between the two positions in the combobox text field.</docstring> | |
f32fc4bc RD |
17395 | <paramlist> |
17396 | <param name="from" type="long" default=""/> | |
17397 | <param name="to" type="long" default=""/> | |
17398 | </paramlist> | |
17399 | </method> | |
781d2982 RD |
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> | |
17403 | <paramlist> | |
17404 | <param name="string" type="String" default=""/> | |
17405 | </paramlist> | |
17406 | </method> | |
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> | |
17410 | <paramlist> | |
17411 | <param name="n" type="int" default=""/> | |
17412 | <param name="string" type="String" default=""/> | |
17413 | </paramlist> | |
17414 | </method> | |
f32fc4bc | 17415 | <method name="SetEditable" type="" overloaded="no"> |
781d2982 | 17416 | <autodoc>SetEditable(self, bool editable)</autodoc> |
f32fc4bc RD |
17417 | <paramlist> |
17418 | <param name="editable" type="bool" default=""/> | |
17419 | </paramlist> | |
17420 | </method> | |
17421 | <method name="SetInsertionPointEnd" type="" overloaded="no"> | |
781d2982 | 17422 | <autodoc>SetInsertionPointEnd(self)</autodoc> |
c2dda882 | 17423 | <docstring>Sets the insertion point at the end of the combobox text field.</docstring> |
f32fc4bc RD |
17424 | </method> |
17425 | <method name="Remove" type="" overloaded="no"> | |
781d2982 | 17426 | <autodoc>Remove(self, long from, long to)</autodoc> |
c2dda882 | 17427 | <docstring>Removes the text between the two positions in the combobox text field.</docstring> |
f32fc4bc RD |
17428 | <paramlist> |
17429 | <param name="from" type="long" default=""/> | |
17430 | <param name="to" type="long" default=""/> | |
17431 | </paramlist> | |
17432 | </method> | |
781d2982 RD |
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. | |
17440 | ||
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 | |
17444 | this.</docstring> | |
17445 | <paramlist> | |
17446 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17447 | </paramlist> | |
17448 | </staticmethod> | |
f32fc4bc RD |
17449 | </class> |
17450 | <pythoncode> | |
856bf319 RD |
17451 | #--------------------------------------------------------------------------- |
17452 | </pythoncode> | |
781d2982 | 17453 | <class name="Gauge" oldname="wxGauge" module="_controls"> |
f32fc4bc RD |
17454 | <baseclass name="Control"/> |
17455 | <constructor name="Gauge" overloaded="no"> | |
781d2982 | 17456 | <autodoc>__init__(self, Window parent, int id=-1, int range=100, Point pos=DefaultPosition, |
856bf319 RD |
17457 | Size size=DefaultSize, long style=GA_HORIZONTAL, |
17458 | Validator validator=DefaultValidator, | |
17459 | String name=GaugeNameStr) -> Gauge</autodoc> | |
f32fc4bc RD |
17460 | <paramlist> |
17461 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17462 | <param name="id" type="int" default="-1"/> |
17463 | <param name="range" type="int" default="100"/> | |
f32fc4bc RD |
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"/> | |
17469 | </paramlist> | |
17470 | </constructor> | |
17471 | <constructor name="PreGauge" overloaded="no"> | |
17472 | <autodoc>PreGauge() -> Gauge</autodoc> | |
17473 | </constructor> | |
17474 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 17475 | <autodoc>Create(self, Window parent, int id=-1, int range=100, Point pos=DefaultPosition, |
856bf319 RD |
17476 | Size size=DefaultSize, long style=GA_HORIZONTAL, |
17477 | Validator validator=DefaultValidator, | |
17478 | String name=GaugeNameStr) -> bool</autodoc> | |
f32fc4bc RD |
17479 | <paramlist> |
17480 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17481 | <param name="id" type="int" default="-1"/> |
17482 | <param name="range" type="int" default="100"/> | |
f32fc4bc RD |
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"/> | |
17488 | </paramlist> | |
17489 | </method> | |
17490 | <method name="SetRange" type="" overloaded="no"> | |
781d2982 | 17491 | <autodoc>SetRange(self, int range)</autodoc> |
f32fc4bc RD |
17492 | <paramlist> |
17493 | <param name="range" type="int" default=""/> | |
17494 | </paramlist> | |
17495 | </method> | |
17496 | <method name="GetRange" type="int" overloaded="no"> | |
781d2982 | 17497 | <autodoc>GetRange(self) -> int</autodoc> |
f32fc4bc RD |
17498 | </method> |
17499 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 17500 | <autodoc>SetValue(self, int pos)</autodoc> |
f32fc4bc RD |
17501 | <paramlist> |
17502 | <param name="pos" type="int" default=""/> | |
17503 | </paramlist> | |
17504 | </method> | |
17505 | <method name="GetValue" type="int" overloaded="no"> | |
781d2982 | 17506 | <autodoc>GetValue(self) -> int</autodoc> |
f32fc4bc RD |
17507 | </method> |
17508 | <method name="IsVertical" type="bool" overloaded="no"> | |
781d2982 | 17509 | <autodoc>IsVertical(self) -> bool</autodoc> |
f32fc4bc RD |
17510 | </method> |
17511 | <method name="SetShadowWidth" type="" overloaded="no"> | |
781d2982 | 17512 | <autodoc>SetShadowWidth(self, int w)</autodoc> |
f32fc4bc RD |
17513 | <paramlist> |
17514 | <param name="w" type="int" default=""/> | |
17515 | </paramlist> | |
17516 | </method> | |
17517 | <method name="GetShadowWidth" type="int" overloaded="no"> | |
781d2982 | 17518 | <autodoc>GetShadowWidth(self) -> int</autodoc> |
f32fc4bc RD |
17519 | </method> |
17520 | <method name="SetBezelFace" type="" overloaded="no"> | |
781d2982 | 17521 | <autodoc>SetBezelFace(self, int w)</autodoc> |
f32fc4bc RD |
17522 | <paramlist> |
17523 | <param name="w" type="int" default=""/> | |
17524 | </paramlist> | |
17525 | </method> | |
17526 | <method name="GetBezelFace" type="int" overloaded="no"> | |
781d2982 | 17527 | <autodoc>GetBezelFace(self) -> int</autodoc> |
f32fc4bc | 17528 | </method> |
781d2982 RD |
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. | |
17536 | ||
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 | |
17540 | this.</docstring> | |
17541 | <paramlist> | |
17542 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17543 | </paramlist> | |
17544 | </staticmethod> | |
f32fc4bc RD |
17545 | </class> |
17546 | <pythoncode> | |
856bf319 RD |
17547 | #--------------------------------------------------------------------------- |
17548 | </pythoncode> | |
781d2982 | 17549 | <class name="StaticBox" oldname="wxStaticBox" module="_controls"> |
f32fc4bc RD |
17550 | <baseclass name="Control"/> |
17551 | <constructor name="StaticBox" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17555 | <paramlist> |
17556 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17557 | <param name="id" type="int" default="-1"/> |
17558 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
17563 | </paramlist> | |
17564 | </constructor> | |
17565 | <constructor name="PreStaticBox" overloaded="no"> | |
17566 | <autodoc>PreStaticBox() -> StaticBox</autodoc> | |
17567 | </constructor> | |
17568 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17572 | <paramlist> |
17573 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17574 | <param name="id" type="int" default="-1"/> |
17575 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
17580 | </paramlist> | |
17581 | </method> | |
781d2982 RD |
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. | |
17589 | ||
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 | |
17593 | this.</docstring> | |
17594 | <paramlist> | |
17595 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17596 | </paramlist> | |
17597 | </staticmethod> | |
f32fc4bc RD |
17598 | </class> |
17599 | <pythoncode> | |
856bf319 RD |
17600 | #--------------------------------------------------------------------------- |
17601 | </pythoncode> | |
781d2982 | 17602 | <class name="StaticLine" oldname="wxStaticLine" module="_controls"> |
f32fc4bc RD |
17603 | <baseclass name="Control"/> |
17604 | <constructor name="StaticLine" overloaded="no"> | |
781d2982 RD |
17605 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
17606 | Size size=DefaultSize, long style=LI_HORIZONTAL, | |
856bf319 | 17607 | String name=StaticTextNameStr) -> StaticLine</autodoc> |
f32fc4bc RD |
17608 | <paramlist> |
17609 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17610 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17615 | </paramlist> | |
17616 | </constructor> | |
17617 | <constructor name="PreStaticLine" overloaded="no"> | |
17618 | <autodoc>PreStaticLine() -> StaticLine</autodoc> | |
17619 | </constructor> | |
17620 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
17621 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
17622 | Size size=DefaultSize, long style=LI_HORIZONTAL, | |
856bf319 | 17623 | String name=StaticTextNameStr) -> bool</autodoc> |
f32fc4bc RD |
17624 | <paramlist> |
17625 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17626 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17631 | </paramlist> | |
17632 | </method> | |
17633 | <method name="IsVertical" type="bool" overloaded="no"> | |
781d2982 | 17634 | <autodoc>IsVertical(self) -> bool</autodoc> |
f32fc4bc RD |
17635 | </method> |
17636 | <staticmethod name="GetDefaultSize" type="int" overloaded="no"> | |
17637 | <autodoc>GetDefaultSize() -> int</autodoc> | |
17638 | </staticmethod> | |
781d2982 RD |
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. | |
17646 | ||
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 | |
17650 | this.</docstring> | |
17651 | <paramlist> | |
17652 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17653 | </paramlist> | |
17654 | </staticmethod> | |
f32fc4bc RD |
17655 | </class> |
17656 | <pythoncode> | |
856bf319 RD |
17657 | #--------------------------------------------------------------------------- |
17658 | </pythoncode> | |
781d2982 | 17659 | <class name="StaticText" oldname="wxStaticText" module="_controls"> |
f32fc4bc RD |
17660 | <baseclass name="Control"/> |
17661 | <constructor name="StaticText" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17665 | <paramlist> |
17666 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17667 | <param name="id" type="int" default="-1"/> |
17668 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
17673 | </paramlist> | |
17674 | </constructor> | |
17675 | <constructor name="PreStaticText" overloaded="no"> | |
17676 | <autodoc>PreStaticText() -> StaticText</autodoc> | |
17677 | </constructor> | |
17678 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17682 | <paramlist> |
17683 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17684 | <param name="id" type="int" default="-1"/> |
17685 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
17690 | </paramlist> | |
17691 | </method> | |
781d2982 RD |
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. | |
17699 | ||
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 | |
17703 | this.</docstring> | |
17704 | <paramlist> | |
17705 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17706 | </paramlist> | |
17707 | </staticmethod> | |
f32fc4bc RD |
17708 | </class> |
17709 | <pythoncode> | |
856bf319 RD |
17710 | #--------------------------------------------------------------------------- |
17711 | </pythoncode> | |
781d2982 | 17712 | <class name="StaticBitmap" oldname="wxStaticBitmap" module="_controls"> |
f32fc4bc RD |
17713 | <baseclass name="Control"/> |
17714 | <constructor name="StaticBitmap" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17718 | <paramlist> |
17719 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17720 | <param name="id" type="int" default="-1"/> |
17721 | <param name="bitmap" type="Bitmap" default="wxNullBitmap"/> | |
f32fc4bc RD |
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"/> | |
17726 | </paramlist> | |
17727 | </constructor> | |
17728 | <constructor name="PreStaticBitmap" overloaded="no"> | |
17729 | <autodoc>PreStaticBitmap() -> StaticBitmap</autodoc> | |
17730 | </constructor> | |
17731 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
17735 | <paramlist> |
17736 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
17737 | <param name="id" type="int" default="-1"/> |
17738 | <param name="bitmap" type="Bitmap" default="wxNullBitmap"/> | |
f32fc4bc RD |
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"/> | |
17743 | </paramlist> | |
17744 | </method> | |
17745 | <method name="GetBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 17746 | <autodoc>GetBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
17747 | </method> |
17748 | <method name="SetBitmap" type="" overloaded="no"> | |
781d2982 | 17749 | <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc> |
f32fc4bc RD |
17750 | <paramlist> |
17751 | <param name="bitmap" type="Bitmap" default=""/> | |
17752 | </paramlist> | |
17753 | </method> | |
17754 | <method name="SetIcon" type="" overloaded="no"> | |
781d2982 | 17755 | <autodoc>SetIcon(self, Icon icon)</autodoc> |
f32fc4bc RD |
17756 | <paramlist> |
17757 | <param name="icon" type="Icon" default=""/> | |
17758 | </paramlist> | |
17759 | </method> | |
781d2982 RD |
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. | |
17767 | ||
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 | |
17771 | this.</docstring> | |
17772 | <paramlist> | |
17773 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17774 | </paramlist> | |
17775 | </staticmethod> | |
f32fc4bc RD |
17776 | </class> |
17777 | <pythoncode> | |
856bf319 RD |
17778 | #--------------------------------------------------------------------------- |
17779 | </pythoncode> | |
781d2982 | 17780 | <class name="ListBox" oldname="wxListBox" module="_controls"> |
f32fc4bc RD |
17781 | <baseclass name="ControlWithItems"/> |
17782 | <constructor name="ListBox" overloaded="no"> | |
781d2982 RD |
17783 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
17784 | Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, | |
856bf319 RD |
17785 | long style=0, Validator validator=DefaultValidator, |
17786 | String name=ListBoxNameStr) -> ListBox</autodoc> | |
f32fc4bc RD |
17787 | <paramlist> |
17788 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17789 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17796 | </paramlist> | |
17797 | </constructor> | |
17798 | <constructor name="PreListBox" overloaded="no"> | |
17799 | <autodoc>PreListBox() -> ListBox</autodoc> | |
17800 | </constructor> | |
17801 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
17802 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
17803 | Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, | |
856bf319 RD |
17804 | long style=0, Validator validator=DefaultValidator, |
17805 | String name=ListBoxNameStr) -> bool</autodoc> | |
f32fc4bc RD |
17806 | <paramlist> |
17807 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17808 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17815 | </paramlist> | |
17816 | </method> | |
17817 | <method name="Insert" type="" overloaded="no"> | |
781d2982 RD |
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, | |
c2dda882 | 17820 | optionally associating some data object with the item.</docstring> |
f32fc4bc RD |
17821 | <paramlist> |
17822 | <param name="item" type="String" default=""/> | |
17823 | <param name="pos" type="int" default=""/> | |
17824 | <param name="clientData" type="PyObject" default="NULL"/> | |
17825 | </paramlist> | |
17826 | </method> | |
17827 | <method name="InsertItems" type="" overloaded="no"> | |
781d2982 | 17828 | <autodoc>InsertItems(self, wxArrayString items, int pos)</autodoc> |
f32fc4bc RD |
17829 | <paramlist> |
17830 | <param name="items" type="wxArrayString" default=""/> | |
17831 | <param name="pos" type="int" default=""/> | |
17832 | </paramlist> | |
17833 | </method> | |
17834 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 17835 | <autodoc>Set(self, wxArrayString items)</autodoc> |
f32fc4bc RD |
17836 | <paramlist> |
17837 | <param name="items" type="wxArrayString" default=""/> | |
17838 | </paramlist> | |
17839 | </method> | |
17840 | <method name="IsSelected" type="bool" overloaded="no"> | |
781d2982 | 17841 | <autodoc>IsSelected(self, int n) -> bool</autodoc> |
f32fc4bc RD |
17842 | <paramlist> |
17843 | <param name="n" type="int" default=""/> | |
17844 | </paramlist> | |
17845 | </method> | |
17846 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 17847 | <autodoc>SetSelection(self, int n, bool select=True)</autodoc> |
f32fc4bc RD |
17848 | <paramlist> |
17849 | <param name="n" type="int" default=""/> | |
17850 | <param name="select" type="bool" default="True"/> | |
17851 | </paramlist> | |
17852 | </method> | |
17853 | <method name="Select" type="" overloaded="no"> | |
781d2982 | 17854 | <autodoc>Select(self, int n)</autodoc> |
c2dda882 | 17855 | <docstring>Sets the item at index 'n' to be the selected item.</docstring> |
f32fc4bc RD |
17856 | <paramlist> |
17857 | <param name="n" type="int" default=""/> | |
17858 | </paramlist> | |
17859 | </method> | |
17860 | <method name="Deselect" type="" overloaded="no"> | |
781d2982 | 17861 | <autodoc>Deselect(self, int n)</autodoc> |
f32fc4bc RD |
17862 | <paramlist> |
17863 | <param name="n" type="int" default=""/> | |
17864 | </paramlist> | |
17865 | </method> | |
17866 | <method name="DeselectAll" type="" overloaded="no"> | |
781d2982 | 17867 | <autodoc>DeselectAll(self, int itemToLeaveSelected=-1)</autodoc> |
f32fc4bc RD |
17868 | <paramlist> |
17869 | <param name="itemToLeaveSelected" type="int" default="-1"/> | |
17870 | </paramlist> | |
17871 | </method> | |
17872 | <method name="SetStringSelection" type="bool" overloaded="no"> | |
781d2982 | 17873 | <autodoc>SetStringSelection(self, String s, bool select=True) -> bool</autodoc> |
f32fc4bc RD |
17874 | <paramlist> |
17875 | <param name="s" type="String" default=""/> | |
17876 | <param name="select" type="bool" default="True"/> | |
17877 | </paramlist> | |
17878 | </method> | |
17879 | <method name="GetSelections" type="PyObject" overloaded="no"> | |
781d2982 | 17880 | <autodoc>GetSelections(self) -> PyObject</autodoc> |
f32fc4bc RD |
17881 | </method> |
17882 | <method name="SetFirstItem" type="" overloaded="no"> | |
781d2982 | 17883 | <autodoc>SetFirstItem(self, int n)</autodoc> |
f32fc4bc RD |
17884 | <paramlist> |
17885 | <param name="n" type="int" default=""/> | |
17886 | </paramlist> | |
17887 | </method> | |
17888 | <method name="SetFirstItemStr" type="" overloaded="no"> | |
781d2982 | 17889 | <autodoc>SetFirstItemStr(self, String s)</autodoc> |
f32fc4bc RD |
17890 | <paramlist> |
17891 | <param name="s" type="String" default=""/> | |
17892 | </paramlist> | |
17893 | </method> | |
17894 | <method name="EnsureVisible" type="" overloaded="no"> | |
781d2982 | 17895 | <autodoc>EnsureVisible(self, int n)</autodoc> |
f32fc4bc RD |
17896 | <paramlist> |
17897 | <param name="n" type="int" default=""/> | |
17898 | </paramlist> | |
17899 | </method> | |
17900 | <method name="AppendAndEnsureVisible" type="" overloaded="no"> | |
781d2982 | 17901 | <autodoc>AppendAndEnsureVisible(self, String s)</autodoc> |
f32fc4bc RD |
17902 | <paramlist> |
17903 | <param name="s" type="String" default=""/> | |
17904 | </paramlist> | |
17905 | </method> | |
17906 | <method name="IsSorted" type="bool" overloaded="no"> | |
781d2982 | 17907 | <autodoc>IsSorted(self) -> bool</autodoc> |
f32fc4bc RD |
17908 | </method> |
17909 | <method name="SetItemForegroundColour" type="" overloaded="no"> | |
781d2982 | 17910 | <autodoc>SetItemForegroundColour(self, int item, Colour c)</autodoc> |
f32fc4bc RD |
17911 | <paramlist> |
17912 | <param name="item" type="int" default=""/> | |
17913 | <param name="c" type="Colour" default=""/> | |
17914 | </paramlist> | |
17915 | </method> | |
17916 | <method name="SetItemBackgroundColour" type="" overloaded="no"> | |
781d2982 | 17917 | <autodoc>SetItemBackgroundColour(self, int item, Colour c)</autodoc> |
f32fc4bc RD |
17918 | <paramlist> |
17919 | <param name="item" type="int" default=""/> | |
17920 | <param name="c" type="Colour" default=""/> | |
17921 | </paramlist> | |
17922 | </method> | |
17923 | <method name="SetItemFont" type="" overloaded="no"> | |
781d2982 | 17924 | <autodoc>SetItemFont(self, int item, Font f)</autodoc> |
f32fc4bc RD |
17925 | <paramlist> |
17926 | <param name="item" type="int" default=""/> | |
17927 | <param name="f" type="Font" default=""/> | |
17928 | </paramlist> | |
17929 | </method> | |
781d2982 RD |
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. | |
17937 | ||
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 | |
17941 | this.</docstring> | |
17942 | <paramlist> | |
17943 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
17944 | </paramlist> | |
17945 | </staticmethod> | |
f32fc4bc RD |
17946 | </class> |
17947 | <pythoncode> | |
0f43fbdf RD |
17948 | #--------------------------------------------------------------------------- |
17949 | </pythoncode> | |
781d2982 | 17950 | <class name="CheckListBox" oldname="wxCheckListBox" module="_controls"> |
f32fc4bc RD |
17951 | <baseclass name="ListBox"/> |
17952 | <constructor name="CheckListBox" overloaded="no"> | |
781d2982 RD |
17953 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
17954 | Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, | |
856bf319 RD |
17955 | long style=0, Validator validator=DefaultValidator, |
17956 | String name=ListBoxNameStr) -> CheckListBox</autodoc> | |
f32fc4bc RD |
17957 | <paramlist> |
17958 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17959 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17966 | </paramlist> | |
17967 | </constructor> | |
17968 | <constructor name="PreCheckListBox" overloaded="no"> | |
17969 | <autodoc>PreCheckListBox() -> CheckListBox</autodoc> | |
17970 | </constructor> | |
17971 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
17972 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
17973 | Size size=DefaultSize, wxArrayString choices=wxPyEmptyStringArray, | |
856bf319 RD |
17974 | long style=0, Validator validator=DefaultValidator, |
17975 | String name=ListBoxNameStr) -> bool</autodoc> | |
f32fc4bc RD |
17976 | <paramlist> |
17977 | <param name="parent" type="Window" default=""/> | |
781d2982 | 17978 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
17985 | </paramlist> | |
17986 | </method> | |
17987 | <method name="IsChecked" type="bool" overloaded="no"> | |
781d2982 | 17988 | <autodoc>IsChecked(self, int index) -> bool</autodoc> |
f32fc4bc RD |
17989 | <paramlist> |
17990 | <param name="index" type="int" default=""/> | |
17991 | </paramlist> | |
17992 | </method> | |
17993 | <method name="Check" type="" overloaded="no"> | |
781d2982 | 17994 | <autodoc>Check(self, int index, int check=True)</autodoc> |
f32fc4bc RD |
17995 | <paramlist> |
17996 | <param name="index" type="int" default=""/> | |
17997 | <param name="check" type="int" default="True"/> | |
17998 | </paramlist> | |
17999 | </method> | |
18000 | <method name="GetItemHeight" type="int" overloaded="no"> | |
781d2982 | 18001 | <autodoc>GetItemHeight(self) -> int</autodoc> |
f32fc4bc RD |
18002 | </method> |
18003 | <method name="HitTest" type="int" overloaded="no"> | |
781d2982 | 18004 | <autodoc>HitTest(self, Point pt) -> int</autodoc> |
c2dda882 | 18005 | <docstring>Test where the given (in client coords) point lies</docstring> |
f32fc4bc RD |
18006 | <paramlist> |
18007 | <param name="pt" type="Point" default=""/> | |
18008 | </paramlist> | |
18009 | </method> | |
18010 | <method name="HitTestXY" type="int" overloaded="no"> | |
781d2982 | 18011 | <autodoc>HitTestXY(self, int x, int y) -> int</autodoc> |
c2dda882 | 18012 | <docstring>Test where the given (in client coords) point lies</docstring> |
f32fc4bc RD |
18013 | <paramlist> |
18014 | <param name="x" type="int" default=""/> | |
18015 | <param name="y" type="int" default=""/> | |
18016 | </paramlist> | |
18017 | </method> | |
18018 | </class> | |
18019 | <pythoncode> | |
0f43fbdf RD |
18020 | #--------------------------------------------------------------------------- |
18021 | </pythoncode> | |
781d2982 | 18022 | <class name="TextAttr" oldname="wxTextAttr" module="_controls"> |
ce6878e6 RD |
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> | |
f32fc4bc | 18026 | <paramlist> |
ce6878e6 | 18027 | <param name="colText" type="Colour" default="wxNullColour"/> |
f32fc4bc RD |
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"/> | |
18031 | </paramlist> | |
18032 | </constructor> | |
18033 | <destructor name="~wxTextAttr" overloaded="no"> | |
781d2982 | 18034 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
18035 | </destructor> |
18036 | <method name="Init" type="" overloaded="no"> | |
781d2982 | 18037 | <autodoc>Init(self)</autodoc> |
f32fc4bc RD |
18038 | </method> |
18039 | <method name="SetTextColour" type="" overloaded="no"> | |
781d2982 | 18040 | <autodoc>SetTextColour(self, Colour colText)</autodoc> |
f32fc4bc RD |
18041 | <paramlist> |
18042 | <param name="colText" type="Colour" default=""/> | |
18043 | </paramlist> | |
18044 | </method> | |
18045 | <method name="SetBackgroundColour" type="" overloaded="no"> | |
781d2982 | 18046 | <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc> |
f32fc4bc RD |
18047 | <paramlist> |
18048 | <param name="colBack" type="Colour" default=""/> | |
18049 | </paramlist> | |
18050 | </method> | |
18051 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 18052 | <autodoc>SetFont(self, Font font, long flags=TEXT_ATTR_FONT)</autodoc> |
f32fc4bc RD |
18053 | <paramlist> |
18054 | <param name="font" type="Font" default=""/> | |
18055 | <param name="flags" type="long" default="wxTEXT_ATTR_FONT"/> | |
18056 | </paramlist> | |
18057 | </method> | |
18058 | <method name="SetAlignment" type="" overloaded="no"> | |
781d2982 | 18059 | <autodoc>SetAlignment(self, int alignment)</autodoc> |
f32fc4bc RD |
18060 | <paramlist> |
18061 | <param name="alignment" type="wxTextAttrAlignment" default=""/> | |
18062 | </paramlist> | |
18063 | </method> | |
18064 | <method name="SetTabs" type="" overloaded="no"> | |
781d2982 | 18065 | <autodoc>SetTabs(self, wxArrayInt tabs)</autodoc> |
f32fc4bc RD |
18066 | <paramlist> |
18067 | <param name="tabs" type="wxArrayInt" default=""/> | |
18068 | </paramlist> | |
18069 | </method> | |
18070 | <method name="SetLeftIndent" type="" overloaded="no"> | |
781d2982 | 18071 | <autodoc>SetLeftIndent(self, int indent, int subIndent=0)</autodoc> |
f32fc4bc RD |
18072 | <paramlist> |
18073 | <param name="indent" type="int" default=""/> | |
781d2982 | 18074 | <param name="subIndent" type="int" default="0"/> |
f32fc4bc RD |
18075 | </paramlist> |
18076 | </method> | |
18077 | <method name="SetRightIndent" type="" overloaded="no"> | |
781d2982 | 18078 | <autodoc>SetRightIndent(self, int indent)</autodoc> |
f32fc4bc RD |
18079 | <paramlist> |
18080 | <param name="indent" type="int" default=""/> | |
18081 | </paramlist> | |
18082 | </method> | |
18083 | <method name="SetFlags" type="" overloaded="no"> | |
781d2982 | 18084 | <autodoc>SetFlags(self, long flags)</autodoc> |
f32fc4bc RD |
18085 | <paramlist> |
18086 | <param name="flags" type="long" default=""/> | |
18087 | </paramlist> | |
18088 | </method> | |
18089 | <method name="HasTextColour" type="bool" overloaded="no"> | |
781d2982 | 18090 | <autodoc>HasTextColour(self) -> bool</autodoc> |
f32fc4bc RD |
18091 | </method> |
18092 | <method name="HasBackgroundColour" type="bool" overloaded="no"> | |
781d2982 | 18093 | <autodoc>HasBackgroundColour(self) -> bool</autodoc> |
f32fc4bc RD |
18094 | </method> |
18095 | <method name="HasFont" type="bool" overloaded="no"> | |
781d2982 | 18096 | <autodoc>HasFont(self) -> bool</autodoc> |
f32fc4bc RD |
18097 | </method> |
18098 | <method name="HasAlignment" type="bool" overloaded="no"> | |
781d2982 | 18099 | <autodoc>HasAlignment(self) -> bool</autodoc> |
f32fc4bc RD |
18100 | </method> |
18101 | <method name="HasTabs" type="bool" overloaded="no"> | |
781d2982 | 18102 | <autodoc>HasTabs(self) -> bool</autodoc> |
f32fc4bc RD |
18103 | </method> |
18104 | <method name="HasLeftIndent" type="bool" overloaded="no"> | |
781d2982 | 18105 | <autodoc>HasLeftIndent(self) -> bool</autodoc> |
f32fc4bc RD |
18106 | </method> |
18107 | <method name="HasRightIndent" type="bool" overloaded="no"> | |
781d2982 | 18108 | <autodoc>HasRightIndent(self) -> bool</autodoc> |
f32fc4bc RD |
18109 | </method> |
18110 | <method name="HasFlag" type="bool" overloaded="no"> | |
781d2982 | 18111 | <autodoc>HasFlag(self, long flag) -> bool</autodoc> |
f32fc4bc RD |
18112 | <paramlist> |
18113 | <param name="flag" type="long" default=""/> | |
18114 | </paramlist> | |
18115 | </method> | |
18116 | <method name="GetTextColour" type="Colour" overloaded="no"> | |
781d2982 | 18117 | <autodoc>GetTextColour(self) -> Colour</autodoc> |
f32fc4bc RD |
18118 | </method> |
18119 | <method name="GetBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 18120 | <autodoc>GetBackgroundColour(self) -> Colour</autodoc> |
f32fc4bc RD |
18121 | </method> |
18122 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 18123 | <autodoc>GetFont(self) -> Font</autodoc> |
f32fc4bc RD |
18124 | </method> |
18125 | <method name="GetAlignment" type="wxTextAttrAlignment" overloaded="no"> | |
781d2982 | 18126 | <autodoc>GetAlignment(self) -> int</autodoc> |
f32fc4bc RD |
18127 | </method> |
18128 | <method name="GetTabs" type="wxArrayInt" overloaded="no"> | |
781d2982 | 18129 | <autodoc>GetTabs(self) -> wxArrayInt</autodoc> |
f32fc4bc RD |
18130 | </method> |
18131 | <method name="GetLeftIndent" type="long" overloaded="no"> | |
781d2982 RD |
18132 | <autodoc>GetLeftIndent(self) -> long</autodoc> |
18133 | </method> | |
18134 | <method name="GetLeftSubIndent" type="long" overloaded="no"> | |
18135 | <autodoc>GetLeftSubIndent(self) -> long</autodoc> | |
f32fc4bc RD |
18136 | </method> |
18137 | <method name="GetRightIndent" type="long" overloaded="no"> | |
781d2982 | 18138 | <autodoc>GetRightIndent(self) -> long</autodoc> |
f32fc4bc RD |
18139 | </method> |
18140 | <method name="GetFlags" type="long" overloaded="no"> | |
781d2982 | 18141 | <autodoc>GetFlags(self) -> long</autodoc> |
f32fc4bc RD |
18142 | </method> |
18143 | <method name="IsDefault" type="bool" overloaded="no"> | |
781d2982 | 18144 | <autodoc>IsDefault(self) -> bool</autodoc> |
f32fc4bc RD |
18145 | </method> |
18146 | <staticmethod name="Combine" type="TextAttr" overloaded="no"> | |
18147 | <autodoc>Combine(TextAttr attr, TextAttr attrDef, TextCtrl text) -> TextAttr</autodoc> | |
18148 | <paramlist> | |
18149 | <param name="attr" type="TextAttr" default=""/> | |
18150 | <param name="attrDef" type="TextAttr" default=""/> | |
18151 | <param name="text" type="wxTextCtrl" default=""/> | |
18152 | </paramlist> | |
18153 | </staticmethod> | |
18154 | </class> | |
781d2982 | 18155 | <class name="TextCtrl" oldname="wxTextCtrl" module="_controls"> |
f32fc4bc RD |
18156 | <baseclass name="Control"/> |
18157 | <constructor name="TextCtrl" overloaded="no"> | |
781d2982 RD |
18158 | <autodoc>__init__(self, Window parent, int id=-1, String value=EmptyString, |
18159 | Point pos=DefaultPosition, Size size=DefaultSize, | |
856bf319 RD |
18160 | long style=0, Validator validator=DefaultValidator, |
18161 | String name=TextCtrlNameStr) -> TextCtrl</autodoc> | |
f32fc4bc RD |
18162 | <paramlist> |
18163 | <param name="parent" type="Window" default=""/> | |
781d2982 | 18164 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
18171 | </paramlist> | |
18172 | </constructor> | |
18173 | <constructor name="PreTextCtrl" overloaded="no"> | |
18174 | <autodoc>PreTextCtrl() -> TextCtrl</autodoc> | |
18175 | </constructor> | |
18176 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
18177 | <autodoc>Create(self, Window parent, int id=-1, String value=EmptyString, |
18178 | Point pos=DefaultPosition, Size size=DefaultSize, | |
856bf319 RD |
18179 | long style=0, Validator validator=DefaultValidator, |
18180 | String name=TextCtrlNameStr) -> bool</autodoc> | |
f32fc4bc RD |
18181 | <paramlist> |
18182 | <param name="parent" type="Window" default=""/> | |
781d2982 | 18183 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
18190 | </paramlist> | |
18191 | </method> | |
18192 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 18193 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
18194 | </method> |
18195 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 18196 | <autodoc>SetValue(self, String value)</autodoc> |
f32fc4bc RD |
18197 | <paramlist> |
18198 | <param name="value" type="String" default=""/> | |
18199 | </paramlist> | |
18200 | </method> | |
18201 | <method name="GetRange" type="String" overloaded="no"> | |
781d2982 | 18202 | <autodoc>GetRange(self, long from, long to) -> String</autodoc> |
f32fc4bc RD |
18203 | <paramlist> |
18204 | <param name="from" type="long" default=""/> | |
18205 | <param name="to" type="long" default=""/> | |
18206 | </paramlist> | |
18207 | </method> | |
18208 | <method name="GetLineLength" type="int" overloaded="no"> | |
781d2982 | 18209 | <autodoc>GetLineLength(self, long lineNo) -> int</autodoc> |
f32fc4bc RD |
18210 | <paramlist> |
18211 | <param name="lineNo" type="long" default=""/> | |
18212 | </paramlist> | |
18213 | </method> | |
18214 | <method name="GetLineText" type="String" overloaded="no"> | |
781d2982 | 18215 | <autodoc>GetLineText(self, long lineNo) -> String</autodoc> |
f32fc4bc RD |
18216 | <paramlist> |
18217 | <param name="lineNo" type="long" default=""/> | |
18218 | </paramlist> | |
18219 | </method> | |
18220 | <method name="GetNumberOfLines" type="int" overloaded="no"> | |
781d2982 | 18221 | <autodoc>GetNumberOfLines(self) -> int</autodoc> |
f32fc4bc RD |
18222 | </method> |
18223 | <method name="IsModified" type="bool" overloaded="no"> | |
781d2982 | 18224 | <autodoc>IsModified(self) -> bool</autodoc> |
f32fc4bc RD |
18225 | </method> |
18226 | <method name="IsEditable" type="bool" overloaded="no"> | |
781d2982 | 18227 | <autodoc>IsEditable(self) -> bool</autodoc> |
f32fc4bc RD |
18228 | </method> |
18229 | <method name="IsSingleLine" type="bool" overloaded="no"> | |
781d2982 | 18230 | <autodoc>IsSingleLine(self) -> bool</autodoc> |
f32fc4bc RD |
18231 | </method> |
18232 | <method name="IsMultiLine" type="bool" overloaded="no"> | |
781d2982 | 18233 | <autodoc>IsMultiLine(self) -> bool</autodoc> |
f32fc4bc RD |
18234 | </method> |
18235 | <method name="GetSelection" type="" overloaded="no"> | |
18236 | <autodoc>GetSelection() -> (from, to)</autodoc> | |
ce6878e6 | 18237 | <docstring>If the return values from and to are the same, there is no selection.</docstring> |
f32fc4bc RD |
18238 | <paramlist> |
18239 | <param name="OUTPUT" type="long" default=""/> | |
18240 | <param name="OUTPUT" type="long" default=""/> | |
18241 | </paramlist> | |
18242 | </method> | |
18243 | <method name="GetStringSelection" type="String" overloaded="no"> | |
781d2982 | 18244 | <autodoc>GetStringSelection(self) -> String</autodoc> |
f32fc4bc RD |
18245 | </method> |
18246 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 18247 | <autodoc>Clear(self)</autodoc> |
f32fc4bc RD |
18248 | </method> |
18249 | <method name="Replace" type="" overloaded="no"> | |
781d2982 | 18250 | <autodoc>Replace(self, long from, long to, String value)</autodoc> |
f32fc4bc RD |
18251 | <paramlist> |
18252 | <param name="from" type="long" default=""/> | |
18253 | <param name="to" type="long" default=""/> | |
18254 | <param name="value" type="String" default=""/> | |
18255 | </paramlist> | |
18256 | </method> | |
18257 | <method name="Remove" type="" overloaded="no"> | |
781d2982 | 18258 | <autodoc>Remove(self, long from, long to)</autodoc> |
f32fc4bc RD |
18259 | <paramlist> |
18260 | <param name="from" type="long" default=""/> | |
18261 | <param name="to" type="long" default=""/> | |
18262 | </paramlist> | |
18263 | </method> | |
18264 | <method name="LoadFile" type="bool" overloaded="no"> | |
781d2982 | 18265 | <autodoc>LoadFile(self, String file) -> bool</autodoc> |
f32fc4bc RD |
18266 | <paramlist> |
18267 | <param name="file" type="String" default=""/> | |
18268 | </paramlist> | |
18269 | </method> | |
18270 | <method name="SaveFile" type="bool" overloaded="no"> | |
781d2982 | 18271 | <autodoc>SaveFile(self, String file=EmptyString) -> bool</autodoc> |
f32fc4bc RD |
18272 | <paramlist> |
18273 | <param name="file" type="String" default="wxPyEmptyString"/> | |
18274 | </paramlist> | |
18275 | </method> | |
18276 | <method name="MarkDirty" type="" overloaded="no"> | |
781d2982 | 18277 | <autodoc>MarkDirty(self)</autodoc> |
f32fc4bc RD |
18278 | </method> |
18279 | <method name="DiscardEdits" type="" overloaded="no"> | |
781d2982 | 18280 | <autodoc>DiscardEdits(self)</autodoc> |
f32fc4bc RD |
18281 | </method> |
18282 | <method name="SetMaxLength" type="" overloaded="no"> | |
781d2982 | 18283 | <autodoc>SetMaxLength(self, unsigned long len)</autodoc> |
f32fc4bc RD |
18284 | <paramlist> |
18285 | <param name="len" type="unsigned long" default=""/> | |
18286 | </paramlist> | |
18287 | </method> | |
18288 | <method name="WriteText" type="" overloaded="no"> | |
781d2982 | 18289 | <autodoc>WriteText(self, String text)</autodoc> |
f32fc4bc RD |
18290 | <paramlist> |
18291 | <param name="text" type="String" default=""/> | |
18292 | </paramlist> | |
18293 | </method> | |
18294 | <method name="AppendText" type="" overloaded="no"> | |
781d2982 | 18295 | <autodoc>AppendText(self, String text)</autodoc> |
f32fc4bc RD |
18296 | <paramlist> |
18297 | <param name="text" type="String" default=""/> | |
18298 | </paramlist> | |
18299 | </method> | |
18300 | <method name="EmulateKeyPress" type="bool" overloaded="no"> | |
781d2982 | 18301 | <autodoc>EmulateKeyPress(self, KeyEvent event) -> bool</autodoc> |
f32fc4bc RD |
18302 | <paramlist> |
18303 | <param name="event" type="KeyEvent" default=""/> | |
18304 | </paramlist> | |
18305 | </method> | |
18306 | <method name="SetStyle" type="bool" overloaded="no"> | |
781d2982 | 18307 | <autodoc>SetStyle(self, long start, long end, TextAttr style) -> bool</autodoc> |
f32fc4bc RD |
18308 | <paramlist> |
18309 | <param name="start" type="long" default=""/> | |
18310 | <param name="end" type="long" default=""/> | |
18311 | <param name="style" type="TextAttr" default=""/> | |
18312 | </paramlist> | |
18313 | </method> | |
18314 | <method name="GetStyle" type="bool" overloaded="no"> | |
781d2982 | 18315 | <autodoc>GetStyle(self, long position, TextAttr style) -> bool</autodoc> |
f32fc4bc RD |
18316 | <paramlist> |
18317 | <param name="position" type="long" default=""/> | |
18318 | <param name="style" type="TextAttr" default=""/> | |
18319 | </paramlist> | |
18320 | </method> | |
18321 | <method name="SetDefaultStyle" type="bool" overloaded="no"> | |
781d2982 | 18322 | <autodoc>SetDefaultStyle(self, TextAttr style) -> bool</autodoc> |
f32fc4bc RD |
18323 | <paramlist> |
18324 | <param name="style" type="TextAttr" default=""/> | |
18325 | </paramlist> | |
18326 | </method> | |
18327 | <method name="GetDefaultStyle" type="TextAttr" overloaded="no"> | |
781d2982 | 18328 | <autodoc>GetDefaultStyle(self) -> TextAttr</autodoc> |
f32fc4bc RD |
18329 | </method> |
18330 | <method name="XYToPosition" type="long" overloaded="no"> | |
781d2982 | 18331 | <autodoc>XYToPosition(self, long x, long y) -> long</autodoc> |
f32fc4bc RD |
18332 | <paramlist> |
18333 | <param name="x" type="long" default=""/> | |
18334 | <param name="y" type="long" default=""/> | |
18335 | </paramlist> | |
18336 | </method> | |
18337 | <method name="PositionToXY" type="" overloaded="no"> | |
18338 | <autodoc>PositionToXY(long pos) -> (x, y)</autodoc> | |
18339 | <paramlist> | |
18340 | <param name="pos" type="long" default=""/> | |
18341 | <param name="OUTPUT" type="long" default=""/> | |
18342 | <param name="OUTPUT" type="long" default=""/> | |
18343 | </paramlist> | |
18344 | </method> | |
18345 | <method name="ShowPosition" type="" overloaded="no"> | |
781d2982 | 18346 | <autodoc>ShowPosition(self, long pos)</autodoc> |
f32fc4bc RD |
18347 | <paramlist> |
18348 | <param name="pos" type="long" default=""/> | |
18349 | </paramlist> | |
18350 | </method> | |
18351 | <method name="HitTest" type="wxTextCtrlHitTestResult" overloaded="no"> | |
18352 | <autodoc>HitTest(Point pt) -> (result, row, col)</autodoc> | |
ce6878e6 RD |
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> | |
f32fc4bc RD |
18356 | <paramlist> |
18357 | <param name="pt" type="Point" default=""/> | |
18358 | <param name="OUTPUT" type="long" default=""/> | |
18359 | <param name="OUTPUT" type="long" default=""/> | |
18360 | </paramlist> | |
18361 | </method> | |
ce6878e6 RD |
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> | |
18367 | <paramlist> | |
18368 | <param name="pt" type="Point" default=""/> | |
18369 | <param name="OUTPUT" type="long" default=""/> | |
18370 | </paramlist> | |
18371 | </method> | |
f32fc4bc | 18372 | <method name="Copy" type="" overloaded="no"> |
781d2982 | 18373 | <autodoc>Copy(self)</autodoc> |
f32fc4bc RD |
18374 | </method> |
18375 | <method name="Cut" type="" overloaded="no"> | |
781d2982 | 18376 | <autodoc>Cut(self)</autodoc> |
f32fc4bc RD |
18377 | </method> |
18378 | <method name="Paste" type="" overloaded="no"> | |
781d2982 | 18379 | <autodoc>Paste(self)</autodoc> |
f32fc4bc RD |
18380 | </method> |
18381 | <method name="CanCopy" type="bool" overloaded="no"> | |
781d2982 | 18382 | <autodoc>CanCopy(self) -> bool</autodoc> |
f32fc4bc RD |
18383 | </method> |
18384 | <method name="CanCut" type="bool" overloaded="no"> | |
781d2982 | 18385 | <autodoc>CanCut(self) -> bool</autodoc> |
f32fc4bc RD |
18386 | </method> |
18387 | <method name="CanPaste" type="bool" overloaded="no"> | |
781d2982 | 18388 | <autodoc>CanPaste(self) -> bool</autodoc> |
f32fc4bc RD |
18389 | </method> |
18390 | <method name="Undo" type="" overloaded="no"> | |
781d2982 | 18391 | <autodoc>Undo(self)</autodoc> |
f32fc4bc RD |
18392 | </method> |
18393 | <method name="Redo" type="" overloaded="no"> | |
781d2982 | 18394 | <autodoc>Redo(self)</autodoc> |
f32fc4bc RD |
18395 | </method> |
18396 | <method name="CanUndo" type="bool" overloaded="no"> | |
781d2982 | 18397 | <autodoc>CanUndo(self) -> bool</autodoc> |
f32fc4bc RD |
18398 | </method> |
18399 | <method name="CanRedo" type="bool" overloaded="no"> | |
781d2982 | 18400 | <autodoc>CanRedo(self) -> bool</autodoc> |
f32fc4bc RD |
18401 | </method> |
18402 | <method name="SetInsertionPoint" type="" overloaded="no"> | |
781d2982 | 18403 | <autodoc>SetInsertionPoint(self, long pos)</autodoc> |
f32fc4bc RD |
18404 | <paramlist> |
18405 | <param name="pos" type="long" default=""/> | |
18406 | </paramlist> | |
18407 | </method> | |
18408 | <method name="SetInsertionPointEnd" type="" overloaded="no"> | |
781d2982 | 18409 | <autodoc>SetInsertionPointEnd(self)</autodoc> |
f32fc4bc RD |
18410 | </method> |
18411 | <method name="GetInsertionPoint" type="long" overloaded="no"> | |
781d2982 | 18412 | <autodoc>GetInsertionPoint(self) -> long</autodoc> |
f32fc4bc RD |
18413 | </method> |
18414 | <method name="GetLastPosition" type="long" overloaded="no"> | |
781d2982 | 18415 | <autodoc>GetLastPosition(self) -> long</autodoc> |
f32fc4bc RD |
18416 | </method> |
18417 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 18418 | <autodoc>SetSelection(self, long from, long to)</autodoc> |
f32fc4bc RD |
18419 | <paramlist> |
18420 | <param name="from" type="long" default=""/> | |
18421 | <param name="to" type="long" default=""/> | |
18422 | </paramlist> | |
18423 | </method> | |
18424 | <method name="SelectAll" type="" overloaded="no"> | |
781d2982 | 18425 | <autodoc>SelectAll(self)</autodoc> |
f32fc4bc RD |
18426 | </method> |
18427 | <method name="SetEditable" type="" overloaded="no"> | |
781d2982 | 18428 | <autodoc>SetEditable(self, bool editable)</autodoc> |
f32fc4bc RD |
18429 | <paramlist> |
18430 | <param name="editable" type="bool" default=""/> | |
18431 | </paramlist> | |
18432 | </method> | |
18433 | <method name="write" type="" overloaded="no"> | |
781d2982 | 18434 | <autodoc>write(self, String text)</autodoc> |
f32fc4bc RD |
18435 | <paramlist> |
18436 | <param name="text" type="String" default=""/> | |
18437 | </paramlist> | |
18438 | </method> | |
18439 | <method name="GetString" type="String" overloaded="no"> | |
781d2982 | 18440 | <autodoc>GetString(self, long from, long to) -> String</autodoc> |
f32fc4bc RD |
18441 | <paramlist> |
18442 | <param name="from" type="long" default=""/> | |
18443 | <param name="to" type="long" default=""/> | |
18444 | </paramlist> | |
18445 | </method> | |
781d2982 RD |
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. | |
18453 | ||
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 | |
18457 | this.</docstring> | |
18458 | <paramlist> | |
18459 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
18460 | </paramlist> | |
18461 | </staticmethod> | |
f32fc4bc | 18462 | </class> |
781d2982 | 18463 | <class name="TextUrlEvent" oldname="wxTextUrlEvent" module="_controls"> |
f32fc4bc RD |
18464 | <baseclass name="CommandEvent"/> |
18465 | <constructor name="TextUrlEvent" overloaded="no"> | |
781d2982 | 18466 | <autodoc>__init__(self, int winid, MouseEvent evtMouse, long start, long end) -> TextUrlEvent</autodoc> |
f32fc4bc RD |
18467 | <paramlist> |
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=""/> | |
18472 | </paramlist> | |
18473 | </constructor> | |
18474 | <method name="GetMouseEvent" type="MouseEvent" overloaded="no"> | |
781d2982 | 18475 | <autodoc>GetMouseEvent(self) -> MouseEvent</autodoc> |
f32fc4bc RD |
18476 | </method> |
18477 | <method name="GetURLStart" type="long" overloaded="no"> | |
781d2982 | 18478 | <autodoc>GetURLStart(self) -> long</autodoc> |
f32fc4bc RD |
18479 | </method> |
18480 | <method name="GetURLEnd" type="long" overloaded="no"> | |
781d2982 | 18481 | <autodoc>GetURLEnd(self) -> long</autodoc> |
f32fc4bc RD |
18482 | </method> |
18483 | </class> | |
18484 | <pythoncode> | |
856bf319 RD |
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) | |
18489 | </pythoncode> | |
f32fc4bc | 18490 | <pythoncode> |
856bf319 RD |
18491 | #--------------------------------------------------------------------------- |
18492 | </pythoncode> | |
781d2982 | 18493 | <class name="ScrollBar" oldname="wxScrollBar" module="_controls"> |
f32fc4bc RD |
18494 | <baseclass name="Control"/> |
18495 | <constructor name="ScrollBar" overloaded="no"> | |
781d2982 | 18496 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
856bf319 RD |
18497 | Size size=DefaultSize, long style=SB_HORIZONTAL, |
18498 | Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> ScrollBar</autodoc> | |
f32fc4bc RD |
18499 | <paramlist> |
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"/> | |
18507 | </paramlist> | |
18508 | </constructor> | |
18509 | <constructor name="PreScrollBar" overloaded="no"> | |
18510 | <autodoc>PreScrollBar() -> ScrollBar</autodoc> | |
18511 | </constructor> | |
18512 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 18513 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
856bf319 RD |
18514 | Size size=DefaultSize, long style=SB_HORIZONTAL, |
18515 | Validator validator=DefaultValidator, String name=ScrollBarNameStr) -> bool</autodoc> | |
c2dda882 | 18516 | <docstring>Do the 2nd phase and create the GUI control.</docstring> |
f32fc4bc RD |
18517 | <paramlist> |
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"/> | |
18525 | </paramlist> | |
18526 | </method> | |
18527 | <method name="GetThumbPosition" type="int" overloaded="no"> | |
781d2982 | 18528 | <autodoc>GetThumbPosition(self) -> int</autodoc> |
f32fc4bc RD |
18529 | </method> |
18530 | <method name="GetThumbSize" type="int" overloaded="no"> | |
781d2982 | 18531 | <autodoc>GetThumbSize(self) -> int</autodoc> |
f32fc4bc RD |
18532 | </method> |
18533 | <method name="GetPageSize" type="int" overloaded="no"> | |
781d2982 | 18534 | <autodoc>GetPageSize(self) -> int</autodoc> |
f32fc4bc RD |
18535 | </method> |
18536 | <method name="GetRange" type="int" overloaded="no"> | |
781d2982 | 18537 | <autodoc>GetRange(self) -> int</autodoc> |
f32fc4bc RD |
18538 | </method> |
18539 | <method name="IsVertical" type="bool" overloaded="no"> | |
781d2982 | 18540 | <autodoc>IsVertical(self) -> bool</autodoc> |
f32fc4bc RD |
18541 | </method> |
18542 | <method name="SetThumbPosition" type="" overloaded="no"> | |
781d2982 | 18543 | <autodoc>SetThumbPosition(self, int viewStart)</autodoc> |
f32fc4bc RD |
18544 | <paramlist> |
18545 | <param name="viewStart" type="int" default=""/> | |
18546 | </paramlist> | |
18547 | </method> | |
18548 | <method name="SetScrollbar" type="" overloaded="no"> | |
781d2982 | 18549 | <autodoc>SetScrollbar(self, int position, int thumbSize, int range, int pageSize, |
856bf319 | 18550 | bool refresh=True)</autodoc> |
ce6878e6 RD |
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. | |
18554 | ||
18555 | :param position: The position of the scrollbar in scroll units. | |
18556 | ||
18557 | :param thumbSize: The size of the thumb, or visible portion of the | |
18558 | scrollbar, in scroll units. | |
18559 | ||
18560 | :param range: The maximum position of the scrollbar. | |
18561 | ||
18562 | :param refresh: True to redraw the scrollbar, false otherwise. | |
18563 | </docstring> | |
f32fc4bc RD |
18564 | <paramlist> |
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"/> | |
18570 | </paramlist> | |
18571 | </method> | |
781d2982 RD |
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. | |
18579 | ||
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 | |
18583 | this.</docstring> | |
18584 | <paramlist> | |
18585 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
18586 | </paramlist> | |
18587 | </staticmethod> | |
f32fc4bc RD |
18588 | </class> |
18589 | <pythoncode> | |
0f43fbdf RD |
18590 | #--------------------------------------------------------------------------- |
18591 | </pythoncode> | |
781d2982 | 18592 | <class name="SpinButton" oldname="wxSpinButton" module="_controls"> |
f32fc4bc RD |
18593 | <baseclass name="Control"/> |
18594 | <constructor name="SpinButton" overloaded="no"> | |
781d2982 | 18595 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
856bf319 RD |
18596 | Size size=DefaultSize, long style=SP_HORIZONTAL, |
18597 | String name=SPIN_BUTTON_NAME) -> SpinButton</autodoc> | |
f32fc4bc RD |
18598 | <paramlist> |
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"/> | |
18605 | </paramlist> | |
18606 | </constructor> | |
18607 | <constructor name="PreSpinButton" overloaded="no"> | |
18608 | <autodoc>PreSpinButton() -> SpinButton</autodoc> | |
18609 | </constructor> | |
18610 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 18611 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
856bf319 RD |
18612 | Size size=DefaultSize, long style=SP_HORIZONTAL, |
18613 | String name=SPIN_BUTTON_NAME) -> bool</autodoc> | |
f32fc4bc RD |
18614 | <paramlist> |
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"/> | |
18621 | </paramlist> | |
18622 | </method> | |
18623 | <method name="GetValue" type="int" overloaded="no"> | |
781d2982 | 18624 | <autodoc>GetValue(self) -> int</autodoc> |
f32fc4bc RD |
18625 | </method> |
18626 | <method name="GetMin" type="int" overloaded="no"> | |
781d2982 | 18627 | <autodoc>GetMin(self) -> int</autodoc> |
f32fc4bc RD |
18628 | </method> |
18629 | <method name="GetMax" type="int" overloaded="no"> | |
781d2982 | 18630 | <autodoc>GetMax(self) -> int</autodoc> |
f32fc4bc RD |
18631 | </method> |
18632 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 18633 | <autodoc>SetValue(self, int val)</autodoc> |
f32fc4bc RD |
18634 | <paramlist> |
18635 | <param name="val" type="int" default=""/> | |
18636 | </paramlist> | |
18637 | </method> | |
18638 | <method name="SetMin" type="" overloaded="no"> | |
781d2982 | 18639 | <autodoc>SetMin(self, int minVal)</autodoc> |
f32fc4bc RD |
18640 | <paramlist> |
18641 | <param name="minVal" type="int" default=""/> | |
18642 | </paramlist> | |
18643 | </method> | |
18644 | <method name="SetMax" type="" overloaded="no"> | |
781d2982 | 18645 | <autodoc>SetMax(self, int maxVal)</autodoc> |
f32fc4bc RD |
18646 | <paramlist> |
18647 | <param name="maxVal" type="int" default=""/> | |
18648 | </paramlist> | |
18649 | </method> | |
18650 | <method name="SetRange" type="" overloaded="no"> | |
781d2982 | 18651 | <autodoc>SetRange(self, int minVal, int maxVal)</autodoc> |
f32fc4bc RD |
18652 | <paramlist> |
18653 | <param name="minVal" type="int" default=""/> | |
18654 | <param name="maxVal" type="int" default=""/> | |
18655 | </paramlist> | |
18656 | </method> | |
18657 | <method name="IsVertical" type="bool" overloaded="no"> | |
781d2982 | 18658 | <autodoc>IsVertical(self) -> bool</autodoc> |
f32fc4bc | 18659 | </method> |
781d2982 RD |
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. | |
18667 | ||
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 | |
18671 | this.</docstring> | |
18672 | <paramlist> | |
18673 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
18674 | </paramlist> | |
18675 | </staticmethod> | |
f32fc4bc | 18676 | </class> |
781d2982 | 18677 | <class name="SpinCtrl" oldname="wxSpinCtrl" module="_controls"> |
f32fc4bc RD |
18678 | <baseclass name="Control"/> |
18679 | <constructor name="SpinCtrl" overloaded="no"> | |
781d2982 | 18680 | <autodoc>__init__(self, Window parent, int id=-1, String value=EmptyString, |
856bf319 RD |
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> | |
f32fc4bc RD |
18684 | <paramlist> |
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"/> | |
18695 | </paramlist> | |
18696 | </constructor> | |
18697 | <constructor name="PreSpinCtrl" overloaded="no"> | |
18698 | <autodoc>PreSpinCtrl() -> SpinCtrl</autodoc> | |
18699 | </constructor> | |
18700 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 18701 | <autodoc>Create(self, Window parent, int id=-1, String value=EmptyString, |
856bf319 RD |
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> | |
f32fc4bc RD |
18705 | <paramlist> |
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"/> | |
18716 | </paramlist> | |
18717 | </method> | |
18718 | <method name="GetValue" type="int" overloaded="no"> | |
781d2982 | 18719 | <autodoc>GetValue(self) -> int</autodoc> |
f32fc4bc RD |
18720 | </method> |
18721 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 18722 | <autodoc>SetValue(self, int value)</autodoc> |
f32fc4bc RD |
18723 | <paramlist> |
18724 | <param name="value" type="int" default=""/> | |
18725 | </paramlist> | |
18726 | </method> | |
18727 | <method name="SetValueString" type="" overloaded="no"> | |
781d2982 | 18728 | <autodoc>SetValueString(self, String text)</autodoc> |
f32fc4bc RD |
18729 | <paramlist> |
18730 | <param name="text" type="String" default=""/> | |
18731 | </paramlist> | |
18732 | </method> | |
18733 | <method name="SetRange" type="" overloaded="no"> | |
781d2982 | 18734 | <autodoc>SetRange(self, int minVal, int maxVal)</autodoc> |
f32fc4bc RD |
18735 | <paramlist> |
18736 | <param name="minVal" type="int" default=""/> | |
18737 | <param name="maxVal" type="int" default=""/> | |
18738 | </paramlist> | |
18739 | </method> | |
18740 | <method name="GetMin" type="int" overloaded="no"> | |
781d2982 | 18741 | <autodoc>GetMin(self) -> int</autodoc> |
f32fc4bc RD |
18742 | </method> |
18743 | <method name="GetMax" type="int" overloaded="no"> | |
781d2982 | 18744 | <autodoc>GetMax(self) -> int</autodoc> |
f32fc4bc RD |
18745 | </method> |
18746 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 18747 | <autodoc>SetSelection(self, long from, long to)</autodoc> |
f32fc4bc RD |
18748 | <paramlist> |
18749 | <param name="from" type="long" default=""/> | |
18750 | <param name="to" type="long" default=""/> | |
18751 | </paramlist> | |
18752 | </method> | |
781d2982 RD |
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. | |
18760 | ||
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 | |
18764 | this.</docstring> | |
18765 | <paramlist> | |
18766 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
18767 | </paramlist> | |
18768 | </staticmethod> | |
f32fc4bc | 18769 | </class> |
781d2982 | 18770 | <class name="SpinEvent" oldname="wxSpinEvent" module="_controls"> |
f32fc4bc RD |
18771 | <baseclass name="NotifyEvent"/> |
18772 | <constructor name="SpinEvent" overloaded="no"> | |
781d2982 | 18773 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> SpinEvent</autodoc> |
f32fc4bc RD |
18774 | <paramlist> |
18775 | <param name="commandType" type="wxEventType" default="wxEVT_NULL"/> | |
18776 | <param name="winid" type="int" default="0"/> | |
18777 | </paramlist> | |
18778 | </constructor> | |
18779 | <method name="GetPosition" type="int" overloaded="no"> | |
781d2982 | 18780 | <autodoc>GetPosition(self) -> int</autodoc> |
f32fc4bc RD |
18781 | </method> |
18782 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 18783 | <autodoc>SetPosition(self, int pos)</autodoc> |
f32fc4bc RD |
18784 | <paramlist> |
18785 | <param name="pos" type="int" default=""/> | |
18786 | </paramlist> | |
18787 | </method> | |
18788 | </class> | |
18789 | <pythoncode> | |
856bf319 RD |
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) | |
18794 | </pythoncode> | |
f32fc4bc | 18795 | <pythoncode> |
0f43fbdf RD |
18796 | #--------------------------------------------------------------------------- |
18797 | </pythoncode> | |
781d2982 | 18798 | <class name="RadioBox" oldname="wxRadioBox" module="_controls"> |
f32fc4bc RD |
18799 | <baseclass name="Control"/> |
18800 | <constructor name="RadioBox" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 18806 | String name=RadioBoxNameStr) -> RadioBox</autodoc> |
f32fc4bc RD |
18807 | <paramlist> |
18808 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
18809 | <param name="id" type="int" default="-1"/> |
18810 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
18818 | </paramlist> | |
18819 | </constructor> | |
18820 | <constructor name="PreRadioBox" overloaded="no"> | |
18821 | <autodoc>PreRadioBox() -> RadioBox</autodoc> | |
18822 | </constructor> | |
18823 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 18829 | String name=RadioBoxNameStr) -> bool</autodoc> |
f32fc4bc | 18830 | <paramlist> |
781d2982 RD |
18831 | <param name="parent" type="Window" default=""/> |
18832 | <param name="id" type="int" default="-1"/> | |
18833 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
18841 | </paramlist> | |
18842 | </method> | |
18843 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 18844 | <autodoc>SetSelection(self, int n)</autodoc> |
f32fc4bc RD |
18845 | <paramlist> |
18846 | <param name="n" type="int" default=""/> | |
18847 | </paramlist> | |
18848 | </method> | |
18849 | <method name="GetSelection" type="int" overloaded="no"> | |
781d2982 | 18850 | <autodoc>GetSelection(self) -> int</autodoc> |
f32fc4bc RD |
18851 | </method> |
18852 | <method name="GetStringSelection" type="String" overloaded="no"> | |
781d2982 | 18853 | <autodoc>GetStringSelection(self) -> String</autodoc> |
f32fc4bc RD |
18854 | </method> |
18855 | <method name="SetStringSelection" type="bool" overloaded="no"> | |
781d2982 | 18856 | <autodoc>SetStringSelection(self, String s) -> bool</autodoc> |
f32fc4bc RD |
18857 | <paramlist> |
18858 | <param name="s" type="String" default=""/> | |
18859 | </paramlist> | |
18860 | </method> | |
18861 | <method name="GetCount" type="int" overloaded="no"> | |
781d2982 | 18862 | <autodoc>GetCount(self) -> int</autodoc> |
f32fc4bc RD |
18863 | </method> |
18864 | <method name="FindString" type="int" overloaded="no"> | |
781d2982 | 18865 | <autodoc>FindString(self, String s) -> int</autodoc> |
f32fc4bc RD |
18866 | <paramlist> |
18867 | <param name="s" type="String" default=""/> | |
18868 | </paramlist> | |
18869 | </method> | |
18870 | <method name="GetString" type="String" overloaded="no"> | |
781d2982 | 18871 | <autodoc>GetString(self, int n) -> String</autodoc> |
f32fc4bc RD |
18872 | <paramlist> |
18873 | <param name="n" type="int" default=""/> | |
18874 | </paramlist> | |
18875 | </method> | |
18876 | <method name="SetString" type="" overloaded="no"> | |
781d2982 | 18877 | <autodoc>SetString(self, int n, String label)</autodoc> |
f32fc4bc RD |
18878 | <paramlist> |
18879 | <param name="n" type="int" default=""/> | |
18880 | <param name="label" type="String" default=""/> | |
18881 | </paramlist> | |
18882 | </method> | |
18883 | <method name="EnableItem" type="" overloaded="no"> | |
781d2982 | 18884 | <autodoc>EnableItem(self, int n, bool enable=True)</autodoc> |
f32fc4bc RD |
18885 | <paramlist> |
18886 | <param name="n" type="int" default=""/> | |
18887 | <param name="enable" type="bool" default="True"/> | |
18888 | </paramlist> | |
18889 | </method> | |
18890 | <method name="ShowItem" type="" overloaded="no"> | |
781d2982 | 18891 | <autodoc>ShowItem(self, int n, bool show=True)</autodoc> |
f32fc4bc RD |
18892 | <paramlist> |
18893 | <param name="n" type="int" default=""/> | |
18894 | <param name="show" type="bool" default="True"/> | |
18895 | </paramlist> | |
18896 | </method> | |
18897 | <method name="GetColumnCount" type="int" overloaded="no"> | |
781d2982 | 18898 | <autodoc>GetColumnCount(self) -> int</autodoc> |
f32fc4bc RD |
18899 | </method> |
18900 | <method name="GetRowCount" type="int" overloaded="no"> | |
781d2982 | 18901 | <autodoc>GetRowCount(self) -> int</autodoc> |
f32fc4bc RD |
18902 | </method> |
18903 | <method name="GetNextItem" type="int" overloaded="no"> | |
781d2982 | 18904 | <autodoc>GetNextItem(self, int item, int dir, long style) -> int</autodoc> |
f32fc4bc RD |
18905 | <paramlist> |
18906 | <param name="item" type="int" default=""/> | |
18907 | <param name="dir" type="wxDirection" default=""/> | |
18908 | <param name="style" type="long" default=""/> | |
18909 | </paramlist> | |
18910 | </method> | |
781d2982 RD |
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. | |
18918 | ||
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 | |
18922 | this.</docstring> | |
18923 | <paramlist> | |
18924 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
18925 | </paramlist> | |
18926 | </staticmethod> | |
f32fc4bc RD |
18927 | </class> |
18928 | <pythoncode> | |
0f43fbdf RD |
18929 | #--------------------------------------------------------------------------- |
18930 | </pythoncode> | |
781d2982 | 18931 | <class name="RadioButton" oldname="wxRadioButton" module="_controls"> |
f32fc4bc RD |
18932 | <baseclass name="Control"/> |
18933 | <constructor name="RadioButton" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
18938 | <paramlist> |
18939 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
18940 | <param name="id" type="int" default="-1"/> |
18941 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
18947 | </paramlist> | |
18948 | </constructor> | |
18949 | <constructor name="PreRadioButton" overloaded="no"> | |
18950 | <autodoc>PreRadioButton() -> RadioButton</autodoc> | |
18951 | </constructor> | |
18952 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
18957 | <paramlist> |
18958 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
18959 | <param name="id" type="int" default="-1"/> |
18960 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
18966 | </paramlist> | |
18967 | </method> | |
18968 | <method name="GetValue" type="bool" overloaded="no"> | |
781d2982 | 18969 | <autodoc>GetValue(self) -> bool</autodoc> |
f32fc4bc RD |
18970 | </method> |
18971 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 18972 | <autodoc>SetValue(self, bool value)</autodoc> |
f32fc4bc RD |
18973 | <paramlist> |
18974 | <param name="value" type="bool" default=""/> | |
18975 | </paramlist> | |
18976 | </method> | |
781d2982 RD |
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. | |
18984 | ||
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 | |
18988 | this.</docstring> | |
18989 | <paramlist> | |
18990 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
18991 | </paramlist> | |
18992 | </staticmethod> | |
f32fc4bc RD |
18993 | </class> |
18994 | <pythoncode> | |
0f43fbdf RD |
18995 | #--------------------------------------------------------------------------- |
18996 | </pythoncode> | |
781d2982 | 18997 | <class name="Slider" oldname="wxSlider" module="_controls"> |
f32fc4bc RD |
18998 | <baseclass name="Control"/> |
18999 | <constructor name="Slider" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 19004 | String name=SliderNameStr) -> Slider</autodoc> |
f32fc4bc RD |
19005 | <paramlist> |
19006 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
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"/> | |
f32fc4bc RD |
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"/> | |
19016 | </paramlist> | |
19017 | </constructor> | |
19018 | <constructor name="PreSlider" overloaded="no"> | |
19019 | <autodoc>PreSlider() -> Slider</autodoc> | |
19020 | </constructor> | |
19021 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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, | |
856bf319 | 19026 | String name=SliderNameStr) -> bool</autodoc> |
f32fc4bc RD |
19027 | <paramlist> |
19028 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
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"/> | |
f32fc4bc RD |
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"/> | |
19038 | </paramlist> | |
19039 | </method> | |
19040 | <method name="GetValue" type="int" overloaded="no"> | |
781d2982 | 19041 | <autodoc>GetValue(self) -> int</autodoc> |
f32fc4bc RD |
19042 | </method> |
19043 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 19044 | <autodoc>SetValue(self, int value)</autodoc> |
f32fc4bc RD |
19045 | <paramlist> |
19046 | <param name="value" type="int" default=""/> | |
19047 | </paramlist> | |
19048 | </method> | |
19049 | <method name="SetRange" type="" overloaded="no"> | |
781d2982 | 19050 | <autodoc>SetRange(self, int minValue, int maxValue)</autodoc> |
f32fc4bc RD |
19051 | <paramlist> |
19052 | <param name="minValue" type="int" default=""/> | |
19053 | <param name="maxValue" type="int" default=""/> | |
19054 | </paramlist> | |
19055 | </method> | |
19056 | <method name="GetMin" type="int" overloaded="no"> | |
781d2982 | 19057 | <autodoc>GetMin(self) -> int</autodoc> |
f32fc4bc RD |
19058 | </method> |
19059 | <method name="GetMax" type="int" overloaded="no"> | |
781d2982 | 19060 | <autodoc>GetMax(self) -> int</autodoc> |
f32fc4bc RD |
19061 | </method> |
19062 | <method name="SetMin" type="" overloaded="no"> | |
781d2982 | 19063 | <autodoc>SetMin(self, int minValue)</autodoc> |
f32fc4bc RD |
19064 | <paramlist> |
19065 | <param name="minValue" type="int" default=""/> | |
19066 | </paramlist> | |
19067 | </method> | |
19068 | <method name="SetMax" type="" overloaded="no"> | |
781d2982 | 19069 | <autodoc>SetMax(self, int maxValue)</autodoc> |
f32fc4bc RD |
19070 | <paramlist> |
19071 | <param name="maxValue" type="int" default=""/> | |
19072 | </paramlist> | |
19073 | </method> | |
19074 | <method name="SetLineSize" type="" overloaded="no"> | |
781d2982 | 19075 | <autodoc>SetLineSize(self, int lineSize)</autodoc> |
f32fc4bc RD |
19076 | <paramlist> |
19077 | <param name="lineSize" type="int" default=""/> | |
19078 | </paramlist> | |
19079 | </method> | |
19080 | <method name="SetPageSize" type="" overloaded="no"> | |
781d2982 | 19081 | <autodoc>SetPageSize(self, int pageSize)</autodoc> |
f32fc4bc RD |
19082 | <paramlist> |
19083 | <param name="pageSize" type="int" default=""/> | |
19084 | </paramlist> | |
19085 | </method> | |
19086 | <method name="GetLineSize" type="int" overloaded="no"> | |
781d2982 | 19087 | <autodoc>GetLineSize(self) -> int</autodoc> |
f32fc4bc RD |
19088 | </method> |
19089 | <method name="GetPageSize" type="int" overloaded="no"> | |
781d2982 | 19090 | <autodoc>GetPageSize(self) -> int</autodoc> |
f32fc4bc RD |
19091 | </method> |
19092 | <method name="SetThumbLength" type="" overloaded="no"> | |
781d2982 | 19093 | <autodoc>SetThumbLength(self, int lenPixels)</autodoc> |
f32fc4bc RD |
19094 | <paramlist> |
19095 | <param name="lenPixels" type="int" default=""/> | |
19096 | </paramlist> | |
19097 | </method> | |
19098 | <method name="GetThumbLength" type="int" overloaded="no"> | |
781d2982 | 19099 | <autodoc>GetThumbLength(self) -> int</autodoc> |
f32fc4bc RD |
19100 | </method> |
19101 | <method name="SetTickFreq" type="" overloaded="no"> | |
781d2982 | 19102 | <autodoc>SetTickFreq(self, int n, int pos=1)</autodoc> |
f32fc4bc RD |
19103 | <paramlist> |
19104 | <param name="n" type="int" default=""/> | |
19105 | <param name="pos" type="int" default="1"/> | |
19106 | </paramlist> | |
19107 | </method> | |
19108 | <method name="GetTickFreq" type="int" overloaded="no"> | |
781d2982 | 19109 | <autodoc>GetTickFreq(self) -> int</autodoc> |
f32fc4bc RD |
19110 | </method> |
19111 | <method name="ClearTicks" type="" overloaded="no"> | |
781d2982 | 19112 | <autodoc>ClearTicks(self)</autodoc> |
f32fc4bc RD |
19113 | </method> |
19114 | <method name="SetTick" type="" overloaded="no"> | |
781d2982 | 19115 | <autodoc>SetTick(self, int tickPos)</autodoc> |
f32fc4bc RD |
19116 | <paramlist> |
19117 | <param name="tickPos" type="int" default=""/> | |
19118 | </paramlist> | |
19119 | </method> | |
19120 | <method name="ClearSel" type="" overloaded="no"> | |
781d2982 | 19121 | <autodoc>ClearSel(self)</autodoc> |
f32fc4bc RD |
19122 | </method> |
19123 | <method name="GetSelEnd" type="int" overloaded="no"> | |
781d2982 | 19124 | <autodoc>GetSelEnd(self) -> int</autodoc> |
f32fc4bc RD |
19125 | </method> |
19126 | <method name="GetSelStart" type="int" overloaded="no"> | |
781d2982 | 19127 | <autodoc>GetSelStart(self) -> int</autodoc> |
f32fc4bc RD |
19128 | </method> |
19129 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 19130 | <autodoc>SetSelection(self, int min, int max)</autodoc> |
f32fc4bc RD |
19131 | <paramlist> |
19132 | <param name="min" type="int" default=""/> | |
19133 | <param name="max" type="int" default=""/> | |
19134 | </paramlist> | |
19135 | </method> | |
781d2982 RD |
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. | |
19143 | ||
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 | |
19147 | this.</docstring> | |
19148 | <paramlist> | |
19149 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
19150 | </paramlist> | |
19151 | </staticmethod> | |
f32fc4bc RD |
19152 | </class> |
19153 | <pythoncode> | |
0f43fbdf RD |
19154 | #--------------------------------------------------------------------------- |
19155 | </pythoncode> | |
f32fc4bc | 19156 | <pythoncode> |
856bf319 | 19157 | EVT_TOGGLEBUTTON = wx.PyEventBinder( wxEVT_COMMAND_TOGGLEBUTTON_CLICKED, 1) |
0f43fbdf | 19158 | </pythoncode> |
781d2982 | 19159 | <class name="ToggleButton" oldname="wxToggleButton" module="_controls"> |
f32fc4bc RD |
19160 | <baseclass name="Control"/> |
19161 | <constructor name="ToggleButton" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
19166 | <paramlist> |
19167 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
19168 | <param name="id" type="int" default="-1"/> |
19169 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
19175 | </paramlist> | |
19176 | </constructor> | |
19177 | <constructor name="PreToggleButton" overloaded="no"> | |
19178 | <autodoc>PreToggleButton() -> ToggleButton</autodoc> | |
19179 | </constructor> | |
19180 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
19185 | <paramlist> |
19186 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
19187 | <param name="id" type="int" default="-1"/> |
19188 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
19194 | </paramlist> | |
19195 | </method> | |
19196 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 19197 | <autodoc>SetValue(self, bool value)</autodoc> |
f32fc4bc RD |
19198 | <paramlist> |
19199 | <param name="value" type="bool" default=""/> | |
19200 | </paramlist> | |
19201 | </method> | |
19202 | <method name="GetValue" type="bool" overloaded="no"> | |
781d2982 | 19203 | <autodoc>GetValue(self) -> bool</autodoc> |
f32fc4bc RD |
19204 | </method> |
19205 | <method name="SetLabel" type="" overloaded="no"> | |
781d2982 | 19206 | <autodoc>SetLabel(self, String label)</autodoc> |
c2dda882 | 19207 | <docstring>Sets the item's text.</docstring> |
f32fc4bc RD |
19208 | <paramlist> |
19209 | <param name="label" type="String" default=""/> | |
19210 | </paramlist> | |
19211 | </method> | |
781d2982 RD |
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. | |
19219 | ||
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 | |
19223 | this.</docstring> | |
19224 | <paramlist> | |
19225 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
19226 | </paramlist> | |
19227 | </staticmethod> | |
f32fc4bc RD |
19228 | </class> |
19229 | <pythoncode> | |
0f43fbdf RD |
19230 | #--------------------------------------------------------------------------- |
19231 | </pythoncode> | |
781d2982 | 19232 | <class name="BookCtrl" oldname="wxBookCtrl" module="_controls"> |
f32fc4bc RD |
19233 | <baseclass name="Control"/> |
19234 | <method name="GetPageCount" type="size_t" overloaded="no"> | |
781d2982 | 19235 | <autodoc>GetPageCount(self) -> size_t</autodoc> |
f32fc4bc RD |
19236 | </method> |
19237 | <method name="GetPage" type="Window" overloaded="no"> | |
781d2982 | 19238 | <autodoc>GetPage(self, size_t n) -> Window</autodoc> |
f32fc4bc RD |
19239 | <paramlist> |
19240 | <param name="n" type="size_t" default=""/> | |
19241 | </paramlist> | |
19242 | </method> | |
19243 | <method name="GetSelection" type="int" overloaded="no"> | |
781d2982 | 19244 | <autodoc>GetSelection(self) -> int</autodoc> |
f32fc4bc RD |
19245 | </method> |
19246 | <method name="SetPageText" type="bool" overloaded="no"> | |
781d2982 | 19247 | <autodoc>SetPageText(self, size_t n, String strText) -> bool</autodoc> |
f32fc4bc RD |
19248 | <paramlist> |
19249 | <param name="n" type="size_t" default=""/> | |
19250 | <param name="strText" type="String" default=""/> | |
19251 | </paramlist> | |
19252 | </method> | |
19253 | <method name="GetPageText" type="String" overloaded="no"> | |
781d2982 | 19254 | <autodoc>GetPageText(self, size_t n) -> String</autodoc> |
f32fc4bc RD |
19255 | <paramlist> |
19256 | <param name="n" type="size_t" default=""/> | |
19257 | </paramlist> | |
19258 | </method> | |
19259 | <method name="SetImageList" type="" overloaded="no"> | |
781d2982 | 19260 | <autodoc>SetImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
19261 | <paramlist> |
19262 | <param name="imageList" type="ImageList" default=""/> | |
19263 | </paramlist> | |
19264 | </method> | |
19265 | <method name="AssignImageList" type="" overloaded="no"> | |
781d2982 | 19266 | <autodoc>AssignImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
19267 | <paramlist> |
19268 | <param name="imageList" type="ImageList" default=""/> | |
19269 | </paramlist> | |
19270 | </method> | |
19271 | <method name="GetImageList" type="ImageList" overloaded="no"> | |
781d2982 | 19272 | <autodoc>GetImageList(self) -> ImageList</autodoc> |
f32fc4bc RD |
19273 | </method> |
19274 | <method name="GetPageImage" type="int" overloaded="no"> | |
781d2982 | 19275 | <autodoc>GetPageImage(self, size_t n) -> int</autodoc> |
f32fc4bc RD |
19276 | <paramlist> |
19277 | <param name="n" type="size_t" default=""/> | |
19278 | </paramlist> | |
19279 | </method> | |
19280 | <method name="SetPageImage" type="bool" overloaded="no"> | |
781d2982 | 19281 | <autodoc>SetPageImage(self, size_t n, int imageId) -> bool</autodoc> |
f32fc4bc RD |
19282 | <paramlist> |
19283 | <param name="n" type="size_t" default=""/> | |
19284 | <param name="imageId" type="int" default=""/> | |
19285 | </paramlist> | |
19286 | </method> | |
19287 | <method name="SetPageSize" type="" overloaded="no"> | |
781d2982 | 19288 | <autodoc>SetPageSize(self, Size size)</autodoc> |
f32fc4bc RD |
19289 | <paramlist> |
19290 | <param name="size" type="Size" default=""/> | |
19291 | </paramlist> | |
19292 | </method> | |
19293 | <method name="CalcSizeFromPage" type="Size" overloaded="no"> | |
781d2982 | 19294 | <autodoc>CalcSizeFromPage(self, Size sizePage) -> Size</autodoc> |
f32fc4bc RD |
19295 | <paramlist> |
19296 | <param name="sizePage" type="Size" default=""/> | |
19297 | </paramlist> | |
19298 | </method> | |
19299 | <method name="DeletePage" type="bool" overloaded="no"> | |
781d2982 | 19300 | <autodoc>DeletePage(self, size_t n) -> bool</autodoc> |
f32fc4bc RD |
19301 | <paramlist> |
19302 | <param name="n" type="size_t" default=""/> | |
19303 | </paramlist> | |
19304 | </method> | |
19305 | <method name="RemovePage" type="bool" overloaded="no"> | |
781d2982 | 19306 | <autodoc>RemovePage(self, size_t n) -> bool</autodoc> |
f32fc4bc RD |
19307 | <paramlist> |
19308 | <param name="n" type="size_t" default=""/> | |
19309 | </paramlist> | |
19310 | </method> | |
19311 | <method name="DeleteAllPages" type="bool" overloaded="no"> | |
781d2982 | 19312 | <autodoc>DeleteAllPages(self) -> bool</autodoc> |
f32fc4bc RD |
19313 | </method> |
19314 | <method name="AddPage" type="bool" overloaded="no"> | |
781d2982 | 19315 | <autodoc>AddPage(self, Window page, String text, bool select=False, int imageId=-1) -> bool</autodoc> |
f32fc4bc RD |
19316 | <paramlist> |
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"/> | |
19321 | </paramlist> | |
19322 | </method> | |
19323 | <method name="InsertPage" type="bool" overloaded="no"> | |
781d2982 | 19324 | <autodoc>InsertPage(self, size_t n, Window page, String text, bool select=False, |
856bf319 | 19325 | int imageId=-1) -> bool</autodoc> |
f32fc4bc RD |
19326 | <paramlist> |
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"/> | |
19332 | </paramlist> | |
19333 | </method> | |
19334 | <method name="SetSelection" type="int" overloaded="no"> | |
781d2982 | 19335 | <autodoc>SetSelection(self, size_t n) -> int</autodoc> |
f32fc4bc RD |
19336 | <paramlist> |
19337 | <param name="n" type="size_t" default=""/> | |
19338 | </paramlist> | |
19339 | </method> | |
19340 | <method name="AdvanceSelection" type="" overloaded="no"> | |
781d2982 | 19341 | <autodoc>AdvanceSelection(self, bool forward=True)</autodoc> |
f32fc4bc RD |
19342 | <paramlist> |
19343 | <param name="forward" type="bool" default="True"/> | |
19344 | </paramlist> | |
19345 | </method> | |
781d2982 RD |
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. | |
19353 | ||
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 | |
19357 | this.</docstring> | |
19358 | <paramlist> | |
19359 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
19360 | </paramlist> | |
19361 | </staticmethod> | |
f32fc4bc | 19362 | </class> |
781d2982 | 19363 | <class name="BookCtrlEvent" oldname="wxBookCtrlEvent" module="_controls"> |
f32fc4bc RD |
19364 | <baseclass name="NotifyEvent"/> |
19365 | <constructor name="BookCtrlEvent" overloaded="no"> | |
781d2982 | 19366 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, |
856bf319 | 19367 | int nOldSel=-1) -> BookCtrlEvent</autodoc> |
f32fc4bc RD |
19368 | <paramlist> |
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"/> | |
19373 | </paramlist> | |
19374 | </constructor> | |
19375 | <method name="GetSelection" type="int" overloaded="no"> | |
781d2982 | 19376 | <autodoc>GetSelection(self) -> int</autodoc> |
f32fc4bc RD |
19377 | </method> |
19378 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 19379 | <autodoc>SetSelection(self, int nSel)</autodoc> |
f32fc4bc RD |
19380 | <paramlist> |
19381 | <param name="nSel" type="int" default=""/> | |
19382 | </paramlist> | |
19383 | </method> | |
19384 | <method name="GetOldSelection" type="int" overloaded="no"> | |
781d2982 | 19385 | <autodoc>GetOldSelection(self) -> int</autodoc> |
f32fc4bc RD |
19386 | </method> |
19387 | <method name="SetOldSelection" type="" overloaded="no"> | |
781d2982 | 19388 | <autodoc>SetOldSelection(self, int nOldSel)</autodoc> |
f32fc4bc RD |
19389 | <paramlist> |
19390 | <param name="nOldSel" type="int" default=""/> | |
19391 | </paramlist> | |
19392 | </method> | |
19393 | </class> | |
19394 | <pythoncode> | |
0f43fbdf RD |
19395 | #--------------------------------------------------------------------------- |
19396 | </pythoncode> | |
781d2982 | 19397 | <class name="Notebook" oldname="wxNotebook" module="_controls"> |
f32fc4bc RD |
19398 | <baseclass name="BookCtrl"/> |
19399 | <constructor name="Notebook" overloaded="no"> | |
781d2982 | 19400 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
368d20e8 | 19401 | Size size=DefaultSize, long style=0, String name=NOTEBOOK_NAME) -> Notebook</autodoc> |
f32fc4bc RD |
19402 | <paramlist> |
19403 | <param name="parent" type="Window" default=""/> | |
368d20e8 | 19404 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
19409 | </paramlist> | |
19410 | </constructor> | |
19411 | <constructor name="PreNotebook" overloaded="no"> | |
19412 | <autodoc>PreNotebook() -> Notebook</autodoc> | |
19413 | </constructor> | |
19414 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
19417 | <paramlist> |
19418 | <param name="parent" type="Window" default=""/> | |
781d2982 | 19419 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
19424 | </paramlist> | |
19425 | </method> | |
19426 | <method name="GetRowCount" type="int" overloaded="no"> | |
781d2982 | 19427 | <autodoc>GetRowCount(self) -> int</autodoc> |
f32fc4bc RD |
19428 | </method> |
19429 | <method name="SetPadding" type="" overloaded="no"> | |
781d2982 | 19430 | <autodoc>SetPadding(self, Size padding)</autodoc> |
f32fc4bc RD |
19431 | <paramlist> |
19432 | <param name="padding" type="Size" default=""/> | |
19433 | </paramlist> | |
19434 | </method> | |
19435 | <method name="SetTabSize" type="" overloaded="no"> | |
781d2982 | 19436 | <autodoc>SetTabSize(self, Size sz)</autodoc> |
f32fc4bc RD |
19437 | <paramlist> |
19438 | <param name="sz" type="Size" default=""/> | |
19439 | </paramlist> | |
19440 | </method> | |
19441 | <method name="HitTest" type="int" overloaded="no"> | |
19442 | <autodoc>HitTest(Point pt) -> (tab, where)</autodoc> | |
ce6878e6 RD |
19443 | <docstring>Returns the tab which is hit, and flags indicating where using |
19444 | wx.NB_HITTEST flags.</docstring> | |
f32fc4bc RD |
19445 | <paramlist> |
19446 | <param name="pt" type="Point" default=""/> | |
19447 | <param name="OUTPUT" type="long" default=""/> | |
19448 | </paramlist> | |
19449 | </method> | |
19450 | <method name="CalcSizeFromPage" type="Size" overloaded="no"> | |
781d2982 | 19451 | <autodoc>CalcSizeFromPage(self, Size sizePage) -> Size</autodoc> |
f32fc4bc RD |
19452 | <paramlist> |
19453 | <param name="sizePage" type="Size" default=""/> | |
19454 | </paramlist> | |
19455 | </method> | |
781d2982 RD |
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. | |
19463 | ||
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 | |
19467 | this.</docstring> | |
19468 | <paramlist> | |
19469 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
19470 | </paramlist> | |
19471 | </staticmethod> | |
f32fc4bc | 19472 | </class> |
781d2982 | 19473 | <class name="NotebookEvent" oldname="wxNotebookEvent" module="_controls"> |
f32fc4bc RD |
19474 | <baseclass name="BookCtrlEvent"/> |
19475 | <constructor name="NotebookEvent" overloaded="no"> | |
781d2982 | 19476 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, |
856bf319 | 19477 | int nOldSel=-1) -> NotebookEvent</autodoc> |
f32fc4bc RD |
19478 | <paramlist> |
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"/> | |
19483 | </paramlist> | |
19484 | </constructor> | |
19485 | </class> | |
19486 | <pythoncode> | |
856bf319 RD |
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 ) | |
0f43fbdf | 19490 | </pythoncode> |
f32fc4bc | 19491 | <pythoncode> |
856bf319 RD |
19492 | #---------------------------------------------------------------------------- |
19493 | ||
19494 | class NotebookPage(wx.Panel): | |
19495 | """ | |
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. | |
19504 | """ | |
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) | |
19509 | self.child = None | |
19510 | EVT_SIZE(self, self.OnSize) | |
19511 | ||
19512 | def OnSize(self, evt): | |
19513 | if self.child is None: | |
19514 | children = self.GetChildren() | |
19515 | if len(children): | |
19516 | self.child = children[0] | |
19517 | if self.child: | |
19518 | self.child.SetPosition((0,0)) | |
19519 | self.child.SetSize(self.GetSize()) | |
19520 | ||
0f43fbdf | 19521 | </pythoncode> |
f32fc4bc | 19522 | <pythoncode> |
0f43fbdf RD |
19523 | #--------------------------------------------------------------------------- |
19524 | </pythoncode> | |
781d2982 | 19525 | <class name="Listbook" oldname="wxListbook" module="_controls"> |
f32fc4bc RD |
19526 | <baseclass name="BookCtrl"/> |
19527 | <constructor name="Listbook" overloaded="no"> | |
781d2982 | 19528 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
368d20e8 | 19529 | Size size=DefaultSize, long style=0, String name=EmptyString) -> Listbook</autodoc> |
f32fc4bc RD |
19530 | <paramlist> |
19531 | <param name="parent" type="Window" default=""/> | |
368d20e8 | 19532 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
19537 | </paramlist> | |
19538 | </constructor> | |
19539 | <constructor name="PreListbook" overloaded="no"> | |
19540 | <autodoc>PreListbook() -> Listbook</autodoc> | |
19541 | </constructor> | |
19542 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
19543 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
19544 | Size size=DefaultSize, long style=0, String name=EmptyString) -> bool</autodoc> | |
f32fc4bc RD |
19545 | <paramlist> |
19546 | <param name="parent" type="Window" default=""/> | |
781d2982 | 19547 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
19552 | </paramlist> | |
19553 | </method> | |
19554 | <method name="IsVertical" type="bool" overloaded="no"> | |
781d2982 | 19555 | <autodoc>IsVertical(self) -> bool</autodoc> |
f32fc4bc RD |
19556 | </method> |
19557 | </class> | |
781d2982 | 19558 | <class name="ListbookEvent" oldname="wxListbookEvent" module="_controls"> |
f32fc4bc RD |
19559 | <baseclass name="BookCtrlEvent"/> |
19560 | <constructor name="ListbookEvent" overloaded="no"> | |
781d2982 | 19561 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0, int nSel=-1, |
856bf319 | 19562 | int nOldSel=-1) -> ListbookEvent</autodoc> |
f32fc4bc RD |
19563 | <paramlist> |
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"/> | |
19568 | </paramlist> | |
19569 | </constructor> | |
19570 | </class> | |
19571 | <pythoncode> | |
856bf319 RD |
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 ) | |
0f43fbdf | 19574 | </pythoncode> |
f32fc4bc RD |
19575 | <pythoncode> |
19576 | #--------------------------------------------------------------------------- | |
19577 | </pythoncode> | |
781d2982 | 19578 | <class name="BookCtrlSizer" oldname="wxBookCtrlSizer" module="_controls"> |
f32fc4bc RD |
19579 | <baseclass name="Sizer"/> |
19580 | <constructor name="BookCtrlSizer" overloaded="no"> | |
781d2982 | 19581 | <autodoc>__init__(self, BookCtrl nb) -> BookCtrlSizer</autodoc> |
f32fc4bc RD |
19582 | <paramlist> |
19583 | <param name="nb" type="BookCtrl" default=""/> | |
19584 | </paramlist> | |
19585 | </constructor> | |
19586 | <method name="RecalcSizes" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
19591 | </method> |
19592 | <method name="CalcMin" type="Size" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
19597 | </method> |
19598 | <method name="GetControl" type="BookCtrl" overloaded="no"> | |
781d2982 | 19599 | <autodoc>GetControl(self) -> BookCtrl</autodoc> |
f32fc4bc RD |
19600 | </method> |
19601 | </class> | |
781d2982 | 19602 | <class name="NotebookSizer" oldname="wxNotebookSizer" module="_controls"> |
f32fc4bc RD |
19603 | <baseclass name="Sizer"/> |
19604 | <constructor name="NotebookSizer" overloaded="no"> | |
781d2982 | 19605 | <autodoc>__init__(self, Notebook nb) -> NotebookSizer</autodoc> |
f32fc4bc RD |
19606 | <paramlist> |
19607 | <param name="nb" type="Notebook" default=""/> | |
19608 | </paramlist> | |
19609 | </constructor> | |
19610 | <method name="RecalcSizes" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
19615 | </method> |
19616 | <method name="CalcMin" type="Size" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
19621 | </method> |
19622 | <method name="GetNotebook" type="Notebook" overloaded="no"> | |
781d2982 | 19623 | <autodoc>GetNotebook(self) -> Notebook</autodoc> |
f32fc4bc RD |
19624 | </method> |
19625 | </class> | |
19626 | <pythoncode> | |
19627 | #--------------------------------------------------------------------------- | |
19628 | </pythoncode> | |
781d2982 | 19629 | <class name="ToolBarToolBase" oldname="wxToolBarToolBase" module="_controls"> |
f32fc4bc RD |
19630 | <baseclass name="Object"/> |
19631 | <method name="GetId" type="int" overloaded="no"> | |
781d2982 | 19632 | <autodoc>GetId(self) -> int</autodoc> |
f32fc4bc RD |
19633 | </method> |
19634 | <method name="GetControl" type="Control" overloaded="no"> | |
781d2982 | 19635 | <autodoc>GetControl(self) -> Control</autodoc> |
f32fc4bc RD |
19636 | </method> |
19637 | <method name="GetToolBar" type="wxToolBarBase" overloaded="no"> | |
781d2982 | 19638 | <autodoc>GetToolBar(self) -> ToolBarBase</autodoc> |
f32fc4bc RD |
19639 | </method> |
19640 | <method name="IsButton" type="int" overloaded="no"> | |
781d2982 | 19641 | <autodoc>IsButton(self) -> int</autodoc> |
f32fc4bc RD |
19642 | </method> |
19643 | <method name="IsControl" type="int" overloaded="no"> | |
781d2982 | 19644 | <autodoc>IsControl(self) -> int</autodoc> |
f32fc4bc RD |
19645 | </method> |
19646 | <method name="IsSeparator" type="int" overloaded="no"> | |
781d2982 | 19647 | <autodoc>IsSeparator(self) -> int</autodoc> |
f32fc4bc RD |
19648 | </method> |
19649 | <method name="GetStyle" type="int" overloaded="no"> | |
781d2982 | 19650 | <autodoc>GetStyle(self) -> int</autodoc> |
f32fc4bc RD |
19651 | </method> |
19652 | <method name="GetKind" type="wxItemKind" overloaded="no"> | |
781d2982 | 19653 | <autodoc>GetKind(self) -> int</autodoc> |
f32fc4bc RD |
19654 | </method> |
19655 | <method name="IsEnabled" type="bool" overloaded="no"> | |
781d2982 | 19656 | <autodoc>IsEnabled(self) -> bool</autodoc> |
f32fc4bc RD |
19657 | </method> |
19658 | <method name="IsToggled" type="bool" overloaded="no"> | |
781d2982 | 19659 | <autodoc>IsToggled(self) -> bool</autodoc> |
f32fc4bc RD |
19660 | </method> |
19661 | <method name="CanBeToggled" type="bool" overloaded="no"> | |
781d2982 | 19662 | <autodoc>CanBeToggled(self) -> bool</autodoc> |
f32fc4bc RD |
19663 | </method> |
19664 | <method name="GetNormalBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 19665 | <autodoc>GetNormalBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
19666 | </method> |
19667 | <method name="GetDisabledBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 19668 | <autodoc>GetDisabledBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
19669 | </method> |
19670 | <method name="GetBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 19671 | <autodoc>GetBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
19672 | </method> |
19673 | <method name="GetLabel" type="String" overloaded="no"> | |
781d2982 | 19674 | <autodoc>GetLabel(self) -> String</autodoc> |
f32fc4bc RD |
19675 | </method> |
19676 | <method name="GetShortHelp" type="String" overloaded="no"> | |
781d2982 | 19677 | <autodoc>GetShortHelp(self) -> String</autodoc> |
f32fc4bc RD |
19678 | </method> |
19679 | <method name="GetLongHelp" type="String" overloaded="no"> | |
781d2982 | 19680 | <autodoc>GetLongHelp(self) -> String</autodoc> |
f32fc4bc RD |
19681 | </method> |
19682 | <method name="Enable" type="bool" overloaded="no"> | |
781d2982 | 19683 | <autodoc>Enable(self, bool enable) -> bool</autodoc> |
f32fc4bc RD |
19684 | <paramlist> |
19685 | <param name="enable" type="bool" default=""/> | |
19686 | </paramlist> | |
19687 | </method> | |
19688 | <method name="Toggle" type="" overloaded="no"> | |
781d2982 | 19689 | <autodoc>Toggle(self)</autodoc> |
f32fc4bc RD |
19690 | </method> |
19691 | <method name="SetToggle" type="bool" overloaded="no"> | |
781d2982 | 19692 | <autodoc>SetToggle(self, bool toggle) -> bool</autodoc> |
f32fc4bc RD |
19693 | <paramlist> |
19694 | <param name="toggle" type="bool" default=""/> | |
19695 | </paramlist> | |
19696 | </method> | |
19697 | <method name="SetShortHelp" type="bool" overloaded="no"> | |
781d2982 | 19698 | <autodoc>SetShortHelp(self, String help) -> bool</autodoc> |
f32fc4bc RD |
19699 | <paramlist> |
19700 | <param name="help" type="String" default=""/> | |
19701 | </paramlist> | |
19702 | </method> | |
19703 | <method name="SetLongHelp" type="bool" overloaded="no"> | |
781d2982 | 19704 | <autodoc>SetLongHelp(self, String help) -> bool</autodoc> |
f32fc4bc RD |
19705 | <paramlist> |
19706 | <param name="help" type="String" default=""/> | |
19707 | </paramlist> | |
19708 | </method> | |
19709 | <method name="SetNormalBitmap" type="" overloaded="no"> | |
781d2982 | 19710 | <autodoc>SetNormalBitmap(self, Bitmap bmp)</autodoc> |
f32fc4bc RD |
19711 | <paramlist> |
19712 | <param name="bmp" type="Bitmap" default=""/> | |
19713 | </paramlist> | |
19714 | </method> | |
19715 | <method name="SetDisabledBitmap" type="" overloaded="no"> | |
781d2982 | 19716 | <autodoc>SetDisabledBitmap(self, Bitmap bmp)</autodoc> |
f32fc4bc RD |
19717 | <paramlist> |
19718 | <param name="bmp" type="Bitmap" default=""/> | |
19719 | </paramlist> | |
19720 | </method> | |
19721 | <method name="SetLabel" type="" overloaded="no"> | |
781d2982 | 19722 | <autodoc>SetLabel(self, String label)</autodoc> |
f32fc4bc RD |
19723 | <paramlist> |
19724 | <param name="label" type="String" default=""/> | |
19725 | </paramlist> | |
19726 | </method> | |
19727 | <method name="Detach" type="" overloaded="no"> | |
781d2982 | 19728 | <autodoc>Detach(self)</autodoc> |
f32fc4bc RD |
19729 | </method> |
19730 | <method name="Attach" type="" overloaded="no"> | |
781d2982 | 19731 | <autodoc>Attach(self, ToolBarBase tbar)</autodoc> |
f32fc4bc RD |
19732 | <paramlist> |
19733 | <param name="tbar" type="wxToolBarBase" default=""/> | |
19734 | </paramlist> | |
19735 | </method> | |
19736 | <method name="GetClientData" type="PyObject" overloaded="no"> | |
781d2982 | 19737 | <autodoc>GetClientData(self) -> PyObject</autodoc> |
f32fc4bc RD |
19738 | </method> |
19739 | <method name="SetClientData" type="" overloaded="no"> | |
781d2982 | 19740 | <autodoc>SetClientData(self, PyObject clientData)</autodoc> |
f32fc4bc RD |
19741 | <paramlist> |
19742 | <param name="clientData" type="PyObject" default=""/> | |
19743 | </paramlist> | |
19744 | </method> | |
19745 | </class> | |
781d2982 | 19746 | <class name="ToolBarBase" oldname="wxToolBarBase" module="_controls"> |
f32fc4bc RD |
19747 | <baseclass name="Control"/> |
19748 | <method name="DoAddTool" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19749 | <autodoc>DoAddTool(self, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap, |
f32fc4bc RD |
19750 | int kind=ITEM_NORMAL, String shortHelp=EmptyString, |
19751 | String longHelp=EmptyString, | |
19752 | PyObject clientData=None) -> ToolBarToolBase</autodoc> | |
19753 | <paramlist> | |
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"/> | |
19762 | </paramlist> | |
19763 | </method> | |
19764 | <method name="DoInsertTool" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19765 | <autodoc>DoInsertTool(self, size_t pos, int id, String label, Bitmap bitmap, Bitmap bmpDisabled=wxNullBitmap, |
f32fc4bc RD |
19766 | int kind=ITEM_NORMAL, |
19767 | String shortHelp=EmptyString, String longHelp=EmptyString, | |
19768 | PyObject clientData=None) -> ToolBarToolBase</autodoc> | |
19769 | <paramlist> | |
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"/> | |
19779 | </paramlist> | |
19780 | </method> | |
19781 | <method name="AddToolItem" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19782 | <autodoc>AddToolItem(self, ToolBarToolBase tool) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
19783 | <paramlist> |
19784 | <param name="tool" type="ToolBarToolBase" default=""/> | |
19785 | </paramlist> | |
19786 | </method> | |
19787 | <method name="InsertToolItem" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19788 | <autodoc>InsertToolItem(self, size_t pos, ToolBarToolBase tool) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
19789 | <paramlist> |
19790 | <param name="pos" type="size_t" default=""/> | |
19791 | <param name="tool" type="ToolBarToolBase" default=""/> | |
19792 | </paramlist> | |
19793 | </method> | |
19794 | <method name="AddControl" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19795 | <autodoc>AddControl(self, Control control) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
19796 | <paramlist> |
19797 | <param name="control" type="Control" default=""/> | |
19798 | </paramlist> | |
19799 | </method> | |
19800 | <method name="InsertControl" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19801 | <autodoc>InsertControl(self, size_t pos, Control control) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
19802 | <paramlist> |
19803 | <param name="pos" type="size_t" default=""/> | |
19804 | <param name="control" type="Control" default=""/> | |
19805 | </paramlist> | |
19806 | </method> | |
19807 | <method name="FindControl" type="Control" overloaded="no"> | |
781d2982 | 19808 | <autodoc>FindControl(self, int id) -> Control</autodoc> |
f32fc4bc RD |
19809 | <paramlist> |
19810 | <param name="id" type="int" default=""/> | |
19811 | </paramlist> | |
19812 | </method> | |
19813 | <method name="AddSeparator" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19814 | <autodoc>AddSeparator(self) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
19815 | </method> |
19816 | <method name="InsertSeparator" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19817 | <autodoc>InsertSeparator(self, size_t pos) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
19818 | <paramlist> |
19819 | <param name="pos" type="size_t" default=""/> | |
19820 | </paramlist> | |
19821 | </method> | |
19822 | <method name="RemoveTool" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19823 | <autodoc>RemoveTool(self, int id) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
19824 | <paramlist> |
19825 | <param name="id" type="int" default=""/> | |
19826 | </paramlist> | |
19827 | </method> | |
19828 | <method name="DeleteToolByPos" type="bool" overloaded="no"> | |
781d2982 | 19829 | <autodoc>DeleteToolByPos(self, size_t pos) -> bool</autodoc> |
f32fc4bc RD |
19830 | <paramlist> |
19831 | <param name="pos" type="size_t" default=""/> | |
19832 | </paramlist> | |
19833 | </method> | |
19834 | <method name="DeleteTool" type="bool" overloaded="no"> | |
781d2982 | 19835 | <autodoc>DeleteTool(self, int id) -> bool</autodoc> |
f32fc4bc RD |
19836 | <paramlist> |
19837 | <param name="id" type="int" default=""/> | |
19838 | </paramlist> | |
19839 | </method> | |
19840 | <method name="ClearTools" type="" overloaded="no"> | |
781d2982 | 19841 | <autodoc>ClearTools(self)</autodoc> |
f32fc4bc RD |
19842 | </method> |
19843 | <method name="Realize" type="bool" overloaded="no"> | |
781d2982 | 19844 | <autodoc>Realize(self) -> bool</autodoc> |
f32fc4bc RD |
19845 | </method> |
19846 | <method name="EnableTool" type="" overloaded="no"> | |
781d2982 | 19847 | <autodoc>EnableTool(self, int id, bool enable)</autodoc> |
f32fc4bc RD |
19848 | <paramlist> |
19849 | <param name="id" type="int" default=""/> | |
19850 | <param name="enable" type="bool" default=""/> | |
19851 | </paramlist> | |
19852 | </method> | |
19853 | <method name="ToggleTool" type="" overloaded="no"> | |
781d2982 | 19854 | <autodoc>ToggleTool(self, int id, bool toggle)</autodoc> |
f32fc4bc RD |
19855 | <paramlist> |
19856 | <param name="id" type="int" default=""/> | |
19857 | <param name="toggle" type="bool" default=""/> | |
19858 | </paramlist> | |
19859 | </method> | |
19860 | <method name="SetToggle" type="" overloaded="no"> | |
781d2982 | 19861 | <autodoc>SetToggle(self, int id, bool toggle)</autodoc> |
f32fc4bc RD |
19862 | <paramlist> |
19863 | <param name="id" type="int" default=""/> | |
19864 | <param name="toggle" type="bool" default=""/> | |
19865 | </paramlist> | |
19866 | </method> | |
19867 | <method name="GetToolClientData" type="PyObject" overloaded="no"> | |
781d2982 | 19868 | <autodoc>GetToolClientData(self, int id) -> PyObject</autodoc> |
f32fc4bc RD |
19869 | <paramlist> |
19870 | <param name="id" type="int" default=""/> | |
19871 | </paramlist> | |
19872 | </method> | |
19873 | <method name="SetToolClientData" type="" overloaded="no"> | |
781d2982 | 19874 | <autodoc>SetToolClientData(self, int id, PyObject clientData)</autodoc> |
f32fc4bc RD |
19875 | <paramlist> |
19876 | <param name="id" type="int" default=""/> | |
19877 | <param name="clientData" type="PyObject" default=""/> | |
19878 | </paramlist> | |
19879 | </method> | |
19880 | <method name="GetToolPos" type="int" overloaded="no"> | |
781d2982 | 19881 | <autodoc>GetToolPos(self, int id) -> int</autodoc> |
f32fc4bc RD |
19882 | <paramlist> |
19883 | <param name="id" type="int" default=""/> | |
19884 | </paramlist> | |
19885 | </method> | |
19886 | <method name="GetToolState" type="bool" overloaded="no"> | |
781d2982 | 19887 | <autodoc>GetToolState(self, int id) -> bool</autodoc> |
f32fc4bc RD |
19888 | <paramlist> |
19889 | <param name="id" type="int" default=""/> | |
19890 | </paramlist> | |
19891 | </method> | |
19892 | <method name="GetToolEnabled" type="bool" overloaded="no"> | |
781d2982 | 19893 | <autodoc>GetToolEnabled(self, int id) -> bool</autodoc> |
f32fc4bc RD |
19894 | <paramlist> |
19895 | <param name="id" type="int" default=""/> | |
19896 | </paramlist> | |
19897 | </method> | |
19898 | <method name="SetToolShortHelp" type="" overloaded="no"> | |
781d2982 | 19899 | <autodoc>SetToolShortHelp(self, int id, String helpString)</autodoc> |
f32fc4bc RD |
19900 | <paramlist> |
19901 | <param name="id" type="int" default=""/> | |
19902 | <param name="helpString" type="String" default=""/> | |
19903 | </paramlist> | |
19904 | </method> | |
19905 | <method name="GetToolShortHelp" type="String" overloaded="no"> | |
781d2982 | 19906 | <autodoc>GetToolShortHelp(self, int id) -> String</autodoc> |
f32fc4bc RD |
19907 | <paramlist> |
19908 | <param name="id" type="int" default=""/> | |
19909 | </paramlist> | |
19910 | </method> | |
19911 | <method name="SetToolLongHelp" type="" overloaded="no"> | |
781d2982 | 19912 | <autodoc>SetToolLongHelp(self, int id, String helpString)</autodoc> |
f32fc4bc RD |
19913 | <paramlist> |
19914 | <param name="id" type="int" default=""/> | |
19915 | <param name="helpString" type="String" default=""/> | |
19916 | </paramlist> | |
19917 | </method> | |
19918 | <method name="GetToolLongHelp" type="String" overloaded="no"> | |
781d2982 | 19919 | <autodoc>GetToolLongHelp(self, int id) -> String</autodoc> |
f32fc4bc RD |
19920 | <paramlist> |
19921 | <param name="id" type="int" default=""/> | |
19922 | </paramlist> | |
19923 | </method> | |
19924 | <method name="SetMarginsXY" type="" overloaded="no"> | |
781d2982 | 19925 | <autodoc>SetMarginsXY(self, int x, int y)</autodoc> |
f32fc4bc RD |
19926 | <paramlist> |
19927 | <param name="x" type="int" default=""/> | |
19928 | <param name="y" type="int" default=""/> | |
19929 | </paramlist> | |
19930 | </method> | |
19931 | <method name="SetMargins" type="" overloaded="no"> | |
781d2982 | 19932 | <autodoc>SetMargins(self, Size size)</autodoc> |
f32fc4bc RD |
19933 | <paramlist> |
19934 | <param name="size" type="Size" default=""/> | |
19935 | </paramlist> | |
19936 | </method> | |
19937 | <method name="SetToolPacking" type="" overloaded="no"> | |
781d2982 | 19938 | <autodoc>SetToolPacking(self, int packing)</autodoc> |
f32fc4bc RD |
19939 | <paramlist> |
19940 | <param name="packing" type="int" default=""/> | |
19941 | </paramlist> | |
19942 | </method> | |
19943 | <method name="SetToolSeparation" type="" overloaded="no"> | |
781d2982 | 19944 | <autodoc>SetToolSeparation(self, int separation)</autodoc> |
f32fc4bc RD |
19945 | <paramlist> |
19946 | <param name="separation" type="int" default=""/> | |
19947 | </paramlist> | |
19948 | </method> | |
19949 | <method name="GetToolMargins" type="Size" overloaded="no"> | |
781d2982 | 19950 | <autodoc>GetToolMargins(self) -> Size</autodoc> |
f32fc4bc RD |
19951 | </method> |
19952 | <method name="GetMargins" type="Size" overloaded="no"> | |
781d2982 | 19953 | <autodoc>GetMargins(self) -> Size</autodoc> |
f32fc4bc RD |
19954 | </method> |
19955 | <method name="GetToolPacking" type="int" overloaded="no"> | |
781d2982 | 19956 | <autodoc>GetToolPacking(self) -> int</autodoc> |
f32fc4bc RD |
19957 | </method> |
19958 | <method name="GetToolSeparation" type="int" overloaded="no"> | |
781d2982 | 19959 | <autodoc>GetToolSeparation(self) -> int</autodoc> |
f32fc4bc RD |
19960 | </method> |
19961 | <method name="SetRows" type="" overloaded="no"> | |
781d2982 | 19962 | <autodoc>SetRows(self, int nRows)</autodoc> |
f32fc4bc RD |
19963 | <paramlist> |
19964 | <param name="nRows" type="int" default=""/> | |
19965 | </paramlist> | |
19966 | </method> | |
19967 | <method name="SetMaxRowsCols" type="" overloaded="no"> | |
781d2982 | 19968 | <autodoc>SetMaxRowsCols(self, int rows, int cols)</autodoc> |
f32fc4bc RD |
19969 | <paramlist> |
19970 | <param name="rows" type="int" default=""/> | |
19971 | <param name="cols" type="int" default=""/> | |
19972 | </paramlist> | |
19973 | </method> | |
19974 | <method name="GetMaxRows" type="int" overloaded="no"> | |
781d2982 | 19975 | <autodoc>GetMaxRows(self) -> int</autodoc> |
f32fc4bc RD |
19976 | </method> |
19977 | <method name="GetMaxCols" type="int" overloaded="no"> | |
781d2982 | 19978 | <autodoc>GetMaxCols(self) -> int</autodoc> |
f32fc4bc RD |
19979 | </method> |
19980 | <method name="SetToolBitmapSize" type="" overloaded="no"> | |
781d2982 | 19981 | <autodoc>SetToolBitmapSize(self, Size size)</autodoc> |
f32fc4bc RD |
19982 | <paramlist> |
19983 | <param name="size" type="Size" default=""/> | |
19984 | </paramlist> | |
19985 | </method> | |
19986 | <method name="GetToolBitmapSize" type="Size" overloaded="no"> | |
781d2982 | 19987 | <autodoc>GetToolBitmapSize(self) -> Size</autodoc> |
f32fc4bc RD |
19988 | </method> |
19989 | <method name="GetToolSize" type="Size" overloaded="no"> | |
781d2982 | 19990 | <autodoc>GetToolSize(self) -> Size</autodoc> |
f32fc4bc RD |
19991 | </method> |
19992 | <method name="FindToolForPosition" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 19993 | <autodoc>FindToolForPosition(self, int x, int y) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
19994 | <paramlist> |
19995 | <param name="x" type="int" default=""/> | |
19996 | <param name="y" type="int" default=""/> | |
19997 | </paramlist> | |
19998 | </method> | |
19999 | <method name="FindById" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 20000 | <autodoc>FindById(self, int toolid) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
20001 | <paramlist> |
20002 | <param name="toolid" type="int" default=""/> | |
20003 | </paramlist> | |
20004 | </method> | |
20005 | <method name="IsVertical" type="bool" overloaded="no"> | |
781d2982 | 20006 | <autodoc>IsVertical(self) -> bool</autodoc> |
f32fc4bc RD |
20007 | </method> |
20008 | </class> | |
781d2982 | 20009 | <class name="ToolBar" oldname="wxToolBar" module="_controls"> |
f32fc4bc RD |
20010 | <baseclass name="ToolBarBase"/> |
20011 | <constructor name="ToolBar" overloaded="no"> | |
781d2982 RD |
20012 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
20013 | Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL, | |
f32fc4bc RD |
20014 | String name=wxPyToolBarNameStr) -> ToolBar</autodoc> |
20015 | <paramlist> | |
20016 | <param name="parent" type="Window" default=""/> | |
781d2982 | 20017 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
20022 | </paramlist> | |
20023 | </constructor> | |
20024 | <constructor name="PreToolBar" overloaded="no"> | |
20025 | <autodoc>PreToolBar() -> ToolBar</autodoc> | |
20026 | </constructor> | |
20027 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
20028 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
20029 | Size size=DefaultSize, long style=wxNO_BORDER|wxTB_HORIZONTAL, | |
f32fc4bc RD |
20030 | String name=wxPyToolBarNameStr) -> bool</autodoc> |
20031 | <paramlist> | |
20032 | <param name="parent" type="Window" default=""/> | |
781d2982 | 20033 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
20038 | </paramlist> | |
20039 | </method> | |
20040 | <method name="FindToolForPosition" type="ToolBarToolBase" overloaded="no"> | |
781d2982 | 20041 | <autodoc>FindToolForPosition(self, int x, int y) -> ToolBarToolBase</autodoc> |
f32fc4bc RD |
20042 | <paramlist> |
20043 | <param name="x" type="int" default=""/> | |
20044 | <param name="y" type="int" default=""/> | |
20045 | </paramlist> | |
20046 | </method> | |
781d2982 RD |
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. | |
20054 | ||
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 | |
20058 | this.</docstring> | |
20059 | <paramlist> | |
20060 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
20061 | </paramlist> | |
20062 | </staticmethod> | |
f32fc4bc RD |
20063 | </class> |
20064 | <pythoncode> | |
20065 | #--------------------------------------------------------------------------- | |
20066 | </pythoncode> | |
20067 | <pythoncode> | |
20068 | #--------------------------------------------------------------------------- | |
20069 | </pythoncode> | |
781d2982 | 20070 | <class name="ListItemAttr" oldname="wxListItemAttr" module="_controls"> |
f32fc4bc | 20071 | <constructor name="ListItemAttr" overloaded="no"> |
781d2982 | 20072 | <autodoc>__init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, |
f32fc4bc RD |
20073 | Font font=wxNullFont) -> ListItemAttr</autodoc> |
20074 | <paramlist> | |
20075 | <param name="colText" type="Colour" default="wxNullColour"/> | |
20076 | <param name="colBack" type="Colour" default="wxNullColour"/> | |
20077 | <param name="font" type="Font" default="wxNullFont"/> | |
20078 | </paramlist> | |
20079 | </constructor> | |
20080 | <method name="SetTextColour" type="" overloaded="no"> | |
781d2982 | 20081 | <autodoc>SetTextColour(self, Colour colText)</autodoc> |
f32fc4bc RD |
20082 | <paramlist> |
20083 | <param name="colText" type="Colour" default=""/> | |
20084 | </paramlist> | |
20085 | </method> | |
20086 | <method name="SetBackgroundColour" type="" overloaded="no"> | |
781d2982 | 20087 | <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc> |
f32fc4bc RD |
20088 | <paramlist> |
20089 | <param name="colBack" type="Colour" default=""/> | |
20090 | </paramlist> | |
20091 | </method> | |
20092 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 20093 | <autodoc>SetFont(self, Font font)</autodoc> |
f32fc4bc RD |
20094 | <paramlist> |
20095 | <param name="font" type="Font" default=""/> | |
20096 | </paramlist> | |
20097 | </method> | |
20098 | <method name="HasTextColour" type="bool" overloaded="no"> | |
781d2982 | 20099 | <autodoc>HasTextColour(self) -> bool</autodoc> |
f32fc4bc RD |
20100 | </method> |
20101 | <method name="HasBackgroundColour" type="bool" overloaded="no"> | |
781d2982 | 20102 | <autodoc>HasBackgroundColour(self) -> bool</autodoc> |
f32fc4bc RD |
20103 | </method> |
20104 | <method name="HasFont" type="bool" overloaded="no"> | |
781d2982 | 20105 | <autodoc>HasFont(self) -> bool</autodoc> |
f32fc4bc RD |
20106 | </method> |
20107 | <method name="GetTextColour" type="Colour" overloaded="no"> | |
781d2982 | 20108 | <autodoc>GetTextColour(self) -> Colour</autodoc> |
f32fc4bc RD |
20109 | </method> |
20110 | <method name="GetBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 20111 | <autodoc>GetBackgroundColour(self) -> Colour</autodoc> |
f32fc4bc RD |
20112 | </method> |
20113 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 20114 | <autodoc>GetFont(self) -> Font</autodoc> |
f32fc4bc RD |
20115 | </method> |
20116 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 20117 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
20118 | </method> |
20119 | </class> | |
20120 | <pythoncode> | |
20121 | #--------------------------------------------------------------------------- | |
20122 | </pythoncode> | |
781d2982 | 20123 | <class name="ListItem" oldname="wxListItem" module="_controls"> |
f32fc4bc RD |
20124 | <baseclass name="Object"/> |
20125 | <constructor name="ListItem" overloaded="no"> | |
781d2982 | 20126 | <autodoc>__init__(self) -> ListItem</autodoc> |
f32fc4bc RD |
20127 | </constructor> |
20128 | <destructor name="~wxListItem" overloaded="no"> | |
781d2982 | 20129 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
20130 | </destructor> |
20131 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 20132 | <autodoc>Clear(self)</autodoc> |
f32fc4bc RD |
20133 | </method> |
20134 | <method name="ClearAttributes" type="" overloaded="no"> | |
781d2982 | 20135 | <autodoc>ClearAttributes(self)</autodoc> |
f32fc4bc RD |
20136 | </method> |
20137 | <method name="SetMask" type="" overloaded="no"> | |
781d2982 | 20138 | <autodoc>SetMask(self, long mask)</autodoc> |
f32fc4bc RD |
20139 | <paramlist> |
20140 | <param name="mask" type="long" default=""/> | |
20141 | </paramlist> | |
20142 | </method> | |
20143 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 20144 | <autodoc>SetId(self, long id)</autodoc> |
f32fc4bc RD |
20145 | <paramlist> |
20146 | <param name="id" type="long" default=""/> | |
20147 | </paramlist> | |
20148 | </method> | |
20149 | <method name="SetColumn" type="" overloaded="no"> | |
781d2982 | 20150 | <autodoc>SetColumn(self, int col)</autodoc> |
f32fc4bc RD |
20151 | <paramlist> |
20152 | <param name="col" type="int" default=""/> | |
20153 | </paramlist> | |
20154 | </method> | |
20155 | <method name="SetState" type="" overloaded="no"> | |
781d2982 | 20156 | <autodoc>SetState(self, long state)</autodoc> |
f32fc4bc RD |
20157 | <paramlist> |
20158 | <param name="state" type="long" default=""/> | |
20159 | </paramlist> | |
20160 | </method> | |
20161 | <method name="SetStateMask" type="" overloaded="no"> | |
781d2982 | 20162 | <autodoc>SetStateMask(self, long stateMask)</autodoc> |
f32fc4bc RD |
20163 | <paramlist> |
20164 | <param name="stateMask" type="long" default=""/> | |
20165 | </paramlist> | |
20166 | </method> | |
20167 | <method name="SetText" type="" overloaded="no"> | |
781d2982 | 20168 | <autodoc>SetText(self, String text)</autodoc> |
f32fc4bc RD |
20169 | <paramlist> |
20170 | <param name="text" type="String" default=""/> | |
20171 | </paramlist> | |
20172 | </method> | |
20173 | <method name="SetImage" type="" overloaded="no"> | |
781d2982 | 20174 | <autodoc>SetImage(self, int image)</autodoc> |
f32fc4bc RD |
20175 | <paramlist> |
20176 | <param name="image" type="int" default=""/> | |
20177 | </paramlist> | |
20178 | </method> | |
20179 | <method name="SetData" type="" overloaded="no"> | |
781d2982 | 20180 | <autodoc>SetData(self, long data)</autodoc> |
f32fc4bc RD |
20181 | <paramlist> |
20182 | <param name="data" type="long" default=""/> | |
20183 | </paramlist> | |
20184 | </method> | |
20185 | <method name="SetWidth" type="" overloaded="no"> | |
781d2982 | 20186 | <autodoc>SetWidth(self, int width)</autodoc> |
f32fc4bc RD |
20187 | <paramlist> |
20188 | <param name="width" type="int" default=""/> | |
20189 | </paramlist> | |
20190 | </method> | |
20191 | <method name="SetAlign" type="" overloaded="no"> | |
781d2982 | 20192 | <autodoc>SetAlign(self, int align)</autodoc> |
f32fc4bc RD |
20193 | <paramlist> |
20194 | <param name="align" type="wxListColumnFormat" default=""/> | |
20195 | </paramlist> | |
20196 | </method> | |
20197 | <method name="SetTextColour" type="" overloaded="no"> | |
781d2982 | 20198 | <autodoc>SetTextColour(self, Colour colText)</autodoc> |
f32fc4bc RD |
20199 | <paramlist> |
20200 | <param name="colText" type="Colour" default=""/> | |
20201 | </paramlist> | |
20202 | </method> | |
20203 | <method name="SetBackgroundColour" type="" overloaded="no"> | |
781d2982 | 20204 | <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc> |
f32fc4bc RD |
20205 | <paramlist> |
20206 | <param name="colBack" type="Colour" default=""/> | |
20207 | </paramlist> | |
20208 | </method> | |
20209 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 20210 | <autodoc>SetFont(self, Font font)</autodoc> |
f32fc4bc RD |
20211 | <paramlist> |
20212 | <param name="font" type="Font" default=""/> | |
20213 | </paramlist> | |
20214 | </method> | |
20215 | <method name="GetMask" type="long" overloaded="no"> | |
781d2982 | 20216 | <autodoc>GetMask(self) -> long</autodoc> |
f32fc4bc RD |
20217 | </method> |
20218 | <method name="GetId" type="long" overloaded="no"> | |
781d2982 | 20219 | <autodoc>GetId(self) -> long</autodoc> |
f32fc4bc RD |
20220 | </method> |
20221 | <method name="GetColumn" type="int" overloaded="no"> | |
781d2982 | 20222 | <autodoc>GetColumn(self) -> int</autodoc> |
f32fc4bc RD |
20223 | </method> |
20224 | <method name="GetState" type="long" overloaded="no"> | |
781d2982 | 20225 | <autodoc>GetState(self) -> long</autodoc> |
f32fc4bc RD |
20226 | </method> |
20227 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 20228 | <autodoc>GetText(self) -> String</autodoc> |
f32fc4bc RD |
20229 | </method> |
20230 | <method name="GetImage" type="int" overloaded="no"> | |
781d2982 | 20231 | <autodoc>GetImage(self) -> int</autodoc> |
f32fc4bc RD |
20232 | </method> |
20233 | <method name="GetData" type="long" overloaded="no"> | |
781d2982 | 20234 | <autodoc>GetData(self) -> long</autodoc> |
f32fc4bc RD |
20235 | </method> |
20236 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 20237 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
20238 | </method> |
20239 | <method name="GetAlign" type="wxListColumnFormat" overloaded="no"> | |
781d2982 | 20240 | <autodoc>GetAlign(self) -> int</autodoc> |
f32fc4bc RD |
20241 | </method> |
20242 | <method name="GetAttributes" type="ListItemAttr" overloaded="no"> | |
781d2982 | 20243 | <autodoc>GetAttributes(self) -> ListItemAttr</autodoc> |
f32fc4bc RD |
20244 | </method> |
20245 | <method name="HasAttributes" type="bool" overloaded="no"> | |
781d2982 | 20246 | <autodoc>HasAttributes(self) -> bool</autodoc> |
f32fc4bc RD |
20247 | </method> |
20248 | <method name="GetTextColour" type="Colour" overloaded="no"> | |
781d2982 | 20249 | <autodoc>GetTextColour(self) -> Colour</autodoc> |
f32fc4bc RD |
20250 | </method> |
20251 | <method name="GetBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 20252 | <autodoc>GetBackgroundColour(self) -> Colour</autodoc> |
f32fc4bc RD |
20253 | </method> |
20254 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 20255 | <autodoc>GetFont(self) -> Font</autodoc> |
f32fc4bc RD |
20256 | </method> |
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"/> | |
20267 | </class> | |
20268 | <pythoncode> | |
20269 | #--------------------------------------------------------------------------- | |
20270 | </pythoncode> | |
781d2982 | 20271 | <class name="ListEvent" oldname="wxListEvent" module="_controls"> |
f32fc4bc RD |
20272 | <baseclass name="NotifyEvent"/> |
20273 | <constructor name="ListEvent" overloaded="no"> | |
781d2982 | 20274 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> ListEvent</autodoc> |
f32fc4bc RD |
20275 | <paramlist> |
20276 | <param name="commandType" type="wxEventType" default="wxEVT_NULL"/> | |
20277 | <param name="id" type="int" default="0"/> | |
20278 | </paramlist> | |
20279 | </constructor> | |
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"> | |
781d2982 | 20287 | <autodoc>GetKeyCode(self) -> int</autodoc> |
f32fc4bc RD |
20288 | </method> |
20289 | <method name="GetIndex" type="long" overloaded="no"> | |
781d2982 | 20290 | <autodoc>GetIndex(self) -> long</autodoc> |
f32fc4bc RD |
20291 | </method> |
20292 | <method name="GetColumn" type="int" overloaded="no"> | |
781d2982 | 20293 | <autodoc>GetColumn(self) -> int</autodoc> |
f32fc4bc RD |
20294 | </method> |
20295 | <method name="GetPoint" type="Point" overloaded="no"> | |
781d2982 | 20296 | <autodoc>GetPoint(self) -> Point</autodoc> |
f32fc4bc RD |
20297 | </method> |
20298 | <method name="GetLabel" type="String" overloaded="no"> | |
781d2982 | 20299 | <autodoc>GetLabel(self) -> String</autodoc> |
f32fc4bc RD |
20300 | </method> |
20301 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 20302 | <autodoc>GetText(self) -> String</autodoc> |
f32fc4bc RD |
20303 | </method> |
20304 | <method name="GetImage" type="int" overloaded="no"> | |
781d2982 | 20305 | <autodoc>GetImage(self) -> int</autodoc> |
f32fc4bc RD |
20306 | </method> |
20307 | <method name="GetData" type="long" overloaded="no"> | |
781d2982 | 20308 | <autodoc>GetData(self) -> long</autodoc> |
f32fc4bc RD |
20309 | </method> |
20310 | <method name="GetMask" type="long" overloaded="no"> | |
781d2982 | 20311 | <autodoc>GetMask(self) -> long</autodoc> |
f32fc4bc RD |
20312 | </method> |
20313 | <method name="GetItem" type="ListItem" overloaded="no"> | |
781d2982 | 20314 | <autodoc>GetItem(self) -> ListItem</autodoc> |
f32fc4bc RD |
20315 | </method> |
20316 | <method name="GetCacheFrom" type="long" overloaded="no"> | |
781d2982 | 20317 | <autodoc>GetCacheFrom(self) -> long</autodoc> |
f32fc4bc RD |
20318 | </method> |
20319 | <method name="GetCacheTo" type="long" overloaded="no"> | |
781d2982 | 20320 | <autodoc>GetCacheTo(self) -> long</autodoc> |
f32fc4bc RD |
20321 | </method> |
20322 | <method name="IsEditCancelled" type="bool" overloaded="no"> | |
781d2982 | 20323 | <autodoc>IsEditCancelled(self) -> bool</autodoc> |
f32fc4bc RD |
20324 | </method> |
20325 | <method name="SetEditCanceled" type="" overloaded="no"> | |
781d2982 | 20326 | <autodoc>SetEditCanceled(self, bool editCancelled)</autodoc> |
f32fc4bc RD |
20327 | <paramlist> |
20328 | <param name="editCancelled" type="bool" default=""/> | |
20329 | </paramlist> | |
20330 | </method> | |
20331 | </class> | |
20332 | <pythoncode> | |
20333 | ||
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) | |
20356 | </pythoncode> | |
20357 | <pythoncode> | |
20358 | #--------------------------------------------------------------------------- | |
20359 | </pythoncode> | |
781d2982 | 20360 | <class name="ListCtrl" oldname="wxPyListCtrl" module="_controls"> |
f32fc4bc RD |
20361 | <baseclass name="Control"/> |
20362 | <constructor name="wxPyListCtrl" overloaded="no"> | |
781d2982 | 20363 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
20364 | Size size=DefaultSize, long style=LC_ICON, |
20365 | Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListCtrl</autodoc> | |
20366 | <paramlist> | |
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"/> | |
20374 | </paramlist> | |
20375 | </constructor> | |
20376 | <constructor name="PreListCtrl" overloaded="no"> | |
20377 | <autodoc>PreListCtrl() -> ListCtrl</autodoc> | |
20378 | </constructor> | |
20379 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 20380 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
20381 | Size size=DefaultSize, long style=LC_ICON, |
20382 | Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool</autodoc> | |
c2dda882 | 20383 | <docstring>Do the 2nd phase and create the GUI control.</docstring> |
f32fc4bc RD |
20384 | <paramlist> |
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"/> | |
20392 | </paramlist> | |
20393 | </method> | |
20394 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 20395 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
20396 | <paramlist> |
20397 | <param name="self" type="PyObject" default=""/> | |
20398 | <param name="_class" type="PyObject" default=""/> | |
20399 | </paramlist> | |
20400 | </method> | |
20401 | <method name="SetForegroundColour" type="bool" overloaded="no"> | |
781d2982 | 20402 | <autodoc>SetForegroundColour(self, Colour col) -> bool</autodoc> |
f32fc4bc RD |
20403 | <paramlist> |
20404 | <param name="col" type="Colour" default=""/> | |
20405 | </paramlist> | |
20406 | </method> | |
20407 | <method name="SetBackgroundColour" type="bool" overloaded="no"> | |
781d2982 | 20408 | <autodoc>SetBackgroundColour(self, Colour col) -> bool</autodoc> |
f32fc4bc RD |
20409 | <paramlist> |
20410 | <param name="col" type="Colour" default=""/> | |
20411 | </paramlist> | |
20412 | </method> | |
20413 | <method name="GetColumn" type="ListItem" overloaded="no"> | |
781d2982 | 20414 | <autodoc>GetColumn(self, int col) -> ListItem</autodoc> |
f32fc4bc RD |
20415 | <paramlist> |
20416 | <param name="col" type="int" default=""/> | |
20417 | </paramlist> | |
20418 | </method> | |
20419 | <method name="SetColumn" type="bool" overloaded="no"> | |
781d2982 | 20420 | <autodoc>SetColumn(self, int col, ListItem item) -> bool</autodoc> |
f32fc4bc RD |
20421 | <paramlist> |
20422 | <param name="col" type="int" default=""/> | |
20423 | <param name="item" type="ListItem" default=""/> | |
20424 | </paramlist> | |
20425 | </method> | |
20426 | <method name="GetColumnWidth" type="int" overloaded="no"> | |
781d2982 | 20427 | <autodoc>GetColumnWidth(self, int col) -> int</autodoc> |
f32fc4bc RD |
20428 | <paramlist> |
20429 | <param name="col" type="int" default=""/> | |
20430 | </paramlist> | |
20431 | </method> | |
20432 | <method name="SetColumnWidth" type="bool" overloaded="no"> | |
781d2982 | 20433 | <autodoc>SetColumnWidth(self, int col, int width) -> bool</autodoc> |
f32fc4bc RD |
20434 | <paramlist> |
20435 | <param name="col" type="int" default=""/> | |
20436 | <param name="width" type="int" default=""/> | |
20437 | </paramlist> | |
20438 | </method> | |
20439 | <method name="GetCountPerPage" type="int" overloaded="no"> | |
781d2982 | 20440 | <autodoc>GetCountPerPage(self) -> int</autodoc> |
f32fc4bc RD |
20441 | </method> |
20442 | <method name="GetViewRect" type="Rect" overloaded="no"> | |
781d2982 | 20443 | <autodoc>GetViewRect(self) -> Rect</autodoc> |
f32fc4bc RD |
20444 | </method> |
20445 | <method name="GetItem" type="ListItem" overloaded="no"> | |
781d2982 | 20446 | <autodoc>GetItem(self, long itemId, int col=0) -> ListItem</autodoc> |
f32fc4bc RD |
20447 | <paramlist> |
20448 | <param name="itemId" type="long" default=""/> | |
20449 | <param name="col" type="int" default="0"/> | |
20450 | </paramlist> | |
20451 | </method> | |
20452 | <method name="SetItem" type="bool" overloaded="no"> | |
781d2982 | 20453 | <autodoc>SetItem(self, ListItem info) -> bool</autodoc> |
f32fc4bc RD |
20454 | <paramlist> |
20455 | <param name="info" type="ListItem" default=""/> | |
20456 | </paramlist> | |
20457 | </method> | |
20458 | <method name="SetStringItem" type="long" overloaded="no"> | |
781d2982 | 20459 | <autodoc>SetStringItem(self, long index, int col, String label, int imageId=-1) -> long</autodoc> |
f32fc4bc RD |
20460 | <paramlist> |
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"/> | |
20465 | </paramlist> | |
20466 | </method> | |
20467 | <method name="GetItemState" type="int" overloaded="no"> | |
781d2982 | 20468 | <autodoc>GetItemState(self, long item, long stateMask) -> int</autodoc> |
f32fc4bc RD |
20469 | <paramlist> |
20470 | <param name="item" type="long" default=""/> | |
20471 | <param name="stateMask" type="long" default=""/> | |
20472 | </paramlist> | |
20473 | </method> | |
20474 | <method name="SetItemState" type="bool" overloaded="no"> | |
781d2982 | 20475 | <autodoc>SetItemState(self, long item, long state, long stateMask) -> bool</autodoc> |
f32fc4bc RD |
20476 | <paramlist> |
20477 | <param name="item" type="long" default=""/> | |
20478 | <param name="state" type="long" default=""/> | |
20479 | <param name="stateMask" type="long" default=""/> | |
20480 | </paramlist> | |
20481 | </method> | |
20482 | <method name="SetItemImage" type="bool" overloaded="no"> | |
781d2982 | 20483 | <autodoc>SetItemImage(self, long item, int image, int selImage) -> bool</autodoc> |
f32fc4bc RD |
20484 | <paramlist> |
20485 | <param name="item" type="long" default=""/> | |
20486 | <param name="image" type="int" default=""/> | |
20487 | <param name="selImage" type="int" default=""/> | |
20488 | </paramlist> | |
20489 | </method> | |
20490 | <method name="GetItemText" type="String" overloaded="no"> | |
781d2982 | 20491 | <autodoc>GetItemText(self, long item) -> String</autodoc> |
f32fc4bc RD |
20492 | <paramlist> |
20493 | <param name="item" type="long" default=""/> | |
20494 | </paramlist> | |
20495 | </method> | |
20496 | <method name="SetItemText" type="" overloaded="no"> | |
781d2982 | 20497 | <autodoc>SetItemText(self, long item, String str)</autodoc> |
f32fc4bc RD |
20498 | <paramlist> |
20499 | <param name="item" type="long" default=""/> | |
20500 | <param name="str" type="String" default=""/> | |
20501 | </paramlist> | |
20502 | </method> | |
20503 | <method name="GetItemData" type="long" overloaded="no"> | |
781d2982 | 20504 | <autodoc>GetItemData(self, long item) -> long</autodoc> |
f32fc4bc RD |
20505 | <paramlist> |
20506 | <param name="item" type="long" default=""/> | |
20507 | </paramlist> | |
20508 | </method> | |
20509 | <method name="SetItemData" type="bool" overloaded="no"> | |
781d2982 | 20510 | <autodoc>SetItemData(self, long item, long data) -> bool</autodoc> |
f32fc4bc RD |
20511 | <paramlist> |
20512 | <param name="item" type="long" default=""/> | |
20513 | <param name="data" type="long" default=""/> | |
20514 | </paramlist> | |
20515 | </method> | |
20516 | <method name="GetItemPosition" type="Point" overloaded="no"> | |
781d2982 | 20517 | <autodoc>GetItemPosition(self, long item) -> Point</autodoc> |
f32fc4bc RD |
20518 | <paramlist> |
20519 | <param name="item" type="long" default=""/> | |
20520 | </paramlist> | |
20521 | </method> | |
20522 | <method name="GetItemRect" type="Rect" overloaded="no"> | |
781d2982 | 20523 | <autodoc>GetItemRect(self, long item, int code=LIST_RECT_BOUNDS) -> Rect</autodoc> |
f32fc4bc RD |
20524 | <paramlist> |
20525 | <param name="item" type="long" default=""/> | |
20526 | <param name="code" type="int" default="wxLIST_RECT_BOUNDS"/> | |
20527 | </paramlist> | |
20528 | </method> | |
20529 | <method name="SetItemPosition" type="bool" overloaded="no"> | |
781d2982 | 20530 | <autodoc>SetItemPosition(self, long item, Point pos) -> bool</autodoc> |
f32fc4bc RD |
20531 | <paramlist> |
20532 | <param name="item" type="long" default=""/> | |
20533 | <param name="pos" type="Point" default=""/> | |
20534 | </paramlist> | |
20535 | </method> | |
20536 | <method name="GetItemCount" type="int" overloaded="no"> | |
781d2982 | 20537 | <autodoc>GetItemCount(self) -> int</autodoc> |
f32fc4bc RD |
20538 | </method> |
20539 | <method name="GetColumnCount" type="int" overloaded="no"> | |
781d2982 | 20540 | <autodoc>GetColumnCount(self) -> int</autodoc> |
f32fc4bc RD |
20541 | </method> |
20542 | <method name="GetItemSpacing" type="Size" overloaded="no"> | |
781d2982 | 20543 | <autodoc>GetItemSpacing(self) -> Size</autodoc> |
f32fc4bc RD |
20544 | </method> |
20545 | <method name="SetItemSpacing" type="" overloaded="no"> | |
781d2982 | 20546 | <autodoc>SetItemSpacing(self, int spacing, bool isSmall=False)</autodoc> |
f32fc4bc RD |
20547 | <paramlist> |
20548 | <param name="spacing" type="int" default=""/> | |
20549 | <param name="isSmall" type="bool" default="False"/> | |
20550 | </paramlist> | |
20551 | </method> | |
20552 | <method name="GetSelectedItemCount" type="int" overloaded="no"> | |
781d2982 | 20553 | <autodoc>GetSelectedItemCount(self) -> int</autodoc> |
f32fc4bc RD |
20554 | </method> |
20555 | <method name="GetTextColour" type="Colour" overloaded="no"> | |
781d2982 | 20556 | <autodoc>GetTextColour(self) -> Colour</autodoc> |
f32fc4bc RD |
20557 | </method> |
20558 | <method name="SetTextColour" type="" overloaded="no"> | |
781d2982 | 20559 | <autodoc>SetTextColour(self, Colour col)</autodoc> |
f32fc4bc RD |
20560 | <paramlist> |
20561 | <param name="col" type="Colour" default=""/> | |
20562 | </paramlist> | |
20563 | </method> | |
20564 | <method name="GetTopItem" type="long" overloaded="no"> | |
781d2982 | 20565 | <autodoc>GetTopItem(self) -> long</autodoc> |
f32fc4bc RD |
20566 | </method> |
20567 | <method name="SetSingleStyle" type="" overloaded="no"> | |
781d2982 | 20568 | <autodoc>SetSingleStyle(self, long style, bool add=True)</autodoc> |
f32fc4bc RD |
20569 | <paramlist> |
20570 | <param name="style" type="long" default=""/> | |
20571 | <param name="add" type="bool" default="True"/> | |
20572 | </paramlist> | |
20573 | </method> | |
20574 | <method name="SetWindowStyleFlag" type="" overloaded="no"> | |
781d2982 | 20575 | <autodoc>SetWindowStyleFlag(self, long style)</autodoc> |
c2dda882 | 20576 | <docstring>Sets the style of the window. Please note that some styles cannot be |
781d2982 RD |
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> | |
f32fc4bc RD |
20580 | <paramlist> |
20581 | <param name="style" type="long" default=""/> | |
20582 | </paramlist> | |
20583 | </method> | |
20584 | <method name="GetNextItem" type="long" overloaded="no"> | |
781d2982 | 20585 | <autodoc>GetNextItem(self, long item, int geometry=LIST_NEXT_ALL, int state=LIST_STATE_DONTCARE) -> long</autodoc> |
f32fc4bc RD |
20586 | <paramlist> |
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"/> | |
20590 | </paramlist> | |
20591 | </method> | |
20592 | <method name="GetImageList" type="ImageList" overloaded="no"> | |
781d2982 | 20593 | <autodoc>GetImageList(self, int which) -> ImageList</autodoc> |
f32fc4bc RD |
20594 | <paramlist> |
20595 | <param name="which" type="int" default=""/> | |
20596 | </paramlist> | |
20597 | </method> | |
20598 | <method name="SetImageList" type="" overloaded="no"> | |
781d2982 | 20599 | <autodoc>SetImageList(self, ImageList imageList, int which)</autodoc> |
f32fc4bc RD |
20600 | <paramlist> |
20601 | <param name="imageList" type="ImageList" default=""/> | |
20602 | <param name="which" type="int" default=""/> | |
20603 | </paramlist> | |
20604 | </method> | |
20605 | <method name="AssignImageList" type="" overloaded="no"> | |
781d2982 | 20606 | <autodoc>AssignImageList(self, ImageList imageList, int which)</autodoc> |
f32fc4bc RD |
20607 | <paramlist> |
20608 | <param name="imageList" type="ImageList" default=""/> | |
20609 | <param name="which" type="int" default=""/> | |
20610 | </paramlist> | |
20611 | </method> | |
b39e211b | 20612 | <method name="InReportView" type="bool" overloaded="no"> |
781d2982 | 20613 | <autodoc>InReportView(self) -> bool</autodoc> |
b39e211b | 20614 | </method> |
f32fc4bc | 20615 | <method name="IsVirtual" type="bool" overloaded="no"> |
781d2982 | 20616 | <autodoc>IsVirtual(self) -> bool</autodoc> |
f32fc4bc RD |
20617 | </method> |
20618 | <method name="RefreshItem" type="" overloaded="no"> | |
781d2982 | 20619 | <autodoc>RefreshItem(self, long item)</autodoc> |
f32fc4bc RD |
20620 | <paramlist> |
20621 | <param name="item" type="long" default=""/> | |
20622 | </paramlist> | |
20623 | </method> | |
20624 | <method name="RefreshItems" type="" overloaded="no"> | |
781d2982 | 20625 | <autodoc>RefreshItems(self, long itemFrom, long itemTo)</autodoc> |
f32fc4bc RD |
20626 | <paramlist> |
20627 | <param name="itemFrom" type="long" default=""/> | |
20628 | <param name="itemTo" type="long" default=""/> | |
20629 | </paramlist> | |
20630 | </method> | |
20631 | <method name="Arrange" type="bool" overloaded="no"> | |
781d2982 | 20632 | <autodoc>Arrange(self, int flag=LIST_ALIGN_DEFAULT) -> bool</autodoc> |
f32fc4bc RD |
20633 | <paramlist> |
20634 | <param name="flag" type="int" default="wxLIST_ALIGN_DEFAULT"/> | |
20635 | </paramlist> | |
20636 | </method> | |
20637 | <method name="DeleteItem" type="bool" overloaded="no"> | |
781d2982 | 20638 | <autodoc>DeleteItem(self, long item) -> bool</autodoc> |
f32fc4bc RD |
20639 | <paramlist> |
20640 | <param name="item" type="long" default=""/> | |
20641 | </paramlist> | |
20642 | </method> | |
20643 | <method name="DeleteAllItems" type="bool" overloaded="no"> | |
781d2982 | 20644 | <autodoc>DeleteAllItems(self) -> bool</autodoc> |
f32fc4bc RD |
20645 | </method> |
20646 | <method name="DeleteColumn" type="bool" overloaded="no"> | |
781d2982 | 20647 | <autodoc>DeleteColumn(self, int col) -> bool</autodoc> |
f32fc4bc RD |
20648 | <paramlist> |
20649 | <param name="col" type="int" default=""/> | |
20650 | </paramlist> | |
20651 | </method> | |
20652 | <method name="DeleteAllColumns" type="bool" overloaded="no"> | |
781d2982 | 20653 | <autodoc>DeleteAllColumns(self) -> bool</autodoc> |
f32fc4bc RD |
20654 | </method> |
20655 | <method name="ClearAll" type="" overloaded="no"> | |
781d2982 | 20656 | <autodoc>ClearAll(self)</autodoc> |
f32fc4bc RD |
20657 | </method> |
20658 | <method name="EditLabel" type="" overloaded="no"> | |
781d2982 | 20659 | <autodoc>EditLabel(self, long item)</autodoc> |
f32fc4bc RD |
20660 | <paramlist> |
20661 | <param name="item" type="long" default=""/> | |
20662 | </paramlist> | |
20663 | </method> | |
20664 | <method name="EnsureVisible" type="bool" overloaded="no"> | |
781d2982 | 20665 | <autodoc>EnsureVisible(self, long item) -> bool</autodoc> |
f32fc4bc RD |
20666 | <paramlist> |
20667 | <param name="item" type="long" default=""/> | |
20668 | </paramlist> | |
20669 | </method> | |
20670 | <method name="FindItem" type="long" overloaded="no"> | |
781d2982 | 20671 | <autodoc>FindItem(self, long start, String str, bool partial=False) -> long</autodoc> |
f32fc4bc RD |
20672 | <paramlist> |
20673 | <param name="start" type="long" default=""/> | |
20674 | <param name="str" type="String" default=""/> | |
20675 | <param name="partial" type="bool" default="False"/> | |
20676 | </paramlist> | |
20677 | </method> | |
20678 | <method name="FindItemData" type="long" overloaded="no"> | |
781d2982 | 20679 | <autodoc>FindItemData(self, long start, long data) -> long</autodoc> |
f32fc4bc RD |
20680 | <paramlist> |
20681 | <param name="start" type="long" default=""/> | |
20682 | <param name="data" type="long" default=""/> | |
20683 | </paramlist> | |
20684 | </method> | |
20685 | <method name="FindItemAtPos" type="long" overloaded="no"> | |
781d2982 | 20686 | <autodoc>FindItemAtPos(self, long start, Point pt, int direction) -> long</autodoc> |
f32fc4bc RD |
20687 | <paramlist> |
20688 | <param name="start" type="long" default=""/> | |
20689 | <param name="pt" type="Point" default=""/> | |
20690 | <param name="direction" type="int" default=""/> | |
20691 | </paramlist> | |
20692 | </method> | |
20693 | <method name="HitTest" type="long" overloaded="no"> | |
20694 | <autodoc>HitTest(Point point) -> (item, where)</autodoc> | |
ce6878e6 RD |
20695 | <docstring>Determines which item (if any) is at the specified point, giving |
20696 | in the second return value (see wxLIST_HITTEST_... flags.)</docstring> | |
f32fc4bc RD |
20697 | <paramlist> |
20698 | <param name="point" type="Point" default=""/> | |
20699 | <param name="OUTPUT" type="int" default=""/> | |
20700 | </paramlist> | |
20701 | </method> | |
20702 | <method name="InsertItem" type="long" overloaded="no"> | |
781d2982 | 20703 | <autodoc>InsertItem(self, ListItem info) -> long</autodoc> |
f32fc4bc RD |
20704 | <paramlist> |
20705 | <param name="info" type="ListItem" default=""/> | |
20706 | </paramlist> | |
20707 | </method> | |
20708 | <method name="InsertStringItem" type="long" overloaded="no"> | |
781d2982 | 20709 | <autodoc>InsertStringItem(self, long index, String label) -> long</autodoc> |
f32fc4bc RD |
20710 | <paramlist> |
20711 | <param name="index" type="long" default=""/> | |
20712 | <param name="label" type="String" default=""/> | |
20713 | </paramlist> | |
20714 | </method> | |
20715 | <method name="InsertImageItem" type="long" overloaded="no"> | |
781d2982 | 20716 | <autodoc>InsertImageItem(self, long index, int imageIndex) -> long</autodoc> |
f32fc4bc RD |
20717 | <paramlist> |
20718 | <param name="index" type="long" default=""/> | |
20719 | <param name="imageIndex" type="int" default=""/> | |
20720 | </paramlist> | |
20721 | </method> | |
20722 | <method name="InsertImageStringItem" type="long" overloaded="no"> | |
781d2982 | 20723 | <autodoc>InsertImageStringItem(self, long index, String label, int imageIndex) -> long</autodoc> |
f32fc4bc RD |
20724 | <paramlist> |
20725 | <param name="index" type="long" default=""/> | |
20726 | <param name="label" type="String" default=""/> | |
20727 | <param name="imageIndex" type="int" default=""/> | |
20728 | </paramlist> | |
20729 | </method> | |
20730 | <method name="InsertColumnInfo" type="long" overloaded="no"> | |
781d2982 | 20731 | <autodoc>InsertColumnInfo(self, long col, ListItem info) -> long</autodoc> |
f32fc4bc RD |
20732 | <paramlist> |
20733 | <param name="col" type="long" default=""/> | |
20734 | <param name="info" type="ListItem" default=""/> | |
20735 | </paramlist> | |
20736 | </method> | |
20737 | <method name="InsertColumn" type="long" overloaded="no"> | |
781d2982 | 20738 | <autodoc>InsertColumn(self, long col, String heading, int format=LIST_FORMAT_LEFT, |
f32fc4bc RD |
20739 | int width=-1) -> long</autodoc> |
20740 | <paramlist> | |
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"/> | |
20745 | </paramlist> | |
20746 | </method> | |
20747 | <method name="SetItemCount" type="" overloaded="no"> | |
781d2982 | 20748 | <autodoc>SetItemCount(self, long count)</autodoc> |
f32fc4bc RD |
20749 | <paramlist> |
20750 | <param name="count" type="long" default=""/> | |
20751 | </paramlist> | |
20752 | </method> | |
20753 | <method name="ScrollList" type="bool" overloaded="no"> | |
781d2982 | 20754 | <autodoc>ScrollList(self, int dx, int dy) -> bool</autodoc> |
f32fc4bc RD |
20755 | <paramlist> |
20756 | <param name="dx" type="int" default=""/> | |
20757 | <param name="dy" type="int" default=""/> | |
20758 | </paramlist> | |
20759 | </method> | |
20760 | <method name="SetItemTextColour" type="" overloaded="no"> | |
781d2982 | 20761 | <autodoc>SetItemTextColour(self, long item, Colour col)</autodoc> |
f32fc4bc RD |
20762 | <paramlist> |
20763 | <param name="item" type="long" default=""/> | |
20764 | <param name="col" type="Colour" default=""/> | |
20765 | </paramlist> | |
20766 | </method> | |
20767 | <method name="GetItemTextColour" type="Colour" overloaded="no"> | |
781d2982 | 20768 | <autodoc>GetItemTextColour(self, long item) -> Colour</autodoc> |
f32fc4bc RD |
20769 | <paramlist> |
20770 | <param name="item" type="long" default=""/> | |
20771 | </paramlist> | |
20772 | </method> | |
20773 | <method name="SetItemBackgroundColour" type="" overloaded="no"> | |
781d2982 | 20774 | <autodoc>SetItemBackgroundColour(self, long item, Colour col)</autodoc> |
f32fc4bc RD |
20775 | <paramlist> |
20776 | <param name="item" type="long" default=""/> | |
20777 | <param name="col" type="Colour" default=""/> | |
20778 | </paramlist> | |
20779 | </method> | |
20780 | <method name="GetItemBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 20781 | <autodoc>GetItemBackgroundColour(self, long item) -> Colour</autodoc> |
f32fc4bc RD |
20782 | <paramlist> |
20783 | <param name="item" type="long" default=""/> | |
20784 | </paramlist> | |
20785 | </method> | |
20786 | <method name="SortItems" type="bool" overloaded="no"> | |
781d2982 | 20787 | <autodoc>SortItems(self, PyObject func) -> bool</autodoc> |
f32fc4bc RD |
20788 | <paramlist> |
20789 | <param name="func" type="PyObject" default=""/> | |
20790 | </paramlist> | |
20791 | </method> | |
20792 | <method name="GetMainWindow" type="Window" overloaded="no"> | |
781d2982 | 20793 | <autodoc>GetMainWindow(self) -> Window</autodoc> |
f32fc4bc | 20794 | </method> |
781d2982 RD |
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. | |
20802 | ||
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 | |
20806 | this.</docstring> | |
20807 | <paramlist> | |
20808 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
20809 | </paramlist> | |
20810 | </staticmethod> | |
f32fc4bc RD |
20811 | </class> |
20812 | <pythoncode> | |
20813 | #--------------------------------------------------------------------------- | |
20814 | </pythoncode> | |
781d2982 | 20815 | <class name="ListView" oldname="wxListView" module="_controls"> |
f32fc4bc RD |
20816 | <baseclass name="ListCtrl"/> |
20817 | <constructor name="ListView" overloaded="no"> | |
781d2982 | 20818 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
20819 | Size size=DefaultSize, long style=LC_REPORT, |
20820 | Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> ListView</autodoc> | |
20821 | <paramlist> | |
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"/> | |
20829 | </paramlist> | |
20830 | </constructor> | |
20831 | <constructor name="PreListView" overloaded="no"> | |
20832 | <autodoc>PreListView() -> ListView</autodoc> | |
20833 | </constructor> | |
20834 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 20835 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
20836 | Size size=DefaultSize, long style=LC_REPORT, |
20837 | Validator validator=DefaultValidator, String name=ListCtrlNameStr) -> bool</autodoc> | |
c2dda882 | 20838 | <docstring>Do the 2nd phase and create the GUI control.</docstring> |
f32fc4bc RD |
20839 | <paramlist> |
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"/> | |
20847 | </paramlist> | |
20848 | </method> | |
20849 | <method name="Select" type="" overloaded="no"> | |
781d2982 | 20850 | <autodoc>Select(self, long n, bool on=True)</autodoc> |
f32fc4bc RD |
20851 | <paramlist> |
20852 | <param name="n" type="long" default=""/> | |
20853 | <param name="on" type="bool" default="True"/> | |
20854 | </paramlist> | |
20855 | </method> | |
20856 | <method name="Focus" type="" overloaded="no"> | |
781d2982 | 20857 | <autodoc>Focus(self, long index)</autodoc> |
f32fc4bc RD |
20858 | <paramlist> |
20859 | <param name="index" type="long" default=""/> | |
20860 | </paramlist> | |
20861 | </method> | |
20862 | <method name="GetFocusedItem" type="long" overloaded="no"> | |
781d2982 | 20863 | <autodoc>GetFocusedItem(self) -> long</autodoc> |
f32fc4bc RD |
20864 | </method> |
20865 | <method name="GetNextSelected" type="long" overloaded="no"> | |
781d2982 | 20866 | <autodoc>GetNextSelected(self, long item) -> long</autodoc> |
f32fc4bc RD |
20867 | <paramlist> |
20868 | <param name="item" type="long" default=""/> | |
20869 | </paramlist> | |
20870 | </method> | |
20871 | <method name="GetFirstSelected" type="long" overloaded="no"> | |
781d2982 | 20872 | <autodoc>GetFirstSelected(self) -> long</autodoc> |
f32fc4bc RD |
20873 | </method> |
20874 | <method name="IsSelected" type="bool" overloaded="no"> | |
781d2982 | 20875 | <autodoc>IsSelected(self, long index) -> bool</autodoc> |
f32fc4bc RD |
20876 | <paramlist> |
20877 | <param name="index" type="long" default=""/> | |
20878 | </paramlist> | |
20879 | </method> | |
20880 | <method name="SetColumnImage" type="" overloaded="no"> | |
781d2982 | 20881 | <autodoc>SetColumnImage(self, int col, int image)</autodoc> |
f32fc4bc RD |
20882 | <paramlist> |
20883 | <param name="col" type="int" default=""/> | |
20884 | <param name="image" type="int" default=""/> | |
20885 | </paramlist> | |
20886 | </method> | |
20887 | <method name="ClearColumnImage" type="" overloaded="no"> | |
781d2982 | 20888 | <autodoc>ClearColumnImage(self, int col)</autodoc> |
f32fc4bc RD |
20889 | <paramlist> |
20890 | <param name="col" type="int" default=""/> | |
20891 | </paramlist> | |
20892 | </method> | |
20893 | </class> | |
20894 | <pythoncode> | |
20895 | #--------------------------------------------------------------------------- | |
20896 | </pythoncode> | |
20897 | <pythoncode> | |
20898 | #--------------------------------------------------------------------------- | |
20899 | </pythoncode> | |
781d2982 | 20900 | <class name="TreeItemId" oldname="wxTreeItemId" module="_controls"> |
f32fc4bc | 20901 | <constructor name="TreeItemId" overloaded="no"> |
781d2982 | 20902 | <autodoc>__init__(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
20903 | </constructor> |
20904 | <destructor name="~wxTreeItemId" overloaded="no"> | |
781d2982 | 20905 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
20906 | </destructor> |
20907 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 20908 | <autodoc>IsOk(self) -> bool</autodoc> |
f32fc4bc RD |
20909 | </method> |
20910 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 20911 | <autodoc>__eq__(self, TreeItemId other) -> bool</autodoc> |
f32fc4bc RD |
20912 | <paramlist> |
20913 | <param name="other" type="TreeItemId" default=""/> | |
20914 | </paramlist> | |
20915 | </method> | |
20916 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 20917 | <autodoc>__ne__(self, TreeItemId other) -> bool</autodoc> |
f32fc4bc RD |
20918 | <paramlist> |
20919 | <param name="other" type="TreeItemId" default=""/> | |
20920 | </paramlist> | |
20921 | </method> | |
20922 | <property name="m_pItem" type="" readonly="no"/> | |
20923 | </class> | |
781d2982 | 20924 | <class name="TreeItemData" oldname="wxPyTreeItemData" module="_controls"> |
f32fc4bc | 20925 | <constructor name="wxPyTreeItemData" overloaded="no"> |
781d2982 | 20926 | <autodoc>__init__(self, PyObject obj=None) -> TreeItemData</autodoc> |
f32fc4bc RD |
20927 | <paramlist> |
20928 | <param name="obj" type="PyObject" default="NULL"/> | |
20929 | </paramlist> | |
20930 | </constructor> | |
20931 | <method name="GetData" type="PyObject" overloaded="no"> | |
781d2982 | 20932 | <autodoc>GetData(self) -> PyObject</autodoc> |
f32fc4bc RD |
20933 | </method> |
20934 | <method name="SetData" type="" overloaded="no"> | |
781d2982 | 20935 | <autodoc>SetData(self, PyObject obj)</autodoc> |
f32fc4bc RD |
20936 | <paramlist> |
20937 | <param name="obj" type="PyObject" default=""/> | |
20938 | </paramlist> | |
20939 | </method> | |
20940 | <method name="GetId" type="TreeItemId" overloaded="no"> | |
781d2982 | 20941 | <autodoc>GetId(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
20942 | </method> |
20943 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 20944 | <autodoc>SetId(self, TreeItemId id)</autodoc> |
f32fc4bc RD |
20945 | <paramlist> |
20946 | <param name="id" type="TreeItemId" default=""/> | |
20947 | </paramlist> | |
20948 | </method> | |
20949 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 20950 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
20951 | </method> |
20952 | </class> | |
20953 | <pythoncode> | |
20954 | #--------------------------------------------------------------------------- | |
20955 | </pythoncode> | |
20956 | <pythoncode> | |
20957 | ||
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) | |
20978 | </pythoncode> | |
781d2982 | 20979 | <class name="TreeEvent" oldname="wxTreeEvent" module="_controls"> |
f32fc4bc RD |
20980 | <baseclass name="NotifyEvent"/> |
20981 | <constructor name="TreeEvent" overloaded="no"> | |
781d2982 | 20982 | <autodoc>__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> TreeEvent</autodoc> |
f32fc4bc RD |
20983 | <paramlist> |
20984 | <param name="commandType" type="wxEventType" default="wxEVT_NULL"/> | |
20985 | <param name="id" type="int" default="0"/> | |
20986 | </paramlist> | |
20987 | </constructor> | |
20988 | <method name="GetItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 20989 | <autodoc>GetItem(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
20990 | </method> |
20991 | <method name="SetItem" type="" overloaded="no"> | |
781d2982 | 20992 | <autodoc>SetItem(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
20993 | <paramlist> |
20994 | <param name="item" type="TreeItemId" default=""/> | |
20995 | </paramlist> | |
20996 | </method> | |
20997 | <method name="GetOldItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 20998 | <autodoc>GetOldItem(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
20999 | </method> |
21000 | <method name="SetOldItem" type="" overloaded="no"> | |
781d2982 | 21001 | <autodoc>SetOldItem(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21002 | <paramlist> |
21003 | <param name="item" type="TreeItemId" default=""/> | |
21004 | </paramlist> | |
21005 | </method> | |
21006 | <method name="GetPoint" type="Point" overloaded="no"> | |
781d2982 | 21007 | <autodoc>GetPoint(self) -> Point</autodoc> |
f32fc4bc RD |
21008 | </method> |
21009 | <method name="SetPoint" type="" overloaded="no"> | |
781d2982 | 21010 | <autodoc>SetPoint(self, Point pt)</autodoc> |
f32fc4bc RD |
21011 | <paramlist> |
21012 | <param name="pt" type="Point" default=""/> | |
21013 | </paramlist> | |
21014 | </method> | |
21015 | <method name="GetKeyEvent" type="KeyEvent" overloaded="no"> | |
781d2982 | 21016 | <autodoc>GetKeyEvent(self) -> KeyEvent</autodoc> |
f32fc4bc RD |
21017 | </method> |
21018 | <method name="GetKeyCode" type="int" overloaded="no"> | |
781d2982 | 21019 | <autodoc>GetKeyCode(self) -> int</autodoc> |
f32fc4bc RD |
21020 | </method> |
21021 | <method name="SetKeyEvent" type="" overloaded="no"> | |
781d2982 | 21022 | <autodoc>SetKeyEvent(self, KeyEvent evt)</autodoc> |
f32fc4bc RD |
21023 | <paramlist> |
21024 | <param name="evt" type="KeyEvent" default=""/> | |
21025 | </paramlist> | |
21026 | </method> | |
21027 | <method name="GetLabel" type="String" overloaded="no"> | |
781d2982 | 21028 | <autodoc>GetLabel(self) -> String</autodoc> |
f32fc4bc RD |
21029 | </method> |
21030 | <method name="SetLabel" type="" overloaded="no"> | |
781d2982 | 21031 | <autodoc>SetLabel(self, String label)</autodoc> |
f32fc4bc RD |
21032 | <paramlist> |
21033 | <param name="label" type="String" default=""/> | |
21034 | </paramlist> | |
21035 | </method> | |
21036 | <method name="IsEditCancelled" type="bool" overloaded="no"> | |
781d2982 | 21037 | <autodoc>IsEditCancelled(self) -> bool</autodoc> |
f32fc4bc RD |
21038 | </method> |
21039 | <method name="SetEditCanceled" type="" overloaded="no"> | |
781d2982 | 21040 | <autodoc>SetEditCanceled(self, bool editCancelled)</autodoc> |
f32fc4bc RD |
21041 | <paramlist> |
21042 | <param name="editCancelled" type="bool" default=""/> | |
21043 | </paramlist> | |
21044 | </method> | |
21045 | <method name="SetToolTip" type="" overloaded="no"> | |
781d2982 | 21046 | <autodoc>SetToolTip(self, String toolTip)</autodoc> |
f32fc4bc RD |
21047 | <paramlist> |
21048 | <param name="toolTip" type="String" default=""/> | |
21049 | </paramlist> | |
21050 | </method> | |
21051 | </class> | |
21052 | <pythoncode> | |
21053 | #--------------------------------------------------------------------------- | |
21054 | </pythoncode> | |
781d2982 | 21055 | <class name="TreeCtrl" oldname="wxPyTreeCtrl" module="_controls"> |
f32fc4bc RD |
21056 | <baseclass name="Control"/> |
21057 | <constructor name="wxPyTreeCtrl" overloaded="no"> | |
781d2982 | 21058 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
21059 | Size size=DefaultSize, long style=TR_DEFAULT_STYLE, |
21060 | Validator validator=DefaultValidator, | |
21061 | String name=TreeCtrlNameStr) -> TreeCtrl</autodoc> | |
21062 | <paramlist> | |
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"/> | |
21070 | </paramlist> | |
21071 | </constructor> | |
21072 | <constructor name="PreTreeCtrl" overloaded="no"> | |
21073 | <autodoc>PreTreeCtrl() -> TreeCtrl</autodoc> | |
21074 | </constructor> | |
21075 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 21076 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
21077 | Size size=DefaultSize, long style=TR_DEFAULT_STYLE, |
21078 | Validator validator=DefaultValidator, | |
21079 | String name=TreeCtrlNameStr) -> bool</autodoc> | |
c2dda882 | 21080 | <docstring>Do the 2nd phase and create the GUI control.</docstring> |
f32fc4bc RD |
21081 | <paramlist> |
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"/> | |
21089 | </paramlist> | |
21090 | </method> | |
21091 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 21092 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
21093 | <paramlist> |
21094 | <param name="self" type="PyObject" default=""/> | |
21095 | <param name="_class" type="PyObject" default=""/> | |
21096 | </paramlist> | |
21097 | </method> | |
21098 | <method name="GetCount" type="size_t" overloaded="no"> | |
781d2982 | 21099 | <autodoc>GetCount(self) -> size_t</autodoc> |
f32fc4bc RD |
21100 | </method> |
21101 | <method name="GetIndent" type="unsigned int" overloaded="no"> | |
781d2982 | 21102 | <autodoc>GetIndent(self) -> unsigned int</autodoc> |
f32fc4bc RD |
21103 | </method> |
21104 | <method name="SetIndent" type="" overloaded="no"> | |
781d2982 | 21105 | <autodoc>SetIndent(self, unsigned int indent)</autodoc> |
f32fc4bc RD |
21106 | <paramlist> |
21107 | <param name="indent" type="unsigned int" default=""/> | |
21108 | </paramlist> | |
21109 | </method> | |
21110 | <method name="GetSpacing" type="unsigned int" overloaded="no"> | |
781d2982 | 21111 | <autodoc>GetSpacing(self) -> unsigned int</autodoc> |
f32fc4bc RD |
21112 | </method> |
21113 | <method name="SetSpacing" type="" overloaded="no"> | |
781d2982 | 21114 | <autodoc>SetSpacing(self, unsigned int spacing)</autodoc> |
f32fc4bc RD |
21115 | <paramlist> |
21116 | <param name="spacing" type="unsigned int" default=""/> | |
21117 | </paramlist> | |
21118 | </method> | |
21119 | <method name="GetImageList" type="ImageList" overloaded="no"> | |
781d2982 | 21120 | <autodoc>GetImageList(self) -> ImageList</autodoc> |
f32fc4bc RD |
21121 | </method> |
21122 | <method name="GetStateImageList" type="ImageList" overloaded="no"> | |
781d2982 | 21123 | <autodoc>GetStateImageList(self) -> ImageList</autodoc> |
f32fc4bc RD |
21124 | </method> |
21125 | <method name="SetImageList" type="" overloaded="no"> | |
781d2982 | 21126 | <autodoc>SetImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
21127 | <paramlist> |
21128 | <param name="imageList" type="ImageList" default=""/> | |
21129 | </paramlist> | |
21130 | </method> | |
21131 | <method name="SetStateImageList" type="" overloaded="no"> | |
781d2982 | 21132 | <autodoc>SetStateImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
21133 | <paramlist> |
21134 | <param name="imageList" type="ImageList" default=""/> | |
21135 | </paramlist> | |
21136 | </method> | |
21137 | <method name="AssignImageList" type="" overloaded="no"> | |
781d2982 | 21138 | <autodoc>AssignImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
21139 | <paramlist> |
21140 | <param name="imageList" type="ImageList" default=""/> | |
21141 | </paramlist> | |
21142 | </method> | |
21143 | <method name="AssignStateImageList" type="" overloaded="no"> | |
781d2982 | 21144 | <autodoc>AssignStateImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
21145 | <paramlist> |
21146 | <param name="imageList" type="ImageList" default=""/> | |
21147 | </paramlist> | |
21148 | </method> | |
21149 | <method name="GetItemText" type="String" overloaded="no"> | |
781d2982 | 21150 | <autodoc>GetItemText(self, TreeItemId item) -> String</autodoc> |
f32fc4bc RD |
21151 | <paramlist> |
21152 | <param name="item" type="TreeItemId" default=""/> | |
21153 | </paramlist> | |
21154 | </method> | |
21155 | <method name="GetItemImage" type="int" overloaded="no"> | |
781d2982 | 21156 | <autodoc>GetItemImage(self, TreeItemId item, int which=TreeItemIcon_Normal) -> int</autodoc> |
f32fc4bc RD |
21157 | <paramlist> |
21158 | <param name="item" type="TreeItemId" default=""/> | |
21159 | <param name="which" type="wxTreeItemIcon" default="wxTreeItemIcon_Normal"/> | |
21160 | </paramlist> | |
21161 | </method> | |
21162 | <method name="GetItemData" type="TreeItemData" overloaded="no"> | |
781d2982 | 21163 | <autodoc>GetItemData(self, TreeItemId item) -> TreeItemData</autodoc> |
f32fc4bc RD |
21164 | <paramlist> |
21165 | <param name="item" type="TreeItemId" default=""/> | |
21166 | </paramlist> | |
21167 | </method> | |
21168 | <method name="GetItemPyData" type="PyObject" overloaded="no"> | |
781d2982 | 21169 | <autodoc>GetItemPyData(self, TreeItemId item) -> PyObject</autodoc> |
f32fc4bc RD |
21170 | <paramlist> |
21171 | <param name="item" type="TreeItemId" default=""/> | |
21172 | </paramlist> | |
21173 | </method> | |
21174 | <method name="GetItemTextColour" type="Colour" overloaded="no"> | |
781d2982 | 21175 | <autodoc>GetItemTextColour(self, TreeItemId item) -> Colour</autodoc> |
f32fc4bc RD |
21176 | <paramlist> |
21177 | <param name="item" type="TreeItemId" default=""/> | |
21178 | </paramlist> | |
21179 | </method> | |
21180 | <method name="GetItemBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 21181 | <autodoc>GetItemBackgroundColour(self, TreeItemId item) -> Colour</autodoc> |
f32fc4bc RD |
21182 | <paramlist> |
21183 | <param name="item" type="TreeItemId" default=""/> | |
21184 | </paramlist> | |
21185 | </method> | |
21186 | <method name="GetItemFont" type="Font" overloaded="no"> | |
781d2982 | 21187 | <autodoc>GetItemFont(self, TreeItemId item) -> Font</autodoc> |
f32fc4bc RD |
21188 | <paramlist> |
21189 | <param name="item" type="TreeItemId" default=""/> | |
21190 | </paramlist> | |
21191 | </method> | |
21192 | <method name="SetItemText" type="" overloaded="no"> | |
781d2982 | 21193 | <autodoc>SetItemText(self, TreeItemId item, String text)</autodoc> |
f32fc4bc RD |
21194 | <paramlist> |
21195 | <param name="item" type="TreeItemId" default=""/> | |
21196 | <param name="text" type="String" default=""/> | |
21197 | </paramlist> | |
21198 | </method> | |
21199 | <method name="SetItemImage" type="" overloaded="no"> | |
781d2982 | 21200 | <autodoc>SetItemImage(self, TreeItemId item, int image, int which=TreeItemIcon_Normal)</autodoc> |
f32fc4bc RD |
21201 | <paramlist> |
21202 | <param name="item" type="TreeItemId" default=""/> | |
21203 | <param name="image" type="int" default=""/> | |
21204 | <param name="which" type="wxTreeItemIcon" default="wxTreeItemIcon_Normal"/> | |
21205 | </paramlist> | |
21206 | </method> | |
21207 | <method name="SetItemData" type="" overloaded="no"> | |
781d2982 | 21208 | <autodoc>SetItemData(self, TreeItemId item, TreeItemData data)</autodoc> |
f32fc4bc RD |
21209 | <paramlist> |
21210 | <param name="item" type="TreeItemId" default=""/> | |
21211 | <param name="data" type="TreeItemData" default=""/> | |
21212 | </paramlist> | |
21213 | </method> | |
21214 | <method name="SetItemPyData" type="" overloaded="no"> | |
781d2982 | 21215 | <autodoc>SetItemPyData(self, TreeItemId item, PyObject obj)</autodoc> |
f32fc4bc RD |
21216 | <paramlist> |
21217 | <param name="item" type="TreeItemId" default=""/> | |
21218 | <param name="obj" type="PyObject" default=""/> | |
21219 | </paramlist> | |
21220 | </method> | |
21221 | <method name="SetItemHasChildren" type="" overloaded="no"> | |
781d2982 | 21222 | <autodoc>SetItemHasChildren(self, TreeItemId item, bool has=True)</autodoc> |
f32fc4bc RD |
21223 | <paramlist> |
21224 | <param name="item" type="TreeItemId" default=""/> | |
21225 | <param name="has" type="bool" default="True"/> | |
21226 | </paramlist> | |
21227 | </method> | |
21228 | <method name="SetItemBold" type="" overloaded="no"> | |
781d2982 | 21229 | <autodoc>SetItemBold(self, TreeItemId item, bool bold=True)</autodoc> |
f32fc4bc RD |
21230 | <paramlist> |
21231 | <param name="item" type="TreeItemId" default=""/> | |
21232 | <param name="bold" type="bool" default="True"/> | |
21233 | </paramlist> | |
21234 | </method> | |
21235 | <method name="SetItemTextColour" type="" overloaded="no"> | |
781d2982 | 21236 | <autodoc>SetItemTextColour(self, TreeItemId item, Colour col)</autodoc> |
f32fc4bc RD |
21237 | <paramlist> |
21238 | <param name="item" type="TreeItemId" default=""/> | |
21239 | <param name="col" type="Colour" default=""/> | |
21240 | </paramlist> | |
21241 | </method> | |
21242 | <method name="SetItemBackgroundColour" type="" overloaded="no"> | |
781d2982 | 21243 | <autodoc>SetItemBackgroundColour(self, TreeItemId item, Colour col)</autodoc> |
f32fc4bc RD |
21244 | <paramlist> |
21245 | <param name="item" type="TreeItemId" default=""/> | |
21246 | <param name="col" type="Colour" default=""/> | |
21247 | </paramlist> | |
21248 | </method> | |
21249 | <method name="SetItemFont" type="" overloaded="no"> | |
781d2982 | 21250 | <autodoc>SetItemFont(self, TreeItemId item, Font font)</autodoc> |
f32fc4bc RD |
21251 | <paramlist> |
21252 | <param name="item" type="TreeItemId" default=""/> | |
21253 | <param name="font" type="Font" default=""/> | |
21254 | </paramlist> | |
21255 | </method> | |
21256 | <method name="IsVisible" type="bool" overloaded="no"> | |
781d2982 | 21257 | <autodoc>IsVisible(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
21258 | <paramlist> |
21259 | <param name="item" type="TreeItemId" default=""/> | |
21260 | </paramlist> | |
21261 | </method> | |
21262 | <method name="ItemHasChildren" type="bool" overloaded="no"> | |
781d2982 | 21263 | <autodoc>ItemHasChildren(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
21264 | <paramlist> |
21265 | <param name="item" type="TreeItemId" default=""/> | |
21266 | </paramlist> | |
21267 | </method> | |
21268 | <method name="IsExpanded" type="bool" overloaded="no"> | |
781d2982 | 21269 | <autodoc>IsExpanded(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
21270 | <paramlist> |
21271 | <param name="item" type="TreeItemId" default=""/> | |
21272 | </paramlist> | |
21273 | </method> | |
21274 | <method name="IsSelected" type="bool" overloaded="no"> | |
781d2982 | 21275 | <autodoc>IsSelected(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
21276 | <paramlist> |
21277 | <param name="item" type="TreeItemId" default=""/> | |
21278 | </paramlist> | |
21279 | </method> | |
21280 | <method name="IsBold" type="bool" overloaded="no"> | |
781d2982 | 21281 | <autodoc>IsBold(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
21282 | <paramlist> |
21283 | <param name="item" type="TreeItemId" default=""/> | |
21284 | </paramlist> | |
21285 | </method> | |
21286 | <method name="GetChildrenCount" type="size_t" overloaded="no"> | |
781d2982 | 21287 | <autodoc>GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t</autodoc> |
f32fc4bc RD |
21288 | <paramlist> |
21289 | <param name="item" type="TreeItemId" default=""/> | |
21290 | <param name="recursively" type="bool" default="True"/> | |
21291 | </paramlist> | |
21292 | </method> | |
21293 | <method name="GetRootItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 21294 | <autodoc>GetRootItem(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
21295 | </method> |
21296 | <method name="GetSelection" type="TreeItemId" overloaded="no"> | |
781d2982 | 21297 | <autodoc>GetSelection(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
21298 | </method> |
21299 | <method name="GetSelections" type="PyObject" overloaded="no"> | |
781d2982 | 21300 | <autodoc>GetSelections(self) -> PyObject</autodoc> |
f32fc4bc RD |
21301 | </method> |
21302 | <method name="GetItemParent" type="TreeItemId" overloaded="no"> | |
781d2982 | 21303 | <autodoc>GetItemParent(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
21304 | <paramlist> |
21305 | <param name="item" type="TreeItemId" default=""/> | |
21306 | </paramlist> | |
21307 | </method> | |
21308 | <method name="GetFirstChild" type="PyObject" overloaded="no"> | |
781d2982 | 21309 | <autodoc>GetFirstChild(self, TreeItemId item) -> PyObject</autodoc> |
f32fc4bc RD |
21310 | <paramlist> |
21311 | <param name="item" type="TreeItemId" default=""/> | |
21312 | </paramlist> | |
21313 | </method> | |
21314 | <method name="GetNextChild" type="PyObject" overloaded="no"> | |
781d2982 | 21315 | <autodoc>GetNextChild(self, TreeItemId item, void cookie) -> PyObject</autodoc> |
f32fc4bc RD |
21316 | <paramlist> |
21317 | <param name="item" type="TreeItemId" default=""/> | |
21318 | <param name="cookie" type="" default=""/> | |
21319 | </paramlist> | |
21320 | </method> | |
21321 | <method name="GetLastChild" type="TreeItemId" overloaded="no"> | |
781d2982 | 21322 | <autodoc>GetLastChild(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
21323 | <paramlist> |
21324 | <param name="item" type="TreeItemId" default=""/> | |
21325 | </paramlist> | |
21326 | </method> | |
21327 | <method name="GetNextSibling" type="TreeItemId" overloaded="no"> | |
781d2982 | 21328 | <autodoc>GetNextSibling(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
21329 | <paramlist> |
21330 | <param name="item" type="TreeItemId" default=""/> | |
21331 | </paramlist> | |
21332 | </method> | |
21333 | <method name="GetPrevSibling" type="TreeItemId" overloaded="no"> | |
781d2982 | 21334 | <autodoc>GetPrevSibling(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
21335 | <paramlist> |
21336 | <param name="item" type="TreeItemId" default=""/> | |
21337 | </paramlist> | |
21338 | </method> | |
21339 | <method name="GetFirstVisibleItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 21340 | <autodoc>GetFirstVisibleItem(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
21341 | </method> |
21342 | <method name="GetNextVisible" type="TreeItemId" overloaded="no"> | |
781d2982 | 21343 | <autodoc>GetNextVisible(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
21344 | <paramlist> |
21345 | <param name="item" type="TreeItemId" default=""/> | |
21346 | </paramlist> | |
21347 | </method> | |
21348 | <method name="GetPrevVisible" type="TreeItemId" overloaded="no"> | |
781d2982 | 21349 | <autodoc>GetPrevVisible(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
21350 | <paramlist> |
21351 | <param name="item" type="TreeItemId" default=""/> | |
21352 | </paramlist> | |
21353 | </method> | |
21354 | <method name="AddRoot" type="TreeItemId" overloaded="no"> | |
781d2982 | 21355 | <autodoc>AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc> |
f32fc4bc RD |
21356 | <paramlist> |
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"/> | |
21361 | </paramlist> | |
21362 | </method> | |
21363 | <method name="PrependItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 21364 | <autodoc>PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, |
f32fc4bc RD |
21365 | TreeItemData data=None) -> TreeItemId</autodoc> |
21366 | <paramlist> | |
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"/> | |
21372 | </paramlist> | |
21373 | </method> | |
21374 | <method name="InsertItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 21375 | <autodoc>InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text, |
f32fc4bc RD |
21376 | int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc> |
21377 | <paramlist> | |
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"/> | |
21384 | </paramlist> | |
21385 | </method> | |
21386 | <method name="InsertItemBefore" type="TreeItemId" overloaded="no"> | |
781d2982 | 21387 | <autodoc>InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-1, |
f32fc4bc RD |
21388 | int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc> |
21389 | <paramlist> | |
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"/> | |
21396 | </paramlist> | |
21397 | </method> | |
21398 | <method name="AppendItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 21399 | <autodoc>AppendItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, |
f32fc4bc RD |
21400 | TreeItemData data=None) -> TreeItemId</autodoc> |
21401 | <paramlist> | |
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"/> | |
21407 | </paramlist> | |
21408 | </method> | |
21409 | <method name="Delete" type="" overloaded="no"> | |
781d2982 | 21410 | <autodoc>Delete(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21411 | <paramlist> |
21412 | <param name="item" type="TreeItemId" default=""/> | |
21413 | </paramlist> | |
21414 | </method> | |
21415 | <method name="DeleteChildren" type="" overloaded="no"> | |
781d2982 | 21416 | <autodoc>DeleteChildren(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21417 | <paramlist> |
21418 | <param name="item" type="TreeItemId" default=""/> | |
21419 | </paramlist> | |
21420 | </method> | |
21421 | <method name="DeleteAllItems" type="" overloaded="no"> | |
781d2982 | 21422 | <autodoc>DeleteAllItems(self)</autodoc> |
f32fc4bc RD |
21423 | </method> |
21424 | <method name="Expand" type="" overloaded="no"> | |
781d2982 | 21425 | <autodoc>Expand(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21426 | <paramlist> |
21427 | <param name="item" type="TreeItemId" default=""/> | |
21428 | </paramlist> | |
21429 | </method> | |
21430 | <method name="Collapse" type="" overloaded="no"> | |
781d2982 | 21431 | <autodoc>Collapse(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21432 | <paramlist> |
21433 | <param name="item" type="TreeItemId" default=""/> | |
21434 | </paramlist> | |
21435 | </method> | |
21436 | <method name="CollapseAndReset" type="" overloaded="no"> | |
781d2982 | 21437 | <autodoc>CollapseAndReset(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21438 | <paramlist> |
21439 | <param name="item" type="TreeItemId" default=""/> | |
21440 | </paramlist> | |
21441 | </method> | |
21442 | <method name="Toggle" type="" overloaded="no"> | |
781d2982 | 21443 | <autodoc>Toggle(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21444 | <paramlist> |
21445 | <param name="item" type="TreeItemId" default=""/> | |
21446 | </paramlist> | |
21447 | </method> | |
21448 | <method name="Unselect" type="" overloaded="no"> | |
781d2982 | 21449 | <autodoc>Unselect(self)</autodoc> |
f32fc4bc RD |
21450 | </method> |
21451 | <method name="UnselectItem" type="" overloaded="no"> | |
781d2982 | 21452 | <autodoc>UnselectItem(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21453 | <paramlist> |
21454 | <param name="item" type="TreeItemId" default=""/> | |
21455 | </paramlist> | |
21456 | </method> | |
21457 | <method name="UnselectAll" type="" overloaded="no"> | |
781d2982 | 21458 | <autodoc>UnselectAll(self)</autodoc> |
f32fc4bc RD |
21459 | </method> |
21460 | <method name="SelectItem" type="" overloaded="no"> | |
781d2982 | 21461 | <autodoc>SelectItem(self, TreeItemId item, bool select=True)</autodoc> |
f32fc4bc RD |
21462 | <paramlist> |
21463 | <param name="item" type="TreeItemId" default=""/> | |
21464 | <param name="select" type="bool" default="True"/> | |
21465 | </paramlist> | |
21466 | </method> | |
21467 | <method name="ToggleItemSelection" type="" overloaded="no"> | |
781d2982 | 21468 | <autodoc>ToggleItemSelection(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21469 | <paramlist> |
21470 | <param name="item" type="TreeItemId" default=""/> | |
21471 | </paramlist> | |
21472 | </method> | |
21473 | <method name="EnsureVisible" type="" overloaded="no"> | |
781d2982 | 21474 | <autodoc>EnsureVisible(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21475 | <paramlist> |
21476 | <param name="item" type="TreeItemId" default=""/> | |
21477 | </paramlist> | |
21478 | </method> | |
21479 | <method name="ScrollTo" type="" overloaded="no"> | |
781d2982 | 21480 | <autodoc>ScrollTo(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21481 | <paramlist> |
21482 | <param name="item" type="TreeItemId" default=""/> | |
21483 | </paramlist> | |
21484 | </method> | |
21485 | <method name="EditLabel" type="" overloaded="no"> | |
781d2982 | 21486 | <autodoc>EditLabel(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21487 | <paramlist> |
21488 | <param name="item" type="TreeItemId" default=""/> | |
21489 | </paramlist> | |
21490 | </method> | |
21491 | <method name="GetEditControl" type="TextCtrl" overloaded="no"> | |
781d2982 | 21492 | <autodoc>GetEditControl(self) -> TextCtrl</autodoc> |
f32fc4bc RD |
21493 | </method> |
21494 | <method name="SortChildren" type="" overloaded="no"> | |
781d2982 | 21495 | <autodoc>SortChildren(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
21496 | <paramlist> |
21497 | <param name="item" type="TreeItemId" default=""/> | |
21498 | </paramlist> | |
21499 | </method> | |
21500 | <method name="HitTest" type="TreeItemId" overloaded="no"> | |
21501 | <autodoc>HitTest(Point point) -> (item, where)</autodoc> | |
ce6878e6 RD |
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. | |
21505 | </docstring> | |
f32fc4bc RD |
21506 | <paramlist> |
21507 | <param name="point" type="Point" default=""/> | |
21508 | <param name="OUTPUT" type="int" default=""/> | |
21509 | </paramlist> | |
21510 | </method> | |
21511 | <method name="GetBoundingRect" type="PyObject" overloaded="no"> | |
781d2982 | 21512 | <autodoc>GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject</autodoc> |
f32fc4bc RD |
21513 | <paramlist> |
21514 | <param name="item" type="TreeItemId" default=""/> | |
21515 | <param name="textOnly" type="bool" default="False"/> | |
21516 | </paramlist> | |
21517 | </method> | |
781d2982 RD |
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. | |
21525 | ||
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 | |
21529 | this.</docstring> | |
21530 | <paramlist> | |
21531 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
21532 | </paramlist> | |
21533 | </staticmethod> | |
f32fc4bc RD |
21534 | </class> |
21535 | <pythoncode> | |
21536 | #--------------------------------------------------------------------------- | |
21537 | </pythoncode> | |
781d2982 | 21538 | <class name="GenericDirCtrl" oldname="wxGenericDirCtrl" module="_controls"> |
f32fc4bc RD |
21539 | <baseclass name="Control"/> |
21540 | <constructor name="GenericDirCtrl" overloaded="no"> | |
781d2982 | 21541 | <autodoc>__init__(self, Window parent, int id=-1, String dir=DirDialogDefaultFolderStr, |
f32fc4bc RD |
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> | |
21546 | <paramlist> | |
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"/> | |
21556 | </paramlist> | |
21557 | </constructor> | |
21558 | <constructor name="PreGenericDirCtrl" overloaded="no"> | |
21559 | <autodoc>PreGenericDirCtrl() -> GenericDirCtrl</autodoc> | |
21560 | </constructor> | |
21561 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 21562 | <autodoc>Create(self, Window parent, int id=-1, String dir=DirDialogDefaultFolderStr, |
f32fc4bc RD |
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> | |
21567 | <paramlist> | |
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"/> | |
21577 | </paramlist> | |
21578 | </method> | |
21579 | <method name="ExpandPath" type="bool" overloaded="no"> | |
781d2982 | 21580 | <autodoc>ExpandPath(self, String path) -> bool</autodoc> |
f32fc4bc RD |
21581 | <paramlist> |
21582 | <param name="path" type="String" default=""/> | |
21583 | </paramlist> | |
21584 | </method> | |
21585 | <method name="GetDefaultPath" type="String" overloaded="no"> | |
781d2982 | 21586 | <autodoc>GetDefaultPath(self) -> String</autodoc> |
f32fc4bc RD |
21587 | </method> |
21588 | <method name="SetDefaultPath" type="" overloaded="no"> | |
781d2982 | 21589 | <autodoc>SetDefaultPath(self, String path)</autodoc> |
f32fc4bc RD |
21590 | <paramlist> |
21591 | <param name="path" type="String" default=""/> | |
21592 | </paramlist> | |
21593 | </method> | |
21594 | <method name="GetPath" type="String" overloaded="no"> | |
781d2982 | 21595 | <autodoc>GetPath(self) -> String</autodoc> |
f32fc4bc RD |
21596 | </method> |
21597 | <method name="GetFilePath" type="String" overloaded="no"> | |
781d2982 | 21598 | <autodoc>GetFilePath(self) -> String</autodoc> |
f32fc4bc RD |
21599 | </method> |
21600 | <method name="SetPath" type="" overloaded="no"> | |
781d2982 | 21601 | <autodoc>SetPath(self, String path)</autodoc> |
f32fc4bc RD |
21602 | <paramlist> |
21603 | <param name="path" type="String" default=""/> | |
21604 | </paramlist> | |
21605 | </method> | |
21606 | <method name="ShowHidden" type="" overloaded="no"> | |
781d2982 | 21607 | <autodoc>ShowHidden(self, bool show)</autodoc> |
f32fc4bc RD |
21608 | <paramlist> |
21609 | <param name="show" type="bool" default=""/> | |
21610 | </paramlist> | |
21611 | </method> | |
21612 | <method name="GetShowHidden" type="bool" overloaded="no"> | |
781d2982 | 21613 | <autodoc>GetShowHidden(self) -> bool</autodoc> |
f32fc4bc RD |
21614 | </method> |
21615 | <method name="GetFilter" type="String" overloaded="no"> | |
781d2982 | 21616 | <autodoc>GetFilter(self) -> String</autodoc> |
f32fc4bc RD |
21617 | </method> |
21618 | <method name="SetFilter" type="" overloaded="no"> | |
781d2982 | 21619 | <autodoc>SetFilter(self, String filter)</autodoc> |
f32fc4bc RD |
21620 | <paramlist> |
21621 | <param name="filter" type="String" default=""/> | |
21622 | </paramlist> | |
21623 | </method> | |
21624 | <method name="GetFilterIndex" type="int" overloaded="no"> | |
781d2982 | 21625 | <autodoc>GetFilterIndex(self) -> int</autodoc> |
f32fc4bc RD |
21626 | </method> |
21627 | <method name="SetFilterIndex" type="" overloaded="no"> | |
781d2982 | 21628 | <autodoc>SetFilterIndex(self, int n)</autodoc> |
f32fc4bc RD |
21629 | <paramlist> |
21630 | <param name="n" type="int" default=""/> | |
21631 | </paramlist> | |
21632 | </method> | |
21633 | <method name="GetRootId" type="TreeItemId" overloaded="no"> | |
781d2982 | 21634 | <autodoc>GetRootId(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
21635 | </method> |
21636 | <method name="GetTreeCtrl" type="TreeCtrl" overloaded="no"> | |
781d2982 | 21637 | <autodoc>GetTreeCtrl(self) -> TreeCtrl</autodoc> |
f32fc4bc RD |
21638 | </method> |
21639 | <method name="GetFilterListCtrl" type="wxDirFilterListCtrl" overloaded="no"> | |
781d2982 | 21640 | <autodoc>GetFilterListCtrl(self) -> DirFilterListCtrl</autodoc> |
f32fc4bc RD |
21641 | </method> |
21642 | <method name="FindChild" type="TreeItemId" overloaded="no"> | |
21643 | <autodoc>FindChild(wxTreeItemId parentId, wxString path) -> (item, done)</autodoc> | |
ce6878e6 RD |
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. | |
21648 | </docstring> | |
f32fc4bc RD |
21649 | <paramlist> |
21650 | <param name="parentId" type="TreeItemId" default=""/> | |
21651 | <param name="path" type="String" default=""/> | |
21652 | <param name="OUTPUT" type="bool" default=""/> | |
21653 | </paramlist> | |
21654 | </method> | |
21655 | <method name="DoResize" type="" overloaded="no"> | |
781d2982 | 21656 | <autodoc>DoResize(self)</autodoc> |
f32fc4bc RD |
21657 | </method> |
21658 | <method name="ReCreateTree" type="" overloaded="no"> | |
781d2982 | 21659 | <autodoc>ReCreateTree(self)</autodoc> |
f32fc4bc RD |
21660 | </method> |
21661 | </class> | |
781d2982 | 21662 | <class name="DirFilterListCtrl" oldname="wxDirFilterListCtrl" module="_controls"> |
f32fc4bc RD |
21663 | <baseclass name="Choice"/> |
21664 | <constructor name="DirFilterListCtrl" overloaded="no"> | |
781d2982 | 21665 | <autodoc>__init__(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
21666 | Size size=DefaultSize, long style=0) -> DirFilterListCtrl</autodoc> |
21667 | <paramlist> | |
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"/> | |
21673 | </paramlist> | |
21674 | </constructor> | |
21675 | <constructor name="PreDirFilterListCtrl" overloaded="no"> | |
21676 | <autodoc>PreDirFilterListCtrl() -> DirFilterListCtrl</autodoc> | |
21677 | </constructor> | |
21678 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 21679 | <autodoc>Create(self, GenericDirCtrl parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
21680 | Size size=DefaultSize, long style=0) -> bool</autodoc> |
21681 | <paramlist> | |
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"/> | |
21687 | </paramlist> | |
21688 | </method> | |
21689 | <method name="FillFilterList" type="" overloaded="no"> | |
781d2982 | 21690 | <autodoc>FillFilterList(self, String filter, int defaultFilter)</autodoc> |
f32fc4bc RD |
21691 | <paramlist> |
21692 | <param name="filter" type="String" default=""/> | |
21693 | <param name="defaultFilter" type="int" default=""/> | |
21694 | </paramlist> | |
21695 | </method> | |
21696 | </class> | |
21697 | <pythoncode> | |
21698 | #--------------------------------------------------------------------------- | |
21699 | </pythoncode> | |
781d2982 | 21700 | <class name="PyControl" oldname="wxPyControl" module="_controls"> |
f32fc4bc RD |
21701 | <baseclass name="Control"/> |
21702 | <constructor name="PyControl" overloaded="no"> | |
781d2982 RD |
21703 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
21704 | Size size=DefaultSize, long style=0, Validator validator=DefaultValidator, | |
f32fc4bc RD |
21705 | String name=ControlNameStr) -> PyControl</autodoc> |
21706 | <paramlist> | |
21707 | <param name="parent" type="Window" default=""/> | |
781d2982 | 21708 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
21714 | </paramlist> | |
21715 | </constructor> | |
781d2982 RD |
21716 | <constructor name="PrePyControl" overloaded="no"> |
21717 | <autodoc>PrePyControl() -> PyControl</autodoc> | |
21718 | </constructor> | |
f32fc4bc | 21719 | <method name="_setCallbackInfo" type="" overloaded="no"> |
781d2982 | 21720 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
21721 | <paramlist> |
21722 | <param name="self" type="PyObject" default=""/> | |
21723 | <param name="_class" type="PyObject" default=""/> | |
21724 | </paramlist> | |
21725 | </method> | |
781d2982 RD |
21726 | <method name="SetBestSize" type="" overloaded="no"> |
21727 | <autodoc>SetBestSize(self, Size size)</autodoc> | |
21728 | <paramlist> | |
21729 | <param name="size" type="Size" default=""/> | |
21730 | </paramlist> | |
21731 | </method> | |
f32fc4bc | 21732 | <method name="base_DoMoveWindow" type="" overloaded="no"> |
781d2982 | 21733 | <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc> |
f32fc4bc RD |
21734 | <paramlist> |
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=""/> | |
21739 | </paramlist> | |
21740 | </method> | |
21741 | <method name="base_DoSetSize" type="" overloaded="no"> | |
781d2982 | 21742 | <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc> |
f32fc4bc RD |
21743 | <paramlist> |
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"/> | |
21749 | </paramlist> | |
21750 | </method> | |
21751 | <method name="base_DoSetClientSize" type="" overloaded="no"> | |
781d2982 | 21752 | <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc> |
f32fc4bc RD |
21753 | <paramlist> |
21754 | <param name="width" type="int" default=""/> | |
21755 | <param name="height" type="int" default=""/> | |
21756 | </paramlist> | |
21757 | </method> | |
21758 | <method name="base_DoSetVirtualSize" type="" overloaded="no"> | |
781d2982 | 21759 | <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc> |
f32fc4bc RD |
21760 | <paramlist> |
21761 | <param name="x" type="int" default=""/> | |
21762 | <param name="y" type="int" default=""/> | |
21763 | </paramlist> | |
21764 | </method> | |
21765 | <method name="base_DoGetSize" type="" overloaded="no"> | |
21766 | <autodoc>base_DoGetSize() -> (width, height)</autodoc> | |
21767 | <paramlist> | |
21768 | <param name="OUTPUT" type="int" default=""/> | |
21769 | <param name="OUTPUT" type="int" default=""/> | |
21770 | </paramlist> | |
21771 | </method> | |
21772 | <method name="base_DoGetClientSize" type="" overloaded="no"> | |
21773 | <autodoc>base_DoGetClientSize() -> (width, height)</autodoc> | |
21774 | <paramlist> | |
21775 | <param name="OUTPUT" type="int" default=""/> | |
21776 | <param name="OUTPUT" type="int" default=""/> | |
21777 | </paramlist> | |
21778 | </method> | |
21779 | <method name="base_DoGetPosition" type="" overloaded="no"> | |
21780 | <autodoc>base_DoGetPosition() -> (x,y)</autodoc> | |
21781 | <paramlist> | |
21782 | <param name="OUTPUT" type="int" default=""/> | |
21783 | <param name="OUTPUT" type="int" default=""/> | |
21784 | </paramlist> | |
21785 | </method> | |
21786 | <method name="base_DoGetVirtualSize" type="Size" overloaded="no"> | |
781d2982 | 21787 | <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc> |
f32fc4bc RD |
21788 | </method> |
21789 | <method name="base_DoGetBestSize" type="Size" overloaded="no"> | |
781d2982 | 21790 | <autodoc>base_DoGetBestSize(self) -> Size</autodoc> |
f32fc4bc RD |
21791 | </method> |
21792 | <method name="base_InitDialog" type="" overloaded="no"> | |
781d2982 | 21793 | <autodoc>base_InitDialog(self)</autodoc> |
f32fc4bc RD |
21794 | </method> |
21795 | <method name="base_TransferDataToWindow" type="bool" overloaded="no"> | |
781d2982 | 21796 | <autodoc>base_TransferDataToWindow(self) -> bool</autodoc> |
f32fc4bc RD |
21797 | </method> |
21798 | <method name="base_TransferDataFromWindow" type="bool" overloaded="no"> | |
781d2982 | 21799 | <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc> |
f32fc4bc RD |
21800 | </method> |
21801 | <method name="base_Validate" type="bool" overloaded="no"> | |
781d2982 | 21802 | <autodoc>base_Validate(self) -> bool</autodoc> |
f32fc4bc RD |
21803 | </method> |
21804 | <method name="base_AcceptsFocus" type="bool" overloaded="no"> | |
781d2982 | 21805 | <autodoc>base_AcceptsFocus(self) -> bool</autodoc> |
f32fc4bc RD |
21806 | </method> |
21807 | <method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no"> | |
781d2982 | 21808 | <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc> |
f32fc4bc RD |
21809 | </method> |
21810 | <method name="base_GetMaxSize" type="Size" overloaded="no"> | |
781d2982 | 21811 | <autodoc>base_GetMaxSize(self) -> Size</autodoc> |
f32fc4bc RD |
21812 | </method> |
21813 | <method name="base_AddChild" type="" overloaded="no"> | |
781d2982 | 21814 | <autodoc>base_AddChild(self, Window child)</autodoc> |
f32fc4bc RD |
21815 | <paramlist> |
21816 | <param name="child" type="Window" default=""/> | |
21817 | </paramlist> | |
21818 | </method> | |
21819 | <method name="base_RemoveChild" type="" overloaded="no"> | |
781d2982 | 21820 | <autodoc>base_RemoveChild(self, Window child)</autodoc> |
f32fc4bc RD |
21821 | <paramlist> |
21822 | <param name="child" type="Window" default=""/> | |
21823 | </paramlist> | |
21824 | </method> | |
781d2982 RD |
21825 | <method name="base_ShouldInheritColours" type="bool" overloaded="no"> |
21826 | <autodoc>base_ShouldInheritColours(self) -> bool</autodoc> | |
21827 | </method> | |
21828 | <method name="base_ApplyParentThemeBackground" type="" overloaded="no"> | |
21829 | <autodoc>base_ApplyParentThemeBackground(self, Colour c)</autodoc> | |
21830 | <paramlist> | |
21831 | <param name="c" type="Colour" default=""/> | |
21832 | </paramlist> | |
21833 | </method> | |
21834 | <method name="base_GetDefaultAttributes" type="VisualAttributes" overloaded="no"> | |
21835 | <autodoc>base_GetDefaultAttributes(self) -> VisualAttributes</autodoc> | |
21836 | </method> | |
f32fc4bc RD |
21837 | </class> |
21838 | <pythoncode> | |
21839 | #--------------------------------------------------------------------------- | |
21840 | </pythoncode> | |
21841 | <pythoncode> | |
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) | |
21846 | </pythoncode> | |
781d2982 RD |
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. | |
21853 | ||
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 | |
ce6878e6 RD |
21862 | windows, since processing would stop after the first window found. |
21863 | ||
21864 | Events | |
21865 | ------- | |
21866 | ============== ========================================= | |
21867 | EVT_HELP Sent when the user has requested context- | |
21868 | sensitive help. | |
21869 | EVT_HELP_RANGE Allows to catch EVT_HELP for a range of IDs | |
21870 | ============== ========================================= | |
21871 | ||
21872 | :see: `wx.ContextHelp`, `wx.ContextHelpButton` | |
21873 | </docstring> | |
f32fc4bc RD |
21874 | <baseclass name="CommandEvent"/> |
21875 | <constructor name="HelpEvent" overloaded="no"> | |
781d2982 | 21876 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> HelpEvent</autodoc> |
f32fc4bc RD |
21877 | <paramlist> |
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"/> | |
21881 | </paramlist> | |
21882 | </constructor> | |
21883 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 21884 | <autodoc>GetPosition(self) -> Point</autodoc> |
c2dda882 RD |
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> | |
f32fc4bc RD |
21888 | </method> |
21889 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 21890 | <autodoc>SetPosition(self, Point pos)</autodoc> |
c2dda882 | 21891 | <docstring>Sets the left-click position of the mouse, in screen coordinates.</docstring> |
f32fc4bc RD |
21892 | <paramlist> |
21893 | <param name="pos" type="Point" default=""/> | |
21894 | </paramlist> | |
21895 | </method> | |
21896 | <method name="GetLink" type="String" overloaded="no"> | |
781d2982 | 21897 | <autodoc>GetLink(self) -> String</autodoc> |
c2dda882 | 21898 | <docstring>Get an optional link to further help</docstring> |
f32fc4bc RD |
21899 | </method> |
21900 | <method name="SetLink" type="" overloaded="no"> | |
781d2982 | 21901 | <autodoc>SetLink(self, String link)</autodoc> |
c2dda882 | 21902 | <docstring>Set an optional link to further help</docstring> |
f32fc4bc RD |
21903 | <paramlist> |
21904 | <param name="link" type="String" default=""/> | |
21905 | </paramlist> | |
21906 | </method> | |
21907 | <method name="GetTarget" type="String" overloaded="no"> | |
781d2982 | 21908 | <autodoc>GetTarget(self) -> String</autodoc> |
c2dda882 | 21909 | <docstring>Get an optional target to display help in. E.g. a window specification</docstring> |
f32fc4bc RD |
21910 | </method> |
21911 | <method name="SetTarget" type="" overloaded="no"> | |
781d2982 | 21912 | <autodoc>SetTarget(self, String target)</autodoc> |
c2dda882 | 21913 | <docstring>Set an optional target to display help in. E.g. a window specification</docstring> |
f32fc4bc RD |
21914 | <paramlist> |
21915 | <param name="target" type="String" default=""/> | |
21916 | </paramlist> | |
21917 | </method> | |
21918 | </class> | |
781d2982 RD |
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 | |
21924 | help. | |
c2dda882 RD |
21925 | |
21926 | There are a couple of ways to invoke this behaviour implicitly: | |
21927 | ||
781d2982 RD |
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. | |
21932 | ||
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 | |
21937 | Windows). | |
21938 | ||
21939 | :see: `wx.ContextHelpButton` | |
c2dda882 | 21940 | </docstring> |
f32fc4bc RD |
21941 | <baseclass name="Object"/> |
21942 | <constructor name="ContextHelp" overloaded="no"> | |
781d2982 RD |
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). | |
c2dda882 RD |
21946 | |
21947 | If window is None, the top window is used.</docstring> | |
f32fc4bc RD |
21948 | <paramlist> |
21949 | <param name="window" type="Window" default="NULL"/> | |
21950 | <param name="doNow" type="bool" default="True"/> | |
21951 | </paramlist> | |
21952 | </constructor> | |
21953 | <destructor name="~wxContextHelp" overloaded="no"> | |
781d2982 | 21954 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
21955 | </destructor> |
21956 | <method name="BeginContextHelp" type="bool" overloaded="no"> | |
781d2982 RD |
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 | |
21960 | will be used. | |
c2dda882 RD |
21961 | |
21962 | Returns true if the application was successfully put into | |
781d2982 RD |
21963 | context-sensitive help mode. This function only returns when the event |
21964 | loop has finished.</docstring> | |
f32fc4bc RD |
21965 | <paramlist> |
21966 | <param name="window" type="Window" default="NULL"/> | |
21967 | </paramlist> | |
21968 | </method> | |
21969 | <method name="EndContextHelp" type="bool" overloaded="no"> | |
781d2982 | 21970 | <autodoc>EndContextHelp(self) -> bool</autodoc> |
c2dda882 RD |
21971 | <docstring>Ends context-sensitive help mode. Not normally called by the |
21972 | application.</docstring> | |
f32fc4bc RD |
21973 | </method> |
21974 | </class> | |
781d2982 RD |
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. | |
21980 | ||
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 | |
21984 | similar buttons. | |
c2dda882 | 21985 | |
781d2982 | 21986 | :see: `wx.ContextHelp`, `wx.ContextHelpButton` |
c2dda882 | 21987 | </docstring> |
f32fc4bc RD |
21988 | <baseclass name="BitmapButton"/> |
21989 | <constructor name="ContextHelpButton" overloaded="no"> | |
781d2982 | 21990 | <autodoc>__init__(self, Window parent, int id=ID_CONTEXT_HELP, Point pos=DefaultPosition, |
f32fc4bc | 21991 | Size size=DefaultSize, long style=BU_AUTODRAW) -> ContextHelpButton</autodoc> |
c2dda882 | 21992 | <docstring>Constructor, creating and showing a context help button.</docstring> |
f32fc4bc RD |
21993 | <paramlist> |
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"/> | |
21999 | </paramlist> | |
22000 | </constructor> | |
22001 | </class> | |
781d2982 | 22002 | <class name="HelpProvider" oldname="wxHelpProvider" module="_controls"> |
c2dda882 RD |
22003 | <docstring>wx.HelpProvider is an abstract class used by a program |
22004 | implementing context-sensitive help to show the help text for the | |
22005 | given window. | |
22006 | ||
22007 | The current help provider must be explicitly set by the | |
22008 | application using wx.HelpProvider.Set().</docstring> | |
f32fc4bc RD |
22009 | <staticmethod name="Set" type="HelpProvider" overloaded="no"> |
22010 | <autodoc>Set(HelpProvider helpProvider) -> HelpProvider</autodoc> | |
781d2982 RD |
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> | |
f32fc4bc RD |
22014 | <paramlist> |
22015 | <param name="helpProvider" type="HelpProvider" default=""/> | |
22016 | </paramlist> | |
22017 | </staticmethod> | |
22018 | <staticmethod name="Get" type="HelpProvider" overloaded="no"> | |
22019 | <autodoc>Get() -> HelpProvider</autodoc> | |
c2dda882 | 22020 | <docstring>Return the current application-wide help provider.</docstring> |
f32fc4bc RD |
22021 | </staticmethod> |
22022 | <method name="GetHelp" type="String" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
22027 | <paramlist> |
22028 | <param name="window" type="Window" default=""/> | |
22029 | </paramlist> | |
22030 | </method> | |
22031 | <method name="ShowHelp" type="bool" overloaded="no"> | |
781d2982 | 22032 | <autodoc>ShowHelp(self, Window window) -> bool</autodoc> |
c2dda882 | 22033 | <docstring>Shows help for the given window. Uses GetHelp internally if |
781d2982 RD |
22034 | applicable. Returns True if it was done, or False if no help was |
22035 | available for this window.</docstring> | |
f32fc4bc RD |
22036 | <paramlist> |
22037 | <param name="window" type="Window" default=""/> | |
22038 | </paramlist> | |
22039 | </method> | |
22040 | <method name="AddHelp" type="" overloaded="no"> | |
781d2982 | 22041 | <autodoc>AddHelp(self, Window window, String text)</autodoc> |
c2dda882 | 22042 | <docstring>Associates the text with the given window.</docstring> |
f32fc4bc RD |
22043 | <paramlist> |
22044 | <param name="window" type="Window" default=""/> | |
22045 | <param name="text" type="String" default=""/> | |
22046 | </paramlist> | |
22047 | </method> | |
22048 | <method name="AddHelpById" type="" overloaded="no"> | |
781d2982 | 22049 | <autodoc>AddHelpById(self, int id, String text)</autodoc> |
c2dda882 | 22050 | <docstring>This version associates the given text with all windows with this |
781d2982 RD |
22051 | id. May be used to set the same help string for all Cancel buttons in |
22052 | the application, for example.</docstring> | |
f32fc4bc RD |
22053 | <paramlist> |
22054 | <param name="id" type="int" default=""/> | |
22055 | <param name="text" type="String" default=""/> | |
22056 | </paramlist> | |
22057 | </method> | |
c2dda882 | 22058 | <method name="RemoveHelp" type="" overloaded="no"> |
781d2982 | 22059 | <autodoc>RemoveHelp(self, Window window)</autodoc> |
c2dda882 | 22060 | <docstring>Removes the association between the window pointer and the help |
781d2982 RD |
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> | |
c2dda882 RD |
22064 | <paramlist> |
22065 | <param name="window" type="Window" default=""/> | |
22066 | </paramlist> | |
22067 | </method> | |
f32fc4bc | 22068 | <method name="Destroy" type="" overloaded="no"> |
781d2982 | 22069 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
22070 | </method> |
22071 | </class> | |
781d2982 RD |
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> | |
f32fc4bc RD |
22076 | <baseclass name="HelpProvider"/> |
22077 | <constructor name="SimpleHelpProvider" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
22082 | </constructor> |
22083 | </class> | |
22084 | <pythoncode> | |
22085 | #--------------------------------------------------------------------------- | |
22086 | </pythoncode> | |
781d2982 | 22087 | <class name="DragImage" oldname="wxGenericDragImage" module="_controls"> |
f32fc4bc RD |
22088 | <baseclass name="Object"/> |
22089 | <constructor name="wxGenericDragImage" overloaded="no"> | |
781d2982 | 22090 | <autodoc>__init__(self, Bitmap image, Cursor cursor=wxNullCursor) -> DragImage</autodoc> |
f32fc4bc RD |
22091 | <paramlist> |
22092 | <param name="image" type="Bitmap" default=""/> | |
22093 | <param name="cursor" type="Cursor" default="wxNullCursor"/> | |
22094 | </paramlist> | |
22095 | </constructor> | |
22096 | <constructor name="DragIcon" overloaded="no"> | |
22097 | <autodoc>DragIcon(Icon image, Cursor cursor=wxNullCursor) -> DragImage</autodoc> | |
22098 | <paramlist> | |
22099 | <param name="image" type="Icon" default=""/> | |
22100 | <param name="cursor" type="Cursor" default="wxNullCursor"/> | |
22101 | </paramlist> | |
22102 | </constructor> | |
22103 | <constructor name="DragString" overloaded="no"> | |
22104 | <autodoc>DragString(String str, Cursor cursor=wxNullCursor) -> DragImage</autodoc> | |
22105 | <paramlist> | |
22106 | <param name="str" type="String" default=""/> | |
22107 | <param name="cursor" type="Cursor" default="wxNullCursor"/> | |
22108 | </paramlist> | |
22109 | </constructor> | |
22110 | <constructor name="DragTreeItem" overloaded="no"> | |
22111 | <autodoc>DragTreeItem(TreeCtrl treeCtrl, TreeItemId id) -> DragImage</autodoc> | |
22112 | <paramlist> | |
22113 | <param name="treeCtrl" type="TreeCtrl" default=""/> | |
22114 | <param name="id" type="TreeItemId" default=""/> | |
22115 | </paramlist> | |
22116 | </constructor> | |
22117 | <constructor name="DragListItem" overloaded="no"> | |
22118 | <autodoc>DragListItem(ListCtrl listCtrl, long id) -> DragImage</autodoc> | |
22119 | <paramlist> | |
22120 | <param name="listCtrl" type="ListCtrl" default=""/> | |
22121 | <param name="id" type="long" default=""/> | |
22122 | </paramlist> | |
22123 | </constructor> | |
22124 | <destructor name="~wxGenericDragImage" overloaded="no"> | |
781d2982 | 22125 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22126 | </destructor> |
22127 | <method name="SetBackingBitmap" type="" overloaded="no"> | |
781d2982 | 22128 | <autodoc>SetBackingBitmap(self, Bitmap bitmap)</autodoc> |
f32fc4bc RD |
22129 | <paramlist> |
22130 | <param name="bitmap" type="Bitmap" default=""/> | |
22131 | </paramlist> | |
22132 | </method> | |
22133 | <method name="BeginDrag" type="bool" overloaded="no"> | |
781d2982 | 22134 | <autodoc>BeginDrag(self, Point hotspot, Window window, bool fullScreen=False, |
f32fc4bc RD |
22135 | Rect rect=None) -> bool</autodoc> |
22136 | <paramlist> | |
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"/> | |
22141 | </paramlist> | |
22142 | </method> | |
22143 | <method name="BeginDragBounded" type="bool" overloaded="no"> | |
781d2982 | 22144 | <autodoc>BeginDragBounded(self, Point hotspot, Window window, Window boundingWindow) -> bool</autodoc> |
f32fc4bc RD |
22145 | <paramlist> |
22146 | <param name="hotspot" type="Point" default=""/> | |
22147 | <param name="window" type="Window" default=""/> | |
22148 | <param name="boundingWindow" type="Window" default=""/> | |
22149 | </paramlist> | |
22150 | </method> | |
22151 | <method name="EndDrag" type="bool" overloaded="no"> | |
781d2982 | 22152 | <autodoc>EndDrag(self) -> bool</autodoc> |
f32fc4bc RD |
22153 | </method> |
22154 | <method name="Move" type="bool" overloaded="no"> | |
781d2982 | 22155 | <autodoc>Move(self, Point pt) -> bool</autodoc> |
f32fc4bc RD |
22156 | <paramlist> |
22157 | <param name="pt" type="Point" default=""/> | |
22158 | </paramlist> | |
22159 | </method> | |
22160 | <method name="Show" type="bool" overloaded="no"> | |
781d2982 | 22161 | <autodoc>Show(self) -> bool</autodoc> |
f32fc4bc RD |
22162 | </method> |
22163 | <method name="Hide" type="bool" overloaded="no"> | |
781d2982 | 22164 | <autodoc>Hide(self) -> bool</autodoc> |
f32fc4bc RD |
22165 | </method> |
22166 | <method name="GetImageRect" type="Rect" overloaded="no"> | |
781d2982 | 22167 | <autodoc>GetImageRect(self, Point pos) -> Rect</autodoc> |
f32fc4bc RD |
22168 | <paramlist> |
22169 | <param name="pos" type="Point" default=""/> | |
22170 | </paramlist> | |
22171 | </method> | |
22172 | <method name="DoDrawImage" type="bool" overloaded="no"> | |
781d2982 | 22173 | <autodoc>DoDrawImage(self, DC dc, Point pos) -> bool</autodoc> |
f32fc4bc RD |
22174 | <paramlist> |
22175 | <param name="dc" type="DC" default=""/> | |
22176 | <param name="pos" type="Point" default=""/> | |
22177 | </paramlist> | |
22178 | </method> | |
22179 | <method name="UpdateBackingFromWindow" type="bool" overloaded="no"> | |
781d2982 | 22180 | <autodoc>UpdateBackingFromWindow(self, DC windowDC, MemoryDC destDC, Rect sourceRect, Rect destRect) -> bool</autodoc> |
f32fc4bc RD |
22181 | <paramlist> |
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=""/> | |
22186 | </paramlist> | |
22187 | </method> | |
22188 | <method name="RedrawImage" type="bool" overloaded="no"> | |
781d2982 | 22189 | <autodoc>RedrawImage(self, Point oldPos, Point newPos, bool eraseOld, bool drawNew) -> bool</autodoc> |
f32fc4bc RD |
22190 | <paramlist> |
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=""/> | |
22195 | </paramlist> | |
22196 | </method> | |
22197 | </class> | |
22198 | </module> | |
781d2982 RD |
22199 | <module name="_misc"> |
22200 | <import name="_core"/> | |
22201 | <pythoncode> wx = _core </pythoncode> | |
f32fc4bc RD |
22202 | <pythoncode> |
22203 | #--------------------------------------------------------------------------- | |
22204 | </pythoncode> | |
781d2982 | 22205 | <class name="SystemSettings" oldname="wxSystemSettings" module="_misc"> |
f32fc4bc RD |
22206 | <staticmethod name="GetColour" type="Colour" overloaded="no"> |
22207 | <autodoc>GetColour(int index) -> Colour</autodoc> | |
22208 | <paramlist> | |
22209 | <param name="index" type="wxSystemColour" default=""/> | |
22210 | </paramlist> | |
22211 | </staticmethod> | |
22212 | <staticmethod name="GetFont" type="Font" overloaded="no"> | |
22213 | <autodoc>GetFont(int index) -> Font</autodoc> | |
22214 | <paramlist> | |
22215 | <param name="index" type="wxSystemFont" default=""/> | |
22216 | </paramlist> | |
22217 | </staticmethod> | |
22218 | <staticmethod name="GetMetric" type="int" overloaded="no"> | |
22219 | <autodoc>GetMetric(int index) -> int</autodoc> | |
22220 | <paramlist> | |
22221 | <param name="index" type="wxSystemMetric" default=""/> | |
22222 | </paramlist> | |
22223 | </staticmethod> | |
22224 | <staticmethod name="HasFeature" type="bool" overloaded="no"> | |
22225 | <autodoc>HasFeature(int index) -> bool</autodoc> | |
22226 | <paramlist> | |
22227 | <param name="index" type="wxSystemFeature" default=""/> | |
22228 | </paramlist> | |
22229 | </staticmethod> | |
22230 | <staticmethod name="GetScreenType" type="wxSystemScreenType" overloaded="no"> | |
22231 | <autodoc>GetScreenType() -> int</autodoc> | |
22232 | </staticmethod> | |
22233 | <staticmethod name="SetScreenType" type="" overloaded="no"> | |
22234 | <autodoc>SetScreenType(int screen)</autodoc> | |
22235 | <paramlist> | |
22236 | <param name="screen" type="wxSystemScreenType" default=""/> | |
22237 | </paramlist> | |
22238 | </staticmethod> | |
22239 | </class> | |
781d2982 | 22240 | <class name="SystemOptions" oldname="wxSystemOptions" module="_misc"> |
f32fc4bc RD |
22241 | <baseclass name="Object"/> |
22242 | <constructor name="SystemOptions" overloaded="no"> | |
781d2982 | 22243 | <autodoc>__init__(self) -> SystemOptions</autodoc> |
f32fc4bc RD |
22244 | </constructor> |
22245 | <staticmethod name="SetOption" type="" overloaded="no"> | |
22246 | <autodoc>SetOption(String name, String value)</autodoc> | |
22247 | <paramlist> | |
22248 | <param name="name" type="String" default=""/> | |
22249 | <param name="value" type="String" default=""/> | |
22250 | </paramlist> | |
22251 | </staticmethod> | |
22252 | <staticmethod name="SetOptionInt" type="" overloaded="no"> | |
22253 | <autodoc>SetOptionInt(String name, int value)</autodoc> | |
22254 | <paramlist> | |
22255 | <param name="name" type="String" default=""/> | |
22256 | <param name="value" type="int" default=""/> | |
22257 | </paramlist> | |
22258 | </staticmethod> | |
22259 | <staticmethod name="GetOption" type="String" overloaded="no"> | |
22260 | <autodoc>GetOption(String name) -> String</autodoc> | |
22261 | <paramlist> | |
22262 | <param name="name" type="String" default=""/> | |
22263 | </paramlist> | |
22264 | </staticmethod> | |
22265 | <staticmethod name="GetOptionInt" type="int" overloaded="no"> | |
22266 | <autodoc>GetOptionInt(String name) -> int</autodoc> | |
22267 | <paramlist> | |
22268 | <param name="name" type="String" default=""/> | |
22269 | </paramlist> | |
22270 | </staticmethod> | |
22271 | <staticmethod name="HasOption" type="bool" overloaded="no"> | |
22272 | <autodoc>HasOption(String name) -> bool</autodoc> | |
22273 | <paramlist> | |
22274 | <param name="name" type="String" default=""/> | |
22275 | </paramlist> | |
22276 | </staticmethod> | |
22277 | </class> | |
22278 | <pythoncode> | |
0f43fbdf RD |
22279 | #--------------------------------------------------------------------------- |
22280 | </pythoncode> | |
f32fc4bc RD |
22281 | <method name="NewId" oldname="wxNewId" type="long" overloaded="no"> |
22282 | <autodoc>NewId() -> long</autodoc> | |
22283 | </method> | |
22284 | <method name="RegisterId" oldname="wxRegisterId" type="" overloaded="no"> | |
22285 | <autodoc>RegisterId(long id)</autodoc> | |
856bf319 | 22286 | <paramlist> |
f32fc4bc | 22287 | <param name="id" type="long" default=""/> |
856bf319 | 22288 | </paramlist> |
856bf319 | 22289 | </method> |
f32fc4bc RD |
22290 | <method name="GetCurrentId" oldname="wxGetCurrentId" type="long" overloaded="no"> |
22291 | <autodoc>GetCurrentId() -> long</autodoc> | |
856bf319 | 22292 | </method> |
f32fc4bc RD |
22293 | <method name="Bell" oldname="wxBell" type="" overloaded="no"> |
22294 | <autodoc>Bell()</autodoc> | |
856bf319 | 22295 | </method> |
f32fc4bc RD |
22296 | <method name="EndBusyCursor" oldname="wxEndBusyCursor" type="" overloaded="no"> |
22297 | <autodoc>EndBusyCursor()</autodoc> | |
22298 | </method> | |
22299 | <method name="GetElapsedTime" oldname="wxGetElapsedTime" type="long" overloaded="no"> | |
22300 | <autodoc>GetElapsedTime(bool resetTimer=True) -> long</autodoc> | |
856bf319 | 22301 | <paramlist> |
f32fc4bc | 22302 | <param name="resetTimer" type="bool" default="True"/> |
856bf319 | 22303 | </paramlist> |
856bf319 | 22304 | </method> |
f32fc4bc RD |
22305 | <method name="GetMousePosition" oldname="wxGetMousePosition" type="" overloaded="no"> |
22306 | <autodoc>GetMousePosition() -> (x,y)</autodoc> | |
22307 | <paramlist> | |
22308 | <param name="OUTPUT" type="int" default=""/> | |
22309 | <param name="OUTPUT" type="int" default=""/> | |
22310 | </paramlist> | |
856bf319 | 22311 | </method> |
f32fc4bc RD |
22312 | <method name="IsBusy" oldname="wxIsBusy" type="bool" overloaded="no"> |
22313 | <autodoc>IsBusy() -> bool</autodoc> | |
856bf319 | 22314 | </method> |
f32fc4bc RD |
22315 | <method name="Now" oldname="wxNow" type="String" overloaded="no"> |
22316 | <autodoc>Now() -> String</autodoc> | |
856bf319 | 22317 | </method> |
f32fc4bc RD |
22318 | <method name="Shell" oldname="wxShell" type="bool" overloaded="no"> |
22319 | <autodoc>Shell(String command=EmptyString) -> bool</autodoc> | |
22320 | <paramlist> | |
22321 | <param name="command" type="String" default="wxPyEmptyString"/> | |
22322 | </paramlist> | |
856bf319 | 22323 | </method> |
f32fc4bc RD |
22324 | <method name="StartTimer" oldname="wxStartTimer" type="" overloaded="no"> |
22325 | <autodoc>StartTimer()</autodoc> | |
856bf319 | 22326 | </method> |
f32fc4bc RD |
22327 | <method name="GetOsVersion" oldname="wxGetOsVersion" type="int" overloaded="no"> |
22328 | <autodoc>GetOsVersion() -> (platform, major, minor)</autodoc> | |
22329 | <paramlist> | |
22330 | <param name="OUTPUT" type="int" default=""/> | |
22331 | <param name="OUTPUT" type="int" default=""/> | |
22332 | </paramlist> | |
856bf319 | 22333 | </method> |
f32fc4bc RD |
22334 | <method name="GetOsDescription" oldname="wxGetOsDescription" type="String" overloaded="no"> |
22335 | <autodoc>GetOsDescription() -> String</autodoc> | |
856bf319 | 22336 | </method> |
f32fc4bc RD |
22337 | <method name="GetFreeMemory" oldname="wxGetFreeMemory" type="long" overloaded="no"> |
22338 | <autodoc>GetFreeMemory() -> long</autodoc> | |
856bf319 | 22339 | </method> |
f32fc4bc RD |
22340 | <method name="Shutdown" oldname="wxShutdown" type="bool" overloaded="no"> |
22341 | <autodoc>Shutdown(int wFlags) -> bool</autodoc> | |
22342 | <paramlist> | |
22343 | <param name="wFlags" type="wxShutdownFlags" default=""/> | |
22344 | </paramlist> | |
856bf319 | 22345 | </method> |
f32fc4bc RD |
22346 | <method name="Sleep" oldname="wxSleep" type="" overloaded="no"> |
22347 | <autodoc>Sleep(int secs)</autodoc> | |
22348 | <paramlist> | |
22349 | <param name="secs" type="int" default=""/> | |
22350 | </paramlist> | |
856bf319 | 22351 | </method> |
ce6878e6 RD |
22352 | <method name="MilliSleep" oldname="wxMilliSleep" type="" overloaded="no"> |
22353 | <autodoc>MilliSleep(unsigned long milliseconds)</autodoc> | |
f32fc4bc RD |
22354 | <paramlist> |
22355 | <param name="milliseconds" type="unsigned long" default=""/> | |
22356 | </paramlist> | |
856bf319 | 22357 | </method> |
ce6878e6 RD |
22358 | <method name="MicroSleep" oldname="wxMicroSleep" type="" overloaded="no"> |
22359 | <autodoc>MicroSleep(unsigned long microseconds)</autodoc> | |
22360 | <paramlist> | |
22361 | <param name="microseconds" type="unsigned long" default=""/> | |
22362 | </paramlist> | |
22363 | </method> | |
22364 | <pythoncode> Usleep = MilliSleep </pythoncode> | |
f32fc4bc RD |
22365 | <method name="EnableTopLevelWindows" oldname="wxEnableTopLevelWindows" type="" overloaded="no"> |
22366 | <autodoc>EnableTopLevelWindows(bool enable)</autodoc> | |
22367 | <paramlist> | |
22368 | <param name="enable" type="bool" default=""/> | |
22369 | </paramlist> | |
856bf319 | 22370 | </method> |
f32fc4bc RD |
22371 | <method name="StripMenuCodes" oldname="wxStripMenuCodes" type="String" overloaded="no"> |
22372 | <autodoc>StripMenuCodes(String in) -> String</autodoc> | |
22373 | <paramlist> | |
22374 | <param name="in" type="String" default=""/> | |
22375 | </paramlist> | |
856bf319 | 22376 | </method> |
f32fc4bc RD |
22377 | <method name="GetEmailAddress" oldname="wxGetEmailAddress" type="String" overloaded="no"> |
22378 | <autodoc>GetEmailAddress() -> String</autodoc> | |
856bf319 | 22379 | </method> |
f32fc4bc RD |
22380 | <method name="GetHostName" oldname="wxGetHostName" type="String" overloaded="no"> |
22381 | <autodoc>GetHostName() -> String</autodoc> | |
856bf319 | 22382 | </method> |
f32fc4bc RD |
22383 | <method name="GetFullHostName" oldname="wxGetFullHostName" type="String" overloaded="no"> |
22384 | <autodoc>GetFullHostName() -> String</autodoc> | |
856bf319 | 22385 | </method> |
f32fc4bc RD |
22386 | <method name="GetUserId" oldname="wxGetUserId" type="String" overloaded="no"> |
22387 | <autodoc>GetUserId() -> String</autodoc> | |
856bf319 | 22388 | </method> |
f32fc4bc RD |
22389 | <method name="GetUserName" oldname="wxGetUserName" type="String" overloaded="no"> |
22390 | <autodoc>GetUserName() -> String</autodoc> | |
856bf319 | 22391 | </method> |
f32fc4bc RD |
22392 | <method name="GetHomeDir" oldname="wxGetHomeDir" type="String" overloaded="no"> |
22393 | <autodoc>GetHomeDir() -> String</autodoc> | |
856bf319 | 22394 | </method> |
f32fc4bc RD |
22395 | <method name="GetUserHome" oldname="wxGetUserHome" type="String" overloaded="no"> |
22396 | <autodoc>GetUserHome(String user=EmptyString) -> String</autodoc> | |
856bf319 | 22397 | <paramlist> |
f32fc4bc | 22398 | <param name="user" type="String" default="wxPyEmptyString"/> |
856bf319 RD |
22399 | </paramlist> |
22400 | </method> | |
f32fc4bc RD |
22401 | <method name="GetProcessId" oldname="wxGetProcessId" type="unsigned long" overloaded="no"> |
22402 | <autodoc>GetProcessId() -> unsigned long</autodoc> | |
22403 | </method> | |
22404 | <method name="Trap" oldname="wxTrap" type="" overloaded="no"> | |
22405 | <autodoc>Trap()</autodoc> | |
856bf319 | 22406 | </method> |
f32fc4bc RD |
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> | |
856bf319 | 22414 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22424 | </paramlist> |
22425 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22429 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22434 | </paramlist> |
22435 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22439 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22444 | </paramlist> |
22445 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22450 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22456 | </paramlist> |
22457 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22462 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22470 | </paramlist> |
22471 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22475 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22480 | </paramlist> |
22481 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22486 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22497 | </paramlist> |
22498 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22503 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22514 | </paramlist> |
22515 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22520 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22527 | </paramlist> |
22528 | </method> | |
f32fc4bc RD |
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> | |
856bf319 | 22533 | <paramlist> |
f32fc4bc RD |
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"/> | |
856bf319 RD |
22542 | </paramlist> |
22543 | </method> | |
f32fc4bc RD |
22544 | <method name="ColourDisplay" oldname="wxColourDisplay" type="bool" overloaded="no"> |
22545 | <autodoc>ColourDisplay() -> bool</autodoc> | |
22546 | </method> | |
22547 | <method name="DisplayDepth" oldname="wxDisplayDepth" type="int" overloaded="no"> | |
22548 | <autodoc>DisplayDepth() -> int</autodoc> | |
22549 | </method> | |
22550 | <method name="GetDisplayDepth" oldname="wxGetDisplayDepth" type="int" overloaded="no"> | |
22551 | <autodoc>GetDisplayDepth() -> int</autodoc> | |
22552 | </method> | |
22553 | <method name="DisplaySize" oldname="wxDisplaySize" type="" overloaded="no"> | |
22554 | <autodoc>DisplaySize() -> (width, height)</autodoc> | |
856bf319 | 22555 | <paramlist> |
f32fc4bc RD |
22556 | <param name="OUTPUT" type="int" default=""/> |
22557 | <param name="OUTPUT" type="int" default=""/> | |
856bf319 RD |
22558 | </paramlist> |
22559 | </method> | |
f32fc4bc RD |
22560 | <method name="GetDisplaySize" oldname="wxGetDisplaySize" type="Size" overloaded="no"> |
22561 | <autodoc>GetDisplaySize() -> Size</autodoc> | |
22562 | </method> | |
22563 | <method name="DisplaySizeMM" oldname="wxDisplaySizeMM" type="" overloaded="no"> | |
22564 | <autodoc>DisplaySizeMM() -> (width, height)</autodoc> | |
856bf319 | 22565 | <paramlist> |
f32fc4bc RD |
22566 | <param name="OUTPUT" type="int" default=""/> |
22567 | <param name="OUTPUT" type="int" default=""/> | |
856bf319 RD |
22568 | </paramlist> |
22569 | </method> | |
f32fc4bc RD |
22570 | <method name="GetDisplaySizeMM" oldname="wxGetDisplaySizeMM" type="Size" overloaded="no"> |
22571 | <autodoc>GetDisplaySizeMM() -> Size</autodoc> | |
22572 | </method> | |
22573 | <method name="ClientDisplayRect" oldname="wxClientDisplayRect" type="" overloaded="no"> | |
22574 | <autodoc>ClientDisplayRect() -> (x, y, width, height)</autodoc> | |
856bf319 | 22575 | <paramlist> |
f32fc4bc RD |
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=""/> | |
856bf319 RD |
22580 | </paramlist> |
22581 | </method> | |
f32fc4bc RD |
22582 | <method name="GetClientDisplayRect" oldname="wxGetClientDisplayRect" type="Rect" overloaded="no"> |
22583 | <autodoc>GetClientDisplayRect() -> Rect</autodoc> | |
22584 | </method> | |
22585 | <method name="SetCursor" oldname="wxSetCursor" type="" overloaded="no"> | |
22586 | <autodoc>SetCursor(Cursor cursor)</autodoc> | |
856bf319 | 22587 | <paramlist> |
f32fc4bc | 22588 | <param name="cursor" type="Cursor" default=""/> |
856bf319 RD |
22589 | </paramlist> |
22590 | </method> | |
f32fc4bc RD |
22591 | <method name="BeginBusyCursor" oldname="wxBeginBusyCursor" type="" overloaded="no"> |
22592 | <autodoc>BeginBusyCursor(Cursor cursor=wxHOURGLASS_CURSOR)</autodoc> | |
856bf319 | 22593 | <paramlist> |
f32fc4bc | 22594 | <param name="cursor" type="Cursor" default="wxHOURGLASS_CURSOR"/> |
856bf319 RD |
22595 | </paramlist> |
22596 | </method> | |
f32fc4bc RD |
22597 | <method name="GetActiveWindow" oldname="wxGetActiveWindow" type="Window" overloaded="no"> |
22598 | <autodoc>GetActiveWindow() -> Window</autodoc> | |
856bf319 | 22599 | </method> |
f32fc4bc RD |
22600 | <method name="GenericFindWindowAtPoint" oldname="wxGenericFindWindowAtPoint" type="Window" overloaded="no"> |
22601 | <autodoc>GenericFindWindowAtPoint(Point pt) -> Window</autodoc> | |
856bf319 | 22602 | <paramlist> |
f32fc4bc | 22603 | <param name="pt" type="Point" default=""/> |
856bf319 RD |
22604 | </paramlist> |
22605 | </method> | |
f32fc4bc RD |
22606 | <method name="FindWindowAtPoint" oldname="wxFindWindowAtPoint" type="Window" overloaded="no"> |
22607 | <autodoc>FindWindowAtPoint(Point pt) -> Window</autodoc> | |
856bf319 | 22608 | <paramlist> |
f32fc4bc | 22609 | <param name="pt" type="Point" default=""/> |
856bf319 RD |
22610 | </paramlist> |
22611 | </method> | |
f32fc4bc RD |
22612 | <method name="GetTopLevelParent" oldname="wxGetTopLevelParent" type="Window" overloaded="no"> |
22613 | <autodoc>GetTopLevelParent(Window win) -> Window</autodoc> | |
856bf319 | 22614 | <paramlist> |
f32fc4bc | 22615 | <param name="win" type="Window" default=""/> |
856bf319 RD |
22616 | </paramlist> |
22617 | </method> | |
f32fc4bc RD |
22618 | <method name="GetKeyState" oldname="wxGetKeyState" type="bool" overloaded="no"> |
22619 | <autodoc>GetKeyState(int key) -> bool</autodoc> | |
781d2982 RD |
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. | |
22623 | </docstring> | |
856bf319 | 22624 | <paramlist> |
f32fc4bc | 22625 | <param name="key" type="wxKeyCode" default=""/> |
856bf319 RD |
22626 | </paramlist> |
22627 | </method> | |
f32fc4bc RD |
22628 | <method name="WakeUpMainThread" oldname="wxWakeUpMainThread" type="" overloaded="no"> |
22629 | <autodoc>WakeUpMainThread()</autodoc> | |
856bf319 | 22630 | </method> |
f32fc4bc RD |
22631 | <method name="MutexGuiEnter" oldname="wxMutexGuiEnter" type="" overloaded="no"> |
22632 | <autodoc>MutexGuiEnter()</autodoc> | |
856bf319 | 22633 | </method> |
f32fc4bc RD |
22634 | <method name="MutexGuiLeave" oldname="wxMutexGuiLeave" type="" overloaded="no"> |
22635 | <autodoc>MutexGuiLeave()</autodoc> | |
856bf319 | 22636 | </method> |
781d2982 | 22637 | <class name="MutexGuiLocker" oldname="wxMutexGuiLocker" module="_misc"> |
f32fc4bc | 22638 | <constructor name="MutexGuiLocker" overloaded="no"> |
781d2982 | 22639 | <autodoc>__init__(self) -> MutexGuiLocker</autodoc> |
f32fc4bc RD |
22640 | </constructor> |
22641 | <destructor name="~wxMutexGuiLocker" overloaded="no"> | |
781d2982 | 22642 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22643 | </destructor> |
22644 | </class> | |
22645 | <method name="Thread_IsMain" oldname="wxThread_IsMain" type="bool" overloaded="no"> | |
22646 | <autodoc>Thread_IsMain() -> bool</autodoc> | |
856bf319 | 22647 | </method> |
f32fc4bc RD |
22648 | <pythoncode> |
22649 | #--------------------------------------------------------------------------- | |
22650 | </pythoncode> | |
781d2982 | 22651 | <class name="ToolTip" oldname="wxToolTip" module="_misc"> |
f32fc4bc RD |
22652 | <baseclass name="Object"/> |
22653 | <constructor name="ToolTip" overloaded="no"> | |
781d2982 | 22654 | <autodoc>__init__(self, String tip) -> ToolTip</autodoc> |
f32fc4bc RD |
22655 | <paramlist> |
22656 | <param name="tip" type="String" default=""/> | |
22657 | </paramlist> | |
22658 | </constructor> | |
22659 | <method name="SetTip" type="" overloaded="no"> | |
781d2982 | 22660 | <autodoc>SetTip(self, String tip)</autodoc> |
f32fc4bc RD |
22661 | <paramlist> |
22662 | <param name="tip" type="String" default=""/> | |
22663 | </paramlist> | |
22664 | </method> | |
22665 | <method name="GetTip" type="String" overloaded="no"> | |
781d2982 | 22666 | <autodoc>GetTip(self) -> String</autodoc> |
f32fc4bc RD |
22667 | </method> |
22668 | <method name="GetWindow" type="Window" overloaded="no"> | |
781d2982 | 22669 | <autodoc>GetWindow(self) -> Window</autodoc> |
f32fc4bc RD |
22670 | </method> |
22671 | <staticmethod name="Enable" type="" overloaded="no"> | |
22672 | <autodoc>Enable(bool flag)</autodoc> | |
22673 | <paramlist> | |
22674 | <param name="flag" type="bool" default=""/> | |
22675 | </paramlist> | |
22676 | </staticmethod> | |
22677 | <staticmethod name="SetDelay" type="" overloaded="no"> | |
22678 | <autodoc>SetDelay(long milliseconds)</autodoc> | |
22679 | <paramlist> | |
22680 | <param name="milliseconds" type="long" default=""/> | |
22681 | </paramlist> | |
22682 | </staticmethod> | |
22683 | </class> | |
781d2982 | 22684 | <class name="Caret" oldname="wxCaret" module="_misc"> |
f32fc4bc | 22685 | <constructor name="Caret" overloaded="no"> |
781d2982 | 22686 | <autodoc>__init__(self, Window window, Size size) -> Caret</autodoc> |
f32fc4bc RD |
22687 | <paramlist> |
22688 | <param name="window" type="Window" default=""/> | |
22689 | <param name="size" type="Size" default=""/> | |
22690 | </paramlist> | |
22691 | </constructor> | |
22692 | <destructor name="~wxCaret" overloaded="no"> | |
781d2982 | 22693 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22694 | </destructor> |
22695 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 22696 | <autodoc>IsOk(self) -> bool</autodoc> |
f32fc4bc RD |
22697 | </method> |
22698 | <method name="IsVisible" type="bool" overloaded="no"> | |
781d2982 | 22699 | <autodoc>IsVisible(self) -> bool</autodoc> |
f32fc4bc RD |
22700 | </method> |
22701 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 22702 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
22703 | </method> |
22704 | <method name="GetPositionTuple" type="" overloaded="no"> | |
22705 | <autodoc>GetPositionTuple() -> (x,y)</autodoc> | |
22706 | <paramlist> | |
22707 | <param name="OUTPUT" type="int" default=""/> | |
22708 | <param name="OUTPUT" type="int" default=""/> | |
22709 | </paramlist> | |
22710 | </method> | |
22711 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 | 22712 | <autodoc>GetSize(self) -> Size</autodoc> |
f32fc4bc RD |
22713 | </method> |
22714 | <method name="GetSizeTuple" type="" overloaded="no"> | |
22715 | <autodoc>GetSizeTuple() -> (width, height)</autodoc> | |
22716 | <paramlist> | |
22717 | <param name="OUTPUT" type="int" default=""/> | |
22718 | <param name="OUTPUT" type="int" default=""/> | |
22719 | </paramlist> | |
22720 | </method> | |
22721 | <method name="GetWindow" type="Window" overloaded="no"> | |
781d2982 | 22722 | <autodoc>GetWindow(self) -> Window</autodoc> |
f32fc4bc RD |
22723 | </method> |
22724 | <method name="MoveXY" type="" overloaded="no"> | |
781d2982 | 22725 | <autodoc>MoveXY(self, int x, int y)</autodoc> |
f32fc4bc RD |
22726 | <paramlist> |
22727 | <param name="x" type="int" default=""/> | |
22728 | <param name="y" type="int" default=""/> | |
22729 | </paramlist> | |
22730 | </method> | |
22731 | <method name="Move" type="" overloaded="no"> | |
781d2982 | 22732 | <autodoc>Move(self, Point pt)</autodoc> |
f32fc4bc RD |
22733 | <paramlist> |
22734 | <param name="pt" type="Point" default=""/> | |
22735 | </paramlist> | |
22736 | </method> | |
22737 | <method name="SetSizeWH" type="" overloaded="no"> | |
781d2982 | 22738 | <autodoc>SetSizeWH(self, int width, int height)</autodoc> |
f32fc4bc RD |
22739 | <paramlist> |
22740 | <param name="width" type="int" default=""/> | |
22741 | <param name="height" type="int" default=""/> | |
22742 | </paramlist> | |
22743 | </method> | |
22744 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 22745 | <autodoc>SetSize(self, Size size)</autodoc> |
f32fc4bc RD |
22746 | <paramlist> |
22747 | <param name="size" type="Size" default=""/> | |
22748 | </paramlist> | |
22749 | </method> | |
22750 | <method name="Show" type="" overloaded="no"> | |
781d2982 | 22751 | <autodoc>Show(self, int show=True)</autodoc> |
f32fc4bc RD |
22752 | <paramlist> |
22753 | <param name="show" type="int" default="True"/> | |
22754 | </paramlist> | |
22755 | </method> | |
22756 | <method name="Hide" type="" overloaded="no"> | |
781d2982 | 22757 | <autodoc>Hide(self)</autodoc> |
f32fc4bc RD |
22758 | </method> |
22759 | </class> | |
22760 | <method name="Caret_GetBlinkTime" oldname="wxCaret_GetBlinkTime" type="int" overloaded="no"> | |
22761 | <autodoc>Caret_GetBlinkTime() -> int</autodoc> | |
22762 | </method> | |
22763 | <method name="Caret_SetBlinkTime" oldname="wxCaret_SetBlinkTime" type="" overloaded="no"> | |
22764 | <autodoc>Caret_SetBlinkTime(int milliseconds)</autodoc> | |
856bf319 | 22765 | <paramlist> |
f32fc4bc | 22766 | <param name="milliseconds" type="int" default=""/> |
856bf319 RD |
22767 | </paramlist> |
22768 | </method> | |
781d2982 | 22769 | <class name="BusyCursor" oldname="wxBusyCursor" module="_misc"> |
f32fc4bc | 22770 | <constructor name="BusyCursor" overloaded="no"> |
781d2982 | 22771 | <autodoc>__init__(self, Cursor cursor=wxHOURGLASS_CURSOR) -> BusyCursor</autodoc> |
f32fc4bc RD |
22772 | <paramlist> |
22773 | <param name="cursor" type="Cursor" default="wxHOURGLASS_CURSOR"/> | |
22774 | </paramlist> | |
22775 | </constructor> | |
22776 | <destructor name="~wxBusyCursor" overloaded="no"> | |
781d2982 | 22777 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22778 | </destructor> |
22779 | </class> | |
781d2982 | 22780 | <class name="WindowDisabler" oldname="wxWindowDisabler" module="_misc"> |
f32fc4bc | 22781 | <constructor name="WindowDisabler" overloaded="no"> |
781d2982 | 22782 | <autodoc>__init__(self, Window winToSkip=None) -> WindowDisabler</autodoc> |
f32fc4bc RD |
22783 | <paramlist> |
22784 | <param name="winToSkip" type="Window" default="NULL"/> | |
22785 | </paramlist> | |
22786 | </constructor> | |
22787 | <destructor name="~wxWindowDisabler" overloaded="no"> | |
781d2982 | 22788 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22789 | </destructor> |
22790 | </class> | |
781d2982 | 22791 | <class name="BusyInfo" oldname="wxBusyInfo" module="_misc"> |
f32fc4bc RD |
22792 | <baseclass name="Object"/> |
22793 | <constructor name="BusyInfo" overloaded="no"> | |
781d2982 | 22794 | <autodoc>__init__(self, String message) -> BusyInfo</autodoc> |
f32fc4bc RD |
22795 | <paramlist> |
22796 | <param name="message" type="String" default=""/> | |
22797 | </paramlist> | |
22798 | </constructor> | |
22799 | <destructor name="~wxBusyInfo" overloaded="no"> | |
781d2982 | 22800 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22801 | </destructor> |
22802 | </class> | |
781d2982 | 22803 | <class name="StopWatch" oldname="wxStopWatch" module="_misc"> |
f32fc4bc | 22804 | <constructor name="StopWatch" overloaded="no"> |
781d2982 | 22805 | <autodoc>__init__(self) -> StopWatch</autodoc> |
f32fc4bc RD |
22806 | </constructor> |
22807 | <method name="Start" type="" overloaded="no"> | |
781d2982 | 22808 | <autodoc>Start(self, long t0=0)</autodoc> |
f32fc4bc RD |
22809 | <paramlist> |
22810 | <param name="t0" type="long" default="0"/> | |
22811 | </paramlist> | |
22812 | </method> | |
22813 | <method name="Pause" type="" overloaded="no"> | |
781d2982 | 22814 | <autodoc>Pause(self)</autodoc> |
f32fc4bc RD |
22815 | </method> |
22816 | <method name="Resume" type="" overloaded="no"> | |
781d2982 | 22817 | <autodoc>Resume(self)</autodoc> |
f32fc4bc RD |
22818 | </method> |
22819 | <method name="Time" type="long" overloaded="no"> | |
781d2982 | 22820 | <autodoc>Time(self) -> long</autodoc> |
f32fc4bc RD |
22821 | </method> |
22822 | </class> | |
781d2982 | 22823 | <class name="FileHistory" oldname="wxFileHistory" module="_misc"> |
f32fc4bc RD |
22824 | <baseclass name="Object"/> |
22825 | <constructor name="FileHistory" overloaded="no"> | |
781d2982 | 22826 | <autodoc>__init__(self, int maxFiles=9) -> FileHistory</autodoc> |
f32fc4bc RD |
22827 | <paramlist> |
22828 | <param name="maxFiles" type="int" default="9"/> | |
22829 | </paramlist> | |
22830 | </constructor> | |
22831 | <destructor name="~wxFileHistory" overloaded="no"> | |
781d2982 | 22832 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22833 | </destructor> |
22834 | <method name="AddFileToHistory" type="" overloaded="no"> | |
781d2982 | 22835 | <autodoc>AddFileToHistory(self, String file)</autodoc> |
f32fc4bc RD |
22836 | <paramlist> |
22837 | <param name="file" type="String" default=""/> | |
22838 | </paramlist> | |
22839 | </method> | |
22840 | <method name="RemoveFileFromHistory" type="" overloaded="no"> | |
781d2982 | 22841 | <autodoc>RemoveFileFromHistory(self, int i)</autodoc> |
f32fc4bc RD |
22842 | <paramlist> |
22843 | <param name="i" type="int" default=""/> | |
22844 | </paramlist> | |
22845 | </method> | |
22846 | <method name="GetMaxFiles" type="int" overloaded="no"> | |
781d2982 | 22847 | <autodoc>GetMaxFiles(self) -> int</autodoc> |
f32fc4bc RD |
22848 | </method> |
22849 | <method name="UseMenu" type="" overloaded="no"> | |
781d2982 | 22850 | <autodoc>UseMenu(self, Menu menu)</autodoc> |
f32fc4bc RD |
22851 | <paramlist> |
22852 | <param name="menu" type="Menu" default=""/> | |
22853 | </paramlist> | |
22854 | </method> | |
22855 | <method name="RemoveMenu" type="" overloaded="no"> | |
781d2982 | 22856 | <autodoc>RemoveMenu(self, Menu menu)</autodoc> |
f32fc4bc RD |
22857 | <paramlist> |
22858 | <param name="menu" type="Menu" default=""/> | |
22859 | </paramlist> | |
22860 | </method> | |
22861 | <method name="Load" type="" overloaded="no"> | |
781d2982 | 22862 | <autodoc>Load(self, ConfigBase config)</autodoc> |
f32fc4bc RD |
22863 | <paramlist> |
22864 | <param name="config" type="wxConfigBase" default=""/> | |
22865 | </paramlist> | |
22866 | </method> | |
22867 | <method name="Save" type="" overloaded="no"> | |
781d2982 | 22868 | <autodoc>Save(self, ConfigBase config)</autodoc> |
f32fc4bc RD |
22869 | <paramlist> |
22870 | <param name="config" type="wxConfigBase" default=""/> | |
22871 | </paramlist> | |
22872 | </method> | |
22873 | <method name="AddFilesToMenu" type="" overloaded="no"> | |
781d2982 | 22874 | <autodoc>AddFilesToMenu(self)</autodoc> |
f32fc4bc RD |
22875 | </method> |
22876 | <method name="AddFilesToThisMenu" type="" overloaded="no"> | |
781d2982 | 22877 | <autodoc>AddFilesToThisMenu(self, Menu menu)</autodoc> |
f32fc4bc RD |
22878 | <paramlist> |
22879 | <param name="menu" type="Menu" default=""/> | |
22880 | </paramlist> | |
22881 | </method> | |
22882 | <method name="GetHistoryFile" type="String" overloaded="no"> | |
781d2982 | 22883 | <autodoc>GetHistoryFile(self, int i) -> String</autodoc> |
f32fc4bc RD |
22884 | <paramlist> |
22885 | <param name="i" type="int" default=""/> | |
22886 | </paramlist> | |
22887 | </method> | |
22888 | <method name="GetCount" type="int" overloaded="no"> | |
781d2982 | 22889 | <autodoc>GetCount(self) -> int</autodoc> |
f32fc4bc RD |
22890 | </method> |
22891 | </class> | |
781d2982 | 22892 | <class name="SingleInstanceChecker" oldname="wxSingleInstanceChecker" module="_misc"> |
f32fc4bc | 22893 | <constructor name="SingleInstanceChecker" overloaded="no"> |
781d2982 | 22894 | <autodoc>__init__(self, String name, String path=EmptyString) -> SingleInstanceChecker</autodoc> |
f32fc4bc RD |
22895 | <paramlist> |
22896 | <param name="name" type="String" default=""/> | |
22897 | <param name="path" type="String" default="wxPyEmptyString"/> | |
22898 | </paramlist> | |
22899 | </constructor> | |
22900 | <constructor name="PreSingleInstanceChecker" overloaded="no"> | |
22901 | <autodoc>PreSingleInstanceChecker() -> SingleInstanceChecker</autodoc> | |
22902 | </constructor> | |
22903 | <destructor name="~wxSingleInstanceChecker" overloaded="no"> | |
781d2982 | 22904 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22905 | </destructor> |
22906 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 22907 | <autodoc>Create(self, String name, String path=EmptyString) -> bool</autodoc> |
f32fc4bc RD |
22908 | <paramlist> |
22909 | <param name="name" type="String" default=""/> | |
22910 | <param name="path" type="String" default="wxPyEmptyString"/> | |
22911 | </paramlist> | |
22912 | </method> | |
22913 | <method name="IsAnotherRunning" type="bool" overloaded="no"> | |
781d2982 | 22914 | <autodoc>IsAnotherRunning(self) -> bool</autodoc> |
f32fc4bc RD |
22915 | </method> |
22916 | </class> | |
22917 | <method name="DrawWindowOnDC" oldname="wxDrawWindowOnDC" type="" overloaded="no"> | |
22918 | <autodoc>DrawWindowOnDC(Window window, DC dc, int method)</autodoc> | |
22919 | <paramlist> | |
22920 | <param name="window" type="Window" default=""/> | |
22921 | <param name="dc" type="DC" default=""/> | |
22922 | <param name="method" type="int" default=""/> | |
856bf319 RD |
22923 | </paramlist> |
22924 | </method> | |
f32fc4bc RD |
22925 | <pythoncode> |
22926 | #--------------------------------------------------------------------------- | |
22927 | </pythoncode> | |
781d2982 | 22928 | <class name="TipProvider" oldname="wxTipProvider" module="_misc"> |
f32fc4bc | 22929 | <destructor name="~wxTipProvider" overloaded="no"> |
781d2982 | 22930 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22931 | </destructor> |
22932 | <method name="GetTip" type="String" overloaded="no"> | |
781d2982 | 22933 | <autodoc>GetTip(self) -> String</autodoc> |
f32fc4bc RD |
22934 | </method> |
22935 | <method name="GetCurrentTip" type="size_t" overloaded="no"> | |
781d2982 | 22936 | <autodoc>GetCurrentTip(self) -> size_t</autodoc> |
f32fc4bc RD |
22937 | </method> |
22938 | <method name="PreprocessTip" type="String" overloaded="no"> | |
781d2982 | 22939 | <autodoc>PreprocessTip(self, String tip) -> String</autodoc> |
f32fc4bc RD |
22940 | <paramlist> |
22941 | <param name="tip" type="String" default=""/> | |
22942 | </paramlist> | |
22943 | </method> | |
22944 | </class> | |
781d2982 | 22945 | <class name="PyTipProvider" oldname="wxPyTipProvider" module="_misc"> |
f32fc4bc RD |
22946 | <baseclass name="TipProvider"/> |
22947 | <constructor name="PyTipProvider" overloaded="no"> | |
781d2982 | 22948 | <autodoc>__init__(self, size_t currentTip) -> PyTipProvider</autodoc> |
f32fc4bc RD |
22949 | <paramlist> |
22950 | <param name="currentTip" type="size_t" default=""/> | |
22951 | </paramlist> | |
22952 | </constructor> | |
22953 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 22954 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
22955 | <paramlist> |
22956 | <param name="self" type="PyObject" default=""/> | |
22957 | <param name="_class" type="PyObject" default=""/> | |
22958 | </paramlist> | |
22959 | </method> | |
22960 | </class> | |
22961 | <method name="ShowTip" oldname="wxShowTip" type="bool" overloaded="no"> | |
22962 | <autodoc>ShowTip(Window parent, TipProvider tipProvider, bool showAtStartup=True) -> bool</autodoc> | |
22963 | <paramlist> | |
22964 | <param name="parent" type="Window" default=""/> | |
22965 | <param name="tipProvider" type="TipProvider" default=""/> | |
22966 | <param name="showAtStartup" type="bool" default="True"/> | |
22967 | </paramlist> | |
22968 | </method> | |
22969 | <method name="CreateFileTipProvider" oldname="wxCreateFileTipProvider" type="TipProvider" overloaded="no"> | |
22970 | <autodoc>CreateFileTipProvider(String filename, size_t currentTip) -> TipProvider</autodoc> | |
22971 | <paramlist> | |
22972 | <param name="filename" type="String" default=""/> | |
22973 | <param name="currentTip" type="size_t" default=""/> | |
856bf319 RD |
22974 | </paramlist> |
22975 | </method> | |
f32fc4bc | 22976 | <pythoncode> |
0f43fbdf RD |
22977 | #--------------------------------------------------------------------------- |
22978 | </pythoncode> | |
781d2982 | 22979 | <class name="Timer" oldname="wxPyTimer" module="_misc"> |
f32fc4bc RD |
22980 | <baseclass name="EvtHandler"/> |
22981 | <constructor name="wxPyTimer" overloaded="no"> | |
781d2982 | 22982 | <autodoc>__init__(self, EvtHandler owner=None, int id=-1) -> Timer</autodoc> |
f32fc4bc RD |
22983 | <paramlist> |
22984 | <param name="owner" type="EvtHandler" default="NULL"/> | |
22985 | <param name="id" type="int" default="-1"/> | |
22986 | </paramlist> | |
22987 | </constructor> | |
22988 | <destructor name="~wxPyTimer" overloaded="no"> | |
781d2982 | 22989 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
22990 | </destructor> |
22991 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 22992 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref=1)</autodoc> |
f32fc4bc RD |
22993 | <paramlist> |
22994 | <param name="self" type="PyObject" default=""/> | |
22995 | <param name="_class" type="PyObject" default=""/> | |
b39e211b | 22996 | <param name="incref" type="int" default="1"/> |
f32fc4bc RD |
22997 | </paramlist> |
22998 | </method> | |
22999 | <method name="SetOwner" type="" overloaded="no"> | |
781d2982 | 23000 | <autodoc>SetOwner(self, EvtHandler owner, int id=-1)</autodoc> |
f32fc4bc RD |
23001 | <paramlist> |
23002 | <param name="owner" type="EvtHandler" default=""/> | |
23003 | <param name="id" type="int" default="-1"/> | |
23004 | </paramlist> | |
23005 | </method> | |
781d2982 RD |
23006 | <method name="GetOwner" type="EvtHandler" overloaded="no"> |
23007 | <autodoc>GetOwner(self) -> EvtHandler</autodoc> | |
23008 | </method> | |
f32fc4bc | 23009 | <method name="Start" type="bool" overloaded="no"> |
781d2982 | 23010 | <autodoc>Start(self, int milliseconds=-1, bool oneShot=False) -> bool</autodoc> |
f32fc4bc RD |
23011 | <paramlist> |
23012 | <param name="milliseconds" type="int" default="-1"/> | |
23013 | <param name="oneShot" type="bool" default="False"/> | |
23014 | </paramlist> | |
23015 | </method> | |
23016 | <method name="Stop" type="" overloaded="no"> | |
781d2982 | 23017 | <autodoc>Stop(self)</autodoc> |
f32fc4bc RD |
23018 | </method> |
23019 | <method name="IsRunning" type="bool" overloaded="no"> | |
781d2982 | 23020 | <autodoc>IsRunning(self) -> bool</autodoc> |
f32fc4bc RD |
23021 | </method> |
23022 | <method name="GetInterval" type="int" overloaded="no"> | |
781d2982 | 23023 | <autodoc>GetInterval(self) -> int</autodoc> |
f32fc4bc RD |
23024 | </method> |
23025 | <method name="IsOneShot" type="bool" overloaded="no"> | |
781d2982 | 23026 | <autodoc>IsOneShot(self) -> bool</autodoc> |
f32fc4bc RD |
23027 | </method> |
23028 | <method name="GetId" type="int" overloaded="no"> | |
781d2982 | 23029 | <autodoc>GetId(self) -> int</autodoc> |
f32fc4bc RD |
23030 | </method> |
23031 | </class> | |
b39e211b | 23032 | <pythoncode> |
f32fc4bc RD |
23033 | # For backwards compatibility with 2.4 |
23034 | class PyTimer(Timer): | |
23035 | def __init__(self, notify): | |
23036 | Timer.__init__(self) | |
23037 | self.notify = notify | |
23038 | ||
23039 | def Notify(self): | |
23040 | if self.notify: | |
23041 | self.notify() | |
23042 | ||
23043 | ||
23044 | EVT_TIMER = wx.PyEventBinder( wxEVT_TIMER, 1 ) | |
b39e211b | 23045 | |
0f43fbdf | 23046 | </pythoncode> |
781d2982 | 23047 | <class name="TimerEvent" oldname="wxTimerEvent" module="_misc"> |
f32fc4bc RD |
23048 | <baseclass name="Event"/> |
23049 | <constructor name="TimerEvent" overloaded="no"> | |
781d2982 | 23050 | <autodoc>__init__(self, int timerid=0, int interval=0) -> TimerEvent</autodoc> |
f32fc4bc RD |
23051 | <paramlist> |
23052 | <param name="timerid" type="int" default="0"/> | |
23053 | <param name="interval" type="int" default="0"/> | |
23054 | </paramlist> | |
23055 | </constructor> | |
23056 | <method name="GetInterval" type="int" overloaded="no"> | |
781d2982 | 23057 | <autodoc>GetInterval(self) -> int</autodoc> |
f32fc4bc RD |
23058 | </method> |
23059 | </class> | |
781d2982 | 23060 | <class name="TimerRunner" oldname="wxTimerRunner" module="_misc"> |
f32fc4bc RD |
23061 | <constructor name="TimerRunner" overloaded="yes"> |
23062 | <paramlist> | |
23063 | <param name="timer" type="wxTimer" default=""/> | |
23064 | </paramlist> | |
23065 | </constructor> | |
23066 | <constructor name="TimerRunner" overloaded="yes"> | |
781d2982 RD |
23067 | <autodoc>__init__(self, wxTimer timer) -> TimerRunner |
23068 | __init__(self, wxTimer timer, int milli, bool oneShot=False) -> TimerRunner</autodoc> | |
f32fc4bc RD |
23069 | <paramlist> |
23070 | <param name="timer" type="wxTimer" default=""/> | |
23071 | <param name="milli" type="int" default=""/> | |
23072 | <param name="oneShot" type="bool" default="False"/> | |
23073 | </paramlist> | |
23074 | </constructor> | |
23075 | <destructor name="~wxTimerRunner" overloaded="no"> | |
781d2982 | 23076 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
23077 | </destructor> |
23078 | <method name="Start" type="" overloaded="no"> | |
781d2982 | 23079 | <autodoc>Start(self, int milli, bool oneShot=False)</autodoc> |
f32fc4bc RD |
23080 | <paramlist> |
23081 | <param name="milli" type="int" default=""/> | |
23082 | <param name="oneShot" type="bool" default="False"/> | |
23083 | </paramlist> | |
23084 | </method> | |
23085 | </class> | |
23086 | <pythoncode> | |
0f43fbdf RD |
23087 | #--------------------------------------------------------------------------- |
23088 | </pythoncode> | |
781d2982 | 23089 | <class name="Log" oldname="wxLog" module="_misc"> |
f32fc4bc | 23090 | <constructor name="Log" overloaded="no"> |
781d2982 | 23091 | <autodoc>__init__(self) -> Log</autodoc> |
f32fc4bc RD |
23092 | </constructor> |
23093 | <staticmethod name="IsEnabled" type="bool" overloaded="no"> | |
23094 | <autodoc>IsEnabled() -> bool</autodoc> | |
23095 | </staticmethod> | |
23096 | <staticmethod name="EnableLogging" type="bool" overloaded="no"> | |
23097 | <autodoc>EnableLogging(bool doIt=True) -> bool</autodoc> | |
23098 | <paramlist> | |
23099 | <param name="doIt" type="bool" default="True"/> | |
23100 | </paramlist> | |
23101 | </staticmethod> | |
23102 | <staticmethod name="OnLog" type="" overloaded="no"> | |
23103 | <autodoc>OnLog(wxLogLevel level, wxChar szString, time_t t)</autodoc> | |
23104 | <paramlist> | |
23105 | <param name="level" type="wxLogLevel" default=""/> | |
23106 | <param name="szString" type="wxChar" default=""/> | |
23107 | <param name="t" type="time_t" default=""/> | |
23108 | </paramlist> | |
23109 | </staticmethod> | |
23110 | <method name="Flush" type="" overloaded="no"> | |
781d2982 | 23111 | <autodoc>Flush(self)</autodoc> |
f32fc4bc RD |
23112 | </method> |
23113 | <staticmethod name="FlushActive" type="" overloaded="no"> | |
23114 | <autodoc>FlushActive()</autodoc> | |
23115 | </staticmethod> | |
23116 | <staticmethod name="GetActiveTarget" type="Log" overloaded="no"> | |
23117 | <autodoc>GetActiveTarget() -> Log</autodoc> | |
23118 | </staticmethod> | |
23119 | <staticmethod name="SetActiveTarget" type="Log" overloaded="no"> | |
23120 | <autodoc>SetActiveTarget(Log pLogger) -> Log</autodoc> | |
23121 | <paramlist> | |
23122 | <param name="pLogger" type="Log" default=""/> | |
23123 | </paramlist> | |
23124 | </staticmethod> | |
23125 | <staticmethod name="Suspend" type="" overloaded="no"> | |
23126 | <autodoc>Suspend()</autodoc> | |
23127 | </staticmethod> | |
23128 | <staticmethod name="Resume" type="" overloaded="no"> | |
23129 | <autodoc>Resume()</autodoc> | |
23130 | </staticmethod> | |
23131 | <staticmethod name="SetVerbose" type="" overloaded="no"> | |
23132 | <autodoc>SetVerbose(bool bVerbose=True)</autodoc> | |
23133 | <paramlist> | |
23134 | <param name="bVerbose" type="bool" default="True"/> | |
23135 | </paramlist> | |
23136 | </staticmethod> | |
23137 | <staticmethod name="SetLogLevel" type="" overloaded="no"> | |
23138 | <autodoc>SetLogLevel(wxLogLevel logLevel)</autodoc> | |
23139 | <paramlist> | |
23140 | <param name="logLevel" type="wxLogLevel" default=""/> | |
23141 | </paramlist> | |
23142 | </staticmethod> | |
23143 | <staticmethod name="DontCreateOnDemand" type="" overloaded="no"> | |
23144 | <autodoc>DontCreateOnDemand()</autodoc> | |
23145 | </staticmethod> | |
23146 | <staticmethod name="SetTraceMask" type="" overloaded="no"> | |
23147 | <autodoc>SetTraceMask(wxTraceMask ulMask)</autodoc> | |
23148 | <paramlist> | |
23149 | <param name="ulMask" type="wxTraceMask" default=""/> | |
23150 | </paramlist> | |
23151 | </staticmethod> | |
23152 | <staticmethod name="AddTraceMask" type="" overloaded="no"> | |
23153 | <autodoc>AddTraceMask(String str)</autodoc> | |
23154 | <paramlist> | |
23155 | <param name="str" type="String" default=""/> | |
23156 | </paramlist> | |
23157 | </staticmethod> | |
23158 | <staticmethod name="RemoveTraceMask" type="" overloaded="no"> | |
23159 | <autodoc>RemoveTraceMask(String str)</autodoc> | |
23160 | <paramlist> | |
23161 | <param name="str" type="String" default=""/> | |
23162 | </paramlist> | |
23163 | </staticmethod> | |
23164 | <staticmethod name="ClearTraceMasks" type="" overloaded="no"> | |
23165 | <autodoc>ClearTraceMasks()</autodoc> | |
23166 | </staticmethod> | |
23167 | <staticmethod name="GetTraceMasks" type="wxArrayString" overloaded="no"> | |
23168 | <autodoc>GetTraceMasks() -> wxArrayString</autodoc> | |
23169 | </staticmethod> | |
23170 | <staticmethod name="SetTimestamp" type="" overloaded="no"> | |
23171 | <autodoc>SetTimestamp(wxChar ts)</autodoc> | |
23172 | <paramlist> | |
23173 | <param name="ts" type="wxChar" default=""/> | |
23174 | </paramlist> | |
23175 | </staticmethod> | |
23176 | <staticmethod name="GetVerbose" type="bool" overloaded="no"> | |
23177 | <autodoc>GetVerbose() -> bool</autodoc> | |
23178 | </staticmethod> | |
23179 | <staticmethod name="GetTraceMask" type="wxTraceMask" overloaded="no"> | |
23180 | <autodoc>GetTraceMask() -> wxTraceMask</autodoc> | |
23181 | </staticmethod> | |
23182 | <staticmethod name="IsAllowedTraceMask" type="bool" overloaded="no"> | |
23183 | <autodoc>IsAllowedTraceMask(wxChar mask) -> bool</autodoc> | |
23184 | <paramlist> | |
23185 | <param name="mask" type="wxChar" default=""/> | |
23186 | </paramlist> | |
23187 | </staticmethod> | |
23188 | <staticmethod name="GetLogLevel" type="wxLogLevel" overloaded="no"> | |
23189 | <autodoc>GetLogLevel() -> wxLogLevel</autodoc> | |
23190 | </staticmethod> | |
23191 | <staticmethod name="GetTimestamp" type="wxChar" overloaded="no"> | |
23192 | <autodoc>GetTimestamp() -> wxChar</autodoc> | |
23193 | </staticmethod> | |
23194 | <staticmethod name="TimeStamp" type="String" overloaded="no"> | |
23195 | <autodoc>TimeStamp() -> String</autodoc> | |
23196 | </staticmethod> | |
23197 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 23198 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
23199 | </method> |
23200 | </class> | |
781d2982 | 23201 | <class name="LogStderr" oldname="wxLogStderr" module="_misc"> |
f32fc4bc RD |
23202 | <baseclass name="Log"/> |
23203 | <constructor name="LogStderr" overloaded="no"> | |
781d2982 | 23204 | <autodoc>__init__(self) -> LogStderr</autodoc> |
f32fc4bc RD |
23205 | </constructor> |
23206 | </class> | |
781d2982 | 23207 | <class name="LogTextCtrl" oldname="wxLogTextCtrl" module="_misc"> |
f32fc4bc RD |
23208 | <baseclass name="Log"/> |
23209 | <constructor name="LogTextCtrl" overloaded="no"> | |
781d2982 | 23210 | <autodoc>__init__(self, wxTextCtrl pTextCtrl) -> LogTextCtrl</autodoc> |
f32fc4bc RD |
23211 | <paramlist> |
23212 | <param name="pTextCtrl" type="TextCtrl" default=""/> | |
23213 | </paramlist> | |
23214 | </constructor> | |
23215 | </class> | |
781d2982 | 23216 | <class name="LogGui" oldname="wxLogGui" module="_misc"> |
f32fc4bc RD |
23217 | <baseclass name="Log"/> |
23218 | <constructor name="LogGui" overloaded="no"> | |
781d2982 | 23219 | <autodoc>__init__(self) -> LogGui</autodoc> |
f32fc4bc RD |
23220 | </constructor> |
23221 | </class> | |
781d2982 | 23222 | <class name="LogWindow" oldname="wxLogWindow" module="_misc"> |
f32fc4bc RD |
23223 | <baseclass name="Log"/> |
23224 | <constructor name="LogWindow" overloaded="no"> | |
781d2982 | 23225 | <autodoc>__init__(self, wxFrame pParent, String szTitle, bool bShow=True, bool bPassToOld=True) -> LogWindow</autodoc> |
f32fc4bc RD |
23226 | <paramlist> |
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"/> | |
23231 | </paramlist> | |
23232 | </constructor> | |
23233 | <method name="Show" type="" overloaded="no"> | |
781d2982 | 23234 | <autodoc>Show(self, bool bShow=True)</autodoc> |
f32fc4bc RD |
23235 | <paramlist> |
23236 | <param name="bShow" type="bool" default="True"/> | |
23237 | </paramlist> | |
23238 | </method> | |
23239 | <method name="GetFrame" type="Frame" overloaded="no"> | |
781d2982 | 23240 | <autodoc>GetFrame(self) -> wxFrame</autodoc> |
f32fc4bc RD |
23241 | </method> |
23242 | <method name="GetOldLog" type="Log" overloaded="no"> | |
781d2982 | 23243 | <autodoc>GetOldLog(self) -> Log</autodoc> |
f32fc4bc RD |
23244 | </method> |
23245 | <method name="IsPassingMessages" type="bool" overloaded="no"> | |
781d2982 | 23246 | <autodoc>IsPassingMessages(self) -> bool</autodoc> |
f32fc4bc RD |
23247 | </method> |
23248 | <method name="PassMessages" type="" overloaded="no"> | |
781d2982 | 23249 | <autodoc>PassMessages(self, bool bDoPass)</autodoc> |
f32fc4bc RD |
23250 | <paramlist> |
23251 | <param name="bDoPass" type="bool" default=""/> | |
23252 | </paramlist> | |
23253 | </method> | |
23254 | </class> | |
781d2982 | 23255 | <class name="LogChain" oldname="wxLogChain" module="_misc"> |
f32fc4bc RD |
23256 | <baseclass name="Log"/> |
23257 | <constructor name="LogChain" overloaded="no"> | |
781d2982 | 23258 | <autodoc>__init__(self, Log logger) -> LogChain</autodoc> |
f32fc4bc RD |
23259 | <paramlist> |
23260 | <param name="logger" type="Log" default=""/> | |
23261 | </paramlist> | |
23262 | </constructor> | |
23263 | <method name="SetLog" type="" overloaded="no"> | |
781d2982 | 23264 | <autodoc>SetLog(self, Log logger)</autodoc> |
f32fc4bc RD |
23265 | <paramlist> |
23266 | <param name="logger" type="Log" default=""/> | |
23267 | </paramlist> | |
23268 | </method> | |
23269 | <method name="PassMessages" type="" overloaded="no"> | |
781d2982 | 23270 | <autodoc>PassMessages(self, bool bDoPass)</autodoc> |
f32fc4bc RD |
23271 | <paramlist> |
23272 | <param name="bDoPass" type="bool" default=""/> | |
23273 | </paramlist> | |
23274 | </method> | |
23275 | <method name="IsPassingMessages" type="bool" overloaded="no"> | |
781d2982 | 23276 | <autodoc>IsPassingMessages(self) -> bool</autodoc> |
f32fc4bc RD |
23277 | </method> |
23278 | <method name="GetOldLog" type="Log" overloaded="no"> | |
781d2982 | 23279 | <autodoc>GetOldLog(self) -> Log</autodoc> |
f32fc4bc RD |
23280 | </method> |
23281 | </class> | |
23282 | <method name="SysErrorCode" oldname="wxSysErrorCode" type="unsigned long" overloaded="no"> | |
23283 | <autodoc>SysErrorCode() -> unsigned long</autodoc> | |
23284 | </method> | |
23285 | <method name="SysErrorMsg" oldname="wxSysErrorMsg" type="String" overloaded="no"> | |
23286 | <autodoc>SysErrorMsg(unsigned long nErrCode=0) -> String</autodoc> | |
23287 | <paramlist> | |
23288 | <param name="nErrCode" type="unsigned long" default="0"/> | |
23289 | </paramlist> | |
23290 | </method> | |
23291 | <method name="LogFatalError" oldname="wxLogFatalError" type="" overloaded="no"> | |
23292 | <autodoc>LogFatalError(String msg)</autodoc> | |
23293 | <paramlist> | |
23294 | <param name="msg" type="String" default=""/> | |
23295 | </paramlist> | |
23296 | </method> | |
23297 | <method name="LogError" oldname="wxLogError" type="" overloaded="no"> | |
23298 | <autodoc>LogError(String msg)</autodoc> | |
23299 | <paramlist> | |
23300 | <param name="msg" type="String" default=""/> | |
23301 | </paramlist> | |
23302 | </method> | |
23303 | <method name="LogWarning" oldname="wxLogWarning" type="" overloaded="no"> | |
23304 | <autodoc>LogWarning(String msg)</autodoc> | |
23305 | <paramlist> | |
23306 | <param name="msg" type="String" default=""/> | |
23307 | </paramlist> | |
23308 | </method> | |
23309 | <method name="LogMessage" oldname="wxLogMessage" type="" overloaded="no"> | |
23310 | <autodoc>LogMessage(String msg)</autodoc> | |
856bf319 | 23311 | <paramlist> |
f32fc4bc | 23312 | <param name="msg" type="String" default=""/> |
856bf319 RD |
23313 | </paramlist> |
23314 | </method> | |
f32fc4bc RD |
23315 | <method name="LogInfo" oldname="wxLogInfo" type="" overloaded="no"> |
23316 | <autodoc>LogInfo(String msg)</autodoc> | |
856bf319 | 23317 | <paramlist> |
f32fc4bc | 23318 | <param name="msg" type="String" default=""/> |
856bf319 RD |
23319 | </paramlist> |
23320 | </method> | |
f32fc4bc RD |
23321 | <method name="LogDebug" oldname="wxLogDebug" type="" overloaded="no"> |
23322 | <autodoc>LogDebug(String msg)</autodoc> | |
856bf319 | 23323 | <paramlist> |
f32fc4bc | 23324 | <param name="msg" type="String" default=""/> |
856bf319 RD |
23325 | </paramlist> |
23326 | </method> | |
f32fc4bc RD |
23327 | <method name="LogVerbose" oldname="wxLogVerbose" type="" overloaded="no"> |
23328 | <autodoc>LogVerbose(String msg)</autodoc> | |
856bf319 | 23329 | <paramlist> |
f32fc4bc | 23330 | <param name="msg" type="String" default=""/> |
856bf319 RD |
23331 | </paramlist> |
23332 | </method> | |
f32fc4bc RD |
23333 | <method name="LogStatus" oldname="wxLogStatus" type="" overloaded="no"> |
23334 | <autodoc>LogStatus(String msg)</autodoc> | |
856bf319 | 23335 | <paramlist> |
f32fc4bc | 23336 | <param name="msg" type="String" default=""/> |
856bf319 RD |
23337 | </paramlist> |
23338 | </method> | |
f32fc4bc RD |
23339 | <method name="LogStatusFrame" oldname="wxLogStatus" type="" overloaded="no"> |
23340 | <autodoc>LogStatusFrame(wxFrame pFrame, String msg)</autodoc> | |
856bf319 | 23341 | <paramlist> |
f32fc4bc RD |
23342 | <param name="pFrame" type="Frame" default=""/> |
23343 | <param name="msg" type="String" default=""/> | |
856bf319 RD |
23344 | </paramlist> |
23345 | </method> | |
f32fc4bc RD |
23346 | <method name="LogSysError" oldname="wxLogSysError" type="" overloaded="no"> |
23347 | <autodoc>LogSysError(String msg)</autodoc> | |
856bf319 | 23348 | <paramlist> |
f32fc4bc | 23349 | <param name="msg" type="String" default=""/> |
856bf319 RD |
23350 | </paramlist> |
23351 | </method> | |
f32fc4bc | 23352 | <method name="LogTrace" oldname="wxLogTrace" type="" overloaded="yes"> |
856bf319 | 23353 | <paramlist> |
f32fc4bc RD |
23354 | <param name="mask" type="unsigned long" default=""/> |
23355 | <param name="msg" type="String" default=""/> | |
856bf319 RD |
23356 | </paramlist> |
23357 | </method> | |
f32fc4bc RD |
23358 | <method name="LogTrace" oldname="wxLogTrace" type="" overloaded="yes"> |
23359 | <autodoc>LogTrace(unsigned long mask, String msg) | |
23360 | LogTrace(String mask, String msg)</autodoc> | |
856bf319 | 23361 | <paramlist> |
f32fc4bc RD |
23362 | <param name="mask" type="String" default=""/> |
23363 | <param name="msg" type="String" default=""/> | |
23364 | </paramlist> | |
23365 | </method> | |
23366 | <method name="LogGeneric" oldname="wxLogGeneric" type="" overloaded="no"> | |
23367 | <autodoc>LogGeneric(unsigned long level, String msg)</autodoc> | |
23368 | <paramlist> | |
23369 | <param name="level" type="unsigned long" default=""/> | |
23370 | <param name="msg" type="String" default=""/> | |
23371 | </paramlist> | |
23372 | </method> | |
23373 | <method name="SafeShowMessage" oldname="wxSafeShowMessage" type="" overloaded="no"> | |
23374 | <autodoc>SafeShowMessage(String title, String text)</autodoc> | |
23375 | <paramlist> | |
23376 | <param name="title" type="String" default=""/> | |
23377 | <param name="text" type="String" default=""/> | |
23378 | </paramlist> | |
23379 | </method> | |
781d2982 | 23380 | <class name="LogNull" oldname="wxLogNull" module="_misc"> |
f32fc4bc | 23381 | <constructor name="LogNull" overloaded="no"> |
781d2982 | 23382 | <autodoc>__init__(self) -> LogNull</autodoc> |
f32fc4bc RD |
23383 | </constructor> |
23384 | <destructor name="~wxLogNull" overloaded="no"> | |
781d2982 | 23385 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
23386 | </destructor> |
23387 | </class> | |
781d2982 | 23388 | <class name="PyLog" oldname="wxPyLog" module="_misc"> |
f32fc4bc RD |
23389 | <baseclass name="Log"/> |
23390 | <constructor name="PyLog" overloaded="no"> | |
781d2982 | 23391 | <autodoc>__init__(self) -> PyLog</autodoc> |
f32fc4bc RD |
23392 | </constructor> |
23393 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 23394 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
23395 | <paramlist> |
23396 | <param name="self" type="PyObject" default=""/> | |
23397 | <param name="_class" type="PyObject" default=""/> | |
23398 | </paramlist> | |
23399 | </method> | |
23400 | </class> | |
23401 | <pythoncode> | |
0f43fbdf RD |
23402 | #--------------------------------------------------------------------------- |
23403 | </pythoncode> | |
781d2982 | 23404 | <class name="Process" oldname="wxPyProcess" module="_misc"> |
f32fc4bc RD |
23405 | <baseclass name="EvtHandler"/> |
23406 | <constructor name="wxPyProcess" overloaded="no"> | |
781d2982 | 23407 | <autodoc>__init__(self, EvtHandler parent=None, int id=-1) -> Process</autodoc> |
f32fc4bc RD |
23408 | <paramlist> |
23409 | <param name="parent" type="EvtHandler" default="NULL"/> | |
23410 | <param name="id" type="int" default="-1"/> | |
23411 | </paramlist> | |
23412 | </constructor> | |
23413 | <staticmethod name="Kill" type="wxKillError" overloaded="no"> | |
23414 | <autodoc>Kill(int pid, int sig=SIGTERM) -> int</autodoc> | |
23415 | <paramlist> | |
23416 | <param name="pid" type="int" default=""/> | |
23417 | <param name="sig" type="wxSignal" default="wxSIGTERM"/> | |
23418 | </paramlist> | |
23419 | </staticmethod> | |
23420 | <staticmethod name="Exists" type="bool" overloaded="no"> | |
23421 | <autodoc>Exists(int pid) -> bool</autodoc> | |
23422 | <paramlist> | |
23423 | <param name="pid" type="int" default=""/> | |
23424 | </paramlist> | |
23425 | </staticmethod> | |
23426 | <staticmethod name="Open" type="Process" overloaded="no"> | |
23427 | <autodoc>Open(String cmd, int flags=EXEC_ASYNC) -> Process</autodoc> | |
23428 | <paramlist> | |
23429 | <param name="cmd" type="String" default=""/> | |
23430 | <param name="flags" type="int" default="wxEXEC_ASYNC"/> | |
23431 | </paramlist> | |
23432 | </staticmethod> | |
23433 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 23434 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
23435 | <paramlist> |
23436 | <param name="self" type="PyObject" default=""/> | |
23437 | <param name="_class" type="PyObject" default=""/> | |
23438 | </paramlist> | |
23439 | </method> | |
23440 | <method name="base_OnTerminate" type="" overloaded="no"> | |
781d2982 | 23441 | <autodoc>base_OnTerminate(self, int pid, int status)</autodoc> |
f32fc4bc RD |
23442 | <paramlist> |
23443 | <param name="pid" type="int" default=""/> | |
23444 | <param name="status" type="int" default=""/> | |
23445 | </paramlist> | |
23446 | </method> | |
23447 | <method name="Redirect" type="" overloaded="no"> | |
781d2982 | 23448 | <autodoc>Redirect(self)</autodoc> |
f32fc4bc RD |
23449 | </method> |
23450 | <method name="IsRedirected" type="bool" overloaded="no"> | |
781d2982 | 23451 | <autodoc>IsRedirected(self) -> bool</autodoc> |
f32fc4bc RD |
23452 | </method> |
23453 | <method name="Detach" type="" overloaded="no"> | |
781d2982 | 23454 | <autodoc>Detach(self)</autodoc> |
f32fc4bc RD |
23455 | </method> |
23456 | <method name="GetInputStream" type="wxInputStream" overloaded="no"> | |
781d2982 | 23457 | <autodoc>GetInputStream(self) -> InputStream</autodoc> |
f32fc4bc RD |
23458 | </method> |
23459 | <method name="GetErrorStream" type="wxInputStream" overloaded="no"> | |
781d2982 | 23460 | <autodoc>GetErrorStream(self) -> InputStream</autodoc> |
f32fc4bc RD |
23461 | </method> |
23462 | <method name="GetOutputStream" type="OutputStream" overloaded="no"> | |
781d2982 | 23463 | <autodoc>GetOutputStream(self) -> OutputStream</autodoc> |
f32fc4bc RD |
23464 | </method> |
23465 | <method name="CloseOutput" type="" overloaded="no"> | |
781d2982 | 23466 | <autodoc>CloseOutput(self)</autodoc> |
f32fc4bc RD |
23467 | </method> |
23468 | <method name="IsInputOpened" type="bool" overloaded="no"> | |
781d2982 | 23469 | <autodoc>IsInputOpened(self) -> bool</autodoc> |
f32fc4bc RD |
23470 | </method> |
23471 | <method name="IsInputAvailable" type="bool" overloaded="no"> | |
781d2982 | 23472 | <autodoc>IsInputAvailable(self) -> bool</autodoc> |
f32fc4bc RD |
23473 | </method> |
23474 | <method name="IsErrorAvailable" type="bool" overloaded="no"> | |
781d2982 | 23475 | <autodoc>IsErrorAvailable(self) -> bool</autodoc> |
f32fc4bc RD |
23476 | </method> |
23477 | </class> | |
781d2982 | 23478 | <class name="ProcessEvent" oldname="wxProcessEvent" module="_misc"> |
f32fc4bc RD |
23479 | <baseclass name="Event"/> |
23480 | <constructor name="ProcessEvent" overloaded="no"> | |
781d2982 | 23481 | <autodoc>__init__(self, int id=0, int pid=0, int exitcode=0) -> ProcessEvent</autodoc> |
f32fc4bc RD |
23482 | <paramlist> |
23483 | <param name="id" type="int" default="0"/> | |
23484 | <param name="pid" type="int" default="0"/> | |
23485 | <param name="exitcode" type="int" default="0"/> | |
23486 | </paramlist> | |
23487 | </constructor> | |
23488 | <method name="GetPid" type="int" overloaded="no"> | |
781d2982 | 23489 | <autodoc>GetPid(self) -> int</autodoc> |
f32fc4bc RD |
23490 | </method> |
23491 | <method name="GetExitCode" type="int" overloaded="no"> | |
781d2982 | 23492 | <autodoc>GetExitCode(self) -> int</autodoc> |
f32fc4bc RD |
23493 | </method> |
23494 | <property name="m_pid" type="int" readonly="no"/> | |
23495 | <property name="m_exitcode" type="int" readonly="no"/> | |
23496 | </class> | |
23497 | <pythoncode> | |
23498 | EVT_END_PROCESS = wx.PyEventBinder( wxEVT_END_PROCESS, 1 ) | |
23499 | </pythoncode> | |
23500 | <method name="Execute" oldname="wxExecute" type="long" overloaded="no"> | |
23501 | <autodoc>Execute(String command, int flags=EXEC_ASYNC, Process process=None) -> long</autodoc> | |
856bf319 | 23502 | <paramlist> |
f32fc4bc RD |
23503 | <param name="command" type="String" default=""/> |
23504 | <param name="flags" type="int" default="wxEXEC_ASYNC"/> | |
23505 | <param name="process" type="Process" default="NULL"/> | |
856bf319 RD |
23506 | </paramlist> |
23507 | </method> | |
f32fc4bc RD |
23508 | <pythoncode> |
23509 | #--------------------------------------------------------------------------- | |
23510 | </pythoncode> | |
781d2982 | 23511 | <class name="Joystick" oldname="wxJoystick" module="_misc"> |
f32fc4bc | 23512 | <constructor name="Joystick" overloaded="no"> |
781d2982 | 23513 | <autodoc>__init__(self, int joystick=JOYSTICK1) -> Joystick</autodoc> |
f32fc4bc RD |
23514 | <paramlist> |
23515 | <param name="joystick" type="int" default="wxJOYSTICK1"/> | |
23516 | </paramlist> | |
23517 | </constructor> | |
23518 | <destructor name="~wxJoystick" overloaded="no"> | |
781d2982 | 23519 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
23520 | </destructor> |
23521 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 23522 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
23523 | </method> |
23524 | <method name="GetZPosition" type="int" overloaded="no"> | |
781d2982 | 23525 | <autodoc>GetZPosition(self) -> int</autodoc> |
f32fc4bc RD |
23526 | </method> |
23527 | <method name="GetButtonState" type="int" overloaded="no"> | |
781d2982 | 23528 | <autodoc>GetButtonState(self) -> int</autodoc> |
f32fc4bc RD |
23529 | </method> |
23530 | <method name="GetPOVPosition" type="int" overloaded="no"> | |
781d2982 | 23531 | <autodoc>GetPOVPosition(self) -> int</autodoc> |
f32fc4bc RD |
23532 | </method> |
23533 | <method name="GetPOVCTSPosition" type="int" overloaded="no"> | |
781d2982 | 23534 | <autodoc>GetPOVCTSPosition(self) -> int</autodoc> |
f32fc4bc RD |
23535 | </method> |
23536 | <method name="GetRudderPosition" type="int" overloaded="no"> | |
781d2982 | 23537 | <autodoc>GetRudderPosition(self) -> int</autodoc> |
f32fc4bc RD |
23538 | </method> |
23539 | <method name="GetUPosition" type="int" overloaded="no"> | |
781d2982 | 23540 | <autodoc>GetUPosition(self) -> int</autodoc> |
f32fc4bc RD |
23541 | </method> |
23542 | <method name="GetVPosition" type="int" overloaded="no"> | |
781d2982 | 23543 | <autodoc>GetVPosition(self) -> int</autodoc> |
f32fc4bc RD |
23544 | </method> |
23545 | <method name="GetMovementThreshold" type="int" overloaded="no"> | |
781d2982 | 23546 | <autodoc>GetMovementThreshold(self) -> int</autodoc> |
f32fc4bc RD |
23547 | </method> |
23548 | <method name="SetMovementThreshold" type="" overloaded="no"> | |
781d2982 | 23549 | <autodoc>SetMovementThreshold(self, int threshold)</autodoc> |
f32fc4bc RD |
23550 | <paramlist> |
23551 | <param name="threshold" type="int" default=""/> | |
23552 | </paramlist> | |
23553 | </method> | |
23554 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 23555 | <autodoc>IsOk(self) -> bool</autodoc> |
f32fc4bc RD |
23556 | </method> |
23557 | <method name="GetNumberJoysticks" type="int" overloaded="no"> | |
781d2982 | 23558 | <autodoc>GetNumberJoysticks(self) -> int</autodoc> |
f32fc4bc RD |
23559 | </method> |
23560 | <method name="GetManufacturerId" type="int" overloaded="no"> | |
781d2982 | 23561 | <autodoc>GetManufacturerId(self) -> int</autodoc> |
f32fc4bc RD |
23562 | </method> |
23563 | <method name="GetProductId" type="int" overloaded="no"> | |
781d2982 | 23564 | <autodoc>GetProductId(self) -> int</autodoc> |
f32fc4bc RD |
23565 | </method> |
23566 | <method name="GetProductName" type="String" overloaded="no"> | |
781d2982 | 23567 | <autodoc>GetProductName(self) -> String</autodoc> |
f32fc4bc RD |
23568 | </method> |
23569 | <method name="GetXMin" type="int" overloaded="no"> | |
781d2982 | 23570 | <autodoc>GetXMin(self) -> int</autodoc> |
f32fc4bc RD |
23571 | </method> |
23572 | <method name="GetYMin" type="int" overloaded="no"> | |
781d2982 | 23573 | <autodoc>GetYMin(self) -> int</autodoc> |
f32fc4bc RD |
23574 | </method> |
23575 | <method name="GetZMin" type="int" overloaded="no"> | |
781d2982 | 23576 | <autodoc>GetZMin(self) -> int</autodoc> |
f32fc4bc RD |
23577 | </method> |
23578 | <method name="GetXMax" type="int" overloaded="no"> | |
781d2982 | 23579 | <autodoc>GetXMax(self) -> int</autodoc> |
f32fc4bc RD |
23580 | </method> |
23581 | <method name="GetYMax" type="int" overloaded="no"> | |
781d2982 | 23582 | <autodoc>GetYMax(self) -> int</autodoc> |
f32fc4bc RD |
23583 | </method> |
23584 | <method name="GetZMax" type="int" overloaded="no"> | |
781d2982 | 23585 | <autodoc>GetZMax(self) -> int</autodoc> |
f32fc4bc RD |
23586 | </method> |
23587 | <method name="GetNumberButtons" type="int" overloaded="no"> | |
781d2982 | 23588 | <autodoc>GetNumberButtons(self) -> int</autodoc> |
f32fc4bc RD |
23589 | </method> |
23590 | <method name="GetNumberAxes" type="int" overloaded="no"> | |
781d2982 | 23591 | <autodoc>GetNumberAxes(self) -> int</autodoc> |
f32fc4bc RD |
23592 | </method> |
23593 | <method name="GetMaxButtons" type="int" overloaded="no"> | |
781d2982 | 23594 | <autodoc>GetMaxButtons(self) -> int</autodoc> |
f32fc4bc RD |
23595 | </method> |
23596 | <method name="GetMaxAxes" type="int" overloaded="no"> | |
781d2982 | 23597 | <autodoc>GetMaxAxes(self) -> int</autodoc> |
f32fc4bc RD |
23598 | </method> |
23599 | <method name="GetPollingMin" type="int" overloaded="no"> | |
781d2982 | 23600 | <autodoc>GetPollingMin(self) -> int</autodoc> |
f32fc4bc RD |
23601 | </method> |
23602 | <method name="GetPollingMax" type="int" overloaded="no"> | |
781d2982 | 23603 | <autodoc>GetPollingMax(self) -> int</autodoc> |
f32fc4bc RD |
23604 | </method> |
23605 | <method name="GetRudderMin" type="int" overloaded="no"> | |
781d2982 | 23606 | <autodoc>GetRudderMin(self) -> int</autodoc> |
f32fc4bc RD |
23607 | </method> |
23608 | <method name="GetRudderMax" type="int" overloaded="no"> | |
781d2982 | 23609 | <autodoc>GetRudderMax(self) -> int</autodoc> |
f32fc4bc RD |
23610 | </method> |
23611 | <method name="GetUMin" type="int" overloaded="no"> | |
781d2982 | 23612 | <autodoc>GetUMin(self) -> int</autodoc> |
f32fc4bc RD |
23613 | </method> |
23614 | <method name="GetUMax" type="int" overloaded="no"> | |
781d2982 | 23615 | <autodoc>GetUMax(self) -> int</autodoc> |
f32fc4bc RD |
23616 | </method> |
23617 | <method name="GetVMin" type="int" overloaded="no"> | |
781d2982 | 23618 | <autodoc>GetVMin(self) -> int</autodoc> |
f32fc4bc RD |
23619 | </method> |
23620 | <method name="GetVMax" type="int" overloaded="no"> | |
781d2982 | 23621 | <autodoc>GetVMax(self) -> int</autodoc> |
f32fc4bc RD |
23622 | </method> |
23623 | <method name="HasRudder" type="bool" overloaded="no"> | |
781d2982 | 23624 | <autodoc>HasRudder(self) -> bool</autodoc> |
f32fc4bc RD |
23625 | </method> |
23626 | <method name="HasZ" type="bool" overloaded="no"> | |
781d2982 | 23627 | <autodoc>HasZ(self) -> bool</autodoc> |
f32fc4bc RD |
23628 | </method> |
23629 | <method name="HasU" type="bool" overloaded="no"> | |
781d2982 | 23630 | <autodoc>HasU(self) -> bool</autodoc> |
f32fc4bc RD |
23631 | </method> |
23632 | <method name="HasV" type="bool" overloaded="no"> | |
781d2982 | 23633 | <autodoc>HasV(self) -> bool</autodoc> |
f32fc4bc RD |
23634 | </method> |
23635 | <method name="HasPOV" type="bool" overloaded="no"> | |
781d2982 | 23636 | <autodoc>HasPOV(self) -> bool</autodoc> |
f32fc4bc RD |
23637 | </method> |
23638 | <method name="HasPOV4Dir" type="bool" overloaded="no"> | |
781d2982 | 23639 | <autodoc>HasPOV4Dir(self) -> bool</autodoc> |
f32fc4bc RD |
23640 | </method> |
23641 | <method name="HasPOVCTS" type="bool" overloaded="no"> | |
781d2982 | 23642 | <autodoc>HasPOVCTS(self) -> bool</autodoc> |
f32fc4bc RD |
23643 | </method> |
23644 | <method name="SetCapture" type="bool" overloaded="no"> | |
781d2982 | 23645 | <autodoc>SetCapture(self, Window win, int pollingFreq=0) -> bool</autodoc> |
f32fc4bc RD |
23646 | <paramlist> |
23647 | <param name="win" type="Window" default=""/> | |
23648 | <param name="pollingFreq" type="int" default="0"/> | |
23649 | </paramlist> | |
23650 | </method> | |
23651 | <method name="ReleaseCapture" type="bool" overloaded="no"> | |
781d2982 | 23652 | <autodoc>ReleaseCapture(self) -> bool</autodoc> |
f32fc4bc RD |
23653 | </method> |
23654 | </class> | |
781d2982 | 23655 | <class name="JoystickEvent" oldname="wxJoystickEvent" module="_misc"> |
f32fc4bc RD |
23656 | <baseclass name="Event"/> |
23657 | <constructor name="JoystickEvent" overloaded="no"> | |
781d2982 | 23658 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int state=0, int joystick=JOYSTICK1, |
f32fc4bc RD |
23659 | int change=0) -> JoystickEvent</autodoc> |
23660 | <paramlist> | |
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"/> | |
23665 | </paramlist> | |
23666 | </constructor> | |
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"> | |
781d2982 | 23673 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
23674 | </method> |
23675 | <method name="GetZPosition" type="int" overloaded="no"> | |
781d2982 | 23676 | <autodoc>GetZPosition(self) -> int</autodoc> |
f32fc4bc RD |
23677 | </method> |
23678 | <method name="GetButtonState" type="int" overloaded="no"> | |
781d2982 | 23679 | <autodoc>GetButtonState(self) -> int</autodoc> |
f32fc4bc RD |
23680 | </method> |
23681 | <method name="GetButtonChange" type="int" overloaded="no"> | |
781d2982 | 23682 | <autodoc>GetButtonChange(self) -> int</autodoc> |
f32fc4bc RD |
23683 | </method> |
23684 | <method name="GetJoystick" type="int" overloaded="no"> | |
781d2982 | 23685 | <autodoc>GetJoystick(self) -> int</autodoc> |
f32fc4bc RD |
23686 | </method> |
23687 | <method name="SetJoystick" type="" overloaded="no"> | |
781d2982 | 23688 | <autodoc>SetJoystick(self, int stick)</autodoc> |
f32fc4bc RD |
23689 | <paramlist> |
23690 | <param name="stick" type="int" default=""/> | |
23691 | </paramlist> | |
23692 | </method> | |
23693 | <method name="SetButtonState" type="" overloaded="no"> | |
781d2982 | 23694 | <autodoc>SetButtonState(self, int state)</autodoc> |
f32fc4bc RD |
23695 | <paramlist> |
23696 | <param name="state" type="int" default=""/> | |
23697 | </paramlist> | |
23698 | </method> | |
23699 | <method name="SetButtonChange" type="" overloaded="no"> | |
781d2982 | 23700 | <autodoc>SetButtonChange(self, int change)</autodoc> |
f32fc4bc RD |
23701 | <paramlist> |
23702 | <param name="change" type="int" default=""/> | |
23703 | </paramlist> | |
23704 | </method> | |
23705 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 23706 | <autodoc>SetPosition(self, Point pos)</autodoc> |
f32fc4bc RD |
23707 | <paramlist> |
23708 | <param name="pos" type="Point" default=""/> | |
23709 | </paramlist> | |
23710 | </method> | |
23711 | <method name="SetZPosition" type="" overloaded="no"> | |
781d2982 | 23712 | <autodoc>SetZPosition(self, int zPos)</autodoc> |
f32fc4bc RD |
23713 | <paramlist> |
23714 | <param name="zPos" type="int" default=""/> | |
23715 | </paramlist> | |
23716 | </method> | |
23717 | <method name="IsButton" type="bool" overloaded="no"> | |
781d2982 | 23718 | <autodoc>IsButton(self) -> bool</autodoc> |
f32fc4bc RD |
23719 | </method> |
23720 | <method name="IsMove" type="bool" overloaded="no"> | |
781d2982 | 23721 | <autodoc>IsMove(self) -> bool</autodoc> |
f32fc4bc RD |
23722 | </method> |
23723 | <method name="IsZMove" type="bool" overloaded="no"> | |
781d2982 | 23724 | <autodoc>IsZMove(self) -> bool</autodoc> |
f32fc4bc RD |
23725 | </method> |
23726 | <method name="ButtonDown" type="bool" overloaded="no"> | |
781d2982 | 23727 | <autodoc>ButtonDown(self, int but=JOY_BUTTON_ANY) -> bool</autodoc> |
f32fc4bc RD |
23728 | <paramlist> |
23729 | <param name="but" type="int" default="wxJOY_BUTTON_ANY"/> | |
23730 | </paramlist> | |
23731 | </method> | |
23732 | <method name="ButtonUp" type="bool" overloaded="no"> | |
781d2982 | 23733 | <autodoc>ButtonUp(self, int but=JOY_BUTTON_ANY) -> bool</autodoc> |
f32fc4bc RD |
23734 | <paramlist> |
23735 | <param name="but" type="int" default="wxJOY_BUTTON_ANY"/> | |
23736 | </paramlist> | |
23737 | </method> | |
23738 | <method name="ButtonIsDown" type="bool" overloaded="no"> | |
781d2982 | 23739 | <autodoc>ButtonIsDown(self, int but=JOY_BUTTON_ANY) -> bool</autodoc> |
f32fc4bc RD |
23740 | <paramlist> |
23741 | <param name="but" type="int" default="wxJOY_BUTTON_ANY"/> | |
23742 | </paramlist> | |
23743 | </method> | |
23744 | </class> | |
23745 | <pythoncode> | |
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 ) | |
23750 | ||
23751 | EVT_JOYSTICK_EVENTS = wx.PyEventBinder([ wxEVT_JOY_BUTTON_DOWN, | |
23752 | wxEVT_JOY_BUTTON_UP, | |
23753 | wxEVT_JOY_MOVE, | |
23754 | wxEVT_JOY_ZMOVE, | |
23755 | ]) | |
856bf319 | 23756 | |
0f43fbdf | 23757 | </pythoncode> |
f32fc4bc | 23758 | <pythoncode> |
0f43fbdf RD |
23759 | #--------------------------------------------------------------------------- |
23760 | </pythoncode> | |
781d2982 RD |
23761 | <class name="Sound" oldname="wxSound" module="_misc"> |
23762 | <constructor name="Sound" overloaded="no"> | |
23763 | <autodoc>__init__(self, String fileName=EmptyString) -> Sound</autodoc> | |
f32fc4bc | 23764 | <paramlist> |
781d2982 | 23765 | <param name="fileName" type="String" default="wxPyEmptyString"/> |
f32fc4bc RD |
23766 | </paramlist> |
23767 | </constructor> | |
781d2982 RD |
23768 | <constructor name="SoundFromData" overloaded="no"> |
23769 | <autodoc>SoundFromData(PyObject data) -> Sound</autodoc> | |
f32fc4bc | 23770 | <paramlist> |
781d2982 | 23771 | <param name="data" type="PyObject" default=""/> |
f32fc4bc RD |
23772 | </paramlist> |
23773 | </constructor> | |
23774 | <destructor name="~wxSound" overloaded="no"> | |
781d2982 | 23775 | <autodoc>__del__(self)</autodoc> |
f32fc4bc | 23776 | </destructor> |
781d2982 RD |
23777 | <method name="Create" type="bool" overloaded="no"> |
23778 | <autodoc>Create(self, String fileName) -> bool</autodoc> | |
f32fc4bc RD |
23779 | <paramlist> |
23780 | <param name="fileName" type="String" default=""/> | |
f32fc4bc RD |
23781 | </paramlist> |
23782 | </method> | |
781d2982 RD |
23783 | <method name="CreateFromData" type="bool" overloaded="no"> |
23784 | <autodoc>CreateFromData(self, PyObject data) -> bool</autodoc> | |
f32fc4bc | 23785 | <paramlist> |
781d2982 | 23786 | <param name="data" type="PyObject" default=""/> |
f32fc4bc RD |
23787 | </paramlist> |
23788 | </method> | |
23789 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 23790 | <autodoc>IsOk(self) -> bool</autodoc> |
f32fc4bc RD |
23791 | </method> |
23792 | <method name="Play" type="bool" overloaded="no"> | |
781d2982 | 23793 | <autodoc>Play(self, unsigned int flags=SOUND_ASYNC) -> bool</autodoc> |
f32fc4bc RD |
23794 | <paramlist> |
23795 | <param name="flags" type="unsigned int" default="wxSOUND_ASYNC"/> | |
23796 | </paramlist> | |
23797 | </method> | |
23798 | <staticmethod name="PlaySound" type="bool" overloaded="no"> | |
23799 | <autodoc>PlaySound(String filename, unsigned int flags=SOUND_ASYNC) -> bool</autodoc> | |
23800 | <paramlist> | |
23801 | <param name="filename" type="String" default=""/> | |
23802 | <param name="flags" type="unsigned int" default="wxSOUND_ASYNC"/> | |
23803 | </paramlist> | |
23804 | </staticmethod> | |
23805 | <staticmethod name="Stop" type="" overloaded="no"> | |
23806 | <autodoc>Stop()</autodoc> | |
23807 | </staticmethod> | |
23808 | </class> | |
23809 | <pythoncode> | |
23810 | #--------------------------------------------------------------------------- | |
23811 | </pythoncode> | |
781d2982 | 23812 | <class name="FileTypeInfo" oldname="wxFileTypeInfo" module="_misc"> |
f32fc4bc | 23813 | <constructor name="FileTypeInfo" overloaded="no"> |
781d2982 | 23814 | <autodoc>__init__(self, String mimeType, String openCmd, String printCmd, String desc) -> FileTypeInfo</autodoc> |
f32fc4bc RD |
23815 | <paramlist> |
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=""/> | |
23820 | </paramlist> | |
23821 | </constructor> | |
23822 | <constructor name="FileTypeInfoSequence" overloaded="no"> | |
23823 | <autodoc>FileTypeInfoSequence(wxArrayString sArray) -> FileTypeInfo</autodoc> | |
23824 | <paramlist> | |
23825 | <param name="sArray" type="wxArrayString" default=""/> | |
23826 | </paramlist> | |
23827 | </constructor> | |
23828 | <constructor name="NullFileTypeInfo" overloaded="no"> | |
23829 | <autodoc>NullFileTypeInfo() -> FileTypeInfo</autodoc> | |
23830 | </constructor> | |
23831 | <method name="IsValid" type="bool" overloaded="no"> | |
781d2982 | 23832 | <autodoc>IsValid(self) -> bool</autodoc> |
f32fc4bc RD |
23833 | </method> |
23834 | <method name="SetIcon" type="" overloaded="no"> | |
781d2982 | 23835 | <autodoc>SetIcon(self, String iconFile, int iconIndex=0)</autodoc> |
f32fc4bc RD |
23836 | <paramlist> |
23837 | <param name="iconFile" type="String" default=""/> | |
23838 | <param name="iconIndex" type="int" default="0"/> | |
23839 | </paramlist> | |
23840 | </method> | |
23841 | <method name="SetShortDesc" type="" overloaded="no"> | |
781d2982 | 23842 | <autodoc>SetShortDesc(self, String shortDesc)</autodoc> |
f32fc4bc RD |
23843 | <paramlist> |
23844 | <param name="shortDesc" type="String" default=""/> | |
23845 | </paramlist> | |
23846 | </method> | |
23847 | <method name="GetMimeType" type="String" overloaded="no"> | |
781d2982 | 23848 | <autodoc>GetMimeType(self) -> String</autodoc> |
f32fc4bc RD |
23849 | </method> |
23850 | <method name="GetOpenCommand" type="String" overloaded="no"> | |
781d2982 | 23851 | <autodoc>GetOpenCommand(self) -> String</autodoc> |
f32fc4bc RD |
23852 | </method> |
23853 | <method name="GetPrintCommand" type="String" overloaded="no"> | |
781d2982 | 23854 | <autodoc>GetPrintCommand(self) -> String</autodoc> |
f32fc4bc RD |
23855 | </method> |
23856 | <method name="GetShortDesc" type="String" overloaded="no"> | |
781d2982 | 23857 | <autodoc>GetShortDesc(self) -> String</autodoc> |
f32fc4bc RD |
23858 | </method> |
23859 | <method name="GetDescription" type="String" overloaded="no"> | |
781d2982 | 23860 | <autodoc>GetDescription(self) -> String</autodoc> |
f32fc4bc RD |
23861 | </method> |
23862 | <method name="GetExtensions" type="wxArrayString" overloaded="no"> | |
781d2982 | 23863 | <autodoc>GetExtensions(self) -> wxArrayString</autodoc> |
f32fc4bc RD |
23864 | </method> |
23865 | <method name="GetExtensionsCount" type="int" overloaded="no"> | |
781d2982 | 23866 | <autodoc>GetExtensionsCount(self) -> int</autodoc> |
f32fc4bc RD |
23867 | </method> |
23868 | <method name="GetIconFile" type="String" overloaded="no"> | |
781d2982 | 23869 | <autodoc>GetIconFile(self) -> String</autodoc> |
f32fc4bc RD |
23870 | </method> |
23871 | <method name="GetIconIndex" type="int" overloaded="no"> | |
781d2982 | 23872 | <autodoc>GetIconIndex(self) -> int</autodoc> |
f32fc4bc RD |
23873 | </method> |
23874 | </class> | |
781d2982 | 23875 | <class name="FileType" oldname="wxFileType" module="_misc"> |
f32fc4bc | 23876 | <constructor name="FileType" overloaded="no"> |
781d2982 | 23877 | <autodoc>__init__(self, FileTypeInfo ftInfo) -> FileType</autodoc> |
f32fc4bc RD |
23878 | <paramlist> |
23879 | <param name="ftInfo" type="FileTypeInfo" default=""/> | |
23880 | </paramlist> | |
23881 | </constructor> | |
23882 | <destructor name="~wxFileType" overloaded="no"> | |
781d2982 | 23883 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
23884 | </destructor> |
23885 | <method name="GetMimeType" type="PyObject" overloaded="no"> | |
781d2982 | 23886 | <autodoc>GetMimeType(self) -> PyObject</autodoc> |
f32fc4bc RD |
23887 | </method> |
23888 | <method name="GetMimeTypes" type="PyObject" overloaded="no"> | |
781d2982 | 23889 | <autodoc>GetMimeTypes(self) -> PyObject</autodoc> |
f32fc4bc RD |
23890 | </method> |
23891 | <method name="GetExtensions" type="PyObject" overloaded="no"> | |
781d2982 | 23892 | <autodoc>GetExtensions(self) -> PyObject</autodoc> |
f32fc4bc RD |
23893 | </method> |
23894 | <method name="GetIcon" type="Icon" overloaded="no"> | |
781d2982 | 23895 | <autodoc>GetIcon(self) -> Icon</autodoc> |
f32fc4bc RD |
23896 | </method> |
23897 | <method name="GetIconInfo" type="PyObject" overloaded="no"> | |
781d2982 | 23898 | <autodoc>GetIconInfo(self) -> PyObject</autodoc> |
f32fc4bc RD |
23899 | </method> |
23900 | <method name="GetDescription" type="PyObject" overloaded="no"> | |
781d2982 | 23901 | <autodoc>GetDescription(self) -> PyObject</autodoc> |
f32fc4bc RD |
23902 | </method> |
23903 | <method name="GetOpenCommand" type="PyObject" overloaded="no"> | |
781d2982 | 23904 | <autodoc>GetOpenCommand(self, String filename, String mimetype=EmptyString) -> PyObject</autodoc> |
f32fc4bc RD |
23905 | <paramlist> |
23906 | <param name="filename" type="String" default=""/> | |
23907 | <param name="mimetype" type="String" default="wxPyEmptyString"/> | |
23908 | </paramlist> | |
23909 | </method> | |
23910 | <method name="GetPrintCommand" type="PyObject" overloaded="no"> | |
781d2982 | 23911 | <autodoc>GetPrintCommand(self, String filename, String mimetype=EmptyString) -> PyObject</autodoc> |
f32fc4bc RD |
23912 | <paramlist> |
23913 | <param name="filename" type="String" default=""/> | |
23914 | <param name="mimetype" type="String" default="wxPyEmptyString"/> | |
23915 | </paramlist> | |
23916 | </method> | |
23917 | <method name="GetAllCommands" type="PyObject" overloaded="no"> | |
781d2982 | 23918 | <autodoc>GetAllCommands(self, String filename, String mimetype=EmptyString) -> PyObject</autodoc> |
f32fc4bc RD |
23919 | <paramlist> |
23920 | <param name="filename" type="String" default=""/> | |
23921 | <param name="mimetype" type="String" default="wxPyEmptyString"/> | |
23922 | </paramlist> | |
23923 | </method> | |
23924 | <method name="SetCommand" type="bool" overloaded="no"> | |
781d2982 | 23925 | <autodoc>SetCommand(self, String cmd, String verb, bool overwriteprompt=True) -> bool</autodoc> |
f32fc4bc RD |
23926 | <paramlist> |
23927 | <param name="cmd" type="String" default=""/> | |
23928 | <param name="verb" type="String" default=""/> | |
23929 | <param name="overwriteprompt" type="bool" default="True"/> | |
23930 | </paramlist> | |
23931 | </method> | |
23932 | <method name="SetDefaultIcon" type="bool" overloaded="no"> | |
781d2982 | 23933 | <autodoc>SetDefaultIcon(self, String cmd=EmptyString, int index=0) -> bool</autodoc> |
f32fc4bc RD |
23934 | <paramlist> |
23935 | <param name="cmd" type="String" default="wxPyEmptyString"/> | |
23936 | <param name="index" type="int" default="0"/> | |
23937 | </paramlist> | |
23938 | </method> | |
23939 | <method name="Unassociate" type="bool" overloaded="no"> | |
781d2982 | 23940 | <autodoc>Unassociate(self) -> bool</autodoc> |
f32fc4bc RD |
23941 | </method> |
23942 | <staticmethod name="ExpandCommand" type="String" overloaded="no"> | |
23943 | <autodoc>ExpandCommand(String command, String filename, String mimetype=EmptyString) -> String</autodoc> | |
23944 | <paramlist> | |
23945 | <param name="command" type="String" default=""/> | |
23946 | <param name="filename" type="String" default=""/> | |
23947 | <param name="mimetype" type="String" default="wxPyEmptyString"/> | |
23948 | </paramlist> | |
23949 | </staticmethod> | |
23950 | </class> | |
781d2982 | 23951 | <class name="MimeTypesManager" oldname="wxMimeTypesManager" module="_misc"> |
f32fc4bc | 23952 | <constructor name="MimeTypesManager" overloaded="no"> |
781d2982 | 23953 | <autodoc>__init__(self) -> MimeTypesManager</autodoc> |
f32fc4bc RD |
23954 | </constructor> |
23955 | <destructor name="~wxMimeTypesManager" overloaded="no"> | |
781d2982 | 23956 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
23957 | </destructor> |
23958 | <staticmethod name="IsOfType" type="bool" overloaded="no"> | |
23959 | <autodoc>IsOfType(String mimeType, String wildcard) -> bool</autodoc> | |
23960 | <paramlist> | |
23961 | <param name="mimeType" type="String" default=""/> | |
23962 | <param name="wildcard" type="String" default=""/> | |
23963 | </paramlist> | |
23964 | </staticmethod> | |
23965 | <method name="Initialize" type="" overloaded="no"> | |
781d2982 | 23966 | <autodoc>Initialize(self, int mailcapStyle=MAILCAP_ALL, String extraDir=EmptyString)</autodoc> |
f32fc4bc RD |
23967 | <paramlist> |
23968 | <param name="mailcapStyle" type="int" default="wxMAILCAP_ALL"/> | |
23969 | <param name="extraDir" type="String" default="wxPyEmptyString"/> | |
23970 | </paramlist> | |
23971 | </method> | |
23972 | <method name="ClearData" type="" overloaded="no"> | |
781d2982 | 23973 | <autodoc>ClearData(self)</autodoc> |
f32fc4bc RD |
23974 | </method> |
23975 | <method name="GetFileTypeFromExtension" type="FileType" overloaded="no"> | |
781d2982 | 23976 | <autodoc>GetFileTypeFromExtension(self, String ext) -> FileType</autodoc> |
f32fc4bc RD |
23977 | <paramlist> |
23978 | <param name="ext" type="String" default=""/> | |
23979 | </paramlist> | |
23980 | </method> | |
23981 | <method name="GetFileTypeFromMimeType" type="FileType" overloaded="no"> | |
781d2982 | 23982 | <autodoc>GetFileTypeFromMimeType(self, String mimeType) -> FileType</autodoc> |
f32fc4bc RD |
23983 | <paramlist> |
23984 | <param name="mimeType" type="String" default=""/> | |
23985 | </paramlist> | |
23986 | </method> | |
23987 | <method name="ReadMailcap" type="bool" overloaded="no"> | |
781d2982 | 23988 | <autodoc>ReadMailcap(self, String filename, bool fallback=False) -> bool</autodoc> |
f32fc4bc RD |
23989 | <paramlist> |
23990 | <param name="filename" type="String" default=""/> | |
23991 | <param name="fallback" type="bool" default="False"/> | |
23992 | </paramlist> | |
23993 | </method> | |
23994 | <method name="ReadMimeTypes" type="bool" overloaded="no"> | |
781d2982 | 23995 | <autodoc>ReadMimeTypes(self, String filename) -> bool</autodoc> |
f32fc4bc RD |
23996 | <paramlist> |
23997 | <param name="filename" type="String" default=""/> | |
23998 | </paramlist> | |
23999 | </method> | |
24000 | <method name="EnumAllFileTypes" type="PyObject" overloaded="no"> | |
781d2982 | 24001 | <autodoc>EnumAllFileTypes(self) -> PyObject</autodoc> |
f32fc4bc RD |
24002 | </method> |
24003 | <method name="AddFallback" type="" overloaded="no"> | |
781d2982 | 24004 | <autodoc>AddFallback(self, FileTypeInfo ft)</autodoc> |
f32fc4bc RD |
24005 | <paramlist> |
24006 | <param name="ft" type="FileTypeInfo" default=""/> | |
24007 | </paramlist> | |
24008 | </method> | |
24009 | <method name="Associate" type="FileType" overloaded="no"> | |
781d2982 | 24010 | <autodoc>Associate(self, FileTypeInfo ftInfo) -> FileType</autodoc> |
f32fc4bc RD |
24011 | <paramlist> |
24012 | <param name="ftInfo" type="FileTypeInfo" default=""/> | |
24013 | </paramlist> | |
24014 | </method> | |
24015 | <method name="Unassociate" type="bool" overloaded="no"> | |
781d2982 | 24016 | <autodoc>Unassociate(self, FileType ft) -> bool</autodoc> |
f32fc4bc RD |
24017 | <paramlist> |
24018 | <param name="ft" type="FileType" default=""/> | |
24019 | </paramlist> | |
24020 | </method> | |
24021 | </class> | |
24022 | <pythoncode> | |
24023 | #--------------------------------------------------------------------------- | |
24024 | </pythoncode> | |
781d2982 RD |
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:: | |
24034 | ||
24035 | class MyArtProvider(wx.ArtProvider): | |
24036 | def __init__(self): | |
24037 | wx.ArtProvider.__init__(self) | |
24038 | ||
24039 | def CreateBitmap(self, artid, client, size): | |
24040 | ... | |
24041 | return bmp | |
ce6878e6 RD |
24042 | |
24043 | ||
24044 | Identifying art resources | |
24045 | ------------------------- | |
24046 | ||
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 | |
24049 | predefined values: | |
24050 | ||
24051 | * wx.ART_ADD_BOOKMARK | |
24052 | * wx.ART_DEL_BOOKMARK | |
24053 | * wx.ART_HELP_SIDE_PANEL | |
24054 | * wx.ART_HELP_SETTINGS | |
24055 | * wx.ART_HELP_BOOK | |
24056 | * wx.ART_HELP_FOLDER | |
24057 | * wx.ART_HELP_PAGE | |
24058 | * wx.ART_GO_BACK | |
24059 | * wx.ART_GO_FORWARD | |
24060 | * wx.ART_GO_UP | |
24061 | * wx.ART_GO_DOWN | |
24062 | * wx.ART_GO_TO_PARENT | |
24063 | * wx.ART_GO_HOME | |
24064 | * wx.ART_FILE_OPEN | |
24065 | * wx.ART_PRINT | |
24066 | * wx.ART_HELP | |
24067 | * wx.ART_TIP | |
24068 | * wx.ART_REPORT_VIEW | |
24069 | * wx.ART_LIST_VIEW | |
24070 | * wx.ART_NEW_DIR | |
24071 | * wx.ART_FOLDER | |
24072 | * wx.ART_GO_DIR_UP | |
24073 | * wx.ART_EXECUTABLE_FILE | |
24074 | * wx.ART_NORMAL_FILE | |
24075 | * wx.ART_TICK_MARK | |
24076 | * wx.ART_CROSS_MARK | |
24077 | * wx.ART_ERROR | |
24078 | * wx.ART_QUESTION | |
24079 | * wx.ART_WARNING | |
24080 | * wx.ART_INFORMATION | |
24081 | * wx.ART_MISSING_IMAGE | |
24082 | ||
24083 | ||
24084 | Clients | |
24085 | ------- | |
24086 | ||
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! | |
24095 | ||
24096 | * wx.ART_TOOLBAR | |
24097 | * wx.ART_MENU | |
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) | |
781d2982 | 24104 | </docstring> |
f32fc4bc | 24105 | <constructor name="wxPyArtProvider" overloaded="no"> |
781d2982 RD |
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:: | |
24115 | ||
24116 | class MyArtProvider(wx.ArtProvider): | |
24117 | def __init__(self): | |
24118 | wx.ArtProvider.__init__(self) | |
24119 | ||
24120 | def CreateBitmap(self, artid, client, size): | |
24121 | ... | |
24122 | return bmp | |
ce6878e6 RD |
24123 | |
24124 | ||
24125 | Identifying art resources | |
24126 | ------------------------- | |
24127 | ||
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 | |
24130 | predefined values: | |
24131 | ||
24132 | * wx.ART_ADD_BOOKMARK | |
24133 | * wx.ART_DEL_BOOKMARK | |
24134 | * wx.ART_HELP_SIDE_PANEL | |
24135 | * wx.ART_HELP_SETTINGS | |
24136 | * wx.ART_HELP_BOOK | |
24137 | * wx.ART_HELP_FOLDER | |
24138 | * wx.ART_HELP_PAGE | |
24139 | * wx.ART_GO_BACK | |
24140 | * wx.ART_GO_FORWARD | |
24141 | * wx.ART_GO_UP | |
24142 | * wx.ART_GO_DOWN | |
24143 | * wx.ART_GO_TO_PARENT | |
24144 | * wx.ART_GO_HOME | |
24145 | * wx.ART_FILE_OPEN | |
24146 | * wx.ART_PRINT | |
24147 | * wx.ART_HELP | |
24148 | * wx.ART_TIP | |
24149 | * wx.ART_REPORT_VIEW | |
24150 | * wx.ART_LIST_VIEW | |
24151 | * wx.ART_NEW_DIR | |
24152 | * wx.ART_FOLDER | |
24153 | * wx.ART_GO_DIR_UP | |
24154 | * wx.ART_EXECUTABLE_FILE | |
24155 | * wx.ART_NORMAL_FILE | |
24156 | * wx.ART_TICK_MARK | |
24157 | * wx.ART_CROSS_MARK | |
24158 | * wx.ART_ERROR | |
24159 | * wx.ART_QUESTION | |
24160 | * wx.ART_WARNING | |
24161 | * wx.ART_INFORMATION | |
24162 | * wx.ART_MISSING_IMAGE | |
24163 | ||
24164 | ||
24165 | Clients | |
24166 | ------- | |
24167 | ||
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! | |
24176 | ||
24177 | * wx.ART_TOOLBAR | |
24178 | * wx.ART_MENU | |
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) | |
781d2982 | 24185 | </docstring> |
f32fc4bc RD |
24186 | </constructor> |
24187 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 24188 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
24189 | <paramlist> |
24190 | <param name="self" type="PyObject" default=""/> | |
24191 | <param name="_class" type="PyObject" default=""/> | |
24192 | </paramlist> | |
24193 | </method> | |
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> | |
24197 | <paramlist> | |
24198 | <param name="provider" type="ArtProvider" default=""/> | |
24199 | </paramlist> | |
24200 | </staticmethod> | |
24201 | <staticmethod name="PopProvider" type="bool" overloaded="no"> | |
24202 | <autodoc>PopProvider() -> bool</autodoc> | |
24203 | <docstring>Remove latest added provider and delete it.</docstring> | |
24204 | </staticmethod> | |
24205 | <staticmethod name="RemoveProvider" type="bool" overloaded="no"> | |
24206 | <autodoc>RemoveProvider(ArtProvider provider) -> bool</autodoc> | |
781d2982 RD |
24207 | <docstring>Remove provider. The provider must have been added previously! The |
24208 | provider is _not_ deleted.</docstring> | |
f32fc4bc RD |
24209 | <paramlist> |
24210 | <param name="provider" type="ArtProvider" default=""/> | |
24211 | </paramlist> | |
24212 | </staticmethod> | |
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> | |
24217 | <paramlist> | |
24218 | <param name="id" type="String" default=""/> | |
24219 | <param name="client" type="String" default="wxPyART_OTHER"/> | |
24220 | <param name="size" type="Size" default="wxDefaultSize"/> | |
24221 | </paramlist> | |
24222 | </staticmethod> | |
24223 | <staticmethod name="GetIcon" type="Icon" overloaded="no"> | |
24224 | <autodoc>GetIcon(String id, String client=ART_OTHER, Size size=DefaultSize) -> Icon</autodoc> | |
781d2982 | 24225 | <docstring>Query the providers for icon with given ID and return it. Return |
f32fc4bc RD |
24226 | wx.NullIcon if no provider provides it.</docstring> |
24227 | <paramlist> | |
24228 | <param name="id" type="String" default=""/> | |
24229 | <param name="client" type="String" default="wxPyART_OTHER"/> | |
24230 | <param name="size" type="Size" default="wxDefaultSize"/> | |
24231 | </paramlist> | |
24232 | </staticmethod> | |
24233 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 24234 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
24235 | </method> |
24236 | </class> | |
24237 | <pythoncode> | |
24238 | #--------------------------------------------------------------------------- | |
24239 | </pythoncode> | |
781d2982 | 24240 | <class name="ConfigBase" oldname="wxConfigBase" module="_misc"> |
c2dda882 | 24241 | <docstring>wx.ConfigBase class defines the basic interface of all config |
781d2982 RD |
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 | |
24244 | wx.FileConfig. | |
24245 | ||
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. | |
b39e211b RD |
24253 | |
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 | |
781d2982 RD |
24256 | without first encoding it as a string. For performance reasons items |
24257 | should be kept small, no more than a couple kilobytes. | |
c2dda882 | 24258 | </docstring> |
f32fc4bc | 24259 | <destructor name="~wxConfigBase" overloaded="no"> |
781d2982 | 24260 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
24261 | </destructor> |
24262 | <staticmethod name="Set" type="ConfigBase" overloaded="no"> | |
c2dda882 | 24263 | <autodoc>Set(ConfigBase config) -> ConfigBase</autodoc> |
781d2982 RD |
24264 | <docstring>Sets the global config object (the one returned by Get) and returns a |
24265 | reference to the previous global config object.</docstring> | |
f32fc4bc | 24266 | <paramlist> |
c2dda882 | 24267 | <param name="config" type="ConfigBase" default=""/> |
f32fc4bc RD |
24268 | </paramlist> |
24269 | </staticmethod> | |
24270 | <staticmethod name="Get" type="ConfigBase" overloaded="no"> | |
24271 | <autodoc>Get(bool createOnDemand=True) -> ConfigBase</autodoc> | |
c2dda882 | 24272 | <docstring>Returns the current global config object, creating one if neccessary.</docstring> |
f32fc4bc RD |
24273 | <paramlist> |
24274 | <param name="createOnDemand" type="bool" default="True"/> | |
24275 | </paramlist> | |
24276 | </staticmethod> | |
24277 | <staticmethod name="Create" type="ConfigBase" overloaded="no"> | |
24278 | <autodoc>Create() -> ConfigBase</autodoc> | |
c2dda882 RD |
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> | |
f32fc4bc RD |
24282 | </staticmethod> |
24283 | <staticmethod name="DontCreateOnDemand" type="" overloaded="no"> | |
24284 | <autodoc>DontCreateOnDemand()</autodoc> | |
781d2982 RD |
24285 | <docstring>Should Get() try to create a new log object if there isn't a current |
24286 | one?</docstring> | |
f32fc4bc RD |
24287 | </staticmethod> |
24288 | <method name="SetPath" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc | 24293 | <paramlist> |
c2dda882 | 24294 | <param name="path" type="String" default=""/> |
f32fc4bc RD |
24295 | </paramlist> |
24296 | </method> | |
24297 | <method name="GetPath" type="String" overloaded="no"> | |
781d2982 | 24298 | <autodoc>GetPath(self) -> String</autodoc> |
c2dda882 | 24299 | <docstring>Retrieve the current path (always as absolute path)</docstring> |
f32fc4bc RD |
24300 | </method> |
24301 | <method name="GetFirstGroup" type="PyObject" overloaded="no"> | |
c2dda882 | 24302 | <autodoc>GetFirstGroup() -> (more, value, index)</autodoc> |
781d2982 RD |
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 | |
24306 | item.</docstring> | |
f32fc4bc RD |
24307 | </method> |
24308 | <method name="GetNextGroup" type="PyObject" overloaded="no"> | |
c2dda882 | 24309 | <autodoc>GetNextGroup(long index) -> (more, value, index)</autodoc> |
781d2982 RD |
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 | |
24313 | item.</docstring> | |
f32fc4bc RD |
24314 | <paramlist> |
24315 | <param name="index" type="long" default=""/> | |
24316 | </paramlist> | |
24317 | </method> | |
24318 | <method name="GetFirstEntry" type="PyObject" overloaded="no"> | |
c2dda882 RD |
24319 | <autodoc>GetFirstEntry() -> (more, value, index)</autodoc> |
24320 | <docstring>Allows enumerating the entries in the current group in a config | |
781d2982 RD |
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 | |
c2dda882 | 24323 | GetNextGroup to fetch the next item.</docstring> |
f32fc4bc RD |
24324 | </method> |
24325 | <method name="GetNextEntry" type="PyObject" overloaded="no"> | |
c2dda882 RD |
24326 | <autodoc>GetNextEntry(long index) -> (more, value, index)</autodoc> |
24327 | <docstring>Allows enumerating the entries in the current group in a config | |
781d2982 RD |
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 | |
c2dda882 | 24330 | GetNextGroup to fetch the next item.</docstring> |
f32fc4bc RD |
24331 | <paramlist> |
24332 | <param name="index" type="long" default=""/> | |
24333 | </paramlist> | |
24334 | </method> | |
24335 | <method name="GetNumberOfEntries" type="size_t" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc | 24339 | <paramlist> |
c2dda882 | 24340 | <param name="recursive" type="bool" default="False"/> |
f32fc4bc RD |
24341 | </paramlist> |
24342 | </method> | |
24343 | <method name="GetNumberOfGroups" type="size_t" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc | 24347 | <paramlist> |
c2dda882 | 24348 | <param name="recursive" type="bool" default="False"/> |
f32fc4bc RD |
24349 | </paramlist> |
24350 | </method> | |
24351 | <method name="HasGroup" type="bool" overloaded="no"> | |
781d2982 | 24352 | <autodoc>HasGroup(self, String name) -> bool</autodoc> |
c2dda882 | 24353 | <docstring>Returns True if the group by this name exists</docstring> |
f32fc4bc | 24354 | <paramlist> |
c2dda882 | 24355 | <param name="name" type="String" default=""/> |
f32fc4bc RD |
24356 | </paramlist> |
24357 | </method> | |
24358 | <method name="HasEntry" type="bool" overloaded="no"> | |
781d2982 | 24359 | <autodoc>HasEntry(self, String name) -> bool</autodoc> |
c2dda882 | 24360 | <docstring>Returns True if the entry by this name exists</docstring> |
f32fc4bc | 24361 | <paramlist> |
c2dda882 | 24362 | <param name="name" type="String" default=""/> |
f32fc4bc RD |
24363 | </paramlist> |
24364 | </method> | |
24365 | <method name="Exists" type="bool" overloaded="no"> | |
781d2982 | 24366 | <autodoc>Exists(self, String name) -> bool</autodoc> |
c2dda882 | 24367 | <docstring>Returns True if either a group or an entry with a given name exists</docstring> |
f32fc4bc | 24368 | <paramlist> |
c2dda882 | 24369 | <param name="name" type="String" default=""/> |
f32fc4bc RD |
24370 | </paramlist> |
24371 | </method> | |
24372 | <method name="GetEntryType" type="wxConfigBase::EntryType" overloaded="no"> | |
781d2982 | 24373 | <autodoc>GetEntryType(self, String name) -> int</autodoc> |
c2dda882 | 24374 | <docstring>Get the type of the entry. Returns one of the wx.Config.Type_XXX values.</docstring> |
f32fc4bc RD |
24375 | <paramlist> |
24376 | <param name="name" type="String" default=""/> | |
24377 | </paramlist> | |
24378 | </method> | |
24379 | <method name="Read" type="String" overloaded="no"> | |
781d2982 | 24380 | <autodoc>Read(self, String key, String defaultVal=EmptyString) -> String</autodoc> |
c2dda882 | 24381 | <docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring> |
f32fc4bc RD |
24382 | <paramlist> |
24383 | <param name="key" type="String" default=""/> | |
24384 | <param name="defaultVal" type="String" default="wxPyEmptyString"/> | |
24385 | </paramlist> | |
24386 | </method> | |
24387 | <method name="ReadInt" type="long" overloaded="no"> | |
781d2982 | 24388 | <autodoc>ReadInt(self, String key, long defaultVal=0) -> long</autodoc> |
c2dda882 | 24389 | <docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring> |
f32fc4bc RD |
24390 | <paramlist> |
24391 | <param name="key" type="String" default=""/> | |
24392 | <param name="defaultVal" type="long" default="0"/> | |
24393 | </paramlist> | |
24394 | </method> | |
24395 | <method name="ReadFloat" type="double" overloaded="no"> | |
781d2982 | 24396 | <autodoc>ReadFloat(self, String key, double defaultVal=0.0) -> double</autodoc> |
c2dda882 | 24397 | <docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring> |
f32fc4bc RD |
24398 | <paramlist> |
24399 | <param name="key" type="String" default=""/> | |
24400 | <param name="defaultVal" type="double" default="0.0"/> | |
24401 | </paramlist> | |
24402 | </method> | |
24403 | <method name="ReadBool" type="bool" overloaded="no"> | |
781d2982 | 24404 | <autodoc>ReadBool(self, String key, bool defaultVal=False) -> bool</autodoc> |
c2dda882 | 24405 | <docstring>Returns the value of key if it exists, defaultVal otherwise.</docstring> |
f32fc4bc RD |
24406 | <paramlist> |
24407 | <param name="key" type="String" default=""/> | |
24408 | <param name="defaultVal" type="bool" default="False"/> | |
24409 | </paramlist> | |
24410 | </method> | |
24411 | <method name="Write" type="bool" overloaded="no"> | |
781d2982 | 24412 | <autodoc>Write(self, String key, String value) -> bool</autodoc> |
c2dda882 | 24413 | <docstring>write the value (return True on success)</docstring> |
f32fc4bc RD |
24414 | <paramlist> |
24415 | <param name="key" type="String" default=""/> | |
24416 | <param name="value" type="String" default=""/> | |
24417 | </paramlist> | |
24418 | </method> | |
24419 | <method name="WriteInt" type="bool" overloaded="no"> | |
781d2982 | 24420 | <autodoc>WriteInt(self, String key, long value) -> bool</autodoc> |
c2dda882 | 24421 | <docstring>write the value (return True on success)</docstring> |
f32fc4bc RD |
24422 | <paramlist> |
24423 | <param name="key" type="String" default=""/> | |
24424 | <param name="value" type="long" default=""/> | |
24425 | </paramlist> | |
24426 | </method> | |
24427 | <method name="WriteFloat" type="bool" overloaded="no"> | |
781d2982 | 24428 | <autodoc>WriteFloat(self, String key, double value) -> bool</autodoc> |
c2dda882 | 24429 | <docstring>write the value (return True on success)</docstring> |
f32fc4bc RD |
24430 | <paramlist> |
24431 | <param name="key" type="String" default=""/> | |
24432 | <param name="value" type="double" default=""/> | |
24433 | </paramlist> | |
24434 | </method> | |
24435 | <method name="WriteBool" type="bool" overloaded="no"> | |
781d2982 | 24436 | <autodoc>WriteBool(self, String key, bool value) -> bool</autodoc> |
c2dda882 | 24437 | <docstring>write the value (return True on success)</docstring> |
f32fc4bc RD |
24438 | <paramlist> |
24439 | <param name="key" type="String" default=""/> | |
24440 | <param name="value" type="bool" default=""/> | |
24441 | </paramlist> | |
24442 | </method> | |
24443 | <method name="Flush" type="bool" overloaded="no"> | |
781d2982 | 24444 | <autodoc>Flush(self, bool currentOnly=False) -> bool</autodoc> |
c2dda882 | 24445 | <docstring>permanently writes all changes</docstring> |
f32fc4bc | 24446 | <paramlist> |
c2dda882 | 24447 | <param name="currentOnly" type="bool" default="False"/> |
f32fc4bc RD |
24448 | </paramlist> |
24449 | </method> | |
24450 | <method name="RenameEntry" type="bool" overloaded="no"> | |
781d2982 | 24451 | <autodoc>RenameEntry(self, String oldName, String newName) -> bool</autodoc> |
c2dda882 RD |
24452 | <docstring>Rename an entry. Returns False on failure (probably because the new |
24453 | name is already taken by an existing entry)</docstring> | |
f32fc4bc RD |
24454 | <paramlist> |
24455 | <param name="oldName" type="String" default=""/> | |
24456 | <param name="newName" type="String" default=""/> | |
24457 | </paramlist> | |
24458 | </method> | |
24459 | <method name="RenameGroup" type="bool" overloaded="no"> | |
781d2982 RD |
24460 | <autodoc>RenameGroup(self, String oldName, String newName) -> bool</autodoc> |
24461 | <docstring>Rename a group. Returns False on failure (probably because the new | |
c2dda882 | 24462 | name is already taken by an existing entry)</docstring> |
f32fc4bc RD |
24463 | <paramlist> |
24464 | <param name="oldName" type="String" default=""/> | |
24465 | <param name="newName" type="String" default=""/> | |
24466 | </paramlist> | |
24467 | </method> | |
24468 | <method name="DeleteEntry" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
24472 | <paramlist> |
24473 | <param name="key" type="String" default=""/> | |
c2dda882 | 24474 | <param name="deleteGroupIfEmpty" type="bool" default="True"/> |
f32fc4bc RD |
24475 | </paramlist> |
24476 | </method> | |
24477 | <method name="DeleteGroup" type="bool" overloaded="no"> | |
781d2982 | 24478 | <autodoc>DeleteGroup(self, String key) -> bool</autodoc> |
c2dda882 | 24479 | <docstring>Delete the group (with all subgroups)</docstring> |
f32fc4bc RD |
24480 | <paramlist> |
24481 | <param name="key" type="String" default=""/> | |
24482 | </paramlist> | |
24483 | </method> | |
24484 | <method name="DeleteAll" type="bool" overloaded="no"> | |
781d2982 | 24485 | <autodoc>DeleteAll(self) -> bool</autodoc> |
c2dda882 | 24486 | <docstring>Delete the whole underlying object (disk file, registry key, ...) |
781d2982 | 24487 | primarly intended for use by deinstallation routine.</docstring> |
f32fc4bc RD |
24488 | </method> |
24489 | <method name="SetExpandEnvVars" type="" overloaded="no"> | |
781d2982 RD |
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 | |
24493 | time)</docstring> | |
f32fc4bc | 24494 | <paramlist> |
c2dda882 | 24495 | <param name="doIt" type="bool" default="True"/> |
f32fc4bc RD |
24496 | </paramlist> |
24497 | </method> | |
c2dda882 | 24498 | <method name="IsExpandingEnvVars" type="bool" overloaded="no"> |
781d2982 | 24499 | <autodoc>IsExpandingEnvVars(self) -> bool</autodoc> |
c2dda882 RD |
24500 | <docstring>Are we currently expanding environment variables?</docstring> |
24501 | </method> | |
f32fc4bc | 24502 | <method name="SetRecordDefaults" type="" overloaded="no"> |
781d2982 | 24503 | <autodoc>SetRecordDefaults(self, bool doIt=True)</autodoc> |
c2dda882 | 24504 | <docstring>Set whether the config objec should record default values.</docstring> |
f32fc4bc | 24505 | <paramlist> |
c2dda882 | 24506 | <param name="doIt" type="bool" default="True"/> |
f32fc4bc RD |
24507 | </paramlist> |
24508 | </method> | |
24509 | <method name="IsRecordingDefaults" type="bool" overloaded="no"> | |
781d2982 | 24510 | <autodoc>IsRecordingDefaults(self) -> bool</autodoc> |
c2dda882 | 24511 | <docstring>Are we currently recording default values?</docstring> |
f32fc4bc RD |
24512 | </method> |
24513 | <method name="ExpandEnvVars" type="String" overloaded="no"> | |
781d2982 | 24514 | <autodoc>ExpandEnvVars(self, String str) -> String</autodoc> |
c2dda882 | 24515 | <docstring>Expand any environment variables in str and return the result</docstring> |
f32fc4bc RD |
24516 | <paramlist> |
24517 | <param name="str" type="String" default=""/> | |
24518 | </paramlist> | |
24519 | </method> | |
24520 | <method name="GetAppName" type="String" overloaded="no"> | |
781d2982 | 24521 | <autodoc>GetAppName(self) -> String</autodoc> |
f32fc4bc RD |
24522 | </method> |
24523 | <method name="GetVendorName" type="String" overloaded="no"> | |
781d2982 | 24524 | <autodoc>GetVendorName(self) -> String</autodoc> |
f32fc4bc RD |
24525 | </method> |
24526 | <method name="SetAppName" type="" overloaded="no"> | |
781d2982 | 24527 | <autodoc>SetAppName(self, String appName)</autodoc> |
f32fc4bc RD |
24528 | <paramlist> |
24529 | <param name="appName" type="String" default=""/> | |
24530 | </paramlist> | |
24531 | </method> | |
24532 | <method name="SetVendorName" type="" overloaded="no"> | |
781d2982 | 24533 | <autodoc>SetVendorName(self, String vendorName)</autodoc> |
f32fc4bc RD |
24534 | <paramlist> |
24535 | <param name="vendorName" type="String" default=""/> | |
24536 | </paramlist> | |
24537 | </method> | |
24538 | <method name="SetStyle" type="" overloaded="no"> | |
781d2982 | 24539 | <autodoc>SetStyle(self, long style)</autodoc> |
f32fc4bc RD |
24540 | <paramlist> |
24541 | <param name="style" type="long" default=""/> | |
24542 | </paramlist> | |
24543 | </method> | |
24544 | <method name="GetStyle" type="long" overloaded="no"> | |
781d2982 | 24545 | <autodoc>GetStyle(self) -> long</autodoc> |
f32fc4bc RD |
24546 | </method> |
24547 | </class> | |
781d2982 | 24548 | <class name="Config" oldname="wxConfig" module="_misc"> |
c2dda882 RD |
24549 | <docstring>This ConfigBase-derived class will use the registry on Windows, |
24550 | and will be a wx.FileConfig on other platforms.</docstring> | |
f32fc4bc RD |
24551 | <baseclass name="ConfigBase"/> |
24552 | <constructor name="Config" overloaded="no"> | |
781d2982 | 24553 | <autodoc>__init__(self, String appName=EmptyString, String vendorName=EmptyString, |
f32fc4bc | 24554 | String localFilename=EmptyString, String globalFilename=EmptyString, |
368d20e8 | 24555 | long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> Config</autodoc> |
f32fc4bc RD |
24556 | <paramlist> |
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"/> | |
368d20e8 | 24561 | <param name="style" type="long" default="wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE"/> |
f32fc4bc RD |
24562 | </paramlist> |
24563 | </constructor> | |
24564 | <destructor name="~wxConfig" overloaded="no"> | |
781d2982 | 24565 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
24566 | </destructor> |
24567 | </class> | |
781d2982 | 24568 | <class name="FileConfig" oldname="wxFileConfig" module="_misc"> |
c2dda882 | 24569 | <docstring>This config class will use a file for storage on all platforms.</docstring> |
f32fc4bc RD |
24570 | <baseclass name="ConfigBase"/> |
24571 | <constructor name="FileConfig" overloaded="no"> | |
781d2982 | 24572 | <autodoc>__init__(self, String appName=EmptyString, String vendorName=EmptyString, |
f32fc4bc | 24573 | String localFilename=EmptyString, String globalFilename=EmptyString, |
b39e211b | 24574 | long style=wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE) -> FileConfig</autodoc> |
f32fc4bc RD |
24575 | <paramlist> |
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"/> | |
b39e211b | 24580 | <param name="style" type="long" default="wxCONFIG_USE_LOCAL_FILE|wxCONFIG_USE_GLOBAL_FILE"/> |
f32fc4bc RD |
24581 | </paramlist> |
24582 | </constructor> | |
24583 | <destructor name="~wxFileConfig" overloaded="no"> | |
781d2982 | 24584 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
24585 | </destructor> |
24586 | </class> | |
781d2982 RD |
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> | |
c2dda882 | 24592 | <constructor name="ConfigPathChanger" overloaded="no"> |
781d2982 | 24593 | <autodoc>__init__(self, ConfigBase config, String entry) -> ConfigPathChanger</autodoc> |
c2dda882 RD |
24594 | <paramlist> |
24595 | <param name="config" type="ConfigBase" default=""/> | |
24596 | <param name="entry" type="String" default=""/> | |
24597 | </paramlist> | |
24598 | </constructor> | |
24599 | <destructor name="~wxConfigPathChanger" overloaded="no"> | |
781d2982 | 24600 | <autodoc>__del__(self)</autodoc> |
c2dda882 RD |
24601 | </destructor> |
24602 | <method name="Name" type="String" overloaded="no"> | |
781d2982 | 24603 | <autodoc>Name(self) -> String</autodoc> |
c2dda882 RD |
24604 | <docstring>Get the key name</docstring> |
24605 | </method> | |
24606 | </class> | |
f32fc4bc RD |
24607 | <method name="ExpandEnvVars" oldname="wxExpandEnvVars" type="String" overloaded="no"> |
24608 | <autodoc>ExpandEnvVars(String sz) -> String</autodoc> | |
c2dda882 | 24609 | <docstring>Replace environment variables ($SOMETHING) with their values. The |
781d2982 RD |
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> | |
f32fc4bc RD |
24613 | <paramlist> |
24614 | <param name="sz" type="String" default=""/> | |
856bf319 RD |
24615 | </paramlist> |
24616 | </method> | |
f32fc4bc RD |
24617 | <pythoncode> |
24618 | #--------------------------------------------------------------------------- | |
24619 | </pythoncode> | |
781d2982 | 24620 | <class name="DateTime" oldname="wxDateTime" module="_misc"> |
f32fc4bc | 24621 | <constructor name="DateTime" overloaded="no"> |
781d2982 | 24622 | <autodoc>__init__(self) -> DateTime</autodoc> |
f32fc4bc RD |
24623 | </constructor> |
24624 | <constructor name="DateTimeFromTimeT" overloaded="no"> | |
24625 | <autodoc>DateTimeFromTimeT(time_t timet) -> DateTime</autodoc> | |
24626 | <paramlist> | |
24627 | <param name="timet" type="time_t" default=""/> | |
24628 | </paramlist> | |
24629 | </constructor> | |
24630 | <constructor name="DateTimeFromJDN" overloaded="no"> | |
24631 | <autodoc>DateTimeFromJDN(double jdn) -> DateTime</autodoc> | |
24632 | <paramlist> | |
24633 | <param name="jdn" type="double" default=""/> | |
24634 | </paramlist> | |
24635 | </constructor> | |
24636 | <constructor name="DateTimeFromHMS" overloaded="no"> | |
24637 | <autodoc>DateTimeFromHMS(int hour, int minute=0, int second=0, int millisec=0) -> DateTime</autodoc> | |
24638 | <paramlist> | |
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"/> | |
24643 | </paramlist> | |
24644 | </constructor> | |
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> | |
24648 | <paramlist> | |
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"/> | |
24656 | </paramlist> | |
24657 | </constructor> | |
24658 | <destructor name="~wxDateTime" overloaded="no"> | |
781d2982 | 24659 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
24660 | </destructor> |
24661 | <staticmethod name="SetCountry" type="" overloaded="no"> | |
24662 | <autodoc>SetCountry(int country)</autodoc> | |
24663 | <paramlist> | |
24664 | <param name="country" type="wxDateTime::Country" default=""/> | |
24665 | </paramlist> | |
24666 | </staticmethod> | |
24667 | <staticmethod name="GetCountry" type="wxDateTime::Country" overloaded="no"> | |
24668 | <autodoc>GetCountry() -> int</autodoc> | |
24669 | </staticmethod> | |
24670 | <staticmethod name="IsWestEuropeanCountry" type="bool" overloaded="no"> | |
24671 | <autodoc>IsWestEuropeanCountry(int country=Country_Default) -> bool</autodoc> | |
24672 | <paramlist> | |
24673 | <param name="country" type="wxDateTime::Country" default="wxDateTime::Country_Default"/> | |
24674 | </paramlist> | |
24675 | </staticmethod> | |
24676 | <staticmethod name="GetCurrentYear" type="int" overloaded="no"> | |
24677 | <autodoc>GetCurrentYear(int cal=Gregorian) -> int</autodoc> | |
24678 | <paramlist> | |
24679 | <param name="cal" type="wxDateTime::Calendar" default="wxDateTime::Gregorian"/> | |
24680 | </paramlist> | |
24681 | </staticmethod> | |
24682 | <staticmethod name="ConvertYearToBC" type="int" overloaded="no"> | |
24683 | <autodoc>ConvertYearToBC(int year) -> int</autodoc> | |
24684 | <paramlist> | |
24685 | <param name="year" type="int" default=""/> | |
24686 | </paramlist> | |
24687 | </staticmethod> | |
24688 | <staticmethod name="GetCurrentMonth" type="wxDateTime::Month" overloaded="no"> | |
24689 | <autodoc>GetCurrentMonth(int cal=Gregorian) -> int</autodoc> | |
24690 | <paramlist> | |
24691 | <param name="cal" type="wxDateTime::Calendar" default="wxDateTime::Gregorian"/> | |
24692 | </paramlist> | |
24693 | </staticmethod> | |
24694 | <staticmethod name="IsLeapYear" type="bool" overloaded="no"> | |
24695 | <autodoc>IsLeapYear(int year=Inv_Year, int cal=Gregorian) -> bool</autodoc> | |
24696 | <paramlist> | |
24697 | <param name="year" type="int" default="wxDateTime::Inv_Year"/> | |
24698 | <param name="cal" type="wxDateTime::Calendar" default="wxDateTime::Gregorian"/> | |
24699 | </paramlist> | |
24700 | </staticmethod> | |
24701 | <staticmethod name="GetCentury" type="int" overloaded="no"> | |
24702 | <autodoc>GetCentury(int year=Inv_Year) -> int</autodoc> | |
24703 | <paramlist> | |
24704 | <param name="year" type="int" default="wxDateTime::Inv_Year"/> | |
24705 | </paramlist> | |
24706 | </staticmethod> | |
24707 | <staticmethod name="GetNumberOfDaysinYear" type="int" overloaded="no"> | |
24708 | <autodoc>GetNumberOfDaysinYear(int year, int cal=Gregorian) -> int</autodoc> | |
24709 | <paramlist> | |
24710 | <param name="year" type="int" default=""/> | |
24711 | <param name="cal" type="wxDateTime::Calendar" default="wxDateTime::Gregorian"/> | |
24712 | </paramlist> | |
24713 | </staticmethod> | |
24714 | <staticmethod name="GetNumberOfDaysInMonth" type="int" overloaded="no"> | |
24715 | <autodoc>GetNumberOfDaysInMonth(int month, int year=Inv_Year, int cal=Gregorian) -> int</autodoc> | |
24716 | <paramlist> | |
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"/> | |
24720 | </paramlist> | |
24721 | </staticmethod> | |
24722 | <staticmethod name="GetMonthName" type="String" overloaded="no"> | |
24723 | <autodoc>GetMonthName(int month, int flags=Name_Full) -> String</autodoc> | |
24724 | <paramlist> | |
24725 | <param name="month" type="wxDateTime::Month" default=""/> | |
24726 | <param name="flags" type="wxDateTime::NameFlags" default="wxDateTime::Name_Full"/> | |
24727 | </paramlist> | |
24728 | </staticmethod> | |
24729 | <staticmethod name="GetWeekDayName" type="String" overloaded="no"> | |
24730 | <autodoc>GetWeekDayName(int weekday, int flags=Name_Full) -> String</autodoc> | |
24731 | <paramlist> | |
24732 | <param name="weekday" type="wxDateTime::WeekDay" default=""/> | |
24733 | <param name="flags" type="wxDateTime::NameFlags" default="wxDateTime::Name_Full"/> | |
24734 | </paramlist> | |
24735 | </staticmethod> | |
24736 | <staticmethod name="GetAmPmStrings" type="" overloaded="no"> | |
24737 | <autodoc>GetAmPmStrings() -> (am, pm)</autodoc> | |
ce6878e6 | 24738 | <docstring>Get the AM and PM strings in the current locale (may be empty)</docstring> |
f32fc4bc RD |
24739 | <paramlist> |
24740 | <param name="OUTPUT" type="String" default=""/> | |
24741 | <param name="OUTPUT" type="String" default=""/> | |
24742 | </paramlist> | |
24743 | </staticmethod> | |
24744 | <staticmethod name="IsDSTApplicable" type="bool" overloaded="no"> | |
24745 | <autodoc>IsDSTApplicable(int year=Inv_Year, int country=Country_Default) -> bool</autodoc> | |
24746 | <paramlist> | |
24747 | <param name="year" type="int" default="wxDateTime::Inv_Year"/> | |
24748 | <param name="country" type="wxDateTime::Country" default="wxDateTime::Country_Default"/> | |
24749 | </paramlist> | |
24750 | </staticmethod> | |
24751 | <staticmethod name="GetBeginDST" type="DateTime" overloaded="no"> | |
24752 | <autodoc>GetBeginDST(int year=Inv_Year, int country=Country_Default) -> DateTime</autodoc> | |
24753 | <paramlist> | |
24754 | <param name="year" type="int" default="wxDateTime::Inv_Year"/> | |
24755 | <param name="country" type="wxDateTime::Country" default="wxDateTime::Country_Default"/> | |
24756 | </paramlist> | |
24757 | </staticmethod> | |
24758 | <staticmethod name="GetEndDST" type="DateTime" overloaded="no"> | |
24759 | <autodoc>GetEndDST(int year=Inv_Year, int country=Country_Default) -> DateTime</autodoc> | |
24760 | <paramlist> | |
24761 | <param name="year" type="int" default="wxDateTime::Inv_Year"/> | |
24762 | <param name="country" type="wxDateTime::Country" default="wxDateTime::Country_Default"/> | |
24763 | </paramlist> | |
24764 | </staticmethod> | |
24765 | <staticmethod name="Now" type="DateTime" overloaded="no"> | |
24766 | <autodoc>Now() -> DateTime</autodoc> | |
24767 | </staticmethod> | |
24768 | <staticmethod name="UNow" type="DateTime" overloaded="no"> | |
24769 | <autodoc>UNow() -> DateTime</autodoc> | |
24770 | </staticmethod> | |
24771 | <staticmethod name="Today" type="DateTime" overloaded="no"> | |
24772 | <autodoc>Today() -> DateTime</autodoc> | |
24773 | </staticmethod> | |
24774 | <method name="SetToCurrent" type="DateTime" overloaded="no"> | |
781d2982 | 24775 | <autodoc>SetToCurrent(self) -> DateTime</autodoc> |
f32fc4bc RD |
24776 | </method> |
24777 | <method name="SetTimeT" type="DateTime" overloaded="no"> | |
781d2982 | 24778 | <autodoc>SetTimeT(self, time_t timet) -> DateTime</autodoc> |
f32fc4bc RD |
24779 | <paramlist> |
24780 | <param name="timet" type="time_t" default=""/> | |
24781 | </paramlist> | |
24782 | </method> | |
24783 | <method name="SetJDN" type="DateTime" overloaded="no"> | |
781d2982 | 24784 | <autodoc>SetJDN(self, double jdn) -> DateTime</autodoc> |
f32fc4bc RD |
24785 | <paramlist> |
24786 | <param name="jdn" type="double" default=""/> | |
24787 | </paramlist> | |
24788 | </method> | |
24789 | <method name="SetHMS" type="DateTime" overloaded="no"> | |
781d2982 | 24790 | <autodoc>SetHMS(self, int hour, int minute=0, int second=0, int millisec=0) -> DateTime</autodoc> |
f32fc4bc RD |
24791 | <paramlist> |
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"/> | |
24796 | </paramlist> | |
24797 | </method> | |
24798 | <method name="Set" type="DateTime" overloaded="no"> | |
781d2982 | 24799 | <autodoc>Set(self, int day, int month=Inv_Month, int year=Inv_Year, int hour=0, |
f32fc4bc RD |
24800 | int minute=0, int second=0, int millisec=0) -> DateTime</autodoc> |
24801 | <paramlist> | |
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"/> | |
24809 | </paramlist> | |
24810 | </method> | |
24811 | <method name="ResetTime" type="DateTime" overloaded="no"> | |
781d2982 | 24812 | <autodoc>ResetTime(self) -> DateTime</autodoc> |
f32fc4bc RD |
24813 | </method> |
24814 | <method name="SetYear" type="DateTime" overloaded="no"> | |
781d2982 | 24815 | <autodoc>SetYear(self, int year) -> DateTime</autodoc> |
f32fc4bc RD |
24816 | <paramlist> |
24817 | <param name="year" type="int" default=""/> | |
24818 | </paramlist> | |
24819 | </method> | |
24820 | <method name="SetMonth" type="DateTime" overloaded="no"> | |
781d2982 | 24821 | <autodoc>SetMonth(self, int month) -> DateTime</autodoc> |
f32fc4bc RD |
24822 | <paramlist> |
24823 | <param name="month" type="wxDateTime::Month" default=""/> | |
24824 | </paramlist> | |
24825 | </method> | |
24826 | <method name="SetDay" type="DateTime" overloaded="no"> | |
781d2982 | 24827 | <autodoc>SetDay(self, int day) -> DateTime</autodoc> |
f32fc4bc RD |
24828 | <paramlist> |
24829 | <param name="day" type="int" default=""/> | |
24830 | </paramlist> | |
24831 | </method> | |
24832 | <method name="SetHour" type="DateTime" overloaded="no"> | |
781d2982 | 24833 | <autodoc>SetHour(self, int hour) -> DateTime</autodoc> |
f32fc4bc RD |
24834 | <paramlist> |
24835 | <param name="hour" type="int" default=""/> | |
24836 | </paramlist> | |
24837 | </method> | |
24838 | <method name="SetMinute" type="DateTime" overloaded="no"> | |
781d2982 | 24839 | <autodoc>SetMinute(self, int minute) -> DateTime</autodoc> |
f32fc4bc RD |
24840 | <paramlist> |
24841 | <param name="minute" type="int" default=""/> | |
24842 | </paramlist> | |
24843 | </method> | |
24844 | <method name="SetSecond" type="DateTime" overloaded="no"> | |
781d2982 | 24845 | <autodoc>SetSecond(self, int second) -> DateTime</autodoc> |
f32fc4bc RD |
24846 | <paramlist> |
24847 | <param name="second" type="int" default=""/> | |
24848 | </paramlist> | |
24849 | </method> | |
24850 | <method name="SetMillisecond" type="DateTime" overloaded="no"> | |
781d2982 | 24851 | <autodoc>SetMillisecond(self, int millisecond) -> DateTime</autodoc> |
f32fc4bc RD |
24852 | <paramlist> |
24853 | <param name="millisecond" type="int" default=""/> | |
24854 | </paramlist> | |
24855 | </method> | |
24856 | <method name="SetToWeekDayInSameWeek" type="DateTime" overloaded="no"> | |
781d2982 | 24857 | <autodoc>SetToWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime</autodoc> |
f32fc4bc RD |
24858 | <paramlist> |
24859 | <param name="weekday" type="wxDateTime::WeekDay" default=""/> | |
24860 | <param name="flags" type="wxDateTime::WeekFlags" default="wxDateTime::Monday_First"/> | |
24861 | </paramlist> | |
24862 | </method> | |
24863 | <method name="GetWeekDayInSameWeek" type="DateTime" overloaded="no"> | |
781d2982 | 24864 | <autodoc>GetWeekDayInSameWeek(self, int weekday, int flags=Monday_First) -> DateTime</autodoc> |
f32fc4bc RD |
24865 | <paramlist> |
24866 | <param name="weekday" type="wxDateTime::WeekDay" default=""/> | |
24867 | <param name="flags" type="wxDateTime::WeekFlags" default="wxDateTime::Monday_First"/> | |
24868 | </paramlist> | |
24869 | </method> | |
24870 | <method name="SetToNextWeekDay" type="DateTime" overloaded="no"> | |
781d2982 | 24871 | <autodoc>SetToNextWeekDay(self, int weekday) -> DateTime</autodoc> |
f32fc4bc RD |
24872 | <paramlist> |
24873 | <param name="weekday" type="wxDateTime::WeekDay" default=""/> | |
24874 | </paramlist> | |
24875 | </method> | |
24876 | <method name="GetNextWeekDay" type="DateTime" overloaded="no"> | |
781d2982 | 24877 | <autodoc>GetNextWeekDay(self, int weekday) -> DateTime</autodoc> |
f32fc4bc RD |
24878 | <paramlist> |
24879 | <param name="weekday" type="wxDateTime::WeekDay" default=""/> | |
24880 | </paramlist> | |
24881 | </method> | |
24882 | <method name="SetToPrevWeekDay" type="DateTime" overloaded="no"> | |
781d2982 | 24883 | <autodoc>SetToPrevWeekDay(self, int weekday) -> DateTime</autodoc> |
f32fc4bc RD |
24884 | <paramlist> |
24885 | <param name="weekday" type="wxDateTime::WeekDay" default=""/> | |
24886 | </paramlist> | |
24887 | </method> | |
24888 | <method name="GetPrevWeekDay" type="DateTime" overloaded="no"> | |
781d2982 | 24889 | <autodoc>GetPrevWeekDay(self, int weekday) -> DateTime</autodoc> |
f32fc4bc RD |
24890 | <paramlist> |
24891 | <param name="weekday" type="wxDateTime::WeekDay" default=""/> | |
24892 | </paramlist> | |
24893 | </method> | |
24894 | <method name="SetToWeekDay" type="bool" overloaded="no"> | |
781d2982 | 24895 | <autodoc>SetToWeekDay(self, int weekday, int n=1, int month=Inv_Month, int year=Inv_Year) -> bool</autodoc> |
f32fc4bc RD |
24896 | <paramlist> |
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"/> | |
24901 | </paramlist> | |
24902 | </method> | |
24903 | <method name="SetToLastWeekDay" type="bool" overloaded="no"> | |
781d2982 | 24904 | <autodoc>SetToLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> bool</autodoc> |
f32fc4bc RD |
24905 | <paramlist> |
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"/> | |
24909 | </paramlist> | |
24910 | </method> | |
24911 | <method name="GetLastWeekDay" type="DateTime" overloaded="no"> | |
781d2982 | 24912 | <autodoc>GetLastWeekDay(self, int weekday, int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc> |
f32fc4bc RD |
24913 | <paramlist> |
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"/> | |
24917 | </paramlist> | |
24918 | </method> | |
24919 | <method name="SetToTheWeek" type="bool" overloaded="no"> | |
781d2982 | 24920 | <autodoc>SetToTheWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> bool</autodoc> |
f32fc4bc RD |
24921 | <paramlist> |
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"/> | |
24925 | </paramlist> | |
24926 | </method> | |
24927 | <method name="GetWeek" type="DateTime" overloaded="no"> | |
781d2982 | 24928 | <autodoc>GetWeek(self, int numWeek, int weekday=Mon, int flags=Monday_First) -> DateTime</autodoc> |
f32fc4bc RD |
24929 | <paramlist> |
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"/> | |
24933 | </paramlist> | |
24934 | </method> | |
24935 | <method name="SetToLastMonthDay" type="DateTime" overloaded="no"> | |
781d2982 | 24936 | <autodoc>SetToLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc> |
f32fc4bc RD |
24937 | <paramlist> |
24938 | <param name="month" type="wxDateTime::Month" default="wxDateTime::Inv_Month"/> | |
24939 | <param name="year" type="int" default="wxDateTime::Inv_Year"/> | |
24940 | </paramlist> | |
24941 | </method> | |
24942 | <method name="GetLastMonthDay" type="DateTime" overloaded="no"> | |
781d2982 | 24943 | <autodoc>GetLastMonthDay(self, int month=Inv_Month, int year=Inv_Year) -> DateTime</autodoc> |
f32fc4bc RD |
24944 | <paramlist> |
24945 | <param name="month" type="wxDateTime::Month" default="wxDateTime::Inv_Month"/> | |
24946 | <param name="year" type="int" default="wxDateTime::Inv_Year"/> | |
24947 | </paramlist> | |
24948 | </method> | |
24949 | <method name="SetToYearDay" type="DateTime" overloaded="no"> | |
781d2982 | 24950 | <autodoc>SetToYearDay(self, int yday) -> DateTime</autodoc> |
f32fc4bc RD |
24951 | <paramlist> |
24952 | <param name="yday" type="int" default=""/> | |
24953 | </paramlist> | |
24954 | </method> | |
24955 | <method name="GetYearDay" type="DateTime" overloaded="no"> | |
781d2982 | 24956 | <autodoc>GetYearDay(self, int yday) -> DateTime</autodoc> |
f32fc4bc RD |
24957 | <paramlist> |
24958 | <param name="yday" type="int" default=""/> | |
24959 | </paramlist> | |
24960 | </method> | |
24961 | <method name="GetJulianDayNumber" type="double" overloaded="no"> | |
781d2982 | 24962 | <autodoc>GetJulianDayNumber(self) -> double</autodoc> |
f32fc4bc RD |
24963 | </method> |
24964 | <method name="GetJDN" type="double" overloaded="no"> | |
781d2982 | 24965 | <autodoc>GetJDN(self) -> double</autodoc> |
f32fc4bc RD |
24966 | </method> |
24967 | <method name="GetModifiedJulianDayNumber" type="double" overloaded="no"> | |
781d2982 | 24968 | <autodoc>GetModifiedJulianDayNumber(self) -> double</autodoc> |
f32fc4bc RD |
24969 | </method> |
24970 | <method name="GetMJD" type="double" overloaded="no"> | |
781d2982 | 24971 | <autodoc>GetMJD(self) -> double</autodoc> |
f32fc4bc RD |
24972 | </method> |
24973 | <method name="GetRataDie" type="double" overloaded="no"> | |
781d2982 | 24974 | <autodoc>GetRataDie(self) -> double</autodoc> |
f32fc4bc RD |
24975 | </method> |
24976 | <method name="ToTimezone" type="DateTime" overloaded="no"> | |
781d2982 | 24977 | <autodoc>ToTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime</autodoc> |
f32fc4bc RD |
24978 | <paramlist> |
24979 | <param name="tz" type="wxDateTime::TimeZone" default=""/> | |
24980 | <param name="noDST" type="bool" default="False"/> | |
24981 | </paramlist> | |
24982 | </method> | |
24983 | <method name="MakeTimezone" type="DateTime" overloaded="no"> | |
781d2982 | 24984 | <autodoc>MakeTimezone(self, wxDateTime::TimeZone tz, bool noDST=False) -> DateTime</autodoc> |
f32fc4bc RD |
24985 | <paramlist> |
24986 | <param name="tz" type="wxDateTime::TimeZone" default=""/> | |
24987 | <param name="noDST" type="bool" default="False"/> | |
24988 | </paramlist> | |
24989 | </method> | |
24990 | <method name="ToGMT" type="DateTime" overloaded="no"> | |
781d2982 | 24991 | <autodoc>ToGMT(self, bool noDST=False) -> DateTime</autodoc> |
f32fc4bc RD |
24992 | <paramlist> |
24993 | <param name="noDST" type="bool" default="False"/> | |
24994 | </paramlist> | |
24995 | </method> | |
24996 | <method name="MakeGMT" type="DateTime" overloaded="no"> | |
781d2982 | 24997 | <autodoc>MakeGMT(self, bool noDST=False) -> DateTime</autodoc> |
f32fc4bc RD |
24998 | <paramlist> |
24999 | <param name="noDST" type="bool" default="False"/> | |
25000 | </paramlist> | |
25001 | </method> | |
25002 | <method name="IsDST" type="int" overloaded="no"> | |
781d2982 | 25003 | <autodoc>IsDST(self, int country=Country_Default) -> int</autodoc> |
f32fc4bc RD |
25004 | <paramlist> |
25005 | <param name="country" type="wxDateTime::Country" default="wxDateTime::Country_Default"/> | |
25006 | </paramlist> | |
25007 | </method> | |
25008 | <method name="IsValid" type="bool" overloaded="no"> | |
781d2982 | 25009 | <autodoc>IsValid(self) -> bool</autodoc> |
f32fc4bc RD |
25010 | </method> |
25011 | <method name="GetTicks" type="time_t" overloaded="no"> | |
781d2982 | 25012 | <autodoc>GetTicks(self) -> time_t</autodoc> |
f32fc4bc RD |
25013 | </method> |
25014 | <method name="GetYear" type="int" overloaded="no"> | |
781d2982 | 25015 | <autodoc>GetYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25016 | <paramlist> |
25017 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25018 | </paramlist> | |
25019 | </method> | |
25020 | <method name="GetMonth" type="wxDateTime::Month" overloaded="no"> | |
781d2982 | 25021 | <autodoc>GetMonth(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25022 | <paramlist> |
25023 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25024 | </paramlist> | |
25025 | </method> | |
25026 | <method name="GetDay" type="int" overloaded="no"> | |
781d2982 | 25027 | <autodoc>GetDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25028 | <paramlist> |
25029 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25030 | </paramlist> | |
25031 | </method> | |
25032 | <method name="GetWeekDay" type="wxDateTime::WeekDay" overloaded="no"> | |
781d2982 | 25033 | <autodoc>GetWeekDay(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25034 | <paramlist> |
25035 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25036 | </paramlist> | |
25037 | </method> | |
25038 | <method name="GetHour" type="int" overloaded="no"> | |
781d2982 | 25039 | <autodoc>GetHour(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25040 | <paramlist> |
25041 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25042 | </paramlist> | |
25043 | </method> | |
25044 | <method name="GetMinute" type="int" overloaded="no"> | |
781d2982 | 25045 | <autodoc>GetMinute(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25046 | <paramlist> |
25047 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25048 | </paramlist> | |
25049 | </method> | |
25050 | <method name="GetSecond" type="int" overloaded="no"> | |
781d2982 | 25051 | <autodoc>GetSecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25052 | <paramlist> |
25053 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25054 | </paramlist> | |
25055 | </method> | |
25056 | <method name="GetMillisecond" type="int" overloaded="no"> | |
781d2982 | 25057 | <autodoc>GetMillisecond(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25058 | <paramlist> |
25059 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25060 | </paramlist> | |
25061 | </method> | |
25062 | <method name="GetDayOfYear" type="int" overloaded="no"> | |
781d2982 | 25063 | <autodoc>GetDayOfYear(self, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25064 | <paramlist> |
25065 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25066 | </paramlist> | |
25067 | </method> | |
25068 | <method name="GetWeekOfYear" type="int" overloaded="no"> | |
781d2982 | 25069 | <autodoc>GetWeekOfYear(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25070 | <paramlist> |
25071 | <param name="flags" type="wxDateTime::WeekFlags" default="wxDateTime::Monday_First"/> | |
25072 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25073 | </paramlist> | |
25074 | </method> | |
25075 | <method name="GetWeekOfMonth" type="int" overloaded="no"> | |
781d2982 | 25076 | <autodoc>GetWeekOfMonth(self, int flags=Monday_First, wxDateTime::TimeZone tz=LOCAL_TZ) -> int</autodoc> |
f32fc4bc RD |
25077 | <paramlist> |
25078 | <param name="flags" type="wxDateTime::WeekFlags" default="wxDateTime::Monday_First"/> | |
25079 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25080 | </paramlist> | |
25081 | </method> | |
25082 | <method name="IsWorkDay" type="bool" overloaded="no"> | |
781d2982 | 25083 | <autodoc>IsWorkDay(self, int country=Country_Default) -> bool</autodoc> |
f32fc4bc RD |
25084 | <paramlist> |
25085 | <param name="country" type="wxDateTime::Country" default="wxDateTime::Country_Default"/> | |
25086 | </paramlist> | |
25087 | </method> | |
25088 | <method name="IsEqualTo" type="bool" overloaded="no"> | |
781d2982 | 25089 | <autodoc>IsEqualTo(self, DateTime datetime) -> bool</autodoc> |
f32fc4bc RD |
25090 | <paramlist> |
25091 | <param name="datetime" type="DateTime" default=""/> | |
25092 | </paramlist> | |
25093 | </method> | |
25094 | <method name="IsEarlierThan" type="bool" overloaded="no"> | |
781d2982 | 25095 | <autodoc>IsEarlierThan(self, DateTime datetime) -> bool</autodoc> |
f32fc4bc RD |
25096 | <paramlist> |
25097 | <param name="datetime" type="DateTime" default=""/> | |
25098 | </paramlist> | |
25099 | </method> | |
25100 | <method name="IsLaterThan" type="bool" overloaded="no"> | |
781d2982 | 25101 | <autodoc>IsLaterThan(self, DateTime datetime) -> bool</autodoc> |
f32fc4bc RD |
25102 | <paramlist> |
25103 | <param name="datetime" type="DateTime" default=""/> | |
25104 | </paramlist> | |
25105 | </method> | |
25106 | <method name="IsStrictlyBetween" type="bool" overloaded="no"> | |
781d2982 | 25107 | <autodoc>IsStrictlyBetween(self, DateTime t1, DateTime t2) -> bool</autodoc> |
f32fc4bc RD |
25108 | <paramlist> |
25109 | <param name="t1" type="DateTime" default=""/> | |
25110 | <param name="t2" type="DateTime" default=""/> | |
25111 | </paramlist> | |
25112 | </method> | |
25113 | <method name="IsBetween" type="bool" overloaded="no"> | |
781d2982 | 25114 | <autodoc>IsBetween(self, DateTime t1, DateTime t2) -> bool</autodoc> |
f32fc4bc RD |
25115 | <paramlist> |
25116 | <param name="t1" type="DateTime" default=""/> | |
25117 | <param name="t2" type="DateTime" default=""/> | |
25118 | </paramlist> | |
25119 | </method> | |
25120 | <method name="IsSameDate" type="bool" overloaded="no"> | |
781d2982 | 25121 | <autodoc>IsSameDate(self, DateTime dt) -> bool</autodoc> |
f32fc4bc RD |
25122 | <paramlist> |
25123 | <param name="dt" type="DateTime" default=""/> | |
25124 | </paramlist> | |
25125 | </method> | |
25126 | <method name="IsSameTime" type="bool" overloaded="no"> | |
781d2982 | 25127 | <autodoc>IsSameTime(self, DateTime dt) -> bool</autodoc> |
f32fc4bc RD |
25128 | <paramlist> |
25129 | <param name="dt" type="DateTime" default=""/> | |
25130 | </paramlist> | |
25131 | </method> | |
25132 | <method name="IsEqualUpTo" type="bool" overloaded="no"> | |
781d2982 | 25133 | <autodoc>IsEqualUpTo(self, DateTime dt, TimeSpan ts) -> bool</autodoc> |
f32fc4bc RD |
25134 | <paramlist> |
25135 | <param name="dt" type="DateTime" default=""/> | |
25136 | <param name="ts" type="wxTimeSpan" default=""/> | |
25137 | </paramlist> | |
25138 | </method> | |
25139 | <method name="AddTS" type="DateTime" overloaded="no"> | |
781d2982 | 25140 | <autodoc>AddTS(self, TimeSpan diff) -> DateTime</autodoc> |
f32fc4bc RD |
25141 | <paramlist> |
25142 | <param name="diff" type="wxTimeSpan" default=""/> | |
25143 | </paramlist> | |
25144 | </method> | |
25145 | <method name="AddDS" type="DateTime" overloaded="no"> | |
781d2982 | 25146 | <autodoc>AddDS(self, DateSpan diff) -> DateTime</autodoc> |
f32fc4bc RD |
25147 | <paramlist> |
25148 | <param name="diff" type="wxDateSpan" default=""/> | |
25149 | </paramlist> | |
25150 | </method> | |
25151 | <method name="SubtractTS" type="DateTime" overloaded="no"> | |
781d2982 | 25152 | <autodoc>SubtractTS(self, TimeSpan diff) -> DateTime</autodoc> |
f32fc4bc RD |
25153 | <paramlist> |
25154 | <param name="diff" type="wxTimeSpan" default=""/> | |
25155 | </paramlist> | |
25156 | </method> | |
25157 | <method name="SubtractDS" type="DateTime" overloaded="no"> | |
781d2982 | 25158 | <autodoc>SubtractDS(self, DateSpan diff) -> DateTime</autodoc> |
f32fc4bc RD |
25159 | <paramlist> |
25160 | <param name="diff" type="wxDateSpan" default=""/> | |
25161 | </paramlist> | |
25162 | </method> | |
25163 | <method name="Subtract" type="wxTimeSpan" overloaded="no"> | |
781d2982 | 25164 | <autodoc>Subtract(self, DateTime dt) -> TimeSpan</autodoc> |
f32fc4bc RD |
25165 | <paramlist> |
25166 | <param name="dt" type="DateTime" default=""/> | |
25167 | </paramlist> | |
25168 | </method> | |
25169 | <method name="__iadd__" type="DateTime" overloaded="yes"> | |
25170 | <paramlist> | |
25171 | <param name="diff" type="wxTimeSpan" default=""/> | |
25172 | </paramlist> | |
25173 | </method> | |
25174 | <method name="__iadd__" type="DateTime" overloaded="yes"> | |
781d2982 RD |
25175 | <autodoc>__iadd__(self, TimeSpan diff) -> DateTime |
25176 | __iadd__(self, DateSpan diff) -> DateTime</autodoc> | |
f32fc4bc RD |
25177 | <paramlist> |
25178 | <param name="diff" type="wxDateSpan" default=""/> | |
25179 | </paramlist> | |
25180 | </method> | |
25181 | <method name="__isub__" type="DateTime" overloaded="yes"> | |
25182 | <paramlist> | |
25183 | <param name="diff" type="wxTimeSpan" default=""/> | |
25184 | </paramlist> | |
25185 | </method> | |
25186 | <method name="__isub__" type="DateTime" overloaded="yes"> | |
781d2982 RD |
25187 | <autodoc>__isub__(self, TimeSpan diff) -> DateTime |
25188 | __isub__(self, DateSpan diff) -> DateTime</autodoc> | |
f32fc4bc RD |
25189 | <paramlist> |
25190 | <param name="diff" type="wxDateSpan" default=""/> | |
25191 | </paramlist> | |
25192 | </method> | |
25193 | <method name="__add__" type="DateTime" overloaded="yes"> | |
25194 | <paramlist> | |
25195 | <param name="other" type="wxTimeSpan" default=""/> | |
25196 | </paramlist> | |
25197 | </method> | |
25198 | <method name="__add__" type="DateTime" overloaded="yes"> | |
781d2982 RD |
25199 | <autodoc>__add__(self, TimeSpan other) -> DateTime |
25200 | __add__(self, DateSpan other) -> DateTime</autodoc> | |
f32fc4bc RD |
25201 | <paramlist> |
25202 | <param name="other" type="wxDateSpan" default=""/> | |
25203 | </paramlist> | |
25204 | </method> | |
25205 | <method name="__sub__" type="wxTimeSpan" overloaded="yes"> | |
25206 | <paramlist> | |
25207 | <param name="other" type="DateTime" default=""/> | |
25208 | </paramlist> | |
25209 | </method> | |
25210 | <method name="__sub__" type="DateTime" overloaded="yes"> | |
25211 | <paramlist> | |
25212 | <param name="other" type="wxTimeSpan" default=""/> | |
25213 | </paramlist> | |
25214 | </method> | |
25215 | <method name="__sub__" type="DateTime" overloaded="yes"> | |
781d2982 RD |
25216 | <autodoc>__sub__(self, DateTime other) -> TimeSpan |
25217 | __sub__(self, TimeSpan other) -> DateTime | |
25218 | __sub__(self, DateSpan other) -> DateTime</autodoc> | |
f32fc4bc RD |
25219 | <paramlist> |
25220 | <param name="other" type="wxDateSpan" default=""/> | |
25221 | </paramlist> | |
25222 | </method> | |
25223 | <method name="__lt__" type="bool" overloaded="no"> | |
781d2982 | 25224 | <autodoc>__lt__(self, DateTime other) -> bool</autodoc> |
f32fc4bc RD |
25225 | <paramlist> |
25226 | <param name="other" type="DateTime" default=""/> | |
25227 | </paramlist> | |
25228 | </method> | |
25229 | <method name="__le__" type="bool" overloaded="no"> | |
781d2982 | 25230 | <autodoc>__le__(self, DateTime other) -> bool</autodoc> |
f32fc4bc RD |
25231 | <paramlist> |
25232 | <param name="other" type="DateTime" default=""/> | |
25233 | </paramlist> | |
25234 | </method> | |
25235 | <method name="__gt__" type="bool" overloaded="no"> | |
781d2982 | 25236 | <autodoc>__gt__(self, DateTime other) -> bool</autodoc> |
f32fc4bc RD |
25237 | <paramlist> |
25238 | <param name="other" type="DateTime" default=""/> | |
25239 | </paramlist> | |
25240 | </method> | |
25241 | <method name="__ge__" type="bool" overloaded="no"> | |
781d2982 | 25242 | <autodoc>__ge__(self, DateTime other) -> bool</autodoc> |
f32fc4bc RD |
25243 | <paramlist> |
25244 | <param name="other" type="DateTime" default=""/> | |
25245 | </paramlist> | |
25246 | </method> | |
25247 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 25248 | <autodoc>__eq__(self, DateTime other) -> bool</autodoc> |
f32fc4bc RD |
25249 | <paramlist> |
25250 | <param name="other" type="DateTime" default=""/> | |
25251 | </paramlist> | |
25252 | </method> | |
25253 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 25254 | <autodoc>__ne__(self, DateTime other) -> bool</autodoc> |
f32fc4bc RD |
25255 | <paramlist> |
25256 | <param name="other" type="DateTime" default=""/> | |
25257 | </paramlist> | |
25258 | </method> | |
25259 | <method name="ParseRfc822Date" type="int" overloaded="no"> | |
781d2982 | 25260 | <autodoc>ParseRfc822Date(self, String date) -> int</autodoc> |
f32fc4bc RD |
25261 | <paramlist> |
25262 | <param name="date" type="String" default=""/> | |
25263 | </paramlist> | |
25264 | </method> | |
25265 | <method name="ParseFormat" type="int" overloaded="no"> | |
781d2982 | 25266 | <autodoc>ParseFormat(self, String date, String format=DateFormatStr, DateTime dateDef=DefaultDateTime) -> int</autodoc> |
f32fc4bc RD |
25267 | <paramlist> |
25268 | <param name="date" type="String" default=""/> | |
25269 | <param name="format" type="String" default="wxPyDateFormatStr"/> | |
25270 | <param name="dateDef" type="DateTime" default="wxDefaultDateTime"/> | |
25271 | </paramlist> | |
25272 | </method> | |
25273 | <method name="ParseDateTime" type="int" overloaded="no"> | |
781d2982 | 25274 | <autodoc>ParseDateTime(self, String datetime) -> int</autodoc> |
f32fc4bc RD |
25275 | <paramlist> |
25276 | <param name="datetime" type="String" default=""/> | |
25277 | </paramlist> | |
25278 | </method> | |
25279 | <method name="ParseDate" type="int" overloaded="no"> | |
781d2982 | 25280 | <autodoc>ParseDate(self, String date) -> int</autodoc> |
f32fc4bc RD |
25281 | <paramlist> |
25282 | <param name="date" type="String" default=""/> | |
25283 | </paramlist> | |
25284 | </method> | |
25285 | <method name="ParseTime" type="int" overloaded="no"> | |
781d2982 | 25286 | <autodoc>ParseTime(self, String time) -> int</autodoc> |
f32fc4bc RD |
25287 | <paramlist> |
25288 | <param name="time" type="String" default=""/> | |
25289 | </paramlist> | |
25290 | </method> | |
25291 | <method name="Format" type="String" overloaded="no"> | |
781d2982 | 25292 | <autodoc>Format(self, String format=DateFormatStr, wxDateTime::TimeZone tz=LOCAL_TZ) -> String</autodoc> |
f32fc4bc RD |
25293 | <paramlist> |
25294 | <param name="format" type="String" default="wxPyDateFormatStr"/> | |
25295 | <param name="tz" type="wxDateTime::TimeZone" default="LOCAL_TZ"/> | |
25296 | </paramlist> | |
25297 | </method> | |
25298 | <method name="FormatDate" type="String" overloaded="no"> | |
781d2982 | 25299 | <autodoc>FormatDate(self) -> String</autodoc> |
f32fc4bc RD |
25300 | </method> |
25301 | <method name="FormatTime" type="String" overloaded="no"> | |
781d2982 | 25302 | <autodoc>FormatTime(self) -> String</autodoc> |
f32fc4bc RD |
25303 | </method> |
25304 | <method name="FormatISODate" type="String" overloaded="no"> | |
781d2982 | 25305 | <autodoc>FormatISODate(self) -> String</autodoc> |
f32fc4bc RD |
25306 | </method> |
25307 | <method name="FormatISOTime" type="String" overloaded="no"> | |
781d2982 | 25308 | <autodoc>FormatISOTime(self) -> String</autodoc> |
f32fc4bc RD |
25309 | </method> |
25310 | </class> | |
781d2982 | 25311 | <class name="TimeSpan" oldname="wxTimeSpan" module="_misc"> |
f32fc4bc | 25312 | <constructor name="TimeSpan" overloaded="no"> |
781d2982 | 25313 | <autodoc>__init__(self, long hours=0, long minutes=0, long seconds=0, long milliseconds=0) -> TimeSpan</autodoc> |
f32fc4bc RD |
25314 | <paramlist> |
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"/> | |
25319 | </paramlist> | |
25320 | </constructor> | |
25321 | <destructor name="~wxTimeSpan" overloaded="no"> | |
781d2982 | 25322 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
25323 | </destructor> |
25324 | <staticmethod name="Seconds" type="TimeSpan" overloaded="no"> | |
25325 | <autodoc>Seconds(long sec) -> TimeSpan</autodoc> | |
25326 | <paramlist> | |
25327 | <param name="sec" type="long" default=""/> | |
25328 | </paramlist> | |
25329 | </staticmethod> | |
25330 | <staticmethod name="Second" type="TimeSpan" overloaded="no"> | |
25331 | <autodoc>Second() -> TimeSpan</autodoc> | |
25332 | </staticmethod> | |
25333 | <staticmethod name="Minutes" type="TimeSpan" overloaded="no"> | |
25334 | <autodoc>Minutes(long min) -> TimeSpan</autodoc> | |
25335 | <paramlist> | |
25336 | <param name="min" type="long" default=""/> | |
25337 | </paramlist> | |
25338 | </staticmethod> | |
25339 | <staticmethod name="Minute" type="TimeSpan" overloaded="no"> | |
25340 | <autodoc>Minute() -> TimeSpan</autodoc> | |
25341 | </staticmethod> | |
25342 | <staticmethod name="Hours" type="TimeSpan" overloaded="no"> | |
25343 | <autodoc>Hours(long hours) -> TimeSpan</autodoc> | |
25344 | <paramlist> | |
25345 | <param name="hours" type="long" default=""/> | |
25346 | </paramlist> | |
25347 | </staticmethod> | |
25348 | <staticmethod name="Hour" type="TimeSpan" overloaded="no"> | |
25349 | <autodoc>Hour() -> TimeSpan</autodoc> | |
25350 | </staticmethod> | |
25351 | <staticmethod name="Days" type="TimeSpan" overloaded="no"> | |
25352 | <autodoc>Days(long days) -> TimeSpan</autodoc> | |
25353 | <paramlist> | |
25354 | <param name="days" type="long" default=""/> | |
25355 | </paramlist> | |
25356 | </staticmethod> | |
25357 | <staticmethod name="Day" type="TimeSpan" overloaded="no"> | |
25358 | <autodoc>Day() -> TimeSpan</autodoc> | |
25359 | </staticmethod> | |
25360 | <staticmethod name="Weeks" type="TimeSpan" overloaded="no"> | |
25361 | <autodoc>Weeks(long days) -> TimeSpan</autodoc> | |
25362 | <paramlist> | |
25363 | <param name="days" type="long" default=""/> | |
25364 | </paramlist> | |
25365 | </staticmethod> | |
25366 | <staticmethod name="Week" type="TimeSpan" overloaded="no"> | |
25367 | <autodoc>Week() -> TimeSpan</autodoc> | |
25368 | </staticmethod> | |
25369 | <method name="Add" type="TimeSpan" overloaded="no"> | |
781d2982 | 25370 | <autodoc>Add(self, TimeSpan diff) -> TimeSpan</autodoc> |
f32fc4bc RD |
25371 | <paramlist> |
25372 | <param name="diff" type="TimeSpan" default=""/> | |
25373 | </paramlist> | |
25374 | </method> | |
25375 | <method name="Subtract" type="TimeSpan" overloaded="no"> | |
781d2982 | 25376 | <autodoc>Subtract(self, TimeSpan diff) -> TimeSpan</autodoc> |
f32fc4bc RD |
25377 | <paramlist> |
25378 | <param name="diff" type="TimeSpan" default=""/> | |
25379 | </paramlist> | |
25380 | </method> | |
25381 | <method name="Multiply" type="TimeSpan" overloaded="no"> | |
781d2982 | 25382 | <autodoc>Multiply(self, int n) -> TimeSpan</autodoc> |
f32fc4bc RD |
25383 | <paramlist> |
25384 | <param name="n" type="int" default=""/> | |
25385 | </paramlist> | |
25386 | </method> | |
25387 | <method name="Neg" type="TimeSpan" overloaded="no"> | |
781d2982 | 25388 | <autodoc>Neg(self) -> TimeSpan</autodoc> |
f32fc4bc RD |
25389 | </method> |
25390 | <method name="Abs" type="TimeSpan" overloaded="no"> | |
781d2982 | 25391 | <autodoc>Abs(self) -> TimeSpan</autodoc> |
f32fc4bc RD |
25392 | </method> |
25393 | <method name="__iadd__" type="TimeSpan" overloaded="no"> | |
781d2982 | 25394 | <autodoc>__iadd__(self, TimeSpan diff) -> TimeSpan</autodoc> |
f32fc4bc RD |
25395 | <paramlist> |
25396 | <param name="diff" type="TimeSpan" default=""/> | |
25397 | </paramlist> | |
25398 | </method> | |
25399 | <method name="__isub__" type="TimeSpan" overloaded="no"> | |
781d2982 | 25400 | <autodoc>__isub__(self, TimeSpan diff) -> TimeSpan</autodoc> |
f32fc4bc RD |
25401 | <paramlist> |
25402 | <param name="diff" type="TimeSpan" default=""/> | |
25403 | </paramlist> | |
25404 | </method> | |
25405 | <method name="__imul__" type="TimeSpan" overloaded="no"> | |
781d2982 | 25406 | <autodoc>__imul__(self, int n) -> TimeSpan</autodoc> |
f32fc4bc RD |
25407 | <paramlist> |
25408 | <param name="n" type="int" default=""/> | |
25409 | </paramlist> | |
25410 | </method> | |
25411 | <method name="__neg__" type="TimeSpan" overloaded="no"> | |
781d2982 | 25412 | <autodoc>__neg__(self) -> TimeSpan</autodoc> |
f32fc4bc RD |
25413 | </method> |
25414 | <method name="__add__" type="TimeSpan" overloaded="no"> | |
781d2982 | 25415 | <autodoc>__add__(self, TimeSpan other) -> TimeSpan</autodoc> |
f32fc4bc RD |
25416 | <paramlist> |
25417 | <param name="other" type="TimeSpan" default=""/> | |
25418 | </paramlist> | |
25419 | </method> | |
25420 | <method name="__sub__" type="TimeSpan" overloaded="no"> | |
781d2982 | 25421 | <autodoc>__sub__(self, TimeSpan other) -> TimeSpan</autodoc> |
f32fc4bc RD |
25422 | <paramlist> |
25423 | <param name="other" type="TimeSpan" default=""/> | |
25424 | </paramlist> | |
25425 | </method> | |
25426 | <method name="__mul__" type="TimeSpan" overloaded="no"> | |
781d2982 | 25427 | <autodoc>__mul__(self, int n) -> TimeSpan</autodoc> |
f32fc4bc RD |
25428 | <paramlist> |
25429 | <param name="n" type="int" default=""/> | |
25430 | </paramlist> | |
25431 | </method> | |
25432 | <method name="__rmul__" type="TimeSpan" overloaded="no"> | |
781d2982 | 25433 | <autodoc>__rmul__(self, int n) -> TimeSpan</autodoc> |
f32fc4bc RD |
25434 | <paramlist> |
25435 | <param name="n" type="int" default=""/> | |
25436 | </paramlist> | |
25437 | </method> | |
25438 | <method name="__lt__" type="bool" overloaded="no"> | |
781d2982 | 25439 | <autodoc>__lt__(self, TimeSpan other) -> bool</autodoc> |
f32fc4bc RD |
25440 | <paramlist> |
25441 | <param name="other" type="TimeSpan" default=""/> | |
25442 | </paramlist> | |
25443 | </method> | |
25444 | <method name="__le__" type="bool" overloaded="no"> | |
781d2982 | 25445 | <autodoc>__le__(self, TimeSpan other) -> bool</autodoc> |
f32fc4bc RD |
25446 | <paramlist> |
25447 | <param name="other" type="TimeSpan" default=""/> | |
25448 | </paramlist> | |
25449 | </method> | |
25450 | <method name="__gt__" type="bool" overloaded="no"> | |
781d2982 | 25451 | <autodoc>__gt__(self, TimeSpan other) -> bool</autodoc> |
f32fc4bc RD |
25452 | <paramlist> |
25453 | <param name="other" type="TimeSpan" default=""/> | |
25454 | </paramlist> | |
25455 | </method> | |
25456 | <method name="__ge__" type="bool" overloaded="no"> | |
781d2982 | 25457 | <autodoc>__ge__(self, TimeSpan other) -> bool</autodoc> |
f32fc4bc RD |
25458 | <paramlist> |
25459 | <param name="other" type="TimeSpan" default=""/> | |
25460 | </paramlist> | |
25461 | </method> | |
25462 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 25463 | <autodoc>__eq__(self, TimeSpan other) -> bool</autodoc> |
f32fc4bc RD |
25464 | <paramlist> |
25465 | <param name="other" type="TimeSpan" default=""/> | |
25466 | </paramlist> | |
25467 | </method> | |
25468 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 25469 | <autodoc>__ne__(self, TimeSpan other) -> bool</autodoc> |
f32fc4bc RD |
25470 | <paramlist> |
25471 | <param name="other" type="TimeSpan" default=""/> | |
25472 | </paramlist> | |
25473 | </method> | |
25474 | <method name="IsNull" type="bool" overloaded="no"> | |
781d2982 | 25475 | <autodoc>IsNull(self) -> bool</autodoc> |
f32fc4bc RD |
25476 | </method> |
25477 | <method name="IsPositive" type="bool" overloaded="no"> | |
781d2982 | 25478 | <autodoc>IsPositive(self) -> bool</autodoc> |
f32fc4bc RD |
25479 | </method> |
25480 | <method name="IsNegative" type="bool" overloaded="no"> | |
781d2982 | 25481 | <autodoc>IsNegative(self) -> bool</autodoc> |
f32fc4bc RD |
25482 | </method> |
25483 | <method name="IsEqualTo" type="bool" overloaded="no"> | |
781d2982 | 25484 | <autodoc>IsEqualTo(self, TimeSpan ts) -> bool</autodoc> |
f32fc4bc RD |
25485 | <paramlist> |
25486 | <param name="ts" type="TimeSpan" default=""/> | |
25487 | </paramlist> | |
25488 | </method> | |
25489 | <method name="IsLongerThan" type="bool" overloaded="no"> | |
781d2982 | 25490 | <autodoc>IsLongerThan(self, TimeSpan ts) -> bool</autodoc> |
f32fc4bc RD |
25491 | <paramlist> |
25492 | <param name="ts" type="TimeSpan" default=""/> | |
25493 | </paramlist> | |
25494 | </method> | |
25495 | <method name="IsShorterThan" type="bool" overloaded="no"> | |
781d2982 | 25496 | <autodoc>IsShorterThan(self, TimeSpan t) -> bool</autodoc> |
f32fc4bc RD |
25497 | <paramlist> |
25498 | <param name="t" type="TimeSpan" default=""/> | |
25499 | </paramlist> | |
25500 | </method> | |
25501 | <method name="GetWeeks" type="int" overloaded="no"> | |
781d2982 | 25502 | <autodoc>GetWeeks(self) -> int</autodoc> |
f32fc4bc RD |
25503 | </method> |
25504 | <method name="GetDays" type="int" overloaded="no"> | |
781d2982 | 25505 | <autodoc>GetDays(self) -> int</autodoc> |
f32fc4bc RD |
25506 | </method> |
25507 | <method name="GetHours" type="int" overloaded="no"> | |
781d2982 | 25508 | <autodoc>GetHours(self) -> int</autodoc> |
f32fc4bc RD |
25509 | </method> |
25510 | <method name="GetMinutes" type="int" overloaded="no"> | |
781d2982 | 25511 | <autodoc>GetMinutes(self) -> int</autodoc> |
f32fc4bc RD |
25512 | </method> |
25513 | <method name="GetSeconds" type="wxLongLong" overloaded="no"> | |
781d2982 | 25514 | <autodoc>GetSeconds(self) -> wxLongLong</autodoc> |
f32fc4bc RD |
25515 | </method> |
25516 | <method name="GetMilliseconds" type="wxLongLong" overloaded="no"> | |
781d2982 | 25517 | <autodoc>GetMilliseconds(self) -> wxLongLong</autodoc> |
f32fc4bc RD |
25518 | </method> |
25519 | <method name="Format" type="String" overloaded="no"> | |
781d2982 | 25520 | <autodoc>Format(self, String format=TimeSpanFormatStr) -> String</autodoc> |
f32fc4bc RD |
25521 | <paramlist> |
25522 | <param name="format" type="String" default="wxPyTimeSpanFormatStr"/> | |
25523 | </paramlist> | |
25524 | </method> | |
25525 | </class> | |
781d2982 | 25526 | <class name="DateSpan" oldname="wxDateSpan" module="_misc"> |
f32fc4bc | 25527 | <constructor name="DateSpan" overloaded="no"> |
781d2982 | 25528 | <autodoc>__init__(self, int years=0, int months=0, int weeks=0, int days=0) -> DateSpan</autodoc> |
f32fc4bc RD |
25529 | <paramlist> |
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"/> | |
25534 | </paramlist> | |
25535 | </constructor> | |
25536 | <destructor name="~wxDateSpan" overloaded="no"> | |
781d2982 | 25537 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
25538 | </destructor> |
25539 | <staticmethod name="Days" type="DateSpan" overloaded="no"> | |
25540 | <autodoc>Days(int days) -> DateSpan</autodoc> | |
25541 | <paramlist> | |
25542 | <param name="days" type="int" default=""/> | |
25543 | </paramlist> | |
25544 | </staticmethod> | |
25545 | <staticmethod name="Day" type="DateSpan" overloaded="no"> | |
25546 | <autodoc>Day() -> DateSpan</autodoc> | |
25547 | </staticmethod> | |
25548 | <staticmethod name="Weeks" type="DateSpan" overloaded="no"> | |
25549 | <autodoc>Weeks(int weeks) -> DateSpan</autodoc> | |
25550 | <paramlist> | |
25551 | <param name="weeks" type="int" default=""/> | |
25552 | </paramlist> | |
25553 | </staticmethod> | |
25554 | <staticmethod name="Week" type="DateSpan" overloaded="no"> | |
25555 | <autodoc>Week() -> DateSpan</autodoc> | |
25556 | </staticmethod> | |
25557 | <staticmethod name="Months" type="DateSpan" overloaded="no"> | |
25558 | <autodoc>Months(int mon) -> DateSpan</autodoc> | |
25559 | <paramlist> | |
25560 | <param name="mon" type="int" default=""/> | |
25561 | </paramlist> | |
25562 | </staticmethod> | |
25563 | <staticmethod name="Month" type="DateSpan" overloaded="no"> | |
25564 | <autodoc>Month() -> DateSpan</autodoc> | |
25565 | </staticmethod> | |
25566 | <staticmethod name="Years" type="DateSpan" overloaded="no"> | |
25567 | <autodoc>Years(int years) -> DateSpan</autodoc> | |
25568 | <paramlist> | |
25569 | <param name="years" type="int" default=""/> | |
25570 | </paramlist> | |
25571 | </staticmethod> | |
25572 | <staticmethod name="Year" type="DateSpan" overloaded="no"> | |
25573 | <autodoc>Year() -> DateSpan</autodoc> | |
25574 | </staticmethod> | |
25575 | <method name="SetYears" type="DateSpan" overloaded="no"> | |
781d2982 | 25576 | <autodoc>SetYears(self, int n) -> DateSpan</autodoc> |
f32fc4bc RD |
25577 | <paramlist> |
25578 | <param name="n" type="int" default=""/> | |
25579 | </paramlist> | |
25580 | </method> | |
25581 | <method name="SetMonths" type="DateSpan" overloaded="no"> | |
781d2982 | 25582 | <autodoc>SetMonths(self, int n) -> DateSpan</autodoc> |
f32fc4bc RD |
25583 | <paramlist> |
25584 | <param name="n" type="int" default=""/> | |
25585 | </paramlist> | |
25586 | </method> | |
25587 | <method name="SetWeeks" type="DateSpan" overloaded="no"> | |
781d2982 | 25588 | <autodoc>SetWeeks(self, int n) -> DateSpan</autodoc> |
f32fc4bc RD |
25589 | <paramlist> |
25590 | <param name="n" type="int" default=""/> | |
25591 | </paramlist> | |
25592 | </method> | |
25593 | <method name="SetDays" type="DateSpan" overloaded="no"> | |
781d2982 | 25594 | <autodoc>SetDays(self, int n) -> DateSpan</autodoc> |
f32fc4bc RD |
25595 | <paramlist> |
25596 | <param name="n" type="int" default=""/> | |
25597 | </paramlist> | |
25598 | </method> | |
25599 | <method name="GetYears" type="int" overloaded="no"> | |
781d2982 | 25600 | <autodoc>GetYears(self) -> int</autodoc> |
f32fc4bc RD |
25601 | </method> |
25602 | <method name="GetMonths" type="int" overloaded="no"> | |
781d2982 | 25603 | <autodoc>GetMonths(self) -> int</autodoc> |
f32fc4bc RD |
25604 | </method> |
25605 | <method name="GetWeeks" type="int" overloaded="no"> | |
781d2982 | 25606 | <autodoc>GetWeeks(self) -> int</autodoc> |
f32fc4bc RD |
25607 | </method> |
25608 | <method name="GetDays" type="int" overloaded="no"> | |
781d2982 | 25609 | <autodoc>GetDays(self) -> int</autodoc> |
f32fc4bc RD |
25610 | </method> |
25611 | <method name="GetTotalDays" type="int" overloaded="no"> | |
781d2982 | 25612 | <autodoc>GetTotalDays(self) -> int</autodoc> |
f32fc4bc RD |
25613 | </method> |
25614 | <method name="Add" type="DateSpan" overloaded="no"> | |
781d2982 | 25615 | <autodoc>Add(self, DateSpan other) -> DateSpan</autodoc> |
f32fc4bc RD |
25616 | <paramlist> |
25617 | <param name="other" type="DateSpan" default=""/> | |
25618 | </paramlist> | |
25619 | </method> | |
25620 | <method name="Subtract" type="DateSpan" overloaded="no"> | |
781d2982 | 25621 | <autodoc>Subtract(self, DateSpan other) -> DateSpan</autodoc> |
f32fc4bc RD |
25622 | <paramlist> |
25623 | <param name="other" type="DateSpan" default=""/> | |
25624 | </paramlist> | |
25625 | </method> | |
25626 | <method name="Neg" type="DateSpan" overloaded="no"> | |
781d2982 | 25627 | <autodoc>Neg(self) -> DateSpan</autodoc> |
f32fc4bc RD |
25628 | </method> |
25629 | <method name="Multiply" type="DateSpan" overloaded="no"> | |
781d2982 | 25630 | <autodoc>Multiply(self, int factor) -> DateSpan</autodoc> |
f32fc4bc RD |
25631 | <paramlist> |
25632 | <param name="factor" type="int" default=""/> | |
25633 | </paramlist> | |
25634 | </method> | |
25635 | <method name="__iadd__" type="DateSpan" overloaded="no"> | |
781d2982 | 25636 | <autodoc>__iadd__(self, DateSpan other) -> DateSpan</autodoc> |
f32fc4bc RD |
25637 | <paramlist> |
25638 | <param name="other" type="DateSpan" default=""/> | |
25639 | </paramlist> | |
25640 | </method> | |
25641 | <method name="__isub__" type="DateSpan" overloaded="no"> | |
781d2982 | 25642 | <autodoc>__isub__(self, DateSpan other) -> DateSpan</autodoc> |
f32fc4bc RD |
25643 | <paramlist> |
25644 | <param name="other" type="DateSpan" default=""/> | |
25645 | </paramlist> | |
25646 | </method> | |
25647 | <method name="__neg__" type="DateSpan" overloaded="no"> | |
781d2982 | 25648 | <autodoc>__neg__(self) -> DateSpan</autodoc> |
f32fc4bc RD |
25649 | </method> |
25650 | <method name="__imul__" type="DateSpan" overloaded="no"> | |
781d2982 | 25651 | <autodoc>__imul__(self, int factor) -> DateSpan</autodoc> |
f32fc4bc RD |
25652 | <paramlist> |
25653 | <param name="factor" type="int" default=""/> | |
25654 | </paramlist> | |
25655 | </method> | |
25656 | <method name="__add__" type="DateSpan" overloaded="no"> | |
781d2982 | 25657 | <autodoc>__add__(self, DateSpan other) -> DateSpan</autodoc> |
f32fc4bc RD |
25658 | <paramlist> |
25659 | <param name="other" type="DateSpan" default=""/> | |
25660 | </paramlist> | |
25661 | </method> | |
25662 | <method name="__sub__" type="DateSpan" overloaded="no"> | |
781d2982 | 25663 | <autodoc>__sub__(self, DateSpan other) -> DateSpan</autodoc> |
f32fc4bc RD |
25664 | <paramlist> |
25665 | <param name="other" type="DateSpan" default=""/> | |
25666 | </paramlist> | |
25667 | </method> | |
25668 | <method name="__mul__" type="DateSpan" overloaded="no"> | |
781d2982 | 25669 | <autodoc>__mul__(self, int n) -> DateSpan</autodoc> |
f32fc4bc RD |
25670 | <paramlist> |
25671 | <param name="n" type="int" default=""/> | |
25672 | </paramlist> | |
25673 | </method> | |
25674 | <method name="__rmul__" type="DateSpan" overloaded="no"> | |
781d2982 | 25675 | <autodoc>__rmul__(self, int n) -> DateSpan</autodoc> |
f32fc4bc RD |
25676 | <paramlist> |
25677 | <param name="n" type="int" default=""/> | |
25678 | </paramlist> | |
25679 | </method> | |
25680 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 25681 | <autodoc>__eq__(self, DateSpan other) -> bool</autodoc> |
f32fc4bc RD |
25682 | <paramlist> |
25683 | <param name="other" type="DateSpan" default=""/> | |
25684 | </paramlist> | |
25685 | </method> | |
25686 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 25687 | <autodoc>__ne__(self, DateSpan other) -> bool</autodoc> |
f32fc4bc RD |
25688 | <paramlist> |
25689 | <param name="other" type="DateSpan" default=""/> | |
25690 | </paramlist> | |
25691 | </method> | |
25692 | </class> | |
25693 | <method name="GetLocalTime" oldname="wxGetLocalTime" type="long" overloaded="no"> | |
25694 | <autodoc>GetLocalTime() -> long</autodoc> | |
25695 | </method> | |
25696 | <method name="GetUTCTime" oldname="wxGetUTCTime" type="long" overloaded="no"> | |
25697 | <autodoc>GetUTCTime() -> long</autodoc> | |
25698 | </method> | |
25699 | <method name="GetCurrentTime" oldname="wxGetCurrentTime" type="long" overloaded="no"> | |
25700 | <autodoc>GetCurrentTime() -> long</autodoc> | |
25701 | </method> | |
25702 | <method name="GetLocalTimeMillis" oldname="wxGetLocalTimeMillis" type="wxLongLong" overloaded="no"> | |
25703 | <autodoc>GetLocalTimeMillis() -> wxLongLong</autodoc> | |
856bf319 | 25704 | </method> |
f32fc4bc RD |
25705 | <pythoncode> |
25706 | #--------------------------------------------------------------------------- | |
25707 | </pythoncode> | |
781d2982 | 25708 | <class name="DataFormat" oldname="wxDataFormat" module="_misc"> |
c2dda882 | 25709 | <docstring>A wx.DataFormat is an encapsulation of a platform-specific format |
781d2982 RD |
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 | |
ce6878e6 RD |
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.) | |
25717 | ||
25718 | The standard format IDs are: | |
25719 | ||
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 | ================ ===================================== | |
25729 | ||
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. | |
25736 | ||
25737 | </docstring> | |
f32fc4bc | 25738 | <constructor name="DataFormat" overloaded="no"> |
781d2982 RD |
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> | |
f32fc4bc RD |
25742 | <paramlist> |
25743 | <param name="type" type="wxDataFormatId" default=""/> | |
25744 | </paramlist> | |
25745 | </constructor> | |
25746 | <constructor name="CustomDataFormat" overloaded="no"> | |
25747 | <autodoc>CustomDataFormat(String format) -> DataFormat</autodoc> | |
781d2982 RD |
25748 | <docstring>Constructs a data format object for a custom format identified by its |
25749 | name.</docstring> | |
f32fc4bc RD |
25750 | <paramlist> |
25751 | <param name="format" type="String" default=""/> | |
25752 | </paramlist> | |
25753 | </constructor> | |
25754 | <destructor name="~wxDataFormat" overloaded="no"> | |
781d2982 | 25755 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
25756 | </destructor> |
25757 | <method name="__eq__" type="bool" overloaded="yes"> | |
25758 | <paramlist> | |
25759 | <param name="format" type="wxDataFormatId" default=""/> | |
25760 | </paramlist> | |
25761 | </method> | |
25762 | <method name="__ne__" type="bool" overloaded="yes"> | |
25763 | <paramlist> | |
25764 | <param name="format" type="wxDataFormatId" default=""/> | |
25765 | </paramlist> | |
25766 | </method> | |
25767 | <method name="__eq__" type="bool" overloaded="yes"> | |
781d2982 RD |
25768 | <autodoc>__eq__(self, int format) -> bool |
25769 | __eq__(self, DataFormat format) -> bool</autodoc> | |
f32fc4bc RD |
25770 | <paramlist> |
25771 | <param name="format" type="DataFormat" default=""/> | |
25772 | </paramlist> | |
25773 | </method> | |
25774 | <method name="__ne__" type="bool" overloaded="yes"> | |
781d2982 RD |
25775 | <autodoc>__ne__(self, int format) -> bool |
25776 | __ne__(self, DataFormat format) -> bool</autodoc> | |
f32fc4bc RD |
25777 | <paramlist> |
25778 | <param name="format" type="DataFormat" default=""/> | |
25779 | </paramlist> | |
25780 | </method> | |
25781 | <method name="SetType" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
25785 | <paramlist> |
25786 | <param name="format" type="wxDataFormatId" default=""/> | |
25787 | </paramlist> | |
25788 | </method> | |
25789 | <method name="GetType" type="wxDataFormatId" overloaded="no"> | |
781d2982 | 25790 | <autodoc>GetType(self) -> int</autodoc> |
c2dda882 | 25791 | <docstring>Returns the platform-specific number identifying the format.</docstring> |
f32fc4bc RD |
25792 | </method> |
25793 | <method name="GetId" type="String" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
25797 | </method> |
25798 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 25799 | <autodoc>SetId(self, String format)</autodoc> |
c2dda882 | 25800 | <docstring>Sets the format to be the custom format identified by the given name.</docstring> |
f32fc4bc RD |
25801 | <paramlist> |
25802 | <param name="format" type="String" default=""/> | |
25803 | </paramlist> | |
25804 | </method> | |
25805 | </class> | |
781d2982 RD |
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. | |
25813 | ||
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`. | |
ce6878e6 RD |
25818 | |
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. | |
25823 | ||
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. | |
25832 | ||
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 | |
25843 | it so.) | |
25844 | ||
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. | |
781d2982 | 25851 | </docstring> |
f32fc4bc | 25852 | <destructor name="~wxDataObject" overloaded="no"> |
781d2982 | 25853 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
25854 | </destructor> |
25855 | <method name="GetPreferredFormat" type="DataFormat" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
25860 | <paramlist> |
25861 | <param name="dir" type="wxDataObject::Direction" default="wxDataObject::Get"/> | |
25862 | </paramlist> | |
25863 | </method> | |
25864 | <method name="GetFormatCount" type="size_t" overloaded="no"> | |
781d2982 RD |
25865 | <autodoc>GetFormatCount(self, int dir=Get) -> size_t</autodoc> |
25866 | <docstring>Returns the number of available formats for rendering or setting the | |
25867 | data.</docstring> | |
f32fc4bc RD |
25868 | <paramlist> |
25869 | <param name="dir" type="wxDataObject::Direction" default="wxDataObject::Get"/> | |
25870 | </paramlist> | |
25871 | </method> | |
25872 | <method name="IsSupported" type="bool" overloaded="no"> | |
781d2982 RD |
25873 | <autodoc>IsSupported(self, DataFormat format, int dir=Get) -> bool</autodoc> |
25874 | <docstring>Returns True if this format is supported.</docstring> | |
f32fc4bc RD |
25875 | <paramlist> |
25876 | <param name="format" type="DataFormat" default=""/> | |
25877 | <param name="dir" type="wxDataObject::Direction" default="wxDataObject::Get"/> | |
25878 | </paramlist> | |
25879 | </method> | |
25880 | <method name="GetDataSize" type="size_t" overloaded="no"> | |
781d2982 RD |
25881 | <autodoc>GetDataSize(self, DataFormat format) -> size_t</autodoc> |
25882 | <docstring>Get the (total) size of data for the given format</docstring> | |
f32fc4bc RD |
25883 | <paramlist> |
25884 | <param name="format" type="DataFormat" default=""/> | |
25885 | </paramlist> | |
25886 | </method> | |
781d2982 RD |
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> | |
f32fc4bc | 25891 | <paramlist> |
f32fc4bc RD |
25892 | <param name="dir" type="wxDataObject::Direction" default="wxDataObject::Get"/> |
25893 | </paramlist> | |
25894 | </method> | |
781d2982 RD |
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. | |
ce6878e6 RD |
25898 | |
25899 | :todo: This should use the python buffer interface isntead...</docstring> | |
f32fc4bc RD |
25900 | <paramlist> |
25901 | <param name="format" type="DataFormat" default=""/> | |
f32fc4bc RD |
25902 | </paramlist> |
25903 | </method> | |
25904 | <method name="SetData" type="bool" overloaded="no"> | |
781d2982 RD |
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. | |
ce6878e6 RD |
25907 | |
25908 | :todo: This should use the python buffer interface isntead...</docstring> | |
f32fc4bc RD |
25909 | <paramlist> |
25910 | <param name="format" type="DataFormat" default=""/> | |
781d2982 | 25911 | <param name="data" type="PyObject" default=""/> |
f32fc4bc RD |
25912 | </paramlist> |
25913 | </method> | |
25914 | </class> | |
781d2982 RD |
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. | |
25918 | ||
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`. | |
25922 | </docstring> | |
f32fc4bc RD |
25923 | <baseclass name="DataObject"/> |
25924 | <constructor name="DataObjectSimple" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
25928 | <paramlist> |
25929 | <param name="format" type="DataFormat" default="wxFormatInvalid"/> | |
25930 | </paramlist> | |
25931 | </constructor> | |
25932 | <method name="GetFormat" type="DataFormat" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
25936 | </method> |
25937 | <method name="SetFormat" type="" overloaded="no"> | |
781d2982 RD |
25938 | <autodoc>SetFormat(self, DataFormat format)</autodoc> |
25939 | <docstring>Sets the supported format.</docstring> | |
f32fc4bc RD |
25940 | <paramlist> |
25941 | <param name="format" type="DataFormat" default=""/> | |
25942 | </paramlist> | |
25943 | </method> | |
781d2982 RD |
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> | |
25947 | </method> | |
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> | |
25953 | </method> | |
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. | |
25958 | </docstring> | |
25959 | <paramlist> | |
25960 | <param name="data" type="PyObject" default=""/> | |
25961 | </paramlist> | |
25962 | </method> | |
f32fc4bc | 25963 | </class> |
781d2982 RD |
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`. | |
ce6878e6 RD |
25970 | |
25971 | Here is a simple example:: | |
25972 | ||
25973 | class MyDataObject(wx.PyDataObjectSimple): | |
25974 | def __init__(self): | |
25975 | wx.PyDataObjectSimple.__init__( | |
25976 | self, wx.CustomDataFormat('MyDOFormat')) | |
25977 | self.data = '' | |
25978 | ||
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): | |
25984 | self.data = data | |
25985 | return True | |
25986 | ||
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 | |
25992 | data structures. | |
781d2982 | 25993 | </docstring> |
f32fc4bc RD |
25994 | <baseclass name="DataObjectSimple"/> |
25995 | <constructor name="PyDataObjectSimple" overloaded="no"> | |
781d2982 RD |
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`. | |
ce6878e6 RD |
26002 | |
26003 | Here is a simple example:: | |
26004 | ||
26005 | class MyDataObject(wx.PyDataObjectSimple): | |
26006 | def __init__(self): | |
26007 | wx.PyDataObjectSimple.__init__( | |
26008 | self, wx.CustomDataFormat('MyDOFormat')) | |
26009 | self.data = '' | |
26010 | ||
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): | |
26016 | self.data = data | |
26017 | return True | |
26018 | ||
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 | |
26024 | data structures. | |
781d2982 | 26025 | </docstring> |
f32fc4bc RD |
26026 | <paramlist> |
26027 | <param name="format" type="DataFormat" default="wxFormatInvalid"/> | |
26028 | </paramlist> | |
26029 | </constructor> | |
26030 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 26031 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
26032 | <paramlist> |
26033 | <param name="self" type="PyObject" default=""/> | |
26034 | <param name="_class" type="PyObject" default=""/> | |
26035 | </paramlist> | |
26036 | </method> | |
26037 | </class> | |
781d2982 RD |
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. | |
26046 | ||
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. | |
26050 | </docstring> | |
f32fc4bc RD |
26051 | <baseclass name="DataObject"/> |
26052 | <constructor name="DataObjectComposite" overloaded="no"> | |
781d2982 RD |
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. | |
26061 | ||
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. | |
26065 | </docstring> | |
f32fc4bc RD |
26066 | </constructor> |
26067 | <method name="Add" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26071 | <paramlist> |
26072 | <param name="dataObject" type="DataObjectSimple" default=""/> | |
781d2982 | 26073 | <param name="preferred" type="bool" default="False"/> |
f32fc4bc RD |
26074 | </paramlist> |
26075 | </method> | |
26076 | </class> | |
781d2982 RD |
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`. | |
26081 | ||
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> | |
f32fc4bc RD |
26089 | <baseclass name="DataObjectSimple"/> |
26090 | <constructor name="TextDataObject" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26094 | <paramlist> |
26095 | <param name="text" type="String" default="wxPyEmptyString"/> | |
26096 | </paramlist> | |
26097 | </constructor> | |
26098 | <method name="GetTextLength" type="size_t" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26105 | </method> |
26106 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 RD |
26107 | <autodoc>GetText(self) -> String</autodoc> |
26108 | <docstring>Returns the text associated with the data object.</docstring> | |
f32fc4bc RD |
26109 | </method> |
26110 | <method name="SetText" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26117 | <paramlist> |
26118 | <param name="text" type="String" default=""/> | |
26119 | </paramlist> | |
26120 | </method> | |
26121 | </class> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26129 | <baseclass name="TextDataObject"/> |
26130 | <constructor name="PyTextDataObject" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26138 | <paramlist> |
26139 | <param name="text" type="String" default="wxPyEmptyString"/> | |
26140 | </paramlist> | |
26141 | </constructor> | |
26142 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 26143 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
26144 | <paramlist> |
26145 | <param name="self" type="PyObject" default=""/> | |
26146 | <param name="_class" type="PyObject" default=""/> | |
26147 | </paramlist> | |
26148 | </method> | |
26149 | </class> | |
781d2982 RD |
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`. | |
ce6878e6 RD |
26154 | |
26155 | :see: `wx.PyBitmapDataObject` if you wish to override `GetBitmap` to increase efficiency.</docstring> | |
f32fc4bc RD |
26156 | <baseclass name="DataObjectSimple"/> |
26157 | <constructor name="BitmapDataObject" overloaded="no"> | |
781d2982 RD |
26158 | <autodoc>__init__(self, Bitmap bitmap=wxNullBitmap) -> BitmapDataObject</autodoc> |
26159 | <docstring>Constructor, optionally passing a bitmap (otherwise use `SetBitmap` | |
26160 | later).</docstring> | |
f32fc4bc RD |
26161 | <paramlist> |
26162 | <param name="bitmap" type="Bitmap" default="wxNullBitmap"/> | |
26163 | </paramlist> | |
26164 | </constructor> | |
26165 | <method name="GetBitmap" type="Bitmap" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26172 | </method> |
26173 | <method name="SetBitmap" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26178 | <paramlist> |
26179 | <param name="bitmap" type="Bitmap" default=""/> | |
26180 | </paramlist> | |
26181 | </method> | |
26182 | </class> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26188 | <baseclass name="BitmapDataObject"/> |
26189 | <constructor name="PyBitmapDataObject" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26195 | <paramlist> |
26196 | <param name="bitmap" type="Bitmap" default="wxNullBitmap"/> | |
26197 | </paramlist> | |
26198 | </constructor> | |
26199 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 26200 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
26201 | <paramlist> |
26202 | <param name="self" type="PyObject" default=""/> | |
26203 | <param name="_class" type="PyObject" default=""/> | |
26204 | </paramlist> | |
26205 | </method> | |
26206 | </class> | |
781d2982 RD |
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. | |
26214 | ||
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. | |
26219 | </docstring> | |
f32fc4bc RD |
26220 | <baseclass name="DataObjectSimple"/> |
26221 | <constructor name="FileDataObject" overloaded="no"> | |
781d2982 | 26222 | <autodoc>__init__(self) -> FileDataObject</autodoc> |
f32fc4bc RD |
26223 | </constructor> |
26224 | <method name="GetFilenames" type="wxArrayString" overloaded="no"> | |
781d2982 | 26225 | <autodoc>GetFilenames(self) -> [names]</autodoc> |
ce6878e6 | 26226 | <docstring>Returns a list of file names.</docstring> |
f32fc4bc | 26227 | </method> |
c2dda882 | 26228 | <method name="AddFile" type="" overloaded="no"> |
781d2982 RD |
26229 | <autodoc>AddFile(self, String filename)</autodoc> |
26230 | <docstring>Adds a file to the list of files represented by this data object.</docstring> | |
c2dda882 RD |
26231 | <paramlist> |
26232 | <param name="filename" type="String" default=""/> | |
26233 | </paramlist> | |
26234 | </method> | |
f32fc4bc | 26235 | </class> |
781d2982 RD |
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> | |
f32fc4bc RD |
26242 | <baseclass name="DataObjectSimple"/> |
26243 | <constructor name="CustomDataObject" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26250 | <paramlist> |
26251 | <param name="format" type="DataFormat" default="wxFormatInvalid"/> | |
26252 | </paramlist> | |
26253 | </constructor> | |
f32fc4bc | 26254 | <method name="SetData" type="bool" overloaded="no"> |
781d2982 RD |
26255 | <autodoc>SetData(self, String data) -> bool</autodoc> |
26256 | <docstring>Copy the data value to the data object.</docstring> | |
f32fc4bc RD |
26257 | <paramlist> |
26258 | <param name="data" type="PyObject" default=""/> | |
26259 | </paramlist> | |
26260 | </method> | |
26261 | <method name="GetSize" type="size_t" overloaded="no"> | |
781d2982 RD |
26262 | <autodoc>GetSize(self) -> size_t</autodoc> |
26263 | <docstring>Get the size of the data.</docstring> | |
f32fc4bc RD |
26264 | </method> |
26265 | <method name="GetData" type="PyObject" overloaded="no"> | |
781d2982 RD |
26266 | <autodoc>GetData(self) -> String</autodoc> |
26267 | <docstring>Returns the data bytes from the data object as a string.</docstring> | |
f32fc4bc RD |
26268 | </method> |
26269 | </class> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26273 | <baseclass name="DataObjectComposite"/> |
26274 | <constructor name="URLDataObject" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26278 | </constructor> |
26279 | <method name="GetURL" type="String" overloaded="no"> | |
781d2982 RD |
26280 | <autodoc>GetURL(self) -> String</autodoc> |
26281 | <docstring>Returns a string containing the current URL.</docstring> | |
f32fc4bc RD |
26282 | </method> |
26283 | <method name="SetURL" type="" overloaded="no"> | |
781d2982 RD |
26284 | <autodoc>SetURL(self, String url)</autodoc> |
26285 | <docstring>Set the URL.</docstring> | |
f32fc4bc RD |
26286 | <paramlist> |
26287 | <param name="url" type="String" default=""/> | |
26288 | </paramlist> | |
26289 | </method> | |
26290 | </class> | |
781d2982 | 26291 | <class name="MetafileDataObject" oldname="wxMetafileDataObject" module="_misc"> |
f32fc4bc RD |
26292 | <baseclass name="DataObjectSimple"/> |
26293 | <constructor name="MetafileDataObject" overloaded="no"> | |
781d2982 | 26294 | <autodoc>__init__(self) -> MetafileDataObject</autodoc> |
f32fc4bc RD |
26295 | </constructor> |
26296 | </class> | |
26297 | <pythoncode> | |
26298 | #--------------------------------------------------------------------------- | |
26299 | </pythoncode> | |
26300 | <method name="IsDragResultOk" oldname="wxIsDragResultOk" type="bool" overloaded="no"> | |
26301 | <autodoc>IsDragResultOk(int res) -> bool</autodoc> | |
856bf319 | 26302 | <paramlist> |
f32fc4bc | 26303 | <param name="res" type="wxDragResult" default=""/> |
856bf319 RD |
26304 | </paramlist> |
26305 | </method> | |
781d2982 | 26306 | <class name="DropSource" oldname="wxPyDropSource" module="_misc"> |
f32fc4bc | 26307 | <constructor name="wxPyDropSource" overloaded="no"> |
781d2982 | 26308 | <autodoc>__init__(self, Window win, Icon copy=wxNullIcon, Icon move=wxNullIcon, |
f32fc4bc RD |
26309 | Icon none=wxNullIcon) -> DropSource</autodoc> |
26310 | <paramlist> | |
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"/> | |
26315 | </paramlist> | |
26316 | </constructor> | |
26317 | <destructor name="~wxPyDropSource" overloaded="no"> | |
781d2982 | 26318 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
26319 | </destructor> |
26320 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 26321 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class, int incref)</autodoc> |
f32fc4bc RD |
26322 | <paramlist> |
26323 | <param name="self" type="PyObject" default=""/> | |
26324 | <param name="_class" type="PyObject" default=""/> | |
26325 | <param name="incref" type="int" default=""/> | |
26326 | </paramlist> | |
26327 | </method> | |
26328 | <method name="SetData" type="" overloaded="no"> | |
781d2982 | 26329 | <autodoc>SetData(self, DataObject data)</autodoc> |
f32fc4bc RD |
26330 | <paramlist> |
26331 | <param name="data" type="DataObject" default=""/> | |
26332 | </paramlist> | |
26333 | </method> | |
26334 | <method name="GetDataObject" type="DataObject" overloaded="no"> | |
781d2982 | 26335 | <autodoc>GetDataObject(self) -> DataObject</autodoc> |
f32fc4bc RD |
26336 | </method> |
26337 | <method name="SetCursor" type="" overloaded="no"> | |
781d2982 | 26338 | <autodoc>SetCursor(self, int res, Cursor cursor)</autodoc> |
f32fc4bc RD |
26339 | <paramlist> |
26340 | <param name="res" type="wxDragResult" default=""/> | |
26341 | <param name="cursor" type="Cursor" default=""/> | |
26342 | </paramlist> | |
26343 | </method> | |
26344 | <method name="DoDragDrop" type="wxDragResult" overloaded="no"> | |
781d2982 | 26345 | <autodoc>DoDragDrop(self, int flags=Drag_CopyOnly) -> int</autodoc> |
f32fc4bc RD |
26346 | <paramlist> |
26347 | <param name="flags" type="int" default="wxDrag_CopyOnly"/> | |
26348 | </paramlist> | |
26349 | </method> | |
26350 | <method name="base_GiveFeedback" type="bool" overloaded="no"> | |
781d2982 | 26351 | <autodoc>base_GiveFeedback(self, int effect) -> bool</autodoc> |
f32fc4bc RD |
26352 | <paramlist> |
26353 | <param name="effect" type="wxDragResult" default=""/> | |
26354 | </paramlist> | |
26355 | </method> | |
26356 | </class> | |
781d2982 | 26357 | <class name="DropTarget" oldname="wxPyDropTarget" module="_misc"> |
c2dda882 | 26358 | <constructor name="DropTarget" overloaded="no"> |
781d2982 | 26359 | <autodoc>__init__(self, DataObject dataObject=None) -> DropTarget</autodoc> |
f32fc4bc RD |
26360 | <paramlist> |
26361 | <param name="dataObject" type="DataObject" default="NULL"/> | |
26362 | </paramlist> | |
26363 | </constructor> | |
26364 | <destructor name="~wxPyDropTarget" overloaded="no"> | |
781d2982 | 26365 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
26366 | </destructor> |
26367 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 26368 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
26369 | <paramlist> |
26370 | <param name="self" type="PyObject" default=""/> | |
26371 | <param name="_class" type="PyObject" default=""/> | |
26372 | </paramlist> | |
26373 | </method> | |
26374 | <method name="GetDataObject" type="DataObject" overloaded="no"> | |
781d2982 | 26375 | <autodoc>GetDataObject(self) -> DataObject</autodoc> |
f32fc4bc RD |
26376 | </method> |
26377 | <method name="SetDataObject" type="" overloaded="no"> | |
781d2982 | 26378 | <autodoc>SetDataObject(self, DataObject dataObject)</autodoc> |
f32fc4bc RD |
26379 | <paramlist> |
26380 | <param name="dataObject" type="DataObject" default=""/> | |
26381 | </paramlist> | |
26382 | </method> | |
26383 | <method name="base_OnEnter" type="wxDragResult" overloaded="no"> | |
781d2982 | 26384 | <autodoc>base_OnEnter(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
26385 | <paramlist> |
26386 | <param name="x" type="int" default=""/> | |
26387 | <param name="y" type="int" default=""/> | |
26388 | <param name="def" type="wxDragResult" default=""/> | |
26389 | </paramlist> | |
26390 | </method> | |
26391 | <method name="base_OnDragOver" type="wxDragResult" overloaded="no"> | |
781d2982 | 26392 | <autodoc>base_OnDragOver(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
26393 | <paramlist> |
26394 | <param name="x" type="int" default=""/> | |
26395 | <param name="y" type="int" default=""/> | |
26396 | <param name="def" type="wxDragResult" default=""/> | |
26397 | </paramlist> | |
26398 | </method> | |
26399 | <method name="base_OnLeave" type="" overloaded="no"> | |
781d2982 | 26400 | <autodoc>base_OnLeave(self)</autodoc> |
f32fc4bc RD |
26401 | </method> |
26402 | <method name="base_OnDrop" type="bool" overloaded="no"> | |
781d2982 | 26403 | <autodoc>base_OnDrop(self, int x, int y) -> bool</autodoc> |
f32fc4bc RD |
26404 | <paramlist> |
26405 | <param name="x" type="int" default=""/> | |
26406 | <param name="y" type="int" default=""/> | |
26407 | </paramlist> | |
26408 | </method> | |
26409 | <method name="GetData" type="bool" overloaded="no"> | |
781d2982 | 26410 | <autodoc>GetData(self) -> bool</autodoc> |
f32fc4bc RD |
26411 | </method> |
26412 | </class> | |
26413 | <pythoncode> PyDropTarget = DropTarget </pythoncode> | |
781d2982 | 26414 | <class name="TextDropTarget" oldname="wxPyTextDropTarget" module="_misc"> |
f32fc4bc RD |
26415 | <baseclass name="DropTarget"/> |
26416 | <constructor name="wxPyTextDropTarget" overloaded="no"> | |
781d2982 | 26417 | <autodoc>__init__(self) -> TextDropTarget</autodoc> |
f32fc4bc RD |
26418 | </constructor> |
26419 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 26420 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
26421 | <paramlist> |
26422 | <param name="self" type="PyObject" default=""/> | |
26423 | <param name="_class" type="PyObject" default=""/> | |
26424 | </paramlist> | |
26425 | </method> | |
26426 | <method name="base_OnEnter" type="wxDragResult" overloaded="no"> | |
781d2982 | 26427 | <autodoc>base_OnEnter(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
26428 | <paramlist> |
26429 | <param name="x" type="int" default=""/> | |
26430 | <param name="y" type="int" default=""/> | |
26431 | <param name="def" type="wxDragResult" default=""/> | |
26432 | </paramlist> | |
26433 | </method> | |
26434 | <method name="base_OnDragOver" type="wxDragResult" overloaded="no"> | |
781d2982 | 26435 | <autodoc>base_OnDragOver(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
26436 | <paramlist> |
26437 | <param name="x" type="int" default=""/> | |
26438 | <param name="y" type="int" default=""/> | |
26439 | <param name="def" type="wxDragResult" default=""/> | |
26440 | </paramlist> | |
26441 | </method> | |
26442 | <method name="base_OnLeave" type="" overloaded="no"> | |
781d2982 | 26443 | <autodoc>base_OnLeave(self)</autodoc> |
f32fc4bc RD |
26444 | </method> |
26445 | <method name="base_OnDrop" type="bool" overloaded="no"> | |
781d2982 | 26446 | <autodoc>base_OnDrop(self, int x, int y) -> bool</autodoc> |
f32fc4bc RD |
26447 | <paramlist> |
26448 | <param name="x" type="int" default=""/> | |
26449 | <param name="y" type="int" default=""/> | |
26450 | </paramlist> | |
26451 | </method> | |
26452 | <method name="base_OnData" type="wxDragResult" overloaded="no"> | |
781d2982 | 26453 | <autodoc>base_OnData(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
26454 | <paramlist> |
26455 | <param name="x" type="int" default=""/> | |
26456 | <param name="y" type="int" default=""/> | |
26457 | <param name="def" type="wxDragResult" default=""/> | |
26458 | </paramlist> | |
26459 | </method> | |
26460 | </class> | |
781d2982 | 26461 | <class name="FileDropTarget" oldname="wxPyFileDropTarget" module="_misc"> |
f32fc4bc RD |
26462 | <baseclass name="DropTarget"/> |
26463 | <constructor name="wxPyFileDropTarget" overloaded="no"> | |
781d2982 | 26464 | <autodoc>__init__(self) -> FileDropTarget</autodoc> |
f32fc4bc RD |
26465 | </constructor> |
26466 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 26467 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
26468 | <paramlist> |
26469 | <param name="self" type="PyObject" default=""/> | |
26470 | <param name="_class" type="PyObject" default=""/> | |
26471 | </paramlist> | |
26472 | </method> | |
26473 | <method name="base_OnEnter" type="wxDragResult" overloaded="no"> | |
781d2982 | 26474 | <autodoc>base_OnEnter(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
26475 | <paramlist> |
26476 | <param name="x" type="int" default=""/> | |
26477 | <param name="y" type="int" default=""/> | |
26478 | <param name="def" type="wxDragResult" default=""/> | |
26479 | </paramlist> | |
26480 | </method> | |
26481 | <method name="base_OnDragOver" type="wxDragResult" overloaded="no"> | |
781d2982 | 26482 | <autodoc>base_OnDragOver(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
26483 | <paramlist> |
26484 | <param name="x" type="int" default=""/> | |
26485 | <param name="y" type="int" default=""/> | |
26486 | <param name="def" type="wxDragResult" default=""/> | |
26487 | </paramlist> | |
26488 | </method> | |
26489 | <method name="base_OnLeave" type="" overloaded="no"> | |
781d2982 | 26490 | <autodoc>base_OnLeave(self)</autodoc> |
f32fc4bc RD |
26491 | </method> |
26492 | <method name="base_OnDrop" type="bool" overloaded="no"> | |
781d2982 | 26493 | <autodoc>base_OnDrop(self, int x, int y) -> bool</autodoc> |
f32fc4bc RD |
26494 | <paramlist> |
26495 | <param name="x" type="int" default=""/> | |
26496 | <param name="y" type="int" default=""/> | |
26497 | </paramlist> | |
26498 | </method> | |
26499 | <method name="base_OnData" type="wxDragResult" overloaded="no"> | |
781d2982 | 26500 | <autodoc>base_OnData(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
26501 | <paramlist> |
26502 | <param name="x" type="int" default=""/> | |
26503 | <param name="y" type="int" default=""/> | |
26504 | <param name="def" type="wxDragResult" default=""/> | |
26505 | </paramlist> | |
26506 | </method> | |
26507 | </class> | |
0dd25e81 | 26508 | <pythoncode> |
f32fc4bc RD |
26509 | #--------------------------------------------------------------------------- |
26510 | </pythoncode> | |
781d2982 RD |
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 | |
26515 | instance. | |
26516 | ||
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 | |
26522 | only momentarily. | |
26523 | ||
26524 | :see: `wx.DataObject` | |
c2dda882 | 26525 | </docstring> |
f32fc4bc RD |
26526 | <baseclass name="Object"/> |
26527 | <constructor name="Clipboard" overloaded="no"> | |
781d2982 | 26528 | <autodoc>__init__(self) -> Clipboard</autodoc> |
f32fc4bc RD |
26529 | </constructor> |
26530 | <destructor name="~wxClipboard" overloaded="no"> | |
781d2982 | 26531 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
26532 | </destructor> |
26533 | <method name="Open" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26539 | </method> |
26540 | <method name="Close" type="" overloaded="no"> | |
781d2982 | 26541 | <autodoc>Close(self)</autodoc> |
c2dda882 | 26542 | <docstring>Closes the clipboard.</docstring> |
f32fc4bc RD |
26543 | </method> |
26544 | <method name="IsOpened" type="bool" overloaded="no"> | |
781d2982 | 26545 | <autodoc>IsOpened(self) -> bool</autodoc> |
c2dda882 | 26546 | <docstring>Query whether the clipboard is opened</docstring> |
f32fc4bc RD |
26547 | </method> |
26548 | <method name="AddData" type="bool" overloaded="no"> | |
781d2982 RD |
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. | |
c2dda882 | 26552 | After this function has been called, the clipboard owns the data, so |
781d2982 RD |
26553 | do not delete the data explicitly. |
26554 | ||
26555 | :see: `wx.DataObject`</docstring> | |
f32fc4bc RD |
26556 | <paramlist> |
26557 | <param name="data" type="DataObject" default=""/> | |
26558 | </paramlist> | |
26559 | </method> | |
26560 | <method name="SetData" type="bool" overloaded="no"> | |
781d2982 RD |
26561 | <autodoc>SetData(self, DataObject data) -> bool</autodoc> |
26562 | <docstring>Set the clipboard data, this is the same as `Clear` followed by | |
26563 | `AddData`. | |
26564 | ||
26565 | :see: `wx.DataObject`</docstring> | |
f32fc4bc RD |
26566 | <paramlist> |
26567 | <param name="data" type="DataObject" default=""/> | |
26568 | </paramlist> | |
26569 | </method> | |
26570 | <method name="IsSupported" type="bool" overloaded="no"> | |
781d2982 | 26571 | <autodoc>IsSupported(self, DataFormat format) -> bool</autodoc> |
c2dda882 RD |
26572 | <docstring>Returns True if the given format is available in the data object(s) on |
26573 | the clipboard.</docstring> | |
f32fc4bc RD |
26574 | <paramlist> |
26575 | <param name="format" type="DataFormat" default=""/> | |
26576 | </paramlist> | |
26577 | </method> | |
26578 | <method name="GetData" type="bool" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
26582 | <paramlist> |
26583 | <param name="data" type="DataObject" default=""/> | |
26584 | </paramlist> | |
26585 | </method> | |
26586 | <method name="Clear" type="" overloaded="no"> | |
781d2982 RD |
26587 | <autodoc>Clear(self)</autodoc> |
26588 | <docstring>Clears data from the clipboard object and also the system's clipboard | |
c2dda882 | 26589 | if possible.</docstring> |
f32fc4bc RD |
26590 | </method> |
26591 | <method name="Flush" type="bool" overloaded="no"> | |
781d2982 | 26592 | <autodoc>Flush(self) -> bool</autodoc> |
c2dda882 | 26593 | <docstring>Flushes the clipboard: this means that the data which is currently on |
781d2982 RD |
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> | |
f32fc4bc RD |
26597 | </method> |
26598 | <method name="UsePrimarySelection" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc | 26603 | <paramlist> |
c2dda882 | 26604 | <param name="primary" type="bool" default="True"/> |
f32fc4bc RD |
26605 | </paramlist> |
26606 | </method> | |
ce6878e6 RD |
26607 | <staticmethod name="Get" type="Clipboard" overloaded="no"> |
26608 | <autodoc>Get() -> Clipboard</autodoc> | |
26609 | <docstring>Returns global instance (wxTheClipboard) of the object.</docstring> | |
26610 | </staticmethod> | |
f32fc4bc | 26611 | </class> |
ce6878e6 RD |
26612 | <pythoncode> |
26613 | class _wxPyDelayedInitWrapper(object): | |
26614 | def __init__(self, initfunc, *args, **kwargs): | |
26615 | self._initfunc = initfunc | |
26616 | self._args = args | |
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) | |
26629 | </pythoncode> | |
781d2982 RD |
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> | |
f32fc4bc | 26633 | <constructor name="ClipboardLocker" overloaded="no"> |
781d2982 RD |
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> | |
f32fc4bc RD |
26637 | <paramlist> |
26638 | <param name="clipboard" type="Clipboard" default="NULL"/> | |
26639 | </paramlist> | |
26640 | </constructor> | |
26641 | <destructor name="~wxClipboardLocker" overloaded="no"> | |
781d2982 | 26642 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
26643 | </destructor> |
26644 | <method name="__nonzero__" type="bool" overloaded="no"> | |
781d2982 | 26645 | <autodoc>__nonzero__(self) -> bool</autodoc> |
c2dda882 RD |
26646 | <docstring>A ClipboardLocker instance evaluates to True if the clipboard was |
26647 | successfully opened.</docstring> | |
f32fc4bc RD |
26648 | </method> |
26649 | </class> | |
b39e211b RD |
26650 | <pythoncode> |
26651 | #--------------------------------------------------------------------------- | |
26652 | </pythoncode> | |
781d2982 | 26653 | <class name="VideoMode" oldname="wxVideoMode" module="_misc"> |
b39e211b RD |
26654 | <docstring>A simple struct containing video mode parameters for a display</docstring> |
26655 | <constructor name="VideoMode" overloaded="no"> | |
781d2982 | 26656 | <autodoc>__init__(self, int width=0, int height=0, int depth=0, int freq=0) -> VideoMode</autodoc> |
b39e211b RD |
26657 | <docstring>A simple struct containing video mode parameters for a display</docstring> |
26658 | <paramlist> | |
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"/> | |
26663 | </paramlist> | |
26664 | </constructor> | |
26665 | <destructor name="~wxVideoMode" overloaded="no"> | |
781d2982 | 26666 | <autodoc>__del__(self)</autodoc> |
b39e211b RD |
26667 | </destructor> |
26668 | <method name="Matches" type="bool" overloaded="no"> | |
781d2982 RD |
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 | |
b39e211b RD |
26672 | one (except for refresh which is allowed to have a greater value)</docstring> |
26673 | <paramlist> | |
26674 | <param name="other" type="VideoMode" default=""/> | |
26675 | </paramlist> | |
26676 | </method> | |
26677 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 RD |
26678 | <autodoc>GetWidth(self) -> int</autodoc> |
26679 | <docstring>Returns the screen width in pixels (e.g. 640*480), 0 means unspecified</docstring> | |
b39e211b RD |
26680 | </method> |
26681 | <method name="GetHeight" type="int" overloaded="no"> | |
781d2982 | 26682 | <autodoc>GetHeight(self) -> int</autodoc> |
b39e211b RD |
26683 | <docstring>Returns the screen width in pixels (e.g. 640*480), 0 means |
26684 | unspecified</docstring> | |
26685 | </method> | |
26686 | <method name="GetDepth" type="int" overloaded="no"> | |
781d2982 RD |
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> | |
b39e211b RD |
26690 | </method> |
26691 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 26692 | <autodoc>IsOk(self) -> bool</autodoc> |
b39e211b RD |
26693 | <docstring>returns true if the object has been initialized</docstring> |
26694 | </method> | |
26695 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 26696 | <autodoc>__eq__(self, VideoMode other) -> bool</autodoc> |
b39e211b RD |
26697 | <paramlist> |
26698 | <param name="other" type="VideoMode" default=""/> | |
26699 | </paramlist> | |
26700 | </method> | |
26701 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 26702 | <autodoc>__ne__(self, VideoMode other) -> bool</autodoc> |
b39e211b RD |
26703 | <paramlist> |
26704 | <param name="other" type="VideoMode" default=""/> | |
26705 | </paramlist> | |
26706 | </method> | |
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"/> | |
26711 | </class> | |
781d2982 | 26712 | <class name="Display" oldname="wxDisplay" module="_misc"> |
b39e211b RD |
26713 | <docstring>Represents a display/monitor attached to the system</docstring> |
26714 | <constructor name="Display" overloaded="no"> | |
781d2982 RD |
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> | |
b39e211b RD |
26719 | <paramlist> |
26720 | <param name="index" type="size_t" default="0"/> | |
26721 | </paramlist> | |
26722 | </constructor> | |
26723 | <destructor name="~wxDisplay" overloaded="no"> | |
781d2982 | 26724 | <autodoc>__del__(self)</autodoc> |
b39e211b RD |
26725 | </destructor> |
26726 | <staticmethod name="GetCount" type="size_t" overloaded="no"> | |
26727 | <autodoc>GetCount() -> size_t</autodoc> | |
26728 | <docstring>Return the number of available displays.</docstring> | |
26729 | </staticmethod> | |
26730 | <staticmethod name="GetFromPoint" type="int" overloaded="no"> | |
26731 | <autodoc>GetFromPoint(Point pt) -> int</autodoc> | |
781d2982 RD |
26732 | <docstring>Find the display where the given point lies, return wx.NOT_FOUND if it |
26733 | doesn't belong to any display</docstring> | |
b39e211b RD |
26734 | <paramlist> |
26735 | <param name="pt" type="Point" default=""/> | |
26736 | </paramlist> | |
26737 | </staticmethod> | |
26738 | <staticmethod name="GetFromWindow" type="int" overloaded="no"> | |
26739 | <autodoc>GetFromWindow(Window window) -> int</autodoc> | |
781d2982 RD |
26740 | <docstring>Find the display where the given window lies, return wx.NOT_FOUND if |
26741 | it is not shown at all.</docstring> | |
b39e211b RD |
26742 | <paramlist> |
26743 | <param name="window" type="Window" default=""/> | |
26744 | </paramlist> | |
26745 | </staticmethod> | |
26746 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 26747 | <autodoc>IsOk(self) -> bool</autodoc> |
b39e211b RD |
26748 | <docstring>Return true if the object was initialized successfully</docstring> |
26749 | </method> | |
26750 | <method name="GetGeometry" type="Rect" overloaded="no"> | |
781d2982 RD |
26751 | <autodoc>GetGeometry(self) -> Rect</autodoc> |
26752 | <docstring>Returns the bounding rectangle of the display whose index was passed | |
26753 | to the constructor.</docstring> | |
b39e211b RD |
26754 | </method> |
26755 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 26756 | <autodoc>GetName(self) -> String</autodoc> |
b39e211b RD |
26757 | <docstring>Returns the display's name. A name is not available on all platforms.</docstring> |
26758 | </method> | |
26759 | <method name="IsPrimary" type="bool" overloaded="no"> | |
781d2982 | 26760 | <autodoc>IsPrimary(self) -> bool</autodoc> |
b39e211b RD |
26761 | <docstring>Returns true if the display is the primary display. The primary |
26762 | display is the one whose index is 0.</docstring> | |
26763 | </method> | |
26764 | <method name="GetModes" type="PyObject" overloaded="no"> | |
26765 | <autodoc>GetModes(VideoMode mode=DefaultVideoMode) -> [videoMode...]</autodoc> | |
781d2982 RD |
26766 | <docstring>Enumerate all video modes supported by this display matching the given |
26767 | one (in the sense of VideoMode.Match()). | |
b39e211b | 26768 | |
781d2982 RD |
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> | |
b39e211b RD |
26773 | <paramlist> |
26774 | <param name="mode" type="VideoMode" default="wxDefaultVideoMode"/> | |
26775 | </paramlist> | |
26776 | </method> | |
26777 | <method name="GetCurrentMode" type="VideoMode" overloaded="no"> | |
781d2982 | 26778 | <autodoc>GetCurrentMode(self) -> VideoMode</autodoc> |
b39e211b RD |
26779 | <docstring>Get the current video mode.</docstring> |
26780 | </method> | |
26781 | <method name="ChangeMode" type="bool" overloaded="no"> | |
781d2982 | 26782 | <autodoc>ChangeMode(self, VideoMode mode=DefaultVideoMode) -> bool</autodoc> |
ce6878e6 RD |
26783 | <docstring>Changes the video mode of this display to the mode specified in the |
26784 | mode parameter. | |
26785 | ||
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. | |
26792 | ||
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. | |
26797 | ||
26798 | Returns True if succeeded, False otherwise</docstring> | |
b39e211b RD |
26799 | <paramlist> |
26800 | <param name="mode" type="VideoMode" default="wxDefaultVideoMode"/> | |
26801 | </paramlist> | |
26802 | </method> | |
26803 | <method name="ResetMode" type="" overloaded="no"> | |
781d2982 | 26804 | <autodoc>ResetMode(self)</autodoc> |
b39e211b RD |
26805 | <docstring>Restore the default video mode (just a more readable synonym)</docstring> |
26806 | </method> | |
26807 | </class> | |
f32fc4bc RD |
26808 | </module> |
26809 | <module name="calendar"> | |
781d2982 RD |
26810 | <import name="_misc"/> |
26811 | <pythoncode> wx = _core </pythoncode> | |
26812 | <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode> | |
f32fc4bc | 26813 | <class name="CalendarDateAttr" oldname="wxCalendarDateAttr" module="calendar"> |
781d2982 RD |
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> | |
f32fc4bc | 26816 | <constructor name="CalendarDateAttr" overloaded="no"> |
781d2982 | 26817 | <autodoc>__init__(self, Colour colText=wxNullColour, Colour colBack=wxNullColour, |
f32fc4bc RD |
26818 | Colour colBorder=wxNullColour, Font font=wxNullFont, |
26819 | int border=CAL_BORDER_NONE) -> CalendarDateAttr</autodoc> | |
26820 | <docstring>Create a CalendarDateAttr.</docstring> | |
26821 | <paramlist> | |
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"/> | |
26827 | </paramlist> | |
26828 | </constructor> | |
26829 | <method name="SetTextColour" type="" overloaded="no"> | |
781d2982 | 26830 | <autodoc>SetTextColour(self, Colour colText)</autodoc> |
f32fc4bc RD |
26831 | <paramlist> |
26832 | <param name="colText" type="Colour" default=""/> | |
26833 | </paramlist> | |
26834 | </method> | |
26835 | <method name="SetBackgroundColour" type="" overloaded="no"> | |
781d2982 | 26836 | <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc> |
f32fc4bc RD |
26837 | <paramlist> |
26838 | <param name="colBack" type="Colour" default=""/> | |
26839 | </paramlist> | |
26840 | </method> | |
26841 | <method name="SetBorderColour" type="" overloaded="no"> | |
781d2982 | 26842 | <autodoc>SetBorderColour(self, Colour col)</autodoc> |
f32fc4bc RD |
26843 | <paramlist> |
26844 | <param name="col" type="Colour" default=""/> | |
26845 | </paramlist> | |
26846 | </method> | |
26847 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 26848 | <autodoc>SetFont(self, Font font)</autodoc> |
f32fc4bc RD |
26849 | <paramlist> |
26850 | <param name="font" type="Font" default=""/> | |
26851 | </paramlist> | |
26852 | </method> | |
26853 | <method name="SetBorder" type="" overloaded="no"> | |
781d2982 | 26854 | <autodoc>SetBorder(self, int border)</autodoc> |
f32fc4bc RD |
26855 | <paramlist> |
26856 | <param name="border" type="wxCalendarDateBorder" default=""/> | |
26857 | </paramlist> | |
26858 | </method> | |
26859 | <method name="SetHoliday" type="" overloaded="no"> | |
781d2982 | 26860 | <autodoc>SetHoliday(self, bool holiday)</autodoc> |
f32fc4bc RD |
26861 | <paramlist> |
26862 | <param name="holiday" type="bool" default=""/> | |
26863 | </paramlist> | |
26864 | </method> | |
26865 | <method name="HasTextColour" type="bool" overloaded="no"> | |
781d2982 | 26866 | <autodoc>HasTextColour(self) -> bool</autodoc> |
f32fc4bc RD |
26867 | </method> |
26868 | <method name="HasBackgroundColour" type="bool" overloaded="no"> | |
781d2982 | 26869 | <autodoc>HasBackgroundColour(self) -> bool</autodoc> |
f32fc4bc RD |
26870 | </method> |
26871 | <method name="HasBorderColour" type="bool" overloaded="no"> | |
781d2982 | 26872 | <autodoc>HasBorderColour(self) -> bool</autodoc> |
f32fc4bc RD |
26873 | </method> |
26874 | <method name="HasFont" type="bool" overloaded="no"> | |
781d2982 | 26875 | <autodoc>HasFont(self) -> bool</autodoc> |
f32fc4bc RD |
26876 | </method> |
26877 | <method name="HasBorder" type="bool" overloaded="no"> | |
781d2982 | 26878 | <autodoc>HasBorder(self) -> bool</autodoc> |
f32fc4bc RD |
26879 | </method> |
26880 | <method name="IsHoliday" type="bool" overloaded="no"> | |
781d2982 | 26881 | <autodoc>IsHoliday(self) -> bool</autodoc> |
f32fc4bc RD |
26882 | </method> |
26883 | <method name="GetTextColour" type="Colour" overloaded="no"> | |
781d2982 | 26884 | <autodoc>GetTextColour(self) -> Colour</autodoc> |
f32fc4bc RD |
26885 | </method> |
26886 | <method name="GetBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 26887 | <autodoc>GetBackgroundColour(self) -> Colour</autodoc> |
f32fc4bc RD |
26888 | </method> |
26889 | <method name="GetBorderColour" type="Colour" overloaded="no"> | |
781d2982 | 26890 | <autodoc>GetBorderColour(self) -> Colour</autodoc> |
f32fc4bc RD |
26891 | </method> |
26892 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 26893 | <autodoc>GetFont(self) -> Font</autodoc> |
f32fc4bc RD |
26894 | </method> |
26895 | <method name="GetBorder" type="wxCalendarDateBorder" overloaded="no"> | |
781d2982 | 26896 | <autodoc>GetBorder(self) -> int</autodoc> |
f32fc4bc RD |
26897 | </method> |
26898 | </class> | |
26899 | <class name="CalendarEvent" oldname="wxCalendarEvent" module="calendar"> | |
26900 | <baseclass name="CommandEvent"/> | |
26901 | <constructor name="CalendarEvent" overloaded="no"> | |
781d2982 | 26902 | <autodoc>__init__(self, CalendarCtrl cal, wxEventType type) -> CalendarEvent</autodoc> |
f32fc4bc RD |
26903 | <paramlist> |
26904 | <param name="cal" type="wxCalendarCtrl" default=""/> | |
26905 | <param name="type" type="wxEventType" default=""/> | |
26906 | </paramlist> | |
26907 | </constructor> | |
26908 | <method name="GetDate" type="DateTime" overloaded="no"> | |
781d2982 | 26909 | <autodoc>GetDate(self) -> DateTime</autodoc> |
f32fc4bc RD |
26910 | </method> |
26911 | <method name="SetDate" type="" overloaded="no"> | |
781d2982 | 26912 | <autodoc>SetDate(self, DateTime date)</autodoc> |
f32fc4bc RD |
26913 | <paramlist> |
26914 | <param name="date" type="DateTime" default=""/> | |
26915 | </paramlist> | |
26916 | </method> | |
26917 | <method name="SetWeekDay" type="" overloaded="no"> | |
781d2982 | 26918 | <autodoc>SetWeekDay(self, int wd)</autodoc> |
f32fc4bc RD |
26919 | <paramlist> |
26920 | <param name="wd" type="wxDateTime::WeekDay" default=""/> | |
26921 | </paramlist> | |
26922 | </method> | |
26923 | <method name="GetWeekDay" type="wxDateTime::WeekDay" overloaded="no"> | |
781d2982 | 26924 | <autodoc>GetWeekDay(self) -> int</autodoc> |
f32fc4bc RD |
26925 | </method> |
26926 | </class> | |
26927 | <pythoncode> | |
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) | |
26934 | </pythoncode> | |
26935 | <class name="CalendarCtrl" oldname="wxCalendarCtrl" module="calendar"> | |
781d2982 RD |
26936 | <docstring>The calendar control allows the user to pick a date interactively. |
26937 | ||
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. | |
26944 | ||
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. | |
26949 | ||
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. | |
26956 | ||
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 | |
ce6878e6 RD |
26959 | EVT_CALENDAR_MONTH event handler. |
26960 | ||
26961 | Window Styles | |
26962 | ------------- | |
26963 | ============================== ============================ | |
26964 | CAL_SUNDAY_FIRST Show Sunday as the first day | |
26965 | in the week | |
26966 | CAL_MONDAY_FIRST Show Monday as the first day | |
26967 | in the week | |
26968 | CAL_SHOW_HOLIDAYS Highlight holidays in the | |
26969 | calendar | |
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 | ============================== ============================ | |
26979 | ||
26980 | The default calendar style is CAL_SHOW_HOLIDAYS. | |
26981 | ||
26982 | Events | |
26983 | ------- | |
26984 | ============================= ============================== | |
26985 | EVT_CALENDAR A day was double clicked in the | |
26986 | calendar. | |
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 | |
26992 | header | |
26993 | ============================= ============================== | |
26994 | ||
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 | |
26997 | event. | |
26998 | ||
26999 | </docstring> | |
f32fc4bc RD |
27000 | <baseclass name="Control"/> |
27001 | <constructor name="CalendarCtrl" overloaded="no"> | |
781d2982 | 27002 | <autodoc>__init__(self, Window parent, int id=-1, DateTime date=DefaultDateTime, |
f32fc4bc RD |
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> | |
f32fc4bc RD |
27007 | <paramlist> |
27008 | <param name="parent" type="Window" default=""/> | |
781d2982 | 27009 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
27015 | </paramlist> | |
27016 | </constructor> | |
27017 | <constructor name="PreCalendarCtrl" overloaded="no"> | |
27018 | <autodoc>PreCalendarCtrl() -> CalendarCtrl</autodoc> | |
27019 | <docstring>Precreate a CalendarCtrl for 2-phase creation.</docstring> | |
f32fc4bc RD |
27020 | </constructor> |
27021 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 27022 | <autodoc>Create(self, Window parent, int id, DateTime date=DefaultDateTime, |
f32fc4bc RD |
27023 | Point pos=DefaultPosition, Size size=DefaultSize, |
27024 | long style=wxCAL_SHOW_HOLIDAYS|wxWANTS_CHARS, | |
27025 | String name=CalendarNameStr) -> bool</autodoc> | |
781d2982 RD |
27026 | <docstring>Acutally create the GUI portion of the CalendarCtrl for 2-phase |
27027 | creation.</docstring> | |
f32fc4bc RD |
27028 | <paramlist> |
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"/> | |
27036 | </paramlist> | |
27037 | </method> | |
27038 | <method name="SetDate" type="" overloaded="no"> | |
781d2982 | 27039 | <autodoc>SetDate(self, DateTime date)</autodoc> |
f32fc4bc RD |
27040 | <docstring>Sets the current date.</docstring> |
27041 | <paramlist> | |
27042 | <param name="date" type="DateTime" default=""/> | |
27043 | </paramlist> | |
27044 | </method> | |
27045 | <method name="GetDate" type="DateTime" overloaded="no"> | |
781d2982 | 27046 | <autodoc>GetDate(self) -> DateTime</autodoc> |
f32fc4bc RD |
27047 | <docstring>Gets the currently selected date.</docstring> |
27048 | </method> | |
27049 | <method name="SetLowerDateLimit" type="bool" overloaded="no"> | |
781d2982 | 27050 | <autodoc>SetLowerDateLimit(self, DateTime date=DefaultDateTime) -> bool</autodoc> |
f32fc4bc RD |
27051 | <docstring>set the range in which selection can occur</docstring> |
27052 | <paramlist> | |
27053 | <param name="date" type="DateTime" default="wxDefaultDateTime"/> | |
27054 | </paramlist> | |
27055 | </method> | |
27056 | <method name="SetUpperDateLimit" type="bool" overloaded="no"> | |
781d2982 | 27057 | <autodoc>SetUpperDateLimit(self, DateTime date=DefaultDateTime) -> bool</autodoc> |
f32fc4bc RD |
27058 | <docstring>set the range in which selection can occur</docstring> |
27059 | <paramlist> | |
27060 | <param name="date" type="DateTime" default="wxDefaultDateTime"/> | |
27061 | </paramlist> | |
27062 | </method> | |
27063 | <method name="GetLowerDateLimit" type="DateTime" overloaded="no"> | |
781d2982 | 27064 | <autodoc>GetLowerDateLimit(self) -> DateTime</autodoc> |
f32fc4bc RD |
27065 | <docstring>get the range in which selection can occur</docstring> |
27066 | </method> | |
27067 | <method name="GetUpperDateLimit" type="DateTime" overloaded="no"> | |
781d2982 | 27068 | <autodoc>GetUpperDateLimit(self) -> DateTime</autodoc> |
f32fc4bc RD |
27069 | <docstring>get the range in which selection can occur</docstring> |
27070 | </method> | |
27071 | <method name="SetDateRange" type="bool" overloaded="no"> | |
781d2982 | 27072 | <autodoc>SetDateRange(self, DateTime lowerdate=DefaultDateTime, DateTime upperdate=DefaultDateTime) -> bool</autodoc> |
f32fc4bc RD |
27073 | <docstring>set the range in which selection can occur</docstring> |
27074 | <paramlist> | |
27075 | <param name="lowerdate" type="DateTime" default="wxDefaultDateTime"/> | |
27076 | <param name="upperdate" type="DateTime" default="wxDefaultDateTime"/> | |
27077 | </paramlist> | |
27078 | </method> | |
27079 | <method name="EnableYearChange" type="" overloaded="no"> | |
781d2982 | 27080 | <autodoc>EnableYearChange(self, bool enable=True)</autodoc> |
f32fc4bc RD |
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> | |
27084 | <paramlist> | |
27085 | <param name="enable" type="bool" default="True"/> | |
27086 | </paramlist> | |
27087 | </method> | |
27088 | <method name="EnableMonthChange" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
27094 | <paramlist> |
27095 | <param name="enable" type="bool" default="True"/> | |
27096 | </paramlist> | |
27097 | </method> | |
27098 | <method name="EnableHolidayDisplay" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
27103 | <paramlist> |
27104 | <param name="display" type="bool" default="True"/> | |
27105 | </paramlist> | |
27106 | </method> | |
27107 | <method name="SetHeaderColours" type="" overloaded="no"> | |
781d2982 RD |
27108 | <autodoc>SetHeaderColours(self, Colour colFg, Colour colBg)</autodoc> |
27109 | <docstring>Header colours are used for painting the weekdays at the top.</docstring> | |
f32fc4bc RD |
27110 | <paramlist> |
27111 | <param name="colFg" type="Colour" default=""/> | |
27112 | <param name="colBg" type="Colour" default=""/> | |
27113 | </paramlist> | |
27114 | </method> | |
27115 | <method name="GetHeaderColourFg" type="Colour" overloaded="no"> | |
781d2982 RD |
27116 | <autodoc>GetHeaderColourFg(self) -> Colour</autodoc> |
27117 | <docstring>Header colours are used for painting the weekdays at the top.</docstring> | |
f32fc4bc RD |
27118 | </method> |
27119 | <method name="GetHeaderColourBg" type="Colour" overloaded="no"> | |
781d2982 RD |
27120 | <autodoc>GetHeaderColourBg(self) -> Colour</autodoc> |
27121 | <docstring>Header colours are used for painting the weekdays at the top.</docstring> | |
f32fc4bc RD |
27122 | </method> |
27123 | <method name="SetHighlightColours" type="" overloaded="no"> | |
781d2982 RD |
27124 | <autodoc>SetHighlightColours(self, Colour colFg, Colour colBg)</autodoc> |
27125 | <docstring>Highlight colour is used for the currently selected date.</docstring> | |
f32fc4bc RD |
27126 | <paramlist> |
27127 | <param name="colFg" type="Colour" default=""/> | |
27128 | <param name="colBg" type="Colour" default=""/> | |
27129 | </paramlist> | |
27130 | </method> | |
27131 | <method name="GetHighlightColourFg" type="Colour" overloaded="no"> | |
781d2982 RD |
27132 | <autodoc>GetHighlightColourFg(self) -> Colour</autodoc> |
27133 | <docstring>Highlight colour is used for the currently selected date.</docstring> | |
f32fc4bc RD |
27134 | </method> |
27135 | <method name="GetHighlightColourBg" type="Colour" overloaded="no"> | |
781d2982 RD |
27136 | <autodoc>GetHighlightColourBg(self) -> Colour</autodoc> |
27137 | <docstring>Highlight colour is used for the currently selected date.</docstring> | |
f32fc4bc RD |
27138 | </method> |
27139 | <method name="SetHolidayColours" type="" overloaded="no"> | |
781d2982 RD |
27140 | <autodoc>SetHolidayColours(self, Colour colFg, Colour colBg)</autodoc> |
27141 | <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is | |
27142 | used).</docstring> | |
f32fc4bc RD |
27143 | <paramlist> |
27144 | <param name="colFg" type="Colour" default=""/> | |
27145 | <param name="colBg" type="Colour" default=""/> | |
27146 | </paramlist> | |
27147 | </method> | |
27148 | <method name="GetHolidayColourFg" type="Colour" overloaded="no"> | |
781d2982 RD |
27149 | <autodoc>GetHolidayColourFg(self) -> Colour</autodoc> |
27150 | <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is | |
27151 | used).</docstring> | |
f32fc4bc RD |
27152 | </method> |
27153 | <method name="GetHolidayColourBg" type="Colour" overloaded="no"> | |
781d2982 RD |
27154 | <autodoc>GetHolidayColourBg(self) -> Colour</autodoc> |
27155 | <docstring>Holiday colour is used for the holidays (if CAL_SHOW_HOLIDAYS style is | |
27156 | used).</docstring> | |
f32fc4bc RD |
27157 | </method> |
27158 | <method name="GetAttr" type="CalendarDateAttr" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
27162 | <paramlist> |
27163 | <param name="day" type="size_t" default=""/> | |
27164 | </paramlist> | |
27165 | </method> | |
27166 | <method name="SetAttr" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
27171 | <paramlist> |
27172 | <param name="day" type="size_t" default=""/> | |
27173 | <param name="attr" type="CalendarDateAttr" default=""/> | |
27174 | </paramlist> | |
27175 | </method> | |
27176 | <method name="SetHoliday" type="" overloaded="no"> | |
781d2982 | 27177 | <autodoc>SetHoliday(self, size_t day)</autodoc> |
f32fc4bc RD |
27178 | <docstring>Marks the specified day as being a holiday in the current month.</docstring> |
27179 | <paramlist> | |
27180 | <param name="day" type="size_t" default=""/> | |
27181 | </paramlist> | |
27182 | </method> | |
27183 | <method name="ResetAttr" type="" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
27187 | <paramlist> |
27188 | <param name="day" type="size_t" default=""/> | |
27189 | </paramlist> | |
27190 | </method> | |
27191 | <method name="HitTest" type="PyObject" overloaded="no"> | |
27192 | <autodoc>HitTest(Point pos) -> (result, date, weekday)</autodoc> | |
781d2982 RD |
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 | |
ce6878e6 RD |
27195 | determines the validity of the remaining two values. |
27196 | The result codes are: | |
27197 | ||
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 | =================== ============================================ | |
27203 | </docstring> | |
f32fc4bc RD |
27204 | <paramlist> |
27205 | <param name="pos" type="Point" default=""/> | |
27206 | </paramlist> | |
27207 | </method> | |
27208 | <method name="GetMonthControl" type="Control" overloaded="no"> | |
781d2982 RD |
27209 | <autodoc>GetMonthControl(self) -> Control</autodoc> |
27210 | <docstring>Get the currently shown control for month.</docstring> | |
f32fc4bc RD |
27211 | </method> |
27212 | <method name="GetYearControl" type="Control" overloaded="no"> | |
781d2982 RD |
27213 | <autodoc>GetYearControl(self) -> Control</autodoc> |
27214 | <docstring>Get the currently shown control for year.</docstring> | |
f32fc4bc | 27215 | </method> |
781d2982 RD |
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. | |
27223 | ||
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 | |
27227 | this.</docstring> | |
27228 | <paramlist> | |
27229 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
27230 | </paramlist> | |
27231 | </staticmethod> | |
f32fc4bc RD |
27232 | </class> |
27233 | </module> | |
27234 | <module name="grid"> | |
781d2982 RD |
27235 | <import name="_windows"/> |
27236 | <pythoncode> wx = _core </pythoncode> | |
27237 | <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode> | |
f32fc4bc RD |
27238 | <class name="GridCellRenderer" oldname="wxGridCellRenderer" module="grid"> |
27239 | <method name="_setOORInfo" type="" overloaded="no"> | |
781d2982 | 27240 | <autodoc>_setOORInfo(self, PyObject _self)</autodoc> |
f32fc4bc RD |
27241 | <paramlist> |
27242 | <param name="_self" type="PyObject" default=""/> | |
27243 | </paramlist> | |
27244 | </method> | |
27245 | <method name="SetParameters" type="" overloaded="no"> | |
781d2982 | 27246 | <autodoc>SetParameters(self, String params)</autodoc> |
f32fc4bc RD |
27247 | <paramlist> |
27248 | <param name="params" type="String" default=""/> | |
27249 | </paramlist> | |
27250 | </method> | |
27251 | <method name="IncRef" type="" overloaded="no"> | |
781d2982 | 27252 | <autodoc>IncRef(self)</autodoc> |
f32fc4bc RD |
27253 | </method> |
27254 | <method name="DecRef" type="" overloaded="no"> | |
781d2982 | 27255 | <autodoc>DecRef(self)</autodoc> |
f32fc4bc RD |
27256 | </method> |
27257 | <method name="Draw" type="" overloaded="no"> | |
781d2982 | 27258 | <autodoc>Draw(self, Grid grid, GridCellAttr attr, DC dc, Rect rect, int row, |
f32fc4bc RD |
27259 | int col, bool isSelected)</autodoc> |
27260 | <paramlist> | |
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=""/> | |
27268 | </paramlist> | |
27269 | </method> | |
27270 | <method name="GetBestSize" type="Size" overloaded="no"> | |
781d2982 | 27271 | <autodoc>GetBestSize(self, Grid grid, GridCellAttr attr, DC dc, int row, int col) -> Size</autodoc> |
f32fc4bc RD |
27272 | <paramlist> |
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=""/> | |
27278 | </paramlist> | |
27279 | </method> | |
27280 | <method name="Clone" type="GridCellRenderer" overloaded="no"> | |
781d2982 | 27281 | <autodoc>Clone(self) -> GridCellRenderer</autodoc> |
f32fc4bc RD |
27282 | </method> |
27283 | </class> | |
27284 | <class name="PyGridCellRenderer" oldname="wxPyGridCellRenderer" module="grid"> | |
27285 | <baseclass name="GridCellRenderer"/> | |
27286 | <constructor name="PyGridCellRenderer" overloaded="no"> | |
781d2982 | 27287 | <autodoc>__init__(self) -> PyGridCellRenderer</autodoc> |
f32fc4bc RD |
27288 | </constructor> |
27289 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 27290 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
27291 | <paramlist> |
27292 | <param name="self" type="PyObject" default=""/> | |
27293 | <param name="_class" type="PyObject" default=""/> | |
27294 | </paramlist> | |
27295 | </method> | |
27296 | <method name="base_SetParameters" type="" overloaded="no"> | |
781d2982 | 27297 | <autodoc>base_SetParameters(self, String params)</autodoc> |
f32fc4bc RD |
27298 | <paramlist> |
27299 | <param name="params" type="String" default=""/> | |
27300 | </paramlist> | |
27301 | </method> | |
27302 | </class> | |
27303 | <class name="GridCellStringRenderer" oldname="wxGridCellStringRenderer" module="grid"> | |
27304 | <baseclass name="GridCellRenderer"/> | |
27305 | <constructor name="GridCellStringRenderer" overloaded="no"> | |
781d2982 | 27306 | <autodoc>__init__(self) -> GridCellStringRenderer</autodoc> |
f32fc4bc RD |
27307 | </constructor> |
27308 | </class> | |
27309 | <class name="GridCellNumberRenderer" oldname="wxGridCellNumberRenderer" module="grid"> | |
27310 | <baseclass name="GridCellStringRenderer"/> | |
27311 | <constructor name="GridCellNumberRenderer" overloaded="no"> | |
781d2982 | 27312 | <autodoc>__init__(self) -> GridCellNumberRenderer</autodoc> |
f32fc4bc RD |
27313 | </constructor> |
27314 | </class> | |
27315 | <class name="GridCellFloatRenderer" oldname="wxGridCellFloatRenderer" module="grid"> | |
27316 | <baseclass name="GridCellStringRenderer"/> | |
27317 | <constructor name="GridCellFloatRenderer" overloaded="no"> | |
781d2982 | 27318 | <autodoc>__init__(self, int width=-1, int precision=-1) -> GridCellFloatRenderer</autodoc> |
f32fc4bc RD |
27319 | <paramlist> |
27320 | <param name="width" type="int" default="-1"/> | |
27321 | <param name="precision" type="int" default="-1"/> | |
27322 | </paramlist> | |
27323 | </constructor> | |
27324 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 27325 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
27326 | </method> |
27327 | <method name="SetWidth" type="" overloaded="no"> | |
781d2982 | 27328 | <autodoc>SetWidth(self, int width)</autodoc> |
f32fc4bc RD |
27329 | <paramlist> |
27330 | <param name="width" type="int" default=""/> | |
27331 | </paramlist> | |
27332 | </method> | |
27333 | <method name="GetPrecision" type="int" overloaded="no"> | |
781d2982 | 27334 | <autodoc>GetPrecision(self) -> int</autodoc> |
f32fc4bc RD |
27335 | </method> |
27336 | <method name="SetPrecision" type="" overloaded="no"> | |
781d2982 | 27337 | <autodoc>SetPrecision(self, int precision)</autodoc> |
f32fc4bc RD |
27338 | <paramlist> |
27339 | <param name="precision" type="int" default=""/> | |
27340 | </paramlist> | |
27341 | </method> | |
27342 | </class> | |
27343 | <class name="GridCellBoolRenderer" oldname="wxGridCellBoolRenderer" module="grid"> | |
27344 | <baseclass name="GridCellRenderer"/> | |
27345 | <constructor name="GridCellBoolRenderer" overloaded="no"> | |
781d2982 | 27346 | <autodoc>__init__(self) -> GridCellBoolRenderer</autodoc> |
f32fc4bc RD |
27347 | </constructor> |
27348 | </class> | |
27349 | <class name="GridCellDateTimeRenderer" oldname="wxGridCellDateTimeRenderer" module="grid"> | |
27350 | <baseclass name="GridCellStringRenderer"/> | |
27351 | <constructor name="GridCellDateTimeRenderer" overloaded="no"> | |
781d2982 | 27352 | <autodoc>__init__(self, String outformat=DateTimeFormatStr, String informat=DateTimeFormatStr) -> GridCellDateTimeRenderer</autodoc> |
f32fc4bc RD |
27353 | <paramlist> |
27354 | <param name="outformat" type="String" default="wxPyDateTimeFormatStr"/> | |
27355 | <param name="informat" type="String" default="wxPyDateTimeFormatStr"/> | |
27356 | </paramlist> | |
27357 | </constructor> | |
27358 | </class> | |
27359 | <class name="GridCellEnumRenderer" oldname="wxGridCellEnumRenderer" module="grid"> | |
27360 | <baseclass name="GridCellStringRenderer"/> | |
27361 | <constructor name="GridCellEnumRenderer" overloaded="no"> | |
781d2982 | 27362 | <autodoc>__init__(self, String choices=EmptyString) -> GridCellEnumRenderer</autodoc> |
f32fc4bc RD |
27363 | <paramlist> |
27364 | <param name="choices" type="String" default="wxPyEmptyString"/> | |
27365 | </paramlist> | |
27366 | </constructor> | |
27367 | </class> | |
27368 | <class name="GridCellAutoWrapStringRenderer" oldname="wxGridCellAutoWrapStringRenderer" module="grid"> | |
27369 | <baseclass name="GridCellStringRenderer"/> | |
27370 | <constructor name="GridCellAutoWrapStringRenderer" overloaded="no"> | |
781d2982 | 27371 | <autodoc>__init__(self) -> GridCellAutoWrapStringRenderer</autodoc> |
f32fc4bc RD |
27372 | </constructor> |
27373 | </class> | |
27374 | <class name="GridCellEditor" oldname="wxGridCellEditor" module="grid"> | |
27375 | <method name="_setOORInfo" type="" overloaded="no"> | |
781d2982 | 27376 | <autodoc>_setOORInfo(self, PyObject _self)</autodoc> |
f32fc4bc RD |
27377 | <paramlist> |
27378 | <param name="_self" type="PyObject" default=""/> | |
27379 | </paramlist> | |
27380 | </method> | |
27381 | <method name="IsCreated" type="bool" overloaded="no"> | |
781d2982 | 27382 | <autodoc>IsCreated(self) -> bool</autodoc> |
f32fc4bc RD |
27383 | </method> |
27384 | <method name="GetControl" type="Control" overloaded="no"> | |
781d2982 | 27385 | <autodoc>GetControl(self) -> Control</autodoc> |
f32fc4bc RD |
27386 | </method> |
27387 | <method name="SetControl" type="" overloaded="no"> | |
781d2982 | 27388 | <autodoc>SetControl(self, Control control)</autodoc> |
f32fc4bc RD |
27389 | <paramlist> |
27390 | <param name="control" type="Control" default=""/> | |
27391 | </paramlist> | |
27392 | </method> | |
27393 | <method name="GetCellAttr" type="wxGridCellAttr" overloaded="no"> | |
781d2982 | 27394 | <autodoc>GetCellAttr(self) -> GridCellAttr</autodoc> |
f32fc4bc RD |
27395 | </method> |
27396 | <method name="SetCellAttr" type="" overloaded="no"> | |
781d2982 | 27397 | <autodoc>SetCellAttr(self, GridCellAttr attr)</autodoc> |
f32fc4bc RD |
27398 | <paramlist> |
27399 | <param name="attr" type="wxGridCellAttr" default=""/> | |
27400 | </paramlist> | |
27401 | </method> | |
27402 | <method name="SetParameters" type="" overloaded="no"> | |
781d2982 | 27403 | <autodoc>SetParameters(self, String params)</autodoc> |
f32fc4bc RD |
27404 | <paramlist> |
27405 | <param name="params" type="String" default=""/> | |
27406 | </paramlist> | |
27407 | </method> | |
27408 | <method name="IncRef" type="" overloaded="no"> | |
781d2982 | 27409 | <autodoc>IncRef(self)</autodoc> |
f32fc4bc RD |
27410 | </method> |
27411 | <method name="DecRef" type="" overloaded="no"> | |
781d2982 | 27412 | <autodoc>DecRef(self)</autodoc> |
f32fc4bc RD |
27413 | </method> |
27414 | <method name="Create" type="" overloaded="no"> | |
781d2982 | 27415 | <autodoc>Create(self, Window parent, int id, EvtHandler evtHandler)</autodoc> |
f32fc4bc RD |
27416 | <paramlist> |
27417 | <param name="parent" type="Window" default=""/> | |
27418 | <param name="id" type="int" default=""/> | |
27419 | <param name="evtHandler" type="EvtHandler" default=""/> | |
27420 | </paramlist> | |
27421 | </method> | |
27422 | <method name="BeginEdit" type="" overloaded="no"> | |
781d2982 | 27423 | <autodoc>BeginEdit(self, int row, int col, Grid grid)</autodoc> |
f32fc4bc RD |
27424 | <paramlist> |
27425 | <param name="row" type="int" default=""/> | |
27426 | <param name="col" type="int" default=""/> | |
27427 | <param name="grid" type="wxGrid" default=""/> | |
27428 | </paramlist> | |
27429 | </method> | |
27430 | <method name="EndEdit" type="bool" overloaded="no"> | |
781d2982 | 27431 | <autodoc>EndEdit(self, int row, int col, Grid grid) -> bool</autodoc> |
f32fc4bc RD |
27432 | <paramlist> |
27433 | <param name="row" type="int" default=""/> | |
27434 | <param name="col" type="int" default=""/> | |
27435 | <param name="grid" type="wxGrid" default=""/> | |
27436 | </paramlist> | |
27437 | </method> | |
27438 | <method name="Reset" type="" overloaded="no"> | |
781d2982 | 27439 | <autodoc>Reset(self)</autodoc> |
f32fc4bc RD |
27440 | </method> |
27441 | <method name="Clone" type="GridCellEditor" overloaded="no"> | |
781d2982 | 27442 | <autodoc>Clone(self) -> GridCellEditor</autodoc> |
f32fc4bc RD |
27443 | </method> |
27444 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 27445 | <autodoc>SetSize(self, Rect rect)</autodoc> |
f32fc4bc RD |
27446 | <paramlist> |
27447 | <param name="rect" type="Rect" default=""/> | |
27448 | </paramlist> | |
27449 | </method> | |
27450 | <method name="Show" type="" overloaded="no"> | |
781d2982 | 27451 | <autodoc>Show(self, bool show, GridCellAttr attr=None)</autodoc> |
f32fc4bc RD |
27452 | <paramlist> |
27453 | <param name="show" type="bool" default=""/> | |
27454 | <param name="attr" type="wxGridCellAttr" default="NULL"/> | |
27455 | </paramlist> | |
27456 | </method> | |
27457 | <method name="PaintBackground" type="" overloaded="no"> | |
781d2982 | 27458 | <autodoc>PaintBackground(self, Rect rectCell, GridCellAttr attr)</autodoc> |
f32fc4bc RD |
27459 | <paramlist> |
27460 | <param name="rectCell" type="Rect" default=""/> | |
27461 | <param name="attr" type="wxGridCellAttr" default=""/> | |
27462 | </paramlist> | |
27463 | </method> | |
27464 | <method name="IsAcceptedKey" type="bool" overloaded="no"> | |
781d2982 | 27465 | <autodoc>IsAcceptedKey(self, KeyEvent event) -> bool</autodoc> |
f32fc4bc RD |
27466 | <paramlist> |
27467 | <param name="event" type="KeyEvent" default=""/> | |
27468 | </paramlist> | |
27469 | </method> | |
27470 | <method name="StartingKey" type="" overloaded="no"> | |
781d2982 | 27471 | <autodoc>StartingKey(self, KeyEvent event)</autodoc> |
f32fc4bc RD |
27472 | <paramlist> |
27473 | <param name="event" type="KeyEvent" default=""/> | |
27474 | </paramlist> | |
27475 | </method> | |
27476 | <method name="StartingClick" type="" overloaded="no"> | |
781d2982 | 27477 | <autodoc>StartingClick(self)</autodoc> |
f32fc4bc RD |
27478 | </method> |
27479 | <method name="HandleReturn" type="" overloaded="no"> | |
781d2982 | 27480 | <autodoc>HandleReturn(self, KeyEvent event)</autodoc> |
f32fc4bc RD |
27481 | <paramlist> |
27482 | <param name="event" type="KeyEvent" default=""/> | |
27483 | </paramlist> | |
27484 | </method> | |
27485 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 27486 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
27487 | </method> |
27488 | </class> | |
27489 | <class name="PyGridCellEditor" oldname="wxPyGridCellEditor" module="grid"> | |
27490 | <baseclass name="GridCellEditor"/> | |
27491 | <constructor name="PyGridCellEditor" overloaded="no"> | |
781d2982 | 27492 | <autodoc>__init__(self) -> PyGridCellEditor</autodoc> |
f32fc4bc RD |
27493 | </constructor> |
27494 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 27495 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
27496 | <paramlist> |
27497 | <param name="self" type="PyObject" default=""/> | |
27498 | <param name="_class" type="PyObject" default=""/> | |
27499 | </paramlist> | |
27500 | </method> | |
27501 | <method name="base_SetSize" type="" overloaded="no"> | |
781d2982 | 27502 | <autodoc>base_SetSize(self, Rect rect)</autodoc> |
f32fc4bc RD |
27503 | <paramlist> |
27504 | <param name="rect" type="Rect" default=""/> | |
27505 | </paramlist> | |
27506 | </method> | |
27507 | <method name="base_Show" type="" overloaded="no"> | |
781d2982 | 27508 | <autodoc>base_Show(self, bool show, GridCellAttr attr=None)</autodoc> |
f32fc4bc RD |
27509 | <paramlist> |
27510 | <param name="show" type="bool" default=""/> | |
27511 | <param name="attr" type="wxGridCellAttr" default="NULL"/> | |
27512 | </paramlist> | |
27513 | </method> | |
27514 | <method name="base_PaintBackground" type="" overloaded="no"> | |
781d2982 | 27515 | <autodoc>base_PaintBackground(self, Rect rectCell, GridCellAttr attr)</autodoc> |
f32fc4bc RD |
27516 | <paramlist> |
27517 | <param name="rectCell" type="Rect" default=""/> | |
27518 | <param name="attr" type="wxGridCellAttr" default=""/> | |
27519 | </paramlist> | |
27520 | </method> | |
27521 | <method name="base_IsAcceptedKey" type="bool" overloaded="no"> | |
781d2982 | 27522 | <autodoc>base_IsAcceptedKey(self, KeyEvent event) -> bool</autodoc> |
f32fc4bc RD |
27523 | <paramlist> |
27524 | <param name="event" type="KeyEvent" default=""/> | |
27525 | </paramlist> | |
27526 | </method> | |
27527 | <method name="base_StartingKey" type="" overloaded="no"> | |
781d2982 | 27528 | <autodoc>base_StartingKey(self, KeyEvent event)</autodoc> |
f32fc4bc RD |
27529 | <paramlist> |
27530 | <param name="event" type="KeyEvent" default=""/> | |
27531 | </paramlist> | |
27532 | </method> | |
27533 | <method name="base_StartingClick" type="" overloaded="no"> | |
781d2982 | 27534 | <autodoc>base_StartingClick(self)</autodoc> |
f32fc4bc RD |
27535 | </method> |
27536 | <method name="base_HandleReturn" type="" overloaded="no"> | |
781d2982 | 27537 | <autodoc>base_HandleReturn(self, KeyEvent event)</autodoc> |
f32fc4bc RD |
27538 | <paramlist> |
27539 | <param name="event" type="KeyEvent" default=""/> | |
27540 | </paramlist> | |
27541 | </method> | |
27542 | <method name="base_Destroy" type="" overloaded="no"> | |
781d2982 | 27543 | <autodoc>base_Destroy(self)</autodoc> |
f32fc4bc RD |
27544 | </method> |
27545 | <method name="base_SetParameters" type="" overloaded="no"> | |
781d2982 | 27546 | <autodoc>base_SetParameters(self, String params)</autodoc> |
f32fc4bc RD |
27547 | <paramlist> |
27548 | <param name="params" type="String" default=""/> | |
27549 | </paramlist> | |
27550 | </method> | |
27551 | </class> | |
27552 | <class name="GridCellTextEditor" oldname="wxGridCellTextEditor" module="grid"> | |
27553 | <baseclass name="GridCellEditor"/> | |
27554 | <constructor name="GridCellTextEditor" overloaded="no"> | |
781d2982 | 27555 | <autodoc>__init__(self) -> GridCellTextEditor</autodoc> |
f32fc4bc RD |
27556 | </constructor> |
27557 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 27558 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
27559 | </method> |
27560 | </class> | |
27561 | <class name="GridCellNumberEditor" oldname="wxGridCellNumberEditor" module="grid"> | |
27562 | <baseclass name="GridCellTextEditor"/> | |
27563 | <constructor name="GridCellNumberEditor" overloaded="no"> | |
781d2982 | 27564 | <autodoc>__init__(self, int min=-1, int max=-1) -> GridCellNumberEditor</autodoc> |
f32fc4bc RD |
27565 | <paramlist> |
27566 | <param name="min" type="int" default="-1"/> | |
27567 | <param name="max" type="int" default="-1"/> | |
27568 | </paramlist> | |
27569 | </constructor> | |
27570 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 27571 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
27572 | </method> |
27573 | </class> | |
27574 | <class name="GridCellFloatEditor" oldname="wxGridCellFloatEditor" module="grid"> | |
27575 | <baseclass name="GridCellTextEditor"/> | |
27576 | <constructor name="GridCellFloatEditor" overloaded="no"> | |
781d2982 RD |
27577 | <autodoc>__init__(self, int width=-1, int precision=-1) -> GridCellFloatEditor</autodoc> |
27578 | <paramlist> | |
27579 | <param name="width" type="int" default="-1"/> | |
27580 | <param name="precision" type="int" default="-1"/> | |
27581 | </paramlist> | |
f32fc4bc RD |
27582 | </constructor> |
27583 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 27584 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
27585 | </method> |
27586 | </class> | |
27587 | <class name="GridCellBoolEditor" oldname="wxGridCellBoolEditor" module="grid"> | |
27588 | <baseclass name="GridCellEditor"/> | |
27589 | <constructor name="GridCellBoolEditor" overloaded="no"> | |
781d2982 | 27590 | <autodoc>__init__(self) -> GridCellBoolEditor</autodoc> |
f32fc4bc RD |
27591 | </constructor> |
27592 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 27593 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
27594 | </method> |
27595 | </class> | |
27596 | <class name="GridCellChoiceEditor" oldname="wxGridCellChoiceEditor" module="grid"> | |
27597 | <baseclass name="GridCellEditor"/> | |
27598 | <constructor name="GridCellChoiceEditor" overloaded="no"> | |
781d2982 | 27599 | <autodoc>__init__(self, int choices=0, String choices_array=None, bool allowOthers=False) -> GridCellChoiceEditor</autodoc> |
f32fc4bc RD |
27600 | <paramlist> |
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"/> | |
27604 | </paramlist> | |
27605 | </constructor> | |
27606 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 27607 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
27608 | </method> |
27609 | </class> | |
27610 | <class name="GridCellEnumEditor" oldname="wxGridCellEnumEditor" module="grid"> | |
27611 | <baseclass name="GridCellChoiceEditor"/> | |
27612 | <constructor name="GridCellEnumEditor" overloaded="no"> | |
781d2982 | 27613 | <autodoc>__init__(self, String choices=EmptyString) -> GridCellEnumEditor</autodoc> |
f32fc4bc RD |
27614 | <paramlist> |
27615 | <param name="choices" type="String" default="wxPyEmptyString"/> | |
27616 | </paramlist> | |
27617 | </constructor> | |
27618 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 27619 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
27620 | </method> |
27621 | </class> | |
27622 | <class name="GridCellAutoWrapStringEditor" oldname="wxGridCellAutoWrapStringEditor" module="grid"> | |
27623 | <baseclass name="GridCellTextEditor"/> | |
27624 | <constructor name="GridCellAutoWrapStringEditor" overloaded="no"> | |
781d2982 | 27625 | <autodoc>__init__(self) -> GridCellAutoWrapStringEditor</autodoc> |
f32fc4bc RD |
27626 | </constructor> |
27627 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 27628 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
27629 | </method> |
27630 | </class> | |
27631 | <class name="GridCellAttr" oldname="wxGridCellAttr" module="grid"> | |
27632 | <constructor name="GridCellAttr" overloaded="no"> | |
781d2982 | 27633 | <autodoc>__init__(self, GridCellAttr attrDefault=None) -> GridCellAttr</autodoc> |
f32fc4bc RD |
27634 | <paramlist> |
27635 | <param name="attrDefault" type="GridCellAttr" default="NULL"/> | |
27636 | </paramlist> | |
27637 | </constructor> | |
27638 | <method name="_setOORInfo" type="" overloaded="no"> | |
781d2982 | 27639 | <autodoc>_setOORInfo(self, PyObject _self)</autodoc> |
f32fc4bc RD |
27640 | <paramlist> |
27641 | <param name="_self" type="PyObject" default=""/> | |
27642 | </paramlist> | |
27643 | </method> | |
27644 | <method name="Clone" type="GridCellAttr" overloaded="no"> | |
781d2982 | 27645 | <autodoc>Clone(self) -> GridCellAttr</autodoc> |
f32fc4bc RD |
27646 | </method> |
27647 | <method name="MergeWith" type="" overloaded="no"> | |
781d2982 | 27648 | <autodoc>MergeWith(self, GridCellAttr mergefrom)</autodoc> |
f32fc4bc RD |
27649 | <paramlist> |
27650 | <param name="mergefrom" type="GridCellAttr" default=""/> | |
27651 | </paramlist> | |
27652 | </method> | |
27653 | <method name="IncRef" type="" overloaded="no"> | |
781d2982 | 27654 | <autodoc>IncRef(self)</autodoc> |
f32fc4bc RD |
27655 | </method> |
27656 | <method name="DecRef" type="" overloaded="no"> | |
781d2982 | 27657 | <autodoc>DecRef(self)</autodoc> |
f32fc4bc RD |
27658 | </method> |
27659 | <method name="SetTextColour" type="" overloaded="no"> | |
781d2982 | 27660 | <autodoc>SetTextColour(self, Colour colText)</autodoc> |
f32fc4bc RD |
27661 | <paramlist> |
27662 | <param name="colText" type="Colour" default=""/> | |
27663 | </paramlist> | |
27664 | </method> | |
27665 | <method name="SetBackgroundColour" type="" overloaded="no"> | |
781d2982 | 27666 | <autodoc>SetBackgroundColour(self, Colour colBack)</autodoc> |
f32fc4bc RD |
27667 | <paramlist> |
27668 | <param name="colBack" type="Colour" default=""/> | |
27669 | </paramlist> | |
27670 | </method> | |
27671 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 27672 | <autodoc>SetFont(self, Font font)</autodoc> |
f32fc4bc RD |
27673 | <paramlist> |
27674 | <param name="font" type="Font" default=""/> | |
27675 | </paramlist> | |
27676 | </method> | |
27677 | <method name="SetAlignment" type="" overloaded="no"> | |
781d2982 | 27678 | <autodoc>SetAlignment(self, int hAlign, int vAlign)</autodoc> |
f32fc4bc RD |
27679 | <paramlist> |
27680 | <param name="hAlign" type="int" default=""/> | |
27681 | <param name="vAlign" type="int" default=""/> | |
27682 | </paramlist> | |
27683 | </method> | |
27684 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 27685 | <autodoc>SetSize(self, int num_rows, int num_cols)</autodoc> |
f32fc4bc RD |
27686 | <paramlist> |
27687 | <param name="num_rows" type="int" default=""/> | |
27688 | <param name="num_cols" type="int" default=""/> | |
27689 | </paramlist> | |
27690 | </method> | |
27691 | <method name="SetOverflow" type="" overloaded="no"> | |
781d2982 | 27692 | <autodoc>SetOverflow(self, bool allow=True)</autodoc> |
f32fc4bc RD |
27693 | <paramlist> |
27694 | <param name="allow" type="bool" default="True"/> | |
27695 | </paramlist> | |
27696 | </method> | |
27697 | <method name="SetReadOnly" type="" overloaded="no"> | |
781d2982 | 27698 | <autodoc>SetReadOnly(self, bool isReadOnly=True)</autodoc> |
f32fc4bc RD |
27699 | <paramlist> |
27700 | <param name="isReadOnly" type="bool" default="True"/> | |
27701 | </paramlist> | |
27702 | </method> | |
27703 | <method name="SetRenderer" type="" overloaded="no"> | |
781d2982 | 27704 | <autodoc>SetRenderer(self, GridCellRenderer renderer)</autodoc> |
f32fc4bc RD |
27705 | <paramlist> |
27706 | <param name="renderer" type="GridCellRenderer" default=""/> | |
27707 | </paramlist> | |
27708 | </method> | |
27709 | <method name="SetEditor" type="" overloaded="no"> | |
781d2982 | 27710 | <autodoc>SetEditor(self, GridCellEditor editor)</autodoc> |
f32fc4bc RD |
27711 | <paramlist> |
27712 | <param name="editor" type="GridCellEditor" default=""/> | |
27713 | </paramlist> | |
27714 | </method> | |
27715 | <method name="SetKind" type="" overloaded="no"> | |
781d2982 | 27716 | <autodoc>SetKind(self, int kind)</autodoc> |
f32fc4bc RD |
27717 | <paramlist> |
27718 | <param name="kind" type="wxGridCellAttr::wxAttrKind" default=""/> | |
27719 | </paramlist> | |
27720 | </method> | |
27721 | <method name="HasTextColour" type="bool" overloaded="no"> | |
781d2982 | 27722 | <autodoc>HasTextColour(self) -> bool</autodoc> |
f32fc4bc RD |
27723 | </method> |
27724 | <method name="HasBackgroundColour" type="bool" overloaded="no"> | |
781d2982 | 27725 | <autodoc>HasBackgroundColour(self) -> bool</autodoc> |
f32fc4bc RD |
27726 | </method> |
27727 | <method name="HasFont" type="bool" overloaded="no"> | |
781d2982 | 27728 | <autodoc>HasFont(self) -> bool</autodoc> |
f32fc4bc RD |
27729 | </method> |
27730 | <method name="HasAlignment" type="bool" overloaded="no"> | |
781d2982 | 27731 | <autodoc>HasAlignment(self) -> bool</autodoc> |
f32fc4bc RD |
27732 | </method> |
27733 | <method name="HasRenderer" type="bool" overloaded="no"> | |
781d2982 | 27734 | <autodoc>HasRenderer(self) -> bool</autodoc> |
f32fc4bc RD |
27735 | </method> |
27736 | <method name="HasEditor" type="bool" overloaded="no"> | |
781d2982 | 27737 | <autodoc>HasEditor(self) -> bool</autodoc> |
f32fc4bc RD |
27738 | </method> |
27739 | <method name="HasReadWriteMode" type="bool" overloaded="no"> | |
781d2982 | 27740 | <autodoc>HasReadWriteMode(self) -> bool</autodoc> |
f32fc4bc RD |
27741 | </method> |
27742 | <method name="HasOverflowMode" type="bool" overloaded="no"> | |
781d2982 | 27743 | <autodoc>HasOverflowMode(self) -> bool</autodoc> |
f32fc4bc RD |
27744 | </method> |
27745 | <method name="GetTextColour" type="Colour" overloaded="no"> | |
781d2982 | 27746 | <autodoc>GetTextColour(self) -> Colour</autodoc> |
f32fc4bc RD |
27747 | </method> |
27748 | <method name="GetBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 27749 | <autodoc>GetBackgroundColour(self) -> Colour</autodoc> |
f32fc4bc RD |
27750 | </method> |
27751 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 27752 | <autodoc>GetFont(self) -> Font</autodoc> |
f32fc4bc RD |
27753 | </method> |
27754 | <method name="GetAlignment" type="" overloaded="no"> | |
27755 | <autodoc>GetAlignment() -> (hAlign, vAlign)</autodoc> | |
27756 | <paramlist> | |
27757 | <param name="OUTPUT" type="int" default=""/> | |
27758 | <param name="OUTPUT" type="int" default=""/> | |
27759 | </paramlist> | |
27760 | </method> | |
27761 | <method name="GetSize" type="" overloaded="no"> | |
27762 | <autodoc>GetSize() -> (num_rows, num_cols)</autodoc> | |
27763 | <paramlist> | |
27764 | <param name="OUTPUT" type="int" default=""/> | |
27765 | <param name="OUTPUT" type="int" default=""/> | |
27766 | </paramlist> | |
27767 | </method> | |
27768 | <method name="GetOverflow" type="bool" overloaded="no"> | |
781d2982 | 27769 | <autodoc>GetOverflow(self) -> bool</autodoc> |
f32fc4bc RD |
27770 | </method> |
27771 | <method name="GetRenderer" type="GridCellRenderer" overloaded="no"> | |
781d2982 | 27772 | <autodoc>GetRenderer(self, Grid grid, int row, int col) -> GridCellRenderer</autodoc> |
f32fc4bc RD |
27773 | <paramlist> |
27774 | <param name="grid" type="wxGrid" default=""/> | |
27775 | <param name="row" type="int" default=""/> | |
27776 | <param name="col" type="int" default=""/> | |
27777 | </paramlist> | |
27778 | </method> | |
27779 | <method name="GetEditor" type="GridCellEditor" overloaded="no"> | |
781d2982 | 27780 | <autodoc>GetEditor(self, Grid grid, int row, int col) -> GridCellEditor</autodoc> |
f32fc4bc RD |
27781 | <paramlist> |
27782 | <param name="grid" type="wxGrid" default=""/> | |
27783 | <param name="row" type="int" default=""/> | |
27784 | <param name="col" type="int" default=""/> | |
27785 | </paramlist> | |
27786 | </method> | |
27787 | <method name="IsReadOnly" type="bool" overloaded="no"> | |
781d2982 | 27788 | <autodoc>IsReadOnly(self) -> bool</autodoc> |
f32fc4bc | 27789 | </method> |
ce6878e6 RD |
27790 | <method name="GetKind" type="wxGridCellAttr::wxAttrKind" overloaded="no"> |
27791 | <autodoc>GetKind(self) -> int</autodoc> | |
27792 | </method> | |
f32fc4bc | 27793 | <method name="SetDefAttr" type="" overloaded="no"> |
781d2982 | 27794 | <autodoc>SetDefAttr(self, GridCellAttr defAttr)</autodoc> |
f32fc4bc RD |
27795 | <paramlist> |
27796 | <param name="defAttr" type="GridCellAttr" default=""/> | |
27797 | </paramlist> | |
27798 | </method> | |
27799 | </class> | |
27800 | <class name="GridCellAttrProvider" oldname="wxGridCellAttrProvider" module="grid"> | |
27801 | <constructor name="GridCellAttrProvider" overloaded="no"> | |
781d2982 | 27802 | <autodoc>__init__(self) -> GridCellAttrProvider</autodoc> |
f32fc4bc RD |
27803 | </constructor> |
27804 | <method name="_setOORInfo" type="" overloaded="no"> | |
781d2982 | 27805 | <autodoc>_setOORInfo(self, PyObject _self)</autodoc> |
f32fc4bc RD |
27806 | <paramlist> |
27807 | <param name="_self" type="PyObject" default=""/> | |
27808 | </paramlist> | |
27809 | </method> | |
27810 | <method name="GetAttr" type="GridCellAttr" overloaded="no"> | |
781d2982 | 27811 | <autodoc>GetAttr(self, int row, int col, int kind) -> GridCellAttr</autodoc> |
f32fc4bc RD |
27812 | <paramlist> |
27813 | <param name="row" type="int" default=""/> | |
27814 | <param name="col" type="int" default=""/> | |
27815 | <param name="kind" type="wxGridCellAttr::wxAttrKind" default=""/> | |
27816 | </paramlist> | |
27817 | </method> | |
27818 | <method name="SetAttr" type="" overloaded="no"> | |
781d2982 | 27819 | <autodoc>SetAttr(self, GridCellAttr attr, int row, int col)</autodoc> |
f32fc4bc RD |
27820 | <paramlist> |
27821 | <param name="attr" type="GridCellAttr" default=""/> | |
27822 | <param name="row" type="int" default=""/> | |
27823 | <param name="col" type="int" default=""/> | |
27824 | </paramlist> | |
27825 | </method> | |
27826 | <method name="SetRowAttr" type="" overloaded="no"> | |
781d2982 | 27827 | <autodoc>SetRowAttr(self, GridCellAttr attr, int row)</autodoc> |
f32fc4bc RD |
27828 | <paramlist> |
27829 | <param name="attr" type="GridCellAttr" default=""/> | |
27830 | <param name="row" type="int" default=""/> | |
27831 | </paramlist> | |
27832 | </method> | |
27833 | <method name="SetColAttr" type="" overloaded="no"> | |
781d2982 | 27834 | <autodoc>SetColAttr(self, GridCellAttr attr, int col)</autodoc> |
f32fc4bc RD |
27835 | <paramlist> |
27836 | <param name="attr" type="GridCellAttr" default=""/> | |
27837 | <param name="col" type="int" default=""/> | |
27838 | </paramlist> | |
27839 | </method> | |
27840 | <method name="UpdateAttrRows" type="" overloaded="no"> | |
781d2982 | 27841 | <autodoc>UpdateAttrRows(self, size_t pos, int numRows)</autodoc> |
f32fc4bc RD |
27842 | <paramlist> |
27843 | <param name="pos" type="size_t" default=""/> | |
27844 | <param name="numRows" type="int" default=""/> | |
27845 | </paramlist> | |
27846 | </method> | |
27847 | <method name="UpdateAttrCols" type="" overloaded="no"> | |
781d2982 | 27848 | <autodoc>UpdateAttrCols(self, size_t pos, int numCols)</autodoc> |
f32fc4bc RD |
27849 | <paramlist> |
27850 | <param name="pos" type="size_t" default=""/> | |
27851 | <param name="numCols" type="int" default=""/> | |
27852 | </paramlist> | |
27853 | </method> | |
27854 | </class> | |
27855 | <class name="PyGridCellAttrProvider" oldname="wxPyGridCellAttrProvider" module="grid"> | |
27856 | <baseclass name="GridCellAttrProvider"/> | |
27857 | <constructor name="PyGridCellAttrProvider" overloaded="no"> | |
781d2982 | 27858 | <autodoc>__init__(self) -> PyGridCellAttrProvider</autodoc> |
f32fc4bc RD |
27859 | </constructor> |
27860 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 27861 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
27862 | <paramlist> |
27863 | <param name="self" type="PyObject" default=""/> | |
27864 | <param name="_class" type="PyObject" default=""/> | |
27865 | </paramlist> | |
27866 | </method> | |
27867 | <method name="base_GetAttr" type="GridCellAttr" overloaded="no"> | |
781d2982 | 27868 | <autodoc>base_GetAttr(self, int row, int col, int kind) -> GridCellAttr</autodoc> |
f32fc4bc RD |
27869 | <paramlist> |
27870 | <param name="row" type="int" default=""/> | |
27871 | <param name="col" type="int" default=""/> | |
27872 | <param name="kind" type="wxGridCellAttr::wxAttrKind" default=""/> | |
27873 | </paramlist> | |
27874 | </method> | |
27875 | <method name="base_SetAttr" type="" overloaded="no"> | |
781d2982 | 27876 | <autodoc>base_SetAttr(self, GridCellAttr attr, int row, int col)</autodoc> |
f32fc4bc RD |
27877 | <paramlist> |
27878 | <param name="attr" type="GridCellAttr" default=""/> | |
27879 | <param name="row" type="int" default=""/> | |
27880 | <param name="col" type="int" default=""/> | |
27881 | </paramlist> | |
27882 | </method> | |
27883 | <method name="base_SetRowAttr" type="" overloaded="no"> | |
781d2982 | 27884 | <autodoc>base_SetRowAttr(self, GridCellAttr attr, int row)</autodoc> |
f32fc4bc RD |
27885 | <paramlist> |
27886 | <param name="attr" type="GridCellAttr" default=""/> | |
27887 | <param name="row" type="int" default=""/> | |
27888 | </paramlist> | |
27889 | </method> | |
27890 | <method name="base_SetColAttr" type="" overloaded="no"> | |
781d2982 | 27891 | <autodoc>base_SetColAttr(self, GridCellAttr attr, int col)</autodoc> |
f32fc4bc RD |
27892 | <paramlist> |
27893 | <param name="attr" type="GridCellAttr" default=""/> | |
27894 | <param name="col" type="int" default=""/> | |
27895 | </paramlist> | |
27896 | </method> | |
27897 | </class> | |
27898 | <class name="GridTableBase" oldname="wxGridTableBase" module="grid"> | |
27899 | <baseclass name="Object"/> | |
27900 | <method name="_setOORInfo" type="" overloaded="no"> | |
781d2982 | 27901 | <autodoc>_setOORInfo(self, PyObject _self)</autodoc> |
f32fc4bc RD |
27902 | <paramlist> |
27903 | <param name="_self" type="PyObject" default=""/> | |
27904 | </paramlist> | |
27905 | </method> | |
27906 | <method name="SetAttrProvider" type="" overloaded="no"> | |
781d2982 | 27907 | <autodoc>SetAttrProvider(self, GridCellAttrProvider attrProvider)</autodoc> |
f32fc4bc RD |
27908 | <paramlist> |
27909 | <param name="attrProvider" type="GridCellAttrProvider" default=""/> | |
27910 | </paramlist> | |
27911 | </method> | |
27912 | <method name="GetAttrProvider" type="GridCellAttrProvider" overloaded="no"> | |
781d2982 | 27913 | <autodoc>GetAttrProvider(self) -> GridCellAttrProvider</autodoc> |
f32fc4bc RD |
27914 | </method> |
27915 | <method name="SetView" type="" overloaded="no"> | |
781d2982 | 27916 | <autodoc>SetView(self, Grid grid)</autodoc> |
f32fc4bc RD |
27917 | <paramlist> |
27918 | <param name="grid" type="wxGrid" default=""/> | |
27919 | </paramlist> | |
27920 | </method> | |
27921 | <method name="GetView" type="wxGrid" overloaded="no"> | |
781d2982 | 27922 | <autodoc>GetView(self) -> Grid</autodoc> |
f32fc4bc RD |
27923 | </method> |
27924 | <method name="GetNumberRows" type="int" overloaded="no"> | |
781d2982 | 27925 | <autodoc>GetNumberRows(self) -> int</autodoc> |
f32fc4bc RD |
27926 | </method> |
27927 | <method name="GetNumberCols" type="int" overloaded="no"> | |
781d2982 | 27928 | <autodoc>GetNumberCols(self) -> int</autodoc> |
f32fc4bc RD |
27929 | </method> |
27930 | <method name="IsEmptyCell" type="bool" overloaded="no"> | |
781d2982 | 27931 | <autodoc>IsEmptyCell(self, int row, int col) -> bool</autodoc> |
f32fc4bc RD |
27932 | <paramlist> |
27933 | <param name="row" type="int" default=""/> | |
27934 | <param name="col" type="int" default=""/> | |
27935 | </paramlist> | |
27936 | </method> | |
27937 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 27938 | <autodoc>GetValue(self, int row, int col) -> String</autodoc> |
f32fc4bc RD |
27939 | <paramlist> |
27940 | <param name="row" type="int" default=""/> | |
27941 | <param name="col" type="int" default=""/> | |
27942 | </paramlist> | |
27943 | </method> | |
27944 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 27945 | <autodoc>SetValue(self, int row, int col, String value)</autodoc> |
f32fc4bc RD |
27946 | <paramlist> |
27947 | <param name="row" type="int" default=""/> | |
27948 | <param name="col" type="int" default=""/> | |
27949 | <param name="value" type="String" default=""/> | |
27950 | </paramlist> | |
27951 | </method> | |
27952 | <method name="GetTypeName" type="String" overloaded="no"> | |
781d2982 | 27953 | <autodoc>GetTypeName(self, int row, int col) -> String</autodoc> |
f32fc4bc RD |
27954 | <paramlist> |
27955 | <param name="row" type="int" default=""/> | |
27956 | <param name="col" type="int" default=""/> | |
27957 | </paramlist> | |
27958 | </method> | |
27959 | <method name="CanGetValueAs" type="bool" overloaded="no"> | |
781d2982 | 27960 | <autodoc>CanGetValueAs(self, int row, int col, String typeName) -> bool</autodoc> |
f32fc4bc RD |
27961 | <paramlist> |
27962 | <param name="row" type="int" default=""/> | |
27963 | <param name="col" type="int" default=""/> | |
27964 | <param name="typeName" type="String" default=""/> | |
27965 | </paramlist> | |
27966 | </method> | |
27967 | <method name="CanSetValueAs" type="bool" overloaded="no"> | |
781d2982 | 27968 | <autodoc>CanSetValueAs(self, int row, int col, String typeName) -> bool</autodoc> |
f32fc4bc RD |
27969 | <paramlist> |
27970 | <param name="row" type="int" default=""/> | |
27971 | <param name="col" type="int" default=""/> | |
27972 | <param name="typeName" type="String" default=""/> | |
27973 | </paramlist> | |
27974 | </method> | |
27975 | <method name="GetValueAsLong" type="long" overloaded="no"> | |
781d2982 | 27976 | <autodoc>GetValueAsLong(self, int row, int col) -> long</autodoc> |
f32fc4bc RD |
27977 | <paramlist> |
27978 | <param name="row" type="int" default=""/> | |
27979 | <param name="col" type="int" default=""/> | |
27980 | </paramlist> | |
27981 | </method> | |
27982 | <method name="GetValueAsDouble" type="double" overloaded="no"> | |
781d2982 | 27983 | <autodoc>GetValueAsDouble(self, int row, int col) -> double</autodoc> |
f32fc4bc RD |
27984 | <paramlist> |
27985 | <param name="row" type="int" default=""/> | |
27986 | <param name="col" type="int" default=""/> | |
27987 | </paramlist> | |
27988 | </method> | |
27989 | <method name="GetValueAsBool" type="bool" overloaded="no"> | |
781d2982 | 27990 | <autodoc>GetValueAsBool(self, int row, int col) -> bool</autodoc> |
f32fc4bc RD |
27991 | <paramlist> |
27992 | <param name="row" type="int" default=""/> | |
27993 | <param name="col" type="int" default=""/> | |
27994 | </paramlist> | |
27995 | </method> | |
27996 | <method name="SetValueAsLong" type="" overloaded="no"> | |
781d2982 | 27997 | <autodoc>SetValueAsLong(self, int row, int col, long value)</autodoc> |
f32fc4bc RD |
27998 | <paramlist> |
27999 | <param name="row" type="int" default=""/> | |
28000 | <param name="col" type="int" default=""/> | |
28001 | <param name="value" type="long" default=""/> | |
28002 | </paramlist> | |
28003 | </method> | |
28004 | <method name="SetValueAsDouble" type="" overloaded="no"> | |
781d2982 | 28005 | <autodoc>SetValueAsDouble(self, int row, int col, double value)</autodoc> |
f32fc4bc RD |
28006 | <paramlist> |
28007 | <param name="row" type="int" default=""/> | |
28008 | <param name="col" type="int" default=""/> | |
28009 | <param name="value" type="double" default=""/> | |
28010 | </paramlist> | |
28011 | </method> | |
28012 | <method name="SetValueAsBool" type="" overloaded="no"> | |
781d2982 | 28013 | <autodoc>SetValueAsBool(self, int row, int col, bool value)</autodoc> |
f32fc4bc RD |
28014 | <paramlist> |
28015 | <param name="row" type="int" default=""/> | |
28016 | <param name="col" type="int" default=""/> | |
28017 | <param name="value" type="bool" default=""/> | |
28018 | </paramlist> | |
28019 | </method> | |
28020 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 28021 | <autodoc>Clear(self)</autodoc> |
f32fc4bc RD |
28022 | </method> |
28023 | <method name="InsertRows" type="bool" overloaded="no"> | |
781d2982 | 28024 | <autodoc>InsertRows(self, size_t pos=0, size_t numRows=1) -> bool</autodoc> |
f32fc4bc RD |
28025 | <paramlist> |
28026 | <param name="pos" type="size_t" default="0"/> | |
28027 | <param name="numRows" type="size_t" default="1"/> | |
28028 | </paramlist> | |
28029 | </method> | |
28030 | <method name="AppendRows" type="bool" overloaded="no"> | |
781d2982 | 28031 | <autodoc>AppendRows(self, size_t numRows=1) -> bool</autodoc> |
f32fc4bc RD |
28032 | <paramlist> |
28033 | <param name="numRows" type="size_t" default="1"/> | |
28034 | </paramlist> | |
28035 | </method> | |
28036 | <method name="DeleteRows" type="bool" overloaded="no"> | |
781d2982 | 28037 | <autodoc>DeleteRows(self, size_t pos=0, size_t numRows=1) -> bool</autodoc> |
f32fc4bc RD |
28038 | <paramlist> |
28039 | <param name="pos" type="size_t" default="0"/> | |
28040 | <param name="numRows" type="size_t" default="1"/> | |
28041 | </paramlist> | |
28042 | </method> | |
28043 | <method name="InsertCols" type="bool" overloaded="no"> | |
781d2982 | 28044 | <autodoc>InsertCols(self, size_t pos=0, size_t numCols=1) -> bool</autodoc> |
f32fc4bc RD |
28045 | <paramlist> |
28046 | <param name="pos" type="size_t" default="0"/> | |
28047 | <param name="numCols" type="size_t" default="1"/> | |
28048 | </paramlist> | |
28049 | </method> | |
28050 | <method name="AppendCols" type="bool" overloaded="no"> | |
781d2982 | 28051 | <autodoc>AppendCols(self, size_t numCols=1) -> bool</autodoc> |
f32fc4bc RD |
28052 | <paramlist> |
28053 | <param name="numCols" type="size_t" default="1"/> | |
28054 | </paramlist> | |
28055 | </method> | |
28056 | <method name="DeleteCols" type="bool" overloaded="no"> | |
781d2982 | 28057 | <autodoc>DeleteCols(self, size_t pos=0, size_t numCols=1) -> bool</autodoc> |
f32fc4bc RD |
28058 | <paramlist> |
28059 | <param name="pos" type="size_t" default="0"/> | |
28060 | <param name="numCols" type="size_t" default="1"/> | |
28061 | </paramlist> | |
28062 | </method> | |
28063 | <method name="GetRowLabelValue" type="String" overloaded="no"> | |
781d2982 | 28064 | <autodoc>GetRowLabelValue(self, int row) -> String</autodoc> |
f32fc4bc RD |
28065 | <paramlist> |
28066 | <param name="row" type="int" default=""/> | |
28067 | </paramlist> | |
28068 | </method> | |
28069 | <method name="GetColLabelValue" type="String" overloaded="no"> | |
781d2982 | 28070 | <autodoc>GetColLabelValue(self, int col) -> String</autodoc> |
f32fc4bc RD |
28071 | <paramlist> |
28072 | <param name="col" type="int" default=""/> | |
28073 | </paramlist> | |
28074 | </method> | |
28075 | <method name="SetRowLabelValue" type="" overloaded="no"> | |
781d2982 | 28076 | <autodoc>SetRowLabelValue(self, int row, String value)</autodoc> |
f32fc4bc RD |
28077 | <paramlist> |
28078 | <param name="row" type="int" default=""/> | |
28079 | <param name="value" type="String" default=""/> | |
28080 | </paramlist> | |
28081 | </method> | |
28082 | <method name="SetColLabelValue" type="" overloaded="no"> | |
781d2982 | 28083 | <autodoc>SetColLabelValue(self, int col, String value)</autodoc> |
f32fc4bc RD |
28084 | <paramlist> |
28085 | <param name="col" type="int" default=""/> | |
28086 | <param name="value" type="String" default=""/> | |
28087 | </paramlist> | |
28088 | </method> | |
28089 | <method name="CanHaveAttributes" type="bool" overloaded="no"> | |
781d2982 | 28090 | <autodoc>CanHaveAttributes(self) -> bool</autodoc> |
f32fc4bc RD |
28091 | </method> |
28092 | <method name="GetAttr" type="GridCellAttr" overloaded="no"> | |
781d2982 | 28093 | <autodoc>GetAttr(self, int row, int col, int kind) -> GridCellAttr</autodoc> |
f32fc4bc RD |
28094 | <paramlist> |
28095 | <param name="row" type="int" default=""/> | |
28096 | <param name="col" type="int" default=""/> | |
28097 | <param name="kind" type="wxGridCellAttr::wxAttrKind" default=""/> | |
28098 | </paramlist> | |
28099 | </method> | |
28100 | <method name="SetAttr" type="" overloaded="no"> | |
781d2982 | 28101 | <autodoc>SetAttr(self, GridCellAttr attr, int row, int col)</autodoc> |
f32fc4bc RD |
28102 | <paramlist> |
28103 | <param name="attr" type="GridCellAttr" default=""/> | |
28104 | <param name="row" type="int" default=""/> | |
28105 | <param name="col" type="int" default=""/> | |
28106 | </paramlist> | |
28107 | </method> | |
28108 | <method name="SetRowAttr" type="" overloaded="no"> | |
781d2982 | 28109 | <autodoc>SetRowAttr(self, GridCellAttr attr, int row)</autodoc> |
f32fc4bc RD |
28110 | <paramlist> |
28111 | <param name="attr" type="GridCellAttr" default=""/> | |
28112 | <param name="row" type="int" default=""/> | |
28113 | </paramlist> | |
28114 | </method> | |
28115 | <method name="SetColAttr" type="" overloaded="no"> | |
781d2982 | 28116 | <autodoc>SetColAttr(self, GridCellAttr attr, int col)</autodoc> |
f32fc4bc RD |
28117 | <paramlist> |
28118 | <param name="attr" type="GridCellAttr" default=""/> | |
28119 | <param name="col" type="int" default=""/> | |
28120 | </paramlist> | |
28121 | </method> | |
28122 | </class> | |
28123 | <class name="PyGridTableBase" oldname="wxPyGridTableBase" module="grid"> | |
28124 | <baseclass name="GridTableBase"/> | |
28125 | <constructor name="PyGridTableBase" overloaded="no"> | |
781d2982 | 28126 | <autodoc>__init__(self) -> PyGridTableBase</autodoc> |
f32fc4bc RD |
28127 | </constructor> |
28128 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 28129 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
28130 | <paramlist> |
28131 | <param name="self" type="PyObject" default=""/> | |
28132 | <param name="_class" type="PyObject" default=""/> | |
28133 | </paramlist> | |
28134 | </method> | |
28135 | <method name="Destroy" type="" overloaded="no"> | |
781d2982 | 28136 | <autodoc>Destroy(self)</autodoc> |
f32fc4bc RD |
28137 | <docstring>Deletes the C++ object this Python object is a proxy for.</docstring> |
28138 | </method> | |
28139 | <method name="base_GetTypeName" type="String" overloaded="no"> | |
781d2982 | 28140 | <autodoc>base_GetTypeName(self, int row, int col) -> String</autodoc> |
f32fc4bc RD |
28141 | <paramlist> |
28142 | <param name="row" type="int" default=""/> | |
28143 | <param name="col" type="int" default=""/> | |
28144 | </paramlist> | |
28145 | </method> | |
28146 | <method name="base_CanGetValueAs" type="bool" overloaded="no"> | |
781d2982 | 28147 | <autodoc>base_CanGetValueAs(self, int row, int col, String typeName) -> bool</autodoc> |
f32fc4bc RD |
28148 | <paramlist> |
28149 | <param name="row" type="int" default=""/> | |
28150 | <param name="col" type="int" default=""/> | |
28151 | <param name="typeName" type="String" default=""/> | |
28152 | </paramlist> | |
28153 | </method> | |
28154 | <method name="base_CanSetValueAs" type="bool" overloaded="no"> | |
781d2982 | 28155 | <autodoc>base_CanSetValueAs(self, int row, int col, String typeName) -> bool</autodoc> |
f32fc4bc RD |
28156 | <paramlist> |
28157 | <param name="row" type="int" default=""/> | |
28158 | <param name="col" type="int" default=""/> | |
28159 | <param name="typeName" type="String" default=""/> | |
28160 | </paramlist> | |
28161 | </method> | |
28162 | <method name="base_Clear" type="" overloaded="no"> | |
781d2982 | 28163 | <autodoc>base_Clear(self)</autodoc> |
f32fc4bc RD |
28164 | </method> |
28165 | <method name="base_InsertRows" type="bool" overloaded="no"> | |
781d2982 | 28166 | <autodoc>base_InsertRows(self, size_t pos=0, size_t numRows=1) -> bool</autodoc> |
f32fc4bc RD |
28167 | <paramlist> |
28168 | <param name="pos" type="size_t" default="0"/> | |
28169 | <param name="numRows" type="size_t" default="1"/> | |
28170 | </paramlist> | |
28171 | </method> | |
28172 | <method name="base_AppendRows" type="bool" overloaded="no"> | |
781d2982 | 28173 | <autodoc>base_AppendRows(self, size_t numRows=1) -> bool</autodoc> |
f32fc4bc RD |
28174 | <paramlist> |
28175 | <param name="numRows" type="size_t" default="1"/> | |
28176 | </paramlist> | |
28177 | </method> | |
28178 | <method name="base_DeleteRows" type="bool" overloaded="no"> | |
781d2982 | 28179 | <autodoc>base_DeleteRows(self, size_t pos=0, size_t numRows=1) -> bool</autodoc> |
f32fc4bc RD |
28180 | <paramlist> |
28181 | <param name="pos" type="size_t" default="0"/> | |
28182 | <param name="numRows" type="size_t" default="1"/> | |
28183 | </paramlist> | |
28184 | </method> | |
28185 | <method name="base_InsertCols" type="bool" overloaded="no"> | |
781d2982 | 28186 | <autodoc>base_InsertCols(self, size_t pos=0, size_t numCols=1) -> bool</autodoc> |
f32fc4bc RD |
28187 | <paramlist> |
28188 | <param name="pos" type="size_t" default="0"/> | |
28189 | <param name="numCols" type="size_t" default="1"/> | |
28190 | </paramlist> | |
28191 | </method> | |
28192 | <method name="base_AppendCols" type="bool" overloaded="no"> | |
781d2982 | 28193 | <autodoc>base_AppendCols(self, size_t numCols=1) -> bool</autodoc> |
f32fc4bc RD |
28194 | <paramlist> |
28195 | <param name="numCols" type="size_t" default="1"/> | |
28196 | </paramlist> | |
28197 | </method> | |
28198 | <method name="base_DeleteCols" type="bool" overloaded="no"> | |
781d2982 | 28199 | <autodoc>base_DeleteCols(self, size_t pos=0, size_t numCols=1) -> bool</autodoc> |
f32fc4bc RD |
28200 | <paramlist> |
28201 | <param name="pos" type="size_t" default="0"/> | |
28202 | <param name="numCols" type="size_t" default="1"/> | |
28203 | </paramlist> | |
28204 | </method> | |
28205 | <method name="base_GetRowLabelValue" type="String" overloaded="no"> | |
781d2982 | 28206 | <autodoc>base_GetRowLabelValue(self, int row) -> String</autodoc> |
f32fc4bc RD |
28207 | <paramlist> |
28208 | <param name="row" type="int" default=""/> | |
28209 | </paramlist> | |
28210 | </method> | |
28211 | <method name="base_GetColLabelValue" type="String" overloaded="no"> | |
781d2982 | 28212 | <autodoc>base_GetColLabelValue(self, int col) -> String</autodoc> |
f32fc4bc RD |
28213 | <paramlist> |
28214 | <param name="col" type="int" default=""/> | |
28215 | </paramlist> | |
28216 | </method> | |
28217 | <method name="base_SetRowLabelValue" type="" overloaded="no"> | |
781d2982 | 28218 | <autodoc>base_SetRowLabelValue(self, int row, String value)</autodoc> |
f32fc4bc RD |
28219 | <paramlist> |
28220 | <param name="row" type="int" default=""/> | |
28221 | <param name="value" type="String" default=""/> | |
28222 | </paramlist> | |
28223 | </method> | |
28224 | <method name="base_SetColLabelValue" type="" overloaded="no"> | |
781d2982 | 28225 | <autodoc>base_SetColLabelValue(self, int col, String value)</autodoc> |
f32fc4bc RD |
28226 | <paramlist> |
28227 | <param name="col" type="int" default=""/> | |
28228 | <param name="value" type="String" default=""/> | |
28229 | </paramlist> | |
28230 | </method> | |
28231 | <method name="base_CanHaveAttributes" type="bool" overloaded="no"> | |
781d2982 | 28232 | <autodoc>base_CanHaveAttributes(self) -> bool</autodoc> |
f32fc4bc RD |
28233 | </method> |
28234 | <method name="base_GetAttr" type="GridCellAttr" overloaded="no"> | |
781d2982 | 28235 | <autodoc>base_GetAttr(self, int row, int col, int kind) -> GridCellAttr</autodoc> |
f32fc4bc RD |
28236 | <paramlist> |
28237 | <param name="row" type="int" default=""/> | |
28238 | <param name="col" type="int" default=""/> | |
28239 | <param name="kind" type="wxGridCellAttr::wxAttrKind" default=""/> | |
28240 | </paramlist> | |
28241 | </method> | |
28242 | <method name="base_SetAttr" type="" overloaded="no"> | |
781d2982 | 28243 | <autodoc>base_SetAttr(self, GridCellAttr attr, int row, int col)</autodoc> |
f32fc4bc RD |
28244 | <paramlist> |
28245 | <param name="attr" type="GridCellAttr" default=""/> | |
28246 | <param name="row" type="int" default=""/> | |
28247 | <param name="col" type="int" default=""/> | |
28248 | </paramlist> | |
28249 | </method> | |
28250 | <method name="base_SetRowAttr" type="" overloaded="no"> | |
781d2982 | 28251 | <autodoc>base_SetRowAttr(self, GridCellAttr attr, int row)</autodoc> |
f32fc4bc RD |
28252 | <paramlist> |
28253 | <param name="attr" type="GridCellAttr" default=""/> | |
28254 | <param name="row" type="int" default=""/> | |
28255 | </paramlist> | |
28256 | </method> | |
28257 | <method name="base_SetColAttr" type="" overloaded="no"> | |
781d2982 | 28258 | <autodoc>base_SetColAttr(self, GridCellAttr attr, int col)</autodoc> |
f32fc4bc RD |
28259 | <paramlist> |
28260 | <param name="attr" type="GridCellAttr" default=""/> | |
28261 | <param name="col" type="int" default=""/> | |
28262 | </paramlist> | |
28263 | </method> | |
28264 | </class> | |
28265 | <class name="GridStringTable" oldname="wxGridStringTable" module="grid"> | |
28266 | <baseclass name="GridTableBase"/> | |
28267 | <constructor name="GridStringTable" overloaded="no"> | |
781d2982 | 28268 | <autodoc>__init__(self, int numRows=0, int numCols=0) -> GridStringTable</autodoc> |
f32fc4bc RD |
28269 | <paramlist> |
28270 | <param name="numRows" type="int" default="0"/> | |
28271 | <param name="numCols" type="int" default="0"/> | |
28272 | </paramlist> | |
28273 | </constructor> | |
28274 | </class> | |
28275 | <class name="GridTableMessage" oldname="wxGridTableMessage" module="grid"> | |
28276 | <constructor name="GridTableMessage" overloaded="no"> | |
781d2982 | 28277 | <autodoc>__init__(self, GridTableBase table, int id, int comInt1=-1, int comInt2=-1) -> GridTableMessage</autodoc> |
f32fc4bc RD |
28278 | <paramlist> |
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"/> | |
28283 | </paramlist> | |
28284 | </constructor> | |
28285 | <destructor name="~wxGridTableMessage" overloaded="no"> | |
781d2982 | 28286 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
28287 | </destructor> |
28288 | <method name="SetTableObject" type="" overloaded="no"> | |
781d2982 | 28289 | <autodoc>SetTableObject(self, GridTableBase table)</autodoc> |
f32fc4bc RD |
28290 | <paramlist> |
28291 | <param name="table" type="GridTableBase" default=""/> | |
28292 | </paramlist> | |
28293 | </method> | |
28294 | <method name="GetTableObject" type="GridTableBase" overloaded="no"> | |
781d2982 | 28295 | <autodoc>GetTableObject(self) -> GridTableBase</autodoc> |
f32fc4bc RD |
28296 | </method> |
28297 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 28298 | <autodoc>SetId(self, int id)</autodoc> |
f32fc4bc RD |
28299 | <paramlist> |
28300 | <param name="id" type="int" default=""/> | |
28301 | </paramlist> | |
28302 | </method> | |
28303 | <method name="GetId" type="int" overloaded="no"> | |
781d2982 | 28304 | <autodoc>GetId(self) -> int</autodoc> |
f32fc4bc RD |
28305 | </method> |
28306 | <method name="SetCommandInt" type="" overloaded="no"> | |
781d2982 | 28307 | <autodoc>SetCommandInt(self, int comInt1)</autodoc> |
f32fc4bc RD |
28308 | <paramlist> |
28309 | <param name="comInt1" type="int" default=""/> | |
28310 | </paramlist> | |
28311 | </method> | |
28312 | <method name="GetCommandInt" type="int" overloaded="no"> | |
781d2982 | 28313 | <autodoc>GetCommandInt(self) -> int</autodoc> |
f32fc4bc RD |
28314 | </method> |
28315 | <method name="SetCommandInt2" type="" overloaded="no"> | |
781d2982 | 28316 | <autodoc>SetCommandInt2(self, int comInt2)</autodoc> |
f32fc4bc RD |
28317 | <paramlist> |
28318 | <param name="comInt2" type="int" default=""/> | |
28319 | </paramlist> | |
28320 | </method> | |
28321 | <method name="GetCommandInt2" type="int" overloaded="no"> | |
781d2982 | 28322 | <autodoc>GetCommandInt2(self) -> int</autodoc> |
f32fc4bc RD |
28323 | </method> |
28324 | </class> | |
28325 | <class name="GridCellCoords" oldname="wxGridCellCoords" module="grid"> | |
28326 | <constructor name="GridCellCoords" overloaded="no"> | |
781d2982 | 28327 | <autodoc>__init__(self, int r=-1, int c=-1) -> GridCellCoords</autodoc> |
f32fc4bc RD |
28328 | <paramlist> |
28329 | <param name="r" type="int" default="-1"/> | |
28330 | <param name="c" type="int" default="-1"/> | |
28331 | </paramlist> | |
28332 | </constructor> | |
28333 | <destructor name="~wxGridCellCoords" overloaded="no"> | |
781d2982 | 28334 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
28335 | </destructor> |
28336 | <method name="GetRow" type="int" overloaded="no"> | |
781d2982 | 28337 | <autodoc>GetRow(self) -> int</autodoc> |
f32fc4bc RD |
28338 | </method> |
28339 | <method name="SetRow" type="" overloaded="no"> | |
781d2982 | 28340 | <autodoc>SetRow(self, int n)</autodoc> |
f32fc4bc RD |
28341 | <paramlist> |
28342 | <param name="n" type="int" default=""/> | |
28343 | </paramlist> | |
28344 | </method> | |
28345 | <method name="GetCol" type="int" overloaded="no"> | |
781d2982 | 28346 | <autodoc>GetCol(self) -> int</autodoc> |
f32fc4bc RD |
28347 | </method> |
28348 | <method name="SetCol" type="" overloaded="no"> | |
781d2982 | 28349 | <autodoc>SetCol(self, int n)</autodoc> |
f32fc4bc RD |
28350 | <paramlist> |
28351 | <param name="n" type="int" default=""/> | |
28352 | </paramlist> | |
28353 | </method> | |
28354 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 28355 | <autodoc>Set(self, int row, int col)</autodoc> |
f32fc4bc RD |
28356 | <paramlist> |
28357 | <param name="row" type="int" default=""/> | |
28358 | <param name="col" type="int" default=""/> | |
28359 | </paramlist> | |
28360 | </method> | |
28361 | <method name="__eq__" type="bool" overloaded="no"> | |
781d2982 | 28362 | <autodoc>__eq__(self, GridCellCoords other) -> bool</autodoc> |
f32fc4bc RD |
28363 | <paramlist> |
28364 | <param name="other" type="GridCellCoords" default=""/> | |
28365 | </paramlist> | |
28366 | </method> | |
28367 | <method name="__ne__" type="bool" overloaded="no"> | |
781d2982 | 28368 | <autodoc>__ne__(self, GridCellCoords other) -> bool</autodoc> |
f32fc4bc RD |
28369 | <paramlist> |
28370 | <param name="other" type="GridCellCoords" default=""/> | |
28371 | </paramlist> | |
28372 | </method> | |
781d2982 RD |
28373 | <method name="Get" type="PyObject" overloaded="no"> |
28374 | <autodoc>Get(self) -> PyObject</autodoc> | |
f32fc4bc RD |
28375 | </method> |
28376 | </class> | |
28377 | <class name="Grid" oldname="wxGrid" module="grid"> | |
28378 | <baseclass name="ScrolledWindow"/> | |
28379 | <constructor name="Grid" overloaded="no"> | |
781d2982 RD |
28380 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
28381 | Size size=DefaultSize, long style=WANTS_CHARS, | |
f32fc4bc RD |
28382 | String name=PanelNameStr) -> Grid</autodoc> |
28383 | <paramlist> | |
28384 | <param name="parent" type="Window" default=""/> | |
781d2982 | 28385 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
28390 | </paramlist> | |
28391 | </constructor> | |
781d2982 RD |
28392 | <constructor name="PreGrid" overloaded="no"> |
28393 | <autodoc>PreGrid() -> Grid</autodoc> | |
28394 | </constructor> | |
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> | |
28399 | <paramlist> | |
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"/> | |
28406 | </paramlist> | |
28407 | </method> | |
f32fc4bc | 28408 | <method name="CreateGrid" type="bool" overloaded="no"> |
781d2982 | 28409 | <autodoc>CreateGrid(self, int numRows, int numCols, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool</autodoc> |
f32fc4bc RD |
28410 | <paramlist> |
28411 | <param name="numRows" type="int" default=""/> | |
28412 | <param name="numCols" type="int" default=""/> | |
28413 | <param name="selmode" type="WXGRIDSELECTIONMODES" default="wxGrid::wxGridSelectCells"/> | |
28414 | </paramlist> | |
28415 | </method> | |
28416 | <method name="SetSelectionMode" type="" overloaded="no"> | |
781d2982 | 28417 | <autodoc>SetSelectionMode(self, WXGRIDSELECTIONMODES selmode)</autodoc> |
f32fc4bc RD |
28418 | <paramlist> |
28419 | <param name="selmode" type="WXGRIDSELECTIONMODES" default=""/> | |
28420 | </paramlist> | |
28421 | </method> | |
28422 | <method name="GetSelectionMode" type="WXGRIDSELECTIONMODES" overloaded="no"> | |
781d2982 | 28423 | <autodoc>GetSelectionMode(self) -> WXGRIDSELECTIONMODES</autodoc> |
f32fc4bc RD |
28424 | </method> |
28425 | <method name="GetNumberRows" type="int" overloaded="no"> | |
781d2982 | 28426 | <autodoc>GetNumberRows(self) -> int</autodoc> |
f32fc4bc RD |
28427 | </method> |
28428 | <method name="GetNumberCols" type="int" overloaded="no"> | |
781d2982 | 28429 | <autodoc>GetNumberCols(self) -> int</autodoc> |
f32fc4bc RD |
28430 | </method> |
28431 | <method name="ProcessTableMessage" type="bool" overloaded="no"> | |
781d2982 | 28432 | <autodoc>ProcessTableMessage(self, GridTableMessage ??) -> bool</autodoc> |
f32fc4bc RD |
28433 | <paramlist> |
28434 | <param name="" type="GridTableMessage" default=""/> | |
28435 | </paramlist> | |
28436 | </method> | |
28437 | <method name="GetTable" type="GridTableBase" overloaded="no"> | |
781d2982 | 28438 | <autodoc>GetTable(self) -> GridTableBase</autodoc> |
f32fc4bc RD |
28439 | </method> |
28440 | <method name="SetTable" type="bool" overloaded="no"> | |
781d2982 | 28441 | <autodoc>SetTable(self, GridTableBase table, bool takeOwnership=False, WXGRIDSELECTIONMODES selmode=wxGridSelectCells) -> bool</autodoc> |
f32fc4bc RD |
28442 | <paramlist> |
28443 | <param name="table" type="GridTableBase" default=""/> | |
28444 | <param name="takeOwnership" type="bool" default="False"/> | |
28445 | <param name="selmode" type="WXGRIDSELECTIONMODES" default="wxGrid::wxGridSelectCells"/> | |
28446 | </paramlist> | |
28447 | </method> | |
28448 | <method name="ClearGrid" type="" overloaded="no"> | |
781d2982 | 28449 | <autodoc>ClearGrid(self)</autodoc> |
f32fc4bc RD |
28450 | </method> |
28451 | <method name="InsertRows" type="bool" overloaded="no"> | |
781d2982 | 28452 | <autodoc>InsertRows(self, int pos=0, int numRows=1, bool updateLabels=True) -> bool</autodoc> |
f32fc4bc RD |
28453 | <paramlist> |
28454 | <param name="pos" type="int" default="0"/> | |
28455 | <param name="numRows" type="int" default="1"/> | |
28456 | <param name="updateLabels" type="bool" default="True"/> | |
28457 | </paramlist> | |
28458 | </method> | |
28459 | <method name="AppendRows" type="bool" overloaded="no"> | |
781d2982 | 28460 | <autodoc>AppendRows(self, int numRows=1, bool updateLabels=True) -> bool</autodoc> |
f32fc4bc RD |
28461 | <paramlist> |
28462 | <param name="numRows" type="int" default="1"/> | |
28463 | <param name="updateLabels" type="bool" default="True"/> | |
28464 | </paramlist> | |
28465 | </method> | |
28466 | <method name="DeleteRows" type="bool" overloaded="no"> | |
781d2982 | 28467 | <autodoc>DeleteRows(self, int pos=0, int numRows=1, bool updateLabels=True) -> bool</autodoc> |
f32fc4bc RD |
28468 | <paramlist> |
28469 | <param name="pos" type="int" default="0"/> | |
28470 | <param name="numRows" type="int" default="1"/> | |
28471 | <param name="updateLabels" type="bool" default="True"/> | |
28472 | </paramlist> | |
28473 | </method> | |
28474 | <method name="InsertCols" type="bool" overloaded="no"> | |
781d2982 | 28475 | <autodoc>InsertCols(self, int pos=0, int numCols=1, bool updateLabels=True) -> bool</autodoc> |
f32fc4bc RD |
28476 | <paramlist> |
28477 | <param name="pos" type="int" default="0"/> | |
28478 | <param name="numCols" type="int" default="1"/> | |
28479 | <param name="updateLabels" type="bool" default="True"/> | |
28480 | </paramlist> | |
28481 | </method> | |
28482 | <method name="AppendCols" type="bool" overloaded="no"> | |
781d2982 | 28483 | <autodoc>AppendCols(self, int numCols=1, bool updateLabels=True) -> bool</autodoc> |
f32fc4bc RD |
28484 | <paramlist> |
28485 | <param name="numCols" type="int" default="1"/> | |
28486 | <param name="updateLabels" type="bool" default="True"/> | |
28487 | </paramlist> | |
28488 | </method> | |
28489 | <method name="DeleteCols" type="bool" overloaded="no"> | |
781d2982 | 28490 | <autodoc>DeleteCols(self, int pos=0, int numCols=1, bool updateLabels=True) -> bool</autodoc> |
f32fc4bc RD |
28491 | <paramlist> |
28492 | <param name="pos" type="int" default="0"/> | |
28493 | <param name="numCols" type="int" default="1"/> | |
28494 | <param name="updateLabels" type="bool" default="True"/> | |
28495 | </paramlist> | |
28496 | </method> | |
28497 | <method name="DrawCellHighlight" type="" overloaded="no"> | |
781d2982 | 28498 | <autodoc>DrawCellHighlight(self, DC dc, GridCellAttr attr)</autodoc> |
f32fc4bc RD |
28499 | <paramlist> |
28500 | <param name="dc" type="DC" default=""/> | |
28501 | <param name="attr" type="GridCellAttr" default=""/> | |
28502 | </paramlist> | |
28503 | </method> | |
28504 | <method name="DrawTextRectangle" type="" overloaded="no"> | |
781d2982 | 28505 | <autodoc>DrawTextRectangle(self, DC dc, String ??, Rect ??, int horizontalAlignment=LEFT, |
f32fc4bc RD |
28506 | int verticalAlignment=TOP, int textOrientation=HORIZONTAL)</autodoc> |
28507 | <paramlist> | |
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"/> | |
28514 | </paramlist> | |
28515 | </method> | |
28516 | <method name="GetTextBoxSize" type="" overloaded="no"> | |
28517 | <autodoc>GetTextBoxSize(DC dc, list lines) -> (width, height)</autodoc> | |
28518 | <paramlist> | |
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=""/> | |
28523 | </paramlist> | |
28524 | </method> | |
28525 | <method name="BeginBatch" type="" overloaded="no"> | |
781d2982 | 28526 | <autodoc>BeginBatch(self)</autodoc> |
f32fc4bc RD |
28527 | </method> |
28528 | <method name="EndBatch" type="" overloaded="no"> | |
781d2982 | 28529 | <autodoc>EndBatch(self)</autodoc> |
f32fc4bc RD |
28530 | </method> |
28531 | <method name="GetBatchCount" type="int" overloaded="no"> | |
781d2982 | 28532 | <autodoc>GetBatchCount(self) -> int</autodoc> |
f32fc4bc RD |
28533 | </method> |
28534 | <method name="ForceRefresh" type="" overloaded="no"> | |
781d2982 | 28535 | <autodoc>ForceRefresh(self)</autodoc> |
f32fc4bc | 28536 | </method> |
f32fc4bc | 28537 | <method name="IsEditable" type="bool" overloaded="no"> |
781d2982 | 28538 | <autodoc>IsEditable(self) -> bool</autodoc> |
f32fc4bc RD |
28539 | </method> |
28540 | <method name="EnableEditing" type="" overloaded="no"> | |
781d2982 | 28541 | <autodoc>EnableEditing(self, bool edit)</autodoc> |
f32fc4bc RD |
28542 | <paramlist> |
28543 | <param name="edit" type="bool" default=""/> | |
28544 | </paramlist> | |
28545 | </method> | |
28546 | <method name="EnableCellEditControl" type="" overloaded="no"> | |
781d2982 | 28547 | <autodoc>EnableCellEditControl(self, bool enable=True)</autodoc> |
f32fc4bc RD |
28548 | <paramlist> |
28549 | <param name="enable" type="bool" default="True"/> | |
28550 | </paramlist> | |
28551 | </method> | |
28552 | <method name="DisableCellEditControl" type="" overloaded="no"> | |
781d2982 | 28553 | <autodoc>DisableCellEditControl(self)</autodoc> |
f32fc4bc RD |
28554 | </method> |
28555 | <method name="CanEnableCellControl" type="bool" overloaded="no"> | |
781d2982 | 28556 | <autodoc>CanEnableCellControl(self) -> bool</autodoc> |
f32fc4bc RD |
28557 | </method> |
28558 | <method name="IsCellEditControlEnabled" type="bool" overloaded="no"> | |
781d2982 | 28559 | <autodoc>IsCellEditControlEnabled(self) -> bool</autodoc> |
f32fc4bc RD |
28560 | </method> |
28561 | <method name="IsCellEditControlShown" type="bool" overloaded="no"> | |
781d2982 | 28562 | <autodoc>IsCellEditControlShown(self) -> bool</autodoc> |
f32fc4bc RD |
28563 | </method> |
28564 | <method name="IsCurrentCellReadOnly" type="bool" overloaded="no"> | |
781d2982 | 28565 | <autodoc>IsCurrentCellReadOnly(self) -> bool</autodoc> |
f32fc4bc RD |
28566 | </method> |
28567 | <method name="ShowCellEditControl" type="" overloaded="no"> | |
781d2982 | 28568 | <autodoc>ShowCellEditControl(self)</autodoc> |
f32fc4bc RD |
28569 | </method> |
28570 | <method name="HideCellEditControl" type="" overloaded="no"> | |
781d2982 | 28571 | <autodoc>HideCellEditControl(self)</autodoc> |
f32fc4bc RD |
28572 | </method> |
28573 | <method name="SaveEditControlValue" type="" overloaded="no"> | |
781d2982 | 28574 | <autodoc>SaveEditControlValue(self)</autodoc> |
f32fc4bc RD |
28575 | </method> |
28576 | <method name="XYToCell" type="GridCellCoords" overloaded="no"> | |
781d2982 | 28577 | <autodoc>XYToCell(self, int x, int y) -> GridCellCoords</autodoc> |
f32fc4bc RD |
28578 | <paramlist> |
28579 | <param name="x" type="int" default=""/> | |
28580 | <param name="y" type="int" default=""/> | |
28581 | </paramlist> | |
28582 | </method> | |
28583 | <method name="YToRow" type="int" overloaded="no"> | |
781d2982 | 28584 | <autodoc>YToRow(self, int y) -> int</autodoc> |
f32fc4bc RD |
28585 | <paramlist> |
28586 | <param name="y" type="int" default=""/> | |
28587 | </paramlist> | |
28588 | </method> | |
28589 | <method name="XToCol" type="int" overloaded="no"> | |
781d2982 | 28590 | <autodoc>XToCol(self, int x) -> int</autodoc> |
f32fc4bc RD |
28591 | <paramlist> |
28592 | <param name="x" type="int" default=""/> | |
28593 | </paramlist> | |
28594 | </method> | |
28595 | <method name="YToEdgeOfRow" type="int" overloaded="no"> | |
781d2982 | 28596 | <autodoc>YToEdgeOfRow(self, int y) -> int</autodoc> |
f32fc4bc RD |
28597 | <paramlist> |
28598 | <param name="y" type="int" default=""/> | |
28599 | </paramlist> | |
28600 | </method> | |
28601 | <method name="XToEdgeOfCol" type="int" overloaded="no"> | |
781d2982 | 28602 | <autodoc>XToEdgeOfCol(self, int x) -> int</autodoc> |
f32fc4bc RD |
28603 | <paramlist> |
28604 | <param name="x" type="int" default=""/> | |
28605 | </paramlist> | |
28606 | </method> | |
28607 | <method name="CellToRect" type="Rect" overloaded="no"> | |
781d2982 | 28608 | <autodoc>CellToRect(self, int row, int col) -> Rect</autodoc> |
f32fc4bc RD |
28609 | <paramlist> |
28610 | <param name="row" type="int" default=""/> | |
28611 | <param name="col" type="int" default=""/> | |
28612 | </paramlist> | |
28613 | </method> | |
28614 | <method name="GetGridCursorRow" type="int" overloaded="no"> | |
781d2982 | 28615 | <autodoc>GetGridCursorRow(self) -> int</autodoc> |
f32fc4bc RD |
28616 | </method> |
28617 | <method name="GetGridCursorCol" type="int" overloaded="no"> | |
781d2982 | 28618 | <autodoc>GetGridCursorCol(self) -> int</autodoc> |
f32fc4bc RD |
28619 | </method> |
28620 | <method name="IsVisible" type="bool" overloaded="no"> | |
781d2982 | 28621 | <autodoc>IsVisible(self, int row, int col, bool wholeCellVisible=True) -> bool</autodoc> |
f32fc4bc RD |
28622 | <paramlist> |
28623 | <param name="row" type="int" default=""/> | |
28624 | <param name="col" type="int" default=""/> | |
28625 | <param name="wholeCellVisible" type="bool" default="True"/> | |
28626 | </paramlist> | |
28627 | </method> | |
28628 | <method name="MakeCellVisible" type="" overloaded="no"> | |
781d2982 | 28629 | <autodoc>MakeCellVisible(self, int row, int col)</autodoc> |
f32fc4bc RD |
28630 | <paramlist> |
28631 | <param name="row" type="int" default=""/> | |
28632 | <param name="col" type="int" default=""/> | |
28633 | </paramlist> | |
28634 | </method> | |
28635 | <method name="SetGridCursor" type="" overloaded="no"> | |
781d2982 | 28636 | <autodoc>SetGridCursor(self, int row, int col)</autodoc> |
f32fc4bc RD |
28637 | <paramlist> |
28638 | <param name="row" type="int" default=""/> | |
28639 | <param name="col" type="int" default=""/> | |
28640 | </paramlist> | |
28641 | </method> | |
28642 | <method name="MoveCursorUp" type="bool" overloaded="no"> | |
781d2982 | 28643 | <autodoc>MoveCursorUp(self, bool expandSelection) -> bool</autodoc> |
f32fc4bc RD |
28644 | <paramlist> |
28645 | <param name="expandSelection" type="bool" default=""/> | |
28646 | </paramlist> | |
28647 | </method> | |
28648 | <method name="MoveCursorDown" type="bool" overloaded="no"> | |
781d2982 | 28649 | <autodoc>MoveCursorDown(self, bool expandSelection) -> bool</autodoc> |
f32fc4bc RD |
28650 | <paramlist> |
28651 | <param name="expandSelection" type="bool" default=""/> | |
28652 | </paramlist> | |
28653 | </method> | |
28654 | <method name="MoveCursorLeft" type="bool" overloaded="no"> | |
781d2982 | 28655 | <autodoc>MoveCursorLeft(self, bool expandSelection) -> bool</autodoc> |
f32fc4bc RD |
28656 | <paramlist> |
28657 | <param name="expandSelection" type="bool" default=""/> | |
28658 | </paramlist> | |
28659 | </method> | |
28660 | <method name="MoveCursorRight" type="bool" overloaded="no"> | |
781d2982 | 28661 | <autodoc>MoveCursorRight(self, bool expandSelection) -> bool</autodoc> |
f32fc4bc RD |
28662 | <paramlist> |
28663 | <param name="expandSelection" type="bool" default=""/> | |
28664 | </paramlist> | |
28665 | </method> | |
28666 | <method name="MovePageDown" type="bool" overloaded="no"> | |
781d2982 | 28667 | <autodoc>MovePageDown(self) -> bool</autodoc> |
f32fc4bc RD |
28668 | </method> |
28669 | <method name="MovePageUp" type="bool" overloaded="no"> | |
781d2982 | 28670 | <autodoc>MovePageUp(self) -> bool</autodoc> |
f32fc4bc RD |
28671 | </method> |
28672 | <method name="MoveCursorUpBlock" type="bool" overloaded="no"> | |
781d2982 | 28673 | <autodoc>MoveCursorUpBlock(self, bool expandSelection) -> bool</autodoc> |
f32fc4bc RD |
28674 | <paramlist> |
28675 | <param name="expandSelection" type="bool" default=""/> | |
28676 | </paramlist> | |
28677 | </method> | |
28678 | <method name="MoveCursorDownBlock" type="bool" overloaded="no"> | |
781d2982 | 28679 | <autodoc>MoveCursorDownBlock(self, bool expandSelection) -> bool</autodoc> |
f32fc4bc RD |
28680 | <paramlist> |
28681 | <param name="expandSelection" type="bool" default=""/> | |
28682 | </paramlist> | |
28683 | </method> | |
28684 | <method name="MoveCursorLeftBlock" type="bool" overloaded="no"> | |
781d2982 | 28685 | <autodoc>MoveCursorLeftBlock(self, bool expandSelection) -> bool</autodoc> |
f32fc4bc RD |
28686 | <paramlist> |
28687 | <param name="expandSelection" type="bool" default=""/> | |
28688 | </paramlist> | |
28689 | </method> | |
28690 | <method name="MoveCursorRightBlock" type="bool" overloaded="no"> | |
781d2982 | 28691 | <autodoc>MoveCursorRightBlock(self, bool expandSelection) -> bool</autodoc> |
f32fc4bc RD |
28692 | <paramlist> |
28693 | <param name="expandSelection" type="bool" default=""/> | |
28694 | </paramlist> | |
28695 | </method> | |
28696 | <method name="GetDefaultRowLabelSize" type="int" overloaded="no"> | |
781d2982 | 28697 | <autodoc>GetDefaultRowLabelSize(self) -> int</autodoc> |
f32fc4bc RD |
28698 | </method> |
28699 | <method name="GetRowLabelSize" type="int" overloaded="no"> | |
781d2982 | 28700 | <autodoc>GetRowLabelSize(self) -> int</autodoc> |
f32fc4bc RD |
28701 | </method> |
28702 | <method name="GetDefaultColLabelSize" type="int" overloaded="no"> | |
781d2982 | 28703 | <autodoc>GetDefaultColLabelSize(self) -> int</autodoc> |
f32fc4bc RD |
28704 | </method> |
28705 | <method name="GetColLabelSize" type="int" overloaded="no"> | |
781d2982 | 28706 | <autodoc>GetColLabelSize(self) -> int</autodoc> |
f32fc4bc RD |
28707 | </method> |
28708 | <method name="GetLabelBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 28709 | <autodoc>GetLabelBackgroundColour(self) -> Colour</autodoc> |
f32fc4bc RD |
28710 | </method> |
28711 | <method name="GetLabelTextColour" type="Colour" overloaded="no"> | |
781d2982 | 28712 | <autodoc>GetLabelTextColour(self) -> Colour</autodoc> |
f32fc4bc RD |
28713 | </method> |
28714 | <method name="GetLabelFont" type="Font" overloaded="no"> | |
781d2982 | 28715 | <autodoc>GetLabelFont(self) -> Font</autodoc> |
f32fc4bc RD |
28716 | </method> |
28717 | <method name="GetRowLabelAlignment" type="" overloaded="no"> | |
28718 | <autodoc>GetRowLabelAlignment() -> (horiz, vert)</autodoc> | |
28719 | <paramlist> | |
28720 | <param name="OUTPUT" type="int" default=""/> | |
28721 | <param name="OUTPUT" type="int" default=""/> | |
28722 | </paramlist> | |
28723 | </method> | |
28724 | <method name="GetColLabelAlignment" type="" overloaded="no"> | |
28725 | <autodoc>GetColLabelAlignment() -> (horiz, vert)</autodoc> | |
28726 | <paramlist> | |
28727 | <param name="OUTPUT" type="int" default=""/> | |
28728 | <param name="OUTPUT" type="int" default=""/> | |
28729 | </paramlist> | |
28730 | </method> | |
28731 | <method name="GetColLabelTextOrientation" type="int" overloaded="no"> | |
781d2982 | 28732 | <autodoc>GetColLabelTextOrientation(self) -> int</autodoc> |
f32fc4bc RD |
28733 | </method> |
28734 | <method name="GetRowLabelValue" type="String" overloaded="no"> | |
781d2982 | 28735 | <autodoc>GetRowLabelValue(self, int row) -> String</autodoc> |
f32fc4bc RD |
28736 | <paramlist> |
28737 | <param name="row" type="int" default=""/> | |
28738 | </paramlist> | |
28739 | </method> | |
28740 | <method name="GetColLabelValue" type="String" overloaded="no"> | |
781d2982 | 28741 | <autodoc>GetColLabelValue(self, int col) -> String</autodoc> |
f32fc4bc RD |
28742 | <paramlist> |
28743 | <param name="col" type="int" default=""/> | |
28744 | </paramlist> | |
28745 | </method> | |
28746 | <method name="GetGridLineColour" type="Colour" overloaded="no"> | |
781d2982 | 28747 | <autodoc>GetGridLineColour(self) -> Colour</autodoc> |
f32fc4bc RD |
28748 | </method> |
28749 | <method name="GetCellHighlightColour" type="Colour" overloaded="no"> | |
781d2982 | 28750 | <autodoc>GetCellHighlightColour(self) -> Colour</autodoc> |
f32fc4bc RD |
28751 | </method> |
28752 | <method name="GetCellHighlightPenWidth" type="int" overloaded="no"> | |
781d2982 | 28753 | <autodoc>GetCellHighlightPenWidth(self) -> int</autodoc> |
f32fc4bc RD |
28754 | </method> |
28755 | <method name="GetCellHighlightROPenWidth" type="int" overloaded="no"> | |
781d2982 | 28756 | <autodoc>GetCellHighlightROPenWidth(self) -> int</autodoc> |
f32fc4bc RD |
28757 | </method> |
28758 | <method name="SetRowLabelSize" type="" overloaded="no"> | |
781d2982 | 28759 | <autodoc>SetRowLabelSize(self, int width)</autodoc> |
f32fc4bc RD |
28760 | <paramlist> |
28761 | <param name="width" type="int" default=""/> | |
28762 | </paramlist> | |
28763 | </method> | |
28764 | <method name="SetColLabelSize" type="" overloaded="no"> | |
781d2982 | 28765 | <autodoc>SetColLabelSize(self, int height)</autodoc> |
f32fc4bc RD |
28766 | <paramlist> |
28767 | <param name="height" type="int" default=""/> | |
28768 | </paramlist> | |
28769 | </method> | |
28770 | <method name="SetLabelBackgroundColour" type="" overloaded="no"> | |
781d2982 | 28771 | <autodoc>SetLabelBackgroundColour(self, Colour ??)</autodoc> |
f32fc4bc RD |
28772 | <paramlist> |
28773 | <param name="" type="Colour" default=""/> | |
28774 | </paramlist> | |
28775 | </method> | |
28776 | <method name="SetLabelTextColour" type="" overloaded="no"> | |
781d2982 | 28777 | <autodoc>SetLabelTextColour(self, Colour ??)</autodoc> |
f32fc4bc RD |
28778 | <paramlist> |
28779 | <param name="" type="Colour" default=""/> | |
28780 | </paramlist> | |
28781 | </method> | |
28782 | <method name="SetLabelFont" type="" overloaded="no"> | |
781d2982 | 28783 | <autodoc>SetLabelFont(self, Font ??)</autodoc> |
f32fc4bc RD |
28784 | <paramlist> |
28785 | <param name="" type="Font" default=""/> | |
28786 | </paramlist> | |
28787 | </method> | |
28788 | <method name="SetRowLabelAlignment" type="" overloaded="no"> | |
781d2982 | 28789 | <autodoc>SetRowLabelAlignment(self, int horiz, int vert)</autodoc> |
f32fc4bc RD |
28790 | <paramlist> |
28791 | <param name="horiz" type="int" default=""/> | |
28792 | <param name="vert" type="int" default=""/> | |
28793 | </paramlist> | |
28794 | </method> | |
28795 | <method name="SetColLabelAlignment" type="" overloaded="no"> | |
781d2982 | 28796 | <autodoc>SetColLabelAlignment(self, int horiz, int vert)</autodoc> |
f32fc4bc RD |
28797 | <paramlist> |
28798 | <param name="horiz" type="int" default=""/> | |
28799 | <param name="vert" type="int" default=""/> | |
28800 | </paramlist> | |
28801 | </method> | |
28802 | <method name="SetColLabelTextOrientation" type="" overloaded="no"> | |
781d2982 | 28803 | <autodoc>SetColLabelTextOrientation(self, int textOrientation)</autodoc> |
f32fc4bc RD |
28804 | <paramlist> |
28805 | <param name="textOrientation" type="int" default=""/> | |
28806 | </paramlist> | |
28807 | </method> | |
28808 | <method name="SetRowLabelValue" type="" overloaded="no"> | |
781d2982 | 28809 | <autodoc>SetRowLabelValue(self, int row, String ??)</autodoc> |
f32fc4bc RD |
28810 | <paramlist> |
28811 | <param name="row" type="int" default=""/> | |
28812 | <param name="" type="String" default=""/> | |
28813 | </paramlist> | |
28814 | </method> | |
28815 | <method name="SetColLabelValue" type="" overloaded="no"> | |
781d2982 | 28816 | <autodoc>SetColLabelValue(self, int col, String ??)</autodoc> |
f32fc4bc RD |
28817 | <paramlist> |
28818 | <param name="col" type="int" default=""/> | |
28819 | <param name="" type="String" default=""/> | |
28820 | </paramlist> | |
28821 | </method> | |
28822 | <method name="SetGridLineColour" type="" overloaded="no"> | |
781d2982 | 28823 | <autodoc>SetGridLineColour(self, Colour ??)</autodoc> |
f32fc4bc RD |
28824 | <paramlist> |
28825 | <param name="" type="Colour" default=""/> | |
28826 | </paramlist> | |
28827 | </method> | |
28828 | <method name="SetCellHighlightColour" type="" overloaded="no"> | |
781d2982 | 28829 | <autodoc>SetCellHighlightColour(self, Colour ??)</autodoc> |
f32fc4bc RD |
28830 | <paramlist> |
28831 | <param name="" type="Colour" default=""/> | |
28832 | </paramlist> | |
28833 | </method> | |
28834 | <method name="SetCellHighlightPenWidth" type="" overloaded="no"> | |
781d2982 | 28835 | <autodoc>SetCellHighlightPenWidth(self, int width)</autodoc> |
f32fc4bc RD |
28836 | <paramlist> |
28837 | <param name="width" type="int" default=""/> | |
28838 | </paramlist> | |
28839 | </method> | |
28840 | <method name="SetCellHighlightROPenWidth" type="" overloaded="no"> | |
781d2982 | 28841 | <autodoc>SetCellHighlightROPenWidth(self, int width)</autodoc> |
f32fc4bc RD |
28842 | <paramlist> |
28843 | <param name="width" type="int" default=""/> | |
28844 | </paramlist> | |
28845 | </method> | |
28846 | <method name="EnableDragRowSize" type="" overloaded="no"> | |
781d2982 | 28847 | <autodoc>EnableDragRowSize(self, bool enable=True)</autodoc> |
f32fc4bc RD |
28848 | <paramlist> |
28849 | <param name="enable" type="bool" default="True"/> | |
28850 | </paramlist> | |
28851 | </method> | |
28852 | <method name="DisableDragRowSize" type="" overloaded="no"> | |
781d2982 | 28853 | <autodoc>DisableDragRowSize(self)</autodoc> |
f32fc4bc RD |
28854 | </method> |
28855 | <method name="CanDragRowSize" type="bool" overloaded="no"> | |
781d2982 | 28856 | <autodoc>CanDragRowSize(self) -> bool</autodoc> |
f32fc4bc RD |
28857 | </method> |
28858 | <method name="EnableDragColSize" type="" overloaded="no"> | |
781d2982 | 28859 | <autodoc>EnableDragColSize(self, bool enable=True)</autodoc> |
f32fc4bc RD |
28860 | <paramlist> |
28861 | <param name="enable" type="bool" default="True"/> | |
28862 | </paramlist> | |
28863 | </method> | |
28864 | <method name="DisableDragColSize" type="" overloaded="no"> | |
781d2982 | 28865 | <autodoc>DisableDragColSize(self)</autodoc> |
f32fc4bc RD |
28866 | </method> |
28867 | <method name="CanDragColSize" type="bool" overloaded="no"> | |
781d2982 | 28868 | <autodoc>CanDragColSize(self) -> bool</autodoc> |
f32fc4bc RD |
28869 | </method> |
28870 | <method name="EnableDragGridSize" type="" overloaded="no"> | |
781d2982 | 28871 | <autodoc>EnableDragGridSize(self, bool enable=True)</autodoc> |
f32fc4bc RD |
28872 | <paramlist> |
28873 | <param name="enable" type="bool" default="True"/> | |
28874 | </paramlist> | |
28875 | </method> | |
28876 | <method name="DisableDragGridSize" type="" overloaded="no"> | |
781d2982 | 28877 | <autodoc>DisableDragGridSize(self)</autodoc> |
f32fc4bc RD |
28878 | </method> |
28879 | <method name="CanDragGridSize" type="bool" overloaded="no"> | |
781d2982 | 28880 | <autodoc>CanDragGridSize(self) -> bool</autodoc> |
f32fc4bc RD |
28881 | </method> |
28882 | <method name="SetAttr" type="" overloaded="no"> | |
781d2982 | 28883 | <autodoc>SetAttr(self, int row, int col, GridCellAttr attr)</autodoc> |
f32fc4bc RD |
28884 | <paramlist> |
28885 | <param name="row" type="int" default=""/> | |
28886 | <param name="col" type="int" default=""/> | |
28887 | <param name="attr" type="GridCellAttr" default=""/> | |
28888 | </paramlist> | |
28889 | </method> | |
28890 | <method name="SetRowAttr" type="" overloaded="no"> | |
781d2982 | 28891 | <autodoc>SetRowAttr(self, int row, GridCellAttr attr)</autodoc> |
f32fc4bc RD |
28892 | <paramlist> |
28893 | <param name="row" type="int" default=""/> | |
28894 | <param name="attr" type="GridCellAttr" default=""/> | |
28895 | </paramlist> | |
28896 | </method> | |
28897 | <method name="SetColAttr" type="" overloaded="no"> | |
781d2982 | 28898 | <autodoc>SetColAttr(self, int col, GridCellAttr attr)</autodoc> |
f32fc4bc RD |
28899 | <paramlist> |
28900 | <param name="col" type="int" default=""/> | |
28901 | <param name="attr" type="GridCellAttr" default=""/> | |
28902 | </paramlist> | |
28903 | </method> | |
28904 | <method name="SetColFormatBool" type="" overloaded="no"> | |
781d2982 | 28905 | <autodoc>SetColFormatBool(self, int col)</autodoc> |
f32fc4bc RD |
28906 | <paramlist> |
28907 | <param name="col" type="int" default=""/> | |
28908 | </paramlist> | |
28909 | </method> | |
28910 | <method name="SetColFormatNumber" type="" overloaded="no"> | |
781d2982 | 28911 | <autodoc>SetColFormatNumber(self, int col)</autodoc> |
f32fc4bc RD |
28912 | <paramlist> |
28913 | <param name="col" type="int" default=""/> | |
28914 | </paramlist> | |
28915 | </method> | |
28916 | <method name="SetColFormatFloat" type="" overloaded="no"> | |
781d2982 | 28917 | <autodoc>SetColFormatFloat(self, int col, int width=-1, int precision=-1)</autodoc> |
f32fc4bc RD |
28918 | <paramlist> |
28919 | <param name="col" type="int" default=""/> | |
28920 | <param name="width" type="int" default="-1"/> | |
28921 | <param name="precision" type="int" default="-1"/> | |
28922 | </paramlist> | |
28923 | </method> | |
28924 | <method name="SetColFormatCustom" type="" overloaded="no"> | |
781d2982 | 28925 | <autodoc>SetColFormatCustom(self, int col, String typeName)</autodoc> |
f32fc4bc RD |
28926 | <paramlist> |
28927 | <param name="col" type="int" default=""/> | |
28928 | <param name="typeName" type="String" default=""/> | |
28929 | </paramlist> | |
28930 | </method> | |
28931 | <method name="EnableGridLines" type="" overloaded="no"> | |
781d2982 | 28932 | <autodoc>EnableGridLines(self, bool enable=True)</autodoc> |
f32fc4bc RD |
28933 | <paramlist> |
28934 | <param name="enable" type="bool" default="True"/> | |
28935 | </paramlist> | |
28936 | </method> | |
28937 | <method name="GridLinesEnabled" type="bool" overloaded="no"> | |
781d2982 | 28938 | <autodoc>GridLinesEnabled(self) -> bool</autodoc> |
f32fc4bc RD |
28939 | </method> |
28940 | <method name="GetDefaultRowSize" type="int" overloaded="no"> | |
781d2982 | 28941 | <autodoc>GetDefaultRowSize(self) -> int</autodoc> |
f32fc4bc RD |
28942 | </method> |
28943 | <method name="GetRowSize" type="int" overloaded="no"> | |
781d2982 | 28944 | <autodoc>GetRowSize(self, int row) -> int</autodoc> |
f32fc4bc RD |
28945 | <paramlist> |
28946 | <param name="row" type="int" default=""/> | |
28947 | </paramlist> | |
28948 | </method> | |
28949 | <method name="GetDefaultColSize" type="int" overloaded="no"> | |
781d2982 | 28950 | <autodoc>GetDefaultColSize(self) -> int</autodoc> |
f32fc4bc RD |
28951 | </method> |
28952 | <method name="GetColSize" type="int" overloaded="no"> | |
781d2982 | 28953 | <autodoc>GetColSize(self, int col) -> int</autodoc> |
f32fc4bc RD |
28954 | <paramlist> |
28955 | <param name="col" type="int" default=""/> | |
28956 | </paramlist> | |
28957 | </method> | |
28958 | <method name="GetDefaultCellBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 28959 | <autodoc>GetDefaultCellBackgroundColour(self) -> Colour</autodoc> |
f32fc4bc RD |
28960 | </method> |
28961 | <method name="GetCellBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 28962 | <autodoc>GetCellBackgroundColour(self, int row, int col) -> Colour</autodoc> |
f32fc4bc RD |
28963 | <paramlist> |
28964 | <param name="row" type="int" default=""/> | |
28965 | <param name="col" type="int" default=""/> | |
28966 | </paramlist> | |
28967 | </method> | |
28968 | <method name="GetDefaultCellTextColour" type="Colour" overloaded="no"> | |
781d2982 | 28969 | <autodoc>GetDefaultCellTextColour(self) -> Colour</autodoc> |
f32fc4bc RD |
28970 | </method> |
28971 | <method name="GetCellTextColour" type="Colour" overloaded="no"> | |
781d2982 | 28972 | <autodoc>GetCellTextColour(self, int row, int col) -> Colour</autodoc> |
f32fc4bc RD |
28973 | <paramlist> |
28974 | <param name="row" type="int" default=""/> | |
28975 | <param name="col" type="int" default=""/> | |
28976 | </paramlist> | |
28977 | </method> | |
28978 | <method name="GetDefaultCellFont" type="Font" overloaded="no"> | |
781d2982 | 28979 | <autodoc>GetDefaultCellFont(self) -> Font</autodoc> |
f32fc4bc RD |
28980 | </method> |
28981 | <method name="GetCellFont" type="Font" overloaded="no"> | |
781d2982 | 28982 | <autodoc>GetCellFont(self, int row, int col) -> Font</autodoc> |
f32fc4bc RD |
28983 | <paramlist> |
28984 | <param name="row" type="int" default=""/> | |
28985 | <param name="col" type="int" default=""/> | |
28986 | </paramlist> | |
28987 | </method> | |
28988 | <method name="GetDefaultCellAlignment" type="" overloaded="no"> | |
28989 | <autodoc>GetDefaultCellAlignment() -> (horiz, vert)</autodoc> | |
28990 | <paramlist> | |
28991 | <param name="OUTPUT" type="int" default=""/> | |
28992 | <param name="OUTPUT" type="int" default=""/> | |
28993 | </paramlist> | |
28994 | </method> | |
28995 | <method name="GetCellAlignment" type="" overloaded="no"> | |
28996 | <autodoc>GetCellAlignment() -> (horiz, vert)</autodoc> | |
28997 | <paramlist> | |
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=""/> | |
29002 | </paramlist> | |
29003 | </method> | |
29004 | <method name="GetDefaultCellOverflow" type="bool" overloaded="no"> | |
781d2982 | 29005 | <autodoc>GetDefaultCellOverflow(self) -> bool</autodoc> |
f32fc4bc RD |
29006 | </method> |
29007 | <method name="GetCellOverflow" type="bool" overloaded="no"> | |
781d2982 | 29008 | <autodoc>GetCellOverflow(self, int row, int col) -> bool</autodoc> |
f32fc4bc RD |
29009 | <paramlist> |
29010 | <param name="row" type="int" default=""/> | |
29011 | <param name="col" type="int" default=""/> | |
29012 | </paramlist> | |
29013 | </method> | |
29014 | <method name="GetCellSize" type="" overloaded="no"> | |
29015 | <autodoc>GetCellSize(int row, int col) -> (num_rows, num_cols)</autodoc> | |
29016 | <paramlist> | |
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=""/> | |
29021 | </paramlist> | |
29022 | </method> | |
29023 | <method name="SetDefaultRowSize" type="" overloaded="no"> | |
781d2982 | 29024 | <autodoc>SetDefaultRowSize(self, int height, bool resizeExistingRows=False)</autodoc> |
f32fc4bc RD |
29025 | <paramlist> |
29026 | <param name="height" type="int" default=""/> | |
29027 | <param name="resizeExistingRows" type="bool" default="False"/> | |
29028 | </paramlist> | |
29029 | </method> | |
29030 | <method name="SetRowSize" type="" overloaded="no"> | |
781d2982 | 29031 | <autodoc>SetRowSize(self, int row, int height)</autodoc> |
f32fc4bc RD |
29032 | <paramlist> |
29033 | <param name="row" type="int" default=""/> | |
29034 | <param name="height" type="int" default=""/> | |
29035 | </paramlist> | |
29036 | </method> | |
29037 | <method name="SetDefaultColSize" type="" overloaded="no"> | |
781d2982 | 29038 | <autodoc>SetDefaultColSize(self, int width, bool resizeExistingCols=False)</autodoc> |
f32fc4bc RD |
29039 | <paramlist> |
29040 | <param name="width" type="int" default=""/> | |
29041 | <param name="resizeExistingCols" type="bool" default="False"/> | |
29042 | </paramlist> | |
29043 | </method> | |
29044 | <method name="SetColSize" type="" overloaded="no"> | |
781d2982 | 29045 | <autodoc>SetColSize(self, int col, int width)</autodoc> |
f32fc4bc RD |
29046 | <paramlist> |
29047 | <param name="col" type="int" default=""/> | |
29048 | <param name="width" type="int" default=""/> | |
29049 | </paramlist> | |
29050 | </method> | |
29051 | <method name="AutoSizeColumn" type="" overloaded="no"> | |
781d2982 | 29052 | <autodoc>AutoSizeColumn(self, int col, bool setAsMin=True)</autodoc> |
f32fc4bc RD |
29053 | <paramlist> |
29054 | <param name="col" type="int" default=""/> | |
29055 | <param name="setAsMin" type="bool" default="True"/> | |
29056 | </paramlist> | |
29057 | </method> | |
29058 | <method name="AutoSizeRow" type="" overloaded="no"> | |
781d2982 | 29059 | <autodoc>AutoSizeRow(self, int row, bool setAsMin=True)</autodoc> |
f32fc4bc RD |
29060 | <paramlist> |
29061 | <param name="row" type="int" default=""/> | |
29062 | <param name="setAsMin" type="bool" default="True"/> | |
29063 | </paramlist> | |
29064 | </method> | |
29065 | <method name="AutoSizeColumns" type="" overloaded="no"> | |
781d2982 | 29066 | <autodoc>AutoSizeColumns(self, bool setAsMin=True)</autodoc> |
f32fc4bc RD |
29067 | <paramlist> |
29068 | <param name="setAsMin" type="bool" default="True"/> | |
29069 | </paramlist> | |
29070 | </method> | |
29071 | <method name="AutoSizeRows" type="" overloaded="no"> | |
781d2982 | 29072 | <autodoc>AutoSizeRows(self, bool setAsMin=True)</autodoc> |
f32fc4bc RD |
29073 | <paramlist> |
29074 | <param name="setAsMin" type="bool" default="True"/> | |
29075 | </paramlist> | |
29076 | </method> | |
29077 | <method name="AutoSize" type="" overloaded="no"> | |
781d2982 | 29078 | <autodoc>AutoSize(self)</autodoc> |
f32fc4bc RD |
29079 | </method> |
29080 | <method name="AutoSizeRowLabelSize" type="" overloaded="no"> | |
781d2982 | 29081 | <autodoc>AutoSizeRowLabelSize(self, int row)</autodoc> |
f32fc4bc RD |
29082 | <paramlist> |
29083 | <param name="row" type="int" default=""/> | |
29084 | </paramlist> | |
29085 | </method> | |
29086 | <method name="AutoSizeColLabelSize" type="" overloaded="no"> | |
781d2982 | 29087 | <autodoc>AutoSizeColLabelSize(self, int col)</autodoc> |
f32fc4bc RD |
29088 | <paramlist> |
29089 | <param name="col" type="int" default=""/> | |
29090 | </paramlist> | |
29091 | </method> | |
29092 | <method name="SetColMinimalWidth" type="" overloaded="no"> | |
781d2982 | 29093 | <autodoc>SetColMinimalWidth(self, int col, int width)</autodoc> |
f32fc4bc RD |
29094 | <paramlist> |
29095 | <param name="col" type="int" default=""/> | |
29096 | <param name="width" type="int" default=""/> | |
29097 | </paramlist> | |
29098 | </method> | |
29099 | <method name="SetRowMinimalHeight" type="" overloaded="no"> | |
781d2982 | 29100 | <autodoc>SetRowMinimalHeight(self, int row, int width)</autodoc> |
f32fc4bc RD |
29101 | <paramlist> |
29102 | <param name="row" type="int" default=""/> | |
29103 | <param name="width" type="int" default=""/> | |
29104 | </paramlist> | |
29105 | </method> | |
29106 | <method name="SetColMinimalAcceptableWidth" type="" overloaded="no"> | |
781d2982 | 29107 | <autodoc>SetColMinimalAcceptableWidth(self, int width)</autodoc> |
f32fc4bc RD |
29108 | <paramlist> |
29109 | <param name="width" type="int" default=""/> | |
29110 | </paramlist> | |
29111 | </method> | |
29112 | <method name="SetRowMinimalAcceptableHeight" type="" overloaded="no"> | |
781d2982 | 29113 | <autodoc>SetRowMinimalAcceptableHeight(self, int width)</autodoc> |
f32fc4bc RD |
29114 | <paramlist> |
29115 | <param name="width" type="int" default=""/> | |
29116 | </paramlist> | |
29117 | </method> | |
29118 | <method name="GetColMinimalAcceptableWidth" type="int" overloaded="no"> | |
781d2982 | 29119 | <autodoc>GetColMinimalAcceptableWidth(self) -> int</autodoc> |
f32fc4bc RD |
29120 | </method> |
29121 | <method name="GetRowMinimalAcceptableHeight" type="int" overloaded="no"> | |
781d2982 | 29122 | <autodoc>GetRowMinimalAcceptableHeight(self) -> int</autodoc> |
f32fc4bc RD |
29123 | </method> |
29124 | <method name="SetDefaultCellBackgroundColour" type="" overloaded="no"> | |
781d2982 | 29125 | <autodoc>SetDefaultCellBackgroundColour(self, Colour ??)</autodoc> |
f32fc4bc RD |
29126 | <paramlist> |
29127 | <param name="" type="Colour" default=""/> | |
29128 | </paramlist> | |
29129 | </method> | |
29130 | <method name="SetCellBackgroundColour" type="" overloaded="no"> | |
781d2982 | 29131 | <autodoc>SetCellBackgroundColour(self, int row, int col, Colour ??)</autodoc> |
f32fc4bc RD |
29132 | <paramlist> |
29133 | <param name="row" type="int" default=""/> | |
29134 | <param name="col" type="int" default=""/> | |
29135 | <param name="" type="Colour" default=""/> | |
29136 | </paramlist> | |
29137 | </method> | |
29138 | <method name="SetDefaultCellTextColour" type="" overloaded="no"> | |
781d2982 | 29139 | <autodoc>SetDefaultCellTextColour(self, Colour ??)</autodoc> |
f32fc4bc RD |
29140 | <paramlist> |
29141 | <param name="" type="Colour" default=""/> | |
29142 | </paramlist> | |
29143 | </method> | |
29144 | <method name="SetCellTextColour" type="" overloaded="no"> | |
781d2982 | 29145 | <autodoc>SetCellTextColour(self, int row, int col, Colour ??)</autodoc> |
f32fc4bc RD |
29146 | <paramlist> |
29147 | <param name="row" type="int" default=""/> | |
29148 | <param name="col" type="int" default=""/> | |
29149 | <param name="" type="Colour" default=""/> | |
29150 | </paramlist> | |
29151 | </method> | |
29152 | <method name="SetDefaultCellFont" type="" overloaded="no"> | |
781d2982 | 29153 | <autodoc>SetDefaultCellFont(self, Font ??)</autodoc> |
f32fc4bc RD |
29154 | <paramlist> |
29155 | <param name="" type="Font" default=""/> | |
29156 | </paramlist> | |
29157 | </method> | |
29158 | <method name="SetCellFont" type="" overloaded="no"> | |
781d2982 | 29159 | <autodoc>SetCellFont(self, int row, int col, Font ??)</autodoc> |
f32fc4bc RD |
29160 | <paramlist> |
29161 | <param name="row" type="int" default=""/> | |
29162 | <param name="col" type="int" default=""/> | |
29163 | <param name="" type="Font" default=""/> | |
29164 | </paramlist> | |
29165 | </method> | |
29166 | <method name="SetDefaultCellAlignment" type="" overloaded="no"> | |
781d2982 | 29167 | <autodoc>SetDefaultCellAlignment(self, int horiz, int vert)</autodoc> |
f32fc4bc RD |
29168 | <paramlist> |
29169 | <param name="horiz" type="int" default=""/> | |
29170 | <param name="vert" type="int" default=""/> | |
29171 | </paramlist> | |
29172 | </method> | |
29173 | <method name="SetCellAlignment" type="" overloaded="no"> | |
781d2982 | 29174 | <autodoc>SetCellAlignment(self, int row, int col, int horiz, int vert)</autodoc> |
f32fc4bc RD |
29175 | <paramlist> |
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=""/> | |
29180 | </paramlist> | |
29181 | </method> | |
29182 | <method name="SetDefaultCellOverflow" type="" overloaded="no"> | |
781d2982 | 29183 | <autodoc>SetDefaultCellOverflow(self, bool allow)</autodoc> |
f32fc4bc RD |
29184 | <paramlist> |
29185 | <param name="allow" type="bool" default=""/> | |
29186 | </paramlist> | |
29187 | </method> | |
29188 | <method name="SetCellOverflow" type="" overloaded="no"> | |
781d2982 | 29189 | <autodoc>SetCellOverflow(self, int row, int col, bool allow)</autodoc> |
f32fc4bc RD |
29190 | <paramlist> |
29191 | <param name="row" type="int" default=""/> | |
29192 | <param name="col" type="int" default=""/> | |
29193 | <param name="allow" type="bool" default=""/> | |
29194 | </paramlist> | |
29195 | </method> | |
29196 | <method name="SetCellSize" type="" overloaded="no"> | |
781d2982 | 29197 | <autodoc>SetCellSize(self, int row, int col, int num_rows, int num_cols)</autodoc> |
f32fc4bc RD |
29198 | <paramlist> |
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=""/> | |
29203 | </paramlist> | |
29204 | </method> | |
29205 | <method name="SetDefaultRenderer" type="" overloaded="no"> | |
781d2982 | 29206 | <autodoc>SetDefaultRenderer(self, GridCellRenderer renderer)</autodoc> |
f32fc4bc RD |
29207 | <paramlist> |
29208 | <param name="renderer" type="GridCellRenderer" default=""/> | |
29209 | </paramlist> | |
29210 | </method> | |
29211 | <method name="SetCellRenderer" type="" overloaded="no"> | |
781d2982 | 29212 | <autodoc>SetCellRenderer(self, int row, int col, GridCellRenderer renderer)</autodoc> |
f32fc4bc RD |
29213 | <paramlist> |
29214 | <param name="row" type="int" default=""/> | |
29215 | <param name="col" type="int" default=""/> | |
29216 | <param name="renderer" type="GridCellRenderer" default=""/> | |
29217 | </paramlist> | |
29218 | </method> | |
29219 | <method name="GetDefaultRenderer" type="GridCellRenderer" overloaded="no"> | |
781d2982 | 29220 | <autodoc>GetDefaultRenderer(self) -> GridCellRenderer</autodoc> |
f32fc4bc RD |
29221 | </method> |
29222 | <method name="GetCellRenderer" type="GridCellRenderer" overloaded="no"> | |
781d2982 | 29223 | <autodoc>GetCellRenderer(self, int row, int col) -> GridCellRenderer</autodoc> |
f32fc4bc RD |
29224 | <paramlist> |
29225 | <param name="row" type="int" default=""/> | |
29226 | <param name="col" type="int" default=""/> | |
29227 | </paramlist> | |
29228 | </method> | |
29229 | <method name="SetDefaultEditor" type="" overloaded="no"> | |
781d2982 | 29230 | <autodoc>SetDefaultEditor(self, GridCellEditor editor)</autodoc> |
f32fc4bc RD |
29231 | <paramlist> |
29232 | <param name="editor" type="GridCellEditor" default=""/> | |
29233 | </paramlist> | |
29234 | </method> | |
29235 | <method name="SetCellEditor" type="" overloaded="no"> | |
781d2982 | 29236 | <autodoc>SetCellEditor(self, int row, int col, GridCellEditor editor)</autodoc> |
f32fc4bc RD |
29237 | <paramlist> |
29238 | <param name="row" type="int" default=""/> | |
29239 | <param name="col" type="int" default=""/> | |
29240 | <param name="editor" type="GridCellEditor" default=""/> | |
29241 | </paramlist> | |
29242 | </method> | |
29243 | <method name="GetDefaultEditor" type="GridCellEditor" overloaded="no"> | |
781d2982 | 29244 | <autodoc>GetDefaultEditor(self) -> GridCellEditor</autodoc> |
f32fc4bc RD |
29245 | </method> |
29246 | <method name="GetCellEditor" type="GridCellEditor" overloaded="no"> | |
781d2982 | 29247 | <autodoc>GetCellEditor(self, int row, int col) -> GridCellEditor</autodoc> |
f32fc4bc RD |
29248 | <paramlist> |
29249 | <param name="row" type="int" default=""/> | |
29250 | <param name="col" type="int" default=""/> | |
29251 | </paramlist> | |
29252 | </method> | |
29253 | <method name="GetCellValue" type="String" overloaded="no"> | |
781d2982 | 29254 | <autodoc>GetCellValue(self, int row, int col) -> String</autodoc> |
f32fc4bc RD |
29255 | <paramlist> |
29256 | <param name="row" type="int" default=""/> | |
29257 | <param name="col" type="int" default=""/> | |
29258 | </paramlist> | |
29259 | </method> | |
29260 | <method name="SetCellValue" type="" overloaded="no"> | |
781d2982 | 29261 | <autodoc>SetCellValue(self, int row, int col, String s)</autodoc> |
f32fc4bc RD |
29262 | <paramlist> |
29263 | <param name="row" type="int" default=""/> | |
29264 | <param name="col" type="int" default=""/> | |
29265 | <param name="s" type="String" default=""/> | |
29266 | </paramlist> | |
29267 | </method> | |
29268 | <method name="IsReadOnly" type="bool" overloaded="no"> | |
781d2982 | 29269 | <autodoc>IsReadOnly(self, int row, int col) -> bool</autodoc> |
f32fc4bc RD |
29270 | <paramlist> |
29271 | <param name="row" type="int" default=""/> | |
29272 | <param name="col" type="int" default=""/> | |
29273 | </paramlist> | |
29274 | </method> | |
29275 | <method name="SetReadOnly" type="" overloaded="no"> | |
781d2982 | 29276 | <autodoc>SetReadOnly(self, int row, int col, bool isReadOnly=True)</autodoc> |
f32fc4bc RD |
29277 | <paramlist> |
29278 | <param name="row" type="int" default=""/> | |
29279 | <param name="col" type="int" default=""/> | |
29280 | <param name="isReadOnly" type="bool" default="True"/> | |
29281 | </paramlist> | |
29282 | </method> | |
29283 | <method name="SelectRow" type="" overloaded="no"> | |
781d2982 | 29284 | <autodoc>SelectRow(self, int row, bool addToSelected=False)</autodoc> |
f32fc4bc RD |
29285 | <paramlist> |
29286 | <param name="row" type="int" default=""/> | |
29287 | <param name="addToSelected" type="bool" default="False"/> | |
29288 | </paramlist> | |
29289 | </method> | |
29290 | <method name="SelectCol" type="" overloaded="no"> | |
781d2982 | 29291 | <autodoc>SelectCol(self, int col, bool addToSelected=False)</autodoc> |
f32fc4bc RD |
29292 | <paramlist> |
29293 | <param name="col" type="int" default=""/> | |
29294 | <param name="addToSelected" type="bool" default="False"/> | |
29295 | </paramlist> | |
29296 | </method> | |
29297 | <method name="SelectBlock" type="" overloaded="no"> | |
781d2982 | 29298 | <autodoc>SelectBlock(self, int topRow, int leftCol, int bottomRow, int rightCol, |
f32fc4bc RD |
29299 | bool addToSelected=False)</autodoc> |
29300 | <paramlist> | |
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"/> | |
29306 | </paramlist> | |
29307 | </method> | |
29308 | <method name="SelectAll" type="" overloaded="no"> | |
781d2982 | 29309 | <autodoc>SelectAll(self)</autodoc> |
f32fc4bc RD |
29310 | </method> |
29311 | <method name="IsSelection" type="bool" overloaded="no"> | |
781d2982 | 29312 | <autodoc>IsSelection(self) -> bool</autodoc> |
f32fc4bc RD |
29313 | </method> |
29314 | <method name="ClearSelection" type="" overloaded="no"> | |
781d2982 | 29315 | <autodoc>ClearSelection(self)</autodoc> |
f32fc4bc RD |
29316 | </method> |
29317 | <method name="IsInSelection" type="bool" overloaded="no"> | |
781d2982 | 29318 | <autodoc>IsInSelection(self, int row, int col) -> bool</autodoc> |
f32fc4bc RD |
29319 | <paramlist> |
29320 | <param name="row" type="int" default=""/> | |
29321 | <param name="col" type="int" default=""/> | |
29322 | </paramlist> | |
29323 | </method> | |
29324 | <method name="GetSelectedCells" type="wxGridCellCoordsArray" overloaded="no"> | |
781d2982 | 29325 | <autodoc>GetSelectedCells(self) -> wxGridCellCoordsArray</autodoc> |
f32fc4bc RD |
29326 | </method> |
29327 | <method name="GetSelectionBlockTopLeft" type="wxGridCellCoordsArray" overloaded="no"> | |
781d2982 | 29328 | <autodoc>GetSelectionBlockTopLeft(self) -> wxGridCellCoordsArray</autodoc> |
f32fc4bc RD |
29329 | </method> |
29330 | <method name="GetSelectionBlockBottomRight" type="wxGridCellCoordsArray" overloaded="no"> | |
781d2982 | 29331 | <autodoc>GetSelectionBlockBottomRight(self) -> wxGridCellCoordsArray</autodoc> |
f32fc4bc RD |
29332 | </method> |
29333 | <method name="GetSelectedRows" type="wxArrayInt" overloaded="no"> | |
781d2982 | 29334 | <autodoc>GetSelectedRows(self) -> wxArrayInt</autodoc> |
f32fc4bc RD |
29335 | </method> |
29336 | <method name="GetSelectedCols" type="wxArrayInt" overloaded="no"> | |
781d2982 | 29337 | <autodoc>GetSelectedCols(self) -> wxArrayInt</autodoc> |
f32fc4bc RD |
29338 | </method> |
29339 | <method name="DeselectRow" type="" overloaded="no"> | |
781d2982 | 29340 | <autodoc>DeselectRow(self, int row)</autodoc> |
f32fc4bc RD |
29341 | <paramlist> |
29342 | <param name="row" type="int" default=""/> | |
29343 | </paramlist> | |
29344 | </method> | |
29345 | <method name="DeselectCol" type="" overloaded="no"> | |
781d2982 | 29346 | <autodoc>DeselectCol(self, int col)</autodoc> |
f32fc4bc RD |
29347 | <paramlist> |
29348 | <param name="col" type="int" default=""/> | |
29349 | </paramlist> | |
29350 | </method> | |
29351 | <method name="DeselectCell" type="" overloaded="no"> | |
781d2982 | 29352 | <autodoc>DeselectCell(self, int row, int col)</autodoc> |
f32fc4bc RD |
29353 | <paramlist> |
29354 | <param name="row" type="int" default=""/> | |
29355 | <param name="col" type="int" default=""/> | |
29356 | </paramlist> | |
29357 | </method> | |
29358 | <method name="BlockToDeviceRect" type="Rect" overloaded="no"> | |
781d2982 | 29359 | <autodoc>BlockToDeviceRect(self, GridCellCoords topLeft, GridCellCoords bottomRight) -> Rect</autodoc> |
f32fc4bc RD |
29360 | <paramlist> |
29361 | <param name="topLeft" type="GridCellCoords" default=""/> | |
29362 | <param name="bottomRight" type="GridCellCoords" default=""/> | |
29363 | </paramlist> | |
29364 | </method> | |
29365 | <method name="GetSelectionBackground" type="Colour" overloaded="no"> | |
781d2982 | 29366 | <autodoc>GetSelectionBackground(self) -> Colour</autodoc> |
f32fc4bc RD |
29367 | </method> |
29368 | <method name="GetSelectionForeground" type="Colour" overloaded="no"> | |
781d2982 | 29369 | <autodoc>GetSelectionForeground(self) -> Colour</autodoc> |
f32fc4bc RD |
29370 | </method> |
29371 | <method name="SetSelectionBackground" type="" overloaded="no"> | |
781d2982 | 29372 | <autodoc>SetSelectionBackground(self, Colour c)</autodoc> |
f32fc4bc RD |
29373 | <paramlist> |
29374 | <param name="c" type="Colour" default=""/> | |
29375 | </paramlist> | |
29376 | </method> | |
29377 | <method name="SetSelectionForeground" type="" overloaded="no"> | |
781d2982 | 29378 | <autodoc>SetSelectionForeground(self, Colour c)</autodoc> |
f32fc4bc RD |
29379 | <paramlist> |
29380 | <param name="c" type="Colour" default=""/> | |
29381 | </paramlist> | |
29382 | </method> | |
29383 | <method name="RegisterDataType" type="" overloaded="no"> | |
781d2982 | 29384 | <autodoc>RegisterDataType(self, String typeName, GridCellRenderer renderer, GridCellEditor editor)</autodoc> |
f32fc4bc RD |
29385 | <paramlist> |
29386 | <param name="typeName" type="String" default=""/> | |
29387 | <param name="renderer" type="GridCellRenderer" default=""/> | |
29388 | <param name="editor" type="GridCellEditor" default=""/> | |
29389 | </paramlist> | |
29390 | </method> | |
29391 | <method name="GetDefaultEditorForCell" type="GridCellEditor" overloaded="no"> | |
781d2982 | 29392 | <autodoc>GetDefaultEditorForCell(self, int row, int col) -> GridCellEditor</autodoc> |
f32fc4bc RD |
29393 | <paramlist> |
29394 | <param name="row" type="int" default=""/> | |
29395 | <param name="col" type="int" default=""/> | |
29396 | </paramlist> | |
29397 | </method> | |
29398 | <method name="GetDefaultRendererForCell" type="GridCellRenderer" overloaded="no"> | |
781d2982 | 29399 | <autodoc>GetDefaultRendererForCell(self, int row, int col) -> GridCellRenderer</autodoc> |
f32fc4bc RD |
29400 | <paramlist> |
29401 | <param name="row" type="int" default=""/> | |
29402 | <param name="col" type="int" default=""/> | |
29403 | </paramlist> | |
29404 | </method> | |
29405 | <method name="GetDefaultEditorForType" type="GridCellEditor" overloaded="no"> | |
781d2982 | 29406 | <autodoc>GetDefaultEditorForType(self, String typeName) -> GridCellEditor</autodoc> |
f32fc4bc RD |
29407 | <paramlist> |
29408 | <param name="typeName" type="String" default=""/> | |
29409 | </paramlist> | |
29410 | </method> | |
29411 | <method name="GetDefaultRendererForType" type="GridCellRenderer" overloaded="no"> | |
781d2982 | 29412 | <autodoc>GetDefaultRendererForType(self, String typeName) -> GridCellRenderer</autodoc> |
f32fc4bc RD |
29413 | <paramlist> |
29414 | <param name="typeName" type="String" default=""/> | |
29415 | </paramlist> | |
29416 | </method> | |
29417 | <method name="SetMargins" type="" overloaded="no"> | |
781d2982 | 29418 | <autodoc>SetMargins(self, int extraWidth, int extraHeight)</autodoc> |
f32fc4bc RD |
29419 | <paramlist> |
29420 | <param name="extraWidth" type="int" default=""/> | |
29421 | <param name="extraHeight" type="int" default=""/> | |
29422 | </paramlist> | |
29423 | </method> | |
29424 | <method name="GetGridWindow" type="Window" overloaded="no"> | |
781d2982 | 29425 | <autodoc>GetGridWindow(self) -> Window</autodoc> |
f32fc4bc RD |
29426 | </method> |
29427 | <method name="GetGridRowLabelWindow" type="Window" overloaded="no"> | |
781d2982 | 29428 | <autodoc>GetGridRowLabelWindow(self) -> Window</autodoc> |
f32fc4bc RD |
29429 | </method> |
29430 | <method name="GetGridColLabelWindow" type="Window" overloaded="no"> | |
781d2982 | 29431 | <autodoc>GetGridColLabelWindow(self) -> Window</autodoc> |
f32fc4bc RD |
29432 | </method> |
29433 | <method name="GetGridCornerLabelWindow" type="Window" overloaded="no"> | |
781d2982 | 29434 | <autodoc>GetGridCornerLabelWindow(self) -> Window</autodoc> |
f32fc4bc | 29435 | </method> |
781d2982 RD |
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. | |
29443 | ||
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 | |
29447 | this.</docstring> | |
29448 | <paramlist> | |
29449 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
29450 | </paramlist> | |
29451 | </staticmethod> | |
f32fc4bc RD |
29452 | </class> |
29453 | <class name="GridEvent" oldname="wxGridEvent" module="grid"> | |
29454 | <baseclass name="NotifyEvent"/> | |
29455 | <constructor name="GridEvent" overloaded="no"> | |
781d2982 | 29456 | <autodoc>__init__(self, int id, wxEventType type, Grid obj, int row=-1, int col=-1, |
f32fc4bc RD |
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> | |
29460 | <paramlist> | |
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"/> | |
29473 | </paramlist> | |
29474 | </constructor> | |
29475 | <method name="GetRow" type="int" overloaded="no"> | |
781d2982 | 29476 | <autodoc>GetRow(self) -> int</autodoc> |
f32fc4bc RD |
29477 | </method> |
29478 | <method name="GetCol" type="int" overloaded="no"> | |
781d2982 | 29479 | <autodoc>GetCol(self) -> int</autodoc> |
f32fc4bc RD |
29480 | </method> |
29481 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 29482 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
29483 | </method> |
29484 | <method name="Selecting" type="bool" overloaded="no"> | |
781d2982 | 29485 | <autodoc>Selecting(self) -> bool</autodoc> |
f32fc4bc RD |
29486 | </method> |
29487 | <method name="ControlDown" type="bool" overloaded="no"> | |
781d2982 | 29488 | <autodoc>ControlDown(self) -> bool</autodoc> |
f32fc4bc RD |
29489 | </method> |
29490 | <method name="MetaDown" type="bool" overloaded="no"> | |
781d2982 | 29491 | <autodoc>MetaDown(self) -> bool</autodoc> |
f32fc4bc RD |
29492 | </method> |
29493 | <method name="ShiftDown" type="bool" overloaded="no"> | |
781d2982 | 29494 | <autodoc>ShiftDown(self) -> bool</autodoc> |
f32fc4bc RD |
29495 | </method> |
29496 | <method name="AltDown" type="bool" overloaded="no"> | |
781d2982 | 29497 | <autodoc>AltDown(self) -> bool</autodoc> |
f32fc4bc RD |
29498 | </method> |
29499 | </class> | |
29500 | <class name="GridSizeEvent" oldname="wxGridSizeEvent" module="grid"> | |
29501 | <baseclass name="NotifyEvent"/> | |
29502 | <constructor name="GridSizeEvent" overloaded="no"> | |
781d2982 | 29503 | <autodoc>__init__(self, int id, wxEventType type, Grid obj, int rowOrCol=-1, |
f32fc4bc RD |
29504 | int x=-1, int y=-1, bool control=False, bool shift=False, |
29505 | bool alt=False, bool meta=False) -> GridSizeEvent</autodoc> | |
29506 | <paramlist> | |
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"/> | |
29517 | </paramlist> | |
29518 | </constructor> | |
29519 | <method name="GetRowOrCol" type="int" overloaded="no"> | |
781d2982 | 29520 | <autodoc>GetRowOrCol(self) -> int</autodoc> |
f32fc4bc RD |
29521 | </method> |
29522 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 29523 | <autodoc>GetPosition(self) -> Point</autodoc> |
f32fc4bc RD |
29524 | </method> |
29525 | <method name="ControlDown" type="bool" overloaded="no"> | |
781d2982 | 29526 | <autodoc>ControlDown(self) -> bool</autodoc> |
f32fc4bc RD |
29527 | </method> |
29528 | <method name="MetaDown" type="bool" overloaded="no"> | |
781d2982 | 29529 | <autodoc>MetaDown(self) -> bool</autodoc> |
f32fc4bc RD |
29530 | </method> |
29531 | <method name="ShiftDown" type="bool" overloaded="no"> | |
781d2982 | 29532 | <autodoc>ShiftDown(self) -> bool</autodoc> |
f32fc4bc RD |
29533 | </method> |
29534 | <method name="AltDown" type="bool" overloaded="no"> | |
781d2982 | 29535 | <autodoc>AltDown(self) -> bool</autodoc> |
f32fc4bc RD |
29536 | </method> |
29537 | </class> | |
29538 | <class name="GridRangeSelectEvent" oldname="wxGridRangeSelectEvent" module="grid"> | |
29539 | <baseclass name="NotifyEvent"/> | |
29540 | <constructor name="GridRangeSelectEvent" overloaded="no"> | |
781d2982 | 29541 | <autodoc>__init__(self, int id, wxEventType type, Grid obj, GridCellCoords topLeft, |
f32fc4bc RD |
29542 | GridCellCoords bottomRight, bool sel=True, |
29543 | bool control=False, bool shift=False, | |
29544 | bool alt=False, bool meta=False) -> GridRangeSelectEvent</autodoc> | |
29545 | <paramlist> | |
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"/> | |
29556 | </paramlist> | |
29557 | </constructor> | |
29558 | <method name="GetTopLeftCoords" type="GridCellCoords" overloaded="no"> | |
781d2982 | 29559 | <autodoc>GetTopLeftCoords(self) -> GridCellCoords</autodoc> |
f32fc4bc RD |
29560 | </method> |
29561 | <method name="GetBottomRightCoords" type="GridCellCoords" overloaded="no"> | |
781d2982 | 29562 | <autodoc>GetBottomRightCoords(self) -> GridCellCoords</autodoc> |
f32fc4bc RD |
29563 | </method> |
29564 | <method name="GetTopRow" type="int" overloaded="no"> | |
781d2982 | 29565 | <autodoc>GetTopRow(self) -> int</autodoc> |
f32fc4bc RD |
29566 | </method> |
29567 | <method name="GetBottomRow" type="int" overloaded="no"> | |
781d2982 | 29568 | <autodoc>GetBottomRow(self) -> int</autodoc> |
f32fc4bc RD |
29569 | </method> |
29570 | <method name="GetLeftCol" type="int" overloaded="no"> | |
781d2982 | 29571 | <autodoc>GetLeftCol(self) -> int</autodoc> |
f32fc4bc RD |
29572 | </method> |
29573 | <method name="GetRightCol" type="int" overloaded="no"> | |
781d2982 | 29574 | <autodoc>GetRightCol(self) -> int</autodoc> |
f32fc4bc RD |
29575 | </method> |
29576 | <method name="Selecting" type="bool" overloaded="no"> | |
781d2982 | 29577 | <autodoc>Selecting(self) -> bool</autodoc> |
f32fc4bc RD |
29578 | </method> |
29579 | <method name="ControlDown" type="bool" overloaded="no"> | |
781d2982 | 29580 | <autodoc>ControlDown(self) -> bool</autodoc> |
f32fc4bc RD |
29581 | </method> |
29582 | <method name="MetaDown" type="bool" overloaded="no"> | |
781d2982 | 29583 | <autodoc>MetaDown(self) -> bool</autodoc> |
f32fc4bc RD |
29584 | </method> |
29585 | <method name="ShiftDown" type="bool" overloaded="no"> | |
781d2982 | 29586 | <autodoc>ShiftDown(self) -> bool</autodoc> |
f32fc4bc RD |
29587 | </method> |
29588 | <method name="AltDown" type="bool" overloaded="no"> | |
781d2982 | 29589 | <autodoc>AltDown(self) -> bool</autodoc> |
f32fc4bc RD |
29590 | </method> |
29591 | </class> | |
29592 | <class name="GridEditorCreatedEvent" oldname="wxGridEditorCreatedEvent" module="grid"> | |
29593 | <baseclass name="CommandEvent"/> | |
29594 | <constructor name="GridEditorCreatedEvent" overloaded="no"> | |
781d2982 | 29595 | <autodoc>__init__(self, int id, wxEventType type, Object obj, int row, int col, |
f32fc4bc RD |
29596 | Control ctrl) -> GridEditorCreatedEvent</autodoc> |
29597 | <paramlist> | |
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=""/> | |
29604 | </paramlist> | |
29605 | </constructor> | |
29606 | <method name="GetRow" type="int" overloaded="no"> | |
781d2982 | 29607 | <autodoc>GetRow(self) -> int</autodoc> |
f32fc4bc RD |
29608 | </method> |
29609 | <method name="GetCol" type="int" overloaded="no"> | |
781d2982 | 29610 | <autodoc>GetCol(self) -> int</autodoc> |
f32fc4bc RD |
29611 | </method> |
29612 | <method name="GetControl" type="Control" overloaded="no"> | |
781d2982 | 29613 | <autodoc>GetControl(self) -> Control</autodoc> |
f32fc4bc RD |
29614 | </method> |
29615 | <method name="SetRow" type="" overloaded="no"> | |
781d2982 | 29616 | <autodoc>SetRow(self, int row)</autodoc> |
f32fc4bc RD |
29617 | <paramlist> |
29618 | <param name="row" type="int" default=""/> | |
29619 | </paramlist> | |
29620 | </method> | |
29621 | <method name="SetCol" type="" overloaded="no"> | |
781d2982 | 29622 | <autodoc>SetCol(self, int col)</autodoc> |
f32fc4bc RD |
29623 | <paramlist> |
29624 | <param name="col" type="int" default=""/> | |
29625 | </paramlist> | |
29626 | </method> | |
29627 | <method name="SetControl" type="" overloaded="no"> | |
781d2982 | 29628 | <autodoc>SetControl(self, Control ctrl)</autodoc> |
f32fc4bc RD |
29629 | <paramlist> |
29630 | <param name="ctrl" type="Control" default=""/> | |
29631 | </paramlist> | |
29632 | </method> | |
29633 | </class> | |
29634 | <pythoncode> | |
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 ) | |
ce6878e6 RD |
29651 | |
29652 | ||
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 ) | |
0f43fbdf | 29670 | </pythoncode> |
f32fc4bc RD |
29671 | </module> |
29672 | <module name="html"> | |
781d2982 RD |
29673 | <import name="_windows"/> |
29674 | <pythoncode> wx = _core </pythoncode> | |
29675 | <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode> | |
f32fc4bc | 29676 | <pythoncode> |
0f43fbdf RD |
29677 | #--------------------------------------------------------------------------- |
29678 | </pythoncode> | |
f32fc4bc RD |
29679 | <class name="HtmlLinkInfo" oldname="wxHtmlLinkInfo" module="html"> |
29680 | <baseclass name="Object"/> | |
29681 | <constructor name="HtmlLinkInfo" overloaded="no"> | |
781d2982 | 29682 | <autodoc>__init__(self, String href, String target=EmptyString) -> HtmlLinkInfo</autodoc> |
f32fc4bc RD |
29683 | <paramlist> |
29684 | <param name="href" type="String" default=""/> | |
29685 | <param name="target" type="String" default="wxPyEmptyString"/> | |
29686 | </paramlist> | |
29687 | </constructor> | |
29688 | <method name="GetHref" type="String" overloaded="no"> | |
781d2982 | 29689 | <autodoc>GetHref(self) -> String</autodoc> |
f32fc4bc RD |
29690 | </method> |
29691 | <method name="GetTarget" type="String" overloaded="no"> | |
781d2982 | 29692 | <autodoc>GetTarget(self) -> String</autodoc> |
f32fc4bc RD |
29693 | </method> |
29694 | <method name="GetEvent" type="MouseEvent" overloaded="no"> | |
781d2982 | 29695 | <autodoc>GetEvent(self) -> MouseEvent</autodoc> |
f32fc4bc RD |
29696 | </method> |
29697 | <method name="GetHtmlCell" type="wxHtmlCell" overloaded="no"> | |
781d2982 | 29698 | <autodoc>GetHtmlCell(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
29699 | </method> |
29700 | <method name="SetEvent" type="" overloaded="no"> | |
781d2982 | 29701 | <autodoc>SetEvent(self, MouseEvent e)</autodoc> |
f32fc4bc RD |
29702 | <paramlist> |
29703 | <param name="e" type="MouseEvent" default=""/> | |
29704 | </paramlist> | |
29705 | </method> | |
29706 | <method name="SetHtmlCell" type="" overloaded="no"> | |
781d2982 | 29707 | <autodoc>SetHtmlCell(self, HtmlCell e)</autodoc> |
f32fc4bc RD |
29708 | <paramlist> |
29709 | <param name="e" type="wxHtmlCell" default=""/> | |
29710 | </paramlist> | |
29711 | </method> | |
29712 | </class> | |
29713 | <class name="HtmlTag" oldname="wxHtmlTag" module="html"> | |
29714 | <baseclass name="Object"/> | |
29715 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 29716 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
29717 | </method> |
29718 | <method name="HasParam" type="bool" overloaded="no"> | |
781d2982 | 29719 | <autodoc>HasParam(self, String par) -> bool</autodoc> |
f32fc4bc RD |
29720 | <paramlist> |
29721 | <param name="par" type="String" default=""/> | |
29722 | </paramlist> | |
29723 | </method> | |
29724 | <method name="GetParam" type="String" overloaded="no"> | |
781d2982 | 29725 | <autodoc>GetParam(self, String par, int with_commas=False) -> String</autodoc> |
f32fc4bc RD |
29726 | <paramlist> |
29727 | <param name="par" type="String" default=""/> | |
29728 | <param name="with_commas" type="int" default="False"/> | |
29729 | </paramlist> | |
29730 | </method> | |
29731 | <method name="GetAllParams" type="String" overloaded="no"> | |
781d2982 | 29732 | <autodoc>GetAllParams(self) -> String</autodoc> |
f32fc4bc RD |
29733 | </method> |
29734 | <method name="HasEnding" type="bool" overloaded="no"> | |
781d2982 | 29735 | <autodoc>HasEnding(self) -> bool</autodoc> |
f32fc4bc RD |
29736 | </method> |
29737 | <method name="GetBeginPos" type="int" overloaded="no"> | |
781d2982 | 29738 | <autodoc>GetBeginPos(self) -> int</autodoc> |
f32fc4bc RD |
29739 | </method> |
29740 | <method name="GetEndPos1" type="int" overloaded="no"> | |
781d2982 | 29741 | <autodoc>GetEndPos1(self) -> int</autodoc> |
f32fc4bc RD |
29742 | </method> |
29743 | <method name="GetEndPos2" type="int" overloaded="no"> | |
781d2982 | 29744 | <autodoc>GetEndPos2(self) -> int</autodoc> |
f32fc4bc RD |
29745 | </method> |
29746 | </class> | |
29747 | <class name="HtmlParser" oldname="wxHtmlParser" module="html"> | |
29748 | <baseclass name="Object"/> | |
29749 | <method name="SetFS" type="" overloaded="no"> | |
781d2982 | 29750 | <autodoc>SetFS(self, FileSystem fs)</autodoc> |
f32fc4bc RD |
29751 | <paramlist> |
29752 | <param name="fs" type="FileSystem" default=""/> | |
29753 | </paramlist> | |
29754 | </method> | |
29755 | <method name="GetFS" type="FileSystem" overloaded="no"> | |
781d2982 | 29756 | <autodoc>GetFS(self) -> FileSystem</autodoc> |
f32fc4bc RD |
29757 | </method> |
29758 | <method name="Parse" type="Object" overloaded="no"> | |
781d2982 | 29759 | <autodoc>Parse(self, String source) -> Object</autodoc> |
f32fc4bc RD |
29760 | <paramlist> |
29761 | <param name="source" type="String" default=""/> | |
29762 | </paramlist> | |
29763 | </method> | |
29764 | <method name="InitParser" type="" overloaded="no"> | |
781d2982 | 29765 | <autodoc>InitParser(self, String source)</autodoc> |
f32fc4bc RD |
29766 | <paramlist> |
29767 | <param name="source" type="String" default=""/> | |
29768 | </paramlist> | |
29769 | </method> | |
29770 | <method name="DoneParser" type="" overloaded="no"> | |
781d2982 | 29771 | <autodoc>DoneParser(self)</autodoc> |
f32fc4bc RD |
29772 | </method> |
29773 | <method name="DoParsing" type="" overloaded="no"> | |
781d2982 | 29774 | <autodoc>DoParsing(self, int begin_pos, int end_pos)</autodoc> |
f32fc4bc RD |
29775 | <paramlist> |
29776 | <param name="begin_pos" type="int" default=""/> | |
29777 | <param name="end_pos" type="int" default=""/> | |
29778 | </paramlist> | |
29779 | </method> | |
29780 | <method name="StopParsing" type="" overloaded="no"> | |
781d2982 | 29781 | <autodoc>StopParsing(self)</autodoc> |
f32fc4bc RD |
29782 | </method> |
29783 | <method name="AddTagHandler" type="" overloaded="no"> | |
781d2982 | 29784 | <autodoc>AddTagHandler(self, HtmlTagHandler handler)</autodoc> |
f32fc4bc RD |
29785 | <paramlist> |
29786 | <param name="handler" type="wxHtmlTagHandler" default=""/> | |
29787 | </paramlist> | |
29788 | </method> | |
29789 | <method name="GetSource" type="String" overloaded="no"> | |
781d2982 | 29790 | <autodoc>GetSource(self) -> String</autodoc> |
f32fc4bc RD |
29791 | </method> |
29792 | <method name="PushTagHandler" type="" overloaded="no"> | |
781d2982 | 29793 | <autodoc>PushTagHandler(self, HtmlTagHandler handler, String tags)</autodoc> |
f32fc4bc RD |
29794 | <paramlist> |
29795 | <param name="handler" type="wxHtmlTagHandler" default=""/> | |
29796 | <param name="tags" type="String" default=""/> | |
29797 | </paramlist> | |
29798 | </method> | |
29799 | <method name="PopTagHandler" type="" overloaded="no"> | |
781d2982 | 29800 | <autodoc>PopTagHandler(self)</autodoc> |
f32fc4bc RD |
29801 | </method> |
29802 | </class> | |
29803 | <class name="HtmlWinParser" oldname="wxHtmlWinParser" module="html"> | |
29804 | <baseclass name="HtmlParser"/> | |
29805 | <constructor name="HtmlWinParser" overloaded="no"> | |
781d2982 | 29806 | <autodoc>__init__(self, HtmlWindow wnd=None) -> HtmlWinParser</autodoc> |
f32fc4bc RD |
29807 | <paramlist> |
29808 | <param name="wnd" type="wxPyHtmlWindow" default="NULL"/> | |
29809 | </paramlist> | |
29810 | </constructor> | |
29811 | <method name="SetDC" type="" overloaded="no"> | |
781d2982 | 29812 | <autodoc>SetDC(self, DC dc)</autodoc> |
f32fc4bc RD |
29813 | <paramlist> |
29814 | <param name="dc" type="DC" default=""/> | |
29815 | </paramlist> | |
29816 | </method> | |
29817 | <method name="GetDC" type="DC" overloaded="no"> | |
781d2982 | 29818 | <autodoc>GetDC(self) -> DC</autodoc> |
f32fc4bc RD |
29819 | </method> |
29820 | <method name="GetCharHeight" type="int" overloaded="no"> | |
781d2982 | 29821 | <autodoc>GetCharHeight(self) -> int</autodoc> |
f32fc4bc RD |
29822 | </method> |
29823 | <method name="GetCharWidth" type="int" overloaded="no"> | |
781d2982 | 29824 | <autodoc>GetCharWidth(self) -> int</autodoc> |
f32fc4bc RD |
29825 | </method> |
29826 | <method name="GetWindow" type="wxPyHtmlWindow" overloaded="no"> | |
781d2982 | 29827 | <autodoc>GetWindow(self) -> HtmlWindow</autodoc> |
f32fc4bc RD |
29828 | </method> |
29829 | <method name="SetFonts" type="" overloaded="no"> | |
781d2982 | 29830 | <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc> |
f32fc4bc RD |
29831 | <paramlist> |
29832 | <param name="normal_face" type="String" default=""/> | |
29833 | <param name="fixed_face" type="String" default=""/> | |
29834 | <param name="sizes" type="PyObject" default="NULL"/> | |
29835 | </paramlist> | |
29836 | </method> | |
ce6878e6 RD |
29837 | <method name="NormalizeFontSizes" type="" overloaded="no"> |
29838 | <autodoc>NormalizeFontSizes(self, int size=-1)</autodoc> | |
29839 | <paramlist> | |
29840 | <param name="size" type="int" default="-1"/> | |
29841 | </paramlist> | |
29842 | </method> | |
f32fc4bc | 29843 | <method name="GetContainer" type="wxHtmlContainerCell" overloaded="no"> |
781d2982 | 29844 | <autodoc>GetContainer(self) -> HtmlContainerCell</autodoc> |
f32fc4bc RD |
29845 | </method> |
29846 | <method name="OpenContainer" type="wxHtmlContainerCell" overloaded="no"> | |
781d2982 | 29847 | <autodoc>OpenContainer(self) -> HtmlContainerCell</autodoc> |
f32fc4bc RD |
29848 | </method> |
29849 | <method name="SetContainer" type="wxHtmlContainerCell" overloaded="no"> | |
781d2982 | 29850 | <autodoc>SetContainer(self, HtmlContainerCell c) -> HtmlContainerCell</autodoc> |
f32fc4bc RD |
29851 | <paramlist> |
29852 | <param name="c" type="wxHtmlContainerCell" default=""/> | |
29853 | </paramlist> | |
29854 | </method> | |
29855 | <method name="CloseContainer" type="wxHtmlContainerCell" overloaded="no"> | |
781d2982 | 29856 | <autodoc>CloseContainer(self) -> HtmlContainerCell</autodoc> |
f32fc4bc RD |
29857 | </method> |
29858 | <method name="GetFontSize" type="int" overloaded="no"> | |
781d2982 | 29859 | <autodoc>GetFontSize(self) -> int</autodoc> |
f32fc4bc RD |
29860 | </method> |
29861 | <method name="SetFontSize" type="" overloaded="no"> | |
781d2982 | 29862 | <autodoc>SetFontSize(self, int s)</autodoc> |
f32fc4bc RD |
29863 | <paramlist> |
29864 | <param name="s" type="int" default=""/> | |
29865 | </paramlist> | |
29866 | </method> | |
29867 | <method name="GetFontBold" type="int" overloaded="no"> | |
781d2982 | 29868 | <autodoc>GetFontBold(self) -> int</autodoc> |
f32fc4bc RD |
29869 | </method> |
29870 | <method name="SetFontBold" type="" overloaded="no"> | |
781d2982 | 29871 | <autodoc>SetFontBold(self, int x)</autodoc> |
f32fc4bc RD |
29872 | <paramlist> |
29873 | <param name="x" type="int" default=""/> | |
29874 | </paramlist> | |
29875 | </method> | |
29876 | <method name="GetFontItalic" type="int" overloaded="no"> | |
781d2982 | 29877 | <autodoc>GetFontItalic(self) -> int</autodoc> |
f32fc4bc RD |
29878 | </method> |
29879 | <method name="SetFontItalic" type="" overloaded="no"> | |
781d2982 | 29880 | <autodoc>SetFontItalic(self, int x)</autodoc> |
f32fc4bc RD |
29881 | <paramlist> |
29882 | <param name="x" type="int" default=""/> | |
29883 | </paramlist> | |
29884 | </method> | |
29885 | <method name="GetFontUnderlined" type="int" overloaded="no"> | |
781d2982 | 29886 | <autodoc>GetFontUnderlined(self) -> int</autodoc> |
f32fc4bc RD |
29887 | </method> |
29888 | <method name="SetFontUnderlined" type="" overloaded="no"> | |
781d2982 | 29889 | <autodoc>SetFontUnderlined(self, int x)</autodoc> |
f32fc4bc RD |
29890 | <paramlist> |
29891 | <param name="x" type="int" default=""/> | |
29892 | </paramlist> | |
29893 | </method> | |
29894 | <method name="GetFontFixed" type="int" overloaded="no"> | |
781d2982 | 29895 | <autodoc>GetFontFixed(self) -> int</autodoc> |
f32fc4bc RD |
29896 | </method> |
29897 | <method name="SetFontFixed" type="" overloaded="no"> | |
781d2982 | 29898 | <autodoc>SetFontFixed(self, int x)</autodoc> |
f32fc4bc RD |
29899 | <paramlist> |
29900 | <param name="x" type="int" default=""/> | |
29901 | </paramlist> | |
29902 | </method> | |
29903 | <method name="GetAlign" type="int" overloaded="no"> | |
781d2982 | 29904 | <autodoc>GetAlign(self) -> int</autodoc> |
f32fc4bc RD |
29905 | </method> |
29906 | <method name="SetAlign" type="" overloaded="no"> | |
781d2982 | 29907 | <autodoc>SetAlign(self, int a)</autodoc> |
f32fc4bc RD |
29908 | <paramlist> |
29909 | <param name="a" type="int" default=""/> | |
29910 | </paramlist> | |
29911 | </method> | |
29912 | <method name="GetLinkColor" type="Colour" overloaded="no"> | |
781d2982 | 29913 | <autodoc>GetLinkColor(self) -> Colour</autodoc> |
f32fc4bc RD |
29914 | </method> |
29915 | <method name="SetLinkColor" type="" overloaded="no"> | |
781d2982 | 29916 | <autodoc>SetLinkColor(self, Colour clr)</autodoc> |
f32fc4bc RD |
29917 | <paramlist> |
29918 | <param name="clr" type="Colour" default=""/> | |
29919 | </paramlist> | |
29920 | </method> | |
29921 | <method name="GetActualColor" type="Colour" overloaded="no"> | |
781d2982 | 29922 | <autodoc>GetActualColor(self) -> Colour</autodoc> |
f32fc4bc RD |
29923 | </method> |
29924 | <method name="SetActualColor" type="" overloaded="no"> | |
781d2982 | 29925 | <autodoc>SetActualColor(self, Colour clr)</autodoc> |
f32fc4bc RD |
29926 | <paramlist> |
29927 | <param name="clr" type="Colour" default=""/> | |
29928 | </paramlist> | |
29929 | </method> | |
29930 | <method name="SetLink" type="" overloaded="no"> | |
781d2982 | 29931 | <autodoc>SetLink(self, String link)</autodoc> |
f32fc4bc RD |
29932 | <paramlist> |
29933 | <param name="link" type="String" default=""/> | |
29934 | </paramlist> | |
29935 | </method> | |
29936 | <method name="CreateCurrentFont" type="Font" overloaded="no"> | |
781d2982 | 29937 | <autodoc>CreateCurrentFont(self) -> Font</autodoc> |
f32fc4bc RD |
29938 | </method> |
29939 | <method name="GetLink" type="HtmlLinkInfo" overloaded="no"> | |
781d2982 | 29940 | <autodoc>GetLink(self) -> HtmlLinkInfo</autodoc> |
f32fc4bc RD |
29941 | </method> |
29942 | </class> | |
29943 | <class name="HtmlTagHandler" oldname="wxPyHtmlTagHandler" module="html"> | |
29944 | <baseclass name="Object"/> | |
29945 | <constructor name="wxPyHtmlTagHandler" overloaded="no"> | |
781d2982 | 29946 | <autodoc>__init__(self) -> HtmlTagHandler</autodoc> |
f32fc4bc RD |
29947 | </constructor> |
29948 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 29949 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
29950 | <paramlist> |
29951 | <param name="self" type="PyObject" default=""/> | |
29952 | <param name="_class" type="PyObject" default=""/> | |
29953 | </paramlist> | |
29954 | </method> | |
29955 | <method name="SetParser" type="" overloaded="no"> | |
781d2982 | 29956 | <autodoc>SetParser(self, HtmlParser parser)</autodoc> |
f32fc4bc RD |
29957 | <paramlist> |
29958 | <param name="parser" type="HtmlParser" default=""/> | |
29959 | </paramlist> | |
29960 | </method> | |
29961 | <method name="GetParser" type="HtmlParser" overloaded="no"> | |
781d2982 | 29962 | <autodoc>GetParser(self) -> HtmlParser</autodoc> |
f32fc4bc RD |
29963 | </method> |
29964 | <method name="ParseInner" type="" overloaded="no"> | |
781d2982 | 29965 | <autodoc>ParseInner(self, HtmlTag tag)</autodoc> |
f32fc4bc RD |
29966 | <paramlist> |
29967 | <param name="tag" type="HtmlTag" default=""/> | |
29968 | </paramlist> | |
29969 | </method> | |
29970 | </class> | |
29971 | <class name="HtmlWinTagHandler" oldname="wxPyHtmlWinTagHandler" module="html"> | |
29972 | <baseclass name="HtmlTagHandler"/> | |
29973 | <constructor name="wxPyHtmlWinTagHandler" overloaded="no"> | |
781d2982 | 29974 | <autodoc>__init__(self) -> HtmlWinTagHandler</autodoc> |
f32fc4bc RD |
29975 | </constructor> |
29976 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 29977 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
29978 | <paramlist> |
29979 | <param name="self" type="PyObject" default=""/> | |
29980 | <param name="_class" type="PyObject" default=""/> | |
29981 | </paramlist> | |
29982 | </method> | |
29983 | <method name="SetParser" type="" overloaded="no"> | |
781d2982 | 29984 | <autodoc>SetParser(self, HtmlParser parser)</autodoc> |
f32fc4bc RD |
29985 | <paramlist> |
29986 | <param name="parser" type="HtmlParser" default=""/> | |
29987 | </paramlist> | |
29988 | </method> | |
29989 | <method name="GetParser" type="HtmlWinParser" overloaded="no"> | |
781d2982 | 29990 | <autodoc>GetParser(self) -> HtmlWinParser</autodoc> |
f32fc4bc RD |
29991 | </method> |
29992 | <method name="ParseInner" type="" overloaded="no"> | |
781d2982 | 29993 | <autodoc>ParseInner(self, HtmlTag tag)</autodoc> |
f32fc4bc RD |
29994 | <paramlist> |
29995 | <param name="tag" type="HtmlTag" default=""/> | |
29996 | </paramlist> | |
29997 | </method> | |
29998 | </class> | |
29999 | <method name="HtmlWinParser_AddTagHandler" oldname="wxHtmlWinParser_AddTagHandler" type="" overloaded="no"> | |
30000 | <autodoc>HtmlWinParser_AddTagHandler(PyObject tagHandlerClass)</autodoc> | |
30001 | <paramlist> | |
30002 | <param name="tagHandlerClass" type="PyObject" default=""/> | |
856bf319 RD |
30003 | </paramlist> |
30004 | </method> | |
0dd25e81 | 30005 | <pythoncode> |
0f43fbdf RD |
30006 | #--------------------------------------------------------------------------- |
30007 | </pythoncode> | |
f32fc4bc RD |
30008 | <class name="HtmlSelection" oldname="wxHtmlSelection" module="html"> |
30009 | <constructor name="HtmlSelection" overloaded="no"> | |
781d2982 | 30010 | <autodoc>__init__(self) -> HtmlSelection</autodoc> |
f32fc4bc RD |
30011 | </constructor> |
30012 | <destructor name="~wxHtmlSelection" overloaded="no"> | |
781d2982 | 30013 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
30014 | </destructor> |
30015 | <method name="Set" type="" overloaded="no"> | |
781d2982 | 30016 | <autodoc>Set(self, Point fromPos, HtmlCell fromCell, Point toPos, HtmlCell toCell)</autodoc> |
f32fc4bc RD |
30017 | <paramlist> |
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=""/> | |
30022 | </paramlist> | |
30023 | </method> | |
30024 | <method name="SetCells" type="" overloaded="no"> | |
781d2982 | 30025 | <autodoc>SetCells(self, HtmlCell fromCell, HtmlCell toCell)</autodoc> |
f32fc4bc RD |
30026 | <paramlist> |
30027 | <param name="fromCell" type="wxHtmlCell" default=""/> | |
30028 | <param name="toCell" type="wxHtmlCell" default=""/> | |
30029 | </paramlist> | |
30030 | </method> | |
30031 | <method name="GetFromCell" type="wxHtmlCell" overloaded="no"> | |
781d2982 | 30032 | <autodoc>GetFromCell(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
30033 | </method> |
30034 | <method name="GetToCell" type="wxHtmlCell" overloaded="no"> | |
781d2982 | 30035 | <autodoc>GetToCell(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
30036 | </method> |
30037 | <method name="GetFromPos" type="Point" overloaded="no"> | |
781d2982 | 30038 | <autodoc>GetFromPos(self) -> Point</autodoc> |
f32fc4bc RD |
30039 | </method> |
30040 | <method name="GetToPos" type="Point" overloaded="no"> | |
781d2982 | 30041 | <autodoc>GetToPos(self) -> Point</autodoc> |
f32fc4bc RD |
30042 | </method> |
30043 | <method name="GetFromPrivPos" type="Point" overloaded="no"> | |
781d2982 | 30044 | <autodoc>GetFromPrivPos(self) -> Point</autodoc> |
f32fc4bc RD |
30045 | </method> |
30046 | <method name="GetToPrivPos" type="Point" overloaded="no"> | |
781d2982 | 30047 | <autodoc>GetToPrivPos(self) -> Point</autodoc> |
f32fc4bc RD |
30048 | </method> |
30049 | <method name="SetFromPrivPos" type="" overloaded="no"> | |
781d2982 | 30050 | <autodoc>SetFromPrivPos(self, Point pos)</autodoc> |
f32fc4bc RD |
30051 | <paramlist> |
30052 | <param name="pos" type="Point" default=""/> | |
30053 | </paramlist> | |
30054 | </method> | |
30055 | <method name="SetToPrivPos" type="" overloaded="no"> | |
781d2982 | 30056 | <autodoc>SetToPrivPos(self, Point pos)</autodoc> |
f32fc4bc RD |
30057 | <paramlist> |
30058 | <param name="pos" type="Point" default=""/> | |
30059 | </paramlist> | |
30060 | </method> | |
30061 | <method name="ClearPrivPos" type="" overloaded="no"> | |
781d2982 | 30062 | <autodoc>ClearPrivPos(self)</autodoc> |
f32fc4bc RD |
30063 | </method> |
30064 | <method name="IsEmpty" type="bool" overloaded="no"> | |
781d2982 | 30065 | <autodoc>IsEmpty(self) -> bool</autodoc> |
f32fc4bc RD |
30066 | </method> |
30067 | </class> | |
30068 | <class name="HtmlRenderingState" oldname="wxHtmlRenderingState" module="html"> | |
30069 | <constructor name="HtmlRenderingState" overloaded="no"> | |
781d2982 | 30070 | <autodoc>__init__(self) -> HtmlRenderingState</autodoc> |
f32fc4bc RD |
30071 | </constructor> |
30072 | <destructor name="~wxHtmlRenderingState" overloaded="no"> | |
781d2982 | 30073 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
30074 | </destructor> |
30075 | <method name="SetSelectionState" type="" overloaded="no"> | |
781d2982 | 30076 | <autodoc>SetSelectionState(self, int s)</autodoc> |
f32fc4bc RD |
30077 | <paramlist> |
30078 | <param name="s" type="wxHtmlSelectionState" default=""/> | |
30079 | </paramlist> | |
30080 | </method> | |
30081 | <method name="GetSelectionState" type="wxHtmlSelectionState" overloaded="no"> | |
781d2982 | 30082 | <autodoc>GetSelectionState(self) -> int</autodoc> |
f32fc4bc RD |
30083 | </method> |
30084 | <method name="SetFgColour" type="" overloaded="no"> | |
781d2982 | 30085 | <autodoc>SetFgColour(self, Colour c)</autodoc> |
f32fc4bc RD |
30086 | <paramlist> |
30087 | <param name="c" type="Colour" default=""/> | |
30088 | </paramlist> | |
30089 | </method> | |
30090 | <method name="GetFgColour" type="Colour" overloaded="no"> | |
781d2982 | 30091 | <autodoc>GetFgColour(self) -> Colour</autodoc> |
f32fc4bc RD |
30092 | </method> |
30093 | <method name="SetBgColour" type="" overloaded="no"> | |
781d2982 | 30094 | <autodoc>SetBgColour(self, Colour c)</autodoc> |
f32fc4bc RD |
30095 | <paramlist> |
30096 | <param name="c" type="Colour" default=""/> | |
30097 | </paramlist> | |
30098 | </method> | |
30099 | <method name="GetBgColour" type="Colour" overloaded="no"> | |
781d2982 | 30100 | <autodoc>GetBgColour(self) -> Colour</autodoc> |
f32fc4bc RD |
30101 | </method> |
30102 | </class> | |
30103 | <class name="HtmlRenderingStyle" oldname="wxHtmlRenderingStyle" module="html"> | |
30104 | <method name="GetSelectedTextColour" type="Colour" overloaded="no"> | |
781d2982 | 30105 | <autodoc>GetSelectedTextColour(self, Colour clr) -> Colour</autodoc> |
f32fc4bc RD |
30106 | <paramlist> |
30107 | <param name="clr" type="Colour" default=""/> | |
30108 | </paramlist> | |
30109 | </method> | |
30110 | <method name="GetSelectedTextBgColour" type="Colour" overloaded="no"> | |
781d2982 | 30111 | <autodoc>GetSelectedTextBgColour(self, Colour clr) -> Colour</autodoc> |
f32fc4bc RD |
30112 | <paramlist> |
30113 | <param name="clr" type="Colour" default=""/> | |
30114 | </paramlist> | |
30115 | </method> | |
30116 | </class> | |
30117 | <class name="DefaultHtmlRenderingStyle" oldname="wxDefaultHtmlRenderingStyle" module="html"> | |
30118 | <baseclass name="HtmlRenderingStyle"/> | |
30119 | <method name="GetSelectedTextColour" type="Colour" overloaded="no"> | |
781d2982 | 30120 | <autodoc>GetSelectedTextColour(self, Colour clr) -> Colour</autodoc> |
f32fc4bc RD |
30121 | <paramlist> |
30122 | <param name="clr" type="Colour" default=""/> | |
30123 | </paramlist> | |
30124 | </method> | |
30125 | <method name="GetSelectedTextBgColour" type="Colour" overloaded="no"> | |
781d2982 | 30126 | <autodoc>GetSelectedTextBgColour(self, Colour clr) -> Colour</autodoc> |
f32fc4bc RD |
30127 | <paramlist> |
30128 | <param name="clr" type="Colour" default=""/> | |
30129 | </paramlist> | |
30130 | </method> | |
30131 | </class> | |
30132 | <class name="HtmlRenderingInfo" oldname="wxHtmlRenderingInfo" module="html"> | |
30133 | <constructor name="HtmlRenderingInfo" overloaded="no"> | |
781d2982 | 30134 | <autodoc>__init__(self) -> HtmlRenderingInfo</autodoc> |
f32fc4bc RD |
30135 | </constructor> |
30136 | <destructor name="~wxHtmlRenderingInfo" overloaded="no"> | |
781d2982 | 30137 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
30138 | </destructor> |
30139 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 30140 | <autodoc>SetSelection(self, HtmlSelection s)</autodoc> |
f32fc4bc RD |
30141 | <paramlist> |
30142 | <param name="s" type="HtmlSelection" default=""/> | |
30143 | </paramlist> | |
30144 | </method> | |
30145 | <method name="GetSelection" type="HtmlSelection" overloaded="no"> | |
781d2982 | 30146 | <autodoc>GetSelection(self) -> HtmlSelection</autodoc> |
f32fc4bc RD |
30147 | </method> |
30148 | <method name="SetStyle" type="" overloaded="no"> | |
781d2982 | 30149 | <autodoc>SetStyle(self, HtmlRenderingStyle style)</autodoc> |
f32fc4bc RD |
30150 | <paramlist> |
30151 | <param name="style" type="HtmlRenderingStyle" default=""/> | |
30152 | </paramlist> | |
30153 | </method> | |
30154 | <method name="GetStyle" type="HtmlRenderingStyle" overloaded="no"> | |
781d2982 | 30155 | <autodoc>GetStyle(self) -> HtmlRenderingStyle</autodoc> |
f32fc4bc RD |
30156 | </method> |
30157 | <method name="GetState" type="HtmlRenderingState" overloaded="no"> | |
781d2982 | 30158 | <autodoc>GetState(self) -> HtmlRenderingState</autodoc> |
f32fc4bc RD |
30159 | </method> |
30160 | </class> | |
30161 | <pythoncode> | |
30162 | #--------------------------------------------------------------------------- | |
856bf319 | 30163 | </pythoncode> |
f32fc4bc RD |
30164 | <class name="HtmlCell" oldname="wxHtmlCell" module="html"> |
30165 | <baseclass name="Object"/> | |
30166 | <constructor name="HtmlCell" overloaded="no"> | |
781d2982 | 30167 | <autodoc>__init__(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
30168 | </constructor> |
30169 | <method name="GetPosX" type="int" overloaded="no"> | |
781d2982 | 30170 | <autodoc>GetPosX(self) -> int</autodoc> |
f32fc4bc RD |
30171 | </method> |
30172 | <method name="GetPosY" type="int" overloaded="no"> | |
781d2982 | 30173 | <autodoc>GetPosY(self) -> int</autodoc> |
f32fc4bc RD |
30174 | </method> |
30175 | <method name="GetWidth" type="int" overloaded="no"> | |
781d2982 | 30176 | <autodoc>GetWidth(self) -> int</autodoc> |
f32fc4bc RD |
30177 | </method> |
30178 | <method name="GetHeight" type="int" overloaded="no"> | |
781d2982 | 30179 | <autodoc>GetHeight(self) -> int</autodoc> |
f32fc4bc RD |
30180 | </method> |
30181 | <method name="GetDescent" type="int" overloaded="no"> | |
781d2982 | 30182 | <autodoc>GetDescent(self) -> int</autodoc> |
f32fc4bc | 30183 | </method> |
368d20e8 | 30184 | <method name="GetMaxTotalWidth" type="int" overloaded="no"> |
781d2982 | 30185 | <autodoc>GetMaxTotalWidth(self) -> int</autodoc> |
368d20e8 | 30186 | </method> |
f32fc4bc | 30187 | <method name="GetId" type="String" overloaded="no"> |
781d2982 | 30188 | <autodoc>GetId(self) -> String</autodoc> |
f32fc4bc RD |
30189 | </method> |
30190 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 30191 | <autodoc>SetId(self, String id)</autodoc> |
f32fc4bc RD |
30192 | <paramlist> |
30193 | <param name="id" type="String" default=""/> | |
30194 | </paramlist> | |
30195 | </method> | |
30196 | <method name="GetLink" type="HtmlLinkInfo" overloaded="no"> | |
781d2982 | 30197 | <autodoc>GetLink(self, int x=0, int y=0) -> HtmlLinkInfo</autodoc> |
f32fc4bc RD |
30198 | <paramlist> |
30199 | <param name="x" type="int" default="0"/> | |
30200 | <param name="y" type="int" default="0"/> | |
30201 | </paramlist> | |
30202 | </method> | |
30203 | <method name="GetNext" type="HtmlCell" overloaded="no"> | |
781d2982 | 30204 | <autodoc>GetNext(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
30205 | </method> |
30206 | <method name="GetParent" type="wxHtmlContainerCell" overloaded="no"> | |
781d2982 | 30207 | <autodoc>GetParent(self) -> HtmlContainerCell</autodoc> |
f32fc4bc RD |
30208 | </method> |
30209 | <method name="GetFirstChild" type="HtmlCell" overloaded="no"> | |
781d2982 | 30210 | <autodoc>GetFirstChild(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
30211 | </method> |
30212 | <method name="GetCursor" type="Cursor" overloaded="no"> | |
781d2982 | 30213 | <autodoc>GetCursor(self) -> Cursor</autodoc> |
f32fc4bc RD |
30214 | </method> |
30215 | <method name="IsFormattingCell" type="bool" overloaded="no"> | |
781d2982 | 30216 | <autodoc>IsFormattingCell(self) -> bool</autodoc> |
f32fc4bc RD |
30217 | </method> |
30218 | <method name="SetLink" type="" overloaded="no"> | |
781d2982 | 30219 | <autodoc>SetLink(self, HtmlLinkInfo link)</autodoc> |
f32fc4bc RD |
30220 | <paramlist> |
30221 | <param name="link" type="HtmlLinkInfo" default=""/> | |
30222 | </paramlist> | |
30223 | </method> | |
30224 | <method name="SetNext" type="" overloaded="no"> | |
781d2982 | 30225 | <autodoc>SetNext(self, HtmlCell cell)</autodoc> |
f32fc4bc RD |
30226 | <paramlist> |
30227 | <param name="cell" type="HtmlCell" default=""/> | |
30228 | </paramlist> | |
30229 | </method> | |
30230 | <method name="SetParent" type="" overloaded="no"> | |
781d2982 | 30231 | <autodoc>SetParent(self, HtmlContainerCell p)</autodoc> |
f32fc4bc RD |
30232 | <paramlist> |
30233 | <param name="p" type="wxHtmlContainerCell" default=""/> | |
30234 | </paramlist> | |
30235 | </method> | |
30236 | <method name="SetPos" type="" overloaded="no"> | |
781d2982 | 30237 | <autodoc>SetPos(self, int x, int y)</autodoc> |
f32fc4bc RD |
30238 | <paramlist> |
30239 | <param name="x" type="int" default=""/> | |
30240 | <param name="y" type="int" default=""/> | |
30241 | </paramlist> | |
30242 | </method> | |
30243 | <method name="Layout" type="" overloaded="no"> | |
781d2982 | 30244 | <autodoc>Layout(self, int w)</autodoc> |
f32fc4bc RD |
30245 | <paramlist> |
30246 | <param name="w" type="int" default=""/> | |
30247 | </paramlist> | |
30248 | </method> | |
30249 | <method name="Draw" type="" overloaded="no"> | |
781d2982 | 30250 | <autodoc>Draw(self, DC dc, int x, int y, int view_y1, int view_y2, HtmlRenderingInfo info)</autodoc> |
f32fc4bc RD |
30251 | <paramlist> |
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=""/> | |
30258 | </paramlist> | |
30259 | </method> | |
30260 | <method name="DrawInvisible" type="" overloaded="no"> | |
781d2982 | 30261 | <autodoc>DrawInvisible(self, DC dc, int x, int y, HtmlRenderingInfo info)</autodoc> |
f32fc4bc RD |
30262 | <paramlist> |
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=""/> | |
30267 | </paramlist> | |
30268 | </method> | |
30269 | <method name="Find" type="HtmlCell" overloaded="no"> | |
781d2982 | 30270 | <autodoc>Find(self, int condition, void param) -> HtmlCell</autodoc> |
f32fc4bc RD |
30271 | <paramlist> |
30272 | <param name="condition" type="int" default=""/> | |
30273 | <param name="param" type="" default=""/> | |
30274 | </paramlist> | |
30275 | </method> | |
30276 | <method name="AdjustPagebreak" type="bool" overloaded="no"> | |
781d2982 | 30277 | <autodoc>AdjustPagebreak(self, int INOUT) -> bool</autodoc> |
f32fc4bc RD |
30278 | <paramlist> |
30279 | <param name="INOUT" type="int" default=""/> | |
30280 | </paramlist> | |
30281 | </method> | |
30282 | <method name="SetCanLiveOnPagebreak" type="" overloaded="no"> | |
781d2982 | 30283 | <autodoc>SetCanLiveOnPagebreak(self, bool can)</autodoc> |
f32fc4bc RD |
30284 | <paramlist> |
30285 | <param name="can" type="bool" default=""/> | |
30286 | </paramlist> | |
30287 | </method> | |
30288 | <method name="IsLinebreakAllowed" type="bool" overloaded="no"> | |
781d2982 | 30289 | <autodoc>IsLinebreakAllowed(self) -> bool</autodoc> |
f32fc4bc RD |
30290 | </method> |
30291 | <method name="IsTerminalCell" type="bool" overloaded="no"> | |
781d2982 | 30292 | <autodoc>IsTerminalCell(self) -> bool</autodoc> |
f32fc4bc RD |
30293 | </method> |
30294 | <method name="FindCellByPos" type="HtmlCell" overloaded="no"> | |
781d2982 | 30295 | <autodoc>FindCellByPos(self, int x, int y, unsigned int flags=HTML_FIND_EXACT) -> HtmlCell</autodoc> |
f32fc4bc RD |
30296 | <paramlist> |
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"/> | |
30300 | </paramlist> | |
30301 | </method> | |
30302 | <method name="GetAbsPos" type="Point" overloaded="no"> | |
781d2982 | 30303 | <autodoc>GetAbsPos(self) -> Point</autodoc> |
f32fc4bc RD |
30304 | </method> |
30305 | <method name="GetFirstTerminal" type="HtmlCell" overloaded="no"> | |
781d2982 | 30306 | <autodoc>GetFirstTerminal(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
30307 | </method> |
30308 | <method name="GetLastTerminal" type="HtmlCell" overloaded="no"> | |
781d2982 | 30309 | <autodoc>GetLastTerminal(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
30310 | </method> |
30311 | <method name="GetDepth" type="unsigned int" overloaded="no"> | |
781d2982 | 30312 | <autodoc>GetDepth(self) -> unsigned int</autodoc> |
f32fc4bc RD |
30313 | </method> |
30314 | <method name="IsBefore" type="bool" overloaded="no"> | |
781d2982 | 30315 | <autodoc>IsBefore(self, HtmlCell cell) -> bool</autodoc> |
f32fc4bc RD |
30316 | <paramlist> |
30317 | <param name="cell" type="HtmlCell" default=""/> | |
30318 | </paramlist> | |
30319 | </method> | |
30320 | <method name="ConvertToText" type="String" overloaded="no"> | |
781d2982 | 30321 | <autodoc>ConvertToText(self, HtmlSelection sel) -> String</autodoc> |
f32fc4bc RD |
30322 | <paramlist> |
30323 | <param name="sel" type="HtmlSelection" default=""/> | |
30324 | </paramlist> | |
30325 | </method> | |
30326 | </class> | |
30327 | <class name="HtmlWordCell" oldname="wxHtmlWordCell" module="html"> | |
30328 | <baseclass name="HtmlCell"/> | |
30329 | <constructor name="HtmlWordCell" overloaded="no"> | |
781d2982 | 30330 | <autodoc>__init__(self, String word, DC dc) -> HtmlWordCell</autodoc> |
f32fc4bc RD |
30331 | <paramlist> |
30332 | <param name="word" type="String" default=""/> | |
30333 | <param name="dc" type="DC" default=""/> | |
30334 | </paramlist> | |
30335 | </constructor> | |
30336 | </class> | |
30337 | <class name="HtmlContainerCell" oldname="wxHtmlContainerCell" module="html"> | |
30338 | <baseclass name="HtmlCell"/> | |
30339 | <constructor name="HtmlContainerCell" overloaded="no"> | |
781d2982 | 30340 | <autodoc>__init__(self, HtmlContainerCell parent) -> HtmlContainerCell</autodoc> |
f32fc4bc RD |
30341 | <paramlist> |
30342 | <param name="parent" type="HtmlContainerCell" default=""/> | |
30343 | </paramlist> | |
30344 | </constructor> | |
30345 | <method name="InsertCell" type="" overloaded="no"> | |
781d2982 | 30346 | <autodoc>InsertCell(self, HtmlCell cell)</autodoc> |
f32fc4bc RD |
30347 | <paramlist> |
30348 | <param name="cell" type="HtmlCell" default=""/> | |
30349 | </paramlist> | |
30350 | </method> | |
30351 | <method name="SetAlignHor" type="" overloaded="no"> | |
781d2982 | 30352 | <autodoc>SetAlignHor(self, int al)</autodoc> |
f32fc4bc RD |
30353 | <paramlist> |
30354 | <param name="al" type="int" default=""/> | |
30355 | </paramlist> | |
30356 | </method> | |
30357 | <method name="GetAlignHor" type="int" overloaded="no"> | |
781d2982 | 30358 | <autodoc>GetAlignHor(self) -> int</autodoc> |
f32fc4bc RD |
30359 | </method> |
30360 | <method name="SetAlignVer" type="" overloaded="no"> | |
781d2982 | 30361 | <autodoc>SetAlignVer(self, int al)</autodoc> |
f32fc4bc RD |
30362 | <paramlist> |
30363 | <param name="al" type="int" default=""/> | |
30364 | </paramlist> | |
30365 | </method> | |
30366 | <method name="GetAlignVer" type="int" overloaded="no"> | |
781d2982 | 30367 | <autodoc>GetAlignVer(self) -> int</autodoc> |
f32fc4bc RD |
30368 | </method> |
30369 | <method name="SetIndent" type="" overloaded="no"> | |
781d2982 | 30370 | <autodoc>SetIndent(self, int i, int what, int units=HTML_UNITS_PIXELS)</autodoc> |
f32fc4bc RD |
30371 | <paramlist> |
30372 | <param name="i" type="int" default=""/> | |
30373 | <param name="what" type="int" default=""/> | |
30374 | <param name="units" type="int" default="wxHTML_UNITS_PIXELS"/> | |
30375 | </paramlist> | |
30376 | </method> | |
30377 | <method name="GetIndent" type="int" overloaded="no"> | |
781d2982 | 30378 | <autodoc>GetIndent(self, int ind) -> int</autodoc> |
f32fc4bc RD |
30379 | <paramlist> |
30380 | <param name="ind" type="int" default=""/> | |
30381 | </paramlist> | |
30382 | </method> | |
30383 | <method name="GetIndentUnits" type="int" overloaded="no"> | |
781d2982 | 30384 | <autodoc>GetIndentUnits(self, int ind) -> int</autodoc> |
f32fc4bc RD |
30385 | <paramlist> |
30386 | <param name="ind" type="int" default=""/> | |
30387 | </paramlist> | |
30388 | </method> | |
30389 | <method name="SetAlign" type="" overloaded="no"> | |
781d2982 | 30390 | <autodoc>SetAlign(self, HtmlTag tag)</autodoc> |
f32fc4bc RD |
30391 | <paramlist> |
30392 | <param name="tag" type="HtmlTag" default=""/> | |
30393 | </paramlist> | |
30394 | </method> | |
30395 | <method name="SetWidthFloat" type="" overloaded="no"> | |
781d2982 | 30396 | <autodoc>SetWidthFloat(self, int w, int units)</autodoc> |
f32fc4bc RD |
30397 | <paramlist> |
30398 | <param name="w" type="int" default=""/> | |
30399 | <param name="units" type="int" default=""/> | |
30400 | </paramlist> | |
30401 | </method> | |
30402 | <method name="SetWidthFloatFromTag" type="" overloaded="no"> | |
781d2982 | 30403 | <autodoc>SetWidthFloatFromTag(self, HtmlTag tag)</autodoc> |
f32fc4bc RD |
30404 | <paramlist> |
30405 | <param name="tag" type="HtmlTag" default=""/> | |
30406 | </paramlist> | |
30407 | </method> | |
30408 | <method name="SetMinHeight" type="" overloaded="no"> | |
781d2982 | 30409 | <autodoc>SetMinHeight(self, int h, int align=HTML_ALIGN_TOP)</autodoc> |
f32fc4bc RD |
30410 | <paramlist> |
30411 | <param name="h" type="int" default=""/> | |
30412 | <param name="align" type="int" default="wxHTML_ALIGN_TOP"/> | |
30413 | </paramlist> | |
30414 | </method> | |
30415 | <method name="SetBackgroundColour" type="" overloaded="no"> | |
781d2982 | 30416 | <autodoc>SetBackgroundColour(self, Colour clr)</autodoc> |
f32fc4bc RD |
30417 | <paramlist> |
30418 | <param name="clr" type="Colour" default=""/> | |
30419 | </paramlist> | |
30420 | </method> | |
30421 | <method name="GetBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 30422 | <autodoc>GetBackgroundColour(self) -> Colour</autodoc> |
f32fc4bc RD |
30423 | </method> |
30424 | <method name="SetBorder" type="" overloaded="no"> | |
781d2982 | 30425 | <autodoc>SetBorder(self, Colour clr1, Colour clr2)</autodoc> |
f32fc4bc RD |
30426 | <paramlist> |
30427 | <param name="clr1" type="Colour" default=""/> | |
30428 | <param name="clr2" type="Colour" default=""/> | |
30429 | </paramlist> | |
30430 | </method> | |
30431 | <method name="GetFirstChild" type="HtmlCell" overloaded="no"> | |
781d2982 | 30432 | <autodoc>GetFirstChild(self) -> HtmlCell</autodoc> |
f32fc4bc RD |
30433 | </method> |
30434 | </class> | |
30435 | <class name="HtmlColourCell" oldname="wxHtmlColourCell" module="html"> | |
30436 | <baseclass name="HtmlCell"/> | |
30437 | <constructor name="HtmlColourCell" overloaded="no"> | |
781d2982 | 30438 | <autodoc>__init__(self, Colour clr, int flags=HTML_CLR_FOREGROUND) -> HtmlColourCell</autodoc> |
f32fc4bc RD |
30439 | <paramlist> |
30440 | <param name="clr" type="Colour" default=""/> | |
30441 | <param name="flags" type="int" default="wxHTML_CLR_FOREGROUND"/> | |
30442 | </paramlist> | |
30443 | </constructor> | |
30444 | </class> | |
30445 | <class name="HtmlFontCell" oldname="wxHtmlFontCell" module="html"> | |
30446 | <baseclass name="HtmlCell"/> | |
30447 | <constructor name="HtmlFontCell" overloaded="no"> | |
781d2982 | 30448 | <autodoc>__init__(self, Font font) -> HtmlFontCell</autodoc> |
f32fc4bc RD |
30449 | <paramlist> |
30450 | <param name="font" type="Font" default=""/> | |
30451 | </paramlist> | |
30452 | </constructor> | |
30453 | </class> | |
30454 | <class name="HtmlWidgetCell" oldname="wxHtmlWidgetCell" module="html"> | |
30455 | <baseclass name="HtmlCell"/> | |
30456 | <constructor name="HtmlWidgetCell" overloaded="no"> | |
781d2982 | 30457 | <autodoc>__init__(self, Window wnd, int w=0) -> HtmlWidgetCell</autodoc> |
f32fc4bc RD |
30458 | <paramlist> |
30459 | <param name="wnd" type="Window" default=""/> | |
30460 | <param name="w" type="int" default="0"/> | |
30461 | </paramlist> | |
30462 | </constructor> | |
30463 | </class> | |
30464 | <pythoncode> | |
0f43fbdf RD |
30465 | #--------------------------------------------------------------------------- |
30466 | </pythoncode> | |
f32fc4bc RD |
30467 | <class name="HtmlFilter" oldname="wxPyHtmlFilter" module="html"> |
30468 | <baseclass name="Object"/> | |
30469 | <constructor name="wxPyHtmlFilter" overloaded="no"> | |
781d2982 | 30470 | <autodoc>__init__(self) -> HtmlFilter</autodoc> |
f32fc4bc RD |
30471 | </constructor> |
30472 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 30473 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
30474 | <paramlist> |
30475 | <param name="self" type="PyObject" default=""/> | |
30476 | <param name="_class" type="PyObject" default=""/> | |
30477 | </paramlist> | |
30478 | </method> | |
30479 | </class> | |
30480 | <pythoncode> | |
0f43fbdf RD |
30481 | #--------------------------------------------------------------------------- |
30482 | </pythoncode> | |
f32fc4bc RD |
30483 | <class name="HtmlWindow" oldname="wxPyHtmlWindow" module="html"> |
30484 | <baseclass name="ScrolledWindow"/> | |
30485 | <constructor name="wxPyHtmlWindow" overloaded="no"> | |
781d2982 | 30486 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
30487 | Size size=DefaultSize, int style=HW_DEFAULT_STYLE, |
30488 | String name=HtmlWindowNameStr) -> HtmlWindow</autodoc> | |
30489 | <paramlist> | |
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"/> | |
30496 | </paramlist> | |
30497 | </constructor> | |
30498 | <constructor name="PreHtmlWindow" overloaded="no"> | |
30499 | <autodoc>PreHtmlWindow() -> HtmlWindow</autodoc> | |
30500 | </constructor> | |
30501 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 30502 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
30503 | Size size=DefaultSize, int style=HW_SCROLLBAR_AUTO, |
30504 | String name=HtmlWindowNameStr) -> bool</autodoc> | |
30505 | <paramlist> | |
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"/> | |
30512 | </paramlist> | |
30513 | </method> | |
30514 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 30515 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
30516 | <paramlist> |
30517 | <param name="self" type="PyObject" default=""/> | |
30518 | <param name="_class" type="PyObject" default=""/> | |
30519 | </paramlist> | |
30520 | </method> | |
30521 | <method name="SetPage" type="bool" overloaded="no"> | |
781d2982 | 30522 | <autodoc>SetPage(self, String source) -> bool</autodoc> |
f32fc4bc RD |
30523 | <paramlist> |
30524 | <param name="source" type="String" default=""/> | |
30525 | </paramlist> | |
30526 | </method> | |
30527 | <method name="LoadPage" type="bool" overloaded="no"> | |
781d2982 | 30528 | <autodoc>LoadPage(self, String location) -> bool</autodoc> |
f32fc4bc RD |
30529 | <paramlist> |
30530 | <param name="location" type="String" default=""/> | |
30531 | </paramlist> | |
30532 | </method> | |
30533 | <method name="LoadFile" type="bool" overloaded="no"> | |
781d2982 | 30534 | <autodoc>LoadFile(self, String filename) -> bool</autodoc> |
f32fc4bc RD |
30535 | <paramlist> |
30536 | <param name="filename" type="String" default=""/> | |
30537 | </paramlist> | |
30538 | </method> | |
30539 | <method name="AppendToPage" type="bool" overloaded="no"> | |
781d2982 | 30540 | <autodoc>AppendToPage(self, String source) -> bool</autodoc> |
f32fc4bc RD |
30541 | <paramlist> |
30542 | <param name="source" type="String" default=""/> | |
30543 | </paramlist> | |
30544 | </method> | |
30545 | <method name="GetOpenedPage" type="String" overloaded="no"> | |
781d2982 | 30546 | <autodoc>GetOpenedPage(self) -> String</autodoc> |
f32fc4bc RD |
30547 | </method> |
30548 | <method name="GetOpenedAnchor" type="String" overloaded="no"> | |
781d2982 | 30549 | <autodoc>GetOpenedAnchor(self) -> String</autodoc> |
f32fc4bc RD |
30550 | </method> |
30551 | <method name="GetOpenedPageTitle" type="String" overloaded="no"> | |
781d2982 | 30552 | <autodoc>GetOpenedPageTitle(self) -> String</autodoc> |
f32fc4bc RD |
30553 | </method> |
30554 | <method name="SetRelatedFrame" type="" overloaded="no"> | |
781d2982 | 30555 | <autodoc>SetRelatedFrame(self, Frame frame, String format)</autodoc> |
f32fc4bc RD |
30556 | <paramlist> |
30557 | <param name="frame" type="Frame" default=""/> | |
30558 | <param name="format" type="String" default=""/> | |
30559 | </paramlist> | |
30560 | </method> | |
30561 | <method name="GetRelatedFrame" type="Frame" overloaded="no"> | |
781d2982 | 30562 | <autodoc>GetRelatedFrame(self) -> Frame</autodoc> |
f32fc4bc RD |
30563 | </method> |
30564 | <method name="SetRelatedStatusBar" type="" overloaded="no"> | |
781d2982 | 30565 | <autodoc>SetRelatedStatusBar(self, int bar)</autodoc> |
f32fc4bc RD |
30566 | <paramlist> |
30567 | <param name="bar" type="int" default=""/> | |
30568 | </paramlist> | |
30569 | </method> | |
30570 | <method name="SetFonts" type="" overloaded="no"> | |
781d2982 | 30571 | <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc> |
f32fc4bc RD |
30572 | <paramlist> |
30573 | <param name="normal_face" type="String" default=""/> | |
30574 | <param name="fixed_face" type="String" default=""/> | |
30575 | <param name="sizes" type="PyObject" default="NULL"/> | |
30576 | </paramlist> | |
30577 | </method> | |
ce6878e6 RD |
30578 | <method name="NormalizeFontSizes" type="" overloaded="no"> |
30579 | <autodoc>NormalizeFontSizes(self, int size=-1)</autodoc> | |
30580 | <paramlist> | |
30581 | <param name="size" type="int" default="-1"/> | |
30582 | </paramlist> | |
30583 | </method> | |
f32fc4bc | 30584 | <method name="SetTitle" type="" overloaded="no"> |
781d2982 | 30585 | <autodoc>SetTitle(self, String title)</autodoc> |
f32fc4bc RD |
30586 | <paramlist> |
30587 | <param name="title" type="String" default=""/> | |
30588 | </paramlist> | |
30589 | </method> | |
30590 | <method name="SetBorders" type="" overloaded="no"> | |
781d2982 | 30591 | <autodoc>SetBorders(self, int b)</autodoc> |
f32fc4bc RD |
30592 | <paramlist> |
30593 | <param name="b" type="int" default=""/> | |
30594 | </paramlist> | |
30595 | </method> | |
30596 | <method name="ReadCustomization" type="" overloaded="no"> | |
781d2982 | 30597 | <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc> |
f32fc4bc RD |
30598 | <paramlist> |
30599 | <param name="cfg" type="ConfigBase" default=""/> | |
30600 | <param name="path" type="String" default="wxPyEmptyString"/> | |
30601 | </paramlist> | |
30602 | </method> | |
30603 | <method name="WriteCustomization" type="" overloaded="no"> | |
781d2982 | 30604 | <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc> |
f32fc4bc RD |
30605 | <paramlist> |
30606 | <param name="cfg" type="ConfigBase" default=""/> | |
30607 | <param name="path" type="String" default="wxPyEmptyString"/> | |
30608 | </paramlist> | |
30609 | </method> | |
30610 | <method name="HistoryBack" type="bool" overloaded="no"> | |
781d2982 | 30611 | <autodoc>HistoryBack(self) -> bool</autodoc> |
f32fc4bc RD |
30612 | </method> |
30613 | <method name="HistoryForward" type="bool" overloaded="no"> | |
781d2982 | 30614 | <autodoc>HistoryForward(self) -> bool</autodoc> |
f32fc4bc RD |
30615 | </method> |
30616 | <method name="HistoryCanBack" type="bool" overloaded="no"> | |
781d2982 | 30617 | <autodoc>HistoryCanBack(self) -> bool</autodoc> |
f32fc4bc RD |
30618 | </method> |
30619 | <method name="HistoryCanForward" type="bool" overloaded="no"> | |
781d2982 | 30620 | <autodoc>HistoryCanForward(self) -> bool</autodoc> |
f32fc4bc RD |
30621 | </method> |
30622 | <method name="HistoryClear" type="" overloaded="no"> | |
781d2982 | 30623 | <autodoc>HistoryClear(self)</autodoc> |
f32fc4bc RD |
30624 | </method> |
30625 | <method name="GetInternalRepresentation" type="HtmlContainerCell" overloaded="no"> | |
781d2982 | 30626 | <autodoc>GetInternalRepresentation(self) -> HtmlContainerCell</autodoc> |
f32fc4bc RD |
30627 | </method> |
30628 | <method name="GetParser" type="HtmlWinParser" overloaded="no"> | |
781d2982 | 30629 | <autodoc>GetParser(self) -> HtmlWinParser</autodoc> |
f32fc4bc RD |
30630 | </method> |
30631 | <method name="ScrollToAnchor" type="bool" overloaded="no"> | |
781d2982 | 30632 | <autodoc>ScrollToAnchor(self, String anchor) -> bool</autodoc> |
f32fc4bc RD |
30633 | <paramlist> |
30634 | <param name="anchor" type="String" default=""/> | |
30635 | </paramlist> | |
30636 | </method> | |
30637 | <method name="HasAnchor" type="bool" overloaded="no"> | |
781d2982 | 30638 | <autodoc>HasAnchor(self, String anchor) -> bool</autodoc> |
f32fc4bc RD |
30639 | <paramlist> |
30640 | <param name="anchor" type="String" default=""/> | |
30641 | </paramlist> | |
30642 | </method> | |
30643 | <staticmethod name="AddFilter" type="" overloaded="no"> | |
30644 | <autodoc>AddFilter(HtmlFilter filter)</autodoc> | |
30645 | <paramlist> | |
30646 | <param name="filter" type="HtmlFilter" default=""/> | |
30647 | </paramlist> | |
30648 | </staticmethod> | |
30649 | <method name="SelectWord" type="" overloaded="no"> | |
781d2982 | 30650 | <autodoc>SelectWord(self, Point pos)</autodoc> |
f32fc4bc RD |
30651 | <paramlist> |
30652 | <param name="pos" type="Point" default=""/> | |
30653 | </paramlist> | |
30654 | </method> | |
30655 | <method name="SelectLine" type="" overloaded="no"> | |
781d2982 | 30656 | <autodoc>SelectLine(self, Point pos)</autodoc> |
f32fc4bc RD |
30657 | <paramlist> |
30658 | <param name="pos" type="Point" default=""/> | |
30659 | </paramlist> | |
30660 | </method> | |
30661 | <method name="SelectAll" type="" overloaded="no"> | |
781d2982 | 30662 | <autodoc>SelectAll(self)</autodoc> |
f32fc4bc | 30663 | </method> |
ce6878e6 RD |
30664 | <method name="SelectionToText" type="String" overloaded="no"> |
30665 | <autodoc>SelectionToText(self) -> String</autodoc> | |
30666 | </method> | |
30667 | <method name="ToText" type="String" overloaded="no"> | |
30668 | <autodoc>ToText(self) -> String</autodoc> | |
30669 | </method> | |
f32fc4bc | 30670 | <method name="base_OnLinkClicked" type="" overloaded="no"> |
781d2982 | 30671 | <autodoc>base_OnLinkClicked(self, HtmlLinkInfo link)</autodoc> |
f32fc4bc RD |
30672 | <paramlist> |
30673 | <param name="link" type="HtmlLinkInfo" default=""/> | |
30674 | </paramlist> | |
30675 | </method> | |
30676 | <method name="base_OnSetTitle" type="" overloaded="no"> | |
781d2982 | 30677 | <autodoc>base_OnSetTitle(self, String title)</autodoc> |
f32fc4bc RD |
30678 | <paramlist> |
30679 | <param name="title" type="String" default=""/> | |
30680 | </paramlist> | |
30681 | </method> | |
30682 | <method name="base_OnCellMouseHover" type="" overloaded="no"> | |
781d2982 | 30683 | <autodoc>base_OnCellMouseHover(self, HtmlCell cell, int x, int y)</autodoc> |
f32fc4bc RD |
30684 | <paramlist> |
30685 | <param name="cell" type="HtmlCell" default=""/> | |
30686 | <param name="x" type="int" default=""/> | |
30687 | <param name="y" type="int" default=""/> | |
30688 | </paramlist> | |
30689 | </method> | |
30690 | <method name="base_OnCellClicked" type="" overloaded="no"> | |
781d2982 | 30691 | <autodoc>base_OnCellClicked(self, HtmlCell cell, int x, int y, MouseEvent event)</autodoc> |
f32fc4bc RD |
30692 | <paramlist> |
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=""/> | |
30697 | </paramlist> | |
30698 | </method> | |
781d2982 RD |
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. | |
30706 | ||
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 | |
30710 | this.</docstring> | |
30711 | <paramlist> | |
30712 | <param name="variant" type="wxWindowVariant" default="wxWINDOW_VARIANT_NORMAL"/> | |
30713 | </paramlist> | |
30714 | </staticmethod> | |
f32fc4bc RD |
30715 | </class> |
30716 | <pythoncode> | |
0f43fbdf RD |
30717 | #--------------------------------------------------------------------------- |
30718 | </pythoncode> | |
f32fc4bc RD |
30719 | <class name="HtmlDCRenderer" oldname="wxHtmlDCRenderer" module="html"> |
30720 | <baseclass name="Object"/> | |
30721 | <constructor name="HtmlDCRenderer" overloaded="no"> | |
781d2982 | 30722 | <autodoc>__init__(self) -> HtmlDCRenderer</autodoc> |
f32fc4bc RD |
30723 | </constructor> |
30724 | <destructor name="~wxHtmlDCRenderer" overloaded="no"> | |
781d2982 | 30725 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
30726 | </destructor> |
30727 | <method name="SetDC" type="" overloaded="no"> | |
781d2982 | 30728 | <autodoc>SetDC(self, DC dc, int maxwidth)</autodoc> |
f32fc4bc RD |
30729 | <paramlist> |
30730 | <param name="dc" type="DC" default=""/> | |
30731 | <param name="maxwidth" type="int" default=""/> | |
30732 | </paramlist> | |
30733 | </method> | |
30734 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 30735 | <autodoc>SetSize(self, int width, int height)</autodoc> |
f32fc4bc RD |
30736 | <paramlist> |
30737 | <param name="width" type="int" default=""/> | |
30738 | <param name="height" type="int" default=""/> | |
30739 | </paramlist> | |
30740 | </method> | |
30741 | <method name="SetHtmlText" type="" overloaded="no"> | |
781d2982 | 30742 | <autodoc>SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True)</autodoc> |
f32fc4bc RD |
30743 | <paramlist> |
30744 | <param name="html" type="String" default=""/> | |
30745 | <param name="basepath" type="String" default="wxPyEmptyString"/> | |
30746 | <param name="isdir" type="bool" default="True"/> | |
30747 | </paramlist> | |
30748 | </method> | |
30749 | <method name="SetFonts" type="" overloaded="no"> | |
781d2982 | 30750 | <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc> |
f32fc4bc RD |
30751 | <paramlist> |
30752 | <param name="normal_face" type="String" default=""/> | |
30753 | <param name="fixed_face" type="String" default=""/> | |
30754 | <param name="sizes" type="PyObject" default="NULL"/> | |
30755 | </paramlist> | |
30756 | </method> | |
ce6878e6 RD |
30757 | <method name="NormalizeFontSizes" type="" overloaded="no"> |
30758 | <autodoc>NormalizeFontSizes(self, int size=-1)</autodoc> | |
30759 | <paramlist> | |
30760 | <param name="size" type="int" default="-1"/> | |
30761 | </paramlist> | |
30762 | </method> | |
f32fc4bc | 30763 | <method name="Render" type="int" overloaded="no"> |
781d2982 | 30764 | <autodoc>Render(self, int x, int y, int from=0, int dont_render=False, int to=INT_MAX, |
f32fc4bc RD |
30765 | int choices=None, int LCOUNT=0) -> int</autodoc> |
30766 | <paramlist> | |
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"/> | |
30774 | </paramlist> | |
30775 | </method> | |
30776 | <method name="GetTotalHeight" type="int" overloaded="no"> | |
781d2982 | 30777 | <autodoc>GetTotalHeight(self) -> int</autodoc> |
f32fc4bc RD |
30778 | </method> |
30779 | </class> | |
30780 | <class name="HtmlPrintout" oldname="wxHtmlPrintout" module="html"> | |
30781 | <baseclass name="Printout"/> | |
30782 | <constructor name="HtmlPrintout" overloaded="no"> | |
781d2982 | 30783 | <autodoc>__init__(self, String title=HtmlPrintoutTitleStr) -> HtmlPrintout</autodoc> |
f32fc4bc RD |
30784 | <paramlist> |
30785 | <param name="title" type="String" default="wxPyHtmlPrintoutTitleStr"/> | |
30786 | </paramlist> | |
30787 | </constructor> | |
30788 | <method name="SetHtmlText" type="" overloaded="no"> | |
781d2982 | 30789 | <autodoc>SetHtmlText(self, String html, String basepath=EmptyString, bool isdir=True)</autodoc> |
f32fc4bc RD |
30790 | <paramlist> |
30791 | <param name="html" type="String" default=""/> | |
30792 | <param name="basepath" type="String" default="wxPyEmptyString"/> | |
30793 | <param name="isdir" type="bool" default="True"/> | |
30794 | </paramlist> | |
30795 | </method> | |
30796 | <method name="SetHtmlFile" type="" overloaded="no"> | |
781d2982 | 30797 | <autodoc>SetHtmlFile(self, String htmlfile)</autodoc> |
f32fc4bc RD |
30798 | <paramlist> |
30799 | <param name="htmlfile" type="String" default=""/> | |
30800 | </paramlist> | |
30801 | </method> | |
30802 | <method name="SetHeader" type="" overloaded="no"> | |
781d2982 | 30803 | <autodoc>SetHeader(self, String header, int pg=PAGE_ALL)</autodoc> |
f32fc4bc RD |
30804 | <paramlist> |
30805 | <param name="header" type="String" default=""/> | |
30806 | <param name="pg" type="int" default="wxPAGE_ALL"/> | |
30807 | </paramlist> | |
30808 | </method> | |
30809 | <method name="SetFooter" type="" overloaded="no"> | |
781d2982 | 30810 | <autodoc>SetFooter(self, String footer, int pg=PAGE_ALL)</autodoc> |
f32fc4bc RD |
30811 | <paramlist> |
30812 | <param name="footer" type="String" default=""/> | |
30813 | <param name="pg" type="int" default="wxPAGE_ALL"/> | |
30814 | </paramlist> | |
30815 | </method> | |
30816 | <method name="SetFonts" type="" overloaded="no"> | |
781d2982 | 30817 | <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc> |
f32fc4bc RD |
30818 | <paramlist> |
30819 | <param name="normal_face" type="String" default=""/> | |
30820 | <param name="fixed_face" type="String" default=""/> | |
30821 | <param name="sizes" type="PyObject" default="NULL"/> | |
30822 | </paramlist> | |
30823 | </method> | |
ce6878e6 RD |
30824 | <method name="NormalizeFontSizes" type="" overloaded="no"> |
30825 | <autodoc>NormalizeFontSizes(self, int size=-1)</autodoc> | |
30826 | <paramlist> | |
30827 | <param name="size" type="int" default="-1"/> | |
30828 | </paramlist> | |
30829 | </method> | |
f32fc4bc | 30830 | <method name="SetMargins" type="" overloaded="no"> |
781d2982 | 30831 | <autodoc>SetMargins(self, float top=25.2, float bottom=25.2, float left=25.2, |
f32fc4bc RD |
30832 | float right=25.2, float spaces=5)</autodoc> |
30833 | <paramlist> | |
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"/> | |
30839 | </paramlist> | |
30840 | </method> | |
30841 | <staticmethod name="AddFilter" type="" overloaded="no"> | |
30842 | <autodoc>AddFilter(wxHtmlFilter filter)</autodoc> | |
30843 | <paramlist> | |
30844 | <param name="filter" type="wxHtmlFilter" default=""/> | |
30845 | </paramlist> | |
30846 | </staticmethod> | |
30847 | <staticmethod name="CleanUpStatics" type="" overloaded="no"> | |
30848 | <autodoc>CleanUpStatics()</autodoc> | |
30849 | </staticmethod> | |
30850 | </class> | |
30851 | <class name="HtmlEasyPrinting" oldname="wxHtmlEasyPrinting" module="html"> | |
30852 | <baseclass name="Object"/> | |
30853 | <constructor name="HtmlEasyPrinting" overloaded="no"> | |
781d2982 | 30854 | <autodoc>__init__(self, String name=HtmlPrintingTitleStr, Window parentWindow=None) -> HtmlEasyPrinting</autodoc> |
f32fc4bc RD |
30855 | <paramlist> |
30856 | <param name="name" type="String" default="wxPyHtmlPrintingTitleStr"/> | |
30857 | <param name="parentWindow" type="Window" default="NULL"/> | |
30858 | </paramlist> | |
30859 | </constructor> | |
30860 | <destructor name="~wxHtmlEasyPrinting" overloaded="no"> | |
781d2982 | 30861 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
30862 | </destructor> |
30863 | <method name="PreviewFile" type="" overloaded="no"> | |
781d2982 | 30864 | <autodoc>PreviewFile(self, String htmlfile)</autodoc> |
f32fc4bc RD |
30865 | <paramlist> |
30866 | <param name="htmlfile" type="String" default=""/> | |
30867 | </paramlist> | |
30868 | </method> | |
30869 | <method name="PreviewText" type="" overloaded="no"> | |
781d2982 | 30870 | <autodoc>PreviewText(self, String htmltext, String basepath=EmptyString)</autodoc> |
f32fc4bc RD |
30871 | <paramlist> |
30872 | <param name="htmltext" type="String" default=""/> | |
30873 | <param name="basepath" type="String" default="wxPyEmptyString"/> | |
30874 | </paramlist> | |
30875 | </method> | |
30876 | <method name="PrintFile" type="" overloaded="no"> | |
781d2982 | 30877 | <autodoc>PrintFile(self, String htmlfile)</autodoc> |
f32fc4bc RD |
30878 | <paramlist> |
30879 | <param name="htmlfile" type="String" default=""/> | |
30880 | </paramlist> | |
30881 | </method> | |
30882 | <method name="PrintText" type="" overloaded="no"> | |
781d2982 | 30883 | <autodoc>PrintText(self, String htmltext, String basepath=EmptyString)</autodoc> |
f32fc4bc RD |
30884 | <paramlist> |
30885 | <param name="htmltext" type="String" default=""/> | |
30886 | <param name="basepath" type="String" default="wxPyEmptyString"/> | |
30887 | </paramlist> | |
30888 | </method> | |
30889 | <method name="PrinterSetup" type="" overloaded="no"> | |
781d2982 | 30890 | <autodoc>PrinterSetup(self)</autodoc> |
f32fc4bc RD |
30891 | </method> |
30892 | <method name="PageSetup" type="" overloaded="no"> | |
781d2982 | 30893 | <autodoc>PageSetup(self)</autodoc> |
f32fc4bc RD |
30894 | </method> |
30895 | <method name="SetHeader" type="" overloaded="no"> | |
781d2982 | 30896 | <autodoc>SetHeader(self, String header, int pg=PAGE_ALL)</autodoc> |
f32fc4bc RD |
30897 | <paramlist> |
30898 | <param name="header" type="String" default=""/> | |
30899 | <param name="pg" type="int" default="wxPAGE_ALL"/> | |
30900 | </paramlist> | |
30901 | </method> | |
30902 | <method name="SetFooter" type="" overloaded="no"> | |
781d2982 | 30903 | <autodoc>SetFooter(self, String footer, int pg=PAGE_ALL)</autodoc> |
f32fc4bc RD |
30904 | <paramlist> |
30905 | <param name="footer" type="String" default=""/> | |
30906 | <param name="pg" type="int" default="wxPAGE_ALL"/> | |
30907 | </paramlist> | |
30908 | </method> | |
30909 | <method name="SetFonts" type="" overloaded="no"> | |
781d2982 | 30910 | <autodoc>SetFonts(self, String normal_face, String fixed_face, PyObject sizes=None)</autodoc> |
f32fc4bc RD |
30911 | <paramlist> |
30912 | <param name="normal_face" type="String" default=""/> | |
30913 | <param name="fixed_face" type="String" default=""/> | |
30914 | <param name="sizes" type="PyObject" default="NULL"/> | |
30915 | </paramlist> | |
30916 | </method> | |
ce6878e6 RD |
30917 | <method name="NormalizeFontSizes" type="" overloaded="no"> |
30918 | <autodoc>NormalizeFontSizes(self, int size=-1)</autodoc> | |
30919 | <paramlist> | |
30920 | <param name="size" type="int" default="-1"/> | |
30921 | </paramlist> | |
30922 | </method> | |
f32fc4bc | 30923 | <method name="GetPrintData" type="PrintData" overloaded="no"> |
781d2982 | 30924 | <autodoc>GetPrintData(self) -> PrintData</autodoc> |
f32fc4bc RD |
30925 | </method> |
30926 | <method name="GetPageSetupData" type="PageSetupDialogData" overloaded="no"> | |
781d2982 | 30927 | <autodoc>GetPageSetupData(self) -> PageSetupDialogData</autodoc> |
f32fc4bc RD |
30928 | </method> |
30929 | </class> | |
30930 | <pythoncode> | |
0dd25e81 RD |
30931 | #--------------------------------------------------------------------------- |
30932 | </pythoncode> | |
f32fc4bc RD |
30933 | <class name="HtmlBookRecord" oldname="wxHtmlBookRecord" module="html"> |
30934 | <constructor name="HtmlBookRecord" overloaded="no"> | |
781d2982 | 30935 | <autodoc>__init__(self, String bookfile, String basepath, String title, String start) -> HtmlBookRecord</autodoc> |
f32fc4bc RD |
30936 | <paramlist> |
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=""/> | |
30941 | </paramlist> | |
30942 | </constructor> | |
30943 | <method name="GetBookFile" type="String" overloaded="no"> | |
781d2982 | 30944 | <autodoc>GetBookFile(self) -> String</autodoc> |
f32fc4bc RD |
30945 | </method> |
30946 | <method name="GetTitle" type="String" overloaded="no"> | |
781d2982 | 30947 | <autodoc>GetTitle(self) -> String</autodoc> |
f32fc4bc RD |
30948 | </method> |
30949 | <method name="GetStart" type="String" overloaded="no"> | |
781d2982 | 30950 | <autodoc>GetStart(self) -> String</autodoc> |
f32fc4bc RD |
30951 | </method> |
30952 | <method name="GetBasePath" type="String" overloaded="no"> | |
781d2982 | 30953 | <autodoc>GetBasePath(self) -> String</autodoc> |
f32fc4bc RD |
30954 | </method> |
30955 | <method name="SetContentsRange" type="" overloaded="no"> | |
781d2982 | 30956 | <autodoc>SetContentsRange(self, int start, int end)</autodoc> |
f32fc4bc RD |
30957 | <paramlist> |
30958 | <param name="start" type="int" default=""/> | |
30959 | <param name="end" type="int" default=""/> | |
30960 | </paramlist> | |
30961 | </method> | |
30962 | <method name="GetContentsStart" type="int" overloaded="no"> | |
781d2982 | 30963 | <autodoc>GetContentsStart(self) -> int</autodoc> |
f32fc4bc RD |
30964 | </method> |
30965 | <method name="GetContentsEnd" type="int" overloaded="no"> | |
781d2982 | 30966 | <autodoc>GetContentsEnd(self) -> int</autodoc> |
f32fc4bc RD |
30967 | </method> |
30968 | <method name="SetTitle" type="" overloaded="no"> | |
781d2982 | 30969 | <autodoc>SetTitle(self, String title)</autodoc> |
f32fc4bc RD |
30970 | <paramlist> |
30971 | <param name="title" type="String" default=""/> | |
30972 | </paramlist> | |
30973 | </method> | |
30974 | <method name="SetBasePath" type="" overloaded="no"> | |
781d2982 | 30975 | <autodoc>SetBasePath(self, String path)</autodoc> |
f32fc4bc RD |
30976 | <paramlist> |
30977 | <param name="path" type="String" default=""/> | |
30978 | </paramlist> | |
30979 | </method> | |
30980 | <method name="SetStart" type="" overloaded="no"> | |
781d2982 | 30981 | <autodoc>SetStart(self, String start)</autodoc> |
f32fc4bc RD |
30982 | <paramlist> |
30983 | <param name="start" type="String" default=""/> | |
30984 | </paramlist> | |
30985 | </method> | |
30986 | <method name="GetFullPath" type="String" overloaded="no"> | |
781d2982 | 30987 | <autodoc>GetFullPath(self, String page) -> String</autodoc> |
f32fc4bc RD |
30988 | <paramlist> |
30989 | <param name="page" type="String" default=""/> | |
30990 | </paramlist> | |
30991 | </method> | |
30992 | </class> | |
30993 | <class name="HtmlContentsItem" oldname="wxHtmlContentsItem" module="html"> | |
30994 | <method name="GetLevel" type="int" overloaded="no"> | |
781d2982 | 30995 | <autodoc>GetLevel(self) -> int</autodoc> |
f32fc4bc RD |
30996 | </method> |
30997 | <method name="GetID" type="int" overloaded="no"> | |
781d2982 | 30998 | <autodoc>GetID(self) -> int</autodoc> |
f32fc4bc RD |
30999 | </method> |
31000 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 31001 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
31002 | </method> |
31003 | <method name="GetPage" type="String" overloaded="no"> | |
781d2982 | 31004 | <autodoc>GetPage(self) -> String</autodoc> |
f32fc4bc RD |
31005 | </method> |
31006 | <method name="GetBook" type="HtmlBookRecord" overloaded="no"> | |
781d2982 | 31007 | <autodoc>GetBook(self) -> HtmlBookRecord</autodoc> |
f32fc4bc RD |
31008 | </method> |
31009 | </class> | |
31010 | <class name="HtmlSearchStatus" oldname="wxHtmlSearchStatus" module="html"> | |
31011 | <method name="Search" type="bool" overloaded="no"> | |
781d2982 | 31012 | <autodoc>Search(self) -> bool</autodoc> |
f32fc4bc RD |
31013 | </method> |
31014 | <method name="IsActive" type="bool" overloaded="no"> | |
781d2982 | 31015 | <autodoc>IsActive(self) -> bool</autodoc> |
f32fc4bc RD |
31016 | </method> |
31017 | <method name="GetCurIndex" type="int" overloaded="no"> | |
781d2982 | 31018 | <autodoc>GetCurIndex(self) -> int</autodoc> |
f32fc4bc RD |
31019 | </method> |
31020 | <method name="GetMaxIndex" type="int" overloaded="no"> | |
781d2982 | 31021 | <autodoc>GetMaxIndex(self) -> int</autodoc> |
f32fc4bc RD |
31022 | </method> |
31023 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 31024 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
31025 | </method> |
31026 | <method name="GetContentsItem" type="HtmlContentsItem" overloaded="no"> | |
781d2982 | 31027 | <autodoc>GetContentsItem(self) -> HtmlContentsItem</autodoc> |
f32fc4bc RD |
31028 | </method> |
31029 | </class> | |
31030 | <class name="HtmlHelpData" oldname="wxHtmlHelpData" module="html"> | |
31031 | <constructor name="HtmlHelpData" overloaded="no"> | |
781d2982 | 31032 | <autodoc>__init__(self) -> HtmlHelpData</autodoc> |
f32fc4bc RD |
31033 | </constructor> |
31034 | <destructor name="~wxHtmlHelpData" overloaded="no"> | |
781d2982 | 31035 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
31036 | </destructor> |
31037 | <method name="SetTempDir" type="" overloaded="no"> | |
781d2982 | 31038 | <autodoc>SetTempDir(self, String path)</autodoc> |
f32fc4bc RD |
31039 | <paramlist> |
31040 | <param name="path" type="String" default=""/> | |
31041 | </paramlist> | |
31042 | </method> | |
31043 | <method name="AddBook" type="bool" overloaded="no"> | |
781d2982 | 31044 | <autodoc>AddBook(self, String book) -> bool</autodoc> |
f32fc4bc RD |
31045 | <paramlist> |
31046 | <param name="book" type="String" default=""/> | |
31047 | </paramlist> | |
31048 | </method> | |
31049 | <method name="FindPageByName" type="String" overloaded="no"> | |
781d2982 | 31050 | <autodoc>FindPageByName(self, String page) -> String</autodoc> |
f32fc4bc RD |
31051 | <paramlist> |
31052 | <param name="page" type="String" default=""/> | |
31053 | </paramlist> | |
31054 | </method> | |
31055 | <method name="FindPageById" type="String" overloaded="no"> | |
781d2982 | 31056 | <autodoc>FindPageById(self, int id) -> String</autodoc> |
f32fc4bc RD |
31057 | <paramlist> |
31058 | <param name="id" type="int" default=""/> | |
31059 | </paramlist> | |
31060 | </method> | |
31061 | <method name="GetBookRecArray" type="wxHtmlBookRecArray" overloaded="no"> | |
781d2982 | 31062 | <autodoc>GetBookRecArray(self) -> wxHtmlBookRecArray</autodoc> |
f32fc4bc RD |
31063 | </method> |
31064 | <method name="GetContents" type="HtmlContentsItem" overloaded="no"> | |
781d2982 | 31065 | <autodoc>GetContents(self) -> HtmlContentsItem</autodoc> |
f32fc4bc RD |
31066 | </method> |
31067 | <method name="GetContentsCnt" type="int" overloaded="no"> | |
781d2982 | 31068 | <autodoc>GetContentsCnt(self) -> int</autodoc> |
f32fc4bc RD |
31069 | </method> |
31070 | <method name="GetIndex" type="HtmlContentsItem" overloaded="no"> | |
781d2982 | 31071 | <autodoc>GetIndex(self) -> HtmlContentsItem</autodoc> |
f32fc4bc RD |
31072 | </method> |
31073 | <method name="GetIndexCnt" type="int" overloaded="no"> | |
781d2982 | 31074 | <autodoc>GetIndexCnt(self) -> int</autodoc> |
f32fc4bc RD |
31075 | </method> |
31076 | </class> | |
31077 | <class name="HtmlHelpFrame" oldname="wxHtmlHelpFrame" module="html"> | |
31078 | <baseclass name="Frame"/> | |
31079 | <constructor name="HtmlHelpFrame" overloaded="no"> | |
781d2982 | 31080 | <autodoc>__init__(self, Window parent, int ??, String title=EmptyString, int style=HF_DEFAULTSTYLE, |
f32fc4bc RD |
31081 | HtmlHelpData data=None) -> HtmlHelpFrame</autodoc> |
31082 | <paramlist> | |
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"/> | |
31088 | </paramlist> | |
31089 | </constructor> | |
31090 | <method name="GetData" type="HtmlHelpData" overloaded="no"> | |
781d2982 | 31091 | <autodoc>GetData(self) -> HtmlHelpData</autodoc> |
f32fc4bc RD |
31092 | </method> |
31093 | <method name="SetTitleFormat" type="" overloaded="no"> | |
781d2982 | 31094 | <autodoc>SetTitleFormat(self, String format)</autodoc> |
f32fc4bc RD |
31095 | <paramlist> |
31096 | <param name="format" type="String" default=""/> | |
31097 | </paramlist> | |
31098 | </method> | |
31099 | <method name="Display" type="" overloaded="no"> | |
781d2982 | 31100 | <autodoc>Display(self, String x)</autodoc> |
f32fc4bc RD |
31101 | <paramlist> |
31102 | <param name="x" type="String" default=""/> | |
31103 | </paramlist> | |
31104 | </method> | |
31105 | <method name="DisplayID" type="" overloaded="no"> | |
781d2982 | 31106 | <autodoc>DisplayID(self, int id)</autodoc> |
f32fc4bc RD |
31107 | <paramlist> |
31108 | <param name="id" type="int" default=""/> | |
31109 | </paramlist> | |
31110 | </method> | |
31111 | <method name="DisplayContents" type="" overloaded="no"> | |
781d2982 | 31112 | <autodoc>DisplayContents(self)</autodoc> |
f32fc4bc RD |
31113 | </method> |
31114 | <method name="DisplayIndex" type="" overloaded="no"> | |
781d2982 | 31115 | <autodoc>DisplayIndex(self)</autodoc> |
f32fc4bc RD |
31116 | </method> |
31117 | <method name="KeywordSearch" type="bool" overloaded="no"> | |
781d2982 | 31118 | <autodoc>KeywordSearch(self, String keyword) -> bool</autodoc> |
f32fc4bc RD |
31119 | <paramlist> |
31120 | <param name="keyword" type="String" default=""/> | |
31121 | </paramlist> | |
31122 | </method> | |
31123 | <method name="UseConfig" type="" overloaded="no"> | |
781d2982 | 31124 | <autodoc>UseConfig(self, ConfigBase config, String rootpath=EmptyString)</autodoc> |
f32fc4bc RD |
31125 | <paramlist> |
31126 | <param name="config" type="ConfigBase" default=""/> | |
31127 | <param name="rootpath" type="String" default="wxPyEmptyString"/> | |
31128 | </paramlist> | |
31129 | </method> | |
31130 | <method name="ReadCustomization" type="" overloaded="no"> | |
781d2982 | 31131 | <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc> |
f32fc4bc RD |
31132 | <paramlist> |
31133 | <param name="cfg" type="ConfigBase" default=""/> | |
31134 | <param name="path" type="String" default="wxPyEmptyString"/> | |
31135 | </paramlist> | |
31136 | </method> | |
31137 | <method name="WriteCustomization" type="" overloaded="no"> | |
781d2982 | 31138 | <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc> |
f32fc4bc RD |
31139 | <paramlist> |
31140 | <param name="cfg" type="ConfigBase" default=""/> | |
31141 | <param name="path" type="String" default="wxPyEmptyString"/> | |
31142 | </paramlist> | |
31143 | </method> | |
31144 | </class> | |
31145 | <class name="HtmlHelpController" oldname="wxHtmlHelpController" module="html"> | |
31146 | <baseclass name="EvtHandler"/> | |
31147 | <constructor name="HtmlHelpController" overloaded="no"> | |
781d2982 | 31148 | <autodoc>__init__(self, int style=HF_DEFAULTSTYLE) -> HtmlHelpController</autodoc> |
f32fc4bc RD |
31149 | <paramlist> |
31150 | <param name="style" type="int" default="wxHF_DEFAULTSTYLE"/> | |
31151 | </paramlist> | |
31152 | </constructor> | |
31153 | <destructor name="~wxHtmlHelpController" overloaded="no"> | |
781d2982 | 31154 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
31155 | </destructor> |
31156 | <method name="SetTitleFormat" type="" overloaded="no"> | |
781d2982 | 31157 | <autodoc>SetTitleFormat(self, String format)</autodoc> |
f32fc4bc RD |
31158 | <paramlist> |
31159 | <param name="format" type="String" default=""/> | |
31160 | </paramlist> | |
31161 | </method> | |
31162 | <method name="SetTempDir" type="" overloaded="no"> | |
781d2982 | 31163 | <autodoc>SetTempDir(self, String path)</autodoc> |
f32fc4bc RD |
31164 | <paramlist> |
31165 | <param name="path" type="String" default=""/> | |
31166 | </paramlist> | |
31167 | </method> | |
31168 | <method name="AddBook" type="bool" overloaded="no"> | |
781d2982 | 31169 | <autodoc>AddBook(self, String book, int show_wait_msg=False) -> bool</autodoc> |
f32fc4bc RD |
31170 | <paramlist> |
31171 | <param name="book" type="String" default=""/> | |
31172 | <param name="show_wait_msg" type="int" default="False"/> | |
31173 | </paramlist> | |
31174 | </method> | |
31175 | <method name="Display" type="" overloaded="no"> | |
781d2982 | 31176 | <autodoc>Display(self, String x)</autodoc> |
f32fc4bc RD |
31177 | <paramlist> |
31178 | <param name="x" type="String" default=""/> | |
31179 | </paramlist> | |
31180 | </method> | |
31181 | <method name="DisplayID" type="" overloaded="no"> | |
781d2982 | 31182 | <autodoc>DisplayID(self, int id)</autodoc> |
f32fc4bc RD |
31183 | <paramlist> |
31184 | <param name="id" type="int" default=""/> | |
31185 | </paramlist> | |
31186 | </method> | |
31187 | <method name="DisplayContents" type="" overloaded="no"> | |
781d2982 | 31188 | <autodoc>DisplayContents(self)</autodoc> |
f32fc4bc RD |
31189 | </method> |
31190 | <method name="DisplayIndex" type="" overloaded="no"> | |
781d2982 | 31191 | <autodoc>DisplayIndex(self)</autodoc> |
f32fc4bc RD |
31192 | </method> |
31193 | <method name="KeywordSearch" type="bool" overloaded="no"> | |
781d2982 | 31194 | <autodoc>KeywordSearch(self, String keyword) -> bool</autodoc> |
f32fc4bc RD |
31195 | <paramlist> |
31196 | <param name="keyword" type="String" default=""/> | |
31197 | </paramlist> | |
31198 | </method> | |
31199 | <method name="UseConfig" type="" overloaded="no"> | |
781d2982 | 31200 | <autodoc>UseConfig(self, ConfigBase config, String rootpath=EmptyString)</autodoc> |
f32fc4bc RD |
31201 | <paramlist> |
31202 | <param name="config" type="ConfigBase" default=""/> | |
31203 | <param name="rootpath" type="String" default="wxPyEmptyString"/> | |
31204 | </paramlist> | |
31205 | </method> | |
31206 | <method name="ReadCustomization" type="" overloaded="no"> | |
781d2982 | 31207 | <autodoc>ReadCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc> |
f32fc4bc RD |
31208 | <paramlist> |
31209 | <param name="cfg" type="ConfigBase" default=""/> | |
31210 | <param name="path" type="String" default="wxPyEmptyString"/> | |
31211 | </paramlist> | |
31212 | </method> | |
31213 | <method name="WriteCustomization" type="" overloaded="no"> | |
781d2982 | 31214 | <autodoc>WriteCustomization(self, ConfigBase cfg, String path=EmptyString)</autodoc> |
f32fc4bc RD |
31215 | <paramlist> |
31216 | <param name="cfg" type="ConfigBase" default=""/> | |
31217 | <param name="path" type="String" default="wxPyEmptyString"/> | |
31218 | </paramlist> | |
31219 | </method> | |
31220 | <method name="GetFrame" type="HtmlHelpFrame" overloaded="no"> | |
781d2982 | 31221 | <autodoc>GetFrame(self) -> HtmlHelpFrame</autodoc> |
f32fc4bc RD |
31222 | </method> |
31223 | </class> | |
31224 | </module> | |
31225 | <module name="wizard"> | |
781d2982 RD |
31226 | <import name="_windows"/> |
31227 | <pythoncode> wx = _core </pythoncode> | |
31228 | <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode> | |
f32fc4bc RD |
31229 | <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) | |
0dd25e81 | 31235 | </pythoncode> |
f32fc4bc RD |
31236 | <class name="WizardEvent" oldname="wxWizardEvent" module="wizard"> |
31237 | <baseclass name="NotifyEvent"/> | |
31238 | <constructor name="WizardEvent" overloaded="no"> | |
781d2982 | 31239 | <autodoc>__init__(self, wxEventType type=wxEVT_NULL, int id=-1, bool direction=True, |
f32fc4bc RD |
31240 | WizardPage page=None) -> WizardEvent</autodoc> |
31241 | <paramlist> | |
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"/> | |
31246 | </paramlist> | |
31247 | </constructor> | |
31248 | <method name="GetDirection" type="bool" overloaded="no"> | |
781d2982 | 31249 | <autodoc>GetDirection(self) -> bool</autodoc> |
f32fc4bc RD |
31250 | </method> |
31251 | <method name="GetPage" type="wxWizardPage" overloaded="no"> | |
781d2982 | 31252 | <autodoc>GetPage(self) -> WizardPage</autodoc> |
f32fc4bc RD |
31253 | </method> |
31254 | </class> | |
31255 | <class name="WizardPage" oldname="wxWizardPage" module="wizard"> | |
31256 | <baseclass name="Panel"/> | |
31257 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 31258 | <autodoc>Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool</autodoc> |
f32fc4bc RD |
31259 | <paramlist> |
31260 | <param name="parent" type="wxWizard" default=""/> | |
31261 | <param name="bitmap" type="Bitmap" default="wxNullBitmap"/> | |
31262 | <param name="resource" type="String" default="wxPyEmptyString"/> | |
31263 | </paramlist> | |
31264 | </method> | |
31265 | <method name="GetPrev" type="WizardPage" overloaded="no"> | |
781d2982 | 31266 | <autodoc>GetPrev(self) -> WizardPage</autodoc> |
f32fc4bc RD |
31267 | </method> |
31268 | <method name="GetNext" type="WizardPage" overloaded="no"> | |
781d2982 | 31269 | <autodoc>GetNext(self) -> WizardPage</autodoc> |
f32fc4bc RD |
31270 | </method> |
31271 | <method name="GetBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 31272 | <autodoc>GetBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
31273 | </method> |
31274 | </class> | |
31275 | <class name="PyWizardPage" oldname="wxPyWizardPage" module="wizard"> | |
31276 | <baseclass name="WizardPage"/> | |
31277 | <constructor name="PyWizardPage" overloaded="no"> | |
781d2982 | 31278 | <autodoc>__init__(self, Wizard parent, Bitmap bitmap=&wxNullBitmap, String resource=&wxPyEmptyString) -> PyWizardPage</autodoc> |
f32fc4bc RD |
31279 | <paramlist> |
31280 | <param name="parent" type="wxWizard" default=""/> | |
31281 | <param name="bitmap" type="Bitmap" default="&wxNullBitmap"/> | |
31282 | <param name="resource" type="String" default="&wxPyEmptyString"/> | |
31283 | </paramlist> | |
31284 | </constructor> | |
31285 | <constructor name="PrePyWizardPage" overloaded="no"> | |
31286 | <autodoc>PrePyWizardPage() -> PyWizardPage</autodoc> | |
31287 | </constructor> | |
31288 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 31289 | <autodoc>Create(self, Wizard parent, Bitmap bitmap=wxNullBitmap, String resource=EmptyString) -> bool</autodoc> |
f32fc4bc RD |
31290 | <paramlist> |
31291 | <param name="parent" type="wxWizard" default=""/> | |
31292 | <param name="bitmap" type="Bitmap" default="wxNullBitmap"/> | |
31293 | <param name="resource" type="String" default="wxPyEmptyString"/> | |
31294 | </paramlist> | |
31295 | </method> | |
31296 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 31297 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
31298 | <paramlist> |
31299 | <param name="self" type="PyObject" default=""/> | |
31300 | <param name="_class" type="PyObject" default=""/> | |
31301 | </paramlist> | |
31302 | </method> | |
31303 | <method name="base_DoMoveWindow" type="" overloaded="no"> | |
781d2982 | 31304 | <autodoc>base_DoMoveWindow(self, int x, int y, int width, int height)</autodoc> |
f32fc4bc RD |
31305 | <paramlist> |
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=""/> | |
31310 | </paramlist> | |
31311 | </method> | |
31312 | <method name="base_DoSetSize" type="" overloaded="no"> | |
781d2982 | 31313 | <autodoc>base_DoSetSize(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO)</autodoc> |
f32fc4bc RD |
31314 | <paramlist> |
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"/> | |
31320 | </paramlist> | |
31321 | </method> | |
31322 | <method name="base_DoSetClientSize" type="" overloaded="no"> | |
781d2982 | 31323 | <autodoc>base_DoSetClientSize(self, int width, int height)</autodoc> |
f32fc4bc RD |
31324 | <paramlist> |
31325 | <param name="width" type="int" default=""/> | |
31326 | <param name="height" type="int" default=""/> | |
31327 | </paramlist> | |
31328 | </method> | |
31329 | <method name="base_DoSetVirtualSize" type="" overloaded="no"> | |
781d2982 | 31330 | <autodoc>base_DoSetVirtualSize(self, int x, int y)</autodoc> |
f32fc4bc RD |
31331 | <paramlist> |
31332 | <param name="x" type="int" default=""/> | |
31333 | <param name="y" type="int" default=""/> | |
31334 | </paramlist> | |
31335 | </method> | |
31336 | <method name="base_DoGetSize" type="" overloaded="no"> | |
31337 | <autodoc>base_DoGetSize() -> (width, height)</autodoc> | |
31338 | <paramlist> | |
31339 | <param name="OUTPUT" type="int" default=""/> | |
31340 | <param name="OUTPUT" type="int" default=""/> | |
31341 | </paramlist> | |
31342 | </method> | |
31343 | <method name="base_DoGetClientSize" type="" overloaded="no"> | |
31344 | <autodoc>base_DoGetClientSize() -> (width, height)</autodoc> | |
31345 | <paramlist> | |
31346 | <param name="OUTPUT" type="int" default=""/> | |
31347 | <param name="OUTPUT" type="int" default=""/> | |
31348 | </paramlist> | |
31349 | </method> | |
31350 | <method name="base_DoGetPosition" type="" overloaded="no"> | |
31351 | <autodoc>base_DoGetPosition() -> (x,y)</autodoc> | |
31352 | <paramlist> | |
31353 | <param name="OUTPUT" type="int" default=""/> | |
31354 | <param name="OUTPUT" type="int" default=""/> | |
31355 | </paramlist> | |
31356 | </method> | |
31357 | <method name="base_DoGetVirtualSize" type="Size" overloaded="no"> | |
781d2982 | 31358 | <autodoc>base_DoGetVirtualSize(self) -> Size</autodoc> |
f32fc4bc RD |
31359 | </method> |
31360 | <method name="base_DoGetBestSize" type="Size" overloaded="no"> | |
781d2982 | 31361 | <autodoc>base_DoGetBestSize(self) -> Size</autodoc> |
f32fc4bc RD |
31362 | </method> |
31363 | <method name="base_InitDialog" type="" overloaded="no"> | |
781d2982 | 31364 | <autodoc>base_InitDialog(self)</autodoc> |
f32fc4bc RD |
31365 | </method> |
31366 | <method name="base_TransferDataToWindow" type="bool" overloaded="no"> | |
781d2982 | 31367 | <autodoc>base_TransferDataToWindow(self) -> bool</autodoc> |
f32fc4bc RD |
31368 | </method> |
31369 | <method name="base_TransferDataFromWindow" type="bool" overloaded="no"> | |
781d2982 | 31370 | <autodoc>base_TransferDataFromWindow(self) -> bool</autodoc> |
f32fc4bc RD |
31371 | </method> |
31372 | <method name="base_Validate" type="bool" overloaded="no"> | |
781d2982 | 31373 | <autodoc>base_Validate(self) -> bool</autodoc> |
f32fc4bc RD |
31374 | </method> |
31375 | <method name="base_AcceptsFocus" type="bool" overloaded="no"> | |
781d2982 | 31376 | <autodoc>base_AcceptsFocus(self) -> bool</autodoc> |
f32fc4bc RD |
31377 | </method> |
31378 | <method name="base_AcceptsFocusFromKeyboard" type="bool" overloaded="no"> | |
781d2982 | 31379 | <autodoc>base_AcceptsFocusFromKeyboard(self) -> bool</autodoc> |
f32fc4bc RD |
31380 | </method> |
31381 | <method name="base_GetMaxSize" type="Size" overloaded="no"> | |
781d2982 | 31382 | <autodoc>base_GetMaxSize(self) -> Size</autodoc> |
f32fc4bc RD |
31383 | </method> |
31384 | <method name="base_AddChild" type="" overloaded="no"> | |
781d2982 | 31385 | <autodoc>base_AddChild(self, Window child)</autodoc> |
f32fc4bc RD |
31386 | <paramlist> |
31387 | <param name="child" type="Window" default=""/> | |
31388 | </paramlist> | |
31389 | </method> | |
31390 | <method name="base_RemoveChild" type="" overloaded="no"> | |
781d2982 | 31391 | <autodoc>base_RemoveChild(self, Window child)</autodoc> |
f32fc4bc RD |
31392 | <paramlist> |
31393 | <param name="child" type="Window" default=""/> | |
31394 | </paramlist> | |
31395 | </method> | |
31396 | </class> | |
31397 | <class name="WizardPageSimple" oldname="wxWizardPageSimple" module="wizard"> | |
31398 | <baseclass name="WizardPage"/> | |
31399 | <constructor name="WizardPageSimple" overloaded="no"> | |
781d2982 | 31400 | <autodoc>__init__(self, Wizard parent, WizardPage prev=None, WizardPage next=None, |
f32fc4bc RD |
31401 | Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> WizardPageSimple</autodoc> |
31402 | <paramlist> | |
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"/> | |
31408 | </paramlist> | |
31409 | </constructor> | |
31410 | <constructor name="PreWizardPageSimple" overloaded="no"> | |
31411 | <autodoc>PreWizardPageSimple() -> WizardPageSimple</autodoc> | |
31412 | </constructor> | |
31413 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 31414 | <autodoc>Create(self, Wizard parent=None, WizardPage prev=None, WizardPage next=None, |
f32fc4bc RD |
31415 | Bitmap bitmap=wxNullBitmap, wxChar resource=None) -> bool</autodoc> |
31416 | <paramlist> | |
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"/> | |
31422 | </paramlist> | |
31423 | </method> | |
31424 | <method name="SetPrev" type="" overloaded="no"> | |
781d2982 | 31425 | <autodoc>SetPrev(self, WizardPage prev)</autodoc> |
f32fc4bc RD |
31426 | <paramlist> |
31427 | <param name="prev" type="WizardPage" default=""/> | |
31428 | </paramlist> | |
31429 | </method> | |
31430 | <method name="SetNext" type="" overloaded="no"> | |
781d2982 | 31431 | <autodoc>SetNext(self, WizardPage next)</autodoc> |
f32fc4bc RD |
31432 | <paramlist> |
31433 | <param name="next" type="WizardPage" default=""/> | |
31434 | </paramlist> | |
31435 | </method> | |
31436 | <staticmethod name="Chain" type="" overloaded="no"> | |
31437 | <autodoc>Chain(WizardPageSimple first, WizardPageSimple second)</autodoc> | |
31438 | <paramlist> | |
31439 | <param name="first" type="WizardPageSimple" default=""/> | |
31440 | <param name="second" type="WizardPageSimple" default=""/> | |
31441 | </paramlist> | |
31442 | </staticmethod> | |
31443 | </class> | |
31444 | <class name="Wizard" oldname="wxWizard" module="wizard"> | |
31445 | <baseclass name="Dialog"/> | |
31446 | <constructor name="Wizard" overloaded="no"> | |
781d2982 | 31447 | <autodoc>__init__(self, Window parent, int id=-1, String title=EmptyString, |
f32fc4bc RD |
31448 | Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition, |
31449 | long style=DEFAULT_DIALOG_STYLE) -> Wizard</autodoc> | |
31450 | <paramlist> | |
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"/> | |
31457 | </paramlist> | |
31458 | </constructor> | |
31459 | <constructor name="PreWizard" overloaded="no"> | |
31460 | <autodoc>PreWizard() -> Wizard</autodoc> | |
31461 | </constructor> | |
31462 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 31463 | <autodoc>Create(self, Window parent, int id=-1, String title=EmptyString, |
f32fc4bc RD |
31464 | Bitmap bitmap=wxNullBitmap, Point pos=DefaultPosition) -> bool</autodoc> |
31465 | <paramlist> | |
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"/> | |
31471 | </paramlist> | |
31472 | </method> | |
31473 | <method name="Init" type="" overloaded="no"> | |
781d2982 | 31474 | <autodoc>Init(self)</autodoc> |
f32fc4bc RD |
31475 | </method> |
31476 | <method name="RunWizard" type="bool" overloaded="no"> | |
781d2982 | 31477 | <autodoc>RunWizard(self, WizardPage firstPage) -> bool</autodoc> |
f32fc4bc RD |
31478 | <paramlist> |
31479 | <param name="firstPage" type="WizardPage" default=""/> | |
31480 | </paramlist> | |
31481 | </method> | |
31482 | <method name="GetCurrentPage" type="WizardPage" overloaded="no"> | |
781d2982 | 31483 | <autodoc>GetCurrentPage(self) -> WizardPage</autodoc> |
f32fc4bc RD |
31484 | </method> |
31485 | <method name="SetPageSize" type="" overloaded="no"> | |
781d2982 | 31486 | <autodoc>SetPageSize(self, Size size)</autodoc> |
f32fc4bc RD |
31487 | <paramlist> |
31488 | <param name="size" type="Size" default=""/> | |
31489 | </paramlist> | |
31490 | </method> | |
31491 | <method name="GetPageSize" type="Size" overloaded="no"> | |
781d2982 | 31492 | <autodoc>GetPageSize(self) -> Size</autodoc> |
f32fc4bc RD |
31493 | </method> |
31494 | <method name="FitToPage" type="" overloaded="no"> | |
781d2982 | 31495 | <autodoc>FitToPage(self, WizardPage firstPage)</autodoc> |
f32fc4bc RD |
31496 | <paramlist> |
31497 | <param name="firstPage" type="WizardPage" default=""/> | |
31498 | </paramlist> | |
31499 | </method> | |
31500 | <method name="GetPageAreaSizer" type="Sizer" overloaded="no"> | |
781d2982 | 31501 | <autodoc>GetPageAreaSizer(self) -> Sizer</autodoc> |
f32fc4bc RD |
31502 | </method> |
31503 | <method name="SetBorder" type="" overloaded="no"> | |
781d2982 | 31504 | <autodoc>SetBorder(self, int border)</autodoc> |
f32fc4bc RD |
31505 | <paramlist> |
31506 | <param name="border" type="int" default=""/> | |
31507 | </paramlist> | |
31508 | </method> | |
31509 | <method name="IsRunning" type="bool" overloaded="no"> | |
781d2982 | 31510 | <autodoc>IsRunning(self) -> bool</autodoc> |
f32fc4bc RD |
31511 | </method> |
31512 | <method name="ShowPage" type="bool" overloaded="no"> | |
781d2982 | 31513 | <autodoc>ShowPage(self, WizardPage page, bool goingForward=True) -> bool</autodoc> |
f32fc4bc RD |
31514 | <paramlist> |
31515 | <param name="page" type="WizardPage" default=""/> | |
31516 | <param name="goingForward" type="bool" default="True"/> | |
31517 | </paramlist> | |
31518 | </method> | |
31519 | <method name="HasNextPage" type="bool" overloaded="no"> | |
781d2982 | 31520 | <autodoc>HasNextPage(self, WizardPage page) -> bool</autodoc> |
f32fc4bc RD |
31521 | <paramlist> |
31522 | <param name="page" type="WizardPage" default=""/> | |
31523 | </paramlist> | |
31524 | </method> | |
31525 | <method name="HasPrevPage" type="bool" overloaded="no"> | |
781d2982 | 31526 | <autodoc>HasPrevPage(self, WizardPage page) -> bool</autodoc> |
f32fc4bc RD |
31527 | <paramlist> |
31528 | <param name="page" type="WizardPage" default=""/> | |
31529 | </paramlist> | |
31530 | </method> | |
31531 | </class> | |
31532 | </module> | |
31533 | <module name="glcanvas"> | |
781d2982 RD |
31534 | <import name="_core"/> |
31535 | <pythoncode> wx = _core </pythoncode> | |
31536 | <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode> | |
f32fc4bc RD |
31537 | <class name="GLContext" oldname="wxGLContext" module="glcanvas"> |
31538 | <baseclass name="Object"/> | |
31539 | <constructor name="GLContext" overloaded="no"> | |
781d2982 | 31540 | <autodoc>__init__(self, bool isRGB, GLCanvas win, wxPalette palette=wxNullPalette, |
f32fc4bc RD |
31541 | GLContext other=None) -> GLContext</autodoc> |
31542 | <paramlist> | |
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"/> | |
31547 | </paramlist> | |
31548 | </constructor> | |
31549 | <destructor name="~wxGLContext" overloaded="no"> | |
781d2982 | 31550 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
31551 | </destructor> |
31552 | <method name="SetCurrent" type="" overloaded="no"> | |
781d2982 | 31553 | <autodoc>SetCurrent(self)</autodoc> |
f32fc4bc RD |
31554 | </method> |
31555 | <method name="SetColour" type="" overloaded="no"> | |
781d2982 | 31556 | <autodoc>SetColour(self, String colour)</autodoc> |
f32fc4bc RD |
31557 | <paramlist> |
31558 | <param name="colour" type="String" default=""/> | |
31559 | </paramlist> | |
31560 | </method> | |
31561 | <method name="SwapBuffers" type="" overloaded="no"> | |
781d2982 | 31562 | <autodoc>SwapBuffers(self)</autodoc> |
f32fc4bc RD |
31563 | </method> |
31564 | <method name="SetupPixelFormat" type="" overloaded="no"> | |
781d2982 | 31565 | <autodoc>SetupPixelFormat(self)</autodoc> |
f32fc4bc RD |
31566 | </method> |
31567 | <method name="SetupPalette" type="" overloaded="no"> | |
781d2982 | 31568 | <autodoc>SetupPalette(self, wxPalette palette)</autodoc> |
f32fc4bc RD |
31569 | <paramlist> |
31570 | <param name="palette" type="Palette" default=""/> | |
31571 | </paramlist> | |
31572 | </method> | |
31573 | <method name="CreateDefaultPalette" type="Palette" overloaded="no"> | |
781d2982 | 31574 | <autodoc>CreateDefaultPalette(self) -> wxPalette</autodoc> |
f32fc4bc RD |
31575 | </method> |
31576 | <method name="GetPalette" type="Palette" overloaded="no"> | |
781d2982 | 31577 | <autodoc>GetPalette(self) -> wxPalette</autodoc> |
f32fc4bc RD |
31578 | </method> |
31579 | <method name="GetWindow" type="Window" overloaded="no"> | |
781d2982 | 31580 | <autodoc>GetWindow(self) -> Window</autodoc> |
f32fc4bc RD |
31581 | </method> |
31582 | </class> | |
31583 | <class name="GLCanvas" oldname="wxGLCanvas" module="glcanvas"> | |
31584 | <baseclass name="Window"/> | |
31585 | <constructor name="GLCanvas" overloaded="no"> | |
781d2982 | 31586 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
31587 | Size size=DefaultSize, long style=0, String name=GLCanvasNameStr, |
31588 | int attribList=None, wxPalette palette=wxNullPalette) -> GLCanvas</autodoc> | |
31589 | <paramlist> | |
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"/> | |
31598 | </paramlist> | |
31599 | </constructor> | |
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> | |
31605 | <paramlist> | |
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"/> | |
31615 | </paramlist> | |
31616 | </constructor> | |
31617 | <method name="SetCurrent" type="" overloaded="no"> | |
781d2982 | 31618 | <autodoc>SetCurrent(self)</autodoc> |
f32fc4bc RD |
31619 | </method> |
31620 | <method name="SetColour" type="" overloaded="no"> | |
781d2982 | 31621 | <autodoc>SetColour(self, String colour)</autodoc> |
f32fc4bc RD |
31622 | <paramlist> |
31623 | <param name="colour" type="String" default=""/> | |
31624 | </paramlist> | |
31625 | </method> | |
31626 | <method name="SwapBuffers" type="" overloaded="no"> | |
781d2982 | 31627 | <autodoc>SwapBuffers(self)</autodoc> |
f32fc4bc RD |
31628 | </method> |
31629 | <method name="GetContext" type="GLContext" overloaded="no"> | |
781d2982 | 31630 | <autodoc>GetContext(self) -> GLContext</autodoc> |
f32fc4bc RD |
31631 | </method> |
31632 | </class> | |
31633 | </module> | |
31634 | <module name="ogl"> | |
781d2982 RD |
31635 | <import name="_windows"/> |
31636 | <pythoncode> wx = _core </pythoncode> | |
31637 | <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode> | |
31638 | <pythoncode> | |
31639 | import warnings | |
31640 | warnings.warn("This module is deprecated. Please use the wx.lib.ogl package instead.", | |
31641 | DeprecationWarning, stacklevel=2) | |
31642 | </pythoncode> | |
f32fc4bc | 31643 | <pythoncode> |
0dd25e81 RD |
31644 | #--------------------------------------------------------------------------- |
31645 | </pythoncode> | |
f32fc4bc RD |
31646 | <class name="ShapeRegion" oldname="wxShapeRegion" module="ogl"> |
31647 | <baseclass name="Object"/> | |
31648 | <constructor name="ShapeRegion" overloaded="no"> | |
781d2982 | 31649 | <autodoc>__init__(self) -> ShapeRegion</autodoc> |
f32fc4bc RD |
31650 | </constructor> |
31651 | <method name="SetText" type="" overloaded="no"> | |
781d2982 | 31652 | <autodoc>SetText(self, String s)</autodoc> |
f32fc4bc RD |
31653 | <paramlist> |
31654 | <param name="s" type="String" default=""/> | |
31655 | </paramlist> | |
31656 | </method> | |
31657 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 31658 | <autodoc>SetFont(self, Font f)</autodoc> |
f32fc4bc RD |
31659 | <paramlist> |
31660 | <param name="f" type="Font" default=""/> | |
31661 | </paramlist> | |
31662 | </method> | |
31663 | <method name="SetMinSize" type="" overloaded="no"> | |
781d2982 | 31664 | <autodoc>SetMinSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
31665 | <paramlist> |
31666 | <param name="w" type="double" default=""/> | |
31667 | <param name="h" type="double" default=""/> | |
31668 | </paramlist> | |
31669 | </method> | |
31670 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 31671 | <autodoc>SetSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
31672 | <paramlist> |
31673 | <param name="w" type="double" default=""/> | |
31674 | <param name="h" type="double" default=""/> | |
31675 | </paramlist> | |
31676 | </method> | |
31677 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 31678 | <autodoc>SetPosition(self, double x, double y)</autodoc> |
f32fc4bc RD |
31679 | <paramlist> |
31680 | <param name="x" type="double" default=""/> | |
31681 | <param name="y" type="double" default=""/> | |
31682 | </paramlist> | |
31683 | </method> | |
31684 | <method name="SetProportions" type="" overloaded="no"> | |
781d2982 | 31685 | <autodoc>SetProportions(self, double x, double y)</autodoc> |
f32fc4bc RD |
31686 | <paramlist> |
31687 | <param name="x" type="double" default=""/> | |
31688 | <param name="y" type="double" default=""/> | |
31689 | </paramlist> | |
31690 | </method> | |
31691 | <method name="SetFormatMode" type="" overloaded="no"> | |
781d2982 | 31692 | <autodoc>SetFormatMode(self, int mode)</autodoc> |
f32fc4bc RD |
31693 | <paramlist> |
31694 | <param name="mode" type="int" default=""/> | |
31695 | </paramlist> | |
31696 | </method> | |
31697 | <method name="SetName" type="" overloaded="no"> | |
781d2982 | 31698 | <autodoc>SetName(self, String s)</autodoc> |
f32fc4bc RD |
31699 | <paramlist> |
31700 | <param name="s" type="String" default=""/> | |
31701 | </paramlist> | |
31702 | </method> | |
31703 | <method name="SetColour" type="" overloaded="no"> | |
781d2982 | 31704 | <autodoc>SetColour(self, String col)</autodoc> |
f32fc4bc RD |
31705 | <paramlist> |
31706 | <param name="col" type="String" default=""/> | |
31707 | </paramlist> | |
31708 | </method> | |
31709 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 31710 | <autodoc>GetText(self) -> String</autodoc> |
f32fc4bc RD |
31711 | </method> |
31712 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 31713 | <autodoc>GetFont(self) -> Font</autodoc> |
f32fc4bc RD |
31714 | </method> |
31715 | <method name="GetMinSize" type="" overloaded="no"> | |
781d2982 | 31716 | <autodoc>GetMinSize(self, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
31717 | <paramlist> |
31718 | <param name="OUTPUT" type="double" default=""/> | |
31719 | <param name="OUTPUT" type="double" default=""/> | |
31720 | </paramlist> | |
31721 | </method> | |
31722 | <method name="GetProportion" type="" overloaded="no"> | |
781d2982 | 31723 | <autodoc>GetProportion(self, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
31724 | <paramlist> |
31725 | <param name="OUTPUT" type="double" default=""/> | |
31726 | <param name="OUTPUT" type="double" default=""/> | |
31727 | </paramlist> | |
31728 | </method> | |
31729 | <method name="GetSize" type="" overloaded="no"> | |
781d2982 | 31730 | <autodoc>GetSize(self, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
31731 | <paramlist> |
31732 | <param name="OUTPUT" type="double" default=""/> | |
31733 | <param name="OUTPUT" type="double" default=""/> | |
31734 | </paramlist> | |
31735 | </method> | |
31736 | <method name="GetPosition" type="" overloaded="no"> | |
781d2982 | 31737 | <autodoc>GetPosition(self, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
31738 | <paramlist> |
31739 | <param name="OUTPUT" type="double" default=""/> | |
31740 | <param name="OUTPUT" type="double" default=""/> | |
31741 | </paramlist> | |
31742 | </method> | |
31743 | <method name="GetFormatMode" type="int" overloaded="no"> | |
781d2982 | 31744 | <autodoc>GetFormatMode(self) -> int</autodoc> |
f32fc4bc RD |
31745 | </method> |
31746 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 31747 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
31748 | </method> |
31749 | <method name="GetColour" type="String" overloaded="no"> | |
781d2982 | 31750 | <autodoc>GetColour(self) -> String</autodoc> |
f32fc4bc RD |
31751 | </method> |
31752 | <method name="GetActualColourObject" type="Colour" overloaded="no"> | |
781d2982 | 31753 | <autodoc>GetActualColourObject(self) -> Colour</autodoc> |
f32fc4bc RD |
31754 | </method> |
31755 | <method name="GetFormattedText" type="wxList" overloaded="no"> | |
781d2982 | 31756 | <autodoc>GetFormattedText(self) -> wxList</autodoc> |
f32fc4bc RD |
31757 | </method> |
31758 | <method name="GetPenColour" type="String" overloaded="no"> | |
781d2982 | 31759 | <autodoc>GetPenColour(self) -> String</autodoc> |
f32fc4bc RD |
31760 | </method> |
31761 | <method name="GetPenStyle" type="int" overloaded="no"> | |
781d2982 | 31762 | <autodoc>GetPenStyle(self) -> int</autodoc> |
f32fc4bc RD |
31763 | </method> |
31764 | <method name="SetPenStyle" type="" overloaded="no"> | |
781d2982 | 31765 | <autodoc>SetPenStyle(self, int style)</autodoc> |
f32fc4bc RD |
31766 | <paramlist> |
31767 | <param name="style" type="int" default=""/> | |
31768 | </paramlist> | |
31769 | </method> | |
31770 | <method name="SetPenColour" type="" overloaded="no"> | |
781d2982 | 31771 | <autodoc>SetPenColour(self, String col)</autodoc> |
f32fc4bc RD |
31772 | <paramlist> |
31773 | <param name="col" type="String" default=""/> | |
31774 | </paramlist> | |
31775 | </method> | |
31776 | <method name="GetActualPen" type="Pen" overloaded="no"> | |
781d2982 | 31777 | <autodoc>GetActualPen(self) -> wxPen</autodoc> |
f32fc4bc RD |
31778 | </method> |
31779 | <method name="GetWidth" type="double" overloaded="no"> | |
781d2982 | 31780 | <autodoc>GetWidth(self) -> double</autodoc> |
f32fc4bc RD |
31781 | </method> |
31782 | <method name="GetHeight" type="double" overloaded="no"> | |
781d2982 | 31783 | <autodoc>GetHeight(self) -> double</autodoc> |
f32fc4bc RD |
31784 | </method> |
31785 | <method name="ClearText" type="" overloaded="no"> | |
781d2982 | 31786 | <autodoc>ClearText(self)</autodoc> |
f32fc4bc RD |
31787 | </method> |
31788 | </class> | |
31789 | <class name="AttachmentPoint" oldname="wxAttachmentPoint" module="ogl"> | |
31790 | <baseclass name="Object"/> | |
31791 | <constructor name="AttachmentPoint" overloaded="no"> | |
781d2982 | 31792 | <autodoc>__init__(self, int id=0, double x=0.0, double y=0.0) -> AttachmentPoint</autodoc> |
f32fc4bc RD |
31793 | <paramlist> |
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"/> | |
31797 | </paramlist> | |
31798 | </constructor> | |
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"/> | |
31802 | </class> | |
31803 | <class name="PyShapeEvtHandler" oldname="wxPyShapeEvtHandler" module="ogl"> | |
31804 | <baseclass name="Object"/> | |
31805 | <constructor name="PyShapeEvtHandler" overloaded="no"> | |
781d2982 | 31806 | <autodoc>__init__(self, PyShapeEvtHandler prev=None, PyShape shape=None) -> PyShapeEvtHandler</autodoc> |
f32fc4bc RD |
31807 | <paramlist> |
31808 | <param name="prev" type="PyShapeEvtHandler" default="NULL"/> | |
31809 | <param name="shape" type="wxPyShape" default="NULL"/> | |
31810 | </paramlist> | |
31811 | </constructor> | |
31812 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 31813 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
31814 | <paramlist> |
31815 | <param name="self" type="PyObject" default=""/> | |
31816 | <param name="_class" type="PyObject" default=""/> | |
31817 | </paramlist> | |
31818 | </method> | |
31819 | <method name="_setOORInfo" type="" overloaded="no"> | |
781d2982 | 31820 | <autodoc>_setOORInfo(self, PyObject _self)</autodoc> |
f32fc4bc RD |
31821 | <paramlist> |
31822 | <param name="_self" type="PyObject" default=""/> | |
31823 | </paramlist> | |
31824 | </method> | |
31825 | <method name="SetShape" type="" overloaded="no"> | |
781d2982 | 31826 | <autodoc>SetShape(self, PyShape sh)</autodoc> |
f32fc4bc RD |
31827 | <paramlist> |
31828 | <param name="sh" type="wxPyShape" default=""/> | |
31829 | </paramlist> | |
31830 | </method> | |
31831 | <method name="GetShape" type="wxPyShape" overloaded="no"> | |
781d2982 | 31832 | <autodoc>GetShape(self) -> PyShape</autodoc> |
f32fc4bc RD |
31833 | </method> |
31834 | <method name="SetPreviousHandler" type="" overloaded="no"> | |
781d2982 | 31835 | <autodoc>SetPreviousHandler(self, PyShapeEvtHandler handler)</autodoc> |
f32fc4bc RD |
31836 | <paramlist> |
31837 | <param name="handler" type="PyShapeEvtHandler" default=""/> | |
31838 | </paramlist> | |
31839 | </method> | |
31840 | <method name="GetPreviousHandler" type="PyShapeEvtHandler" overloaded="no"> | |
781d2982 | 31841 | <autodoc>GetPreviousHandler(self) -> PyShapeEvtHandler</autodoc> |
f32fc4bc RD |
31842 | </method> |
31843 | <method name="CreateNewCopy" type="PyShapeEvtHandler" overloaded="no"> | |
781d2982 | 31844 | <autodoc>CreateNewCopy(self) -> PyShapeEvtHandler</autodoc> |
f32fc4bc RD |
31845 | </method> |
31846 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 31847 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
31848 | </method> |
31849 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 31850 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
31851 | <paramlist> |
31852 | <param name="dc" type="DC" default=""/> | |
31853 | </paramlist> | |
31854 | </method> | |
31855 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 31856 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
31857 | <paramlist> |
31858 | <param name="dc" type="DC" default=""/> | |
31859 | </paramlist> | |
31860 | </method> | |
31861 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 31862 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=False)</autodoc> |
f32fc4bc RD |
31863 | <paramlist> |
31864 | <param name="dc" type="DC" default=""/> | |
31865 | <param name="erase" type="bool" default="False"/> | |
31866 | </paramlist> | |
31867 | </method> | |
31868 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 31869 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
31870 | <paramlist> |
31871 | <param name="dc" type="DC" default=""/> | |
31872 | </paramlist> | |
31873 | </method> | |
31874 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 31875 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
31876 | <paramlist> |
31877 | <param name="dc" type="DC" default=""/> | |
31878 | </paramlist> | |
31879 | </method> | |
31880 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 31881 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
31882 | <paramlist> |
31883 | <param name="dc" type="DC" default=""/> | |
31884 | </paramlist> | |
31885 | </method> | |
31886 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 31887 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
31888 | <paramlist> |
31889 | <param name="dc" type="DC" default=""/> | |
31890 | </paramlist> | |
31891 | </method> | |
31892 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 31893 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31894 | <paramlist> |
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"/> | |
31899 | </paramlist> | |
31900 | </method> | |
31901 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 31902 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31903 | <paramlist> |
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"/> | |
31908 | </paramlist> | |
31909 | </method> | |
31910 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 31911 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31912 | <paramlist> |
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"/> | |
31917 | </paramlist> | |
31918 | </method> | |
31919 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 31920 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
31921 | <paramlist> |
31922 | <param name="x" type="double" default=""/> | |
31923 | <param name="y" type="double" default=""/> | |
31924 | </paramlist> | |
31925 | </method> | |
31926 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 31927 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
31928 | bool display=True) -> bool</autodoc> |
31929 | <paramlist> | |
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"/> | |
31936 | </paramlist> | |
31937 | </method> | |
31938 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 31939 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
31940 | bool display=True)</autodoc> |
31941 | <paramlist> | |
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"/> | |
31948 | </paramlist> | |
31949 | </method> | |
31950 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 31951 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31952 | <paramlist> |
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"/> | |
31958 | </paramlist> | |
31959 | </method> | |
31960 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 31961 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31962 | <paramlist> |
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"/> | |
31967 | </paramlist> | |
31968 | </method> | |
31969 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 31970 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31971 | <paramlist> |
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"/> | |
31976 | </paramlist> | |
31977 | </method> | |
31978 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 31979 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31980 | <paramlist> |
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"/> | |
31986 | </paramlist> | |
31987 | </method> | |
31988 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 31989 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31990 | <paramlist> |
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"/> | |
31995 | </paramlist> | |
31996 | </method> | |
31997 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 31998 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
31999 | <paramlist> |
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"/> | |
32004 | </paramlist> | |
32005 | </method> | |
32006 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 32007 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
32008 | <paramlist> |
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=""/> | |
32014 | </paramlist> | |
32015 | </method> | |
32016 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 32017 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
32018 | <paramlist> |
32019 | <param name="dc" type="DC" default=""/> | |
32020 | </paramlist> | |
32021 | </method> | |
32022 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 32023 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
32024 | <paramlist> |
32025 | <param name="dc" type="DC" default=""/> | |
32026 | </paramlist> | |
32027 | </method> | |
32028 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 32029 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
32030 | <paramlist> |
32031 | <param name="dc" type="DC" default=""/> | |
32032 | <param name="moveControlPoints" type="bool" default="True"/> | |
32033 | </paramlist> | |
32034 | </method> | |
32035 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 32036 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
32037 | int attachment=0)</autodoc> |
32038 | <paramlist> | |
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"/> | |
32045 | </paramlist> | |
32046 | </method> | |
32047 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 32048 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
32049 | int attachment=0)</autodoc> |
32050 | <paramlist> | |
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"/> | |
32056 | </paramlist> | |
32057 | </method> | |
32058 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 32059 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
32060 | int attachment=0)</autodoc> |
32061 | <paramlist> | |
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"/> | |
32067 | </paramlist> | |
32068 | </method> | |
32069 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 32070 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
32071 | <paramlist> |
32072 | <param name="w" type="double" default=""/> | |
32073 | <param name="h" type="double" default=""/> | |
32074 | </paramlist> | |
32075 | </method> | |
32076 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 32077 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
32078 | <paramlist> |
32079 | <param name="w" type="double" default=""/> | |
32080 | <param name="h" type="double" default=""/> | |
32081 | </paramlist> | |
32082 | </method> | |
32083 | </class> | |
32084 | <class name="PyShape" oldname="wxPyShape" module="ogl"> | |
32085 | <baseclass name="PyShapeEvtHandler"/> | |
32086 | <constructor name="PyShape" overloaded="no"> | |
781d2982 | 32087 | <autodoc>__init__(self, PyShapeCanvas can=None) -> PyShape</autodoc> |
f32fc4bc RD |
32088 | <paramlist> |
32089 | <param name="can" type="wxPyShapeCanvas" default="NULL"/> | |
32090 | </paramlist> | |
32091 | </constructor> | |
32092 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 32093 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
32094 | <paramlist> |
32095 | <param name="self" type="PyObject" default=""/> | |
32096 | <param name="_class" type="PyObject" default=""/> | |
32097 | </paramlist> | |
32098 | </method> | |
32099 | <method name="GetBoundingBoxMax" type="" overloaded="no"> | |
781d2982 | 32100 | <autodoc>GetBoundingBoxMax(self, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
32101 | <paramlist> |
32102 | <param name="OUTPUT" type="double" default=""/> | |
32103 | <param name="OUTPUT" type="double" default=""/> | |
32104 | </paramlist> | |
32105 | </method> | |
32106 | <method name="GetBoundingBoxMin" type="" overloaded="no"> | |
781d2982 | 32107 | <autodoc>GetBoundingBoxMin(self, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
32108 | <paramlist> |
32109 | <param name="OUTPUT" type="double" default=""/> | |
32110 | <param name="OUTPUT" type="double" default=""/> | |
32111 | </paramlist> | |
32112 | </method> | |
32113 | <method name="GetPerimeterPoint" type="bool" overloaded="no"> | |
781d2982 | 32114 | <autodoc>GetPerimeterPoint(self, double x1, double y1, double x2, double y2, double OUTPUT, |
f32fc4bc RD |
32115 | double OUTPUT) -> bool</autodoc> |
32116 | <paramlist> | |
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=""/> | |
32123 | </paramlist> | |
32124 | </method> | |
32125 | <method name="GetCanvas" type="wxPyShapeCanvas" overloaded="no"> | |
781d2982 | 32126 | <autodoc>GetCanvas(self) -> PyShapeCanvas</autodoc> |
f32fc4bc RD |
32127 | </method> |
32128 | <method name="SetCanvas" type="" overloaded="no"> | |
781d2982 | 32129 | <autodoc>SetCanvas(self, PyShapeCanvas the_canvas)</autodoc> |
f32fc4bc RD |
32130 | <paramlist> |
32131 | <param name="the_canvas" type="wxPyShapeCanvas" default=""/> | |
32132 | </paramlist> | |
32133 | </method> | |
32134 | <method name="AddToCanvas" type="" overloaded="no"> | |
781d2982 | 32135 | <autodoc>AddToCanvas(self, PyShapeCanvas the_canvas, PyShape addAfter=None)</autodoc> |
f32fc4bc RD |
32136 | <paramlist> |
32137 | <param name="the_canvas" type="wxPyShapeCanvas" default=""/> | |
32138 | <param name="addAfter" type="PyShape" default="NULL"/> | |
32139 | </paramlist> | |
32140 | </method> | |
32141 | <method name="InsertInCanvas" type="" overloaded="no"> | |
781d2982 | 32142 | <autodoc>InsertInCanvas(self, PyShapeCanvas the_canvas)</autodoc> |
f32fc4bc RD |
32143 | <paramlist> |
32144 | <param name="the_canvas" type="wxPyShapeCanvas" default=""/> | |
32145 | </paramlist> | |
32146 | </method> | |
32147 | <method name="RemoveFromCanvas" type="" overloaded="no"> | |
781d2982 | 32148 | <autodoc>RemoveFromCanvas(self, PyShapeCanvas the_canvas)</autodoc> |
f32fc4bc RD |
32149 | <paramlist> |
32150 | <param name="the_canvas" type="wxPyShapeCanvas" default=""/> | |
32151 | </paramlist> | |
32152 | </method> | |
32153 | <method name="GetX" type="double" overloaded="no"> | |
781d2982 | 32154 | <autodoc>GetX(self) -> double</autodoc> |
f32fc4bc RD |
32155 | </method> |
32156 | <method name="GetY" type="double" overloaded="no"> | |
781d2982 | 32157 | <autodoc>GetY(self) -> double</autodoc> |
f32fc4bc RD |
32158 | </method> |
32159 | <method name="SetX" type="" overloaded="no"> | |
781d2982 | 32160 | <autodoc>SetX(self, double x)</autodoc> |
f32fc4bc RD |
32161 | <paramlist> |
32162 | <param name="x" type="double" default=""/> | |
32163 | </paramlist> | |
32164 | </method> | |
32165 | <method name="SetY" type="" overloaded="no"> | |
781d2982 | 32166 | <autodoc>SetY(self, double y)</autodoc> |
f32fc4bc RD |
32167 | <paramlist> |
32168 | <param name="y" type="double" default=""/> | |
32169 | </paramlist> | |
32170 | </method> | |
32171 | <method name="GetParent" type="PyShape" overloaded="no"> | |
781d2982 | 32172 | <autodoc>GetParent(self) -> PyShape</autodoc> |
f32fc4bc RD |
32173 | </method> |
32174 | <method name="SetParent" type="" overloaded="no"> | |
781d2982 | 32175 | <autodoc>SetParent(self, PyShape p)</autodoc> |
f32fc4bc RD |
32176 | <paramlist> |
32177 | <param name="p" type="PyShape" default=""/> | |
32178 | </paramlist> | |
32179 | </method> | |
32180 | <method name="GetTopAncestor" type="PyShape" overloaded="no"> | |
781d2982 | 32181 | <autodoc>GetTopAncestor(self) -> PyShape</autodoc> |
f32fc4bc RD |
32182 | </method> |
32183 | <method name="GetChildren" type="PyObject" overloaded="no"> | |
781d2982 | 32184 | <autodoc>GetChildren(self) -> PyObject</autodoc> |
f32fc4bc RD |
32185 | </method> |
32186 | <method name="Unlink" type="" overloaded="no"> | |
781d2982 | 32187 | <autodoc>Unlink(self)</autodoc> |
f32fc4bc RD |
32188 | </method> |
32189 | <method name="SetDrawHandles" type="" overloaded="no"> | |
781d2982 | 32190 | <autodoc>SetDrawHandles(self, bool drawH)</autodoc> |
f32fc4bc RD |
32191 | <paramlist> |
32192 | <param name="drawH" type="bool" default=""/> | |
32193 | </paramlist> | |
32194 | </method> | |
32195 | <method name="GetDrawHandles" type="bool" overloaded="no"> | |
781d2982 | 32196 | <autodoc>GetDrawHandles(self) -> bool</autodoc> |
f32fc4bc RD |
32197 | </method> |
32198 | <method name="MakeControlPoints" type="" overloaded="no"> | |
781d2982 | 32199 | <autodoc>MakeControlPoints(self)</autodoc> |
f32fc4bc RD |
32200 | </method> |
32201 | <method name="DeleteControlPoints" type="" overloaded="no"> | |
781d2982 | 32202 | <autodoc>DeleteControlPoints(self, DC dc=None)</autodoc> |
f32fc4bc RD |
32203 | <paramlist> |
32204 | <param name="dc" type="DC" default="NULL"/> | |
32205 | </paramlist> | |
32206 | </method> | |
32207 | <method name="ResetControlPoints" type="" overloaded="no"> | |
781d2982 | 32208 | <autodoc>ResetControlPoints(self)</autodoc> |
f32fc4bc RD |
32209 | </method> |
32210 | <method name="GetEventHandler" type="PyShapeEvtHandler" overloaded="no"> | |
781d2982 | 32211 | <autodoc>GetEventHandler(self) -> PyShapeEvtHandler</autodoc> |
f32fc4bc RD |
32212 | </method> |
32213 | <method name="SetEventHandler" type="" overloaded="no"> | |
781d2982 | 32214 | <autodoc>SetEventHandler(self, PyShapeEvtHandler handler)</autodoc> |
f32fc4bc RD |
32215 | <paramlist> |
32216 | <param name="handler" type="PyShapeEvtHandler" default=""/> | |
32217 | </paramlist> | |
32218 | </method> | |
32219 | <method name="MakeMandatoryControlPoints" type="" overloaded="no"> | |
781d2982 | 32220 | <autodoc>MakeMandatoryControlPoints(self)</autodoc> |
f32fc4bc RD |
32221 | </method> |
32222 | <method name="ResetMandatoryControlPoints" type="" overloaded="no"> | |
781d2982 | 32223 | <autodoc>ResetMandatoryControlPoints(self)</autodoc> |
f32fc4bc RD |
32224 | </method> |
32225 | <method name="Recompute" type="bool" overloaded="no"> | |
781d2982 | 32226 | <autodoc>Recompute(self) -> bool</autodoc> |
f32fc4bc RD |
32227 | </method> |
32228 | <method name="CalculateSize" type="" overloaded="no"> | |
781d2982 | 32229 | <autodoc>CalculateSize(self)</autodoc> |
f32fc4bc RD |
32230 | </method> |
32231 | <method name="Select" type="" overloaded="no"> | |
781d2982 | 32232 | <autodoc>Select(self, bool select=True, DC dc=None)</autodoc> |
f32fc4bc RD |
32233 | <paramlist> |
32234 | <param name="select" type="bool" default="True"/> | |
32235 | <param name="dc" type="DC" default="NULL"/> | |
32236 | </paramlist> | |
32237 | </method> | |
32238 | <method name="SetHighlight" type="" overloaded="no"> | |
781d2982 | 32239 | <autodoc>SetHighlight(self, bool hi=True, bool recurse=False)</autodoc> |
f32fc4bc RD |
32240 | <paramlist> |
32241 | <param name="hi" type="bool" default="True"/> | |
32242 | <param name="recurse" type="bool" default="False"/> | |
32243 | </paramlist> | |
32244 | </method> | |
32245 | <method name="IsHighlighted" type="bool" overloaded="no"> | |
781d2982 | 32246 | <autodoc>IsHighlighted(self) -> bool</autodoc> |
f32fc4bc RD |
32247 | </method> |
32248 | <method name="Selected" type="bool" overloaded="no"> | |
781d2982 | 32249 | <autodoc>Selected(self) -> bool</autodoc> |
f32fc4bc RD |
32250 | </method> |
32251 | <method name="AncestorSelected" type="bool" overloaded="no"> | |
781d2982 | 32252 | <autodoc>AncestorSelected(self) -> bool</autodoc> |
f32fc4bc RD |
32253 | </method> |
32254 | <method name="SetSensitivityFilter" type="" overloaded="no"> | |
781d2982 | 32255 | <autodoc>SetSensitivityFilter(self, int sens=OP_ALL, bool recursive=False)</autodoc> |
f32fc4bc RD |
32256 | <paramlist> |
32257 | <param name="sens" type="int" default="OP_ALL"/> | |
32258 | <param name="recursive" type="bool" default="False"/> | |
32259 | </paramlist> | |
32260 | </method> | |
32261 | <method name="GetSensitivityFilter" type="int" overloaded="no"> | |
781d2982 | 32262 | <autodoc>GetSensitivityFilter(self) -> int</autodoc> |
f32fc4bc RD |
32263 | </method> |
32264 | <method name="SetDraggable" type="" overloaded="no"> | |
781d2982 | 32265 | <autodoc>SetDraggable(self, bool drag, bool recursive=False)</autodoc> |
f32fc4bc RD |
32266 | <paramlist> |
32267 | <param name="drag" type="bool" default=""/> | |
32268 | <param name="recursive" type="bool" default="False"/> | |
32269 | </paramlist> | |
32270 | </method> | |
32271 | <method name="SetFixedSize" type="" overloaded="no"> | |
781d2982 | 32272 | <autodoc>SetFixedSize(self, bool x, bool y)</autodoc> |
f32fc4bc RD |
32273 | <paramlist> |
32274 | <param name="x" type="bool" default=""/> | |
32275 | <param name="y" type="bool" default=""/> | |
32276 | </paramlist> | |
32277 | </method> | |
32278 | <method name="GetFixedSize" type="" overloaded="no"> | |
781d2982 | 32279 | <autodoc>GetFixedSize(self, bool OUTPUT, bool OUTPUT)</autodoc> |
f32fc4bc RD |
32280 | <paramlist> |
32281 | <param name="OUTPUT" type="bool" default=""/> | |
32282 | <param name="OUTPUT" type="bool" default=""/> | |
32283 | </paramlist> | |
32284 | </method> | |
32285 | <method name="GetFixedWidth" type="bool" overloaded="no"> | |
781d2982 | 32286 | <autodoc>GetFixedWidth(self) -> bool</autodoc> |
f32fc4bc RD |
32287 | </method> |
32288 | <method name="GetFixedHeight" type="bool" overloaded="no"> | |
781d2982 | 32289 | <autodoc>GetFixedHeight(self) -> bool</autodoc> |
f32fc4bc RD |
32290 | </method> |
32291 | <method name="SetSpaceAttachments" type="" overloaded="no"> | |
781d2982 | 32292 | <autodoc>SetSpaceAttachments(self, bool sp)</autodoc> |
f32fc4bc RD |
32293 | <paramlist> |
32294 | <param name="sp" type="bool" default=""/> | |
32295 | </paramlist> | |
32296 | </method> | |
32297 | <method name="GetSpaceAttachments" type="bool" overloaded="no"> | |
781d2982 | 32298 | <autodoc>GetSpaceAttachments(self) -> bool</autodoc> |
f32fc4bc RD |
32299 | </method> |
32300 | <method name="SetShadowMode" type="" overloaded="no"> | |
781d2982 | 32301 | <autodoc>SetShadowMode(self, int mode, bool redraw=False)</autodoc> |
f32fc4bc RD |
32302 | <paramlist> |
32303 | <param name="mode" type="int" default=""/> | |
32304 | <param name="redraw" type="bool" default="False"/> | |
32305 | </paramlist> | |
32306 | </method> | |
32307 | <method name="GetShadowMode" type="int" overloaded="no"> | |
781d2982 | 32308 | <autodoc>GetShadowMode(self) -> int</autodoc> |
f32fc4bc RD |
32309 | </method> |
32310 | <method name="HitTest" type="bool" overloaded="no"> | |
781d2982 | 32311 | <autodoc>HitTest(self, double x, double y, int OUTPUT, double OUTPUT) -> bool</autodoc> |
f32fc4bc RD |
32312 | <paramlist> |
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=""/> | |
32317 | </paramlist> | |
32318 | </method> | |
32319 | <method name="SetCentreResize" type="" overloaded="no"> | |
781d2982 | 32320 | <autodoc>SetCentreResize(self, bool cr)</autodoc> |
f32fc4bc RD |
32321 | <paramlist> |
32322 | <param name="cr" type="bool" default=""/> | |
32323 | </paramlist> | |
32324 | </method> | |
32325 | <method name="GetCentreResize" type="bool" overloaded="no"> | |
781d2982 | 32326 | <autodoc>GetCentreResize(self) -> bool</autodoc> |
f32fc4bc RD |
32327 | </method> |
32328 | <method name="SetMaintainAspectRatio" type="" overloaded="no"> | |
781d2982 | 32329 | <autodoc>SetMaintainAspectRatio(self, bool ar)</autodoc> |
f32fc4bc RD |
32330 | <paramlist> |
32331 | <param name="ar" type="bool" default=""/> | |
32332 | </paramlist> | |
32333 | </method> | |
32334 | <method name="GetMaintainAspectRatio" type="bool" overloaded="no"> | |
781d2982 | 32335 | <autodoc>GetMaintainAspectRatio(self) -> bool</autodoc> |
f32fc4bc RD |
32336 | </method> |
32337 | <method name="GetLines" type="PyObject" overloaded="no"> | |
781d2982 | 32338 | <autodoc>GetLines(self) -> PyObject</autodoc> |
f32fc4bc RD |
32339 | </method> |
32340 | <method name="SetDisableLabel" type="" overloaded="no"> | |
781d2982 | 32341 | <autodoc>SetDisableLabel(self, bool flag)</autodoc> |
f32fc4bc RD |
32342 | <paramlist> |
32343 | <param name="flag" type="bool" default=""/> | |
32344 | </paramlist> | |
32345 | </method> | |
32346 | <method name="GetDisableLabel" type="bool" overloaded="no"> | |
781d2982 | 32347 | <autodoc>GetDisableLabel(self) -> bool</autodoc> |
f32fc4bc RD |
32348 | </method> |
32349 | <method name="SetAttachmentMode" type="" overloaded="no"> | |
781d2982 | 32350 | <autodoc>SetAttachmentMode(self, int mode)</autodoc> |
f32fc4bc RD |
32351 | <paramlist> |
32352 | <param name="mode" type="int" default=""/> | |
32353 | </paramlist> | |
32354 | </method> | |
32355 | <method name="GetAttachmentMode" type="int" overloaded="no"> | |
781d2982 | 32356 | <autodoc>GetAttachmentMode(self) -> int</autodoc> |
f32fc4bc RD |
32357 | </method> |
32358 | <method name="SetId" type="" overloaded="no"> | |
781d2982 | 32359 | <autodoc>SetId(self, long i)</autodoc> |
f32fc4bc RD |
32360 | <paramlist> |
32361 | <param name="i" type="long" default=""/> | |
32362 | </paramlist> | |
32363 | </method> | |
32364 | <method name="GetId" type="long" overloaded="no"> | |
781d2982 | 32365 | <autodoc>GetId(self) -> long</autodoc> |
f32fc4bc RD |
32366 | </method> |
32367 | <method name="SetPen" type="" overloaded="no"> | |
781d2982 | 32368 | <autodoc>SetPen(self, wxPen pen)</autodoc> |
f32fc4bc RD |
32369 | <paramlist> |
32370 | <param name="pen" type="Pen" default=""/> | |
32371 | </paramlist> | |
32372 | </method> | |
32373 | <method name="SetBrush" type="" overloaded="no"> | |
781d2982 | 32374 | <autodoc>SetBrush(self, wxBrush brush)</autodoc> |
f32fc4bc RD |
32375 | <paramlist> |
32376 | <param name="brush" type="Brush" default=""/> | |
32377 | </paramlist> | |
32378 | </method> | |
32379 | <method name="Show" type="" overloaded="no"> | |
781d2982 | 32380 | <autodoc>Show(self, bool show)</autodoc> |
f32fc4bc RD |
32381 | <paramlist> |
32382 | <param name="show" type="bool" default=""/> | |
32383 | </paramlist> | |
32384 | </method> | |
32385 | <method name="IsShown" type="bool" overloaded="no"> | |
781d2982 | 32386 | <autodoc>IsShown(self) -> bool</autodoc> |
f32fc4bc RD |
32387 | </method> |
32388 | <method name="Move" type="" overloaded="no"> | |
781d2982 | 32389 | <autodoc>Move(self, DC dc, double x1, double y1, bool display=True)</autodoc> |
f32fc4bc RD |
32390 | <paramlist> |
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"/> | |
32395 | </paramlist> | |
32396 | </method> | |
32397 | <method name="Erase" type="" overloaded="no"> | |
781d2982 | 32398 | <autodoc>Erase(self, DC dc)</autodoc> |
f32fc4bc RD |
32399 | <paramlist> |
32400 | <param name="dc" type="DC" default=""/> | |
32401 | </paramlist> | |
32402 | </method> | |
32403 | <method name="EraseContents" type="" overloaded="no"> | |
781d2982 | 32404 | <autodoc>EraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
32405 | <paramlist> |
32406 | <param name="dc" type="DC" default=""/> | |
32407 | </paramlist> | |
32408 | </method> | |
32409 | <method name="Draw" type="" overloaded="no"> | |
781d2982 | 32410 | <autodoc>Draw(self, DC dc)</autodoc> |
f32fc4bc RD |
32411 | <paramlist> |
32412 | <param name="dc" type="DC" default=""/> | |
32413 | </paramlist> | |
32414 | </method> | |
32415 | <method name="Flash" type="" overloaded="no"> | |
781d2982 | 32416 | <autodoc>Flash(self)</autodoc> |
f32fc4bc RD |
32417 | </method> |
32418 | <method name="MoveLinks" type="" overloaded="no"> | |
781d2982 | 32419 | <autodoc>MoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
32420 | <paramlist> |
32421 | <param name="dc" type="DC" default=""/> | |
32422 | </paramlist> | |
32423 | </method> | |
32424 | <method name="DrawContents" type="" overloaded="no"> | |
781d2982 | 32425 | <autodoc>DrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
32426 | <paramlist> |
32427 | <param name="dc" type="DC" default=""/> | |
32428 | </paramlist> | |
32429 | </method> | |
32430 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 32431 | <autodoc>SetSize(self, double x, double y, bool recursive=True)</autodoc> |
f32fc4bc RD |
32432 | <paramlist> |
32433 | <param name="x" type="double" default=""/> | |
32434 | <param name="y" type="double" default=""/> | |
32435 | <param name="recursive" type="bool" default="True"/> | |
32436 | </paramlist> | |
32437 | </method> | |
32438 | <method name="SetAttachmentSize" type="" overloaded="no"> | |
781d2982 | 32439 | <autodoc>SetAttachmentSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
32440 | <paramlist> |
32441 | <param name="x" type="double" default=""/> | |
32442 | <param name="y" type="double" default=""/> | |
32443 | </paramlist> | |
32444 | </method> | |
32445 | <method name="Attach" type="" overloaded="no"> | |
781d2982 | 32446 | <autodoc>Attach(self, PyShapeCanvas can)</autodoc> |
f32fc4bc RD |
32447 | <paramlist> |
32448 | <param name="can" type="wxPyShapeCanvas" default=""/> | |
32449 | </paramlist> | |
32450 | </method> | |
32451 | <method name="Detach" type="" overloaded="no"> | |
781d2982 | 32452 | <autodoc>Detach(self)</autodoc> |
f32fc4bc RD |
32453 | </method> |
32454 | <method name="Constrain" type="bool" overloaded="no"> | |
781d2982 | 32455 | <autodoc>Constrain(self) -> bool</autodoc> |
f32fc4bc RD |
32456 | </method> |
32457 | <method name="AddLine" type="" overloaded="no"> | |
781d2982 | 32458 | <autodoc>AddLine(self, PyLineShape line, PyShape other, int attachFrom=0, |
f32fc4bc RD |
32459 | int attachTo=0, int positionFrom=-1, int positionTo=-1)</autodoc> |
32460 | <paramlist> | |
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"/> | |
32467 | </paramlist> | |
32468 | </method> | |
32469 | <method name="GetLinePosition" type="int" overloaded="no"> | |
781d2982 | 32470 | <autodoc>GetLinePosition(self, PyLineShape line) -> int</autodoc> |
f32fc4bc RD |
32471 | <paramlist> |
32472 | <param name="line" type="wxPyLineShape" default=""/> | |
32473 | </paramlist> | |
32474 | </method> | |
32475 | <method name="AddText" type="" overloaded="no"> | |
781d2982 | 32476 | <autodoc>AddText(self, String string)</autodoc> |
f32fc4bc RD |
32477 | <paramlist> |
32478 | <param name="string" type="String" default=""/> | |
32479 | </paramlist> | |
32480 | </method> | |
32481 | <method name="GetPen" type="Pen" overloaded="no"> | |
781d2982 | 32482 | <autodoc>GetPen(self) -> wxPen</autodoc> |
f32fc4bc RD |
32483 | </method> |
32484 | <method name="GetBrush" type="Brush" overloaded="no"> | |
781d2982 | 32485 | <autodoc>GetBrush(self) -> wxBrush</autodoc> |
f32fc4bc RD |
32486 | </method> |
32487 | <method name="SetDefaultRegionSize" type="" overloaded="no"> | |
781d2982 | 32488 | <autodoc>SetDefaultRegionSize(self)</autodoc> |
f32fc4bc RD |
32489 | </method> |
32490 | <method name="FormatText" type="" overloaded="no"> | |
781d2982 | 32491 | <autodoc>FormatText(self, DC dc, String s, int regionId=0)</autodoc> |
f32fc4bc RD |
32492 | <paramlist> |
32493 | <param name="dc" type="DC" default=""/> | |
32494 | <param name="s" type="String" default=""/> | |
32495 | <param name="regionId" type="int" default="0"/> | |
32496 | </paramlist> | |
32497 | </method> | |
32498 | <method name="SetFormatMode" type="" overloaded="no"> | |
781d2982 | 32499 | <autodoc>SetFormatMode(self, int mode, int regionId=0)</autodoc> |
f32fc4bc RD |
32500 | <paramlist> |
32501 | <param name="mode" type="int" default=""/> | |
32502 | <param name="regionId" type="int" default="0"/> | |
32503 | </paramlist> | |
32504 | </method> | |
32505 | <method name="GetFormatMode" type="int" overloaded="no"> | |
781d2982 | 32506 | <autodoc>GetFormatMode(self, int regionId=0) -> int</autodoc> |
f32fc4bc RD |
32507 | <paramlist> |
32508 | <param name="regionId" type="int" default="0"/> | |
32509 | </paramlist> | |
32510 | </method> | |
32511 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 32512 | <autodoc>SetFont(self, Font font, int regionId=0)</autodoc> |
f32fc4bc RD |
32513 | <paramlist> |
32514 | <param name="font" type="Font" default=""/> | |
32515 | <param name="regionId" type="int" default="0"/> | |
32516 | </paramlist> | |
32517 | </method> | |
32518 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 32519 | <autodoc>GetFont(self, int regionId=0) -> Font</autodoc> |
f32fc4bc RD |
32520 | <paramlist> |
32521 | <param name="regionId" type="int" default="0"/> | |
32522 | </paramlist> | |
32523 | </method> | |
32524 | <method name="SetTextColour" type="" overloaded="no"> | |
781d2982 | 32525 | <autodoc>SetTextColour(self, String colour, int regionId=0)</autodoc> |
f32fc4bc RD |
32526 | <paramlist> |
32527 | <param name="colour" type="String" default=""/> | |
32528 | <param name="regionId" type="int" default="0"/> | |
32529 | </paramlist> | |
32530 | </method> | |
32531 | <method name="GetTextColour" type="String" overloaded="no"> | |
781d2982 | 32532 | <autodoc>GetTextColour(self, int regionId=0) -> String</autodoc> |
f32fc4bc RD |
32533 | <paramlist> |
32534 | <param name="regionId" type="int" default="0"/> | |
32535 | </paramlist> | |
32536 | </method> | |
32537 | <method name="GetNumberOfTextRegions" type="int" overloaded="no"> | |
781d2982 | 32538 | <autodoc>GetNumberOfTextRegions(self) -> int</autodoc> |
f32fc4bc RD |
32539 | </method> |
32540 | <method name="SetRegionName" type="" overloaded="no"> | |
781d2982 | 32541 | <autodoc>SetRegionName(self, String name, int regionId=0)</autodoc> |
f32fc4bc RD |
32542 | <paramlist> |
32543 | <param name="name" type="String" default=""/> | |
32544 | <param name="regionId" type="int" default="0"/> | |
32545 | </paramlist> | |
32546 | </method> | |
32547 | <method name="GetRegionName" type="String" overloaded="no"> | |
781d2982 | 32548 | <autodoc>GetRegionName(self, int regionId) -> String</autodoc> |
f32fc4bc RD |
32549 | <paramlist> |
32550 | <param name="regionId" type="int" default=""/> | |
32551 | </paramlist> | |
32552 | </method> | |
32553 | <method name="GetRegionId" type="int" overloaded="no"> | |
781d2982 | 32554 | <autodoc>GetRegionId(self, String name) -> int</autodoc> |
f32fc4bc RD |
32555 | <paramlist> |
32556 | <param name="name" type="String" default=""/> | |
32557 | </paramlist> | |
32558 | </method> | |
32559 | <method name="NameRegions" type="" overloaded="no"> | |
781d2982 | 32560 | <autodoc>NameRegions(self, String parentName=EmptyString)</autodoc> |
f32fc4bc RD |
32561 | <paramlist> |
32562 | <param name="parentName" type="String" default="wxPyEmptyString"/> | |
32563 | </paramlist> | |
32564 | </method> | |
32565 | <method name="GetRegions" type="PyObject" overloaded="no"> | |
781d2982 | 32566 | <autodoc>GetRegions(self) -> PyObject</autodoc> |
f32fc4bc RD |
32567 | </method> |
32568 | <method name="AddRegion" type="" overloaded="no"> | |
781d2982 | 32569 | <autodoc>AddRegion(self, ShapeRegion region)</autodoc> |
f32fc4bc RD |
32570 | <paramlist> |
32571 | <param name="region" type="ShapeRegion" default=""/> | |
32572 | </paramlist> | |
32573 | </method> | |
32574 | <method name="ClearRegions" type="" overloaded="no"> | |
781d2982 | 32575 | <autodoc>ClearRegions(self)</autodoc> |
f32fc4bc RD |
32576 | </method> |
32577 | <method name="AssignNewIds" type="" overloaded="no"> | |
781d2982 | 32578 | <autodoc>AssignNewIds(self)</autodoc> |
f32fc4bc RD |
32579 | </method> |
32580 | <method name="FindRegion" type="PyShape" overloaded="no"> | |
781d2982 | 32581 | <autodoc>FindRegion(self, String regionName, int OUTPUT) -> PyShape</autodoc> |
f32fc4bc RD |
32582 | <paramlist> |
32583 | <param name="regionName" type="String" default=""/> | |
32584 | <param name="OUTPUT" type="int" default=""/> | |
32585 | </paramlist> | |
32586 | </method> | |
32587 | <method name="FindRegionNames" type="" overloaded="no"> | |
781d2982 | 32588 | <autodoc>FindRegionNames(self, wxStringList list)</autodoc> |
f32fc4bc RD |
32589 | <paramlist> |
32590 | <param name="list" type="wxStringList" default=""/> | |
32591 | </paramlist> | |
32592 | </method> | |
32593 | <method name="ClearText" type="" overloaded="no"> | |
781d2982 | 32594 | <autodoc>ClearText(self, int regionId=0)</autodoc> |
f32fc4bc RD |
32595 | <paramlist> |
32596 | <param name="regionId" type="int" default="0"/> | |
32597 | </paramlist> | |
32598 | </method> | |
32599 | <method name="RemoveLine" type="" overloaded="no"> | |
781d2982 | 32600 | <autodoc>RemoveLine(self, PyLineShape line)</autodoc> |
f32fc4bc RD |
32601 | <paramlist> |
32602 | <param name="line" type="wxPyLineShape" default=""/> | |
32603 | </paramlist> | |
32604 | </method> | |
32605 | <method name="GetAttachmentPosition" type="bool" overloaded="no"> | |
781d2982 | 32606 | <autodoc>GetAttachmentPosition(self, int attachment, double OUTPUT, double OUTPUT, int nth=0, |
f32fc4bc RD |
32607 | int no_arcs=1, PyLineShape line=None) -> bool</autodoc> |
32608 | <paramlist> | |
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"/> | |
32615 | </paramlist> | |
32616 | </method> | |
32617 | <method name="GetNumberOfAttachments" type="int" overloaded="no"> | |
781d2982 | 32618 | <autodoc>GetNumberOfAttachments(self) -> int</autodoc> |
f32fc4bc RD |
32619 | </method> |
32620 | <method name="AttachmentIsValid" type="bool" overloaded="no"> | |
781d2982 | 32621 | <autodoc>AttachmentIsValid(self, int attachment) -> bool</autodoc> |
f32fc4bc RD |
32622 | <paramlist> |
32623 | <param name="attachment" type="int" default=""/> | |
32624 | </paramlist> | |
32625 | </method> | |
32626 | <method name="GetAttachments" type="PyObject" overloaded="no"> | |
781d2982 | 32627 | <autodoc>GetAttachments(self) -> PyObject</autodoc> |
f32fc4bc RD |
32628 | </method> |
32629 | <method name="GetAttachmentPositionEdge" type="bool" overloaded="no"> | |
781d2982 | 32630 | <autodoc>GetAttachmentPositionEdge(self, int attachment, double OUTPUT, double OUTPUT, int nth=0, |
f32fc4bc RD |
32631 | int no_arcs=1, PyLineShape line=None) -> bool</autodoc> |
32632 | <paramlist> | |
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"/> | |
32639 | </paramlist> | |
32640 | </method> | |
32641 | <method name="CalcSimpleAttachment" type="RealPoint" overloaded="no"> | |
781d2982 | 32642 | <autodoc>CalcSimpleAttachment(self, RealPoint pt1, RealPoint pt2, int nth, int noArcs, |
f32fc4bc RD |
32643 | PyLineShape line) -> RealPoint</autodoc> |
32644 | <paramlist> | |
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=""/> | |
32650 | </paramlist> | |
32651 | </method> | |
32652 | <method name="AttachmentSortTest" type="bool" overloaded="no"> | |
781d2982 | 32653 | <autodoc>AttachmentSortTest(self, int attachmentPoint, RealPoint pt1, RealPoint pt2) -> bool</autodoc> |
f32fc4bc RD |
32654 | <paramlist> |
32655 | <param name="attachmentPoint" type="int" default=""/> | |
32656 | <param name="pt1" type="RealPoint" default=""/> | |
32657 | <param name="pt2" type="RealPoint" default=""/> | |
32658 | </paramlist> | |
32659 | </method> | |
32660 | <method name="EraseLinks" type="" overloaded="no"> | |
781d2982 | 32661 | <autodoc>EraseLinks(self, DC dc, int attachment=-1, bool recurse=False)</autodoc> |
f32fc4bc RD |
32662 | <paramlist> |
32663 | <param name="dc" type="DC" default=""/> | |
32664 | <param name="attachment" type="int" default="-1"/> | |
32665 | <param name="recurse" type="bool" default="False"/> | |
32666 | </paramlist> | |
32667 | </method> | |
32668 | <method name="DrawLinks" type="" overloaded="no"> | |
781d2982 | 32669 | <autodoc>DrawLinks(self, DC dc, int attachment=-1, bool recurse=False)</autodoc> |
f32fc4bc RD |
32670 | <paramlist> |
32671 | <param name="dc" type="DC" default=""/> | |
32672 | <param name="attachment" type="int" default="-1"/> | |
32673 | <param name="recurse" type="bool" default="False"/> | |
32674 | </paramlist> | |
32675 | </method> | |
32676 | <method name="MoveLineToNewAttachment" type="bool" overloaded="no"> | |
781d2982 | 32677 | <autodoc>MoveLineToNewAttachment(self, DC dc, PyLineShape to_move, double x, double y) -> bool</autodoc> |
f32fc4bc RD |
32678 | <paramlist> |
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=""/> | |
32683 | </paramlist> | |
32684 | </method> | |
32685 | <method name="ApplyAttachmentOrdering" type="" overloaded="no"> | |
781d2982 | 32686 | <autodoc>ApplyAttachmentOrdering(self, PyObject linesToSort)</autodoc> |
f32fc4bc RD |
32687 | <paramlist> |
32688 | <param name="linesToSort" type="PyObject" default=""/> | |
32689 | </paramlist> | |
32690 | </method> | |
32691 | <method name="GetBranchingAttachmentRoot" type="RealPoint" overloaded="no"> | |
781d2982 | 32692 | <autodoc>GetBranchingAttachmentRoot(self, int attachment) -> RealPoint</autodoc> |
f32fc4bc RD |
32693 | <paramlist> |
32694 | <param name="attachment" type="int" default=""/> | |
32695 | </paramlist> | |
32696 | </method> | |
32697 | <method name="GetBranchingAttachmentInfo" type="bool" overloaded="no"> | |
781d2982 | 32698 | <autodoc>GetBranchingAttachmentInfo(self, int attachment, RealPoint root, RealPoint neck, RealPoint shoulder1, |
f32fc4bc RD |
32699 | RealPoint shoulder2) -> bool</autodoc> |
32700 | <paramlist> | |
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=""/> | |
32706 | </paramlist> | |
32707 | </method> | |
32708 | <method name="GetBranchingAttachmentPoint" type="bool" overloaded="no"> | |
781d2982 | 32709 | <autodoc>GetBranchingAttachmentPoint(self, int attachment, int n, RealPoint attachmentPoint, RealPoint stemPoint) -> bool</autodoc> |
f32fc4bc RD |
32710 | <paramlist> |
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=""/> | |
32715 | </paramlist> | |
32716 | </method> | |
32717 | <method name="GetAttachmentLineCount" type="int" overloaded="no"> | |
781d2982 | 32718 | <autodoc>GetAttachmentLineCount(self, int attachment) -> int</autodoc> |
f32fc4bc RD |
32719 | <paramlist> |
32720 | <param name="attachment" type="int" default=""/> | |
32721 | </paramlist> | |
32722 | </method> | |
32723 | <method name="SetBranchNeckLength" type="" overloaded="no"> | |
781d2982 | 32724 | <autodoc>SetBranchNeckLength(self, int len)</autodoc> |
f32fc4bc RD |
32725 | <paramlist> |
32726 | <param name="len" type="int" default=""/> | |
32727 | </paramlist> | |
32728 | </method> | |
32729 | <method name="GetBranchNeckLength" type="int" overloaded="no"> | |
781d2982 | 32730 | <autodoc>GetBranchNeckLength(self) -> int</autodoc> |
f32fc4bc RD |
32731 | </method> |
32732 | <method name="SetBranchStemLength" type="" overloaded="no"> | |
781d2982 | 32733 | <autodoc>SetBranchStemLength(self, int len)</autodoc> |
f32fc4bc RD |
32734 | <paramlist> |
32735 | <param name="len" type="int" default=""/> | |
32736 | </paramlist> | |
32737 | </method> | |
32738 | <method name="GetBranchStemLength" type="int" overloaded="no"> | |
781d2982 | 32739 | <autodoc>GetBranchStemLength(self) -> int</autodoc> |
f32fc4bc RD |
32740 | </method> |
32741 | <method name="SetBranchSpacing" type="" overloaded="no"> | |
781d2982 | 32742 | <autodoc>SetBranchSpacing(self, int len)</autodoc> |
f32fc4bc RD |
32743 | <paramlist> |
32744 | <param name="len" type="int" default=""/> | |
32745 | </paramlist> | |
32746 | </method> | |
32747 | <method name="GetBranchSpacing" type="int" overloaded="no"> | |
781d2982 | 32748 | <autodoc>GetBranchSpacing(self) -> int</autodoc> |
f32fc4bc RD |
32749 | </method> |
32750 | <method name="SetBranchStyle" type="" overloaded="no"> | |
781d2982 | 32751 | <autodoc>SetBranchStyle(self, long style)</autodoc> |
f32fc4bc RD |
32752 | <paramlist> |
32753 | <param name="style" type="long" default=""/> | |
32754 | </paramlist> | |
32755 | </method> | |
32756 | <method name="GetBranchStyle" type="long" overloaded="no"> | |
781d2982 | 32757 | <autodoc>GetBranchStyle(self) -> long</autodoc> |
f32fc4bc RD |
32758 | </method> |
32759 | <method name="PhysicalToLogicalAttachment" type="int" overloaded="no"> | |
781d2982 | 32760 | <autodoc>PhysicalToLogicalAttachment(self, int physicalAttachment) -> int</autodoc> |
f32fc4bc RD |
32761 | <paramlist> |
32762 | <param name="physicalAttachment" type="int" default=""/> | |
32763 | </paramlist> | |
32764 | </method> | |
32765 | <method name="LogicalToPhysicalAttachment" type="int" overloaded="no"> | |
781d2982 | 32766 | <autodoc>LogicalToPhysicalAttachment(self, int logicalAttachment) -> int</autodoc> |
f32fc4bc RD |
32767 | <paramlist> |
32768 | <param name="logicalAttachment" type="int" default=""/> | |
32769 | </paramlist> | |
32770 | </method> | |
32771 | <method name="Draggable" type="bool" overloaded="no"> | |
781d2982 | 32772 | <autodoc>Draggable(self) -> bool</autodoc> |
f32fc4bc RD |
32773 | </method> |
32774 | <method name="HasDescendant" type="bool" overloaded="no"> | |
781d2982 | 32775 | <autodoc>HasDescendant(self, PyShape image) -> bool</autodoc> |
f32fc4bc RD |
32776 | <paramlist> |
32777 | <param name="image" type="PyShape" default=""/> | |
32778 | </paramlist> | |
32779 | </method> | |
32780 | <method name="CreateNewCopy" type="PyShape" overloaded="no"> | |
781d2982 | 32781 | <autodoc>CreateNewCopy(self, bool resetMapping=True, bool recompute=True) -> PyShape</autodoc> |
f32fc4bc RD |
32782 | <paramlist> |
32783 | <param name="resetMapping" type="bool" default="True"/> | |
32784 | <param name="recompute" type="bool" default="True"/> | |
32785 | </paramlist> | |
32786 | </method> | |
32787 | <method name="Copy" type="" overloaded="no"> | |
781d2982 | 32788 | <autodoc>Copy(self, PyShape copy)</autodoc> |
f32fc4bc RD |
32789 | <paramlist> |
32790 | <param name="copy" type="PyShape" default=""/> | |
32791 | </paramlist> | |
32792 | </method> | |
32793 | <method name="CopyWithHandler" type="" overloaded="no"> | |
781d2982 | 32794 | <autodoc>CopyWithHandler(self, PyShape copy)</autodoc> |
f32fc4bc RD |
32795 | <paramlist> |
32796 | <param name="copy" type="PyShape" default=""/> | |
32797 | </paramlist> | |
32798 | </method> | |
32799 | <method name="Rotate" type="" overloaded="no"> | |
781d2982 | 32800 | <autodoc>Rotate(self, double x, double y, double theta)</autodoc> |
f32fc4bc RD |
32801 | <paramlist> |
32802 | <param name="x" type="double" default=""/> | |
32803 | <param name="y" type="double" default=""/> | |
32804 | <param name="theta" type="double" default=""/> | |
32805 | </paramlist> | |
32806 | </method> | |
32807 | <method name="GetRotation" type="double" overloaded="no"> | |
781d2982 | 32808 | <autodoc>GetRotation(self) -> double</autodoc> |
f32fc4bc RD |
32809 | </method> |
32810 | <method name="SetRotation" type="" overloaded="no"> | |
781d2982 | 32811 | <autodoc>SetRotation(self, double rotation)</autodoc> |
f32fc4bc RD |
32812 | <paramlist> |
32813 | <param name="rotation" type="double" default=""/> | |
32814 | </paramlist> | |
32815 | </method> | |
32816 | <method name="ClearAttachments" type="" overloaded="no"> | |
781d2982 | 32817 | <autodoc>ClearAttachments(self)</autodoc> |
f32fc4bc RD |
32818 | </method> |
32819 | <method name="Recentre" type="" overloaded="no"> | |
781d2982 | 32820 | <autodoc>Recentre(self, DC dc)</autodoc> |
f32fc4bc RD |
32821 | <paramlist> |
32822 | <param name="dc" type="DC" default=""/> | |
32823 | </paramlist> | |
32824 | </method> | |
32825 | <method name="ClearPointList" type="" overloaded="no"> | |
781d2982 | 32826 | <autodoc>ClearPointList(self, wxList list)</autodoc> |
f32fc4bc RD |
32827 | <paramlist> |
32828 | <param name="list" type="wxList" default=""/> | |
32829 | </paramlist> | |
32830 | </method> | |
32831 | <method name="GetBackgroundPen" type="Pen" overloaded="no"> | |
781d2982 | 32832 | <autodoc>GetBackgroundPen(self) -> wxPen</autodoc> |
f32fc4bc RD |
32833 | </method> |
32834 | <method name="GetBackgroundBrush" type="Brush" overloaded="no"> | |
781d2982 | 32835 | <autodoc>GetBackgroundBrush(self) -> wxBrush</autodoc> |
f32fc4bc RD |
32836 | </method> |
32837 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 32838 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
32839 | </method> |
32840 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 32841 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
32842 | <paramlist> |
32843 | <param name="dc" type="DC" default=""/> | |
32844 | </paramlist> | |
32845 | </method> | |
32846 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 32847 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
32848 | <paramlist> |
32849 | <param name="dc" type="DC" default=""/> | |
32850 | </paramlist> | |
32851 | </method> | |
32852 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 32853 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=False)</autodoc> |
f32fc4bc RD |
32854 | <paramlist> |
32855 | <param name="dc" type="DC" default=""/> | |
32856 | <param name="erase" type="bool" default="False"/> | |
32857 | </paramlist> | |
32858 | </method> | |
32859 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 32860 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
32861 | <paramlist> |
32862 | <param name="dc" type="DC" default=""/> | |
32863 | </paramlist> | |
32864 | </method> | |
32865 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 32866 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
32867 | <paramlist> |
32868 | <param name="dc" type="DC" default=""/> | |
32869 | </paramlist> | |
32870 | </method> | |
32871 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 32872 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
32873 | <paramlist> |
32874 | <param name="dc" type="DC" default=""/> | |
32875 | </paramlist> | |
32876 | </method> | |
32877 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 32878 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
32879 | <paramlist> |
32880 | <param name="dc" type="DC" default=""/> | |
32881 | </paramlist> | |
32882 | </method> | |
32883 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 32884 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32885 | <paramlist> |
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"/> | |
32890 | </paramlist> | |
32891 | </method> | |
32892 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 32893 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32894 | <paramlist> |
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"/> | |
32899 | </paramlist> | |
32900 | </method> | |
32901 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 32902 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32903 | <paramlist> |
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"/> | |
32908 | </paramlist> | |
32909 | </method> | |
32910 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 32911 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
32912 | <paramlist> |
32913 | <param name="x" type="double" default=""/> | |
32914 | <param name="y" type="double" default=""/> | |
32915 | </paramlist> | |
32916 | </method> | |
32917 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 32918 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
32919 | bool display=True) -> bool</autodoc> |
32920 | <paramlist> | |
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"/> | |
32927 | </paramlist> | |
32928 | </method> | |
32929 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 32930 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
32931 | bool display=True)</autodoc> |
32932 | <paramlist> | |
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"/> | |
32939 | </paramlist> | |
32940 | </method> | |
32941 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 32942 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32943 | <paramlist> |
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"/> | |
32949 | </paramlist> | |
32950 | </method> | |
32951 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 32952 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32953 | <paramlist> |
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"/> | |
32958 | </paramlist> | |
32959 | </method> | |
32960 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 32961 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32962 | <paramlist> |
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"/> | |
32967 | </paramlist> | |
32968 | </method> | |
32969 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 32970 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32971 | <paramlist> |
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"/> | |
32977 | </paramlist> | |
32978 | </method> | |
32979 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 32980 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32981 | <paramlist> |
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"/> | |
32986 | </paramlist> | |
32987 | </method> | |
32988 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 32989 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
32990 | <paramlist> |
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"/> | |
32995 | </paramlist> | |
32996 | </method> | |
32997 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 32998 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
32999 | <paramlist> |
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=""/> | |
33005 | </paramlist> | |
33006 | </method> | |
33007 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 33008 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
33009 | <paramlist> |
33010 | <param name="dc" type="DC" default=""/> | |
33011 | </paramlist> | |
33012 | </method> | |
33013 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 33014 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
33015 | <paramlist> |
33016 | <param name="dc" type="DC" default=""/> | |
33017 | </paramlist> | |
33018 | </method> | |
33019 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 33020 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
33021 | <paramlist> |
33022 | <param name="dc" type="DC" default=""/> | |
33023 | <param name="moveControlPoints" type="bool" default="True"/> | |
33024 | </paramlist> | |
33025 | </method> | |
33026 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 33027 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
33028 | int attachment=0)</autodoc> |
33029 | <paramlist> | |
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"/> | |
33036 | </paramlist> | |
33037 | </method> | |
33038 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 33039 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
33040 | int attachment=0)</autodoc> |
33041 | <paramlist> | |
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"/> | |
33047 | </paramlist> | |
33048 | </method> | |
33049 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 33050 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
33051 | int attachment=0)</autodoc> |
33052 | <paramlist> | |
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"/> | |
33058 | </paramlist> | |
33059 | </method> | |
33060 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 33061 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
33062 | <paramlist> |
33063 | <param name="w" type="double" default=""/> | |
33064 | <param name="h" type="double" default=""/> | |
33065 | </paramlist> | |
33066 | </method> | |
33067 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 33068 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
33069 | <paramlist> |
33070 | <param name="w" type="double" default=""/> | |
33071 | <param name="h" type="double" default=""/> | |
33072 | </paramlist> | |
33073 | </method> | |
33074 | </class> | |
33075 | <class name="PseudoMetaFile" oldname="wxPseudoMetaFile" module="ogl"> | |
33076 | <baseclass name="Object"/> | |
33077 | <constructor name="PseudoMetaFile" overloaded="no"> | |
781d2982 | 33078 | <autodoc>__init__(self) -> PseudoMetaFile</autodoc> |
f32fc4bc RD |
33079 | </constructor> |
33080 | <destructor name="~wxPseudoMetaFile" overloaded="no"> | |
781d2982 | 33081 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
33082 | </destructor> |
33083 | <method name="Draw" type="" overloaded="no"> | |
781d2982 | 33084 | <autodoc>Draw(self, DC dc, double xoffset, double yoffset)</autodoc> |
f32fc4bc RD |
33085 | <paramlist> |
33086 | <param name="dc" type="DC" default=""/> | |
33087 | <param name="xoffset" type="double" default=""/> | |
33088 | <param name="yoffset" type="double" default=""/> | |
33089 | </paramlist> | |
33090 | </method> | |
33091 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 33092 | <autodoc>Clear(self)</autodoc> |
f32fc4bc RD |
33093 | </method> |
33094 | <method name="Copy" type="" overloaded="no"> | |
781d2982 | 33095 | <autodoc>Copy(self, PseudoMetaFile copy)</autodoc> |
f32fc4bc RD |
33096 | <paramlist> |
33097 | <param name="copy" type="PseudoMetaFile" default=""/> | |
33098 | </paramlist> | |
33099 | </method> | |
33100 | <method name="Scale" type="" overloaded="no"> | |
781d2982 | 33101 | <autodoc>Scale(self, double sx, double sy)</autodoc> |
f32fc4bc RD |
33102 | <paramlist> |
33103 | <param name="sx" type="double" default=""/> | |
33104 | <param name="sy" type="double" default=""/> | |
33105 | </paramlist> | |
33106 | </method> | |
33107 | <method name="ScaleTo" type="" overloaded="no"> | |
781d2982 | 33108 | <autodoc>ScaleTo(self, double w, double h)</autodoc> |
f32fc4bc RD |
33109 | <paramlist> |
33110 | <param name="w" type="double" default=""/> | |
33111 | <param name="h" type="double" default=""/> | |
33112 | </paramlist> | |
33113 | </method> | |
33114 | <method name="Translate" type="" overloaded="no"> | |
781d2982 | 33115 | <autodoc>Translate(self, double x, double y)</autodoc> |
f32fc4bc RD |
33116 | <paramlist> |
33117 | <param name="x" type="double" default=""/> | |
33118 | <param name="y" type="double" default=""/> | |
33119 | </paramlist> | |
33120 | </method> | |
33121 | <method name="Rotate" type="" overloaded="no"> | |
781d2982 | 33122 | <autodoc>Rotate(self, double x, double y, double theta)</autodoc> |
f32fc4bc RD |
33123 | <paramlist> |
33124 | <param name="x" type="double" default=""/> | |
33125 | <param name="y" type="double" default=""/> | |
33126 | <param name="theta" type="double" default=""/> | |
33127 | </paramlist> | |
33128 | </method> | |
33129 | <method name="LoadFromMetaFile" type="bool" overloaded="no"> | |
781d2982 | 33130 | <autodoc>LoadFromMetaFile(self, String filename, double width, double height) -> bool</autodoc> |
f32fc4bc RD |
33131 | <paramlist> |
33132 | <param name="filename" type="String" default=""/> | |
33133 | <param name="width" type="double" default=""/> | |
33134 | <param name="height" type="double" default=""/> | |
33135 | </paramlist> | |
33136 | </method> | |
33137 | <method name="GetBounds" type="" overloaded="no"> | |
781d2982 | 33138 | <autodoc>GetBounds(self, double minX, double minY, double maxX, double maxY)</autodoc> |
f32fc4bc RD |
33139 | <paramlist> |
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=""/> | |
33144 | </paramlist> | |
33145 | </method> | |
33146 | <method name="CalculateSize" type="" overloaded="no"> | |
781d2982 | 33147 | <autodoc>CalculateSize(self, PyDrawnShape shape)</autodoc> |
f32fc4bc RD |
33148 | <paramlist> |
33149 | <param name="shape" type="wxPyDrawnShape" default=""/> | |
33150 | </paramlist> | |
33151 | </method> | |
33152 | <method name="SetRotateable" type="" overloaded="no"> | |
781d2982 | 33153 | <autodoc>SetRotateable(self, bool rot)</autodoc> |
f32fc4bc RD |
33154 | <paramlist> |
33155 | <param name="rot" type="bool" default=""/> | |
33156 | </paramlist> | |
33157 | </method> | |
33158 | <method name="GetRotateable" type="bool" overloaded="no"> | |
781d2982 | 33159 | <autodoc>GetRotateable(self) -> bool</autodoc> |
f32fc4bc RD |
33160 | </method> |
33161 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 33162 | <autodoc>SetSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
33163 | <paramlist> |
33164 | <param name="w" type="double" default=""/> | |
33165 | <param name="h" type="double" default=""/> | |
33166 | </paramlist> | |
33167 | </method> | |
33168 | <method name="SetFillBrush" type="" overloaded="no"> | |
781d2982 | 33169 | <autodoc>SetFillBrush(self, wxBrush brush)</autodoc> |
f32fc4bc RD |
33170 | <paramlist> |
33171 | <param name="brush" type="Brush" default=""/> | |
33172 | </paramlist> | |
33173 | </method> | |
33174 | <method name="GetFillBrush" type="Brush" overloaded="no"> | |
781d2982 | 33175 | <autodoc>GetFillBrush(self) -> wxBrush</autodoc> |
f32fc4bc RD |
33176 | </method> |
33177 | <method name="SetOutlinePen" type="" overloaded="no"> | |
781d2982 | 33178 | <autodoc>SetOutlinePen(self, wxPen pen)</autodoc> |
f32fc4bc RD |
33179 | <paramlist> |
33180 | <param name="pen" type="Pen" default=""/> | |
33181 | </paramlist> | |
33182 | </method> | |
33183 | <method name="GetOutlinePen" type="Pen" overloaded="no"> | |
781d2982 | 33184 | <autodoc>GetOutlinePen(self) -> wxPen</autodoc> |
f32fc4bc RD |
33185 | </method> |
33186 | <method name="SetOutlineOp" type="" overloaded="no"> | |
781d2982 | 33187 | <autodoc>SetOutlineOp(self, int op)</autodoc> |
f32fc4bc RD |
33188 | <paramlist> |
33189 | <param name="op" type="int" default=""/> | |
33190 | </paramlist> | |
33191 | </method> | |
33192 | <method name="GetOutlineOp" type="int" overloaded="no"> | |
781d2982 | 33193 | <autodoc>GetOutlineOp(self) -> int</autodoc> |
f32fc4bc RD |
33194 | </method> |
33195 | <method name="IsValid" type="bool" overloaded="no"> | |
781d2982 | 33196 | <autodoc>IsValid(self) -> bool</autodoc> |
f32fc4bc RD |
33197 | </method> |
33198 | <method name="DrawLine" type="" overloaded="no"> | |
781d2982 | 33199 | <autodoc>DrawLine(self, Point pt1, Point pt2)</autodoc> |
f32fc4bc RD |
33200 | <paramlist> |
33201 | <param name="pt1" type="Point" default=""/> | |
33202 | <param name="pt2" type="Point" default=""/> | |
33203 | </paramlist> | |
33204 | </method> | |
33205 | <method name="DrawRectangle" type="" overloaded="no"> | |
781d2982 | 33206 | <autodoc>DrawRectangle(self, Rect rect)</autodoc> |
f32fc4bc RD |
33207 | <paramlist> |
33208 | <param name="rect" type="Rect" default=""/> | |
33209 | </paramlist> | |
33210 | </method> | |
33211 | <method name="DrawRoundedRectangle" type="" overloaded="no"> | |
781d2982 | 33212 | <autodoc>DrawRoundedRectangle(self, Rect rect, double radius)</autodoc> |
f32fc4bc RD |
33213 | <paramlist> |
33214 | <param name="rect" type="Rect" default=""/> | |
33215 | <param name="radius" type="double" default=""/> | |
33216 | </paramlist> | |
33217 | </method> | |
33218 | <method name="DrawArc" type="" overloaded="no"> | |
781d2982 | 33219 | <autodoc>DrawArc(self, Point centrePt, Point startPt, Point endPt)</autodoc> |
f32fc4bc RD |
33220 | <paramlist> |
33221 | <param name="centrePt" type="Point" default=""/> | |
33222 | <param name="startPt" type="Point" default=""/> | |
33223 | <param name="endPt" type="Point" default=""/> | |
33224 | </paramlist> | |
33225 | </method> | |
33226 | <method name="DrawEllipticArc" type="" overloaded="no"> | |
781d2982 | 33227 | <autodoc>DrawEllipticArc(self, Rect rect, double startAngle, double endAngle)</autodoc> |
f32fc4bc RD |
33228 | <paramlist> |
33229 | <param name="rect" type="Rect" default=""/> | |
33230 | <param name="startAngle" type="double" default=""/> | |
33231 | <param name="endAngle" type="double" default=""/> | |
33232 | </paramlist> | |
33233 | </method> | |
33234 | <method name="DrawEllipse" type="" overloaded="no"> | |
781d2982 | 33235 | <autodoc>DrawEllipse(self, Rect rect)</autodoc> |
f32fc4bc RD |
33236 | <paramlist> |
33237 | <param name="rect" type="Rect" default=""/> | |
33238 | </paramlist> | |
33239 | </method> | |
33240 | <method name="DrawPoint" type="" overloaded="no"> | |
781d2982 | 33241 | <autodoc>DrawPoint(self, Point pt)</autodoc> |
f32fc4bc RD |
33242 | <paramlist> |
33243 | <param name="pt" type="Point" default=""/> | |
33244 | </paramlist> | |
33245 | </method> | |
33246 | <method name="DrawText" type="" overloaded="no"> | |
781d2982 | 33247 | <autodoc>DrawText(self, String text, Point pt)</autodoc> |
f32fc4bc RD |
33248 | <paramlist> |
33249 | <param name="text" type="String" default=""/> | |
33250 | <param name="pt" type="Point" default=""/> | |
33251 | </paramlist> | |
33252 | </method> | |
33253 | <method name="DrawLines" type="" overloaded="no"> | |
781d2982 | 33254 | <autodoc>DrawLines(self, int points, Point points_array)</autodoc> |
f32fc4bc | 33255 | <paramlist> |
781d2982 RD |
33256 | <param name="points" type="int" default=""/> |
33257 | <param name="points_array" type="Point" default=""/> | |
f32fc4bc RD |
33258 | </paramlist> |
33259 | </method> | |
33260 | <method name="DrawPolygon" type="" overloaded="no"> | |
781d2982 | 33261 | <autodoc>DrawPolygon(self, int points, Point points_array, int flags=0)</autodoc> |
f32fc4bc | 33262 | <paramlist> |
781d2982 RD |
33263 | <param name="points" type="int" default=""/> |
33264 | <param name="points_array" type="Point" default=""/> | |
f32fc4bc RD |
33265 | <param name="flags" type="int" default="0"/> |
33266 | </paramlist> | |
33267 | </method> | |
33268 | <method name="DrawSpline" type="" overloaded="no"> | |
781d2982 | 33269 | <autodoc>DrawSpline(self, int points, Point points_array)</autodoc> |
f32fc4bc | 33270 | <paramlist> |
781d2982 RD |
33271 | <param name="points" type="int" default=""/> |
33272 | <param name="points_array" type="Point" default=""/> | |
f32fc4bc RD |
33273 | </paramlist> |
33274 | </method> | |
33275 | <method name="SetClippingRect" type="" overloaded="no"> | |
781d2982 | 33276 | <autodoc>SetClippingRect(self, Rect rect)</autodoc> |
f32fc4bc RD |
33277 | <paramlist> |
33278 | <param name="rect" type="Rect" default=""/> | |
33279 | </paramlist> | |
33280 | </method> | |
33281 | <method name="DestroyClippingRect" type="" overloaded="no"> | |
781d2982 | 33282 | <autodoc>DestroyClippingRect(self)</autodoc> |
f32fc4bc RD |
33283 | </method> |
33284 | <method name="SetPen" type="" overloaded="no"> | |
781d2982 | 33285 | <autodoc>SetPen(self, wxPen pen, bool isOutline=FALSE)</autodoc> |
f32fc4bc RD |
33286 | <paramlist> |
33287 | <param name="pen" type="Pen" default=""/> | |
33288 | <param name="isOutline" type="bool" default="FALSE"/> | |
33289 | </paramlist> | |
33290 | </method> | |
33291 | <method name="SetBrush" type="" overloaded="no"> | |
781d2982 | 33292 | <autodoc>SetBrush(self, wxBrush brush, bool isFill=FALSE)</autodoc> |
f32fc4bc RD |
33293 | <paramlist> |
33294 | <param name="brush" type="Brush" default=""/> | |
33295 | <param name="isFill" type="bool" default="FALSE"/> | |
33296 | </paramlist> | |
33297 | </method> | |
33298 | <method name="SetFont" type="" overloaded="no"> | |
781d2982 | 33299 | <autodoc>SetFont(self, Font font)</autodoc> |
f32fc4bc RD |
33300 | <paramlist> |
33301 | <param name="font" type="Font" default=""/> | |
33302 | </paramlist> | |
33303 | </method> | |
33304 | <method name="SetTextColour" type="" overloaded="no"> | |
781d2982 | 33305 | <autodoc>SetTextColour(self, Colour colour)</autodoc> |
f32fc4bc RD |
33306 | <paramlist> |
33307 | <param name="colour" type="Colour" default=""/> | |
33308 | </paramlist> | |
33309 | </method> | |
33310 | <method name="SetBackgroundColour" type="" overloaded="no"> | |
781d2982 | 33311 | <autodoc>SetBackgroundColour(self, Colour colour)</autodoc> |
f32fc4bc RD |
33312 | <paramlist> |
33313 | <param name="colour" type="Colour" default=""/> | |
33314 | </paramlist> | |
33315 | </method> | |
33316 | <method name="SetBackgroundMode" type="" overloaded="no"> | |
781d2982 | 33317 | <autodoc>SetBackgroundMode(self, int mode)</autodoc> |
f32fc4bc RD |
33318 | <paramlist> |
33319 | <param name="mode" type="int" default=""/> | |
33320 | </paramlist> | |
33321 | </method> | |
33322 | </class> | |
33323 | <class name="PyRectangleShape" oldname="wxPyRectangleShape" module="ogl"> | |
33324 | <baseclass name="PyShape"/> | |
33325 | <constructor name="PyRectangleShape" overloaded="no"> | |
781d2982 | 33326 | <autodoc>__init__(self, double width=0.0, double height=0.0) -> PyRectangleShape</autodoc> |
f32fc4bc RD |
33327 | <paramlist> |
33328 | <param name="width" type="double" default="0.0"/> | |
33329 | <param name="height" type="double" default="0.0"/> | |
33330 | </paramlist> | |
33331 | </constructor> | |
33332 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 33333 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
33334 | <paramlist> |
33335 | <param name="self" type="PyObject" default=""/> | |
33336 | <param name="_class" type="PyObject" default=""/> | |
33337 | </paramlist> | |
33338 | </method> | |
33339 | <method name="SetCornerRadius" type="" overloaded="no"> | |
781d2982 | 33340 | <autodoc>SetCornerRadius(self, double radius)</autodoc> |
f32fc4bc RD |
33341 | <paramlist> |
33342 | <param name="radius" type="double" default=""/> | |
33343 | </paramlist> | |
33344 | </method> | |
33345 | <method name="GetCornerRadius" type="double" overloaded="no"> | |
781d2982 | 33346 | <autodoc>GetCornerRadius(self) -> double</autodoc> |
f32fc4bc RD |
33347 | </method> |
33348 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 33349 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
33350 | </method> |
33351 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 33352 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
33353 | <paramlist> |
33354 | <param name="dc" type="DC" default=""/> | |
33355 | </paramlist> | |
33356 | </method> | |
33357 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 33358 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
33359 | <paramlist> |
33360 | <param name="dc" type="DC" default=""/> | |
33361 | </paramlist> | |
33362 | </method> | |
33363 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 33364 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
33365 | <paramlist> |
33366 | <param name="dc" type="DC" default=""/> | |
33367 | <param name="erase" type="bool" default="FALSE"/> | |
33368 | </paramlist> | |
33369 | </method> | |
33370 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 33371 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
33372 | <paramlist> |
33373 | <param name="dc" type="DC" default=""/> | |
33374 | </paramlist> | |
33375 | </method> | |
33376 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 33377 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
33378 | <paramlist> |
33379 | <param name="dc" type="DC" default=""/> | |
33380 | </paramlist> | |
33381 | </method> | |
33382 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 33383 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
33384 | <paramlist> |
33385 | <param name="dc" type="DC" default=""/> | |
33386 | </paramlist> | |
33387 | </method> | |
33388 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 33389 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
33390 | <paramlist> |
33391 | <param name="dc" type="DC" default=""/> | |
33392 | </paramlist> | |
33393 | </method> | |
33394 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 33395 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33396 | <paramlist> |
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"/> | |
33401 | </paramlist> | |
33402 | </method> | |
33403 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 33404 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33405 | <paramlist> |
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"/> | |
33410 | </paramlist> | |
33411 | </method> | |
33412 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 33413 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33414 | <paramlist> |
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"/> | |
33419 | </paramlist> | |
33420 | </method> | |
33421 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 33422 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
33423 | <paramlist> |
33424 | <param name="x" type="double" default=""/> | |
33425 | <param name="y" type="double" default=""/> | |
33426 | </paramlist> | |
33427 | </method> | |
33428 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 33429 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
33430 | bool display=True) -> bool</autodoc> |
33431 | <paramlist> | |
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"/> | |
33438 | </paramlist> | |
33439 | </method> | |
33440 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 33441 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
33442 | bool display=True)</autodoc> |
33443 | <paramlist> | |
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"/> | |
33450 | </paramlist> | |
33451 | </method> | |
33452 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 33453 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33454 | <paramlist> |
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"/> | |
33460 | </paramlist> | |
33461 | </method> | |
33462 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 33463 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33464 | <paramlist> |
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"/> | |
33469 | </paramlist> | |
33470 | </method> | |
33471 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 33472 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33473 | <paramlist> |
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"/> | |
33478 | </paramlist> | |
33479 | </method> | |
33480 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 33481 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33482 | <paramlist> |
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"/> | |
33488 | </paramlist> | |
33489 | </method> | |
33490 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 33491 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33492 | <paramlist> |
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"/> | |
33497 | </paramlist> | |
33498 | </method> | |
33499 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 33500 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33501 | <paramlist> |
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"/> | |
33506 | </paramlist> | |
33507 | </method> | |
33508 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 33509 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
33510 | <paramlist> |
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=""/> | |
33516 | </paramlist> | |
33517 | </method> | |
33518 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 33519 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
33520 | <paramlist> |
33521 | <param name="dc" type="DC" default=""/> | |
33522 | </paramlist> | |
33523 | </method> | |
33524 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 33525 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
33526 | <paramlist> |
33527 | <param name="dc" type="DC" default=""/> | |
33528 | </paramlist> | |
33529 | </method> | |
33530 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 33531 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
33532 | <paramlist> |
33533 | <param name="dc" type="DC" default=""/> | |
33534 | <param name="moveControlPoints" type="bool" default="True"/> | |
33535 | </paramlist> | |
33536 | </method> | |
33537 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 33538 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
33539 | int attachment=0)</autodoc> |
33540 | <paramlist> | |
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"/> | |
33547 | </paramlist> | |
33548 | </method> | |
33549 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 33550 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
33551 | int attachment=0)</autodoc> |
33552 | <paramlist> | |
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"/> | |
33558 | </paramlist> | |
33559 | </method> | |
33560 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 33561 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
33562 | int attachment=0)</autodoc> |
33563 | <paramlist> | |
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"/> | |
33569 | </paramlist> | |
33570 | </method> | |
33571 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 33572 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
33573 | <paramlist> |
33574 | <param name="w" type="double" default=""/> | |
33575 | <param name="h" type="double" default=""/> | |
33576 | </paramlist> | |
33577 | </method> | |
33578 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 33579 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
33580 | <paramlist> |
33581 | <param name="w" type="double" default=""/> | |
33582 | <param name="h" type="double" default=""/> | |
33583 | </paramlist> | |
33584 | </method> | |
33585 | </class> | |
33586 | <class name="PyControlPoint" oldname="wxPyControlPoint" module="ogl"> | |
33587 | <baseclass name="PyRectangleShape"/> | |
33588 | <constructor name="PyControlPoint" overloaded="no"> | |
781d2982 | 33589 | <autodoc>__init__(self, PyShapeCanvas the_canvas=None, PyShape object=None, |
f32fc4bc RD |
33590 | double size=0.0, double the_xoffset=0.0, double the_yoffset=0.0, |
33591 | int the_type=0) -> PyControlPoint</autodoc> | |
33592 | <paramlist> | |
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"/> | |
33599 | </paramlist> | |
33600 | </constructor> | |
33601 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 33602 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
33603 | <paramlist> |
33604 | <param name="self" type="PyObject" default=""/> | |
33605 | <param name="_class" type="PyObject" default=""/> | |
33606 | </paramlist> | |
33607 | </method> | |
33608 | <method name="SetCornerRadius" type="" overloaded="no"> | |
781d2982 | 33609 | <autodoc>SetCornerRadius(self, double radius)</autodoc> |
f32fc4bc RD |
33610 | <paramlist> |
33611 | <param name="radius" type="double" default=""/> | |
33612 | </paramlist> | |
33613 | </method> | |
33614 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 33615 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
33616 | </method> |
33617 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 33618 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
33619 | <paramlist> |
33620 | <param name="dc" type="DC" default=""/> | |
33621 | </paramlist> | |
33622 | </method> | |
33623 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 33624 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
33625 | <paramlist> |
33626 | <param name="dc" type="DC" default=""/> | |
33627 | </paramlist> | |
33628 | </method> | |
33629 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 33630 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
33631 | <paramlist> |
33632 | <param name="dc" type="DC" default=""/> | |
33633 | <param name="erase" type="bool" default="FALSE"/> | |
33634 | </paramlist> | |
33635 | </method> | |
33636 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 33637 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
33638 | <paramlist> |
33639 | <param name="dc" type="DC" default=""/> | |
33640 | </paramlist> | |
33641 | </method> | |
33642 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 33643 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
33644 | <paramlist> |
33645 | <param name="dc" type="DC" default=""/> | |
33646 | </paramlist> | |
33647 | </method> | |
33648 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 33649 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
33650 | <paramlist> |
33651 | <param name="dc" type="DC" default=""/> | |
33652 | </paramlist> | |
33653 | </method> | |
33654 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 33655 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
33656 | <paramlist> |
33657 | <param name="dc" type="DC" default=""/> | |
33658 | </paramlist> | |
33659 | </method> | |
33660 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 33661 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33662 | <paramlist> |
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"/> | |
33667 | </paramlist> | |
33668 | </method> | |
33669 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 33670 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33671 | <paramlist> |
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"/> | |
33676 | </paramlist> | |
33677 | </method> | |
33678 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 33679 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33680 | <paramlist> |
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"/> | |
33685 | </paramlist> | |
33686 | </method> | |
33687 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 33688 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
33689 | <paramlist> |
33690 | <param name="x" type="double" default=""/> | |
33691 | <param name="y" type="double" default=""/> | |
33692 | </paramlist> | |
33693 | </method> | |
33694 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 33695 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
33696 | bool display=True) -> bool</autodoc> |
33697 | <paramlist> | |
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"/> | |
33704 | </paramlist> | |
33705 | </method> | |
33706 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 33707 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
33708 | bool display=True)</autodoc> |
33709 | <paramlist> | |
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"/> | |
33716 | </paramlist> | |
33717 | </method> | |
33718 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 33719 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33720 | <paramlist> |
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"/> | |
33726 | </paramlist> | |
33727 | </method> | |
33728 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 33729 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33730 | <paramlist> |
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"/> | |
33735 | </paramlist> | |
33736 | </method> | |
33737 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 33738 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33739 | <paramlist> |
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"/> | |
33744 | </paramlist> | |
33745 | </method> | |
33746 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 33747 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33748 | <paramlist> |
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"/> | |
33754 | </paramlist> | |
33755 | </method> | |
33756 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 33757 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33758 | <paramlist> |
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"/> | |
33763 | </paramlist> | |
33764 | </method> | |
33765 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 33766 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33767 | <paramlist> |
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"/> | |
33772 | </paramlist> | |
33773 | </method> | |
33774 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 33775 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
33776 | <paramlist> |
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=""/> | |
33782 | </paramlist> | |
33783 | </method> | |
33784 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 33785 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
33786 | <paramlist> |
33787 | <param name="dc" type="DC" default=""/> | |
33788 | </paramlist> | |
33789 | </method> | |
33790 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 33791 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
33792 | <paramlist> |
33793 | <param name="dc" type="DC" default=""/> | |
33794 | </paramlist> | |
33795 | </method> | |
33796 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 33797 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
33798 | <paramlist> |
33799 | <param name="dc" type="DC" default=""/> | |
33800 | <param name="moveControlPoints" type="bool" default="True"/> | |
33801 | </paramlist> | |
33802 | </method> | |
33803 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 33804 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
33805 | int attachment=0)</autodoc> |
33806 | <paramlist> | |
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"/> | |
33813 | </paramlist> | |
33814 | </method> | |
33815 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 33816 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
33817 | int attachment=0)</autodoc> |
33818 | <paramlist> | |
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"/> | |
33824 | </paramlist> | |
33825 | </method> | |
33826 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 33827 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
33828 | int attachment=0)</autodoc> |
33829 | <paramlist> | |
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"/> | |
33835 | </paramlist> | |
33836 | </method> | |
33837 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 33838 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
33839 | <paramlist> |
33840 | <param name="w" type="double" default=""/> | |
33841 | <param name="h" type="double" default=""/> | |
33842 | </paramlist> | |
33843 | </method> | |
33844 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 33845 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
33846 | <paramlist> |
33847 | <param name="w" type="double" default=""/> | |
33848 | <param name="h" type="double" default=""/> | |
33849 | </paramlist> | |
33850 | </method> | |
33851 | </class> | |
33852 | <class name="PyBitmapShape" oldname="wxPyBitmapShape" module="ogl"> | |
33853 | <baseclass name="PyRectangleShape"/> | |
33854 | <constructor name="PyBitmapShape" overloaded="no"> | |
781d2982 | 33855 | <autodoc>__init__(self) -> PyBitmapShape</autodoc> |
f32fc4bc RD |
33856 | </constructor> |
33857 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 33858 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
33859 | <paramlist> |
33860 | <param name="self" type="PyObject" default=""/> | |
33861 | <param name="_class" type="PyObject" default=""/> | |
33862 | </paramlist> | |
33863 | </method> | |
33864 | <method name="GetBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 33865 | <autodoc>GetBitmap(self) -> Bitmap</autodoc> |
f32fc4bc RD |
33866 | </method> |
33867 | <method name="GetFilename" type="String" overloaded="no"> | |
781d2982 | 33868 | <autodoc>GetFilename(self) -> String</autodoc> |
f32fc4bc RD |
33869 | </method> |
33870 | <method name="SetBitmap" type="" overloaded="no"> | |
781d2982 | 33871 | <autodoc>SetBitmap(self, Bitmap bitmap)</autodoc> |
f32fc4bc RD |
33872 | <paramlist> |
33873 | <param name="bitmap" type="Bitmap" default=""/> | |
33874 | </paramlist> | |
33875 | </method> | |
33876 | <method name="SetFilename" type="" overloaded="no"> | |
781d2982 | 33877 | <autodoc>SetFilename(self, String filename)</autodoc> |
f32fc4bc RD |
33878 | <paramlist> |
33879 | <param name="filename" type="String" default=""/> | |
33880 | </paramlist> | |
33881 | </method> | |
33882 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 33883 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
33884 | </method> |
33885 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 33886 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
33887 | <paramlist> |
33888 | <param name="dc" type="DC" default=""/> | |
33889 | </paramlist> | |
33890 | </method> | |
33891 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 33892 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
33893 | <paramlist> |
33894 | <param name="dc" type="DC" default=""/> | |
33895 | </paramlist> | |
33896 | </method> | |
33897 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 33898 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
33899 | <paramlist> |
33900 | <param name="dc" type="DC" default=""/> | |
33901 | <param name="erase" type="bool" default="FALSE"/> | |
33902 | </paramlist> | |
33903 | </method> | |
33904 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 33905 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
33906 | <paramlist> |
33907 | <param name="dc" type="DC" default=""/> | |
33908 | </paramlist> | |
33909 | </method> | |
33910 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 33911 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
33912 | <paramlist> |
33913 | <param name="dc" type="DC" default=""/> | |
33914 | </paramlist> | |
33915 | </method> | |
33916 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 33917 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
33918 | <paramlist> |
33919 | <param name="dc" type="DC" default=""/> | |
33920 | </paramlist> | |
33921 | </method> | |
33922 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 33923 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
33924 | <paramlist> |
33925 | <param name="dc" type="DC" default=""/> | |
33926 | </paramlist> | |
33927 | </method> | |
33928 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 33929 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33930 | <paramlist> |
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"/> | |
33935 | </paramlist> | |
33936 | </method> | |
33937 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 33938 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33939 | <paramlist> |
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"/> | |
33944 | </paramlist> | |
33945 | </method> | |
33946 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 33947 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33948 | <paramlist> |
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"/> | |
33953 | </paramlist> | |
33954 | </method> | |
33955 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 33956 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
33957 | <paramlist> |
33958 | <param name="x" type="double" default=""/> | |
33959 | <param name="y" type="double" default=""/> | |
33960 | </paramlist> | |
33961 | </method> | |
33962 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 33963 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
33964 | bool display=True) -> bool</autodoc> |
33965 | <paramlist> | |
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"/> | |
33972 | </paramlist> | |
33973 | </method> | |
33974 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 33975 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
33976 | bool display=True)</autodoc> |
33977 | <paramlist> | |
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"/> | |
33984 | </paramlist> | |
33985 | </method> | |
33986 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 33987 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33988 | <paramlist> |
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"/> | |
33994 | </paramlist> | |
33995 | </method> | |
33996 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 33997 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
33998 | <paramlist> |
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"/> | |
34003 | </paramlist> | |
34004 | </method> | |
34005 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 34006 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34007 | <paramlist> |
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"/> | |
34012 | </paramlist> | |
34013 | </method> | |
34014 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 34015 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34016 | <paramlist> |
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"/> | |
34022 | </paramlist> | |
34023 | </method> | |
34024 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 34025 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34026 | <paramlist> |
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"/> | |
34031 | </paramlist> | |
34032 | </method> | |
34033 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 34034 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34035 | <paramlist> |
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"/> | |
34040 | </paramlist> | |
34041 | </method> | |
34042 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 34043 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
34044 | <paramlist> |
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=""/> | |
34050 | </paramlist> | |
34051 | </method> | |
34052 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 34053 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
34054 | <paramlist> |
34055 | <param name="dc" type="DC" default=""/> | |
34056 | </paramlist> | |
34057 | </method> | |
34058 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 34059 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
34060 | <paramlist> |
34061 | <param name="dc" type="DC" default=""/> | |
34062 | </paramlist> | |
34063 | </method> | |
34064 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 34065 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
34066 | <paramlist> |
34067 | <param name="dc" type="DC" default=""/> | |
34068 | <param name="moveControlPoints" type="bool" default="True"/> | |
34069 | </paramlist> | |
34070 | </method> | |
34071 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 34072 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
34073 | int attachment=0)</autodoc> |
34074 | <paramlist> | |
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"/> | |
34081 | </paramlist> | |
34082 | </method> | |
34083 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 34084 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
34085 | int attachment=0)</autodoc> |
34086 | <paramlist> | |
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"/> | |
34092 | </paramlist> | |
34093 | </method> | |
34094 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 34095 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
34096 | int attachment=0)</autodoc> |
34097 | <paramlist> | |
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"/> | |
34103 | </paramlist> | |
34104 | </method> | |
34105 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 34106 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
34107 | <paramlist> |
34108 | <param name="w" type="double" default=""/> | |
34109 | <param name="h" type="double" default=""/> | |
34110 | </paramlist> | |
34111 | </method> | |
34112 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 34113 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
34114 | <paramlist> |
34115 | <param name="w" type="double" default=""/> | |
34116 | <param name="h" type="double" default=""/> | |
34117 | </paramlist> | |
34118 | </method> | |
34119 | </class> | |
34120 | <class name="PyDrawnShape" oldname="wxPyDrawnShape" module="ogl"> | |
34121 | <baseclass name="PyRectangleShape"/> | |
34122 | <constructor name="PyDrawnShape" overloaded="no"> | |
781d2982 | 34123 | <autodoc>__init__(self) -> PyDrawnShape</autodoc> |
f32fc4bc RD |
34124 | </constructor> |
34125 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 34126 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
34127 | <paramlist> |
34128 | <param name="self" type="PyObject" default=""/> | |
34129 | <param name="_class" type="PyObject" default=""/> | |
34130 | </paramlist> | |
34131 | </method> | |
34132 | <method name="CalculateSize" type="" overloaded="no"> | |
781d2982 | 34133 | <autodoc>CalculateSize(self)</autodoc> |
f32fc4bc RD |
34134 | </method> |
34135 | <method name="DestroyClippingRect" type="" overloaded="no"> | |
781d2982 | 34136 | <autodoc>DestroyClippingRect(self)</autodoc> |
f32fc4bc RD |
34137 | </method> |
34138 | <method name="DrawArc" type="" overloaded="no"> | |
781d2982 | 34139 | <autodoc>DrawArc(self, Point centrePoint, Point startPoint, Point endPoint)</autodoc> |
f32fc4bc RD |
34140 | <paramlist> |
34141 | <param name="centrePoint" type="Point" default=""/> | |
34142 | <param name="startPoint" type="Point" default=""/> | |
34143 | <param name="endPoint" type="Point" default=""/> | |
34144 | </paramlist> | |
34145 | </method> | |
34146 | <method name="DrawAtAngle" type="" overloaded="no"> | |
781d2982 | 34147 | <autodoc>DrawAtAngle(self, int angle)</autodoc> |
f32fc4bc RD |
34148 | <paramlist> |
34149 | <param name="angle" type="int" default=""/> | |
34150 | </paramlist> | |
34151 | </method> | |
34152 | <method name="DrawEllipticArc" type="" overloaded="no"> | |
781d2982 | 34153 | <autodoc>DrawEllipticArc(self, Rect rect, double startAngle, double endAngle)</autodoc> |
f32fc4bc RD |
34154 | <paramlist> |
34155 | <param name="rect" type="Rect" default=""/> | |
34156 | <param name="startAngle" type="double" default=""/> | |
34157 | <param name="endAngle" type="double" default=""/> | |
34158 | </paramlist> | |
34159 | </method> | |
34160 | <method name="DrawLine" type="" overloaded="no"> | |
781d2982 | 34161 | <autodoc>DrawLine(self, Point point1, Point point2)</autodoc> |
f32fc4bc RD |
34162 | <paramlist> |
34163 | <param name="point1" type="Point" default=""/> | |
34164 | <param name="point2" type="Point" default=""/> | |
34165 | </paramlist> | |
34166 | </method> | |
34167 | <method name="DrawLines" type="" overloaded="no"> | |
781d2982 | 34168 | <autodoc>DrawLines(self, int points, Point points_array)</autodoc> |
f32fc4bc | 34169 | <paramlist> |
781d2982 RD |
34170 | <param name="points" type="int" default=""/> |
34171 | <param name="points_array" type="Point" default=""/> | |
f32fc4bc RD |
34172 | </paramlist> |
34173 | </method> | |
34174 | <method name="DrawPoint" type="" overloaded="no"> | |
781d2982 | 34175 | <autodoc>DrawPoint(self, Point point)</autodoc> |
f32fc4bc RD |
34176 | <paramlist> |
34177 | <param name="point" type="Point" default=""/> | |
34178 | </paramlist> | |
34179 | </method> | |
34180 | <method name="DrawPolygon" type="" overloaded="no"> | |
781d2982 | 34181 | <autodoc>DrawPolygon(self, int points, Point points_array, int flags=0)</autodoc> |
f32fc4bc | 34182 | <paramlist> |
781d2982 RD |
34183 | <param name="points" type="int" default=""/> |
34184 | <param name="points_array" type="Point" default=""/> | |
f32fc4bc RD |
34185 | <param name="flags" type="int" default="0"/> |
34186 | </paramlist> | |
34187 | </method> | |
34188 | <method name="DrawRectangle" type="" overloaded="no"> | |
781d2982 | 34189 | <autodoc>DrawRectangle(self, Rect rect)</autodoc> |
f32fc4bc RD |
34190 | <paramlist> |
34191 | <param name="rect" type="Rect" default=""/> | |
34192 | </paramlist> | |
34193 | </method> | |
34194 | <method name="DrawRoundedRectangle" type="" overloaded="no"> | |
781d2982 | 34195 | <autodoc>DrawRoundedRectangle(self, Rect rect, double radius)</autodoc> |
f32fc4bc RD |
34196 | <paramlist> |
34197 | <param name="rect" type="Rect" default=""/> | |
34198 | <param name="radius" type="double" default=""/> | |
34199 | </paramlist> | |
34200 | </method> | |
34201 | <method name="DrawSpline" type="" overloaded="no"> | |
781d2982 | 34202 | <autodoc>DrawSpline(self, int points, Point points_array)</autodoc> |
f32fc4bc | 34203 | <paramlist> |
781d2982 RD |
34204 | <param name="points" type="int" default=""/> |
34205 | <param name="points_array" type="Point" default=""/> | |
f32fc4bc RD |
34206 | </paramlist> |
34207 | </method> | |
34208 | <method name="DrawText" type="" overloaded="no"> | |
781d2982 | 34209 | <autodoc>DrawText(self, String text, Point point)</autodoc> |
f32fc4bc RD |
34210 | <paramlist> |
34211 | <param name="text" type="String" default=""/> | |
34212 | <param name="point" type="Point" default=""/> | |
34213 | </paramlist> | |
34214 | </method> | |
34215 | <method name="GetAngle" type="int" overloaded="no"> | |
781d2982 | 34216 | <autodoc>GetAngle(self) -> int</autodoc> |
f32fc4bc RD |
34217 | </method> |
34218 | <method name="GetMetaFile" type="PseudoMetaFile" overloaded="no"> | |
781d2982 | 34219 | <autodoc>GetMetaFile(self) -> PseudoMetaFile</autodoc> |
f32fc4bc RD |
34220 | </method> |
34221 | <method name="GetRotation" type="double" overloaded="no"> | |
781d2982 | 34222 | <autodoc>GetRotation(self) -> double</autodoc> |
f32fc4bc RD |
34223 | </method> |
34224 | <method name="LoadFromMetaFile" type="bool" overloaded="no"> | |
781d2982 | 34225 | <autodoc>LoadFromMetaFile(self, String filename) -> bool</autodoc> |
f32fc4bc RD |
34226 | <paramlist> |
34227 | <param name="filename" type="String" default=""/> | |
34228 | </paramlist> | |
34229 | </method> | |
34230 | <method name="Rotate" type="" overloaded="no"> | |
781d2982 | 34231 | <autodoc>Rotate(self, double x, double y, double theta)</autodoc> |
f32fc4bc RD |
34232 | <paramlist> |
34233 | <param name="x" type="double" default=""/> | |
34234 | <param name="y" type="double" default=""/> | |
34235 | <param name="theta" type="double" default=""/> | |
34236 | </paramlist> | |
34237 | </method> | |
34238 | <method name="SetClippingRect" type="" overloaded="no"> | |
781d2982 | 34239 | <autodoc>SetClippingRect(self, Rect rect)</autodoc> |
f32fc4bc RD |
34240 | <paramlist> |
34241 | <param name="rect" type="Rect" default=""/> | |
34242 | </paramlist> | |
34243 | </method> | |
34244 | <method name="SetDrawnBackgroundColour" type="" overloaded="no"> | |
781d2982 | 34245 | <autodoc>SetDrawnBackgroundColour(self, Colour colour)</autodoc> |
f32fc4bc RD |
34246 | <paramlist> |
34247 | <param name="colour" type="Colour" default=""/> | |
34248 | </paramlist> | |
34249 | </method> | |
34250 | <method name="SetDrawnBackgroundMode" type="" overloaded="no"> | |
781d2982 | 34251 | <autodoc>SetDrawnBackgroundMode(self, int mode)</autodoc> |
f32fc4bc RD |
34252 | <paramlist> |
34253 | <param name="mode" type="int" default=""/> | |
34254 | </paramlist> | |
34255 | </method> | |
34256 | <method name="SetDrawnBrush" type="" overloaded="no"> | |
781d2982 | 34257 | <autodoc>SetDrawnBrush(self, wxBrush pen, bool isOutline=FALSE)</autodoc> |
f32fc4bc RD |
34258 | <paramlist> |
34259 | <param name="pen" type="Brush" default=""/> | |
34260 | <param name="isOutline" type="bool" default="FALSE"/> | |
34261 | </paramlist> | |
34262 | </method> | |
34263 | <method name="SetDrawnFont" type="" overloaded="no"> | |
781d2982 | 34264 | <autodoc>SetDrawnFont(self, Font font)</autodoc> |
f32fc4bc RD |
34265 | <paramlist> |
34266 | <param name="font" type="Font" default=""/> | |
34267 | </paramlist> | |
34268 | </method> | |
34269 | <method name="SetDrawnPen" type="" overloaded="no"> | |
781d2982 | 34270 | <autodoc>SetDrawnPen(self, wxPen pen, bool isOutline=FALSE)</autodoc> |
f32fc4bc RD |
34271 | <paramlist> |
34272 | <param name="pen" type="Pen" default=""/> | |
34273 | <param name="isOutline" type="bool" default="FALSE"/> | |
34274 | </paramlist> | |
34275 | </method> | |
34276 | <method name="SetDrawnTextColour" type="" overloaded="no"> | |
781d2982 | 34277 | <autodoc>SetDrawnTextColour(self, Colour colour)</autodoc> |
f32fc4bc RD |
34278 | <paramlist> |
34279 | <param name="colour" type="Colour" default=""/> | |
34280 | </paramlist> | |
34281 | </method> | |
34282 | <method name="Scale" type="" overloaded="no"> | |
781d2982 | 34283 | <autodoc>Scale(self, double sx, double sy)</autodoc> |
f32fc4bc RD |
34284 | <paramlist> |
34285 | <param name="sx" type="double" default=""/> | |
34286 | <param name="sy" type="double" default=""/> | |
34287 | </paramlist> | |
34288 | </method> | |
34289 | <method name="SetSaveToFile" type="" overloaded="no"> | |
781d2982 | 34290 | <autodoc>SetSaveToFile(self, bool save)</autodoc> |
f32fc4bc RD |
34291 | <paramlist> |
34292 | <param name="save" type="bool" default=""/> | |
34293 | </paramlist> | |
34294 | </method> | |
34295 | <method name="Translate" type="" overloaded="no"> | |
781d2982 | 34296 | <autodoc>Translate(self, double x, double y)</autodoc> |
f32fc4bc RD |
34297 | <paramlist> |
34298 | <param name="x" type="double" default=""/> | |
34299 | <param name="y" type="double" default=""/> | |
34300 | </paramlist> | |
34301 | </method> | |
34302 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 34303 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
34304 | </method> |
34305 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 34306 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
34307 | <paramlist> |
34308 | <param name="dc" type="DC" default=""/> | |
34309 | </paramlist> | |
34310 | </method> | |
34311 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 34312 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
34313 | <paramlist> |
34314 | <param name="dc" type="DC" default=""/> | |
34315 | </paramlist> | |
34316 | </method> | |
34317 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 34318 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
34319 | <paramlist> |
34320 | <param name="dc" type="DC" default=""/> | |
34321 | <param name="erase" type="bool" default="FALSE"/> | |
34322 | </paramlist> | |
34323 | </method> | |
34324 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 34325 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
34326 | <paramlist> |
34327 | <param name="dc" type="DC" default=""/> | |
34328 | </paramlist> | |
34329 | </method> | |
34330 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 34331 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
34332 | <paramlist> |
34333 | <param name="dc" type="DC" default=""/> | |
34334 | </paramlist> | |
34335 | </method> | |
34336 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 34337 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
34338 | <paramlist> |
34339 | <param name="dc" type="DC" default=""/> | |
34340 | </paramlist> | |
34341 | </method> | |
34342 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 34343 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
34344 | <paramlist> |
34345 | <param name="dc" type="DC" default=""/> | |
34346 | </paramlist> | |
34347 | </method> | |
34348 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 34349 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34350 | <paramlist> |
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"/> | |
34355 | </paramlist> | |
34356 | </method> | |
34357 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 34358 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34359 | <paramlist> |
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"/> | |
34364 | </paramlist> | |
34365 | </method> | |
34366 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 34367 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34368 | <paramlist> |
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"/> | |
34373 | </paramlist> | |
34374 | </method> | |
34375 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 34376 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
34377 | <paramlist> |
34378 | <param name="x" type="double" default=""/> | |
34379 | <param name="y" type="double" default=""/> | |
34380 | </paramlist> | |
34381 | </method> | |
34382 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 34383 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
34384 | bool display=True) -> bool</autodoc> |
34385 | <paramlist> | |
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"/> | |
34392 | </paramlist> | |
34393 | </method> | |
34394 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 34395 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
34396 | bool display=True)</autodoc> |
34397 | <paramlist> | |
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"/> | |
34404 | </paramlist> | |
34405 | </method> | |
34406 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 34407 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34408 | <paramlist> |
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"/> | |
34414 | </paramlist> | |
34415 | </method> | |
34416 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 34417 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34418 | <paramlist> |
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"/> | |
34423 | </paramlist> | |
34424 | </method> | |
34425 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 34426 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34427 | <paramlist> |
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"/> | |
34432 | </paramlist> | |
34433 | </method> | |
34434 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 34435 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34436 | <paramlist> |
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"/> | |
34442 | </paramlist> | |
34443 | </method> | |
34444 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 34445 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34446 | <paramlist> |
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"/> | |
34451 | </paramlist> | |
34452 | </method> | |
34453 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 34454 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34455 | <paramlist> |
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"/> | |
34460 | </paramlist> | |
34461 | </method> | |
34462 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 34463 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
34464 | <paramlist> |
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=""/> | |
34470 | </paramlist> | |
34471 | </method> | |
34472 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 34473 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
34474 | <paramlist> |
34475 | <param name="dc" type="DC" default=""/> | |
34476 | </paramlist> | |
34477 | </method> | |
34478 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 34479 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
34480 | <paramlist> |
34481 | <param name="dc" type="DC" default=""/> | |
34482 | </paramlist> | |
34483 | </method> | |
34484 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 34485 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
34486 | <paramlist> |
34487 | <param name="dc" type="DC" default=""/> | |
34488 | <param name="moveControlPoints" type="bool" default="True"/> | |
34489 | </paramlist> | |
34490 | </method> | |
34491 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 34492 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
34493 | int attachment=0)</autodoc> |
34494 | <paramlist> | |
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"/> | |
34501 | </paramlist> | |
34502 | </method> | |
34503 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 34504 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
34505 | int attachment=0)</autodoc> |
34506 | <paramlist> | |
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"/> | |
34512 | </paramlist> | |
34513 | </method> | |
34514 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 34515 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
34516 | int attachment=0)</autodoc> |
34517 | <paramlist> | |
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"/> | |
34523 | </paramlist> | |
34524 | </method> | |
34525 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 34526 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
34527 | <paramlist> |
34528 | <param name="w" type="double" default=""/> | |
34529 | <param name="h" type="double" default=""/> | |
34530 | </paramlist> | |
34531 | </method> | |
34532 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 34533 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
34534 | <paramlist> |
34535 | <param name="w" type="double" default=""/> | |
34536 | <param name="h" type="double" default=""/> | |
34537 | </paramlist> | |
34538 | </method> | |
34539 | </class> | |
34540 | <class name="OGLConstraint" oldname="wxOGLConstraint" module="ogl"> | |
34541 | <baseclass name="Object"/> | |
34542 | <constructor name="OGLConstraint" overloaded="no"> | |
781d2982 | 34543 | <autodoc>__init__(self, int type, PyShape constraining, PyObject constrained) -> OGLConstraint</autodoc> |
f32fc4bc RD |
34544 | <paramlist> |
34545 | <param name="type" type="int" default=""/> | |
34546 | <param name="constraining" type="PyShape" default=""/> | |
34547 | <param name="constrained" type="PyObject" default=""/> | |
34548 | </paramlist> | |
34549 | </constructor> | |
34550 | <method name="Evaluate" type="bool" overloaded="no"> | |
781d2982 | 34551 | <autodoc>Evaluate(self) -> bool</autodoc> |
f32fc4bc RD |
34552 | </method> |
34553 | <method name="SetSpacing" type="" overloaded="no"> | |
781d2982 | 34554 | <autodoc>SetSpacing(self, double x, double y)</autodoc> |
f32fc4bc RD |
34555 | <paramlist> |
34556 | <param name="x" type="double" default=""/> | |
34557 | <param name="y" type="double" default=""/> | |
34558 | </paramlist> | |
34559 | </method> | |
34560 | <method name="Equals" type="bool" overloaded="no"> | |
781d2982 | 34561 | <autodoc>Equals(self, double a, double b) -> bool</autodoc> |
f32fc4bc RD |
34562 | <paramlist> |
34563 | <param name="a" type="double" default=""/> | |
34564 | <param name="b" type="double" default=""/> | |
34565 | </paramlist> | |
34566 | </method> | |
34567 | </class> | |
34568 | <class name="PyCompositeShape" oldname="wxPyCompositeShape" module="ogl"> | |
34569 | <baseclass name="PyRectangleShape"/> | |
34570 | <constructor name="PyCompositeShape" overloaded="no"> | |
781d2982 | 34571 | <autodoc>__init__(self) -> PyCompositeShape</autodoc> |
f32fc4bc RD |
34572 | </constructor> |
34573 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 34574 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
34575 | <paramlist> |
34576 | <param name="self" type="PyObject" default=""/> | |
34577 | <param name="_class" type="PyObject" default=""/> | |
34578 | </paramlist> | |
34579 | </method> | |
34580 | <method name="AddChild" type="" overloaded="no"> | |
781d2982 | 34581 | <autodoc>AddChild(self, PyShape child, PyShape addAfter=None)</autodoc> |
f32fc4bc RD |
34582 | <paramlist> |
34583 | <param name="child" type="PyShape" default=""/> | |
34584 | <param name="addAfter" type="PyShape" default="NULL"/> | |
34585 | </paramlist> | |
34586 | </method> | |
34587 | <method name="AddConstraint" type="OGLConstraint" overloaded="no"> | |
781d2982 | 34588 | <autodoc>AddConstraint(self, OGLConstraint constraint) -> OGLConstraint</autodoc> |
f32fc4bc RD |
34589 | <paramlist> |
34590 | <param name="constraint" type="OGLConstraint" default=""/> | |
34591 | </paramlist> | |
34592 | </method> | |
34593 | <method name="AddConstrainedShapes" type="OGLConstraint" overloaded="no"> | |
781d2982 | 34594 | <autodoc>AddConstrainedShapes(self, int type, PyShape constraining, PyObject constrained) -> OGLConstraint</autodoc> |
f32fc4bc RD |
34595 | <paramlist> |
34596 | <param name="type" type="int" default=""/> | |
34597 | <param name="constraining" type="PyShape" default=""/> | |
34598 | <param name="constrained" type="PyObject" default=""/> | |
34599 | </paramlist> | |
34600 | </method> | |
34601 | <method name="AddSimpleConstraint" type="OGLConstraint" overloaded="no"> | |
781d2982 | 34602 | <autodoc>AddSimpleConstraint(self, int type, PyShape constraining, PyShape constrained) -> OGLConstraint</autodoc> |
f32fc4bc RD |
34603 | <paramlist> |
34604 | <param name="type" type="int" default=""/> | |
34605 | <param name="constraining" type="PyShape" default=""/> | |
34606 | <param name="constrained" type="PyShape" default=""/> | |
34607 | </paramlist> | |
34608 | </method> | |
34609 | <method name="CalculateSize" type="" overloaded="no"> | |
781d2982 | 34610 | <autodoc>CalculateSize(self)</autodoc> |
f32fc4bc RD |
34611 | </method> |
34612 | <method name="ContainsDivision" type="bool" overloaded="no"> | |
781d2982 | 34613 | <autodoc>ContainsDivision(self, PyDivisionShape division) -> bool</autodoc> |
f32fc4bc RD |
34614 | <paramlist> |
34615 | <param name="division" type="wxPyDivisionShape" default=""/> | |
34616 | </paramlist> | |
34617 | </method> | |
34618 | <method name="DeleteConstraint" type="" overloaded="no"> | |
781d2982 | 34619 | <autodoc>DeleteConstraint(self, OGLConstraint constraint)</autodoc> |
f32fc4bc RD |
34620 | <paramlist> |
34621 | <param name="constraint" type="OGLConstraint" default=""/> | |
34622 | </paramlist> | |
34623 | </method> | |
34624 | <method name="DeleteConstraintsInvolvingChild" type="" overloaded="no"> | |
781d2982 | 34625 | <autodoc>DeleteConstraintsInvolvingChild(self, PyShape child)</autodoc> |
f32fc4bc RD |
34626 | <paramlist> |
34627 | <param name="child" type="PyShape" default=""/> | |
34628 | </paramlist> | |
34629 | </method> | |
34630 | <method name="FindContainerImage" type="PyShape" overloaded="no"> | |
781d2982 | 34631 | <autodoc>FindContainerImage(self) -> PyShape</autodoc> |
f32fc4bc RD |
34632 | </method> |
34633 | <method name="GetConstraints" type="PyObject" overloaded="no"> | |
781d2982 | 34634 | <autodoc>GetConstraints(self) -> PyObject</autodoc> |
f32fc4bc RD |
34635 | </method> |
34636 | <method name="GetDivisions" type="PyObject" overloaded="no"> | |
781d2982 | 34637 | <autodoc>GetDivisions(self) -> PyObject</autodoc> |
f32fc4bc RD |
34638 | </method> |
34639 | <method name="MakeContainer" type="" overloaded="no"> | |
781d2982 | 34640 | <autodoc>MakeContainer(self)</autodoc> |
f32fc4bc RD |
34641 | </method> |
34642 | <method name="Recompute" type="bool" overloaded="no"> | |
781d2982 | 34643 | <autodoc>Recompute(self) -> bool</autodoc> |
f32fc4bc RD |
34644 | </method> |
34645 | <method name="RemoveChild" type="" overloaded="no"> | |
781d2982 | 34646 | <autodoc>RemoveChild(self, PyShape child)</autodoc> |
f32fc4bc RD |
34647 | <paramlist> |
34648 | <param name="child" type="PyShape" default=""/> | |
34649 | </paramlist> | |
34650 | </method> | |
34651 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 34652 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
34653 | </method> |
34654 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 34655 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
34656 | <paramlist> |
34657 | <param name="dc" type="DC" default=""/> | |
34658 | </paramlist> | |
34659 | </method> | |
34660 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 34661 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
34662 | <paramlist> |
34663 | <param name="dc" type="DC" default=""/> | |
34664 | </paramlist> | |
34665 | </method> | |
34666 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 34667 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
34668 | <paramlist> |
34669 | <param name="dc" type="DC" default=""/> | |
34670 | <param name="erase" type="bool" default="FALSE"/> | |
34671 | </paramlist> | |
34672 | </method> | |
34673 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 34674 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
34675 | <paramlist> |
34676 | <param name="dc" type="DC" default=""/> | |
34677 | </paramlist> | |
34678 | </method> | |
34679 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 34680 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
34681 | <paramlist> |
34682 | <param name="dc" type="DC" default=""/> | |
34683 | </paramlist> | |
34684 | </method> | |
34685 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 34686 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
34687 | <paramlist> |
34688 | <param name="dc" type="DC" default=""/> | |
34689 | </paramlist> | |
34690 | </method> | |
34691 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 34692 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
34693 | <paramlist> |
34694 | <param name="dc" type="DC" default=""/> | |
34695 | </paramlist> | |
34696 | </method> | |
34697 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 34698 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34699 | <paramlist> |
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"/> | |
34704 | </paramlist> | |
34705 | </method> | |
34706 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 34707 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34708 | <paramlist> |
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"/> | |
34713 | </paramlist> | |
34714 | </method> | |
34715 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 34716 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34717 | <paramlist> |
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"/> | |
34722 | </paramlist> | |
34723 | </method> | |
34724 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 34725 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
34726 | <paramlist> |
34727 | <param name="x" type="double" default=""/> | |
34728 | <param name="y" type="double" default=""/> | |
34729 | </paramlist> | |
34730 | </method> | |
34731 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 34732 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
34733 | bool display=True) -> bool</autodoc> |
34734 | <paramlist> | |
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"/> | |
34741 | </paramlist> | |
34742 | </method> | |
34743 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 34744 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
34745 | bool display=True)</autodoc> |
34746 | <paramlist> | |
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"/> | |
34753 | </paramlist> | |
34754 | </method> | |
34755 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 34756 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34757 | <paramlist> |
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"/> | |
34763 | </paramlist> | |
34764 | </method> | |
34765 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 34766 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34767 | <paramlist> |
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"/> | |
34772 | </paramlist> | |
34773 | </method> | |
34774 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 34775 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34776 | <paramlist> |
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"/> | |
34781 | </paramlist> | |
34782 | </method> | |
34783 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 34784 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34785 | <paramlist> |
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"/> | |
34791 | </paramlist> | |
34792 | </method> | |
34793 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 34794 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34795 | <paramlist> |
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"/> | |
34800 | </paramlist> | |
34801 | </method> | |
34802 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 34803 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34804 | <paramlist> |
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"/> | |
34809 | </paramlist> | |
34810 | </method> | |
34811 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 34812 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
34813 | <paramlist> |
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=""/> | |
34819 | </paramlist> | |
34820 | </method> | |
34821 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 34822 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
34823 | <paramlist> |
34824 | <param name="dc" type="DC" default=""/> | |
34825 | </paramlist> | |
34826 | </method> | |
34827 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 34828 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
34829 | <paramlist> |
34830 | <param name="dc" type="DC" default=""/> | |
34831 | </paramlist> | |
34832 | </method> | |
34833 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 34834 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
34835 | <paramlist> |
34836 | <param name="dc" type="DC" default=""/> | |
34837 | <param name="moveControlPoints" type="bool" default="True"/> | |
34838 | </paramlist> | |
34839 | </method> | |
34840 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 34841 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
34842 | int attachment=0)</autodoc> |
34843 | <paramlist> | |
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"/> | |
34850 | </paramlist> | |
34851 | </method> | |
34852 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 34853 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
34854 | int attachment=0)</autodoc> |
34855 | <paramlist> | |
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"/> | |
34861 | </paramlist> | |
34862 | </method> | |
34863 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 34864 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
34865 | int attachment=0)</autodoc> |
34866 | <paramlist> | |
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"/> | |
34872 | </paramlist> | |
34873 | </method> | |
34874 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 34875 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
34876 | <paramlist> |
34877 | <param name="w" type="double" default=""/> | |
34878 | <param name="h" type="double" default=""/> | |
34879 | </paramlist> | |
34880 | </method> | |
34881 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 34882 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
34883 | <paramlist> |
34884 | <param name="w" type="double" default=""/> | |
34885 | <param name="h" type="double" default=""/> | |
34886 | </paramlist> | |
34887 | </method> | |
34888 | </class> | |
34889 | <class name="PyDividedShape" oldname="wxPyDividedShape" module="ogl"> | |
34890 | <baseclass name="PyRectangleShape"/> | |
34891 | <constructor name="PyDividedShape" overloaded="no"> | |
781d2982 | 34892 | <autodoc>__init__(self, double width=0.0, double height=0.0) -> PyDividedShape</autodoc> |
f32fc4bc RD |
34893 | <paramlist> |
34894 | <param name="width" type="double" default="0.0"/> | |
34895 | <param name="height" type="double" default="0.0"/> | |
34896 | </paramlist> | |
34897 | </constructor> | |
34898 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 34899 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
34900 | <paramlist> |
34901 | <param name="self" type="PyObject" default=""/> | |
34902 | <param name="_class" type="PyObject" default=""/> | |
34903 | </paramlist> | |
34904 | </method> | |
34905 | <method name="EditRegions" type="" overloaded="no"> | |
781d2982 | 34906 | <autodoc>EditRegions(self)</autodoc> |
f32fc4bc RD |
34907 | </method> |
34908 | <method name="SetRegionSizes" type="" overloaded="no"> | |
781d2982 | 34909 | <autodoc>SetRegionSizes(self)</autodoc> |
f32fc4bc RD |
34910 | </method> |
34911 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 34912 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
34913 | </method> |
34914 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 34915 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
34916 | <paramlist> |
34917 | <param name="dc" type="DC" default=""/> | |
34918 | </paramlist> | |
34919 | </method> | |
34920 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 34921 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
34922 | <paramlist> |
34923 | <param name="dc" type="DC" default=""/> | |
34924 | </paramlist> | |
34925 | </method> | |
34926 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 34927 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
34928 | <paramlist> |
34929 | <param name="dc" type="DC" default=""/> | |
34930 | <param name="erase" type="bool" default="FALSE"/> | |
34931 | </paramlist> | |
34932 | </method> | |
34933 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 34934 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
34935 | <paramlist> |
34936 | <param name="dc" type="DC" default=""/> | |
34937 | </paramlist> | |
34938 | </method> | |
34939 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 34940 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
34941 | <paramlist> |
34942 | <param name="dc" type="DC" default=""/> | |
34943 | </paramlist> | |
34944 | </method> | |
34945 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 34946 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
34947 | <paramlist> |
34948 | <param name="dc" type="DC" default=""/> | |
34949 | </paramlist> | |
34950 | </method> | |
34951 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 34952 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
34953 | <paramlist> |
34954 | <param name="dc" type="DC" default=""/> | |
34955 | </paramlist> | |
34956 | </method> | |
34957 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 34958 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34959 | <paramlist> |
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"/> | |
34964 | </paramlist> | |
34965 | </method> | |
34966 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 34967 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34968 | <paramlist> |
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"/> | |
34973 | </paramlist> | |
34974 | </method> | |
34975 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 34976 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
34977 | <paramlist> |
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"/> | |
34982 | </paramlist> | |
34983 | </method> | |
34984 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 34985 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
34986 | <paramlist> |
34987 | <param name="x" type="double" default=""/> | |
34988 | <param name="y" type="double" default=""/> | |
34989 | </paramlist> | |
34990 | </method> | |
34991 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 34992 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
34993 | bool display=True) -> bool</autodoc> |
34994 | <paramlist> | |
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"/> | |
35001 | </paramlist> | |
35002 | </method> | |
35003 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 35004 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
35005 | bool display=True)</autodoc> |
35006 | <paramlist> | |
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"/> | |
35013 | </paramlist> | |
35014 | </method> | |
35015 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 35016 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35017 | <paramlist> |
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"/> | |
35023 | </paramlist> | |
35024 | </method> | |
35025 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 35026 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35027 | <paramlist> |
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"/> | |
35032 | </paramlist> | |
35033 | </method> | |
35034 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 35035 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35036 | <paramlist> |
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"/> | |
35041 | </paramlist> | |
35042 | </method> | |
35043 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 35044 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35045 | <paramlist> |
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"/> | |
35051 | </paramlist> | |
35052 | </method> | |
35053 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 35054 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35055 | <paramlist> |
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"/> | |
35060 | </paramlist> | |
35061 | </method> | |
35062 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 35063 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35064 | <paramlist> |
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"/> | |
35069 | </paramlist> | |
35070 | </method> | |
35071 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 35072 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
35073 | <paramlist> |
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=""/> | |
35079 | </paramlist> | |
35080 | </method> | |
35081 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 35082 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
35083 | <paramlist> |
35084 | <param name="dc" type="DC" default=""/> | |
35085 | </paramlist> | |
35086 | </method> | |
35087 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 35088 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
35089 | <paramlist> |
35090 | <param name="dc" type="DC" default=""/> | |
35091 | </paramlist> | |
35092 | </method> | |
35093 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 35094 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
35095 | <paramlist> |
35096 | <param name="dc" type="DC" default=""/> | |
35097 | <param name="moveControlPoints" type="bool" default="True"/> | |
35098 | </paramlist> | |
35099 | </method> | |
35100 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 35101 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
35102 | int attachment=0)</autodoc> |
35103 | <paramlist> | |
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"/> | |
35110 | </paramlist> | |
35111 | </method> | |
35112 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 35113 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
35114 | int attachment=0)</autodoc> |
35115 | <paramlist> | |
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"/> | |
35121 | </paramlist> | |
35122 | </method> | |
35123 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 35124 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
35125 | int attachment=0)</autodoc> |
35126 | <paramlist> | |
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"/> | |
35132 | </paramlist> | |
35133 | </method> | |
35134 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 35135 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
35136 | <paramlist> |
35137 | <param name="w" type="double" default=""/> | |
35138 | <param name="h" type="double" default=""/> | |
35139 | </paramlist> | |
35140 | </method> | |
35141 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 35142 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
35143 | <paramlist> |
35144 | <param name="w" type="double" default=""/> | |
35145 | <param name="h" type="double" default=""/> | |
35146 | </paramlist> | |
35147 | </method> | |
35148 | </class> | |
35149 | <class name="PyDivisionShape" oldname="wxPyDivisionShape" module="ogl"> | |
35150 | <baseclass name="PyCompositeShape"/> | |
35151 | <constructor name="PyDivisionShape" overloaded="no"> | |
781d2982 | 35152 | <autodoc>__init__(self) -> PyDivisionShape</autodoc> |
f32fc4bc RD |
35153 | </constructor> |
35154 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 35155 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
35156 | <paramlist> |
35157 | <param name="self" type="PyObject" default=""/> | |
35158 | <param name="_class" type="PyObject" default=""/> | |
35159 | </paramlist> | |
35160 | </method> | |
35161 | <method name="AdjustBottom" type="" overloaded="no"> | |
781d2982 | 35162 | <autodoc>AdjustBottom(self, double bottom, bool test)</autodoc> |
f32fc4bc RD |
35163 | <paramlist> |
35164 | <param name="bottom" type="double" default=""/> | |
35165 | <param name="test" type="bool" default=""/> | |
35166 | </paramlist> | |
35167 | </method> | |
35168 | <method name="AdjustLeft" type="" overloaded="no"> | |
781d2982 | 35169 | <autodoc>AdjustLeft(self, double left, bool test)</autodoc> |
f32fc4bc RD |
35170 | <paramlist> |
35171 | <param name="left" type="double" default=""/> | |
35172 | <param name="test" type="bool" default=""/> | |
35173 | </paramlist> | |
35174 | </method> | |
35175 | <method name="AdjustRight" type="" overloaded="no"> | |
781d2982 | 35176 | <autodoc>AdjustRight(self, double right, bool test)</autodoc> |
f32fc4bc RD |
35177 | <paramlist> |
35178 | <param name="right" type="double" default=""/> | |
35179 | <param name="test" type="bool" default=""/> | |
35180 | </paramlist> | |
35181 | </method> | |
35182 | <method name="AdjustTop" type="" overloaded="no"> | |
781d2982 | 35183 | <autodoc>AdjustTop(self, double top, bool test)</autodoc> |
f32fc4bc RD |
35184 | <paramlist> |
35185 | <param name="top" type="double" default=""/> | |
35186 | <param name="test" type="bool" default=""/> | |
35187 | </paramlist> | |
35188 | </method> | |
35189 | <method name="Divide" type="" overloaded="no"> | |
781d2982 | 35190 | <autodoc>Divide(self, int direction)</autodoc> |
f32fc4bc RD |
35191 | <paramlist> |
35192 | <param name="direction" type="int" default=""/> | |
35193 | </paramlist> | |
35194 | </method> | |
35195 | <method name="EditEdge" type="" overloaded="no"> | |
781d2982 | 35196 | <autodoc>EditEdge(self, int side)</autodoc> |
f32fc4bc RD |
35197 | <paramlist> |
35198 | <param name="side" type="int" default=""/> | |
35199 | </paramlist> | |
35200 | </method> | |
35201 | <method name="GetBottomSide" type="PyDivisionShape" overloaded="no"> | |
781d2982 | 35202 | <autodoc>GetBottomSide(self) -> PyDivisionShape</autodoc> |
f32fc4bc RD |
35203 | </method> |
35204 | <method name="GetHandleSide" type="int" overloaded="no"> | |
781d2982 | 35205 | <autodoc>GetHandleSide(self) -> int</autodoc> |
f32fc4bc RD |
35206 | </method> |
35207 | <method name="GetLeftSide" type="PyDivisionShape" overloaded="no"> | |
781d2982 | 35208 | <autodoc>GetLeftSide(self) -> PyDivisionShape</autodoc> |
f32fc4bc RD |
35209 | </method> |
35210 | <method name="GetLeftSideColour" type="String" overloaded="no"> | |
781d2982 | 35211 | <autodoc>GetLeftSideColour(self) -> String</autodoc> |
f32fc4bc RD |
35212 | </method> |
35213 | <method name="GetLeftSidePen" type="Pen" overloaded="no"> | |
781d2982 | 35214 | <autodoc>GetLeftSidePen(self) -> wxPen</autodoc> |
f32fc4bc RD |
35215 | </method> |
35216 | <method name="GetRightSide" type="PyDivisionShape" overloaded="no"> | |
781d2982 | 35217 | <autodoc>GetRightSide(self) -> PyDivisionShape</autodoc> |
f32fc4bc RD |
35218 | </method> |
35219 | <method name="GetTopSide" type="PyDivisionShape" overloaded="no"> | |
781d2982 | 35220 | <autodoc>GetTopSide(self) -> PyDivisionShape</autodoc> |
f32fc4bc RD |
35221 | </method> |
35222 | <method name="GetTopSidePen" type="Pen" overloaded="no"> | |
781d2982 | 35223 | <autodoc>GetTopSidePen(self) -> wxPen</autodoc> |
f32fc4bc RD |
35224 | </method> |
35225 | <method name="ResizeAdjoining" type="" overloaded="no"> | |
781d2982 | 35226 | <autodoc>ResizeAdjoining(self, int side, double newPos, bool test)</autodoc> |
f32fc4bc RD |
35227 | <paramlist> |
35228 | <param name="side" type="int" default=""/> | |
35229 | <param name="newPos" type="double" default=""/> | |
35230 | <param name="test" type="bool" default=""/> | |
35231 | </paramlist> | |
35232 | </method> | |
35233 | <method name="PopupMenu" type="" overloaded="no"> | |
781d2982 | 35234 | <autodoc>PopupMenu(self, double x, double y)</autodoc> |
f32fc4bc RD |
35235 | <paramlist> |
35236 | <param name="x" type="double" default=""/> | |
35237 | <param name="y" type="double" default=""/> | |
35238 | </paramlist> | |
35239 | </method> | |
35240 | <method name="SetBottomSide" type="" overloaded="no"> | |
781d2982 | 35241 | <autodoc>SetBottomSide(self, PyDivisionShape shape)</autodoc> |
f32fc4bc RD |
35242 | <paramlist> |
35243 | <param name="shape" type="PyDivisionShape" default=""/> | |
35244 | </paramlist> | |
35245 | </method> | |
35246 | <method name="SetHandleSide" type="" overloaded="no"> | |
781d2982 | 35247 | <autodoc>SetHandleSide(self, int side)</autodoc> |
f32fc4bc RD |
35248 | <paramlist> |
35249 | <param name="side" type="int" default=""/> | |
35250 | </paramlist> | |
35251 | </method> | |
35252 | <method name="SetLeftSide" type="" overloaded="no"> | |
781d2982 | 35253 | <autodoc>SetLeftSide(self, PyDivisionShape shape)</autodoc> |
f32fc4bc RD |
35254 | <paramlist> |
35255 | <param name="shape" type="PyDivisionShape" default=""/> | |
35256 | </paramlist> | |
35257 | </method> | |
35258 | <method name="SetLeftSideColour" type="" overloaded="no"> | |
781d2982 | 35259 | <autodoc>SetLeftSideColour(self, String colour)</autodoc> |
f32fc4bc RD |
35260 | <paramlist> |
35261 | <param name="colour" type="String" default=""/> | |
35262 | </paramlist> | |
35263 | </method> | |
35264 | <method name="SetLeftSidePen" type="" overloaded="no"> | |
781d2982 | 35265 | <autodoc>SetLeftSidePen(self, wxPen pen)</autodoc> |
f32fc4bc RD |
35266 | <paramlist> |
35267 | <param name="pen" type="Pen" default=""/> | |
35268 | </paramlist> | |
35269 | </method> | |
35270 | <method name="SetRightSide" type="" overloaded="no"> | |
781d2982 | 35271 | <autodoc>SetRightSide(self, PyDivisionShape shape)</autodoc> |
f32fc4bc RD |
35272 | <paramlist> |
35273 | <param name="shape" type="PyDivisionShape" default=""/> | |
35274 | </paramlist> | |
35275 | </method> | |
35276 | <method name="SetTopSide" type="" overloaded="no"> | |
781d2982 | 35277 | <autodoc>SetTopSide(self, PyDivisionShape shape)</autodoc> |
f32fc4bc RD |
35278 | <paramlist> |
35279 | <param name="shape" type="PyDivisionShape" default=""/> | |
35280 | </paramlist> | |
35281 | </method> | |
35282 | <method name="SetTopSideColour" type="" overloaded="no"> | |
781d2982 | 35283 | <autodoc>SetTopSideColour(self, String colour)</autodoc> |
f32fc4bc RD |
35284 | <paramlist> |
35285 | <param name="colour" type="String" default=""/> | |
35286 | </paramlist> | |
35287 | </method> | |
35288 | <method name="SetTopSidePen" type="" overloaded="no"> | |
781d2982 | 35289 | <autodoc>SetTopSidePen(self, wxPen pen)</autodoc> |
f32fc4bc RD |
35290 | <paramlist> |
35291 | <param name="pen" type="Pen" default=""/> | |
35292 | </paramlist> | |
35293 | </method> | |
35294 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 35295 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
35296 | </method> |
35297 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 35298 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
35299 | <paramlist> |
35300 | <param name="dc" type="DC" default=""/> | |
35301 | </paramlist> | |
35302 | </method> | |
35303 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 35304 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
35305 | <paramlist> |
35306 | <param name="dc" type="DC" default=""/> | |
35307 | </paramlist> | |
35308 | </method> | |
35309 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 35310 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
35311 | <paramlist> |
35312 | <param name="dc" type="DC" default=""/> | |
35313 | <param name="erase" type="bool" default="FALSE"/> | |
35314 | </paramlist> | |
35315 | </method> | |
35316 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 35317 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
35318 | <paramlist> |
35319 | <param name="dc" type="DC" default=""/> | |
35320 | </paramlist> | |
35321 | </method> | |
35322 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 35323 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
35324 | <paramlist> |
35325 | <param name="dc" type="DC" default=""/> | |
35326 | </paramlist> | |
35327 | </method> | |
35328 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 35329 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
35330 | <paramlist> |
35331 | <param name="dc" type="DC" default=""/> | |
35332 | </paramlist> | |
35333 | </method> | |
35334 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 35335 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
35336 | <paramlist> |
35337 | <param name="dc" type="DC" default=""/> | |
35338 | </paramlist> | |
35339 | </method> | |
35340 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 35341 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35342 | <paramlist> |
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"/> | |
35347 | </paramlist> | |
35348 | </method> | |
35349 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 35350 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35351 | <paramlist> |
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"/> | |
35356 | </paramlist> | |
35357 | </method> | |
35358 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 35359 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35360 | <paramlist> |
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"/> | |
35365 | </paramlist> | |
35366 | </method> | |
35367 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 35368 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
35369 | <paramlist> |
35370 | <param name="x" type="double" default=""/> | |
35371 | <param name="y" type="double" default=""/> | |
35372 | </paramlist> | |
35373 | </method> | |
35374 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 35375 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
35376 | bool display=True) -> bool</autodoc> |
35377 | <paramlist> | |
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"/> | |
35384 | </paramlist> | |
35385 | </method> | |
35386 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 35387 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
35388 | bool display=True)</autodoc> |
35389 | <paramlist> | |
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"/> | |
35396 | </paramlist> | |
35397 | </method> | |
35398 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 35399 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35400 | <paramlist> |
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"/> | |
35406 | </paramlist> | |
35407 | </method> | |
35408 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 35409 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35410 | <paramlist> |
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"/> | |
35415 | </paramlist> | |
35416 | </method> | |
35417 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 35418 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35419 | <paramlist> |
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"/> | |
35424 | </paramlist> | |
35425 | </method> | |
35426 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 35427 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35428 | <paramlist> |
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"/> | |
35434 | </paramlist> | |
35435 | </method> | |
35436 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 35437 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35438 | <paramlist> |
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"/> | |
35443 | </paramlist> | |
35444 | </method> | |
35445 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 35446 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35447 | <paramlist> |
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"/> | |
35452 | </paramlist> | |
35453 | </method> | |
35454 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 35455 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
35456 | <paramlist> |
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=""/> | |
35462 | </paramlist> | |
35463 | </method> | |
35464 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 35465 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
35466 | <paramlist> |
35467 | <param name="dc" type="DC" default=""/> | |
35468 | </paramlist> | |
35469 | </method> | |
35470 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 35471 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
35472 | <paramlist> |
35473 | <param name="dc" type="DC" default=""/> | |
35474 | </paramlist> | |
35475 | </method> | |
35476 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 35477 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
35478 | <paramlist> |
35479 | <param name="dc" type="DC" default=""/> | |
35480 | <param name="moveControlPoints" type="bool" default="True"/> | |
35481 | </paramlist> | |
35482 | </method> | |
35483 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 35484 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
35485 | int attachment=0)</autodoc> |
35486 | <paramlist> | |
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"/> | |
35493 | </paramlist> | |
35494 | </method> | |
35495 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 35496 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
35497 | int attachment=0)</autodoc> |
35498 | <paramlist> | |
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"/> | |
35504 | </paramlist> | |
35505 | </method> | |
35506 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 35507 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
35508 | int attachment=0)</autodoc> |
35509 | <paramlist> | |
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"/> | |
35515 | </paramlist> | |
35516 | </method> | |
35517 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 35518 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
35519 | <paramlist> |
35520 | <param name="w" type="double" default=""/> | |
35521 | <param name="h" type="double" default=""/> | |
35522 | </paramlist> | |
35523 | </method> | |
35524 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 35525 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
35526 | <paramlist> |
35527 | <param name="w" type="double" default=""/> | |
35528 | <param name="h" type="double" default=""/> | |
35529 | </paramlist> | |
35530 | </method> | |
35531 | </class> | |
35532 | <class name="PyEllipseShape" oldname="wxPyEllipseShape" module="ogl"> | |
35533 | <baseclass name="PyShape"/> | |
35534 | <constructor name="PyEllipseShape" overloaded="no"> | |
781d2982 | 35535 | <autodoc>__init__(self, double width=0.0, double height=0.0) -> PyEllipseShape</autodoc> |
f32fc4bc RD |
35536 | <paramlist> |
35537 | <param name="width" type="double" default="0.0"/> | |
35538 | <param name="height" type="double" default="0.0"/> | |
35539 | </paramlist> | |
35540 | </constructor> | |
35541 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 35542 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
35543 | <paramlist> |
35544 | <param name="self" type="PyObject" default=""/> | |
35545 | <param name="_class" type="PyObject" default=""/> | |
35546 | </paramlist> | |
35547 | </method> | |
35548 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 35549 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
35550 | <paramlist> |
35551 | <param name="dc" type="DC" default=""/> | |
35552 | </paramlist> | |
35553 | </method> | |
35554 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 35555 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
35556 | <paramlist> |
35557 | <param name="dc" type="DC" default=""/> | |
35558 | </paramlist> | |
35559 | </method> | |
35560 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 35561 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
35562 | <paramlist> |
35563 | <param name="dc" type="DC" default=""/> | |
35564 | <param name="erase" type="bool" default="FALSE"/> | |
35565 | </paramlist> | |
35566 | </method> | |
35567 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 35568 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
35569 | <paramlist> |
35570 | <param name="dc" type="DC" default=""/> | |
35571 | </paramlist> | |
35572 | </method> | |
35573 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 35574 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
35575 | <paramlist> |
35576 | <param name="dc" type="DC" default=""/> | |
35577 | </paramlist> | |
35578 | </method> | |
35579 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 35580 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
35581 | <paramlist> |
35582 | <param name="dc" type="DC" default=""/> | |
35583 | </paramlist> | |
35584 | </method> | |
35585 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 35586 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
35587 | <paramlist> |
35588 | <param name="dc" type="DC" default=""/> | |
35589 | </paramlist> | |
35590 | </method> | |
35591 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 35592 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35593 | <paramlist> |
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"/> | |
35598 | </paramlist> | |
35599 | </method> | |
35600 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 35601 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35602 | <paramlist> |
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"/> | |
35607 | </paramlist> | |
35608 | </method> | |
35609 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 35610 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35611 | <paramlist> |
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"/> | |
35616 | </paramlist> | |
35617 | </method> | |
35618 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 35619 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
35620 | <paramlist> |
35621 | <param name="x" type="double" default=""/> | |
35622 | <param name="y" type="double" default=""/> | |
35623 | </paramlist> | |
35624 | </method> | |
35625 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 35626 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
35627 | bool display=True) -> bool</autodoc> |
35628 | <paramlist> | |
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"/> | |
35635 | </paramlist> | |
35636 | </method> | |
35637 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 35638 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
35639 | bool display=True)</autodoc> |
35640 | <paramlist> | |
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"/> | |
35647 | </paramlist> | |
35648 | </method> | |
35649 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 35650 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35651 | <paramlist> |
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"/> | |
35657 | </paramlist> | |
35658 | </method> | |
35659 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 35660 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35661 | <paramlist> |
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"/> | |
35666 | </paramlist> | |
35667 | </method> | |
35668 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 35669 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35670 | <paramlist> |
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"/> | |
35675 | </paramlist> | |
35676 | </method> | |
35677 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 35678 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35679 | <paramlist> |
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"/> | |
35685 | </paramlist> | |
35686 | </method> | |
35687 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 35688 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35689 | <paramlist> |
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"/> | |
35694 | </paramlist> | |
35695 | </method> | |
35696 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 35697 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35698 | <paramlist> |
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"/> | |
35703 | </paramlist> | |
35704 | </method> | |
35705 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 35706 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
35707 | <paramlist> |
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=""/> | |
35713 | </paramlist> | |
35714 | </method> | |
35715 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 35716 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
35717 | <paramlist> |
35718 | <param name="dc" type="DC" default=""/> | |
35719 | </paramlist> | |
35720 | </method> | |
35721 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 35722 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
35723 | <paramlist> |
35724 | <param name="dc" type="DC" default=""/> | |
35725 | </paramlist> | |
35726 | </method> | |
35727 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 35728 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
35729 | <paramlist> |
35730 | <param name="dc" type="DC" default=""/> | |
35731 | <param name="moveControlPoints" type="bool" default="True"/> | |
35732 | </paramlist> | |
35733 | </method> | |
35734 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 35735 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
35736 | int attachment=0)</autodoc> |
35737 | <paramlist> | |
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"/> | |
35744 | </paramlist> | |
35745 | </method> | |
35746 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 35747 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
35748 | int attachment=0)</autodoc> |
35749 | <paramlist> | |
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"/> | |
35755 | </paramlist> | |
35756 | </method> | |
35757 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 35758 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
35759 | int attachment=0)</autodoc> |
35760 | <paramlist> | |
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"/> | |
35766 | </paramlist> | |
35767 | </method> | |
35768 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 35769 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
35770 | <paramlist> |
35771 | <param name="w" type="double" default=""/> | |
35772 | <param name="h" type="double" default=""/> | |
35773 | </paramlist> | |
35774 | </method> | |
35775 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 35776 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
35777 | <paramlist> |
35778 | <param name="w" type="double" default=""/> | |
35779 | <param name="h" type="double" default=""/> | |
35780 | </paramlist> | |
35781 | </method> | |
35782 | </class> | |
35783 | <class name="PyCircleShape" oldname="wxPyCircleShape" module="ogl"> | |
35784 | <baseclass name="PyEllipseShape"/> | |
35785 | <constructor name="PyCircleShape" overloaded="no"> | |
781d2982 | 35786 | <autodoc>__init__(self, double width=0.0) -> PyCircleShape</autodoc> |
f32fc4bc RD |
35787 | <paramlist> |
35788 | <param name="width" type="double" default="0.0"/> | |
35789 | </paramlist> | |
35790 | </constructor> | |
35791 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 35792 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
35793 | <paramlist> |
35794 | <param name="self" type="PyObject" default=""/> | |
35795 | <param name="_class" type="PyObject" default=""/> | |
35796 | </paramlist> | |
35797 | </method> | |
35798 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 35799 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
35800 | <paramlist> |
35801 | <param name="dc" type="DC" default=""/> | |
35802 | </paramlist> | |
35803 | </method> | |
35804 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 35805 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
35806 | <paramlist> |
35807 | <param name="dc" type="DC" default=""/> | |
35808 | </paramlist> | |
35809 | </method> | |
35810 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 35811 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
35812 | <paramlist> |
35813 | <param name="dc" type="DC" default=""/> | |
35814 | <param name="erase" type="bool" default="FALSE"/> | |
35815 | </paramlist> | |
35816 | </method> | |
35817 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 35818 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
35819 | <paramlist> |
35820 | <param name="dc" type="DC" default=""/> | |
35821 | </paramlist> | |
35822 | </method> | |
35823 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 35824 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
35825 | <paramlist> |
35826 | <param name="dc" type="DC" default=""/> | |
35827 | </paramlist> | |
35828 | </method> | |
35829 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 35830 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
35831 | <paramlist> |
35832 | <param name="dc" type="DC" default=""/> | |
35833 | </paramlist> | |
35834 | </method> | |
35835 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 35836 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
35837 | <paramlist> |
35838 | <param name="dc" type="DC" default=""/> | |
35839 | </paramlist> | |
35840 | </method> | |
35841 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 35842 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35843 | <paramlist> |
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"/> | |
35848 | </paramlist> | |
35849 | </method> | |
35850 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 35851 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35852 | <paramlist> |
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"/> | |
35857 | </paramlist> | |
35858 | </method> | |
35859 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 35860 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35861 | <paramlist> |
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"/> | |
35866 | </paramlist> | |
35867 | </method> | |
35868 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 35869 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
35870 | <paramlist> |
35871 | <param name="x" type="double" default=""/> | |
35872 | <param name="y" type="double" default=""/> | |
35873 | </paramlist> | |
35874 | </method> | |
35875 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 35876 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
35877 | bool display=True) -> bool</autodoc> |
35878 | <paramlist> | |
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"/> | |
35885 | </paramlist> | |
35886 | </method> | |
35887 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 35888 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
35889 | bool display=True)</autodoc> |
35890 | <paramlist> | |
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"/> | |
35897 | </paramlist> | |
35898 | </method> | |
35899 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 35900 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35901 | <paramlist> |
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"/> | |
35907 | </paramlist> | |
35908 | </method> | |
35909 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 35910 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35911 | <paramlist> |
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"/> | |
35916 | </paramlist> | |
35917 | </method> | |
35918 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 35919 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35920 | <paramlist> |
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"/> | |
35925 | </paramlist> | |
35926 | </method> | |
35927 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 35928 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35929 | <paramlist> |
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"/> | |
35935 | </paramlist> | |
35936 | </method> | |
35937 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 35938 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35939 | <paramlist> |
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"/> | |
35944 | </paramlist> | |
35945 | </method> | |
35946 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 35947 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
35948 | <paramlist> |
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"/> | |
35953 | </paramlist> | |
35954 | </method> | |
35955 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 35956 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
35957 | <paramlist> |
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=""/> | |
35963 | </paramlist> | |
35964 | </method> | |
35965 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 35966 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
35967 | <paramlist> |
35968 | <param name="dc" type="DC" default=""/> | |
35969 | </paramlist> | |
35970 | </method> | |
35971 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 35972 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
35973 | <paramlist> |
35974 | <param name="dc" type="DC" default=""/> | |
35975 | </paramlist> | |
35976 | </method> | |
35977 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 35978 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
35979 | <paramlist> |
35980 | <param name="dc" type="DC" default=""/> | |
35981 | <param name="moveControlPoints" type="bool" default="True"/> | |
35982 | </paramlist> | |
35983 | </method> | |
35984 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 35985 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
35986 | int attachment=0)</autodoc> |
35987 | <paramlist> | |
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"/> | |
35994 | </paramlist> | |
35995 | </method> | |
35996 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 35997 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
35998 | int attachment=0)</autodoc> |
35999 | <paramlist> | |
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"/> | |
36005 | </paramlist> | |
36006 | </method> | |
36007 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 36008 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
36009 | int attachment=0)</autodoc> |
36010 | <paramlist> | |
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"/> | |
36016 | </paramlist> | |
36017 | </method> | |
36018 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 36019 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
36020 | <paramlist> |
36021 | <param name="w" type="double" default=""/> | |
36022 | <param name="h" type="double" default=""/> | |
36023 | </paramlist> | |
36024 | </method> | |
36025 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 36026 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
36027 | <paramlist> |
36028 | <param name="w" type="double" default=""/> | |
36029 | <param name="h" type="double" default=""/> | |
36030 | </paramlist> | |
36031 | </method> | |
36032 | </class> | |
36033 | <class name="ArrowHead" oldname="wxArrowHead" module="ogl"> | |
36034 | <baseclass name="Object"/> | |
36035 | <constructor name="ArrowHead" overloaded="no"> | |
781d2982 | 36036 | <autodoc>__init__(self, int type=0, int end=0, double size=0.0, double dist=0.0, |
f32fc4bc RD |
36037 | String name=EmptyString, PseudoMetaFile mf=None, |
36038 | long arrowId=-1) -> ArrowHead</autodoc> | |
36039 | <paramlist> | |
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"/> | |
36047 | </paramlist> | |
36048 | </constructor> | |
36049 | <destructor name="~wxArrowHead" overloaded="no"> | |
781d2982 | 36050 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
36051 | </destructor> |
36052 | <method name="_GetType" type="int" overloaded="no"> | |
781d2982 | 36053 | <autodoc>_GetType(self) -> int</autodoc> |
f32fc4bc RD |
36054 | </method> |
36055 | <method name="GetPosition" type="int" overloaded="no"> | |
781d2982 | 36056 | <autodoc>GetPosition(self) -> int</autodoc> |
f32fc4bc RD |
36057 | </method> |
36058 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 36059 | <autodoc>SetPosition(self, int pos)</autodoc> |
f32fc4bc RD |
36060 | <paramlist> |
36061 | <param name="pos" type="int" default=""/> | |
36062 | </paramlist> | |
36063 | </method> | |
36064 | <method name="GetXOffset" type="double" overloaded="no"> | |
781d2982 | 36065 | <autodoc>GetXOffset(self) -> double</autodoc> |
f32fc4bc RD |
36066 | </method> |
36067 | <method name="GetYOffset" type="double" overloaded="no"> | |
781d2982 | 36068 | <autodoc>GetYOffset(self) -> double</autodoc> |
f32fc4bc RD |
36069 | </method> |
36070 | <method name="GetSpacing" type="double" overloaded="no"> | |
781d2982 | 36071 | <autodoc>GetSpacing(self) -> double</autodoc> |
f32fc4bc RD |
36072 | </method> |
36073 | <method name="GetSize" type="double" overloaded="no"> | |
781d2982 | 36074 | <autodoc>GetSize(self) -> double</autodoc> |
f32fc4bc RD |
36075 | </method> |
36076 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 36077 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
36078 | </method> |
36079 | <method name="SetXOffset" type="" overloaded="no"> | |
781d2982 | 36080 | <autodoc>SetXOffset(self, double x)</autodoc> |
f32fc4bc RD |
36081 | <paramlist> |
36082 | <param name="x" type="double" default=""/> | |
36083 | </paramlist> | |
36084 | </method> | |
36085 | <method name="SetYOffset" type="" overloaded="no"> | |
781d2982 | 36086 | <autodoc>SetYOffset(self, double y)</autodoc> |
f32fc4bc RD |
36087 | <paramlist> |
36088 | <param name="y" type="double" default=""/> | |
36089 | </paramlist> | |
36090 | </method> | |
36091 | <method name="GetMetaFile" type="PseudoMetaFile" overloaded="no"> | |
781d2982 | 36092 | <autodoc>GetMetaFile(self) -> PseudoMetaFile</autodoc> |
f32fc4bc RD |
36093 | </method> |
36094 | <method name="GetId" type="long" overloaded="no"> | |
781d2982 | 36095 | <autodoc>GetId(self) -> long</autodoc> |
f32fc4bc RD |
36096 | </method> |
36097 | <method name="GetArrowEnd" type="int" overloaded="no"> | |
781d2982 | 36098 | <autodoc>GetArrowEnd(self) -> int</autodoc> |
f32fc4bc RD |
36099 | </method> |
36100 | <method name="GetArrowSize" type="double" overloaded="no"> | |
781d2982 | 36101 | <autodoc>GetArrowSize(self) -> double</autodoc> |
f32fc4bc RD |
36102 | </method> |
36103 | <method name="SetSize" type="" overloaded="no"> | |
781d2982 | 36104 | <autodoc>SetSize(self, double size)</autodoc> |
f32fc4bc RD |
36105 | <paramlist> |
36106 | <param name="size" type="double" default=""/> | |
36107 | </paramlist> | |
36108 | </method> | |
36109 | <method name="SetSpacing" type="" overloaded="no"> | |
781d2982 | 36110 | <autodoc>SetSpacing(self, double sp)</autodoc> |
f32fc4bc RD |
36111 | <paramlist> |
36112 | <param name="sp" type="double" default=""/> | |
36113 | </paramlist> | |
36114 | </method> | |
36115 | </class> | |
36116 | <class name="PyLineShape" oldname="wxPyLineShape" module="ogl"> | |
36117 | <baseclass name="PyShape"/> | |
36118 | <constructor name="PyLineShape" overloaded="no"> | |
781d2982 | 36119 | <autodoc>__init__(self) -> PyLineShape</autodoc> |
f32fc4bc RD |
36120 | </constructor> |
36121 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 36122 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
36123 | <paramlist> |
36124 | <param name="self" type="PyObject" default=""/> | |
36125 | <param name="_class" type="PyObject" default=""/> | |
36126 | </paramlist> | |
36127 | </method> | |
36128 | <method name="AddArrow" type="" overloaded="no"> | |
781d2982 | 36129 | <autodoc>AddArrow(self, int type, int end=ARROW_POSITION_END, double arrowSize=10.0, |
f32fc4bc RD |
36130 | double xOffset=0.0, String name=EmptyString, |
36131 | PseudoMetaFile mf=None, long arrowId=-1)</autodoc> | |
36132 | <paramlist> | |
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"/> | |
36140 | </paramlist> | |
36141 | </method> | |
36142 | <method name="AddArrowOrdered" type="" overloaded="no"> | |
781d2982 | 36143 | <autodoc>AddArrowOrdered(self, ArrowHead arrow, PyObject referenceList, int end)</autodoc> |
f32fc4bc RD |
36144 | <paramlist> |
36145 | <param name="arrow" type="ArrowHead" default=""/> | |
36146 | <param name="referenceList" type="PyObject" default=""/> | |
36147 | <param name="end" type="int" default=""/> | |
36148 | </paramlist> | |
36149 | </method> | |
36150 | <method name="ClearArrow" type="bool" overloaded="no"> | |
781d2982 | 36151 | <autodoc>ClearArrow(self, String name) -> bool</autodoc> |
f32fc4bc RD |
36152 | <paramlist> |
36153 | <param name="name" type="String" default=""/> | |
36154 | </paramlist> | |
36155 | </method> | |
36156 | <method name="ClearArrowsAtPosition" type="" overloaded="no"> | |
781d2982 | 36157 | <autodoc>ClearArrowsAtPosition(self, int position=-1)</autodoc> |
f32fc4bc RD |
36158 | <paramlist> |
36159 | <param name="position" type="int" default="-1"/> | |
36160 | </paramlist> | |
36161 | </method> | |
36162 | <method name="DrawArrow" type="" overloaded="no"> | |
781d2982 | 36163 | <autodoc>DrawArrow(self, DC dc, ArrowHead arrow, double xOffset, bool proportionalOffset)</autodoc> |
f32fc4bc RD |
36164 | <paramlist> |
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=""/> | |
36169 | </paramlist> | |
36170 | </method> | |
36171 | <method name="DeleteArrowHeadId" type="bool" overloaded="no"> | |
781d2982 | 36172 | <autodoc>DeleteArrowHeadId(self, long arrowId) -> bool</autodoc> |
f32fc4bc RD |
36173 | <paramlist> |
36174 | <param name="arrowId" type="long" default=""/> | |
36175 | </paramlist> | |
36176 | </method> | |
36177 | <method name="DeleteArrowHead" type="bool" overloaded="no"> | |
781d2982 | 36178 | <autodoc>DeleteArrowHead(self, int position, String name) -> bool</autodoc> |
f32fc4bc RD |
36179 | <paramlist> |
36180 | <param name="position" type="int" default=""/> | |
36181 | <param name="name" type="String" default=""/> | |
36182 | </paramlist> | |
36183 | </method> | |
36184 | <method name="DeleteLineControlPoint" type="bool" overloaded="no"> | |
781d2982 | 36185 | <autodoc>DeleteLineControlPoint(self) -> bool</autodoc> |
f32fc4bc RD |
36186 | </method> |
36187 | <method name="DrawArrows" type="" overloaded="no"> | |
781d2982 | 36188 | <autodoc>DrawArrows(self, DC dc)</autodoc> |
f32fc4bc RD |
36189 | <paramlist> |
36190 | <param name="dc" type="DC" default=""/> | |
36191 | </paramlist> | |
36192 | </method> | |
36193 | <method name="DrawRegion" type="" overloaded="no"> | |
781d2982 | 36194 | <autodoc>DrawRegion(self, DC dc, ShapeRegion region, double x, double y)</autodoc> |
f32fc4bc RD |
36195 | <paramlist> |
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=""/> | |
36200 | </paramlist> | |
36201 | </method> | |
36202 | <method name="EraseRegion" type="" overloaded="no"> | |
781d2982 | 36203 | <autodoc>EraseRegion(self, DC dc, ShapeRegion region, double x, double y)</autodoc> |
f32fc4bc RD |
36204 | <paramlist> |
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=""/> | |
36209 | </paramlist> | |
36210 | </method> | |
36211 | <method name="FindArrowHeadId" type="ArrowHead" overloaded="no"> | |
781d2982 | 36212 | <autodoc>FindArrowHeadId(self, long arrowId) -> ArrowHead</autodoc> |
f32fc4bc RD |
36213 | <paramlist> |
36214 | <param name="arrowId" type="long" default=""/> | |
36215 | </paramlist> | |
36216 | </method> | |
36217 | <method name="FindArrowHead" type="ArrowHead" overloaded="no"> | |
781d2982 | 36218 | <autodoc>FindArrowHead(self, int position, String name) -> ArrowHead</autodoc> |
f32fc4bc RD |
36219 | <paramlist> |
36220 | <param name="position" type="int" default=""/> | |
36221 | <param name="name" type="String" default=""/> | |
36222 | </paramlist> | |
36223 | </method> | |
36224 | <method name="FindLineEndPoints" type="" overloaded="no"> | |
781d2982 | 36225 | <autodoc>FindLineEndPoints(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
36226 | <paramlist> |
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=""/> | |
36231 | </paramlist> | |
36232 | </method> | |
36233 | <method name="FindLinePosition" type="int" overloaded="no"> | |
781d2982 | 36234 | <autodoc>FindLinePosition(self, double x, double y) -> int</autodoc> |
f32fc4bc RD |
36235 | <paramlist> |
36236 | <param name="x" type="double" default=""/> | |
36237 | <param name="y" type="double" default=""/> | |
36238 | </paramlist> | |
36239 | </method> | |
36240 | <method name="FindMinimumWidth" type="double" overloaded="no"> | |
781d2982 | 36241 | <autodoc>FindMinimumWidth(self) -> double</autodoc> |
f32fc4bc RD |
36242 | </method> |
36243 | <method name="FindNth" type="" overloaded="no"> | |
781d2982 | 36244 | <autodoc>FindNth(self, PyShape image, int OUTPUT, int OUTPUT, bool incoming)</autodoc> |
f32fc4bc RD |
36245 | <paramlist> |
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=""/> | |
36250 | </paramlist> | |
36251 | </method> | |
36252 | <method name="GetAttachmentFrom" type="int" overloaded="no"> | |
781d2982 | 36253 | <autodoc>GetAttachmentFrom(self) -> int</autodoc> |
f32fc4bc RD |
36254 | </method> |
36255 | <method name="GetAttachmentTo" type="int" overloaded="no"> | |
781d2982 | 36256 | <autodoc>GetAttachmentTo(self) -> int</autodoc> |
f32fc4bc RD |
36257 | </method> |
36258 | <method name="GetEnds" type="" overloaded="no"> | |
781d2982 | 36259 | <autodoc>GetEnds(self, double OUTPUT, double OUTPUT, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
36260 | <paramlist> |
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=""/> | |
36265 | </paramlist> | |
36266 | </method> | |
36267 | <method name="GetFrom" type="PyShape" overloaded="no"> | |
781d2982 | 36268 | <autodoc>GetFrom(self) -> PyShape</autodoc> |
f32fc4bc RD |
36269 | </method> |
36270 | <method name="GetLabelPosition" type="" overloaded="no"> | |
781d2982 | 36271 | <autodoc>GetLabelPosition(self, int position, double OUTPUT, double OUTPUT)</autodoc> |
f32fc4bc RD |
36272 | <paramlist> |
36273 | <param name="position" type="int" default=""/> | |
36274 | <param name="OUTPUT" type="double" default=""/> | |
36275 | <param name="OUTPUT" type="double" default=""/> | |
36276 | </paramlist> | |
36277 | </method> | |
36278 | <method name="GetNextControlPoint" type="RealPoint" overloaded="no"> | |
781d2982 | 36279 | <autodoc>GetNextControlPoint(self, PyShape shape) -> RealPoint</autodoc> |
f32fc4bc RD |
36280 | <paramlist> |
36281 | <param name="shape" type="PyShape" default=""/> | |
36282 | </paramlist> | |
36283 | </method> | |
36284 | <method name="GetTo" type="PyShape" overloaded="no"> | |
781d2982 | 36285 | <autodoc>GetTo(self) -> PyShape</autodoc> |
f32fc4bc RD |
36286 | </method> |
36287 | <method name="Initialise" type="" overloaded="no"> | |
781d2982 | 36288 | <autodoc>Initialise(self)</autodoc> |
f32fc4bc RD |
36289 | </method> |
36290 | <method name="InsertLineControlPoint" type="" overloaded="no"> | |
781d2982 | 36291 | <autodoc>InsertLineControlPoint(self, DC dc)</autodoc> |
f32fc4bc RD |
36292 | <paramlist> |
36293 | <param name="dc" type="DC" default=""/> | |
36294 | </paramlist> | |
36295 | </method> | |
36296 | <method name="IsEnd" type="bool" overloaded="no"> | |
781d2982 | 36297 | <autodoc>IsEnd(self, PyShape shape) -> bool</autodoc> |
f32fc4bc RD |
36298 | <paramlist> |
36299 | <param name="shape" type="PyShape" default=""/> | |
36300 | </paramlist> | |
36301 | </method> | |
36302 | <method name="IsSpline" type="bool" overloaded="no"> | |
781d2982 | 36303 | <autodoc>IsSpline(self) -> bool</autodoc> |
f32fc4bc RD |
36304 | </method> |
36305 | <method name="MakeLineControlPoints" type="" overloaded="no"> | |
781d2982 | 36306 | <autodoc>MakeLineControlPoints(self, int n)</autodoc> |
f32fc4bc RD |
36307 | <paramlist> |
36308 | <param name="n" type="int" default=""/> | |
36309 | </paramlist> | |
36310 | </method> | |
36311 | <method name="GetLineControlPoints" type="PyObject" overloaded="no"> | |
781d2982 RD |
36312 | <autodoc>GetLineControlPoints(self) -> PyObject</autodoc> |
36313 | </method> | |
36314 | <method name="SetLineControlPoints" type="" overloaded="no"> | |
36315 | <autodoc>SetLineControlPoints(self, PyObject list)</autodoc> | |
36316 | <paramlist> | |
36317 | <param name="list" type="PyObject" default=""/> | |
36318 | </paramlist> | |
f32fc4bc RD |
36319 | </method> |
36320 | <method name="SetAttachmentFrom" type="" overloaded="no"> | |
781d2982 | 36321 | <autodoc>SetAttachmentFrom(self, int fromAttach)</autodoc> |
f32fc4bc RD |
36322 | <paramlist> |
36323 | <param name="fromAttach" type="int" default=""/> | |
36324 | </paramlist> | |
36325 | </method> | |
36326 | <method name="SetAttachments" type="" overloaded="no"> | |
781d2982 | 36327 | <autodoc>SetAttachments(self, int fromAttach, int toAttach)</autodoc> |
f32fc4bc RD |
36328 | <paramlist> |
36329 | <param name="fromAttach" type="int" default=""/> | |
36330 | <param name="toAttach" type="int" default=""/> | |
36331 | </paramlist> | |
36332 | </method> | |
36333 | <method name="SetAttachmentTo" type="" overloaded="no"> | |
781d2982 | 36334 | <autodoc>SetAttachmentTo(self, int toAttach)</autodoc> |
f32fc4bc RD |
36335 | <paramlist> |
36336 | <param name="toAttach" type="int" default=""/> | |
36337 | </paramlist> | |
36338 | </method> | |
36339 | <method name="SetEnds" type="" overloaded="no"> | |
781d2982 | 36340 | <autodoc>SetEnds(self, double x1, double y1, double x2, double y2)</autodoc> |
f32fc4bc RD |
36341 | <paramlist> |
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=""/> | |
36346 | </paramlist> | |
36347 | </method> | |
36348 | <method name="SetFrom" type="" overloaded="no"> | |
781d2982 | 36349 | <autodoc>SetFrom(self, PyShape object)</autodoc> |
f32fc4bc RD |
36350 | <paramlist> |
36351 | <param name="object" type="PyShape" default=""/> | |
36352 | </paramlist> | |
36353 | </method> | |
36354 | <method name="SetIgnoreOffsets" type="" overloaded="no"> | |
781d2982 | 36355 | <autodoc>SetIgnoreOffsets(self, bool ignore)</autodoc> |
f32fc4bc RD |
36356 | <paramlist> |
36357 | <param name="ignore" type="bool" default=""/> | |
36358 | </paramlist> | |
36359 | </method> | |
36360 | <method name="SetSpline" type="" overloaded="no"> | |
781d2982 | 36361 | <autodoc>SetSpline(self, bool spline)</autodoc> |
f32fc4bc RD |
36362 | <paramlist> |
36363 | <param name="spline" type="bool" default=""/> | |
36364 | </paramlist> | |
36365 | </method> | |
36366 | <method name="SetTo" type="" overloaded="no"> | |
781d2982 | 36367 | <autodoc>SetTo(self, PyShape object)</autodoc> |
f32fc4bc RD |
36368 | <paramlist> |
36369 | <param name="object" type="PyShape" default=""/> | |
36370 | </paramlist> | |
36371 | </method> | |
36372 | <method name="Straighten" type="" overloaded="no"> | |
781d2982 | 36373 | <autodoc>Straighten(self, DC dc=None)</autodoc> |
f32fc4bc RD |
36374 | <paramlist> |
36375 | <param name="dc" type="DC" default="NULL"/> | |
36376 | </paramlist> | |
36377 | </method> | |
36378 | <method name="Unlink" type="" overloaded="no"> | |
781d2982 | 36379 | <autodoc>Unlink(self)</autodoc> |
f32fc4bc RD |
36380 | </method> |
36381 | <method name="SetAlignmentOrientation" type="" overloaded="no"> | |
781d2982 | 36382 | <autodoc>SetAlignmentOrientation(self, bool isEnd, bool isHoriz)</autodoc> |
f32fc4bc RD |
36383 | <paramlist> |
36384 | <param name="isEnd" type="bool" default=""/> | |
36385 | <param name="isHoriz" type="bool" default=""/> | |
36386 | </paramlist> | |
36387 | </method> | |
36388 | <method name="SetAlignmentType" type="" overloaded="no"> | |
781d2982 | 36389 | <autodoc>SetAlignmentType(self, bool isEnd, int alignType)</autodoc> |
f32fc4bc RD |
36390 | <paramlist> |
36391 | <param name="isEnd" type="bool" default=""/> | |
36392 | <param name="alignType" type="int" default=""/> | |
36393 | </paramlist> | |
36394 | </method> | |
36395 | <method name="GetAlignmentOrientation" type="bool" overloaded="no"> | |
781d2982 | 36396 | <autodoc>GetAlignmentOrientation(self, bool isEnd) -> bool</autodoc> |
f32fc4bc RD |
36397 | <paramlist> |
36398 | <param name="isEnd" type="bool" default=""/> | |
36399 | </paramlist> | |
36400 | </method> | |
36401 | <method name="GetAlignmentType" type="int" overloaded="no"> | |
781d2982 | 36402 | <autodoc>GetAlignmentType(self, bool isEnd) -> int</autodoc> |
f32fc4bc RD |
36403 | <paramlist> |
36404 | <param name="isEnd" type="bool" default=""/> | |
36405 | </paramlist> | |
36406 | </method> | |
36407 | <method name="GetAlignmentStart" type="int" overloaded="no"> | |
781d2982 | 36408 | <autodoc>GetAlignmentStart(self) -> int</autodoc> |
f32fc4bc RD |
36409 | </method> |
36410 | <method name="GetAlignmentEnd" type="int" overloaded="no"> | |
781d2982 | 36411 | <autodoc>GetAlignmentEnd(self) -> int</autodoc> |
f32fc4bc RD |
36412 | </method> |
36413 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 36414 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
36415 | <paramlist> |
36416 | <param name="dc" type="DC" default=""/> | |
36417 | </paramlist> | |
36418 | </method> | |
36419 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 36420 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
36421 | <paramlist> |
36422 | <param name="dc" type="DC" default=""/> | |
36423 | </paramlist> | |
36424 | </method> | |
36425 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 36426 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
36427 | <paramlist> |
36428 | <param name="dc" type="DC" default=""/> | |
36429 | <param name="erase" type="bool" default="FALSE"/> | |
36430 | </paramlist> | |
36431 | </method> | |
36432 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 36433 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
36434 | <paramlist> |
36435 | <param name="dc" type="DC" default=""/> | |
36436 | </paramlist> | |
36437 | </method> | |
36438 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 36439 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
36440 | <paramlist> |
36441 | <param name="dc" type="DC" default=""/> | |
36442 | </paramlist> | |
36443 | </method> | |
36444 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 36445 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
36446 | <paramlist> |
36447 | <param name="dc" type="DC" default=""/> | |
36448 | </paramlist> | |
36449 | </method> | |
36450 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 36451 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
36452 | <paramlist> |
36453 | <param name="dc" type="DC" default=""/> | |
36454 | </paramlist> | |
36455 | </method> | |
36456 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 36457 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36458 | <paramlist> |
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"/> | |
36463 | </paramlist> | |
36464 | </method> | |
36465 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 36466 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36467 | <paramlist> |
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"/> | |
36472 | </paramlist> | |
36473 | </method> | |
36474 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 36475 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36476 | <paramlist> |
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"/> | |
36481 | </paramlist> | |
36482 | </method> | |
36483 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 36484 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
36485 | <paramlist> |
36486 | <param name="x" type="double" default=""/> | |
36487 | <param name="y" type="double" default=""/> | |
36488 | </paramlist> | |
36489 | </method> | |
36490 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 36491 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
36492 | bool display=True) -> bool</autodoc> |
36493 | <paramlist> | |
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"/> | |
36500 | </paramlist> | |
36501 | </method> | |
36502 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 36503 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
36504 | bool display=True)</autodoc> |
36505 | <paramlist> | |
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"/> | |
36512 | </paramlist> | |
36513 | </method> | |
36514 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 36515 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36516 | <paramlist> |
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"/> | |
36522 | </paramlist> | |
36523 | </method> | |
36524 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 36525 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36526 | <paramlist> |
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"/> | |
36531 | </paramlist> | |
36532 | </method> | |
36533 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 36534 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36535 | <paramlist> |
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"/> | |
36540 | </paramlist> | |
36541 | </method> | |
36542 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 36543 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36544 | <paramlist> |
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"/> | |
36550 | </paramlist> | |
36551 | </method> | |
36552 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 36553 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36554 | <paramlist> |
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"/> | |
36559 | </paramlist> | |
36560 | </method> | |
36561 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 36562 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36563 | <paramlist> |
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"/> | |
36568 | </paramlist> | |
36569 | </method> | |
36570 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 36571 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
36572 | <paramlist> |
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=""/> | |
36578 | </paramlist> | |
36579 | </method> | |
36580 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 36581 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
36582 | <paramlist> |
36583 | <param name="dc" type="DC" default=""/> | |
36584 | </paramlist> | |
36585 | </method> | |
36586 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 36587 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
36588 | <paramlist> |
36589 | <param name="dc" type="DC" default=""/> | |
36590 | </paramlist> | |
36591 | </method> | |
36592 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 36593 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
36594 | <paramlist> |
36595 | <param name="dc" type="DC" default=""/> | |
36596 | <param name="moveControlPoints" type="bool" default="True"/> | |
36597 | </paramlist> | |
36598 | </method> | |
36599 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 36600 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
36601 | int attachment=0)</autodoc> |
36602 | <paramlist> | |
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"/> | |
36609 | </paramlist> | |
36610 | </method> | |
36611 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 36612 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
36613 | int attachment=0)</autodoc> |
36614 | <paramlist> | |
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"/> | |
36620 | </paramlist> | |
36621 | </method> | |
36622 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 36623 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
36624 | int attachment=0)</autodoc> |
36625 | <paramlist> | |
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"/> | |
36631 | </paramlist> | |
36632 | </method> | |
36633 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 36634 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
36635 | <paramlist> |
36636 | <param name="w" type="double" default=""/> | |
36637 | <param name="h" type="double" default=""/> | |
36638 | </paramlist> | |
36639 | </method> | |
36640 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 36641 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
36642 | <paramlist> |
36643 | <param name="w" type="double" default=""/> | |
36644 | <param name="h" type="double" default=""/> | |
36645 | </paramlist> | |
36646 | </method> | |
36647 | </class> | |
36648 | <class name="PyPolygonShape" oldname="wxPyPolygonShape" module="ogl"> | |
36649 | <baseclass name="PyShape"/> | |
36650 | <constructor name="PyPolygonShape" overloaded="no"> | |
781d2982 | 36651 | <autodoc>__init__(self) -> PyPolygonShape</autodoc> |
f32fc4bc RD |
36652 | </constructor> |
36653 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 36654 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
36655 | <paramlist> |
36656 | <param name="self" type="PyObject" default=""/> | |
36657 | <param name="_class" type="PyObject" default=""/> | |
36658 | </paramlist> | |
36659 | </method> | |
36660 | <method name="Create" type="PyObject" overloaded="no"> | |
781d2982 | 36661 | <autodoc>Create(self, PyObject points) -> PyObject</autodoc> |
f32fc4bc RD |
36662 | <paramlist> |
36663 | <param name="points" type="PyObject" default=""/> | |
36664 | </paramlist> | |
36665 | </method> | |
36666 | <method name="AddPolygonPoint" type="" overloaded="no"> | |
781d2982 | 36667 | <autodoc>AddPolygonPoint(self, int pos=0)</autodoc> |
f32fc4bc RD |
36668 | <paramlist> |
36669 | <param name="pos" type="int" default="0"/> | |
36670 | </paramlist> | |
36671 | </method> | |
36672 | <method name="CalculatePolygonCentre" type="" overloaded="no"> | |
781d2982 | 36673 | <autodoc>CalculatePolygonCentre(self)</autodoc> |
f32fc4bc RD |
36674 | </method> |
36675 | <method name="DeletePolygonPoint" type="" overloaded="no"> | |
781d2982 | 36676 | <autodoc>DeletePolygonPoint(self, int pos=0)</autodoc> |
f32fc4bc RD |
36677 | <paramlist> |
36678 | <param name="pos" type="int" default="0"/> | |
36679 | </paramlist> | |
36680 | </method> | |
36681 | <method name="GetPoints" type="PyObject" overloaded="no"> | |
781d2982 | 36682 | <autodoc>GetPoints(self) -> PyObject</autodoc> |
f32fc4bc RD |
36683 | </method> |
36684 | <method name="GetOriginalPoints" type="PyObject" overloaded="no"> | |
781d2982 | 36685 | <autodoc>GetOriginalPoints(self) -> PyObject</autodoc> |
f32fc4bc RD |
36686 | </method> |
36687 | <method name="GetOriginalWidth" type="double" overloaded="no"> | |
781d2982 | 36688 | <autodoc>GetOriginalWidth(self) -> double</autodoc> |
f32fc4bc RD |
36689 | </method> |
36690 | <method name="GetOriginalHeight" type="double" overloaded="no"> | |
781d2982 | 36691 | <autodoc>GetOriginalHeight(self) -> double</autodoc> |
f32fc4bc RD |
36692 | </method> |
36693 | <method name="SetOriginalWidth" type="" overloaded="no"> | |
781d2982 | 36694 | <autodoc>SetOriginalWidth(self, double w)</autodoc> |
f32fc4bc RD |
36695 | <paramlist> |
36696 | <param name="w" type="double" default=""/> | |
36697 | </paramlist> | |
36698 | </method> | |
36699 | <method name="SetOriginalHeight" type="" overloaded="no"> | |
781d2982 | 36700 | <autodoc>SetOriginalHeight(self, double h)</autodoc> |
f32fc4bc RD |
36701 | <paramlist> |
36702 | <param name="h" type="double" default=""/> | |
36703 | </paramlist> | |
36704 | </method> | |
36705 | <method name="UpdateOriginalPoints" type="" overloaded="no"> | |
781d2982 | 36706 | <autodoc>UpdateOriginalPoints(self)</autodoc> |
f32fc4bc RD |
36707 | </method> |
36708 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 36709 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
36710 | <paramlist> |
36711 | <param name="dc" type="DC" default=""/> | |
36712 | </paramlist> | |
36713 | </method> | |
36714 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 36715 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
36716 | <paramlist> |
36717 | <param name="dc" type="DC" default=""/> | |
36718 | </paramlist> | |
36719 | </method> | |
36720 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 36721 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
36722 | <paramlist> |
36723 | <param name="dc" type="DC" default=""/> | |
36724 | <param name="erase" type="bool" default="FALSE"/> | |
36725 | </paramlist> | |
36726 | </method> | |
36727 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 36728 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
36729 | <paramlist> |
36730 | <param name="dc" type="DC" default=""/> | |
36731 | </paramlist> | |
36732 | </method> | |
36733 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 36734 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
36735 | <paramlist> |
36736 | <param name="dc" type="DC" default=""/> | |
36737 | </paramlist> | |
36738 | </method> | |
36739 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 36740 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
36741 | <paramlist> |
36742 | <param name="dc" type="DC" default=""/> | |
36743 | </paramlist> | |
36744 | </method> | |
36745 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 36746 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
36747 | <paramlist> |
36748 | <param name="dc" type="DC" default=""/> | |
36749 | </paramlist> | |
36750 | </method> | |
36751 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 36752 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36753 | <paramlist> |
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"/> | |
36758 | </paramlist> | |
36759 | </method> | |
36760 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 36761 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36762 | <paramlist> |
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"/> | |
36767 | </paramlist> | |
36768 | </method> | |
36769 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 36770 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36771 | <paramlist> |
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"/> | |
36776 | </paramlist> | |
36777 | </method> | |
36778 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 36779 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
36780 | <paramlist> |
36781 | <param name="x" type="double" default=""/> | |
36782 | <param name="y" type="double" default=""/> | |
36783 | </paramlist> | |
36784 | </method> | |
36785 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 36786 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
36787 | bool display=True) -> bool</autodoc> |
36788 | <paramlist> | |
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"/> | |
36795 | </paramlist> | |
36796 | </method> | |
36797 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 36798 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
36799 | bool display=True)</autodoc> |
36800 | <paramlist> | |
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"/> | |
36807 | </paramlist> | |
36808 | </method> | |
36809 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 36810 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36811 | <paramlist> |
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"/> | |
36817 | </paramlist> | |
36818 | </method> | |
36819 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 36820 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36821 | <paramlist> |
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"/> | |
36826 | </paramlist> | |
36827 | </method> | |
36828 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 36829 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36830 | <paramlist> |
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"/> | |
36835 | </paramlist> | |
36836 | </method> | |
36837 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 36838 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36839 | <paramlist> |
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"/> | |
36845 | </paramlist> | |
36846 | </method> | |
36847 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 36848 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36849 | <paramlist> |
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"/> | |
36854 | </paramlist> | |
36855 | </method> | |
36856 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 36857 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
36858 | <paramlist> |
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"/> | |
36863 | </paramlist> | |
36864 | </method> | |
36865 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 36866 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
36867 | <paramlist> |
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=""/> | |
36873 | </paramlist> | |
36874 | </method> | |
36875 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 36876 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
36877 | <paramlist> |
36878 | <param name="dc" type="DC" default=""/> | |
36879 | </paramlist> | |
36880 | </method> | |
36881 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 36882 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
36883 | <paramlist> |
36884 | <param name="dc" type="DC" default=""/> | |
36885 | </paramlist> | |
36886 | </method> | |
36887 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 36888 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
36889 | <paramlist> |
36890 | <param name="dc" type="DC" default=""/> | |
36891 | <param name="moveControlPoints" type="bool" default="True"/> | |
36892 | </paramlist> | |
36893 | </method> | |
36894 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 36895 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
36896 | int attachment=0)</autodoc> |
36897 | <paramlist> | |
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"/> | |
36904 | </paramlist> | |
36905 | </method> | |
36906 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 36907 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
36908 | int attachment=0)</autodoc> |
36909 | <paramlist> | |
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"/> | |
36915 | </paramlist> | |
36916 | </method> | |
36917 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 36918 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
36919 | int attachment=0)</autodoc> |
36920 | <paramlist> | |
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"/> | |
36926 | </paramlist> | |
36927 | </method> | |
36928 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 36929 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
36930 | <paramlist> |
36931 | <param name="w" type="double" default=""/> | |
36932 | <param name="h" type="double" default=""/> | |
36933 | </paramlist> | |
36934 | </method> | |
36935 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 36936 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
36937 | <paramlist> |
36938 | <param name="w" type="double" default=""/> | |
36939 | <param name="h" type="double" default=""/> | |
36940 | </paramlist> | |
36941 | </method> | |
36942 | </class> | |
36943 | <class name="PyTextShape" oldname="wxPyTextShape" module="ogl"> | |
36944 | <baseclass name="PyRectangleShape"/> | |
36945 | <constructor name="PyTextShape" overloaded="no"> | |
781d2982 | 36946 | <autodoc>__init__(self, double width=0.0, double height=0.0) -> PyTextShape</autodoc> |
f32fc4bc RD |
36947 | <paramlist> |
36948 | <param name="width" type="double" default="0.0"/> | |
36949 | <param name="height" type="double" default="0.0"/> | |
36950 | </paramlist> | |
36951 | </constructor> | |
36952 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 36953 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
36954 | <paramlist> |
36955 | <param name="self" type="PyObject" default=""/> | |
36956 | <param name="_class" type="PyObject" default=""/> | |
36957 | </paramlist> | |
36958 | </method> | |
36959 | <method name="base_OnDelete" type="" overloaded="no"> | |
781d2982 | 36960 | <autodoc>base_OnDelete(self)</autodoc> |
f32fc4bc RD |
36961 | </method> |
36962 | <method name="base_OnDraw" type="" overloaded="no"> | |
781d2982 | 36963 | <autodoc>base_OnDraw(self, DC dc)</autodoc> |
f32fc4bc RD |
36964 | <paramlist> |
36965 | <param name="dc" type="DC" default=""/> | |
36966 | </paramlist> | |
36967 | </method> | |
36968 | <method name="base_OnDrawContents" type="" overloaded="no"> | |
781d2982 | 36969 | <autodoc>base_OnDrawContents(self, DC dc)</autodoc> |
f32fc4bc RD |
36970 | <paramlist> |
36971 | <param name="dc" type="DC" default=""/> | |
36972 | </paramlist> | |
36973 | </method> | |
36974 | <method name="base_OnDrawBranches" type="" overloaded="no"> | |
781d2982 | 36975 | <autodoc>base_OnDrawBranches(self, DC dc, bool erase=FALSE)</autodoc> |
f32fc4bc RD |
36976 | <paramlist> |
36977 | <param name="dc" type="DC" default=""/> | |
36978 | <param name="erase" type="bool" default="FALSE"/> | |
36979 | </paramlist> | |
36980 | </method> | |
36981 | <method name="base_OnMoveLinks" type="" overloaded="no"> | |
781d2982 | 36982 | <autodoc>base_OnMoveLinks(self, DC dc)</autodoc> |
f32fc4bc RD |
36983 | <paramlist> |
36984 | <param name="dc" type="DC" default=""/> | |
36985 | </paramlist> | |
36986 | </method> | |
36987 | <method name="base_OnErase" type="" overloaded="no"> | |
781d2982 | 36988 | <autodoc>base_OnErase(self, DC dc)</autodoc> |
f32fc4bc RD |
36989 | <paramlist> |
36990 | <param name="dc" type="DC" default=""/> | |
36991 | </paramlist> | |
36992 | </method> | |
36993 | <method name="base_OnEraseContents" type="" overloaded="no"> | |
781d2982 | 36994 | <autodoc>base_OnEraseContents(self, DC dc)</autodoc> |
f32fc4bc RD |
36995 | <paramlist> |
36996 | <param name="dc" type="DC" default=""/> | |
36997 | </paramlist> | |
36998 | </method> | |
36999 | <method name="base_OnHighlight" type="" overloaded="no"> | |
781d2982 | 37000 | <autodoc>base_OnHighlight(self, DC dc)</autodoc> |
f32fc4bc RD |
37001 | <paramlist> |
37002 | <param name="dc" type="DC" default=""/> | |
37003 | </paramlist> | |
37004 | </method> | |
37005 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 37006 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37007 | <paramlist> |
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"/> | |
37012 | </paramlist> | |
37013 | </method> | |
37014 | <method name="base_OnLeftDoubleClick" type="" overloaded="no"> | |
781d2982 | 37015 | <autodoc>base_OnLeftDoubleClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37016 | <paramlist> |
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"/> | |
37021 | </paramlist> | |
37022 | </method> | |
37023 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 37024 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37025 | <paramlist> |
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"/> | |
37030 | </paramlist> | |
37031 | </method> | |
37032 | <method name="base_OnSize" type="" overloaded="no"> | |
781d2982 | 37033 | <autodoc>base_OnSize(self, double x, double y)</autodoc> |
f32fc4bc RD |
37034 | <paramlist> |
37035 | <param name="x" type="double" default=""/> | |
37036 | <param name="y" type="double" default=""/> | |
37037 | </paramlist> | |
37038 | </method> | |
37039 | <method name="base_OnMovePre" type="bool" overloaded="no"> | |
781d2982 | 37040 | <autodoc>base_OnMovePre(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
37041 | bool display=True) -> bool</autodoc> |
37042 | <paramlist> | |
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"/> | |
37049 | </paramlist> | |
37050 | </method> | |
37051 | <method name="base_OnMovePost" type="" overloaded="no"> | |
781d2982 | 37052 | <autodoc>base_OnMovePost(self, DC dc, double x, double y, double old_x, double old_y, |
f32fc4bc RD |
37053 | bool display=True)</autodoc> |
37054 | <paramlist> | |
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"/> | |
37061 | </paramlist> | |
37062 | </method> | |
37063 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 37064 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37065 | <paramlist> |
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"/> | |
37071 | </paramlist> | |
37072 | </method> | |
37073 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 37074 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37075 | <paramlist> |
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"/> | |
37080 | </paramlist> | |
37081 | </method> | |
37082 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 37083 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37084 | <paramlist> |
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"/> | |
37089 | </paramlist> | |
37090 | </method> | |
37091 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 37092 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37093 | <paramlist> |
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"/> | |
37099 | </paramlist> | |
37100 | </method> | |
37101 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 37102 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37103 | <paramlist> |
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"/> | |
37108 | </paramlist> | |
37109 | </method> | |
37110 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 37111 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0, int attachment=0)</autodoc> |
f32fc4bc RD |
37112 | <paramlist> |
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"/> | |
37117 | </paramlist> | |
37118 | </method> | |
37119 | <method name="base_OnDrawOutline" type="" overloaded="no"> | |
781d2982 | 37120 | <autodoc>base_OnDrawOutline(self, DC dc, double x, double y, double w, double h)</autodoc> |
f32fc4bc RD |
37121 | <paramlist> |
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=""/> | |
37127 | </paramlist> | |
37128 | </method> | |
37129 | <method name="base_OnDrawControlPoints" type="" overloaded="no"> | |
781d2982 | 37130 | <autodoc>base_OnDrawControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
37131 | <paramlist> |
37132 | <param name="dc" type="DC" default=""/> | |
37133 | </paramlist> | |
37134 | </method> | |
37135 | <method name="base_OnEraseControlPoints" type="" overloaded="no"> | |
781d2982 | 37136 | <autodoc>base_OnEraseControlPoints(self, DC dc)</autodoc> |
f32fc4bc RD |
37137 | <paramlist> |
37138 | <param name="dc" type="DC" default=""/> | |
37139 | </paramlist> | |
37140 | </method> | |
37141 | <method name="base_OnMoveLink" type="" overloaded="no"> | |
781d2982 | 37142 | <autodoc>base_OnMoveLink(self, DC dc, bool moveControlPoints=True)</autodoc> |
f32fc4bc RD |
37143 | <paramlist> |
37144 | <param name="dc" type="DC" default=""/> | |
37145 | <param name="moveControlPoints" type="bool" default="True"/> | |
37146 | </paramlist> | |
37147 | </method> | |
37148 | <method name="base_OnSizingDragLeft" type="" overloaded="no"> | |
781d2982 | 37149 | <autodoc>base_OnSizingDragLeft(self, PyControlPoint pt, bool draw, double x, double y, int keys=0, |
f32fc4bc RD |
37150 | int attachment=0)</autodoc> |
37151 | <paramlist> | |
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"/> | |
37158 | </paramlist> | |
37159 | </method> | |
37160 | <method name="base_OnSizingBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 37161 | <autodoc>base_OnSizingBeginDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
37162 | int attachment=0)</autodoc> |
37163 | <paramlist> | |
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"/> | |
37169 | </paramlist> | |
37170 | </method> | |
37171 | <method name="base_OnSizingEndDragLeft" type="" overloaded="no"> | |
781d2982 | 37172 | <autodoc>base_OnSizingEndDragLeft(self, PyControlPoint pt, double x, double y, int keys=0, |
f32fc4bc RD |
37173 | int attachment=0)</autodoc> |
37174 | <paramlist> | |
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"/> | |
37180 | </paramlist> | |
37181 | </method> | |
37182 | <method name="base_OnBeginSize" type="" overloaded="no"> | |
781d2982 | 37183 | <autodoc>base_OnBeginSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
37184 | <paramlist> |
37185 | <param name="w" type="double" default=""/> | |
37186 | <param name="h" type="double" default=""/> | |
37187 | </paramlist> | |
37188 | </method> | |
37189 | <method name="base_OnEndSize" type="" overloaded="no"> | |
781d2982 | 37190 | <autodoc>base_OnEndSize(self, double w, double h)</autodoc> |
f32fc4bc RD |
37191 | <paramlist> |
37192 | <param name="w" type="double" default=""/> | |
37193 | <param name="h" type="double" default=""/> | |
37194 | </paramlist> | |
37195 | </method> | |
37196 | </class> | |
37197 | <class name="Diagram" oldname="wxDiagram" module="ogl"> | |
37198 | <baseclass name="Object"/> | |
37199 | <constructor name="Diagram" overloaded="no"> | |
781d2982 | 37200 | <autodoc>__init__(self) -> Diagram</autodoc> |
f32fc4bc RD |
37201 | </constructor> |
37202 | <method name="AddShape" type="" overloaded="no"> | |
781d2982 | 37203 | <autodoc>AddShape(self, PyShape shape, PyShape addAfter=None)</autodoc> |
f32fc4bc RD |
37204 | <paramlist> |
37205 | <param name="shape" type="PyShape" default=""/> | |
37206 | <param name="addAfter" type="PyShape" default="NULL"/> | |
37207 | </paramlist> | |
37208 | </method> | |
37209 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 37210 | <autodoc>Clear(self, DC dc)</autodoc> |
f32fc4bc RD |
37211 | <paramlist> |
37212 | <param name="dc" type="DC" default=""/> | |
37213 | </paramlist> | |
37214 | </method> | |
37215 | <method name="DeleteAllShapes" type="" overloaded="no"> | |
781d2982 | 37216 | <autodoc>DeleteAllShapes(self)</autodoc> |
f32fc4bc RD |
37217 | </method> |
37218 | <method name="DrawOutline" type="" overloaded="no"> | |
781d2982 | 37219 | <autodoc>DrawOutline(self, DC dc, double x1, double y1, double x2, double y2)</autodoc> |
f32fc4bc RD |
37220 | <paramlist> |
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=""/> | |
37226 | </paramlist> | |
37227 | </method> | |
37228 | <method name="FindShape" type="PyShape" overloaded="no"> | |
781d2982 | 37229 | <autodoc>FindShape(self, long id) -> PyShape</autodoc> |
f32fc4bc RD |
37230 | <paramlist> |
37231 | <param name="id" type="long" default=""/> | |
37232 | </paramlist> | |
37233 | </method> | |
37234 | <method name="GetCanvas" type="wxPyShapeCanvas" overloaded="no"> | |
781d2982 | 37235 | <autodoc>GetCanvas(self) -> PyShapeCanvas</autodoc> |
f32fc4bc RD |
37236 | </method> |
37237 | <method name="GetCount" type="int" overloaded="no"> | |
781d2982 | 37238 | <autodoc>GetCount(self) -> int</autodoc> |
f32fc4bc RD |
37239 | </method> |
37240 | <method name="GetGridSpacing" type="double" overloaded="no"> | |
781d2982 | 37241 | <autodoc>GetGridSpacing(self) -> double</autodoc> |
f32fc4bc RD |
37242 | </method> |
37243 | <method name="GetMouseTolerance" type="int" overloaded="no"> | |
781d2982 | 37244 | <autodoc>GetMouseTolerance(self) -> int</autodoc> |
f32fc4bc RD |
37245 | </method> |
37246 | <method name="GetShapeList" type="PyObject" overloaded="no"> | |
781d2982 | 37247 | <autodoc>GetShapeList(self) -> PyObject</autodoc> |
f32fc4bc RD |
37248 | </method> |
37249 | <method name="GetQuickEditMode" type="bool" overloaded="no"> | |
781d2982 | 37250 | <autodoc>GetQuickEditMode(self) -> bool</autodoc> |
f32fc4bc RD |
37251 | </method> |
37252 | <method name="GetSnapToGrid" type="bool" overloaded="no"> | |
781d2982 | 37253 | <autodoc>GetSnapToGrid(self) -> bool</autodoc> |
f32fc4bc RD |
37254 | </method> |
37255 | <method name="InsertShape" type="" overloaded="no"> | |
781d2982 | 37256 | <autodoc>InsertShape(self, PyShape shape)</autodoc> |
f32fc4bc RD |
37257 | <paramlist> |
37258 | <param name="shape" type="PyShape" default=""/> | |
37259 | </paramlist> | |
37260 | </method> | |
37261 | <method name="RecentreAll" type="" overloaded="no"> | |
781d2982 | 37262 | <autodoc>RecentreAll(self, DC dc)</autodoc> |
f32fc4bc RD |
37263 | <paramlist> |
37264 | <param name="dc" type="DC" default=""/> | |
37265 | </paramlist> | |
37266 | </method> | |
37267 | <method name="Redraw" type="" overloaded="no"> | |
781d2982 | 37268 | <autodoc>Redraw(self, DC dc)</autodoc> |
f32fc4bc RD |
37269 | <paramlist> |
37270 | <param name="dc" type="DC" default=""/> | |
37271 | </paramlist> | |
37272 | </method> | |
37273 | <method name="RemoveAllShapes" type="" overloaded="no"> | |
781d2982 | 37274 | <autodoc>RemoveAllShapes(self)</autodoc> |
f32fc4bc RD |
37275 | </method> |
37276 | <method name="RemoveShape" type="" overloaded="no"> | |
781d2982 | 37277 | <autodoc>RemoveShape(self, PyShape shape)</autodoc> |
f32fc4bc RD |
37278 | <paramlist> |
37279 | <param name="shape" type="PyShape" default=""/> | |
37280 | </paramlist> | |
37281 | </method> | |
37282 | <method name="SetCanvas" type="" overloaded="no"> | |
781d2982 | 37283 | <autodoc>SetCanvas(self, PyShapeCanvas canvas)</autodoc> |
f32fc4bc RD |
37284 | <paramlist> |
37285 | <param name="canvas" type="wxPyShapeCanvas" default=""/> | |
37286 | </paramlist> | |
37287 | </method> | |
37288 | <method name="SetGridSpacing" type="" overloaded="no"> | |
781d2982 | 37289 | <autodoc>SetGridSpacing(self, double spacing)</autodoc> |
f32fc4bc RD |
37290 | <paramlist> |
37291 | <param name="spacing" type="double" default=""/> | |
37292 | </paramlist> | |
37293 | </method> | |
37294 | <method name="SetMouseTolerance" type="" overloaded="no"> | |
781d2982 | 37295 | <autodoc>SetMouseTolerance(self, int tolerance)</autodoc> |
f32fc4bc RD |
37296 | <paramlist> |
37297 | <param name="tolerance" type="int" default=""/> | |
37298 | </paramlist> | |
37299 | </method> | |
37300 | <method name="SetQuickEditMode" type="" overloaded="no"> | |
781d2982 | 37301 | <autodoc>SetQuickEditMode(self, bool mode)</autodoc> |
f32fc4bc RD |
37302 | <paramlist> |
37303 | <param name="mode" type="bool" default=""/> | |
37304 | </paramlist> | |
37305 | </method> | |
37306 | <method name="SetSnapToGrid" type="" overloaded="no"> | |
781d2982 | 37307 | <autodoc>SetSnapToGrid(self, bool snap)</autodoc> |
f32fc4bc RD |
37308 | <paramlist> |
37309 | <param name="snap" type="bool" default=""/> | |
37310 | </paramlist> | |
37311 | </method> | |
37312 | <method name="ShowAll" type="" overloaded="no"> | |
781d2982 | 37313 | <autodoc>ShowAll(self, bool show)</autodoc> |
f32fc4bc RD |
37314 | <paramlist> |
37315 | <param name="show" type="bool" default=""/> | |
37316 | </paramlist> | |
37317 | </method> | |
37318 | <method name="Snap" type="" overloaded="no"> | |
781d2982 | 37319 | <autodoc>Snap(self, double INOUT, double INOUT)</autodoc> |
f32fc4bc RD |
37320 | <paramlist> |
37321 | <param name="INOUT" type="double" default=""/> | |
37322 | <param name="INOUT" type="double" default=""/> | |
37323 | </paramlist> | |
37324 | </method> | |
37325 | </class> | |
37326 | <class name="PyShapeCanvas" oldname="wxPyShapeCanvas" module="ogl"> | |
37327 | <baseclass name="ScrolledWindow"/> | |
37328 | <constructor name="PyShapeCanvas" overloaded="no"> | |
781d2982 | 37329 | <autodoc>__init__(self, Window parent=None, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
37330 | Size size=DefaultSize, long style=BORDER, |
37331 | String name=wxPyShapeCanvasNameStr) -> PyShapeCanvas</autodoc> | |
37332 | <paramlist> | |
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"/> | |
37339 | </paramlist> | |
37340 | </constructor> | |
37341 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 37342 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
37343 | <paramlist> |
37344 | <param name="self" type="PyObject" default=""/> | |
37345 | <param name="_class" type="PyObject" default=""/> | |
37346 | </paramlist> | |
37347 | </method> | |
37348 | <method name="AddShape" type="" overloaded="no"> | |
781d2982 | 37349 | <autodoc>AddShape(self, PyShape shape, PyShape addAfter=None)</autodoc> |
f32fc4bc RD |
37350 | <paramlist> |
37351 | <param name="shape" type="PyShape" default=""/> | |
37352 | <param name="addAfter" type="PyShape" default="NULL"/> | |
37353 | </paramlist> | |
37354 | </method> | |
37355 | <method name="FindShape" type="PyShape" overloaded="no"> | |
781d2982 | 37356 | <autodoc>FindShape(self, double x1, double y, int OUTPUT, wxClassInfo info=None, |
f32fc4bc RD |
37357 | PyShape notImage=None) -> PyShape</autodoc> |
37358 | <paramlist> | |
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"/> | |
37364 | </paramlist> | |
37365 | </method> | |
37366 | <method name="FindFirstSensitiveShape" type="PyShape" overloaded="no"> | |
781d2982 | 37367 | <autodoc>FindFirstSensitiveShape(self, double x1, double y, int OUTPUT, int op) -> PyShape</autodoc> |
f32fc4bc RD |
37368 | <paramlist> |
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=""/> | |
37373 | </paramlist> | |
37374 | </method> | |
37375 | <method name="GetDiagram" type="Diagram" overloaded="no"> | |
781d2982 | 37376 | <autodoc>GetDiagram(self) -> Diagram</autodoc> |
f32fc4bc RD |
37377 | </method> |
37378 | <method name="GetQuickEditMode" type="bool" overloaded="no"> | |
781d2982 | 37379 | <autodoc>GetQuickEditMode(self) -> bool</autodoc> |
f32fc4bc RD |
37380 | </method> |
37381 | <method name="InsertShape" type="" overloaded="no"> | |
781d2982 | 37382 | <autodoc>InsertShape(self, PyShape shape)</autodoc> |
f32fc4bc RD |
37383 | <paramlist> |
37384 | <param name="shape" type="PyShape" default=""/> | |
37385 | </paramlist> | |
37386 | </method> | |
37387 | <method name="base_OnBeginDragLeft" type="" overloaded="no"> | |
781d2982 | 37388 | <autodoc>base_OnBeginDragLeft(self, double x, double y, int keys=0)</autodoc> |
f32fc4bc RD |
37389 | <paramlist> |
37390 | <param name="x" type="double" default=""/> | |
37391 | <param name="y" type="double" default=""/> | |
37392 | <param name="keys" type="int" default="0"/> | |
37393 | </paramlist> | |
37394 | </method> | |
37395 | <method name="base_OnBeginDragRight" type="" overloaded="no"> | |
781d2982 | 37396 | <autodoc>base_OnBeginDragRight(self, double x, double y, int keys=0)</autodoc> |
f32fc4bc RD |
37397 | <paramlist> |
37398 | <param name="x" type="double" default=""/> | |
37399 | <param name="y" type="double" default=""/> | |
37400 | <param name="keys" type="int" default="0"/> | |
37401 | </paramlist> | |
37402 | </method> | |
37403 | <method name="base_OnEndDragLeft" type="" overloaded="no"> | |
781d2982 | 37404 | <autodoc>base_OnEndDragLeft(self, double x, double y, int keys=0)</autodoc> |
f32fc4bc RD |
37405 | <paramlist> |
37406 | <param name="x" type="double" default=""/> | |
37407 | <param name="y" type="double" default=""/> | |
37408 | <param name="keys" type="int" default="0"/> | |
37409 | </paramlist> | |
37410 | </method> | |
37411 | <method name="base_OnEndDragRight" type="" overloaded="no"> | |
781d2982 | 37412 | <autodoc>base_OnEndDragRight(self, double x, double y, int keys=0)</autodoc> |
f32fc4bc RD |
37413 | <paramlist> |
37414 | <param name="x" type="double" default=""/> | |
37415 | <param name="y" type="double" default=""/> | |
37416 | <param name="keys" type="int" default="0"/> | |
37417 | </paramlist> | |
37418 | </method> | |
37419 | <method name="base_OnDragLeft" type="" overloaded="no"> | |
781d2982 | 37420 | <autodoc>base_OnDragLeft(self, bool draw, double x, double y, int keys=0)</autodoc> |
f32fc4bc RD |
37421 | <paramlist> |
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"/> | |
37426 | </paramlist> | |
37427 | </method> | |
37428 | <method name="base_OnDragRight" type="" overloaded="no"> | |
781d2982 | 37429 | <autodoc>base_OnDragRight(self, bool draw, double x, double y, int keys=0)</autodoc> |
f32fc4bc RD |
37430 | <paramlist> |
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"/> | |
37435 | </paramlist> | |
37436 | </method> | |
37437 | <method name="base_OnLeftClick" type="" overloaded="no"> | |
781d2982 | 37438 | <autodoc>base_OnLeftClick(self, double x, double y, int keys=0)</autodoc> |
f32fc4bc RD |
37439 | <paramlist> |
37440 | <param name="x" type="double" default=""/> | |
37441 | <param name="y" type="double" default=""/> | |
37442 | <param name="keys" type="int" default="0"/> | |
37443 | </paramlist> | |
37444 | </method> | |
37445 | <method name="base_OnRightClick" type="" overloaded="no"> | |
781d2982 | 37446 | <autodoc>base_OnRightClick(self, double x, double y, int keys=0)</autodoc> |
f32fc4bc RD |
37447 | <paramlist> |
37448 | <param name="x" type="double" default=""/> | |
37449 | <param name="y" type="double" default=""/> | |
37450 | <param name="keys" type="int" default="0"/> | |
37451 | </paramlist> | |
37452 | </method> | |
37453 | <method name="Redraw" type="" overloaded="no"> | |
781d2982 | 37454 | <autodoc>Redraw(self, DC dc)</autodoc> |
f32fc4bc RD |
37455 | <paramlist> |
37456 | <param name="dc" type="DC" default=""/> | |
37457 | </paramlist> | |
37458 | </method> | |
37459 | <method name="RemoveShape" type="" overloaded="no"> | |
781d2982 | 37460 | <autodoc>RemoveShape(self, PyShape shape)</autodoc> |
f32fc4bc RD |
37461 | <paramlist> |
37462 | <param name="shape" type="PyShape" default=""/> | |
37463 | </paramlist> | |
37464 | </method> | |
37465 | <method name="SetDiagram" type="" overloaded="no"> | |
781d2982 | 37466 | <autodoc>SetDiagram(self, Diagram diagram)</autodoc> |
f32fc4bc RD |
37467 | <paramlist> |
37468 | <param name="diagram" type="Diagram" default=""/> | |
37469 | </paramlist> | |
37470 | </method> | |
37471 | <method name="Snap" type="" overloaded="no"> | |
781d2982 | 37472 | <autodoc>Snap(self, double INOUT, double INOUT)</autodoc> |
f32fc4bc RD |
37473 | <paramlist> |
37474 | <param name="INOUT" type="double" default=""/> | |
37475 | <param name="INOUT" type="double" default=""/> | |
37476 | </paramlist> | |
37477 | </method> | |
37478 | </class> | |
37479 | <pythoncode> | |
37480 | # Aliases | |
37481 | ShapeCanvas = PyShapeCanvas | |
37482 | ShapeEvtHandler = PyShapeEvtHandler | |
37483 | Shape = PyShape | |
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 | |
37496 | </pythoncode> | |
37497 | <method name="OGLInitialize" oldname="wxOGLInitialize" type="" overloaded="no"> | |
37498 | <autodoc>OGLInitialize()</autodoc> | |
37499 | </method> | |
37500 | <method name="OGLCleanUp" oldname="wxOGLCleanUp" type="" overloaded="no"> | |
37501 | <autodoc>OGLCleanUp()</autodoc> | |
37502 | </method> | |
37503 | </module> | |
37504 | <module name="stc"> | |
781d2982 RD |
37505 | <import name="_core"/> |
37506 | <import name="_misc"/> | |
37507 | <pythoncode> wx = _core </pythoncode> | |
37508 | <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode> | |
f32fc4bc RD |
37509 | <class name="StyledTextCtrl" oldname="wxStyledTextCtrl" module="stc"> |
37510 | <baseclass name="Control"/> | |
37511 | <constructor name="StyledTextCtrl" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
37514 | <paramlist> |
37515 | <param name="parent" type="Window" default=""/> | |
781d2982 | 37516 | <param name="id" type="int" default="wxID_ANY"/> |
f32fc4bc RD |
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"/> | |
37521 | </paramlist> | |
37522 | </constructor> | |
37523 | <constructor name="PreStyledTextCtrl" overloaded="no"> | |
37524 | <autodoc>PreStyledTextCtrl() -> StyledTextCtrl</autodoc> | |
37525 | </constructor> | |
37526 | <method name="Create" type="" overloaded="no"> | |
781d2982 RD |
37527 | <autodoc>Create(self, Window parent, int id=ID_ANY, Point pos=DefaultPosition, |
37528 | Size size=DefaultSize, long style=0, String name=wxSTCNameStr)</autodoc> | |
f32fc4bc RD |
37529 | <paramlist> |
37530 | <param name="parent" type="Window" default=""/> | |
781d2982 | 37531 | <param name="id" type="int" default="wxID_ANY"/> |
f32fc4bc RD |
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"/> | |
37536 | </paramlist> | |
37537 | </method> | |
37538 | <method name="AddText" type="" overloaded="no"> | |
781d2982 | 37539 | <autodoc>AddText(self, String text)</autodoc> |
f32fc4bc RD |
37540 | <paramlist> |
37541 | <param name="text" type="String" default=""/> | |
37542 | </paramlist> | |
37543 | </method> | |
37544 | <method name="AddStyledText" type="" overloaded="no"> | |
781d2982 | 37545 | <autodoc>AddStyledText(self, wxMemoryBuffer data)</autodoc> |
f32fc4bc RD |
37546 | <paramlist> |
37547 | <param name="data" type="wxMemoryBuffer" default=""/> | |
37548 | </paramlist> | |
37549 | </method> | |
37550 | <method name="InsertText" type="" overloaded="no"> | |
781d2982 | 37551 | <autodoc>InsertText(self, int pos, String text)</autodoc> |
f32fc4bc RD |
37552 | <paramlist> |
37553 | <param name="pos" type="int" default=""/> | |
37554 | <param name="text" type="String" default=""/> | |
37555 | </paramlist> | |
37556 | </method> | |
37557 | <method name="ClearAll" type="" overloaded="no"> | |
781d2982 | 37558 | <autodoc>ClearAll(self)</autodoc> |
f32fc4bc RD |
37559 | </method> |
37560 | <method name="ClearDocumentStyle" type="" overloaded="no"> | |
781d2982 | 37561 | <autodoc>ClearDocumentStyle(self)</autodoc> |
f32fc4bc RD |
37562 | </method> |
37563 | <method name="GetLength" type="int" overloaded="no"> | |
781d2982 | 37564 | <autodoc>GetLength(self) -> int</autodoc> |
f32fc4bc RD |
37565 | </method> |
37566 | <method name="GetCharAt" type="int" overloaded="no"> | |
781d2982 | 37567 | <autodoc>GetCharAt(self, int pos) -> int</autodoc> |
f32fc4bc RD |
37568 | <paramlist> |
37569 | <param name="pos" type="int" default=""/> | |
37570 | </paramlist> | |
37571 | </method> | |
37572 | <method name="GetCurrentPos" type="int" overloaded="no"> | |
781d2982 | 37573 | <autodoc>GetCurrentPos(self) -> int</autodoc> |
f32fc4bc RD |
37574 | </method> |
37575 | <method name="GetAnchor" type="int" overloaded="no"> | |
781d2982 | 37576 | <autodoc>GetAnchor(self) -> int</autodoc> |
f32fc4bc RD |
37577 | </method> |
37578 | <method name="GetStyleAt" type="int" overloaded="no"> | |
781d2982 | 37579 | <autodoc>GetStyleAt(self, int pos) -> int</autodoc> |
f32fc4bc RD |
37580 | <paramlist> |
37581 | <param name="pos" type="int" default=""/> | |
37582 | </paramlist> | |
37583 | </method> | |
37584 | <method name="Redo" type="" overloaded="no"> | |
781d2982 | 37585 | <autodoc>Redo(self)</autodoc> |
f32fc4bc RD |
37586 | </method> |
37587 | <method name="SetUndoCollection" type="" overloaded="no"> | |
781d2982 | 37588 | <autodoc>SetUndoCollection(self, bool collectUndo)</autodoc> |
f32fc4bc RD |
37589 | <paramlist> |
37590 | <param name="collectUndo" type="bool" default=""/> | |
37591 | </paramlist> | |
37592 | </method> | |
37593 | <method name="SelectAll" type="" overloaded="no"> | |
781d2982 | 37594 | <autodoc>SelectAll(self)</autodoc> |
f32fc4bc RD |
37595 | </method> |
37596 | <method name="SetSavePoint" type="" overloaded="no"> | |
781d2982 | 37597 | <autodoc>SetSavePoint(self)</autodoc> |
f32fc4bc RD |
37598 | </method> |
37599 | <method name="GetStyledText" type="wxMemoryBuffer" overloaded="no"> | |
781d2982 | 37600 | <autodoc>GetStyledText(self, int startPos, int endPos) -> wxMemoryBuffer</autodoc> |
f32fc4bc RD |
37601 | <paramlist> |
37602 | <param name="startPos" type="int" default=""/> | |
37603 | <param name="endPos" type="int" default=""/> | |
37604 | </paramlist> | |
37605 | </method> | |
37606 | <method name="CanRedo" type="bool" overloaded="no"> | |
781d2982 | 37607 | <autodoc>CanRedo(self) -> bool</autodoc> |
f32fc4bc RD |
37608 | </method> |
37609 | <method name="MarkerLineFromHandle" type="int" overloaded="no"> | |
781d2982 | 37610 | <autodoc>MarkerLineFromHandle(self, int handle) -> int</autodoc> |
f32fc4bc RD |
37611 | <paramlist> |
37612 | <param name="handle" type="int" default=""/> | |
37613 | </paramlist> | |
37614 | </method> | |
37615 | <method name="MarkerDeleteHandle" type="" overloaded="no"> | |
781d2982 | 37616 | <autodoc>MarkerDeleteHandle(self, int handle)</autodoc> |
f32fc4bc RD |
37617 | <paramlist> |
37618 | <param name="handle" type="int" default=""/> | |
37619 | </paramlist> | |
37620 | </method> | |
37621 | <method name="GetUndoCollection" type="bool" overloaded="no"> | |
781d2982 | 37622 | <autodoc>GetUndoCollection(self) -> bool</autodoc> |
f32fc4bc RD |
37623 | </method> |
37624 | <method name="GetViewWhiteSpace" type="int" overloaded="no"> | |
781d2982 | 37625 | <autodoc>GetViewWhiteSpace(self) -> int</autodoc> |
f32fc4bc RD |
37626 | </method> |
37627 | <method name="SetViewWhiteSpace" type="" overloaded="no"> | |
781d2982 | 37628 | <autodoc>SetViewWhiteSpace(self, int viewWS)</autodoc> |
f32fc4bc RD |
37629 | <paramlist> |
37630 | <param name="viewWS" type="int" default=""/> | |
37631 | </paramlist> | |
37632 | </method> | |
37633 | <method name="PositionFromPoint" type="int" overloaded="no"> | |
781d2982 | 37634 | <autodoc>PositionFromPoint(self, Point pt) -> int</autodoc> |
f32fc4bc RD |
37635 | <paramlist> |
37636 | <param name="pt" type="Point" default=""/> | |
37637 | </paramlist> | |
37638 | </method> | |
37639 | <method name="PositionFromPointClose" type="int" overloaded="no"> | |
781d2982 | 37640 | <autodoc>PositionFromPointClose(self, int x, int y) -> int</autodoc> |
f32fc4bc RD |
37641 | <paramlist> |
37642 | <param name="x" type="int" default=""/> | |
37643 | <param name="y" type="int" default=""/> | |
37644 | </paramlist> | |
37645 | </method> | |
37646 | <method name="GotoLine" type="" overloaded="no"> | |
781d2982 | 37647 | <autodoc>GotoLine(self, int line)</autodoc> |
f32fc4bc RD |
37648 | <paramlist> |
37649 | <param name="line" type="int" default=""/> | |
37650 | </paramlist> | |
37651 | </method> | |
37652 | <method name="GotoPos" type="" overloaded="no"> | |
781d2982 | 37653 | <autodoc>GotoPos(self, int pos)</autodoc> |
f32fc4bc RD |
37654 | <paramlist> |
37655 | <param name="pos" type="int" default=""/> | |
37656 | </paramlist> | |
37657 | </method> | |
37658 | <method name="SetAnchor" type="" overloaded="no"> | |
781d2982 | 37659 | <autodoc>SetAnchor(self, int posAnchor)</autodoc> |
f32fc4bc RD |
37660 | <paramlist> |
37661 | <param name="posAnchor" type="int" default=""/> | |
37662 | </paramlist> | |
37663 | </method> | |
37664 | <method name="GetCurLine" type="String" overloaded="no"> | |
781d2982 | 37665 | <autodoc>GetCurLine(self, int OUTPUT) -> String</autodoc> |
f32fc4bc RD |
37666 | <paramlist> |
37667 | <param name="OUTPUT" type="int" default=""/> | |
37668 | </paramlist> | |
37669 | </method> | |
37670 | <method name="GetEndStyled" type="int" overloaded="no"> | |
781d2982 | 37671 | <autodoc>GetEndStyled(self) -> int</autodoc> |
f32fc4bc RD |
37672 | </method> |
37673 | <method name="ConvertEOLs" type="" overloaded="no"> | |
781d2982 | 37674 | <autodoc>ConvertEOLs(self, int eolMode)</autodoc> |
f32fc4bc RD |
37675 | <paramlist> |
37676 | <param name="eolMode" type="int" default=""/> | |
37677 | </paramlist> | |
37678 | </method> | |
37679 | <method name="GetEOLMode" type="int" overloaded="no"> | |
781d2982 | 37680 | <autodoc>GetEOLMode(self) -> int</autodoc> |
f32fc4bc RD |
37681 | </method> |
37682 | <method name="SetEOLMode" type="" overloaded="no"> | |
781d2982 | 37683 | <autodoc>SetEOLMode(self, int eolMode)</autodoc> |
f32fc4bc RD |
37684 | <paramlist> |
37685 | <param name="eolMode" type="int" default=""/> | |
37686 | </paramlist> | |
37687 | </method> | |
37688 | <method name="StartStyling" type="" overloaded="no"> | |
781d2982 | 37689 | <autodoc>StartStyling(self, int pos, int mask)</autodoc> |
f32fc4bc RD |
37690 | <paramlist> |
37691 | <param name="pos" type="int" default=""/> | |
37692 | <param name="mask" type="int" default=""/> | |
37693 | </paramlist> | |
37694 | </method> | |
37695 | <method name="SetStyling" type="" overloaded="no"> | |
781d2982 | 37696 | <autodoc>SetStyling(self, int length, int style)</autodoc> |
f32fc4bc RD |
37697 | <paramlist> |
37698 | <param name="length" type="int" default=""/> | |
37699 | <param name="style" type="int" default=""/> | |
37700 | </paramlist> | |
37701 | </method> | |
37702 | <method name="GetBufferedDraw" type="bool" overloaded="no"> | |
781d2982 | 37703 | <autodoc>GetBufferedDraw(self) -> bool</autodoc> |
f32fc4bc RD |
37704 | </method> |
37705 | <method name="SetBufferedDraw" type="" overloaded="no"> | |
781d2982 | 37706 | <autodoc>SetBufferedDraw(self, bool buffered)</autodoc> |
f32fc4bc RD |
37707 | <paramlist> |
37708 | <param name="buffered" type="bool" default=""/> | |
37709 | </paramlist> | |
37710 | </method> | |
37711 | <method name="SetTabWidth" type="" overloaded="no"> | |
781d2982 | 37712 | <autodoc>SetTabWidth(self, int tabWidth)</autodoc> |
f32fc4bc RD |
37713 | <paramlist> |
37714 | <param name="tabWidth" type="int" default=""/> | |
37715 | </paramlist> | |
37716 | </method> | |
37717 | <method name="GetTabWidth" type="int" overloaded="no"> | |
781d2982 | 37718 | <autodoc>GetTabWidth(self) -> int</autodoc> |
f32fc4bc RD |
37719 | </method> |
37720 | <method name="SetCodePage" type="" overloaded="no"> | |
781d2982 | 37721 | <autodoc>SetCodePage(self, int codePage)</autodoc> |
f32fc4bc RD |
37722 | <paramlist> |
37723 | <param name="codePage" type="int" default=""/> | |
37724 | </paramlist> | |
37725 | </method> | |
37726 | <method name="MarkerDefine" type="" overloaded="no"> | |
781d2982 | 37727 | <autodoc>MarkerDefine(self, int markerNumber, int markerSymbol, Colour foreground=wxNullColour, |
f32fc4bc RD |
37728 | Colour background=wxNullColour)</autodoc> |
37729 | <paramlist> | |
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"/> | |
37734 | </paramlist> | |
37735 | </method> | |
37736 | <method name="MarkerSetForeground" type="" overloaded="no"> | |
781d2982 | 37737 | <autodoc>MarkerSetForeground(self, int markerNumber, Colour fore)</autodoc> |
f32fc4bc RD |
37738 | <paramlist> |
37739 | <param name="markerNumber" type="int" default=""/> | |
37740 | <param name="fore" type="Colour" default=""/> | |
37741 | </paramlist> | |
37742 | </method> | |
37743 | <method name="MarkerSetBackground" type="" overloaded="no"> | |
781d2982 | 37744 | <autodoc>MarkerSetBackground(self, int markerNumber, Colour back)</autodoc> |
f32fc4bc RD |
37745 | <paramlist> |
37746 | <param name="markerNumber" type="int" default=""/> | |
37747 | <param name="back" type="Colour" default=""/> | |
37748 | </paramlist> | |
37749 | </method> | |
37750 | <method name="MarkerAdd" type="int" overloaded="no"> | |
781d2982 | 37751 | <autodoc>MarkerAdd(self, int line, int markerNumber) -> int</autodoc> |
f32fc4bc RD |
37752 | <paramlist> |
37753 | <param name="line" type="int" default=""/> | |
37754 | <param name="markerNumber" type="int" default=""/> | |
37755 | </paramlist> | |
37756 | </method> | |
37757 | <method name="MarkerDelete" type="" overloaded="no"> | |
781d2982 | 37758 | <autodoc>MarkerDelete(self, int line, int markerNumber)</autodoc> |
f32fc4bc RD |
37759 | <paramlist> |
37760 | <param name="line" type="int" default=""/> | |
37761 | <param name="markerNumber" type="int" default=""/> | |
37762 | </paramlist> | |
37763 | </method> | |
37764 | <method name="MarkerDeleteAll" type="" overloaded="no"> | |
781d2982 | 37765 | <autodoc>MarkerDeleteAll(self, int markerNumber)</autodoc> |
f32fc4bc RD |
37766 | <paramlist> |
37767 | <param name="markerNumber" type="int" default=""/> | |
37768 | </paramlist> | |
37769 | </method> | |
37770 | <method name="MarkerGet" type="int" overloaded="no"> | |
781d2982 | 37771 | <autodoc>MarkerGet(self, int line) -> int</autodoc> |
f32fc4bc RD |
37772 | <paramlist> |
37773 | <param name="line" type="int" default=""/> | |
37774 | </paramlist> | |
37775 | </method> | |
37776 | <method name="MarkerNext" type="int" overloaded="no"> | |
781d2982 | 37777 | <autodoc>MarkerNext(self, int lineStart, int markerMask) -> int</autodoc> |
f32fc4bc RD |
37778 | <paramlist> |
37779 | <param name="lineStart" type="int" default=""/> | |
37780 | <param name="markerMask" type="int" default=""/> | |
37781 | </paramlist> | |
37782 | </method> | |
37783 | <method name="MarkerPrevious" type="int" overloaded="no"> | |
781d2982 | 37784 | <autodoc>MarkerPrevious(self, int lineStart, int markerMask) -> int</autodoc> |
f32fc4bc RD |
37785 | <paramlist> |
37786 | <param name="lineStart" type="int" default=""/> | |
37787 | <param name="markerMask" type="int" default=""/> | |
37788 | </paramlist> | |
37789 | </method> | |
37790 | <method name="MarkerDefineBitmap" type="" overloaded="no"> | |
781d2982 | 37791 | <autodoc>MarkerDefineBitmap(self, int markerNumber, Bitmap bmp)</autodoc> |
f32fc4bc RD |
37792 | <paramlist> |
37793 | <param name="markerNumber" type="int" default=""/> | |
37794 | <param name="bmp" type="Bitmap" default=""/> | |
37795 | </paramlist> | |
37796 | </method> | |
37797 | <method name="SetMarginType" type="" overloaded="no"> | |
781d2982 | 37798 | <autodoc>SetMarginType(self, int margin, int marginType)</autodoc> |
f32fc4bc RD |
37799 | <paramlist> |
37800 | <param name="margin" type="int" default=""/> | |
37801 | <param name="marginType" type="int" default=""/> | |
37802 | </paramlist> | |
37803 | </method> | |
37804 | <method name="GetMarginType" type="int" overloaded="no"> | |
781d2982 | 37805 | <autodoc>GetMarginType(self, int margin) -> int</autodoc> |
f32fc4bc RD |
37806 | <paramlist> |
37807 | <param name="margin" type="int" default=""/> | |
37808 | </paramlist> | |
37809 | </method> | |
37810 | <method name="SetMarginWidth" type="" overloaded="no"> | |
781d2982 | 37811 | <autodoc>SetMarginWidth(self, int margin, int pixelWidth)</autodoc> |
f32fc4bc RD |
37812 | <paramlist> |
37813 | <param name="margin" type="int" default=""/> | |
37814 | <param name="pixelWidth" type="int" default=""/> | |
37815 | </paramlist> | |
37816 | </method> | |
37817 | <method name="GetMarginWidth" type="int" overloaded="no"> | |
781d2982 | 37818 | <autodoc>GetMarginWidth(self, int margin) -> int</autodoc> |
f32fc4bc RD |
37819 | <paramlist> |
37820 | <param name="margin" type="int" default=""/> | |
37821 | </paramlist> | |
37822 | </method> | |
37823 | <method name="SetMarginMask" type="" overloaded="no"> | |
781d2982 | 37824 | <autodoc>SetMarginMask(self, int margin, int mask)</autodoc> |
f32fc4bc RD |
37825 | <paramlist> |
37826 | <param name="margin" type="int" default=""/> | |
37827 | <param name="mask" type="int" default=""/> | |
37828 | </paramlist> | |
37829 | </method> | |
37830 | <method name="GetMarginMask" type="int" overloaded="no"> | |
781d2982 | 37831 | <autodoc>GetMarginMask(self, int margin) -> int</autodoc> |
f32fc4bc RD |
37832 | <paramlist> |
37833 | <param name="margin" type="int" default=""/> | |
37834 | </paramlist> | |
37835 | </method> | |
37836 | <method name="SetMarginSensitive" type="" overloaded="no"> | |
781d2982 | 37837 | <autodoc>SetMarginSensitive(self, int margin, bool sensitive)</autodoc> |
f32fc4bc RD |
37838 | <paramlist> |
37839 | <param name="margin" type="int" default=""/> | |
37840 | <param name="sensitive" type="bool" default=""/> | |
37841 | </paramlist> | |
37842 | </method> | |
37843 | <method name="GetMarginSensitive" type="bool" overloaded="no"> | |
781d2982 | 37844 | <autodoc>GetMarginSensitive(self, int margin) -> bool</autodoc> |
f32fc4bc RD |
37845 | <paramlist> |
37846 | <param name="margin" type="int" default=""/> | |
37847 | </paramlist> | |
37848 | </method> | |
37849 | <method name="StyleClearAll" type="" overloaded="no"> | |
781d2982 | 37850 | <autodoc>StyleClearAll(self)</autodoc> |
f32fc4bc RD |
37851 | </method> |
37852 | <method name="StyleSetForeground" type="" overloaded="no"> | |
781d2982 | 37853 | <autodoc>StyleSetForeground(self, int style, Colour fore)</autodoc> |
f32fc4bc RD |
37854 | <paramlist> |
37855 | <param name="style" type="int" default=""/> | |
37856 | <param name="fore" type="Colour" default=""/> | |
37857 | </paramlist> | |
37858 | </method> | |
37859 | <method name="StyleSetBackground" type="" overloaded="no"> | |
781d2982 | 37860 | <autodoc>StyleSetBackground(self, int style, Colour back)</autodoc> |
f32fc4bc RD |
37861 | <paramlist> |
37862 | <param name="style" type="int" default=""/> | |
37863 | <param name="back" type="Colour" default=""/> | |
37864 | </paramlist> | |
37865 | </method> | |
37866 | <method name="StyleSetBold" type="" overloaded="no"> | |
781d2982 | 37867 | <autodoc>StyleSetBold(self, int style, bool bold)</autodoc> |
f32fc4bc RD |
37868 | <paramlist> |
37869 | <param name="style" type="int" default=""/> | |
37870 | <param name="bold" type="bool" default=""/> | |
37871 | </paramlist> | |
37872 | </method> | |
37873 | <method name="StyleSetItalic" type="" overloaded="no"> | |
781d2982 | 37874 | <autodoc>StyleSetItalic(self, int style, bool italic)</autodoc> |
f32fc4bc RD |
37875 | <paramlist> |
37876 | <param name="style" type="int" default=""/> | |
37877 | <param name="italic" type="bool" default=""/> | |
37878 | </paramlist> | |
37879 | </method> | |
37880 | <method name="StyleSetSize" type="" overloaded="no"> | |
781d2982 | 37881 | <autodoc>StyleSetSize(self, int style, int sizePoints)</autodoc> |
f32fc4bc RD |
37882 | <paramlist> |
37883 | <param name="style" type="int" default=""/> | |
37884 | <param name="sizePoints" type="int" default=""/> | |
37885 | </paramlist> | |
37886 | </method> | |
37887 | <method name="StyleSetFaceName" type="" overloaded="no"> | |
781d2982 | 37888 | <autodoc>StyleSetFaceName(self, int style, String fontName)</autodoc> |
f32fc4bc RD |
37889 | <paramlist> |
37890 | <param name="style" type="int" default=""/> | |
37891 | <param name="fontName" type="String" default=""/> | |
37892 | </paramlist> | |
37893 | </method> | |
37894 | <method name="StyleSetEOLFilled" type="" overloaded="no"> | |
781d2982 | 37895 | <autodoc>StyleSetEOLFilled(self, int style, bool filled)</autodoc> |
f32fc4bc RD |
37896 | <paramlist> |
37897 | <param name="style" type="int" default=""/> | |
37898 | <param name="filled" type="bool" default=""/> | |
37899 | </paramlist> | |
37900 | </method> | |
37901 | <method name="StyleResetDefault" type="" overloaded="no"> | |
781d2982 | 37902 | <autodoc>StyleResetDefault(self)</autodoc> |
f32fc4bc RD |
37903 | </method> |
37904 | <method name="StyleSetUnderline" type="" overloaded="no"> | |
781d2982 | 37905 | <autodoc>StyleSetUnderline(self, int style, bool underline)</autodoc> |
f32fc4bc RD |
37906 | <paramlist> |
37907 | <param name="style" type="int" default=""/> | |
37908 | <param name="underline" type="bool" default=""/> | |
37909 | </paramlist> | |
37910 | </method> | |
37911 | <method name="StyleSetCase" type="" overloaded="no"> | |
781d2982 | 37912 | <autodoc>StyleSetCase(self, int style, int caseForce)</autodoc> |
f32fc4bc RD |
37913 | <paramlist> |
37914 | <param name="style" type="int" default=""/> | |
37915 | <param name="caseForce" type="int" default=""/> | |
37916 | </paramlist> | |
37917 | </method> | |
37918 | <method name="StyleSetCharacterSet" type="" overloaded="no"> | |
781d2982 | 37919 | <autodoc>StyleSetCharacterSet(self, int style, int characterSet)</autodoc> |
f32fc4bc RD |
37920 | <paramlist> |
37921 | <param name="style" type="int" default=""/> | |
37922 | <param name="characterSet" type="int" default=""/> | |
37923 | </paramlist> | |
37924 | </method> | |
37925 | <method name="StyleSetHotSpot" type="" overloaded="no"> | |
781d2982 | 37926 | <autodoc>StyleSetHotSpot(self, int style, bool hotspot)</autodoc> |
f32fc4bc RD |
37927 | <paramlist> |
37928 | <param name="style" type="int" default=""/> | |
37929 | <param name="hotspot" type="bool" default=""/> | |
37930 | </paramlist> | |
37931 | </method> | |
37932 | <method name="SetSelForeground" type="" overloaded="no"> | |
781d2982 | 37933 | <autodoc>SetSelForeground(self, bool useSetting, Colour fore)</autodoc> |
f32fc4bc RD |
37934 | <paramlist> |
37935 | <param name="useSetting" type="bool" default=""/> | |
37936 | <param name="fore" type="Colour" default=""/> | |
37937 | </paramlist> | |
37938 | </method> | |
37939 | <method name="SetSelBackground" type="" overloaded="no"> | |
781d2982 | 37940 | <autodoc>SetSelBackground(self, bool useSetting, Colour back)</autodoc> |
f32fc4bc RD |
37941 | <paramlist> |
37942 | <param name="useSetting" type="bool" default=""/> | |
37943 | <param name="back" type="Colour" default=""/> | |
37944 | </paramlist> | |
37945 | </method> | |
37946 | <method name="SetCaretForeground" type="" overloaded="no"> | |
781d2982 | 37947 | <autodoc>SetCaretForeground(self, Colour fore)</autodoc> |
f32fc4bc RD |
37948 | <paramlist> |
37949 | <param name="fore" type="Colour" default=""/> | |
37950 | </paramlist> | |
37951 | </method> | |
37952 | <method name="CmdKeyAssign" type="" overloaded="no"> | |
781d2982 | 37953 | <autodoc>CmdKeyAssign(self, int key, int modifiers, int cmd)</autodoc> |
f32fc4bc RD |
37954 | <paramlist> |
37955 | <param name="key" type="int" default=""/> | |
37956 | <param name="modifiers" type="int" default=""/> | |
37957 | <param name="cmd" type="int" default=""/> | |
37958 | </paramlist> | |
37959 | </method> | |
37960 | <method name="CmdKeyClear" type="" overloaded="no"> | |
781d2982 | 37961 | <autodoc>CmdKeyClear(self, int key, int modifiers)</autodoc> |
f32fc4bc RD |
37962 | <paramlist> |
37963 | <param name="key" type="int" default=""/> | |
37964 | <param name="modifiers" type="int" default=""/> | |
37965 | </paramlist> | |
37966 | </method> | |
37967 | <method name="CmdKeyClearAll" type="" overloaded="no"> | |
781d2982 | 37968 | <autodoc>CmdKeyClearAll(self)</autodoc> |
f32fc4bc RD |
37969 | </method> |
37970 | <method name="SetStyleBytes" type="" overloaded="no"> | |
781d2982 | 37971 | <autodoc>SetStyleBytes(self, int length, char styleBytes)</autodoc> |
f32fc4bc RD |
37972 | <paramlist> |
37973 | <param name="length" type="int" default=""/> | |
37974 | <param name="styleBytes" type="char" default=""/> | |
37975 | </paramlist> | |
37976 | </method> | |
37977 | <method name="StyleSetVisible" type="" overloaded="no"> | |
781d2982 | 37978 | <autodoc>StyleSetVisible(self, int style, bool visible)</autodoc> |
f32fc4bc RD |
37979 | <paramlist> |
37980 | <param name="style" type="int" default=""/> | |
37981 | <param name="visible" type="bool" default=""/> | |
37982 | </paramlist> | |
37983 | </method> | |
37984 | <method name="GetCaretPeriod" type="int" overloaded="no"> | |
781d2982 | 37985 | <autodoc>GetCaretPeriod(self) -> int</autodoc> |
f32fc4bc RD |
37986 | </method> |
37987 | <method name="SetCaretPeriod" type="" overloaded="no"> | |
781d2982 | 37988 | <autodoc>SetCaretPeriod(self, int periodMilliseconds)</autodoc> |
f32fc4bc RD |
37989 | <paramlist> |
37990 | <param name="periodMilliseconds" type="int" default=""/> | |
37991 | </paramlist> | |
37992 | </method> | |
37993 | <method name="SetWordChars" type="" overloaded="no"> | |
781d2982 | 37994 | <autodoc>SetWordChars(self, String characters)</autodoc> |
f32fc4bc RD |
37995 | <paramlist> |
37996 | <param name="characters" type="String" default=""/> | |
37997 | </paramlist> | |
37998 | </method> | |
37999 | <method name="BeginUndoAction" type="" overloaded="no"> | |
781d2982 | 38000 | <autodoc>BeginUndoAction(self)</autodoc> |
f32fc4bc RD |
38001 | </method> |
38002 | <method name="EndUndoAction" type="" overloaded="no"> | |
781d2982 | 38003 | <autodoc>EndUndoAction(self)</autodoc> |
f32fc4bc RD |
38004 | </method> |
38005 | <method name="IndicatorSetStyle" type="" overloaded="no"> | |
781d2982 | 38006 | <autodoc>IndicatorSetStyle(self, int indic, int style)</autodoc> |
f32fc4bc RD |
38007 | <paramlist> |
38008 | <param name="indic" type="int" default=""/> | |
38009 | <param name="style" type="int" default=""/> | |
38010 | </paramlist> | |
38011 | </method> | |
38012 | <method name="IndicatorGetStyle" type="int" overloaded="no"> | |
781d2982 | 38013 | <autodoc>IndicatorGetStyle(self, int indic) -> int</autodoc> |
f32fc4bc RD |
38014 | <paramlist> |
38015 | <param name="indic" type="int" default=""/> | |
38016 | </paramlist> | |
38017 | </method> | |
38018 | <method name="IndicatorSetForeground" type="" overloaded="no"> | |
781d2982 | 38019 | <autodoc>IndicatorSetForeground(self, int indic, Colour fore)</autodoc> |
f32fc4bc RD |
38020 | <paramlist> |
38021 | <param name="indic" type="int" default=""/> | |
38022 | <param name="fore" type="Colour" default=""/> | |
38023 | </paramlist> | |
38024 | </method> | |
38025 | <method name="IndicatorGetForeground" type="Colour" overloaded="no"> | |
781d2982 | 38026 | <autodoc>IndicatorGetForeground(self, int indic) -> Colour</autodoc> |
f32fc4bc RD |
38027 | <paramlist> |
38028 | <param name="indic" type="int" default=""/> | |
38029 | </paramlist> | |
38030 | </method> | |
38031 | <method name="SetWhitespaceForeground" type="" overloaded="no"> | |
781d2982 | 38032 | <autodoc>SetWhitespaceForeground(self, bool useSetting, Colour fore)</autodoc> |
f32fc4bc RD |
38033 | <paramlist> |
38034 | <param name="useSetting" type="bool" default=""/> | |
38035 | <param name="fore" type="Colour" default=""/> | |
38036 | </paramlist> | |
38037 | </method> | |
38038 | <method name="SetWhitespaceBackground" type="" overloaded="no"> | |
781d2982 | 38039 | <autodoc>SetWhitespaceBackground(self, bool useSetting, Colour back)</autodoc> |
f32fc4bc RD |
38040 | <paramlist> |
38041 | <param name="useSetting" type="bool" default=""/> | |
38042 | <param name="back" type="Colour" default=""/> | |
38043 | </paramlist> | |
38044 | </method> | |
38045 | <method name="SetStyleBits" type="" overloaded="no"> | |
781d2982 | 38046 | <autodoc>SetStyleBits(self, int bits)</autodoc> |
f32fc4bc RD |
38047 | <paramlist> |
38048 | <param name="bits" type="int" default=""/> | |
38049 | </paramlist> | |
38050 | </method> | |
38051 | <method name="GetStyleBits" type="int" overloaded="no"> | |
781d2982 | 38052 | <autodoc>GetStyleBits(self) -> int</autodoc> |
f32fc4bc RD |
38053 | </method> |
38054 | <method name="SetLineState" type="" overloaded="no"> | |
781d2982 | 38055 | <autodoc>SetLineState(self, int line, int state)</autodoc> |
f32fc4bc RD |
38056 | <paramlist> |
38057 | <param name="line" type="int" default=""/> | |
38058 | <param name="state" type="int" default=""/> | |
38059 | </paramlist> | |
38060 | </method> | |
38061 | <method name="GetLineState" type="int" overloaded="no"> | |
781d2982 | 38062 | <autodoc>GetLineState(self, int line) -> int</autodoc> |
f32fc4bc RD |
38063 | <paramlist> |
38064 | <param name="line" type="int" default=""/> | |
38065 | </paramlist> | |
38066 | </method> | |
38067 | <method name="GetMaxLineState" type="int" overloaded="no"> | |
781d2982 | 38068 | <autodoc>GetMaxLineState(self) -> int</autodoc> |
f32fc4bc RD |
38069 | </method> |
38070 | <method name="GetCaretLineVisible" type="bool" overloaded="no"> | |
781d2982 | 38071 | <autodoc>GetCaretLineVisible(self) -> bool</autodoc> |
f32fc4bc RD |
38072 | </method> |
38073 | <method name="SetCaretLineVisible" type="" overloaded="no"> | |
781d2982 | 38074 | <autodoc>SetCaretLineVisible(self, bool show)</autodoc> |
f32fc4bc RD |
38075 | <paramlist> |
38076 | <param name="show" type="bool" default=""/> | |
38077 | </paramlist> | |
38078 | </method> | |
38079 | <method name="GetCaretLineBack" type="Colour" overloaded="no"> | |
781d2982 | 38080 | <autodoc>GetCaretLineBack(self) -> Colour</autodoc> |
f32fc4bc RD |
38081 | </method> |
38082 | <method name="SetCaretLineBack" type="" overloaded="no"> | |
781d2982 | 38083 | <autodoc>SetCaretLineBack(self, Colour back)</autodoc> |
f32fc4bc RD |
38084 | <paramlist> |
38085 | <param name="back" type="Colour" default=""/> | |
38086 | </paramlist> | |
38087 | </method> | |
38088 | <method name="StyleSetChangeable" type="" overloaded="no"> | |
781d2982 | 38089 | <autodoc>StyleSetChangeable(self, int style, bool changeable)</autodoc> |
f32fc4bc RD |
38090 | <paramlist> |
38091 | <param name="style" type="int" default=""/> | |
38092 | <param name="changeable" type="bool" default=""/> | |
38093 | </paramlist> | |
38094 | </method> | |
38095 | <method name="AutoCompShow" type="" overloaded="no"> | |
781d2982 | 38096 | <autodoc>AutoCompShow(self, int lenEntered, String itemList)</autodoc> |
f32fc4bc RD |
38097 | <paramlist> |
38098 | <param name="lenEntered" type="int" default=""/> | |
38099 | <param name="itemList" type="String" default=""/> | |
38100 | </paramlist> | |
38101 | </method> | |
38102 | <method name="AutoCompCancel" type="" overloaded="no"> | |
781d2982 | 38103 | <autodoc>AutoCompCancel(self)</autodoc> |
f32fc4bc RD |
38104 | </method> |
38105 | <method name="AutoCompActive" type="bool" overloaded="no"> | |
781d2982 | 38106 | <autodoc>AutoCompActive(self) -> bool</autodoc> |
f32fc4bc RD |
38107 | </method> |
38108 | <method name="AutoCompPosStart" type="int" overloaded="no"> | |
781d2982 | 38109 | <autodoc>AutoCompPosStart(self) -> int</autodoc> |
f32fc4bc RD |
38110 | </method> |
38111 | <method name="AutoCompComplete" type="" overloaded="no"> | |
781d2982 | 38112 | <autodoc>AutoCompComplete(self)</autodoc> |
f32fc4bc RD |
38113 | </method> |
38114 | <method name="AutoCompStops" type="" overloaded="no"> | |
781d2982 | 38115 | <autodoc>AutoCompStops(self, String characterSet)</autodoc> |
f32fc4bc RD |
38116 | <paramlist> |
38117 | <param name="characterSet" type="String" default=""/> | |
38118 | </paramlist> | |
38119 | </method> | |
38120 | <method name="AutoCompSetSeparator" type="" overloaded="no"> | |
781d2982 | 38121 | <autodoc>AutoCompSetSeparator(self, int separatorCharacter)</autodoc> |
f32fc4bc RD |
38122 | <paramlist> |
38123 | <param name="separatorCharacter" type="int" default=""/> | |
38124 | </paramlist> | |
38125 | </method> | |
38126 | <method name="AutoCompGetSeparator" type="int" overloaded="no"> | |
781d2982 | 38127 | <autodoc>AutoCompGetSeparator(self) -> int</autodoc> |
f32fc4bc RD |
38128 | </method> |
38129 | <method name="AutoCompSelect" type="" overloaded="no"> | |
781d2982 | 38130 | <autodoc>AutoCompSelect(self, String text)</autodoc> |
f32fc4bc RD |
38131 | <paramlist> |
38132 | <param name="text" type="String" default=""/> | |
38133 | </paramlist> | |
38134 | </method> | |
38135 | <method name="AutoCompSetCancelAtStart" type="" overloaded="no"> | |
781d2982 | 38136 | <autodoc>AutoCompSetCancelAtStart(self, bool cancel)</autodoc> |
f32fc4bc RD |
38137 | <paramlist> |
38138 | <param name="cancel" type="bool" default=""/> | |
38139 | </paramlist> | |
38140 | </method> | |
38141 | <method name="AutoCompGetCancelAtStart" type="bool" overloaded="no"> | |
781d2982 | 38142 | <autodoc>AutoCompGetCancelAtStart(self) -> bool</autodoc> |
f32fc4bc RD |
38143 | </method> |
38144 | <method name="AutoCompSetFillUps" type="" overloaded="no"> | |
781d2982 | 38145 | <autodoc>AutoCompSetFillUps(self, String characterSet)</autodoc> |
f32fc4bc RD |
38146 | <paramlist> |
38147 | <param name="characterSet" type="String" default=""/> | |
38148 | </paramlist> | |
38149 | </method> | |
38150 | <method name="AutoCompSetChooseSingle" type="" overloaded="no"> | |
781d2982 | 38151 | <autodoc>AutoCompSetChooseSingle(self, bool chooseSingle)</autodoc> |
f32fc4bc RD |
38152 | <paramlist> |
38153 | <param name="chooseSingle" type="bool" default=""/> | |
38154 | </paramlist> | |
38155 | </method> | |
38156 | <method name="AutoCompGetChooseSingle" type="bool" overloaded="no"> | |
781d2982 | 38157 | <autodoc>AutoCompGetChooseSingle(self) -> bool</autodoc> |
f32fc4bc RD |
38158 | </method> |
38159 | <method name="AutoCompSetIgnoreCase" type="" overloaded="no"> | |
781d2982 | 38160 | <autodoc>AutoCompSetIgnoreCase(self, bool ignoreCase)</autodoc> |
f32fc4bc RD |
38161 | <paramlist> |
38162 | <param name="ignoreCase" type="bool" default=""/> | |
38163 | </paramlist> | |
38164 | </method> | |
38165 | <method name="AutoCompGetIgnoreCase" type="bool" overloaded="no"> | |
781d2982 | 38166 | <autodoc>AutoCompGetIgnoreCase(self) -> bool</autodoc> |
f32fc4bc RD |
38167 | </method> |
38168 | <method name="UserListShow" type="" overloaded="no"> | |
781d2982 | 38169 | <autodoc>UserListShow(self, int listType, String itemList)</autodoc> |
f32fc4bc RD |
38170 | <paramlist> |
38171 | <param name="listType" type="int" default=""/> | |
38172 | <param name="itemList" type="String" default=""/> | |
38173 | </paramlist> | |
38174 | </method> | |
38175 | <method name="AutoCompSetAutoHide" type="" overloaded="no"> | |
781d2982 | 38176 | <autodoc>AutoCompSetAutoHide(self, bool autoHide)</autodoc> |
f32fc4bc RD |
38177 | <paramlist> |
38178 | <param name="autoHide" type="bool" default=""/> | |
38179 | </paramlist> | |
38180 | </method> | |
38181 | <method name="AutoCompGetAutoHide" type="bool" overloaded="no"> | |
781d2982 | 38182 | <autodoc>AutoCompGetAutoHide(self) -> bool</autodoc> |
f32fc4bc RD |
38183 | </method> |
38184 | <method name="AutoCompSetDropRestOfWord" type="" overloaded="no"> | |
781d2982 | 38185 | <autodoc>AutoCompSetDropRestOfWord(self, bool dropRestOfWord)</autodoc> |
f32fc4bc RD |
38186 | <paramlist> |
38187 | <param name="dropRestOfWord" type="bool" default=""/> | |
38188 | </paramlist> | |
38189 | </method> | |
38190 | <method name="AutoCompGetDropRestOfWord" type="bool" overloaded="no"> | |
781d2982 | 38191 | <autodoc>AutoCompGetDropRestOfWord(self) -> bool</autodoc> |
f32fc4bc RD |
38192 | </method> |
38193 | <method name="RegisterImage" type="" overloaded="no"> | |
781d2982 | 38194 | <autodoc>RegisterImage(self, int type, Bitmap bmp)</autodoc> |
f32fc4bc RD |
38195 | <paramlist> |
38196 | <param name="type" type="int" default=""/> | |
38197 | <param name="bmp" type="Bitmap" default=""/> | |
38198 | </paramlist> | |
38199 | </method> | |
38200 | <method name="ClearRegisteredImages" type="" overloaded="no"> | |
781d2982 | 38201 | <autodoc>ClearRegisteredImages(self)</autodoc> |
f32fc4bc RD |
38202 | </method> |
38203 | <method name="AutoCompGetTypeSeparator" type="int" overloaded="no"> | |
781d2982 | 38204 | <autodoc>AutoCompGetTypeSeparator(self) -> int</autodoc> |
f32fc4bc RD |
38205 | </method> |
38206 | <method name="AutoCompSetTypeSeparator" type="" overloaded="no"> | |
781d2982 | 38207 | <autodoc>AutoCompSetTypeSeparator(self, int separatorCharacter)</autodoc> |
f32fc4bc RD |
38208 | <paramlist> |
38209 | <param name="separatorCharacter" type="int" default=""/> | |
38210 | </paramlist> | |
38211 | </method> | |
38212 | <method name="SetIndent" type="" overloaded="no"> | |
781d2982 | 38213 | <autodoc>SetIndent(self, int indentSize)</autodoc> |
f32fc4bc RD |
38214 | <paramlist> |
38215 | <param name="indentSize" type="int" default=""/> | |
38216 | </paramlist> | |
38217 | </method> | |
38218 | <method name="GetIndent" type="int" overloaded="no"> | |
781d2982 | 38219 | <autodoc>GetIndent(self) -> int</autodoc> |
f32fc4bc RD |
38220 | </method> |
38221 | <method name="SetUseTabs" type="" overloaded="no"> | |
781d2982 | 38222 | <autodoc>SetUseTabs(self, bool useTabs)</autodoc> |
f32fc4bc RD |
38223 | <paramlist> |
38224 | <param name="useTabs" type="bool" default=""/> | |
38225 | </paramlist> | |
38226 | </method> | |
38227 | <method name="GetUseTabs" type="bool" overloaded="no"> | |
781d2982 | 38228 | <autodoc>GetUseTabs(self) -> bool</autodoc> |
f32fc4bc RD |
38229 | </method> |
38230 | <method name="SetLineIndentation" type="" overloaded="no"> | |
781d2982 | 38231 | <autodoc>SetLineIndentation(self, int line, int indentSize)</autodoc> |
f32fc4bc RD |
38232 | <paramlist> |
38233 | <param name="line" type="int" default=""/> | |
38234 | <param name="indentSize" type="int" default=""/> | |
38235 | </paramlist> | |
38236 | </method> | |
38237 | <method name="GetLineIndentation" type="int" overloaded="no"> | |
781d2982 | 38238 | <autodoc>GetLineIndentation(self, int line) -> int</autodoc> |
f32fc4bc RD |
38239 | <paramlist> |
38240 | <param name="line" type="int" default=""/> | |
38241 | </paramlist> | |
38242 | </method> | |
38243 | <method name="GetLineIndentPosition" type="int" overloaded="no"> | |
781d2982 | 38244 | <autodoc>GetLineIndentPosition(self, int line) -> int</autodoc> |
f32fc4bc RD |
38245 | <paramlist> |
38246 | <param name="line" type="int" default=""/> | |
38247 | </paramlist> | |
38248 | </method> | |
38249 | <method name="GetColumn" type="int" overloaded="no"> | |
781d2982 | 38250 | <autodoc>GetColumn(self, int pos) -> int</autodoc> |
f32fc4bc RD |
38251 | <paramlist> |
38252 | <param name="pos" type="int" default=""/> | |
38253 | </paramlist> | |
38254 | </method> | |
38255 | <method name="SetUseHorizontalScrollBar" type="" overloaded="no"> | |
781d2982 | 38256 | <autodoc>SetUseHorizontalScrollBar(self, bool show)</autodoc> |
f32fc4bc RD |
38257 | <paramlist> |
38258 | <param name="show" type="bool" default=""/> | |
38259 | </paramlist> | |
38260 | </method> | |
38261 | <method name="GetUseHorizontalScrollBar" type="bool" overloaded="no"> | |
781d2982 | 38262 | <autodoc>GetUseHorizontalScrollBar(self) -> bool</autodoc> |
f32fc4bc RD |
38263 | </method> |
38264 | <method name="SetIndentationGuides" type="" overloaded="no"> | |
781d2982 | 38265 | <autodoc>SetIndentationGuides(self, bool show)</autodoc> |
f32fc4bc RD |
38266 | <paramlist> |
38267 | <param name="show" type="bool" default=""/> | |
38268 | </paramlist> | |
38269 | </method> | |
38270 | <method name="GetIndentationGuides" type="bool" overloaded="no"> | |
781d2982 | 38271 | <autodoc>GetIndentationGuides(self) -> bool</autodoc> |
f32fc4bc RD |
38272 | </method> |
38273 | <method name="SetHighlightGuide" type="" overloaded="no"> | |
781d2982 | 38274 | <autodoc>SetHighlightGuide(self, int column)</autodoc> |
f32fc4bc RD |
38275 | <paramlist> |
38276 | <param name="column" type="int" default=""/> | |
38277 | </paramlist> | |
38278 | </method> | |
38279 | <method name="GetHighlightGuide" type="int" overloaded="no"> | |
781d2982 | 38280 | <autodoc>GetHighlightGuide(self) -> int</autodoc> |
f32fc4bc RD |
38281 | </method> |
38282 | <method name="GetLineEndPosition" type="int" overloaded="no"> | |
781d2982 | 38283 | <autodoc>GetLineEndPosition(self, int line) -> int</autodoc> |
f32fc4bc RD |
38284 | <paramlist> |
38285 | <param name="line" type="int" default=""/> | |
38286 | </paramlist> | |
38287 | </method> | |
38288 | <method name="GetCodePage" type="int" overloaded="no"> | |
781d2982 | 38289 | <autodoc>GetCodePage(self) -> int</autodoc> |
f32fc4bc RD |
38290 | </method> |
38291 | <method name="GetCaretForeground" type="Colour" overloaded="no"> | |
781d2982 | 38292 | <autodoc>GetCaretForeground(self) -> Colour</autodoc> |
f32fc4bc RD |
38293 | </method> |
38294 | <method name="GetReadOnly" type="bool" overloaded="no"> | |
781d2982 | 38295 | <autodoc>GetReadOnly(self) -> bool</autodoc> |
f32fc4bc RD |
38296 | </method> |
38297 | <method name="SetCurrentPos" type="" overloaded="no"> | |
781d2982 | 38298 | <autodoc>SetCurrentPos(self, int pos)</autodoc> |
f32fc4bc RD |
38299 | <paramlist> |
38300 | <param name="pos" type="int" default=""/> | |
38301 | </paramlist> | |
38302 | </method> | |
38303 | <method name="SetSelectionStart" type="" overloaded="no"> | |
781d2982 | 38304 | <autodoc>SetSelectionStart(self, int pos)</autodoc> |
f32fc4bc RD |
38305 | <paramlist> |
38306 | <param name="pos" type="int" default=""/> | |
38307 | </paramlist> | |
38308 | </method> | |
38309 | <method name="GetSelectionStart" type="int" overloaded="no"> | |
781d2982 | 38310 | <autodoc>GetSelectionStart(self) -> int</autodoc> |
f32fc4bc RD |
38311 | </method> |
38312 | <method name="SetSelectionEnd" type="" overloaded="no"> | |
781d2982 | 38313 | <autodoc>SetSelectionEnd(self, int pos)</autodoc> |
f32fc4bc RD |
38314 | <paramlist> |
38315 | <param name="pos" type="int" default=""/> | |
38316 | </paramlist> | |
38317 | </method> | |
38318 | <method name="GetSelectionEnd" type="int" overloaded="no"> | |
781d2982 | 38319 | <autodoc>GetSelectionEnd(self) -> int</autodoc> |
f32fc4bc RD |
38320 | </method> |
38321 | <method name="SetPrintMagnification" type="" overloaded="no"> | |
781d2982 | 38322 | <autodoc>SetPrintMagnification(self, int magnification)</autodoc> |
f32fc4bc RD |
38323 | <paramlist> |
38324 | <param name="magnification" type="int" default=""/> | |
38325 | </paramlist> | |
38326 | </method> | |
38327 | <method name="GetPrintMagnification" type="int" overloaded="no"> | |
781d2982 | 38328 | <autodoc>GetPrintMagnification(self) -> int</autodoc> |
f32fc4bc RD |
38329 | </method> |
38330 | <method name="SetPrintColourMode" type="" overloaded="no"> | |
781d2982 | 38331 | <autodoc>SetPrintColourMode(self, int mode)</autodoc> |
f32fc4bc RD |
38332 | <paramlist> |
38333 | <param name="mode" type="int" default=""/> | |
38334 | </paramlist> | |
38335 | </method> | |
38336 | <method name="GetPrintColourMode" type="int" overloaded="no"> | |
781d2982 | 38337 | <autodoc>GetPrintColourMode(self) -> int</autodoc> |
f32fc4bc RD |
38338 | </method> |
38339 | <method name="FindText" type="int" overloaded="no"> | |
781d2982 | 38340 | <autodoc>FindText(self, int minPos, int maxPos, String text, int flags=0) -> int</autodoc> |
f32fc4bc RD |
38341 | <paramlist> |
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"/> | |
38346 | </paramlist> | |
38347 | </method> | |
38348 | <method name="FormatRange" type="int" overloaded="no"> | |
781d2982 | 38349 | <autodoc>FormatRange(self, bool doDraw, int startPos, int endPos, DC draw, DC target, |
f32fc4bc RD |
38350 | Rect renderRect, Rect pageRect) -> int</autodoc> |
38351 | <paramlist> | |
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=""/> | |
38359 | </paramlist> | |
38360 | </method> | |
38361 | <method name="GetFirstVisibleLine" type="int" overloaded="no"> | |
781d2982 | 38362 | <autodoc>GetFirstVisibleLine(self) -> int</autodoc> |
f32fc4bc RD |
38363 | </method> |
38364 | <method name="GetLine" type="String" overloaded="no"> | |
781d2982 | 38365 | <autodoc>GetLine(self, int line) -> String</autodoc> |
f32fc4bc RD |
38366 | <paramlist> |
38367 | <param name="line" type="int" default=""/> | |
38368 | </paramlist> | |
38369 | </method> | |
38370 | <method name="GetLineCount" type="int" overloaded="no"> | |
781d2982 | 38371 | <autodoc>GetLineCount(self) -> int</autodoc> |
f32fc4bc RD |
38372 | </method> |
38373 | <method name="SetMarginLeft" type="" overloaded="no"> | |
781d2982 | 38374 | <autodoc>SetMarginLeft(self, int pixelWidth)</autodoc> |
f32fc4bc RD |
38375 | <paramlist> |
38376 | <param name="pixelWidth" type="int" default=""/> | |
38377 | </paramlist> | |
38378 | </method> | |
38379 | <method name="GetMarginLeft" type="int" overloaded="no"> | |
781d2982 | 38380 | <autodoc>GetMarginLeft(self) -> int</autodoc> |
f32fc4bc RD |
38381 | </method> |
38382 | <method name="SetMarginRight" type="" overloaded="no"> | |
781d2982 | 38383 | <autodoc>SetMarginRight(self, int pixelWidth)</autodoc> |
f32fc4bc RD |
38384 | <paramlist> |
38385 | <param name="pixelWidth" type="int" default=""/> | |
38386 | </paramlist> | |
38387 | </method> | |
38388 | <method name="GetMarginRight" type="int" overloaded="no"> | |
781d2982 | 38389 | <autodoc>GetMarginRight(self) -> int</autodoc> |
f32fc4bc RD |
38390 | </method> |
38391 | <method name="GetModify" type="bool" overloaded="no"> | |
781d2982 | 38392 | <autodoc>GetModify(self) -> bool</autodoc> |
f32fc4bc RD |
38393 | </method> |
38394 | <method name="SetSelection" type="" overloaded="no"> | |
781d2982 | 38395 | <autodoc>SetSelection(self, int start, int end)</autodoc> |
f32fc4bc RD |
38396 | <paramlist> |
38397 | <param name="start" type="int" default=""/> | |
38398 | <param name="end" type="int" default=""/> | |
38399 | </paramlist> | |
38400 | </method> | |
38401 | <method name="GetSelectedText" type="String" overloaded="no"> | |
781d2982 | 38402 | <autodoc>GetSelectedText(self) -> String</autodoc> |
f32fc4bc RD |
38403 | </method> |
38404 | <method name="GetTextRange" type="String" overloaded="no"> | |
781d2982 | 38405 | <autodoc>GetTextRange(self, int startPos, int endPos) -> String</autodoc> |
f32fc4bc RD |
38406 | <paramlist> |
38407 | <param name="startPos" type="int" default=""/> | |
38408 | <param name="endPos" type="int" default=""/> | |
38409 | </paramlist> | |
38410 | </method> | |
38411 | <method name="HideSelection" type="" overloaded="no"> | |
781d2982 | 38412 | <autodoc>HideSelection(self, bool normal)</autodoc> |
f32fc4bc RD |
38413 | <paramlist> |
38414 | <param name="normal" type="bool" default=""/> | |
38415 | </paramlist> | |
38416 | </method> | |
38417 | <method name="LineFromPosition" type="int" overloaded="no"> | |
781d2982 | 38418 | <autodoc>LineFromPosition(self, int pos) -> int</autodoc> |
f32fc4bc RD |
38419 | <paramlist> |
38420 | <param name="pos" type="int" default=""/> | |
38421 | </paramlist> | |
38422 | </method> | |
38423 | <method name="PositionFromLine" type="int" overloaded="no"> | |
781d2982 | 38424 | <autodoc>PositionFromLine(self, int line) -> int</autodoc> |
f32fc4bc RD |
38425 | <paramlist> |
38426 | <param name="line" type="int" default=""/> | |
38427 | </paramlist> | |
38428 | </method> | |
38429 | <method name="LineScroll" type="" overloaded="no"> | |
781d2982 | 38430 | <autodoc>LineScroll(self, int columns, int lines)</autodoc> |
f32fc4bc RD |
38431 | <paramlist> |
38432 | <param name="columns" type="int" default=""/> | |
38433 | <param name="lines" type="int" default=""/> | |
38434 | </paramlist> | |
38435 | </method> | |
38436 | <method name="EnsureCaretVisible" type="" overloaded="no"> | |
781d2982 | 38437 | <autodoc>EnsureCaretVisible(self)</autodoc> |
f32fc4bc RD |
38438 | </method> |
38439 | <method name="ReplaceSelection" type="" overloaded="no"> | |
781d2982 | 38440 | <autodoc>ReplaceSelection(self, String text)</autodoc> |
f32fc4bc RD |
38441 | <paramlist> |
38442 | <param name="text" type="String" default=""/> | |
38443 | </paramlist> | |
38444 | </method> | |
38445 | <method name="SetReadOnly" type="" overloaded="no"> | |
781d2982 | 38446 | <autodoc>SetReadOnly(self, bool readOnly)</autodoc> |
f32fc4bc RD |
38447 | <paramlist> |
38448 | <param name="readOnly" type="bool" default=""/> | |
38449 | </paramlist> | |
38450 | </method> | |
38451 | <method name="CanPaste" type="bool" overloaded="no"> | |
781d2982 | 38452 | <autodoc>CanPaste(self) -> bool</autodoc> |
f32fc4bc RD |
38453 | </method> |
38454 | <method name="CanUndo" type="bool" overloaded="no"> | |
781d2982 | 38455 | <autodoc>CanUndo(self) -> bool</autodoc> |
f32fc4bc RD |
38456 | </method> |
38457 | <method name="EmptyUndoBuffer" type="" overloaded="no"> | |
781d2982 | 38458 | <autodoc>EmptyUndoBuffer(self)</autodoc> |
f32fc4bc RD |
38459 | </method> |
38460 | <method name="Undo" type="" overloaded="no"> | |
781d2982 | 38461 | <autodoc>Undo(self)</autodoc> |
f32fc4bc RD |
38462 | </method> |
38463 | <method name="Cut" type="" overloaded="no"> | |
781d2982 | 38464 | <autodoc>Cut(self)</autodoc> |
f32fc4bc RD |
38465 | </method> |
38466 | <method name="Copy" type="" overloaded="no"> | |
781d2982 | 38467 | <autodoc>Copy(self)</autodoc> |
f32fc4bc RD |
38468 | </method> |
38469 | <method name="Paste" type="" overloaded="no"> | |
781d2982 | 38470 | <autodoc>Paste(self)</autodoc> |
f32fc4bc RD |
38471 | </method> |
38472 | <method name="Clear" type="" overloaded="no"> | |
781d2982 | 38473 | <autodoc>Clear(self)</autodoc> |
f32fc4bc RD |
38474 | </method> |
38475 | <method name="SetText" type="" overloaded="no"> | |
781d2982 | 38476 | <autodoc>SetText(self, String text)</autodoc> |
f32fc4bc RD |
38477 | <paramlist> |
38478 | <param name="text" type="String" default=""/> | |
38479 | </paramlist> | |
38480 | </method> | |
38481 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 38482 | <autodoc>GetText(self) -> String</autodoc> |
f32fc4bc RD |
38483 | </method> |
38484 | <method name="GetTextLength" type="int" overloaded="no"> | |
781d2982 | 38485 | <autodoc>GetTextLength(self) -> int</autodoc> |
f32fc4bc RD |
38486 | </method> |
38487 | <method name="SetOvertype" type="" overloaded="no"> | |
781d2982 | 38488 | <autodoc>SetOvertype(self, bool overtype)</autodoc> |
f32fc4bc RD |
38489 | <paramlist> |
38490 | <param name="overtype" type="bool" default=""/> | |
38491 | </paramlist> | |
38492 | </method> | |
38493 | <method name="GetOvertype" type="bool" overloaded="no"> | |
781d2982 | 38494 | <autodoc>GetOvertype(self) -> bool</autodoc> |
f32fc4bc RD |
38495 | </method> |
38496 | <method name="SetCaretWidth" type="" overloaded="no"> | |
781d2982 | 38497 | <autodoc>SetCaretWidth(self, int pixelWidth)</autodoc> |
f32fc4bc RD |
38498 | <paramlist> |
38499 | <param name="pixelWidth" type="int" default=""/> | |
38500 | </paramlist> | |
38501 | </method> | |
38502 | <method name="GetCaretWidth" type="int" overloaded="no"> | |
781d2982 | 38503 | <autodoc>GetCaretWidth(self) -> int</autodoc> |
f32fc4bc RD |
38504 | </method> |
38505 | <method name="SetTargetStart" type="" overloaded="no"> | |
781d2982 | 38506 | <autodoc>SetTargetStart(self, int pos)</autodoc> |
f32fc4bc RD |
38507 | <paramlist> |
38508 | <param name="pos" type="int" default=""/> | |
38509 | </paramlist> | |
38510 | </method> | |
38511 | <method name="GetTargetStart" type="int" overloaded="no"> | |
781d2982 | 38512 | <autodoc>GetTargetStart(self) -> int</autodoc> |
f32fc4bc RD |
38513 | </method> |
38514 | <method name="SetTargetEnd" type="" overloaded="no"> | |
781d2982 | 38515 | <autodoc>SetTargetEnd(self, int pos)</autodoc> |
f32fc4bc RD |
38516 | <paramlist> |
38517 | <param name="pos" type="int" default=""/> | |
38518 | </paramlist> | |
38519 | </method> | |
38520 | <method name="GetTargetEnd" type="int" overloaded="no"> | |
781d2982 | 38521 | <autodoc>GetTargetEnd(self) -> int</autodoc> |
f32fc4bc RD |
38522 | </method> |
38523 | <method name="ReplaceTarget" type="int" overloaded="no"> | |
781d2982 | 38524 | <autodoc>ReplaceTarget(self, String text) -> int</autodoc> |
f32fc4bc RD |
38525 | <paramlist> |
38526 | <param name="text" type="String" default=""/> | |
38527 | </paramlist> | |
38528 | </method> | |
38529 | <method name="ReplaceTargetRE" type="int" overloaded="no"> | |
781d2982 | 38530 | <autodoc>ReplaceTargetRE(self, String text) -> int</autodoc> |
f32fc4bc RD |
38531 | <paramlist> |
38532 | <param name="text" type="String" default=""/> | |
38533 | </paramlist> | |
38534 | </method> | |
38535 | <method name="SearchInTarget" type="int" overloaded="no"> | |
781d2982 | 38536 | <autodoc>SearchInTarget(self, String text) -> int</autodoc> |
f32fc4bc RD |
38537 | <paramlist> |
38538 | <param name="text" type="String" default=""/> | |
38539 | </paramlist> | |
38540 | </method> | |
38541 | <method name="SetSearchFlags" type="" overloaded="no"> | |
781d2982 | 38542 | <autodoc>SetSearchFlags(self, int flags)</autodoc> |
f32fc4bc RD |
38543 | <paramlist> |
38544 | <param name="flags" type="int" default=""/> | |
38545 | </paramlist> | |
38546 | </method> | |
38547 | <method name="GetSearchFlags" type="int" overloaded="no"> | |
781d2982 | 38548 | <autodoc>GetSearchFlags(self) -> int</autodoc> |
f32fc4bc RD |
38549 | </method> |
38550 | <method name="CallTipShow" type="" overloaded="no"> | |
781d2982 | 38551 | <autodoc>CallTipShow(self, int pos, String definition)</autodoc> |
f32fc4bc RD |
38552 | <paramlist> |
38553 | <param name="pos" type="int" default=""/> | |
38554 | <param name="definition" type="String" default=""/> | |
38555 | </paramlist> | |
38556 | </method> | |
38557 | <method name="CallTipCancel" type="" overloaded="no"> | |
781d2982 | 38558 | <autodoc>CallTipCancel(self)</autodoc> |
f32fc4bc RD |
38559 | </method> |
38560 | <method name="CallTipActive" type="bool" overloaded="no"> | |
781d2982 | 38561 | <autodoc>CallTipActive(self) -> bool</autodoc> |
f32fc4bc RD |
38562 | </method> |
38563 | <method name="CallTipPosAtStart" type="int" overloaded="no"> | |
781d2982 | 38564 | <autodoc>CallTipPosAtStart(self) -> int</autodoc> |
f32fc4bc RD |
38565 | </method> |
38566 | <method name="CallTipSetHighlight" type="" overloaded="no"> | |
781d2982 | 38567 | <autodoc>CallTipSetHighlight(self, int start, int end)</autodoc> |
f32fc4bc RD |
38568 | <paramlist> |
38569 | <param name="start" type="int" default=""/> | |
38570 | <param name="end" type="int" default=""/> | |
38571 | </paramlist> | |
38572 | </method> | |
38573 | <method name="CallTipSetBackground" type="" overloaded="no"> | |
781d2982 | 38574 | <autodoc>CallTipSetBackground(self, Colour back)</autodoc> |
f32fc4bc RD |
38575 | <paramlist> |
38576 | <param name="back" type="Colour" default=""/> | |
38577 | </paramlist> | |
38578 | </method> | |
38579 | <method name="CallTipSetForeground" type="" overloaded="no"> | |
781d2982 | 38580 | <autodoc>CallTipSetForeground(self, Colour fore)</autodoc> |
f32fc4bc RD |
38581 | <paramlist> |
38582 | <param name="fore" type="Colour" default=""/> | |
38583 | </paramlist> | |
38584 | </method> | |
38585 | <method name="CallTipSetForegroundHighlight" type="" overloaded="no"> | |
781d2982 | 38586 | <autodoc>CallTipSetForegroundHighlight(self, Colour fore)</autodoc> |
f32fc4bc RD |
38587 | <paramlist> |
38588 | <param name="fore" type="Colour" default=""/> | |
38589 | </paramlist> | |
38590 | </method> | |
38591 | <method name="VisibleFromDocLine" type="int" overloaded="no"> | |
781d2982 | 38592 | <autodoc>VisibleFromDocLine(self, int line) -> int</autodoc> |
f32fc4bc RD |
38593 | <paramlist> |
38594 | <param name="line" type="int" default=""/> | |
38595 | </paramlist> | |
38596 | </method> | |
38597 | <method name="DocLineFromVisible" type="int" overloaded="no"> | |
781d2982 | 38598 | <autodoc>DocLineFromVisible(self, int lineDisplay) -> int</autodoc> |
f32fc4bc RD |
38599 | <paramlist> |
38600 | <param name="lineDisplay" type="int" default=""/> | |
38601 | </paramlist> | |
38602 | </method> | |
38603 | <method name="SetFoldLevel" type="" overloaded="no"> | |
781d2982 | 38604 | <autodoc>SetFoldLevel(self, int line, int level)</autodoc> |
f32fc4bc RD |
38605 | <paramlist> |
38606 | <param name="line" type="int" default=""/> | |
38607 | <param name="level" type="int" default=""/> | |
38608 | </paramlist> | |
38609 | </method> | |
38610 | <method name="GetFoldLevel" type="int" overloaded="no"> | |
781d2982 | 38611 | <autodoc>GetFoldLevel(self, int line) -> int</autodoc> |
f32fc4bc RD |
38612 | <paramlist> |
38613 | <param name="line" type="int" default=""/> | |
38614 | </paramlist> | |
38615 | </method> | |
38616 | <method name="GetLastChild" type="int" overloaded="no"> | |
781d2982 | 38617 | <autodoc>GetLastChild(self, int line, int level) -> int</autodoc> |
f32fc4bc RD |
38618 | <paramlist> |
38619 | <param name="line" type="int" default=""/> | |
38620 | <param name="level" type="int" default=""/> | |
38621 | </paramlist> | |
38622 | </method> | |
38623 | <method name="GetFoldParent" type="int" overloaded="no"> | |
781d2982 | 38624 | <autodoc>GetFoldParent(self, int line) -> int</autodoc> |
f32fc4bc RD |
38625 | <paramlist> |
38626 | <param name="line" type="int" default=""/> | |
38627 | </paramlist> | |
38628 | </method> | |
38629 | <method name="ShowLines" type="" overloaded="no"> | |
781d2982 | 38630 | <autodoc>ShowLines(self, int lineStart, int lineEnd)</autodoc> |
f32fc4bc RD |
38631 | <paramlist> |
38632 | <param name="lineStart" type="int" default=""/> | |
38633 | <param name="lineEnd" type="int" default=""/> | |
38634 | </paramlist> | |
38635 | </method> | |
38636 | <method name="HideLines" type="" overloaded="no"> | |
781d2982 | 38637 | <autodoc>HideLines(self, int lineStart, int lineEnd)</autodoc> |
f32fc4bc RD |
38638 | <paramlist> |
38639 | <param name="lineStart" type="int" default=""/> | |
38640 | <param name="lineEnd" type="int" default=""/> | |
38641 | </paramlist> | |
38642 | </method> | |
38643 | <method name="GetLineVisible" type="bool" overloaded="no"> | |
781d2982 | 38644 | <autodoc>GetLineVisible(self, int line) -> bool</autodoc> |
f32fc4bc RD |
38645 | <paramlist> |
38646 | <param name="line" type="int" default=""/> | |
38647 | </paramlist> | |
38648 | </method> | |
38649 | <method name="SetFoldExpanded" type="" overloaded="no"> | |
781d2982 | 38650 | <autodoc>SetFoldExpanded(self, int line, bool expanded)</autodoc> |
f32fc4bc RD |
38651 | <paramlist> |
38652 | <param name="line" type="int" default=""/> | |
38653 | <param name="expanded" type="bool" default=""/> | |
38654 | </paramlist> | |
38655 | </method> | |
38656 | <method name="GetFoldExpanded" type="bool" overloaded="no"> | |
781d2982 | 38657 | <autodoc>GetFoldExpanded(self, int line) -> bool</autodoc> |
f32fc4bc RD |
38658 | <paramlist> |
38659 | <param name="line" type="int" default=""/> | |
38660 | </paramlist> | |
38661 | </method> | |
38662 | <method name="ToggleFold" type="" overloaded="no"> | |
781d2982 | 38663 | <autodoc>ToggleFold(self, int line)</autodoc> |
f32fc4bc RD |
38664 | <paramlist> |
38665 | <param name="line" type="int" default=""/> | |
38666 | </paramlist> | |
38667 | </method> | |
38668 | <method name="EnsureVisible" type="" overloaded="no"> | |
781d2982 | 38669 | <autodoc>EnsureVisible(self, int line)</autodoc> |
f32fc4bc RD |
38670 | <paramlist> |
38671 | <param name="line" type="int" default=""/> | |
38672 | </paramlist> | |
38673 | </method> | |
38674 | <method name="SetFoldFlags" type="" overloaded="no"> | |
781d2982 | 38675 | <autodoc>SetFoldFlags(self, int flags)</autodoc> |
f32fc4bc RD |
38676 | <paramlist> |
38677 | <param name="flags" type="int" default=""/> | |
38678 | </paramlist> | |
38679 | </method> | |
38680 | <method name="EnsureVisibleEnforcePolicy" type="" overloaded="no"> | |
781d2982 | 38681 | <autodoc>EnsureVisibleEnforcePolicy(self, int line)</autodoc> |
f32fc4bc RD |
38682 | <paramlist> |
38683 | <param name="line" type="int" default=""/> | |
38684 | </paramlist> | |
38685 | </method> | |
38686 | <method name="SetTabIndents" type="" overloaded="no"> | |
781d2982 | 38687 | <autodoc>SetTabIndents(self, bool tabIndents)</autodoc> |
f32fc4bc RD |
38688 | <paramlist> |
38689 | <param name="tabIndents" type="bool" default=""/> | |
38690 | </paramlist> | |
38691 | </method> | |
38692 | <method name="GetTabIndents" type="bool" overloaded="no"> | |
781d2982 | 38693 | <autodoc>GetTabIndents(self) -> bool</autodoc> |
f32fc4bc RD |
38694 | </method> |
38695 | <method name="SetBackSpaceUnIndents" type="" overloaded="no"> | |
781d2982 | 38696 | <autodoc>SetBackSpaceUnIndents(self, bool bsUnIndents)</autodoc> |
f32fc4bc RD |
38697 | <paramlist> |
38698 | <param name="bsUnIndents" type="bool" default=""/> | |
38699 | </paramlist> | |
38700 | </method> | |
38701 | <method name="GetBackSpaceUnIndents" type="bool" overloaded="no"> | |
781d2982 | 38702 | <autodoc>GetBackSpaceUnIndents(self) -> bool</autodoc> |
f32fc4bc RD |
38703 | </method> |
38704 | <method name="SetMouseDwellTime" type="" overloaded="no"> | |
781d2982 | 38705 | <autodoc>SetMouseDwellTime(self, int periodMilliseconds)</autodoc> |
f32fc4bc RD |
38706 | <paramlist> |
38707 | <param name="periodMilliseconds" type="int" default=""/> | |
38708 | </paramlist> | |
38709 | </method> | |
38710 | <method name="GetMouseDwellTime" type="int" overloaded="no"> | |
781d2982 | 38711 | <autodoc>GetMouseDwellTime(self) -> int</autodoc> |
f32fc4bc RD |
38712 | </method> |
38713 | <method name="WordStartPosition" type="int" overloaded="no"> | |
781d2982 | 38714 | <autodoc>WordStartPosition(self, int pos, bool onlyWordCharacters) -> int</autodoc> |
f32fc4bc RD |
38715 | <paramlist> |
38716 | <param name="pos" type="int" default=""/> | |
38717 | <param name="onlyWordCharacters" type="bool" default=""/> | |
38718 | </paramlist> | |
38719 | </method> | |
38720 | <method name="WordEndPosition" type="int" overloaded="no"> | |
781d2982 | 38721 | <autodoc>WordEndPosition(self, int pos, bool onlyWordCharacters) -> int</autodoc> |
f32fc4bc RD |
38722 | <paramlist> |
38723 | <param name="pos" type="int" default=""/> | |
38724 | <param name="onlyWordCharacters" type="bool" default=""/> | |
38725 | </paramlist> | |
38726 | </method> | |
38727 | <method name="SetWrapMode" type="" overloaded="no"> | |
781d2982 | 38728 | <autodoc>SetWrapMode(self, int mode)</autodoc> |
f32fc4bc RD |
38729 | <paramlist> |
38730 | <param name="mode" type="int" default=""/> | |
38731 | </paramlist> | |
38732 | </method> | |
38733 | <method name="GetWrapMode" type="int" overloaded="no"> | |
781d2982 | 38734 | <autodoc>GetWrapMode(self) -> int</autodoc> |
f32fc4bc RD |
38735 | </method> |
38736 | <method name="SetLayoutCache" type="" overloaded="no"> | |
781d2982 | 38737 | <autodoc>SetLayoutCache(self, int mode)</autodoc> |
f32fc4bc RD |
38738 | <paramlist> |
38739 | <param name="mode" type="int" default=""/> | |
38740 | </paramlist> | |
38741 | </method> | |
38742 | <method name="GetLayoutCache" type="int" overloaded="no"> | |
781d2982 | 38743 | <autodoc>GetLayoutCache(self) -> int</autodoc> |
f32fc4bc RD |
38744 | </method> |
38745 | <method name="SetScrollWidth" type="" overloaded="no"> | |
781d2982 | 38746 | <autodoc>SetScrollWidth(self, int pixelWidth)</autodoc> |
f32fc4bc RD |
38747 | <paramlist> |
38748 | <param name="pixelWidth" type="int" default=""/> | |
38749 | </paramlist> | |
38750 | </method> | |
38751 | <method name="GetScrollWidth" type="int" overloaded="no"> | |
781d2982 | 38752 | <autodoc>GetScrollWidth(self) -> int</autodoc> |
f32fc4bc RD |
38753 | </method> |
38754 | <method name="TextWidth" type="int" overloaded="no"> | |
781d2982 | 38755 | <autodoc>TextWidth(self, int style, String text) -> int</autodoc> |
f32fc4bc RD |
38756 | <paramlist> |
38757 | <param name="style" type="int" default=""/> | |
38758 | <param name="text" type="String" default=""/> | |
38759 | </paramlist> | |
38760 | </method> | |
38761 | <method name="SetEndAtLastLine" type="" overloaded="no"> | |
781d2982 | 38762 | <autodoc>SetEndAtLastLine(self, bool endAtLastLine)</autodoc> |
f32fc4bc RD |
38763 | <paramlist> |
38764 | <param name="endAtLastLine" type="bool" default=""/> | |
38765 | </paramlist> | |
38766 | </method> | |
38767 | <method name="GetEndAtLastLine" type="int" overloaded="no"> | |
781d2982 | 38768 | <autodoc>GetEndAtLastLine(self) -> int</autodoc> |
f32fc4bc RD |
38769 | </method> |
38770 | <method name="TextHeight" type="int" overloaded="no"> | |
781d2982 | 38771 | <autodoc>TextHeight(self, int line) -> int</autodoc> |
f32fc4bc RD |
38772 | <paramlist> |
38773 | <param name="line" type="int" default=""/> | |
38774 | </paramlist> | |
38775 | </method> | |
38776 | <method name="SetUseVerticalScrollBar" type="" overloaded="no"> | |
781d2982 | 38777 | <autodoc>SetUseVerticalScrollBar(self, bool show)</autodoc> |
f32fc4bc RD |
38778 | <paramlist> |
38779 | <param name="show" type="bool" default=""/> | |
38780 | </paramlist> | |
38781 | </method> | |
38782 | <method name="GetUseVerticalScrollBar" type="bool" overloaded="no"> | |
781d2982 | 38783 | <autodoc>GetUseVerticalScrollBar(self) -> bool</autodoc> |
f32fc4bc RD |
38784 | </method> |
38785 | <method name="AppendText" type="" overloaded="no"> | |
781d2982 | 38786 | <autodoc>AppendText(self, int length, String text)</autodoc> |
f32fc4bc RD |
38787 | <paramlist> |
38788 | <param name="length" type="int" default=""/> | |
38789 | <param name="text" type="String" default=""/> | |
38790 | </paramlist> | |
38791 | </method> | |
38792 | <method name="GetTwoPhaseDraw" type="bool" overloaded="no"> | |
781d2982 | 38793 | <autodoc>GetTwoPhaseDraw(self) -> bool</autodoc> |
f32fc4bc RD |
38794 | </method> |
38795 | <method name="SetTwoPhaseDraw" type="" overloaded="no"> | |
781d2982 | 38796 | <autodoc>SetTwoPhaseDraw(self, bool twoPhase)</autodoc> |
f32fc4bc RD |
38797 | <paramlist> |
38798 | <param name="twoPhase" type="bool" default=""/> | |
38799 | </paramlist> | |
38800 | </method> | |
38801 | <method name="TargetFromSelection" type="" overloaded="no"> | |
781d2982 | 38802 | <autodoc>TargetFromSelection(self)</autodoc> |
f32fc4bc RD |
38803 | </method> |
38804 | <method name="LinesJoin" type="" overloaded="no"> | |
781d2982 | 38805 | <autodoc>LinesJoin(self)</autodoc> |
f32fc4bc RD |
38806 | </method> |
38807 | <method name="LinesSplit" type="" overloaded="no"> | |
781d2982 | 38808 | <autodoc>LinesSplit(self, int pixelWidth)</autodoc> |
f32fc4bc RD |
38809 | <paramlist> |
38810 | <param name="pixelWidth" type="int" default=""/> | |
38811 | </paramlist> | |
38812 | </method> | |
38813 | <method name="SetFoldMarginColour" type="" overloaded="no"> | |
781d2982 | 38814 | <autodoc>SetFoldMarginColour(self, bool useSetting, Colour back)</autodoc> |
f32fc4bc RD |
38815 | <paramlist> |
38816 | <param name="useSetting" type="bool" default=""/> | |
38817 | <param name="back" type="Colour" default=""/> | |
38818 | </paramlist> | |
38819 | </method> | |
38820 | <method name="SetFoldMarginHiColour" type="" overloaded="no"> | |
781d2982 | 38821 | <autodoc>SetFoldMarginHiColour(self, bool useSetting, Colour fore)</autodoc> |
f32fc4bc RD |
38822 | <paramlist> |
38823 | <param name="useSetting" type="bool" default=""/> | |
38824 | <param name="fore" type="Colour" default=""/> | |
38825 | </paramlist> | |
38826 | </method> | |
b39e211b | 38827 | <method name="LineDown" type="" overloaded="no"> |
781d2982 | 38828 | <autodoc>LineDown(self)</autodoc> |
b39e211b RD |
38829 | <docstring>This is just a wrapper for ScrollLines(1).</docstring> |
38830 | </method> | |
38831 | <method name="LineDownExtend" type="" overloaded="no"> | |
781d2982 | 38832 | <autodoc>LineDownExtend(self)</autodoc> |
b39e211b RD |
38833 | </method> |
38834 | <method name="LineUp" type="" overloaded="no"> | |
781d2982 | 38835 | <autodoc>LineUp(self)</autodoc> |
b39e211b RD |
38836 | <docstring>This is just a wrapper for ScrollLines(-1).</docstring> |
38837 | </method> | |
38838 | <method name="LineUpExtend" type="" overloaded="no"> | |
781d2982 | 38839 | <autodoc>LineUpExtend(self)</autodoc> |
b39e211b RD |
38840 | </method> |
38841 | <method name="CharLeft" type="" overloaded="no"> | |
781d2982 | 38842 | <autodoc>CharLeft(self)</autodoc> |
b39e211b RD |
38843 | </method> |
38844 | <method name="CharLeftExtend" type="" overloaded="no"> | |
781d2982 | 38845 | <autodoc>CharLeftExtend(self)</autodoc> |
b39e211b RD |
38846 | </method> |
38847 | <method name="CharRight" type="" overloaded="no"> | |
781d2982 | 38848 | <autodoc>CharRight(self)</autodoc> |
b39e211b RD |
38849 | </method> |
38850 | <method name="CharRightExtend" type="" overloaded="no"> | |
781d2982 | 38851 | <autodoc>CharRightExtend(self)</autodoc> |
b39e211b RD |
38852 | </method> |
38853 | <method name="WordLeft" type="" overloaded="no"> | |
781d2982 | 38854 | <autodoc>WordLeft(self)</autodoc> |
b39e211b RD |
38855 | </method> |
38856 | <method name="WordLeftExtend" type="" overloaded="no"> | |
781d2982 | 38857 | <autodoc>WordLeftExtend(self)</autodoc> |
b39e211b RD |
38858 | </method> |
38859 | <method name="WordRight" type="" overloaded="no"> | |
781d2982 | 38860 | <autodoc>WordRight(self)</autodoc> |
b39e211b RD |
38861 | </method> |
38862 | <method name="WordRightExtend" type="" overloaded="no"> | |
781d2982 | 38863 | <autodoc>WordRightExtend(self)</autodoc> |
b39e211b RD |
38864 | </method> |
38865 | <method name="Home" type="" overloaded="no"> | |
781d2982 | 38866 | <autodoc>Home(self)</autodoc> |
b39e211b RD |
38867 | </method> |
38868 | <method name="HomeExtend" type="" overloaded="no"> | |
781d2982 | 38869 | <autodoc>HomeExtend(self)</autodoc> |
b39e211b RD |
38870 | </method> |
38871 | <method name="LineEnd" type="" overloaded="no"> | |
781d2982 | 38872 | <autodoc>LineEnd(self)</autodoc> |
b39e211b RD |
38873 | </method> |
38874 | <method name="LineEndExtend" type="" overloaded="no"> | |
781d2982 | 38875 | <autodoc>LineEndExtend(self)</autodoc> |
b39e211b RD |
38876 | </method> |
38877 | <method name="DocumentStart" type="" overloaded="no"> | |
781d2982 | 38878 | <autodoc>DocumentStart(self)</autodoc> |
b39e211b RD |
38879 | </method> |
38880 | <method name="DocumentStartExtend" type="" overloaded="no"> | |
781d2982 | 38881 | <autodoc>DocumentStartExtend(self)</autodoc> |
b39e211b RD |
38882 | </method> |
38883 | <method name="DocumentEnd" type="" overloaded="no"> | |
781d2982 | 38884 | <autodoc>DocumentEnd(self)</autodoc> |
b39e211b RD |
38885 | </method> |
38886 | <method name="DocumentEndExtend" type="" overloaded="no"> | |
781d2982 | 38887 | <autodoc>DocumentEndExtend(self)</autodoc> |
b39e211b RD |
38888 | </method> |
38889 | <method name="PageUp" type="" overloaded="no"> | |
781d2982 | 38890 | <autodoc>PageUp(self)</autodoc> |
b39e211b RD |
38891 | <docstring>This is just a wrapper for ScrollPages(-1).</docstring> |
38892 | </method> | |
38893 | <method name="PageUpExtend" type="" overloaded="no"> | |
781d2982 | 38894 | <autodoc>PageUpExtend(self)</autodoc> |
b39e211b RD |
38895 | </method> |
38896 | <method name="PageDown" type="" overloaded="no"> | |
781d2982 | 38897 | <autodoc>PageDown(self)</autodoc> |
b39e211b RD |
38898 | <docstring>This is just a wrapper for ScrollPages(1).</docstring> |
38899 | </method> | |
38900 | <method name="PageDownExtend" type="" overloaded="no"> | |
781d2982 | 38901 | <autodoc>PageDownExtend(self)</autodoc> |
b39e211b RD |
38902 | </method> |
38903 | <method name="EditToggleOvertype" type="" overloaded="no"> | |
781d2982 | 38904 | <autodoc>EditToggleOvertype(self)</autodoc> |
b39e211b RD |
38905 | </method> |
38906 | <method name="Cancel" type="" overloaded="no"> | |
781d2982 | 38907 | <autodoc>Cancel(self)</autodoc> |
b39e211b RD |
38908 | </method> |
38909 | <method name="DeleteBack" type="" overloaded="no"> | |
781d2982 | 38910 | <autodoc>DeleteBack(self)</autodoc> |
b39e211b RD |
38911 | </method> |
38912 | <method name="Tab" type="" overloaded="no"> | |
781d2982 | 38913 | <autodoc>Tab(self)</autodoc> |
b39e211b RD |
38914 | </method> |
38915 | <method name="BackTab" type="" overloaded="no"> | |
781d2982 | 38916 | <autodoc>BackTab(self)</autodoc> |
b39e211b RD |
38917 | </method> |
38918 | <method name="NewLine" type="" overloaded="no"> | |
781d2982 | 38919 | <autodoc>NewLine(self)</autodoc> |
b39e211b RD |
38920 | </method> |
38921 | <method name="FormFeed" type="" overloaded="no"> | |
781d2982 | 38922 | <autodoc>FormFeed(self)</autodoc> |
b39e211b RD |
38923 | </method> |
38924 | <method name="VCHome" type="" overloaded="no"> | |
781d2982 | 38925 | <autodoc>VCHome(self)</autodoc> |
b39e211b RD |
38926 | </method> |
38927 | <method name="VCHomeExtend" type="" overloaded="no"> | |
781d2982 | 38928 | <autodoc>VCHomeExtend(self)</autodoc> |
b39e211b RD |
38929 | </method> |
38930 | <method name="ZoomIn" type="" overloaded="no"> | |
781d2982 | 38931 | <autodoc>ZoomIn(self)</autodoc> |
b39e211b RD |
38932 | </method> |
38933 | <method name="ZoomOut" type="" overloaded="no"> | |
781d2982 | 38934 | <autodoc>ZoomOut(self)</autodoc> |
b39e211b RD |
38935 | </method> |
38936 | <method name="DelWordLeft" type="" overloaded="no"> | |
781d2982 | 38937 | <autodoc>DelWordLeft(self)</autodoc> |
b39e211b RD |
38938 | </method> |
38939 | <method name="DelWordRight" type="" overloaded="no"> | |
781d2982 | 38940 | <autodoc>DelWordRight(self)</autodoc> |
b39e211b RD |
38941 | </method> |
38942 | <method name="LineCut" type="" overloaded="no"> | |
781d2982 | 38943 | <autodoc>LineCut(self)</autodoc> |
b39e211b RD |
38944 | </method> |
38945 | <method name="LineDelete" type="" overloaded="no"> | |
781d2982 | 38946 | <autodoc>LineDelete(self)</autodoc> |
b39e211b RD |
38947 | </method> |
38948 | <method name="LineTranspose" type="" overloaded="no"> | |
781d2982 | 38949 | <autodoc>LineTranspose(self)</autodoc> |
b39e211b | 38950 | </method> |
f32fc4bc | 38951 | <method name="LineDuplicate" type="" overloaded="no"> |
781d2982 | 38952 | <autodoc>LineDuplicate(self)</autodoc> |
f32fc4bc | 38953 | </method> |
b39e211b | 38954 | <method name="LowerCase" type="" overloaded="no"> |
781d2982 | 38955 | <autodoc>LowerCase(self)</autodoc> |
b39e211b RD |
38956 | </method> |
38957 | <method name="UpperCase" type="" overloaded="no"> | |
781d2982 | 38958 | <autodoc>UpperCase(self)</autodoc> |
b39e211b RD |
38959 | </method> |
38960 | <method name="LineScrollDown" type="" overloaded="no"> | |
781d2982 | 38961 | <autodoc>LineScrollDown(self)</autodoc> |
b39e211b RD |
38962 | </method> |
38963 | <method name="LineScrollUp" type="" overloaded="no"> | |
781d2982 | 38964 | <autodoc>LineScrollUp(self)</autodoc> |
b39e211b RD |
38965 | </method> |
38966 | <method name="DeleteBackNotLine" type="" overloaded="no"> | |
781d2982 | 38967 | <autodoc>DeleteBackNotLine(self)</autodoc> |
b39e211b | 38968 | </method> |
f32fc4bc | 38969 | <method name="HomeDisplay" type="" overloaded="no"> |
781d2982 | 38970 | <autodoc>HomeDisplay(self)</autodoc> |
f32fc4bc RD |
38971 | </method> |
38972 | <method name="HomeDisplayExtend" type="" overloaded="no"> | |
781d2982 | 38973 | <autodoc>HomeDisplayExtend(self)</autodoc> |
f32fc4bc RD |
38974 | </method> |
38975 | <method name="LineEndDisplay" type="" overloaded="no"> | |
781d2982 | 38976 | <autodoc>LineEndDisplay(self)</autodoc> |
f32fc4bc RD |
38977 | </method> |
38978 | <method name="LineEndDisplayExtend" type="" overloaded="no"> | |
781d2982 | 38979 | <autodoc>LineEndDisplayExtend(self)</autodoc> |
f32fc4bc | 38980 | </method> |
b39e211b | 38981 | <method name="HomeWrap" type="" overloaded="no"> |
781d2982 | 38982 | <autodoc>HomeWrap(self)</autodoc> |
b39e211b RD |
38983 | </method> |
38984 | <method name="HomeWrapExtend" type="" overloaded="no"> | |
781d2982 | 38985 | <autodoc>HomeWrapExtend(self)</autodoc> |
b39e211b RD |
38986 | </method> |
38987 | <method name="LineEndWrap" type="" overloaded="no"> | |
781d2982 | 38988 | <autodoc>LineEndWrap(self)</autodoc> |
b39e211b RD |
38989 | </method> |
38990 | <method name="LineEndWrapExtend" type="" overloaded="no"> | |
781d2982 | 38991 | <autodoc>LineEndWrapExtend(self)</autodoc> |
b39e211b RD |
38992 | </method> |
38993 | <method name="VCHomeWrap" type="" overloaded="no"> | |
781d2982 | 38994 | <autodoc>VCHomeWrap(self)</autodoc> |
b39e211b RD |
38995 | </method> |
38996 | <method name="VCHomeWrapExtend" type="" overloaded="no"> | |
781d2982 | 38997 | <autodoc>VCHomeWrapExtend(self)</autodoc> |
b39e211b | 38998 | </method> |
f32fc4bc | 38999 | <method name="LineCopy" type="" overloaded="no"> |
781d2982 | 39000 | <autodoc>LineCopy(self)</autodoc> |
f32fc4bc RD |
39001 | </method> |
39002 | <method name="MoveCaretInsideView" type="" overloaded="no"> | |
781d2982 | 39003 | <autodoc>MoveCaretInsideView(self)</autodoc> |
f32fc4bc RD |
39004 | </method> |
39005 | <method name="LineLength" type="int" overloaded="no"> | |
781d2982 | 39006 | <autodoc>LineLength(self, int line) -> int</autodoc> |
f32fc4bc RD |
39007 | <paramlist> |
39008 | <param name="line" type="int" default=""/> | |
39009 | </paramlist> | |
39010 | </method> | |
39011 | <method name="BraceHighlight" type="" overloaded="no"> | |
781d2982 | 39012 | <autodoc>BraceHighlight(self, int pos1, int pos2)</autodoc> |
f32fc4bc RD |
39013 | <paramlist> |
39014 | <param name="pos1" type="int" default=""/> | |
39015 | <param name="pos2" type="int" default=""/> | |
39016 | </paramlist> | |
39017 | </method> | |
39018 | <method name="BraceBadLight" type="" overloaded="no"> | |
781d2982 | 39019 | <autodoc>BraceBadLight(self, int pos)</autodoc> |
f32fc4bc RD |
39020 | <paramlist> |
39021 | <param name="pos" type="int" default=""/> | |
39022 | </paramlist> | |
39023 | </method> | |
39024 | <method name="BraceMatch" type="int" overloaded="no"> | |
781d2982 | 39025 | <autodoc>BraceMatch(self, int pos) -> int</autodoc> |
f32fc4bc RD |
39026 | <paramlist> |
39027 | <param name="pos" type="int" default=""/> | |
39028 | </paramlist> | |
39029 | </method> | |
39030 | <method name="GetViewEOL" type="bool" overloaded="no"> | |
781d2982 | 39031 | <autodoc>GetViewEOL(self) -> bool</autodoc> |
f32fc4bc RD |
39032 | </method> |
39033 | <method name="SetViewEOL" type="" overloaded="no"> | |
781d2982 | 39034 | <autodoc>SetViewEOL(self, bool visible)</autodoc> |
f32fc4bc RD |
39035 | <paramlist> |
39036 | <param name="visible" type="bool" default=""/> | |
39037 | </paramlist> | |
39038 | </method> | |
39039 | <method name="GetDocPointer" type="" overloaded="no"> | |
781d2982 | 39040 | <autodoc>GetDocPointer(self) -> void</autodoc> |
f32fc4bc RD |
39041 | </method> |
39042 | <method name="SetDocPointer" type="" overloaded="no"> | |
781d2982 | 39043 | <autodoc>SetDocPointer(self, void docPointer)</autodoc> |
f32fc4bc RD |
39044 | <paramlist> |
39045 | <param name="docPointer" type="" default=""/> | |
39046 | </paramlist> | |
39047 | </method> | |
39048 | <method name="SetModEventMask" type="" overloaded="no"> | |
781d2982 | 39049 | <autodoc>SetModEventMask(self, int mask)</autodoc> |
f32fc4bc RD |
39050 | <paramlist> |
39051 | <param name="mask" type="int" default=""/> | |
39052 | </paramlist> | |
39053 | </method> | |
39054 | <method name="GetEdgeColumn" type="int" overloaded="no"> | |
781d2982 | 39055 | <autodoc>GetEdgeColumn(self) -> int</autodoc> |
f32fc4bc RD |
39056 | </method> |
39057 | <method name="SetEdgeColumn" type="" overloaded="no"> | |
781d2982 | 39058 | <autodoc>SetEdgeColumn(self, int column)</autodoc> |
f32fc4bc RD |
39059 | <paramlist> |
39060 | <param name="column" type="int" default=""/> | |
39061 | </paramlist> | |
39062 | </method> | |
39063 | <method name="GetEdgeMode" type="int" overloaded="no"> | |
781d2982 | 39064 | <autodoc>GetEdgeMode(self) -> int</autodoc> |
f32fc4bc RD |
39065 | </method> |
39066 | <method name="SetEdgeMode" type="" overloaded="no"> | |
781d2982 | 39067 | <autodoc>SetEdgeMode(self, int mode)</autodoc> |
f32fc4bc RD |
39068 | <paramlist> |
39069 | <param name="mode" type="int" default=""/> | |
39070 | </paramlist> | |
39071 | </method> | |
39072 | <method name="GetEdgeColour" type="Colour" overloaded="no"> | |
781d2982 | 39073 | <autodoc>GetEdgeColour(self) -> Colour</autodoc> |
f32fc4bc RD |
39074 | </method> |
39075 | <method name="SetEdgeColour" type="" overloaded="no"> | |
781d2982 | 39076 | <autodoc>SetEdgeColour(self, Colour edgeColour)</autodoc> |
f32fc4bc RD |
39077 | <paramlist> |
39078 | <param name="edgeColour" type="Colour" default=""/> | |
39079 | </paramlist> | |
39080 | </method> | |
39081 | <method name="SearchAnchor" type="" overloaded="no"> | |
781d2982 | 39082 | <autodoc>SearchAnchor(self)</autodoc> |
f32fc4bc RD |
39083 | </method> |
39084 | <method name="SearchNext" type="int" overloaded="no"> | |
781d2982 | 39085 | <autodoc>SearchNext(self, int flags, String text) -> int</autodoc> |
f32fc4bc RD |
39086 | <paramlist> |
39087 | <param name="flags" type="int" default=""/> | |
39088 | <param name="text" type="String" default=""/> | |
39089 | </paramlist> | |
39090 | </method> | |
39091 | <method name="SearchPrev" type="int" overloaded="no"> | |
781d2982 | 39092 | <autodoc>SearchPrev(self, int flags, String text) -> int</autodoc> |
f32fc4bc RD |
39093 | <paramlist> |
39094 | <param name="flags" type="int" default=""/> | |
39095 | <param name="text" type="String" default=""/> | |
39096 | </paramlist> | |
39097 | </method> | |
39098 | <method name="LinesOnScreen" type="int" overloaded="no"> | |
781d2982 | 39099 | <autodoc>LinesOnScreen(self) -> int</autodoc> |
f32fc4bc RD |
39100 | </method> |
39101 | <method name="UsePopUp" type="" overloaded="no"> | |
781d2982 | 39102 | <autodoc>UsePopUp(self, bool allowPopUp)</autodoc> |
f32fc4bc RD |
39103 | <paramlist> |
39104 | <param name="allowPopUp" type="bool" default=""/> | |
39105 | </paramlist> | |
39106 | </method> | |
39107 | <method name="SelectionIsRectangle" type="bool" overloaded="no"> | |
781d2982 | 39108 | <autodoc>SelectionIsRectangle(self) -> bool</autodoc> |
f32fc4bc RD |
39109 | </method> |
39110 | <method name="SetZoom" type="" overloaded="no"> | |
781d2982 | 39111 | <autodoc>SetZoom(self, int zoom)</autodoc> |
f32fc4bc RD |
39112 | <paramlist> |
39113 | <param name="zoom" type="int" default=""/> | |
39114 | </paramlist> | |
39115 | </method> | |
39116 | <method name="GetZoom" type="int" overloaded="no"> | |
781d2982 | 39117 | <autodoc>GetZoom(self) -> int</autodoc> |
f32fc4bc RD |
39118 | </method> |
39119 | <method name="CreateDocument" type="" overloaded="no"> | |
781d2982 | 39120 | <autodoc>CreateDocument(self) -> void</autodoc> |
f32fc4bc RD |
39121 | </method> |
39122 | <method name="AddRefDocument" type="" overloaded="no"> | |
781d2982 | 39123 | <autodoc>AddRefDocument(self, void docPointer)</autodoc> |
f32fc4bc RD |
39124 | <paramlist> |
39125 | <param name="docPointer" type="" default=""/> | |
39126 | </paramlist> | |
39127 | </method> | |
39128 | <method name="ReleaseDocument" type="" overloaded="no"> | |
781d2982 | 39129 | <autodoc>ReleaseDocument(self, void docPointer)</autodoc> |
f32fc4bc RD |
39130 | <paramlist> |
39131 | <param name="docPointer" type="" default=""/> | |
39132 | </paramlist> | |
39133 | </method> | |
39134 | <method name="GetModEventMask" type="int" overloaded="no"> | |
781d2982 | 39135 | <autodoc>GetModEventMask(self) -> int</autodoc> |
f32fc4bc RD |
39136 | </method> |
39137 | <method name="SetSTCFocus" type="" overloaded="no"> | |
781d2982 | 39138 | <autodoc>SetSTCFocus(self, bool focus)</autodoc> |
f32fc4bc RD |
39139 | <paramlist> |
39140 | <param name="focus" type="bool" default=""/> | |
39141 | </paramlist> | |
39142 | </method> | |
39143 | <method name="GetSTCFocus" type="bool" overloaded="no"> | |
781d2982 | 39144 | <autodoc>GetSTCFocus(self) -> bool</autodoc> |
f32fc4bc RD |
39145 | </method> |
39146 | <method name="SetStatus" type="" overloaded="no"> | |
781d2982 | 39147 | <autodoc>SetStatus(self, int statusCode)</autodoc> |
f32fc4bc RD |
39148 | <paramlist> |
39149 | <param name="statusCode" type="int" default=""/> | |
39150 | </paramlist> | |
39151 | </method> | |
39152 | <method name="GetStatus" type="int" overloaded="no"> | |
781d2982 | 39153 | <autodoc>GetStatus(self) -> int</autodoc> |
f32fc4bc RD |
39154 | </method> |
39155 | <method name="SetMouseDownCaptures" type="" overloaded="no"> | |
781d2982 | 39156 | <autodoc>SetMouseDownCaptures(self, bool captures)</autodoc> |
f32fc4bc RD |
39157 | <paramlist> |
39158 | <param name="captures" type="bool" default=""/> | |
39159 | </paramlist> | |
39160 | </method> | |
39161 | <method name="GetMouseDownCaptures" type="bool" overloaded="no"> | |
781d2982 | 39162 | <autodoc>GetMouseDownCaptures(self) -> bool</autodoc> |
f32fc4bc RD |
39163 | </method> |
39164 | <method name="SetSTCCursor" type="" overloaded="no"> | |
781d2982 | 39165 | <autodoc>SetSTCCursor(self, int cursorType)</autodoc> |
f32fc4bc RD |
39166 | <paramlist> |
39167 | <param name="cursorType" type="int" default=""/> | |
39168 | </paramlist> | |
39169 | </method> | |
39170 | <method name="GetSTCCursor" type="int" overloaded="no"> | |
781d2982 | 39171 | <autodoc>GetSTCCursor(self) -> int</autodoc> |
f32fc4bc RD |
39172 | </method> |
39173 | <method name="SetControlCharSymbol" type="" overloaded="no"> | |
781d2982 | 39174 | <autodoc>SetControlCharSymbol(self, int symbol)</autodoc> |
f32fc4bc RD |
39175 | <paramlist> |
39176 | <param name="symbol" type="int" default=""/> | |
39177 | </paramlist> | |
39178 | </method> | |
39179 | <method name="GetControlCharSymbol" type="int" overloaded="no"> | |
781d2982 | 39180 | <autodoc>GetControlCharSymbol(self) -> int</autodoc> |
f32fc4bc RD |
39181 | </method> |
39182 | <method name="WordPartLeft" type="" overloaded="no"> | |
781d2982 | 39183 | <autodoc>WordPartLeft(self)</autodoc> |
f32fc4bc RD |
39184 | </method> |
39185 | <method name="WordPartLeftExtend" type="" overloaded="no"> | |
781d2982 | 39186 | <autodoc>WordPartLeftExtend(self)</autodoc> |
f32fc4bc RD |
39187 | </method> |
39188 | <method name="WordPartRight" type="" overloaded="no"> | |
781d2982 | 39189 | <autodoc>WordPartRight(self)</autodoc> |
f32fc4bc RD |
39190 | </method> |
39191 | <method name="WordPartRightExtend" type="" overloaded="no"> | |
781d2982 | 39192 | <autodoc>WordPartRightExtend(self)</autodoc> |
f32fc4bc RD |
39193 | </method> |
39194 | <method name="SetVisiblePolicy" type="" overloaded="no"> | |
781d2982 | 39195 | <autodoc>SetVisiblePolicy(self, int visiblePolicy, int visibleSlop)</autodoc> |
f32fc4bc RD |
39196 | <paramlist> |
39197 | <param name="visiblePolicy" type="int" default=""/> | |
39198 | <param name="visibleSlop" type="int" default=""/> | |
39199 | </paramlist> | |
39200 | </method> | |
39201 | <method name="DelLineLeft" type="" overloaded="no"> | |
781d2982 | 39202 | <autodoc>DelLineLeft(self)</autodoc> |
f32fc4bc RD |
39203 | </method> |
39204 | <method name="DelLineRight" type="" overloaded="no"> | |
781d2982 | 39205 | <autodoc>DelLineRight(self)</autodoc> |
f32fc4bc RD |
39206 | </method> |
39207 | <method name="SetXOffset" type="" overloaded="no"> | |
781d2982 | 39208 | <autodoc>SetXOffset(self, int newOffset)</autodoc> |
f32fc4bc RD |
39209 | <paramlist> |
39210 | <param name="newOffset" type="int" default=""/> | |
39211 | </paramlist> | |
39212 | </method> | |
39213 | <method name="GetXOffset" type="int" overloaded="no"> | |
781d2982 | 39214 | <autodoc>GetXOffset(self) -> int</autodoc> |
f32fc4bc RD |
39215 | </method> |
39216 | <method name="ChooseCaretX" type="" overloaded="no"> | |
781d2982 | 39217 | <autodoc>ChooseCaretX(self)</autodoc> |
f32fc4bc RD |
39218 | </method> |
39219 | <method name="SetXCaretPolicy" type="" overloaded="no"> | |
781d2982 | 39220 | <autodoc>SetXCaretPolicy(self, int caretPolicy, int caretSlop)</autodoc> |
f32fc4bc RD |
39221 | <paramlist> |
39222 | <param name="caretPolicy" type="int" default=""/> | |
39223 | <param name="caretSlop" type="int" default=""/> | |
39224 | </paramlist> | |
39225 | </method> | |
39226 | <method name="SetYCaretPolicy" type="" overloaded="no"> | |
781d2982 | 39227 | <autodoc>SetYCaretPolicy(self, int caretPolicy, int caretSlop)</autodoc> |
f32fc4bc RD |
39228 | <paramlist> |
39229 | <param name="caretPolicy" type="int" default=""/> | |
39230 | <param name="caretSlop" type="int" default=""/> | |
39231 | </paramlist> | |
39232 | </method> | |
39233 | <method name="SetPrintWrapMode" type="" overloaded="no"> | |
781d2982 | 39234 | <autodoc>SetPrintWrapMode(self, int mode)</autodoc> |
f32fc4bc RD |
39235 | <paramlist> |
39236 | <param name="mode" type="int" default=""/> | |
39237 | </paramlist> | |
39238 | </method> | |
39239 | <method name="GetPrintWrapMode" type="int" overloaded="no"> | |
781d2982 | 39240 | <autodoc>GetPrintWrapMode(self) -> int</autodoc> |
f32fc4bc RD |
39241 | </method> |
39242 | <method name="SetHotspotActiveForeground" type="" overloaded="no"> | |
781d2982 | 39243 | <autodoc>SetHotspotActiveForeground(self, bool useSetting, Colour fore)</autodoc> |
f32fc4bc RD |
39244 | <paramlist> |
39245 | <param name="useSetting" type="bool" default=""/> | |
39246 | <param name="fore" type="Colour" default=""/> | |
39247 | </paramlist> | |
39248 | </method> | |
39249 | <method name="SetHotspotActiveBackground" type="" overloaded="no"> | |
781d2982 | 39250 | <autodoc>SetHotspotActiveBackground(self, bool useSetting, Colour back)</autodoc> |
f32fc4bc RD |
39251 | <paramlist> |
39252 | <param name="useSetting" type="bool" default=""/> | |
39253 | <param name="back" type="Colour" default=""/> | |
39254 | </paramlist> | |
39255 | </method> | |
39256 | <method name="SetHotspotActiveUnderline" type="" overloaded="no"> | |
781d2982 | 39257 | <autodoc>SetHotspotActiveUnderline(self, bool underline)</autodoc> |
f32fc4bc RD |
39258 | <paramlist> |
39259 | <param name="underline" type="bool" default=""/> | |
39260 | </paramlist> | |
39261 | </method> | |
39262 | <method name="SetHotspotSingleLine" type="" overloaded="no"> | |
781d2982 | 39263 | <autodoc>SetHotspotSingleLine(self, bool singleLine)</autodoc> |
f32fc4bc RD |
39264 | <paramlist> |
39265 | <param name="singleLine" type="bool" default=""/> | |
39266 | </paramlist> | |
39267 | </method> | |
b39e211b | 39268 | <method name="ParaDown" type="" overloaded="no"> |
781d2982 | 39269 | <autodoc>ParaDown(self)</autodoc> |
b39e211b RD |
39270 | </method> |
39271 | <method name="ParaDownExtend" type="" overloaded="no"> | |
781d2982 | 39272 | <autodoc>ParaDownExtend(self)</autodoc> |
b39e211b RD |
39273 | </method> |
39274 | <method name="ParaUp" type="" overloaded="no"> | |
781d2982 | 39275 | <autodoc>ParaUp(self)</autodoc> |
b39e211b RD |
39276 | </method> |
39277 | <method name="ParaUpExtend" type="" overloaded="no"> | |
781d2982 | 39278 | <autodoc>ParaUpExtend(self)</autodoc> |
b39e211b | 39279 | </method> |
f32fc4bc | 39280 | <method name="PositionBefore" type="int" overloaded="no"> |
781d2982 | 39281 | <autodoc>PositionBefore(self, int pos) -> int</autodoc> |
f32fc4bc RD |
39282 | <paramlist> |
39283 | <param name="pos" type="int" default=""/> | |
39284 | </paramlist> | |
39285 | </method> | |
39286 | <method name="PositionAfter" type="int" overloaded="no"> | |
781d2982 | 39287 | <autodoc>PositionAfter(self, int pos) -> int</autodoc> |
f32fc4bc RD |
39288 | <paramlist> |
39289 | <param name="pos" type="int" default=""/> | |
39290 | </paramlist> | |
39291 | </method> | |
39292 | <method name="CopyRange" type="" overloaded="no"> | |
781d2982 | 39293 | <autodoc>CopyRange(self, int start, int end)</autodoc> |
f32fc4bc RD |
39294 | <paramlist> |
39295 | <param name="start" type="int" default=""/> | |
39296 | <param name="end" type="int" default=""/> | |
39297 | </paramlist> | |
39298 | </method> | |
39299 | <method name="CopyText" type="" overloaded="no"> | |
781d2982 | 39300 | <autodoc>CopyText(self, int length, String text)</autodoc> |
f32fc4bc RD |
39301 | <paramlist> |
39302 | <param name="length" type="int" default=""/> | |
39303 | <param name="text" type="String" default=""/> | |
39304 | </paramlist> | |
39305 | </method> | |
39306 | <method name="SetSelectionMode" type="" overloaded="no"> | |
781d2982 | 39307 | <autodoc>SetSelectionMode(self, int mode)</autodoc> |
f32fc4bc RD |
39308 | <paramlist> |
39309 | <param name="mode" type="int" default=""/> | |
39310 | </paramlist> | |
39311 | </method> | |
39312 | <method name="GetSelectionMode" type="int" overloaded="no"> | |
781d2982 | 39313 | <autodoc>GetSelectionMode(self) -> int</autodoc> |
f32fc4bc RD |
39314 | </method> |
39315 | <method name="GetLineSelStartPosition" type="int" overloaded="no"> | |
781d2982 | 39316 | <autodoc>GetLineSelStartPosition(self, int line) -> int</autodoc> |
f32fc4bc RD |
39317 | <paramlist> |
39318 | <param name="line" type="int" default=""/> | |
39319 | </paramlist> | |
39320 | </method> | |
39321 | <method name="GetLineSelEndPosition" type="int" overloaded="no"> | |
781d2982 | 39322 | <autodoc>GetLineSelEndPosition(self, int line) -> int</autodoc> |
f32fc4bc RD |
39323 | <paramlist> |
39324 | <param name="line" type="int" default=""/> | |
39325 | </paramlist> | |
39326 | </method> | |
b39e211b | 39327 | <method name="LineDownRectExtend" type="" overloaded="no"> |
781d2982 | 39328 | <autodoc>LineDownRectExtend(self)</autodoc> |
b39e211b RD |
39329 | </method> |
39330 | <method name="LineUpRectExtend" type="" overloaded="no"> | |
781d2982 | 39331 | <autodoc>LineUpRectExtend(self)</autodoc> |
b39e211b RD |
39332 | </method> |
39333 | <method name="CharLeftRectExtend" type="" overloaded="no"> | |
781d2982 | 39334 | <autodoc>CharLeftRectExtend(self)</autodoc> |
b39e211b RD |
39335 | </method> |
39336 | <method name="CharRightRectExtend" type="" overloaded="no"> | |
781d2982 | 39337 | <autodoc>CharRightRectExtend(self)</autodoc> |
b39e211b RD |
39338 | </method> |
39339 | <method name="HomeRectExtend" type="" overloaded="no"> | |
781d2982 | 39340 | <autodoc>HomeRectExtend(self)</autodoc> |
b39e211b RD |
39341 | </method> |
39342 | <method name="VCHomeRectExtend" type="" overloaded="no"> | |
781d2982 | 39343 | <autodoc>VCHomeRectExtend(self)</autodoc> |
b39e211b RD |
39344 | </method> |
39345 | <method name="LineEndRectExtend" type="" overloaded="no"> | |
781d2982 | 39346 | <autodoc>LineEndRectExtend(self)</autodoc> |
b39e211b RD |
39347 | </method> |
39348 | <method name="PageUpRectExtend" type="" overloaded="no"> | |
781d2982 | 39349 | <autodoc>PageUpRectExtend(self)</autodoc> |
b39e211b RD |
39350 | </method> |
39351 | <method name="PageDownRectExtend" type="" overloaded="no"> | |
781d2982 | 39352 | <autodoc>PageDownRectExtend(self)</autodoc> |
b39e211b RD |
39353 | </method> |
39354 | <method name="StutteredPageUp" type="" overloaded="no"> | |
781d2982 | 39355 | <autodoc>StutteredPageUp(self)</autodoc> |
b39e211b RD |
39356 | </method> |
39357 | <method name="StutteredPageUpExtend" type="" overloaded="no"> | |
781d2982 | 39358 | <autodoc>StutteredPageUpExtend(self)</autodoc> |
b39e211b RD |
39359 | </method> |
39360 | <method name="StutteredPageDown" type="" overloaded="no"> | |
781d2982 | 39361 | <autodoc>StutteredPageDown(self)</autodoc> |
b39e211b RD |
39362 | </method> |
39363 | <method name="StutteredPageDownExtend" type="" overloaded="no"> | |
781d2982 | 39364 | <autodoc>StutteredPageDownExtend(self)</autodoc> |
b39e211b RD |
39365 | </method> |
39366 | <method name="WordLeftEnd" type="" overloaded="no"> | |
781d2982 | 39367 | <autodoc>WordLeftEnd(self)</autodoc> |
b39e211b RD |
39368 | </method> |
39369 | <method name="WordLeftEndExtend" type="" overloaded="no"> | |
781d2982 | 39370 | <autodoc>WordLeftEndExtend(self)</autodoc> |
b39e211b RD |
39371 | </method> |
39372 | <method name="WordRightEnd" type="" overloaded="no"> | |
781d2982 | 39373 | <autodoc>WordRightEnd(self)</autodoc> |
b39e211b RD |
39374 | </method> |
39375 | <method name="WordRightEndExtend" type="" overloaded="no"> | |
781d2982 | 39376 | <autodoc>WordRightEndExtend(self)</autodoc> |
b39e211b | 39377 | </method> |
f32fc4bc | 39378 | <method name="SetWhitespaceChars" type="" overloaded="no"> |
781d2982 | 39379 | <autodoc>SetWhitespaceChars(self, String characters)</autodoc> |
f32fc4bc RD |
39380 | <paramlist> |
39381 | <param name="characters" type="String" default=""/> | |
39382 | </paramlist> | |
39383 | </method> | |
39384 | <method name="SetCharsDefault" type="" overloaded="no"> | |
781d2982 | 39385 | <autodoc>SetCharsDefault(self)</autodoc> |
f32fc4bc RD |
39386 | </method> |
39387 | <method name="AutoCompGetCurrent" type="int" overloaded="no"> | |
781d2982 | 39388 | <autodoc>AutoCompGetCurrent(self) -> int</autodoc> |
f32fc4bc RD |
39389 | </method> |
39390 | <method name="StartRecord" type="" overloaded="no"> | |
781d2982 | 39391 | <autodoc>StartRecord(self)</autodoc> |
f32fc4bc RD |
39392 | </method> |
39393 | <method name="StopRecord" type="" overloaded="no"> | |
781d2982 | 39394 | <autodoc>StopRecord(self)</autodoc> |
f32fc4bc RD |
39395 | </method> |
39396 | <method name="SetLexer" type="" overloaded="no"> | |
781d2982 | 39397 | <autodoc>SetLexer(self, int lexer)</autodoc> |
f32fc4bc RD |
39398 | <paramlist> |
39399 | <param name="lexer" type="int" default=""/> | |
39400 | </paramlist> | |
39401 | </method> | |
39402 | <method name="GetLexer" type="int" overloaded="no"> | |
781d2982 | 39403 | <autodoc>GetLexer(self) -> int</autodoc> |
f32fc4bc RD |
39404 | </method> |
39405 | <method name="Colourise" type="" overloaded="no"> | |
781d2982 | 39406 | <autodoc>Colourise(self, int start, int end)</autodoc> |
f32fc4bc RD |
39407 | <paramlist> |
39408 | <param name="start" type="int" default=""/> | |
39409 | <param name="end" type="int" default=""/> | |
39410 | </paramlist> | |
39411 | </method> | |
39412 | <method name="SetProperty" type="" overloaded="no"> | |
781d2982 | 39413 | <autodoc>SetProperty(self, String key, String value)</autodoc> |
f32fc4bc RD |
39414 | <paramlist> |
39415 | <param name="key" type="String" default=""/> | |
39416 | <param name="value" type="String" default=""/> | |
39417 | </paramlist> | |
39418 | </method> | |
39419 | <method name="SetKeyWords" type="" overloaded="no"> | |
781d2982 | 39420 | <autodoc>SetKeyWords(self, int keywordSet, String keyWords)</autodoc> |
f32fc4bc RD |
39421 | <paramlist> |
39422 | <param name="keywordSet" type="int" default=""/> | |
39423 | <param name="keyWords" type="String" default=""/> | |
39424 | </paramlist> | |
39425 | </method> | |
39426 | <method name="SetLexerLanguage" type="" overloaded="no"> | |
781d2982 | 39427 | <autodoc>SetLexerLanguage(self, String language)</autodoc> |
f32fc4bc RD |
39428 | <paramlist> |
39429 | <param name="language" type="String" default=""/> | |
39430 | </paramlist> | |
39431 | </method> | |
39432 | <method name="GetCurrentLine" type="int" overloaded="no"> | |
781d2982 | 39433 | <autodoc>GetCurrentLine(self) -> int</autodoc> |
f32fc4bc RD |
39434 | </method> |
39435 | <method name="StyleSetSpec" type="" overloaded="no"> | |
781d2982 | 39436 | <autodoc>StyleSetSpec(self, int styleNum, String spec)</autodoc> |
f32fc4bc RD |
39437 | <paramlist> |
39438 | <param name="styleNum" type="int" default=""/> | |
39439 | <param name="spec" type="String" default=""/> | |
39440 | </paramlist> | |
39441 | </method> | |
39442 | <method name="StyleSetFont" type="" overloaded="no"> | |
781d2982 | 39443 | <autodoc>StyleSetFont(self, int styleNum, Font font)</autodoc> |
f32fc4bc RD |
39444 | <paramlist> |
39445 | <param name="styleNum" type="int" default=""/> | |
39446 | <param name="font" type="Font" default=""/> | |
39447 | </paramlist> | |
39448 | </method> | |
39449 | <method name="StyleSetFontAttr" type="" overloaded="no"> | |
781d2982 | 39450 | <autodoc>StyleSetFontAttr(self, int styleNum, int size, String faceName, bool bold, |
f32fc4bc RD |
39451 | bool italic, bool underline)</autodoc> |
39452 | <paramlist> | |
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=""/> | |
39459 | </paramlist> | |
39460 | </method> | |
39461 | <method name="CmdKeyExecute" type="" overloaded="no"> | |
781d2982 | 39462 | <autodoc>CmdKeyExecute(self, int cmd)</autodoc> |
f32fc4bc RD |
39463 | <paramlist> |
39464 | <param name="cmd" type="int" default=""/> | |
39465 | </paramlist> | |
39466 | </method> | |
39467 | <method name="SetMargins" type="" overloaded="no"> | |
781d2982 | 39468 | <autodoc>SetMargins(self, int left, int right)</autodoc> |
f32fc4bc RD |
39469 | <paramlist> |
39470 | <param name="left" type="int" default=""/> | |
39471 | <param name="right" type="int" default=""/> | |
39472 | </paramlist> | |
39473 | </method> | |
39474 | <method name="GetSelection" type="" overloaded="no"> | |
781d2982 | 39475 | <autodoc>GetSelection(self, int OUTPUT, int OUTPUT)</autodoc> |
f32fc4bc RD |
39476 | <paramlist> |
39477 | <param name="OUTPUT" type="int" default=""/> | |
39478 | <param name="OUTPUT" type="int" default=""/> | |
39479 | </paramlist> | |
39480 | </method> | |
39481 | <method name="PointFromPosition" type="Point" overloaded="no"> | |
781d2982 | 39482 | <autodoc>PointFromPosition(self, int pos) -> Point</autodoc> |
f32fc4bc RD |
39483 | <paramlist> |
39484 | <param name="pos" type="int" default=""/> | |
39485 | </paramlist> | |
39486 | </method> | |
39487 | <method name="ScrollToLine" type="" overloaded="no"> | |
781d2982 | 39488 | <autodoc>ScrollToLine(self, int line)</autodoc> |
f32fc4bc RD |
39489 | <paramlist> |
39490 | <param name="line" type="int" default=""/> | |
39491 | </paramlist> | |
39492 | </method> | |
39493 | <method name="ScrollToColumn" type="" overloaded="no"> | |
781d2982 | 39494 | <autodoc>ScrollToColumn(self, int column)</autodoc> |
f32fc4bc RD |
39495 | <paramlist> |
39496 | <param name="column" type="int" default=""/> | |
39497 | </paramlist> | |
39498 | </method> | |
39499 | <method name="SendMsg" type="long" overloaded="no"> | |
781d2982 | 39500 | <autodoc>SendMsg(self, int msg, long wp=0, long lp=0) -> long</autodoc> |
f32fc4bc RD |
39501 | <paramlist> |
39502 | <param name="msg" type="int" default=""/> | |
39503 | <param name="wp" type="long" default="0"/> | |
39504 | <param name="lp" type="long" default="0"/> | |
39505 | </paramlist> | |
39506 | </method> | |
39507 | <method name="SetVScrollBar" type="" overloaded="no"> | |
781d2982 | 39508 | <autodoc>SetVScrollBar(self, wxScrollBar bar)</autodoc> |
f32fc4bc RD |
39509 | <paramlist> |
39510 | <param name="bar" type="ScrollBar" default=""/> | |
39511 | </paramlist> | |
39512 | </method> | |
39513 | <method name="SetHScrollBar" type="" overloaded="no"> | |
781d2982 | 39514 | <autodoc>SetHScrollBar(self, wxScrollBar bar)</autodoc> |
f32fc4bc RD |
39515 | <paramlist> |
39516 | <param name="bar" type="ScrollBar" default=""/> | |
39517 | </paramlist> | |
39518 | </method> | |
39519 | <method name="GetLastKeydownProcessed" type="bool" overloaded="no"> | |
781d2982 | 39520 | <autodoc>GetLastKeydownProcessed(self) -> bool</autodoc> |
f32fc4bc RD |
39521 | </method> |
39522 | <method name="SetLastKeydownProcessed" type="" overloaded="no"> | |
781d2982 | 39523 | <autodoc>SetLastKeydownProcessed(self, bool val)</autodoc> |
f32fc4bc RD |
39524 | <paramlist> |
39525 | <param name="val" type="bool" default=""/> | |
39526 | </paramlist> | |
39527 | </method> | |
39528 | <method name="SaveFile" type="bool" overloaded="no"> | |
781d2982 | 39529 | <autodoc>SaveFile(self, String filename) -> bool</autodoc> |
f32fc4bc RD |
39530 | <paramlist> |
39531 | <param name="filename" type="String" default=""/> | |
39532 | </paramlist> | |
39533 | </method> | |
39534 | <method name="LoadFile" type="bool" overloaded="no"> | |
781d2982 | 39535 | <autodoc>LoadFile(self, String filename) -> bool</autodoc> |
f32fc4bc RD |
39536 | <paramlist> |
39537 | <param name="filename" type="String" default=""/> | |
39538 | </paramlist> | |
39539 | </method> | |
39540 | <method name="DoDragOver" type="wxDragResult" overloaded="no"> | |
781d2982 | 39541 | <autodoc>DoDragOver(self, int x, int y, int def) -> int</autodoc> |
f32fc4bc RD |
39542 | <paramlist> |
39543 | <param name="x" type="int" default=""/> | |
39544 | <param name="y" type="int" default=""/> | |
39545 | <param name="def" type="wxDragResult" default=""/> | |
39546 | </paramlist> | |
39547 | </method> | |
39548 | <method name="DoDropText" type="bool" overloaded="no"> | |
781d2982 | 39549 | <autodoc>DoDropText(self, long x, long y, String data) -> bool</autodoc> |
f32fc4bc RD |
39550 | <paramlist> |
39551 | <param name="x" type="long" default=""/> | |
39552 | <param name="y" type="long" default=""/> | |
39553 | <param name="data" type="String" default=""/> | |
39554 | </paramlist> | |
39555 | </method> | |
39556 | <method name="SetUseAntiAliasing" type="" overloaded="no"> | |
781d2982 | 39557 | <autodoc>SetUseAntiAliasing(self, bool useAA)</autodoc> |
f32fc4bc RD |
39558 | <paramlist> |
39559 | <param name="useAA" type="bool" default=""/> | |
39560 | </paramlist> | |
39561 | </method> | |
39562 | <method name="GetUseAntiAliasing" type="bool" overloaded="no"> | |
781d2982 | 39563 | <autodoc>GetUseAntiAliasing(self) -> bool</autodoc> |
f32fc4bc RD |
39564 | </method> |
39565 | </class> | |
39566 | <class name="StyledTextEvent" oldname="wxStyledTextEvent" module="stc"> | |
39567 | <baseclass name="CommandEvent"/> | |
39568 | <constructor name="StyledTextEvent" overloaded="no"> | |
781d2982 | 39569 | <autodoc>__init__(self, wxEventType commandType=0, int id=0) -> StyledTextEvent</autodoc> |
f32fc4bc RD |
39570 | <paramlist> |
39571 | <param name="commandType" type="wxEventType" default="0"/> | |
39572 | <param name="id" type="int" default="0"/> | |
39573 | </paramlist> | |
39574 | </constructor> | |
39575 | <destructor name="~wxStyledTextEvent" overloaded="no"> | |
781d2982 | 39576 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
39577 | </destructor> |
39578 | <method name="SetPosition" type="" overloaded="no"> | |
781d2982 | 39579 | <autodoc>SetPosition(self, int pos)</autodoc> |
f32fc4bc RD |
39580 | <paramlist> |
39581 | <param name="pos" type="int" default=""/> | |
39582 | </paramlist> | |
39583 | </method> | |
39584 | <method name="SetKey" type="" overloaded="no"> | |
781d2982 | 39585 | <autodoc>SetKey(self, int k)</autodoc> |
f32fc4bc RD |
39586 | <paramlist> |
39587 | <param name="k" type="int" default=""/> | |
39588 | </paramlist> | |
39589 | </method> | |
39590 | <method name="SetModifiers" type="" overloaded="no"> | |
781d2982 | 39591 | <autodoc>SetModifiers(self, int m)</autodoc> |
f32fc4bc RD |
39592 | <paramlist> |
39593 | <param name="m" type="int" default=""/> | |
39594 | </paramlist> | |
39595 | </method> | |
39596 | <method name="SetModificationType" type="" overloaded="no"> | |
781d2982 | 39597 | <autodoc>SetModificationType(self, int t)</autodoc> |
f32fc4bc RD |
39598 | <paramlist> |
39599 | <param name="t" type="int" default=""/> | |
39600 | </paramlist> | |
39601 | </method> | |
39602 | <method name="SetText" type="" overloaded="no"> | |
781d2982 | 39603 | <autodoc>SetText(self, String t)</autodoc> |
f32fc4bc RD |
39604 | <paramlist> |
39605 | <param name="t" type="String" default=""/> | |
39606 | </paramlist> | |
39607 | </method> | |
39608 | <method name="SetLength" type="" overloaded="no"> | |
781d2982 | 39609 | <autodoc>SetLength(self, int len)</autodoc> |
f32fc4bc RD |
39610 | <paramlist> |
39611 | <param name="len" type="int" default=""/> | |
39612 | </paramlist> | |
39613 | </method> | |
39614 | <method name="SetLinesAdded" type="" overloaded="no"> | |
781d2982 | 39615 | <autodoc>SetLinesAdded(self, int num)</autodoc> |
f32fc4bc RD |
39616 | <paramlist> |
39617 | <param name="num" type="int" default=""/> | |
39618 | </paramlist> | |
39619 | </method> | |
39620 | <method name="SetLine" type="" overloaded="no"> | |
781d2982 | 39621 | <autodoc>SetLine(self, int val)</autodoc> |
f32fc4bc RD |
39622 | <paramlist> |
39623 | <param name="val" type="int" default=""/> | |
39624 | </paramlist> | |
39625 | </method> | |
39626 | <method name="SetFoldLevelNow" type="" overloaded="no"> | |
781d2982 | 39627 | <autodoc>SetFoldLevelNow(self, int val)</autodoc> |
f32fc4bc RD |
39628 | <paramlist> |
39629 | <param name="val" type="int" default=""/> | |
39630 | </paramlist> | |
39631 | </method> | |
39632 | <method name="SetFoldLevelPrev" type="" overloaded="no"> | |
781d2982 | 39633 | <autodoc>SetFoldLevelPrev(self, int val)</autodoc> |
f32fc4bc RD |
39634 | <paramlist> |
39635 | <param name="val" type="int" default=""/> | |
39636 | </paramlist> | |
39637 | </method> | |
39638 | <method name="SetMargin" type="" overloaded="no"> | |
781d2982 | 39639 | <autodoc>SetMargin(self, int val)</autodoc> |
f32fc4bc RD |
39640 | <paramlist> |
39641 | <param name="val" type="int" default=""/> | |
39642 | </paramlist> | |
39643 | </method> | |
39644 | <method name="SetMessage" type="" overloaded="no"> | |
781d2982 | 39645 | <autodoc>SetMessage(self, int val)</autodoc> |
f32fc4bc RD |
39646 | <paramlist> |
39647 | <param name="val" type="int" default=""/> | |
39648 | </paramlist> | |
39649 | </method> | |
39650 | <method name="SetWParam" type="" overloaded="no"> | |
781d2982 | 39651 | <autodoc>SetWParam(self, int val)</autodoc> |
f32fc4bc RD |
39652 | <paramlist> |
39653 | <param name="val" type="int" default=""/> | |
39654 | </paramlist> | |
39655 | </method> | |
39656 | <method name="SetLParam" type="" overloaded="no"> | |
781d2982 | 39657 | <autodoc>SetLParam(self, int val)</autodoc> |
f32fc4bc RD |
39658 | <paramlist> |
39659 | <param name="val" type="int" default=""/> | |
39660 | </paramlist> | |
39661 | </method> | |
39662 | <method name="SetListType" type="" overloaded="no"> | |
781d2982 | 39663 | <autodoc>SetListType(self, int val)</autodoc> |
f32fc4bc RD |
39664 | <paramlist> |
39665 | <param name="val" type="int" default=""/> | |
39666 | </paramlist> | |
39667 | </method> | |
39668 | <method name="SetX" type="" overloaded="no"> | |
781d2982 | 39669 | <autodoc>SetX(self, int val)</autodoc> |
f32fc4bc RD |
39670 | <paramlist> |
39671 | <param name="val" type="int" default=""/> | |
39672 | </paramlist> | |
39673 | </method> | |
39674 | <method name="SetY" type="" overloaded="no"> | |
781d2982 | 39675 | <autodoc>SetY(self, int val)</autodoc> |
f32fc4bc RD |
39676 | <paramlist> |
39677 | <param name="val" type="int" default=""/> | |
39678 | </paramlist> | |
39679 | </method> | |
39680 | <method name="SetDragText" type="" overloaded="no"> | |
781d2982 | 39681 | <autodoc>SetDragText(self, String val)</autodoc> |
f32fc4bc RD |
39682 | <paramlist> |
39683 | <param name="val" type="String" default=""/> | |
39684 | </paramlist> | |
39685 | </method> | |
39686 | <method name="SetDragAllowMove" type="" overloaded="no"> | |
781d2982 | 39687 | <autodoc>SetDragAllowMove(self, bool val)</autodoc> |
f32fc4bc RD |
39688 | <paramlist> |
39689 | <param name="val" type="bool" default=""/> | |
39690 | </paramlist> | |
39691 | </method> | |
39692 | <method name="SetDragResult" type="" overloaded="no"> | |
781d2982 | 39693 | <autodoc>SetDragResult(self, int val)</autodoc> |
f32fc4bc RD |
39694 | <paramlist> |
39695 | <param name="val" type="wxDragResult" default=""/> | |
39696 | </paramlist> | |
39697 | </method> | |
39698 | <method name="GetPosition" type="int" overloaded="no"> | |
781d2982 | 39699 | <autodoc>GetPosition(self) -> int</autodoc> |
f32fc4bc RD |
39700 | </method> |
39701 | <method name="GetKey" type="int" overloaded="no"> | |
781d2982 | 39702 | <autodoc>GetKey(self) -> int</autodoc> |
f32fc4bc RD |
39703 | </method> |
39704 | <method name="GetModifiers" type="int" overloaded="no"> | |
781d2982 | 39705 | <autodoc>GetModifiers(self) -> int</autodoc> |
f32fc4bc RD |
39706 | </method> |
39707 | <method name="GetModificationType" type="int" overloaded="no"> | |
781d2982 | 39708 | <autodoc>GetModificationType(self) -> int</autodoc> |
f32fc4bc RD |
39709 | </method> |
39710 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 39711 | <autodoc>GetText(self) -> String</autodoc> |
f32fc4bc RD |
39712 | </method> |
39713 | <method name="GetLength" type="int" overloaded="no"> | |
781d2982 | 39714 | <autodoc>GetLength(self) -> int</autodoc> |
f32fc4bc RD |
39715 | </method> |
39716 | <method name="GetLinesAdded" type="int" overloaded="no"> | |
781d2982 | 39717 | <autodoc>GetLinesAdded(self) -> int</autodoc> |
f32fc4bc RD |
39718 | </method> |
39719 | <method name="GetLine" type="int" overloaded="no"> | |
781d2982 | 39720 | <autodoc>GetLine(self) -> int</autodoc> |
f32fc4bc RD |
39721 | </method> |
39722 | <method name="GetFoldLevelNow" type="int" overloaded="no"> | |
781d2982 | 39723 | <autodoc>GetFoldLevelNow(self) -> int</autodoc> |
f32fc4bc RD |
39724 | </method> |
39725 | <method name="GetFoldLevelPrev" type="int" overloaded="no"> | |
781d2982 | 39726 | <autodoc>GetFoldLevelPrev(self) -> int</autodoc> |
f32fc4bc RD |
39727 | </method> |
39728 | <method name="GetMargin" type="int" overloaded="no"> | |
781d2982 | 39729 | <autodoc>GetMargin(self) -> int</autodoc> |
f32fc4bc RD |
39730 | </method> |
39731 | <method name="GetMessage" type="int" overloaded="no"> | |
781d2982 | 39732 | <autodoc>GetMessage(self) -> int</autodoc> |
f32fc4bc RD |
39733 | </method> |
39734 | <method name="GetWParam" type="int" overloaded="no"> | |
781d2982 | 39735 | <autodoc>GetWParam(self) -> int</autodoc> |
f32fc4bc RD |
39736 | </method> |
39737 | <method name="GetLParam" type="int" overloaded="no"> | |
781d2982 | 39738 | <autodoc>GetLParam(self) -> int</autodoc> |
f32fc4bc RD |
39739 | </method> |
39740 | <method name="GetListType" type="int" overloaded="no"> | |
781d2982 | 39741 | <autodoc>GetListType(self) -> int</autodoc> |
f32fc4bc RD |
39742 | </method> |
39743 | <method name="GetX" type="int" overloaded="no"> | |
781d2982 | 39744 | <autodoc>GetX(self) -> int</autodoc> |
f32fc4bc RD |
39745 | </method> |
39746 | <method name="GetY" type="int" overloaded="no"> | |
781d2982 | 39747 | <autodoc>GetY(self) -> int</autodoc> |
f32fc4bc RD |
39748 | </method> |
39749 | <method name="GetDragText" type="String" overloaded="no"> | |
781d2982 | 39750 | <autodoc>GetDragText(self) -> String</autodoc> |
f32fc4bc RD |
39751 | </method> |
39752 | <method name="GetDragAllowMove" type="bool" overloaded="no"> | |
781d2982 | 39753 | <autodoc>GetDragAllowMove(self) -> bool</autodoc> |
f32fc4bc RD |
39754 | </method> |
39755 | <method name="GetDragResult" type="wxDragResult" overloaded="no"> | |
781d2982 | 39756 | <autodoc>GetDragResult(self) -> int</autodoc> |
f32fc4bc RD |
39757 | </method> |
39758 | <method name="GetShift" type="bool" overloaded="no"> | |
781d2982 | 39759 | <autodoc>GetShift(self) -> bool</autodoc> |
f32fc4bc RD |
39760 | </method> |
39761 | <method name="GetControl" type="bool" overloaded="no"> | |
781d2982 | 39762 | <autodoc>GetControl(self) -> bool</autodoc> |
f32fc4bc RD |
39763 | </method> |
39764 | <method name="GetAlt" type="bool" overloaded="no"> | |
781d2982 | 39765 | <autodoc>GetAlt(self) -> bool</autodoc> |
f32fc4bc RD |
39766 | </method> |
39767 | <method name="Clone" type="Event" overloaded="no"> | |
781d2982 | 39768 | <autodoc>Clone(self) -> Event</autodoc> |
f32fc4bc RD |
39769 | </method> |
39770 | </class> | |
39771 | <pythoncode> | |
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 ) | |
f32fc4bc RD |
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 ) | |
39797 | </pythoncode> | |
39798 | </module> | |
39799 | <module name="xrc"> | |
781d2982 RD |
39800 | <import name="_core"/> |
39801 | <pythoncode> wx = _core </pythoncode> | |
39802 | <pythoncode> __docfilter__ = wx.__DocFilter(globals()) </pythoncode> | |
f32fc4bc RD |
39803 | <pythoncode> |
39804 | #--------------------------------------------------------------------------- | |
39805 | </pythoncode> | |
39806 | <class name="XmlResource" oldname="wxXmlResource" module="xrc"> | |
39807 | <baseclass name="Object"/> | |
39808 | <constructor name="XmlResource" overloaded="no"> | |
781d2982 | 39809 | <autodoc>__init__(self, String filemask, int flags=XRC_USE_LOCALE) -> XmlResource</autodoc> |
f32fc4bc RD |
39810 | <paramlist> |
39811 | <param name="filemask" type="String" default=""/> | |
39812 | <param name="flags" type="int" default="wxXRC_USE_LOCALE"/> | |
39813 | </paramlist> | |
39814 | </constructor> | |
39815 | <constructor name="EmptyXmlResource" overloaded="no"> | |
39816 | <autodoc>EmptyXmlResource(int flags=XRC_USE_LOCALE) -> XmlResource</autodoc> | |
39817 | <paramlist> | |
39818 | <param name="flags" type="int" default="wxXRC_USE_LOCALE"/> | |
39819 | </paramlist> | |
39820 | </constructor> | |
39821 | <destructor name="~wxXmlResource" overloaded="no"> | |
781d2982 | 39822 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
39823 | </destructor> |
39824 | <method name="Load" type="bool" overloaded="no"> | |
781d2982 | 39825 | <autodoc>Load(self, String filemask) -> bool</autodoc> |
f32fc4bc RD |
39826 | <paramlist> |
39827 | <param name="filemask" type="String" default=""/> | |
39828 | </paramlist> | |
39829 | </method> | |
39830 | <method name="LoadFromString" type="bool" overloaded="no"> | |
781d2982 | 39831 | <autodoc>LoadFromString(self, String data) -> bool</autodoc> |
f32fc4bc RD |
39832 | <paramlist> |
39833 | <param name="data" type="String" default=""/> | |
39834 | </paramlist> | |
39835 | </method> | |
39836 | <method name="InitAllHandlers" type="" overloaded="no"> | |
781d2982 | 39837 | <autodoc>InitAllHandlers(self)</autodoc> |
f32fc4bc RD |
39838 | </method> |
39839 | <method name="AddHandler" type="" overloaded="no"> | |
781d2982 | 39840 | <autodoc>AddHandler(self, XmlResourceHandler handler)</autodoc> |
f32fc4bc RD |
39841 | <paramlist> |
39842 | <param name="handler" type="wxPyXmlResourceHandler" default=""/> | |
39843 | </paramlist> | |
39844 | </method> | |
39845 | <method name="InsertHandler" type="" overloaded="no"> | |
781d2982 | 39846 | <autodoc>InsertHandler(self, XmlResourceHandler handler)</autodoc> |
f32fc4bc RD |
39847 | <paramlist> |
39848 | <param name="handler" type="wxPyXmlResourceHandler" default=""/> | |
39849 | </paramlist> | |
39850 | </method> | |
39851 | <method name="ClearHandlers" type="" overloaded="no"> | |
781d2982 | 39852 | <autodoc>ClearHandlers(self)</autodoc> |
f32fc4bc RD |
39853 | </method> |
39854 | <staticmethod name="AddSubclassFactory" type="" overloaded="no"> | |
39855 | <autodoc>AddSubclassFactory(XmlSubclassFactory factory)</autodoc> | |
39856 | <paramlist> | |
39857 | <param name="factory" type="wxPyXmlSubclassFactory" default=""/> | |
39858 | </paramlist> | |
39859 | </staticmethod> | |
39860 | <method name="LoadMenu" type="Menu" overloaded="no"> | |
781d2982 | 39861 | <autodoc>LoadMenu(self, String name) -> Menu</autodoc> |
f32fc4bc RD |
39862 | <paramlist> |
39863 | <param name="name" type="String" default=""/> | |
39864 | </paramlist> | |
39865 | </method> | |
39866 | <method name="LoadMenuBar" type="MenuBar" overloaded="no"> | |
781d2982 | 39867 | <autodoc>LoadMenuBar(self, String name) -> MenuBar</autodoc> |
f32fc4bc RD |
39868 | <paramlist> |
39869 | <param name="name" type="String" default=""/> | |
39870 | </paramlist> | |
39871 | </method> | |
39872 | <method name="LoadMenuBarOnFrame" type="MenuBar" overloaded="no"> | |
781d2982 | 39873 | <autodoc>LoadMenuBarOnFrame(self, Window parent, String name) -> MenuBar</autodoc> |
f32fc4bc RD |
39874 | <paramlist> |
39875 | <param name="parent" type="Window" default=""/> | |
39876 | <param name="name" type="String" default=""/> | |
39877 | </paramlist> | |
39878 | </method> | |
39879 | <method name="LoadToolBar" type="ToolBar" overloaded="no"> | |
781d2982 | 39880 | <autodoc>LoadToolBar(self, Window parent, String name) -> wxToolBar</autodoc> |
f32fc4bc RD |
39881 | <paramlist> |
39882 | <param name="parent" type="Window" default=""/> | |
39883 | <param name="name" type="String" default=""/> | |
39884 | </paramlist> | |
39885 | </method> | |
39886 | <method name="LoadDialog" type="Dialog" overloaded="no"> | |
781d2982 | 39887 | <autodoc>LoadDialog(self, Window parent, String name) -> wxDialog</autodoc> |
f32fc4bc RD |
39888 | <paramlist> |
39889 | <param name="parent" type="Window" default=""/> | |
39890 | <param name="name" type="String" default=""/> | |
39891 | </paramlist> | |
39892 | </method> | |
39893 | <method name="LoadOnDialog" type="bool" overloaded="no"> | |
781d2982 | 39894 | <autodoc>LoadOnDialog(self, wxDialog dlg, Window parent, String name) -> bool</autodoc> |
f32fc4bc RD |
39895 | <paramlist> |
39896 | <param name="dlg" type="Dialog" default=""/> | |
39897 | <param name="parent" type="Window" default=""/> | |
39898 | <param name="name" type="String" default=""/> | |
39899 | </paramlist> | |
39900 | </method> | |
39901 | <method name="LoadPanel" type="Panel" overloaded="no"> | |
781d2982 | 39902 | <autodoc>LoadPanel(self, Window parent, String name) -> wxPanel</autodoc> |
f32fc4bc RD |
39903 | <paramlist> |
39904 | <param name="parent" type="Window" default=""/> | |
39905 | <param name="name" type="String" default=""/> | |
39906 | </paramlist> | |
39907 | </method> | |
39908 | <method name="LoadOnPanel" type="bool" overloaded="no"> | |
781d2982 | 39909 | <autodoc>LoadOnPanel(self, wxPanel panel, Window parent, String name) -> bool</autodoc> |
f32fc4bc RD |
39910 | <paramlist> |
39911 | <param name="panel" type="Panel" default=""/> | |
39912 | <param name="parent" type="Window" default=""/> | |
39913 | <param name="name" type="String" default=""/> | |
39914 | </paramlist> | |
39915 | </method> | |
39916 | <method name="LoadFrame" type="Frame" overloaded="no"> | |
781d2982 | 39917 | <autodoc>LoadFrame(self, Window parent, String name) -> wxFrame</autodoc> |
f32fc4bc RD |
39918 | <paramlist> |
39919 | <param name="parent" type="Window" default=""/> | |
39920 | <param name="name" type="String" default=""/> | |
39921 | </paramlist> | |
39922 | </method> | |
39923 | <method name="LoadOnFrame" type="bool" overloaded="no"> | |
781d2982 | 39924 | <autodoc>LoadOnFrame(self, wxFrame frame, Window parent, String name) -> bool</autodoc> |
f32fc4bc RD |
39925 | <paramlist> |
39926 | <param name="frame" type="Frame" default=""/> | |
39927 | <param name="parent" type="Window" default=""/> | |
39928 | <param name="name" type="String" default=""/> | |
39929 | </paramlist> | |
39930 | </method> | |
39931 | <method name="LoadObject" type="Object" overloaded="no"> | |
781d2982 | 39932 | <autodoc>LoadObject(self, Window parent, String name, String classname) -> Object</autodoc> |
f32fc4bc RD |
39933 | <paramlist> |
39934 | <param name="parent" type="Window" default=""/> | |
39935 | <param name="name" type="String" default=""/> | |
39936 | <param name="classname" type="String" default=""/> | |
39937 | </paramlist> | |
39938 | </method> | |
39939 | <method name="LoadOnObject" type="bool" overloaded="no"> | |
781d2982 | 39940 | <autodoc>LoadOnObject(self, Object instance, Window parent, String name, String classname) -> bool</autodoc> |
f32fc4bc RD |
39941 | <paramlist> |
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=""/> | |
39946 | </paramlist> | |
39947 | </method> | |
39948 | <method name="LoadBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 39949 | <autodoc>LoadBitmap(self, String name) -> Bitmap</autodoc> |
f32fc4bc RD |
39950 | <paramlist> |
39951 | <param name="name" type="String" default=""/> | |
39952 | </paramlist> | |
39953 | </method> | |
39954 | <method name="LoadIcon" type="Icon" overloaded="no"> | |
781d2982 | 39955 | <autodoc>LoadIcon(self, String name) -> Icon</autodoc> |
f32fc4bc RD |
39956 | <paramlist> |
39957 | <param name="name" type="String" default=""/> | |
39958 | </paramlist> | |
39959 | </method> | |
39960 | <method name="AttachUnknownControl" type="bool" overloaded="no"> | |
781d2982 | 39961 | <autodoc>AttachUnknownControl(self, String name, Window control, Window parent=None) -> bool</autodoc> |
f32fc4bc RD |
39962 | <paramlist> |
39963 | <param name="name" type="String" default=""/> | |
39964 | <param name="control" type="Window" default=""/> | |
39965 | <param name="parent" type="Window" default="NULL"/> | |
39966 | </paramlist> | |
39967 | </method> | |
39968 | <staticmethod name="GetXRCID" type="int" overloaded="no"> | |
39969 | <autodoc>GetXRCID(String str_id) -> int</autodoc> | |
39970 | <paramlist> | |
39971 | <param name="str_id" type="String" default=""/> | |
39972 | </paramlist> | |
39973 | </staticmethod> | |
39974 | <method name="GetVersion" type="long" overloaded="no"> | |
781d2982 | 39975 | <autodoc>GetVersion(self) -> long</autodoc> |
f32fc4bc RD |
39976 | </method> |
39977 | <method name="CompareVersion" type="int" overloaded="no"> | |
781d2982 | 39978 | <autodoc>CompareVersion(self, int major, int minor, int release, int revision) -> int</autodoc> |
f32fc4bc RD |
39979 | <paramlist> |
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=""/> | |
39984 | </paramlist> | |
39985 | </method> | |
39986 | <staticmethod name="Get" type="XmlResource" overloaded="no"> | |
39987 | <autodoc>Get() -> XmlResource</autodoc> | |
39988 | </staticmethod> | |
39989 | <staticmethod name="Set" type="XmlResource" overloaded="no"> | |
39990 | <autodoc>Set(XmlResource res) -> XmlResource</autodoc> | |
39991 | <paramlist> | |
39992 | <param name="res" type="XmlResource" default=""/> | |
39993 | </paramlist> | |
39994 | </staticmethod> | |
39995 | <method name="GetFlags" type="int" overloaded="no"> | |
781d2982 | 39996 | <autodoc>GetFlags(self) -> int</autodoc> |
f32fc4bc RD |
39997 | </method> |
39998 | <method name="SetFlags" type="" overloaded="no"> | |
781d2982 | 39999 | <autodoc>SetFlags(self, int flags)</autodoc> |
f32fc4bc RD |
40000 | <paramlist> |
40001 | <param name="flags" type="int" default=""/> | |
40002 | </paramlist> | |
40003 | </method> | |
40004 | </class> | |
40005 | <pythoncode> | |
40006 | def XRCID(str_id): | |
40007 | return XmlResource_GetXRCID(str_id) | |
40008 | ||
40009 | def XRCCTRL(window, str_id, *ignoreargs): | |
40010 | return window.FindWindowById(XRCID(str_id)) | |
40011 | </pythoncode> | |
40012 | <pythoncode> | |
40013 | #--------------------------------------------------------------------------- | |
40014 | </pythoncode> | |
40015 | <class name="XmlSubclassFactory" oldname="wxPyXmlSubclassFactory" module="xrc"> | |
40016 | <constructor name="wxPyXmlSubclassFactory" overloaded="no"> | |
781d2982 | 40017 | <autodoc>__init__(self) -> XmlSubclassFactory</autodoc> |
f32fc4bc RD |
40018 | </constructor> |
40019 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 40020 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
40021 | <paramlist> |
40022 | <param name="self" type="PyObject" default=""/> | |
40023 | <param name="_class" type="PyObject" default=""/> | |
40024 | </paramlist> | |
40025 | </method> | |
40026 | </class> | |
40027 | <pythoncode> | |
40028 | #--------------------------------------------------------------------------- | |
40029 | </pythoncode> | |
40030 | <class name="XmlProperty" oldname="wxXmlProperty" module="xrc"> | |
40031 | <constructor name="XmlProperty" overloaded="no"> | |
781d2982 | 40032 | <autodoc>__init__(self, String name=EmptyString, String value=EmptyString, |
f32fc4bc RD |
40033 | XmlProperty next=None) -> XmlProperty</autodoc> |
40034 | <paramlist> | |
40035 | <param name="name" type="String" default="wxPyEmptyString"/> | |
40036 | <param name="value" type="String" default="wxPyEmptyString"/> | |
40037 | <param name="next" type="XmlProperty" default="NULL"/> | |
40038 | </paramlist> | |
40039 | </constructor> | |
40040 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 40041 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
40042 | </method> |
40043 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 40044 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
40045 | </method> |
40046 | <method name="GetNext" type="XmlProperty" overloaded="no"> | |
781d2982 | 40047 | <autodoc>GetNext(self) -> XmlProperty</autodoc> |
f32fc4bc RD |
40048 | </method> |
40049 | <method name="SetName" type="" overloaded="no"> | |
781d2982 | 40050 | <autodoc>SetName(self, String name)</autodoc> |
f32fc4bc RD |
40051 | <paramlist> |
40052 | <param name="name" type="String" default=""/> | |
40053 | </paramlist> | |
40054 | </method> | |
40055 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 40056 | <autodoc>SetValue(self, String value)</autodoc> |
f32fc4bc RD |
40057 | <paramlist> |
40058 | <param name="value" type="String" default=""/> | |
40059 | </paramlist> | |
40060 | </method> | |
40061 | <method name="SetNext" type="" overloaded="no"> | |
781d2982 | 40062 | <autodoc>SetNext(self, XmlProperty next)</autodoc> |
f32fc4bc RD |
40063 | <paramlist> |
40064 | <param name="next" type="XmlProperty" default=""/> | |
40065 | </paramlist> | |
40066 | </method> | |
40067 | </class> | |
40068 | <class name="XmlNode" oldname="wxXmlNode" module="xrc"> | |
40069 | <constructor name="XmlNode" overloaded="no"> | |
781d2982 | 40070 | <autodoc>__init__(self, XmlNode parent=None, int type=0, String name=EmptyString, |
f32fc4bc RD |
40071 | String content=EmptyString, XmlProperty props=None, |
40072 | XmlNode next=None) -> XmlNode</autodoc> | |
40073 | <paramlist> | |
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"/> | |
40080 | </paramlist> | |
40081 | </constructor> | |
40082 | <constructor name="XmlNodeEasy" overloaded="no"> | |
40083 | <autodoc>XmlNodeEasy(int type, String name, String content=EmptyString) -> XmlNode</autodoc> | |
40084 | <paramlist> | |
40085 | <param name="type" type="wxXmlNodeType" default=""/> | |
40086 | <param name="name" type="String" default=""/> | |
40087 | <param name="content" type="String" default="wxPyEmptyString"/> | |
40088 | </paramlist> | |
40089 | </constructor> | |
40090 | <destructor name="~wxXmlNode" overloaded="no"> | |
781d2982 | 40091 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
40092 | </destructor> |
40093 | <method name="AddChild" type="" overloaded="no"> | |
781d2982 | 40094 | <autodoc>AddChild(self, XmlNode child)</autodoc> |
f32fc4bc RD |
40095 | <paramlist> |
40096 | <param name="child" type="XmlNode" default=""/> | |
40097 | </paramlist> | |
40098 | </method> | |
40099 | <method name="InsertChild" type="" overloaded="no"> | |
781d2982 | 40100 | <autodoc>InsertChild(self, XmlNode child, XmlNode before_node)</autodoc> |
f32fc4bc RD |
40101 | <paramlist> |
40102 | <param name="child" type="XmlNode" default=""/> | |
40103 | <param name="before_node" type="XmlNode" default=""/> | |
40104 | </paramlist> | |
40105 | </method> | |
40106 | <method name="RemoveChild" type="bool" overloaded="no"> | |
781d2982 | 40107 | <autodoc>RemoveChild(self, XmlNode child) -> bool</autodoc> |
f32fc4bc RD |
40108 | <paramlist> |
40109 | <param name="child" type="XmlNode" default=""/> | |
40110 | </paramlist> | |
40111 | </method> | |
40112 | <method name="AddProperty" type="" overloaded="no"> | |
781d2982 | 40113 | <autodoc>AddProperty(self, XmlProperty prop)</autodoc> |
f32fc4bc RD |
40114 | <paramlist> |
40115 | <param name="prop" type="XmlProperty" default=""/> | |
40116 | </paramlist> | |
40117 | </method> | |
40118 | <method name="AddPropertyName" type="" overloaded="no"> | |
781d2982 | 40119 | <autodoc>AddPropertyName(self, String name, String value)</autodoc> |
f32fc4bc RD |
40120 | <paramlist> |
40121 | <param name="name" type="String" default=""/> | |
40122 | <param name="value" type="String" default=""/> | |
40123 | </paramlist> | |
40124 | </method> | |
40125 | <method name="DeleteProperty" type="bool" overloaded="no"> | |
781d2982 | 40126 | <autodoc>DeleteProperty(self, String name) -> bool</autodoc> |
f32fc4bc RD |
40127 | <paramlist> |
40128 | <param name="name" type="String" default=""/> | |
40129 | </paramlist> | |
40130 | </method> | |
40131 | <method name="GetType" type="wxXmlNodeType" overloaded="no"> | |
781d2982 | 40132 | <autodoc>GetType(self) -> int</autodoc> |
f32fc4bc RD |
40133 | </method> |
40134 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 40135 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
40136 | </method> |
40137 | <method name="GetContent" type="String" overloaded="no"> | |
781d2982 | 40138 | <autodoc>GetContent(self) -> String</autodoc> |
f32fc4bc RD |
40139 | </method> |
40140 | <method name="GetParent" type="XmlNode" overloaded="no"> | |
781d2982 | 40141 | <autodoc>GetParent(self) -> XmlNode</autodoc> |
f32fc4bc RD |
40142 | </method> |
40143 | <method name="GetNext" type="XmlNode" overloaded="no"> | |
781d2982 | 40144 | <autodoc>GetNext(self) -> XmlNode</autodoc> |
f32fc4bc RD |
40145 | </method> |
40146 | <method name="GetChildren" type="XmlNode" overloaded="no"> | |
781d2982 | 40147 | <autodoc>GetChildren(self) -> XmlNode</autodoc> |
f32fc4bc RD |
40148 | </method> |
40149 | <method name="GetProperties" type="XmlProperty" overloaded="no"> | |
781d2982 | 40150 | <autodoc>GetProperties(self) -> XmlProperty</autodoc> |
f32fc4bc RD |
40151 | </method> |
40152 | <method name="GetPropVal" type="String" overloaded="no"> | |
781d2982 | 40153 | <autodoc>GetPropVal(self, String propName, String defaultVal) -> String</autodoc> |
f32fc4bc RD |
40154 | <paramlist> |
40155 | <param name="propName" type="String" default=""/> | |
40156 | <param name="defaultVal" type="String" default=""/> | |
40157 | </paramlist> | |
40158 | </method> | |
40159 | <method name="HasProp" type="bool" overloaded="no"> | |
781d2982 | 40160 | <autodoc>HasProp(self, String propName) -> bool</autodoc> |
f32fc4bc RD |
40161 | <paramlist> |
40162 | <param name="propName" type="String" default=""/> | |
40163 | </paramlist> | |
40164 | </method> | |
40165 | <method name="SetType" type="" overloaded="no"> | |
781d2982 | 40166 | <autodoc>SetType(self, int type)</autodoc> |
f32fc4bc RD |
40167 | <paramlist> |
40168 | <param name="type" type="wxXmlNodeType" default=""/> | |
40169 | </paramlist> | |
40170 | </method> | |
40171 | <method name="SetName" type="" overloaded="no"> | |
781d2982 | 40172 | <autodoc>SetName(self, String name)</autodoc> |
f32fc4bc RD |
40173 | <paramlist> |
40174 | <param name="name" type="String" default=""/> | |
40175 | </paramlist> | |
40176 | </method> | |
40177 | <method name="SetContent" type="" overloaded="no"> | |
781d2982 | 40178 | <autodoc>SetContent(self, String con)</autodoc> |
f32fc4bc RD |
40179 | <paramlist> |
40180 | <param name="con" type="String" default=""/> | |
40181 | </paramlist> | |
40182 | </method> | |
40183 | <method name="SetParent" type="" overloaded="no"> | |
781d2982 | 40184 | <autodoc>SetParent(self, XmlNode parent)</autodoc> |
f32fc4bc RD |
40185 | <paramlist> |
40186 | <param name="parent" type="XmlNode" default=""/> | |
40187 | </paramlist> | |
40188 | </method> | |
40189 | <method name="SetNext" type="" overloaded="no"> | |
781d2982 | 40190 | <autodoc>SetNext(self, XmlNode next)</autodoc> |
f32fc4bc RD |
40191 | <paramlist> |
40192 | <param name="next" type="XmlNode" default=""/> | |
40193 | </paramlist> | |
40194 | </method> | |
40195 | <method name="SetChildren" type="" overloaded="no"> | |
781d2982 | 40196 | <autodoc>SetChildren(self, XmlNode child)</autodoc> |
f32fc4bc RD |
40197 | <paramlist> |
40198 | <param name="child" type="XmlNode" default=""/> | |
40199 | </paramlist> | |
40200 | </method> | |
40201 | <method name="SetProperties" type="" overloaded="no"> | |
781d2982 | 40202 | <autodoc>SetProperties(self, XmlProperty prop)</autodoc> |
f32fc4bc RD |
40203 | <paramlist> |
40204 | <param name="prop" type="XmlProperty" default=""/> | |
40205 | </paramlist> | |
40206 | </method> | |
40207 | </class> | |
40208 | <class name="XmlDocument" oldname="wxXmlDocument" module="xrc"> | |
40209 | <baseclass name="Object"/> | |
40210 | <constructor name="XmlDocument" overloaded="no"> | |
781d2982 | 40211 | <autodoc>__init__(self, String filename, String encoding=UTF8String) -> XmlDocument</autodoc> |
f32fc4bc RD |
40212 | <paramlist> |
40213 | <param name="filename" type="String" default=""/> | |
40214 | <param name="encoding" type="String" default="wxPyUTF8String"/> | |
40215 | </paramlist> | |
40216 | </constructor> | |
40217 | <constructor name="XmlDocumentFromStream" overloaded="no"> | |
40218 | <autodoc>XmlDocumentFromStream(InputStream stream, String encoding=UTF8String) -> XmlDocument</autodoc> | |
40219 | <paramlist> | |
40220 | <param name="stream" type="wxInputStream" default=""/> | |
40221 | <param name="encoding" type="String" default="wxPyUTF8String"/> | |
40222 | </paramlist> | |
40223 | </constructor> | |
40224 | <constructor name="EmptyXmlDocument" overloaded="no"> | |
40225 | <autodoc>EmptyXmlDocument() -> XmlDocument</autodoc> | |
40226 | </constructor> | |
40227 | <destructor name="~wxXmlDocument" overloaded="no"> | |
781d2982 | 40228 | <autodoc>__del__(self)</autodoc> |
f32fc4bc RD |
40229 | </destructor> |
40230 | <method name="Load" type="bool" overloaded="no"> | |
781d2982 | 40231 | <autodoc>Load(self, String filename, String encoding=UTF8String) -> bool</autodoc> |
f32fc4bc RD |
40232 | <paramlist> |
40233 | <param name="filename" type="String" default=""/> | |
40234 | <param name="encoding" type="String" default="wxPyUTF8String"/> | |
40235 | </paramlist> | |
40236 | </method> | |
40237 | <method name="LoadFromStream" type="bool" overloaded="no"> | |
781d2982 | 40238 | <autodoc>LoadFromStream(self, InputStream stream, String encoding=UTF8String) -> bool</autodoc> |
f32fc4bc RD |
40239 | <paramlist> |
40240 | <param name="stream" type="wxInputStream" default=""/> | |
40241 | <param name="encoding" type="String" default="wxPyUTF8String"/> | |
40242 | </paramlist> | |
40243 | </method> | |
40244 | <method name="Save" type="bool" overloaded="no"> | |
781d2982 | 40245 | <autodoc>Save(self, String filename) -> bool</autodoc> |
f32fc4bc RD |
40246 | <paramlist> |
40247 | <param name="filename" type="String" default=""/> | |
40248 | </paramlist> | |
40249 | </method> | |
40250 | <method name="SaveToStream" type="bool" overloaded="no"> | |
781d2982 | 40251 | <autodoc>SaveToStream(self, OutputStream stream) -> bool</autodoc> |
f32fc4bc RD |
40252 | <paramlist> |
40253 | <param name="stream" type="OutputStream" default=""/> | |
40254 | </paramlist> | |
40255 | </method> | |
40256 | <method name="IsOk" type="bool" overloaded="no"> | |
781d2982 | 40257 | <autodoc>IsOk(self) -> bool</autodoc> |
f32fc4bc RD |
40258 | </method> |
40259 | <method name="GetRoot" type="XmlNode" overloaded="no"> | |
781d2982 | 40260 | <autodoc>GetRoot(self) -> XmlNode</autodoc> |
f32fc4bc RD |
40261 | </method> |
40262 | <method name="GetVersion" type="String" overloaded="no"> | |
781d2982 | 40263 | <autodoc>GetVersion(self) -> String</autodoc> |
f32fc4bc RD |
40264 | </method> |
40265 | <method name="GetFileEncoding" type="String" overloaded="no"> | |
781d2982 | 40266 | <autodoc>GetFileEncoding(self) -> String</autodoc> |
f32fc4bc RD |
40267 | </method> |
40268 | <method name="SetRoot" type="" overloaded="no"> | |
781d2982 | 40269 | <autodoc>SetRoot(self, XmlNode node)</autodoc> |
f32fc4bc RD |
40270 | <paramlist> |
40271 | <param name="node" type="XmlNode" default=""/> | |
40272 | </paramlist> | |
40273 | </method> | |
40274 | <method name="SetVersion" type="" overloaded="no"> | |
781d2982 | 40275 | <autodoc>SetVersion(self, String version)</autodoc> |
f32fc4bc RD |
40276 | <paramlist> |
40277 | <param name="version" type="String" default=""/> | |
40278 | </paramlist> | |
40279 | </method> | |
40280 | <method name="SetFileEncoding" type="" overloaded="no"> | |
781d2982 | 40281 | <autodoc>SetFileEncoding(self, String encoding)</autodoc> |
f32fc4bc RD |
40282 | <paramlist> |
40283 | <param name="encoding" type="String" default=""/> | |
40284 | </paramlist> | |
40285 | </method> | |
40286 | </class> | |
40287 | <pythoncode> | |
40288 | #--------------------------------------------------------------------------- | |
40289 | </pythoncode> | |
40290 | <class name="XmlResourceHandler" oldname="wxPyXmlResourceHandler" module="xrc"> | |
40291 | <baseclass name="Object"/> | |
40292 | <constructor name="wxPyXmlResourceHandler" overloaded="no"> | |
781d2982 | 40293 | <autodoc>__init__(self) -> XmlResourceHandler</autodoc> |
f32fc4bc RD |
40294 | </constructor> |
40295 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 40296 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
40297 | <paramlist> |
40298 | <param name="self" type="PyObject" default=""/> | |
40299 | <param name="_class" type="PyObject" default=""/> | |
40300 | </paramlist> | |
40301 | </method> | |
40302 | <method name="CreateResource" type="Object" overloaded="no"> | |
781d2982 | 40303 | <autodoc>CreateResource(self, XmlNode node, Object parent, Object instance) -> Object</autodoc> |
f32fc4bc RD |
40304 | <paramlist> |
40305 | <param name="node" type="XmlNode" default=""/> | |
40306 | <param name="parent" type="Object" default=""/> | |
40307 | <param name="instance" type="Object" default=""/> | |
40308 | </paramlist> | |
40309 | </method> | |
40310 | <method name="SetParentResource" type="" overloaded="no"> | |
781d2982 | 40311 | <autodoc>SetParentResource(self, XmlResource res)</autodoc> |
f32fc4bc RD |
40312 | <paramlist> |
40313 | <param name="res" type="XmlResource" default=""/> | |
40314 | </paramlist> | |
40315 | </method> | |
40316 | <method name="GetResource" type="XmlResource" overloaded="no"> | |
781d2982 | 40317 | <autodoc>GetResource(self) -> XmlResource</autodoc> |
f32fc4bc RD |
40318 | </method> |
40319 | <method name="GetNode" type="XmlNode" overloaded="no"> | |
781d2982 | 40320 | <autodoc>GetNode(self) -> XmlNode</autodoc> |
f32fc4bc RD |
40321 | </method> |
40322 | <method name="GetClass" type="String" overloaded="no"> | |
781d2982 | 40323 | <autodoc>GetClass(self) -> String</autodoc> |
f32fc4bc RD |
40324 | </method> |
40325 | <method name="GetParent" type="Object" overloaded="no"> | |
781d2982 | 40326 | <autodoc>GetParent(self) -> Object</autodoc> |
f32fc4bc RD |
40327 | </method> |
40328 | <method name="GetInstance" type="Object" overloaded="no"> | |
781d2982 | 40329 | <autodoc>GetInstance(self) -> Object</autodoc> |
f32fc4bc RD |
40330 | </method> |
40331 | <method name="GetParentAsWindow" type="Window" overloaded="no"> | |
781d2982 | 40332 | <autodoc>GetParentAsWindow(self) -> Window</autodoc> |
f32fc4bc RD |
40333 | </method> |
40334 | <method name="GetInstanceAsWindow" type="Window" overloaded="no"> | |
781d2982 | 40335 | <autodoc>GetInstanceAsWindow(self) -> Window</autodoc> |
f32fc4bc RD |
40336 | </method> |
40337 | <method name="IsOfClass" type="bool" overloaded="no"> | |
781d2982 | 40338 | <autodoc>IsOfClass(self, XmlNode node, String classname) -> bool</autodoc> |
f32fc4bc RD |
40339 | <paramlist> |
40340 | <param name="node" type="XmlNode" default=""/> | |
40341 | <param name="classname" type="String" default=""/> | |
40342 | </paramlist> | |
40343 | </method> | |
40344 | <method name="GetNodeContent" type="String" overloaded="no"> | |
781d2982 | 40345 | <autodoc>GetNodeContent(self, XmlNode node) -> String</autodoc> |
f32fc4bc RD |
40346 | <paramlist> |
40347 | <param name="node" type="XmlNode" default=""/> | |
40348 | </paramlist> | |
40349 | </method> | |
40350 | <method name="HasParam" type="bool" overloaded="no"> | |
781d2982 | 40351 | <autodoc>HasParam(self, String param) -> bool</autodoc> |
f32fc4bc RD |
40352 | <paramlist> |
40353 | <param name="param" type="String" default=""/> | |
40354 | </paramlist> | |
40355 | </method> | |
40356 | <method name="GetParamNode" type="XmlNode" overloaded="no"> | |
781d2982 | 40357 | <autodoc>GetParamNode(self, String param) -> XmlNode</autodoc> |
f32fc4bc RD |
40358 | <paramlist> |
40359 | <param name="param" type="String" default=""/> | |
40360 | </paramlist> | |
40361 | </method> | |
40362 | <method name="GetParamValue" type="String" overloaded="no"> | |
781d2982 | 40363 | <autodoc>GetParamValue(self, String param) -> String</autodoc> |
f32fc4bc RD |
40364 | <paramlist> |
40365 | <param name="param" type="String" default=""/> | |
40366 | </paramlist> | |
40367 | </method> | |
40368 | <method name="AddStyle" type="" overloaded="no"> | |
781d2982 | 40369 | <autodoc>AddStyle(self, String name, int value)</autodoc> |
f32fc4bc RD |
40370 | <paramlist> |
40371 | <param name="name" type="String" default=""/> | |
40372 | <param name="value" type="int" default=""/> | |
40373 | </paramlist> | |
40374 | </method> | |
40375 | <method name="AddWindowStyles" type="" overloaded="no"> | |
781d2982 | 40376 | <autodoc>AddWindowStyles(self)</autodoc> |
f32fc4bc RD |
40377 | </method> |
40378 | <method name="GetStyle" type="int" overloaded="no"> | |
781d2982 | 40379 | <autodoc>GetStyle(self, String param=StyleString, int defaults=0) -> int</autodoc> |
f32fc4bc RD |
40380 | <paramlist> |
40381 | <param name="param" type="String" default="wxPyStyleString"/> | |
40382 | <param name="defaults" type="int" default="0"/> | |
40383 | </paramlist> | |
40384 | </method> | |
40385 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 40386 | <autodoc>GetText(self, String param, bool translate=True) -> String</autodoc> |
f32fc4bc RD |
40387 | <paramlist> |
40388 | <param name="param" type="String" default=""/> | |
40389 | <param name="translate" type="bool" default="True"/> | |
40390 | </paramlist> | |
40391 | </method> | |
40392 | <method name="GetID" type="int" overloaded="no"> | |
781d2982 | 40393 | <autodoc>GetID(self) -> int</autodoc> |
f32fc4bc RD |
40394 | </method> |
40395 | <method name="GetName" type="String" overloaded="no"> | |
781d2982 | 40396 | <autodoc>GetName(self) -> String</autodoc> |
f32fc4bc RD |
40397 | </method> |
40398 | <method name="GetBool" type="bool" overloaded="no"> | |
781d2982 | 40399 | <autodoc>GetBool(self, String param, bool defaultv=False) -> bool</autodoc> |
f32fc4bc RD |
40400 | <paramlist> |
40401 | <param name="param" type="String" default=""/> | |
40402 | <param name="defaultv" type="bool" default="False"/> | |
40403 | </paramlist> | |
40404 | </method> | |
40405 | <method name="GetLong" type="long" overloaded="no"> | |
781d2982 | 40406 | <autodoc>GetLong(self, String param, long defaultv=0) -> long</autodoc> |
f32fc4bc RD |
40407 | <paramlist> |
40408 | <param name="param" type="String" default=""/> | |
40409 | <param name="defaultv" type="long" default="0"/> | |
40410 | </paramlist> | |
40411 | </method> | |
40412 | <method name="GetColour" type="Colour" overloaded="no"> | |
781d2982 | 40413 | <autodoc>GetColour(self, String param) -> Colour</autodoc> |
f32fc4bc RD |
40414 | <paramlist> |
40415 | <param name="param" type="String" default=""/> | |
40416 | </paramlist> | |
40417 | </method> | |
40418 | <method name="GetSize" type="Size" overloaded="no"> | |
781d2982 | 40419 | <autodoc>GetSize(self, String param=SizeString) -> Size</autodoc> |
f32fc4bc RD |
40420 | <paramlist> |
40421 | <param name="param" type="String" default="wxPySizeString"/> | |
40422 | </paramlist> | |
40423 | </method> | |
40424 | <method name="GetPosition" type="Point" overloaded="no"> | |
781d2982 | 40425 | <autodoc>GetPosition(self, String param=PosString) -> Point</autodoc> |
f32fc4bc RD |
40426 | <paramlist> |
40427 | <param name="param" type="String" default="wxPyPosString"/> | |
40428 | </paramlist> | |
40429 | </method> | |
40430 | <method name="GetDimension" type="int" overloaded="no"> | |
781d2982 | 40431 | <autodoc>GetDimension(self, String param, int defaultv=0) -> int</autodoc> |
f32fc4bc RD |
40432 | <paramlist> |
40433 | <param name="param" type="String" default=""/> | |
40434 | <param name="defaultv" type="int" default="0"/> | |
40435 | </paramlist> | |
40436 | </method> | |
40437 | <method name="GetBitmap" type="Bitmap" overloaded="no"> | |
781d2982 | 40438 | <autodoc>GetBitmap(self, String param=BitmapString, wxArtClient defaultArtClient=wxART_OTHER, |
f32fc4bc RD |
40439 | Size size=DefaultSize) -> Bitmap</autodoc> |
40440 | <paramlist> | |
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"/> | |
40444 | </paramlist> | |
40445 | </method> | |
40446 | <method name="GetIcon" type="Icon" overloaded="no"> | |
781d2982 | 40447 | <autodoc>GetIcon(self, String param=IconString, wxArtClient defaultArtClient=wxART_OTHER, |
f32fc4bc RD |
40448 | Size size=DefaultSize) -> Icon</autodoc> |
40449 | <paramlist> | |
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"/> | |
40453 | </paramlist> | |
40454 | </method> | |
40455 | <method name="GetFont" type="Font" overloaded="no"> | |
781d2982 | 40456 | <autodoc>GetFont(self, String param=FontString) -> Font</autodoc> |
f32fc4bc RD |
40457 | <paramlist> |
40458 | <param name="param" type="String" default="wxPyFontString"/> | |
40459 | </paramlist> | |
40460 | </method> | |
40461 | <method name="SetupWindow" type="" overloaded="no"> | |
781d2982 | 40462 | <autodoc>SetupWindow(self, Window wnd)</autodoc> |
f32fc4bc RD |
40463 | <paramlist> |
40464 | <param name="wnd" type="Window" default=""/> | |
40465 | </paramlist> | |
40466 | </method> | |
40467 | <method name="CreateChildren" type="" overloaded="no"> | |
781d2982 | 40468 | <autodoc>CreateChildren(self, Object parent, bool this_hnd_only=False)</autodoc> |
f32fc4bc RD |
40469 | <paramlist> |
40470 | <param name="parent" type="Object" default=""/> | |
40471 | <param name="this_hnd_only" type="bool" default="False"/> | |
40472 | </paramlist> | |
40473 | </method> | |
40474 | <method name="CreateChildrenPrivately" type="" overloaded="no"> | |
781d2982 | 40475 | <autodoc>CreateChildrenPrivately(self, Object parent, XmlNode rootnode=None)</autodoc> |
f32fc4bc RD |
40476 | <paramlist> |
40477 | <param name="parent" type="Object" default=""/> | |
40478 | <param name="rootnode" type="XmlNode" default="NULL"/> | |
40479 | </paramlist> | |
40480 | </method> | |
40481 | <method name="CreateResFromNode" type="Object" overloaded="no"> | |
781d2982 | 40482 | <autodoc>CreateResFromNode(self, XmlNode node, Object parent, Object instance=None) -> Object</autodoc> |
f32fc4bc RD |
40483 | <paramlist> |
40484 | <param name="node" type="XmlNode" default=""/> | |
40485 | <param name="parent" type="Object" default=""/> | |
40486 | <param name="instance" type="Object" default="NULL"/> | |
40487 | </paramlist> | |
40488 | </method> | |
40489 | <method name="GetCurFileSystem" type="FileSystem" overloaded="no"> | |
781d2982 | 40490 | <autodoc>GetCurFileSystem(self) -> FileSystem</autodoc> |
f32fc4bc RD |
40491 | </method> |
40492 | </class> | |
40493 | <pythoncode>#---------------------------------------------------------------------------- | |
40494 | # The global was removed in favor of static accessor functions. This is for | |
40495 | # backwards compatibility: | |
40496 | ||
40497 | TheXmlResource = XmlResource_Get() | |
40498 | ||
40499 | ||
40500 | #---------------------------------------------------------------------------- | |
40501 | # Create a factory for handling the subclass property of the object tag. | |
40502 | ||
40503 | ||
40504 | def _my_import(name): | |
40505 | mod = __import__(name) | |
40506 | components = name.split('.') | |
40507 | for comp in components[1:]: | |
40508 | mod = getattr(mod, comp) | |
40509 | return mod | |
40510 | ||
40511 | ||
40512 | class XmlSubclassFactory_Python(XmlSubclassFactory): | |
40513 | def __init__(self): | |
40514 | XmlSubclassFactory.__init__(self) | |
40515 | ||
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) | |
40522 | inst = klass() | |
40523 | return inst | |
40524 | ||
40525 | ||
40526 | XmlResource_AddSubclassFactory(XmlSubclassFactory_Python()) | |
40527 | ||
40528 | #---------------------------------------------------------------------------- | |
40529 | </pythoncode> | |
40530 | </module> | |
40531 | <module name="gizmos"> | |
781d2982 RD |
40532 | <import name="_windows"/> |
40533 | <import name="_controls"/> | |
ce6878e6 RD |
40534 | <pythoncode> import wx </pythoncode> |
40535 | <pythoncode> __docfilter__ = wx._core.__DocFilter(globals()) </pythoncode> | |
f32fc4bc RD |
40536 | <class name="DynamicSashSplitEvent" oldname="wxDynamicSashSplitEvent" module="gizmos"> |
40537 | <baseclass name="CommandEvent"/> | |
40538 | <constructor name="DynamicSashSplitEvent" overloaded="no"> | |
781d2982 | 40539 | <autodoc>__init__(self, Object target) -> DynamicSashSplitEvent</autodoc> |
f32fc4bc RD |
40540 | <paramlist> |
40541 | <param name="target" type="Object" default=""/> | |
40542 | </paramlist> | |
40543 | </constructor> | |
40544 | </class> | |
40545 | <class name="DynamicSashUnifyEvent" oldname="wxDynamicSashUnifyEvent" module="gizmos"> | |
40546 | <baseclass name="CommandEvent"/> | |
40547 | <constructor name="DynamicSashUnifyEvent" overloaded="no"> | |
781d2982 | 40548 | <autodoc>__init__(self, Object target) -> DynamicSashUnifyEvent</autodoc> |
f32fc4bc RD |
40549 | <paramlist> |
40550 | <param name="target" type="Object" default=""/> | |
40551 | </paramlist> | |
40552 | </constructor> | |
40553 | </class> | |
40554 | <class name="DynamicSashWindow" oldname="wxDynamicSashWindow" module="gizmos"> | |
40555 | <baseclass name="Window"/> | |
40556 | <constructor name="DynamicSashWindow" overloaded="no"> | |
781d2982 RD |
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, | |
f32fc4bc RD |
40559 | String name=DynamicSashNameStr) -> DynamicSashWindow</autodoc> |
40560 | <paramlist> | |
40561 | <param name="parent" type="Window" default=""/> | |
781d2982 | 40562 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
40567 | </paramlist> | |
40568 | </constructor> | |
40569 | <constructor name="PreDynamicSashWindow" overloaded="no"> | |
40570 | <autodoc>PreDynamicSashWindow() -> DynamicSashWindow</autodoc> | |
40571 | </constructor> | |
40572 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 RD |
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, | |
f32fc4bc RD |
40575 | String name=DynamicSashNameStr) -> bool</autodoc> |
40576 | <paramlist> | |
40577 | <param name="parent" type="Window" default=""/> | |
781d2982 | 40578 | <param name="id" type="int" default="-1"/> |
f32fc4bc RD |
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"/> | |
40583 | </paramlist> | |
40584 | </method> | |
40585 | <method name="GetHScrollBar" type="ScrollBar" overloaded="no"> | |
781d2982 | 40586 | <autodoc>GetHScrollBar(self, Window child) -> ScrollBar</autodoc> |
f32fc4bc RD |
40587 | <paramlist> |
40588 | <param name="child" type="Window" default=""/> | |
40589 | </paramlist> | |
40590 | </method> | |
40591 | <method name="GetVScrollBar" type="ScrollBar" overloaded="no"> | |
781d2982 | 40592 | <autodoc>GetVScrollBar(self, Window child) -> ScrollBar</autodoc> |
f32fc4bc RD |
40593 | <paramlist> |
40594 | <param name="child" type="Window" default=""/> | |
40595 | </paramlist> | |
40596 | </method> | |
40597 | </class> | |
40598 | <pythoncode> | |
40599 | EVT_DYNAMIC_SASH_SPLIT = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_SPLIT, 1 ) | |
40600 | EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 ) | |
40601 | </pythoncode> | |
40602 | <class name="EditableListBox" oldname="wxEditableListBox" module="gizmos"> | |
40603 | <baseclass name="Panel"/> | |
40604 | <constructor name="EditableListBox" overloaded="no"> | |
781d2982 RD |
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, | |
f32fc4bc RD |
40608 | String name=EditableListBoxNameStr) -> EditableListBox</autodoc> |
40609 | <paramlist> | |
40610 | <param name="parent" type="Window" default=""/> | |
781d2982 RD |
40611 | <param name="id" type="int" default="-1"/> |
40612 | <param name="label" type="String" default="wxPyEmptyString"/> | |
f32fc4bc RD |
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"/> | |
40617 | </paramlist> | |
40618 | </constructor> | |
40619 | <method name="SetStrings" type="" overloaded="no"> | |
781d2982 | 40620 | <autodoc>SetStrings(self, wxArrayString strings)</autodoc> |
f32fc4bc RD |
40621 | <paramlist> |
40622 | <param name="strings" type="wxArrayString" default=""/> | |
40623 | </paramlist> | |
40624 | </method> | |
40625 | <method name="GetStrings" type="PyObject" overloaded="no"> | |
781d2982 | 40626 | <autodoc>GetStrings(self) -> PyObject</autodoc> |
f32fc4bc RD |
40627 | </method> |
40628 | <method name="GetListCtrl" type="wxListCtrl" overloaded="no"> | |
781d2982 | 40629 | <autodoc>GetListCtrl(self) -> wxListCtrl</autodoc> |
f32fc4bc RD |
40630 | </method> |
40631 | <method name="GetDelButton" type="BitmapButton" overloaded="no"> | |
781d2982 | 40632 | <autodoc>GetDelButton(self) -> BitmapButton</autodoc> |
f32fc4bc RD |
40633 | </method> |
40634 | <method name="GetNewButton" type="BitmapButton" overloaded="no"> | |
781d2982 | 40635 | <autodoc>GetNewButton(self) -> BitmapButton</autodoc> |
f32fc4bc RD |
40636 | </method> |
40637 | <method name="GetUpButton" type="BitmapButton" overloaded="no"> | |
781d2982 | 40638 | <autodoc>GetUpButton(self) -> BitmapButton</autodoc> |
f32fc4bc RD |
40639 | </method> |
40640 | <method name="GetDownButton" type="BitmapButton" overloaded="no"> | |
781d2982 | 40641 | <autodoc>GetDownButton(self) -> BitmapButton</autodoc> |
f32fc4bc RD |
40642 | </method> |
40643 | <method name="GetEditButton" type="BitmapButton" overloaded="no"> | |
781d2982 | 40644 | <autodoc>GetEditButton(self) -> BitmapButton</autodoc> |
f32fc4bc RD |
40645 | </method> |
40646 | </class> | |
40647 | <class name="RemotelyScrolledTreeCtrl" oldname="wxRemotelyScrolledTreeCtrl" module="gizmos"> | |
40648 | <baseclass name="TreeCtrl"/> | |
40649 | <constructor name="RemotelyScrolledTreeCtrl" overloaded="no"> | |
781d2982 | 40650 | <autodoc>__init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize, |
f32fc4bc RD |
40651 | long style=TR_HAS_BUTTONS) -> RemotelyScrolledTreeCtrl</autodoc> |
40652 | <paramlist> | |
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"/> | |
40658 | </paramlist> | |
40659 | </constructor> | |
40660 | <method name="HideVScrollbar" type="" overloaded="no"> | |
781d2982 | 40661 | <autodoc>HideVScrollbar(self)</autodoc> |
f32fc4bc RD |
40662 | </method> |
40663 | <method name="AdjustRemoteScrollbars" type="" overloaded="no"> | |
781d2982 | 40664 | <autodoc>AdjustRemoteScrollbars(self)</autodoc> |
f32fc4bc RD |
40665 | </method> |
40666 | <method name="GetScrolledWindow" type="ScrolledWindow" overloaded="no"> | |
781d2982 | 40667 | <autodoc>GetScrolledWindow(self) -> ScrolledWindow</autodoc> |
f32fc4bc RD |
40668 | </method> |
40669 | <method name="ScrollToLine" type="" overloaded="no"> | |
781d2982 | 40670 | <autodoc>ScrollToLine(self, int posHoriz, int posVert)</autodoc> |
f32fc4bc RD |
40671 | <paramlist> |
40672 | <param name="posHoriz" type="int" default=""/> | |
40673 | <param name="posVert" type="int" default=""/> | |
40674 | </paramlist> | |
40675 | </method> | |
40676 | <method name="SetCompanionWindow" type="" overloaded="no"> | |
781d2982 | 40677 | <autodoc>SetCompanionWindow(self, Window companion)</autodoc> |
f32fc4bc RD |
40678 | <paramlist> |
40679 | <param name="companion" type="Window" default=""/> | |
40680 | </paramlist> | |
40681 | </method> | |
40682 | <method name="GetCompanionWindow" type="Window" overloaded="no"> | |
781d2982 | 40683 | <autodoc>GetCompanionWindow(self) -> Window</autodoc> |
f32fc4bc RD |
40684 | </method> |
40685 | </class> | |
40686 | <class name="TreeCompanionWindow" oldname="wxPyTreeCompanionWindow" module="gizmos"> | |
40687 | <baseclass name="Window"/> | |
40688 | <constructor name="wxPyTreeCompanionWindow" overloaded="no"> | |
781d2982 | 40689 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
40690 | Size size=DefaultSize, long style=0) -> TreeCompanionWindow</autodoc> |
40691 | <paramlist> | |
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"/> | |
40697 | </paramlist> | |
40698 | </constructor> | |
40699 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 40700 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
40701 | <paramlist> |
40702 | <param name="self" type="PyObject" default=""/> | |
40703 | <param name="_class" type="PyObject" default=""/> | |
40704 | </paramlist> | |
40705 | </method> | |
40706 | <method name="GetTreeCtrl" type="RemotelyScrolledTreeCtrl" overloaded="no"> | |
781d2982 | 40707 | <autodoc>GetTreeCtrl(self) -> RemotelyScrolledTreeCtrl</autodoc> |
f32fc4bc RD |
40708 | </method> |
40709 | <method name="SetTreeCtrl" type="" overloaded="no"> | |
781d2982 | 40710 | <autodoc>SetTreeCtrl(self, RemotelyScrolledTreeCtrl treeCtrl)</autodoc> |
f32fc4bc RD |
40711 | <paramlist> |
40712 | <param name="treeCtrl" type="RemotelyScrolledTreeCtrl" default=""/> | |
40713 | </paramlist> | |
40714 | </method> | |
40715 | </class> | |
40716 | <class name="ThinSplitterWindow" oldname="wxThinSplitterWindow" module="gizmos"> | |
40717 | <baseclass name="SplitterWindow"/> | |
40718 | <constructor name="ThinSplitterWindow" overloaded="no"> | |
781d2982 | 40719 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
40720 | Size size=DefaultSize, long style=wxSP_3D|wxCLIP_CHILDREN) -> ThinSplitterWindow</autodoc> |
40721 | <paramlist> | |
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"/> | |
40727 | </paramlist> | |
40728 | </constructor> | |
40729 | </class> | |
40730 | <class name="SplitterScrolledWindow" oldname="wxSplitterScrolledWindow" module="gizmos"> | |
40731 | <baseclass name="ScrolledWindow"/> | |
40732 | <constructor name="SplitterScrolledWindow" overloaded="no"> | |
781d2982 | 40733 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
40734 | Size size=DefaultSize, long style=0) -> SplitterScrolledWindow</autodoc> |
40735 | <paramlist> | |
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"/> | |
40741 | </paramlist> | |
40742 | </constructor> | |
40743 | </class> | |
40744 | <class name="LEDNumberCtrl" oldname="wxLEDNumberCtrl" module="gizmos"> | |
40745 | <baseclass name="Control"/> | |
40746 | <constructor name="LEDNumberCtrl" overloaded="no"> | |
781d2982 | 40747 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
40748 | Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> LEDNumberCtrl</autodoc> |
40749 | <paramlist> | |
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"/> | |
40755 | </paramlist> | |
40756 | </constructor> | |
40757 | <constructor name="PreLEDNumberCtrl" overloaded="no"> | |
40758 | <autodoc>PreLEDNumberCtrl() -> LEDNumberCtrl</autodoc> | |
40759 | </constructor> | |
40760 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 40761 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
40762 | Size size=DefaultSize, long style=wxLED_ALIGN_LEFT|wxLED_DRAW_FADED) -> bool</autodoc> |
40763 | <paramlist> | |
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"/> | |
40769 | </paramlist> | |
40770 | </method> | |
40771 | <method name="GetAlignment" type="wxLEDValueAlign" overloaded="no"> | |
781d2982 | 40772 | <autodoc>GetAlignment(self) -> int</autodoc> |
f32fc4bc RD |
40773 | </method> |
40774 | <method name="GetDrawFaded" type="bool" overloaded="no"> | |
781d2982 | 40775 | <autodoc>GetDrawFaded(self) -> bool</autodoc> |
f32fc4bc RD |
40776 | </method> |
40777 | <method name="GetValue" type="String" overloaded="no"> | |
781d2982 | 40778 | <autodoc>GetValue(self) -> String</autodoc> |
f32fc4bc RD |
40779 | </method> |
40780 | <method name="SetAlignment" type="" overloaded="no"> | |
781d2982 | 40781 | <autodoc>SetAlignment(self, int Alignment, bool Redraw=true)</autodoc> |
f32fc4bc RD |
40782 | <paramlist> |
40783 | <param name="Alignment" type="wxLEDValueAlign" default=""/> | |
40784 | <param name="Redraw" type="bool" default="true"/> | |
40785 | </paramlist> | |
40786 | </method> | |
40787 | <method name="SetDrawFaded" type="" overloaded="no"> | |
781d2982 | 40788 | <autodoc>SetDrawFaded(self, bool DrawFaded, bool Redraw=true)</autodoc> |
f32fc4bc RD |
40789 | <paramlist> |
40790 | <param name="DrawFaded" type="bool" default=""/> | |
40791 | <param name="Redraw" type="bool" default="true"/> | |
40792 | </paramlist> | |
40793 | </method> | |
40794 | <method name="SetValue" type="" overloaded="no"> | |
781d2982 | 40795 | <autodoc>SetValue(self, String Value, bool Redraw=true)</autodoc> |
f32fc4bc RD |
40796 | <paramlist> |
40797 | <param name="Value" type="String" default=""/> | |
40798 | <param name="Redraw" type="bool" default="true"/> | |
40799 | </paramlist> | |
40800 | </method> | |
40801 | </class> | |
ce6878e6 | 40802 | <pythoncode> wx.TR_DONT_ADJUST_MAC = TR_DONT_ADJUST_MAC </pythoncode> |
f32fc4bc RD |
40803 | <class name="TreeListColumnInfo" oldname="wxTreeListColumnInfo" module="gizmos"> |
40804 | <baseclass name="Object"/> | |
40805 | <constructor name="TreeListColumnInfo" overloaded="no"> | |
781d2982 RD |
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> | |
f32fc4bc RD |
40808 | <paramlist> |
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"/> | |
781d2982 | 40812 | <param name="shown" type="bool" default="True"/> |
f32fc4bc RD |
40813 | <param name="alignment" type="wxTreeListColumnAlign" default="wxTL_ALIGN_LEFT"/> |
40814 | </paramlist> | |
40815 | </constructor> | |
781d2982 RD |
40816 | <method name="GetShown" type="bool" overloaded="no"> |
40817 | <autodoc>GetShown(self) -> bool</autodoc> | |
40818 | </method> | |
f32fc4bc | 40819 | <method name="GetAlignment" type="wxTreeListColumnAlign" overloaded="no"> |
781d2982 | 40820 | <autodoc>GetAlignment(self) -> int</autodoc> |
f32fc4bc RD |
40821 | </method> |
40822 | <method name="GetText" type="String" overloaded="no"> | |
781d2982 | 40823 | <autodoc>GetText(self) -> String</autodoc> |
f32fc4bc RD |
40824 | </method> |
40825 | <method name="GetImage" type="int" overloaded="no"> | |
781d2982 | 40826 | <autodoc>GetImage(self) -> int</autodoc> |
f32fc4bc RD |
40827 | </method> |
40828 | <method name="GetSelectedImage" type="int" overloaded="no"> | |
781d2982 | 40829 | <autodoc>GetSelectedImage(self) -> int</autodoc> |
f32fc4bc RD |
40830 | </method> |
40831 | <method name="GetWidth" type="size_t" overloaded="no"> | |
781d2982 RD |
40832 | <autodoc>GetWidth(self) -> size_t</autodoc> |
40833 | </method> | |
40834 | <method name="SetShown" type="" overloaded="no"> | |
40835 | <autodoc>SetShown(self, bool shown)</autodoc> | |
40836 | <paramlist> | |
40837 | <param name="shown" type="bool" default=""/> | |
40838 | </paramlist> | |
f32fc4bc RD |
40839 | </method> |
40840 | <method name="SetAlignment" type="" overloaded="no"> | |
781d2982 | 40841 | <autodoc>SetAlignment(self, int alignment)</autodoc> |
f32fc4bc RD |
40842 | <paramlist> |
40843 | <param name="alignment" type="wxTreeListColumnAlign" default=""/> | |
40844 | </paramlist> | |
40845 | </method> | |
40846 | <method name="SetText" type="" overloaded="no"> | |
781d2982 | 40847 | <autodoc>SetText(self, String text)</autodoc> |
f32fc4bc RD |
40848 | <paramlist> |
40849 | <param name="text" type="String" default=""/> | |
40850 | </paramlist> | |
40851 | </method> | |
40852 | <method name="SetImage" type="" overloaded="no"> | |
781d2982 | 40853 | <autodoc>SetImage(self, int image)</autodoc> |
f32fc4bc RD |
40854 | <paramlist> |
40855 | <param name="image" type="int" default=""/> | |
40856 | </paramlist> | |
40857 | </method> | |
40858 | <method name="SetSelectedImage" type="" overloaded="no"> | |
781d2982 | 40859 | <autodoc>SetSelectedImage(self, int image)</autodoc> |
f32fc4bc RD |
40860 | <paramlist> |
40861 | <param name="image" type="int" default=""/> | |
40862 | </paramlist> | |
40863 | </method> | |
40864 | <method name="SetWidth" type="" overloaded="no"> | |
781d2982 | 40865 | <autodoc>SetWidth(self, size_t with)</autodoc> |
f32fc4bc RD |
40866 | <paramlist> |
40867 | <param name="with" type="size_t" default=""/> | |
40868 | </paramlist> | |
40869 | </method> | |
40870 | </class> | |
40871 | <class name="TreeListCtrl" oldname="wxPyTreeListCtrl" module="gizmos"> | |
40872 | <baseclass name="Control"/> | |
40873 | <constructor name="wxPyTreeListCtrl" overloaded="no"> | |
781d2982 | 40874 | <autodoc>__init__(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
40875 | Size size=DefaultSize, long style=TR_DEFAULT_STYLE, |
40876 | Validator validator=DefaultValidator, | |
40877 | String name=TreeListCtrlNameStr) -> TreeListCtrl</autodoc> | |
40878 | <paramlist> | |
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"/> | |
40886 | </paramlist> | |
40887 | </constructor> | |
40888 | <constructor name="PreTreeListCtrl" overloaded="no"> | |
40889 | <autodoc>PreTreeListCtrl() -> TreeListCtrl</autodoc> | |
40890 | </constructor> | |
40891 | <method name="Create" type="bool" overloaded="no"> | |
781d2982 | 40892 | <autodoc>Create(self, Window parent, int id=-1, Point pos=DefaultPosition, |
f32fc4bc RD |
40893 | Size size=DefaultSize, long style=TR_DEFAULT_STYLE, |
40894 | Validator validator=DefaultValidator, | |
40895 | String name=TreeListCtrlNameStr) -> bool</autodoc> | |
c2dda882 | 40896 | <docstring>Do the 2nd phase and create the GUI control.</docstring> |
f32fc4bc RD |
40897 | <paramlist> |
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"/> | |
40905 | </paramlist> | |
40906 | </method> | |
40907 | <method name="_setCallbackInfo" type="" overloaded="no"> | |
781d2982 | 40908 | <autodoc>_setCallbackInfo(self, PyObject self, PyObject _class)</autodoc> |
f32fc4bc RD |
40909 | <paramlist> |
40910 | <param name="self" type="PyObject" default=""/> | |
40911 | <param name="_class" type="PyObject" default=""/> | |
40912 | </paramlist> | |
40913 | </method> | |
40914 | <method name="GetCount" type="size_t" overloaded="no"> | |
781d2982 | 40915 | <autodoc>GetCount(self) -> size_t</autodoc> |
f32fc4bc RD |
40916 | </method> |
40917 | <method name="GetIndent" type="unsigned int" overloaded="no"> | |
781d2982 | 40918 | <autodoc>GetIndent(self) -> unsigned int</autodoc> |
f32fc4bc RD |
40919 | </method> |
40920 | <method name="SetIndent" type="" overloaded="no"> | |
781d2982 | 40921 | <autodoc>SetIndent(self, unsigned int indent)</autodoc> |
f32fc4bc RD |
40922 | <paramlist> |
40923 | <param name="indent" type="unsigned int" default=""/> | |
40924 | </paramlist> | |
40925 | </method> | |
f32fc4bc | 40926 | <method name="GetLineSpacing" type="unsigned int" overloaded="no"> |
781d2982 | 40927 | <autodoc>GetLineSpacing(self) -> unsigned int</autodoc> |
f32fc4bc RD |
40928 | </method> |
40929 | <method name="SetLineSpacing" type="" overloaded="no"> | |
781d2982 | 40930 | <autodoc>SetLineSpacing(self, unsigned int spacing)</autodoc> |
f32fc4bc RD |
40931 | <paramlist> |
40932 | <param name="spacing" type="unsigned int" default=""/> | |
40933 | </paramlist> | |
40934 | </method> | |
40935 | <method name="GetImageList" type="ImageList" overloaded="no"> | |
781d2982 | 40936 | <autodoc>GetImageList(self) -> ImageList</autodoc> |
f32fc4bc RD |
40937 | </method> |
40938 | <method name="GetStateImageList" type="ImageList" overloaded="no"> | |
781d2982 | 40939 | <autodoc>GetStateImageList(self) -> ImageList</autodoc> |
f32fc4bc RD |
40940 | </method> |
40941 | <method name="GetButtonsImageList" type="ImageList" overloaded="no"> | |
781d2982 | 40942 | <autodoc>GetButtonsImageList(self) -> ImageList</autodoc> |
f32fc4bc RD |
40943 | </method> |
40944 | <method name="SetImageList" type="" overloaded="no"> | |
781d2982 | 40945 | <autodoc>SetImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
40946 | <paramlist> |
40947 | <param name="imageList" type="ImageList" default=""/> | |
40948 | </paramlist> | |
40949 | </method> | |
40950 | <method name="SetStateImageList" type="" overloaded="no"> | |
781d2982 | 40951 | <autodoc>SetStateImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
40952 | <paramlist> |
40953 | <param name="imageList" type="ImageList" default=""/> | |
40954 | </paramlist> | |
40955 | </method> | |
40956 | <method name="SetButtonsImageList" type="" overloaded="no"> | |
781d2982 | 40957 | <autodoc>SetButtonsImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
40958 | <paramlist> |
40959 | <param name="imageList" type="ImageList" default=""/> | |
40960 | </paramlist> | |
40961 | </method> | |
40962 | <method name="AssignImageList" type="" overloaded="no"> | |
781d2982 | 40963 | <autodoc>AssignImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
40964 | <paramlist> |
40965 | <param name="imageList" type="ImageList" default=""/> | |
40966 | </paramlist> | |
40967 | </method> | |
40968 | <method name="AssignStateImageList" type="" overloaded="no"> | |
781d2982 | 40969 | <autodoc>AssignStateImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
40970 | <paramlist> |
40971 | <param name="imageList" type="ImageList" default=""/> | |
40972 | </paramlist> | |
40973 | </method> | |
40974 | <method name="AssignButtonsImageList" type="" overloaded="no"> | |
781d2982 | 40975 | <autodoc>AssignButtonsImageList(self, ImageList imageList)</autodoc> |
f32fc4bc RD |
40976 | <paramlist> |
40977 | <param name="imageList" type="ImageList" default=""/> | |
40978 | </paramlist> | |
40979 | </method> | |
40980 | <method name="AddColumn" type="" overloaded="no"> | |
781d2982 | 40981 | <autodoc>AddColumn(self, String text)</autodoc> |
f32fc4bc RD |
40982 | <paramlist> |
40983 | <param name="text" type="String" default=""/> | |
40984 | </paramlist> | |
40985 | </method> | |
40986 | <method name="AddColumnInfo" type="" overloaded="no"> | |
781d2982 | 40987 | <autodoc>AddColumnInfo(self, TreeListColumnInfo col)</autodoc> |
f32fc4bc RD |
40988 | <paramlist> |
40989 | <param name="col" type="TreeListColumnInfo" default=""/> | |
40990 | </paramlist> | |
40991 | </method> | |
40992 | <method name="InsertColumn" type="" overloaded="no"> | |
781d2982 | 40993 | <autodoc>InsertColumn(self, size_t before, String text)</autodoc> |
f32fc4bc RD |
40994 | <paramlist> |
40995 | <param name="before" type="size_t" default=""/> | |
40996 | <param name="text" type="String" default=""/> | |
40997 | </paramlist> | |
40998 | </method> | |
40999 | <method name="InsertColumnInfo" type="" overloaded="no"> | |
781d2982 | 41000 | <autodoc>InsertColumnInfo(self, size_t before, TreeListColumnInfo col)</autodoc> |
f32fc4bc RD |
41001 | <paramlist> |
41002 | <param name="before" type="size_t" default=""/> | |
41003 | <param name="col" type="TreeListColumnInfo" default=""/> | |
41004 | </paramlist> | |
41005 | </method> | |
41006 | <method name="RemoveColumn" type="" overloaded="no"> | |
781d2982 | 41007 | <autodoc>RemoveColumn(self, size_t column)</autodoc> |
f32fc4bc RD |
41008 | <paramlist> |
41009 | <param name="column" type="size_t" default=""/> | |
41010 | </paramlist> | |
41011 | </method> | |
41012 | <method name="GetColumnCount" type="size_t" overloaded="no"> | |
781d2982 | 41013 | <autodoc>GetColumnCount(self) -> size_t</autodoc> |
f32fc4bc RD |
41014 | </method> |
41015 | <method name="SetColumnWidth" type="" overloaded="no"> | |
781d2982 | 41016 | <autodoc>SetColumnWidth(self, size_t column, size_t width)</autodoc> |
f32fc4bc RD |
41017 | <paramlist> |
41018 | <param name="column" type="size_t" default=""/> | |
41019 | <param name="width" type="size_t" default=""/> | |
41020 | </paramlist> | |
41021 | </method> | |
41022 | <method name="GetColumnWidth" type="int" overloaded="no"> | |
781d2982 | 41023 | <autodoc>GetColumnWidth(self, size_t column) -> int</autodoc> |
f32fc4bc RD |
41024 | <paramlist> |
41025 | <param name="column" type="size_t" default=""/> | |
41026 | </paramlist> | |
41027 | </method> | |
41028 | <method name="SetMainColumn" type="" overloaded="no"> | |
781d2982 | 41029 | <autodoc>SetMainColumn(self, size_t column)</autodoc> |
f32fc4bc RD |
41030 | <paramlist> |
41031 | <param name="column" type="size_t" default=""/> | |
41032 | </paramlist> | |
41033 | </method> | |
41034 | <method name="GetMainColumn" type="size_t" overloaded="no"> | |
781d2982 | 41035 | <autodoc>GetMainColumn(self) -> size_t</autodoc> |
f32fc4bc RD |
41036 | </method> |
41037 | <method name="SetColumnText" type="" overloaded="no"> | |
781d2982 | 41038 | <autodoc>SetColumnText(self, size_t column, String text)</autodoc> |
f32fc4bc RD |
41039 | <paramlist> |
41040 | <param name="column" type="size_t" default=""/> | |
41041 | <param name="text" type="String" default=""/> | |
41042 | </paramlist> | |
41043 | </method> | |
41044 | <method name="GetColumnText" type="String" overloaded="no"> | |
781d2982 | 41045 | <autodoc>GetColumnText(self, size_t column) -> String</autodoc> |
f32fc4bc RD |
41046 | <paramlist> |
41047 | <param name="column" type="size_t" default=""/> | |
41048 | </paramlist> | |
41049 | </method> | |
41050 | <method name="SetColumn" type="" overloaded="no"> | |
781d2982 | 41051 | <autodoc>SetColumn(self, size_t column, TreeListColumnInfo info)</autodoc> |
f32fc4bc RD |
41052 | <paramlist> |
41053 | <param name="column" type="size_t" default=""/> | |
41054 | <param name="info" type="TreeListColumnInfo" default=""/> | |
41055 | </paramlist> | |
41056 | </method> | |
41057 | <method name="GetColumn" type="TreeListColumnInfo" overloaded="no"> | |
781d2982 | 41058 | <autodoc>GetColumn(self, size_t column) -> TreeListColumnInfo</autodoc> |
f32fc4bc RD |
41059 | <paramlist> |
41060 | <param name="column" type="size_t" default=""/> | |
41061 | </paramlist> | |
41062 | </method> | |
41063 | <method name="SetColumnAlignment" type="" overloaded="no"> | |
781d2982 | 41064 | <autodoc>SetColumnAlignment(self, size_t column, int align)</autodoc> |
f32fc4bc RD |
41065 | <paramlist> |
41066 | <param name="column" type="size_t" default=""/> | |
41067 | <param name="align" type="wxTreeListColumnAlign" default=""/> | |
41068 | </paramlist> | |
41069 | </method> | |
41070 | <method name="GetColumnAlignment" type="wxTreeListColumnAlign" overloaded="no"> | |
781d2982 | 41071 | <autodoc>GetColumnAlignment(self, size_t column) -> int</autodoc> |
f32fc4bc RD |
41072 | <paramlist> |
41073 | <param name="column" type="size_t" default=""/> | |
41074 | </paramlist> | |
41075 | </method> | |
41076 | <method name="SetColumnImage" type="" overloaded="no"> | |
781d2982 | 41077 | <autodoc>SetColumnImage(self, size_t column, int image)</autodoc> |
f32fc4bc RD |
41078 | <paramlist> |
41079 | <param name="column" type="size_t" default=""/> | |
41080 | <param name="image" type="int" default=""/> | |
41081 | </paramlist> | |
41082 | </method> | |
41083 | <method name="GetColumnImage" type="int" overloaded="no"> | |
781d2982 RD |
41084 | <autodoc>GetColumnImage(self, size_t column) -> int</autodoc> |
41085 | <paramlist> | |
41086 | <param name="column" type="size_t" default=""/> | |
41087 | </paramlist> | |
41088 | </method> | |
41089 | <method name="ShowColumn" type="" overloaded="no"> | |
41090 | <autodoc>ShowColumn(self, size_t column, bool shown)</autodoc> | |
41091 | <paramlist> | |
41092 | <param name="column" type="size_t" default=""/> | |
41093 | <param name="shown" type="bool" default=""/> | |
41094 | </paramlist> | |
41095 | </method> | |
41096 | <method name="IsColumnShown" type="bool" overloaded="no"> | |
41097 | <autodoc>IsColumnShown(self, size_t column) -> bool</autodoc> | |
f32fc4bc RD |
41098 | <paramlist> |
41099 | <param name="column" type="size_t" default=""/> | |
41100 | </paramlist> | |
41101 | </method> | |
41102 | <method name="GetItemText" type="String" overloaded="no"> | |
781d2982 | 41103 | <autodoc>GetItemText(self, TreeItemId item, int column=-1) -> String</autodoc> |
f32fc4bc RD |
41104 | <paramlist> |
41105 | <param name="item" type="TreeItemId" default=""/> | |
41106 | <param name="column" type="int" default="-1"/> | |
41107 | </paramlist> | |
41108 | </method> | |
41109 | <method name="GetItemImage" type="int" overloaded="no"> | |
781d2982 | 41110 | <autodoc>GetItemImage(self, TreeItemId item, int column=-1, int which=TreeItemIcon_Normal) -> int</autodoc> |
f32fc4bc RD |
41111 | <paramlist> |
41112 | <param name="item" type="TreeItemId" default=""/> | |
41113 | <param name="column" type="int" default="-1"/> | |
41114 | <param name="which" type="wxTreeItemIcon" default="wxTreeItemIcon_Normal"/> | |
41115 | </paramlist> | |
41116 | </method> | |
41117 | <method name="SetItemText" type="" overloaded="no"> | |
781d2982 | 41118 | <autodoc>SetItemText(self, TreeItemId item, String text, int column=-1)</autodoc> |
f32fc4bc RD |
41119 | <paramlist> |
41120 | <param name="item" type="TreeItemId" default=""/> | |
41121 | <param name="text" type="String" default=""/> | |
41122 | <param name="column" type="int" default="-1"/> | |
41123 | </paramlist> | |
41124 | </method> | |
41125 | <method name="SetItemImage" type="" overloaded="no"> | |
781d2982 | 41126 | <autodoc>SetItemImage(self, TreeItemId item, int image, int column=-1, int which=TreeItemIcon_Normal)</autodoc> |
f32fc4bc RD |
41127 | <paramlist> |
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"/> | |
41132 | </paramlist> | |
41133 | </method> | |
41134 | <method name="GetItemData" type="TreeItemData" overloaded="no"> | |
781d2982 | 41135 | <autodoc>GetItemData(self, TreeItemId item) -> TreeItemData</autodoc> |
f32fc4bc RD |
41136 | <paramlist> |
41137 | <param name="item" type="TreeItemId" default=""/> | |
41138 | </paramlist> | |
41139 | </method> | |
41140 | <method name="SetItemData" type="" overloaded="no"> | |
781d2982 | 41141 | <autodoc>SetItemData(self, TreeItemId item, TreeItemData data)</autodoc> |
f32fc4bc RD |
41142 | <paramlist> |
41143 | <param name="item" type="TreeItemId" default=""/> | |
41144 | <param name="data" type="TreeItemData" default=""/> | |
41145 | </paramlist> | |
41146 | </method> | |
41147 | <method name="GetItemPyData" type="PyObject" overloaded="no"> | |
781d2982 | 41148 | <autodoc>GetItemPyData(self, TreeItemId item) -> PyObject</autodoc> |
f32fc4bc RD |
41149 | <paramlist> |
41150 | <param name="item" type="TreeItemId" default=""/> | |
41151 | </paramlist> | |
41152 | </method> | |
41153 | <method name="SetItemPyData" type="" overloaded="no"> | |
781d2982 | 41154 | <autodoc>SetItemPyData(self, TreeItemId item, PyObject obj)</autodoc> |
f32fc4bc RD |
41155 | <paramlist> |
41156 | <param name="item" type="TreeItemId" default=""/> | |
41157 | <param name="obj" type="PyObject" default=""/> | |
41158 | </paramlist> | |
41159 | </method> | |
41160 | <method name="SetItemHasChildren" type="" overloaded="no"> | |
781d2982 | 41161 | <autodoc>SetItemHasChildren(self, TreeItemId item, bool has=True)</autodoc> |
f32fc4bc RD |
41162 | <paramlist> |
41163 | <param name="item" type="TreeItemId" default=""/> | |
41164 | <param name="has" type="bool" default="True"/> | |
41165 | </paramlist> | |
41166 | </method> | |
41167 | <method name="SetItemBold" type="" overloaded="no"> | |
781d2982 | 41168 | <autodoc>SetItemBold(self, TreeItemId item, bool bold=True)</autodoc> |
f32fc4bc RD |
41169 | <paramlist> |
41170 | <param name="item" type="TreeItemId" default=""/> | |
41171 | <param name="bold" type="bool" default="True"/> | |
41172 | </paramlist> | |
41173 | </method> | |
41174 | <method name="SetItemTextColour" type="" overloaded="no"> | |
781d2982 | 41175 | <autodoc>SetItemTextColour(self, TreeItemId item, Colour colour)</autodoc> |
f32fc4bc RD |
41176 | <paramlist> |
41177 | <param name="item" type="TreeItemId" default=""/> | |
781d2982 | 41178 | <param name="colour" type="Colour" default=""/> |
f32fc4bc RD |
41179 | </paramlist> |
41180 | </method> | |
41181 | <method name="SetItemBackgroundColour" type="" overloaded="no"> | |
781d2982 | 41182 | <autodoc>SetItemBackgroundColour(self, TreeItemId item, Colour colour)</autodoc> |
f32fc4bc RD |
41183 | <paramlist> |
41184 | <param name="item" type="TreeItemId" default=""/> | |
781d2982 | 41185 | <param name="colour" type="Colour" default=""/> |
f32fc4bc RD |
41186 | </paramlist> |
41187 | </method> | |
41188 | <method name="SetItemFont" type="" overloaded="no"> | |
781d2982 | 41189 | <autodoc>SetItemFont(self, TreeItemId item, Font font)</autodoc> |
f32fc4bc RD |
41190 | <paramlist> |
41191 | <param name="item" type="TreeItemId" default=""/> | |
41192 | <param name="font" type="Font" default=""/> | |
41193 | </paramlist> | |
41194 | </method> | |
41195 | <method name="GetItemBold" type="bool" overloaded="no"> | |
781d2982 | 41196 | <autodoc>GetItemBold(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
41197 | <paramlist> |
41198 | <param name="item" type="TreeItemId" default=""/> | |
41199 | </paramlist> | |
41200 | </method> | |
41201 | <method name="GetItemTextColour" type="Colour" overloaded="no"> | |
781d2982 | 41202 | <autodoc>GetItemTextColour(self, TreeItemId item) -> Colour</autodoc> |
f32fc4bc RD |
41203 | <paramlist> |
41204 | <param name="item" type="TreeItemId" default=""/> | |
41205 | </paramlist> | |
41206 | </method> | |
41207 | <method name="GetItemBackgroundColour" type="Colour" overloaded="no"> | |
781d2982 | 41208 | <autodoc>GetItemBackgroundColour(self, TreeItemId item) -> Colour</autodoc> |
f32fc4bc RD |
41209 | <paramlist> |
41210 | <param name="item" type="TreeItemId" default=""/> | |
41211 | </paramlist> | |
41212 | </method> | |
41213 | <method name="GetItemFont" type="Font" overloaded="no"> | |
781d2982 | 41214 | <autodoc>GetItemFont(self, TreeItemId item) -> Font</autodoc> |
f32fc4bc RD |
41215 | <paramlist> |
41216 | <param name="item" type="TreeItemId" default=""/> | |
41217 | </paramlist> | |
41218 | </method> | |
41219 | <method name="IsVisible" type="bool" overloaded="no"> | |
781d2982 | 41220 | <autodoc>IsVisible(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
41221 | <paramlist> |
41222 | <param name="item" type="TreeItemId" default=""/> | |
41223 | </paramlist> | |
41224 | </method> | |
41225 | <method name="ItemHasChildren" type="bool" overloaded="no"> | |
781d2982 | 41226 | <autodoc>ItemHasChildren(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
41227 | <paramlist> |
41228 | <param name="item" type="TreeItemId" default=""/> | |
41229 | </paramlist> | |
41230 | </method> | |
41231 | <method name="IsExpanded" type="bool" overloaded="no"> | |
781d2982 | 41232 | <autodoc>IsExpanded(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
41233 | <paramlist> |
41234 | <param name="item" type="TreeItemId" default=""/> | |
41235 | </paramlist> | |
41236 | </method> | |
41237 | <method name="IsSelected" type="bool" overloaded="no"> | |
781d2982 | 41238 | <autodoc>IsSelected(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
41239 | <paramlist> |
41240 | <param name="item" type="TreeItemId" default=""/> | |
41241 | </paramlist> | |
41242 | </method> | |
41243 | <method name="IsBold" type="bool" overloaded="no"> | |
781d2982 | 41244 | <autodoc>IsBold(self, TreeItemId item) -> bool</autodoc> |
f32fc4bc RD |
41245 | <paramlist> |
41246 | <param name="item" type="TreeItemId" default=""/> | |
41247 | </paramlist> | |
41248 | </method> | |
41249 | <method name="GetChildrenCount" type="size_t" overloaded="no"> | |
781d2982 | 41250 | <autodoc>GetChildrenCount(self, TreeItemId item, bool recursively=True) -> size_t</autodoc> |
f32fc4bc RD |
41251 | <paramlist> |
41252 | <param name="item" type="TreeItemId" default=""/> | |
41253 | <param name="recursively" type="bool" default="True"/> | |
41254 | </paramlist> | |
41255 | </method> | |
41256 | <method name="GetRootItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 41257 | <autodoc>GetRootItem(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
41258 | </method> |
41259 | <method name="GetSelection" type="TreeItemId" overloaded="no"> | |
781d2982 | 41260 | <autodoc>GetSelection(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
41261 | </method> |
41262 | <method name="GetSelections" type="PyObject" overloaded="no"> | |
781d2982 | 41263 | <autodoc>GetSelections(self) -> PyObject</autodoc> |
f32fc4bc RD |
41264 | </method> |
41265 | <method name="GetItemParent" type="TreeItemId" overloaded="no"> | |
781d2982 | 41266 | <autodoc>GetItemParent(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
41267 | <paramlist> |
41268 | <param name="item" type="TreeItemId" default=""/> | |
41269 | </paramlist> | |
41270 | </method> | |
41271 | <method name="GetFirstChild" type="PyObject" overloaded="no"> | |
781d2982 | 41272 | <autodoc>GetFirstChild(self, TreeItemId item) -> PyObject</autodoc> |
f32fc4bc RD |
41273 | <paramlist> |
41274 | <param name="item" type="TreeItemId" default=""/> | |
41275 | </paramlist> | |
41276 | </method> | |
41277 | <method name="GetNextChild" type="PyObject" overloaded="no"> | |
781d2982 | 41278 | <autodoc>GetNextChild(self, TreeItemId item, void cookie) -> PyObject</autodoc> |
f32fc4bc RD |
41279 | <paramlist> |
41280 | <param name="item" type="TreeItemId" default=""/> | |
781d2982 | 41281 | <param name="cookie" type="" default=""/> |
f32fc4bc RD |
41282 | </paramlist> |
41283 | </method> | |
41284 | <method name="GetLastChild" type="TreeItemId" overloaded="no"> | |
781d2982 | 41285 | <autodoc>GetLastChild(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
41286 | <paramlist> |
41287 | <param name="item" type="TreeItemId" default=""/> | |
41288 | </paramlist> | |
41289 | </method> | |
41290 | <method name="GetNextSibling" type="TreeItemId" overloaded="no"> | |
781d2982 | 41291 | <autodoc>GetNextSibling(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
41292 | <paramlist> |
41293 | <param name="item" type="TreeItemId" default=""/> | |
41294 | </paramlist> | |
41295 | </method> | |
41296 | <method name="GetPrevSibling" type="TreeItemId" overloaded="no"> | |
781d2982 | 41297 | <autodoc>GetPrevSibling(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
41298 | <paramlist> |
41299 | <param name="item" type="TreeItemId" default=""/> | |
41300 | </paramlist> | |
41301 | </method> | |
41302 | <method name="GetFirstVisibleItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 41303 | <autodoc>GetFirstVisibleItem(self) -> TreeItemId</autodoc> |
f32fc4bc RD |
41304 | </method> |
41305 | <method name="GetNextVisible" type="TreeItemId" overloaded="no"> | |
781d2982 | 41306 | <autodoc>GetNextVisible(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
41307 | <paramlist> |
41308 | <param name="item" type="TreeItemId" default=""/> | |
41309 | </paramlist> | |
41310 | </method> | |
41311 | <method name="GetPrevVisible" type="TreeItemId" overloaded="no"> | |
781d2982 | 41312 | <autodoc>GetPrevVisible(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
41313 | <paramlist> |
41314 | <param name="item" type="TreeItemId" default=""/> | |
41315 | </paramlist> | |
41316 | </method> | |
41317 | <method name="GetNext" type="TreeItemId" overloaded="no"> | |
781d2982 | 41318 | <autodoc>GetNext(self, TreeItemId item) -> TreeItemId</autodoc> |
f32fc4bc RD |
41319 | <paramlist> |
41320 | <param name="item" type="TreeItemId" default=""/> | |
41321 | </paramlist> | |
41322 | </method> | |
41323 | <method name="AddRoot" type="TreeItemId" overloaded="no"> | |
781d2982 | 41324 | <autodoc>AddRoot(self, String text, int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc> |
f32fc4bc RD |
41325 | <paramlist> |
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"/> | |
41330 | </paramlist> | |
41331 | </method> | |
41332 | <method name="PrependItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 41333 | <autodoc>PrependItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, |
0f43fbdf | 41334 | TreeItemData data=None) -> TreeItemId</autodoc> |
f32fc4bc RD |
41335 | <paramlist> |
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"/> | |
41341 | </paramlist> | |
41342 | </method> | |
41343 | <method name="InsertItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 41344 | <autodoc>InsertItem(self, TreeItemId parent, TreeItemId idPrevious, String text, |
0f43fbdf | 41345 | int image=-1, int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc> |
f32fc4bc RD |
41346 | <paramlist> |
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"/> | |
41353 | </paramlist> | |
41354 | </method> | |
41355 | <method name="InsertItemBefore" type="TreeItemId" overloaded="no"> | |
781d2982 | 41356 | <autodoc>InsertItemBefore(self, TreeItemId parent, size_t index, String text, int image=-1, |
0f43fbdf | 41357 | int selectedImage=-1, TreeItemData data=None) -> TreeItemId</autodoc> |
f32fc4bc RD |
41358 | <paramlist> |
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"/> | |
41365 | </paramlist> | |
41366 | </method> | |
41367 | <method name="AppendItem" type="TreeItemId" overloaded="no"> | |
781d2982 | 41368 | <autodoc>AppendItem(self, TreeItemId parent, String text, int image=-1, int selectedImage=-1, |
0f43fbdf | 41369 | TreeItemData data=None) -> TreeItemId</autodoc> |
f32fc4bc RD |
41370 | <paramlist> |
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"/> | |
41376 | </paramlist> | |
41377 | </method> | |
41378 | <method name="Delete" type="" overloaded="no"> | |
781d2982 | 41379 | <autodoc>Delete(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41380 | <paramlist> |
41381 | <param name="item" type="TreeItemId" default=""/> | |
41382 | </paramlist> | |
41383 | </method> | |
41384 | <method name="DeleteChildren" type="" overloaded="no"> | |
781d2982 | 41385 | <autodoc>DeleteChildren(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41386 | <paramlist> |
41387 | <param name="item" type="TreeItemId" default=""/> | |
41388 | </paramlist> | |
41389 | </method> | |
41390 | <method name="DeleteAllItems" type="" overloaded="no"> | |
781d2982 | 41391 | <autodoc>DeleteAllItems(self)</autodoc> |
f32fc4bc RD |
41392 | </method> |
41393 | <method name="Expand" type="" overloaded="no"> | |
781d2982 | 41394 | <autodoc>Expand(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41395 | <paramlist> |
41396 | <param name="item" type="TreeItemId" default=""/> | |
41397 | </paramlist> | |
41398 | </method> | |
41399 | <method name="ExpandAll" type="" overloaded="no"> | |
781d2982 | 41400 | <autodoc>ExpandAll(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41401 | <paramlist> |
41402 | <param name="item" type="TreeItemId" default=""/> | |
41403 | </paramlist> | |
41404 | </method> | |
41405 | <method name="Collapse" type="" overloaded="no"> | |
781d2982 | 41406 | <autodoc>Collapse(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41407 | <paramlist> |
41408 | <param name="item" type="TreeItemId" default=""/> | |
41409 | </paramlist> | |
41410 | </method> | |
41411 | <method name="CollapseAndReset" type="" overloaded="no"> | |
781d2982 | 41412 | <autodoc>CollapseAndReset(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41413 | <paramlist> |
41414 | <param name="item" type="TreeItemId" default=""/> | |
41415 | </paramlist> | |
41416 | </method> | |
41417 | <method name="Toggle" type="" overloaded="no"> | |
781d2982 | 41418 | <autodoc>Toggle(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41419 | <paramlist> |
41420 | <param name="item" type="TreeItemId" default=""/> | |
41421 | </paramlist> | |
41422 | </method> | |
41423 | <method name="Unselect" type="" overloaded="no"> | |
781d2982 | 41424 | <autodoc>Unselect(self)</autodoc> |
f32fc4bc RD |
41425 | </method> |
41426 | <method name="UnselectAll" type="" overloaded="no"> | |
781d2982 | 41427 | <autodoc>UnselectAll(self)</autodoc> |
f32fc4bc RD |
41428 | </method> |
41429 | <method name="SelectItem" type="" overloaded="no"> | |
781d2982 | 41430 | <autodoc>SelectItem(self, TreeItemId item, bool unselect_others=True, bool extended_select=False)</autodoc> |
f32fc4bc RD |
41431 | <paramlist> |
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"/> | |
41435 | </paramlist> | |
41436 | </method> | |
781d2982 RD |
41437 | <method name="SelectAll" type="" overloaded="no"> |
41438 | <autodoc>SelectAll(self, bool extended_select=False)</autodoc> | |
41439 | <paramlist> | |
41440 | <param name="extended_select" type="bool" default="False"/> | |
41441 | </paramlist> | |
41442 | </method> | |
f32fc4bc | 41443 | <method name="EnsureVisible" type="" overloaded="no"> |
781d2982 | 41444 | <autodoc>EnsureVisible(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41445 | <paramlist> |
41446 | <param name="item" type="TreeItemId" default=""/> | |
41447 | </paramlist> | |
41448 | </method> | |
41449 | <method name="ScrollTo" type="" overloaded="no"> | |
781d2982 | 41450 | <autodoc>ScrollTo(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41451 | <paramlist> |
41452 | <param name="item" type="TreeItemId" default=""/> | |
41453 | </paramlist> | |
41454 | </method> | |
41455 | <method name="HitTest" type="TreeItemId" overloaded="no"> | |
781d2982 | 41456 | <autodoc>HitTest(self, Point point, int OUTPUT, int OUTPUT) -> TreeItemId</autodoc> |
f32fc4bc RD |
41457 | <paramlist> |
41458 | <param name="point" type="Point" default=""/> | |
41459 | <param name="OUTPUT" type="int" default=""/> | |
41460 | <param name="OUTPUT" type="int" default=""/> | |
41461 | </paramlist> | |
41462 | </method> | |
41463 | <method name="GetBoundingRect" type="PyObject" overloaded="no"> | |
781d2982 | 41464 | <autodoc>GetBoundingRect(self, TreeItemId item, bool textOnly=False) -> PyObject</autodoc> |
f32fc4bc RD |
41465 | <paramlist> |
41466 | <param name="item" type="TreeItemId" default=""/> | |
41467 | <param name="textOnly" type="bool" default="False"/> | |
41468 | </paramlist> | |
41469 | </method> | |
41470 | <method name="EditLabel" type="" overloaded="no"> | |
781d2982 | 41471 | <autodoc>EditLabel(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41472 | <paramlist> |
41473 | <param name="item" type="TreeItemId" default=""/> | |
41474 | </paramlist> | |
41475 | </method> | |
41476 | <method name="Edit" type="" overloaded="no"> | |
781d2982 | 41477 | <autodoc>Edit(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41478 | <paramlist> |
41479 | <param name="item" type="TreeItemId" default=""/> | |
41480 | </paramlist> | |
41481 | </method> | |
41482 | <method name="SortChildren" type="" overloaded="no"> | |
781d2982 | 41483 | <autodoc>SortChildren(self, TreeItemId item)</autodoc> |
f32fc4bc RD |
41484 | <paramlist> |
41485 | <param name="item" type="TreeItemId" default=""/> | |
41486 | </paramlist> | |
41487 | </method> | |
781d2982 RD |
41488 | <method name="FindItem" type="TreeItemId" overloaded="no"> |
41489 | <autodoc>FindItem(self, TreeItemId item, String str, int flags=0) -> TreeItemId</autodoc> | |
f32fc4bc RD |
41490 | <paramlist> |
41491 | <param name="item" type="TreeItemId" default=""/> | |
781d2982 RD |
41492 | <param name="str" type="String" default=""/> |
41493 | <param name="flags" type="int" default="0"/> | |
f32fc4bc RD |
41494 | </paramlist> |
41495 | </method> | |
41496 | <method name="GetHeaderWindow" type="Window" overloaded="no"> | |
781d2982 | 41497 | <autodoc>GetHeaderWindow(self) -> Window</autodoc> |
f32fc4bc | 41498 | </method> |
ce6878e6 RD |
41499 | <method name="GetMainWindow" type="ScrolledWindow" overloaded="no"> |
41500 | <autodoc>GetMainWindow(self) -> ScrolledWindow</autodoc> | |
f32fc4bc RD |
41501 | </method> |
41502 | </class> | |
41503 | </module> | |
0dd25e81 | 41504 | </wxPython-metadata> |