summaryrefslogblamecommitdiffstats
path: root/public/sdk/inc/ftestkey.mst
blob: bb1b50f3be55e6cead418f825c3f6b25d27a4dc4 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363


















































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































                                                                                                                
'FTestKey.inc - definitions for Fast Test Key, Menu and Window routines
'
'  Copyright (c) 1991-1992, Microsoft Corporation. All rights reserved.
'
'Purpose:
' This file defines the Key, Menu and Window functions of the Fast Test
' functionality
'


'**********************************************************
'***************** Keystroke Subroutines ******************
'**********************************************************

' support routine for other subroutines, not meant to be called
' except by fasttest routines
'
FUNCTION SKeyString$(s$) STATIC
    DIM sTemp$

    IF LEN(s$) = 0 THEN
        XLogFailure "zero length string passed to SKeyString$"
    END IF

    IF LEN(s$) = 1 THEN
        SELECT CASE ASC(s$)

            ' alphanumerics, pass along as given
            CASE ASC("a") to ASC("z"), ASC("A") to ASC("Z"), ASC("0") to ASC("9")
                sTemp$ = s$

            ' special characters to Dokeys, surround with braces
            CASE ASC("~"),ASC("+"),ASC("^"),ASC("%")
                sTemp$ = "{" + s$ + "}"

            CASE ASC("{"),ASC("}"),ASC("("),ASC(")"),ASC("["),ASC("]")
                sTemp$ = "{" + s$ + "}"

            ' normal printable non-alphanumerics, pass along
            CASE ASC("!"),ASC("@"),ASC("#"),ASC("$"),ASC("&")
                sTemp$ = s$

            CASE ASC("*"),ASC("_"),ASC("|"),ASC(""""),ASC("<"),ASC(">")
                sTemp$ = s$

            CASE ASC("-"),ASC("="),ASC("\"),ASC(";"),ASC("'"),ASC(":")
                sTemp$ =s$

            CASE ASC(","),ASC("."),ASC("/"),ASC(" "),ASC("?"),ASC("`")
                sTemp$ =s$

            ' non-printable other character
            CASE ELSE
                XLogFailure "Bad character passed to SKeyString$"

        END SELECT

    ELSE
        ' the string is greater than 1 character in length, put braces
        ' around it and send it to Dokeys and let it parse it
        sTemp$ = "{" + s$ + "}"
    END IF
    SKeyString$ = "(" + sTemp$ + ")"
END FUNCTION

' support routine for other subroutines, not meant to be called
' except by fasttest routines
'
FUNCTION SHideKeys$(s$) STATIC
    DIM check$
    DIM i%
    DIM stRet$
    ' this code must hide each character that is special to DoKeys

    stRet$ = ""     ' start empty
    FOR i% = 1 to LEN(s$)
        ' special characters to DoKeys, surround with braces
        check$ = mid$(s$,i%,1)
        IF check$ = "~" OR check$ = "+" OR check$ = "^" OR check$ = "%" THEN
            stRet$ = stRet$ + "{" + check$ + "}"
        ELSEIF check$ = "{" OR check$ = "}" OR check$ = "(" OR check$ = ")" OR check$ = "[" OR check$ = "]" THEN
            stRet$ = stRet$ + "{" + check$ + "}"
        ELSE
            stRet$ = stRet$ + check$
        END IF
    NEXT i%
    SHideKeys$ = stRet$
END FUNCTION

'
'   XKey(s$)
'
' Description:
'       Send Keystroke to active application
'       This uses DoKeys, so DoKeys syntax is allowed
'
' Parameters:
'       s$ - single char to send
'       NOTE: any string longer that 1 character in length is assumed
'             to be a special name for a key and is handled as such
'
' Returns:
'       nothing
'
' Example:
'       XKey "f"
'       XKey "escape"

SUB XKey (s$) STATIC
    DoKeys SKeyString$(s$)

END SUB


'
' XAlt(s$)
'
' Description:
'       Send a key as if the alt key is pressed at the same time
'
' Parameters:
'       s$ - single char to send
'       see XKey note
'
' Returns:
'       nothing
'
' Example:
'       XAlt "f"
'       XAlt "escape"
'
'

SUB XAlt (s$) STATIC
    DoKeys "%" + SKeyString$(s$)

END SUB

'
' XCtrl(s$)
'
' Description:
'       Send a key as if the control key is pressed at the same time
'
' Parameters:
'       s$ - single char to send
'       see XKey note
'
' Returns:
'       nothing
'
' Example:
'       XCtrl "f"
'       XCtrl "escape"
'
'

SUB XCtrl (s$) STATIC
    DoKeys "^" + SKeyString$(s$)
END SUB

'
' XShift(s$)
'
' Description:
'       Send a key as if the alt key is pressed at the same time
'
' Parameters:
'       s$ - single char to send
'       see XKey note
'
' Returns:
'       nothing
'
' Example:
'       XShift "f"
'       XShift "escape"
'
'

SUB XShift (s$) STATIC
    DoKeys "+" + SKeyString$(s$)

END SUB

'
' XCtrlAlt(s$)
'
' Description:
'       Send a key as if the alt key is pressed at the same time
'
' Parameters:
'       s$ - single char to send
'       see XKey note
'
' Returns:
'       nothing
'
' Example:
'       XCtrlAlt "f"
'       XCtrlAlt "escape"
'
'


SUB XCtrlAlt (s$) STATIC
    DoKeys "^%" + SKeyString$(s$)
END SUB

'
' XAltShift(s$)
'
' Description:
'       Send a key as if the alt key is pressed at the same time
'
' Parameters:
'       s$ - single char to send
'       see XKey note
'
' Returns:
'       nothing
'
' Example:
'       XAltShift "f"
'       XAltShift "escape"
'
'

SUB XAltShift (s$) STATIC
    DoKeys "%+" + SKeyString$(s$)
END SUB

'
' XCtrlShift(s$)
'
' Description:
'       Send a key as if the alt key is pressed at the same time
'
' Parameters:
'       s$ - single char to send
'       see XKey note
'
' Returns:
'       nothing
'
' Example:
'       XCtrlShift "f"
'       XCtrlShift "escape"
'
'

SUB XCtrlShift (s$) STATIC
    DoKeys "^+" + SKeyString$(s$)
END SUB

'
' XCtrlAltShift(s$)
'
' Description:
'       Send a key as if the alt key is pressed at the same time
'
' Parameters:
'       s$ - single char to send
'       see XKey note
'
' Returns:
'       nothing
'
' Example:
'       XCtrlAltShift "f"
'       XCtrlAltShift "escape"
'
'

SUB XCtrlAltShift (s$) STATIC
    DoKeys "^%+" + SKeyString$(s$)

END SUB

'
' XText(s$)
'
' Description:
'       Send any key as without having to specially specify any
'       keys that are special to DoKeys
'
' Parameters:
'       s$ - string of characters to send
'
' Returns:
'       nothing
'
' Example:
'       XText "Hello World"
'       XText "The DoKeys string to send is {escape}"
'
'

SUB XText(s$) STATIC
    DoKeys SHideKeys$(s$)
END SUB

'
' XEnter(s$)
'
' Description:
'       Send any key as without having to specially specify any
'       keys that are special to DoKeys followed by an enter key
'
' Parameters:
'       s$ - string of characters to send
'
' Returns:
'       nothing
'
' Example:
'       XEnter "Hello World"
'       XEnter "The DoKeys string to send is {escape}"
'
'

SUB XEnter(s$) STATIC
    DoKeys SHideKeys$(s$) + "{enter}"
END SUB





'**********************************************************
'***************** Menu Subroutines ***********************
'**********************************************************




'
' XSelectMenuItem(stMenu, stMenuItem, stHMenuItem)
'
' Description:
'       This procedure selects the specified menu item name.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF
'                     Hierarchial menu exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XSelectMenuItem "Edit", "Copy",""
'
'
SUB XSelectMenuItem(stMenu$,stMenuItem$,stHMenuItem$) STATIC
    XMenuItemExists stMenu$,stMenuItem$,stHMenuItem$

    WMenu(stMenu$)
    IF stMenuItem$ <> "" THEN
        WMenu(stMenuItem$)
    END IF
    IF stHMenuItem$ <> "" THEN              'If popup menu is to be selected
        WMenu(stHMenuItem$)                  'Select menu item under popup menu.
    END IF

END SUB



'
' BMenuItemExists(stMenu, stMenuItem, stHMenuItem)
'
' Description:
'       This procedure checks for the specified menu item
'       and returns true IF found, false IF not found.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to check or secondary menu, IF
'                     Hierarchial menu exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       TRUE if it exists, FALSE if not
'
' Example:
'       fSuccess% = BMenuItemExists("File", "", "")
'       fSuccess% = BMenuItemExists("FIle","Edit", "")
'
'
FUNCTION BMenuItemExists%(stMenu$,stMenuItem$,stHMenuItem$) STATIC

    IF stHMenuItem$ = "" THEN
        IF stMenuItem$ = "" THEN
            BMenuItemExists = WMenuExists(stMenu$) <> 0
        ELSE
            WMenu(stMenu$)
            BMenuItemExists = WMenuExists(stMenuItem$) <> 0
        END IF
    ELSE
        WMenu(stMenu$)
        WMenu(stMenuItem$)
        BMenuItemExists = WMenuExists(stHMenuItem$) <> 0
    END IF
    DoKeys "{esc 3}"                     'Make sure you close menu.

END FUNCTION


'
' XMenuItemExists (stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       Reports error IF menu item does not exist.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF
'                     Hierarchial menu exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XMenuItemExists "File", "Close", ""
'
'
'
SUB XMenuItemExists(stMenu$,stMenuItem$, stHMenuItem$) STATIC
    IF BMenuItemExists(stMenu$,stMenuItem$, stHMenuItem$) = 0 THEN
        XLogFailure stMenu$ + " " + stMenuItem$ + " " + stHMenuItem$ + " does not Exist"
    END IF
END SUB


'
' XMenuItemNotExists (stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       Reports error IF menu item exist.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                        exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XMenuItemNotExists "File", "Close", ""
'
'
'

SUB XMenuItemNotExists(stMenu$,stMenuItem$, stHMenuItem$) STATIC
    IF BMenuItemExists(stMenu$,stMenuItem$, stHMenuItem$) THEN
        XLogFailure stMenu$ + " " + stMenuItem$ + " " + stHMenuItem$ + " Exists"
    END IF
END SUB



'
' IGetMenuCount(stMenu, stMenuItem)
'
' Description:
'       This procedure returns the number of menu items
'       in the specified menu.
'
' Parameters:
'       stMenu       = top level menu to count menu items in.
'                      IF stMenu = "", THEN counts items in the menu bar(counts the
'                      number of top level menus).
'       stMenuItem   = secondary menu to count menu items in; counts hierarchial
'                      menu items.
'
' Returns:
'       An integer; the number of menu items found.
'
' Example:
'       iHowMany% = IGetMenuCount("","") returns how many top level menus.
'       iHowMany% = IGetMenuCount("Utilities", "") returns the number of menu items
'                                                     in the "Utilities" menu.
'       iHowMany% = IGetMenuCount("Utilities", "Info") returns how many menu items
'                                                                 in the popup menu "Info".
'
'
FUNCTION IGetMenuCount%(stMenu$, stMenuItem$) STATIC

    IF stMenuItem$ <> "" THEN                   'Count in menu items in hierarchial menu.
        WMenu(stMenu$)
        WMenu(stMenuItem$)
        IGetMenuCount = WMenuCount()          'Count the number of menus items in the popup
                                                'menu.
    ELSE
        IF stMenu$ <> "" THEN                   'Count menus in stMenu$.
            WMenu(stMenu$)
            IGetMenuCount = WMenuCount()      'Count the number of menus items in the menu.
        ELSE
            IGetMenuCount = WMenuCount()      'Count the number of menus in the menu bar if.
                                                'the above "IF" statements are skipped.
        END IF
    END IF
    DoKeys "{esc 3}"                             'Make sure you close menu.

END FUNCTION



'
' SGetMenuItemText(stMenu, stMenuItem, iIndex)
'
' Description:
'       This procedure returns the text of menu item, iIndex
'       (base 1) in stMenu.  Length of the buffer to store
'       the menu item text is passed in.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to check or secondary menu, IF Hierarchial menu
'                     exists.
'       iIndex      = index of menu item in stMenu.
'       iLength     = length of buffer to store text
'
' Returns:
'       a string, the menu item text(name).
'
' Example:
'       Print SGetMenuItemText("","","", 3)  gets name of 3rd menu.
'       Print SGetMenuItemText("Utilities","","",3) gets name of 3rd menu item
'                                                          in the "Utilities" menu.
'       Print SGetMenuItemText("Utilities","Info",3) gets name of 3rd menu item
'                                                           in the popup menu "Info".
'
'
FUNCTION SGetMenuItemText$(stMenu$,stMenuItem$, iIndex%) STATIC
    DIM buffer$

    buffer$ = String$(128,32)        'initialize with spaces.
    IF stMenuItem$ <> "" THEN        'get menu text from hierarchial menu.
        WMenu(stMenu$)
        WMenu(stMenuItem$)
    ELSE
        IF stMenu$ <> "" THEN        'get menu text from stMenu$.
            WMenu(stMenu$)
        END IF
    END IF

'$IFNDEF NT
    WMenuText iIndex%, buffer$       'get menu text. If above "IF" condition
                                     'is skipped, this gets text in menu bar.
'$ELSE
    WMenuText "@"+STR$(iIndex%), buffer$
'$ENDIF

    SGetMenuItemText = buffer$       'return buffer$

    DoKeys "{esc 3}"                 'Make sure you close menu.

END FUNCTION



'
' BMenuItemGrayed(stMenu$, stMenuItem$,stHMenuItem$)
'
' Description:
'       This procedure checks to see IF the specified menu or
'       menu item is grayed out or not.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       TRUE if grayed.
'       FALSE if not grayed.
'
' Example:
'       fIsGrayed% = BMenuItemGrayed("Edit", "Copy", "")
'       fIsGrayed% = BMenuItemGrayed("Edit", "", "")
'
'
FUNCTION BMenuItemGrayed%(stMenu$, stMenuItem$, stHMenuItem$) STATIC

    IF stHMenuItem$ = "" THEN
        IF stMenuItem$ = "" THEN
            BMenuItemGrayed = WMenuGrayed(stMenu$) <> 0  'Check main menu bar menu items.
        ELSE
            WMenu(stMenu$)                         'Check menu item within stMenuItem$.
            BMenuItemGrayed = WMenuGrayed(stMenuItem$) <> 0
        END IF
    ELSE
        WMenu(stMenu$)                             'Check popup menu items.
        WMenu(stMenuItem$)
        BMenuItemGrayed = WMenuGrayed(stHMenuItem$) <> 0
    END IF
    DoKeys "{esc 3}"                                         'Make sure you close menu.

END FUNCTION


'
' XMenuItemGrayed (stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       Reports error IF menu item is not Grayed.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XMenuItemGrayed "File", "Close", ""
'
'
'

SUB XMenuItemGrayed(stMenu$,stMenuItem$, stHMenuItem$) STATIC
  IF BMenuItemGrayed(stMenu$,stMenuItem$, stHMenuItem$) = 0 THEN
     XLogFailure stMenu$ + " " + stMenuItem$ + " " + stHMenuItem$ + " is not Grayed"
  END IF
END SUB

'
' XMenuItemNotGrayed (stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       Reports error IF menu item is Grayed.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XMenuItemNotGrayed "File", "Close", ""
'
'
'

SUB XMenuItemNotGrayed(stMenu$,stMenuItem$, stHMenuItem$) STATIC
    IF BMenuItemGrayed(stMenu$,stMenuItem$, stHMenuItem$) THEN
        XLogFailure stMenu$ + " " + stMenuItem$ + " " + stHMenuItem$ + " is Grayed"
    END IF
END SUB



'
' BMenuItemChecked(stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       This procedure checks to see IF the specified menu
'       item is checked or not.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       TRUE if checked.
'       FALSE if not checked.
'
' Example:
'       fIsChecked% = BMenuItemChecked("Format","Style","Bold")
'       fIsChecked% = BMenuItemchecked("Edit", "Copy", "")
'
'
FUNCTION BMenuItemChecked%(stMenu$, stMenuItem$, stHMenuItem$) STATIC

    IF stHMenuItem$ = "" THEN
        WMenu(stMenu$)                             'Check menu item within stMenu$.
        BMenuItemChecked = WMenuChecked(stMenuItem$) <> 0
    ELSE
        WMenu(stMenu$)                             'Check menu item under popup menu.
        WMenu(stMenuItem$)
        BMenuItemChecked = WMenuChecked(stHMenuItem$) <> 0
    END IF
    DoKeys "{esc 3}"                                           'Make sure you close menu.

END FUNCTION



'
' XMenuItemChecked (stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       Reports error IF menu item is not Checked.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XMenuItemChecked "Options", "Read Only", ""
'
'
'
SUB XMenuItemChecked(stMenu$,stMenuItem$, stHMenuItem$) STATIC
    IF BMenuItemChecked(stMenu$,stMenuItem$, stHMenuItem$) = 0 THEN
        XLogFailure stMenu$ + " " + stMenuItem$ + " " + stHMenuItem$ + " is not Checked"
    END IF
END SUB

'
' XMenuItemNotChecked (stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       Reports error IF menu item is Checked.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XMenuItemNotChecked "Options", "Read Only", ""
'
'
'
SUB XMenuItemNotChecked(stMenu$,stMenuItem$, stHMenuItem$) STATIC
    IF BMenuItemChecked(stMenu$,stMenuItem$, stHMenuItem$) THEN
        XLogFailure stMenu$ + " " + stMenuItem$ + " " + stHMenuItem$ + " is Checked"
    END IF
END SUB



'
' BMenuItemEnabled(stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       This procedure checks to see IF the specified menu or
'       menu item is enabled or not.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       TRUE if enabled.
'       FALSE if not enabled.
'
' Example:
'       fIsEnabled% = BMenuItemEnabled("File", "", "")
'       fIsEnabled% = BMenuItemEnabled("File", "Close", "")
'
'
FUNCTION BMenuItemEnabled%(stMenu$,stMenuItem$, stHMenuItem$) STATIC

    IF stHMenuItem$ = "" THEN
        IF stMenuItem$ = "" THEN
            BMenuItemEnabled = WMenuEnabled(stMenu$) <> 0 'Check main menu bar menu items.
        ELSE
            WMenu(stMenu$)                         'Check menu item within stMenu$.
            BMenuItemEnabled = WMenuEnabled(stMenuItem$) <> 0
        END IF
    ELSE
        WMenu(stMenu$)                             'Check menu item under popup menu.
        WMenu(stMenuItem$)
        BMenuItemEnabled = WMenuEnabled(stHMenuItem$) <> 0
    END IF
    DoKeys "{esc 3}"                                         'Make sure you close menu.

END FUNCTION


'
' XMenuItemEnabled (stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       Reports error IF menu item is not Enabled.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XMenuItemEnabled "Options", "Read Only", ""
'
'
'
SUB XMenuItemEnabled(stMenu$,stMenuItem$, stHMenuItem$) STATIC
    IF BMenuItemEnabled(stMenu$,stMenuItem$, stHMenuItem$) = 0 THEN
        XLogFailure stMenu$ + " " + stMenuItem$ + " " + stHMenuItem$ + " is not Enabled"
    END IF
END SUB


'
' XMenuItemNotEnabled (stMenu$,stMenuItem$, stHMenuItem$)
'
' Description:
'       Reports error IF menu item is Enabled.
'
' Parameters:
'       stMenu      = menu where stMenuItem is found.
'       stMenuItem  = menu item to select or secondary menu, IF Hierarchial menu
'                     exists.
'       stHMenuItem = hierarchial(popup) menu item.
'
' Returns:
'       nothing
'
' Example:
'       XMenuItemNotEnabled "Options", "Read Only", ""
'
'
'
SUB XMenuItemNotEnabled(stMenu$,stMenuItem$, stHMenuItem$) STATIC
    IF BMenuItemEnabled(stMenu$,stMenuItem$, stHMenuItem$) THEN
        XLogFailure stMenu$ + " " + stMenuItem$ + " " + stHMenuItem$ + " is Enabled"
    END IF
END SUB



'**********************************************************
'***************** Window Subroutines *********************
'**********************************************************




'
' XCaptionExists(stCaption$)
'
' Description:
'       Will report error IF caption does not Exist.
'
' Parameters:
'       stCaption$  - expected caption of current window
'
' Returns:
'       nothing
'
' Example:
'       XCaptionExists "Winword"
'
'
'
SUB XCaptionExists(stCaption$) STATIC
    IF Instr(SGetCaption(), stCaption$) = 0 THEN
        XLogFailure stCaption$ + " caption does not exist in active window."
    END IF
END SUB


'
' XCaptionNotExists(stCaption$)
'
' Description:
'       Will report error IF caption Exist.
'
' Parameters:
'       stCaption$  - NOT expected caption of current window
'
' Returns:
'       nothing
'
' Example:
'       XCaptionNotExists "Winword"
'
'
SUB XCaptionNotExists(stCaption$) STATIC
    IF Instr(SGetCaption(), stCaption$) <> 0 THEN
        XLogFailure stCaption$ + " caption Exists in active window."
    END IF
END SUB



'
' SGetCaption()
'
' Description:
'       Returns the caption of the Active window
'
' Parameters:
'       none
'
' Return:
'       Caption of the Active window
'
' Example:
'       stCaption$ = SGetCaption()
'
'
FUNCTION SGetCaption$() STATIC
    DIM x%
    DIM stCaption$

    stCaption$ = String$(100, 32)
    x% = GetWindowText (GetForegroundWindow(), stCaption$, LEN(stCaption$))
    SGetCaption = mid$(stCaption$,1,x%)
    stCaption$ = ""
END FUNCTION



'
' XZoomWindow
'
' Description:
'       Toggles the state of the window between normalized
'       and maximized.
'
' Parameters:
'       None
'
' Returns:
'       nothing
'
' Example:
'       XZoomWindow
'
'
'
SUB XZoomWindow STATIC
    DIM bogus%
    DIM lhwndTemp%

    lhwndTemp% = GetForegroundWindow()

    ' IF the window is maximized, normalize.

    IF (IsZoomed(lhwndTemp%)) THEN
        ' window is maximized, we must normalize it
        bogus% = ShowWindow(lhwndTemp%, SW_SHOWNORMAL)
    ELSE
        bogus% = ShowWindow(lhwndTemp%, SW_MAXIMIZE)
    END IF

END SUB


'
' XMaxWindow
'
' Description:
'       Maximize the current active window
'
' Parameters:
'       None
'
' Returns:
'       nothing
'
' Example:
'       XMaxWinow
'
'
'


SUB XMaxWindow STATIC
    DIM bogus%
    DIM lhwndTemp%
    DIM lWndStyle&

    lhwndTemp% = GetForegroundWindow ()

    ' Get the window's style attributes
    lWndStyle& = GetWindowLong(lhwndTemp%, GWL_STYLE)

    IF ((lWndStyle& And WS_MAXIMIZE) <> 0) THEN
        XLogFailure "Could not maximize active window, already maximized"
    ELSE
        bogus% = ShowWindow(lhwndTemp%, SW_SHOWMAXIMIZED)
    END IF

END SUB

'
' XWindowMaximized
'
' Description:
'       check IF the current active window is Maximized
'
' Parameters:
'       none
'
' Returns:
'       nothing
'
' Example:
'       XWindowMaximized
'
'
'


SUB XWindowMaximized STATIC
    IF BWindowMaximized = 0 THEN
        XLogFailure "Active Window not maximized"
    END IF

END SUB

'
' XWindowNotMaximized
'
' Description:
'       Check that the current window is not maximized
'
' Parameters:
'       none
'
' Returns:
'       nothing
'
' Example:
'       XWindowNotMaximized
'
'
'


SUB XWindowNotMaximized STATIC

    IF BWindowMaximized THEN
        XLogFailure "Active Window is maximized"
    END IF

END SUB

'
' BWindowMaximized
'
' Description:
'       detect IF current window is maximized
'
' Parameters:
'       none
'
' Returns:
'       TRUE if maximized, FALSE if not
'
' Example:
'       BWindowMaximized
'
'
'


FUNCTION BWindowMaximized% STATIC
    DIM bogus%
    DIM lhwndTemp%
    DIM lWndStyle&

    lhwndTemp% = GetForegroundWindow ()

    ' Get the window's style attributes
    lWndStyle& = GetWindowLong(lhwndTemp%, GWL_STYLE)

    BWindowMaximized = (lWndStyle& AND WS_MAXIMIZE) <> 0

END FUNCTION


'
' XMinWindow
'
' Description:
'       Minimize the current active window
'
' Parameters:
'       none
'
' Returns:
'       nothing
'
' Example:
'       XMinWindow
'
'
'


SUB XMinWindow STATIC
    DIM bogus%
    DIM lhwndTemp%
    DIM lWndStyle&

    lhwndTemp% = GetForegroundWindow ()

    ' Get the window's style attributes
    lWndStyle& = GetWindowLong(lhwndTemp%, GWL_STYLE)

    ' IF maximized, XLog the descrepancy
    IF ((lWndStyle& And WS_MINIMIZE) <> 0) THEN
        XLogFailure "Could not minimize active window, already minimized"
    ELSE
        bogus% = ShowWindow(lhwndTemp%, SW_SHOWMINIMIZED)
    END IF

END SUB

' XWindowMinimized
'
' Description:
'       Check that current window is minimized
'
' Parameters:
'       none
'
' Returns:
'       nothing
'
' Example:
'       XWindowMinized
'
'
'


SUB XWindowMinimized STATIC

    IF BWindowMinimized = 0 THEN
        XLogFailure "Active Window not Minimized"
    END IF

END SUB

'
' XWindowNotMinimized
'
' Description:
'       Check that current window is not minimized
'
' Parameters:
'       none
'
' Returns:
'       nothing
'
' Example:
'       XWindowNotMinimized
'
'
'


SUB XWindowNotMinimized STATIC
    IF BWindowMinimized THEN
        XLogFailure "Active Window is Minimized"
    END IF

END SUB

'
' BWindowMinimized
'
' Description:
'       Detect IF active window minimized
'
' Parameters:
'       none
'
' Returns:
'       TRUE if minimized, FALSE if not
'
' Example:
'       BWindowMinimized
'
'
'


FUNCTION BWindowMinimized% STATIC
    DIM bogus%
    DIM lhwndTemp%
    DIM lWndStyle&

    lhwndTemp% = GetForegroundWindow ()

    ' Get the window's style attributes
    lWndStyle& = GetWindowLong(lhwndTemp%, GWL_STYLE)

    BWindowMinimized = (lWndStyle& AND WS_MINIMIZE) <> 0

END FUNCTION

'
' XRestoreWindow
'
' Description:
'       Restore the current active window.  NOTE: You must make
'       the icon the active window before calling XRestoreWin!
'
' Parameters:
'       none
'
' Returns:
'       nothing
'
' Example:
'       XRestoreWindow
'
'
'


SUB XRestoreWindow STATIC
    DIM bogus%
    DIM lhwndTemp%
    DIM lWndStyle&

    lhwndTemp% = GetForegroundWindow ()

    ' Get the window's style attributes
    lWndStyle& = GetWindowLong(lhwndTemp%, GWL_STYLE)

    ' IF maximized, XLog the descrepancy
    IF ((lWndStyle& And WS_MINIMIZE) = 0) AND ((lWndStyle& And WS_MAXIMIZE) = 0) THEN
        XLogFailure "Active window is not minimized or maximized."
    ELSE
        bogus% = ShowWindow(lhwndTemp%, SW_RESTORE)
    END IF

END SUB



'
' XSizeActiveWindow(iXPixels, iYPixels, fAbsOrRel)
'
' Description:
'       Moves the bottom-right corner of the active window
'       to new coordiates iXPixels, iYPixels.  IF fAbsOrRel
'       is TRUE, the coordiates are absolute.  IF fAbsOrRel
'       is FALSE, the coordiates are relative to the current
'       position.
'
' Parameters:
'       iXPixels - X coordinate
'       iYPixels - Y coordinate
'       IF !fAbsOrRel FALSE, the X,Y coordinates are relative to the
'       current mouse coordianates.
'
' Returns:
'       nothing
'
' Example:
'       XSizeActiveWindow iXPixels, iYPixels, fAbsOrRel
'
'
'

SUB XSizeActiveWindow (iXPixels%, iYPixels%, fAbsOrRel%) STATIC

    DIM xyTempRect As rect
    DIM iTempX%
    DIM iTempY%
    DIM temphWnd%

    IF fAbsOrRel% THEN
        WSetWndSiz GetForegroundWindow(), iXPixels%, iYPixels%
    ELSE
        ' Find the active window
        temphWnd% = GetForegroundWindow

        ' Get the Rect of the active window
        GetWindowRect temphWnd%, xyTempRect
        ' Determine new X coordinate
        iTempX% = ((xyTempRect.wright - 1) - (xyTempRect.wleft)) + iXPixels%

        ' Determine new Y coordinate
        iTempY% = ((xyTempRect.bottom - 1) - (xyTempRect.top)) + iYPixels%

        ' size the window
        WSetWndSiz GetForegroundWindow(), iTempX%, iTempY%

    END IF
END SUB


'
' XMoveActiveWindow(iXPixels, iYPixels, fAbsOrRel)
'
' Description:
'       Moves the top-left corner of the active window
'       to new coordiates iXPixels, iYPixels.  IF fAbsOrRel
'       is TRUE, the coordiates are absolute.  IF fAbsOrRel
'       is FALSE, the coordiates are relative to the current
'       position.
'
' Parameters:
'       iXPixels - X coordinate
'       iYPixels - Y coordinate
'       IF !fAbsOrRel FALSE, the X,Y coordinates are relative to the
'       current mouse coordianates.
'
' Returns:
'       nothing
'
' Example:
'       XMoveActiveWindow iXPixels, iYPixels, fAbsOrRel
'
'

SUB XMoveActiveWindow (iXPixels%, iYPixels%, fAbsOrRel%) STATIC

    DIM xyTempRect As Rect
    DIM iTempX%
    DIM iTempY%
    DIM temphWnd%


    IF fAbsOrRel% THEN
        WSetWndPos GetForegroundWindow(), iXPixels%, iYPixels%
    ELSE
        ' Find the active window
        temphWnd% = GetForegroundWindow

        ' Get the Rect of the active window
        GetWindowRect temphWnd%, xyTempRect

        ' Determine new X coordinate
        iTempX% = xyTempRect.wleft + iXPixels%

        ' Determine new Y coordinate
        iTempY% = xyTempRect.top + iYPixels%

        ' move the window
        WSetWndPos GetForegroundWindow(), iTempX%, iTempY%
    END IF
END SUB