]>
Commit | Line | Data |
---|---|---|
1 | """Decorator classes for documentation and shell scripting. | |
2 | """ | |
3 | ||
4 | __author__ = "Patrick K. O'Brien <pobrien@orbtech.com>" | |
5 | __cvsid__ = "$Id$" | |
6 | __revision__ = "$Revision$"[11:-2] | |
7 | ||
8 | ||
9 | # These are not the real wxPython classes. These are Python versions | |
10 | # for documentation purposes. They are also used to apply docstrings | |
11 | # to the real wxPython classes, which are SWIG-generated wrappers for | |
12 | # C-language classes. | |
13 | ||
14 | ||
15 | from Base import EvtHandler | |
16 | import Parameters as wx | |
17 | ||
18 | try: | |
19 | True | |
20 | except NameError: | |
21 | True = 1==1 | |
22 | False = 1==0 | |
23 | ||
24 | ||
25 | class Window(EvtHandler): | |
26 | """""" | |
27 | ||
28 | def __init__(self, parent, id, pos=wx.DefaultPosition, | |
29 | size=wx.DefaultSize, style=0, name=wx.PyPanelNameStr): | |
30 | """""" | |
31 | pass | |
32 | ||
33 | def AcceptsFocus(self): | |
34 | """""" | |
35 | pass | |
36 | ||
37 | def AddChild(self, child): | |
38 | """""" | |
39 | pass | |
40 | ||
41 | def CaptureMouse(self): | |
42 | """""" | |
43 | pass | |
44 | ||
45 | def Center(self, direction=wx.BOTH): | |
46 | """""" | |
47 | pass | |
48 | ||
49 | def CenterOnParent(self, direction=wx.BOTH): | |
50 | """""" | |
51 | pass | |
52 | ||
53 | def CenterOnScreen(self, direction=wx.BOTH): | |
54 | """""" | |
55 | pass | |
56 | ||
57 | def Centre(self, direction=wx.BOTH): | |
58 | """""" | |
59 | pass | |
60 | ||
61 | def CentreOnParent(self, direction=wx.BOTH): | |
62 | """""" | |
63 | pass | |
64 | ||
65 | def CentreOnScreen(self, direction=wx.BOTH): | |
66 | """""" | |
67 | pass | |
68 | ||
69 | def Clear(self): | |
70 | """""" | |
71 | pass | |
72 | ||
73 | def ClientToScreen(self, pt): | |
74 | """""" | |
75 | pass | |
76 | ||
77 | def ClientToScreenXY(self, x, y): | |
78 | """""" | |
79 | pass | |
80 | ||
81 | def Close(self, force=False): | |
82 | """""" | |
83 | pass | |
84 | ||
85 | def ConvertDialogPointToPixels(self, pt): | |
86 | """""" | |
87 | pass | |
88 | ||
89 | def ConvertDialogSizeToPixels(self, sz): | |
90 | """""" | |
91 | pass | |
92 | ||
93 | def ConvertPixelPointToDialog(self, pt): | |
94 | """""" | |
95 | pass | |
96 | ||
97 | def ConvertPixelSizeToDialog(self, sz): | |
98 | """""" | |
99 | pass | |
100 | ||
101 | def Create(self, parent, id, pos=wx.DefaultPosition, | |
102 | size=wx.DefaultSize, style=0, name=wx.PyPanelNameStr): | |
103 | """""" | |
104 | pass | |
105 | ||
106 | def DLG_PNT(self, win, point_or_x, y=None): | |
107 | """""" | |
108 | pass | |
109 | ||
110 | def DLG_SZE(self, win, size_width, height=None): | |
111 | """""" | |
112 | pass | |
113 | ||
114 | def Destroy(self): | |
115 | """""" | |
116 | pass | |
117 | ||
118 | def DestroyChildren(self): | |
119 | """""" | |
120 | pass | |
121 | ||
122 | def DragAcceptFiles(self, accept): | |
123 | """Windows only.""" | |
124 | pass | |
125 | ||
126 | def Enable(self, enable): | |
127 | """""" | |
128 | pass | |
129 | ||
130 | def FindWindowById(self, id): | |
131 | """""" | |
132 | pass | |
133 | ||
134 | def FindWindowByName(self, name): | |
135 | """""" | |
136 | pass | |
137 | ||
138 | def Fit(self): | |
139 | """""" | |
140 | pass | |
141 | ||
142 | def FitInside(self): | |
143 | """""" | |
144 | pass | |
145 | ||
146 | def Freeze(self): | |
147 | """""" | |
148 | pass | |
149 | ||
150 | def GetAcceleratorTable(self): | |
151 | """""" | |
152 | pass | |
153 | ||
154 | def GetAdjustedBestSize(self): | |
155 | """""" | |
156 | pass | |
157 | ||
158 | def GetAutoLayout(self): | |
159 | """""" | |
160 | pass | |
161 | ||
162 | def GetBackgroundColour(self): | |
163 | """""" | |
164 | pass | |
165 | ||
166 | def GetBestSize(self): | |
167 | """""" | |
168 | pass | |
169 | ||
170 | def GetBestVirtualSize(self): | |
171 | """""" | |
172 | pass | |
173 | ||
174 | def GetBorder(self): | |
175 | """""" | |
176 | pass | |
177 | ||
178 | def GetCaret(self): | |
179 | """""" | |
180 | pass | |
181 | ||
182 | def GetCharHeight(self): | |
183 | """""" | |
184 | pass | |
185 | ||
186 | def GetCharWidth(self): | |
187 | """""" | |
188 | pass | |
189 | ||
190 | def GetChildren(self): | |
191 | """""" | |
192 | pass | |
193 | ||
194 | def GetClientAreaOrigin(self): | |
195 | """""" | |
196 | pass | |
197 | ||
198 | def GetClientRect(self): | |
199 | """""" | |
200 | pass | |
201 | ||
202 | def GetClientSize(self): | |
203 | """""" | |
204 | pass | |
205 | ||
206 | def GetClientSizeTuple(self): | |
207 | """""" | |
208 | pass | |
209 | ||
210 | def GetConstraints(self): | |
211 | """""" | |
212 | pass | |
213 | ||
214 | def GetContainingSizer(self): | |
215 | """""" | |
216 | pass | |
217 | ||
218 | def GetCursor(self): | |
219 | """""" | |
220 | pass | |
221 | ||
222 | def GetDefaultItem(self): | |
223 | """""" | |
224 | pass | |
225 | ||
226 | def GetDropTarget(self): | |
227 | """""" | |
228 | pass | |
229 | ||
230 | def GetEventHandler(self): | |
231 | """""" | |
232 | pass | |
233 | ||
234 | def GetFont(self): | |
235 | """""" | |
236 | pass | |
237 | ||
238 | def GetForegroundColour(self): | |
239 | """""" | |
240 | pass | |
241 | ||
242 | def GetFullTextExtent(self): | |
243 | """""" | |
244 | pass | |
245 | ||
246 | def GetGrandParent(self): | |
247 | """""" | |
248 | pass | |
249 | ||
250 | def GetHandle(self): | |
251 | """""" | |
252 | pass | |
253 | ||
254 | def GetHelpText(self): | |
255 | """""" | |
256 | pass | |
257 | ||
258 | def GetId(self): | |
259 | """""" | |
260 | pass | |
261 | ||
262 | def GetLabel(self): | |
263 | """""" | |
264 | pass | |
265 | ||
266 | def GetMaxSize(self): | |
267 | """""" | |
268 | pass | |
269 | ||
270 | def GetName(self): | |
271 | """""" | |
272 | pass | |
273 | ||
274 | def GetParent(self): | |
275 | """""" | |
276 | pass | |
277 | ||
278 | def GetPosition(self): | |
279 | """""" | |
280 | pass | |
281 | ||
282 | def GetPositionTuple(self): | |
283 | """""" | |
284 | pass | |
285 | ||
286 | def GetRect(self): | |
287 | """""" | |
288 | pass | |
289 | ||
290 | def GetScrollPos(self, orientation): | |
291 | """""" | |
292 | pass | |
293 | ||
294 | def GetScrollRange(self, orientation): | |
295 | """""" | |
296 | pass | |
297 | ||
298 | def GetScrollThumb(self, orientation): | |
299 | """""" | |
300 | pass | |
301 | ||
302 | def GetSize(self): | |
303 | """""" | |
304 | pass | |
305 | ||
306 | def GetSizeTuple(self): | |
307 | """""" | |
308 | pass | |
309 | ||
310 | def GetSizer(self): | |
311 | """""" | |
312 | pass | |
313 | ||
314 | def GetTextExtent(self, string): | |
315 | """""" | |
316 | pass | |
317 | ||
318 | def GetTitle(self): | |
319 | """""" | |
320 | pass | |
321 | ||
322 | def GetToolTip(self): | |
323 | """""" | |
324 | pass | |
325 | ||
326 | def GetUpdateRegion(self): | |
327 | """""" | |
328 | pass | |
329 | ||
330 | def GetValidator(self): | |
331 | """""" | |
332 | pass | |
333 | ||
334 | def GetVirtualSize(self): | |
335 | """""" | |
336 | pass | |
337 | ||
338 | def GetVirtualSizeTuple(self): | |
339 | """""" | |
340 | pass | |
341 | ||
342 | def GetWindowStyleFlag(self): | |
343 | """""" | |
344 | pass | |
345 | ||
346 | def HasCapture(self): | |
347 | """""" | |
348 | pass | |
349 | ||
350 | def HasScrollbar(self, orient): | |
351 | """""" | |
352 | pass | |
353 | ||
354 | def Hide(self): | |
355 | """""" | |
356 | pass | |
357 | ||
358 | def HitTest(self, pt): | |
359 | """""" | |
360 | pass | |
361 | ||
362 | def InitDialog(self): | |
363 | """""" | |
364 | pass | |
365 | ||
366 | def IsBeingDeleted(self): | |
367 | """""" | |
368 | pass | |
369 | ||
370 | def IsEnabled(self): | |
371 | """""" | |
372 | pass | |
373 | ||
374 | def IsExposed(self, x, y, w=0, h=0): | |
375 | """""" | |
376 | pass | |
377 | ||
378 | def IsExposedPoint(self, pt): | |
379 | """""" | |
380 | pass | |
381 | ||
382 | def IsExposedRect(self, rect): | |
383 | """""" | |
384 | pass | |
385 | ||
386 | def IsRetained(self): | |
387 | """""" | |
388 | pass | |
389 | ||
390 | def IsShown(self): | |
391 | """""" | |
392 | pass | |
393 | ||
394 | def IsTopLevel(self): | |
395 | """""" | |
396 | pass | |
397 | ||
398 | def Layout(self): | |
399 | """""" | |
400 | pass | |
401 | ||
402 | def LineDown(self): | |
403 | """""" | |
404 | pass | |
405 | ||
406 | def LineUp(self): | |
407 | """""" | |
408 | pass | |
409 | ||
410 | def LoadFromResource(self, parent, resourceName, resourceTable=wx.NULL): | |
411 | """Only if USE_WX_RESOURCES.""" | |
412 | pass | |
413 | ||
414 | def Lower(self): | |
415 | """""" | |
416 | pass | |
417 | ||
418 | def MakeModal(self, flag=True): | |
419 | """""" | |
420 | pass | |
421 | ||
422 | def Move(self, point, flags=wx.SIZE_USE_EXISTING): | |
423 | """""" | |
424 | pass | |
425 | ||
426 | def MoveXY(self, x, y, flags=wx.SIZE_USE_EXISTING): | |
427 | """""" | |
428 | pass | |
429 | ||
430 | def OnPaint(self, event): | |
431 | """Windows only.""" | |
432 | pass | |
433 | ||
434 | def PageDown(self): | |
435 | """""" | |
436 | pass | |
437 | ||
438 | def PageUp(self): | |
439 | """""" | |
440 | pass | |
441 | ||
442 | def PopEventHandler(self, deleteHandler=False): | |
443 | """""" | |
444 | pass | |
445 | ||
446 | def PopupMenu(self, menu, pos): | |
447 | """""" | |
448 | pass | |
449 | ||
450 | def PopupMenuXY(self, menu, x, y): | |
451 | """""" | |
452 | pass | |
453 | ||
454 | def PushEventHandler(self, handler): | |
455 | """""" | |
456 | pass | |
457 | ||
458 | def Raise(self): | |
459 | """""" | |
460 | pass | |
461 | ||
462 | def Refresh(self, eraseBackground=True, rect=wx.NULL): | |
463 | """""" | |
464 | pass | |
465 | ||
466 | def RefreshRect(self, rect): | |
467 | """""" | |
468 | pass | |
469 | ||
470 | def ReleaseMouse(self): | |
471 | """""" | |
472 | pass | |
473 | ||
474 | def RemoveChild(self, child): | |
475 | """""" | |
476 | pass | |
477 | ||
478 | def RemoveEventHandler(self, handler): | |
479 | """""" | |
480 | pass | |
481 | ||
482 | def Reparent(self, newParent): | |
483 | """""" | |
484 | pass | |
485 | ||
486 | def ScreenToClient(self, pt): | |
487 | """""" | |
488 | pass | |
489 | ||
490 | def ScreenToClientXY(self, x, y): | |
491 | """""" | |
492 | pass | |
493 | ||
494 | def ScrollLines(self, lines): | |
495 | """""" | |
496 | pass | |
497 | ||
498 | def ScrollPages(self, pages): | |
499 | """""" | |
500 | pass | |
501 | ||
502 | def ScrollWindow(self, dx, dy, rect=wx.NULL): | |
503 | """""" | |
504 | pass | |
505 | ||
506 | def SetAcceleratorTable(self, accel): | |
507 | """""" | |
508 | pass | |
509 | ||
510 | def SetAutoLayout(self, autoLayout): | |
511 | """""" | |
512 | pass | |
513 | ||
514 | def SetBackgroundColour(self, colour): | |
515 | """""" | |
516 | pass | |
517 | ||
518 | def SetCaret(self, caret): | |
519 | """""" | |
520 | pass | |
521 | ||
522 | def SetClientSize(self, size): | |
523 | """""" | |
524 | pass | |
525 | ||
526 | def SetClientSizeWH(self, width, height): | |
527 | """""" | |
528 | pass | |
529 | ||
530 | def SetConstraints(self, constraints): | |
531 | """""" | |
532 | pass | |
533 | ||
534 | def SetContainingSizer(self, sizer): | |
535 | """""" | |
536 | pass | |
537 | ||
538 | def SetCursor(self, cursor): | |
539 | """""" | |
540 | pass | |
541 | ||
542 | def SetDefaultItem(self, btn): | |
543 | """""" | |
544 | pass | |
545 | ||
546 | def SetDimensions(self): | |
547 | """""" | |
548 | pass | |
549 | ||
550 | def SetDropTarget(self, target): | |
551 | """""" | |
552 | pass | |
553 | ||
554 | def SetEventHandler(self, handler): | |
555 | """""" | |
556 | pass | |
557 | ||
558 | def SetExtraStyle(self, exStyle): | |
559 | """""" | |
560 | pass | |
561 | ||
562 | def SetFocus(self): | |
563 | """""" | |
564 | pass | |
565 | ||
566 | def SetFocusFromKbd(self): | |
567 | """""" | |
568 | pass | |
569 | ||
570 | def SetFont(self, font): | |
571 | """""" | |
572 | pass | |
573 | ||
574 | def SetForegroundColour(self, colour): | |
575 | """""" | |
576 | pass | |
577 | ||
578 | def SetHelpText(self, helpText): | |
579 | """""" | |
580 | pass | |
581 | ||
582 | def SetHelpTextForId(self, text): | |
583 | """""" | |
584 | pass | |
585 | ||
586 | def SetId(self, id): | |
587 | """""" | |
588 | pass | |
589 | ||
590 | def SetLabel(self, label): | |
591 | """""" | |
592 | pass | |
593 | ||
594 | def SetName(self, name): | |
595 | """""" | |
596 | pass | |
597 | ||
598 | def SetPosition(self, pos, flags=wx.SIZE_USE_EXISTING): | |
599 | """""" | |
600 | pass | |
601 | ||
602 | def SetRect(self, rect, sizeFlags=wx.SIZE_AUTO): | |
603 | """""" | |
604 | pass | |
605 | ||
606 | def SetScrollPos(self, orientation, pos, refresh=True): | |
607 | """""" | |
608 | pass | |
609 | ||
610 | def SetScrollbar(self, orientation, pos, thumbSize, range, refresh=True): | |
611 | """""" | |
612 | pass | |
613 | ||
614 | def SetSize(self, x, y, width, height, sizeFlags=wx.SIZE_AUTO): | |
615 | """""" | |
616 | pass | |
617 | ||
618 | def SetSizeHints(self, minW, minH, maxW=-1, maxH=-1, incW=-1, incH=-1): | |
619 | """""" | |
620 | pass | |
621 | ||
622 | def SetSizer(self, sizer, deleteOld=True): | |
623 | """""" | |
624 | pass | |
625 | ||
626 | def SetSizerAndFit(self, sizer, deleteOld=True): | |
627 | """""" | |
628 | pass | |
629 | ||
630 | def SetTitle(self, title): | |
631 | """""" | |
632 | pass | |
633 | ||
634 | def SetTmpDefaultItem(self, win): | |
635 | """""" | |
636 | pass | |
637 | ||
638 | def SetToolTip(self, tooltip): | |
639 | """""" | |
640 | pass | |
641 | ||
642 | def SetToolTipString(self, tip): | |
643 | """""" | |
644 | pass | |
645 | ||
646 | def SetValidator(self, validator): | |
647 | """""" | |
648 | pass | |
649 | ||
650 | def SetVirtualSize(self, size): | |
651 | """""" | |
652 | pass | |
653 | ||
654 | def SetVirtualSizeHints(self, minW, minH, maxW=-1, maxH=-1): | |
655 | """""" | |
656 | pass | |
657 | ||
658 | def SetVirtualSizeWH(self, x, y): | |
659 | """""" | |
660 | pass | |
661 | ||
662 | def SetWindowStyle(self, style): | |
663 | """""" | |
664 | pass | |
665 | ||
666 | def SetWindowStyleFlag(self, style): | |
667 | """""" | |
668 | pass | |
669 | ||
670 | def Show(self, show=True): | |
671 | """""" | |
672 | pass | |
673 | ||
674 | def Thaw(self): | |
675 | """""" | |
676 | pass | |
677 | ||
678 | def TransferDataFromWindow(self): | |
679 | """""" | |
680 | pass | |
681 | ||
682 | def TransferDataToWindow(self): | |
683 | """""" | |
684 | pass | |
685 | ||
686 | def UnsetConstraints(self, constraints): | |
687 | """""" | |
688 | pass | |
689 | ||
690 | def Update(self): | |
691 | """""" | |
692 | pass | |
693 | ||
694 | def UpdateWindowUI(self): | |
695 | """""" | |
696 | pass | |
697 | ||
698 | def Validate(self): | |
699 | """""" | |
700 | pass | |
701 | ||
702 | def WarpPointer(self, x, y): | |
703 | """""" | |
704 | pass | |
705 | ||
706 | ||
707 | class PyWindow(Window): | |
708 | """""" | |
709 | ||
710 | def __init__(self): | |
711 | """""" | |
712 | pass | |
713 | ||
714 | def _setCallbackInfo(self): | |
715 | """""" | |
716 | pass | |
717 | ||
718 | def base_AcceptsFocus(self): | |
719 | """""" | |
720 | pass | |
721 | ||
722 | def base_AcceptsFocusFromKeyboard(self): | |
723 | """""" | |
724 | pass | |
725 | ||
726 | def base_AddChild(self): | |
727 | """""" | |
728 | pass | |
729 | ||
730 | def base_DoGetBestSize(self): | |
731 | """""" | |
732 | pass | |
733 | ||
734 | def base_DoGetClientSize(self): | |
735 | """""" | |
736 | pass | |
737 | ||
738 | def base_DoGetPosition(self): | |
739 | """""" | |
740 | pass | |
741 | ||
742 | def base_DoGetSize(self): | |
743 | """""" | |
744 | pass | |
745 | ||
746 | def base_DoGetVirtualSize(self): | |
747 | """""" | |
748 | pass | |
749 | ||
750 | def base_DoMoveWindow(self): | |
751 | """""" | |
752 | pass | |
753 | ||
754 | def base_DoSetClientSize(self): | |
755 | """""" | |
756 | pass | |
757 | ||
758 | def base_DoSetSize(self): | |
759 | """""" | |
760 | pass | |
761 | ||
762 | def base_DoSetVirtualSize(self): | |
763 | """""" | |
764 | pass | |
765 | ||
766 | def base_GetMaxSize(self): | |
767 | """""" | |
768 | pass | |
769 | ||
770 | def base_InitDialog(self): | |
771 | """""" | |
772 | pass | |
773 | ||
774 | def base_RemoveChild(self): | |
775 | """""" | |
776 | pass | |
777 | ||
778 | def base_TransferDataFromWindow(self): | |
779 | """""" | |
780 | pass | |
781 | ||
782 | def base_TransferDataToWindow(self): | |
783 | """""" | |
784 | pass | |
785 | ||
786 | def base_Validate(self): | |
787 | """""" | |
788 | pass | |
789 | ||
790 | ||
791 | class TopLevelWindow(Window): | |
792 | """""" | |
793 | ||
794 | def Create(self): | |
795 | """""" | |
796 | pass | |
797 | ||
798 | def GetIcon(self): | |
799 | """""" | |
800 | pass | |
801 | ||
802 | def GetTitle(self): | |
803 | """""" | |
804 | pass | |
805 | ||
806 | def Iconize(self): | |
807 | """""" | |
808 | pass | |
809 | ||
810 | def IsFullScreen(self): | |
811 | """""" | |
812 | pass | |
813 | ||
814 | def IsIconized(self): | |
815 | """""" | |
816 | pass | |
817 | ||
818 | def IsMaximized(self): | |
819 | """""" | |
820 | pass | |
821 | ||
822 | def Maximize(self): | |
823 | """""" | |
824 | pass | |
825 | ||
826 | def Restore(self): | |
827 | """""" | |
828 | pass | |
829 | ||
830 | def SetIcon(self): | |
831 | """""" | |
832 | pass | |
833 | ||
834 | def SetIcons(self): | |
835 | """""" | |
836 | pass | |
837 | ||
838 | def SetTitle(self): | |
839 | """""" | |
840 | pass | |
841 | ||
842 | def ShowFullScreen(self): | |
843 | """""" | |
844 | pass | |
845 | ||
846 | def __init__(self): | |
847 | """""" | |
848 | pass | |
849 | ||
850 |