wxPython/wx/py/wxd/Events.py

   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 Object
  16 import Parameters as wx
  17
  18
  19 class Event(Object):
  20     """"""
  21
  22     def __init__(self):
  23         """"""
  24         pass
  25
  26     def Clone(self):
  27         """"""
  28         pass
  29
  30     def GetEventObject(self):
  31         """"""
  32         pass
  33
  34     def GetEventType(self):
  35         """"""
  36         pass
  37
  38     def GetId(self):
  39         """"""
  40         pass
  41
  42     def GetSkipped(self):
  43         """"""
  44         pass
  45
  46     def GetTimestamp(self):
  47         """"""
  48         pass
  49
  50     def SetEventObject(self):
  51         """"""
  52         pass
  53
  54     def SetEventType(self):
  55         """"""
  56         pass
  57
  58     def SetId(self):
  59         """"""
  60         pass
  61
  62     def SetTimestamp(self):
  63         """"""
  64         pass
  65
  66     def Skip(self):
  67         """"""
  68         pass
  69
  70
  71 class PyEvent(Event):
  72     """"""
  73
  74     def GetSelf(self):
  75         """"""
  76         pass
  77
  78     def SetSelf(self):
  79         """"""
  80         pass
  81
  82     def __del__(self):
  83         """"""
  84         pass
  85
  86     def __init__(self):
  87         """"""
  88         pass
  89
  90
  91 class ActivateEvent(Event):
  92     """"""
  93
  94     def GetActive(self):
  95         """"""
  96         pass
  97
  98     def __init__(self):
  99         """"""
 100         pass
 101
 102
 103 class CalculateLayoutEvent(Event):
 104     """"""
 105
 106     def GetFlags(self):
 107         """"""
 108         pass
 109
 110     def GetRect(self):
 111         """"""
 112         pass
 113
 114     def SetFlags(self):
 115         """"""
 116         pass
 117
 118     def SetRect(self):
 119         """"""
 120         pass
 121
 122     def __init__(self):
 123         """"""
 124         pass
 125
 126
 127 class CloseEvent(Event):
 128     """"""
 129
 130     def CanVeto(self):
 131         """"""
 132         pass
 133
 134     def GetLoggingOff(self):
 135         """"""
 136         pass
 137
 138     def GetVeto(self):
 139         """"""
 140         pass
 141
 142     def SetCanVeto(self):
 143         """"""
 144         pass
 145
 146     def SetLoggingOff(self):
 147         """"""
 148         pass
 149
 150     def Veto(self):
 151         """"""
 152         pass
 153
 154     def __init__(self):
 155         """"""
 156         pass
 157
 158
 159 class CommandEvent(Event):
 160     """"""
 161
 162     def __init__(self):
 163         """"""
 164         pass
 165
 166     def Checked(self):
 167         """"""
 168         pass
 169
 170     def GetClientData(self):
 171         """"""
 172         pass
 173
 174     def GetExtraLong(self):
 175         """"""
 176         pass
 177
 178     def GetInt(self):
 179         """"""
 180         pass
 181
 182     def GetSelection(self):
 183         """"""
 184         pass
 185
 186     def GetString(self):
 187         """"""
 188         pass
 189
 190     def IsChecked(self):
 191         """"""
 192         pass
 193
 194     def IsSelection(self):
 195         """"""
 196         pass
 197
 198     def SetExtraLong(self):
 199         """"""
 200         pass
 201
 202     def SetInt(self):
 203         """"""
 204         pass
 205
 206     def SetString(self):
 207         """"""
 208         pass
 209
 210
 211 class ChildFocusEvent(CommandEvent):
 212     """"""
 213
 214     def GetWindow(self):
 215         """"""
 216         pass
 217
 218     def __init__(self):
 219         """"""
 220         pass
 221
 222
 223 class ContextMenuEvent(CommandEvent):
 224     """"""
 225
 226     def GetPosition(self):
 227         """"""
 228         pass
 229
 230     def SetPosition(self):
 231         """"""
 232         pass
 233
 234     def __init__(self):
 235         """"""
 236         pass
 237
 238
 239 class DisplayChangedEvent(Event):
 240     """"""
 241
 242     def __init__(self):
 243         """"""
 244         pass
 245
 246
 247 class DropFilesEvent(Event):
 248     """"""
 249
 250     def GetFiles(self):
 251         """"""
 252         pass
 253
 254     def GetNumberOfFiles(self):
 255         """"""
 256         pass
 257
 258     def GetPosition(self):
 259         """"""
 260         pass
 261
 262     def __init__(self):
 263         """"""
 264         pass
 265
 266
 267 class EraseEvent(Event):
 268     """"""
 269
 270     def GetDC(self):
 271         """"""
 272         pass
 273
 274     def __init__(self):
 275         """"""
 276         pass
 277
 278
 279 class FindDialogEvent(CommandEvent):
 280     """"""
 281
 282     def GetDialog(self):
 283         """"""
 284         pass
 285
 286     def GetFindString(self):
 287         """"""
 288         pass
 289
 290     def GetFlags(self):
 291         """"""
 292         pass
 293
 294     def GetReplaceString(self):
 295         """"""
 296         pass
 297
 298     def SetFindString(self):
 299         """"""
 300         pass
 301
 302     def SetFlags(self):
 303         """"""
 304         pass
 305
 306     def SetReplaceString(self):
 307         """"""
 308         pass
 309
 310     def __init__(self):
 311         """"""
 312         pass
 313
 314
 315 class FocusEvent(Event):
 316     """"""
 317
 318     def __init__(self):
 319         """"""
 320         pass
 321
 322
 323 class IconizeEvent(Event):
 324     """"""
 325
 326     def Iconized(self):
 327         """"""
 328         pass
 329
 330     def __init__(self):
 331         """"""
 332         pass
 333
 334
 335 class IdleEvent(Event):
 336     """"""
 337
 338     def MoreRequested(self):
 339         """"""
 340         pass
 341
 342     def RequestMore(self):
 343         """"""
 344         pass
 345
 346     def __init__(self):
 347         """"""
 348         pass
 349
 350
 351 class InitDialogEvent(Event):
 352     """"""
 353
 354     def __init__(self):
 355         """"""
 356         pass
 357
 358
 359 class JoystickEvent(Event):
 360     """"""
 361
 362     def ButtonDown(self):
 363         """"""
 364         pass
 365
 366     def ButtonIsDown(self):
 367         """"""
 368         pass
 369
 370     def ButtonUp(self):
 371         """"""
 372         pass
 373
 374     def GetButtonChange(self):
 375         """"""
 376         pass
 377
 378     def GetButtonState(self):
 379         """"""
 380         pass
 381
 382     def GetJoystick(self):
 383         """"""
 384         pass
 385
 386     def GetPosition(self):
 387         """"""
 388         pass
 389
 390     def GetZPosition(self):
 391         """"""
 392         pass
 393
 394     def IsButton(self):
 395         """"""
 396         pass
 397
 398     def IsMove(self):
 399         """"""
 400         pass
 401
 402     def IsZMove(self):
 403         """"""
 404         pass
 405
 406     def SetButtonChange(self):
 407         """"""
 408         pass
 409
 410     def SetButtonState(self):
 411         """"""
 412         pass
 413
 414     def SetJoystick(self):
 415         """"""
 416         pass
 417
 418     def SetPosition(self):
 419         """"""
 420         pass
 421
 422     def SetZPosition(self):
 423         """"""
 424         pass
 425
 426     def __init__(self):
 427         """"""
 428         pass
 429
 430
 431 class KeyEvent(Event):
 432     """"""
 433
 434     def AltDown(self):
 435         """"""
 436         pass
 437
 438     def ControlDown(self):
 439         """"""
 440         pass
 441
 442     def GetKeyCode(self):
 443         """"""
 444         pass
 445
 446     def GetPosition(self):
 447         """"""
 448         pass
 449
 450     def GetPositionTuple(self):
 451         """"""
 452         pass
 453
 454     def GetRawKeyCode(self):
 455         """"""
 456         pass
 457
 458     def GetRawKeyFlags(self):
 459         """"""
 460         pass
 461
 462     def GetX(self):
 463         """"""
 464         pass
 465
 466     def GetY(self):
 467         """"""
 468         pass
 469
 470     def HasModifiers(self):
 471         """"""
 472         pass
 473
 474     def KeyCode(self):
 475         """"""
 476         pass
 477
 478     def MetaDown(self):
 479         """"""
 480         pass
 481
 482     def ShiftDown(self):
 483         """"""
 484         pass
 485
 486     def __getattr__(self):
 487         """"""
 488         pass
 489
 490     def __init__(self):
 491         """"""
 492         pass
 493
 494     def __setattr__(self):
 495         """"""
 496         pass
 497
 498
 499 class MaximizeEvent(Event):
 500     """"""
 501
 502     def __init__(self):
 503         """"""
 504         pass
 505
 506
 507 class MenuEvent(Event):
 508     """"""
 509
 510     def GetMenuId(self):
 511         """"""
 512         pass
 513
 514     def IsPopup(self):
 515         """"""
 516         pass
 517
 518     def __init__(self):
 519         """"""
 520         pass
 521
 522
 523 class MouseCaptureChangedEvent(Event):
 524     """"""
 525
 526     def GetCapturedWindow(self):
 527         """"""
 528         pass
 529
 530     def __init__(self):
 531         """"""
 532         pass
 533
 534
 535 class MouseEvent(Event):
 536     """"""
 537
 538     def AltDown(self):
 539         """"""
 540         pass
 541
 542     def Button(self):
 543         """"""
 544         pass
 545
 546     def ButtonDClick(self):
 547         """"""
 548         pass
 549
 550     def ButtonDown(self):
 551         """"""
 552         pass
 553
 554     def ButtonIsDown(self):
 555         """"""
 556         pass
 557
 558     def ButtonUp(self):
 559         """"""
 560         pass
 561
 562     def ControlDown(self):
 563         """"""
 564         pass
 565
 566     def Dragging(self):
 567         """"""
 568         pass
 569
 570     def Entering(self):
 571         """"""
 572         pass
 573
 574     def GetLinesPerAction(self):
 575         """"""
 576         pass
 577
 578     def GetLogicalPosition(self):
 579         """"""
 580         pass
 581
 582     def GetPosition(self):
 583         """"""
 584         pass
 585
 586     def GetPositionTuple(self):
 587         """"""
 588         pass
 589
 590     def GetWheelDelta(self):
 591         """"""
 592         pass
 593
 594     def GetWheelRotation(self):
 595         """"""
 596         pass
 597
 598     def GetX(self):
 599         """"""
 600         pass
 601
 602     def GetY(self):
 603         """"""
 604         pass
 605
 606     def IsButton(self):
 607         """"""
 608         pass
 609
 610     def Leaving(self):
 611         """"""
 612         pass
 613
 614     def LeftDClick(self):
 615         """"""
 616         pass
 617
 618     def LeftDown(self):
 619         """"""
 620         pass
 621
 622     def LeftIsDown(self):
 623         """"""
 624         pass
 625
 626     def LeftUp(self):
 627         """"""
 628         pass
 629
 630     def MetaDown(self):
 631         """"""
 632         pass
 633
 634     def MiddleDClick(self):
 635         """"""
 636         pass
 637
 638     def MiddleDown(self):
 639         """"""
 640         pass
 641
 642     def MiddleIsDown(self):
 643         """"""
 644         pass
 645
 646     def MiddleUp(self):
 647         """"""
 648         pass
 649
 650     def Moving(self):
 651         """"""
 652         pass
 653
 654     def RightDClick(self):
 655         """"""
 656         pass
 657
 658     def RightDown(self):
 659         """"""
 660         pass
 661
 662     def RightIsDown(self):
 663         """"""
 664         pass
 665
 666     def RightUp(self):
 667         """"""
 668         pass
 669
 670     def ShiftDown(self):
 671         """"""
 672         pass
 673
 674     def __getattr__(self):
 675         """"""
 676         pass
 677
 678     def __init__(self):
 679         """"""
 680         pass
 681
 682     def __setattr__(self):
 683         """"""
 684         pass
 685
 686
 687 class MoveEvent(Event):
 688     """"""
 689
 690     def GetPosition(self):
 691         """"""
 692         pass
 693
 694     def __init__(self):
 695         """"""
 696         pass
 697
 698
 699 class NavigationKeyEvent(Event):
 700     """"""
 701
 702     def GetCurrentFocus(self):
 703         """"""
 704         pass
 705
 706     def GetDirection(self):
 707         """"""
 708         pass
 709
 710     def IsWindowChange(self):
 711         """"""
 712         pass
 713
 714     def SetCurrentFocus(self):
 715         """"""
 716         pass
 717
 718     def SetDirection(self):
 719         """"""
 720         pass
 721
 722     def SetWindowChange(self):
 723         """"""
 724         pass
 725
 726     def __init__(self):
 727         """"""
 728         pass
 729
 730
 731 class NotifyEvent(CommandEvent):
 732     """"""
 733
 734     def __init__(self):
 735         """"""
 736         pass
 737
 738     def Allow(self):
 739         """"""
 740         pass
 741
 742     def IsAllowed(self):
 743         """"""
 744         pass
 745
 746     def Veto(self):
 747         """"""
 748         pass
 749
 750
 751 class ListEvent(NotifyEvent):
 752     """"""
 753
 754     def GetCacheFrom(self):
 755         """"""
 756         pass
 757
 758     def GetCacheTo(self):
 759         """"""
 760         pass
 761
 762     def GetCode(self):
 763         """"""
 764         pass
 765
 766     def GetColumn(self):
 767         """"""
 768         pass
 769
 770     def GetData(self):
 771         """"""
 772         pass
 773
 774     def GetImage(self):
 775         """"""
 776         pass
 777
 778     def GetIndex(self):
 779         """"""
 780         pass
 781
 782     def GetItem(self):
 783         """"""
 784         pass
 785
 786     def GetKeyCode(self):
 787         """"""
 788         pass
 789
 790     def GetLabel(self):
 791         """"""
 792         pass
 793
 794     def GetMask(self):
 795         """"""
 796         pass
 797
 798     def GetPoint(self):
 799         """"""
 800         pass
 801
 802     def GetText(self):
 803         """"""
 804         pass
 805
 806     def __getattr__(self):
 807         """"""
 808         pass
 809
 810     def __init__(self):
 811         """"""
 812         pass
 813
 814     def __setattr__(self):
 815         """"""
 816         pass
 817
 818
 819 class NotebookEvent(NotifyEvent):
 820
 821     def __init__(self, commandType=wx.EVT_NULL, id=0, nSel=-1, nOldSel=-1):
 822         """"""
 823         pass
 824
 825     def GetSelection(self):
 826         """"""
 827         pass
 828
 829     def GetOldSelection(self):
 830         """"""
 831         pass
 832
 833     def SetOldSelection(self, page):
 834         """"""
 835         pass
 836
 837     def SetSelection(self, page):
 838         """"""
 839         pass
 840
 841
 842 class PaintEvent(Event):
 843     """"""
 844
 845     def __init__(self):
 846         """"""
 847         pass
 848
 849
 850 class PaletteChangedEvent(Event):
 851     """"""
 852
 853     def GetChangedWindow(self):
 854         """"""
 855         pass
 856
 857     def SetChangedWindow(self):
 858         """"""
 859         pass
 860
 861     def __init__(self):
 862         """"""
 863         pass
 864
 865
 866 class ProcessEvent(Event):
 867     """"""
 868
 869     def GetExitCode(self):
 870         """"""
 871         pass
 872
 873     def GetPid(self):
 874         """"""
 875         pass
 876
 877     def __getattr__(self):
 878         """"""
 879         pass
 880
 881     def __init__(self):
 882         """"""
 883         pass
 884
 885     def __setattr__(self):
 886         """"""
 887         pass
 888
 889
 890 class PyCommandEvent(CommandEvent):
 891     """"""
 892
 893     def GetSelf(self):
 894         """"""
 895         pass
 896
 897     def SetSelf(self):
 898         """"""
 899         pass
 900
 901     def __del__(self):
 902         """"""
 903         pass
 904
 905     def __init__(self):
 906         """"""
 907         pass
 908
 909
 910 class QueryLayoutInfoEvent(Event):
 911     """"""
 912
 913     def GetAlignment(self):
 914         """"""
 915         pass
 916
 917     def GetFlags(self):
 918         """"""
 919         pass
 920
 921     def GetOrientation(self):
 922         """"""
 923         pass
 924
 925     def GetRequestedLength(self):
 926         """"""
 927         pass
 928
 929     def GetSize(self):
 930         """"""
 931         pass
 932
 933     def SetAlignment(self):
 934         """"""
 935         pass
 936
 937     def SetFlags(self):
 938         """"""
 939         pass
 940
 941     def SetOrientation(self):
 942         """"""
 943         pass
 944
 945     def SetRequestedLength(self):
 946         """"""
 947         pass
 948
 949     def SetSize(self):
 950         """"""
 951         pass
 952
 953     def __init__(self):
 954         """"""
 955         pass
 956
 957
 958 class QueryNewPaletteEvent(Event):
 959     """"""
 960
 961     def GetPaletteRealized(self):
 962         """"""
 963         pass
 964
 965     def SetPaletteRealized(self):
 966         """"""
 967         pass
 968
 969     def __init__(self):
 970         """"""
 971         pass
 972
 973
 974 class SashEvent(CommandEvent):
 975     """"""
 976
 977     def GetDragRect(self):
 978         """"""
 979         pass
 980
 981     def GetDragStatus(self):
 982         """"""
 983         pass
 984
 985     def GetEdge(self):
 986         """"""
 987         pass
 988
 989     def SetDragRect(self):
 990         """"""
 991         pass
 992
 993     def SetDragStatus(self):
 994         """"""
 995         pass
 996
 997     def SetEdge(self):
 998         """"""
 999         pass
1000
1001     def __init__(self):
1002         """"""
1003         pass
1004
1005
1006 class ScrollEvent(CommandEvent):
1007     """"""
1008
1009     def GetOrientation(self):
1010         """"""
1011         pass
1012
1013     def GetPosition(self):
1014         """"""
1015         pass
1016
1017     def __init__(self):
1018         """"""
1019         pass
1020
1021
1022 class ScrollWinEvent(Event):
1023     """"""
1024
1025     def GetOrientation(self):
1026         """"""
1027         pass
1028
1029     def GetPosition(self):
1030         """"""
1031         pass
1032
1033     def __init__(self):
1034         """"""
1035         pass
1036
1037
1038 class SetCursorEvent(Event):
1039     """"""
1040
1041     def GetCursor(self):
1042         """"""
1043         pass
1044
1045     def GetX(self):
1046         """"""
1047         pass
1048
1049     def GetY(self):
1050         """"""
1051         pass
1052
1053     def HasCursor(self):
1054         """"""
1055         pass
1056
1057     def SetCursor(self):
1058         """"""
1059         pass
1060
1061     def __init__(self):
1062         """"""
1063         pass
1064
1065
1066 class ShowEvent(Event):
1067     """"""
1068
1069     def GetShow(self):
1070         """"""
1071         pass
1072
1073     def SetShow(self):
1074         """"""
1075         pass
1076
1077     def __init__(self):
1078         """"""
1079         pass
1080
1081
1082 class SizeEvent(Event):
1083     """"""
1084
1085     def GetSize(self):
1086         """"""
1087         pass
1088
1089     def __init__(self):
1090         """"""
1091         pass
1092
1093
1094 class SpinEvent(ScrollEvent):
1095     """"""
1096
1097     def __init__(self):
1098         """"""
1099         pass
1100
1101
1102 class SplitterEvent(NotifyEvent):
1103     """"""
1104
1105     def GetSashPosition(self):
1106         """"""
1107         pass
1108
1109     def GetWindowBeingRemoved(self):
1110         """"""
1111         pass
1112
1113     def GetX(self):
1114         """"""
1115         pass
1116
1117     def GetY(self):
1118         """"""
1119         pass
1120
1121     def SetSashPosition(self):
1122         """"""
1123         pass
1124
1125     def __init__(self):
1126         """"""
1127         pass
1128
1129
1130 class SysColourChangedEvent(Event):
1131     """"""
1132
1133     def __init__(self):
1134         """"""
1135         pass
1136
1137
1138 class TextUrlEvent(CommandEvent):
1139     """"""
1140
1141     def GetMouseEvent(self):
1142         """"""
1143         pass
1144
1145     def GetURLEnd(self):
1146         """"""
1147         pass
1148
1149     def GetURLStart(self):
1150         """"""
1151         pass
1152
1153     def __init__(self):
1154         """"""
1155         pass
1156
1157
1158 class TimerEvent(Event):
1159     """"""
1160
1161     def GetInterval(self):
1162         """"""
1163         pass
1164
1165     def __init__(self):
1166         """"""
1167         pass
1168
1169
1170 class TreeEvent(NotifyEvent):
1171     """"""
1172
1173     def GetCode(self):
1174         """"""
1175         pass
1176
1177     def GetItem(self):
1178         """"""
1179         pass
1180
1181     def GetKeyCode(self):
1182         """"""
1183         pass
1184
1185     def GetKeyEvent(self):
1186         """"""
1187         pass
1188
1189     def GetLabel(self):
1190         """"""
1191         pass
1192
1193     def GetOldItem(self):
1194         """"""
1195         pass
1196
1197     def GetPoint(self):
1198         """"""
1199         pass
1200
1201     def IsEditCancelled(self):
1202         """"""
1203         pass
1204
1205     def __init__(self):
1206         """"""
1207         pass
1208
1209
1210 class UpdateUIEvent(Event):
1211     """"""
1212
1213     def Check(self):
1214         """"""
1215         pass
1216
1217     def Enable(self):
1218         """"""
1219         pass
1220
1221     def GetChecked(self):
1222         """"""
1223         pass
1224
1225     def GetEnabled(self):
1226         """"""
1227         pass
1228
1229     def GetSetChecked(self):
1230         """"""
1231         pass
1232
1233     def GetSetEnabled(self):
1234         """"""
1235         pass
1236
1237     def GetSetText(self):
1238         """"""
1239         pass
1240
1241     def GetText(self):
1242         """"""
1243         pass
1244
1245     def SetText(self):
1246         """"""
1247         pass
1248
1249     def __init__(self):
1250         """"""
1251         pass
1252
1253
1254 class WindowCreateEvent(CommandEvent):
1255     """"""
1256
1257     def GetWindow(self):
1258         """"""
1259         pass
1260
1261     def __init__(self):
1262         """"""
1263         pass
1264
1265
1266 class WindowDestroyEvent(CommandEvent):
1267     """"""
1268
1269     def GetWindow(self):
1270         """"""
1271         pass
1272
1273     def __init__(self):
1274         """"""
1275         pass