]> git.saurik.com Git - wxWidgets.git/blame - wxPython/wx/py/wxd/Functions.py
doc tweaks, typo fixed, etc.
[wxWidgets.git] / wxPython / wx / py / wxd / Functions.py
CommitLineData
1e4a197e
RD
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
15import Parameters as wx
16
17
18def ArtProvider_GetBitmap():
19 """"""
20 pass
21
22def ArtProvider_GetIcon():
23 """"""
24 pass
25
26def ArtProvider_PopProvider():
27 """"""
28 pass
29
30def ArtProvider_PushProvider():
31 """"""
32 pass
33
34def ArtProvider_RemoveProvider():
35 """"""
36 pass
37
38def BeginBusyCursor():
39 """"""
40 pass
41
42def Bell():
43 """"""
44 pass
45
46def BitmapFromBits():
47 """"""
48 pass
49
50def BitmapFromIcon():
51 """"""
52 pass
53
54def BitmapFromImage():
55 """"""
56 pass
57
58def BitmapFromXPMData():
59 """"""
60 pass
61
62def BufferedDCInternalBuffer():
63 """"""
64 pass
65
66def Button_GetDefaultSize():
67 """"""
68 pass
69
70def CallAfter(callable, *args, **kw):
71 """Call the specified function after the current and pending event
72 handlers have been completed. This is also good for making GUI
73 method calls from non-GUI threads."""
74 pass
75
76def Caret_GetBlinkTime():
77 """"""
78 pass
79
80def Caret_SetBlinkTime():
81 """"""
82 pass
83
84def ClientDisplayRect():
85 """"""
86 pass
87
88def ColourDisplay():
89 """"""
90 pass
91
92def ConfigBase_Create():
93 """"""
94 pass
95
96def ConfigBase_DontCreateOnDemand():
97 """"""
98 pass
99
100def ConfigBase_Get():
101 """"""
102 pass
103
104def ConfigBase_Set():
105 """"""
106 pass
107
108def CreateFileTipProvider():
109 """"""
110 pass
111
112def CustomDataFormat():
113 """"""
114 pass
115
116def DLG_PNT():
117 """"""
118 pass
119
120def DLG_SZE():
121 """"""
122 pass
123
124def DateSpan_Day():
125 """"""
126 pass
127
128def DateSpan_Days():
129 """"""
130 pass
131
132def DateSpan_Month():
133 """"""
134 pass
135
136def DateSpan_Months():
137 """"""
138 pass
139
140def DateSpan_Week():
141 """"""
142 pass
143
144def DateSpan_Weeks():
145 """"""
146 pass
147
148def DateSpan_Year():
149 """"""
150 pass
151
152def DateSpan_Years():
153 """"""
154 pass
155
156def DateTimeFromDMY():
157 """"""
158 pass
159
160def DateTimeFromHMS():
161 """"""
162 pass
163
164def DateTimeFromJDN():
165 """"""
166 pass
167
168def DateTimeFromTimeT():
169 """"""
170 pass
171
172def DateTime_ConvertYearToBC():
173 """"""
174 pass
175
176def DateTime_GetAmPmStrings():
177 """"""
178 pass
179
180def DateTime_GetBeginDST():
181 """"""
182 pass
183
184def DateTime_GetCentury():
185 """"""
186 pass
187
188def DateTime_GetCountry():
189 """"""
190 pass
191
192def DateTime_GetCurrentMonth():
193 """"""
194 pass
195
196def DateTime_GetCurrentYear():
197 """"""
198 pass
199
200def DateTime_GetEndDST():
201 """"""
202 pass
203
204def DateTime_GetMonthName():
205 """"""
206 pass
207
208def DateTime_GetNumberOfDaysInMonth():
209 """"""
210 pass
211
212def DateTime_GetNumberOfDaysinYear():
213 """"""
214 pass
215
216def DateTime_GetWeekDayName():
217 """"""
218 pass
219
220def DateTime_IsDSTApplicable():
221 """"""
222 pass
223
224def DateTime_IsLeapYear():
225 """"""
226 pass
227
228def DateTime_IsWestEuropeanCountry():
229 """"""
230 pass
231
232def DateTime_Now():
233 """"""
234 pass
235
236def DateTime_SetCountry():
237 """"""
238 pass
239
240def DateTime_Today():
241 """"""
242 pass
243
244def DateTime_UNow():
245 """"""
246 pass
247
248def DirSelector():
249 """"""
250 pass
251
252def DisplayDepth():
253 """"""
254 pass
255
256def DisplaySize():
257 """"""
258 pass
259
260def DisplaySizeMM():
261 """"""
262 pass
263
264def DragIcon():
265 """"""
266 pass
267
268def DragListItem():
269 """"""
270 pass
271
272def DragString():
273 """"""
274 pass
275
276def DragTreeItem():
277 """"""
278 pass
279
280def EmptyBitmap():
281 """"""
282 pass
283
284def EmptyIcon():
285 """"""
286 pass
287
288def EmptyImage():
289 """"""
290 pass
291
292def EnableTopLevelWindows():
293 """"""
294 pass
295
296def EncodingConverter_GetAllEquivalents():
297 """"""
298 pass
299
300def EncodingConverter_GetPlatformEquivalents():
301 """"""
302 pass
303
304def EndBusyCursor():
305 """"""
306 pass
307
308def Execute():
309 """"""
310 pass
311
312def FileSelector():
313 """"""
314 pass
315
316def FileSystem_AddHandler():
317 """"""
318 pass
319
320def FileSystem_CleanUpHandlers():
321 """"""
322 pass
323
324def FileTypeInfoSequence():
325 """"""
326 pass
327
328def FileType_ExpandCommand():
329 """"""
330 pass
331
332def FindWindowAtPoint():
333 """"""
334 pass
335
336def FindWindowById(id, parent=wx.NULL):
337 """"""
338 pass
339
340def FindWindowByLabel(label, parent=wx.NULL):
341 """"""
342 pass
343
344def FindWindowByName(name, parent=wx.NULL):
345 """"""
346 pass
347
348def FontFromNativeInfo():
349 """"""
350 pass
351
352def FontMapper_Get():
353 """"""
354 pass
355
356def FontMapper_GetDefaultConfigPath():
357 """"""
358 pass
359
360def FontMapper_GetEncodingDescription():
361 """"""
362 pass
363
364def FontMapper_GetEncodingName():
365 """"""
366 pass
367
368def FontMapper_Set():
369 """"""
370 pass
371
372def Font_GetDefaultEncoding():
373 """"""
374 pass
375
376def Font_SetDefaultEncoding():
377 """"""
378 pass
379
380def GenericFindWindowAtPoint():
381 """"""
382 pass
383
384def GetAccelFromString():
385 """"""
386 pass
387
388def GetActiveWindow():
389 """"""
390 pass
391
392def GetApp():
393 """"""
394 pass
395
396def GetClientDisplayRect():
397 """"""
398 pass
399
400def GetCurrentId():
401 """"""
402 pass
403
404def GetCurrentTime():
405 """"""
406 pass
407
408def GetDisplayDepth():
409 """"""
410 pass
411
412def GetDisplaySize():
413 """"""
414 pass
415
416def GetDisplaySizeMM():
417 """"""
418 pass
419
420def GetElapsedTime():
421 """"""
422 pass
423
424def GetEmailAddress():
425 """"""
426 pass
427
428def GetFullHostName():
429 """"""
430 pass
431
432def GetHomeDir():
433 """"""
434 pass
435
436def GetHostName():
437 """"""
438 pass
439
440def GetLocalTime():
441 """"""
442 pass
443
444def GetLocalTimeMillis():
445 """"""
446 pass
447
448def GetLocale():
449 """"""
450 pass
451
452def GetMousePosition():
453 """"""
454 pass
455
456def GetNumberFromUser():
457 """"""
458 pass
459
460def GetOsDescription():
461 """"""
462 pass
463
464def GetOsVersion():
465 """"""
466 pass
467
468def GetPasswordFromUser():
469 """"""
470 pass
471
472def GetProcessId():
473 """"""
474 pass
475
476def GetSingleChoice():
477 """"""
478 pass
479
480def GetSingleChoiceIndex():
481 """"""
482 pass
483
484def GetTextFromUser():
485 """"""
486 pass
487
488def GetTopLevelParent():
489 """"""
490 pass
491
492def GetTranslation():
493 """"""
494 pass
495
496def GetUTCTime():
497 """"""
498 pass
499
500def GetUserHome():
501 """"""
502 pass
503
504def GetUserId():
505 """"""
506 pass
507
508def GetUserName():
509 """"""
510 pass
511
512def IconBundleFromFile():
513 """"""
514 pass
515
516def IconBundleFromIcon():
517 """"""
518 pass
519
520def IconFromBitmap():
521 """"""
522 pass
523
524def IconFromXPMData():
525 """"""
526 pass
527
528def ImageFromBitmap():
529 """"""
530 pass
531
532def ImageFromData():
533 """"""
534 pass
535
536def ImageFromMime():
537 """"""
538 pass
539
540def ImageFromStream():
541 """"""
542 pass
543
544def ImageFromStreamMime():
545 """"""
546 pass
547
548def Image_AddHandler():
549 """"""
550 pass
551
552def Image_CanRead():
553 """"""
554 pass
555
556def Image_CanReadStream():
557 """"""
558 pass
559
560def Image_GetImageCount():
561 """"""
562 pass
563
564def Image_InsertHandler():
565 """"""
566 pass
567
568def Image_RemoveHandler():
569 """"""
570 pass
571
572def InitAllImageHandlers():
573 """"""
574 pass
575
576def IntersectRect():
577 """"""
578 pass
579
580def IsBusy():
581 """"""
582 pass
583
584def IsDragResultOk():
585 """"""
586 pass
587
588def LoadFileSelector():
589 """"""
590 pass
591
592def Locale_AddCatalogLookupPathPrefix():
593 """"""
594 pass
595
596def Locale_AddLanguage():
597 """"""
598 pass
599
600def Locale_GetLanguageInfo():
601 """"""
602 pass
603
604def Locale_GetSystemEncoding():
605 """"""
606 pass
607
608def Locale_GetSystemEncodingName():
609 """"""
610 pass
611
612def Locale_GetSystemLanguage():
613 """"""
614 pass
615
616def LogDebug():
617 """"""
618 pass
619
620def LogError():
621 """"""
622 pass
623
624def LogFatalError():
625 """"""
626 pass
627
628def LogGeneric():
629 """"""
630 pass
631
632def LogInfo():
633 """"""
634 pass
635
636def LogMessage():
637 """"""
638 pass
639
640def LogStatus():
641 """"""
642 pass
643
644def LogStatusFrame():
645 """"""
646 pass
647
648def LogSysError():
649 """"""
650 pass
651
652def LogTrace():
653 """"""
654 pass
655
656def LogTraceMask():
657 """"""
658 pass
659
660def LogVerbose():
661 """"""
662 pass
663
664def LogWarning():
665 """"""
666 pass
667
668def Log_AddTraceMask():
669 """"""
670 pass
671
672def Log_ClearTraceMasks():
673 """"""
674 pass
675
676def Log_DontCreateOnDemand():
677 """"""
678 pass
679
680def Log_EnableLogging():
681 """"""
682 pass
683
684def Log_FlushActive():
685 """"""
686 pass
687
688def Log_GetActiveTarget():
689 """"""
690 pass
691
692def Log_GetLogLevel():
693 """"""
694 pass
695
696def Log_GetTimestamp():
697 """"""
698 pass
699
700def Log_GetTraceMask():
701 """"""
702 pass
703
704def Log_GetTraceMasks():
705 """"""
706 pass
707
708def Log_IsAllowedTraceMask():
709 """"""
710 pass
711
712def Log_IsEnabled():
713 """"""
714 pass
715
716def Log_OnLog():
717 """"""
718 pass
719
720def Log_RemoveTraceMask():
721 """"""
722 pass
723
724def Log_Resume():
725 """"""
726 pass
727
728def Log_SetActiveTarget():
729 """"""
730 pass
731
732def Log_SetLogLevel():
733 """"""
734 pass
735
736def Log_SetTimestamp():
737 """"""
738 pass
739
740def Log_SetTraceMask():
741 """"""
742 pass
743
744def Log_SetVerbose():
745 """"""
746 pass
747
748def Log_Suspend():
749 """"""
750 pass
751
752def MaskColour():
753 """"""
754 pass
755
756def MemoryDCFromDC():
757 """"""
758 pass
759
760def MemoryFSHandler_AddFile():
761 """"""
762 pass
763
764def MemoryFSHandler_RemoveFile():
765 """"""
766 pass
767
768def MenuItem_GetLabelFromText():
769 """"""
770 pass
771
772def MessageBox():
773 """"""
774 pass
775
776def MimeTypesManager_IsOfType():
777 """"""
778 pass
779
780def MutexGuiEnter():
781 """"""
782 pass
783
784def MutexGuiLeave():
785 """"""
786 pass
787
788def NamedColour():
789 """"""
790 pass
791
792def NamedColour():
793 """"""
794 pass
795
796def NewEventType():
797 """"""
798 pass
799
800def NewId():
801 """"""
802 pass
803
804def Now():
805 """"""
806 pass
807
808def NullFileTypeInfo():
809 """"""
810 pass
811
812def Point2DDoubleCopy():
813 """"""
814 pass
815
816def Point2DDoubleFromPoint():
817 """"""
818 pass
819
820def PostEvent():
821 """"""
822 pass
823
824def PostScriptDC_GetResolution():
825 """"""
826 pass
827
828def PostScriptDC_SetResolution():
829 """"""
830 pass
831
832def PreBitmapButton():
833 """"""
834 pass
835
836def PreButton():
837 """"""
838 pass
839
840def PreCheckBox():
841 """"""
842 pass
843
844def PreCheckListBox():
845 """"""
846 pass
847
848def PreChoice():
849 """"""
850 pass
851
852def PreComboBox():
853 """"""
854 pass
855
856def PreControl():
857 """"""
858 pass
859
860def PreDialog():
861 """"""
862 pass
863
864def PreDirFilterListCtrl():
865 """"""
866 pass
867
868def PreFindReplaceDialog():
869 """"""
870 pass
871
872def PreFrame():
873 """"""
874 pass
875
876def PreGauge():
877 """"""
878 pass
879
880def PreGenericDirCtrl():
881 """"""
882 pass
883
884def PreListBox():
885 """"""
886 pass
887
888def PreListCtrl():
889 """"""
890 pass
891
892def PreListView():
893 """"""
894 pass
895
896def PreMDIChildFrame():
897 """"""
898 pass
899
900def PreMDIClientWindow():
901 """"""
902 pass
903
904def PreMDIParentFrame():
905 """"""
906 pass
907
908def PreMiniFrame():
909 """"""
910 pass
911
912def PreNotebook():
913 """"""
914 pass
915
916def PrePanel():
917 """"""
918 pass
919
920def PrePopupTransientWindow():
921 """"""
922 pass
923
924def PrePopupWindow():
925 """"""
926 pass
927
928def PreRadioBox():
929 """"""
930 pass
931
932def PreRadioButton():
933 """"""
934 pass
935
936def PreSashLayoutWindow():
937 """"""
938 pass
939
940def PreSashWindow():
941 """"""
942 pass
943
944def PreScrollBar():
945 """"""
946 pass
947
948def PreScrolledWindow():
949 """"""
950 pass
951
952def PreSingleInstanceChecker():
953 """"""
954 pass
955
956def PreSlider():
957 """"""
958 pass
959
960def PreSpinButton():
961 """"""
962 pass
963
964def PreSpinCtrl():
965 """"""
966 pass
967
968def PreSplitterWindow():
969 """"""
970 pass
971
972def PreStaticBitmap():
973 """"""
974 pass
975
976def PreStaticBox():
977 """"""
978 pass
979
980def PreStaticLine():
981 """"""
982 pass
983
984def PreStaticText():
985 """"""
986 pass
987
988def PreStatusBar():
989 """"""
990 pass
991
992def PreTextCtrl():
993 """"""
994 pass
995
996def PreToggleButton():
997 """"""
998 pass
999
1000def PreToolBar():
1001 """"""
1002 pass
1003
1004def PreToolBarSimple():
1005 """"""
1006 pass
1007
1008def PreTopLevelWindow():
1009 """"""
1010 pass
1011
1012def PreTreeCtrl():
1013 """"""
1014 pass
1015
1016def PreWindow():
1017 """"""
1018 pass
1019
1020def Process_Exists():
1021 """"""
1022 pass
1023
1024def Process_Kill():
1025 """"""
1026 pass
1027
1028def Process_Open():
1029 """"""
1030 pass
1031
1032def PyTypeCast(obj, typeStr):
1033 """This helper function will take a wxPython object and convert it
1034 to another wxPython object type. This will not be able to create
1035 objects that are derived from wxPython classes by the user, only
1036 those that are actually part of wxPython and directly corespond to
1037 C++ objects.
1038
1039 This is useful in situations where some method returns a generic
1040 type such as wxWindow, but you know that it is actually some
1041 derived type such as a TextCtrl. You can't call TextCtrl
1042 specific methods on a Window object, but you can use this
1043 function to create a TextCtrl object that will pass the same
1044 pointer to the C++ code. You use it like this:
1045
1046 textCtrl = PyTypeCast(window, "TextCtrl")
1047
1048 WARNING: Using this function to type cast objects into types that
1049 they are not is not recommended and is likely to cause
1050 your program to crash... Hard."""
1051 pass
1052
1053def Py_isinstance(obj, klasses):
1054 """An isinstance for Python < 2.2 that can check a sequence of
1055 class objects like the one in 2.2 can."""
1056 pass
1057
1058def RegionFromPoints():
1059 """"""
1060 pass
1061
1062def RegisterId():
1063 """"""
1064 pass
1065
1066## def RunLater(callable, *args, **kw):
1067## """An alias for CallAfter."""
1068## pass
1069
1070RunLater = CallAfter
1071
1072def SafeShowMessage():
1073 """"""
1074 pass
1075
1076def SafeYield():
1077 """"""
1078 pass
1079
1080def SaveFileSelector():
1081 """"""
1082 pass
1083
1084def SetCursor():
1085 """"""
1086 pass
1087
1088def Shell():
1089 """"""
1090 pass
1091
1092def ShowTip():
1093 """"""
1094 pass
1095
1096def Shutdown():
1097 """"""
1098 pass
1099
1100def Sleep():
1101 """"""
1102 pass
1103
1104def StartTimer():
1105 """"""
1106 pass
1107
1108def StockCursor():
1109 """"""
1110 pass
1111
1112def StripMenuCodes():
1113 """"""
1114 pass
1115
1116def SysErrorCode():
1117 """"""
1118 pass
1119
1120def SysErrorMsg():
1121 """"""
1122 pass
1123
1124def SystemSettings_GetColour():
1125 """"""
1126 pass
1127
1128def SystemSettings_GetFont():
1129 """"""
1130 pass
1131
1132def SystemSettings_GetMetric():
1133 """"""
1134 pass
1135
1136def SystemSettings_GetScreenType():
1137 """"""
1138 pass
1139
1140def SystemSettings_GetColour():
1141 """"""
1142 pass
1143
1144def SystemSettings_GetFont():
1145 """"""
1146 pass
1147
1148def SystemSettings_GetMetric():
1149 """"""
1150 pass
1151
1152def SystemSettings_HasFeature():
1153 """"""
1154 pass
1155
1156def SystemSettings_SetScreenType():
1157 """"""
1158 pass
1159
1160def TextAttr_Combine():
1161 """"""
1162 pass
1163
1164def Thread_IsMain():
1165 """"""
1166 pass
1167
1168def TimeSpan_Day():
1169 """"""
1170 pass
1171
1172def TimeSpan_Days():
1173 """"""
1174 pass
1175
1176def TimeSpan_Hour():
1177 """"""
1178 pass
1179
1180def TimeSpan_Hours():
1181 """"""
1182 pass
1183
1184def TimeSpan_Minute():
1185 """"""
1186 pass
1187
1188def TimeSpan_Minutes():
1189 """"""
1190 pass
1191
1192def TimeSpan_Second():
1193 """"""
1194 pass
1195
1196def TimeSpan_Seconds():
1197 """"""
1198 pass
1199
1200def TimeSpan_Week():
1201 """"""
1202 pass
1203
1204def TimeSpan_Weeks():
1205 """"""
1206 pass
1207
1208def ToolTip_Enable():
1209 """"""
1210 pass
1211
1212def ToolTip_SetDelay():
1213 """"""
1214 pass
1215
1216def Usleep():
1217 """"""
1218 pass
1219
1220def Validator_IsSilent():
1221 """"""
1222 pass
1223
1224def Validator_SetBellOnError():
1225 """"""
1226 pass
1227
1228def WakeUpIdle():
1229 """"""
1230 pass
1231
1232def WaveData():
1233 """"""
1234 pass
1235
1236def Window_FindFocus():
1237 """"""
1238 pass
1239
1240def Window_GetCapture():
1241 """"""
1242 pass
1243
1244def Window_NewControlId():
1245 """"""
1246 pass
1247
1248def Window_NextControlId():
1249 """"""
1250 pass
1251
1252def Window_PrevControlId():
1253 """"""
1254 pass
1255
1256def Yield():
1257 """"""
1258 pass
1259
1260def YieldIfNeeded():
1261 """"""
1262 pass